From 21aa8e76581a36adae67f97ceb1466756e08f9a3 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 19 Sep 2024 12:11:34 +1000 Subject: [PATCH 1/2] updated google --- .../googleapis.com/v00.00.00000/provider.yaml | 11 + .../v00.00.00000/services/accessapproval.yaml | 4 +- .../services/accesscontextmanager.yaml | 4 +- .../services/addressvalidation.yaml | 1392 +- .../services/advisorynotifications.yaml | 492 +- .../v00.00.00000/services/aiplatform.yaml | 60535 ++++++++-------- .../v00.00.00000/services/airquality.yaml | 1394 +- .../v00.00.00000/services/alloydb.yaml | 2 +- .../v00.00.00000/services/analyticshub.yaml | 2 +- .../v00.00.00000/services/apigateway.yaml | 4 +- .../v00.00.00000/services/apigee.yaml | 26804 +++---- .../v00.00.00000/services/apigeeregistry.yaml | 2 +- .../v00.00.00000/services/apikeys.yaml | 690 +- .../v00.00.00000/services/apim.yaml | 2 +- .../v00.00.00000/services/appengine.yaml | 4 +- .../v00.00.00000/services/apphub.yaml | 2 +- .../services/artifactregistry.yaml | 4 +- .../services/assuredworkloads.yaml | 2042 +- .../v00.00.00000/services/backupdr.yaml | 2 +- .../services/baremetalsolution.yaml | 4 +- .../v00.00.00000/services/batch.yaml | 2 +- .../v00.00.00000/services/beyondcorp.yaml | 2 +- .../v00.00.00000/services/biglake.yaml | 2 +- .../v00.00.00000/services/bigquery.yaml | 183 +- .../services/bigqueryconnection.yaml | 4 +- .../services/bigquerydatapolicy.yaml | 4 +- .../services/bigquerydatatransfer.yaml | 2 +- .../services/bigqueryreservation.yaml | 4 +- .../v00.00.00000/services/bigtableadmin.yaml | 47 +- .../v00.00.00000/services/billingbudgets.yaml | 836 +- .../services/binaryauthorization.yaml | 2 +- .../services/blockchainnodeengine.yaml | 4 +- .../services/certificatemanager.yaml | 4 +- .../v00.00.00000/services/cloudasset.yaml | 4 +- .../v00.00.00000/services/cloudbilling.yaml | 4 +- .../v00.00.00000/services/cloudbuild.yaml | 4624 +- .../services/cloudcommerceprocurement.yaml | 1060 +- .../services/cloudcontrolspartner.yaml | 4 +- .../v00.00.00000/services/clouddeploy.yaml | 4 +- .../services/clouderrorreporting.yaml | 2 +- .../v00.00.00000/services/cloudfunctions.yaml | 4 +- .../v00.00.00000/services/cloudidentity.yaml | 4 +- .../v00.00.00000/services/cloudkms.yaml | 4 +- .../v00.00.00000/services/cloudprofiler.yaml | 2 +- .../services/cloudresourcemanager.yaml | 2 +- .../v00.00.00000/services/cloudscheduler.yaml | 2 +- .../v00.00.00000/services/cloudshell.yaml | 4 +- .../v00.00.00000/services/cloudsupport.yaml | 1635 +- .../v00.00.00000/services/cloudtasks.yaml | 4 +- .../v00.00.00000/services/cloudtrace.yaml | 2 +- .../v00.00.00000/services/composer.yaml | 2 +- .../v00.00.00000/services/compute.yaml | 22 +- .../v00.00.00000/services/config.yaml | 4 +- .../v00.00.00000/services/connectors.yaml | 2 +- .../services/contactcenteraiplatform.yaml | 4 +- .../services/contactcenterinsights.yaml | 9238 +-- .../v00.00.00000/services/container.yaml | 2 +- .../services/containeranalysis.yaml | 9986 +-- .../services/contentwarehouse.yaml | 9506 +-- .../v00.00.00000/services/datacatalog.yaml | 2 +- .../v00.00.00000/services/dataflow.yaml | 2 +- .../v00.00.00000/services/dataform.yaml | 2 +- .../v00.00.00000/services/datafusion.yaml | 2 +- .../v00.00.00000/services/datalabeling.yaml | 2 +- .../v00.00.00000/services/datalineage.yaml | 1504 +- .../v00.00.00000/services/datamigration.yaml | 2 +- .../v00.00.00000/services/datapipelines.yaml | 1378 +- .../v00.00.00000/services/dataplex.yaml | 2 +- .../v00.00.00000/services/dataproc.yaml | 2 +- .../v00.00.00000/services/datastore.yaml | 4 +- .../v00.00.00000/services/datastream.yaml | 2 +- .../services/deploymentmanager.yaml | 2 +- .../services/developerconnect.yaml | 4 +- .../v00.00.00000/services/dialogflow.yaml | 4 +- .../services/discoveryengine.yaml | 2 +- .../v00.00.00000/services/dlp.yaml | 17988 ++--- .../v00.00.00000/services/dns.yaml | 2 +- .../v00.00.00000/services/documentai.yaml | 9346 +-- .../v00.00.00000/services/domains.yaml | 4 +- .../services/essentialcontacts.yaml | 888 +- .../v00.00.00000/services/eventarc.yaml | 4 +- .../v00.00.00000/services/file.yaml | 2 +- .../v00.00.00000/services/firestore.yaml | 4 +- .../v00.00.00000/services/gkebackup.yaml | 2 +- .../v00.00.00000/services/gkehub.yaml | 4 +- .../v00.00.00000/services/gkeonprem.yaml | 4 +- .../v00.00.00000/services/healthcare.yaml | 2 +- .../v00.00.00000/services/iam.yaml | 564 +- .../v00.00.00000/services/iamcredentials.yaml | 2 +- .../v00.00.00000/services/iamv2.yaml | 4 +- .../v00.00.00000/services/iamv2beta.yaml | 4 +- .../v00.00.00000/services/iap.yaml | 2 +- .../services/identitytoolkit.yaml | 2 +- .../v00.00.00000/services/ids.yaml | 2 +- .../v00.00.00000/services/integrations.yaml | 19846 ++--- .../v00.00.00000/services/jobs.yaml | 4 +- .../v00.00.00000/services/kmsinventory.yaml | 1124 +- .../v00.00.00000/services/language.yaml | 7948 +- .../v00.00.00000/services/libraryagent.yaml | 180 +- .../v00.00.00000/services/lifesciences.yaml | 4 +- .../v00.00.00000/services/logging.yaml | 8 +- .../v00.00.00000/services/looker.yaml | 12 +- .../services/managedidentities.yaml | 4 +- .../v00.00.00000/services/memcache.yaml | 4 +- .../v00.00.00000/services/metastore.yaml | 4 +- .../services/migrationcenter.yaml | 2 +- .../v00.00.00000/services/ml.yaml | 2 +- .../v00.00.00000/services/monitoring.yaml | 4 +- .../services/networkconnectivity.yaml | 108 +- .../services/networkmanagement.yaml | 2 +- .../services/networksecurity.yaml | 2 +- .../services/networkservices.yaml | 4 +- .../v00.00.00000/services/notebooks.yaml | 2 +- .../services/ondemandscanning.yaml | 2 +- .../v00.00.00000/services/oracledatabase.yaml | 4101 ++ .../v00.00.00000/services/orgpolicy.yaml | 1586 +- .../v00.00.00000/services/osconfig.yaml | 4 +- .../v00.00.00000/services/oslogin.yaml | 2 +- .../v00.00.00000/services/places.yaml | 3326 +- .../v00.00.00000/services/policyanalyzer.yaml | 184 +- .../services/policysimulator.yaml | 3394 +- .../services/policytroubleshooter.yaml | 912 +- .../v00.00.00000/services/pollen.yaml | 644 +- .../v00.00.00000/services/privateca.yaml | 4 +- .../services/prod_tt_sasportal.yaml | 3932 +- .../v00.00.00000/services/publicca.yaml | 4 +- .../v00.00.00000/services/pubsub.yaml | 2 +- .../v00.00.00000/services/pubsublite.yaml | 4 +- .../services/rapidmigrationassessment.yaml | 2 +- .../services/recaptchaenterprise.yaml | 3944 +- .../services/recommendationengine.yaml | 2 +- .../v00.00.00000/services/recommender.yaml | 2766 +- .../v00.00.00000/services/redis.yaml | 4 +- .../services/resourcesettings.yaml | 514 +- .../v00.00.00000/services/retail.yaml | 244 +- .../v00.00.00000/services/run.yaml | 2 +- .../v00.00.00000/services/runtimeconfig.yaml | 2 +- .../v00.00.00000/services/sasportal.yaml | 4238 +- .../v00.00.00000/services/secretmanager.yaml | 2 +- .../v00.00.00000/services/securitycenter.yaml | 10 +- .../services/serviceconsumermanagement.yaml | 6234 +- .../v00.00.00000/services/servicecontrol.yaml | 4 +- .../services/servicedirectory.yaml | 4 +- .../services/servicemanagement.yaml | 2 +- .../services/servicenetworking.yaml | 7733 +- .../v00.00.00000/services/serviceusage.yaml | 6107 +- .../v00.00.00000/services/solar.yaml | 1516 +- .../v00.00.00000/services/spanner.yaml | 4 +- .../v00.00.00000/services/speech.yaml | 2 +- .../v00.00.00000/services/sqladmin.yaml | 2 +- .../v00.00.00000/services/storage.yaml | 2 +- .../services/storagetransfer.yaml | 2 +- .../v00.00.00000/services/testing.yaml | 4 +- .../v00.00.00000/services/texttospeech.yaml | 2 +- .../v00.00.00000/services/tpu.yaml | 4 +- .../services/trafficdirector.yaml | 2 +- .../v00.00.00000/services/transcoder.yaml | 4 +- .../v00.00.00000/services/translate.yaml | 8 +- .../services/videointelligence.yaml | 2 +- .../v00.00.00000/services/vision.yaml | 2 +- .../v00.00.00000/services/vmmigration.yaml | 4 +- .../v00.00.00000/services/vmwareengine.yaml | 2 +- .../v00.00.00000/services/vpcaccess.yaml | 2 +- .../v00.00.00000/services/webrisk.yaml | 730 +- .../services/websecurityscanner.yaml | 1818 +- .../services/workflowexecutions.yaml | 4 +- .../v00.00.00000/services/workflows.yaml | 4 +- .../services/workloadmanager.yaml | 2 +- .../v00.00.00000/services/workstations.yaml | 18 +- 169 files changed, 125379 insertions(+), 120309 deletions(-) create mode 100644 providers/src/googleapis.com/v00.00.00000/services/oracledatabase.yaml diff --git a/providers/src/googleapis.com/v00.00.00000/provider.yaml b/providers/src/googleapis.com/v00.00.00000/provider.yaml index 71fc082d..1119dc9a 100644 --- a/providers/src/googleapis.com/v00.00.00000/provider.yaml +++ b/providers/src/googleapis.com/v00.00.00000/provider.yaml @@ -1187,6 +1187,17 @@ providerServices: title: On-Demand Scanning API version: v00.00.00000 description: A service to scan container images for vulnerabilities. + oracledatabase: + id: oracledatabase:v00.00.00000 + name: oracledatabase + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/oracledatabase.yaml + title: Oracle Database@Google Cloud API + version: v00.00.00000 + description: >- + The Oracle Database@Google Cloud API provides set of APIs to manage Oracle + databases such as Exadata and Autonomous Databases. orgpolicy: id: orgpolicy:v00.00.00000 name: orgpolicy diff --git a/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml b/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml index dc44e752..e9a00b5f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml @@ -7,8 +7,8 @@ info: title: Access Approval API description: An API for controlling access to data by Google personnel. version: v1 - x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240913' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/assured-workloads/access-approval/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml index 1affe51f..38cbd13b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml @@ -17,8 +17,8 @@ info: Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters. version: v1 - x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/access-context-manager/docs/reference/rest/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml index 59e16ce9..a945d3ea 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml @@ -11,8 +11,8 @@ info: the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address. version: v1 - x-discovery-doc-revision: '20240911' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/maps/documentation/addressvalidation servers: @@ -42,100 +42,60 @@ components: scopes: *ref_0 schemas: GoogleMapsAddressvalidationV1ValidateAddressResponse: + type: object + id: GoogleMapsAddressvalidationV1ValidateAddressResponse description: The response to an address validation request. properties: result: $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' description: The result of the address validation. responseId: + type: string description: >- The UUID that identifies this response. If the address needs to be re-validated, this UUID *must* accompany the new request. - type: string - id: GoogleMapsAddressvalidationV1ValidateAddressResponse - type: object - GoogleMapsAddressvalidationV1ValidateAddressRequest: + GoogleMapsAddressvalidationV1UspsAddress: + id: GoogleMapsAddressvalidationV1UspsAddress properties: - sessionToken: + city: + description: City name. type: string - description: >- - Optional. A string which identifies an Autocomplete session for - billing purposes. Must be a URL and filename safe base64 string with - at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT - error is returned. The session begins when the user makes an - Autocomplete query, and concludes when they select a place and a - call to Place Details or Address Validation is made. Each session - can have multiple Autocomplete queries, followed by one Place - Details or Address Validation request. The credentials used for each - request within a session must belong to the same Google Cloud - Console project. Once a session has concluded, the token is no - longer valid; your app must generate a fresh token for each session. - If the `sessionToken` parameter is omitted, or if you reuse a - session token, the session is charged as if no session token was - provided (each request is billed separately). Note: Address - Validation can only be used in sessions with the Autocomplete (New) - API, not the Autocomplete API. See - https://developers.google.com/maps/documentation/places/web-service/session-pricing - for more details. - previousResponseId: - description: >- - This field must be empty for the first address validation request. - If more requests are necessary to fully validate a single address - (for example if the changes the user makes after the initial - validation need to be re-validated), then each followup request must - populate this field with the response_id from the very first - response in the validation sequence. + firm: + description: Firm name. + type: string + firstAddressLine: + description: First address line. + type: string + secondAddressLine: + type: string + description: Second address line. + zipCodeExtension: + type: string + description: 4-digit postal code extension e.g. 5023. + zipCode: + type: string + description: Postal code e.g. 10009. + state: + description: 2 letter state code. + type: string + cityStateZipAddressLine: + description: City + state + postal code. + type: string + urbanization: + description: Puerto Rican urbanization name. type: string - languageOptions: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1LanguageOptions' - description: >- - Optional. Preview: This feature is in Preview (pre-GA). Pre-GA - products and features might have limited support, and changes to - pre-GA products and features might not be compatible with other - pre-GA versions. Pre-GA Offerings are covered by the [Google Maps - Platform Service Specific - Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). - For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). - Enables the Address Validation API to include additional information - in the response. - enableUspsCass: - type: boolean - description: >- - Enables USPS CASS compatible mode. This affects _only_ the - [google.maps.addressvalidation.v1.ValidationResult.usps_data] field - of [google.maps.addressvalidation.v1.ValidationResult]. Note: for - USPS CASS enabled requests for addresses in Puerto Rico, a - [google.type.PostalAddress.region_code] of the `address` must be - provided as "PR", or an - [google.type.PostalAddress.administrative_area] of the `address` - must be provided as "Puerto Rico" (case-insensitive) or "PR". It's - recommended to use a componentized `address`, or alternatively - specify at least two [google.type.PostalAddress.address_lines] where - the first line contains the street number and name and the second - line contains the city, state, and zip code. - address: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: >- - Required. The address being validated. Unformatted addresses should - be submitted via `address_lines`. The total length of the fields in - this input must not exceed 280 characters. Supported regions can be - found - [here](https://developers.google.com/maps/documentation/address-validation/coverage). - The language_code value in the input address is reserved for future - uses and is ignored today. The validated address result will be - populated based on the preferred language for the given address, as - identified by the system. The Address Validation API ignores the - values in recipients and organization. Any values in those fields - will be discarded and not returned. Please do not set them. - id: GoogleMapsAddressvalidationV1ValidateAddressRequest type: object - description: The request for validating an address. + description: USPS representation of a US address. GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: - type: object - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest + description: The request for sending validation feedback. properties: conclusion: + enum: + - VALIDATION_CONCLUSION_UNSPECIFIED + - VALIDATED_VERSION_USED + - USER_VERSION_USED + - UNVALIDATED_VERSION_USED + - UNUSED enumDescriptions: - >- This value is unused. If the @@ -157,12 +117,6 @@ components: Required. The outcome of the sequence of validation attempts. If this field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error will be returned. - enum: - - VALIDATION_CONCLUSION_UNSPECIFIED - - VALIDATED_VERSION_USED - - USER_VERSION_USED - - UNVALIDATED_VERSION_USED - - UNUSED type: string responseId: type: string @@ -170,156 +124,54 @@ components: Required. The ID of the response that this feedback is for. This should be the response_id from the first response in a series of address validation attempts. - description: The request for sending validation feedback. - GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: - description: >- - The response for validation feedback. The response is empty if the - feedback is sent successfully. - properties: {} + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest + type: object + GoogleTypePostalAddress: type: object - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse - GoogleMapsAddressvalidationV1AddressComponent: properties: - componentType: - description: >- - The type of the address component. See [Table 2: Additional types - returned by the Places - service](https://developers.google.com/places/web-service/supported_types#table2) - for a list of possible types. - type: string - replaced: - type: boolean + recipients: + type: array + items: + type: string description: >- - Indicates the name of the component was replaced with a completely - different one, for example a wrong postal code being replaced with - one that is correct for the address. This is not a cosmetic change, - the input component has been changed to a different one. - confirmationLevel: - enumDescriptions: - - Default value. This value is unused. - - >- - We were able to verify that this component exists and makes sense - in the context of the rest of the address. - - >- - This component could not be confirmed, but it is plausible that it - exists. For example, a street number within a known valid range of - numbers on a street where specific house numbers are not known. - - >- - This component was not confirmed and is likely to be wrong. For - example, a neighborhood that does not fit the rest of the address. - enum: - - CONFIRMATION_LEVEL_UNSPECIFIED - - CONFIRMED - - UNCONFIRMED_BUT_PLAUSIBLE - - UNCONFIRMED_AND_SUSPICIOUS + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. + organization: + description: Optional. The name of the organization at the address. type: string + revision: description: >- - Indicates the level of certainty that we have that the component is - correct. - unexpected: - description: >- - Indicates an address component that is not expected to be present in - a postal address for the given region. We have retained it only - because it was part of the input. - type: boolean - spellCorrected: - type: boolean - description: >- - Indicates a correction to a misspelling in the component name. The - API does not always flag changes from one spelling variant to - another, such as when changing "centre" to "center". It also does - not always flag common misspellings, such as when changing - "Amphitheater Pkwy" to "Amphitheatre Pkwy". - inferred: + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + type: integer + format: int32 + languageCode: description: >- - Indicates that the component was not part of the input, but we - inferred it for the address location and believe it should be - provided for a complete address. - type: boolean - componentName: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' - description: The name for this component. - description: Represents an address component, such as a street, city, or state. - type: object - id: GoogleMapsAddressvalidationV1AddressComponent - GoogleTypeLatLng: - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - type: object - properties: - longitude: - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - type: number - format: double - latitude: - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - format: double - type: number - id: GoogleTypeLatLng - GoogleMapsAddressvalidationV1UspsAddress: - id: GoogleMapsAddressvalidationV1UspsAddress - type: object - properties: - state: - description: 2 letter state code. - type: string - city: - type: string - description: City name. - secondAddressLine: - type: string - description: Second address line. - urbanization: - type: string - description: Puerto Rican urbanization name. - cityStateZipAddressLine: - type: string - description: City + state + postal code. - firstAddressLine: - type: string - description: First address line. - zipCode: - type: string - description: Postal code e.g. 10009. - zipCodeExtension: - description: 4-digit postal code extension e.g. 5023. - type: string - firm: + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". type: string - description: Firm name. - description: USPS representation of a US address. - GoogleTypePostalAddress: - id: GoogleTypePostalAddress - properties: sublocality: type: string description: >- Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. - revision: - format: int32 - type: integer - description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - recipients: - type: array - items: - type: string - description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. - locality: + sortingCode: description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). type: string postalCode: description: >- @@ -328,16 +180,9 @@ components: may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). type: string - regionCode: - description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. - type: string addressLines: - type: array + items: + type: string description: >- Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type @@ -358,30 +203,16 @@ components: recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - items: - type: string - languageCode: - type: string + type: array + locality: description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - sortingCode: + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. type: string - description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). administrativeArea: + type: string description: >- Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a @@ -390,124 +221,191 @@ components: "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. + regionCode: + type: string + description: >- + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + description: >- + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 + id: GoogleTypePostalAddress + GoogleMapsAddressvalidationV1PlusCode: + id: GoogleMapsAddressvalidationV1PlusCode + description: >- + Plus code (http://plus.codes) is a location reference with two formats: + global code defining a 14mx14m (1/8000th of a degree) or smaller + rectangle, and compound code, replacing the prefix with a reference + location. + type: object + properties: + compoundCode: type: string - organization: - description: Optional. The name of the organization at the address. + description: >- + Place's compound code, such as "33GV+HQ, Ramberg, Norway", + containing the suffix of the global code and replacing the prefix + with a formatted name of a reference entity. + globalCode: + description: >- + Place's global (full) code, such as "9FWM33GV+HQ", representing an + 1/8000 by 1/8000 degree area (~14 by 14 meters). type: string + GoogleGeoTypeViewport: + description: >- + A latitude-longitude viewport, represented as two diagonally opposite + `low` and `high` points. A viewport is considered a closed region, i.e. + it includes its boundary. The latitude bounds must range between -90 to + 90 degrees inclusive, and the longitude bounds must range between -180 + to 180 degrees inclusive. Various cases include: - If `low` = `high`, + the viewport consists of that single point. - If `low.longitude` > + `high.longitude`, the longitude range is inverted (the viewport crosses + the 180 degree longitude line). - If `low.longitude` = -180 degrees and + `high.longitude` = 180 degrees, the viewport includes all longitudes. - + If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, + the longitude range is empty. - If `low.latitude` > `high.latitude`, the + latitude range is empty. Both `low` and `high` must be populated, and + the represented box cannot be empty (as specified by the definitions + above). An empty viewport will result in an error. For example, this + viewport fully encloses New York City: { "low": { "latitude": 40.477398, + "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": + -73.70018 } } type: object + properties: + high: + description: Required. The high point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + low: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: Required. The low point of the viewport. + id: GoogleGeoTypeViewport + GoogleTypeLatLng: description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - GoogleMapsAddressvalidationV1ValidationResult: - description: The result of validating an address. + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. type: object properties: - verdict: - description: Overall verdict flags - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' - address: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' - description: Information about the address itself as opposed to the geocode. - uspsData: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' + longitude: + format: double + type: number + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: number + format: double + id: GoogleTypeLatLng + GoogleMapsAddressvalidationV1ValidateAddressRequest: + id: GoogleMapsAddressvalidationV1ValidateAddressRequest + properties: + previousResponseId: + type: string description: >- - Extra deliverability flags provided by USPS. Only provided in region - `US` and `PR`. - metadata: + This field must be empty for the first address validation request. + If more requests are necessary to fully validate a single address + (for example if the changes the user makes after the initial + validation need to be re-validated), then each followup request must + populate this field with the response_id from the very first + response in the validation sequence. + enableUspsCass: description: >- - Other information relevant to deliverability. `metadata` is not - guaranteed to be fully populated for every address sent to the - Address Validation API. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressMetadata' - englishLatinAddress: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' + Enables USPS CASS compatible mode. This affects _only_ the + [google.maps.addressvalidation.v1.ValidationResult.usps_data] field + of [google.maps.addressvalidation.v1.ValidationResult]. Note: for + USPS CASS enabled requests for addresses in Puerto Rico, a + [google.type.PostalAddress.region_code] of the `address` must be + provided as "PR", or an + [google.type.PostalAddress.administrative_area] of the `address` + must be provided as "Puerto Rico" (case-insensitive) or "PR". It's + recommended to use a componentized `address`, or alternatively + specify at least two [google.type.PostalAddress.address_lines] where + the first line contains the street number and name and the second + line contains the city, state, and zip code. + type: boolean + languageOptions: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1LanguageOptions' description: >- - Preview: This feature is in Preview (pre-GA). Pre-GA products and - features might have limited support, and changes to pre-GA products - and features might not be compatible with other pre-GA versions. - Pre-GA Offerings are covered by the [Google Maps Platform Service - Specific + Optional. Preview: This feature is in Preview (pre-GA). Pre-GA + products and features might have limited support, and changes to + pre-GA products and features might not be compatible with other + pre-GA versions. Pre-GA Offerings are covered by the [Google Maps + Platform Service Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). The - address translated to English. Translated addresses are not reusable - as API input. The service provides them so that the user can use - their native language to confirm or deny the validation of the - originally-provided address. If part of the address doesn't have an - English translation, the service returns that part in an alternate - language that uses a Latin script. See - [here](https://developers.google.com/maps/documentation/address-validation/convert-addresses-english) - for an explanation of how the alternate language is selected. If - part of the address doesn't have any translations or - transliterations in a language that uses a Latin script, the service - returns that part in the local language associated with the address. - Enable this output by using the - [google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address] - flag. Note: the - [google.maps.addressvalidation.v1.Address.unconfirmed_component_types] - field in the `english_latin_address` and the - [google.maps.addressvalidation.v1.AddressComponent.confirmation_level] - fields in `english_latin_address.address_components` are not - populated. - geocode: - description: >- - Information about the location and place that the address geocoded - to. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' - id: GoogleMapsAddressvalidationV1ValidationResult - GoogleMapsAddressvalidationV1AddressMetadata: - id: GoogleMapsAddressvalidationV1AddressMetadata - properties: - residential: - description: >- - Indicates that this is the address of a residence. If unset, - indicates that the value is unknown. - type: boolean - business: + descriptions](https://developers.google.com/maps/launch-stages). + Enables the Address Validation API to include additional information + in the response. + address: description: >- - Indicates that this is the address of a business. If unset, - indicates that the value is unknown. - type: boolean - poBox: - type: boolean + Required. The address being validated. Unformatted addresses should + be submitted via `address_lines`. The total length of the fields in + this input must not exceed 280 characters. Supported regions can be + found + [here](https://developers.google.com/maps/documentation/address-validation/coverage). + The language_code value in the input address is reserved for future + uses and is ignored today. The validated address result will be + populated based on the preferred language for the given address, as + identified by the system. The Address Validation API ignores the + values in recipients and organization. Any values in those fields + will be discarded and not returned. Please do not set them. + $ref: '#/components/schemas/GoogleTypePostalAddress' + sessionToken: + type: string description: >- - Indicates that the address of a PO box. If unset, indicates that the - value is unknown. - description: >- - The metadata for the address. `metadata` is not guaranteed to be fully - populated for every address sent to the Address Validation API. + Optional. A string which identifies an Autocomplete session for + billing purposes. Must be a URL and filename safe base64 string with + at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT + error is returned. The session begins when the user makes an + Autocomplete query, and concludes when they select a place and a + call to Place Details or Address Validation is made. Each session + can have multiple Autocomplete queries, followed by one Place + Details or Address Validation request. The credentials used for each + request within a session must belong to the same Google Cloud + Console project. Once a session has concluded, the token is no + longer valid; your app must generate a fresh token for each session. + If the `sessionToken` parameter is omitted, or if you reuse a + session token, the session is charged as if no session token was + provided (each request is billed separately). Note: Address + Validation can only be used in sessions with the Autocomplete (New) + API, not the Autocomplete API. See + https://developers.google.com/maps/documentation/places/web-service/session-pricing + for more details. + description: The request for validating an address. type: object GoogleMapsAddressvalidationV1Verdict: + id: GoogleMapsAddressvalidationV1Verdict description: High level overview of the address validation result and geocode. type: object - id: GoogleMapsAddressvalidationV1Verdict properties: - validationGranularity: + addressComplete: description: >- - The granularity level that the API can fully **validate** the - address to. For example, an `validation_granularity` of `PREMISE` - indicates all address components at the level of `PREMISE` or more - coarse can be validated. Per address component validation result can - be found in - [google.maps.addressvalidation.v1.Address.address_components]. - type: string - enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER + The address is considered complete if there are no unresolved + tokens, no unexpected or missing address components. If unset, + indicates that the value is `false`. See `missing_component_types`, + `unresolved_tokens` or `unexpected` fields for more details. + type: boolean + geocodeGranularity: + description: >- + Information about the granularity of the `geocode`. This can be + understood as the semantic meaning of how coarse or fine the + geocoded location is. This can differ from the + `validation_granularity` above occasionally. For example, our + database might record the existence of an apartment number but do + not have a precise location for the apartment within a big apartment + complex. In that case, the `validation_granularity` will be + `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`. enumDescriptions: - Default value. This value is unused. - Below-building level result, such as an apartment. @@ -524,14 +422,6 @@ components: - >- All other granularities, which are bucketed together since they are not deliverable. - hasInferredComponents: - type: boolean - description: >- - At least one address component was inferred (added) that wasn't in - the input, see - [google.maps.addressvalidation.v1.Address.address_components] for - details. - inputGranularity: type: string enum: - GRANULARITY_UNSPECIFIED @@ -541,6 +431,7 @@ components: - BLOCK - ROUTE - OTHER + inputGranularity: enumDescriptions: - Default value. This value is unused. - Below-building level result, such as an apartment. @@ -557,6 +448,14 @@ components: - >- All other granularities, which are bucketed together since they are not deliverable. + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER description: >- The granularity of the **input** address. This is the result of parsing the input address and does not give any validation signals. @@ -566,8 +465,30 @@ components: cannot match the apartment number in the databases or the apartment number is invalid, the `validation_granularity` will likely be `PREMISE` or below. - geocodeGranularity: type: string + hasUnconfirmedComponents: + description: >- + At least one address component cannot be categorized or validated, + see [google.maps.addressvalidation.v1.Address.address_components] + for details. + type: boolean + validationGranularity: + type: string + description: >- + The granularity level that the API can fully **validate** the + address to. For example, an `validation_granularity` of `PREMISE` + indicates all address components at the level of `PREMISE` or more + coarse can be validated. Per address component validation result can + be found in + [google.maps.addressvalidation.v1.Address.address_components]. + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER enumDescriptions: - Default value. This value is unused. - Below-building level result, such as an apartment. @@ -584,66 +505,66 @@ components: - >- All other granularities, which are bucketed together since they are not deliverable. - enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER + hasInferredComponents: + type: boolean description: >- - Information about the granularity of the `geocode`. This can be - understood as the semantic meaning of how coarse or fine the - geocoded location is. This can differ from the - `validation_granularity` above occasionally. For example, our - database might record the existence of an apartment number but do - not have a precise location for the apartment within a big apartment - complex. In that case, the `validation_granularity` will be - `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`. + At least one address component was inferred (added) that wasn't in + the input, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. hasReplacedComponents: - type: boolean description: >- At least one address component was replaced, see [google.maps.addressvalidation.v1.Address.address_components] for details. - hasUnconfirmedComponents: - description: >- - At least one address component cannot be categorized or validated, - see [google.maps.addressvalidation.v1.Address.address_components] - for details. - type: boolean - addressComplete: type: boolean - description: >- - The address is considered complete if there are no unresolved - tokens, no unexpected or missing address components. If unset, - indicates that the value is `false`. See `missing_component_types`, - `unresolved_tokens` or `unexpected` fields for more details. - GoogleMapsAddressvalidationV1PlusCode: + GoogleMapsAddressvalidationV1AddressMetadata: + id: GoogleMapsAddressvalidationV1AddressMetadata + type: object description: >- - Plus code (http://plus.codes) is a location reference with two formats: - global code defining a 14mx14m (1/8000th of a degree) or smaller - rectangle, and compound code, replacing the prefix with a reference - location. + The metadata for the address. `metadata` is not guaranteed to be fully + populated for every address sent to the Address Validation API. properties: - globalCode: + residential: description: >- - Place's global (full) code, such as "9FWM33GV+HQ", representing an - 1/8000 by 1/8000 degree area (~14 by 14 meters). - type: string - compoundCode: - type: string + Indicates that this is the address of a residence. If unset, + indicates that the value is unknown. + type: boolean + poBox: + type: boolean description: >- - Place's compound code, such as "33GV+HQ, Ramberg, Norway", - containing the suffix of the global code and replacing the prefix - with a formatted name of a reference entity. - type: object - id: GoogleMapsAddressvalidationV1PlusCode + Indicates that the address of a PO box. If unset, indicates that the + value is unknown. + business: + type: boolean + description: >- + Indicates that this is the address of a business. If unset, + indicates that the value is unknown. GoogleMapsAddressvalidationV1Geocode: - description: Contains information about the place the input was geocoded to. id: GoogleMapsAddressvalidationV1Geocode + description: Contains information about the place the input was geocoded to. + type: object properties: + bounds: + description: The bounds of the geocoded place. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + placeTypes: + items: + type: string + type: array + description: >- + The type(s) of place that the input geocoded to. For example, + `['locality', 'political']`. The full list of types can be found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + plusCode: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' + description: The plus code corresponding to the `location`. + placeId: + type: string + description: >- + The PlaceID of the place this input geocodes to. For more + information about Place IDs see + [here](https://developers.google.com/maps/documentation/places/web-service/place-id). location: $ref: '#/components/schemas/GoogleTypeLatLng' description: >- @@ -656,109 +577,204 @@ components: to the property. Additionally, when a location is reverse geocoded, there is no guarantee that the returned address will match the original. - placeId: - description: >- - The PlaceID of the place this input geocodes to. For more - information about Place IDs see - [here](https://developers.google.com/maps/documentation/places/web-service/place-id). - type: string - bounds: - description: The bounds of the geocoded place. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - plusCode: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' - description: The plus code corresponding to the `location`. - placeTypes: - description: >- - The type(s) of place that the input geocoded to. For example, - `['locality', 'political']`. The full list of types can be found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - type: array - items: - type: string featureSizeMeters: + format: float type: number description: >- The size of the geocoded place, in meters. This is another measure of the coarseness of the geocoded location, but in physical size rather than in semantic meaning. - format: float + GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse + properties: {} + description: >- + The response for validation feedback. The response is empty if the + feedback is sent successfully. + type: object + GoogleMapsAddressvalidationV1AddressComponent: + properties: + componentName: + description: The name for this component. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' + replaced: + description: >- + Indicates the name of the component was replaced with a completely + different one, for example a wrong postal code being replaced with + one that is correct for the address. This is not a cosmetic change, + the input component has been changed to a different one. + type: boolean + inferred: + type: boolean + description: >- + Indicates that the component was not part of the input, but we + inferred it for the address location and believe it should be + provided for a complete address. + spellCorrected: + description: >- + Indicates a correction to a misspelling in the component name. The + API does not always flag changes from one spelling variant to + another, such as when changing "centre" to "center". It also does + not always flag common misspellings, such as when changing + "Amphitheater Pkwy" to "Amphitheatre Pkwy". + type: boolean + unexpected: + type: boolean + description: >- + Indicates an address component that is not expected to be present in + a postal address for the given region. We have retained it only + because it was part of the input. + componentType: + description: >- + The type of the address component. See [Table 2: Additional types + returned by the Places + service](https://developers.google.com/places/web-service/supported_types#table2) + for a list of possible types. + type: string + confirmationLevel: + enumDescriptions: + - Default value. This value is unused. + - >- + We were able to verify that this component exists and makes sense + in the context of the rest of the address. + - >- + This component could not be confirmed, but it is plausible that it + exists. For example, a street number within a known valid range of + numbers on a street where specific house numbers are not known. + - >- + This component was not confirmed and is likely to be wrong. For + example, a neighborhood that does not fit the rest of the address. + enum: + - CONFIRMATION_LEVEL_UNSPECIFIED + - CONFIRMED + - UNCONFIRMED_BUT_PLAUSIBLE + - UNCONFIRMED_AND_SUSPICIOUS + type: string + description: >- + Indicates the level of certainty that we have that the component is + correct. + description: Represents an address component, such as a street, city, or state. type: object + id: GoogleMapsAddressvalidationV1AddressComponent GoogleMapsAddressvalidationV1ComponentName: id: GoogleMapsAddressvalidationV1ComponentName - description: A wrapper for the name of the component. - type: object properties: + text: + type: string + description: >- + The name text. For example, "5th Avenue" for a street name or "1253" + for a street number. languageCode: type: string description: >- - The BCP-47 language code. This will not be present if the component - name is not associated with a language, such as a street number. - text: - type: string + The BCP-47 language code. This will not be present if the component + name is not associated with a language, such as a street number. + description: A wrapper for the name of the component. + type: object + GoogleMapsAddressvalidationV1ValidationResult: + id: GoogleMapsAddressvalidationV1ValidationResult + type: object + description: The result of validating an address. + properties: + uspsData: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' + description: >- + Extra deliverability flags provided by USPS. Only provided in region + `US` and `PR`. + englishLatinAddress: + description: >- + Preview: This feature is in Preview (pre-GA). Pre-GA products and + features might have limited support, and changes to pre-GA products + and features might not be compatible with other pre-GA versions. + Pre-GA Offerings are covered by the [Google Maps Platform Service + Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). The + address translated to English. Translated addresses are not reusable + as API input. The service provides them so that the user can use + their native language to confirm or deny the validation of the + originally-provided address. If part of the address doesn't have an + English translation, the service returns that part in an alternate + language that uses a Latin script. See + [here](https://developers.google.com/maps/documentation/address-validation/convert-addresses-english) + for an explanation of how the alternate language is selected. If + part of the address doesn't have any translations or + transliterations in a language that uses a Latin script, the service + returns that part in the local language associated with the address. + Enable this output by using the + [google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address] + flag. Note: the + [google.maps.addressvalidation.v1.Address.unconfirmed_component_types] + field in the `english_latin_address` and the + [google.maps.addressvalidation.v1.AddressComponent.confirmation_level] + fields in `english_latin_address.address_components` are not + populated. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' + geocode: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' + description: >- + Information about the location and place that the address geocoded + to. + metadata: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressMetadata' description: >- - The name text. For example, "5th Avenue" for a street name or "1253" - for a street number. - GoogleGeoTypeViewport: + Other information relevant to deliverability. `metadata` is not + guaranteed to be fully populated for every address sent to the + Address Validation API. + verdict: + description: Overall verdict flags + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' + address: + description: Information about the address itself as opposed to the geocode. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' + GoogleMapsAddressvalidationV1LanguageOptions: properties: - high: - description: Required. The high point of the viewport. - $ref: '#/components/schemas/GoogleTypeLatLng' - low: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The low point of the viewport. - id: GoogleGeoTypeViewport + returnEnglishLatinAddress: + type: boolean + description: >- + Preview: Return a [google.maps.addressvalidation.v1.Address] in + English. See + [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] + for details. type: object description: >- - A latitude-longitude viewport, represented as two diagonally opposite - `low` and `high` points. A viewport is considered a closed region, i.e. - it includes its boundary. The latitude bounds must range between -90 to - 90 degrees inclusive, and the longitude bounds must range between -180 - to 180 degrees inclusive. Various cases include: - If `low` = `high`, - the viewport consists of that single point. - If `low.longitude` > - `high.longitude`, the longitude range is inverted (the viewport crosses - the 180 degree longitude line). - If `low.longitude` = -180 degrees and - `high.longitude` = 180 degrees, the viewport includes all longitudes. - - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, - the longitude range is empty. - If `low.latitude` > `high.latitude`, the - latitude range is empty. Both `low` and `high` must be populated, and - the represented box cannot be empty (as specified by the definitions - above). An empty viewport will result in an error. For example, this - viewport fully encloses New York City: { "low": { "latitude": 40.477398, - "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": - -73.70018 } } + Preview: This feature is in Preview (pre-GA). Pre-GA products and + features might have limited support, and changes to pre-GA products and + features might not be compatible with other pre-GA versions. Pre-GA + Offerings are covered by the [Google Maps Platform Service Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). Enables + the Address Validation API to include additional information in the + response. + id: GoogleMapsAddressvalidationV1LanguageOptions GoogleMapsAddressvalidationV1UspsData: - description: >- - The USPS data for the address. `uspsData` is not guaranteed to be fully - populated for every US or PR address sent to the Address Validation API. - It's recommended to integrate the backup address fields in the response - if you utilize uspsData as the primary part of the response. id: GoogleMapsAddressvalidationV1UspsData - type: object properties: - elotNumber: - type: string - description: Enhanced Line of Travel (eLOT) number. - suitelinkFootnote: + ewsNoMatch: + type: boolean description: >- - Footnotes from matching a street or highrise record to suite - information. If business name match is found, the secondary number - is returned. * `A`: SuiteLink record match, business address - improved. * `00`: No match, business address is not improved. - type: string - carrierRouteIndicator: - description: Carrier route rate sort indicator. + The delivery address is matchable, but the EWS file indicates that + an exact match will be available soon. + cassProcessed: + type: boolean + description: Indicator that the request has been CASS processed. + dpvDoorNotAccessible: + description: >- + Flag indicates addresses where USPS cannot knock on a door to + deliver mail. Returns a single character. * `Y`: The door is not + accessible. * `N`: No indication the door is not accessible. type: string - dpvNoStat: + dpvCmra: type: string description: >- - Is this a no stat address or an active address? No stat addresses - are ones which are not continuously occupied or addresses that the - USPS does not service. Returns a single character. * `Y`: The - address is not active * `N`: The address is active - county: + Indicates if the address is a CMRA (Commercial Mail Receiving + Agency)--a private business receiving mail for clients. Returns a + single character. * `Y`: The address is a CMRA * `N`: The address is + not a CMRA + deliveryPointCode: type: string - description: County name. + description: 2 digit delivery point code addressRecordType: description: >- Type of the address record that matches the input address. * `F`: @@ -772,37 +788,12 @@ components: Number ranges. * `S`: STREET RECORD: This is a match to a Street record containing a valid primary number range. type: string - abbreviatedCity: - type: string - description: Abbreviated city. - fipsCountyCode: - description: FIPS county code. - type: string - standardizedAddress: - description: USPS standardized address. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' - dpvNonDeliveryDays: - description: >- - Flag indicates mail delivery is not performed every day of the week. - Returns a single character. * `Y`: The mail delivery is not - performed every day of the week. * `N`: No indication the mail - delivery is not performed every day of the week. - type: string - carrierRoute: + lacsLinkIndicator: type: string - description: >- - The carrier route code. A four character code consisting of a one - letter prefix and a three digit route designator. Prefixes: * `C`: - Carrier route (or city route) * `R`: Rural route * `H`: Highway - Contract Route * `B`: Post Office Box Section * `G`: General - delivery unit - defaultAddress: - description: >- - Indicator that a default address was found, but more specific - addresses exists. - type: boolean + description: LACSLink indicator. dpvNoStatReasonCode: type: integer + format: int32 description: >- Indicates the NoStat type. Returns a reason code as int. * `1`: IDA (Internal Drop Address) – Addresses that do not receive mail @@ -816,44 +807,6 @@ components: Indicates addresses not receiving delivery and the addresses are not counted as possible deliveries. * `6`: Secondary Required - The address requires secondary information. - format: int32 - postOfficeState: - type: string - description: Main post office state. - postOfficeCity: - description: Main post office city. - type: string - dpvVacant: - description: >- - Is this place vacant? Returns a single character. * `Y`: The address - is vacant * `N`: The address is not vacant - type: string - dpvThrowback: - description: >- - Indicates that mail is not delivered to the street address. Returns - a single character. * `Y`: The mail is not delivered to the street - address. * `N`: The mail is delivered to the street address. - type: string - ewsNoMatch: - type: boolean - description: >- - The delivery address is matchable, but the EWS file indicates that - an exact match will be available soon. - lacsLinkReturnCode: - description: LACSLink return code. - type: string - elotFlag: - description: eLOT Ascending/Descending Flag (A/D). - type: string - pmbNumber: - description: PMB (Private Mail Box) number; - type: string - pmbDesignator: - description: PMB (Private Mail Box) unit designator. - type: string - cassProcessed: - type: boolean - description: Indicator that the request has been CASS processed. dpvFootnote: description: >- The footnotes from delivery point validation. Multiple footnotes may @@ -873,34 +826,81 @@ components: `IA`: Informed Address identified * `TA`: Primary number matched by dropping a trailing alpha type: string + standardizedAddress: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' + description: USPS standardized address. + dpvEnhancedDeliveryCode: + description: >- + Indicates that more than one DPV return code is valid for the + address. Returns a single character. * `Y`: Address was DPV + confirmed for primary and any secondary numbers. * `N`: Primary and + any secondary number information failed to DPV confirm. * `S`: + Address was DPV confirmed for the primary number only, and the + secondary number information was present but not confirmed, or a + single trailing alpha on a primary number was dropped to make a DPV + match and secondary information required. * `D`: Address was DPV + confirmed for the primary number only, and the secondary number + information was missing. * `R`: Address confirmed but assigned to + phantom route R777 and R779 and USPS delivery is not provided. + type: string + dpvNonDeliveryDays: + type: string + description: >- + Flag indicates mail delivery is not performed every day of the week. + Returns a single character. * `Y`: The mail delivery is not + performed every day of the week. * `N`: No indication the mail + delivery is not performed every day of the week. + carrierRoute: + type: string + description: >- + The carrier route code. A four character code consisting of a one + letter prefix and a three digit route designator. Prefixes: * `C`: + Carrier route (or city route) * `R`: Rural route * `H`: Highway + Contract Route * `B`: Post Office Box Section * `G`: General + delivery unit + poBoxOnlyPostalCode: + type: boolean + description: PO Box only postal code. + dpvNoSecureLocation: + description: >- + Flag indicates door is accessible, but package will not be left due + to security concerns. Returns a single character. * `Y`: The package + will not be left due to security concerns. * `N`: No indication the + package will not be left due to security concerns. + type: string + county: + type: string + description: County name. + suitelinkFootnote: + description: >- + Footnotes from matching a street or highrise record to suite + information. If business name match is found, the secondary number + is returned. * `A`: SuiteLink record match, business address + improved. * `00`: No match, business address is not improved. + type: string + elotNumber: + type: string + description: Enhanced Line of Travel (eLOT) number. dpvPbsa: description: >- Indicates the address was matched to PBSA record. Returns a single character. * `Y`: The address was matched to PBSA record. * `N`: The address was not matched to PBSA record. type: string - deliveryPointCode: - description: 2 digit delivery point code - type: string - dpvNonDeliveryDaysValues: - format: int32 - type: integer + defaultAddress: description: >- - Integer identifying non-delivery days. It can be interrogated using - bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a - non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – - Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery - day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a - non-delivery day - dpvDoorNotAccessible: + Indicator that a default address was found, but more specific + addresses exists. + type: boolean + postOfficeCity: + description: Main post office city. + type: string + dpvThrowback: description: >- - Flag indicates addresses where USPS cannot knock on a door to - deliver mail. Returns a single character. * `Y`: The door is not - accessible. * `N`: No indication the door is not accessible. + Indicates that mail is not delivered to the street address. Returns + a single character. * `Y`: The mail is not delivered to the street + address. * `N`: The mail is delivered to the street address. type: string - poBoxOnlyPostalCode: - type: boolean - description: PO Box only postal code. dpvDrop: description: >- Flag indicates mail is delivered to a single receptable at a site. @@ -908,8 +908,8 @@ components: receptable at a site. * `N`: The mail is not delivered to a single receptable at a site. type: string - lacsLinkIndicator: - description: LACSLink indicator. + elotFlag: + description: eLOT Ascending/Descending Flag (A/D). type: string errorMessage: type: string @@ -918,47 +918,27 @@ components: processing is suspended because of the detection of artificially created addresses. The USPS data fields might not be populated when this error is present. - dpvCmra: + dpvVacant: description: >- - Indicates if the address is a CMRA (Commercial Mail Receiving - Agency)--a private business receiving mail for clients. Returns a - single character. * `Y`: The address is a CMRA * `N`: The address is - not a CMRA + Is this place vacant? Returns a single character. * `Y`: The address + is vacant * `N`: The address is not vacant type: string - dpvConfirmation: + dpvNoStat: description: >- - The possible values for DPV confirmation. Returns a single character - or returns no value. * `N`: Primary and any secondary number - information failed to DPV confirm. * `D`: Address was DPV confirmed - for the primary number only, and the secondary number information - was missing. * `S`: Address was DPV confirmed for the primary number - only, and the secondary number information was present but not - confirmed. * `Y`: Address was DPV confirmed for primary and any - secondary numbers. * Empty: If the response does not contain a - `dpv_confirmation` value, the address was not submitted for DPV - confirmation. + Is this a no stat address or an active address? No stat addresses + are ones which are not continuously occupied or addresses that the + USPS does not service. Returns a single character. * `Y`: The + address is not active * `N`: The address is active type: string - dpvNoSecureLocation: + lacsLinkReturnCode: + description: LACSLink return code. type: string - description: >- - Flag indicates door is accessible, but package will not be left due - to security concerns. Returns a single character. * `Y`: The package - will not be left due to security concerns. * `N`: No indication the - package will not be left due to security concerns. - dpvEnhancedDeliveryCode: + pmbNumber: + description: PMB (Private Mail Box) number; + type: string + fipsCountyCode: + description: FIPS county code. type: string - description: >- - Indicates that more than one DPV return code is valid for the - address. Returns a single character. * `Y`: Address was DPV - confirmed for primary and any secondary numbers. * `N`: Primary and - any secondary number information failed to DPV confirm. * `S`: - Address was DPV confirmed for the primary number only, and the - secondary number information was present but not confirmed, or a - single trailing alpha on a primary number was dropped to make a DPV - match and secondary information required. * `D`: Address was DPV - confirmed for the primary number only, and the secondary number - information was missing. * `R`: Address confirmed but assigned to - phantom route R777 and R779 and USPS delivery is not provided. deliveryPointCheckDigit: description: >- The delivery point check digit. This number is added to the end of @@ -967,39 +947,87 @@ components: delivery_point_check_digit, postal code, and ZIP+4 together should yield a number divisible by 10. type: string - GoogleMapsAddressvalidationV1LanguageOptions: - id: GoogleMapsAddressvalidationV1LanguageOptions - description: >- - Preview: This feature is in Preview (pre-GA). Pre-GA products and - features might have limited support, and changes to pre-GA products and - features might not be compatible with other pre-GA versions. Pre-GA - Offerings are covered by the [Google Maps Platform Service Specific - Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). - For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). Enables - the Address Validation API to include additional information in the - response. - type: object - properties: - returnEnglishLatinAddress: + dpvNonDeliveryDaysValues: + format: int32 + type: integer description: >- - Preview: Return a [google.maps.addressvalidation.v1.Address] in - English. See - [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] - for details. - type: boolean - GoogleMapsAddressvalidationV1Address: + Integer identifying non-delivery days. It can be interrogated using + bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a + non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – + Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery + day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a + non-delivery day + carrierRouteIndicator: + type: string + description: Carrier route rate sort indicator. + abbreviatedCity: + description: Abbreviated city. + type: string + postOfficeState: + type: string + description: Main post office state. + pmbDesignator: + description: PMB (Private Mail Box) unit designator. + type: string + dpvConfirmation: + type: string + description: >- + The possible values for DPV confirmation. Returns a single character + or returns no value. * `N`: Primary and any secondary number + information failed to DPV confirm. * `D`: Address was DPV confirmed + for the primary number only, and the secondary number information + was missing. * `S`: Address was DPV confirmed for the primary number + only, and the secondary number information was present but not + confirmed. * `Y`: Address was DPV confirmed for primary and any + secondary numbers. * Empty: If the response does not contain a + `dpv_confirmation` value, the address was not submitted for DPV + confirmation. type: object + description: >- + The USPS data for the address. `uspsData` is not guaranteed to be fully + populated for every US or PR address sent to the Address Validation API. + It's recommended to integrate the backup address fields in the response + if you utilize uspsData as the primary part of the response. + GoogleMapsAddressvalidationV1Address: + id: GoogleMapsAddressvalidationV1Address description: >- Details of the post-processed address. Post-processing includes correcting misspelled parts of the address, replacing incorrect parts, and inferring missing parts. - id: GoogleMapsAddressvalidationV1Address properties: - missingComponentTypes: + unconfirmedComponentTypes: + description: >- + The types of the components that are present in the + `address_components` but could not be confirmed to be correct. This + field is provided for the sake of convenience: its contents are + equivalent to iterating through the `address_components` to find the + types of all the components where the confirmation_level is not + CONFIRMED or the inferred flag is not set to `true`. The list of + possible types can be found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + items: + type: string type: array + postalAddress: + $ref: '#/components/schemas/GoogleTypePostalAddress' + description: The post-processed address represented as a postal address. + unresolvedTokens: items: type: string + description: >- + Any tokens in the input that could not be resolved. This might be an + input that was not recognized as a valid part of an address (for + example in an input like "123235253253 Main St, San Francisco, CA, + 94105", the unresolved tokens may look like `["123235253253"]` since + that does not look like a valid street number. + type: array + formattedAddress: + type: string + description: >- + The post-processed address, formatted as a single-line address + following the address formatting rules of the region where the + address is located. + missingComponentTypes: description: >- The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input @@ -1009,20 +1037,10 @@ components: "Boulder, Colorado, 80301, USA". The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - unresolvedTokens: type: array items: type: string - description: >- - Any tokens in the input that could not be resolved. This might be an - input that was not recognized as a valid part of an address (for - example in an input like "123235253253 Main St, San Francisco, CA, - 94105", the unresolved tokens may look like `["123235253253"]` since - that does not look like a valid street number. addressComponents: - type: array - items: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressComponent' description: >- Unordered list. The individual address components of the formatted and corrected address, along with validation information. This @@ -1030,28 +1048,10 @@ components: components. Address components are not ordered in a particular way. Do not make any assumptions on the ordering of the address components in the list. - unconfirmedComponentTypes: - description: >- - The types of the components that are present in the - `address_components` but could not be confirmed to be correct. This - field is provided for the sake of convenience: its contents are - equivalent to iterating through the `address_components` to find the - types of all the components where the confirmation_level is not - CONFIRMED or the inferred flag is not set to `true`. The list of - possible types can be found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - type: array items: - type: string - postalAddress: - description: The post-processed address represented as a postal address. - $ref: '#/components/schemas/GoogleTypePostalAddress' - formattedAddress: - description: >- - The post-processed address, formatted as a single-line address - following the address formatting rules of the region where the - address is located. - type: string + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressComponent' + type: array + type: object parameters: prettyPrint: description: Returns response with indentations and line breaks. @@ -1059,6 +1059,21 @@ components: name: prettyPrint schema: type: boolean + 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. + in: query + name: key + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -1074,30 +1089,18 @@ components: name: upload_protocol schema: 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. - in: query - name: key - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string alt: description: Data format for response. in: query @@ -1108,28 +1111,25 @@ components: - json - media - proto - access_token: - description: OAuth access token. + _.xgafv: + description: V1 error format. in: query - name: access_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' callback: description: JSONP in: query name: callback schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token schema: type: string x-stackQL-resources: @@ -1160,16 +1160,16 @@ paths: /v1:validateAddress: parameters: &ref_1 - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' post: description: Validates an address. operationId: addressvalidation.validateAddress diff --git a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml index 949e197f..eac15767 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml @@ -7,8 +7,8 @@ info: title: Advisory Notifications API description: An API for accessing Advisory Notifications in Google Cloud version: v1 - x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240918' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/advisory-notifications servers: @@ -34,161 +34,74 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAdvisorynotificationsV1Message: - description: A message which contains notification details. - id: GoogleCloudAdvisorynotificationsV1Message - type: object - properties: - localizationTime: - format: google-datetime - type: string - description: Time when Message was localized - body: - description: The message content. - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' - createTime: - format: google-datetime - description: The Message creation timestamp. - type: string - attachments: - description: The attachments to download. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' - GoogleCloudAdvisorynotificationsV1Text: - type: object - id: GoogleCloudAdvisorynotificationsV1Text - description: A text object containing the English text and its localized copies. - properties: - localizationState: - type: string - enum: - - LOCALIZATION_STATE_UNSPECIFIED - - LOCALIZATION_STATE_NOT_APPLICABLE - - LOCALIZATION_STATE_PENDING - - LOCALIZATION_STATE_COMPLETED - description: Status of the localization. - enumDescriptions: - - Not used. - - >- - Localization is not applicable for requested language. This can - happen when: - The requested language was not supported by - Advisory Notifications at the time of localization (including - notifications created before the localization feature was - launched). - The requested language is English, so only the - English text is returned. - - >- - Localization for requested language is in progress, and not ready - yet. - - Localization for requested language is completed. - enText: - description: The English copy. - type: string - localizedText: - description: The requested localized copy (if applicable). - type: string - GoogleCloudAdvisorynotificationsV1ListNotificationsResponse: - description: Response of ListNotifications endpoint. - properties: - nextPageToken: - type: string - 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. - notifications: - items: - $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification - type: array - description: List of notifications under a given parent. - totalSize: - type: integer - description: Estimation of a total number of notifications. - format: int32 - id: GoogleCloudAdvisorynotificationsV1ListNotificationsResponse - type: object - GoogleCloudAdvisorynotificationsV1Csv: - id: GoogleCloudAdvisorynotificationsV1Csv + GoogleCloudAdvisorynotificationsV1CsvCsvRow: type: object + description: A representation of a single data row in a CSV file. properties: - dataRows: + entries: type: array - items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' description: >- - The list of data rows in a CSV file, as string arrays rather than as - a single comma-separated string. - headers: - type: array + The data entries in a CSV file row, as a string array rather than a + single comma-separated string. items: type: string - description: The list of headers for data columns in a CSV file. - description: >- - A representation of a CSV file attachment, as a list of column headers - and a list of data rows. - GoogleCloudAdvisorynotificationsV1Subject: - description: A subject line of a notification. - type: object - id: GoogleCloudAdvisorynotificationsV1Subject - properties: - text: - description: The text content. - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' - GoogleCloudAdvisorynotificationsV1NotificationSettings: - properties: - enabled: - description: Whether the associated NotificationType is enabled. - type: boolean - type: object - description: Settings for each NotificationType. - id: GoogleCloudAdvisorynotificationsV1NotificationSettings + id: GoogleCloudAdvisorynotificationsV1CsvCsvRow GoogleCloudAdvisorynotificationsV1Settings: properties: + notificationSettings: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAdvisorynotificationsV1NotificationSettings + type: object + description: >- + Required. Map of each notification type and its settings to get/set + all settings at once. The server will validate the value for each + notification type. etag: + type: string description: >- Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle. - type: string name: description: >- Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. type: string - notificationSettings: - description: >- - Required. Map of each notification type and its settings to get/set - all settings at once. The server will validate the value for each - notification type. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1NotificationSettings - type: object type: object - id: GoogleCloudAdvisorynotificationsV1Settings description: Settings for Advisory Notifications. - GoogleCloudAdvisorynotificationsV1CsvCsvRow: + id: GoogleCloudAdvisorynotificationsV1Settings + GoogleCloudAdvisorynotificationsV1NotificationSettings: + properties: + enabled: + type: boolean + description: Whether the associated NotificationType is enabled. type: object + description: Settings for each NotificationType. + id: GoogleCloudAdvisorynotificationsV1NotificationSettings + GoogleCloudAdvisorynotificationsV1MessageBody: + id: GoogleCloudAdvisorynotificationsV1MessageBody properties: - entries: - description: >- - The data entries in a CSV file row, as a string array rather than a - single comma-separated string. - type: array - items: - type: string - description: A representation of a single data row in a CSV file. - id: GoogleCloudAdvisorynotificationsV1CsvCsvRow + text: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' + description: The text content of the message body. + type: object + description: A message body containing text. GoogleCloudAdvisorynotificationsV1Notification: + description: >- + A notification object for notifying customers about security and privacy + issues. + type: object properties: - messages: - items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Message' - type: array - description: A list of messages in the notification. notificationType: + enum: + - NOTIFICATION_TYPE_UNSPECIFIED + - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY + - NOTIFICATION_TYPE_SENSITIVE_ACTIONS + - NOTIFICATION_TYPE_SECURITY_MSA + - NOTIFICATION_TYPE_THREAT_HORIZONS description: Type of notification enumDescriptions: - Default type @@ -196,57 +109,159 @@ components: - Sensitive action notifications - General security MSA - Threat horizons MSA - enum: - - NOTIFICATION_TYPE_UNSPECIFIED - - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY - - NOTIFICATION_TYPE_SENSITIVE_ACTIONS - - NOTIFICATION_TYPE_SECURITY_MSA - - NOTIFICATION_TYPE_THREAT_HORIZONS type: string name: + type: string description: >- The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{project}/locations/{location}/notifications/{notification}. - type: string createTime: - format: google-datetime - type: string description: Output only. Time the notification was created. readOnly: true + type: string + format: google-datetime + messages: + description: A list of messages in the notification. + items: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Message' + type: array subject: $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Subject' description: The subject line of the notification. id: GoogleCloudAdvisorynotificationsV1Notification - description: >- - A notification object for notifying customers about security and privacy - issues. - type: object GoogleCloudAdvisorynotificationsV1Attachment: - id: GoogleCloudAdvisorynotificationsV1Attachment - description: Attachment with specific information about the issue. type: object + id: GoogleCloudAdvisorynotificationsV1Attachment properties: - displayName: - type: string - description: The title of the attachment. csv: $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' description: A CSV file attachment. Max size is 10 MB. - GoogleCloudAdvisorynotificationsV1MessageBody: + displayName: + type: string + description: The title of the attachment. + description: Attachment with specific information about the issue. + GoogleCloudAdvisorynotificationsV1ListNotificationsResponse: + properties: + notifications: + description: List of notifications under a given parent. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + nextPageToken: + type: string + 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. + totalSize: + format: int32 + description: Estimation of a total number of notifications. + type: integer + description: Response of ListNotifications endpoint. + type: object + id: GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + GoogleCloudAdvisorynotificationsV1Subject: properties: text: - description: The text content of the message body. $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' - id: GoogleCloudAdvisorynotificationsV1MessageBody + description: The text content. type: object - description: A message body containing text. + description: A subject line of a notification. + id: GoogleCloudAdvisorynotificationsV1Subject + GoogleCloudAdvisorynotificationsV1Csv: + type: object + description: >- + A representation of a CSV file attachment, as a list of column headers + and a list of data rows. + properties: + headers: + items: + type: string + type: array + description: The list of headers for data columns in a CSV file. + dataRows: + description: >- + The list of data rows in a CSV file, as string arrays rather than as + a single comma-separated string. + items: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' + type: array + id: GoogleCloudAdvisorynotificationsV1Csv + GoogleCloudAdvisorynotificationsV1Text: + description: A text object containing the English text and its localized copies. + type: object + properties: + localizedText: + type: string + description: The requested localized copy (if applicable). + localizationState: + description: Status of the localization. + enum: + - LOCALIZATION_STATE_UNSPECIFIED + - LOCALIZATION_STATE_NOT_APPLICABLE + - LOCALIZATION_STATE_PENDING + - LOCALIZATION_STATE_COMPLETED + enumDescriptions: + - Not used. + - >- + Localization is not applicable for requested language. This can + happen when: - The requested language was not supported by + Advisory Notifications at the time of localization (including + notifications created before the localization feature was + launched). - The requested language is English, so only the + English text is returned. + - >- + Localization for requested language is in progress, and not ready + yet. + - Localization for requested language is completed. + type: string + enText: + type: string + description: The English copy. + id: GoogleCloudAdvisorynotificationsV1Text + GoogleCloudAdvisorynotificationsV1Message: + description: A message which contains notification details. + type: object + id: GoogleCloudAdvisorynotificationsV1Message + properties: + localizationTime: + type: string + format: google-datetime + description: Time when Message was localized + body: + description: The message content. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' + createTime: + format: google-datetime + description: The Message creation timestamp. + type: string + attachments: + items: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' + description: The attachments to download. + type: array parameters: - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token + schema: + 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. + in: query + name: key + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string quotaUser: @@ -258,52 +273,46 @@ components: name: quotaUser schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt schema: type: string + enum: + - json + - media + - proto upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -313,15 +322,6 @@ components: enum: - '1' - '2' - 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. - in: query - name: key - schema: - type: string x-stackQL-resources: notifications: id: google.advisorynotifications.notifications @@ -381,17 +381,17 @@ components: paths: /v1/projects/{projectsId}/locations/{locationsId}/notifications/{notificationsId}: parameters: &ref_1 - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' get: description: Gets a notification. operationId: advisorynotifications.projects.locations.notifications.get @@ -458,7 +458,7 @@ paths: schema: type: string - in: query - name: languageCode + name: pageToken schema: type: string - in: query @@ -467,7 +467,7 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: languageCode schema: type: string - in: query @@ -535,11 +535,11 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/settings: + /v1/organizations/{organizationsId}/locations/{locationsId}/notifications: parameters: *ref_1 get: - description: Get notification settings. - operationId: advisorynotifications.organizations.locations.getSettings + description: Lists notifications under a given parent. + operationId: advisorynotifications.organizations.locations.notifications.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -552,7 +552,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse parameters: - in: path name: organizationsId @@ -564,14 +564,28 @@ paths: required: true schema: type: string - patch: - description: Update notification settings. - operationId: advisorynotifications.organizations.locations.updateSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' + - in: query + name: view + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: + parameters: *ref_1 + get: + description: Gets a notification. + operationId: advisorynotifications.organizations.locations.notifications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -584,7 +598,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification parameters: - in: path name: organizationsId @@ -596,11 +610,25 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: + - in: path + name: notificationsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/settings: parameters: *ref_1 - get: - description: Gets a notification. - operationId: advisorynotifications.organizations.locations.notifications.get + patch: + description: Update notification settings. + operationId: advisorynotifications.organizations.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -613,7 +641,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path name: organizationsId @@ -625,20 +653,9 @@ paths: required: true schema: type: string - - in: path - name: notificationsId - required: true - schema: - type: string - - in: query - name: languageCode - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/notifications: - parameters: *ref_1 get: - description: Lists notifications under a given parent. - operationId: advisorynotifications.organizations.locations.notifications.list + description: Get notification settings. + operationId: advisorynotifications.organizations.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -651,7 +668,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path name: organizationsId @@ -663,20 +680,3 @@ paths: required: true schema: type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: view - schema: - type: string - - in: query - name: pageToken - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml index 6de234dc..fec578f2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml @@ -9,8 +9,8 @@ info: Train high-quality custom machine learning models with minimal machine learning expertise and effort. version: v1 - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240907' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/vertex-ai/ servers: @@ -24,12 +24,12 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform: >- - See, edit, configure, and delete your Google Cloud data and see - the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only: >- View your data across Google Cloud services and see the email address of your Google Account + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -39,570 +39,532 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset: - description: Represents one Dataset in datalabeling.googleapis.com. + GoogleCloudAiplatformV1RayMetricSpec: + description: Configuration for the Ray metrics. + id: GoogleCloudAiplatformV1RayMetricSpec type: object properties: - dataset: + disabled: + type: boolean + description: Optional. Flag to disable the Ray metrics collection. + GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable: + type: object + properties: + bigqueryTablePath: description: >- - Full resource name of data labeling Dataset. Format: - `projects/{project}/datasets/{dataset}`. + The created BigQuery table to store logs. Customer could do their + own query & analysis. Format: `bq://.model_deployment_monitoring_._` type: string - datasetDisplayName: - description: The Dataset's display name in datalabeling.googleapis.com. + logSource: + enum: + - LOG_SOURCE_UNSPECIFIED + - TRAINING + - SERVING + enumDescriptions: + - Unspecified source. + - Logs coming from Training dataset. + - Logs coming from Serving traffic. type: string - dataLabelingAnnotatedDatasets: - description: >- - The migratable AnnotatedDataset in datalabeling.googleapis.com - belongs to the data labeling Dataset. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset - type: array - id: GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation - type: object - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. - properties: - timeFormat: + description: The source of log. + logType: + description: The type of log. type: string - description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) - columnName: + enumDescriptions: + - Unspecified type. + - Predict logs. + - Explain logs. + enum: + - LOG_TYPE_UNSPECIFIED + - PREDICT + - EXPLAIN + requestResponseLoggingSchemaVersion: + readOnly: true type: string - GoogleCloudAiplatformV1DataItemView: - description: A container for a single DataItem and Annotations on it. - id: GoogleCloudAiplatformV1DataItemView + description: >- + Output only. The schema version of the request/response logging + BigQuery table. Default to v1 if unset. + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable + description: >- + ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name + as well as some information of the logs stored in this table. + GoogleCloudAiplatformV1ListDatasetsResponse: + id: GoogleCloudAiplatformV1ListDatasetsResponse type: object + description: Response message for DatasetService.ListDatasets. properties: - annotations: - type: array + nextPageToken: + type: string + description: The standard List next-page token. + datasets: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' - description: >- - The Annotations on the DataItem. If too many Annotations should be - returned for the DataItem, this field will be truncated per - annotations_limit in request. If it was, then the - has_truncated_annotations will be set to true. - dataItem: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' - description: The DataItem. - hasTruncatedAnnotations: - type: boolean - description: >- - True if and only if the Annotations field has been truncated. It - happens if more Annotations for this DataItem met the request's - annotation_filter than are allowed to be returned by - annotations_limit. Note that if Annotations field is not being - returned due to field mask, then this field will not be set to true - no matter how many Annotations are there. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics - description: Metrics for general pairwise text generation evaluation results. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + description: A list of Datasets that matches the specified filter in the request. + type: array + GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig: + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + description: The config for scheduling monitoring job. type: object properties: - accuracy: - format: float - type: number - description: Fraction of cases where the autorater agreed with the human raters. - baselineModelWinRate: + monitorWindow: description: >- - Percentage of time the autorater decided the baseline model had the - better response. - type: number - format: float - falseNegativeCount: + The time window of the prediction data being included in each + prediction dataset. This window specifies how long the data should + be collected from historical model results for each run. If not set, + ModelDeploymentMonitoringScheduleConfig.monitor_interval will be + used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and + the monitor_window is set to be 3600, then data from 2022-01-08 + 13:30:00 to 2022-01-08 14:30:00 will be retrieved and aggregated to + calculate the monitoring statistics. type: string + format: google-duration + monitorInterval: description: >- - Number of examples where the autorater chose the baseline model, but - humans preferred the model. - format: int64 - precision: - type: number - format: float - description: >- - Fraction of cases where the autorater and humans thought the model - had a better response out of all cases where the autorater thought - the model had a better response. True positive divided by all - positive. - falsePositiveCount: - format: int64 - description: >- - Number of examples where the autorater chose the model, but humans - preferred the baseline model. + Required. The model monitoring job scheduling interval. It will be + rounded up to next full hour. This defines how often the monitoring + jobs are triggered. type: string - modelWinRate: + format: google-duration + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult: + properties: + score: type: number - description: >- - Percentage of time the autorater decided the model had the better - response. + readOnly: true format: float - truePositiveCount: - description: >- - Number of examples where both the autorater and humans decided that - the model had the better response. - type: string - format: int64 - f1Score: - description: Harmonic mean of precision and recall. - type: number + description: Output only. Question Answering Correctness score. + confidence: format: float - humanPreferenceModelWinRate: + description: Output only. Confidence for question answering correctness score. + readOnly: true type: number - format: float - description: Percentage of time humans decided the model had the better response. - trueNegativeCount: + explanation: + readOnly: true + description: Output only. Explanation for question answering correctness score. type: string - format: int64 - description: >- - Number of examples where both the autorater and humans decided that - the model had the worse response. - recall: - type: number - description: >- - Fraction of cases where the autorater and humans thought the model - had a better response out of all cases where the humans thought the - model had a better response. - format: float - cohensKappa: - type: number - description: >- - A measurement of agreement between the autorater and human raters - that takes the likelihood of random agreement into account. - format: float - humanPreferenceBaselineModelWinRate: - description: >- - Percentage of time humans decided the baseline model had the better - response. - type: number - format: float - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition: type: object - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition - properties: - values: - type: array - items: - type: number - format: double - description: >- - Required. Matches values of the parent parameter of 'DISCRETE' type. - All values must exist in `discrete_value_spec` of parent parameter. - The Epsilon of the value matching is 1e-10. - description: Represents the spec to match discrete values from parent parameter. - GoogleCloudAiplatformV1ListIndexesResponse: + description: Spec for question answering correctness result. + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult + GoogleCloudAiplatformV1ContainerRegistryDestination: + type: object + id: GoogleCloudAiplatformV1ContainerRegistryDestination properties: - indexes: - description: List of indexes in the requested page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' - nextPageToken: + outputUri: type: string description: >- - A token to retrieve next page of results. Pass to - ListIndexesRequest.page_token to obtain that page. - type: object - id: GoogleCloudAiplatformV1ListIndexesResponse - description: Response message for IndexService.ListIndexes. - GoogleIamV1Binding: + Required. Container Registry URI of a container image. Only Google + Container Registry and Artifact Registry are supported now. Accepted + forms: * Google Container Registry path. For example: + `gcr.io/projectId/imageName:tag`. * Artifact Registry path. For + example: + `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`. If a + tag is not specified, "latest" will be used as the default tag. + description: The Container Registry location for the container image. + GoogleCloudAiplatformV1VertexRagStoreRagResource: properties: - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - role: + ragCorpus: type: string description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - members: + Optional. RagCorpora resource name. Format: + `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + ragFileIds: type: array items: type: string description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. - type: object - GoogleCloudAiplatformV1PublisherModelDocumentation: - description: A named piece of documentation. - id: GoogleCloudAiplatformV1PublisherModelDocumentation - properties: - content: - type: string - description: Required. Content of this piece of document (in Markdown format). - title: - type: string - description: >- - Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, - JAVA, NODE.JS, etc.. - type: object - GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: + Optional. rag_file_id. The files should be in the same rag_corpus + set in rag_corpus field. + id: GoogleCloudAiplatformV1VertexRagStoreRagResource + description: The definition of the Rag resource. type: object + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame: properties: - sum: - description: Output only. Sum of a given population of values. - readOnly: true - format: int64 - type: string - p5: - type: number - readOnly: true - description: Output only. The 5th percentile of the values in the population. - format: double - mean: + xMin: type: number - readOnly: true - format: double - description: Output only. The arithmetic mean of the values in the population. - billableSum: - format: int64 - description: Output only. Sum of a given population of values that are billable. + format: float + description: The leftmost coordinate of the bounding box. + timeOffset: + description: >- + A time (frame) of a video in which the object has been detected. + Expressed as a number of seconds as measured from the start of the + video, with fractions up to a microsecond precision, and with "s" + appended at the end. type: string - readOnly: true - max: - format: double - description: Output only. The maximum of the population values. - readOnly: true - type: number - buckets: - type: array - readOnly: true - description: Output only. Defines the histogram bucket. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket - median: - description: Output only. The median of the values in the population. - readOnly: true - format: double + format: google-duration + xMax: + format: float type: number - p95: - format: double - description: Output only. The 95th percentile of the values in the population. + description: The rightmost coordinate of the bounding box. + yMax: type: number - readOnly: true - min: - description: Output only. The minimum of the population values. - readOnly: true + format: float + description: The bottommost coordinate of the bounding box. + yMin: type: number - format: double - description: Dataset distribution for Supervised Tuning. - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - GoogleCloudAiplatformV1Segment: + description: The topmost coordinate of the bounding box. + format: float + description: >- + The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box, + i.e. the rectangle over the video frame pinpointing the found + AnnotationSpec. The coordinates are relative to the frame size, and the + point 0,0 is in the top left of the frame. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame + type: object + GoogleCloudAiplatformV1RawPredictRequest: + description: Request message for PredictionService.RawPredict. type: object + id: GoogleCloudAiplatformV1RawPredictRequest properties: - startIndex: - readOnly: true - type: integer + httpBody: + $ref: '#/components/schemas/GoogleApiHttpBody' description: >- - Output only. Start index in the given Part, measured in bytes. - Offset from the start of the Part, inclusive, starting at zero. - format: int32 - endIndex: - readOnly: true - type: integer + The prediction input. Supports HTTP headers and arbitrary data + payload. A DeployedModel may have an upper limit on the number of + instances it supports per request. When this limit it is exceeded + for an AutoML model, the RawPredict method returns an error. When + this limit is exceeded for a custom-trained model, the behavior + varies depending on the model. You can specify the schema for each + instance in the predict_schemata.instance_schema_uri field when you + create a Model. This schema applies when you deploy the `Model` as a + `DeployedModel` to an Endpoint and use the `RawPredict` method. + GoogleCloudAiplatformV1RaySpec: + properties: + headNodeResourcePoolId: + type: string description: >- - Output only. End index in the given Part, measured in bytes. Offset - from the start of the Part, exclusive, starting at zero. - format: int32 - partIndex: - format: int32 + Optional. This will be used to indicate which resource pool will + serve as the Ray head node(the first node within that pool). Will + use the machine from the first workerpool as the head node by + default if this field isn't set. + resourcePoolImages: + additionalProperties: + type: string + type: object description: >- - Output only. The index of a Part object within its parent Content - object. - readOnly: true - type: integer - text: + Optional. Required if image_uri isn't set. A map of resource_pool_id + to prebuild Ray image if user need to use different images for + different head/worker pools. This map needs to cover all the + resource pool ids. Example: { "ray_head_node_pool": "head image" + "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": + "another worker image" } + rayLogsSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RayLogsSpec' + description: Optional. OSS Ray logging configurations. + rayMetricSpec: + description: Optional. Ray metrics configurations. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RayMetricSpec' + imageUri: description: >- - Output only. The text corresponding to the segment from the - response. + Optional. Default image for user to choose a preferred ML framework + (for example, TensorFlow or Pytorch) by choosing from [Vertex + prebuilt + images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). + Either this or the resource_pool_images is required. Use this field + if you need all the resource pools to have the same Ray image. + Otherwise, use the {@code resource_pool_images} field. type: string - readOnly: true - id: GoogleCloudAiplatformV1Segment - description: Segment of the content. - GoogleCloudAiplatformV1CsvSource: - id: GoogleCloudAiplatformV1CsvSource - description: The storage details for CSV input content. - properties: - gcsSource: - description: Required. Google Cloud Storage location. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + id: GoogleCloudAiplatformV1RaySpec type: object - GoogleCloudAiplatformV1Tool: - properties: - 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 64 function declarations can be provided. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionDeclaration' - type: array - googleSearchRetrieval: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' - description: >- - Optional. GoogleSearchRetrieval tool type. Specialized retrieval - tool that is powered by Google search. - retrieval: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' - description: >- - Optional. Retrieval tool type. System will always execute the - provided retrieval tool(s) to get external knowledge to answer the - prompt. Retrieval results are presented to the model for generation. description: >- - Tool details that the model may use to generate response. A `Tool` is a - piece of code that enables the system to interact with external systems - to perform an action, or set of actions, outside of knowledge and scope - of the model. A Tool object should contain exactly one type of Tool (e.g - FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - type: object - id: GoogleCloudAiplatformV1Tool - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation - properties: - columnName: - type: string - type: object + Configuration information for the Ray cluster. For experimental launch, + Ray cluster creation and Persistent cluster creation are 1:1 mapping: We + will provision all the nodes within the Persistent cluster as Ray nodes. + GoogleCloudAiplatformV1InputDataConfig: description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset: + Specifies Vertex AI owned input data to be used for training, and + possibly evaluating, the Model. type: object - description: Training Dataset information. - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset properties: - loggingSamplingStrategy: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' + predefinedSplit: description: >- - Strategy to sample data from Training Dataset. If not set, we - process the whole dataset. - dataFormat: + Supported only for tabular Datasets. Split based on a predefined + key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedSplit' + annotationSchemaUri: + description: >- + Applicable only to custom training with Datasets that have DataItems + and Annotations. Cloud Storage URI that points to a YAML file + describing the annotation schema. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that + the chosen schema must be consistent with metadata of the Dataset + specified by dataset_id. Only Annotations that both match this + schema and belong to DataItems not ignored by the split method are + used in respectively training, validation or test role, depending on + the role of the DataItem they are on. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both annotations_filter and annotation_schema_uri. type: string + stratifiedSplit: description: >- - Data format of the dataset, only applicable if the input is from - Google Cloud Storage. The possible formats are: "tf-record" The - source file is a TFRecord file. "csv" The source file is a CSV file. - "jsonl" The source file is a JSONL file. - targetField: + Supported only for tabular Datasets. Split based on the distribution + of the specified column. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StratifiedSplit' + fractionSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FractionSplit' + description: Split based on fractions defining the size of each set. + annotationsFilter: type: string description: >- - The target field name the model is to predict. This field will be - excluded when doing Predict and (or) Explain for the training data. - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + Applicable only to Datasets that have DataItems and Annotations. A + filter on Annotations of the Dataset. Only Annotations that both + match this filter and belong to DataItems not ignored by the split + method are used in respectively training, validation or test role, + depending on the role of the DataItem they are on (for the + auto-assigned that role is decided by Vertex AI). A filter with same + syntax as the one used in ListAnnotations may be used, but note here + it filters across all Annotations of the Dataset, and not just + within a single DataItem. + bigqueryDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' description: >- - The Google Cloud Storage uri of the unmanaged Dataset used to train - this Model. - bigquerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + Only applicable to custom training with tabular Dataset with + BigQuery source. The BigQuery project location where the training + data is to be written to. In the given project a new dataset is + created with name `dataset___` where timestamp is in + YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written + into that dataset. In the dataset three tables are created, + `training`, `validation` and `test`. * AIP_DATA_FORMAT = "bigquery". + * AIP_TRAINING_DATA_URI = "bigquery_destination.dataset___.training" + * AIP_VALIDATION_DATA_URI = + "bigquery_destination.dataset___.validation" * AIP_TEST_DATA_URI = + "bigquery_destination.dataset___.test" + timestampSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimestampSplit' description: >- - The BigQuery table of the unmanaged Dataset used to train this - Model. - dataset: - description: The resource name of the Dataset used to train this Model. - type: string - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: - id: >- - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult - type: object - properties: - dataset: + Supported only for tabular Datasets. Split based on the timestamp of + the input data pieces. + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: >- + The Cloud Storage location where the training data is to be written + to. In the given directory a new directory is created with name: + `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 + format. All training input data is written into that directory. The + Vertex AI environment variables representing Cloud Storage data URIs + are represented in the Cloud Storage wildcard format to support + sharded data. e.g.: "gs://.../training-*.jsonl" * AIP_DATA_FORMAT = + "jsonl" for non-tabular data, "csv" for tabular data * + AIP_TRAINING_DATA_URI = + "gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}" * + AIP_VALIDATION_DATA_URI = + "gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}" * + AIP_TEST_DATA_URI = + "gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}" + filterSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FilterSplit' + description: Split based on the provided filters for each set. + savedQueryId: + description: >- + Only applicable to Datasets that have SavedQueries. The ID of a + SavedQuery (annotation set) under the Dataset specified by + dataset_id used for filtering Annotations for training. Only + Annotations that are associated with this SavedQuery are used in + respectively training. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both saved_query_id and annotations_filter. Only one of + saved_query_id and annotation_schema_uri should be specified as both + of them represent the same thing: problem type. type: string - description: Migrated dataset resource name. - model: + persistMlUseAssignment: + type: boolean + description: Whether to persist the ML use assignment to data item system labels. + datasetId: type: string - description: Migrated model resource name. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The error result of the migration request in case of failure. - request: description: >- - It's the same as the value in - MigrateResourceRequest.migrate_resource_requests. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' - description: >- - Represents a partial result in batch migration operation for one - MigrateResourceRequest. - GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec: + Required. The ID of the Dataset in the same Project and Location + which data will be used to train the Model. The Dataset must use + schema compatible with Model being trained, and what is compatible + should be described in the used TrainingPipeline's + training_task_definition. For tabular Datasets, all their data is + exported to training, to pick and choose from. + id: GoogleCloudAiplatformV1InputDataConfig + GoogleCloudAiplatformV1MetadataSchema: type: object - id: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec + description: Instance of a general MetadataSchema. + id: GoogleCloudAiplatformV1MetadataSchema properties: - minReplicaCount: - description: >- - Optional. min replicas in the node pool, must be ≤ replica_count and - < max_replica_count or will throw error. For autoscaling enabled - Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 - to match the OSS Ray - behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). - As for Persistent Resource, the min_replica_count must be > 0, we - added a corresponding validation inside - CreatePersistentResourceRequestValidator.java. + description: + type: string + description: Description of the Metadata Schema + schemaType: + enumDescriptions: + - Unspecified type for the MetadataSchema. + - >- + A type indicating that the MetadataSchema will be used by + Artifacts. + - >- + A typee indicating that the MetadataSchema will be used by + Executions. + - >- + A state indicating that the MetadataSchema will be used by + Contexts. type: string - format: int64 - maxReplicaCount: - format: int64 description: >- - Optional. max replicas in the node pool, must be ≥ replica_count and - > min_replica_count or will throw error + The type of the MetadataSchema. This is a property that identifies + which metadata types will use the MetadataSchema. + enum: + - METADATA_SCHEMA_TYPE_UNSPECIFIED + - ARTIFACT_TYPE + - EXECUTION_TYPE + - CONTEXT_TYPE + schemaVersion: type: string - description: The min/max number of replicas allowed if enabling autoscaling - GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint: - type: object - description: >- - The dedicated serving endpoint for this FeatureOnlineStore. Only need to - set when you choose Optimized storage type. Public endpoint is - provisioned by default. - id: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint - properties: - privateServiceConnectConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig description: >- - Optional. Private service connect config. The private service - connection is available only for Optimized storage type, not for - embedding management now. If - PrivateServiceConnectConfig.enable_private_service_connect set to - true, customers will use private service connection to send request. - Otherwise, the connection will set to public endpoint. - publicEndpointDomainName: + The version of the MetadataSchema. The version's format must match + the following regular expression: `^[0-9]+.+.+$`, which would allow + to order/compare different versions. Example: 1.0.0, 1.0.1, etc. + name: + type: string + description: Output only. The resource name of the MetadataSchema. readOnly: true + schema: description: >- - Output only. This field will be populated with the domain name to - use for this FeatureOnlineStore + Required. The raw YAML string representation of the MetadataSchema. + The combination of [MetadataSchema.version] and the schema name + given by `title` in [MetadataSchema.schema] must be unique within a + MetadataStore. The schema is defined as an OpenAPI 3.0.2 + [MetadataSchema + Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) type: string - serviceAttachment: - description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled and after FeatureViewSync is - created. + createTime: type: string readOnly: true - GoogleCloudAiplatformV1Port: - id: GoogleCloudAiplatformV1Port - description: Represents a network port in a container. + format: google-datetime + description: Output only. Timestamp when this MetadataSchema was created. + GoogleCloudAiplatformV1MutateDeployedModelResponse: + type: object + id: GoogleCloudAiplatformV1MutateDeployedModelResponse properties: - containerPort: + deployedModel: + description: The DeployedModel that's being mutated. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: Response message for EndpointService.MutateDeployedModel. + GoogleCloudAiplatformV1RougeSpec: + type: object + id: GoogleCloudAiplatformV1RougeSpec + properties: + rougeType: + type: string description: >- - The number of the port to expose on the pod's IP address. Must be a - valid port number, between 1 and 65535 inclusive. - format: int32 - type: integer + Optional. Supported rouge types are rougen[1-9], rougeL, and + rougeLsum. + splitSummaries: + type: boolean + description: Optional. Whether to split summaries while using rougeLsum. + useStemmer: + description: Optional. Whether to use stemmer to compute rouge score. + type: boolean + description: >- + Spec for rouge score metric - calculates the recall of n-grams in + prediction as compared to reference - returns a score ranging between 0 + and 1. + GoogleCloudAiplatformV1DataLabelingJob: type: object - GoogleCloudAiplatformV1TuningJob: properties: - supervisedTuningSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' - description: Tuning Spec for Supervised Fine Tuning. - tuningDataStats: + instructionUri: + type: string description: >- - Output only. The tuning data statistics associated with this - TuningJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' + Required. The Google Cloud Storage location of the instruction pdf. + This pdf is shared with labelers, and provides detailed description + on how to label DataItems in Datasets. + encryptionSpec: + description: >- + Customer-managed encryption key spec for a DataLabelingJob. If set, + this DataLabelingJob will be secured by this key. Note: Annotations + created in the DataLabelingJob are associated with the + EncryptionSpec of the Dataset they are exported to. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + createTime: readOnly: true - name: + format: google-datetime + type: string + description: Output only. Timestamp when this DataLabelingJob was created. + datasets: + description: >- + Required. Dataset resource names. Right now we only support labeling + from a single Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}` + items: + type: string + type: array + labelerCount: + type: integer + format: int32 + description: Required. Number of labelers to work on each DataItem. + error: + description: >- + Output only. DataLabelingJob errors. It is only populated when job's + state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' readOnly: true + annotationLabels: + type: object description: >- - Output only. Identifier. Resource name of a TuningJob. Format: - `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + Labels to assign to annotations generated by this DataLabelingJob. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + additionalProperties: + type: string + updateTime: + format: google-datetime + readOnly: true + description: >- + Output only. Timestamp when this DataLabelingJob was updated most + recently. + type: string + inputs: + type: any + description: Required. Input config parameters for the DataLabelingJob. + displayName: + type: string + description: >- + Required. The user-defined name of the DataLabelingJob. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. Display name of a DataLabelingJob. + name: + description: Output only. Resource name of the DataLabelingJob. + readOnly: true type: string + currentSpend: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + Output only. Estimated cost(in US dollars) that the DataLabelingJob + has incurred to date. + readOnly: true + activeLearningConfig: + description: >- + Parameters that configure the active learning pipeline. Active + learning will label the data incrementally via several iterations. + For every iteration, it will select a batch of data based on the + sampling strategy. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' + specialistPools: + items: + type: string + type: array + description: The SpecialistPools' resource names associated with this job. state: type: string + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + readOnly: true enumDescriptions: - The job state is unspecified. - >- @@ -625,5265 +587,4463 @@ components: - >- The job is partially succeeded, some results may be missing due to errors. - readOnly: true - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED description: Output only. The detailed state of the job. - updateTime: - description: Output only. Time when the TuningJob was most recently updated. - readOnly: true + inputsSchemaUri: type: string - format: google-datetime - tunedModel: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' description: >- - Output only. The tuned model resources assiociated with this - TuningJob. - encryptionSpec: - description: >- - Customer-managed encryption key options for a TuningJob. If this is - set, then all resources created by the TuningJob will be encrypted - with the provided encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - tunedModelDisplayName: + Required. Points to a YAML file stored on Google Cloud Storage + describing the config for a specific type of DataLabelingJob. The + schema files that can be used here are found in the + https://storage.googleapis.com/google-cloud-aiplatform bucket in the + /schema/datalabelingjob/inputs/ folder. + labels: description: >- - Optional. The display name of the TunedModel. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - type: string - endTime: + The labels with user-defined metadata to organize your + DataLabelingJobs. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for each DataLabelingJob: * + "aiplatform.googleapis.com/schema": output only, its value is the + inputs_schema's title. + additionalProperties: + type: string + type: object + labelingProgress: description: >- - Output only. Time when the TuningJob entered any of the following - JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. - format: google-datetime + Output only. Current labeling job progress percentage scaled in + interval [0, 100], indicating the percentage of DataItems that has + been finished. readOnly: true + format: int32 + type: integer + id: GoogleCloudAiplatformV1DataLabelingJob + description: >- + DataLabelingJob is used to trigger a human labeling job on unlabeled + data from the following Dataset: + GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: + id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata + description: Metadata information for NotebookService.AssignNotebookRuntime. + properties: + progressMessage: type: string - experiment: + description: >- + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + type: object + GoogleCloudAiplatformV1CreateFeatureRequest: + id: GoogleCloudAiplatformV1CreateFeatureRequest + type: object + description: >- + Request message for FeaturestoreService.CreateFeature. Request message + for FeatureRegistryService.CreateFeature. + properties: + parent: type: string - readOnly: true - description: Output only. The Experiment associated with this TuningJob. - error: description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - description: - description: Optional. The description of the TuningJob. + 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}` + featureId: + type: string + 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. + feature: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: Required. The Feature to create. + GoogleCloudAiplatformV1HyperparameterTuningJob: + id: GoogleCloudAiplatformV1HyperparameterTuningJob + type: object + description: >- + Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a + Study specification and multiple CustomJobs with identical CustomJob + specification. + properties: + name: type: string - startTime: - format: google-datetime readOnly: true + description: Output only. Resource name of the HyperparameterTuningJob. + endTime: description: >- - Output only. Time when the TuningJob for the first time entered the - `JOB_STATE_RUNNING` state. + Output only. Time when the HyperparameterTuningJob entered any of + the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + format: google-datetime type: string - createTime: - description: Output only. Time when the TuningJob was created. readOnly: true + createTime: + description: Output only. Time when the HyperparameterTuningJob was created. type: string format: google-datetime - baseModel: - type: string - description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". - labels: + readOnly: true + parallelTrialCount: + format: int32 + description: Required. The desired number of Trials to run in parallel. + type: integer + encryptionSpec: description: >- - Optional. The labels with user-defined metadata to organize - TuningJob and generated resources such as Model and Endpoint. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - type: object - additionalProperties: - type: string - type: object - id: GoogleCloudAiplatformV1TuningJob - description: Represents a TuningJob that runs with Google owned models. - GoogleCloudAiplatformV1ListModelsResponse: - id: GoogleCloudAiplatformV1ListModelsResponse - properties: - nextPageToken: + Customer-managed encryption key options for a + HyperparameterTuningJob. If this is set, then all resources created + by the HyperparameterTuningJob will be encrypted with the provided + encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + displayName: description: >- - A token to retrieve next page of results. Pass to - ListModelsRequest.page_token to obtain that page. + Required. The display name of the HyperparameterTuningJob. The name + can be up to 128 characters long and can consist of any UTF-8 + characters. type: string - models: - description: List of Models in the requested page. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Only populated when job's state is JOB_STATE_FAILED or + JOB_STATE_CANCELLED. + readOnly: true + trials: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + readOnly: true type: array - type: object - description: Response message for ModelService.ListModels - GoogleCloudAiplatformV1ToolNameMatchInstance: - id: GoogleCloudAiplatformV1ToolNameMatchInstance - description: Spec for tool name match instance. - type: object - properties: - reference: - type: string - description: Required. Ground truth used to compare against the prediction. - prediction: - description: Required. Output of the evaluated model. - type: string - GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Runtime operation information for CreateDeploymentResourcePool method. - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata - type: object - GoogleCloudAiplatformV1NetworkSpec: - properties: - subnetwork: - description: >- - The name of the subnet that this instance is in. Format: - `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` - type: string - enableInternetAccess: - description: Whether to enable public internet access. Default false. + description: Output only. Trials of the HyperparameterTuningJob. + satisfiesPzs: type: boolean - network: - description: >- - The full name of the Google Compute Engine - [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) - type: string - description: Network spec. - type: object - id: GoogleCloudAiplatformV1NetworkSpec - GoogleCloudAiplatformV1Context: - properties: - description: - type: string - description: Description of the Context - updateTime: - description: Output only. Timestamp when this Context was last updated. + description: Output only. Reserved for future use. + readOnly: true + startTime: format: google-datetime + description: >- + Output only. Time when the HyperparameterTuningJob for the first + time entered the `JOB_STATE_RUNNING` state. readOnly: true type: string - displayName: + maxTrialCount: + description: Required. The desired total number of Trials. + format: int32 + type: integer + state: + description: Output only. The detailed state of the job. type: string + readOnly: true + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + maxFailedTrialCount: description: >- - User provided display name of the Context. May be up to 128 Unicode - characters. - parentContexts: + The number of failed Trials that need to be seen before failing the + HyperparameterTuningJob. If set to 0, Vertex AI decides how many + Trials must fail before the whole job fails. + type: integer + format: int32 + updateTime: description: >- - Output only. A list of resource names of Contexts that are parents - of this Context. A Context may have at most 10 parent_contexts. + Output only. Time when the HyperparameterTuningJob was most recently + updated. + format: google-datetime readOnly: true - items: - type: string - type: array - createTime: type: string - description: Output only. Timestamp when this Context was created. - readOnly: true - format: google-datetime - labels: - type: object + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + description: Required. Study configuration of the HyperparameterTuningJob. + trialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' description: >- - The labels with user-defined metadata to organize your Contexts. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Context (System - labels are excluded). + Required. The spec of a trial job. The same spec applies to the + CustomJobs created in all the trials. + labels: additionalProperties: type: string - name: - description: Immutable. The resource name of the Context. - type: string - schemaTitle: - type: string description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - metadata: + The labels with user-defined metadata to organize + HyperparameterTuningJobs. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. type: object - additionalProperties: - description: Properties of the object. - type: any - description: >- - Properties of the Context. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. - etag: + GoogleCloudAiplatformV1FeatureViewSync: + properties: + name: description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. + Identifier. Name of the FeatureViewSync. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` type: string - schemaVersion: - description: >- - The version of the schema in schema_name to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. + runTime: + $ref: '#/components/schemas/GoogleTypeInterval' + description: Output only. Time when this FeatureViewSync is finished. + readOnly: true + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + syncSummary: + description: Output only. Summary of the sync job. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncSyncSummary + finalStatus: + description: Output only. Final status of the FeatureViewSync. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + createTime: + format: google-datetime + readOnly: true type: string + description: >- + Output only. Time when this FeatureViewSync is created. Creation of + a FeatureViewSync means that the job is pending / waiting for + sufficient resources but may not have started the actual data + transfer yet. type: object - id: GoogleCloudAiplatformV1Context - description: Instance of a general context. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics: + description: >- + FeatureViewSync is a representation of sync operation which copies data + from data source to Feature View in Online Store. + id: GoogleCloudAiplatformV1FeatureViewSync + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation: type: object - description: Metrics for image object detection evaluation results. id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation + description: >- + A TrainingJob that trains and uploads an AutoML Image Segmentation + Model. properties: - boundingBoxMetrics: - description: >- - The bounding boxes match metrics for each intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata + description: The metadata information. + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs + description: The input parameters of this TrainingJob. + GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader: + type: object + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader + properties: + featureDescriptors: type: array + description: >- + List of Feature metadata corresponding to each piece of + ReadFeatureValuesResponse.EntityView.data. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - evaluatedBoundingBoxCount: - format: int32 - type: integer - description: >- - The total number of bounding boxes (i.e. summed over all images) the - ground truth used to create this evaluation had. - boundingBoxMeanAveragePrecision: + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor + entityType: description: >- - The single metric for bounding boxes evaluation: the - `meanAveragePrecision` averaged over all - `boundingBoxMetricsEntries`. - format: float - type: number - GoogleCloudAiplatformV1ImportFeatureValuesResponse: - id: GoogleCloudAiplatformV1ImportFeatureValuesResponse + The resource name of the EntityType from the + ReadFeatureValuesRequest. Value format: + `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + type: string + description: >- + Response header with metadata for the requested + ReadFeatureValuesRequest.entity_type and Features. + GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec: type: object + description: Defines the Feature value(s) to import. + id: GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec properties: - invalidRowCount: + sourceField: type: string description: >- - The number of rows in input source that weren't imported due to - either * Not having any featureValues. * Having a null entityId. * - Having a null timestamp. * Not being parsable (applicable for CSV - sources). - format: int64 - importedFeatureValueCount: - description: Number of Feature values that have been imported by the operation. + Source column to get the Feature values from. If not set, uses the + column with the same name as the Feature ID. + id: + description: >- + Required. ID of the Feature to import values of. This Feature must + exist in the target EntityType, or the request will fail. type: string - format: int64 - importedEntityCount: - format: int64 + GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics + type: object + properties: + rougeLSum: + description: ROUGE-L (Longest Common Subsequence) scoring at summary level. + type: number + format: float + GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse: + type: object + properties: + nextPageToken: + description: >- + A token to retrieve next page of results. Pass to + ListModelEvaluationSlicesRequest.page_token to obtain that page. type: string - description: Number of entities that have been imported by the operation. - timestampOutsideRetentionRowsCount: + modelEvaluationSlices: + description: List of ModelEvaluations in the requested page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + description: Response message for ModelService.ListModelEvaluationSlices. + id: GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata: + type: object + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + properties: + backingCustomJob: type: string - format: int64 description: >- - The number rows that weren't ingested due to having feature - timestamps outside the retention boundary. - description: Response message for FeaturestoreService.ImportFeatureValues. - GoogleCloudAiplatformV1BatchDedicatedResources: + The resource name of the CustomJob that has been created to carry + out this custom task. + GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest: + properties: + evaluatedAnnotations: + type: array + description: Required. Evaluated annotations resource to be imported. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotation' type: object - id: GoogleCloudAiplatformV1BatchDedicatedResources + description: Request message for ModelService.BatchImportEvaluatedAnnotations + id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation: + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. properties: - maxReplicaCount: - type: integer + columnName: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + type: object + GoogleCloudAiplatformV1SchemaTimeSegment: + properties: + endTimeOffset: + type: string + format: google-duration description: >- - Immutable. The maximum number of machine replicas the batch - operation may be scaled to. The default value is 10. - format: int32 - machineSpec: - description: Required. Immutable. The specification of a single machine. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - startingReplicaCount: - type: integer + End of the time segment (exclusive), represented as the duration + since the start of the DataItem. + startTimeOffset: + type: string 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 - format: int32 + Start of the time segment (inclusive), represented as the duration + since the start of the DataItem. + format: google-duration + id: GoogleCloudAiplatformV1SchemaTimeSegment + type: object description: >- - A description of resources that are used for performing batch - operations, are dedicated to a Model, and need manual configuration. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs + A time period inside of a DataItem that has a time dimension (e.g. + video). + GoogleCloudAiplatformV1ContainerSpec: + id: GoogleCloudAiplatformV1ContainerSpec + type: object properties: - disableEarlyStopping: - type: boolean + args: + description: The arguments to be passed when starting the container. + items: + type: string + type: array + command: + type: array + items: + type: string description: >- - Use the entire training budget. This disables the early stopping - feature. When false the early stopping feature is enabled, which - means that AutoML Image Object Detection might stop training before - the entire training budget has been used. - uptrainBaseModelId: + The command to be invoked when the container is started. It + overrides the entrypoint instruction in Dockerfile when provided. + imageUri: + description: >- + Required. The URI of a container image in the Container Registry + that is to be run on each worker replica. type: string + env: description: >- - The ID of `base` model for upTraining. If it is specified, the new - model will be upTrained based on the `base` model for upTraining. - Otherwise, the new model will be trained from scratch. The `base` - model for upTraining must be in the same Project and Location as the - new Model to train, and have the same modelType. - modelType: - enumDescriptions: - - Should not be set. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to have a higher latency, but should - also have a higher prediction quality than other cloud models. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to have a low latency, but may have - lower prediction quality than other cloud models. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Compared to the CLOUD_HIGH_ACCURACY_1 and - CLOUD_LOW_LATENCY_1 models above, it is expected to have higher - prediction quality and lower latency. - - >- - A model that, in addition to being available within Google Cloud - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. Expected to have - low latency, but may have lower prediction quality than other - mobile models. - - >- - A model that, in addition to being available within Google Cloud - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. Expected to have - a higher latency, but should also have a higher prediction quality - than other mobile models. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to best support predictions in - streaming with lower latency and lower prediction quality than - other cloud models. - - >- - SpineNet for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - YOLO for Model Garden training with customizable hyperparameters. - Best tailored to be used within Google Cloud, and cannot be - exported externally. - type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD_HIGH_ACCURACY_1 - - CLOUD_LOW_LATENCY_1 - - CLOUD_1 - - MOBILE_TF_LOW_LATENCY_1 - - MOBILE_TF_VERSATILE_1 - - MOBILE_TF_HIGH_ACCURACY_1 - - CLOUD_STREAMING_1 - - SPINENET - - YOLO - budgetMilliNodeHours: - description: >- - The training budget of creating this model, expressed in milli node - hours i.e. 1,000 value in this field means 1 node hour. The actual - metadata.costMilliNodeHours will be equal or less than this value. - If further model training ceases to provide any improvements, it - will stop without using the full budget and the - metadata.successfulStopReason will be `model-converged`. Note, - node_hour = actual_hour * number_of_nodes_involved. For modelType - `cloud`(default), the budget must be between 20,000 and 900,000 - milli node hours, inclusive. The default value is 216,000 which - represents one day in wall time, considering 9 nodes are used. For - model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, - `mobile-tf-high-accuracy-1` the training budget must be between - 1,000 and 100,000 milli node hours, inclusive. The default value is - 24,000 which represents one day in wall time on a single node that - is used. - format: int64 - type: string - tunableParameter: - description: Trainer type for Vision TrainRequest. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - type: object - GoogleCloudAiplatformV1UpsertDatapointsResponse: - type: object - description: Response message for IndexService.UpsertDatapoints - id: GoogleCloudAiplatformV1UpsertDatapointsResponse - properties: {} - GoogleCloudAiplatformV1IndexDatapointNumericRestriction: - type: object - description: >- - This field allows restricts to be based on numeric comparisons rather - than categorical tokens. - id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction - properties: - valueDouble: - description: Represents 64 bit float. - type: number - format: double - valueFloat: - description: Represents 32 bit float. - format: float - type: number - valueInt: - type: string - format: int64 - description: Represents 64 bit integer. - op: - enumDescriptions: - - Default value of the enum. - - Datapoints are eligible iff their value is < the query's. - - Datapoints are eligible iff their value is <= the query's. - - Datapoints are eligible iff their value is == the query's. - - Datapoints are eligible iff their value is >= the query's. - - Datapoints are eligible iff their value is > the query's. - - Datapoints are eligible iff their value is != the query's. - type: string - description: >- - This MUST be specified for queries and must NOT be specified for - datapoints. - enum: - - OPERATOR_UNSPECIFIED - - LESS - - LESS_EQUAL - - EQUAL - - GREATER_EQUAL - - GREATER - - NOT_EQUAL - namespace: - description: 'The namespace of this restriction. e.g.: cost.' - type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata: - description: Model metadata specific to AutoML Tables. - properties: - evaluatedDataItemsBigqueryUri: - description: BigQuery destination uri for exported evaluated examples. - type: string - trainCostMilliNodeHours: - description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - format: int64 - type: string - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata - type: object - GoogleCloudAiplatformV1BatchPredictionJob: - id: GoogleCloudAiplatformV1BatchPredictionJob - type: object - description: >- - A job that uses a Model to produce predictions on multiple input - instances. If predictions for significant portion of the instances fail, - the job may finish without attempting predictions for all remaining - instances. + Environment variables to be passed to the container. Maximum limit + is 100. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + type: array + description: The spec of a Container. + GoogleCloudAiplatformV1DataItem: + id: GoogleCloudAiplatformV1DataItem properties: createTime: - readOnly: true format: google-datetime + description: Output only. Timestamp when this DataItem was created. type: string - description: Output only. Time when the BatchPredictionJob was created. - disableContainerLogging: - type: boolean - description: >- - For custom-trained Models and AutoML Tabular Models, the container - of the DeployedModel instances will send `stderr` and `stdout` - streams to Cloud Logging by default. Please note that the logs incur - cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging/pricing). User can disable - container logging by setting this flag to true. - completionStats: - description: >- - Output only. Statistics on completed and failed prediction - instances. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1CompletionStats' - displayName: - type: string - description: Required. The user-defined name of this BatchPredictionJob. - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. readOnly: true labels: - description: >- - The labels with user-defined metadata to organize - BatchPredictionJobs. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. type: object + description: >- + Optional. The labels with user-defined metadata to organize your + DataItems. Label keys and values can be no longer than 64 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are + allowed. No more than 64 user labels can be associated with one + DataItem(System labels are excluded). See https://goo.gl/xmQnxf for + more information and examples of labels. System reserved label keys + are prefixed with "aiplatform.googleapis.com/" and are immutable. additionalProperties: type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' + payload: description: >- - Output only. Only populated when the job's state is JOB_STATE_FAILED - or JOB_STATE_CANCELLED. + Required. The data that the DataItem represents (for example, an + image or a text snippet). The schema of the payload is stored in the + parent Dataset's metadata schema's dataItemSchemaUri field. + type: any + satisfiesPzi: + description: Output only. Reserved for future use. readOnly: true - generateExplanation: type: boolean - description: >- - Generate explanation with the batch prediction results. When set to - `true`, the batch prediction output changes based on the - `predictions_format` field of the BatchPredictionJob.output_config - object: * `bigquery`: output includes a column named `explanation`. - The value is a struct that conforms to the Explanation object. * - `jsonl`: The JSON objects on each line include an additional entry - keyed `explanation`. The value of the entry is a JSON object that - conforms to the Explanation object. * `csv`: Generating explanations - for CSV format is not supported. If this field is set to true, - either the Model.explanation_spec or explanation_spec must be - populated. - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' - description: >- - Explanation configuration for this BatchPredictionJob. Can be - specified only if generate_explanation is set to `true`. This value - overrides the value of Model.explanation_spec. All fields of - explanation_spec are optional in the request. If a field of the - explanation_spec object is not populated, the corresponding field of - the Model.explanation_spec object is inherited. - serviceAccount: - description: >- - The service account that the DeployedModel's container runs as. If - not specified, a system generated one will be used, which has - minimal permissions and the custom container, if used, may not have - enough permission to access other Google Cloud resources. Users - deploying the Model must have the `iam.serviceAccounts.actAs` - permission on this service account. + updateTime: + description: Output only. Timestamp when this DataItem was last updated. + format: google-datetime type: string - manualBatchTuningParameters: - description: >- - Immutable. Parameters configuring the batch behavior. Currently only - applicable when dedicated_resources are used (in other cases Vertex - AI does the tuning itself). - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ManualBatchTuningParameters - dedicatedResources: - description: >- - The config of resources used by the Model during the batch - prediction. If the Model supports DEDICATED_RESOURCES this config - may be provided (and the job will use these resources), if the Model - doesn't support AUTOMATIC_RESOURCES, this config must be provided. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchDedicatedResources' - resourcesConsumed: - description: >- - Output only. Information about resources that had been consumed by - this job. Provided in real time at best effort basis, as well as a - final value once the job completes. Note: This field currently may - be not populated for batch predictions that use AutoML Models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcesConsumed' readOnly: true name: - description: Output only. Resource name of the BatchPredictionJob. + type: string readOnly: true + description: Output only. The resource name of the DataItem. + etag: type: string - model: + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + type: object + description: >- + A piece of data in a Dataset. Could be an image, a video, a document or + plain text. + GoogleCloudAiplatformV1PairwiseMetricInstance: + properties: + jsonInstance: type: string description: >- - The name of the Model resource that produces the predictions via - this job, must share the same ancestor Location. Starting this job - has no impact on any existing deployments of the Model and their - resources. Exactly one of model and unmanaged_container_model must - be set. The model resource name may contain version id or version - alias to specify the version. Example: - `projects/{project}/locations/{location}/models/{model}@2` or - `projects/{project}/locations/{location}/models/{model}@golden` if - no version is specified, the default version will be deployed. The - model resource could also be a publisher model. Example: - `publishers/{publisher}/models/{model}` or - `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` - endTime: + Instance specified as a json string. String key-value pairs are + expected in the json_instance to render + PairwiseMetricSpec.instance_prompt_template. + description: >- + Pairwise metric instance. Usually one instance corresponds to one row in + an evaluation dataset. + id: GoogleCloudAiplatformV1PairwiseMetricInstance + type: object + GoogleCloudAiplatformV1TensorboardRun: + type: object + description: >- + TensorboardRun maps to a specific execution of a training job with a + given set of hyperparameter values, model definition, dataset, etc + properties: + name: type: string readOnly: true description: >- - Output only. Time when the BatchPredictionJob entered any of the - following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - format: google-datetime - unmanagedContainerModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UnmanagedContainerModel' - description: >- - Contains model information necessary to perform batch prediction - without requiring uploading to model registry. Exactly one of model - and unmanaged_container_model must be set. + Output only. Name of the TensorboardRun. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` updateTime: - readOnly: true format: google-datetime - description: >- - Output only. Time when the BatchPredictionJob was most recently - updated. + readOnly: true type: string - instanceConfig: - description: >- - Configuration for how to convert batch prediction input instances to - the prediction instances that are sent to the Model. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig - outputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputConfig + description: Output only. Timestamp when this TensorboardRun was last updated. + description: + type: string + description: Description of this TensorboardRun. + labels: description: >- - Required. The Configuration specifying where output predictions - should be written. The schema of any single prediction may be - specified as a concatenation of Model's PredictSchemata's - instance_schema_uri and prediction_schema_uri. - outputInfo: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputInfo - description: Output only. Information further describing the output of this job. - readOnly: true - inputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInputConfig + The labels with user-defined metadata to organize your + TensorboardRuns. This field will be used to filter and visualize + Runs in the Tensorboard UI. For example, a Vertex AI training job + can set a label aiplatform.googleapis.com/training_job_id=xxxxx to + all the runs created within that job. An end user can set a label + experiment_id=xxxxx for all the runs produced in a Jupyter notebook. + These runs can be grouped by a label value and visualized together + in the Tensorboard UI. Label keys and values can be no longer than + 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. No more than 64 user labels can be + associated with one TensorboardRun (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + type: object + additionalProperties: + type: string + etag: + type: string description: >- - Required. Input configuration of the instances on which predictions - are performed. The schema of any single instance may be specified - via the Model's PredictSchemata's instance_schema_uri. - modelVersionId: + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + displayName: description: >- - Output only. The version ID of the Model that produces the - predictions via this job. - readOnly: true + Required. User provided name of this TensorboardRun. This value must + be unique among all TensorboardRuns belonging to the same parent + TensorboardExperiment. type: string - state: + createTime: type: string - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - description: Output only. The detailed state of the job. - readOnly: true - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean + format: google-datetime + description: Output only. Timestamp when this TensorboardRun was created. readOnly: true - partialFailures: + id: GoogleCloudAiplatformV1TensorboardRun + GoogleCloudAiplatformV1PythonPackageSpec: + type: object + properties: + args: type: array - readOnly: true items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. Partial failures encountered. For example, single files - that can't be read. This field never exceeds 20 entries. Status - details fields contain standard Google Cloud error details. - modelParameters: + type: string + description: Command line arguments to be passed to the Python task. + packageUris: description: >- - The parameters that govern the predictions. The schema of the - parameters may be specified via the Model's PredictSchemata's - parameters_schema_uri. - type: any - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Required. The Google Cloud Storage location of the Python package + files which are the training program and its dependent packages. The + maximum number of package URIs is 100. + items: + type: string + type: array + env: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' description: >- - Customer-managed encryption key options for a BatchPredictionJob. If - this is set, then all resources created by the BatchPredictionJob - will be encrypted with the provided encryption key. - startTime: - format: google-datetime + Environment variables to be passed to the python module. Maximum + limit is 100. + executorImageUri: type: string - readOnly: true description: >- - Output only. Time when the BatchPredictionJob for the first time - entered the `JOB_STATE_RUNNING` state. - GoogleCloudAiplatformV1ExportModelOperationMetadata: - type: object - id: GoogleCloudAiplatformV1ExportModelOperationMetadata - description: Details of ModelService.ExportModel operation. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - outputInfo: + Required. The URI of a container image in Artifact Registry that + will run the provided Python package. Vertex AI provides a wide + range of executor images with pre-installed packages to meet users' + various use cases. See the list of [pre-built containers for + training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). + You must use an image from this list. + pythonModule: description: >- - Output only. Information further describing the output of this Model - export. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo - GoogleCloudAiplatformV1Tensorboard: - type: object + Required. The Python module name to run after installing the + packages. + type: string + description: The spec of a Python packaged code. + id: GoogleCloudAiplatformV1PythonPackageSpec + GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult: properties: - runCount: - description: Output only. The number of Runs stored in this Tensorboard. - readOnly: true - type: integer - format: int32 - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean - readOnly: true - createTime: + explanation: + description: Output only. Explanation for question answering relevance score. type: string - format: google-datetime readOnly: true - description: Output only. Timestamp when this Tensorboard was created. - description: - description: Description of this Tensorboard. - type: string - isDefault: - description: >- - Used to indicate if the TensorBoard instance is the default one. - Each project & region can have at most one default TensorBoard - instance. Creation of a default TensorBoard instance and updating an - existing TensorBoard instance to be default will mark all other - TensorBoard instances (if any) as non default. - type: boolean - name: + score: + readOnly: true + description: Output only. Question Answering Relevance score. + type: number + format: float + confidence: readOnly: true + format: float + type: number + description: Output only. Confidence for question answering relevance score. + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult + description: Spec for question answering relevance result. + type: object + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig: + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig + type: object + properties: + annotatedDataset: type: string description: >- - Output only. Name of the Tensorboard. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}` - displayName: - type: string - description: Required. User provided name of this Tensorboard. - encryptionSpec: + Required. Full resource name of data labeling AnnotatedDataset. + Format: + `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + description: >- + Config for migrating AnnotatedDataset in datalabeling.googleapis.com to + Vertex AI's SavedQuery. + GoogleCloudAiplatformV1Event: + properties: + labels: description: >- - Customer-managed encryption key spec for a Tensorboard. If set, this - Tensorboard and all sub-resources of this Tensorboard will be - secured by this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - blobStoragePathPrefix: - readOnly: true + The labels with user-defined metadata to annotate Events. Label keys + and values can be no longer than 64 characters (Unicode codepoints), + can only contain lowercase letters, numeric characters, underscores + and dashes. International characters are allowed. No more than 64 + user labels can be associated with one Event (System labels are + excluded). See https://goo.gl/xmQnxf for more information and + examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + type: object + additionalProperties: + type: string + type: + enumDescriptions: + - Unspecified whether input or output of the Execution. + - An input of the Execution. + - An output of the Execution. type: string - description: >- - Output only. Consumer project Cloud Storage path prefix used to - store blob data, which can either be a bucket or directory. Does not - end with a '/'. - etag: + description: Required. The type of the Event. + enum: + - TYPE_UNSPECIFIED + - INPUT + - OUTPUT + artifact: + description: Required. The relative resource name of the Artifact in the Event. type: string + execution: description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - updateTime: - format: google-datetime - type: string + Output only. The relative resource name of the Execution in the + Event. readOnly: true - description: Output only. Timestamp when this Tensorboard was last updated. - satisfiesPzs: + type: string + eventTime: readOnly: true - type: boolean - description: Output only. Reserved for future use. - labels: - type: object - description: >- - The labels with user-defined metadata to organize your Tensorboards. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Tensorboard - (System labels are excluded). See https://goo.gl/xmQnxf for more - information and examples of labels. System reserved label keys are - prefixed with "aiplatform.googleapis.com/" and are immutable. - additionalProperties: - type: string - id: GoogleCloudAiplatformV1Tensorboard + description: Output only. Time the Event occurred. + type: string + format: google-datetime description: >- - Tensorboard is a physical database that stores users' training metrics. - A default Tensorboard is provided in each region of a Google Cloud - project. If needed users can also create extra Tensorboards in their - projects. - GoogleCloudAiplatformV1BleuInstance: - id: GoogleCloudAiplatformV1BleuInstance + An edge describing the relationship between an Artifact and an Execution + in a lineage graph. + type: object + id: GoogleCloudAiplatformV1Event + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation: + type: object + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. properties: - reference: - type: string - description: Required. Ground truth used to compare against the prediction. - prediction: - description: Required. Output of the evaluated model. + columnName: type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation + CloudAiLargeModelsVisionRaiInfoDetectedLabels: type: object - description: Spec for bleu instance. + description: Filters returning list of deteceted labels, scores, and bounding boxes. + id: CloudAiLargeModelsVisionRaiInfoDetectedLabels + properties: + raiCategory: + description: The RAI category for the deteceted labels. + type: string + entities: + items: + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + type: array + description: The list of detected entities for the rai signal. GoogleCloudAiplatformV1ListTrialsResponse: type: object + id: GoogleCloudAiplatformV1ListTrialsResponse description: Response message for VizierService.ListTrials. properties: nextPageToken: - type: string description: >- Pass this token as the `page_token` field of the request for a subsequent call. If this field is omitted, there are no subsequent pages. + type: string trials: - description: The Trials associated with the Study. items: $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' type: array - id: GoogleCloudAiplatformV1ListTrialsResponse - GoogleCloudAiplatformV1ReadFeatureValuesRequest: + description: The Trials associated with the Study. + GoogleCloudAiplatformV1ListFeaturesResponse: properties: - entityId: - type: string + nextPageToken: description: >- - Required. ID for a specific entity. For example, for a machine - learning model predicting user clicks on a website, an entity ID - could be `user_123`. - featureSelector: - description: Required. Selector choosing Features of the target EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - id: GoogleCloudAiplatformV1ReadFeatureValuesRequest - type: object - description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. - GoogleCloudAiplatformV1PredefinedSplit: - description: >- - Assigns input data to training, validation, and test sets based on the - value of a provided key. Supported only for tabular Datasets. - properties: - key: + A token, which can be sent as ListFeaturesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. type: string - description: >- - Required. The key is a name of one of the Dataset's data columns. - The value of the key (either the label's value or value in the - column) must be one of {`training`, `validation`, `test`}, and it - defines to which set the given piece of data is assigned. If for a - piece of data the key is not present or has an invalid value, that - piece is ignored by the pipeline. - id: GoogleCloudAiplatformV1PredefinedSplit - type: object - GoogleCloudAiplatformV1ProbeExecAction: - type: object - description: ExecAction specifies a command to execute. - properties: - command: - description: >- - Command is the command line to execute inside the container, the - working directory for the command is root ('/') in the container's - filesystem. The command is simply exec'd, it is not run inside a - shell, so traditional shell instructions ('|', etc) won't work. To - use a shell, you need to explicitly call out to that shell. Exit - status of 0 is treated as live/healthy and non-zero is unhealthy. + features: + description: The Features matching the request. items: - type: string - type: array - id: GoogleCloudAiplatformV1ProbeExecAction - GoogleCloudAiplatformV1ListExecutionsResponse: - properties: - executions: - description: The Executions retrieved from the MetadataStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - nextPageToken: - type: string - description: >- - A token, which can be sent as ListExecutionsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. + description: >- + Response message for FeaturestoreService.ListFeatures. Response message + for FeatureRegistryService.ListFeatures. + id: GoogleCloudAiplatformV1ListFeaturesResponse type: object - description: Response message for MetadataService.ListExecutions. - id: GoogleCloudAiplatformV1ListExecutionsResponse - GoogleCloudAiplatformV1AddContextChildrenResponse: + GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for deleting a MetadataStore. type: object - description: Response message for MetadataService.AddContextChildren. - properties: {} - id: GoogleCloudAiplatformV1AddContextChildrenResponse - GoogleCloudAiplatformV1IndexEndpoint: - description: >- - Indexes are deployed into it. An IndexEndpoint can have multiple - DeployedIndexes. - id: GoogleCloudAiplatformV1IndexEndpoint + description: Details of operations that perform MetadataService.DeleteMetadataStore. + id: GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata + GoogleTypeExpr: type: object properties: - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + expression: + type: string description: >- - Immutable. Customer-managed encryption key spec for an - IndexEndpoint. If set, this IndexEndpoint and all sub-resources of - this IndexEndpoint will be secured by this key. - network: + Textual representation of an expression in Common Expression + Language syntax. + location: description: >- - Optional. The full name of the Google Compute Engine - [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) - to which the IndexEndpoint should be peered. Private services access - must already be configured for the network. If left unspecified, the - Endpoint is not peered with any network. network and - private_service_connect_config are mutually exclusive. - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where {project} is a - project number, as in '12345', and {network} is network name. - type: string - displayName: + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string - description: >- - Required. The display name of the IndexEndpoint. The name can be up - to 128 characters long and can consist of any UTF-8 characters. - publicEndpointDomainName: + description: type: string description: >- - Output only. If public_endpoint_enabled is true, this field will be - populated with the domain name to use for this index endpoint. - readOnly: true - deployedIndexes: - description: Output only. The indexes deployed in this endpoint. - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - type: array - publicEndpointEnabled: - type: boolean - description: >- - Optional. If true, the deployed index will be accessible through - public endpoint. - name: + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + title: type: string - readOnly: true - description: Output only. The resource name of the IndexEndpoint. - enablePrivateServiceConnect: description: >- - Optional. Deprecated: If true, expose the IndexEndpoint via private - service connect. Only one of the fields, network or - enable_private_service_connect, can be set. - type: boolean - deprecated: true - satisfiesPzs: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - etag: + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + id: GoogleTypeExpr + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature: + description: >- + Response message if the request uses the SelectTimeRangeAndFeature + option. + id: >- + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature + properties: + impactedFeatureCount: type: string description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - labels: - additionalProperties: - type: string - description: >- - The labels with user-defined metadata to organize your - IndexEndpoints. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. - type: object - satisfiesPzi: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - privateServiceConnectConfig: + The count of the features or columns impacted. This is the same as + the feature count in the request. + format: int64 + onlineStorageModifiedEntityCount: description: >- - Optional. Configuration for private service connect. network and - private_service_connect_config are mutually exclusive. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig - createTime: - description: Output only. Timestamp when this IndexEndpoint was created. - readOnly: true - type: string - format: google-datetime - description: - description: The description of the IndexEndpoint. + The count of modified entities in the online storage. Each entity ID + corresponds to one entity. Within each entity, only the features + specified in the request are deleted. + format: int64 type: string - updateTime: + offlineStorageModifiedEntityRowCount: description: >- - Output only. Timestamp when this IndexEndpoint was last updated. - This timestamp is not updated when the endpoint's DeployedIndexes - are updated, e.g. due to updates of the original Indexes they are - the deployments of. + The count of modified entity rows in the offline storage. Each row + corresponds to the combination of an entity ID and a timestamp. One + entity ID can have multiple rows in the offline storage. Within each + row, only the features specified in the request are deleted. + format: int64 type: string - readOnly: true - format: google-datetime - GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue: type: object + GoogleCloudAiplatformV1ListTensorboardRunsResponse: + description: Response message for TensorboardService.ListTensorboardRuns. + type: object + properties: + nextPageToken: + type: string + description: >- + A token, which can be sent as ListTensorboardRunsRequest.page_token + to retrieve the next page. If this field is omitted, there are no + subsequent pages. + tensorboardRuns: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + type: array + description: The TensorboardRuns mathching the request. + id: GoogleCloudAiplatformV1ListTensorboardRunsResponse + GoogleCloudAiplatformV1SummarizationHelpfulnessResult: + description: Spec for summarization helpfulness result. properties: score: - description: Output only. Tool parameter key match score. + readOnly: true + format: float type: number + description: Output only. Summarization Helpfulness score. + explanation: readOnly: true + type: string + description: Output only. Explanation for summarization helpfulness score. + confidence: + description: Output only. Confidence for summarization helpfulness score. + type: number format: float - id: GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue - description: Tool parameter key match metric value for an instance. - GoogleCloudAiplatformV1WorkerPoolSpec: + readOnly: true + id: GoogleCloudAiplatformV1SummarizationHelpfulnessResult type: object - description: Represents the spec of a worker pool in a job. + GoogleCloudAiplatformV1BleuSpec: + type: object + description: >- + Spec for bleu score metric - calculates the precision of n-grams in the + prediction as compared to reference - returns a score ranging between 0 + to 1. + id: GoogleCloudAiplatformV1BleuSpec properties: - machineSpec: - description: Optional. Immutable. The specification of a single machine. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - nfsMounts: - type: array - description: Optional. List of NFS mount spec. + useEffectiveOrder: + description: Optional. Whether to use_effective_order to compute bleu score. + type: boolean + GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse: + description: Response message for ModelService.BatchImportModelEvaluationSlices + type: object + id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse + properties: + importedModelEvaluationSlices: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' - diskSpec: - description: Disk spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - replicaCount: - description: Optional. The number of worker replicas to use for this worker pool. - type: string - format: int64 - containerSpec: - description: The custom container task. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' - pythonPackageSpec: - description: The Python packaged task. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' - id: GoogleCloudAiplatformV1WorkerPoolSpec - GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport: + type: string + readOnly: true + type: array + description: Output only. List of imported ModelEvaluationSlice.name. + GoogleCloudAiplatformV1FeatureNoiseSigma: + description: >- + Noise sigma by features. Noise sigma represents the standard deviation + of the gaussian kernel that will be used to add noise to interpolated + inputs prior to computing gradients. type: object + id: GoogleCloudAiplatformV1FeatureNoiseSigma properties: - startTime: + noiseSigma: + type: array + description: >- + Noise sigma per feature. No noise is added to features that are not + set. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec: + properties: + maxReplicaCount: + format: int64 type: string - format: google-datetime description: >- - Excludes Feature values with feature generation timestamp before - this timestamp. If not set, retrieve oldest values kept in Feature - Store. Timestamp, if present, must not have higher than millisecond - precision. - endTime: + Optional. max replicas in the node pool, must be ≥ replica_count and + > min_replica_count or will throw error + minReplicaCount: type: string - format: google-datetime + format: int64 description: >- - Exports Feature values as of this timestamp. If not set, retrieve - values as of now. Timestamp, if present, must not have higher than - millisecond precision. - description: >- - Describes exporting all historical Feature values of all entities of the - EntityType between [start_time, end_time]. - id: GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport - GoogleCloudAiplatformV1Part: - id: GoogleCloudAiplatformV1Part + Optional. min replicas in the node pool, must be ≤ replica_count and + < max_replica_count or will throw error. For autoscaling enabled + Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 + to match the OSS Ray + behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). + As for Persistent Resource, the min_replica_count must be > 0, we + added a corresponding validation inside + CreatePersistentResourceRequestValidator.java. + description: The min/max number of replicas allowed if enabling autoscaling + id: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics: + type: object + description: Metrics for classification evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics properties: - videoMetadata: - description: >- - Optional. Video metadata. The metadata should only be specified - while the video data is presented in inline_data or file_data. - $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' - functionCall: + auPrc: description: >- - Optional. A predicted [FunctionCall] returned from the model that - contains a string representing the [FunctionDeclaration.name] with - the parameters and their values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCall' - inlineData: - description: Optional. Inlined bytes data. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' - text: - description: Optional. Text part (can be code). - type: string - functionResponse: + The Area Under Precision-Recall Curve metric. Micro-averaged for the + overall evaluation. + type: number + format: float + confidenceMetrics: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics description: >- - Optional. The result output of a [FunctionCall] that contains a - string representing the [FunctionDeclaration.name] and a structured - JSON object containing any output from the function call. It is used - as context to the model. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' - fileData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' - description: Optional. URI based data. - description: >- - A datatype containing media that is part of a multi-part `Content` - message. A `Part` consists of data which has an associated datatype. A - `Part` can only contain one of the accepted types in `Part.data`. A - `Part` must have a fixed IANA MIME type identifying the type and subtype - of the media if `inline_data` or `file_data` field is filled with raw - bytes. - GoogleCloudAiplatformV1NasTrialDetail: + Metrics for each `confidenceThreshold` in + 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and `positionThreshold` + = INT32_MAX_VALUE. ROC and precision-recall curves, and other + aggregated metrics are derived from them. The confidence metrics + entries may also be supplied for additional values of + `positionThreshold`, but from these no aggregated metrics are + computed. + type: array + confusionMatrix: + description: Confusion matrix of the evaluation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + logLoss: + format: float + description: The Log Loss metric. + type: number + auRoc: + format: float + description: >- + The Area Under Receiver Operating Characteristic curve metric. + Micro-averaged for the overall evaluation. + type: number + GoogleCloudAiplatformV1SuggestTrialsMetadata: properties: - searchTrial: - description: The requested search NasTrial. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - parameters: + clientId: type: string - description: The parameters for the NasJob NasTrial. - trainTrial: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' description: >- - The train NasTrial corresponding to search_trial. Only populated if - search_trial is used for training. - name: - type: string - description: Output only. Resource name of the NasTrialDetail. - readOnly: true + The identifier of the client that is requesting the suggestion. If + multiple SuggestTrialsRequests have the same `client_id`, the + service will return the identical suggested Trial if the Trial is + pending, and provide a new Trial if the last suggested Trial was + completed. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for suggesting Trials. + description: Details of operations that perform Trials suggestion. + id: GoogleCloudAiplatformV1SuggestTrialsMetadata type: object + GoogleCloudAiplatformV1NotebookIdleShutdownConfig: description: >- - Represents a NasTrial details along with its parameters. If there is a - corresponding train NasTrial, the train NasTrial is also returned. - id: GoogleCloudAiplatformV1NasTrialDetail - GoogleCloudAiplatformV1ExamplesOverride: + The idle shutdown configuration of NotebookRuntimeTemplate, which + contains the idle_timeout as required field. + id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig properties: - neighborCount: - type: integer - description: The number of neighbors to return. - format: int32 - restrictions: - type: array + idleTimeout: description: >- - Restrict the resulting nearest neighbors to respect these - constraints. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExamplesRestrictionsNamespace - crowdingCount: - type: integer - format: int32 - description: The number of neighbors to return that have the same crowding tag. - dataFormat: - enumDescriptions: - - Unspecified format. Must not be used. - - Provided data is a set of model inputs. - - Provided data is a set of embeddings. - enum: - - DATA_FORMAT_UNSPECIFIED - - INSTANCES - - EMBEDDINGS + Required. Duration is accurate to the second. In Notebook, Idle + Timeout is accurate to minute so the range of idle_timeout (second) + is: 10 * 60 ~ 1440 * 60. + format: google-duration type: string - description: The format of the data being provided with each call. - returnEmbeddings: + idleShutdownDisabled: type: boolean - description: If true, return the embeddings instead of neighbors. + description: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. type: object - id: GoogleCloudAiplatformV1ExamplesOverride - description: Overrides for example-based explanations. - GoogleCloudAiplatformV1IntegratedGradientsAttribution: - id: GoogleCloudAiplatformV1IntegratedGradientsAttribution - description: >- - An attribution method that computes the Aumann-Shapley value taking - advantage of the model's fully differentiable structure. Refer to this - paper for more details: https://arxiv.org/abs/1703.01365 + GoogleCloudAiplatformV1ListPersistentResourcesResponse: + description: Response message for PersistentResourceService.ListPersistentResources + id: GoogleCloudAiplatformV1ListPersistentResourcesResponse properties: - blurBaselineConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' - description: >- - Config for IG with blur baseline. When enabled, a linear path from - the maximally blurred image to the input image is created. Using a - blurred baseline instead of zero (black image) is motivated by the - BlurIG approach explained here: https://arxiv.org/abs/2004.03383 - smoothGradConfig: - description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy - samples in the vicinity of the inputs. Adding noise can help improve - the computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf - $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' - stepCount: + nextPageToken: + type: string description: >- - Required. The number of steps for approximating the path integral. A - good value to start is 50 and gradually increase until the sum to - diff property is within the desired error range. Valid range of its - value is [1, 100], inclusively. - type: integer - format: int32 - type: object - GoogleCloudAiplatformV1IdMatcher: - properties: - ids: + A token to retrieve next page of results. Pass to + ListPersistentResourcesRequest.page_token to obtain that page. + persistentResources: items: - type: string - description: >- - Required. The following are accepted as `ids`: * A single-element - list containing only `*`, which selects all Features in the target - EntityType, or * A list containing only Feature IDs, which selects - only Features with those IDs in the target EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' type: array type: object - id: GoogleCloudAiplatformV1IdMatcher - description: Matcher for Features of an EntityType by Feature ID. - GoogleCloudAiplatformV1MetadataSchema: + GoogleCloudAiplatformV1ModelDataStats: + description: Stats of data used for train or evaluate the Model. properties: - schemaType: + testAnnotationsCount: + format: int64 type: string - enumDescriptions: - - Unspecified type for the MetadataSchema. - - >- - A type indicating that the MetadataSchema will be used by - Artifacts. - - >- - A typee indicating that the MetadataSchema will be used by - Executions. - - >- - A state indicating that the MetadataSchema will be used by - Contexts. - enum: - - METADATA_SCHEMA_TYPE_UNSPECIFIED - - ARTIFACT_TYPE - - EXECUTION_TYPE - - CONTEXT_TYPE description: >- - The type of the MetadataSchema. This is a property that identifies - which metadata types will use the MetadataSchema. - schema: + Number of Annotations that are used for evaluating this Model. If + the Model is evaluated multiple times, this will be the number of + test Annotations used by the first evaluation. If the Model is not + evaluated, the number is 0. + validationAnnotationsCount: + type: string description: >- - Required. The raw YAML string representation of the MetadataSchema. - The combination of [MetadataSchema.version] and the schema name - given by `title` in [MetadataSchema.schema] must be unique within a - MetadataStore. The schema is defined as an OpenAPI 3.0.2 - [MetadataSchema - Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) + Number of Annotations that are used for validating this Model during + training. + format: int64 + trainingAnnotationsCount: + description: Number of Annotations that are used for training this Model. type: string - description: - description: Description of the Metadata Schema + format: int64 + validationDataItemsCount: + format: int64 + description: >- + Number of DataItems that were used for validating this Model during + training. type: string - schemaVersion: + trainingDataItemsCount: + type: string + description: Number of DataItems that were used for training this Model. + format: int64 + testDataItemsCount: + type: string + format: int64 description: >- - The version of the MetadataSchema. The version's format must match - the following regular expression: `^[0-9]+.+.+$`, which would allow - to order/compare different versions. Example: 1.0.0, 1.0.1, etc. + Number of DataItems that were used for evaluating this Model. If the + Model is evaluated multiple times, this will be the number of test + DataItems used by the first evaluation. If the Model is not + evaluated, the number is 0. + type: object + id: GoogleCloudAiplatformV1ModelDataStats + GoogleCloudAiplatformV1IndexEndpoint: + description: >- + Indexes are deployed into it. An IndexEndpoint can have multiple + DeployedIndexes. + properties: + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + encryptionSpec: + description: >- + Immutable. Customer-managed encryption key spec for an + IndexEndpoint. If set, this IndexEndpoint and all sub-resources of + this IndexEndpoint will be secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + updateTime: type: string - name: - description: Output only. The resource name of the MetadataSchema. + format: google-datetime + readOnly: true + description: >- + Output only. Timestamp when this IndexEndpoint was last updated. + This timestamp is not updated when the endpoint's DeployedIndexes + are updated, e.g. due to updates of the original Indexes they are + the deployments of. + privateServiceConnectConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + description: >- + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + displayName: + description: >- + Required. The display name of the IndexEndpoint. The name can be up + to 128 characters long and can consist of any UTF-8 characters. type: string + name: + description: Output only. The resource name of the IndexEndpoint. readOnly: true + type: string createTime: + type: string format: google-datetime - description: Output only. Timestamp when this MetadataSchema was created. + description: Output only. Timestamp when this IndexEndpoint was created. + readOnly: true + description: + type: string + description: The description of the IndexEndpoint. + etag: + type: string + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + labels: + additionalProperties: + type: string + description: >- + The labels with user-defined metadata to organize your + IndexEndpoints. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. + type: object + publicEndpointDomainName: type: string readOnly: true - id: GoogleCloudAiplatformV1MetadataSchema - type: object - description: Instance of a general MetadataSchema. - GoogleCloudAiplatformV1SummarizationVerbosityResult: - properties: - confidence: + description: >- + Output only. If public_endpoint_enabled is true, this field will be + populated with the domain name to use for this index endpoint. + deployedIndexes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: Output only. The indexes deployed in this endpoint. readOnly: true - type: number - format: float - description: Output only. Confidence for summarization verbosity score. - explanation: - description: Output only. Explanation for summarization verbosity score. + satisfiesPzi: + type: boolean readOnly: true + description: Output only. Reserved for future use. + enablePrivateServiceConnect: + description: >- + Optional. Deprecated: If true, expose the IndexEndpoint via private + service connect. Only one of the fields, network or + enable_private_service_connect, can be set. + deprecated: true + type: boolean + publicEndpointEnabled: + type: boolean + description: >- + Optional. If true, the deployed index will be accessible through + public endpoint. + network: type: string - score: - format: float - readOnly: true - description: Output only. Summarization Verbosity score. - type: number - description: Spec for summarization verbosity result. - id: GoogleCloudAiplatformV1SummarizationVerbosityResult - type: object - GoogleCloudAiplatformV1BleuResults: - id: GoogleCloudAiplatformV1BleuResults - description: Results for bleu metric. + description: >- + Optional. The full name of the Google Compute Engine + [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + to which the IndexEndpoint should be peered. Private services access + must already be configured for the network. If left unspecified, the + Endpoint is not peered with any network. network and + private_service_connect_config are mutually exclusive. + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where {project} is a + project number, as in '12345', and {network} is network name. + id: GoogleCloudAiplatformV1IndexEndpoint type: object + GoogleCloudAiplatformV1ListTensorboardsResponse: + description: Response message for TensorboardService.ListTensorboards. + id: GoogleCloudAiplatformV1ListTensorboardsResponse properties: - bleuMetricValues: - type: array + tensorboards: + description: The Tensorboards mathching the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuMetricValue' - readOnly: true - description: Output only. Bleu metric values. - CloudAiLargeModelsVisionImage: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + type: array + nextPageToken: + type: string + description: >- + A token, which can be sent as ListTensorboardsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. type: object - description: Image. + GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource: + description: The Dataform Repository containing the input notebook. properties: - image: - format: byte - description: Raw bytes. - type: string - encoding: + commitSha: type: string - description: Image encoding, encoded as "image/png" or "image/jpg". - generationSeed: - format: int32 description: >- - Generation seed for the sampled image. This parameter is exposed to - the user only if one of the following is true: 1. The user specified - per-example seeds in the request. 2. The user doesn't specify the - generation seed in the request. - type: integer - imageRaiScores: - $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' - description: RAI scores for generated image. - uri: - type: string - description: Path to another storage (typically Google Cloud Storage). - raiInfo: - description: RAI info for image. - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' - semanticFilterResponse: - $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' - description: Semantic filter info for image. - text: + The commit SHA to read repository with. If unset, the file will be + read at HEAD. + dataformRepositoryResourceName: + description: >- + The resource name of the Dataform Repository. Format: + `projects/{project_id}/locations/{location}/repositories/{repository_id}` type: string - description: Text/Expanded text input for imagen. - id: CloudAiLargeModelsVisionImage - GoogleCloudAiplatformV1DeleteFeatureValuesResponse: - description: Response message for FeaturestoreService.DeleteFeatureValues. - type: object - id: GoogleCloudAiplatformV1DeleteFeatureValuesResponse - properties: - selectTimeRangeAndFeature: - description: Response for request specifying time range and feature - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature - selectEntity: - description: Response for request specifying the entities to delete - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig: - description: >- - The tables Dataset's data source. The Dataset doesn't store the data - directly, but only pointer(s) to its data. - properties: - bigquerySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig type: object - GoogleCloudAiplatformV1SchemaTextDatasetMetadata: - description: The metadata of Datasets that contain Text DataItems. - id: GoogleCloudAiplatformV1SchemaTextDatasetMetadata + id: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource + GoogleCloudAiplatformV1PscAutomatedEndpoints: + id: GoogleCloudAiplatformV1PscAutomatedEndpoints properties: - dataItemSchemaUri: + projectId: type: string - description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Text DataItems that belong to this Dataset. - gcsBucket: + description: Corresponding project_id in pscAutomationConfigs + matchAddress: type: string - description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. + description: Ip Address created by the automated forwarding rule. + network: + type: string + description: Corresponding network in pscAutomationConfigs. type: object - GoogleCloudAiplatformV1ReadIndexDatapointsResponse: + description: >- + PscAutomatedEndpoints defines the output of the forwarding rule + automatically created by each PscAutomationConfig. + GoogleCloudAiplatformV1SafetyInstance: + description: Spec for safety instance. properties: - datapoints: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - description: The result list of datapoints. + prediction: + description: Required. Output of the evaluated model. + type: string + id: GoogleCloudAiplatformV1SafetyInstance type: object - description: The response message for MatchService.ReadIndexDatapoints. - id: GoogleCloudAiplatformV1ReadIndexDatapointsResponse - GoogleCloudAiplatformV1PredictSchemata: + GoogleCloudAiplatformV1TensorboardTimeSeries: type: object - id: GoogleCloudAiplatformV1PredictSchemata - description: >- - Contains the schemata used in Model's predictions and explanations via - PredictionService.Predict, PredictionService.Explain and - BatchPredictionJob. properties: - predictionSchemaUri: - description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the format of a single prediction produced by this Model, - which are returned via PredictResponse.predictions, - ExplainResponse.explanations, and BatchPredictionJob.output_config. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. + pluginData: type: string - instanceSchemaUri: + format: byte + description: Data of the current plugin, with the size limited to 65KB. + etag: type: string description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the format of a single instance, which are used in - PredictRequest.instances, ExplainRequest.instances and - BatchPredictionJob.input_config. The schema is defined as an OpenAPI - 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - parametersSchemaUri: + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + pluginName: type: string description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the parameters of prediction and explanation via - PredictRequest.parameters, ExplainRequest.parameters and - BatchPredictionJob.model_parameters. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI, if no - parameters are supported, then it is set to an empty string. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - GoogleCloudAiplatformV1ListArtifactsResponse: - id: GoogleCloudAiplatformV1ListArtifactsResponse - description: Response message for MetadataService.ListArtifacts. - properties: - nextPageToken: - description: >- - A token, which can be sent as ListArtifactsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. + Immutable. Name of the plugin this time series pertain to. Such as + Scalar, Tensor, Blob + createTime: + format: google-datetime + description: Output only. Timestamp when this TensorboardTimeSeries was created. type: string - artifacts: - type: array - description: The Artifacts retrieved from the MetadataStore. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - type: object - GoogleTypeInterval: - type: object - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - id: GoogleTypeInterval - properties: - startTime: + readOnly: true + description: type: string - format: google-datetime - description: >- - Optional. Inclusive start of the interval. If specified, a Timestamp - matching this interval will have to be the same or after the start. - endTime: + description: Description of this TensorboardTimeSeries. + updateTime: + readOnly: true type: string - format: google-datetime description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. - GoogleCloudAiplatformV1ExportFilterSplit: - id: GoogleCloudAiplatformV1ExportFilterSplit - type: object - description: >- - Assigns input data to training, validation, and test sets based on the - given filters, data pieces not matched by any filter are ignored. - Currently only supported for Datasets containing DataItems. If any of - the filters in this message are to match nothing, then they can be set - as '-' (the minus sign). Supported only for unstructured Datasets. - properties: - validationFilter: + Output only. Timestamp when this TensorboardTimeSeries was last + updated. + format: google-datetime + name: + description: Output only. Name of the TensorboardTimeSeries. type: string + readOnly: true + metadata: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to validate the Model. A filter with same - syntax as the one used in DatasetService.ListDataItems may be used. - If a single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - trainingFilter: + Output only. Scalar, Tensor, or Blob metadata for this + TensorboardTimeSeries. + displayName: description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to train the Model. A filter with same syntax - as the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. + Required. User provided name of this TensorboardTimeSeries. This + value should be unique among all TensorboardTimeSeries resources + belonging to the same TensorboardRun resource (parent resource). type: string - testFilter: - description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to test the Model. A filter with same syntax as - the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. + valueType: type: string - GoogleCloudAiplatformV1PersistentResource: - type: object + enumDescriptions: + - The value type is unspecified. + - >- + Used for TensorboardTimeSeries that is a list of scalars. E.g. + accuracy of a model over epochs/time. + - >- + Used for TensorboardTimeSeries that is a list of tensors. E.g. + histograms of weights of layer in a model over epoch/time. + - >- + Used for TensorboardTimeSeries that is a list of blob sequences. + E.g. set of sample images with labels over epochs/time. + enum: + - VALUE_TYPE_UNSPECIFIED + - SCALAR + - TENSOR + - BLOB_SEQUENCE + description: Required. Immutable. Type of TensorboardTimeSeries value. + description: TensorboardTimeSeries maps to times series produced in training runs + id: GoogleCloudAiplatformV1TensorboardTimeSeries + GoogleCloudAiplatformV1Attribution: + id: GoogleCloudAiplatformV1Attribution + description: Attribution that explains a particular prediction output. properties: - updateTime: - format: google-datetime + outputName: type: string - readOnly: true description: >- - Output only. Time when the PersistentResource was most recently - updated. - resourcePools: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcePool' + Output only. Name of the explain output. Specified as the key in + ExplanationMetadata.outputs. + readOnly: true + outputIndex: type: array - description: Required. The spec of the pools of different resources. - error: - $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. Only populated when persistent resource's state is - `STOPPING` or `ERROR`. - readOnly: true - satisfiesPzs: + Output only. The index that locates the explained prediction output. + If the prediction output is a scalar value, output_index is not + populated. If the prediction output has multiple dimensions, the + length of the output_index list is the same as the number of + dimensions of the output. The i-th element in output_index is the + element index of the i-th dimension of the output vector. Indices + start from 0. + items: + type: integer + format: int32 readOnly: true - description: Output only. Reserved for future use. - type: boolean - displayName: + instanceOutputValue: + format: double description: >- - Optional. The display name of the PersistentResource. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. - type: string - network: - type: string + Output only. Model predicted output on the corresponding explanation + instance. The field name of the output is determined by the key in + ExplanationMetadata.outputs. If the Model predicted output has + multiple dimensions, this is the value in the output located by + output_index. + type: number + readOnly: true + approximationError: + format: double description: >- - Optional. The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to peered - with Vertex AI to host the persistent resources. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - To specify this field, you must have already [configured VPC Network - Peering for Vertex - AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If - this field is left unspecified, the resources aren't peered with any - network. - resourceRuntimeSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntimeSpec' + Output only. Error of feature_attributions caused by approximation + used in the explanation method. Lower value means more precise + attributions. * For Sampled Shapley attribution, increasing + path_count might reduce the error. * For Integrated Gradients + attribution, increasing step_count might reduce the error. * For + XRAI attribution, increasing step_count might reduce the error. See + [this introduction](/vertex-ai/docs/explainable-ai/overview) for + more information. + readOnly: true + type: number + baselineOutputValue: description: >- - Optional. Persistent Resource runtime spec. For example, used for - Ray cluster configuration. - createTime: - description: Output only. Time when the PersistentResource was created. - format: google-datetime - type: string + Output only. Model predicted output if the input instance is + constructed from the baselines of all the features defined in + ExplanationMetadata.inputs. The field name of the output is + determined by the key in ExplanationMetadata.outputs. If the Model's + predicted output has multiple dimensions (rank > 1), this is the + value in the output located by output_index. If there are multiple + baselines, their output values are averaged. readOnly: true - resourceRuntime: - description: Output only. Runtime information of the Persistent Resource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntime' + format: double + type: number + featureAttributions: + type: any readOnly: true - state: + description: >- + Output only. Attributions of each explained feature. Features are + extracted from the prediction instances according to explanation + metadata for inputs. The value is a struct, whose keys are the name + of the feature. The values are how much the feature in the instance + contributed to the predicted result. The format of the value is + determined by the feature's input format: * If the feature is a + scalar value, the attribution value is a floating number. * If the + feature is an array of scalar values, the attribution value is an + array. * If the feature is a struct, the attribution value is a + struct. The keys in the attribution value struct are the same as the + keys in the feature struct. The formats of the values in the + attribution struct are determined by the formats of the values in + the feature struct. The + ExplanationMetadata.feature_attributions_schema_uri field, pointed + to by the ExplanationSpec field of the Endpoint.deployed_models + object, points to the schema file that describes the features and + their attribution values (if it is populated). + outputDisplayName: + description: >- + Output only. The display name of the output identified by + output_index. For example, the predicted class name by a + multi-classification Model. This field is only populated iff the + Model predicts display names as a separate field along with the + explained output. The predicted display name must has the same shape + of the explained output, and can be located using output_index. readOnly: true - description: Output only. The detailed state of a Study. type: string - enumDescriptions: - - Not set. - - >- - The PROVISIONING state indicates the persistent resources is being - created. - - >- - The RUNNING state indicates the persistent resource is healthy and - fully usable. - - >- - The STOPPING state indicates the persistent resource is being - deleted. - - >- - The ERROR state indicates the persistent resource may be unusable. - Details can be found in the `error` field. - - >- - The REBOOTING state indicates the persistent resource is being - rebooted (PR is not available right now but is expected to be - ready again later). - - >- - The UPDATING state indicates the persistent resource is being - updated. - enum: - - STATE_UNSPECIFIED - - PROVISIONING - - RUNNING - - STOPPING - - ERROR - - REBOOTING - - UPDATING - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean + type: object + GoogleCloudAiplatformV1FeaturestoreMonitoringConfig: + type: object + properties: + snapshotAnalysis: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis + description: The config for Snapshot Analysis Based Feature Monitoring. + numericalThresholdConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + description: >- + Threshold for numerical features of anomaly detection. This is + shared by all objectives of Featurestore Monitoring for numerical + features (i.e. Features with type (Feature.ValueType) DOUBLE or + INT64). + categoricalThresholdConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + description: >- + Threshold for categorical features of anomaly detection. This is + shared by all types of Featurestore Monitoring for categorical + features (i.e. Features with type (Feature.ValueType) BOOL or + STRING). + importFeaturesAnalysis: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis + description: The config for ImportFeatures Analysis Based Feature Monitoring. + description: Configuration of how features in Featurestore are monitored. + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfig + GoogleCloudAiplatformV1ExportDataRequest: + description: Request message for DatasetService.ExportData. + type: object + id: GoogleCloudAiplatformV1ExportDataRequest + properties: + exportConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataConfig' + description: Required. The desired output location. + GoogleCloudAiplatformV1BatchReadFeatureValuesRequest: + type: object + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + properties: startTime: - type: string description: >- - Output only. Time when the PersistentResource for the first time - entered the `RUNNING` state. + Optional. Excludes Feature values with feature generation timestamp + before this timestamp. If not set, retrieve oldest values kept in + Feature Store. Timestamp, if present, must not have higher than + millisecond precision. + type: string format: google-datetime - readOnly: true - labels: + bigqueryReadInstances: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + description: Similar to csv_read_instances, but from BigQuery source. + csvReadInstances: description: >- - Optional. The labels with user-defined metadata to organize - PersistentResource. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. - additionalProperties: - type: string - type: object - reservedIpRanges: + Each read instance consists of exactly one read timestamp and one or + more entity IDs identifying entities of the corresponding + EntityTypes whose Features are requested. Each output instance + contains Feature values of requested entities concatenated together + as of the read time. An example read instance may be `foo_entity_id, + bar_entity_id, 2020-01-01T10:00:00.123Z`. An example output instance + may be `foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, + foo_entity_feature1_value, bar_entity_feature2_value`. Timestamp in + each read instance must be millisecond-aligned. `csv_read_instances` + are read instances stored in a plain-text CSV file. The header + should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The + columns can be in any order. Values in the timestamp column must use + the RFC 3339 format, e.g. `2012-07-30T10:43:17.123Z`. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + entityTypeSpecs: description: >- - Optional. A list of names for the reserved IP ranges under the VPC - network that can be used for this persistent resource. If set, we - will deploy the persistent resource within the provided IP ranges. - Otherwise, the persistent resource is deployed to any IP ranges - under the provided VPC network. Example: ['vertex-ai-ip-range']. + Required. Specifies EntityType grouping Features to read values of + and settings. type: array items: - type: string - name: - type: string - description: Immutable. Resource name of a PersistentResource. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec + destination: + description: Required. Specifies output location and format. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' + passThroughFields: description: >- - Optional. Customer-managed encryption key spec for a - PersistentResource. If set, this PersistentResource and all - sub-resources of this PersistentResource will be secured by this - key. - description: >- - Represents long-lasting resources that are dedicated to users to runs - custom workloads. A PersistentResource can have multiple node pools and - each node pool can have its own machine spec. - id: GoogleCloudAiplatformV1PersistentResource - GoogleCloudAiplatformV1CancelDataLabelingJobRequest: - properties: {} - type: object - description: Request message for JobService.CancelDataLabelingJob. - id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest - GoogleCloudAiplatformV1BatchCreateFeaturesRequest: - properties: - requests: + When not empty, the specified fields in the *_read_instances source + will be joined as-is in the output, in addition to those fields from + the Featurestore Entity. For BigQuery source, the type of the + pass-through values will be automatically inferred. For CSV source, + the pass-through values will be passed as opaque bytes. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CreateFeatureRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + type: array + description: Request message for FeaturestoreService.BatchReadFeatureValues. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics: + properties: + boundingBoxMetrics: type: array description: >- - Required. The request message specifying the Features to create. All - Features must be created under the same parent EntityType. The - `parent` field in each child request message can be omitted. If - `parent` is set in a child request, then the value must match the - `parent` value in this request message. - id: GoogleCloudAiplatformV1BatchCreateFeaturesRequest - description: Request message for FeaturestoreService.BatchCreateFeatures. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation: + The bounding boxes match metrics for each intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics + evaluatedBoundingBoxCount: + format: int32 + type: integer + description: >- + The total number of bounding boxes (i.e. summed over all images) the + ground truth used to create this evaluation had. + boundingBoxMeanAveragePrecision: + description: >- + The single metric for bounding boxes evaluation: the + `meanAveragePrecision` averaged over all + `boundingBoxMetricsEntries`. + type: number + format: float id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics type: object - description: >- - Treats the column as categorical array and performs following - transformation functions. * For each element in the array, convert the - category name to a dictionary lookup index and generate an embedding for - each index. Combine the embedding of all elements into a single - embedding using the mean. * Empty arrays treated as an embedding of - zeroes. - properties: - columnName: - type: string - GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse: + description: Metrics for image object detection evaluation results. + GoogleCloudAiplatformV1StructValue: type: object - id: GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse properties: - nextPageToken: - description: >- - A token, which can be sent as - ListFeatureOnlineStoresRequest.page_token to retrieve the next page. - If this field is omitted, there are no subsequent pages. - type: string - featureOnlineStores: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + values: type: array - description: The FeatureOnlineStores matching the request. - description: >- - Response message for - FeatureOnlineStoreAdminService.ListFeatureOnlineStores. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables: - description: A TrainingJob that trains and uploads an AutoML Tables Model. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StructFieldValue' + description: A list of field values. + id: GoogleCloudAiplatformV1StructValue + description: Struct (or object) type feature value. + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs - description: The input parameters of this TrainingJob. - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata - GoogleCloudAiplatformV1BatchPredictionJobOutputConfig: + id: >- + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult description: >- - Configures the output of BatchPredictionJob. See - Model.supported_output_storage_formats for supported output formats, and - how predictions are expressed via any of them. - id: GoogleCloudAiplatformV1BatchPredictionJobOutputConfig - type: object + Represents a partial result in batch migration operation for one + MigrateResourceRequest. properties: - bigqueryDestination: + request: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' description: >- - The BigQuery project or dataset location where the output is to be - written to. If project is provided, a new dataset is created with - name `prediction__` where is made BigQuery-dataset-name compatible - (for example, most special characters become underscores), and - timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. - In the dataset two tables will be created, `predictions`, and - `errors`. If the Model has both instance and prediction schemata - defined then the tables have columns as follows: The `predictions` - table contains instances for which the prediction succeeded, it has - columns as per a concatenation of the Model's instance and - prediction schemata. The `errors` table contains rows for which the - prediction has failed, it has instance columns, as per the instance - schema, followed by a single "errors" column, which as values has - google.rpc.Status represented as a STRUCT, and containing only - `code` and `message`. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - predictionsFormat: + It's the same as the value in + MigrateResourceRequest.migrate_resource_requests. + model: + description: Migrated model resource name. type: string - description: >- - Required. The format in which Vertex AI gives the predictions, must - be one of the Model's supported_output_storage_formats. - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: >- - The Cloud Storage location of the directory where the output is to - be written to. In the given directory a new directory is created. - Its name is `prediction--`, where timestamp is in - YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files - `predictions_0001.`, `predictions_0002.`, ..., `predictions_N.` are - created where `` depends on chosen predictions_format, and N may - equal 0001 and depends on the total number of successfully predicted - instances. If the Model has both instance and prediction schemata - defined then each such file contains predictions as per the - predictions_format. If prediction for any instance failed (partially - or completely), then an additional `errors_0001.`, - `errors_0002.`,..., `errors_N.` files are created (N depends on - total number of failed predictions). These files contain the failed - instances, as per their schema, followed by an additional `error` - field which as value has google.rpc.Status containing only `code` - and `message` fields. - GoogleCloudAiplatformV1Probe: + dataset: + description: Migrated dataset resource name. + type: string + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The error result of the migration request in case of failure. + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats: type: object - id: GoogleCloudAiplatformV1Probe - properties: - timeoutSeconds: - type: integer - description: >- - Number of seconds after which the probe times out. Defaults to 1 - second. Minimum value is 1. Must be greater or equal to - period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - format: int32 - periodSeconds: - type: integer - description: >- - How often (in seconds) to perform the probe. Default to 10 seconds. - Minimum value is 1. Must be less than timeout_seconds. Maps to - Kubernetes probe argument 'periodSeconds'. - format: int32 - exec: - description: ExecAction probes the health of a container by executing a command. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' - description: >- - Probe describes a health check to be performed against a container to - determine whether it is alive or ready to receive traffic. - GoogleCloudAiplatformV1DoubleArray: + id: >- + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats properties: - values: - items: - format: double - type: number + validRecordCount: + type: string + format: int64 + description: Number of records in this file that were successfully processed. + invalidRecordCount: + format: int64 + description: Number of records in this file we skipped due to validate errors. + type: string + partialErrors: type: array - description: A list of double values. - description: A list of double values. - id: GoogleCloudAiplatformV1DoubleArray - type: object - GoogleCloudAiplatformV1StudySpecStudyStoppingConfig: - type: object - properties: - minNumTrials: - type: integer - format: int32 - description: >- - If there are fewer than this many COMPLETED trials, do not stop the - study. - shouldStopAsap: - type: boolean - description: >- - If true, a Study enters STOPPING_ASAP whenever it would normally - enters STOPPING state. The bottom line is: set to true if you want - to interrupt on-going evaluations of Trials as soon as the study - stopping condition is met. (Please see Study.State documentation for - the source of truth). - maxNumTrialsNoProgress: - type: integer - description: >- - If the objective value has not improved for this many consecutive - trials, stop the study. WARNING: Effective only for single-objective - studies. - format: int32 - maximumRuntimeConstraint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' - description: If the specified time or duration has passed, stop the study. - maxDurationNoProgress: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError description: >- - If the objective value has not improved for this much time, stop the - study. WARNING: Effective only for single-objective studies. - format: google-duration + The detail information of the partial failures encountered for those + invalid records that couldn't be parsed. Up to 50 partial errors + will be reported. + sourceGcsUri: + description: Cloud Storage URI pointing to the original file in user's bucket. + type: string + invalidSparseRecordCount: + format: int64 type: string - maxNumTrials: - format: int32 - type: integer - description: If there are more than this many trials, stop the study. - minimumRuntimeConstraint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' description: >- - Each "stopping rule" in this proto specifies an "if" condition. - Before Vizier would generate a new suggestion, it first checks each - specified stopping rule, from top to bottom in this list. Note that - the first few rules (e.g. minimum_runtime_constraint, - min_num_trials) will prevent other stopping rules from being - evaluated until they are met. For example, setting - `min_num_trials=5` and `always_stop_after= 1 hour` means that the - Study will ONLY stop after it has 5 COMPLETED trials, even if more - than an hour has passed since its creation. It follows the first - applicable rule (whose "if" condition is satisfied) to make a - stopping decision. If none of the specified rules are applicable, - then Vizier decides that the study should not stop. If Vizier - decides that the study should stop, the study enters STOPPING state - (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The - automatic study state transition happens precisely as described - above; that is, deleting trials or updating StudyConfig NEVER - automatically moves the study state back to ACTIVE. If you want to - _resume_ a Study that was stopped, 1) change the stopping conditions - if necessary, 2) activate the study, and then 3) ask for - suggestions. If the specified time or duration has not passed, do - not stop the study. - description: >- - The configuration (stopping conditions) for automated stopping of a - Study. Conditions include trial budgets, time budgets, and convergence - detection. - id: GoogleCloudAiplatformV1StudySpecStudyStoppingConfig - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask: - description: A TrainingJob that tunes Hypererparameters of a custom code Model. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec - description: The input parameters of this HyperparameterTuningTask. - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata - description: The metadata information. - type: object - GoogleCloudAiplatformV1MeasurementMetric: - properties: - value: - format: double - readOnly: true - description: Output only. The value for this metric. - type: number - metricId: + Number of sparse records in this file we skipped due to validate + errors. + validSparseRecordCount: + format: int64 description: >- - Output only. The ID of the Metric. The Metric should be defined in - StudySpec's Metrics. - readOnly: true + Number of sparse records in this file that were successfully + processed. type: string - type: object - id: GoogleCloudAiplatformV1MeasurementMetric - description: A message representing a metric in the measurement. - GoogleCloudAiplatformV1FeatureValue: - id: GoogleCloudAiplatformV1FeatureValue + GoogleCloudAiplatformV1ExportFilterSplit: properties: - bytesValue: - format: byte + trainingFilter: type: string - description: Bytes feature value. - boolArrayValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BoolArray' - description: A list of bool type feature value. - stringArrayValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StringArray' - description: A list of string type feature value. - stringValue: + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to train the Model. A filter with same syntax + as the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + validationFilter: type: string - description: String feature value. - metadata: - description: Metadata of feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueMetadata' - structValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StructValue' - description: A struct type feature value. - doubleArrayValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DoubleArray' - description: A list of double type feature value. - int64ArrayValue: - description: A list of int64 type feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Int64Array' - doubleValue: - description: Double type feature value. - type: number - format: double - int64Value: - format: int64 + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to validate the Model. A filter with same + syntax as the one used in DatasetService.ListDataItems may be used. + If a single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + testFilter: + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to test the Model. A filter with same syntax as + the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. type: string - description: Int64 feature value. - boolValue: - type: boolean - description: Bool type feature value. type: object - description: Value for a feature. - GoogleCloudAiplatformV1ToolNameMatchInput: + description: >- + Assigns input data to training, validation, and test sets based on the + given filters, data pieces not matched by any filter are ignored. + Currently only supported for Datasets containing DataItems. If any of + the filters in this message are to match nothing, then they can be set + as '-' (the minus sign). Supported only for unstructured Datasets. + id: GoogleCloudAiplatformV1ExportFilterSplit + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput: + description: Input for question answering correctness metric. type: object + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput properties: - instances: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInstance' - type: array - description: Required. Repeated tool name match instances. metricSpec: - description: Required. Spec for tool name match metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchSpec' - id: GoogleCloudAiplatformV1ToolNameMatchInput - description: Input for tool name match metric. - GoogleCloudAiplatformV1UpdateFeatureOperationMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec + description: Required. Spec for question answering correctness score metric. + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance + description: Required. Question answering correctness instance. + GoogleCloudAiplatformV1ImportModelEvaluationRequest: type: object - id: GoogleCloudAiplatformV1UpdateFeatureOperationMetadata + id: GoogleCloudAiplatformV1ImportModelEvaluationRequest properties: - genericMetadata: - description: Operation metadata for Feature Update. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform update Feature. - GoogleCloudAiplatformV1DeployIndexOperationMetadata: - description: Runtime operation information for IndexEndpointService.DeployIndex. - id: GoogleCloudAiplatformV1DeployIndexOperationMetadata + modelEvaluation: + description: Required. Model evaluation resource to be imported. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + description: Request message for ModelService.ImportModelEvaluation + GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata: + id: GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata + description: Details of operations that perform update Featurestore. properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - deployedIndexId: - type: string - description: The unique index id specified by user + description: Operation metadata for Featurestore. type: object - GoogleCloudAiplatformV1LargeModelReference: + GoogleCloudAiplatformV1AddExecutionEventsResponse: + properties: {} + id: GoogleCloudAiplatformV1AddExecutionEventsResponse + description: Response message for MetadataService.AddExecutionEvents. + type: object + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation: + id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation + description: Annotation details specific to image segmentation. type: object - description: Contains information about the Large Model. - id: GoogleCloudAiplatformV1LargeModelReference properties: - name: + maskAnnotation: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation description: >- - Required. The unique name of the large Foundation or pre-built - model. Like "chat-bison", "text-bison". Or model name with version - ID, like "chat-bison@001", "text-bison@005", etc. - type: string - GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling: - type: object - description: >- - Online serving scaling configuration. If min_node_count and - max_node_count are set to the same value, the cluster will be configured - with the fixed number of node (no auto-scaling). - id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling + Mask based segmentation annotation. Only one mask annotation can + exist for one image. + polylineAnnotation: + description: Polyline annotation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + polygonAnnotation: + description: Polygon annotation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec: + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec properties: - cpuUtilizationTarget: - type: integer + trainTrialJobSpec: description: >- - Optional. The cpu utilization that the Autoscaler should be trying - to achieve. This number is on a scale from 0 (no utilization) to 100 - (total utilization), and is limited between 10 and 80. When a - cluster's CPU utilization exceeds the target that you have set, - Bigtable immediately adds nodes to the cluster. When CPU utilization - is substantially lower than the target, Bigtable removes nodes. If - not set or set to 0, default to 50. + Required. The spec of a train trial job. The same spec applies to + all train trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + maxParallelTrialCount: + description: Required. The maximum number of trials to run in parallel. format: int32 - maxNodeCount: type: integer + frequency: description: >- - The maximum number of nodes to scale up to. Must be greater than - min_node_count, and less than or equal to 10 times of - 'min_node_count'. - format: int32 - minNodeCount: - description: >- - Required. The minimum number of nodes to scale down to. Must be - greater than or equal to 1. + Required. Frequency of search trials to start train stage. Top N + [TrainTrialSpec.max_parallel_trial_count] search trials will be + trained for every M [TrainTrialSpec.frequency] trials searched. format: int32 type: integer - GoogleCloudAiplatformV1FulfillmentSpec: type: object - id: GoogleCloudAiplatformV1FulfillmentSpec - description: Spec for fulfillment metric. + description: Represent spec for train trials. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics: + description: Model evaluation metrics for video action recognition. + type: object properties: - version: - type: integer - description: Optional. Which version to use for evaluation. + videoActionMetrics: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + description: 'The metric entries for precision window lengths: 1s,2s,3s.' + evaluatedActionCount: format: int32 - GoogleCloudAiplatformV1SummarizationVerbosityInstance: + type: integer + description: The number of ground truth actions used to create this evaluation. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics + GoogleCloudAiplatformV1AnnotationSpec: + id: GoogleCloudAiplatformV1AnnotationSpec + description: Identifies a concept with which DataItems may be annotated with. properties: - context: - type: string - description: Required. Text to be summarized. - reference: - type: string - description: Optional. Ground truth used to compare against the prediction. - instruction: - description: Optional. Summarization prompt for LLM. - type: string - prediction: - description: Required. Output of the evaluated model. + etag: + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. type: string - id: GoogleCloudAiplatformV1SummarizationVerbosityInstance - description: Spec for summarization verbosity instance. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata: - type: object - properties: - backingCustomJob: + createTime: + description: Output only. Timestamp when this AnnotationSpec was created. + format: google-datetime type: string - description: >- - The resource name of the CustomJob that has been created to carry - out this custom task. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata - GoogleCloudAiplatformV1SpecialistPool: - properties: - pendingDataLabelingJobs: - items: - type: string - type: array readOnly: true - description: Output only. The resource name of the pending data labeling jobs. - specialistManagerEmails: - type: array - items: - type: string - description: The email addresses of the managers in the SpecialistPool. - specialistManagersCount: - description: Output only. The number of managers in this SpecialistPool. - type: integer - format: int32 + updateTime: + format: google-datetime + type: string + description: Output only. Timestamp when AnnotationSpec was last updated. readOnly: true - specialistWorkerEmails: - items: - type: string - description: The email addresses of workers in the SpecialistPool. - type: array displayName: type: string description: >- - Required. The user-defined name of the SpecialistPool. The name can + Required. The user-defined name of the AnnotationSpec. The name can be up to 128 characters long and can consist of any UTF-8 - characters. This field should be unique on project-level. + characters. name: - description: Required. The resource name of the SpecialistPool. + description: Output only. Resource name of the AnnotationSpec. + readOnly: true type: string - id: GoogleCloudAiplatformV1SpecialistPool - type: object - description: >- - SpecialistPool represents customers' own workforce to work on their data - labeling jobs. It includes a group of specialist managers and workers. - Managers are responsible for managing the workers in this pool as well - as customers' data labeling jobs associated with this pool. Customers - create specialist pool as well as start data labeling jobs on Cloud, - managers and workers handle the jobs using CrowdCompute console. - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec: - type: object - properties: - parentIntValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition - description: >- - The spec for matching values from a parent parameter of `INTEGER` - type. - parameterSpec: - description: Required. The spec for a conditional parameter. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' - parentDiscreteValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition - description: >- - The spec for matching values from a parent parameter of `DISCRETE` - type. - parentCategoricalValues: - description: >- - The spec for matching values from a parent parameter of - `CATEGORICAL` type. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition - description: Represents a parameter spec with condition from its parent parameter. - id: GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec - GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata: - id: GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata type: object + GoogleCloudAiplatformV1ImportDataOperationMetadata: + id: GoogleCloudAiplatformV1ImportDataOperationMetadata + description: Runtime operation information for DatasetService.ImportData. properties: genericMetadata: + description: The common part of the operation metadata. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureGroup. - description: Details of operations that perform update FeatureGroup. - GoogleLongrunningOperation: type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. + GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest: properties: - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - name: + deploymentResourcePool: + description: Required. The DeploymentResourcePool to create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' + deploymentResourcePoolId: type: string description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - metadata: - type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: + Required. The ID to use for the DeploymentResourcePool, which will + become the final component of the DeploymentResourcePool's resource + name. The maximum length is 63 characters, and valid characters are + `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. + description: Request message for CreateDeploymentResourcePool method. + type: object + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest + GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: + type: object + id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + progressMessage: description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - id: GoogleLongrunningOperation - GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource: + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + type: string + description: Metadata information for NotebookService.StartNotebookRuntime. + GoogleCloudAiplatformV1ListDataLabelingJobsResponse: properties: - featureGroups: + nextPageToken: + type: string + description: The standard List next-page token. + dataLabelingJobs: + description: >- + A list of DataLabelingJobs that matches the specified filter in the + request. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup - description: Required. List of features that need to be synced to Online Store. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' type: array - projectNumber: - description: >- - Optional. The project number of the parent project of the Feature - Groups. - type: string - format: int64 - description: >- - A Feature Registry source for features that need to be synced to Online - Store. - id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource + description: Response message for JobService.ListDataLabelingJobs. type: object - GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec: - description: Value specification for a parameter in `DISCRETE` type. - id: GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec + id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse + GoogleCloudAiplatformV1DoubleArray: + id: GoogleCloudAiplatformV1DoubleArray type: object properties: - defaultValue: - description: >- - A default value for a `DISCRETE` parameter that is assumed to be a - relatively good starting point. Unset value signals that there is no - offered starting point. It automatically rounds to the nearest - feasible discrete point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - format: double - type: number values: - type: array items: - format: double type: number - description: >- - Required. A list of possible values. The list should be in - increasing order and at least 1e-10 apart. For instance, this - parameter might have possible settings of 1.5, 2.5, and 4.0. This - list should not contain more than 1,000 values. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs: + format: double + description: A list of double values. + type: array + description: A list of double values. + GoogleCloudAiplatformV1ExportFeatureValuesRequest: + type: object + description: Request message for FeaturestoreService.ExportFeatureValues. properties: - optimizationObjective: + settings: + description: Per-Feature export settings. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting + type: array + destination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' + description: Required. Specifies destination location and format. + featureSelector: + description: Required. Selects Features to export values of. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + snapshotExport: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. - type: string - targetColumn: + Exports the latest Feature values of all entities of the EntityType + within a time range. + fullExport: description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. - type: string - exportEvaluatedDataItemsConfig: + Exports all historical values of all entities of the EntityType + within a time range $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport + id: GoogleCloudAiplatformV1ExportFeatureValuesRequest + GoogleCloudAiplatformV1FetchFeatureValuesResponse: + properties: + protoStruct: + additionalProperties: + type: any + description: Properties of the object. + type: object + description: Feature values in proto Struct format. + keyValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList + description: Feature values in KeyValue format. + dataKey: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - transformations: + The data key associated with this response. Will only be populated + for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. + type: object + id: GoogleCloudAiplatformV1FetchFeatureValuesResponse + description: Response message for FeatureOnlineStoreService.FetchFeatureValues + GoogleCloudAiplatformV1ToolParameterKeyMatchInput: + properties: + metricSpec: + description: Required. Spec for tool parameter key match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchSpec + instances: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation - description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - type: array - availableAtForecastColumns: - items: - type: string - description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInstance type: array - additionalExperiments: + description: Required. Repeated tool parameter key match instances. + description: Input for tool parameter key match metric. + id: GoogleCloudAiplatformV1ToolParameterKeyMatchInput + type: object + GoogleCloudAiplatformV1IndexDatapointRestriction: + properties: + namespace: + description: 'The namespace of this restriction. e.g.: color.' + type: string + allowList: items: type: string + description: 'The attributes to allow in this namespace. e.g.: ''red''' type: array - description: Additional experiment flags for the time series forcasting training. - holidayRegions: - description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. + denyList: items: type: string type: array - windowConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - description: Config containing strategy for generating sliding windows. - dataGranularity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity - description: Expected difference in time granularity between rows in the data. - validationOptions: - type: string - description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue - forecastHorizon: - format: int64 - type: string - description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - timeSeriesAttributeColumns: + description: 'The attributes to deny in this namespace. e.g.: ''blue''' + type: object + id: GoogleCloudAiplatformV1IndexDatapointRestriction + description: >- + Restriction of a datapoint which describe its attributes(tokens) from + each of several attribute categories(namespaces). + GoogleCloudAiplatformV1NotebookEucConfig: + id: GoogleCloudAiplatformV1NotebookEucConfig + type: object + properties: + bypassActasCheck: + readOnly: true + type: boolean description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - items: - type: string - type: array - quantiles: - type: array - items: - type: number - format: double + Output only. Whether ActAs check is bypassed for service account + attached to the VM. If false, we need ActAs check for the default + Compute Engine Service account. When a Runtime is created, a VM is + allocated using Default Compute Engine Service Account. Any user + requesting to use this Runtime requires Service Account User (ActAs) + permission over this SA. If true, Runtime owner is using EUC and + does not require the above permission as VM no longer use default + Compute Engine SA, but a P4SA. + eucDisabled: description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`. Up to 5 quantiles are allowed of values - between 0 and 1, exclusive. Required if the value of - optimization_objective is minimize-quantile-loss. Represents the - percent quantiles to use for that objective. Quantiles must be - unique. - hierarchyConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. + In proto3, the default value of a boolean is false. In this way, by + default EUC will be enabled for NotebookRuntimeTemplate. + type: boolean + description: The euc configuration of NotebookRuntimeTemplate. + GoogleCloudAiplatformV1PrivateServiceConnectConfig: + type: object + id: GoogleCloudAiplatformV1PrivateServiceConnectConfig + properties: + enablePrivateServiceConnect: description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - weightColumn: + Required. If true, expose the IndexEndpoint via private service + connect. + type: boolean + serviceAttachment: description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. This column must be available at forecast. + Output only. The name of the generated service attachment resource. + This is only populated if the endpoint is deployed with + PrivateServiceConnect. type: string - trainBudgetMilliNodeHours: + readOnly: true + projectAllowlist: description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. - format: int64 - type: string - unavailableAtForecastColumns: + A list of Projects from which the forwarding rule will target the + service attachment. type: array - description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. items: type: string - timeColumn: - description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. - type: string - contextWindow: - description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. - format: int64 - type: string - timeSeriesIdentifierColumn: - type: string - description: The name of the column that identifies the time series. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs - type: object - GoogleCloudAiplatformV1TensorboardTensor: + description: Represents configuration for private service connect. + GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata: + id: GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata + description: >- + Runtime operation information for + IndexEndpointService.CreateIndexEndpoint. type: object - id: GoogleCloudAiplatformV1TensorboardTensor - description: One point viewable on a tensor metric plot. properties: - value: - format: byte - description: >- - Required. Serialized form of - https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto - type: string - versionNumber: - format: int32 - description: Optional. Version number of TensorProto used to serialize value. - type: integer - GoogleCloudAiplatformV1BleuMetricValue: - description: Bleu metric value for an instance. - type: object + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec: + description: Value specification for a parameter in `DOUBLE` type. properties: - score: - readOnly: true + maxValue: + format: double + description: Required. Inclusive maximum value of the parameter. type: number - format: float - description: Output only. Bleu score. - id: GoogleCloudAiplatformV1BleuMetricValue - GoogleCloudAiplatformV1PointwiseMetricResult: - type: object - id: GoogleCloudAiplatformV1PointwiseMetricResult - description: Spec for pointwise metric result. - properties: - explanation: - readOnly: true - type: string - description: Output only. Explanation for pointwise metric score. - score: + defaultValue: + format: double + description: >- + A default value for a `DOUBLE` parameter that is assumed to be a + relatively good starting point. Unset value signals that there is no + offered starting point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. type: number - readOnly: true - description: Output only. Pointwise metric score. - format: float - GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks: - properties: - notebooks: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Required. Regional resource references to notebooks. - id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks - description: Open notebooks. + minValue: + format: double + type: number + description: Required. Inclusive minimum value of the parameter. + id: GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec type: object - GoogleCloudAiplatformV1ContainerSpec: - description: The spec of a Container. + GoogleCloudLocationListLocationsResponse: + id: GoogleCloudLocationListLocationsResponse + type: object + description: The response message for Locations.ListLocations. properties: - command: - items: - type: string - type: array - description: >- - The command to be invoked when the container is started. It - overrides the entrypoint instruction in Dockerfile when provided. - args: - description: The arguments to be passed when starting the container. - items: - type: string - type: array - imageUri: - description: >- - Required. The URI of a container image in the Container Registry - that is to be run on each worker replica. + nextPageToken: type: string - env: + description: The standard List next-page token. + locations: description: >- - Environment variables to be passed to the container. Maximum limit - is 100. + A list of locations that matches the specified filter in the + request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + $ref: '#/components/schemas/GoogleCloudLocationLocation' type: array - id: GoogleCloudAiplatformV1ContainerSpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation type: object - GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. properties: - nextPageToken: + timeFormat: description: >- - A token to retrieve next page of results. Pass to - ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) type: string - notebookRuntimeTemplates: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate - description: List of NotebookRuntimeTemplates in the requested page. - description: Response message for NotebookService.ListNotebookRuntimeTemplates. - type: object - id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse - GoogleCloudAiplatformV1FeatureViewVertexRagSource: + columnName: + type: string + GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance: + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance + description: Prediction input format for Text Extraction. type: object properties: - uri: + mimeType: + type: string description: >- - Required. The BigQuery view/table URI that will be materialized on - each manual sync trigger. The table/view is expected to have the - following columns at least: Field name Type Mode corpus_id STRING - REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING - REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE - chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED - file_original_uri STRING REQUIRED/NULLABLE + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + content: type: string - ragCorpusId: - description: Optional. The RAG corpus id corresponding to this FeatureView. - format: int64 + description: The text snippet to make the predictions on. + key: type: string - id: GoogleCloudAiplatformV1FeatureViewVertexRagSource - description: A Vertex Rag source for features that need to be synced to Online Store. - GoogleCloudAiplatformV1UndeployModelOperationMetadata: + description: >- + This field is only used for batch prediction. If a key is provided, + the batch prediction result will by mapped to this key. If omitted, + then the batch prediction result will contain the entire input + instance. Vertex AI will not check if keys in the request are + duplicates, so it is up to the caller to ensure the keys are unique. + GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig: type: object - description: Runtime operation information for EndpointService.UndeployModel. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - id: GoogleCloudAiplatformV1UndeployModelOperationMetadata - GoogleCloudAiplatformV1Attribution: + scaling: + description: >- + Online serving scaling configuration. Only one of `fixed_node_count` + and `scaling` can be set. Setting one will reset the other. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling + fixedNodeCount: + format: int32 + type: integer + description: >- + The number of nodes for the online store. The number of nodes + doesn't scale automatically, but you can manually update the number + of nodes. If set to 0, the featurestore will not have an online + store and cannot be used for online serving. + id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig + description: >- + OnlineServingConfig specifies the details for provisioning online + serving resources. + GoogleCloudAiplatformV1ToolCallValidSpec: + id: GoogleCloudAiplatformV1ToolCallValidSpec + properties: {} + type: object + description: Spec for tool call valid metric. + GoogleCloudAiplatformV1Citation: type: object + description: Source attributions for content. + id: GoogleCloudAiplatformV1Citation properties: - outputDisplayName: - description: >- - Output only. The display name of the output identified by - output_index. For example, the predicted class name by a - multi-classification Model. This field is only populated iff the - Model predicts display names as a separate field along with the - explained output. The predicted display name must has the same shape - of the explained output, and can be located using output_index. - readOnly: true + uri: type: string - instanceOutputValue: - type: number - readOnly: true - description: >- - Output only. Model predicted output on the corresponding explanation - instance. The field name of the output is determined by the key in - ExplanationMetadata.outputs. If the Model predicted output has - multiple dimensions, this is the value in the output located by - output_index. - format: double - featureAttributions: - type: any - description: >- - Output only. Attributions of each explained feature. Features are - extracted from the prediction instances according to explanation - metadata for inputs. The value is a struct, whose keys are the name - of the feature. The values are how much the feature in the instance - contributed to the predicted result. The format of the value is - determined by the feature's input format: * If the feature is a - scalar value, the attribution value is a floating number. * If the - feature is an array of scalar values, the attribution value is an - array. * If the feature is a struct, the attribution value is a - struct. The keys in the attribution value struct are the same as the - keys in the feature struct. The formats of the values in the - attribution struct are determined by the formats of the values in - the feature struct. The - ExplanationMetadata.feature_attributions_schema_uri field, pointed - to by the ExplanationSpec field of the Endpoint.deployed_models - object, points to the schema file that describes the features and - their attribution values (if it is populated). readOnly: true - outputName: - description: >- - Output only. Name of the explain output. Specified as the key in - ExplanationMetadata.outputs. - type: string + description: Output only. Url reference of the attribution. + publicationDate: + description: Output only. Publication date of the attribution. + $ref: '#/components/schemas/GoogleTypeDate' readOnly: true - baselineOutputValue: - type: number - description: >- - Output only. Model predicted output if the input instance is - constructed from the baselines of all the features defined in - ExplanationMetadata.inputs. The field name of the output is - determined by the key in ExplanationMetadata.outputs. If the Model's - predicted output has multiple dimensions (rank > 1), this is the - value in the output located by output_index. If there are multiple - baselines, their output values are averaged. - format: double + endIndex: + type: integer + format: int32 readOnly: true - outputIndex: - description: >- - Output only. The index that locates the explained prediction output. - If the prediction output is a scalar value, output_index is not - populated. If the prediction output has multiple dimensions, the - length of the output_index list is the same as the number of - dimensions of the output. The i-th element in output_index is the - element index of the i-th dimension of the output vector. Indices - start from 0. + description: Output only. End index into the content. + startIndex: + format: int32 readOnly: true - type: array - items: - format: int32 - type: integer - approximationError: - description: >- - Output only. Error of feature_attributions caused by approximation - used in the explanation method. Lower value means more precise - attributions. * For Sampled Shapley attribution, increasing - path_count might reduce the error. * For Integrated Gradients - attribution, increasing step_count might reduce the error. * For - XRAI attribution, increasing step_count might reduce the error. See - [this introduction](/vertex-ai/docs/explainable-ai/overview) for - more information. - format: double + type: integer + description: Output only. Start index into the content. + license: + description: Output only. License of the attribution. readOnly: true - type: number - description: Attribution that explains a particular prediction output. - id: GoogleCloudAiplatformV1Attribution - GoogleCloudAiplatformV1EntityType: - properties: - etag: - type: string - description: >- - Optional. Used to perform a consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - createTime: type: string - description: Output only. Timestamp when this EntityType was created. - format: google-datetime + title: readOnly: true - 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. type: string - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - updateTime: - readOnly: true + description: Output only. Title of the attribution. + GoogleCloudAiplatformV1GcsDestination: + id: GoogleCloudAiplatformV1GcsDestination + description: The Google Cloud Storage location where the output is to be written to. + type: object + properties: + outputUriPrefix: description: >- - Output only. Timestamp when this EntityType was most recently - updated. - format: google-datetime + Required. Google Cloud Storage URI to output directory. If the uri + doesn't end with '/', a '/' will be automatically appended. The + directory is created if it doesn't exist. type: string - offlineStorageTtlDays: + GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData: + type: object + description: Per month usage data + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData + properties: + userUsageData: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData + description: Usage data for each user in the given month. + type: array + GoogleCloudAiplatformV1ListOptimalTrialsRequest: + id: GoogleCloudAiplatformV1ListOptimalTrialsRequest + properties: {} + type: object + description: Request message for VizierService.ListOptimalTrials. + GoogleCloudAiplatformV1ExamplesOverride: + description: Overrides for example-based explanations. + properties: + returnEmbeddings: + type: boolean + description: If true, return the embeddings instead of neighbors. + neighborCount: type: integer format: int32 + description: The number of neighbors to return. + crowdingCount: + format: int32 + type: integer + description: The number of neighbors to return that have the same crowding tag. + restrictions: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExamplesRestrictionsNamespace description: >- - Optional. Config for data retention policy in offline storage. TTL - in days for feature values that will be stored in offline storage. - The Feature Store offline storage periodically removes obsolete - feature values older than `offline_storage_ttl_days` since the - feature generation time. If unset (or explicitly set to 0), default - to 4000 days TTL. - description: + Restrict the resulting nearest neighbors to respect these + constraints. + dataFormat: + enum: + - DATA_FORMAT_UNSPECIFIED + - INSTANCES + - EMBEDDINGS + enumDescriptions: + - Unspecified format. Must not be used. + - Provided data is a set of model inputs. + - Provided data is a set of embeddings. + description: The format of the data being provided with each call. type: string - description: Optional. Description of the EntityType. - satisfiesPzs: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - monitoringConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfig - description: >- - Optional. The default monitoring configuration for all Features with - value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under - this EntityType. If this is populated with - [FeaturestoreMonitoringConfig.monitoring_interval] specified, - snapshot analysis monitoring is enabled. Otherwise, snapshot - analysis monitoring is disabled. - labels: - type: object - description: >- - Optional. The labels with user-defined metadata to organize your - EntityTypes. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one EntityType (System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - additionalProperties: - type: string type: object - description: >- - An entity type is a type of object in a system that needs to be modeled - and have stored information about. For example, driver is an entity - type, and driver0 is an instance of an entity type driver. - id: GoogleCloudAiplatformV1EntityType - GoogleCloudAiplatformV1MetadataStoreMetadataStoreState: - description: Represents state information for a MetadataStore. - id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + id: GoogleCloudAiplatformV1ExamplesOverride + GoogleCloudAiplatformV1CancelCustomJobRequest: type: object - properties: - diskUtilizationBytes: - format: int64 - type: string - description: The disk utilization of the MetadataStore in bytes. - CloudAiLargeModelsVisionVideo: + properties: {} + description: Request message for JobService.CancelCustomJob. + id: GoogleCloudAiplatformV1CancelCustomJobRequest + GoogleCloudAiplatformV1DirectRawPredictResponse: type: object properties: - uri: - description: Path to another storage (typically Google Cloud Storage). - type: string - video: - description: Raw bytes. + output: + description: The prediction output. format: byte type: string - description: Video - id: CloudAiLargeModelsVisionVideo - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs: + description: Response message for PredictionService.DirectRawPredict. + id: GoogleCloudAiplatformV1DirectRawPredictResponse + GoogleCloudAiplatformV1SchemaTextSegment: type: object properties: - modelType: - enumDescriptions: - - Should not be set. - - >- - A model best tailored to be used within Google Cloud, and which c - annot be exported. Default. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. - - >- - A versatile model that is meant to be exported (see - ModelService.ExportModel) and used on a Google Coral device. - - >- - A model that trades off quality for low latency, to be exported - (see ModelService.ExportModel) and used on a Google Coral device. - - >- - A versatile model that is meant to be exported (see - ModelService.ExportModel) and used on an NVIDIA Jetson device. - - >- - A model that trades off quality for low latency, to be exported - (see ModelService.ExportModel) and used on an NVIDIA Jetson - device. - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_CORAL_VERSATILE_1 - - MOBILE_CORAL_LOW_LATENCY_1 - - MOBILE_JETSON_VERSATILE_1 - - MOBILE_JETSON_LOW_LATENCY_1 + startOffset: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs - GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus: - properties: - error: - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' + format: uint64 description: >- - Output only. The error that occurred during the state. May be set - when the state is any of the non-final state - (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is - FAILED, the error here is final and not going to be retried. If the - state is a non-final state, the error indicates a system-error being - retried. - state: - enumDescriptions: - - Unspecified. - - Specifies pending state for the task. - - Specifies task is being executed. - - Specifies task completed successfully. - - Specifies Task cancel is in pending state. - - Specifies task is being cancelled. - - Specifies task was cancelled. - - Specifies task failed. - - Specifies task was skipped due to cache hit. - - >- - Specifies that the task was not triggered because the task's - trigger policy is not satisfied. The trigger policy is specified - in the `condition` field of PipelineJob.pipeline_spec. - readOnly: true - description: Output only. The state of the task. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - CANCEL_PENDING - - CANCELLING - - CANCELLED - - FAILED - - SKIPPED - - NOT_TRIGGERED + Zero-based character index of the first character of the text + segment (counting characters from the beginning of the text). + content: type: string - updateTime: + description: The text content in the segment for output only. + endOffset: type: string - readOnly: true - description: Output only. Update time of this status. - format: google-datetime - description: A single record of the task status. - id: GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus - type: object - GoogleCloudAiplatformV1FindNeighborsResponseNeighbor: - description: A neighbor of the query vector. + description: >- + Zero-based character index of the first character past the end of + the text segment (counting character from the beginning of the + text). The character at the end_offset is NOT included in the text + segment. + format: uint64 + id: GoogleCloudAiplatformV1SchemaTextSegment + description: The text segment inside of DataItem. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics: + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. type: object properties: - distance: + meanAveragePrecision: + format: float type: number - description: The distance between the neighbor and the dense embedding query. - format: double - sparseDistance: + description: The mean average precision, most often close to `auPrc`. + iouThreshold: + format: float + description: >- + The intersection-over-union threshold value used to compute this + metrics entry. type: number - description: The distance between the neighbor and the query sparse_embedding. - format: double - datapoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + confidenceMetrics: description: >- - The datapoint of the neighbor. Note that full datapoints are - returned only when "return_full_datapoint" is set to true. - Otherwise, only the "datapoint_id" and "crowding_tag" fields are - populated. - id: GoogleCloudAiplatformV1FindNeighborsResponseNeighbor - GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig: + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + GoogleCloudAiplatformV1ToolNameMatchMetricValue: + id: GoogleCloudAiplatformV1ToolNameMatchMetricValue + description: Tool name match metric value for an instance. + properties: + score: + type: number + format: float + readOnly: true + description: Output only. Tool name match score. type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation + description: >- + Treats the column as text array and performs following transformation + functions. * Concatenate all text values in the array into a single text + value using a space (" ") as a delimiter, and then treat the result as a + single text value. Apply the transformations for Text columns. * Empty + arrays treated as an empty text. properties: - keyField: + columnName: type: string + type: object + GoogleCloudAiplatformV1ListTuningJobsResponse: + id: GoogleCloudAiplatformV1ListTuningJobsResponse + type: object + properties: + nextPageToken: description: >- - The name of the field that is considered as a key. The values - identified by the key field is not included in the transformed - instances that is sent to the Model. This is similar to specifying - this name of the field in excluded_fields. In addition, the batch - prediction output will not include the instances. Instead the output - will only include the value of the key field, in a field named `key` - in the output: * For `jsonl` output format, the output will have a - `key` field instead of the `instance` field. * For `csv`/`bigquery` - output format, the output will have have a `key` column instead of - the instance feature columns. The input must be JSONL with objects - at each line, CSV, BigQuery or TfRecord. - instanceType: + A token to retrieve the next page of results. Pass to + ListTuningJobsRequest.page_token to obtain that page. type: string - description: >- - The format of the instance that the Model accepts. Vertex AI will - convert compatible batch prediction input instance formats to the - specified format. Supported values are: * `object`: Each input is - converted to JSON object format. * For `bigquery`, each row is - converted to an object. * For `jsonl`, each line of the JSONL input - must be an object. * Does not apply to `csv`, `file-list`, - `tf-record`, or `tf-record-gzip`. * `array`: Each input is converted - to JSON array format. * For `bigquery`, each row is converted to an - array. The order of columns is determined by the BigQuery column - order, unless included_fields is populated. included_fields must be - populated for specifying field orders. * For `jsonl`, if each line - of the JSONL input is an object, included_fields must be populated - for specifying field orders. * Does not apply to `csv`, `file-list`, - `tf-record`, or `tf-record-gzip`. If not specified, Vertex AI - converts the batch prediction input as follows: * For `bigquery` and - `csv`, the behavior is the same as `array`. The order of columns is - the same as defined in the file or table, unless included_fields is - populated. * For `jsonl`, the prediction instance format is - determined by each line of the input. * For - `tf-record`/`tf-record-gzip`, each record will be converted to an - object in the format of `{"b64": }`, where `` is the Base64-encoded - string of the content of the record. * For `file-list`, each file in - the list will be converted to an object in the format of `{"b64": - }`, where `` is the Base64-encoded string of the content of the - file. - excludedFields: + tuningJobs: items: - type: string - description: >- - Fields that will be excluded in the prediction instance that is sent - to the Model. Excluded will be attached to the batch prediction - output if key_field is not specified. When excluded_fields is - populated, included_fields must be empty. The input must be JSONL - with objects at each line, BigQuery or TfRecord. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' type: array - includedFields: - items: - type: string - description: >- - Fields that will be included in the prediction instance that is sent - to the Model. If instance_type is `array`, the order of field names - in included_fields also determines the order of the values in the - array. When included_fields is populated, excluded_fields must be - empty. The input must be JSONL with objects at each line, BigQuery - or TfRecord. - type: array - description: >- - Configuration defining how to transform batch prediction input instances - to the instances that the Model accepts. - id: GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig - GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport: + description: List of TuningJobs in the requested page. + description: Response message for GenAiTuningService.ListTuningJobs + GoogleCloudAiplatformV1TensorboardTensor: + description: One point viewable on a tensor metric plot. + id: GoogleCloudAiplatformV1TensorboardTensor type: object - id: GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport properties: - startTime: - type: string - format: google-datetime - description: >- - Excludes Feature values with feature generation timestamp before - this timestamp. If not set, retrieve oldest values kept in Feature - Store. Timestamp, if present, must not have higher than millisecond - precision. - snapshotTime: + value: type: string description: >- - Exports Feature values as of this timestamp. If not set, retrieve - values as of now. Timestamp, if present, must not have higher than - millisecond precision. - format: google-datetime - description: >- - Describes exporting the latest Feature values of all entities of the - EntityType between [start_time, snapshot_time]. - GoogleCloudAiplatformV1SyncFeatureViewRequest: - id: GoogleCloudAiplatformV1SyncFeatureViewRequest - description: Request message for FeatureOnlineStoreAdminService.SyncFeatureView. + Required. Serialized form of + https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto + format: byte + versionNumber: + type: integer + format: int32 + description: Optional. Version number of TensorProto used to serialize value. + GoogleCloudAiplatformV1FeatureViewDataKey: type: object - properties: {} - GoogleCloudAiplatformV1RougeInstance: + id: GoogleCloudAiplatformV1FeatureViewDataKey + description: Lookup key for a feature view. properties: - prediction: - description: Required. Output of the evaluated model. - type: string - reference: - description: Required. Ground truth used to compare against the prediction. + key: type: string - id: GoogleCloudAiplatformV1RougeInstance - type: object - description: Spec for rouge instance. - GoogleCloudAiplatformV1Explanation: + description: String key to use for lookup. + compositeKey: + description: >- + The actual Entity ID will be composed from this struct. This should + match with the way ID is defined in the FeatureView spec. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey + GoogleCloudAiplatformV1PurgeExecutionsResponse: + description: Response message for MetadataService.PurgeExecutions. type: object - id: GoogleCloudAiplatformV1Explanation - description: >- - Explanation of a prediction (provided in PredictResponse.predictions) - produced by the Model on a given instance. properties: - neighbors: - type: array + purgeSample: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Neighbor' - readOnly: true + type: string description: >- - Output only. List of the nearest neighbors for example-based - explanations. For models deployed with the examples explanations - feature enabled, the attributions field is empty and instead the - neighbors field is populated. - attributions: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' - readOnly: true + A sample of the Execution names that will be deleted. Only populated + if `force` is set to false. The maximum number of samples is 100 (it + is possible to return fewer). type: array - description: >- - Output only. Feature attributions grouped by predicted outputs. For - Models that predict only one output, such as regression Models that - predict only one score, there is only one attibution that explains - the predicted output. For Models that predict multiple outputs, such - as multiclass Models that predict multiple classes, each element - explains one specific item. Attribution.output_index can be used to - identify which output this attribution is explaining. By default, we - provide Shapley values for the predicted class. However, you can - configure the explanation request to generate Shapley values for any - other classes too. For example, if a model predicts a probability of - `0.4` for approving a loan application, the model's decision is to - reject the application since `p(reject) = 0.6 > p(approve) = 0.4`, - and the default Shapley values would be computed for rejection - decision and not approval, even though the latter might be the - positive class. If users set ExplanationParameters.top_k, the - attributions are sorted by instance_output_value in descending - order. If ExplanationParameters.output_indices is specified, the - attributions are stored by Attribution.output_index in the same - order as they appear in the output_indices. - GoogleCloudAiplatformV1SchemaTextClassificationAnnotation: - description: Annotation details specific to text classification. - id: GoogleCloudAiplatformV1SchemaTextClassificationAnnotation - type: object - properties: - displayName: - type: string - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - annotationSpecId: + purgeCount: type: string - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation: - type: object - description: Annotation details specific to video object tracking. - id: GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation - properties: - instanceId: format: int64 - type: string description: >- - The instance of the object, expressed as a positive integer. Used to - track the same object across different frames. - yMax: - type: number - description: The bottommost coordinate of the bounding box. - format: double - xMax: - type: number - format: double - description: The rightmost coordinate of the bounding box. - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - annotationSpecId: - type: string - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - yMin: - type: number - description: The topmost coordinate of the bounding box. - format: double - xMin: - format: double - type: number - description: The leftmost coordinate of the bounding box. - timeOffset: - type: string - description: >- - A time (frame) of a video to which this annotation pertains. - Represented as the duration since the video's start. - format: google-duration - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation: - type: object + The number of Executions that this request deleted (or, if `force` + is false, the number of Executions that will be deleted). This can + be an estimate. + id: GoogleCloudAiplatformV1PurgeExecutionsResponse + GoogleCloudAiplatformV1RougeResults: + description: Results for rouge metric. + id: GoogleCloudAiplatformV1RougeResults properties: - columnName: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation - description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. - GoogleCloudAiplatformV1GenieSource: - id: GoogleCloudAiplatformV1GenieSource + rougeMetricValues: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeMetricValue' + readOnly: true + type: array + description: Output only. Rouge metric values. + type: object + GoogleCloudAiplatformV1SummarizationVerbosityInput: + id: GoogleCloudAiplatformV1SummarizationVerbosityInput properties: - baseModelUri: - description: Required. The public base model URI. - type: string - description: >- - Contains information about the source of the models generated from - Generative AI Studio. + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInstance + description: Required. Summarization verbosity instance. + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbositySpec + description: Required. Spec for summarization verbosity score metric. type: object - GoogleCloudAiplatformV1ExamplesRestrictionsNamespace: - description: Restrictions namespace for example-based explanations overrides. + description: Input for summarization verbosity metric. + GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata: properties: - allow: - type: array - description: The list of allowed tags. - items: - type: string - deny: - type: array - items: - type: string - description: The list of deny tags. - namespaceName: + progressMessage: + description: >- + A human-readable message that shows the intermediate progress + details of NotebookRuntime. type: string - description: The namespace name. - id: GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata + description: Metadata information for NotebookService.UpgradeNotebookRuntime. type: object - GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail: + GoogleCloudAiplatformV1Candidate: + description: A response candidate generated from the model. + id: GoogleCloudAiplatformV1Candidate type: object properties: - failedJobs: - items: - type: string + safetyRatings: type: array description: >- - Output only. The names of the previously failed CustomJob. The list - includes the all attempts in chronological order. + Output only. List of ratings for the safety of a response candidate. + There is at most one rating per category. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' readOnly: true - job: - description: Output only. The name of the CustomJob. - type: string + citationMetadata: readOnly: true - description: The detailed info for a custom job executor. - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail - GoogleCloudAiplatformV1ComputeTokensRequest: - id: GoogleCloudAiplatformV1ComputeTokensRequest - type: object - description: Request message for ComputeTokens RPC call. - properties: - model: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CitationMetadata' + description: Output only. Source attribution of the generated content. + avgLogprobs: + type: number + readOnly: true + format: double + description: Output only. Average log probability score of the candidate. + index: + readOnly: true + description: Output only. Index of the candidate. + format: int32 + type: integer + finishMessage: description: >- - Optional. The name of the publisher model requested to serve the - prediction. Format: - projects/{project}/locations/{location}/publishers/*/models/* + Output only. Describes the reason the mode stopped generating tokens + in more detail. This is only filled when `finish_reason` is set. + readOnly: true type: string - instances: - items: - type: any - type: array + groundingMetadata: description: >- - Optional. The instances that are the input to token computing API - call. Schema is identical to the prediction schema of the text - model, even for the non-text models, like chat models, or Codey - models. - contents: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: Optional. Input content. - GoogleCloudAiplatformV1SummarizationHelpfulnessInstance: - description: Spec for summarization helpfulness instance. - type: object - id: GoogleCloudAiplatformV1SummarizationHelpfulnessInstance - properties: - prediction: - description: Required. Output of the evaluated model. - type: string - instruction: - type: string - description: Optional. Summarization prompt for LLM. - context: - description: Required. Text to be summarized. - type: string - reference: + Output only. Metadata specifies sources used to ground generated + content. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' + content: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + readOnly: true + description: Output only. Content parts of the candidate. + finishReason: + description: >- + Output only. The reason why the model stopped generating tokens. If + empty, the model has not stopped generating the tokens. + enumDescriptions: + - The finish reason is unspecified. + - >- + Token generation reached a natural stopping point or a configured + stop sequence. + - Token generation reached the configured maximum output tokens. + - >- + Token generation stopped because the content potentially contains + safety violations. NOTE: When streaming, content is empty if + content filters blocks the output. + - >- + Token generation stopped because the content potentially contains + copyright violations. + - All other reasons that stopped the token generation. + - >- + Token generation stopped because the content contains forbidden + terms. + - >- + Token generation stopped for potentially containing prohibited + content. + - >- + Token generation stopped because the content potentially contains + Sensitive Personally Identifiable Information (SPII). + - The function call generated by the model is invalid. + enum: + - FINISH_REASON_UNSPECIFIED + - STOP + - MAX_TOKENS + - SAFETY + - RECITATION + - OTHER + - BLOCKLIST + - PROHIBITED_CONTENT + - SPII + - MALFORMED_FUNCTION_CALL type: string - description: Optional. Ground truth used to compare against the prediction. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig: + readOnly: true + GoogleCloudAiplatformV1PersistentResource: + description: >- + Represents long-lasting resources that are dedicated to users to runs + custom workloads. A PersistentResource can have multiple node pools and + each node pool can have its own machine spec. type: object - description: Configuration for exporting test set predictions to a BigQuery table. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + id: GoogleCloudAiplatformV1PersistentResource properties: - destinationBigqueryUri: + displayName: type: string description: >- - URI of desired destination BigQuery table. Expected format: - `bq://{project_id}:{dataset_id}:{table}` If not specified, then - results are exported to the following auto-created BigQuery table: - `{project_id}:export_evaluated_examples_{model_name}_{yyyy_MM_dd'T'HH_mm_ss_SSS'Z'}.evaluated_examples` - overrideExistingTable: - description: >- - If true and an export destination is specified, then the contents of - the destination are overwritten. Otherwise, if the export - destination already exists, then the export operation fails. - type: boolean - GoogleCloudAiplatformV1VertexRagStoreRagResource: - description: The definition of the Rag resource. - id: GoogleCloudAiplatformV1VertexRagStoreRagResource - type: object - properties: - ragCorpus: - type: string + Optional. The display name of the PersistentResource. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. + labels: + type: object description: >- - Optional. RagCorpora resource name. Format: - `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - ragFileIds: + Optional. The labels with user-defined metadata to organize + PersistentResource. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. + additionalProperties: + type: string + reservedIpRanges: items: type: string type: array description: >- - Optional. rag_file_id. The files should be in the same rag_corpus - set in rag_corpus field. - GoogleCloudAiplatformV1Measurement: - type: object - id: GoogleCloudAiplatformV1Measurement - description: >- - A message representing a Measurement of a Trial. A Measurement contains - the Metrics got by executing a Trial using suggested hyperparameter - values. - properties: - stepCount: - format: int64 + Optional. A list of names for the reserved IP ranges under the VPC + network that can be used for this persistent resource. If set, we + will deploy the persistent resource within the provided IP ranges. + Otherwise, the persistent resource is deployed to any IP ranges + under the provided VPC network. Example: ['vertex-ai-ip-range']. + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean readOnly: true - type: string + resourceRuntimeSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntimeSpec' description: >- - Output only. The number of steps the machine learning model has been - trained for. Must be non-negative. - metrics: - type: array + Optional. Persistent Resource runtime spec. For example, used for + Ray cluster configuration. + createTime: + type: string + readOnly: true + description: Output only. Time when the PersistentResource was created. + format: google-datetime + error: readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MeasurementMetric' description: >- - Output only. A list of metrics got by evaluating the objective - functions using suggested Parameter values. - elapsedDuration: + Output only. Only populated when persistent resource's state is + `STOPPING` or `ERROR`. + $ref: '#/components/schemas/GoogleRpcStatus' + resourceRuntime: + description: Output only. Runtime information of the Persistent Resource. readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntime' + name: + description: Immutable. Resource name of a PersistentResource. type: string - format: google-duration + encryptionSpec: description: >- - Output only. Time that the Trial has been running at the point of - this Measurement. - GoogleCloudAiplatformV1CoherenceResult: - id: GoogleCloudAiplatformV1CoherenceResult - description: Spec for coherence result. - properties: - score: - type: number - format: float - description: Output only. Coherence score. - readOnly: true - explanation: + Optional. Customer-managed encryption key spec for a + PersistentResource. If set, this PersistentResource and all + sub-resources of this PersistentResource will be secured by this + key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + updateTime: + format: google-datetime + type: string readOnly: true - description: Output only. Explanation for coherence score. + description: >- + Output only. Time when the PersistentResource was most recently + updated. + startTime: + description: >- + Output only. Time when the PersistentResource for the first time + entered the `RUNNING` state. type: string - confidence: - type: number readOnly: true - description: Output only. Confidence for coherence score. - format: float - type: object - GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest: - description: Request message for TensorboardService.WriteTensorboardExperimentData. - type: object - properties: - writeRunDataRequests: - type: array + format: google-datetime + network: description: >- - Required. Requests containing per-run TensorboardTimeSeries data to - write. + Optional. The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to peered + with Vertex AI to host the persistent resources. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + To specify this field, you must have already [configured VPC Network + Peering for Vertex + AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If + this field is left unspecified, the resources aren't peered with any + network. + type: string + resourcePools: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest - id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation - properties: - columnName: - type: string - description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Convert the category name to a dictionary lookup index and generate an - embedding for each index. - type: object - GoogleCloudAiplatformV1MutateDeployedModelRequest: - type: object - description: Request message for EndpointService.MutateDeployedModel. - id: GoogleCloudAiplatformV1MutateDeployedModelRequest - properties: - updateMask: - description: >- - Required. The update mask applies to the resource. See - google.protobuf.FieldMask. - format: google-fieldmask - type: string - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: >- - Required. The DeployedModel to be mutated within the Endpoint. Only - the following fields can be mutated: * `min_replica_count` in either - DedicatedResources or AutomaticResources * `max_replica_count` in - either DedicatedResources or AutomaticResources * - autoscaling_metric_specs * `disable_container_logging` (v1 only) * - `enable_container_logging` (v1beta1 only) - GoogleCloudAiplatformV1Index: - description: >- - A representation of a collection of database items organized in a way - that allows for approximate nearest neighbor (a.k.a ANN) algorithms - search. - id: GoogleCloudAiplatformV1Index - properties: - indexStats: - readOnly: true - description: Output only. Stats of the index resource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcePool' + description: Required. The spec of the pools of different resources. + type: array satisfiesPzi: type: boolean - description: Output only. Reserved for future use. readOnly: true - satisfiesPzs: - type: boolean description: Output only. Reserved for future use. - readOnly: true - name: + state: type: string + description: Output only. The detailed state of a Study. readOnly: true - description: Output only. The resource name of the Index. - indexUpdateMethod: - type: string + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - RUNNING + - STOPPING + - ERROR + - REBOOTING + - UPDATING enumDescriptions: - - Should not be used. + - Not set. - >- - BatchUpdate: user can call UpdateIndex with files on Cloud Storage - of Datapoints to update. + The PROVISIONING state indicates the persistent resources is being + created. - >- - StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to - update the Index and the updates will be applied in corresponding - DeployedIndexes in nearly real-time. - enum: - - INDEX_UPDATE_METHOD_UNSPECIFIED - - BATCH_UPDATE - - STREAM_UPDATE - description: >- - Immutable. The update method to use with this Index. If not set, - BATCH_UPDATE will be used by default. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Immutable. Customer-managed encryption key spec for an Index. If - set, this Index and all sub-resources of this Index will be secured - by this key. + The RUNNING state indicates the persistent resource is healthy and + fully usable. + - >- + The STOPPING state indicates the persistent resource is being + deleted. + - >- + The ERROR state indicates the persistent resource may be unusable. + Details can be found in the `error` field. + - >- + The REBOOTING state indicates the persistent resource is being + rebooted (PR is not available right now but is expected to be + ready again later). + - >- + The UPDATING state indicates the persistent resource is being + updated. + GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: + id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for creating a MetadataStore. + type: object + description: Details of operations that perform MetadataService.CreateMetadataStore. + GoogleCloudAiplatformV1ModelEvaluationSlice: + type: object + description: >- + A collection of metrics calculated by comparing Model's predictions on a + slice of the test data against ground truth annotations. + properties: createTime: - description: Output only. Timestamp when this Index was created. format: google-datetime type: string readOnly: true - metadata: - type: any + description: Output only. Timestamp when this ModelEvaluationSlice was created. + modelExplanation: description: >- - An additional information about the Index; the schema of the - metadata can be found in metadata_schema. - metadataSchemaUri: + Output only. Aggregated explanation metrics for the Model's + prediction output over the data this ModelEvaluation uses. This + field is populated only if the Model is evaluated with explanations, + and only for tabular Models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' + readOnly: true + metricsSchemaUri: + readOnly: true description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Index, that is specific - to it. Unset if the Index does not have any additional information. - The schema is defined as an OpenAPI 3.0.2 [Schema + Output only. Points to a YAML file stored on Google Cloud Storage + describing the metrics of this ModelEvaluationSlice. The schema is + defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - Note: The URI given on output will be immutable and probably - different, including the URI scheme, than the one given on input. - The output URI will point to a location where the user only has a - read access. type: string - description: + name: + readOnly: true + description: Output only. The resource name of the ModelEvaluationSlice. type: string - description: The description of the Index. - deployedIndexes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' + slice: readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSlice description: >- - Output only. The pointers to DeployedIndexes created from this - Index. An Index can be only deleted if all its DeployedIndexes had - been undeployed first. - displayName: + Output only. The slice of the test data that is used to evaluate the + Model. + metrics: + type: any + readOnly: true + description: >- + Output only. Sliced evaluation metrics of the Model. The schema of + the metrics is stored in metrics_schema_uri + id: GoogleCloudAiplatformV1ModelEvaluationSlice + GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec: + description: >- + Configuration for ConvexAutomatedStoppingSpec. When there are enough + completed trials (configured by min_measurement_count), for pending + trials with enough measurements and steps, the policy first computes an + overestimate of the objective value at max_num_steps according to the + slope of the incomplete objective value curve. No prediction can be made + if the curve is completely flat. If the overestimation is worse than the + best objective value of the completed trials, this pending trial will be + early-stopped, but a last measurement will be added to the pending trial + with max_num_steps and predicted objective value from the autoregression + model. + properties: + updateAllStoppedTrials: + type: boolean + description: >- + ConvexAutomatedStoppingSpec by default only updates the trials that + needs to be early stopped using a newly trained auto-regressive + model. When this flag is set to True, all stopped trials from the + beginning are potentially updated in terms of their + `final_measurement`. Also, note that the training logic of + autoregressive models is different in this case. Enabling this + option has shown better results and this may be the default option + in the future. + minStepCount: type: string + format: int64 description: >- - Required. The display name of the Index. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - updateTime: + Minimum number of steps for a trial to complete. Trials which do not + have a measurement with step_count > min_step_count won't be + considered for early stopping. It's ok to set it to 0, and a trial + can be early stopped at any stage. By default, min_step_count is set + to be one-tenth of the max_step_count. When use_elapsed_duration is + true, this field is set to the minimum elapsed seconds. + learningRateParameterName: type: string - readOnly: true description: >- - Output only. Timestamp when this Index was most recently updated. - This also includes any update to the contents of the Index. Note - that Operations working on this Index may have their - Operations.metadata.generic_metadata.update_time a little after the - value of this timestamp, yet that does not mean their results are - not already reflected in the Index. Result of any successfully - completed Operation on the Index is reflected in it. - format: google-datetime - labels: - type: object - additionalProperties: - type: string + The hyper-parameter name used in the tuning job that stands for + learning rate. Leave it blank if learning rate is not in a parameter + in tuning. The learning_rate is used to estimate the objective value + of the ongoing trial. + maxStepCount: + type: string description: >- - The labels with user-defined metadata to organize your Indexes. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - etag: + Steps used in predicting the final objective for early stopped + trials. In general, it's set to be the same as the defined steps in + training / tuning. If not defined, it will learn it from the + completed trials. When use_steps is false, this field is set to the + maximum elapsed seconds. + format: int64 + minMeasurementCount: type: string + format: int64 description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + The minimal number of measurements in a Trial. Early-stopping checks + will not trigger if less than min_measurement_count+1 completed + trials or pending trials with less than min_measurement_count + measurements. If not defined, the default value is 5. + useElapsedDuration: + description: >- + This bool determines whether or not the rule is applied based on + elapsed_secs or steps. If use_elapsed_duration==false, the early + stopping decision is made according to the predicted objective + values according to the target steps. If use_elapsed_duration==true, + elapsed_secs is used instead of steps. Also, in this case, the + parameters max_num_steps and min_num_steps are overloaded to contain + max_elapsed_seconds and min_elapsed_seconds. + type: boolean type: object - GoogleCloudAiplatformV1IndexDatapointCrowdingTag: + id: GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec + GoogleCloudAiplatformV1AssignNotebookRuntimeRequest: + type: object + id: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest properties: - crowdingAttribute: + notebookRuntimeTemplate: type: string description: >- - The attribute value used for crowding. The maximum number of - neighbors to return per crowding attribute value - (per_crowding_attribute_num_neighbors) is configured per-query. This - field is ignored if per_crowding_attribute_num_neighbors is larger - than the total number of neighbors to return for a given query. + Required. The resource name of the NotebookRuntimeTemplate based on + which a NotebookRuntime will be assigned (reuse or create a new + one). + notebookRuntimeId: + description: Optional. User specified ID for the notebook runtime. + type: string + notebookRuntime: + description: >- + Required. Provide runtime specific information (e.g. runtime owner, + notebook id) used for NotebookRuntime assignment. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + description: Request message for NotebookService.AssignNotebookRuntime. + GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata: type: object - description: >- - Crowding tag is a constraint on a neighbor list produced by nearest - neighbor search requiring that no more than some value k' of the k - neighbors returned have the same value of crowding_attribute. - id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag - GoogleCloudAiplatformV1ListModelEvaluationsResponse: + id: GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore export Feature values. + description: Details of operations that exports Features values. + GoogleCloudAiplatformV1ListTensorboardExperimentsResponse: + id: GoogleCloudAiplatformV1ListTensorboardExperimentsResponse properties: nextPageToken: type: string description: >- - A token to retrieve next page of results. Pass to - ListModelEvaluationsRequest.page_token to obtain that page. - modelEvaluations: - description: List of ModelEvaluations in the requested page. + A token, which can be sent as + ListTensorboardExperimentsRequest.page_token to retrieve the next + page. If this field is omitted, there are no subsequent pages. + tensorboardExperiments: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment' type: array - id: GoogleCloudAiplatformV1ListModelEvaluationsResponse + description: The TensorboardExperiments mathching the request. type: object - description: Response message for ModelService.ListModelEvaluations. - GoogleCloudAiplatformV1ListOptimalTrialsResponse: - id: GoogleCloudAiplatformV1ListOptimalTrialsResponse - description: Response message for VizierService.ListOptimalTrials. - properties: - optimalTrials: - description: >- - The pareto-optimal Trials for multiple objective Study or the - optimal trial for single objective Study. The definition of - pareto-optimal can be checked in wiki page. - https://en.wikipedia.org/wiki/Pareto_efficiency - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + description: Response message for TensorboardService.ListTensorboardExperiments. + GoogleCloudAiplatformV1UndeployModelRequest: type: object - GoogleCloudAiplatformV1DeployModelRequest: + id: GoogleCloudAiplatformV1UndeployModelRequest + description: Request message for EndpointService.UndeployModel. properties: trafficSplit: type: object additionalProperties: - type: integer format: int32 + type: integer description: >- - A map from a DeployedModel's ID to the percentage of this Endpoint's - traffic that should be forwarded to that DeployedModel. If this - field is non-empty, then the Endpoint's traffic_split will be - overwritten with it. To refer to the ID of the just being deployed - Model, a "0" should be used, and the actual ID of the new - DeployedModel will be filled in its place by this method. The - traffic percentage values must add up to 100. If this field is - empty, then the Endpoint's traffic_split is not updated. - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + If this field is provided, then the Endpoint's traffic_split will be + overwritten with it. If last DeployedModel is being undeployed from + the Endpoint, the [Endpoint.traffic_split] will always end up empty + when this call returns. A DeployedModel will be successfully + undeployed only if it doesn't have any traffic assigned to it when + this method executes, or if this field unassigns any traffic to it. + deployedModelId: description: >- - Required. The DeployedModel to be created within the Endpoint. Note - that Endpoint.traffic_split must be updated for the DeployedModel to - start receiving traffic, either as part of this call, or via - EndpointService.UpdateEndpoint. + Required. The ID of the DeployedModel to be undeployed from the + Endpoint. + type: string + GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult: type: object - description: Request message for EndpointService.DeployModel. - id: GoogleCloudAiplatformV1DeployModelRequest - GoogleCloudAiplatformV1StructFieldValue: - id: GoogleCloudAiplatformV1StructFieldValue + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult properties: - value: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: The value for this field. - name: - description: Name of the field in the struct feature. + categoryMask: type: string + description: >- + A PNG image where each pixel in the mask represents the category in + which the pixel in the original image was predicted to belong to. + The size of this image will be the same as the original image. The + mapping between the AnntoationSpec and the color can be found in + model's metadata. The model will choose the most likely category and + if none of the categories reach the confidence threshold, the pixel + will be marked as background. + confidenceMask: + description: >- + A one channel image which is encoded as an 8bit lossless PNG. The + size of the image will be the same as the original image. For a + specific pixel, darker color means less confidence in correctness of + the cateogry in the categoryMask for the corresponding pixel. Black + means no confidence and white means complete confidence. + type: string + description: Prediction output format for Image Segmentation. + GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig: type: object - description: One field of a Struct (or object) type feature value. - GoogleCloudAiplatformV1Tensor: - type: object + description: >- + Configuration defining how to transform batch prediction input instances + to the instances that the Model accepts. properties: - uintVal: - type: array - description: UINT8 UINT16 UINT32 - items: - format: uint32 - type: integer - floatVal: - description: FLOAT - type: array - items: - type: number - format: float - uint64Val: - type: array - description: UINT64 - items: - format: uint64 - type: string - structVal: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: A map of string to tensor. - type: object - int64Val: - description: INT64 - items: - type: string - format: int64 - type: array - stringVal: - type: array - items: - type: string - description: STRING - shape: + excludedFields: items: - format: int64 type: string type: array - description: Shape of the tensor. - dtype: - enum: - - DATA_TYPE_UNSPECIFIED - - BOOL - - STRING - - FLOAT - - DOUBLE - - INT8 - - INT16 - - INT32 - - INT64 - - UINT8 - - UINT16 - - UINT32 - - UINT64 - type: string - description: The data type of tensor. - enumDescriptions: - - >- - Not a legal value for DataType. Used to indicate a DataType field - has not been set. - - >- - Data types that all computation devices are expected to be capable - to support. - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - boolVal: description: >- - Type specific representations that make it easy to create tensor - protos in all languages. Only the representation corresponding to - "dtype" can be set. The values hold the flattened representation of - the tensor in row major order. BOOL - items: - type: boolean - type: array - listVal: - type: array - description: A list of tensor values. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - doubleVal: - type: array - items: - format: double - type: number - description: DOUBLE - intVal: - description: INT_8 INT_16 INT_32 - items: - format: int32 - type: integer - type: array - tensorVal: - format: byte - type: string - description: Serialized raw tensor content. - bytesVal: + Fields that will be excluded in the prediction instance that is sent + to the Model. Excluded will be attached to the batch prediction + output if key_field is not specified. When excluded_fields is + populated, included_fields must be empty. The input must be JSONL + with objects at each line, BigQuery or TfRecord. + includedFields: type: array - description: STRING items: type: string - format: byte - description: A tensor value type. - id: GoogleCloudAiplatformV1Tensor - GoogleCloudAiplatformV1FeatureViewBigQuerySource: - properties: - entityIdColumns: - description: Required. Columns to construct entity_id / row keys. - items: - type: string - type: array - uri: description: >- - Required. The BigQuery view URI that will be materialized on each - sync trigger based on FeatureView.SyncConfig. - type: string - type: object - id: GoogleCloudAiplatformV1FeatureViewBigQuerySource - GoogleCloudAiplatformV1ListContextsResponse: - properties: - nextPageToken: + Fields that will be included in the prediction instance that is sent + to the Model. If instance_type is `array`, the order of field names + in included_fields also determines the order of the values in the + array. When included_fields is populated, excluded_fields must be + empty. The input must be JSONL with objects at each line, BigQuery + or TfRecord. + keyField: + type: string description: >- - A token, which can be sent as ListContextsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. + The name of the field that is considered as a key. The values + identified by the key field is not included in the transformed + instances that is sent to the Model. This is similar to specifying + this name of the field in excluded_fields. In addition, the batch + prediction output will not include the instances. Instead the output + will only include the value of the key field, in a field named `key` + in the output: * For `jsonl` output format, the output will have a + `key` field instead of the `instance` field. * For `csv`/`bigquery` + output format, the output will have have a `key` column instead of + the instance feature columns. The input must be JSONL with objects + at each line, CSV, BigQuery or TfRecord. + instanceType: + description: >- + The format of the instance that the Model accepts. Vertex AI will + convert compatible batch prediction input instance formats to the + specified format. Supported values are: * `object`: Each input is + converted to JSON object format. * For `bigquery`, each row is + converted to an object. * For `jsonl`, each line of the JSONL input + must be an object. * Does not apply to `csv`, `file-list`, + `tf-record`, or `tf-record-gzip`. * `array`: Each input is converted + to JSON array format. * For `bigquery`, each row is converted to an + array. The order of columns is determined by the BigQuery column + order, unless included_fields is populated. included_fields must be + populated for specifying field orders. * For `jsonl`, if each line + of the JSONL input is an object, included_fields must be populated + for specifying field orders. * Does not apply to `csv`, `file-list`, + `tf-record`, or `tf-record-gzip`. If not specified, Vertex AI + converts the batch prediction input as follows: * For `bigquery` and + `csv`, the behavior is the same as `array`. The order of columns is + the same as defined in the file or table, unless included_fields is + populated. * For `jsonl`, the prediction instance format is + determined by each line of the input. * For + `tf-record`/`tf-record-gzip`, each record will be converted to an + object in the format of `{"b64": }`, where `` is the Base64-encoded + string of the content of the record. * For `file-list`, each file in + the list will be converted to an object in the format of `{"b64": + }`, where `` is the Base64-encoded string of the content of the + file. type: string - contexts: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - description: The Contexts retrieved from the MetadataStore. - type: object - id: GoogleCloudAiplatformV1ListContextsResponse - description: Response message for MetadataService.ListContexts. - GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: + id: GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - description: Runtime operation information for DatasetService.CreateDatasetVersion. + description: Operation metadata for Featurestore. type: object - id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata - GoogleCloudAiplatformV1UploadModelResponse: + id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata + description: Details of operations that perform create Featurestore. + GoogleCloudAiplatformV1NearestNeighborsNeighbor: type: object properties: - modelVersionId: - readOnly: true - type: string - description: Output only. The version ID of the model that is uploaded. - model: + entityId: type: string + description: The id of the similar entity. + entityKeyValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse description: >- - The name of the uploaded Model resource. Format: - `projects/{project}/locations/{location}/models/{model}` - description: Response message of ModelService.UploadModel operation. - id: GoogleCloudAiplatformV1UploadModelResponse - GoogleCloudAiplatformV1RemoveContextChildrenRequest: - description: Request message for MetadataService.DeleteContextChildrenRequest. + The attributes of the neighbor, e.g. filters, crowding and metadata + Note that full entities are returned only when "return_full_entity" + is set to true. Otherwise, only the "entity_id" and "distance" + fields are populated. + distance: + description: The distance between the neighbor and the query vector. + type: number + format: double + id: GoogleCloudAiplatformV1NearestNeighborsNeighbor + description: A neighbor of the query vector. + GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput: + type: object + description: The output of a multi-trial Neural Architecture Search (NAS) jobs. + id: GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput properties: - childContexts: + trainTrials: + description: >- + Output only. List of NasTrials that were started as part of train + stage. type: array + readOnly: true items: - type: string - description: The resource names of the child Contexts. - type: object - id: GoogleCloudAiplatformV1RemoveContextChildrenRequest - GoogleCloudAiplatformV1GroundingMetadata: - id: GoogleCloudAiplatformV1GroundingMetadata - properties: - webSearchQueries: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + searchTrials: + description: >- + Output only. List of NasTrials that were started as part of search + stage. items: - type: string - type: array - description: Optional. Web search queries for the following-up web search. - searchEntryPoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SearchEntryPoint' - description: Optional. Google search entry for the following-up web searches. - groundingSupports: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' type: array - description: Optional. List of grounding support. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingSupport' - groundingChunks: + readOnly: true + GoogleCloudAiplatformV1ListEntityTypesResponse: + id: GoogleCloudAiplatformV1ListEntityTypesResponse + description: Response message for FeaturestoreService.ListEntityTypes. + properties: + nextPageToken: + type: string description: >- - List of supporting references retrieved from specified grounding - source. + A token, which can be sent as ListEntityTypesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + entityTypes: type: array + description: The EntityTypes matching the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunk' - description: Metadata returned to client when grounding is enabled. - type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' type: object - properties: - explanationConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig - description: The config for integrating with Vertex Explainable AI. - trainingDataset: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset - description: >- - Training dataset for models. This field has to be set only if - TrainingPredictionSkewDetectionConfig is specified. - trainingPredictionSkewDetectionConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig - description: The config for skew between training data and prediction data. - predictionDriftDetectionConfig: - description: The config for drift of prediction data. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig + GoogleCloudAiplatformV1ModelEvaluation: description: >- - The objective configuration for model monitoring, including the - information needed to detect anomalies for one particular model. - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig - GoogleCloudAiplatformV1NearestNeighborQueryParameters: + A collection of metrics calculated by comparing Model's predictions on + all of the test data against annotations from the test data. properties: - leafNodesSearchFraction: + dataItemSchemaUri: + type: string description: >- - Optional. The fraction of the number of leaves to search, set at - query time allows user to tune search performance. This value - increase result in both search accuracy and latency increase. The - value should be between 0.0 and 1.0. - format: double - type: number - approximateNeighborCandidates: + Points to a YAML file stored on Google Cloud Storage describing + EvaluatedDataItemView.data_item_payload and + EvaluatedAnnotation.data_item_payload. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + This field is not populated if there are neither + EvaluatedDataItemViews nor EvaluatedAnnotations under this + ModelEvaluation. + explanationSpecs: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + type: array description: >- - Optional. The number of neighbors to find via approximate search - before exact reordering is performed; if set, this value must be > - neighbor_count. - format: int32 - type: integer - type: object - description: >- - Parameters that can be overrided in each query to tune query latency and - recall. - id: GoogleCloudAiplatformV1NearestNeighborQueryParameters - GoogleCloudAiplatformV1ModelOriginalModelInfo: - description: Contains information about the original Model if this Model is a copy. - type: object - id: GoogleCloudAiplatformV1ModelOriginalModelInfo - properties: - model: - readOnly: true + Describes the values of ExplanationSpec that are used for explaining + the predicted values on the evaluated data. + metadata: description: >- - Output only. The resource name of the Model this Model is a copy of, - including the revision. Format: - `projects/{project}/locations/{location}/models/{model_id}@{version_id}` - type: string - GoogleCloudAiplatformV1ModelEvaluationSlice: - id: GoogleCloudAiplatformV1ModelEvaluationSlice - description: >- - A collection of metrics calculated by comparing Model's predictions on a - slice of the test data against ground truth annotations. - properties: - name: - description: Output only. The resource name of the ModelEvaluationSlice. - readOnly: true + The metadata of the ModelEvaluation. For the ModelEvaluation + uploaded from Managed Pipeline, metadata contains a structured value + with keys of "pipeline_job_id", "evaluation_dataset_type", + "evaluation_dataset_path", "row_based_metrics_path". + type: any + annotationSchemaUri: type: string + description: >- + Points to a YAML file stored on Google Cloud Storage describing + EvaluatedDataItemView.predictions, + EvaluatedDataItemView.ground_truths, + EvaluatedAnnotation.predictions, and + EvaluatedAnnotation.ground_truths. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + This field is not populated if there are neither + EvaluatedDataItemViews nor EvaluatedAnnotations under this + ModelEvaluation. createTime: - format: google-datetime readOnly: true - description: Output only. Timestamp when this ModelEvaluationSlice was created. + description: Output only. Timestamp when this ModelEvaluation was created. + format: google-datetime + type: string + displayName: + description: The display name of the ModelEvaluation. + type: string + name: type: string - slice: readOnly: true - description: >- - Output only. The slice of the test data that is used to evaluate the - Model. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSlice + description: Output only. The resource name of the ModelEvaluation. modelExplanation: $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' description: >- - Output only. Aggregated explanation metrics for the Model's - prediction output over the data this ModelEvaluation uses. This - field is populated only if the Model is evaluated with explanations, - and only for tabular Models. - readOnly: true + Aggregated explanation metrics for the Model's prediction output + over the data this ModelEvaluation uses. This field is populated + only if the Model is evaluated with explanations, and only for + AutoML tabular Models. + sliceDimensions: + description: >- + All possible dimensions of ModelEvaluationSlices. The dimensions can + be used as the filter of the ModelService.ListModelEvaluationSlices + request, in the form of `slice.dimension = `. + type: array + items: + type: string + metrics: + type: any + description: >- + Evaluation metrics of the Model. The schema of the metrics is stored + in metrics_schema_uri metricsSchemaUri: type: string description: >- - Output only. Points to a YAML file stored on Google Cloud Storage - describing the metrics of this ModelEvaluationSlice. The schema is - defined as an OpenAPI 3.0.2 [Schema + Points to a YAML file stored on Google Cloud Storage describing the + metrics of this ModelEvaluation. The schema is defined as an OpenAPI + 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - readOnly: true - metrics: - description: >- - Output only. Sliced evaluation metrics of the Model. The schema of - the metrics is stored in metrics_schema_uri - type: any - readOnly: true type: object - GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: + id: GoogleCloudAiplatformV1ModelEvaluation + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec: type: object - id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata - description: Details of operations that batch reads Feature values. + id: GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec + properties: + parameterSpec: + description: Required. The spec for a conditional parameter. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + parentIntValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition + description: >- + The spec for matching values from a parent parameter of `INTEGER` + type. + parentCategoricalValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + description: >- + The spec for matching values from a parent parameter of + `CATEGORICAL` type. + parentDiscreteValues: + description: >- + The spec for matching values from a parent parameter of `DISCRETE` + type. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition + description: Represents a parameter spec with condition from its parent parameter. + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: properties: genericMetadata: + description: The common part of the operation metadata. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore batch read Features values. - GoogleCloudAiplatformV1FileData: - id: GoogleCloudAiplatformV1FileData - description: URI based data. + partialResults: + description: >- + Partial results that reflect the latest migration operation + progress. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + type: object + id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata + description: >- + Runtime operation information for + MigrationService.BatchMigrateResources. + GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata: + id: GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata + description: Details of operations that perform create PersistentResource. + type: object properties: - fileUri: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for PersistentResource. + progressMessage: + description: Progress Message for Create LRO type: string - description: Required. URI. - mimeType: + GoogleCloudAiplatformV1IndexDatapointCrowdingTag: + id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag + type: object + properties: + crowdingAttribute: type: string - description: Required. The IANA standard MIME type of the source data. + description: >- + The attribute value used for crowding. The maximum number of + neighbors to return per crowding attribute value + (per_crowding_attribute_num_neighbors) is configured per-query. This + field is ignored if per_crowding_attribute_num_neighbors is larger + than the total number of neighbors to return for a given query. + description: >- + Crowding tag is a constraint on a neighbor list produced by nearest + neighbor search requiring that no more than some value k' of the k + neighbors returned have the same value of crowding_attribute. + GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest: + id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + description: Request message for NotebookService.UpgradeNotebookRuntime. + properties: {} type: object - GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: + GoogleCloudAiplatformV1ModelDeploymentMonitoringJob: type: object properties: - count: - type: number - readOnly: true - format: double - description: Output only. Number of values in the bucket. - right: - description: Output only. Right bound of the bucket. - format: double - type: number + error: + description: >- + Output only. Only populated when the job's state is + `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' readOnly: true - left: + satisfiesPzi: + description: Output only. Reserved for future use. readOnly: true - format: double - type: number - description: Output only. Left bound of the bucket. - description: >- - Dataset bucket used to create a histogram for the distribution given a - population of values. - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket - GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse: - description: Response message for ListDeploymentResourcePools method. - id: GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse - properties: - deploymentResourcePools: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' - type: array - description: The DeploymentResourcePools from the specified location. - nextPageToken: + type: boolean + endpoint: + type: string 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. + Required. Endpoint resource name. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}` + enableMonitoringPipelineLogs: + type: boolean + description: >- + If true, the scheduled monitoring pipeline logs are sent to Google + Cloud Logging, including pipeline status and anomalies detected. + Please note the logs incur cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging#pricing). + createTime: + format: google-datetime type: string - type: object - GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse: - description: >- - Response message for - TensorboardService.BatchCreateTensorboardTimeSeries. - id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse - type: object - properties: - tensorboardTimeSeries: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - description: The created TensorboardTimeSeries. - type: array - GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult: - description: Spec for pairwise question answering quality result. - id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult - properties: - confidence: - format: float - description: Output only. Confidence for question answering quality score. - type: number - readOnly: true - pairwiseChoice: readOnly: true + description: >- + Output only. Timestamp when this ModelDeploymentMonitoringJob was + created. + loggingSamplingStrategy: + description: Required. Sample Strategy for logging. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' + scheduleState: enum: - - PAIRWISE_CHOICE_UNSPECIFIED - - BASELINE - - CANDIDATE - - TIE + - MONITORING_SCHEDULE_STATE_UNSPECIFIED + - PENDING + - OFFLINE + - RUNNING + description: >- + Output only. Schedule state when the monitoring job is in Running + state. + type: string + readOnly: true enumDescriptions: - - Unspecified prediction choice. - - Baseline prediction wins - - Candidate prediction wins - - Winner cannot be determined + - Unspecified state. + - The pipeline is picked up and wait to run. + - The pipeline is offline and will be scheduled for next run. + - The pipeline is running. + modelMonitoringAlertConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfig + description: Alert config for model monitoring. + updateTime: + format: google-datetime + description: >- + Output only. Timestamp when this ModelDeploymentMonitoringJob was + updated most recently. type: string - description: Output only. Pairwise question answering prediction choice. - explanation: - description: Output only. Explanation for question answering quality score. readOnly: true + modelDeploymentMonitoringScheduleConfig: + description: Required. Schedule config for running the monitoring job. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + name: + description: Output only. Resource name of a ModelDeploymentMonitoringJob. type: string - type: object - GoogleCloudAiplatformV1SampledShapleyAttribution: - id: GoogleCloudAiplatformV1SampledShapleyAttribution - type: object - properties: - pathCount: - type: integer - description: >- - Required. The number of feature permutations to consider when - approximating the Shapley values. Valid range of its value is [1, - 50], inclusively. - format: int32 - description: >- - An attribution method that approximates Shapley values for features that - contribute to the label being predicted. A sampling strategy is used to - approximate the value rather than considering all subsets of features. - GoogleCloudAiplatformV1ListBatchPredictionJobsResponse: - id: GoogleCloudAiplatformV1ListBatchPredictionJobsResponse - properties: - batchPredictionJobs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' - description: List of BatchPredictionJobs in the requested page. - type: array - nextPageToken: - type: string - description: >- - A token to retrieve the next page of results. Pass to - ListBatchPredictionJobsRequest.page_token to obtain that page. - description: Response message for JobService.ListBatchPredictionJobs - type: object - GoogleCloudAiplatformV1DirectPredictResponse: - id: GoogleCloudAiplatformV1DirectPredictResponse - properties: - outputs: - type: array - description: The prediction output. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. - description: Response message for PredictionService.DirectPredict. - type: object - GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec: - description: Value specification for a parameter in `CATEGORICAL` type. - properties: - defaultValue: + readOnly: true + statsAnomaliesBaseDirectory: + description: Stats anomalies base folder path. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + labels: description: >- - A default value for a `CATEGORICAL` parameter that is assumed to be - a relatively good starting point. Unset value signals that there is - no offered starting point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - type: string - values: - description: Required. The list of possible categories. - items: - type: string - type: array - id: GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec - type: object - GoogleCloudAiplatformV1NearestNeighborQueryStringFilter: - description: >- - String filter is used to search a subset of the entities by using - boolean rules on string columns. For example: if a query specifies - string filter with 'name = color, allow_tokens = {red, blue}, - deny_tokens = {purple}',' then that query will match entities that are - red or blue, but if those points are also purple, then they will be - excluded even if they are red/blue. Only string filter is supported for - now, numeric filter will be supported in the near future. - id: GoogleCloudAiplatformV1NearestNeighborQueryStringFilter - type: object - properties: - denyTokens: - items: + The labels with user-defined metadata to organize your + ModelDeploymentMonitoringJob. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. + type: object + additionalProperties: type: string - description: Optional. The denied tokens. - type: array - name: + analysisInstanceSchemaUri: + description: >- + YAML schema file uri describing the format of a single instance that + you want Tensorflow Data Validation (TFDV) to analyze. If this field + is empty, all the feature data types are inferred from + predict_instance_schema_uri, meaning that TFDV will use the data in + the exact format(data type) as prediction request/response. If there + are any data type differences between predict instance and TFDV + instance, this field can be used to override the schema. For models + trained with Vertex AI, this field must be set as all the fields in + predict instance formatted as string. type: string - description: Required. Column names in BigQuery that used as filters. - allowTokens: - items: - type: string + modelDeploymentMonitoringObjectiveConfigs: type: array - description: Optional. The allowed tokens. - GoogleCloudAiplatformV1ListSpecialistPoolsResponse: - properties: - specialistPools: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig description: >- - A list of SpecialistPools that matches the specified filter in the - request. - type: array - nextPageToken: - type: string - description: The standard List next-page token. - type: object - description: Response message for SpecialistPoolService.ListSpecialistPools. - id: GoogleCloudAiplatformV1ListSpecialistPoolsResponse - GoogleCloudAiplatformV1SummarizationQualityInput: - id: GoogleCloudAiplatformV1SummarizationQualityInput - properties: - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SummarizationQualitySpec' - description: Required. Spec for summarization quality score metric. - instance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInstance - description: Required. Summarization quality instance. - description: Input for summarization quality metric. - type: object - GoogleCloudAiplatformV1DatasetVersion: - properties: - etag: - type: string + Required. The config for monitoring objectives. This is a per + DeployedModel config. Each DeployedModel needs to be configured + separately. + encryptionSpec: description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - createTime: - description: Output only. Timestamp when this DatasetVersion was created. - type: string - format: google-datetime - readOnly: true - updateTime: - type: string - format: google-datetime - readOnly: true - description: Output only. Timestamp when this DatasetVersion was last updated. - bigQueryDatasetName: - description: Output only. Name of the associated BigQuery dataset. + Customer-managed encryption key spec for a + ModelDeploymentMonitoringJob. If set, this + ModelDeploymentMonitoringJob and all sub-resources of this + ModelDeploymentMonitoringJob will be secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + latestMonitoringPipelineMetadata: readOnly: true - type: string - modelReference: + description: Output only. Latest triggered monitoring pipeline metadata. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata + state: readOnly: true type: string + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED description: >- - Output only. Reference to the public base model last used by the - dataset version. Only set for prompt dataset versions. - name: - description: Output only. Identifier. The resource name of the DatasetVersion. - readOnly: true - type: string - metadata: - readOnly: true - type: any + Output only. The detailed state of the monitoring job. When the job + is still creating, the state will be 'PENDING'. Once the job is + successfully created, the state will be 'RUNNING'. Pause the job, + the state will be 'PAUSED'. Resume the job, the state will return to + 'RUNNING'. + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + samplePredictInstance: description: >- - Required. Output only. Additional information about the - DatasetVersion. + Sample Predict instance, same format as PredictRequest.instances, + this can be set as a replacement of + ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not + set, we will generate predict schema from collected predict + requests. + type: any displayName: type: string description: >- - The user-defined name of the DatasetVersion. The name can be up to - 128 characters long and can consist of any UTF-8 characters. + Required. The user-defined name of the ModelDeploymentMonitoringJob. + The name can be up to 128 characters long and can consist of any + UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. satisfiesPzs: + readOnly: true description: Output only. Reserved for future use. type: boolean + bigqueryTables: readOnly: true - id: GoogleCloudAiplatformV1DatasetVersion - type: object - description: Describes the dataset version. - GoogleCloudAiplatformV1ResumeScheduleRequest: - properties: - catchUp: - type: boolean description: >- - Optional. Whether to backfill missed runs when the schedule is - resumed from PAUSED state. If set to true, all missed runs will be - scheduled. New runs will be scheduled after the backfill is - complete. This will also update Schedule.catch_up field. Default to - false. - type: object - id: GoogleCloudAiplatformV1ResumeScheduleRequest - description: Request message for ScheduleService.ResumeSchedule. - GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest: - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest + Output only. The created bigquery tables for the job under customer + project. Customer could do their own query & analysis. There could + be 4 log tables in maximum: 1. Training data logging predict + request/response 2. Serving data logging predict request/response + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable + predictInstanceSchemaUri: + type: string + description: >- + YAML schema file uri describing the format of a single instance, + which are given to format this Endpoint's prediction (and + explanation). If not set, we will generate predict schema from + collected predict requests. + logTtl: + type: string + format: google-duration + description: >- + The TTL of BigQuery tables in user projects which stores logs. A day + is the basic unit of the TTL and we take the ceil of TTL/86400(a + day). e.g. { second: 3600} indicates ttl = 1 day. + nextScheduleTime: + description: >- + Output only. Timestamp when this monitoring pipeline will be + scheduled to run for the next round. + readOnly: true + format: google-datetime + type: string + description: >- + Represents a job that runs periodically to monitor the deployed models + in an endpoint. It will analyze the logged training & prediction data to + detect any abnormal behaviors. + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + GoogleCloudAiplatformV1PipelineJobRuntimeConfig: + description: The runtime config of a PipelineJob. + id: GoogleCloudAiplatformV1PipelineJobRuntimeConfig type: object properties: - deploymentResourcePoolId: + gcsOutputDirectory: + type: string description: >- - Required. The ID to use for the DeploymentResourcePool, which will - become the final component of the DeploymentResourcePool's resource - name. The maximum length is 63 characters, and valid characters are - `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. + Required. A path in a Cloud Storage bucket, which will be treated as + the root output directory of the pipeline. It is used by the system + to generate the paths of output artifacts. The artifact paths are + generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` + under the specified output directory. The service account specified + in this pipeline must have the `storage.objects.get` and + `storage.objects.create` permissions for this bucket. + failurePolicy: + description: >- + Represents the failure policy of a pipeline. Currently, the default + of a pipeline is that the pipeline will continue to run until no + more tasks can be executed, also known as + PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to + PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new + tasks when a task has failed. Any scheduled tasks will continue to + completion. type: string - deploymentResourcePool: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' - description: Required. The DeploymentResourcePool to create. - description: Request message for CreateDeploymentResourcePool method. - GoogleCloudAiplatformV1WriteFeatureValuesResponse: - id: GoogleCloudAiplatformV1WriteFeatureValuesResponse - properties: {} + enumDescriptions: + - Default value, and follows fail slow behavior. + - >- + Indicates that the pipeline should continue to run until all + possible tasks have been scheduled and completed. + - >- + Indicates that the pipeline should stop scheduling new tasks after + a task has failed. + enum: + - PIPELINE_FAILURE_POLICY_UNSPECIFIED + - PIPELINE_FAILURE_POLICY_FAIL_SLOW + - PIPELINE_FAILURE_POLICY_FAIL_FAST + parameterValues: + additionalProperties: + type: any + description: >- + The runtime parameters of the PipelineJob. The parameters will be + passed into PipelineJob.pipeline_spec to replace the placeholders at + runtime. This field is used by pipelines built using + `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines + built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. + type: object + inputArtifacts: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact + description: >- + The runtime artifacts of the PipelineJob. The key will be the input + artifact name and the value would be one of the InputArtifact. + type: object + parameters: + description: >- + Deprecated. Use RuntimeConfig.parameter_values instead. The runtime + parameters of the PipelineJob. The parameters will be passed into + PipelineJob.pipeline_spec to replace the placeholders at runtime. + This field is used by pipelines built using + `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as + pipelines built using Kubeflow Pipelines SDK 1.8 or lower. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Value' + deprecated: true + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting: + properties: + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata + description: The metadata information. + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs type: object + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting + GoogleCloudAiplatformV1XraiAttribution: description: >- - Response message for - FeaturestoreOnlineServingService.WriteFeatureValues. - GoogleCloudAiplatformV1SearchDataItemsResponse: - id: GoogleCloudAiplatformV1SearchDataItemsResponse - description: Response message for DatasetService.SearchDataItems. + An explanation method that redistributes Integrated Gradients + attributions to segmented regions, taking advantage of the model's fully + differentiable structure. Refer to this paper for more details: + https://arxiv.org/abs/1906.02825 Supported only by image Models. + id: GoogleCloudAiplatformV1XraiAttribution type: object properties: - dataItemViews: - description: The DataItemViews read. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItemView' - type: array - nextPageToken: - type: string + stepCount: + format: int32 + type: integer description: >- - A token to retrieve next page of results. Pass to - SearchDataItemsRequest.page_token to obtain that page. - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity: + Required. The number of steps for approximating the path integral. A + good value to start is 50 and gradually increase until the sum to + diff property is met within the desired error range. Valid range of + its value is [1, 100], inclusively. + smoothGradConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' + description: >- + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy + samples in the vicinity of the inputs. Adding noise can help improve + the computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + blurBaselineConfig: + description: >- + Config for XRAI with blur baseline. When enabled, a linear path from + the maximally blurred image to the input image is created. Using a + blurred baseline instead of zero (black image) is motivated by the + BlurIG approach explained here: https://arxiv.org/abs/2004.03383 + $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' + GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: + description: Runtime operation information for DatasetService.RestoreDatasetVersion. + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata + type: object + GoogleCloudAiplatformV1UploadModelRequest: + id: GoogleCloudAiplatformV1UploadModelRequest + description: Request message for ModelService.UploadModel. type: object properties: - onlineStorageDeletedEntityCount: - type: string - format: int64 + parentModel: description: >- - The count of deleted entities in the online storage. Each entity ID - corresponds to one entity. - offlineStorageDeletedEntityRowCount: - format: int64 + Optional. The resource name of the model into which to upload the + version. Only specify this field when uploading a new version. + type: string + serviceAccount: + type: string description: >- - The count of deleted entity rows in the offline storage. Each row - corresponds to the combination of an entity ID and a timestamp. One - entity ID can have multiple rows in the offline storage. + Optional. The user-provided custom service account to use to do the + model upload. If empty, [Vertex AI Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + will be used to access resources needed to upload the model. This + account must belong to the target project where the model is + uploaded to, i.e., the project specified in the `parent` field of + this request and have necessary read permissions (to Google Cloud + Storage, Artifact Registry, etc.). + model: + description: Required. The Model to create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + modelId: type: string - id: GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity - description: Response message if the request uses the SelectEntity option. - GoogleCloudAiplatformV1FeatureGroupBigQuery: + description: >- + Optional. The ID to use for the uploaded Model, which will become + the final component of the model 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. + GoogleCloudAiplatformV1PurgeArtifactsRequest: + description: Request message for MetadataService.PurgeArtifacts. + id: GoogleCloudAiplatformV1PurgeArtifactsRequest type: object - id: GoogleCloudAiplatformV1FeatureGroupBigQuery properties: - dense: - description: >- - Optional. If set, all feature values will be fetched from a single - row per unique entityId including nulls. If not set, will collapse - all rows for each unique entityId into a singe row with any non-null - values if present, if no non-null values are present will sync null. - ex: If source has schema (entity_id, feature_timestamp, f0, f1) and - values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, - 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) - is synced to online stores. If dense is not set, (e1, 20, 15) is - synced to online stores. - type: boolean - bigQuerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + force: description: >- - Required. Immutable. The BigQuery source URI that points to either a - BigQuery Table or View. - staticDataSource: - description: Optional. Set if the data source is not a time-series. + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Artifact names + that would be deleted. type: boolean - timeSeries: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries - description: >- - Optional. If the source is a time-series source, this can be set to - control how downstream sources (ex: FeatureView ) will treat - time-series sources. If not set, will treat the source as a - time-series source with `feature_timestamp` as timestamp column and - no scan boundary. - entityIdColumns: + filter: + type: string description: >- - Optional. Columns to construct entity_id / row keys. If not provided - defaults to `entity_id`. - items: - type: string - type: array - description: Input source type for BigQuery Tables and Views. - GoogleCloudAiplatformV1FeatureViewDataKey: - description: Lookup key for a feature view. + Required. A required filter matching the Artifacts to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail: type: object + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail properties: - compositeKey: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey + mainJob: description: >- - The actual Entity ID will be composed from this struct. This should - match with the way ID is defined in the FeatureView spec. - key: + Output only. The name of the CustomJob for the main container + execution. + readOnly: true type: string - description: String key to use for lookup. - id: GoogleCloudAiplatformV1FeatureViewDataKey - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics - description: Model evaluation metrics for text sentiment problems. - properties: - confusionMatrix: + failedMainJobs: + type: array + readOnly: true description: >- - Confusion matrix of the evaluation. Only set for ModelEvaluations, - not for ModelEvaluationSlices. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - f1Score: - type: number - format: float - description: The harmonic mean of recall and precision. - recall: - description: Recall. - format: float - type: number - meanAbsoluteError: + Output only. The names of the previously failed CustomJob for the + main container executions. The list includes the all attempts in + chronological order. + items: + type: string + preCachingCheckJob: description: >- - Mean absolute error. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - format: float - type: number - meanSquaredError: - format: float + Output only. The name of the CustomJob for the pre-caching-check + container execution. This job will be available if the + PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in + the lifecycle events. + type: string + readOnly: true + failedPreCachingCheckJobs: description: >- - Mean squared error. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - type: number - quadraticKappa: + Output only. The names of the previously failed CustomJob for the + pre-caching-check container executions. This job will be available + if the PipelineJob.pipeline_spec specifies the `pre_caching_check` + hook in the lifecycle events. The list includes the all attempts in + chronological order. + type: array + items: + type: string + readOnly: true + description: >- + The detail of a container execution. It contains the job names of the + lifecycle of a container execution. + GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams: + properties: + confidenceThreshold: type: number description: >- - Quadratic weighted kappa. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - format: float - precision: - format: float - type: number - description: Precision. - linearKappa: - type: number + When the model predicts category of pixels of the image, it will + only provide predictions for pixels that it is at least this much + confident about. All other pixels will be classified as background. + Default value is 0.5. format: float - description: >- - Linear weighted kappa. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - type: object - GoogleCloudAiplatformV1PipelineTaskExecutorDetail: - type: object - properties: - containerDetail: - readOnly: true - description: Output only. The detailed info for a container executor. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail - customJobDetail: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail - description: Output only. The detailed info for a custom job executor. - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail - description: The runtime detail of a pipeline executor. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry: id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry + GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams + description: Prediction model parameters for Image Segmentation. type: object + GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource: properties: - iouScore: - type: number - format: float + generation: + type: string description: >- - The intersection-over-union score. The measure of overlap of the - annotation's category mask with ground truth category mask on the - DataItem. - precision: - format: float - description: Precision for the given confidence threshold. - type: number - diceScoreCoefficient: - description: DSC or the F1 score, The harmonic mean of recall and precision. - format: float - type: number - confusionMatrix: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: Confusion matrix for the given confidence threshold. - confidenceThreshold: + The version of the Cloud Storage object to read. If unset, the + current version of the object is read. See + https://cloud.google.com/storage/docs/metadata#generation-number. + uri: + type: string description: >- - Metrics are computed with an assumption that the model never returns - predictions with score lower than this value. - format: float - type: number - recall: - type: number - format: float - description: Recall (True Positive Rate) for the given confidence threshold. - GoogleCloudAiplatformV1TrialContext: + The Cloud Storage uri pointing to the ipynb file. Format: + `gs://bucket/notebook_file.ipynb` + description: The Cloud Storage uri for the input notebook. + id: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource type: object - id: GoogleCloudAiplatformV1TrialContext + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs: properties: - description: - description: >- - A human-readable field which can store a description of this - context. This will become part of the resulting Trial's description - field. - type: string - parameters: + quantiles: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + type: number + format: double + description: >- + Quantiles to use for minimize-quantile-loss + `optimization_objective`. Up to 5 quantiles are allowed of values + between 0 and 1, exclusive. Required if the value of + optimization_objective is minimize-quantile-loss. Represents the + percent quantiles to use for that objective. Quantiles must be + unique. type: array + exportEvaluatedDataItemsConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig description: >- - If/when a Trial is generated or selected from this Context, its - Parameters will match any parameters specified here. (I.e. if this - context specifies parameter name:'a' int_value:3, then a resulting - Trial will have int_value:3 for its parameter named 'a'.) Note that - we first attempt to match existing REQUESTED Trials with contexts, - and if there are no matches, we generate suggestions in the subspace - defined by the parameters specified here. NOTE: a Context without - any Parameters matches the entire feasible search space. - GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse: - id: GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse - type: object - properties: - nextPageToken: + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + targetColumn: + description: >- + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + type: string + forecastHorizon: type: string description: >- - A token to retrieve the next page of results. Pass to - ListHyperparameterTuningJobsRequest.page_token to obtain that page. - hyperparameterTuningJobs: + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. + format: int64 + unavailableAtForecastColumns: type: array description: >- - List of HyperparameterTuningJobs in the requested page. - HyperparameterTuningJob.trials of the jobs will be not be returned. + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob - description: Response message for JobService.ListHyperparameterTuningJobs - GoogleCloudAiplatformV1DeployedModel: - type: object - description: A deployment of a Model. Endpoints contain one or more DeployedModels. - id: GoogleCloudAiplatformV1DeployedModel - properties: - createTime: - description: Output only. Timestamp when the DeployedModel was created. - format: google-datetime + type: string + timeColumn: type: string - readOnly: true - disableExplanations: - type: boolean description: >- - If true, deploy the model without explainable feature, regardless - the existence of Model.explanation_spec or explanation_spec. - displayName: + The name of the column that identifies time order in the time + series. This column must be available at forecast. + contextWindow: + description: >- + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. type: string + format: int64 + weightColumn: description: >- - The display name of the DeployedModel. If not provided upon - creation, the Model's display_name is used. - model: + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. This column must be available at forecast. + type: string + optimizationObjective: type: string description: >- - Required. The resource name of the Model that this is the deployment - of. Note that the Model may be in a different location than the - DeployedModel's Endpoint. The resource name may contain version id - or version alias to specify the version. Example: - `projects/{project}/locations/{location}/models/{model}@2` or - `projects/{project}/locations/{location}/models/{model}@golden` if - no version is specified, the default version will be deployed. - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. + additionalExperiments: + description: Additional experiment flags for the time series forcasting training. + type: array + items: + type: string + validationOptions: description: >- - A description of resources that are dedicated to the DeployedModel, - and that need a higher degree of manual configuration. - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + type: string + availableAtForecastColumns: description: >- - Explanation configuration for this DeployedModel. When deploying a - Model using EndpointService.DeployModel, this value overrides the - value of Model.explanation_spec. All fields of explanation_spec are - optional in the request. If a field of explanation_spec is not - populated, the value of the same field of Model.explanation_spec is - inherited. If the corresponding Model.explanation_spec is not - populated, all fields of the explanation_spec will be used for the - explanation configuration. - id: + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. + type: array + items: + type: string + timeSeriesAttributeColumns: description: >- - Immutable. The ID of the DeployedModel. If not provided upon - deployment, Vertex AI will generate a value for this ID. This value - should be 1-10 characters, and valid characters are `/[0-9]/`. - type: string - enableAccessLogging: - type: boolean + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. + type: array + items: + type: string + hierarchyConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig description: >- - If true, online prediction access logs are sent to Cloud Logging. - These logs are like standard server access logs, containing - information like timestamp and latency for each prediction request. - Note that logs may incur a cost, especially if your project receives - prediction requests at a high queries per second rate (QPS). - Estimate your costs before enabling this option. - sharedResources: + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + dataGranularity: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity + description: Expected difference in time granularity between rows in the data. + trainBudgetMilliNodeHours: + format: int64 description: >- - The resource name of the shared DeploymentResourcePool to deploy on. - Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - type: string - serviceAccount: + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. type: string - description: >- - The service account that the DeployedModel's container runs as. - Specify the email address of the service account. If this service - account is not specified, the container runs as a service account - that doesn't have access to the resource project. Users deploying - the Model must have the `iam.serviceAccounts.actAs` permission on - this service account. - modelVersionId: - description: Output only. The version ID of the model that is deployed. - readOnly: true + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. type: string - privateEndpoints: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' - readOnly: true - description: >- - Output only. Provide paths for users to send predict/explain/health - requests directly to the deployed model services running on Cloud - via private services access. This field is populated if network is - configured. - automaticResources: + transformations: + type: array description: >- - A description of resources that to large degree are decided by - Vertex AI, and require only a modest additional configuration. - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - disableContainerLogging: - type: boolean + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + holidayRegions: + items: + type: string + type: array description: >- - For custom-trained Models and AutoML Tabular Models, the container - of the DeployedModel instances will send `stderr` and `stdout` - streams to Cloud Logging by default. Please note that the logs incur - cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging/pricing). User can disable - container logging by setting this flag to true. - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest: - description: Request message for VizierService.CheckTrialEarlyStoppingState. - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest - properties: {} + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. + windowConfig: + description: Config containing strategy for generating sliding windows. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + type: object + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs + GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: + description: Runtime operation information for DatasetService.CreateDatasetVersion. + id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata properties: - evaluatedDataItemsBigqueryUri: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1MigrateResourceResponse: + type: object + description: Describes a successfully migrated resource. + properties: + model: type: string - description: BigQuery destination uri for exported evaluated examples. - trainCostMilliNodeHours: + description: Migrated Model's resource name. + migratableResource: description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - format: int64 + Before migration, the identifier in ml.googleapis.com, + automl.googleapis.com or datalabeling.googleapis.com. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' + dataset: + description: Migrated Dataset's resource name. + type: string + id: GoogleCloudAiplatformV1MigrateResourceResponse + GoogleCloudAiplatformV1FunctionResponse: + properties: + response: + type: object + additionalProperties: + description: Properties of the object. + type: any + description: >- + Required. The function response in JSON object format. Use "output" + key to specify function output and "error" key to specify error + details (if any). If "output" and "error" keys are not specified, + then whole "response" is treated as function output. + name: type: string + description: >- + Required. The name of the function to call. Matches + [FunctionDeclaration.name] and [FunctionCall.name]. + id: GoogleCloudAiplatformV1FunctionResponse type: object - description: Model metadata specific to Seq2Seq Plus Forecasting. - GoogleCloudAiplatformV1GenerationConfig: - id: GoogleCloudAiplatformV1GenerationConfig + 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. + GoogleCloudAiplatformV1ExplanationSpec: + description: Specification of Model explanation. + id: GoogleCloudAiplatformV1ExplanationSpec type: object properties: - responseSchema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + metadata: description: >- - Optional. The `Schema` object allows the definition of input and - output data types. These types can be objects, but also primitives - and arrays. Represents a select subset of an [OpenAPI 3.0 schema - object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a - compatible response_mime_type must also be set. Compatible - mimetypes: `application/json`: Schema for JSON response. - routingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfig - description: Optional. Routing configuration. - topP: - type: number - format: float - description: Optional. If specified, nucleus sampling will be used. - candidateCount: - type: integer - format: int32 - description: Optional. Number of candidates to generate. - responseMimeType: - type: string + Optional. Metadata describing the Model's input and output for + explanation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationMetadata' + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' description: >- - Optional. Output response mimetype of the generated candidate text. - Supported mimetype: - `text/plain`: (default) Text output. - - `application/json`: JSON response in the candidates. The model needs - to be prompted to output the appropriate response type, otherwise - the behavior is undefined. This is a preview feature. - stopSequences: - type: array - items: - type: string - description: Optional. Stop sequences. - topK: + Required. Parameters that configure explaining of the Model's + predictions. + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange: + description: A range of values for slice(s). `low` is inclusive, `high` is exclusive. + type: object + properties: + high: format: float - description: Optional. If specified, top-k sampling will be used. + description: Exclusive high value for the range. type: number - maxOutputTokens: - description: >- - Optional. The maximum number of output tokens to generate per - message. - format: int32 - type: integer - frequencyPenalty: + low: + description: Inclusive low value for the range. format: float - description: Optional. Frequency penalties. - type: number - presencePenalty: - type: number - format: float - description: Optional. Positive penalties. - seed: - format: int32 - type: integer - description: Optional. Seed. - temperature: - format: float - description: Optional. Controls the randomness of predictions. type: number - description: Generation config. - GoogleCloudAiplatformV1BoolArray: - id: GoogleCloudAiplatformV1BoolArray - description: A list of boolean values. - properties: - values: - description: A list of bool values. - type: array - items: - type: boolean - type: object - GoogleCloudAiplatformV1ServiceAccountSpec: - id: GoogleCloudAiplatformV1ServiceAccountSpec + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + GoogleCloudAiplatformV1PSCAutomationConfig: type: object description: >- - Configuration for the use of custom service account to run the - workloads. + PSC config that is used to automatically create forwarding rule via + ServiceConnectionMap. properties: - enableCustomServiceAccount: - type: boolean - description: >- - Required. If true, custom user-managed service account is enforced - to run any workloads (for example, Vertex Jobs) on the resource. - Otherwise, uses the [Vertex AI Custom Code Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - serviceAccount: + network: type: string description: >- - Optional. Required when all below conditions are met * - `enable_custom_service_account` is true; * any runtime is specified - via `ResourceRuntimeSpec` on creation time, for example, Ray The - users must have `iam.serviceAccounts.actAs` permission on this - service account and then the specified runtime containers will run - as it. Do not set this field if you want to submit jobs using custom - service account to this PersistentResource after creation, but only - specify the `service_account` inside the job. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs: + Required. The full name of the Google Compute Engine + [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where {project} is a + project number, as in '12345', and {network} is network name. + projectId: + description: Required. Project id used to create forwarding rule. + type: string + id: GoogleCloudAiplatformV1PSCAutomationConfig + GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor: + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor + description: Metadata for requested Features. properties: - budgetMilliNodeHours: - format: int64 + id: type: string - description: >- - The training budget of creating this model, expressed in milli node - hours i.e. 1,000 value in this field means 1 node hour. The actual - metadata.costMilliNodeHours will be equal or less than this value. - If further model training ceases to provide any improvements, it - will stop without using the full budget and the - metadata.successfulStopReason will be `model-converged`. Note, - node_hour = actual_hour * number_of_nodes_involved. For modelType - `cloud`(default), the budget must be between 8,000 and 800,000 milli - node hours, inclusive. The default value is 192,000 which represents - one day in wall time, considering 8 nodes are used. For model types - `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, - `mobile-tf-high-accuracy-1`, the training budget must be between - 1,000 and 100,000 milli node hours, inclusive. The default value is - 24,000 which represents one day in wall time on a single node that - is used. - disableEarlyStopping: - description: >- - Use the entire training budget. This disables the early stopping - feature. When false the early stopping feature is enabled, which - means that AutoML Image Classification might stop training before - the entire training budget has been used. - type: boolean - tunableParameter: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - description: Trainer type for Vision TrainRequest. - baseModelId: + description: Feature ID. + type: object + GoogleCloudAiplatformV1TimeSeriesDataPoint: + type: object + description: A TensorboardTimeSeries data point. + properties: + scalar: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scalar' + description: A scalar value. + wallTime: + format: google-datetime type: string description: >- - The ID of the `base` model. If it is specified, the new model will - be trained based on the `base` model. Otherwise, the new model will - be trained from scratch. The `base` model must be in the same - Project and Location as the new Model to train, and have the same - modelType. - uptrainBaseModelId: + Wall clock timestamp when this data point is generated by the end + user. + step: + format: int64 + description: Step index of this data point within the run. type: string - description: >- - The ID of `base` model for upTraining. If it is specified, the new - model will be upTrained based on the `base` model for upTraining. - Otherwise, the new model will be trained from scratch. The `base` - model for upTraining must be in the same Project and Location as the - new Model to train, and have the same modelType. - modelType: + tensor: + description: A tensor value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTensor' + blobs: + description: A blob sequence value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlobSequence' + id: GoogleCloudAiplatformV1TimeSeriesDataPoint + GoogleCloudAiplatformV1EvaluatedAnnotationExplanation: + properties: + explanation: + description: Explanation attribution response details. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + explanationType: type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - CLOUD_1 - - MOBILE_TF_LOW_LATENCY_1 - - MOBILE_TF_VERSATILE_1 - - MOBILE_TF_HIGH_ACCURACY_1 - - EFFICIENTNET - - MAXVIT - - VIT - - COCA - enumDescriptions: - - Should not be set. - - >- - A Model best tailored to be used within Google Cloud, and which - cannot be exported. Default. - - >- - A model type best tailored to be used within Google Cloud, which - cannot be exported externally. Compared to the CLOUD model above, - it is expected to have higher prediction accuracy. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device afterwards. - Expected to have low latency, but may have lower prediction - quality than other mobile models. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device with - afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device afterwards. - Expected to have a higher latency, but should also have a higher - prediction quality than other mobile models. - - >- - EfficientNet model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - MaxViT model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - ViT model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - CoCa model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - multiLabel: - type: boolean description: >- - If false, a single-label (multi-class) Model will be trained (i.e. - assuming that for each image just up to one annotation may be - applicable). If true, a multi-label Model will be trained (i.e. - assuming that for each image multiple annotations may be - applicable). - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + id: GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + type: object + description: Explanation result of the prediction produced by the Model. + GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue: + description: Tool parameter key match metric value for an instance. + id: GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue type: object - GoogleCloudAiplatformV1TunedModel: properties: - model: - type: string - description: >- - Output only. The resource name of the TunedModel. Format: - `projects/{project}/locations/{location}/models/{model}`. - readOnly: true - endpoint: + score: + type: number + description: Output only. Tool parameter key match score. + format: float readOnly: true - type: string - description: >- - Output only. A resource name of an Endpoint. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}`. - type: object - id: GoogleCloudAiplatformV1TunedModel - description: >- - The Model Registry Model and Online Prediction Endpoint assiociated with - this TuningJob. - GoogleCloudAiplatformV1CreateFeatureOperationMetadata: - description: Details of operations that perform create Feature. + GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata: + properties: + multiLabel: + description: Whether or not the classification label is multi_label. + type: boolean type: object + id: >- + GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata + GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: properties: genericMetadata: + description: Operation metadata for FeatureOnlineStore. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. - id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata - GoogleCloudAiplatformV1MutateDeployedModelResponse: - description: Response message for EndpointService.MutateDeployedModel. - id: GoogleCloudAiplatformV1MutateDeployedModelResponse + id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata type: object + description: Details of operations that perform create FeatureOnlineStore. + GoogleCloudAiplatformV1ToolCallValidInstance: + id: GoogleCloudAiplatformV1ToolCallValidInstance properties: - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: The DeployedModel that's being mutated. - GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata: - id: GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + prediction: + type: string + description: Required. Output of the evaluated model. + description: Spec for tool call valid instance. + type: object + GoogleCloudAiplatformV1PredictRequest: + id: GoogleCloudAiplatformV1PredictRequest properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore. + instances: + description: >- + Required. The instances that are the input to the prediction call. A + DeployedModel may have an upper limit on the number of instances it + supports per request, and when it is exceeded the prediction call + errors in case of AutoML Models, or, in case of customer created + Models, the behaviour is as documented by that Model. The schema of + any single instance may be specified via Endpoint's DeployedModels' + Model's PredictSchemata's instance_schema_uri. + items: + type: any + type: array + parameters: + description: >- + The parameters that govern the prediction. The schema of the + parameters may be specified via Endpoint's DeployedModels' Model's + PredictSchemata's parameters_schema_uri. + type: any + description: Request message for PredictionService.Predict. type: object - description: Details of operations that perform update Featurestore. - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig: - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + GoogleCloudAiplatformV1NearestNeighborQuery: properties: - datasetDisplayName: - type: string + perCrowdingAttributeNeighborCount: description: >- - Optional. Display name of the Dataset in Vertex AI. System will pick - a display name if unspecified. - dataset: + Optional. Crowding is a constraint on a neighbor list produced by + nearest neighbor search requiring that no more than + sper_crowding_attribute_neighbor_count of the k neighbors returned + have the same value of crowding_attribute. It's used for improving + result diversity. + type: integer + format: int32 + embedding: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryEmbedding + description: Optional. The embedding vector that be used for similar search. + neighborCount: + format: int32 + type: integer + description: >- + Optional. The number of similar entities to be retrieved from + feature view for each query. + parameters: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryParameters + description: Optional. Parameters that can be set to tune query on the fly. + numericFilters: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter + description: Optional. The list of numeric filters. + type: array + entityId: type: string description: >- - Required. Full resource name of data labeling Dataset. Format: - `projects/{project}/datasets/{dataset}`. - migrateDataLabelingAnnotatedDatasetConfigs: + Optional. The entity id whose similar entities should be searched + for. If embedding is set, search will use embedding instead of + entity_id. + stringFilters: type: array + description: Optional. The list of string filters. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig - description: >- - Optional. Configs for migrating AnnotatedDataset in - datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified - AnnotatedDatasets have to belong to the datalabeling Dataset. + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryStringFilter + id: GoogleCloudAiplatformV1NearestNeighborQuery + description: A query to find a number of similar entities. + type: object + GoogleCloudAiplatformV1UndeployModelResponse: + type: object + id: GoogleCloudAiplatformV1UndeployModelResponse + properties: {} + description: Response message for EndpointService.UndeployModel. + GoogleCloudAiplatformV1RemoveContextChildrenResponse: + type: object + properties: {} + id: GoogleCloudAiplatformV1RemoveContextChildrenResponse + description: Response message for MetadataService.RemoveContextChildren. + GoogleCloudAiplatformV1ImportDataConfig: + id: GoogleCloudAiplatformV1ImportDataConfig type: object description: >- - Config for migrating Dataset in datalabeling.googleapis.com to Vertex - AI's Dataset. - GoogleCloudAiplatformV1NasTrial: - id: GoogleCloudAiplatformV1NasTrial + 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. properties: - endTime: + annotationLabels: + type: object + additionalProperties: + type: string description: >- - Output only. Time when the NasTrial's status changed to `SUCCEEDED` - or `INFEASIBLE`. - readOnly: true - format: google-datetime + Labels that will be applied to newly imported Annotations. If two + Annotations are identical, one of them will be deduped. Two + Annotations are considered identical if their payload, + payload_schema_uri and all of their labels are the same. These + labels will be overridden by Annotation labels specified inside + index file referenced by import_schema_uri, e.g. jsonl file. + importSchemaUri: type: string - id: - description: Output only. The identifier of the NasTrial assigned by the service. - readOnly: true + description: >- + Required. Points to a YAML file stored on Google Cloud Storage + describing the import format. Validation will be done against the + schema. The schema is defined as an [OpenAPI 3.0.2 Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + dataItemLabels: + type: object + additionalProperties: + type: string + description: >- + Labels that will be applied to newly imported DataItems. If an + identical DataItem as one being imported already exists in the + Dataset, then these labels will be appended to these of the already + existing one, and if labels with identical key is imported before, + the old label value will be overwritten. If two DataItems are + identical in the same import data operation, the labels will be + combined and if key collision happens in this case, one of the + values will be picked randomly. Two DataItems are considered + identical if their content bytes are identical (e.g. image bytes or + pdf bytes). These labels will be overridden by Annotation labels + specified inside index file referenced by import_schema_uri, e.g. + jsonl file. + gcsSource: + description: The Google Cloud Storage location for the input content. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics: + properties: + meanAbsoluteError: + format: float + description: >- + Mean absolute error. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + type: number + meanSquaredError: + format: float + description: >- + Mean squared error. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + type: number + confusionMatrix: + description: >- + Confusion matrix of the evaluation. Only set for ModelEvaluations, + not for ModelEvaluationSlices. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + linearKappa: + description: >- + Linear weighted kappa. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + type: number + format: float + recall: + format: float + type: number + description: Recall. + quadraticKappa: + type: number + format: float + description: >- + Quadratic weighted kappa. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + precision: + type: number + format: float + description: Precision. + f1Score: + format: float + type: number + description: The harmonic mean of recall and precision. + type: object + description: Model evaluation metrics for text sentiment problems. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics + GoogleCloudAiplatformV1SuggestTrialsResponse: + type: object + properties: + endTime: type: string - state: + description: The time at which operation processing completed. + format: google-datetime + trials: + type: array + description: A list of Trials. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + studyState: + description: The state of the Study. enumDescriptions: - - The NasTrial state is unspecified. - - >- - Indicates that a specific NasTrial has been requested, but it has - not yet been suggested by the service. - - Indicates that the NasTrial has been suggested. - - Indicates that the NasTrial should stop according to the service. - - Indicates that the NasTrial is completed successfully. + - The study state is unspecified. + - The study is active. + - The study is stopped due to an internal error. - >- - Indicates that the NasTrial should not be attempted again. The - service will set a NasTrial to INFEASIBLE when it's done but - missing the final_measurement. + The study is done when the service exhausts the parameter search + space or max_trial_count is reached. enum: - STATE_UNSPECIFIED - - REQUESTED - ACTIVE - - STOPPING - - SUCCEEDED - - INFEASIBLE - readOnly: true + - INACTIVE + - COMPLETED type: string - description: Output only. The detailed state of the NasTrial. - finalMeasurement: - description: Output only. The final measurement containing the objective value. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' startTime: - description: Output only. Time when the NasTrial was started. - readOnly: true type: string + description: The time at which the operation was started. format: google-datetime - description: Represents a uCAIP NasJob trial. - type: object - GoogleCloudAiplatformV1StudySpec: - description: Represents specification of a Study. + description: Response message for VizierService.SuggestTrials. + id: GoogleCloudAiplatformV1SuggestTrialsResponse + GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: properties: - metrics: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpec' - description: Required. Metric specs for the Study. - observationNoise: - enum: - - OBSERVATION_NOISE_UNSPECIFIED - - LOW - - HIGH - enumDescriptions: - - The default noise level chosen by Vertex AI. - - >- - Vertex AI assumes that the objective function is (nearly) - perfectly reproducible, and will never repeat the same Trial - parameters. - - >- - Vertex AI will estimate the amount of noise in metric evaluations, - it may repeat the same Trial parameters more than once. + mean: + readOnly: true + type: number + description: Output only. The arithmetic mean of the values in the population. + format: double + sum: + format: int64 + readOnly: true type: string - description: >- - The observation noise level of the study. Currently only supported - by the Vertex AI Vizier service. Not supported by - HyperparameterTuningJob or TrainingPipeline. - parameters: + description: Output only. Sum of a given population of values. + min: + format: double + description: Output only. The minimum of the population values. + readOnly: true + type: number + median: + type: number + format: double + readOnly: true + description: Output only. The median of the values in the population. + p5: + format: double + type: number + description: Output only. The 5th percentile of the values in the population. + readOnly: true + buckets: + readOnly: true + description: Output only. Defines the histogram bucket. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket type: array - description: Required. The set of parameters to tune. - decayCurveStoppingSpec: - description: The automated early stopping spec using decay curve rule. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec - convexAutomatedStoppingSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec - description: The automated early stopping spec using convex stopping rule. - algorithm: - type: string - description: The search algorithm specified for the Study. - enumDescriptions: - - >- - The default algorithm used by Vertex AI for [hyperparameter - tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview) - and [Vertex AI - Vizier](https://cloud.google.com/vertex-ai/docs/vizier). - - >- - Simple grid search within the feasible space. To use grid search, - all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`. - - Simple random search within the feasible space. - enum: - - ALGORITHM_UNSPECIFIED - - GRID_SEARCH - - RANDOM_SEARCH - medianAutomatedStoppingSpec: - description: The automated early stopping spec using median rule. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec - measurementSelectionType: - enumDescriptions: - - Will be treated as LAST_MEASUREMENT. - - Use the last measurement reported. - - Use the best measurement reported. - description: Describe which measurement selection type will be used + p95: + format: double + description: Output only. The 95th percentile of the values in the population. + type: number + readOnly: true + billableSum: + format: int64 type: string - enum: - - MEASUREMENT_SELECTION_TYPE_UNSPECIFIED - - LAST_MEASUREMENT - - BEST_MEASUREMENT - studyStoppingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecStudyStoppingConfig - description: >- - Conditions for automated stopping of a Study. Enable automated - stopping by configuring at least one condition. - type: object - id: GoogleCloudAiplatformV1StudySpec - GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest: - id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + readOnly: true + description: Output only. Sum of a given population of values that are billable. + max: + format: double + description: Output only. The maximum of the population values. + readOnly: true + type: number type: object + description: Dataset distribution for Supervised Tuning. + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + GoogleCloudAiplatformV1FeatureValueMetadata: + id: GoogleCloudAiplatformV1FeatureValueMetadata properties: - evaluatedAnnotations: - description: Required. Evaluated annotations resource to be imported. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotation' - description: Request message for ModelService.BatchImportEvaluatedAnnotations - GoogleCloudAiplatformV1ListTensorboardRunsResponse: - id: GoogleCloudAiplatformV1ListTensorboardRunsResponse - description: Response message for TensorboardService.ListTensorboardRuns. - properties: - nextPageToken: - type: string + generateTime: + format: google-datetime description: >- - A token, which can be sent as ListTensorboardRunsRequest.page_token - to retrieve the next page. If this field is omitted, there are no - subsequent pages. - tensorboardRuns: - description: The TensorboardRuns mathching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - type: array - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata + Feature generation timestamp. Typically, it is provided by user at + feature ingestion time. If not, feature store will use the system + timestamp when the data is ingested into feature store. For + streaming ingestion, the time, aligned by days, must be no older + than five years (1825 days) and no later than one year (366 days) in + the future. + type: string type: object + description: Metadata of feature value. + GoogleCloudAiplatformV1Blob: properties: - successfulStopReason: + data: + format: byte + description: Required. Raw bytes. type: string - description: >- - For successful job completions, this is the reason why the job has - finished. - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED - enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - - >- - Further training of the Model ceased to increase its quality, - since it already has converged. - costMilliNodeHours: - format: int64 - description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. + mimeType: + description: Required. The IANA standard MIME type of the source data. type: string - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + description: >- + Content blob. It's preferred to send as text directly rather than raw + bytes. + id: GoogleCloudAiplatformV1Blob + type: object + GoogleCloudAiplatformV1WriteTensorboardRunDataResponse: + type: object + properties: {} + description: Response message for TensorboardService.WriteTensorboardRunData. + id: GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + GoogleCloudAiplatformV1BoolArray: + id: GoogleCloudAiplatformV1BoolArray + description: A list of boolean values. + type: object properties: - confidenceThreshold: - description: The confidence threshold value used to compute the metrics. - type: number - format: float - f1Score: + values: + items: + type: boolean + description: A list of bool values. + type: array + GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: + description: >- + Dataset bucket used to create a histogram for the distribution given a + population of values. + type: object + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + properties: + right: + description: Output only. Right bound of the bucket. type: number - format: float - description: The harmonic mean of recall and precision. - precision: - format: float - description: Precision under the given confidence threshold. + format: double + readOnly: true + left: + format: double type: number - recall: - format: float - description: Recall under the given confidence threshold. + description: Output only. Left bound of the bucket. + readOnly: true + count: + format: double type: number - description: Metrics for a single confidence threshold. - type: object - GoogleCloudAiplatformV1Featurestore: + readOnly: true + description: Output only. Number of values in the bucket. + GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig: type: object - id: GoogleCloudAiplatformV1Featurestore + id: GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig + properties: + leafNodeEmbeddingCount: + description: >- + Optional. Number of embeddings on each leaf node. The default value + is 1000 if not set. + type: string + format: int64 + description: Configuration options for the tree-AH algorithm. + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis: description: >- - Vertex AI Feature Store provides a centralized repository for - organizing, storing, and serving ML features. The Featurestore is a - top-level container for your features and their values. + Configuration of the Featurestore's Snapshot Analysis Based Monitoring. + This type of analysis generates statistics for each Feature based on a + snapshot of the latest feature value of each entities every + monitoring_interval. + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis properties: - onlineStorageTtlDays: + disabled: + type: boolean + description: >- + The monitoring schedule for snapshot analysis. For EntityType-level + config: unset / disabled = true indicates disabled by default for + Features under it; otherwise by default enable snapshot analysis + monitoring with monitoring_interval for Features under it. + Feature-level config: disabled = true indicates disabled regardless + of the EntityType-level config; unset monitoring_interval indicates + going with EntityType-level config; otherwise run snapshot analysis + monitoring with monitoring_interval regardless of the + EntityType-level config. Explicitly Disable the snapshot analysis + based monitoring. + monitoringIntervalDays: type: integer description: >- - Optional. TTL in days for feature values that will be stored in - online serving storage. The Feature Store online storage - periodically removes obsolete feature values older than - `online_storage_ttl_days` since the feature generation time. Note - that `online_storage_ttl_days` should be less than or equal to - `offline_storage_ttl_days` for each EntityType under a featurestore. - If not set, default to 4000 days + Configuration of the snapshot analysis based monitoring pipeline + running interval. The value indicates number of days. format: int32 - encryptionSpec: - description: >- - Optional. Customer-managed encryption key spec for data storage. If - set, both of the online and offline data storage will be secured by - this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - name: + stalenessDays: + format: int32 + type: integer description: >- - Output only. Name of the Featurestore. Format: - `projects/{project}/locations/{location}/featurestores/{featurestore}` - readOnly: true + Customized export features time window for snapshot analysis. Unit + is one day. Default value is 3 weeks. Minimum value is 1 day. + Maximum value is 4000 days. + type: object + GoogleCloudAiplatformV1SummarizationQualityInstance: + type: object + id: GoogleCloudAiplatformV1SummarizationQualityInstance + description: Spec for summarization quality instance. + properties: + context: type: string - state: - description: Output only. State of the featurestore. + description: Required. Text to be summarized. + reference: + description: Optional. Ground truth used to compare against the prediction. type: string - enumDescriptions: - - Default value. This value is unused. - - >- - State when the featurestore configuration is not being updated and - the fields reflect the current configuration of the featurestore. - The featurestore is usable in this state. - - >- - The state of the featurestore configuration when it is being - updated. During an update, the fields reflect either the original - configuration or the updated configuration of the featurestore. - For example, `online_serving_config.fixed_node_count` can take - minutes to update. While the update is in progress, the - featurestore is in the UPDATING state, and the value of - `fixed_node_count` can be the original value or the updated value, - depending on the progress of the operation. Until the update - completes, the actual number of nodes can still be the original - value of `fixed_node_count`. The featurestore is still usable in - this state. - enum: - - STATE_UNSPECIFIED - - STABLE - - UPDATING - readOnly: true - createTime: - format: google-datetime - description: Output only. Timestamp when this Featurestore was created. - readOnly: true + prediction: type: string - labels: - type: object - description: >- - Optional. The labels with user-defined metadata to organize your - Featurestore. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one Featurestore(System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - additionalProperties: - type: string - etag: + description: Required. Output of the evaluated model. + instruction: type: string + description: Required. Summarization prompt for LLM. + GoogleTypeInterval: + properties: + endTime: description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - onlineServingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + type: string + format: google-datetime + startTime: description: >- - Optional. Config for online storage resources. The field should not - co-exist with the field of `OnlineStoreReplicationConfig`. If both - of it and OnlineStoreReplicationConfig are unset, the feature store - will not have an online store and cannot be used for online serving. - satisfiesPzs: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - updateTime: - readOnly: true + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. type: string - description: Output only. Timestamp when this Featurestore was last updated. format: google-datetime - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation: - properties: - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation - GoogleCloudAiplatformV1Scalar: - properties: - value: - type: number - description: Value of the point at this step / timestamp. - format: double - id: GoogleCloudAiplatformV1Scalar + id: GoogleTypeInterval type: object - description: One point viewable on a scalar metric plot. - GoogleCloudAiplatformV1PipelineTaskDetail: - description: The runtime detail of a task execution. + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance: type: object - id: GoogleCloudAiplatformV1PipelineTaskDetail + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance + description: Spec for question answering helpfulness instance. properties: - endTime: - description: Output only. Task end time. - readOnly: true - type: string - format: google-datetime - executorDetail: - description: Output only. The detailed execution info. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetail - state: + instruction: type: string - description: Output only. State of the task. - enumDescriptions: - - Unspecified. - - Specifies pending state for the task. - - Specifies task is being executed. - - Specifies task completed successfully. - - Specifies Task cancel is in pending state. - - Specifies task is being cancelled. - - Specifies task was cancelled. - - Specifies task failed. - - Specifies task was skipped due to cache hit. - - >- - Specifies that the task was not triggered because the task's - trigger policy is not satisfied. The trigger policy is specified - in the `condition` field of PipelineJob.pipeline_spec. - readOnly: true - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - CANCEL_PENDING - - CANCELLING - - CANCELLED - - FAILED - - SKIPPED - - NOT_TRIGGERED - outputs: - readOnly: true - type: object - description: Output only. The runtime output artifacts of the task. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - error: - description: >- - Output only. The error that occurred during task execution. Only - populated when the task's state is FAILED or CANCELLED. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - taskName: description: >- - Output only. The user specified name of the task that is defined in - pipeline_spec. + Required. The question asked and other instruction in the inference + prompt. + context: + description: Optional. Text provided as context to answer the question. type: string - readOnly: true - inputs: - readOnly: true - type: object - description: Output only. The runtime input artifacts of the task. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - taskId: + reference: type: string - format: int64 - readOnly: true - description: Output only. The system generated ID of the task. - parentTaskId: + description: Optional. Ground truth used to compare against the prediction. + prediction: type: string - format: int64 + description: Required. Output of the evaluated model. + GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF: + description: Parameters for RRF algorithm that combines search results. + id: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF + type: object + properties: + alpha: + type: number + format: float description: >- - Output only. The id of the parent task if the task is within a - component scope. Empty if the task is at the root level. - readOnly: true - startTime: - description: Output only. Task start time. - format: google-datetime - readOnly: true - type: string - execution: - description: Output only. The execution metadata of the task. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - readOnly: true - createTime: - description: Output only. Task create time. - type: string - readOnly: true - format: google-datetime - pipelineTaskStatus: + Required. Users can provide an alpha value to give more weight to + dense vs sparse results. For example, if the alpha is 0, we only + return sparse and if the alpha is 1, we only return dense. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + type: object + properties: + columnName: + type: string + GoogleCloudAiplatformV1IdMatcher: + type: object + description: Matcher for Features of an EntityType by Feature ID. + id: GoogleCloudAiplatformV1IdMatcher + properties: + ids: + description: >- + Required. The following are accepted as `ids`: * A single-element + list containing only `*`, which selects all Features in the target + EntityType, or * A list containing only Feature IDs, which selects + only Features with those IDs in the target EntityType. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus - readOnly: true + type: string type: array - description: >- - Output only. A list of task status. This field keeps a record of - task status evolving over time. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics: + GoogleCloudAiplatformV1PairwiseMetricInput: + id: GoogleCloudAiplatformV1PairwiseMetricInput + properties: + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInstance' + description: Required. Pairwise metric instance. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricSpec' + description: Required. Spec for pairwise metric. + type: object + description: Input for pairwise metric. + GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest: type: object + description: Request message for [NotebookService.CreateNotebookExecutionJob] properties: - precisionWindowLength: - format: google-duration + notebookExecutionJobId: + description: Optional. User specified ID for the NotebookExecutionJob. + type: string + parent: description: >- - This VideoActionMetrics is calculated based on this prediction - window length. If the predicted action's timestamp is inside the - time window whose center is the ground truth action's timestamp with - this specific length, the prediction result is treated as a true - positive. + Required. The resource name of the Location to create the + NotebookExecutionJob. Format: + `projects/{project}/locations/{location}` type: string - meanAveragePrecision: + notebookExecutionJob: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + description: Required. The NotebookExecutionJob to create. + id: GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest + GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata: + description: Runtime operation information for ModelService.UpdateExplanationDataset. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + id: GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata + type: object + GoogleCloudAiplatformV1ExportFractionSplit: + type: object + description: >- + Assigns the input data to training, validation, and test sets as per the + given fractions. Any of `training_fraction`, `validation_fraction` and + `test_fraction` may optionally be provided, they must sum to up to 1. If + the provided ones sum to less than 1, the remainder is assigned to sets + as decided by Vertex AI. If none of the fractions are set, by default + roughly 80% of data is used for training, 10% for validation, and 10% + for test. + id: GoogleCloudAiplatformV1ExportFractionSplit + properties: + validationFraction: type: number - description: The mean average precision. - format: float - confidenceMetrics: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - description: The Evaluation metrics given a specific precision_window_length. - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics - GoogleCloudAiplatformV1WriteTensorboardRunDataRequest: - properties: - tensorboardRun: + The fraction of the input data that is to be used to validate the + Model. + format: double + trainingFraction: + format: double + type: number description: >- - Required. The resource name of the TensorboardRun to write data to. - Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - type: string - timeSeriesData: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + The fraction of the input data that is to be used to train the + Model. + testFraction: + format: double + type: number description: >- - Required. The TensorboardTimeSeries data to write. Values with in a - time series are indexed by their step value. Repeated writes to the - same step will overwrite the existing value for that step. The upper - limit of data points per write request is 5000. - type: array - description: Request message for TensorboardService.WriteTensorboardRunData. - id: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest - type: object - GoogleCloudAiplatformV1NasJob: + The fraction of the input data that is to be used to evaluate the + Model. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics: + description: Metrics for general pairwise text generation evaluation results. properties: - createTime: - format: google-datetime - readOnly: true - description: Output only. Time when the NasJob was created. - type: string - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + cohensKappa: description: >- - Customer-managed encryption key options for a NasJob. If this is - set, then all resources created by the NasJob will be encrypted with - the provided encryption key. - startTime: - format: google-datetime + A measurement of agreement between the autorater and human raters + that takes the likelihood of random agreement into account. + type: number + format: float + humanPreferenceBaselineModelWinRate: description: >- - Output only. Time when the NasJob for the first time entered the - `JOB_STATE_RUNNING` state. - readOnly: true - type: string - error: + Percentage of time humans decided the baseline model had the better + response. + format: float + type: number + baselineModelWinRate: description: >- - Output only. Only populated when job's state is JOB_STATE_FAILED or - JOB_STATE_CANCELLED. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - satisfiesPzi: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - nasJobSpec: - description: Required. The specification of a NasJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobSpec' - satisfiesPzs: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - nasJobOutput: - description: Output only. Output of the NasJob. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobOutput' - displayName: + Percentage of time the autorater decided the baseline model had the + better response. + format: float + type: number + falsePositiveCount: + format: int64 type: string description: >- - Required. The display name of the NasJob. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - endTime: - format: google-datetime + Number of examples where the autorater chose the model, but humans + preferred the baseline model. + humanPreferenceModelWinRate: + type: number + description: Percentage of time humans decided the model had the better response. + format: float + modelWinRate: + format: float description: >- - Output only. Time when the NasJob entered any of the following - states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - type: string - readOnly: true - updateTime: + Percentage of time the autorater decided the model had the better + response. + type: number + accuracy: + format: float + type: number + description: Fraction of cases where the autorater agreed with the human raters. + trueNegativeCount: type: string - description: Output only. Time when the NasJob was most recently updated. - readOnly: true - format: google-datetime - enableRestrictedImageTraining: - type: boolean - deprecated: true + format: int64 description: >- - Optional. Enable a separation of Custom model training and - restricted image training for tenant project. - labels: + Number of examples where both the autorater and humans decided that + the model had the worse response. + f1Score: + format: float + description: Harmonic mean of precision and recall. + type: number + truePositiveCount: + format: int64 description: >- - The labels with user-defined metadata to organize NasJobs. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - type: object - additionalProperties: - type: string - name: - readOnly: true - description: Output only. Resource name of the NasJob. + Number of examples where both the autorater and humans decided that + the model had the better response. type: string - state: - description: Output only. The detailed state of the job. - readOnly: true - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. + precision: + type: number + format: float + description: >- + Fraction of cases where the autorater and humans thought the model + had a better response out of all cases where the autorater thought + the model had a better response. True positive divided by all + positive. + falseNegativeCount: type: string - id: GoogleCloudAiplatformV1NasJob - description: Represents a Neural Architecture Search (NAS) job. + format: int64 + description: >- + Number of examples where the autorater chose the baseline model, but + humans preferred the model. + recall: + format: float + type: number + description: >- + Fraction of cases where the autorater and humans thought the model + had a better response out of all cases where the humans thought the + model had a better response. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics + GoogleCloudAiplatformV1ResourceRuntimeSpec: + properties: + raySpec: + description: >- + Optional. Ray cluster configuration. Required when creating a + dedicated RayCluster on the PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RaySpec' + serviceAccountSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ServiceAccountSpec' + description: >- + Optional. Configure the use of workload identity on the + PersistentResource + type: object + id: GoogleCloudAiplatformV1ResourceRuntimeSpec + description: >- + Configuration for the runtime on a PersistentResource instance, + including but not limited to: * Service accounts used to run the + workloads. * Whether to make it a dedicated Ray Cluster. + GoogleCloudAiplatformV1ModelExplanation: + id: GoogleCloudAiplatformV1ModelExplanation + type: object + description: Aggregated explanation metrics for a Model over a set of instances. + properties: + meanAttributions: + type: array + readOnly: true + description: >- + Output only. Aggregated attributions explaining the Model's + prediction outputs over the set of instances. The attributions are + grouped by outputs. For Models that predict only one output, such as + regression Models that predict only one score, there is only one + attibution that explains the predicted output. For Models that + predict multiple outputs, such as multiclass Models that predict + multiple classes, each element explains one specific item. + Attribution.output_index can be used to identify which output this + attribution is explaining. The baselineOutputValue, + instanceOutputValue and featureAttributions fields are averaged over + the test data. NOTE: Currently AutoML tabular classification Models + produce only one attribution, which averages attributions over all + the classes it predicts. Attribution.approximation_error is not + populated. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation: description: >- Training pipeline will perform following transformation functions. * The value converted to float32. * The z_score of the value. * log(value+1) @@ -5891,6155 +5051,5616 @@ components: transformation is not applied and the value is considered a missing value. * z_score of log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. * A boolean value that indicates whether the - value is valid. + considered a missing value. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation properties: columnName: type: string - invalidValuesAllowed: - type: boolean - description: >- - If invalid values is allowed, the training pipeline will create a - boolean feature that indicated whether the value is valid. - Otherwise, the training pipeline will discard the input row from - trainining data. + GoogleCloudAiplatformV1ModelOriginalModelInfo: + id: GoogleCloudAiplatformV1ModelOriginalModelInfo + description: Contains information about the original Model if this Model is a copy. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation - GoogleCloudAiplatformV1SearchEntryPoint: - description: Google search entry point. properties: - sdkBlob: - type: string - description: Optional. Base64 encoded JSON representing array of tuple. - format: byte - renderedContent: + model: type: string + readOnly: true description: >- - Optional. Web content snippet that can be embedded in a web page or - an app webview. - id: GoogleCloudAiplatformV1SearchEntryPoint + Output only. The resource name of the Model this Model is a copy of, + including the revision. Format: + `projects/{project}/locations/{location}/models/{model_id}@{version_id}` + GoogleCloudAiplatformV1ProbeExecAction: + id: GoogleCloudAiplatformV1ProbeExecAction + description: ExecAction specifies a command to execute. type: object - GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec: properties: - useReference: - type: boolean + command: + items: + type: string + type: array description: >- - Optional. Whether to use instance.reference to compute pairwise - summarization quality. - version: - description: Optional. Which version to use for evaluation. - type: integer - format: int32 - id: GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec - type: object - description: Spec for pairwise summarization quality score metric. - GoogleCloudAiplatformV1SupervisedTuningSpec: - description: Tuning Spec for Supervised Tuning. + Command is the command line to execute inside the container, the + working directory for the command is root ('/') in the container's + filesystem. The command is simply exec'd, it is not run inside a + shell, so traditional shell instructions ('|', etc) won't work. To + use a shell, you need to explicitly call out to that shell. Exit + status of 0 is treated as live/healthy and non-zero is unhealthy. + GoogleCloudAiplatformV1GroundingChunkRetrievedContext: + id: GoogleCloudAiplatformV1GroundingChunkRetrievedContext type: object + description: Chunk from context retrieved by the retrieval tools. properties: - validationDatasetUri: + title: type: string - description: >- - Optional. Cloud Storage path to file containing validation dataset - for tuning. The dataset must be formatted as a JSONL file. - trainingDatasetUri: - description: >- - Required. Cloud Storage path to file containing training dataset for - tuning. The dataset must be formatted as a JSONL file. + description: Title of the attribution. + uri: type: string - hyperParameters: - description: Optional. Hyperparameters for SFT. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters - id: GoogleCloudAiplatformV1SupervisedTuningSpec - GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult: + description: URI reference of the attribution. + GoogleCloudAiplatformV1GroundingMetadata: + description: Metadata returned to client when grounding is enabled. + type: object properties: - bboxes: + searchEntryPoint: + description: Optional. Google search entry for the following-up web searches. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SearchEntryPoint' + webSearchQueries: + description: Optional. Web search queries for the following-up web search. items: - type: array - items: - type: any + type: string type: array - description: >- - Bounding boxes, i.e. the rectangles over the image, that pinpoint - the found AnnotationSpecs. Given in order that matches the IDs. Each - bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and - `yMax`, which represent the extremal coordinates of the box. They - are relative to the image size, and the point 0,0 is in the top left - of the image. - confidences: - items: - type: number - format: float - description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. + groundingChunks: type: array - displayNames: items: - type: string - type: array + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunk' description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. - ids: + List of supporting references retrieved from specified grounding + source. + groundingSupports: type: array - description: >- - The resource IDs of the AnnotationSpecs that had been identified, - ordered by the confidence score descendingly. + description: Optional. List of grounding support. items: - type: string - format: int64 - type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult - description: Prediction output format for Image Object Detection. - GoogleCloudAiplatformV1ListFeatureViewSyncsResponse: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingSupport' + id: GoogleCloudAiplatformV1GroundingMetadata + GoogleCloudAiplatformV1AddExecutionEventsRequest: + description: Request message for MetadataService.AddExecutionEvents. properties: - nextPageToken: - description: >- - A token, which can be sent as ListFeatureViewSyncsRequest.page_token - to retrieve the next page. If this field is omitted, there are no - subsequent pages. - type: string - featureViewSyncs: + events: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' - description: The FeatureViewSyncs matching the request. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' type: array + description: The Events to create and add. type: object - description: >- - Response message for - FeatureOnlineStoreAdminService.ListFeatureViewSyncs. - id: GoogleCloudAiplatformV1ListFeatureViewSyncsResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs + id: GoogleCloudAiplatformV1AddExecutionEventsRequest + GoogleCloudAiplatformV1AvroSource: + type: object + id: GoogleCloudAiplatformV1AvroSource properties: - baseModelId: - description: >- - The ID of the `base` model. If it is specified, the new model will - be trained based on the `base` model. Otherwise, the new model will - be trained from scratch. The `base` model must be in the same - Project and Location as the new Model to train, and have the same - modelType. - type: string - modelType: - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD_HIGH_ACCURACY_1 - - CLOUD_LOW_ACCURACY_1 - - MOBILE_TF_LOW_LATENCY_1 - type: string - enumDescriptions: - - Should not be set. - - >- - A model to be used via prediction calls to uCAIP API. Expected to - have a higher latency, but should also have a higher prediction - quality than other models. - - >- - A model to be used via prediction calls to uCAIP API. Expected to - have a lower latency but relatively lower prediction quality. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - model and used on a mobile or edge device afterwards. Expected to - have low latency, but may have lower prediction quality than other - mobile models. - budgetMilliNodeHours: - description: >- - The training budget of creating this model, expressed in milli node - hours i.e. 1,000 value in this field means 1 node hour. The actual - metadata.costMilliNodeHours will be equal or less than this value. - If further model training ceases to provide any improvements, it - will stop without using the full budget and the - metadata.successfulStopReason will be `model-converged`. Note, - node_hour = actual_hour * number_of_nodes_involved. Or - actual_wall_clock_hours = train_budget_milli_node_hours / - (number_of_nodes_involved * 1000) For modelType - `cloud-high-accuracy-1`(default), the budget must be between 20,000 - and 2,000,000 milli node hours, inclusive. The default value is - 192,000 which represents one day in wall time (1000 milli * 24 hours - * 8 nodes). - type: string - format: int64 - type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult: - type: object - description: Prediction output format for Video Classification. - properties: - displayName: - type: string - description: The display name of the AnnotationSpec that had been identified. - type: - type: string - description: >- - The type of the prediction. The requested types can be configured - via parameters. This will be one of - segment-classification - - shot-classification - one-sec-interval-classification - id: - description: The resource ID of the AnnotationSpec that had been identified. - type: string - timeSegmentStart: - description: >- - The beginning, inclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. Note that - for 'segment-classification' prediction type, this equals the - original 'timeSegmentStart' from the input instance, for other types - it is the start of a shot or a 1 second interval respectively. - format: google-duration - type: string - confidence: - format: float - description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. - type: number - timeSegmentEnd: - format: google-duration - type: string - description: >- - The end, exclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. Note that - for 'segment-classification' prediction type, this equals the - original 'timeSegmentEnd' from the input instance, for other types - it is the end of a shot or a 1 second interval respectively. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult - GoogleCloudAiplatformV1PairwiseSummarizationQualityInput: - description: Input for pairwise summarization quality metric. + gcsSource: + description: Required. Google Cloud Storage location. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: The storage details for Avro input content. + GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks: properties: - metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec - description: Required. Spec for pairwise summarization quality score metric. - instance: - description: Required. Pairwise summarization quality instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance - id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInput + notebooks: + description: Required. Regional resource references to notebooks. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + type: array + id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks + description: Open notebooks. type: object - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue: + GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata: properties: - floatValue: - type: number - description: Float type. - format: float - stringValue: - type: string - description: String type. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue - description: Single value that supports strings and floats. + sentimentMax: + description: The maximum sentiment of sentiment Anntoation in this SavedQuery. + type: integer + format: int32 + type: object + description: The metadata of SavedQuery contains TextSentiment Annotations. + id: GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata + GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: + id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata + description: Details of operations that perform create FeatureGroup. type: object - CloudAiLargeModelsVisionImageRAIScores: properties: - agileWatermarkDetectionScore: - description: Agile watermark score for image. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature. + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig: + properties: + value: type: number + description: >- + Specify a threshold value that can trigger the alert. 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. Each feature + must have a non-zero threshold if they need to be monitored. + Otherwise no alert will be triggered for that feature. format: double + description: The config for Featurestore Monitoring threshold. type: object - description: RAI scores for generated image returned. - id: CloudAiLargeModelsVisionImageRAIScores - GoogleRpcStatus: - id: GoogleRpcStatus - type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + GoogleCloudAiplatformV1IndexDatapoint: + id: GoogleCloudAiplatformV1IndexDatapoint properties: - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - details: + crowdingTag: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Optional. CrowdingTag of the datapoint, the number of neighbors to + return in each crowding can be configured during query. + featureVector: type: array + description: >- + Required. Feature embedding vector for dense index. An array of + numbers with the length of [NearestNeighborSearchConfig.dimensions]. items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - GoogleCloudAiplatformV1ExplanationMetadataOverride: - properties: - inputs: + type: number + format: float + sparseEmbedding: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + description: Optional. Feature embedding vector for sparse index. + restricts: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction description: >- - Required. Overrides the input metadata of the features. The key is - the name of the feature to be overridden. The keys specified here - must exist in the input metadata to be overridden. If a feature is - not specified here, the corresponding feature's input metadata is - not overridden. - additionalProperties: + Optional. List of Restrict of the datapoint, used to perform + "restricted searches" where boolean rule are used to filter the + subset of the database eligible for matching. This uses categorical + tokens. See: + https://cloud.google.com/vertex-ai/docs/matching-engine/filtering + type: array + numericRestricts: + type: array + items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride - type: object - id: GoogleCloudAiplatformV1ExplanationMetadataOverride + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction + description: >- + Optional. List of Restrict of the datapoint, used to perform + "restricted searches" where boolean rule are used to filter the + subset of the database eligible for matching. This uses numeric + comparisons. + datapointId: + description: Required. Unique identifier of the datapoint. + type: string + description: A datapoint of Index. type: object - description: >- - The ExplanationMetadata entries that can be overridden at online - explanation time. - GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries: + GoogleCloudAiplatformV1ListNasTrialDetailsResponse: + id: GoogleCloudAiplatformV1ListNasTrialDetailsResponse type: object - id: GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries + description: Response message for JobService.ListNasTrialDetails properties: - timestampColumn: + nasTrialDetails: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + description: List of top NasTrials in the requested page. + nextPageToken: description: >- - Optional. Column hosting timestamp values for a time-series source. - Will be used to determine the latest `feature_values` for each - entity. Optional. If not provided, column named `feature_timestamp` - of type `TIMESTAMP` will be used. + A token to retrieve the next page of results. Pass to + ListNasTrialDetailsRequest.page_token to obtain that page. type: string - GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable: + GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance: + description: Spec for pairwise summarization quality instance. properties: - requestResponseLoggingSchemaVersion: + prediction: + description: Required. Output of the candidate model. + type: string + instruction: + type: string + description: Required. Summarization prompt for LLM. + context: + description: Required. Text to be summarized. + type: string + baselinePrediction: + type: string + description: Required. Output of the baseline model. + reference: + type: string + description: Optional. Ground truth used to compare against the prediction. + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance + type: object + GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance: + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance + description: Prediction input format for Image Segmentation. + properties: + mimeType: + type: string description: >- - Output only. The schema version of the request/response logging - BigQuery table. Default to v1 if unset. - readOnly: true + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/png + content: + description: The image bytes to make the predictions on. type: string - bigqueryTablePath: + GoogleCloudAiplatformV1FeatureViewSyncSyncSummary: + id: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary + properties: + rowSynced: + readOnly: true type: string + format: int64 + description: Output only. Total number of rows synced. + systemWatermarkTime: description: >- - The created BigQuery table to store logs. Customer could do their - own query & analysis. Format: `bq://.model_deployment_monitoring_._` - logType: - enum: - - LOG_TYPE_UNSPECIFIED - - PREDICT - - EXPLAIN - description: The type of log. + Lower bound of the system time watermark for the sync job. This is + only set for continuously syncing feature views. + format: google-datetime type: string - enumDescriptions: - - Unspecified type. - - Predict logs. - - Explain logs. - logSource: - enumDescriptions: - - Unspecified source. - - Logs coming from Training dataset. - - Logs coming from Serving traffic. + totalSlot: type: string - description: The source of log. - enum: - - LOG_SOURCE_UNSPECIFIED - - TRAINING - - SERVING - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable + format: int64 + description: Output only. BigQuery slot milliseconds consumed for the sync job. + readOnly: true type: object description: >- - ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name - as well as some information of the logs stored in this table. - GoogleCloudAiplatformV1BlurBaselineConfig: - description: >- - Config for blur baseline. When enabled, a linear path from the maximally - blurred image to the input image is created. Using a blurred baseline - instead of zero (black image) is motivated by the BlurIG approach - explained here: https://arxiv.org/abs/2004.03383 - type: object + Summary from the Sync job. For continuous syncs, the summary is updated + periodically. For batch syncs, it gets updated on completion of the + sync. + GoogleCloudAiplatformV1ModelMonitoringAlertConfig: + description: The alert config for model monitoring. properties: - maxBlurSigma: + enableLogging: + type: boolean description: >- - The standard deviation of the blur kernel for the blurred baseline. - The same blurring parameter is used for both the height and the - width dimension. If not set, the method defaults to the zero (i.e. - black for images) baseline. - type: number - format: float - id: GoogleCloudAiplatformV1BlurBaselineConfig - GoogleCloudAiplatformV1ReadFeatureValuesResponse: - id: GoogleCloudAiplatformV1ReadFeatureValuesResponse + Dump the anomalies to Cloud Logging. The anomalies will be put to + json payload encoded from proto + google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. + This can be further sinked to Pub/Sub or any other services + supported by Cloud Logging. + emailAlertConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + description: Email alert config. + notificationChannels: + items: + type: string + description: >- + Resource names of the NotificationChannels to send alert. Must be of + the format `projects//notificationChannels/` + type: array + id: GoogleCloudAiplatformV1ModelMonitoringAlertConfig + type: object + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput: type: object + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput properties: - header: + metricSpec: + description: Required. Spec for pairwise question answering quality score metric. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader - description: Response header. - entityView: + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec + instance: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView - description: >- - Entity view with Feature values. This may be the entity in the - Featurestore if values for all Features were requested, or a - projection of the entity in the Featurestore if values for only some - Features were requested. - description: Response message for FeaturestoreOnlineServingService.ReadFeatureValues. - GoogleCloudAiplatformV1ImportModelEvaluationRequest: - id: GoogleCloudAiplatformV1ImportModelEvaluationRequest + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance + description: Required. Pairwise question answering quality instance. + description: Input for pairwise question answering quality metric. + GoogleCloudAiplatformV1GenerationConfigRoutingConfig: + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfig + type: object properties: - modelEvaluation: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' - description: Required. Model evaluation resource to be imported. + manualMode: + description: Manual routing. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode + autoMode: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode + description: Automated routing. + description: The configuration for routing the request to a specific model. + GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: type: object - description: Request message for ModelService.ImportModelEvaluation - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation: - description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. properties: - columnName: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata + description: Runtime operation information for CreateDeploymentResourcePool method. + GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors: + properties: + id: type: string + description: The ID of the query datapoint. + neighbors: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNeighbor + type: array + description: All its neighbors. + id: GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation - GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: + description: Nearest neighbors for one query. + GoogleCloudLocationLocation: + description: A resource that represents a Google Cloud location. properties: - modelName: + labels: + additionalProperties: + type: string + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + name: type: string description: >- - The model name to use. Only the public LLM models are accepted. e.g. - 'gemini-1.5-pro-001'. - id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + metadata: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + displayName: + type: string + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". type: object - description: When manual routing is set, the specified model will be used directly. - GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies: + id: GoogleCloudLocationLocation + GoogleCloudAiplatformV1RemoveDatapointsResponse: + properties: {} + type: object + description: Response message for IndexService.RemoveDatapoints + id: GoogleCloudAiplatformV1RemoveDatapointsResponse + GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse: + id: GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse + type: object + description: Response message for JobService.ListHyperparameterTuningJobs properties: - featureStats: + hyperparameterTuningJobs: + type: array + description: >- + List of HyperparameterTuningJobs in the requested page. + HyperparameterTuningJob.trials of the jobs will be not be returned. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies - description: A list of historical Stats and Anomalies generated for all Features. - type: array - objective: + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListHyperparameterTuningJobsRequest.page_token to obtain that page. type: string - description: Model Monitoring Objective those stats and anomalies belonging to. - enumDescriptions: - - Default value, should not be set. - - >- - Raw feature values' stats to detect skew between - Training-Prediction datasets. - - >- - Raw feature values' stats to detect drift between - Serving-Prediction datasets. - - >- - Feature attribution scores to detect skew between - Training-Prediction datasets. - - >- - Feature attribution scores to detect skew between Prediction - datasets collected within different time windows. - enum: - - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED - - RAW_FEATURE_SKEW - - RAW_FEATURE_DRIFT - - FEATURE_ATTRIBUTION_SKEW - - FEATURE_ATTRIBUTION_DRIFT - deployedModelId: + GoogleCloudAiplatformV1ListModelsResponse: + description: Response message for ModelService.ListModels + type: object + properties: + models: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + description: List of Models in the requested page. + nextPageToken: + description: >- + A token to retrieve next page of results. Pass to + ListModelsRequest.page_token to obtain that page. type: string - description: Deployed Model ID. - anomalyCount: - format: int32 - description: Number of anomalies within all stats. - type: integer - description: Statistics and anomalies generated by Model Monitoring. - id: GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies + id: GoogleCloudAiplatformV1ListModelsResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation: type: object - GoogleCloudAiplatformV1BleuSpec: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation properties: - useEffectiveOrder: - type: boolean - description: Optional. Whether to use_effective_order to compute bleu score. + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation + GoogleCloudAiplatformV1TFRecordDestination: + id: GoogleCloudAiplatformV1TFRecordDestination + description: The storage details for TFRecord output content. + properties: + gcsDestination: + description: Required. Google Cloud Storage location. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' type: object - id: GoogleCloudAiplatformV1BleuSpec - description: >- - Spec for bleu score metric - calculates the precision of n-grams in the - prediction as compared to reference - returns a score ranging between 0 - to 1. - GoogleCloudAiplatformV1CancelPipelineJobRequest: + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource: + properties: + uri: + description: The URI of a BigQuery table. + type: string + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource type: object - description: Request message for PipelineService.CancelPipelineJob. - properties: {} - id: GoogleCloudAiplatformV1CancelPipelineJobRequest - GoogleCloudAiplatformV1RougeResults: - description: Results for rouge metric. + GoogleCloudAiplatformV1SampleConfig: + description: >- + Active learning data sampling config. For every active learning labeling + iteration, it will select a batch of data based on the sampling + strategy. + id: GoogleCloudAiplatformV1SampleConfig type: object - id: GoogleCloudAiplatformV1RougeResults - properties: - rougeMetricValues: - readOnly: true - description: Output only. Rouge metric values. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeMetricValue' - type: array - GoogleCloudAiplatformV1NotebookEucConfig: - description: The euc configuration of NotebookRuntimeTemplate. - id: GoogleCloudAiplatformV1NotebookEucConfig properties: - eucDisabled: - type: boolean + followingBatchSamplePercentage: description: >- - Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. - In proto3, the default value of a boolean is false. In this way, by - default EUC will be enabled for NotebookRuntimeTemplate. - bypassActasCheck: - type: boolean + The percentage of data needed to be labeled in each following batch + (except the first batch). + format: int32 + type: integer + initialBatchSamplePercentage: + description: The percentage of data needed to be labeled in the first batch. + format: int32 + type: integer + sampleStrategy: + type: string description: >- - Output only. Whether ActAs check is bypassed for service account - attached to the VM. If false, we need ActAs check for the default - Compute Engine Service account. When a Runtime is created, a VM is - allocated using Default Compute Engine Service Account. Any user - requesting to use this Runtime requires Service Account User (ActAs) - permission over this SA. If true, Runtime owner is using EUC and - does not require the above permission as VM no longer use default - Compute Engine SA, but a P4SA. - readOnly: true + Field to choose sampling strategy. Sampling strategy will decide + which data should be selected for human labeling in every batch. + enum: + - SAMPLE_STRATEGY_UNSPECIFIED + - UNCERTAINTY + enumDescriptions: + - Default will be treated as UNCERTAINTY. + - Sample the most uncertain data to label. + GoogleCloudAiplatformV1PurgeContextsMetadata: + description: Details of operations that perform MetadataService.PurgeContexts. type: object - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for purging Contexts. + id: GoogleCloudAiplatformV1PurgeContextsMetadata + GoogleIamV1SetIamPolicyRequest: type: object + description: Request message for `SetIamPolicy` method. properties: - value: - format: double + policy: description: >- - Specify a threshold value that can trigger the alert. 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. Each feature - must have a non-zero threshold if they need to be monitored. - Otherwise no alert will be triggered for that feature. - type: number - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig - description: The config for Featurestore Monitoring threshold. - GoogleCloudAiplatformV1SchemaVertex: - id: GoogleCloudAiplatformV1SchemaVertex - description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/GoogleIamV1Policy' + id: GoogleIamV1SetIamPolicyRequest + GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: type: object properties: - x: - type: number - description: X coordinate. - format: double - 'y': - type: number - format: double - description: Y coordinate. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation: - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureView Update. + id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata + description: Details of operations that perform update FeatureView. + GoogleLongrunningListOperationsResponse: properties: - timeFormat: + nextPageToken: type: string + description: The standard List next-page token. + operations: + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) - columnName: - type: string + A list of operations that matches the specified filter in the + request. + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig: + GoogleCloudAiplatformV1SummarizationVerbositySpec: + description: Spec for summarization verbosity score metric. type: object - description: The config for Prediction data drift detection. - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig - properties: - defaultDriftThreshold: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - description: >- - Drift anomaly detection threshold used by all features. When the - per-feature thresholds are not set, this field can be used to - specify a threshold for all features. - driftThresholds: - description: >- - Key is the feature name and value is the threshold. If a feature - needs to be monitored for drift, a value threshold must be - configured for that feature. The threshold here is against feature - distribution distance between different time windws. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - type: object - attributionScoreDriftThresholds: - description: >- - Key is the feature name and value is the threshold. The threshold - here is against attribution score distance between different time - windows. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - type: object - GoogleCloudAiplatformV1NotebookRuntime: - description: >- - A runtime is a virtual machine allocated to a particular user for a - particular Notebook file on temporary basis with lifetime limited to 24 - hours. + id: GoogleCloudAiplatformV1SummarizationVerbositySpec properties: - notebookRuntimeType: - enum: - - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED - - USER_DEFINED - - ONE_CLICK - readOnly: true - enumDescriptions: - - >- - Unspecified notebook runtime type, NotebookRuntimeType will - default to USER_DEFINED. - - runtime or template with coustomized configurations from user. - - runtime or template with system defined configurations. - type: string - description: Output only. The type of the notebook runtime. - serviceAccount: - readOnly: true - description: >- - Output only. The service account that the NotebookRuntime workload - runs as. - type: string - name: - readOnly: true - description: Output only. The resource name of the NotebookRuntime. - type: string - displayName: - description: >- - Required. The display name of the NotebookRuntime. The name can be - up to 128 characters long and can consist of any UTF-8 characters. - type: string - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - runtimeState: - enumDescriptions: - - Unspecified runtime state. - - NotebookRuntime is in running state. - - NotebookRuntime is in starting state. - - NotebookRuntime is in stopping state. - - NotebookRuntime is in stopped state. - - >- - NotebookRuntime is in upgrading state. It is in the middle of - upgrading process. - - NotebookRuntime was unable to start/stop properly. - - NotebookRuntime is in invalid state. Cannot be recovered. - description: Output only. The runtime (instance) state of the NotebookRuntime. - type: string - enum: - - RUNTIME_STATE_UNSPECIFIED - - RUNNING - - BEING_STARTED - - BEING_STOPPED - - STOPPED - - BEING_UPGRADED - - ERROR - - INVALID - readOnly: true - encryptionSpec: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Output only. Customer-managed encryption key spec for the notebook - runtime. - runtimeUser: - type: string - description: Required. The user email of the NotebookRuntime. - networkTags: - items: - type: string - type: array + useReference: description: >- - Optional. The Compute Engine tags to add to runtime (see [Tagging - instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). - isUpgradable: - readOnly: true - type: boolean - description: Output only. Whether NotebookRuntime is upgradable. - satisfiesPzs: + Optional. Whether to use instance.reference to compute summarization + verbosity. type: boolean - readOnly: true - description: Output only. Reserved for future use. - notebookRuntimeTemplateRef: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplateRef + version: + format: int32 + description: Optional. Which version to use for evaluation. + type: integer + GoogleCloudAiplatformV1ModelEvaluationSliceSlice: + properties: + dimension: description: >- - Output only. The pointer to NotebookRuntimeTemplate this - NotebookRuntime is created from. - createTime: - format: google-datetime - description: Output only. Timestamp when this NotebookRuntime was created. - type: string + Output only. The dimension of the slice. Well-known dimensions are: + * `annotationSpec`: This slice is on the test data that has either + ground truth or prediction with AnnotationSpec.display_name equals + to value. * `slice`: This slice is a user customized slice defined + by its SliceSpec. readOnly: true - expirationTime: - description: >- - Output only. Timestamp when this NotebookRuntime will be expired: 1. - System Predefined NotebookRuntime: 24 hours after creation. After - expiration, system predifined runtime will be deleted. 2. User - created NotebookRuntime: 6 months after last upgrade. After - expiration, user created runtime will be stopped and allowed for - upgrade. - format: google-datetime type: string - readOnly: true - version: - description: Output only. The VM os image version of NotebookRuntime. + value: type: string + description: Output only. The value of the dimension in this slice. readOnly: true - labels: - type: object - description: >- - The labels with user-defined metadata to organize your - NotebookRuntime. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. No more than 64 user labels can be associated with one - NotebookRuntime (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for NotebookRuntime: * - "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output - only, its value is the Compute Engine instance id. * - "aiplatform.googleapis.com/colab_enterprise_entry_service": its - value is either "bigquery" or "vertex"; if absent, it should be - "vertex". This is to describe the entry service, either BigQuery or - Vertex. - additionalProperties: - type: string - description: - description: The description of the NotebookRuntime. - type: string - idleShutdownConfig: + sliceSpec: + description: Output only. Specification for how the data was sliced. readOnly: true $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig - description: >- - Output only. The idle shutdown configuration of the notebook - runtime. - proxyUri: - description: Output only. The proxy endpoint used to access the NotebookRuntime. - type: string - readOnly: true - healthState: - enum: - - HEALTH_STATE_UNSPECIFIED - - HEALTHY - - UNHEALTHY - enumDescriptions: - - Unspecified health state. - - NotebookRuntime is in healthy state. Applies to ACTIVE state. - - NotebookRuntime is in unhealthy state. Applies to ACTIVE state. - readOnly: true - description: Output only. The health state of the NotebookRuntime. - type: string - updateTime: - format: google-datetime - readOnly: true - type: string - description: >- - Output only. Timestamp when this NotebookRuntime was most recently - updated. - id: GoogleCloudAiplatformV1NotebookRuntime + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec + description: Definition of a slice. type: object - GoogleCloudAiplatformV1BatchMigrateResourcesRequest: + id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice + GoogleCloudAiplatformV1MigratableResourceAutomlModel: + description: Represents one Model in automl.googleapis.com. properties: - migrateResourceRequests: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + model: + type: string description: >- - Required. The request messages specifying the resources to migrate. - They must be in the same location as the destination. Up to 50 - resources can be migrated in one batch. - type: array - type: object - id: GoogleCloudAiplatformV1BatchMigrateResourcesRequest - description: Request message for MigrationService.BatchMigrateResources. - GoogleCloudAiplatformV1ExportFeatureValuesResponse: - id: GoogleCloudAiplatformV1ExportFeatureValuesResponse - description: Response message for FeaturestoreService.ExportFeatureValues. - properties: {} - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification: - description: >- - A TrainingJob that trains and uploads an AutoML Text Classification - Model. + Full resource name of automl Model. Format: + `projects/{project}/locations/{location}/models/{model}`. + modelDisplayName: + description: The Model's display name in automl.googleapis.com. + type: string type: object - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs - description: The input parameters of this TrainingJob. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification + id: GoogleCloudAiplatformV1MigratableResourceAutomlModel GoogleCloudAiplatformV1SearchNearestEntitiesResponse: + type: object + id: GoogleCloudAiplatformV1SearchNearestEntitiesResponse + description: Response message for FeatureOnlineStoreService.SearchNearestEntities properties: nearestNeighbors: $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighbors' description: The nearest neighbors of the query entity. - id: GoogleCloudAiplatformV1SearchNearestEntitiesResponse - type: object - description: Response message for FeatureOnlineStoreService.SearchNearestEntities - GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata: + GoogleCloudAiplatformV1CopyModelOperationMetadata: type: object - description: Metadata information for NotebookService.UpgradeNotebookRuntime. - properties: - progressMessage: - type: string - description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata - GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata: - description: Runtime operation information for EndpointService.MutateDeployedModel. properties: genericMetadata: - description: The operation generic information. + description: The common part of the operation metadata. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1CopyModelOperationMetadata + description: Details of ModelService.CopyModel operation. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs: type: object - id: GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata - GoogleCloudAiplatformV1CreateTensorboardOperationMetadata: - type: object - description: Details of operations that perform create Tensorboard. - id: GoogleCloudAiplatformV1CreateTensorboardOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Tensorboard. - GoogleCloudAiplatformV1AutoscalingMetricSpec: - description: >- - The metric specification that defines the target resource utilization - (CPU utilization, accelerator's duty cycle, and so on) for calculating - the desired replica count. - id: GoogleCloudAiplatformV1AutoscalingMetricSpec properties: - metricName: - type: string - description: >- - Required. The resource metric name. Supported metrics: * For Online - Prediction: * - `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` - * `aiplatform.googleapis.com/prediction/online/cpu/utilization` - target: - type: integer - description: >- - The target resource utilization in percentage (1% - 100%) for the - given metric; once the real usage deviates from the target by a - certain percentage, the machine replicas change. The default value - is 60 (representing 60%) if not provided. - format: int32 - type: object - GoogleCloudAiplatformV1CountTokensRequest: - type: object - id: GoogleCloudAiplatformV1CountTokensRequest - description: Request message for PredictionService.CountTokens. - properties: - contents: - description: Optional. Input content. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - tools: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' - description: >- - Optional. A list of `Tools` the model may use to generate the next - response. A `Tool` is a piece of code that enables the system to - interact with external systems to perform an action, or set of - actions, outside of knowledge and scope of the model. - systemInstruction: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: >- - Optional. The user provided system instructions for the model. Note: - only text should be used in parts and content in each part will be - in a separate paragraph. - model: - type: string - description: >- - Optional. The name of the publisher model requested to serve the - prediction. Format: - `projects/{project}/locations/{location}/publishers/*/models/*` - instances: - description: >- - Optional. The instances that are the input to token counting call. - Schema is identical to the prediction schema of the underlying - model. - items: - type: any - type: array - GoogleCloudAiplatformV1IndexStats: - properties: - vectorsCount: - format: int64 - description: Output only. The number of dense vectors in the Index. - type: string - readOnly: true - sparseVectorsCount: - format: int64 - readOnly: true - type: string - description: Output only. The number of sparse vectors in the Index. - shardsCount: - format: int32 - description: Output only. The number of shards in the Index. - type: integer - readOnly: true - description: Stats of the Index. - id: GoogleCloudAiplatformV1IndexStats - type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame: - description: >- - The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box, - i.e. the rectangle over the video frame pinpointing the found - AnnotationSpec. The coordinates are relative to the frame size, and the - point 0,0 is in the top left of the frame. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame - properties: - yMin: - description: The topmost coordinate of the bounding box. - type: number - format: float - yMax: - format: float - type: number - description: The bottommost coordinate of the bounding box. - xMax: - description: The rightmost coordinate of the bounding box. - format: float - type: number - xMin: - format: float - type: number - description: The leftmost coordinate of the bounding box. - timeOffset: - description: >- - A time (frame) of a video in which the object has been detected. - Expressed as a number of seconds as measured from the start of the - video, with fractions up to a microsecond precision, and with "s" - appended at the end. - format: google-duration - type: string - type: object - GoogleCloudAiplatformV1TensorboardTimeSeries: - type: object - id: GoogleCloudAiplatformV1TensorboardTimeSeries - properties: - description: - description: Description of this TensorboardTimeSeries. - type: string - createTime: - type: string - format: google-datetime - description: Output only. Timestamp when this TensorboardTimeSeries was created. - readOnly: true - pluginName: - description: >- - Immutable. Name of the plugin this time series pertain to. Such as - Scalar, Tensor, Blob - type: string - pluginData: - format: byte - description: Data of the current plugin, with the size limited to 65KB. - type: string - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata - description: >- - Output only. Scalar, Tensor, or Blob metadata for this - TensorboardTimeSeries. - readOnly: true - updateTime: - description: >- - Output only. Timestamp when this TensorboardTimeSeries was last - updated. - format: google-datetime - readOnly: true - type: string - name: - description: Output only. Name of the TensorboardTimeSeries. - readOnly: true - type: string - valueType: - description: Required. Immutable. Type of TensorboardTimeSeries value. - type: string - enum: - - VALUE_TYPE_UNSPECIFIED - - SCALAR - - TENSOR - - BLOB_SEQUENCE + modelType: enumDescriptions: - - The value type is unspecified. + - Should not be set. - >- - Used for TensorboardTimeSeries that is a list of scalars. E.g. - accuracy of a model over epochs/time. + A model to be used via prediction calls to uCAIP API. Expected to + have a higher latency, but should also have a higher prediction + quality than other models. - >- - Used for TensorboardTimeSeries that is a list of tensors. E.g. - histograms of weights of layer in a model over epoch/time. + A model to be used via prediction calls to uCAIP API. Expected to + have a lower latency but relatively lower prediction quality. - >- - Used for TensorboardTimeSeries that is a list of blob sequences. - E.g. set of sample images with labels over epochs/time. - etag: - description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + model and used on a mobile or edge device afterwards. Expected to + have low latency, but may have lower prediction quality than other + mobile models. + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD_HIGH_ACCURACY_1 + - CLOUD_LOW_ACCURACY_1 + - MOBILE_TF_LOW_LATENCY_1 type: string - displayName: + budgetMilliNodeHours: + format: int64 type: string description: >- - Required. User provided name of this TensorboardTimeSeries. This - value should be unique among all TensorboardTimeSeries resources - belonging to the same TensorboardRun resource (parent resource). - description: TensorboardTimeSeries maps to times series produced in training runs - GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec: - type: object - id: GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec - properties: - useElapsedDuration: - type: boolean + The training budget of creating this model, expressed in milli node + hours i.e. 1,000 value in this field means 1 node hour. The actual + metadata.costMilliNodeHours will be equal or less than this value. + If further model training ceases to provide any improvements, it + will stop without using the full budget and the + metadata.successfulStopReason will be `model-converged`. Note, + node_hour = actual_hour * number_of_nodes_involved. Or + actual_wall_clock_hours = train_budget_milli_node_hours / + (number_of_nodes_involved * 1000) For modelType + `cloud-high-accuracy-1`(default), the budget must be between 20,000 + and 2,000,000 milli node hours, inclusive. The default value is + 192,000 which represents one day in wall time (1000 milli * 24 hours + * 8 nodes). + baseModelId: + type: string description: >- - True if Measurement.elapsed_duration is used as the x-axis of each - Trials Decay Curve. Otherwise, Measurement.step_count will be used - as the x-axis. - description: >- - The decay curve automated stopping rule builds a Gaussian Process - Regressor to predict the final objective value of a Trial based on the - already completed Trials and the intermediate measurements of the - current Trial. Early stopping is requested for the current Trial if - there is very low probability to exceed the optimal value found so far. - GoogleCloudAiplatformV1CoherenceInput: + The ID of the `base` model. If it is specified, the new model will + be trained based on the `base` model. Otherwise, the new model will + be trained from scratch. The `base` model must be in the same + Project and Location as the new Model to train, and have the same + modelType. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs + GoogleCloudAiplatformV1PointwiseMetricInput: + description: Input for pointwise metric. + id: GoogleCloudAiplatformV1PointwiseMetricInput type: object - description: Input for coherence metric. - id: GoogleCloudAiplatformV1CoherenceInput properties: instance: - description: Required. Coherence instance. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInstance' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInstance' + description: Required. Pointwise metric instance. metricSpec: - description: Required. Spec for coherence score metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceSpec' - GoogleCloudAiplatformV1Study: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricSpec' + description: Required. Spec for pointwise metric. + GoogleCloudAiplatformV1SummarizationVerbosityInstance: + id: GoogleCloudAiplatformV1SummarizationVerbosityInstance + description: Spec for summarization verbosity instance. + type: object properties: - name: - type: string - description: >- - Output only. The name of a study. The study's globally unique - identifier. Format: - `projects/{project}/locations/{location}/studies/{study}` - readOnly: true - displayName: + context: + description: Required. Text to be summarized. type: string - description: Required. Describes the Study, default value is empty string. - createTime: - format: google-datetime - description: Output only. Time at which the study was created. + reference: + description: Optional. Ground truth used to compare against the prediction. type: string - readOnly: true - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - description: Required. Configuration of the Study. - state: - enumDescriptions: - - The study state is unspecified. - - The study is active. - - The study is stopped due to an internal error. - - >- - The study is done when the service exhausts the parameter search - space or max_trial_count is reached. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - INACTIVE - - COMPLETED + prediction: type: string - description: Output only. The detailed state of a Study. - readOnly: true - inactiveReason: + description: Required. Output of the evaluated model. + instruction: type: string - description: >- - Output only. A human readable reason why the Study is inactive. This - should be empty if a study is ACTIVE or COMPLETED. - readOnly: true - type: object - id: GoogleCloudAiplatformV1Study - description: A message representing a Study. + description: Optional. Summarization prompt for LLM. GoogleCloudAiplatformV1CitationMetadata: id: GoogleCloudAiplatformV1CitationMetadata - type: object description: A collection of source attributions for a piece of content. properties: citations: - description: Output only. List of citations. - type: array + readOnly: true items: $ref: '#/components/schemas/GoogleCloudAiplatformV1Citation' - readOnly: true - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: - description: >- - This message will be placed in the metadata field of a - google.longrunning.Operation associated with a - CheckTrialEarlyStoppingState request. + type: array + description: Output only. List of citations. + type: object + GoogleCloudAiplatformV1UndeployModelOperationMetadata: + type: object + description: Runtime operation information for EndpointService.UndeployModel. properties: - study: - description: The name of the Study that the Trial belongs to. - type: string - trial: - type: string - description: The Trial name. genericMetadata: - description: Operation metadata for suggesting Trials. + description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata - type: object - GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance: + id: GoogleCloudAiplatformV1UndeployModelOperationMetadata + GoogleCloudAiplatformV1SchemaTextExtractionAnnotation: + description: Annotation details specific to text extraction. properties: - timeSegmentStart: + annotationSpecId: description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. + The resource Id of the AnnotationSpec that this Annotation pertains + to. type: string - mimeType: + displayName: type: string description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime - timeSegmentEnd: - description: >- - The end, exclusive, of the video's time segment on which to perform - the prediction. Expressed as a number of seconds as measured from - the start of the video, with "s" appended at the end. Fractions are - allowed, up to a microsecond precision, and "inf" or "Infinity" is - allowed, which means the end of the video. + The display name of the AnnotationSpec that this Annotation pertains + to. + textSegment: + description: The segment of the text content. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTextSegment' + id: GoogleCloudAiplatformV1SchemaTextExtractionAnnotation + type: object + GoogleCloudAiplatformV1GroundingChunkWeb: + properties: + title: type: string - content: + description: Title of the chunk. + uri: + description: URI reference of the chunk. type: string - description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance - description: Prediction input format for Video Action Recognition. type: object - GoogleCloudAiplatformV1PipelineJob: + description: Chunk from the web. + id: GoogleCloudAiplatformV1GroundingChunkWeb + GoogleIamV1Policy: type: object - description: An instance of a machine learning PipelineJob. - id: GoogleCloudAiplatformV1PipelineJob properties: - runtimeConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfig' - description: Runtime config of the pipeline. - labels: - type: object - description: >- - The labels with user-defined metadata to organize PipelineJob. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - Note there is some reserved label key for Vertex AI Pipelines. - - `vertex-ai-pipelines-run-billing-id`, user set value will get - overrided. - additionalProperties: - type: string - templateUri: - type: string - description: >- - A template uri from where the PipelineJob.pipeline_spec, if empty, - will be downloaded. Currently, only uri from Vertex Template - Registry & Gallery is supported. Reference to - https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. - state: - readOnly: true - enum: - - PIPELINE_STATE_UNSPECIFIED - - PIPELINE_STATE_QUEUED - - PIPELINE_STATE_PENDING - - PIPELINE_STATE_RUNNING - - PIPELINE_STATE_SUCCEEDED - - PIPELINE_STATE_FAILED - - PIPELINE_STATE_CANCELLING - - PIPELINE_STATE_CANCELLED - - PIPELINE_STATE_PAUSED - description: Output only. The detailed state of the job. - type: string - enumDescriptions: - - The pipeline state is unspecified. - - >- - The pipeline has been created or resumed, and processing has not - yet begun. - - The service is preparing to run the pipeline. - - The pipeline is in progress. - - The pipeline completed successfully. - - The pipeline failed. - - >- - The pipeline is being cancelled. From this state, the pipeline may - only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED - or PIPELINE_STATE_CANCELLED. - - The pipeline has been cancelled. - - The pipeline has been stopped, and can be resumed. - name: - readOnly: true - type: string - description: Output only. The resource name of the PipelineJob. - displayName: - description: >- - The display name of the Pipeline. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - type: string - encryptionSpec: - description: >- - Customer-managed encryption key spec for a pipelineJob. If set, this - PipelineJob and all of its sub-resources will be secured by this - key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - updateTime: - description: >- - Output only. Timestamp when this PipelineJob was most recently - updated. - readOnly: true - type: string - format: google-datetime - startTime: - description: Output only. Pipeline start time. - type: string - readOnly: true - format: google-datetime - createTime: - description: Output only. Pipeline creation time. - readOnly: true - format: google-datetime - type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. The error that occurred during pipeline execution. Only - populated when the pipeline's state is FAILED or CANCELLED. - readOnly: true - templateMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTemplateMetadata' - description: >- - Output only. Pipeline template metadata. Will fill up fields if - PipelineJob.template_uri is from supported template registry. - readOnly: true - network: + etag: type: string + format: byte description: >- - The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to which - the Pipeline Job's workload should be peered. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - Private services access must already be configured for the network. - Pipeline job will apply the network configuration to the Google - Cloud resources being launched, if applied, such as Vertex AI - Training or Dataflow job. If left unspecified, the workload is not - peered with any network. - reservedIpRanges: + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + bindings: type: array - description: >- - A list of names for the reserved ip ranges under the VPC network - that can be used for this Pipeline Job's workload. If set, we will - deploy the Pipeline Job's workload within the provided ip ranges. - Otherwise, the job will be deployed to any ip ranges under the - provided VPC network. Example: ['vertex-ai-ip-range']. items: - type: string - pipelineSpec: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: The spec of the pipeline. - preflightValidations: - type: boolean + $ref: '#/components/schemas/GoogleIamV1Binding' description: >- - Optional. Whether to do component level validations before job - creation. - serviceAccount: - type: string + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + version: + format: int32 description: >- - The service account that the pipeline workload runs as. If not - specified, the Compute Engine default service account in the project - will be used. See - https://cloud.google.com/compute/docs/access/service-accounts#default_service_account - Users starting the pipeline must have the - `iam.serviceAccounts.actAs` permission on this service account. - scheduleName: - readOnly: true - type: string - description: >- - Output only. The schedule resource name. Only returned if the - Pipeline is created by Schedule API. - jobDetail: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobDetail' - description: >- - Output only. The details of pipeline run. Not available in the list - view. - endTime: - format: google-datetime - description: Output only. Pipeline end time. - type: string - readOnly: true - GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField: - description: Describe pass-through fields in read_instance source. - type: object - properties: - fieldName: - description: >- - Required. The name of the field in the CSV header or the name of the - column in BigQuery table. The naming restriction is the same as - Feature.name. - type: string - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField - GoogleCloudAiplatformV1DeployModelResponse: - description: Response message for EndpointService.DeployModel. - id: GoogleCloudAiplatformV1DeployModelResponse - properties: - deployedModel: - description: The DeployedModel that had been deployed in the Endpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - type: object - GoogleCloudAiplatformV1ToolCallValidMetricValue: + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + id: GoogleIamV1Policy + CloudAiLargeModelsVisionNamedBoundingBox: + id: CloudAiLargeModelsVisionNamedBoundingBox type: object - description: Tool call valid metric value for an instance. - id: GoogleCloudAiplatformV1ToolCallValidMetricValue properties: - score: - readOnly: true + y1: + type: number format: float - description: Output only. Tool call valid score. + classes: + type: array + items: + type: string + entities: + items: + type: string + type: array + y2: type: number - CloudAiLargeModelsVisionSemanticFilterResponse: - properties: - namedBoundingBoxes: + format: float + x2: + type: number + format: float + x1: + format: float + type: number + scores: type: array items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' + format: float + type: number + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata: + description: The metadata of Datasets that contain time series data. + properties: + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig + timeColumn: description: >- - Class labels of the bounding boxes that failed the semantic - filtering. Bounding box coordinates. - passedSemanticFilter: + The column name of the time column that identifies time order in the + time series. + type: string + timeSeriesIdentifierColumn: + type: string description: >- - This response is added when semantic filter config is turned on in - EditConfig. It reports if this image is passed semantic filter - response. If passed_semantic_filter is false, the bounding box - information will be populated for user to check what caused the - semantic filter to fail. - type: boolean - id: CloudAiLargeModelsVisionSemanticFilterResponse + The column name of the time series identifier column that identifies + the time series. + type: object + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata + GoogleCloudAiplatformV1ReservationAffinity: type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation: description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. + A ReservationAffinity can be used to configure a Vertex AI resource + (e.g., a DeployedModel) to draw its Compute Engine resources from a + Shared Reservation, or exclusively from on-demand capacity. + id: GoogleCloudAiplatformV1ReservationAffinity properties: - columnName: + reservationAffinityType: + enum: + - TYPE_UNSPECIFIED + - NO_RESERVATION + - ANY_RESERVATION + - SPECIFIC_RESERVATION + enumDescriptions: + - Default value. This should not be used. + - Do not consume from any reserved capacity, only use on-demand. + - Consume any reservation available, falling back to on-demand. + - >- + Consume from a specific reservation. When chosen, the reservation + must be identified via the `key` and `values` fields. + description: Required. Specifies the reservation affinity type. type: string - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation - GoogleCloudAiplatformV1BatchMigrateResourcesResponse: - description: Response message for MigrationService.BatchMigrateResources. - type: object + key: + description: >- + Optional. Corresponds to the label key of a reservation resource. To + target a SPECIFIC_RESERVATION by name, use + `compute.googleapis.com/reservation-name` as the key and specify the + name of your reservation as its value. + type: string + values: + description: >- + Optional. Corresponds to the label values of a reservation resource. + This must be the full resource name of the reservation. + type: array + items: + type: string + GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest: + description: Request message for TensorboardService.BatchCreateTensorboardRuns. properties: - migrateResourceResponses: - description: Successfully migrated resources. + requests: type: array + description: >- + Required. The request message specifying the TensorboardRuns to + create. A maximum of 1000 TensorboardRuns can be created in a batch. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse - id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig: + #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardRunRequest + id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig: + type: object + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig description: >- - Specification message containing the config for this SliceSpec. When - `kind` is selected as `value` and/or `range`, only a single slice will - be computed. When `all_values` is present, a separate slice will be - computed for each possible label/value for the corresponding key in - `config`. Examples, with feature zip_code with values 12345, 23334, - 88888 and feature country with values "US", "Canada", "Mexico" in the - dataset: Example 1: { "zip_code": { "value": { "float_value": 12345.0 } - } } A single slice for any data with zip_code 12345 in the dataset. - Example 2: { "zip_code": { "range": { "low": 12345, "high": 20000 } } } - A single slice containing data where the zip_codes between 12345 and - 20000 For this example, data with the zip_code of 12345 will be in this - slice. Example 3: { "zip_code": { "range": { "low": 10000, "high": 20000 - } }, "country": { "value": { "string_value": "US" } } } A single slice - containing data where the zip_codes between 10000 and 20000 has the - country "US". For this example, data with the zip_code of 12345 and - country "US" will be in this slice. Example 4: { "country": - {"all_values": { "value": true } } } Three slices are computed, one for - each unique country in the dataset. Example 5: { "country": { - "all_values": { "value": true } }, "zip_code": { "value": { - "float_value": 12345.0 } } } Three slices are computed, one for each - unique country in the dataset where the zip_code is also 12345. For this - example, data with zip_code 12345 and country "US" will be in one slice, - zip_code 12345 and country "Canada" in another slice, and zip_code 12345 - and country "Mexico" in another slice, totaling 3 slices. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + Configuration that defines the hierarchical relationship of time series + and parameters for hierarchical forecasting strategies. properties: - allValues: - type: boolean + groupTemporalTotalWeight: + type: number description: >- - If all_values is set to true, then all possible labels of the keyed - feature will have another slice computed. Example: - `{"all_values":{"value":true}}` - value: + The weight of the loss for predictions aggregated over both the + horizon and time series in the same hierarchy group. + format: double + groupColumns: description: >- - A unique specific value for a given feature. Example: `{ "value": { - "string_value": "12345" } }` - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue - range: + A list of time series attribute column names that define the time + series hierarchy. Only one level of hierarchy is supported, ex. + 'region' for a hierarchy of stores or 'department' for a hierarchy + of products. If multiple columns are specified, time series will be + grouped by their combined values, ex. ('blue', 'large') for 'color' + and 'size', up to 5 columns are accepted. If no group columns are + specified, all time series are considered to be part of the same + group. + type: array + items: + type: string + temporalTotalWeight: description: >- - A range of values for a numerical feature. Example: - `{"range":{"low":10000.0,"high":50000.0}}` will capture 12345 and - 23334 in the slice. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + The weight of the loss for predictions aggregated over the horizon + for a single time series. + type: number + format: double + groupTotalWeight: + format: double + description: >- + The weight of the loss for predictions aggregated over time series + in the same group. + type: number + GoogleCloudAiplatformV1StopTrialRequest: + properties: {} + description: Request message for VizierService.StopTrial. + id: GoogleCloudAiplatformV1StopTrialRequest type: object - GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams: - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams + GoogleCloudAiplatformV1StudySpecStudyStoppingConfig: + description: >- + The configuration (stopping conditions) for automated stopping of a + Study. Conditions include trial budgets, time budgets, and convergence + detection. + id: GoogleCloudAiplatformV1StudySpecStudyStoppingConfig properties: - minBoundingBoxSize: - format: float - type: number + maxNumTrialsNoProgress: description: >- - Only bounding boxes with shortest edge at least that long as a - relative value of video frame size are returned. Default value is - 0.0. - maxPredictions: + If the objective value has not improved for this many consecutive + trials, stop the study. WARNING: Effective only for single-objective + studies. + type: integer + format: int32 + maxNumTrials: + description: If there are more than this many trials, stop the study. format: int32 type: integer + maxDurationNoProgress: + type: string description: >- - The model only returns up to that many top, by confidence score, - predictions per frame of the video. If this number is very high, the - Model may return fewer predictions per frame. Default value is 50. - confidenceThreshold: - format: float - type: number + If the objective value has not improved for this much time, stop the + study. WARNING: Effective only for single-objective studies. + format: google-duration + maximumRuntimeConstraint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' + description: If the specified time or duration has passed, stop the study. + shouldStopAsap: description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - type: object - description: Prediction model parameters for Video Object Tracking. - GoogleCloudAiplatformV1PointwiseMetricSpec: - description: Spec for pointwise metric. - id: GoogleCloudAiplatformV1PointwiseMetricSpec - properties: - metricPromptTemplate: - description: Required. Metric prompt template for pointwise metric. - type: string - type: object - GoogleCloudAiplatformV1CreateEndpointOperationMetadata: - type: object - description: Runtime operation information for EndpointService.CreateEndpoint. - id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1MutateDeployedIndexResponse: - type: object - id: GoogleCloudAiplatformV1MutateDeployedIndexResponse - properties: - deployedIndex: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - description: The DeployedIndex that had been updated in the IndexEndpoint. - description: Response message for IndexEndpointService.MutateDeployedIndex. - GoogleCloudAiplatformV1PurgeExecutionsRequest: - id: GoogleCloudAiplatformV1PurgeExecutionsRequest - type: object - properties: - force: + If true, a Study enters STOPPING_ASAP whenever it would normally + enters STOPPING state. The bottom line is: set to true if you want + to interrupt on-going evaluations of Trials as soon as the study + stopping condition is met. (Please see Study.State documentation for + the source of truth). type: boolean + minNumTrials: + type: integer description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Execution names - that would be deleted. - filter: - type: string + If there are fewer than this many COMPLETED trials, do not stop the + study. + format: int32 + minimumRuntimeConstraint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' description: >- - Required. A required filter matching the Executions to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. - description: Request message for MetadataService.PurgeExecutions. - GoogleCloudAiplatformV1ToolParameterKVMatchInput: + Each "stopping rule" in this proto specifies an "if" condition. + Before Vizier would generate a new suggestion, it first checks each + specified stopping rule, from top to bottom in this list. Note that + the first few rules (e.g. minimum_runtime_constraint, + min_num_trials) will prevent other stopping rules from being + evaluated until they are met. For example, setting + `min_num_trials=5` and `always_stop_after= 1 hour` means that the + Study will ONLY stop after it has 5 COMPLETED trials, even if more + than an hour has passed since its creation. It follows the first + applicable rule (whose "if" condition is satisfied) to make a + stopping decision. If none of the specified rules are applicable, + then Vizier decides that the study should not stop. If Vizier + decides that the study should stop, the study enters STOPPING state + (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The + automatic study state transition happens precisely as described + above; that is, deleting trials or updating StudyConfig NEVER + automatically moves the study state back to ACTIVE. If you want to + _resume_ a Study that was stopped, 1) change the stopping conditions + if necessary, 2) activate the study, and then 3) ask for + suggestions. If the specified time or duration has not passed, do + not stop the study. + type: object + GoogleCloudAiplatformV1NearestNeighborQueryStringFilter: + id: GoogleCloudAiplatformV1NearestNeighborQueryStringFilter + type: object + description: >- + String filter is used to search a subset of the entities by using + boolean rules on string columns. For example: if a query specifies + string filter with 'name = color, allow_tokens = {red, blue}, + deny_tokens = {purple}',' then that query will match entities that are + red or blue, but if those points are also purple, then they will be + excluded even if they are red/blue. Only string filter is supported for + now, numeric filter will be supported in the near future. properties: - instances: + name: + type: string + description: Required. Column names in BigQuery that used as filters. + denyTokens: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInstance - description: Required. Repeated tool parameter key value match instances. + type: string + description: Optional. The denied tokens. type: array - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchSpec' - description: Required. Spec for tool parameter key value match metric. - description: Input for tool parameter key value match metric. + allowTokens: + description: Optional. The allowed tokens. + items: + type: string + type: array + GoogleCloudAiplatformV1ExplanationMetadata: + id: GoogleCloudAiplatformV1ExplanationMetadata type: object - id: GoogleCloudAiplatformV1ToolParameterKVMatchInput - GoogleCloudAiplatformV1SchemaAnnotationSpecColor: + description: Metadata describing the Model's input and output for explanation. properties: - displayName: + inputs: + description: >- + Required. Map from feature names to feature input metadata. Keys are + the name of the features. Values are the specification of the + feature. An empty InputMetadata is valid. It describes a text + feature which has the name specified as the key in + ExplanationMetadata.inputs. The baseline of the empty feature is + chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the + key can be any friendly name of the feature. Once specified, + featureAttributions are keyed by this key (if not grouped with + another feature). For custom images, the key must match with the key + in instance. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadata + type: object + latentSpaceSource: + description: >- + Name of the source to generate embeddings for example based + explanations. type: string + outputs: description: >- - The display name of the AnnotationSpec represented by the color in - the segmentation mask. - color: - $ref: '#/components/schemas/GoogleTypeColor' - description: The color of the AnnotationSpec in a segmentation mask. - id: + Required. Map from output names to output metadata. For Vertex + AI-provided Tensorflow images, keys can be any user defined string + that consists of any UTF-8 characters. For custom images, keys are + the name of the output field in the prediction to be explained. + Currently only one key is allowed. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata + featureAttributionsSchemaUri: type: string description: >- - The ID of the AnnotationSpec represented by the color in the - segmentation mask. - description: >- - An entry of mapping between color and AnnotationSpec. The mapping is - used in segmentation mask. - id: GoogleCloudAiplatformV1SchemaAnnotationSpecColor + Points to a YAML file stored on Google Cloud Storage describing the + format of the feature attributions. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML tabular Models always have this field populated by Vertex AI. + Note: The URI given on output may be different, including the URI + scheme, than the one given on input. The output URI will point to a + location where the user only has a read access. + GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: + description: Response message for FeaturestoreService.BatchReadFeatureValues. + properties: {} type: object - GoogleCloudAiplatformV1EnvVar: - id: GoogleCloudAiplatformV1EnvVar - description: >- - Represents an environment variable present in a Container or Python - Module. + id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse + GoogleCloudAiplatformV1PipelineJobDetail: + description: The runtime detail of PipelineJob. + type: object + id: GoogleCloudAiplatformV1PipelineJobDetail properties: - value: - description: >- - Required. Variables that reference a $(VAR_NAME) are expanded using - the previous defined environment variables in the container and any - service environment variables. If a variable cannot be resolved, the - reference in the input string will be unchanged. The $(VAR_NAME) - syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped - references will never be expanded, regardless of whether the - variable exists or not. - type: string - name: + pipelineContext: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + description: Output only. The context of the pipeline. + taskDetails: + description: Output only. The runtime details of the tasks under the pipeline. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetail' + readOnly: true + type: array + pipelineRunContext: + description: Output only. The context of the current pipeline run. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + GoogleCloudAiplatformV1FeatureViewVertexRagSource: + id: GoogleCloudAiplatformV1FeatureViewVertexRagSource + properties: + uri: description: >- - Required. Name of the environment variable. Must be a valid C - identifier. + Required. The BigQuery view/table URI that will be materialized on + each manual sync trigger. The table/view is expected to have the + following columns and types at least: - `corpus_id` (STRING, + NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - + `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, + NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - + `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, + NULLABLE/REQUIRED) + type: string + ragCorpusId: + format: int64 + description: Optional. The RAG corpus id corresponding to this FeatureView. type: string + description: A Vertex Rag source for features that need to be synced to Online Store. type: object - GoogleCloudAiplatformV1Blob: + GoogleCloudAiplatformV1TuningJob: + id: GoogleCloudAiplatformV1TuningJob properties: - mimeType: + description: + description: Optional. The description of the TuningJob. type: string - description: Required. The IANA standard MIME type of the source data. - data: + supervisedTuningSpec: + description: Tuning Spec for Supervised Fine Tuning. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' + tunedModel: + description: >- + Output only. The tuned model resources assiociated with this + TuningJob. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' + updateTime: + readOnly: true + format: google-datetime type: string - description: Required. Raw bytes. - format: byte - description: >- - Content blob. It's preferred to send as text directly rather than raw - bytes. - id: GoogleCloudAiplatformV1Blob + description: Output only. Time when the TuningJob was most recently updated. + encryptionSpec: + description: >- + Customer-managed encryption key options for a TuningJob. If this is + set, then all resources created by the TuningJob will be encrypted + with the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + createTime: + format: google-datetime + description: Output only. Time when the TuningJob was created. + readOnly: true + type: string + experiment: + readOnly: true + description: Output only. The Experiment associated with this TuningJob. + type: string + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. + readOnly: true + labels: + description: >- + Optional. The labels with user-defined metadata to organize + TuningJob and generated resources such as Model and Endpoint. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object + additionalProperties: + type: string + startTime: + readOnly: true + type: string + format: google-datetime + description: >- + Output only. Time when the TuningJob for the first time entered the + `JOB_STATE_RUNNING` state. + name: + readOnly: true + description: >- + Output only. Identifier. Resource name of a TuningJob. Format: + `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + type: string + tuningDataStats: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' + description: >- + Output only. The tuning data statistics associated with this + TuningJob. + endTime: + description: >- + Output only. Time when the TuningJob entered any of the following + JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. + type: string + format: google-datetime + readOnly: true + state: + readOnly: true + description: Output only. The detailed state of the job. + type: string + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + baseModel: + description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". + type: string + tunedModelDisplayName: + type: string + description: >- + Optional. The display name of the TunedModel. The name can be up to + 128 characters long and can consist of any UTF-8 characters. type: object - GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: - description: Details of operations that perform MetadataService.CreateMetadataStore. + description: Represents a TuningJob that runs with Google owned models. + GoogleCloudAiplatformV1ListSchedulesResponse: + id: GoogleCloudAiplatformV1ListSchedulesResponse properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for creating a MetadataStore. + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListSchedulesRequest.page_token to obtain that page. + type: string + schedules: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + description: List of Schedules in the requested page. + type: array type: object - id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata - GoogleCloudAiplatformV1ExportDataOperationMetadata: + description: Response message for ScheduleService.ListSchedules + GoogleCloudAiplatformV1ToolParameterKVMatchSpec: properties: - gcsOutputDirectory: - type: string - description: >- - A Google Cloud Storage directory which path ends with '/'. The - exported data is stored in the directory. - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - id: GoogleCloudAiplatformV1ExportDataOperationMetadata + useStrictStringMatch: + description: Optional. Whether to use STRCIT string match on parameter values. + type: boolean + id: GoogleCloudAiplatformV1ToolParameterKVMatchSpec + description: Spec for tool parameter key value match metric. type: object - description: Runtime operation information for DatasetService.ExportData. - GoogleCloudAiplatformV1SummarizationVerbositySpec: - id: GoogleCloudAiplatformV1SummarizationVerbositySpec + GoogleCloudAiplatformV1MigratableResourceAutomlDataset: type: object - description: Spec for summarization verbosity score metric. + description: Represents one Dataset in automl.googleapis.com. + id: GoogleCloudAiplatformV1MigratableResourceAutomlDataset properties: - version: - description: Optional. Which version to use for evaluation. - format: int32 - type: integer - useReference: - type: boolean + datasetDisplayName: + description: The Dataset's display name in automl.googleapis.com. + type: string + dataset: description: >- - Optional. Whether to use instance.reference to compute summarization - verbosity. - GoogleCloudAiplatformV1ListSavedQueriesResponse: - description: Response message for DatasetService.ListSavedQueries. + Full resource name of automl Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}`. + type: string + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity: type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity + description: A duration of time expressed in time granularity units. properties: - savedQueries: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + quantity: + type: string + format: int64 description: >- - A list of SavedQueries that match the specified filter in the - request. - type: array - nextPageToken: + The number of granularity_units between data points in the training + data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. + For all other values of `granularity_unit`, must be 1. + unit: + description: >- + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" type: string - description: The standard List next-page token. - id: GoogleCloudAiplatformV1ListSavedQueriesResponse - GoogleCloudAiplatformV1ReadTensorboardSizeResponse: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata properties: - storageSizeByte: - description: Payload storage size for the TensorBoard + evaluatedDataItemsBigqueryUri: + description: BigQuery destination uri for exported evaluated examples. + type: string + trainCostMilliNodeHours: type: string format: int64 - description: Response message for TensorboardService.ReadTensorboardSize. + description: >- + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + description: Model metadata specific to AutoML Tables. type: object - id: GoogleCloudAiplatformV1ReadTensorboardSizeResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation: + GoogleCloudAiplatformV1ToolCallValidMetricValue: + description: Tool call valid metric value for an instance. type: object + id: GoogleCloudAiplatformV1ToolCallValidMetricValue properties: - columnName: - type: string + score: + type: number + description: Output only. Tool call valid score. + format: float + readOnly: true + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata: - description: Metadata information for NotebookService.CreateNotebookRuntimeTemplate. - id: GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig type: object + properties: + skewThresholds: + description: >- + Key is the feature name and value is the threshold. If a feature + needs to be monitored for skew, a value threshold must be configured + for that feature. The threshold here is against feature distribution + distance between the training and prediction feature. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + attributionScoreSkewThresholds: + description: >- + Key is the feature name and value is the threshold. The threshold + here is against attribution score distance between the training and + prediction feature. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + defaultSkewThreshold: + description: >- + Skew anomaly detection threshold used by all features. When the + per-feature thresholds are not set, this field can be used to + specify a threshold for all features. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + description: >- + The config for Training & Prediction data skew detection. It specifies + the training dataset sources and the skew detection parameters. GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline: + id: >- + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline + type: object + description: >- + Output from BatchPredictionJob for Model Monitoring baseline dataset, + which can be used to generate baseline attribution scores. properties: + gcs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Cloud Storage location for BatchExplain output. predictionFormat: - enum: - - PREDICTION_FORMAT_UNSPECIFIED - - JSONL - - BIGQUERY - type: string description: The storage format of the predictions generated BatchPrediction job. enumDescriptions: - Should not be set. - Predictions are in JSONL files. - Predictions are in BigQuery. + enum: + - PREDICTION_FORMAT_UNSPECIFIED + - JSONL + - BIGQUERY + type: string bigquery: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' description: BigQuery location for BatchExplain output. - gcs: - description: Cloud Storage location for BatchExplain output. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry: type: object id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline - description: >- - Output from BatchPredictionJob for Model Monitoring baseline dataset, - which can be used to generate baseline attribution scores. - GoogleCloudAiplatformV1SamplingStrategy: - properties: - randomSampleConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig - description: Random sample config. Will support more sampling strategies later. - id: GoogleCloudAiplatformV1SamplingStrategy - type: object - description: >- - Sampling Strategy for logging, can be for both training and prediction - dataset. - GoogleCloudAiplatformV1ToolParameterKeyMatchResults: - type: object - id: GoogleCloudAiplatformV1ToolParameterKeyMatchResults - properties: - toolParameterKeyMatchMetricValues: - type: array - description: Output only. Tool parameter key match metric values. - readOnly: true - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue - description: Results for tool parameter key match metric. - GoogleCloudAiplatformV1PipelineTaskDetailArtifactList: - properties: - artifacts: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - type: array - description: Output only. A list of artifact metadata. - readOnly: true - type: object - description: A list of artifact metadata. - id: GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - GoogleCloudAiplatformV1EncryptionSpec: - properties: - kmsKeyName: - description: >- - Required. The Cloud KMS resource identifier of the customer managed - encryption key used to protect a resource. Has the form: - `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. - The key needs to be in the same region as where the compute resource - is created. - type: string - type: object - id: GoogleCloudAiplatformV1EncryptionSpec - description: >- - Represents a customer-managed encryption key spec that can be applied to - a top-level resource. - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: - type: object - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - partialResults: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult - description: >- - Partial results that reflect the latest migration operation - progress. - type: array - id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata - description: >- - Runtime operation information for - MigrationService.BatchMigrateResources. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting: - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting - type: object - properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata - description: The metadata information. - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs - CloudAiLargeModelsVisionNamedBoundingBox: + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry properties: - y1: - format: float - type: number - classes: - items: - type: string - type: array - x2: - format: float + quantile: + description: The quantile for this entry. type: number - entities: - type: array - items: - type: string - y2: + format: double + observedQuantile: type: number + description: >- + This is a custom metric that calculates the percentage of true + values that were less than the predicted value for that quantile. + Only populated when optimization_objective is minimize-quantile-loss + and each entry corresponds to an entry in quantiles The percent + value can be used to compare with the quantile value, which is the + target value. + format: double + scaledPinballLoss: format: float - scores: - items: - format: float - type: number - type: array - x1: + description: The scaled pinball loss of this quantile. type: number - format: float + description: Entry for the Quantiles loss type optimization objective. + GoogleCloudAiplatformV1FluencyInput: type: object - id: CloudAiLargeModelsVisionNamedBoundingBox - GoogleCloudAiplatformV1FluencySpec: - id: GoogleCloudAiplatformV1FluencySpec - description: Spec for fluency score metric. + id: GoogleCloudAiplatformV1FluencyInput properties: - version: - type: integer - description: Optional. Which version to use for evaluation. - format: int32 + metricSpec: + description: Required. Spec for fluency score metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencySpec' + instance: + description: Required. Fluency instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInstance' + description: Input for fluency metric. + GoogleCloudAiplatformV1DeployedIndex: type: object - GoogleCloudAiplatformV1SafetyRating: properties: - severityScore: - format: float - description: Output only. Harm severity score. + createTime: + format: google-datetime readOnly: true - type: number - category: + description: Output only. Timestamp when the DeployedIndex was created. type: string - enumDescriptions: - - The harm category is unspecified. - - The harm category is hate speech. - - The harm category is dangerous content. - - The harm category is harassment. - - The harm category is sexually explicit content. - readOnly: true - description: Output only. Harm category. - enum: - - HARM_CATEGORY_UNSPECIFIED - - HARM_CATEGORY_HATE_SPEECH - - HARM_CATEGORY_DANGEROUS_CONTENT - - HARM_CATEGORY_HARASSMENT - - HARM_CATEGORY_SEXUALLY_EXPLICIT - probabilityScore: - description: Output only. Harm probability score. - readOnly: true - format: float - type: number - blocked: - readOnly: true + index: description: >- - Output only. Indicates whether the content was filtered out because - of this rating. + Required. The name of the Index this is the deployment of. We may + refer to this Index as the DeployedIndex's "original" Index. + type: string + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + description: >- + Optional. A description of resources that are dedicated to the + DeployedIndex, and that need a higher degree of manual + configuration. The field min_replica_count must be set to a value + strictly greater than 0, or else validation will fail. We don't + provide SLA when min_replica_count=1. If max_replica_count is not + set, the default value is min_replica_count. The max allowed replica + count is 1000. Available machine types for SMALL shard: + e2-standard-2 and all machine types available for MEDIUM and LARGE + shard. Available machine types for MEDIUM shard: e2-standard-16 and + all machine types available for LARGE shard. Available machine types + for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and + n1-standard-32 are still available, but we recommend e2-standard-16 + and e2-highmem-16 for cost efficiency. + reservedIpRanges: + type: array + items: + type: string + description: >- + Optional. A list of reserved ip ranges under the VPC network that + can be used for this DeployedIndex. If set, we will deploy the index + within the provided ip ranges. Otherwise, the index might be + deployed to any ip ranges under the provided VPC network. The value + should be the name of the address + (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) + Example: ['vertex-ai-ip-range']. For more information about subnets + and network IP ranges, please see + https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. + enableAccessLogging: type: boolean - severity: + description: >- + Optional. If true, private endpoint's access logs are sent to Cloud + Logging. These logs are like standard server access logs, containing + information like timestamp and latency for each MatchRequest. Note + that logs may incur a cost, especially if the deployed index + receives a high queries per second rate (QPS). Estimate your costs + before enabling this option. + privateEndpoints: readOnly: true - enum: - - HARM_SEVERITY_UNSPECIFIED - - HARM_SEVERITY_NEGLIGIBLE - - HARM_SEVERITY_LOW - - HARM_SEVERITY_MEDIUM - - HARM_SEVERITY_HIGH - enumDescriptions: - - Harm severity unspecified. - - Negligible level of harm severity. - - Low level of harm severity. - - Medium level of harm severity. - - High level of harm severity. + description: >- + Output only. Provides paths for users to send requests directly to + the deployed index services running on Cloud via private services + access. This field is populated if network is configured. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' + displayName: type: string - description: Output only. Harm severity levels in the content. - probability: - description: Output only. Harm probability levels in the content. + description: >- + The display name of the DeployedIndex. If not provided upon + creation, the Index's display_name is used. + indexSyncTime: type: string - enumDescriptions: - - Harm probability unspecified. - - Negligible level of harm. - - Low level of harm. - - Medium level of harm. - - High level of harm. + description: >- + Output only. The DeployedIndex may depend on various data on its + original Index. Additionally when certain changes to the original + Index are being done (e.g. when what the Index contains is being + changed) the DeployedIndex may be asynchronously updated in the + background to reflect these changes. If this timestamp's value is at + least the Index.update_time of the original Index, it means that + this DeployedIndex and the original Index are in sync. If this + timestamp is older, then to see which updates this DeployedIndex + already contains (and which it does not), one must list the + operations that are running on the original Index. Only the + successfully completed Operations with update_time equal or before + this sync time are contained in this DeployedIndex. readOnly: true - enum: - - HARM_PROBABILITY_UNSPECIFIED - - NEGLIGIBLE - - LOW - - MEDIUM - - HIGH - description: Safety rating corresponding to the generated content. + format: google-datetime + id: + type: string + description: >- + Required. The user specified ID of the DeployedIndex. The ID can be + up to 128 characters long and must start with a letter and only + contain letters, numbers, and underscores. The ID must be unique + within the project it is created in. + pscAutomationConfigs: + description: >- + Optional. If set for PSC deployed index, PSC connection will be + automatically created after deployment is done and the endpoint + information is populated in + private_endpoints.psc_automated_endpoints. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PSCAutomationConfig' + automaticResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + description: >- + Optional. A description of resources that the DeployedIndex uses, + which to large degree are decided by Vertex AI, and optionally + allows only a modest additional configuration. If min_replica_count + is not set, the default value is 2 (we don't provide SLA when + min_replica_count=1). If max_replica_count is not set, the default + value is min_replica_count. The max allowed replica count is 1000. + deploymentGroup: + type: string + description: >- + Optional. The deployment group can be no longer than 64 characters + (eg: 'test', 'prod'). If not set, we will use the 'default' + deployment group. Creating `deployment_groups` with + `reserved_ip_ranges` is a recommended practice when the peered + network has multiple peering ranges. This creates your deployments + from predictable IP spaces for easier traffic administration. Also, + one deployment_group (except 'default') can only be used with the + same reserved_ip_ranges which means if the deployment_group has been + used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, + e] is disallowed. Note: we only support up to 5 deployment + groups(not including 'default'). + deployedIndexAuthConfig: + description: >- + Optional. If set, the authentication is enabled for the private + endpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' + description: >- + A deployment of an Index. IndexEndpoints contain one or more + DeployedIndexes. + id: GoogleCloudAiplatformV1DeployedIndex + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance: type: object - id: GoogleCloudAiplatformV1SafetyRating - GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult: + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance + description: Spec for question answering correctness instance. + properties: + instruction: + type: string + description: >- + Required. The question asked and other instruction in the inference + prompt. + prediction: + type: string + description: Required. Output of the evaluated model. + reference: + type: string + description: Optional. Ground truth used to compare against the prediction. + context: + description: Optional. Text provided as context to answer the question. + type: string + GoogleCloudAiplatformV1CoherenceResult: type: object - description: Prediction output format for Tabular Regression. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult + description: Spec for coherence result. + id: GoogleCloudAiplatformV1CoherenceResult properties: - quantilePredictions: - description: Quantile predictions, in 1-1 correspondence with quantile_values. - items: - type: number - format: float - type: array - upperBound: - description: The upper bound of the prediction interval. - format: float - type: number - lowerBound: + explanation: + readOnly: true + description: Output only. Explanation for coherence score. + type: string + confidence: + readOnly: true type: number - description: The lower bound of the prediction interval. - format: float - value: + description: Output only. Confidence for coherence score. format: float + score: type: number - description: The regression value. - quantileValues: + readOnly: true + description: Output only. Coherence score. + format: float + GoogleCloudAiplatformV1DeployIndexOperationMetadata: + description: Runtime operation information for IndexEndpointService.DeployIndex. + type: object + id: GoogleCloudAiplatformV1DeployIndexOperationMetadata + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + deployedIndexId: + description: The unique index id specified by user + type: string + CloudAiLargeModelsVisionRaiInfo: + description: 'Next ID: 6' + properties: + detectedLabels: + type: array + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' + description: The list of detected labels for different rai categories. + raiCategories: + items: + type: string + description: List of rai categories' information to return + type: array + scores: + description: >- + List of rai scores mapping to the rai categories. Rounded to 1 + decimal place. + type: array items: type: number format: float + modelName: + type: string + description: >- + The model name used to indexing into the RaiFilterConfig map. Would + either be one of imagegeneration@002-006, imagen-3.0-... api + endpoint names, or internal names used for mapping to different + filter configs (genselfie, ai_watermark) than its api endpoint. + blockedEntities: type: array - description: Quantile values. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics + description: List of blocked entities from the blocklist if it is detected. + items: + type: string + id: CloudAiLargeModelsVisionRaiInfo + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics: type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics properties: - rootMeanSquaredLogError: - description: >- - Root mean squared log error. Undefined when there are negative - ground truth values or predictions. + confidenceThreshold: format: float type: number - meanAbsolutePercentageError: + description: The confidence threshold value used to compute the metrics. + f1Score: format: float - description: >- - Mean absolute percentage error. Infinity when there are zeros in the - ground truth. - type: number - meanAbsoluteError: + description: The harmonic mean of recall and precision. type: number - description: Mean Absolute Error (MAE). + recall: format: float - rSquared: - description: >- - Coefficient of determination as Pearson correlation coefficient. - Undefined when ground truth or predictions are constant or near - constant. type: number - format: float - rootMeanSquaredError: - description: Root Mean Squared Error (RMSE). + description: Recall under the given confidence threshold. + precision: + description: Precision under the given confidence threshold. format: float type: number - description: Metrics for regression evaluation results. - GoogleCloudAiplatformV1Execution: - id: GoogleCloudAiplatformV1Execution - type: object + description: Metrics for a single confidence threshold. + GoogleCloudAiplatformV1Tensorboard: properties: - name: + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + updateTime: type: string - description: Output only. The resource name of the Execution. + description: Output only. Timestamp when this Tensorboard was last updated. readOnly: true + format: google-datetime description: + description: Description of this Tensorboard. type: string - description: Description of the Execution - state: + isDefault: + type: boolean + description: >- + Used to indicate if the TensorBoard instance is the default one. + Each project & region can have at most one default TensorBoard + instance. Creation of a default TensorBoard instance and updating an + existing TensorBoard instance to be default will mark all other + TensorBoard instances (if any) as non default. + etag: type: string - enum: - - STATE_UNSPECIFIED - - NEW - - RUNNING - - COMPLETE - - FAILED - - CACHED - - CANCELLED - enumDescriptions: - - Unspecified Execution state - - The Execution is new - - The Execution is running - - The Execution has finished running - - The Execution has failed - - The Execution completed through Cache hit. - - The Execution was cancelled. description: >- - The state of this Execution. This is a property of the Execution, - and does not imply or capture any ongoing process. This property is - managed by clients (such as Vertex AI Pipelines) and the system does - not prescribe or check the validity of state transitions. + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + blobStoragePathPrefix: + description: >- + Output only. Consumer project Cloud Storage path prefix used to + store blob data, which can either be a bucket or directory. Does not + end with a '/'. + type: string + readOnly: true + name: + description: >- + Output only. Name of the Tensorboard. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + readOnly: true + type: string labels: additionalProperties: type: string type: object description: >- - The labels with user-defined metadata to organize your Executions. + The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Execution - (System labels are excluded). - createTime: - type: string - format: google-datetime - description: Output only. Timestamp when this Execution was created. + more than 64 user labels can be associated with one Tensorboard + (System labels are excluded). See https://goo.gl/xmQnxf for more + information and examples of labels. System reserved label keys are + prefixed with "aiplatform.googleapis.com/" and are immutable. + runCount: + readOnly: true + format: int32 + description: Output only. The number of Runs stored in this Tensorboard. + type: integer + satisfiesPzs: + type: boolean readOnly: true + description: Output only. Reserved for future use. displayName: - description: >- - User provided display name of the Execution. May be up to 128 - Unicode characters. + description: Required. User provided name of this Tensorboard. type: string - schemaVersion: - description: >- - The version of the schema in `schema_title` to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. + createTime: type: string - schemaTitle: + format: google-datetime + description: Output only. Timestamp when this Tensorboard was created. + readOnly: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. + Customer-managed encryption key spec for a Tensorboard. If set, this + Tensorboard and all sub-resources of this Tensorboard will be + secured by this key. + id: GoogleCloudAiplatformV1Tensorboard + type: object + description: >- + Tensorboard is a physical database that stores users' training metrics. + A default Tensorboard is provided in each region of a Google Cloud + project. If needed users can also create extra Tensorboards in their + projects. + GoogleCloudAiplatformV1QuestionAnsweringQualityResult: + type: object + description: Spec for question answering quality result. + properties: + confidence: + readOnly: true + format: float + description: Output only. Confidence for question answering quality score. + type: number + explanation: type: string - etag: + readOnly: true + description: Output only. Explanation for question answering quality score. + score: + description: Output only. Question Answering Quality score. + type: number + format: float + readOnly: true + id: GoogleCloudAiplatformV1QuestionAnsweringQualityResult + GoogleCloudAiplatformV1WriteFeatureValuesResponse: + description: >- + Response message for + FeaturestoreOnlineServingService.WriteFeatureValues. + type: object + properties: {} + id: GoogleCloudAiplatformV1WriteFeatureValuesResponse + GoogleCloudAiplatformV1FluencySpec: + properties: + version: + format: int32 + type: integer + description: Optional. Which version to use for evaluation. + id: GoogleCloudAiplatformV1FluencySpec + type: object + description: Spec for fluency score metric. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata: + properties: + successfulStopReason: + enumDescriptions: + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. + - >- + Further training of the Model ceased to increase its quality, + since it already has converged. type: string + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - updateTime: - format: google-datetime - readOnly: true - description: Output only. Timestamp when this Execution was last updated. + For successful job completions, this is the reason why the job has + finished. + costMilliNodeHours: type: string - metadata: description: >- - Properties of the Execution. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. - type: object - additionalProperties: - description: Properties of the object. - type: any - description: Instance of a general execution. - CloudAiLargeModelsVisionMedia: + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. + format: int64 + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics: + description: Metrics for text extraction evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics type: object properties: - video: - $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' - description: Video - image: - $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' - description: Image. - description: Media. - id: CloudAiLargeModelsVisionMedia - GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: - id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata - description: Details of operations that perform create FeatureOnlineStore. + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: >- + Confusion matrix of the evaluation. Only set for Models where number + of AnnotationSpecs is no more than 10. Only set for + ModelEvaluations, not for ModelEvaluationSlices. + confidenceMetrics: + description: >- + Metrics that have confidence thresholds. Precision-recall curve can + be derived from them. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics + GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + type: object + description: Metadata information for NotebookService.CreateNotebookRuntimeTemplate. + id: GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata + GoogleCloudAiplatformV1ExportDataOperationMetadata: + description: Runtime operation information for DatasetService.ExportData. type: object properties: + gcsOutputDirectory: + description: >- + A Google Cloud Storage directory which path ends with '/'. The + exported data is stored in the directory. + type: string genericMetadata: + description: The common part of the operation metadata. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureOnlineStore. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs + id: GoogleCloudAiplatformV1ExportDataOperationMetadata + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix: properties: - enableProbabilisticInference: + rows: + items: + items: + type: any + type: array + type: array description: >- - If probabilistic inference is enabled, the model will fit a - distribution that captures the uncertainty of a prediction. At - inference time, the predictive distribution is used to make a point - prediction that minimizes the optimization objective. For example, - the mean of a predictive distribution is the point prediction that - minimizes RMSE loss. If quantiles are specified, then the quantiles - of the distribution are also returned. The optimization objective - cannot be minimize-quantile-loss. - type: boolean - exportEvaluatedDataItemsConfig: - description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - dataGranularity: - description: Expected difference in time granularity between rows in the data. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity - quantiles: - description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`, or for probabilistic inference. Up to 5 - quantiles are allowed of values between 0 and 1, exclusive. Required - if the value of optimization_objective is minimize-quantile-loss. - Represents the percent quantiles to use for that objective. - Quantiles must be unique. + Rows in the confusion matrix. The number of rows is equal to the + size of `annotationSpecs`. `rowsi` is the number of DataItems that + have ground truth of the `annotationSpecs[i]` and are predicted as + `annotationSpecs[j]` by the Model being evaluated. For Text + Extraction, when `annotationSpecs[i]` is the last element in + `annotationSpecs`, i.e. the special negative AnnotationSpec, `rowsi` + is the number of predicted entities of `annoatationSpec[j]` that are + not labeled as any of the ground truth AnnotationSpec. When + annotationSpecs[j] is the special negative AnnotationSpec, `rowsi` + is the number of entities have ground truth of `annotationSpec[i]` + that are not predicted as an entity by the Model. The value of the + last cell, i.e. `rowi` where i == j and `annotationSpec[i]` is the + special negative AnnotationSpec, is always 0. + annotationSpecs: items: - format: double - type: number + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + description: >- + AnnotationSpecs used in the confusion matrix. For AutoML Text + Extraction, a special negative AnnotationSpec with empty `id` and + `displayName` of "NULL" will be added as the last element. type: array - timeColumn: + type: object + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + GoogleCloudAiplatformV1FeatureStatsAnomaly: + id: GoogleCloudAiplatformV1FeatureStatsAnomaly + type: object + properties: + distributionDeviation: + format: double + description: >- + Deviation from the current stats to baseline stats. 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. + type: number + score: + description: >- + Feature importance score, only populated when cross-feature + monitoring is enabled. For now only used to represent feature + attribution score within range [0, 1] for + ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and + ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT. + format: double + type: number + endTime: + format: google-datetime type: string description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. - validationOptions: + The end timestamp of window where stats were generated. For + objectives where time window doesn't make sense (e.g. Featurestore + Snapshot Monitoring), end_time indicates the timestamp of the data + used to generate stats (e.g. timestamp we take snapshots for feature + values). + statsUri: type: string description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue - windowConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - description: Config containing strategy for generating sliding windows. - trainBudgetMilliNodeHours: - format: int64 + Path of the stats file for current feature values in Cloud Storage + bucket. Format: gs:////stats. Example: + gs://monitoring_bucket/feature_name/stats. Stats are stored as + binary format with Protobuf message + [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto). + anomalyUri: description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. + Path of the anomaly file for current feature values in Cloud Storage + bucket. Format: gs:////anomalies. Example: + gs://monitoring_bucket/feature_name/anomalies. Stats are stored as + binary format with Protobuf message Anoamlies are stored as binary + format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] + (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto). type: string - unavailableAtForecastColumns: - type: array + anomalyDetectionThreshold: + format: double + type: number description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. - items: - type: string - contextWindow: - type: string + This is the threshold used when detecting anomalies. The threshold + can be changed by user, so this one might be different from + ThresholdConfig.value. + startTime: description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. - format: int64 - forecastHorizon: - format: int64 + The start timestamp of window where stats were generated. For + objectives where time window doesn't make sense (e.g. Featurestore + Snapshot Monitoring), start_time is only used to indicate the + monitoring intervals, so it always equals to (end_time - + monitoring_interval). + format: google-datetime + type: string + description: >- + Stats and Anomaly generated at specific timestamp for specific Feature. + The start_time and end_time are used to define the time range of the + dataset that current stats belongs to, e.g. prediction traffic is + bucketed into prediction datasets by time window. If the Dataset is not + defined by time window, start_time = end_time. Timestamp of the stats + and anomalies always refers to end_time. Raw stats and anomalies are + stored in stats_uri or anomaly_uri in the tensorflow defined protos. + Field data_stats contains almost identical information with the raw + stats in Vertex AI defined proto, for UI to display. + GoogleCloudAiplatformV1Execution: + id: GoogleCloudAiplatformV1Execution + type: object + properties: + schemaVersion: type: string description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - availableAtForecastColumns: - type: array - description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. - items: - type: string - targetColumn: + The version of the schema in `schema_title` to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + state: type: string + enumDescriptions: + - Unspecified Execution state + - The Execution is new + - The Execution is running + - The Execution has finished running + - The Execution has failed + - The Execution completed through Cache hit. + - The Execution was cancelled. + enum: + - STATE_UNSPECIFIED + - NEW + - RUNNING + - COMPLETE + - FAILED + - CACHED + - CANCELLED description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. - optimizationObjective: + The state of this Execution. This is a property of the Execution, + and does not imply or capture any ongoing process. This property is + managed by clients (such as Vertex AI Pipelines) and the system does + not prescribe or check the validity of state transitions. + name: + description: Output only. The resource name of the Execution. type: string + readOnly: true + etag: description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + type: string + schemaTitle: type: string - hierarchyConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - additionalExperiments: - items: - type: string - type: array - description: Additional experiment flags for the time series forcasting training. - timeSeriesAttributeColumns: - items: - type: string + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + description: + type: string + description: Description of the Execution + createTime: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this Execution was created. + type: string + updateTime: + type: string + readOnly: true + description: Output only. Timestamp when this Execution was last updated. + format: google-datetime + displayName: description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - type: array - holidayRegions: + User provided display name of the Execution. May be up to 128 + Unicode characters. + type: string + labels: + type: object description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. - items: + The labels with user-defined metadata to organize your Executions. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Execution + (System labels are excluded). + additionalProperties: type: string - type: array - transformations: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation - description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - type: array - weightColumn: - type: string + metadata: description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. + Properties of the Execution. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + type: object + additionalProperties: + type: any + description: Properties of the object. + description: Instance of a general execution. + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest: + description: >- + Request message for + JobService.SearchModelDeploymentMonitoringStatsAnomalies. type: object - GoogleCloudAiplatformV1RayLogsSpec: properties: - disabled: + pageSize: + description: The standard list page size. + type: integer + format: int32 + deployedModelId: description: >- - Optional. Flag to disable the export of Ray OSS logs to Cloud - Logging. - type: boolean - type: object - description: Configuration for the Ray OSS Logs. - id: GoogleCloudAiplatformV1RayLogsSpec - GoogleCloudAiplatformV1ListTuningJobsResponse: - type: object - properties: - tuningJobs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' - description: List of TuningJobs in the requested page. - nextPageToken: + Required. The DeployedModel ID of the + [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. + type: string + endTime: type: string description: >- - A token to retrieve the next page of results. Pass to - ListTuningJobsRequest.page_token to obtain that page. - description: Response message for GenAiTuningService.ListTuningJobs - id: GoogleCloudAiplatformV1ListTuningJobsResponse - GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec: - type: object - properties: - useReference: - description: >- - Optional. Whether to use instance.reference to compute question - answering quality. - type: boolean - version: - description: Optional. Which version to use for evaluation. - format: int32 - type: integer - description: Spec for pairwise question answering quality score metric. - id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec - GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue: - properties: - score: - format: float - type: number - readOnly: true - description: Output only. Tool parameter key value match score. - type: object - description: Tool parameter key value match metric value for an instance. - id: GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation: - description: Represents a polygon in image. - properties: - annotationSpecId: + The latest timestamp of stats being generated. If not set, indicates + feching stats till the latest possible one. + format: google-datetime + startTime: + type: string + format: google-datetime description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. + The earliest timestamp of stats being generated. If not set, + indicates fetching stats till the earliest possible one. + featureDisplayName: type: string - vertexes: description: >- - The vertexes are connected one by one and the last vertex is - connected to the first one to represent a polygon. - type: array + The feature display name. If specified, only return the stats + belonging to this feature. Format: + ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, + example: "user_destination". + objectives: + description: Required. Objectives of the stats to retrieve. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' - displayName: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective + type: array + pageToken: description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. + A page token received from a previous + JobService.SearchModelDeploymentMonitoringStatsAnomalies call. type: string id: >- - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation - type: object - GoogleCloudAiplatformV1FunctionDeclaration: - id: GoogleCloudAiplatformV1FunctionDeclaration + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest + GoogleProtobufEmpty: + id: GoogleProtobufEmpty type: object - properties: - response: - description: >- - Optional. Describes the output from this function in JSON Schema - format. Reflects the Open API 3.03 Response Object. The Schema - defines the type used for the response value of the function. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - description: >- - Optional. Describes the parameters to this function in JSON Schema - Object format. Reflects the Open API 3.03 Parameter Object. string - Key: the name of the parameter. Parameter names are case sensitive. - Schema Value: the Schema defining the type used for the parameter. - For function with no parameters, this can be left unset. Parameter - names must start with a letter or an underscore and must only - contain chars a-z, A-Z, 0-9, or underscores with a maximum length of - 64. Example with 1 required and 1 optional parameter: type: OBJECT - properties: param1: type: STRING param2: type: INTEGER required: - - param1 - name: - description: >- - Required. The name of the function to call. Must start with a letter - or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, - dots and dashes, with a maximum length of 64. - type: string - description: - description: >- - Optional. Description and purpose of the function. Model uses it to - decide how and whether to call the function. - type: string description: >- - Structured representation of a function declaration as defined by the - [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). - Included in this declaration are the function name and parameters. This - FunctionDeclaration is a representation of a block of code that can be - used as a `Tool` by the model and executed by the client. - GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature: + 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); } + properties: {} + GoogleCloudAiplatformV1ExactMatchMetricValue: + description: Exact match metric value for an instance. type: object + id: GoogleCloudAiplatformV1ExactMatchMetricValue properties: - sigma: + score: type: number + description: Output only. Exact match score. format: float - description: >- - This represents the standard deviation of the Gaussian kernel that - will be used to add noise to the feature prior to computing - gradients. Similar to noise_sigma but represents the noise added to - the current feature. Defaults to 0.1. - name: - type: string - description: >- - The name of the input feature for which noise sigma is provided. The - features are defined in explanation metadata inputs. - id: GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature - description: Noise sigma for a single feature. - GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + readOnly: true + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource: properties: - allowedIssuers: - type: array + uri: items: type: string description: >- - A list of allowed JWT issuers. Each entry must be a valid Google - service account, in the following format: - `service-account-name@project-id.iam.gserviceaccount.com` - audiences: + Cloud Storage URI of one or more files. Only CSV files are + supported. The first line of the CSV file is used as the header. If + there are multiple files, the header is the first line of the + lexicographically first file, the other files must either contain + the exact same header or omit the header. type: array - items: - type: string - description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. - id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider type: object - GoogleCloudAiplatformV1ListTensorboardsResponse: + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest: + id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest properties: - nextPageToken: + filter: type: string description: >- - A token, which can be sent as ListTensorboardsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - tensorboards: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' - description: The Tensorboards mathching the request. - type: array - type: object - description: Response message for TensorboardService.ListTensorboards. - id: GoogleCloudAiplatformV1ListTensorboardsResponse - GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource: - properties: - content: - format: byte - description: The base64-encoded contents of the input notebook file. - type: string - id: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource - type: object - description: The content of the input notebook in ipynb format. - GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance: - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance - description: Prediction input format for Video Classification. - properties: - timeSegmentStart: - type: string - description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. - content: - type: string + Exports the TensorboardTimeSeries' data that match the filter + expression. + pageSize: description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. - timeSegmentEnd: + The maximum number of data points to return per page. The default + page_size is 1000. Values must be between 1 and 10000. Values above + 10000 are coerced to 10000. + type: integer + format: int32 + orderBy: description: >- - The end, exclusive, of the video's time segment on which to perform - the prediction. Expressed as a number of seconds as measured from - the start of the video, with "s" appended at the end. Fractions are - allowed, up to a microsecond precision, and "inf" or "Infinity" is - allowed, which means the end of the video. + Field to use to sort the TensorboardTimeSeries' data. By default, + TensorboardTimeSeries' data is returned in a pseudo random order. type: string - mimeType: + pageToken: description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime + A page token, received from a previous + ExportTensorboardTimeSeriesData call. Provide this to retrieve the + subsequent page. When paginating, all other parameters provided to + ExportTensorboardTimeSeriesData must match the call that provided + the page token. type: string + description: Request message for TensorboardService.ExportTensorboardTimeSeriesData. type: object - GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig: - id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig - description: The configuration for grounding checking. - type: object + GoogleCloudAiplatformV1ExportModelOperationMetadata: properties: - sources: - description: The sources for the grounding checking. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry - disableAttribution: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + outputInfo: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo description: >- - If set, skip finding claim attributions (i.e not generate grounding - citation). - type: boolean - deprecated: true - GoogleCloudAiplatformV1SuggestTrialsResponse: + Output only. Information further describing the output of this Model + export. + readOnly: true + description: Details of ModelService.ExportModel operation. type: object + id: GoogleCloudAiplatformV1ExportModelOperationMetadata + GoogleCloudAiplatformV1TimeSeriesData: + id: GoogleCloudAiplatformV1TimeSeriesData properties: - studyState: - type: string + valueType: enumDescriptions: - - The study state is unspecified. - - The study is active. - - The study is stopped due to an internal error. + - The value type is unspecified. - >- - The study is done when the service exhausts the parameter search - space or max_trial_count is reached. + Used for TensorboardTimeSeries that is a list of scalars. E.g. + accuracy of a model over epochs/time. + - >- + Used for TensorboardTimeSeries that is a list of tensors. E.g. + histograms of weights of layer in a model over epoch/time. + - >- + Used for TensorboardTimeSeries that is a list of blob sequences. + E.g. set of sample images with labels over epochs/time. + description: >- + Required. Immutable. The value type of this time series. All the + values in this time series data must match this value type. enum: - - STATE_UNSPECIFIED - - ACTIVE - - INACTIVE - - COMPLETED - description: The state of the Study. - startTime: - format: google-datetime + - VALUE_TYPE_UNSPECIFIED + - SCALAR + - TENSOR + - BLOB_SEQUENCE type: string - description: The time at which the operation was started. - endTime: - description: The time at which operation processing completed. - format: google-datetime + tensorboardTimeSeriesId: type: string - trials: - type: array + description: >- + Required. The ID of the TensorboardTimeSeries, which will become the + final component of the TensorboardTimeSeries' resource name + values: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - description: A list of Trials. - id: GoogleCloudAiplatformV1SuggestTrialsResponse - description: Response message for VizierService.SuggestTrials. - GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance: - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + type: array + description: Required. Data points in this time series. + description: All the data stored in a TensorboardTimeSeries. + type: object + GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail: type: object + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail + description: The detailed info for a custom job executor. properties: - content: - description: The text snippet to make the predictions on. - type: string - mimeType: + failedJobs: + readOnly: true + items: + type: string + type: array description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain + Output only. The names of the previously failed CustomJob. The list + includes the all attempts in chronological order. + job: + readOnly: true type: string - description: Prediction input format for Text Classification. - GoogleCloudAiplatformV1ToolCallValidInstance: + description: Output only. The name of the CustomJob. + GoogleCloudAiplatformV1DirectPredictRequest: + id: GoogleCloudAiplatformV1DirectPredictRequest properties: - reference: - type: string - description: Required. Ground truth used to compare against the prediction. - prediction: + parameters: + description: The parameters that govern the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + inputs: + description: The prediction input. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: Request message for PredictionService.DirectPredict. + type: object + GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: + description: When manual routing is set, the specified model will be used directly. + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode + properties: + modelName: type: string - description: Required. Output of the evaluated model. - description: Spec for tool call valid instance. - id: GoogleCloudAiplatformV1ToolCallValidInstance + description: >- + The model name to use. Only the public LLM models are accepted. e.g. + 'gemini-1.5-pro-001'. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification: + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList: + type: object + id: >- + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList + properties: + features: + description: List of feature names and values. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + type: array description: >- - A TrainingJob that trains and uploads an AutoML Video Classification - Model. + Response structure in the format of key (feature name) and (feature) + value pair. + GoogleCloudAiplatformV1FunctionDeclaration: properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs - description: The input parameters of this TrainingJob. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification - type: object - GoogleCloudAiplatformV1SummarizationQualityInstance: - description: Spec for summarization quality instance. + parameters: + description: >- + Optional. Describes the parameters to this function in JSON Schema + Object format. Reflects the Open API 3.03 Parameter Object. string + Key: the name of the parameter. Parameter names are case sensitive. + Schema Value: the Schema defining the type used for the parameter. + For function with no parameters, this can be left unset. Parameter + names must start with a letter or an underscore and must only + contain chars a-z, A-Z, 0-9, or underscores with a maximum length of + 64. Example with 1 required and 1 optional parameter: type: OBJECT + properties: param1: type: STRING param2: type: INTEGER required: - + param1 + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + name: + type: string + description: >- + Required. The name of the function to call. Must start with a letter + or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, + dots and dashes, with a maximum length of 64. + description: + type: string + description: >- + Optional. Description and purpose of the function. Model uses it to + decide how and whether to call the function. + response: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: >- + Optional. Describes the output from this function in JSON Schema + format. Reflects the Open API 3.03 Response Object. The Schema + defines the type used for the response value of the function. + description: >- + Structured representation of a function declaration as defined by the + [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). + Included in this declaration are the function name and parameters. This + FunctionDeclaration is a representation of a block of code that can be + used as a `Tool` by the model and executed by the client. type: object - id: GoogleCloudAiplatformV1SummarizationQualityInstance + id: GoogleCloudAiplatformV1FunctionDeclaration + GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry: properties: - instruction: + inlineContext: type: string - description: Required. Summarization prompt for LLM. - reference: + description: >- + The grounding text passed inline with the Predict API. It can + support up to 1 million bytes. + enterpriseDatastore: + deprecated: true + description: >- + The uri of the Vertex AI Search data source. Deprecated. Use + vertex_ai_search_datastore instead. type: string - description: Optional. Ground truth used to compare against the prediction. - context: - description: Required. Text to be summarized. + vertexAiSearchDatastore: type: string - prediction: - description: Required. Output of the evaluated model. + description: The uri of the Vertex AI Search data source. + type: + enumDescriptions: + - '' + - Uses Web Search to check the grounding. + - >- + Uses Vertex AI Search to check the grounding. Deprecated. Use + VERTEX_AI_SEARCH instead. + - Uses Vertex AI Search to check the grounding + - Uses inline context to check the grounding. + description: The type of the grounding checking source. + enum: + - UNSPECIFIED + - WEB + - ENTERPRISE + - VERTEX_AI_SEARCH + - INLINE type: string - GoogleCloudAiplatformV1TuningDataStats: - id: GoogleCloudAiplatformV1TuningDataStats - properties: - supervisedTuningDataStats: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats - description: The SFT Tuning data stats. + enumDeprecated: + - false + - false + - true + - false + - false + id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry + description: Single source entry for the grounding checking. type: object - description: The tuning data statistic values for TuningJob. - GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest: + GoogleCloudAiplatformV1Retrieval: properties: - requests: - type: array + vertexAiSearch: + description: Set to use data source powered by Vertex AI Search. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' + disableAttribution: + type: boolean + description: Optional. Deprecated. This option is no longer supported. + deprecated: true + vertexRagStore: + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexRagStore' description: >- - Required. The request message specifying the TensorboardTimeSeries - to create. A maximum of 1000 TensorboardTimeSeries can be created in - a batch. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest - id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest - type: object - description: Request message for TensorboardService.BatchCreateTensorboardTimeSeries. - GoogleCloudAiplatformV1RemoveDatapointsResponse: - properties: {} - description: Response message for IndexService.RemoveDatapoints - id: GoogleCloudAiplatformV1RemoveDatapointsResponse + Set to use data source powered by Vertex RAG store. User data is + uploaded via the VertexRagDataService. + id: GoogleCloudAiplatformV1Retrieval type: object - GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance: + description: >- + Defines a retrieval tool that model can call to access external + knowledge. + GoogleCloudAiplatformV1SafetySetting: + description: Safety settings. + id: GoogleCloudAiplatformV1SafetySetting type: object - description: Prediction input format for Image Classification. properties: - content: - type: string - description: The image bytes or Cloud Storage URI to make the prediction on. - mimeType: + method: + 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 description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/gif - - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance - GoogleCloudAiplatformV1SuggestTrialsRequest: + Optional. Specify if the threshold is used for probability or + severity score. If not specified, the threshold is used for + probability score. + category: + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + - The harm category is civic integrity. + description: Required. Harm category. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + - HARM_CATEGORY_CIVIC_INTEGRITY + type: string + threshold: + enumDescriptions: + - Unspecified harm block threshold. + - Block low threshold and above (i.e. block more). + - Block medium threshold and above. + - Block only high threshold (i.e. block less). + - Block none. + - Turn off the safety filter. + type: string + enum: + - HARM_BLOCK_THRESHOLD_UNSPECIFIED + - BLOCK_LOW_AND_ABOVE + - BLOCK_MEDIUM_AND_ABOVE + - BLOCK_ONLY_HIGH + - BLOCK_NONE + - 'OFF' + description: Required. The harm block threshold. + GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling: + id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling type: object - id: GoogleCloudAiplatformV1SuggestTrialsRequest properties: - clientId: - type: string + minNodeCount: description: >- - Required. The identifier of the client that is requesting the - suggestion. If multiple SuggestTrialsRequests have the same - `client_id`, the service will return the identical suggested Trial - if the Trial is pending, and provide a new Trial if the last - suggested Trial was completed. - contexts: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialContext' + Required. The minimum number of nodes to scale down to. Must be + greater than or equal to 1. + type: integer + format: int32 + maxNodeCount: description: >- - Optional. This allows you to specify the "context" for a Trial; a - context is a slice (a subspace) of the search space. Typical uses - for contexts: 1) You are using Vizier to tune a server for best - performance, but there's a strong weekly cycle. The context - specifies the day-of-week. This allows Tuesday to generalize from - Wednesday without assuming that everything is identical. 2) Imagine - you're optimizing some medical treatment for people. As they walk in - the door, you know certain facts about them (e.g. sex, weight, - height, blood-pressure). Put that information in the context, and - Vizier will adapt its suggestions to the patient. 3) You want to do - a fair A/B test efficiently. Specify the "A" and "B" conditions as - contexts, and Vizier will generalize between "A" and "B" conditions. - If they are similar, this will allow Vizier to converge to the - optimum faster than if "A" and "B" were separate Studies. NOTE: You - can also enter contexts as REQUESTED Trials, e.g. via the - CreateTrial() RPC; that's the asynchronous option where you don't - need a close association between contexts and suggestions. NOTE: All - the Parameters you set in a context MUST be defined in the Study. - NOTE: You must supply 0 or $suggestion_count contexts. If you don't - supply any contexts, Vizier will make suggestions from the full - search space specified in the StudySpec; if you supply a full set of - context, each suggestion will match the corresponding context. NOTE: - A Context with no features set matches anything, and allows - suggestions from the full search space. NOTE: Contexts MUST lie - within the search space specified in the StudySpec. It's an error if - they don't. NOTE: Contexts preferentially match ACTIVE then - REQUESTED trials before new suggestions are generated. NOTE: - Generation of suggestions involves a match between a Context and - (optionally) a REQUESTED trial; if that match is not fully - specified, a suggestion will be geneated in the merged subspace. - suggestionCount: + The maximum number of nodes to scale up to. Must be greater than + min_node_count, and less than or equal to 10 times of + 'min_node_count'. type: integer format: int32 - description: Required. The number of suggestions requested. It must be positive. - description: Request message for VizierService.SuggestTrials. - GoogleCloudAiplatformV1FindNeighborsResponse: - id: GoogleCloudAiplatformV1FindNeighborsResponse + cpuUtilizationTarget: + description: >- + Optional. The cpu utilization that the Autoscaler should be trying + to achieve. This number is on a scale from 0 (no utilization) to 100 + (total utilization), and is limited between 10 and 80. When a + cluster's CPU utilization exceeds the target that you have set, + Bigtable immediately adds nodes to the cluster. When CPU utilization + is substantially lower than the target, Bigtable removes nodes. If + not set or set to 0, default to 50. + type: integer + format: int32 + description: >- + Online serving scaling configuration. If min_node_count and + max_node_count are set to the same value, the cluster will be configured + with the fixed number of node (no auto-scaling). + GoogleCloudAiplatformV1ExportModelRequest: properties: - nearestNeighbors: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors - type: array - description: The nearest neighbors of the query datapoints. + outputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportModelRequestOutputConfig + description: Required. The desired output location and configuration. type: object - description: The response message for MatchService.FindNeighbors. - GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec: - id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec - description: Spec for question answering correctness metric. + description: Request message for ModelService.ExportModel. + id: GoogleCloudAiplatformV1ExportModelRequest + GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData: + type: object + properties: + username: + type: string + description: User's username + viewCount: + type: string + description: Number of times the user has read data within the Tensorboard. + format: int64 + description: Per user usage data. + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData + GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec: type: object + description: Spec for question answering relevance metric. properties: version: - description: Optional. Which version to use for evaluation. format: int32 + description: Optional. Which version to use for evaluation. type: integer useReference: + type: boolean description: >- Optional. Whether to use instance.reference to compute question - answering correctness. - type: boolean - GoogleCloudAiplatformV1SafetyInstance: - properties: - prediction: - description: Required. Output of the evaluated model. - type: string - description: Spec for safety instance. - type: object - id: GoogleCloudAiplatformV1SafetyInstance - GoogleTypeExpr: + answering relevance. + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask: properties: - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - description: - type: string - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - location: - type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - id: GoogleTypeExpr - type: object - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition: - description: Represents the spec to match integer values from parent parameter. - properties: - values: - items: - format: int64 - type: string - type: array - description: >- - Required. Matches values of the parent parameter of 'INTEGER' type. - All values must lie in `integer_value_spec` of parent parameter. - type: object - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition - GoogleCloudAiplatformV1RougeInput: - properties: - instances: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInstance' - description: Required. Repeated rouge instances. - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeSpec' - description: Required. Spec for rouge score metric. - description: Input for rouge metric. - id: GoogleCloudAiplatformV1RougeInput + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + description: The metadata information. + inputs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + description: The input parameters of this CustomTask. + description: A TrainingJob that trains a custom code Model. type: object - GoogleCloudAiplatformV1FulfillmentInput: - properties: - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentSpec' - description: Required. Spec for fulfillment score metric. - instance: - description: Required. Fulfillment instance. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInstance' + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables: + description: A TrainingJob that trains and uploads an AutoML Tables Model. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables type: object - id: GoogleCloudAiplatformV1FulfillmentInput - description: Input for fulfillment metric. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition: properties: - inputs: + metadata: + description: The metadata information. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata + inputs: description: The input parameters of this TrainingJob. - description: >- - A TrainingJob that trains and uploads an AutoML Video Action Recognition - Model. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition - type: object - GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode: - description: >- - When automated routing is specified, the routing will be determined by - the pretrained routing model and customer provided model routing - preference. - id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs + GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation: + description: Annotation details specific to video classification. type: object properties: - modelRoutingPreference: - description: The model routing preference. + displayName: type: string - enumDescriptions: - - Unspecified model routing preference. - - Prefer higher quality over low cost. - - Balanced model routing preference. - - Prefer lower cost over higher quality. - enum: - - UNKNOWN - - PRIORITIZE_QUALITY - - BALANCED - - PRIORITIZE_COST - GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest: - properties: {} - description: Request message for JobService.CancelHyperparameterTuningJob. - type: object - id: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest - GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata: - properties: - specialistPool: description: >- - Output only. The name of the SpecialistPool to which the specialists - are being added. Format: - `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` + The display name of the AnnotationSpec that this Annotation pertains + to. + timeSegment: + description: >- + This Annotation applies to the time period represented by the + TimeSegment. If it's not set, the Annotation applies to the whole + video. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' + annotationSpecId: type: string - readOnly: true - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - type: object - id: GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata - description: >- - Runtime operation metadata for - SpecialistPoolService.UpdateSpecialistPool. - GoogleCloudAiplatformV1ExactMatchInput: - properties: - metricSpec: - description: Required. Spec for exact match metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchSpec' - instances: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInstance' - description: Required. Repeated exact match instances. - type: array - description: Input for exact match metric. + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + id: GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation + GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: + description: Request message for ModelService.UpdateExplanationDataset. + id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest type: object - id: GoogleCloudAiplatformV1ExactMatchInput - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation: properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs - description: The input parameters of this TrainingJob. - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation - description: >- - A TrainingJob that trains and uploads an AutoML Image Segmentation - Model. - type: object - GoogleCloudAiplatformV1FeatureOnlineStoreOptimized: - type: object - id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized - properties: {} - description: Optimized storage type - GoogleCloudAiplatformV1Annotation: - id: GoogleCloudAiplatformV1Annotation + examples: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + description: The example config containing the location of the dataset. + GoogleCloudAiplatformV1FractionSplit: properties: - payloadSchemaUri: - type: string + validationFraction: + type: number + format: double description: >- - Required. Google Cloud Storage URI points to a YAML file describing - payload. The schema is defined as an [OpenAPI 3.0.2 Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/, note that - the chosen schema must be consistent with the parent Dataset's - metadata. - annotationSource: - description: Output only. The source of the Annotation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1UserActionReference' - readOnly: true - createTime: - format: google-datetime - readOnly: true - type: string - description: Output only. Timestamp when this Annotation was created. - etag: + The fraction of the input data that is to be used to validate the + Model. + trainingFraction: + format: double + type: number description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - type: string - labels: - additionalProperties: - type: string - type: object + The fraction of the input data that is to be used to train the + Model. + testFraction: + type: number description: >- - Optional. The labels with user-defined metadata to organize your - Annotations. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. No more than 64 user labels can be associated with one - Annotation(System labels are excluded). See https://goo.gl/xmQnxf - for more information and examples of labels. System reserved label - keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. Following system labels exist for each Annotation: * - "aiplatform.googleapis.com/annotation_set_name": optional, name of - the UI's annotation set this Annotation belongs to. If not set, the - Annotation is not visible in the UI. * - "aiplatform.googleapis.com/payload_schema": output only, its value - is the payload_schema's title. - updateTime: - format: google-datetime - readOnly: true - type: string - description: Output only. Timestamp when this Annotation was last updated. - name: - type: string - readOnly: true - description: Output only. Resource name of the Annotation. - payload: - description: Required. The schema of the payload can be found in payload_schema. - type: any + The fraction of the input data that is to be used to evaluate the + Model. + format: double description: >- - Used to assign specific AnnotationSpec to a particular area of a - DataItem or the whole part of the DataItem. + Assigns the input data to training, validation, and test sets as per the + given fractions. Any of `training_fraction`, `validation_fraction` and + `test_fraction` may optionally be provided, they must sum to up to 1. If + the provided ones sum to less than 1, the remainder is assigned to sets + as decided by Vertex AI. If none of the fractions are set, by default + roughly 80% of data is used for training, 10% for validation, and 10% + for test. + id: GoogleCloudAiplatformV1FractionSplit + type: object + GoogleCloudAiplatformV1SummarizationVerbosityResult: + description: Spec for summarization verbosity result. + id: GoogleCloudAiplatformV1SummarizationVerbosityResult type: object - GoogleCloudAiplatformV1FulfillmentResult: properties: score: - format: float - type: number - description: Output only. Fulfillment score. - readOnly: true - explanation: readOnly: true - type: string - description: Output only. Explanation for fulfillment score. + description: Output only. Summarization Verbosity score. + type: number + format: float confidence: readOnly: true + description: Output only. Confidence for summarization verbosity score. format: float - description: Output only. Confidence for fulfillment score. type: number - description: Spec for fulfillment result. - id: GoogleCloudAiplatformV1FulfillmentResult - type: object - GoogleCloudAiplatformV1ToolParameterKeyMatchInput: - description: Input for tool parameter key match metric. - id: GoogleCloudAiplatformV1ToolParameterKeyMatchInput + explanation: + type: string + description: Output only. Explanation for summarization verbosity score. + readOnly: true + GoogleCloudAiplatformV1MetadataStoreDataplexConfig: type: object + id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig properties: - metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchSpec - description: Required. Spec for tool parameter key match metric. - instances: - description: Required. Repeated tool parameter key match instances. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInstance - GoogleCloudAiplatformV1MergeVersionAliasesRequest: - id: GoogleCloudAiplatformV1MergeVersionAliasesRequest - description: Request message for ModelService.MergeVersionAliases. - properties: - versionAliases: - type: array + enabledPipelinesLineage: + type: boolean description: >- - Required. The set of version aliases to merge. The alias should be - at most 128 characters, and match `a-z{0,126}[a-z-0-9]`. Add the `-` - prefix to an alias means removing that alias from the version. `-` - is NOT counted in the 128 characters. Example: `-golden` means - removing the `golden` alias from the version. There is NO ordering - in aliases, which means 1) The aliases returned from GetModel API - might not have the exactly same order from this MergeVersionAliases - API. 2) Adding and deleting the same alias in the request is not - recommended, and the 2 operations will be cancelled out. - items: - type: string + Optional. Whether or not Data Lineage synchronization is enabled for + Vertex Pipelines. + description: Represents Dataplex integration settings. + GoogleCloudAiplatformV1CancelTrainingPipelineRequest: + properties: {} + type: object + id: GoogleCloudAiplatformV1CancelTrainingPipelineRequest + description: Request message for PipelineService.CancelTrainingPipeline. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata: + description: Model metadata specific to AutoML Forecasting. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata type: object - GoogleCloudAiplatformV1TimeSeriesDataPoint: - id: GoogleCloudAiplatformV1TimeSeriesDataPoint properties: - step: - type: string - description: Step index of this data point within the run. + trainCostMilliNodeHours: + description: >- + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. format: int64 - wallTime: type: string - format: google-datetime + evaluatedDataItemsBigqueryUri: + description: BigQuery destination uri for exported evaluated examples. + type: string + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + properties: + trainerType: + enumDescriptions: + - Default value. + - '' + - '' + type: string + enum: + - TRAINER_TYPE_UNSPECIFIED + - AUTOML_TRAINER + - MODEL_GARDEN_TRAINER + checkpointName: + type: string description: >- - Wall clock timestamp when this data point is generated by the end - user. - blobs: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlobSequence' - description: A blob sequence value. - scalar: - description: A scalar value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scalar' - tensor: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTensor' - description: A tensor value. + Optional. An unique name of pretrained model checkpoint provided in + model garden, it will be mapped to a GCS location internally. + trainerConfig: + additionalProperties: + type: string + description: Customizable trainer settings, used in the `model_garden_trainer`. + type: object + studySpec: + description: >- + Optioinal. StudySpec of hyperparameter tuning job. Required for + `model_garden_trainer`. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + datasetConfig: + type: object + description: Customizable dataset settings, used in the `model_garden_trainer`. + additionalProperties: + type: string + description: >- + A wrapper class which contains the tunable parameters in an AutoML Image + training job. type: object - description: A TensorboardTimeSeries data point. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask: + GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries: type: object - description: A TrainingJob that trains a custom code Model. - properties: - inputs: - description: The input parameters of this CustomTask. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask - GoogleCloudAiplatformV1SchemaTextExtractionAnnotation: properties: - textSegment: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTextSegment' - description: The segment of the text content. - displayName: - type: string - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - annotationSpecId: + timestampColumn: type: string description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - id: GoogleCloudAiplatformV1SchemaTextExtractionAnnotation + Optional. Column hosting timestamp values for a time-series source. + Will be used to determine the latest `feature_values` for each + entity. Optional. If not provided, column named `feature_timestamp` + of type `TIMESTAMP` will be used. + id: GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries + GoogleCloudAiplatformV1CsvSource: type: object - description: Annotation details specific to text extraction. - GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec: + description: The storage details for CSV input content. + properties: + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: Required. Google Cloud Storage location. + id: GoogleCloudAiplatformV1CsvSource + GoogleCloudAiplatformV1IndexStats: type: object - description: Value specification for a parameter in `INTEGER` type. properties: - maxValue: - type: string + sparseVectorsCount: format: int64 - description: Required. Inclusive maximum value of the parameter. - defaultValue: - description: >- - A default value for an `INTEGER` parameter that is assumed to be a - relatively good starting point. Unset value signals that there is no - offered starting point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. + readOnly: true type: string - format: int64 - minValue: - description: Required. Inclusive minimum value of the parameter. + description: Output only. The number of sparse vectors in the Index. + vectorsCount: format: int64 type: string - id: GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics: - type: object + readOnly: true + description: Output only. The number of dense vectors in the Index. + shardsCount: + format: int32 + description: Output only. The number of shards in the Index. + type: integer + readOnly: true + id: GoogleCloudAiplatformV1IndexStats + description: Stats of the Index. + GoogleCloudAiplatformV1EntityIdSelector: properties: - falsePositiveCount: - format: int64 + csvSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + description: Source of Csv + entityIdField: description: >- - The number of Model created labels that do not match a ground truth - label. + Source column that holds entity IDs. If not provided, entity IDs are + extracted from the column named entity_id. + type: string + id: GoogleCloudAiplatformV1EntityIdSelector + type: object + description: Selector for entityId. Getting ids from the given source. + GoogleCloudAiplatformV1FindNeighborsRequest: + description: The request message for MatchService.FindNeighbors. + properties: + queries: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQuery + type: array + description: The list of queries. + deployedIndexId: type: string - precisionAt1: - format: float - type: number description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - DataItem. - confusionMatrix: - description: Confusion matrix of the evaluation for this confidence_threshold. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - trueNegativeCount: - type: string - format: int64 - description: >- - The number of labels that were not created by the Model, but if they - would, they would not match a ground truth label. - falsePositiveRate: - description: False Positive Rate for the given confidence threshold. - type: number - format: float - f1ScoreMicro: - format: float - description: Micro-averaged F1 Score. - type: number - f1ScoreMacro: - type: number - description: Macro-averaged F1 Score. - format: float - truePositiveCount: - description: The number of Model created labels that match a ground truth label. - format: int64 - type: string - f1Score: - format: float - description: >- - The harmonic mean of recall and precision. For summary metrics, it - computes the micro-averaged F1 score. - type: number - f1ScoreAt1: - description: The harmonic mean of recallAt1 and precisionAt1. - format: float - type: number - recall: - description: Recall (True Positive Rate) for the given confidence threshold. - type: number - format: float - falseNegativeCount: - type: string - description: >- - The number of ground truth labels that are not matched by a Model - created label. - format: int64 - confidenceThreshold: - format: float - description: >- - Metrics are computed with an assumption that the Model never returns - predictions with score lower than this value. - type: number - maxPredictions: - description: >- - Metrics are computed with an assumption that the Model always - returns at most this many predictions (ordered by their score, - descendingly), but they all still need to meet the - `confidenceThreshold`. - type: integer - format: int32 - falsePositiveRateAt1: - description: >- - The False Positive Rate when only considering the label that has the - highest prediction score and not below the confidence threshold for - each DataItem. - format: float - type: number - precision: - description: Precision for the given confidence threshold. - format: float - type: number - recallAt1: - format: float - type: number - description: >- - The Recall (True Positive Rate) when only considering the label that - has the highest prediction score and not below the confidence - threshold for each DataItem. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics - GoogleCloudAiplatformV1SchemaTimeSegment: - properties: - startTimeOffset: - type: string - format: google-duration - description: >- - Start of the time segment (inclusive), represented as the duration - since the start of the DataItem. - endTimeOffset: - format: google-duration + The ID of the DeployedIndex that will serve the request. This + request is sent to a specific IndexEndpoint, as per the + IndexEndpoint.network. That IndexEndpoint also has + IndexEndpoint.deployed_indexes, and each such index has a + DeployedIndex.id field. The value of the field below must equal one + of the DeployedIndex.id fields of the IndexEndpoint that is being + called for this request. + returnFullDatapoint: + type: boolean description: >- - End of the time segment (exclusive), represented as the duration - since the start of the DataItem. - type: string - type: object - id: GoogleCloudAiplatformV1SchemaTimeSegment - description: >- - A time period inside of a DataItem that has a time dimension (e.g. - video). - GoogleCloudAiplatformV1ModelDataStats: - id: GoogleCloudAiplatformV1ModelDataStats + If set to true, the full datapoints (including all vector values and + restricts) of the nearest neighbors are returned. Note that + returning full datapoint will significantly increase the latency and + cost of the query. type: object + id: GoogleCloudAiplatformV1FindNeighborsRequest + GoogleCloudAiplatformV1CustomJob: properties: - testAnnotationsCount: - description: >- - Number of Annotations that are used for evaluating this Model. If - the Model is evaluated multiple times, this will be the number of - test Annotations used by the first evaluation. If the Model is not - evaluated, the number is 0. - type: string - format: int64 - trainingAnnotationsCount: - type: string - description: Number of Annotations that are used for training this Model. - format: int64 - trainingDataItemsCount: - description: Number of DataItems that were used for training this Model. - type: string - format: int64 - testDataItemsCount: - format: int64 + webAccessUris: + readOnly: true + additionalProperties: + type: string description: >- - Number of DataItems that were used for evaluating this Model. If the - Model is evaluated multiple times, this will be the number of test - DataItems used by the first evaluation. If the Model is not - evaluated, the number is 0. - type: string - validationDataItemsCount: - format: int64 + Output only. URIs for accessing [interactive + shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + (one URI for each training node). Only available if + job_spec.enable_web_access is `true`. The keys are names of each + node in the training job; for example, `workerpool0-0` for the + primary node, `workerpool1-0` for the first node in the second + worker pool, and `workerpool1-1` for the second node in the second + worker pool. The values are the URIs for each node's interactive + shell. + type: object + endTime: type: string description: >- - Number of DataItems that were used for validating this Model during - training. - validationAnnotationsCount: - format: int64 - description: >- - Number of Annotations that are used for validating this Model during - training. - type: string - description: Stats of data used for train or evaluate the Model. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs: - properties: - modelType: + Output only. Time when the CustomJob entered any of the following + states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + readOnly: true + format: google-datetime + state: + readOnly: true type: string + description: Output only. The detailed state of the job. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED enumDescriptions: - - Should not be set. + - The job state is unspecified. - >- - A model best tailored to be used within Google Cloud, and which c - annot be exported. Default. + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) to a Jetson - device afterwards. + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a Coral device - afterwards. - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_JETSON_VERSATILE_1 - - MOBILE_CORAL_VERSATILE_1 - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs - GoogleCloudAiplatformV1ContainerRegistryDestination: - id: GoogleCloudAiplatformV1ContainerRegistryDestination - type: object - description: The Container Registry location for the container image. - properties: - outputUri: + The job is partially succeeded, some results may be missing due to + errors. + startTime: type: string description: >- - Required. Container Registry URI of a container image. Only Google - Container Registry and Artifact Registry are supported now. Accepted - forms: * Google Container Registry path. For example: - `gcr.io/projectId/imageName:tag`. * Artifact Registry path. For - example: - `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`. If a - tag is not specified, "latest" will be used as the default tag. - GoogleCloudAiplatformV1RougeMetricValue: - properties: - score: - type: number - format: float + Output only. Time when the CustomJob for the first time entered the + `JOB_STATE_RUNNING` state. + format: google-datetime readOnly: true - description: Output only. Rouge score. - type: object - description: Rouge metric value for an instance. - id: GoogleCloudAiplatformV1RougeMetricValue - GoogleCloudAiplatformV1CountTokensResponse: - properties: - totalTokens: - type: integer + name: + type: string + readOnly: true + description: Output only. Resource name of a CustomJob. + jobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + description: Required. Job spec. + updateTime: + readOnly: true + format: google-datetime + description: Output only. Time when the CustomJob was most recently updated. + type: string + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + displayName: description: >- - The total number of tokens counted across all instances from the - request. - format: int32 - totalBillableCharacters: + Required. The display name of the CustomJob. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + type: string + satisfiesPzs: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + labels: + type: object description: >- - The total number of billable characters counted across all instances - from the request. - format: int32 - type: integer - description: Response message for PredictionService.CountTokens. - id: GoogleCloudAiplatformV1CountTokensResponse - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics: - type: object - description: Metrics for a single confidence threshold. - properties: - precision: - description: Output only. Precision for the given confidence threshold. - type: number - format: float - confidenceThreshold: + The labels with user-defined metadata to organize CustomJobs. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + additionalProperties: + type: string + error: description: >- - Output only. The confidence threshold value used to compute the - metrics. - format: float - type: number - f1Score: - type: number - format: float - description: Output only. The harmonic mean of recall and precision. - recall: - format: float - type: number - description: Output only. Recall for the given confidence threshold. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics - GoogleCloudAiplatformV1ComputeTokensResponse: - type: object - properties: - tokensInfo: - type: array + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Lists of tokens info from the input. A ComputeTokensRequest could - have multiple instances with a prompt in each instance. We also need - to return lists of tokens info for the request with multiple - instances. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TokensInfo' - description: Response message for ComputeTokens RPC call. - id: GoogleCloudAiplatformV1ComputeTokensResponse - GoogleCloudAiplatformV1SampleConfig: + Customer-managed encryption key options for a CustomJob. If this is + set, then all resources created by the CustomJob will be encrypted + with the provided encryption key. + createTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Time when the CustomJob was created. + id: GoogleCloudAiplatformV1CustomJob description: >- - Active learning data sampling config. For every active learning labeling - iteration, it will select a batch of data based on the sampling - strategy. + Represents a job that runs custom workloads such as a Docker container + or a Python package. A CustomJob can have multiple worker pools and each + worker pool can have its own machine and input spec. A CustomJob will be + cleaned up once the job enters terminal state (failed or succeeded). + type: object + GoogleCloudAiplatformV1ListEndpointsResponse: properties: - sampleStrategy: - description: >- - Field to choose sampling strategy. Sampling strategy will decide - which data should be selected for human labeling in every batch. + nextPageToken: type: string - enum: - - SAMPLE_STRATEGY_UNSPECIFIED - - UNCERTAINTY - enumDescriptions: - - Default will be treated as UNCERTAINTY. - - Sample the most uncertain data to label. - followingBatchSamplePercentage: description: >- - The percentage of data needed to be labeled in each following batch - (except the first batch). - format: int32 - type: integer - initialBatchSamplePercentage: - description: The percentage of data needed to be labeled in the first batch. - type: integer - format: int32 - id: GoogleCloudAiplatformV1SampleConfig + A token to retrieve the next page of results. Pass to + ListEndpointsRequest.page_token to obtain that page. + endpoints: + description: List of Endpoints in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + type: array + id: GoogleCloudAiplatformV1ListEndpointsResponse type: object - GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: + description: Response message for EndpointService.ListEndpoints. + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation: properties: - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - xMin: - format: double - description: The leftmost coordinate of the bounding box. - type: number annotationSpecId: type: string description: >- The resource Id of the AnnotationSpec that this Annotation pertains to. - yMin: - type: number - format: double - description: The topmost coordinate of the bounding box. - xMax: - type: number - description: The rightmost coordinate of the bounding box. - format: double - yMax: - type: number - format: double - description: The bottommost coordinate of the bounding box. - type: object - id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation - description: Annotation details specific to image object detection. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification: - properties: - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs - description: The input parameters of this TrainingJob. - description: >- - A TrainingJob that trains and uploads an AutoML Image Classification - Model. + displayName: + type: string + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + vertexes: + description: >- + The vertexes are connected one by one and the last vertex is + connected to the first one to represent a polygon. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' + type: array id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation + description: Represents a polygon in image. type: object - GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec: - description: Spec for question answering relevance metric. - id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec + GoogleCloudAiplatformV1FeatureOnlineStoreOptimized: + description: Optimized storage type + properties: {} + type: object + id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized + GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams: + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams + description: Prediction model parameters for Image Classification. properties: - version: + confidenceThreshold: + type: number + format: float + description: >- + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + maxPredictions: + description: >- + The Model only returns up to that many top, by confidence score, + predictions per instance. If this number is very high, the Model may + return fewer predictions. Default value is 10. type: integer format: int32 - description: Optional. Which version to use for evaluation. - useReference: - type: boolean - description: >- - Optional. Whether to use instance.reference to compute question - answering relevance. - type: object - GoogleCloudAiplatformV1ExportModelRequest: - properties: - outputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportModelRequestOutputConfig - description: Required. The desired output location and configuration. - description: Request message for ModelService.ExportModel. - id: GoogleCloudAiplatformV1ExportModelRequest - type: object - GoogleCloudAiplatformV1PurgeArtifactsResponse: + GoogleCloudAiplatformV1CustomJobSpec: type: object properties: - purgeSample: + workerPoolSpecs: + description: >- + Required. The spec of the worker pools including machine type and + Docker image. All worker pools except the first one are optional and + can be skipped by providing an empty value. type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' + models: description: >- - A sample of the Artifact names that will be deleted. Only populated - if `force` is set to false. The maximum number of samples is 100 (it - is possible to return fewer). + Optional. The name of the Model resources for which to generate a + mapping to artifact URIs. Applicable only to some of the + Google-provided custom jobs. 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. items: type: string - purgeCount: - description: >- - The number of Artifacts that this request deleted (or, if `force` is - false, the number of Artifacts that will be deleted). This can be an - estimate. - format: int64 + type: array + tensorboard: type: string - description: Response message for MetadataService.PurgeArtifacts. - id: GoogleCloudAiplatformV1PurgeArtifactsResponse - GoogleCloudAiplatformV1QuestionAnsweringQualityInput: - description: Input for question answering quality metric. - properties: - instance: - description: Required. Question answering quality instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInstance - metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualitySpec - description: Required. Spec for question answering quality score metric. - id: GoogleCloudAiplatformV1QuestionAnsweringQualityInput - type: object - GoogleCloudAiplatformV1ToolNameMatchSpec: - properties: {} - description: Spec for tool name match metric. - id: GoogleCloudAiplatformV1ToolNameMatchSpec - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs - properties: - exportEvaluatedDataItemsConfig: description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - weightColumnName: - type: string + Optional. The name of a Vertex AI Tensorboard resource to which this + CustomJob will upload Tensorboard logs. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + reservedIpRanges: + items: + type: string + type: array description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. - optimizationObjective: + Optional. A list of names for the reserved ip ranges under the VPC + network that can be used for this job. If set, we will deploy the + job within the provided ip ranges. Otherwise, the job will be + deployed to any ip ranges under the provided VPC network. Example: + ['vertex-ai-ip-range']. + enableWebAccess: + description: >- + Optional. Whether you want Vertex AI to enable [interactive shell + access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + to training containers. If set to `true`, you can access interactive + shells at the URIs given by CustomJob.web_access_uris or + Trial.web_access_uris (within HyperparameterTuningJob.trials). + type: boolean + scheduling: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' + description: Scheduling options for a CustomJob. + experimentRun: + description: >- + Optional. The Experiment Run associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` type: string + baseOutputDirectory: description: >- - Objective function the model is optimizing towards. The training - process creates a model that maximizes/minimizes the value of the - objective function over the validation set. The supported - optimization objectives depend on the prediction type. If the field - is not set, a default objective function is used. classification - (binary): "maximize-au-roc" (default) - Maximize the area under the - receiver operating characteristic (ROC) curve. "minimize-log-loss" - - Minimize log loss. "maximize-au-prc" - Maximize the area under the - precision-recall curve. "maximize-precision-at-recall" - Maximize - precision for a specified recall value. - "maximize-recall-at-precision" - Maximize recall for a specified - precision value. classification (multi-class): "minimize-log-loss" - (default) - Minimize log loss. regression: "minimize-rmse" (default) - - Minimize root-mean-squared error (RMSE). "minimize-mae" - Minimize - mean-absolute error (MAE). "minimize-rmsle" - Minimize - root-mean-squared log error (RMSLE). - disableEarlyStopping: + The Cloud Storage location to store the output of this CustomJob or + HyperparameterTuningJob. For HyperparameterTuningJob, the + baseOutputDirectory of each child CustomJob backing a Trial is set + to a subdirectory of name id under its parent + HyperparameterTuningJob's baseOutputDirectory. The following Vertex + AI environment variables will be passed to containers or python + modules when this field is set: For CustomJob: * AIP_MODEL_DIR = + `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * + AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of + HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * + AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = + `//logs/` + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + enableDashboardAccess: + description: >- + Optional. Whether you want Vertex AI to enable access to the + customized dashboard in training chief container. If set to `true`, + you can access the dashboard at the URIs given by + CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). type: boolean + persistentResourceId: description: >- - Use the entire training budget. This disables the early stopping - feature. By default, the early stopping feature is enabled, which - means that AutoML Tables might stop training before the entire - training budget has been used. - optimizationObjectiveRecallValue: - format: float - type: number + Optional. The ID of the PersistentResource in the same Project and + Location which to run If this is specified, the job will be run on + existing machines held by the PersistentResource instead of + on-demand short-live machines. The network and CMEK configs on the + job should be consistent with those on the PersistentResource, + otherwise, the job will be rejected. + type: string + network: description: >- - Required when optimization_objective is - "maximize-precision-at-recall". Must be between 0 and 1, inclusive. - targetColumn: + Optional. The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to which + the Job should be peered. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + To specify this field, you must have already [configured VPC Network + Peering for Vertex + AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If + this field is left unspecified, the job is not peered with any + network. type: string - description: The column name of the target column that the model is to predict. - predictionType: + protectedArtifactLocationId: type: string description: >- - The type of prediction the Model is to produce. "classification" - - Predict one out of multiple target values is picked for each row. - "regression" - Predict a value based on its relation to other - values. This type is available only to columns that contain - semantically numeric values, i.e. integers or floating point number, - even if stored as e.g. strings. - additionalExperiments: - type: array - items: - type: string - description: Additional experiment flags for the Tables training pipeline. - transformations: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation - type: array + The ID of the location to store protected artifacts. e.g. + us-central1. Populate only when the location is different than + CustomJob location. List of supported locations: + https://cloud.google.com/vertex-ai/docs/general/locations + serviceAccount: description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - trainBudgetMilliNodeHours: + Specifies the service account for workload run-as account. Users + submitting jobs must have act-as permission on this run-as account. + If unspecified, the [Vertex AI Custom Code Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + for the CustomJob's project is used. + type: string + experiment: + type: string description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. - format: int64 + Optional. The Experiment associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` + description: Represents the spec of a CustomJob. + id: GoogleCloudAiplatformV1CustomJobSpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity: + properties: + unit: + description: >- + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" type: string - optimizationObjectivePrecisionValue: + quantity: + format: int64 description: >- - Required when optimization_objective is - "maximize-recall-at-precision". Must be between 0 and 1, inclusive. - type: number - format: float + The number of granularity_units between data points in the training + data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. + For all other values of `granularity_unit`, must be 1. + type: string + description: A duration of time expressed in time granularity units. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity type: object - GoogleCloudAiplatformV1SearchMigratableResourcesRequest: - id: GoogleCloudAiplatformV1SearchMigratableResourcesRequest - description: Request message for MigrationService.SearchMigratableResources. + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity: + id: GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + properties: + entityIdSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityIdSelector' + description: >- + Required. Selectors choosing feature values of which entity id to be + deleted from the EntityType. + description: >- + Message to select entity. If an entity id is selected, all the feature + values corresponding to the entity id will be deleted, including the + entityId. type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata properties: - pageToken: - description: The standard page token. - type: string - pageSize: - description: The standard page size. The default and maximum value is 100. - type: integer - format: int32 - filter: + trainCostMilliNodeHours: + format: int64 type: string description: >- - A filter for your search. You can use the following types of - filters: * Resource type filters. The following strings filter for a - specific type of MigratableResource: * `ml_engine_model_version:*` * - `automl_model:*` * `automl_dataset:*` * `data_labeling_dataset:*` * - "Migrated or not" filters. The following strings filter for - resources that either have or have not already been migrated: * - `last_migrate_time:*` filters for migrated resources. * `NOT - last_migrate_time:*` filters for not yet migrated resources. - GoogleCloudAiplatformV1ModelGardenSource: + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + evaluatedDataItemsBigqueryUri: + description: BigQuery destination uri for exported evaluated examples. + type: string + type: object + description: Model metadata specific to Seq2Seq Plus Forecasting. + GoogleCloudAiplatformV1ListSpecialistPoolsResponse: properties: - publicModelName: - description: Required. The model garden source model resource name. + specialistPools: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + description: >- + A list of SpecialistPools that matches the specified filter in the + request. + nextPageToken: type: string - description: >- - Contains information about the source of the models generated from Model - Garden. + description: The standard List next-page token. type: object - id: GoogleCloudAiplatformV1ModelGardenSource - GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: + id: GoogleCloudAiplatformV1ListSpecialistPoolsResponse + description: Response message for SpecialistPoolService.ListSpecialistPools. + GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest: type: object - description: Details of operations that perform update FeatureOnlineStore. - properties: - genericMetadata: - description: Operation metadata for FeatureOnlineStore. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata - GoogleCloudAiplatformV1ExportDataRequest: + properties: {} + description: Request message for JobService.PauseModelDeploymentMonitoringJob. + id: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + GoogleCloudAiplatformV1DeployedIndexAuthConfig: + description: Used to set up the auth on the DeployedIndex's private endpoint. + id: GoogleCloudAiplatformV1DeployedIndexAuthConfig properties: - exportConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataConfig' - description: Required. The desired output location. - id: GoogleCloudAiplatformV1ExportDataRequest + authProvider: + description: Defines the authentication provider that the DeployedIndex uses. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider type: object - description: Request message for DatasetService.ExportData. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation + GoogleCloudAiplatformV1ListMetadataStoresResponse: + description: Response message for MetadataService.ListMetadataStores. type: object - description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Convert the category name to a dictionary lookup index and generate an - embedding for each index. + id: GoogleCloudAiplatformV1ListMetadataStoresResponse properties: - columnName: + nextPageToken: + description: >- + A token, which can be sent as ListMetadataStoresRequest.page_token + to retrieve the next page. If this field is not populated, there are + no subsequent pages. type: string - GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: + metadataStores: + type: array + description: The MetadataStores found for the Location. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + GoogleCloudAiplatformV1TimestampSplit: properties: - progressMessage: - type: string + key: description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - description: Metadata information for NotebookService.StartNotebookRuntime. - id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata - type: object - GoogleCloudAiplatformV1ModelSourceInfo: - properties: - sourceType: - description: Type of the model source. - enum: - - MODEL_SOURCE_TYPE_UNSPECIFIED - - AUTOML - - CUSTOM - - BQML - - MODEL_GARDEN - - GENIE - - CUSTOM_TEXT_EMBEDDING - - MARKETPLACE + Required. The key is a name of one of the Dataset's data columns. + The values of the key (the values in the column) must be in RFC 3339 + `date-time` format, where `time-offset` = `"Z"` (e.g. + 1985-04-12T23:20:50.52Z). If for a piece of data the key is not + present or has an invalid value, that piece is ignored by the + pipeline. type: string - enumDescriptions: - - Should not be used. - - The Model is uploaded by automl training pipeline. - - The Model is uploaded by user or custom training pipeline. - - The Model is registered and sync'ed from BigQuery ML. - - The Model is saved or tuned from Model Garden. - - The Model is saved or tuned from Genie. - - The Model is uploaded by text embedding finetuning pipeline. - - The Model is saved or tuned from Marketplace. - copy: - type: boolean + testFraction: description: >- - If this Model is copy of another Model. If true then source_type - pertains to the original. - description: Detail description of the source information of the model. - type: object - id: GoogleCloudAiplatformV1ModelSourceInfo - GoogleCloudAiplatformV1PurgeArtifactsMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for purging Artifacts. - description: Details of operations that perform MetadataService.PurgeArtifacts. + The fraction of the input data that is to be used to evaluate the + Model. + type: number + format: double + validationFraction: + description: >- + The fraction of the input data that is to be used to validate the + Model. + type: number + format: double + trainingFraction: + type: number + format: double + description: >- + The fraction of the input data that is to be used to train the + Model. type: object - id: GoogleCloudAiplatformV1PurgeArtifactsMetadata - GoogleCloudAiplatformV1PublisherModelResourceReference: + id: GoogleCloudAiplatformV1TimestampSplit + description: >- + Assigns input data to training, validation, and test sets based on a + provided timestamps. The youngest data pieces are assigned to training + set, next to validation set, and the oldest to the test set. Supported + only for tabular Datasets. + GoogleCloudAiplatformV1NetworkSpec: + id: GoogleCloudAiplatformV1NetworkSpec type: object - id: GoogleCloudAiplatformV1PublisherModelResourceReference + description: Network spec. properties: - useCase: - type: string - deprecated: true - description: Use case (CUJ) of the resource. - resourceName: - description: The resource name of the Google Cloud resource. - type: string - uri: + network: + description: >- + The full name of the Google Compute Engine + [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) type: string - description: The URI of the resource. - description: + enableInternetAccess: + type: boolean + description: Whether to enable public internet access. Default false. + subnetwork: + description: >- + The name of the subnet that this instance is in. Format: + `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` type: string - deprecated: true - description: Description of the resource. - description: Reference to a resource. - GoogleApiHttpBody: + GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo: description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + Further describes the output of the ExportModel. Supplements + ExportModelRequest.OutputConfig. type: object - id: GoogleApiHttpBody properties: - contentType: + imageOutputUri: + readOnly: true type: string description: >- - The HTTP Content-Type header value specifying the content type of - the body. - data: + Output only. If the Model image is being exported to Google + Container Registry or Artifact Registry this is the full path of the + image created. + artifactOutputUri: + readOnly: true type: string - format: byte - description: The HTTP request/response body as raw binary. - extensions: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - GoogleCloudAiplatformV1ReadIndexDatapointsRequest: + Output only. If the Model artifact is being exported to Google Cloud + Storage this is the full path of the directory created, into which + the Model files are being written to. + id: GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo + GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata: + id: GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata type: object - id: GoogleCloudAiplatformV1ReadIndexDatapointsRequest - description: The request message for MatchService.ReadIndexDatapoints. properties: - ids: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Runtime operation information for EndpointService.MutateDeployedModel. + GoogleCloudAiplatformV1CountTokensRequest: + id: GoogleCloudAiplatformV1CountTokensRequest + properties: + instances: type: array - description: IDs of the datapoints to be searched for. + description: >- + Optional. The instances that are the input to token counting call. + Schema is identical to the prediction schema of the underlying + model. items: - type: string - deployedIndexId: - type: string - description: The ID of the DeployedIndex that will serve the request. - GoogleCloudAiplatformV1GroundingChunk: - type: object - description: Grounding chunk. - id: GoogleCloudAiplatformV1GroundingChunk - properties: - retrievedContext: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GroundingChunkRetrievedContext - description: Grounding chunk from context retrieved by the retrieval tools. - web: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunkWeb' - description: Grounding chunk from the web. - GoogleCloudAiplatformV1ListTrainingPipelinesResponse: - description: Response message for PipelineService.ListTrainingPipelines - properties: - nextPageToken: - type: string + type: any + generationConfig: description: >- - A token to retrieve the next page of results. Pass to - ListTrainingPipelinesRequest.page_token to obtain that page. - trainingPipelines: - description: List of TrainingPipelines in the requested page. + Optional. Generation config that the model will use to generate the + response. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' + tools: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' + description: >- + Optional. A list of `Tools` the model may use to generate the next + response. A `Tool` is a piece of code that enables the system to + interact with external systems to perform an action, or set of + actions, outside of knowledge and scope of the model. + type: array + systemInstruction: + description: >- + Optional. The user provided system instructions for the model. Note: + only text should be used in parts and content in each part will be + in a separate paragraph. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + contents: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' - id: GoogleCloudAiplatformV1ListTrainingPipelinesResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: Optional. Input content. + model: + type: string + description: >- + Optional. The name of the publisher model requested to serve the + prediction. Format: + `projects/{project}/locations/{location}/publishers/*/models/*` type: object - GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: + description: Request message for PredictionService.CountTokens. + GoogleCloudAiplatformV1FeatureSelector: + description: Selector for Features of an EntityType. + type: object + id: GoogleCloudAiplatformV1FeatureSelector properties: - genericMetadata: - description: Operation metadata for Feature. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + idMatcher: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IdMatcher' + description: Required. Matches Features based on ID. + GoogleCloudAiplatformV1BatchDedicatedResources: + description: >- + A description of resources that are used for performing batch + operations, are dedicated to a Model, and need manual configuration. + properties: + machineSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + description: Required. Immutable. The specification of a single machine. + maxReplicaCount: + format: int32 + type: integer + description: >- + Immutable. The maximum number of machine replicas the batch + operation may be scaled to. The default value is 10. + 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 + type: integer + format: int32 + id: GoogleCloudAiplatformV1BatchDedicatedResources type: object - id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata - description: Details of operations that perform create FeatureGroup. - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature: + GoogleCloudAiplatformV1SearchNearestEntitiesRequest: + description: The request message for FeatureOnlineStoreService.SearchNearestEntities. properties: - featureSelector: + query: + description: Required. The query. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighborQuery' + returnFullEntity: + type: boolean description: >- - Required. Selectors choosing which feature values to be deleted from - the EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - timeRange: + Optional. If set to true, the full entities (including all vector + values and metadata) of the nearest neighbors are returned; + otherwise only entity id of the nearest neighbors will be returned. + Note that returning full entities will significantly increase the + latency and cost of the query. + id: GoogleCloudAiplatformV1SearchNearestEntitiesRequest + type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig: + properties: + explanationBaseline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline description: >- - Required. Select feature generated within a half-inclusive time - range. The time range is lower inclusive and upper exclusive. - $ref: '#/components/schemas/GoogleTypeInterval' - skipOnlineStorageDelete: + Predictions generated by the BatchPredictionJob using baseline + dataset. + enableFeatureAttributes: description: >- - If set, data will not be deleted from online storage. When time - range is older than the data in online storage, setting this to be - true will make the deletion have no impact on online serving. + If want to analyze the Vertex Explainable AI feature attribute + scores or not. If set to true, Vertex AI will log the feature + attributions from explain response and do the skew/drift detection + for them. type: boolean type: object description: >- - Message to select time range and feature. Values of the selected feature - generated within an inclusive time range will be deleted. Using this - option permanently deletes the feature values from the specified feature - IDs within the specified time range. This might include data from the - online storage. If you want to retain any deleted historical data in the - online storage, you must re-ingest it. - id: >- - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature - GoogleCloudAiplatformV1SavedQuery: + The config for integrating with Vertex Explainable AI. Only applicable + if the Model has explanation_spec populated. + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig + GoogleCloudAiplatformV1EntityType: + type: object + id: GoogleCloudAiplatformV1EntityType description: >- - A SavedQuery is a view of the dataset. It references a subset of - annotations by problem type and filters. + An entity type is a type of object in a system that needs to be modeled + and have stored information about. For example, driver is an entity + type, and driver0 is an instance of an entity type driver. properties: - annotationFilter: - description: Output only. Filters on the Annotations in the dataset. + satisfiesPzi: + type: boolean readOnly: true + description: Output only. Reserved for future use. + monitoringConfig: + description: >- + Optional. The default monitoring configuration for all Features with + value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under + this EntityType. If this is populated with + [FeaturestoreMonitoringConfig.monitoring_interval] specified, + snapshot analysis monitoring is enabled. Otherwise, snapshot + analysis monitoring is disabled. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfig + labels: + additionalProperties: + type: string + type: object + description: >- + Optional. The labels with user-defined metadata to organize your + EntityTypes. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one EntityType (System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + description: + description: Optional. Description of the EntityType. type: string - metadata: - type: any - description: Some additional information about the SavedQuery. - annotationSpecCount: + offlineStorageTtlDays: description: >- - Output only. Number of AnnotationSpecs in the context of the - SavedQuery. + Optional. Config for data retention policy in offline storage. TTL + in days for feature values that will be stored in offline storage. + The Feature Store offline storage periodically removes obsolete + feature values older than `offline_storage_ttl_days` since the + feature generation time. If unset (or explicitly set to 0), default + to 4000 days TTL. type: integer - readOnly: true format: int32 createTime: - type: string - description: Output only. Timestamp when this SavedQuery was created. format: google-datetime - readOnly: true - displayName: - description: >- - Required. The user-defined name of the SavedQuery. The name can be - up to 128 characters long and can consist of any UTF-8 characters. + description: Output only. Timestamp when this EntityType was created. type: string - problemType: + readOnly: true + etag: type: string description: >- - Required. Problem type of the SavedQuery. Allowed values: * - IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL - * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * - TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * - TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * - VIDEO_OBJECT_TRACKING - supportAutomlTraining: - description: >- - Output only. If the Annotations belonging to the SavedQuery can be - used for AutoML training. - type: boolean + Optional. Used to perform a consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + satisfiesPzs: + description: Output only. Reserved for future use. readOnly: true + type: boolean updateTime: - description: Output only. Timestamp when SavedQuery was last updated. + description: >- + Output only. Timestamp when this EntityType was most recently + updated. + type: string readOnly: true format: google-datetime - type: string name: - type: string - description: Output only. Resource name of the SavedQuery. - readOnly: true - etag: - type: string description: >- - Used to perform a consistent read-modify-write update. If not set, a - blind "overwrite" update happens. - id: GoogleCloudAiplatformV1SavedQuery - type: object - GoogleCloudAiplatformV1SchemaPredictionResult: - id: GoogleCloudAiplatformV1SchemaPredictionResult - description: Represents a line of JSONL in the batch prediction output file. - properties: - key: - description: Optional user-provided key from the input instance. + 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. type: string - prediction: - description: >- - The prediction result. Value is used here instead of Any so that - JsonFormat does not append an extra "@type" field when we convert - the proto to JSON and so we can represent array of objects. Do not - set error if this is set. - type: any - error: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictionResultError - description: The error result. Do not set prediction if this is set. - instance: - additionalProperties: - description: Properties of the object. - type: any - description: >- - User's input instance. Struct is used here instead of Any so that - JsonFormat does not append an extra "@type" field when we convert - the proto to JSON. - type: object - type: object - GoogleCloudAiplatformV1SearchMigratableResourcesResponse: + GoogleCloudAiplatformV1ListIndexEndpointsResponse: + description: Response message for IndexEndpointService.ListIndexEndpoints. properties: - migratableResources: + nextPageToken: description: >- - All migratable resources that can be migrated to the location - specified in the request. + A token to retrieve next page of results. Pass to + ListIndexEndpointsRequest.page_token to obtain that page. + type: string + indexEndpoints: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' type: array - nextPageToken: + description: List of IndexEndpoints in the requested page. + type: object + id: GoogleCloudAiplatformV1ListIndexEndpointsResponse + GoogleCloudAiplatformV1DeployModelResponse: + type: object + properties: + deployedModel: + description: The DeployedModel that had been deployed in the Endpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: Response message for EndpointService.DeployModel. + id: GoogleCloudAiplatformV1DeployModelResponse + GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode: + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode + type: object + description: >- + When automated routing is specified, the routing will be determined by + the pretrained routing model and customer provided model routing + preference. + properties: + modelRoutingPreference: type: string - description: >- - The standard next-page token. The migratable_resources may not fill - page_size in SearchMigratableResourcesRequest even when there are - subsequent pages. - id: GoogleCloudAiplatformV1SearchMigratableResourcesResponse - description: Response message for MigrationService.SearchMigratableResources. + enumDescriptions: + - Unspecified model routing preference. + - Prefer higher quality over low cost. + - Balanced model routing preference. + - Prefer lower cost over higher quality. + description: The model routing preference. + enum: + - UNKNOWN + - PRIORITIZE_QUALITY + - BALANCED + - PRIORITIZE_COST + GoogleCloudAiplatformV1PipelineTaskExecutorDetail: type: object - GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: - id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata + properties: + containerDetail: + readOnly: true + description: Output only. The detailed info for a container executor. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail + customJobDetail: + readOnly: true + description: Output only. The detailed info for a custom job executor. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail + description: The runtime detail of a pipeline executor. + GoogleCloudAiplatformV1CreateDatasetOperationMetadata: properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureView Update. - type: object - description: Details of operations that perform update FeatureView. - GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata: + description: The operation generic information. + description: Runtime operation information for DatasetService.CreateDataset. type: object - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata + id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata + GoogleCloudAiplatformV1TensorboardExperiment: description: >- - Metadata information about the deployment for managing deployment - config. + A TensorboardExperiment is a group of TensorboardRuns, that are + typically the results of a training job run, in a Tensorboard. + id: GoogleCloudAiplatformV1TensorboardExperiment properties: - sampleRequest: - description: Optional. Sample request for deployed endpoint. + name: + type: string + description: >- + Output only. Name of the TensorboardExperiment. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + readOnly: true + etag: + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string labels: description: >- - Optional. Labels for the deployment. For managing deployment config - like verifying, source of deployment config, etc. - type: object + The labels with user-defined metadata to organize your + TensorboardExperiment. Label keys and values cannot be longer than + 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. No more than 64 user labels can be + associated with one Dataset (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + `aiplatform.googleapis.com/` and are immutable. The following system + labels exist for each Dataset: * + `aiplatform.googleapis.com/dataset_metadata_schema`: output only. + Its value is the metadata_schema's title. additionalProperties: type: string - GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest: - properties: - requests: - type: array - description: >- - Required. The request message specifying the TensorboardRuns to - create. A maximum of 1000 TensorboardRuns can be created in a batch. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardRunRequest - id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest - type: object - description: Request message for TensorboardService.BatchCreateTensorboardRuns. - GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly: - type: object - description: >- - A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats - requested by user, sorted by FeatureStatsAnomaly.start_time descending. - properties: - featureStatsAnomaly: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + type: object + updateTime: description: >- - Output only. The stats and anomalies generated at specific - timestamp. - objective: - enumDescriptions: - - If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty. - - Stats are generated by Import Feature Analysis. - - Stats are generated by Snapshot Analysis. - enum: - - OBJECTIVE_UNSPECIFIED - - IMPORT_FEATURE_ANALYSIS - - SNAPSHOT_ANALYSIS + Output only. Timestamp when this TensorboardExperiment was last + updated. readOnly: true type: string - description: Output only. The objective for each stats. - id: GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly - GoogleCloudAiplatformV1Neighbor: - properties: - neighborDistance: - readOnly: true - format: double - type: number - description: Output only. The neighbor distance. - neighborId: + format: google-datetime + description: + description: Description of this TensorboardExperiment. type: string - description: Output only. The neighbor id. + displayName: + type: string + description: User provided name of this TensorboardExperiment. + source: + type: string + description: >- + Immutable. Source of the TensorboardExperiment. Example: a custom + training job. + createTime: + format: google-datetime readOnly: true - description: Neighbors for example-based explanations. + type: string + description: Output only. Timestamp when this TensorboardExperiment was created. type: object - id: GoogleCloudAiplatformV1Neighbor - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics - description: Metrics for forecasting evaluation results. + GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: + description: Response message for NotebookService.ListNotebookRuntimeTemplates. type: object + id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse properties: - meanAbsoluteError: - description: Mean Absolute Error (MAE). - type: number - format: float - rootMeanSquaredPercentageError: - description: >- - Root Mean Square Percentage Error. Square root of MSPE. - Undefined/imaginary when MSPE is negative. - type: number - format: float - quantileMetrics: - description: The quantile metrics entries for each quantile. + notebookRuntimeTemplates: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + description: List of NotebookRuntimeTemplates in the requested page. type: array - rSquared: - description: >- - Coefficient of determination as Pearson correlation coefficient. - Undefined when ground truth or predictions are constant or near - constant. - type: number - format: float - rootMeanSquaredError: - type: number - description: Root Mean Squared Error (RMSE). - format: float - weightedAbsolutePercentageError: - type: number + nextPageToken: + type: string description: >- - Weighted Absolute Percentage Error. Does not use weights, this is - just what the metric is called. Undefined if actual values sum to - zero. Will be very large if actual values sum to a very small - number. - format: float - rootMeanSquaredLogError: - format: float - type: number + A token to retrieve next page of results. Pass to + ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. + GoogleCloudAiplatformV1CreateTensorboardRunRequest: + type: object + properties: + parent: + type: string description: >- - Root mean squared log error. Undefined when there are negative - ground truth values or predictions. - meanAbsolutePercentageError: - type: number - format: float + Required. The resource name of the TensorboardExperiment to create + the TensorboardRun in. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + tensorboardRunId: + type: string description: >- - Mean absolute percentage error. Infinity when there are zeros in the - ground truth. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics: + 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-/`. + tensorboardRun: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + description: Required. The TensorboardRun to create. + description: Request message for TensorboardService.CreateTensorboardRun. + id: GoogleCloudAiplatformV1CreateTensorboardRunRequest + GoogleCloudAiplatformV1PointwiseMetricResult: + type: object + id: GoogleCloudAiplatformV1PointwiseMetricResult properties: - trackingRecall: - type: number + score: format: float - description: Tracking recall. - trackingPrecision: - format: float - type: number - description: Tracking precision. - mismatchRate: - type: number - format: float - description: >- - Mismatch rate, which measures the tracking consistency, i.e. - correctness of instance ID continuity. - boundingBoxIou: - type: number - format: float - description: >- - Bounding box intersection-over-union precision. Measures how well - the bounding boxes overlap between each other (e.g. complete overlap - or just barely above iou_threshold). - confidenceThreshold: - format: float - description: The confidence threshold value used to compute the metrics. + description: Output only. Pointwise metric score. type: number - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics - description: Metrics for a single confidence threshold. - type: object - GoogleCloudAiplatformV1WriteFeatureValuesRequest: - properties: - payloads: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesPayload - description: >- - Required. The entities to be written. Up to 100,000 feature values - can be written across all `payloads`. - type: array - id: GoogleCloudAiplatformV1WriteFeatureValuesRequest - type: object - description: Request message for FeaturestoreOnlineServingService.WriteFeatureValues. - GoogleCloudAiplatformV1FeatureViewSyncConfig: - description: Configuration for Sync. Only one option is set. - id: GoogleCloudAiplatformV1FeatureViewSyncConfig - properties: - cron: + readOnly: true + explanation: + description: Output only. Explanation for pointwise metric score. type: string - description: >- - Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch - scheduled runs. To explicitly set a timezone to the cron tab, apply - a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database. For example, - "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * - * *". - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation: + readOnly: true + description: Spec for pointwise metric result. + GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation + GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata type: object - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. properties: - columnName: + runTime: type: string - GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest: - description: Request message for NotebookService.UpgradeNotebookRuntime. - id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest - properties: {} - type: object - GoogleCloudAiplatformV1TrialParameter: - description: A message representing a parameter to be tuned. - id: GoogleCloudAiplatformV1TrialParameter + description: >- + The time that most recent monitoring pipelines that is related to + this run. + format: google-datetime + status: + description: The status of the most recent monitoring pipeline. + $ref: '#/components/schemas/GoogleRpcStatus' + description: All metadata of most recent monitoring pipelines. + GoogleCloudAiplatformV1BatchPredictionJobOutputInfo: type: object + description: Further describes this job's output. Supplements output_config. + id: GoogleCloudAiplatformV1BatchPredictionJobOutputInfo properties: - value: - type: any + gcsOutputDirectory: + readOnly: true description: >- - Output only. The value of the parameter. `number_value` will be set - if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' - or 'DISCRETE'. `string_value` will be set if a parameter defined in - StudySpec is in type 'CATEGORICAL'. + Output only. The full path of the Cloud Storage directory created, + into which the prediction output is written. + type: string + bigqueryOutputDataset: readOnly: true - parameterId: + description: >- + Output only. The path of the BigQuery dataset created, in + `bq://projectId.bqDatasetId` format, into which the prediction + output is written. + type: string + bigqueryOutputTable: readOnly: true description: >- - Output only. The ID of the parameter. The parameter should be - defined in StudySpec's Parameters. + Output only. The name of the BigQuery table created, in + `predictions_` format, into which the prediction output is written. + Can be used by UI to generate the BigQuery output path, for example. type: string - GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse: - type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset: + description: Training Dataset information. + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset properties: - nextPageToken: + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + description: >- + The BigQuery table of the unmanaged Dataset used to train this + Model. + dataFormat: type: string description: >- - A token, which can be sent as - ListTensorboardTimeSeriesRequest.page_token to retrieve the next - page. If this field is omitted, there are no subsequent pages. - tensorboardTimeSeries: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - description: The TensorboardTimeSeries mathching the request. - type: array - id: GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse - description: Response message for TensorboardService.ListTensorboardTimeSeries. - GoogleCloudAiplatformV1TimeSeriesData: - description: All the data stored in a TensorboardTimeSeries. - id: GoogleCloudAiplatformV1TimeSeriesData - properties: - valueType: + Data format of the dataset, only applicable if the input is from + Google Cloud Storage. The possible formats are: "tf-record" The + source file is a TFRecord file. "csv" The source file is a CSV file. + "jsonl" The source file is a JSONL file. + targetField: description: >- - Required. Immutable. The value type of this time series. All the - values in this time series data must match this value type. - enum: - - VALUE_TYPE_UNSPECIFIED - - SCALAR - - TENSOR - - BLOB_SEQUENCE + The target field name the model is to predict. This field will be + excluded when doing Predict and (or) Explain for the training data. type: string - enumDescriptions: - - The value type is unspecified. - - >- - Used for TensorboardTimeSeries that is a list of scalars. E.g. - accuracy of a model over epochs/time. - - >- - Used for TensorboardTimeSeries that is a list of tensors. E.g. - histograms of weights of layer in a model over epoch/time. - - >- - Used for TensorboardTimeSeries that is a list of blob sequences. - E.g. set of sample images with labels over epochs/time. - values: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' - description: Required. Data points in this time series. - type: array - tensorboardTimeSeriesId: + dataset: type: string + description: The resource name of the Dataset used to train this Model. + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' description: >- - Required. The ID of the TensorboardTimeSeries, which will become the - final component of the TensorboardTimeSeries' resource name - type: object - GoogleCloudAiplatformV1ExplanationMetadata: - id: GoogleCloudAiplatformV1ExplanationMetadata - description: Metadata describing the Model's input and output for explanation. + The Google Cloud Storage uri of the unmanaged Dataset used to train + this Model. + loggingSamplingStrategy: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' + description: >- + Strategy to sample data from Training Dataset. If not set, we + process the whole dataset. type: object + GoogleCloudAiplatformV1IndexDatapointNumericRestriction: properties: - outputs: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata - description: >- - Required. Map from output names to output metadata. For Vertex - AI-provided Tensorflow images, keys can be any user defined string - that consists of any UTF-8 characters. For custom images, keys are - the name of the output field in the prediction to be explained. - Currently only one key is allowed. - featureAttributionsSchemaUri: + op: description: >- - Points to a YAML file stored on Google Cloud Storage describing the - format of the feature attributions. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML tabular Models always have this field populated by Vertex AI. - Note: The URI given on output may be different, including the URI - scheme, than the one given on input. The output URI will point to a - location where the user only has a read access. + This MUST be specified for queries and must NOT be specified for + datapoints. + enumDescriptions: + - Default value of the enum. + - Datapoints are eligible iff their value is < the query's. + - Datapoints are eligible iff their value is <= the query's. + - Datapoints are eligible iff their value is == the query's. + - Datapoints are eligible iff their value is >= the query's. + - Datapoints are eligible iff their value is > the query's. + - Datapoints are eligible iff their value is != the query's. type: string - inputs: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadata - description: >- - Required. Map from feature names to feature input metadata. Keys are - the name of the features. Values are the specification of the - feature. An empty InputMetadata is valid. It describes a text - feature which has the name specified as the key in - ExplanationMetadata.inputs. The baseline of the empty feature is - chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the - key can be any friendly name of the feature. Once specified, - featureAttributions are keyed by this key (if not grouped with - another feature). For custom images, the key must match with the key - in instance. - latentSpaceSource: + enum: + - OPERATOR_UNSPECIFIED + - LESS + - LESS_EQUAL + - EQUAL + - GREATER_EQUAL + - GREATER + - NOT_EQUAL + valueDouble: + format: double + description: Represents 64 bit float. + type: number + valueFloat: + type: number + format: float + description: Represents 32 bit float. + valueInt: type: string - description: >- - Name of the source to generate embeddings for example based - explanations. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection: - description: >- - A TrainingJob that trains and uploads an AutoML Image Object Detection - Model. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection - type: object - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs - description: The input parameters of this TrainingJob. - metadata: - description: The metadata information - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata - GoogleCloudAiplatformV1DeployIndexResponse: - id: GoogleCloudAiplatformV1DeployIndexResponse - description: Response message for IndexEndpointService.DeployIndex. - properties: - deployedIndex: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - description: The DeployedIndex that had been deployed in the IndexEndpoint. + description: Represents 64 bit integer. + format: int64 + namespace: + type: string + description: 'The namespace of this restriction. e.g.: cost.' type: object - GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata: + description: >- + This field allows restricts to be based on numeric comparisons rather + than categorical tokens. + id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec: properties: - progressMessage: - type: string + maxParallelTrialCount: + type: integer + format: int32 + description: Required. The maximum number of trials to run in parallel. + maxTrialCount: description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Metadata information for NotebookService.CreateNotebookExecutionJob. + Required. The maximum number of Neural Architecture Search (NAS) + trials to run. + type: integer + format: int32 + maxFailedTrialCount: + type: integer + format: int32 + description: >- + The number of failed trials that need to be seen before failing the + NasJob. If set to 0, Vertex AI decides how many trials must fail + before the whole job fails. + searchTrialJobSpec: + description: >- + Required. The spec of a search trial job. The same spec applies to + all search trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec + description: Represent spec for search trials. type: object - id: GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata - GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata: - id: >- - GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata + GoogleCloudAiplatformV1DataItemView: properties: - multiLabel: + hasTruncatedAnnotations: type: boolean - description: Whether or not the classification label is multi_label. + description: >- + True if and only if the Annotations field has been truncated. It + happens if more Annotations for this DataItem met the request's + annotation_filter than are allowed to be returned by + annotations_limit. Note that if Annotations field is not being + returned due to field mask, then this field will not be set to true + no matter how many Annotations are there. + dataItem: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' + description: The DataItem. + annotations: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' + description: >- + The Annotations on the DataItem. If too many Annotations should be + returned for the DataItem, this field will be truncated per + annotations_limit in request. If it was, then the + has_truncated_annotations will be set to true. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity + id: GoogleCloudAiplatformV1DataItemView + description: A container for a single DataItem and Annotations on it. + GoogleCloudAiplatformV1SavedQuery: properties: - unit: + name: + type: string + readOnly: true + description: Output only. Resource name of the SavedQuery. + createTime: + format: google-datetime + type: string + description: Output only. Timestamp when this SavedQuery was created. + readOnly: true + annotationFilter: + readOnly: true + type: string + description: Output only. Filters on the Annotations in the dataset. + problemType: type: string description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" - quantity: - format: int64 + Required. Problem type of the SavedQuery. Allowed values: * + IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL + * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * + TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * + TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * + VIDEO_OBJECT_TRACKING + etag: type: string description: >- - The number of granularity_units between data points in the training - data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. - For all other values of `granularity_unit`, must be 1. - description: A duration of time expressed in time granularity units. - type: object - GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata: + Used to perform a consistent read-modify-write update. If not set, a + blind "overwrite" update happens. + supportAutomlTraining: + type: boolean + description: >- + Output only. If the Annotations belonging to the SavedQuery can be + used for AutoML training. + readOnly: true + annotationSpecCount: + format: int32 + readOnly: true + type: integer + description: >- + Output only. Number of AnnotationSpecs in the context of the + SavedQuery. + metadata: + description: Some additional information about the SavedQuery. + type: any + displayName: + description: >- + Required. The user-defined name of the SavedQuery. The name can be + up to 128 characters long and can consist of any UTF-8 characters. + type: string + updateTime: + type: string + readOnly: true + format: google-datetime + description: Output only. Timestamp when SavedQuery was last updated. + id: GoogleCloudAiplatformV1SavedQuery type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - id: GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata description: >- - Runtime operation information for - SpecialistPoolService.CreateSpecialistPool. - GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines: + A SavedQuery is a view of the dataset. It references a subset of + annotations by problem type and filters. + GoogleCloudAiplatformV1ResumeScheduleRequest: type: object - description: Open fine tuning pipelines. + description: Request message for ScheduleService.ResumeSchedule. properties: - fineTuningPipelines: - description: Required. Regional resource references to fine tuning pipelines. + catchUp: + type: boolean + description: >- + Optional. Whether to backfill missed runs when the schedule is + resumed from PAUSED state. If set to true, all missed runs will be + scheduled. New runs will be scheduled after the backfill is + complete. This will also update Schedule.catch_up field. Default to + false. + id: GoogleCloudAiplatformV1ResumeScheduleRequest + GoogleCloudAiplatformV1TrialContext: + properties: + parameters: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + description: >- + If/when a Trial is generated or selected from this Context, its + Parameters will match any parameters specified here. (I.e. if this + context specifies parameter name:'a' int_value:3, then a resulting + Trial will have int_value:3 for its parameter named 'a'.) Note that + we first attempt to match existing REQUESTED Trials with contexts, + and if there are no matches, we generate suggestions in the subspace + defined by the parameters specified here. NOTE: a Context without + any Parameters matches the entire feasible search space. type: array - id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines - GoogleCloudAiplatformV1FeatureSelector: - description: Selector for Features of an EntityType. - properties: - idMatcher: - description: Required. Matches Features based on ID. - $ref: '#/components/schemas/GoogleCloudAiplatformV1IdMatcher' - id: GoogleCloudAiplatformV1FeatureSelector - type: object - GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: - properties: {} - id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse + description: + description: >- + A human-readable field which can store a description of this + context. This will become part of the resulting Trial's description + field. + type: string type: object - description: Response message for FeaturestoreService.BatchReadFeatureValues. - GoogleCloudAiplatformV1VertexAISearch: - description: >- - Retrieve from Vertex AI Search datastore for grounding. See - https://cloud.google.com/products/agent-builder + id: GoogleCloudAiplatformV1TrialContext + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation: properties: - datastore: - description: >- - Required. Fully-qualified Vertex AI Search data store resource ID. - Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + columnName: type: string - id: GoogleCloudAiplatformV1VertexAISearch type: object - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata: type: object - description: Annotation details specific to image segmentation. + description: Details of operations that perform update FeatureGroup. + id: GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata properties: - polylineAnnotation: - description: Polyline annotation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation - maskAnnotation: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation + genericMetadata: + description: Operation metadata for FeatureGroup. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig: + properties: + desiredMinSafeTrialsFraction: description: >- - Mask based segmentation annotation. Only one mask annotation can - exist for one image. - polygonAnnotation: - description: Polygon annotation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation - id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation - GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource: - id: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource + Desired minimum fraction of safe trials (over total number of + trials) that should be targeted by the algorithm at any time during + the study (best effort). This should be between 0.0 and 1.0 and a + value of 0.0 means that there is no minimum and an algorithm + proceeds without targeting any specific fraction. A value of 1.0 + means that the algorithm attempts to only Suggest safe Trials. + format: double + type: number + safetyThreshold: + description: >- + Safety threshold (boundary value between safe and unsafe). NOTE that + if you leave SafetyMetricConfig unset, a default value of 0 will be + used. + type: number + format: double + description: >- + Used in safe optimization to specify threshold levels and risk + tolerance. type: object + id: GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig + GoogleCloudAiplatformV1ImportFeatureValuesRequest: properties: - generation: + disableOnlineServing: + type: boolean description: >- - The version of the Cloud Storage object to read. If unset, the - current version of the object is read. See - https://cloud.google.com/storage/docs/metadata#generation-number. + If set, data will not be imported for online serving. This is + typically used for backfilling, where Feature generation timestamps + are not in the timestamp range needed for online serving. + featureTimeField: type: string - uri: description: >- - The Cloud Storage uri pointing to the ipynb file. Format: - `gs://bucket/notebook_file.ipynb` + Source column that holds the Feature timestamp for all Feature + values in each entity. + avroSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AvroSource' + featureSpecs: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + type: array + description: >- + Required. Specifications defining which Feature values to import + from the entity. The request fails if no feature_specs are provided, + and having multiple feature_specs for one Feature is not allowed. + workerCount: + type: integer + format: int32 + description: >- + Specifies the number of workers that are used to write data to the + Featurestore. Consider the online serving capacity that you require + to achieve the desired import throughput without interfering with + online serving. The value must be positive, and less than or equal + to 100. If not set, defaults to using 1 worker. The low count + ensures minimal impact on online serving performance. + disableIngestionAnalysis: + type: boolean + description: If true, API doesn't start ingestion analysis pipeline. + csvSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + featureTime: + format: google-datetime + description: >- + Single Feature timestamp for all entities being imported. The + timestamp must not have higher than millisecond precision. type: string - description: The Cloud Storage uri for the input notebook. - GoogleCloudAiplatformV1PurgeContextsMetadata: + entityIdField: + type: string + description: >- + Source column that holds entity IDs. If not provided, entity IDs are + extracted from the column named entity_id. + id: GoogleCloudAiplatformV1ImportFeatureValuesRequest + description: Request message for FeaturestoreService.ImportFeatureValues. type: object - description: Details of operations that perform MetadataService.PurgeContexts. - id: GoogleCloudAiplatformV1PurgeContextsMetadata - properties: - genericMetadata: - description: Operation metadata for purging Contexts. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateIndexOperationMetadata: + GoogleCloudAiplatformV1BatchPredictionJobOutputConfig: + description: >- + Configures the output of BatchPredictionJob. See + Model.supported_output_storage_formats for supported output formats, and + how predictions are expressed via any of them. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - nearestNeighborSearchOperationMetadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + predictionsFormat: description: >- - The operation metadata with regard to Matching Engine Index - operation. - description: Runtime operation information for IndexService.CreateIndex. - type: object - id: GoogleCloudAiplatformV1CreateIndexOperationMetadata - GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors: + Required. The format in which Vertex AI gives the predictions, must + be one of the Model's supported_output_storage_formats. + type: string + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: >- + The Cloud Storage location of the directory where the output is to + be written to. In the given directory a new directory is created. + Its name is `prediction--`, where timestamp is in + YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files + `predictions_0001.`, `predictions_0002.`, ..., `predictions_N.` are + created where `` depends on chosen predictions_format, and N may + equal 0001 and depends on the total number of successfully predicted + instances. If the Model has both instance and prediction schemata + defined then each such file contains predictions as per the + predictions_format. If prediction for any instance failed (partially + or completely), then an additional `errors_0001.`, + `errors_0002.`,..., `errors_N.` files are created (N depends on + total number of failed predictions). These files contain the failed + instances, as per their schema, followed by an additional `error` + field which as value has google.rpc.Status containing only `code` + and `message` fields. + bigqueryDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + description: >- + The BigQuery project or dataset location where the output is to be + written to. If project is provided, a new dataset is created with + name `prediction__` where is made BigQuery-dataset-name compatible + (for example, most special characters become underscores), and + timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. + In the dataset two tables will be created, `predictions`, and + `errors`. If the Model has both instance and prediction schemata + defined then the tables have columns as follows: The `predictions` + table contains instances for which the prediction succeeded, it has + columns as per a concatenation of the Model's instance and + prediction schemata. The `errors` table contains rows for which the + prediction has failed, it has instance columns, as per the instance + schema, followed by a single "errors" column, which as values has + google.rpc.Status represented as a STRUCT, and containing only + `code` and `message`. type: object - id: GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors - description: Nearest neighbors for one query. + id: GoogleCloudAiplatformV1BatchPredictionJobOutputConfig + GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex: + description: Multiple setups to deploy the PublisherModel. properties: - neighbors: - description: All its neighbors. + multiDeployVertex: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNeighbor + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + description: Optional. One click deployment configurations. type: array - id: - description: The ID of the query datapoint. - type: string - GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi: type: object - description: Rest API docs. + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs + type: object properties: - title: - description: Required. The title of the view rest API. + predictionType: + description: >- + The type of prediction the Model is to produce. "classification" - + Predict one out of multiple target values is picked for each row. + "regression" - Predict a value based on its relation to other + values. This type is available only to columns that contain + semantically numeric values, i.e. integers or floating point number, + even if stored as e.g. strings. type: string - documentations: - type: array + targetColumn: + description: The column name of the target column that the model is to predict. + type: string + additionalExperiments: + description: Additional experiment flags for the Tables training pipeline. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelDocumentation - description: Required. - id: GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi - GoogleCloudAiplatformV1SummarizationQualitySpec: - properties: - version: - format: int32 - type: integer - description: Optional. Which version to use for evaluation. - useReference: + type: string + type: array + disableEarlyStopping: type: boolean description: >- - Optional. Whether to use instance.reference to compute summarization - quality. - type: object - id: GoogleCloudAiplatformV1SummarizationQualitySpec - description: Spec for summarization quality score metric. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics: - properties: - meanAveragePrecision: - description: The mean average precision, most often close to `auPrc`. - type: number - format: float - iouThreshold: + Use the entire training budget. This disables the early stopping + feature. By default, the early stopping feature is enabled, which + means that AutoML Tables might stop training before the entire + training budget has been used. + optimizationObjectivePrecisionValue: + description: >- + Required when optimization_objective is + "maximize-recall-at-precision". Must be between 0 and 1, inclusive. format: float type: number + optimizationObjectiveRecallValue: + format: float description: >- - The intersection-over-union threshold value used to compute this - metrics entry. - confidenceMetrics: - description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics - type: object - description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - GoogleCloudAiplatformV1NotebookRuntimeTemplateRef: - properties: - notebookRuntimeTemplate: - type: string - description: Immutable. A resource name of the NotebookRuntimeTemplate. - id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef - type: object - description: Points to a NotebookRuntimeTemplateRef. - GoogleCloudAiplatformV1BatchCreateFeaturesResponse: - id: GoogleCloudAiplatformV1BatchCreateFeaturesResponse - properties: - features: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - description: The Features created. - type: object - description: Response message for FeaturestoreService.BatchCreateFeatures. - GoogleCloudAiplatformV1FluencyInstance: - type: object - description: Spec for fluency instance. - id: GoogleCloudAiplatformV1FluencyInstance - properties: - prediction: + Required when optimization_objective is + "maximize-precision-at-recall". Must be between 0 and 1, inclusive. + type: number + weightColumnName: type: string - description: Required. Output of the evaluated model. - GoogleCloudAiplatformV1Schedule: - properties: - lastPauseTime: - format: google-datetime description: >- - Output only. Timestamp when this Schedule was last paused. Unset if - never paused. - readOnly: true + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. + exportEvaluatedDataItemsConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + description: >- + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + optimizationObjective: type: string - catchUp: - readOnly: true - type: boolean description: >- - Output only. Whether to backfill missed runs when the schedule is - resumed from PAUSED state. If set to true, all missed runs will be - scheduled. New runs will be scheduled after the backfill is - complete. Default to false. - maxRunCount: + Objective function the model is optimizing towards. The training + process creates a model that maximizes/minimizes the value of the + objective function over the validation set. The supported + optimization objectives depend on the prediction type. If the field + is not set, a default objective function is used. classification + (binary): "maximize-au-roc" (default) - Maximize the area under the + receiver operating characteristic (ROC) curve. "minimize-log-loss" - + Minimize log loss. "maximize-au-prc" - Maximize the area under the + precision-recall curve. "maximize-precision-at-recall" - Maximize + precision for a specified recall value. + "maximize-recall-at-precision" - Maximize recall for a specified + precision value. classification (multi-class): "minimize-log-loss" + (default) - Minimize log loss. regression: "minimize-rmse" (default) + - Minimize root-mean-squared error (RMSE). "minimize-mae" - Minimize + mean-absolute error (MAE). "minimize-rmsle" - Minimize + root-mean-squared log error (RMSLE). + trainBudgetMilliNodeHours: format: int64 type: string description: >- - Optional. Maximum run count of the schedule. If specified, The - schedule will be completed when either started_run_count >= - max_run_count or when end_time is reached. If not specified, new - runs will keep getting scheduled until this Schedule is paused or - deleted. Already scheduled runs will be allowed to complete. Unset - if not specified. - allowQueueing: - type: boolean + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. + transformations: description: >- - Optional. Whether new scheduled runs can be queued when - max_concurrent_runs limit is reached. If set to true, new runs will - be queued instead of skipped. Default to false. - createNotebookExecutionJobRequest: - description: Request for NotebookService.CreateNotebookExecutionJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest - state: - enum: - - STATE_UNSPECIFIED - - ACTIVE - - PAUSED - - COMPLETED + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation + type: array + GoogleCloudAiplatformV1AddTrialMeasurementRequest: + description: Request message for VizierService.AddTrialMeasurement. + type: object + id: GoogleCloudAiplatformV1AddTrialMeasurementRequest + properties: + measurement: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + description: Required. The measurement to be added to a Trial. + GoogleCloudAiplatformV1FeatureViewIndexConfig: + description: Configuration for vector indexing. + properties: + distanceMeasureType: enumDescriptions: - - Unspecified. - - >- - The Schedule is active. Runs are being scheduled on the - user-specified timespec. - - >- - The schedule is paused. No new runs will be created until the - schedule is resumed. Already started runs will be allowed to - complete. + - Should not be set. + - Euclidean (L_2) Distance. - >- - The Schedule is completed. No new runs will be scheduled. Already - started runs will be allowed to complete. Schedules in completed - state cannot be paused or resumed. - readOnly: true - description: Output only. The state of this Schedule. - type: string - cron: + Cosine Distance. Defined as 1 - cosine similarity. We strongly + suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of + COSINE distance. Our algorithms have been more optimized for + DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is + mathematically equivalent to COSINE distance and results in the + same ranking. + - Dot Product Distance. Defined as a negative of the dot product. + enum: + - DISTANCE_MEASURE_TYPE_UNSPECIFIED + - SQUARED_L2_DISTANCE + - COSINE_DISTANCE + - DOT_PRODUCT_DISTANCE + description: Optional. The distance measure used in nearest neighbor search. type: string + bruteForceConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig description: >- - Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch - scheduled runs. To explicitly set a timezone to the cron tab, apply - a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database. For example, - "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * - * *". - endTime: - description: >- - Optional. Timestamp after which no new runs can be scheduled. If - specified, The schedule will be completed when either end_time is - reached or when scheduled_run_count >= max_run_count. If not - specified, new runs will keep getting scheduled until this Schedule - is paused or deleted. Already scheduled runs will be allowed to - complete. Unset if not specified. - type: string - format: google-datetime - startTime: - format: google-datetime + Optional. Configuration options for using brute force search, which + simply implements the standard linear search in the database for + each query. It is primarily meant for benchmarking and to generate + the ground truth for approximate search. + filterColumns: + items: + type: string description: >- - Optional. Timestamp after which the first run can be scheduled. - Default to Schedule create time if not specified. - type: string - createPipelineJobRequest: + Optional. Columns of features that're used to filter vector search + results. + type: array + embeddingDimension: + format: int32 + description: Optional. The number of dimensions of the input embedding. + type: integer + crowdingColumn: description: >- - Request for PipelineService.CreatePipelineJob. - CreatePipelineJobRequest.parent field is required (format: - projects/{project}/locations/{location}). - $ref: '#/components/schemas/GoogleCloudAiplatformV1CreatePipelineJobRequest' - name: - description: Immutable. The resource name of the Schedule. + Optional. Column of crowding. This column contains crowding + attribute which is a constraint on a neighbor list produced by + FeatureOnlineStoreService.SearchNearestEntities to diversify search + results. If + NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to + K in SearchNearestEntitiesRequest, it's guaranteed that no more than + K entities of the same crowding attribute are returned in the + response. type: string - lastResumeTime: + embeddingColumn: type: string description: >- - Output only. Timestamp when this Schedule was last resumed. Unset if - never resumed from pause. - format: google-datetime - readOnly: true - createTime: - description: Output only. Timestamp when this Schedule was created. - format: google-datetime - readOnly: true - type: string - displayName: - type: string + Optional. Column of embedding. This column contains the source data + to create index for vector search. embedding_column must be set when + using vector search. + treeAhConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig description: >- - Required. User provided name of the Schedule. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - updateTime: - format: google-datetime - readOnly: true + Optional. Configuration options for the tree-AH algorithm (Shallow + tree + Asymmetric Hashing). Please refer to this paper for more + details: https://arxiv.org/abs/1908.10396 + id: GoogleCloudAiplatformV1FeatureViewIndexConfig + type: object + CloudAiLargeModelsVisionVideo: + properties: + uri: type: string - description: Output only. Timestamp when this Schedule was updated. - maxConcurrentRunCount: - description: >- - Required. Maximum number of runs that can be started concurrently - for this Schedule. This is the limit for starting the scheduled - requests and not the execution of the operations/jobs created by the - requests (if applicable). + description: Path to another storage (typically Google Cloud Storage). + video: + format: byte type: string - format: int64 - nextRunTime: - readOnly: true - description: >- - Output only. Timestamp when this Schedule should schedule the next - run. Having a next_run_time in the past means the runs are being - started behind schedule. + description: Raw bytes. + id: CloudAiLargeModelsVisionVideo + type: object + description: Video + GoogleCloudAiplatformV1AddContextChildrenResponse: + properties: {} + id: GoogleCloudAiplatformV1AddContextChildrenResponse + description: Response message for MetadataService.AddContextChildren. + type: object + GoogleCloudAiplatformV1ListTrainingPipelinesResponse: + type: object + properties: + nextPageToken: type: string - format: google-datetime - lastScheduledRunResponse: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ScheduleRunResponse' - readOnly: true description: >- - Output only. Response of the last scheduled run. This is the - response for starting the scheduled requests and not the execution - of the operations/jobs created by the requests (if applicable). - Unset if no run has been scheduled yet. - startedRunCount: - type: string - description: Output only. The number of runs started by this schedule. - format: int64 - readOnly: true - type: object - description: >- - An instance of a Schedule periodically schedules runs to make API calls - based on user specified time specification and API request type. - id: GoogleCloudAiplatformV1Schedule - GoogleCloudAiplatformV1CsvDestination: - description: The storage details for CSV output content. - id: GoogleCloudAiplatformV1CsvDestination - properties: - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Required. Google Cloud Storage location. - type: object - GoogleCloudAiplatformV1NasJobSpec: - properties: - multiTrialAlgorithmSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec - description: The spec of multi-trial algorithms. - searchSpaceSpec: - type: string - description: It defines the search space for Neural Architecture Search (NAS). - resumeNasJobId: - type: string - description: >- - The ID of the existing NasJob in the same Project and Location which - will be used to resume search. search_space_spec and - nas_algorithm_spec are obtained from previous NasJob hence should - not provide them again for this NasJob. - id: GoogleCloudAiplatformV1NasJobSpec - description: Represents the spec of a NasJob. - type: object - GoogleCloudAiplatformV1PointwiseMetricInput: - properties: - instance: - description: Required. Pointwise metric instance. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInstance' - metricSpec: - description: Required. Spec for pointwise metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricSpec' - type: object - description: Input for pointwise metric. - id: GoogleCloudAiplatformV1PointwiseMetricInput + A token to retrieve the next page of results. Pass to + ListTrainingPipelinesRequest.page_token to obtain that page. + trainingPipelines: + description: List of TrainingPipelines in the requested page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + id: GoogleCloudAiplatformV1ListTrainingPipelinesResponse + description: Response message for PipelineService.ListTrainingPipelines GoogleCloudAiplatformV1ListModelVersionsResponse: - description: Response message for ModelService.ListModelVersions + type: object properties: models: + type: array description: >- List of Model versions in the requested page. In the returned Model name field, version ID instead of regvision tag will be included. items: $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - type: array nextPageToken: + type: string description: >- A token to retrieve the next page of results. Pass to ListModelVersionsRequest.page_token to obtain that page. - type: string id: GoogleCloudAiplatformV1ListModelVersionsResponse - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation: + description: Response message for ModelService.ListModelVersions + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs: properties: - columnName: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation - type: object - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. - GoogleCloudAiplatformV1CancelCustomJobRequest: - properties: {} - description: Request message for JobService.CancelCustomJob. + sentimentMax: + format: int32 + description: >- + A sentiment is expressed as an integer ordinal, where higher value + means a more positive sentiment. The range of sentiments that will + be used is between 0 and sentimentMax (inclusive on both ends), and + all the values in the range must be represented in the dataset + before a model can be created. Only the Annotations with this + sentimentMax will be used for training. sentimentMax value must be + between 1 and 10 (inclusive). + type: integer type: object - id: GoogleCloudAiplatformV1CancelCustomJobRequest - GoogleCloudAiplatformV1ReadTensorboardUsageResponse: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs + GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset: properties: - monthlyUsageData: - description: Maps year-month (YYYYMM) string to per month usage data. - type: object - additionalProperties: + dataset: + type: string + description: >- + Full resource name of data labeling Dataset. Format: + `projects/{project}/datasets/{dataset}`. + dataLabelingAnnotatedDatasets: + type: array + description: >- + The migratable AnnotatedDataset in datalabeling.googleapis.com + belongs to the data labeling Dataset. + items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData - description: Response message for TensorboardService.ReadTensorboardUsage. - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponse + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset + datasetDisplayName: + type: string + description: The Dataset's display name in datalabeling.googleapis.com. + description: Represents one Dataset in datalabeling.googleapis.com. + id: GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset + type: object + CloudAiLargeModelsVisionGenerateVideoResponse: + description: Generate video response. type: object - GoogleCloudAiplatformV1GroundingSupport: - id: GoogleCloudAiplatformV1GroundingSupport properties: - confidenceScores: - description: >- - Confidence score of the support references. Ranges from 0 to 1. 1 is - the most confident. This list must have the same size as the - grounding_chunk_indices. + raiMediaFilteredReasons: + description: Returns rai failure reasons if any. items: - type: number - format: float + type: string type: array - groundingChunkIndices: - items: - format: int32 - type: integer - description: >- - A list of indices (into 'grounding_chunk') specifying the citations - associated with the claim. For instance [1,3,4] means that - grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the - retrieved content attributed to the claim. + generatedSamples: type: array - segment: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Segment' - description: Segment of the content this support belongs to. + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' + description: The generates samples. + raiMediaFilteredCount: + format: int32 + description: Returns if any videos were filtered due to RAI policies. + type: integer + id: CloudAiLargeModelsVisionGenerateVideoResponse + GoogleCloudAiplatformV1FeatureViewBigQuerySource: + id: GoogleCloudAiplatformV1FeatureViewBigQuerySource type: object - description: Grounding support. - GoogleCloudAiplatformV1ModelEvaluationSliceSlice: - description: Definition of a slice. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice properties: - sliceSpec: - readOnly: true - description: Output only. Specification for how the data was sliced. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec - dimension: + entityIdColumns: + items: + type: string + description: Required. Columns to construct entity_id / row keys. + type: array + uri: type: string description: >- - Output only. The dimension of the slice. Well-known dimensions are: - * `annotationSpec`: This slice is on the test data that has either - ground truth or prediction with AnnotationSpec.display_name equals - to value. * `slice`: This slice is a user customized slice defined - by its SliceSpec. - readOnly: true - value: - readOnly: true - type: string - description: Output only. The value of the dimension in this slice. + Required. The BigQuery view URI that will be materialized on each + sync trigger based on FeatureView.SyncConfig. + GoogleCloudAiplatformV1ListArtifactsResponse: + id: GoogleCloudAiplatformV1ListArtifactsResponse type: object - GoogleCloudAiplatformV1FeatureViewSyncSyncSummary: properties: - totalSlot: - type: string - readOnly: true - format: int64 - description: Output only. BigQuery slot milliseconds consumed for the sync job. - systemWatermarkTime: - format: google-datetime + nextPageToken: type: string description: >- - Lower bound of the system time watermark for the sync job. This is - only set for continuously syncing feature views. - rowSynced: - format: int64 - readOnly: true - type: string - description: Output only. Total number of rows synced. + A token, which can be sent as ListArtifactsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. + artifacts: + description: The Artifacts retrieved from the MetadataStore. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + type: array + description: Response message for MetadataService.ListArtifacts. + GoogleCloudAiplatformV1GroundednessSpec: + properties: + version: + description: Optional. Which version to use for evaluation. + format: int32 + type: integer + description: Spec for groundedness metric. + id: GoogleCloudAiplatformV1GroundednessSpec type: object - id: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary - description: >- - Summary from the Sync job. For continuous syncs, the summary is updated - periodically. For batch syncs, it gets updated on completion of the - sync. - GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig: + GoogleCloudAiplatformV1DirectPredictResponse: + id: GoogleCloudAiplatformV1DirectPredictResponse properties: - deployedModelId: - description: The DeployedModel ID of the objective config. - type: string - objectiveConfig: - description: >- - The objective config of for the modelmonitoring job of this deployed - model. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + outputs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: array + description: The prediction output. + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. type: object - description: >- - ModelDeploymentMonitoringObjectiveConfig contains the pair of - deployed_model_id to ModelMonitoringObjectiveConfig. - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig: - description: >- - Config for migrating AnnotatedDataset in datalabeling.googleapis.com to - Vertex AI's SavedQuery. + description: Response message for PredictionService.DirectPredict. + GoogleCloudAiplatformV1PublisherModelCallToActionDeploy: + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy type: object - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig properties: - annotatedDataset: + containerSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' description: >- - Required. Full resource name of data labeling AnnotatedDataset. - Format: - `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. - type: string - GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance: - type: object - description: Prediction input format for Video Object Tracking. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance - properties: - timeSegmentEnd: + Optional. The specification of the container that is to be used when + deploying this Model in Vertex AI. Not present for Large Models. + automaticResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + description: >- + A description of resources that to large degree are decided by + Vertex AI, and require only a modest additional configuration. + title: + description: Required. The title of the regional resource reference. type: string + artifactUri: description: >- - The end, exclusive, of the video's time segment on which to perform - the prediction. Expressed as a number of seconds as measured from - the start of the video, with "s" appended at the end. Fractions are - allowed, up to a microsecond precision, and "inf" or "Infinity" is - allowed, which means the end of the video. - content: + Optional. The path to the directory containing the Model artifact + and any of its supporting files. + type: string + modelDisplayName: + description: Optional. Default model display name. + type: string + largeModelReference: description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. + Optional. Large model reference. When this is set, + model_artifact_spec is not needed. + $ref: '#/components/schemas/GoogleCloudAiplatformV1LargeModelReference' + publicArtifactUri: type: string - mimeType: description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime + Optional. The signed URI for ephemeral Cloud Storage access to model + artifact. + sharedResources: + description: >- + The resource name of the shared DeploymentResourcePool to deploy on. + Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` type: string - timeSegmentStart: + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. + A description of resources that are dedicated to the DeployedModel, + and that need a higher degree of manual configuration. + deployMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata + description: Optional. Metadata information about this deployment config. + deployTaskName: + description: >- + Optional. The name of the deploy task (e.g., "text to image + generation"). type: string - GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance: - description: Spec for question answering correctness instance. + description: >- + Model metadata that is needed for UploadModel or + DeployModel/CreateEndpoint requests. + GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest: + properties: {} + description: Request message for JobService.ResumeModelDeploymentMonitoringJob. + type: object + id: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + GoogleCloudAiplatformV1NotebookRuntime: + id: GoogleCloudAiplatformV1NotebookRuntime type: object - id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance properties: - reference: - type: string - description: Optional. Ground truth used to compare against the prediction. - prediction: + serviceAccount: + readOnly: true + description: >- + Output only. The service account that the NotebookRuntime workload + runs as. type: string - description: Required. Output of the evaluated model. - context: + healthState: type: string - description: Optional. Text provided as context to answer the question. - instruction: + enumDescriptions: + - Unspecified health state. + - NotebookRuntime is in healthy state. Applies to ACTIVE state. + - NotebookRuntime is in unhealthy state. Applies to ACTIVE state. + readOnly: true + enum: + - HEALTH_STATE_UNSPECIFIED + - HEALTHY + - UNHEALTHY + description: Output only. The health state of the NotebookRuntime. + idleShutdownConfig: + description: >- + Output only. The idle shutdown configuration of the notebook + runtime. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + readOnly: true + displayName: type: string description: >- - Required. The question asked and other instruction in the inference - prompt. - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity: - type: object - description: >- - Message to select entity. If an entity id is selected, all the feature - values corresponding to the entity id will be deleted, including the - entityId. - properties: - entityIdSelector: + Required. The display name of the NotebookRuntime. The name can be + up to 128 characters long and can consist of any UTF-8 characters. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + description: + description: The description of the NotebookRuntime. + type: string + version: + description: Output only. The VM os image version of NotebookRuntime. + type: string + readOnly: true + isUpgradable: + readOnly: true + description: Output only. Whether NotebookRuntime is upgradable. + type: boolean + notebookRuntimeType: + description: Output only. The type of the notebook runtime. + readOnly: true + enumDescriptions: + - >- + Unspecified notebook runtime type, NotebookRuntimeType will + default to USER_DEFINED. + - runtime or template with coustomized configurations from user. + - runtime or template with system defined configurations. + enum: + - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED + - USER_DEFINED + - ONE_CLICK + type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Required. Selectors choosing feature values of which entity id to be - deleted from the EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityIdSelector' - id: GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity - GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams: - description: Prediction model parameters for Image Object Detection. - type: object - properties: - confidenceThreshold: + Output only. Customer-managed encryption key spec for the notebook + runtime. + readOnly: true + notebookRuntimeTemplateRef: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplateRef description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - format: float - type: number - maxPredictions: + Output only. The pointer to NotebookRuntimeTemplate this + NotebookRuntime is created from. + readOnly: true + expirationTime: + readOnly: true + type: string description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. Note that number of returned predictions - is also limited by metadata's predictionsLimit. Default value is 10. - format: int32 - type: integer - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams - GoogleCloudAiplatformV1FeatureValueMetadata: - description: Metadata of feature value. - type: object - id: GoogleCloudAiplatformV1FeatureValueMetadata - properties: - generateTime: + Output only. Timestamp when this NotebookRuntime will be expired: 1. + System Predefined NotebookRuntime: 24 hours after creation. After + expiration, system predifined runtime will be deleted. 2. User + created NotebookRuntime: 6 months after last upgrade. After + expiration, user created runtime will be stopped and allowed for + upgrade. format: google-datetime + updateTime: description: >- - Feature generation timestamp. Typically, it is provided by user at - feature ingestion time. If not, feature store will use the system - timestamp when the data is ingested into feature store. For - streaming ingestion, the time, aligned by days, must be no older - than five years (1825 days) and no later than one year (366 days) in - the future. + Output only. Timestamp when this NotebookRuntime was most recently + updated. type: string - GoogleCloudAiplatformV1EvaluateInstancesRequest: - type: object - id: GoogleCloudAiplatformV1EvaluateInstancesRequest - properties: - bleuInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInput' - description: Instances and metric spec for bleu metric. - questionAnsweringCorrectnessInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput - description: Input for question answering correctness metric. - summarizationQualityInput: - description: Input for summarization quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInput - toolParameterKvMatchInput: - description: Input for tool parameter key value match metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInput - pairwiseSummarizationQualityInput: - description: Input for pairwise summarization quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInput - pairwiseQuestionAnsweringQualityInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput - description: Input for pairwise question answering quality metric. - fulfillmentInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInput' - description: Input for fulfillment metric. - groundednessInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInput' - description: Input for groundedness metric. - safetyInput: - description: Input for safety metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInput' - pointwiseMetricInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInput' - description: Input for pointwise metric. - summarizationHelpfulnessInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInput - description: Input for summarization helpfulness metric. - toolNameMatchInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInput' - description: Input for tool name match metric. - summarizationVerbosityInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInput - description: Input for summarization verbosity metric. - toolCallValidInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInput' - description: Tool call metric instances. Input for tool call valid metric. - questionAnsweringRelevanceInput: - description: Input for question answering relevance metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput - coherenceInput: - description: Input for coherence metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInput' - exactMatchInput: - description: >- - Auto metric instances. Instances and metric spec for exact match - metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInput' - questionAnsweringHelpfulnessInput: - description: Input for question answering helpfulness metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput - rougeInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInput' - description: Instances and metric spec for rouge metric. - pairwiseMetricInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInput' - description: Input for pairwise metric. - questionAnsweringQualityInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInput - description: Input for question answering quality metric. - toolParameterKeyMatchInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInput - description: Input for tool parameter key match metric. - fluencyInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInput' - description: >- - LLM-based metric instance. General text generation metrics, - applicable to other categories. Input for fluency metric. - description: Request message for EvaluationService.EvaluateInstances. - GoogleCloudAiplatformV1SummarizationVerbosityInput: - type: object - id: GoogleCloudAiplatformV1SummarizationVerbosityInput - properties: - metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbositySpec - description: Required. Spec for summarization verbosity score metric. - instance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInstance - description: Required. Summarization verbosity instance. - description: Input for summarization verbosity metric. - GoogleCloudAiplatformV1ExactMatchMetricValue: - id: GoogleCloudAiplatformV1ExactMatchMetricValue - properties: - score: - format: float - type: number - description: Output only. Exact match score. + format: google-datetime readOnly: true - description: Exact match metric value for an instance. - type: object - GoogleCloudAiplatformV1ListPersistentResourcesResponse: - type: object - properties: - persistentResources: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' - type: array - nextPageToken: + proxyUri: type: string - description: >- - A token to retrieve next page of results. Pass to - ListPersistentResourcesRequest.page_token to obtain that page. - id: GoogleCloudAiplatformV1ListPersistentResourcesResponse - description: Response message for PersistentResourceService.ListPersistentResources - GoogleCloudAiplatformV1UndeployModelRequest: - id: GoogleCloudAiplatformV1UndeployModelRequest - description: Request message for EndpointService.UndeployModel. - type: object - properties: - trafficSplit: - additionalProperties: - format: int32 - type: integer - description: >- - If this field is provided, then the Endpoint's traffic_split will be - overwritten with it. If last DeployedModel is being undeployed from - the Endpoint, the [Endpoint.traffic_split] will always end up empty - when this call returns. A DeployedModel will be successfully - undeployed only if it doesn't have any traffic assigned to it when - this method executes, or if this field unassigns any traffic to it. - type: object - deployedModelId: + description: Output only. The proxy endpoint used to access the NotebookRuntime. + readOnly: true + runtimeState: + readOnly: true + enumDescriptions: + - Unspecified runtime state. + - NotebookRuntime is in running state. + - NotebookRuntime is in starting state. + - NotebookRuntime is in stopping state. + - NotebookRuntime is in stopped state. + - >- + NotebookRuntime is in upgrading state. It is in the middle of + upgrading process. + - NotebookRuntime was unable to start/stop properly. + - NotebookRuntime is in invalid state. Cannot be recovered. + enum: + - RUNTIME_STATE_UNSPECIFIED + - RUNNING + - BEING_STARTED + - BEING_STOPPED + - STOPPED + - BEING_UPGRADED + - ERROR + - INVALID + description: Output only. The runtime (instance) state of the NotebookRuntime. type: string - description: >- - Required. The ID of the DeployedModel to be undeployed from the - Endpoint. - GoogleCloudAiplatformV1ExplainResponse: - id: GoogleCloudAiplatformV1ExplainResponse - properties: - deployedModelId: - description: ID of the Endpoint's DeployedModel that served this explanation. + name: + description: Output only. The resource name of the NotebookRuntime. type: string - predictions: - items: - type: any - type: array + readOnly: true + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. Timestamp when this NotebookRuntime was created. + networkTags: description: >- - The predictions that are the output of the predictions call. Same as - PredictResponse.predictions. - explanations: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + Optional. The Compute Engine tags to add to runtime (see [Tagging + instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). type: array - description: >- - The explanations of the Model's PredictResponse.predictions. It has - the same number of elements as instances to be explained. - description: Response message for PredictionService.Explain. - type: object - GoogleCloudAiplatformV1IndexDatapointRestriction: - properties: - denyList: items: type: string - type: array - description: 'The attributes to deny in this namespace. e.g.: ''blue''' - allowList: - type: array - items: + labels: + description: >- + The labels with user-defined metadata to organize your + NotebookRuntime. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. No more than 64 user labels can be associated with one + NotebookRuntime (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for NotebookRuntime: * + "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output + only, its value is the Compute Engine instance id. * + "aiplatform.googleapis.com/colab_enterprise_entry_service": its + value is either "bigquery" or "vertex"; if absent, it should be + "vertex". This is to describe the entry service, either BigQuery or + Vertex. + additionalProperties: type: string - description: 'The attributes to allow in this namespace. e.g.: ''red''' - namespace: + type: object + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + runtimeUser: type: string - description: 'The namespace of this restriction. e.g.: color.' - type: object - id: GoogleCloudAiplatformV1IndexDatapointRestriction + description: Required. The user email of the NotebookRuntime. description: >- - Restriction of a datapoint which describe its attributes(tokens) from - each of several attribute categories(namespaces). - GoogleCloudAiplatformV1SearchNearestEntitiesRequest: - id: GoogleCloudAiplatformV1SearchNearestEntitiesRequest + A runtime is a virtual machine allocated to a particular user for a + particular Notebook file on temporary basis with lifetime limited to 24 + hours. + GoogleCloudAiplatformV1ExamplesExampleGcsSource: + id: GoogleCloudAiplatformV1ExamplesExampleGcsSource + description: The Cloud Storage input instances. + type: object properties: - query: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighborQuery' - description: Required. The query. - returnFullEntity: - type: boolean + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: The Cloud Storage location for the input instances. + dataFormat: + type: string + enumDescriptions: + - Format unspecified, used when unset. + - Examples are stored in JSONL files. + enum: + - DATA_FORMAT_UNSPECIFIED + - JSONL description: >- - Optional. If set to true, the full entities (including all vector - values and metadata) of the nearest neighbors are returned; - otherwise only entity id of the nearest neighbors will be returned. - Note that returning full entities will significantly increase the - latency and cost of the query. - description: The request message for FeatureOnlineStoreService.SearchNearestEntities. - type: object - GoogleCloudAiplatformV1ToolParameterKVMatchInstance: - id: GoogleCloudAiplatformV1ToolParameterKVMatchInstance - type: object + The format in which instances are given, if not specified, assume + it's JSONL format. Currently only JSONL format is supported. + GoogleCloudAiplatformV1SearchEntryPoint: + id: GoogleCloudAiplatformV1SearchEntryPoint + description: Google search entry point. properties: - prediction: - description: Required. Output of the evaluated model. + renderedContent: type: string - reference: + description: >- + Optional. Web content snippet that can be embedded in a web page or + an app webview. + sdkBlob: + format: byte type: string - description: Required. Ground truth used to compare against the prediction. - description: Spec for tool parameter key value match instance. - GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata: + description: Optional. Base64 encoded JSON representing array of tuple. type: object + GoogleCloudAiplatformV1SafetyInput: + description: Input for safety metric. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore export Feature values. - description: Details of operations that exports Features values. - id: GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata - GoogleCloudAiplatformV1UndeployModelResponse: - id: GoogleCloudAiplatformV1UndeployModelResponse + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySpec' + description: Required. Spec for safety metric. + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInstance' + description: Required. Safety instance. + id: GoogleCloudAiplatformV1SafetyInput type: object - properties: {} - description: Response message for EndpointService.UndeployModel. + GoogleCloudAiplatformV1ErrorAnalysisAnnotation: + id: GoogleCloudAiplatformV1ErrorAnalysisAnnotation + properties: + attributedItems: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem + description: >- + Attributed items for a given annotation, typically representing + neighbors from the training sets constrained by the query type. + type: array + outlierThreshold: + type: number + description: >- + The threshold used to determine if this annotation is an outlier or + not. + format: double + queryType: + enumDescriptions: + - Unspecified query type for model error analysis. + - Query similar samples across all classes in the dataset. + - Query similar samples from the same class of the input sample. + - Query dissimilar samples from the same class of the input sample. + enum: + - QUERY_TYPE_UNSPECIFIED + - ALL_SIMILAR + - SAME_CLASS_SIMILAR + - SAME_CLASS_DISSIMILAR + type: string + description: The query type used for finding the attributed items. + outlierScore: + description: >- + The outlier score of this annotated item. Usually defined as the min + of all distances from attributed items. + type: number + format: double + type: object + description: Model error analysis for each annotation. GoogleCloudAiplatformV1StreamingPredictRequest: + description: >- + Request message for PredictionService.StreamingPredict. The first + message must contain endpoint field and optionally input. The subsequent + messages must contain input. id: GoogleCloudAiplatformV1StreamingPredictRequest properties: - parameters: - description: The parameters that govern the prediction. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' inputs: type: array items: $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' description: The prediction input. + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. type: object - description: >- - Request message for PredictionService.StreamingPredict. The first - message must contain endpoint field and optionally input. The subsequent - messages must contain input. - GoogleCloudAiplatformV1NearestNeighborsNeighbor: - id: GoogleCloudAiplatformV1NearestNeighborsNeighbor + GoogleCloudAiplatformV1ExportModelResponse: + type: object + properties: {} + description: Response message of ModelService.ExportModel operation. + id: GoogleCloudAiplatformV1ExportModelResponse + GoogleCloudAiplatformV1CsvDestination: + type: object + description: The storage details for CSV output content. + id: GoogleCloudAiplatformV1CsvDestination properties: - entityKeyValues: + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Required. Google Cloud Storage location. + GoogleCloudAiplatformV1TuningDataStats: + id: GoogleCloudAiplatformV1TuningDataStats + properties: + supervisedTuningDataStats: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats + description: The SFT Tuning data stats. + type: object + description: The tuning data statistic values for TuningJob. + CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: + type: object + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + description: >- + An integer bounding box of original pixels of the image for the detected + labels. + properties: + y1: + format: int32 + description: The Y coordinate of the top-left corner, in pixels. + type: integer + x2: + type: integer + description: The X coordinate of the bottom-right corner, in pixels. + format: int32 + y2: + format: int32 + type: integer + description: The Y coordinate of the bottom-right corner, in pixels. + x1: + format: int32 + description: The X coordinate of the top-left corner, in pixels. + type: integer + GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: + id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + type: object + properties: + samplingRate: description: >- - The attributes of the neighbor, e.g. filters, crowding and metadata - Note that full entities are returned only when "return_full_entity" - is set to true. Otherwise, only the "entity_id" and "distance" - fields are populated. - distance: - format: double - description: The distance between the neighbor and the query vector. + Percentage of requests to be logged, expressed as a fraction in + range(0,1]. type: number - entityId: - type: string - description: The id of the similar entity. - description: A neighbor of the query vector. - type: object - GoogleCloudAiplatformV1ListFeatureGroupsResponse: - id: GoogleCloudAiplatformV1ListFeatureGroupsResponse + format: double + enabled: + type: boolean + description: If logging is enabled or not. + bigqueryDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + description: >- + BigQuery table for logging. If only given a project, a new dataset + will be created with name `logging__` where will be made + BigQuery-dataset-name compatible (e.g. most special characters will + become underscores). If no table name is given, a new table will be + created with name `request_response_logging` + description: Configuration for logging request-response to a BigQuery table. + GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata: + id: GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata + description: Details of operations that perform reboot PersistentResource. properties: - featureGroups: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' - description: The FeatureGroups matching the request. - type: array - nextPageToken: + progressMessage: + description: Progress Message for Reboot LRO type: string - description: >- - A token, which can be sent as ListFeatureGroupsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - description: Response message for FeatureRegistryService.ListFeatureGroups. + genericMetadata: + description: Operation metadata for PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' type: object - GoogleCloudAiplatformV1SafetyInput: + GoogleCloudAiplatformV1ToolParameterKVMatchInstance: + description: Spec for tool parameter key value match instance. type: object - description: Input for safety metric. + id: GoogleCloudAiplatformV1ToolParameterKVMatchInstance properties: - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySpec' - description: Required. Spec for safety metric. - instance: - description: Required. Safety instance. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInstance' - id: GoogleCloudAiplatformV1SafetyInput - GoogleCloudAiplatformV1TensorboardRun: - description: >- - TensorboardRun maps to a specific execution of a training job with a - given set of hyperparameter values, model definition, dataset, etc - id: GoogleCloudAiplatformV1TensorboardRun + reference: + description: Required. Ground truth used to compare against the prediction. + type: string + prediction: + type: string + description: Required. Output of the evaluated model. + GoogleCloudAiplatformV1SchemaAnnotationSpecColor: type: object + description: >- + An entry of mapping between color and AnnotationSpec. The mapping is + used in segmentation mask. + id: GoogleCloudAiplatformV1SchemaAnnotationSpecColor properties: - createTime: - description: Output only. Timestamp when this TensorboardRun was created. - format: google-datetime - readOnly: true + displayName: type: string - name: - readOnly: true description: >- - Output only. Name of the TensorboardRun. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - type: string - updateTime: + The display name of the AnnotationSpec represented by the color in + the segmentation mask. + id: + description: >- + The ID of the AnnotationSpec represented by the color in the + segmentation mask. type: string - description: Output only. Timestamp when this TensorboardRun was last updated. - format: google-datetime - readOnly: true - displayName: + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: The color of the AnnotationSpec in a segmentation mask. + GoogleCloudAiplatformV1UserActionReference: + type: object + properties: + dataLabelingJob: type: string description: >- - Required. User provided name of this TensorboardRun. This value must - be unique among all TensorboardRuns belonging to the same parent - TensorboardExperiment. - etag: - type: string + For API calls that start a LabelingJob. Resource name of the + LabelingJob. Format: + `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + method: description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - description: + The method name of the API RPC call. For example, + "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset" type: string - description: Description of this TensorboardRun. - labels: - additionalProperties: - type: string - type: object + operation: description: >- - The labels with user-defined metadata to organize your - TensorboardRuns. This field will be used to filter and visualize - Runs in the Tensorboard UI. For example, a Vertex AI training job - can set a label aiplatform.googleapis.com/training_job_id=xxxxx to - all the runs created within that job. An end user can set a label - experiment_id=xxxxx for all the runs produced in a Jupyter notebook. - These runs can be grouped by a label value and visualized together - in the Tensorboard UI. Label keys and values can be no longer than - 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. No more than 64 user labels can be - associated with one TensorboardRun (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - GoogleCloudAiplatformV1PipelineJobDetail: - description: The runtime detail of PipelineJob. + For API calls that return a long running operation. Resource name of + the long running operation. Format: + `projects/{project}/locations/{location}/operations/{operation}` + type: string + description: >- + References an API call. It contains more information about long running + operation and Jobs that are triggered by the API call. + id: GoogleCloudAiplatformV1UserActionReference + GoogleCloudAiplatformV1TunedModel: + description: >- + The Model Registry Model and Online Prediction Endpoint assiociated with + this TuningJob. type: object - id: GoogleCloudAiplatformV1PipelineJobDetail properties: - taskDetails: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetail' - description: Output only. The runtime details of the tasks under the pipeline. - readOnly: true - type: array - pipelineContext: + model: readOnly: true - description: Output only. The context of the pipeline. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - pipelineRunContext: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + type: string + description: >- + Output only. The resource name of the TunedModel. Format: + `projects/{project}/locations/{location}/models/{model}`. + endpoint: + type: string + description: >- + Output only. A resource name of an Endpoint. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}`. readOnly: true - description: Output only. The context of the current pipeline run. - GoogleCloudAiplatformV1ExplanationSpecOverride: + id: GoogleCloudAiplatformV1TunedModel + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation: description: >- - The ExplanationSpec entries that can be overridden at online explanation - time. + Treats the column as categorical array and performs following + transformation functions. * For each element in the array, convert the + category name to a dictionary lookup index and generate an embedding for + each index. Combine the embedding of all elements into a single + embedding using the mean. * Empty arrays treated as an embedding of + zeroes. + properties: + columnName: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + type: object + GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance: + description: Prediction input format for Video Object Tracking. type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance properties: - metadata: + content: description: >- - The metadata to be overridden. If not specified, no metadata is - overridden. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverride - examplesOverride: - description: The example-based explanations parameter overrides. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesOverride' - parameters: + The Google Cloud Storage location of the video on which to perform + the prediction. + type: string + timeSegmentEnd: description: >- - The parameters to be overridden. Note that the attribution method - cannot be changed. If not specified, no parameter is overridden. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' - id: GoogleCloudAiplatformV1ExplanationSpecOverride - GoogleCloudAiplatformV1SchemaImageDatasetMetadata: + The end, exclusive, of the video's time segment on which to perform + the prediction. Expressed as a number of seconds as measured from + the start of the video, with "s" appended at the end. Fractions are + allowed, up to a microsecond precision, and "inf" or "Infinity" is + allowed, which means the end of the video. + type: string + mimeType: + description: >- + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime + type: string + timeSegmentStart: + description: >- + The beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. + type: string + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature: + id: >- + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature + description: >- + Message to select time range and feature. Values of the selected feature + generated within an inclusive time range will be deleted. Using this + option permanently deletes the feature values from the specified feature + IDs within the specified time range. This might include data from the + online storage. If you want to retain any deleted historical data in the + online storage, you must re-ingest it. type: object properties: - gcsBucket: + skipOnlineStorageDelete: description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. + If set, data will not be deleted from online storage. When time + range is older than the data in online storage, setting this to be + true will make the deletion have no impact on online serving. + type: boolean + timeRange: + description: >- + Required. Select feature generated within a half-inclusive time + range. The time range is lower inclusive and upper exclusive. + $ref: '#/components/schemas/GoogleTypeInterval' + featureSelector: + description: >- + Required. Selectors choosing which feature values to be deleted from + the EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + GoogleCloudAiplatformV1SchemaImageClassificationAnnotation: + properties: + annotationSpecId: type: string - dataItemSchemaUri: + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + displayName: type: string description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Image DataItems that belong to this Dataset. - id: GoogleCloudAiplatformV1SchemaImageDatasetMetadata - description: The metadata of Datasets that contain Image DataItems. - GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult: + The display name of the AnnotationSpec that this Annotation pertains + to. + id: GoogleCloudAiplatformV1SchemaImageClassificationAnnotation + description: Annotation details specific to image classification. type: object - description: Spec for question answering helpfulness result. - id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult + GoogleCloudAiplatformV1SchemaTextSentimentAnnotation: + type: object + id: GoogleCloudAiplatformV1SchemaTextSentimentAnnotation properties: - explanation: - readOnly: true + displayName: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. type: string - description: Output only. Explanation for question answering helpfulness score. - score: - type: number - format: float - readOnly: true - description: Output only. Question Answering Helpfulness score. - confidence: - format: float - readOnly: true - type: number - description: Output only. Confidence for question answering helpfulness score. - GoogleCloudAiplatformV1DeployIndexRequest: - description: Request message for IndexEndpointService.DeployIndex. + sentimentMax: + format: int32 + description: The sentiment max score for text. + type: integer + sentiment: + format: int32 + type: integer + description: The sentiment score for text. + annotationSpecId: + type: string + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + description: Annotation details specific to text sentiment. + GoogleCloudAiplatformV1UpdateFeatureOperationMetadata: type: object + description: Details of operations that perform update Feature. + id: GoogleCloudAiplatformV1UpdateFeatureOperationMetadata properties: - deployedIndex: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - description: Required. The DeployedIndex to be created within the IndexEndpoint. - id: GoogleCloudAiplatformV1DeployIndexRequest - GoogleCloudAiplatformV1PairwiseSummarizationQualityResult: + genericMetadata: + description: Operation metadata for Feature Update. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1StreamRawPredictRequest: + properties: + httpBody: + description: >- + The prediction input. Supports HTTP headers and arbitrary data + payload. + $ref: '#/components/schemas/GoogleApiHttpBody' + type: object + description: Request message for PredictionService.StreamRawPredict. + id: GoogleCloudAiplatformV1StreamRawPredictRequest + GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource: + description: >- + A Feature Registry source for features that need to be synced to Online + Store. type: object - id: GoogleCloudAiplatformV1PairwiseSummarizationQualityResult - description: Spec for pairwise summarization quality result. properties: - explanation: - readOnly: true + projectNumber: type: string - description: Output only. Explanation for summarization quality score. - confidence: + description: >- + Optional. The project number of the parent project of the Feature + Groups. + format: int64 + featureGroups: + description: Required. List of features that need to be synced to Online Store. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup + type: array + id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource + GoogleCloudAiplatformV1TrialParameter: + id: GoogleCloudAiplatformV1TrialParameter + description: A message representing a parameter to be tuned. + properties: + parameterId: + type: string + description: >- + Output only. The ID of the parameter. The parameter should be + defined in StudySpec's Parameters. readOnly: true - description: Output only. Confidence for summarization quality score. - format: float - type: number - pairwiseChoice: - description: Output only. Pairwise summarization prediction choice. - enum: - - PAIRWISE_CHOICE_UNSPECIFIED - - BASELINE - - CANDIDATE - - TIE - enumDescriptions: - - Unspecified prediction choice. - - Baseline prediction wins - - Candidate prediction wins - - Winner cannot be determined + value: readOnly: true - type: string - GoogleCloudAiplatformV1ModelBaseModelSource: + description: >- + Output only. The value of the parameter. `number_value` will be set + if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' + or 'DISCRETE'. `string_value` will be set if a parameter defined in + StudySpec is in type 'CATEGORICAL'. + type: any type: object - id: GoogleCloudAiplatformV1ModelBaseModelSource - description: >- - User input field to specify the base model source. Currently it only - supports specifing the Model Garden models and Genie models. + GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata: properties: - modelGardenSource: - description: Source information of Model Garden models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelGardenSource' - genieSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenieSource' - description: Information about the base model of Genie models. - GoogleCloudAiplatformV1PairwiseMetricInput: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: >- + GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata type: object + description: >- + Runtime operation information for + JobService.UpdateModelDeploymentMonitoringJob. + GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec: + description: >- + The median automated stopping rule stops a pending Trial if the Trial's + best objective_value is strictly below the median 'performance' of all + completed Trials reported up to the Trial's last measurement. Currently, + 'performance' refers to the running average of the objective values + reported by the Trial in each measurement. + id: GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec properties: - instance: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInstance' - description: Required. Pairwise metric instance. - metricSpec: - description: Required. Spec for pairwise metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricSpec' - id: GoogleCloudAiplatformV1PairwiseMetricInput - description: Input for pairwise metric. - GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry: + useElapsedDuration: + type: boolean + description: >- + True if median automated stopping rule applies on + Measurement.elapsed_duration. It means that elapsed_duration field + of latest measurement of current Trial is used to compute median + objective value for each completed Trials. type: object - description: Single source entry for the grounding checking. + GoogleCloudAiplatformV1SummarizationHelpfulnessInstance: + description: Spec for summarization helpfulness instance. + type: object + id: GoogleCloudAiplatformV1SummarizationHelpfulnessInstance properties: - type: + reference: type: string - enumDescriptions: - - '' - - Uses Web Search to check the grounding. - - >- - Uses Vertex AI Search to check the grounding. Deprecated. Use - VERTEX_AI_SEARCH instead. - - Uses Vertex AI Search to check the grounding - - Uses inline context to check the grounding. - enumDeprecated: - - false - - false - - true - - false - - false - enum: - - UNSPECIFIED - - WEB - - ENTERPRISE - - VERTEX_AI_SEARCH - - INLINE - description: The type of the grounding checking source. - inlineContext: - description: >- - The grounding text passed inline with the Predict API. It can - support up to 1 million bytes. + description: Optional. Ground truth used to compare against the prediction. + instruction: type: string - enterpriseDatastore: - deprecated: true - description: >- - The uri of the Vertex AI Search data source. Deprecated. Use - vertex_ai_search_datastore instead. + description: Optional. Summarization prompt for LLM. + context: type: string - vertexAiSearchDatastore: - description: The uri of the Vertex AI Search data source. + description: Required. Text to be summarized. + prediction: type: string - id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry - GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor: + description: Required. Output of the evaluated model. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + type: object properties: - id: - description: Feature ID. + evaluatedDataItemsBigqueryUri: type: string + description: BigQuery destination uri for exported evaluated examples. + trainCostMilliNodeHours: + type: string + description: >- + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + format: int64 + description: Model metadata specific to TFT Forecasting. + GoogleCloudAiplatformV1LineageSubgraph: + description: >- + A subgraph of the overall lineage graph. Event edges connect Artifact + and Execution nodes. + properties: + executions: + description: The Execution nodes in the subgraph. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + events: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' + description: The Event edges between Artifacts and Executions in the subgraph. + artifacts: + description: The Artifact nodes in the subgraph. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' type: object - description: Metadata for requested Features. - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor - GoogleLongrunningListOperationsResponse: - type: object + id: GoogleCloudAiplatformV1LineageSubgraph + GoogleIamV1Binding: properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: + members: type: array items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + type: string description: >- - A list of operations that matches the specified filter in the - request. - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - GoogleCloudAiplatformV1ToolCallValidInput: - description: Input for tool call valid metric. + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + description: Associates `members`, or principals, with a `role`. + type: object + id: GoogleIamV1Binding + GoogleCloudAiplatformV1SummarizationQualitySpec: + id: GoogleCloudAiplatformV1SummarizationQualitySpec + description: Spec for summarization quality score metric. type: object properties: - instances: + version: + format: int32 + type: integer + description: Optional. Which version to use for evaluation. + useReference: + description: >- + Optional. Whether to use instance.reference to compute summarization + quality. + type: boolean + GoogleCloudAiplatformV1ExactMatchResults: + properties: + exactMatchMetricValues: + readOnly: true items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInstance' - description: Required. Repeated tool call valid instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchMetricValue' + description: Output only. Exact match metric values. type: array - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidSpec' - description: Required. Spec for tool call valid metric. - id: GoogleCloudAiplatformV1ToolCallValidInput - GoogleCloudAiplatformV1EvaluateInstancesResponse: - properties: - pairwiseQuestionAnsweringQualityResult: - description: Result for pairwise question answering quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult - rougeResults: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeResults' - description: Results for rouge metric. - fluencyResult: - description: >- - LLM-based metric evaluation result. General text generation metrics, - applicable to other categories. Result for fluency metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyResult' - toolNameMatchResults: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchResults' - description: Results for tool name match metric. - pointwiseMetricResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricResult' - description: Generic metrics. Result for pointwise metric. - questionAnsweringRelevanceResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult - description: Result for question answering relevance metric. - pairwiseMetricResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricResult' - description: Result for pairwise metric. - questionAnsweringQualityResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityResult - description: >- - Question answering only metrics. Result for question answering - quality metric. - summarizationVerbosityResult: - description: Result for summarization verbosity metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityResult - summarizationQualityResult: - description: Summarization only metrics. Result for summarization quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityResult - groundednessResult: - description: Result for groundedness metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessResult' - exactMatchResults: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchResults' - description: Auto metric evaluation results. Results for exact match metric. - bleuResults: - description: Results for bleu metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuResults' - toolParameterKeyMatchResults: - description: Results for tool parameter key match metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchResults - coherenceResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceResult' - description: Result for coherence metric. - fulfillmentResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentResult' - description: Result for fulfillment metric. - questionAnsweringCorrectnessResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult - description: Result for question answering correctness metric. - pairwiseSummarizationQualityResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityResult - description: Result for pairwise summarization quality metric. - toolCallValidResults: - description: Tool call metrics. Results for tool call valid metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidResults' - toolParameterKvMatchResults: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchResults - description: Results for tool parameter key value match metric. - questionAnsweringHelpfulnessResult: - description: Result for question answering helpfulness metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult - summarizationHelpfulnessResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessResult - description: Result for summarization helpfulness metric. - safetyResult: - description: Result for safety metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyResult' - type: object - id: GoogleCloudAiplatformV1EvaluateInstancesResponse - description: Response message for EvaluationService.EvaluateInstances. - GoogleCloudAiplatformV1FilterSplit: - id: GoogleCloudAiplatformV1FilterSplit + description: Results for exact match metric. type: object - description: >- - Assigns input data to training, validation, and test sets based on the - given filters, data pieces not matched by any filter are ignored. - Currently only supported for Datasets containing DataItems. If any of - the filters in this message are to match nothing, then they can be set - as '-' (the minus sign). Supported only for unstructured Datasets. + id: GoogleCloudAiplatformV1ExactMatchResults + GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint: properties: - validationFilter: - type: string - description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to validate the Model. A filter with same - syntax as the one used in DatasetService.ListDataItems may be used. - If a single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - testFilter: - type: string - description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to test the Model. A filter with same syntax as - the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - trainingFilter: - description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to train the Model. A filter with same syntax - as the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. + serviceAttachment: type: string - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics - properties: - videoActionMetrics: - type: array - description: 'The metric entries for precision window lengths: 1s,2s,3s.' - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics - evaluatedActionCount: - format: int32 - type: integer - description: The number of ground truth actions used to create this evaluation. - type: object - description: Model evaluation metrics for video action recognition. - GoogleCloudAiplatformV1MigratableResource: - id: GoogleCloudAiplatformV1MigratableResource - type: object - description: >- - Represents one resource that exists in automl.googleapis.com, - datalabeling.googleapis.com or ml.googleapis.com. - properties: - dataLabelingDataset: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset - description: Output only. Represents one Dataset in datalabeling.googleapis.com. - readOnly: true - automlModel: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlModel - readOnly: true - description: Output only. Represents one Model in automl.googleapis.com. - mlEngineModelVersion: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion readOnly: true - description: Output only. Represents one Version in ml.googleapis.com. - lastMigrateTime: + description: >- + Output only. The name of the service attachment resource. Populated + if private service connect is enabled and after FeatureViewSync is + created. + publicEndpointDomainName: type: string readOnly: true description: >- - Output only. Timestamp when the last migration attempt on this - MigratableResource started. Will not be set if there's no migration - attempt on this MigratableResource. - format: google-datetime - lastUpdateTime: - readOnly: true - type: string - format: google-datetime + Output only. This field will be populated with the domain name to + use for this FeatureOnlineStore + privateServiceConnectConfig: description: >- - Output only. Timestamp when this MigratableResource was last - updated. - automlDataset: + Optional. Private service connect config. The private service + connection is available only for Optimized storage type, not for + embedding management now. If + PrivateServiceConnectConfig.enable_private_service_connect set to + true, customers will use private service connection to send request. + Otherwise, the connection will set to public endpoint. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlDataset - readOnly: true - description: Output only. Represents one Dataset in automl.googleapis.com. - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource: - type: object - properties: - uri: - type: string - description: The URI of a BigQuery table. - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource - GoogleCloudAiplatformV1RougeSpec: - type: object + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig description: >- - Spec for rouge score metric - calculates the recall of n-grams in - prediction as compared to reference - returns a score ranging between 0 - and 1. - id: GoogleCloudAiplatformV1RougeSpec - properties: - splitSummaries: - type: boolean - description: Optional. Whether to split summaries while using rougeLsum. - rougeType: - description: >- - Optional. Supported rouge types are rougen[1-9], rougeL, and - rougeLsum. - type: string - useStemmer: - type: boolean - description: Optional. Whether to use stemmer to compute rouge score. - GoogleCloudAiplatformV1Presets: + The dedicated serving endpoint for this FeatureOnlineStore. Only need to + set when you choose Optimized storage type. Public endpoint is + provisioned by default. + type: object + id: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint + GoogleCloudAiplatformV1PairwiseSummarizationQualityResult: + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityResult + description: Spec for pairwise summarization quality result. type: object - description: Preset configuration for example-based explanations - id: GoogleCloudAiplatformV1Presets properties: - modality: + pairwiseChoice: enumDescriptions: - - Should not be set. Added as a recommended best practice for enums - - IMAGE modality - - TEXT modality - - TABULAR modality - description: >- - The modality of the uploaded model, which automatically configures - the distance measurement and feature normalization for the - underlying example index and queries. If your model does not - precisely fit one of these types, it is okay to choose the closest - type. + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined + description: Output only. Pairwise summarization prediction choice. enum: - - MODALITY_UNSPECIFIED - - IMAGE - - TEXT - - TABULAR - type: string - query: - enumDescriptions: - - More precise neighbors as a trade-off against slower response. - - Faster response as a trade-off against less precise neighbors. - description: >- - Preset option controlling parameters for speed-precision trade-off - when querying for examples. If omitted, defaults to `PRECISE`. + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE + readOnly: true type: string - enum: - - PRECISE - - FAST - GoogleCloudAiplatformV1DirectRawPredictResponse: - id: GoogleCloudAiplatformV1DirectRawPredictResponse - properties: - output: - format: byte - description: The prediction output. + explanation: + readOnly: true + description: Output only. Explanation for summarization quality score. type: string - description: Response message for PredictionService.DirectRawPredict. - type: object - GoogleCloudAiplatformV1PurgeExecutionsMetadata: - description: Details of operations that perform MetadataService.PurgeExecutions. - id: GoogleCloudAiplatformV1PurgeExecutionsMetadata - type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for purging Executions. - GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult: - description: Prediction output format for Text Extraction. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult + confidence: + description: Output only. Confidence for summarization quality score. + format: float + type: number + readOnly: true + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics: properties: - displayNames: + boundingBoxMeanAveragePrecision: + format: float description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. - items: - type: string - type: array - ids: + The single metric for bounding boxes evaluation: the + `meanAveragePrecision` averaged over all `boundingBoxMetrics`. + type: number + boundingBoxMetrics: type: array items: - format: int64 - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics description: >- - The resource IDs of the AnnotationSpecs that had been identified, - ordered by the confidence score descendingly. - textSegmentEndOffsets: - type: array - items: - format: int64 - type: string + The bounding boxes match metrics for each intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + trackMeanAveragePrecision: + type: number + format: float description: >- - The end offsets, inclusive, of the text segment in which the - AnnotationSpec has been identified. Expressed as a zero-based number - of characters as measured from the start of the text snippet. - textSegmentStartOffsets: - items: - type: string - format: int64 - type: array + UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the + `meanAveragePrecision` averaged over all `trackMetrics`. + trackMeanBoundingBoxIou: + type: number + format: float description: >- - The start offsets, inclusive, of the text segment in which the - AnnotationSpec has been identified. Expressed as a zero-based number - of characters as measured from the start of the text snippet. - confidences: + UNIMPLEMENTED. The single metric for tracks bounding box iou + evaluation: the `meanBoundingBoxIou` averaged over all + `trackMetrics`. + trackMeanMismatchRate: + description: >- + UNIMPLEMENTED. The single metric for tracking consistency + evaluation: the `meanMismatchRate` averaged over all `trackMetrics`. + type: number + format: float + trackMetrics: items: - format: float - type: number + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. + UNIMPLEMENTED. The tracks match metrics for each + intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. type: array - type: object - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec: - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec - properties: - trainTrialSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec + evaluatedFrameCount: + format: int32 description: >- - Spec for train trials. Top N - [TrainTrialSpec.max_parallel_trial_count] search trials will be - trained for every M [TrainTrialSpec.frequency] trials searched. - searchTrialSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec - description: Required. Spec for search trials. - multiTrialAlgorithm: - enumDescriptions: - - Defaults to `REINFORCEMENT_LEARNING`. - - >- - The Reinforcement Learning Algorithm for Multi-trial Neural - Architecture Search (NAS). - - >- - The Grid Search Algorithm for Multi-trial Neural Architecture - Search (NAS). + UNIMPLEMENTED. The number of video frames used to create this + evaluation. + type: integer + evaluatedBoundingBoxCount: + type: integer + format: int32 description: >- - The multi-trial Neural Architecture Search (NAS) algorithm type. - Defaults to `REINFORCEMENT_LEARNING`. - type: string - enum: - - MULTI_TRIAL_ALGORITHM_UNSPECIFIED - - REINFORCEMENT_LEARNING - - GRID_SEARCH - metric: + UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over + all frames) the ground truth used to create this evaluation had. + evaluatedTrackCount: + format: int32 + type: integer description: >- - Metric specs for the NAS job. Validation for this field is done at - `multi_trial_algorithm_spec` field. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + UNIMPLEMENTED. The total number of tracks (i.e. as seen across all + frames) the ground truth used to create this evaluation had. type: object - description: The spec of multi-trial Neural Architecture Search (NAS). - GoogleCloudAiplatformV1TokensInfo: description: >- - Tokens info with a list of tokens and the corresponding list of token - ids. - id: GoogleCloudAiplatformV1TokensInfo + Model evaluation metrics for video object tracking problems. Evaluates + prediction quality of both labeled bounding boxes and labeled tracks + (i.e. series of bounding boxes sharing same label and instance ID). + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics + GoogleCloudAiplatformV1CopyModelRequest: + type: object + description: Request message for ModelService.CopyModel. + id: GoogleCloudAiplatformV1CopyModelRequest properties: - tokenIds: - items: - type: string - format: int64 - description: A list of token ids from the input. - type: array - tokens: - description: A list of tokens from the input. - items: - type: string - format: byte - type: array - role: + modelId: type: string description: >- - Optional. Optional fields for the role from the corresponding - Content. - type: object - GoogleCloudAiplatformV1ResourceRuntimeSpec: - properties: - serviceAccountSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ServiceAccountSpec' + Optional. Copy source_model into a new Model with this ID. The ID + will become the final component of the model 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. + sourceModel: + type: string description: >- - Optional. Configure the use of workload identity on the - PersistentResource - raySpec: + Required. The resource name of the Model to copy. That Model must be + in the same Project. Format: + `projects/{project}/locations/{location}/models/{model}` + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Optional. Ray cluster configuration. Required when creating a - dedicated RayCluster on the PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RaySpec' - type: object - id: GoogleCloudAiplatformV1ResourceRuntimeSpec - description: >- - Configuration for the runtime on a PersistentResource instance, - including but not limited to: * Service accounts used to run the - workloads. * Whether to make it a dedicated Ray Cluster. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation: - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. - properties: - columnName: - type: string - timeFormat: + Customer-managed encryption key options. If this is set, then the + Model copy will be encrypted with the provided encryption key. + parentModel: type: string description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation + Optional. Specify this field to copy source_model into this existing + Model as a new version. Format: + `projects/{project}/locations/{location}/models/{model}` + GoogleCloudAiplatformV1WriteTensorboardRunDataRequest: type: object - GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata: - id: GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata + id: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + description: Request message for TensorboardService.WriteTensorboardRunData. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for PersistentResource. - progressMessage: + tensorboardRun: type: string - description: Progress Message for Reboot LRO - description: Details of operations that perform reboot PersistentResource. + description: >- + Required. The resource name of the TensorboardRun to write data to. + Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + timeSeriesData: + description: >- + Required. The TensorboardTimeSeries data to write. Values with in a + time series are indexed by their step value. Repeated writes to the + same step will overwrite the existing value for that step. The upper + limit of data points per write request is 5000. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + type: array + GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource: + description: The content of the input notebook in ipynb format. type: object - GoogleCloudAiplatformV1WriteFeatureValuesPayload: + id: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource + properties: + content: + type: string + description: The base64-encoded contents of the input notebook file. + format: byte + CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: + id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail + description: 'Create API error message for Vertex Pipeline. Next Id: 3.' type: object properties: - featureValues: - description: >- - Required. Feature values to be written, mapping from Feature ID to - value. Up to 100,000 `feature_values` entries may be written across - all payloads. The feature generation time, aligned by days, must be - no older than five years (1825 days) and no later than one year (366 - days) in the future. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - entityId: + errorCause: + enum: + - ERROR_CAUSE_UNSPECIFIED + - INVALID_PIPELINE_SPEC_FORMAT + - INVALID_PIPELINE_SPEC + - INVALID_DEPLOYMENT_CONFIG + - INVALID_DEPLOYMENT_SPEC + - INVALID_INSTANCE_SCHEMA + - INVALID_CUSTOM_JOB + - INVALID_CONTAINER_SPEC + - INVALID_NOTIFICATION_EMAIL_SETUP + - INVALID_SERVICE_ACCOUNT_SETUP + - INVALID_KMS_SETUP + - INVALID_NETWORK_SETUP + - INVALID_PIPELINE_TASK_SPEC + - INVALID_PIPELINE_TASK_ARTIFACT + - INVALID_IMPORTER_SPEC + - INVALID_RESOLVER_SPEC + - INVALID_RUNTIME_PARAMETERS + - CLOUD_API_NOT_ENABLED + - INVALID_GCS_INPUT_URI + - INVALID_GCS_OUTPUT_URI + - INVALID_COMPONENT_SPEC + - INVALID_DAG_OUTPUTS_SPEC + - INVALID_DAG_SPEC + - INSUFFICIENT_QUOTA + - INTERNAL + description: The error root cause returned by CreatePipelineJob API. type: string - description: Required. The ID of the entity. - id: GoogleCloudAiplatformV1WriteFeatureValuesPayload - description: Contains Feature values to be written for a specific entity. - GoogleCloudAiplatformV1UnmanagedContainerModel: - id: GoogleCloudAiplatformV1UnmanagedContainerModel - description: >- - Contains model information necessary to perform batch prediction without - requiring a full model import. + enumDescriptions: + - Should never be used. + - IR Pipeline Spec can not been parsed to yaml or json format. + - A pipeline spec is invalid. + - A deployment config is invalid. + - A deployment spec is invalid. + - An instance schema is invalid. + - A custom job is invalid. + - A container spec is invalid. + - Notification email setup is invalid. + - Service account setup is invalid. + - KMS setup is invalid. + - Network setup is invalid. + - Task spec is invalid. + - Task artifact is invalid. + - Importer spec is invalid. + - Resolver spec is invalid. + - Runtime Parameters are invalid. + - Cloud API not enabled. + - Invalid GCS input uri + - Invalid GCS output uri + - Component spec of pipeline is invalid. + - DagOutputsSpec is invalid. + - DagSpec is invalid. + - Project does not have enough quota. + - An internal error with unknown cause. + publicMessage: + type: string + description: Public messages contains actionable items for the error cause. + GoogleCloudAiplatformV1ResourcesConsumed: properties: - predictSchemata: - description: Contains the schemata used in Model's predictions and explanations - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - containerSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' - description: >- - Input only. The specification of the container that is to be used - when deploying this Model. - artifactUri: + replicaHours: description: >- - The path to the directory containing the Model artifact and any of - its supporting files. - type: string + Output only. The number of replica hours used. Note that many + replicas may run in parallel, and additionally any given work may be + queued for some time. Therefore this value is not strictly related + to wall time. + readOnly: true + type: number + format: double + id: GoogleCloudAiplatformV1ResourcesConsumed + description: Statistics information about resource consumption. type: object - GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling: - id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling + GoogleCloudAiplatformV1PointwiseMetricInstance: + id: GoogleCloudAiplatformV1PointwiseMetricInstance + description: >- + Pointwise metric instance. Usually one instance corresponds to one row + in an evaluation dataset. properties: - cpuUtilizationTarget: - description: >- - Optional. A percentage of the cluster's CPU capacity. Can be from - 10% to 80%. When a cluster's CPU utilization exceeds the target that - you have set, Bigtable immediately adds nodes to the cluster. When - CPU utilization is substantially lower than the target, Bigtable - removes nodes. If not set will default to 50%. - type: integer - format: int32 - minNodeCount: - type: integer - format: int32 - description: >- - Required. The minimum number of nodes to scale down to. Must be - greater than or equal to 1. - maxNodeCount: + jsonInstance: description: >- - Required. The maximum number of nodes to scale up to. Must be - greater than or equal to min_node_count, and less than or equal to - 10 times of 'min_node_count'. - format: int32 - type: integer + Instance specified as a json string. String key-value pairs are + expected in the json_instance to render + PointwiseMetricSpec.instance_prompt_template. + type: string type: object - GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest: - description: Request message for ModelService.BatchImportModelEvaluationSlices - id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest + GoogleCloudAiplatformV1ToolCallValidResults: properties: - modelEvaluationSlices: + toolCallValidMetricValues: type: array - description: Required. Model evaluation slice resource to be imported. + description: Output only. Tool call valid metric values. + readOnly: true items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolCallValidMetricValue + description: Results for tool call valid metric. type: object - GoogleCloudAiplatformV1SchemaVideoDataItem: + id: GoogleCloudAiplatformV1ToolCallValidResults + GoogleCloudAiplatformV1PipelineTemplateMetadata: + properties: + version: + description: >- + The version_name in artifact registry. Will always be presented in + output if the PipelineJob.template_uri is from supported template + registry. Format is "sha256:abcdef123456...". + type: string + description: >- + Pipeline template metadata if PipelineJob.template_uri is from supported + template registry. Currently, the only supported registry is Artifact + Registry. type: object - description: Payload of Video DataItem. - id: GoogleCloudAiplatformV1SchemaVideoDataItem + id: GoogleCloudAiplatformV1PipelineTemplateMetadata + GoogleCloudAiplatformV1MetadataStore: properties: - mimeType: + dataplexConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MetadataStoreDataplexConfig + description: Optional. Dataplex integration settings. + updateTime: + description: Output only. Timestamp when this MetadataStore was last updated. readOnly: true type: string - description: >- - Output only. The mime type of the content of the video. Only the - videos in below listed mime types are supported. Supported - mime_type: - video/mp4 - video/avi - video/quicktime - gcsUri: - description: >- - Required. Google Cloud Storage URI points to the original video in - user's bucket. The video is up to 50 GB in size and up to 3 hour in - duration. + format: google-datetime + name: type: string - GoogleCloudAiplatformV1BigQueryDestination: - description: The BigQuery location for the output content. - properties: - outputUri: + description: Output only. The resource name of the MetadataStore instance. + readOnly: true + createTime: + format: google-datetime + description: Output only. Timestamp when this MetadataStore was created. type: string + readOnly: true + state: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + description: Output only. State information of the MetadataStore. + readOnly: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Required. BigQuery URI to a project or table, up to 2000 characters - long. When only the project is specified, the Dataset and Table is - created. When the full table reference is specified, the Dataset - must exist and table must not exist. Accepted forms: * BigQuery - path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` - or `bq://projectId.bqDatasetId.bqTableId`. - id: GoogleCloudAiplatformV1BigQueryDestination - type: object - GoogleCloudAiplatformV1EntityIdSelector: - properties: - csvSource: - description: Source of Csv - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - entityIdField: + Customer-managed encryption key spec for a Metadata Store. If set, + this Metadata Store and all sub-resources of this Metadata Store are + secured using this key. + description: type: string - description: >- - Source column that holds entity IDs. If not provided, entity IDs are - extracted from the column named entity_id. - description: Selector for entityId. Getting ids from the given source. + description: Description of the MetadataStore. type: object - id: GoogleCloudAiplatformV1EntityIdSelector - GoogleCloudAiplatformV1Value: + id: GoogleCloudAiplatformV1MetadataStore + description: >- + Instance of a metadata store. Contains a set of metadata that can be + queried. + GoogleCloudAiplatformV1ToolParameterKeyMatchInstance: + description: Spec for tool parameter key match instance. + id: GoogleCloudAiplatformV1ToolParameterKeyMatchInstance type: object properties: - intValue: + reference: type: string - format: int64 - description: An integer value. - stringValue: - description: A string value. + description: Required. Ground truth used to compare against the prediction. + prediction: type: string - doubleValue: - type: number - format: double - description: A double value. - id: GoogleCloudAiplatformV1Value - description: Value is the value of the field. - GoogleCloudAiplatformV1SchemaVideoDatasetMetadata: + description: Required. Output of the evaluated model. + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig: + type: object properties: - gcsBucket: + dataset: type: string description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. - dataItemSchemaUri: + Required. Full resource name of data labeling Dataset. Format: + `projects/{project}/datasets/{dataset}`. + datasetDisplayName: type: string description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Video DataItems that belong to this Dataset. - type: object - description: The metadata of Datasets that contain Video DataItems. - id: GoogleCloudAiplatformV1SchemaVideoDatasetMetadata - GoogleCloudAiplatformV1LineageSubgraph: - type: object - description: >- - A subgraph of the overall lineage graph. Event edges connect Artifact - and Execution nodes. - id: GoogleCloudAiplatformV1LineageSubgraph - properties: - events: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' - description: The Event edges between Artifacts and Executions in the subgraph. - type: array - artifacts: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - description: The Artifact nodes in the subgraph. - type: array - executions: - description: The Execution nodes in the subgraph. + Optional. Display name of the Dataset in Vertex AI. System will pick + a display name if unspecified. + migrateDataLabelingAnnotatedDatasetConfigs: type: array + description: >- + Optional. Configs for migrating AnnotatedDataset in + datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified + AnnotatedDatasets have to belong to the datalabeling Dataset. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - GoogleCloudAiplatformV1ListMetadataSchemasResponse: - id: GoogleCloudAiplatformV1ListMetadataSchemasResponse - type: object + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig + description: >- + Config for migrating Dataset in datalabeling.googleapis.com to Vertex + AI's Dataset. + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + GoogleCloudAiplatformV1ToolParameterKVMatchInput: + id: GoogleCloudAiplatformV1ToolParameterKVMatchInput properties: - metadataSchemas: + metricSpec: + description: Required. Spec for tool parameter key value match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchSpec' + instances: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' - description: The MetadataSchemas found for the MetadataStore. - nextPageToken: - type: string - description: >- - A token, which can be sent as ListMetadataSchemasRequest.page_token - to retrieve the next page. If this field is not populated, there are - no subsequent pages. - description: Response message for MetadataService.ListMetadataSchemas. - GoogleCloudAiplatformV1AddExecutionEventsResponse: - properties: {} - id: GoogleCloudAiplatformV1AddExecutionEventsResponse + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInstance + description: Required. Repeated tool parameter key value match instances. type: object - description: Response message for MetadataService.AddExecutionEvents. - GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse: - id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse - description: Response message for TensorboardService.BatchCreateTensorboardRuns. + description: Input for tool parameter key value match metric. + GoogleRpcStatus: type: object properties: - tensorboardRuns: - type: array - description: The created TensorboardRuns. + details: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - id: >- - GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata - description: >- - Runtime operation information for - JobService.UpdateModelDeploymentMonitoringJob. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata - type: object - properties: - bestTrialBackingCustomJob: - type: string - description: >- - The resource name of the CustomJob that has been created to run the - best Trial of this HyperparameterTuning task. - backingHyperparameterTuningJob: - type: string + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array description: >- - The resource name of the HyperparameterTuningJob that has been - created to carry out this HyperparameterTuning task. - GoogleCloudAiplatformV1PairwiseMetricSpec: - type: object - properties: - metricPromptTemplate: - description: Required. Metric prompt template for pairwise metric. - type: string - id: GoogleCloudAiplatformV1PairwiseMetricSpec - description: Spec for pairwise metric. - GoogleCloudAiplatformV1ResourcesConsumed: - properties: - replicaHours: - format: double - readOnly: true - type: number + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + message: description: >- - Output only. The number of replica hours used. Note that many - replicas may run in parallel, and additionally any given work may be - queued for some time. Therefore this value is not strictly related - to wall time. - id: GoogleCloudAiplatformV1ResourcesConsumed - type: object - description: Statistics information about resource consumption. - GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset: - properties: - annotatedDatasetDisplayName: - type: string - description: The AnnotatedDataset's display name in datalabeling.googleapis.com. - annotatedDataset: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - description: >- - Full resource name of data labeling AnnotatedDataset. Format: - `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. - type: object - description: Represents one AnnotatedDataset in datalabeling.googleapis.com. - id: >- - GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset + code: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation: + id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation + description: The mask based segmentation annotation. properties: annotationSpecColors: description: The mapping between color and AnnotationSpec for this Annotation. + type: array items: $ref: >- #/components/schemas/GoogleCloudAiplatformV1SchemaAnnotationSpecColor - type: array maskGcsUri: description: >- Google Cloud Storage URI that points to the mask image. The image @@ -12048,469 +10669,437 @@ components: which the pixel in the image DataItem belong to. Each color is mapped to one AnnotationSpec based on annotation_spec_colors. type: string - id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation - type: object - description: The mask based segmentation annotation. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics: - type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics - properties: - bleu: - description: >- - BLEU (bilingual evaluation understudy) scores based on sacrebleu - implementation. - type: number - format: float - rougeLSum: - type: number - format: float - description: ROUGE-L (Longest Common Subsequence) scoring at summary level. - GoogleCloudAiplatformV1WriteTensorboardRunDataResponse: - description: Response message for TensorboardService.WriteTensorboardRunData. - properties: {} - id: GoogleCloudAiplatformV1WriteTensorboardRunDataResponse - type: object - GoogleCloudAiplatformV1ListDataLabelingJobsResponse: type: object - description: Response message for JobService.ListDataLabelingJobs. + GoogleCloudAiplatformV1Content: + description: >- + The base structured datatype containing multi-part content of a message. + A `Content` includes a `role` field designating the producer of the + `Content` and a `parts` field containing multi-part data that contains + the content of the message turn. properties: - dataLabelingJobs: + parts: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' - description: >- - A list of DataLabelingJobs that matches the specified filter in the - request. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' type: array - nextPageToken: + description: >- + Required. Ordered `Parts` that constitute a single message. Parts + may have different IANA MIME types. + role: type: string - description: The standard List next-page token. - id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse - GoogleCloudAiplatformV1AvroSource: - description: The storage details for Avro input content. - id: GoogleCloudAiplatformV1AvroSource - properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: Required. Google Cloud Storage location. + description: >- + Optional. The producer of the content. Must be either 'user' or + 'model'. Useful to set for multi-turn conversations, otherwise can + be left blank or unset. type: object - GoogleCloudAiplatformV1Examples: - description: >- - Example-based explainability that returns the nearest neighbors from the - provided dataset. + id: GoogleCloudAiplatformV1Content + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation: type: object properties: - nearestNeighborSearchConfig: - description: >- - The full configuration for the generated index, the semantics are - the same as metadata and should match - [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). - type: any - neighborCount: - format: int32 - description: The number of neighbors to return when querying for examples. - type: integer - exampleGcsSource: - description: The Cloud Storage input instances. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesExampleGcsSource' - presets: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Presets' - description: >- - Simplified preset configuration, which automatically sets - configuration values based on the desired query speed-precision - trade-off and modality. - id: GoogleCloudAiplatformV1Examples - GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata: - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - type: object - description: Runtime operation information for UpdateDeploymentResourcePool method. - id: GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata - GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata: - properties: - indexDisplayNameMapping: - type: any - description: >- - Static mapping between the index and display name. Use this if the - outputs are a deterministic n-dimensional array, e.g. a list of - scores of all the classes in a pre-defined order for a - multi-classification Model. It's not feasible if the outputs are - non-deterministic, e.g. the Model produces top-k classes or sort the - outputs by their values. The shape of the value must be an - n-dimensional array of strings. The number of dimensions must match - that of the outputs to be explained. The - Attribution.output_display_name is populated by locating in the - mapping with Attribution.output_index. - displayNameMappingKey: - description: >- - Specify a field name in the prediction to look for the display name. - Use this if the prediction contains the display names for the - outputs. The display names in the prediction must have the same - shape of the outputs, so that it can be located by - Attribution.output_index for a specific output. - type: string - outputTensorName: - description: >- - Name of the output tensor. Required and is only applicable to Vertex - AI provided images for Tensorflow. + columnName: type: string - id: GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. * A boolean value that indicates whether the + value is valid. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest: + properties: {} + description: Request message for VizierService.CheckTrialEarlyStoppingState. type: object - description: Metadata of the prediction output to be explained. - GoogleCloudAiplatformV1Candidate: + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + GoogleCloudAiplatformV1ToolNameMatchResults: + id: GoogleCloudAiplatformV1ToolNameMatchResults + description: Results for tool name match metric. properties: - safetyRatings: - description: >- - Output only. List of ratings for the safety of a response candidate. - There is at most one rating per category. - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' + toolNameMatchMetricValues: + description: Output only. Tool name match metric values. type: array - avgLogprobs: - description: Output only. Average log probability score of the candidate. - type: number - readOnly: true - format: double - finishMessage: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolNameMatchMetricValue readOnly: true + type: object + GoogleCloudAiplatformV1DeployedIndexRef: + type: object + id: GoogleCloudAiplatformV1DeployedIndexRef + description: Points to a DeployedIndex. + properties: + indexEndpoint: type: string - description: >- - Output only. Describes the reason the mode stopped generating tokens - in more detail. This is only filled when `finish_reason` is set. - index: - description: Output only. Index of the candidate. - readOnly: true - format: int32 - type: integer - groundingMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' + description: Immutable. A resource name of the IndexEndpoint. + displayName: + description: Output only. The display name of the DeployedIndex. readOnly: true - description: >- - Output only. Metadata specifies sources used to ground generated - content. - finishReason: - description: >- - Output only. The reason why the model stopped generating tokens. If - empty, the model has not stopped generating the tokens. - enumDescriptions: - - The finish reason is unspecified. - - >- - Token generation reached a natural stopping point or a configured - stop sequence. - - Token generation reached the configured maximum output tokens. - - >- - Token generation stopped because the content potentially contains - safety violations. NOTE: When streaming, content is empty if - content filters blocks the output. - - >- - Token generation stopped because the content potentially contains - copyright violations. - - All other reasons that stopped the token generation. - - >- - Token generation stopped because the content contains forbidden - terms. - - >- - Token generation stopped for potentially containing prohibited - content. - - >- - Token generation stopped because the content potentially contains - Sensitive Personally Identifiable Information (SPII). - - The function call generated by the model is invalid. type: string - enum: - - FINISH_REASON_UNSPECIFIED - - STOP - - MAX_TOKENS - - SAFETY - - RECITATION - - OTHER - - BLOCKLIST - - PROHIBITED_CONTENT - - SPII - - MALFORMED_FUNCTION_CALL - readOnly: true - citationMetadata: - description: Output only. Source attribution of the generated content. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1CitationMetadata' - content: - readOnly: true - description: Output only. Content parts of the candidate. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - id: GoogleCloudAiplatformV1Candidate - description: A response candidate generated from the model. - type: object - GoogleCloudAiplatformV1StreamingPredictResponse: - type: object + deployedIndexId: + type: string + description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. + GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest: properties: - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. - outputs: + names: + description: >- + Required. The names of the PipelineJobs to delete. A maximum of 32 + PipelineJobs can be deleted in a batch. Format: + `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The prediction output. - description: Response message for PredictionService.StreamingPredict. - id: GoogleCloudAiplatformV1StreamingPredictResponse - GoogleCloudAiplatformV1VertexRagStore: + type: string + id: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest type: object - id: GoogleCloudAiplatformV1VertexRagStore + description: Request message for PipelineService.BatchDeletePipelineJobs. + GoogleTypeColor: + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + type: object + id: GoogleTypeColor properties: - ragCorpora: - description: Optional. Deprecated. Please use rag_resources instead. - type: array - items: - type: string - deprecated: true - ragResources: - description: >- - Optional. The representation of the rag source. It can be used to - specify corpus only or ragfiles. Currently only support one corpus - or multiple files from one corpus. In the future we may open up - multiple corpora support. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1VertexRagStoreRagResource - similarityTopK: - format: int32 - description: >- - Optional. Number of top k results to return from the selected - corpora. - type: integer - vectorDistanceThreshold: - format: double + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float type: number + alpha: + format: float description: >- - Optional. Only return results with vector distance smaller than the - threshold. - description: Retrieve from Vertex RAG Store for grounding. - GoogleCloudAiplatformV1ExportFeatureValuesRequest: - description: Request message for FeaturestoreService.ExportFeatureValues. - id: GoogleCloudAiplatformV1ExportFeatureValuesRequest + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + red: + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + type: number + green: + type: number + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact: + id: GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact + type: object properties: - destination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' - description: Required. Specifies destination location and format. - snapshotExport: - description: >- - Exports the latest Feature values of all entities of the EntityType - within a time range. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport - settings: - type: array - description: Per-Feature export settings. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting - featureSelector: - description: Required. Selects Features to export values of. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - fullExport: + artifactId: + type: string description: >- - Exports all historical values of all entities of the EntityType - within a time range - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport + Artifact resource id from MLMD. Which is the last portion of an + artifact resource name: + `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. + The artifact must stay within the same project, location and default + metadatastore as the pipeline. + description: The type of an input artifact. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation: + properties: + columnName: + type: string type: object - GoogleCloudAiplatformV1GcsSource: + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Convert the category name to a dictionary lookup index and generate an + embedding for each index. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation + GoogleCloudAiplatformV1GenieSource: + description: >- + Contains information about the source of the models generated from + Generative AI Studio. properties: - uris: - description: >- - Required. Google Cloud Storage URI(-s) to the input file(s). May - contain wildcards. For more information on wildcards, see - https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. + baseModelUri: + description: Required. The public base model URI. + type: string + id: GoogleCloudAiplatformV1GenieSource + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics: + type: object + description: Metrics for image segmentation evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics + properties: + confidenceMetricsEntries: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry + description: >- + Metrics for each confidenceThreshold in + 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 Precision-recall curve + can be derived from it. type: array + GoogleCloudAiplatformV1WorkerPoolSpec: + id: GoogleCloudAiplatformV1WorkerPoolSpec type: object - description: The Google Cloud Storage location for the input content. - id: GoogleCloudAiplatformV1GcsSource - GoogleCloudAiplatformV1StructValue: - description: Struct (or object) type feature value. - id: GoogleCloudAiplatformV1StructValue - type: object + description: Represents the spec of a worker pool in a job. properties: - values: - description: A list of field values. + replicaCount: + description: Optional. The number of worker replicas to use for this worker pool. + format: int64 + type: string + pythonPackageSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' + description: The Python packaged task. + nfsMounts: type: array + description: Optional. List of NFS mount spec. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StructFieldValue' - GoogleCloudAiplatformV1QueryDeployedModelsResponse: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' + machineSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + description: Optional. Immutable. The specification of a single machine. + diskSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + description: Disk spec. + containerSpec: + description: The custom container task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' + GoogleCloudAiplatformV1FilterSplit: + type: object properties: - totalDeployedModelCount: - description: The total number of DeployedModels on this DeploymentResourcePool. - format: int32 - type: integer - totalEndpointCount: - type: integer - description: >- - The total number of Endpoints that have DeployedModels on this - DeploymentResourcePool. - format: int32 - nextPageToken: + trainingFilter: 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. + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to train the Model. A filter with same syntax + as the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + type: string + validationFilter: type: string - deployedModelRefs: - type: array description: >- - References to the DeployedModels that share the specified - deploymentResourcePool. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' - deployedModels: - type: array - deprecated: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: DEPRECATED Use deployed_model_refs instead. - description: Response message for QueryDeployedModels method. - id: GoogleCloudAiplatformV1QueryDeployedModelsResponse + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to validate the Model. A filter with same + syntax as the one used in DatasetService.ListDataItems may be used. + If a single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + testFilter: + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to test the Model. A filter with same syntax as + the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + type: string + description: >- + Assigns input data to training, validation, and test sets based on the + given filters, data pieces not matched by any filter are ignored. + Currently only supported for Datasets containing DataItems. If any of + the filters in this message are to match nothing, then they can be set + as '-' (the minus sign). Supported only for unstructured Datasets. + id: GoogleCloudAiplatformV1FilterSplit + GoogleCloudAiplatformV1UpsertDatapointsResponse: + id: GoogleCloudAiplatformV1UpsertDatapointsResponse + description: Response message for IndexService.UpsertDatapoints type: object - GoogleCloudAiplatformV1ExportModelResponse: - description: Response message of ModelService.ExportModel operation. - id: GoogleCloudAiplatformV1ExportModelResponse properties: {} - type: object - GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest: - id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + GoogleCloudAiplatformV1EnvVar: type: object description: >- - Request message for - FeaturestoreOnlineServingService.StreamingFeatureValuesRead. + Represents an environment variable present in a Container or Python + Module. properties: - entityIds: + value: + type: string description: >- - Required. IDs of entities to read Feature values of. The maximum - number of IDs is 100. For example, for a machine learning model - predicting user clicks on a website, an entity ID could be - `user_123`. - items: - type: string - type: array - featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + Required. Variables that reference a $(VAR_NAME) are expanded using + the previous defined environment variables in the container and any + service environment variables. If a variable cannot be resolved, the + reference in the input string will be unchanged. The $(VAR_NAME) + syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + references will never be expanded, regardless of whether the + variable exists or not. + name: description: >- - Required. Selector choosing Features of the target EntityType. - Feature IDs will be deduplicated. - GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance: - description: Spec for question answering helpfulness instance. - properties: - context: + Required. Name of the environment variable. Must be a valid C + identifier. type: string - description: Optional. Text provided as context to answer the question. - instruction: + id: GoogleCloudAiplatformV1EnvVar + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation: + properties: + invalidValuesAllowed: + type: boolean description: >- - Required. The question asked and other instruction in the inference - prompt. - type: string - reference: - type: string - description: Optional. Ground truth used to compare against the prediction. - prediction: - description: Required. Output of the evaluated model. + If invalid values is allowed, the training pipeline will create a + boolean feature that indicated whether the value is valid. + Otherwise, the training pipeline will discard the input row from + trainining data. + columnName: type: string - id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance + description: >- + Treats the column as numerical array and performs following + transformation functions. * All transformations for Numerical types + applied to the average of the all elements. * The average of empty + arrays is treated as zero. type: object - GoogleCloudAiplatformV1CopyModelResponse: - id: GoogleCloudAiplatformV1CopyModelResponse + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + GoogleCloudAiplatformV1FulfillmentInput: properties: - modelVersionId: - type: string - readOnly: true - description: Output only. The version ID of the model that is copied. - model: + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInstance' + description: Required. Fulfillment instance. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentSpec' + description: Required. Spec for fulfillment score metric. + type: object + id: GoogleCloudAiplatformV1FulfillmentInput + description: Input for fulfillment metric. + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition: + properties: + values: + type: array description: >- - The name of the copied Model resource. Format: - `projects/{project}/locations/{location}/models/{model}` - type: string - description: Response message of ModelService.CopyModel operation. + Required. Matches values of the parent parameter of 'CATEGORICAL' + type. All values must exist in `categorical_value_spec` of parent + parameter. + items: + type: string type: object - GoogleCloudAiplatformV1SupervisedTuningDataStats: + description: Represents the spec to match categorical values from parent parameter. + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics type: object - id: GoogleCloudAiplatformV1SupervisedTuningDataStats properties: - tuningDatasetExampleCount: - format: int64 - readOnly: true - description: Output only. Number of examples in the tuning dataset. - type: string - tuningStepCount: - readOnly: true - format: int64 - type: string - description: Output only. Number of tuning steps for this Tuning Job. - userOutputTokenDistribution: - description: Output only. Dataset distributions for the user output tokens. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - totalBillableCharacterCount: - description: Output only. Number of billable characters in the tuning dataset. - readOnly: true - deprecated: true - type: string - format: int64 - totalTruncatedExampleCount: + confidenceThreshold: + format: float + type: number + description: The confidence threshold value used to compute the metrics. + trackingRecall: + format: float + description: Tracking recall. + type: number + trackingPrecision: + format: float + type: number + description: Tracking precision. + mismatchRate: + type: number + description: >- + Mismatch rate, which measures the tracking consistency, i.e. + correctness of instance ID continuity. + format: float + boundingBoxIou: + description: >- + Bounding box intersection-over-union precision. Measures how well + the bounding boxes overlap between each other (e.g. complete overlap + or just barely above iou_threshold). + type: number + format: float + description: Metrics for a single confidence threshold. + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec: + type: object + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec + properties: + version: + type: integer + format: int32 + description: Optional. Which version to use for evaluation. + useReference: + type: boolean + description: >- + Optional. Whether to use instance.reference to compute question + answering helpfulness. + description: Spec for question answering helpfulness metric. + GoogleCloudAiplatformV1ListFeatureViewsResponse: + type: object + properties: + nextPageToken: type: string - format: int64 description: >- - The number of examples in the dataset that have been truncated by - any amount. - userDatasetExamples: + A token, which can be sent as ListFeatureViewsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + featureViews: + description: The FeatureViews matching the request. type: array - readOnly: true - description: Output only. Sample user messages in the training dataset uri. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - totalBillableTokenCount: - format: int64 - description: Output only. Number of billable tokens in the tuning dataset. - readOnly: true - type: string - truncatedExampleIndices: items: - format: int64 - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + id: GoogleCloudAiplatformV1ListFeatureViewsResponse + description: Response message for FeatureOnlineStoreAdminService.ListFeatureViews. + GoogleCloudAiplatformV1SampledShapleyAttribution: + properties: + pathCount: + format: int32 description: >- - A partial sample of the indices (starting from 1) of the truncated - examples. - type: array - userMessagePerExampleDistribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - readOnly: true - description: Output only. Dataset distributions for the messages per example. - userInputTokenDistribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - description: Output only. Dataset distributions for the user input tokens. - readOnly: true - totalTuningCharacterCount: - readOnly: true - description: Output only. Number of tuning characters in the tuning dataset. - format: int64 - type: string - description: Tuning data statistics for Supervised Tuning. - GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult: + Required. The number of feature permutations to consider when + approximating the Shapley values. Valid range of its value is [1, + 50], inclusively. + type: integer + id: GoogleCloudAiplatformV1SampledShapleyAttribution type: object + description: >- + An attribution method that approximates Shapley values for features that + contribute to the label being predicted. A sampling strategy is used to + approximate the value rather than considering all subsets of features. + GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult: id: >- GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult + description: Prediction output format for Tabular Classification. + type: object properties: - classes: - type: array - description: >- - The name of the classes being classified, contains all possible - values of the target column. - items: - type: string scores: items: format: float @@ -12520,5321 +11109,4674 @@ components: means higher confidence. The N-th score corresponds to the N-th class in classes. type: array - description: Prediction output format for Tabular Classification. - GoogleCloudAiplatformV1FeatureOnlineStore: - id: GoogleCloudAiplatformV1FeatureOnlineStore - properties: - dedicatedServingEndpoint: + classes: + items: + type: string description: >- - Optional. The dedicated serving endpoint for this - FeatureOnlineStore, which is different from common Vertex service - endpoint. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint - updateTime: - format: google-datetime - readOnly: true + The name of the classes being classified, contains all possible + values of the target column. + type: array + GoogleCloudAiplatformV1CancelTuningJobRequest: + type: object + description: Request message for GenAiTuningService.CancelTuningJob. + id: GoogleCloudAiplatformV1CancelTuningJobRequest + properties: {} + GoogleCloudAiplatformV1DirectRawPredictRequest: + description: Request message for PredictionService.DirectRawPredict. + id: GoogleCloudAiplatformV1DirectRawPredictRequest + properties: + methodName: + type: string description: >- - Output only. Timestamp when this FeatureOnlineStore was last - updated. + Fully qualified name of the API method being invoked to perform + predictions. Format: `/namespace.Service/Method/` Example: + `/tensorflow.serving.PredictionService/Predict` + input: + format: byte type: string - etag: + description: The prediction input. + type: object + CloudAiLargeModelsVisionImage: + id: CloudAiLargeModelsVisionImage + properties: + uri: + type: string + description: Path to another storage (typically Google Cloud Storage). + text: + type: string + description: Text/Expanded text input for imagen. + semanticFilterResponse: + description: Semantic filter info for image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' + image: + type: string + format: byte + description: Raw bytes. + encoding: type: string + description: Image encoding, encoded as "image/png" or "image/jpg". + imageRaiScores: + $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' + description: RAI scores for generated image. + generationSeed: + type: integer + format: int32 description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - satisfiesPzs: + Generation seed for the sampled image. This parameter is exposed to + the user only if one of the following is true: 1. The user specified + per-example seeds in the request. 2. The user doesn't specify the + generation seed in the request. + raiInfo: + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' + description: RAI info for image. + type: object + description: Image. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs: + properties: + disableEarlyStopping: type: boolean - description: Output only. Reserved for future use. - readOnly: true - labels: description: >- - Optional. The labels with user-defined metadata to organize your - FeatureOnlineStore. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one FeatureOnlineStore(System labels are excluded)." System - reserved label keys are prefixed with "aiplatform.googleapis.com/" - and are immutable. - type: object - additionalProperties: - type: string - createTime: - type: string - readOnly: true - description: Output only. Timestamp when this FeatureOnlineStore was created. - format: google-datetime - optimized: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreOptimized + Use the entire training budget. This disables the early stopping + feature. When false the early stopping feature is enabled, which + means that AutoML Image Object Detection might stop training before + the entire training budget has been used. + budgetMilliNodeHours: description: >- - Contains settings for the Optimized store that will be created to - serve featureValues for all FeatureViews under this - FeatureOnlineStore. When choose Optimized storage type, need to set - PrivateServiceConnectConfig.enable_private_service_connect to use - private endpoint. Otherwise will use public endpoint by default. - name: + The training budget of creating this model, expressed in milli node + hours i.e. 1,000 value in this field means 1 node hour. The actual + metadata.costMilliNodeHours will be equal or less than this value. + If further model training ceases to provide any improvements, it + will stop without using the full budget and the + metadata.successfulStopReason will be `model-converged`. Note, + node_hour = actual_hour * number_of_nodes_involved. For modelType + `cloud`(default), the budget must be between 20,000 and 900,000 + milli node hours, inclusive. The default value is 216,000 which + represents one day in wall time, considering 9 nodes are used. For + model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, + `mobile-tf-high-accuracy-1` the training budget must be between + 1,000 and 100,000 milli node hours, inclusive. The default value is + 24,000 which represents one day in wall time on a single node that + is used. + format: int64 type: string - description: >- - Identifier. Name of the FeatureOnlineStore. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` - bigtable: + tunableParameter: + description: Trainer type for Vision TrainRequest. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + uptrainBaseModelId: + type: string description: >- - Contains settings for the Cloud Bigtable instance that will be - created to serve featureValues for all FeatureViews under this - FeatureOnlineStore. - state: + The ID of `base` model for upTraining. If it is specified, the new + model will be upTrained based on the `base` model for upTraining. + Otherwise, the new model will be trained from scratch. The `base` + model for upTraining must be in the same Project and Location as the + new Model to train, and have the same modelType. + modelType: enum: - - STATE_UNSPECIFIED - - STABLE - - UPDATING + - MODEL_TYPE_UNSPECIFIED + - CLOUD_HIGH_ACCURACY_1 + - CLOUD_LOW_LATENCY_1 + - CLOUD_1 + - MOBILE_TF_LOW_LATENCY_1 + - MOBILE_TF_VERSATILE_1 + - MOBILE_TF_HIGH_ACCURACY_1 + - CLOUD_STREAMING_1 + - SPINENET + - YOLO type: string - description: Output only. State of the featureOnlineStore. enumDescriptions: - - Default value. This value is unused. + - Should not be set. - >- - State when the featureOnlineStore configuration is not being - updated and the fields reflect the current configuration of the - featureOnlineStore. The featureOnlineStore is usable in this - state. + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to have a higher latency, but should + also have a higher prediction quality than other cloud models. - >- - The state of the featureOnlineStore configuration when it is being - updated. During an update, the fields reflect either the original - configuration or the updated configuration of the - featureOnlineStore. The featureOnlineStore is still usable in this - state. - readOnly: true - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Optional. Customer-managed encryption key spec for data storage. If - set, online store will be secured by this key. - satisfiesPzi: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - description: >- - Vertex AI Feature Online Store provides a centralized repository for - serving ML features and embedding indexes at low latency. The Feature - Online Store is a top-level container. + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to have a low latency, but may have + lower prediction quality than other cloud models. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Compared to the CLOUD_HIGH_ACCURACY_1 and + CLOUD_LOW_LATENCY_1 models above, it is expected to have higher + prediction quality and lower latency. + - >- + A model that, in addition to being available within Google Cloud + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. Expected to have + low latency, but may have lower prediction quality than other + mobile models. + - >- + A model that, in addition to being available within Google Cloud + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. Expected to have + a higher latency, but should also have a higher prediction quality + than other mobile models. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to best support predictions in + streaming with lower latency and lower prediction quality than + other cloud models. + - >- + SpineNet for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + YOLO for Model Garden training with customizable hyperparameters. + Best tailored to be used within Google Cloud, and cannot be + exported externally. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs + type: object + GoogleCloudAiplatformV1DeployedModel: + description: A deployment of a Model. Endpoints contain one or more DeployedModels. + id: GoogleCloudAiplatformV1DeployedModel type: object - GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig: - id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig properties: + serviceAccount: + description: >- + The service account that the DeployedModel's container runs as. + Specify the email address of the service account. If this service + account is not specified, the container runs as a service account + that doesn't have access to the resource project. Users deploying + the Model must have the `iam.serviceAccounts.actAs` permission on + this service account. + type: string model: description: >- - Required. Full resource name of automl Model. Format: - `projects/{project}/locations/{location}/models/{model}`. + Required. The resource name of the Model that this is the deployment + of. Note that the Model may be in a different location than the + DeployedModel's Endpoint. The resource name may contain version id + or version alias to specify the version. Example: + `projects/{project}/locations/{location}/models/{model}@2` or + `projects/{project}/locations/{location}/models/{model}@golden` if + no version is specified, the default version will be deployed. type: string - modelDisplayName: + createTime: type: string + readOnly: true + format: google-datetime + description: Output only. Timestamp when the DeployedModel was created. + privateEndpoints: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' description: >- - Optional. Display name of the model in Vertex AI. System will pick a - display name if unspecified. - description: >- - Config for migrating Model in automl.googleapis.com to Vertex AI's - Model. - type: object - GoogleCloudAiplatformV1CreateTensorboardRunRequest: - type: object - id: GoogleCloudAiplatformV1CreateTensorboardRunRequest - description: Request message for TensorboardService.CreateTensorboardRun. - properties: - tensorboardRun: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - description: Required. The TensorboardRun to create. - tensorboardRunId: - type: string + Output only. Provide paths for users to send predict/explain/health + requests directly to the deployed model services running on Cloud + via private services access. This field is populated if network is + configured. + dedicatedResources: description: >- - 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-/`. - parent: + A description of resources that are dedicated to the DeployedModel, + and that need a higher degree of manual configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + modelVersionId: + description: Output only. The version ID of the model that is deployed. + type: string + readOnly: true + id: type: string description: >- - Required. The resource name of the TensorboardExperiment to create - the TensorboardRun in. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` - GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig: - properties: - desiredMinSafeTrialsFraction: + Immutable. The ID of the DeployedModel. If not provided upon + deployment, Vertex AI will generate a value for this ID. This value + should be 1-10 characters, and valid characters are `/[0-9]/`. + disableExplanations: + type: boolean description: >- - Desired minimum fraction of safe trials (over total number of - trials) that should be targeted by the algorithm at any time during - the study (best effort). This should be between 0.0 and 1.0 and a - value of 0.0 means that there is no minimum and an algorithm - proceeds without targeting any specific fraction. A value of 1.0 - means that the algorithm attempts to only Suggest safe Trials. - format: double - type: number - safetyThreshold: + If true, deploy the model without explainable feature, regardless + the existence of Model.explanation_spec or explanation_spec. + disableContainerLogging: description: >- - Safety threshold (boundary value between safe and unsafe). NOTE that - if you leave SafetyMetricConfig unset, a default value of 0 will be - used. - type: number - format: double - description: >- - Used in safe optimization to specify threshold levels and risk - tolerance. - id: GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig - type: object - GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey: - id: GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey - properties: - parts: - items: - type: string - type: array - description: >- - Parts to construct Entity ID. Should match with the same ID columns - as defined in FeatureView in the same order. - description: ID that is comprised from several parts (columns). - type: object - GoogleCloudAiplatformV1ListFeatureViewsResponse: - description: Response message for FeatureOnlineStoreAdminService.ListFeatureViews. - properties: - featureViews: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' - type: array - description: The FeatureViews matching the request. - nextPageToken: + For custom-trained Models and AutoML Tabular Models, the container + of the DeployedModel instances will send `stderr` and `stdout` + streams to Cloud Logging by default. Please note that the logs incur + cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging/pricing). User can disable + container logging by setting this flag to true. + type: boolean + displayName: type: string description: >- - A token, which can be sent as ListFeatureViewsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - id: GoogleCloudAiplatformV1ListFeatureViewsResponse - type: object - GoogleCloudAiplatformV1IndexDatapoint: - type: object - description: A datapoint of Index. - properties: - sparseEmbedding: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding - description: Optional. Feature embedding vector for sparse index. - crowdingTag: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag - description: >- - Optional. CrowdingTag of the datapoint, the number of neighbors to - return in each crowding can be configured during query. - numericRestricts: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction - description: >- - Optional. List of Restrict of the datapoint, used to perform - "restricted searches" where boolean rule are used to filter the - subset of the database eligible for matching. This uses numeric - comparisons. - type: array - restricts: - type: array - description: >- - Optional. List of Restrict of the datapoint, used to perform - "restricted searches" where boolean rule are used to filter the - subset of the database eligible for matching. This uses categorical - tokens. See: - https://cloud.google.com/vertex-ai/docs/matching-engine/filtering - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction - featureVector: - type: array - items: - type: number - format: float + The display name of the DeployedModel. If not provided upon + creation, the Model's display_name is used. + automaticResources: description: >- - Required. Feature embedding vector for dense index. An array of - numbers with the length of [NearestNeighborSearchConfig.dimensions]. - datapointId: - description: Required. Unique identifier of the datapoint. + A description of resources that to large degree are decided by + Vertex AI, and require only a modest additional configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + sharedResources: type: string - id: GoogleCloudAiplatformV1IndexDatapoint - GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec: - description: >- - Selects Features of an EntityType to read values of and specifies read - settings. - type: object - properties: - settings: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting - type: array - description: Per-Feature settings for the batch read. - featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' description: >- - Required. Selectors choosing which Feature values to read from the - EntityType. - entityTypeId: + The resource name of the shared DeploymentResourcePool to deploy on. + Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + enableAccessLogging: description: >- - Required. ID of the EntityType to select Features. The EntityType id - is the entity_type_id specified during EntityType creation. - type: string - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec - GoogleCloudAiplatformV1MigratableResourceAutomlDataset: - id: GoogleCloudAiplatformV1MigratableResourceAutomlDataset - type: object - description: Represents one Dataset in automl.googleapis.com. - properties: - dataset: - type: string + If true, online prediction access logs are sent to Cloud Logging. + These logs are like standard server access logs, containing + information like timestamp and latency for each prediction request. + Note that logs may incur a cost, especially if your project receives + prediction requests at a high queries per second rate (QPS). + Estimate your costs before enabling this option. + type: boolean + explanationSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' description: >- - Full resource name of automl Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}`. - datasetDisplayName: - description: The Dataset's display name in automl.googleapis.com. - type: string - GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest: + Explanation configuration for this DeployedModel. When deploying a + Model using EndpointService.DeployModel, this value overrides the + value of Model.explanation_spec. All fields of explanation_spec are + optional in the request. If a field of explanation_spec is not + populated, the value of the same field of Model.explanation_spec is + inherited. If the corresponding Model.explanation_spec is not + populated, all fields of the explanation_spec will be used for the + explanation configuration. + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec: type: object + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec properties: - names: + useReference: description: >- - Required. The names of the PipelineJobs to cancel. A maximum of 32 - PipelineJobs can be cancelled in a batch. Format: - `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` - items: - type: string - type: array - id: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest - description: Request message for PipelineService.BatchCancelPipelineJobs. - GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse: - id: GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse + Optional. Whether to use instance.reference to compute question + answering correctness. + type: boolean + version: + description: Optional. Which version to use for evaluation. + type: integer + format: int32 + description: Spec for question answering correctness metric. + GoogleCloudAiplatformV1Schedule: + description: >- + An instance of a Schedule periodically schedules runs to make API calls + based on user specified time specification and API request type. properties: - nextPageToken: - description: >- - A token to retrieve next page of results. Pass to - ListNotebookExecutionJobs.page_token to obtain that page. + displayName: type: string - notebookExecutionJobs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' - description: List of NotebookExecutionJobs in the requested page. - description: Response message for [NotebookService.CreateNotebookExecutionJob] - type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig: - properties: - attributionScoreSkewThresholds: - type: object - description: >- - Key is the feature name and value is the threshold. The threshold - here is against attribution score distance between the training and - prediction feature. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - skewThresholds: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - type: object description: >- - Key is the feature name and value is the threshold. If a feature - needs to be monitored for skew, a value threshold must be configured - for that feature. The threshold here is against feature distribution - distance between the training and prediction feature. - defaultSkewThreshold: - description: >- - Skew anomaly detection threshold used by all features. When the - per-feature thresholds are not set, this field can be used to - specify a threshold for all features. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - type: object - description: >- - The config for Training & Prediction data skew detection. It specifies - the training dataset sources and the skew detection parameters. - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig - GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata: - id: >- - GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata - type: object - description: All metadata of most recent monitoring pipelines. - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the most recent monitoring pipeline. - runTime: + Required. User provided name of the Schedule. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + nextRunTime: description: >- - The time that most recent monitoring pipelines that is related to - this run. + Output only. Timestamp when this Schedule should schedule the next + run. Having a next_run_time in the past means the runs are being + started behind schedule. type: string format: google-datetime - GoogleCloudAiplatformV1FeaturestoreMonitoringConfig: - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfig - properties: - snapshotAnalysis: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis - description: The config for Snapshot Analysis Based Feature Monitoring. - categoricalThresholdConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig - description: >- - Threshold for categorical features of anomaly detection. This is - shared by all types of Featurestore Monitoring for categorical - features (i.e. Features with type (Feature.ValueType) BOOL or - STRING). - numericalThresholdConfig: - description: >- - Threshold for numerical features of anomaly detection. This is - shared by all objectives of Featurestore Monitoring for numerical - features (i.e. Features with type (Feature.ValueType) DOUBLE or - INT64). - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig - importFeaturesAnalysis: + readOnly: true + createNotebookExecutionJobRequest: + description: Request for NotebookService.CreateNotebookExecutionJob. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis - description: The config for ImportFeatures Analysis Based Feature Monitoring. - type: object - description: Configuration of how features in Featurestore are monitored. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs: - type: object - properties: - targetColumn: + #/components/schemas/GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest + maxConcurrentRunCount: + format: int64 type: string description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. - dataGranularity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity - description: Expected difference in time granularity between rows in the data. - contextWindow: + Required. Maximum number of runs that can be started concurrently + for this Schedule. This is the limit for starting the scheduled + requests and not the execution of the operations/jobs created by the + requests (if applicable). + createTime: + readOnly: true + format: google-datetime + description: Output only. Timestamp when this Schedule was created. type: string - description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. - format: int64 - hierarchyConfig: - description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - additionalExperiments: - description: Additional experiment flags for the time series forcasting training. - items: - type: string - type: array - forecastHorizon: + state: + description: Output only. The state of this Schedule. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - PAUSED + - COMPLETED + enumDescriptions: + - Unspecified. + - >- + The Schedule is active. Runs are being scheduled on the + user-specified timespec. + - >- + The schedule is paused. No new runs will be created until the + schedule is resumed. Already started runs will be allowed to + complete. + - >- + The Schedule is completed. No new runs will be scheduled. Already + started runs will be allowed to complete. Schedules in completed + state cannot be paused or resumed. + readOnly: true + type: string + updateTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Timestamp when this Schedule was updated. + endTime: + format: google-datetime type: string description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - format: int64 - trainBudgetMilliNodeHours: + Optional. Timestamp after which no new runs can be scheduled. If + specified, The schedule will be completed when either end_time is + reached or when scheduled_run_count >= max_run_count. If not + specified, new runs will keep getting scheduled until this Schedule + is paused or deleted. Already scheduled runs will be allowed to + complete. Unset if not specified. + maxRunCount: description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. + Optional. Maximum run count of the schedule. If specified, The + schedule will be completed when either started_run_count >= + max_run_count or when end_time is reached. If not specified, new + runs will keep getting scheduled until this Schedule is paused or + deleted. Already scheduled runs will be allowed to complete. Unset + if not specified. format: int64 type: string - unavailableAtForecastColumns: + allowQueueing: description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. - type: array - items: - type: string - timeSeriesAttributeColumns: - items: - type: string + Optional. Whether new scheduled runs can be queued when + max_concurrent_runs limit is reached. If set to true, new runs will + be queued instead of skipped. Default to false. + type: boolean + catchUp: description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - type: array - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. + Output only. Whether to backfill missed runs when the schedule is + resumed from PAUSED state. If set to true, all missed runs will be + scheduled. New runs will be scheduled after the backfill is + complete. Default to false. + type: boolean + readOnly: true + startTime: + format: google-datetime type: string - validationOptions: + description: >- + Optional. Timestamp after which the first run can be scheduled. + Default to Schedule create time if not specified. + lastScheduledRunResponse: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ScheduleRunResponse' + description: >- + Output only. Response of the last scheduled run. This is the + response for starting the scheduled requests and not the execution + of the operations/jobs created by the requests (if applicable). + Unset if no run has been scheduled yet. + cron: type: string description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue - optimizationObjective: + Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch + scheduled runs. To explicitly set a timezone to the cron tab, apply + a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * + * *". + createPipelineJobRequest: description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. + Request for PipelineService.CreatePipelineJob. + CreatePipelineJobRequest.parent field is required (format: + projects/{project}/locations/{location}). + $ref: '#/components/schemas/GoogleCloudAiplatformV1CreatePipelineJobRequest' + startedRunCount: + description: Output only. The number of runs started by this schedule. + readOnly: true + format: int64 type: string - availableAtForecastColumns: - type: array + name: + description: Immutable. The resource name of the Schedule. + type: string + lastResumeTime: description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. - items: - type: string - weightColumn: + Output only. Timestamp when this Schedule was last resumed. Unset if + never resumed from pause. + readOnly: true + format: google-datetime type: string + lastPauseTime: + readOnly: true description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. This column must be available at forecast. - holidayRegions: - items: - type: string - type: array + Output only. Timestamp when this Schedule was last paused. Unset if + never paused. + type: string + format: google-datetime + type: object + id: GoogleCloudAiplatformV1Schedule + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics: + type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + properties: + maxPredictions: + type: integer + format: int32 description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. - windowConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - description: Config containing strategy for generating sliding windows. - timeColumn: + Metrics are computed with an assumption that the Model always + returns at most this many predictions (ordered by their score, + descendingly), but they all still need to meet the + `confidenceThreshold`. + f1ScoreAt1: + description: The harmonic mean of recallAt1 and precisionAt1. + type: number + format: float + falseNegativeCount: + format: int64 + type: string description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. + The number of ground truth labels that are not matched by a Model + created label. + trueNegativeCount: type: string - quantiles: - type: array + format: int64 description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`. Up to 5 quantiles are allowed of values - between 0 and 1, exclusive. Required if the value of - optimization_objective is minimize-quantile-loss. Represents the - percent quantiles to use for that objective. Quantiles must be - unique. - items: - type: number - format: double - transformations: - type: array - description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation - exportEvaluatedDataItemsConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs - GoogleCloudAiplatformV1CustomJobSpec: - type: object - properties: - workerPoolSpecs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' - type: array + The number of labels that were not created by the Model, but if they + would, they would not match a ground truth label. + precision: + format: float + type: number + description: Precision for the given confidence threshold. + confidenceThreshold: description: >- - Required. The spec of the worker pools including machine type and - Docker image. All worker pools except the first one are optional and - can be skipped by providing an empty value. - tensorboard: + Metrics are computed with an assumption that the Model never returns + predictions with score lower than this value. + type: number + format: float + truePositiveCount: type: string + format: int64 + description: The number of Model created labels that match a ground truth label. + f1ScoreMicro: + type: number + format: float + description: Micro-averaged F1 Score. + f1Score: + type: number description: >- - Optional. The name of a Vertex AI Tensorboard resource to which this - CustomJob will upload Tensorboard logs. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}` - experimentRun: + The harmonic mean of recall and precision. For summary metrics, it + computes the micro-averaged F1 score. + format: float + recallAt1: description: >- - Optional. The Experiment Run associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` - type: string - reservedIpRanges: - items: - type: string - type: array + The Recall (True Positive Rate) when only considering the label that + has the highest prediction score and not below the confidence + threshold for each DataItem. + format: float + type: number + recall: + type: number + description: Recall (True Positive Rate) for the given confidence threshold. + format: float + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: Confusion matrix of the evaluation for this confidence_threshold. + f1ScoreMacro: + format: float + type: number + description: Macro-averaged F1 Score. + precisionAt1: description: >- - Optional. A list of names for the reserved ip ranges under the VPC - network that can be used for this job. If set, we will deploy the - job within the provided ip ranges. Otherwise, the job will be - deployed to any ip ranges under the provided VPC network. Example: - ['vertex-ai-ip-range']. - scheduling: - description: Scheduling options for a CustomJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' - protectedArtifactLocationId: - type: string + The precision when only considering the label that has the highest + prediction score and not below the confidence threshold for each + DataItem. + type: number + format: float + falsePositiveCount: + format: int64 description: >- - The ID of the location to store protected artifacts. e.g. - us-central1. Populate only when the location is different than - CustomJob location. List of supported locations: - https://cloud.google.com/vertex-ai/docs/general/locations - serviceAccount: + The number of Model created labels that do not match a ground truth + label. type: string + falsePositiveRate: + format: float + type: number + description: False Positive Rate for the given confidence threshold. + falsePositiveRateAt1: + type: number description: >- - Specifies the service account for workload run-as account. Users - submitting jobs must have act-as permission on this run-as account. - If unspecified, the [Vertex AI Custom Code Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) - for the CustomJob's project is used. - baseOutputDirectory: - description: >- - The Cloud Storage location to store the output of this CustomJob or - HyperparameterTuningJob. For HyperparameterTuningJob, the - baseOutputDirectory of each child CustomJob backing a Trial is set - to a subdirectory of name id under its parent - HyperparameterTuningJob's baseOutputDirectory. The following Vertex - AI environment variables will be passed to containers or python - modules when this field is set: For CustomJob: * AIP_MODEL_DIR = - `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * - AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of - HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * - AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = - `//logs/` - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - enableWebAccess: - description: >- - Optional. Whether you want Vertex AI to enable [interactive shell - access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - to training containers. If set to `true`, you can access interactive - shells at the URIs given by CustomJob.web_access_uris or - Trial.web_access_uris (within HyperparameterTuningJob.trials). - type: boolean - experiment: + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each DataItem. + format: float + GoogleCloudAiplatformV1DeployIndexResponse: + type: object + description: Response message for IndexEndpointService.DeployIndex. + properties: + deployedIndex: + description: The DeployedIndex that had been deployed in the IndexEndpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + id: GoogleCloudAiplatformV1DeployIndexResponse + GoogleCloudAiplatformV1CoherenceInstance: + description: Spec for coherence instance. + properties: + prediction: + description: Required. Output of the evaluated model. type: string - description: >- - Optional. The Experiment associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` - models: - items: - type: string - type: array - description: >- - Optional. The name of the Model resources for which to generate a - mapping to artifact URIs. Applicable only to some of the - Google-provided custom jobs. 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. - persistentResourceId: + type: object + id: GoogleCloudAiplatformV1CoherenceInstance + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata: + type: object + properties: + bestTrialBackingCustomJob: type: string description: >- - Optional. The ID of the PersistentResource in the same Project and - Location which to run If this is specified, the job will be run on - existing machines held by the PersistentResource instead of - on-demand short-live machines. The network and CMEK configs on the - job should be consistent with those on the PersistentResource, - otherwise, the job will be rejected. - network: + The resource name of the CustomJob that has been created to run the + best Trial of this HyperparameterTuning task. + backingHyperparameterTuningJob: description: >- - Optional. The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to which - the Job should be peered. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - To specify this field, you must have already [configured VPC Network - Peering for Vertex - AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If - this field is left unspecified, the job is not peered with any - network. + The resource name of the HyperparameterTuningJob that has been + created to carry out this HyperparameterTuning task. type: string - enableDashboardAccess: - description: >- - Optional. Whether you want Vertex AI to enable access to the - customized dashboard in training chief container. If set to `true`, - you can access the dashboard at the URIs given by - CustomJob.web_access_uris or Trial.web_access_uris (within - HyperparameterTuningJob.trials). - type: boolean - id: GoogleCloudAiplatformV1CustomJobSpec - description: Represents the spec of a CustomJob. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + GoogleCloudAiplatformV1ListNotebookRuntimesResponse: type: object + id: GoogleCloudAiplatformV1ListNotebookRuntimesResponse + description: Response message for NotebookService.ListNotebookRuntimes. properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs - description: The input parameters of this TrainingJob. - description: A TrainingJob that trains and uploads an AutoML Text Sentiment Model. - GoogleCloudAiplatformV1FeatureViewIndexConfig: - id: GoogleCloudAiplatformV1FeatureViewIndexConfig - description: Configuration for vector indexing. - properties: - bruteForceConfig: - description: >- - Optional. Configuration options for using brute force search, which - simply implements the standard linear search in the database for - each query. It is primarily meant for benchmarking and to generate - the ground truth for approximate search. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig - embeddingDimension: - format: int32 - type: integer - description: Optional. The number of dimensions of the input embedding. - distanceMeasureType: - enum: - - DISTANCE_MEASURE_TYPE_UNSPECIFIED - - SQUARED_L2_DISTANCE - - COSINE_DISTANCE - - DOT_PRODUCT_DISTANCE - enumDescriptions: - - Should not be set. - - Euclidean (L_2) Distance. - - >- - Cosine Distance. Defined as 1 - cosine similarity. We strongly - suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of - COSINE distance. Our algorithms have been more optimized for - DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is - mathematically equivalent to COSINE distance and results in the - same ranking. - - Dot Product Distance. Defined as a negative of the dot product. - type: string - description: Optional. The distance measure used in nearest neighbor search. - crowdingColumn: + nextPageToken: description: >- - Optional. Column of crowding. This column contains crowding - attribute which is a constraint on a neighbor list produced by - FeatureOnlineStoreService.SearchNearestEntities to diversify search - results. If - NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to - K in SearchNearestEntitiesRequest, it's guaranteed that no more than - K entities of the same crowding attribute are returned in the - response. + A token to retrieve next page of results. Pass to + ListNotebookRuntimesRequest.page_token to obtain that page. type: string - filterColumns: + notebookRuntimes: items: - type: string - description: >- - Optional. Columns of features that're used to filter vector search - results. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' type: array - treeAhConfig: - description: >- - Optional. Configuration options for the tree-AH algorithm (Shallow - tree + Asymmetric Hashing). Please refer to this paper for more - details: https://arxiv.org/abs/1908.10396 - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig - embeddingColumn: - description: >- - Optional. Column of embedding. This column contains the source data - to create index for vector search. embedding_column must be set when - using vector search. - type: string - type: object - GoogleCloudAiplatformV1RemoveDatapointsRequest: - description: Request message for IndexService.RemoveDatapoints + description: List of NotebookRuntimes in the requested page. + GoogleCloudAiplatformV1RemoveContextChildrenRequest: properties: - datapointIds: - description: A list of datapoint ids to be deleted. + childContexts: + type: array items: type: string - type: array - id: GoogleCloudAiplatformV1RemoveDatapointsRequest - type: object - GoogleCloudAiplatformV1PauseScheduleRequest: - description: Request message for ScheduleService.PauseSchedule. + description: The resource names of the child Contexts. + description: Request message for MetadataService.DeleteContextChildrenRequest. + id: GoogleCloudAiplatformV1RemoveContextChildrenRequest type: object - id: GoogleCloudAiplatformV1PauseScheduleRequest - properties: {} - GoogleCloudAiplatformV1TrainingConfig: + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult: + description: Spec for question answering helpfulness result. type: object - id: GoogleCloudAiplatformV1TrainingConfig + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult properties: - timeoutTrainingMilliHours: - description: >- - The timeout hours for the CMLE training job, expressed in milli - hours i.e. 1,000 value in this field means 1 hour. + explanation: + readOnly: true + description: Output only. Explanation for question answering helpfulness score. type: string - format: int64 - description: >- - CMLE training config. For every active learning labeling iteration, - system will train a machine learning model on CMLE. The trained model - will be used by data sampling algorithm to select DataItems. - GoogleCloudAiplatformV1XraiAttribution: - type: object - id: GoogleCloudAiplatformV1XraiAttribution + score: + description: Output only. Question Answering Helpfulness score. + readOnly: true + type: number + format: float + confidence: + format: float + type: number + description: Output only. Confidence for question answering helpfulness score. + readOnly: true + GoogleCloudAiplatformV1DatasetVersion: properties: - smoothGradConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' - description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy - samples in the vicinity of the inputs. Adding noise can help improve - the computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf - stepCount: - type: integer - format: int32 + modelReference: + readOnly: true description: >- - Required. The number of steps for approximating the path integral. A - good value to start is 50 and gradually increase until the sum to - diff property is met within the desired error range. Valid range of - its value is [1, 100], inclusively. - blurBaselineConfig: + Output only. Reference to the public base model last used by the + dataset version. Only set for prompt dataset versions. + type: string + displayName: + type: string description: >- - Config for XRAI with blur baseline. When enabled, a linear path from - the maximally blurred image to the input image is created. Using a - blurred baseline instead of zero (black image) is motivated by the - BlurIG approach explained here: https://arxiv.org/abs/2004.03383 - $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' - description: >- - An explanation method that redistributes Integrated Gradients - attributions to segmented regions, taking advantage of the model's fully - differentiable structure. Refer to this paper for more details: - https://arxiv.org/abs/1906.02825 Supported only by image Models. - GoogleCloudAiplatformV1PersistentDiskSpec: - id: GoogleCloudAiplatformV1PersistentDiskSpec - properties: - diskType: + The user-defined name of the DatasetVersion. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + updateTime: + description: Output only. Timestamp when this DatasetVersion was last updated. + readOnly: true + format: google-datetime + type: string + createTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Timestamp when this DatasetVersion was created. + bigQueryDatasetName: + type: string + readOnly: true + description: Output only. Name of the associated BigQuery dataset. + metadata: + readOnly: true + type: any 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) + Required. Output only. Additional information about the + DatasetVersion. + name: + readOnly: true + description: Output only. Identifier. The resource name of the DatasetVersion. type: string - diskSizeGb: + etag: + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string - format: int64 - description: Size in GB of the disk (default is 100GB). - description: Represents the spec of persistent disk options. + id: GoogleCloudAiplatformV1DatasetVersion type: object - GoogleCloudAiplatformV1FeatureNoiseSigma: - description: >- - Noise sigma by features. Noise sigma represents the standard deviation - of the gaussian kernel that will be used to add noise to interpolated - inputs prior to computing gradients. + description: Describes the dataset version. + GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse: + id: GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + description: Response message for JobService.ListModelDeploymentMonitoringJobs. type: object - id: GoogleCloudAiplatformV1FeatureNoiseSigma properties: - noiseSigma: - description: >- - Noise sigma per feature. No noise is added to features that are not - set. + nextPageToken: + type: string + description: The standard List next-page token. + modelDeploymentMonitoringJobs: type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature - GoogleCloudAiplatformV1CancelNasJobRequest: - id: GoogleCloudAiplatformV1CancelNasJobRequest - description: Request message for JobService.CancelNasJob. - properties: {} + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + description: >- + A list of ModelDeploymentMonitoringJobs that matches the specified + filter in the request. + GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata: + id: GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata type: object - GoogleCloudAiplatformV1Artifact: - description: Instance of a general artifact. properties: - etag: - type: string + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + progressMessage: description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - schemaTitle: + A human-readable message that shows the intermediate progress + details of NotebookRuntime. type: string + description: Metadata information for NotebookService.CreateNotebookExecutionJob. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + properties: + iouScore: + type: number description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - name: - type: string - description: Output only. The resource name of the Artifact. - readOnly: true - metadata: - type: object - additionalProperties: - description: Properties of the object. - type: any + The intersection-over-union score. The measure of overlap of the + annotation's category mask with ground truth category mask on the + DataItem. + format: float + confidenceThreshold: + format: float + type: number description: >- - Properties of the Artifact. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. - updateTime: - description: Output only. Timestamp when this Artifact was last updated. - readOnly: true - format: google-datetime - type: string - labels: - additionalProperties: - type: string - type: object - description: >- - The labels with user-defined metadata to organize your Artifacts. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Artifact (System - labels are excluded). - schemaVersion: - type: string - description: >- - The version of the schema in schema_name to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. + Metrics are computed with an assumption that the model never returns + predictions with score lower than this value. + confusionMatrix: + description: Confusion matrix for the given confidence threshold. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + diceScoreCoefficient: + format: float + type: number + description: DSC or the F1 score, The harmonic mean of recall and precision. + precision: + type: number + description: Precision for the given confidence threshold. + format: float + recall: + format: float + description: Recall (True Positive Rate) for the given confidence threshold. + type: number + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry + type: object + GoogleCloudAiplatformV1PipelineTaskDetail: + properties: + executorDetail: + description: Output only. The detailed execution info. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetail + readOnly: true state: enum: - STATE_UNSPECIFIED - PENDING - - LIVE - description: >- - The state of this Artifact. This is a property of the Artifact, and - does not imply or capture any ongoing process. This property is - managed by clients (such as Vertex AI Pipelines), and the system - does not prescribe or check the validity of state transitions. + - RUNNING + - SUCCEEDED + - CANCEL_PENDING + - CANCELLING + - CANCELLED + - FAILED + - SKIPPED + - NOT_TRIGGERED + description: Output only. State of the task. enumDescriptions: - - Unspecified state for the Artifact. - - >- - A state used by systems like Vertex AI Pipelines to indicate that - the underlying data item represented by this Artifact is being - created. + - Unspecified. + - Specifies pending state for the task. + - Specifies task is being executed. + - Specifies task completed successfully. + - Specifies Task cancel is in pending state. + - Specifies task is being cancelled. + - Specifies task was cancelled. + - Specifies task failed. + - Specifies task was skipped due to cache hit. - >- - A state indicating that the Artifact should exist, unless - something external to the system deletes it. - type: string - displayName: + Specifies that the task was not triggered because the task's + trigger policy is not satisfied. The trigger policy is specified + in the `condition` field of PipelineJob.pipeline_spec. + readOnly: true type: string + outputs: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + description: Output only. The runtime output artifacts of the task. + type: object + readOnly: true + error: + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true description: >- - User provided display name of the Artifact. May be up to 128 Unicode - characters. - description: - description: Description of the Artifact + Output only. The error that occurred during task execution. Only + populated when the task's state is FAILED or CANCELLED. + inputs: + description: Output only. The runtime input artifacts of the task. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + readOnly: true + type: object + parentTaskId: + format: int64 + description: >- + Output only. The id of the parent task if the task is within a + component scope. Empty if the task is at the root level. type: string - uri: + readOnly: true + startTime: + format: google-datetime + description: Output only. Task start time. + readOnly: true + type: string + execution: + readOnly: true + description: Output only. The execution metadata of the task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + endTime: + readOnly: true + description: Output only. Task end time. + format: google-datetime type: string + taskName: description: >- - The uniform resource identifier of the artifact file. May be empty - if there is no actual artifact file. + Output only. The user specified name of the task that is defined in + pipeline_spec. + readOnly: true + type: string + taskId: + readOnly: true + type: string + format: int64 + description: Output only. The system generated ID of the task. createTime: type: string format: google-datetime - description: Output only. Timestamp when this Artifact was created. readOnly: true - id: GoogleCloudAiplatformV1Artifact - type: object - GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse: - description: Response message for ModelService.BatchImportModelEvaluationSlices - properties: - importedModelEvaluationSlices: + description: Output only. Task create time. + pipelineTaskStatus: type: array - description: Output only. List of imported ModelEvaluationSlice.name. readOnly: true + description: >- + Output only. A list of task status. This field keeps a record of + task status evolving over time. items: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus + description: The runtime detail of a task execution. type: object - id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse - GoogleCloudAiplatformV1SyncFeatureViewResponse: - id: GoogleCloudAiplatformV1SyncFeatureViewResponse - description: Response message for FeatureOnlineStoreAdminService.SyncFeatureView. + id: GoogleCloudAiplatformV1PipelineTaskDetail + GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec: + description: Value specification for a parameter in `INTEGER` type. + type: object + id: GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec properties: - featureViewSync: + defaultValue: + format: int64 description: >- - Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` + A default value for an `INTEGER` parameter that is assumed to be a + relatively good starting point. Unset value signals that there is no + offered starting point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. type: string + maxValue: + type: string + format: int64 + description: Required. Inclusive maximum value of the parameter. + minValue: + format: int64 + description: Required. Inclusive minimum value of the parameter. + type: string + GoogleCloudAiplatformV1ResourceRuntime: + id: GoogleCloudAiplatformV1ResourceRuntime + properties: + accessUris: + type: object + readOnly: true + description: >- + Output only. URIs for user to connect to the Cluster. Example: { + "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" + "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } + additionalProperties: + type: string type: object - GoogleCloudAiplatformV1ListDatasetVersionsResponse: + description: Persistent Cluster runtime information as output + GoogleCloudAiplatformV1SearchMigratableResourcesResponse: properties: nextPageToken: type: string - description: The standard List next-page token. - datasetVersions: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + description: >- + The standard next-page token. The migratable_resources may not fill + page_size in SearchMigratableResourcesRequest even when there are + subsequent pages. + migratableResources: type: array description: >- - A list of DatasetVersions that matches the specified filter in the - request. - type: object - id: GoogleCloudAiplatformV1ListDatasetVersionsResponse - description: Response message for DatasetService.ListDatasetVersions. - GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata: + All migratable resources that can be migrated to the location + specified in the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' + description: Response message for MigrationService.SearchMigratableResources. + id: GoogleCloudAiplatformV1SearchMigratableResourcesResponse type: object - properties: - candidatesTokenCount: - format: int32 - description: Number of tokens in the response(s). - type: integer - promptTokenCount: - type: integer - format: int32 - description: >- - Number of tokens in the request. When `cached_content` is set, this - is still the total effective prompt size meaning this includes the - number of tokens in the cached content. - totalTokenCount: - format: int32 - description: Total token count for prompt and response candidates. - type: integer - description: Usage metadata about response(s). - id: GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata - GoogleCloudAiplatformV1GroundednessResult: - id: GoogleCloudAiplatformV1GroundednessResult + GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines: + id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines type: object - description: Spec for groundedness result. + description: Open fine tuning pipelines. properties: - confidence: - type: number - format: float - readOnly: true - description: Output only. Confidence for groundedness score. - score: - readOnly: true - type: number - description: Output only. Groundedness score. - format: float - explanation: - type: string - description: Output only. Explanation for groundedness score. - readOnly: true - GoogleCloudAiplatformV1SummarizationQualityResult: - description: Spec for summarization quality result. + fineTuningPipelines: + description: Required. Regional resource references to fine tuning pipelines. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + type: array + GoogleCloudAiplatformV1ComputeTokensRequest: + id: GoogleCloudAiplatformV1ComputeTokensRequest type: object - id: GoogleCloudAiplatformV1SummarizationQualityResult properties: - score: - format: float - readOnly: true - type: number - description: Output only. Summarization Quality score. - explanation: + instances: + description: >- + Optional. The instances that are the input to token computing API + call. Schema is identical to the prediction schema of the text + model, even for the non-text models, like chat models, or Codey + models. + type: array + items: + type: any + model: type: string - readOnly: true - description: Output only. Explanation for summarization quality score. - confidence: - type: number - description: Output only. Confidence for summarization quality score. - readOnly: true - format: float - GoogleCloudAiplatformV1QuestionAnsweringQualityInstance: + description: >- + Optional. The name of the publisher model requested to serve the + prediction. Format: + projects/{project}/locations/{location}/publishers/*/models/* + contents: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: Optional. Input content. + type: array + description: Request message for ComputeTokens RPC call. + GoogleCloudAiplatformV1SyncFeatureViewResponse: properties: - prediction: - type: string - description: Required. Output of the evaluated model. - reference: - description: Optional. Ground truth used to compare against the prediction. - type: string - context: - type: string - description: Required. Text to answer the question. - instruction: - description: Required. Question Answering prompt for LLM. + featureViewSync: type: string - id: GoogleCloudAiplatformV1QuestionAnsweringQualityInstance + description: >- + Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` + id: GoogleCloudAiplatformV1SyncFeatureViewResponse + description: Response message for FeatureOnlineStoreAdminService.SyncFeatureView. type: object - description: Spec for question answering quality instance. - GoogleCloudAiplatformV1ExportFractionSplit: - description: >- - Assigns the input data to training, validation, and test sets as per the - given fractions. Any of `training_fraction`, `validation_fraction` and - `test_fraction` may optionally be provided, they must sum to up to 1. If - the provided ones sum to less than 1, the remainder is assigned to sets - as decided by Vertex AI. If none of the fractions are set, by default - roughly 80% of data is used for training, 10% for validation, and 10% - for test. - id: GoogleCloudAiplatformV1ExportFractionSplit + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation: type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation properties: - validationFraction: - format: double - type: number - description: >- - The fraction of the input data that is to be used to validate the - Model. - testFraction: - description: >- - The fraction of the input data that is to be used to evaluate the - Model. - type: number - format: double - trainingFraction: - format: double - type: number + columnName: + type: string + timeFormat: description: >- - The fraction of the input data that is to be used to train the - Model. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation: - type: object + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + type: string + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification + type: object properties: - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation - categorical: + inputs: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation - timestamp: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs + description: The input parameters of this TrainingJob. + metadata: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation - GoogleCloudAiplatformV1ListIndexEndpointsResponse: - type: object + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata + description: The metadata information. + description: >- + A TrainingJob that trains and uploads an AutoML Image Classification + Model. + GoogleCloudAiplatformV1CompleteTrialRequest: + description: Request message for VizierService.CompleteTrial. properties: - indexEndpoints: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' - type: array - description: List of IndexEndpoints in the requested page. - nextPageToken: + trialInfeasible: description: >- - A token to retrieve next page of results. Pass to - ListIndexEndpointsRequest.page_token to obtain that page. + Optional. True if the Trial cannot be run with the given Parameter, + and final_measurement will be ignored. + type: boolean + finalMeasurement: + description: >- + Optional. If provided, it will be used as the completed Trial's + final_measurement; Otherwise, the service will auto-select a + previously reported measurement as the final-measurement + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + infeasibleReason: type: string - id: GoogleCloudAiplatformV1ListIndexEndpointsResponse - description: Response message for IndexEndpointService.ListIndexEndpoints. - GoogleCloudAiplatformV1ModelContainerSpec: - id: GoogleCloudAiplatformV1ModelContainerSpec - description: >- - Specification of a container for serving predictions. Some fields in - this message correspond to fields in the [Kubernetes Container v1 core - specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + description: >- + Optional. A human readable reason why the trial was infeasible. This + should only be provided if `trial_infeasible` is true. + type: object + id: GoogleCloudAiplatformV1CompleteTrialRequest + GoogleCloudAiplatformV1FeatureGroupBigQuery: + id: GoogleCloudAiplatformV1FeatureGroupBigQuery type: object properties: - startupProbe: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' - description: Immutable. Specification for Kubernetes startup probe. - imageUri: + timeSeries: description: >- - Required. Immutable. URI of the Docker image to be used as the - custom container for serving predictions. This URI must identify an - image in Artifact Registry or Container Registry. Learn more about - the [container publishing - requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), - including permissions requirements for the Vertex AI Service Agent. - The container image is ingested upon ModelService.UploadModel, - stored internally, and this original path is afterwards not used. To - learn about the requirements for the Docker image itself, see - [Custom container - requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). - You can use the URI to one of Vertex AI's [pre-built container - images for - prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) - in this field. - type: string - grpcPorts: + Optional. If the source is a time-series source, this can be set to + control how downstream sources (ex: FeatureView ) will treat + time-series sources. If not set, will treat the source as a + time-series source with `feature_timestamp` as timestamp column and + no scan boundary. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries + staticDataSource: + description: Optional. Set if the data source is not a time-series. + type: boolean + entityIdColumns: type: array description: >- - Immutable. List of ports to expose from the container. Vertex AI - sends gRPC prediction requests that it receives to the first port on - this list. Vertex AI also sends liveness and health checks to this - port. If you do not specify this field, gRPC requests to the - container will be disabled. Vertex AI does not use ports other than - the first one listed. This field corresponds to the `ports` field of - the Kubernetes Containers v1 core API. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' - command: - type: array + Optional. Columns to construct entity_id / row keys. If not provided + defaults to `entity_id`. items: type: string + dense: description: >- - Immutable. Specifies the command that runs when the container - starts. This overrides the container's - [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). - Specify this field as an array of executable and arguments, similar - to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you - do not specify this field, then the container's `ENTRYPOINT` runs, - in conjunction with the args field or the container's - [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if - either exists. If this field is not specified and the container does - not have an `ENTRYPOINT`, then refer to the Docker documentation - about [how `CMD` and `ENTRYPOINT` - interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). - If you specify this field, then you can also specify the `args` - field to provide additional arguments for this command. However, if - you specify this field, then the container's `CMD` is ignored. See - the [Kubernetes documentation about how the `command` and `args` - fields interact with a container's `ENTRYPOINT` and - `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). - In this field, you can reference [environment variables set by - Vertex - AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - and environment variables set in the env field. You cannot reference - environment variables set in the Docker image. In order for - environment variables to be expanded, reference them by using the - following syntax: $( VARIABLE_NAME) Note that this differs from Bash - variable expansion, which does not use parentheses. If a variable - cannot be resolved, the reference in the input string is used - unchanged. To avoid variable expansion, you can escape this syntax - with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to - the `command` field of the Kubernetes Containers [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - sharedMemorySizeMb: + Optional. If set, all feature values will be fetched from a single + row per unique entityId including nulls. If not set, will collapse + all rows for each unique entityId into a singe row with any non-null + values if present, if no non-null values are present will sync null. + ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` + and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` + `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, + 20, null)` is synced to online stores. If dense is not set, `(e1, + 20, 15)` is synced to online stores. + type: boolean + bigQuerySource: + description: >- + Required. Immutable. The BigQuery source URI that points to either a + BigQuery Table or View. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + description: Input source type for BigQuery Tables and Views. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs: + properties: + modelType: + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_CORAL_VERSATILE_1 + - MOBILE_CORAL_LOW_LATENCY_1 + - MOBILE_JETSON_VERSATILE_1 + - MOBILE_JETSON_LOW_LATENCY_1 + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which c + annot be exported. Default. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A versatile model that is meant to be exported (see + ModelService.ExportModel) and used on a Google Coral device. + - >- + A model that trades off quality for low latency, to be exported + (see ModelService.ExportModel) and used on a Google Coral device. + - >- + A versatile model that is meant to be exported (see + ModelService.ExportModel) and used on an NVIDIA Jetson device. + - >- + A model that trades off quality for low latency, to be exported + (see ModelService.ExportModel) and used on an NVIDIA Jetson + device. + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs + type: object + GoogleCloudAiplatformV1PersistentDiskSpec: + properties: + diskSizeGb: format: int64 type: string + description: Size in GB of the disk (default is 100GB). + diskType: description: >- - Immutable. The amount of the VM memory to reserve as the shared - memory for the model in megabytes. - deploymentTimeout: - format: google-duration - description: >- - Immutable. Deployment timeout. Limit for deployment timeout is 2 - hours. + 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: string - healthRoute: - description: >- - Immutable. HTTP path on the container to send health checks to. - Vertex AI intermittently sends GET requests to this path on the - container's IP address and port to check that the container is - healthy. Read more about [health - checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). - For example, if you set this field to `/bar`, then Vertex AI - intermittently sends a GET request to the `/bar` path on the port of - your container specified by the first value of this - `ModelContainerSpec`'s ports field. If you don't specify this field, - it defaults to the following value when you deploy this Model to an - Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ - DEPLOYED_MODEL:predict The placeholders in this value are replaced - as follows: * ENDPOINT: The last segment (following `endpoints/`)of - the Endpoint.name][] field of the Endpoint where this Model has been - deployed. (Vertex AI makes this value available to your container - code as the [`AIP_ENDPOINT_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex - AI makes this value available to your container code as the - [`AIP_DEPLOYED_MODEL_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + id: GoogleCloudAiplatformV1PersistentDiskSpec + type: object + description: Represents the spec of persistent disk options. + GoogleCloudAiplatformV1PredictResponse: + description: Response message for PredictionService.Predict. + id: GoogleCloudAiplatformV1PredictResponse + type: object + properties: + model: type: string - predictRoute: + readOnly: true description: >- - Immutable. HTTP path on the container to send prediction requests - to. Vertex AI forwards requests sent using - projects.locations.endpoints.predict to this path on the container's - IP address and port. Vertex AI then returns the container's response - in the API response. For example, if you set this field to `/foo`, - then when Vertex AI receives a prediction request, it forwards the - request body in a POST request to the `/foo` path on the port of - your container specified by the first value of this - `ModelContainerSpec`'s ports field. If you don't specify this field, - it defaults to the following value when you deploy this Model to an - Endpoint: - /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The - placeholders in this value are replaced as follows: * ENDPOINT: The - last segment (following `endpoints/`)of the Endpoint.name][] field - of the Endpoint where this Model has been deployed. (Vertex AI makes - this value available to your container code as the - [`AIP_ENDPOINT_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex - AI makes this value available to your container code as the - [`AIP_DEPLOYED_MODEL_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + Output only. The resource name of the Model which is deployed as the + DeployedModel that this prediction hits. + modelDisplayName: + readOnly: true + description: >- + Output only. The display name of the Model which is deployed as the + DeployedModel that this prediction hits. type: string - args: - type: array - items: - type: string + metadata: + readOnly: true + type: any description: >- - Immutable. Specifies arguments for the command that runs when the - container starts. This overrides the container's - [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). - Specify this field as an array of executable and arguments, similar - to a Docker `CMD`'s "default parameters" form. If you don't specify - this field but do specify the command field, then the command from - the `command` field runs without any additional arguments. See the - [Kubernetes documentation about how the `command` and `args` fields - interact with a container's `ENTRYPOINT` and - `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). - If you don't specify this field and don't specify the `command` - field, then the container's - [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) - and `CMD` determine what runs based on their default behavior. See - the Docker documentation about [how `CMD` and `ENTRYPOINT` - interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). - In this field, you can reference [environment variables set by - Vertex - AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - and environment variables set in the env field. You cannot reference - environment variables set in the Docker image. In order for - environment variables to be expanded, reference them by using the - following syntax: $( VARIABLE_NAME) Note that this differs from Bash - variable expansion, which does not use parentheses. If a variable - cannot be resolved, the reference in the input string is used - unchanged. To avoid variable expansion, you can escape this syntax - with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to - the `args` field of the Kubernetes Containers [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - env: + Output only. Request-level metadata returned by the model. The + metadata type will be dependent upon the model implementation. + predictions: type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' description: >- - Immutable. List of environment variables to set in the container. - After the container starts running, code running in the container - can read these environment variables. Additionally, the command and - args fields can reference these variables. Later entries in this - list can also reference earlier entries. For example, the following - example sets the variable `VAR_2` to have the value `foo bar`: - ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", - "value": "$(VAR_1) bar" } ] ``` If you switch the order of the - variables in the example, then the expansion does not occur. This - field corresponds to the `env` field of the Kubernetes Containers - [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - healthProbe: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' - description: Immutable. Specification for Kubernetes readiness probe. - ports: - type: array + The predictions that are the output of the predictions call. The + schema of any single prediction may be specified via Endpoint's + DeployedModels' Model's PredictSchemata's prediction_schema_uri. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' - description: >- - Immutable. List of ports to expose from the container. Vertex AI - sends any prediction requests that it receives to the first port on - this list. Vertex AI also sends [liveness and health - checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) - to this port. If you do not specify this field, it defaults to - following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI - does not use ports other than the first one listed. This field - corresponds to the `ports` field of the Kubernetes Containers [v1 - core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - GoogleCloudAiplatformV1ListEntityTypesResponse: - description: Response message for FeaturestoreService.ListEntityTypes. - id: GoogleCloudAiplatformV1ListEntityTypesResponse - type: object - properties: - nextPageToken: + type: any + deployedModelId: + type: string + description: ID of the Endpoint's DeployedModel that served this prediction. + modelVersionId: description: >- - A token, which can be sent as ListEntityTypesRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. + Output only. The version ID of the Model which is deployed as the + DeployedModel that this prediction hits. type: string - entityTypes: - type: array - description: The EntityTypes matching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' - GoogleCloudAiplatformV1PipelineJobRuntimeConfig: + readOnly: true + GoogleCloudAiplatformV1ListPipelineJobsResponse: + description: Response message for PipelineService.ListPipelineJobs type: object - description: The runtime config of a PipelineJob. properties: - gcsOutputDirectory: - description: >- - Required. A path in a Cloud Storage bucket, which will be treated as - the root output directory of the pipeline. It is used by the system - to generate the paths of output artifacts. The artifact paths are - generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` - under the specified output directory. The service account specified - in this pipeline must have the `storage.objects.get` and - `storage.objects.create` permissions for this bucket. - type: string - parameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Value' - type: object - description: >- - Deprecated. Use RuntimeConfig.parameter_values instead. The runtime - parameters of the PipelineJob. The parameters will be passed into - PipelineJob.pipeline_spec to replace the placeholders at runtime. - This field is used by pipelines built using - `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as - pipelines built using Kubeflow Pipelines SDK 1.8 or lower. - deprecated: true - inputArtifacts: - description: >- - The runtime artifacts of the PipelineJob. The key will be the input - artifact name and the value would be one of the InputArtifact. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact - type: object - failurePolicy: + pipelineJobs: + description: List of PipelineJobs in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + type: array + nextPageToken: type: string description: >- - Represents the failure policy of a pipeline. Currently, the default - of a pipeline is that the pipeline will continue to run until no - more tasks can be executed, also known as - PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to - PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new - tasks when a task has failed. Any scheduled tasks will continue to - completion. - enum: - - PIPELINE_FAILURE_POLICY_UNSPECIFIED - - PIPELINE_FAILURE_POLICY_FAIL_SLOW - - PIPELINE_FAILURE_POLICY_FAIL_FAST + A token to retrieve the next page of results. Pass to + ListPipelineJobsRequest.page_token to obtain that page. + id: GoogleCloudAiplatformV1ListPipelineJobsResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + properties: + modelType: enumDescriptions: - - Default value, and follows fail slow behavior. + - Should not be set. - >- - Indicates that the pipeline should continue to run until all - possible tasks have been scheduled and completed. + A model best tailored to be used within Google Cloud, and which + cannot be exported. Default. - >- - Indicates that the pipeline should stop scheduling new tasks after - a task has failed. - parameterValues: - additionalProperties: - type: any - type: object - description: >- - The runtime parameters of the PipelineJob. The parameters will be - passed into PipelineJob.pipeline_spec to replace the placeholders at - runtime. This field is used by pipelines built using - `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines - built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. - id: GoogleCloudAiplatformV1PipelineJobRuntimeConfig - GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig: + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) to a Jetson + device afterwards. + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_JETSON_VERSATILE_1 + type: string type: object - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + GoogleCloudAiplatformV1ImportFeatureValuesResponse: + description: Response message for FeaturestoreService.ImportFeatureValues. properties: - monitorWindow: - format: google-duration - type: string - description: >- - The time window of the prediction data being included in each - prediction dataset. This window specifies how long the data should - be collected from historical model results for each run. If not set, - ModelDeploymentMonitoringScheduleConfig.monitor_interval will be - used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and - the monitor_window is set to be 3600, then data from 2022-01-08 - 13:30:00 to 2022-01-08 14:30:00 will be retrieved and aggregated to - calculate the monitoring statistics. - monitorInterval: - description: >- - Required. The model monitoring job scheduling interval. It will be - rounded up to next full hour. This defines how often the monitoring - jobs are triggered. + importedFeatureValueCount: type: string - format: google-duration - description: The config for scheduling monitoring job. - GoogleCloudAiplatformV1PrivateEndpoints: - description: >- - PrivateEndpoints proto is used to provide paths for users to send - requests privately. To send request via private service access, use - predict_http_uri, explain_http_uri or health_http_uri. To send request - via private service connect, use service_attachment. - properties: - serviceAttachment: + format: int64 + description: Number of Feature values that have been imported by the operation. + invalidRowCount: type: string - readOnly: true description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. - explainHttpUri: - readOnly: true - type: string - description: Output only. Http(s) path to send explain requests. - predictHttpUri: - readOnly: true - description: Output only. Http(s) path to send prediction requests. + The number of rows in input source that weren't imported due to + either * Not having any featureValues. * Having a null entityId. * + Having a null timestamp. * Not being parsable (applicable for CSV + sources). + format: int64 + importedEntityCount: + description: Number of entities that have been imported by the operation. type: string - healthHttpUri: + format: int64 + timestampOutsideRetentionRowsCount: + description: >- + The number rows that weren't ingested due to having feature + timestamps outside the retention boundary. type: string - readOnly: true - description: Output only. Http(s) path to send health check requests. - type: object - id: GoogleCloudAiplatformV1PrivateEndpoints - GoogleCloudLocationListLocationsResponse: + format: int64 + id: GoogleCloudAiplatformV1ImportFeatureValuesResponse type: object + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse: + description: >- + Response message for + JobService.SearchModelDeploymentMonitoringStatsAnomalies. properties: nextPageToken: type: string - description: The standard List next-page token. - locations: + description: >- + The page token that can be used by the next + JobService.SearchModelDeploymentMonitoringStatsAnomalies call. + monitoringStats: items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies description: >- - A list of locations that matches the specified filter in the - request. + Stats retrieved for requested objectives. There are at most 1000 + ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats + in the response. type: array - description: The response message for Locations.ListLocations. - id: GoogleCloudLocationListLocationsResponse - GoogleCloudAiplatformV1RebootPersistentResourceRequest: - type: object - id: GoogleCloudAiplatformV1RebootPersistentResourceRequest - description: Request message for PersistentResourceService.RebootPersistentResource. - properties: {} - GoogleCloudAiplatformV1DirectRawPredictRequest: + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse type: object - id: GoogleCloudAiplatformV1DirectRawPredictRequest + GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata: properties: - input: - type: string - format: byte - description: The prediction input. - methodName: + candidatesTokenCount: + format: int32 + description: Number of tokens in the response(s). + type: integer + promptTokenCount: description: >- - Fully qualified name of the API method being invoked to perform - predictions. Format: `/namespace.Service/Method/` Example: - `/tensorflow.serving.PredictionService/Predict` - type: string - description: Request message for PredictionService.DirectRawPredict. - GoogleCloudAiplatformV1CopyModelOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. + Number of tokens in the request. When `cached_content` is set, this + is still the total effective prompt size meaning this includes the + number of tokens in the cached content. + type: integer + format: int32 + totalTokenCount: + type: integer + format: int32 + description: Total token count for prompt and response candidates. type: object - description: Details of ModelService.CopyModel operation. - id: GoogleCloudAiplatformV1CopyModelOperationMetadata - GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: - id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + description: Usage metadata about response(s). + id: GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata + GoogleCloudAiplatformV1StratifiedSplit: + id: GoogleCloudAiplatformV1StratifiedSplit description: >- - Feature embedding vector for sparse index. An array of numbers whose - values are located in the specified dimensions. + Assigns input data to the training, validation, and test sets so that + the distribution of values found in the categorical column (as specified + by the `key` field) is mirrored within each split. The fraction values + determine the relative sizes of the splits. For example, if the + specified column has three values, with 50% of the rows having value + "A", 25% value "B", and 25% value "C", and the split fractions are + specified as 80/10/10, then the training set will constitute 80% of the + training data, with about 50% of the training set rows having the value + "A" for the specified column, about 25% having the value "B", and about + 25% having the value "C". Only the top 500 occurring values are used; + any values not in the top 500 values are randomly assigned to a split. + If less than three rows contain a specific value, those rows are + randomly assigned. Supported only for tabular Datasets. properties: - dimensions: + trainingFraction: + type: number description: >- - Required. The list of indexes for the embedding values of the sparse - vector. - items: - type: string - format: int64 - type: array - values: - type: array - items: - type: number - format: float - description: Required. The list of embedding values of the sparse vector. - type: object - GoogleCloudAiplatformV1InputDataConfig: - properties: - stratifiedSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StratifiedSplit' + The fraction of the input data that is to be used to train the + Model. + format: double + validationFraction: + type: number + format: double description: >- - Supported only for tabular Datasets. Split based on the distribution - of the specified column. - timestampSplit: + The fraction of the input data that is to be used to validate the + Model. + testFraction: + format: double + type: number description: >- - Supported only for tabular Datasets. Split based on the timestamp of - the input data pieces. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimestampSplit' - predefinedSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedSplit' + The fraction of the input data that is to be used to evaluate the + Model. + key: + type: string description: >- - Supported only for tabular Datasets. Split based on a predefined - key. - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: >- - The Cloud Storage location where the training data is to be written - to. In the given directory a new directory is created with name: - `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 - format. All training input data is written into that directory. The - Vertex AI environment variables representing Cloud Storage data URIs - are represented in the Cloud Storage wildcard format to support - sharded data. e.g.: "gs://.../training-*.jsonl" * AIP_DATA_FORMAT = - "jsonl" for non-tabular data, "csv" for tabular data * - AIP_TRAINING_DATA_URI = - "gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}" * - AIP_VALIDATION_DATA_URI = - "gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}" * - AIP_TEST_DATA_URI = - "gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}" - datasetId: - type: string - description: >- - Required. The ID of the Dataset in the same Project and Location - which data will be used to train the Model. The Dataset must use - schema compatible with Model being trained, and what is compatible - should be described in the used TrainingPipeline's - training_task_definition. For tabular Datasets, all their data is - exported to training, to pick and choose from. - filterSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FilterSplit' - description: Split based on the provided filters for each set. - annotationsFilter: - type: string - description: >- - Applicable only to Datasets that have DataItems and Annotations. A - filter on Annotations of the Dataset. Only Annotations that both - match this filter and belong to DataItems not ignored by the split - method are used in respectively training, validation or test role, - depending on the role of the DataItem they are on (for the - auto-assigned that role is decided by Vertex AI). A filter with same - syntax as the one used in ListAnnotations may be used, but note here - it filters across all Annotations of the Dataset, and not just - within a single DataItem. - fractionSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FractionSplit' - description: Split based on fractions defining the size of each set. - bigqueryDestination: - description: >- - Only applicable to custom training with tabular Dataset with - BigQuery source. The BigQuery project location where the training - data is to be written to. In the given project a new dataset is - created with name `dataset___` where timestamp is in - YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written - into that dataset. In the dataset three tables are created, - `training`, `validation` and `test`. * AIP_DATA_FORMAT = "bigquery". - * AIP_TRAINING_DATA_URI = "bigquery_destination.dataset___.training" - * AIP_VALIDATION_DATA_URI = - "bigquery_destination.dataset___.validation" * AIP_TEST_DATA_URI = - "bigquery_destination.dataset___.test" - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - savedQueryId: - type: string - description: >- - Only applicable to Datasets that have SavedQueries. The ID of a - SavedQuery (annotation set) under the Dataset specified by - dataset_id used for filtering Annotations for training. Only - Annotations that are associated with this SavedQuery are used in - respectively training. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both saved_query_id and annotations_filter. Only one of - saved_query_id and annotation_schema_uri should be specified as both - of them represent the same thing: problem type. - persistMlUseAssignment: - description: Whether to persist the ML use assignment to data item system labels. - type: boolean - annotationSchemaUri: - type: string - description: >- - Applicable only to custom training with Datasets that have DataItems - and Annotations. Cloud Storage URI that points to a YAML file - describing the annotation schema. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that - the chosen schema must be consistent with metadata of the Dataset - specified by dataset_id. Only Annotations that both match this - schema and belong to DataItems not ignored by the split method are - used in respectively training, validation or test role, depending on - the role of the DataItem they are on. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both annotations_filter and annotation_schema_uri. + Required. The key is a name of one of the Dataset's data columns. + The key provided must be for a categorical column. type: object - description: >- - Specifies Vertex AI owned input data to be used for training, and - possibly evaluating, the Model. - id: GoogleCloudAiplatformV1InputDataConfig - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain: + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig: properties: - maxValue: - type: number - description: The maximum permissible value for this feature. - format: float - minValue: - type: number - description: The minimum permissible value for this feature. - format: float - originalStddev: - format: float - type: number - description: >- - If this input feature has been normalized to a standard deviation of - 1.0, the original_stddev specifies the standard deviation of the - domain prior to normalization. - originalMean: - format: float - description: >- - If this input feature has been normalized to a mean value of 0, the - original_mean specifies the mean value of the domain prior to - normalization. - type: number - id: >- - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + bigquerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig description: >- - Domain details of the input feature value. Provides numeric information - about the feature, such as its range (min, max). If the feature has been - pre-processed, for example with z-scoring, then it provides information - about how to recover the original feature. For example, if the input - feature is an image and it has been pre-processed to obtain 0-mean and - stddev = 1 values, then original_mean, and original_stddev refer to the - mean and stddev of the original feature (e.g. image tensor) from which - input feature (with mean = 0 and stddev = 1) was obtained. - type: object - GoogleCloudAiplatformV1ToolParameterKeyMatchSpec: - properties: {} - id: GoogleCloudAiplatformV1ToolParameterKeyMatchSpec - type: object - description: Spec for tool parameter key match metric. - GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams: - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams - description: Prediction model parameters for Video Classification. + The tables Dataset's data source. The Dataset doesn't store the data + directly, but only pointer(s) to its data. type: object + GoogleCloudAiplatformV1FeatureOnlineStore: properties: - segmentClassification: - type: boolean - description: >- - Set to true to request segment-level classification. Vertex AI - returns labels and their confidence scores for the entire time - segment of the video that user specified in the input instance. - Default value is true - maxPredictions: - type: integer - description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. If this number is very high, the Model may - return fewer predictions. Default value is 10,000. - format: int32 - oneSecIntervalClassification: - type: boolean + name: + type: string description: >- - Set to true to request classification for a video at one-second - intervals. Vertex AI returns labels and their confidence scores for - each second of the entire time segment of the video that user - specified in the input WARNING: Model evaluation is not done for - this classification type, the quality of it depends on the training - data, but there are no metrics provided to describe that quality. - Default value is false - shotClassification: + Identifier. Name of the FeatureOnlineStore. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` + state: + description: Output only. State of the featureOnlineStore. + readOnly: true + enumDescriptions: + - Default value. This value is unused. + - >- + State when the featureOnlineStore configuration is not being + updated and the fields reflect the current configuration of the + featureOnlineStore. The featureOnlineStore is usable in this + state. + - >- + The state of the featureOnlineStore configuration when it is being + updated. During an update, the fields reflect either the original + configuration or the updated configuration of the + featureOnlineStore. The featureOnlineStore is still usable in this + state. + enum: + - STATE_UNSPECIFIED + - STABLE + - UPDATING + type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Set to true to request shot-level classification. Vertex AI - determines the boundaries for each camera shot in the entire time - segment of the video that user specified in the input instance. - Vertex AI then returns labels and their confidence scores for each - detected shot, along with the start and end time of the shot. - WARNING: Model evaluation is not done for this classification type, - the quality of it depends on the training data, but there are no - metrics provided to describe that quality. Default value is false + Optional. Customer-managed encryption key spec for data storage. If + set, online store will be secured by this key. + satisfiesPzs: + readOnly: true + description: Output only. Reserved for future use. type: boolean - confidenceThreshold: - format: float - type: number + dedicatedServingEndpoint: description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance: - properties: - reference: - type: string - description: Optional. Ground truth used to compare against the prediction. - prediction: - description: Required. Output of the candidate model. - type: string - baselinePrediction: - type: string - description: Required. Output of the baseline model. - instruction: - description: Required. Summarization prompt for LLM. - type: string - context: - type: string - description: Required. Text to be summarized. - id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance - type: object - description: Spec for pairwise summarization quality instance. - GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec: - type: object - properties: - explanationSpec: - description: Explanation spec details. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' - explanationType: - type: string + Optional. The dedicated serving endpoint for this + FeatureOnlineStore, which is different from common Vertex service + endpoint. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint + bigtable: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtable description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - id: GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis: - properties: - stalenessDays: - type: integer + Contains settings for the Cloud Bigtable instance that will be + created to serve featureValues for all FeatureViews under this + FeatureOnlineStore. + labels: + type: object description: >- - Customized export features time window for snapshot analysis. Unit - is one day. Default value is 3 weeks. Minimum value is 1 day. - Maximum value is 4000 days. - format: int32 - disabled: + Optional. The labels with user-defined metadata to organize your + FeatureOnlineStore. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureOnlineStore(System labels are excluded)." System + reserved label keys are prefixed with "aiplatform.googleapis.com/" + and are immutable. + additionalProperties: + type: string + optimized: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreOptimized description: >- - The monitoring schedule for snapshot analysis. For EntityType-level - config: unset / disabled = true indicates disabled by default for - Features under it; otherwise by default enable snapshot analysis - monitoring with monitoring_interval for Features under it. - Feature-level config: disabled = true indicates disabled regardless - of the EntityType-level config; unset monitoring_interval indicates - going with EntityType-level config; otherwise run snapshot analysis - monitoring with monitoring_interval regardless of the - EntityType-level config. Explicitly Disable the snapshot analysis - based monitoring. + Contains settings for the Optimized store that will be created to + serve featureValues for all FeatureViews under this + FeatureOnlineStore. When choose Optimized storage type, need to set + PrivateServiceConnectConfig.enable_private_service_connect to use + private endpoint. Otherwise will use public endpoint by default. + createTime: + format: google-datetime + type: string + readOnly: true + description: Output only. Timestamp when this FeatureOnlineStore was created. + satisfiesPzi: + description: Output only. Reserved for future use. type: boolean - monitoringIntervalDays: - type: integer - description: >- - Configuration of the snapshot analysis based monitoring pipeline - running interval. The value indicates number of days. - format: int32 - type: object - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis - description: >- - Configuration of the Featurestore's Snapshot Analysis Based Monitoring. - This type of analysis generates statistics for each Feature based on a - snapshot of the latest feature value of each entities every - monitoring_interval. - GoogleCloudAiplatformV1BatchReadFeatureValuesRequest: - properties: - startTime: - description: >- - Optional. Excludes Feature values with feature generation timestamp - before this timestamp. If not set, retrieve oldest values kept in - Feature Store. Timestamp, if present, must not have higher than - millisecond precision. + readOnly: true + updateTime: + readOnly: true type: string format: google-datetime - bigqueryReadInstances: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: Similar to csv_read_instances, but from BigQuery source. - entityTypeSpecs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec - type: array - description: >- - Required. Specifies EntityType grouping Features to read values of - and settings. - csvReadInstances: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' description: >- - Each read instance consists of exactly one read timestamp and one or - more entity IDs identifying entities of the corresponding - EntityTypes whose Features are requested. Each output instance - contains Feature values of requested entities concatenated together - as of the read time. An example read instance may be `foo_entity_id, - bar_entity_id, 2020-01-01T10:00:00.123Z`. An example output instance - may be `foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, - foo_entity_feature1_value, bar_entity_feature2_value`. Timestamp in - each read instance must be millisecond-aligned. `csv_read_instances` - are read instances stored in a plain-text CSV file. The header - should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The - columns can be in any order. Values in the timestamp column must use - the RFC 3339 format, e.g. `2012-07-30T10:43:17.123Z`. - destination: - description: Required. Specifies output location and format. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' - passThroughFields: + Output only. Timestamp when this FeatureOnlineStore was last + updated. + etag: + type: string description: >- - When not empty, the specified fields in the *_read_instances source - will be joined as-is in the output, in addition to those fields from - the Featurestore Entity. For BigQuery source, the type of the - pass-through values will be automatically inferred. For CSV source, - the pass-through values will be passed as opaque bytes. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField - type: array - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + id: GoogleCloudAiplatformV1FeatureOnlineStore type: object - description: Request message for FeaturestoreService.BatchReadFeatureValues. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation: + description: >- + Vertex AI Feature Online Store provides a centralized repository for + serving ML features and embedding indexes at low latency. The Feature + Online Store is a top-level container. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation: properties: columnName: type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation description: >- Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. * A boolean value that indicates whether the - value is valid. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. type: object - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats: + GoogleCloudAiplatformV1PredictSchemata: + type: object + description: >- + Contains the schemata used in Model's predictions and explanations via + PredictionService.Predict, PredictionService.Explain and + BatchPredictionJob. + id: GoogleCloudAiplatformV1PredictSchemata properties: - partialErrors: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError + parametersSchemaUri: description: >- - The detail information of the partial failures encountered for those - invalid records that couldn't be parsed. Up to 50 partial errors - will be reported. - type: array - validSparseRecordCount: - format: int64 + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the parameters of prediction and explanation via + PredictRequest.parameters, ExplainRequest.parameters and + BatchPredictionJob.model_parameters. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI, if no + parameters are supported, then it is set to an empty string. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. type: string + predictionSchemaUri: description: >- - Number of sparse records in this file that were successfully - processed. - validRecordCount: - type: string - description: Number of records in this file that were successfully processed. - format: int64 - invalidRecordCount: - description: Number of records in this file we skipped due to validate errors. + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the format of a single prediction produced by this Model, + which are returned via PredictResponse.predictions, + ExplainResponse.explanations, and BatchPredictionJob.output_config. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. type: string - format: int64 - invalidSparseRecordCount: + instanceSchemaUri: type: string description: >- - Number of sparse records in this file we skipped due to validate - errors. - format: int64 - sourceGcsUri: - type: string - description: Cloud Storage URI pointing to the original file in user's bucket. - type: object - id: >- - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange: - description: A range of values for slice(s). `low` is inclusive, `high` is exclusive. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the format of a single instance, which are used in + PredictRequest.instances, ExplainRequest.instances and + BatchPredictionJob.input_config. The schema is defined as an OpenAPI + 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. + GoogleCloudAiplatformV1BleuInput: properties: - high: - type: number - format: float - description: Exclusive high value for the range. - low: - type: number - description: Inclusive low value for the range. - format: float - type: object - GoogleCloudAiplatformV1EvaluatedAnnotationExplanation: - id: GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuSpec' + description: Required. Spec for bleu score metric. + instances: + description: Required. Repeated bleu instances. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInstance' + description: Input for bleu metric. + id: GoogleCloudAiplatformV1BleuInput type: object - description: Explanation result of the prediction produced by the Model. + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair: properties: - explanationType: + name: type: string - description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - explanation: - description: Explanation attribution response details. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' - GoogleCloudAiplatformV1ListStudiesResponse: - id: GoogleCloudAiplatformV1ListStudiesResponse - description: Response message for VizierService.ListStudies. - properties: - nextPageToken: - description: >- - Passes this token as the `page_token` field of the request for a - subsequent call. If this field is omitted, there are no subsequent - pages. - type: string - studies: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' - description: The studies associated with the project. - type: array + description: Feature short name. + value: + description: Feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + id: >- + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair type: object - GoogleCloudAiplatformV1FindNeighborsRequestQuery: + description: Feature name & value pair. + GoogleCloudAiplatformV1UpdateIndexOperationMetadata: + id: GoogleCloudAiplatformV1UpdateIndexOperationMetadata + type: object + description: Runtime operation information for IndexService.UpdateIndex. properties: - neighborCount: - format: int32 - type: integer - description: >- - The number of nearest neighbors to be retrieved from database for - each query. If not set, will use the default from the service - configuration - (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config). - datapoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - description: >- - Required. The datapoint/vector whose nearest neighbors should be - searched for. - approximateNeighborCount: - description: >- - The number of neighbors to find via approximate search before exact - reordering is performed. If not set, the default value from scam - config is used; if set, this value must be > 0. - type: integer - format: int32 - fractionLeafNodesToSearchOverride: - format: double - type: number + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + nearestNeighborSearchOperationMetadata: description: >- - The fraction of the number of leaves to search, set at query time - allows user to tune search performance. This value increase result - in both search accuracy and latency increase. The value should be - between 0.0 and 1.0. If not set or set to 0.0, query uses the - default value specified in - NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search. - rrf: + The operation metadata with regard to Matching Engine Index + operation. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF - description: Optional. Represents RRF algorithm that combines search results. - perCrowdingAttributeNeighborCount: - description: >- - Crowding is a constraint on a neighbor list produced by nearest - neighbor search requiring that no more than some value k' of the k - neighbors returned have the same value of crowding_attribute. It's - used for improving result diversity. This field is the maximum - number of matches with the same crowding tag. - format: int32 - type: integer - description: >- - A query to find a number of the nearest neighbors (most similar vectors) - of a vector. - id: GoogleCloudAiplatformV1FindNeighborsRequestQuery - type: object - GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse: + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + GoogleCloudAiplatformV1GenerateContentResponse: + description: Response message for [PredictionService.GenerateContent]. properties: - nextPageToken: - type: string - description: The standard List next-page token. - modelDeploymentMonitoringJobs: - description: >- - A list of ModelDeploymentMonitoringJobs that matches the specified - filter in the request. + candidates: + description: Output only. Generated candidates. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1Candidate' type: array + readOnly: true + promptFeedback: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + description: >- + Output only. Content filter results for a prompt sent in the + request. Note: Sent only in the first stream chunk. Only happens + when no candidates were generated due to content violations. + readOnly: true + usageMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata + description: Usage metadata about the response(s). + id: GoogleCloudAiplatformV1GenerateContentResponse type: object - description: Response message for JobService.ListModelDeploymentMonitoringJobs. - id: GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse - GoogleCloudAiplatformV1SearchFeaturesResponse: - type: object - description: Response message for FeaturestoreService.SearchFeatures. - id: GoogleCloudAiplatformV1SearchFeaturesResponse + GoogleCloudAiplatformV1ExamplesRestrictionsNamespace: properties: - features: - description: >- - The Features matching the request. Fields returned: * `name` * - `description` * `labels` * `create_time` * `update_time` + deny: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + type: string + description: The list of deny tags. type: array - nextPageToken: - description: >- - A token, which can be sent as SearchFeaturesRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. + namespaceName: type: string - GoogleCloudAiplatformV1CreateDatasetOperationMetadata: - id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata + description: The namespace name. + allow: + description: The list of allowed tags. + type: array + items: + type: string + id: GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + type: object + description: Restrictions namespace for example-based explanations overrides. + GoogleCloudAiplatformV1PurgeExecutionsMetadata: + id: GoogleCloudAiplatformV1PurgeExecutionsMetadata type: object - description: Runtime operation information for DatasetService.CreateDataset. properties: genericMetadata: + description: Operation metadata for purging Executions. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig: + description: Details of operations that perform MetadataService.PurgeExecutions. + GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport: properties: - scaling: - description: >- - Online serving scaling configuration. Only one of `fixed_node_count` - and `scaling` can be set. Setting one will reset the other. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling - fixedNodeCount: + snapshotTime: description: >- - The number of nodes for the online store. The number of nodes - doesn't scale automatically, but you can manually update the number - of nodes. If set to 0, the featurestore will not have an online - store and cannot be used for online serving. - format: int32 - type: integer - description: >- - OnlineServingConfig specifies the details for provisioning online - serving resources. - id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig - type: object - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse: - properties: - nextPageToken: + Exports Feature values as of this timestamp. If not set, retrieve + values as of now. Timestamp, if present, must not have higher than + millisecond precision. + format: google-datetime + type: string + startTime: type: string description: >- - The page token that can be used by the next - JobService.SearchModelDeploymentMonitoringStatsAnomalies call. - monitoringStats: - description: >- - Stats retrieved for requested objectives. There are at most 1000 - ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats - in the response. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies - type: array + Excludes Feature values with feature generation timestamp before + this timestamp. If not set, retrieve oldest values kept in Feature + Store. Timestamp, if present, must not have higher than millisecond + precision. + format: google-datetime + type: object description: >- - Response message for - JobService.SearchModelDeploymentMonitoringStatsAnomalies. + Describes exporting the latest Feature values of all entities of the + EntityType between [start_time, snapshot_time]. + id: GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization: + id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization type: object - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse - GoogleCloudAiplatformV1RaySpec: + description: Visualization configurations for image explanation. properties: - resourcePoolImages: - additionalProperties: - type: string + clipPercentUpperbound: + format: float + type: number description: >- - Optional. Required if image_uri isn't set. A map of resource_pool_id - to prebuild Ray image if user need to use different images for - different head/worker pools. This map needs to cover all the - resource pool ids. Example: { "ray_head_node_pool": "head image" - "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": - "another worker image" } - type: object - rayMetricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RayMetricSpec' - description: Optional. Ray metrics configurations. - imageUri: + Excludes attributions above the specified percentile from the + highlighted areas. Using the clip_percent_upperbound and + clip_percent_lowerbound together can be useful for filtering out + noise and making it easier to see areas of strong attribution. + Defaults to 99.9. + colorMap: type: string + enum: + - COLOR_MAP_UNSPECIFIED + - PINK_GREEN + - VIRIDIS + - RED + - GREEN + - RED_GREEN + - PINK_WHITE_GREEN + enumDescriptions: + - Should not be used. + - 'Positive: green. Negative: pink.' + - >- + Viridis color map: A perceptually uniform color mapping which is + easier to see by those with colorblindness and progresses from + yellow to green to blue. Positive: yellow. Negative: blue. + - 'Positive: red. Negative: red.' + - 'Positive: green. Negative: green.' + - 'Positive: green. Negative: red.' + - PiYG palette. description: >- - Optional. Default image for user to choose a preferred ML framework - (for example, TensorFlow or Pytorch) by choosing from [Vertex - prebuilt - images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). - Either this or the resource_pool_images is required. Use this field - if you need all the resource pools to have the same Ray image. - Otherwise, use the {@code resource_pool_images} field. - rayLogsSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RayLogsSpec' - description: Optional. OSS Ray logging configurations. - headNodeResourcePoolId: + The color scheme used for the highlighted areas. Defaults to + PINK_GREEN for Integrated Gradients attribution, which shows + positive attributions in green and negative in pink. Defaults to + VIRIDIS for XRAI attribution, which highlights the most influential + regions in yellow and the least influential in blue. + polarity: + enumDescriptions: + - Default value. This is the same as POSITIVE. + - >- + Highlights the pixels/outlines that were most influential to the + model's prediction. + - >- + Setting polarity to negative highlights areas that does not lead + to the models's current prediction. + - Shows both positive and negative attributions. description: >- - Optional. This will be used to indicate which resource pool will - serve as the Ray head node(the first node within that pool). Will - use the machine from the first workerpool as the head node by - default if this field isn't set. + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + type: string + overlayType: + enumDescriptions: + - Default value. This is the same as NONE. + - No overlay. + - The attributions are shown on top of the original image. + - >- + The attributions are shown on top of grayscaled version of the + original image. + - >- + The attributions are used as a mask to reveal predictive parts of + the image and hide the un-predictive parts. + enum: + - OVERLAY_TYPE_UNSPECIFIED + - NONE + - ORIGINAL + - GRAYSCALE + - MASK_BLACK type: string - type: object - description: >- - Configuration information for the Ray cluster. For experimental launch, - Ray cluster creation and Persistent cluster creation are 1:1 mapping: We - will provision all the nodes within the Persistent cluster as Ray nodes. - id: GoogleCloudAiplatformV1RaySpec - GoogleCloudAiplatformV1MigrateResourceRequest: - properties: - migrateAutomlDatasetConfig: description: >- - Config for migrating Dataset in automl.googleapis.com to Vertex AI's - Dataset. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig - migrateDataLabelingDatasetConfig: + How the original image is displayed in the visualization. Adjusting + the overlay can help increase visual clarity if the original image + makes it difficult to view the visualization. Defaults to NONE. + clipPercentLowerbound: + type: number description: >- - Config for migrating Dataset in datalabeling.googleapis.com to - Vertex AI's Dataset. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig - migrateMlEngineModelVersionConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. + format: float + type: + type: string description: >- - Config for migrating Version in ml.googleapis.com to Vertex AI's - Model. - migrateAutomlModelConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig + Type of the image visualization. Only applicable to Integrated + Gradients attribution. OUTLINES shows regions of attribution, while + PIXELS shows per-pixel attribution. Defaults to OUTLINES. + enumDescriptions: + - Should not be used. + - Shows which pixel contributed to the image prediction. + - >- + Shows which region contributed to the image prediction by + outlining the region. + enum: + - TYPE_UNSPECIFIED + - PIXELS + - OUTLINES + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError: + id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError + properties: + sourceGcsUri: + type: string + description: Cloud Storage URI pointing to the original file in user's bucket. + errorType: + enumDescriptions: + - Default, shall not be used. + - The record is empty. + - Invalid json format. + - Invalid csv format. + - Invalid avro format. + - The embedding id is not valid. + - >- + The size of the dense embedding vectors does not match with the + specified dimension. + - The `namespace` field is missing. + - >- + Generic catch-all error. Only used for validation failure where + the root cause cannot be easily retrieved programmatically. + - There are multiple restricts with the same `namespace` value. + - Numeric restrict has operator specified in datapoint. + - Numeric restrict has multiple values specified. + - Numeric restrict has invalid numeric value specified. + - File is not in UTF_8 format. + - Error parsing sparse dimensions field. + - Token restrict value is invalid. + - Invalid sparse embedding. + - Invalid dense embedding. + description: The error type of this record. + type: string + enum: + - ERROR_TYPE_UNSPECIFIED + - EMPTY_LINE + - INVALID_JSON_SYNTAX + - INVALID_CSV_SYNTAX + - INVALID_AVRO_SYNTAX + - INVALID_EMBEDDING_ID + - EMBEDDING_SIZE_MISMATCH + - NAMESPACE_MISSING + - PARSING_ERROR + - DUPLICATE_NAMESPACE + - OP_IN_DATAPOINT + - MULTIPLE_VALUES + - INVALID_NUMERIC_VALUE + - INVALID_ENCODING + - INVALID_SPARSE_DIMENSIONS + - INVALID_TOKEN_VALUE + - INVALID_SPARSE_EMBEDDING + - INVALID_EMBEDDING + errorMessage: description: >- - Config for migrating Model in automl.googleapis.com to Vertex AI's - Model. - description: >- - Config of migrating one resource from automl.googleapis.com, - datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. - id: GoogleCloudAiplatformV1MigrateResourceRequest + A human-readable message that is shown to the user to help them fix + the error. Note that this message may change from time to time, your + code should check against error_type as the source of truth. + type: string + embeddingId: + type: string + description: Empty if the embedding id is failed to parse. + rawRecord: + type: string + description: The original content of this record. type: object - GoogleCloudAiplatformV1ListDatasetsResponse: - description: Response message for DatasetService.ListDatasets. - id: GoogleCloudAiplatformV1ListDatasetsResponse + GoogleCloudAiplatformV1CreateTensorboardOperationMetadata: + id: GoogleCloudAiplatformV1CreateTensorboardOperationMetadata + properties: + genericMetadata: + description: Operation metadata for Tensorboard. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + type: object + description: Details of operations that perform create Tensorboard. + GoogleCloudAiplatformV1ToolCallValidInput: type: object + description: Input for tool call valid metric. + id: GoogleCloudAiplatformV1ToolCallValidInput properties: - datasets: - description: A list of Datasets that matches the specified filter in the request. + instances: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' - nextPageToken: - description: The standard List next-page token. - type: string - GoogleCloudAiplatformV1FeatureValueDestination: - type: object - id: GoogleCloudAiplatformV1FeatureValueDestination - description: A destination location for Feature values and format. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInstance' + description: Required. Repeated tool call valid instances. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidSpec' + description: Required. Spec for tool call valid metric. + GoogleCloudAiplatformV1NearestNeighborQueryParameters: + id: GoogleCloudAiplatformV1NearestNeighborQueryParameters properties: - tfrecordDestination: - description: >- - Output in TFRecord format. Below are the mapping from Feature value - type in Featurestore to Feature value type in TFRecord: Value type - in Featurestore | Value type in TFRecord DOUBLE, DOUBLE_ARRAY | - FLOAT_LIST INT64, INT64_ARRAY | INT64_LIST STRING, STRING_ARRAY, - BYTES | BYTES_LIST true -> byte_string("true"), false -> - byte_string("false") BOOL, BOOL_ARRAY (true, false) | BYTES_LIST - $ref: '#/components/schemas/GoogleCloudAiplatformV1TFRecordDestination' - bigqueryDestination: + leafNodesSearchFraction: + format: double + type: number description: >- - Output in BigQuery format. BigQueryDestination.output_uri in - FeatureValueDestination.bigquery_destination must refer to a table. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - csvDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvDestination' + Optional. The fraction of the number of leaves to search, set at + query time allows user to tune search performance. This value + increase result in both search accuracy and latency increase. The + value should be between 0.0 and 1.0. + approximateNeighborCandidates: + format: int32 description: >- - Output in CSV format. Array Feature value types are not allowed in - CSV format. - GoogleCloudAiplatformV1FeatureValueList: - description: Container for list of values. - type: object - id: GoogleCloudAiplatformV1FeatureValueList - properties: - values: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: A list of feature values. All of them should be the same data type. - type: array - GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult: + Optional. The number of neighbors to find via approximate search + before exact reordering is performed; if set, this value must be > + neighbor_count. + type: integer + description: >- + Parameters that can be overrided in each query to tune query latency and + recall. type: object - id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult + GoogleCloudAiplatformV1IndexPrivateEndpoints: + id: GoogleCloudAiplatformV1IndexPrivateEndpoints properties: - score: - description: Output only. Question Answering Relevance score. - format: float - type: number - readOnly: true - confidence: - type: number - format: float + matchGrpcAddress: readOnly: true - description: Output only. Confidence for question answering relevance score. - explanation: type: string - description: Output only. Explanation for question answering relevance score. + description: Output only. The ip address used to send match gRPC requests. + pscAutomatedEndpoints: readOnly: true - description: Spec for question answering relevance result. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation: - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation - description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Tokenize text to words. Convert each words to a dictionary lookup - index and generate an embedding for each index. Combine the embedding of - all elements into a single embedding using the mean. * Tokenization is - based on unicode script boundaries. * Missing values get their own - lookup index and resulting embedding. * Stop-words receive no special - treatment and are not removed. - properties: - columnName: - type: string - GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata: - type: object - description: Details of operations that perform update Tensorboard. - id: GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata - properties: - genericMetadata: - description: Operation metadata for Tensorboard. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec: - properties: - sourceField: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' description: >- - Source column to get the Feature values from. If not set, uses the - column with the same name as the Feature ID. + Output only. PscAutomatedEndpoints is populated if private service + connect is enabled if PscAutomatedConfig is set. + serviceAttachment: + readOnly: true type: string - id: description: >- - Required. ID of the Feature to import values of. This Feature must - exist in the target EntityType, or the request will fail. - type: string - id: GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. type: object - description: Defines the Feature value(s) to import. - GoogleCloudAiplatformV1ImportDataResponse: - id: GoogleCloudAiplatformV1ImportDataResponse + description: >- + IndexPrivateEndpoints proto is used to provide paths for users to send + requests via private endpoints (e.g. private service access, private + service connect). To send request via private service access, use + match_grpc_address. To send request via private service connect, use + service_attachment. + GoogleCloudAiplatformV1CancelPipelineJobRequest: type: object properties: {} - description: Response message for DatasetService.ImportData. - GoogleCloudAiplatformV1MetadataStoreDataplexConfig: - id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig - type: object - description: Represents Dataplex integration settings. - properties: - enabledPipelinesLineage: - description: >- - Optional. Whether or not Data Lineage synchronization is enabled for - Vertex Pipelines. - type: boolean - GoogleCloudAiplatformV1UpdateIndexOperationMetadata: - type: object - id: GoogleCloudAiplatformV1UpdateIndexOperationMetadata - description: Runtime operation information for IndexService.UpdateIndex. + id: GoogleCloudAiplatformV1CancelPipelineJobRequest + description: Request message for PipelineService.CancelPipelineJob. + GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion: + id: GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion + description: Represents one model Version in ml.googleapis.com. properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - nearestNeighborSearchOperationMetadata: + endpoint: + type: string description: >- - The operation metadata with regard to Matching Engine Index - operation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata - GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig: - type: object - properties: - datasetDisplayName: + The ml.googleapis.com endpoint that this model Version currently + lives in. Example values: * ml.googleapis.com * + us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * + asia-east1-ml.googleapis.com + version: description: >- - Required. Display name of the Dataset in Vertex AI. System will pick - a display name if unspecified. - type: string - dataset: + Full resource name of ml engine model Version. Format: + `projects/{project}/models/{model}/versions/{version}`. type: string - description: >- - Required. Full resource name of automl Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}`. - id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig - description: >- - Config for migrating Dataset in automl.googleapis.com to Vertex AI's - Dataset. - GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata: type: object - id: GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata - description: Details of operations that perform MetadataService.DeleteMetadataStore. + GoogleCloudAiplatformV1AddContextChildrenRequest: + id: GoogleCloudAiplatformV1AddContextChildrenRequest properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for deleting a MetadataStore. - GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput: + childContexts: + items: + type: string + description: The resource names of the child Contexts. + type: array + description: Request message for MetadataService.AddContextChildren. type: object - id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput + GoogleCloudAiplatformV1ExactMatchInput: properties: - instance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance - description: Required. Question answering relevance instance. + instances: + type: array + description: Required. Repeated exact match instances. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInstance' metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec - description: Required. Spec for question answering relevance score metric. - description: Input for question answering relevance metric. - CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchSpec' + description: Required. Spec for exact match metric. type: object + id: GoogleCloudAiplatformV1ExactMatchInput + description: Input for exact match metric. + GoogleCloudAiplatformV1StudyTimeConstraint: + id: GoogleCloudAiplatformV1StudyTimeConstraint properties: - publicMessage: - type: string - description: Public messages contains actionable items for the error cause. - errorCause: - enum: - - ERROR_CAUSE_UNSPECIFIED - - INVALID_PIPELINE_SPEC_FORMAT - - INVALID_PIPELINE_SPEC - - INVALID_DEPLOYMENT_CONFIG - - INVALID_DEPLOYMENT_SPEC - - INVALID_INSTANCE_SCHEMA - - INVALID_CUSTOM_JOB - - INVALID_CONTAINER_SPEC - - INVALID_NOTIFICATION_EMAIL_SETUP - - INVALID_SERVICE_ACCOUNT_SETUP - - INVALID_KMS_SETUP - - INVALID_NETWORK_SETUP - - INVALID_PIPELINE_TASK_SPEC - - INVALID_PIPELINE_TASK_ARTIFACT - - INVALID_IMPORTER_SPEC - - INVALID_RESOLVER_SPEC - - INVALID_RUNTIME_PARAMETERS - - CLOUD_API_NOT_ENABLED - - INVALID_GCS_INPUT_URI - - INVALID_GCS_OUTPUT_URI - - INVALID_COMPONENT_SPEC - - INVALID_DAG_OUTPUTS_SPEC - - INVALID_DAG_SPEC - - INSUFFICIENT_QUOTA - - INTERNAL + maxDuration: type: string - enumDescriptions: - - Should never be used. - - IR Pipeline Spec can not been parsed to yaml or json format. - - A pipeline spec is invalid. - - A deployment config is invalid. - - A deployment spec is invalid. - - An instance schema is invalid. - - A custom job is invalid. - - A container spec is invalid. - - Notification email setup is invalid. - - Service account setup is invalid. - - KMS setup is invalid. - - Network setup is invalid. - - Task spec is invalid. - - Task artifact is invalid. - - Importer spec is invalid. - - Resolver spec is invalid. - - Runtime Parameters are invalid. - - Cloud API not enabled. - - Invalid GCS input uri - - Invalid GCS output uri - - Component spec of pipeline is invalid. - - DagOutputsSpec is invalid. - - DagSpec is invalid. - - Project does not have enough quota. - - An internal error with unknown cause. - description: The error root cause returned by CreatePipelineJob API. - description: 'Create API error message for Vertex Pipeline. Next Id: 3.' - id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail - GoogleCloudAiplatformV1BigQuerySource: - properties: - inputUri: - description: >- - Required. BigQuery URI to a table, up to 2000 characters long. - Accepted forms: * BigQuery path. For example: - `bq://projectId.bqDatasetId.bqTableId`. + description: Counts the wallclock time passed since the creation of this Study. + format: google-duration + endTime: + description: Compares the wallclock time to this time. Must use UTC timezone. + format: google-datetime type: string type: object - description: The BigQuery location for the input content. - id: GoogleCloudAiplatformV1BigQuerySource - GoogleCloudAiplatformV1DeployedModelRef: - id: GoogleCloudAiplatformV1DeployedModelRef - description: Points to a DeployedModel. + description: Time-based Constraint for Study + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment type: object properties: - deployedModelId: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs + description: The input parameters of this TrainingJob. + description: A TrainingJob that trains and uploads an AutoML Text Sentiment Model. + GoogleCloudAiplatformV1ExactMatchInstance: + description: Spec for exact match instance. + type: object + properties: + prediction: type: string - description: Immutable. An ID of a DeployedModel in the above Endpoint. - endpoint: + description: Required. Output of the evaluated model. + reference: + description: Required. Ground truth used to compare against the prediction. type: string - description: Immutable. A resource name of an Endpoint. - GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest: + id: GoogleCloudAiplatformV1ExactMatchInstance + GoogleCloudAiplatformV1CreatePipelineJobRequest: type: object - properties: {} - description: Request message for JobService.PauseModelDeploymentMonitoringJob. - id: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest - GoogleCloudAiplatformV1UploadModelRequest: + description: Request message for PipelineService.CreatePipelineJob. properties: - parentModel: - type: string - description: >- - Optional. The resource name of the model into which to upload the - version. Only specify this field when uploading a new version. - serviceAccount: + parent: description: >- - Optional. The user-provided custom service account to use to do the - model upload. If empty, [Vertex AI Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) - will be used to access resources needed to upload the model. This - account must belong to the target project where the model is - uploaded to, i.e., the project specified in the `parent` field of - this request and have necessary read permissions (to Google Cloud - Storage, Artifact Registry, etc.). + Required. The resource name of the Location to create the + PipelineJob in. Format: `projects/{project}/locations/{location}` type: string - modelId: - description: >- - Optional. The ID to use for the uploaded Model, which will become - the final component of the model 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. + pipelineJobId: type: string - model: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - description: Required. The Model to create. - id: GoogleCloudAiplatformV1UploadModelRequest - description: Request message for ModelService.UploadModel. + description: >- + 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-/`. + pipelineJob: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + description: Required. The PipelineJob to create. + id: GoogleCloudAiplatformV1CreatePipelineJobRequest + GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse: type: object - GoogleCloudAiplatformV1FeatureViewSync: properties: - runTime: - description: Output only. Time when this FeatureViewSync is finished. - readOnly: true - $ref: '#/components/schemas/GoogleTypeInterval' - satisfiesPzs: - description: Output only. Reserved for future use. - type: boolean - readOnly: true - name: + nextPageToken: type: string description: >- - Identifier. Name of the FeatureViewSync. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` - finalStatus: - description: Output only. Final status of the FeatureViewSync. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - syncSummary: - readOnly: true - description: Output only. Summary of the sync job. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncSyncSummary - createTime: - format: google-datetime - description: >- - Output only. Time when this FeatureViewSync is created. Creation of - a FeatureViewSync means that the job is pending / waiting for - sufficient resources but may not have started the actual data - transfer yet. - readOnly: true - type: string - description: >- - FeatureViewSync is a representation of sync operation which copies data - from data source to Feature View in Online Store. - id: GoogleCloudAiplatformV1FeatureViewSync - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + deploymentResourcePools: + description: The DeploymentResourcePools from the specified location. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' + type: array + description: Response message for ListDeploymentResourcePools method. + id: GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + GoogleCloudAiplatformV1Neighbor: properties: - columnName: + neighborId: + readOnly: true + description: Output only. The neighbor id. type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. + neighborDistance: + format: double + description: Output only. The neighbor distance. + type: number + readOnly: true + id: GoogleCloudAiplatformV1Neighbor + description: Neighbors for example-based explanations. type: object - GoogleCloudAiplatformV1SuggestTrialsMetadata: + GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata: + description: Details of operations that perform update PersistentResource. + id: GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata type: object - id: GoogleCloudAiplatformV1SuggestTrialsMetadata - description: Details of operations that perform Trials suggestion. properties: - clientId: - description: >- - The identifier of the client that is requesting the suggestion. If - multiple SuggestTrialsRequests have the same `client_id`, the - service will return the identical suggested Trial if the Trial is - pending, and provide a new Trial if the last suggested Trial was - completed. + progressMessage: + description: Progress Message for Update LRO type: string genericMetadata: + description: Operation metadata for PersistentResource. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for suggesting Trials. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation: - properties: - columnName: - type: string - description: >- - Treats the column as text array and performs following transformation - functions. * Concatenate all text values in the array into a single text - value using a space (" ") as a delimiter, and then treat the result as a - single text value. Apply the transformations for Text columns. * Empty - arrays treated as an empty text. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation - type: object - GoogleCloudAiplatformV1GroundingChunkRetrievedContext: - description: Chunk from context retrieved by the retrieval tools. + GoogleCloudAiplatformV1BlurBaselineConfig: type: object + id: GoogleCloudAiplatformV1BlurBaselineConfig + description: >- + Config for blur baseline. When enabled, a linear path from the maximally + blurred image to the input image is created. Using a blurred baseline + instead of zero (black image) is motivated by the BlurIG approach + explained here: https://arxiv.org/abs/2004.03383 properties: - title: - description: Title of the attribution. - type: string - uri: - description: URI reference of the attribution. - type: string - id: GoogleCloudAiplatformV1GroundingChunkRetrievedContext - GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput: - description: Input for pairwise question answering quality metric. - id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput + maxBlurSigma: + format: float + description: >- + The standard deviation of the blur kernel for the blurred baseline. + The same blurring parameter is used for both the height and the + width dimension. If not set, the method defaults to the zero (i.e. + black for images) baseline. + type: number + GoogleCloudAiplatformV1DeleteFeatureValuesResponse: + description: Response message for FeaturestoreService.DeleteFeatureValues. type: object properties: - metricSpec: - description: Required. Spec for pairwise question answering quality score metric. + selectTimeRangeAndFeature: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec - instance: - description: Required. Pairwise question answering quality instance. + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature + description: Response for request specifying time range and feature + selectEntity: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition: - type: object - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition - description: Represents the spec to match categorical values from parent parameter. + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity + description: Response for request specifying the entities to delete + id: GoogleCloudAiplatformV1DeleteFeatureValuesResponse + GoogleCloudAiplatformV1StudySpec: + description: Represents specification of a Study. properties: - values: - description: >- - Required. Matches values of the parent parameter of 'CATEGORICAL' - type. All values must exist in `categorical_value_spec` of parent - parameter. - type: array + parameters: + description: Required. The set of parameters to tune. items: - type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata: - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata - properties: - successfulStopReason: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + type: array + measurementSelectionType: + enum: + - MEASUREMENT_SELECTION_TYPE_UNSPECIFIED + - LAST_MEASUREMENT + - BEST_MEASUREMENT + type: string + enumDescriptions: + - Will be treated as LAST_MEASUREMENT. + - Use the last measurement reported. + - Use the best measurement reported. + description: Describe which measurement selection type will be used + medianAutomatedStoppingSpec: + description: The automated early stopping spec using median rule. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec + algorithm: + enum: + - ALGORITHM_UNSPECIFIED + - GRID_SEARCH + - RANDOM_SEARCH enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - >- - Further training of the Model ceased to increase its quality, - since it already has converged. + The default algorithm used by Vertex AI for [hyperparameter + tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview) + and [Vertex AI + Vizier](https://cloud.google.com/vertex-ai/docs/vizier). + - >- + Simple grid search within the feasible space. To use grid search, + all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`. + - Simple random search within the feasible space. + description: The search algorithm specified for the Study. + type: string + decayCurveStoppingSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec + description: The automated early stopping spec using decay curve rule. + observationNoise: + enumDescriptions: + - The default noise level chosen by Vertex AI. + - >- + Vertex AI assumes that the objective function is (nearly) + perfectly reproducible, and will never repeat the same Trial + parameters. + - >- + Vertex AI will estimate the amount of noise in metric evaluations, + it may repeat the same Trial parameters more than once. enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED - description: >- - For successful job completions, this is the reason why the job has - finished. + - OBSERVATION_NOISE_UNSPECIFIED + - LOW + - HIGH type: string - costMilliNodeHours: description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. - format: int64 - type: string - GoogleCloudAiplatformV1PipelineTemplateMetadata: - id: GoogleCloudAiplatformV1PipelineTemplateMetadata - properties: - version: + The observation noise level of the study. Currently only supported + by the Vertex AI Vizier service. Not supported by + HyperparameterTuningJob or TrainingPipeline. + convexAutomatedStoppingSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec + description: The automated early stopping spec using convex stopping rule. + metrics: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpec' + type: array + description: Required. Metric specs for the Study. + studyStoppingConfig: description: >- - The version_name in artifact registry. Will always be presented in - output if the PipelineJob.template_uri is from supported template - registry. Format is "sha256:abcdef123456...". - type: string - description: >- - Pipeline template metadata if PipelineJob.template_uri is from supported - template registry. Currently, the only supported registry is Artifact - Registry. + Conditions for automated stopping of a Study. Enable automated + stopping by configuring at least one condition. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecStudyStoppingConfig + id: GoogleCloudAiplatformV1StudySpec type: object - GoogleCloudAiplatformV1SummarizationHelpfulnessSpec: + GoogleCloudAiplatformV1EvaluateInstancesRequest: type: object - description: Spec for summarization helpfulness score metric. - id: GoogleCloudAiplatformV1SummarizationHelpfulnessSpec + description: Request message for EvaluationService.EvaluateInstances. + id: GoogleCloudAiplatformV1EvaluateInstancesRequest properties: - useReference: - type: boolean + pairwiseQuestionAnsweringQualityInput: + description: Input for pairwise question answering quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput + exactMatchInput: description: >- - Optional. Whether to use instance.reference to compute summarization - helpfulness. - version: - format: int32 - type: integer - description: Optional. Which version to use for evaluation. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + Auto metric instances. Instances and metric spec for exact match + metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInput' + toolNameMatchInput: + description: Input for tool name match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInput' + summarizationVerbosityInput: + description: Input for summarization verbosity metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInput + coherenceInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInput' + description: Input for coherence metric. + questionAnsweringQualityInput: + description: Input for question answering quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInput + groundednessInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInput' + description: Input for groundedness metric. + bleuInput: + description: Instances and metric spec for bleu metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInput' + summarizationHelpfulnessInput: + description: Input for summarization helpfulness metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInput + questionAnsweringRelevanceInput: + description: Input for question answering relevance metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput + fulfillmentInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInput' + description: Input for fulfillment metric. + pointwiseMetricInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInput' + description: Input for pointwise metric. + questionAnsweringCorrectnessInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput + description: Input for question answering correctness metric. + toolParameterKvMatchInput: + description: Input for tool parameter key value match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInput + pairwiseSummarizationQualityInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInput + description: Input for pairwise summarization quality metric. + pairwiseMetricInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInput' + description: Input for pairwise metric. + questionAnsweringHelpfulnessInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput + description: Input for question answering helpfulness metric. + fluencyInput: + description: >- + LLM-based metric instance. General text generation metrics, + applicable to other categories. Input for fluency metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInput' + summarizationQualityInput: + description: Input for summarization quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInput + toolCallValidInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInput' + description: Tool call metric instances. Input for tool call valid metric. + toolParameterKeyMatchInput: + description: Input for tool parameter key match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInput + safetyInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInput' + description: Input for safety metric. + rougeInput: + description: Instances and metric spec for rouge metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInput' + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec: type: object properties: - columnName: + metric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + description: >- + Metric specs for the NAS job. Validation for this field is done at + `multi_trial_algorithm_spec` field. + trainTrialSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec + description: >- + Spec for train trials. Top N + [TrainTrialSpec.max_parallel_trial_count] search trials will be + trained for every M [TrainTrialSpec.frequency] trials searched. + multiTrialAlgorithm: + enumDescriptions: + - Defaults to `REINFORCEMENT_LEARNING`. + - >- + The Reinforcement Learning Algorithm for Multi-trial Neural + Architecture Search (NAS). + - >- + The Grid Search Algorithm for Multi-trial Neural Architecture + Search (NAS). type: string - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - CloudAiLargeModelsVisionRaiInfo: - id: CloudAiLargeModelsVisionRaiInfo + enum: + - MULTI_TRIAL_ALGORITHM_UNSPECIFIED + - REINFORCEMENT_LEARNING + - GRID_SEARCH + description: >- + The multi-trial Neural Architecture Search (NAS) algorithm type. + Defaults to `REINFORCEMENT_LEARNING`. + searchTrialSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec + description: Required. Spec for search trials. + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec + description: The spec of multi-trial Neural Architecture Search (NAS). + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity: properties: - modelName: + offlineStorageDeletedEntityRowCount: + format: int64 type: string description: >- - The model name used to indexing into the RaiFilterConfig map. Would - either be one of imagegeneration@002-006, imagen-3.0-... api - endpoint names, or internal names used for mapping to different - filter configs (genselfie, ai_watermark) than its api endpoint. - scores: + The count of deleted entity rows in the offline storage. Each row + corresponds to the combination of an entity ID and a timestamp. One + entity ID can have multiple rows in the offline storage. + onlineStorageDeletedEntityCount: description: >- - List of rai scores mapping to the rai categories. Rounded to 1 - decimal place. - type: array - items: - type: number - format: float - raiCategories: - type: array - description: List of rai categories' information to return - items: - type: string - detectedLabels: - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' - type: array - description: The list of detected labels for different rai categories. - type: object - GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig: - properties: {} - description: Configuration options for using brute force search. - id: GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig - type: object - GoogleCloudAiplatformV1AddContextChildrenRequest: - type: object - id: GoogleCloudAiplatformV1AddContextChildrenRequest - description: Request message for MetadataService.AddContextChildren. - properties: - childContexts: - type: array - description: The resource names of the child Contexts. - items: - type: string - GoogleCloudAiplatformV1Retrieval: + The count of deleted entities in the online storage. Each entity ID + corresponds to one entity. + type: string + format: int64 + id: GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity + description: Response message if the request uses the SelectEntity option. type: object + GoogleCloudAiplatformV1NasJob: + description: Represents a Neural Architecture Search (NAS) job. + id: GoogleCloudAiplatformV1NasJob properties: - vertexRagStore: + name: + description: Output only. Resource name of the NasJob. + type: string + readOnly: true + nasJobSpec: + description: Required. The specification of a NasJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobSpec' + state: + description: Output only. The detailed state of the job. + type: string + readOnly: true + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + endTime: + readOnly: true description: >- - Set to use data source powered by Vertex RAG store. User data is - uploaded via the VertexRagDataService. - $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexRagStore' - vertexAiSearch: - description: Set to use data source powered by Vertex AI Search. - $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' - disableAttribution: - description: Optional. Deprecated. This option is no longer supported. + Output only. Time when the NasJob entered any of the following + states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + format: google-datetime + type: string + nasJobOutput: + description: Output only. Output of the NasJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobOutput' + readOnly: true + enableRestrictedImageTraining: + description: >- + Optional. Enable a separation of Custom model training and + restricted image training for tenant project. type: boolean deprecated: true - id: GoogleCloudAiplatformV1Retrieval - description: >- - Defines a retrieval tool that model can call to access external - knowledge. - GoogleCloudAiplatformV1NotebookIdleShutdownConfig: - type: object - description: >- - The idle shutdown configuration of NotebookRuntimeTemplate, which - contains the idle_timeout as required field. - properties: - idleTimeout: + createTime: + description: Output only. Time when the NasJob was created. + format: google-datetime type: string + readOnly: true + encryptionSpec: description: >- - Required. Duration is accurate to the second. In Notebook, Idle - Timeout is accurate to minute so the range of idle_timeout (second) - is: 10 * 60 ~ 1440 * 60. - format: google-duration - idleShutdownDisabled: + Customer-managed encryption key options for a NasJob. If this is + set, then all resources created by the NasJob will be encrypted with + the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + error: + readOnly: true + description: >- + Output only. Only populated when job's state is JOB_STATE_FAILED or + JOB_STATE_CANCELLED. + $ref: '#/components/schemas/GoogleRpcStatus' + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true type: boolean - description: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. - id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig - GoogleCloudAiplatformV1FunctionResponse: - 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. - properties: - response: - type: object + updateTime: + description: Output only. Time when the NasJob was most recently updated. + format: google-datetime + readOnly: true + type: string + labels: additionalProperties: - description: Properties of the object. - type: any + type: string + type: object description: >- - Required. The function response in JSON object format. Use "output" - key to specify function output and "error" key to specify error - details (if any). If "output" and "error" keys are not specified, - then whole "response" is treated as function output. - name: + The labels with user-defined metadata to organize NasJobs. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + startTime: + readOnly: true + type: string description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name] and [FunctionCall.name]. + Output only. Time when the NasJob for the first time entered the + `JOB_STATE_RUNNING` state. + format: google-datetime + displayName: + description: >- + Required. The display name of the NasJob. The name can be up to 128 + characters long and can consist of any UTF-8 characters. type: string - id: GoogleCloudAiplatformV1FunctionResponse + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. type: object - GoogleCloudAiplatformV1StudySpecParameterSpec: + GoogleCloudAiplatformV1StructFieldValue: type: object - id: GoogleCloudAiplatformV1StudySpecParameterSpec properties: - conditionalParameterSpecs: - type: array + value: + description: The value for this field. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + name: + type: string + description: Name of the field in the struct feature. + id: GoogleCloudAiplatformV1StructFieldValue + description: One field of a Struct (or object) type feature value. + GoogleCloudAiplatformV1CancelNasJobRequest: + properties: {} + type: object + description: Request message for JobService.CancelNasJob. + id: GoogleCloudAiplatformV1CancelNasJobRequest + GoogleCloudAiplatformV1ThresholdConfig: + id: GoogleCloudAiplatformV1ThresholdConfig + properties: + value: + type: number + format: double description: >- - A conditional parameter node is active if the parameter's value - matches the conditional node's parent_value_condition. If two items - in conditional_parameter_specs have the same name, they must have - disjoint parent_value_condition. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec - integerValueSpec: - description: The value spec for an 'INTEGER' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec - discreteValueSpec: - description: The value spec for a 'DISCRETE' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec - doubleValueSpec: - description: The value spec for a 'DOUBLE' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec - categoricalValueSpec: - description: The value spec for a 'CATEGORICAL' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec - parameterId: + Specify a threshold value that can trigger the alert. If this + threshold config is for feature distribution distance: 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. Each feature + must have a non-zero threshold if they need to be monitored. + Otherwise no alert will be triggered for that feature. + type: object + description: The config for feature monitoring threshold. + GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult + description: Prediction output format for Video Action Recognition. + type: object + properties: + displayName: + description: The display name of the AnnotationSpec that had been identified. + type: string + id: type: string + description: The resource ID of the AnnotationSpec that had been identified. + timeSegmentStart: + format: google-duration description: >- - Required. The ID of the parameter. Must not contain whitespaces and - must be unique amongst all ParameterSpecs. - scaleType: - enumDescriptions: - - By default, no scaling is applied. - - Scales the feasible space to (0, 1) linearly. - - >- - Scales the feasible space logarithmically to (0, 1). The entire - feasible space must be strictly positive. - - >- - Scales the feasible space "reverse" logarithmically to (0, 1). The - result is that values close to the top of the feasible space are - spread out more than points near the bottom. The entire feasible - space must be strictly positive. + The beginning, inclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. + type: string + timeSegmentEnd: + format: google-duration description: >- - How the parameter should be scaled. Leave unset for `CATEGORICAL` - parameters. - enum: - - SCALE_TYPE_UNSPECIFIED - - UNIT_LINEAR_SCALE - - UNIT_LOG_SCALE - - UNIT_REVERSE_LOG_SCALE + The end, exclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. type: string - description: Represents a single parameter to optimize. - GoogleCloudAiplatformV1EvaluatedAnnotation: - id: GoogleCloudAiplatformV1EvaluatedAnnotation + confidence: + format: float + description: >- + The Model's confidence in correction of this prediction, higher + value means higher confidence. + type: number + GoogleCloudAiplatformV1MutateDeployedIndexResponse: + properties: + deployedIndex: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: The DeployedIndex that had been updated in the IndexEndpoint. + type: object + id: GoogleCloudAiplatformV1MutateDeployedIndexResponse + description: Response message for IndexEndpointService.MutateDeployedIndex. + GoogleCloudAiplatformV1CompletionStats: description: >- - True positive, false positive, or false negative. EvaluatedAnnotation is - only available under ModelEvaluationSlice with slice of `annotationSpec` - dimension. + Success and error statistics of processing multiple entities (for + example, DataItems or structured data rows) in batch. + type: object + id: GoogleCloudAiplatformV1CompletionStats properties: - dataItemPayload: - readOnly: true + failedCount: description: >- - Output only. The data item payload that the Model predicted this - EvaluatedAnnotation on. - type: any - type: - readOnly: true - type: string - description: Output only. Type of the EvaluatedAnnotation. - enumDescriptions: - - Invalid value. - - >- - The EvaluatedAnnotation is a true positive. It has a prediction - created by the Model and a ground truth Annotation which the - prediction matches. - - >- - The EvaluatedAnnotation is false positive. It has a prediction - created by the Model which does not match any ground truth - annotation. - - >- - The EvaluatedAnnotation is false negative. It has a ground truth - annotation which is not matched by any of the model created - predictions. - enum: - - EVALUATED_ANNOTATION_TYPE_UNSPECIFIED - - TRUE_POSITIVE - - FALSE_POSITIVE - - FALSE_NEGATIVE - errorAnalysisAnnotations: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotation - description: Annotations of model error analysis results. - groundTruths: - type: array + Output only. The number of entities for which any error was + encountered. readOnly: true - items: - type: any - description: >- - Output only. The ground truth Annotations, i.e. the Annotations that - exist in the test data the Model is evaluated on. For true positive, - there is one and only one ground truth annotation, which matches the - only prediction in predictions. For false positive, there are zero - or more ground truth annotations that are similar to the only - prediction in predictions, but not enough for a match. For false - negative, there is one and only one ground truth annotation, which - doesn't match any predictions created by the model. The schema of - the ground truth is stored in ModelEvaluation.annotation_schema_uri - explanations: - description: >- - Explanations of predictions. Each element of the explanations - indicates the explanation for one explanation Method. The - attributions list in the EvaluatedAnnotationExplanation.explanation - object corresponds to the predictions list. For example, the second - element in the attributions list explains the second element in the - predictions list. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotationExplanation - evaluatedDataItemViewId: - description: >- - Output only. ID of the EvaluatedDataItemView under the same ancestor - ModelEvaluation. The EvaluatedDataItemView consists of all ground - truths and predictions on data_item_payload. + format: int64 type: string + successfulCount: readOnly: true - predictions: - readOnly: true - description: >- - Output only. The model predicted annotations. For true positive, - there is one and only one prediction, which matches the only one - ground truth annotation in ground_truths. For false positive, there - is one and only one prediction, which doesn't match any ground truth - annotation of the corresponding data_item_view_id. For false - negative, there are zero or more predictions which are similar to - the only ground truth annotation in ground_truths but not enough for - a match. The schema of the prediction is stored in - ModelEvaluation.annotation_schema_uri - items: - type: any - type: array - type: object - GoogleCloudAiplatformV1NearestNeighborQuery: - properties: - stringFilters: - description: Optional. The list of string filters. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryStringFilter - type: array - perCrowdingAttributeNeighborCount: - format: int32 - description: >- - Optional. Crowding is a constraint on a neighbor list produced by - nearest neighbor search requiring that no more than - sper_crowding_attribute_neighbor_count of the k neighbors returned - have the same value of crowding_attribute. It's used for improving - result diversity. - type: integer - parameters: - description: Optional. Parameters that can be set to tune query on the fly. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryParameters - neighborCount: - type: integer - format: int32 + format: int64 description: >- - Optional. The number of similar entities to be retrieved from - feature view for each query. - numericFilters: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter - type: array - description: Optional. The list of numeric filters. - entityId: + Output only. The number of entities that had been processed + successfully. type: string - description: >- - Optional. The entity id whose similar entities should be searched - for. If embedding is set, search will use embedding instead of - entity_id. - embedding: - description: Optional. The embedding vector that be used for similar search. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryEmbedding - description: A query to find a number of similar entities. - type: object - id: GoogleCloudAiplatformV1NearestNeighborQuery - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource: - type: object - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource - properties: - uri: + successfulForecastPointCount: type: string description: >- - The URI of a BigQuery table. e.g. - bq://projectId.bqDatasetId.bqTableId - GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult: - properties: - confidence: - type: number - format: float - description: Output only. Confidence for question answering correctness score. - readOnly: true - score: - format: float - type: number - description: Output only. Question Answering Correctness score. + Output only. The number of the successful forecast points that are + generated by the forecasting model. This is ONLY used by the + forecasting batch prediction. readOnly: true - explanation: - description: Output only. Explanation for question answering correctness score. + format: int64 + incompleteCount: + format: int64 readOnly: true type: string - description: Spec for question answering correctness result. - id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult - type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult: - properties: - displayName: - type: string - description: The display name of the AnnotationSpec that had been identified. - timeSegmentEnd: - description: >- - The end, exclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. - format: google-duration - type: string - timeSegmentStart: - description: >- - The beginning, inclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. - format: google-duration - type: string - confidence: description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. - format: float - type: number - id: - type: string - description: The resource ID of the AnnotationSpec that had been identified. - description: Prediction output format for Video Action Recognition. - type: object + Output only. In cases when enough errors are encountered a job, + pipeline, or operation may be failed as a whole. Below is the number + of entities for which the processing had not been finished (either + in successful or failed state). Set to -1 if the number is unknown + (for example, the operation failed before the total entity number + could be collected). + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis: id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult - GoogleCloudAiplatformV1Scheduling: + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis type: object - description: All parameters related to queuing and scheduling of custom jobs. + description: >- + Configuration of the Featurestore's ImportFeature Analysis Based + Monitoring. This type of analysis generates statistics for values of + each Feature imported by every ImportFeatureValues operation. properties: - timeout: - description: The maximum job running time. The default is 7 days. + state: type: string - format: google-duration - disableRetries: description: >- - Optional. Indicates if the job should retry for internal errors - after the job starts running. If true, overrides - `Scheduling.restart_job_on_worker_restart` to false. - type: boolean - strategy: - type: string - description: Optional. This determines which type of scheduling strategy to use. - enumDeprecated: - - false - - true - - true - - false - - false - - false + Whether to enable / disable / inherite default hebavior for import + features analysis. + enum: + - STATE_UNSPECIFIED + - DEFAULT + - ENABLED + - DISABLED enumDescriptions: - - Strategy will default to STANDARD. - - Deprecated. Regular on-demand provisioning strategy. - - Deprecated. Low cost by making potential use of spot resources. - - Standard provisioning strategy uses regular on-demand resources. - - Spot provisioning strategy uses spot resources. - - Flex Start strategy uses DWS to queue for resources. + - Should not be used. + - >- + The default behavior of whether to enable the monitoring. + EntityType-level config: disabled. Feature-level config: inherited + from the configuration of EntityType this Feature belongs to. + - >- + Explicitly enables import features analysis. EntityType-level + config: by default enables import features analysis for all + Features under it. Feature-level config: enables import features + analysis regardless of the EntityType-level config. + - >- + Explicitly disables import features analysis. EntityType-level + config: by default disables import features analysis for all + Features under it. Feature-level config: disables import features + analysis regardless of the EntityType-level config. + anomalyDetectionBaseline: enum: - - STRATEGY_UNSPECIFIED - - ON_DEMAND - - LOW_COST - - STANDARD - - SPOT - - FLEX_START - restartJobOnWorkerRestart: - description: >- - Restarts the entire CustomJob if a worker gets restarted. This - feature can be used by distributed training jobs that are not - resilient to workers leaving and joining a job. - type: boolean - maxWaitDuration: - format: google-duration - description: >- - Optional. This is the maximum duration that a job will wait for the - requested resources to be provisioned if the scheduling strategy is - set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait - indefinitely. The default is 24 hours. + - BASELINE_UNSPECIFIED + - LATEST_STATS + - MOST_RECENT_SNAPSHOT_STATS + - PREVIOUS_IMPORT_FEATURES_STATS type: string - id: GoogleCloudAiplatformV1Scheduling - GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec: - type: object - description: Spec for question answering helpfulness metric. - id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec - properties: - version: - description: Optional. Which version to use for evaluation. - type: integer - format: int32 - useReference: + enumDescriptions: + - Should not be used. + - >- + Choose the later one statistics generated by either most recent + snapshot analysis or previous import features analysis. If non of + them exists, skip anomaly detection and only generate a + statistics. + - >- + Use the statistics generated by the most recent snapshot analysis + if exists. + - >- + Use the statistics generated by the previous import features + analysis if exists. description: >- - Optional. Whether to use instance.reference to compute question - answering helpfulness. - type: boolean - GoogleCloudAiplatformV1ToolParameterKeyMatchInstance: + The baseline used to do anomaly detection for the statistics + generated by import features analysis. + GoogleCloudAiplatformV1FluencyInstance: + id: GoogleCloudAiplatformV1FluencyInstance properties: prediction: - description: Required. Output of the evaluated model. type: string - reference: - type: string - description: Required. Ground truth used to compare against the prediction. - description: Spec for tool parameter key match instance. - id: GoogleCloudAiplatformV1ToolParameterKeyMatchInstance + description: Required. Output of the evaluated model. + description: Spec for fluency instance. type: object - GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation: - description: Annotation details specific to video action recognition. + GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest: + id: GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest properties: - annotationSpecId: - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. + parent: type: string - timeSegment: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' - description: >- - This Annotation applies to the time period represented by the - TimeSegment. If it's not set, the Annotation applies to the whole - video. - displayName: description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. + Required. The resource name of the TensorboardRun to create the + TensorboardTimeSeries in. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + tensorboardTimeSeriesId: type: string - id: GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation + description: >- + 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}" + tensorboardTimeSeries: + description: Required. The TensorboardTimeSeries to create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' type: object - GoogleCloudAiplatformV1TensorboardExperiment: - id: GoogleCloudAiplatformV1TensorboardExperiment + description: Request message for TensorboardService.CreateTensorboardTimeSeries. + GoogleCloudAiplatformV1FeatureOnlineStoreBigtable: + properties: + autoScaling: + description: Required. Autoscaling config applied to Bigtable Instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling type: object - description: >- - A TensorboardExperiment is a group of TensorboardRuns, that are - typically the results of a training job run, in a Tensorboard. + id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + GoogleCloudAiplatformV1NotebookRuntimeTemplate: + id: GoogleCloudAiplatformV1NotebookRuntimeTemplate properties: + description: + description: The description of the NotebookRuntimeTemplate. + type: string labels: additionalProperties: type: string + type: object description: >- - The labels with user-defined metadata to organize your - TensorboardExperiment. Label keys and values cannot be longer than - 64 characters (Unicode codepoints), can only contain lowercase + The labels with user-defined metadata to organize the + NotebookRuntimeTemplates. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International - characters are allowed. No more than 64 user labels can be - associated with one Dataset (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - `aiplatform.googleapis.com/` and are immutable. The following system - labels exist for each Dataset: * - `aiplatform.googleapis.com/dataset_metadata_schema`: output only. - Its value is the metadata_schema's title. - type: object - displayName: - description: User provided name of this TensorboardExperiment. - type: string + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. updateTime: - description: >- - Output only. Timestamp when this TensorboardExperiment was last - updated. - format: google-datetime type: string + format: google-datetime + description: >- + Output only. Timestamp when this NotebookRuntimeTemplate was most + recently updated. readOnly: true - source: - type: string + serviceAccount: description: >- - Immutable. Source of the TensorboardExperiment. Example: a custom - training job. + The service account that the runtime workload runs as. You can use + any service account within the same project, but you must have the + service account user permission to use the instance. If not + specified, the [Compute Engine default service + account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) + is used. + type: string createTime: - format: google-datetime - readOnly: true type: string - description: Output only. Timestamp when this TensorboardExperiment was created. - etag: description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - name: + Output only. Timestamp when this NotebookRuntimeTemplate was + created. readOnly: true - description: >- - Output only. Name of the TensorboardExperiment. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + format: google-datetime + notebookRuntimeType: + description: Optional. Immutable. The type of the notebook runtime template. + enum: + - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED + - USER_DEFINED + - ONE_CLICK + enumDescriptions: + - >- + Unspecified notebook runtime type, NotebookRuntimeType will + default to USER_DEFINED. + - runtime or template with coustomized configurations from user. + - runtime or template with system defined configurations. type: string - description: - description: Description of this TensorboardExperiment. + name: type: string - GoogleCloudLocationLocation: - type: object - description: A resource that represents a Google Cloud location. - id: GoogleCloudLocationLocation - properties: - displayName: + description: The resource name of the NotebookRuntimeTemplate. + networkSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' + description: Optional. Network spec. + idleShutdownConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". + The idle shutdown configuration of NotebookRuntimeTemplate. This + config will only be set when idle shutdown is enabled. + isDefault: + type: boolean + description: Output only. The default template to use if not specified. + readOnly: true + displayName: type: string - name: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` + Required. The display name of the NotebookRuntimeTemplate. The name + can be up to 128 characters long and can consist of any UTF-8 + characters. + machineSpec: + description: >- + Optional. Immutable. The specification of a single machine for the + template. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + etag: type: string - labels: - type: object - additionalProperties: + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + encryptionSpec: + description: Customer-managed encryption key spec for the notebook runtime. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + shieldedVmConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' + description: Optional. Immutable. Runtime Shielded VM spec. + networkTags: + type: array + items: type: string description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - metadata: + Optional. The Compute Engine tags to add to runtime (see [Tagging + instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). + eucConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' + description: EUC configuration of the NotebookRuntimeTemplate. + dataPersistentDiskSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' description: >- - Service-specific metadata. For example the available capacity at the - given location. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' - type: string - GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: + Optional. The specification of persistent disk attached to the + runtime as data disk storage. + description: >- + A template that specifies runtime configurations such as machine type, + runtime version, network configurations, etc. Multiple runtimes can be + created from a runtime template. type: object - description: Request message for ModelService.UpdateExplanationDataset. - properties: - examples: - description: The example config containing the location of the dataset. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' - id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest - GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance: + GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling: type: object - description: Prediction input format for Text Sentiment. properties: - mimeType: + maxNodeCount: + type: integer + format: int32 description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain - type: string - content: - description: The text snippet to make the predictions on. - type: string - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance - GoogleCloudAiplatformV1SafetySetting: - id: GoogleCloudAiplatformV1SafetySetting - description: Safety settings. + Required. The maximum number of nodes to scale up to. Must be + greater than or equal to min_node_count, and less than or equal to + 10 times of 'min_node_count'. + cpuUtilizationTarget: + type: integer + format: int32 + description: >- + Optional. A percentage of the cluster's CPU capacity. Can be from + 10% to 80%. When a cluster's CPU utilization exceeds the target that + you have set, Bigtable immediately adds nodes to the cluster. When + CPU utilization is substantially lower than the target, Bigtable + removes nodes. If not set will default to 50%. + minNodeCount: + description: >- + Required. The minimum number of nodes to scale down to. Must be + greater than or equal to 1. + type: integer + format: int32 + id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling + GoogleCloudAiplatformV1Presets: + type: object properties: - threshold: + modality: + description: >- + The modality of the uploaded model, which automatically configures + the distance measurement and feature normalization for the + underlying example index and queries. If your model does not + precisely fit one of these types, it is okay to choose the closest + type. enumDescriptions: - - Unspecified harm block threshold. - - Block low threshold and above (i.e. block more). - - Block medium threshold and above. - - Block only high threshold (i.e. block less). - - Block none. - type: string - enum: - - HARM_BLOCK_THRESHOLD_UNSPECIFIED - - BLOCK_LOW_AND_ABOVE - - BLOCK_MEDIUM_AND_ABOVE - - BLOCK_ONLY_HIGH - - BLOCK_NONE - description: Required. The harm block threshold. - category: + - Should not be set. Added as a recommended best practice for enums + - IMAGE modality + - TEXT modality + - TABULAR modality enum: - - HARM_CATEGORY_UNSPECIFIED - - HARM_CATEGORY_HATE_SPEECH - - HARM_CATEGORY_DANGEROUS_CONTENT - - HARM_CATEGORY_HARASSMENT - - HARM_CATEGORY_SEXUALLY_EXPLICIT + - MODALITY_UNSPECIFIED + - IMAGE + - TEXT + - TABULAR type: string - description: Required. Harm category. - enumDescriptions: - - The harm category is unspecified. - - The harm category is hate speech. - - The harm category is dangerous content. - - The harm category is harassment. - - The harm category is sexually explicit content. - method: + query: enum: - - HARM_BLOCK_METHOD_UNSPECIFIED - - SEVERITY - - PROBABILITY + - PRECISE + - FAST + type: string 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. + - More precise neighbors as a trade-off against slower response. + - Faster response as a trade-off against less precise neighbors. description: >- - Optional. Specify if the threshold is used for probability or - severity score. If not specified, the threshold is used for - probability score. - type: string + Preset option controlling parameters for speed-precision trade-off + when querying for examples. If omitted, defaults to `PRECISE`. + id: GoogleCloudAiplatformV1Presets + description: Preset configuration for example-based explanations + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig: + properties: + attributionScoreDriftThresholds: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + description: >- + Key is the feature name and value is the threshold. The threshold + here is against attribution score distance between different time + windows. + type: object + defaultDriftThreshold: + description: >- + Drift anomaly detection threshold used by all features. When the + per-feature thresholds are not set, this field can be used to + specify a threshold for all features. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + driftThresholds: + description: >- + Key is the feature name and value is the threshold. If a feature + needs to be monitored for drift, a value threshold must be + configured for that feature. The threshold here is against feature + distribution distance between different time windws. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + type: object type: object - GoogleCloudAiplatformV1SchemaTextDataItem: - id: GoogleCloudAiplatformV1SchemaTextDataItem - description: Payload of Text DataItem. + description: The config for Prediction data drift detection. + id: >- + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation: + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. + properties: + columnName: + type: string + timeFormat: + description: >- + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + type: string type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation + GoogleCloudAiplatformV1Endpoint: + description: >- + Models are deployed into it, and afterwards Endpoint is called to obtain + predictions and explanations. properties: - gcsUri: + name: + readOnly: true + type: string + description: Output only. The resource name of the Endpoint. + createTime: + description: Output only. Timestamp when this Endpoint was created. readOnly: true type: string + format: google-datetime + displayName: description: >- - Output only. Google Cloud Storage URI points to the original text in - user's bucket. The text file is up to 10MB in size. - GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader: - properties: - featureDescriptors: + Required. The display name of the Endpoint. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + type: string + modelDeploymentMonitoringJob: + description: >- + Output only. Resource name of the Model Monitoring job associated + with this Endpoint if monitoring is enabled by + JobService.CreateModelDeploymentMonitoringJob. Format: + `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + type: string + readOnly: true + updateTime: + description: Output only. Timestamp when this Endpoint was last updated. + readOnly: true + format: google-datetime + type: string + predictRequestResponseLoggingConfig: + description: Configures the request-response logging for online prediction. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + deployedModels: type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + readOnly: true description: >- - List of Feature metadata corresponding to each piece of - ReadFeatureValuesResponse.EntityView.data. - entityType: - type: string + Output only. The models deployed in this Endpoint. To add or remove + DeployedModels use EndpointService.DeployModel and + EndpointService.UndeployModel respectively. + enablePrivateServiceConnect: + type: boolean + deprecated: true description: >- - The resource name of the EntityType from the - ReadFeatureValuesRequest. Value format: - `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. - description: >- - Response header with metadata for the requested - ReadFeatureValuesRequest.entity_type and Features. - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader - type: object - GoogleCloudAiplatformV1ToolCallValidSpec: - description: Spec for tool call valid metric. - id: GoogleCloudAiplatformV1ToolCallValidSpec - properties: {} - type: object - GoogleCloudAiplatformV1ExamplesExampleGcsSource: - description: The Cloud Storage input instances. - id: GoogleCloudAiplatformV1ExamplesExampleGcsSource - type: object - properties: - dataFormat: + Deprecated: If true, expose the Endpoint via private service + connect. Only one of the fields, network or + enable_private_service_connect, can be set. + dedicatedEndpointEnabled: + description: >- + If true, the endpoint will be exposed through a dedicated DNS + [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + will be isolated from other users' traffic and will have better + performance and reliability. Note: Once you enabled dedicated + endpoint, you won't be able to send request to the shared DNS + {region}-aiplatform.googleapis.com. The limitation will be removed + soon. + type: boolean + trafficSplit: + description: >- + A map from a DeployedModel's ID to the percentage of this Endpoint's + traffic that should be forwarded to that DeployedModel. If a + DeployedModel's ID is not listed in this map, then it receives no + traffic. The traffic percentage values must add up to 100, or map + must be empty if the Endpoint is to not accept any traffic at a + moment. + type: object + additionalProperties: + format: int32 + type: integer + etag: type: string - enum: - - DATA_FORMAT_UNSPECIFIED - - JSONL description: >- - The format in which instances are given, if not specified, assume - it's JSONL format. Currently only JSONL format is supported. - enumDescriptions: - - Format unspecified, used when unset. - - Examples are stored in JSONL files. - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: The Cloud Storage location for the input instances. - GoogleCloudAiplatformV1CopyModelRequest: - description: Request message for ModelService.CopyModel. - id: GoogleCloudAiplatformV1CopyModelRequest - type: object - properties: - parentModel: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + privateServiceConnectConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig description: >- - Optional. Specify this field to copy source_model into this existing - Model as a new version. Format: - `projects/{project}/locations/{location}/models/{model}` + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + dedicatedEndpointDns: type: string - encryptionSpec: + readOnly: true description: >- - Customer-managed encryption key options. If this is set, then the - Model copy will be encrypted with the provided encryption key. + Output only. DNS of the dedicated endpoint. Will only be populated + if dedicated_endpoint_enabled is true. Format: + `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + encryptionSpec: $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - modelId: description: >- - Optional. Copy source_model into a new Model with this ID. The ID - will become the final component of the model 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. + Customer-managed encryption key spec for an Endpoint. If set, this + Endpoint and all sub-resources of this Endpoint will be secured by + this key. + network: + description: >- + Optional. The full name of the Google Compute Engine + [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) + to which the Endpoint should be peered. Private services access must + already be configured for the network. If left unspecified, the + Endpoint is not peered with any network. Only one of the fields, + network or enable_private_service_connect, can be set. + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where `{project}` is + a project number, as in `12345`, and `{network}` is network name. type: string - sourceModel: + description: + description: The description of the Endpoint. type: string + labels: + type: object description: >- - Required. The resource name of the Model to copy. That Model must be - in the same Project. Format: - `projects/{project}/locations/{location}/models/{model}` - CloudAiLargeModelsVisionRaiInfoDetectedLabels: - description: Filters returning list of deteceted labels, scores, and bounding boxes. - type: object - properties: - entities: - description: The list of detected entities for the rai signal. - items: - $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity - type: array - raiCategory: - description: The RAI category for the deteceted labels. - type: string - id: CloudAiLargeModelsVisionRaiInfoDetectedLabels - GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics + The labels with user-defined metadata to organize your Endpoints. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + additionalProperties: + type: string type: object + id: GoogleCloudAiplatformV1Endpoint + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata: properties: - exactMatch: - format: float - description: >- - The rate at which the input predicted strings exactly match their - references. - type: number - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature: - description: >- - Response message if the request uses the SelectTimeRangeAndFeature - option. - properties: - impactedFeatureCount: + costMilliNodeHours: type: string description: >- - The count of the features or columns impacted. This is the same as - the feature count in the request. - format: int64 - offlineStorageModifiedEntityRowCount: - type: string + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. format: int64 + successfulStopReason: + enumDescriptions: + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. + - >- + Further training of the Model ceased to increase its quality, + since it already has converged. description: >- - The count of modified entity rows in the offline storage. Each row - corresponds to the combination of an entity ID and a timestamp. One - entity ID can have multiple rows in the offline storage. Within each - row, only the features specified in the request are deleted. - onlineStorageModifiedEntityCount: + For successful job completions, this is the reason why the job has + finished. + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED type: string - description: >- - The count of modified entities in the online storage. Each entity ID - corresponds to one entity. Within each entity, only the features - specified in the request are deleted. - format: int64 type: object id: >- - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature - GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata: - type: object - description: Details of operations that perform update PersistentResource. - id: GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata + GoogleCloudAiplatformV1DeployedModelRef: + description: Points to a DeployedModel. + id: GoogleCloudAiplatformV1DeployedModelRef properties: - progressMessage: + endpoint: + description: Immutable. A resource name of an Endpoint. type: string - description: Progress Message for Update LRO - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for PersistentResource. - GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance: + deployedModelId: + type: string + description: Immutable. An ID of a DeployedModel in the above Endpoint. type: object + GoogleCloudAiplatformV1PipelineTaskDetailArtifactList: + id: GoogleCloudAiplatformV1PipelineTaskDetailArtifactList properties: - reference: - description: Optional. Ground truth used to compare against the prediction. - type: string - context: - type: string - description: Optional. Text provided as context to answer the question. - instruction: - type: string - description: >- - Required. The question asked and other instruction in the inference - prompt. - prediction: - description: Required. Output of the evaluated model. - type: string - id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance - description: Spec for question answering relevance instance. - GoogleCloudAiplatformV1AssignNotebookRuntimeRequest: - id: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest - description: Request message for NotebookService.AssignNotebookRuntime. + artifacts: + type: array + description: Output only. A list of artifact metadata. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + readOnly: true + type: object + description: A list of artifact metadata. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation + type: object properties: - notebookRuntimeTemplate: + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation + GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation: + type: object + id: GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation + properties: + annotationSpecId: description: >- - Required. The resource name of the NotebookRuntimeTemplate based on - which a NotebookRuntime will be assigned (reuse or create a new - one). + The resource Id of the AnnotationSpec that this Annotation pertains + to. type: string - notebookRuntime: - description: >- - Required. Provide runtime specific information (e.g. runtime owner, - notebook id) used for NotebookRuntime assignment. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' - notebookRuntimeId: + displayName: type: string - description: Optional. User specified ID for the notebook runtime. - type: object - GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + timeSegment: + description: >- + This Annotation applies to the time period represented by the + TimeSegment. If it's not set, the Annotation applies to the whole + video. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' + description: Annotation details specific to video action recognition. + GoogleCloudAiplatformV1UnmanagedContainerModel: + description: >- + Contains model information necessary to perform batch prediction without + requiring a full model import. type: object properties: - modelDisplayName: - type: string - description: >- - Required. Display name of the model in Vertex AI. System will pick a - display name if unspecified. - modelVersion: + artifactUri: type: string description: >- - Required. Full resource name of ml engine model version. Format: - `projects/{project}/models/{model}/versions/{version}`. - endpoint: - type: string + The path to the directory containing the Model artifact and any of + its supporting files. + predictSchemata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + description: Contains the schemata used in Model's predictions and explanations + containerSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' description: >- - Required. The ml.googleapis.com endpoint that this model version - should be migrated from. Example values: * ml.googleapis.com * - us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * - asia-east1-ml.googleapis.com - description: Config for migrating version in ml.googleapis.com to Vertex AI's Model. - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig - GoogleCloudAiplatformV1PscAutomatedEndpoints: - description: >- - PscAutomatedEndpoints defines the output of the forwarding rule - automatically created by each PscAutomationConfig. - id: GoogleCloudAiplatformV1PscAutomatedEndpoints + Input only. The specification of the container that is to be used + when deploying this Model. + id: GoogleCloudAiplatformV1UnmanagedContainerModel + GoogleCloudAiplatformV1GenerateContentRequest: properties: - projectId: - description: Corresponding project_id in pscAutomationConfigs - type: string - network: - type: string - description: Corresponding network in pscAutomationConfigs. - matchAddress: - type: string - description: Ip Address created by the automated forwarding rule. + labels: + 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. + additionalProperties: + type: string + type: object + systemInstruction: + description: >- + Optional. The user provided system instructions for the model. Note: + only text should be used in parts and content in each part will be + in a separate paragraph. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + generationConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' + description: Optional. Generation config. + contents: + description: >- + Required. The content of the current conversation with the model. + For single-turn queries, this is a single instance. For multi-turn + queries, this is a repeated field that contains conversation history + + latest request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + tools: + description: >- + Optional. A list of `Tools` the model may use to generate the next + response. A `Tool` is a piece of code that enables the system to + interact with external systems to perform an action, or set of + actions, outside of knowledge and scope of the model. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' + toolConfig: + description: >- + Optional. Tool config. This config is shared for all tools provided + in the request. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' + safetySettings: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' + description: >- + Optional. Per request settings for blocking unsafe content. Enforced + on GenerateContentResponse.candidates. + type: array + description: Request message for [PredictionService.GenerateContent]. type: object - GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest: - id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest - description: Request message for TensorboardService.ExportTensorboardTimeSeriesData. + id: GoogleCloudAiplatformV1GenerateContentRequest + GoogleCloudAiplatformV1FunctionCall: + description: >- + A predicted [FunctionCall] returned from the model that contains a + string representing the [FunctionDeclaration.name] and a structured JSON + object containing the parameters and their values. + id: GoogleCloudAiplatformV1FunctionCall type: object properties: - pageToken: - type: string + args: description: >- - A page token, received from a previous - ExportTensorboardTimeSeriesData call. Provide this to retrieve the - subsequent page. When paginating, all other parameters provided to - ExportTensorboardTimeSeriesData must match the call that provided - the page token. - orderBy: + Optional. Required. The function parameters and values in JSON + object format. See [FunctionDeclaration.parameters] for parameter + details. + type: object + additionalProperties: + description: Properties of the object. + type: any + name: type: string description: >- - Field to use to sort the TensorboardTimeSeries' data. By default, - TensorboardTimeSeries' data is returned in a pseudo random order. - filter: - type: string + Required. The name of the function to call. Matches + [FunctionDeclaration.name]. + GoogleCloudAiplatformV1ExplainRequest: + id: GoogleCloudAiplatformV1ExplainRequest + properties: + explanationSpecOverride: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpecOverride' description: >- - Exports the TensorboardTimeSeries' data that match the filter - expression. - pageSize: - format: int32 - type: integer + If specified, overrides the explanation_spec of the DeployedModel. + Can be used for explaining prediction results with different + configurations, such as: - Explaining top-5 predictions results as + opposed to top-1; - Increasing path count or step count of the + attribution methods to reduce approximate errors; - Using different + baselines for explaining the prediction results. + instances: description: >- - The maximum number of data points to return per page. The default - page_size is 1000. Values must be between 1 and 10000. Values above - 10000 are coerced to 10000. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation: - properties: - columnName: + Required. The instances that are the input to the explanation call. + A DeployedModel may have an upper limit on the number of instances + it supports per request, and when it is exceeded the explanation + call errors in case of AutoML Models, or, in case of customer + created Models, the behaviour is as documented by that Model. The + schema of any single instance may be specified via Endpoint's + DeployedModels' Model's PredictSchemata's instance_schema_uri. + type: array + items: + type: any + parameters: + description: >- + The parameters that govern the prediction. The schema of the + parameters may be specified via Endpoint's DeployedModels' Model's + PredictSchemata's parameters_schema_uri. + type: any + deployedModelId: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. - type: object - GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata: - description: Details of operations that perform create EntityType. - properties: - genericMetadata: - description: Operation metadata for EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata - type: object - GoogleCloudAiplatformV1PurgeContextsRequest: - description: Request message for MetadataService.PurgeContexts. + description: >- + If specified, this ExplainRequest will be served by the chosen + DeployedModel, overriding Endpoint.traffic_split. type: object + description: Request message for PredictionService.Explain. + GoogleCloudAiplatformV1ListFeatureGroupsResponse: properties: - filter: + nextPageToken: type: string description: >- - Required. A required filter matching the Contexts to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. - force: - type: boolean - description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Context names - that would be deleted. - id: GoogleCloudAiplatformV1PurgeContextsRequest - GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData: - type: object - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData - properties: - userUsageData: + A token, which can be sent as ListFeatureGroupsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + featureGroups: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + description: The FeatureGroups matching the request. type: array - description: Usage data for each user in the given month. - description: Per month usage data - GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse: + description: Response message for FeatureRegistryService.ListFeatureGroups. type: object - description: Response message for TensorboardService.ReadTensorboardTimeSeriesData. - id: GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + id: GoogleCloudAiplatformV1ListFeatureGroupsResponse + GoogleCloudAiplatformV1BatchPredictionJobInputConfig: + description: >- + Configures the input to BatchPredictionJob. See + Model.supported_input_storage_formats for Model's supported input + formats, and how instances should be expressed via any of them. + type: object + id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig properties: - timeSeriesData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' - description: The returned time series data. - GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse: - description: Response message for ModelService.BatchImportEvaluatedAnnotations + gcsSource: + description: The Cloud Storage location for the input instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + instancesFormat: + description: >- + Required. The format in which instances are given, must be one of + the Model's supported_input_storage_formats. + type: string + bigquerySource: + description: >- + The BigQuery location of the input table. The schema of the table + should be in the format described by the given context OpenAPI + Schema, if one is provided. The table may contain additional columns + that are not described by the schema, and they will be ignored. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance: properties: - importedEvaluatedAnnotationsCount: - type: integer - format: int32 - readOnly: true - description: Output only. Number of EvaluatedAnnotations imported. - id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + baselinePrediction: + description: Required. Output of the baseline model. + type: string + instruction: + type: string + description: Required. Question Answering prompt for LLM. + prediction: + type: string + description: Required. Output of the candidate model. + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + context: + description: Required. Text to answer the question. + type: string type: object - GoogleTypeColor: + description: Spec for pairwise question answering quality instance. + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance + GoogleCloudAiplatformV1EncryptionSpec: + type: object + id: GoogleCloudAiplatformV1EncryptionSpec properties: - alpha: - format: float - type: number + kmsKeyName: + type: string description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - green: - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - format: float - red: - description: The amount of red in the color as a value in the interval [0, 1]. - format: float - type: number - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - type: number - format: float - id: GoogleTypeColor + Required. The Cloud KMS resource identifier of the customer managed + encryption key used to protect a resource. Has the form: + `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. + The key needs to be in the same region as where the compute resource + is created. description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... + Represents a customer-managed encryption key spec that can be applied to + a top-level resource. + GoogleCloudAiplatformV1Probe: + description: >- + Probe describes a health check to be performed against a container to + determine whether it is alive or ready to receive traffic. + id: GoogleCloudAiplatformV1Probe type: object - GoogleCloudAiplatformV1SafetySpec: properties: - version: + exec: + description: ExecAction probes the health of a container by executing a command. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' + periodSeconds: format: int32 - description: Optional. Which version to use for evaluation. + description: >- + How often (in seconds) to perform the probe. Default to 10 seconds. + Minimum value is 1. Must be less than timeout_seconds. Maps to + Kubernetes probe argument 'periodSeconds'. type: integer - id: GoogleCloudAiplatformV1SafetySpec + timeoutSeconds: + type: integer + description: >- + Number of seconds after which the probe times out. Defaults to 1 + second. Minimum value is 1. Must be greater or equal to + period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. + format: int32 + GoogleCloudAiplatformV1GroundednessInput: + properties: + instance: + description: Required. Groundedness instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInstance' + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessSpec' + description: Required. Spec for groundedness metric. type: object - description: Spec for safety metric. - GoogleCloudAiplatformV1SafetyResult: + description: Input for groundedness metric. + id: GoogleCloudAiplatformV1GroundednessInput + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec: + description: Spec for pairwise question answering quality score metric. + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec type: object properties: - score: - format: float + version: + type: integer + format: int32 + description: Optional. Which version to use for evaluation. + useReference: + type: boolean + description: >- + Optional. Whether to use instance.reference to compute question + answering quality. + GoogleCloudAiplatformV1FeatureView: + description: >- + FeatureView is representation of values that the FeatureOnlineStore will + serve based on its syncConfig. + properties: + name: + type: string + description: >- + Identifier. Name of the FeatureView. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + bigQuerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewBigQuerySource + description: >- + Optional. Configures how data is supposed to be extracted from a + BigQuery source to be loaded onto the FeatureOnlineStore. + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean readOnly: true - type: number - description: Output only. Safety score. - confidence: - type: number - description: Output only. Confidence for safety score. - format: float + labels: + additionalProperties: + type: string + type: object + description: >- + Optional. The labels with user-defined metadata to organize your + FeatureViews. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureOnlineStore(System labels are excluded)." System + reserved label keys are prefixed with "aiplatform.googleapis.com/" + and are immutable. + vertexRagSource: + description: Optional. The Vertex RAG Source that the FeatureView is linked to. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewVertexRagSource + createTime: + format: google-datetime + type: string + description: Output only. Timestamp when this FeatureView was created. readOnly: true - explanation: + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. readOnly: true - description: Output only. Explanation for safety score. + featureRegistrySource: + description: >- + Optional. Configures the features from a Feature Registry source + that need to be loaded onto the FeatureOnlineStore. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource + indexConfig: + description: >- + Optional. Configuration for index preparation for vector search. It + contains the required configurations to create an index from source + data, so that approximate nearest neighbor (a.k.a ANN) algorithms + search can be performed during online serving. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfig' + updateTime: + format: google-datetime type: string - id: GoogleCloudAiplatformV1SafetyResult - description: Spec for safety result. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation: - properties: - columnName: + description: Output only. Timestamp when this FeatureView was last updated. + readOnly: true + etag: + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. type: string - invalidValuesAllowed: - type: boolean + syncConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncConfig' description: >- - If invalid values is allowed, the training pipeline will create a - boolean feature that indicated whether the value is valid. - Otherwise, the training pipeline will discard the input row from - trainining data. + Configures when data is to be synced/updated for this FeatureView. + At the end of the sync the latest featureValues for each entityId of + this FeatureView are made ready for online serving. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation - description: >- - Treats the column as numerical array and performs following - transformation functions. * All transformations for Numerical types - applied to the average of the all elements. * The average of empty - arrays is treated as zero. - GoogleCloudAiplatformV1GroundingChunkWeb: - description: Chunk from the web. + id: GoogleCloudAiplatformV1FeatureView + GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport: + id: GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport type: object - id: GoogleCloudAiplatformV1GroundingChunkWeb properties: - title: - type: string - description: Title of the chunk. - uri: - description: URI reference of the chunk. + startTime: + description: >- + Excludes Feature values with feature generation timestamp before + this timestamp. If not set, retrieve oldest values kept in Feature + Store. Timestamp, if present, must not have higher than millisecond + precision. type: string - GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse: - description: Response message for TensorboardService.ReadTensorboardBlobData. - type: object - id: GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse - properties: - blobs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' - description: Blob messages containing blob bytes. - type: array - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata: - description: Model metadata specific to AutoML Forecasting. - properties: - trainCostMilliNodeHours: - description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - type: string - format: int64 - evaluatedDataItemsBigqueryUri: - type: string - description: BigQuery destination uri for exported evaluated examples. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata - type: object - GoogleCloudAiplatformV1FetchFeatureValuesRequest: - id: GoogleCloudAiplatformV1FetchFeatureValuesRequest - type: object - description: >- - Request message for FeatureOnlineStoreService.FetchFeatureValues. All - the features under the requested feature view will be returned. - properties: - dataKey: - description: Optional. The request key to fetch feature values for. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' - dataFormat: + format: google-datetime + endTime: + format: google-datetime type: string description: >- - Optional. Response data format. If not set, - FeatureViewDataFormat.KEY_VALUE will be used. - enumDescriptions: - - Not set. Will be treated as the KeyValue format. - - Return response data in key-value format. - - Return response data in proto Struct format. - enum: - - FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED - - KEY_VALUE - - PROTO_STRUCT - GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. - description: Details of operations that perform batch create Features. - id: GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata + Exports Feature values as of this timestamp. If not set, retrieve + values as of now. Timestamp, if present, must not have higher than + millisecond precision. + description: >- + Describes exporting all historical Feature values of all entities of the + EntityType between [start_time, end_time]. + GoogleCloudAiplatformV1StudySpecMetricSpec: type: object - GoogleCloudAiplatformV1ExplanationMetadataInputMetadata: + description: Represents a metric to optimize. properties: - inputBaselines: - description: >- - Baseline inputs for this feature. If no baseline is specified, - Vertex AI chooses the baseline for this feature. If multiple - baselines are specified, Vertex AI returns the average attributions - across them in Attribution.feature_attributions. For Vertex - AI-provided Tensorflow images (both 1.x and 2.x), the shape of each - baseline must match the shape of the input tensor. If a scalar is - provided, we broadcast to the same shape as the input tensor. For - custom images, the element of the baselines must be in the same - format as the feature's input in the instance[]. The schema of any - single instance may be specified via Endpoint's DeployedModels' - Model's PredictSchemata's instance_schema_uri. - items: - type: any - type: array - visualization: - description: Visualization configurations for image explanation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization - denseShapeTensorName: + metricId: + type: string description: >- - Specifies the shape of the values of the input if the input is a - sparse representation. Refer to Tensorflow documentation for more - details: - https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. + Required. The ID of the metric. Must not contain whitespaces and + must be unique amongst all MetricSpecs. + goal: + description: Required. The optimization goal of the metric. type: string - encoding: enum: - - ENCODING_UNSPECIFIED - - IDENTITY - - BAG_OF_FEATURES - - BAG_OF_FEATURES_SPARSE - - INDICATOR - - COMBINED_EMBEDDING - - CONCAT_EMBEDDING - type: string - description: >- - Defines how the feature is encoded into the input tensor. Defaults - to IDENTITY. + - GOAL_TYPE_UNSPECIFIED + - MAXIMIZE + - MINIMIZE enumDescriptions: - - Default value. This is the same as IDENTITY. - - The tensor represents one feature. - - >- - The tensor represents a bag of features where each index maps to a - feature. InputMetadata.index_feature_mapping must be provided for - this encoding. For example: ``` input = [27, 6.0, 150] - index_feature_mapping = ["age", "height", "weight"] ``` - - >- - The tensor represents a bag of features where each index maps to a - feature. Zero values in the tensor indicates feature being - non-existent. InputMetadata.index_feature_mapping must be provided - for this encoding. For example: ``` input = [2, 0, 5, 0, 1] - index_feature_mapping = ["a", "b", "c", "d", "e"] ``` - - >- - The tensor is a list of binaries representing whether a feature - exists or not (1 indicates existence). - InputMetadata.index_feature_mapping must be provided for this - encoding. For example: ``` input = [1, 0, 1, 0, 1] - index_feature_mapping = ["a", "b", "c", "d", "e"] ``` - - >- - The tensor is encoded into a 1-dimensional array represented by an - encoded tensor. InputMetadata.encoded_tensor_name must be provided - for this encoding. For example: ``` input = ["This", "is", "a", - "test", "."] encoded = [0.1, 0.2, 0.3, 0.4, 0.5] ``` - - >- - Select this encoding when the input tensor is encoded into a - 2-dimensional array represented by an encoded tensor. - InputMetadata.encoded_tensor_name must be provided for this - encoding. The first dimension of the encoded tensor's shape is the - same as the input tensor's shape. For example: ``` input = - ["This", "is", "a", "test", "."] encoded = [[0.1, 0.2, 0.3, 0.4, - 0.5], [0.2, 0.1, 0.4, 0.3, 0.5], [0.5, 0.1, 0.3, 0.5, 0.4], [0.5, - 0.3, 0.1, 0.2, 0.4], [0.4, 0.3, 0.2, 0.5, 0.1]] ``` - indexFeatureMapping: - type: array - description: >- - A list of feature names for each index in the input tensor. Required - when the input InputMetadata.encoding is BAG_OF_FEATURES, - BAG_OF_FEATURES_SPARSE, INDICATOR. - items: - type: string - modality: - description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. - type: string - indicesTensorName: - type: string + - Goal Type will default to maximize. + - Maximize the goal metric. + - Minimize the goal metric. + safetyConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig description: >- - Specifies the index of the values of the input tensor. Required when - the input tensor is a sparse representation. Refer to Tensorflow - documentation for more details: - https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. - groupName: + Used for safe search. In the case, the metric will be a safety + metric. You must provide a separate metric for objective metric. + id: GoogleCloudAiplatformV1StudySpecMetricSpec + GoogleCloudAiplatformV1UploadModelResponse: + description: Response message of ModelService.UploadModel operation. + id: GoogleCloudAiplatformV1UploadModelResponse + type: object + properties: + modelVersionId: type: string + description: Output only. The version ID of the model that is uploaded. + readOnly: true + model: description: >- - Name of the group that the input belongs to. Features with the same - group name will be treated as one feature when computing - attributions. Features grouped together can have different shapes in - value. If provided, there will be one single attribution generated - in Attribution.feature_attributions, keyed by the group name. - inputTensorName: - description: >- - Name of the input tensor for this feature. Required and is only - applicable to Vertex AI-provided images for Tensorflow. + The name of the uploaded Model resource. Format: + `projects/{project}/locations/{location}/models/{model}` type: string - encodedTensorName: + GoogleCloudAiplatformV1ListStudiesResponse: + properties: + nextPageToken: type: string description: >- - Encoded tensor is a transformation of the input tensor. Must be - provided if choosing Integrated Gradients attribution or XRAI - attribution and the input tensor is not differentiable. An encoded - tensor is generated if the input tensor is encoded by a lookup - table. - featureValueDomain: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain - description: >- - The domain details of the input feature value. Like min/max, - original mean or standard deviation if normalized. - encodedBaselines: + Passes this token as the `page_token` field of the request for a + subsequent call. If this field is omitted, there are no subsequent + pages. + studies: items: - type: any + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + description: The studies associated with the project. type: array - description: >- - A list of baselines for the encoded tensor. The shape of each - baseline should match the shape of the encoded tensor. If a scalar - is provided, Vertex AI broadcasts to the same shape as the encoded - tensor. - type: object - description: >- - Metadata of the input of a feature. Fields other than - InputMetadata.input_baselines are applicable only for Models that are - using Vertex AI-provided images for Tensorflow. - id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadata - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics: + description: Response message for VizierService.ListStudies. + id: GoogleCloudAiplatformV1ListStudiesResponse type: object - description: >- - UNIMPLEMENTED. Track matching model metrics for a single track match - threshold and multiple label match confidence thresholds. - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics + GoogleCloudAiplatformV1RougeMetricValue: properties: - meanBoundingBoxIou: - format: float - description: The mean bounding box iou over all confidence thresholds. - type: number - confidenceMetrics: - description: >- - Metrics for each label-match `confidenceThreshold` from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics - meanTrackingAveragePrecision: + score: + description: Output only. Rouge score. + readOnly: true type: number format: float - description: The mean average precision over all confidence thresholds. - iouThreshold: + id: GoogleCloudAiplatformV1RougeMetricValue + type: object + description: Rouge metric value for an instance. + CloudAiLargeModelsVisionMedia: + properties: + video: + $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' + description: Video + image: + $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' + description: Image. + id: CloudAiLargeModelsVisionMedia + type: object + description: Media. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics: + type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics + properties: + exactMatch: type: number - format: float description: >- - The intersection-over-union threshold value between bounding boxes - across frames used to compute this metric entry. - meanMismatchRate: - type: number - description: The mean mismatch rate over all confidence thresholds. + The rate at which the input predicted strings exactly match their + references. format: float - GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact: + GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem: type: object - description: The type of an input artifact. + description: >- + Attributed items for a given annotation, typically representing + neighbors from the training sets constrained by the query type. + id: GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem properties: - artifactId: - type: string + annotationResourceName: description: >- - Artifact resource id from MLMD. Which is the last portion of an - artifact resource name: - `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. - The artifact must stay within the same project, location and default - metadatastore as the pipeline. - id: GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact - GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse: - description: >- - Response message for - TensorboardService.BatchReadTensorboardTimeSeriesData. - type: object + The unique ID for each annotation. Used by FE to allocate the + annotation in DB. + type: string + distance: + description: The distance of this item to the annotation. + type: number + format: double + GoogleCloudAiplatformV1ReadIndexDatapointsRequest: + description: The request message for MatchService.ReadIndexDatapoints. + id: GoogleCloudAiplatformV1ReadIndexDatapointsRequest properties: - timeSeriesData: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + ids: type: array - description: The returned time series data. - id: GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse - GoogleCloudAiplatformV1SchemaImageClassificationAnnotation: - id: GoogleCloudAiplatformV1SchemaImageClassificationAnnotation - description: Annotation details specific to image classification. + description: IDs of the datapoints to be searched for. + items: + type: string + deployedIndexId: + description: The ID of the DeployedIndex that will serve the request. + type: string type: object + GoogleCloudAiplatformV1BatchMigrateResourcesResponse: + type: object + id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse properties: - annotationSpecId: - type: string - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - GoogleCloudAiplatformV1PredictRequest: - description: Request message for PredictionService.Predict. + migrateResourceResponses: + description: Successfully migrated resources. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse + type: array + description: Response message for MigrationService.BatchMigrateResources. + GoogleCloudAiplatformV1BatchCreateFeaturesRequest: + description: Request message for FeaturestoreService.BatchCreateFeatures. type: object + id: GoogleCloudAiplatformV1BatchCreateFeaturesRequest properties: - parameters: - type: any + requests: description: >- - The parameters that govern the prediction. The schema of the - parameters may be specified via Endpoint's DeployedModels' Model's - PredictSchemata's parameters_schema_uri. - instances: + Required. The request message specifying the Features to create. All + Features must be created under the same parent EntityType. The + `parent` field in each child request message can be omitted. If + `parent` is set in a child request, then the value must match the + `parent` value in this request message. type: array items: - type: any - description: >- - Required. The instances that are the input to the prediction call. A - DeployedModel may have an upper limit on the number of instances it - supports per request, and when it is exceeded the prediction call - errors in case of AutoML Models, or, in case of customer created - Models, the behaviour is as documented by that Model. The schema of - any single instance may be specified via Endpoint's DeployedModels' - Model's PredictSchemata's instance_schema_uri. - id: GoogleCloudAiplatformV1PredictRequest - GoogleCloudAiplatformV1Int64Array: - id: GoogleCloudAiplatformV1Int64Array + $ref: '#/components/schemas/GoogleCloudAiplatformV1CreateFeatureRequest' + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition: type: object + description: Represents the spec to match discrete values from parent parameter. + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition properties: values: + description: >- + Required. Matches values of the parent parameter of 'DISCRETE' type. + All values must exist in `discrete_value_spec` of parent parameter. + The Epsilon of the value matching is 1e-10. items: - type: string - format: int64 - description: A list of int64 values. + format: double + type: number type: array - description: A list of int64 values. - GoogleCloudAiplatformV1VideoMetadata: + GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata: + description: Describes metadata for a TensorboardTimeSeries. properties: - endOffset: - description: Optional. The end offset of the video. - format: google-duration + maxStep: + format: int64 + description: >- + Output only. Max step index of all data points within a + TensorboardTimeSeries. + readOnly: true type: string - startOffset: - format: google-duration - description: Optional. The start offset of the video. + maxBlobSequenceLength: + type: string + readOnly: true + format: int64 + description: >- + Output only. The largest blob sequence length (number of blobs) of + all data points in this time series, if its ValueType is + BLOB_SEQUENCE. + maxWallTime: type: string + format: google-datetime + description: >- + Output only. Max wall clock timestamp of all data points within a + TensorboardTimeSeries. + readOnly: true + id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata + type: object + GoogleCloudAiplatformV1Study: + id: GoogleCloudAiplatformV1Study type: object - id: GoogleCloudAiplatformV1VideoMetadata - description: Metadata describes the input video content. - GoogleCloudAiplatformV1PublisherModel: - id: GoogleCloudAiplatformV1PublisherModel properties: - versionId: + createTime: type: string - description: >- - Output only. Immutable. The version ID of the PublisherModel. A new - version is committed when a new model version is uploaded under an - existing model id. It is an auto-incrementing decimal number in - string representation. readOnly: true - supportedActions: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToAction - description: Optional. Supported call-to-action options. - predictSchemata: - description: >- - Optional. The schemata that describes formats of the - PublisherModel's predictions and explanations as given and returned - via PredictionService.Predict. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - frameworks: - description: Optional. Additional information about the model's Frameworks. - items: - type: string - type: array - openSourceCategory: - description: Required. Indicates the open source category of the publisher model. + description: Output only. Time at which the study was created. + format: google-datetime + state: + description: Output only. The detailed state of a Study. enumDescriptions: - - The open source category is unspecified, which should not be used. - - Used to indicate the PublisherModel is not open sourced. - - >- - Used to indicate the PublisherModel is a Google-owned open source - model w/ Google checkpoint. - - >- - Used to indicate the PublisherModel is a 3p-owned open source - model w/ Google checkpoint. - - >- - Used to indicate the PublisherModel is a Google-owned pure open - source model. + - The study state is unspecified. + - The study is active. + - The study is stopped due to an internal error. - >- - Used to indicate the PublisherModel is a 3p-owned pure open source - model. + The study is done when the service exhausts the parameter search + space or max_trial_count is reached. + readOnly: true enum: - - OPEN_SOURCE_CATEGORY_UNSPECIFIED - - PROPRIETARY - - GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT - - THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT - - GOOGLE_OWNED_OSS - - THIRD_PARTY_OWNED_OSS + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + - COMPLETED type: string - publisherModelTemplate: + name: type: string + description: >- + Output only. The name of a study. The study's globally unique + identifier. Format: + `projects/{project}/locations/{location}/studies/{study}` + readOnly: true + studySpec: + description: Required. Configuration of the Study. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + inactiveReason: readOnly: true + type: string description: >- - Optional. Output only. Immutable. Used to indicate this model has a - publisher model and provide the template of the publisher model - resource name. - versionState: - enum: - - VERSION_STATE_UNSPECIFIED - - VERSION_STATE_STABLE - - VERSION_STATE_UNSTABLE + Output only. A human readable reason why the Study is inactive. This + should be empty if a study is ACTIVE or COMPLETED. + displayName: type: string - description: Optional. Indicates the state of the model version. - enumDescriptions: - - The version state is unspecified. - - Used to indicate the version is stable. - - Used to indicate the version is unstable. - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - EXPERIMENTAL - - PRIVATE_PREVIEW - - PUBLIC_PREVIEW - - GA + description: Required. Describes the Study, default value is empty string. + description: A message representing a Study. + GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse: + properties: + importedEvaluatedAnnotationsCount: + description: Output only. Number of EvaluatedAnnotations imported. + format: int32 + type: integer + readOnly: true + description: Response message for ModelService.BatchImportEvaluatedAnnotations + id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + type: object + GoogleCloudAiplatformV1RougeInstance: + properties: + prediction: + description: Required. Output of the evaluated model. type: string - enumDescriptions: - - The model launch stage is unspecified. - - >- - Used to indicate the PublisherModel is at Experimental launch - stage, available to a small set of customers. - - >- - Used to indicate the PublisherModel is at Private Preview launch - stage, only available to a small set of customers, although a - larger set of customers than an Experimental launch. Previews are - the first launch stage used to get feedback from customers. - - >- - Used to indicate the PublisherModel is at Public Preview launch - stage, available to all customers, although not supported for - production workloads. - - >- - Used to indicate the PublisherModel is at GA launch stage, - available to all customers and ready for production workload. - description: Optional. Indicates the launch stage of the model. - name: + reference: + description: Required. Ground truth used to compare against the prediction. type: string - readOnly: true - description: Output only. The resource name of the PublisherModel. - description: A Model Garden Publisher Model. + description: Spec for rouge instance. + id: GoogleCloudAiplatformV1RougeInstance type: object - GoogleCloudAiplatformV1ExportDataConfig: + GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec: properties: - filterSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFilterSplit' - description: Split based on the provided filters for each set. - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + useElapsedDuration: + type: boolean description: >- - The Google Cloud Storage location where the output is to be written - to. In the given directory a new directory will be created with - name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ - ISO-8601 format. All export output will be written into that - directory. Inside that directory, annotations with the same schema - will be grouped into sub directories which are named with the - corresponding annotations' schema title. Inside these sub - directories, a schema.yaml will be created to describe the output - format. - savedQueryId: + True if Measurement.elapsed_duration is used as the x-axis of each + Trials Decay Curve. Otherwise, Measurement.step_count will be used + as the x-axis. + id: GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec + description: >- + The decay curve automated stopping rule builds a Gaussian Process + Regressor to predict the final objective value of a Trial based on the + already completed Trials and the intermediate measurements of the + current Trial. Early stopping is requested for the current Trial if + there is very low probability to exceed the optimal value found so far. + type: object + GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput: + type: object + description: Input for question answering relevance metric. + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput + properties: + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance + description: Required. Question answering relevance instance. + metricSpec: + description: Required. Spec for question answering relevance score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec + GoogleCloudAiplatformV1Port: + id: GoogleCloudAiplatformV1Port + type: object + description: Represents a network port in a container. + properties: + containerPort: + format: int32 description: >- - The ID of a SavedQuery (annotation set) under the Dataset specified - by dataset_id used for filtering Annotations for training. Only used - for custom training data export use cases. Only applicable to - Datasets that have SavedQueries. Only Annotations that are - associated with this SavedQuery are used in respectively training. - When used in conjunction with annotations_filter, the Annotations - used for training are filtered by both saved_query_id and - annotations_filter. Only one of saved_query_id and - annotation_schema_uri should be specified as both of them represent - the same thing: problem type. - type: string - exportUse: - type: string - description: Indicates the usage of the exported files. - enum: - - EXPORT_USE_UNSPECIFIED - - CUSTOM_CODE_TRAINING - enumDescriptions: - - Regular user export. - - Export for custom code training. - annotationSchemaUri: + The number of the port to expose on the pod's IP address. Must be a + valid port number, between 1 and 65535 inclusive. + type: integer + GoogleCloudAiplatformV1SummarizationQualityInput: + type: object + description: Input for summarization quality metric. + properties: + instance: + description: Required. Summarization quality instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInstance + metricSpec: + description: Required. Spec for summarization quality score metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SummarizationQualitySpec' + id: GoogleCloudAiplatformV1SummarizationQualityInput + GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance: + properties: + content: description: >- - The Cloud Storage URI that points to a YAML file describing the - annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/, note that - the chosen schema must be consistent with metadata of the Dataset - specified by dataset_id. Only used for custom training data export - use cases. Only applicable to Datasets that have DataItems and - Annotations. Only Annotations that both match this schema and belong - to DataItems not ignored by the split method are used in - respectively training, validation or test role, depending on the - role of the DataItem they are on. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both annotations_filter and annotation_schema_uri. + The Google Cloud Storage location of the video on which to perform + the prediction. type: string - annotationsFilter: + timeSegmentEnd: type: string description: >- - An expression for filtering what part of the Dataset is to be - exported. Only Annotations that match this filter will be exported. - The filter syntax is the same as in ListAnnotations. - fractionSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFractionSplit' - description: Split based on fractions defining the size of each set. - description: >- - Describes what part of the Dataset is to be exported, the destination of - the export and how to export. - type: object - id: GoogleCloudAiplatformV1ExportDataConfig - GoogleCloudAiplatformV1ListPipelineJobsResponse: - properties: - nextPageToken: + The end, exclusive, of the video's time segment on which to perform + the prediction. Expressed as a number of seconds as measured from + the start of the video, with "s" appended at the end. Fractions are + allowed, up to a microsecond precision, and "inf" or "Infinity" is + allowed, which means the end of the video. + timeSegmentStart: type: string description: >- - A token to retrieve the next page of results. Pass to - ListPipelineJobsRequest.page_token to obtain that page. - pipelineJobs: - description: List of PipelineJobs in the requested page. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' - type: array - description: Response message for PipelineService.ListPipelineJobs - id: GoogleCloudAiplatformV1ListPipelineJobsResponse + The beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. + mimeType: + description: >- + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime + type: string + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance + description: Prediction input format for Video Action Recognition. type: object - GoogleCloudAiplatformV1DeploymentResourcePool: + GoogleCloudAiplatformV1MigrateResourceRequest: type: object description: >- - A description of resources that can be shared by multiple - DeployedModels, whose underlying specification consists of a - DedicatedResources. - id: GoogleCloudAiplatformV1DeploymentResourcePool + Config of migrating one resource from automl.googleapis.com, + datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. + id: GoogleCloudAiplatformV1MigrateResourceRequest properties: - serviceAccount: - type: string - description: >- - The service account that the DeploymentResourcePool's container(s) - run as. Specify the email address of the service account. If this - service account is not specified, the container(s) run as a service - account that doesn't have access to the resource project. Users - deploying the Models to this DeploymentResourcePool must have the - `iam.serviceAccounts.actAs` permission on this service account. - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + migrateAutomlDatasetConfig: description: >- - Required. The underlying DedicatedResources that the - DeploymentResourcePool uses. - disableContainerLogging: + Config for migrating Dataset in automl.googleapis.com to Vertex AI's + Dataset. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig + migrateDataLabelingDatasetConfig: description: >- - If the DeploymentResourcePool is deployed with custom-trained Models - or AutoML Tabular Models, the container(s) of the - DeploymentResourcePool will send `stderr` and `stdout` streams to - Cloud Logging by default. Please note that the logs incur cost, - which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging/pricing). User can disable - container logging by setting this flag to true. - type: boolean - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Config for migrating Dataset in datalabeling.googleapis.com to + Vertex AI's Dataset. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + migrateMlEngineModelVersionConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig description: >- - Customer-managed encryption key spec for a DeploymentResourcePool. - If set, this DeploymentResourcePool will be secured by this key. - Endpoints and the DeploymentResourcePool they deploy in need to have - the same EncryptionSpec. - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. Timestamp when this DeploymentResourcePool was created. - satisfiesPzs: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - name: - type: string + Config for migrating Version in ml.googleapis.com to Vertex AI's + Model. + migrateAutomlModelConfig: description: >- - Immutable. The resource name of the DeploymentResourcePool. Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - GoogleCloudAiplatformV1DeployedIndexAuthConfig: - properties: - authProvider: + Config for migrating Model in automl.googleapis.com to Vertex AI's + Model. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider - description: Defines the authentication provider that the DeployedIndex uses. - id: GoogleCloudAiplatformV1DeployedIndexAuthConfig - description: Used to set up the auth on the DeployedIndex's private endpoint. - type: object - GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance: + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig + GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams: type: object - description: Prediction input format for Text Extraction. + description: Prediction model parameters for Video Object Tracking. + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams properties: - mimeType: - type: string + minBoundingBoxSize: description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain - key: + Only bounding boxes with shortest edge at least that long as a + relative value of video frame size are returned. Default value is + 0.0. + type: number + format: float + confidenceThreshold: description: >- - This field is only used for batch prediction. If a key is provided, - the batch prediction result will by mapped to this key. If omitted, - then the batch prediction result will contain the entire input - instance. Vertex AI will not check if keys in the request are - duplicates, so it is up to the caller to ensure the keys are unique. - type: string - content: - type: string - description: The text snippet to make the predictions on. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance - GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo: + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + format: float + type: number + maxPredictions: + description: >- + The model only returns up to that many top, by confidence score, + predictions per frame of the video. If this number is very high, the + Model may return fewer predictions per frame. Default value is 50. + format: int32 + type: integer + GoogleCloudAiplatformV1ListBatchPredictionJobsResponse: + id: GoogleCloudAiplatformV1ListBatchPredictionJobsResponse type: object + description: Response message for JobService.ListBatchPredictionJobs properties: - artifactOutputUri: - readOnly: true - type: string + nextPageToken: description: >- - Output only. If the Model artifact is being exported to Google Cloud - Storage this is the full path of the directory created, into which - the Model files are being written to. - imageOutputUri: + A token to retrieve the next page of results. Pass to + ListBatchPredictionJobsRequest.page_token to obtain that page. + type: string + batchPredictionJobs: + description: List of BatchPredictionJobs in the requested page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance: + properties: + mimeType: + type: string description: >- - Output only. If the Model image is being exported to Google - Container Registry or Artifact Registry this is the full path of the - image created. + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/gif - + image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + content: type: string - readOnly: true - id: GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo - description: >- - Further describes the output of the ExportModel. Supplements - ExportModelRequest.OutputConfig. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs: + description: The image bytes or Cloud Storage URI to make the prediction on. + description: Prediction input format for Image Object Detection. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance type: object - properties: {} - CloudAiLargeModelsVisionGenerateVideoResponse: - id: CloudAiLargeModelsVisionGenerateVideoResponse - description: Generate video response. + GoogleCloudAiplatformV1WriteFeatureValuesRequest: type: object + description: Request message for FeaturestoreOnlineServingService.WriteFeatureValues. properties: - raiMediaFilteredCount: - format: int32 - description: Returns if any videos were filtered due to RAI policies. - type: integer - generatedSamples: - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' - description: The generates samples. + payloads: + description: >- + Required. The entities to be written. Up to 100,000 feature values + can be written across all `payloads`. type: array - raiMediaFilteredReasons: - description: Returns rai failure reasons if any. items: - type: string - type: array - GoogleCloudAiplatformV1ImportFeatureValuesRequest: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesPayload + id: GoogleCloudAiplatformV1WriteFeatureValuesRequest + CloudAiLargeModelsVisionImageRAIScores: + description: RAI scores for generated image returned. + id: CloudAiLargeModelsVisionImageRAIScores + properties: + agileWatermarkDetectionScore: + description: Agile watermark score for image. + type: number + format: double type: object - description: Request message for FeaturestoreService.ImportFeatureValues. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation properties: - bigquerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - disableOnlineServing: - type: boolean - description: >- - If set, data will not be imported for online serving. This is - typically used for backfilling, where Feature generation timestamps - are not in the timestamp range needed for online serving. - featureTimeField: + columnName: type: string + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + type: object + GoogleCloudAiplatformV1SchemaVideoDataItem: + description: Payload of Video DataItem. + properties: + mimeType: + readOnly: true description: >- - Source column that holds the Feature timestamp for all Feature - values in each entity. - entityIdField: + Output only. The mime type of the content of the video. Only the + videos in below listed mime types are supported. Supported + mime_type: - video/mp4 - video/avi - video/quicktime type: string + gcsUri: description: >- - Source column that holds entity IDs. If not provided, entity IDs are - extracted from the column named entity_id. - disableIngestionAnalysis: - description: If true, API doesn't start ingestion analysis pipeline. - type: boolean - featureTime: - format: google-datetime + Required. Google Cloud Storage URI points to the original video in + user's bucket. The video is up to 50 GB in size and up to 3 hour in + duration. type: string - description: >- - Single Feature timestamp for all entities being imported. The - timestamp must not have higher than millisecond precision. - workerCount: - format: int32 - description: >- - Specifies the number of workers that are used to write data to the - Featurestore. Consider the online serving capacity that you require - to achieve the desired import throughput without interfering with - online serving. The value must be positive, and less than or equal - to 100. If not set, defaults to using 1 worker. The low count - ensures minimal impact on online serving performance. - type: integer - csvSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - avroSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AvroSource' - featureSpecs: - description: >- - Required. Specifications defining which Feature values to import - from the entity. The request fails if no feature_specs are provided, - and having multiple feature_specs for one Feature is not allowed. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec - type: array - id: GoogleCloudAiplatformV1ImportFeatureValuesRequest - GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata: - id: GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata - description: Runtime operation information for ModelService.UpdateExplanationDataset. + id: GoogleCloudAiplatformV1SchemaVideoDataItem type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation - type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation properties: - repeatedCategorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation numeric: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation - repeatedNumeric: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + text: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation timestamp: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation categorical: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation - repeatedText: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation - GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata: - description: >- - Runtime operation information for - IndexEndpointService.MutateDeployedIndex. - id: GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata - properties: - deployedIndexId: - description: The unique index id specified by user - type: string - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - type: object - GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse: - description: Response message for TensorboardService.WriteTensorboardExperimentData. - properties: {} + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation type: object - id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec: + GoogleCloudAiplatformV1CancelBatchPredictionJobRequest: type: object - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec + id: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest + properties: {} + description: Request message for JobService.CancelBatchPredictionJob. + GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult: + description: Prediction output format for Video Classification. properties: - maxParallelTrialCount: - type: integer - format: int32 - description: Required. The maximum number of trials to run in parallel. - maxTrialCount: - format: int32 + confidence: + type: number + format: float description: >- - Required. The maximum number of Neural Architecture Search (NAS) - trials to run. - type: integer - maxFailedTrialCount: - format: int32 - type: integer + The Model's confidence in correction of this prediction, higher + value means higher confidence. + displayName: + type: string + description: The display name of the AnnotationSpec that had been identified. + timeSegmentEnd: description: >- - The number of failed trials that need to be seen before failing the - NasJob. If set to 0, Vertex AI decides how many trials must fail - before the whole job fails. - searchTrialJobSpec: + The end, exclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. Note that + for 'segment-classification' prediction type, this equals the + original 'timeSegmentEnd' from the input instance, for other types + it is the end of a shot or a 1 second interval respectively. + format: google-duration + type: string + type: + type: string description: >- - Required. The spec of a search trial job. The same spec applies to - all search trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: Represent spec for search trials. - GoogleCloudAiplatformV1TFRecordDestination: + The type of the prediction. The requested types can be configured + via parameters. This will be one of - segment-classification - + shot-classification - one-sec-interval-classification + timeSegmentStart: + description: >- + The beginning, inclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. Note that + for 'segment-classification' prediction type, this equals the + original 'timeSegmentStart' from the input instance, for other types + it is the start of a shot or a 1 second interval respectively. + format: google-duration + type: string + id: + description: The resource ID of the AnnotationSpec that had been identified. + type: string + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult type: object - id: GoogleCloudAiplatformV1TFRecordDestination - description: The storage details for TFRecord output content. + GoogleCloudAiplatformV1ModelGardenSource: properties: - gcsDestination: - description: Required. Google Cloud Storage location. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - GoogleCloudAiplatformV1PythonPackageSpec: + publicModelName: + type: string + description: Required. The model garden source model resource name. + id: GoogleCloudAiplatformV1ModelGardenSource type: object + description: >- + Contains information about the source of the models generated from Model + Garden. + GoogleCloudAiplatformV1SearchDataItemsResponse: + description: Response message for DatasetService.SearchDataItems. properties: - args: - items: - type: string - type: array - description: Command line arguments to be passed to the Python task. - pythonModule: - type: string - description: >- - Required. The Python module name to run after installing the - packages. - env: + nextPageToken: description: >- - Environment variables to be passed to the python module. Maximum - limit is 100. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' - type: array - executorImageUri: + A token to retrieve next page of results. Pass to + SearchDataItemsRequest.page_token to obtain that page. type: string - description: >- - Required. The URI of a container image in Artifact Registry that - will run the provided Python package. Vertex AI provides a wide - range of executor images with pre-installed packages to meet users' - various use cases. See the list of [pre-built containers for - training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). - You must use an image from this list. - packageUris: - description: >- - Required. The Google Cloud Storage location of the Python package - files which are the training program and its dependent packages. The - maximum number of package URIs is 100. + dataItemViews: type: array + description: The DataItemViews read. items: - type: string - description: The spec of a Python packaged code. - id: GoogleCloudAiplatformV1PythonPackageSpec - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata: - description: The metadata of Datasets that contain time series data. - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItemView' + id: GoogleCloudAiplatformV1SearchDataItemsResponse + type: object + GoogleCloudAiplatformV1PublisherModelCallToAction: properties: - timeSeriesIdentifierColumn: - type: string - description: >- - The column name of the time series identifier column that identifies - the time series. - timeColumn: + openGenerationAiStudio: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open in Generation AI Studio. + viewRestApi: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi + description: Optional. To view Rest API docs. + createApplication: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Create application using the PublisherModel. + deployGke: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke + description: Optional. Deploy PublisherModel to Google Kubernetes Engine. + openFineTuningPipelines: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines + description: Optional. Open fine-tuning pipelines of the PublisherModel. + openNotebook: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open notebook of the PublisherModel. + openGenie: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open Genie / Playground. + openEvaluationPipeline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open evaluation pipeline of the PublisherModel. + multiDeployVertex: description: >- - The column name of the time column that identifies time order in the - time series. - type: string - inputConfig: + Optional. Multiple setups to deploy the PublisherModel to Vertex + Endpoint. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex + openNotebooks: + description: Optional. Open notebooks of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks + requestAccess: + description: Optional. Request for access. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + deploy: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + description: Optional. Deploy the PublisherModel to Vertex Endpoint. + openPromptTuningPipeline: + description: Optional. Open prompt-tuning pipeline of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + openFineTuningPipeline: + description: Optional. Open fine-tuning pipeline of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + type: object + id: GoogleCloudAiplatformV1PublisherModelCallToAction + description: Actions could take on this Publisher Model. + CloudAiLargeModelsVisionSemanticFilterResponse: + id: CloudAiLargeModelsVisionSemanticFilterResponse type: object - GoogleCloudAiplatformV1ToolCallValidResults: - description: Results for tool call valid metric. - id: GoogleCloudAiplatformV1ToolCallValidResults properties: - toolCallValidMetricValues: - description: Output only. Tool call valid metric values. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolCallValidMetricValue - readOnly: true + passedSemanticFilter: + type: boolean + description: >- + This response is added when semantic filter config is turned on in + EditConfig. It reports if this image is passed semantic filter + response. If passed_semantic_filter is false, the bounding box + information will be populated for user to check what caused the + semantic filter to fail. + namedBoundingBoxes: type: array - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics: - description: Metrics for classification evaluation results. - type: object + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' + description: >- + Class labels of the bounding boxes that failed the semantic + filtering. Bounding box coordinates. + GoogleCloudAiplatformV1Feature: + id: GoogleCloudAiplatformV1Feature properties: - auRoc: - format: float + updateTime: + format: google-datetime + type: string description: >- - The Area Under Receiver Operating Characteristic curve metric. - Micro-averaged for the overall evaluation. - type: number - confusionMatrix: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: Confusion matrix of the evaluation. - auPrc: - type: number - format: float + Output only. Only applicable for Vertex AI Feature Store (Legacy). + Timestamp when this EntityType was most recently updated. + readOnly: true + createTime: + format: google-datetime description: >- - The Area Under Precision-Recall Curve metric. Micro-averaged for the - overall evaluation. - logLoss: - description: The Log Loss metric. - format: float - type: number - confidenceMetrics: - type: array + Output only. Only applicable for Vertex AI Feature Store (Legacy). + Timestamp when this EntityType was created. + readOnly: true + type: string + monitoringStatsAnomalies: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + #/components/schemas/GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + readOnly: true description: >- - Metrics for each `confidenceThreshold` in - 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and `positionThreshold` - = INT32_MAX_VALUE. ROC and precision-recall curves, and other - aggregated metrics are derived from them. The confidence metrics - entries may also be supplied for additional values of - `positionThreshold`, but from these no aggregated metrics are - computed. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - description: >- - A wrapper class which contains the tunable parameters in an AutoML Image - training job. - properties: - trainerType: + Output only. Only applicable for Vertex AI Feature Store (Legacy). + The list of historical stats and anomalies with specified + objectives. + type: array + versionColumnName: type: string - enum: - - TRAINER_TYPE_UNSPECIFIED - - AUTOML_TRAINER - - MODEL_GARDEN_TRAINER - enumDescriptions: - - Default value. - - '' - - '' - trainerConfig: + description: >- + Only applicable for Vertex AI Feature Store. The name of the + BigQuery Table/View column hosting data for this version. If no + value is provided, will use feature_id. + labels: additionalProperties: type: string - description: Customizable trainer settings, used in the `model_garden_trainer`. type: object - checkpointName: + description: >- + Optional. The labels with user-defined metadata to organize your + Features. Label keys and values can be no longer than 64 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are + allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one Feature (System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + etag: type: string description: >- - Optional. An unique name of pretrained model checkpoint provided in - model garden, it will be mapped to a GCS location internally. - datasetConfig: - type: object - description: Customizable dataset settings, used in the `model_garden_trainer`. - additionalProperties: - type: string - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + name: description: >- - Optioinal. StudySpec of hyperparameter tuning job. Required for - `model_garden_trainer`. - type: object - GoogleCloudAiplatformV1QuestionAnsweringQualityResult: - properties: - confidence: - type: number - description: Output only. Confidence for question answering quality score. - format: float - readOnly: true - explanation: + 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. type: string - description: Output only. Explanation for question answering quality score. - readOnly: true - score: - description: Output only. Question Answering Quality score. - readOnly: true - format: float - type: number - type: object - id: GoogleCloudAiplatformV1QuestionAnsweringQualityResult - description: Spec for question answering quality result. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics: - type: object - properties: - rougeLSum: - description: ROUGE-L (Longest Common Subsequence) scoring at summary level. - type: number - format: float - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics - GoogleTypeMoney: - description: Represents an amount of money with its currency type. - properties: - units: + valueType: + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - BOOL_ARRAY + - DOUBLE + - DOUBLE_ARRAY + - INT64 + - INT64_ARRAY + - STRING + - STRING_ARRAY + - BYTES + - STRUCT + enumDescriptions: + - The value type is unspecified. + - Used for Feature that is a boolean. + - Used for Feature that is a list of boolean. + - Used for Feature that is double. + - Used for Feature that is a list of double. + - Used for Feature that is INT64. + - Used for Feature that is a list of INT64. + - Used for Feature that is string. + - Used for Feature that is a list of String. + - Used for Feature that is bytes. + - Used for Feature that is struct. description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + Immutable. Only applicable for Vertex AI Feature Store (Legacy). + Type of Feature value. type: string - format: int64 - nanos: + disableMonitoring: + type: boolean description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - format: int32 - type: integer - currencyCode: - description: The three-letter currency code defined in ISO 4217. + Optional. Only applicable for Vertex AI Feature Store (Legacy). If + not set, use the monitoring_config defined for the EntityType this + Feature belongs to. Only Features with type (Feature.ValueType) + BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, + all types of data monitoring are disabled despite the config on + EntityType. + description: + description: Description of the Feature. + type: string + pointOfContact: type: string + description: >- + Entity responsible for maintaining this feature. Can be comma + separated list of email addresses or URIs. type: object - id: GoogleTypeMoney - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef: + description: >- + Feature Metadata information. For example, color is a feature that + describes an apple. + GoogleCloudAiplatformV1ToolConfig: + description: >- + Tool config. This config is shared for all tools provided in the + request. properties: - id: - type: string - description: ID of the AnnotationSpec. - displayName: - description: Display name of the AnnotationSpec. - type: string + functionCallingConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' + description: Optional. Function calling config. type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity: - description: A duration of time expressed in time granularity units. + id: GoogleCloudAiplatformV1ToolConfig + GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: + description: Content filter results for a prompt sent in the request. + id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback properties: - quantity: - format: int64 - description: >- - The number of granularity_units between data points in the training - data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. - For all other values of `granularity_unit`, must be 1. + blockReasonMessage: + readOnly: true type: string - unit: - description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" + description: Output only. A readable block reason message. + safetyRatings: + description: Output only. Safety ratings. + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' + blockReason: type: string + enumDescriptions: + - Unspecified blocked reason. + - Candidates blocked due to safety. + - Candidates blocked due to other reason. + - >- + Candidates blocked due to the terms which are included from the + terminology blocklist. + - Candidates blocked due to prohibited content. + enum: + - BLOCKED_REASON_UNSPECIFIED + - SAFETY + - OTHER + - BLOCKLIST + - PROHIBITED_CONTENT + description: Output only. Blocked reason. + readOnly: true type: object + GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult: + description: Prediction output format for Image and Text Classification. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity - GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex: - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex + GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult type: object - description: Multiple setups to deploy the PublisherModel. properties: - multiDeployVertex: - description: Optional. One click deployment configurations. + confidences: + description: >- + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy - type: array - GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse: - id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse - properties: {} - description: Response message for MetadataService.AddContextArtifactsAndExecutions. + format: float + type: number + type: array + ids: + type: array + items: + type: string + format: int64 + description: The resource IDs of the AnnotationSpecs that had been identified. + displayNames: + items: + type: string + description: >- + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. + type: array + GoogleCloudAiplatformV1StreamingPredictResponse: + id: GoogleCloudAiplatformV1StreamingPredictResponse + properties: + outputs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: array + description: The prediction output. + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. type: object - GoogleCloudAiplatformV1Dataset: - description: A collection of DataItems and Annotations on them. + description: Response message for PredictionService.StreamingPredict. + GoogleCloudAiplatformV1PrivateEndpoints: + description: >- + PrivateEndpoints proto is used to provide paths for users to send + requests privately. To send request via private service access, use + predict_http_uri, explain_http_uri or health_http_uri. To send request + via private service connect, use service_attachment. properties: - metadataSchemaUri: - description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Dataset. The schema is - defined as an OpenAPI 3.0.2 Schema Object. The schema files that can - be used here are found in - gs://google-cloud-aiplatform/schema/dataset/metadata/. + explainHttpUri: type: string - updateTime: + description: Output only. Http(s) path to send explain requests. readOnly: true - description: Output only. Timestamp when this Dataset was last updated. + healthHttpUri: type: string - format: google-datetime - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean readOnly: true - metadataArtifact: + description: Output only. Http(s) path to send health check requests. + serviceAttachment: type: string readOnly: true description: >- - Output only. The resource name of the Artifact that was created in - MetadataStore when creating the Dataset. The Artifact resource name - pattern is - `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. - description: - description: The description of the Dataset. + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. + predictHttpUri: + description: Output only. Http(s) path to send prediction requests. type: string - createTime: readOnly: true + type: object + id: GoogleCloudAiplatformV1PrivateEndpoints + GoogleCloudAiplatformV1SamplingStrategy: + description: >- + Sampling Strategy for logging, can be for both training and prediction + dataset. + properties: + randomSampleConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig + description: Random sample config. Will support more sampling strategies later. + type: object + id: GoogleCloudAiplatformV1SamplingStrategy + GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig: + description: Configuration options for using brute force search. + type: object + properties: {} + id: GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig + GoogleCloudAiplatformV1Value: + type: object + id: GoogleCloudAiplatformV1Value + description: Value is the value of the field. + properties: + stringValue: type: string - description: Output only. Timestamp when this Dataset was created. - format: google-datetime - satisfiesPzs: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - metadata: - type: any - description: Required. Additional information about the Dataset. - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + description: A string value. + intValue: type: string - displayName: + description: An integer value. + format: int64 + doubleValue: + description: A double value. + format: double + type: number + GoogleCloudAiplatformV1ActiveLearningConfig: + type: object + 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 + properties: + maxDataItemCount: + format: int64 + description: Max number of human labeled DataItems. type: string + maxDataItemPercentage: + description: Max percent of total DataItems for human labeling. + format: int32 + type: integer + sampleConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' description: >- - Required. The user-defined name of the Dataset. The name can be up - to 128 characters long and can consist of any UTF-8 characters. - dataItemCount: - readOnly: true + Active learning data sampling config. For every active learning + labeling iteration, it will select a batch of data based on the + sampling strategy. + trainingConfig: description: >- - Output only. The number of DataItems in this Dataset. Only apply for - non-structured Dataset. + CMLE training config. For every active learning labeling iteration, + system will train a machine learning model on CMLE. The trained + model will be used by data sampling algorithm to select DataItems. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' + GoogleCloudAiplatformV1Index: + id: GoogleCloudAiplatformV1Index + type: object + description: >- + A representation of a collection of database items organized in a way + that allows for approximate nearest neighbor (a.k.a ANN) algorithms + search. + properties: + metadataSchemaUri: type: string - format: int64 - name: + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Index, that is specific + to it. Unset if the Index does not have any additional information. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + Note: The URI given on output will be immutable and probably + different, including the URI scheme, than the one given on input. + The output URI will point to a location where the user only has a + read access. + displayName: + description: >- + Required. The display name of the Index. The name can be up to 128 + characters long and can consist of any UTF-8 characters. type: string - description: Output only. Identifier. The resource name of the Dataset. + etag: + type: string + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + metadata: + type: any + description: >- + An additional information about the Index; the schema of the + metadata can be found in metadata_schema. + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean readOnly: true labels: - type: object description: >- - The labels with user-defined metadata to organize your Datasets. + The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Dataset (System - labels are excluded). See https://goo.gl/xmQnxf for more information - and examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for each Dataset: * - "aiplatform.googleapis.com/dataset_metadata_schema": output only, - its value is the metadata_schema's title. + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object additionalProperties: type: string - modelReference: - type: string - description: >- - Optional. Reference to the public base model last used by the - dataset. Only set for prompt datasets. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Customer-managed encryption key spec for a Dataset. If set, this - Dataset and all sub-resources of this Dataset will be secured by - this key. - savedQueries: + deployedIndexes: description: >- - All SavedQueries belong to the Dataset will be returned in List/Get - Dataset response. The annotation_specs field will not be populated - except for UI cases which will only use annotation_spec_count. In - CreateDataset request, a SavedQuery is created together if this - field is set, up to one SavedQuery can be set in - CreateDatasetRequest. The SavedQuery should not contain any - AnnotationSpec. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + Output only. The pointers to DeployedIndexes created from this + Index. An Index can be only deleted if all its DeployedIndexes had + been undeployed first. type: array - id: GoogleCloudAiplatformV1Dataset - type: object - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest: - type: object - properties: - featureDisplayName: - description: >- - The feature display name. If specified, only return the stats - belonging to this feature. Format: - ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, - example: "user_destination". - type: string - objectives: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective - description: Required. Objectives of the stats to retrieve. - type: array - pageToken: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' + readOnly: true + indexUpdateMethod: + enum: + - INDEX_UPDATE_METHOD_UNSPECIFIED + - BATCH_UPDATE + - STREAM_UPDATE type: string description: >- - A page token received from a previous - JobService.SearchModelDeploymentMonitoringStatsAnomalies call. - deployedModelId: + Immutable. The update method to use with this Index. If not set, + BATCH_UPDATE will be used by default. + enumDescriptions: + - Should not be used. + - >- + BatchUpdate: user can call UpdateIndex with files on Cloud Storage + of Datapoints to update. + - >- + StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to + update the Index and the updates will be applied in corresponding + DeployedIndexes in nearly real-time. + updateTime: + format: google-datetime description: >- - Required. The DeployedModel ID of the - [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. - type: string - endTime: + Output only. Timestamp when this Index was most recently updated. + This also includes any update to the contents of the Index. Note + that Operations working on this Index may have their + Operations.metadata.generic_metadata.update_time a little after the + value of this timestamp, yet that does not mean their results are + not already reflected in the Index. Result of any successfully + completed Operation on the Index is reflected in it. type: string + readOnly: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - The latest timestamp of stats being generated. If not set, indicates - feching stats till the latest possible one. - format: google-datetime - startTime: - description: >- - The earliest timestamp of stats being generated. If not set, - indicates fetching stats till the earliest possible one. + Immutable. Customer-managed encryption key spec for an Index. If + set, this Index and all sub-resources of this Index will be secured + by this key. + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + name: + description: Output only. The resource name of the Index. + readOnly: true + type: string + description: + type: string + description: The description of the Index. + indexStats: + description: Output only. Stats of the index resource. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' + createTime: format: google-datetime type: string - pageSize: - description: The standard list page size. - format: int32 - type: integer - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest - description: >- - Request message for - JobService.SearchModelDeploymentMonitoringStatsAnomalies. - GoogleCloudAiplatformV1PurgeExecutionsResponse: - description: Response message for MetadataService.PurgeExecutions. - id: GoogleCloudAiplatformV1PurgeExecutionsResponse + readOnly: true + description: Output only. Timestamp when this Index was created. + GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest: + type: object + id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest + description: Request message for ModelService.BatchImportModelEvaluationSlices properties: - purgeCount: - description: >- - The number of Executions that this request deleted (or, if `force` - is false, the number of Executions that will be deleted). This can - be an estimate. - type: string - format: int64 - purgeSample: - description: >- - A sample of the Execution names that will be deleted. Only populated - if `force` is set to false. The maximum number of samples is 100 (it - is possible to return fewer). - type: array + modelEvaluationSlices: items: - type: string - type: object - GoogleCloudAiplatformV1Content: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + type: array + description: Required. Model evaluation slice resource to be imported. + GoogleCloudAiplatformV1ToolNameMatchInput: type: object - description: >- - The base structured datatype containing multi-part content of a message. - A `Content` includes a `role` field designating the producer of the - `Content` and a `parts` field containing multi-part data that contains - the content of the message turn. - id: GoogleCloudAiplatformV1Content properties: - role: - type: string - description: >- - Optional. The producer of the content. Must be either 'user' or - 'model'. Useful to set for multi-turn conversations, otherwise can - be left blank or unset. - parts: + instances: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' - description: >- - Required. Ordered `Parts` that constitute a single message. Parts - may have different IANA MIME types. - GoogleCloudAiplatformV1FeatureGroup: - id: GoogleCloudAiplatformV1FeatureGroup - description: Vertex AI Feature Group. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInstance' + description: Required. Repeated tool name match instances. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchSpec' + description: Required. Spec for tool name match metric. + id: GoogleCloudAiplatformV1ToolNameMatchInput + description: Input for tool name match metric. + GoogleCloudAiplatformV1TensorboardBlob: properties: - bigQuery: - description: >- - Indicates that features for this group come from BigQuery - Table/View. By default treats the source as a sparse time series - source. The BigQuery source table or view must have at least one - entity ID column and a column named `feature_timestamp`. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQuery' - updateTime: - type: string - readOnly: true - format: google-datetime - description: Output only. Timestamp when this FeatureGroup was last updated. - name: + data: type: string + format: byte description: >- - Identifier. Name of the FeatureGroup. Format: - `projects/{project}/locations/{location}/featureGroups/{featureGroup}` - description: - description: Optional. Description of the FeatureGroup. + Optional. The bytes of the blob is not present unless it's returned + by the ReadTensorboardBlobData endpoint. + id: type: string - labels: description: >- - Optional. The labels with user-defined metadata to organize your - FeatureGroup. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one FeatureGroup(System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - additionalProperties: - type: string - type: object - createTime: - description: Output only. Timestamp when this FeatureGroup was created. + Output only. A URI safe key uniquely identifying a blob. Can be used + to locate the blob stored in the Cloud Storage bucket of the + consumer project. readOnly: true - format: google-datetime - type: string - etag: - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - type: string - type: object - GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata: + id: GoogleCloudAiplatformV1TensorboardBlob + description: One blob (e.g, image, graph) viewable on a blob metric plot. type: object - id: GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata - description: Details of operations that delete Feature values. - properties: - genericMetadata: - description: Operation metadata for Featurestore delete Features values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1RawPredictRequest: + GoogleCloudAiplatformV1NearestNeighborQueryEmbedding: + description: The embedding vector. type: object properties: - httpBody: - $ref: '#/components/schemas/GoogleApiHttpBody' - description: >- - The prediction input. Supports HTTP headers and arbitrary data - payload. A DeployedModel may have an upper limit on the number of - instances it supports per request. When this limit it is exceeded - for an AutoML model, the RawPredict method returns an error. When - this limit is exceeded for a custom-trained model, the behavior - varies depending on the model. You can specify the schema for each - instance in the predict_schemata.instance_schema_uri field when you - create a Model. This schema applies when you deploy the `Model` as a - `DeployedModel` to an Endpoint and use the `RawPredict` method. - id: GoogleCloudAiplatformV1RawPredictRequest - description: Request message for PredictionService.RawPredict. - GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance: + value: + description: Optional. Individual value in the embedding. + type: array + items: + format: float + type: number + id: GoogleCloudAiplatformV1NearestNeighborQueryEmbedding + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction: + description: A TrainingJob that trains and uploads an AutoML Text Extraction Model. properties: - content: - type: string - description: The image bytes or Cloud Storage URI to make the prediction on. - mimeType: - type: string - description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/gif - - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon - description: Prediction input format for Image Object Detection. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction type: object - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis: - id: >- - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis - description: >- - Configuration of the Featurestore's ImportFeature Analysis Based - Monitoring. This type of analysis generates statistics for values of - each Feature imported by every ImportFeatureValues operation. + GoogleLongrunningOperation: type: object properties: - anomalyDetectionBaseline: + name: type: string - enum: - - BASELINE_UNSPECIFIED - - LATEST_STATS - - MOST_RECENT_SNAPSHOT_STATS - - PREVIOUS_IMPORT_FEATURES_STATS - enumDescriptions: - - Should not be used. - - >- - Choose the later one statistics generated by either most recent - snapshot analysis or previous import features analysis. If non of - them exists, skip anomaly detection and only generate a - statistics. - - >- - Use the statistics generated by the most recent snapshot analysis - if exists. - - >- - Use the statistics generated by the previous import features - analysis if exists. - description: >- - The baseline used to do anomaly detection for the statistics - generated by import features analysis. - state: description: >- - Whether to enable / disable / inherite default hebavior for import - features analysis. - enumDescriptions: - - Should not be used. - - >- - The default behavior of whether to enable the monitoring. - EntityType-level config: disabled. Feature-level config: inherited - from the configuration of EntityType this Feature belongs to. - - >- - Explicitly enables import features analysis. EntityType-level - config: by default enables import features analysis for all - Features under it. Feature-level config: enables import features - analysis regardless of the EntityType-level config. - - >- - Explicitly disables import features analysis. EntityType-level - config: by default disables import features analysis for all - Features under it. Feature-level config: disables import features - analysis regardless of the EntityType-level config. - type: string - enum: - - STATE_UNSPECIFIED - - DEFAULT - - ENABLED - - DISABLED - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair: - id: >- - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair - description: Feature name & value pair. - properties: - name: - description: Feature short name. - type: string - value: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: Feature value. - type: object - GoogleCloudAiplatformV1SchemaTablesDatasetMetadata: - description: The metadata of Datasets that contain tables data. + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + metadata: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics: type: object - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadata + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics properties: - inputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig - GoogleCloudAiplatformV1ListFeaturestoresResponse: + recall: + format: float + description: Recall (True Positive Rate) for the given confidence threshold. + type: number + confidenceThreshold: + description: >- + Metrics are computed with an assumption that the Model never returns + predictions with score lower than this value. + type: number + format: float + precision: + description: Precision for the given confidence threshold. + format: float + type: number + f1Score: + description: The harmonic mean of recall and precision. + type: number + format: float + GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig: properties: - nextPageToken: + datasetDisplayName: + description: >- + Required. Display name of the Dataset in Vertex AI. System will pick + a display name if unspecified. type: string + dataset: description: >- - A token, which can be sent as ListFeaturestoresRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - featurestores: - description: The Featurestores matching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' - type: array - id: GoogleCloudAiplatformV1ListFeaturestoresResponse + Required. Full resource name of automl Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}`. + type: string + description: >- + Config for migrating Dataset in automl.googleapis.com to Vertex AI's + Dataset. + id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig type: object - description: Response message for FeaturestoreService.ListFeaturestores. - GoogleCloudAiplatformV1ListNotebookRuntimesResponse: - description: Response message for NotebookService.ListNotebookRuntimes. + GoogleCloudAiplatformV1TensorboardBlobSequence: properties: - notebookRuntimes: + values: + description: List of blobs contained within the sequence. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' - description: List of NotebookRuntimes in the requested page. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' type: array + type: object + id: GoogleCloudAiplatformV1TensorboardBlobSequence + description: >- + One point viewable on a blob metric plot, but mostly just a wrapper + message to work around repeated fields can't be used directly within + `oneof` fields. + GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse: + description: Response message for [NotebookService.CreateNotebookExecutionJob] + properties: nextPageToken: description: >- A token to retrieve next page of results. Pass to - ListNotebookRuntimesRequest.page_token to obtain that page. + ListNotebookExecutionJobs.page_token to obtain that page. type: string + notebookExecutionJobs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + type: array + description: List of NotebookExecutionJobs in the requested page. + id: GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse type: object - id: GoogleCloudAiplatformV1ListNotebookRuntimesResponse - GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: + GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest: + id: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + description: Request message for JobService.CancelHyperparameterTuningJob. type: object - id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Runtime operation information for DatasetService.RestoreDatasetVersion. - GoogleCloudAiplatformV1FulfillmentInstance: - id: GoogleCloudAiplatformV1FulfillmentInstance - description: Spec for fulfillment instance. + properties: {} + GoogleCloudAiplatformV1Artifact: type: object + description: Instance of a general artifact. properties: - instruction: - description: Required. Inference instruction prompt to compare prediction with. - type: string - prediction: - description: Required. Output of the evaluated model. - type: string - GoogleCloudAiplatformV1DataLabelingJob: - description: >- - DataLabelingJob is used to trigger a human labeling job on unlabeled - data from the following Dataset: - properties: - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. Timestamp when this DataLabelingJob was created. - displayName: - description: >- - Required. The user-defined name of the DataLabelingJob. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. Display name of a DataLabelingJob. - type: string - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + metadata: + type: object description: >- - Customer-managed encryption key spec for a DataLabelingJob. If set, - this DataLabelingJob will be secured by this key. Note: Annotations - created in the DataLabelingJob are associated with the - EncryptionSpec of the Dataset they are exported to. - labelerCount: - type: integer - format: int32 - description: Required. Number of labelers to work on each DataItem. - annotationLabels: + Properties of the Artifact. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + additionalProperties: + type: any + description: Properties of the object. + labels: additionalProperties: type: string type: object description: >- - Labels to assign to annotations generated by this DataLabelingJob. + The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - updateTime: + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Artifact (System + labels are excluded). + displayName: description: >- - Output only. Timestamp when this DataLabelingJob was updated most - recently. - format: google-datetime - readOnly: true + User provided display name of the Artifact. May be up to 128 Unicode + characters. type: string - inputsSchemaUri: + etag: type: string description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing the config for a specific type of DataLabelingJob. The - schema files that can be used here are found in the - https://storage.googleapis.com/google-cloud-aiplatform bucket in the - /schema/datalabelingjob/inputs/ folder. - inputs: - type: any - description: Required. Input config parameters for the DataLabelingJob. - datasets: - type: array - items: - type: string + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. Timestamp when this Artifact was created. + schemaVersion: description: >- - Required. Dataset resource names. Right now we only support labeling - from a single Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}` - labels: - type: object - additionalProperties: - type: string + The version of the schema in schema_name to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + type: string + uri: + type: string description: >- - The labels with user-defined metadata to organize your - DataLabelingJobs. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for each DataLabelingJob: * - "aiplatform.googleapis.com/schema": output only, its value is the - inputs_schema's title. + The uniform resource identifier of the artifact file. May be empty + if there is no actual artifact file. name: type: string readOnly: true - description: Output only. Resource name of the DataLabelingJob. + description: Output only. The resource name of the Artifact. state: + enum: + - STATE_UNSPECIFIED + - PENDING + - LIVE type: string enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. + - Unspecified state for the Artifact. - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. + A state used by systems like Vertex AI Pipelines to indicate that + the underlying data item represented by this Artifact is being + created. - >- - The job is partially succeeded, some results may be missing due to - errors. - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - description: Output only. The detailed state of the job. - readOnly: true - currentSpend: - readOnly: true - description: >- - Output only. Estimated cost(in US dollars) that the DataLabelingJob - has incurred to date. - $ref: '#/components/schemas/GoogleTypeMoney' - activeLearningConfig: + A state indicating that the Artifact should exist, unless + something external to the system deletes it. description: >- - Parameters that configure the active learning pipeline. Active - learning will label the data incrementally via several iterations. - For every iteration, it will select a batch of data based on the - sampling strategy. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' - labelingProgress: + The state of this Artifact. This is a property of the Artifact, and + does not imply or capture any ongoing process. This property is + managed by clients (such as Vertex AI Pipelines), and the system + does not prescribe or check the validity of state transitions. + updateTime: readOnly: true - description: >- - Output only. Current labeling job progress percentage scaled in - interval [0, 100], indicating the percentage of DataItems that has - been finished. - type: integer - format: int32 - instructionUri: - description: >- - Required. The Google Cloud Storage location of the instruction pdf. - This pdf is shared with labelers, and provides detailed description - on how to label DataItems in Datasets. + format: google-datetime + description: Output only. Timestamp when this Artifact was last updated. + type: string + description: + type: string + description: Description of the Artifact + schemaTitle: type: string - specialistPools: - description: The SpecialistPools' resource names associated with this job. - type: array - items: - type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true description: >- - Output only. DataLabelingJob errors. It is only populated when job's - state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + id: GoogleCloudAiplatformV1Artifact + GoogleCloudAiplatformV1ComputeTokensResponse: + id: GoogleCloudAiplatformV1ComputeTokensResponse type: object - id: GoogleCloudAiplatformV1DataLabelingJob + description: Response message for ComputeTokens RPC call. + properties: + tokensInfo: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TokensInfo' + type: array + description: >- + Lists of tokens info from the input. A ComputeTokensRequest could + have multiple instances with a prompt in each instance. We also need + to return lists of tokens info for the request with multiple + instances. GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation: type: object id: >- GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the * timestamp - as a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. properties: - columnName: - type: string invalidValuesAllowed: type: boolean description: >- @@ -17842,6 +15784,8 @@ components: boolean feature that indicated whether the value is valid. Otherwise, the training pipeline will discard the input row from trainining data. + columnName: + type: string timeFormat: description: >- The format in which that time field is expressed. The time_format @@ -17852,472 +15796,198 @@ components: is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) type: string - GoogleCloudAiplatformV1PairwiseMetricResult: - description: Spec for pairwise metric result. - properties: - pairwiseChoice: - enum: - - PAIRWISE_CHOICE_UNSPECIFIED - - BASELINE - - CANDIDATE - - TIE - enumDescriptions: - - Unspecified prediction choice. - - Baseline prediction wins - - Candidate prediction wins - - Winner cannot be determined - readOnly: true - type: string - description: Output only. Pairwise metric choice. - explanation: - description: Output only. Explanation for pairwise metric score. - type: string - readOnly: true - id: GoogleCloudAiplatformV1PairwiseMetricResult - type: object - GoogleCloudAiplatformV1SupervisedHyperParameters: - description: Hyperparameters for SFT. - id: GoogleCloudAiplatformV1SupervisedHyperParameters + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the * timestamp + as a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig: type: object properties: - adapterSize: - enum: - - ADAPTER_SIZE_UNSPECIFIED - - ADAPTER_SIZE_ONE - - ADAPTER_SIZE_FOUR - - ADAPTER_SIZE_EIGHT - - ADAPTER_SIZE_SIXTEEN - - ADAPTER_SIZE_THIRTY_TWO - type: string - enumDescriptions: - - Adapter size is unspecified. - - Adapter size 1. - - Adapter size 4. - - Adapter size 8. - - Adapter size 16. - - Adapter size 32. - description: Optional. Adapter size for tuning. - learningRateMultiplier: - description: Optional. Multiplier for adjusting the default learning rate. - type: number - format: double - epochCount: - type: string - description: >- - Optional. Number of complete passes the model makes over the entire - training dataset during training. - format: int64 - GoogleCloudAiplatformV1ListFeaturesResponse: + bigquerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource description: >- - Response message for FeaturestoreService.ListFeatures. Response message - for FeatureRegistryService.ListFeatures. + The time series Dataset's data source. The Dataset doesn't store the + data directly, but only pointer(s) to its data. + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics: + description: The Evaluation metrics given a specific precision_window_length. properties: - nextPageToken: + precisionWindowLength: type: string + format: google-duration description: >- - A token, which can be sent as ListFeaturesRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - features: - description: The Features matching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + This VideoActionMetrics is calculated based on this prediction + window length. If the predicted action's timestamp is inside the + time window whose center is the ground truth action's timestamp with + this specific length, the prediction result is treated as a true + positive. + confidenceMetrics: type: array - id: GoogleCloudAiplatformV1ListFeaturesResponse + description: >- + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics + meanAveragePrecision: + type: number + format: float + description: The mean average precision. + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics type: object - GoogleCloudAiplatformV1PurgeContextsResponse: + GoogleCloudAiplatformV1NasTrialDetail: type: object - id: GoogleCloudAiplatformV1PurgeContextsResponse - description: Response message for MetadataService.PurgeContexts. + id: GoogleCloudAiplatformV1NasTrialDetail properties: - purgeSample: - items: - type: string - type: array - description: >- - A sample of the Context names that will be deleted. Only populated - if `force` is set to false. The maximum number of samples is 100 (it - is possible to return fewer). - purgeCount: - type: string - format: int64 - description: >- - The number of Contexts that this request deleted (or, if `force` is - false, the number of Contexts that will be deleted). This can be an - estimate. - GoogleCloudAiplatformV1ToolNameMatchResults: - description: Results for tool name match metric. - type: object - properties: - toolNameMatchMetricValues: - readOnly: true - description: Output only. Tool name match metric values. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolNameMatchMetricValue - id: GoogleCloudAiplatformV1ToolNameMatchResults - GoogleCloudAiplatformV1PredictResponse: - description: Response message for PredictionService.Predict. - type: object - id: GoogleCloudAiplatformV1PredictResponse - properties: - predictions: - items: - type: any - description: >- - The predictions that are the output of the predictions call. The - schema of any single prediction may be specified via Endpoint's - DeployedModels' Model's PredictSchemata's prediction_schema_uri. - type: array - metadata: - description: >- - Output only. Request-level metadata returned by the model. The - metadata type will be dependent upon the model implementation. - readOnly: true - type: any - deployedModelId: - description: ID of the Endpoint's DeployedModel that served this prediction. - type: string - model: + trainTrial: description: >- - Output only. The resource name of the Model which is deployed as the - DeployedModel that this prediction hits. - readOnly: true - type: string - modelDisplayName: + The train NasTrial corresponding to search_trial. Only populated if + search_trial is used for training. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + searchTrial: + description: The requested search NasTrial. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + name: + description: Output only. Resource name of the NasTrialDetail. type: string readOnly: true - description: >- - Output only. The display name of the Model which is deployed as the - DeployedModel that this prediction hits. - modelVersionId: + parameters: type: string - description: >- - Output only. The version ID of the Model which is deployed as the - DeployedModel that this prediction hits. - readOnly: true - GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams: - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams - description: Prediction model parameters for Image Segmentation. + description: The parameters for the NasJob NasTrial. + description: >- + Represents a NasTrial details along with its parameters. If there is a + corresponding train NasTrial, the train NasTrial is also returned. + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput: type: object + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput properties: - confidenceThreshold: - description: >- - When the model predicts category of pixels of the image, it will - only provide predictions for pixels that it is at least this much - confident about. All other pixels will be classified as background. - Default value is 0.5. - type: number - format: float - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig: - properties: - bigquerySource: + instance: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource - gcsSource: + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance + description: Required. Question answering helpfulness instance. + metricSpec: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource - description: >- - The time series Dataset's data source. The Dataset doesn't store the - data directly, but only pointer(s) to its data. - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig - type: object - GoogleCloudAiplatformV1UserActionReference: + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec + description: Required. Spec for question answering helpfulness score metric. + description: Input for question answering helpfulness metric. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef: properties: - operation: - type: string - description: >- - For API calls that return a long running operation. Resource name of - the long running operation. Format: - `projects/{project}/locations/{location}/operations/{operation}` - dataLabelingJob: + displayName: type: string - description: >- - For API calls that start a LabelingJob. Resource name of the - LabelingJob. Format: - `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` - method: - description: >- - The method name of the API RPC call. For example, - "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset" + description: Display name of the AnnotationSpec. + id: type: string - id: GoogleCloudAiplatformV1UserActionReference - description: >- - References an API call. It contains more information about long running - operation and Jobs that are triggered by the API call. + description: ID of the AnnotationSpec. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef type: object - GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult: + GoogleCloudAiplatformV1ToolParameterKeyMatchSpec: + id: GoogleCloudAiplatformV1ToolParameterKeyMatchSpec + properties: {} + type: object + description: Spec for tool parameter key match metric. + GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult: id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult - description: Prediction output format for Image and Text Classification. + GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult + type: object properties: - displayNames: + bboxes: + items: + items: + type: any + type: array description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. + Bounding boxes, i.e. the rectangles over the image, that pinpoint + the found AnnotationSpecs. Given in order that matches the IDs. Each + bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and + `yMax`, which represent the extremal coordinates of the box. They + are relative to the image size, and the point 0,0 is in the top left + of the image. type: array - items: - type: string ids: + description: >- + The resource IDs of the AnnotationSpecs that had been identified, + ordered by the confidence score descendingly. items: - type: string format: int64 + type: string type: array - description: The resource IDs of the AnnotationSpecs that had been identified. - confidences: - description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. + displayNames: type: array - items: - format: float - type: number - type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig: - properties: - explanationBaseline: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline - description: >- - Predictions generated by the BatchPredictionJob using baseline - dataset. - enableFeatureAttributes: description: >- - If want to analyze the Vertex Explainable AI feature attribute - scores or not. If set to true, Vertex AI will log the feature - attributions from explain response and do the skew/drift detection - for them. - type: boolean - type: object - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig - description: >- - The config for integrating with Vertex Explainable AI. Only applicable - if the Model has explanation_spec populated. - GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata: - properties: - genericMetadata: - description: Operation metadata for PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - progressMessage: - description: Progress Message for Create LRO - type: string - id: GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata - type: object - description: Details of operations that perform create PersistentResource. - GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig: - type: object - properties: - userEmails: - type: array - description: The email addresses to send the alert. + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. items: type: string - id: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig - description: The config for email alert. - GoogleCloudAiplatformV1DeployModelOperationMetadata: - id: GoogleCloudAiplatformV1DeployModelOperationMetadata - type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - description: Runtime operation information for EndpointService.DeployModel. - GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse: - description: Response message for ModelService.ListModelEvaluationSlices. - id: GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse - type: object - properties: - modelEvaluationSlices: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + confidences: type: array - description: List of ModelEvaluations in the requested page. - nextPageToken: - type: string - description: >- - A token to retrieve next page of results. Pass to - ListModelEvaluationSlicesRequest.page_token to obtain that page. - GoogleCloudAiplatformV1DestinationFeatureSetting: - properties: - featureId: - description: Required. The ID of the Feature to apply the setting to. - type: string - destinationField: - type: string - description: >- - Specify the field name in the export destination. If not specified, - Feature ID is used. - type: object - id: GoogleCloudAiplatformV1DestinationFeatureSetting - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity: - description: A duration of time expressed in time granularity units. - properties: - quantity: - format: int64 - type: string description: >- - The number of granularity_units between data points in the training - data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. - For all other values of `granularity_unit`, must be 1. - unit: - type: string - description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity - GoogleCloudAiplatformV1DedicatedResources: - properties: - spot: - type: boolean - description: >- - Optional. If true, schedule the deployment workload on [spot - VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). - machineSpec: - description: >- - Required. Immutable. The specification of a single machine used by - the prediction. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - autoscalingMetricSpecs: + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoscalingMetricSpec' - description: >- - Immutable. The metric specifications that overrides a resource - utilization metric (CPU utilization, accelerator's duty cycle, and - so on) target value (default to 60 if not set). At most one entry is - allowed per metric. If machine_spec.accelerator_count is above 0, - the autoscaling will be based on both CPU utilization and - accelerator's duty cycle metrics and scale up when either metrics - exceeds its target value while scale down if both metrics are under - their target value. The default target value is 60 for both metrics. - If machine_spec.accelerator_count is 0, the autoscaling will be - based on CPU utilization metric only with default target value 60 if - not explicitly set. For example, in the case of Online Prediction, - if you want to override target CPU utilization to 80, you should set - autoscaling_metric_specs.metric_name to - `aiplatform.googleapis.com/prediction/online/cpu/utilization` and - autoscaling_metric_specs.target to `80`. - type: array - minReplicaCount: - format: int32 - description: >- - Required. Immutable. The minimum number of machine replicas this - DeployedModel will be always deployed on. This value must be greater - than or equal to 1. If traffic against the DeployedModel increases, - it may dynamically be deployed onto more replicas, and as traffic - decreases, some of these extra replicas may be freed. - type: integer - maxReplicaCount: - description: >- - Immutable. The maximum number of replicas this DeployedModel 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 the model to that many replicas - is guaranteed (barring service outages). If traffic against the - DeployedModel 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). - format: int32 - type: integer - type: object - id: GoogleCloudAiplatformV1DedicatedResources - description: >- - A description of resources that are dedicated to a DeployedModel, and - that need a higher degree of manual configuration. - GoogleCloudAiplatformV1AutomaticResources: + type: number + format: float + description: Prediction output format for Image Object Detection. + GoogleCloudAiplatformV1SchemaPredictionResult: properties: - minReplicaCount: - format: int32 + key: + description: Optional user-provided key from the input instance. + type: string + instance: + additionalProperties: + description: Properties of the object. + type: any description: >- - Immutable. The minimum number of replicas this DeployedModel will be - always deployed on. If traffic against it increases, it may - dynamically be deployed onto more replicas up to max_replica_count, - and as traffic decreases, some of these extra replicas may be freed. - If the requested value is too large, the deployment will error. - type: integer - maxReplicaCount: + User's input instance. Struct is used here instead of Any so that + JsonFormat does not append an extra "@type" field when we convert + the proto to JSON. + type: object + error: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictionResultError + description: The error result. Do not set prediction if this is set. + prediction: description: >- - Immutable. The maximum number of replicas this DeployedModel 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 the model to that many replicas - is guaranteed (barring service outages). If traffic against the - DeployedModel 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. - format: int32 - type: integer + The prediction result. Value is used here instead of Any so that + JsonFormat does not append an extra "@type" field when we convert + the proto to JSON and so we can represent array of objects. Do not + set error if this is set. + type: any type: object - id: 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. - GoogleCloudAiplatformV1PointwiseMetricInstance: + id: GoogleCloudAiplatformV1SchemaPredictionResult + description: Represents a line of JSONL in the batch prediction output file. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting: properties: - jsonInstance: - type: string - description: >- - Instance specified as a json string. String key-value pairs are - expected in the json_instance to render - PointwiseMetricSpec.instance_prompt_template. + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs + description: The input parameters of this TrainingJob. + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. type: object - description: >- - Pointwise metric instance. Usually one instance corresponds to one row - in an evaluation dataset. - id: GoogleCloudAiplatformV1PointwiseMetricInstance - GoogleCloudAiplatformV1AddExecutionEventsRequest: - id: GoogleCloudAiplatformV1AddExecutionEventsRequest + GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse: + description: Response message for TensorboardService.BatchCreateTensorboardRuns. properties: - events: - description: The Events to create and add. + tensorboardRuns: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + description: The created TensorboardRuns. type: array type: object - description: Request message for MetadataService.AddExecutionEvents. - GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult - type: object - description: Prediction output format for Text Sentiment - properties: - sentiment: - description: >- - The integer sentiment labels between 0 (inclusive) and sentimentMax - label (inclusive), while 0 maps to the least positive sentiment and - sentimentMax maps to the most positive one. The higher the score is, - the more positive the sentiment in the text snippet is. Note: - sentimentMax is an integer value between 1 (inclusive) and 10 - (inclusive). - type: integer - format: int32 - GoogleCloudAiplatformV1GenerationConfigRoutingConfig: - description: The configuration for routing the request to a specific model. - id: GoogleCloudAiplatformV1GenerationConfigRoutingConfig - properties: - manualMode: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode - description: Manual routing. - autoMode: - description: Automated routing. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode - type: object + id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse GoogleCloudAiplatformV1ExportModelRequestOutputConfig: - id: GoogleCloudAiplatformV1ExportModelRequestOutputConfig description: Output configuration for the Model export. - type: object properties: exportFormatId: description: >- @@ -18344,3443 +16014,6363 @@ components: Model container image will be copied to. This field should only be set when the `exportableContent` field of the [Model.supported_export_formats] object contains `IMAGE`. - GoogleCloudAiplatformV1ListNasJobsResponse: type: object + id: GoogleCloudAiplatformV1ExportModelRequestOutputConfig + GoogleCloudAiplatformV1ManualBatchTuningParameters: + id: GoogleCloudAiplatformV1ManualBatchTuningParameters + description: Manual batch tuning parameters. properties: - nextPageToken: - type: string - description: >- - A token to retrieve the next page of results. Pass to - ListNasJobsRequest.page_token to obtain that page. - nasJobs: + batchSize: + format: int32 description: >- - List of NasJobs in the requested page. NasJob.nas_job_output of the - jobs will not be returned. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' - description: Response message for JobService.ListNasJobs - id: GoogleCloudAiplatformV1ListNasJobsResponse - GoogleCloudAiplatformV1StreamRawPredictRequest: - description: Request message for PredictionService.StreamRawPredict. - id: GoogleCloudAiplatformV1StreamRawPredictRequest + Immutable. The number of the records (e.g. instances) of the + operation given in each batch to a machine replica. Machine type, + and size of a single record should be considered when setting this + parameter, higher value speeds up the batch operation's execution, + but too high value will result in a whole batch not fitting in a + machine's memory, and the whole operation will fail. The default + value is 64. + type: integer type: object - properties: - httpBody: - description: >- - The prediction input. Supports HTTP headers and arbitrary data - payload. - $ref: '#/components/schemas/GoogleApiHttpBody' - GoogleCloudAiplatformV1ScheduleRunResponse: + GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata: type: object properties: - scheduledRunTime: - description: The scheduled run time based on the user-specified schedule. - format: google-datetime - type: string - runResponse: - description: The response of the scheduled run. - type: string - description: Status of a scheduled run. - id: GoogleCloudAiplatformV1ScheduleRunResponse - GoogleCloudAiplatformV1StudySpecMetricSpec: - id: GoogleCloudAiplatformV1StudySpecMetricSpec + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + id: GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata + description: >- + Runtime operation information for + SpecialistPoolService.CreateSpecialistPool. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking: + description: >- + A TrainingJob that trains and uploads an AutoML Video ObjectTracking + Model. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking type: object properties: - goal: - type: string - enum: - - GOAL_TYPE_UNSPECIFIED - - MAXIMIZE - - MINIMIZE - description: Required. The optimization goal of the metric. - enumDescriptions: - - Goal Type will default to maximize. - - Maximize the goal metric. - - Minimize the goal metric. - metricId: - description: >- - Required. The ID of the metric. Must not contain whitespaces and - must be unique amongst all MetricSpecs. - type: string - safetyConfig: + inputs: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig - description: >- - Used for safe search. In the case, the metric will be a safety - metric. You must provide a separate metric for objective metric. - description: Represents a metric to optimize. - GoogleCloudAiplatformV1ResourcePool: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs + description: The input parameters of this TrainingJob. + GoogleCloudAiplatformV1Trial: type: object - description: >- - Represents the spec of a group of resources of the same type, for - example machine type, disk, and accelerators, in a PersistentResource. properties: - usedReplicaCount: + name: + description: Output only. Resource name of the Trial assigned by the service. type: string - description: >- - Output only. The number of machines currently in use by training - jobs for this resource pool. Will replace idle_replica_count. readOnly: true - format: int64 - replicaCount: - type: string - format: int64 - description: >- - Optional. The total number of machines to use for this resource - pool. - id: - description: >- - Immutable. The unique ID in a PersistentResource for referring to - this resource pool. User can specify it if necessary. Otherwise, - it's generated automatically. + state: type: string - diskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - description: Optional. Disk spec for the machine in this node pool. - machineSpec: - description: Required. Immutable. The specification of a single machine. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - autoscalingSpec: - description: >- - Optional. Optional spec to configure GKE or Ray-on-Vertex - autoscaling - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec - id: GoogleCloudAiplatformV1ResourcePool - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList: - properties: - features: + enum: + - STATE_UNSPECIFIED + - REQUESTED + - ACTIVE + - STOPPING + - SUCCEEDED + - INFEASIBLE + enumDescriptions: + - The Trial state is unspecified. + - >- + Indicates that a specific Trial has been requested, but it has not + yet been suggested by the service. + - Indicates that the Trial has been suggested. + - Indicates that the Trial should stop according to the service. + - Indicates that the Trial is completed successfully. + - >- + Indicates that the Trial should not be attempted again. The + service will set a Trial to INFEASIBLE when it's done but missing + the final_measurement. + readOnly: true + description: Output only. The detailed state of the Trial. + parameters: + readOnly: true type: array + description: Output only. The parameters of the Trial. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair - description: List of feature names and values. - type: object - description: >- - Response structure in the format of key (feature name) and (feature) - value pair. - id: >- - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList - GoogleCloudAiplatformV1CustomJob: - id: GoogleCloudAiplatformV1CustomJob - type: object - description: >- - Represents a job that runs custom workloads such as a Docker container - or a Python package. A CustomJob can have multiple worker pools and each - worker pool can have its own machine and input spec. A CustomJob will be - cleaned up once the job enters terminal state (failed or succeeded). - properties: - satisfiesPzs: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - displayName: - description: >- - Required. The display name of the CustomJob. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - type: string - encryptionSpec: - description: >- - Customer-managed encryption key options for a CustomJob. If this is - set, then all resources created by the CustomJob will be encrypted - with the provided encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' webAccessUris: - additionalProperties: - type: string - type: object - readOnly: true description: >- Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - (one URI for each training node). Only available if - job_spec.enable_web_access is `true`. The keys are names of each - node in the training job; for example, `workerpool0-0` for the - primary node, `workerpool1-0` for the first node in the second + (one URI for each training node). Only available if this trial is + part of a HyperparameterTuningJob and the job's + trial_job_spec.enable_web_access field is `true`. The keys are names + of each node used for the trial; for example, `workerpool0-0` for + the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell. - updateTime: - type: string - description: Output only. Time when the CustomJob was most recently updated. - format: google-datetime - readOnly: true - state: - type: string - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - readOnly: true - description: Output only. The detailed state of the job. - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - error: - description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - satisfiesPzi: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - createTime: + additionalProperties: + type: string readOnly: true - format: google-datetime - type: string - description: Output only. Time when the CustomJob was created. - labels: type: object + customJob: description: >- - The labels with user-defined metadata to organize CustomJobs. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - additionalProperties: - type: string - name: + Output only. The CustomJob name linked to the Trial. It's set for a + HyperparameterTuningJob's Trial. type: string readOnly: true - description: Output only. Resource name of a CustomJob. - jobSpec: - description: Required. Job spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - endTime: - type: string + startTime: readOnly: true + description: Output only. Time when the Trial was started. format: google-datetime - description: >- - Output only. Time when the CustomJob entered any of the following - states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - startTime: type: string + infeasibleReason: description: >- - Output only. Time when the CustomJob for the first time entered the - `JOB_STATE_RUNNING` state. - format: google-datetime + Output only. A human readable string describing why the Trial is + infeasible. This is set only if Trial state is `INFEASIBLE`. readOnly: true - GoogleCloudAiplatformV1UndeployIndexRequest: - properties: - deployedIndexId: type: string + endTime: + format: google-datetime + readOnly: true description: >- - Required. The ID of the DeployedIndex to be undeployed from the - IndexEndpoint. - description: Request message for IndexEndpointService.UndeployIndex. - type: object - id: GoogleCloudAiplatformV1UndeployIndexRequest - GoogleCloudAiplatformV1ModelExportFormat: - type: object - properties: - id: + Output only. Time when the Trial's status changed to `SUCCEEDED` or + `INFEASIBLE`. type: string + finalMeasurement: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + description: Output only. The final measurement containing the objective value. readOnly: true + measurements: description: >- - Output only. The ID of the export format. The possible format IDs - are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * - `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be - used in the browser and in Node.js using JavaScript. * `core-ml` - Used for iOS mobile devices. * `custom-trained` A Model that was - uploaded or trained by custom code. - exportableContents: + Output only. A list of measurements that are strictly + lexicographically ordered by their induced tuples (steps, + elapsed_duration). These are used for early stopping computations. + type: array items: - type: string - enum: - - EXPORTABLE_CONTENT_UNSPECIFIED - - ARTIFACT - - IMAGE - enumDescriptions: - - Should not be used. - - >- - Model artifact and any of its supported files. Will be exported - to the location specified by the `artifactDestination` field of - the ExportModelRequest.output_config object. - - >- - The container image that is to be used when deploying this - Model. Will be exported to the location specified by the - `imageDestination` field of the ExportModelRequest.output_config - object. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + readOnly: true + id: + description: Output only. The identifier of the Trial assigned by the service. readOnly: true - description: Output only. The content of this Model that may be exported. - type: array - id: GoogleCloudAiplatformV1ModelExportFormat - description: >- - Represents export format supported by the Model. All formats export to - Google Cloud Storage. - GoogleCloudAiplatformV1FeatureStatsAnomaly: - properties: - score: - type: number - format: double - description: >- - Feature importance score, only populated when cross-feature - monitoring is enabled. For now only used to represent feature - attribution score within range [0, 1] for - ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and - ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT. - anomalyUri: - description: >- - Path of the anomaly file for current feature values in Cloud Storage - bucket. Format: gs:////anomalies. Example: - gs://monitoring_bucket/feature_name/anomalies. Stats are stored as - binary format with Protobuf message Anoamlies are stored as binary - format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] - (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto). type: string - anomalyDetectionThreshold: - description: >- - This is the threshold used when detecting anomalies. The threshold - can be changed by user, so this one might be different from - ThresholdConfig.value. - format: double - type: number - endTime: - format: google-datetime - description: >- - The end timestamp of window where stats were generated. For - objectives where time window doesn't make sense (e.g. Featurestore - Snapshot Monitoring), end_time indicates the timestamp of the data - used to generate stats (e.g. timestamp we take snapshots for feature - values). + clientId: type: string - distributionDeviation: + readOnly: true description: >- - Deviation from the current stats to baseline stats. 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. + Output only. The identifier of the client that originally requested + this Trial. Each client is identified by a unique client_id. When a + client asks for a suggestion, Vertex AI Vizier will assign it a + Trial. The client should evaluate the Trial, complete it, and report + back to Vertex AI Vizier. If suggestion is asked again by same + client_id before the Trial is completed, the same Trial will be + returned. Multiple clients with different client_ids can ask for + suggestions simultaneously, each of them will get their own Trial. + description: >- + A message representing a Trial. A Trial contains a unique set of + Parameters that has been or will be evaluated, along with the objective + metrics got by running the Trial. + id: GoogleCloudAiplatformV1Trial + GoogleCloudAiplatformV1SupervisedHyperParameters: + properties: + learningRateMultiplier: type: number + description: Optional. Multiplier for adjusting the default learning rate. format: double - statsUri: + adapterSize: + enum: + - ADAPTER_SIZE_UNSPECIFIED + - ADAPTER_SIZE_ONE + - ADAPTER_SIZE_FOUR + - ADAPTER_SIZE_EIGHT + - ADAPTER_SIZE_SIXTEEN + - ADAPTER_SIZE_THIRTY_TWO + description: Optional. Adapter size for tuning. type: string + enumDescriptions: + - Adapter size is unspecified. + - Adapter size 1. + - Adapter size 4. + - Adapter size 8. + - Adapter size 16. + - Adapter size 32. + epochCount: description: >- - Path of the stats file for current feature values in Cloud Storage - bucket. Format: gs:////stats. Example: - gs://monitoring_bucket/feature_name/stats. Stats are stored as - binary format with Protobuf message - [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto). - startTime: - format: google-datetime + Optional. Number of complete passes the model makes over the entire + training dataset during training. type: string - description: >- - The start timestamp of window where stats were generated. For - objectives where time window doesn't make sense (e.g. Featurestore - Snapshot Monitoring), start_time is only used to indicate the - monitoring intervals, so it always equals to (end_time - - monitoring_interval). + format: int64 type: object - description: >- - Stats and Anomaly generated at specific timestamp for specific Feature. - The start_time and end_time are used to define the time range of the - dataset that current stats belongs to, e.g. prediction traffic is - bucketed into prediction datasets by time window. If the Dataset is not - defined by time window, start_time = end_time. Timestamp of the stats - and anomalies always refers to end_time. Raw stats and anomalies are - stored in stats_uri or anomaly_uri in the tensorflow defined protos. - Field data_stats contains almost identical information with the raw - stats in Vertex AI defined proto, for UI to display. - id: GoogleCloudAiplatformV1FeatureStatsAnomaly - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation: + description: Hyperparameters for SFT. + id: GoogleCloudAiplatformV1SupervisedHyperParameters + GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly: properties: - vertexes: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' - type: array - description: >- - The vertexes are connected one by one and the last vertex in not - connected to the first one. - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - annotationSpecId: + objective: type: string + enum: + - OBJECTIVE_UNSPECIFIED + - IMPORT_FEATURE_ANALYSIS + - SNAPSHOT_ANALYSIS + enumDescriptions: + - If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty. + - Stats are generated by Import Feature Analysis. + - Stats are generated by Snapshot Analysis. + description: Output only. The objective for each stats. + readOnly: true + featureStatsAnomaly: + readOnly: true description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - description: Represents a polyline in image. + Output only. The stats and anomalies generated at specific + timestamp. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + id: GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + description: >- + A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats + requested by user, sorted by FeatureStatsAnomaly.start_time descending. type: object - id: >- - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation - GoogleCloudAiplatformV1ListEndpointsResponse: + GoogleCloudAiplatformV1Tensor: + description: A tensor value type. + id: GoogleCloudAiplatformV1Tensor type: object properties: - endpoints: + tensorVal: + format: byte + description: Serialized raw tensor content. + type: string + listVal: + description: A list of tensor values. + type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + floatVal: + description: FLOAT + items: + format: float + type: number type: array - description: List of Endpoints in the requested page. - nextPageToken: - type: string - description: >- - A token to retrieve the next page of results. Pass to - ListEndpointsRequest.page_token to obtain that page. - description: Response message for EndpointService.ListEndpoints. - id: GoogleCloudAiplatformV1ListEndpointsResponse - GoogleCloudAiplatformV1SchemaImageDataItem: - id: GoogleCloudAiplatformV1SchemaImageDataItem - type: object - properties: - gcsUri: - type: string + boolVal: description: >- - Required. Google Cloud Storage URI points to the original image in - user's bucket. The image is up to 30MB in size. - mimeType: - type: string - readOnly: true - description: >- - Output only. The mime type of the content of the image. Only the - images in below listed mime types are supported. - image/jpeg - - image/gif - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon - description: Payload of Image DataItem. - GoogleCloudAiplatformV1MigratableResourceAutomlModel: - description: Represents one Model in automl.googleapis.com. - id: GoogleCloudAiplatformV1MigratableResourceAutomlModel - properties: - modelDisplayName: - description: The Model's display name in automl.googleapis.com. - type: string - model: - description: >- - Full resource name of automl Model. Format: - `projects/{project}/locations/{location}/models/{model}`. + Type specific representations that make it easy to create tensor + protos in all languages. Only the representation corresponding to + "dtype" can be set. The values hold the flattened representation of + the tensor in row major order. BOOL + items: + type: boolean + type: array + int64Val: + description: INT64 + type: array + items: + type: string + format: int64 + dtype: + enumDescriptions: + - >- + Not a legal value for DataType. Used to indicate a DataType field + has not been set. + - >- + Data types that all computation devices are expected to be capable + to support. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: The data type of tensor. type: string + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - STRING + - FLOAT + - DOUBLE + - INT8 + - INT16 + - INT32 + - INT64 + - UINT8 + - UINT16 + - UINT32 + - UINT64 + stringVal: + type: array + description: STRING + items: + type: string + uintVal: + items: + type: integer + format: uint32 + type: array + description: UINT8 UINT16 UINT32 + intVal: + description: INT_8 INT_16 INT_32 + items: + type: integer + format: int32 + type: array + doubleVal: + description: DOUBLE + items: + format: double + type: number + type: array + structVal: + description: A map of string to tensor. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: object + shape: + type: array + description: Shape of the tensor. + items: + format: int64 + type: string + uint64Val: + description: UINT64 + items: + type: string + format: uint64 + type: array + bytesVal: + description: STRING + type: array + items: + format: byte + type: string + GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: type: object - GoogleCloudAiplatformV1FunctionCall: + id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider properties: - name: + allowedIssuers: + items: + type: string + type: array description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name]. - type: string - args: - additionalProperties: - description: Properties of the object. - type: any - type: object + A list of allowed JWT issuers. Each entry must be a valid Google + service account, in the following format: + `service-account-name@project-id.iam.gserviceaccount.com` + audiences: + items: + type: string description: >- - Optional. Required. The function parameters and values in JSON - object format. See [FunctionDeclaration.parameters] for parameter - details. - id: GoogleCloudAiplatformV1FunctionCall - type: object + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. + type: array description: >- - A predicted [FunctionCall] returned from the model that contains a - string representing the [FunctionDeclaration.name] and a structured JSON - object containing the parameters and their values. + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: + type: object + description: Details of operations that perform create FeatureGroup. properties: genericMetadata: - description: Operation metadata for FeatureGroup. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform create FeatureGroup. + description: Operation metadata for FeatureGroup. id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs: - properties: - multiLabel: - type: boolean - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs - GoogleCloudAiplatformV1CoherenceInstance: - description: Spec for coherence instance. + GoogleCloudAiplatformV1Annotation: + description: >- + Used to assign specific AnnotationSpec to a particular area of a + DataItem or the whole part of the DataItem. properties: - prediction: + payloadSchemaUri: + type: string + description: >- + Required. Google Cloud Storage URI points to a YAML file describing + payload. The schema is defined as an [OpenAPI 3.0.2 Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/, note that + the chosen schema must be consistent with the parent Dataset's + metadata. + updateTime: + format: google-datetime + description: Output only. Timestamp when this Annotation was last updated. + readOnly: true + type: string + labels: + additionalProperties: + type: string + description: >- + Optional. The labels with user-defined metadata to organize your + Annotations. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. No more than 64 user labels can be associated with one + Annotation(System labels are excluded). See https://goo.gl/xmQnxf + for more information and examples of labels. System reserved label + keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. Following system labels exist for each Annotation: * + "aiplatform.googleapis.com/annotation_set_name": optional, name of + the UI's annotation set this Annotation belongs to. If not set, the + Annotation is not visible in the UI. * + "aiplatform.googleapis.com/payload_schema": output only, its value + is the payload_schema's title. + type: object + etag: + type: string + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + annotationSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UserActionReference' + readOnly: true + description: Output only. The source of the Annotation. + payload: + type: any + description: Required. The schema of the payload can be found in payload_schema. + name: + description: Output only. Resource name of the Annotation. + type: string + readOnly: true + createTime: + description: Output only. Timestamp when this Annotation was created. + readOnly: true + format: google-datetime type: string - description: Required. Output of the evaluated model. - id: GoogleCloudAiplatformV1CoherenceInstance - type: object - GoogleCloudAiplatformV1GroundednessSpec: type: object + id: GoogleCloudAiplatformV1Annotation + GoogleCloudAiplatformV1ImportDataRequest: + description: Request message for DatasetService.ImportData. properties: - version: - description: Optional. Which version to use for evaluation. - format: int32 - type: integer - description: Spec for groundedness metric. - id: GoogleCloudAiplatformV1GroundednessSpec - GoogleCloudAiplatformV1StringArray: - id: GoogleCloudAiplatformV1StringArray - properties: - values: + importConfigs: + description: >- + Required. The desired input locations. The contents of all input + locations will be imported in one batch. type: array items: - type: string - description: A list of string values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataConfig' type: object - description: A list of string values. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting: + id: GoogleCloudAiplatformV1ImportDataRequest + GoogleCloudAiplatformV1ExplanationMetadataOverride: properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata - description: The metadata information. inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs - description: The input parameters of this TrainingJob. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. - type: object - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec: - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec - type: object - description: Represent spec for train trials. - properties: - frequency: - description: >- - Required. Frequency of search trials to start train stage. Top N - [TrainTrialSpec.max_parallel_trial_count] search trials will be - trained for every M [TrainTrialSpec.frequency] trials searched. - format: int32 - type: integer - trainTrialJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' description: >- - Required. The spec of a train trial job. The same spec applies to - all train trials. - maxParallelTrialCount: - type: integer - description: Required. The maximum number of trials to run in parallel. - format: int32 - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec: - type: object - description: Represents a metric to optimize. - properties: - goal: - enumDescriptions: - - Goal Type will default to maximize. - - Maximize the goal metric. - - Minimize the goal metric. - enum: - - GOAL_TYPE_UNSPECIFIED - - MAXIMIZE - - MINIMIZE - description: Required. The optimization goal of the metric. - type: string - metricId: - type: string - description: Required. The ID of the metric. Must not contain whitespaces. - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec - GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData: - properties: - viewCount: - type: string - format: int64 - description: Number of times the user has read data within the Tensorboard. - username: - type: string - description: User's username - description: Per user usage data. - type: object - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData - GoogleProtobufEmpty: - id: GoogleProtobufEmpty - type: object - properties: {} - 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); } - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation: + Required. Overrides the input metadata of the features. The key is + the name of the feature to be overridden. The keys specified here + must exist in the input metadata to be overridden. If a feature is + not specified here, the corresponding feature's input metadata is + not overridden. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + type: object description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Convert the category name to a dictionary lookup index and generate an - embedding for each index. + The ExplanationMetadata entries that can be overridden at online + explanation time. type: object + id: GoogleCloudAiplatformV1ExplanationMetadataOverride + GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation + GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset + type: object + description: Represents one AnnotatedDataset in datalabeling.googleapis.com. properties: - columnName: + annotatedDataset: type: string - GoogleCloudAiplatformV1NasJobOutput: - type: object - description: Represents a uCAIP NasJob output. + description: >- + Full resource name of data labeling AnnotatedDataset. Format: + `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + annotatedDatasetDisplayName: + type: string + description: The AnnotatedDataset's display name in datalabeling.googleapis.com. + GoogleCloudAiplatformV1NasJobSpec: + description: Represents the spec of a NasJob. properties: - multiTrialJobOutput: - readOnly: true + searchSpaceSpec: + type: string + description: It defines the search space for Neural Architecture Search (NAS). + multiTrialAlgorithmSpec: + description: The spec of multi-trial algorithms. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec + resumeNasJobId: + type: string description: >- - Output only. The output of this multi-trial Neural Architecture - Search (NAS) job. - id: GoogleCloudAiplatformV1NasJobOutput - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction: + The ID of the existing NasJob in the same Project and Location which + will be used to resume search. search_space_spec and + nas_algorithm_spec are obtained from previous NasJob hence should + not provide them again for this NasJob. type: object - description: A TrainingJob that trains and uploads an AutoML Text Extraction Model. - properties: - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction - GoogleCloudAiplatformV1LookupStudyRequest: + id: GoogleCloudAiplatformV1NasJobSpec + GoogleCloudAiplatformV1Scalar: type: object + description: One point viewable on a scalar metric plot. + id: GoogleCloudAiplatformV1Scalar properties: - displayName: - description: Required. The user-defined display name of the Study - type: string - id: GoogleCloudAiplatformV1LookupStudyRequest - description: Request message for VizierService.LookupStudy. - GoogleCloudAiplatformV1PrivateServiceConnectConfig: + value: + format: double + type: number + description: Value of the point at this step / timestamp. + GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult: properties: - serviceAttachment: - readOnly: true + textSegmentStartOffsets: + items: + format: int64 + type: string + type: array description: >- - Output only. The name of the generated service attachment resource. - This is only populated if the endpoint is deployed with - PrivateServiceConnect. - type: string - enablePrivateServiceConnect: - type: boolean + The start offsets, inclusive, of the text segment in which the + AnnotationSpec has been identified. Expressed as a zero-based number + of characters as measured from the start of the text snippet. + ids: + type: array description: >- - Required. If true, expose the IndexEndpoint via private service - connect. - projectAllowlist: + The resource IDs of the AnnotationSpecs that had been identified, + ordered by the confidence score descendingly. + items: + format: int64 + type: string + confidences: + type: array + items: + format: float + type: number + description: >- + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. + textSegmentEndOffsets: + items: + format: int64 + type: string type: array description: >- - A list of Projects from which the forwarding rule will target the - service attachment. + The end offsets, inclusive, of the text segment in which the + AnnotationSpec has been identified. Expressed as a zero-based number + of characters as measured from the start of the text snippet. + displayNames: items: type: string - id: GoogleCloudAiplatformV1PrivateServiceConnectConfig - description: Represents configuration for private service connect. + description: >- + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. + type: array + description: Prediction output format for Text Extraction. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult type: object - GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest: - id: GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest + GoogleCloudAiplatformV1SummarizationHelpfulnessSpec: + type: object + id: GoogleCloudAiplatformV1SummarizationHelpfulnessSpec properties: - notebookExecutionJob: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' - description: Required. The NotebookExecutionJob to create. - parent: - type: string + version: + description: Optional. Which version to use for evaluation. + format: int32 + type: integer + useReference: + type: boolean description: >- - Required. The resource name of the Location to create the - NotebookExecutionJob. Format: - `projects/{project}/locations/{location}` - notebookExecutionJobId: - description: Optional. User specified ID for the NotebookExecutionJob. + Optional. Whether to use instance.reference to compute summarization + helpfulness. + description: Spec for summarization helpfulness score metric. + GoogleCloudAiplatformV1MetadataStoreMetadataStoreState: + id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + description: Represents state information for a MetadataStore. + properties: + diskUtilizationBytes: type: string + description: The disk utilization of the MetadataStore in bytes. + format: int64 type: object - description: Request message for [NotebookService.CreateNotebookExecutionJob] - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting - type: object - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + GoogleCloudAiplatformV1FileData: properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata - description: The metadata information. - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs - description: The input parameters of this TrainingJob. - GoogleCloudAiplatformV1ListTensorboardExperimentsResponse: + fileUri: + type: string + description: Required. URI. + mimeType: + description: Required. The IANA standard MIME type of the source data. + type: string type: object + description: URI based data. + id: GoogleCloudAiplatformV1FileData + GoogleCloudAiplatformV1NotebookExecutionJob: properties: - nextPageToken: + serviceAccount: + description: The service account to run the execution as. type: string + createTime: + description: Output only. Timestamp when this NotebookExecutionJob was created. + readOnly: true + type: string + format: google-datetime + status: description: >- - A token, which can be sent as - ListTensorboardExperimentsRequest.page_token to retrieve the next - page. If this field is omitted, there are no subsequent pages. - tensorboardExperiments: - description: The TensorboardExperiments mathching the request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment' - description: Response message for TensorboardService.ListTensorboardExperiments. - id: GoogleCloudAiplatformV1ListTensorboardExperimentsResponse - GoogleCloudAiplatformV1ShieldedVmConfig: - properties: - enableSecureBoot: - type: boolean - description: >- - Defines whether the instance has [Secure - Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) - enabled. Secure Boot helps ensure that the system only runs - authentic software by verifying the digital signature of all boot - components, and halting the boot process if signature verification - fails. - type: object - id: GoogleCloudAiplatformV1ShieldedVmConfig - description: >- - A set of Shielded Instance options. See [Images using supported Shielded - VM - features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). - GoogleCloudAiplatformV1Model: - description: A trained machine learning Model. - id: GoogleCloudAiplatformV1Model - properties: - dataStats: + Output only. Populated when the NotebookExecutionJob is completed. + When there is an error during notebook execution, the error details + are populated. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + gcsOutputUri: description: >- - Stats of data used for training or evaluating the Model. Only - populated when the Model is trained by a TrainingPipeline with - data_input_config. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' - supportedDeploymentResourcesTypes: - type: array - items: - enum: - - DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED - - DEDICATED_RESOURCES - - AUTOMATIC_RESOURCES - - SHARED_RESOURCES - type: string - enumDescriptions: - - Should not be used. - - >- - Resources that are dedicated to the DeployedModel, and that need - a higher degree of manual configuration. - - >- - Resources that to large degree are decided by Vertex AI, and - require only a modest additional configuration. - - >- - Resources that can be shared by multiple DeployedModels. A - pre-configured DeploymentResourcePool is required. - description: >- - Output only. When this Model is deployed, its prediction resources - are described by the `prediction_resources` field of the - Endpoint.deployed_models object. Because not all Models support all - resource configuration types, the configuration types this Model - supports are listed here. If no configuration types are listed, the - Model cannot be deployed to an Endpoint and does not support online - predictions (PredictionService.Predict or - PredictionService.Explain). Such a Model can serve predictions by - using a BatchPredictionJob, if it has at least one entry each in - supported_input_storage_formats and - supported_output_storage_formats. - readOnly: true - versionId: - description: >- - Output only. Immutable. The version ID of the model. A new version - is committed when a new model version is uploaded or trained under - an existing model id. It is an auto-incrementing decimal number in - string representation. - type: string - readOnly: true - createTime: - description: Output only. Timestamp when this Model was uploaded into Vertex AI. - readOnly: true - format: google-datetime + The Cloud Storage location to upload the result to. Format: + `gs://bucket-name` type: string - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - containerSpec: - $ref: '#/components/schemas/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. - versionAliases: - description: >- - User provided version aliases so that a model version can be - referenced via alias (i.e. - `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` - instead of auto-generated version id (i.e. - `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. - The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A - default version alias will be created for the first version of the - model, and there must be exactly one default version alias for a - model. - items: - type: string - type: array - deployedModels: - readOnly: true - description: >- - Output only. The pointers to DeployedModels created from this Model. - Note that Model could have been deployed to Endpoints in different - Locations. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' - type: array - baseModelSource: + gcsNotebookSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource description: >- - Optional. User input field to specify the base model source. - Currently it only supports specifing the Model Garden models and - Genie models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelBaseModelSource' - versionCreateTime: - readOnly: true - description: Output only. Timestamp when this version was created. + The Cloud Storage url pointing to the ipynb file. Format: + `gs://bucket/notebook_file.ipynb` + directNotebookSource: + description: The contents of an input notebook file. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource + updateTime: format: google-datetime - type: string - etag: - type: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - predictSchemata: - description: >- - The schemata that describe formats of the Model's predictions and - explanations as given and returned via PredictionService.Predict and - PredictionService.Explain. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - modelSourceInfo: - description: >- - Output only. Source of a model. It can either be automl training - pipeline, custom training pipeline, BigQuery ML, or saved and tuned - from Genie or Model Garden. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelSourceInfo' - supportedOutputStorageFormats: - items: - type: string - type: array description: >- - Output only. The formats this Model supports in - BatchPredictionJob.output_config. If both - PredictSchemata.instance_schema_uri and - PredictSchemata.prediction_schema_uri exist, the predictions are - returned together with their instances. In other words, the - prediction has the original instance data first, followed by the - actual prediction content (as per the schema). The possible formats - are: * `jsonl` The JSON Lines format, where each prediction is a - single line. Uses GcsDestination. * `csv` The CSV format, where each - prediction is a single comma-separated line. The first line in the - file is the header, containing comma-separated field names. Uses - GcsDestination. * `bigquery` Each prediction is a single row in a - BigQuery table, uses BigQueryDestination . If this Model doesn't - support any of these formats it means it cannot be used with a - BatchPredictionJob. However, if it has - supported_deployment_resources_types, it could serve online - predictions by using PredictionService.Predict or - PredictionService.Explain. + Output only. Timestamp when this NotebookExecutionJob was most + recently updated. readOnly: true - metadata: - description: >- - Immutable. An additional information about the Model; the schema of - the metadata can be found in metadata_schema. Unset if the Model - does not have any additional information. - type: any - metadataSchemaUri: type: string + executionTimeout: + format: google-duration description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Model, that is specific - to it. Unset if the Model does not have any additional information. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI, if no - additional metadata is needed, this field is set to an empty string. - Note: The URI given on output will be immutable and probably - different, including the URI scheme, than the one given on input. - The output URI will point to a location where the user only has a - read access. - supportedExportFormats: - type: array - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExportFormat' - description: >- - Output only. The formats in which this Model may be exported. If - empty, this Model is not available for export. - artifactUri: + Max running time of the execution job in seconds (default 86400s / + 24 hrs). type: string - description: >- - Immutable. The path to the directory containing the Model artifact - and any of its supporting files. Not required for AutoML Models. - supportedInputStorageFormats: - type: array + name: readOnly: true description: >- - Output only. The formats this Model supports in - BatchPredictionJob.input_config. If - PredictSchemata.instance_schema_uri exists, the instances should be - given as per that schema. The possible formats are: * `jsonl` The - JSON Lines format, where each instance is a single line. Uses - GcsSource. * `csv` The CSV format, where each instance is a single - comma-separated line. The first line in the file is the header, - containing comma-separated field names. Uses GcsSource. * - `tf-record` The TFRecord format, where each instance is a single - record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` - Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * - `bigquery` Each instance is a single row in BigQuery. Uses - BigQuerySource. * `file-list` Each line of the file is the location - of an instance to process, uses `gcs_source` field of the - InputConfig object. If this Model doesn't support any of these - formats it means it cannot be used with a BatchPredictionJob. - However, if it has supported_deployment_resources_types, it could - serve online predictions by using PredictionService.Predict or - PredictionService.Explain. - items: - type: string - explanationSpec: - description: >- - The default explanation specification for this Model. The Model can - be used for requesting explanation after being deployed if it is - populated. The Model can be used for batch explanation if it is - populated. All fields of the explanation_spec can be overridden by - explanation_spec of DeployModelRequest.deployed_model, or - explanation_spec of BatchPredictionJob. If the default explanation - specification is not set for this Model, this Model can still be - used for requesting explanation by setting explanation_spec of - DeployModelRequest.deployed_model and for batch explanation by - setting explanation_spec of BatchPredictionJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - versionUpdateTime: - format: google-datetime - description: Output only. Timestamp when this version was most recently updated. + Output only. The resource name of this NotebookExecutionJob. Format: + `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` type: string + jobState: + description: Output only. The state of the NotebookExecutionJob. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED readOnly: true - updateTime: - description: Output only. Timestamp when this Model was most recently updated. - format: google-datetime - readOnly: true + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. type: string - description: - description: The description of the Model. + notebookRuntimeTemplateResourceName: type: string - trainingPipeline: + description: The NotebookRuntimeTemplate to source compute configuration from. + displayName: description: >- - Output only. The resource name of the TrainingPipeline that uploaded - this Model, if any. + The display name of the NotebookExecutionJob. The name can be up to + 128 characters long and can consist of any UTF-8 characters. type: string - readOnly: true labels: + description: >- + The labels with user-defined metadata to organize + NotebookExecutionJobs. Label keys and values can be no longer than + 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. System reserved label keys are + prefixed with "aiplatform.googleapis.com/" and are immutable. type: object additionalProperties: type: string + scheduleResourceName: description: >- - The labels with user-defined metadata to organize your Models. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - versionDescription: - type: string - description: The description of this version. - metadataArtifact: + Output only. The Schedule resource name if this job is triggered by + one. Format: + `projects/{project_id}/locations/{location}/schedules/{schedule_id}` type: string readOnly: true + dataformRepositorySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource description: >- - Output only. The resource name of the Artifact that was created in - MetadataStore when creating the Model. The Artifact resource name - pattern is - `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. - pipelineJob: - description: >- - Optional. This field is populated if the model is produced by a - pipeline job. - type: string - displayName: + The Dataform Repository pointing to a single file notebook + repository. + executionUser: description: >- - Required. The display name of the Model. The name can be up to 128 - characters long and can consist of any UTF-8 characters. + The user email to run the execution as. Only supported by Colab + runtimes. type: string encryptionSpec: description: >- - Customer-managed encryption key spec for a Model. If set, this Model - and all sub-resources of this Model will be secured by this key. + Customer-managed encryption key spec for the notebook execution job. + This field is auto-populated if the + NotebookService.NotebookRuntimeTemplate has an encryption spec. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - name: - description: The resource name of the Model. + type: object + description: NotebookExecutionJob represents an instance of a notebook execution. + id: GoogleCloudAiplatformV1NotebookExecutionJob + GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter: + id: GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter + description: >- + Numeric filter is used to search a subset of the entities by using + boolean rules on numeric columns. For example: Database Point 0: {name: + "a" value_int: 42} {name: "b" value_float: 1.0} Database Point 1: {name: + "a" value_int: 10} {name: "b" value_float: 2.0} Database Point 2: {name: + "a" value_int: -1} {name: "b" value_float: 3.0} Query: {name: "a" + value_int: 12 operator: LESS} // Matches Point 1, 2 {name: "b" + value_float: 2.0 operator: EQUAL} // Matches Point 1 + type: object + properties: + valueInt: + format: int64 + description: int value type. type: string - originalModelInfo: + valueDouble: + type: number + description: double value type. + format: double + op: + enum: + - OPERATOR_UNSPECIFIED + - LESS + - LESS_EQUAL + - EQUAL + - GREATER_EQUAL + - GREATER + - NOT_EQUAL description: >- - Output only. If this Model is a copy of another Model, this contains - info about the original. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelOriginalModelInfo' + Optional. This MUST be specified for queries and must NOT be + specified for database points. + type: string + enumDescriptions: + - Unspecified operator. + - Entities are eligible if their value is < the query's. + - Entities are eligible if their value is <= the query's. + - Entities are eligible if their value is == the query's. + - Entities are eligible if their value is >= the query's. + - Entities are eligible if their value is > the query's. + - Entities are eligible if their value is != the query's. + name: + type: string + description: Required. Column name in BigQuery that used as filters. + valueFloat: + description: float value type. + format: float + type: number + GoogleCloudAiplatformV1ReadTensorboardSizeResponse: + description: Response message for TensorboardService.ReadTensorboardSize. + properties: + storageSizeByte: + description: Payload storage size for the TensorBoard + type: string + format: int64 + id: GoogleCloudAiplatformV1ReadTensorboardSizeResponse type: object - GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: - id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata - description: Details of operations that perform create FeatureView. + GoogleCloudAiplatformV1CoherenceSpec: + properties: + version: + type: integer + description: Optional. Which version to use for evaluation. + format: int32 + description: Spec for coherence score metric. + id: GoogleCloudAiplatformV1CoherenceSpec type: object + GoogleCloudAiplatformV1ReadFeatureValuesResponse: + id: GoogleCloudAiplatformV1ReadFeatureValuesResponse + description: Response message for FeaturestoreOnlineServingService.ReadFeatureValues. properties: - genericMetadata: - description: Operation metadata for FeatureView Create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource: - id: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource + header: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader + description: Response header. + entityView: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView + description: >- + Entity view with Feature values. This may be the entity in the + Featurestore if values for all Features were requested, or a + projection of the entity in the Featurestore if values for only some + Features were requested. type: object - description: The Dataform Repository containing the input notebook. + GoogleCloudAiplatformV1ReadTensorboardUsageResponse: properties: - commitSha: + monthlyUsageData: + description: Maps year-month (YYYYMM) string to per month usage data. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData + type: object + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponse + description: Response message for TensorboardService.ReadTensorboardUsage. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation: + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation + properties: + columnName: type: string + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Tokenize text to words. Convert each words to a dictionary lookup + index and generate an embedding for each index. Combine the embedding of + all elements into a single embedding using the mean. * Tokenization is + based on unicode script boundaries. * Missing values get their own + lookup index and resulting embedding. * Stop-words receive no special + treatment and are not removed. + GoogleCloudAiplatformV1VertexRagStore: + properties: + vectorDistanceThreshold: + type: number + format: double description: >- - The commit SHA to read repository with. If unset, the file will be - read at HEAD. - dataformRepositoryResourceName: - type: string + Optional. Only return results with vector distance smaller than the + threshold. + similarityTopK: + type: integer + format: int32 description: >- - The resource name of the Dataform Repository. Format: - `projects/{project_id}/locations/{location}/repositories/{repository_id}` - GoogleCloudAiplatformV1UploadModelOperationMetadata: - id: GoogleCloudAiplatformV1UploadModelOperationMetadata - description: Details of ModelService.UploadModel operation. + Optional. Number of top k results to return from the selected + corpora. + ragCorpora: + deprecated: true + description: Optional. Deprecated. Please use rag_resources instead. + type: array + items: + type: string + ragResources: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1VertexRagStoreRagResource + description: >- + Optional. The representation of the rag source. It can be used to + specify corpus only or ragfiles. Currently only support one corpus + or multiple files from one corpus. In the future we may open up + multiple corpora support. + type: array + description: Retrieve from Vertex RAG Store for grounding. + id: GoogleCloudAiplatformV1VertexRagStore + type: object + GoogleCloudAiplatformV1CancelDataLabelingJobRequest: + properties: {} + description: Request message for JobService.CancelDataLabelingJob. + id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest + type: object + GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. + description: Operation metadata for Featurestore batch read Features values. type: object - GoogleCloudAiplatformV1NotebookRuntimeTemplate: + id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata + description: Details of operations that batch reads Feature values. + GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature: + description: Noise sigma for a single feature. properties: - machineSpec: + name: description: >- - Optional. Immutable. The specification of a single machine for the - template. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - notebookRuntimeType: - description: Optional. Immutable. The type of the notebook runtime template. - enumDescriptions: - - >- - Unspecified notebook runtime type, NotebookRuntimeType will - default to USER_DEFINED. - - runtime or template with coustomized configurations from user. - - runtime or template with system defined configurations. - enum: - - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED - - USER_DEFINED - - ONE_CLICK + The name of the input feature for which noise sigma is provided. The + features are defined in explanation metadata inputs. type: string - shieldedVmConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' - description: Optional. Immutable. Runtime Shielded VM spec. - name: + sigma: + format: float + type: number + description: >- + This represents the standard deviation of the Gaussian kernel that + will be used to add noise to the feature prior to computing + gradients. Similar to noise_sigma but represents the noise added to + the current feature. Defaults to 0.1. + id: GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + type: object + GoogleCloudAiplatformV1FluencyResult: + properties: + confidence: + description: Output only. Confidence for fluency score. + format: float + type: number + readOnly: true + score: + type: number + format: float + description: Output only. Fluency score. + readOnly: true + explanation: + readOnly: true type: string - description: The resource name of the NotebookRuntimeTemplate. - description: - description: The description of the NotebookRuntimeTemplate. + description: Output only. Explanation for fluency score. + description: Spec for fluency result. + id: GoogleCloudAiplatformV1FluencyResult + type: object + GoogleCloudAiplatformV1VideoMetadata: + description: Metadata describes the input video content. + properties: + endOffset: + format: google-duration + description: Optional. The end offset of the video. type: string - displayName: + startOffset: + format: google-duration + type: string + description: Optional. The start offset of the video. + id: GoogleCloudAiplatformV1VideoMetadata + type: object + GoogleCloudAiplatformV1PurgeContextsResponse: + properties: + purgeCount: + format: int64 type: string description: >- - Required. The display name of the NotebookRuntimeTemplate. The name - can be up to 128 characters long and can consist of any UTF-8 - characters. - labels: - additionalProperties: + The number of Contexts that this request deleted (or, if `force` is + false, the number of Contexts that will be deleted). This can be an + estimate. + purgeSample: + items: type: string description: >- - The labels with user-defined metadata to organize the - NotebookRuntimeTemplates. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - type: object - eucConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' - description: EUC configuration of the NotebookRuntimeTemplate. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: Customer-managed encryption key spec for the notebook runtime. - isDefault: - type: boolean - description: Output only. The default template to use if not specified. - readOnly: true - serviceAccount: + A sample of the Context names that will be deleted. Only populated + if `force` is set to false. The maximum number of samples is 100 (it + is possible to return fewer). + type: array + id: GoogleCloudAiplatformV1PurgeContextsResponse + description: Response message for MetadataService.PurgeContexts. + type: object + GoogleCloudAiplatformV1FindNeighborsResponse: + description: The response message for MatchService.FindNeighbors. + type: object + properties: + nearestNeighbors: + description: The nearest neighbors of the query datapoints. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors + id: GoogleCloudAiplatformV1FindNeighborsResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs: + properties: + targetColumn: type: string description: >- - The service account that the runtime workload runs as. You can use - any service account within the same project, but you must have the - service account user permission to use the instance. If not - specified, the [Compute Engine default service - account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) - is used. - networkSpec: - description: Optional. Network spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' - createTime: - format: google-datetime + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + contextWindow: type: string - readOnly: true + format: int64 description: >- - Output only. Timestamp when this NotebookRuntimeTemplate was - created. - idleShutdownConfig: + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. + exportEvaluatedDataItemsConfig: description: >- - The idle shutdown configuration of NotebookRuntimeTemplate. This - config will only be set when idle shutdown is enabled. + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig - etag: - type: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - dataPersistentDiskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + enableProbabilisticInference: description: >- - Optional. The specification of persistent disk attached to the - runtime as data disk storage. - updateTime: + If probabilistic inference is enabled, the model will fit a + distribution that captures the uncertainty of a prediction. At + inference time, the predictive distribution is used to make a point + prediction that minimizes the optimization objective. For example, + the mean of a predictive distribution is the point prediction that + minimizes RMSE loss. If quantiles are specified, then the quantiles + of the distribution are also returned. The optimization objective + cannot be minimize-quantile-loss. + type: boolean + validationOptions: type: string description: >- - Output only. Timestamp when this NotebookRuntimeTemplate was most - recently updated. - readOnly: true - format: google-datetime - networkTags: - description: >- - Optional. The Compute Engine tags to add to runtime (see [Tagging - instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + quantiles: items: - type: string - type: array - type: object - id: GoogleCloudAiplatformV1NotebookRuntimeTemplate - description: >- - A template that specifies runtime configurations such as machine type, - runtime version, network configurations, etc. Multiple runtimes can be - created from a runtime template. - GoogleCloudAiplatformV1Feature: - id: GoogleCloudAiplatformV1Feature - description: >- - Feature Metadata information. For example, color is a feature that - describes an apple. - properties: - labels: - type: object + format: double + type: number description: >- - Optional. The labels with user-defined metadata to organize your - Features. Label keys and values can be no longer than 64 characters - (Unicode codepoints), can only contain lowercase letters, numeric - characters, underscores and dashes. International characters are - allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one Feature (System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - additionalProperties: - type: string - createTime: - readOnly: true + Quantiles to use for minimize-quantile-loss + `optimization_objective`, or for probabilistic inference. Up to 5 + quantiles are allowed of values between 0 and 1, exclusive. Required + if the value of optimization_objective is minimize-quantile-loss. + Represents the percent quantiles to use for that objective. + Quantiles must be unique. + type: array + weightColumn: description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - Timestamp when this EntityType was created. + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. type: string - format: google-datetime - versionColumnName: + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. type: string - description: >- - Only applicable for Vertex AI Feature Store. The name of the - BigQuery Table/View column hosting data for this version. If no - value is provided, will use feature_id. - valueType: - enumDescriptions: - - The value type is unspecified. - - Used for Feature that is a boolean. - - Used for Feature that is a list of boolean. - - Used for Feature that is double. - - Used for Feature that is a list of double. - - Used for Feature that is INT64. - - Used for Feature that is a list of INT64. - - Used for Feature that is string. - - Used for Feature that is a list of String. - - Used for Feature that is bytes. - - Used for Feature that is struct. - description: >- - Immutable. Only applicable for Vertex AI Feature Store (Legacy). - Type of Feature value. - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - BOOL_ARRAY - - DOUBLE - - DOUBLE_ARRAY - - INT64 - - INT64_ARRAY - - STRING - - STRING_ARRAY - - BYTES - - STRUCT + trainBudgetMilliNodeHours: + format: int64 type: string - disableMonitoring: - type: boolean description: >- - Optional. Only applicable for Vertex AI Feature Store (Legacy). If - not set, use the monitoring_config defined for the EntityType this - Feature belongs to. Only Features with type (Feature.ValueType) - BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, - all types of data monitoring are disabled despite the config on - EntityType. - etag: + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. + unavailableAtForecastColumns: + items: + type: string description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - type: string - description: + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. + type: array + timeColumn: type: string - description: Description of the Feature. - updateTime: - readOnly: true description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - Timestamp when this EntityType was most recently updated. - format: google-datetime - type: string - name: + The name of the column that identifies time order in the time + series. This column must be available at forecast. + additionalExperiments: + items: + type: string + type: array + description: Additional experiment flags for the time series forcasting training. + optimizationObjective: type: string 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. - monitoringStatsAnomalies: - description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - The list of historical stats and anomalies with specified - objectives. - readOnly: true + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. + transformations: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly - type: array - pointOfContact: - type: string + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation description: >- - Entity responsible for maintaining this feature. Can be comma - separated list of email addresses or URIs. - type: object - GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies: - properties: - threshold: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - description: Threshold for anomaly detection. - predictionStats: + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. + type: array + availableAtForecastColumns: + items: + type: string + type: array description: >- - A list of historical stats generated by different time window's - Prediction Dataset. + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. + windowConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + description: Config containing strategy for generating sliding windows. + holidayRegions: type: array + description: >- + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - trainingStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - description: Stats calculated for the Training Dataset. - featureDisplayName: - description: Display Name of the Feature. - type: string - description: Historical Stats (and Anomalies) for a specific Feature. - type: object - id: >- - GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies - GoogleCloudAiplatformV1ReservationAffinity: - description: >- - A ReservationAffinity can be used to configure a Vertex AI resource - (e.g., a DeployedModel) to draw its Compute Engine resources from a - Shared Reservation, or exclusively from on-demand capacity. - id: GoogleCloudAiplatformV1ReservationAffinity - properties: - key: + type: string + hierarchyConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig description: >- - Optional. Corresponds to the label key of a reservation resource. To - target a SPECIFIC_RESERVATION by name, use - `compute.googleapis.com/reservation-name` as the key and specify the - name of your reservation as its value. - type: string - reservationAffinityType: - enumDescriptions: - - Default value. This should not be used. - - Do not consume from any reserved capacity, only use on-demand. - - Consume any reservation available, falling back to on-demand. - - >- - Consume from a specific reservation. When chosen, the reservation - must be identified via the `key` and `values` fields. - enum: - - TYPE_UNSPECIFIED - - NO_RESERVATION - - ANY_RESERVATION - - SPECIFIC_RESERVATION + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + dataGranularity: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + description: Expected difference in time granularity between rows in the data. + forecastHorizon: type: string - description: Required. Specifies the reservation affinity type. - values: + format: int64 description: >- - Optional. Corresponds to the label values of a reservation resource. - This must be the full resource name of the reservation. + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. + timeSeriesAttributeColumns: items: type: string type: array + description: >- + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs + GoogleCloudAiplatformV1RebootPersistentResourceRequest: + id: GoogleCloudAiplatformV1RebootPersistentResourceRequest + description: Request message for PersistentResourceService.RebootPersistentResource. + type: object + properties: {} + GoogleCloudAiplatformV1ToolNameMatchInstance: + description: Spec for tool name match instance. + id: GoogleCloudAiplatformV1ToolNameMatchInstance type: object - GoogleCloudAiplatformV1StratifiedSplit: properties: - key: - description: >- - Required. The key is a name of one of the Dataset's data columns. - The key provided must be for a categorical column. + reference: + description: Required. Ground truth used to compare against the prediction. + type: string + prediction: + description: Required. Output of the evaluated model. + type: string + GoogleCloudAiplatformV1SchemaTextClassificationAnnotation: + properties: + displayName: type: string - trainingFraction: - description: >- - The fraction of the input data that is to be used to train the - Model. - type: number - format: double - testFraction: - type: number - format: double description: >- - The fraction of the input data that is to be used to evaluate the - Model. - validationFraction: - type: number - format: double + The display name of the AnnotationSpec that this Annotation pertains + to. + annotationSpecId: description: >- - The fraction of the input data that is to be used to validate the - Model. - id: GoogleCloudAiplatformV1StratifiedSplit - description: >- - Assigns input data to the training, validation, and test sets so that - the distribution of values found in the categorical column (as specified - by the `key` field) is mirrored within each split. The fraction values - determine the relative sizes of the splits. For example, if the - specified column has three values, with 50% of the rows having value - "A", 25% value "B", and 25% value "C", and the split fractions are - specified as 80/10/10, then the training set will constitute 80% of the - training data, with about 50% of the training set rows having the value - "A" for the specified column, about 25% having the value "B", and about - 25% having the value "C". Only the top 500 occurring values are used; - any values not in the top 500 values are randomly assigned to a split. - If less than three rows contain a specific value, those rows are - randomly assigned. Supported only for tabular Datasets. - type: object - GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams: + The resource Id of the AnnotationSpec that this Annotation pertains + to. + type: string type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams - description: Prediction model parameters for Image Classification. + description: Annotation details specific to text classification. + id: GoogleCloudAiplatformV1SchemaTextClassificationAnnotation + GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies: + description: Statistics and anomalies generated by Model Monitoring. properties: - maxPredictions: - description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. If this number is very high, the Model may - return fewer predictions. Default value is 10. - type: integer - format: int32 - confidenceThreshold: - description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - format: float - type: number - GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest: - id: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest - properties: - names: - description: >- - Required. The names of the PipelineJobs to delete. A maximum of 32 - PipelineJobs can be deleted in a batch. Format: - `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` - items: - type: string + featureStats: + description: A list of historical Stats and Anomalies generated for all Features. type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies + objective: + enumDescriptions: + - Default value, should not be set. + - >- + Raw feature values' stats to detect skew between + Training-Prediction datasets. + - >- + Raw feature values' stats to detect drift between + Serving-Prediction datasets. + - >- + Feature attribution scores to detect skew between + Training-Prediction datasets. + - >- + Feature attribution scores to detect skew between Prediction + datasets collected within different time windows. + enum: + - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED + - RAW_FEATURE_SKEW + - RAW_FEATURE_DRIFT + - FEATURE_ATTRIBUTION_SKEW + - FEATURE_ATTRIBUTION_DRIFT + description: Model Monitoring Objective those stats and anomalies belonging to. + type: string + deployedModelId: + type: string + description: Deployed Model ID. + anomalyCount: + format: int32 + type: integer + description: Number of anomalies within all stats. + id: GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies type: object - description: Request message for PipelineService.BatchDeletePipelineJobs. - GoogleCloudAiplatformV1UndeployIndexOperationMetadata: + GoogleCloudAiplatformV1LookupStudyRequest: + description: Request message for VizierService.LookupStudy. + id: GoogleCloudAiplatformV1LookupStudyRequest properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Runtime operation information for IndexEndpointService.UndeployIndex. + displayName: + description: Required. The user-defined display name of the Study + type: string type: object - id: GoogleCloudAiplatformV1UndeployIndexOperationMetadata - GoogleCloudAiplatformV1DataItem: + GoogleCloudAiplatformV1ResourcePool: + id: GoogleCloudAiplatformV1ResourcePool type: object description: >- - A piece of data in a Dataset. Could be an image, a video, a document or - plain text. - id: GoogleCloudAiplatformV1DataItem + Represents the spec of a group of resources of the same type, for + example machine type, disk, and accelerators, in a PersistentResource. properties: - createTime: - description: Output only. Timestamp when this DataItem was created. - format: google-datetime + machineSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + description: Required. Immutable. The specification of a single machine. + usedReplicaCount: + format: int64 type: string readOnly: true - payload: - type: any - description: >- - Required. The data that the DataItem represents (for example, an - image or a text snippet). The schema of the payload is stored in the - parent Dataset's metadata schema's dataItemSchemaUri field. - etag: - type: string description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - labels: - additionalProperties: - type: string + Output only. The number of machines currently in use by training + jobs for this resource pool. Will replace idle_replica_count. + diskSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + description: Optional. Disk spec for the machine in this node pool. + id: description: >- - Optional. The labels with user-defined metadata to organize your - DataItems. Label keys and values can be no longer than 64 characters - (Unicode codepoints), can only contain lowercase letters, numeric - characters, underscores and dashes. International characters are - allowed. No more than 64 user labels can be associated with one - DataItem(System labels are excluded). See https://goo.gl/xmQnxf for - more information and examples of labels. System reserved label keys - are prefixed with "aiplatform.googleapis.com/" and are immutable. - type: object - updateTime: + Immutable. The unique ID in a PersistentResource for referring to + this resource pool. User can specify it if necessary. Otherwise, + it's generated automatically. type: string - readOnly: true - format: google-datetime - description: Output only. Timestamp when this DataItem was last updated. - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean - readOnly: true - name: - description: Output only. The resource name of the DataItem. - readOnly: true + replicaCount: type: string - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: + description: >- + Optional. The total number of machines to use for this resource + pool. + format: int64 + autoscalingSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec + description: >- + Optional. Optional spec to configure GKE or Ray-on-Vertex + autoscaling + GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata: + description: Details of operations that perform update Tensorboard. properties: - shouldStop: - description: True if the Trial should stop. - type: boolean - description: Response message for VizierService.CheckTrialEarlyStoppingState. - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Tensorboard. + type: object + id: GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata + GoogleCloudAiplatformV1ListMetadataSchemasResponse: + description: Response message for MetadataService.ListMetadataSchemas. + id: GoogleCloudAiplatformV1ListMetadataSchemasResponse type: object - GoogleCloudAiplatformV1ManualBatchTuningParameters: properties: - batchSize: + metadataSchemas: + description: The MetadataSchemas found for the MetadataStore. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + nextPageToken: description: >- - Immutable. The number of the records (e.g. instances) of the - operation given in each batch to a machine replica. Machine type, - and size of a single record should be considered when setting this - parameter, higher value speeds up the batch operation's execution, - but too high value will result in a whole batch not fitting in a - machine's memory, and the whole operation will fail. The default - value is 64. - type: integer - format: int32 - description: Manual batch tuning parameters. - type: object - id: GoogleCloudAiplatformV1ManualBatchTuningParameters - GoogleCloudAiplatformV1DeleteFeatureValuesRequest: + A token, which can be sent as ListMetadataSchemasRequest.page_token + to retrieve the next page. If this field is not populated, there are + no subsequent pages. + type: string + GoogleCloudAiplatformV1BigQuerySource: properties: - selectEntity: - description: Select feature values to be deleted by specifying entities. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity - selectTimeRangeAndFeature: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature + inputUri: description: >- - Select feature values to be deleted by specifying time range and - features. + Required. BigQuery URI to a table, up to 2000 characters long. + Accepted forms: * BigQuery path. For example: + `bq://projectId.bqDatasetId.bqTableId`. + type: string + description: The BigQuery location for the input content. type: object - id: GoogleCloudAiplatformV1DeleteFeatureValuesRequest - description: Request message for FeaturestoreService.DeleteFeatureValues. - GoogleCloudAiplatformV1Event: - id: GoogleCloudAiplatformV1Event + id: GoogleCloudAiplatformV1BigQuerySource + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue: + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue + description: Single value that supports strings and floats. + properties: + stringValue: + description: String type. + type: string + floatValue: + format: float + type: number + description: Float type. type: object - description: >- - An edge describing the relationship between an Artifact and an Execution - in a lineage graph. + GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance: + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance + description: Prediction input format for Text Sentiment. properties: - labels: + mimeType: description: >- - The labels with user-defined metadata to annotate Events. Label keys - and values can be no longer than 64 characters (Unicode codepoints), - can only contain lowercase letters, numeric characters, underscores - and dashes. International characters are allowed. No more than 64 - user labels can be associated with one Event (System labels are - excluded). See https://goo.gl/xmQnxf for more information and - examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - type: object - additionalProperties: - type: string - eventTime: + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain type: string - format: google-datetime - readOnly: true - description: Output only. Time the Event occurred. - artifact: + content: type: string - description: Required. The relative resource name of the Artifact in the Event. - type: - description: Required. The type of the Event. + description: The text snippet to make the predictions on. + GoogleCloudAiplatformV1TokensInfo: + properties: + tokenIds: + items: + format: int64 + type: string + description: A list of token ids from the input. + type: array + tokens: + description: A list of tokens from the input. + items: + type: string + format: byte + type: array + role: type: string - enumDescriptions: - - Unspecified whether input or output of the Execution. - - An input of the Execution. - - An output of the Execution. - enum: - - TYPE_UNSPECIFIED - - INPUT - - OUTPUT - execution: description: >- - Output only. The relative resource name of the Execution in the - Event. - type: string - readOnly: true - GoogleCloudAiplatformV1PairwiseMetricInstance: + Optional. Optional fields for the role from the corresponding + Content. + id: GoogleCloudAiplatformV1TokensInfo description: >- - Pairwise metric instance. Usually one instance corresponds to one row in - an evaluation dataset. - id: GoogleCloudAiplatformV1PairwiseMetricInstance + Tokens info with a list of tokens and the corresponding list of token + ids. type: object + GoogleCloudAiplatformV1SafetyResult: + type: object + description: Spec for safety result. + id: GoogleCloudAiplatformV1SafetyResult properties: - jsonInstance: - description: >- - Instance specified as a json string. String key-value pairs are - expected in the json_instance to render - PairwiseMetricSpec.instance_prompt_template. - type: string - GoogleCloudAiplatformV1HyperparameterTuningJob: - properties: - name: + score: + readOnly: true + format: float + description: Output only. Safety score. + type: number + explanation: type: string + description: Output only. Explanation for safety score. readOnly: true - description: Output only. Resource name of the HyperparameterTuningJob. - trialJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: >- - Required. The spec of a trial job. The same spec applies to the - CustomJobs created in all the trials. - error: + confidence: + type: number readOnly: true + format: float + description: Output only. Confidence for safety score. + GoogleCloudAiplatformV1SchemaTextDatasetMetadata: + type: object + properties: + gcsBucket: description: >- - Output only. Only populated when job's state is JOB_STATE_FAILED or - JOB_STATE_CANCELLED. - $ref: '#/components/schemas/GoogleRpcStatus' - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - description: Required. Study configuration of the HyperparameterTuningJob. - updateTime: + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. type: string - format: google-datetime - readOnly: true + dataItemSchemaUri: description: >- - Output only. Time when the HyperparameterTuningJob was most recently - updated. - createTime: - description: Output only. Time when the HyperparameterTuningJob was created. - format: google-datetime + Points to a YAML file stored on Google Cloud Storage describing + payload of the Text DataItems that belong to this Dataset. type: string + id: GoogleCloudAiplatformV1SchemaTextDatasetMetadata + description: The metadata of Datasets that contain Text DataItems. + GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: + id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureOnlineStore. + type: object + description: Details of operations that perform update FeatureOnlineStore. + GoogleCloudAiplatformV1Segment: + properties: + startIndex: readOnly: true - trials: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - readOnly: true - description: Output only. Trials of the HyperparameterTuningJob. - type: array - maxTrialCount: - type: integer format: int32 - description: Required. The desired total number of Trials. - labels: description: >- - The labels with user-defined metadata to organize - HyperparameterTuningJobs. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - type: object - additionalProperties: - type: string - satisfiesPzs: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - state: - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - readOnly: true - description: Output only. The detailed state of the job. - type: string - maxFailedTrialCount: + Output only. Start index in the given Part, measured in bytes. + Offset from the start of the Part, inclusive, starting at zero. type: integer + endIndex: description: >- - The number of failed Trials that need to be seen before failing the - HyperparameterTuningJob. If set to 0, Vertex AI decides how many - Trials must fail before the whole job fails. - format: int32 - endTime: - format: google-datetime - type: string - description: >- - Output only. Time when the HyperparameterTuningJob entered any of - the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - readOnly: true - satisfiesPzi: + Output only. End index in the given Part, measured in bytes. Offset + from the start of the Part, exclusive, starting at zero. readOnly: true - type: boolean - description: Output only. Reserved for future use. - displayName: - description: >- - Required. The display name of the HyperparameterTuningJob. The name - can be up to 128 characters long and can consist of any UTF-8 - characters. + type: integer + format: int32 + text: type: string - encryptionSpec: - description: >- - Customer-managed encryption key options for a - HyperparameterTuningJob. If this is set, then all resources created - by the HyperparameterTuningJob will be encrypted with the provided - encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - startTime: readOnly: true - type: string - format: google-datetime description: >- - Output only. Time when the HyperparameterTuningJob for the first - time entered the `JOB_STATE_RUNNING` state. - parallelTrialCount: + Output only. The text corresponding to the segment from the + response. + partIndex: type: integer - description: Required. The desired number of Trials to run in parallel. + description: >- + Output only. The index of a Part object within its parent Content + object. format: int32 - id: GoogleCloudAiplatformV1HyperparameterTuningJob + readOnly: true + description: Segment of the content. + id: GoogleCloudAiplatformV1Segment type: object - description: >- - Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a - Study specification and multiple CustomJobs with identical CustomJob - specification. - GoogleCloudAiplatformV1DeleteOperationMetadata: - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1DeleteOperationMetadata + GoogleCloudAiplatformV1FeatureViewSyncConfig: + id: GoogleCloudAiplatformV1FeatureViewSyncConfig type: object - description: Details of operations that perform deletes of any entities. - GoogleCloudAiplatformV1ThresholdConfig: - description: The config for feature monitoring threshold. + description: Configuration for Sync. Only one option is set. properties: - value: - format: double - type: number + cron: description: >- - Specify a threshold value that can trigger the alert. If this - threshold config is for feature distribution distance: 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. Each feature - must have a non-zero threshold if they need to be monitored. - Otherwise no alert will be triggered for that feature. + Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch + scheduled runs. To explicitly set a timezone to the cron tab, apply + a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * + * *". + type: string + GoogleCloudAiplatformV1DedicatedResources: type: object - id: GoogleCloudAiplatformV1ThresholdConfig - GoogleCloudAiplatformV1FractionSplit: - description: >- - Assigns the input data to training, validation, and test sets as per the - given fractions. Any of `training_fraction`, `validation_fraction` and - `test_fraction` may optionally be provided, they must sum to up to 1. If - the provided ones sum to less than 1, the remainder is assigned to sets - as decided by Vertex AI. If none of the fractions are set, by default - roughly 80% of data is used for training, 10% for validation, and 10% - for test. properties: - trainingFraction: - format: double + maxReplicaCount: + format: int32 + type: integer description: >- - The fraction of the input data that is to be used to train the - Model. - type: number - validationFraction: - type: number - format: double + Immutable. The maximum number of replicas this DeployedModel 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 the model to that many replicas + is guaranteed (barring service outages). If traffic against the + DeployedModel 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). + machineSpec: description: >- - The fraction of the input data that is to be used to validate the - Model. - testFraction: - format: double - type: number + Required. Immutable. The specification of a single machine used by + the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + spot: + type: boolean description: >- - The fraction of the input data that is to be used to evaluate the - Model. - type: object - id: GoogleCloudAiplatformV1FractionSplit - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec: - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec - properties: - configs: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + Optional. If true, schedule the deployment workload on [spot + VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). + autoscalingMetricSpecs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoscalingMetricSpec' description: >- - Mapping configuration for this SliceSpec. The key is the name of the - feature. By default, the key will be prefixed by "instance" as a - dictionary prefix for Vertex Batch Predictions output format. - type: object - description: Specification for how the data should be sliced. - type: object - GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem: - properties: - annotationResourceName: - type: string + Immutable. The metric specifications that overrides a resource + utilization metric (CPU utilization, accelerator's duty cycle, and + so on) target value (default to 60 if not set). At most one entry is + allowed per metric. If machine_spec.accelerator_count is above 0, + the autoscaling will be based on both CPU utilization and + accelerator's duty cycle metrics and scale up when either metrics + exceeds its target value while scale down if both metrics are under + their target value. The default target value is 60 for both metrics. + If machine_spec.accelerator_count is 0, the autoscaling will be + based on CPU utilization metric only with default target value 60 if + not explicitly set. For example, in the case of Online Prediction, + if you want to override target CPU utilization to 80, you should set + autoscaling_metric_specs.metric_name to + `aiplatform.googleapis.com/prediction/online/cpu/utilization` and + autoscaling_metric_specs.target to `80`. + type: array + minReplicaCount: + format: int32 + type: integer description: >- - The unique ID for each annotation. Used by FE to allocate the - annotation in DB. - distance: - type: number - description: The distance of this item to the annotation. - format: double - type: object + Required. Immutable. The minimum number of machine replicas this + DeployedModel will be always deployed on. This value must be greater + than or equal to 1. If traffic against the DeployedModel increases, + it may dynamically be deployed onto more replicas, and as traffic + decreases, some of these extra replicas may be freed. description: >- - Attributed items for a given annotation, typically representing - neighbors from the training sets constrained by the query type. - id: GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem - GoogleCloudAiplatformV1FeatureView: + A description of resources that are dedicated to a DeployedModel, and + that need a higher degree of manual configuration. + id: GoogleCloudAiplatformV1DedicatedResources + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation: + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation properties: - satisfiesPzs: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - createTime: - description: Output only. Timestamp when this FeatureView was created. - readOnly: true - type: string - format: google-datetime - etag: - type: string - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - satisfiesPzi: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - labels: - description: >- - Optional. The labels with user-defined metadata to organize your - FeatureViews. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one FeatureOnlineStore(System labels are excluded)." System - reserved label keys are prefixed with "aiplatform.googleapis.com/" - and are immutable. - additionalProperties: - type: string - type: object - bigQuerySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewBigQuerySource - description: >- - Optional. Configures how data is supposed to be extracted from a - BigQuery source to be loaded onto the FeatureOnlineStore. - name: - description: >- - Identifier. Name of the FeatureView. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` - type: string - updateTime: - readOnly: true - description: Output only. Timestamp when this FeatureView was last updated. - format: google-datetime + columnName: type: string - featureRegistrySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource - description: >- - Optional. Configures the features from a Feature Registry source - that need to be loaded onto the FeatureOnlineStore. - indexConfig: - description: >- - Optional. Configuration for index preparation for vector search. It - contains the required configurations to create an index from source - data, so that approximate nearest neighbor (a.k.a ANN) algorithms - search can be performed during online serving. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfig' - vertexRagSource: - description: Optional. The Vertex RAG Source that the FeatureView is linked to. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewVertexRagSource - syncConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncConfig' - description: >- - Configures when data is to be synced/updated for this FeatureView. - At the end of the sync the latest featureValues for each entityId of - this FeatureView are made ready for online serving. - description: >- - FeatureView is representation of values that the FeatureOnlineStore will - serve based on its syncConfig. - type: object - id: GoogleCloudAiplatformV1FeatureView - GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata: - type: object - id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata - properties: {} - GoogleCloudAiplatformV1ImportDataConfig: type: object + GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse: + id: GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + description: Response message for TensorboardService.ReadTensorboardTimeSeriesData. properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: The Google Cloud Storage location for the input content. - importSchemaUri: - type: string - description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing the import format. Validation will be done against the - schema. The schema is defined as an [OpenAPI 3.0.2 Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - dataItemLabels: - type: object - description: >- - Labels that will be applied to newly imported DataItems. If an - identical DataItem as one being imported already exists in the - Dataset, then these labels will be appended to these of the already - existing one, and if labels with identical key is imported before, - the old label value will be overwritten. If two DataItems are - identical in the same import data operation, the labels will be - combined and if key collision happens in this case, one of the - values will be picked randomly. Two DataItems are considered - identical if their content bytes are identical (e.g. image bytes or - pdf bytes). These labels will be overridden by Annotation labels - specified inside index file referenced by import_schema_uri, e.g. - jsonl file. - additionalProperties: - type: string - annotationLabels: - type: object - description: >- - Labels that will be applied to newly imported Annotations. If two - Annotations are identical, one of them will be deduped. Two - Annotations are considered identical if their payload, - payload_schema_uri and all of their labels are the same. These - labels will be overridden by Annotation labels specified inside - index file referenced by import_schema_uri, e.g. jsonl file. - additionalProperties: - type: string - id: 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. - GoogleCloudAiplatformV1StartNotebookRuntimeRequest: - properties: {} - id: GoogleCloudAiplatformV1StartNotebookRuntimeRequest + timeSeriesData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + description: The returned time series data. type: object - description: Request message for NotebookService.StartNotebookRuntime. - GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec: - description: Value specification for a parameter in `DOUBLE` type. + GoogleCloudAiplatformV1ExplanationSpecOverride: properties: - defaultValue: - format: double - type: number + examplesOverride: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesOverride' + description: The example-based explanations parameter overrides. + parameters: description: >- - A default value for a `DOUBLE` parameter that is assumed to be a - relatively good starting point. Unset value signals that there is no - offered starting point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - maxValue: - type: number - description: Required. Inclusive maximum value of the parameter. - format: double - minValue: - format: double - type: number - description: Required. Inclusive minimum value of the parameter. + The parameters to be overridden. Note that the attribution method + cannot be changed. If not specified, no parameter is overridden. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverride + description: >- + The metadata to be overridden. If not specified, no metadata is + overridden. + id: GoogleCloudAiplatformV1ExplanationSpecOverride type: object - id: GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + description: >- + The ExplanationSpec entries that can be overridden at online explanation + time. GoogleCloudAiplatformV1ExactMatchSpec: - properties: {} type: object description: >- Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. id: GoogleCloudAiplatformV1ExactMatchSpec - GoogleCloudAiplatformV1ModelDeploymentMonitoringJob: - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + properties: {} + GoogleCloudAiplatformV1Model: + id: GoogleCloudAiplatformV1Model + description: A trained machine learning Model. properties: displayName: - description: >- - Required. The user-defined name of the ModelDeploymentMonitoringJob. - The name can be up to 128 characters long and can consist of any - UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. type: string - samplePredictInstance: - description: >- - Sample Predict instance, same format as PredictRequest.instances, - this can be set as a replacement of - ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not - set, we will generate predict schema from collected predict - requests. - type: any - bigqueryTables: - readOnly: true - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable - type: array description: >- - Output only. The created bigquery tables for the job under customer - project. Customer could do their own query & analysis. There could - be 4 log tables in maximum: 1. Training data logging predict - request/response 2. Serving data logging predict request/response - nextScheduleTime: - type: string + Required. The display name of the Model. The name can be up to 128 + characters long and can consist of any UTF-8 characters. + versionUpdateTime: readOnly: true - description: >- - Output only. Timestamp when this monitoring pipeline will be - scheduled to run for the next round. format: google-datetime - satisfiesPzi: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - scheduleState: - enumDescriptions: - - Unspecified state. - - The pipeline is picked up and wait to run. - - The pipeline is offline and will be scheduled for next run. - - The pipeline is running. - description: >- - Output only. Schedule state when the monitoring job is in Running - state. - readOnly: true - type: string - enum: - - MONITORING_SCHEDULE_STATE_UNSPECIFIED - - PENDING - - OFFLINE - - RUNNING - predictInstanceSchemaUri: - description: >- - YAML schema file uri describing the format of a single instance, - which are given to format this Endpoint's prediction (and - explanation). If not set, we will generate predict schema from - collected predict requests. type: string - logTtl: - format: google-duration + description: Output only. Timestamp when this version was most recently updated. + pipelineJob: type: string description: >- - The TTL of BigQuery tables in user projects which stores logs. A day - is the basic unit of the TTL and we take the ceil of TTL/86400(a - day). e.g. { second: 3600} indicates ttl = 1 day. - satisfiesPzs: - description: Output only. Reserved for future use. - type: boolean + Optional. This field is populated if the model is produced by a + pipeline job. + deployedModels: readOnly: true - state: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' description: >- - Output only. The detailed state of the monitoring job. When the job - is still creating, the state will be 'PENDING'. Once the job is - successfully created, the state will be 'RUNNING'. Pause the job, - the state will be 'PAUSED'. Resume the job, the state will return to - 'RUNNING'. - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. + Output only. The pointers to DeployedModels created from this Model. + Note that Model could have been deployed to Endpoints in different + Locations. + metadataArtifact: readOnly: true - type: string - statsAnomaliesBaseDirectory: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Stats anomalies base folder path. - modelDeploymentMonitoringScheduleConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig - description: Required. Schedule config for running the monitoring job. - endpoint: - type: string description: >- - Required. Endpoint resource name. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}` - modelMonitoringAlertConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfig - description: Alert config for model monitoring. - latestMonitoringPipelineMetadata: - description: Output only. Latest triggered monitoring pipeline metadata. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata - readOnly: true + Output only. The resource name of the Artifact that was created in + MetadataStore when creating the Model. The Artifact resource name + pattern is + `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + type: string encryptionSpec: - description: >- - Customer-managed encryption key spec for a - ModelDeploymentMonitoringJob. If set, this - ModelDeploymentMonitoringJob and all sub-resources of this - ModelDeploymentMonitoringJob will be secured by this key. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - labels: - type: object description: >- - The labels with user-defined metadata to organize your - ModelDeploymentMonitoringJob. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - additionalProperties: - type: string - analysisInstanceSchemaUri: + Customer-managed encryption key spec for a Model. If set, this Model + and all sub-resources of this Model will be secured by this key. + modelSourceInfo: description: >- - YAML schema file uri describing the format of a single instance that - you want Tensorflow Data Validation (TFDV) to analyze. If this field - is empty, all the feature data types are inferred from - predict_instance_schema_uri, meaning that TFDV will use the data in - the exact format(data type) as prediction request/response. If there - are any data type differences between predict instance and TFDV - instance, this field can be used to override the schema. For models - trained with Vertex AI, this field must be set as all the fields in - predict instance formatted as string. - type: string - loggingSamplingStrategy: - description: Required. Sample Strategy for logging. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' - name: - description: Output only. Resource name of a ModelDeploymentMonitoringJob. + Output only. Source of a model. It can either be automl training + pipeline, custom training pipeline, BigQuery ML, or saved and tuned + from Genie or Model Garden. readOnly: true - type: string - enableMonitoringPipelineLogs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelSourceInfo' + satisfiesPzi: type: boolean + readOnly: true + description: Output only. Reserved for future use. + etag: description: >- - If true, the scheduled monitoring pipeline logs are sent to Google - Cloud Logging, including pipeline status and anomalies detected. - Please note the logs incur cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging#pricing). - updateTime: - format: google-datetime - description: >- - Output only. Timestamp when this ModelDeploymentMonitoringJob was - updated most recently. + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string - readOnly: true - error: - readOnly: true + explanationSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' description: >- - Output only. Only populated when the job's state is - `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' - createTime: + The default explanation specification for this Model. The Model can + be used for requesting explanation after being deployed if it is + populated. The Model can be used for batch explanation if it is + populated. All fields of the explanation_spec can be overridden by + explanation_spec of DeployModelRequest.deployed_model, or + explanation_spec of BatchPredictionJob. If the default explanation + specification is not set for this Model, this Model can still be + used for requesting explanation by setting explanation_spec of + DeployModelRequest.deployed_model and for batch explanation by + setting explanation_spec of BatchPredictionJob. + versionCreateTime: + description: Output only. Timestamp when this version was created. type: string format: google-datetime readOnly: true + trainingPipeline: + readOnly: true + type: string description: >- - Output only. Timestamp when this ModelDeploymentMonitoringJob was - created. - modelDeploymentMonitoringObjectiveConfigs: + Output only. The resource name of the TrainingPipeline that uploaded + this Model, if any. + containerSpec: description: >- - Required. The config for monitoring objectives. This is a per - DeployedModel config. Each DeployedModel needs to be configured - separately. + 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. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' + artifactUri: + type: string + description: >- + Immutable. The path to the directory containing the Model artifact + and any of its supporting files. Not required for AutoML Models. + description: + type: string + description: The description of the Model. + versionDescription: + type: string + description: The description of this version. + metadataSchemaUri: + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Model, that is specific + to it. Unset if the Model does not have any additional information. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI, if no + additional metadata is needed, this field is set to an empty string. + Note: The URI given on output will be immutable and probably + different, including the URI scheme, than the one given on input. + The output URI will point to a location where the user only has a + read access. + type: string + metadata: + description: >- + Immutable. An additional information about the Model; the schema of + the metadata can be found in metadata_schema. Unset if the Model + does not have any additional information. + type: any + versionAliases: + type: array + items: + type: string + description: >- + User provided version aliases so that a model version can be + referenced via alias (i.e. + `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` + instead of auto-generated version id (i.e. + `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. + The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A + default version alias will be created for the first version of the + model, and there must be exactly one default version alias for a + model. + originalModelInfo: + description: >- + Output only. If this Model is a copy of another Model, this contains + info about the original. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelOriginalModelInfo' + readOnly: true + predictSchemata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + description: >- + The schemata that describe formats of the Model's predictions and + explanations as given and returned via PredictionService.Predict and + PredictionService.Explain. + supportedInputStorageFormats: + readOnly: true + description: >- + Output only. The formats this Model supports in + BatchPredictionJob.input_config. If + PredictSchemata.instance_schema_uri exists, the instances should be + given as per that schema. The possible formats are: * `jsonl` The + JSON Lines format, where each instance is a single line. Uses + GcsSource. * `csv` The CSV format, where each instance is a single + comma-separated line. The first line in the file is the header, + containing comma-separated field names. Uses GcsSource. * + `tf-record` The TFRecord format, where each instance is a single + record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` + Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * + `bigquery` Each instance is a single row in BigQuery. Uses + BigQuerySource. * `file-list` Each line of the file is the location + of an instance to process, uses `gcs_source` field of the + InputConfig object. If this Model doesn't support any of these + formats it means it cannot be used with a BatchPredictionJob. + However, if it has supported_deployment_resources_types, it could + serve online predictions by using PredictionService.Predict or + PredictionService.Explain. + type: array + items: + type: string + versionId: + type: string + readOnly: true + description: >- + Output only. Immutable. The version ID of the model. A new version + is committed when a new model version is uploaded or trained under + an existing model id. It is an auto-incrementing decimal number in + string representation. + labels: + description: >- + The labels with user-defined metadata to organize your Models. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object + additionalProperties: + type: string + baseModelSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelBaseModelSource' + description: >- + Optional. User input field to specify the base model source. + Currently it only supports specifing the Model Garden models and + Genie models. + supportedDeploymentResourcesTypes: + type: array + readOnly: true + items: + type: string + enum: + - DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED + - DEDICATED_RESOURCES + - AUTOMATIC_RESOURCES + - SHARED_RESOURCES + enumDescriptions: + - Should not be used. + - >- + Resources that are dedicated to the DeployedModel, and that need + a higher degree of manual configuration. + - >- + Resources that to large degree are decided by Vertex AI, and + require only a modest additional configuration. + - >- + Resources that can be shared by multiple DeployedModels. A + pre-configured DeploymentResourcePool is required. + description: >- + Output only. When this Model is deployed, its prediction resources + are described by the `prediction_resources` field of the + Endpoint.deployed_models object. Because not all Models support all + resource configuration types, the configuration types this Model + supports are listed here. If no configuration types are listed, the + Model cannot be deployed to an Endpoint and does not support online + predictions (PredictionService.Predict or + PredictionService.Explain). Such a Model can serve predictions by + using a BatchPredictionJob, if it has at least one entry each in + supported_input_storage_formats and + supported_output_storage_formats. + dataStats: + description: >- + Stats of data used for training or evaluating the Model. Only + populated when the Model is trained by a TrainingPipeline with + data_input_config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' + updateTime: + type: string + readOnly: true + format: google-datetime + description: Output only. Timestamp when this Model was most recently updated. + satisfiesPzs: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + supportedExportFormats: + description: >- + Output only. The formats in which this Model may be exported. If + empty, this Model is not available for export. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExportFormat' + name: + description: The resource name of the Model. + type: string + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. Timestamp when this Model was uploaded into Vertex AI. + supportedOutputStorageFormats: + description: >- + Output only. The formats this Model supports in + BatchPredictionJob.output_config. If both + PredictSchemata.instance_schema_uri and + PredictSchemata.prediction_schema_uri exist, the predictions are + returned together with their instances. In other words, the + prediction has the original instance data first, followed by the + actual prediction content (as per the schema). The possible formats + are: * `jsonl` The JSON Lines format, where each prediction is a + single line. Uses GcsDestination. * `csv` The CSV format, where each + prediction is a single comma-separated line. The first line in the + file is the header, containing comma-separated field names. Uses + GcsDestination. * `bigquery` Each prediction is a single row in a + BigQuery table, uses BigQueryDestination . If this Model doesn't + support any of these formats it means it cannot be used with a + BatchPredictionJob. However, if it has + supported_deployment_resources_types, it could serve online + predictions by using PredictionService.Predict or + PredictionService.Explain. + items: + type: string + type: array + readOnly: true + type: object + GoogleCloudAiplatformV1BatchCreateFeaturesResponse: + type: object + id: GoogleCloudAiplatformV1BatchCreateFeaturesResponse + properties: + features: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: The Features created. + type: array + description: Response message for FeaturestoreService.BatchCreateFeatures. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + properties: + columnName: + type: string + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + type: object + GoogleCloudAiplatformV1DiskSpec: + id: GoogleCloudAiplatformV1DiskSpec + description: Represents the spec of disk options. + properties: + bootDiskType: + description: >- + Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" + (Persistent Disk Solid State Drive) or "pd-standard" (Persistent + Disk Hard Disk Drive). + type: string + bootDiskSizeGb: + format: int32 + type: integer + description: Size in GB of the boot disk (default is 100GB). + type: object + GoogleCloudAiplatformV1ToolParameterKeyMatchResults: + description: Results for tool parameter key match metric. + type: object + id: GoogleCloudAiplatformV1ToolParameterKeyMatchResults + properties: + toolParameterKeyMatchMetricValues: + description: Output only. Tool parameter key match metric values. type: array + readOnly: true items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue + GoogleCloudAiplatformV1BleuResults: + description: Results for bleu metric. + id: GoogleCloudAiplatformV1BleuResults + type: object + properties: + bleuMetricValues: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuMetricValue' + description: Output only. Bleu metric values. + readOnly: true + type: array + GoogleCloudAiplatformV1QuestionAnsweringQualityInstance: + type: object + properties: + instruction: + type: string + description: Required. Question Answering prompt for LLM. + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + context: + description: Required. Text to answer the question. + type: string + prediction: + type: string + description: Required. Output of the evaluated model. + description: Spec for question answering quality instance. + id: GoogleCloudAiplatformV1QuestionAnsweringQualityInstance + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig: description: >- - Represents a job that runs periodically to monitor the deployed models - in an endpoint. It will analyze the logged training & prediction data to - detect any abnormal behaviors. + Specification message containing the config for this SliceSpec. When + `kind` is selected as `value` and/or `range`, only a single slice will + be computed. When `all_values` is present, a separate slice will be + computed for each possible label/value for the corresponding key in + `config`. Examples, with feature zip_code with values 12345, 23334, + 88888 and feature country with values "US", "Canada", "Mexico" in the + dataset: Example 1: { "zip_code": { "value": { "float_value": 12345.0 } + } } A single slice for any data with zip_code 12345 in the dataset. + Example 2: { "zip_code": { "range": { "low": 12345, "high": 20000 } } } + A single slice containing data where the zip_codes between 12345 and + 20000 For this example, data with the zip_code of 12345 will be in this + slice. Example 3: { "zip_code": { "range": { "low": 10000, "high": 20000 + } }, "country": { "value": { "string_value": "US" } } } A single slice + containing data where the zip_codes between 10000 and 20000 has the + country "US". For this example, data with the zip_code of 12345 and + country "US" will be in this slice. Example 4: { "country": + {"all_values": { "value": true } } } Three slices are computed, one for + each unique country in the dataset. Example 5: { "country": { + "all_values": { "value": true } }, "zip_code": { "value": { + "float_value": 12345.0 } } } Three slices are computed, one for each + unique country in the dataset where the zip_code is also 12345. For this + example, data with zip_code 12345 and country "US" will be in one slice, + zip_code 12345 and country "Canada" in another slice, and zip_code 12345 + and country "Mexico" in another slice, totaling 3 slices. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + properties: + value: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue + description: >- + A unique specific value for a given feature. Example: `{ "value": { + "string_value": "12345" } }` + allValues: + type: boolean + description: >- + If all_values is set to true, then all possible labels of the keyed + feature will have another slice computed. Example: + `{"all_values":{"value":true}}` + range: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + description: >- + A range of values for a numerical feature. Example: + `{"range":{"low":10000.0,"high":50000.0}}` will capture 12345 and + 23334 in the slice. + type: object + GoogleCloudAiplatformV1Examples: + type: object + description: >- + Example-based explainability that returns the nearest neighbors from the + provided dataset. + id: GoogleCloudAiplatformV1Examples + properties: + presets: + description: >- + Simplified preset configuration, which automatically sets + configuration values based on the desired query speed-precision + trade-off and modality. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Presets' + nearestNeighborSearchConfig: + type: any + description: >- + The full configuration for the generated index, the semantics are + the same as metadata and should match + [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). + exampleGcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesExampleGcsSource' + description: The Cloud Storage input instances. + neighborCount: + format: int32 + description: The number of neighbors to return when querying for examples. + type: integer + GoogleCloudAiplatformV1ExplanationParameters: + description: Parameters to configure explaining for Model's predictions. + id: GoogleCloudAiplatformV1ExplanationParameters + type: object + properties: + integratedGradientsAttribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IntegratedGradientsAttribution + description: >- + An attribution method that computes Aumann-Shapley values taking + advantage of the model's fully differentiable structure. Refer to + this paper for more details: https://arxiv.org/abs/1703.01365 + sampledShapleyAttribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SampledShapleyAttribution + description: >- + An attribution method that approximates Shapley values for features + that contribute to the label being predicted. A sampling strategy is + used to approximate the value rather than considering all subsets of + features. Refer to this paper for model details: + https://arxiv.org/abs/1306.4265. + outputIndices: + items: + type: any + description: >- + If populated, only returns attributions that have output_index + contained in output_indices. It must be an ndarray of integers, with + the same shape of the output it's explaining. If not populated, + returns attributions for top_k indices of outputs. If neither top_k + nor output_indices is populated, returns the argmax index of the + outputs. Only applicable to Models that predict multiple outputs + (e,g, multi-class Models that predict multiple classes). + type: array + xraiAttribution: + description: >- + An attribution method that redistributes Integrated Gradients + attribution to segmented regions, taking advantage of the model's + fully differentiable structure. Refer to this paper for more + details: https://arxiv.org/abs/1906.02825 XRAI currently performs + better on natural images, like a picture of a house or an animal. If + the images are taken in artificial environments, like a lab or + manufacturing line, or from diagnostic equipment, like x-rays or + quality-control cameras, use Integrated Gradients instead. + $ref: '#/components/schemas/GoogleCloudAiplatformV1XraiAttribution' + examples: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + description: >- + Example-based explanations that returns the nearest neighbors from + the provided dataset. + topK: + description: >- + If populated, returns attributions for top K indices of outputs + (defaults to 1). Only applies to Models that predicts more than one + outputs (e,g, multi-class Models). When set to -1, returns + explanations for all outputs. + format: int32 + type: integer + GoogleCloudAiplatformV1Measurement: + properties: + stepCount: + type: string + description: >- + Output only. The number of steps the machine learning model has been + trained for. Must be non-negative. + readOnly: true + format: int64 + metrics: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MeasurementMetric' + type: array + description: >- + Output only. A list of metrics got by evaluating the objective + functions using suggested Parameter values. + readOnly: true + elapsedDuration: + readOnly: true + type: string + description: >- + Output only. Time that the Trial has been running at the point of + this Measurement. + format: google-duration + id: GoogleCloudAiplatformV1Measurement + description: >- + A message representing a Measurement of a Trial. A Measurement contains + the Metrics got by executing a Trial using suggested hyperparameter + values. + type: object + GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: + properties: + xMax: + type: number + description: The rightmost coordinate of the bounding box. + format: double + displayName: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + type: string + yMin: + type: number + description: The topmost coordinate of the bounding box. + format: double + annotationSpecId: + type: string + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + yMax: + type: number + description: The bottommost coordinate of the bounding box. + format: double + xMin: + type: number + description: The leftmost coordinate of the bounding box. + format: double + id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation + description: Annotation details specific to image object detection. + type: object + GoogleCloudAiplatformV1GroundingChunk: + id: GoogleCloudAiplatformV1GroundingChunk + description: Grounding chunk. + properties: + retrievedContext: + description: Grounding chunk from context retrieved by the retrieval tools. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GroundingChunkRetrievedContext + web: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunkWeb' + description: Grounding chunk from the web. + type: object + GoogleCloudAiplatformV1BleuMetricValue: + properties: + score: + description: Output only. Bleu score. + type: number + format: float + readOnly: true + description: Bleu metric value for an instance. + id: GoogleCloudAiplatformV1BleuMetricValue + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask: + type: object + properties: + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec + description: The input parameters of this HyperparameterTuningTask. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask + description: A TrainingJob that tunes Hypererparameters of a custom code Model. + GoogleCloudAiplatformV1Featurestore: + description: >- + Vertex AI Feature Store provides a centralized repository for + organizing, storing, and serving ML features. The Featurestore is a + top-level container for your features and their values. + id: GoogleCloudAiplatformV1Featurestore + properties: + labels: + additionalProperties: + type: string + description: >- + Optional. The labels with user-defined metadata to organize your + Featurestore. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one Featurestore(System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + type: object + onlineServingConfig: + description: >- + Optional. Config for online storage resources. The field should not + co-exist with the field of `OnlineStoreReplicationConfig`. If both + of it and OnlineStoreReplicationConfig are unset, the feature store + will not have an online store and cannot be used for online serving. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig + onlineStorageTtlDays: + format: int32 + description: >- + Optional. TTL in days for feature values that will be stored in + online serving storage. The Feature Store online storage + periodically removes obsolete feature values older than + `online_storage_ttl_days` since the feature generation time. Note + that `online_storage_ttl_days` should be less than or equal to + `offline_storage_ttl_days` for each EntityType under a featurestore. + If not set, default to 4000 days + type: integer + updateTime: + type: string + description: Output only. Timestamp when this Featurestore was last updated. + format: google-datetime + readOnly: true + satisfiesPzi: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + etag: + type: string + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + encryptionSpec: + description: >- + Optional. Customer-managed encryption key spec for data storage. If + set, both of the online and offline data storage will be secured by + this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + state: + readOnly: true + enum: + - STATE_UNSPECIFIED + - STABLE + - UPDATING + description: Output only. State of the featurestore. + enumDescriptions: + - Default value. This value is unused. + - >- + State when the featurestore configuration is not being updated and + the fields reflect the current configuration of the featurestore. + The featurestore is usable in this state. + - >- + The state of the featurestore configuration when it is being + updated. During an update, the fields reflect either the original + configuration or the updated configuration of the featurestore. + For example, `online_serving_config.fixed_node_count` can take + minutes to update. While the update is in progress, the + featurestore is in the UPDATING state, and the value of + `fixed_node_count` can be the original value or the updated value, + depending on the progress of the operation. Until the update + completes, the actual number of nodes can still be the original + value of `fixed_node_count`. The featurestore is still usable in + this state. + type: string + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + createTime: + readOnly: true + type: string + description: Output only. Timestamp when this Featurestore was created. + format: google-datetime + name: + description: >- + Output only. Name of the Featurestore. Format: + `projects/{project}/locations/{location}/featurestores/{featurestore}` + type: string + readOnly: true + type: object + GoogleCloudAiplatformV1FeatureGroup: + id: GoogleCloudAiplatformV1FeatureGroup + type: object + properties: + createTime: + readOnly: true + format: google-datetime + type: string + description: Output only. Timestamp when this FeatureGroup was created. + updateTime: + description: Output only. Timestamp when this FeatureGroup was last updated. + type: string + readOnly: true + format: google-datetime + bigQuery: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQuery' + description: >- + Indicates that features for this group come from BigQuery + Table/View. By default treats the source as a sparse time series + source. The BigQuery source table or view must have at least one + entity ID column and a column named `feature_timestamp`. + name: + description: >- + Identifier. Name of the FeatureGroup. Format: + `projects/{project}/locations/{location}/featureGroups/{featureGroup}` + type: string + description: + description: Optional. Description of the FeatureGroup. + type: string + etag: + type: string + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + labels: + description: >- + Optional. The labels with user-defined metadata to organize your + FeatureGroup. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureGroup(System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + additionalProperties: + type: string + type: object + description: Vertex AI Feature Group. + GoogleCloudAiplatformV1CountTokensResponse: + id: GoogleCloudAiplatformV1CountTokensResponse + description: Response message for PredictionService.CountTokens. + type: object + properties: + totalBillableCharacters: + description: >- + The total number of billable characters counted across all instances + from the request. + format: int32 + type: integer + totalTokens: + description: >- + The total number of tokens counted across all instances from the + request. + type: integer + format: int32 + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics: + description: Metrics for forecasting evaluation results. + type: object + properties: + meanAbsoluteError: + description: Mean Absolute Error (MAE). + type: number + format: float + weightedAbsolutePercentageError: + format: float + description: >- + Weighted Absolute Percentage Error. Does not use weights, this is + just what the metric is called. Undefined if actual values sum to + zero. Will be very large if actual values sum to a very small + number. + type: number + rootMeanSquaredError: + type: number + format: float + description: Root Mean Squared Error (RMSE). + rootMeanSquaredPercentageError: + format: float + type: number + description: >- + Root Mean Square Percentage Error. Square root of MSPE. + Undefined/imaginary when MSPE is negative. + rSquared: + format: float + type: number + description: >- + Coefficient of determination as Pearson correlation coefficient. + Undefined when ground truth or predictions are constant or near + constant. + quantileMetrics: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + description: The quantile metrics entries for each quantile. + type: array + meanAbsolutePercentageError: + description: >- + Mean absolute percentage error. Infinity when there are zeros in the + ground truth. + format: float + type: number + rootMeanSquaredLogError: + description: >- + Root mean squared log error. Undefined when there are negative + ground truth values or predictions. + format: float + type: number + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics + GoogleCloudAiplatformV1BigQueryDestination: + description: The BigQuery location for the output content. + type: object + id: GoogleCloudAiplatformV1BigQueryDestination + properties: + outputUri: + description: >- + Required. BigQuery URI to a project or table, up to 2000 characters + long. When only the project is specified, the Dataset and Table is + created. When the full table reference is specified, the Dataset + must exist and table must not exist. Accepted forms: * BigQuery + path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` + or `bq://projectId.bqDatasetId.bqTableId`. + type: string + GoogleCloudAiplatformV1SchemaVideoDatasetMetadata: + type: object + id: GoogleCloudAiplatformV1SchemaVideoDatasetMetadata + properties: + dataItemSchemaUri: + description: >- + Points to a YAML file stored on Google Cloud Storage describing + payload of the Video DataItems that belong to this Dataset. + type: string + gcsBucket: + type: string + description: >- + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. + description: The metadata of Datasets that contain Video DataItems. + GoogleCloudAiplatformV1SafetyRating: + type: object + description: Safety rating corresponding to the generated content. + id: GoogleCloudAiplatformV1SafetyRating + properties: + probabilityScore: + description: Output only. Harm probability score. + type: number + format: float + readOnly: true + severity: + readOnly: true + type: string + enumDescriptions: + - Harm severity unspecified. + - Negligible level of harm severity. + - Low level of harm severity. + - Medium level of harm severity. + - High level of harm severity. + enum: + - HARM_SEVERITY_UNSPECIFIED + - HARM_SEVERITY_NEGLIGIBLE + - HARM_SEVERITY_LOW + - HARM_SEVERITY_MEDIUM + - HARM_SEVERITY_HIGH + description: Output only. Harm severity levels in the content. + probability: + enumDescriptions: + - Harm probability unspecified. + - Negligible level of harm. + - Low level of harm. + - Medium level of harm. + - High level of harm. + readOnly: true + type: string + description: Output only. Harm probability levels in the content. + enum: + - HARM_PROBABILITY_UNSPECIFIED + - NEGLIGIBLE + - LOW + - MEDIUM + - HIGH + severityScore: + description: Output only. Harm severity score. + type: number + readOnly: true + format: float + blocked: + readOnly: true + type: boolean + description: >- + Output only. Indicates whether the content was filtered out because + of this rating. + category: + type: string + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + - The harm category is civic integrity. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + - HARM_CATEGORY_CIVIC_INTEGRITY + readOnly: true + description: Output only. Harm category. + GoogleCloudAiplatformV1SearchFeaturesResponse: + properties: + nextPageToken: + type: string + description: >- + A token, which can be sent as SearchFeaturesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + features: + description: >- + The Features matching the request. Fields returned: * `name` * + `description` * `labels` * `create_time` * `update_time` + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + type: array + type: object + id: GoogleCloudAiplatformV1SearchFeaturesResponse + description: Response message for FeaturestoreService.SearchFeatures. + GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore delete Features values. + id: GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata + description: Details of operations that delete Feature values. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation: + properties: + columnName: + type: string + invalidValuesAllowed: + description: >- + If invalid values is allowed, the training pipeline will create a + boolean feature that indicated whether the value is valid. + Otherwise, the training pipeline will discard the input row from + trainining data. + type: boolean + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. * A boolean value that indicates whether the + value is valid. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec + properties: + parallelTrialCount: + type: integer + description: The desired number of Trials to run in parallel. + format: int32 + maxTrialCount: + format: int32 + description: The desired total number of Trials. + type: integer + studySpec: + description: Study configuration of the HyperparameterTuningJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + maxFailedTrialCount: + format: int32 + type: integer + description: >- + The number of failed Trials that need to be seen before failing the + HyperparameterTuningJob. If set to 0, Vertex AI decides how many + Trials must fail before the whole job fails. + trialJobSpec: + description: >- + The spec of a trial job. The same spec applies to the CustomJobs + created in all the trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + type: object + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: + description: >- + This message will be placed in the metadata field of a + google.longrunning.Operation associated with a + CheckTrialEarlyStoppingState request. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for suggesting Trials. + trial: + type: string + description: The Trial name. + study: + type: string + description: The name of the Study that the Trial belongs to. + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata + type: object + GoogleCloudAiplatformV1StartNotebookRuntimeRequest: + properties: {} + id: GoogleCloudAiplatformV1StartNotebookRuntimeRequest + description: Request message for NotebookService.StartNotebookRuntime. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata: + type: object + properties: + costMilliNodeHours: + description: >- + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. + type: string + format: int64 + successfulStopReason: + type: string + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED + enumDescriptions: + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. + - >- + Further training of the Model ceased to increase its quality, + since it already has converged. + description: >- + For successful job completions, this is the reason why the job has + finished. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata + GoogleCloudAiplatformV1Tool: + id: GoogleCloudAiplatformV1Tool + description: >- + Tool details that the model may use to generate response. A `Tool` is a + piece of code that enables the system to interact with external systems + to perform an action, or set of actions, outside of knowledge and scope + of the model. A Tool object should contain exactly one type of Tool (e.g + FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + type: object + properties: + functionDeclarations: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionDeclaration' + 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 64 function declarations can be provided. + type: array + retrieval: + description: >- + Optional. Retrieval tool type. System will always execute the + provided retrieval tool(s) to get external knowledge to answer the + prompt. Retrieval results are presented to the model for generation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' + googleSearchRetrieval: + description: >- + Optional. GoogleSearchRetrieval tool type. Specialized retrieval + tool that is powered by Google search. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' + GoogleCloudAiplatformV1ReadFeatureValuesRequest: + properties: + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + description: Required. Selector choosing Features of the target EntityType. + entityId: + description: >- + Required. ID for a specific entity. For example, for a machine + learning model predicting user clicks on a website, an entity ID + could be `user_123`. + type: string + type: object + description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. + id: GoogleCloudAiplatformV1ReadFeatureValuesRequest + GoogleCloudAiplatformV1FetchFeatureValuesRequest: + description: >- + Request message for FeatureOnlineStoreService.FetchFeatureValues. All + the features under the requested feature view will be returned. + id: GoogleCloudAiplatformV1FetchFeatureValuesRequest + type: object + properties: + dataKey: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' + description: Optional. The request key to fetch feature values for. + dataFormat: + description: >- + Optional. Response data format. If not set, + FeatureViewDataFormat.KEY_VALUE will be used. + type: string + enum: + - FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED + - KEY_VALUE + - PROTO_STRUCT + enumDescriptions: + - Not set. Will be treated as the KeyValue format. + - Return response data in key-value format. + - Return response data in proto Struct format. + GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult: + description: Prediction output format for Tabular Regression. + type: object + properties: + lowerBound: + description: The lower bound of the prediction interval. + type: number + format: float + quantilePredictions: + type: array + description: Quantile predictions, in 1-1 correspondence with quantile_values. + items: + type: number + format: float + quantileValues: + description: Quantile values. + items: + format: float + type: number + type: array + value: + description: The regression value. + format: float + type: number + upperBound: + type: number + description: The upper bound of the prediction interval. + format: float + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult + GoogleCloudAiplatformV1MigratableResource: + id: GoogleCloudAiplatformV1MigratableResource + description: >- + Represents one resource that exists in automl.googleapis.com, + datalabeling.googleapis.com or ml.googleapis.com. + type: object + properties: + automlDataset: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlDataset + description: Output only. Represents one Dataset in automl.googleapis.com. + readOnly: true + lastMigrateTime: + type: string + description: >- + Output only. Timestamp when the last migration attempt on this + MigratableResource started. Will not be set if there's no migration + attempt on this MigratableResource. + readOnly: true + format: google-datetime + lastUpdateTime: + readOnly: true + format: google-datetime + description: >- + Output only. Timestamp when this MigratableResource was last + updated. + type: string + mlEngineModelVersion: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion + description: Output only. Represents one Version in ml.googleapis.com. + readOnly: true + dataLabelingDataset: + description: Output only. Represents one Dataset in datalabeling.googleapis.com. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset + automlModel: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlModel + description: Output only. Represents one Model in automl.googleapis.com. + readOnly: true + GoogleCloudAiplatformV1QuestionAnsweringQualitySpec: + properties: + useReference: + description: >- + Optional. Whether to use instance.reference to compute question + answering quality. + type: boolean + version: + description: Optional. Which version to use for evaluation. + format: int32 + type: integer + description: Spec for question answering quality score metric. + type: object + id: GoogleCloudAiplatformV1QuestionAnsweringQualitySpec + GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec: + properties: + values: + items: + type: number + format: double + type: array + description: >- + Required. A list of possible values. The list should be in + increasing order and at least 1e-10 apart. For instance, this + parameter might have possible settings of 1.5, 2.5, and 4.0. This + list should not contain more than 1,000 values. + defaultValue: + format: double + type: number + description: >- + A default value for a `DISCRETE` parameter that is assumed to be a + relatively good starting point. Unset value signals that there is no + offered starting point. It automatically rounds to the nearest + feasible discrete point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. + id: GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec + description: Value specification for a parameter in `DISCRETE` type. + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult: + type: object + properties: + tftFeatureImportance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance + description: Only use these if TFt is enabled. + value: + description: The regression value. + type: number + format: float + quantilePredictions: + description: Quantile predictions, in 1-1 correspondence with quantile_values. + type: array + items: + format: float + type: number + quantileValues: + type: array + items: + format: float + type: number + description: Quantile values. + description: Prediction output format for Time Series Forecasting. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult + GoogleCloudAiplatformV1SchemaPredictionResultError: + id: GoogleCloudAiplatformV1SchemaPredictionResultError + properties: + message: + type: string + description: Error message with additional details. + status: + description: >- + Error status. This will be serialized into the enum name e.g. + "NOT_FOUND". + enumDescriptions: + - 'Not an error; returned on success. HTTP Mapping: 200 OK' + - >- + The operation was cancelled, typically by the caller. HTTP + Mapping: 499 Client Closed Request + - >- + Unknown error. For example, this error may be returned when a + `Status` value received from another address space belongs to an + error space that is not known in this address space. Also errors + raised by APIs that do not return enough error information may be + converted to this error. HTTP Mapping: 500 Internal Server Error + - >- + The client specified an invalid argument. Note that this differs + from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments + that are problematic regardless of the state of the system (e.g., + a malformed file name). HTTP Mapping: 400 Bad Request + - >- + The deadline expired before the operation could complete. For + operations that change the state of the system, this error may be + returned even if the operation has completed successfully. For + example, a successful response from a server could have been + delayed long enough for the deadline to expire. HTTP Mapping: 504 + Gateway Timeout + - >- + Some requested entity (e.g., file or directory) was not found. + Note to server developers: if a request is denied for an entire + class of users, such as gradual feature rollout or undocumented + allowlist, `NOT_FOUND` may be used. If a request is denied for + some users within a class of users, such as user-based access + control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not + Found + - >- + The entity that a client attempted to create (e.g., file or + directory) already exists. HTTP Mapping: 409 Conflict + - >- + The caller does not have permission to execute the specified + operation. `PERMISSION_DENIED` must not be used for rejections + caused by exhausting some resource (use `RESOURCE_EXHAUSTED` + instead for those errors). `PERMISSION_DENIED` must not be used if + the caller can not be identified (use `UNAUTHENTICATED` instead + for those errors). This error code does not imply the request is + valid or the requested entity exists or satisfies other + pre-conditions. HTTP Mapping: 403 Forbidden + - >- + The request does not have valid authentication credentials for the + operation. HTTP Mapping: 401 Unauthorized + - >- + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. HTTP Mapping: 429 + Too Many Requests + - >- + The operation was rejected because the system is not in a state + required for the operation's execution. For example, the directory + to be deleted is non-empty, an rmdir operation is applied to a + non-directory, etc. Service implementors can use the following + guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and + `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just + the failing call. (b) Use `ABORTED` if the client should retry at + a higher level. For example, when a client-specified test-and-set + fails, indicating the client should restart a read-modify-write + sequence. (c) Use `FAILED_PRECONDITION` if the client should not + retry until the system state has been explicitly fixed. For + example, if an "rmdir" fails because the directory is non-empty, + `FAILED_PRECONDITION` should be returned since the client should + not retry unless the files are deleted from the directory. HTTP + Mapping: 400 Bad Request + - >- + The operation was aborted, typically due to a concurrency issue + such as a sequencer check failure or transaction abort. See the + guidelines above for deciding between `FAILED_PRECONDITION`, + `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + - >- + The operation was attempted past the valid range. E.g., seeking or + reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error + indicates a problem that may be fixed if the system state changes. + For example, a 32-bit file system will generate `INVALID_ARGUMENT` + if asked to read at an offset that is not in the range [0,2^32-1], + but it will generate `OUT_OF_RANGE` if asked to read from an + offset past the current file size. There is a fair bit of overlap + between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend + using `OUT_OF_RANGE` (the more specific error) when it applies so + that callers who are iterating through a space can easily look for + an `OUT_OF_RANGE` error to detect when they are done. HTTP + Mapping: 400 Bad Request + - >- + The operation is not implemented or is not supported/enabled in + this service. HTTP Mapping: 501 Not Implemented + - >- + Internal errors. This means that some invariants expected by the + underlying system have been broken. This error code is reserved + for serious errors. HTTP Mapping: 500 Internal Server Error + - >- + The service is currently unavailable. This is most likely a + transient condition, which can be corrected by retrying with a + backoff. Note that it is not always safe to retry non-idempotent + operations. See the guidelines above for deciding between + `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: + 503 Service Unavailable + - >- + Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal + Server Error + enum: + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS + type: string + type: object + GoogleCloudAiplatformV1ExplanationMetadataInputMetadata: + id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadata + properties: + featureValueDomain: + description: >- + The domain details of the input feature value. Like min/max, + original mean or standard deviation if normalized. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + encodedBaselines: + description: >- + A list of baselines for the encoded tensor. The shape of each + baseline should match the shape of the encoded tensor. If a scalar + is provided, Vertex AI broadcasts to the same shape as the encoded + tensor. + type: array + items: + type: any + denseShapeTensorName: + description: >- + Specifies the shape of the values of the input if the input is a + sparse representation. Refer to Tensorflow documentation for more + details: + https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. + type: string + indicesTensorName: + type: string + description: >- + Specifies the index of the values of the input tensor. Required when + the input tensor is a sparse representation. Refer to Tensorflow + documentation for more details: + https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. + encoding: + enumDescriptions: + - Default value. This is the same as IDENTITY. + - The tensor represents one feature. + - >- + The tensor represents a bag of features where each index maps to a + feature. InputMetadata.index_feature_mapping must be provided for + this encoding. For example: ``` input = [27, 6.0, 150] + index_feature_mapping = ["age", "height", "weight"] ``` + - >- + The tensor represents a bag of features where each index maps to a + feature. Zero values in the tensor indicates feature being + non-existent. InputMetadata.index_feature_mapping must be provided + for this encoding. For example: ``` input = [2, 0, 5, 0, 1] + index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + - >- + The tensor is a list of binaries representing whether a feature + exists or not (1 indicates existence). + InputMetadata.index_feature_mapping must be provided for this + encoding. For example: ``` input = [1, 0, 1, 0, 1] + index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + - >- + The tensor is encoded into a 1-dimensional array represented by an + encoded tensor. InputMetadata.encoded_tensor_name must be provided + for this encoding. For example: ``` input = ["This", "is", "a", + "test", "."] encoded = [0.1, 0.2, 0.3, 0.4, 0.5] ``` + - >- + Select this encoding when the input tensor is encoded into a + 2-dimensional array represented by an encoded tensor. + InputMetadata.encoded_tensor_name must be provided for this + encoding. The first dimension of the encoded tensor's shape is the + same as the input tensor's shape. For example: ``` input = + ["This", "is", "a", "test", "."] encoded = [[0.1, 0.2, 0.3, 0.4, + 0.5], [0.2, 0.1, 0.4, 0.3, 0.5], [0.5, 0.1, 0.3, 0.5, 0.4], [0.5, + 0.3, 0.1, 0.2, 0.4], [0.4, 0.3, 0.2, 0.5, 0.1]] ``` + enum: + - ENCODING_UNSPECIFIED + - IDENTITY + - BAG_OF_FEATURES + - BAG_OF_FEATURES_SPARSE + - INDICATOR + - COMBINED_EMBEDDING + - CONCAT_EMBEDDING + description: >- + Defines how the feature is encoded into the input tensor. Defaults + to IDENTITY. + type: string + indexFeatureMapping: + description: >- + A list of feature names for each index in the input tensor. Required + when the input InputMetadata.encoding is BAG_OF_FEATURES, + BAG_OF_FEATURES_SPARSE, INDICATOR. + type: array + items: + type: string + inputBaselines: + items: + type: any + type: array + description: >- + Baseline inputs for this feature. If no baseline is specified, + Vertex AI chooses the baseline for this feature. If multiple + baselines are specified, Vertex AI returns the average attributions + across them in Attribution.feature_attributions. For Vertex + AI-provided Tensorflow images (both 1.x and 2.x), the shape of each + baseline must match the shape of the input tensor. If a scalar is + provided, we broadcast to the same shape as the input tensor. For + custom images, the element of the baselines must be in the same + format as the feature's input in the instance[]. The schema of any + single instance may be specified via Endpoint's DeployedModels' + Model's PredictSchemata's instance_schema_uri. + inputTensorName: + description: >- + Name of the input tensor for this feature. Required and is only + applicable to Vertex AI-provided images for Tensorflow. + type: string + visualization: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization + description: Visualization configurations for image explanation. + modality: + type: string + description: >- + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. + groupName: + description: >- + Name of the group that the input belongs to. Features with the same + group name will be treated as one feature when computing + attributions. Features grouped together can have different shapes in + value. If provided, there will be one single attribution generated + in Attribution.feature_attributions, keyed by the group name. + type: string + encodedTensorName: + description: >- + Encoded tensor is a transformation of the input tensor. Must be + provided if choosing Integrated Gradients attribution or XRAI + attribution and the input tensor is not differentiable. An encoded + tensor is generated if the input tensor is encoded by a lookup + table. + type: string + description: >- + Metadata of the input of a feature. Fields other than + InputMetadata.input_baselines are applicable only for Models that are + using Vertex AI-provided images for Tensorflow. + type: object + GoogleCloudAiplatformV1DeployModelOperationMetadata: + description: Runtime operation information for EndpointService.DeployModel. + type: object + id: GoogleCloudAiplatformV1DeployModelOperationMetadata + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata: + description: Details of operations that perform create EntityType. + type: object + id: GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for EntityType. + GoogleCloudAiplatformV1ModelContainerSpec: + properties: + healthRoute: + description: >- + Immutable. HTTP path on the container to send health checks to. + Vertex AI intermittently sends GET requests to this path on the + container's IP address and port to check that the container is + healthy. Read more about [health + checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). + For example, if you set this field to `/bar`, then Vertex AI + intermittently sends a GET request to the `/bar` path on the port of + your container specified by the first value of this + `ModelContainerSpec`'s ports field. If you don't specify this field, + it defaults to the following value when you deploy this Model to an + Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ + DEPLOYED_MODEL:predict The placeholders in this value are replaced + as follows: * ENDPOINT: The last segment (following `endpoints/`)of + the Endpoint.name][] field of the Endpoint where this Model has been + deployed. (Vertex AI makes this value available to your container + code as the [`AIP_ENDPOINT_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex + AI makes this value available to your container code as the + [`AIP_DEPLOYED_MODEL_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + type: string + ports: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' + description: >- + Immutable. List of ports to expose from the container. Vertex AI + sends any prediction requests that it receives to the first port on + this list. Vertex AI also sends [liveness and health + checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) + to this port. If you do not specify this field, it defaults to + following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI + does not use ports other than the first one listed. This field + corresponds to the `ports` field of the Kubernetes Containers [v1 + core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + type: array + sharedMemorySizeMb: + type: string + description: >- + Immutable. The amount of the VM memory to reserve as the shared + memory for the model in megabytes. + format: int64 + env: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + description: >- + Immutable. List of environment variables to set in the container. + After the container starts running, code running in the container + can read these environment variables. Additionally, the command and + args fields can reference these variables. Later entries in this + list can also reference earlier entries. For example, the following + example sets the variable `VAR_2` to have the value `foo bar`: + ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", + "value": "$(VAR_1) bar" } ] ``` If you switch the order of the + variables in the example, then the expansion does not occur. This + field corresponds to the `env` field of the Kubernetes Containers + [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + imageUri: + type: string + description: >- + Required. Immutable. URI of the Docker image to be used as the + custom container for serving predictions. This URI must identify an + image in Artifact Registry or Container Registry. Learn more about + the [container publishing + requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), + including permissions requirements for the Vertex AI Service Agent. + The container image is ingested upon ModelService.UploadModel, + stored internally, and this original path is afterwards not used. To + learn about the requirements for the Docker image itself, see + [Custom container + requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). + You can use the URI to one of Vertex AI's [pre-built container + images for + prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) + in this field. + args: + type: array + items: + type: string + description: >- + Immutable. Specifies arguments for the command that runs when the + container starts. This overrides the container's + [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). + Specify this field as an array of executable and arguments, similar + to a Docker `CMD`'s "default parameters" form. If you don't specify + this field but do specify the command field, then the command from + the `command` field runs without any additional arguments. See the + [Kubernetes documentation about how the `command` and `args` fields + interact with a container's `ENTRYPOINT` and + `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). + If you don't specify this field and don't specify the `command` + field, then the container's + [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) + and `CMD` determine what runs based on their default behavior. See + the Docker documentation about [how `CMD` and `ENTRYPOINT` + interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). + In this field, you can reference [environment variables set by + Vertex + AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) + and environment variables set in the env field. You cannot reference + environment variables set in the Docker image. In order for + environment variables to be expanded, reference them by using the + following syntax: $( VARIABLE_NAME) Note that this differs from Bash + variable expansion, which does not use parentheses. If a variable + cannot be resolved, the reference in the input string is used + unchanged. To avoid variable expansion, you can escape this syntax + with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to + the `args` field of the Kubernetes Containers [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + grpcPorts: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' + description: >- + Immutable. List of ports to expose from the container. Vertex AI + sends gRPC prediction requests that it receives to the first port on + this list. Vertex AI also sends liveness and health checks to this + port. If you do not specify this field, gRPC requests to the + container will be disabled. Vertex AI does not use ports other than + the first one listed. This field corresponds to the `ports` field of + the Kubernetes Containers v1 core API. + type: array + deploymentTimeout: + format: google-duration + description: >- + Immutable. Deployment timeout. Limit for deployment timeout is 2 + hours. + type: string + predictRoute: + description: >- + Immutable. HTTP path on the container to send prediction requests + to. Vertex AI forwards requests sent using + projects.locations.endpoints.predict to this path on the container's + IP address and port. Vertex AI then returns the container's response + in the API response. For example, if you set this field to `/foo`, + then when Vertex AI receives a prediction request, it forwards the + request body in a POST request to the `/foo` path on the port of + your container specified by the first value of this + `ModelContainerSpec`'s ports field. If you don't specify this field, + it defaults to the following value when you deploy this Model to an + Endpoint: + /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The + placeholders in this value are replaced as follows: * ENDPOINT: The + last segment (following `endpoints/`)of the Endpoint.name][] field + of the Endpoint where this Model has been deployed. (Vertex AI makes + this value available to your container code as the + [`AIP_ENDPOINT_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex + AI makes this value available to your container code as the + [`AIP_DEPLOYED_MODEL_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + type: string + command: + type: array + description: >- + Immutable. Specifies the command that runs when the container + starts. This overrides the container's + [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). + Specify this field as an array of executable and arguments, similar + to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you + do not specify this field, then the container's `ENTRYPOINT` runs, + in conjunction with the args field or the container's + [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if + either exists. If this field is not specified and the container does + not have an `ENTRYPOINT`, then refer to the Docker documentation + about [how `CMD` and `ENTRYPOINT` + interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). + If you specify this field, then you can also specify the `args` + field to provide additional arguments for this command. However, if + you specify this field, then the container's `CMD` is ignored. See + the [Kubernetes documentation about how the `command` and `args` + fields interact with a container's `ENTRYPOINT` and + `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). + In this field, you can reference [environment variables set by + Vertex + AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) + and environment variables set in the env field. You cannot reference + environment variables set in the Docker image. In order for + environment variables to be expanded, reference them by using the + following syntax: $( VARIABLE_NAME) Note that this differs from Bash + variable expansion, which does not use parentheses. If a variable + cannot be resolved, the reference in the input string is used + unchanged. To avoid variable expansion, you can escape this syntax + with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to + the `command` field of the Kubernetes Containers [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + items: + type: string + healthProbe: + description: Immutable. Specification for Kubernetes readiness probe. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + startupProbe: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + description: Immutable. Specification for Kubernetes startup probe. + type: object + id: GoogleCloudAiplatformV1ModelContainerSpec + description: >- + Specification of a container for serving predictions. Some fields in + this message correspond to fields in the [Kubernetes Container v1 core + specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata: + id: GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata + type: object + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Runtime operation information for UpdateDeploymentResourcePool method. + GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance: + description: Spec for question answering relevance instance. + type: object + properties: + prediction: + type: string + description: Required. Output of the evaluated model. + instruction: + type: string + description: >- + Required. The question asked and other instruction in the inference + prompt. + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + context: + description: Optional. Text provided as context to answer the question. + type: string + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource: + properties: + uri: + type: array + items: + type: string + description: >- + Cloud Storage URI of one or more files. Only CSV files are + supported. The first line of the CSV file is used as the header. If + there are multiple files, the header is the first line of the + lexicographically first file, the other files must either contain + the exact same header or omit the header. + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource + type: object + CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: + properties: + mid: + description: MID of the label + type: string + description: + type: string + description: Description of the label + iouScore: + format: float + type: number + description: >- + The intersection ratio between the detection bounding box and the + mask. + score: + type: number + format: float + description: Confidence score of the label + boundingBox: + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + description: Bounding box of the label + description: The properties for a detected entity from the rai signal. + type: object + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest: + id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + type: object + properties: + entityIds: + items: + type: string + description: >- + Required. IDs of entities to read Feature values of. The maximum + number of IDs is 100. For example, for a machine learning model + predicting user clicks on a website, an entity ID could be + `user_123`. + type: array + featureSelector: + description: >- + Required. Selector choosing Features of the target EntityType. + Feature IDs will be deduplicated. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + description: >- + Request message for + FeaturestoreOnlineServingService.StreamingFeatureValuesRead. + GoogleCloudAiplatformV1StudySpecParameterSpec: + properties: + scaleType: + enumDescriptions: + - By default, no scaling is applied. + - Scales the feasible space to (0, 1) linearly. + - >- + Scales the feasible space logarithmically to (0, 1). The entire + feasible space must be strictly positive. + - >- + Scales the feasible space "reverse" logarithmically to (0, 1). The + result is that values close to the top of the feasible space are + spread out more than points near the bottom. The entire feasible + space must be strictly positive. + description: >- + How the parameter should be scaled. Leave unset for `CATEGORICAL` + parameters. + type: string + enum: + - SCALE_TYPE_UNSPECIFIED + - UNIT_LINEAR_SCALE + - UNIT_LOG_SCALE + - UNIT_REVERSE_LOG_SCALE + categoricalValueSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec + description: The value spec for a 'CATEGORICAL' parameter. + integerValueSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec + description: The value spec for an 'INTEGER' parameter. + discreteValueSpec: + description: The value spec for a 'DISCRETE' parameter. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec + doubleValueSpec: + description: The value spec for a 'DOUBLE' parameter. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + conditionalParameterSpecs: + description: >- + A conditional parameter node is active if the parameter's value + matches the conditional node's parent_value_condition. If two items + in conditional_parameter_specs have the same name, they must have + disjoint parent_value_condition. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec + parameterId: + type: string + description: >- + Required. The ID of the parameter. Must not contain whitespaces and + must be unique amongst all ParameterSpecs. + type: object + id: GoogleCloudAiplatformV1StudySpecParameterSpec + description: Represents a single parameter to optimize. + GoogleCloudAiplatformV1BatchPredictionJob: + description: >- + A job that uses a Model to produce predictions on multiple input + instances. If predictions for significant portion of the instances fail, + the job may finish without attempting predictions for all remaining + instances. + properties: + inputConfig: + description: >- + Required. Input configuration of the instances on which predictions + are performed. The schema of any single instance may be specified + via the Model's PredictSchemata's instance_schema_uri. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInputConfig + createTime: + readOnly: true + description: Output only. Time when the BatchPredictionJob was created. + format: google-datetime + type: string + name: + readOnly: true + description: Output only. Resource name of the BatchPredictionJob. + type: string + endTime: + type: string + format: google-datetime + description: >- + Output only. Time when the BatchPredictionJob entered any of the + following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + readOnly: true + outputInfo: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + readOnly: true + description: Output only. Information further describing the output of this job. + displayName: + description: Required. The user-defined name of this BatchPredictionJob. + type: string + resourcesConsumed: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcesConsumed' + description: >- + Output only. Information about resources that had been consumed by + this job. Provided in real time at best effort basis, as well as a + final value once the job completes. Note: This field currently may + be not populated for batch predictions that use AutoML Models. + updateTime: + type: string + readOnly: true + description: >- + Output only. Time when the BatchPredictionJob was most recently + updated. + format: google-datetime + instanceConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + description: >- + Configuration for how to convert batch prediction input instances to + the prediction instances that are sent to the Model. + partialFailures: + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + description: >- + Output only. Partial failures encountered. For example, single files + that can't be read. This field never exceeds 20 entries. Status + details fields contain standard Google Cloud error details. + labels: + description: >- + The labels with user-defined metadata to organize + BatchPredictionJobs. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. + type: object + additionalProperties: + type: string + manualBatchTuningParameters: + description: >- + Immutable. Parameters configuring the batch behavior. Currently only + applicable when dedicated_resources are used (in other cases Vertex + AI does the tuning itself). + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ManualBatchTuningParameters + satisfiesPzs: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + modelVersionId: + readOnly: true + description: >- + Output only. The version ID of the Model that produces the + predictions via this job. + type: string + disableContainerLogging: + type: boolean + description: >- + For custom-trained Models and AutoML Tabular Models, the container + of the DeployedModel instances will send `stderr` and `stdout` + streams to Cloud Logging by default. Please note that the logs incur + cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging/pricing). User can disable + container logging by setting this flag to true. + unmanagedContainerModel: + description: >- + Contains model information necessary to perform batch prediction + without requiring uploading to model registry. Exactly one of model + and unmanaged_container_model must be set. + $ref: '#/components/schemas/GoogleCloudAiplatformV1UnmanagedContainerModel' + completionStats: + description: >- + Output only. Statistics on completed and failed prediction + instances. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompletionStats' + modelParameters: + description: >- + The parameters that govern the predictions. The schema of the + parameters may be specified via the Model's PredictSchemata's + parameters_schema_uri. + type: any + encryptionSpec: + description: >- + Customer-managed encryption key options for a BatchPredictionJob. If + this is set, then all resources created by the BatchPredictionJob + will be encrypted with the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + startTime: + description: >- + Output only. Time when the BatchPredictionJob for the first time + entered the `JOB_STATE_RUNNING` state. + format: google-datetime + type: string + readOnly: true + dedicatedResources: + description: >- + The config of resources used by the Model during the batch + prediction. If the Model supports DEDICATED_RESOURCES this config + may be provided (and the job will use these resources), if the Model + doesn't support AUTOMATIC_RESOURCES, this config must be provided. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchDedicatedResources' + outputConfig: + description: >- + Required. The Configuration specifying where output predictions + should be written. The schema of any single prediction may be + specified as a concatenation of Model's PredictSchemata's + instance_schema_uri and prediction_schema_uri. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputConfig + explanationSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + description: >- + Explanation configuration for this BatchPredictionJob. Can be + specified only if generate_explanation is set to `true`. This value + overrides the value of Model.explanation_spec. All fields of + explanation_spec are optional in the request. If a field of the + explanation_spec object is not populated, the corresponding field of + the Model.explanation_spec object is inherited. + serviceAccount: + type: string + description: >- + The service account that the DeployedModel's container runs as. If + not specified, a system generated one will be used, which has + minimal permissions and the custom container, if used, may not have + enough permission to access other Google Cloud resources. Users + deploying the Model must have the `iam.serviceAccounts.actAs` + permission on this service account. + satisfiesPzi: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + model: + description: >- + The name of the Model resource that produces the predictions via + this job, must share the same ancestor Location. Starting this job + has no impact on any existing deployments of the Model and their + resources. Exactly one of model and unmanaged_container_model must + be set. The model resource name may contain version id or version + alias to specify the version. Example: + `projects/{project}/locations/{location}/models/{model}@2` or + `projects/{project}/locations/{location}/models/{model}@golden` if + no version is specified, the default version will be deployed. The + model resource could also be a publisher model. Example: + `publishers/{publisher}/models/{model}` or + `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` + type: string + state: + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + description: Output only. The detailed state of the job. + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + readOnly: true + type: string + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Only populated when the job's state is JOB_STATE_FAILED + or JOB_STATE_CANCELLED. + readOnly: true + generateExplanation: + description: >- + Generate explanation with the batch prediction results. When set to + `true`, the batch prediction output changes based on the + `predictions_format` field of the BatchPredictionJob.output_config + object: * `bigquery`: output includes a column named `explanation`. + The value is a struct that conforms to the Explanation object. * + `jsonl`: The JSON objects on each line include an additional entry + keyed `explanation`. The value of the entry is a JSON object that + conforms to the Explanation object. * `csv`: Generating explanations + for CSV format is not supported. If this field is set to true, + either the Model.explanation_spec or explanation_spec must be + populated. + type: boolean + type: object + id: GoogleCloudAiplatformV1BatchPredictionJob + GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata: + type: object + id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata + properties: {} + GoogleCloudAiplatformV1PublisherModel: + properties: + launchStage: + type: string + enum: + - LAUNCH_STAGE_UNSPECIFIED + - EXPERIMENTAL + - PRIVATE_PREVIEW + - PUBLIC_PREVIEW + - GA + description: Optional. Indicates the launch stage of the model. + enumDescriptions: + - The model launch stage is unspecified. + - >- + Used to indicate the PublisherModel is at Experimental launch + stage, available to a small set of customers. + - >- + Used to indicate the PublisherModel is at Private Preview launch + stage, only available to a small set of customers, although a + larger set of customers than an Experimental launch. Previews are + the first launch stage used to get feedback from customers. + - >- + Used to indicate the PublisherModel is at Public Preview launch + stage, available to all customers, although not supported for + production workloads. + - >- + Used to indicate the PublisherModel is at GA launch stage, + available to all customers and ready for production workload. + versionId: + description: >- + Output only. Immutable. The version ID of the PublisherModel. A new + version is committed when a new model version is uploaded under an + existing model id. It is an auto-incrementing decimal number in + string representation. + type: string + readOnly: true + openSourceCategory: + enum: + - OPEN_SOURCE_CATEGORY_UNSPECIFIED + - PROPRIETARY + - GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT + - THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT + - GOOGLE_OWNED_OSS + - THIRD_PARTY_OWNED_OSS + enumDescriptions: + - The open source category is unspecified, which should not be used. + - Used to indicate the PublisherModel is not open sourced. + - >- + Used to indicate the PublisherModel is a Google-owned open source + model w/ Google checkpoint. + - >- + Used to indicate the PublisherModel is a 3p-owned open source + model w/ Google checkpoint. + - >- + Used to indicate the PublisherModel is a Google-owned pure open + source model. + - >- + Used to indicate the PublisherModel is a 3p-owned pure open source + model. + type: string + description: Required. Indicates the open source category of the publisher model. + name: + readOnly: true + description: Output only. The resource name of the PublisherModel. + type: string + publisherModelTemplate: + description: >- + Optional. Output only. Immutable. Used to indicate this model has a + publisher model and provide the template of the publisher model + resource name. + readOnly: true + type: string + predictSchemata: + description: >- + Optional. The schemata that describes formats of the + PublisherModel's predictions and explanations as given and returned + via PredictionService.Predict. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + frameworks: + type: array + description: Optional. Additional information about the model's Frameworks. + items: + type: string + supportedActions: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToAction + description: Optional. Supported call-to-action options. + versionState: + enumDescriptions: + - The version state is unspecified. + - Used to indicate the version is stable. + - Used to indicate the version is unstable. + description: Optional. Indicates the state of the model version. + type: string + enum: + - VERSION_STATE_UNSPECIFIED + - VERSION_STATE_STABLE + - VERSION_STATE_UNSTABLE + id: GoogleCloudAiplatformV1PublisherModel + description: A Model Garden Publisher Model. + type: object + GoogleCloudAiplatformV1Part: + description: >- + A datatype containing media that is part of a multi-part `Content` + message. A `Part` consists of data which has an associated datatype. A + `Part` can only contain one of the accepted types in `Part.data`. A + `Part` must have a fixed IANA MIME type identifying the type and subtype + of the media if `inline_data` or `file_data` field is filled with raw + bytes. + type: object + id: GoogleCloudAiplatformV1Part + properties: + fileData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' + description: Optional. URI based data. + functionCall: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCall' + description: >- + Optional. A predicted [FunctionCall] returned from the model that + contains a string representing the [FunctionDeclaration.name] with + the parameters and their values. + text: + description: Optional. Text part (can be code). + type: string + functionResponse: + description: >- + Optional. The result output of a [FunctionCall] that contains a + string representing the [FunctionDeclaration.name] and a structured + JSON object containing any output from the function call. It is used + as context to the model. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' + videoMetadata: + description: >- + Optional. Video metadata. The metadata should only be specified + while the video data is presented in inline_data or file_data. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' + inlineData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' + description: Optional. Inlined bytes data. + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition: + type: object + properties: + values: + items: + type: string + format: int64 + description: >- + Required. Matches values of the parent parameter of 'INTEGER' type. + All values must lie in `integer_value_spec` of parent parameter. + type: array + description: Represents the spec to match integer values from parent parameter. + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition + GoogleCloudAiplatformV1AutoscalingMetricSpec: + description: >- + The metric specification that defines the target resource utilization + (CPU utilization, accelerator's duty cycle, and so on) for calculating + the desired replica count. + id: GoogleCloudAiplatformV1AutoscalingMetricSpec + type: object + properties: + target: + format: int32 + description: >- + The target resource utilization in percentage (1% - 100%) for the + given metric; once the real usage deviates from the target by a + certain percentage, the machine replicas change. The default value + is 60 (representing 60%) if not provided. + type: integer + metricName: + type: string + description: >- + Required. The resource metric name. Supported metrics: * For Online + Prediction: * + `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` + * `aiplatform.googleapis.com/prediction/online/cpu/utilization` + GoogleCloudAiplatformV1ListFeatureViewSyncsResponse: + id: GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + type: object + properties: + nextPageToken: + description: >- + A token, which can be sent as ListFeatureViewSyncsRequest.page_token + to retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: string + featureViewSyncs: + type: array + description: The FeatureViewSyncs matching the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + description: >- + Response message for + FeatureOnlineStoreAdminService.ListFeatureViewSyncs. + GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec: + description: Value specification for a parameter in `CATEGORICAL` type. + id: GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec + properties: + defaultValue: + description: >- + A default value for a `CATEGORICAL` parameter that is assumed to be + a relatively good starting point. Unset value signals that there is + no offered starting point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. + type: string + values: + type: array + items: + type: string + description: Required. The list of possible categories. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + properties: + maxCount: + format: int64 + type: string + description: >- + Maximum number of windows that should be generated across all time + series. + column: + description: >- + Name of the column that should be used to generate sliding windows. + The column should contain either booleans or string booleans; if the + value of the row is True, generate a sliding window with the horizon + starting at that row. The column will not be used as a feature in + training. + type: string + strideLength: + type: string + description: >- + Stride length used to generate input examples. Within one time + series, every {$STRIDE_LENGTH} rows will be used to generate a + sliding window. + format: int64 + description: >- + Config that contains the strategy used to generate sliding windows in + time series training. A window is a series of rows that comprise the + context up to the time of prediction, and the horizon following. The + corresponding row for each window marks the start of the forecast + horizon. Each window is used as an input example for + training/evaluation. + type: object + GoogleCloudAiplatformV1PublisherModelDocumentation: + properties: + title: + description: >- + Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, + JAVA, NODE.JS, etc.. + type: string + content: + description: Required. Content of this piece of document (in Markdown format). + type: string + id: GoogleCloudAiplatformV1PublisherModelDocumentation + type: object + description: A named piece of documentation. + GoogleCloudAiplatformV1GenericOperationMetadata: + id: GoogleCloudAiplatformV1GenericOperationMetadata + description: Generic Metadata shared by all operations. + type: object + properties: + createTime: + format: google-datetime + description: Output only. Time when the operation was created. + readOnly: true + type: string + partialFailures: + readOnly: true + description: >- + Output only. Partial failures encountered. E.g. single files that + couldn't be read. This field should never exceed 20 entries. Status + details field will contain standard Google Cloud error details. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + updateTime: + format: google-datetime + type: string + readOnly: true + description: >- + Output only. Time when the operation was updated for the last time. + If the operation has finished (successfully or not), this is the + finish time. + GoogleCloudAiplatformV1NasJobOutput: + properties: + multiTrialJobOutput: + readOnly: true + description: >- + Output only. The output of this multi-trial Neural Architecture + Search (NAS) job. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + description: Represents a uCAIP NasJob output. + id: GoogleCloudAiplatformV1NasJobOutput + type: object + GoogleCloudAiplatformV1ModelExportFormat: + properties: + exportableContents: + readOnly: true + description: Output only. The content of this Model that may be exported. + items: + enum: + - EXPORTABLE_CONTENT_UNSPECIFIED + - ARTIFACT + - IMAGE + enumDescriptions: + - Should not be used. + - >- + Model artifact and any of its supported files. Will be exported + to the location specified by the `artifactDestination` field of + the ExportModelRequest.output_config object. + - >- + The container image that is to be used when deploying this + Model. Will be exported to the location specified by the + `imageDestination` field of the ExportModelRequest.output_config + object. + type: string + type: array + id: + description: >- + Output only. The ID of the export format. The possible format IDs + are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` + Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * + `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be + used in the browser and in Node.js using JavaScript. * `core-ml` + Used for iOS mobile devices. * `custom-trained` A Model that was + uploaded or trained by custom code. + readOnly: true + type: string + description: >- + Represents export format supported by the Model. All formats export to + Google Cloud Storage. + type: object + id: GoogleCloudAiplatformV1ModelExportFormat + GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata: + description: >- + Metadata information about the deployment for managing deployment + config. + type: object + properties: + sampleRequest: + description: Optional. Sample request for deployed endpoint. + type: string + labels: + description: >- + Optional. Labels for the deployment. For managing deployment config + like verifying, source of deployment config, etc. + additionalProperties: + type: string + type: object + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata + GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse: + id: GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse + description: Response message for TensorboardService.ListTensorboardTimeSeries. + type: object + properties: + tensorboardTimeSeries: + description: The TensorboardTimeSeries mathching the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + nextPageToken: + type: string + description: >- + A token, which can be sent as + ListTensorboardTimeSeriesRequest.page_token to retrieve the next + page. If this field is omitted, there are no subsequent pages. + GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig: + properties: + modelVersion: + type: string + description: >- + Required. Full resource name of ml engine model version. Format: + `projects/{project}/models/{model}/versions/{version}`. + modelDisplayName: + type: string + description: >- + Required. Display name of the model in Vertex AI. System will pick a + display name if unspecified. + endpoint: + description: >- + Required. The ml.googleapis.com endpoint that this model version + should be migrated from. Example values: * ml.googleapis.com * + us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * + asia-east1-ml.googleapis.com + type: string + description: Config for migrating version in ml.googleapis.com to Vertex AI's Model. + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig + type: object + GoogleCloudAiplatformV1Dataset: + properties: + dataItemCount: + description: >- + Output only. The number of DataItems in this Dataset. Only apply for + non-structured Dataset. + format: int64 + readOnly: true + type: string + labels: + type: object + additionalProperties: + type: string + description: >- + The labels with user-defined metadata to organize your Datasets. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Dataset (System + labels are excluded). See https://goo.gl/xmQnxf for more information + and examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for each Dataset: * + "aiplatform.googleapis.com/dataset_metadata_schema": output only, + its value is the metadata_schema's title. + encryptionSpec: + description: >- + Customer-managed encryption key spec for a Dataset. If set, this + Dataset and all sub-resources of this Dataset will be secured by + this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + updateTime: + format: google-datetime + readOnly: true + type: string + description: Output only. Timestamp when this Dataset was last updated. + etag: + type: string + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + metadataSchemaUri: + description: >- + Required. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Dataset. The schema is + defined as an OpenAPI 3.0.2 Schema Object. The schema files that can + be used here are found in + gs://google-cloud-aiplatform/schema/dataset/metadata/. + type: string + description: + description: The description of the Dataset. + type: string + displayName: + type: string + description: >- + Required. The user-defined name of the Dataset. The name can be up + to 128 characters long and can consist of any UTF-8 characters. + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + metadata: + description: Required. Additional information about the Dataset. + type: any + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + name: + type: string + readOnly: true + description: Output only. Identifier. The resource name of the Dataset. + savedQueries: + type: array + description: >- + All SavedQueries belong to the Dataset will be returned in List/Get + Dataset response. The annotation_specs field will not be populated + except for UI cases which will only use annotation_spec_count. In + CreateDataset request, a SavedQuery is created together if this + field is set, up to one SavedQuery can be set in + CreateDatasetRequest. The SavedQuery should not contain any + AnnotationSpec. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + metadataArtifact: + type: string + description: >- + Output only. The resource name of the Artifact that was created in + MetadataStore when creating the Dataset. The Artifact resource name + pattern is + `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + readOnly: true + modelReference: + type: string + description: >- + Optional. Reference to the public base model last used by the + dataset. Only set for prompt datasets. + createTime: + type: string + readOnly: true + description: Output only. Timestamp when this Dataset was created. + format: google-datetime + id: GoogleCloudAiplatformV1Dataset + type: object + description: A collection of DataItems and Annotations on them. + GoogleCloudAiplatformV1EvaluateInstancesResponse: + type: object + properties: + questionAnsweringRelevanceResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult + description: Result for question answering relevance metric. + fluencyResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyResult' + description: >- + LLM-based metric evaluation result. General text generation metrics, + applicable to other categories. Result for fluency metric. + pointwiseMetricResult: + description: Generic metrics. Result for pointwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricResult' + bleuResults: + description: Results for bleu metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuResults' + rougeResults: + description: Results for rouge metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeResults' + summarizationHelpfulnessResult: + description: Result for summarization helpfulness metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessResult + toolNameMatchResults: + description: Results for tool name match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchResults' + summarizationVerbosityResult: + description: Result for summarization verbosity metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityResult + groundednessResult: + description: Result for groundedness metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessResult' + summarizationQualityResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityResult + description: Summarization only metrics. Result for summarization quality metric. + questionAnsweringCorrectnessResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult + description: Result for question answering correctness metric. + questionAnsweringHelpfulnessResult: + description: Result for question answering helpfulness metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult + exactMatchResults: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchResults' + description: Auto metric evaluation results. Results for exact match metric. + safetyResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyResult' + description: Result for safety metric. + toolCallValidResults: + description: Tool call metrics. Results for tool call valid metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidResults' + pairwiseMetricResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricResult' + description: Result for pairwise metric. + toolParameterKeyMatchResults: + description: Results for tool parameter key match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchResults + questionAnsweringQualityResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityResult + description: >- + Question answering only metrics. Result for question answering + quality metric. + pairwiseSummarizationQualityResult: + description: Result for pairwise summarization quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityResult + pairwiseQuestionAnsweringQualityResult: + description: Result for pairwise question answering quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult + coherenceResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceResult' + description: Result for coherence metric. + toolParameterKvMatchResults: + description: Results for tool parameter key value match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchResults + fulfillmentResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentResult' + description: Result for fulfillment metric. + id: GoogleCloudAiplatformV1EvaluateInstancesResponse + description: Response message for EvaluationService.EvaluateInstances. + GoogleCloudAiplatformV1DeleteFeatureValuesRequest: + description: Request message for FeaturestoreService.DeleteFeatureValues. + properties: + selectEntity: + description: Select feature values to be deleted by specifying entities. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + selectTimeRangeAndFeature: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature + description: >- + Select feature values to be deleted by specifying time range and + features. + type: object + id: GoogleCloudAiplatformV1DeleteFeatureValuesRequest + GoogleCloudAiplatformV1ListDatasetVersionsResponse: + id: GoogleCloudAiplatformV1ListDatasetVersionsResponse + description: Response message for DatasetService.ListDatasetVersions. + type: object + properties: + nextPageToken: + description: The standard List next-page token. + type: string + datasetVersions: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + type: array + description: >- + A list of DatasetVersions that matches the specified filter in the + request. + GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest: + type: object + properties: + writeRunDataRequests: + description: >- + Required. Requests containing per-run TensorboardTimeSeries data to + write. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + type: array + id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest + description: Request message for TensorboardService.WriteTensorboardExperimentData. + GoogleCloudAiplatformV1ServiceAccountSpec: + description: >- + Configuration for the use of custom service account to run the + workloads. + properties: + serviceAccount: + description: >- + Optional. Required when all below conditions are met * + `enable_custom_service_account` is true; * any runtime is specified + via `ResourceRuntimeSpec` on creation time, for example, Ray The + users must have `iam.serviceAccounts.actAs` permission on this + service account and then the specified runtime containers will run + as it. Do not set this field if you want to submit jobs using custom + service account to this PersistentResource after creation, but only + specify the `service_account` inside the job. + type: string + enableCustomServiceAccount: + description: >- + Required. If true, custom user-managed service account is enforced + to run any workloads (for example, Vertex Jobs) on the resource. + Otherwise, uses the [Vertex AI Custom Code Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + type: boolean + type: object + id: GoogleCloudAiplatformV1ServiceAccountSpec + GoogleCloudAiplatformV1SuggestTrialsRequest: + properties: + clientId: + type: string + description: >- + Required. The identifier of the client that is requesting the + suggestion. If multiple SuggestTrialsRequests have the same + `client_id`, the service will return the identical suggested Trial + if the Trial is pending, and provide a new Trial if the last + suggested Trial was completed. + suggestionCount: + format: int32 + description: Required. The number of suggestions requested. It must be positive. + type: integer + contexts: + description: >- + Optional. This allows you to specify the "context" for a Trial; a + context is a slice (a subspace) of the search space. Typical uses + for contexts: 1) You are using Vizier to tune a server for best + performance, but there's a strong weekly cycle. The context + specifies the day-of-week. This allows Tuesday to generalize from + Wednesday without assuming that everything is identical. 2) Imagine + you're optimizing some medical treatment for people. As they walk in + the door, you know certain facts about them (e.g. sex, weight, + height, blood-pressure). Put that information in the context, and + Vizier will adapt its suggestions to the patient. 3) You want to do + a fair A/B test efficiently. Specify the "A" and "B" conditions as + contexts, and Vizier will generalize between "A" and "B" conditions. + If they are similar, this will allow Vizier to converge to the + optimum faster than if "A" and "B" were separate Studies. NOTE: You + can also enter contexts as REQUESTED Trials, e.g. via the + CreateTrial() RPC; that's the asynchronous option where you don't + need a close association between contexts and suggestions. NOTE: All + the Parameters you set in a context MUST be defined in the Study. + NOTE: You must supply 0 or $suggestion_count contexts. If you don't + supply any contexts, Vizier will make suggestions from the full + search space specified in the StudySpec; if you supply a full set of + context, each suggestion will match the corresponding context. NOTE: + A Context with no features set matches anything, and allows + suggestions from the full search space. NOTE: Contexts MUST lie + within the search space specified in the StudySpec. It's an error if + they don't. NOTE: Contexts preferentially match ACTIVE then + REQUESTED trials before new suggestions are generated. NOTE: + Generation of suggestions involves a match between a Context and + (optionally) a REQUESTED trial; if that match is not fully + specified, a suggestion will be geneated in the merged subspace. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialContext' + type: array + id: GoogleCloudAiplatformV1SuggestTrialsRequest + type: object + description: Request message for VizierService.SuggestTrials. + GoogleCloudAiplatformV1FulfillmentResult: + type: object + description: Spec for fulfillment result. + properties: + confidence: + format: float + description: Output only. Confidence for fulfillment score. + type: number + readOnly: true + explanation: + type: string + readOnly: true + description: Output only. Explanation for fulfillment score. + score: + readOnly: true + description: Output only. Fulfillment score. + type: number + format: float + id: GoogleCloudAiplatformV1FulfillmentResult + GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue: + description: Tool parameter key value match metric value for an instance. + type: object + id: GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue + properties: + score: + type: number + format: float + readOnly: true + description: Output only. Tool parameter key value match score. + GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse: + description: Response message for TensorboardService.ExportTensorboardTimeSeriesData. + id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + type: object + properties: + nextPageToken: + type: string + 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. + timeSeriesDataPoints: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + description: The returned time series data points. + GoogleCloudAiplatformV1CreateEndpointOperationMetadata: + description: Runtime operation information for EndpointService.CreateEndpoint. + id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata + type: object + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata: + type: object + properties: + genericMetadata: + description: Operation metadata for Feature. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata + description: Details of operations that perform batch create Features. + GoogleCloudAiplatformV1SchemaTextDataItem: + type: object + description: Payload of Text DataItem. + properties: + gcsUri: + type: string + description: >- + Output only. Google Cloud Storage URI points to the original text in + user's bucket. The text file is up to 10MB in size. + readOnly: true + id: GoogleCloudAiplatformV1SchemaTextDataItem + GoogleCloudAiplatformV1Schema: + properties: + default: + type: any + description: Optional. Default value of the data. + enum: + description: >- + Optional. Possible values of the element of Type.STRING with enum + format. For example we can define an Enum Direction as : + {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + type: array + items: + type: string + minimum: + description: >- + Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of + the Type.INTEGER and Type.NUMBER + type: number + format: double + maxItems: + description: Optional. Maximum number of the elements for Type.ARRAY. + format: int64 + type: string + minLength: + description: >- + Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the + Type.STRING + type: string + format: int64 + propertyOrdering: + items: + type: string + type: array + description: >- + Optional. The order of the properties. Not a standard field in open + api spec. Only used to support the order of the properties. + required: + description: Optional. Required properties of Type.OBJECT. + items: + type: string + type: array + title: + description: Optional. The title of the Schema. + type: string + example: + type: any + description: >- + Optional. Example of the object. Will only populated when the object + is the root. + type: + enumDescriptions: + - Not specified, should not be used. + - OpenAPI string type + - OpenAPI number type + - OpenAPI integer type + - OpenAPI boolean type + - OpenAPI array type + - OpenAPI object type + description: Optional. The type of the data. + type: string + enum: + - TYPE_UNSPECIFIED + - STRING + - NUMBER + - INTEGER + - BOOLEAN + - ARRAY + - OBJECT + maxProperties: + description: Optional. Maximum number of the properties for Type.OBJECT. + format: int64 + type: string + nullable: + type: boolean + description: Optional. Indicates if the value may be null. + minItems: + type: string + format: int64 + description: Optional. Minimum number of the elements for Type.ARRAY. + pattern: + description: >- + Optional. Pattern of the Type.STRING to restrict a string to a + regular expression. + type: string + maxLength: + description: Optional. Maximum length of the Type.STRING + type: string + format: int64 + description: + description: Optional. The description of the data. + type: string + properties: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + type: object + description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + format: + type: string + description: >- + Optional. The format of the data. Supported formats: for NUMBER + type: "float", "double" for INTEGER type: "int32", "int64" for + STRING type: "email", "byte", etc + minProperties: + format: int64 + type: string + description: Optional. Minimum number of the properties for Type.OBJECT. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: >- + Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of + Type.ARRAY. + maximum: + format: double + description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER + type: number + id: GoogleCloudAiplatformV1Schema + description: >- + Schema is used to define the format of input/output data. Represents a + select subset of an [OpenAPI 3.0 schema + object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields + may be added in the future as needed. + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult + type: object + description: Prediction output format for Video Object Tracking. + properties: + id: + description: The resource ID of the AnnotationSpec that had been identified. + type: string + displayName: + description: The display name of the AnnotationSpec that had been identified. + type: string + timeSegmentEnd: + type: string + format: google-duration + description: >- + The end, inclusive, of the video's time segment in which the object + instance has been detected. Expressed as a number of seconds as + measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. + frames: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame + description: >- + All of the frames of the video in which a single object instance has + been detected. The bounding boxes in the frames identify the same + object. + type: array + timeSegmentStart: + type: string + format: google-duration + description: >- + The beginning, inclusive, of the video's time segment in which the + object instance has been detected. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. + confidence: + description: >- + The Model's confidence in correction of this prediction, higher + value means higher confidence. + type: number + format: float + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs + type: object + properties: + optimizationObjective: + type: string + description: >- + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. + timeColumn: + type: string + description: >- + The name of the column that identifies time order in the time + series. This column must be available at forecast. + transformations: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation + description: >- + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. + weightColumn: + description: >- + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. This column must be available at forecast. + type: string + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. + type: string + targetColumn: + description: >- + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + type: string + validationOptions: + type: string + description: >- + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + quantiles: + items: + format: double + type: number + type: array + description: >- + Quantiles to use for minimize-quantile-loss + `optimization_objective`. Up to 5 quantiles are allowed of values + between 0 and 1, exclusive. Required if the value of + optimization_objective is minimize-quantile-loss. Represents the + percent quantiles to use for that objective. Quantiles must be + unique. + hierarchyConfig: + description: >- + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + windowConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + description: Config containing strategy for generating sliding windows. + forecastHorizon: + description: >- + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. + type: string + format: int64 + unavailableAtForecastColumns: + type: array + items: + type: string + description: >- + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. + exportEvaluatedDataItemsConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + description: >- + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + additionalExperiments: + items: + type: string + type: array + description: Additional experiment flags for the time series forcasting training. + trainBudgetMilliNodeHours: + description: >- + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. + type: string + format: int64 + holidayRegions: + description: >- + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. + type: array + items: + type: string + contextWindow: + description: >- + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. + type: string + format: int64 + dataGranularity: + description: Expected difference in time granularity between rows in the data. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity + availableAtForecastColumns: + description: >- + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. + type: array + items: + type: string + timeSeriesAttributeColumns: + type: array + items: + type: string + description: >- + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. + GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest: + id: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest + description: Request message for PipelineService.BatchCancelPipelineJobs. + type: object + properties: + names: + type: array + description: >- + Required. The names of the PipelineJobs to cancel. A maximum of 32 + PipelineJobs can be cancelled in a batch. Format: + `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` + items: + type: string + GoogleCloudAiplatformV1IntegratedGradientsAttribution: + id: GoogleCloudAiplatformV1IntegratedGradientsAttribution + description: >- + An attribution method that computes the Aumann-Shapley value taking + advantage of the model's fully differentiable structure. Refer to this + paper for more details: https://arxiv.org/abs/1703.01365 + properties: + stepCount: + description: >- + Required. The number of steps for approximating the path integral. A + good value to start is 50 and gradually increase until the sum to + diff property is within the desired error range. Valid range of its + value is [1, 100], inclusively. + format: int32 + type: integer + blurBaselineConfig: + description: >- + Config for IG with blur baseline. When enabled, a linear path from + the maximally blurred image to the input image is created. Using a + blurred baseline instead of zero (black image) is motivated by the + BlurIG approach explained here: https://arxiv.org/abs/2004.03383 + $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' + smoothGradConfig: + description: >- + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy + samples in the vicinity of the inputs. Adding noise can help improve + the computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' + type: object + GoogleCloudAiplatformV1SchemaImageDataItem: + type: object + properties: + gcsUri: + description: >- + Required. Google Cloud Storage URI points to the original image in + user's bucket. The image is up to 30MB in size. + type: string + mimeType: + readOnly: true + description: >- + Output only. The mime type of the content of the image. Only the + images in below listed mime types are supported. - image/jpeg - + image/gif - image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + type: string + description: Payload of Image DataItem. + id: GoogleCloudAiplatformV1SchemaImageDataItem + GoogleCloudAiplatformV1Int64Array: + description: A list of int64 values. + id: GoogleCloudAiplatformV1Int64Array + type: object + properties: + values: + items: + type: string + format: int64 + type: array + description: A list of int64 values. + GoogleCloudAiplatformV1SafetySpec: + description: Spec for safety metric. + type: object + id: GoogleCloudAiplatformV1SafetySpec + properties: + version: + type: integer + description: Optional. Which version to use for evaluation. + format: int32 + GoogleCloudAiplatformV1ExportDataConfig: + description: >- + Describes what part of the Dataset is to be exported, the destination of + the export and how to export. + type: object + id: GoogleCloudAiplatformV1ExportDataConfig + properties: + exportUse: + enumDescriptions: + - Regular user export. + - Export for custom code training. + enum: + - EXPORT_USE_UNSPECIFIED + - CUSTOM_CODE_TRAINING + type: string + description: Indicates the usage of the exported files. + filterSplit: + description: Split based on the provided filters for each set. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFilterSplit' + annotationsFilter: + description: >- + An expression for filtering what part of the Dataset is to be + exported. Only Annotations that match this filter will be exported. + The filter syntax is the same as in ListAnnotations. + type: string + fractionSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFractionSplit' + description: Split based on fractions defining the size of each set. + savedQueryId: + description: >- + The ID of a SavedQuery (annotation set) under the Dataset specified + by dataset_id used for filtering Annotations for training. Only used + for custom training data export use cases. Only applicable to + Datasets that have SavedQueries. Only Annotations that are + associated with this SavedQuery are used in respectively training. + When used in conjunction with annotations_filter, the Annotations + used for training are filtered by both saved_query_id and + annotations_filter. Only one of saved_query_id and + annotation_schema_uri should be specified as both of them represent + the same thing: problem type. + type: string + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: >- + The Google Cloud Storage location where the output is to be written + to. In the given directory a new directory will be created with + name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ + ISO-8601 format. All export output will be written into that + directory. Inside that directory, annotations with the same schema + will be grouped into sub directories which are named with the + corresponding annotations' schema title. Inside these sub + directories, a schema.yaml will be created to describe the output + format. + annotationSchemaUri: + type: string + description: >- + The Cloud Storage URI that points to a YAML file describing the + annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/, note that + the chosen schema must be consistent with metadata of the Dataset + specified by dataset_id. Only used for custom training data export + use cases. Only applicable to Datasets that have DataItems and + Annotations. Only Annotations that both match this schema and belong + to DataItems not ignored by the split method are used in + respectively training, validation or test role, depending on the + role of the DataItem they are on. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both annotations_filter and annotation_schema_uri. + GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse: + id: GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + description: >- + Response message for + FeatureOnlineStoreAdminService.ListFeatureOnlineStores. + properties: + nextPageToken: + description: >- + A token, which can be sent as + ListFeatureOnlineStoresRequest.page_token to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + featureOnlineStores: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + description: The FeatureOnlineStores matching the request. + type: object + GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse: + properties: {} + description: Response message for MetadataService.AddContextArtifactsAndExecutions. + id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + type: object + GoogleCloudAiplatformV1FeatureValueList: + type: object + description: Container for list of values. + id: GoogleCloudAiplatformV1FeatureValueList + properties: + values: + description: A list of feature values. All of them should be the same data type. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + type: array + GoogleCloudAiplatformV1FeatureValue: + id: GoogleCloudAiplatformV1FeatureValue + description: Value for a feature. + type: object + properties: + stringValue: + type: string + description: String feature value. + doubleArrayValue: + description: A list of double type feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DoubleArray' + stringArrayValue: + description: A list of string type feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StringArray' + int64ArrayValue: + description: A list of int64 type feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Int64Array' + int64Value: + type: string + description: Int64 feature value. + format: int64 + doubleValue: + type: number + format: double + description: Double type feature value. + metadata: + description: Metadata of feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueMetadata' + boolArrayValue: + description: A list of bool type feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BoolArray' + structValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StructValue' + description: A struct type feature value. + boolValue: + description: Bool type feature value. + type: boolean + bytesValue: + description: Bytes feature value. + type: string + format: byte + GoogleCloudAiplatformV1FindNeighborsRequestQuery: + description: >- + A query to find a number of the nearest neighbors (most similar vectors) + of a vector. + type: object + properties: + fractionLeafNodesToSearchOverride: + type: number + description: >- + The fraction of the number of leaves to search, set at query time + allows user to tune search performance. This value increase result + in both search accuracy and latency increase. The value should be + between 0.0 and 1.0. If not set or set to 0.0, query uses the + default value specified in + NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search. + format: double + neighborCount: + format: int32 + type: integer + description: >- + The number of nearest neighbors to be retrieved from database for + each query. If not set, will use the default from the service + configuration + (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config). + approximateNeighborCount: + format: int32 + type: integer + description: >- + The number of neighbors to find via approximate search before exact + reordering is performed. If not set, the default value from scam + config is used; if set, this value must be > 0. + perCrowdingAttributeNeighborCount: + type: integer + format: int32 + description: >- + Crowding is a constraint on a neighbor list produced by nearest + neighbor search requiring that no more than some value k' of the k + neighbors returned have the same value of crowding_attribute. It's + used for improving result diversity. This field is the maximum + number of matches with the same crowding tag. + datapoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + description: >- + Required. The datapoint/vector whose nearest neighbors should be + searched for. + rrf: + description: Optional. Represents RRF algorithm that combines search results. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF + id: GoogleCloudAiplatformV1FindNeighborsRequestQuery + GoogleCloudAiplatformV1ScheduleRunResponse: + description: Status of a scheduled run. + properties: + runResponse: + description: The response of the scheduled run. + type: string + scheduledRunTime: + type: string + format: google-datetime + description: The scheduled run time based on the user-specified schedule. + type: object + id: GoogleCloudAiplatformV1ScheduleRunResponse + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation: + properties: + displayName: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + type: string + annotationSpecId: + type: string + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + vertexes: + description: >- + The vertexes are connected one by one and the last vertex in not + connected to the first one. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' + type: array + description: Represents a polyline in image. + id: >- + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + type: object + GoogleCloudAiplatformV1ListAnnotationsResponse: + description: Response message for DatasetService.ListAnnotations. + properties: + annotations: + type: array + description: >- + A list of Annotations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' + nextPageToken: + type: string + description: The standard List next-page token. + id: GoogleCloudAiplatformV1ListAnnotationsResponse + type: object + GoogleCloudAiplatformV1GenerationConfig: + properties: + responseMimeType: + description: >- + Optional. Output response mimetype of the generated candidate text. + Supported mimetype: - `text/plain`: (default) Text output. - + `application/json`: JSON response in the candidates. The model needs + to be prompted to output the appropriate response type, otherwise + the behavior is undefined. This is a preview feature. + type: string + routingConfig: + description: Optional. Routing configuration. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfig + frequencyPenalty: + format: float + description: Optional. Frequency penalties. + type: number + stopSequences: + items: + type: string + description: Optional. Stop sequences. + type: array + responseSchema: + description: >- + Optional. The `Schema` object allows the definition of input and + output data types. These types can be objects, but also primitives + and arrays. Represents a select subset of an [OpenAPI 3.0 schema + object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a + compatible response_mime_type must also be set. Compatible + mimetypes: `application/json`: Schema for JSON response. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + presencePenalty: + format: float + type: number + description: Optional. Positive penalties. + maxOutputTokens: + description: >- + Optional. The maximum number of output tokens to generate per + message. + format: int32 + type: integer + temperature: + description: Optional. Controls the randomness of predictions. + format: float + type: number + topK: + description: Optional. If specified, top-k sampling will be used. + format: float + type: number + seed: + description: Optional. Seed. + format: int32 + type: integer + candidateCount: + type: integer + format: int32 + description: Optional. Number of candidates to generate. + topP: + type: number + description: Optional. If specified, nucleus sampling will be used. + format: float + id: GoogleCloudAiplatformV1GenerationConfig + description: Generation config. type: object - GoogleCloudAiplatformV1CancelTrainingPipelineRequest: - properties: {} - id: GoogleCloudAiplatformV1CancelTrainingPipelineRequest - description: Request message for PipelineService.CancelTrainingPipeline. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs: type: object - GoogleCloudAiplatformV1DiskSpec: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + properties: {} + GoogleCloudAiplatformV1FulfillmentSpec: properties: - bootDiskType: - type: string - description: >- - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" - (Persistent Disk Solid State Drive) or "pd-standard" (Persistent - Disk Hard Disk Drive). - bootDiskSizeGb: - description: Size in GB of the boot disk (default is 100GB). + version: + description: Optional. Which version to use for evaluation. format: int32 type: integer - id: GoogleCloudAiplatformV1DiskSpec + id: GoogleCloudAiplatformV1FulfillmentSpec type: object - description: Represents the spec of disk options. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking: - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs - description: The input parameters of this TrainingJob. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking + description: Spec for fulfillment metric. + GoogleTypeDate: type: object + id: GoogleTypeDate description: >- - A TrainingJob that trains and uploads an AutoML Video ObjectTracking - Model. - GoogleCloudAiplatformV1FluencyInput: - type: object - properties: - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencySpec' - description: Required. Spec for fluency score metric. - instance: - description: Required. Fluency instance. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInstance' - description: Input for fluency metric. - id: GoogleCloudAiplatformV1FluencyInput - GoogleCloudAiplatformV1RemoveContextChildrenResponse: - description: Response message for MetadataService.RemoveContextChildren. - id: GoogleCloudAiplatformV1RemoveContextChildrenResponse - type: object - properties: {} - GoogleCloudAiplatformV1ExplainRequest: - type: object + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp properties: - parameters: - type: any - description: >- - The parameters that govern the prediction. The schema of the - parameters may be specified via Endpoint's DeployedModels' Model's - PredictSchemata's parameters_schema_uri. - explanationSpecOverride: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpecOverride' + month: description: >- - If specified, overrides the explanation_spec of the DeployedModel. - Can be used for explaining prediction results with different - configurations, such as: - Explaining top-5 predictions results as - opposed to top-1; - Increasing path count or step count of the - attribution methods to reduce approximate errors; - Using different - baselines for explaining the prediction results. - instances: - type: array + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + day: + type: integer description: >- - Required. The instances that are the input to the explanation call. - A DeployedModel may have an upper limit on the number of instances - it supports per request, and when it is exceeded the explanation - call errors in case of AutoML Models, or, in case of customer - created Models, the behaviour is as documented by that Model. The - schema of any single instance may be specified via Endpoint's - DeployedModels' Model's PredictSchemata's instance_schema_uri. - items: - type: any - deployedModelId: + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + year: + format: int32 + type: integer description: >- - If specified, this ExplainRequest will be served by the chosen - DeployedModel, overriding Endpoint.traffic_split. - type: string - description: Request message for PredictionService.Explain. - id: GoogleCloudAiplatformV1ExplainRequest - GoogleCloudAiplatformV1FindNeighborsRequest: - type: object - id: GoogleCloudAiplatformV1FindNeighborsRequest + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + GoogleCloudAiplatformV1DeploymentResourcePool: properties: - returnFullDatapoint: - type: boolean + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' description: >- - If set to true, the full datapoints (including all vector values and - restricts) of the nearest neighbors are returned. Note that - returning full datapoint will significantly increase the latency and - cost of the query. - queries: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQuery - description: The list of queries. - type: array - deployedIndexId: + Required. The underlying DedicatedResources that the + DeploymentResourcePool uses. + serviceAccount: description: >- - The ID of the DeployedIndex that will serve the request. This - request is sent to a specific IndexEndpoint, as per the - IndexEndpoint.network. That IndexEndpoint also has - IndexEndpoint.deployed_indexes, and each such index has a - DeployedIndex.id field. The value of the field below must equal one - of the DeployedIndex.id fields of the IndexEndpoint that is being - called for this request. - type: string - description: The request message for MatchService.FindNeighbors. - GoogleCloudAiplatformV1CreateFeatureRequest: - id: GoogleCloudAiplatformV1CreateFeatureRequest - properties: - parent: + The service account that the DeploymentResourcePool's container(s) + run as. Specify the email address of the service account. If this + service account is not specified, the container(s) run as a service + account that doesn't have access to the resource project. Users + deploying the Models to this DeploymentResourcePool must have the + `iam.serviceAccounts.actAs` permission on this service account. type: string + disableContainerLogging: + type: boolean 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}` - feature: - description: Required. The Feature to create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - 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. - type: string - description: >- - Request message for FeaturestoreService.CreateFeature. Request message - for FeatureRegistryService.CreateFeature. - type: object - GoogleCloudAiplatformV1MetadataStore: - properties: - dataplexConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MetadataStoreDataplexConfig - description: Optional. Dataplex integration settings. - state: - readOnly: true - description: Output only. State information of the MetadataStore. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + If the DeploymentResourcePool is deployed with custom-trained Models + or AutoML Tabular Models, the container(s) of the + DeploymentResourcePool will send `stderr` and `stdout` streams to + Cloud Logging by default. Please note that the logs incur cost, + which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging/pricing). User can disable + container logging by setting this flag to true. name: type: string - description: Output only. The resource name of the MetadataStore instance. - readOnly: true - createTime: - format: google-datetime - type: string - readOnly: true - description: Output only. Timestamp when this MetadataStore was created. - description: - description: Description of the MetadataStore. - type: string + description: >- + Immutable. The resource name of the DeploymentResourcePool. Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Customer-managed encryption key spec for a Metadata Store. If set, - this Metadata Store and all sub-resources of this Metadata Store are - secured using this key. - updateTime: - type: string - format: google-datetime + Customer-managed encryption key spec for a DeploymentResourcePool. + If set, this DeploymentResourcePool will be secured by this key. + Endpoints and the DeploymentResourcePool they deploy in need to have + the same EncryptionSpec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean readOnly: true - description: Output only. Timestamp when this MetadataStore was last updated. - description: >- - Instance of a metadata store. Contains a set of metadata that can be - queried. - id: GoogleCloudAiplatformV1MetadataStore - type: object - GoogleCloudAiplatformV1DeployedIndex: - properties: createTime: type: string - description: Output only. Timestamp when the DeployedIndex was created. format: google-datetime readOnly: true - dedicatedResources: - description: >- - Optional. A description of resources that are dedicated to the - DeployedIndex, and that need a higher degree of manual - configuration. The field min_replica_count must be set to a value - strictly greater than 0, or else validation will fail. We don't - provide SLA when min_replica_count=1. If max_replica_count is not - set, the default value is min_replica_count. The max allowed replica - count is 1000. Available machine types for SMALL shard: - e2-standard-2 and all machine types available for MEDIUM and LARGE - shard. Available machine types for MEDIUM shard: e2-standard-16 and - all machine types available for LARGE shard. Available machine types - for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and - n1-standard-32 are still available, but we recommend e2-standard-16 - and e2-highmem-16 for cost efficiency. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' - privateEndpoints: - description: >- - Output only. Provides paths for users to send requests directly to - the deployed index services running on Cloud via private services - access. This field is populated if network is configured. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' - deployedIndexAuthConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' - description: >- - Optional. If set, the authentication is enabled for the private - endpoint. - automaticResources: - description: >- - Optional. A description of resources that the DeployedIndex uses, - which to large degree are decided by Vertex AI, and optionally - allows only a modest additional configuration. If min_replica_count - is not set, the default value is 2 (we don't provide SLA when - min_replica_count=1). If max_replica_count is not set, the default - value is min_replica_count. The max allowed replica count is 1000. - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - id: - type: string - description: >- - Required. The user specified ID of the DeployedIndex. The ID can be - up to 128 characters long and must start with a letter and only - contain letters, numbers, and underscores. The ID must be unique - within the project it is created in. - displayName: - description: >- - The display name of the DeployedIndex. If not provided upon - creation, the Index's display_name is used. - type: string - reservedIpRanges: - type: array - description: >- - Optional. A list of reserved ip ranges under the VPC network that - can be used for this DeployedIndex. If set, we will deploy the index - within the provided ip ranges. Otherwise, the index might be - deployed to any ip ranges under the provided VPC network. The value - should be the name of the address - (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) - Example: ['vertex-ai-ip-range']. For more information about subnets - and network IP ranges, please see - https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. - items: - type: string - enableAccessLogging: + description: Output only. Timestamp when this DeploymentResourcePool was created. + satisfiesPzs: type: boolean - description: >- - Optional. If true, private endpoint's access logs are sent to Cloud - Logging. These logs are like standard server access logs, containing - information like timestamp and latency for each MatchRequest. Note - that logs may incur a cost, especially if the deployed index - receives a high queries per second rate (QPS). Estimate your costs - before enabling this option. - indexSyncTime: - description: >- - Output only. The DeployedIndex may depend on various data on its - original Index. Additionally when certain changes to the original - Index are being done (e.g. when what the Index contains is being - changed) the DeployedIndex may be asynchronously updated in the - background to reflect these changes. If this timestamp's value is at - least the Index.update_time of the original Index, it means that - this DeployedIndex and the original Index are in sync. If this - timestamp is older, then to see which updates this DeployedIndex - already contains (and which it does not), one must list the - operations that are running on the original Index. Only the - successfully completed Operations with update_time equal or before - this sync time are contained in this DeployedIndex. - format: google-datetime - type: string + description: Output only. Reserved for future use. readOnly: true - index: - type: string - description: >- - Required. The name of the Index this is the deployment of. We may - refer to this Index as the DeployedIndex's "original" Index. - deploymentGroup: - description: >- - Optional. The deployment group can be no longer than 64 characters - (eg: 'test', 'prod'). If not set, we will use the 'default' - deployment group. Creating `deployment_groups` with - `reserved_ip_ranges` is a recommended practice when the peered - network has multiple peering ranges. This creates your deployments - from predictable IP spaces for easier traffic administration. Also, - one deployment_group (except 'default') can only be used with the - same reserved_ip_ranges which means if the deployment_group has been - used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, - e] is disallowed. Note: we only support up to 5 deployment - groups(not including 'default'). - type: string type: object - id: GoogleCloudAiplatformV1DeployedIndex + id: GoogleCloudAiplatformV1DeploymentResourcePool description: >- - A deployment of an Index. IndexEndpoints contain one or more - DeployedIndexes. - GoogleCloudAiplatformV1SummarizationHelpfulnessInput: - type: object - description: Input for summarization helpfulness metric. - properties: - instance: - description: Required. Summarization helpfulness instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInstance - metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessSpec - description: Required. Spec for summarization helpfulness score metric. - id: GoogleCloudAiplatformV1SummarizationHelpfulnessInput - GoogleCloudAiplatformV1GroundednessInput: - description: Input for groundedness metric. - type: object - id: GoogleCloudAiplatformV1GroundednessInput - properties: - instance: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInstance' - description: Required. Groundedness instance. - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessSpec' - description: Required. Spec for groundedness metric. - GoogleCloudAiplatformV1ToolParameterKVMatchResults: - id: GoogleCloudAiplatformV1ToolParameterKVMatchResults - properties: - toolParameterKvMatchMetricValues: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue - type: array - readOnly: true - description: Output only. Tool parameter key value match metric values. - description: Results for tool parameter key value match metric. + A description of resources that can be shared by multiple + DeployedModels, whose underlying specification consists of a + DedicatedResources. + GoogleCloudAiplatformV1UpdateExplanationDatasetResponse: + id: GoogleCloudAiplatformV1UpdateExplanationDatasetResponse + properties: {} + description: Response message of ModelService.UpdateExplanationDataset operation. type: object - GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig: - description: Configuration options for the tree-AH algorithm. - id: GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig + GoogleCloudAiplatformV1TrainingPipeline: type: object + description: >- + The TrainingPipeline orchestrates tasks associated with training a + Model. It always executes the training task, and optionally may also + export data from Vertex AI's Dataset which becomes the training input, + upload the Model to Vertex AI, and evaluate the Model. + id: GoogleCloudAiplatformV1TrainingPipeline properties: - leafNodeEmbeddingCount: + startTime: type: string description: >- - Optional. Number of embeddings on each leaf node. The default value - is 1000 if not set. - format: int64 - GoogleCloudAiplatformV1FunctionCallingConfig: - id: GoogleCloudAiplatformV1FunctionCallingConfig - type: object - properties: - mode: - enumDescriptions: - - Unspecified function calling mode. This value should not be used. - - >- - Default model behavior, model decides to predict either function - calls or natural language response. - - >- - Model is constrained to always predicting function calls only. If - "allowed_function_names" are set, the predicted function calls - will be limited to any one of "allowed_function_names", else the - predicted function calls will be any one of the provided - "function_declarations". - - >- - Model will not predict any function calls. Model behavior is same - as when not passing any function declarations. - enum: - - MODE_UNSPECIFIED - - AUTO - - ANY - - NONE + Output only. Time when the TrainingPipeline for the first time + entered the `PIPELINE_STATE_RUNNING` state. + format: google-datetime + readOnly: true + modelId: type: string - description: Optional. Function calling mode. - allowedFunctionNames: - type: array description: >- - Optional. Function names to call. Only set when the Mode is ANY. - Function names should match [FunctionDeclaration.name]. With mode - set to ANY, model will predict a function call from the set of - function names provided. - items: - type: string - description: Function calling config. - GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail: - type: object - description: >- - The detail of a container execution. It contains the job names of the - lifecycle of a container execution. - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail - properties: - mainJob: + Optional. The ID to use for the uploaded Model, which will become + the final component of the model 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. + trainingTaskMetadata: + type: any readOnly: true description: >- - Output only. The name of the CustomJob for the main container - execution. + Output only. The metadata information as specified in the + training_task_definition's `metadata`. This metadata is an auxiliary + runtime and final information about the training task. While the + pipeline is running this information is populated only at a best + effort basis. Only present if the pipeline's + training_task_definition contains `metadata` object. + state: type: string - preCachingCheckJob: readOnly: true + description: Output only. The detailed state of the pipeline. + enum: + - PIPELINE_STATE_UNSPECIFIED + - PIPELINE_STATE_QUEUED + - PIPELINE_STATE_PENDING + - PIPELINE_STATE_RUNNING + - PIPELINE_STATE_SUCCEEDED + - PIPELINE_STATE_FAILED + - PIPELINE_STATE_CANCELLING + - PIPELINE_STATE_CANCELLED + - PIPELINE_STATE_PAUSED + enumDescriptions: + - The pipeline state is unspecified. + - >- + The pipeline has been created or resumed, and processing has not + yet begun. + - The service is preparing to run the pipeline. + - The pipeline is in progress. + - The pipeline completed successfully. + - The pipeline failed. + - >- + The pipeline is being cancelled. From this state, the pipeline may + only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED + or PIPELINE_STATE_CANCELLED. + - The pipeline has been cancelled. + - The pipeline has been stopped, and can be resumed. + displayName: + description: Required. The user-defined name of this TrainingPipeline. + type: string + trainingTaskInputs: description: >- - Output only. The name of the CustomJob for the pre-caching-check - container execution. This job will be available if the - PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in - the lifecycle events. + Required. The training task's parameter(s), as specified in the + training_task_definition's `inputs`. + type: any + endTime: + description: >- + Output only. Time when the TrainingPipeline entered any of the + following states: `PIPELINE_STATE_SUCCEEDED`, + `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. + readOnly: true type: string - failedPreCachingCheckJobs: + format: google-datetime + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Output only. The names of the previously failed CustomJob for the - pre-caching-check container executions. This job will be available - if the PipelineJob.pipeline_spec specifies the `pre_caching_check` - hook in the lifecycle events. The list includes the all attempts in - chronological order. - items: - type: string - readOnly: true - type: array - failedMainJobs: - items: + Customer-managed encryption key spec for a TrainingPipeline. If set, + this TrainingPipeline will be secured by this key. Note: Model + trained by this TrainingPipeline is also secured by this key if + model_to_upload is not set separately. + labels: + type: object + additionalProperties: type: string description: >- - Output only. The names of the previously failed CustomJob for the - main container executions. The list includes the all attempts in - chronological order. - type: array + The labels with user-defined metadata to organize TrainingPipelines. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + name: + description: Output only. Resource name of the TrainingPipeline. readOnly: true - GoogleCloudAiplatformV1RayMetricSpec: - type: object - properties: - disabled: - type: boolean - description: Optional. Flag to disable the Ray metrics collection. - description: Configuration for the Ray metrics. - id: GoogleCloudAiplatformV1RayMetricSpec - GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec: - type: object - properties: - useElapsedDuration: - type: boolean + type: string + inputDataConfig: description: >- - This bool determines whether or not the rule is applied based on - elapsed_secs or steps. If use_elapsed_duration==false, the early - stopping decision is made according to the predicted objective - values according to the target steps. If use_elapsed_duration==true, - elapsed_secs is used instead of steps. Also, in this case, the - parameters max_num_steps and min_num_steps are overloaded to contain - max_elapsed_seconds and min_elapsed_seconds. - minStepCount: + Specifies Vertex AI owned input data that may be used for training + the Model. The TrainingPipeline's training_task_definition should + make clear whether this config is used and if there are any special + requirements on how it should be filled. If nothing about this + config is mentioned in the training_task_definition, then it should + be assumed that the TrainingPipeline does not depend on this + configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1InputDataConfig' + parentModel: description: >- - Minimum number of steps for a trial to complete. Trials which do not - have a measurement with step_count > min_step_count won't be - considered for early stopping. It's ok to set it to 0, and a trial - can be early stopped at any stage. By default, min_step_count is set - to be one-tenth of the max_step_count. When use_elapsed_duration is - true, this field is set to the minimum elapsed seconds. - format: int64 + Optional. When specify this field, the `model_to_upload` will not be + uploaded as a new model, instead, it will become a new version of + this `parent_model`. type: string - maxStepCount: - format: int64 + error: description: >- - Steps used in predicting the final objective for early stopped - trials. In general, it's set to be the same as the defined steps in - training / tuning. If not defined, it will learn it from the - completed trials. When use_steps is false, this field is set to the - maximum elapsed seconds. - type: string - learningRateParameterName: + Output only. Only populated when the pipeline's state is + `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + modelToUpload: description: >- - The hyper-parameter name used in the tuning job that stands for - learning rate. Leave it blank if learning rate is not in a parameter - in tuning. The learning_rate is used to estimate the objective value - of the ongoing trial. + Describes the Model that may be uploaded (via + ModelService.UploadModel) by this TrainingPipeline. The + TrainingPipeline's training_task_definition should make clear + whether this Model description should be populated, and if there are + any special requirements regarding how it should be filled. If + nothing is mentioned in the training_task_definition, then it should + be assumed that this field should not be filled and the training + task either uploads the Model without a need of this information, or + that training task does not support uploading a Model as part of the + pipeline. When the Pipeline's state becomes + `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded + into Vertex AI, then the model_to_upload's resource name is + populated. The Model is always uploaded into the Project and + Location in which this pipeline is. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + trainingTaskDefinition: type: string - updateAllStoppedTrials: description: >- - ConvexAutomatedStoppingSpec by default only updates the trials that - needs to be early stopped using a newly trained auto-regressive - model. When this flag is set to True, all stopped trials from the - beginning are potentially updated in terms of their - `final_measurement`. Also, note that the training logic of - autoregressive models is different in this case. Enabling this - option has shown better results and this may be the default option - in the future. - type: boolean - minMeasurementCount: + Required. A Google Cloud Storage path to the YAML file that defines + the training task which is responsible for producing the model + artifact, and may also include additional auxiliary work. The + definition files that can be used here are found in + gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. + createTime: + format: google-datetime + readOnly: true + description: Output only. Time when the TrainingPipeline was created. + type: string + updateTime: + readOnly: true type: string description: >- - The minimal number of measurements in a Trial. Early-stopping checks - will not trigger if less than min_measurement_count+1 completed - trials or pending trials with less than min_measurement_count - measurements. If not defined, the default value is 5. - format: int64 - id: GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec - description: >- - Configuration for ConvexAutomatedStoppingSpec. When there are enough - completed trials (configured by min_measurement_count), for pending - trials with enough measurements and steps, the policy first computes an - overestimate of the objective value at max_num_steps according to the - slope of the incomplete objective value curve. No prediction can be made - if the curve is completely flat. If the overestimation is worse than the - best objective value of the completed trials, this pending trial will be - early-stopped, but a last measurement will be added to the pending trial - with max_num_steps and predicted objective value from the autoregression - model. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs: + Output only. Time when the TrainingPipeline was most recently + updated. + format: google-datetime + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification type: object + description: >- + A TrainingJob that trains and uploads an AutoML Video Classification + Model. properties: - sentimentMax: - type: integer - format: int32 - description: >- - A sentiment is expressed as an integer ordinal, where higher value - means a more positive sentiment. The range of sentiments that will - be used is between 0 and sentimentMax (inclusive on both ends), and - all the values in the range must be represented in the dataset - before a model can be created. Only the Annotations with this - sentimentMax will be used for training. sentimentMax value must be - between 1 and 10 (inclusive). - GoogleCloudAiplatformV1GenericOperationMetadata: - description: Generic Metadata shared by all operations. + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + GoogleCloudAiplatformV1ListIndexesResponse: + type: object + description: Response message for IndexService.ListIndexes. properties: - createTime: - description: Output only. Time when the operation was created. - type: string - readOnly: true - format: google-datetime - updateTime: - format: google-datetime + nextPageToken: type: string description: >- - Output only. Time when the operation was updated for the last time. - If the operation has finished (successfully or not), this is the - finish time. - readOnly: true - partialFailures: - items: - $ref: '#/components/schemas/GoogleRpcStatus' + A token to retrieve next page of results. Pass to + ListIndexesRequest.page_token to obtain that page. + indexes: type: array - readOnly: true - description: >- - Output only. Partial failures encountered. E.g. single files that - couldn't be read. This field should never exceed 20 entries. Status - details field will contain standard Google Cloud error details. + description: List of indexes in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + id: GoogleCloudAiplatformV1ListIndexesResponse + GoogleCloudAiplatformV1SpecialistPool: + id: GoogleCloudAiplatformV1SpecialistPool type: object - id: GoogleCloudAiplatformV1GenericOperationMetadata - GoogleCloudAiplatformV1AnnotationSpec: properties: - updateTime: - format: google-datetime + pendingDataLabelingJobs: + items: + type: string readOnly: true - description: Output only. Timestamp when AnnotationSpec was last updated. - type: string - etag: - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - type: string + description: Output only. The resource name of the pending data labeling jobs. + type: array name: - readOnly: true - description: Output only. Resource name of the AnnotationSpec. - type: string - createTime: type: string + description: Required. The resource name of the SpecialistPool. + specialistManagersCount: + type: integer + format: int32 readOnly: true - format: google-datetime - description: Output only. Timestamp when this AnnotationSpec was created. + description: Output only. The number of managers in this SpecialistPool. + specialistWorkerEmails: + type: array + description: The email addresses of workers in the SpecialistPool. + items: + type: string + specialistManagerEmails: + items: + type: string + type: array + description: The email addresses of the managers in the SpecialistPool. displayName: - type: string description: >- - Required. The user-defined name of the AnnotationSpec. The name can + Required. The user-defined name of the SpecialistPool. The name can be up to 128 characters long and can consist of any UTF-8 - characters. - id: GoogleCloudAiplatformV1AnnotationSpec + characters. This field should be unique on project-level. + type: string + description: >- + SpecialistPool represents customers' own workforce to work on their data + labeling jobs. It includes a group of specialist managers and workers. + Managers are responsible for managing the workers in this pool as well + as customers' data labeling jobs associated with this pool. Customers + create specialist pool as well as start data labeling jobs on Cloud, + managers and workers handle the jobs using CrowdCompute console. + GoogleCloudAiplatformV1SyncFeatureViewRequest: + id: GoogleCloudAiplatformV1SyncFeatureViewRequest + properties: {} + description: Request message for FeatureOnlineStoreAdminService.SyncFeatureView. type: object - description: Identifies a concept with which DataItems may be annotated with. - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError: + GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences: + description: >- + The regional resource name or the URI. Key is region, e.g., us-central1, + europe-west2, global, etc.. properties: - errorType: - type: string - description: The error type of this record. - enum: - - ERROR_TYPE_UNSPECIFIED - - EMPTY_LINE - - INVALID_JSON_SYNTAX - - INVALID_CSV_SYNTAX - - INVALID_AVRO_SYNTAX - - INVALID_EMBEDDING_ID - - EMBEDDING_SIZE_MISMATCH - - NAMESPACE_MISSING - - PARSING_ERROR - - DUPLICATE_NAMESPACE - - OP_IN_DATAPOINT - - MULTIPLE_VALUES - - INVALID_NUMERIC_VALUE - - INVALID_ENCODING - - INVALID_SPARSE_DIMENSIONS - - INVALID_TOKEN_VALUE - - INVALID_SPARSE_EMBEDDING - - INVALID_EMBEDDING - enumDescriptions: - - Default, shall not be used. - - The record is empty. - - Invalid json format. - - Invalid csv format. - - Invalid avro format. - - The embedding id is not valid. - - >- - The size of the dense embedding vectors does not match with the - specified dimension. - - The `namespace` field is missing. - - >- - Generic catch-all error. Only used for validation failure where - the root cause cannot be easily retrieved programmatically. - - There are multiple restricts with the same `namespace` value. - - Numeric restrict has operator specified in datapoint. - - Numeric restrict has multiple values specified. - - Numeric restrict has invalid numeric value specified. - - File is not in UTF_8 format. - - Error parsing sparse dimensions field. - - Token restrict value is invalid. - - Invalid sparse embedding. - - Invalid dense embedding. - errorMessage: - description: >- - A human-readable message that is shown to the user to help them fix - the error. Note that this message may change from time to time, your - code should check against error_type as the source of truth. + resourceDescription: type: string - sourceGcsUri: + description: Optional. Description of the resource. + references: + description: Required. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelResourceReference + resourceTitle: + description: Optional. Title of the resource. type: string - description: Cloud Storage URI pointing to the original file in user's bucket. - embeddingId: + title: + description: 'Required. ' type: string - description: Empty if the embedding id is failed to parse. - rawRecord: + resourceUseCase: type: string - description: The original content of this record. - id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError - type: object - GoogleCloudAiplatformV1NearestNeighborQueryEmbedding: + description: Optional. Use case (CUJ) of the resource. type: object - id: GoogleCloudAiplatformV1NearestNeighborQueryEmbedding + id: >- + GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig: properties: - value: - description: Optional. Individual value in the embedding. + userEmails: type: array + description: The email addresses to send the alert. items: - format: float - type: number - description: The embedding vector. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics: + type: string + id: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + type: object + description: The config for email alert. + GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance: + id: GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics - description: >- - Model evaluation metrics for video object tracking problems. Evaluates - prediction quality of both labeled bounding boxes and labeled tracks - (i.e. series of bounding boxes sharing same label and instance ID). properties: - trackMetrics: - description: >- - UNIMPLEMENTED. The tracks match metrics for each - intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + contextWeights: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics + format: float + type: number type: array - boundingBoxMeanAveragePrecision: - format: float - type: number description: >- - The single metric for bounding boxes evaluation: the - `meanAveragePrecision` averaged over all `boundingBoxMetrics`. - boundingBoxMetrics: + TFT feature importance values. Each pair for + {context/horizon/attribute} should have the same shape since the + weight corresponds to the column names. + horizonWeights: + items: + type: number + format: float type: array + attributeColumns: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - description: >- - The bounding boxes match metrics for each intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - evaluatedTrackCount: - type: integer + type: string + type: array + horizonColumns: + type: array + items: + type: string + contextColumns: + type: array + items: + type: string + attributeWeights: + items: + type: number + format: float + type: array + GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField: + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + description: Describe pass-through fields in read_instance source. + type: object + properties: + fieldName: + type: string description: >- - UNIMPLEMENTED. The total number of tracks (i.e. as seen across all - frames) the ground truth used to create this evaluation had. - format: int32 - trackMeanMismatchRate: + Required. The name of the field in the CSV header or the name of the + column in BigQuery table. The naming restriction is the same as + Feature.name. + GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride: + description: The input metadata entries to be overridden. + type: object + id: GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + properties: + inputBaselines: + type: array + items: + type: any description: >- - UNIMPLEMENTED. The single metric for tracking consistency - evaluation: the `meanMismatchRate` averaged over all `trackMetrics`. - format: float + Baseline inputs for this feature. This overrides the + `input_baseline` field of the ExplanationMetadata.InputMetadata + object of the corresponding feature's input metadata. If it's not + specified, the original baselines are not overridden. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics: + properties: + bleu: type: number - trackMeanBoundingBoxIou: description: >- - UNIMPLEMENTED. The single metric for tracks bounding box iou - evaluation: the `meanBoundingBoxIou` averaged over all - `trackMetrics`. + BLEU (bilingual evaluation understudy) scores based on sacrebleu + implementation. + format: float + rougeLSum: + description: ROUGE-L (Longest Common Subsequence) scoring at summary level. type: number format: float - evaluatedBoundingBoxCount: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics + type: object + GoogleCloudAiplatformV1MeasurementMetric: + type: object + properties: + value: + format: double + type: number + description: Output only. The value for this metric. + readOnly: true + metricId: + type: string + readOnly: true description: >- - UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over - all frames) the ground truth used to create this evaluation had. - format: int32 - type: integer - evaluatedFrameCount: + Output only. The ID of the Metric. The Metric should be defined in + StudySpec's Metrics. + id: GoogleCloudAiplatformV1MeasurementMetric + description: A message representing a metric in the measurement. + GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata: + id: GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata + type: object + description: Details of operations that perform import Feature values. + properties: + importedFeatureValueCount: + type: string + format: int64 + description: Number of Feature values that have been imported by the operation. + blockingOperationIds: + items: + format: int64 + type: string description: >- - UNIMPLEMENTED. The number of video frames used to create this - evaluation. - format: int32 - type: integer - trackMeanAveragePrecision: + List of ImportFeatureValues operations running under a single + EntityType that are blocking this operation. + type: array + invalidRowCount: + format: int64 + type: string + description: >- + The number of rows in input source that weren't imported due to + either * Not having any featureValues. * Having a null entityId. * + Having a null timestamp. * Not being parsable (applicable for CSV + sources). + timestampOutsideRetentionRowsCount: description: >- - UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the - `meanAveragePrecision` averaged over all `trackMetrics`. - type: number - format: float - GoogleCloudAiplatformV1GroundednessInstance: - type: object - id: GoogleCloudAiplatformV1GroundednessInstance - properties: - prediction: - description: Required. Output of the evaluated model. + The number rows that weren't ingested due to having timestamps + outside the retention boundary. + format: int64 type: string - context: + importedEntityCount: + format: int64 type: string - description: >- - Required. Background information provided in context used to compare - against the prediction. - description: Spec for groundedness instance. - GoogleCloudAiplatformV1StudyTimeConstraint: + description: Number of entities that have been imported by the operation. + sourceUris: + description: The source URI from where Feature values are imported. + items: + type: string + type: array + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore import Feature values. + GoogleCloudAiplatformV1TrainingConfig: properties: - maxDuration: - description: Counts the wallclock time passed since the creation of this Study. - type: string - format: google-duration - endTime: - format: google-datetime - description: Compares the wallclock time to this time. Must use UTC timezone. + timeoutTrainingMilliHours: type: string - description: Time-based Constraint for Study - id: GoogleCloudAiplatformV1StudyTimeConstraint + description: >- + The timeout hours for the CMLE training job, expressed in milli + hours i.e. 1,000 value in this field means 1 hour. + format: int64 + description: >- + CMLE training config. For every active learning labeling iteration, + system will train a machine learning model on CMLE. The trained model + will be used by data sampling algorithm to select DataItems. + id: GoogleCloudAiplatformV1TrainingConfig type: object - GoogleCloudAiplatformV1ToolNameMatchMetricValue: - description: Tool name match metric value for an instance. + GoogleCloudAiplatformV1ListFeaturestoresResponse: + description: Response message for FeaturestoreService.ListFeaturestores. properties: - score: - format: float - readOnly: true - description: Output only. Tool name match score. - type: number - id: GoogleCloudAiplatformV1ToolNameMatchMetricValue + nextPageToken: + description: >- + A token, which can be sent as ListFeaturestoresRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: string + featurestores: + description: The Featurestores matching the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' type: object - GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance: + id: GoogleCloudAiplatformV1ListFeaturestoresResponse + GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: + description: >- + Feature embedding vector for sparse index. An array of numbers whose + values are located in the specified dimensions. type: object properties: - contextColumns: - type: array - items: - type: string - contextWeights: - description: >- - TFT feature importance values. Each pair for - {context/horizon/attribute} should have the same shape since the - weight corresponds to the column names. + values: type: array + description: Required. The list of embedding values of the sparse vector. items: type: number format: float - horizonWeights: - items: - format: float - type: number - type: array - horizonColumns: - items: - type: string - type: array - attributeColumns: + dimensions: items: + format: int64 type: string + description: >- + Required. The list of indexes for the embedding values of the sparse + vector. type: array - attributeWeights: - type: array - items: - format: float - type: number - id: GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance - GoogleCloudAiplatformV1ImportDataOperationMetadata: + id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + GoogleCloudAiplatformV1SchemaTablesDatasetMetadata: + properties: + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadata type: object - description: Runtime operation information for DatasetService.ImportData. - id: GoogleCloudAiplatformV1ImportDataOperationMetadata + description: The metadata of Datasets that contain tables data. + GoogleCloudAiplatformV1UndeployIndexOperationMetadata: properties: genericMetadata: + description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec: type: object - description: >- - The median automated stopping rule stops a pending Trial if the Trial's - best objective_value is strictly below the median 'performance' of all - completed Trials reported up to the Trial's last measurement. Currently, - 'performance' refers to the running average of the objective values - reported by the Trial in each measurement. + description: Runtime operation information for IndexEndpointService.UndeployIndex. + id: GoogleCloudAiplatformV1UndeployIndexOperationMetadata + GoogleCloudAiplatformV1SchemaImageDatasetMetadata: + type: object + description: The metadata of Datasets that contain Image DataItems. + id: GoogleCloudAiplatformV1SchemaImageDatasetMetadata properties: - useElapsedDuration: + dataItemSchemaUri: description: >- - True if median automated stopping rule applies on - Measurement.elapsed_duration. It means that elapsed_duration field - of latest measurement of current Trial is used to compute median - objective value for each completed Trials. - type: boolean - id: GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec - GoogleCloudAiplatformV1NotebookExecutionJob: - description: NotebookExecutionJob represents an instance of a notebook execution. - properties: - updateTime: + Points to a YAML file stored on Google Cloud Storage describing + payload of the Image DataItems that belong to this Dataset. type: string - readOnly: true - format: google-datetime + gcsBucket: description: >- - Output only. Timestamp when this NotebookExecutionJob was most - recently updated. - createTime: - readOnly: true - type: string - format: google-datetime - description: Output only. Timestamp when this NotebookExecutionJob was created. - notebookRuntimeTemplateResourceName: + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. type: string - description: The NotebookRuntimeTemplate to source compute configuration from. - executionTimeout: + GoogleCloudAiplatformV1PurgeExecutionsRequest: + description: Request message for MetadataService.PurgeExecutions. + properties: + force: + type: boolean description: >- - Max running time of the execution job in seconds (default 86400s / - 24 hrs). + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Execution names + that would be deleted. + filter: + description: >- + Required. A required filter matching the Executions to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. type: string - format: google-duration - gcsOutputUri: + id: GoogleCloudAiplatformV1PurgeExecutionsRequest + type: object + GoogleApiHttpBody: + type: object + properties: + extensions: description: >- - The Cloud Storage location to upload the result to. Format: - `gs://bucket-name` + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + data: + format: byte type: string - serviceAccount: + description: The HTTP request/response body as raw binary. + contentType: type: string - description: The service account to run the execution as. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Customer-managed encryption key spec for the notebook execution job. - This field is auto-populated if the - NotebookService.NotebookRuntimeTemplate has an encryption spec. - displayName: - type: string + The HTTP Content-Type header value specifying the content type of + the body. + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + id: GoogleApiHttpBody + GoogleCloudAiplatformV1DeleteOperationMetadata: + type: object + description: Details of operations that perform deletes of any entities. + id: GoogleCloudAiplatformV1DeleteOperationMetadata + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams: + type: object + description: Prediction model parameters for Video Classification. + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams + properties: + segmentClassification: + type: boolean description: >- - The display name of the NotebookExecutionJob. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - dataformRepositorySource: + Set to true to request segment-level classification. Vertex AI + returns labels and their confidence scores for the entire time + segment of the video that user specified in the input instance. + Default value is true + shotClassification: + type: boolean description: >- - The Dataform Repository pointing to a single file notebook - repository. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource - executionUser: + Set to true to request shot-level classification. Vertex AI + determines the boundaries for each camera shot in the entire time + segment of the video that user specified in the input instance. + Vertex AI then returns labels and their confidence scores for each + detected shot, along with the start and end time of the shot. + WARNING: Model evaluation is not done for this classification type, + the quality of it depends on the training data, but there are no + metrics provided to describe that quality. Default value is false + oneSecIntervalClassification: + type: boolean + description: >- + Set to true to request classification for a video at one-second + intervals. Vertex AI returns labels and their confidence scores for + each second of the entire time segment of the video that user + specified in the input WARNING: Model evaluation is not done for + this classification type, the quality of it depends on the training + data, but there are no metrics provided to describe that quality. + Default value is false + maxPredictions: + type: integer + description: >- + The Model only returns up to that many top, by confidence score, + predictions per instance. If this number is very high, the Model may + return fewer predictions. Default value is 10,000. + format: int32 + confidenceThreshold: + type: number + format: float + description: >- + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + GoogleCloudAiplatformV1MachineSpec: + id: GoogleCloudAiplatformV1MachineSpec + type: object + description: Specification of a single machine. + properties: + acceleratorCount: + description: The number of accelerators to attach to the machine. + format: int32 + type: integer + 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. type: string + reservationAffinity: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReservationAffinity' description: >- - The user email to run the execution as. Only supported by Colab - runtimes. - scheduleResourceName: + Optional. Immutable. Configuration controlling how this resource + pool consumes reservation. + tpuTopology: description: >- - Output only. The Schedule resource name if this job is triggered by - one. Format: - `projects/{project_id}/locations/{location}/schedules/{schedule_id}` + Immutable. The topology of the TPUs. Corresponds to the TPU + topologies available from GKE. (Example: tpu_topology: "2x2x1"). type: string - readOnly: true - name: + acceleratorType: + enumDescriptions: + - Unspecified accelerator type, which means no accelerator. + - >- + Deprecated: Nvidia Tesla K80 GPU has reached end of support, see + https://cloud.google.com/compute/docs/eol/k80-eol. + - Nvidia Tesla P100 GPU. + - Nvidia Tesla V100 GPU. + - Nvidia Tesla P4 GPU. + - Nvidia Tesla T4 GPU. + - Nvidia Tesla A100 GPU. + - Nvidia A100 80GB GPU. + - Nvidia L4 GPU. + - Nvidia H100 80Gb GPU. + - TPU v2. + - TPU v3. + - TPU v4. + - TPU v5. type: string - readOnly: true description: >- - Output only. The resource name of this NotebookExecutionJob. Format: - `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` - gcsNotebookSource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource + Immutable. The type of accelerator(s) that may be attached to the + machine as per accelerator_count. + enum: + - ACCELERATOR_TYPE_UNSPECIFIED + - NVIDIA_TESLA_K80 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_V100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_L4 + - NVIDIA_H100_80GB + - TPU_V2 + - TPU_V3 + - TPU_V4_POD + - TPU_V5_LITEPOD + enumDeprecated: + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult + properties: + sentiment: description: >- - The Cloud Storage url pointing to the ipynb file. Format: - `gs://bucket/notebook_file.ipynb` - labels: + The integer sentiment labels between 0 (inclusive) and sentimentMax + label (inclusive), while 0 maps to the least positive sentiment and + sentimentMax maps to the most positive one. The higher the score is, + the more positive the sentiment in the text snippet is. Note: + sentimentMax is an integer value between 1 (inclusive) and 10 + (inclusive). + format: int32 + type: integer + type: object + description: Prediction output format for Text Sentiment + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation: + type: object + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Convert the category name to a dictionary lookup index and generate an + embedding for each index. + properties: + columnName: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation + GoogleCloudAiplatformV1FunctionCallingConfig: + properties: + allowedFunctionNames: description: >- - The labels with user-defined metadata to organize - NotebookExecutionJobs. Label keys and values can be no longer than - 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. System reserved label keys are - prefixed with "aiplatform.googleapis.com/" and are immutable. - additionalProperties: + Optional. Function names to call. Only set when the Mode is ANY. + Function names should match [FunctionDeclaration.name]. With mode + set to ANY, model will predict a function call from the set of + function names provided. + type: array + items: type: string - type: object - directNotebookSource: - description: The contents of an input notebook file. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource - status: - description: >- - Output only. Populated when the NotebookExecutionJob is completed. - When there is an error during notebook execution, the error details - are populated. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - jobState: - description: Output only. The state of the NotebookExecutionJob. - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED + mode: type: string - readOnly: true + description: Optional. Function calling mode. enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. + - Unspecified function calling mode. This value should not be used. - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. + Default model behavior, model decides to predict either function + calls or natural language response. - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. + Model is constrained to always predicting function calls only. If + "allowed_function_names" are set, the predicted function calls + will be limited to any one of "allowed_function_names", else the + predicted function calls will be any one of the provided + "function_declarations". - >- - The job is partially succeeded, some results may be missing due to - errors. - id: GoogleCloudAiplatformV1NotebookExecutionJob + Model will not predict any function calls. Model behavior is same + as when not passing any function declarations. + enum: + - MODE_UNSPECIFIED + - AUTO + - ANY + - NONE + description: Function calling config. type: object - GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke: - description: Configurations for PublisherModel GKE deployment + id: GoogleCloudAiplatformV1FunctionCallingConfig + GoogleCloudAiplatformV1NearestNeighbors: + description: Nearest neighbors for one query. type: object - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke properties: - gkeYamlConfigs: - description: Optional. GKE deployment configuration in yaml format. + neighbors: + description: All its neighbors. items: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborsNeighbor type: array - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig: - description: >- - Config that contains the strategy used to generate sliding windows in - time series training. A window is a series of rows that comprise the - context up to the time of prediction, and the horizon following. The - corresponding row for each window marks the start of the forecast - horizon. Each window is used as an input example for - training/evaluation. + id: GoogleCloudAiplatformV1NearestNeighbors + GoogleCloudAiplatformV1DestinationFeatureSetting: + type: object properties: - column: + featureId: + type: string + description: Required. The ID of the Feature to apply the setting to. + destinationField: type: string description: >- - Name of the column that should be used to generate sliding windows. - The column should contain either booleans or string booleans; if the - value of the row is True, generate a sliding window with the horizon - starting at that row. The column will not be used as a feature in - training. - strideLength: + Specify the field name in the export destination. If not specified, + Feature ID is used. + id: GoogleCloudAiplatformV1DestinationFeatureSetting + GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec: + description: >- + Selects Features of an EntityType to read values of and specifies read + settings. + properties: + entityTypeId: description: >- - Stride length used to generate input examples. Within one time - series, every {$STRIDE_LENGTH} rows will be used to generate a - sliding window. - format: int64 - type: string - maxCount: + Required. ID of the EntityType to select Features. The EntityType id + is the entity_type_id specified during EntityType creation. type: string - format: int64 + settings: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting + description: Per-Feature settings for the batch read. + featureSelector: description: >- - Maximum number of windows that should be generated across all time - series. + Required. Selectors choosing which Feature values to read from the + EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest: + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec + GoogleCloudAiplatformV1PurgeArtifactsResponse: + description: Response message for MetadataService.PurgeArtifacts. + id: GoogleCloudAiplatformV1PurgeArtifactsResponse properties: - artifacts: - items: - type: string - description: >- - The resource names of the Artifacts to attribute to the Context. - Format: - `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` - type: array - executions: + purgeSample: description: >- - The resource names of the Executions to associate with the Context. - Format: - `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + A sample of the Artifact names that will be deleted. Only populated + if `force` is set to false. The maximum number of samples is 100 (it + is possible to return fewer). items: type: string type: array - description: Request message for MetadataService.AddContextArtifactsAndExecutions. - id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest + purgeCount: + type: string + description: >- + The number of Artifacts that this request deleted (or, if `force` is + false, the number of Artifacts that will be deleted). This can be an + estimate. + format: int64 + type: object + GoogleCloudAiplatformV1QuestionAnsweringQualityInput: + id: GoogleCloudAiplatformV1QuestionAnsweringQualityInput + properties: + metricSpec: + description: Required. Spec for question answering quality score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualitySpec + instance: + description: Required. Question answering quality instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInstance + description: Input for question answering quality metric. + type: object + GoogleCloudAiplatformV1VertexAISearch: type: object - GoogleCloudAiplatformV1Endpoint: - id: GoogleCloudAiplatformV1Endpoint description: >- - Models are deployed into it, and afterwards Endpoint is called to obtain - predictions and explanations. + Retrieve from Vertex AI Search datastore for grounding. See + https://cloud.google.com/products/agent-builder properties: - dedicatedEndpointDns: - readOnly: true - type: string + datastore: description: >- - Output only. DNS of the dedicated endpoint. Will only be populated - if dedicated_endpoint_enabled is true. Format: - `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. - displayName: + Required. Fully-qualified Vertex AI Search data store resource ID. + Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` type: string + id: GoogleCloudAiplatformV1VertexAISearch + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification: + type: object + properties: + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification + description: >- + A TrainingJob that trains and uploads an AutoML Text Classification + Model. + GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData: + properties: + values: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueList' description: >- - Required. The display name of the Endpoint. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - trafficSplit: + Feature values list if values, successive in time, are requested. If + the requested number of values is greater than the number of + existing Feature values, nonexistent values are omitted instead of + being returned as empty. + value: + description: Feature value if a single value is requested. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + description: >- + Container to hold value(s), successive in time, for one Feature from the + request. + type: object + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData + GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata: + description: Metadata of the prediction output to be explained. + properties: + displayNameMappingKey: description: >- - A map from a DeployedModel's ID to the percentage of this Endpoint's - traffic that should be forwarded to that DeployedModel. If a - DeployedModel's ID is not listed in this map, then it receives no - traffic. The traffic percentage values must add up to 100, or map - must be empty if the Endpoint is to not accept any traffic at a - moment. - type: object - additionalProperties: - format: int32 - type: integer - predictRequestResponseLoggingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig - description: Configures the request-response logging for online prediction. - updateTime: - format: google-datetime - description: Output only. Timestamp when this Endpoint was last updated. + Specify a field name in the prediction to look for the display name. + Use this if the prediction contains the display names for the + outputs. The display names in the prediction must have the same + shape of the outputs, so that it can be located by + Attribution.output_index for a specific output. + type: string + outputTensorName: type: string - readOnly: true - privateServiceConnectConfig: description: >- - Optional. Configuration for private service connect. network and - private_service_connect_config are mutually exclusive. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Name of the output tensor. Required and is only applicable to Vertex + AI provided images for Tensorflow. + indexDisplayNameMapping: description: >- - Customer-managed encryption key spec for an Endpoint. If set, this - Endpoint and all sub-resources of this Endpoint will be secured by - this key. - etag: - type: string + Static mapping between the index and display name. Use this if the + outputs are a deterministic n-dimensional array, e.g. a list of + scores of all the classes in a pre-defined order for a + multi-classification Model. It's not feasible if the outputs are + non-deterministic, e.g. the Model produces top-k classes or sort the + outputs by their values. The shape of the value must be an + n-dimensional array of strings. The number of dimensions must match + that of the outputs to be explained. The + Attribution.output_display_name is populated by locating in the + mapping with Attribution.output_index. + type: any + type: object + id: GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata + GoogleCloudAiplatformV1ListOptimalTrialsResponse: + id: GoogleCloudAiplatformV1ListOptimalTrialsResponse + description: Response message for VizierService.ListOptimalTrials. + type: object + properties: + optimalTrials: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - name: - description: Output only. The resource name of the Endpoint. - readOnly: true - type: string - enablePrivateServiceConnect: - deprecated: true + The pareto-optimal Trials for multiple objective Study or the + optimal trial for single objective Study. The definition of + pareto-optimal can be checked in wiki page. + https://en.wikipedia.org/wiki/Pareto_efficiency + type: array + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs + type: object + properties: + multiLabel: type: boolean - description: >- - Deprecated: If true, expose the Endpoint via private service - connect. Only one of the fields, network or - enable_private_service_connect, can be set. - modelDeploymentMonitoringJob: + GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig: + description: >- + Config for migrating Model in automl.googleapis.com to Vertex AI's + Model. + type: object + properties: + model: type: string - readOnly: true description: >- - Output only. Resource name of the Model Monitoring job associated - with this Endpoint if monitoring is enabled by - JobService.CreateModelDeploymentMonitoringJob. Format: - `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - labels: - type: object + Required. Full resource name of automl Model. Format: + `projects/{project}/locations/{location}/models/{model}`. + modelDisplayName: description: >- - The labels with user-defined metadata to organize your Endpoints. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - additionalProperties: - type: string - deployedModels: - type: array + Optional. Display name of the model in Vertex AI. System will pick a + display name if unspecified. + type: string + id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig + GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus: + type: object + description: A single record of the task status. + properties: + error: readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' description: >- - Output only. The models deployed in this Endpoint. To add or remove - DeployedModels use EndpointService.DeployModel and - EndpointService.UndeployModel respectively. - satisfiesPzs: - description: Output only. Reserved for future use. + Output only. The error that occurred during the state. May be set + when the state is any of the non-final state + (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is + FAILED, the error here is final and not going to be retried. If the + state is a non-final state, the error indicates a system-error being + retried. + $ref: '#/components/schemas/GoogleRpcStatus' + state: readOnly: true - type: boolean - network: + enumDescriptions: + - Unspecified. + - Specifies pending state for the task. + - Specifies task is being executed. + - Specifies task completed successfully. + - Specifies Task cancel is in pending state. + - Specifies task is being cancelled. + - Specifies task was cancelled. + - Specifies task failed. + - Specifies task was skipped due to cache hit. + - >- + Specifies that the task was not triggered because the task's + trigger policy is not satisfied. The trigger policy is specified + in the `condition` field of PipelineJob.pipeline_spec. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - CANCEL_PENDING + - CANCELLING + - CANCELLED + - FAILED + - SKIPPED + - NOT_TRIGGERED type: string - description: >- - Optional. The full name of the Google Compute Engine - [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) - to which the Endpoint should be peered. Private services access must - already be configured for the network. If left unspecified, the - Endpoint is not peered with any network. Only one of the fields, - network or enable_private_service_connect, can be set. - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where `{project}` is - a project number, as in `12345`, and `{network}` is network name. - satisfiesPzi: + description: Output only. The state of the task. + updateTime: readOnly: true - type: boolean - description: Output only. Reserved for future use. - description: - description: The description of the Endpoint. - type: string - createTime: type: string - description: Output only. Timestamp when this Endpoint was created. - readOnly: true format: google-datetime - dedicatedEndpointEnabled: - description: >- - If true, the endpoint will be exposed through a dedicated DNS - [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS - will be isolated from other users' traffic and will have better - performance and reliability. Note: Once you enabled dedicated - endpoint, you won't be able to send request to the shared DNS - {region}-aiplatform.googleapis.com. The limitation will be removed - soon. + description: Output only. Update time of this status. + id: GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig: + properties: + overrideExistingTable: type: boolean + description: >- + If true and an export destination is specified, then the contents of + the destination are overwritten. Otherwise, if the export + destination already exists, then the export operation fails. + destinationBigqueryUri: + description: >- + URI of desired destination BigQuery table. Expected format: + `bq://{project_id}:{dataset_id}:{table}` If not specified, then + results are exported to the following auto-created BigQuery table: + `{project_id}:export_evaluated_examples_{model_name}_{yyyy_MM_dd'T'HH_mm_ss_SSS'Z'}.evaluated_examples` + type: string type: object - GoogleCloudAiplatformV1UpdateExplanationDatasetResponse: - id: GoogleCloudAiplatformV1UpdateExplanationDatasetResponse - properties: {} - description: Response message of ModelService.UpdateExplanationDataset operation. - type: object - GoogleCloudAiplatformV1FetchFeatureValuesResponse: + description: Configuration for exporting test set predictions to a BigQuery table. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + GoogleCloudAiplatformV1BleuInstance: + description: Spec for bleu instance. + id: GoogleCloudAiplatformV1BleuInstance type: object - id: GoogleCloudAiplatformV1FetchFeatureValuesResponse - description: Response message for FeatureOnlineStoreService.FetchFeatureValues properties: - dataKey: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' - description: >- - The data key associated with this response. Will only be populated - for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. - keyValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList - description: Feature values in KeyValue format. - protoStruct: - description: Feature values in proto Struct format. - additionalProperties: - type: any - description: Properties of the object. - type: object - GoogleCloudAiplatformV1ListOptimalTrialsRequest: + prediction: + description: Required. Output of the evaluated model. + type: string + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + GoogleCloudAiplatformV1RemoveDatapointsRequest: + description: Request message for IndexService.RemoveDatapoints type: object - description: Request message for VizierService.ListOptimalTrials. - id: GoogleCloudAiplatformV1ListOptimalTrialsRequest - properties: {} - GoogleCloudAiplatformV1SummarizationHelpfulnessResult: properties: - score: - description: Output only. Summarization Helpfulness score. - format: float - type: number - readOnly: true - explanation: - type: string - readOnly: true - description: Output only. Explanation for summarization helpfulness score. - confidence: - description: Output only. Confidence for summarization helpfulness score. - readOnly: true - type: number - format: float - id: GoogleCloudAiplatformV1SummarizationHelpfulnessResult + datapointIds: + description: A list of datapoint ids to be deleted. + items: + type: string + type: array + id: GoogleCloudAiplatformV1RemoveDatapointsRequest + GoogleCloudAiplatformV1RougeInput: + id: GoogleCloudAiplatformV1RougeInput + description: Input for rouge metric. + properties: + instances: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInstance' + type: array + description: Required. Repeated rouge instances. + metricSpec: + description: Required. Spec for rouge score metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeSpec' type: object - description: Spec for summarization helpfulness result. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics + GoogleCloudAiplatformV1LargeModelReference: properties: - f1Score: - type: number - format: float - description: The harmonic mean of recall and precision. - confidenceThreshold: - format: float - type: number + name: + type: string description: >- - Metrics are computed with an assumption that the Model never returns - predictions with score lower than this value. - recall: - format: float - description: Recall (True Positive Rate) for the given confidence threshold. - type: number - precision: - format: float - description: Precision for the given confidence threshold. - type: number + Required. The unique name of the large Foundation or pre-built + model. Like "chat-bison", "text-bison". Or model name with version + ID, like "chat-bison@001", "text-bison@005", etc. + description: Contains information about the Large Model. + id: GoogleCloudAiplatformV1LargeModelReference type: object - GoogleCloudAiplatformV1BatchPredictionJobOutputInfo: - id: GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + GoogleCloudAiplatformV1NfsMount: + description: Represents a mount configuration for Network File System (NFS) to mount. properties: - bigqueryOutputDataset: - description: >- - Output only. The path of the BigQuery dataset created, in - `bq://projectId.bqDatasetId` format, into which the prediction - output is written. - type: string - readOnly: true - bigqueryOutputTable: + path: type: string description: >- - Output only. The name of the BigQuery table created, in - `predictions_` format, into which the prediction output is written. - Can be used by UI to generate the BigQuery output path, for example. - readOnly: true - gcsOutputDirectory: + Required. Source path exported from NFS server. Has to start with + '/', and combined with the ip address, it indicates the source mount + path in the form of `server:path` + server: + description: Required. IP address of the NFS server. + type: string + mountPoint: description: >- - Output only. The full path of the Cloud Storage directory created, - into which the prediction output is written. + Required. Destination mount path. The NFS will be mounted for the + user under /mnt/nfs/ type: string - readOnly: true - description: Further describes this job's output. Supplements output_config. - type: object - GoogleCloudAiplatformV1ExactMatchResults: type: object - id: GoogleCloudAiplatformV1ExactMatchResults - description: Results for exact match metric. - properties: - exactMatchMetricValues: - description: Output only. Exact match metric values. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchMetricValue' - readOnly: true - GoogleCloudAiplatformV1DirectPredictRequest: - id: GoogleCloudAiplatformV1DirectPredictRequest + id: GoogleCloudAiplatformV1NfsMount + GoogleCloudAiplatformV1GoogleSearchRetrieval: + id: GoogleCloudAiplatformV1GoogleSearchRetrieval + description: Tool to retrieve public web data for grounding, powered by Google. type: object + properties: {} + GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse: properties: - inputs: - description: The prediction input. + blobs: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' + description: Blob messages containing blob bytes. type: array - parameters: - description: The parameters that govern the prediction. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: Request message for PredictionService.DirectPredict. - GoogleIamV1SetIamPolicyRequest: - type: object - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/GoogleIamV1Policy' - description: Request message for `SetIamPolicy` method. - id: GoogleIamV1SetIamPolicyRequest - GoogleCloudAiplatformV1ToolParameterKVMatchSpec: - id: GoogleCloudAiplatformV1ToolParameterKVMatchSpec - properties: - useStrictStringMatch: - description: Optional. Whether to use STRCIT string match on parameter values. - type: boolean - description: Spec for tool parameter key value match metric. + id: GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse + description: Response message for TensorboardService.ReadTensorboardBlobData. type: object GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata: id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata properties: dataBytesCount: - type: string - format: int64 description: The ingested data size in bytes. + format: int64 + type: string contentValidationStats: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats description: >- The validation stats of the content (per file) to be inserted or updated on the Matching Engine Index resource. Populated if @@ -21788,516 +22378,358 @@ components: that, currently for those files that are broken or has unsupported file format, we will not have the stats for those files. type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats type: object description: Runtime operation metadata with regard to Matching Engine Index. - GoogleCloudAiplatformV1CancelTuningJobRequest: - type: object - properties: {} - description: Request message for GenAiTuningService.CancelTuningJob. - id: GoogleCloudAiplatformV1CancelTuningJobRequest - GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: - id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata - description: Metadata information for NotebookService.AssignNotebookRuntime. - type: object - properties: - progressMessage: - type: string - description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1ExactMatchInstance: - description: Spec for exact match instance. - properties: - reference: - type: string - description: Required. Ground truth used to compare against the prediction. - prediction: - type: string - description: Required. Output of the evaluated model. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics: + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics type: object - id: GoogleCloudAiplatformV1ExactMatchInstance - GoogleCloudAiplatformV1ImportDataRequest: properties: - importConfigs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataConfig' - type: array + meanTrackingAveragePrecision: + description: The mean average precision over all confidence thresholds. + format: float + type: number + meanMismatchRate: + format: float + description: The mean mismatch rate over all confidence thresholds. + type: number + iouThreshold: description: >- - Required. The desired input locations. The contents of all input - locations will be imported in one batch. - type: object - description: Request message for DatasetService.ImportData. - id: GoogleCloudAiplatformV1ImportDataRequest - GoogleCloudAiplatformV1SchemaPredictionResultError: - id: GoogleCloudAiplatformV1SchemaPredictionResultError - type: object - properties: - status: - enumDescriptions: - - 'Not an error; returned on success. HTTP Mapping: 200 OK' - - >- - The operation was cancelled, typically by the caller. HTTP - Mapping: 499 Client Closed Request - - >- - Unknown error. For example, this error may be returned when a - `Status` value received from another address space belongs to an - error space that is not known in this address space. Also errors - raised by APIs that do not return enough error information may be - converted to this error. HTTP Mapping: 500 Internal Server Error - - >- - The client specified an invalid argument. Note that this differs - from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments - that are problematic regardless of the state of the system (e.g., - a malformed file name). HTTP Mapping: 400 Bad Request - - >- - The deadline expired before the operation could complete. For - operations that change the state of the system, this error may be - returned even if the operation has completed successfully. For - example, a successful response from a server could have been - delayed long enough for the deadline to expire. HTTP Mapping: 504 - Gateway Timeout - - >- - Some requested entity (e.g., file or directory) was not found. - Note to server developers: if a request is denied for an entire - class of users, such as gradual feature rollout or undocumented - allowlist, `NOT_FOUND` may be used. If a request is denied for - some users within a class of users, such as user-based access - control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not - Found - - >- - The entity that a client attempted to create (e.g., file or - directory) already exists. HTTP Mapping: 409 Conflict - - >- - The caller does not have permission to execute the specified - operation. `PERMISSION_DENIED` must not be used for rejections - caused by exhausting some resource (use `RESOURCE_EXHAUSTED` - instead for those errors). `PERMISSION_DENIED` must not be used if - the caller can not be identified (use `UNAUTHENTICATED` instead - for those errors). This error code does not imply the request is - valid or the requested entity exists or satisfies other - pre-conditions. HTTP Mapping: 403 Forbidden - - >- - The request does not have valid authentication credentials for the - operation. HTTP Mapping: 401 Unauthorized - - >- - Some resource has been exhausted, perhaps a per-user quota, or - perhaps the entire file system is out of space. HTTP Mapping: 429 - Too Many Requests - - >- - The operation was rejected because the system is not in a state - required for the operation's execution. For example, the directory - to be deleted is non-empty, an rmdir operation is applied to a - non-directory, etc. Service implementors can use the following - guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and - `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just - the failing call. (b) Use `ABORTED` if the client should retry at - a higher level. For example, when a client-specified test-and-set - fails, indicating the client should restart a read-modify-write - sequence. (c) Use `FAILED_PRECONDITION` if the client should not - retry until the system state has been explicitly fixed. For - example, if an "rmdir" fails because the directory is non-empty, - `FAILED_PRECONDITION` should be returned since the client should - not retry unless the files are deleted from the directory. HTTP - Mapping: 400 Bad Request - - >- - The operation was aborted, typically due to a concurrency issue - such as a sequencer check failure or transaction abort. See the - guidelines above for deciding between `FAILED_PRECONDITION`, - `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict - - >- - The operation was attempted past the valid range. E.g., seeking or - reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error - indicates a problem that may be fixed if the system state changes. - For example, a 32-bit file system will generate `INVALID_ARGUMENT` - if asked to read at an offset that is not in the range [0,2^32-1], - but it will generate `OUT_OF_RANGE` if asked to read from an - offset past the current file size. There is a fair bit of overlap - between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend - using `OUT_OF_RANGE` (the more specific error) when it applies so - that callers who are iterating through a space can easily look for - an `OUT_OF_RANGE` error to detect when they are done. HTTP - Mapping: 400 Bad Request - - >- - The operation is not implemented or is not supported/enabled in - this service. HTTP Mapping: 501 Not Implemented - - >- - Internal errors. This means that some invariants expected by the - underlying system have been broken. This error code is reserved - for serious errors. HTTP Mapping: 500 Internal Server Error - - >- - The service is currently unavailable. This is most likely a - transient condition, which can be corrected by retrying with a - backoff. Note that it is not always safe to retry non-idempotent - operations. See the guidelines above for deciding between - `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: - 503 Service Unavailable - - >- - Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal - Server Error - enum: - - OK - - CANCELLED - - UNKNOWN - - INVALID_ARGUMENT - - DEADLINE_EXCEEDED - - NOT_FOUND - - ALREADY_EXISTS - - PERMISSION_DENIED - - UNAUTHENTICATED - - RESOURCE_EXHAUSTED - - FAILED_PRECONDITION - - ABORTED - - OUT_OF_RANGE - - UNIMPLEMENTED - - INTERNAL - - UNAVAILABLE - - DATA_LOSS - type: string + The intersection-over-union threshold value between bounding boxes + across frames used to compute this metric entry. + format: float + type: number + confidenceMetrics: description: >- - Error status. This will be serialized into the enum name e.g. - "NOT_FOUND". - message: - description: Error message with additional details. - type: string - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics: - type: object - description: Metrics for image segmentation evaluation results. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics - properties: - confidenceMetricsEntries: + Metrics for each label-match `confidenceThreshold` from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. type: array - description: >- - Metrics for each confidenceThreshold in - 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 Precision-recall curve - can be derived from it. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry - GoogleCloudAiplatformV1UndeployIndexResponse: - description: Response message for IndexEndpointService.UndeployIndex. - properties: {} + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics + meanBoundingBoxIou: + format: float + description: The mean bounding box iou over all confidence thresholds. + type: number + description: >- + UNIMPLEMENTED. Track matching model metrics for a single track match + threshold and multiple label match confidence thresholds. + GoogleCloudAiplatformV1MutateDeployedModelRequest: type: object - id: GoogleCloudAiplatformV1UndeployIndexResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs: + description: Request message for EndpointService.MutateDeployedModel. + id: GoogleCloudAiplatformV1MutateDeployedModelRequest properties: - modelType: + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: >- + Required. The DeployedModel to be mutated within the Endpoint. Only + the following fields can be mutated: * `min_replica_count` in either + DedicatedResources or AutomaticResources * `max_replica_count` in + either DedicatedResources or AutomaticResources * + autoscaling_metric_specs * `disable_container_logging` (v1 only) * + `enable_container_logging` (v1beta1 only) + updateMask: + format: google-fieldmask + description: >- + Required. The update mask applies to the resource. See + google.protobuf.FieldMask. type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_JETSON_VERSATILE_1 - enumDescriptions: - - Should not be set. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Default. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) to a Jetson - device afterwards. + GoogleCloudAiplatformV1FeatureValueDestination: type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs - GoogleCloudAiplatformV1ModelMonitoringAlertConfig: + id: GoogleCloudAiplatformV1FeatureValueDestination properties: - enableLogging: - type: boolean + tfrecordDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TFRecordDestination' description: >- - Dump the anomalies to Cloud Logging. The anomalies will be put to - json payload encoded from proto - google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. - This can be further sinked to Pub/Sub or any other services - supported by Cloud Logging. - emailAlertConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig - description: Email alert config. - notificationChannels: - items: - type: string - type: array + Output in TFRecord format. Below are the mapping from Feature value + type in Featurestore to Feature value type in TFRecord: Value type + in Featurestore | Value type in TFRecord DOUBLE, DOUBLE_ARRAY | + FLOAT_LIST INT64, INT64_ARRAY | INT64_LIST STRING, STRING_ARRAY, + BYTES | BYTES_LIST true -> byte_string("true"), false -> + byte_string("false") BOOL, BOOL_ARRAY (true, false) | BYTES_LIST + bigqueryDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' description: >- - Resource names of the NotificationChannels to send alert. Must be of - the format `projects//notificationChannels/` - id: GoogleCloudAiplatformV1ModelMonitoringAlertConfig - description: The alert config for model monitoring. - type: object - GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata: - description: Details of operations that perform import Feature values. - type: object - id: GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata - properties: - importedFeatureValueCount: - type: string - format: int64 - description: Number of Feature values that have been imported by the operation. - invalidRowCount: + Output in BigQuery format. BigQueryDestination.output_uri in + FeatureValueDestination.bigquery_destination must refer to a table. + csvDestination: description: >- - The number of rows in input source that weren't imported due to - either * Not having any featureValues. * Having a null entityId. * - Having a null timestamp. * Not being parsable (applicable for CSV - sources). - type: string - format: int64 - genericMetadata: - description: Operation metadata for Featurestore import Feature values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - sourceUris: - description: The source URI from where Feature values are imported. + Output in CSV format. Array Feature value types are not allowed in + CSV format. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvDestination' + description: A destination location for Feature values and format. + GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView: + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView + description: Entity view with Feature values. + properties: + data: type: array - items: - type: string - blockingOperationIds: description: >- - List of ImportFeatureValues operations running under a single - EntityType that are blocking this operation. + Each piece of data holds the k requested values for one requested + Feature. If no values for the requested Feature exist, the + corresponding cell will be empty. This has the same size and is in + the same order as the features from the header + ReadFeatureValuesResponse.header. items: - format: int64 - type: string - type: array - timestampOutsideRetentionRowsCount: - description: >- - The number rows that weren't ingested due to having timestamps - outside the retention boundary. - format: int64 - type: string - importedEntityCount: - description: Number of entities that have been imported by the operation. - format: int64 + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData + entityId: + description: ID of the requested entity. type: string - GoogleCloudAiplatformV1PublisherModelCallToActionDeploy: type: object - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy - description: >- - Model metadata that is needed for UploadModel or - DeployModel/CreateEndpoint requests. + GoogleCloudAiplatformV1Scheduling: properties: - largeModelReference: - description: >- - Optional. Large model reference. When this is set, - model_artifact_spec is not needed. - $ref: '#/components/schemas/GoogleCloudAiplatformV1LargeModelReference' - containerSpec: - description: >- - Optional. The specification of the container that is to be used when - deploying this Model in Vertex AI. Not present for Large Models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' - deployTaskName: + maxWaitDuration: + format: google-duration description: >- - Optional. The name of the deploy task (e.g., "text to image - generation"). + Optional. This is the maximum duration that a job will wait for the + requested resources to be provisioned if the scheduling strategy is + set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait + indefinitely. The default is 24 hours. type: string - deployMetadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata - description: Optional. Metadata information about this deployment config. - sharedResources: - description: >- - The resource name of the shared DeploymentResourcePool to deploy on. - Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + timeout: + format: google-duration + description: The maximum job running time. The default is 7 days. type: string - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + strategy: + description: Optional. This determines which type of scheduling strategy to use. + enumDeprecated: + - false + - true + - true + - false + - false + - false + type: string + enumDescriptions: + - Strategy will default to STANDARD. + - Deprecated. Regular on-demand provisioning strategy. + - Deprecated. Low cost by making potential use of spot resources. + - Standard provisioning strategy uses regular on-demand resources. + - Spot provisioning strategy uses spot resources. + - Flex Start strategy uses DWS to queue for resources. + enum: + - STRATEGY_UNSPECIFIED + - ON_DEMAND + - LOW_COST + - STANDARD + - SPOT + - FLEX_START + restartJobOnWorkerRestart: description: >- - A description of resources that are dedicated to the DeployedModel, - and that need a higher degree of manual configuration. - automaticResources: + Restarts the entire CustomJob if a worker gets restarted. This + feature can be used by distributed training jobs that are not + resilient to workers leaving and joining a job. + type: boolean + disableRetries: + type: boolean description: >- - A description of resources that to large degree are decided by - Vertex AI, and require only a modest additional configuration. - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - artifactUri: + Optional. Indicates if the job should retry for internal errors + after the job starts running. If true, overrides + `Scheduling.restart_job_on_worker_restart` to false. + id: GoogleCloudAiplatformV1Scheduling + type: object + description: All parameters related to queuing and scheduling of custom jobs. + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec: + description: Specification for how the data should be sliced. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec + properties: + configs: + type: object + description: >- + Mapping configuration for this SliceSpec. The key is the name of the + feature. By default, the key will be prefixed by "instance" as a + dictionary prefix for Vertex Batch Predictions output format. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + type: object + GoogleCloudAiplatformV1CopyModelResponse: + properties: + model: type: string description: >- - Optional. The path to the directory containing the Model artifact - and any of its supporting files. - modelDisplayName: + The name of the copied Model resource. Format: + `projects/{project}/locations/{location}/models/{model}` + modelVersionId: type: string - description: Optional. Default model display name. - publicArtifactUri: + description: Output only. The version ID of the model that is copied. + readOnly: true + description: Response message of ModelService.CopyModel operation. + type: object + id: GoogleCloudAiplatformV1CopyModelResponse + GoogleCloudAiplatformV1PipelineJob: + id: GoogleCloudAiplatformV1PipelineJob + properties: + jobDetail: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobDetail' + readOnly: true + description: >- + Output only. The details of pipeline run. Not available in the list + view. + endTime: + description: Output only. Pipeline end time. type: string + readOnly: true + format: google-datetime + serviceAccount: description: >- - Optional. The signed URI for ephemeral Cloud Storage access to model - artifact. - title: - description: Required. The title of the regional resource reference. + The service account that the pipeline workload runs as. If not + specified, the Compute Engine default service account in the project + will be used. See + https://cloud.google.com/compute/docs/access/service-accounts#default_service_account + Users starting the pipeline must have the + `iam.serviceAccounts.actAs` permission on this service account. type: string - GoogleCloudAiplatformV1Trial: - description: >- - A message representing a Trial. A Trial contains a unique set of - Parameters that has been or will be evaluated, along with the objective - metrics got by running the Trial. - properties: + createTime: + type: string + readOnly: true + description: Output only. Pipeline creation time. + format: google-datetime state: + enum: + - PIPELINE_STATE_UNSPECIFIED + - PIPELINE_STATE_QUEUED + - PIPELINE_STATE_PENDING + - PIPELINE_STATE_RUNNING + - PIPELINE_STATE_SUCCEEDED + - PIPELINE_STATE_FAILED + - PIPELINE_STATE_CANCELLING + - PIPELINE_STATE_CANCELLED + - PIPELINE_STATE_PAUSED + description: Output only. The detailed state of the job. enumDescriptions: - - The Trial state is unspecified. + - The pipeline state is unspecified. - >- - Indicates that a specific Trial has been requested, but it has not - yet been suggested by the service. - - Indicates that the Trial has been suggested. - - Indicates that the Trial should stop according to the service. - - Indicates that the Trial is completed successfully. + The pipeline has been created or resumed, and processing has not + yet begun. + - The service is preparing to run the pipeline. + - The pipeline is in progress. + - The pipeline completed successfully. + - The pipeline failed. - >- - Indicates that the Trial should not be attempted again. The - service will set a Trial to INFEASIBLE when it's done but missing - the final_measurement. + The pipeline is being cancelled. From this state, the pipeline may + only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED + or PIPELINE_STATE_CANCELLED. + - The pipeline has been cancelled. + - The pipeline has been stopped, and can be resumed. type: string - enum: - - STATE_UNSPECIFIED - - REQUESTED - - ACTIVE - - STOPPING - - SUCCEEDED - - INFEASIBLE readOnly: true - description: Output only. The detailed state of the Trial. - startTime: - readOnly: true - format: google-datetime - type: string - description: Output only. Time when the Trial was started. - finalMeasurement: - description: Output only. The final measurement containing the objective value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + templateMetadata: readOnly: true - clientId: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTemplateMetadata' + description: >- + Output only. Pipeline template metadata. Will fill up fields if + PipelineJob.template_uri is from supported template registry. + name: + description: Output only. The resource name of the PipelineJob. type: string readOnly: true + preflightValidations: description: >- - Output only. The identifier of the client that originally requested - this Trial. Each client is identified by a unique client_id. When a - client asks for a suggestion, Vertex AI Vizier will assign it a - Trial. The client should evaluate the Trial, complete it, and report - back to Vertex AI Vizier. If suggestion is asked again by same - client_id before the Trial is completed, the same Trial will be - returned. Multiple clients with different client_ids can ask for - suggestions simultaneously, each of them will get their own Trial. - id: - description: Output only. The identifier of the Trial assigned by the service. - readOnly: true - type: string - measurements: - type: array + Optional. Whether to do component level validations before job + creation. + type: boolean + error: description: >- - Output only. A list of measurements that are strictly - lexicographically ordered by their induced tuples (steps, - elapsed_duration). These are used for early stopping computations. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + Output only. The error that occurred during pipeline execution. Only + populated when the pipeline's state is FAILED or CANCELLED. readOnly: true - webAccessUris: - type: object + $ref: '#/components/schemas/GoogleRpcStatus' + runtimeConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfig' + description: Runtime config of the pipeline. + startTime: + format: google-datetime readOnly: true - description: >- - Output only. URIs for accessing [interactive - shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - (one URI for each training node). Only available if this trial is - part of a HyperparameterTuningJob and the job's - trial_job_spec.enable_web_access field is `true`. The keys are names - of each node used for the trial; for example, `workerpool0-0` for - the primary node, `workerpool1-0` for the first node in the second - worker pool, and `workerpool1-1` for the second node in the second - worker pool. The values are the URIs for each node's interactive - shell. + description: Output only. Pipeline start time. + type: string + pipelineSpec: additionalProperties: - type: string - parameters: - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' - description: Output only. The parameters of the Trial. - type: array - endTime: + description: Properties of the object. + type: any + type: object + description: The spec of the pipeline. + templateUri: description: >- - Output only. Time when the Trial's status changed to `SUCCEEDED` or - `INFEASIBLE`. - type: string - readOnly: true - format: google-datetime - infeasibleReason: + A template uri from where the PipelineJob.pipeline_spec, if empty, + will be downloaded. Currently, only uri from Vertex Template + Registry & Gallery is supported. Reference to + https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. type: string - readOnly: true + network: description: >- - Output only. A human readable string describing why the Trial is - infeasible. This is set only if Trial state is `INFEASIBLE`. - name: - readOnly: true + The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to which + the Pipeline Job's workload should be peered. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + Private services access must already be configured for the network. + Pipeline job will apply the network configuration to the Google + Cloud resources being launched, if applied, such as Vertex AI + Training or Dataflow job. If left unspecified, the workload is not + peered with any network. type: string - description: Output only. Resource name of the Trial assigned by the service. - customJob: - readOnly: true + displayName: + description: >- + The display name of the Pipeline. The name can be up to 128 + characters long and can consist of any UTF-8 characters. type: string + labels: + additionalProperties: + type: string + type: object description: >- - Output only. The CustomJob name linked to the Trial. It's set for a - HyperparameterTuningJob's Trial. - id: GoogleCloudAiplatformV1Trial - type: object - GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest: - type: object - description: Request message for JobService.ResumeModelDeploymentMonitoringJob. - properties: {} - id: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest - GoogleCloudAiplatformV1ErrorAnalysisAnnotation: - description: Model error analysis for each annotation. - properties: - attributedItems: + The labels with user-defined metadata to organize PipelineJob. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + Note there is some reserved label key for Vertex AI Pipelines. - + `vertex-ai-pipelines-run-billing-id`, user set value will get + overrided. + reservedIpRanges: description: >- - Attributed items for a given annotation, typically representing - neighbors from the training sets constrained by the query type. + A list of names for the reserved ip ranges under the VPC network + that can be used for this Pipeline Job's workload. If set, we will + deploy the Pipeline Job's workload within the provided ip ranges. + Otherwise, the job will be deployed to any ip ranges under the + provided VPC network. Example: ['vertex-ai-ip-range']. type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem - outlierScore: - format: double + type: string + scheduleName: + type: string description: >- - The outlier score of this annotated item. Usually defined as the min - of all distances from attributed items. - type: number - outlierThreshold: - format: double + Output only. The schedule resource name. Only returned if the + Pipeline is created by Schedule API. + readOnly: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - The threshold used to determine if this annotation is an outlier or - not. - type: number - queryType: - description: The query type used for finding the attributed items. - enumDescriptions: - - Unspecified query type for model error analysis. - - Query similar samples across all classes in the dataset. - - Query similar samples from the same class of the input sample. - - Query dissimilar samples from the same class of the input sample. + Customer-managed encryption key spec for a pipelineJob. If set, this + PipelineJob and all of its sub-resources will be secured by this + key. + updateTime: type: string - enum: - - QUERY_TYPE_UNSPECIFIED - - ALL_SIMILAR - - SAME_CLASS_SIMILAR - - SAME_CLASS_DISSIMILAR + description: >- + Output only. Timestamp when this PipelineJob was most recently + updated. + readOnly: true + format: google-datetime type: object - id: GoogleCloudAiplatformV1ErrorAnalysisAnnotation + description: An instance of a machine learning PipelineJob. GoogleCloudAiplatformV1ExportDataResponse: id: GoogleCloudAiplatformV1ExportDataResponse properties: dataStats: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' description: >- Only present for custom code training export use case. Records data stats, i.e., train/validation/test item/annotation counts calculated during the export operation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' exportedFiles: description: >- All of the files that are exported in this export operation. For @@ -22309,2490 +22741,2133 @@ components: type: array description: Response message for DatasetService.ExportData. type: object - GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput: - type: object - properties: - metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec - description: Required. Spec for question answering helpfulness score metric. - instance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance - description: Required. Question answering helpfulness instance. - id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput - description: Input for question answering helpfulness metric. - GoogleCloudAiplatformV1ResourceRuntime: - type: object - description: Persistent Cluster runtime information as output - id: GoogleCloudAiplatformV1ResourceRuntime - properties: - accessUris: - readOnly: true - type: object - additionalProperties: - type: string - description: >- - Output only. URIs for user to connect to the Cluster. Example: { - "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" - "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource: + GoogleCloudAiplatformV1PointwiseMetricSpec: type: object + description: Spec for pointwise metric. properties: - uri: - type: array - items: - type: string - description: >- - Cloud Storage URI of one or more files. Only CSV files are - supported. The first line of the CSV file is used as the header. If - there are multiple files, the header is the first line of the - lexicographically first file, the other files must either contain - the exact same header or omit the header. - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource - GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata: + metricPromptTemplate: + type: string + description: Required. Metric prompt template for pointwise metric. + id: GoogleCloudAiplatformV1PointwiseMetricSpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity: type: object - description: The metadata of Datasets that contain Text Prompt data. - id: GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata properties: - gcsUri: - description: The Google Cloud Storage URI that stores the prompt data. - type: string - stopSequences: - items: - type: string - type: array - description: Customized stop sequences. - groundingConfig: - description: Grounding checking configuration. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig - promptType: - type: string - description: Type of the prompt dataset. - systemInstruction: - description: The content of the prompt dataset system instruction. - type: string - topK: + unit: type: string description: >- - Top K value set when the dataset was saved. This value determines - how many candidates with highest probability from the vocab would be - selected for each decoding step. - format: int64 - candidateCount: - type: string - description: Number of candidates. + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" + quantity: format: int64 - note: - description: User-created prompt note. Note size limit is 2KB. - type: string - hasPromptVariable: - type: boolean - description: Whether the prompt dataset has prompt variable. - systemInstructionGcsUri: - type: string - description: >- - The Google Cloud Storage URI that stores the system instruction, - starting with gs://. - temperature: - format: float - description: >- - Temperature value used for sampling set when the dataset was saved. - This value is used to tune the degree of randomness. - type: number - maxOutputTokens: description: >- - Value of the maximum number of tokens generated set when the dataset - was saved. + The number of granularity_units between data points in the training + data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. + For all other values of `granularity_unit`, must be 1. type: string - format: int64 - topP: - type: number - format: float + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + description: A duration of time expressed in time granularity units. + GoogleCloudAiplatformV1PredefinedSplit: + properties: + key: description: >- - Top P value set when the dataset was saved. Given topK tokens for - decoding, top candidates will be selected until the sum of their - probabilities is topP. - text: - description: The content of the prompt dataset. + Required. The key is a name of one of the Dataset's data columns. + The value of the key (either the label's value or value in the + column) must be one of {`training`, `validation`, `test`}, and it + defines to which set the given piece of data is assigned. If for a + piece of data the key is not present or has an invalid value, that + piece is ignored by the pipeline. type: string - GoogleCloudAiplatformV1GenerateContentResponse: type: object - description: Response message for [PredictionService.GenerateContent]. - id: GoogleCloudAiplatformV1GenerateContentResponse + description: >- + Assigns input data to training, validation, and test sets based on the + value of a provided key. Supported only for tabular Datasets. + id: GoogleCloudAiplatformV1PredefinedSplit + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs properties: - usageMetadata: - description: Usage metadata about the response(s). - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata - candidates: - readOnly: true + modelType: + type: string + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which c + annot be exported. Default. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) to a Jetson + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a Coral device + afterwards. + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_JETSON_VERSATILE_1 + - MOBILE_CORAL_VERSATILE_1 + type: object + GoogleCloudAiplatformV1UpsertDatapointsRequest: + properties: + updateMask: + description: >- + Optional. Update mask is used to specify the fields to be + overwritten in the datapoints by the update. The fields specified in + the update_mask are relative to each IndexDatapoint inside + datapoints, not the full request. Updatable fields: * Use + `all_restricts` to update both restricts and numeric_restricts. + type: string + format: google-fieldmask + datapoints: type: array + description: A list of datapoints to be created/updated. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Candidate' - description: Output only. Generated candidates. - promptFeedback: - description: >- - Output only. Content filter results for a prompt sent in the - request. Note: Sent only in the first stream chunk. Only happens - when no candidates were generated due to content violations. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback - readOnly: true - GoogleCloudAiplatformV1FeatureOnlineStoreBigtable: - id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + description: Request message for IndexService.UpsertDatapoints + id: GoogleCloudAiplatformV1UpsertDatapointsRequest type: object + GoogleIamV1TestIamPermissionsResponse: + id: GoogleIamV1TestIamPermissionsResponse properties: - autoScaling: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling - description: Required. Autoscaling config applied to Bigtable Instance. - GoogleCloudAiplatformV1SmoothGradConfig: - id: GoogleCloudAiplatformV1SmoothGradConfig - properties: - featureNoiseSigma: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigma' - description: >- - This is similar to noise_sigma, but provides additional flexibility. - A separate noise sigma can be provided for each feature, which is - useful if their distributions are different. No noise is added to - features that are not set. If this field is unset, noise_sigma will - be used for all features. - noisySampleCount: - description: >- - The number of gradient samples to use for approximation. The higher - this number, the more accurate the gradient is, but the runtime - complexity increases by this factor as well. Valid range of its - value is [1, 50]. Defaults to 3. - format: int32 - type: integer - noiseSigma: - format: float - type: number + permissions: + type: array + items: + type: string description: >- - This is a single float value and will be used to add noise to all - the features. Use this field when all features are normalized to - have the same distribution: scale to range [0, 1], [-1, 1] or - z-scoring, where features are normalized to have 0-mean and - 1-variance. Learn more about - [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). - For best results the recommended value is about 10% - 20% of the - standard deviation of the input feature. Refer to section 3.2 of the - SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to - 0.1. If the distribution is different per feature, set - feature_noise_sigma instead for each feature. + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. type: object - description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy samples - in the vicinity of the inputs. Adding noise can help improve the - computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf - GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig: + description: Response message for `TestIamPermissions` method. + GoogleCloudAiplatformV1SummarizationQualityResult: + description: Spec for summarization quality result. + type: object + id: GoogleCloudAiplatformV1SummarizationQualityResult properties: - sampleRate: + explanation: + type: string + readOnly: true + description: Output only. Explanation for summarization quality score. + score: + type: number + readOnly: true + format: float + description: Output only. Summarization Quality score. + confidence: type: number - description: Sample rate (0, 1] - format: double - description: Requests are randomly selected. - type: object - id: GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig - GoogleCloudAiplatformV1NfsMount: - id: GoogleCloudAiplatformV1NfsMount + description: Output only. Confidence for summarization quality score. + readOnly: true + format: float + GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata: properties: - path: - type: string - description: >- - Required. Source path exported from NFS server. Has to start with - '/', and combined with the ip address, it indicates the source mount - path in the form of `server:path` - mountPoint: - description: >- - Required. Destination mount path. The NFS will be mounted for the - user under /mnt/nfs/ - type: string - server: - description: Required. IP address of the NFS server. + deployedIndexId: type: string - description: Represents a mount configuration for Network File System (NFS) to mount. + description: The unique index id specified by user + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. type: object - GoogleCloudAiplatformV1BatchPredictionJobInputConfig: + id: GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata + description: >- + Runtime operation information for + IndexEndpointService.MutateDeployedIndex. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation: + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Convert the category name to a dictionary lookup index and generate an + embedding for each index. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation properties: - bigquerySource: - description: >- - The BigQuery location of the input table. The schema of the table - should be in the format described by the given context OpenAPI - Schema, if one is provided. The table may contain additional columns - that are not described by the schema, and they will be ignored. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - gcsSource: - description: The Cloud Storage location for the input instances. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - instancesFormat: + columnName: type: string - description: >- - Required. The format in which instances are given, must be one of - the Model's supported_input_storage_formats. type: object - id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig - description: >- - Configures the input to BatchPredictionJob. See - Model.supported_input_storage_formats for Model's supported input - formats, and how instances should be expressed via any of them. - GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult: + description: Spec for pairwise question answering quality result. + type: object + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult properties: - categoryMask: - description: >- - A PNG image where each pixel in the mask represents the category in - which the pixel in the original image was predicted to belong to. - The size of this image will be the same as the original image. The - mapping between the AnntoationSpec and the color can be found in - model's metadata. The model will choose the most likely category and - if none of the categories reach the confidence threshold, the pixel - will be marked as background. + confidence: + description: Output only. Confidence for question answering quality score. + format: float + type: number + readOnly: true + explanation: + description: Output only. Explanation for question answering quality score. type: string - confidenceMask: + readOnly: true + pairwiseChoice: + enumDescriptions: + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined + enum: + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE + readOnly: true + description: Output only. Pairwise question answering prediction choice. type: string - description: >- - A one channel image which is encoded as an 8bit lossless PNG. The - size of the image will be the same as the original image. For a - specific pixel, darker color means less confidence in correctness of - the cateogry in the categoryMask for the corresponding pixel. Black - means no confidence and white means complete confidence. - description: Prediction output format for Image Segmentation. - type: object - GoogleCloudAiplatformV1ListAnnotationsResponse: + GoogleCloudAiplatformV1ListDataItemsResponse: type: object - description: Response message for DatasetService.ListAnnotations. + description: Response message for DatasetService.ListDataItems. properties: + dataItems: + description: >- + A list of DataItems that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' nextPageToken: type: string description: The standard List next-page token. - annotations: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' - type: array + id: GoogleCloudAiplatformV1ListDataItemsResponse + GoogleCloudAiplatformV1ShieldedVmConfig: + description: >- + A set of Shielded Instance options. See [Images using supported Shielded + VM + features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). + type: object + properties: + enableSecureBoot: description: >- - A list of Annotations that matches the specified filter in the - request. - id: GoogleCloudAiplatformV1ListAnnotationsResponse - GoogleCloudAiplatformV1PublisherModelCallToAction: - id: GoogleCloudAiplatformV1PublisherModelCallToAction + Defines whether the instance has [Secure + Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) + enabled. Secure Boot helps ensure that the system only runs + authentic software by verifying the digital signature of all boot + components, and halting the boot process if signature verification + fails. + type: boolean + id: GoogleCloudAiplatformV1ShieldedVmConfig + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection: properties: - openNotebook: - description: Optional. Open notebook of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - openFineTuningPipelines: - description: Optional. Open fine-tuning pipelines of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines - requestAccess: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Request for access. - openFineTuningPipeline: + metadata: + description: The metadata information $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open fine-tuning pipeline of the PublisherModel. - openGenerationAiStudio: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata + inputs: + description: The input parameters of this TrainingJob. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open in Generation AI Studio. - multiDeployVertex: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection + description: >- + A TrainingJob that trains and uploads an AutoML Image Object Detection + Model. + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics: + properties: + recall: + type: number + description: Output only. Recall for the given confidence threshold. + format: float + f1Score: + format: float + type: number + description: Output only. The harmonic mean of recall and precision. + precision: + description: Output only. Precision for the given confidence threshold. + type: number + format: float + confidenceThreshold: + type: number description: >- - Optional. Multiple setups to deploy the PublisherModel to Vertex - Endpoint. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex - deployGke: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke - description: Optional. Deploy PublisherModel to Google Kubernetes Engine. - openGenie: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open Genie / Playground. - openPromptTuningPipeline: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open prompt-tuning pipeline of the PublisherModel. - openNotebooks: - description: Optional. Open notebooks of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks - viewRestApi: - description: Optional. To view Rest API docs. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi - deploy: - description: Optional. Deploy the PublisherModel to Vertex Endpoint. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy - createApplication: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Create application using the PublisherModel. - openEvaluationPipeline: - description: Optional. Open evaluation pipeline of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Actions could take on this Publisher Model. + Output only. The confidence threshold value used to compute the + metrics. + format: float + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics + description: Metrics for a single confidence threshold. type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult: + GoogleCloudAiplatformV1UndeployIndexResponse: + id: GoogleCloudAiplatformV1UndeployIndexResponse + type: object + description: Response message for IndexEndpointService.UndeployIndex. + properties: {} + GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke: + type: object + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke + description: Configurations for PublisherModel GKE deployment properties: - timeSegmentStart: + gkeYamlConfigs: + type: array + description: Optional. GKE deployment configuration in yaml format. + items: + type: string + GoogleCloudAiplatformV1PurgeContextsRequest: + id: GoogleCloudAiplatformV1PurgeContextsRequest + type: object + description: Request message for MetadataService.PurgeContexts. + properties: + filter: type: string description: >- - The beginning, inclusive, of the video's time segment in which the - object instance has been detected. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. - format: google-duration - displayName: + Required. A required filter matching the Contexts to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + force: + description: >- + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Context names + that would be deleted. + type: boolean + GoogleCloudAiplatformV1NasTrial: + id: GoogleCloudAiplatformV1NasTrial + type: object + properties: + endTime: + readOnly: true type: string - description: The display name of the AnnotationSpec that had been identified. - confidence: - type: number - format: float description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. + Output only. Time when the NasTrial's status changed to `SUCCEEDED` + or `INFEASIBLE`. + format: google-datetime id: type: string - description: The resource ID of the AnnotationSpec that had been identified. - timeSegmentEnd: - description: >- - The end, inclusive, of the video's time segment in which the object - instance has been detected. Expressed as a number of seconds as - measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. + description: Output only. The identifier of the NasTrial assigned by the service. + readOnly: true + startTime: + readOnly: true type: string - format: google-duration - frames: + description: Output only. Time when the NasTrial was started. + format: google-datetime + finalMeasurement: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + description: Output only. The final measurement containing the objective value. + readOnly: true + state: + type: string + readOnly: true + enum: + - STATE_UNSPECIFIED + - REQUESTED + - ACTIVE + - STOPPING + - SUCCEEDED + - INFEASIBLE + description: Output only. The detailed state of the NasTrial. + enumDescriptions: + - The NasTrial state is unspecified. + - >- + Indicates that a specific NasTrial has been requested, but it has + not yet been suggested by the service. + - Indicates that the NasTrial has been suggested. + - Indicates that the NasTrial should stop according to the service. + - Indicates that the NasTrial is completed successfully. + - >- + Indicates that the NasTrial should not be attempted again. The + service will set a NasTrial to INFEASIBLE when it's done but + missing the final_measurement. + description: Represents a uCAIP NasJob trial. + GoogleCloudAiplatformV1GroundingSupport: + description: Grounding support. + properties: + segment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Segment' + description: Segment of the content this support belongs to. + groundingChunkIndices: + description: >- + A list of indices (into 'grounding_chunk') specifying the citations + associated with the claim. For instance [1,3,4] means that + grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the + retrieved content attributed to the claim. + type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame + format: int32 + type: integer + confidenceScores: description: >- - All of the frames of the video in which a single object instance has - been detected. The bounding boxes in the frames identify the same - object. + Confidence score of the support references. Ranges from 0 to 1. 1 is + the most confident. This list must have the same size as the + grounding_chunk_indices. type: array + items: + format: float + type: number + id: GoogleCloudAiplatformV1GroundingSupport type: object - description: Prediction output format for Video Object Tracking. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + GoogleCloudAiplatformV1ModelBaseModelSource: + properties: + genieSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenieSource' + description: Information about the base model of Genie models. + modelGardenSource: + description: Source information of Model Garden models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelGardenSource' + description: >- + User input field to specify the base model source. Currently it only + supports specifing the Model Garden models and Genie models. + type: object + id: GoogleCloudAiplatformV1ModelBaseModelSource + GoogleCloudAiplatformV1SchemaVertex: type: object properties: - groupColumns: - description: >- - A list of time series attribute column names that define the time - series hierarchy. Only one level of hierarchy is supported, ex. - 'region' for a hierarchy of stores or 'department' for a hierarchy - of products. If multiple columns are specified, time series will be - grouped by their combined values, ex. ('blue', 'large') for 'color' - and 'size', up to 5 columns are accepted. If no group columns are - specified, all time series are considered to be part of the same - group. - type: array - items: - type: string - temporalTotalWeight: - type: number - format: double - description: >- - The weight of the loss for predictions aggregated over the horizon - for a single time series. - groupTotalWeight: - description: >- - The weight of the loss for predictions aggregated over time series - in the same group. + x: + description: X coordinate. type: number format: double - groupTemporalTotalWeight: + 'y': type: number - description: >- - The weight of the loss for predictions aggregated over both the - horizon and time series in the same hierarchy group. + description: Y coordinate. format: double description: >- - Configuration that defines the hierarchical relationship of time series - and parameters for hierarchical forecasting strategies. - GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata: - id: GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. + id: GoogleCloudAiplatformV1SchemaVertex + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource: + type: object + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource + properties: + uri: + type: string + description: >- + The URI of a BigQuery table. e.g. + bq://projectId.bqDatasetId.bqTableId + GoogleCloudAiplatformV1PurgeArtifactsMetadata: + id: GoogleCloudAiplatformV1PurgeArtifactsMetadata properties: genericMetadata: + description: Operation metadata for purging Artifacts. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - description: >- - Runtime operation information for - IndexEndpointService.CreateIndexEndpoint. + description: Details of operations that perform MetadataService.PurgeArtifacts. type: object - GoogleCloudAiplatformV1ActiveLearningConfig: + GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig: properties: - sampleConfig: - description: >- - Active learning data sampling config. For every active learning - labeling iteration, it will select a batch of data based on the - sampling strategy. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' - maxDataItemCount: - format: int64 + sampleRate: + type: number + description: Sample rate (0, 1] + format: double + type: object + id: GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig + description: Requests are randomly selected. + GoogleCloudAiplatformV1ListModelEvaluationsResponse: + type: object + description: Response message for ModelService.ListModelEvaluations. + id: GoogleCloudAiplatformV1ListModelEvaluationsResponse + properties: + modelEvaluations: + description: List of ModelEvaluations in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + type: array + nextPageToken: type: string - description: Max number of human labeled DataItems. - trainingConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' description: >- - CMLE training config. For every active learning labeling iteration, - system will train a machine learning model on CMLE. The trained - model will be used by data sampling algorithm to select DataItems. - maxDataItemPercentage: - description: Max percent of total DataItems for human labeling. - format: int32 - type: integer - id: 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. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + A token to retrieve next page of results. Pass to + ListModelEvaluationsRequest.page_token to obtain that page. + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective: properties: - evaluatedDataItemsBigqueryUri: + type: type: string - description: BigQuery destination uri for exported evaluated examples. - trainCostMilliNodeHours: + enumDescriptions: + - Default value, should not be set. + - >- + Raw feature values' stats to detect skew between + Training-Prediction datasets. + - >- + Raw feature values' stats to detect drift between + Serving-Prediction datasets. + - >- + Feature attribution scores to detect skew between + Training-Prediction datasets. + - >- + Feature attribution scores to detect skew between Prediction + datasets collected within different time windows. + enum: + - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED + - RAW_FEATURE_SKEW + - RAW_FEATURE_DRIFT + - FEATURE_ATTRIBUTION_SKEW + - FEATURE_ATTRIBUTION_DRIFT + topFeatureCount: + type: integer + format: int32 description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - format: int64 - type: string - description: Model metadata specific to TFT Forecasting. + If set, all attribution scores between + SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time and + SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time are + fetched, and page token doesn't take effect in this case. Only used + to retrieve attribution score for the top Features which has the + highest attribution score in the latest monitoring run. type: object - GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: - description: Details of operations that perform create Featurestore. + description: Stats requested for specific objective. + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective + GoogleCloudAiplatformV1PairwiseMetricSpec: + description: Spec for pairwise metric. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore. - id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata + metricPromptTemplate: + type: string + description: Required. Metric prompt template for pairwise metric. + id: GoogleCloudAiplatformV1PairwiseMetricSpec type: object - GoogleCloudAiplatformV1GoogleSearchRetrieval: - description: Tool to retrieve public web data for grounding, powered by Google. - properties: {} - id: GoogleCloudAiplatformV1GoogleSearchRetrieval + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation: type: object - GoogleCloudAiplatformV1ListMetadataStoresResponse: properties: - metadataStores: + columnName: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup: + id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup + description: >- + Features belonging to a single feature group that will be synced to + Online Store. + properties: + featureIds: + description: Required. Identifiers of features under the feature group. type: array - description: The MetadataStores found for the Location. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' - nextPageToken: + type: string + featureGroupId: + description: Required. Identifier of the feature group. type: string - description: >- - A token, which can be sent as ListMetadataStoresRequest.page_token - to retrieve the next page. If this field is not populated, there are - no subsequent pages. - id: GoogleCloudAiplatformV1ListMetadataStoresResponse - description: Response message for MetadataService.ListMetadataStores. - type: object - GoogleCloudAiplatformV1StopTrialRequest: - id: GoogleCloudAiplatformV1StopTrialRequest - properties: {} type: object - description: Request message for VizierService.StopTrial. - GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata: + GoogleCloudAiplatformV1PublisherModelResourceReference: properties: - maxWallTime: - readOnly: true - format: google-datetime - description: >- - Output only. Max wall clock timestamp of all data points within a - TensorboardTimeSeries. + resourceName: type: string - maxBlobSequenceLength: - readOnly: true + description: The resource name of the Google Cloud resource. + useCase: + description: Use case (CUJ) of the resource. + deprecated: true type: string - format: int64 - description: >- - Output only. The largest blob sequence length (number of blobs) of - all data points in this time series, if its ValueType is - BLOB_SEQUENCE. - maxStep: + uri: + description: The URI of the resource. type: string - format: int64 - readOnly: true - description: >- - Output only. Max step index of all data points within a - TensorboardTimeSeries. - id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata - description: Describes metadata for a TensorboardTimeSeries. + description: + description: Description of the resource. + type: string + deprecated: true + description: Reference to a resource. + id: GoogleCloudAiplatformV1PublisherModelResourceReference type: object - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource: + GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams: + description: Prediction model parameters for Video Action Recognition. + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams type: object - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource - properties: - uri: - description: >- - Cloud Storage URI of one or more files. Only CSV files are - supported. The first line of the CSV file is used as the header. If - there are multiple files, the header is the first line of the - lexicographically first file, the other files must either contain - the exact same header or omit the header. - type: array - items: - type: string - GoogleCloudAiplatformV1CreatePipelineJobRequest: - id: GoogleCloudAiplatformV1CreatePipelineJobRequest properties: - pipelineJobId: + maxPredictions: + format: int32 + type: integer description: >- - 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-/`. - type: string - parent: - type: string + The model only returns up to that many top, by confidence score, + predictions per frame of the video. If this number is very high, the + Model may return fewer predictions per frame. Default value is 50. + confidenceThreshold: description: >- - Required. The resource name of the Location to create the - PipelineJob in. Format: `projects/{project}/locations/{location}` - pipelineJob: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' - description: Required. The PipelineJob to create. - type: object - description: Request message for PipelineService.CreatePipelineJob. - GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest: + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + type: number + format: float + GoogleCloudAiplatformV1SupervisedTuningDataStats: + description: Tuning data statistics for Supervised Tuning. type: object + id: GoogleCloudAiplatformV1SupervisedTuningDataStats properties: - tensorboardTimeSeriesId: - description: >- - 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}" + totalTruncatedExampleCount: + format: int64 type: string - tensorboardTimeSeries: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - description: Required. The TensorboardTimeSeries to create. - parent: description: >- - Required. The resource name of the TensorboardRun to create the - TensorboardTimeSeries in. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + The number of examples in the dataset that have been truncated by + any amount. + userInputTokenDistribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + readOnly: true + description: Output only. Dataset distributions for the user input tokens. + totalBillableCharacterCount: + description: Output only. Number of billable characters in the tuning dataset. + format: int64 type: string - description: Request message for TensorboardService.CreateTensorboardTimeSeries. - id: GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest - GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse: - description: Response message for TensorboardService.ExportTensorboardTimeSeriesData. - id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse - properties: - 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. + deprecated: true + readOnly: true + tuningDatasetExampleCount: + readOnly: true + description: Output only. Number of examples in the tuning dataset. + format: int64 type: string - timeSeriesDataPoints: - description: The returned time series data points. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' - type: object - GoogleCloudAiplatformV1ExplanationSpec: - type: object - properties: - metadata: - description: >- - Optional. Metadata describing the Model's input and output for - explanation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationMetadata' - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' + totalBillableTokenCount: + description: Output only. Number of billable tokens in the tuning dataset. + type: string + readOnly: true + format: int64 + userOutputTokenDistribution: + description: Output only. Dataset distributions for the user output tokens. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + truncatedExampleIndices: description: >- - Required. Parameters that configure explaining of the Model's - predictions. - id: GoogleCloudAiplatformV1ExplanationSpec - description: Specification of Model explanation. - GoogleCloudAiplatformV1ListNasTrialDetailsResponse: - type: object - id: GoogleCloudAiplatformV1ListNasTrialDetailsResponse - description: Response message for JobService.ListNasTrialDetails - properties: - nasTrialDetails: - description: List of top NasTrials in the requested page. + A partial sample of the indices (starting from 1) of the truncated + examples. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + type: string + format: int64 type: array - nextPageToken: + userMessagePerExampleDistribution: + description: Output only. Dataset distributions for the messages per example. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + totalTuningCharacterCount: type: string - description: >- - A token to retrieve the next page of results. Pass to - ListNasTrialDetailsRequest.page_token to obtain that page. - GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: - id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + format: int64 + readOnly: true + description: Output only. Number of tuning characters in the tuning dataset. + tuningStepCount: + description: Output only. Number of tuning steps for this Tuning Job. + readOnly: true + type: string + format: int64 + userDatasetExamples: + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + type: array + description: Output only. Sample user messages in the training dataset uri. + GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig: type: object - description: Configuration for logging request-response to a BigQuery table. properties: - samplingRate: - type: number - format: double - description: >- - Percentage of requests to be logged, expressed as a fraction in - range(0,1]. - enabled: - description: If logging is enabled or not. + disableAttribution: type: boolean - bigqueryDestination: description: >- - BigQuery table for logging. If only given a project, a new dataset - will be created with name `logging__` where will be made - BigQuery-dataset-name compatible (e.g. most special characters will - become underscores). If no table name is given, a new table will be - created with name `request_response_logging` - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry: - description: Entry for the Quantiles loss type optimization objective. + If set, skip finding claim attributions (i.e not generate grounding + citation). + deprecated: true + sources: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry + type: array + description: The sources for the grounding checking. + description: The configuration for grounding checking. + id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + GoogleCloudAiplatformV1GroundednessInstance: properties: - scaledPinballLoss: - format: float - description: The scaled pinball loss of this quantile. - type: number - observedQuantile: - type: number + context: + type: string description: >- - This is a custom metric that calculates the percentage of true - values that were less than the predicted value for that quantile. - Only populated when optimization_objective is minimize-quantile-loss - and each entry corresponds to an entry in quantiles The percent - value can be used to compare with the quantile value, which is the - target value. - format: double - quantile: - type: number - format: double - description: The quantile for this entry. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + Required. Background information provided in context used to compare + against the prediction. + prediction: + type: string + description: Required. Output of the evaluated model. type: object - GoogleIamV1Policy: + id: GoogleCloudAiplatformV1GroundednessInstance + description: Spec for groundedness instance. + GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey: + description: ID that is comprised from several parts (columns). properties: - version: - format: int32 + parts: description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - bindings: + Parts to construct Entity ID. Should match with the same ID columns + as defined in FeatureView in the same order. type: array items: - $ref: '#/components/schemas/GoogleIamV1Binding' - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - format: byte - type: string - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + type: string + id: GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey type: object - id: GoogleIamV1Policy - GoogleCloudAiplatformV1TimestampSplit: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs: properties: - validationFraction: + disableEarlyStopping: description: >- - The fraction of the input data that is to be used to validate the - Model. - type: number - format: double - key: + Use the entire training budget. This disables the early stopping + feature. When false the early stopping feature is enabled, which + means that AutoML Image Classification might stop training before + the entire training budget has been used. + type: boolean + baseModelId: type: string description: >- - Required. The key is a name of one of the Dataset's data columns. - The values of the key (the values in the column) must be in RFC 3339 - `date-time` format, where `time-offset` = `"Z"` (e.g. - 1985-04-12T23:20:50.52Z). If for a piece of data the key is not - present or has an invalid value, that piece is ignored by the - pipeline. - trainingFraction: - type: number - format: double + The ID of the `base` model. If it is specified, the new model will + be trained based on the `base` model. Otherwise, the new model will + be trained from scratch. The `base` model must be in the same + Project and Location as the new Model to train, and have the same + modelType. + tunableParameter: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + description: Trainer type for Vision TrainRequest. + budgetMilliNodeHours: + type: string + format: int64 description: >- - The fraction of the input data that is to be used to train the - Model. - testFraction: - format: double + The training budget of creating this model, expressed in milli node + hours i.e. 1,000 value in this field means 1 node hour. The actual + metadata.costMilliNodeHours will be equal or less than this value. + If further model training ceases to provide any improvements, it + will stop without using the full budget and the + metadata.successfulStopReason will be `model-converged`. Note, + node_hour = actual_hour * number_of_nodes_involved. For modelType + `cloud`(default), the budget must be between 8,000 and 800,000 milli + node hours, inclusive. The default value is 192,000 which represents + one day in wall time, considering 8 nodes are used. For model types + `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, + `mobile-tf-high-accuracy-1`, the training budget must be between + 1,000 and 100,000 milli node hours, inclusive. The default value is + 24,000 which represents one day in wall time on a single node that + is used. + multiLabel: description: >- - The fraction of the input data that is to be used to evaluate the - Model. - type: number - id: GoogleCloudAiplatformV1TimestampSplit - type: object - description: >- - Assigns input data to training, validation, and test sets based on a - provided timestamps. The youngest data pieces are assigned to training - set, next to validation set, and the oldest to the test set. Supported - only for tabular Datasets. - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective: - type: object - description: Stats requested for specific objective. - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective - properties: - type: - type: string + If false, a single-label (multi-class) Model will be trained (i.e. + assuming that for each image just up to one annotation may be + applicable). If true, a multi-label Model will be trained (i.e. + assuming that for each image multiple annotations may be + applicable). + type: boolean + modelType: enum: - - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED - - RAW_FEATURE_SKEW - - RAW_FEATURE_DRIFT - - FEATURE_ATTRIBUTION_SKEW - - FEATURE_ATTRIBUTION_DRIFT + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - CLOUD_1 + - MOBILE_TF_LOW_LATENCY_1 + - MOBILE_TF_VERSATILE_1 + - MOBILE_TF_HIGH_ACCURACY_1 + - EFFICIENTNET + - MAXVIT + - VIT + - COCA + type: string enumDescriptions: - - Default value, should not be set. + - Should not be set. + - >- + A Model best tailored to be used within Google Cloud, and which + cannot be exported. Default. - >- - Raw feature values' stats to detect skew between - Training-Prediction datasets. + A model type best tailored to be used within Google Cloud, which + cannot be exported externally. Compared to the CLOUD model above, + it is expected to have higher prediction accuracy. - >- - Raw feature values' stats to detect drift between - Serving-Prediction datasets. + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device afterwards. + Expected to have low latency, but may have lower prediction + quality than other mobile models. - >- - Feature attribution scores to detect skew between - Training-Prediction datasets. + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device with + afterwards. - >- - Feature attribution scores to detect skew between Prediction - datasets collected within different time windows. - topFeatureCount: + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device afterwards. + Expected to have a higher latency, but should also have a higher + prediction quality than other mobile models. + - >- + EfficientNet model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + MaxViT model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + ViT model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + CoCa model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + uptrainBaseModelId: description: >- - If set, all attribution scores between - SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time and - SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time are - fetched, and page token doesn't take effect in this case. Only used - to retrieve attribution score for the top Features which has the - highest attribution score in the latest monitoring run. - format: int32 - type: integer - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization: - id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization + The ID of `base` model for upTraining. If it is specified, the new + model will be upTrained based on the `base` model for upTraining. + Otherwise, the new model will be trained from scratch. The `base` + model for upTraining must be in the same Project and Location as the + new Model to train, and have the same modelType. + type: string type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs + GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig: + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig properties: - colorMap: + deployedModelId: + type: string + description: The DeployedModel ID of the objective config. + objectiveConfig: description: >- - The color scheme used for the highlighted areas. Defaults to - PINK_GREEN for Integrated Gradients attribution, which shows - positive attributions in green and negative in pink. Defaults to - VIRIDIS for XRAI attribution, which highlights the most influential - regions in yellow and the least influential in blue. - enumDescriptions: - - Should not be used. - - 'Positive: green. Negative: pink.' - - >- - Viridis color map: A perceptually uniform color mapping which is - easier to see by those with colorblindness and progresses from - yellow to green to blue. Positive: yellow. Negative: blue. - - 'Positive: red. Negative: red.' - - 'Positive: green. Negative: green.' - - 'Positive: green. Negative: red.' - - PiYG palette. - enum: - - COLOR_MAP_UNSPECIFIED - - PINK_GREEN - - VIRIDIS - - RED - - GREEN - - RED_GREEN - - PINK_WHITE_GREEN + The objective config of for the modelmonitoring job of this deployed + model. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + description: >- + ModelDeploymentMonitoringObjectiveConfig contains the pair of + deployed_model_id to ModelMonitoringObjectiveConfig. + type: object + GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata: + id: GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata + type: object + description: The metadata of Datasets that contain Text Prompt data. + properties: + systemInstruction: type: string - overlayType: - enum: - - OVERLAY_TYPE_UNSPECIFIED - - NONE - - ORIGINAL - - GRAYSCALE - - MASK_BLACK + description: The content of the prompt dataset system instruction. + hasPromptVariable: + description: Whether the prompt dataset has prompt variable. + type: boolean + candidateCount: type: string - enumDescriptions: - - Default value. This is the same as NONE. - - No overlay. - - The attributions are shown on top of the original image. - - >- - The attributions are shown on top of grayscaled version of the - original image. - - >- - The attributions are used as a mask to reveal predictive parts of - the image and hide the un-predictive parts. - description: >- - How the original image is displayed in the visualization. Adjusting - the overlay can help increase visual clarity if the original image - makes it difficult to view the visualization. Defaults to NONE. - clipPercentUpperbound: - description: >- - Excludes attributions above the specified percentile from the - highlighted areas. Using the clip_percent_upperbound and - clip_percent_lowerbound together can be useful for filtering out - noise and making it easier to see areas of strong attribution. - Defaults to 99.9. - format: float - type: number - type: - description: >- - Type of the image visualization. Only applicable to Integrated - Gradients attribution. OUTLINES shows regions of attribution, while - PIXELS shows per-pixel attribution. Defaults to OUTLINES. - enumDescriptions: - - Should not be used. - - Shows which pixel contributed to the image prediction. - - >- - Shows which region contributed to the image prediction by - outlining the region. + description: Number of candidates. + format: int64 + gcsUri: type: string - enum: - - TYPE_UNSPECIFIED - - PIXELS - - OUTLINES - polarity: - enum: - - POLARITY_UNSPECIFIED - - POSITIVE - - NEGATIVE - - BOTH + description: The Google Cloud Storage URI that stores the prompt data. + note: + description: User-created prompt note. Note size limit is 2KB. + type: string + topK: + format: int64 description: >- - Whether to only highlight pixels with positive contributions, - negative or both. Defaults to POSITIVE. - enumDescriptions: - - Default value. This is the same as POSITIVE. - - >- - Highlights the pixels/outlines that were most influential to the - model's prediction. - - >- - Setting polarity to negative highlights areas that does not lead - to the models's current prediction. - - Shows both positive and negative attributions. + Top K value set when the dataset was saved. This value determines + how many candidates with highest probability from the vocab would be + selected for each decoding step. type: string - clipPercentLowerbound: + topP: format: float description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. + Top P value set when the dataset was saved. Given topK tokens for + decoding, top candidates will be selected until the sum of their + probabilities is topP. type: number - description: Visualization configurations for image explanation. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec: - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec - properties: - maxFailedTrialCount: + promptType: + type: string + description: Type of the prompt dataset. + systemInstructionGcsUri: + type: string description: >- - The number of failed Trials that need to be seen before failing the - HyperparameterTuningJob. If set to 0, Vertex AI decides how many - Trials must fail before the whole job fails. - type: integer - format: int32 - trialJobSpec: + The Google Cloud Storage URI that stores the system instruction, + starting with gs://. + maxOutputTokens: + type: string description: >- - The spec of a trial job. The same spec applies to the CustomJobs - created in all the trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - parallelTrialCount: - description: The desired number of Trials to run in parallel. - format: int32 - type: integer - maxTrialCount: - type: integer - format: int32 - description: The desired total number of Trials. - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - description: Study configuration of the HyperparameterTuningJob. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation: - properties: - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + Value of the maximum number of tokens generated set when the dataset + was saved. + format: int64 + temperature: + description: >- + Temperature value used for sampling set when the dataset was saved. + This value is used to tune the degree of randomness. + format: float + type: number + stopSequences: + description: Customized stop sequences. + items: + type: string + type: array text: + type: string + description: The content of the prompt dataset. + groundingConfig: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation - GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride: - description: The input metadata entries to be overridden. - id: GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + description: Grounding checking configuration. + GoogleCloudAiplatformV1EvaluatedAnnotation: + id: GoogleCloudAiplatformV1EvaluatedAnnotation type: object + description: >- + True positive, false positive, or false negative. EvaluatedAnnotation is + only available under ModelEvaluationSlice with slice of `annotationSpec` + dimension. properties: - inputBaselines: + errorAnalysisAnnotations: type: array + description: Annotations of model error analysis results. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotation + evaluatedDataItemViewId: description: >- - Baseline inputs for this feature. This overrides the - `input_baseline` field of the ExplanationMetadata.InputMetadata - object of the corresponding feature's input metadata. If it's not - specified, the original baselines are not overridden. + Output only. ID of the EvaluatedDataItemView under the same ancestor + ModelEvaluation. The EvaluatedDataItemView consists of all ground + truths and predictions on data_item_payload. + readOnly: true + type: string + predictions: + type: array items: type: any - GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion: - id: GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion - type: object - description: Represents one model Version in ml.googleapis.com. - properties: - version: description: >- - Full resource name of ml engine model Version. Format: - `projects/{project}/models/{model}/versions/{version}`. + Output only. The model predicted annotations. For true positive, + there is one and only one prediction, which matches the only one + ground truth annotation in ground_truths. For false positive, there + is one and only one prediction, which doesn't match any ground truth + annotation of the corresponding data_item_view_id. For false + negative, there are zero or more predictions which are similar to + the only ground truth annotation in ground_truths but not enough for + a match. The schema of the prediction is stored in + ModelEvaluation.annotation_schema_uri + readOnly: true + type: + readOnly: true + enumDescriptions: + - Invalid value. + - >- + The EvaluatedAnnotation is a true positive. It has a prediction + created by the Model and a ground truth Annotation which the + prediction matches. + - >- + The EvaluatedAnnotation is false positive. It has a prediction + created by the Model which does not match any ground truth + annotation. + - >- + The EvaluatedAnnotation is false negative. It has a ground truth + annotation which is not matched by any of the model created + predictions. + enum: + - EVALUATED_ANNOTATION_TYPE_UNSPECIFIED + - TRUE_POSITIVE + - FALSE_POSITIVE + - FALSE_NEGATIVE + description: Output only. Type of the EvaluatedAnnotation. type: string - endpoint: + dataItemPayload: + readOnly: true + type: any description: >- - The ml.googleapis.com endpoint that this model Version currently - lives in. Example values: * ml.googleapis.com * - us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * - asia-east1-ml.googleapis.com - type: string - GoogleCloudAiplatformV1ModelEvaluation: - description: >- - A collection of metrics calculated by comparing Model's predictions on - all of the test data against annotations from the test data. - properties: - dataItemSchemaUri: - type: string + Output only. The data item payload that the Model predicted this + EvaluatedAnnotation on. + explanations: description: >- - Points to a YAML file stored on Google Cloud Storage describing - EvaluatedDataItemView.data_item_payload and - EvaluatedAnnotation.data_item_payload. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - This field is not populated if there are neither - EvaluatedDataItemViews nor EvaluatedAnnotations under this - ModelEvaluation. - explanationSpecs: + Explanations of predictions. Each element of the explanations + indicates the explanation for one explanation Method. The + attributions list in the EvaluatedAnnotationExplanation.explanation + object corresponds to the predictions list. For example, the second + element in the attributions list explains the second element in the + predictions list. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + #/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + type: array + groundTruths: + readOnly: true type: array + items: + type: any description: >- - Describes the values of ExplanationSpec that are used for explaining - the predicted values on the evaluated data. - metadata: + Output only. The ground truth Annotations, i.e. the Annotations that + exist in the test data the Model is evaluated on. For true positive, + there is one and only one ground truth annotation, which matches the + only prediction in predictions. For false positive, there are zero + or more ground truth annotations that are similar to the only + prediction in predictions, but not enough for a match. For false + negative, there is one and only one ground truth annotation, which + doesn't match any predictions created by the model. The schema of + the ground truth is stored in ModelEvaluation.annotation_schema_uri + GoogleCloudAiplatformV1MergeVersionAliasesRequest: + type: object + properties: + versionAliases: + type: array description: >- - The metadata of the ModelEvaluation. For the ModelEvaluation - uploaded from Managed Pipeline, metadata contains a structured value - with keys of "pipeline_job_id", "evaluation_dataset_type", - "evaluation_dataset_path", "row_based_metrics_path". - type: any - annotationSchemaUri: + Required. The set of version aliases to merge. The alias should be + at most 128 characters, and match `a-z{0,126}[a-z-0-9]`. Add the `-` + prefix to an alias means removing that alias from the version. `-` + is NOT counted in the 128 characters. Example: `-golden` means + removing the `golden` alias from the version. There is NO ordering + in aliases, which means 1) The aliases returned from GetModel API + might not have the exactly same order from this MergeVersionAliases + API. 2) Adding and deleting the same alias in the request is not + recommended, and the 2 operations will be cancelled out. + items: + type: string + description: Request message for ModelService.MergeVersionAliases. + id: GoogleCloudAiplatformV1MergeVersionAliasesRequest + GoogleCloudAiplatformV1NotebookRuntimeTemplateRef: + type: object + properties: + notebookRuntimeTemplate: type: string + description: Immutable. A resource name of the NotebookRuntimeTemplate. + id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef + description: Points to a NotebookRuntimeTemplateRef. + GoogleCloudAiplatformV1ListCustomJobsResponse: + id: GoogleCloudAiplatformV1ListCustomJobsResponse + type: object + properties: + customJobs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + description: List of CustomJobs in the requested page. + type: array + nextPageToken: description: >- - Points to a YAML file stored on Google Cloud Storage describing - EvaluatedDataItemView.predictions, - EvaluatedDataItemView.ground_truths, - EvaluatedAnnotation.predictions, and - EvaluatedAnnotation.ground_truths. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - This field is not populated if there are neither - EvaluatedDataItemViews nor EvaluatedAnnotations under this - ModelEvaluation. - createTime: - description: Output only. Timestamp when this ModelEvaluation was created. - type: string - readOnly: true - format: google-datetime - name: - readOnly: true - description: Output only. The resource name of the ModelEvaluation. + A token to retrieve the next page of results. Pass to + ListCustomJobsRequest.page_token to obtain that page. type: string - displayName: - description: The display name of the ModelEvaluation. + description: Response message for JobService.ListCustomJobs + GoogleCloudAiplatformV1ExplainResponse: + id: GoogleCloudAiplatformV1ExplainResponse + properties: + deployedModelId: type: string - modelExplanation: - description: >- - Aggregated explanation metrics for the Model's prediction output - over the data this ModelEvaluation uses. This field is populated - only if the Model is evaluated with explanations, and only for - AutoML tabular Models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' - metrics: + description: ID of the Endpoint's DeployedModel that served this explanation. + predictions: + items: + type: any + type: array description: >- - Evaluation metrics of the Model. The schema of the metrics is stored - in metrics_schema_uri - type: any - metricsSchemaUri: - type: string + The predictions that are the output of the predictions call. Same as + PredictResponse.predictions. + explanations: description: >- - Points to a YAML file stored on Google Cloud Storage describing the - metrics of this ModelEvaluation. The schema is defined as an OpenAPI - 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - sliceDimensions: + The explanations of the Model's PredictResponse.predictions. It has + the same number of elements as instances to be explained. type: array items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + description: Response message for PredictionService.Explain. + type: object + GoogleCloudAiplatformV1DeployModelRequest: + properties: + deployedModel: description: >- - All possible dimensions of ModelEvaluationSlices. The dimensions can - be used as the filter of the ModelService.ListModelEvaluationSlices - request, in the form of `slice.dimension = `. + Required. The DeployedModel to be created within the Endpoint. Note + that Endpoint.traffic_split must be updated for the DeployedModel to + start receiving traffic, either as part of this call, or via + EndpointService.UpdateEndpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + trafficSplit: + type: object + description: >- + A map from a DeployedModel's ID to the percentage of this Endpoint's + traffic that should be forwarded to that DeployedModel. If this + field is non-empty, then the Endpoint's traffic_split will be + overwritten with it. To refer to the ID of the just being deployed + Model, a "0" should be used, and the actual ID of the new + DeployedModel will be filled in its place by this method. The + traffic percentage values must add up to 100. If this field is + empty, then the Endpoint's traffic_split is not updated. + additionalProperties: + format: int32 + type: integer + id: GoogleCloudAiplatformV1DeployModelRequest + description: Request message for EndpointService.DeployModel. type: object - id: GoogleCloudAiplatformV1ModelEvaluation - GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata: - description: The metadata of SavedQuery contains TextSentiment Annotations. + GoogleCloudAiplatformV1CoherenceInput: type: object - id: GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata - properties: - sentimentMax: - type: integer - description: The maximum sentiment of sentiment Anntoation in this SavedQuery. - format: int32 - GoogleCloudAiplatformV1NearestNeighbors: properties: - neighbors: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborsNeighbor - description: All its neighbors. - type: array + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInstance' + description: Required. Coherence instance. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceSpec' + description: Required. Spec for coherence score metric. + id: GoogleCloudAiplatformV1CoherenceInput + description: Input for coherence metric. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation type: object - id: GoogleCloudAiplatformV1NearestNeighbors - description: Nearest neighbors for one query. - GoogleCloudAiplatformV1BleuInput: - description: Input for bleu metric. properties: - instances: - type: array - description: Required. Repeated bleu instances. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInstance' + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation + repeatedNumeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + repeatedCategorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation + repeatedText: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation + GoogleCloudAiplatformV1SummarizationHelpfulnessInput: + description: Input for summarization helpfulness metric. + id: GoogleCloudAiplatformV1SummarizationHelpfulnessInput + properties: + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInstance + description: Required. Summarization helpfulness instance. metricSpec: - description: Required. Spec for bleu score metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuSpec' - id: GoogleCloudAiplatformV1BleuInput + description: Required. Spec for summarization helpfulness score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessSpec type: object - GoogleCloudAiplatformV1CompletionStats: + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: + properties: + shouldStop: + type: boolean + description: True if the Trial should stop. + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse + type: object + description: Response message for VizierService.CheckTrialEarlyStoppingState. + GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse: + properties: + timeSeriesData: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + description: The returned time series data. + type: array description: >- - Success and error statistics of processing multiple entities (for - example, DataItems or structured data rows) in batch. + Response message for + TensorboardService.BatchReadTensorboardTimeSeriesData. + id: GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + type: object + GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance: + description: Prediction input format for Text Classification. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance properties: - successfulForecastPointCount: - description: >- - Output only. The number of the successful forecast points that are - generated by the forecasting model. This is ONLY used by the - forecasting batch prediction. - format: int64 - type: string - readOnly: true - failedCount: - format: int64 - type: string - description: >- - Output only. The number of entities for which any error was - encountered. - readOnly: true - successfulCount: + mimeType: type: string - readOnly: true - format: int64 description: >- - Output only. The number of entities that had been processed - successfully. - incompleteCount: - format: int64 - readOnly: true + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + content: type: string - description: >- - Output only. In cases when enough errors are encountered a job, - pipeline, or operation may be failed as a whole. Below is the number - of entities for which the processing had not been finished (either - in successful or failed state). Set to -1 if the number is unknown - (for example, the operation failed before the total entity number - could be collected). - id: GoogleCloudAiplatformV1CompletionStats + description: The text snippet to make the predictions on. type: object - GoogleCloudAiplatformV1SchemaTextSentimentAnnotation: - description: Annotation details specific to text sentiment. + GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse: + properties: {} + id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + description: Response message for TensorboardService.WriteTensorboardExperimentData. type: object - id: GoogleCloudAiplatformV1SchemaTextSentimentAnnotation + GoogleCloudAiplatformV1CreateIndexOperationMetadata: + description: Runtime operation information for IndexService.CreateIndex. properties: - displayName: - type: string - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - annotationSpecId: + nearestNeighborSearchOperationMetadata: description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - sentimentMax: - type: integer - format: int32 - description: The sentiment max score for text. - sentiment: - format: int32 - type: integer - description: The sentiment score for text. - GoogleCloudAiplatformV1DeployedIndexRef: - id: GoogleCloudAiplatformV1DeployedIndexRef + The operation metadata with regard to Matching Engine Index + operation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + type: object + id: GoogleCloudAiplatformV1CreateIndexOperationMetadata + GoogleCloudAiplatformV1PairwiseSummarizationQualityInput: properties: - deployedIndexId: - type: string - description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. - displayName: - readOnly: true - description: Output only. The display name of the DeployedIndex. - type: string - indexEndpoint: - description: Immutable. A resource name of the IndexEndpoint. - type: string + metricSpec: + description: Required. Spec for pairwise summarization quality score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec + instance: + description: Required. Pairwise summarization quality instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance type: object - description: Points to a DeployedIndex. - GoogleCloudAiplatformV1PurgeArtifactsRequest: - id: GoogleCloudAiplatformV1PurgeArtifactsRequest - description: Request message for MetadataService.PurgeArtifacts. + description: Input for pairwise summarization quality metric. + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInput + GoogleCloudAiplatformV1ModelSourceInfo: + description: Detail description of the source information of the model. + id: GoogleCloudAiplatformV1ModelSourceInfo properties: - force: - description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Artifact names - that would be deleted. - type: boolean - filter: + sourceType: + enumDescriptions: + - Should not be used. + - The Model is uploaded by automl training pipeline. + - The Model is uploaded by user or custom training pipeline. + - The Model is registered and sync'ed from BigQuery ML. + - The Model is saved or tuned from Model Garden. + - The Model is saved or tuned from Genie. + - The Model is uploaded by text embedding finetuning pipeline. + - The Model is saved or tuned from Marketplace. + enum: + - MODEL_SOURCE_TYPE_UNSPECIFIED + - AUTOML + - CUSTOM + - BQML + - MODEL_GARDEN + - GENIE + - CUSTOM_TEXT_EMBEDDING + - MARKETPLACE type: string + description: Type of the model source. + copy: + type: boolean description: >- - Required. A required filter matching the Artifacts to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + If this Model is copy of another Model. If true then source_type + pertains to the original. type: object - GoogleCloudAiplatformV1SchemaTextSegment: + GoogleCloudAiplatformV1ToolNameMatchSpec: + description: Spec for tool name match metric. type: object - description: The text segment inside of DataItem. + properties: {} + id: GoogleCloudAiplatformV1ToolNameMatchSpec + GoogleCloudAiplatformV1UndeployIndexRequest: properties: - endOffset: - type: string - description: >- - Zero-based character index of the first character past the end of - the text segment (counting character from the beginning of the - text). The character at the end_offset is NOT included in the text - segment. - format: uint64 - startOffset: + deployedIndexId: description: >- - Zero-based character index of the first character of the text - segment (counting characters from the beginning of the text). - type: string - format: uint64 - content: + Required. The ID of the DeployedIndex to be undeployed from the + IndexEndpoint. type: string - description: The text content in the segment for output only. - id: GoogleCloudAiplatformV1SchemaTextSegment - GoogleCloudAiplatformV1GenerateContentRequest: + description: Request message for IndexEndpointService.UndeployIndex. type: object - id: GoogleCloudAiplatformV1GenerateContentRequest + id: GoogleCloudAiplatformV1UndeployIndexRequest + GoogleCloudAiplatformV1SupervisedTuningSpec: + description: Tuning Spec for Supervised Tuning for first party models. properties: - generationConfig: - description: Optional. Generation config. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' - safetySettings: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' + validationDatasetUri: description: >- - Optional. Per request settings for blocking unsafe content. Enforced - on GenerateContentResponse.candidates. - contents: + Optional. Cloud Storage path to file containing validation dataset + for tuning. The dataset must be formatted as a JSONL file. + type: string + hyperParameters: + description: Optional. Hyperparameters for SFT. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters + trainingDatasetUri: description: >- - Required. The content of the current conversation with the model. - For single-turn queries, this is a single instance. For multi-turn - queries, this is a repeated field that contains conversation history - + latest request. + Required. Cloud Storage path to file containing training dataset for + tuning. The dataset must be formatted as a JSONL file. + type: string + type: object + id: GoogleCloudAiplatformV1SupervisedTuningSpec + GoogleCloudAiplatformV1GcsSource: + type: object + id: GoogleCloudAiplatformV1GcsSource + description: The Google Cloud Storage location for the input content. + properties: + uris: type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - toolConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' - description: >- - Optional. Tool config. This config is shared for all tools provided - in the request. - tools: description: >- - Optional. A list of `Tools` the model may use to generate the next - response. A `Tool` is a piece of code that enables the system to - interact with external systems to perform an action, or set of - actions, outside of knowledge and scope of the model. + Required. Google Cloud Storage URI(-s) to the input file(s). May + contain wildcards. For more information on wildcards, see + https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' - type: array - systemInstruction: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: >- - Optional. The user provided system instructions for the model. Note: - only text should be used in parts and content in each part will be - in a separate paragraph. - description: Request message for [PredictionService.GenerateContent]. - GoogleIamV1TestIamPermissionsResponse: - id: GoogleIamV1TestIamPermissionsResponse + type: string + GoogleCloudAiplatformV1ReadIndexDatapointsResponse: + id: GoogleCloudAiplatformV1ReadIndexDatapointsResponse properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. + datapoints: + description: The result list of datapoints. items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' type: array - description: Response message for `TestIamPermissions` method. + description: The response message for MatchService.ReadIndexDatapoints. type: object - GoogleCloudAiplatformV1GcsDestination: - description: The Google Cloud Storage location where the output is to be written to. + GoogleCloudAiplatformV1Context: type: object - id: GoogleCloudAiplatformV1GcsDestination + description: Instance of a general context. properties: - outputUriPrefix: + description: type: string + description: Description of the Context + name: + type: string + description: Immutable. The resource name of the Context. + etag: description: >- - Required. Google Cloud Storage URI to output directory. If the uri - doesn't end with '/', a '/' will be automatically appended. The - directory is created if it doesn't exist. - GoogleCloudAiplatformV1CancelBatchPredictionJobRequest: - id: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest - type: object - properties: {} - description: Request message for JobService.CancelBatchPredictionJob. - CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: - type: object - description: >- - An integer bounding box of original pixels of the image for the detected - labels. - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - properties: - y2: - type: integer - description: The Y coordinate of the bottom-right corner, in pixels. - format: int32 - x2: - format: int32 - type: integer - description: The X coordinate of the bottom-right corner, in pixels. - x1: - type: integer - description: The X coordinate of the top-left corner, in pixels. - format: int32 - y1: - format: int32 - description: The Y coordinate of the top-left corner, in pixels. - type: integer - GoogleCloudAiplatformV1IndexPrivateEndpoints: - description: >- - IndexPrivateEndpoints proto is used to provide paths for users to send - requests via private endpoints (e.g. private service access, private - service connect). To send request via private service access, use - match_grpc_address. To send request via private service connect, use - service_attachment. - properties: - pscAutomatedEndpoints: - type: array - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + type: string + displayName: description: >- - Output only. PscAutomatedEndpoints is populated if private service - connect is enabled if PscAutomatedConfig is set. - matchGrpcAddress: + User provided display name of the Context. May be up to 128 Unicode + characters. type: string - readOnly: true - description: Output only. The ip address used to send match gRPC requests. - serviceAttachment: + schemaTitle: type: string description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. - readOnly: true - id: GoogleCloudAiplatformV1IndexPrivateEndpoints - type: object - GoogleCloudAiplatformV1TensorboardBlob: - description: One blob (e.g, image, graph) viewable on a blob metric plot. - type: object - id: GoogleCloudAiplatformV1TensorboardBlob - properties: - data: - format: byte - description: >- - Optional. The bytes of the blob is not present unless it's returned - by the ReadTensorboardBlobData endpoint. - type: string - id: + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + schemaVersion: type: string description: >- - Output only. A URI safe key uniquely identifying a blob. Can be used - to locate the blob stored in the Cloud Storage bucket of the - consumer project. - readOnly: true - GoogleCloudAiplatformV1QuestionAnsweringQualitySpec: - type: object - id: GoogleCloudAiplatformV1QuestionAnsweringQualitySpec - description: Spec for question answering quality score metric. - properties: - version: - type: integer - description: Optional. Which version to use for evaluation. - format: int32 - useReference: - type: boolean + The version of the schema in schema_name to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + labels: description: >- - Optional. Whether to use instance.reference to compute question - answering quality. - GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: - id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback - properties: - blockReason: - type: string - enum: - - BLOCKED_REASON_UNSPECIFIED - - SAFETY - - OTHER - - BLOCKLIST - - PROHIBITED_CONTENT - enumDescriptions: - - Unspecified blocked reason. - - Candidates blocked due to safety. - - Candidates blocked due to other reason. - - >- - Candidates blocked due to the terms which are included from the - terminology blocklist. - - Candidates blocked due to prohibited content. - description: Output only. Blocked reason. - readOnly: true - safetyRatings: - readOnly: true + The labels with user-defined metadata to organize your Contexts. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Context (System + labels are excluded). + additionalProperties: + type: string + type: object + parentContexts: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' - description: Output only. Safety ratings. + type: string + description: >- + Output only. A list of resource names of Contexts that are parents + of this Context. A Context may have at most 10 parent_contexts. + readOnly: true type: array - blockReasonMessage: - description: Output only. A readable block reason message. + updateTime: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this Context was last updated. + type: string + createTime: + description: Output only. Timestamp when this Context was created. + format: google-datetime readOnly: true type: string + metadata: + type: object + description: >- + Properties of the Context. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + additionalProperties: + description: Properties of the object. + type: any + id: GoogleCloudAiplatformV1Context + GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation: + id: GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation type: object - description: Content filter results for a prompt sent in the request. - CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: properties: - boundingBox: - description: Bounding box of the label - $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - description: - description: Description of the label + instanceId: type: string - iouScore: + format: int64 description: >- - The intersection ratio between the detection bounding box and the - mask. + The instance of the object, expressed as a positive integer. Used to + track the same object across different frames. + xMin: type: number - format: float - score: - description: Confidence score of the label + format: double + description: The leftmost coordinate of the bounding box. + yMax: + format: double type: number - format: float - mid: - type: string - description: MID of the label - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity - description: The properties for a detected entity from the rai signal. - type: object - GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation: - id: GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation - properties: - timeSegment: + description: The bottommost coordinate of the bounding box. + yMin: + type: number + description: The topmost coordinate of the bounding box. + format: double + timeOffset: + format: google-duration description: >- - This Annotation applies to the time period represented by the - TimeSegment. If it's not set, the Annotation applies to the whole - video. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' + A time (frame) of a video to which this annotation pertains. + Represented as the duration since the video's start. + type: string displayName: + type: string description: >- The display name of the AnnotationSpec that this Annotation pertains to. - type: string annotationSpecId: + type: string description: >- The resource Id of the AnnotationSpec that this Annotation pertains to. - type: string - description: Annotation details specific to video classification. - type: object - GoogleCloudAiplatformV1ExplanationParameters: - properties: - topK: - format: int32 - type: integer - description: >- - If populated, returns attributions for top K indices of outputs - (defaults to 1). Only applies to Models that predicts more than one - outputs (e,g, multi-class Models). When set to -1, returns - explanations for all outputs. - examples: - description: >- - Example-based explanations that returns the nearest neighbors from - the provided dataset. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' - sampledShapleyAttribution: - description: >- - An attribution method that approximates Shapley values for features - that contribute to the label being predicted. A sampling strategy is - used to approximate the value rather than considering all subsets of - features. Refer to this paper for model details: - https://arxiv.org/abs/1306.4265. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SampledShapleyAttribution - xraiAttribution: - $ref: '#/components/schemas/GoogleCloudAiplatformV1XraiAttribution' - description: >- - An attribution method that redistributes Integrated Gradients - attribution to segmented regions, taking advantage of the model's - fully differentiable structure. Refer to this paper for more - details: https://arxiv.org/abs/1906.02825 XRAI currently performs - better on natural images, like a picture of a house or an animal. If - the images are taken in artificial environments, like a lab or - manufacturing line, or from diagnostic equipment, like x-rays or - quality-control cameras, use Integrated Gradients instead. - outputIndices: - items: - type: any - type: array - description: >- - If populated, only returns attributions that have output_index - contained in output_indices. It must be an ndarray of integers, with - the same shape of the output it's explaining. If not populated, - returns attributions for top_k indices of outputs. If neither top_k - nor output_indices is populated, returns the argmax index of the - outputs. Only applicable to Models that predict multiple outputs - (e,g, multi-class Models that predict multiple classes). - integratedGradientsAttribution: - description: >- - An attribution method that computes Aumann-Shapley values taking - advantage of the model's fully differentiable structure. Refer to - this paper for more details: https://arxiv.org/abs/1703.01365 - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IntegratedGradientsAttribution - id: GoogleCloudAiplatformV1ExplanationParameters - description: Parameters to configure explaining for Model's predictions. - type: object - GoogleCloudAiplatformV1MachineSpec: - description: Specification of a single machine. + xMax: + description: The rightmost coordinate of the bounding box. + format: double + type: number + description: Annotation details specific to video object tracking. + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec: properties: - acceleratorCount: - description: The number of accelerators to attach to the machine. - format: int32 - type: integer - reservationAffinity: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ReservationAffinity' - description: >- - Optional. Immutable. Configuration controlling how this resource - pool consumes reservation. - tpuTopology: - description: >- - Immutable. The topology of the TPUs. Corresponds to the TPU - topologies available from GKE. (Example: tpu_topology: "2x2x1"). + metricId: type: string - acceleratorType: - enumDescriptions: - - Unspecified accelerator type, which means no accelerator. - - >- - Deprecated: Nvidia Tesla K80 GPU has reached end of support, see - https://cloud.google.com/compute/docs/eol/k80-eol. - - Nvidia Tesla P100 GPU. - - Nvidia Tesla V100 GPU. - - Nvidia Tesla P4 GPU. - - Nvidia Tesla T4 GPU. - - Nvidia Tesla A100 GPU. - - Nvidia A100 80GB GPU. - - Nvidia L4 GPU. - - Nvidia H100 80Gb GPU. - - TPU v2. - - TPU v3. - - TPU v4. - - TPU v5. + description: Required. The ID of the metric. Must not contain whitespaces. + goal: type: string + description: Required. The optimization goal of the metric. + enumDescriptions: + - Goal Type will default to maximize. + - Maximize the goal metric. + - Minimize the goal metric. enum: - - ACCELERATOR_TYPE_UNSPECIFIED - - NVIDIA_TESLA_K80 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_V100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_L4 - - NVIDIA_H100_80GB - - TPU_V2 - - TPU_V3 - - TPU_V4_POD - - TPU_V5_LITEPOD - description: >- - Immutable. The type of accelerator(s) that may be attached to the - machine as per accelerator_count. - enumDeprecated: - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - 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. - type: string - id: GoogleCloudAiplatformV1MachineSpec - type: object - GoogleCloudAiplatformV1FluencyResult: + - GOAL_TYPE_UNSPECIFIED + - MAXIMIZE + - MINIMIZE + description: Represents a metric to optimize. + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec type: object + GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: + description: Details of operations that perform create FeatureView. + id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata properties: - confidence: - type: number - readOnly: true - description: Output only. Confidence for fluency score. - format: float - explanation: - type: string - readOnly: true - description: Output only. Explanation for fluency score. - score: - readOnly: true - type: number - format: float - description: Output only. Fluency score. - id: GoogleCloudAiplatformV1FluencyResult - description: Spec for fluency result. - GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureView Create. type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams + GoogleCloudAiplatformV1AutomaticResources: properties: - maxPredictions: + maxReplicaCount: format: int32 description: >- - The model only returns up to that many top, by confidence score, - predictions per frame of the video. If this number is very high, the - Model may return fewer predictions per frame. Default value is 50. + Immutable. The maximum number of replicas this DeployedModel 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 the model to that many replicas + is guaranteed (barring service outages). If traffic against the + DeployedModel 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. + type: integer + minReplicaCount: + format: int32 type: integer - confidenceThreshold: - format: float - type: number description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - description: Prediction model parameters for Video Action Recognition. - GoogleCloudAiplatformV1TensorboardBlobSequence: - properties: - values: - description: List of blobs contained within the sequence. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' - type: array + Immutable. The minimum number of replicas this DeployedModel will be + always deployed on. If traffic against it increases, it may + dynamically be deployed onto more replicas up to max_replica_count, + and as traffic decreases, some of these extra replicas may be freed. + If the requested value is too large, the deployment will error. + id: GoogleCloudAiplatformV1AutomaticResources + type: object description: >- - One point viewable on a blob metric plot, but mostly just a wrapper - message to work around repeated fields can't be used directly within - `oneof` fields. - id: GoogleCloudAiplatformV1TensorboardBlobSequence + 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. + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig: + description: >- + The objective configuration for model monitoring, including the + information needed to detect anomalies for one particular model. + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + properties: + trainingPredictionSkewDetectionConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + description: The config for skew between training data and prediction data. + trainingDataset: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset + description: >- + Training dataset for models. This field has to be set only if + TrainingPredictionSkewDetectionConfig is specified. + predictionDriftDetectionConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig + description: The config for drift of prediction data. + explanationConfig: + description: The config for integrating with Vertex Explainable AI. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig type: object - GoogleCloudAiplatformV1CompleteTrialRequest: + GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec: + id: GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec type: object - id: GoogleCloudAiplatformV1CompleteTrialRequest - description: Request message for VizierService.CompleteTrial. properties: - infeasibleReason: - type: string + useReference: description: >- - Optional. A human readable reason why the trial was infeasible. This - should only be provided if `trial_infeasible` is true. - trialInfeasible: + Optional. Whether to use instance.reference to compute pairwise + summarization quality. type: boolean - description: >- - Optional. True if the Trial cannot be run with the given Parameter, - and final_measurement will be ignored. - finalMeasurement: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - description: >- - Optional. If provided, it will be used as the completed Trial's - final_measurement; Otherwise, the service will auto-select a - previously reported measurement as the final-measurement - GoogleCloudAiplatformV1AddTrialMeasurementRequest: + version: + description: Optional. Which version to use for evaluation. + type: integer + format: int32 + description: Spec for pairwise summarization quality score metric. + GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse: + description: >- + Response message for + TensorboardService.BatchCreateTensorboardTimeSeries. properties: - measurement: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - description: Required. The measurement to be added to a Trial. + tensorboardTimeSeries: + type: array + description: The created TensorboardTimeSeries. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse type: object - description: Request message for VizierService.AddTrialMeasurement. - id: GoogleCloudAiplatformV1AddTrialMeasurementRequest - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix: + GoogleCloudAiplatformV1BatchMigrateResourcesRequest: properties: - annotationSpecs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef - description: >- - AnnotationSpecs used in the confusion matrix. For AutoML Text - Extraction, a special negative AnnotationSpec with empty `id` and - `displayName` of "NULL" will be added as the last element. - type: array - rows: + migrateResourceRequests: type: array items: - type: array - items: - type: any + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' description: >- - Rows in the confusion matrix. The number of rows is equal to the - size of `annotationSpecs`. `rowsi` is the number of DataItems that - have ground truth of the `annotationSpecs[i]` and are predicted as - `annotationSpecs[j]` by the Model being evaluated. For Text - Extraction, when `annotationSpecs[i]` is the last element in - `annotationSpecs`, i.e. the special negative AnnotationSpec, `rowsi` - is the number of predicted entities of `annoatationSpec[j]` that are - not labeled as any of the ground truth AnnotationSpec. When - annotationSpecs[j] is the special negative AnnotationSpec, `rowsi` - is the number of entities have ground truth of `annotationSpec[i]` - that are not predicted as an entity by the Model. The value of the - last cell, i.e. `rowi` where i == j and `annotationSpec[i]` is the - special negative AnnotationSpec, is always 0. + Required. The request messages specifying the resources to migrate. + They must be in the same location as the destination. Up to 50 + resources can be migrated in one batch. + id: GoogleCloudAiplatformV1BatchMigrateResourcesRequest type: object - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - GoogleCloudAiplatformV1MigrateResourceResponse: + description: Request message for MigrationService.BatchMigrateResources. + GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest: properties: - model: - type: string - description: Migrated Model's resource name. - dataset: - type: string - description: Migrated Dataset's resource name. - migratableResource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' + requests: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest description: >- - Before migration, the identifier in ml.googleapis.com, - automl.googleapis.com or datalabeling.googleapis.com. - description: Describes a successfully migrated resource. - id: GoogleCloudAiplatformV1MigrateResourceResponse + Required. The request message specifying the TensorboardTimeSeries + to create. A maximum of 1000 TensorboardTimeSeries can be created in + a batch. + type: array + description: Request message for TensorboardService.BatchCreateTensorboardTimeSeries. + id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest type: object - GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput: - description: Input for question answering correctness metric. - properties: - instance: - description: Required. Question answering correctness instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance - metricSpec: - description: Required. Spec for question answering correctness score metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec - id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput + GoogleCloudAiplatformV1ImportDataResponse: + properties: {} + description: Response message for DatasetService.ImportData. type: object - GoogleCloudAiplatformV1UpsertDatapointsRequest: + id: GoogleCloudAiplatformV1ImportDataResponse + GoogleCloudAiplatformV1RayLogsSpec: type: object properties: - updateMask: - type: string + disabled: description: >- - Optional. Update mask is used to specify the fields to be - overwritten in the datapoints by the update. The fields specified in - the update_mask are relative to each IndexDatapoint inside - datapoints, not the full request. Updatable fields: * Use - `all_restricts` to update both restricts and numeric_restricts. - format: google-fieldmask - datapoints: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - description: A list of datapoints to be created/updated. - description: Request message for IndexService.UpsertDatapoints - id: GoogleCloudAiplatformV1UpsertDatapointsRequest - GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF: + Optional. Flag to disable the export of Ray OSS logs to Cloud + Logging. + type: boolean + description: Configuration for the Ray OSS Logs. + id: GoogleCloudAiplatformV1RayLogsSpec + GoogleCloudAiplatformV1ToolParameterKVMatchResults: + id: GoogleCloudAiplatformV1ToolParameterKVMatchResults properties: - alpha: - type: number - format: float - description: >- - Required. Users can provide an alpha value to give more weight to - dense vs sparse results. For example, if the alpha is 0, we only - return sparse and if the alpha is 1, we only return dense. - description: Parameters for RRF algorithm that combines search results. - id: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF - type: object - GoogleTypeDate: - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + toolParameterKvMatchMetricValues: + description: Output only. Tool parameter key value match metric values. + readOnly: true + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue + type: array type: object + description: Results for tool parameter key value match metric. + GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest: + description: Request message for MetadataService.AddContextArtifactsAndExecutions. + id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest properties: - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - format: int32 - year: - type: integer - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - month: - format: int32 - type: integer - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - id: GoogleTypeDate - GoogleCloudAiplatformV1ModelExplanation: - description: Aggregated explanation metrics for a Model over a set of instances. - properties: - meanAttributions: + artifacts: + items: + type: string type: array + description: >- + The resource names of the Artifacts to attribute to the Context. + Format: + `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + executions: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' - readOnly: true + type: string description: >- - Output only. Aggregated attributions explaining the Model's - prediction outputs over the set of instances. The attributions are - grouped by outputs. For Models that predict only one output, such as - regression Models that predict only one score, there is only one - attibution that explains the predicted output. For Models that - predict multiple outputs, such as multiclass Models that predict - multiple classes, each element explains one specific item. - Attribution.output_index can be used to identify which output this - attribution is explaining. The baselineOutputValue, - instanceOutputValue and featureAttributions fields are averaged over - the test data. NOTE: Currently AutoML tabular classification Models - produce only one attribution, which averages attributions over all - the classes it predicts. Attribution.approximation_error is not - populated. + The resource names of the Executions to associate with the Context. + Format: + `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + type: array type: object - id: GoogleCloudAiplatformV1ModelExplanation - GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance: + GoogleCloudAiplatformV1CreateFeatureOperationMetadata: type: object + description: Details of operations that perform create Feature. properties: - mimeType: - description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/png - type: string - content: - type: string - description: The image bytes to make the predictions on. - description: Prediction input format for Image Segmentation. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata - properties: - costMilliNodeHours: - description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. - type: string - format: int64 - successfulStopReason: - enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - - >- - Further training of the Model ceased to increase its quality, - since it already has converged. - description: >- - For successful job completions, this is the reason why the job has - finished. - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED - type: string + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature. + id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata + GoogleCloudAiplatformV1ListSavedQueriesResponse: + id: GoogleCloudAiplatformV1ListSavedQueriesResponse + description: Response message for DatasetService.ListSavedQueries. type: object - GoogleCloudAiplatformV1ListDataItemsResponse: - description: Response message for DatasetService.ListDataItems. - id: GoogleCloudAiplatformV1ListDataItemsResponse properties: - dataItems: + savedQueries: type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' description: >- - A list of DataItems that matches the specified filter in the + A list of SavedQueries that match the specified filter in the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' nextPageToken: type: string description: The standard List next-page token. - type: object - GoogleCloudAiplatformV1CoherenceSpec: - id: GoogleCloudAiplatformV1CoherenceSpec - description: Spec for coherence score metric. + GoogleCloudAiplatformV1SmoothGradConfig: + id: GoogleCloudAiplatformV1SmoothGradConfig type: object properties: - version: - type: integer - description: Optional. Which version to use for evaluation. + noiseSigma: + type: number + format: float + description: >- + This is a single float value and will be used to add noise to all + the features. Use this field when all features are normalized to + have the same distribution: scale to range [0, 1], [-1, 1] or + z-scoring, where features are normalized to have 0-mean and + 1-variance. Learn more about + [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). + For best results the recommended value is about 10% - 20% of the + standard deviation of the input feature. Refer to section 3.2 of the + SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to + 0.1. If the distribution is different per feature, set + feature_noise_sigma instead for each feature. + featureNoiseSigma: + description: >- + This is similar to noise_sigma, but provides additional flexibility. + A separate noise sigma can be provided for each feature, which is + useful if their distributions are different. No noise is added to + features that are not set. If this field is unset, noise_sigma will + be used for all features. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigma' + noisySampleCount: format: int32 - GoogleCloudAiplatformV1ListCustomJobsResponse: - description: Response message for JobService.ListCustomJobs - id: GoogleCloudAiplatformV1ListCustomJobsResponse + description: >- + The number of gradient samples to use for approximation. The higher + this number, the more accurate the gradient is, but the runtime + complexity increases by this factor as well. Valid range of its + value is [1, 50]. Defaults to 3. + type: integer + description: >- + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy samples + in the vicinity of the inputs. Adding noise can help improve the + computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + GoogleCloudAiplatformV1FindNeighborsResponseNeighbor: + description: A neighbor of the query vector. properties: - nextPageToken: - type: string + datapoint: description: >- - A token to retrieve the next page of results. Pass to - ListCustomJobsRequest.page_token to obtain that page. - customJobs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' - description: List of CustomJobs in the requested page. + The datapoint of the neighbor. Note that full datapoints are + returned only when "return_full_datapoint" is set to true. + Otherwise, only the "datapoint_id" and "crowding_tag" fields are + populated. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + distance: + type: number + description: The distance between the neighbor and the dense embedding query. + format: double + sparseDistance: + description: The distance between the neighbor and the query sparse_embedding. + format: double + type: number + type: object + id: GoogleCloudAiplatformV1FindNeighborsResponseNeighbor + GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata: + id: GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata + description: >- + Runtime operation metadata for + SpecialistPoolService.UpdateSpecialistPool. type: object - GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance: - description: Spec for pairwise question answering quality instance. - id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance properties: - baselinePrediction: - description: Required. Output of the baseline model. - type: string - instruction: - type: string - description: Required. Question Answering prompt for LLM. - context: - type: string - description: Required. Text to answer the question. - prediction: - type: string - description: Required. Output of the candidate model. - reference: - description: Optional. Ground truth used to compare against the prediction. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + specialistPool: + description: >- + Output only. The name of the SpecialistPool to which the specialists + are being added. Format: + `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` + readOnly: true type: string + GoogleCloudAiplatformV1StringArray: + description: A list of string values. + properties: + values: + description: A list of string values. + items: + type: string + type: array type: object - GoogleCloudAiplatformV1TrainingPipeline: + id: GoogleCloudAiplatformV1StringArray + GoogleCloudAiplatformV1PairwiseMetricResult: + id: GoogleCloudAiplatformV1PairwiseMetricResult + description: Spec for pairwise metric result. properties: - createTime: - description: Output only. Time when the TrainingPipeline was created. + explanation: readOnly: true - format: google-datetime type: string - startTime: - format: google-datetime + description: Output only. Explanation for pairwise metric score. + pairwiseChoice: readOnly: true + description: Output only. Pairwise metric choice. + enum: + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE + enumDescriptions: + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined type: string + type: object + GoogleCloudAiplatformV1DeployIndexRequest: + type: object + properties: + deployedIndex: + description: Required. The DeployedIndex to be created within the IndexEndpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: Request message for IndexEndpointService.DeployIndex. + id: GoogleCloudAiplatformV1DeployIndexRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition: + description: >- + A TrainingJob that trains and uploads an AutoML Video Action Recognition + Model. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition + type: object + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + description: The input parameters of this TrainingJob. + GoogleCloudAiplatformV1Explanation: + description: >- + Explanation of a prediction (provided in PredictResponse.predictions) + produced by the Model on a given instance. + type: object + id: GoogleCloudAiplatformV1Explanation + properties: + attributions: + readOnly: true description: >- - Output only. Time when the TrainingPipeline for the first time - entered the `PIPELINE_STATE_RUNNING` state. - trainingTaskDefinition: - type: string - description: >- - Required. A Google Cloud Storage path to the YAML file that defines - the training task which is responsible for producing the model - artifact, and may also include additional auxiliary work. The - definition files that can be used here are found in - gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - inputDataConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1InputDataConfig' - description: >- - Specifies Vertex AI owned input data that may be used for training - the Model. The TrainingPipeline's training_task_definition should - make clear whether this config is used and if there are any special - requirements on how it should be filled. If nothing about this - config is mentioned in the training_task_definition, then it should - be assumed that the TrainingPipeline does not depend on this - configuration. - trainingTaskMetadata: - type: any - description: >- - Output only. The metadata information as specified in the - training_task_definition's `metadata`. This metadata is an auxiliary - runtime and final information about the training task. While the - pipeline is running this information is populated only at a best - effort basis. Only present if the pipeline's - training_task_definition contains `metadata` object. + Output only. Feature attributions grouped by predicted outputs. For + Models that predict only one output, such as regression Models that + predict only one score, there is only one attibution that explains + the predicted output. For Models that predict multiple outputs, such + as multiclass Models that predict multiple classes, each element + explains one specific item. Attribution.output_index can be used to + identify which output this attribution is explaining. By default, we + provide Shapley values for the predicted class. However, you can + configure the explanation request to generate Shapley values for any + other classes too. For example, if a model predicts a probability of + `0.4` for approving a loan application, the model's decision is to + reject the application since `p(reject) = 0.6 > p(approve) = 0.4`, + and the default Shapley values would be computed for rejection + decision and not approval, even though the latter might be the + positive class. If users set ExplanationParameters.top_k, the + attributions are sorted by instance_output_value in descending + order. If ExplanationParameters.output_indices is specified, the + attributions are stored by Attribution.output_index in the same + order as they appear in the output_indices. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' + neighbors: + type: array readOnly: true - parentModel: description: >- - Optional. When specify this field, the `model_to_upload` will not be - uploaded as a new model, instead, it will become a new version of - this `parent_model`. - type: string - endTime: + Output only. List of the nearest neighbors for example-based + explanations. For models deployed with the examples explanations + feature enabled, the attributions field is empty and instead the + neighbors field is populated. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Neighbor' + GoogleTypeMoney: + description: Represents an amount of money with its currency type. + type: object + properties: + currencyCode: type: string - format: google-datetime + description: The three-letter currency code defined in ISO 4217. + nanos: + type: integer description: >- - Output only. Time when the TrainingPipeline entered any of the - following states: `PIPELINE_STATE_SUCCEEDED`, - `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. - readOnly: true - modelToUpload: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + format: int32 + units: description: >- - Describes the Model that may be uploaded (via - ModelService.UploadModel) by this TrainingPipeline. The - TrainingPipeline's training_task_definition should make clear - whether this Model description should be populated, and if there are - any special requirements regarding how it should be filled. If - nothing is mentioned in the training_task_definition, then it should - be assumed that this field should not be filled and the training - task either uploads the Model without a need of this information, or - that training task does not support uploading a Model as part of the - pipeline. When the Pipeline's state becomes - `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded - into Vertex AI, then the model_to_upload's resource name is - populated. The Model is always uploaded into the Project and - Location in which this pipeline is. - updateTime: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - readOnly: true - description: >- - Output only. Time when the TrainingPipeline was most recently - updated. - format: google-datetime - labels: + format: int64 + id: GoogleTypeMoney + GoogleCloudAiplatformV1WriteFeatureValuesPayload: + description: Contains Feature values to be written for a specific entity. + properties: + entityId: + description: Required. The ID of the entity. + type: string + featureValues: additionalProperties: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' description: >- - The labels with user-defined metadata to organize TrainingPipelines. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. + Required. Feature values to be written, mapping from Feature ID to + value. Up to 100,000 `feature_values` entries may be written across + all payloads. The feature generation time, aligned by days, must be + no older than five years (1825 days) and no later than one year (366 + days) in the future. type: object - modelId: + id: GoogleCloudAiplatformV1WriteFeatureValuesPayload + type: object + GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance: + properties: + timeSegmentStart: description: >- - Optional. The ID to use for the uploaded Model, which will become - the final component of the model 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 beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. type: string - state: - description: Output only. The detailed state of the pipeline. - enumDescriptions: - - The pipeline state is unspecified. - - >- - The pipeline has been created or resumed, and processing has not - yet begun. - - The service is preparing to run the pipeline. - - The pipeline is in progress. - - The pipeline completed successfully. - - The pipeline failed. - - >- - The pipeline is being cancelled. From this state, the pipeline may - only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED - or PIPELINE_STATE_CANCELLED. - - The pipeline has been cancelled. - - The pipeline has been stopped, and can be resumed. - readOnly: true - enum: - - PIPELINE_STATE_UNSPECIFIED - - PIPELINE_STATE_QUEUED - - PIPELINE_STATE_PENDING - - PIPELINE_STATE_RUNNING - - PIPELINE_STATE_SUCCEEDED - - PIPELINE_STATE_FAILED - - PIPELINE_STATE_CANCELLING - - PIPELINE_STATE_CANCELLED - - PIPELINE_STATE_PAUSED + content: type: string - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Customer-managed encryption key spec for a TrainingPipeline. If set, - this TrainingPipeline will be secured by this key. Note: Model - trained by this TrainingPipeline is also secured by this key if - model_to_upload is not set separately. - trainingTaskInputs: + The Google Cloud Storage location of the video on which to perform + the prediction. + timeSegmentEnd: description: >- - Required. The training task's parameter(s), as specified in the - training_task_definition's `inputs`. - type: any - displayName: + The end, exclusive, of the video's time segment on which to perform + the prediction. Expressed as a number of seconds as measured from + the start of the video, with "s" appended at the end. Fractions are + allowed, up to a microsecond precision, and "inf" or "Infinity" is + allowed, which means the end of the video. type: string - description: Required. The user-defined name of this TrainingPipeline. - name: - readOnly: true - description: Output only. Resource name of the TrainingPipeline. + mimeType: type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true description: >- - Output only. Only populated when the pipeline's state is - `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. - description: >- - The TrainingPipeline orchestrates tasks associated with training a - Model. It always executes the training task, and optionally may also - export data from Vertex AI's Dataset which becomes the training input, - upload the Model to Vertex AI, and evaluate the Model. + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance + description: Prediction input format for Video Classification. type: object - id: GoogleCloudAiplatformV1TrainingPipeline - GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting: + properties: + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata + description: The metadata information. + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + type: object + GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi: + type: object + properties: + title: + description: Required. The title of the view rest API. + type: string + documentations: + description: Required. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelDocumentation + id: GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi + description: Rest API docs. + GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance: + description: Prediction input format for Image Classification. + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance + properties: + mimeType: + description: >- + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/gif - + image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + type: string + content: + description: The image bytes or Cloud Storage URI to make the prediction on. + type: string + GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec: + id: GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec properties: - entityId: + explanationType: type: string - description: ID of the requested entity. - data: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData - type: array description: >- - Each piece of data holds the k requested values for one requested - Feature. If no values for the requested Feature exist, the - corresponding cell will be empty. This has the same size and is in - the same order as the features from the header - ReadFeatureValuesResponse.header. + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + explanationSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + description: Explanation spec details. type: object - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView - description: Entity view with Feature values. - GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput: - id: GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies: + id: >- + GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies + description: Historical Stats (and Anomalies) for a specific Feature. type: object properties: - trainTrials: - type: array - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - description: >- - Output only. List of NasTrials that were started as part of train - stage. - searchTrials: + threshold: + description: Threshold for anomaly detection. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + featureDisplayName: + description: Display Name of the Feature. + type: string + trainingStats: + description: Stats calculated for the Training Dataset. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + predictionStats: description: >- - Output only. List of NasTrials that were started as part of search - stage. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - readOnly: true - type: array - description: The output of a multi-trial Neural Architecture Search (NAS) jobs. - GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult: - description: Prediction output format for Time Series Forecasting. - properties: - quantileValues: - description: Quantile values. - type: array + A list of historical stats generated by different time window's + Prediction Dataset. items: - type: number - format: float - tftFeatureImportance: - description: Only use these if TFt is enabled. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance - quantilePredictions: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' type: array - items: - type: number - format: float - description: Quantile predictions, in 1-1 correspondence with quantile_values. - value: - format: float - type: number - description: The regression value. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult + GoogleCloudAiplatformV1ListExecutionsResponse: type: object - GoogleCloudAiplatformV1ListSchedulesResponse: - description: Response message for ScheduleService.ListSchedules + description: Response message for MetadataService.ListExecutions. properties: - schedules: + executions: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' - description: List of Schedules in the requested page. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' type: array + description: The Executions retrieved from the MetadataStore. nextPageToken: type: string description: >- - A token to retrieve the next page of results. Pass to - ListSchedulesRequest.page_token to obtain that page. - id: GoogleCloudAiplatformV1ListSchedulesResponse + A token, which can be sent as ListExecutionsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. + id: GoogleCloudAiplatformV1ListExecutionsResponse + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain: type: object - GoogleCloudAiplatformV1Citation: + description: >- + Domain details of the input feature value. Provides numeric information + about the feature, such as its range (min, max). If the feature has been + pre-processed, for example with z-scoring, then it provides information + about how to recover the original feature. For example, if the input + feature is an image and it has been pre-processed to obtain 0-mean and + stddev = 1 values, then original_mean, and original_stddev refer to the + mean and stddev of the original feature (e.g. image tensor) from which + input feature (with mean = 0 and stddev = 1) was obtained. + id: >- + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain properties: - startIndex: - description: Output only. Start index into the content. - format: int32 - type: integer - readOnly: true - uri: - description: Output only. Url reference of the attribution. - readOnly: true - type: string - publicationDate: + maxValue: + description: The maximum permissible value for this feature. + type: number + format: float + minValue: + type: number + format: float + description: The minimum permissible value for this feature. + originalStddev: + type: number + description: >- + If this input feature has been normalized to a standard deviation of + 1.0, the original_stddev specifies the standard deviation of the + domain prior to normalization. + format: float + originalMean: + type: number + description: >- + If this input feature has been normalized to a mean value of 0, the + original_mean specifies the mean value of the domain prior to + normalization. + format: float + GoogleCloudAiplatformV1GroundednessResult: + type: object + properties: + confidence: readOnly: true - description: Output only. Publication date of the attribution. - $ref: '#/components/schemas/GoogleTypeDate' - endIndex: - format: int32 - type: integer - description: Output only. End index into the content. + type: number + format: float + description: Output only. Confidence for groundedness score. + score: + format: float readOnly: true - license: - type: string - description: Output only. License of the attribution. + description: Output only. Groundedness score. + type: number + explanation: + description: Output only. Explanation for groundedness score. readOnly: true - title: type: string - readOnly: true - description: Output only. Title of the attribution. - id: GoogleCloudAiplatformV1Citation - type: object - description: Source attributions for content. - GoogleCloudAiplatformV1Schema: + id: GoogleCloudAiplatformV1GroundednessResult + description: Spec for groundedness result. + GoogleCloudAiplatformV1SearchMigratableResourcesRequest: + id: GoogleCloudAiplatformV1SearchMigratableResourcesRequest type: object properties: - minimum: - type: number - description: >- - Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of - the Type.INTEGER and Type.NUMBER - format: double - minItems: - description: Optional. Minimum number of the elements for Type.ARRAY. - type: string - format: int64 - maxItems: - description: Optional. Maximum number of the elements for Type.ARRAY. + pageToken: type: string - format: int64 - nullable: - type: boolean - description: Optional. Indicates if the value may be null. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: The standard page token. + pageSize: + type: integer + description: The standard page size. The default and maximum value is 100. + format: int32 + filter: description: >- - Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of - Type.ARRAY. - minProperties: + A filter for your search. You can use the following types of + filters: * Resource type filters. The following strings filter for a + specific type of MigratableResource: * `ml_engine_model_version:*` * + `automl_model:*` * `automl_dataset:*` * `data_labeling_dataset:*` * + "Migrated or not" filters. The following strings filter for + resources that either have or have not already been migrated: * + `last_migrate_time:*` filters for migrated resources. * `NOT + last_migrate_time:*` filters for not yet migrated resources. type: string - description: Optional. Minimum number of the properties for Type.OBJECT. - format: int64 - maximum: - format: double - type: number - description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER - maxProperties: + description: Request message for MigrationService.SearchMigratableResources. + GoogleCloudAiplatformV1PauseScheduleRequest: + type: object + properties: {} + description: Request message for ScheduleService.PauseSchedule. + id: GoogleCloudAiplatformV1PauseScheduleRequest + GoogleCloudAiplatformV1ListContextsResponse: + type: object + description: Response message for MetadataService.ListContexts. + properties: + nextPageToken: type: string - format: int64 - description: Optional. Maximum number of the properties for Type.OBJECT. - example: - type: any description: >- - Optional. Example of the object. Will only populated when the object - is the root. - enum: + A token, which can be sent as ListContextsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. + contexts: + description: The Contexts retrieved from the MetadataStore. + type: array items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + id: GoogleCloudAiplatformV1ListContextsResponse + GoogleCloudAiplatformV1QueryDeployedModelsResponse: + type: object + description: Response message for QueryDeployedModels method. + properties: + totalEndpointCount: + format: int32 description: >- - Optional. Possible values of the element of Type.STRING with enum - format. For example we can define an Enum Direction as : - {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - type: array - maxLength: - description: Optional. Maximum length of the Type.STRING - type: string - format: int64 - required: + The total number of Endpoints that have DeployedModels on this + DeploymentResourcePool. + type: integer + deployedModelRefs: items: - type: string - description: Optional. Required properties of Type.OBJECT. - type: array - title: - type: string - description: Optional. The title of the Schema. - description: - description: Optional. The description of the data. - type: string - default: - type: any - description: Optional. Default value of the data. - format: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' description: >- - Optional. The format of the data. Supported formats: for NUMBER - type: "float", "double" for INTEGER type: "int32", "int64" for - STRING type: "email", "byte", etc - pattern: + References to the DeployedModels that share the specified + deploymentResourcePool. + type: array + nextPageToken: type: string description: >- - Optional. Pattern of the Type.STRING to restrict a string to a - regular expression. - properties: - type: object - description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - type: - description: Optional. The type of the data. - enum: - - TYPE_UNSPECIFIED - - STRING - - NUMBER - - INTEGER - - BOOLEAN - - ARRAY - - OBJECT - enumDescriptions: - - Not specified, should not be used. - - OpenAPI string type - - OpenAPI number type - - OpenAPI integer type - - OpenAPI boolean type - - OpenAPI array type - - OpenAPI object type + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + deployedModels: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: DEPRECATED Use deployed_model_refs instead. + deprecated: true + totalDeployedModelCount: + type: integer + format: int32 + description: The total number of DeployedModels on this DeploymentResourcePool. + id: GoogleCloudAiplatformV1QueryDeployedModelsResponse + GoogleCloudAiplatformV1FulfillmentInstance: + description: Spec for fulfillment instance. + type: object + properties: + instruction: + description: Required. Inference instruction prompt to compare prediction with. type: string - minLength: - description: >- - Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the - Type.STRING + prediction: + description: Required. Output of the evaluated model. type: string - format: int64 - id: GoogleCloudAiplatformV1Schema - description: >- - Schema is used to define the format of input/output data. Represents a - select subset of an [OpenAPI 3.0 schema - object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields - may be added in the future as needed. - GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData: - properties: - values: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueList' - description: >- - Feature values list if values, successive in time, are requested. If - the requested number of values is greater than the number of - existing Feature values, nonexistent values are omitted instead of - being returned as empty. - value: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: Feature value if a single value is requested. - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData - description: >- - Container to hold value(s), successive in time, for one Feature from the - request. - type: object - GoogleCloudAiplatformV1ToolConfig: + id: GoogleCloudAiplatformV1FulfillmentInstance + GoogleCloudAiplatformV1ExportFeatureValuesResponse: + description: Response message for FeaturestoreService.ExportFeatureValues. + id: GoogleCloudAiplatformV1ExportFeatureValuesResponse type: object - properties: - functionCallingConfig: - description: Optional. Function calling config. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' - description: >- - Tool config. This config is shared for all tools provided in the - request. - id: GoogleCloudAiplatformV1ToolConfig - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics: - description: Metrics for text extraction evaluation results. + properties: {} + GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics: id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics + GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics properties: - confidenceMetrics: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from them. - type: array - confusionMatrix: + rSquared: description: >- - Confusion matrix of the evaluation. Only set for Models where number - of AnnotationSpecs is no more than 10. Only set for - ModelEvaluations, not for ModelEvaluationSlices. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - type: object - GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter: - id: GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter - properties: - valueDouble: - format: double - description: double value type. + Coefficient of determination as Pearson correlation coefficient. + Undefined when ground truth or predictions are constant or near + constant. type: number - valueInt: - format: int64 - type: string - description: int value type. - valueFloat: + format: float + rootMeanSquaredLogError: + format: float type: number - description: float value type. + description: >- + Root mean squared log error. Undefined when there are negative + ground truth values or predictions. + rootMeanSquaredError: + type: number + description: Root Mean Squared Error (RMSE). format: float - name: - description: Required. Column name in BigQuery that used as filters. - type: string - op: - type: string + meanAbsolutePercentageError: description: >- - Optional. This MUST be specified for queries and must NOT be - specified for database points. - enumDescriptions: - - Unspecified operator. - - Entities are eligible if their value is < the query's. - - Entities are eligible if their value is <= the query's. - - Entities are eligible if their value is == the query's. - - Entities are eligible if their value is >= the query's. - - Entities are eligible if their value is > the query's. - - Entities are eligible if their value is != the query's. - enum: - - OPERATOR_UNSPECIFIED - - LESS - - LESS_EQUAL - - EQUAL - - GREATER_EQUAL - - GREATER - - NOT_EQUAL - type: object - description: >- - Numeric filter is used to search a subset of the entities by using - boolean rules on numeric columns. For example: Database Point 0: {name: - "a" value_int: 42} {name: "b" value_float: 1.0} Database Point 1: {name: - "a" value_int: 10} {name: "b" value_float: 2.0} Database Point 2: {name: - "a" value_int: -1} {name: "b" value_float: 3.0} Query: {name: "a" - value_int: 12 operator: LESS} // Matches Point 1, 2 {name: "b" - value_float: 2.0 operator: EQUAL} // Matches Point 1 - GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup: + Mean absolute percentage error. Infinity when there are zeros in the + ground truth. + format: float + type: number + meanAbsoluteError: + format: float + type: number + description: Mean Absolute Error (MAE). + description: Metrics for regression evaluation results. type: object + GoogleCloudAiplatformV1ListNasJobsResponse: + id: GoogleCloudAiplatformV1ListNasJobsResponse properties: - featureIds: - description: Required. Identifiers of features under the feature group. - items: - type: string - type: array - featureGroupId: - description: Required. Identifier of the feature group. - type: string - description: >- - Features belonging to a single feature group that will be synced to - Online Store. - id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup - GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences: - properties: - references: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelResourceReference - description: Required. - type: object - resourceTitle: - type: string - description: Optional. Title of the resource. - resourceDescription: - description: Optional. Description of the resource. - type: string - resourceUseCase: - description: Optional. Use case (CUJ) of the resource. - type: string - title: + nextPageToken: type: string - description: 'Required. ' + description: >- + A token to retrieve the next page of results. Pass to + ListNasJobsRequest.page_token to obtain that page. + nasJobs: + description: >- + List of NasJobs in the requested page. NasJob.nas_job_output of the + jobs will not be returned. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + description: Response message for JobService.ListNasJobs + type: object + GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams: id: >- - GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams type: object - description: >- - The regional resource name or the URI. Key is region, e.g., us-central1, - europe-west2, global, etc.. + properties: + maxPredictions: + description: >- + The Model only returns up to that many top, by confidence score, + predictions per instance. Note that number of returned predictions + is also limited by metadata's predictionsLimit. Default value is 10. + type: integer + format: int32 + confidenceThreshold: + description: >- + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + format: float + type: number + description: Prediction model parameters for Image Object Detection. + GoogleCloudAiplatformV1UploadModelOperationMetadata: + id: GoogleCloudAiplatformV1UploadModelOperationMetadata + type: object + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + description: Details of ModelService.UploadModel operation. parameters: + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -24808,34 +24883,23 @@ components: name: prettyPrint schema: type: boolean - callback: - description: JSONP - in: query - name: callback - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - access_token: - description: OAuth access token. + alt: + description: Data format for response. in: query - name: access_token + name: alt schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + enum: + - json + - media + - proto + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: oauth_token + name: quotaUser schema: type: string _.xgafv: @@ -24847,31 +24911,30 @@ components: enum: - '1' - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: quotaUser + name: oauth_token schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string - alt: - description: Data format for response. + access_token: + description: OAuth access token. in: query - name: alt + name: access_token + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string - enum: - - json - - media - - proto x-stackQL-resources: models: id: google.aiplatform.models @@ -24885,10 +24948,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - compute_tokens: + stream_generate_content: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:computeTokens/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamGenerateContent/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -24899,17 +24969,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - stream_generate_content: + compute_tokens: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamGenerateContent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:computeTokens/post response: mediaType: application/json openAPIDocKey: '200' - get: + predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predict/post response: mediaType: application/json openAPIDocKey: '200' @@ -24920,10 +24990,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - predict: + raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:rawPredict/post response: mediaType: application/json openAPIDocKey: '200' @@ -24934,10 +25004,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - raw_predict: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:rawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -24948,13 +25018,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.models merge_version_aliases: operation: $ref: >- @@ -24962,6 +25033,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' export: operation: $ref: >- @@ -24976,72 +25054,215 @@ components: response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/models/methods/get' + - $ref: '#/components/x-stackQL-resources/models/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/models/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/models/methods/delete' + locations: + id: google.aiplatform.locations + name: locations + title: Locations + methods: + evaluate_instances: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:evaluateInstances/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + datasets: + id: google.aiplatform.datasets + name: datasets + title: Datasets + methods: + create: + operation: + $ref: '#/paths/~1v1~1datasets/post' + response: + mediaType: application/json + openAPIDocKey: '200' list: + operation: + $ref: '#/paths/~1v1~1datasets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.datasets + get: + operation: + $ref: '#/paths/~1v1~1datasets~1{datasetsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1v1~1datasets~1{datasetsId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v1~1datasets~1{datasetsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:import/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.models - upload: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:export/post + response: + mediaType: application/json + openAPIDocKey: '200' + search_data_items: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:searchDataItems/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/models/methods/get' - - $ref: '#/components/x-stackQL-resources/models/methods/list' - insert: [] + - $ref: '#/components/x-stackQL-resources/datasets/methods/get' + - $ref: '#/components/x-stackQL-resources/datasets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create' update: - - $ref: '#/components/x-stackQL-resources/models/methods/patch' + - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/models/methods/delete' + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' + dataset_versions: + id: google.aiplatform.dataset_versions + name: dataset_versions + title: Dataset_versions + methods: + delete: + operation: + $ref: >- + #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + restore: + operation: + $ref: >- + #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}:restore/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.datasetVersions + create: + operation: + $ref: '#/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/delete' operations: id: google.aiplatform.operations name: operations title: Operations methods: - get: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - delete: + wait: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}:wait/post response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - wait: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations~1{operationsId}:wait/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - cancel: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -25051,615 +25272,624 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - migratable_resources: - id: google.aiplatform.migratable_resources - name: migratable_resources - title: Migratable_resources + annotation_specs: + id: google.aiplatform.annotation_specs + name: annotation_specs + title: Annotation_specs methods: - search: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:search/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1annotationSpecs~1{annotationSpecsId}/get response: mediaType: application/json openAPIDocKey: '200' - batch_migrate: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/annotation_specs/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + annotations: + id: google.aiplatform.annotations + name: annotations + title: Annotations + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:batchMigrate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems~1{dataItemsId}~1annotations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.annotations sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/annotations/methods/list' insert: [] update: [] replace: [] delete: [] - operations_wait: - id: google.aiplatform.operations_wait - name: operations_wait - title: Operations_wait + data_items: + id: google.aiplatform.data_items + name: data_items + title: Data_items methods: - list_wait: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}~1operations~1{operationsId}:wait/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations + objectKey: $.dataItems sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' + - $ref: '#/components/x-stackQL-resources/data_items/methods/list' insert: [] update: [] replace: [] delete: [] - feature_views: - id: google.aiplatform.feature_views - name: feature_views - title: Feature_views + saved_queries: + id: google.aiplatform.saved_queries + name: saved_queries + title: Saved_queries methods: - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries~1{savedQueriesId}/delete response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureViews - search_nearest_entities: + objectKey: $.savedQueries + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' + endpoints: + id: google.aiplatform.endpoints + name: endpoints + title: Endpoints + methods: + generate_content: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:searchNearestEntities/post + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:generateContent/post' response: mediaType: application/json openAPIDocKey: '200' - get: + predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/get response: mediaType: application/json openAPIDocKey: '200' - sync: + objectKey: $.endpoints + count_tokens: + operation: + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:countTokens/post' + response: + mediaType: application/json + openAPIDocKey: '200' + raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:sync/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:rawPredict/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_views/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/patch' - replace: [] delete: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/delete' - feature_views_iam_policies: - id: google.aiplatform.feature_views_iam_policies - name: feature_views_iam_policies - title: Feature_views_iam_policies - methods: - get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/patch response: mediaType: application/json openAPIDocKey: '200' - set_iam_policy: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/feature_views_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/feature_views_iam_policies/methods/set_iam_policy - delete: [] - feature_views_feature_values: - id: google.aiplatform.feature_views_feature_values - name: feature_views_feature_values - title: Feature_views_feature_values - methods: - fetch_feature_values: + server_streaming_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:serverStreamingPredict/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/feature_views_feature_values/methods/fetch_feature_values - insert: [] - update: [] - replace: [] - delete: [] - feature_view_syncs: - id: google.aiplatform.feature_view_syncs - name: feature_view_syncs - title: Feature_view_syncs - methods: - get: + undeploy_model: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs~1{featureViewSyncsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:undeployModel/post response: mediaType: application/json openAPIDocKey: '200' - list: + deploy_model: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:deployModel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureViewSyncs - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - feature_online_stores: - id: google.aiplatform.feature_online_stores - name: feature_online_stores - title: Feature_online_stores - methods: - get: + explain: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:explain/post + response: + mediaType: application/json + openAPIDocKey: '200' + mutate_deployed_model: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:mutateDeployedModel/post response: mediaType: application/json openAPIDocKey: '200' - delete: + stream_raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamRawPredict/post response: mediaType: application/json openAPIDocKey: '200' - patch: + direct_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directPredict/post response: mediaType: application/json openAPIDocKey: '200' - create: + compute_tokens: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/post + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:computeTokens/post' response: mediaType: application/json openAPIDocKey: '200' - list: + stream_generate_content: + operation: + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:streamGenerateContent/post' + response: + mediaType: application/json + openAPIDocKey: '200' + direct_raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directRawPredict/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureOnlineStores sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_online_stores/methods/get' - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/list + - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/create + - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/patch + - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/delete - feature_online_stores_iam_policies: - id: google.aiplatform.feature_online_stores_iam_policies - name: feature_online_stores_iam_policies - title: Feature_online_stores_iam_policies + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' + schedules: + id: google.aiplatform.schedules + name: schedules + title: Schedules methods: - test_iam_permissions: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/patch response: mediaType: application/json openAPIDocKey: '200' - get_iam_policy: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/set_iam_policy - delete: [] - persistent_resources: - id: google.aiplatform.persistent_resources - name: persistent_resources - title: Persistent_resources - methods: - list: + pause: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:pause/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.persistentResources create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.schedules + resume: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:resume/post response: mediaType: application/json openAPIDocKey: '200' - patch: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schedules/methods/get' + - $ref: '#/components/x-stackQL-resources/schedules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/schedules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/schedules/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' + specialist_pools: + id: google.aiplatform.specialist_pools + name: specialist_pools + title: Specialist_pools + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - reboot: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}:reboot/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/get' - - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/list' - insert: - - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/create - update: - - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/delete - endpoints: - id: google.aiplatform.endpoints - name: endpoints - title: Endpoints - methods: - stream_raw_predict: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.specialistPools + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/patch' + replace: [] delete: + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/delete' + notebook_execution_jobs: + id: google.aiplatform.notebook_execution_jobs + name: notebook_execution_jobs + title: Notebook_execution_jobs + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - deploy_model: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:deployModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - server_streaming_predict: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:serverStreamingPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/post response: mediaType: application/json openAPIDocKey: '200' - mutate_deployed_model: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:mutateDeployedModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/get response: mediaType: application/json openAPIDocKey: '200' - direct_raw_predict: + objectKey: $.notebookExecutionJobs + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/get + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/delete + feature_groups: + id: google.aiplatform.feature_groups + name: feature_groups + title: Feature_groups + methods: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post response: mediaType: application/json openAPIDocKey: '200' - count_tokens: + list: operation: - $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:countTokens/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get response: mediaType: application/json openAPIDocKey: '200' - explain: + objectKey: $.featureGroups + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:explain/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - stream_generate_content: + patch: operation: - $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:streamGenerateContent/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' + operations_wait: + id: google.aiplatform.operations_wait + name: operations_wait + title: Operations_wait + methods: + list_wait: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1operations~1{operationsId}:wait/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.endpoints - raw_predict: + objectKey: $.operations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' + insert: [] + update: [] + replace: [] + delete: [] + features: + id: google.aiplatform.features + name: features + title: Features + methods: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:rawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features~1{featuresId}/delete response: mediaType: application/json openAPIDocKey: '200' - predict: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features~1{featuresId}/get response: mediaType: application/json openAPIDocKey: '200' - undeploy_model: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:undeployModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features~1{featuresId}/patch response: mediaType: application/json openAPIDocKey: '200' - compute_tokens: + list: operation: - $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:computeTokens/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features/get response: mediaType: application/json openAPIDocKey: '200' - direct_predict: + objectKey: $.features + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features/post response: mediaType: application/json openAPIDocKey: '200' - generate_content: + batch_create: operation: - $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:generateContent/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' - - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' + - $ref: '#/components/x-stackQL-resources/features/methods/get' + - $ref: '#/components/x-stackQL-resources/features/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' + - $ref: '#/components/x-stackQL-resources/features/methods/batch_create' + - $ref: '#/components/x-stackQL-resources/features/methods/create' update: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' + - $ref: '#/components/x-stackQL-resources/features/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' - hyperparameter_tuning_jobs: - id: google.aiplatform.hyperparameter_tuning_jobs - name: hyperparameter_tuning_jobs - title: Hyperparameter_tuning_jobs + - $ref: '#/components/x-stackQL-resources/features/methods/delete' + model_deployment_monitoring_jobs: + id: google.aiplatform.model_deployment_monitoring_jobs + name: model_deployment_monitoring_jobs + title: Model_deployment_monitoring_jobs methods: - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.hyperparameterTuningJobs delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + pause: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:pause/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/get - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/delete - notebook_execution_jobs: - id: google.aiplatform.notebook_execution_jobs - name: notebook_execution_jobs - title: Notebook_execution_jobs - methods: + objectKey: $.modelDeploymentMonitoringJobs create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notebookExecutionJobs - delete: + resume: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:resume/post response: mediaType: application/json openAPIDocKey: '200' - get: + search_model_deployment_monitoring_stats_anomalies: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/notebook_execution_jobs/methods/get + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/get - $ref: >- - #/components/x-stackQL-resources/notebook_execution_jobs/methods/list + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/notebook_execution_jobs/methods/create - update: [] + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/notebook_execution_jobs/methods/delete - notebook_runtime_templates_iam_policies: - id: google.aiplatform.notebook_runtime_templates_iam_policies - name: notebook_runtime_templates_iam_policies - title: Notebook_runtime_templates_iam_policies + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/delete + feature_views_iam_policies: + id: google.aiplatform.feature_views_iam_policies + name: feature_views_iam_policies + title: Feature_views_iam_policies methods: get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' @@ -25667,708 +25897,743 @@ components: test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/feature_views_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/feature_views_iam_policies/methods/set_iam_policy delete: [] - notebook_runtime_templates: - id: google.aiplatform.notebook_runtime_templates - name: notebook_runtime_templates - title: Notebook_runtime_templates + feature_views: + id: google.aiplatform.feature_views + name: feature_views + title: Feature_views methods: delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notebookRuntimeTemplates - create: + search_nearest_entities: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:searchNearestEntities/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/get - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/create - update: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/delete - schedules: - id: google.aiplatform.schedules - name: schedules - title: Schedules - methods: create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.schedules - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.featureViews + sync: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:sync/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/patch' + replace: [] delete: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/delete' + feature_views_feature_values: + id: google.aiplatform.feature_views_feature_values + name: feature_views_feature_values + title: Feature_views_feature_values + methods: + fetch_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - pause: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_views_feature_values/methods/fetch_feature_values + insert: [] + update: [] + replace: [] + delete: [] + feature_view_syncs: + id: google.aiplatform.feature_view_syncs + name: feature_view_syncs + title: Feature_view_syncs + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:pause/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs/get response: mediaType: application/json openAPIDocKey: '200' - resume: + objectKey: $.featureViewSyncs + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:resume/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs~1{featureViewSyncsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/schedules/methods/get' - - $ref: '#/components/x-stackQL-resources/schedules/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/schedules/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/schedules/methods/patch' + - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/list' + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' - custom_jobs: - id: google.aiplatform.custom_jobs - name: custom_jobs - title: Custom_jobs + delete: [] + feature_online_stores: + id: google.aiplatform.feature_online_stores + name: feature_online_stores + title: Feature_online_stores methods: - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customJobs - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/get response: mediaType: application/json openAPIDocKey: '200' - cancel: + objectKey: $.featureOnlineStores + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/feature_online_stores/methods/get' + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/list insert: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/create' - update: [] + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/delete' - tuning_jobs: - id: google.aiplatform.tuning_jobs - name: tuning_jobs - title: Tuning_jobs + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/delete + feature_online_stores_iam_policies: + id: google.aiplatform.feature_online_stores_iam_policies + name: feature_online_stores_iam_policies + title: Feature_online_stores_iam_policies methods: - cancel: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.bindings + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tuningJobs - create: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/set_iam_policy + delete: [] + batch_prediction_jobs: + id: google.aiplatform.batch_prediction_jobs + name: batch_prediction_jobs + title: Batch_prediction_jobs + methods: + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/create' - update: [] - replace: [] - delete: [] - saved_queries: - id: google.aiplatform.saved_queries - name: saved_queries - title: Saved_queries - methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.savedQueries - delete: + objectKey: $.batchPredictionJobs + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries~1{savedQueriesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' - insert: [] + - $ref: '#/components/x-stackQL-resources/batch_prediction_jobs/methods/get' + - $ref: >- + #/components/x-stackQL-resources/batch_prediction_jobs/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/batch_prediction_jobs/methods/create update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' - annotations: - id: google.aiplatform.annotations - name: annotations - title: Annotations + - $ref: >- + #/components/x-stackQL-resources/batch_prediction_jobs/methods/delete + entity_types: + id: google.aiplatform.entity_types + name: entity_types + title: Entity_types methods: - list: + import_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems~1{dataItemsId}~1annotations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:importFeatureValues/post + response: + mediaType: application/json + openAPIDocKey: '200' + streaming_read_feature_values: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:streamingReadFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.annotations - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/annotations/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - data_items: - id: google.aiplatform.data_items - name: data_items - title: Data_items - methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataItems - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/data_items/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - annotation_specs: - id: google.aiplatform.annotation_specs - name: annotation_specs - title: Annotation_specs - methods: - get: + objectKey: $.entityTypes + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1annotationSpecs~1{annotationSpecsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/annotation_specs/methods/get' - insert: [] - update: [] - replace: [] - delete: [] - dataset_versions: - id: google.aiplatform.dataset_versions - name: dataset_versions - title: Dataset_versions - methods: - delete: + export_feature_values: operation: $ref: >- - #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:exportFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/get response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.datasetVersions - create: + read_feature_values: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:readFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - restore: + write_feature_values: operation: $ref: >- - #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}:restore/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:writeFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/get' - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/list' + - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' + - $ref: '#/components/x-stackQL-resources/entity_types/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/create' + - $ref: '#/components/x-stackQL-resources/entity_types/methods/create' update: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/patch' + - $ref: '#/components/x-stackQL-resources/entity_types/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/delete' - datasets: - id: google.aiplatform.datasets - name: datasets - title: Datasets + - $ref: '#/components/x-stackQL-resources/entity_types/methods/delete' + entity_types_iam_policies: + id: google.aiplatform.entity_types_iam_policies + name: entity_types_iam_policies + title: Entity_types_iam_policies methods: - create: + get_iam_policy: operation: - $ref: '#/paths/~1v1~1datasets/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.bindings + test_iam_permissions: operation: - $ref: '#/paths/~1v1~1datasets/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.datasets - get: + set_iam_policy: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entity_types_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entity_types_iam_policies/methods/set_iam_policy + delete: [] + entity_types_feature_values: + id: google.aiplatform.entity_types_feature_values + name: entity_types_feature_values + title: Entity_types_feature_values + methods: + delete_feature_values: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}/delete' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/entity_types_feature_values/methods/delete_feature_values + featurestores: + id: google.aiplatform.featurestores + name: featurestores + title: Featurestores + methods: patch: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}/patch' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/patch response: mediaType: application/json openAPIDocKey: '200' - export: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - search_data_items: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:searchDataItems/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/get response: mediaType: application/json openAPIDocKey: '200' - import: + batch_read_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:batchReadFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/datasets/methods/get' - - $ref: '#/components/x-stackQL-resources/datasets/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/datasets/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' - runs: - id: google.aiplatform.runs - name: runs - title: Runs - methods: - batch_create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.featurestores + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/post response: mediaType: application/json openAPIDocKey: '200' - delete: + search_features: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores:searchFeatures/get response: mediaType: application/json openAPIDocKey: '200' - patch: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/get' + - $ref: '#/components/x-stackQL-resources/featurestores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/delete' + featurestores_iam_policies: + id: google.aiplatform.featurestores_iam_policies + name: featurestores_iam_policies + title: Featurestores_iam_policies + methods: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - write: + objectKey: $.bindings + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}:write/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - list: + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboardRuns - create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/featurestores_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/featurestores_iam_policies/methods/set_iam_policy + delete: [] + trials_trial_measurement: + id: google.aiplatform.trials_trial_measurement + name: trials_trial_measurement + title: Trials_trial_measurement + methods: + add_trial_measurement: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/runs/methods/get' - - $ref: '#/components/x-stackQL-resources/runs/methods/list' + select: [] insert: - - $ref: '#/components/x-stackQL-resources/runs/methods/batch_create' - - $ref: '#/components/x-stackQL-resources/runs/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/runs/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/trials_trial_measurement/methods/add_trial_measurement + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/runs/methods/delete' - time_series: - id: google.aiplatform.time_series - name: time_series - title: Time_series + delete: [] + trials: + id: google.aiplatform.trials + name: trials + title: Trials methods: - read: + complete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:read/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:complete/post response: mediaType: application/json openAPIDocKey: '200' - get: + suggest: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:suggest/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.trials + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/post response: mediaType: application/json openAPIDocKey: '200' - list: + stop: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:stop/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboardTimeSeries - create: + check_trial_early_stopping_state: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:checkTrialEarlyStoppingState/post response: mediaType: application/json openAPIDocKey: '200' - read_blob_data: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:readBlobData/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/delete response: mediaType: application/json openAPIDocKey: '200' - export_tensorboard_time_series: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:exportTensorboardTimeSeries/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/time_series/methods/get' - - $ref: '#/components/x-stackQL-resources/time_series/methods/list' + - $ref: '#/components/x-stackQL-resources/trials/methods/get' + - $ref: '#/components/x-stackQL-resources/trials/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/time_series/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/time_series/methods/patch' + - $ref: '#/components/x-stackQL-resources/trials/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/time_series/methods/delete' - experiments: - id: google.aiplatform.experiments - name: experiments - title: Experiments + - $ref: '#/components/x-stackQL-resources/trials/methods/delete' + trials_optimal_trials: + id: google.aiplatform.trials_optimal_trials + name: trials_optimal_trials + title: Trials_optimal_trials methods: - patch: + list_optimal_trials: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:listOptimalTrials/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/trials_optimal_trials/methods/list_optimal_trials + insert: [] + update: [] + replace: [] + delete: [] + studies: + id: google.aiplatform.studies + name: studies + title: Studies + methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/delete response: mediaType: application/json openAPIDocKey: '200' - batch_create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.studies create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboardExperiments - write: + lookup: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:write/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies:lookup/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/experiments/methods/get' - - $ref: '#/components/x-stackQL-resources/experiments/methods/list' + - $ref: '#/components/x-stackQL-resources/studies/methods/get' + - $ref: '#/components/x-stackQL-resources/studies/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/experiments/methods/batch_create' - - $ref: '#/components/x-stackQL-resources/experiments/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/experiments/methods/patch' + - $ref: '#/components/x-stackQL-resources/studies/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/experiments/methods/delete' + - $ref: '#/components/x-stackQL-resources/studies/methods/delete' tensorboards: id: google.aiplatform.tensorboards name: tensorboards title: Tensorboards methods: - patch: + read_size: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readSize/get response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.tensorboards + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboards - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/patch response: mediaType: application/json openAPIDocKey: '200' - batch_read: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:batchRead/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -26379,10 +26644,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - read_size: + batch_read: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readSize/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:batchRead/get response: mediaType: application/json openAPIDocKey: '200' @@ -26397,804 +26662,734 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/tensorboards/methods/delete' - batch_prediction_jobs: - id: google.aiplatform.batch_prediction_jobs - name: batch_prediction_jobs - title: Batch_prediction_jobs + time_series: + id: google.aiplatform.time_series + name: time_series + title: Time_series methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.batchPredictionJobs + objectKey: $.tensorboardTimeSeries create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + read_blob_data: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:readBlobData/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/batch_prediction_jobs/methods/get' - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/delete - training_pipelines: - id: google.aiplatform.training_pipelines - name: training_pipelines - title: Training_pipelines - methods: - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.trainingPipelines - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + read: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:read/get response: mediaType: application/json openAPIDocKey: '200' - cancel: + export_tensorboard_time_series: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:exportTensorboardTimeSeries/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/get' - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/list' + - $ref: '#/components/x-stackQL-resources/time_series/methods/get' + - $ref: '#/components/x-stackQL-resources/time_series/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/time_series/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/time_series/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/delete' - indexes: - id: google.aiplatform.indexes - name: indexes - title: Indexes + - $ref: '#/components/x-stackQL-resources/time_series/methods/delete' + runs: + id: google.aiplatform.runs + name: runs + title: Runs methods: - upsert_datapoints: + write: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:upsertDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}:write/post response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + batch_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.indexes + objectKey: $.tensorboardRuns sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/indexes/methods/get' - - $ref: '#/components/x-stackQL-resources/indexes/methods/list' + - $ref: '#/components/x-stackQL-resources/runs/methods/get' + - $ref: '#/components/x-stackQL-resources/runs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/indexes/methods/create' + - $ref: '#/components/x-stackQL-resources/runs/methods/batch_create' + - $ref: '#/components/x-stackQL-resources/runs/methods/create' update: - - $ref: '#/components/x-stackQL-resources/indexes/methods/patch' + - $ref: '#/components/x-stackQL-resources/runs/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' - indexes_datapoints: - id: google.aiplatform.indexes_datapoints - name: indexes_datapoints - title: Indexes_datapoints + - $ref: '#/components/x-stackQL-resources/runs/methods/delete' + experiments: + id: google.aiplatform.experiments + name: experiments + title: Experiments methods: - remove_datapoints: + write: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:write/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/indexes_datapoints/methods/remove_datapoints - notebook_runtimes: - id: google.aiplatform.notebook_runtimes - name: notebook_runtimes - title: Notebook_runtimes - methods: - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notebookRuntimes - upgrade: + batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:upgrade/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' - start: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:start/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/post response: mediaType: application/json openAPIDocKey: '200' - assign: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes:assign/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.tensorboardExperiments sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/get' - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/list' - insert: [] - update: [] + - $ref: '#/components/x-stackQL-resources/experiments/methods/get' + - $ref: '#/components/x-stackQL-resources/experiments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/experiments/methods/batch_create' + - $ref: '#/components/x-stackQL-resources/experiments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/experiments/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/delete' - featurestores_iam_policies: - id: google.aiplatform.featurestores_iam_policies - name: featurestores_iam_policies - title: Featurestores_iam_policies + - $ref: '#/components/x-stackQL-resources/experiments/methods/delete' + tuning_jobs: + id: google.aiplatform.tuning_jobs + name: tuning_jobs + title: Tuning_jobs methods: - set_iam_policy: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - get_iam_policy: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/featurestores_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/featurestores_iam_policies/methods/set_iam_policy - delete: [] - featurestores: - id: google.aiplatform.featurestores - name: featurestores - title: Featurestores - methods: - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.tuningJobs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/create' + update: [] + replace: [] + delete: [] + notebook_runtimes: + id: google.aiplatform.notebook_runtimes + name: notebook_runtimes + title: Notebook_runtimes + methods: + assign: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes:assign/post response: mediaType: application/json openAPIDocKey: '200' - patch: + start: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:start/post response: mediaType: application/json openAPIDocKey: '200' - batch_read_feature_values: + upgrade: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:batchReadFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:upgrade/post response: mediaType: application/json openAPIDocKey: '200' - search_features: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores:searchFeatures/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes/get response: mediaType: application/json openAPIDocKey: '200' - create: + objectKey: $.notebookRuntimes + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featurestores sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/get' - - $ref: '#/components/x-stackQL-resources/featurestores/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/patch' + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/get' + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/list' + insert: [] + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/delete' - entity_types: - id: google.aiplatform.entity_types - name: entity_types - title: Entity_types + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/delete' + persistent_resources: + id: google.aiplatform.persistent_resources + name: persistent_resources + title: Persistent_resources methods: - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.entityTypes - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/get response: mediaType: application/json openAPIDocKey: '200' - read_feature_values: + reboot: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:readFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}:reboot/post response: mediaType: application/json openAPIDocKey: '200' - import_feature_values: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:importFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/post response: mediaType: application/json openAPIDocKey: '200' - streaming_read_feature_values: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:streamingReadFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/get response: mediaType: application/json openAPIDocKey: '200' - write_feature_values: + objectKey: $.persistentResources + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/get' + - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/delete + migratable_resources: + id: google.aiplatform.migratable_resources + name: migratable_resources + title: Migratable_resources + methods: + batch_migrate: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:writeFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:batchMigrate/post response: mediaType: application/json openAPIDocKey: '200' - export_feature_values: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:exportFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:search/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' - - $ref: '#/components/x-stackQL-resources/entity_types/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/patch' + select: [] + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/delete' - entity_types_iam_policies: - id: google.aiplatform.entity_types_iam_policies - name: entity_types_iam_policies - title: Entity_types_iam_policies + delete: [] + notebook_runtime_templates_iam_policies: + id: google.aiplatform.notebook_runtime_templates_iam_policies + name: notebook_runtime_templates_iam_policies + title: Notebook_runtime_templates_iam_policies methods: - test_iam_permissions: + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - get_iam_policy: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.bindings sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entity_types_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/entity_types_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/set_iam_policy delete: [] - entity_types_feature_values: - id: google.aiplatform.entity_types_feature_values - name: entity_types_feature_values - title: Entity_types_feature_values + notebook_runtime_templates: + id: google.aiplatform.notebook_runtime_templates + name: notebook_runtime_templates + title: Notebook_runtime_templates methods: - delete_feature_values: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/entity_types_feature_values/methods/delete_feature_values - features: - id: google.aiplatform.features - name: features - title: Features - methods: + objectKey: $.notebookRuntimeTemplates create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.features - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - batch_create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/features/methods/get' - - $ref: '#/components/x-stackQL-resources/features/methods/list' + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/get + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/list insert: - - $ref: '#/components/x-stackQL-resources/features/methods/create' - - $ref: '#/components/x-stackQL-resources/features/methods/batch_create' + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/create update: - - $ref: '#/components/x-stackQL-resources/features/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/features/methods/delete' - studies: - id: google.aiplatform.studies - name: studies - title: Studies + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/delete + index_endpoints: + id: google.aiplatform.index_endpoints + name: index_endpoints + title: Index_endpoints methods: - list: + undeploy_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:undeployIndex/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.studies - create: + deploy_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:deployIndex/post response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/get response: mediaType: application/json openAPIDocKey: '200' - lookup: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies:lookup/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/studies/methods/get' - - $ref: '#/components/x-stackQL-resources/studies/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/studies/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/studies/methods/delete' - trials: - id: google.aiplatform.trials - name: trials - title: Trials - methods: - stop: + read_index_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:stop/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:readIndexDatapoints/post response: mediaType: application/json openAPIDocKey: '200' - suggest: + mutate_deployed_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:suggest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:mutateDeployedIndex/post response: mediaType: application/json openAPIDocKey: '200' - delete: + find_neighbors: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:findNeighbors/post response: mediaType: application/json openAPIDocKey: '200' - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.trials - create: + objectKey: $.indexEndpoints + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/delete' + data_labeling_jobs: + id: google.aiplatform.data_labeling_jobs + name: data_labeling_jobs + title: Data_labeling_jobs + methods: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - complete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:complete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - check_trial_early_stopping_state: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:checkTrialEarlyStoppingState/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/trials/methods/get' - - $ref: '#/components/x-stackQL-resources/trials/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/trials/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/trials/methods/delete' - trials_optimal_trials: - id: google.aiplatform.trials_optimal_trials - name: trials_optimal_trials - title: Trials_optimal_trials - methods: - list_optimal_trials: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:listOptimalTrials/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/trials_optimal_trials/methods/list_optimal_trials - insert: [] - update: [] - replace: [] - delete: [] - trials_trial_measurement: - id: google.aiplatform.trials_trial_measurement - name: trials_trial_measurement - title: Trials_trial_measurement - methods: - add_trial_measurement: + objectKey: $.dataLabelingJobs + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/trials_trial_measurement/methods/add_trial_measurement + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/create' update: [] replace: [] - delete: [] - index_endpoints: - id: google.aiplatform.index_endpoints - name: index_endpoints - title: Index_endpoints + delete: + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/delete' + custom_jobs: + id: google.aiplatform.custom_jobs + name: custom_jobs + title: Custom_jobs methods: - find_neighbors: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:findNeighbors/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/post response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.customJobs + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.indexEndpoints - mutate_deployed_index: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:mutateDeployedIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - read_index_datapoints: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:readIndexDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - undeploy_index: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/delete' + training_pipelines: + id: google.aiplatform.training_pipelines + name: training_pipelines + title: Training_pipelines + methods: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:undeployIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/post response: mediaType: application/json openAPIDocKey: '200' - deploy_index: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:deployIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.trainingPipelines + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/get' - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/list' + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/get' + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/patch' + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/delete' + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/delete' deployment_resource_pools: id: google.aiplatform.deployment_resource_pools name: deployment_resource_pools @@ -27215,10 +27410,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + query_deployed_models: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}:queryDeployedModels/get response: mediaType: application/json openAPIDocKey: '200' @@ -27236,19 +27431,19 @@ components: response: mediaType: application/json openAPIDocKey: '200' - query_deployed_models: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}:queryDeployedModels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/get - $ref: >- #/components/x-stackQL-resources/deployment_resource_pools/methods/query_deployed_models + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/get - $ref: >- #/components/x-stackQL-resources/deployment_resource_pools/methods/list insert: @@ -27261,953 +27456,821 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/deployment_resource_pools/methods/delete - nas_trial_details: - id: google.aiplatform.nas_trial_details - name: nas_trial_details - title: Nas_trial_details + indexes: + id: google.aiplatform.indexes + name: indexes + title: Indexes methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails~1{nasTrialDetailsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - list: + upsert_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:upsertDatapoints/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nasTrialDetails - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/get' - - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - nas_jobs: - id: google.aiplatform.nas_jobs - name: nas_jobs - title: Nas_jobs - methods: - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nasJobs - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/get response: mediaType: application/json openAPIDocKey: '200' - cancel: + objectKey: $.indexes + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/indexes/methods/get' + - $ref: '#/components/x-stackQL-resources/indexes/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/indexes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/indexes/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/delete' - data_labeling_jobs: - id: google.aiplatform.data_labeling_jobs - name: data_labeling_jobs - title: Data_labeling_jobs + - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' + indexes_datapoints: + id: google.aiplatform.indexes_datapoints + name: indexes_datapoints + title: Indexes_datapoints methods: - cancel: + remove_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/indexes_datapoints/methods/remove_datapoints + metadata_stores: + id: google.aiplatform.metadata_stores + name: metadata_stores + title: Metadata_stores + methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataLabelingJobs + objectKey: $.metadataStores create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/create' + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/create' update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/delete' - model_deployment_monitoring_jobs: - id: google.aiplatform.model_deployment_monitoring_jobs - name: model_deployment_monitoring_jobs - title: Model_deployment_monitoring_jobs + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/delete' + artifacts: + id: google.aiplatform.artifacts + name: artifacts + title: Artifacts methods: - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelDeploymentMonitoringJobs - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts:purge/post response: mediaType: application/json openAPIDocKey: '200' - resume: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:resume/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/post response: mediaType: application/json openAPIDocKey: '200' - search_model_deployment_monitoring_stats_anomalies: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/get response: mediaType: application/json openAPIDocKey: '200' - pause: + objectKey: $.artifacts + query_artifact_lineage_subgraph: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:pause/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}:queryArtifactLineageSubgraph/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/artifacts/methods/get' - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/get - - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/list + #/components/x-stackQL-resources/artifacts/methods/query_artifact_lineage_subgraph + - $ref: '#/components/x-stackQL-resources/artifacts/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/create + - $ref: '#/components/x-stackQL-resources/artifacts/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/patch + - $ref: '#/components/x-stackQL-resources/artifacts/methods/patch' replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/delete - evaluations: - id: google.aiplatform.evaluations - name: evaluations - title: Evaluations + - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' + metadata_schemas: + id: google.aiplatform.metadata_schemas + name: metadata_schemas + title: Metadata_schemas methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - import: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations:import/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelEvaluations - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' - - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - slices: - id: google.aiplatform.slices - name: slices - title: Slices - methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.modelEvaluationSlices - batch_import: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}:batchImport/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.metadataSchemas get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/slices/methods/get' - - $ref: '#/components/x-stackQL-resources/slices/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - models_versions: - id: google.aiplatform.models_versions - name: models_versions - title: Models_versions - methods: - list_versions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listVersions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas~1{metadataSchemasId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.models sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/models_versions/methods/list_versions - insert: [] + - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/create' update: [] replace: [] delete: [] - models_iam_policies: - id: google.aiplatform.models_iam_policies - name: models_iam_policies - title: Models_iam_policies + contexts: + id: google.aiplatform.contexts + name: contexts + title: Contexts methods: - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:getIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - test_iam_permissions: + query_context_lineage_subgraph: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:queryContextLineageSubgraph/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/models_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/models_iam_policies/methods/set_iam_policy - delete: [] - models_version: - id: google.aiplatform.models_version - name: models_version - title: Models_version - methods: - delete_version: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:deleteVersion/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/models_version/methods/delete_version - models_explanation_dataset: - id: google.aiplatform.models_explanation_dataset - name: models_explanation_dataset - title: Models_explanation_dataset - methods: - update_explanation_dataset: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/models_explanation_dataset/methods/update_explanation_dataset - replace: [] - delete: [] - specialist_pools: - id: google.aiplatform.specialist_pools - name: specialist_pools - title: Specialist_pools - methods: - get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.contexts + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.specialistPools - create: + purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts:purge/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/get' - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/list' + - $ref: >- + #/components/x-stackQL-resources/contexts/methods/query_context_lineage_subgraph + - $ref: '#/components/x-stackQL-resources/contexts/methods/get' + - $ref: '#/components/x-stackQL-resources/contexts/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/create' + - $ref: '#/components/x-stackQL-resources/contexts/methods/create' update: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/patch' + - $ref: '#/components/x-stackQL-resources/contexts/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/delete' - pipeline_jobs: - id: google.aiplatform.pipeline_jobs - name: pipeline_jobs - title: Pipeline_jobs + - $ref: '#/components/x-stackQL-resources/contexts/methods/delete' + contexts_context_artifacts_and_executions: + id: google.aiplatform.contexts_context_artifacts_and_executions + name: contexts_context_artifacts_and_executions + title: Contexts_context_artifacts_and_executions methods: - batch_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchDelete/post - response: - mediaType: application/json - openAPIDocKey: '200' - delete: + add_context_artifacts_and_executions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextArtifactsAndExecutions/post response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/contexts_context_artifacts_and_executions/methods/add_context_artifacts_and_executions + update: [] + replace: [] + delete: [] + contexts_context_children: + id: google.aiplatform.contexts_context_children + name: contexts_context_children + title: Contexts_context_children + methods: + remove_context_children: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:removeContextChildren/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + add_context_children: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post response: mediaType: application/json openAPIDocKey: '200' - batch_cancel: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/contexts_context_children/methods/add_context_children + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/contexts_context_children/methods/remove_context_children + executions: + id: google.aiplatform.executions + name: executions + title: Executions + methods: + query_execution_inputs_and_outputs: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchCancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get response: mediaType: application/json openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.pipelineJobs - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' - - $ref: >- - #/components/x-stackQL-resources/pipeline_jobs/methods/batch_delete - feature_groups: - id: google.aiplatform.feature_groups - name: feature_groups - title: Feature_groups - methods: + objectKey: $.executions patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions:purge/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureGroups sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' + - $ref: >- + #/components/x-stackQL-resources/executions/methods/query_execution_inputs_and_outputs + - $ref: '#/components/x-stackQL-resources/executions/methods/get' + - $ref: '#/components/x-stackQL-resources/executions/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' + - $ref: '#/components/x-stackQL-resources/executions/methods/create' update: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' + - $ref: '#/components/x-stackQL-resources/executions/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' - metadata_schemas: - id: google.aiplatform.metadata_schemas - name: metadata_schemas - title: Metadata_schemas + - $ref: '#/components/x-stackQL-resources/executions/methods/delete' + executions_execution_events: + id: google.aiplatform.executions_execution_events + name: executions_execution_events + title: Executions_execution_events methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.metadataSchemas - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: + add_execution_events: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas~1{metadataSchemasId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:addExecutionEvents/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/get' - - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/list' + select: [] insert: - - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/create' + - $ref: >- + #/components/x-stackQL-resources/executions_execution_events/methods/add_execution_events update: [] replace: [] delete: [] - artifacts: - id: google.aiplatform.artifacts - name: artifacts - title: Artifacts + pipeline_jobs: + id: google.aiplatform.pipeline_jobs + name: pipeline_jobs + title: Pipeline_jobs methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - purge: + batch_cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchCancel/post response: mediaType: application/json openAPIDocKey: '200' - query_artifact_lineage_subgraph: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}:queryArtifactLineageSubgraph/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.pipelineJobs + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.artifacts - create: + batch_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchDelete/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/get' - - $ref: >- - #/components/x-stackQL-resources/artifacts/methods/query_artifact_lineage_subgraph - - $ref: '#/components/x-stackQL-resources/artifacts/methods/list' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/patch' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' - contexts: - id: google.aiplatform.contexts - name: contexts - title: Contexts + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/pipeline_jobs/methods/batch_delete + nas_jobs: + id: google.aiplatform.nas_jobs + name: nas_jobs + title: Nas_jobs methods: - delete: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.nasJobs + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contexts - purge: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/delete' + nas_trial_details: + id: google.aiplatform.nas_trial_details + name: nas_trial_details + title: Nas_trial_details + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails/get response: mediaType: application/json openAPIDocKey: '200' - query_context_lineage_subgraph: + objectKey: $.nasTrialDetails + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:queryContextLineageSubgraph/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails~1{nasTrialDetailsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/contexts/methods/get' - - $ref: >- - #/components/x-stackQL-resources/contexts/methods/query_context_lineage_subgraph - - $ref: '#/components/x-stackQL-resources/contexts/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/contexts/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/contexts/methods/patch' + - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/get' + - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/list' + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/contexts/methods/delete' - contexts_context_children: - id: google.aiplatform.contexts_context_children - name: contexts_context_children - title: Contexts_context_children + delete: [] + models_iam_policies: + id: google.aiplatform.models_iam_policies + name: models_iam_policies + title: Models_iam_policies methods: - add_context_children: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - remove_context_children: + objectKey: $.bindings + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:removeContextChildren/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/contexts_context_children/methods/add_context_children + #/components/x-stackQL-resources/models_iam_policies/methods/get_iam_policy + insert: [] update: [] - replace: [] - delete: + replace: - $ref: >- - #/components/x-stackQL-resources/contexts_context_children/methods/remove_context_children - contexts_context_artifacts_and_executions: - id: google.aiplatform.contexts_context_artifacts_and_executions - name: contexts_context_artifacts_and_executions - title: Contexts_context_artifacts_and_executions + #/components/x-stackQL-resources/models_iam_policies/methods/set_iam_policy + delete: [] + models_versions: + id: google.aiplatform.models_versions + name: models_versions + title: Models_versions methods: - add_context_artifacts_and_executions: + list_versions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextArtifactsAndExecutions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listVersions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.models sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/contexts_context_artifacts_and_executions/methods/add_context_artifacts_and_executions + #/components/x-stackQL-resources/models_versions/methods/list_versions + insert: [] update: [] replace: [] delete: [] - executions_execution_events: - id: google.aiplatform.executions_execution_events - name: executions_execution_events - title: Executions_execution_events + models_explanation_dataset: + id: google.aiplatform.models_explanation_dataset + name: models_explanation_dataset + title: Models_explanation_dataset methods: - add_execution_events: + update_explanation_dataset: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:addExecutionEvents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] - insert: + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/executions_execution_events/methods/add_execution_events - update: [] + #/components/x-stackQL-resources/models_explanation_dataset/methods/update_explanation_dataset replace: [] delete: [] - executions: - id: google.aiplatform.executions - name: executions - title: Executions + models_version: + id: google.aiplatform.models_version + name: models_version + title: Models_version methods: - query_execution_inputs_and_outputs: + delete_version: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:deleteVersion/delete response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/models_version/methods/delete_version + slices: + id: google.aiplatform.slices + name: slices + title: Slices + methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions - create: + objectKey: $.modelEvaluationSlices + batch_import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}:batchImport/post response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}/get response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/slices/methods/get' + - $ref: '#/components/x-stackQL-resources/slices/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + evaluations: + id: google.aiplatform.evaluations + name: evaluations + title: Evaluations + methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations:import/post response: mediaType: application/json openAPIDocKey: '200' - purge: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.modelEvaluations sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/executions/methods/query_execution_inputs_and_outputs - - $ref: '#/components/x-stackQL-resources/executions/methods/get' - - $ref: '#/components/x-stackQL-resources/executions/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/executions/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/executions/methods/patch' + - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' + - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/executions/methods/delete' - metadata_stores: - id: google.aiplatform.metadata_stores - name: metadata_stores - title: Metadata_stores + delete: [] + hyperparameter_tuning_jobs: + id: google.aiplatform.hyperparameter_tuning_jobs + name: hyperparameter_tuning_jobs + title: Hyperparameter_tuning_jobs methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.metadataStores - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/get' - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/delete' - locations: - id: google.aiplatform.locations - name: locations - title: Locations - methods: - evaluate_instances: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:evaluateInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.hyperparameterTuningJobs + create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/get' - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - insert: [] + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/get + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/create update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/delete paths: /v1/publishers/{publishersId}/models/{modelsId}:countTokens: parameters: &ref_1 + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' post: description: Perform a token counting. operationId: aiplatform.publishers.models.countTokens @@ -28240,21 +28303,26 @@ paths: required: true schema: type: string - /v1/publishers/{publishersId}/models/{modelsId}:computeTokens: + /v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: parameters: *ref_1 post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.publishers.models.computeTokens + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.publishers.models.streamGenerateContent requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -28262,7 +28330,35 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/publishers/{publishersId}/models/{modelsId}: + parameters: *ref_1 + get: + description: Gets a Model Garden publisher model. + operationId: aiplatform.publishers.models.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PublisherModel' parameters: - in: path name: publishersId @@ -28274,6 +28370,22 @@ paths: required: true schema: type: string + - in: query + name: huggingFaceToken + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: isHuggingFaceModel + schema: + type: boolean /v1/publishers/{publishersId}/models/{modelsId}:generateContent: parameters: *ref_1 post: @@ -28313,26 +28425,180 @@ paths: required: true schema: type: string - /v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: + /v1/publishers/{publishersId}/models/{modelsId}:computeTokens: parameters: *ref_1 post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.publishers.models.streamGenerateContent + description: Return a list of tokens based on the input text. + operationId: aiplatform.publishers.models.computeTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances: + parameters: *ref_1 + post: + description: Evaluates instances based on a given metric. + operationId: aiplatform.projects.locations.evaluateInstances requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: aiplatform.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: aiplatform.projects.locations.list + security: - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/cloud-platform Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets: + parameters: *ref_1 + post: + description: Creates a Dataset. + operationId: aiplatform.projects.locations.datasets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + get: + description: Lists Datasets in a Location. + operationId: aiplatform.projects.locations.datasets.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform responses: '200': description: Successful response @@ -28340,23 +28606,45 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse parameters: - in: path - name: publishersId + name: projectsId required: true schema: type: string - in: path - name: modelsId + name: locationsId required: true schema: type: string - /v1/publishers/{publishersId}/models/{modelsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: parameters: *ref_1 get: - description: Gets a Model Garden publisher model. - operationId: aiplatform.publishers.models.get + description: Gets a Dataset. + operationId: aiplatform.projects.locations.datasets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28368,42 +28656,270 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PublisherModel' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path - name: publishersId + name: projectsId required: true schema: type: string - in: path - name: modelsId + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + patch: + description: Updates a Dataset. + operationId: aiplatform.projects.locations.datasets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Dataset. + operationId: aiplatform.projects.locations.datasets.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: + parameters: *ref_1 + post: + description: Imports data into a Dataset. + operationId: aiplatform.projects.locations.datasets.import + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: + parameters: *ref_1 + post: + description: Exports data from a Dataset. + operationId: aiplatform.projects.locations.datasets.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: + parameters: *ref_1 + get: + description: Searches DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.searchDataItems + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId required: true schema: - type: string + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: orderByAnnotation.orderBy + schema: + type: string + - in: query + name: dataItemFilter + schema: + type: string + - in: query + name: annotationsLimit + schema: + type: integer + format: int32 + - in: query + name: annotationFilters + schema: + type: string + - in: query + name: orderByDataItem + schema: + type: string + - in: query + name: savedQuery + schema: + type: string + - in: query + name: fieldMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query - name: view + name: annotationsFilter schema: type: string - in: query - name: languageCode + name: dataLabelingJob schema: type: string - in: query - name: isHuggingFaceModel + name: orderByAnnotation.savedQuery schema: - type: boolean + type: string - in: query - name: huggingFaceToken + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.migratableResources.operations.get + delete: + description: Deletes a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28428,22 +28944,18 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: datasetVersionsId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.migratableResources.operations.delete + get: + description: Gets a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28455,7 +28967,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -28468,22 +28980,28 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: datasetVersionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.migratableResources.operations.list + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + patch: + description: Updates a DatasetVersion. + operationId: aiplatform.projects.locations.datasets.datasetVersions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28495,7 +29013,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -28508,37 +29026,25 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: datasetsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: datasetVersionsId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.migratableResources.operations.wait + get: + description: Restores a dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.restore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28563,34 +29069,20 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: datasetVersionsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.migratableResources.operations.cancel + get: + description: Lists DatasetVersions in a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28602,7 +29094,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse parameters: - in: path name: projectsId @@ -28615,66 +29108,40 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: - parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.migratableResources.search - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse - parameters: - - in: path - name: projectsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask schema: type: string - - in: path - name: locationsId - required: true + format: google-fieldmask + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: - parameters: *ref_1 post: - description: >- - Batch migrates resources from ml.googleapis.com, automl.googleapis.com, - and datalabeling.googleapis.com to Vertex AI. - operationId: aiplatform.projects.locations.migratableResources.batchMigrate + description: Create a version from a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28698,13 +29165,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.listWait + 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`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28716,7 +29195,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -28729,28 +29208,22 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: annotationSpecsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -28762,7 +29235,7 @@ paths: 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. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28787,7 +29260,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId + required: true + schema: + type: string + - in: path + name: annotationSpecsId required: true schema: type: string @@ -28801,15 +29279,14 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: parameters: *ref_1 - delete: + get: 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`. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.delete + 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. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28821,7 +29298,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -28834,7 +29311,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId + required: true + schema: + type: string + - in: path + name: annotationSpecsId required: true schema: type: string @@ -28843,12 +29325,13 @@ paths: required: true schema: type: string - get: + delete: 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. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.get + 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`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28860,7 +29343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -28873,7 +29356,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId + required: true + schema: + type: string + - in: path + name: annotationSpecsId required: true schema: type: string @@ -28882,16 +29370,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: parameters: *ref_1 - post: - description: Creates a new FeatureView in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28903,7 +29388,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -28916,48 +29401,17 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: query - name: runSyncImmediately - schema: - type: boolean - - in: query - name: featureViewId - schema: - type: string - get: - description: Lists FeatureViews in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse - parameters: - - in: path - name: projectsId + name: datasetsId required: true schema: type: string - in: path - name: locationsId + name: annotationSpecsId required: true schema: type: string - - in: path - name: featureOnlineStoresId - required: true + - in: query + name: filter schema: type: string - in: query @@ -28965,26 +29419,15 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: parameters: *ref_1 - post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy + get: + description: Gets an AnnotationSpec. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28996,7 +29439,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' parameters: - in: path name: projectsId @@ -29009,35 +29452,28 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: annotationSpecsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: readMask schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: parameters: *ref_1 - post: + get: 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. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest + Lists Annotations belongs to a dataitem This RPC is only available in + InternalDatasetService. It is only used for exporting conversation data + to CCAI Insights. + operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29050,7 +29486,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse + #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse parameters: - in: path name: projectsId @@ -29063,56 +29499,47 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}: - parameters: *ref_1 - get: - description: Gets details of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - - in: path - name: featureOnlineStoresId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: featureViewsId - required: true + format: google-fieldmask + - in: query + name: filter schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: + parameters: *ref_1 delete: - description: Deletes a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.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`. + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29124,7 +29551,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29137,23 +29564,32 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - patch: - description: Updates the parameters of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + - in: path + name: annotationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + 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. + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29178,31 +29614,40 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: annotationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions: - parameters: *ref_1 - post: - 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. + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions + aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29214,7 +29659,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29227,31 +29672,38 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId + required: true + schema: + type: string + - in: path + name: annotationsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: permissions + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: parameters: *ref_1 - post: - description: Fetch feature values under a FeatureView. + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest + aiplatform.projects.locations.datasets.dataItems.annotations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29263,8 +29715,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -29277,26 +29728,48 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: + - in: path + name: annotationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Triggers on-demand sync for the FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest + 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`. + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29308,8 +29781,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29322,29 +29794,39 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy: + - in: path + name: annotationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + 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`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29356,7 +29838,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29369,21 +29851,29 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}: parameters: *ref_1 - get: - description: Gets details of a single FeatureViewSync. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.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`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29395,7 +29885,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29408,26 +29898,26 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - in: path - name: featureViewSyncsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: - parameters: *ref_1 get: - description: Lists FeatureViewSyncs in a given FeatureView. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list + 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. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29439,8 +29929,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29453,40 +29942,27 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait + operationId: aiplatform.projects.locations.datasets.dataItems.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29511,18 +29987,17 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - in: query @@ -29534,10 +30009,8 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -29549,8 +30022,7 @@ paths: 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. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait + operationId: aiplatform.projects.locations.datasets.dataItems.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29575,12 +30047,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string @@ -29594,16 +30066,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: parameters: *ref_1 - 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`. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete + get: + description: Lists DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.dataItems.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29615,7 +30082,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse parameters: - in: path name: projectsId @@ -29628,27 +30096,39 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: path - name: featureViewsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: operationsId - required: true + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: + parameters: *ref_1 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. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29660,7 +30140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -29673,25 +30153,37 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: path - name: featureViewsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: - description: Gets details of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.get + post: + 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`. + operationId: aiplatform.projects.locations.datasets.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29703,7 +30195,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29716,15 +30208,23 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - delete: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not - contain any FeatureViews. - operationId: aiplatform.projects.locations.featureOnlineStores.delete + 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. + operationId: aiplatform.projects.locations.datasets.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29749,22 +30249,22 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: query - name: force + - in: path + name: operationsId + required: true schema: - type: boolean - patch: - description: Updates the parameters of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + type: string + 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`. + operationId: aiplatform.projects.locations.datasets.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29776,7 +30276,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29789,25 +30289,29 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.featureOnlineStores.testIamPermissions + 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. + operationId: aiplatform.projects.locations.datasets.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29819,7 +30323,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29832,24 +30336,28 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: permissions + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Creates a new FeatureOnlineStore in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + 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. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29873,13 +30381,28 @@ paths: required: true schema: type: string - - in: query - name: featureOnlineStoreId + - in: path + name: datasetsId + required: true schema: type: string - get: - description: Lists FeatureOnlineStores in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.list + - in: path + name: savedQueriesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29891,8 +30414,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29904,30 +30426,35 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: datasetsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: savedQueriesId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featureOnlineStores.getIamPolicy + 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. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29939,7 +30466,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29952,28 +30479,32 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId + required: true + schema: + type: string + - in: path + name: savedQueriesId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: timeout schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featureOnlineStores.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29985,7 +30516,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -29998,18 +30529,42 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: + - in: path + name: savedQueriesId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.persistentResources.operations.get + 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`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30021,7 +30576,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30034,7 +30589,12 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: datasetsId + required: true + schema: + type: string + - in: path + name: savedQueriesId required: true schema: type: string @@ -30043,13 +30603,11 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: + parameters: *ref_1 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`. - operationId: aiplatform.projects.locations.persistentResources.operations.delete + description: Deletes a SavedQuery. + operationId: aiplatform.projects.locations.datasets.savedQueries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30061,7 +30619,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30074,29 +30632,20 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: savedQueriesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.persistentResources.operations.wait + get: + description: Lists SavedQueries in a Dataset. + operationId: aiplatform.projects.locations.datasets.savedQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30108,7 +30657,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse parameters: - in: path name: projectsId @@ -30121,46 +30671,60 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - in: query - name: timeout + name: readMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.persistentResources.operations.cancel + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.projects.locations.publishers.models.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -30173,34 +30737,41 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.persistentResources.operations.list + post: + description: Perform an online prediction. + operationId: aiplatform.projects.locations.publishers.models.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -30213,33 +30784,35 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: publishersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: modelsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: parameters: *ref_1 - get: - description: Lists PersistentResources in a Location. - operationId: aiplatform.projects.locations.persistentResources.list + post: + description: Generate content with multimodal inputs. + operationId: aiplatform.projects.locations.publishers.models.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -30247,7 +30820,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -30259,23 +30832,26 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: publishersId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: modelsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: + parameters: *ref_1 post: - description: Creates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.create + description: Return a list of tokens based on the input text. + operationId: aiplatform.projects.locations.publishers.models.computeTokens requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30287,7 +30863,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -30299,15 +30876,26 @@ paths: required: true schema: type: string - - in: query - name: persistentResourceId + - in: path + name: publishersId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: parameters: *ref_1 - delete: - description: Deletes a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.delete + post: + description: Perform a token counting. + operationId: aiplatform.projects.locations.publishers.models.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30319,7 +30907,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -30332,25 +30921,45 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: publishersId required: true schema: type: string - get: - description: Gets a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.get + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: + parameters: *ref_1 + post: + description: >- + Perform a server-side streaming online prediction request for Vertex LLM + streaming. + operationId: aiplatform.projects.locations.publishers.models.serverStreamingPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -30363,30 +30972,46 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: publishersId required: true schema: type: string - patch: - description: Updates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.patch + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: + parameters: *ref_1 + post: + description: >- + 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. + operationId: aiplatform.projects.locations.publishers.models.rawPredict requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -30399,38 +31024,42 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: publishersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: modelsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: parameters: *ref_1 post: - description: Reboots a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.reboot + description: Perform a streaming online prediction with an arbitrary HTTP payload. + operationId: aiplatform.projects.locations.publishers.models.streamRawPredict requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest + #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -30443,7 +31072,12 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId required: true schema: type: string @@ -30496,13 +31130,12 @@ paths: type: string /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: parameters: *ref_1 - delete: + get: 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`. - operationId: aiplatform.projects.locations.endpoints.operations.delete + 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. + operationId: aiplatform.projects.locations.endpoints.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30514,7 +31147,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30536,12 +31169,13 @@ paths: required: true schema: type: string - get: + delete: 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. - operationId: aiplatform.projects.locations.endpoints.operations.get + 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`. + operationId: aiplatform.projects.locations.endpoints.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30553,7 +31187,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30575,13 +31209,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.endpoints.operations.list + 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. + operationId: aiplatform.projects.locations.endpoints.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30593,7 +31234,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30610,33 +31251,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - in: query - name: filter + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.endpoints.operations.wait + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.endpoints.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30648,7 +31279,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -30665,27 +31296,30 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: timeout + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: parameters: *ref_1 post: - description: Perform a streaming online prediction with an arbitrary HTTP payload. - operationId: aiplatform.projects.locations.endpoints.streamRawPredict + description: Generate content with multimodal inputs. + operationId: aiplatform.projects.locations.endpoints.generateContent requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30701,7 +31335,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -30718,23 +31353,32 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: parameters: *ref_1 - get: - description: Gets an Endpoint. - operationId: aiplatform.projects.locations.endpoints.get + post: + description: Perform an online prediction. + operationId: aiplatform.projects.locations.endpoints.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -30751,9 +31395,11 @@ paths: required: true schema: type: string - patch: - description: Updates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.patch + /v1/projects/{projectsId}/locations/{locationsId}/endpoints: + parameters: *ref_1 + post: + description: Creates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.create requestBody: content: application/json: @@ -30770,7 +31416,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30782,19 +31428,13 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true - schema: - type: string - in: query - name: updateMask + name: endpointId schema: type: string - format: google-fieldmask - delete: - description: Deletes an Endpoint. - operationId: aiplatform.projects.locations.endpoints.delete + get: + description: Lists Endpoints in a Location. + operationId: aiplatform.projects.locations.endpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30806,7 +31446,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse parameters: - in: path name: projectsId @@ -30818,21 +31459,38 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: parameters: *ref_1 post: - description: Deploys a Model into this Endpoint, creating a DeployedModel within it. - operationId: aiplatform.projects.locations.endpoints.deployModel + description: Perform a token counting. + operationId: aiplatform.projects.locations.endpoints.countTokens requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployModelRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30844,7 +31502,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -30861,19 +31520,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: parameters: *ref_1 post: description: >- - Perform a server-side streaming online prediction request for Vertex LLM - streaming. - operationId: aiplatform.projects.locations.endpoints.serverStreamingPredict + 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. + operationId: aiplatform.projects.locations.endpoints.rawPredict requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30889,8 +31550,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -30907,21 +31567,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: parameters: *ref_1 - post: - description: >- - Updates an existing deployed model. Updatable fields include - `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, - `disable_container_logging` (v1 only), and `enable_container_logging` - (v1beta1 only). - operationId: aiplatform.projects.locations.endpoints.mutateDeployedModel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MutateDeployedModelRequest + delete: + description: Deletes an Endpoint. + operationId: aiplatform.projects.locations.endpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30950,36 +31600,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: - parameters: *ref_1 - post: - description: >- - Perform an unary online prediction request to a gRPC model server for - custom containers. - operationId: aiplatform.projects.locations.endpoints.directRawPredict + patch: + description: Updates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -30996,16 +31636,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: - parameters: *ref_1 - post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.endpoints.countTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets an Endpoint. + operationId: aiplatform.projects.locations.endpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31017,8 +31655,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -31035,20 +31672,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.endpoints.explain + Perform a server-side streaming online prediction request for Vertex LLM + streaming. + operationId: aiplatform.projects.locations.endpoints.serverStreamingPredict requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31064,7 +31700,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -31081,34 +31718,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: parameters: *ref_1 post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.endpoints.streamGenerateContent + description: >- + Undeploys a Model from an Endpoint, removing a DeployedModel from it, + and freeing all resources it's using. + operationId: aiplatform.projects.locations.endpoints.undeployModel requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31125,16 +31758,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: parameters: *ref_1 post: - description: Creates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.create + description: Deploys a Model into this Endpoint, creating a DeployedModel within it. + operationId: aiplatform.projects.locations.endpoints.deployModel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31158,26 +31791,41 @@ paths: required: true schema: type: string - - in: query - name: endpointId + - in: path + name: endpointsId + required: true schema: type: string - get: - description: Lists Endpoints in a Location. - operationId: aiplatform.projects.locations.endpoints.list + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: + parameters: *ref_1 + post: + description: >- + 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. + operationId: aiplatform.projects.locations.endpoints.explain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' parameters: - in: path name: projectsId @@ -31189,59 +31837,38 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask + - in: path + name: endpointsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.endpoints.rawPredict + Updates an existing deployed model. Updatable fields include + `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, + `disable_container_logging` (v1 only), and `enable_container_logging` + (v1beta1 only). + operationId: aiplatform.projects.locations.endpoints.mutateDeployedModel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MutateDeployedModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31258,16 +31885,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: parameters: *ref_1 post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.endpoints.predict + description: Perform a streaming online prediction with an arbitrary HTTP payload. + operationId: aiplatform.projects.locations.endpoints.streamRawPredict requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31283,7 +31911,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -31300,30 +31928,35 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: parameters: *ref_1 post: description: >- - Undeploys a Model from an Endpoint, removing a DeployedModel from it, - and freeing all resources it's using. - operationId: aiplatform.projects.locations.endpoints.undeployModel + Perform an unary online prediction request to a gRPC model server for + Vertex first-party products and frameworks. + operationId: aiplatform.projects.locations.endpoints.directPredict requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployModelRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectPredictResponse parameters: - in: path name: projectsId @@ -31379,18 +32012,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: parameters: *ref_1 post: - description: >- - Perform an unary online prediction request to a gRPC model server for - Vertex first-party products and frameworks. - operationId: aiplatform.projects.locations.endpoints.directPredict + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.projects.locations.endpoints.streamGenerateContent requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31407,7 +32039,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectPredictResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -31424,17 +32056,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: parameters: *ref_1 post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.endpoints.generateContent + description: >- + Perform an unary online prediction request to a gRPC model server for + custom containers. + operationId: aiplatform.projects.locations.endpoints.directRawPredict requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31451,7 +32085,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse parameters: - in: path name: projectsId @@ -31468,15 +32102,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: parameters: *ref_1 - delete: + patch: 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`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete + 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. + operationId: aiplatform.projects.locations.schedules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31488,7 +32128,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -31501,21 +32141,18 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: schedulesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: 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. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.get + format: google-fieldmask + delete: + description: Deletes a Schedule. + operationId: aiplatform.projects.locations.schedules.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31540,77 +32177,13 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: - parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait + description: Gets a Schedule. + operationId: aiplatform.projects.locations.schedules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31622,7 +32195,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -31635,34 +32208,23 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: schedulesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel + 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. + operationId: aiplatform.projects.locations.schedules.pause + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PauseScheduleRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31687,26 +32249,20 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: + /v1/projects/{projectsId}/locations/{locationsId}/schedules: parameters: *ref_1 post: - description: Creates a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create + description: Creates a Schedule. + operationId: aiplatform.projects.locations.schedules.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31718,8 +32274,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -31732,8 +32287,8 @@ paths: schema: type: string get: - description: Lists HyperparameterTuningJobs in a Location. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list + description: Lists Schedules in a Location. + operationId: aiplatform.projects.locations.schedules.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31746,7 +32301,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse parameters: - in: path name: projectsId @@ -31772,96 +32327,26 @@ paths: schema: type: string - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: - parameters: *ref_1 - delete: - description: Deletes a HyperparameterTuningJob. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - get: - description: Gets a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.cancel + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: + parameters: *ref_1 + post: + description: >- + 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.catchUp is set up true, + all missed runs will be scheduled for backfill first. + operationId: aiplatform.projects.locations.schedules.resume requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31886,11 +32371,11 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -31903,7 +32388,7 @@ paths: 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. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.wait + operationId: aiplatform.projects.locations.schedules.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31928,7 +32413,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: schedulesId required: true schema: type: string @@ -31942,15 +32427,20 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: parameters: *ref_1 - delete: + post: 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`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.delete + 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`. + operationId: aiplatform.projects.locations.schedules.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31975,7 +32465,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: schedulesId required: true schema: type: string @@ -31984,12 +32474,15 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: + parameters: *ref_1 + delete: 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. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.get + 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`. + operationId: aiplatform.projects.locations.schedules.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32001,7 +32494,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32014,7 +32507,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: schedulesId required: true schema: type: string @@ -32023,20 +32516,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: + get: 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`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.cancel + 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. + operationId: aiplatform.projects.locations.schedules.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32048,7 +32533,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32061,7 +32546,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: schedulesId required: true schema: type: string @@ -32070,13 +32555,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.list + operationId: aiplatform.projects.locations.schedules.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32101,16 +32586,16 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: schedulesId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -32118,16 +32603,11 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: parameters: *ref_1 - post: - description: Creates a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + get: + description: Gets a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32139,7 +32619,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' parameters: - in: path name: projectsId @@ -32151,13 +32631,14 @@ paths: required: true schema: type: string - - in: query - name: notebookExecutionJobId + - in: path + name: specialistPoolsId + required: true schema: type: string - get: - description: Lists NotebookExecutionJobs in a Location. - operationId: aiplatform.projects.locations.notebookExecutionJobs.list + delete: + description: Deletes a SpecialistPool as well as all Specialists in the pool. + operationId: aiplatform.projects.locations.specialistPools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32169,8 +32650,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32182,32 +32662,23 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: specialistPoolsId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}: - parameters: *ref_1 - delete: - description: Deletes a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.delete + type: boolean + patch: + description: Updates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32232,13 +32703,20 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: specialistPoolsId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: + parameters: *ref_1 get: - description: Gets a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.get + description: Lists SpecialistPools in a Location. + operationId: aiplatform.projects.locations.specialistPools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32251,7 +32729,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob + #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse parameters: - in: path name: projectsId @@ -32263,16 +32741,52 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + post: + description: Creates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: notebookExecutionJobsId + name: projectsId required: true schema: type: string - - in: query - name: view + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -32285,7 +32799,7 @@ paths: 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. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait + operationId: aiplatform.projects.locations.specialistPools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32310,7 +32824,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: specialistPoolsId required: true schema: type: string @@ -32324,7 +32838,7 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -32337,7 +32851,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel + operationId: aiplatform.projects.locations.specialistPools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32362,7 +32876,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: specialistPoolsId required: true schema: type: string @@ -32371,14 +32885,15 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: parameters: *ref_1 - get: + delete: 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. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.get + 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`. + operationId: aiplatform.projects.locations.specialistPools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32390,7 +32905,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32403,7 +32918,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: specialistPoolsId required: true schema: type: string @@ -32412,13 +32927,12 @@ paths: required: true schema: type: string - delete: + get: 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`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete + 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. + operationId: aiplatform.projects.locations.specialistPools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32430,7 +32944,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32443,7 +32957,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: specialistPoolsId required: true schema: type: string @@ -32452,13 +32966,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.list + operationId: aiplatform.projects.locations.specialistPools.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32483,30 +32997,75 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: specialistPoolsId required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query name: filter schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: + delete: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy + 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`. + operationId: aiplatform.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32518,7 +33077,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32531,20 +33090,16 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: operationsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: - parameters: *ref_1 - delete: - description: Deletes a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete + 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. + operationId: aiplatform.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32569,19 +33124,24 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: operationsId required: true schema: type: string - patch: - description: Updates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: aiplatform.projects.locations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32593,8 +33153,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32607,18 +33166,29 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask - get: - description: Gets a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32630,8 +33200,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32644,21 +33213,24 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: 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. - operationId: >- - aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions + 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`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32670,7 +33242,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32683,19 +33255,29 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: notebookExecutionJobsId required: true schema: type: string - - in: query - name: permissions + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: Lists NotebookRuntimeTemplates in a Location. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list + post: + 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. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32707,8 +33289,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32720,37 +33301,29 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy + - in: path + name: notebookExecutionJobsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - in: query - name: pageToken + name: timeout schema: type: string - post: - description: Creates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32774,23 +33347,23 @@ paths: required: true schema: type: string - - in: query - name: notebookRuntimeTemplateId + - in: path + name: notebookExecutionJobsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: - parameters: *ref_1 - post: + - in: path + name: operationsId + required: true + schema: + type: string + delete: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + 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`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32802,7 +33375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32815,24 +33388,22 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: notebookExecutionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations: parameters: *ref_1 - post: + get: 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`. - operationId: aiplatform.projects.locations.operations.cancel + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32844,7 +33415,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -32857,24 +33428,28 @@ paths: schema: type: string - in: path - name: operationsId + name: notebookExecutionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.operations.wait + get: + description: Gets a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32886,7 +33461,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob parameters: - in: path name: projectsId @@ -32899,23 +33475,17 @@ paths: schema: type: string - in: path - name: operationsId + name: notebookExecutionJobsId required: true schema: type: string - in: query - name: timeout + name: view schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.operations.get + delete: + description: Deletes a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32940,17 +33510,20 @@ paths: schema: type: string - in: path - name: operationsId + name: notebookExecutionJobsId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs: + parameters: *ref_1 + post: + description: Creates a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32962,7 +33535,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32974,18 +33547,13 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: notebookExecutionJobId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.operations.list + description: Lists NotebookExecutionJobs in a Location. + operationId: aiplatform.projects.locations.notebookExecutionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32997,7 +33565,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse parameters: - in: path name: projectsId @@ -33009,33 +33578,37 @@ paths: required: true schema: type: string + - in: query + name: view + schema: + type: string - in: query name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.schedules.operations.cancel + description: Creates a new FeatureGroup in a given project and location. + operationId: aiplatform.projects.locations.featureGroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33047,7 +33620,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33059,23 +33632,13 @@ paths: required: true schema: type: string - - in: path - name: schedulesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: featureGroupId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: - parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.schedules.operations.list + description: Lists FeatureGroups in a given project and location. + operationId: aiplatform.projects.locations.featureGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33087,7 +33650,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse parameters: - in: path name: projectsId @@ -33099,33 +33663,28 @@ paths: required: true schema: type: string - - in: path - name: schedulesId - required: true + - in: query + name: orderBy schema: type: string - in: query name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: parameters: *ref_1 - 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`. - operationId: aiplatform.projects.locations.schedules.operations.delete + get: + description: Gets details of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33137,7 +33696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' parameters: - in: path name: projectsId @@ -33150,21 +33709,18 @@ paths: schema: type: string - in: path - name: schedulesId - required: true - schema: - type: string - - in: path - name: operationsId + name: featureGroupsId required: true schema: 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. - operationId: aiplatform.projects.locations.schedules.operations.get + patch: + description: Updates the parameters of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33189,29 +33745,18 @@ paths: schema: type: string - in: path - name: schedulesId + name: featureGroupsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.schedules.operations.wait + format: google-fieldmask + delete: + description: Deletes a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33236,30 +33781,23 @@ paths: schema: type: string - in: path - name: schedulesId - required: true - schema: - type: string - - in: path - name: operationsId + name: featureGroupsId required: true schema: type: string - in: query - name: timeout + name: force schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/schedules: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Creates a Schedule. - operationId: aiplatform.projects.locations.schedules.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + 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`. + operationId: aiplatform.projects.locations.featureGroups.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33271,7 +33809,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33283,9 +33821,27 @@ paths: required: true schema: type: string + - in: path + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string get: - description: Lists Schedules in a Location. - operationId: aiplatform.projects.locations.schedules.list + 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. + operationId: aiplatform.projects.locations.featureGroups.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33297,8 +33853,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33310,28 +33865,28 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: featureGroupsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: featuresId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: parameters: *ref_1 get: - description: Gets a Schedule. - operationId: aiplatform.projects.locations.schedules.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33343,7 +33898,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -33356,23 +33911,45 @@ paths: schema: type: string - in: path - name: schedulesId + name: featureGroupsId required: true schema: type: string - patch: + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: description: >- - 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. - operationId: aiplatform.projects.locations.schedules.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + 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. + operationId: aiplatform.projects.locations.featureGroups.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33384,7 +33961,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33397,18 +33974,30 @@ paths: schema: type: string - in: path - name: schedulesId + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: + parameters: *ref_1 delete: - description: Deletes a Schedule. - operationId: aiplatform.projects.locations.schedules.delete + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33433,23 +34022,18 @@ paths: schema: type: string - in: path - name: schedulesId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: - parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.schedules.pause - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PauseScheduleRequest' + - in: path + name: featuresId + required: true + schema: + type: string + get: + description: Gets details of a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33461,7 +34045,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -33474,27 +34058,23 @@ paths: schema: type: string - in: path - name: schedulesId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: - parameters: *ref_1 - post: - description: >- - 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.catchUp is set up true, - all missed runs will be scheduled for backfill first. - operationId: aiplatform.projects.locations.schedules.resume + - in: path + name: featuresId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33506,7 +34086,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33519,22 +34099,25 @@ paths: schema: type: string - in: path - name: schedulesId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs: + - in: path + name: featuresId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: parameters: *ref_1 - post: - description: >- - Creates a CustomJob. A created CustomJob right away will be attempted to - be run. - operationId: aiplatform.projects.locations.customJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + get: + description: Lists Features in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33546,7 +34129,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -33558,9 +34142,46 @@ paths: required: true schema: type: string - get: - description: Lists CustomJobs in a Location. - operationId: aiplatform.projects.locations.customJobs.list + - in: path + name: featureGroupsId + required: true + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + post: + description: Creates a new Feature in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33572,8 +34193,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33585,29 +34205,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken + - in: path + name: featureGroupsId + required: true schema: type: string - in: query - name: filter + name: featureId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets a CustomJob. - operationId: aiplatform.projects.locations.customJobs.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. + operationId: aiplatform.projects.locations.featureGroups.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33619,7 +34233,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33632,13 +34246,22 @@ paths: schema: type: string - in: path - name: customJobsId + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string delete: - description: Deletes a CustomJob. - operationId: aiplatform.projects.locations.customJobs.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`. + operationId: aiplatform.projects.locations.featureGroups.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33650,7 +34273,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33663,29 +34286,22 @@ paths: schema: type: string - in: path - name: customJobsId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: parameters: *ref_1 - post: + get: description: >- - 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`. - operationId: aiplatform.projects.locations.customJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelCustomJobRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33697,7 +34313,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -33710,12 +34326,28 @@ paths: schema: type: string - in: path - name: customJobsId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: - parameters: *ref_1 + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -33727,7 +34359,7 @@ paths: 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. - operationId: aiplatform.projects.locations.customJobs.operations.wait + operationId: aiplatform.projects.locations.featureGroups.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33752,7 +34384,7 @@ paths: schema: type: string - in: path - name: customJobsId + name: featureGroupsId required: true schema: type: string @@ -33766,14 +34398,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.customJobs.operations.get + description: Gets a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33785,7 +34414,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob parameters: - in: path name: projectsId @@ -33798,22 +34428,19 @@ paths: schema: type: string - in: path - name: customJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.customJobs.operations.delete + patch: + description: Updates a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33825,7 +34452,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33838,29 +34465,18 @@ paths: schema: type: string - in: path - name: customJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.customJobs.operations.cancel + format: google-fieldmask + delete: + description: Deletes a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33872,7 +34488,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33885,22 +34501,24 @@ paths: schema: type: string - in: path - name: customJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.customJobs.operations.list + Pauses a ModelDeploymentMonitoringJob. If the job is running, the server + makes a best effort to cancel the job. Will mark + ModelDeploymentMonitoringJob.state to 'PAUSED'. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33912,7 +34530,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33925,42 +34543,15 @@ paths: schema: type: string - in: path - name: customJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: parameters: *ref_1 - post: - description: >- - Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. - 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 - TuningJob is not deleted; instead it becomes a job with a - TuningJob.error value with a google.rpc.Status.code of 1, corresponding - to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.tuningJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelTuningJobRequest + get: + description: Lists ModelDeploymentMonitoringJobs in a Location. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33972,7 +34563,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse parameters: - in: path name: projectsId @@ -33984,16 +34576,35 @@ paths: required: true schema: type: string - - in: path - name: tuningJobsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: - parameters: *ref_1 - get: - description: Lists TuningJobs in a Location. - operationId: aiplatform.projects.locations.tuningJobs.list + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + post: + description: >- + Creates a ModelDeploymentMonitoringJob. It will run periodically on a + configured interval. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34006,7 +34617,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob parameters: - in: path name: projectsId @@ -34018,29 +34629,20 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: + parameters: *ref_1 post: description: >- - Creates a TuningJob. A created TuningJob right away will be attempted to - be run. - operationId: aiplatform.projects.locations.tuningJobs.create + Resumes a paused ModelDeploymentMonitoringJob. It will start to run from + next scheduled time. A deleted ModelDeploymentMonitoringJob can't be + resumed. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34052,7 +34654,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -34064,11 +34666,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: + - in: path + name: modelDeploymentMonitoringJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: parameters: *ref_1 - get: - description: Gets a TuningJob. - operationId: aiplatform.projects.locations.tuningJobs.get + post: + description: >- + Searches Model Monitoring Statistics generated within a given time + window. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34080,7 +34696,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse parameters: - in: path name: projectsId @@ -34093,18 +34710,19 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.tuningJobs.operations.get + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34129,7 +34747,7 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -34138,20 +34756,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: + delete: 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`. - operationId: aiplatform.projects.locations.tuningJobs.operations.cancel + 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`. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34176,7 +34788,7 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -34185,13 +34797,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tuningJobs.operations.list + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34216,10 +34829,15 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: filter schema: @@ -34228,16 +34846,21 @@ paths: name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: - description: Lists SavedQueries in a Dataset. - operationId: aiplatform.projects.locations.datasets.savedQueries.list + post: + 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`. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34249,8 +34872,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -34263,37 +34885,75 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: modelDeploymentMonitoringJobsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - in: query - name: readMask + name: timeout schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: parameters: *ref_1 - delete: - description: Deletes a SavedQuery. - operationId: aiplatform.projects.locations.datasets.savedQueries.delete + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34305,7 +34965,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -34318,29 +34978,40 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: savedQueriesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string post: 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`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.cancel + 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. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34352,7 +35023,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34365,21 +35036,21 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: savedQueriesId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: parameters: *ref_1 delete: description: >- @@ -34387,7 +35058,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete + operationId: aiplatform.projects.locations.featureOnlineStores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34412,12 +35083,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId + name: featureOnlineStoresId required: true schema: type: string @@ -34431,7 +35097,7 @@ paths: 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. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get + operationId: aiplatform.projects.locations.featureOnlineStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34456,12 +35122,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId + name: featureOnlineStoresId required: true schema: type: string @@ -34470,13 +35131,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.list + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34488,7 +35150,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -34501,42 +35163,25 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: savedQueriesId + name: featureViewsId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.wait + delete: + description: Deletes a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34561,33 +35206,23 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}: - parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.get + patch: + description: Updates the parameters of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34612,27 +35247,23 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: dataItemsId + name: featureViewsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - 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`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.delete + format: google-fieldmask + get: + description: Gets details of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34644,7 +35275,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' parameters: - in: path name: projectsId @@ -34657,34 +35288,27 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.wait + description: Fetch feature values under a FeatureView. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34696,7 +35320,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse parameters: - in: path name: projectsId @@ -34709,32 +35334,30 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.list + 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. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34746,7 +35369,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse parameters: - in: path name: projectsId @@ -34759,42 +35383,25 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: dataItemsId + name: featureViewsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.cancel + description: Creates a new FeatureView in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34806,7 +35413,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34819,28 +35426,21 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - - in: path - name: dataItemsId - required: true + - in: query + name: featureViewId schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: runSyncImmediately schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: - parameters: *ref_1 + type: boolean get: - description: >- - Lists Annotations belongs to a dataitem This RPC is only available in - InternalDatasetService. It is only used for exporting conversation data - to CCAI Insights. - operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list + description: Lists FeatureViews in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34853,7 +35453,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse parameters: - in: path name: projectsId @@ -34866,24 +35466,19 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: featureOnlineStoresId required: true schema: type: string - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: orderBy schema: @@ -34892,19 +35487,17 @@ paths: name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + 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. operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.list + aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34916,7 +35509,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -34929,48 +35522,30 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: annotationsId + name: featureViewsId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: parameters: *ref_1 post: - 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`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel + description: Triggers on-demand sync for the FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34982,7 +35557,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse parameters: - in: path name: projectsId @@ -34995,40 +35571,68 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: dataItemsId + name: featureViewsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: - in: path - name: annotationsId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait: + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: parameters: *ref_1 - post: - 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. + get: + description: Lists FeatureViewSyncs in a given FeatureView. operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35040,7 +35644,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse parameters: - in: path name: projectsId @@ -35053,40 +35658,38 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: dataItemsId + name: featureViewsId required: true schema: type: string - - in: path - name: annotationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: orderBy schema: type: string - in: query - name: timeout + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: parameters: *ref_1 - 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`. + get: + description: Gets details of a single FeatureViewSync. operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35098,7 +35701,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' parameters: - in: path name: projectsId @@ -35111,32 +35714,29 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: annotationsId + name: featureViewsId required: true schema: type: string - in: path - name: operationsId + name: featureViewSyncsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: + parameters: *ref_1 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. operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.get + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35161,17 +35761,12 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: annotationsId + name: featureViewsId required: true schema: type: string @@ -35180,11 +35775,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: - parameters: *ref_1 - get: - description: Lists DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.dataItems.list + 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`. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35196,8 +35794,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35210,39 +35807,28 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + - in: path + name: featureViewsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.operations.list + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35267,16 +35853,22 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -35284,14 +35876,23 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: - parameters: *ref_1 - get: + - in: query + name: filter + schema: + type: string + post: 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. - operationId: aiplatform.projects.locations.datasets.operations.get + 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. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35316,7 +35917,12 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId required: true schema: type: string @@ -35325,13 +35931,21 @@ paths: required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.datasets.operations.delete + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: + parameters: *ref_1 + patch: + description: Updates the parameters of a single FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35343,7 +35957,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35356,29 +35970,18 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.datasets.operations.wait + format: google-fieldmask + get: + description: Gets details of a single FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35390,7 +35993,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' parameters: - in: path name: projectsId @@ -35403,34 +36006,15 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: operationsId + name: featureOnlineStoresId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: + delete: 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`. - operationId: aiplatform.projects.locations.datasets.operations.cancel + Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not + contain any FeatureViews. + operationId: aiplatform.projects.locations.featureOnlineStores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35442,7 +36026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35455,23 +36039,19 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.get + description: Lists FeatureOnlineStores in a given project and location. + operationId: aiplatform.projects.locations.featureOnlineStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35483,7 +36063,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse parameters: - in: path name: projectsId @@ -35495,28 +36076,31 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: annotationSpecsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - 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`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new FeatureOnlineStore in a given project and location. + operationId: aiplatform.projects.locations.featureOnlineStores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35528,7 +36112,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35540,35 +36124,17 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: featureOnlineStoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.wait + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featureOnlineStores.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35580,7 +36146,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -35593,39 +36159,66 @@ paths: schema: type: string - in: path - name: datasetsId + name: featureOnlineStoresId required: true schema: type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featureOnlineStores.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: - in: path - name: annotationSpecsId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: featureOnlineStoresId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel + 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. + operationId: aiplatform.projects.locations.featureOnlineStores.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35637,7 +36230,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -35650,27 +36243,33 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: featureOnlineStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list + 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. + operationId: aiplatform.projects.locations.batchPredictionJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35682,7 +36281,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35695,33 +36294,15 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: batchPredictionJobsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: parameters: *ref_1 get: - description: Gets an AnnotationSpec. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.get + description: Gets a BatchPredictionJob + operationId: aiplatform.projects.locations.batchPredictionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35733,7 +36314,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -35746,25 +36327,15 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: batchPredictionJobsId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: - parameters: *ref_1 delete: - description: Deletes a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.delete + description: >- + Deletes a BatchPredictionJob. Can only be called on jobs that already + finished. + operationId: aiplatform.projects.locations.batchPredictionJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35789,18 +36360,15 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: datasetVersionsId + name: batchPredictionJobsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: + parameters: *ref_1 get: - description: Gets a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.get + description: Lists BatchPredictionJobs in a Location. + operationId: aiplatform.projects.locations.batchPredictionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35812,7 +36380,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse parameters: - in: path name: projectsId @@ -35824,29 +36393,34 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: datasetVersionsId - required: true + format: google-fieldmask + - in: query + name: filter schema: type: string - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - patch: - description: Updates a DatasetVersion. - operationId: aiplatform.projects.locations.datasets.datasetVersions.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Creates a BatchPredictionJob. A BatchPredictionJob once created will + right away be attempted to start. + operationId: aiplatform.projects.locations.batchPredictionJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35858,7 +36432,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -35870,26 +36444,21 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: datasetVersionsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: Lists DatasetVersions in a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.list + post: + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35901,8 +36470,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35915,40 +36483,40 @@ paths: schema: type: string - in: path - name: datasetsId + name: featurestoresId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: entityTypesId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: featuresId + required: true schema: type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - in: query - name: orderBy + name: timeout schema: type: string - post: - description: Create a version from a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: + parameters: *ref_1 + 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`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35960,28 +36528,45 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId required: true schema: type: string - in: path - name: locationsId + name: featuresId required: true schema: type: string - in: path - name: datasetsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: - parameters: *ref_1 get: - description: Restores a dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.restore + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36006,51 +36591,33 @@ paths: schema: type: string - in: path - name: datasetsId + name: featurestoresId required: true schema: type: string - in: path - name: datasetVersionsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets: - parameters: *ref_1 - post: - description: Creates a Dataset. - operationId: aiplatform.projects.locations.datasets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: featuresId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: + parameters: *ref_1 get: - description: Lists Datasets in a Location. - operationId: aiplatform.projects.locations.datasets.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36062,8 +36629,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -36075,11 +36641,21 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true schema: type: string - format: google-fieldmask - in: query name: pageToken schema: @@ -36089,19 +36665,25 @@ paths: schema: type: integer format: int32 - - in: query - name: orderBy - schema: - type: string - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: - description: Gets a Dataset. - operationId: aiplatform.projects.locations.datasets.get + post: + 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`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36113,7 +36695,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -36126,54 +36708,35 @@ paths: schema: type: string - in: path - name: datasetsId + name: featurestoresId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a Dataset. - operationId: aiplatform.projects.locations.datasets.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: entityTypesId required: true schema: type: string - in: path - name: locationsId + name: featuresId required: true schema: type: string - in: path - name: datasetsId + name: operationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: + parameters: *ref_1 patch: - description: Updates a Dataset. - operationId: aiplatform.projects.locations.datasets.patch + description: Updates the parameters of a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36185,7 +36748,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -36198,7 +36761,17 @@ paths: schema: type: string - in: path - name: datasetsId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -36207,16 +36780,9 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: - parameters: *ref_1 - post: - description: Exports data from a Dataset. - operationId: aiplatform.projects.locations.datasets.export - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' + get: + description: Gets details of a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36228,7 +36794,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -36241,15 +36807,23 @@ paths: schema: type: string - in: path - name: datasetsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: - parameters: *ref_1 - get: - description: Searches DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.searchDataItems + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + delete: + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36261,8 +36835,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36275,75 +36848,32 @@ paths: schema: type: string - in: path - name: datasetsId + name: featurestoresId required: true schema: type: string - - in: query - name: orderByDataItem - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: orderByAnnotation.orderBy - schema: - type: string - - in: query - name: dataItemFilter - schema: - type: string - - in: query - name: orderByAnnotation.savedQuery - schema: - type: string - - in: query - name: annotationFilters - schema: - type: string - - in: query - name: annotationsLimit - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: savedQuery - schema: - type: string - - in: query - name: fieldMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: annotationsFilter + - in: path + name: entityTypesId + required: true schema: type: string - - in: query - name: dataLabelingJob + - in: path + name: featuresId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: parameters: *ref_1 post: - description: Imports data into a Dataset. - operationId: aiplatform.projects.locations.datasets.import + description: Creates a batch of Features in a given EntityType. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36368,19 +36898,20 @@ paths: schema: type: string - in: path - name: datasetsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: parameters: *ref_1 - 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`. - operationId: aiplatform.projects.locations.tensorboards.operations.delete + get: + description: Lists Features in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36392,7 +36923,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -36405,21 +36937,50 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: 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. - operationId: aiplatform.projects.locations.tensorboards.operations.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + post: + description: Creates a new Feature in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36444,16 +37005,20 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: + - in: query + name: featureId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -36466,7 +37031,8 @@ paths: 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`. - operationId: aiplatform.projects.locations.tensorboards.operations.cancel + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36491,64 +37057,21 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: projectsId + name: featurestoresId required: true schema: type: string - in: path - name: locationsId + name: entityTypesId required: true schema: type: string - in: path - name: tensorboardsId + name: operationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -36561,7 +37084,7 @@ paths: 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. - operationId: aiplatform.projects.locations.tensorboards.operations.wait + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36586,7 +37109,12 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId required: true schema: type: string @@ -36600,17 +37128,13 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations: parameters: *ref_1 - post: - description: Batch create TensorboardRuns. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36622,8 +37146,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -36636,36 +37159,48 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId required: true schema: type: string - in: path - name: experimentsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.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. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36678,23 +37213,28 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId required: true schema: type: string - in: path - name: experimentsId + name: entityTypesId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string delete: - description: Deletes a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.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`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36706,7 +37246,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -36719,28 +37259,46 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId required: true schema: type: string - in: path - name: experimentsId + name: entityTypesId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - patch: - description: Updates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: + parameters: *ref_1 + post: + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36752,7 +37310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36765,38 +37323,29 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: entityTypesId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: parameters: *ref_1 post: description: >- - Write time series data points into multiple TensorboardTimeSeries under - a TensorboardRun. If any data fail to be ingested, an error is returned. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.write + Reads Feature values for multiple entities. Depending on their size, + data for different entities may be broken up across multiple responses. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36809,7 +37358,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse parameters: - in: path name: projectsId @@ -36822,34 +37371,25 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: featurestoresId required: true schema: type: string - in: path - name: runsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: parameters: *ref_1 get: - description: Lists TensorboardRuns in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list + description: Lists EntityTypes in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -36857,7 +37397,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse + #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse parameters: - in: path name: projectsId @@ -36870,17 +37410,16 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: orderBy schema: type: string - in: query - name: orderBy + name: filter schema: type: string - in: query @@ -36888,10 +37427,6 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: @@ -36902,13 +37437,13 @@ paths: type: string format: google-fieldmask post: - description: Creates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create + description: Creates a new EntityType in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36920,7 +37455,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36933,28 +37468,21 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: featurestoresId required: true schema: type: string - in: query - name: tensorboardRunId + name: entityTypeId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: parameters: *ref_1 - get: + post: 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.get + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36966,7 +37494,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -36979,33 +37507,40 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: featurestoresId required: true schema: type: string - in: path - name: runsId + name: entityTypesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - delete: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: + parameters: *ref_1 + post: 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`. + 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. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete + aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37017,7 +37552,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37030,40 +37565,27 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: parameters: *ref_1 post: - 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. + description: Exports Feature values from all the entities of a target EntityType. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait + aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37088,45 +37610,26 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: parameters: *ref_1 post: 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`. + 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. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel + aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37138,7 +37641,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -37151,33 +37654,24 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: featurestoresId required: true schema: type: string - in: path - name: runsId + name: entityTypesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.list + description: Gets details of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37189,7 +37683,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' parameters: - in: path name: projectsId @@ -37202,42 +37696,23 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: featurestoresId required: true schema: type: string - in: path - name: runsId + name: entityTypesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: - parameters: *ref_1 - 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get + patch: + description: Updates the parameters of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37249,7 +37724,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' parameters: - in: path name: projectsId @@ -37262,38 +37737,25 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: path - name: timeSeriesId + name: entityTypesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask 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`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete + Deletes a single EntityType. The EntityType must not have any Features + or `force` must be set to true for the request to succeed. + operationId: aiplatform.projects.locations.featurestores.entityTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37305,7 +37767,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37318,45 +37780,34 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: path - name: timeSeriesId + name: entityTypesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: parameters: *ref_1 post: 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`. + Reads Feature values of a specific entity of an EntityType. For reading + feature values of multiple entities of an EntityType, please use + StreamingReadFeatureValues. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel + aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37368,7 +37819,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse parameters: - in: path name: projectsId @@ -37381,45 +37833,28 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: parameters: *ref_1 post: 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37431,7 +37866,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -37444,43 +37879,31 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + 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. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list + aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37492,7 +37915,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse parameters: - in: path name: projectsId @@ -37505,66 +37929,36 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: path - name: timeSeriesId + name: entityTypesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: parameters: *ref_1 - get: + delete: description: >- - 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read + 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`. + operationId: aiplatform.projects.locations.featurestores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37577,57 +37971,33 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxDataPoints - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: - parameters: *ref_1 - get: - description: Gets a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get + 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. + operationId: aiplatform.projects.locations.featurestores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37640,35 +38010,29 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: type: string - patch: - description: Updates a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.featurestores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37680,8 +38044,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37694,34 +38057,22 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featurestores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37733,7 +38084,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -37746,48 +38097,49 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: runsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: timeSeriesId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: Lists TensorboardTimeSeries in a Location. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list + post: + 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. + operationId: aiplatform.projects.locations.featurestores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37800,52 +38152,30 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: featurestoresId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + name: timeout schema: type: string - post: - description: Creates a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: + parameters: *ref_1 + patch: + description: Updates the parameters of a single Featurestore. + operationId: aiplatform.projects.locations.featurestores.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37857,8 +38187,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37871,50 +38200,32 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: featurestoresId required: true schema: type: string - in: query - name: tensorboardTimeSeriesId + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: - parameters: *ref_1 - get: + format: google-fieldmask + delete: description: >- - 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData + Deletes a single Featurestore. The Featurestore must not contain any + EntityTypes or `force` must be set to true for the request to succeed. + operationId: aiplatform.projects.locations.featurestores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37927,43 +38238,61 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: featurestoresId required: true schema: type: string + - in: query + name: force + schema: + type: boolean + get: + description: Gets details of a single Featurestore. + operationId: aiplatform.projects.locations.featurestores.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + parameters: - in: path - name: experimentsId + name: projectsId required: true schema: type: string - in: path - name: runsId + name: locationsId required: true schema: type: string - in: path - name: timeSeriesId + name: featurestoresId required: true schema: type: string - - in: query - name: blobIds - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: parameters: *ref_1 post: description: >- - Exports a TensorboardTimeSeries' data. Data is returned in paginated - responses. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries + 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. + operationId: aiplatform.projects.locations.featurestores.batchReadFeatureValues requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37975,8 +38304,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37989,32 +38317,17 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.list + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featurestores.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38026,7 +38339,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -38039,36 +38352,20 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: featurestoresId required: true schema: type: string - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get + description: Lists Featurestores in a given project and location. + operationId: aiplatform.projects.locations.featurestores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38080,7 +38377,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse parameters: - in: path name: projectsId @@ -38092,28 +38390,36 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - 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`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new Featurestore in a given project and location. + operationId: aiplatform.projects.locations.featurestores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38125,7 +38431,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38137,35 +38443,20 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: featurestoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.wait + 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. + operationId: aiplatform.projects.locations.featurestores.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38177,7 +38468,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -38190,39 +38481,27 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: operationsId + name: featurestoresId required: true schema: type: string - in: query - name: timeout + name: permissions schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.cancel + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featurestores.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38234,7 +38513,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -38247,31 +38526,15 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: operationsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: parameters: *ref_1 - patch: - description: Updates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + get: + description: Searches Features matching a query in a given project. + operationId: aiplatform.projects.locations.featurestores.searchFeatures security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38284,7 +38547,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse parameters: - in: path name: projectsId @@ -38296,41 +38559,44 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: query schema: type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask - get: - description: Gets a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.get + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: + parameters: *ref_1 + post: + description: >- + Adds a measurement of the objective metrics to a Trial. This measurement + is assumed to have been taken before the Trial is complete. + operationId: aiplatform.projects.locations.studies.trials.addTrialMeasurement + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddTrialMeasurementRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -38343,18 +38609,25 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - in: path - name: experimentsId + name: trialsId required: true schema: type: string - delete: - description: Deletes a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.delete + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: + parameters: *ref_1 + post: + description: Marks a Trial as complete. + operationId: aiplatform.projects.locations.studies.trials.complete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38366,7 +38639,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -38379,28 +38652,29 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - in: path - name: experimentsId + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: parameters: *ref_1 post: description: >- - Batch create TensorboardTimeSeries that belong to a - TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate + 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. + operationId: aiplatform.projects.locations.studies.trials.suggest requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1SuggestTrialsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38412,8 +38686,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38426,26 +38699,24 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: parameters: *ref_1 post: - description: Creates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.create + description: >- + 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 + operationId: aiplatform.projects.locations.studies.trials.listOptimalTrials requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38458,7 +38729,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse parameters: - in: path name: projectsId @@ -38471,34 +38742,27 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - - in: query - name: tensorboardExperimentId - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: + parameters: *ref_1 get: - description: Lists TensorboardExperiments in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.list + description: Lists the Trials associated with a Study. + operationId: aiplatform.projects.locations.studies.trials.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' parameters: - in: path name: projectsId @@ -38511,46 +38775,27 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - in: query - name: orderBy + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: - parameters: *ref_1 post: - description: >- - Write time series data points of multiple TensorboardTimeSeries in - multiple TensorboardRun's. If any data fail to be ingested, an error is - returned. - operationId: aiplatform.projects.locations.tensorboards.experiments.write + description: Adds a user provided Trial to a Study. + operationId: aiplatform.projects.locations.studies.trials.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38562,8 +38807,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -38576,25 +38820,20 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: parameters: *ref_1 - patch: - description: Updates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.patch + post: + description: Stops a Trial. + operationId: aiplatform.projects.locations.studies.trials.stop requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38606,7 +38845,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -38619,18 +38858,30 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: trialsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.delete + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: + parameters: *ref_1 + post: + description: >- + Checks whether a Trial should stop or not. Returns a long-running + operation. When the operation is successful, it will contain a + CheckTrialEarlyStoppingStateResponse. + operationId: >- + aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38655,29 +38906,32 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - get: - description: Gets a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.get + - in: path + name: trialsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: + parameters: *ref_1 + delete: + description: Deletes a Trial. + operationId: aiplatform.projects.locations.studies.trials.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38690,32 +38944,30 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId + required: true + schema: + type: string + - in: path + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: - parameters: *ref_1 get: - description: Lists Tensorboards in a Location. - operationId: aiplatform.projects.locations.tensorboards.list + description: Gets a Trial. + operationId: aiplatform.projects.locations.studies.trials.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -38727,36 +38979,30 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask + - in: path + name: studiesId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: trialsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Creates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + 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. + operationId: aiplatform.projects.locations.studies.trials.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38780,16 +39026,40 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: + - in: path + name: studiesId + required: true + schema: + type: string + - in: path + name: trialsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - 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. - operationId: aiplatform.projects.locations.tensorboards.batchRead + 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`. + operationId: aiplatform.projects.locations.studies.trials.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38801,8 +39071,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38815,19 +39084,28 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - - in: query - name: timeSeries + - in: path + name: trialsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: parameters: *ref_1 get: - description: Returns a list of monthly active users for a given TensorBoard instance. - operationId: aiplatform.projects.locations.tensorboards.readUsage + 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. + operationId: aiplatform.projects.locations.studies.trials.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38839,8 +39117,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38853,15 +39130,27 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: - parameters: *ref_1 - get: - description: Returns the storage size for a given TensorBoard instance. - operationId: aiplatform.projects.locations.tensorboards.readSize + - in: path + name: trialsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: aiplatform.projects.locations.studies.trials.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38873,8 +39162,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38887,40 +39175,39 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: + - in: path + name: trialsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: parameters: *ref_1 - post: + get: description: >- - Perform a server-side streaming online prediction request for Vertex LLM - streaming. - operationId: aiplatform.projects.locations.publishers.models.serverStreamingPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.studies.trials.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -38933,25 +39220,36 @@ paths: schema: type: string - in: path - name: publishersId + name: studiesId required: true schema: type: string - in: path - name: modelsId + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.publishers.models.countTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + 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. + operationId: aiplatform.projects.locations.studies.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38963,8 +39261,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38977,41 +39274,34 @@ paths: schema: type: string - in: path - name: publishersId + name: studiesId required: true schema: type: string - in: path - name: modelsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: - parameters: *ref_1 - post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.publishers.models.predict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + 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`. + operationId: aiplatform.projects.locations.studies.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39024,43 +39314,41 @@ paths: schema: type: string - in: path - name: publishersId + name: studiesId required: true schema: type: string - in: path - name: modelsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.publishers.models.streamGenerateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + 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`. + operationId: aiplatform.projects.locations.studies.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39073,42 +39361,41 @@ paths: schema: type: string - in: path - name: publishersId + name: studiesId required: true schema: type: string - in: path - name: modelsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Perform a streaming online prediction with an arbitrary HTTP payload. - operationId: aiplatform.projects.locations.publishers.models.streamRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest + 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. + operationId: aiplatform.projects.locations.studies.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39121,46 +39408,39 @@ paths: schema: type: string - in: path - name: publishersId + name: studiesId required: true schema: type: string - in: path - name: modelsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: - parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.publishers.models.rawPredict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.studies.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -39173,25 +39453,28 @@ paths: schema: type: string - in: path - name: publishersId + name: studiesId required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: parameters: *ref_1 - post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.projects.locations.publishers.models.computeTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + get: + description: Gets a Study by name. + operationId: aiplatform.projects.locations.studies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39203,8 +39486,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -39217,43 +39499,25 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.publishers.models.generateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + delete: + description: Deletes a Study. + operationId: aiplatform.projects.locations.studies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39266,20 +39530,15 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: + /v1/projects/{projectsId}/locations/{locationsId}/studies: parameters: *ref_1 get: - description: Lists BatchPredictionJobs in a Location. - operationId: aiplatform.projects.locations.batchPredictionJobs.list + description: Lists all the studies in a region for an associated project. + operationId: aiplatform.projects.locations.studies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39292,7 +39551,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse parameters: - in: path name: projectsId @@ -39304,34 +39563,25 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string post: description: >- - Creates a BatchPredictionJob. A BatchPredictionJob once created will - right away be attempted to start. - operationId: aiplatform.projects.locations.batchPredictionJobs.create + Creates a Study. A resource name will be generated after creation of the + Study. + operationId: aiplatform.projects.locations.studies.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39343,7 +39593,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -39355,11 +39605,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: parameters: *ref_1 - get: - description: Gets a BatchPredictionJob - operationId: aiplatform.projects.locations.batchPredictionJobs.get + post: + description: >- + Looks a study up using the user-defined display_name field instead of + the fully qualified resource name. + operationId: aiplatform.projects.locations.studies.lookup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1LookupStudyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39371,7 +39628,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -39383,16 +39640,11 @@ paths: required: true schema: type: string - - in: path - name: batchPredictionJobsId - required: true - schema: - type: string - delete: - description: >- - Deletes a BatchPredictionJob. Can only be called on jobs that already - finished. - operationId: aiplatform.projects.locations.batchPredictionJobs.delete + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: + parameters: *ref_1 + get: + description: Returns the storage size for a given TensorBoard instance. + operationId: aiplatform.projects.locations.tensorboards.readSize security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39404,7 +39656,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse parameters: - in: path name: projectsId @@ -39417,29 +39670,20 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.batchPredictionJobs.cancel + description: Creates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39451,7 +39695,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39463,37 +39707,26 @@ paths: required: true schema: type: string - - in: path - name: batchPredictionJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.trainingPipelines.operations.wait + get: + description: Lists Tensorboards in a Location. + operationId: aiplatform.projects.locations.tensorboards.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse parameters: - in: path name: projectsId @@ -39505,30 +39738,33 @@ paths: required: true schema: type: string - - in: path - name: trainingPipelinesId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - in: query - name: timeout + name: orderBy schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: parameters: *ref_1 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`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.delete + description: Deletes a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39540,7 +39776,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39553,21 +39789,18 @@ paths: schema: type: string - in: path - name: trainingPipelinesId - required: true - schema: - type: string - - in: path - name: operationsId + name: tensorboardsId required: true schema: 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. - operationId: aiplatform.projects.locations.trainingPipelines.operations.get + patch: + description: Updates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39592,34 +39825,34 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: tensorboardsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: - parameters: *ref_1 + format: google-fieldmask get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.list + description: Gets a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' parameters: - in: path name: projectsId @@ -39632,37 +39865,15 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: tensorboardsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.cancel + get: + description: Returns a list of monthly active users for a given TensorBoard instance. + operationId: aiplatform.projects.locations.tensorboards.readUsage security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39674,7 +39885,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse parameters: - in: path name: projectsId @@ -39687,20 +39899,20 @@ paths: schema: type: string - in: path - name: trainingPipelinesId - required: true - schema: - type: string - - in: path - name: operationsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: parameters: *ref_1 get: - description: Lists TrainingPipelines in a Location. - operationId: aiplatform.projects.locations.trainingPipelines.list + description: >- + 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. + operationId: aiplatform.projects.locations.tensorboards.batchRead security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39713,7 +39925,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse + #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -39725,46 +39937,38 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken + - in: path + name: tensorboardsId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: timeSeries schema: type: string - post: - description: >- - Creates a TrainingPipeline. A created TrainingPipeline right away will - be attempted to be run. - operationId: aiplatform.projects.locations.trainingPipelines.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: + parameters: *ref_1 + get: + description: Lists TensorboardTimeSeries in a Location. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -39776,90 +39980,53 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: - parameters: *ref_1 - delete: - description: Deletes a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: tensorboardsId required: true schema: type: string - in: path - name: locationsId + name: experimentsId required: true schema: type: string - in: path - name: trainingPipelinesId + name: runsId required: true schema: type: string - get: - description: Gets a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: trainingPipelinesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: - parameters: *ref_1 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask post: - description: >- - 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`. - operationId: aiplatform.projects.locations.trainingPipelines.cancel + description: Creates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39871,7 +40038,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -39884,30 +40052,50 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: query + name: tensorboardTimeSeriesId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.indexes.operations.get + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse parameters: - in: path name: projectsId @@ -39920,22 +40108,41 @@ paths: schema: type: string - in: path - name: indexesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.indexes.operations.delete + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: blobIds + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: + parameters: *ref_1 + patch: + description: Updates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39947,7 +40154,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -39960,34 +40168,51 @@ paths: schema: type: string - in: path - name: indexesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: - parameters: *ref_1 + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexes.operations.list + description: Gets a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -40000,37 +40225,29 @@ paths: schema: type: string - in: path - name: indexesId + name: tensorboardsId required: true schema: type: string - - in: query - name: filter + - in: path + name: experimentsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: runsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: timeSeriesId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.indexes.operations.cancel + type: string + delete: + description: Deletes a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40042,7 +40259,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40055,41 +40272,53 @@ paths: schema: type: string - in: path - name: indexesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.indexes.operations.wait + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -40102,31 +40331,48 @@ paths: schema: type: string - in: path - name: indexesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId required: true schema: type: string - in: query - name: timeout + name: maxDataPoints + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: parameters: *ref_1 post: - description: Add/update Datapoints into an Index. - operationId: aiplatform.projects.locations.indexes.upsertDatapoints + description: >- + Exports a TensorboardTimeSeries' data. Data is returned in paginated + responses. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40139,7 +40385,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -40152,57 +40398,40 @@ paths: schema: type: string - in: path - name: indexesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: - parameters: *ref_1 - post: - description: Remove Datapoints from an Index. - operationId: aiplatform.projects.locations.indexes.removeDatapoints - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: indexesId + name: timeSeriesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: parameters: *ref_1 - delete: + post: description: >- - Deletes an Index. An Index can only be deleted when all its - DeployedIndexes had been undeployed. - operationId: aiplatform.projects.locations.indexes.delete + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40227,54 +40456,43 @@ paths: schema: type: string - in: path - name: indexesId + name: tensorboardsId required: true schema: type: string - patch: - description: Updates an Index. - operationId: aiplatform.projects.locations.indexes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: indexesId + name: timeSeriesId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: + parameters: *ref_1 get: - description: Gets an Index. - operationId: aiplatform.projects.locations.indexes.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40286,7 +40504,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -40299,68 +40517,27 @@ paths: schema: type: string - in: path - name: indexesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes: - parameters: *ref_1 - post: - description: Creates an Index. - operationId: aiplatform.projects.locations.indexes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - get: - description: Lists Indexes in a Location. - operationId: aiplatform.projects.locations.indexes.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse - parameters: - in: path - name: projectsId + name: timeSeriesId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -40368,24 +40545,25 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: parameters: *ref_1 - delete: - description: Deletes a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.delete + post: + 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`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40397,7 +40575,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40410,46 +40588,39 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: tensorboardsId required: true schema: type: string - get: - description: Gets a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: notebookRuntimesId + name: timeSeriesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: parameters: *ref_1 get: - description: Lists NotebookRuntimes in a Location. - operationId: aiplatform.projects.locations.notebookRuntimes.list + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40461,8 +40632,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40474,39 +40644,39 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: tensorboardsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: experimentsId + required: true schema: - type: integer - format: int32 - - in: query - name: readMask + type: string + - in: path + name: runsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: orderBy + - in: path + name: timeSeriesId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: - parameters: *ref_1 - post: - description: Upgrades a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.upgrade - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + 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`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40518,7 +40688,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40531,63 +40701,38 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: - parameters: *ref_1 - post: - description: Starts a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.start - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: notebookRuntimesId + name: timeSeriesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.notebookRuntimes.assign - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40599,7 +40744,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -40607,17 +40752,47 @@ paths: schema: type: string - in: path - name: locationsId + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations: + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.list + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40629,7 +40804,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40642,31 +40817,33 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: tensorboardsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: experimentsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: runsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}: - parameters: *ref_1 - get: + delete: 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. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.get + 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`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40678,7 +40855,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40691,7 +40868,17 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string @@ -40700,13 +40887,21 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: 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`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.delete + 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`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40731,7 +40926,17 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string @@ -40740,7 +40945,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -40753,7 +40958,8 @@ paths: 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. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.wait + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40778,7 +40984,17 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string @@ -40792,20 +41008,19 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.cancel + Write time series data points into multiple TensorboardTimeSeries under + a TensorboardRun. If any data fail to be ingested, an error is returned. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.write + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40817,7 +41032,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse parameters: - in: path name: projectsId @@ -40830,28 +41046,30 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: + - in: path + name: runsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featurestores.setIamPolicy + patch: + description: Updates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40863,7 +41081,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -40876,20 +41094,28 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.featurestores.testIamPermissions + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40901,7 +41127,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40914,31 +41140,39 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - - in: query - name: permissions + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: - parameters: *ref_1 get: - description: Gets details of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.get + description: Gets a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -40951,15 +41185,31 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - 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. - operationId: aiplatform.projects.locations.featurestores.delete + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: + parameters: *ref_1 + post: + description: Batch create TensorboardRuns. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40971,7 +41221,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse parameters: - in: path name: projectsId @@ -40984,22 +41235,25 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - - in: query - name: force + - in: path + name: experimentsId + required: true schema: - type: boolean - patch: - description: Updates the parameters of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.patch + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: + parameters: *ref_1 + post: + description: Creates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41011,7 +41265,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -41024,31 +41278,96 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string - in: query - name: updateMask + name: tensorboardRunId + schema: + type: string + get: + description: Lists TensorboardRuns in a Location. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.featurestores.batchReadFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + 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`. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41060,7 +41379,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41073,15 +41392,28 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: parameters: *ref_1 get: - description: Searches Features matching a query in a given project. - operationId: aiplatform.projects.locations.featurestores.searchFeatures + 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. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41093,8 +41425,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41106,29 +41437,28 @@ paths: required: true schema: type: string - - in: query - name: query + - in: path + name: tensorboardsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: experimentsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores: - parameters: *ref_1 - post: - description: Creates a new Featurestore in a given project and location. - operationId: aiplatform.projects.locations.featurestores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + type: string + 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`. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41140,7 +41470,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41152,13 +41482,28 @@ paths: required: true schema: type: string - - in: query - name: featurestoreId + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true schema: type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: + parameters: *ref_1 get: - description: Lists Featurestores in a given project and location. - operationId: aiplatform.projects.locations.featurestores.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41170,8 +41515,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -41183,8 +41527,14 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true schema: type: string - in: query @@ -41197,21 +41547,23 @@ paths: schema: type: string - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featurestores.getIamPolicy + 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. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41223,7 +41575,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41236,23 +41588,39 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: timeout schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.featurestores.operations.get + Write time series data points of multiple TensorboardTimeSeries in + multiple TensorboardRun's. If any data fail to be ingested, an error is + returned. + operationId: aiplatform.projects.locations.tensorboards.experiments.write + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41264,7 +41632,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse parameters: - in: path name: projectsId @@ -41277,22 +41646,26 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.featurestores.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: + parameters: *ref_1 + patch: + description: Updates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41304,7 +41677,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -41317,41 +41691,40 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.featurestores.operations.wait + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -41364,27 +41737,18 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.operations.list + delete: + description: Deletes a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41396,7 +41760,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41409,37 +41773,28 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: experimentsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.featurestores.operations.cancel + Batch create TensorboardTimeSeries that belong to a + TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41451,7 +41806,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -41464,25 +41820,26 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: parameters: *ref_1 post: - description: Creates a new EntityType in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.create + description: Creates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41494,7 +41851,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -41507,22 +41865,26 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: query - name: entityTypeId + name: tensorboardExperimentId schema: type: string get: - description: Lists EntityTypes in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.list + description: Lists TensorboardExperiments in a Location. + operationId: aiplatform.projects.locations.tensorboards.experiments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -41530,7 +41892,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse parameters: - in: path name: projectsId @@ -41543,7 +41905,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string @@ -41553,27 +41915,30 @@ paths: type: string format: google-fieldmask - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query name: orderBy schema: type: string - in: query - name: filter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: pageToken + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets details of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.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. + operationId: aiplatform.projects.locations.tensorboards.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41585,7 +41950,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41598,20 +41963,69 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string 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. - operationId: aiplatform.projects.locations.featurestores.entityTypes.delete + 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`. + operationId: aiplatform.projects.locations.tensorboards.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: aiplatform.projects.locations.tensorboards.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41636,27 +42050,27 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - in: query - name: force + name: timeout schema: - type: boolean - patch: - description: Updates the parameters of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tensorboards.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41668,7 +42082,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -41681,35 +42095,37 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Reads Feature values of a specific entity of an EntityType. For reading - feature values of multiple entities of an EntityType, please use - StreamingReadFeatureValues. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest + 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`. + operationId: aiplatform.projects.locations.tensorboards.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41721,8 +42137,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41735,26 +42150,23 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions + 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. + operationId: aiplatform.projects.locations.tuningJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41766,7 +42178,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41779,26 +42191,22 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tuningJobsId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - - in: query - name: permissions - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: parameters: *ref_1 - post: + get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41810,7 +42218,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -41823,46 +42231,37 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tuningJobsId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: filter schema: type: string - in: query - name: options.requestedPolicyVersion + name: pageToken + schema: + type: string + - in: query + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest + 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`. + operationId: aiplatform.projects.locations.tuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41874,7 +42273,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41887,35 +42286,20 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tuningJobsId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: parameters: *ref_1 - post: - 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequest + get: + description: Gets a TuningJob. + operationId: aiplatform.projects.locations.tuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41927,7 +42311,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' parameters: - in: path name: projectsId @@ -41940,29 +42324,29 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: parameters: *ref_1 post: description: >- - Reads Feature values for multiple entities. Depending on their size, - data for different entities may be broken up across multiple responses. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues + Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. + 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 + TuningJob is not deleted; instead it becomes a job with a + TuningJob.error value with a google.rpc.Status.code of 1, corresponding + to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.tuningJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1CancelTuningJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41974,8 +42358,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41988,31 +42371,48 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: parameters: *ref_1 post: 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues + Creates a TuningJob. A created TuningJob right away will be attempted to + be run. + operationId: aiplatform.projects.locations.tuningJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + get: + description: Lists TuningJobs in a Location. + operationId: aiplatform.projects.locations.tuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42025,7 +42425,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse + #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse parameters: - in: path name: projectsId @@ -42037,29 +42437,33 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy + Assigns a NotebookRuntime to a user for a particular Notebook file. This + method will either returns an existing assignment or generates a new + one. + operationId: aiplatform.projects.locations.notebookRuntimes.assign requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42071,7 +42475,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42083,28 +42487,17 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: parameters: *ref_1 post: - description: Exports Feature values from all the entities of a target EntityType. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues + description: Starts a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.start requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42129,25 +42522,21 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: notebookRuntimesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: parameters: *ref_1 post: - description: Creates a new Feature in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create + description: Upgrades a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.upgrade requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42172,22 +42561,15 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: notebookRuntimesId required: true schema: type: string - - in: query - name: featureId - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: + parameters: *ref_1 get: - description: Lists Features in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list + description: Lists NotebookRuntimes in a Location. + operationId: aiplatform.projects.locations.notebookRuntimes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42200,7 +42582,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse parameters: - in: path name: projectsId @@ -42212,48 +42594,33 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true + - in: query + name: readMask schema: type: string + format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 - in: query - name: latestStatsCount - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: orderBy + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: parameters: *ref_1 delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.delete + description: Deletes a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42278,28 +42645,13 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: notebookRuntimesId required: true schema: type: string - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + get: + description: Gets a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42311,7 +42663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' parameters: - in: path name: projectsId @@ -42324,28 +42676,19 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: notebookRuntimesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}: + parameters: *ref_1 + 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`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42357,7 +42700,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42370,32 +42713,21 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: notebookRuntimesId required: true schema: type: string - in: path - name: featuresId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: - parameters: *ref_1 - post: - description: Creates a batch of Features in a given EntityType. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest + 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. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42420,25 +42752,22 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimesId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations: parameters: *ref_1 - delete: + get: 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`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42450,7 +42779,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -42463,32 +42792,37 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimesId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: featuresId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: operationsId - required: true + type: integer + format: int32 + - in: query + name: filter schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.get + 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. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42513,40 +42847,34 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: notebookRuntimesId required: true schema: type: string - in: path - name: featuresId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait + 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`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42558,7 +42886,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42571,17 +42899,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: notebookRuntimesId required: true schema: type: string @@ -42590,19 +42908,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.list + operationId: aiplatform.projects.locations.persistentResources.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42627,18 +42939,12 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: persistentResourcesId required: true schema: type: string - - in: path - name: featuresId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -42646,29 +42952,19 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: parameters: *ref_1 - post: + delete: 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`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel + 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`. + operationId: aiplatform.projects.locations.persistentResources.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42693,17 +42989,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: persistentResourcesId required: true schema: type: string @@ -42712,21 +42998,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: + get: 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`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.operations.cancel + 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. + operationId: aiplatform.projects.locations.persistentResources.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42738,7 +43015,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42751,12 +43028,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: persistentResourcesId required: true schema: type: string @@ -42765,13 +43037,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.list + 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. + operationId: aiplatform.projects.locations.persistentResources.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42783,7 +43062,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42796,36 +43075,34 @@ paths: schema: type: string - in: path - name: featurestoresId + name: persistentResourcesId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.get + 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`. + operationId: aiplatform.projects.locations.persistentResources.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42837,7 +43114,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42850,12 +43127,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: persistentResourcesId required: true schema: type: string @@ -42864,14 +43136,16 @@ paths: required: true schema: type: string - 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`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: + parameters: *ref_1 + patch: + description: Updates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42883,7 +43157,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42896,34 +43170,18 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: persistentResourcesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.wait + format: google-fieldmask + delete: + description: Deletes a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42948,30 +43206,52 @@ paths: schema: type: string - in: path - name: featurestoresId + name: persistentResourcesId required: true schema: type: string + get: + description: Gets a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + parameters: - in: path - name: entityTypesId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: persistentResourcesId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: parameters: *ref_1 - get: - description: Lists all the studies in a region for an associated project. - operationId: aiplatform.projects.locations.studies.list + post: + description: Reboots a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.reboot + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42983,8 +43263,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42996,25 +43275,21 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: persistentResourcesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: + parameters: *ref_1 post: - description: >- - Creates a Study. A resource name will be generated after creation of the - Study. - operationId: aiplatform.projects.locations.studies.create + description: Creates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43026,7 +43301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43038,11 +43313,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: - parameters: *ref_1 - delete: - description: Deletes a Study. - operationId: aiplatform.projects.locations.studies.delete + - in: query + name: persistentResourceId + schema: + type: string + get: + description: Lists PersistentResources in a Location. + operationId: aiplatform.projects.locations.persistentResources.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43054,7 +43331,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse parameters: - in: path name: projectsId @@ -43066,14 +43344,22 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: + parameters: *ref_1 get: - description: Gets a Study by name. - operationId: aiplatform.projects.locations.studies.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.migratableResources.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43085,7 +43371,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -43098,22 +43384,37 @@ paths: schema: type: string - in: path - name: studiesId + name: migratableResourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Looks a study up using the user-defined display_name field instead of - the fully qualified resource name. - operationId: aiplatform.projects.locations.studies.lookup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LookupStudyRequest' + 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`. + operationId: aiplatform.projects.locations.migratableResources.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43125,7 +43426,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43137,14 +43438,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: + - in: path + name: migratableResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.studies.trials.operations.get + operationId: aiplatform.projects.locations.migratableResources.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43169,12 +43480,7 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: migratableResourcesId required: true schema: type: string @@ -43189,7 +43495,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.studies.trials.operations.delete + operationId: aiplatform.projects.locations.migratableResources.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43214,12 +43520,7 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: migratableResourcesId required: true schema: type: string @@ -43228,7 +43529,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -43241,7 +43542,7 @@ paths: 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. - operationId: aiplatform.projects.locations.studies.trials.operations.wait + operationId: aiplatform.projects.locations.migratableResources.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43266,12 +43567,7 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: migratableResourcesId required: true schema: type: string @@ -43285,65 +43581,19 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.studies.trials.operations.cancel - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.trials.operations.list + Batch migrates resources from ml.googleapis.com, automl.googleapis.com, + and datalabeling.googleapis.com to Vertex AI. + operationId: aiplatform.projects.locations.migratableResources.batchMigrate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43355,7 +43605,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43367,39 +43617,20 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: parameters: *ref_1 post: - description: Stops a Trial. - operationId: aiplatform.projects.locations.studies.trials.stop + description: >- + 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. + operationId: aiplatform.projects.locations.migratableResources.search requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43411,7 +43642,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse parameters: - in: path name: projectsId @@ -43423,30 +43655,19 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.studies.trials.suggest + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SuggestTrialsRequest' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43458,7 +43679,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -43471,15 +43692,15 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: parameters: *ref_1 - delete: - description: Deletes a Trial. - operationId: aiplatform.projects.locations.studies.trials.delete + get: + description: Lists NotebookRuntimeTemplates in a Location. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43491,7 +43712,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse parameters: - in: path name: projectsId @@ -43503,19 +43725,37 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: pageToken schema: type: string - get: - description: Gets a Trial. - operationId: aiplatform.projects.locations.studies.trials.get + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43527,7 +43767,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43539,21 +43779,15 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true + - in: query + name: notebookRuntimeTemplateId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: parameters: *ref_1 get: - description: Lists the Trials associated with a Study. - operationId: aiplatform.projects.locations.studies.trials.list + description: Gets a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43565,7 +43799,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate parameters: - in: path name: projectsId @@ -43578,27 +43813,19 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: Adds a user provided Trial to a Study. - operationId: aiplatform.projects.locations.studies.trials.create + patch: + description: Updates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43610,7 +43837,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate parameters: - in: path name: projectsId @@ -43623,24 +43851,18 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: - parameters: *ref_1 - post: - description: >- - 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 - operationId: aiplatform.projects.locations.studies.trials.listOptimalTrials - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43652,8 +43874,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43666,20 +43887,21 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: parameters: *ref_1 post: - description: Marks a Trial as complete. - operationId: aiplatform.projects.locations.studies.trials.complete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' + 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. + operationId: >- + aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43691,7 +43913,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -43704,28 +43926,21 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: parameters: *ref_1 post: description: >- - Adds a measurement of the objective metrics to a Trial. This measurement - is assumed to have been taken before the Trial is complete. - operationId: aiplatform.projects.locations.studies.trials.addTrialMeasurement - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddTrialMeasurementRequest + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43737,7 +43952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -43750,30 +43965,29 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - Checks whether a Trial should stop or not. Returns a long-running - operation. When the operation is successful, it will contain a - CheckTrialEarlyStoppingStateResponse. - operationId: >- - aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + 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. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43798,29 +44012,28 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - in: path - name: trialsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}: parameters: *ref_1 - post: + get: 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`. - operationId: aiplatform.projects.locations.studies.operations.cancel + 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. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43832,7 +44045,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43845,7 +44058,7 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -43854,20 +44067,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: + delete: 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. - operationId: aiplatform.projects.locations.studies.operations.wait + 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`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43879,7 +44085,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43892,7 +44098,7 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -43901,19 +44107,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.studies.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43925,7 +44125,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -43938,22 +44138,37 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - delete: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: 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`. - operationId: aiplatform.projects.locations.studies.operations.delete + 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`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43978,7 +44193,7 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -43987,13 +44202,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.operations.list + Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from + it, and freeing all resources it's using. + operationId: aiplatform.projects.locations.indexEndpoints.undeployIndex + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44005,7 +44225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44018,33 +44238,22 @@ paths: schema: type: string - in: path - name: studiesId + name: indexEndpointsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: parameters: *ref_1 post: - description: Finds the nearest neighbors of each vector within the request. - operationId: aiplatform.projects.locations.indexEndpoints.findNeighbors + description: >- + Deploys an Index into this IndexEndpoint, creating a DeployedIndex + within it. Only non-empty Indexes can be deployed. + operationId: aiplatform.projects.locations.indexEndpoints.deployIndex requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployIndexRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44056,8 +44265,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44074,16 +44282,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: parameters: *ref_1 - post: - description: Creates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + delete: + description: Deletes an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44107,9 +44310,14 @@ paths: required: true schema: type: string + - in: path + name: indexEndpointsId + required: true + schema: + type: string get: - description: Lists IndexEndpoints in a Location. - operationId: aiplatform.projects.locations.indexEndpoints.list + description: Gets an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44121,8 +44329,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path name: projectsId @@ -44134,34 +44341,19 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: indexEndpointsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: - parameters: *ref_1 - post: - description: Update an existing DeployedIndex under an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex + patch: + description: Updates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44173,7 +44365,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path name: projectsId @@ -44190,6 +44382,11 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: parameters: *ref_1 post: @@ -44232,18 +44429,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: parameters: *ref_1 post: - description: >- - Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from - it, and freeing all resources it's using. - operationId: aiplatform.projects.locations.indexEndpoints.undeployIndex + description: Update an existing DeployedIndex under an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44272,18 +44467,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: parameters: *ref_1 post: - description: >- - Deploys an Index into this IndexEndpoint, creating a DeployedIndex - within it. Only non-empty Indexes can be deployed. - operationId: aiplatform.projects.locations.indexEndpoints.deployIndex + description: Finds the nearest neighbors of each vector within the request. + operationId: aiplatform.projects.locations.indexEndpoints.findNeighbors requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployIndexRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44295,7 +44488,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse parameters: - in: path name: projectsId @@ -44312,11 +44506,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: parameters: *ref_1 - patch: - description: Updates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.patch + post: + description: Creates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.create requestBody: content: application/json: @@ -44333,7 +44527,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44345,19 +44539,9 @@ paths: required: true schema: type: string - - in: path - name: indexEndpointsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask get: - description: Gets an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.get + description: Lists IndexEndpoints in a Location. + operationId: aiplatform.projects.locations.indexEndpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44369,7 +44553,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse parameters: - in: path name: projectsId @@ -44381,14 +44566,31 @@ paths: required: true schema: type: string - - in: path - name: indexEndpointsId - required: true + - in: query + name: filter schema: type: string - delete: - description: Deletes an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.delete + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.indexEndpoints.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44400,7 +44602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -44417,6 +44619,19 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: parameters: *ref_1 delete: @@ -44597,13 +44812,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.list + delete: + description: Deletes a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44615,7 +44828,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44628,28 +44841,13 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: dataLabelingJobsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: - parameters: *ref_1 get: - description: List DeploymentResourcePools in a location. - operationId: aiplatform.projects.locations.deploymentResourcePools.list + description: Gets a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44661,8 +44859,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -44674,24 +44871,22 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: dataLabelingJobsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: + parameters: *ref_1 post: - description: Create a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.create + description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. + operationId: aiplatform.projects.locations.dataLabelingJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest + #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44703,7 +44898,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -44715,11 +44910,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: + - in: path + name: dataLabelingJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: parameters: *ref_1 get: - description: Get a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.get + description: Lists DataLabelingJobs in a Location. + operationId: aiplatform.projects.locations.dataLabelingJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44732,7 +44932,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool + #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse parameters: - in: path name: projectsId @@ -44744,14 +44944,36 @@ paths: required: true schema: type: string - - in: path - name: deploymentResourcePoolsId - required: true + - in: query + name: readMask schema: type: string - delete: - description: Delete a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.delete + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + post: + description: Creates a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44763,7 +44985,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -44775,20 +44997,20 @@ paths: required: true schema: type: string - - in: path - name: deploymentResourcePoolsId - required: true - schema: - type: string - patch: - description: Update a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44813,23 +45035,27 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: dataLabelingJobsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: parameters: *ref_1 get: description: >- - List DeployedModels that have been deployed on this - DeploymentResourcePool. - operationId: >- - aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44841,8 +45067,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -44855,28 +45080,37 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: dataLabelingJobsId required: true schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 - delete: + post: 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`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.delete + 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`. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44901,7 +45135,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: dataLabelingJobsId required: true schema: type: string @@ -44910,12 +45144,14 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: + parameters: *ref_1 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. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.get + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44940,7 +45176,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: dataLabelingJobsId required: true schema: type: string @@ -44949,13 +45185,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: - parameters: *ref_1 - get: + delete: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.list + 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`. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44967,7 +45203,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -44980,37 +45216,24 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: dataLabelingJobsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: parameters: *ref_1 - post: + delete: 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`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.cancel + 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`. + operationId: aiplatform.projects.locations.customJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45035,7 +45258,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: customJobsId required: true schema: type: string @@ -45044,20 +45267,59 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.wait + 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. + operationId: aiplatform.projects.locations.customJobs.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: customJobsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.customJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45069,7 +45331,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45082,7 +45344,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: customJobsId required: true schema: type: string @@ -45091,16 +45353,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: parameters: *ref_1 get: - description: Gets a NasTrialDetail. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.customJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45112,7 +45371,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -45125,20 +45384,37 @@ paths: schema: type: string - in: path - name: nasJobsId + name: customJobsId required: true schema: type: string - - in: path - name: nasTrialDetailsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: List top NasTrialDetails of a NasJob. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list + post: + 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. + operationId: aiplatform.projects.locations.customJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45150,8 +45426,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45164,29 +45439,32 @@ paths: schema: type: string - in: path - name: nasJobsId + name: customJobsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/customJobs: parameters: *ref_1 post: - description: Creates a NasJob - operationId: aiplatform.projects.locations.nasJobs.create + description: >- + Creates a CustomJob. A created CustomJob right away will be attempted to + be run. + operationId: aiplatform.projects.locations.customJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45198,7 +45476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -45211,8 +45489,8 @@ paths: schema: type: string get: - description: Lists NasJobs in a Location. - operationId: aiplatform.projects.locations.nasJobs.list + description: Lists CustomJobs in a Location. + operationId: aiplatform.projects.locations.customJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45225,7 +45503,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse parameters: - in: path name: projectsId @@ -45237,14 +45515,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - in: query name: readMask schema: @@ -45255,11 +45525,19 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: parameters: *ref_1 - delete: - description: Deletes a NasJob. - operationId: aiplatform.projects.locations.nasJobs.delete + get: + description: Gets a CustomJob. + operationId: aiplatform.projects.locations.customJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45271,7 +45549,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -45284,29 +45562,25 @@ paths: schema: type: string - in: path - name: nasJobsId + name: customJobsId required: true schema: type: string - get: - description: Gets a NasJob - operationId: aiplatform.projects.locations.nasJobs.get + delete: + description: Deletes a CustomJob. + operationId: aiplatform.projects.locations.customJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45319,28 +45593,29 @@ paths: schema: type: string - in: path - name: nasJobsId + name: customJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: parameters: *ref_1 post: description: >- - 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 + 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 NasJob is not - deleted; instead it becomes a job with a NasJob.error value with a + 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 - NasJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.nasJobs.cancel + CustomJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.customJobs.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelCustomJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45365,21 +45640,18 @@ paths: schema: type: string - in: path - name: nasJobsId + name: customJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. - operationId: aiplatform.projects.locations.dataLabelingJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest + 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. + operationId: aiplatform.projects.locations.trainingPipelines.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45391,7 +45663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45404,15 +45676,22 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: - parameters: *ref_1 - get: - description: Lists DataLabelingJobs in a Location. - operationId: aiplatform.projects.locations.dataLabelingJobs.list + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: aiplatform.projects.locations.trainingPipelines.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45424,8 +45703,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45437,64 +45715,30 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - post: - description: Creates a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' - parameters: - in: path - name: projectsId + name: trainingPipelinesId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: Gets a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.get + post: + 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. + operationId: aiplatform.projects.locations.trainingPipelines.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45506,7 +45750,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45519,42 +45763,21 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId - required: true - schema: - type: string - delete: - description: Deletes a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId + name: trainingPipelinesId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - - in: path - name: dataLabelingJobsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -45567,7 +45790,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.cancel + operationId: aiplatform.projects.locations.trainingPipelines.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45592,7 +45815,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: trainingPipelinesId required: true schema: type: string @@ -45601,15 +45824,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: parameters: *ref_1 - delete: + get: 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`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.trainingPipelines.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45621,7 +45842,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -45634,21 +45855,35 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: trainingPipelinesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - get: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.get + Creates a TrainingPipeline. A created TrainingPipeline right away will + be attempted to be run. + operationId: aiplatform.projects.locations.trainingPipelines.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45660,7 +45895,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' parameters: - in: path name: projectsId @@ -45672,23 +45907,9 @@ paths: required: true schema: type: string - - in: path - name: dataLabelingJobsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: - parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.list + description: Lists TrainingPipelines in a Location. + operationId: aiplatform.projects.locations.trainingPipelines.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45700,7 +45921,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse parameters: - in: path name: projectsId @@ -45712,15 +45934,6 @@ paths: required: true schema: type: string - - in: path - name: dataLabelingJobsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: @@ -45730,20 +45943,20 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.wait + get: + description: Gets a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45755,7 +45968,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' parameters: - in: path name: projectsId @@ -45768,35 +45981,13 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: trainingPipelinesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel + delete: + description: Deletes a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45808,7 +45999,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45821,23 +46012,30 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list + 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`. + operationId: aiplatform.projects.locations.trainingPipelines.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45849,7 +46047,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45862,33 +46060,18 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: trainingPipelinesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: parameters: *ref_1 - delete: + get: 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`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete + 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. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45900,7 +46083,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45913,7 +46096,7 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -45922,13 +46105,13 @@ paths: required: true schema: type: string - get: + delete: 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. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get + 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`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45940,7 +46123,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45953,7 +46136,7 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -45962,7 +46145,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -45975,8 +46158,7 @@ paths: 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. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46001,7 +46183,7 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -46015,11 +46197,20 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: - description: Lists ModelDeploymentMonitoringJobs in a Location. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list + post: + 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`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46031,8 +46222,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -46044,35 +46234,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: deploymentResourcePoolsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - post: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: + parameters: *ref_1 + get: description: >- - Creates a ModelDeploymentMonitoringJob. It will run periodically on a - configured interval. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46084,8 +46262,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -46097,11 +46274,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: + - in: path + name: deploymentResourcePoolsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: parameters: *ref_1 get: - description: Gets a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get + description: List DeploymentResourcePools in a location. + operationId: aiplatform.projects.locations.deploymentResourcePools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46114,7 +46309,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse parameters: - in: path name: projectsId @@ -46126,20 +46321,24 @@ paths: required: true schema: type: string - - in: path - name: modelDeploymentMonitoringJobsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: - description: Updates a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch + post: + description: Create a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46163,19 +46362,57 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: + parameters: *ref_1 + get: + description: >- + List DeployedModels that have been deployed on this + DeploymentResourcePool. + operationId: >- + aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: modelDeploymentMonitoringJobsId + name: locationsId + required: true + schema: + type: string + - in: path + name: deploymentResourcePoolsId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: + parameters: *ref_1 delete: - description: Deletes a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete + description: Delete a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46200,24 +46437,19 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: deploymentResourcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: - parameters: *ref_1 - post: - description: >- - Resumes a paused ModelDeploymentMonitoringJob. It will start to run from - next scheduled time. A deleted ModelDeploymentMonitoringJob can't be - resumed. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume + patch: + description: Update a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46229,7 +46461,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46242,24 +46474,18 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: deploymentResourcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: - parameters: *ref_1 - post: - description: >- - Searches Model Monitoring Statistics generated within a given time - window. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Get a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46272,7 +46498,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool parameters: - in: path name: projectsId @@ -46285,24 +46511,21 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: deploymentResourcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: parameters: *ref_1 post: - description: >- - Pauses a ModelDeploymentMonitoringJob. If the job is running, the server - makes a best effort to cancel the job. Will mark - ModelDeploymentMonitoringJob.state to 'PAUSED'. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause + description: Add/update Datapoints into an Index. + operationId: aiplatform.projects.locations.indexes.upsertDatapoints requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46314,7 +46537,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse parameters: - in: path name: projectsId @@ -46327,15 +46551,20 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: parameters: *ref_1 - get: - description: Gets a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.get + patch: + description: Updates an Index. + operationId: aiplatform.projects.locations.indexes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46347,7 +46576,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46360,26 +46589,20 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string - - in: path - name: evaluationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: - parameters: *ref_1 - post: - description: Imports an externally generated ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.import - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest + format: google-fieldmask + delete: + description: >- + Deletes an Index. An Index can only be deleted when all its + DeployedIndexes had been undeployed. + operationId: aiplatform.projects.locations.indexes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46391,7 +46614,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46404,15 +46627,13 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: - parameters: *ref_1 get: - description: Lists ModelEvaluations in a Model. - operationId: aiplatform.projects.locations.models.evaluations.list + description: Gets an Index. + operationId: aiplatform.projects.locations.indexes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46424,8 +46645,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' parameters: - in: path name: projectsId @@ -46438,33 +46658,15 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: + /v1/projects/{projectsId}/locations/{locationsId}/indexes: parameters: *ref_1 get: - description: Lists ModelEvaluationSlices in a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.slices.list + description: Lists Indexes in a Location. + operationId: aiplatform.projects.locations.indexes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46477,7 +46679,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse + #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse parameters: - in: path name: projectsId @@ -46489,25 +46691,11 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - in: query name: readMask schema: @@ -46517,17 +46705,18 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: - parameters: *ref_1 + - in: query + name: filter + schema: + type: string post: - description: Imports a list of externally generated EvaluatedAnnotations. - operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport + description: Creates an Index. + operationId: aiplatform.projects.locations.indexes.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46539,8 +46728,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46552,26 +46740,17 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: path - name: slicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: parameters: *ref_1 - get: - description: Gets a ModelEvaluationSlice. - operationId: aiplatform.projects.locations.models.evaluations.slices.get + post: + description: Remove Datapoints from an Index. + operationId: aiplatform.projects.locations.indexes.removeDatapoints + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46584,7 +46763,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse parameters: - in: path name: projectsId @@ -46597,27 +46776,17 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: path - name: slicesId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.evaluations.operations.list + operationId: aiplatform.projects.locations.indexes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46642,17 +46811,12 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: indexesId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -46661,114 +46825,18 @@ paths: type: integer format: int32 - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: - parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.models.evaluations.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - 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`. - operationId: aiplatform.projects.locations.models.evaluations.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.models.evaluations.operations.cancel + 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`. + operationId: aiplatform.projects.locations.indexes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46793,12 +46861,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: indexesId required: true schema: type: string @@ -46807,20 +46870,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.models.evaluations.operations.wait + 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. + operationId: aiplatform.projects.locations.indexes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46845,12 +46900,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: indexesId required: true schema: type: string @@ -46859,12 +46909,7 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -46877,7 +46922,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.models.operations.cancel + operationId: aiplatform.projects.locations.indexes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46902,7 +46947,7 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string @@ -46911,7 +46956,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -46924,7 +46969,7 @@ paths: 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. - operationId: aiplatform.projects.locations.models.operations.wait + operationId: aiplatform.projects.locations.indexes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46949,7 +46994,7 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string @@ -46963,13 +47008,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.operations.list + description: Lists MetadataStores for a Location. + operationId: aiplatform.projects.locations.metadataStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46981,7 +47024,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse parameters: - in: path name: projectsId @@ -46993,9 +47037,8 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -47003,23 +47046,14 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: - parameters: *ref_1 - 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`. - operationId: aiplatform.projects.locations.models.operations.delete + post: + description: Initializes a MetadataStore, including allocation of resources. + operationId: aiplatform.projects.locations.metadataStores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47031,7 +47065,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47043,22 +47077,15 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: metadataStoreId schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: + parameters: *ref_1 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. - operationId: aiplatform.projects.locations.models.operations.get + description: Retrieves a specific MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47070,7 +47097,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' parameters: - in: path name: projectsId @@ -47083,20 +47110,15 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: - parameters: *ref_1 - get: - description: Gets a Model. - operationId: aiplatform.projects.locations.models.get + delete: + description: >- + Deletes a single MetadataStore and all its child resources (Artifacts, + Executions, and Contexts). + operationId: aiplatform.projects.locations.metadataStores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47108,7 +47130,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47121,15 +47143,28 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - delete: + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Deletes a Model. A model cannot be deleted if any Endpoint resource has - a DeployedModel based on the model in its deployed_models field. - operationId: aiplatform.projects.locations.models.delete + 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`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47141,7 +47176,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47154,18 +47189,28 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - patch: - description: Updates a Model. - operationId: aiplatform.projects.locations.models.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + - in: path + name: artifactsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47177,7 +47222,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47190,20 +47235,27 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: artifactsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: - parameters: *ref_1 - get: - description: Lists versions of the specified model. - operationId: aiplatform.projects.locations.models.listVersions + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47215,8 +47267,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47229,39 +47280,27 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: artifactsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: parameters: *ref_1 - post: + get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.models.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47273,7 +47312,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -47286,26 +47325,42 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: pageToken + schema: + type: string + - in: query + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Merges a set of aliases for a Model version. - operationId: aiplatform.projects.locations.models.mergeVersionAliases - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MergeVersionAliasesRequest + 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. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47317,7 +47372,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47330,59 +47385,30 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: - parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.models.export - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportModelRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: artifactsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: parameters: *ref_1 delete: - description: >- - 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. - operationId: aiplatform.projects.locations.models.deleteVersion + description: Deletes an Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47407,61 +47433,27 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:copy: - parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.models.copy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: artifactsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: etag schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.models.setIamPolicy + patch: + description: Updates a stored Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47473,7 +47465,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -47486,54 +47478,27 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: - parameters: *ref_1 - post: - description: Incrementally update the dataset used for an examples model. - operationId: aiplatform.projects.locations.models.updateExplanationDataset - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpdateExplanationDatasetRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: artifactsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: allowMissing schema: - type: string - - in: path - name: modelsId - required: true + type: boolean + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models: - parameters: *ref_1 + format: google-fieldmask get: - description: Lists Models in a Location. - operationId: aiplatform.projects.locations.models.list + description: Retrieves a specific Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47545,7 +47510,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -47557,38 +47522,27 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + - in: path + name: metadataStoresId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + - in: path + name: artifactsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.models.testIamPermissions + description: Purges Artifacts. + operationId: aiplatform.projects.locations.metadataStores.artifacts.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47600,7 +47554,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47613,24 +47567,20 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - - in: query - name: permissions - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:upload: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: parameters: *ref_1 post: - description: Uploads a Model artifact into Vertex AI. - operationId: aiplatform.projects.locations.models.upload + description: Creates an Artifact associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47642,7 +47592,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -47654,11 +47604,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: - parameters: *ref_1 + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: query + name: artifactId + schema: + type: string get: - description: Gets a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.get + description: Lists Artifacts in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47670,7 +47627,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse parameters: - in: path name: projectsId @@ -47683,18 +47641,35 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - patch: - description: Updates a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: + parameters: *ref_1 + get: + description: >- + Retrieves lineage of an Artifact represented through Artifacts and + Executions connected by Event edges and returned as a LineageSubgraph. + operationId: >- + aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47706,7 +47681,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -47719,18 +47694,34 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - delete: - description: Deletes a SpecialistPool as well as all Specialists in the pool. - operationId: aiplatform.projects.locations.specialistPools.delete + - in: query + name: maxHops + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: + parameters: *ref_1 + post: + description: Creates a MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47742,7 +47733,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -47755,19 +47746,17 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - in: query - name: force + name: metadataSchemaId schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: - parameters: *ref_1 + type: string get: - description: Lists SpecialistPools in a Location. - operationId: aiplatform.projects.locations.specialistPools.list + description: Lists MetadataSchemas. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47780,7 +47769,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse + #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse parameters: - in: path name: projectsId @@ -47792,11 +47781,11 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: metadataStoresId + required: true schema: type: string - format: google-fieldmask - in: query name: pageSize schema: @@ -47806,14 +47795,15 @@ paths: name: pageToken schema: type: string - post: - description: Creates a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: + parameters: *ref_1 + get: + description: Retrieves a specific MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47825,7 +47815,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -47837,14 +47827,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: metadataSchemasId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.specialistPools.operations.get + operationId: aiplatform.projects.locations.metadataStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47869,7 +47869,7 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string @@ -47884,7 +47884,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.specialistPools.operations.delete + operationId: aiplatform.projects.locations.metadataStores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47909,7 +47909,7 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string @@ -47918,20 +47918,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.specialistPools.operations.cancel + 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. + operationId: aiplatform.projects.locations.metadataStores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47943,7 +47943,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47956,7 +47956,7 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string @@ -47965,20 +47965,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.specialistPools.operations.wait + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47990,7 +47988,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -48003,27 +48001,37 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: timeout + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.specialistPools.operations.list + 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`. + operationId: aiplatform.projects.locations.metadataStores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48035,7 +48043,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -48048,24 +48056,16 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -48078,7 +48078,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.cancel + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48103,7 +48103,12 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId required: true schema: type: string @@ -48112,14 +48117,67 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.pipelineJobs.operations.get + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48144,7 +48202,12 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId required: true schema: type: string @@ -48159,7 +48222,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.delete + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48184,7 +48247,12 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId required: true schema: type: string @@ -48193,7 +48261,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -48206,7 +48274,7 @@ paths: 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. - operationId: aiplatform.projects.locations.pipelineJobs.operations.wait + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48231,7 +48299,12 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId required: true schema: type: string @@ -48245,13 +48318,14 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.list + Retrieves Artifacts and Executions within the specified Context, + connected by Event edges and returned as a LineageSubgraph. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48263,7 +48337,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -48276,37 +48350,30 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: contextsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.pipelineJobs.batchDelete + 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. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48318,7 +48385,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse parameters: - in: path name: projectsId @@ -48330,11 +48398,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: parameters: *ref_1 - delete: - description: Deletes a PipelineJob. - operationId: aiplatform.projects.locations.pipelineJobs.delete + get: + description: Retrieves a specific Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48346,7 +48424,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -48359,13 +48437,18 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - get: - description: Gets a PipelineJob. - operationId: aiplatform.projects.locations.pipelineJobs.get + - in: path + name: contextsId + required: true + schema: + type: string + delete: + description: Deletes a stored Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48377,7 +48460,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48390,30 +48473,31 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: - parameters: *ref_1 - post: - description: >- - 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`. - operationId: aiplatform.projects.locations.pipelineJobs.cancel + - in: path + name: contextsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: force + schema: + type: boolean + patch: + description: Updates a stored Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48425,7 +48509,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -48438,27 +48522,39 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: + - in: path + name: contextsId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.pipelineJobs.batchCancel + 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. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.removeContextChildren requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48470,7 +48566,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse parameters: - in: path name: projectsId @@ -48482,46 +48579,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: - parameters: *ref_1 - post: - description: Creates a PipelineJob. A PipelineJob will run immediately when created. - operationId: aiplatform.projects.locations.pipelineJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: metadataStoresId required: true schema: type: string - - in: query - name: pipelineJobId + - in: path + name: contextsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts: + parameters: *ref_1 get: - description: Lists PipelineJobs in a Location. - operationId: aiplatform.projects.locations.pipelineJobs.list + description: Lists Contexts on the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.contexts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48534,7 +48606,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListContextsResponse parameters: - in: path name: projectsId @@ -48546,8 +48618,9 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: metadataStoresId + required: true schema: type: string - in: query @@ -48555,10 +48628,9 @@ paths: schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - in: query name: pageToken schema: @@ -48568,15 +48640,14 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: - parameters: *ref_1 - 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`. - operationId: aiplatform.projects.locations.featureGroups.operations.delete + post: + description: Creates a Context associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.contexts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48588,7 +48659,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -48601,21 +48672,24 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: contextId schema: 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. - operationId: aiplatform.projects.locations.featureGroups.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge: + parameters: *ref_1 + post: + description: Purges Contexts. + operationId: aiplatform.projects.locations.metadataStores.contexts.purge + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PurgeContextsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48640,29 +48714,26 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.featureGroups.operations.wait + 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. + operationId: aiplatform.projects.locations.metadataStores.contexts.addContextChildren + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48674,7 +48745,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenResponse parameters: - in: path name: projectsId @@ -48687,25 +48759,24 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: contextsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: + parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.operations.listWait + Obtains the set of input and output Artifacts for this Execution, in the + form of LineageSubgraph that also contains the Execution and connecting + Events. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48717,7 +48788,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -48730,42 +48801,25 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.featureGroups.features.operations.wait + description: Creates an Execution associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48777,7 +48831,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -48790,30 +48844,17 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true - schema: - type: string - - in: path - name: operationsId + name: metadataStoresId required: true schema: type: string - in: query - name: timeout + name: executionId schema: type: string - format: google-duration get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait + description: Lists Executions in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48825,7 +48866,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse parameters: - in: path name: projectsId @@ -48838,41 +48880,37 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - - in: path - name: featuresId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: operationsId - required: true + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - in: query name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.featureGroups.features.operations.get + patch: + description: Updates a stored Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48884,7 +48922,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -48897,27 +48935,27 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - in: path - name: featuresId + name: executionsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - 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`. - operationId: aiplatform.projects.locations.featureGroups.features.operations.delete + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean + get: + description: Retrieves a specific Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48929,7 +48967,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -48942,25 +48980,18 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: - parameters: *ref_1 - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.get + delete: + description: Deletes an Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48972,7 +49003,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48985,18 +49016,30 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - in: path - name: featuresId + name: executionsId required: true schema: type: string - delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.delete + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: + parameters: *ref_1 + post: + description: Purges Executions. + operationId: aiplatform.projects.locations.metadataStores.executions.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49021,23 +49064,26 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: metadataStoresId required: true schema: type: string - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.patch + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: + parameters: *ref_1 + post: + description: >- + 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. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.addExecutionEvents requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49049,7 +49095,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse parameters: - in: path name: projectsId @@ -49062,30 +49109,29 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - in: path - name: featuresId + name: executionsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Creates a new Feature in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + 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. + operationId: aiplatform.projects.locations.metadataStores.executions.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49110,17 +49156,33 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: featureId + name: timeout schema: type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Lists Features in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.list + 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. + operationId: aiplatform.projects.locations.metadataStores.executions.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49132,8 +49194,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49146,47 +49207,81 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - - in: query - name: readMask + - in: path + name: executionsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: latestStatsCount + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 - - in: query - name: filter + type: string + 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`. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: metadataStoresId + required: true schema: - type: integer - format: int32 - - in: query - name: orderBy + type: string + - in: path + name: executionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: parameters: *ref_1 - patch: - description: Updates the parameters of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + post: + 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`. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49198,7 +49293,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -49211,18 +49306,27 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: executionsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.delete + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.executions.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49234,7 +49338,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -49247,17 +49351,42 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: executionsId required: true schema: type: string - in: query - name: force + name: pageToken schema: - type: boolean - get: - description: Gets details of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.get + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49269,7 +49398,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -49282,20 +49411,24 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Creates a new FeatureGroup in a given project and location. - operationId: aiplatform.projects.locations.featureGroups.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + 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`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49307,7 +49440,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -49319,13 +49452,22 @@ paths: required: true schema: type: string - - in: query - name: featureGroupId + - in: path + name: pipelineJobsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string get: - description: Lists FeatureGroups in a given project and location. - operationId: aiplatform.projects.locations.featureGroups.list + 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. + operationId: aiplatform.projects.locations.pipelineJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49337,8 +49479,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49350,28 +49491,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: pipelineJobsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: parameters: *ref_1 get: - description: Lists MetadataSchemas. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49383,8 +49519,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -49397,7 +49532,7 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: pipelineJobsId required: true schema: type: string @@ -49414,14 +49549,20 @@ paths: schema: type: integer format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Creates a MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + 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. + operationId: aiplatform.projects.locations.pipelineJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49433,7 +49574,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49446,19 +49587,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: pipelineJobsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: metadataSchemaId + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: parameters: *ref_1 get: - description: Retrieves a specific MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get + description: Gets a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49470,7 +49617,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' parameters: - in: path name: projectsId @@ -49483,22 +49630,13 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: metadataSchemasId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.operations.list + delete: + description: Deletes a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49510,7 +49648,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49523,32 +49661,30 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: pipelineJobsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: parameters: *ref_1 - delete: + post: 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`. - operationId: aiplatform.projects.locations.metadataStores.operations.delete + 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`. + operationId: aiplatform.projects.locations.pipelineJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49573,21 +49709,27 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: operationsId + name: pipelineJobsId required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.metadataStores.operations.get + 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. + operationId: aiplatform.projects.locations.pipelineJobs.batchCancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49611,30 +49753,11 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.metadataStores.operations.wait + get: + description: Lists PipelineJobs in a Location. + operationId: aiplatform.projects.locations.pipelineJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49646,7 +49769,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse parameters: - in: path name: projectsId @@ -49658,35 +49782,36 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: orderBy schema: type: string - in: query - name: timeout + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: - parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.metadataStores.operations.cancel + description: Creates a PipelineJob. A PipelineJob will run immediately when created. + operationId: aiplatform.projects.locations.pipelineJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49698,7 +49823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' parameters: - in: path name: projectsId @@ -49710,25 +49835,24 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: pipelineJobId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: parameters: *ref_1 - delete: + post: 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`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.delete + 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. + operationId: aiplatform.projects.locations.pipelineJobs.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49740,7 +49864,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49752,39 +49876,73 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: + parameters: *ref_1 + post: + description: >- + 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`. + operationId: aiplatform.projects.locations.nasJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: - in: path - name: metadataStoresId + name: projectsId required: true schema: type: string - in: path - name: artifactsId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: nasJobsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: + parameters: *ref_1 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. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.get + description: Gets a NasJob + operationId: aiplatform.projects.locations.nasJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -49797,27 +49955,46 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: nasJobsId + required: true + schema: + type: string + delete: + description: Deletes a NasJob. + operationId: aiplatform.projects.locations.nasJobs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: artifactsId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: nasJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.list + description: Lists NasJobs in a Location. + operationId: aiplatform.projects.locations.nasJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49829,7 +50006,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse parameters: - in: path name: projectsId @@ -49841,20 +50019,11 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId - required: true - schema: - type: string - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query name: pageSize schema: @@ -49864,20 +50033,18 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string post: - 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. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.wait + description: Creates a NasJob + operationId: aiplatform.projects.locations.nasJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49889,7 +50056,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -49901,40 +50068,11 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.cancel + get: + description: List top NasTrialDetails of a NasJob. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49946,7 +50084,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse parameters: - in: path name: projectsId @@ -49959,25 +50098,24 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: nasJobsId required: true schema: type: string - - in: path - name: artifactsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: operationsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: parameters: *ref_1 - get: - description: Retrieves a specific Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.get + get: + description: Gets a NasTrialDetail. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49989,7 +50127,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' parameters: - in: path name: projectsId @@ -50002,23 +50140,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: nasJobsId required: true schema: type: string - in: path - name: artifactsId + name: nasTrialDetailsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: + parameters: *ref_1 patch: - description: Updates a stored Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.patch + description: Updates a Model. + operationId: aiplatform.projects.locations.models.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50030,7 +50170,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -50043,12 +50183,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: modelsId required: true schema: type: string @@ -50057,13 +50192,11 @@ paths: schema: type: string format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean delete: - description: Deletes an Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.delete + description: >- + Deletes a Model. A model cannot be deleted if any Endpoint resource has + a DeployedModel based on the model in its deployed_models field. + operationId: aiplatform.projects.locations.models.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50088,30 +50221,13 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: modelsId required: true schema: type: string - - in: query - name: etag - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: - parameters: *ref_1 - post: - description: Purges Artifacts. - operationId: aiplatform.projects.locations.metadataStores.artifacts.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest + get: + description: Gets a Model. + operationId: aiplatform.projects.locations.models.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50123,7 +50239,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -50136,18 +50252,15 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: + /v1/projects/{projectsId}/locations/{locationsId}/models: parameters: *ref_1 get: - description: >- - Retrieves lineage of an Artifact represented through Artifacts and - Executions connected by Event edges and returned as a LineageSubgraph. - operationId: >- - aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph + description: Lists Models in a Location. + operationId: aiplatform.projects.locations.models.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50159,7 +50272,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' parameters: - in: path name: projectsId @@ -50171,30 +50284,39 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask schema: type: string - - in: path - name: artifactsId - required: true + format: google-fieldmask + - in: query + name: filter schema: type: string - in: query - name: maxHops + name: orderBy schema: - type: integer - format: int32 + type: string - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: parameters: *ref_1 - get: - description: Lists Artifacts in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.list + post: + description: Merges a set of aliases for a Model version. + operationId: aiplatform.projects.locations.models.mergeVersionAliases + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MergeVersionAliasesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50206,8 +50328,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -50220,35 +50341,17 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: + parameters: *ref_1 post: - description: Creates an Artifact associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.models.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50260,7 +50363,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -50273,28 +50376,28 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: query - name: artifactId + name: options.requestedPolicyVersion schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.cancel + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.models.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50306,7 +50409,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -50319,34 +50422,56 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/models:upload: + parameters: *ref_1 + post: + description: Uploads a Model artifact into Vertex AI. + operationId: aiplatform.projects.locations.models.upload + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: contextsId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.wait + 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. + operationId: aiplatform.projects.locations.models.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50371,34 +50496,15 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: parameters: *ref_1 - 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`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.delete + get: + description: Lists versions of the specified model. + operationId: aiplatform.projects.locations.models.listVersions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50410,7 +50516,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse parameters: - in: path name: projectsId @@ -50423,26 +50530,43 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - - in: path - name: contextsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: orderBy schema: 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. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: + parameters: *ref_1 + post: + description: Incrementally update the dataset used for an examples model. + operationId: aiplatform.projects.locations.models.updateExplanationDataset + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpdateExplanationDatasetRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50467,27 +50591,20 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.list + 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. + operationId: aiplatform.projects.locations.models.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50499,7 +50616,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -50512,33 +50629,22 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId + name: modelsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: parameters: *ref_1 delete: - description: Deletes a stored Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.delete + description: >- + 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. + operationId: aiplatform.projects.locations.models.deleteVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50563,31 +50669,25 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId + name: modelsId required: true schema: type: string - - in: query - name: etag - schema: - type: string - - in: query - name: force - schema: - type: boolean - patch: - description: Updates a stored Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.patch + /v1/projects/{projectsId}/locations/{locationsId}/models:copy: + parameters: *ref_1 + post: + description: >- + 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. + operationId: aiplatform.projects.locations.models.copy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50599,7 +50699,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50611,28 +50711,20 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Retrieves a specific Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.get + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: aiplatform.projects.locations.models.evaluations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50644,7 +50736,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50657,31 +50749,39 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: path - name: contextsId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.metadataStores.contexts.addContextChildren - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenRequest + 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`. + operationId: aiplatform.projects.locations.models.evaluations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50693,8 +50793,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50707,25 +50806,29 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: path - name: contextsId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Creates a Context associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.contexts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + 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`. + operationId: aiplatform.projects.locations.models.evaluations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50737,7 +50840,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50750,17 +50853,26 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - - in: query - name: contextId + - in: path + name: evaluationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string get: - description: Lists Contexts on the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.contexts.list + 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. + operationId: aiplatform.projects.locations.models.evaluations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50772,8 +50884,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListContextsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50786,37 +50897,27 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: evaluationsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: parameters: *ref_1 - post: - description: Purges Contexts. - operationId: aiplatform.projects.locations.metadataStores.contexts.purge - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PurgeContextsRequest' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.models.evaluations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50828,7 +50929,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -50841,18 +50942,33 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: + - in: path + name: evaluationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: parameters: *ref_1 get: - description: >- - Retrieves Artifacts and Executions within the specified Context, - connected by Event edges and returned as a LineageSubgraph. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph + description: Lists ModelEvaluationSlices in a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.slices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50864,7 +50980,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse parameters: - in: path name: projectsId @@ -50877,30 +50994,44 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: path - name: contextsId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: parameters: *ref_1 post: - description: >- - 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. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.removeContextChildren + description: Imports a list of externally generated EvaluatedAnnotations. + operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50913,7 +51044,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse parameters: - in: path name: projectsId @@ -50926,30 +51057,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: path - name: contextsId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: + - in: path + name: slicesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: parameters: *ref_1 - post: - description: >- - 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. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest + get: + description: Gets a ModelEvaluationSlice. + operationId: aiplatform.projects.locations.models.evaluations.slices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50962,7 +51088,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice parameters: - in: path name: projectsId @@ -50975,31 +51101,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: path - name: contextsId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: + - in: path + name: slicesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: parameters: *ref_1 - post: - description: >- - 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. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.addExecutionEvents - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest + get: + description: Gets a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51011,8 +51131,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' parameters: - in: path name: projectsId @@ -51025,24 +51144,26 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: path - name: executionsId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: parameters: *ref_1 - get: - description: >- - Obtains the set of input and output Artifacts for this Execution, in the - form of LineageSubgraph that also contains the Execution and connecting - Events. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs + post: + description: Imports an externally generated ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51054,7 +51175,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' parameters: - in: path name: projectsId @@ -51067,20 +51188,15 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: parameters: *ref_1 get: - description: Lists Executions in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.list + description: Lists ModelEvaluations in a Model. + operationId: aiplatform.projects.locations.models.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51093,7 +51209,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse parameters: - in: path name: projectsId @@ -51106,7 +51222,7 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string @@ -51115,26 +51231,33 @@ paths: schema: type: string - in: query - name: orderBy + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Creates an Execution associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + 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. + operationId: aiplatform.projects.locations.models.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51146,7 +51269,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -51159,19 +51282,28 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: executionId + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: parameters: *ref_1 - delete: - description: Deletes an Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.delete + 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. + operationId: aiplatform.projects.locations.models.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51196,22 +51328,22 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: path - name: executionsId + name: operationsId required: true schema: type: string - - in: query - name: etag - schema: - type: string - get: - description: Retrieves a specific Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.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`. + operationId: aiplatform.projects.locations.models.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51223,7 +51355,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -51236,23 +51368,22 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - in: path - name: executionsId + name: operationsId required: true schema: type: string - patch: - description: Updates a stored Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.models.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51264,7 +51395,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -51277,35 +51408,37 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: allowMissing + name: filter schema: - type: boolean + type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Purges Executions. - operationId: aiplatform.projects.locations.metadataStores.executions.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest + 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`. + operationId: aiplatform.projects.locations.models.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51317,7 +51450,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -51330,24 +51463,20 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.wait + get: + description: Gets a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51359,7 +51488,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -51372,40 +51502,62 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: hyperparameterTuningJobsId required: true schema: type: string + delete: + description: Deletes a HyperparameterTuningJob. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: executionsId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: hyperparameterTuningJobsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: parameters: *ref_1 post: 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`. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.operations.cancel + 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`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51430,27 +51582,15 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: operationsId + name: hyperparameterTuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.list + description: Lists HyperparameterTuningJobs in a Location. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51462,7 +51602,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse parameters: - in: path name: projectsId @@ -51474,16 +51615,6 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId - required: true - schema: - type: string - in: query name: pageToken schema: @@ -51497,16 +51628,20 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: - parameters: *ref_1 - 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`. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.operations.delete + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + post: + description: Creates a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51518,39 +51653,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.get + 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. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51575,25 +51704,27 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: hyperparameterTuningJobsId required: true schema: type: string - in: path - name: executionsId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: parameters: *ref_1 get: - description: Lists MetadataStores for a Location. - operationId: aiplatform.projects.locations.metadataStores.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51605,8 +51736,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -51618,23 +51748,38 @@ paths: required: true schema: type: string + - in: path + name: hyperparameterTuningJobsId + required: true + schema: + type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Initializes a MetadataStore, including allocation of resources. - operationId: aiplatform.projects.locations.metadataStores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + 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`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51646,7 +51791,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -51658,17 +51803,25 @@ paths: required: true schema: type: string - - in: query - name: metadataStoreId + - in: path + name: hyperparameterTuningJobsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: parameters: *ref_1 delete: description: >- - Deletes a single MetadataStore and all its child resources (Artifacts, - Executions, and Contexts). - operationId: aiplatform.projects.locations.metadataStores.delete + 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`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51680,7 +51833,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -51693,17 +51846,21 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: hyperparameterTuningJobsId required: true schema: type: string - - in: query - name: force + - in: path + name: operationsId + required: true schema: - type: boolean + type: string get: - description: Retrieves a specific MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.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. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51715,7 +51872,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -51728,21 +51885,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: hyperparameterTuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/endpoints/{endpointsId}:computeTokens: parameters: *ref_1 post: - description: Evaluates instances based on a given metric. - operationId: aiplatform.projects.locations.evaluateInstances + description: Return a list of tokens based on the input text. + operationId: aiplatform.endpoints.computeTokens requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51755,51 +51916,57 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesResponse + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + /v1/endpoints/{endpointsId}:generateContent: parameters: *ref_1 - get: - description: Gets information about a location. - operationId: aiplatform.projects.locations.get + post: + description: Generate content with multimodal inputs. + operationId: aiplatform.endpoints.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations: + /v1/endpoints/{endpointsId}:countTokens: parameters: *ref_1 - get: - description: Lists information about the supported locations for this service. - operationId: aiplatform.projects.locations.list + post: + description: Perform a token counting. + operationId: aiplatform.endpoints.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51811,36 +51978,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path - name: projectsId + name: endpointsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/datasets/{datasetsId}/datasetVersions: + /v1/endpoints/{endpointsId}:streamGenerateContent: parameters: *ref_1 - get: - description: Lists DatasetVersions in a Dataset. - operationId: aiplatform.datasets.datasetVersions.list + post: + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.endpoints.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -51848,43 +52013,18 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path - name: datasetsId + name: endpointsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Create a version from a Dataset. - operationId: aiplatform.datasets.datasetVersions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: + parameters: *ref_1 + delete: + description: Deletes a Dataset version. + operationId: aiplatform.datasets.datasetVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51903,8 +52043,11 @@ paths: required: true schema: type: string - /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: - parameters: *ref_1 + - in: path + name: datasetVersionsId + required: true + schema: + type: string patch: description: Updates a DatasetVersion. operationId: aiplatform.datasets.datasetVersions.patch @@ -51941,9 +52084,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a Dataset version. - operationId: aiplatform.datasets.datasetVersions.delete + get: + description: Gets a Dataset version. + operationId: aiplatform.datasets.datasetVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51955,7 +52098,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: datasetsId @@ -51967,9 +52110,16 @@ paths: required: true schema: type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + parameters: *ref_1 get: - description: Gets a Dataset version. - operationId: aiplatform.datasets.datasetVersions.get + description: Restores a dataset version. + operationId: aiplatform.datasets.datasetVersions.restore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51981,7 +52131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: datasetsId @@ -51993,16 +52143,11 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + /v1/datasets/{datasetsId}/datasetVersions: parameters: *ref_1 get: - description: Restores a dataset version. - operationId: aiplatform.datasets.datasetVersions.restore + description: Lists DatasetVersions in a Dataset. + operationId: aiplatform.datasets.datasetVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52014,15 +52159,59 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse parameters: - in: path name: datasetsId required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Create a version from a Dataset. + operationId: aiplatform.datasets.datasetVersions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: datasetVersionsId + name: datasetsId required: true schema: type: string @@ -52059,9 +52248,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a Dataset. - operationId: aiplatform.datasets.delete + get: + description: Gets a Dataset. + operationId: aiplatform.datasets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52073,16 +52262,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: datasetsId required: true schema: type: string - get: - description: Gets a Dataset. - operationId: aiplatform.datasets.get + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Dataset. + operationId: aiplatform.datasets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52094,18 +52288,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: datasetsId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask /v1/datasets: parameters: *ref_1 get: @@ -52126,7 +52315,7 @@ paths: #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse parameters: - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -52139,7 +52328,11 @@ paths: type: string format: google-fieldmask - in: query - name: filter + name: pageToken + schema: + type: string + - in: query + name: orderBy schema: type: string - in: query @@ -52147,10 +52340,6 @@ paths: schema: type: integer format: int32 - - in: query - name: orderBy - schema: - type: string post: description: Creates a Dataset. operationId: aiplatform.datasets.create @@ -52176,129 +52365,3 @@ paths: name: parent schema: type: string - /v1/endpoints/{endpointsId}:streamGenerateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.endpoints.streamGenerateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse - parameters: - - in: path - name: endpointsId - required: true - schema: - type: string - /v1/endpoints/{endpointsId}:computeTokens: - parameters: *ref_1 - post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.endpoints.computeTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse - parameters: - - in: path - name: endpointsId - required: true - schema: - type: string - /v1/endpoints/{endpointsId}:countTokens: - parameters: *ref_1 - post: - description: Perform a token counting. - operationId: aiplatform.endpoints.countTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse - parameters: - - in: path - name: endpointsId - required: true - schema: - type: string - /v1/endpoints/{endpointsId}:generateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs. - operationId: aiplatform.endpoints.generateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse - parameters: - - in: path - name: endpointsId - required: true - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml b/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml index 9b591e05..94e30513 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml @@ -7,8 +7,8 @@ info: title: Air Quality API description: The Air Quality API. version: v1 - x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/maps/documentation/air-quality servers: @@ -34,173 +34,11 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - HourlyForecast: - type: object - properties: - healthRecommendations: - $ref: '#/components/schemas/HealthRecommendations' - description: >- - Health advice and recommended actions related to the reported air - quality conditions. Recommendations are tailored differently for - populations at risk, groups with greater sensitivities to - pollutants, and the general population. - pollutants: - description: >- - A list of pollutants affecting the location specified in the - request. Note: This field will be returned only for requests that - specified one or more of the following extra computations: - POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, - POLLUTANT_CONCENTRATION. - type: array - items: - $ref: '#/components/schemas/Pollutant' - dateTime: - format: google-datetime - type: string - description: >- - A rounded down timestamp indicating the time (hour) the data refers - to in RFC3339 UTC "Zulu" format. For example: - "2014-10-02T15:00:00Z". - indexes: - type: array - description: >- - Based on the request parameters, this list will include (up to) two - air quality indexes: - Universal AQI. Will be returned if the - `universal_aqi` boolean is set to true. - Local AQI. Will be - returned if the LOCAL_AQI extra computation is specified. - items: - $ref: '#/components/schemas/AirQualityIndex' - id: HourlyForecast - description: >- - Contains the air quality information for each hour in the requested - range. For example, if the request is for 48 hours of forecast there - will be 48 elements of hourly forecasts. - Interval: - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - id: Interval - type: object - properties: - startTime: - format: google-datetime - description: >- - Optional. Inclusive start of the interval. If specified, a Timestamp - matching this interval will have to be the same or after the start. - type: string - 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 - type: string - HttpBody: - id: HttpBody - properties: - contentType: - type: string - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - data: - description: The HTTP request/response body as raw binary. - type: string - format: byte - extensions: - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - type: object - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - HourInfo: - description: >- - Contains the air quality information for each hour in the requested - range. For example, if the request is for 48 hours of history there will - be 48 elements of hourly info. - type: object - properties: - dateTime: - type: string - format: google-datetime - description: >- - A rounded down timestamp indicating the time the data refers to in - RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine - fractional digits. For example: "2014-10-02T15:00:00Z". - indexes: - items: - $ref: '#/components/schemas/AirQualityIndex' - description: >- - Based on the request parameters, this list will include (up to) two - air quality indexes: - Universal AQI. Will be returned if the - universalAqi boolean is set to true. - Local AQI. Will be returned - if the LOCAL_AQI extra computation is specified. - type: array - healthRecommendations: - description: >- - Health advice and recommended actions related to the reported air - quality conditions. Recommendations are tailored differently for - populations at risk, groups with greater sensitivities to - pollutants, and the general population. - $ref: '#/components/schemas/HealthRecommendations' - pollutants: - description: >- - A list of pollutants affecting the location specified in the - request. Note: This field will be returned only for requests that - specified one or more of the following extra computations: - POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, - POLLUTANT_CONCENTRATION. - items: - $ref: '#/components/schemas/Pollutant' - type: array - id: HourInfo - LatLng: - properties: - latitude: - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - format: double - type: number - longitude: - format: double - type: number - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - id: LatLng - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - type: object LookupHistoryResponse: - id: LookupHistoryResponse - type: object properties: + nextPageToken: + description: Optional. The token to retrieve the next page. + type: string regionCode: description: >- Optional. The ISO_3166-1 alpha-2 code of the country/region @@ -209,55 +47,66 @@ components: request resides in a disputed territory. type: string hoursInfo: - items: - $ref: '#/components/schemas/HourInfo' + type: array description: >- Optional. Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of history there will be 48 elements of hourly info. - type: array - nextPageToken: - type: string - description: Optional. The token to retrieve the next page. - LookupForecastRequest: + items: + $ref: '#/components/schemas/HourInfo' type: object + id: LookupHistoryResponse + LookupHistoryRequest: properties: - languageCode: - description: >- - Optional. Allows the client to choose the language for the response. - If data cannot be provided for that language the API uses the - closest match. Allowed values rely on the IETF standard (default = - 'en'). + dateTime: type: string - pageSize: - type: integer - description: >- - Optional. The maximum number of hourly info records to return per - page (default = 24). - format: int32 - period: + format: google-datetime description: >- - Indicates the start and end period for which to get the forecast - data. The timestamp is rounded to the previous exact hour. - $ref: '#/components/schemas/Interval' + A timestamp for which to return historical data. The timestamp is + rounded to the previous exact hour. Note: this will return hourly + data for the requested timestamp only (i.e. a single hourly info + element). For example, a request sent where the dateTime parameter + is set to 2023-01-03T11:05:49Z will be rounded down to + 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC "Zulu" format, with + nanosecond resolution and up to nine fractional digits. Examples: + "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". uaqiColorPalette: enum: - COLOR_PALETTE_UNSPECIFIED - RED_GREEN - INDIGO_PERSIAN_DARK - INDIGO_PERSIAN_LIGHT + description: >- + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. type: string enumDescriptions: - The default value. Ignored if passed as a parameter. - Determines whether to use a red/green palette. - Determines whether to use a indigo/persian palette (dark theme). - Determines whether to use a indigo/persian palette (light theme). + hours: description: >- - Optional. Determines the color palette used for data provided by the - 'Universal Air Quality Index' (UAQI). This color palette is relevant - just for UAQI, other AQIs have a predetermined color palette that - can't be controlled. + Number from 1 to 720 that indicates the hours range for the request. + For example: A value of 48 will yield data from the last 48 hours. + format: int32 + type: integer + languageCode: + type: string + description: >- + Optional. Allows the client to choose the language for the response. + If data cannot be provided for that language the API uses the + closest match. Allowed values rely on the IETF standard. Default + value is en. + location: + description: >- + Required. The latitude and longitude for which the API looks for air + quality history data. + $ref: '#/components/schemas/LatLng' customLocalAqis: + type: array items: $ref: '#/components/schemas/CustomLocalAqi' description: >- @@ -267,33 +116,18 @@ components: chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada. - type: array - pageToken: - type: string + period: + $ref: '#/components/schemas/Interval' description: >- - Optional. A page token received from a previous forecast call. It is - used to retrieve the subsequent page. - universalAqi: + Indicates the start and end period for which to get the historical + data. The timestamp is rounded to the previous exact hour. + pageSize: + type: integer description: >- - Optional. If set to true, the Universal AQI will be included in the - 'indexes' field of the response (default = true). - type: boolean - location: - description: >- - Required. The latitude and longitude for which the API looks for air - quality data. - $ref: '#/components/schemas/LatLng' - dateTime: - format: google-datetime - type: string - description: >- - A timestamp for which to return the data for a specific point in - time. The timestamp is rounded to the previous exact hour. Note: - this will return hourly data for the requested timestamp only (i.e. - a single hourly info element). For example, a request sent where the - date_time parameter is set to 2023-01-03T11:05:49Z will be rounded - down to 2023-01-03T11:00:00Z. - extraComputations: + Optional. The maximum number of hourly info records to return per + page. The default is 72 and the max value is 168 (7 days of data). + format: int32 + extraComputations: description: >- Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements @@ -335,6 +169,7 @@ components: global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available. + type: string enum: - EXTRA_COMPUTATION_UNSPECIFIED - LOCAL_AQI @@ -342,272 +177,384 @@ components: - POLLUTANT_ADDITIONAL_INFO - DOMINANT_POLLUTANT_CONCENTRATION - POLLUTANT_CONCENTRATION - type: string type: array - id: LookupForecastRequest - description: The request object of the air quality forecast API. - Color: + universalAqi: + description: >- + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response. Default value is true. + type: boolean + pageToken: + type: string + description: >- + Optional. A page token received from a previous history call. It is + used to retrieve the subsequent page. Note that when providing a + value for this parameter all other parameters provided must match + the call that provided the page token (the previous call). + type: object + description: The request object of the air quality history API. + id: LookupHistoryRequest + LookupCurrentConditionsResponse: + id: LookupCurrentConditionsResponse + type: object properties: - red: + dateTime: + description: >- + A rounded down timestamp in RFC3339 UTC "Zulu" format, with + nanosecond resolution and up to nine fractional digits. For example: + "2014-10-02T15:00:00Z". + format: google-datetime + type: string + pollutants: + items: + $ref: '#/components/schemas/Pollutant' + description: >- + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + type: array + indexes: + description: >- + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + universalAqi boolean is set to true. - Local AQI. Will be returned + if the LOCAL_AQI extra computation is specified. + items: + $ref: '#/components/schemas/AirQualityIndex' + type: array + healthRecommendations: + description: >- + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + $ref: '#/components/schemas/HealthRecommendations' + regionCode: + description: >- + The ISO_3166-1 alpha-2 code of the country/region corresponding to + the location provided in the request. This field might be omitted + from the response if the location provided in the request resides in + a disputed territory. + type: string + LatLng: + id: LatLng + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. + properties: + longitude: + format: double type: number - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - green: + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + latitude: type: number - format: float - description: The amount of green in the color as a value in the interval [0, 1]. - blue: + format: double + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: object + Concentration: + type: object + properties: + value: type: number - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - alpha: format: float - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - type: number - id: Color + description: Value of the pollutant concentration. + units: + enumDescriptions: + - Unspecified concentration unit. + - The ppb (parts per billion) concentration unit. + - The "µg/m^3" (micrograms per cubic meter) concentration unit. + enum: + - UNIT_UNSPECIFIED + - PARTS_PER_BILLION + - MICROGRAMS_PER_CUBIC_METER + description: Units for measuring this pollutant concentration. + type: string + description: The concentration of a given pollutant in the air. + id: Concentration + HourInfo: + id: HourInfo + type: object description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... + Contains the air quality information for each hour in the requested + range. For example, if the request is for 48 hours of history there will + be 48 elements of hourly info. + properties: + pollutants: + items: + $ref: '#/components/schemas/Pollutant' + description: >- + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + type: array + indexes: + items: + $ref: '#/components/schemas/AirQualityIndex' + description: >- + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + universalAqi boolean is set to true. - Local AQI. Will be returned + if the LOCAL_AQI extra computation is specified. + type: array + healthRecommendations: + description: >- + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + $ref: '#/components/schemas/HealthRecommendations' + dateTime: + format: google-datetime + description: >- + A rounded down timestamp indicating the time the data refers to in + RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine + fractional digits. For example: "2014-10-02T15:00:00Z". + type: string + LookupForecastResponse: + id: LookupForecastResponse type: object + description: The response object of the air quality forecast API. + properties: + regionCode: + description: >- + Optional. The ISO_3166-1 alpha-2 code of the country/region + corresponding to the location provided in the request. This field + might be omitted from the response if the location provided in the + request resides in a disputed territory. + type: string + hourlyForecasts: + type: array + items: + $ref: '#/components/schemas/HourlyForecast' + description: >- + Optional. Contains the air quality information for each hour in the + requested range. For example, if the request is for 48 hours of + forecast there will be 48 elements of hourly forecasts. + nextPageToken: + type: string + description: Optional. The token to retrieve the next page. HealthRecommendations: - id: HealthRecommendations - description: >- - Health recommendations for different population groups in a free text - format. The recommendations are derived from their associated air - quality conditions. + type: object properties: - generalPopulation: + children: + description: Younger populations including children, toddlers, and babies. + type: string + pregnantWomen: + description: Women at all stages of pregnancy. type: string - description: No specific sensitivities. lungDiseasePopulation: type: string description: Respiratory related problems and asthma suffers. - pregnantWomen: - type: string - description: Women at all stages of pregnancy. elderly: - type: string description: Retirees and people older than the general population. - children: - description: Younger populations including children, toddlers, and babies. + type: string + heartDiseasePopulation: + description: Heart and circulatory system diseases. type: string athletes: type: string description: Sports and other strenuous outdoor activities. - heartDiseasePopulation: - description: Heart and circulatory system diseases. + generalPopulation: type: string - type: object - CustomLocalAqi: + description: No specific sensitivities. description: >- - Expresses a 'country/region to AQI' relationship. Pairs a country/region - with a desired AQI so that air quality data that is required for that - country/region will be displayed according to the chosen AQI. + Health recommendations for different population groups in a free text + format. The recommendations are derived from their associated air + quality conditions. + id: HealthRecommendations + HourlyForecast: + description: >- + Contains the air quality information for each hour in the requested + range. For example, if the request is for 48 hours of forecast there + will be 48 elements of hourly forecasts. + type: object properties: - aqi: + dateTime: type: string + format: google-datetime description: >- - The AQI to associate the country/region with. Value should be a - [valid index](/maps/documentation/air-quality/laqis) code. - regionCode: - type: string + A rounded down timestamp indicating the time (hour) the data refers + to in RFC3339 UTC "Zulu" format. For example: + "2014-10-02T15:00:00Z". + pollutants: + items: + $ref: '#/components/schemas/Pollutant' description: >- - The country/region requiring the custom AQI. Value should be - provided using [ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. - type: object - id: CustomLocalAqi + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + type: array + indexes: + description: >- + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + `universal_aqi` boolean is set to true. - Local AQI. Will be + returned if the LOCAL_AQI extra computation is specified. + type: array + items: + $ref: '#/components/schemas/AirQualityIndex' + healthRecommendations: + description: >- + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + $ref: '#/components/schemas/HealthRecommendations' + id: HourlyForecast Pollutant: + id: Pollutant properties: - concentration: - description: >- - The pollutant's concentration level measured by one of the standard - air pollutation measure units. - $ref: '#/components/schemas/Concentration' - displayName: - type: string - description: 'The pollutant''s display name. For example: "NOx".' additionalInfo: $ref: '#/components/schemas/AdditionalInfo' description: Additional information about the pollutant. fullName: + type: string description: >- The pollutant's full name. For chemical compounds, this is the IUPAC name. Example: "Sulfur Dioxide". For more information about the IUPAC names table, see https://iupac.org/what-we-do/periodic-table-of-elements/. - type: string code: - type: string description: >- The pollutant's code name (for example, "so2"). For a list of supported pollutant codes, see [Reported pollutants](/maps/documentation/air-quality/pollutants#reported_pollutants). - id: Pollutant - description: Data regarding an air quality pollutant. - type: object - LookupCurrentConditionsResponse: - id: LookupCurrentConditionsResponse - type: object - properties: - healthRecommendations: - description: >- - Health advice and recommended actions related to the reported air - quality conditions. Recommendations are tailored differently for - populations at risk, groups with greater sensitivities to - pollutants, and the general population. - $ref: '#/components/schemas/HealthRecommendations' - pollutants: + type: string + concentration: description: >- - A list of pollutants affecting the location specified in the - request. Note: This field will be returned only for requests that - specified one or more of the following extra computations: - POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, - POLLUTANT_CONCENTRATION. - items: - $ref: '#/components/schemas/Pollutant' - type: array - dateTime: - format: google-datetime + The pollutant's concentration level measured by one of the standard + air pollutation measure units. + $ref: '#/components/schemas/Concentration' + displayName: + description: 'The pollutant''s display name. For example: "NOx".' + type: string + type: object + description: Data regarding an air quality pollutant. + AirQualityIndex: + type: object + properties: + category: description: >- - A rounded down timestamp in RFC3339 UTC "Zulu" format, with - nanosecond resolution and up to nine fractional digits. For example: - "2014-10-02T15:00:00Z". + Textual classification of the index numeric score interpretation. + For example: "Excellent air quality". type: string - indexes: + aqi: + description: ' The index''s numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.' + type: integer + format: int32 + color: + $ref: '#/components/schemas/Color' + description: The color used to represent the AQI numeric score. + displayName: description: >- - Based on the request parameters, this list will include (up to) two - air quality indexes: - Universal AQI. Will be returned if the - universalAqi boolean is set to true. - Local AQI. Will be returned - if the LOCAL_AQI extra computation is specified. - type: array - items: - $ref: '#/components/schemas/AirQualityIndex' - regionCode: + A human readable representation of the index name. Example: "AQI + (US)" + type: string + dominantPollutant: + description: 'The chemical symbol of the dominant pollutant. For example: "CO".' + type: string + code: description: >- - The ISO_3166-1 alpha-2 code of the country/region corresponding to - the location provided in the request. This field might be omitted - from the response if the location provided in the request resides in - a disputed territory. + The index's code. This field represents the index for programming + purposes by using snake case instead of spaces. Examples: "uaqi", + "fra_atmo". + type: string + aqiDisplay: type: string + description: >- + Textual representation of the index numeric score, that may include + prefix or suffix symbols, which usually represents the worst index + score. Example: >100 or 10+. Note: This field should be used when + you want to display the index score. For non-numeric indexes, this + field is empty. + id: AirQualityIndex + description: >- + The basic object for representing different air quality metrics. When + brought together, these metrics provide a snapshot about the current air + quality conditions. There are multiple indexes in the world serving + different purposes and groups interested in measuring different aspects + of air quality. AdditionalInfo: properties: effects: - type: string description: Text representing the pollutant's main health effects. + type: string sources: description: Text representing the pollutant's main emission sources. type: string description: The emission sources and health effects of a given pollutant. - type: object id: AdditionalInfo - AirQualityIndex: - id: AirQualityIndex + type: object + Interval: + type: object + id: Interval description: >- - The basic object for representing different air quality metrics. When - brought together, these metrics provide a snapshot about the current air - quality conditions. There are multiple indexes in the world serving - different purposes and groups interested in measuring different aspects - of air quality. + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. properties: - aqiDisplay: - description: >- - Textual representation of the index numeric score, that may include - prefix or suffix symbols, which usually represents the worst index - score. Example: >100 or 10+. Note: This field should be used when - you want to display the index score. For non-numeric indexes, this - field is empty. + endTime: type: string - code: description: >- - The index's code. This field represents the index for programming - purposes by using snake case instead of spaces. Examples: "uaqi", - "fra_atmo". - type: string - dominantPollutant: - description: 'The chemical symbol of the dominant pollutant. For example: "CO".' + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + format: google-datetime + startTime: type: string - color: - $ref: '#/components/schemas/Color' - description: The color used to represent the AQI numeric score. - category: description: >- - Textual classification of the index numeric score interpretation. - For example: "Excellent air quality". + 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 + LookupCurrentConditionsRequest: + type: object + id: LookupCurrentConditionsRequest + properties: + uaqiColorPalette: + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + enumDescriptions: + - The default value. Ignored if passed as a parameter. + - Determines whether to use a red/green palette. + - Determines whether to use a indigo/persian palette (dark theme). + - Determines whether to use a indigo/persian palette (light theme). + description: >- + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. type: string - aqi: - description: ' The index''s numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.' - type: integer - format: int32 - displayName: + universalAqi: + type: boolean + description: >- + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response. Default value is true. + languageCode: type: string description: >- - A human readable representation of the index name. Example: "AQI - (US)" - type: object - LookupHistoryRequest: - id: LookupHistoryRequest - properties: + Optional. Allows the client to choose the language for the response. + If data cannot be provided for that language the API uses the + closest match. Allowed values rely on the IETF standard. Default + value is en. + location: + description: >- + Required. The longitude and latitude from which the API looks for + air quality current conditions data. + $ref: '#/components/schemas/LatLng' extraComputations: items: + type: string enum: - EXTRA_COMPUTATION_UNSPECIFIED - LOCAL_AQI @@ -615,7 +562,6 @@ components: - POLLUTANT_ADDITIONAL_INFO - DOMINANT_POLLUTANT_CONCENTRATION - POLLUTANT_CONCENTRATION - type: string enumDescriptions: - >- The default value. The server ignores it if it is passed as a @@ -652,145 +598,28 @@ components: global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available. - type: array description: >- Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response. - pageSize: - description: >- - Optional. The maximum number of hourly info records to return per - page. The default is 72 and the max value is 168 (7 days of data). - format: int32 - type: integer - period: - $ref: '#/components/schemas/Interval' - description: >- - Indicates the start and end period for which to get the historical - data. The timestamp is rounded to the previous exact hour. - hours: - description: >- - Number from 1 to 720 that indicates the hours range for the request. - For example: A value of 48 will yield data from the last 48 hours. - format: int32 - type: integer - languageCode: - description: >- - Optional. Allows the client to choose the language for the response. - If data cannot be provided for that language the API uses the - closest match. Allowed values rely on the IETF standard. Default - value is en. - type: string - customLocalAqis: type: array - items: - $ref: '#/components/schemas/CustomLocalAqi' - description: >- - Optional. Expresses a 'country/region to AQI' relationship. Pairs a - country/region with a desired AQI so that air quality data that is - required for that country/region will be displayed according to the - chosen AQI. This parameter can be used to specify a non-default AQI - for a given country, for example, to get the US EPA index for Canada - rather than the default index for Canada. - location: - $ref: '#/components/schemas/LatLng' - description: >- - Required. The latitude and longitude for which the API looks for air - quality history data. - uaqiColorPalette: - description: >- - Optional. Determines the color palette used for data provided by the - 'Universal Air Quality Index' (UAQI). This color palette is relevant - just for UAQI, other AQIs have a predetermined color palette that - can't be controlled. - enum: - - COLOR_PALETTE_UNSPECIFIED - - RED_GREEN - - INDIGO_PERSIAN_DARK - - INDIGO_PERSIAN_LIGHT - enumDescriptions: - - The default value. Ignored if passed as a parameter. - - Determines whether to use a red/green palette. - - Determines whether to use a indigo/persian palette (dark theme). - - Determines whether to use a indigo/persian palette (light theme). - type: string - pageToken: - type: string - description: >- - Optional. A page token received from a previous history call. It is - used to retrieve the subsequent page. Note that when providing a - value for this parameter all other parameters provided must match - the call that provided the page token (the previous call). - dateTime: - description: >- - A timestamp for which to return historical data. The timestamp is - rounded to the previous exact hour. Note: this will return hourly - data for the requested timestamp only (i.e. a single hourly info - element). For example, a request sent where the dateTime parameter - is set to 2023-01-03T11:05:49Z will be rounded down to - 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC "Zulu" format, with - nanosecond resolution and up to nine fractional digits. Examples: - "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". - format: google-datetime - type: string - universalAqi: - description: >- - Optional. If set to true, the Universal AQI will be included in the - 'indexes' field of the response. Default value is true. - type: boolean - description: The request object of the air quality history API. - type: object - LookupForecastResponse: - properties: - nextPageToken: - description: Optional. The token to retrieve the next page. - type: string - regionCode: - description: >- - Optional. The ISO_3166-1 alpha-2 code of the country/region - corresponding to the location provided in the request. This field - might be omitted from the response if the location provided in the - request resides in a disputed territory. - type: string - hourlyForecasts: + customLocalAqis: description: >- - Optional. Contains the air quality information for each hour in the - requested range. For example, if the request is for 48 hours of - forecast there will be 48 elements of hourly forecasts. + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. items: - $ref: '#/components/schemas/HourlyForecast' + $ref: '#/components/schemas/CustomLocalAqi' type: array + description: The request definition of the air quality current conditions. + LookupForecastRequest: type: object - description: The response object of the air quality forecast API. - id: LookupForecastResponse - Concentration: - properties: - units: - enum: - - UNIT_UNSPECIFIED - - PARTS_PER_BILLION - - MICROGRAMS_PER_CUBIC_METER - type: string - description: Units for measuring this pollutant concentration. - enumDescriptions: - - Unspecified concentration unit. - - The ppb (parts per billion) concentration unit. - - The "µg/m^3" (micrograms per cubic meter) concentration unit. - value: - description: Value of the pollutant concentration. - format: float - type: number - type: object - description: The concentration of a given pollutant in the air. - id: Concentration - LookupCurrentConditionsRequest: - type: object + id: LookupForecastRequest + description: The request object of the air quality forecast API. properties: - location: - description: >- - Required. The longitude and latitude from which the API looks for - air quality current conditions data. - $ref: '#/components/schemas/LatLng' customLocalAqis: items: $ref: '#/components/schemas/CustomLocalAqi' @@ -802,50 +631,54 @@ components: for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada. type: array - universalAqi: - type: boolean + languageCode: + type: string description: >- - Optional. If set to true, the Universal AQI will be included in the - 'indexes' field of the response. Default value is true. + Optional. Allows the client to choose the language for the response. + If data cannot be provided for that language the API uses the + closest match. Allowed values rely on the IETF standard (default = + 'en'). + pageSize: + format: int32 + type: integer + description: >- + Optional. The maximum number of hourly info records to return per + page (default = 24). + location: + description: >- + Required. The latitude and longitude for which the API looks for air + quality data. + $ref: '#/components/schemas/LatLng' uaqiColorPalette: - type: string - enum: - - COLOR_PALETTE_UNSPECIFIED - - RED_GREEN - - INDIGO_PERSIAN_DARK - - INDIGO_PERSIAN_LIGHT + description: >- + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. enumDescriptions: - The default value. Ignored if passed as a parameter. - Determines whether to use a red/green palette. - Determines whether to use a indigo/persian palette (dark theme). - Determines whether to use a indigo/persian palette (light theme). + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + type: string + period: + $ref: '#/components/schemas/Interval' description: >- - Optional. Determines the color palette used for data provided by the - 'Universal Air Quality Index' (UAQI). This color palette is relevant - just for UAQI, other AQIs have a predetermined color palette that - can't be controlled. - languageCode: + Indicates the start and end period for which to get the forecast + data. The timestamp is rounded to the previous exact hour. + universalAqi: description: >- - Optional. Allows the client to choose the language for the response. - If data cannot be provided for that language the API uses the - closest match. Allowed values rely on the IETF standard. Default - value is en. - type: string + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response (default = true). + type: boolean extraComputations: - description: >- - Optional. Additional features that can be optionally enabled. - Specifying extra computations will result in the relevant elements - and fields to be returned in the response. - type: array items: type: string - enum: - - EXTRA_COMPUTATION_UNSPECIFIED - - LOCAL_AQI - - HEALTH_RECOMMENDATIONS - - POLLUTANT_ADDITIONAL_INFO - - DOMINANT_POLLUTANT_CONCENTRATION - - POLLUTANT_CONCENTRATION enumDescriptions: - >- The default value. The server ignores it if it is passed as a @@ -882,21 +715,176 @@ components: global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available. - description: The request definition of the air quality current conditions. - id: LookupCurrentConditionsRequest + enum: + - EXTRA_COMPUTATION_UNSPECIFIED + - LOCAL_AQI + - HEALTH_RECOMMENDATIONS + - POLLUTANT_ADDITIONAL_INFO + - DOMINANT_POLLUTANT_CONCENTRATION + - POLLUTANT_CONCENTRATION + description: >- + Optional. Additional features that can be optionally enabled. + Specifying extra computations will result in the relevant elements + and fields to be returned in the response. + type: array + pageToken: + type: string + description: >- + Optional. A page token received from a previous forecast call. It is + used to retrieve the subsequent page. + dateTime: + format: google-datetime + description: >- + A timestamp for which to return the data for a specific point in + time. The timestamp is rounded to the previous exact hour. Note: + this will return hourly data for the requested timestamp only (i.e. + a single hourly info element). For example, a request sent where the + date_time parameter is set to 2023-01-03T11:05:49Z will be rounded + down to 2023-01-03T11:00:00Z. + type: string + CustomLocalAqi: + type: object + id: CustomLocalAqi + properties: + aqi: + description: >- + The AQI to associate the country/region with. Value should be a + [valid index](/maps/documentation/air-quality/laqis) code. + type: string + regionCode: + type: string + description: >- + The country/region requiring the custom AQI. Value should be + provided using [ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. + description: >- + Expresses a 'country/region to AQI' relationship. Pairs a country/region + with a desired AQI so that air quality data that is required for that + country/region will be displayed according to the chosen AQI. + Color: + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + id: Color + properties: + alpha: + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + format: float + type: number + green: + type: number + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + red: + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + type: number + type: object + HttpBody: + id: HttpBody + properties: + contentType: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + type: string + extensions: + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + data: + type: string + description: The HTTP request/response body as raw binary. + format: byte + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + type: object parameters: - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -906,12 +894,6 @@ components: name: quotaUser schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -921,33 +903,45 @@ components: name: key schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' callback: description: JSONP in: query name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: prettyPrint + name: uploadType schema: - type: boolean - _.xgafv: - description: V1 error format. + type: string + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: $.xgafv + name: fields + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string - enum: - - '1' - - '2' alt: description: Data format for response. in: query @@ -958,21 +952,27 @@ components: - json - media - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + name: oauth_token schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean x-stackQL-resources: - current_conditions: - id: google.airquality.current_conditions - name: current_conditions - title: Current_conditions + forecast: + id: google.airquality.forecast + name: forecast + title: Forecast methods: lookup: operation: - $ref: '#/paths/~1v1~1currentConditions:lookup/post' + $ref: '#/paths/~1v1~1forecast:lookup/post' response: mediaType: application/json openAPIDocKey: '200' @@ -982,14 +982,15 @@ components: update: [] replace: [] delete: [] - forecast: - id: google.airquality.forecast - name: forecast - title: Forecast + heatmap_tiles: + id: google.airquality.heatmap_tiles + name: heatmap_tiles + title: Heatmap_tiles methods: - lookup: + lookup_heatmap_tile: operation: - $ref: '#/paths/~1v1~1forecast:lookup/post' + $ref: >- + #/paths/~1v1~1mapTypes~1{mapType}~1heatmapTiles~1{zoom}~1{x}~1{y}/get response: mediaType: application/json openAPIDocKey: '200' @@ -999,14 +1000,14 @@ components: update: [] replace: [] delete: [] - history: - id: google.airquality.history - name: history - title: History + current_conditions: + id: google.airquality.current_conditions + name: current_conditions + title: Current_conditions methods: lookup: operation: - $ref: '#/paths/~1v1~1history:lookup/post' + $ref: '#/paths/~1v1~1currentConditions:lookup/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1016,15 +1017,14 @@ components: update: [] replace: [] delete: [] - heatmap_tiles: - id: google.airquality.heatmap_tiles - name: heatmap_tiles - title: Heatmap_tiles + history: + id: google.airquality.history + name: history + title: History methods: - lookup_heatmap_tile: + lookup: operation: - $ref: >- - #/paths/~1v1~1mapTypes~1{mapType}~1heatmapTiles~1{zoom}~1{x}~1{y}/get + $ref: '#/paths/~1v1~1history:lookup/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1035,31 +1035,29 @@ components: replace: [] delete: [] paths: - /v1/currentConditions:lookup: + /v1/forecast:lookup: parameters: &ref_1 - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' post: description: >- - The Current Conditions endpoint provides hourly air quality information - in more than 100 countries, up to a 500 x 500 meters resolution. - Includes over 70 local indexes and global air quality index and - categories. - operationId: airquality.currentConditions.lookup + Returns air quality forecast for a specific location for a given time + range. + operationId: airquality.forecast.lookup requestBody: content: application/json: schema: - $ref: '#/components/schemas/LookupCurrentConditionsRequest' + $ref: '#/components/schemas/LookupForecastRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1071,20 +1069,60 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LookupCurrentConditionsResponse' + $ref: '#/components/schemas/LookupForecastResponse' parameters: [] - /v1/forecast:lookup: + /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: + parameters: *ref_1 + get: + description: Returns a bytes array containing the data of the tile PNG image. + operationId: airquality.mapTypes.heatmapTiles.lookupHeatmapTile + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: mapType + required: true + schema: + type: string + - in: path + name: zoom + required: true + schema: + type: string + - in: path + name: x + required: true + schema: + type: string + - in: path + name: 'y' + required: true + schema: + type: string + /v1/currentConditions:lookup: parameters: *ref_1 post: description: >- - Returns air quality forecast for a specific location for a given time - range. - operationId: airquality.forecast.lookup + The Current Conditions endpoint provides hourly air quality information + in more than 100 countries, up to a 500 x 500 meters resolution. + Includes over 70 local indexes and global air quality index and + categories. + operationId: airquality.currentConditions.lookup requestBody: content: application/json: schema: - $ref: '#/components/schemas/LookupForecastRequest' + $ref: '#/components/schemas/LookupCurrentConditionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1096,7 +1134,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LookupForecastResponse' + $ref: '#/components/schemas/LookupCurrentConditionsResponse' parameters: [] /v1/history:lookup: parameters: *ref_1 @@ -1123,41 +1161,3 @@ paths: schema: $ref: '#/components/schemas/LookupHistoryResponse' parameters: [] - /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: - parameters: *ref_1 - get: - description: Returns a bytes array containing the data of the tile PNG image. - operationId: airquality.mapTypes.heatmapTiles.lookupHeatmapTile - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/HttpBody' - parameters: - - in: path - name: mapType - required: true - schema: - type: string - - in: path - name: zoom - required: true - schema: - type: string - - in: path - name: x - required: true - schema: - type: string - - in: path - name: 'y' - required: true - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml b/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml index 9e97fccb..84d1c162 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml @@ -19,7 +19,7 @@ info: and modernize legacy proprietary databases. version: v1 x-discovery-doc-revision: '20240828' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/alloydb/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml b/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml index 219d6c89..b0114d5c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml @@ -8,7 +8,7 @@ info: description: Exchange data and analytics assets securely and efficiently. version: v1 x-discovery-doc-revision: '20240826' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bigquery/docs/analytics-hub-introduction servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml index 4fdd0ed8..257ad9c2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml @@ -7,8 +7,8 @@ info: title: API Gateway API description: '' version: v1 - x-discovery-doc-revision: '20240814' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/api-gateway/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml index 1c14b3a0..f86372de 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml @@ -12,8 +12,8 @@ info: more. Note: This product is available as a free trial for a time period of 60 days. version: v1 - x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240913' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/apigee-api-management/ servers: @@ -39,194 +39,89 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudApigeeV1CanaryEvaluationMetricLabels: - id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels - description: Labels that can be used to filter Apigee metrics. - type: object + GoogleCloudApigeeV1Properties: + id: GoogleCloudApigeeV1Properties properties: - instance_id: - type: string - description: >- - Required. The instance ID associated with the metrics. In Apigee - Hybrid, the value is configured during installation. - env: - type: string - description: The environment ID associated with the metrics. - location: - type: string - description: Required. The location associated with the metrics. - GoogleCloudApigeeV1TraceSamplingConfig: - id: GoogleCloudApigeeV1TraceSamplingConfig - type: object + property: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + type: array + description: List of all properties in the object description: >- - TraceSamplingConfig represents the detail settings of distributed - tracing. Only the fields that are defined in the distributed trace - configuration can be overridden using the distribute trace configuration - override APIs. - properties: - sampler: - enumDescriptions: - - Sampler unspecified. - - >- - OFF means distributed trace is disabled, or the sampling - probability is 0. - - >- - PROBABILITY means traces are captured on a probability that - defined by sampling_rate. The sampling rate is limited to 0 to 0.5 - when this is set. - description: Sampler of distributed tracing. OFF is the default value. - enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY - type: string - samplingRate: - format: float - type: number - description: >- - Field sampling rate. This value is only applicable when using the - PROBABILITY sampler. The supported values are > 0 and <= 0.5. - GoogleCloudApigeeV1ReferenceConfig: + Message for compatibility with legacy Edge specification for Java + Properties object in JSON. type: object + GoogleCloudApigeeV1IngressConfig: + id: GoogleCloudApigeeV1IngressConfig properties: - resourceName: - description: >- - Name of the referenced resource in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` Only - references to keystore resources are supported. + revisionCreateTime: + format: google-datetime + description: Time at which the IngressConfig revision was created. type: string - name: - description: >- - Name of the reference in the following format: - `organizations/{org}/environments/{env}/references/{reference}` + environmentGroups: + description: List of environment groups in the organization. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + type: array + revisionId: + format: int64 type: string - id: GoogleCloudApigeeV1ReferenceConfig - GoogleCloudApigeeV1DocumentationFile: - id: GoogleCloudApigeeV1DocumentationFile - type: object - description: Documentation file contents for a catalog item. - properties: - contents: + description: >- + Revision id that defines the ordering on IngressConfig resources. + The higher the revision, the more recently the configuration was + deployed. + name: type: string - description: Required. The file contents. The max size is 4 MB. - format: byte - displayName: description: >- - Required. A display name for the file, shown in the management UI. - Max length is 255 characters. + Name of the resource in the following format: + `organizations/{org}/deployedIngressConfig`. + uid: type: string - GoogleCloudApigeeV1NatAddress: + description: >- + A unique id for the ingress config that will only change if the + organization is deleted and recreated. + type: object + GoogleCloudApigeeV1SecurityActionsConfig: properties: - state: - readOnly: true + updateTime: + description: Output only. The update time for configuration. type: string - description: Output only. State of the nat address. - enum: - - STATE_UNSPECIFIED - - CREATING - - RESERVED - - ACTIVE - - DELETING - enumDescriptions: - - The resource is in an unspecified state. - - The NAT address is being created. - - The NAT address is reserved but not yet used for Internet egress. - - The NAT address is active and used for Internet egress. - - The NAT address is being deleted. - ipAddress: + format: google-datetime readOnly: true - type: string - description: Output only. The static IPV4 address. + enabled: + type: boolean + description: >- + The flag that controls whether this feature is enabled. This is + `unset` by default. When this flag is `false`, even if individual + rules are enabled, no SecurityActions will be enforced. name: + description: >- + This is a singleton resource, the name will always be set by + SecurityActions and any user input will be ignored. The name is + always: + `organizations/{org}/environments/{env}/security_actions_config` type: string - description: Required. Resource ID of the NAT address. - id: GoogleCloudApigeeV1NatAddress description: >- - Apigee NAT(network address translation) address. A NAT address is a - static external IP address used for Internet egress traffic. + SecurityActionsConfig reflects the current state of the SecurityActions + feature. This is a singleton resource: https://google.aip.dev/156 + id: GoogleCloudApigeeV1SecurityActionsConfig type: object - GoogleCloudApigeeV1Organization: + GoogleCloudApigeeV1ProvisionOrganizationRequest: properties: - lastModifiedAt: - description: >- - Output only. Time that the Apigee organization was last modified in - milliseconds since epoch. - readOnly: true - format: int64 - type: string - subscriptionPlan: - readOnly: true - enumDescriptions: - - Subscription plan not specified. - - Traditional subscription plan. - - >- - New subscription plan that provides standard proxy and scaled - proxy implementation. - enum: - - SUBSCRIPTION_PLAN_UNSPECIFIED - - SUBSCRIPTION_2021 - - SUBSCRIPTION_2024 - description: >- - Output only. Subscription plan that the customer has purchased. - Output only. - type: string - portalDisabled: - type: boolean - description: Configuration for the Portals settings. - caCertificate: - readOnly: true - description: >- - Output only. Base64-encoded public certificate for the root CA of - the Apigee organization. Valid only when [RuntimeType](#RuntimeType) - is `CLOUD`. - format: byte - type: string disableVpcPeering: type: boolean description: >- Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer - network and Apigee. Valid only when RuntimeType is set to CLOUD. - Required if an authorizedNetwork on the consumer project is not - provided, in which case the flag should be set to true. The value - must be set before the creation of any Apigee runtime instance and - can be updated only when there are no runtime instances. **Note:** - Apigee will be deprecating the vpc peering model that requires you - to provide 'authorizedNetwork', by making the non-peering model as - the default way of provisioning Apigee organization in future. So, - this will be a temporary flag to enable the transition. Not - supported for Apigee hybrid. - apiConsumerDataLocation: - description: >- - This field is needed only for customers using non-default data - residency regions. Apigee stores some control plane data only in - single region. This field determines which single region Apigee - should use. For example: "us-west1" when control plane is in US or - "europe-west2" when control plane is in EU. - type: string - analyticsRegion: - deprecated: true - type: string - description: >- - Required. DEPRECATED: This field will eventually be deprecated and - replaced with a differently-named field. Primary Google Cloud region - for analytics data storage. For valid values, see [Create an Apigee - organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). - billingType: - type: string - enum: - - BILLING_TYPE_UNSPECIFIED - - SUBSCRIPTION - - EVALUATION - - PAYG - description: >- - Billing type of the Apigee organization. See [Apigee - pricing](https://cloud.google.com/apigee/pricing). - enumDescriptions: - - Billing type not specified. - - A pre-paid subscription to Apigee. - - Free and limited access to Apigee for evaluation purposes only. - - Access to Apigee using a Pay-As-You-Go plan. + network and Apigee. Required if an authorizedNetwork on the consumer + project is not provided, in which case the flag should be set to + true. The value must be set before the creation of any Apigee + runtime instance and can be updated only when there are no runtime + instances. **Note:** Apigee will be deprecating the vpc peering + model that requires you to provide 'authorizedNetwork', by making + the non-peering model as the default way of provisioning Apigee + organization in future. So, this will be a temporary flag to enable + the transition. Not supported for Apigee hybrid. authorizedNetwork: type: string description: >- @@ -234,2486 +129,2168 @@ components: Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). - Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The - value must be set before the creation of a runtime instance and can - be updated only when there are no runtime instances. For example: - `default`. Apigee also supports shared VPC (that is, the host - network project is not the same as the one that is peering with - Apigee). See [Shared VPC - overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a - shared VPC network, use the following format: + Apigee also supports shared VPC (that is, the host network project + is not the same as the one that is peering with Apigee). See [Shared + VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use + a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` - **Note:** Not supported for Apigee hybrid. - controlPlaneEncryptionKeyName: + analyticsRegion: + type: string description: >- - Cloud KMS key name used for encrypting control plane data that is - stored in a multi region. Only used for the data residency region - "US" or "EU". If not specified or [BillingType](#BillingType) is - `EVALUATION`, a Google-Managed encryption key will be used. Format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*` + Primary Cloud Platform region for analytics data storage. For valid + values, see [Create an + organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). + Defaults to `us-west1`. + runtimeLocation: type: string - runtimeDatabaseEncryptionKeyName: description: >- - Cloud KMS key name used for encrypting the data that is stored and - replicated across runtime instances. Update is not allowed after the - organization is created. If not specified or - [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption - key will be used. For example: - "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** - Not supported for Apigee hybrid. + Cloud Platform location for the runtime instance. Defaults to zone + `us-west1-a`. If a region is provided, `EVAL` organizations will use + the region for automatically selecting a zone for the runtime + instance. + type: object + id: GoogleCloudApigeeV1ProvisionOrganizationRequest + description: Request for ProvisionOrganization. + GoogleCloudApigeeV1TestDatastoreResponse: + description: The response for TestDatastore + properties: + error: type: string - expiresAt: + readOnly: true + description: Output only. Error message of test connection failure + state: type: string readOnly: true - description: >- - Output only. Time that the Apigee organization is scheduled for - deletion. - format: int64 - runtimeType: + description: Output only. It could be `completed` or `failed` + type: object + id: GoogleCloudApigeeV1TestDatastoreResponse + GoogleCloudApigeeV1Point: + properties: + id: + description: Name of a step in the transaction. type: string - enumDescriptions: - - Runtime type not specified. - - Google-managed Apigee runtime. - - User-managed Apigee hybrid runtime. - description: >- - Required. Runtime type of the Apigee organization based on the - Apigee subscription purchased. - enum: - - RUNTIME_TYPE_UNSPECIFIED - - CLOUD - - HYBRID - environments: + results: type: array - description: Output only. List of environments in the Apigee organization. - readOnly: true + description: List of results extracted from a given debug point. items: - type: string - type: - description: Not used by Apigee. - enum: - - TYPE_UNSPECIFIED - - TYPE_TRIAL - - TYPE_PAID - - TYPE_INTERNAL - type: string - enumDescriptions: - - Subscription type not specified. - - >- - Subscription to Apigee is free, limited, and used for evaluation - purposes only. - - >- - Full subscription to Apigee has been purchased. See [Apigee - pricing](https://cloud.google.com/apigee/pricing/). - - For internal users only. - displayName: - description: >- - Display name for the Apigee organization. Unused, but reserved for - future use. - type: string - apiConsumerDataEncryptionKeyName: - description: >- - Cloud KMS key name used for encrypting API consumer data. If not - specified or [BillingType](#BillingType) is `EVALUATION`, a - Google-Managed encryption key will be used. Format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*` - type: string - name: - type: string - description: Output only. Name of the Apigee organization. - readOnly: true - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Properties defined in the Apigee organization profile. - projectId: - readOnly: true - type: string - description: Output only. Project ID associated with the Apigee organization. + $ref: '#/components/schemas/GoogleCloudApigeeV1Result' + type: object + description: >- + Point is a group of information collected by runtime plane at critical + points of the message flow of the processed API request. This is a list + of supported point IDs, categorized to three major buckets. For each + category, debug points that we are currently supporting are listed + below: - Flow status debug points: StateChange FlowInfo Condition + Execution DebugMask Error - Flow control debug points: FlowCallout + Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: + ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition + Oauth2ServicePoint RaiseFault NodeJS The detail information of the given + debug point is stored in a list of results. + id: GoogleCloudApigeeV1Point + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + type: object + description: The format of the assessment recommendation. + properties: + link: + description: The link for the recommendation. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink description: type: string - description: Description of the Apigee organization. - state: - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - readOnly: true - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - description: >- - Output only. State of the organization. Values other than ACTIVE - means the resource is not ready to use. - type: string - customerName: - description: Not used by Apigee. + description: The description of the recommendation. + GoogleCloudApigeeV1ListEnvironmentGroupsResponse: + id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse + type: object + description: Response for ListEnvironmentGroups. + properties: + nextPageToken: type: string - apigeeProjectId: description: >- - Output only. Apigee Project ID associated with the organization. Use - this project to allowlist Apigee in the Service Attachment when - using private service connect with Apigee. - type: string - readOnly: true - attributes: + Page token that you can include in a ListEnvironmentGroups request + to retrieve the next page. If omitted, no subsequent pages exist. + environmentGroups: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + type: array + description: EnvironmentGroups in the specified organization. + GoogleCloudApigeeV1ListEnvironmentResourcesResponse: + id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse + properties: + resourceFile: type: array items: - type: string - description: Not used by Apigee. - subscriptionType: - deprecated: true - readOnly: true - type: string - enumDescriptions: - - Subscription type not specified. - - Full subscription to Apigee has been purchased. - - >- - Subscription to Apigee is free, limited, and used for evaluation - purposes only. - enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAID - - TRIAL - description: >- - Output only. DEPRECATED: This will eventually be replaced by - BillingType. Subscription type of the Apigee organization. Valid - values include trial (free, limited, and for evaluation purposes - only) or paid (full subscription has been purchased). See [Apigee - pricing](https://cloud.google.com/apigee/pricing/). - addonsConfig: - description: Addon configurations of the Apigee organization. - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - createdAt: - description: >- - Output only. Time that the Apigee organization was created in - milliseconds since epoch. - format: int64 - type: string - readOnly: true - id: GoogleCloudApigeeV1Organization + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + description: List of resources files. + description: Response for ListEnvironmentResources type: object - GoogleCloudApigeeV1Query: + GoogleCloudApigeeV1SecurityActionConditionConfig: + id: GoogleCloudApigeeV1SecurityActionConditionConfig + type: object + description: >- + The following are a list of conditions. A valid SecurityAction must + contain at least one condition. Within a condition, each element is + ORed. Across conditions elements are ANDed. For example if a + SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and + bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: + enforce the action if the incoming request has ((ip_address_ranges = + "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR + bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges + and bot_reasons cannot be ANDed. properties: - dimensions: + apiKeys: + type: array + items: + type: string + description: Optional. A list of API keys. Limit 1000 per action. + developers: + type: array + items: + type: string + description: Optional. A list of developers. Limit 1000 per action. + botReasons: type: array description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + Optional. A list of Bot Reasons. Current options: Flooder, Brute + Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, + TorListRule, Advanced Anomaly Detection, Advanced API Scraper, + Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public + Cloud Azure, and Public Cloud Google. items: type: string - limit: - description: Maximum number of rows that can be returned in the result. - type: integer - format: int32 - csvDelimiter: - type: string + apiProducts: + description: Optional. A list of API Products. Limit 1000 per action. + type: array + items: + type: string + asns: + type: array description: >- - Delimiter used in the CSV file, if `outputFormat` is set to `csv`. - Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - envgroupHostname: - type: string + Optional. A list of ASN numbers to act on, e.g. 23. + https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses + int64 instead of uint32 because of + https://linter.aip.dev/141/forbidden-types. + items: + format: int64 + type: string + httpMethods: + items: + type: string description: >- - Hostname needs to be specified if query intends to run at host - level. This field is only allowed when query is submitted by - CreateHostAsyncQuery where analytics data will be grouped by - organization and hostname. - filter: - type: string - description: >- - Boolean expression that can be used to filter data. Filter - expressions can be combined using AND/OR terms and should be fully - parenthesized to avoid ambiguity. See Analytics metrics, dimensions, - and filters reference - https://docs.apigee.com/api-platform/analytics/analytics-reference - for more information on the fields available to filter on. For more - information on the tokens that you use to build filter expressions, - see Filter expression syntax. - https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax - outputFormat: - type: string + Optional. Act only on particular HTTP methods. E.g. A read-only API + can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, + POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH. + type: array + ipAddressRanges: description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. - name: - type: string - description: Asynchronous Query Name. - timeRange: + Optional. A list of IP addresses. This could be either IPv4 or IPv6. + Limited to 100 per action. + type: array + items: + type: string + accessTokens: + type: array + items: + type: string + description: Optional. A list of access_tokens. Limit 1000 per action. + regionCodes: + items: + type: string description: >- - Required. Time range for the query. Can use the following predefined - strings to specify the time range: `last60minutes` `last24hours` - `last7days` Or, specify the timeRange as a structure describing - start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": - "2018-08-01T00:18:00Z" } - type: any - metrics: + Optional. A list of countries/region codes to act on, e.g. US. This + follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. + type: array + userAgents: + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' - description: A list of Metrics. + type: string + description: >- + Optional. A list of user agents to deny. We look for exact matches. + Limit 50 per action. + developerApps: type: array - groupByTimeUnit: - type: string + items: + type: string + description: Optional. A list of developer apps. Limit 1000 per action. + GoogleCloudApigeeV1DebugSessionTransaction: + id: GoogleCloudApigeeV1DebugSessionTransaction + description: >- + A transaction contains all of the debug information of the entire + message flow of an API call processed by the runtime plane. The + information is collected and recorded at critical points of the message + flow in the runtime apiproxy. + properties: + point: description: >- - Time unit used to group the result set. Valid values include: - second, minute, hour, day, week, or month. If a query includes - groupByTimeUnit, then the result is an aggregation based on the - specified time unit and the resultant timestamp does not include - milliseconds precision. If a query omits groupByTimeUnit, then the - resultant timestamp includes milliseconds precision. - reportDefinitionId: - type: string - description: Asynchronous Report ID. + List of debug data collected by runtime plane at various defined + points in the flow. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Point' + completed: + type: boolean + description: Flag indicating whether a transaction is completed or not + type: object + GoogleCloudApigeeV1ProfileConfigAbuse: + id: GoogleCloudApigeeV1ProfileConfigAbuse type: object - id: GoogleCloudApigeeV1Query - GoogleCloudApigeeV1OperationGroup: description: >- - List of operation configuration details associated with Apigee API - proxies or remote services. Remote services are non-Apigee proxies, such - as Istio-Envoy. + Checks for abuse, which includes any requests sent to the API for + purposes other than what it is intended for, such as high volumes of + requests, data scraping, and abuse related to authorization. + properties: {} + GoogleCloudApigeeV1ListRatePlansResponse: + id: GoogleCloudApigeeV1ListRatePlansResponse type: object properties: - operationConfigType: - type: string - description: >- - Flag that specifes whether the configuration is for Apigee API proxy - or a remote service. Valid values include `proxy` or - `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API - proxies are associated with the API product. Set to `remoteservice` - when non-Apigee proxies like Istio-Envoy are associated with the API - product. - operationConfigs: + ratePlans: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' type: array + description: List of rate plans in an organization. + nextStartKey: description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. - id: GoogleCloudApigeeV1OperationGroup - GoogleCloudApigeeV1Score: - description: Represents Security Score. - id: GoogleCloudApigeeV1Score - type: object - properties: - component: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - description: Component containing score, recommendations and actions. - subcomponents: - type: array - description: List of all the drilldown score components. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - timeRange: - description: Start and end time for the score. - $ref: '#/components/schemas/GoogleTypeInterval' - GoogleCloudApigeeV1ScoreComponent: - type: object + Value that can be sent as `startKey` to retrieve the next page of + content. If this field is omitted, there are no subsequent pages. + type: string + description: Response for ListRatePlans. + GoogleCloudApigeeV1SecurityProfileScoringConfig: properties: - scorePath: - description: >- - Path of the component. Example: - /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy + description: + description: Description of the config. type: string - score: - type: integer - format: int32 - description: Score for the component. - dataCaptureTime: - format: google-datetime - description: >- - Time in the requested time period when data was last captured to - compute the score. + scorePath: type: string - calculateTime: + description: Path of the component config used for scoring. + title: type: string - description: Time when score was calculated. - format: google-datetime - recommendations: + description: Title of the config. + type: object + description: Security configurations to manage scoring. + id: GoogleCloudApigeeV1SecurityProfileScoringConfig + GoogleCloudApigeeV1DeveloperAppKey: + properties: + attributes: + description: List of attributes associated with the credential. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' type: array - description: List of recommendations to improve API security. - drilldownPaths: + status: + type: string + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. + scopes: type: array items: type: string - description: List of paths for next components. - id: GoogleCloudApigeeV1ScoreComponent - description: Component is an individual security element that is scored. - GoogleCloudApigeeV1Attribute: - properties: - value: - description: Value of the attribute. - type: string - name: + description: >- + Scopes to apply to the app. The specified scope names must already + be defined for the API product that you associate with the app. + expiresAt: + format: int64 type: string - description: API key of the attribute. - description: Key-value pair to store extra metadata. - id: GoogleCloudApigeeV1Attribute - type: object - GoogleRpcPreconditionFailure: - properties: - violations: - type: array - items: - $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' - description: Describes all precondition violations. - type: object - description: >- - Describes what preconditions have failed. For example, if an RPC failed - because it required the Terms of Service to be acknowledged, it could - list the terms of service violation in the PreconditionFailure message. - id: GoogleRpcPreconditionFailure - GoogleCloudApigeeV1AsyncQuery: - properties: - error: + description: Time the developer app expires in milliseconds since epoch. + consumerKey: + description: Consumer key. type: string - description: Error is set when query fails. - reportDefinitionId: + expiresInSeconds: + format: int64 + description: >- + Input only. Expiration time, in seconds, for the consumer key. If + not set or left to the default value of `-1`, the API key never + expires. The expiration time can't be updated after it is set. type: string - description: Asynchronous Report ID. - state: + apiProducts: + items: + type: any + description: >- + List of API products for which the credential can be used. **Note**: + Do not specify the list of API products when creating a consumer key + and secret for a developer app. Instead, use the + UpdateDeveloperAppKey API to make the association after the consumer + key and secret are created. + type: array + issuedAt: type: string - description: Query state could be "enqueued", "running", "completed", "failed". - resultRows: - description: ResultRows is available only after the query is completed. format: int64 + description: Time the developer app was created in milliseconds since epoch. + consumerSecret: type: string - executionTime: - type: string - description: ExecutionTime is available only after the query is completed. - self: - type: string - description: >- - Self link of the query. Example: - `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - or following format if query is running at host level: - `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - envgroupHostname: - type: string - description: Hostname is available only when query is executed at host level. - created: - type: string - description: Creation time of the query. - result: - description: Result is available only after the query is completed. - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' - queryParams: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' - description: >- - Contains information like metrics, dimenstions etc of the - AsyncQuery. - name: - type: string - description: Asynchronous Query Name. - resultFileSize: - description: ResultFileSize is available only after the query is completed. - type: string - updated: - description: Last updated timestamp for the query. - type: string - id: GoogleCloudApigeeV1AsyncQuery + description: Secret key. + type: object + id: GoogleCloudApigeeV1DeveloperAppKey + GoogleCloudApigeeV1TargetServerConfig: + id: GoogleCloudApigeeV1TargetServerConfig type: object - GoogleCloudApigeeV1ExportRequest: - id: GoogleCloudApigeeV1ExportRequest - description: Request body for [CreateExportRequest] properties: - csvDelimiter: - type: string + tlsInfo: + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' + description: TLS settings for the target server. + enabled: description: >- - Optional. Delimiter used in the CSV file, if `outputFormat` is set - to `csv`. Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). + Whether the target server is enabled. An empty/omitted value for + this field should be interpreted as true. + type: boolean name: - type: string - description: Required. Display name of the export job. - outputFormat: type: string description: >- - Optional. Output format of the export. Valid values include: `csv` - or `json`. Defaults to `json`. Note: Configure the delimiter for CSV - output using the `csvDelimiter` property. - dateRange: - description: Required. Date range of the data to export. - $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' - datastoreName: + Target server revision name in the following format: + `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` + port: + type: integer + description: Port number for the target server. + format: int32 + protocol: + description: The protocol used by this target server. + enum: + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + enumDescriptions: + - UNSPECIFIED defaults to HTTP for backwards compatibility. + - The TargetServer uses HTTP. + - The TargetSever uses HTTP2. + - The TargetServer uses GRPC. + - >- + GRPC TargetServer to be used in ExternalCallout Policy. Prefer to + use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once + EXTERNAL _CALLOUT generally available. + - The TargetServer is to be used in the ExternalCallout Policy type: string - description: Required. Name of the preconfigured datastore. - description: + host: + description: Host name of the target server. type: string - description: Optional. Description of the export job. - type: object - GoogleCloudApigeeV1ReportInstanceStatusRequest: - id: GoogleCloudApigeeV1ReportInstanceStatusRequest - description: Request for ReportInstanceStatus. + GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: type: object properties: - resources: - description: Status for config resources + pageToken: + type: string + description: >- + Page token stands for a specific collection of time series + sequences. + pageSize: + type: integer + format: int32 + description: >- + Page size represents the number of time series sequences, one per + unique set of dimensions and their values. + metrics: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' - reportTime: - description: >- - The time the report was generated in the runtime. Used to prevent an - old status from overwriting a newer one. An instance should space - out it's status reports so that clock skew does not play a factor. + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' + description: Required. List of metrics and their aggregations. + windowSize: + enum: + - WINDOW_SIZE_UNSPECIFIED + - MINUTE + - HOUR + - DAY + - MONTH type: string - format: google-datetime - instanceUid: + enumDescriptions: + - Unspecified window size. Default is 1 hour. + - 1 Minute window + - 1 Hour window + - 1 Day window + - 1 Month window + description: Time buckets to group the stats by. + timestampOrder: + enumDescriptions: + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. type: string + enum: + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING description: >- - A unique ID for the instance which is guaranteed to be unique in - case the user installs multiple hybrid runtimes with the same - instance ID. - GoogleCloudApigeeV1QueryTabularStatsRequest: - description: >- - Request payload representing the query to be run for fetching security - statistics as rows. - type: object - id: GoogleCloudApigeeV1QueryTabularStatsRequest - properties: + Order the sequences in increasing or decreasing order of timestamps. + Default is descending order of timestamps (latest first). dimensions: + description: >- + List of dimension names to group the aggregations by. If no + dimensions are passed, a single trend line representing the + requested metric aggregations grouped by environment is returned. items: type: string type: array - description: Required. List of dimension names to group the aggregations by. - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Time range for the stats. filter: - type: string description: >- Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters - pageSize: - format: int32 - type: integer - description: Page size represents the number of rows. - metrics: - description: Required. List of metrics and their aggregations. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - type: array - pageToken: - description: Identifies a sequence of rows. type: string - GoogleCloudApigeeV1SecurityReportQuery: + timeRange: + description: Required. Time range for the stats. + $ref: '#/components/schemas/GoogleTypeInterval' + id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + description: >- + QueryTimeSeriesStatsRequest represents a query that returns a collection + of time series sequences grouped by their values. + GoogleCloudApigeeV1ApiDoc: + description: >- + `ApiDoc` represents an API catalog item. Catalog items are used in two + ways in a portal: - Users can browse and interact with a visual + representation of the API documentation - The `api_product_name` field + provides a link to a backing [API product] + (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). + Through this link, portal users can create and manage developer apps + linked to one or more API products. type: object properties: - reportDefinitionId: - type: string - description: Report Definition ID. - envgroupHostname: - type: string + published: + type: boolean description: >- - Hostname needs to be specified if query intends to run at host - level. This field is only allowed when query is submitted by - CreateHostSecurityReport where analytics data will be grouped by - organization and hostname. - limit: - format: int32 - type: integer - description: Maximum number of rows that can be returned in the result. - metrics: + Optional. Denotes whether the catalog item is published to the + portal or is in a draft state. When the parent portal is enrolled in + the [audience management + feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), + the visibility can be set to public on creation by setting the + anonAllowed flag to true or further managed in the management UI + (see [Manage the visibility of an API in your + portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) + before it can be visible to any users. If not enrolled in the + audience management feature, the visibility is managed by the + `anonAllowed` flag. + categoryIds: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' - description: A list of Metrics. + type: string type: array - dimensions: description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions - type: array - items: - type: string - groupByTimeUnit: - type: string + Optional. The IDs of the API categories to which this catalog item + belongs. + title: description: >- - Time unit used to group the result set. Valid values include: - second, minute, hour, day, week, or month. If a query includes - groupByTimeUnit, then the result is an aggregation based on the - specified time unit and the resultant timestamp does not include - milliseconds precision. If a query omits groupByTimeUnit, then the - resultant timestamp includes milliseconds precision. - mimeType: + Required. The user-facing name of the catalog item. `title` must be + a non-empty string with a max length of 255 characters. type: string + modified: description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. - timeRange: + Output only. Time the catalog item was last modified in milliseconds + since epoch. + readOnly: true + format: int64 + type: string + description: + type: string description: >- - Required. Time range for the query. Can use the following predefined - strings to specify the time range: `last60minutes` `last24hours` - `last7days` Or, specify the timeRange as a structure describing - start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": - "2018-08-01T00:18:00Z" } - type: any - csvDelimiter: - type: string + Optional. Description of the catalog item. Max length is 10,000 + characters. + anonAllowed: + type: boolean description: >- - Delimiter used in the CSV file, if `outputFormat` is set to `csv`. - Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - filter: + Optional. Boolean flag that manages user access to the catalog item. + When true, the catalog item has public visibility and can be viewed + anonymously; otherwise, only registered users may view it. Note: + when the parent portal is enrolled in the [audience management + feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), + and this flag is set to false, visibility is set to an indeterminate + state and must be explicitly specified in the management UI (see + [Manage the visibility of an API in your + portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). + Additionally, when enrolled in the audience management feature, + updates to this flag will be ignored as visibility permissions must + be updated in the management UI. + siteId: + description: Output only. The ID of the parent portal. + readOnly: true type: string + requireCallbackUrl: + type: boolean description: >- - Boolean expression that can be used to filter data. Filter - expressions can be combined using AND/OR terms and should be fully - parenthesized to avoid ambiguity. See Analytics metrics, dimensions, - and filters reference - https://docs.apigee.com/api-platform/analytics/analytics-reference - for more information on the fields available to filter on. For more - information on the tokens that you use to build filter expressions, - see Filter expression syntax. - https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax - displayName: + Optional. Whether a callback URL is required when this catalog + item's API product is enabled in a developer app. When true, a + portal user will be required to input a URL when managing the app + (this is typically used for the app's OAuth flow). + graphqlSchema: type: string - description: Security Report display name which users can specify. - id: GoogleCloudApigeeV1SecurityReportQuery - description: Body structure when user makes a request to create a security report. - GoogleCloudApigeeV1TestDatastoreResponse: - properties: - error: + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + deprecated: true + id: readOnly: true - description: Output only. Error message of test connection failure + description: Output only. The ID of the catalog item. + format: int64 type: string - state: + graphqlSchemaDisplayName: type: string - description: Output only. It could be `completed` or `failed` - readOnly: true - id: GoogleCloudApigeeV1TestDatastoreResponse - type: object - description: The response for TestDatastore - GoogleCloudApigeeV1RuntimeTraceConfigOverride: - id: GoogleCloudApigeeV1RuntimeTraceConfigOverride - description: >- - NEXT ID: 7 Trace configuration override for a specific API proxy in an - environment. - type: object - properties: - name: description: >- - Name of the trace config override in the following format: - `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + deprecated: true + visibility: + description: 'Optional. DEPRECATED: use the `published` field instead' + type: boolean + edgeAPIProductName: type: string - samplingConfig: description: >- - Trace configuration override for a specific API proxy in an - environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - revisionCreateTime: - description: The timestamp that the revision was created or updated. - format: google-datetime + Optional. Immutable. DEPRECATED: use the `apiProductName` field + instead + graphqlEndpointUrl: + deprecated: true type: string - revisionId: + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + imageUrl: type: string description: >- - Revision number which can be used by the runtime to detect if the - trace config override has changed between two versions. - uid: + Optional. Location of the image used for the catalog item in the + catalog. This can be either an image with an external URL or a file + path for [image files stored in the + portal](/apigee/docs/api-platform/publish/portal/portal-files"), for + example, `/files/book-tree.jpg`. When specifying the URL of an + external image, the image won't be uploaded to your assets; + additionally, loading the image in the integrated portal will be + subject to its availability, which may be blocked or restricted by + [content security + policies](/apigee/docs/api-platform/publish/portal/csp). Max length + of file path is 2,083 characters. + apiProductName: type: string description: >- - Unique ID for the configuration override. The ID will only change if - the override is deleted and recreated. Corresponds to name's - "override" field. - apiProxy: + Required. Immutable. The `name` field of the associated [API + product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). + A portal may have only one catalog item associated with a given API + product. + specId: + deprecated: true + description: 'Optional. DEPRECATED: DO NOT USE' + type: string + id: GoogleCloudApigeeV1ApiDoc + GoogleCloudApigeeV1SecurityAssessmentResultResource: + properties: + type: + enum: + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. + type: string + description: Required. Type of this resource. + resourceRevisionId: + type: string description: >- - Name of the API proxy that will have its trace configuration - overridden following format: `organizations/{org}/apis/{api}` + The revision id for the resource. In case of Apigee, this is proxy + revision id. + name: type: string - GoogleCloudApigeeV1AppGroupApp: - description: >- - Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], - [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and - [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] - id: GoogleCloudApigeeV1AppGroupApp + description: Required. Name of this resource. + description: Resource for which we are computing security assessment. + id: GoogleCloudApigeeV1SecurityAssessmentResultResource + type: object + GoogleCloudApigeeV1SecurityProfileEnvironment: + id: GoogleCloudApigeeV1SecurityProfileEnvironment + type: object properties: - createdAt: + attachTime: readOnly: true - format: int64 - description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. type: string - apiProducts: - type: array - description: List of API products associated with the AppGroup app. - items: - type: string - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - description: List of attributes for the AppGroup app. - keyExpiresIn: - format: int64 description: >- - Immutable. Expiration time, in seconds, for the consumer key that is - generated for the AppGroup app. If not set or left to the default - value of `-1`, the API key never expires. The expiration time can't - be updated after it is set. + Output only. Time at which environment was attached to the security + profile. + format: google-datetime + environment: + readOnly: true type: string - appGroup: + description: Output only. Name of the environment. + description: >- + Environment information of attached environments. Scoring an environment + is enabled only if it is attached to a security profile. + GoogleCloudApigeeV1Datastore: + description: >- + The data store defines the connection to export data repository (Cloud + Storage, BigQuery), including the credentials used to access the data + repository. + id: GoogleCloudApigeeV1Datastore + properties: + org: type: string + description: Output only. Organization that the datastore belongs to + readOnly: true + lastUpdateTime: description: >- - Immutable. Name of the parent AppGroup whose resource name format is - of syntax (organizations/*/appgroups/*). - credentials: - description: >- - Output only. Set of credentials for the AppGroup app consisting of - the consumer key/secret pairs associated with the API products. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + Output only. Datastore last update time, in milliseconds since the + epoch of 1970-01-01T00:00:00Z + format: int64 + readOnly: true + type: string + createTime: readOnly: true - scopes: - items: - type: string - type: array description: >- - Scopes to apply to the AppGroup app. The specified scopes must - already exist for the API product that you associate with the - AppGroup app. - status: - description: Status of the App. Valid values include `approved` or `revoked`. + Output only. Datastore create time, in milliseconds since the epoch + of 1970-01-01T00:00:00Z type: string - name: + format: int64 + displayName: + description: Required. Display name in UI type: string - description: >- - Immutable. Name of the AppGroup app whose resource name format is of - syntax (organizations/*/appgroups/*/apps/*). - lastModifiedAt: + datastoreConfig: + description: Datastore Configurations. + $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' + self: readOnly: true - format: int64 - description: >- - Output only. Time the AppGroup app was modified in milliseconds - since epoch. type: string - callbackUrl: description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to AppGroup apps. - type: string - appId: + Output only. Resource link of Datastore. Example: + `/organizations/{org}/analytics/datastores/{uuid}` + targetType: type: string - description: Immutable. ID of the AppGroup app. - type: object - GoogleCloudApigeeV1SecurityActionDeny: - id: GoogleCloudApigeeV1SecurityActionDeny - description: Message that should be set in case of a Deny Action. - properties: - responseCode: - type: integer - description: Optional. The HTTP response code if the Action = DENY. - format: int32 + description: Destination storage type. Supported types `gcs` or `bigquery`. type: object - GoogleRpcStatus: + GoogleCloudApigeeV1Developer: type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - properties: - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - GoogleCloudApigeeV1SecurityAssessmentResult: properties: - createTime: - type: string - format: google-datetime + createdAt: description: >- - The time of the assessment of this resource. This could lag behind - `assessment_time` due to caching within the backend. - resource: - description: The assessed resource. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The error status if scoring fails. - scoringResult: - description: The result of the assessment. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - type: object - description: The security assessment result for one resource. - id: GoogleCloudApigeeV1SecurityAssessmentResult - GoogleCloudApigeeV1AnalyticsConfig: - description: Configuration for the Analytics add-on. - id: GoogleCloudApigeeV1AnalyticsConfig - properties: - updateTime: - description: Output only. The latest update time. - readOnly: true - format: google-datetime + Output only. Time at which the developer was created in milliseconds + since epoch. + format: int64 type: string - state: - description: Output only. The state of the Analytics add-on. readOnly: true + lastModifiedAt: type: string - enum: - - ADDON_STATE_UNSPECIFIED - - ENABLING - - ENABLED - - DISABLING - - DISABLED - enumDescriptions: - - Default value. - - Add-on is in progress of enabling. - - Add-on is fully enabled and ready to use. - - Add-on is in progress of disabling. - - Add-on is fully disabled. - enabled: - description: Whether the Analytics add-on is enabled. - type: boolean - expireTimeMillis: format: int64 - readOnly: true - type: string description: >- - Output only. Time at which the Analytics add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. - type: object - GoogleCloudApigeeV1ListHybridIssuersResponse: - id: GoogleCloudApigeeV1ListHybridIssuersResponse - properties: - issuers: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' - description: Lists of hybrid services and its trusted issuer email ids. - type: array - type: object - GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: - description: Request for AdjustDeveloperBalance. - properties: - adjustment: - $ref: '#/components/schemas/GoogleTypeMoney' + Output only. Time at which the developer was last modified in + milliseconds since epoch. + readOnly: true + email: description: >- - * A positive value of `adjustment` means that that the API provider - wants to adjust the balance for an under-charged developer i.e. the - balance of the developer will decrease. * A negative value of - `adjustment` means that that the API provider wants to adjust the - balance for an over-charged developer i.e. the balance of the - developer will increase. - id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest - type: object - GoogleCloudApigeeV1ApiCategoryResponse: - description: The API category resource wrapped with response status, error_code, etc. - id: GoogleCloudApigeeV1ApiCategoryResponse - type: object - properties: - message: + Required. Email address of the developer. This value is used to + uniquely identify the developer in Apigee hybrid. Note that the + email address has to be in lowercase only. type: string - description: Description of the operation. - status: + firstName: type: string - description: Status of the operation. - requestId: - description: Unique ID of the request. + description: Required. First name of the developer. + attributes: + description: >- + Optional. Developer attributes (name/value pairs). The custom + attribute limit is 18. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + lastName: type: string - data: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - description: The API category resource. - errorCode: + description: Required. Last name of the developer. + userName: + description: Required. User name of the developer. Not used by Apigee hybrid. type: string - description: Unique error code for the request, if any. - GoogleCloudApigeeV1ApiSecurityRuntimeConfig: - description: >- - Response for - GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. - id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig - type: object - properties: - updateTime: - description: Time that the API Security Runtime configuration was updated. + status: type: string - format: google-datetime - revisionId: - format: int64 description: >- - Revision ID of the API Security Runtime configuration. The higher - the value, the more recently the configuration was deployed. - type: string - uid: + Output only. Status of the developer. Valid values are `active` and + `inactive`. + readOnly: true + organizationName: + readOnly: true description: >- - Unique ID for the API Security Runtime configuration. The ID will - only change if the environment is deleted and recreated. + Output only. Name of the Apigee organization in which the developer + resides. + type: string + developerId: type: string - name: description: >- - Name of the environment API Security Runtime configuration resource. - Format: - `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` + ID of the developer. **Note**: IDs are generated internally by + Apigee and are not guaranteed to stay the same over time. + companies: + description: List of companies associated with the developer. + type: array + items: + type: string + appFamily: + description: Developer app family. type: string - location: + accessType: + description: Access type. + type: string + apps: type: array - description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. items: type: string - GoogleCloudApigeeV1GenerateUploadUrlRequest: + description: List of apps associated with the developer. + id: GoogleCloudApigeeV1Developer + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: + description: The response for GetAsyncQueryResultUrl + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse type: object - properties: {} - description: Request for GenerateUploadUrl method. - id: GoogleCloudApigeeV1GenerateUploadUrlRequest - GoogleCloudApigeeV1ListEnvironmentGroupsResponse: - description: Response for ListEnvironmentGroups. - id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse properties: - environmentGroups: - description: EnvironmentGroups in the specified organization. + urls: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + description: The list of Signed URLs generated by the CreateAsyncQuery request type: array - nextPageToken: - description: >- - Page token that you can include in a ListEnvironmentGroups request - to retrieve the next page. If omitted, no subsequent pages exist. - type: string - type: object - GoogleCloudApigeeV1ListAppsResponse: + GoogleCloudApigeeV1QueryMetadata: type: object + id: GoogleCloudApigeeV1QueryMetadata properties: - totalSize: - format: int32 - type: integer - description: Total count of Apps. - nextPageToken: + endTimestamp: + description: End timestamp of the query range. type: string - description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - app: + timeUnit: + description: Query GroupBy time unit. + type: string + startTimestamp: + type: string + description: Start timestamp of the query range. + dimensions: + description: Dimensions of the AsyncQuery. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' + type: string type: array - id: GoogleCloudApigeeV1ListAppsResponse - GoogleCloudApigeeV1RevenueShareRange: - properties: - start: - format: int64 - type: string - description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. - sharePercentage: - description: >- - Percentage of the revenue to be shared with the developer. For - example, to share 21 percent of the total revenue with the - developer, set this value to 21. Specify a decimal number with a - maximum of two digits following the decimal point. - type: number - format: double - end: + outputFormat: type: string + description: Output format. + metrics: + type: array + items: + type: string description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - format: int64 - id: GoogleCloudApigeeV1RevenueShareRange - type: object - description: >- - API call volume range and the percentage of revenue to share with the - developer when the total number of API calls is within the range. - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: + Metrics of the AsyncQuery. Example: + ["name:message_count,func:sum,alias:sum_message_count"] + GoogleCloudApigeeV1DocumentationFile: type: object - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest - description: Request for BatchComputeSecurityAssessmentResults. + description: Documentation file contents for a catalog item. properties: - scope: - description: >- - Required. Scope of the resources for the computation. For Apigee, - the environment is the scope of the resources. - type: string - profile: - description: Required. Name of the profile that is used for computation. + contents: + format: byte + description: Required. The file contents. The max size is 4 MB. type: string - include: - description: Include only these resources. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray - pageToken: + displayName: type: string description: >- - Optional. A page token, received from a previous - `BatchComputeSecurityAssessmentResults` call. Provide this to - retrieve the subsequent page. - includeAllResources: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - description: Include all resources under the scope. - pageSize: - type: integer - format: int32 - description: >- - Optional. The maximum number of results to return. The service may - return fewer than this value. If unspecified, at most 50 results - will be returned. - GoogleCloudApigeeV1GenerateDownloadUrlRequest: - properties: {} - id: GoogleCloudApigeeV1GenerateDownloadUrlRequest - type: object - description: Request for GenerateDownloadUrl method. - GoogleCloudApigeeV1Point: + Required. A display name for the file, shown in the management UI. + Max length is 255 characters. + id: GoogleCloudApigeeV1DocumentationFile + GoogleCloudApigeeV1ListExportsResponse: properties: - id: - type: string - description: Name of a step in the transaction. - results: - type: array - description: List of results extracted from a given debug point. + exports: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Result' - type: object - description: >- - Point is a group of information collected by runtime plane at critical - points of the message flow of the processed API request. This is a list - of supported point IDs, categorized to three major buckets. For each - category, debug points that we are currently supporting are listed - below: - Flow status debug points: StateChange FlowInfo Condition - Execution DebugMask Error - Flow control debug points: FlowCallout - Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: - ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition - Oauth2ServicePoint RaiseFault NodeJS The detail information of the given - debug point is stored in a list of results. - id: GoogleCloudApigeeV1Point - GoogleIamV1TestIamPermissionsRequest: - id: GoogleIamV1TestIamPermissionsRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + type: array + description: Details of the export jobs. + id: GoogleCloudApigeeV1ListExportsResponse + description: The response for ListExports type: object + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse properties: - permissions: + operations: type: array 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). + A list of operations that matches the specified filter in the + request. items: - type: string - description: Request message for `TestIamPermissions` method. - GoogleCloudApigeeV1UpdateSecurityIncidentRequest: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. + type: string + description: The response message for Operations.ListOperations. type: object - description: Request for UpdateSecurityIncident. + GoogleCloudApigeeV1OperationConfig: + id: GoogleCloudApigeeV1OperationConfig properties: - securityIncident: + apiSource: description: >- - Required. The security incident to update. Must contain all existing - populated fields of the current incident. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - updateMask: + Required. Name of the API proxy or remote service with which the + resources, methods, and quota are associated. type: string - description: >- - Required. The list of fields to update. Allowed fields are: - LINT.IfChange(allowed_update_fields_comment) - observability - LINT.ThenChange() - format: google-fieldmask - id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest - GoogleCloudApigeeV1DebugSessionTransaction: - properties: - completed: - type: boolean - description: Flag indicating whether a transaction is completed or not - point: + attributes: + description: Custom attributes associated with the operation. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Point' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' type: array + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' description: >- - List of debug data collected by runtime plane at various defined - points in the flow. - id: GoogleCloudApigeeV1DebugSessionTransaction - description: >- - A transaction contains all of the debug information of the entire - message flow of an API call processed by the runtime plane. The - information is collected and recorded at critical points of the message - flow in the runtime apiproxy. + Quota parameters to be enforced for the resources, methods, and API + source combination. If none are specified, quota enforcement will + not be done. + operations: + type: array + description: >- + List of resource/method pairs for the API proxy or remote service to + which quota will applied. **Note**: Currently, you can specify only + a single resource/method pair. The call will fail if more than one + resource/method pair is provided. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' type: object - GoogleCloudApigeeV1UpdateError: - description: Details on why a resource update failed in the runtime. + description: >- + Binds the resources in an API proxy or remote service with the allowed + REST methods and associated quota enforcement. + GoogleCloudApigeeV1DeveloperMonetizationConfig: + description: Monetization configuration for the developer. + id: GoogleCloudApigeeV1DeveloperMonetizationConfig type: object - id: GoogleCloudApigeeV1UpdateError properties: - code: + billingType: + description: Billing type. + type: string enum: - - OK - - CANCELLED - - UNKNOWN - - INVALID_ARGUMENT - - DEADLINE_EXCEEDED - - NOT_FOUND - - ALREADY_EXISTS - - PERMISSION_DENIED - - UNAUTHENTICATED - - RESOURCE_EXHAUSTED - - FAILED_PRECONDITION - - ABORTED - - OUT_OF_RANGE - - UNIMPLEMENTED - - INTERNAL - - UNAVAILABLE - - DATA_LOSS + - BILLING_TYPE_UNSPECIFIED + - PREPAID + - POSTPAID enumDescriptions: - - 'Not an error; returned on success. HTTP Mapping: 200 OK' - - >- - The operation was cancelled, typically by the caller. HTTP - Mapping: 499 Client Closed Request - - >- - Unknown error. For example, this error may be returned when a - `Status` value received from another address space belongs to an - error space that is not known in this address space. Also errors - raised by APIs that do not return enough error information may be - converted to this error. HTTP Mapping: 500 Internal Server Error - - >- - The client specified an invalid argument. Note that this differs - from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments - that are problematic regardless of the state of the system (e.g., - a malformed file name). HTTP Mapping: 400 Bad Request + - The default/unset value. - >- - The deadline expired before the operation could complete. For - operations that change the state of the system, this error may be - returned even if the operation has completed successfully. For - example, a successful response from a server could have been - delayed long enough for the deadline to expire. HTTP Mapping: 504 - Gateway Timeout + Developer pays in advance for the use of APIs and the charged + amount is deducted from their account balance. - >- - Some requested entity (e.g., file or directory) was not found. - Note to server developers: if a request is denied for an entire - class of users, such as gradual feature rollout or undocumented - allowlist, `NOT_FOUND` may be used. If a request is denied for - some users within a class of users, such as user-based access - control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not - Found + Developer does not maintain an account balance. The API provider + bills the developer for API usage. + GoogleCloudApigeeV1RuntimeTraceSamplingConfig: + properties: + samplingRate: + type: number + format: float + description: >- + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + sampler: + type: string + enumDescriptions: + - Sampler unspecified. - >- - The entity that a client attempted to create (e.g., file or - directory) already exists. HTTP Mapping: 409 Conflict + OFF means distributed trace is disabled, or the sampling + probability is 0. - >- - The caller does not have permission to execute the specified - operation. `PERMISSION_DENIED` must not be used for rejections - caused by exhausting some resource (use `RESOURCE_EXHAUSTED` - instead for those errors). `PERMISSION_DENIED` must not be used if - the caller can not be identified (use `UNAUTHENTICATED` instead - for those errors). This error code does not imply the request is - valid or the requested entity exists or satisfies other - pre-conditions. HTTP Mapping: 403 Forbidden - - >- - The request does not have valid authentication credentials for the - operation. HTTP Mapping: 401 Unauthorized - - >- - Some resource has been exhausted, perhaps a per-user quota, or - perhaps the entire file system is out of space. HTTP Mapping: 429 - Too Many Requests - - >- - The operation was rejected because the system is not in a state - required for the operation's execution. For example, the directory - to be deleted is non-empty, an rmdir operation is applied to a - non-directory, etc. Service implementors can use the following - guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and - `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just - the failing call. (b) Use `ABORTED` if the client should retry at - a higher level. For example, when a client-specified test-and-set - fails, indicating the client should restart a read-modify-write - sequence. (c) Use `FAILED_PRECONDITION` if the client should not - retry until the system state has been explicitly fixed. For - example, if an "rmdir" fails because the directory is non-empty, - `FAILED_PRECONDITION` should be returned since the client should - not retry unless the files are deleted from the directory. HTTP - Mapping: 400 Bad Request - - >- - The operation was aborted, typically due to a concurrency issue - such as a sequencer check failure or transaction abort. See the - guidelines above for deciding between `FAILED_PRECONDITION`, - `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict - - >- - The operation was attempted past the valid range. E.g., seeking or - reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error - indicates a problem that may be fixed if the system state changes. - For example, a 32-bit file system will generate `INVALID_ARGUMENT` - if asked to read at an offset that is not in the range [0,2^32-1], - but it will generate `OUT_OF_RANGE` if asked to read from an - offset past the current file size. There is a fair bit of overlap - between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend - using `OUT_OF_RANGE` (the more specific error) when it applies so - that callers who are iterating through a space can easily look for - an `OUT_OF_RANGE` error to detect when they are done. HTTP - Mapping: 400 Bad Request - - >- - The operation is not implemented or is not supported/enabled in - this service. HTTP Mapping: 501 Not Implemented - - >- - Internal errors. This means that some invariants expected by the - underlying system have been broken. This error code is reserved - for serious errors. HTTP Mapping: 500 Internal Server Error - - >- - The service is currently unavailable. This is most likely a - transient condition, which can be corrected by retrying with a - backoff. Note that it is not always safe to retry non-idempotent - operations. See the guidelines above for deciding between - `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: - 503 Service Unavailable - - >- - Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal - Server Error - type: string - description: Status code. - type: - type: string - description: >- - A string that uniquely identifies the type of error. This provides a - more reliable means to deduplicate errors across revisions and - instances. - resource: - description: >- - The sub resource specific to this error (e.g. a proxy deployed - within the EnvironmentConfig). If empty the error refers to the top - level resource. - type: string - message: - type: string - description: User-friendly error message. - GoogleCloudApigeeV1ApiDocResponse: - id: GoogleCloudApigeeV1ApiDocResponse + PROBABILITY means traces are captured on a probability that + defined by sampling_rate. The sampling rate is limited to 0 to 0.5 + when this is set. + enum: + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY + description: Sampler of distributed tracing. OFF is the default value. type: object - description: The catalog item resource wrapped with response status, error_code, etc. - properties: - errorCode: - description: Unique error code for the request, if any. - type: string - requestId: - type: string - description: Unique ID of the request. - message: - type: string - description: Description of the operation. - data: - description: The catalog item resource. - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - status: - type: string - description: Status of the operation. - GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: + id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig description: >- - Filter scores by component path. Used custom filter instead of AIP-160 - as the use cases are highly constrained and predictable. - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter - type: object - properties: - scorePath: - type: string - description: >- - Optional. Return scores for this component. Example: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - GoogleCloudApigeeV1OperationMetadata: + NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of + distributed tracing. Only the fields that are defined in the distributed + trace configuration can be overridden using the distribute trace + configuration override APIs. + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: properties: - progress: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' - description: Progress of the operation. - operationType: - enumDescriptions: - - '' - - '' - - '' - - '' + weight: enum: - - OPERATION_TYPE_UNSPECIFIED - - INSERT - - DELETE - - UPDATE + - WEIGHT_UNSPECIFIED + - MINOR + - MODERATE + - MAJOR + description: The weight of the assessment which was set in the profile. type: string - state: enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED - type: string - targetResourceName: - description: Name of the resource for which the operation is operating on. + - The weight is unspecified. + - The weight is minor. + - The weight is moderate. + - The weight is major. + displayName: + description: The display name of the assessment. type: string - warnings: - description: Warnings encountered while executing the operation. + recommendations: + description: The recommended steps of the assessment. items: - type: string + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation type: array + verdict: + enumDescriptions: + - The verdict is unspecified. + - The assessment has passed. + - The assessment has failed. + enum: + - VERDICT_UNSPECIFIED + - PASS + - FAIL + description: Verdict indicates the assessment result. + type: string + scoreImpact: + format: int32 + description: >- + Score impact indicates the impact on the overall score if the + assessment were to pass. + type: integer + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + description: The message format of a recommendation from the assessment. type: object - description: Metadata describing an Operation. - id: GoogleCloudApigeeV1OperationMetadata - GoogleCloudApigeeV1IngressConfig: - type: object - id: GoogleCloudApigeeV1IngressConfig + GoogleCloudApigeeV1ResourceFile: properties: - environmentGroups: - description: List of environment groups in the organization. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' - name: - description: >- - Name of the resource in the following format: - `organizations/{org}/deployedIngressConfig`. + type: type: string - revisionCreateTime: - description: Time at which the IngressConfig revision was created. + description: Resource file type. {{ resource_file_type }} + name: + description: ID of the resource file. type: string + type: object + id: GoogleCloudApigeeV1ResourceFile + description: Metadata about a resource file. + GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: + description: Request for ExpireDeveloperSubscription. + properties: {} + type: object + id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + GoogleTypeInterval: + type: object + properties: + endTime: format: google-datetime - revisionId: - format: int64 description: >- - Revision id that defines the ordering on IngressConfig resources. - The higher the revision, the more recently the configuration was - deployed. + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. type: string - uid: + startTime: description: >- - A unique id for the ingress config that will only change if the - organization is deleted and recreated. + 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 type: string - GoogleCloudApigeeV1InstanceAttachment: description: >- - InstanceAttachment represents the installation of an environment onto an - instance. + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + id: GoogleTypeInterval + GoogleRpcPreconditionFailureViolation: properties: - name: - type: string - readOnly: true - description: Output only. ID of the attachment. - createdAt: - format: int64 - type: string + description: description: >- - Output only. Time the attachment was created in milliseconds since - epoch. - readOnly: true - environment: + A description of how the precondition failed. Developers can use + this description to understand how to fix the failure. For example: + "Terms of service not accepted". + type: string + subject: + type: string + description: >- + The subject, relative to the type, that failed. For example, + "google.com/cloud" relative to the "TOS" type would indicate which + terms of service is being referenced. + type: + description: >- + The type of PreconditionFailure. We recommend using a + service-specific enum type to define the supported precondition + violation subjects. For example, "TOS" for "Terms of Service + violation". type: string - description: ID of the attached environment. - id: GoogleCloudApigeeV1InstanceAttachment - type: object - GoogleCloudApigeeV1Access: type: object + description: A message type used to describe a single precondition failure. + id: GoogleRpcPreconditionFailureViolation + GoogleCloudApigeeV1ConfigVersion: properties: - Remove: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' - Get: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' - Set: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' - id: GoogleCloudApigeeV1Access - GoogleCloudApigeeV1SecurityActionHttpHeader: + minorVersion: + description: Minor version of the API proxy configuration schema. + type: integer + format: int32 + majorVersion: + format: int32 + type: integer + description: Major version of the API proxy configuration schema. + id: GoogleCloudApigeeV1ConfigVersion + description: >- + Version of the API proxy configuration schema. Currently, only 4.0 is + supported. type: object - id: GoogleCloudApigeeV1SecurityActionHttpHeader + GoogleCloudApigeeV1StatsHostStats: properties: - value: - type: string - description: The header value to be sent to the target. + dimensions: + description: List of metrics grouped under dimensions. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' + metrics: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + description: >- + In the final response, only one of the following fields will be + present based on the dimensions provided. If no dimensions are + provided, then only the top-level metrics are provided. If + dimensions are included, then there will be a top-level dimensions + field under hostnames which will contain metrics values and the + dimension name. Example: ``` "hosts": [ { "dimensions": [ { + "metrics": [ { "name": "sum(message_count)", "values": [ + "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" + } ]``` OR ```"hosts": [ { "metrics": [ { "name": + "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": + "example.com" } ]``` List of metric values. name: type: string - description: The header name to be sent to the target. - description: An HTTP header. - GoogleCloudApigeeV1DeveloperApp: - id: GoogleCloudApigeeV1DeveloperApp + description: Hostname used in query. + id: GoogleCloudApigeeV1StatsHostStats + type: object + description: >- + Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { + "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": + "example.com" } ]``` + GoogleCloudApigeeV1GenerateDownloadUrlResponse: + type: object + id: GoogleCloudApigeeV1GenerateDownloadUrlResponse + description: Response for GenerateDownloadUrl method. properties: - scopes: + downloadUri: description: >- - Scopes to apply to the developer app. The specified scopes must - already exist for the API product that you associate with the - developer app. + The Google Cloud Storage signed URL that can be used to download the + Archive zip file. + type: string + GoogleCloudApigeeV1ScoreComponentRecommendation: + description: Recommendation based on security concerns and score. + properties: + impact: + format: int32 + description: >- + Potential impact of this recommendation on the overall score. This + denotes how important this recommendation is to improve the score. + type: integer + actions: type: array items: - type: string - createdAt: - format: int64 - description: >- - Output only. Time the developer app was created in milliseconds - since epoch. - type: string - readOnly: true - appFamily: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction + description: Actions for the recommendation to improve the security score. + description: type: string - description: Developer app family. - appId: + description: Description of the recommendation. + title: + description: Title represents recommendation title. type: string - description: ID of the developer app. - credentials: - type: array + type: object + id: GoogleCloudApigeeV1ScoreComponentRecommendation + GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: + properties: + shouldSequenceRollout: description: >- - Output only. Set of credentials for the developer app consisting of - the consumer key/secret pairs associated with the API products. - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - keyExpiresIn: - format: int64 + Set to `true` if using sequenced rollout would make this routing + change safer. **Note**: This does not necessarily imply that + automated sequenced rollout mode is supported for the operation. + type: boolean + toDeployment: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment description: >- - Expiration time, in milliseconds, for the consumer key that is - generated for the developer app. If not set or left to the default - value of `-1`, the API key never expires. The expiration time can't - be updated after it is set. - type: string - callbackUrl: + Base path/deployment that may start receiving that traffic. May be + null if no deployment is able to receive the traffic. + fromDeployment: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: Base path/deployment that may stop receiving some traffic. + environmentGroup: type: string - description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to developer apps. - lastModifiedAt: - readOnly: true - format: int64 + description: Name of the environment group affected by this routing change. + description: + description: Human-readable description of this routing change. type: string + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + type: object + description: >- + Describes a potential routing change that may occur as a result of some + deployment operation. + GoogleCloudApigeeV1GraphQLOperationConfig: + properties: + apiSource: description: >- - Output only. Time the developer app was modified in milliseconds - since epoch. - developerId: - type: string - description: ID of the developer. - name: + Required. Name of the API proxy endpoint or remote service with + which the GraphQL operation and quota are associated. type: string - description: Name of the developer app. - apiProducts: - description: List of API products associated with the developer app. - type: array - items: - type: string attributes: - description: List of attributes for the developer app. + description: Custom attributes associated with the operation. items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' type: array - status: + operations: description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - type: string + Required. List of GraphQL name/operation type pairs for the proxy or + remote service to which quota will be applied. If only operation + types are specified, the quota will be applied to all GraphQL + requests irrespective of the GraphQL name. **Note**: Currently, you + can specify only a single GraphQLOperation. Specifying more than one + will cause the operation to fail. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' + type: array + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + description: >- + Quota parameters to be enforced for the resources, methods, and API + source combination. If none are specified, quota enforcement will + not be done. type: object - GoogleCloudApigeeV1MetricAggregation: - id: GoogleCloudApigeeV1MetricAggregation - description: The optionally aggregated metric to query with its ordering. + id: GoogleCloudApigeeV1GraphQLOperationConfig + description: >- + Binds the resources in a proxy or remote service with the GraphQL + operation and its associated quota enforcement. + GoogleTypeMoney: + type: object + description: Represents an amount of money with its currency type. properties: - name: - description: Name of the metric - type: string - aggregation: - type: string - description: Aggregation function associated with the metric. - enum: - - AGGREGATION_FUNCTION_UNSPECIFIED - - AVG - - SUM - - MIN - - MAX - - COUNT_DISTINCT - enumDescriptions: - - Unspecified Aggregation function. - - Average. - - Summation. - - Min. - - Max. - - Count distinct - order: - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. + currencyCode: + description: The three-letter currency code defined in ISO 4217. type: string - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING + units: description: >- - Ordering for this aggregation in the result. For time series this is - ignored since the ordering of points depends only on the timestamp, - not the values. - type: object - GoogleCloudApigeeV1Certificate: - properties: - certInfo: - description: Chain of certificates under this name. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' - type: object - id: GoogleCloudApigeeV1Certificate - GoogleCloudApigeeV1ListSecurityActionsResponse: - properties: - securityActions: - type: array - description: The SecurityActions for the specified environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' - 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. + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - id: GoogleCloudApigeeV1ListSecurityActionsResponse - description: >- - Contains a list of SecurityActions in response to a - ListSecurityActionRequest. - type: object - GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: - id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest - description: Request for UpdateAppGroupAppKey + format: int64 + nanos: + type: integer + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + format: int32 + id: GoogleTypeMoney + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: + description: Message for include_all option. + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + properties: {} type: object + GoogleIamV1AuditLogConfig: + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. properties: - apiProducts: - type: array + exemptedMembers: items: type: string description: >- - The list of API products that will be associated with the - credential. This list will be appended to the existing list of - associated API Products for this App Key. Duplicates will be - ignored. - appGroupAppKey: - description: >- - The new AppGroupKey to be amended. Note that the status can be - updated only via action. - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' - action: - description: >- - Approve or revoke the consumer key by setting this value to - `approve` or `revoke` respectively. The `Content-Type` header, if - set, must be set to `application/octet-stream`, with empty body. + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + logType: + description: The log type that this config enables. type: string - GoogleCloudApigeeV1DebugSession: - id: GoogleCloudApigeeV1DebugSession + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + type: object + id: GoogleIamV1AuditLogConfig + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: properties: - filter: + environment: description: >- - Optional. A conditional statement which is evaluated against the - request message to determine if it should be traced. Syntax matches - that of on API Proxy bundle flow Condition. + Destination environment. This will be empty if the route is not yet + reported. type: string - createTime: - readOnly: true - format: google-datetime - description: >- - Output only. The first transaction creation timestamp, recorded by - UAP. + envgroup: type: string - timeout: + description: Environment group where this route is installed. + basepath: type: string - description: >- - Optional. The time in seconds after which this DebugSession should - end. This value will override the value in query param, if both are - provided. - format: int64 - count: + description: Base path in the routing table. + percentage: type: integer format: int32 + description: Percentage of ingress replicas reporting this route. + type: object + description: Route deployed in the ingress routing table. + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + GoogleCloudApigeeV1GraphQLOperationGroup: + id: GoogleCloudApigeeV1GraphQLOperationGroup + description: >- + List of graphQL operation configuration details associated with Apigee + API proxies or remote services. Remote services are non-Apigee proxies, + such as Istio-Envoy. + properties: + operationConfigs: description: >- - Optional. The number of request to be traced. Min = 1, Max = 15, - Default = 10. - validity: - type: integer - description: >- - Optional. The length of time, in seconds, that this debug session is - valid, starting from when it's received in the control plane. Min = - 1, Max = 15, Default = 10. - format: int32 - tracesize: + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' + type: array + operationConfigType: description: >- - Optional. The maximum number of bytes captured from the response - payload. Min = 0, Max = 5120, Default = 5120. - format: int32 - type: integer - name: - description: A unique ID for this DebugSession. + Flag that specifies whether the configuration is for Apigee API + proxy or a remote service. Valid values include `proxy` or + `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API + proxies are associated with the API product. Set to `remoteservice` + when non-Apigee proxies like Istio-Envoy are associated with the API + product. type: string type: object - GoogleCloudApigeeV1ListEnvironmentResourcesResponse: + GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: + description: Tuple representing a base path and the deployment containing it. + properties: + apiProxy: + description: Name of the deployed API proxy revision containing the base path. + type: string + environment: + type: string + description: Name of the environment in which the proxy is deployed. + revision: + type: string + description: Name of the deployed API proxy revision containing the base path. + basepath: + type: string + description: Base path receiving traffic. + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment type: object - id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse + GoogleCloudApigeeV1ListAppGroupAppsResponse: + description: Response for ListAppGroupApps + id: GoogleCloudApigeeV1ListAppGroupAppsResponse properties: - resourceFile: - type: array + appGroupApps: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' - description: List of resources files. - description: Response for ListEnvironmentResources - GoogleCloudApigeeV1GenerateUploadUrlResponse: - id: GoogleCloudApigeeV1GenerateUploadUrlResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + description: List of AppGroup apps and their credentials. + type: array + nextPageToken: + type: string + description: >- + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: object + GoogleCloudApigeeV1FlowHookConfig: properties: - uploadUri: + continueOnError: + type: boolean description: >- - The Google Cloud Storage signed URL that can be used to upload a new - Archive zip file. + Flag that specifies whether the flow should abort after an error in + the flow hook. Defaults to `true` (continue on error). + sharedFlowName: + description: >- + Name of the shared flow to invoke in the following format: + `organizations/{org}/sharedflows/{sharedflow}` type: string + name: + description: >- + Name of the flow hook in the following format: + `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid + `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, + `PreTargetFlowHook`, and `PostTargetFlowHook` + type: string + id: GoogleCloudApigeeV1FlowHookConfig type: object - description: Response for GenerateUploadUrl method. - GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: - description: Response for ListSecurityProfileRevisions. + GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: + properties: + adjustment: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + * A positive value of `adjustment` means that that the API provider + wants to adjust the balance for an under-charged developer i.e. the + balance of the developer will decrease. * A negative value of + `adjustment` means that that the API provider wants to adjust the + balance for an over-charged developer i.e. the balance of the + developer will increase. + description: Request for AdjustDeveloperBalance. + id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest + type: object + GoogleCloudApigeeV1DeleteCustomReportResponse: + id: GoogleCloudApigeeV1DeleteCustomReportResponse type: object properties: - nextPageToken: + message: + description: The response contains only a message field. type: string - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - securityProfiles: - type: array - description: >- - List of security profile revisions. The revisions may be attached or - unattached to any environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' - id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse - GoogleCloudApigeeV1ListNatAddressesResponse: + GoogleCloudApigeeV1SecurityReportResultMetadata: properties: - nextPageToken: + expires: description: >- - Page token that you can include in a ListNatAddresses request to - retrieve the next page of content. If omitted, no subsequent pages - exist. + Output only. Expire_time is set to 7 days after report creation. + Query result will be unaccessable after this time. Example: + "2021-05-04T13:38:52-07:00" + readOnly: true type: string - natAddresses: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' - description: List of NAT Addresses for the instance. - type: array + self: + description: >- + Self link of the query results. Example: + `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + or following format if query is running at host level: + `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + type: string + id: GoogleCloudApigeeV1SecurityReportResultMetadata + description: Contains informations about the security report results. type: object - id: GoogleCloudApigeeV1ListNatAddressesResponse - description: Response for ListNatAddresses. - GoogleTypeExpr: - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - id: GoogleTypeExpr + GoogleCloudApigeeV1ActivateNatAddressRequest: type: object + properties: {} + description: Request for ActivateNatAddressRequest. Activate the nat address request. + id: GoogleCloudApigeeV1ActivateNatAddressRequest + GoogleCloudApigeeV1Export: + type: object + id: GoogleCloudApigeeV1Export + description: Details of an export job. properties: + created: + readOnly: true + description: Output only. Time the export job was created. + type: string description: - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. + description: Description of the export job. type: string - title: + state: description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. + Output only. Status of the export job. Valid values include + `enqueued`, `running`, `completed`, and `failed`. type: string - expression: + readOnly: true + executionTime: + description: >- + Output only. Execution time for this export job. If the job is still + in progress, it will be set to the amount of time that has elapsed + since`created`, in seconds. Else, it will set to (`updated` - + `created`), in seconds. + readOnly: true type: string + self: description: >- - Textual representation of an expression in Common Expression - Language syntax. - location: + Output only. Self link of the export job. A URI that can be used to + retrieve the status of an export job. Example: + `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + type: string + readOnly: true + name: + type: string + description: Display name of the export job. + datastoreName: description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. + Name of the datastore that is the destination of the export job + [datastore] type: string - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision - type: object - properties: - percentage: - description: Percentage of MP replicas reporting this revision. - format: int32 - type: integer - revision: - description: API proxy revision reported as deployed. + error: + description: Output only. Error is set when export fails type: string - description: Revisions deployed in the MPs. - GoogleCloudApigeeV1ListTraceConfigOverridesResponse: + readOnly: true + updated: + type: string + readOnly: true + description: Output only. Time the export job was last updated. + GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: properties: - nextPageToken: + conflictingDeployment: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: Existing base path/deployment causing the conflict. + description: + description: Human-readable description of this conflict. type: string - description: >- - Token value that can be passed as `page_token` to retrieve the next - page of content. - traceConfigOverrides: - type: array - description: List all trace configuration overrides in an environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + environmentGroup: + description: Name of the environment group in which this conflict exists. + type: string + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + description: >- + Describes a routing conflict that may cause a deployment not to receive + traffic at some base path. type: object - description: Response for ListTraceConfigOverrides. - id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse - GoogleCloudApigeeV1ProfileConfigCORS: - properties: {} - id: GoogleCloudApigeeV1ProfileConfigCORS - description: Checks to see if you have CORS policy in place. + GoogleCloudApigeeV1RateRange: + id: GoogleCloudApigeeV1RateRange type: object - GoogleCloudApigeeV1KeystoreConfig: + description: >- + API call volume range and the fees charged when the total number of API + calls is within the range. properties: - aliases: - description: Aliases in the keystore. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' - type: array - name: + start: + type: string description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` + Starting value of the range. Set to 0 or `null` for the initial + range of values. + format: int64 + fee: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + Fee to charge when total number of API calls falls within this + range. + end: type: string - type: object - id: GoogleCloudApigeeV1KeystoreConfig - GoogleCloudApigeeV1TlsInfo: - description: TLS configuration information for virtual hosts and TargetServers. - type: object - properties: - commonName: - description: The TLS Common Name of the certificate. - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' - ciphers: - type: array + format: int64 description: >- - The SSL/TLS cipher suites to be used. For programmable proxies, it - must be one of the cipher suite names listed in: - http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. - For configurable proxies, it must follow the configuration specified - in: - https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. - This setting has no effect for configurable proxies when negotiating - TLS 1.3. + Ending value of the range. Set to 0 or `null` for the last range of + values. + GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: + description: Request for UpdateAppGroupAppKey + id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + properties: + apiProducts: items: type: string - clientAuthEnabled: - description: Optional. Enables two-way TLS. - type: boolean - ignoreValidationErrors: - type: boolean description: >- - If true, Edge ignores TLS certificate errors. Valid when configuring - TLS for target servers and target endpoints, and when configuring - virtual hosts that use 2-way TLS. When used with a target - endpoint/target server, if the backend system uses SNI and returns a - cert with a subject Distinguished Name (DN) that does not match the - hostname, there is no way to ignore the error and the connection - fails. - enforce: - description: TLS is strictly enforced. - type: boolean - trustStore: - type: string - description: The resource ID of the truststore. - enabled: + The list of API products that will be associated with the + credential. This list will be appended to the existing list of + associated API Products for this App Key. Duplicates will be + ignored. + type: array + appGroupAppKey: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' description: >- - Required. Enables TLS. If false, neither one-way nor two-way TLS - will be enabled. - type: boolean - keyAlias: - type: string + The new AppGroupKey to be amended. Note that the status can be + updated only via action. + action: description: >- - Required if `client_auth_enabled` is true. The resource ID for the - alias containing the private key and cert. - keyStore: + Approve or revoke the consumer key by setting this value to + `approve` or `revoke` respectively. The `Content-Type` header, if + set, must be set to `application/octet-stream`, with empty body. type: string - description: >- - Required if `client_auth_enabled` is true. The resource ID of the - keystore. - protocols: - description: The TLS versioins to be used. - type: array - items: - type: string - id: GoogleCloudApigeeV1TlsInfo - GoogleCloudApigeeV1ProfileConfigAuthorization: - properties: {} type: object - description: >- - By default, following policies will be included: - JWS - JWT - OAuth - - BasicAuth - APIKey - id: GoogleCloudApigeeV1ProfileConfigAuthorization - GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: - id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + GoogleCloudApigeeV1AppGroup: properties: - securityProfileRevisionId: + createdAt: + type: string format: int64 - description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' - deprecated: true + readOnly: true + description: Output only. Created time as milliseconds since epoch. + organization: + description: Immutable. the org the app group is created type: string - name: - description: Immutable. Name of the environment that the profile is attached to. + channelId: type: string - attachTime: - description: >- - Output only. The time when environment was attached to the security - profile. - format: google-datetime + description: channel identifier identifies the owner maintaing this grouping. + lastModifiedAt: type: string + format: int64 + description: Output only. Modified time as milliseconds since epoch. readOnly: true - description: Represents a SecurityProfileEnvironmentAssociation resource. - type: object - GoogleCloudApigeeV1DeploymentChangeReport: - id: GoogleCloudApigeeV1DeploymentChangeReport - description: >- - Response for GenerateDeployChangeReport and - GenerateUndeployChangeReport. This report contains any validation - failures that would cause the deployment to be rejected, as well changes - and conflicts in routing that may occur due to the new deployment. The - existence of a routing warning does not necessarily imply that the - deployment request is bad, if the desired state of the deployment - request is to effect a routing change. The primary purposes of the - routing messages are: 1) To inform users of routing changes that may - have an effect on traffic currently being routed to other existing - deployments. 2) To warn users if some base path in the proxy will not - receive traffic due to an existing deployment having already claimed - that base path. The presence of routing conflicts/changes will not cause - non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected. - type: object - properties: - validationErrors: - $ref: '#/components/schemas/GoogleRpcPreconditionFailure' + name: + type: string description: >- - Validation errors that would cause the deployment change request to - be rejected. - routingChanges: - description: All routing changes that may result from a deployment request. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange - routingConflicts: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - type: array - description: All base path conflicts detected for a deployment request. - GoogleCloudApigeeV1ActivateNatAddressRequest: - id: GoogleCloudApigeeV1ActivateNatAddressRequest - properties: {} - description: Request for ActivateNatAddressRequest. Activate the nat address request. - type: object - GoogleCloudApigeeV1RevisionStatus: - properties: - revisionId: + Immutable. Name of the AppGroup. Characters you can use in the name + are restricted to: A-Z0-9._\-$ %. + displayName: type: string - description: The revision of the resource. - replicas: - type: integer - description: The number of replicas that have successfully loaded this revision. - format: int32 - errors: - type: array - description: Errors reported when attempting to load this revision. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' - jsonSpec: + description: app group name displayed in the UI + status: type: string description: >- - The json content of the resource revision. Large specs should be - sent individually via the spec field to avoid hitting request size - limits. - type: object - id: GoogleCloudApigeeV1RevisionStatus - description: The status of a specific resource revision. - GoogleCloudApigeeV1Property: - id: GoogleCloudApigeeV1Property - properties: - value: - type: string - description: The property value - name: + Valid values are `active` or `inactive`. Note that the status of the + AppGroup should be updated via UpdateAppGroupRequest by setting the + action as `active` or `inactive`. + channelUri: + description: A reference to the associated storefront/marketplace. type: string - description: The property key - description: A single property entry in the Properties message. - type: object - GoogleCloudApigeeV1StatsHostStats: - description: >- - Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { - "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": - "example.com" } ]``` - properties: - name: + appGroupId: type: string - description: Hostname used in query. - dimensions: - type: array - description: List of metrics grouped under dimensions. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - metrics: + description: Output only. Internal identifier that cannot be edited + readOnly: true + attributes: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: A list of attributes type: array - description: >- - In the final response, only one of the following fields will be - present based on the dimensions provided. If no dimensions are - provided, then only the top-level metrics are provided. If - dimensions are included, then there will be a top-level dimensions - field under hostnames which will contain metrics values and the - dimension name. Example: ``` "hosts": [ { "dimensions": [ { - "metrics": [ { "name": "sum(message_count)", "values": [ - "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" - } ]``` OR ```"hosts": [ { "metrics": [ { "name": - "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": - "example.com" } ]``` List of metric values. - id: GoogleCloudApigeeV1StatsHostStats + id: GoogleCloudApigeeV1AppGroup type: object - GoogleCloudApigeeV1ApiCategory: - properties: - siteId: - type: string - description: Name of the portal. - id: - description: ID of the category (a UUID). - type: string - name: - type: string - description: Name of the category. - updateTime: - format: int64 - type: string - description: Time the category was last modified in milliseconds since epoch. - id: GoogleCloudApigeeV1ApiCategory description: >- - `ApiCategory` represents an API category. [Catalog - items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) - can be tagged with API categories; users viewing the API catalog in the - portal will have the option to browse the catalog by category. + AppGroup contains the request/response fields representing the logical + grouping of apps. Note that appgroup_id, create_time and update_time + cannot be changed by the user, and gets updated by the system. The name + and the organization once provided cannot be edited subsequently. + GoogleCloudApigeeV1APIProductAssociation: + description: >- + APIProductAssociation has the API product and its administrative state + association. type: object - GoogleCloudApigeeV1OrganizationProjectMapping: - id: GoogleCloudApigeeV1OrganizationProjectMapping + id: GoogleCloudApigeeV1APIProductAssociation properties: - organization: - type: string - description: Name of the Apigee organization. - projectId: - description: Google Cloud project associated with the Apigee organization + status: type: string - location: description: >- - Output only. The Google Cloud region where control plane data is - located. For more information, see - https://cloud.google.com/about/locations/. + The API product credential associated status. Valid values are + `approved` or `revoked`. + apiproduct: type: string - readOnly: true - projectIds: - items: - type: string - deprecated: true - type: array - description: >- - DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a - single project. + description: API product to be associated with the credential. + GoogleCloudApigeeV1ListArchiveDeploymentsResponse: + id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse + description: Response for ListArchiveDeployments method. type: object - GoogleIamV1TestIamPermissionsResponse: properties: - permissions: + nextPageToken: + type: string description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array + Page token that you can include in a ListArchiveDeployments request + to retrieve the next page. If omitted, no subsequent pages exist. + archiveDeployments: items: - type: string - id: GoogleIamV1TestIamPermissionsResponse - type: object - description: Response message for `TestIamPermissions` method. - GoogleCloudApigeeV1ListAsyncQueriesResponse: - id: GoogleCloudApigeeV1ListAsyncQueriesResponse - description: The response for ListAsyncQueries. - properties: - queries: + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' - description: The asynchronous queries belong to requested resource name. - type: object + description: Archive Deployments in the specified environment. GoogleCloudApigeeV1OASDocumentation: - id: GoogleCloudApigeeV1OASDocumentation - type: object + description: OpenAPI Specification documentation for a catalog item. properties: format: - readOnly: true - enumDescriptions: - - The format is not available. - - YAML format. - - JSON format. enum: - FORMAT_UNSPECIFIED - YAML - JSON + enumDescriptions: + - The format is not available. + - YAML format. + - JSON format. type: string description: Output only. The format of the input specification file contents. + readOnly: true spec: description: >- Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported. $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - description: OpenAPI Specification documentation for a catalog item. - GoogleTypeMoney: - id: GoogleTypeMoney - description: Represents an amount of money with its currency type. + id: GoogleCloudApigeeV1OASDocumentation + type: object + GoogleCloudApigeeV1ListAppGroupsResponse: type: object + id: GoogleCloudApigeeV1ListAppGroupsResponse + description: >- + ListAppGroupsResponse contains the 0 or more AppGroups, along with the + optional page token and the total count of apps. properties: - nanos: - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. + totalSize: type: integer + description: Total count of AppGroups. format: int32 - currencyCode: - description: The three-letter currency code defined in ISO 4217. - type: string - units: + nextPageToken: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - format: int64 - GoogleCloudApigeeV1ProfileConfigThreat: - description: >- - By default, following policies will be included: - XMLThreatProtection - - JSONThreatProtection - type: object - id: GoogleCloudApigeeV1ProfileConfigThreat - properties: {} - GoogleCloudApigeeV1Export: + appGroups: + description: List of AppGroups. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + type: array + GoogleCloudApigeeV1SecurityActionDeny: + properties: + responseCode: + format: int32 + type: integer + description: Optional. The HTTP response code if the Action = DENY. type: object - description: Details of an export job. + description: Message that should be set in case of a Deny Action. + id: GoogleCloudApigeeV1SecurityActionDeny + GoogleCloudApigeeV1RuntimeConfig: properties: name: - description: Display name of the export job. - type: string - updated: - readOnly: true - type: string - description: Output only. Time the export job was last updated. - self: description: >- - Output only. Self link of the export job. A URI that can be used to - retrieve the status of an export job. Example: - `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - readOnly: true + Name of the resource in the following format: + `organizations/{org}/runtimeConfig`. type: string - executionTime: - readOnly: true + tenantProjectId: description: >- - Output only. Execution time for this export job. If the job is still - in progress, it will be set to the amount of time that has elapsed - since`created`, in seconds. Else, it will set to (`updated` - - `created`), in seconds. - type: string - description: - type: string - description: Description of the export job. - created: - description: Output only. Time the export job was created. - readOnly: true + Output only. Tenant project ID associated with the Apigee + organization. The tenant project is used to host Google-managed + resources that are dedicated to this Apigee organization. Clients + have limited access to resources within the tenant project used to + support Apigee runtime instances. Access to the tenant project is + managed using SetSyncAuthorization. It can be empty if the tenant + project hasn't been created yet. type: string - error: - description: Output only. Error is set when export fails readOnly: true + analyticsBucket: type: string - datastoreName: + description: Cloud Storage bucket used for uploading Analytics records. + traceBucket: type: string + description: Cloud Storage bucket used for uploading Trace records. + type: object + id: GoogleCloudApigeeV1RuntimeConfig + description: >- + Runtime configuration for the organization. Response for + GetRuntimeConfig. + GoogleCloudApigeeV1InstanceDeploymentStatus: + properties: + deployedRoutes: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + type: array description: >- - Name of the datastore that is the destination of the export job - [datastore] - state: - description: >- - Output only. Status of the export job. Valid values include - `enqueued`, `running`, `completed`, and `failed`. - readOnly: true + Current routes deployed in the ingress routing table. A route which + is missing will appear in `missing_routes`. + deployedRevisions: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + description: Revisions currently deployed in MPs. + type: array + instance: + description: ID of the instance reporting the status. type: string - id: GoogleCloudApigeeV1Export - GoogleCloudApigeeV1ListDebugSessionsResponse: type: object - id: GoogleCloudApigeeV1ListDebugSessionsResponse + id: GoogleCloudApigeeV1InstanceDeploymentStatus + description: The status of a deployment as reported by a single instance. + GoogleCloudApigeeV1RuntimeTraceConfig: + type: object + id: GoogleCloudApigeeV1RuntimeTraceConfig properties: - nextPageToken: + name: + type: string description: >- - Page token that you can include in a ListDebugSessionsRequest to - retrieve the next page. If omitted, no subsequent pages exist. + Name of the trace config in the following format: + `organizations/{org}/environment/{env}/traceConfig` + revisionCreateTime: type: string - sessions: + format: google-datetime + description: The timestamp that the revision was created or updated. + samplingConfig: + description: Trace configuration for all API proxies in an environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + exporter: description: >- - Session info that includes debug session ID and the first - transaction creation timestamp. + Exporter that is used to view the distributed trace captured using + OpenCensus. An exporter sends traces to any backend that is capable + of consuming them. Recorded spans can be exported by registered + exporters. + enum: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE + type: string + enumDescriptions: + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter + endpoint: + type: string + description: Endpoint of the exporter. + overrides: + description: List of trace configuration overrides for spicific API proxies. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Session' + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' type: array - GoogleCloudApigeeV1ListApiProxiesResponse: - id: GoogleCloudApigeeV1ListApiProxiesResponse + revisionId: + description: >- + Revision number which can be used by the runtime to detect if the + trace config has changed between two versions. + type: string + description: >- + NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed + trace in an environment. + GoogleCloudApigeeV1GenerateDownloadUrlRequest: + type: object + description: Request for GenerateDownloadUrl method. + properties: {} + id: GoogleCloudApigeeV1GenerateDownloadUrlRequest + GoogleCloudApigeeV1SyncAuthorization: + id: GoogleCloudApigeeV1SyncAuthorization properties: - proxies: + etag: + type: string + format: byte + description: >- + Entity tag (ETag) used for optimistic concurrency control as a way + to help prevent simultaneous updates from overwriting each other. + For example, when you call + [getSyncAuthorization](organizations/getSyncAuthorization) an ETag + is returned in the response. Pass that ETag when calling the + [setSyncAuthorization](organizations/setSyncAuthorization) to ensure + that you are updating the correct version. If you don't pass the + ETag in the call to `setSyncAuthorization`, then the existing + authorization is overwritten indiscriminately. **Note**: We strongly + recommend that you use the ETag in the read-modify-write cycle to + avoid race conditions. + identities: type: array + description: >- + Required. Array of service accounts to grant access to control plane + resources, each specified using the following format: + `serviceAccount:` service-account-name. The service-account-name is + formatted like an email address. For example: + `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` + You might specify multiple service accounts, for example, if you + have multiple environments and wish to assign a unique service + account to each one. The service accounts must have **Apigee + Synchronizer Manager** role. See also [Create service + accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + type: string type: object - GoogleCloudApigeeV1ReportInstanceStatusResponse: - description: Placeholder for future enhancements to status reporting protocol + GoogleCloudApigeeV1CommonNameConfig: type: object - id: GoogleCloudApigeeV1ReportInstanceStatusResponse - properties: {} - GoogleCloudApigeeV1SecurityActionsConfig: properties: - updateTime: - format: google-datetime - type: string - readOnly: true - description: Output only. The update time for configuration. name: type: string - description: >- - This is a singleton resource, the name will always be set by - SecurityActions and any user input will be ignored. The name is - always: - `organizations/{org}/environments/{env}/security_actions_config` - enabled: + matchWildCards: type: boolean + id: GoogleCloudApigeeV1CommonNameConfig + GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: + id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + description: Represents a SecurityProfileEnvironmentAssociation resource. + properties: + name: + type: string + description: Immutable. Name of the environment that the profile is attached to. + attachTime: + type: string description: >- - The flag that controls whether this feature is enabled. This is - `unset` by default. When this flag is `false`, even if individual - rules are enabled, no SecurityActions will be enforced. - description: >- - SecurityActionsConfig reflects the current state of the SecurityActions - feature. This is a singleton resource: https://google.aip.dev/156 + Output only. The time when environment was attached to the security + profile. + readOnly: true + format: google-datetime + securityProfileRevisionId: + description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' + deprecated: true + format: int64 + type: string type: object - id: GoogleCloudApigeeV1SecurityActionsConfig - GoogleIamV1Policy: + GoogleIamV1TestIamPermissionsRequest: type: object - id: GoogleIamV1Policy properties: - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - format: byte - type: string - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - bindings: + permissions: type: array items: - $ref: '#/components/schemas/GoogleIamV1Binding' + type: string description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - version: - description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - format: int32 - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - GoogleCloudApigeeV1SecurityReportResultMetadata: - id: GoogleCloudApigeeV1SecurityReportResultMetadata + 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). + description: Request message for `TestIamPermissions` method. + id: GoogleIamV1TestIamPermissionsRequest + GoogleCloudApigeeV1ReportInstanceStatusResponse: + id: GoogleCloudApigeeV1ReportInstanceStatusResponse + properties: {} + description: Placeholder for future enhancements to status reporting protocol type: object - description: Contains informations about the security report results. + GoogleCloudApigeeV1DebugSession: properties: - expires: - readOnly: true - type: string - description: >- - Output only. Expire_time is set to 7 days after report creation. - Query result will be unaccessable after this time. Example: - "2021-05-04T13:38:52-07:00" - self: - description: >- - Self link of the query results. Example: - `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - or following format if query is running at host level: - `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + filter: type: string - GoogleCloudApigeeV1AppGroupAppKey: - description: >- - AppGroupAppKey contains all the information associated with the - credentials. - properties: - attributes: - type: array - description: List of attributes associated with the credential. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - expiresInSeconds: - format: int64 description: >- - Immutable. Expiration time, in seconds, for the consumer key. If not - set or left to the default value of `-1`, the API key never expires. - The expiration time can't be updated after it is set. - type: string - issuedAt: - format: int64 + Optional. A conditional statement which is evaluated against the + request message to determine if it should be traced. Syntax matches + that of on API Proxy bundle flow Condition. + tracesize: description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. + Optional. The maximum number of bytes captured from the response + payload. Min = 0, Max = 5120, Default = 5120. + type: integer + format: int32 + name: type: string + description: A unique ID for this DebugSession. + createTime: readOnly: true - consumerKey: + description: >- + Output only. The first transaction creation timestamp, recorded by + UAP. type: string - description: Immutable. Consumer key. - expiresAt: + format: google-datetime + timeout: type: string - readOnly: true format: int64 description: >- - Output only. Time the AppGroup app expires in milliseconds since - epoch. - apiProducts: - readOnly: true - type: array + Optional. The time in seconds after which this DebugSession should + end. This value will override the value in query param, if both are + provided. + count: + format: int32 description: >- - Output only. List of API products and its status for which the - credential can be used. **Note**: Use - UpdateAppGroupAppKeyApiProductRequest API to make the association - after the consumer key and secret are created. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' - consumerSecret: - description: Secret key. + Optional. The number of request to be traced. Min = 1, Max = 15, + Default = 10. + type: integer + validity: + format: int32 + type: integer + description: >- + Optional. The length of time, in seconds, that this debug session is + valid, starting from when it's received in the control plane. Min = + 1, Max = 15, Default = 10. + id: GoogleCloudApigeeV1DebugSession + type: object + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: + properties: + text: type: string - status: + description: 'The text of the url. (ie: "Learn more")' + uri: type: string - description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - scopes: - description: >- - Scopes to apply to the app. The specified scope names must already - be defined for the API product that you associate with the app. - type: array - items: - type: string - id: GoogleCloudApigeeV1AppGroupAppKey + description: The link itself. type: object - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: - description: Response for BatchUpdateSecurityIncident. - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + description: The format for a link in the recommendation. + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink + GoogleCloudApigeeV1SecurityActionAllow: + description: >- + Message that should be set in case of an Allow Action. This does not + have any fields. + properties: {} type: object + id: GoogleCloudApigeeV1SecurityActionAllow + GoogleCloudApigeeV1AccessSet: + type: object + id: GoogleCloudApigeeV1AccessSet properties: - securityIncidents: - description: Output only. Updated security incidents - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - readOnly: true - type: array - GoogleCloudApigeeV1Subscription: - id: GoogleCloudApigeeV1Subscription - properties: + success: + type: boolean + value: + type: string name: - description: >- - Full name of the Pub/Sub subcription. Use the following structure in - your request: `subscription "projects/foo/subscription/bar"` type: string + description: >- + Set action. For example, "Set" : { "name" : "target.name", "success" : + true, "value" : "default" } + GoogleCloudApigeeV1RuntimeAddonsConfig: + id: GoogleCloudApigeeV1RuntimeAddonsConfig type: object - description: Pub/Sub subscription of an environment. - GoogleCloudApigeeV1ResourceStatus: properties: - totalReplicas: - type: integer - description: The total number of replicas that should have this resource. - format: int32 - revisions: - description: Revisions of the resource currently deployed in the instance. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' - type: array - uid: + revisionId: + description: Revision number used by the runtime to detect config changes. type: string + name: description: >- - The uid of the resource. In the unexpected case that the instance - has multiple uids for the same name, they should be reported under - separate ResourceStatuses. - resource: + Name of the addons config in the format: + `organizations/{org}/environments/{env}/addonsConfig` + type: string + uid: type: string description: >- - The resource name. Currently only two resources are supported: - EnvironmentGroup - organizations/{org}/envgroups/{envgroup} - EnvironmentConfig - - organizations/{org}/environments/{environment}/deployedConfig - type: object - id: GoogleCloudApigeeV1ResourceStatus - description: The status of a resource loaded in the runtime. - GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: + UID is to detect if config is recreated after deletion. The add-on + config will only be deleted when the environment itself gets + deleted, thus it will always be the same as the UID of + EnvironmentConfig. + apiSecurityConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' + description: Runtime configuration for API Security add-on. + analyticsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' + description: Runtime configuration for Analytics add-on. description: >- - Describes a routing conflict that may cause a deployment not to receive - traffic at some base path. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + RuntimeAddonsConfig defines the runtime configurations for add-ons in an + environment. + GoogleCloudApigeeV1CustomReport: + id: GoogleCloudApigeeV1CustomReport + type: object properties: - description: - description: Human-readable description of this conflict. + environment: + description: Output only. Environment name type: string - environmentGroup: + readOnly: true + properties: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' + description: This field contains report properties such as ui metadata etc. + type: array + lastModifiedAt: + format: int64 type: string - description: Name of the environment group in which this conflict exists. - conflictingDeployment: - description: Existing base path/deployment causing the conflict. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - type: object - GoogleCloudApigeeV1DeleteResponse: - properties: - status: + readOnly: true + description: >- + Output only. Modified time of this entity as milliseconds since + epoch. json key: lastModifiedAt + sortOrder: + description: >- + Legacy field: not used much. Contains the sort order for the sort + columns type: string - description: Status of the operation. - gcpResource: + chartType: + description: This field contains the chart type for the report type: string - description: Google Cloud name of deleted resource. - errorCode: + name: type: string - description: Unique error code for the request, if any. - requestId: - description: Unique ID of the request. + description: >- + Required. Unique identifier for the report T his is a legacy field + used to encode custom report unique id + timeUnit: + description: This field contains the time unit of aggregation for the report type: string - message: - description: Description of the operation. + filter: + description: This field contains the filter expression type: string - id: GoogleCloudApigeeV1DeleteResponse - description: Response for certain delete operations. - type: object - GoogleCloudApigeeV1ListSharedFlowsResponse: - type: object - id: GoogleCloudApigeeV1ListSharedFlowsResponse - properties: - sharedFlows: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + fromTime: + description: 'Legacy field: not used. Contains the from time for the report' + type: string + tags: type: array - GoogleCloudApigeeV1ListExportsResponse: - description: The response for ListExports - properties: - exports: + description: >- + Legacy field: not used. This field contains a list of tags + associated with custom report items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' - description: Details of the export jobs. + type: string + comments: type: array - type: object - id: GoogleCloudApigeeV1ListExportsResponse - GoogleCloudApigeeV1Reference: - description: >- - A Reference configuration. References must refer to a keystore that also - exists in the parent environment. - id: GoogleCloudApigeeV1Reference - properties: - name: description: >- - Required. The resource id of this reference. Values must match the - regular expression [\w\s\-.]+. - type: string - resourceType: + Legacy field: not used. This field contains a list of comments + associated with custom report + items: + type: string + offset: type: string + description: 'Legacy field: not used. This field contains the offset for the data' + limit: description: >- - The type of resource referred to by this reference. Valid values are - 'KeyStore' or 'TrustStore'. - description: - description: Optional. A human-readable description of this reference. - type: string - refers: + Legacy field: not used This field contains the limit for the result + retrieved type: string + topk: description: >- - Required. The id of the resource to which this reference refers. - Must be the id of a resource that exists in the parent environment - and is of the given resource_type. - type: object - GoogleCloudApigeeV1DataCollectorConfig: - type: object - properties: - name: + Legacy field: not used. This field contains the top k parameter + value for restricting the result type: string + lastViewedAt: + readOnly: true description: >- - Name of the data collector in the following format: - `organizations/{org}/datacollectors/{datacollector}` - type: + Output only. Last viewed time of this entity as milliseconds since + epoch + format: int64 type: string - description: Data type accepted by the data collector. - enumDescriptions: - - For future compatibility. - - For integer values. - - For float values. - - For string values. - - For boolean values. - - For datetime values. - enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME - id: GoogleCloudApigeeV1DataCollectorConfig - description: Data collector and its configuration. - GoogleCloudApigeeV1QueryMetadata: - id: GoogleCloudApigeeV1QueryMetadata - type: object - properties: - outputFormat: + toTime: type: string - description: Output format. - dimensions: - description: Dimensions of the AsyncQuery. + description: 'Legacy field: not used. Contains the end time for the report' + sortByCols: items: type: string type: array - startTimestamp: - description: Start timestamp of the query range. + description: 'Legacy field: not used much. Contains the list of sort by columns' + organization: type: string - timeUnit: + description: Output only. Organization name + readOnly: true + metrics: + type: array + description: Required. This contains the list of metrics + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' + displayName: type: string - description: Query GroupBy time unit. - endTimestamp: - description: End timestamp of the query range. + description: This is the display name for the report + createdAt: + format: int64 type: string - metrics: + readOnly: true + description: 'Output only. Unix time when the app was created json key: createdAt' + dimensions: items: type: string + description: This contains the list of dimensions for the report type: array - description: >- - Metrics of the AsyncQuery. Example: - ["name:message_count,func:sum,alias:sum_message_count"] - GoogleCloudApigeeV1GrpcOperationGroup: + GoogleCloudApigeeV1ListApiCategoriesResponse: + description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' type: object properties: - operationConfigs: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' + errorCode: + description: Unique error code for the request, if any. + type: string + requestId: + description: Unique ID of the request. + type: string + status: + type: string + description: Status of the operation. + data: + description: The API category resources. type: array - description: >- - Required. List of operation configurations for either Apigee API - proxies that are associated with this API product. - description: >- - List of gRPC operation configuration details associated with Apigee API - proxies. - id: GoogleCloudApigeeV1GrpcOperationGroup - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + message: + type: string + description: Description of the operation. + id: GoogleCloudApigeeV1ListApiCategoriesResponse + GoogleCloudApigeeV1OrganizationProjectMapping: + id: GoogleCloudApigeeV1OrganizationProjectMapping properties: - urls: + location: + type: string + description: >- + Output only. The Google Cloud region where control plane data is + located. For more information, see + https://cloud.google.com/about/locations/. + readOnly: true + organization: + type: string + description: Name of the Apigee organization. + projectId: + type: string + description: Google Cloud project associated with the Apigee organization + projectIds: + description: >- + DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a + single project. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + type: string type: array - description: The list of Signed URLs generated by the CreateAsyncQuery request + deprecated: true type: object - description: The response for GetAsyncQueryResultUrl - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse - GoogleCloudApigeeV1ResourceFile: + GoogleCloudApigeeV1SchemaSchemaElement: type: object + id: GoogleCloudApigeeV1SchemaSchemaElement + description: Message type for the schema element properties: + properties: + description: >- + Properties for the schema field. For example: { "createTime": + "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' name: - description: ID of the resource file. type: string - type: - type: string - description: Resource file type. {{ resource_file_type }} - id: GoogleCloudApigeeV1ResourceFile - description: Metadata about a resource file. - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + description: Name of the field. + GoogleCloudApigeeV1ProfileConfigCategory: + description: >- + Advanced API Security provides security profile that scores the + following categories. + id: GoogleCloudApigeeV1ProfileConfigCategory + type: object + properties: + authorization: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' + description: Checks to see if you have an authorization policy in place. + cors: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' + description: Checks to see if you have CORS policy in place. + mediation: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' + description: Checks to see if you have a mediation policy in place. + mtls: + description: Checks to see if you have configured mTLS for the target server. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' + threat: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' + description: Checks to see if you have a threat protection policy in place. + abuse: + description: >- + Checks for abuse, which includes any requests sent to the API for + purposes other than what it is intended for, such as high volumes of + requests, data scraping, and abuse related to authorization. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' + GoogleCloudApigeeV1DisableSecurityActionRequest: + properties: {} + type: object + id: GoogleCloudApigeeV1DisableSecurityActionRequest + description: Message to disable an enabled SecurityAction. + GoogleCloudApigeeV1ApiCategoryResponse: + id: GoogleCloudApigeeV1ApiCategoryResponse + type: object + description: The API category resource wrapped with response status, error_code, etc. + properties: + data: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + description: The API category resource. + message: + type: string + description: Description of the operation. + errorCode: + description: Unique error code for the request, if any. + type: string + status: + description: Status of the operation. + type: string + requestId: + type: string + description: Unique ID of the request. + GoogleCloudApigeeV1NodeConfig: + description: >- + NodeConfig for setting the min/max number of nodes associated with the + environment. + id: GoogleCloudApigeeV1NodeConfig + type: object + properties: + maxNodeCount: + description: >- + Optional. The maximum total number of gateway nodes that the is + reserved for all instances that has the specified environment. If + not specified, the default is determined by the recommended maximum + number of nodes for that gateway. + type: string + format: int64 + minNodeCount: + format: int64 + description: >- + Optional. The minimum total number of gateway nodes that the is + reserved for all instances that has the specified environment. If + not specified, the default is determined by the recommended minimum + number of nodes for that gateway. + type: string + currentAggregateNodeCount: + type: string + readOnly: true + description: >- + Output only. The current total number of gateway nodes that each + environment currently has across all instances. + format: int64 + GoogleCloudApigeeV1DeveloperBalanceWallet: + description: Wallet used to manage an account balance for a particular currency. + id: GoogleCloudApigeeV1DeveloperBalanceWallet + properties: + lastCreditTime: + format: int64 + readOnly: true + type: string + description: >- + Output only. Time at which the developer last added credit to the + account in milliseconds since epoch. + balance: + description: >- + Current remaining balance of the developer for a particular + currency. + $ref: '#/components/schemas/GoogleTypeMoney' + type: object + GoogleCloudApigeeV1Quota: + description: >- + Quota contains the essential parameters needed that can be applied on + the resources, methods, API source combination associated with this API + product. While Quota is optional, setting it prevents requests from + exceeding the provisioned parameters. + type: object + properties: + timeUnit: + type: string + description: >- + Time unit defined for the `interval`. Valid values include `minute`, + `hour`, `day`, or `month`. If `limit` and `interval` are valid, the + default value is `hour`; otherwise, the default is null. + limit: + description: >- + Required. Upper limit allowed for the time interval and time unit + specified. Requests exceeding this limit will be rejected. + type: string + interval: + type: string + description: >- + Required. Time interval over which the number of request messages is + calculated. + id: GoogleCloudApigeeV1Quota + GoogleCloudApigeeV1AsyncQueryResultView: type: object + properties: + rows: + type: array + description: >- + Rows of query result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} + items: + type: any + code: + description: Error code when there is a failure. + type: integer + format: int32 + metadata: + description: >- + Metadata contains information like metrics, dimenstions etc of the + AsyncQuery. + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' + error: + description: Error message when there is a failure. + type: string + state: + type: string + description: State of retrieving ResultView. + id: GoogleCloudApigeeV1AsyncQueryResultView + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: properties: assessmentTime: format: google-datetime @@ -2725,647 +2302,559 @@ components: If this field is blank, there are no subsequent pages. type: string securityAssessmentResults: - description: Default sort order is by resource name in alphabetic order. - type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' + type: array + description: Default sort order is by resource name in alphabetic order. + type: object description: Response for BatchComputeSecurityAssessmentResults. - GoogleCloudApigeeV1DeleteCustomReportResponse: + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + GoogleCloudApigeeV1ListApiDocsResponse: type: object properties: message: - description: The response contains only a message field. type: string - id: GoogleCloudApigeeV1DeleteCustomReportResponse - GoogleCloudApigeeV1DimensionMetric: - id: GoogleCloudApigeeV1DimensionMetric - description: Encapsulates a metric grouped by dimension. - type: object - properties: - individualNames: - type: array - items: - type: string - description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. - name: + description: Description of the operation. + errorCode: + description: Unique error code for the request, if any. type: string - deprecated: true + requestId: + type: string + description: Unique ID of the request. + nextPageToken: description: >- - Comma joined dimension names. E.g. "dim1_name,dim2_name". - Deprecated. If name already has comma before join, we may get wrong - splits. Please use individual_names. - metrics: - description: List of metrics. + 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 + data: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + description: The catalog item resources. type: array - GoogleCloudApigeeV1SecurityProfile: - id: GoogleCloudApigeeV1SecurityProfile - description: Represents a SecurityProfile resource. - type: object + status: + description: Status of the operation. + type: string + id: GoogleCloudApigeeV1ListApiDocsResponse + GoogleCloudApigeeV1KeystoreConfig: + id: GoogleCloudApigeeV1KeystoreConfig properties: + aliases: + description: Aliases in the keystore. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' + type: array name: description: >- - Immutable. Name of the security profile resource. Format: - organizations/{org}/securityProfiles/{profile} + Resource name in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` type: string - maxScore: - type: integer + type: object + GoogleCloudApigeeV1ListSecurityProfilesResponse: + description: Response for ListSecurityProfiles. + type: object + id: GoogleCloudApigeeV1ListSecurityProfilesResponse + properties: + securityProfiles: + type: array description: >- - Output only. Maximum security score that can be generated by this - profile. - format: int32 - readOnly: true - revisionCreateTime: - description: Output only. The time when revision was created. + List of security profiles in the organization. The profiles may be + attached or unattached to any environment. This will return latest + revision of each profile. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - format: google-datetime - readOnly: true - displayName: + GoogleCloudApigeeV1TraceConfigOverride: + description: A representation of a configuration override. + type: object + properties: + apiProxy: type: string - description: 'DEPRECATED: DO NOT USE Display name of the security profile.' - deprecated: true - profileConfig: description: >- - Required. Customized profile configuration that computes the - security score. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' - environments: - type: array - description: List of environments attached to security profile. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' - revisionPublishTime: - deprecated: true - format: google-datetime + ID of the API proxy that will have its trace configuration + overridden. + samplingConfig: + description: Trace configuration to override. + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + name: description: >- - Output only. DEPRECATED: DO NOT USE The time when revision was - published. Once published, the security profile revision cannot be - updated further and can be attached to environments. + ID of the trace configuration override specified as a + system-generated UUID. type: string - readOnly: true - minScore: - format: int32 - type: integer - readOnly: true + id: GoogleCloudApigeeV1TraceConfigOverride + GoogleCloudApigeeV1KeyValueMap: + type: object + properties: + encrypted: + type: boolean description: >- - Output only. Minimum security score that can be generated by this - profile. - description: + Required. Flag that specifies whether entry values will be + encrypted. This field is retained for backward compatibility and the + value of encrypted will always be `true`. Apigee X and hybrid do not + support unencrypted key value maps. + name: type: string - description: Description of the security profile. - scoringConfigs: + description: Required. ID of the key value map. + id: GoogleCloudApigeeV1KeyValueMap + description: Collection of key/value string pairs. + GoogleCloudApigeeV1SetAddonEnablementRequest: + properties: + apiSecurityEnabled: + type: boolean + description: If the API Security should be enabled in the environment. + analyticsEnabled: + type: boolean + description: If the Analytics should be enabled in the environment. + id: GoogleCloudApigeeV1SetAddonEnablementRequest + type: object + description: Request for SetAddonEnablement. + GoogleCloudApigeeV1ListNatAddressesResponse: + properties: + natAddresses: items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' type: array - description: List of profile scoring configs in this revision. - revisionId: - format: int64 - readOnly: true - description: Output only. Revision ID of the security profile. - type: string - revisionUpdateTime: - description: Output only. The time when revision was updated. - type: string - format: google-datetime - readOnly: true - GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: - description: The result of the assessment. - properties: - dataUpdateTime: - type: string + description: List of NAT Addresses for the instance. + nextPageToken: description: >- - The time when resource data was last fetched for this resource. This - time may be different than when the resource was actually updated - due to lag in data collection. - format: google-datetime - severity: - enum: - - SEVERITY_UNSPECIFIED - - LOW - - MEDIUM - - HIGH - - MINIMAL + Page token that you can include in a ListNatAddresses request to + retrieve the next page of content. If omitted, no subsequent pages + exist. type: string - description: The severity of the assessment. - enumDescriptions: - - Severity is not defined. - - Severity is low. - - Severity is medium. - - Severity is high. - - Severity is minimal - failedAssessmentPerWeight: - additionalProperties: - format: int32 - type: integer - type: object - description: >- - The number of failed assessments grouped by its weight. Keys are one - of the following: "MAJOR", "MODERATE", "MINOR". - score: - description: The security score of the assessment. - format: int32 + description: Response for ListNatAddresses. + id: GoogleCloudApigeeV1ListNatAddressesResponse + type: object + GoogleCloudApigeeV1OperationMetadataProgress: + properties: + percentDone: type: integer - assessmentRecommendations: + description: The percentage of the operation progress. + format: int32 + details: additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation - description: >- - The recommendations of the assessment. The key is the "name" of the - assessment (not display_name), and the value are the - recommendations. + description: Properties of the object. + type: any type: object - id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + description: The additional details of the progress. + description: + type: string + description: Description of the operation's progress. + state: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED + description: State of the operation. + type: string + id: GoogleCloudApigeeV1OperationMetadataProgress type: object - GoogleCloudApigeeV1Developer: + description: Information about operation progress. + GoogleCloudApigeeV1SecurityActionHttpHeader: type: object - id: GoogleCloudApigeeV1Developer + description: An HTTP header. properties: - userName: - description: Required. User name of the developer. Not used by Apigee hybrid. + value: type: string - lastModifiedAt: - description: >- - Output only. Time at which the developer was last modified in - milliseconds since epoch. + description: The header value to be sent to the target. + name: + description: The header name to be sent to the target. type: string - readOnly: true - format: int64 - apps: - items: - type: string - description: List of apps associated with the developer. - type: array - companies: - description: List of companies associated with the developer. - items: - type: string - type: array - developerId: - description: >- - ID of the developer. **Note**: IDs are generated internally by - Apigee and are not guaranteed to stay the same over time. + id: GoogleCloudApigeeV1SecurityActionHttpHeader + GoogleCloudApigeeV1IntegrationConfig: + type: object + description: Configuration for the Integration add-on. + id: GoogleCloudApigeeV1IntegrationConfig + properties: + enabled: + type: boolean + description: Flag that specifies whether the Integration add-on is enabled. + GoogleCloudApigeeV1DateRange: + id: GoogleCloudApigeeV1DateRange + description: Date range of the data to export. + properties: + end: type: string - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: >- - Optional. Developer attributes (name/value pairs). The custom - attribute limit is 18. - type: array - lastName: + Required. End date (exclusive) of the data to export in the format + `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- + which will not be in the output. + start: + description: >- + Required. Start date of the data to export in the format + `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start + date. type: string - description: Required. Last name of the developer. - firstName: + type: object + GoogleCloudApigeeV1PodStatus: + id: GoogleCloudApigeeV1PodStatus + properties: + statusCode: type: string - description: Required. First name of the developer. - accessType: - description: Access type. + description: Code associated with the deployment status. + appVersion: + description: Version of the application running in the pod. type: string - status: - readOnly: true - description: >- - Output only. Status of the developer. Valid values are `active` and - `inactive`. + deploymentStatusTime: + format: int64 type: string - appFamily: + description: Time the deployment status was reported in milliseconds since epoch. + podStatusTime: + format: int64 + description: Time the pod status was reported in milliseconds since epoch. type: string - description: Developer app family. - organizationName: - description: >- - Output only. Name of the Apigee organization in which the developer - resides. + podName: type: string - readOnly: true - email: + description: Name of the pod which is reporting the status. + statusCodeDetails: + description: Human-readable message associated with the status code. type: string - description: >- - Required. Email address of the developer. This value is used to - uniquely identify the developer in Apigee hybrid. Note that the - email address has to be in lowercase only. - createdAt: - format: int64 - readOnly: true + deploymentStatus: type: string description: >- - Output only. Time at which the developer was created in milliseconds - since epoch. - GoogleCloudApigeeV1ScoreComponentRecommendation: - type: object - description: Recommendation based on security concerns and score. - id: GoogleCloudApigeeV1ScoreComponentRecommendation - properties: - description: - description: Description of the recommendation. - type: string - title: - description: Title represents recommendation title. - type: string - actions: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction - type: array - description: Actions for the recommendation to improve the security score. - impact: - format: int32 - type: integer - description: >- - Potential impact of this recommendation on the overall score. This - denotes how important this recommendation is to improve the score. - GoogleCloudApigeeV1DeveloperAppKey: - type: object - id: GoogleCloudApigeeV1DeveloperAppKey - properties: - consumerKey: - type: string - description: Consumer key. - expiresInSeconds: - description: >- - Input only. Expiration time, in seconds, for the consumer key. If - not set or left to the default value of `-1`, the API key never - expires. The expiration time can't be updated after it is set. - type: string - format: int64 - consumerSecret: - type: string - description: Secret key. - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes associated with the credential. - type: array - apiProducts: - items: - type: any - description: >- - List of API products for which the credential can be used. **Note**: - Do not specify the list of API products when creating a consumer key - and secret for a developer app. Instead, use the - UpdateDeveloperAppKey API to make the association after the consumer - key and secret are created. - type: array - status: + Status of the deployment. Valid values include: - `deployed`: + Successful. - `error` : Failed. - `pending` : Pod has not yet + reported on the deployment. + podStatus: description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - type: string - issuedAt: - description: Time the developer app was created in milliseconds since epoch. + Overall status of the pod (not this specific deployment). Valid + values include: - `active`: Up to date. - `stale` : Recently out of + date. Pods that have not reported status in a long time are excluded + from the output. type: string - format: int64 - scopes: - items: - type: string - type: array - description: >- - Scopes to apply to the app. The specified scope names must already - be defined for the API product that you associate with the app. - expiresAt: + deploymentTime: type: string - description: Time the developer app expires in milliseconds since epoch. + description: Time the proxy was deployed in milliseconds since epoch. format: int64 - GoogleCloudApigeeV1QueryMetric: - type: object - properties: - name: - type: string - description: Required. Metric name. - function: - description: 'Aggregation function: avg, min, max, or sum.' - type: string - alias: - type: string - description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. - value: - description: Operand value should be provided when operator is set. - type: string - operator: - type: string - description: One of `+`, `-`, `/`, `%`, `*`. - description: >- - More info about Metric: - https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics - id: GoogleCloudApigeeV1QueryMetric - GoogleCloudApigeeV1ListArchiveDeploymentsResponse: - properties: - archiveDeployments: - description: Archive Deployments in the specified environment. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' - nextPageToken: - description: >- - Page token that you can include in a ListArchiveDeployments request - to retrieve the next page. If omitted, no subsequent pages exist. - type: string - id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse type: object - description: Response for ListArchiveDeployments method. - GoogleCloudApigeeV1ProfileConfigCategory: + GoogleCloudApigeeV1SetAddonsRequest: + id: GoogleCloudApigeeV1SetAddonsRequest + description: Request for SetAddons. properties: - mtls: - description: Checks to see if you have configured mTLS for the target server. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' - threat: - description: Checks to see if you have a threat protection policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' - cors: - description: Checks to see if you have CORS policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' - mediation: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' - description: Checks to see if you have a mediation policy in place. - authorization: - description: Checks to see if you have an authorization policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' - abuse: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' - description: >- - Checks for abuse, which includes any requests sent to the API for - purposes other than what it is intended for, such as high volumes of - requests, data scraping, and abuse related to authorization. - id: GoogleCloudApigeeV1ProfileConfigCategory + addonsConfig: + description: Required. Add-on configurations. + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' type: object + GoogleIamV1AuditConfig: description: >- - Advanced API Security provides security profile that scores the - following categories. - GoogleCloudApigeeV1GraphQLOperation: - id: GoogleCloudApigeeV1GraphQLOperation + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. type: object - description: >- - Represents the pairing of GraphQL operation types and the GraphQL - operation name. + id: GoogleIamV1AuditConfig properties: - operation: + service: type: string description: >- - GraphQL operation name. The name and operation type will be used to - apply quotas. If no name is specified, the quota will be applied to - all GraphQL operations irrespective of their operation names in the - payload. - operationTypes: - description: >- - Required. GraphQL operation types. Valid values include `query` or - `mutation`. **Note**: Apigee does not currently support - `subscription` types. - items: - type: string - type: array - GoogleCloudApigeeV1StatsEnvironmentStats: - type: object - id: GoogleCloudApigeeV1StatsEnvironmentStats - properties: - metrics: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - description: >- - In the final response, only one of the following fields will be - present based on the dimensions provided. If no dimensions are - provided, then only top-level metrics is provided. If dimensions are - included, then there will be a top-level dimensions field under - environments which will contain metrics values and the dimension - name. Example: ``` "environments": [ { "dimensions": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], - "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": - [ { "metrics": [ { "name": "sum(message_count)", "values": [ - "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values. - dimensions: + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + auditLogConfigs: + description: The configuration for logging of each type of permission. type: array - description: List of metrics grouped under dimensions. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - name: - type: string - description: Name of the environment. + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + GoogleCloudApigeeV1ListSecurityActionsResponse: description: >- - Encapsulates the environment wrapper: ``` "environments": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], - "name": "prod" } ]``` - GoogleCloudApigeeV1ListDeveloperAppsResponse: - type: object - id: GoogleCloudApigeeV1ListDeveloperAppsResponse + Contains a list of SecurityActions in response to a + ListSecurityActionRequest. + id: GoogleCloudApigeeV1ListSecurityActionsResponse properties: - app: + nextPageToken: + type: string + 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. + securityActions: + description: The SecurityActions for the specified environment. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' - description: List of developer apps and their credentials. - GoogleCloudApigeeV1KeyValueMap: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + type: object + GoogleIamV1Policy: + id: GoogleIamV1Policy type: object properties: - name: - description: Required. ID of the key value map. - type: string - encrypted: - description: >- - Required. Flag that specifies whether entry values will be - encrypted. This field is retained for backward compatibility and the - value of encrypted will always be `true`. Apigee X and hybrid do not - support unencrypted key value maps. - type: boolean - id: GoogleCloudApigeeV1KeyValueMap - description: Collection of key/value string pairs. - GoogleCloudApigeeV1SyncAuthorization: - properties: - identities: + bindings: type: array items: - type: string + $ref: '#/components/schemas/GoogleIamV1Binding' description: >- - Required. Array of service accounts to grant access to control plane - resources, each specified using the following format: - `serviceAccount:` service-account-name. The service-account-name is - formatted like an email address. For example: - `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` - You might specify multiple service accounts, for example, if you - have multiple environments and wish to assign a unique service - account to each one. The service accounts must have **Apigee - Synchronizer Manager** role. See also [Create service - accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + auditConfigs: + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + description: Specifies cloud audit logging configuration for this policy. + type: array + version: + format: int32 + type: integer + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). etag: description: >- - Entity tag (ETag) used for optimistic concurrency control as a way - to help prevent simultaneous updates from overwriting each other. - For example, when you call - [getSyncAuthorization](organizations/getSyncAuthorization) an ETag - is returned in the response. Pass that ETag when calling the - [setSyncAuthorization](organizations/setSyncAuthorization) to ensure - that you are updating the correct version. If you don't pass the - ETag in the call to `setSyncAuthorization`, then the existing - authorization is overwritten indiscriminately. **Note**: We strongly - recommend that you use the ETag in the read-modify-write cycle to - avoid race conditions. + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. type: string format: byte + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + GoogleCloudApigeeV1DeploymentChangeReport: + id: GoogleCloudApigeeV1DeploymentChangeReport type: object - id: GoogleCloudApigeeV1SyncAuthorization - GoogleCloudApigeeV1ListCustomReportsResponse: - type: object - id: GoogleCloudApigeeV1ListCustomReportsResponse - description: This message encapsulates a list of custom report definitions + description: >- + Response for GenerateDeployChangeReport and + GenerateUndeployChangeReport. This report contains any validation + failures that would cause the deployment to be rejected, as well changes + and conflicts in routing that may occur due to the new deployment. The + existence of a routing warning does not necessarily imply that the + deployment request is bad, if the desired state of the deployment + request is to effect a routing change. The primary purposes of the + routing messages are: 1) To inform users of routing changes that may + have an effect on traffic currently being routed to other existing + deployments. 2) To warn users if some base path in the proxy will not + receive traffic due to an existing deployment having already claimed + that base path. The presence of routing conflicts/changes will not cause + non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected. properties: - qualifier: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + routingConflicts: + description: All base path conflicts detected for a deployment request. type: array - GoogleCloudApigeeV1Alias: - type: object - id: GoogleCloudApigeeV1Alias - properties: - type: - enumDescriptions: - - Alias type is not specified. - - Certificate. - - Key/certificate pair. - description: Type of alias. - type: string - enum: - - ALIAS_TYPE_UNSPECIFIED - - CERT - - KEY_CERT - alias: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + validationErrors: + $ref: '#/components/schemas/GoogleRpcPreconditionFailure' description: >- - Resource ID for this alias. Values must match the regular expression - `[^/]{1,255}`. - type: string - certsInfo: - description: Chain of certificates under this alias. - $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' - description: Reference to a certificate or key/certificate pair. - GoogleCloudApigeeV1ProfileConfigMTLS: - description: Checks to see if you have configured mTLS for the target server. - id: GoogleCloudApigeeV1ProfileConfigMTLS - properties: {} - type: object - GoogleCloudApigeeV1ListOrganizationsResponse: - type: object - properties: - organizations: + Validation errors that would cause the deployment change request to + be rejected. + routingChanges: + description: All routing changes that may result from a deployment request. type: array - description: List of Apigee organizations and associated Google Cloud projects. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' - id: GoogleCloudApigeeV1ListOrganizationsResponse - GoogleCloudApigeeV1CustomReport: - id: GoogleCloudApigeeV1CustomReport + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: + id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext type: object + description: Action context are all the relevant details for the action. properties: - fromTime: + documentationLink: + description: Documentation link for the action. type: string - description: 'Legacy field: not used. Contains the from time for the report' - sortByCols: - type: array - description: 'Legacy field: not used much. Contains the list of sort by columns' - items: - type: string - offset: - description: 'Legacy field: not used. This field contains the offset for the data' + GoogleCloudApigeeV1SecurityAction: + properties: + ttl: type: string - environment: - description: Output only. Environment name - readOnly: true + format: google-duration + description: Input only. The TTL for this SecurityAction. + conditionConfig: + description: >- + Required. A valid SecurityAction must contain at least one + condition. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig + updateTime: + format: google-datetime + description: >- + Output only. The update time for this SecurityAction. This reflects + when this SecurityAction changed states. type: string - sortOrder: + readOnly: true + createTime: type: string + readOnly: true + description: Output only. The create time for this SecurityAction. + format: google-datetime + deny: + description: Deny a request through if it matches this SecurityAction. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' + allow: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' + description: Allow a request through if it matches this SecurityAction. + state: description: >- - Legacy field: not used much. Contains the sort order for the sort - columns - topk: + Required. Only an ENABLED SecurityAction is enforced. An ENABLED + SecurityAction past its expiration time will not be enforced. + enum: + - STATE_UNSPECIFIED + - ENABLED + - DISABLED type: string + enumDescriptions: + - >- + The default value. This only exists for forward compatibility. A + create request with this value will be rejected. + - >- + An ENABLED SecurityAction is actively enforced if the + `expiration_time` is in the future. + - A disabled SecurityAction is never enforced. + expireTime: + description: The expiration for this SecurityAction. + type: string + format: google-datetime + description: description: >- - Legacy field: not used. This field contains the top k parameter - value for restricting the result - name: - description: >- - Required. Unique identifier for the report T his is a legacy field - used to encode custom report unique id + Optional. An optional user provided description of the + SecurityAction. type: string - timeUnit: + name: type: string - description: This field contains the time unit of aggregation for the report - chartType: - type: string - description: This field contains the chart type for the report - lastModifiedAt: description: >- - Output only. Modified time of this entity as milliseconds since - epoch. json key: lastModifiedAt - format: int64 - type: string - readOnly: true - metrics: - description: Required. This contains the list of metrics - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' - filter: - type: string - description: This field contains the filter expression - createdAt: - readOnly: true - type: string - description: 'Output only. Unix time when the app was created json key: createdAt' - format: int64 - properties: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' - type: array - description: This field contains report properties such as ui metadata etc. - toTime: - description: 'Legacy field: not used. Contains the end time for the report' - type: string - displayName: - type: string - description: This is the display name for the report - organization: - type: string - description: Output only. Organization name - readOnly: true - comments: + Immutable. This field is ignored during creation as per AIP-133. + Please set the `security_action_id` field in the + CreateSecurityActionRequest when creating a new SecurityAction. + Format: + organizations/{org}/environments/{env}/securityActions/{security_action} + flag: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' + description: Flag a request through if it matches this SecurityAction. + apiProxies: type: array - items: - type: string description: >- - Legacy field: not used. This field contains a list of comments - associated with custom report - tags: - type: array + Optional. If unset, this would apply to all proxies in the + environment. If set, this action is enforced only if at least one + proxy in the repeated list is deployed at the time of enforcement. + If set, several restrictions are enforced on SecurityActions. There + can be at most 100 enabled actions with proxies set in an env. + Several other restrictions apply on conditions and are detailed + later. items: type: string - description: >- - Legacy field: not used. This field contains a list of tags - associated with custom report - lastViewedAt: - format: int64 - readOnly: true + description: >- + A SecurityAction is rule that can be enforced at an environment level. + The result is one of: - A denied API call - An explicitly allowed API + call - A flagged API call (HTTP headers added before the target receives + it) At least one condition is required to create a SecurityAction. + type: object + id: GoogleCloudApigeeV1SecurityAction + GoogleCloudApigeeV1EndpointAttachment: + properties: + location: + description: Required. Location of the endpoint attachment. type: string - description: >- - Output only. Last viewed time of this entity as milliseconds since - epoch - dimensions: - description: This contains the list of dimensions for the report - type: array - items: - type: string - limit: + host: type: string + readOnly: true description: >- - Legacy field: not used This field contains the limit for the result - retrieved - GoogleCloudApigeeV1EndpointAttachment: - properties: + Output only. Host that can be used in either the HTTP target + endpoint directly or as the host in target server. + serviceAttachment: + type: string + description: 'Format: projects/*/regions/*/serviceAttachments/*' name: description: >- Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}` type: string + state: + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + description: >- + Output only. State of the endpoint attachment. Values other than + `ACTIVE` mean the resource is not ready to use. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + readOnly: true + type: string connectionState: + type: string description: >- Output only. State of the endpoint attachment connection to the service attachment. @@ -3378,6 +2867,7 @@ components: - CLOSED - FROZEN - NEEDS_ATTENTION + readOnly: true enumDescriptions: - The connection state has not been set. - >- @@ -3395,416 +2885,527 @@ components: - >- The connection has been accepted by the PSC producer, but it is not ready to serve the traffic due to producer side issues. - type: string - readOnly: true - serviceAttachment: - type: string - description: 'Format: projects/*/regions/*/serviceAttachments/*' - location: - type: string - description: Required. Location of the endpoint attachment. - state: - type: string - description: >- - Output only. State of the endpoint attachment. Values other than - `ACTIVE` mean the resource is not ready to use. - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - readOnly: true - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - host: - type: string - description: >- - Output only. Host that can be used in either the HTTP target - endpoint directly or as the host in target server. - readOnly: true - type: object - id: GoogleCloudApigeeV1EndpointAttachment description: >- Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). - GoogleCloudApigeeV1TargetServerConfig: - id: GoogleCloudApigeeV1TargetServerConfig type: object + id: GoogleCloudApigeeV1EndpointAttachment + GoogleCloudApigeeV1RevenueShareRange: properties: - tlsInfo: - description: TLS settings for the target server. - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' - port: - type: integer - description: Port number for the target server. - format: int32 - enabled: - type: boolean + sharePercentage: + format: double description: >- - Whether the target server is enabled. An empty/omitted value for - this field should be interpreted as true. - protocol: - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - enumDescriptions: - - UNSPECIFIED defaults to HTTP for backwards compatibility. - - The TargetServer uses HTTP. - - The TargetSever uses HTTP2. - - The TargetServer uses GRPC. - - >- - GRPC TargetServer to be used in ExternalCallout Policy. Prefer to - use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once - EXTERNAL _CALLOUT generally available. - - The TargetServer is to be used in the ExternalCallout Policy - type: string - description: The protocol used by this target server. - name: + Percentage of the revenue to be shared with the developer. For + example, to share 21 percent of the total revenue with the + developer, set this value to 21. Specify a decimal number with a + maximum of two digits following the decimal point. + type: number + end: + format: int64 type: string description: >- - Target server revision name in the following format: - `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` - host: - description: Host name of the target server. + Ending value of the range. Set to 0 or `null` for the last range of + values. + start: + format: int64 type: string - GoogleProtobufEmpty: - properties: {} - type: object + description: >- + Starting value of the range. Set to 0 or `null` for the initial + range of values. + id: GoogleCloudApigeeV1RevenueShareRange 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: GoogleProtobufEmpty - GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: - description: Tuple representing a base path and the deployment containing it. + API call volume range and the percentage of revenue to share with the + developer when the total number of API calls is within the range. type: object + GoogleCloudApigeeV1CanaryEvaluation: properties: - revision: - type: string - description: Name of the deployed API proxy revision containing the base path. - basepath: + state: + readOnly: true + description: Output only. The current state of the canary evaluation. + enum: + - STATE_UNSPECIFIED + - RUNNING + - SUCCEEDED type: string - description: Base path receiving traffic. - environment: + enumDescriptions: + - No state has been specified. + - The canary evaluation is still in progress. + - The canary evaluation has finished. + control: + description: Required. The stable version that is serving requests. type: string - description: Name of the environment in which the proxy is deployed. - apiProxy: + createTime: + readOnly: true + format: google-datetime type: string - description: Name of the deployed API proxy revision containing the base path. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - GoogleCloudApigeeV1AccessGet: - id: GoogleCloudApigeeV1AccessGet - description: >- - Get action. For example, "Get" : { "name" : "target.name", "value" : - "default" } - type: object - properties: - name: + description: Output only. Create time of the canary evaluation. + treatment: type: string - value: + description: Required. The newer version that is serving requests. + endTime: type: string - GoogleCloudApigeeV1Result: + format: google-datetime + description: Required. End time for the evaluation's analysis. + name: + description: Output only. Name of the canary evalution. + readOnly: true + type: string + metricLabels: + description: >- + Required. Labels used to filter the metrics used for a canary + evaluation. + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' + startTime: + format: google-datetime + type: string + description: Required. Start time for the canary evaluation's analysis. + verdict: + enum: + - VERDICT_UNSPECIFIED + - NONE + - FAIL + - PASS + enumDescriptions: + - Verdict is not available yet. + - No verdict reached. + - Evaluation is not good. + - Evaluation is good. + type: string + description: >- + Output only. The resulting verdict of the canary evaluations: NONE, + PASS, or FAIL. + readOnly: true + type: object + id: GoogleCloudApigeeV1CanaryEvaluation description: >- - Result is short for "action result", could be different types identified - by "action_result" field. Supported types: 1. DebugInfo : generic debug - info collected by runtime recorded as a list of properties. For example, - the contents could be virtual host info, state change result, or - execution metadata. Required fields : properties, timestamp 2. - RequestMessage: information of a http request. Contains headers, request - URI and http methods type.Required fields : headers, uri, verb 3. - ResponseMessage: information of a http response. Contains headers, - reason phrase and http status code. Required fields : headers, - reasonPhrase, statusCode 4. ErrorMessage: information of a http error - message. Contains detail error message, reason phrase and status code. - Required fields : content, headers, reasonPhrase, statusCode 5. - VariableAccess: a list of variable access actions, can be Get, Set and - Remove. Required fields : accessList - id: GoogleCloudApigeeV1Result + CanaryEvaluation represents the canary analysis between two versions of + the runtime that is serving requests. + GoogleCloudApigeeV1ApiProduct: type: object properties: - statusCode: - description: HTTP response code + description: type: string - timestamp: description: >- - Timestamp of when the result is recorded. Its format is dd-mm-yy - hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` - type: string - uRI: - type: string + Description of the API product. Include key information about the + API product that is not captured by other fields. + quotaTimeUnit: description: >- - The relative path of the api proxy. for example, `"uRI" : - "/iloveapis"` - reasonPhrase: - description: HTTP response phrase + Time unit defined for the `quotaInterval`. Valid values include + `minute`, `hour`, `day`, or `month`. type: string - verb: - description: HTTP method verb + graphqlOperationGroup: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' + description: >- + Configuration used to group Apigee proxies or remote services with + graphQL operation name, graphQL operation type and quotas. This + grouping allows us to precisely set quota for a particular + combination of graphQL name and operation type for a particular + proxy request. If graphQL name is not set, this would imply quota + will be applied on all graphQL requests matching the operation type. + quotaCounterScope: + description: >- + Scope of the quota decides how the quota counter gets applied and + evaluate for quota violation. If the Scope is set as PROXY, then all + the operations defined for the APIproduct that are associated with + the same proxy will share the same quota counter set at the + APIproduct level, making it a global counter at a proxy level. If + the Scope is set as OPERATION, then each operations get the counter + set at the API product dedicated, making it a local counter. Note + that, the QuotaCounterScope applies only when an operation does not + have dedicated quota set for itself. + enum: + - QUOTA_COUNTER_SCOPE_UNSPECIFIED + - PROXY + - OPERATION type: string - content: + enumDescriptions: + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), the limits set at product level will be + used as a local counter for quota evaluation by all the + operations, independent of proxy association. + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), set at product level will be used as a + global counter for quota evaluation by all the operations + associated with a particular proxy. + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), the limits set at product level will be + used as a local counter for quota evaluation by all the + operations, independent of proxy association. This behavior mimics + the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED. + quotaInterval: + description: >- + Time interval over which the number of request messages is + calculated. type: string + operationGroup: + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' description: >- - Error message content. for example, "content" : - "{\"fault\":{\"faultstring\":\"API timed - out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" - ActionResult: + Configuration used to group Apigee proxies or remote services with + resources, method types, and quotas. The resource refers to the + resource URI (excluding the base path). With this grouping, the API + product creator is able to fine-tune and give precise control over + which REST methods have access to specific resources and how many + calls can be made (using the `quota` setting). **Note:** The + `api_resources` setting cannot be specified for both the API product + and operation group; otherwise the call will fail. + quota: description: >- - Type of the action result. Can be one of the five: DebugInfo, - RequestMessage, ResponseMessage, ErrorMessage, VariableAccess + Number of request messages permitted per app by this API product for + the specified `quotaInterval` and `quotaTimeUnit`. For example, a + `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of + hours means 50 requests are allowed every 12 hours. type: string - headers: + attributes: description: >- - A list of HTTP headers. for example, '"headers" : [ { "name" : - "Content-Length", "value" : "83" }, { "name" : "Content-Type", - "value" : "application/json" } ]' + Array of attributes that may be used to extend the default API + product profile with customer-specific metadata. You can specify a + maximum of 18 attributes. Use this property to specify the access + level of the API product as either `public`, `private`, or + `internal`. Only products marked `public` are available to + developers in the Apigee developer portal. For example, you can set + a product to `internal` while it is in development and then change + access to `public` when it is ready to release on the portal. API + products marked as `private` do not appear on the portal, but can be + accessed by external developers. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Name value pairs used for DebugInfo ActionResult. - accessList: - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + grpcOperationGroup: description: >- - A list of variable access actions agaist the api proxy. Supported - values: Get, Set, Remove. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Access' - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: - type: object - description: Request for BatchUpdateSecurityIncident. - properties: - requests: + Optional. Configuration used to group Apigee proxies with gRPC + services and method names. This grouping allows us to set quota for + a particular proxy with the gRPC service name and method. If a + method name is not set, this implies quota and authorization are + applied to all gRPC methods implemented by that proxy for that + particular gRPC service. + $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationGroup' + name: + type: string description: >- - Optional. Required. The request message specifying the resources to - update. A maximum of 1000 can be modified in a batch. + Internal name of the API product. Characters you can use in the name + are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name + cannot be edited when updating the API product. + apiResources: + description: >- + Comma-separated list of API resources to be bundled in the API + product. By default, the resource paths are mapped from the + `proxy.pathsuffix` variable. The proxy path suffix is defined as the + URI fragment following the ProxyEndpoint base path. For example, if + the `apiResources` element is defined to be `/forecastrss` and the + base path defined for the API proxy is `/weather`, then only + requests to `/weather/forecastrss` are permitted by the API product. + You can select a specific path, or you can select all subpaths with + the following wildcard: - `/**`: Indicates that all sub-URIs are + included. - `/*` : Indicates that only URIs one level down are + included. By default, / supports the same resources as /** as well + as the base path defined by the API proxy. For example, if the base + path of the API proxy is `/v1/weatherapikey`, then the API product + supports requests to `/v1/weatherapikey` and to any sub-URIs, such + as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, + and so on. For more information, see Managing API products. type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest - GoogleCloudApigeeV1ApiDocDocumentation: - type: object - description: The documentation for a catalog item. - id: GoogleCloudApigeeV1ApiDocDocumentation - properties: - graphqlDocumentation: - description: Optional. GraphQL documentation. - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' - oasDocumentation: - $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' - description: Optional. OpenAPI Specification documentation. - GoogleCloudApigeeV1Operation: - type: object - id: GoogleCloudApigeeV1Operation - description: >- - Represents the pairing of REST resource path and the actions (verbs) - allowed on the resource path. - properties: - methods: items: type: string - type: array - description: >- - methods refers to the REST verbs as in - https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none - specified, all verb types are allowed. - resource: + approvalType: type: string description: >- - Required. REST resource path associated with the API proxy or remote - service. - GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: - properties: - columns: - type: array - description: >- - Column names corresponding to the same order as the inner values in - the stats field. + Flag that specifies how API keys are approved to access the APIs + defined by the API product. If set to `manual`, the consumer key is + generated and returned in "pending" state. In this case, the API + keys won't work until they have been explicitly approved. If set to + `auto`, the consumer key is generated and returned in "approved" + state and can be used immediately. **Note:** Typically, `auto` is + used to provide access to free or trial API products that provide + limited quota or capabilities. + environments: items: type: string - nextPageToken: - type: string - description: Next page token. - values: type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - description: Results of the query returned as a JSON array. - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse - type: object - description: >- - Represents security stats result as a collection of time series - sequences. - GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: - properties: - pageSize: - format: int32 description: >- - Optional. The maximum number of subcomponents to be returned in a - single page. The service may return fewer than this value. If - unspecified, at most 100 subcomponents will be returned in a single - page. - type: integer - filters: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + Comma-separated list of environment names to which the API product + is bound. Requests to environments that are not listed are rejected. + By specifying one or more environments, you can bind the resources + listed in the API product to a specific environment, preventing + developers from accessing those resources through API proxies + deployed in another environment. This setting is used, for example, + to prevent resources associated with API proxies in `prod` from + being accessed by API proxies deployed in `test`. + createdAt: + format: int64 description: >- - Optional. Filters are used to filter scored components. Return all - the components if no filter is mentioned. Example: [{ "scorePath": - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - }, { "scorePath": - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", - }] This will return components with path: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - OR - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target" - type: array - pageToken: + Response only. Creation time of this environment as milliseconds + since epoch. + type: string + displayName: type: string description: >- - Optional. A token that can be sent as `page_token` to retrieve the - next page. If this field is omitted, there are no subsequent pages. - timeRange: + Name displayed in the UI or developer portal to developers + registering for API access. + lastModifiedAt: + format: int64 description: >- - Required. Time range for score calculation. At most 14 days of - scores will be returned, and both the start and end dates must be - within the last 90 days. - $ref: '#/components/schemas/GoogleTypeInterval' - type: object - description: Request for ComputeEnvironmentScores. - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest - GoogleCloudApigeeV1ListSecurityProfilesResponse: - description: Response for ListSecurityProfiles. - id: GoogleCloudApigeeV1ListSecurityProfilesResponse - type: object - properties: - nextPageToken: + Response only. Modified time of this environment as milliseconds + since epoch. type: string + proxies: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - securityProfiles: + Comma-separated list of API proxy names to which this API product is + bound. By specifying API proxies, you can associate resources in the + API product with specific API proxies, preventing developers from + accessing those resources through other API proxies. Apigee rejects + requests to API proxies that are not listed. **Note:** The API proxy + names must already exist in the specified environment as they will + be validated upon creation. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + type: string + scopes: + type: array description: >- - List of security profiles in the organization. The profiles may be - attached or unattached to any environment. This will return latest - revision of each profile. - GoogleCloudApigeeV1AccessRemove: + Comma-separated list of OAuth scopes that are validated at runtime. + Apigee validates that the scopes in any access token presented match + the scopes defined in the OAuth policy associated with the API + product. + items: + type: string + id: GoogleCloudApigeeV1ApiProduct + GoogleCloudApigeeV1ApiSecurityConfig: + description: Configurations of the API Security add-on. + properties: + expiresAt: + type: string + description: >- + Output only. Time at which the API Security add-on expires in in + milliseconds since epoch. If unspecified, the add-on will never + expire. + format: int64 + readOnly: true + enabled: + type: boolean + description: Flag that specifies whether the API security add-on is enabled. type: object + id: GoogleCloudApigeeV1ApiSecurityConfig + GoogleTypeExpr: description: >- - Remove action. For example, "Remove" : { "name" : "target.name", - "success" : true } + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + id: GoogleTypeExpr properties: - name: + title: + type: string + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + expression: + type: string + description: >- + Textual representation of an expression in Common Expression + Language syntax. + description: + type: string + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + location: + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string - success: - type: boolean - id: GoogleCloudApigeeV1AccessRemove - GoogleCloudApigeeV1RuntimeAnalyticsConfig: type: object - description: Runtime configuration for the Analytics add-on. - id: GoogleCloudApigeeV1RuntimeAnalyticsConfig + GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: + type: object properties: - billingPipelineEnabled: - description: If Runtime should send billing data to AX or not. - type: boolean - enabled: - type: boolean - description: If the Analytics is enabled or not. - GoogleCloudApigeeV1ReportProperty: + nextStartKey: + type: string + description: >- + Value that can be sent as `startKey` to retrieve the next page of + content. If this field is omitted, there are no subsequent pages. + developerSubscriptions: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + type: array + description: List of all subscriptions. + description: Response for ListDeveloperSubscriptions. + id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + GoogleCloudApigeeV1OptimizedStatsNode: + description: >- + Encapsulates a data node as represented below: ``` { "identifier": { + "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": + "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` + { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` + Depending on whether a dimension is present in the query or not the data + node type can be a simple metric value or dimension identifier with list + of metrics. type: object - id: GoogleCloudApigeeV1ReportProperty properties: - value: - description: property values + data: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - property: - description: name of the property - type: string - GoogleCloudApigeeV1RuntimeApiSecurityConfig: - properties: - enabled: - type: boolean - description: If the API Security is enabled or not. - type: object - description: Runtime configuration for the API Security add-on. - id: GoogleCloudApigeeV1RuntimeApiSecurityConfig - GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: - description: Response for ListEnvironmentGroupAttachments. - type: object + type: any + id: GoogleCloudApigeeV1OptimizedStatsNode + GoogleCloudApigeeV1QueryTabularStatsResponse: properties: - environmentGroupAttachments: + columns: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' - description: EnvironmentGroupAttachments for the specified environment group. - nextPageToken: + type: string description: >- - Page token that you can include in a ListEnvironmentGroupAttachments - request to retrieve the next page. If omitted, no subsequent pages - exist. + Column names corresponding to the same order as the inner values in + the stats field. + nextPageToken: + description: Next page token. type: string - id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse - GoogleCloudApigeeV1AccessSet: + values: + description: Resultant rows from the executed query. + items: + type: array + items: + type: any + type: array description: >- - Set action. For example, "Set" : { "name" : "target.name", "success" : - true, "value" : "default" } - type: object - properties: - name: - type: string - success: - type: boolean - value: - type: string - id: GoogleCloudApigeeV1AccessSet - GoogleCloudApigeeV1ApiDocDocumentationResponse: + Encapsulates two kinds of stats that are results of the dimensions and + aggregations requested. - Tabular rows. - Time series data. Example of + tabular rows, Represents security stats results as a row of flat values. type: object + id: GoogleCloudApigeeV1QueryTabularStatsResponse + GoogleCloudApigeeV1ListInstancesResponse: + description: Response for ListInstances. + id: GoogleCloudApigeeV1ListInstancesResponse properties: - message: - readOnly: true - description: Output only. Description of the operation. + nextPageToken: type: string - errorCode: - description: Output only. Unique error code for the request, if any. + description: >- + Page token that you can include in a ListInstance request to + retrieve the next page of content. If omitted, no subsequent pages + exist. + instances: + description: Instances in the specified organization. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + type: array + type: object + GoogleCloudApigeeV1AccessLoggingConfig: + type: object + description: >- + Access logging configuration enables customers to ship the access logs + from the tenant projects to their own project's cloud logging. The + feature is at the instance level ad disabled by default. It can be + enabled during CreateInstance or UpdateInstance. + id: GoogleCloudApigeeV1AccessLoggingConfig + properties: + enabled: + description: >- + Optional. Boolean flag that specifies whether the customer access + log feature is enabled. + type: boolean + filter: + description: >- + Optional. Ship the access log entries that match the status_code + defined in the filter. The status_code is the only + expected/supported filter field. (Ex: status_code) The filter will + parse it to the Common Expression Language semantics for expression + evaluation to build the filter condition. (Ex: "filter": status_code + >= 200 && status_code < 300 ) type: string + GoogleCloudApigeeV1DeveloperApp: + type: object + id: GoogleCloudApigeeV1DeveloperApp + properties: + apiProducts: + description: List of API products associated with the developer app. + items: + type: string + type: array + createdAt: + description: >- + Output only. Time the developer app was created in milliseconds + since epoch. + format: int64 readOnly: true - requestId: - description: Output only. Unique ID of the request. + type: string + attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + description: List of attributes for the developer app. + credentials: + description: >- + Output only. Set of credentials for the developer app consisting of + the consumer key/secret pairs associated with the API products. readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + type: array + appId: type: string - data: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + description: ID of the developer app. + appFamily: + type: string + description: Developer app family. + lastModifiedAt: readOnly: true - description: Output only. The documentation resource. + format: int64 + description: >- + Output only. Time the developer app was modified in milliseconds + since epoch. + type: string + callbackUrl: + type: string + description: >- + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to developer apps. + developerId: + type: string + description: ID of the developer. + keyExpiresIn: + type: string + description: >- + Expiration time, in milliseconds, for the consumer key that is + generated for the developer app. If not set or left to the default + value of `-1`, the API key never expires. The expiration time can't + be updated after it is set. + format: int64 + scopes: + items: + type: string + type: array + description: >- + Scopes to apply to the developer app. The specified scopes must + already exist for the API product that you associate with the + developer app. + name: + type: string + description: Name of the developer app. status: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. type: string - readOnly: true - description: Output only. Status of the operation. - description: >- - The catalog item documentation wrapped with response status, error_code, - etc. - id: GoogleCloudApigeeV1ApiDocDocumentationResponse GoogleCloudApigeeV1DataCollector: + type: object properties: + name: + type: string + description: ID of the data collector. Must begin with `dc_`. type: enumDescriptions: - For future compatibility. @@ -3813,6 +3414,7 @@ components: - For string values. - For boolean values. - For datetime values. + type: string enum: - TYPE_UNSPECIFIED - INTEGER @@ -3820,1529 +3422,1480 @@ components: - STRING - BOOLEAN - DATETIME - type: string description: Immutable. The type of data this data collector will collect. - createdAt: + lastModifiedAt: + type: string + readOnly: true description: >- - Output only. The time at which the data collector was created in - milliseconds since the epoch. + Output only. The time at which the Data Collector was last updated + in milliseconds since the epoch. format: int64 - readOnly: true - type: string description: - type: string description: A description of the data collector. - name: type: string - description: ID of the data collector. Must begin with `dc_`. - lastModifiedAt: + createdAt: format: int64 - readOnly: true - type: string description: >- - Output only. The time at which the Data Collector was last updated - in milliseconds since the epoch. + Output only. The time at which the data collector was created in + milliseconds since the epoch. + type: string + readOnly: true description: Data collector configuration. - type: object id: GoogleCloudApigeeV1DataCollector - GoogleCloudApigeeV1SecurityReportMetadata: - description: Metadata for the security report. + GoogleCloudApigeeV1GrpcOperationGroup: type: object properties: - endTimestamp: - description: End timestamp of the query range. - format: google-datetime - type: string - startTimestamp: - type: string - description: Start timestamp of the query range. - format: google-datetime - mimeType: - description: MIME type / Output format. + operationConfigs: + description: >- + Required. List of operation configurations for either Apigee API + proxies that are associated with this API product. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' + type: array + id: GoogleCloudApigeeV1GrpcOperationGroup + description: >- + List of gRPC operation configuration details associated with Apigee API + proxies. + GoogleCloudApigeeV1StatsEnvironmentStats: + properties: + name: + description: Name of the environment. type: string metrics: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' type: array description: >- - Metrics of the SecurityReport. Example: - ["name:bot_count,func:sum,alias:sum_bot_count"] - timeUnit: - type: string - description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' + In the final response, only one of the following fields will be + present based on the dimensions provided. If no dimensions are + provided, then only top-level metrics is provided. If dimensions are + included, then there will be a top-level dimensions field under + environments which will contain metrics values and the dimension + name. Example: ``` "environments": [ { "dimensions": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], + "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": + [ { "metrics": [ { "name": "sum(message_count)", "values": [ + "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values. dimensions: + description: List of metrics grouped under dimensions. type: array items: - type: string - description: Dimensions of the SecurityReport. - id: GoogleCloudApigeeV1SecurityReportMetadata - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: - properties: {} + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' type: object - description: Message for include_all option. - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - GoogleCloudApigeeV1AliasRevisionConfig: + id: GoogleCloudApigeeV1StatsEnvironmentStats + description: >- + Encapsulates the environment wrapper: ``` "environments": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], + "name": "prod" } ]``` + GoogleCloudApigeeV1TlsInfoConfig: type: object - id: GoogleCloudApigeeV1AliasRevisionConfig - properties: - location: - type: string - description: Location of the alias file. For example, a Google Cloud Storage URI. - type: - enumDescriptions: - - Alias type is not specified. - - Certificate. - - Key/certificate pair. - type: string - enum: - - ALIAS_TYPE_UNSPECIFIED - - CERT - - KEY_CERT - name: - description: >- - Name of the alias revision included in the keystore in the following - format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}` - type: string - GoogleCloudApigeeV1Environment: - id: GoogleCloudApigeeV1Environment + id: GoogleCloudApigeeV1TlsInfoConfig properties: - deploymentType: - enum: - - DEPLOYMENT_TYPE_UNSPECIFIED - - PROXY - - ARCHIVE - type: string - enumDescriptions: - - Deployment type not specified. - - >- - Proxy deployment enables you to develop and deploy API proxies - using Apigee on Google Cloud. This cannot currently be combined - with the CONFIGURABLE API proxy type. - - >- - Archive deployment enables you to develop API proxies locally then - deploy an archive of your API proxy configuration to an - environment in Apigee on Google Cloud. You will be prevented from - performing a [subset of - actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) - within the environment. - description: >- - Optional. Deployment type supported by the environment. The - deployment type can be set when creating the environment and cannot - be changed. When you enable archive deployment, you will be - **prevented from performing** a [subset of - actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) - within the environment, including: * Managing the deployment of API - proxy or shared flow revisions * Creating, updating, or deleting - resource files * Creating, updating, or deleting target servers - forwardProxyUri: - description: >- - Optional. URI of the forward proxy to be applied to the runtime - instances in this environment. Must be in the format of - {scheme}://{hostname}:{port}. Note that the scheme must be one of - "http" or "https", and the port must be supplied. To remove a - forward proxy setting, update the field to an empty value. Note: At - this time, PUT operations to add forwardProxyUri to an existing - environment fail if the environment has nodeConfig set up. To - successfully add the forwardProxyUri setting in this case, include - the NodeConfig details with the request. - type: string - description: - type: string - description: Optional. Description of the environment. - state: - type: string - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - readOnly: true + protocols: + items: + type: string + description: List of TLS protocols that are granted access. + type: array + enabled: description: >- - Output only. State of the environment. Values other than ACTIVE - means the resource is not ready to use. - nodeConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' - description: Optional. NodeConfig of the environment. - properties: + Flag that specifies whether one-way TLS is enabled. Set to `true` to + enable one-way TLS. + type: boolean + enforce: + type: boolean + description: Flag that enforces TLS settings + commonName: + description: Common name to validate the target server against. + $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' + ciphers: + type: array + description: List of ciphers that are granted access. + items: + type: string + ignoreValidationErrors: + type: boolean description: >- - Optional. Key-value pairs that may be used for customizing the - environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - name: + Flag that specifies whether to ignore TLS certificate validation + errors. Set to `true` to ignore errors. + keyAlias: type: string description: >- - Required. Name of the environment. Values must match the regular - expression `^[.\\p{Alnum}-_]{1,255}$` - createdAt: - format: int64 - type: string - readOnly: true + Name of the alias used for client-side authentication in the + following format: + `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` + clientAuthEnabled: description: >- - Output only. Creation time of this environment as milliseconds since - epoch. - hasAttachedFlowHooks: + Flag that specifies whether client-side authentication is enabled + for the target server. Enables two-way TLS. type: boolean - lastModifiedAt: + trustStore: + description: >- + Name of the keystore or keystore reference containing trusted + certificates for the server in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` or + `organizations/{org}/environments/{env}/references/{reference}` type: string - format: int64 - readOnly: true + keyAliasReference: + description: Reference name and alias pair to use for client-side authentication. + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' + GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + properties: + values: + description: Results of the query returned as a JSON array. + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence + type: array + columns: + items: + type: string description: >- - Output only. Last modification time of this environment as - milliseconds since epoch. - type: - enumDescriptions: - - Environment type not specified. - - >- - This is the default type. Base environment has limited capacity - and capabilities and are usually used when you are getting started - with Apigee or while experimenting. Refer to Apigee's public - documentation for more details. - - >- - Intermediate environment supports API management features and - higher capacity than Base environment. Refer to Apigee's public - documentation for more details. - - >- - Comprehensive environment supports advanced capabilites and even - higher capacity than Intermediate environment. Refer to Apigee's - public documentation for more details. - description: Optional. EnvironmentType selected for the environment. + Column names corresponding to the same order as the inner values in + the stats field. + type: array + nextPageToken: type: string - enum: - - ENVIRONMENT_TYPE_UNSPECIFIED - - BASE - - INTERMEDIATE - - COMPREHENSIVE - displayName: + description: Next page token. + type: object + description: >- + Represents security stats result as a collection of time series + sequences. + GoogleCloudApigeeV1ListOfDevelopersResponse: + id: GoogleCloudApigeeV1ListOfDevelopersResponse + properties: + developer: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + description: List of developers. + type: object + GoogleCloudApigeeV1ApiProductRef: + properties: + apiproduct: type: string - description: Optional. Display name for this environment. - apiProxyType: - description: >- - Optional. API Proxy type supported by the environment. The type can - be set when creating the Environment and cannot be changed. + description: Name of the API product. + status: + description: Status of the API product. Valid values are `approved` or `revoked`. type: string - enumDescriptions: - - API proxy type not specified. - - >- - Programmable API Proxies enable you to develop APIs with highly - flexible behavior using bundled policy configuration and one or - more programming languages to describe complex sequential and/or - conditional flows of logic. - - >- - Configurable API Proxies enable you to develop efficient APIs - using simple configuration while complex execution control flow - logic is handled by Apigee. This type only works with the ARCHIVE - deployment type and cannot be combined with the PROXY deployment - type. - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE type: object - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: + id: GoogleCloudApigeeV1ApiProductRef + GoogleCloudApigeeV1AccessGet: properties: - resources: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource - type: array - description: >- - Required. The array of resources. For Apigee, the proxies are - resources. - description: An array of resource messages. - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + name: + type: string + value: + type: string + id: GoogleCloudApigeeV1AccessGet + description: >- + Get action. For example, "Get" : { "name" : "target.name", "value" : + "default" } + type: object + GoogleCloudApigeeV1ServiceIssuersMapping: + id: GoogleCloudApigeeV1ServiceIssuersMapping type: object - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: - description: The format of the assessment recommendation. properties: - description: + service: type: string - description: The description of the recommendation. - link: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - description: The link for the recommendation. + description: String indicating the Apigee service name. + emailIds: + type: array + items: + type: string + description: List of trusted issuer email ids. + GoogleCloudApigeeV1ListCustomReportsResponse: type: object - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: - description: >- - Describes a potential routing change that may occur as a result of some - deployment operation. + description: This message encapsulates a list of custom report definitions + id: GoogleCloudApigeeV1ListCustomReportsResponse + properties: + qualifier: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + type: array + GoogleCloudApigeeV1OptimizedStatsResponse: type: object + id: GoogleCloudApigeeV1OptimizedStatsResponse + description: Encapsulates a response format for JavaScript Optimized Scenario. properties: - shouldSequenceRollout: + TimeUnit: + items: + format: int64 + type: string + description: >- + List of time unit values. Time unit refers to an epoch timestamp + value. + type: array + resultTruncated: type: boolean description: >- - Set to `true` if using sequenced rollout would make this routing - change safer. **Note**: This does not necessarily imply that - automated sequenced rollout mode is supported for the operation. - description: - description: Human-readable description of this routing change. + Boolean flag that indicates whether the results were truncated based + on the limit parameter. + stats: + description: '`stats` results.' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' + metaData: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + description: Metadata information about the query executed. + GoogleCloudApigeeV1ArchiveDeployment: + id: GoogleCloudApigeeV1ArchiveDeployment + properties: + operation: + description: >- + Output only. A reference to the LRO that created this Archive + Deployment in the following format: + `organizations/{org}/operations/{id}` type: string - environmentGroup: - description: Name of the environment group affected by this routing change. + readOnly: true + updatedAt: + readOnly: true + format: int64 type: string - fromDeployment: - description: Base path/deployment that may stop receiving some traffic. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - toDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment description: >- - Base path/deployment that may start receiving that traffic. May be - null if no deployment is able to receive the traffic. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange - GoogleCloudApigeeV1GraphqlDocumentation: - description: GraphQL documentation for a catalog item. - id: GoogleCloudApigeeV1GraphqlDocumentation - type: object - properties: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - description: Required. The documentation file contents for the GraphQL schema. - endpointUri: + Output only. The time at which the Archive Deployment was updated in + milliseconds since the epoch. + labels: description: >- - Required. The GraphQL endpoint URI to be queried by API consumers. - Max length is 2,083 characters. + User-supplied key-value pairs used to organize ArchiveDeployments. + Label keys must be between 1 and 63 characters long, have a UTF-8 + encoding of maximum 128 bytes, and must conform to the following + PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be + between 1 and 63 characters long, have a UTF-8 encoding of maximum + 128 bytes, and must conform to the following PCRE regular + expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can + be associated with a given store. + type: object + additionalProperties: + type: string + createdAt: + format: int64 + description: >- + Output only. The time at which the Archive Deployment was created in + milliseconds since the epoch. + readOnly: true type: string - GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: - properties: - documentationLink: + name: + description: >- + Name of the Archive Deployment in the following format: + `organizations/{org}/environments/{env}/archiveDeployments/{id}`. type: string - description: Documentation link for the action. - description: Action context are all the relevant details for the action. + gcsUri: + type: string + description: >- + Input only. The Google Cloud Storage signed URL returned from + GenerateUploadUrl and used to upload the Archive zip file. + description: Archive Deployment information. type: object - id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext - GoogleCloudApigeeV1FlowHook: + GoogleCloudApigeeV1AccessRemove: type: object properties: - description: + name: type: string - description: Description of the flow hook. - continueOnError: - description: >- - Optional. Flag that specifies whether execution should continue if - the flow hook throws an exception. Set to `true` to continue - execution. Set to `false` to stop execution if the flow hook throws - an exception. Defaults to `true`. + success: type: boolean - sharedFlow: + id: GoogleCloudApigeeV1AccessRemove + description: >- + Remove action. For example, "Remove" : { "name" : "target.name", + "success" : true } + GoogleCloudApigeeV1SecurityReportQuery: + description: Body structure when user makes a request to create a security report. + properties: + groupByTimeUnit: type: string description: >- - Shared flow attached to this flow hook, or empty if there is none - attached. - flowHookPoint: + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. + limit: + format: int32 + description: Maximum number of rows that can be returned in the result. + type: integer + reportDefinitionId: + description: Report Definition ID. + type: string + envgroupHostname: description: >- - Output only. Where in the API call flow the flow hook is invoked. - Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, - `PreTargetFlowHook`, or `PostTargetFlowHook`. + Hostname needs to be specified if query intends to run at host + level. This field is only allowed when query is submitted by + CreateHostSecurityReport where analytics data will be grouped by + organization and hostname. type: string - readOnly: true - id: GoogleCloudApigeeV1FlowHook - GoogleCloudApigeeV1TlsInfoCommonName: - properties: - value: - description: The TLS Common Name string of the certificate. + displayName: + description: Security Report display name which users can specify. type: string - wildcardMatch: - type: boolean + metrics: + type: array + description: A list of Metrics. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' + dimensions: + items: + type: string description: >- - Indicates whether the cert should be matched against as a wildcard - cert. - type: object - id: GoogleCloudApigeeV1TlsInfoCommonName - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: - type: object - description: The format for a link in the recommendation. - properties: - text: + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + type: array + csvDelimiter: type: string - description: 'The text of the url. (ie: "Learn more")' - uri: + description: >- + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + timeRange: + description: >- + Required. Time range for the query. Can use the following predefined + strings to specify the time range: `last60minutes` `last24hours` + `last7days` Or, specify the timeRange as a structure describing + start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": + "2018-08-01T00:18:00Z" } + type: any + filter: type: string - description: The link itself. - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - GoogleCloudApigeeV1OptimizedStatsResponse: + description: >- + Boolean expression that can be used to filter data. Filter + expressions can be combined using AND/OR terms and should be fully + parenthesized to avoid ambiguity. See Analytics metrics, dimensions, + and filters reference + https://docs.apigee.com/api-platform/analytics/analytics-reference + for more information on the fields available to filter on. For more + information on the tokens that you use to build filter expressions, + see Filter expression syntax. + https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax + mimeType: + type: string + description: >- + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. + type: object + id: GoogleCloudApigeeV1SecurityReportQuery + GoogleCloudApigeeV1RuntimeAnalyticsConfig: + id: GoogleCloudApigeeV1RuntimeAnalyticsConfig + description: Runtime configuration for the Analytics add-on. type: object - description: Encapsulates a response format for JavaScript Optimized Scenario. properties: - resultTruncated: + billingPipelineEnabled: type: boolean - description: >- - Boolean flag that indicates whether the results were truncated based - on the limit parameter. - TimeUnit: + description: If Runtime should send billing data to AX or not. + enabled: + type: boolean + description: If the Analytics is enabled or not. + GoogleCloudApigeeV1ListDataCollectorsResponse: + properties: + dataCollectors: + type: array + description: Data collectors in the specified organization. items: - format: int64 - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + nextPageToken: + type: string description: >- - List of time unit values. Time unit refers to an epoch timestamp - value. - type: array - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - description: Metadata information about the query executed. - stats: - description: '`stats` results.' - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' - id: GoogleCloudApigeeV1OptimizedStatsResponse - GoogleCloudApigeeV1NodeConfig: - description: >- - NodeConfig for setting the min/max number of nodes associated with the - environment. - id: GoogleCloudApigeeV1NodeConfig + Page token that you can include in a ListDataCollectors request to + retrieve the next page. If omitted, no subsequent pages exist. + description: Response for ListDataCollectors. + type: object + id: GoogleCloudApigeeV1ListDataCollectorsResponse + GoogleCloudApigeeV1ResourceConfig: + id: GoogleCloudApigeeV1ResourceConfig type: object properties: - minNodeCount: - format: int64 - description: >- - Optional. The minimum total number of gateway nodes that the is - reserved for all instances that has the specified environment. If - not specified, the default is determined by the recommended minimum - number of nodes for that gateway. - type: string - maxNodeCount: + location: + description: Location of the resource as a URI. type: string - format: int64 - description: >- - Optional. The maximum total number of gateway nodes that the is - reserved for all instances that has the specified environment. If - not specified, the default is determined by the recommended maximum - number of nodes for that gateway. - currentAggregateNodeCount: + name: type: string - readOnly: true - format: int64 description: >- - Output only. The current total number of gateway nodes that each - environment currently has across all instances. - GoogleCloudApigeeV1RuntimeTraceSamplingConfig: - id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig - type: object - description: >- - NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of - distributed tracing. Only the fields that are defined in the distributed - trace configuration can be overridden using the distribute trace - configuration override APIs. + Resource name in the following format: + `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` + Only environment-scoped resource files are supported. + GoogleCloudApigeeV1AliasRevisionConfig: + id: GoogleCloudApigeeV1AliasRevisionConfig properties: - samplingRate: + location: + type: string + description: Location of the alias file. For example, a Google Cloud Storage URI. + name: + type: string description: >- - Field sampling rate. This value is only applicable when using the - PROBABILITY sampler. The supported values are > 0 and <= 0.5. - format: float - type: number - sampler: - enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY + Name of the alias revision included in the keystore in the following + format: + `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}` + type: enumDescriptions: - - Sampler unspecified. - - >- - OFF means distributed trace is disabled, or the sampling - probability is 0. - - >- - PROBABILITY means traces are captured on a probability that - defined by sampling_rate. The sampling rate is limited to 0 to 0.5 - when this is set. + - Alias type is not specified. + - Certificate. + - Key/certificate pair. type: string - description: Sampler of distributed tracing. OFF is the default value. - GoogleCloudApigeeV1OperationMetadataProgress: - properties: - percentDone: - type: integer - description: The percentage of the operation progress. - format: int32 - details: - description: The additional details of the progress. - additionalProperties: - description: Properties of the object. - type: any - type: object - state: - enumDescriptions: - - '' - - '' - - '' - - '' enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED - description: State of the operation. - type: string - description: - type: string - description: Description of the operation's progress. + - ALIAS_TYPE_UNSPECIFIED + - CERT + - KEY_CERT type: object - description: Information about operation progress. - id: GoogleCloudApigeeV1OperationMetadataProgress - GoogleCloudApigeeV1ListSecurityIncidentsResponse: - description: Response for ListSecurityIncidents. + GoogleCloudApigeeV1Schema: + description: Response for Schema call properties: - nextPageToken: + meta: + items: + type: string description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - type: string - securityIncidents: - description: List of security incidents in the organization + Additional metadata associated with schema. This is a legacy field + and usually consists of an empty array of strings. + type: array + dimensions: type: array + description: List of schema fields grouped as dimensions. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + type: array + description: >- + List of schema fields grouped as dimensions that can be used with an + aggregate function such as `sum`, `avg`, `min`, and `max`. + id: GoogleCloudApigeeV1Schema + type: object + GoogleCloudApigeeV1MonetizationConfig: type: object - id: GoogleCloudApigeeV1ListSecurityIncidentsResponse - GoogleCloudApigeeV1ScoreComponentRecommendationAction: - description: Action to improve security score. properties: - description: + enabled: + description: Flag that specifies whether the Monetization add-on is enabled. + type: boolean + id: GoogleCloudApigeeV1MonetizationConfig + description: Configuration for the Monetization add-on. + GoogleCloudApigeeV1SecurityAssessmentResult: + type: object + id: GoogleCloudApigeeV1SecurityAssessmentResult + description: The security assessment result for one resource. + properties: + createTime: + description: >- + The time of the assessment of this resource. This could lag behind + `assessment_time` due to caching within the backend. + format: google-datetime type: string - description: Description of the action. - actionContext: - description: Action context for the action. + scoringResult: + description: The result of the assessment. $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + resource: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource + description: The assessed resource. + error: + description: The error status if scoring fails. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudApigeeV1Metric: type: object - id: GoogleCloudApigeeV1ScoreComponentRecommendationAction - GoogleCloudApigeeV1ApiProduct: + id: GoogleCloudApigeeV1Metric properties: - displayName: + values: description: >- - Name displayed in the UI or developer portal to developers - registering for API access. + List of metric values. Possible value formats include: + `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": + 1232434354} ]` + items: + type: any + type: array + name: type: string - scopes: - description: >- - Comma-separated list of OAuth scopes that are validated at runtime. - Apigee validates that the scopes in any access token presented match - the scopes defined in the OAuth policy associated with the API - product. + description: Metric name. + description: >- + Encapsulates the metric data point. For example: ```{ "name": + "sum(message_count)", "values" : [ { "timestamp": 1549004400000, + "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] + }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }``` + GoogleCloudApigeeV1Access: + properties: + Remove: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' + Get: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' + Set: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' + id: GoogleCloudApigeeV1Access + type: object + GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: + properties: + points: type: array items: - type: string - apiResources: + items: + type: any + type: array + description: List of points. First value of each inner list is a timestamp. + dimensions: + type: object description: >- - Comma-separated list of API resources to be bundled in the API - product. By default, the resource paths are mapped from the - `proxy.pathsuffix` variable. The proxy path suffix is defined as the - URI fragment following the ProxyEndpoint base path. For example, if - the `apiResources` element is defined to be `/forecastrss` and the - base path defined for the API proxy is `/weather`, then only - requests to `/weather/forecastrss` are permitted by the API product. - You can select a specific path, or you can select all subpaths with - the following wildcard: - `/**`: Indicates that all sub-URIs are - included. - `/*` : Indicates that only URIs one level down are - included. By default, / supports the same resources as /** as well - as the base path defined by the API proxy. For example, if the base - path of the API proxy is `/v1/weatherapikey`, then the API product - supports requests to `/v1/weatherapikey` and to any sub-URIs, such - as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, - and so on. For more information, see Managing API products. - items: + Map of dimensions and their values that uniquely identifies a time + series sequence. + additionalProperties: type: string - type: array - quotaInterval: + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence + type: object + description: A sequence of time series. + GoogleCloudApigeeV1App: + properties: + developerId: type: string - description: >- - Time interval over which the number of request messages is - calculated. - proxies: + description: ID of the developer. + credentials: type: array + readOnly: true items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' description: >- - Comma-separated list of API proxy names to which this API product is - bound. By specifying API proxies, you can associate resources in the - API product with specific API proxies, preventing developers from - accessing those resources through other API proxies. Apigee rejects - requests to API proxies that are not listed. **Note:** The API proxy - names must already exist in the specified environment as they will - be validated upon creation. + Output only. Set of credentials for the app. Credentials are API + key/secret pairs associated with API products. createdAt: - description: >- - Response only. Creation time of this environment as milliseconds - since epoch. - format: int64 type: string - approvalType: - description: >- - Flag that specifies how API keys are approved to access the APIs - defined by the API product. If set to `manual`, the consumer key is - generated and returned in "pending" state. In this case, the API - keys won't work until they have been explicitly approved. If set to - `auto`, the consumer key is generated and returned in "approved" - state and can be used immediately. **Note:** Typically, `auto` is - used to provide access to free or trial API products that provide - limited quota or capabilities. + description: Output only. Unix time when the app was created. + format: int64 + readOnly: true + lastModifiedAt: type: string + readOnly: true + description: Output only. Last modified time as milliseconds since epoch. + format: int64 name: - description: >- - Internal name of the API product. Characters you can use in the name - are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name - cannot be edited when updating the API product. + description: Name of the app. type: string - attributes: - description: >- - Array of attributes that may be used to extend the default API - product profile with customer-specific metadata. You can specify a - maximum of 18 attributes. Use this property to specify the access - level of the API product as either `public`, `private`, or - `internal`. Only products marked `public` are available to - developers in the Apigee developer portal. For example, you can set - a product to `internal` while it is in development and then change - access to `public` when it is ready to release on the portal. API - products marked as `private` do not appear on the portal, but can be - accessed by external developers. - type: array + scopes: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - grpcOperationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationGroup' - description: >- - Optional. Configuration used to group Apigee proxies with gRPC - services and method names. This grouping allows us to set quota for - a particular proxy with the gRPC service name and method. If a - method name is not set, this implies quota and authorization are - applied to all gRPC methods implemented by that proxy for that - particular gRPC service. - quotaTimeUnit: + type: string + type: array description: >- - Time unit defined for the `quotaInterval`. Valid values include - `minute`, `hour`, `day`, or `month`. + Scopes to apply to the app. The specified scope names must already + exist on the API product that you associate with the app. + appId: + description: ID of the app. type: string - description: + status: + description: Status of the credential. type: string - description: >- - Description of the API product. Include key information about the - API product that is not captured by other fields. - quota: + callbackUrl: type: string description: >- - Number of request messages permitted per app by this API product for - the specified `quotaInterval` and `quotaTimeUnit`. For example, a - `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of - hours means 50 requests are allowed every 12 hours. - lastModifiedAt: + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to apps. + developerEmail: + description: Email of the developer. type: string - description: >- - Response only. Modified time of this environment as milliseconds - since epoch. - format: int64 - environments: + companyName: + type: string + description: Name of the company that owns the app. + attributes: type: array items: - type: string - description: >- - Comma-separated list of environment names to which the API product - is bound. Requests to environments that are not listed are rejected. - By specifying one or more environments, you can bind the resources - listed in the API product to a specific environment, preventing - developers from accessing those resources through API proxies - deployed in another environment. This setting is used, for example, - to prevent resources associated with API proxies in `prod` from - being accessed by API proxies deployed in `test`. - graphqlOperationGroup: - description: >- - Configuration used to group Apigee proxies or remote services with - graphQL operation name, graphQL operation type and quotas. This - grouping allows us to precisely set quota for a particular - combination of graphQL name and operation type for a particular - proxy request. If graphQL name is not set, this would imply quota - will be applied on all graphQL requests matching the operation type. - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' - operationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' - description: >- - Configuration used to group Apigee proxies or remote services with - resources, method types, and quotas. The resource refers to the - resource URI (excluding the base path). With this grouping, the API - product creator is able to fine-tune and give precise control over - which REST methods have access to specific resources and how many - calls can be made (using the `quota` setting). **Note:** The - `api_resources` setting cannot be specified for both the API product - and operation group; otherwise the call will fail. - quotaCounterScope: - enum: - - QUOTA_COUNTER_SCOPE_UNSPECIFIED - - PROXY - - OPERATION - enumDescriptions: - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), the limits set at product level will be - used as a local counter for quota evaluation by all the - operations, independent of proxy association. - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), set at product level will be used as a - global counter for quota evaluation by all the operations - associated with a particular proxy. - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), the limits set at product level will be - used as a local counter for quota evaluation by all the - operations, independent of proxy association. This behavior mimics - the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED. - description: >- - Scope of the quota decides how the quota counter gets applied and - evaluate for quota violation. If the Scope is set as PROXY, then all - the operations defined for the APIproduct that are associated with - the same proxy will share the same quota counter set at the - APIproduct level, making it a global counter at a proxy level. If - the Scope is set as OPERATION, then each operations get the counter - set at the API product dedicated, making it a local counter. Note - that, the QuotaCounterScope applies only when an operation does not - have dedicated quota set for itself. + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: List of attributes. + apiProducts: + description: List of API products associated with the app. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + type: array + appGroup: + type: string + description: Name of the AppGroup + keyExpiresIn: type: string + description: >- + Duration, in milliseconds, of the consumer key that will be + generated for the app. The default value, -1, indicates an infinite + validity period. Once set, the expiration can't be updated. json + key: keyExpiresIn + format: int64 + id: GoogleCloudApigeeV1App type: object - id: GoogleCloudApigeeV1ApiProduct - GoogleCloudApigeeV1GraphQLOperationGroup: - description: >- - List of graphQL operation configuration details associated with Apigee - API proxies or remote services. Remote services are non-Apigee proxies, - such as Istio-Envoy. + GoogleCloudApigeeV1TlsInfo: + description: TLS configuration information for virtual hosts and TargetServers. properties: - operationConfigs: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' + clientAuthEnabled: + description: Optional. Enables two-way TLS. + type: boolean + ignoreValidationErrors: + type: boolean description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. - type: array - operationConfigType: + If true, Edge ignores TLS certificate errors. Valid when configuring + TLS for target servers and target endpoints, and when configuring + virtual hosts that use 2-way TLS. When used with a target + endpoint/target server, if the backend system uses SNI and returns a + cert with a subject Distinguished Name (DN) that does not match the + hostname, there is no way to ignore the error and the connection + fails. + keyStore: + type: string + description: >- + Required if `client_auth_enabled` is true. The resource ID of the + keystore. + keyAlias: + description: >- + Required if `client_auth_enabled` is true. The resource ID for the + alias containing the private key and cert. type: string - description: >- - Flag that specifies whether the configuration is for Apigee API - proxy or a remote service. Valid values include `proxy` or - `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API - proxies are associated with the API product. Set to `remoteservice` - when non-Apigee proxies like Istio-Envoy are associated with the API - product. - id: GoogleCloudApigeeV1GraphQLOperationGroup - type: object - GoogleCloudApigeeV1ListSecurityReportsResponse: - properties: - nextPageToken: + protocols: + description: The TLS versioins to be used. + items: + type: string + type: array + enforce: + description: TLS is strictly enforced. + type: boolean + trustStore: + description: The resource ID of the truststore. type: string + enabled: description: >- - If the number of security reports exceeded the page size requested, - the token can be used to fetch the next page in a subsequent call. - If the response is the last page and there are no more reports to - return this field is left empty. - securityReports: - description: The security reports belong to requested resource name. + Required. Enables TLS. If false, neither one-way nor two-way TLS + will be enabled. + type: boolean + ciphers: type: array + description: >- + The SSL/TLS cipher suites to be used. For programmable proxies, it + must be one of the cipher suite names listed in: + http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. + For configurable proxies, it must follow the configuration specified + in: + https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. + This setting has no effect for configurable proxies when negotiating + TLS 1.3. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + type: string + commonName: + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' + description: The TLS Common Name of the certificate. + type: object + id: GoogleCloudApigeeV1TlsInfo + GoogleCloudApigeeV1DimensionMetric: + description: Encapsulates a metric grouped by dimension. + id: GoogleCloudApigeeV1DimensionMetric type: object - description: The response for SecurityReports. - id: GoogleCloudApigeeV1ListSecurityReportsResponse - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - description: A Signed URL and the relevant metadata associated with it. properties: - md5: - description: The MD5 Hash of the JSON data - type: string - sizeBytes: - type: string - format: int64 - description: The size of the returned file in bytes - uri: + individualNames: + type: array + description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. + items: + type: string + metrics: + type: array + description: List of metrics. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + name: type: string + deprecated: true description: >- - The signed URL of the JSON data. Will be of the form - `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= - GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount - .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 - 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 - 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 - 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc - c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 - 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a - 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 - a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 - 2ea7abedc098d2eb14a7` - type: object - GoogleCloudApigeeV1IntegrationConfig: + Comma joined dimension names. E.g. "dim1_name,dim2_name". + Deprecated. If name already has comma before join, we may get wrong + splits. Please use individual_names. + GoogleCloudApigeeV1ListDeploymentsResponse: properties: - enabled: - type: boolean - description: Flag that specifies whether the Integration add-on is enabled. - id: GoogleCloudApigeeV1IntegrationConfig - description: Configuration for the Integration add-on. + deployments: + description: List of deployments. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + id: GoogleCloudApigeeV1ListDeploymentsResponse type: object - GoogleCloudApigeeV1Keystore: + GoogleCloudApigeeV1Query: type: object + id: GoogleCloudApigeeV1Query properties: - name: + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' + type: array + description: A list of Metrics. + groupByTimeUnit: type: string description: >- - Required. Resource ID for this keystore. Values must match the - regular expression `[\w[:space:].-]{1,255}`. - aliases: - readOnly: true + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. + dimensions: + type: array items: type: string - description: Output only. Aliases in this keystore. - type: array - description: Datastore for Certificates and Aliases. - id: GoogleCloudApigeeV1Keystore - GoogleCloudApigeeV1Metric: - type: object - properties: + description: >- + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + outputFormat: + description: >- + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. + type: string + timeRange: + type: any + description: >- + Required. Time range for the query. Can use the following predefined + strings to specify the time range: `last60minutes` `last24hours` + `last7days` Or, specify the timeRange as a structure describing + start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": + "2018-08-01T00:18:00Z" } + csvDelimiter: + type: string + description: >- + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). name: - description: Metric name. type: string - values: - items: - type: any - type: array + description: Asynchronous Query Name. + filter: + type: string description: >- - List of metric values. Possible value formats include: - `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": - 1232434354} ]` - id: GoogleCloudApigeeV1Metric - description: >- - Encapsulates the metric data point. For example: ```{ "name": - "sum(message_count)", "values" : [ { "timestamp": 1549004400000, - "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] - }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }``` - GoogleApiHttpBody: - type: object - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - id: GoogleApiHttpBody - properties: - contentType: + Boolean expression that can be used to filter data. Filter + expressions can be combined using AND/OR terms and should be fully + parenthesized to avoid ambiguity. See Analytics metrics, dimensions, + and filters reference + https://docs.apigee.com/api-platform/analytics/analytics-reference + for more information on the fields available to filter on. For more + information on the tokens that you use to build filter expressions, + see Filter expression syntax. + https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax + reportDefinitionId: + type: string + description: Asynchronous Report ID. + limit: + type: integer + description: Maximum number of rows that can be returned in the result. + format: int32 + envgroupHostname: type: string description: >- - The HTTP Content-Type header value specifying the content type of - the body. - extensions: - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + Hostname needs to be specified if query intends to run at host + level. This field is only allowed when query is submitted by + CreateHostAsyncQuery where analytics data will be grouped by + organization and hostname. + GoogleCloudApigeeV1EndpointChainingRule: + properties: + deploymentGroup: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - data: - format: byte - description: The HTTP request/response body as raw binary. + The deployment group to target for cross-shard chaining calls to + these proxies. type: string - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: + proxyIds: + type: array + items: + type: string + description: List of proxy ids which may be found in the given deployment group. type: object - description: Resource for which we are computing security assessment. - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + description: >- + EndpointChainingRule specifies the proxies contained in a particular + deployment group, so that other deployment groups can find them in + chaining calls. + id: GoogleCloudApigeeV1EndpointChainingRule + GoogleCloudApigeeV1Result: + description: >- + Result is short for "action result", could be different types identified + by "action_result" field. Supported types: 1. DebugInfo : generic debug + info collected by runtime recorded as a list of properties. For example, + the contents could be virtual host info, state change result, or + execution metadata. Required fields : properties, timestamp 2. + RequestMessage: information of a http request. Contains headers, request + URI and http methods type.Required fields : headers, uri, verb 3. + ResponseMessage: information of a http response. Contains headers, + reason phrase and http status code. Required fields : headers, + reasonPhrase, statusCode 4. ErrorMessage: information of a http error + message. Contains detail error message, reason phrase and status code. + Required fields : content, headers, reasonPhrase, statusCode 5. + VariableAccess: a list of variable access actions, can be Get, Set and + Remove. Required fields : accessList + id: GoogleCloudApigeeV1Result properties: - type: - description: Required. Type of this resource. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY + properties: + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + description: Name value pairs used for DebugInfo ActionResult. + uRI: + description: >- + The relative path of the api proxy. for example, `"uRI" : + "/iloveapis"` type: string - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. - name: + statusCode: + description: HTTP response code type: string - description: Required. Name of this resource. - GoogleCloudApigeeV1AppGroup: - properties: - appGroupId: - readOnly: true + verb: type: string - description: Output only. Internal identifier that cannot be edited - organization: + description: HTTP method verb + ActionResult: type: string - description: Immutable. the org the app group is created - channelId: + description: >- + Type of the action result. Can be one of the five: DebugInfo, + RequestMessage, ResponseMessage, ErrorMessage, VariableAccess + timestamp: type: string - description: channel identifier identifies the owner maintaing this grouping. - status: description: >- - Valid values are `active` or `inactive`. Note that the status of the - AppGroup should be updated via UpdateAppGroupRequest by setting the - action as `active` or `inactive`. + Timestamp of when the result is recorded. Its format is dd-mm-yy + hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` + content: type: string - attributes: + description: >- + Error message content. for example, "content" : + "{\"fault\":{\"faultstring\":\"API timed + out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" + accessList: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Access' + description: >- + A list of variable access actions agaist the api proxy. Supported + values: Get, Set, Remove. type: array + reasonPhrase: + type: string + description: HTTP response phrase + headers: + description: >- + A list of HTTP headers. for example, '"headers" : [ { "name" : + "Content-Length", "value" : "83" }, { "name" : "Content-Type", + "value" : "application/json" } ]' items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: A list of attributes - name: + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + type: array + type: object + GoogleCloudApigeeV1DeveloperSubscription: + type: object + properties: + apiproduct: type: string description: >- - Immutable. Name of the AppGroup. Characters you can use in the name - are restricted to: A-Z0-9._\-$ %. - channelUri: + Name of the API product for which the developer is purchasing a + subscription. + startTime: + format: int64 type: string - description: A reference to the associated storefront/marketplace. + description: >- + Time when the API product subscription starts in milliseconds since + epoch. lastModifiedAt: readOnly: true + description: >- + Output only. Time when the API product subscription was last + modified in milliseconds since epoch. type: string format: int64 - description: Output only. Modified time as milliseconds since epoch. - displayName: + endTime: type: string - description: app group name displayed in the UI + format: int64 + description: >- + Time when the API product subscription ends in milliseconds since + epoch. createdAt: + description: >- + Output only. Time when the API product subscription was created in + milliseconds since epoch. format: int64 - description: Output only. Created time as milliseconds since epoch. + readOnly: true + type: string + name: + description: Output only. Name of the API product subscription. type: string readOnly: true - id: GoogleCloudApigeeV1AppGroup + id: GoogleCloudApigeeV1DeveloperSubscription + description: Structure of a DeveloperSubscription. + GoogleCloudApigeeV1DeleteResponse: + properties: + status: + description: Status of the operation. + type: string + message: + description: Description of the operation. + type: string + errorCode: + type: string + description: Unique error code for the request, if any. + gcpResource: + description: Google Cloud name of deleted resource. + type: string + requestId: + type: string + description: Unique ID of the request. + description: Response for certain delete operations. + type: object + id: GoogleCloudApigeeV1DeleteResponse + GoogleCloudApigeeV1ProfileConfigAuthorization: type: object + properties: {} description: >- - AppGroup contains the request/response fields representing the logical - grouping of apps. Note that appgroup_id, create_time and update_time - cannot be changed by the user, and gets updated by the system. The name - and the organization once provided cannot be edited subsequently. - GoogleCloudApigeeV1DebugMask: + By default, following policies will be included: - JWS - JWT - OAuth - + BasicAuth - APIKey + id: GoogleCloudApigeeV1ProfileConfigAuthorization + GoogleCloudApigeeV1ProfileConfigThreat: type: object - id: GoogleCloudApigeeV1DebugMask + id: GoogleCloudApigeeV1ProfileConfigThreat + description: >- + By default, following policies will be included: - XMLThreatProtection - + JSONThreatProtection + properties: {} + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. properties: - faultJSONPaths: - items: - type: string - type: array - description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON payloads in error flows. - faultXPaths: - description: >- - List of XPaths that specify the XML elements to be filtered from XML - payloads in error flows. - type: array - items: - type: string - requestJSONPaths: - items: - type: string + metadata: description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON request message payloads. - type: array - variables: - type: array - description: List of variables that should be masked from the debug output. - items: - type: string - name: - type: string - description: Name of the debug mask. - responseJSONPaths: - type: array - items: - type: string + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + done: description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON response message payloads. - requestXPaths: + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + response: description: >- - List of XPaths that specify the XML elements to be filtered from XML - request message payloads. - type: array - items: - type: string - namespaces: - additionalProperties: - type: string - description: Map of namespaces to URIs. + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. type: object - responseXPaths: - items: - type: string - type: array + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - List of XPaths that specify the XML elements to be filtered from XML - response message payloads. - GoogleCloudApigeeV1SecurityAssessmentResultResource: - description: Resource for which we are computing security assessment. - properties: + The error result of the operation in case of failure or + cancellation. name: - type: string - description: Required. Name of this resource. - resourceRevisionId: description: >- - The revision id for the resource. In case of Apigee, this is proxy - revision id. - type: string - type: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - description: Required. Type of this resource. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. - id: GoogleCloudApigeeV1SecurityAssessmentResultResource type: object - GoogleCloudApigeeV1ListInstancesResponse: - id: GoogleCloudApigeeV1ListInstancesResponse - description: Response for ListInstances. + GoogleCloudApigeeV1SecurityReportQueryMetric: + id: GoogleCloudApigeeV1SecurityReportQueryMetric properties: - instances: - description: Instances in the specified organization. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' - nextPageToken: + operator: + description: One of `+`, `-`, `/`, `%`, `*`. + type: string + alias: type: string description: >- - Page token that you can include in a ListInstance request to - retrieve the next page of content. If omitted, no subsequent pages - exist. + Alias for the metric. Alias will be used to replace metric name in + query results. + name: + type: string + description: Required. Metric name. + value: + type: string + description: Operand value should be provided when operator is set. + aggregationFunction: + type: string + description: 'Aggregation function: avg, min, max, or sum.' + description: Metric of the Query + type: object + GoogleCloudApigeeV1ReportInstanceStatusRequest: + description: Request for ReportInstanceStatus. + id: GoogleCloudApigeeV1ReportInstanceStatusRequest type: object - GoogleCloudApigeeV1RoutingRule: properties: - envGroupRevision: - format: int64 - type: string - description: >- - The env group config revision_id when this rule was added or last - updated. This value is set when the rule is created and will only - update if the the environment_id changes. It is used to determine if - the runtime is up to date with respect to this rule. This field is - omitted from the IngressConfig unless the GetDeployedIngressConfig - API is called with view=FULL. - otherTargets: + resources: type: array + description: Status for config resources items: - type: string - description: >- - Conflicting targets, which will be resource names specifying either - deployment groups or environments. - environment: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' + instanceUid: type: string description: >- - Name of an environment bound to the environment group in the - following format: `organizations/{org}/environments/{env}`. Only one - of environment or deployment_group will be set. - updateTime: + A unique ID for the instance which is guaranteed to be unique in + case the user installs multiple hybrid runtimes with the same + instance ID. + reportTime: type: string description: >- - The unix timestamp when this rule was updated. This is updated - whenever env_group_revision is updated. This field is omitted from - the IngressConfig unless the GetDeployedIngressConfig API is called - with view=FULL. + The time the report was generated in the runtime. Used to prevent an + old status from overwriting a newer one. An instance should space + out it's status reports so that clock skew does not play a factor. format: google-datetime - receiver: - description: >- - The resource name of the proxy revision that is receiving this - basepath in the following format: - `organizations/{org}/apis/{api}/revisions/{rev}`. This field is - omitted from the IngressConfig unless the GetDeployedIngressConfig - API is called with view=FULL. - type: string - basepath: - type: string - description: >- - URI path prefix used to route to the specified environment. May - contain one or more wildcards. For example, path segments consisting - of a single `*` character will match any string. - deploymentGroup: - description: >- - Name of a deployment group in an environment bound to the - environment group in the following format: - `organizations/{org}/environment/{env}/deploymentGroups/{group}` - Only one of environment or deployment_group will be set. - type: string + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: + description: Revisions deployed in the MPs. + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision type: object - id: GoogleCloudApigeeV1RoutingRule - GoogleCloudApigeeV1ListInstanceAttachmentsResponse: - id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse properties: - attachments: - type: array - description: Attachments for the instance. + percentage: + format: int32 + description: Percentage of MP replicas reporting this revision. + type: integer + revision: + type: string + description: API proxy revision reported as deployed. + GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: + id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + properties: + environmentGroupAttachments: + description: EnvironmentGroupAttachments for the specified environment group. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' + type: array nextPageToken: type: string description: >- - Page token that you can include in a ListInstanceAttachments request - to retrieve the next page of content. If omitted, no subsequent - pages exist. + Page token that you can include in a ListEnvironmentGroupAttachments + request to retrieve the next page. If omitted, no subsequent pages + exist. type: object - description: Response for ListInstanceAttachments. - GoogleCloudApigeeV1ResourceConfig: - properties: - location: - type: string - description: Location of the resource as a URI. - name: - type: string - description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` - Only environment-scoped resource files are supported. + description: Response for ListEnvironmentGroupAttachments. + GoogleCloudApigeeV1GenerateUploadUrlRequest: + description: Request for GenerateUploadUrl method. type: object - id: GoogleCloudApigeeV1ResourceConfig - GoogleCloudApigeeV1CommonNameConfig: + id: GoogleCloudApigeeV1GenerateUploadUrlRequest + properties: {} + GoogleCloudApigeeV1ApiCategory: properties: - matchWildCards: - type: boolean name: type: string - type: object - id: GoogleCloudApigeeV1CommonNameConfig - GoogleCloudApigeeV1DeveloperMonetizationConfig: - id: GoogleCloudApigeeV1DeveloperMonetizationConfig - properties: - billingType: + description: Name of the category. + id: + type: string + description: ID of the category (a UUID). + updateTime: + type: string + format: int64 + description: Time the category was last modified in milliseconds since epoch. + siteId: + description: Name of the portal. type: string - description: Billing type. - enumDescriptions: - - The default/unset value. - - >- - Developer pays in advance for the use of APIs and the charged - amount is deducted from their account balance. - - >- - Developer does not maintain an account balance. The API provider - bills the developer for API usage. - enum: - - BILLING_TYPE_UNSPECIFIED - - PREPAID - - POSTPAID - description: Monetization configuration for the developer. - type: object - GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: - id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest - properties: {} type: object - description: Request for ExpireDeveloperSubscription. - GoogleCloudApigeeV1SecurityActionAllow: - id: GoogleCloudApigeeV1SecurityActionAllow + id: GoogleCloudApigeeV1ApiCategory + description: >- + `ApiCategory` represents an API category. [Catalog + items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) + can be tagged with API categories; users viewing the API catalog in the + portal will have the option to browse the catalog by category. + GoogleCloudApigeeV1DeploymentGroupConfig: type: object - properties: {} description: >- - Message that should be set in case of an Allow Action. This does not - have any fields. - GoogleCloudApigeeV1ListEndpointAttachmentsResponse: - description: Response for ListEndpointAttachments method. - id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse + DeploymentGroupConfig represents a deployment group that should be + present in a particular environment. properties: - nextPageToken: - type: string + revisionId: description: >- - Page token that you can include in an `ListEndpointAttachments` - request to retrieve the next page. If omitted, no subsequent pages - exist. - endpointAttachments: - description: Endpoint attachments in the specified organization. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' - type: object - GoogleCloudApigeeV1SchemaSchemaProperty: - properties: - type: + Revision number which can be used by the runtime to detect if the + deployment group has changed between two versions. type: string - description: Data type of the field. - custom: + format: int64 + name: + description: >- + Name of the deployment group in the following format: + `organizations/{org}/environments/{env}/deploymentGroups/{group}`. type: string + uid: description: >- - Flag that specifies whether the field is standard in the dataset or - a custom field created by the customer. `true` indicates that it is - a custom field. - createTime: + Unique ID. The ID will only change if the deployment group is + deleted and recreated. + type: string + deploymentGroupType: description: >- - Time the field was created in RFC3339 string form. For example: - `2016-02-26T10:23:09.592Z`. + Type of the deployment group, which will be either Standard or + Extensible. + enumDescriptions: + - Unspecified type + - Standard type + - Extensible Type + enum: + - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE type: string - description: Properties for the schema field. - id: GoogleCloudApigeeV1SchemaSchemaProperty - type: object - GoogleCloudApigeeV1ListRatePlansResponse: + id: GoogleCloudApigeeV1DeploymentGroupConfig + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + description: Response for BatchUpdateSecurityIncident. type: object - description: Response for ListRatePlans. properties: - ratePlans: + securityIncidents: + readOnly: true + description: Output only. Updated security incidents items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' - description: List of rate plans in an organization. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' type: array - nextStartKey: - type: string - description: >- - Value that can be sent as `startKey` to retrieve the next page of - content. If this field is omitted, there are no subsequent pages. - id: GoogleCloudApigeeV1ListRatePlansResponse - GoogleCloudApigeeV1DisableSecurityActionRequest: - id: GoogleCloudApigeeV1DisableSecurityActionRequest - description: Message to disable an enabled SecurityAction. - properties: {} - type: object - GoogleCloudApigeeV1ListOfDevelopersResponse: + GoogleCloudApigeeV1ListAsyncQueriesResponse: + id: GoogleCloudApigeeV1ListAsyncQueriesResponse + description: The response for ListAsyncQueries. type: object properties: - developer: - description: List of developers. + queries: type: array + description: The asynchronous queries belong to requested resource name. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' - id: GoogleCloudApigeeV1ListOfDevelopersResponse - GoogleLongrunningOperation: - properties: - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - name: - type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - response: - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - id: GoogleLongrunningOperation + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + GoogleProtobufEmpty: description: >- - This resource represents a long-running operation that is the result of - a network API call. + 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); } + type: object + id: GoogleProtobufEmpty + properties: {} + GoogleRpcStatus: type: object - GoogleIamV1Binding: properties: - condition: - $ref: '#/components/schemas/GoogleTypeExpr' + message: description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - role: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string + details: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - members: - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. items: - type: string + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object type: array - id: GoogleIamV1Binding + code: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudApigeeV1CanaryEvaluationMetricLabels: + description: Labels that can be used to filter Apigee metrics. type: object - description: Associates `members`, or principals, with a `role`. - GoogleCloudApigeeV1ArchiveDeployment: - description: Archive Deployment information. properties: - createdAt: - format: int64 - description: >- - Output only. The time at which the Archive Deployment was created in - milliseconds since the epoch. - readOnly: true + location: type: string - gcsUri: + description: Required. The location associated with the metrics. + env: + description: The environment ID associated with the metrics. type: string + instance_id: description: >- - Input only. The Google Cloud Storage signed URL returned from - GenerateUploadUrl and used to upload the Archive zip file. - name: + Required. The instance ID associated with the metrics. In Apigee + Hybrid, the value is configured during installation. + type: string + id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels + GoogleCloudApigeeV1EnableSecurityActionRequest: + type: object + properties: {} + description: Message to enable a disabled SecurityAction. + id: GoogleCloudApigeeV1EnableSecurityActionRequest + GoogleCloudApigeeV1DeploymentConfig: + id: GoogleCloudApigeeV1DeploymentConfig + type: object + properties: + proxyUid: + description: Unique ID of the API proxy revision. + type: string + serviceAccount: type: string description: >- - Name of the Archive Deployment in the following format: - `organizations/{org}/environments/{env}/archiveDeployments/{id}`. - operation: + The service account identity associated with this deployment. If + non-empty, will be in the following format: + `projects/-/serviceAccounts/{account_email}` + basePath: type: string - readOnly: true + description: Base path where the application will be hosted. Defaults to "/". + uid: description: >- - Output only. A reference to the LRO that created this Archive - Deployment in the following format: - `organizations/{org}/operations/{id}` - updatedAt: - readOnly: true + Unique ID. The ID will only change if the deployment is deleted and + recreated. + type: string + endpoints: description: >- - Output only. The time at which the Archive Deployment was updated in - milliseconds since the epoch. - format: int64 + A mapping from basepaths to proxy endpoint names in this proxy. Not + populated for shared flows. + additionalProperties: + type: string + type: object + name: type: string - labels: + description: >- + Name of the API or shared flow revision to be deployed in the + following format: `organizations/{org}/apis/{api}/revisions/{rev}` + or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` + deploymentGroups: + description: >- + The list of deployment groups in which this proxy should be + deployed. Not currently populated for shared flows. + items: + type: string + type: array + attributes: additionalProperties: type: string type: object + description: Additional key-value metadata for the deployment. + location: + type: string + description: Location of the API proxy bundle as a URI. + description: 'NEXT ID: 11' + GoogleCloudApigeeV1ListSecurityReportsResponse: + properties: + nextPageToken: + type: string description: >- - User-supplied key-value pairs used to organize ArchiveDeployments. - Label keys must be between 1 and 63 characters long, have a UTF-8 - encoding of maximum 128 bytes, and must conform to the following - PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be - between 1 and 63 characters long, have a UTF-8 encoding of maximum - 128 bytes, and must conform to the following PCRE regular - expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can - be associated with a given store. - type: object - id: GoogleCloudApigeeV1ArchiveDeployment - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. + If the number of security reports exceeded the page size requested, + the token can be used to fetch the next page in a subsequent call. + If the response is the last page and there are no more reports to + return this field is left empty. + securityReports: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + type: array + description: The security reports belong to requested resource name. type: object + id: GoogleCloudApigeeV1ListSecurityReportsResponse + description: The response for SecurityReports. + GoogleCloudApigeeV1ReferenceConfig: properties: - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - service: + resourceName: + description: >- + Name of the referenced resource in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` Only + references to keystore resources are supported. + type: string + name: type: string description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - GoogleCloudApigeeV1SecurityReport: - id: GoogleCloudApigeeV1SecurityReport - description: >- - SecurityReport saves all the information about the created security - report. + Name of the reference in the following format: + `organizations/{org}/environments/{env}/references/{reference}` + id: GoogleCloudApigeeV1ReferenceConfig type: object + GoogleCloudApigeeV1GenerateUploadUrlResponse: + id: GoogleCloudApigeeV1GenerateUploadUrlResponse properties: - error: + uploadUri: + description: >- + The Google Cloud Storage signed URL that can be used to upload a new + Archive zip file. type: string - description: Error is set when query fails. - created: + type: object + description: Response for GenerateUploadUrl method. + GoogleCloudApigeeV1SchemaSchemaProperty: + description: Properties for the schema field. + properties: + createTime: + description: >- + Time the field was created in RFC3339 string form. For example: + `2016-02-26T10:23:09.592Z`. type: string - description: Creation time of the query. - self: + type: + description: Data type of the field. type: string + custom: description: >- - Self link of the query. Example: - `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - or following format if query is running at host level: - `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - reportDefinitionId: - description: Report Definition ID. + Flag that specifies whether the field is standard in the dataset or + a custom field created by the customer. `true` indicates that it is + a custom field. type: string - resultFileSize: + type: object + id: GoogleCloudApigeeV1SchemaSchemaProperty + GoogleCloudApigeeV1Environment: + type: object + properties: + createdAt: + description: >- + Output only. Creation time of this environment as milliseconds since + epoch. type: string - description: ResultFileSize is available only after the query is completed. - displayName: + readOnly: true + format: int64 + state: type: string - description: Display Name specified by the user. - queryParams: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + readOnly: true + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. description: >- - Contains information like metrics, dimenstions etc of the Security - Report. - result: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' - description: Result is available only after the query is completed. - envgroupHostname: - description: Hostname is available only when query is executed at host level. - type: string - executionTime: + Output only. State of the environment. Values other than ACTIVE + means the resource is not ready to use. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + nodeConfig: + description: Optional. NodeConfig of the environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' + apiProxyType: + description: >- + Optional. API Proxy type supported by the environment. The type can + be set when creating the Environment and cannot be changed. type: string - description: ExecutionTime is available only after the query is completed. - state: + enumDescriptions: + - API proxy type not specified. + - >- + Programmable API Proxies enable you to develop APIs with highly + flexible behavior using bundled policy configuration and one or + more programming languages to describe complex sequential and/or + conditional flows of logic. + - >- + Configurable API Proxies enable you to develop efficient APIs + using simple configuration while complex execution control flow + logic is handled by Apigee. This type only works with the ARCHIVE + deployment type and cannot be combined with the PROXY deployment + type. + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + deploymentType: + enum: + - DEPLOYMENT_TYPE_UNSPECIFIED + - PROXY + - ARCHIVE type: string description: >- - Query state could be "enqueued", "running", "completed", "expired" - and "failed". - resultRows: - description: ResultRows is available only after the query is completed. + Optional. Deployment type supported by the environment. The + deployment type can be set when creating the environment and cannot + be changed. When you enable archive deployment, you will be + **prevented from performing** a [subset of + actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) + within the environment, including: * Managing the deployment of API + proxy or shared flow revisions * Creating, updating, or deleting + resource files * Creating, updating, or deleting target servers + enumDescriptions: + - Deployment type not specified. + - >- + Proxy deployment enables you to develop and deploy API proxies + using Apigee on Google Cloud. This cannot currently be combined + with the CONFIGURABLE API proxy type. + - >- + Archive deployment enables you to develop API proxies locally then + deploy an archive of your API proxy configuration to an + environment in Apigee on Google Cloud. You will be prevented from + performing a [subset of + actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) + within the environment. + properties: + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + description: >- + Optional. Key-value pairs that may be used for customizing the + environment. + forwardProxyUri: + description: >- + Optional. URI of the forward proxy to be applied to the runtime + instances in this environment. Must be in the format of + {scheme}://{hostname}:{port}. Note that the scheme must be one of + "http" or "https", and the port must be supplied. To remove a + forward proxy setting, update the field to an empty value. Note: At + this time, PUT operations to add forwardProxyUri to an existing + environment fail if the environment has nodeConfig set up. To + successfully add the forwardProxyUri setting in this case, include + the NodeConfig details with the request. + type: string + type: + enumDescriptions: + - Environment type not specified. + - >- + This is the default type. Base environment has limited capacity + and capabilities and are usually used when you are getting started + with Apigee or while experimenting. Refer to Apigee's public + documentation for more details. + - >- + Intermediate environment supports API management features and + higher capacity than Base environment. Refer to Apigee's public + documentation for more details. + - >- + Comprehensive environment supports advanced capabilites and even + higher capacity than Intermediate environment. Refer to Apigee's + public documentation for more details. + enum: + - ENVIRONMENT_TYPE_UNSPECIFIED + - BASE + - INTERMEDIATE + - COMPREHENSIVE + description: Optional. EnvironmentType selected for the environment. type: string + hasAttachedFlowHooks: + type: boolean + lastModifiedAt: format: int64 - updated: + type: string + description: >- + Output only. Last modification time of this environment as + milliseconds since epoch. readOnly: true - description: Output only. Last updated timestamp for the query. + description: + description: Optional. Description of the environment. + type: string + displayName: + description: Optional. Display name for this environment. type: string + name: + description: >- + Required. Name of the environment. Values must match the regular + expression `^[.\\p{Alnum}-_]{1,255}$` + type: string + id: GoogleCloudApigeeV1Environment GoogleCloudApigeeV1SharedFlowRevision: - description: The metadata describing a shared flow revision. id: GoogleCloudApigeeV1SharedFlowRevision type: object + description: The metadata describing a shared flow revision. properties: sharedFlows: - description: >- - A list of the shared flow names included in this shared flow - revision. type: array items: type: string - lastModifiedAt: description: >- - Time at which this shared flow revision was most recently modified, - in milliseconds since epoch. - format: int64 - type: string - policies: - items: + A list of the shared flow names included in this shared flow + revision. + entityMetaDataAsProperties: + type: object + description: A Key-Value map of metadata about this shared flow revision. + additionalProperties: type: string - type: array - description: A list of policy names included in this shared flow revision. - resourceFiles: - description: The resource files included in this shared flow revision. - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - type: - description: The string "Application" - type: string - revision: - type: string - description: The resource ID of this revision. name: - description: The resource ID of the parent shared flow. type: string - displayName: - description: The human readable name of this shared flow. + description: The resource ID of the parent shared flow. + createdAt: + description: >- + Time at which this shared flow revision was created, in milliseconds + since epoch. type: string + format: int64 + resourceFiles: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + description: The resource files included in this shared flow revision. resources: items: type: string + type: array description: >- A list of the resources included in this shared flow revision formatted as "{type}://{name}". - type: array - contextInfo: - description: A textual description of the shared flow revision. + description: type: string + description: Description of the shared flow revision. configurationVersion: description: >- The version of the configuration schema to which this shared flow @@ -5350,3224 +4903,3584 @@ components: minorVersion 0. This setting may be used in the future to enable evolution of the shared flow format. $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' - description: - description: Description of the shared flow revision. + revision: + type: string + description: The resource ID of this revision. + policies: + items: + type: string + type: array + description: A list of policy names included in this shared flow revision. + displayName: + description: The human readable name of this shared flow. + type: string + contextInfo: + type: string + description: A textual description of the shared flow revision. + lastModifiedAt: type: string - createdAt: description: >- - Time at which this shared flow revision was created, in milliseconds - since epoch. + Time at which this shared flow revision was most recently modified, + in milliseconds since epoch. format: int64 + type: + description: The string "Application" type: string - entityMetaDataAsProperties: - additionalProperties: - type: string - type: object - description: A Key-Value map of metadata about this shared flow revision. - GoogleCloudApigeeV1Datastore: - description: >- - The data store defines the connection to export data repository (Cloud - Storage, BigQuery), including the credentials used to access the data - repository. + GoogleCloudApigeeV1Organization: + type: object properties: - datastoreConfig: - description: Datastore Configurations. - $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' - lastUpdateTime: - readOnly: true + createdAt: description: >- - Output only. Datastore last update time, in milliseconds since the - epoch of 1970-01-01T00:00:00Z - type: string + Output only. Time that the Apigee organization was created in + milliseconds since epoch. + readOnly: true format: int64 - org: type: string - description: Output only. Organization that the datastore belongs to - readOnly: true - displayName: - description: Required. Display name in UI + runtimeDatabaseEncryptionKeyName: + description: >- + Cloud KMS key name used for encrypting the data that is stored and + replicated across runtime instances. Update is not allowed after the + organization is created. If not specified or + [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption + key will be used. For example: + "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** + Not supported for Apigee hybrid. type: string - self: + addonsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + description: Addon configurations of the Apigee organization. + caCertificate: readOnly: true type: string description: >- - Output only. Resource link of Datastore. Example: - `/organizations/{org}/analytics/datastores/{uuid}` - targetType: - type: string - description: Destination storage type. Supported types `gcs` or `bigquery`. - createTime: - type: string - format: int64 + Output only. Base64-encoded public certificate for the root CA of + the Apigee organization. Valid only when [RuntimeType](#RuntimeType) + is `CLOUD`. + format: byte + apiConsumerDataLocation: description: >- - Output only. Datastore create time, in milliseconds since the epoch - of 1970-01-01T00:00:00Z + This field is needed only for customers using non-default data + residency regions. Apigee stores some control plane data only in + single region. This field determines which single region Apigee + should use. For example: "us-west1" when control plane is in US or + "europe-west2" when control plane is in EU. + type: string + portalDisabled: + type: boolean + description: Configuration for the Portals settings. + lastModifiedAt: readOnly: true - type: object - id: GoogleCloudApigeeV1Datastore - GoogleCloudApigeeV1KeyValueEntry: - id: GoogleCloudApigeeV1KeyValueEntry - properties: - value: - description: >- - Required. Data or payload that is being retrieved and associated - with the unique key. type: string - name: description: >- - Resource URI that can be used to identify the scope of the key value - map entries. - type: string - description: >- - Key value map pair where the value represents the data associated with - the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and - higher. - type: object - GoogleCloudApigeeV1SecurityReportResultView: - id: GoogleCloudApigeeV1SecurityReportResultView - type: object - description: The response for security report result view APIs. - properties: - error: - description: Error message when there is a failure. + Output only. Time that the Apigee organization was last modified in + milliseconds since epoch. + format: int64 + expiresAt: type: string - rows: - type: array + format: int64 description: >- - Rows of security report result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - items: - type: any - code: - description: Error code when there is a failure. - format: int32 - type: integer - state: - description: State of retrieving ResultView. + Output only. Time that the Apigee organization is scheduled for + deletion. + readOnly: true + analyticsRegion: type: string - metadata: description: >- - Metadata contains information like metrics, dimenstions etc of the - security report. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' - GoogleCloudApigeeV1AsyncQueryResult: - properties: - expires: - type: string - description: Query result will be unaccessable after this time. - self: + Required. DEPRECATED: This field will eventually be deprecated and + replaced with a differently-named field. Primary Google Cloud region + for analytics data storage. For valid values, see [Create an Apigee + organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + deprecated: true + projectId: + description: Output only. Project ID associated with the Apigee organization. type: string + readOnly: true + apiConsumerDataEncryptionKeyName: description: >- - Self link of the query results. Example: - `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - or following format if query is running at host level: - `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - id: GoogleCloudApigeeV1AsyncQueryResult - type: object - GoogleCloudApigeeV1RatePlan: - properties: - consumptionPricingRates: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' - type: array - description: >- - API call volume ranges and the fees charged when the total number of - API calls is within a given range. The method used to calculate the - final fee depends on the selected pricing model. For example, if the - pricing model is `STAIRSTEP` and the ranges are defined as follows: - ``` { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": - 200, "fee": 100 }, } ``` Then the following fees would be charged - based on the total number of API calls (assuming the currency - selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 - calls cost $100 The number of API calls cannot exceed 200. - billingPeriod: - description: Frequency at which the customer will be billed. - enumDescriptions: - - Billing period not specified. - - >- - Weekly billing period. **Note**: Not supported by Apigee at this - time. - - Monthly billing period. + Cloud KMS key name used for encrypting API consumer data. If not + specified or [BillingType](#BillingType) is `EVALUATION`, a + Google-Managed encryption key will be used. Format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*` type: string + billingType: + enumDescriptions: + - Billing type not specified. + - A pre-paid subscription to Apigee. + - Free and limited access to Apigee for evaluation purposes only. + - Access to Apigee using a Pay-As-You-Go plan. enum: - - BILLING_PERIOD_UNSPECIFIED - - WEEKLY - - MONTHLY - revenueShareRates: - description: Details of the revenue sharing model. + - BILLING_TYPE_UNSPECIFIED + - SUBSCRIPTION + - EVALUATION + - PAYG + type: string + description: >- + Billing type of the Apigee organization. See [Apigee + pricing](https://cloud.google.com/apigee/pricing). + disableVpcPeering: + type: boolean + description: >- + Optional. Flag that specifies whether the VPC Peering through + Private Google Access should be disabled between the consumer + network and Apigee. Valid only when RuntimeType is set to CLOUD. + Required if an authorizedNetwork on the consumer project is not + provided, in which case the flag should be set to true. The value + must be set before the creation of any Apigee runtime instance and + can be updated only when there are no runtime instances. **Note:** + Apigee will be deprecating the vpc peering model that requires you + to provide 'authorizedNetwork', by making the non-peering model as + the default way of provisioning Apigee organization in future. So, + this will be a temporary flag to enable the transition. Not + supported for Apigee hybrid. + properties: + description: Properties defined in the Apigee organization profile. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + attributes: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' + type: string + description: Not used by Apigee. type: array - fixedRecurringFee: - $ref: '#/components/schemas/GoogleTypeMoney' + apigeeProjectId: + readOnly: true description: >- - Fixed amount that is charged at a defined interval and billed in - advance of use of the API product. The fee will be prorated for the - first billing period. - state: - description: Current state of the rate plan (draft or published). - enumDescriptions: - - State of the rate plan is not specified. - - Rate plan is in draft mode and only visible to API providers. - - >- - Rate plan is published and will become visible to developers for - the configured duration (between `startTime` and `endTime`). + Output only. Apigee Project ID associated with the organization. Use + this project to allowlist Apigee in the Service Attachment when + using private service connect with Apigee. + type: string + runtimeType: enum: - - STATE_UNSPECIFIED - - DRAFT - - PUBLISHED + - RUNTIME_TYPE_UNSPECIFIED + - CLOUD + - HYBRID + enumDescriptions: + - Runtime type not specified. + - Google-managed Apigee runtime. + - User-managed Apigee hybrid runtime. type: string - revenueShareType: + description: >- + Required. Runtime type of the Apigee organization based on the + Apigee subscription purchased. + authorizedNetwork: + description: >- + Compute Engine network used for Service Networking to be peered with + Apigee runtime instances. See [Getting started with the Service + Networking + API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). + Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The + value must be set before the creation of a runtime instance and can + be updated only when there are no runtime instances. For example: + `default`. Apigee also supports shared VPC (that is, the host + network project is not the same as the one that is peering with + Apigee). See [Shared VPC + overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a + shared VPC network, use the following format: + `projects/{host-project-id}/{region}/networks/{network-name}`. For + example: `projects/my-sharedvpc-host/global/networks/mynetwork` + **Note:** Not supported for Apigee hybrid. type: string + type: + description: Not used by Apigee. enum: - - REVENUE_SHARE_TYPE_UNSPECIFIED - - FIXED - - VOLUME_BANDED + - TYPE_UNSPECIFIED + - TYPE_TRIAL + - TYPE_PAID + - TYPE_INTERNAL + type: string enumDescriptions: - - Revenue share type is not specified. + - Subscription type not specified. - >- - Fixed percentage of the total revenue will be shared. The - percentage to be shared can be configured by the API provider. + Subscription to Apigee is free, limited, and used for evaluation + purposes only. - >- - Amount of revenue shared depends on the number of API calls. The - API call volume ranges and the revenue share percentage for each - volume can be configured by the API provider. **Note**: Not - supported by Apigee at this time. - description: Method used to calculate the revenue that is shared with developers. - consumptionPricingType: - description: Pricing model used for consumption-based charges. - enum: - - CONSUMPTION_PRICING_TYPE_UNSPECIFIED - - FIXED_PER_UNIT - - BANDED - - TIERED - - STAIRSTEP - type: string + Full subscription to Apigee has been purchased. See [Apigee + pricing](https://cloud.google.com/apigee/pricing/). + - For internal users only. + environments: + type: array + items: + type: string + readOnly: true + description: Output only. List of environments in the Apigee organization. + subscriptionPlan: enumDescriptions: - - Pricing model not specified. This is the default. - - Fixed rate charged for each API call. + - Subscription plan not specified. + - Traditional subscription plan. - >- - Variable rate charged for each API call based on price tiers. - Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 - per call * 201-300 calls cost $1 per call * Total price for 50 - calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x - $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + - 50 x $1 = $400. **Note**: Not supported by Apigee at this time. - - '**Note**: Not supported by Apigee at this time.' - - '**Note**: Not supported by Apigee at this time.' - currencyCode: - description: >- - Currency to be used for billing. Consists of a three-letter code as - defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) - standard. - type: string - startTime: - type: string - description: Time when the rate plan becomes active in milliseconds since epoch. - format: int64 - name: - description: Output only. Name of the rate plan. - readOnly: true + New subscription plan that provides standard proxy and scaled + proxy implementation. type: string - setupFee: - description: Initial, one-time fee paid when purchasing the API product. - $ref: '#/components/schemas/GoogleTypeMoney' - lastModifiedAt: - format: int64 + description: >- + Output only. Subscription plan that the customer has purchased. + Output only. readOnly: true + enum: + - SUBSCRIPTION_PLAN_UNSPECIFIED + - SUBSCRIPTION_2021 + - SUBSCRIPTION_2024 + state: description: >- - Output only. Time the rate plan was last modified in milliseconds - since epoch. - type: string - createdAt: - format: int64 + Output only. State of the organization. Values other than ACTIVE + means the resource is not ready to use. type: string + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING readOnly: true - description: >- - Output only. Time that the rate plan was created in milliseconds - since epoch. displayName: - description: Display name of the rate plan. type: string - apiproduct: + description: >- + Display name for the Apigee organization. Unused, but reserved for + future use. + customerName: + description: Not used by Apigee. type: string - description: Name of the API product that the rate plan is associated with. description: - description: Description of the rate plan. + description: Description of the Apigee organization. type: string - endTime: - format: int64 + controlPlaneEncryptionKeyName: type: string description: >- - Time when the rate plan will expire in milliseconds since epoch. Set - to 0 or `null` to indicate that the rate plan should never expire. - fixedFeeFrequency: - type: integer - format: int32 - description: Frequency at which the fixed fee is charged. - paymentFundingModel: + Cloud KMS key name used for encrypting control plane data that is + stored in a multi region. Only used for the data residency region + "US" or "EU". If not specified or [BillingType](#BillingType) is + `EVALUATION`, a Google-Managed encryption key will be used. Format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*` + name: + description: Output only. Name of the Apigee organization. + type: string + readOnly: true + subscriptionType: + type: string enum: - - PAYMENT_FUNDING_MODEL_UNSPECIFIED - - PREPAID - - POSTPAID + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAID + - TRIAL + readOnly: true deprecated: true - type: string enumDescriptions: - - Billing account type not specified. - - >- - Prepaid billing account type. Developer pays in advance for the - use of your API products. Funds are deducted from their prepaid - account balance. **Note**: Not supported by Apigee at this time. + - Subscription type not specified. + - Full subscription to Apigee has been purchased. - >- - Postpaid billing account type. Developer is billed through an - invoice after using your API products. - description: >- - DEPRECATED: This field is no longer supported and will eventually be - removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, - use the `billingType` field inside `DeveloperMonetizationConfig` - resource. Flag that specifies the billing account type, prepaid or - postpaid. - id: GoogleCloudApigeeV1RatePlan - description: Rate plan details. + Subscription to Apigee is free, limited, and used for evaluation + purposes only. + description: >- + Output only. DEPRECATED: This will eventually be replaced by + BillingType. Subscription type of the Apigee organization. Valid + values include trial (free, limited, and for evaluation purposes + only) or paid (full subscription has been purchased). See [Apigee + pricing](https://cloud.google.com/apigee/pricing/). + id: GoogleCloudApigeeV1Organization + GoogleCloudApigeeV1Attribute: + properties: + name: + type: string + description: API key of the attribute. + value: + description: Value of the attribute. + type: string + description: Key-value pair to store extra metadata. type: object + id: GoogleCloudApigeeV1Attribute GoogleCloudApigeeV1ListDatastoresResponse: description: The response for ListDatastores - type: object id: GoogleCloudApigeeV1ListDatastoresResponse properties: datastores: description: A list of datastores + type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' - type: array - GoogleCloudApigeeV1DateRange: - description: Date range of the data to export. - id: GoogleCloudApigeeV1DateRange - type: object - properties: - end: - description: >- - Required. End date (exclusive) of the data to export in the format - `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- - which will not be in the output. - type: string - start: - type: string - description: >- - Required. Start date of the data to export in the format - `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start - date. - GoogleCloudApigeeV1SecurityReportQueryMetric: type: object - id: GoogleCloudApigeeV1SecurityReportQueryMetric - description: Metric of the Query + GoogleCloudApigeeV1ScoreComponent: properties: - operator: + calculateTime: type: string - description: One of `+`, `-`, `/`, `%`, `*`. - alias: + description: Time when score was calculated. + format: google-datetime + dataCaptureTime: type: string description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. - name: - type: string - description: Required. Metric name. - aggregationFunction: - type: string - description: 'Aggregation function: avg, min, max, or sum.' - value: - type: string - description: Operand value should be provided when operator is set. - EdgeConfigstoreBundleBadBundleViolation: - description: A message type used to describe a single bundle validation error. - type: object - properties: - description: - type: string - description: A description of why the bundle is invalid and how to fix it. - filename: + Time in the requested time period when data was last captured to + compute the score. + format: google-datetime + score: + description: Score for the component. + format: int32 + type: integer + recommendations: + type: array + description: List of recommendations to improve API security. + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation + scorePath: type: string description: >- - The filename (including relative path from the bundle root) in which - the error occurred. - id: EdgeConfigstoreBundleBadBundleViolation - GoogleCloudApigeeV1Properties: - properties: - property: - description: List of all properties in the object + Path of the component. Example: + /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy + drilldownPaths: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + type: string + description: List of paths for next components. type: object - description: >- - Message for compatibility with legacy Edge specification for Java - Properties object in JSON. - id: GoogleCloudApigeeV1Properties - GoogleCloudApigeeV1OptimizedStatsNode: + id: GoogleCloudApigeeV1ScoreComponent + description: Component is an individual security element that is scored. + GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: properties: - data: - type: array + scores: items: - type: any - id: GoogleCloudApigeeV1OptimizedStatsNode - type: object - description: >- - Encapsulates a data node as represented below: ``` { "identifier": { - "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": - "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` - { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` - Depending on whether a dimension is present in the query or not the data - node type can be a simple metric value or dimension identifier with list - of metrics. - GoogleCloudApigeeV1SetAddonsRequest: - id: GoogleCloudApigeeV1SetAddonsRequest - description: Request for SetAddons. - type: object - properties: - addonsConfig: - description: Required. Add-on configurations. - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - GoogleCloudApigeeV1AddonsConfig: - type: object - description: Add-on configurations for the Apigee organization. - id: GoogleCloudApigeeV1AddonsConfig - properties: - analyticsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Score' + description: List of scores. One score per day. + type: array + nextPageToken: description: >- - Configuration for the Analytics add-on. Only used in - organizations.environments.addonsConfig. - integrationConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' - description: Configuration for the Integration add-on. - advancedApiOpsConfig: - description: Configuration for the Advanced API Ops add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' - monetizationConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' - description: Configuration for the Monetization add-on. - connectorsPlatformConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' - description: Configuration for the Connectors Platform add-on. - apiSecurityConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' - description: Configuration for the API Security add-on. - GoogleCloudApigeeV1ListApiDocsResponse: + A page token, received from a previous `ComputeScore` call. Provide + this to retrieve the subsequent page. + type: string + description: Response for ComputeEnvironmentScores. + type: object + id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + GoogleCloudApigeeV1ListInstanceAttachmentsResponse: + description: Response for ListInstanceAttachments. type: object + id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse properties: - message: - type: string - description: Description of the operation. - status: - type: string - description: Status of the operation. - data: + attachments: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + description: Attachments for the instance. type: array - description: The catalog item resources. - requestId: - type: string - description: Unique ID of the request. - errorCode: - type: string - description: Unique error code for the request, if any. 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 - id: GoogleCloudApigeeV1ListApiDocsResponse - GoogleCloudApigeeV1Instance: - description: Apigee runtime instance. - id: GoogleCloudApigeeV1Instance + description: >- + Page token that you can include in a ListInstanceAttachments request + to retrieve the next page of content. If omitted, no subsequent + pages exist. + GoogleCloudApigeeV1RuntimeApiSecurityConfig: type: object + description: Runtime configuration for the API Security add-on. + id: GoogleCloudApigeeV1RuntimeApiSecurityConfig properties: - serviceAttachment: - readOnly: true - type: string - description: >- - Output only. Resource name of the service attachment created for the - instance in the format: `projects/*/regions/*/serviceAttachments/*` - Apigee customers can privately forward traffic to this service - attachment using the PSC endpoints. - runtimeVersion: - description: >- - Output only. Version of the runtime system running in the instance. - The runtime system is the set of components that serve the API Proxy - traffic in your Environments. - type: string - readOnly: true - accessLoggingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessLoggingConfig' - description: >- - Optional. Access logging configuration enables the access logging - feature at the instance. Apigee customers can enable access logging - to ship the access logs to their own project's cloud logging. - ipRange: - type: string - description: >- - Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 - used to create the Apigee instance. Providing CIDR ranges is - optional. You can provide just /22 or /28 or both (or neither). - Ranges you provide should be freely available as part of a larger - named range you have allocated to the Service Networking peering. If - this parameter is not provided, Apigee automatically requests an - available /22 and /28 CIDR block from Service Networking. Use the - /22 CIDR block for configuring your firewall needs to allow traffic - from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or - `a.b.c.d/22,e.f.g.h/28` - host: - readOnly: true + enabled: + type: boolean + description: If the API Security is enabled or not. + GoogleCloudApigeeV1EnvironmentGroupConfig: + properties: + hostnames: + description: Host names for the environment group. + type: array + items: + type: string + endpointChainingRules: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' + description: A list of proxies in each deployment group for proxy chaining calls. + type: array + routingRules: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' description: >- - Output only. Internal hostname or IP address of the Apigee endpoint - used by clients to connect to the service. - type: string - lastModifiedAt: - format: int64 - readOnly: true + Ordered list of routing rules defining how traffic to this + environment group's hostnames should be routed to different + environments. + revisionId: description: >- - Output only. Time the instance was last modified in milliseconds - since epoch. + Revision id that defines the ordering of the EnvironmentGroupConfig + resource. The higher the revision, the more recently the + configuration was deployed. + format: int64 type: string name: type: string description: >- - Required. Resource ID of the instance. Values must match the regular - expression `^a-z{0,30}[a-z\d]$`. - displayName: + Name of the environment group in the following format: + `organizations/{org}/envgroups/{envgroup}`. + location: + description: >- + When this message appears in the top-level IngressConfig, this field + will be populated in lieu of the inlined routing_rules and hostnames + fields. Some URL for downloading the full EnvironmentGroupConfig for + this group. type: string - description: Optional. Display name for the instance. - description: + uid: + description: >- + A unique id for the environment group config that will only change + if the environment group is deleted and recreated. type: string - description: Optional. Description of the instance. - location: + id: GoogleCloudApigeeV1EnvironmentGroupConfig + description: >- + EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup + and its associated routing rules. + type: object + GoogleCloudApigeeV1ListDeveloperAppsResponse: + id: GoogleCloudApigeeV1ListDeveloperAppsResponse + properties: + app: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + description: List of developer apps and their credentials. + type: array + type: object + GoogleCloudApigeeV1GraphQLOperation: + id: GoogleCloudApigeeV1GraphQLOperation + description: >- + Represents the pairing of GraphQL operation types and the GraphQL + operation name. + type: object + properties: + operationTypes: + items: + type: string + type: array + description: >- + Required. GraphQL operation types. Valid values include `query` or + `mutation`. **Note**: Apigee does not currently support + `subscription` types. + operation: type: string - description: Required. Compute Engine location where the instance resides. - peeringCidrRange: - enum: - - CIDR_RANGE_UNSPECIFIED - - SLASH_16 - - SLASH_17 - - SLASH_18 - - SLASH_19 - - SLASH_20 - - SLASH_22 - - SLASH_23 - enumDescriptions: - - Range not specified. - - '`/16` CIDR range.' - - '`/17` CIDR range.' - - '`/18` CIDR range.' - - '`/19` CIDR range.' - - '`/20` CIDR range.' - - '`/22` CIDR range. Supported for evaluation only.' - - '`/23` CIDR range. Supported for evaluation only.' - deprecated: true description: >- - Optional. Size of the CIDR block range that will be reserved by the - instance. PAID organizations support `SLASH_16` to `SLASH_20` and - defaults to `SLASH_16`. Evaluation organizations support only - `SLASH_23`. + GraphQL operation name. The name and operation type will be used to + apply quotas. If no name is specified, the quota will be applied to + all GraphQL operations irrespective of their operation names in the + payload. + GoogleCloudApigeeV1DatastoreConfig: + id: GoogleCloudApigeeV1DatastoreConfig + type: object + description: Configuration detail for datastore + properties: + path: + description: Path of Cloud Storage bucket Required for `gcs` target_type. type: string - port: - readOnly: true + bucketName: + description: Name of the Cloud Storage bucket. Required for `gcs` target_type. type: string - description: Output only. Port number of the exposed Apigee endpoint. - diskEncryptionKeyName: + tablePrefix: + type: string + description: Prefix of BigQuery table Required for `bigquery` target_type. + projectId: type: string + description: Required. GCP project in which the datastore exists + datasetName: + type: string + description: BigQuery dataset name Required for `bigquery` target_type. + GoogleCloudApigeeV1ListKeyValueEntriesResponse: + id: GoogleCloudApigeeV1ListKeyValueEntriesResponse + properties: + nextPageToken: description: >- - Customer Managed Encryption Key (CMEK) used for disk and volume - encryption. If not specified, a Google-Managed encryption key will - be used. Use the following format: - `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` - state: - readOnly: true + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + keyValueEntries: + description: One or more key value map keys and values. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + type: object + description: >- + The request structure for listing key value map keys and its + corresponding values. + GoogleCloudApigeeV1ApiProxyRevision: + properties: + name: + description: Name of the API proxy. type: string + targetEndpoints: description: >- - Output only. State of the instance. Values other than `ACTIVE` means - the resource is not ready to use. - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - consumerAcceptList: + List of TargetEndpoints in the `/targets` directory of the API + proxy. Typically, this element is included only when the API proxy + was created using the Edge UI. This is a 'manifest' setting designed + to provide visibility into the contents of the API proxy. type: array + items: + type: string + targetServers: description: >- - Optional. Customer accept list represents the list of projects - (id/number) on customer side that can privately connect to the - service attachment. It is an optional field which the customers can - provide during the instance creation. By default, the customer - project associated with the Apigee organization will be included to - the list. + List of TargetServers referenced in any TargetEndpoint in the API + proxy. Typically, you will see this element only when the API proxy + was created using the Edge UI. This is a 'manifest' setting designed + to provide visibility into the contents of the API proxy. items: type: string - createdAt: + type: array + contextInfo: type: string + description: Revision number, app name, and organization for the API proxy. + type: description: >- - Output only. Time the instance was created in milliseconds since - epoch. - format: int64 - readOnly: true - GoogleCloudApigeeV1ConnectorsPlatformConfig: - id: GoogleCloudApigeeV1ConnectorsPlatformConfig - type: object - properties: - expiresAt: - description: >- - Output only. Time at which the Connectors Platform add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. - format: int64 - readOnly: true + Type. Set to `Application`. Maintained for compatibility with the + Apigee Edge API. type: string - enabled: + resources: + items: + type: string + type: array description: >- - Flag that specifies whether the Connectors Platform add-on is - enabled. - type: boolean - description: Configuration for the Connectors Platform add-on. - GoogleCloudApigeeV1EnvironmentGroup: - description: >- - EnvironmentGroup configuration. An environment group is used to group - one or more Apigee environments under a single host name. - properties: - lastModifiedAt: - type: string + List of the resources included in the API proxy revision formatted + as "{type}://{name}". + archive: description: >- - Output only. The time at which the environment group was last - updated as milliseconds since epoch. - format: int64 - readOnly: true - state: - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING + Output only. The archive that generated this proxy revision. This + field is only present on proxy revisions that were generated by an + archive. Proxies generated by archives cannot be updated, deleted, + or deployed to other environments. Format: + `organizations/*/environments/*/archiveDeployments/*` type: string readOnly: true - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. + sharedFlows: + items: + type: string + type: array + description: List of the shared flows included in the API proxy revision. + proxyEndpoints: + items: + type: string + type: array description: >- - Output only. State of the environment group. Values other than - ACTIVE means the resource is not ready to use. - name: - description: ID of the environment group. + List of ProxyEndpoints in the `/proxies` directory of the API proxy. + Typically, this element is included only when the API proxy was + created using the Edge UI. This is a 'manifest' setting designed to + provide visibility into the contents of the API proxy. + revision: + description: API proxy revision. type: string - hostnames: + entityMetaDataAsProperties: + description: Metadata describing the API proxy revision as a key-value map. + type: object + additionalProperties: + type: string + configurationVersion: + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' + description: >- + Version of the API proxy configuration schema to which the API proxy + conforms. Currently, the only supported value is 4.0 + (`majorVersion.minorVersion`). This setting may be used in the + future to track the evolution of the API proxy format. + targets: + description: List of the targets included in the API proxy revision. + items: + type: string type: array + basepaths: + description: Base URL of the API proxy. items: type: string - description: Required. Host names for this environment group. - createdAt: - readOnly: true + type: array + lastModifiedAt: format: int64 - description: >- - Output only. The time at which the environment group was created as - milliseconds since epoch. - type: string - id: GoogleCloudApigeeV1EnvironmentGroup - type: object - GoogleCloudApigeeV1SharedFlow: - properties: - name: - type: string - description: The ID of the shared flow. - latestRevisionId: type: string - description: The id of the most recently created revision for this shared flow. - metaData: - description: Metadata describing the shared flow. - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - revision: + description: >- + Time that the API proxy revision was last modified in milliseconds + since epoch. + policies: type: array - description: A list of revisions of this shared flow. items: type: string - id: GoogleCloudApigeeV1SharedFlow - type: object - description: The metadata describing a shared flow - GoogleCloudApigeeV1EndpointChainingRule: - properties: - deploymentGroup: + description: List of policy names included in the API proxy revision.. + integrationEndpoints: description: >- - The deployment group to target for cross-shard chaining calls to - these proxies. + List of IntegrationEndpoints in the '/integration-endpoints' + directory of the API proxy. This is a 'manifest' setting designed to + provide visibility into the contents of the API proxy. + type: array + items: + type: string + displayName: + description: Human-readable name of the API proxy. type: string - proxyIds: - description: List of proxy ids which may be found in the given deployment group. + description: + type: string + description: Description of the API proxy revision. + resourceFiles: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + description: List of resource files included in the API proxy revision. + hasExtensiblePolicy: + readOnly: true + type: boolean + description: >- + Output only. This field will be marked as true if revision contains + any policies marked as extensible. + teams: type: array items: type: string - id: GoogleCloudApigeeV1EndpointChainingRule - description: >- - EndpointChainingRule specifies the proxies contained in a particular - deployment group, so that other deployment groups can find them in - chaining calls. + description: List of the teams included in the API proxy revision. + proxies: + items: + type: string + description: List of proxy names included in the API proxy revision. + type: array + spec: + description: >- + OpenAPI Specification that is associated with the API proxy. The + value is set to a URL or to a path in the specification store. + type: string + createdAt: + format: int64 + type: string + description: >- + Time that the API proxy revision was created in milliseconds since + epoch. + id: GoogleCloudApigeeV1ApiProxyRevision + description: API proxy revision. type: object - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: + GoogleCloudApigeeV1UpdateError: + id: GoogleCloudApigeeV1UpdateError type: object - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute - description: Route deployed in the ingress routing table. properties: - percentage: - description: Percentage of ingress replicas reporting this route. - format: int32 - type: integer - envgroup: + resource: + description: >- + The sub resource specific to this error (e.g. a proxy deployed + within the EnvironmentConfig). If empty the error refers to the top + level resource. type: string - description: Environment group where this route is installed. - basepath: + message: + description: User-friendly error message. type: string - description: Base path in the routing table. - environment: + type: type: string description: >- - Destination environment. This will be empty if the route is not yet - reported. - GoogleCloudApigeeV1AsyncQueryResultView: + A string that uniquely identifies the type of error. This provides a + more reliable means to deduplicate errors across revisions and + instances. + code: + enumDescriptions: + - 'Not an error; returned on success. HTTP Mapping: 200 OK' + - >- + The operation was cancelled, typically by the caller. HTTP + Mapping: 499 Client Closed Request + - >- + Unknown error. For example, this error may be returned when a + `Status` value received from another address space belongs to an + error space that is not known in this address space. Also errors + raised by APIs that do not return enough error information may be + converted to this error. HTTP Mapping: 500 Internal Server Error + - >- + The client specified an invalid argument. Note that this differs + from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments + that are problematic regardless of the state of the system (e.g., + a malformed file name). HTTP Mapping: 400 Bad Request + - >- + The deadline expired before the operation could complete. For + operations that change the state of the system, this error may be + returned even if the operation has completed successfully. For + example, a successful response from a server could have been + delayed long enough for the deadline to expire. HTTP Mapping: 504 + Gateway Timeout + - >- + Some requested entity (e.g., file or directory) was not found. + Note to server developers: if a request is denied for an entire + class of users, such as gradual feature rollout or undocumented + allowlist, `NOT_FOUND` may be used. If a request is denied for + some users within a class of users, such as user-based access + control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not + Found + - >- + The entity that a client attempted to create (e.g., file or + directory) already exists. HTTP Mapping: 409 Conflict + - >- + The caller does not have permission to execute the specified + operation. `PERMISSION_DENIED` must not be used for rejections + caused by exhausting some resource (use `RESOURCE_EXHAUSTED` + instead for those errors). `PERMISSION_DENIED` must not be used if + the caller can not be identified (use `UNAUTHENTICATED` instead + for those errors). This error code does not imply the request is + valid or the requested entity exists or satisfies other + pre-conditions. HTTP Mapping: 403 Forbidden + - >- + The request does not have valid authentication credentials for the + operation. HTTP Mapping: 401 Unauthorized + - >- + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. HTTP Mapping: 429 + Too Many Requests + - >- + The operation was rejected because the system is not in a state + required for the operation's execution. For example, the directory + to be deleted is non-empty, an rmdir operation is applied to a + non-directory, etc. Service implementors can use the following + guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and + `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just + the failing call. (b) Use `ABORTED` if the client should retry at + a higher level. For example, when a client-specified test-and-set + fails, indicating the client should restart a read-modify-write + sequence. (c) Use `FAILED_PRECONDITION` if the client should not + retry until the system state has been explicitly fixed. For + example, if an "rmdir" fails because the directory is non-empty, + `FAILED_PRECONDITION` should be returned since the client should + not retry unless the files are deleted from the directory. HTTP + Mapping: 400 Bad Request + - >- + The operation was aborted, typically due to a concurrency issue + such as a sequencer check failure or transaction abort. See the + guidelines above for deciding between `FAILED_PRECONDITION`, + `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + - >- + The operation was attempted past the valid range. E.g., seeking or + reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error + indicates a problem that may be fixed if the system state changes. + For example, a 32-bit file system will generate `INVALID_ARGUMENT` + if asked to read at an offset that is not in the range [0,2^32-1], + but it will generate `OUT_OF_RANGE` if asked to read from an + offset past the current file size. There is a fair bit of overlap + between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend + using `OUT_OF_RANGE` (the more specific error) when it applies so + that callers who are iterating through a space can easily look for + an `OUT_OF_RANGE` error to detect when they are done. HTTP + Mapping: 400 Bad Request + - >- + The operation is not implemented or is not supported/enabled in + this service. HTTP Mapping: 501 Not Implemented + - >- + Internal errors. This means that some invariants expected by the + underlying system have been broken. This error code is reserved + for serious errors. HTTP Mapping: 500 Internal Server Error + - >- + The service is currently unavailable. This is most likely a + transient condition, which can be corrected by retrying with a + backoff. Note that it is not always safe to retry non-idempotent + operations. See the guidelines above for deciding between + `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: + 503 Service Unavailable + - >- + Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal + Server Error + type: string + description: Status code. + enum: + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS + description: Details on why a resource update failed in the runtime. + GoogleCloudApigeeV1ListHybridIssuersResponse: + properties: + issuers: + type: array + description: Lists of hybrid services and its trusted issuer email ids. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' + type: object + id: GoogleCloudApigeeV1ListHybridIssuersResponse + GoogleCloudApigeeV1RuntimeTraceConfigOverride: + description: >- + NEXT ID: 7 Trace configuration override for a specific API proxy in an + environment. properties: - rows: - type: array + revisionId: description: >- - Rows of query result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - items: - type: any - code: - description: Error code when there is a failure. - format: int32 - type: integer - state: - description: State of retrieving ResultView. + Revision number which can be used by the runtime to detect if the + trace config override has changed between two versions. type: string - error: - description: Error message when there is a failure. + apiProxy: type: string - metadata: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' description: >- - Metadata contains information like metrics, dimenstions etc of the - AsyncQuery. - id: GoogleCloudApigeeV1AsyncQueryResultView - type: object - GoogleCloudApigeeV1RuntimeAddonsConfig: - type: object - properties: + Name of the API proxy that will have its trace configuration + overridden following format: `organizations/{org}/apis/{api}` uid: type: string description: >- - UID is to detect if config is recreated after deletion. The add-on - config will only be deleted when the environment itself gets - deleted, thus it will always be the same as the UID of - EnvironmentConfig. - apiSecurityConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' - description: Runtime configuration for API Security add-on. + Unique ID for the configuration override. The ID will only change if + the override is deleted and recreated. Corresponds to name's + "override" field. name: - type: string description: >- - Name of the addons config in the format: - `organizations/{org}/environments/{env}/addonsConfig` - revisionId: + Name of the trace config override in the following format: + `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` type: string - description: Revision number used by the runtime to detect config changes. - analyticsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' - description: Runtime configuration for Analytics add-on. - description: >- - RuntimeAddonsConfig defines the runtime configurations for add-ons in an - environment. - id: GoogleCloudApigeeV1RuntimeAddonsConfig + revisionCreateTime: + type: string + description: The timestamp that the revision was created or updated. + format: google-datetime + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + description: >- + Trace configuration override for a specific API proxy in an + environment. + id: GoogleCloudApigeeV1RuntimeTraceConfigOverride + type: object + GoogleCloudApigeeV1ListSharedFlowsResponse: + id: GoogleCloudApigeeV1ListSharedFlowsResponse + type: object + properties: + sharedFlows: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + type: array GoogleCloudApigeeV1CertInfo: - description: X.509 certificate as defined in RFC 5280. + id: GoogleCloudApigeeV1CertInfo + type: object properties: - issuer: + isValid: + type: string + description: >- + Flag that specifies whether the certificate is valid. Flag is set to + `Yes` if the certificate is valid, `No` if expired, or `Not yet` if + not yet valid. + sigAlgName: + description: X.509 signatureAlgorithm. type: string - description: X.509 issuer. version: - description: X.509 version. type: integer format: int32 - validFrom: - format: int64 + description: X.509 version. + subject: + description: X.509 subject. type: string - description: X.509 `notBefore` validity period in milliseconds since epoch. subjectAlternativeNames: - description: X.509 subject alternative names (SANs) extension. - type: array items: type: string - isValid: - type: string - description: >- - Flag that specifies whether the certificate is valid. Flag is set to - `Yes` if the certificate is valid, `No` if expired, or `Not yet` if - not yet valid. - serialNumber: - description: X.509 serial number. - type: string - expiryDate: + type: array + description: X.509 subject alternative names (SANs) extension. + validFrom: + description: X.509 `notBefore` validity period in milliseconds since epoch. type: string - description: X.509 `notAfter` validity period in milliseconds since epoch. format: int64 - sigAlgName: + issuer: + description: X.509 issuer. type: string - description: X.509 signatureAlgorithm. basicConstraints: - type: string description: X.509 basic constraints extension. + type: string publicKey: + type: string description: Public key component of the X.509 subject public key info. + expiryDate: type: string - subject: - description: X.509 subject. + description: X.509 `notAfter` validity period in milliseconds since epoch. + format: int64 + serialNumber: + description: X.509 serial number. type: string - id: GoogleCloudApigeeV1CertInfo - type: object - GoogleCloudApigeeV1EnvironmentGroupConfig: + description: X.509 certificate as defined in RFC 5280. + GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + description: Request for ComputeEnvironmentScores. properties: - endpointChainingRules: + pageToken: + description: >- + Optional. A token that can be sent as `page_token` to retrieve the + next page. If this field is omitted, there are no subsequent pages. + type: string + pageSize: + description: >- + Optional. The maximum number of subcomponents to be returned in a + single page. The service may return fewer than this value. If + unspecified, at most 100 subcomponents will be returned in a single + page. + type: integer + format: int32 + filters: + description: >- + Optional. Filters are used to filter scored components. Return all + the components if no filter is mentioned. Example: [{ "scorePath": + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + }, { "scorePath": + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", + }] This will return components with path: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + OR + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target" + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: >- + Required. Time range for score calculation. At most 14 days of + scores will be returned, and both the start and end dates must be + within the last 90 days. + type: object + GoogleCloudApigeeV1SecurityActionFlag: + type: object + id: GoogleCloudApigeeV1SecurityActionFlag + description: The message that should be set in the case of a Flag action. + properties: + headers: + description: >- + Optional. A list of HTTP headers to be sent to the target in case of + a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least + one is mandatory. type: array - description: A list of proxies in each deployment group for proxy chaining calls. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' + GoogleCloudApigeeV1ExportRequest: + description: Request body for [CreateExportRequest] + type: object + properties: + datastoreName: + type: string + description: Required. Name of the preconfigured datastore. + outputFormat: + description: >- + Optional. Output format of the export. Valid values include: `csv` + or `json`. Defaults to `json`. Note: Configure the delimiter for CSV + output using the `csvDelimiter` property. + type: string + dateRange: + description: Required. Date range of the data to export. + $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' + description: + description: Optional. Description of the export job. + type: string + csvDelimiter: + description: >- + Optional. Delimiter used in the CSV file, if `outputFormat` is set + to `csv`. Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + type: string + name: + type: string + description: Required. Display name of the export job. + id: GoogleCloudApigeeV1ExportRequest + GoogleCloudApigeeV1DataCollectorConfig: + properties: + type: + enumDescriptions: + - For future compatibility. + - For integer values. + - For float values. + - For string values. + - For boolean values. + - For datetime values. + description: Data type accepted by the data collector. + enum: + - TYPE_UNSPECIFIED + - INTEGER + - FLOAT + - STRING + - BOOLEAN + - DATETIME + type: string name: description: >- - Name of the environment group in the following format: - `organizations/{org}/envgroups/{envgroup}`. + Name of the data collector in the following format: + `organizations/{org}/datacollectors/{datacollector}` type: string - routingRules: + id: GoogleCloudApigeeV1DataCollectorConfig + description: Data collector and its configuration. + type: object + GoogleCloudApigeeV1ApiSecurityRuntimeConfig: + type: object + description: >- + Response for + GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. + properties: + revisionId: + format: int64 description: >- - Ordered list of routing rules defining how traffic to this - environment group's hostnames should be routed to different - environments. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' - location: + Revision ID of the API Security Runtime configuration. The higher + the value, the more recently the configuration was deployed. + type: string + name: description: >- - When this message appears in the top-level IngressConfig, this field - will be populated in lieu of the inlined routing_rules and hostnames - fields. Some URL for downloading the full EnvironmentGroupConfig for - this group. + Name of the environment API Security Runtime configuration resource. + Format: + `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` type: string - uid: + updateTime: + description: Time that the API Security Runtime configuration was updated. + format: google-datetime type: string + uid: description: >- - A unique id for the environment group config that will only change - if the environment group is deleted and recreated. - revisionId: + Unique ID for the API Security Runtime configuration. The ID will + only change if the environment is deleted and recreated. type: string - description: >- - Revision id that defines the ordering of the EnvironmentGroupConfig - resource. The higher the revision, the more recently the - configuration was deployed. - format: int64 - hostnames: - type: array + location: + description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. items: type: string - description: Host names for the environment group. - description: >- - EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup - and its associated routing rules. - id: GoogleCloudApigeeV1EnvironmentGroupConfig + type: array + id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig + GoogleCloudApigeeV1Session: type: object - GoogleCloudApigeeV1GraphQLOperationConfig: + id: GoogleCloudApigeeV1Session + description: Session carries the debug session id and its creation time. properties: - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + timestampMs: + type: string description: >- - Quota parameters to be enforced for the resources, methods, and API - source combination. If none are specified, quota enforcement will - not be done. - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: Custom attributes associated with the operation. - type: array - operations: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' + The first transaction creation timestamp in millisecond, recorded by + UAP. + format: int64 + id: + type: string + description: The debug session ID. + GoogleCloudApigeeV1CreditDeveloperBalanceRequest: + description: Request for CreditDeveloperBalance. + properties: + transactionId: + type: string description: >- - Required. List of GraphQL name/operation type pairs for the proxy or - remote service to which quota will be applied. If only operation - types are specified, the quota will be applied to all GraphQL - requests irrespective of the GraphQL name. **Note**: Currently, you - can specify only a single GraphQLOperation. Specifying more than one - will cause the operation to fail. - apiSource: + Each transaction_id uniquely identifies a credit balance request. If + multiple requests are received with the same transaction_id, only + one of them will be considered. + transactionAmount: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Required. Name of the API proxy endpoint or remote service with - which the GraphQL operation and quota are associated. - type: string - description: >- - Binds the resources in a proxy or remote service with the GraphQL - operation and its associated quota enforcement. - id: GoogleCloudApigeeV1GraphQLOperationConfig + The amount of money to be credited. The wallet corresponding to the + currency specified within `transaction_amount` will be updated. For + example, if you specified `currency_code` within + `transaction_amount` as "USD", then the amount would be added to the + wallet which has the "USD" currency or if no such wallet exists, a + new wallet will be created with the "USD" currency. + id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest type: object - GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: - id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + EdgeConfigstoreBundleBadBundleViolation: properties: - nextStartKey: + filename: type: string description: >- - Value that can be sent as `startKey` to retrieve the next page of - content. If this field is omitted, there are no subsequent pages. - developerSubscriptions: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' - description: List of all subscriptions. - type: array - description: Response for ListDeveloperSubscriptions. + The filename (including relative path from the bundle root) in which + the error occurred. + description: + description: A description of why the bundle is invalid and how to fix it. + type: string + description: A message type used to describe a single bundle validation error. + id: EdgeConfigstoreBundleBadBundleViolation type: object - GoogleCloudApigeeV1ListApiProductsResponse: + GoogleCloudApigeeV1InstanceAttachment: + description: >- + InstanceAttachment represents the installation of an environment onto an + instance. + id: GoogleCloudApigeeV1InstanceAttachment type: object properties: - apiProduct: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' - type: array - description: Lists all API product names defined for an organization. - id: GoogleCloudApigeeV1ListApiProductsResponse - GoogleCloudApigeeV1ApiSecurityConfig: - description: Configurations of the API Security add-on. + name: + type: string + readOnly: true + description: Output only. ID of the attachment. + createdAt: + description: >- + Output only. Time the attachment was created in milliseconds since + epoch. + type: string + format: int64 + readOnly: true + environment: + description: ID of the attached environment. + type: string + GoogleCloudApigeeV1ConnectorsPlatformConfig: properties: - enabled: - type: boolean - description: Flag that specifies whether the API security add-on is enabled. expiresAt: + readOnly: true + format: int64 + type: string description: >- - Output only. Time at which the API Security add-on expires in in + Output only. Time at which the Connectors Platform add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire. - type: string - readOnly: true - format: int64 + enabled: + description: >- + Flag that specifies whether the Connectors Platform add-on is + enabled. + type: boolean type: object - id: GoogleCloudApigeeV1ApiSecurityConfig - GoogleCloudApigeeV1DeveloperSubscription: + id: GoogleCloudApigeeV1ConnectorsPlatformConfig + description: Configuration for the Connectors Platform add-on. + GoogleCloudApigeeV1RatePlan: properties: - apiproduct: - type: string + endTime: description: >- - Name of the API product for which the developer is purchasing a - subscription. - lastModifiedAt: + Time when the rate plan will expire in milliseconds since epoch. Set + to 0 or `null` to indicate that the rate plan should never expire. + type: string format: int64 - description: >- - Output only. Time when the API product subscription was last - modified in milliseconds since epoch. + displayName: + description: Display name of the rate plan. + type: string + fixedFeeFrequency: + format: int32 + type: integer + description: Frequency at which the fixed fee is charged. + name: + description: Output only. Name of the rate plan. readOnly: true type: string + description: + description: Description of the rate plan. + type: string + currencyCode: + description: >- + Currency to be used for billing. Consists of a three-letter code as + defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) + standard. + type: string createdAt: type: string readOnly: true description: >- - Output only. Time when the API product subscription was created in - milliseconds since epoch. - format: int64 - startTime: + Output only. Time that the rate plan was created in milliseconds + since epoch. format: int64 - type: string + fixedRecurringFee: description: >- - Time when the API product subscription starts in milliseconds since - epoch. - name: + Fixed amount that is charged at a defined interval and billed in + advance of use of the API product. The fee will be prorated for the + first billing period. + $ref: '#/components/schemas/GoogleTypeMoney' + consumptionPricingRates: + type: array + description: >- + API call volume ranges and the fees charged when the total number of + API calls is within a given range. The method used to calculate the + final fee depends on the selected pricing model. For example, if the + pricing model is `STAIRSTEP` and the ranges are defined as follows: + ``` { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": + 200, "fee": 100 }, } ``` Then the following fees would be charged + based on the total number of API calls (assuming the currency + selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 + calls cost $100 The number of API calls cannot exceed 200. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' + state: type: string - description: Output only. Name of the API product subscription. + description: Current state of the rate plan (draft or published). + enumDescriptions: + - State of the rate plan is not specified. + - Rate plan is in draft mode and only visible to API providers. + - >- + Rate plan is published and will become visible to developers for + the configured duration (between `startTime` and `endTime`). + enum: + - STATE_UNSPECIFIED + - DRAFT + - PUBLISHED + revenueShareRates: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' + description: Details of the revenue sharing model. + lastModifiedAt: readOnly: true - endTime: - format: int64 description: >- - Time when the API product subscription ends in milliseconds since - epoch. + Output only. Time the rate plan was last modified in milliseconds + since epoch. type: string - type: object - id: GoogleCloudApigeeV1DeveloperSubscription - description: Structure of a DeveloperSubscription. - GoogleCloudApigeeV1SecurityIncident: - id: GoogleCloudApigeeV1SecurityIncident - type: object - properties: - observability: + format: int64 + paymentFundingModel: + description: >- + DEPRECATED: This field is no longer supported and will eventually be + removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, + use the `billingType` field inside `DeveloperMonetizationConfig` + resource. Flag that specifies the billing account type, prepaid or + postpaid. enum: - - OBSERVABILITY_UNSPECIFIED - - ACTIVE - - ARCHIVED + - PAYMENT_FUNDING_MODEL_UNSPECIFIED + - PREPAID + - POSTPAID type: string enumDescriptions: - - The incident observability is unspecified. + - Billing account type not specified. - >- - The incident is currently active. Can change to this status from - archived. + Prepaid billing account type. Developer pays in advance for the + use of your API products. Funds are deducted from their prepaid + account balance. **Note**: Not supported by Apigee at this time. - >- - The incident is currently archived and was archived by the - customer. - description: Optional. Indicates if the user archived this incident. - lastObservabilityChangeTime: - format: google-datetime - description: >- - Output only. The time when the incident observability was last - changed. - readOnly: true + Postpaid billing account type. Developer is billed through an + invoice after using your API products. + deprecated: true + startTime: + format: int64 type: string - displayName: + description: Time when the rate plan becomes active in milliseconds since epoch. + consumptionPricingType: + description: Pricing model used for consumption-based charges. type: string - description: Optional. Display name of the security incident. - firstDetectedTime: - format: google-datetime - readOnly: true - description: >- - Output only. The time when events associated with the incident were - first detected. + enumDescriptions: + - Pricing model not specified. This is the default. + - Fixed rate charged for each API call. + - >- + Variable rate charged for each API call based on price tiers. + Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 + per call * 201-300 calls cost $1 per call * Total price for 50 + calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x + $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + + 50 x $1 = $400. **Note**: Not supported by Apigee at this time. + - '**Note**: Not supported by Apigee at this time.' + - '**Note**: Not supported by Apigee at this time.' + enum: + - CONSUMPTION_PRICING_TYPE_UNSPECIFIED + - FIXED_PER_UNIT + - BANDED + - TIERED + - STAIRSTEP + revenueShareType: + description: Method used to calculate the revenue that is shared with developers. type: string - riskLevel: - readOnly: true - description: Output only. Risk level of the incident. enum: - - RISK_LEVEL_UNSPECIFIED - - LOW - - MODERATE - - SEVERE + - REVENUE_SHARE_TYPE_UNSPECIFIED + - FIXED + - VOLUME_BANDED enumDescriptions: - - Risk Level Unspecified. - - Risk level of the incident is low. - - Risk level of the incident is moderate. - - Risk level of the incident is severe. + - Revenue share type is not specified. + - >- + Fixed percentage of the total revenue will be shared. The + percentage to be shared can be configured by the API provider. + - >- + Amount of revenue shared depends on the number of API calls. The + API call volume ranges and the revenue share percentage for each + volume can be configured by the API provider. **Note**: Not + supported by Apigee at this time. + billingPeriod: + enum: + - BILLING_PERIOD_UNSPECIFIED + - WEEKLY + - MONTHLY + enumDescriptions: + - Billing period not specified. + - >- + Weekly billing period. **Note**: Not supported by Apigee at this + time. + - Monthly billing period. type: string - detectionTypes: + description: Frequency at which the customer will be billed. + setupFee: + description: Initial, one-time fee paid when purchasing the API product. + $ref: '#/components/schemas/GoogleTypeMoney' + apiproduct: + type: string + description: Name of the API product that the rate plan is associated with. + description: Rate plan details. + id: GoogleCloudApigeeV1RatePlan + type: object + GoogleIamV1Binding: + type: object + properties: + members: + description: >- + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array items: type: string - type: array + condition: + $ref: '#/components/schemas/GoogleTypeExpr' description: >- - Output only. Detection types which are part of the incident. - Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly - Detection. - readOnly: true - lastDetectedTime: - format: google-datetime + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + role: description: >- - Output only. The time when events associated with the incident were - last detected. - type: string - readOnly: true - name: + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. + GoogleCloudApigeeV1TraceSamplingConfig: + description: >- + TraceSamplingConfig represents the detail settings of distributed + tracing. Only the fields that are defined in the distributed trace + configuration can be overridden using the distribute trace configuration + override APIs. + properties: + samplingRate: + format: float description: >- - Immutable. Name of the security incident resource. Format: - organizations/{org}/environments/{environment}/securityIncidents/{incident} - Example: - organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 - trafficCount: + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + type: number + sampler: + enumDescriptions: + - Sampler unspecified. + - >- + OFF means distributed trace is disabled, or the sampling + probability is 0. + - >- + PROBABILITY means traces are captured on a probability that + defined by sampling_rate. The sampling rate is limited to 0 to 0.5 + when this is set. + description: Sampler of distributed tracing. OFF is the default value. type: string - description: Total traffic detected as part of the incident. - format: int64 - description: Represents an SecurityIncident resource. - GoogleCloudApigeeV1App: - id: GoogleCloudApigeeV1App + enum: + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY + type: object + id: GoogleCloudApigeeV1TraceSamplingConfig + GoogleCloudApigeeV1Metadata: type: object properties: - developerEmail: - type: string - description: Email of the developer. - scopes: + notices: + type: array + items: + type: string description: >- - Scopes to apply to the app. The specified scope names must already - exist on the API product that you associate with the app. + List of additional information such as data source, if result was + truncated. For example: ``` "notices": [ "Source:Postgres", "PG + Host:uappg0rw.e2e.apigeeks.net", "query served + by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: + edge.api.uapgroup2.agg_api" ]``` + errors: type: array + description: List of error messages as strings. items: type: string - appGroup: + description: Encapsulates additional information about query execution. + id: GoogleCloudApigeeV1Metadata + GoogleCloudApigeeV1QueryMetric: + type: object + properties: + alias: type: string - description: Name of the AppGroup - appId: - description: ID of the app. + description: >- + Alias for the metric. Alias will be used to replace metric name in + query results. + value: type: string - developerId: - description: ID of the developer. + description: Operand value should be provided when operator is set. + name: + description: Required. Metric name. type: string - lastModifiedAt: - description: Output only. Last modified time as milliseconds since epoch. + function: + description: 'Aggregation function: avg, min, max, or sum.' type: string - readOnly: true - format: int64 - name: - description: Name of the app. + operator: type: string - credentials: - type: array + description: One of `+`, `-`, `/`, `%`, `*`. + id: GoogleCloudApigeeV1QueryMetric + description: >- + More info about Metric: + https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: + properties: + resources: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + type: array description: >- - Output only. Set of credentials for the app. Credentials are API - key/secret pairs associated with API products. - readOnly: true - companyName: - type: string - description: Name of the company that owns the app. - callbackUrl: + Required. The array of resources. For Apigee, the proxies are + resources. + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + type: object + description: An array of resource messages. + GoogleCloudApigeeV1TraceConfig: + type: object + properties: + exporter: + description: >- + Required. Exporter that is used to view the distributed trace + captured using OpenCensus. An exporter sends traces to any backend + that is capable of consuming them. Recorded spans can be exported by + registered exporters. type: string + enum: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE + enumDescriptions: + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to apps. - createdAt: - format: int64 - readOnly: true + Distributed trace configuration for all API proxies in an + environment. You can also override the configuration for a specific + API proxy using the distributed trace configuration overrides API. + endpoint: type: string - description: Output only. Unix time when the app was created. - status: - description: Status of the credential. + description: Required. Endpoint of the exporter. + id: GoogleCloudApigeeV1TraceConfig + description: >- + TraceConfig defines the configurations in an environment of distributed + trace. + GoogleCloudApigeeV1Credential: + properties: + consumerKey: + description: Consumer key. type: string - apiProducts: - description: List of API products associated with the app. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' - type: array - keyExpiresIn: + issuedAt: + format: int64 + type: string + description: Time the credential was issued in milliseconds since epoch. + expiresAt: + description: Time the credential will expire in milliseconds since epoch. format: int64 type: string - description: >- - Duration, in milliseconds, of the consumer key that will be - generated for the app. The default value, -1, indicates an infinite - validity period. Once set, the expiration can't be updated. json - key: keyExpiresIn attributes: + description: List of attributes associated with this credential. + type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + scopes: + items: + type: string type: array - description: List of attributes. - EdgeConfigstoreBundleBadBundle: - type: object - id: EdgeConfigstoreBundleBadBundle - properties: - violations: + description: >- + List of scopes to apply to the app. Specified scopes must already + exist on the API product that you associate with the app. + apiProducts: items: - $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' - description: Describes all precondition violations. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + description: List of API products this credential can be used for. type: array - description: Describes why a bundle is invalid. Intended for use in error details. - GoogleCloudApigeeV1ConfigVersion: - id: GoogleCloudApigeeV1ConfigVersion - properties: - minorVersion: - type: integer - description: Minor version of the API proxy configuration schema. - format: int32 - majorVersion: - type: integer - format: int32 - description: Major version of the API proxy configuration schema. - type: object - description: >- - Version of the API proxy configuration schema. Currently, only 4.0 is - supported. - GoogleCloudApigeeV1ApiProductRef: - id: GoogleCloudApigeeV1ApiProductRef - properties: - status: - description: Status of the API product. Valid values are `approved` or `revoked`. + consumerSecret: + description: Secret key. type: string - apiproduct: + status: type: string - description: Name of the API product. - type: object - GoogleCloudApigeeV1AdvancedApiOpsConfig: - description: Configuration for the Advanced API Ops add-on. - id: GoogleCloudApigeeV1AdvancedApiOpsConfig + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. + id: GoogleCloudApigeeV1Credential type: object + GoogleCloudApigeeV1RoutingRule: properties: - enabled: - description: Flag that specifies whether the Advanced API Ops add-on is enabled. - type: boolean - GoogleCloudApigeeV1DeploymentGroupConfig: - properties: - deploymentGroupType: + envGroupRevision: + description: >- + The env group config revision_id when this rule was added or last + updated. This value is set when the rule is created and will only + update if the the environment_id changes. It is used to determine if + the runtime is up to date with respect to this rule. This field is + omitted from the IngressConfig unless the GetDeployedIngressConfig + API is called with view=FULL. + format: int64 + type: string + environment: type: string - enumDescriptions: - - Unspecified type - - Standard type - - Extensible Type description: >- - Type of the deployment group, which will be either Standard or - Extensible. - enum: - - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE - uid: + Name of an environment bound to the environment group in the + following format: `organizations/{org}/environments/{env}`. Only one + of environment or deployment_group will be set. + receiver: description: >- - Unique ID. The ID will only change if the deployment group is - deleted and recreated. + The resource name of the proxy revision that is receiving this + basepath in the following format: + `organizations/{org}/apis/{api}/revisions/{rev}`. This field is + omitted from the IngressConfig unless the GetDeployedIngressConfig + API is called with view=FULL. type: string - name: + deploymentGroup: + description: >- + Name of a deployment group in an environment bound to the + environment group in the following format: + `organizations/{org}/environment/{env}/deploymentGroups/{group}` + Only one of environment or deployment_group will be set. type: string + otherTargets: + items: + type: string + type: array description: >- - Name of the deployment group in the following format: - `organizations/{org}/environments/{env}/deploymentGroups/{group}`. - revisionId: + Conflicting targets, which will be resource names specifying either + deployment groups or environments. + basepath: type: string description: >- - Revision number which can be used by the runtime to detect if the - deployment group has changed between two versions. - format: int64 - description: >- - DeploymentGroupConfig represents a deployment group that should be - present in a particular environment. - id: GoogleCloudApigeeV1DeploymentGroupConfig + URI path prefix used to route to the specified environment. May + contain one or more wildcards. For example, path segments consisting + of a single `*` character will match any string. + updateTime: + format: google-datetime + description: >- + The unix timestamp when this rule was updated. This is updated + whenever env_group_revision is updated. This field is omitted from + the IngressConfig unless the GetDeployedIngressConfig API is called + with view=FULL. + type: string + type: object + id: GoogleCloudApigeeV1RoutingRule + GoogleCloudApigeeV1ReportProperty: + type: object + id: GoogleCloudApigeeV1ReportProperty + properties: + property: + description: name of the property + type: string + value: + description: property values + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + GoogleCloudApigeeV1ListApiProxiesResponse: type: object - GoogleCloudApigeeV1ListAppGroupsResponse: + id: GoogleCloudApigeeV1ListApiProxiesResponse properties: - appGroups: - type: array + proxies: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' - description: List of AppGroups. - nextPageToken: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + type: array + GoogleCloudApigeeV1Subscription: + properties: + name: type: string description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - totalSize: - description: Total count of AppGroups. - format: int32 - type: integer - id: GoogleCloudApigeeV1ListAppGroupsResponse - description: >- - ListAppGroupsResponse contains the 0 or more AppGroups, along with the - optional page token and the total count of apps. + Full name of the Pub/Sub subcription. Use the following structure in + your request: `subscription "projects/foo/subscription/bar"` type: object - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse + id: GoogleCloudApigeeV1Subscription + description: Pub/Sub subscription of an environment. + GoogleCloudApigeeV1Score: type: object + id: GoogleCloudApigeeV1Score + description: Represents Security Score. properties: - operations: + subcomponents: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - description: >- - A list of operations that matches the specified filter in the - request. + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + description: List of all the drilldown score components. type: array - nextPageToken: - type: string - description: The standard List next-page token. - description: The response message for Operations.ListOperations. - GoogleCloudApigeeV1PodStatus: + timeRange: + description: Start and end time for the score. + $ref: '#/components/schemas/GoogleTypeInterval' + component: + description: Component containing score, recommendations and actions. + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + GoogleCloudApigeeV1Property: + description: A single property entry in the Properties message. + id: GoogleCloudApigeeV1Property type: object properties: - deploymentStatus: + name: + description: The property key type: string - description: >- - Status of the deployment. Valid values include: - `deployed`: - Successful. - `error` : Failed. - `pending` : Pod has not yet - reported on the deployment. - podStatus: + value: + description: The property value + type: string + GoogleCloudApigeeV1SecurityReport: + description: >- + SecurityReport saves all the information about the created security + report. + properties: + envgroupHostname: + description: Hostname is available only when query is executed at host level. type: string + queryParams: description: >- - Overall status of the pod (not this specific deployment). Valid - values include: - `active`: Up to date. - `stale` : Recently out of - date. Pods that have not reported status in a long time are excluded - from the output. - deploymentTime: + Contains information like metrics, dimenstions etc of the Security + Report. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + resultRows: type: string - description: Time the proxy was deployed in milliseconds since epoch. + description: ResultRows is available only after the query is completed. format: int64 - deploymentStatusTime: + displayName: + description: Display Name specified by the user. type: string - format: int64 - description: Time the deployment status was reported in milliseconds since epoch. - podStatusTime: - description: Time the pod status was reported in milliseconds since epoch. - format: int64 + state: type: string - statusCode: + description: >- + Query state could be "enqueued", "running", "completed", "expired" + and "failed". + error: + description: Error is set when query fails. type: string - description: Code associated with the deployment status. - appVersion: + reportDefinitionId: + description: Report Definition ID. type: string - description: Version of the application running in the pod. - podName: + self: + description: >- + Self link of the query. Example: + `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + or following format if query is running at host level: + `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` type: string - description: Name of the pod which is reporting the status. - statusCodeDetails: + result: + description: Result is available only after the query is completed. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' + resultFileSize: + description: ResultFileSize is available only after the query is completed. type: string - description: Human-readable message associated with the status code. - id: GoogleCloudApigeeV1PodStatus - GoogleCloudApigeeV1SchemaSchemaElement: - id: GoogleCloudApigeeV1SchemaSchemaElement - type: object - description: Message type for the schema element - properties: - properties: - description: >- - Properties for the schema field. For example: { "createTime": - "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' - name: - description: Name of the field. + updated: + description: Output only. Last updated timestamp for the query. + readOnly: true type: string - GoogleCloudApigeeV1CustomReportMetric: - description: >- - This encapsulates a metric property of the form sum(message_count) where - name is message_count and function is sum - id: GoogleCloudApigeeV1CustomReportMetric - type: object - properties: - function: + created: + description: Creation time of the query. type: string - description: aggregate function - name: + executionTime: type: string - description: name of the metric - GoogleCloudApigeeV1DeveloperBalanceWallet: + description: ExecutionTime is available only after the query is completed. + id: GoogleCloudApigeeV1SecurityReport + type: object + GoogleCloudApigeeV1Alias: + id: GoogleCloudApigeeV1Alias properties: - balance: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Current remaining balance of the developer for a particular - currency. - lastCreditTime: - readOnly: true + certsInfo: + $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' + description: Chain of certificates under this alias. + type: + type: string + enum: + - ALIAS_TYPE_UNSPECIFIED + - CERT + - KEY_CERT + enumDescriptions: + - Alias type is not specified. + - Certificate. + - Key/certificate pair. + description: Type of alias. + alias: type: string - format: int64 description: >- - Output only. Time at which the developer last added credit to the - account in milliseconds since epoch. - description: Wallet used to manage an account balance for a particular currency. - id: GoogleCloudApigeeV1DeveloperBalanceWallet + Resource ID for this alias. Values must match the regular expression + `[^/]{1,255}`. type: object - GoogleCloudApigeeV1Deployment: + description: Reference to a certificate or key/certificate pair. + GoogleCloudApigeeV1AdvancedApiOpsConfig: + type: object + description: Configuration for the Advanced API Ops add-on. + id: GoogleCloudApigeeV1AdvancedApiOpsConfig + properties: + enabled: + type: boolean + description: Flag that specifies whether the Advanced API Ops add-on is enabled. + GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: + description: The result of the assessment. type: object properties: - apiProxy: - description: API proxy. - type: string - proxyDeploymentType: - readOnly: true + severity: enum: - - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE + - SEVERITY_UNSPECIFIED + - LOW + - MEDIUM + - HIGH + - MINIMAL enumDescriptions: - - >- - Default value till public preview. After public preview this value - should not be returned. - - >- - Deployment will be of type Standard if only Standard proxies are - used - - >- - Proxy will be of type Extensible if deployments uses one or more - Extensible proxies + - Severity is not defined. + - Severity is low. + - Severity is medium. + - Severity is high. + - Severity is minimal + description: The severity of the assessment. type: string + dataUpdateTime: description: >- - Output only. The type of the deployment (standard or extensible) - Deployed proxy revision will be marked as extensible in following 2 - cases. 1. The deployed proxy revision uses extensible policies. 2. - If a environment supports flowhooks and flow hook is configured. - pods: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1PodStatus' - type: array - description: >- - Status reported by runtime pods. **Note**: **This field is - deprecated**. Runtime versions 1.3 and above report instance level - status rather than pod status. - deployStartTime: - format: int64 + The time when resource data was last fetched for this resource. This + time may be different than when the resource was actually updated + due to lag in data collection. + format: google-datetime type: string + failedAssessmentPerWeight: + additionalProperties: + format: int32 + type: integer + description: >- + The number of failed assessments grouped by its weight. Keys are one + of the following: "MAJOR", "MODERATE", "MINOR". + type: object + score: + format: int32 + type: integer + description: The security score of the assessment. + assessmentRecommendations: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + type: object description: >- - Time the API proxy was marked `deployed` in the control plane in - millisconds since epoch. - environment: - type: string - description: Environment. - errors: + The recommendations of the assessment. The key is the "name" of the + assessment (not display_name), and the value are the + recommendations. + id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + GoogleCloudApigeeV1ListSecurityIncidentsResponse: + type: object + description: Response for ListSecurityIncidents. + properties: + securityIncidents: type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + description: List of security incidents in the organization + nextPageToken: description: >- - Errors reported for this deployment. Populated only when state == - ERROR. **Note**: This field is displayed only when viewing - deployment status. - revision: + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - description: API proxy revision. - instances: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' + id: GoogleCloudApigeeV1ListSecurityIncidentsResponse + GoogleApiHttpBody: + properties: + extensions: description: >- - Status reported by each runtime instance. **Note**: This field is - displayed only when viewing deployment status. + Application specific response metadata. Must be set in the first + response for streaming APIs. type: array - serviceAccount: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + contentType: type: string description: >- - The full resource name of Cloud IAM Service Account that this - deployment is using, eg, `projects/-/serviceAccounts/{email}`. - state: + The HTTP Content-Type header value specifying the content type of + the body. + data: + description: The HTTP request/response body as raw binary. type: string - enumDescriptions: - - This value should never be returned. - - Runtime has loaded the deployment. - - Deployment is not fully ready in the runtime. - - >- - Encountered an error with the deployment that requires - intervention. - enum: - - RUNTIME_STATE_UNSPECIFIED - - READY - - PROGRESSING - - ERROR - description: >- - Current state of the deployment. **Note**: This field is displayed - only when viewing deployment status. - routeConflicts: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - description: >- - Conflicts in the desired state routing configuration. The presence - of conflicts does not cause the state to be `ERROR`, but it will - mean that some of the deployment's base paths are not routed to its - environment. If the conflicts change, the state will transition to - `PROGRESSING` until the latest configuration is rolled out to all - instances. **Note**: This field is displayed only when viewing - deployment status. - type: array - id: GoogleCloudApigeeV1Deployment - GoogleCloudApigeeV1TraceConfigOverride: - id: GoogleCloudApigeeV1TraceConfigOverride + format: byte + id: GoogleApiHttpBody type: object - description: A representation of a configuration override. + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + GoogleCloudApigeeV1ListApiProductsResponse: + type: object + id: GoogleCloudApigeeV1ListApiProductsResponse properties: - name: + apiProduct: + description: Lists all API product names defined for an organization. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + GoogleCloudApigeeV1ResourceStatus: + properties: + resource: type: string description: >- - ID of the trace configuration override specified as a - system-generated UUID. - samplingConfig: - description: Trace configuration to override. - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' - apiProxy: - description: >- - ID of the API proxy that will have its trace configuration - overridden. - type: string - GoogleCloudApigeeV1OperationConfig: - properties: - operations: + The resource name. Currently only two resources are supported: + EnvironmentGroup - organizations/{org}/envgroups/{envgroup} + EnvironmentConfig - + organizations/{org}/environments/{environment}/deployedConfig + revisions: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' + $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' type: array + description: Revisions of the resource currently deployed in the instance. + uid: description: >- - List of resource/method pairs for the API proxy or remote service to - which quota will applied. **Note**: Currently, you can specify only - a single resource/method pair. The call will fail if more than one - resource/method pair is provided. - apiSource: + The uid of the resource. In the unexpected case that the instance + has multiple uids for the same name, they should be reported under + separate ResourceStatuses. type: string - description: >- - Required. Name of the API proxy or remote service with which the - resources, methods, and quota are associated. - attributes: + totalReplicas: + description: The total number of replicas that should have this resource. + format: int32 + type: integer + type: object + description: The status of a resource loaded in the runtime. + id: GoogleCloudApigeeV1ResourceStatus + GoogleCloudApigeeV1Stats: + description: Encapsulates a `stats` response. + properties: + environments: + description: List of query results on the environment level. + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: Custom attributes associated with the operation. + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' + metaData: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + description: Metadata information. + hosts: type: array - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' - description: >- - Quota parameters to be enforced for the resources, methods, and API - source combination. If none are specified, quota enforcement will - not be done. - description: >- - Binds the resources in an API proxy or remote service with the allowed - REST methods and associated quota enforcement. - id: GoogleCloudApigeeV1OperationConfig + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' + description: List of query results grouped by host. + id: GoogleCloudApigeeV1Stats type: object - GoogleRpcPreconditionFailureViolation: + GoogleCloudApigeeV1ProfileConfigCORS: + properties: {} + type: object + id: GoogleCloudApigeeV1ProfileConfigCORS + description: Checks to see if you have CORS policy in place. + GoogleCloudApigeeV1ListAppsResponse: type: object + id: GoogleCloudApigeeV1ListAppsResponse properties: - description: - type: string - description: >- - A description of how the precondition failed. Developers can use - this description to understand how to fix the failure. For example: - "Terms of service not accepted". - subject: + app: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1App' + totalSize: + type: integer + description: Total count of Apps. + format: int32 + nextPageToken: type: string description: >- - The subject, relative to the type, that failed. For example, - "google.com/cloud" relative to the "TOS" type would indicate which - terms of service is being referenced. - type: + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + GoogleCloudApigeeV1DeveloperBalance: + properties: + wallets: + type: array description: >- - The type of PreconditionFailure. We recommend using a - service-specific enum type to define the supported precondition - violation subjects. For example, "TOS" for "Terms of Service - violation". - type: string - id: GoogleRpcPreconditionFailureViolation - description: A message type used to describe a single precondition failure. - GoogleCloudApigeeV1CreditDeveloperBalanceRequest: - id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest - description: Request for CreditDeveloperBalance. + Output only. List of all wallets. Each individual wallet stores the + account balance for a particular currency. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' + readOnly: true + type: object + id: GoogleCloudApigeeV1DeveloperBalance + description: Account balance for the developer. + GoogleCloudApigeeV1Keystore: + id: GoogleCloudApigeeV1Keystore properties: - transactionAmount: - $ref: '#/components/schemas/GoogleTypeMoney' + aliases: + items: + type: string + description: Output only. Aliases in this keystore. + type: array + readOnly: true + name: description: >- - The amount of money to be credited. The wallet corresponding to the - currency specified within `transaction_amount` will be updated. For - example, if you specified `currency_code` within - `transaction_amount` as "USD", then the amount would be added to the - wallet which has the "USD" currency or if no such wallet exists, a - new wallet will be created with the "USD" currency. - transactionId: + Required. Resource ID for this keystore. Values must match the + regular expression `[\w[:space:].-]{1,255}`. type: string - description: >- - Each transaction_id uniquely identifies a credit balance request. If - multiple requests are received with the same transaction_id, only - one of them will be considered. + description: Datastore for Certificates and Aliases. type: object - GoogleCloudApigeeV1ListKeyValueEntriesResponse: - description: >- - The request structure for listing key value map keys and its - corresponding values. - id: GoogleCloudApigeeV1ListKeyValueEntriesResponse + GoogleCloudApigeeV1EnvironmentGroup: type: object + id: GoogleCloudApigeeV1EnvironmentGroup + description: >- + EnvironmentGroup configuration. An environment group is used to group + one or more Apigee environments under a single host name. properties: - nextPageToken: + state: type: string description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - keyValueEntries: + Output only. State of the environment group. Values other than + ACTIVE means the resource is not ready to use. + readOnly: true + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + name: + description: ID of the environment group. + type: string + createdAt: + description: >- + Output only. The time at which the environment group was created as + milliseconds since epoch. + type: string + format: int64 + readOnly: true + lastModifiedAt: + format: int64 + readOnly: true + description: >- + Output only. The time at which the environment group was last + updated as milliseconds since epoch. + type: string + hostnames: type: array - description: One or more key value map keys and values. + description: Required. Host names for this environment group. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' - GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: + type: string + GoogleCloudApigeeV1QueryTabularStatsRequest: + type: object properties: - metrics: - description: Required. List of metrics and their aggregations. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - type: array - filter: + pageToken: type: string + description: Identifies a sequence of rows. + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: Time range for the stats. + filter: description: >- Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters - timestampOrder: - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. - description: >- - Order the sequences in increasing or decreasing order of timestamps. - Default is descending order of timestamps (latest first). type: string pageSize: format: int32 + description: Page size represents the number of rows. type: integer - description: >- - Page size represents the number of time series sequences, one per - unique set of dimensions and their values. - windowSize: - type: string - description: Time buckets to group the stats by. - enumDescriptions: - - Unspecified window size. Default is 1 hour. - - 1 Minute window - - 1 Hour window - - 1 Day window - - 1 Month window - enum: - - WINDOW_SIZE_UNSPECIFIED - - MINUTE - - HOUR - - DAY - - MONTH - timeRange: - description: Required. Time range for the stats. - $ref: '#/components/schemas/GoogleTypeInterval' - dimensions: + metrics: + description: Required. List of metrics and their aggregations. type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' + dimensions: + description: Required. List of dimension names to group the aggregations by. items: type: string - description: >- - List of dimension names to group the aggregations by. If no - dimensions are passed, a single trend line representing the - requested metric aggregations grouped by environment is returned. - pageToken: - type: string - description: >- - Page token stands for a specific collection of time series - sequences. - id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + type: array + id: GoogleCloudApigeeV1QueryTabularStatsRequest description: >- - QueryTimeSeriesStatsRequest represents a query that returns a collection - of time series sequences grouped by their values. - type: object - GoogleIamV1AuditLogConfig: + Request payload representing the query to be run for fetching security + statistics as rows. + GoogleCloudApigeeV1TargetServer: type: object description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - id: GoogleIamV1AuditLogConfig - properties: - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - logType: - description: The log type that this config enables. - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - type: string - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - GoogleCloudApigeeV1ProvisionOrganizationRequest: - type: object - id: GoogleCloudApigeeV1ProvisionOrganizationRequest - description: Request for ProvisionOrganization. + TargetServer configuration. TargetServers are used to decouple a proxy + TargetEndpoint HTTPTargetConnections from concrete URLs for backend + services. properties: - authorizedNetwork: + description: + description: Optional. A human-readable description of this TargetServer. type: string + sSLInfo: + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' description: >- - Compute Engine network used for Service Networking to be peered with - Apigee runtime instances. See [Getting started with the Service - Networking - API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). - Apigee also supports shared VPC (that is, the host network project - is not the same as the one that is peering with Apigee). See [Shared - VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use - a shared VPC network, use the following format: - `projects/{host-project-id}/{region}/networks/{network-name}`. For - example: `projects/my-sharedvpc-host/global/networks/mynetwork` - analyticsRegion: - description: >- - Primary Cloud Platform region for analytics data storage. For valid - values, see [Create an - organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). - Defaults to `us-west1`. + Optional. Specifies TLS configuration info for this TargetServer. + The JSON name is `sSLInfo` for legacy/backwards compatibility + reasons -- Edge originally supported SSL, and the name is still used + for TLS configuration. + host: type: string - runtimeLocation: description: >- - Cloud Platform location for the runtime instance. Defaults to zone - `us-west1-a`. If a region is provided, `EVAL` organizations will use - the region for automatically selecting a zone for the runtime - instance. - type: string - disableVpcPeering: + Required. The host name this target connects to. Value must be a + valid hostname as described by RFC-1123. + isEnabled: type: boolean description: >- - Optional. Flag that specifies whether the VPC Peering through - Private Google Access should be disabled between the consumer - network and Apigee. Required if an authorizedNetwork on the consumer - project is not provided, in which case the flag should be set to - true. The value must be set before the creation of any Apigee - runtime instance and can be updated only when there are no runtime - instances. **Note:** Apigee will be deprecating the vpc peering - model that requires you to provide 'authorizedNetwork', by making - the non-peering model as the default way of provisioning Apigee - organization in future. So, this will be a temporary flag to enable - the transition. Not supported for Apigee hybrid. - GoogleCloudApigeeV1AccessLoggingConfig: - id: GoogleCloudApigeeV1AccessLoggingConfig - description: >- - Access logging configuration enables customers to ship the access logs - from the tenant projects to their own project's cloud logging. The - feature is at the instance level ad disabled by default. It can be - enabled during CreateInstance or UpdateInstance. - type: object - properties: - enabled: + Optional. Enabling/disabling a TargetServer is useful when + TargetServers are used in load balancing configurations, and one or + more TargetServers need to taken out of rotation periodically. + Defaults to true. + port: + format: int32 description: >- - Optional. Boolean flag that specifies whether the customer access - log feature is enabled. - type: boolean - filter: + Required. The port number this target connects to on the given host. + Value must be between 1 and 65535, inclusive. + type: integer + name: + type: string description: >- - Optional. Ship the access log entries that match the status_code - defined in the filter. The status_code is the only - expected/supported filter field. (Ex: status_code) The filter will - parse it to the Common Expression Language semantics for expression - evaluation to build the filter condition. (Ex: "filter": status_code - >= 200 && status_code < 300 ) + Required. The resource id of this target server. Values must match + the regular expression + protocol: + description: Immutable. The protocol used by this TargetServer. + enum: + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + enumDescriptions: + - UNSPECIFIED defaults to HTTP for backwards compatibility. + - The TargetServer uses HTTP. + - The TargetSever uses HTTP2. + - The TargetServer uses GRPC. + - >- + GRPC TargetServer to be used in ExternalCallout Policy. Prefer to + use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once + EXTERNAL _CALLOUT generally available. + - The TargetServer is to be used in the ExternalCallout Policy type: string - GoogleCloudApigeeV1RateRange: - id: GoogleCloudApigeeV1RateRange - type: object + id: GoogleCloudApigeeV1TargetServer + GoogleCloudApigeeV1SecuritySettings: + id: GoogleCloudApigeeV1SecuritySettings description: >- - API call volume range and the fees charged when the total number of API - calls is within the range. + SecuritySettings reflects the current state of the SecuritySettings + feature. properties: - end: - description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - format: int64 + name: type: string - fee: - $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Fee to charge when total number of API calls falls within this - range. - start: + Identifier. Full resource name is always + `organizations/{org}/securitySettings`. + mlRetrainingFeedbackEnabled: + type: boolean description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. - format: int64 - type: string - GoogleCloudApigeeV1APIProductAssociation: - id: GoogleCloudApigeeV1APIProductAssociation + Optional. If true the user consents to the use of ML models for + Abuse detection. + type: object + GoogleCloudApigeeV1OptimizedStats: type: object - description: >- - APIProductAssociation has the API product and its administrative state - association. properties: - status: + Response: description: >- - The API product credential associated status. Valid values are - `approved` or `revoked`. - type: string - apiproduct: - type: string - description: API product to be associated with the credential. - GoogleCloudApigeeV1Quota: + Wraps the `stats` response for JavaScript Optimized Scenario with a + response key. For example: ```{ "Response": { "TimeUnit": [], + "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table + used: edge.api.aaxgroup001.agg_api", "PG + Host:ruappg08-ro.production.apigeeks.net", "query served + by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": + false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" + ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": + "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": + "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' + id: GoogleCloudApigeeV1OptimizedStats + GoogleCloudApigeeV1OperationMetadata: type: object + id: GoogleCloudApigeeV1OperationMetadata properties: - interval: - description: >- - Required. Time interval over which the number of request messages is - calculated. + targetResourceName: type: string - limit: + description: Name of the resource for which the operation is operating on. + operationType: + enum: + - OPERATION_TYPE_UNSPECIFIED + - INSERT + - DELETE + - UPDATE + enumDescriptions: + - '' + - '' + - '' + - '' type: string - description: >- - Required. Upper limit allowed for the time interval and time unit - specified. Requests exceeding this limit will be rejected. - timeUnit: + warnings: + items: + type: string + description: Warnings encountered while executing the operation. + type: array + progress: + description: Progress of the operation. + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' + state: + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED + enumDescriptions: + - '' + - '' + - '' + - '' type: string - description: >- - Time unit defined for the `interval`. Valid values include `minute`, - `hour`, `day`, or `month`. If `limit` and `interval` are valid, the - default value is `hour`; otherwise, the default is null. - description: >- - Quota contains the essential parameters needed that can be applied on - the resources, methods, API source combination associated with this API - product. While Quota is optional, setting it prevents requests from - exceeding the provisioned parameters. - id: GoogleCloudApigeeV1Quota - GoogleCloudApigeeV1TraceConfig: + description: Metadata describing an Operation. + GoogleCloudApigeeV1ScoreComponentRecommendationAction: + id: GoogleCloudApigeeV1ScoreComponentRecommendationAction + type: object properties: - exporter: + actionContext: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + description: Action context for the action. + description: + description: Description of the action. type: string - enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter - description: >- - Required. Exporter that is used to view the distributed trace - captured using OpenCensus. An exporter sends traces to any backend - that is capable of consuming them. Recorded spans can be exported by - registered exporters. - enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + description: Action to improve security score. + GoogleCloudApigeeV1TlsInfoCommonName: + id: GoogleCloudApigeeV1TlsInfoCommonName + properties: + wildcardMatch: + type: boolean description: >- - Distributed trace configuration for all API proxies in an - environment. You can also override the configuration for a specific - API proxy using the distributed trace configuration overrides API. - endpoint: - description: Required. Endpoint of the exporter. + Indicates whether the cert should be matched against as a wildcard + cert. + value: type: string + description: The TLS Common Name string of the certificate. type: object - id: GoogleCloudApigeeV1TraceConfig - description: >- - TraceConfig defines the configurations in an environment of distributed - trace. - GoogleCloudApigeeV1RuntimeTraceConfig: + GoogleCloudApigeeV1AnalyticsConfig: + description: Configuration for the Analytics add-on. + id: GoogleCloudApigeeV1AnalyticsConfig type: object - id: GoogleCloudApigeeV1RuntimeTraceConfig - description: >- - NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed - trace in an environment. properties: - endpoint: - type: string - description: Endpoint of the exporter. - revisionCreateTime: - type: string - format: google-datetime - description: The timestamp that the revision was created or updated. - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - description: Trace configuration for all API proxies in an environment. - overrides: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' - type: array - description: List of trace configuration overrides for spicific API proxies. - name: + expireTimeMillis: + format: int64 type: string + readOnly: true description: >- - Name of the trace config in the following format: - `organizations/{org}/environment/{env}/traceConfig` - revisionId: - description: >- - Revision number which can be used by the runtime to detect if the - trace config has changed between two versions. + Output only. Time at which the Analytics add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. + state: + enum: + - ADDON_STATE_UNSPECIFIED + - ENABLING + - ENABLED + - DISABLING + - DISABLED type: string - exporter: - description: >- - Exporter that is used to view the distributed trace captured using - OpenCensus. An exporter sends traces to any backend that is capable - of consuming them. Recorded spans can be exported by registered - exporters. + readOnly: true + description: Output only. The state of the Analytics add-on. enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter - enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE + - Default value. + - Add-on is in progress of enabling. + - Add-on is fully enabled and ready to use. + - Add-on is in progress of disabling. + - Add-on is fully disabled. + updateTime: + readOnly: true type: string - GoogleCloudApigeeV1SetAddonEnablementRequest: - description: Request for SetAddonEnablement. - properties: - analyticsEnabled: - type: boolean - description: If the Analytics should be enabled in the environment. - apiSecurityEnabled: - type: boolean - description: If the API Security should be enabled in the environment. - type: object - id: GoogleCloudApigeeV1SetAddonEnablementRequest - GoogleCloudApigeeV1Stats: - description: Encapsulates a `stats` response. + format: google-datetime + description: Output only. The latest update time. + enabled: + description: Whether the Analytics add-on is enabled. + type: boolean + GoogleCloudApigeeV1ResourceFiles: + id: GoogleCloudApigeeV1ResourceFiles type: object + description: List of resource files. properties: - environments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' - type: array - description: List of query results on the environment level. - metaData: - description: Metadata information. - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - hosts: + resourceFile: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' - description: List of query results grouped by host. + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + description: List of resource files. type: array - id: GoogleCloudApigeeV1Stats - GoogleCloudApigeeV1TargetServer: + GoogleCloudApigeeV1SecurityReportResultView: + description: The response for security report result view APIs. + type: object properties: - sSLInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' - description: >- - Optional. Specifies TLS configuration info for this TargetServer. - The JSON name is `sSLInfo` for legacy/backwards compatibility - reasons -- Edge originally supported SSL, and the name is still used - for TLS configuration. - host: + error: + description: Error message when there is a failure. type: string + rows: description: >- - Required. The host name this target connects to. Value must be a - valid hostname as described by RFC-1123. - name: + Rows of security report result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} + type: array + items: + type: any + state: type: string + description: State of retrieving ResultView. + metadata: description: >- - Required. The resource id of this target server. Values must match - the regular expression - isEnabled: - type: boolean - description: >- - Optional. Enabling/disabling a TargetServer is useful when - TargetServers are used in load balancing configurations, and one or - more TargetServers need to taken out of rotation periodically. - Defaults to true. - port: + Metadata contains information like metrics, dimenstions etc of the + security report. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + code: type: integer + description: Error code when there is a failure. format: int32 + id: GoogleCloudApigeeV1SecurityReportResultView + GoogleCloudApigeeV1SecurityReportMetadata: + description: Metadata for the security report. + properties: + timeUnit: + type: string + description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' + metrics: + items: + type: string description: >- - Required. The port number this target connects to on the given host. - Value must be between 1 and 65535, inclusive. - description: + Metrics of the SecurityReport. Example: + ["name:bot_count,func:sum,alias:sum_bot_count"] + type: array + mimeType: + description: MIME type / Output format. type: string - description: Optional. A human-readable description of this TargetServer. - protocol: - description: Immutable. The protocol used by this TargetServer. - enumDescriptions: - - UNSPECIFIED defaults to HTTP for backwards compatibility. - - The TargetServer uses HTTP. - - The TargetSever uses HTTP2. - - The TargetServer uses GRPC. - - >- - GRPC TargetServer to be used in ExternalCallout Policy. Prefer to - use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once - EXTERNAL _CALLOUT generally available. - - The TargetServer is to be used in the ExternalCallout Policy + dimensions: + items: + type: string + type: array + description: Dimensions of the SecurityReport. + startTimestamp: + description: Start timestamp of the query range. type: string - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - description: >- - TargetServer configuration. TargetServers are used to decouple a proxy - TargetEndpoint HTTPTargetConnections from concrete URLs for backend - services. - id: GoogleCloudApigeeV1TargetServer + format: google-datetime + endTimestamp: + description: End timestamp of the query range. + type: string + format: google-datetime type: object - GoogleCloudApigeeV1DatastoreConfig: + id: GoogleCloudApigeeV1SecurityReportMetadata + GoogleCloudApigeeV1FlowHook: type: object + id: GoogleCloudApigeeV1FlowHook properties: - datasetName: - type: string - description: BigQuery dataset name Required for `bigquery` target_type. - tablePrefix: - description: Prefix of BigQuery table Required for `bigquery` target_type. - type: string - path: - description: Path of Cloud Storage bucket Required for `gcs` target_type. + description: type: string - projectId: - description: Required. GCP project in which the datastore exists + description: Description of the flow hook. + flowHookPoint: + description: >- + Output only. Where in the API call flow the flow hook is invoked. + Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, + `PreTargetFlowHook`, or `PostTargetFlowHook`. + readOnly: true type: string - bucketName: - description: Name of the Cloud Storage bucket. Required for `gcs` target_type. + sharedFlow: type: string - id: GoogleCloudApigeeV1DatastoreConfig - description: Configuration detail for datastore - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: - properties: - scoreImpact: description: >- - Score impact indicates the impact on the overall score if the - assessment were to pass. - type: integer - format: int32 - verdict: - enumDescriptions: - - The verdict is unspecified. - - The assessment has passed. - - The assessment has failed. + Shared flow attached to this flow hook, or empty if there is none + attached. + continueOnError: + description: >- + Optional. Flag that specifies whether execution should continue if + the flow hook throws an exception. Set to `true` to continue + execution. Set to `false` to stop execution if the flow hook throws + an exception. Defaults to `true`. + type: boolean + GoogleCloudApigeeV1Instance: + id: GoogleCloudApigeeV1Instance + type: object + description: Apigee runtime instance. + properties: + port: type: string - description: Verdict indicates the assessment result. - enum: - - VERDICT_UNSPECIFIED - - PASS - - FAIL - weight: - enum: - - WEIGHT_UNSPECIFIED - - MINOR - - MODERATE - - MAJOR - description: The weight of the assessment which was set in the profile. - enumDescriptions: - - The weight is unspecified. - - The weight is minor. - - The weight is moderate. - - The weight is major. + description: Output only. Port number of the exposed Apigee endpoint. + readOnly: true + serviceAttachment: + description: >- + Output only. Resource name of the service attachment created for the + instance in the format: `projects/*/regions/*/serviceAttachments/*` + Apigee customers can privately forward traffic to this service + attachment using the PSC endpoints. type: string - recommendations: - description: The recommended steps of the assessment. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - type: array + readOnly: true displayName: + description: Optional. Display name for the instance. type: string - description: The display name of the assessment. - type: object - description: The message format of a recommendation from the assessment. - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation - GoogleCloudApigeeV1SecurityProfileScoringConfig: - type: object - id: GoogleCloudApigeeV1SecurityProfileScoringConfig - properties: + accessLoggingConfig: + description: >- + Optional. Access logging configuration enables the access logging + feature at the instance. Apigee customers can enable access logging + to ship the access logs to their own project's cloud logging. + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessLoggingConfig' description: - description: Description of the config. + description: Optional. Description of the instance. type: string - scorePath: + diskEncryptionKeyName: + description: >- + Customer Managed Encryption Key (CMEK) used for disk and volume + encryption. If not specified, a Google-Managed encryption key will + be used. Use the following format: + `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` type: string - description: Path of the component config used for scoring. - title: - description: Title of the config. + state: + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + description: >- + Output only. State of the instance. Values other than `ACTIVE` means + the resource is not ready to use. + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + readOnly: true + type: string + runtimeVersion: + description: >- + Output only. Version of the runtime system running in the instance. + The runtime system is the set of components that serve the API Proxy + traffic in your Environments. + readOnly: true + type: string + createdAt: type: string - description: Security configurations to manage scoring. - GoogleCloudApigeeV1SecurityActionConditionConfig: - properties: - asns: - type: array + readOnly: true + format: int64 description: >- - Optional. A list of ASN numbers to act on, e.g. 23. - https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses - int64 instead of uint32 because of - https://linter.aip.dev/141/forbidden-types. - items: - type: string - format: int64 - ipAddressRanges: - type: array - items: - type: string + Output only. Time the instance was created in milliseconds since + epoch. + host: description: >- - Optional. A list of IP addresses. This could be either IPv4 or IPv6. - Limited to 100 per action. - botReasons: + Output only. Internal hostname or IP address of the Apigee endpoint + used by clients to connect to the service. + type: string + readOnly: true + peeringCidrRange: + deprecated: true + enum: + - CIDR_RANGE_UNSPECIFIED + - SLASH_16 + - SLASH_17 + - SLASH_18 + - SLASH_19 + - SLASH_20 + - SLASH_22 + - SLASH_23 + enumDescriptions: + - Range not specified. + - '`/16` CIDR range.' + - '`/17` CIDR range.' + - '`/18` CIDR range.' + - '`/19` CIDR range.' + - '`/20` CIDR range.' + - '`/22` CIDR range. Supported for evaluation only.' + - '`/23` CIDR range. Supported for evaluation only.' description: >- - Optional. A list of Bot Reasons. Current options: Flooder, Brute - Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, - TorListRule, Advanced Anomaly Detection, Advanced API Scraper, - Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public - Cloud Azure, and Public Cloud Google. - items: - type: string - type: array - apiKeys: - description: Optional. A list of API keys. Limit 1000 per action. - type: array - items: - type: string - httpMethods: - items: - type: string + Optional. Size of the CIDR block range that will be reserved by the + instance. PAID organizations support `SLASH_16` to `SLASH_20` and + defaults to `SLASH_16`. Evaluation organizations support only + `SLASH_23`. + type: string + consumerAcceptList: description: >- - Optional. Act only on particular HTTP methods. E.g. A read-only API - can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, - POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH. - type: array - accessTokens: - description: Optional. A list of access_tokens. Limit 1000 per action. - items: - type: string + Optional. Customer accept list represents the list of projects + (id/number) on customer side that can privately connect to the + service attachment. It is an optional field which the customers can + provide during the instance creation. By default, the customer + project associated with the Apigee organization will be included to + the list. type: array - developers: items: type: string - description: Optional. A list of developers. Limit 1000 per action. - type: array - regionCodes: - type: array + name: + type: string description: >- - Optional. A list of countries/region codes to act on, e.g. US. This - follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - items: - type: string - apiProducts: - type: array - items: - type: string - description: Optional. A list of API Products. Limit 1000 per action. - developerApps: - items: - type: string - type: array - description: Optional. A list of developer apps. Limit 1000 per action. - userAgents: - items: - type: string - type: array + Required. Resource ID of the instance. Values must match the regular + expression `^a-z{0,30}[a-z\d]$`. + location: + description: Required. Compute Engine location where the instance resides. + type: string + ipRange: + type: string description: >- - Optional. A list of user agents to deny. We look for exact matches. - Limit 50 per action. - description: >- - The following are a list of conditions. A valid SecurityAction must - contain at least one condition. Within a condition, each element is - ORed. Across conditions elements are ANDed. For example if a - SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and - bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: - enforce the action if the incoming request has ((ip_address_ranges = - "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR - bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges - and bot_reasons cannot be ANDed. - type: object - id: GoogleCloudApigeeV1SecurityActionConditionConfig - GoogleCloudApigeeV1Session: - description: Session carries the debug session id and its creation time. - id: GoogleCloudApigeeV1Session - properties: - timestampMs: + Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 + used to create the Apigee instance. Providing CIDR ranges is + optional. You can provide just /22 or /28 or both (or neither). + Ranges you provide should be freely available as part of a larger + named range you have allocated to the Service Networking peering. If + this parameter is not provided, Apigee automatically requests an + available /22 and /28 CIDR block from Service Networking. Use the + /22 CIDR block for configuring your firewall needs to allow traffic + from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or + `a.b.c.d/22,e.f.g.h/28` + lastModifiedAt: type: string description: >- - The first transaction creation timestamp in millisecond, recorded by - UAP. + Output only. Time the instance was last modified in milliseconds + since epoch. format: int64 - id: - description: The debug session ID. - type: string - type: object - GoogleCloudApigeeV1ProfileConfig: + readOnly: true + GoogleCloudApigeeV1SharedFlow: + description: The metadata describing a shared flow + id: GoogleCloudApigeeV1SharedFlow type: object - description: >- - ProfileConfig defines a set of categories and policies which will be - used to compute security score. properties: - categories: + revision: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' + type: string + description: A list of revisions of this shared flow. type: array - description: List of categories of profile config. - id: GoogleCloudApigeeV1ProfileConfig - GoogleCloudApigeeV1SecuritySettings: - description: >- - SecuritySettings reflects the current state of the SecuritySettings - feature. - id: GoogleCloudApigeeV1SecuritySettings - type: object - properties: - mlRetrainingFeedbackEnabled: - description: >- - Optional. If true the user consents to the use of ML models for - Abuse detection. - type: boolean + latestRevisionId: + type: string + description: The id of the most recently created revision for this shared flow. + metaData: + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + description: Metadata describing the shared flow. name: - description: >- - Identifier. Full resource name is always - `organizations/{org}/securitySettings`. + description: The ID of the shared flow. type: string - GoogleCloudApigeeV1GetSyncAuthorizationRequest: - type: object - properties: {} - id: GoogleCloudApigeeV1GetSyncAuthorizationRequest - description: Request for GetSyncAuthorization. - GoogleCloudApigeeV1ResourceFiles: - description: List of resource files. - id: GoogleCloudApigeeV1ResourceFiles - properties: - resourceFile: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' - description: List of resource files. - type: array - type: object - GoogleCloudApigeeV1ApiProxy: - type: object - id: GoogleCloudApigeeV1ApiProxy + GoogleCloudApigeeV1AppGroupAppKey: properties: - labels: - type: object - description: User labels applied to this API Proxy. - additionalProperties: - type: string - apiProxyType: - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE - description: Output only. The type of the API proxy. - readOnly: true - enumDescriptions: - - API proxy type not specified. - - >- - Programmable API Proxies enable you to develop APIs with highly - flexible behavior using bundled policy configuration and one or - more programming languages to describe complex sequential and/or - conditional flows of logic. - - >- - Configurable API Proxies enable you to develop efficient APIs - using simple configuration while complex execution control flow - logic is handled by Apigee. This type only works with the ARCHIVE - deployment type and cannot be combined with the PROXY deployment - type. - type: string - latestRevisionId: - description: >- - Output only. The id of the most recently created revision for this - api proxy. + consumerSecret: type: string - readOnly: true - readOnly: - type: boolean - description: >- - Output only. Whether this proxy is read-only. A read-only proxy - cannot have new revisions created through calls to - CreateApiProxyRevision. A proxy is read-only if it was generated by - an archive. - readOnly: true - name: - readOnly: true + description: Secret key. + attributes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: List of attributes associated with the credential. + issuedAt: type: string - description: Output only. Name of the API proxy. - metaData: + description: >- + Output only. Time the AppGroup app was created in milliseconds since + epoch. + format: int64 readOnly: true - description: Output only. Metadata describing the API proxy. - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - revision: - type: array + scopes: items: type: string + description: >- + Scopes to apply to the app. The specified scope names must already + be defined for the API product that you associate with the app. + type: array + expiresAt: readOnly: true - description: Output only. List of revisions defined for the API proxy. - description: Metadata describing the API proxy - GoogleCloudApigeeV1EntityMetadata: - description: Metadata common to many entities in this API. - type: object - id: GoogleCloudApigeeV1EntityMetadata - properties: - lastModifiedAt: + description: >- + Output only. Time the AppGroup app expires in milliseconds since + epoch. format: int64 + type: string + apiProducts: + readOnly: true description: >- - Time at which the API proxy was most recently modified, in - milliseconds since epoch. + Output only. List of API products and its status for which the + credential can be used. **Note**: Use + UpdateAppGroupAppKeyApiProductRequest API to make the association + after the consumer key and secret are created. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' + status: type: string - subType: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. + consumerKey: + description: Immutable. Consumer key. type: string - description: The type of entity described - createdAt: + expiresInSeconds: format: int64 - description: >- - Time at which the API proxy was created, in milliseconds since - epoch. type: string - GoogleCloudApigeeV1ListDeploymentsResponse: - id: GoogleCloudApigeeV1ListDeploymentsResponse - type: object - properties: - deployments: - description: List of deployments. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' - GoogleCloudApigeeV1ProfileConfigAbuse: + description: >- + Immutable. Expiration time, in seconds, for the consumer key. If not + set or left to the default value of `-1`, the API key never expires. + The expiration time can't be updated after it is set. + id: GoogleCloudApigeeV1AppGroupAppKey type: object - properties: {} - id: GoogleCloudApigeeV1ProfileConfigAbuse description: >- - Checks for abuse, which includes any requests sent to the API for - purposes other than what it is intended for, such as high volumes of - requests, data scraping, and abuse related to authorization. - GoogleIamV1SetIamPolicyRequest: - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/GoogleIamV1Policy' - updateMask: - description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - format: google-fieldmask - type: string - id: GoogleIamV1SetIamPolicyRequest + AppGroupAppKey contains all the information associated with the + credentials. + GoogleCloudApigeeV1GetSyncAuthorizationRequest: + properties: {} + id: GoogleCloudApigeeV1GetSyncAuthorizationRequest type: object - description: Request message for `SetIamPolicy` method. - GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: - description: A sequence of time series. - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence + description: Request for GetSyncAuthorization. + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: + description: Request for BatchUpdateSecurityIncident. type: object + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest properties: - dimensions: - additionalProperties: - type: string - type: object - description: >- - Map of dimensions and their values that uniquely identifies a time - series sequence. - points: - description: List of points. First value of each inner list is a timestamp. - type: array + requests: items: - items: - type: any - type: array - GoogleCloudApigeeV1ProfileConfigMediation: - type: object + $ref: >- + #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest + type: array + description: >- + Optional. Required. The request message specifying the resources to + update. A maximum of 1000 can be modified in a batch. + GoogleCloudApigeeV1ProfileConfigMTLS: + description: Checks to see if you have configured mTLS for the target server. properties: {} - id: GoogleCloudApigeeV1ProfileConfigMediation - description: >- - By default, following policies will be included: - OASValidation - - SOAPMessageValidation - GoogleCloudApigeeV1RuntimeConfig: + type: object + id: GoogleCloudApigeeV1ProfileConfigMTLS + GoogleCloudApigeeV1SecurityIncident: + type: object properties: + displayName: + type: string + description: Optional. Display name of the security incident. + trafficCount: + type: string + format: int64 + description: Total traffic detected as part of the incident. name: + description: >- + Immutable. Name of the security incident resource. Format: + organizations/{org}/environments/{environment}/securityIncidents/{incident} + Example: + organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 type: string + lastObservabilityChangeTime: + type: string + readOnly: true + format: google-datetime description: >- - Name of the resource in the following format: - `organizations/{org}/runtimeConfig`. - traceBucket: - description: Cloud Storage bucket used for uploading Trace records. + Output only. The time when the incident observability was last + changed. + riskLevel: + enumDescriptions: + - Risk Level Unspecified. + - Risk level of the incident is low. + - Risk level of the incident is moderate. + - Risk level of the incident is severe. + enum: + - RISK_LEVEL_UNSPECIFIED + - LOW + - MODERATE + - SEVERE type: string - tenantProjectId: + description: Output only. Risk level of the incident. + readOnly: true + detectionTypes: + items: + type: string + type: array + readOnly: true + description: >- + Output only. Detection types which are part of the incident. + Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly + Detection. + observability: + enumDescriptions: + - The incident observability is unspecified. + - >- + The incident is currently active. Can change to this status from + archived. + - >- + The incident is currently archived and was archived by the + customer. + enum: + - OBSERVABILITY_UNSPECIFIED + - ACTIVE + - ARCHIVED type: string + description: Optional. Indicates if the user archived this incident. + lastDetectedTime: description: >- - Output only. Tenant project ID associated with the Apigee - organization. The tenant project is used to host Google-managed - resources that are dedicated to this Apigee organization. Clients - have limited access to resources within the tenant project used to - support Apigee runtime instances. Access to the tenant project is - managed using SetSyncAuthorization. It can be empty if the tenant - project hasn't been created yet. + Output only. The time when events associated with the incident were + last detected. readOnly: true - analyticsBucket: - description: Cloud Storage bucket used for uploading Analytics records. type: string - description: >- - Runtime configuration for the organization. Response for - GetRuntimeConfig. - id: GoogleCloudApigeeV1RuntimeConfig + format: google-datetime + firstDetectedTime: + readOnly: true + format: google-datetime + description: >- + Output only. The time when events associated with the incident were + first detected. + type: string + id: GoogleCloudApigeeV1SecurityIncident + description: Represents an SecurityIncident resource. + GoogleCloudApigeeV1AddonsConfig: + properties: + apiSecurityConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' + description: Configuration for the API Security add-on. + integrationConfig: + description: Configuration for the Integration add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' + analyticsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' + description: >- + Configuration for the Analytics add-on. Only used in + organizations.environments.addonsConfig. + advancedApiOpsConfig: + description: Configuration for the Advanced API Ops add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' + connectorsPlatformConfig: + description: Configuration for the Connectors Platform add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' + monetizationConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' + description: Configuration for the Monetization add-on. + id: GoogleCloudApigeeV1AddonsConfig + description: Add-on configurations for the Apigee organization. type: object - GoogleCloudApigeeV1EnvironmentConfig: - id: GoogleCloudApigeeV1EnvironmentConfig + GoogleCloudApigeeV1Deployment: properties: - resourceReferences: - description: List of resource references in the environment. + environment: + description: Environment. + type: string + pods: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' - deployments: + $ref: '#/components/schemas/GoogleCloudApigeeV1PodStatus' + description: >- + Status reported by runtime pods. **Note**: **This field is + deprecated**. Runtime versions 1.3 and above report instance level + status rather than pod status. + state: + enumDescriptions: + - This value should never be returned. + - Runtime has loaded the deployment. + - Deployment is not fully ready in the runtime. + - >- + Encountered an error with the deployment that requires + intervention. + enum: + - RUNTIME_STATE_UNSPECIFIED + - READY + - PROGRESSING + - ERROR + description: >- + Current state of the deployment. **Note**: This field is displayed + only when viewing deployment status. + type: string + routeConflicts: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' - description: List of deployments in the environment. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + description: >- + Conflicts in the desired state routing configuration. The presence + of conflicts does not cause the state to be `ERROR`, but it will + mean that some of the deployment's base paths are not routed to its + environment. If the conflicts change, the state will transition to + `PROGRESSING` until the latest configuration is rolled out to all + instances. **Note**: This field is displayed only when viewing + deployment status. type: array - pubsubTopic: + proxyDeploymentType: + enumDescriptions: + - >- + Default value till public preview. After public preview this value + should not be returned. + - >- + Deployment will be of type Standard if only Standard proxies are + used + - >- + Proxy will be of type Extensible if deployments uses one or more + Extensible proxies + readOnly: true + description: >- + Output only. The type of the deployment (standard or extensible) + Deployed proxy revision will be marked as extensible in following 2 + cases. 1. The deployed proxy revision uses extensible policies. 2. + If a environment supports flowhooks and flow hook is configured. type: string - description: Name of the PubSub topic for the environment. - sequenceNumber: - format: int64 - description: 'DEPRECATED: Use revision_id.' + enum: + - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + apiProxy: + description: API proxy. type: string - resources: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' - type: array - description: List of resource versions in the environment. - deploymentGroups: - description: List of deployment groups in the environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' - type: array - addonsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' - description: The latest runtime configurations for add-ons. - featureFlags: - type: object - additionalProperties: - type: string - description: Feature flags inherited from the organization and environment. - targets: + revision: + description: API proxy revision. + type: string + instances: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' description: >- - List of target servers in the environment. Disabled target servers - are not displayed. - dataCollectors: + Status reported by each runtime instance. **Note**: This field is + displayed only when viewing deployment status. + errors: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' - description: List of data collectors used by the deployments in the environment. + $ref: '#/components/schemas/GoogleRpcStatus' type: array - createTime: - format: google-datetime - description: Time that the environment configuration was created. - type: string - uid: - description: >- - Unique ID for the environment configuration. The ID will only change - if the environment is deleted and recreated. - type: string - gatewayConfigLocation: - type: string description: >- - The location for the gateway config blob as a URI, e.g. a Cloud - Storage URI. This is only used by Envoy-based gateways. - arcConfigLocation: + Errors reported for this deployment. Populated only when state == + ERROR. **Note**: This field is displayed only when viewing + deployment status. + deployStartTime: type: string description: >- - The location for the config blob of API Runtime Control, aka Envoy - Adapter, for op-based authentication as a URI, e.g. a Cloud Storage - URI. This is only used by Envoy-based gateways. - traceConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' - description: >- - Trace configurations. Contains config for the environment and config - overrides for specific API proxies. - debugMask: - description: Debug mask that applies to all deployments in the environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' - revisionId: - type: string + Time the API proxy was marked `deployed` in the control plane in + millisconds since epoch. format: int64 + serviceAccount: description: >- - Revision ID of the environment configuration. The higher the value, - the more recently the configuration was deployed. - provider: + The full resource name of Cloud IAM Service Account that this + deployment is using, eg, `projects/-/serviceAccounts/{email}`. + type: string + type: object + id: GoogleCloudApigeeV1Deployment + GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: + properties: + scorePath: type: string description: >- - Used by the Control plane to add context information to help detect - the source of the document during diagnostics and debugging. - envScopedRevisionId: - format: int64 + Optional. Return scores for this component. Example: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + description: >- + Filter scores by component path. Used custom filter instead of AIP-160 + as the use cases are highly constrained and predictable. + type: object + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + GoogleCloudApigeeV1AsyncQueryResult: + properties: + self: description: >- - Revision ID for environment-scoped resources (e.g. target servers, - keystores) in this config. This ID will increment any time a - resource not scoped to a deployment group changes. + Self link of the query results. Example: + `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + or following format if query is running at host level: + `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` type: string - keystores: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' - description: List of keystores in the environment. - type: array - flowhooks: + expires: + type: string + description: Query result will be unaccessable after this time. + type: object + id: GoogleCloudApigeeV1AsyncQueryResult + EdgeConfigstoreBundleBadBundle: + type: object + description: Describes why a bundle is invalid. Intended for use in error details. + properties: + violations: type: array - description: List of flow hooks in the environment. + description: Describes all precondition violations. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' - name: + $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' + id: EdgeConfigstoreBundleBadBundle + GoogleCloudApigeeV1EntityMetadata: + type: object + description: Metadata common to many entities in this API. + properties: + lastModifiedAt: + format: int64 type: string description: >- - Name of the environment configuration in the following format: - `organizations/{org}/environments/{env}/configs/{config}` - forwardProxyUri: - description: >- - The forward proxy's url to be used by the runtime. When set, runtime - will send requests to the target via the given forward proxy. This - is only used by programmable gateways. + Time at which the API proxy was most recently modified, in + milliseconds since epoch. + subType: + description: The type of entity described type: string - type: object - GoogleCloudApigeeV1ServiceIssuersMapping: + createdAt: + format: int64 + type: string + description: >- + Time at which the API proxy was created, in milliseconds since + epoch. + id: GoogleCloudApigeeV1EntityMetadata + GoogleIamV1TestIamPermissionsResponse: properties: - emailIds: + permissions: + type: array items: type: string - type: array - description: List of trusted issuer email ids. - service: - description: String indicating the Apigee service name. + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + description: Response message for `TestIamPermissions` method. + type: object + id: GoogleIamV1TestIamPermissionsResponse + GoogleCloudApigeeV1MetricAggregation: + id: GoogleCloudApigeeV1MetricAggregation + type: object + properties: + order: + enumDescriptions: + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. + description: >- + Ordering for this aggregation in the result. For time series this is + ignored since the ordering of points depends only on the timestamp, + not the values. + enum: + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING + type: string + aggregation: + enum: + - AGGREGATION_FUNCTION_UNSPECIFIED + - AVG + - SUM + - MIN + - MAX + - COUNT_DISTINCT + enumDescriptions: + - Unspecified Aggregation function. + - Average. + - Summation. + - Min. + - Max. + - Count distinct type: string - id: GoogleCloudApigeeV1ServiceIssuersMapping - type: object - GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: - type: object - id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse - properties: - scores: - description: List of scores. One score per day. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Score' - type: array - nextPageToken: - description: >- - A page token, received from a previous `ComputeScore` call. Provide - this to retrieve the subsequent page. + description: Aggregation function associated with the metric. + name: type: string - description: Response for ComputeEnvironmentScores. - GoogleCloudApigeeV1DeveloperBalance: + description: Name of the metric + description: The optionally aggregated metric to query with its ordering. + GoogleCloudApigeeV1ApiDocDocumentation: + id: GoogleCloudApigeeV1ApiDocDocumentation properties: - wallets: - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' - description: >- - Output only. List of all wallets. Each individual wallet stores the - account balance for a particular currency. - type: array + graphqlDocumentation: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' + description: Optional. GraphQL documentation. + oasDocumentation: + $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' + description: Optional. OpenAPI Specification documentation. + description: The documentation for a catalog item. type: object - id: GoogleCloudApigeeV1DeveloperBalance - description: Account balance for the developer. - GoogleCloudApigeeV1SecurityProfileEnvironment: + GoogleCloudApigeeV1NatAddress: type: object + id: GoogleCloudApigeeV1NatAddress description: >- - Environment information of attached environments. Scoring an environment - is enabled only if it is attached to a security profile. - id: GoogleCloudApigeeV1SecurityProfileEnvironment + Apigee NAT(network address translation) address. A NAT address is a + static external IP address used for Internet egress traffic. properties: - attachTime: - type: string - format: google-datetime - readOnly: true - description: >- - Output only. Time at which environment was attached to the security - profile. - environment: + name: + description: Required. Resource ID of the NAT address. type: string - description: Output only. Name of the environment. + ipAddress: readOnly: true - GoogleCloudApigeeV1FlowHookConfig: - properties: - continueOnError: - description: >- - Flag that specifies whether the flow should abort after an error in - the flow hook. Defaults to `true` (continue on error). - type: boolean - name: type: string - description: >- - Name of the flow hook in the following format: - `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid - `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, - `PreTargetFlowHook`, and `PostTargetFlowHook` - sharedFlowName: + description: Output only. The static IPV4 address. + state: type: string - description: >- - Name of the shared flow to invoke in the following format: - `organizations/{org}/sharedflows/{sharedflow}` - type: object - id: GoogleCloudApigeeV1FlowHookConfig - GoogleCloudApigeeV1ApiDoc: - id: GoogleCloudApigeeV1ApiDoc + readOnly: true + description: Output only. State of the nat address. + enumDescriptions: + - The resource is in an unspecified state. + - The NAT address is being created. + - The NAT address is reserved but not yet used for Internet egress. + - The NAT address is active and used for Internet egress. + - The NAT address is being deleted. + enum: + - STATE_UNSPECIFIED + - CREATING + - RESERVED + - ACTIVE + - DELETING + GoogleCloudApigeeV1Reference: + id: GoogleCloudApigeeV1Reference type: object properties: - graphqlEndpointUrl: - type: string - deprecated: true - description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - anonAllowed: - type: boolean - description: >- - Optional. Boolean flag that manages user access to the catalog item. - When true, the catalog item has public visibility and can be viewed - anonymously; otherwise, only registered users may view it. Note: - when the parent portal is enrolled in the [audience management - feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), - and this flag is set to false, visibility is set to an indeterminate - state and must be explicitly specified in the management UI (see - [Manage the visibility of an API in your - portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). - Additionally, when enrolled in the audience management feature, - updates to this flag will be ignored as visibility permissions must - be updated in the management UI. - apiProductName: - description: >- - Required. Immutable. The `name` field of the associated [API - product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). - A portal may have only one catalog item associated with a given API - product. - type: string - requireCallbackUrl: - description: >- - Optional. Whether a callback URL is required when this catalog - item's API product is enabled in a developer app. When true, a - portal user will be required to input a URL when managing the app - (this is typically used for the app's OAuth flow). - type: boolean - siteId: - description: Output only. The ID of the parent portal. + description: + description: Optional. A human-readable description of this reference. type: string - readOnly: true - title: + name: description: >- - Required. The user-facing name of the catalog item. `title` must be - a non-empty string with a max length of 255 characters. + Required. The resource id of this reference. Values must match the + regular expression [\w\s\-.]+. type: string - description: + refers: description: >- - Optional. Description of the catalog item. Max length is 10,000 - characters. + Required. The id of the resource to which this reference refers. + Must be the id of a resource that exists in the parent environment + and is of the given resource_type. type: string - graphqlSchema: + resourceType: type: string description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - deprecated: true - modified: - description: >- - Output only. Time the catalog item was last modified in milliseconds - since epoch. - readOnly: true - format: int64 - type: string - graphqlSchemaDisplayName: + The type of resource referred to by this reference. Valid values are + 'KeyStore' or 'TrustStore'. + description: >- + A Reference configuration. References must refer to a keystore that also + exists in the parent environment. + GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: + properties: + nextPageToken: type: string - deprecated: true description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - published: + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + securityProfiles: + type: array description: >- - Optional. Denotes whether the catalog item is published to the - portal or is in a draft state. When the parent portal is enrolled in - the [audience management - feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), - the visibility can be set to public on creation by setting the - anonAllowed flag to true or further managed in the management UI - (see [Manage the visibility of an API in your - portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) - before it can be visible to any users. If not enrolled in the - audience management feature, the visibility is managed by the - `anonAllowed` flag. - type: boolean - id: - description: Output only. The ID of the catalog item. - format: int64 - readOnly: true + List of security profile revisions. The revisions may be attached or + unattached to any environment. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + description: Response for ListSecurityProfileRevisions. + type: object + id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: + type: object + properties: + name: type: string - imageUrl: + description: Required. Name of this resource. + type: + enum: + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY type: string + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. + description: Required. Type of this resource. + description: Resource for which we are computing security assessment. + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + GoogleCloudApigeeV1EnvironmentConfig: + properties: + envScopedRevisionId: description: >- - Optional. Location of the image used for the catalog item in the - catalog. This can be either an image with an external URL or a file - path for [image files stored in the - portal](/apigee/docs/api-platform/publish/portal/portal-files"), for - example, `/files/book-tree.jpg`. When specifying the URL of an - external image, the image won't be uploaded to your assets; - additionally, loading the image in the integrated portal will be - subject to its availability, which may be blocked or restricted by - [content security - policies](/apigee/docs/api-platform/publish/portal/csp). Max length - of file path is 2,083 characters. - specId: - deprecated: true + Revision ID for environment-scoped resources (e.g. target servers, + keystores) in this config. This ID will increment any time a + resource not scoped to a deployment group changes. type: string - description: 'Optional. DEPRECATED: DO NOT USE' - visibility: - description: 'Optional. DEPRECATED: use the `published` field instead' - type: boolean - edgeAPIProductName: + format: int64 + resourceReferences: + description: List of resource references in the environment. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' + provider: + description: >- + Used by the Control plane to add context information to help detect + the source of the document during diagnostics and debugging. type: string + targets: description: >- - Optional. Immutable. DEPRECATED: use the `apiProductName` field - instead - categoryIds: + List of target servers in the environment. Disabled target servers + are not displayed. items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' type: array + name: + type: string description: >- - Optional. The IDs of the API categories to which this catalog item - belongs. - description: >- - `ApiDoc` represents an API catalog item. Catalog items are used in two - ways in a portal: - Users can browse and interact with a visual - representation of the API documentation - The `api_product_name` field - provides a link to a backing [API product] - (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). - Through this link, portal users can create and manage developer apps - linked to one or more API products. - GoogleCloudApigeeV1TlsInfoConfig: - properties: - protocols: + Name of the environment configuration in the following format: + `organizations/{org}/environments/{env}/configs/{config}` + createTime: + type: string + format: google-datetime + description: Time that the environment configuration was created. + addonsConfig: + description: The latest runtime configurations for add-ons. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' + forwardProxyUri: + description: >- + The forward proxy's url to be used by the runtime. When set, runtime + will send requests to the target via the given forward proxy. This + is only used by programmable gateways. + type: string + deploymentGroups: + description: List of deployment groups in the environment. type: array items: - type: string - description: List of TLS protocols that are granted access. - ciphers: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' + deployments: + description: List of deployments in the environment. items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' + type: array + featureFlags: + additionalProperties: type: string - description: List of ciphers that are granted access. + type: object + description: Feature flags inherited from the organization and environment. + resources: + description: List of resource versions in the environment. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' type: array - clientAuthEnabled: - type: boolean + arcConfigLocation: + type: string description: >- - Flag that specifies whether client-side authentication is enabled - for the target server. Enables two-way TLS. - enabled: - type: boolean + The location for the config blob of API Runtime Control, aka Envoy + Adapter, for op-based authentication as a URI, e.g. a Cloud Storage + URI. This is only used by Envoy-based gateways. + gatewayConfigLocation: description: >- - Flag that specifies whether one-way TLS is enabled. Set to `true` to - enable one-way TLS. - ignoreValidationErrors: - type: boolean + The location for the gateway config blob as a URI, e.g. a Cloud + Storage URI. This is only used by Envoy-based gateways. + type: string + revisionId: + format: int64 + type: string description: >- - Flag that specifies whether to ignore TLS certificate validation - errors. Set to `true` to ignore errors. - keyAlias: + Revision ID of the environment configuration. The higher the value, + the more recently the configuration was deployed. + sequenceNumber: + description: 'DEPRECATED: Use revision_id.' + format: int64 + type: string + keystores: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' + description: List of keystores in the environment. + debugMask: + description: Debug mask that applies to all deployments in the environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + traceConfig: description: >- - Name of the alias used for client-side authentication in the - following format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` + Trace configurations. Contains config for the environment and config + overrides for specific API proxies. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' + dataCollectors: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' + description: List of data collectors used by the deployments in the environment. + type: array + flowhooks: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' + type: array + description: List of flow hooks in the environment. + pubsubTopic: type: string - commonName: - $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' - description: Common name to validate the target server against. - keyAliasReference: - description: Reference name and alias pair to use for client-side authentication. - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' - enforce: - description: Flag that enforces TLS settings - type: boolean - trustStore: + description: Name of the PubSub topic for the environment. + uid: type: string description: >- - Name of the keystore or keystore reference containing trusted - certificates for the server in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` or - `organizations/{org}/environments/{env}/references/{reference}` + Unique ID for the environment configuration. The ID will only change + if the environment is deleted and recreated. + id: GoogleCloudApigeeV1EnvironmentConfig type: object - id: GoogleCloudApigeeV1TlsInfoConfig - GoogleCloudApigeeV1GrpcOperationConfig: + GoogleCloudApigeeV1Operation: + description: >- + Represents the pairing of REST resource path and the actions (verbs) + allowed on the resource path. properties: methods: + description: >- + methods refers to the REST verbs as in + https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none + specified, all verb types are allowed. items: type: string type: array + resource: description: >- - List of unqualified gRPC method names for the proxy to which quota - will be applied. If this field is empty, the Quota will apply to all - operations on the gRPC service defined on the proxy. Example: Given - a proxy that is configured to serve com.petstore.PetService, the - methods com.petstore.PetService.ListPets and - com.petstore.PetService.GetPet would be specified here as simply - ["ListPets", "GetPet"]. - apiSource: - type: string - description: >- - Required. Name of the API proxy with which the gRPC operation and - quota are associated. - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' - description: >- - Quota parameters to be enforced for the methods and API source - combination. If none are specified, quota enforcement will not be - done. - attributes: - type: array - description: Custom attributes associated with the operation. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - service: + Required. REST resource path associated with the API proxy or remote + service. type: string - description: >- - Required. gRPC Service name associated to be associated with the API - proxy, on which quota rules can be applied upon. - description: >- - Binds the resources in a proxy or remote service with the gRPC operation - and its associated quota enforcement. - id: GoogleCloudApigeeV1GrpcOperationConfig - type: object - GoogleCloudApigeeV1MonetizationConfig: - id: GoogleCloudApigeeV1MonetizationConfig - properties: - enabled: - type: boolean - description: Flag that specifies whether the Monetization add-on is enabled. + id: GoogleCloudApigeeV1Operation type: object - description: Configuration for the Monetization add-on. - GoogleCloudApigeeV1Attributes: - id: GoogleCloudApigeeV1Attributes + GoogleCloudApigeeV1SecurityProfile: type: object properties: - attribute: - description: List of attributes. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - GoogleCloudApigeeV1DeploymentConfig: - properties: - endpoints: - additionalProperties: - type: string - description: >- - A mapping from basepaths to proxy endpoint names in this proxy. Not - populated for shared flows. - type: object - serviceAccount: + revisionId: type: string + description: Output only. Revision ID of the security profile. + readOnly: true + format: int64 + minScore: + readOnly: true + type: integer description: >- - The service account identity associated with this deployment. If - non-empty, will be in the following format: - `projects/-/serviceAccounts/{account_email}` - location: + Output only. Minimum security score that can be generated by this + profile. + format: int32 + displayName: type: string - description: Location of the API proxy bundle as a URI. - attributes: - type: object - description: Additional key-value metadata for the deployment. - additionalProperties: - type: string - proxyUid: + deprecated: true + description: 'DEPRECATED: DO NOT USE Display name of the security profile.' + scoringConfigs: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig + description: List of profile scoring configs in this revision. + environments: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' + description: List of environments attached to security profile. + type: array + revisionUpdateTime: type: string - description: Unique ID of the API proxy revision. - uid: + description: Output only. The time when revision was updated. + readOnly: true + format: google-datetime + name: + type: string + description: >- + Immutable. Name of the security profile resource. Format: + organizations/{org}/securityProfiles/{profile} + profileConfig: + description: >- + Required. Customized profile configuration that computes the + security score. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' + revisionPublishTime: type: string + deprecated: true + format: google-datetime description: >- - Unique ID. The ID will only change if the deployment is deleted and - recreated. - name: + Output only. DEPRECATED: DO NOT USE The time when revision was + published. Once published, the security profile revision cannot be + updated further and can be attached to environments. + readOnly: true + maxScore: + readOnly: true description: >- - Name of the API or shared flow revision to be deployed in the - following format: `organizations/{org}/apis/{api}/revisions/{rev}` - or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` + Output only. Maximum security score that can be generated by this + profile. + type: integer + format: int32 + revisionCreateTime: type: string - deploymentGroups: - items: - type: string - description: >- - The list of deployment groups in which this proxy should be - deployed. Not currently populated for shared flows. - type: array - basePath: - description: Base path where the application will be hosted. Defaults to "/". + format: google-datetime + readOnly: true + description: Output only. The time when revision was created. + description: + description: Description of the security profile. type: string - description: 'NEXT ID: 11' - id: GoogleCloudApigeeV1DeploymentConfig - type: object - GoogleTypeInterval: + id: GoogleCloudApigeeV1SecurityProfile + description: Represents a SecurityProfile resource. + GoogleIamV1SetIamPolicyRequest: properties: - startTime: + updateMask: + format: google-fieldmask 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 - type: string - endTime: + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` type: string + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. - format: google-datetime - id: GoogleTypeInterval - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + id: GoogleIamV1SetIamPolicyRequest type: object - GoogleCloudApigeeV1QueryTabularStatsResponse: - id: GoogleCloudApigeeV1QueryTabularStatsResponse + description: Request message for `SetIamPolicy` method. + GoogleCloudApigeeV1CustomReportMetric: + id: GoogleCloudApigeeV1CustomReportMetric + type: object + description: >- + This encapsulates a metric property of the form sum(message_count) where + name is message_count and function is sum properties: - nextPageToken: - description: Next page token. + function: type: string - columns: + description: aggregate function + name: + type: string + description: name of the metric + GoogleCloudApigeeV1DebugMask: + id: GoogleCloudApigeeV1DebugMask + type: object + properties: + variables: type: array items: type: string - description: >- - Column names corresponding to the same order as the inner values in - the stats field. - values: - description: Resultant rows from the executed query. - items: - items: - type: any - type: array - type: array - description: >- - Encapsulates two kinds of stats that are results of the dimensions and - aggregations requested. - Tabular rows. - Time series data. Example of - tabular rows, Represents security stats results as a row of flat values. - type: object - GoogleCloudApigeeV1ApiProxyRevision: - id: GoogleCloudApigeeV1ApiProxyRevision - type: object - properties: - targetServers: + description: List of variables that should be masked from the debug output. + faultJSONPaths: items: type: string type: array description: >- - List of TargetServers referenced in any TargetEndpoint in the API - proxy. Typically, you will see this element only when the API proxy - was created using the Edge UI. This is a 'manifest' setting designed - to provide visibility into the contents of the API proxy. - archive: - type: string - readOnly: true - description: >- - Output only. The archive that generated this proxy revision. This - field is only present on proxy revisions that were generated by an - archive. Proxies generated by archives cannot be updated, deleted, - or deployed to other environments. Format: - `organizations/*/environments/*/archiveDeployments/*` - proxyEndpoints: + List of JSON paths that specify the JSON elements to be filtered + from JSON payloads in error flows. + requestJSONPaths: type: array description: >- - List of ProxyEndpoints in the `/proxies` directory of the API proxy. - Typically, this element is included only when the API proxy was - created using the Edge UI. This is a 'manifest' setting designed to - provide visibility into the contents of the API proxy. + List of JSON paths that specify the JSON elements to be filtered + from JSON request message payloads. items: type: string - sharedFlows: - description: List of the shared flows included in the API proxy revision. + name: + description: Name of the debug mask. + type: string + namespaces: + type: object + additionalProperties: + type: string + description: Map of namespaces to URIs. + faultXPaths: + description: >- + List of XPaths that specify the XML elements to be filtered from XML + payloads in error flows. + type: array items: type: string + responseXPaths: type: array - entityMetaDataAsProperties: - additionalProperties: + description: >- + List of XPaths that specify the XML elements to be filtered from XML + response message payloads. + items: type: string - type: object - description: Metadata describing the API proxy revision as a key-value map. - targetEndpoints: + responseJSONPaths: description: >- - List of TargetEndpoints in the `/targets` directory of the API - proxy. Typically, this element is included only when the API proxy - was created using the Edge UI. This is a 'manifest' setting designed - to provide visibility into the contents of the API proxy. + List of JSON paths that specify the JSON elements to be filtered + from JSON response message payloads. items: type: string type: array - targets: + requestXPaths: + description: >- + List of XPaths that specify the XML elements to be filtered from XML + request message payloads. + type: array items: type: string - description: List of the targets included in the API proxy revision. + GoogleCloudApigeeV1ListDebugSessionsResponse: + id: GoogleCloudApigeeV1ListDebugSessionsResponse + properties: + nextPageToken: + type: string + description: >- + Page token that you can include in a ListDebugSessionsRequest to + retrieve the next page. If omitted, no subsequent pages exist. + sessions: + description: >- + Session info that includes debug session ID and the first + transaction creation timestamp. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Session' type: array - createdAt: - format: int64 + type: object + GoogleCloudApigeeV1UpdateSecurityIncidentRequest: + id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest + type: object + properties: + updateMask: + description: >- + Required. The list of fields to update. Allowed fields are: + LINT.IfChange(allowed_update_fields_comment) - observability + LINT.ThenChange() type: string + format: google-fieldmask + securityIncident: description: >- - Time that the API proxy revision was created in milliseconds since - epoch. - lastModifiedAt: - format: int64 + Required. The security incident to update. Must contain all existing + populated fields of the current incident. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + description: Request for UpdateSecurityIncident. + GoogleCloudApigeeV1ProfileConfig: + description: >- + ProfileConfig defines a set of categories and policies which will be + used to compute security score. + id: GoogleCloudApigeeV1ProfileConfig + properties: + categories: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' + type: array + description: List of categories of profile config. + type: object + GoogleCloudApigeeV1ListEndpointAttachmentsResponse: + properties: + nextPageToken: type: string description: >- - Time that the API proxy revision was last modified in milliseconds - since epoch. - teams: + Page token that you can include in an `ListEndpointAttachments` + request to retrieve the next page. If omitted, no subsequent pages + exist. + endpointAttachments: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + type: array + description: Endpoint attachments in the specified organization. + description: Response for ListEndpointAttachments method. + type: object + id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse + GoogleCloudApigeeV1ApiProxy: + type: object + id: GoogleCloudApigeeV1ApiProxy + description: Metadata describing the API proxy + properties: + metaData: + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + readOnly: true + description: Output only. Metadata describing the API proxy. + revision: + description: Output only. List of revisions defined for the API proxy. + readOnly: true items: type: string - description: List of the teams included in the API proxy revision. type: array name: - description: Name of the API proxy. - type: string - resourceFiles: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - description: List of resource files included in the API proxy revision. - type: - description: >- - Type. Set to `Application`. Maintained for compatibility with the - Apigee Edge API. + description: Output only. Name of the API proxy. type: string - integrationEndpoints: - items: + readOnly: true + labels: + description: User labels applied to this API Proxy. + type: object + additionalProperties: type: string - type: array + readOnly: + type: boolean description: >- - List of IntegrationEndpoints in the '/integration-endpoints' - directory of the API proxy. This is a 'manifest' setting designed to - provide visibility into the contents of the API proxy. - contextInfo: - description: Revision number, app name, and organization for the API proxy. - type: string - proxies: - description: List of proxy names included in the API proxy revision. - type: array - items: - type: string - revision: - description: API proxy revision. + Output only. Whether this proxy is read-only. A read-only proxy + cannot have new revisions created through calls to + CreateApiProxyRevision. A proxy is read-only if it was generated by + an archive. + readOnly: true + apiProxyType: + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + readOnly: true + description: Output only. The type of the API proxy. + enumDescriptions: + - API proxy type not specified. + - >- + Programmable API Proxies enable you to develop APIs with highly + flexible behavior using bundled policy configuration and one or + more programming languages to describe complex sequential and/or + conditional flows of logic. + - >- + Configurable API Proxies enable you to develop efficient APIs + using simple configuration while complex execution control flow + logic is handled by Apigee. This type only works with the ARCHIVE + deployment type and cannot be combined with the PROXY deployment + type. type: string - basepaths: - description: Base URL of the API proxy. - type: array - items: - type: string - description: - description: Description of the API proxy revision. + latestRevisionId: type: string - configurationVersion: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' - description: >- - Version of the API proxy configuration schema to which the API proxy - conforms. Currently, the only supported value is 4.0 - (`majorVersion.minorVersion`). This setting may be used in the - future to track the evolution of the API proxy format. - hasExtensiblePolicy: readOnly: true - type: boolean description: >- - Output only. This field will be marked as true if revision contains - any policies marked as extensible. - resources: + Output only. The id of the most recently created revision for this + api proxy. + GoogleCloudApigeeV1Attributes: + type: object + properties: + attribute: type: array - description: >- - List of the resources included in the API proxy revision formatted - as "{type}://{name}". + description: List of attributes. items: - type: string - displayName: - description: Human-readable name of the API proxy. - type: string - spec: - description: >- - OpenAPI Specification that is associated with the API proxy. The - value is set to a URL or to a path in the specification store. - type: string - policies: - description: List of policy names included in the API proxy revision.. + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + id: GoogleCloudApigeeV1Attributes + GoogleCloudApigeeV1ProfileConfigMediation: + description: >- + By default, following policies will be included: - OASValidation - + SOAPMessageValidation + id: GoogleCloudApigeeV1ProfileConfigMediation + type: object + properties: {} + GoogleRpcPreconditionFailure: + description: >- + Describes what preconditions have failed. For example, if an RPC failed + because it required the Terms of Service to be acknowledged, it could + list the terms of service violation in the PreconditionFailure message. + id: GoogleRpcPreconditionFailure + properties: + violations: items: - type: string + $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' + description: Describes all precondition violations. type: array - description: API proxy revision. - GoogleCloudApigeeV1EnableSecurityActionRequest: - properties: {} - description: Message to enable a disabled SecurityAction. - id: GoogleCloudApigeeV1EnableSecurityActionRequest type: object - GoogleCloudApigeeV1ListDataCollectorsResponse: + GoogleCloudApigeeV1GrpcOperationConfig: + description: >- + Binds the resources in a proxy or remote service with the gRPC operation + and its associated quota enforcement. properties: - nextPageToken: + attributes: + description: Custom attributes associated with the operation. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + apiSource: type: string description: >- - Page token that you can include in a ListDataCollectors request to - retrieve the next page. If omitted, no subsequent pages exist. - dataCollectors: - type: array - description: Data collectors in the specified organization. + Required. Name of the API proxy with which the gRPC operation and + quota are associated. + methods: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' - description: Response for ListDataCollectors. + type: string + type: array + description: >- + List of unqualified gRPC method names for the proxy to which quota + will be applied. If this field is empty, the Quota will apply to all + operations on the gRPC service defined on the proxy. Example: Given + a proxy that is configured to serve com.petstore.PetService, the + methods com.petstore.PetService.ListPets and + com.petstore.PetService.GetPet would be specified here as simply + ["ListPets", "GetPet"]. + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + description: >- + Quota parameters to be enforced for the methods and API source + combination. If none are specified, quota enforcement will not be + done. + service: + type: string + description: >- + Required. gRPC Service name associated to be associated with the API + proxy, on which quota rules can be applied upon. + id: GoogleCloudApigeeV1GrpcOperationConfig type: object - id: GoogleCloudApigeeV1ListDataCollectorsResponse - GoogleCloudApigeeV1OptimizedStats: + GoogleCloudApigeeV1ListOrganizationsResponse: + id: GoogleCloudApigeeV1ListOrganizationsResponse type: object properties: - Response: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' - description: >- - Wraps the `stats` response for JavaScript Optimized Scenario with a - response key. For example: ```{ "Response": { "TimeUnit": [], - "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table - used: edge.api.aaxgroup001.agg_api", "PG - Host:ruappg08-ro.production.apigeeks.net", "query served - by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": - false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" - ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": - "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": - "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` - id: GoogleCloudApigeeV1OptimizedStats - GoogleCloudApigeeV1Metadata: - properties: - notices: - description: >- - List of additional information such as data source, if result was - truncated. For example: ``` "notices": [ "Source:Postgres", "PG - Host:uappg0rw.e2e.apigeeks.net", "query served - by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: - edge.api.uapgroup2.agg_api" ]``` - type: array - items: - type: string - errors: + organizations: items: - type: string - description: List of error messages as strings. + $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' + description: List of Apigee organizations and associated Google Cloud projects. type: array + GoogleCloudApigeeV1AsyncQuery: type: object - description: Encapsulates additional information about query execution. - id: GoogleCloudApigeeV1Metadata - GoogleCloudApigeeV1CanaryEvaluation: - id: GoogleCloudApigeeV1CanaryEvaluation - description: >- - CanaryEvaluation represents the canary analysis between two versions of - the runtime that is serving requests. properties: - startTime: + updated: type: string - description: Required. Start time for the canary evaluation's analysis. - format: google-datetime - endTime: + description: Last updated timestamp for the query. + resultRows: type: string - description: Required. End time for the evaluation's analysis. - format: google-datetime - control: + description: ResultRows is available only after the query is completed. + format: int64 + reportDefinitionId: + type: string + description: Asynchronous Report ID. + envgroupHostname: + type: string + description: Hostname is available only when query is executed at host level. + created: + description: Creation time of the query. + type: string + name: + type: string + description: Asynchronous Query Name. + resultFileSize: + type: string + description: ResultFileSize is available only after the query is completed. + self: type: string - description: Required. The stable version that is serving requests. - metricLabels: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' description: >- - Required. Labels used to filter the metrics used for a canary - evaluation. - createTime: - description: Output only. Create time of the canary evaluation. - format: google-datetime - readOnly: true + Self link of the query. Example: + `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + or following format if query is running at host level: + `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + executionTime: + description: ExecutionTime is available only after the query is completed. type: string - treatment: - description: Required. The newer version that is serving requests. + queryParams: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' + description: >- + Contains information like metrics, dimenstions etc of the + AsyncQuery. + error: type: string - name: + description: Error is set when query fails. + state: type: string - readOnly: true - description: Output only. Name of the canary evalution. - verdict: + description: Query state could be "enqueued", "running", "completed", "failed". + result: + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' + description: Result is available only after the query is completed. + id: GoogleCloudApigeeV1AsyncQuery + GoogleCloudApigeeV1ApiDocResponse: + description: The catalog item resource wrapped with response status, error_code, etc. + properties: + requestId: + description: Unique ID of the request. type: string - enumDescriptions: - - Verdict is not available yet. - - No verdict reached. - - Evaluation is not good. - - Evaluation is good. - description: >- - Output only. The resulting verdict of the canary evaluations: NONE, - PASS, or FAIL. - enum: - - VERDICT_UNSPECIFIED - - NONE - - FAIL - - PASS - readOnly: true - state: - enum: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED - readOnly: true + errorCode: type: string - enumDescriptions: - - No state has been specified. - - The canary evaluation is still in progress. - - The canary evaluation has finished. - description: Output only. The current state of the canary evaluation. + description: Unique error code for the request, if any. + status: + type: string + description: Status of the operation. + message: + type: string + description: Description of the operation. + data: + description: The catalog item resource. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' type: object - GoogleCloudApigeeV1EnvironmentGroupAttachment: + id: GoogleCloudApigeeV1ApiDocResponse + GoogleCloudApigeeV1KeyValueEntry: description: >- - EnvironmentGroupAttachment is a resource which defines an attachment of - an environment to an environment group. + Key value map pair where the value represents the data associated with + the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and + higher. properties: - createdAt: - type: string - readOnly: true - format: int64 + value: description: >- - Output only. The time at which the environment group attachment was - created as milliseconds since epoch. - environmentGroupId: - type: string - description: Output only. ID of the environment group. - readOnly: true - environment: + Required. Data or payload that is being retrieved and associated + with the unique key. type: string - description: Required. ID of the attached environment. name: + description: >- + Resource URI that can be used to identify the scope of the key value + map entries. type: string - description: ID of the environment group attachment. type: object - id: GoogleCloudApigeeV1EnvironmentGroupAttachment - GoogleCloudApigeeV1SecurityAction: + id: GoogleCloudApigeeV1KeyValueEntry + GoogleCloudApigeeV1GraphqlDocumentation: + id: GoogleCloudApigeeV1GraphqlDocumentation type: object properties: - apiProxies: - type: array - items: - type: string + schema: + description: Required. The documentation file contents for the GraphQL schema. + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' + endpointUri: description: >- - Optional. If unset, this would apply to all proxies in the - environment. If set, this action is enforced only if at least one - proxy in the repeated list is deployed at the time of enforcement. - If set, several restrictions are enforced on SecurityActions. There - can be at most 100 enabled actions with proxies set in an env. - Several other restrictions apply on conditions and are detailed - later. - createTime: - readOnly: true - description: Output only. The create time for this SecurityAction. - format: google-datetime - type: string - updateTime: + Required. The GraphQL endpoint URI to be queried by API consumers. + Max length is 2,083 characters. type: string - format: google-datetime - description: >- - Output only. The update time for this SecurityAction. This reflects - when this SecurityAction changed states. + description: GraphQL documentation for a catalog item. + GoogleCloudApigeeV1ApiDocDocumentationResponse: + type: object + properties: + data: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' readOnly: true - name: - description: >- - Immutable. This field is ignored during creation as per AIP-133. - Please set the `security_action_id` field in the - CreateSecurityActionRequest when creating a new SecurityAction. - Format: - organizations/{org}/environments/{env}/securityActions/{security_action} - type: string - description: + description: Output only. The documentation resource. + status: + readOnly: true + description: Output only. Status of the operation. type: string - description: >- - Optional. An optional user provided description of the - SecurityAction. - conditionConfig: - description: >- - Required. A valid SecurityAction must contain at least one - condition. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig - deny: - description: Deny a request through if it matches this SecurityAction. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' - state: - enumDescriptions: - - >- - The default value. This only exists for forward compatibility. A - create request with this value will be rejected. - - >- - An ENABLED SecurityAction is actively enforced if the - `expiration_time` is in the future. - - A disabled SecurityAction is never enforced. + message: + readOnly: true type: string - enum: - - STATE_UNSPECIFIED - - ENABLED - - DISABLED - description: >- - Required. Only an ENABLED SecurityAction is enforced. An ENABLED - SecurityAction past its expiration time will not be enforced. - ttl: + description: Output only. Description of the operation. + requestId: type: string - format: google-duration - description: Input only. The TTL for this SecurityAction. - allow: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' - description: Allow a request through if it matches this SecurityAction. - flag: - description: Flag a request through if it matches this SecurityAction. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' - expireTime: - description: The expiration for this SecurityAction. - format: google-datetime + readOnly: true + description: Output only. Unique ID of the request. + errorCode: + description: Output only. Unique error code for the request, if any. type: string + readOnly: true + id: GoogleCloudApigeeV1ApiDocDocumentationResponse description: >- - A SecurityAction is rule that can be enforced at an environment level. - The result is one of: - A denied API call - An explicitly allowed API - call - A flagged API call (HTTP headers added before the target receives - it) At least one condition is required to create a SecurityAction. - id: GoogleCloudApigeeV1SecurityAction + The catalog item documentation wrapped with response status, error_code, + etc. GoogleCloudApigeeV1KeyAliasReference: + id: GoogleCloudApigeeV1KeyAliasReference properties: reference: description: >- @@ -8577,155 +8490,248 @@ components: aliasId: description: Alias ID. Must exist in the keystore referred to by the reference. type: string - id: GoogleCloudApigeeV1KeyAliasReference - type: object - GoogleCloudApigeeV1GenerateDownloadUrlResponse: - description: Response for GenerateDownloadUrl method. - properties: - downloadUri: - description: >- - The Google Cloud Storage signed URL that can be used to download the - Archive zip file. - type: string - type: object - id: GoogleCloudApigeeV1GenerateDownloadUrlResponse - GoogleCloudApigeeV1ListAppGroupAppsResponse: - description: Response for ListAppGroupApps - properties: - nextPageToken: - description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - appGroupApps: - type: array - description: List of AppGroup apps and their credentials. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' - id: GoogleCloudApigeeV1ListAppGroupAppsResponse - type: object - GoogleCloudApigeeV1InstanceDeploymentStatus: type: object + GoogleCloudApigeeV1EnvironmentGroupAttachment: + description: >- + EnvironmentGroupAttachment is a resource which defines an attachment of + an environment to an environment group. properties: - deployedRoutes: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + createdAt: + format: int64 description: >- - Current routes deployed in the ingress routing table. A route which - is missing will appear in `missing_routes`. - type: array - instance: - type: string - description: ID of the instance reporting the status. - deployedRevisions: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision - type: array - description: Revisions currently deployed in MPs. - id: GoogleCloudApigeeV1InstanceDeploymentStatus - description: The status of a deployment as reported by a single instance. - GoogleCloudApigeeV1ListApiCategoriesResponse: - description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' - properties: - status: - description: Status of the operation. + Output only. The time at which the environment group attachment was + created as milliseconds since epoch. + readOnly: true type: string - requestId: - description: Unique ID of the request. + environment: + description: Required. ID of the attached environment. type: string - message: - description: Description of the operation. + environmentGroupId: type: string - errorCode: + readOnly: true + description: Output only. ID of the environment group. + name: type: string - description: Unique error code for the request, if any. - data: + description: ID of the environment group attachment. + id: GoogleCloudApigeeV1EnvironmentGroupAttachment + type: object + GoogleCloudApigeeV1ListTraceConfigOverridesResponse: + id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse + description: Response for ListTraceConfigOverrides. + properties: + traceConfigOverrides: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - description: The API category resources. + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + description: List all trace configuration overrides in an environment. type: array + nextPageToken: + description: >- + Token value that can be passed as `page_token` to retrieve the next + page of content. + type: string type: object - id: GoogleCloudApigeeV1ListApiCategoriesResponse - GoogleCloudApigeeV1Credential: + GoogleCloudApigeeV1AppGroupApp: + id: GoogleCloudApigeeV1AppGroupApp type: object - id: GoogleCloudApigeeV1Credential properties: - consumerSecret: - description: Secret key. + attributes: + description: List of attributes for the AppGroup app. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + createdAt: type: string - consumerKey: + readOnly: true + format: int64 + description: >- + Output only. Time the AppGroup app was created in milliseconds since + epoch. + callbackUrl: type: string - description: Consumer key. + description: >- + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to AppGroup apps. apiProducts: - type: array - description: List of API products this credential can be used for. + description: List of API products associated with the AppGroup app. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + type: string + type: array scopes: - description: >- - List of scopes to apply to the app. Specified scopes must already - exist on the API product that you associate with the app. type: array + description: >- + Scopes to apply to the AppGroup app. The specified scopes must + already exist for the API product that you associate with the + AppGroup app. items: type: string + appGroup: + description: >- + Immutable. Name of the parent AppGroup whose resource name format is + of syntax (organizations/*/appgroups/*). + type: string status: type: string + description: Status of the App. Valid values include `approved` or `revoked`. + keyExpiresIn: description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - expiresAt: - description: Time the credential will expire in milliseconds since epoch. + Immutable. Expiration time, in seconds, for the consumer key that is + generated for the AppGroup app. If not set or left to the default + value of `-1`, the API key never expires. The expiration time can't + be updated after it is set. type: string format: int64 - issuedAt: + lastModifiedAt: + readOnly: true + description: >- + Output only. Time the AppGroup app was modified in milliseconds + since epoch. + type: string format: int64 - description: Time the credential was issued in milliseconds since epoch. + appId: + description: Immutable. ID of the AppGroup app. type: string - attributes: - type: array + name: + description: >- + Immutable. Name of the AppGroup app whose resource name format is of + syntax (organizations/*/appgroups/*/apps/*). + type: string + credentials: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes associated with this credential. - GoogleCloudApigeeV1SecurityActionFlag: - description: The message that should be set in the case of a Flag action. - id: GoogleCloudApigeeV1SecurityActionFlag + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + description: >- + Output only. Set of credentials for the AppGroup app consisting of + the consumer key/secret pairs associated with the API products. + readOnly: true + type: array + description: >- + Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], + [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and + [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] + GoogleCloudApigeeV1Certificate: type: object + id: GoogleCloudApigeeV1Certificate properties: - headers: + certInfo: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' - description: >- - Optional. A list of HTTP headers to be sent to the target in case of - a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least - one is mandatory. + $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' type: array - GoogleCloudApigeeV1Schema: + description: Chain of certificates under this name. + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: + type: object + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest + description: Request for BatchComputeSecurityAssessmentResults. properties: - meta: - type: array + includeAllResources: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + description: Include all resources under the scope. + profile: + type: string + description: Required. Name of the profile that is used for computation. + pageToken: + type: string description: >- - Additional metadata associated with schema. This is a legacy field - and usually consists of an empty array of strings. - items: - type: string - dimensions: - description: List of schema fields grouped as dimensions. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + Optional. A page token, received from a previous + `BatchComputeSecurityAssessmentResults` call. Provide this to + retrieve the subsequent page. + scope: + type: string + description: >- + Required. Scope of the resources for the computation. For Apigee, + the environment is the scope of the resources. + pageSize: + type: integer + description: >- + Optional. The maximum number of results to return. The service may + return fewer than this value. If unspecified, at most 50 results + will be returned. + format: int32 + include: + description: Include only these resources. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + GoogleCloudApigeeV1OperationGroup: + properties: + operationConfigs: + description: >- + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. type: array - metrics: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' + operationConfigType: description: >- - List of schema fields grouped as dimensions that can be used with an - aggregate function such as `sum`, `avg`, `min`, and `max`. - type: array - description: Response for Schema call + Flag that specifes whether the configuration is for Apigee API proxy + or a remote service. Valid values include `proxy` or + `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API + proxies are associated with the API product. Set to `remoteservice` + when non-Apigee proxies like Istio-Envoy are associated with the API + product. + type: string type: object - id: GoogleCloudApigeeV1Schema + id: GoogleCloudApigeeV1OperationGroup + description: >- + List of operation configuration details associated with Apigee API + proxies or remote services. Remote services are non-Apigee proxies, such + as Istio-Envoy. + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: + description: A Signed URL and the relevant metadata associated with it. + type: object + properties: + md5: + description: The MD5 Hash of the JSON data + type: string + uri: + type: string + description: >- + The signed URL of the JSON data. Will be of the form + `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= + GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount + .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 + 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 + 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 + 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc + c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 + 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a + 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 + a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 + 2ea7abedc098d2eb14a7` + sizeBytes: + description: The size of the returned file in bytes + type: string + format: int64 + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + GoogleCloudApigeeV1RevisionStatus: + type: object + description: The status of a specific resource revision. + id: GoogleCloudApigeeV1RevisionStatus + properties: + revisionId: + description: The revision of the resource. + type: string + replicas: + format: int32 + description: The number of replicas that have successfully loaded this revision. + type: integer + jsonSpec: + type: string + description: >- + The json content of the resource revision. Large specs should be + sent individually via the spec field to avoid hitting request size + limits. + errors: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' + description: Errors reported when attempting to load this revision. parameters: + callback: + description: JSONP + in: query + name: callback + schema: + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -8735,53 +8741,52 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - access_token: - description: OAuth access token. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: access_token + name: uploadType schema: type: string - alt: - description: Data format for response. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: alt + name: prettyPrint schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP + type: boolean + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv schema: type: string + enum: + - '1' + - '2' fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token schema: type: string upload_protocol: @@ -8790,1603 +8795,1622 @@ components: name: upload_protocol schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + alt: + description: Data format for response. in: query - name: quotaUser + name: alt schema: type: string + enum: + - json + - media + - proto x-stackQL-resources: - organizations: - id: google.apigee.organizations - name: organizations - title: Organizations + issuers: + id: google.apigee.issuers + name: issuers + title: Issuers methods: - organizations_create: + hybrid_issuers_list: operation: - $ref: '#/paths/~1v1~1organizations/post' + $ref: '#/paths/~1v1~1hybrid~1issuers/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list + insert: [] + update: [] + replace: [] + delete: [] + reports: + id: google.apigee.reports + name: reports + title: Reports + methods: + organizations_reports_delete: operation: - $ref: '#/paths/~1v1~1organizations/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_update: + organizations_reports_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/put' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_delete: + organizations_reports_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_get: + organizations_reports_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_set_sync_authorization: + organizations_reports_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_get + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_update + delete: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_delete + deployments: + id: google.apigee.deployments + name: deployments + title: Deployments + methods: + organizations_apis_revisions_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_set_addons: + organizations_apis_deployments_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}:setAddons/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_deployments_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateUndeployChangeReport/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_deployments_generate_deploy_change_report: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_sharedflows_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sharedflows_revisions_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sharedflows_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_deployments_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_get + #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_list - insert: + #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_get - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_create - update: [] - replace: + #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_update - delete: + #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_delete - deployed_ingress_config: - id: google.apigee.deployed_ingress_config - name: deployed_ingress_config - title: Deployed_ingress_config + #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_deployments_list + insert: [] + update: [] + replace: [] + delete: [] + revisions: + id: google.apigee.revisions + name: revisions + title: Revisions methods: - organizations_get_deployed_ingress_config: + organizations_apis_revisions_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apis_revisions_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_deploy: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_undeploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config - insert: [] - update: [] - replace: [] - delete: [] - security_settings: - id: google.apigee.security_settings - name: security_settings - title: Security_settings - methods: - organizations_get_security_settings: + organizations_environments_sharedflows_revisions_undeploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_update_security_settings: + organizations_environments_sharedflows_revisions_deploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/organizations_update_security_settings - replace: [] - delete: [] - runtime_config: - id: google.apigee.runtime_config - name: runtime_config - title: Runtime_config - methods: - organizations_get_runtime_config: + organizations_sharedflows_revisions_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1runtimeConfig/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/runtime_config/methods/organizations_get_runtime_config - insert: [] - update: [] - replace: [] - delete: [] - project_mapping: - id: google.apigee.project_mapping - name: project_mapping - title: Project_mapping - methods: - organizations_get_project_mapping: + organizations_sharedflows_revisions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getProjectMapping/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/project_mapping/methods/organizations_get_project_mapping + #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get insert: [] update: [] replace: [] - delete: [] - sync_authorization: - id: google.apigee.sync_authorization - name: sync_authorization - title: Sync_authorization + delete: + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_delete + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete + revisions_api_proxy_revision: + id: google.apigee.revisions_api_proxy_revision + name: revisions_api_proxy_revision + title: Revisions_api_proxy_revision methods: - organizations_get_sync_authorization: + organizations_apis_revisions_update_api_proxy_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/sync_authorization/methods/organizations_get_sync_authorization + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_api_proxy_revision/methods/organizations_apis_revisions_update_api_proxy_revision replace: [] delete: [] - apicategories: - id: google.apigee.apicategories - name: apicategories - title: Apicategories + entries: + id: google.apigee.entries + name: entries + title: Entries methods: - organizations_sites_apicategories_patch: + organizations_apis_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_get: + organizations_apis_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_delete: + objectKey: $.keyValueEntries + organizations_apis_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_create: + organizations_apis_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_list: + organizations_apis_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list - insert: - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create - update: - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete - apidocs: - id: google.apigee.apidocs - name: apidocs - title: Apidocs - methods: - organizations_sites_apidocs_delete: + organizations_environments_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_update: + organizations_environments_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_get: + organizations_environments_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_create: + organizations_environments_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_list: + objectKey: $.keyValueEntries + organizations_environments_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.data - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get - - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list - insert: - - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update - delete: - - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete - apidocs_documentation: - id: google.apigee.apidocs_documentation - name: apidocs_documentation - title: Apidocs_documentation - methods: - organizations_sites_apidocs_get_documentation: + organizations_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_update_documentation: + organizations_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_update_documentation - replace: [] - delete: [] - environments: - id: google.apigee.environments - name: environments - title: Environments - methods: - organizations_environments_delete: + organizations_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_modify_environment: + organizations_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update: + organizations_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get: + objectKey: $.keyValueEntries + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_list + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_list + insert: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_create + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_create + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_update + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_update + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_update + delete: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_delete + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_delete + keyvaluemaps: + id: google.apigee.keyvaluemaps + name: keyvaluemaps + title: Keyvaluemaps + methods: + organizations_apis_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_unsubscribe: + organizations_apis_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_subscribe: + organizations_environments_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_create: + organizations_environments_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_delete: + organizations_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_compute_environment_scores: + organizations_keyvaluemaps_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_get + select: [] insert: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_create - update: [] - replace: + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_update + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create + update: [] + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_delete - environments_environment: - id: google.apigee.environments_environment - name: environments_environment - title: Environments_environment - methods: - organizations_environments_update_environment: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete - $ref: >- - #/components/x-stackQL-resources/environments_environment/methods/organizations_environments_update_environment - replace: [] - delete: [] - environments_debugmask: - id: google.apigee.environments_debugmask - name: environments_debugmask - title: Environments_debugmask + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete + apis: + id: google.apigee.apis + name: apis + title: Apis methods: - organizations_environments_get_debugmask: + organizations_apis_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update_debugmask: + organizations_apis_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_update_debugmask - replace: [] - delete: [] - environments_iam_policies: - id: google.apigee.environments_iam_policies - name: environments_iam_policies - title: Environments_iam_policies - methods: - organizations_environments_set_iam_policy: + organizations_apis_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get_iam_policy: + organizations_apis_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - organizations_environments_test_iam_permissions: + organizations_apis_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy - insert: [] - update: [] - replace: + #/components/x-stackQL-resources/apis/methods/organizations_apis_get - $ref: >- - #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_set_iam_policy - delete: [] - environments_addons_config: - id: google.apigee.environments_addons_config - name: environments_addons_config - title: Environments_addons_config + #/components/x-stackQL-resources/apis/methods/organizations_apis_list + insert: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_create + update: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_delete + host_security_reports: + id: google.apigee.host_security_reports + name: host_security_reports + title: Host_security_reports methods: - organizations_environments_get_addons_config: + organizations_host_security_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_addons_config/methods/organizations_environments_get_addons_config - insert: [] - update: [] - replace: [] - delete: [] - environments_trace_config: - id: google.apigee.environments_trace_config - name: environments_trace_config - title: Environments_trace_config - methods: - organizations_environments_update_trace_config: + organizations_host_security_reports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get_trace_config: + organizations_host_security_reports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.securityReports sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config - insert: [] - update: + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get - $ref: >- - #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_update_trace_config + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create + update: [] replace: [] delete: [] - environments_deployed_config: - id: google.apigee.environments_deployed_config - name: environments_deployed_config - title: Environments_deployed_config + host_security_reports_result_view: + id: google.apigee.host_security_reports_result_view + name: host_security_reports_result_view + title: Host_security_reports_result_view methods: - organizations_environments_get_deployed_config: + organizations_host_security_reports_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config + #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view insert: [] update: [] replace: [] delete: [] - environments_security_actions_config: - id: google.apigee.environments_security_actions_config - name: environments_security_actions_config - title: Environments_security_actions_config + host_security_reports_result: + id: google.apigee.host_security_reports_result + name: host_security_reports_result + title: Host_security_reports_result methods: - organizations_environments_get_security_actions_config: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_update_security_actions_config: + organizations_host_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_get_security_actions_config + #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_update_security_actions_config + update: [] replace: [] delete: [] - environments_api_security_runtime_config: - id: google.apigee.environments_api_security_runtime_config - name: environments_api_security_runtime_config - title: Environments_api_security_runtime_config + developers_monetization_config: + id: google.apigee.developers_monetization_config + name: developers_monetization_config + title: Developers_monetization_config methods: - organizations_environments_get_api_security_runtime_config: + organizations_developers_update_monetization_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_get_monetization_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config insert: [] update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_update_monetization_config delete: [] - flowhooks: - id: google.apigee.flowhooks - name: flowhooks - title: Flowhooks + developers: + id: google.apigee.developers + name: developers + title: Developers methods: - organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: + organizations_developers_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: + organizations_developers_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_flowhooks_get: + organizations_developers_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get - insert: [] - update: [] - replace: [] - delete: [] - targetservers: - id: google.apigee.targetservers - name: targetservers - title: Targetservers - methods: - organizations_environments_targetservers_update: + organizations_developers_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_get: + organizations_developers_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_delete: + organizations_developers_set_developer_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_create: + organizations_developers_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_get + #/components/x-stackQL-resources/developers/methods/organizations_developers_get + - $ref: >- + #/components/x-stackQL-resources/developers/methods/organizations_developers_list insert: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_create + #/components/x-stackQL-resources/developers/methods/organizations_developers_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update + #/components/x-stackQL-resources/developers/methods/organizations_developers_update delete: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete - keystores: - id: google.apigee.keystores - name: keystores - title: Keystores + #/components/x-stackQL-resources/developers/methods/organizations_developers_delete + attributes: + id: google.apigee.attributes + name: attributes + title: Attributes methods: - organizations_environments_keystores_get: + organizations_developers_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_delete: + organizations_developers_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_create: + organizations_developers_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get - insert: - - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete - aliases: - id: google.apigee.aliases - name: aliases - title: Aliases - methods: - organizations_environments_keystores_aliases_get: + organizations_developers_apps_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_delete: + organizations_developers_apps_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_update: + organizations_developers_apps_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_csr: + organizations_apiproducts_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_create: + organizations_apiproducts_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_attributes_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get - insert: + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_get - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create - update: [] - replace: + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_get - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_list + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_get + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_list + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_list + insert: [] + update: [] + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete - aliases_certificate: - id: google.apigee.aliases_certificate - name: aliases_certificate - title: Aliases_certificate + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_delete + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_delete + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_delete + developers_balance: + id: google.apigee.developers_balance + name: developers_balance + title: Developers_balance methods: - organizations_environments_keystores_aliases_get_certificate: + organizations_developers_get_balance: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate + #/components/x-stackQL-resources/developers_balance/methods/organizations_developers_get_balance insert: [] update: [] replace: [] delete: [] - caches: - id: google.apigee.caches - name: caches - title: Caches + attributes_developer_attribute: + id: google.apigee.attributes_developer_attribute + name: attributes_developer_attribute + title: Attributes_developer_attribute methods: - organizations_environments_caches_delete: + organizations_developers_attributes_update_developer_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1caches~1{cachesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete - stats: - id: google.apigee.stats - name: stats - title: Stats - methods: - organizations_environments_stats_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1stats~1{statsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: + update: - $ref: >- - #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get - insert: [] - update: [] + #/components/x-stackQL-resources/attributes_developer_attribute/methods/organizations_developers_attributes_update_developer_attribute replace: [] delete: [] - deployments: - id: google.apigee.deployments - name: deployments - title: Deployments + apps: + id: google.apigee.apps + name: apps + title: Apps methods: - organizations_environments_sharedflows_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_deployments_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_apis_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_deploy_change_report: + organizations_developers_apps_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: + organizations_developers_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateUndeployChangeReport/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_deployments_list: + organizations_developers_apps_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_deployments_list: + organizations_developers_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_deployments_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_deployments_list: + organizations_developers_apps_generate_key_pair_or_update_developer_app_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_deployments_list: + organizations_developers_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_deployments_list - insert: [] - update: [] - replace: [] - delete: [] - revisions: - id: google.apigee.revisions - name: revisions - title: Revisions - methods: - organizations_environments_sharedflows_revisions_deploy: + organizations_developers_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_undeploy: + organizations_appgroups_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_undeploy: + organizations_appgroups_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deploy: + organizations_appgroups_apps_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_get: + organizations_appgroups_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_delete: + objectKey: $.appGroupApps + organizations_appgroups_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_delete: + organizations_apps_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_get: + objectKey: $.app + organizations_apps_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get - insert: [] + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_apps_get + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_apps_list + insert: + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_update + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_update delete: - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_delete - revisions_deployments: - id: google.apigee.revisions_deployments - name: revisions_deployments - title: Revisions_deployments + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete + attributes_developer_app_attribute: + id: google.apigee.attributes_developer_app_attribute + name: attributes_developer_app_attribute + title: Attributes_developer_app_attribute methods: - organizations_environments_sharedflows_revisions_get_deployments: + organizations_developers_apps_attributes_update_developer_app_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_get_deployments: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/attributes_developer_app_attribute/methods/organizations_developers_apps_attributes_update_developer_app_attribute + replace: [] + delete: [] + apiproducts_developer_app_key_api_product: + id: google.apigee.apiproducts_developer_app_key_api_product + name: apiproducts_developer_app_key_api_product + title: Apiproducts_developer_app_key_api_product + methods: + organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_sharedflows_revisions_get_deployments - - $ref: >- - #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_apis_revisions_get_deployments + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/apiproducts_developer_app_key_api_product/methods/organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product replace: [] delete: [] - exports: - id: google.apigee.exports - name: exports - title: Exports + apiproducts: + id: google.apigee.apiproducts + name: apiproducts + title: Apiproducts methods: - organizations_environments_analytics_exports_list: + organizations_developers_apps_keys_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_analytics_exports_create: + organizations_appgroups_apps_keys_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_analytics_exports_get: + organizations_apiproducts_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get - - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list - insert: - - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create - update: [] - replace: [] - delete: [] - admin_schemav2: - id: google.apigee.admin_schemav2 - name: admin_schemav2 - title: Admin_schemav2 - methods: - organizations_environments_analytics_admin_get_schemav2: + organizations_apiproducts_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 - insert: [] - update: [] - replace: [] - delete: [] - deployments_iam_policies: - id: google.apigee.deployments_iam_policies - name: deployments_iam_policies - title: Deployments_iam_policies - methods: - organizations_environments_deployments_test_iam_permissions: + organizations_apiproducts_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:testIamPermissions/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_deployments_set_iam_policy: + organizations_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:setIamPolicy/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_deployments_get_iam_policy: + organizations_apiproducts_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:getIamPolicy/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_get_iam_policy - insert: [] + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list + insert: + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_set_iam_policy + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update + delete: + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete + create: + id: google.apigee.create + name: create + title: Create + methods: + organizations_developers_apps_keys_create_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create + update: [] + replace: [] delete: [] - keyvaluemaps: - id: google.apigee.keyvaluemaps - name: keyvaluemaps - title: Keyvaluemaps + keys: + id: google.apigee.keys + name: keys + title: Keys methods: - organizations_environments_keyvaluemaps_delete: + organizations_developers_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_create: + organizations_developers_apps_keys_replace_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_delete: + organizations_developers_apps_keys_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_create: + organizations_developers_apps_keys_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_create: + organizations_appgroups_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_delete: + organizations_appgroups_apps_keys_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_appgroups_apps_keys_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get + insert: - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create update: [] - replace: [] - delete: + replace: - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_replace_developer_app_key + delete: - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete - entries: - id: google.apigee.entries - name: entries - title: Entries + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_delete + keys_developer_app_key: + id: google.apigee.keys_developer_app_key + name: keys_developer_app_key + title: Keys_developer_app_key methods: - organizations_environments_keyvaluemaps_entries_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_update: + organizations_developers_apps_keys_update_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_get: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/keys_developer_app_key/methods/organizations_developers_apps_keys_update_developer_app_key + replace: [] + delete: [] + subscriptions: + id: google.apigee.subscriptions + name: subscriptions + title: Subscriptions + methods: + organizations_developers_subscriptions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_create: + organizations_developers_subscriptions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_list: + organizations_developers_subscriptions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_keyvaluemaps_entries_update: + organizations_developers_subscriptions_expire: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create + update: [] + replace: [] + delete: [] + balance: + id: google.apigee.balance + name: balance + title: Balance + methods: + organizations_developers_balance_adjust: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_get: + organizations_developers_balance_credit: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_create: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + canaryevaluations: + id: google.apigee.canaryevaluations + name: canaryevaluations + title: Canaryevaluations + methods: + organizations_instances_canaryevaluations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations~1{canaryevaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_list: + organizations_instances_canaryevaluations_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_apis_keyvaluemaps_entries_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_get + insert: + - $ref: >- + #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_create + update: [] + replace: [] + delete: [] + nat_addresses: + id: google.apigee.nat_addresses + name: nat_addresses + title: Nat_addresses + methods: + organizations_instances_nat_addresses_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_delete: + organizations_instances_nat_addresses_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_update: + objectKey: $.natAddresses + organizations_instances_nat_addresses_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_create: + organizations_instances_nat_addresses_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_list: + organizations_instances_nat_addresses_activate: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_get - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_list + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_get - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_list + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_list insert: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_create - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_create - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_create update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_update - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_update - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_update + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_delete - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_delete - references: - id: google.apigee.references - name: references - title: References + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_delete + attachments: + id: google.apigee.attachments + name: attachments + title: Attachments methods: - organizations_environments_references_get: + organizations_instances_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_attachments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attachments + organizations_instances_attachments_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_attachments_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_envgroups_attachments_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_delete: + organizations_envgroups_attachments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_update: + organizations_envgroups_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_create: + organizations_envgroups_attachments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.environmentGroupAttachments sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_get + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list insert: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_create - update: [] - replace: + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_update + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create + update: [] + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete - security_reports_result: - id: google.apigee.security_reports_result - name: security_reports_result - title: Security_reports_result + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete + instances: + id: google.apigee.instances + name: instances + title: Instances methods: - organizations_environments_security_reports_get_result: + organizations_instances_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result - insert: [] - update: [] - replace: [] - delete: [] - security_reports: - id: google.apigee.security_reports - name: security_reports - title: Security_reports - methods: - organizations_environments_security_reports_get: + organizations_instances_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_reports_create: + organizations_instances_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_reports_list: + organizations_instances_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instances + organizations_instances_report_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get + #/components/x-stackQL-resources/instances/methods/organizations_instances_get - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list + #/components/x-stackQL-resources/instances/methods/organizations_instances_list insert: - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create - update: [] + #/components/x-stackQL-resources/instances/methods/organizations_instances_create + update: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_patch replace: [] - delete: [] - security_reports_result_view: - id: google.apigee.security_reports_result_view - name: security_reports_result_view - title: Security_reports_result_view + delete: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_delete + security_assessment_results: + id: google.apigee.security_assessment_results + name: security_assessment_results + title: Security_assessment_results methods: - organizations_environments_security_reports_get_result_view: + organizations_security_assessment_results_batch_compute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view + select: [] insert: [] update: [] replace: [] delete: [] - data: - id: google.apigee.data - name: data - title: Data + overrides: + id: google.apigee.overrides + name: overrides + title: Overrides methods: - organizations_environments_apis_revisions_debugsessions_data_get: + organizations_environments_trace_config_overrides_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data~1{dataId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get - insert: [] - update: [] - replace: [] - delete: [] - debugsessions_data: - id: google.apigee.debugsessions_data - name: debugsessions_data - title: Debugsessions_data - methods: - organizations_environments_apis_revisions_debugsessions_delete_data: + organizations_environments_trace_config_overrides_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/debugsessions_data/methods/organizations_environments_apis_revisions_debugsessions_delete_data - debugsessions: - id: google.apigee.debugsessions - name: debugsessions - title: Debugsessions - methods: - organizations_environments_apis_revisions_debugsessions_list: + objectKey: $.traceConfigOverrides + organizations_environments_trace_config_overrides_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sessions - organizations_environments_apis_revisions_debugsessions_create: + organizations_environments_trace_config_overrides_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_debugsessions_get: + organizations_environments_trace_config_overrides_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list insert: - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create - update: [] + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create + update: + - $ref: >- + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_patch replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete resourcefiles: id: google.apigee.resourcefiles name: resourcefiles title: Resourcefiles methods: - organizations_environments_resourcefiles_get: + organizations_environments_resourcefiles_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_delete: + organizations_environments_resourcefiles_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post response: mediaType: application/json openAPIDocKey: '200' @@ -10397,17 +10421,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_create: + organizations_environments_resourcefiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_list: + organizations_environments_resourcefiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -10447,77 +10471,101 @@ components: update: [] replace: [] delete: [] - archive_deployments: - id: google.apigee.archive_deployments - name: archive_deployments - title: Archive_deployments + admin_schemav2: + id: google.apigee.admin_schemav2 + name: admin_schemav2 + title: Admin_schemav2 methods: - organizations_environments_archive_deployments_get: + organizations_environments_analytics_admin_get_schemav2: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_patch: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 + insert: [] + update: [] + replace: [] + delete: [] + exports: + id: google.apigee.exports + name: exports + title: Exports + methods: + organizations_environments_analytics_exports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_delete: + organizations_environments_analytics_exports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_create: + organizations_environments_analytics_exports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get + - $ref: >- + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create + update: [] + replace: [] + delete: [] + deployments_iam_policies: + id: google.apigee.deployments_iam_policies + name: deployments_iam_policies + title: Deployments_iam_policies + methods: + organizations_environments_deployments_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.archiveDeployments - organizations_environments_archive_deployments_generate_upload_url: + organizations_environments_deployments_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments:generateUploadUrl/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_generate_download_url: + organizations_environments_deployments_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.bindings sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list - insert: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create - update: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_patch - replace: [] - delete: + #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_get_iam_policy + insert: [] + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete + #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_set_iam_policy + delete: [] optimized_stats: id: google.apigee.optimized_stats name: optimized_stats @@ -10538,205 +10586,193 @@ components: update: [] replace: [] delete: [] - overrides: - id: google.apigee.overrides - name: overrides - title: Overrides + keystores: + id: google.apigee.keystores + name: keystores + title: Keystores methods: - organizations_environments_trace_config_overrides_patch: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_trace_config_overrides_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_trace_config_overrides_delete: + organizations_environments_keystores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_list: + organizations_environments_keystores_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.traceConfigOverrides - organizations_environments_trace_config_overrides_create: + organizations_environments_keystores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get insert: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create - update: - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_patch + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete - security_actions: - id: google.apigee.security_actions - name: security_actions - title: Security_actions + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete + aliases: + id: google.apigee.aliases + name: aliases + title: Aliases methods: - organizations_environments_security_actions_list: + organizations_environments_keystores_aliases_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityActions - organizations_environments_security_actions_create: + organizations_environments_keystores_aliases_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_get: + organizations_environments_keystores_aliases_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_enable: + organizations_environments_keystores_aliases_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_disable: + organizations_environments_keystores_aliases_csr: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get - - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get insert: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create update: [] - replace: [] - delete: [] - security_incidents: - id: google.apigee.security_incidents - name: security_incidents - title: Security_incidents + replace: + - $ref: >- + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update + delete: + - $ref: >- + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete + aliases_certificate: + id: google.apigee.aliases_certificate + name: aliases_certificate + title: Aliases_certificate methods: - organizations_environments_security_incidents_patch: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_security_incidents_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_security_incidents_list: + organizations_environments_keystores_aliases_get_certificate: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityIncidents - organizations_environments_security_incidents_batch_update: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate + insert: [] + update: [] + replace: [] + delete: [] + security_reports_result: + id: google.apigee.security_reports_result + name: security_reports_result + title: Security_reports_result + methods: + organizations_environments_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get - - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list + #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch - - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_batch_update + update: [] replace: [] delete: [] - security_stats: - id: google.apigee.security_stats - name: security_stats - title: Security_stats + security_reports: + id: google.apigee.security_reports + name: security_reports + title: Security_reports methods: - organizations_environments_security_stats_query_tabular_stats: + organizations_environments_security_reports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_stats_query_time_series_stats: + organizations_environments_security_reports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.securityReports + organizations_environments_security_reports_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create update: [] replace: [] delete: [] - queries_result: - id: google.apigee.queries_result - name: queries_result - title: Queries_result + security_reports_result_view: + id: google.apigee.security_reports_result_view + name: security_reports_result_view + title: Security_reports_result_view methods: - organizations_environments_queries_get_result: + organizations_environments_security_reports_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result + #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view insert: [] update: [] replace: [] @@ -10746,17 +10782,17 @@ components: name: queries title: Queries methods: - organizations_environments_queries_create: + organizations_environments_queries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_list: + organizations_environments_queries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post response: mediaType: application/json openAPIDocKey: '200' @@ -10779,6 +10815,26 @@ components: update: [] replace: [] delete: [] + queries_result: + id: google.apigee.queries_result + name: queries_result + title: Queries_result + methods: + organizations_environments_queries_get_result: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result + insert: [] + update: [] + replace: [] + delete: [] queries_resulturl: id: google.apigee.queries_resulturl name: queries_resulturl @@ -10799,1261 +10855,1172 @@ components: update: [] replace: [] delete: [] - addons_config: - id: google.apigee.addons_config - name: addons_config - title: Addons_config + data: + id: google.apigee.data + name: data + title: Data methods: - organizations_environments_addons_config_set_addon_enablement: + organizations_environments_apis_revisions_debugsessions_data_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data~1{dataId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get insert: [] update: [] replace: [] delete: [] - endpoint_attachments: - id: google.apigee.endpoint_attachments - name: endpoint_attachments - title: Endpoint_attachments + debugsessions: + id: google.apigee.debugsessions + name: debugsessions + title: Debugsessions methods: - organizations_endpoint_attachments_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_endpoint_attachments_delete: + organizations_environments_apis_revisions_debugsessions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_create: + organizations_environments_apis_revisions_debugsessions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_list: + objectKey: $.sessions + organizations_environments_apis_revisions_debugsessions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.endpointAttachments sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_get + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_list + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list insert: - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_create + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete - reports: - id: google.apigee.reports - name: reports - title: Reports + delete: [] + debugsessions_data: + id: google.apigee.debugsessions_data + name: debugsessions_data + title: Debugsessions_data methods: - organizations_reports_update: + organizations_environments_apis_revisions_debugsessions_delete_data: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_delete: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/debugsessions_data/methods/organizations_environments_apis_revisions_debugsessions_delete_data + revisions_deployments: + id: google.apigee.revisions_deployments + name: revisions_deployments + title: Revisions_deployments + methods: + organizations_environments_apis_revisions_get_deployments: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_get: + organizations_environments_sharedflows_revisions_get_deployments: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_reports_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_reports_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_get - - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_list - insert: + #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_apis_revisions_get_deployments - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_create + #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_sharedflows_revisions_get_deployments + insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_update - delete: - - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_delete - apps: - id: google.apigee.apps - name: apps - title: Apps + replace: [] + delete: [] + archive_deployments: + id: google.apigee.archive_deployments + name: archive_deployments + title: Archive_deployments methods: - organizations_apps_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.app - organizations_apps_get: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_appgroups_apps_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_appgroups_apps_get: + organizations_environments_archive_deployments_generate_download_url: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_update: + organizations_environments_archive_deployments_generate_upload_url: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments:generateUploadUrl/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_list: + organizations_environments_archive_deployments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.appGroupApps - organizations_appgroups_apps_create: + organizations_environments_archive_deployments_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_get: + organizations_environments_archive_deployments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_update: + organizations_environments_archive_deployments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_delete: + organizations_environments_archive_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_generate_key_pair_or_update_developer_app_status: + objectKey: $.archiveDeployments + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get + - $ref: >- + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list + insert: + - $ref: >- + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create + update: + - $ref: >- + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete + targetservers: + id: google.apigee.targetservers + name: targetservers + title: Targetservers + methods: + organizations_environments_targetservers_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes: + organizations_environments_targetservers_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_create: + organizations_environments_targetservers_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_list: + organizations_environments_targetservers_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_list + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_get insert: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_update - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_update + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update delete: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete - host_queries_result_view: - id: google.apigee.host_queries_result_view - name: host_queries_result_view - title: Host_queries_result_view + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete + references: + id: google.apigee.references + name: references + title: References methods: - organizations_host_queries_get_result_view: + organizations_environments_references_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_queries_result_view/methods/organizations_host_queries_get_result_view - insert: [] - update: [] - replace: [] - delete: [] - host_queries: - id: google.apigee.host_queries - name: host_queries - title: Host_queries - methods: - organizations_host_queries_list: + organizations_environments_references_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_create: + organizations_environments_references_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_get: + organizations_environments_references_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get - - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list + #/components/x-stackQL-resources/references/methods/organizations_environments_references_get insert: - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create + #/components/x-stackQL-resources/references/methods/organizations_environments_references_create update: [] - replace: [] - delete: [] - host_queries_result: - id: google.apigee.host_queries_result - name: host_queries_result - title: Host_queries_result + replace: + - $ref: >- + #/components/x-stackQL-resources/references/methods/organizations_environments_references_update + delete: + - $ref: >- + #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete + addons_config: + id: google.apigee.addons_config + name: addons_config + title: Addons_config methods: - organizations_host_queries_get_result: + organizations_environments_addons_config_set_addon_enablement: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result + select: [] insert: [] update: [] replace: [] delete: [] - security_profiles: - id: google.apigee.security_profiles - name: security_profiles - title: Security_profiles + security_incidents: + id: google.apigee.security_incidents + name: security_incidents + title: Security_incidents methods: - organizations_security_profiles_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_security_profiles_delete: + organizations_environments_security_incidents_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_patch: + organizations_environments_security_incidents_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_create: + organizations_environments_security_incidents_batch_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_list: + organizations_environments_security_incidents_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityProfiles + objectKey: $.securityIncidents sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_get - - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_list - insert: + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_create + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list + insert: [] update: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_patch - replace: [] - delete: + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_delete - security_profiles_revisions: - id: google.apigee.security_profiles_revisions - name: security_profiles_revisions - title: Security_profiles_revisions + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_batch_update + replace: [] + delete: [] + security_stats: + id: google.apigee.security_stats + name: security_stats + title: Security_stats methods: - organizations_security_profiles_list_revisions: + organizations_environments_security_stats_query_time_series_stats: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}:listRevisions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityProfiles - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_profiles_revisions/methods/organizations_security_profiles_list_revisions - insert: [] - update: [] - replace: [] - delete: [] - revisions_shared_flow_revision: - id: google.apigee.revisions_shared_flow_revision - name: revisions_shared_flow_revision - title: Revisions_shared_flow_revision - methods: - organizations_sharedflows_revisions_update_shared_flow_revision: + organizations_environments_security_stats_query_tabular_stats: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/revisions_shared_flow_revision/methods/organizations_sharedflows_revisions_update_shared_flow_revision + update: [] replace: [] delete: [] - sharedflows: - id: google.apigee.sharedflows - name: sharedflows - title: Sharedflows + stats: + id: google.apigee.stats + name: stats + title: Stats methods: - organizations_sharedflows_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sharedflows_delete: + organizations_environments_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sharedflows_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sharedflows_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1stats~1{statsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_get - - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_list - insert: - - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create + #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get + insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete - appgroups: - id: google.apigee.appgroups - name: appgroups - title: Appgroups + delete: [] + security_actions: + id: google.apigee.security_actions + name: security_actions + title: Security_actions methods: - organizations_appgroups_delete: + organizations_environments_security_actions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_get: + organizations_environments_security_actions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_update: + objectKey: $.securityActions + organizations_environments_security_actions_enable: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_create: + organizations_environments_security_actions_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_list: + organizations_environments_security_actions_disable: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.appGroups sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list insert: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update - delete: - - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete - keys: - id: google.apigee.keys - name: keys - title: Keys + replace: [] + delete: [] + flowhooks: + id: google.apigee.flowhooks + name: flowhooks + title: Flowhooks methods: - organizations_appgroups_apps_keys_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_appgroups_apps_keys_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_appgroups_apps_keys_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_apps_keys_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_apps_keys_replace_developer_app_key: + organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_delete: + organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_create: + organizations_environments_flowhooks_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get - insert: - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create + #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get + insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_replace_developer_app_key - delete: - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_delete - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete - keys_app_group_app_key: - id: google.apigee.keys_app_group_app_key - name: keys_app_group_app_key - title: Keys_app_group_app_key + replace: [] + delete: [] + caches: + id: google.apigee.caches + name: caches + title: Caches methods: - organizations_appgroups_apps_keys_update_app_group_app_key: + organizations_environments_caches_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1caches~1{cachesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/keys_app_group_app_key/methods/organizations_appgroups_apps_keys_update_app_group_app_key + update: [] replace: [] - delete: [] - apiproducts: - id: google.apigee.apiproducts - name: apiproducts - title: Apiproducts + delete: + - $ref: >- + #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete + environments_iam_policies: + id: google.apigee.environments_iam_policies + name: environments_iam_policies + title: Environments_iam_policies methods: - organizations_appgroups_apps_keys_apiproducts_delete: + organizations_environments_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_apiproducts_delete: + organizations_environments_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes: + objectKey: $.bindings + organizations_environments_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apiproducts_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_set_iam_policy + delete: [] + environments: + id: google.apigee.environments + name: environments + title: Environments + methods: + organizations_environments_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_delete: + organizations_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_update: + organizations_environments_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_get: + organizations_environments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list - insert: - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update - delete: - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete - apiproducts_app_group_app_key_api_product: - id: google.apigee.apiproducts_app_group_app_key_api_product - name: apiproducts_app_group_app_key_api_product - title: Apiproducts_app_group_app_key_api_product - methods: - organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: + organizations_environments_modify_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/apiproducts_app_group_app_key_api_product/methods/organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product - replace: [] - delete: [] - datacollectors: - id: google.apigee.datacollectors - name: datacollectors - title: Datacollectors - methods: - organizations_datacollectors_list: + organizations_environments_unsubscribe: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataCollectors - organizations_datacollectors_create: + organizations_environments_subscribe: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_patch: + organizations_security_profiles_environments_compute_environment_scores: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_delete: + organizations_security_profiles_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_get: + organizations_security_profiles_environments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get - - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list + #/components/x-stackQL-resources/environments/methods/organizations_environments_get insert: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create - update: + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch - replace: [] + #/components/x-stackQL-resources/environments/methods/organizations_environments_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/organizations_environments_update delete: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete - host_security_reports_result: - id: google.apigee.host_security_reports_result - name: host_security_reports_result - title: Host_security_reports_result + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete + - $ref: >- + #/components/x-stackQL-resources/environments/methods/organizations_environments_delete + environments_security_actions_config: + id: google.apigee.environments_security_actions_config + name: environments_security_actions_config + title: Environments_security_actions_config methods: - organizations_host_security_reports_get_result: + organizations_environments_update_security_actions_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_get_security_actions_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result + #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_get_security_actions_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_update_security_actions_config replace: [] delete: [] - host_security_reports_result_view: - id: google.apigee.host_security_reports_result_view - name: host_security_reports_result_view - title: Host_security_reports_result_view + environments_deployed_config: + id: google.apigee.environments_deployed_config + name: environments_deployed_config + title: Environments_deployed_config methods: - organizations_host_security_reports_get_result_view: + organizations_environments_get_deployed_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view + #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config insert: [] update: [] replace: [] delete: [] - host_security_reports: - id: google.apigee.host_security_reports - name: host_security_reports - title: Host_security_reports + environments_addons_config: + id: google.apigee.environments_addons_config + name: environments_addons_config + title: Environments_addons_config methods: - organizations_host_security_reports_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_host_security_reports_list: + organizations_environments_get_addons_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports - organizations_host_security_reports_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_addons_config/methods/organizations_environments_get_addons_config + insert: [] + update: [] + replace: [] + delete: [] + environments_environment: + id: google.apigee.environments_environment + name: environments_environment + title: Environments_environment + methods: + organizations_environments_update_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list - insert: + select: [] + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create - update: [] + #/components/x-stackQL-resources/environments_environment/methods/organizations_environments_update_environment replace: [] delete: [] - operations: - id: google.apigee.operations - name: operations - title: Operations + environments_debugmask: + id: google.apigee.environments_debugmask + name: environments_debugmask + title: Environments_debugmask methods: - organizations_operations_get: + organizations_environments_get_debugmask: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get response: mediaType: application/json openAPIDocKey: '200' - organizations_operations_list: + organizations_environments_update_debugmask: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_list + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_update_debugmask replace: [] delete: [] - envgroups: - id: google.apigee.envgroups - name: envgroups - title: Envgroups + environments_api_security_runtime_config: + id: google.apigee.environments_api_security_runtime_config + name: environments_api_security_runtime_config + title: Environments_api_security_runtime_config methods: - organizations_envgroups_get: + organizations_environments_get_api_security_runtime_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_patch: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config + insert: [] + update: [] + replace: [] + delete: [] + environments_trace_config: + id: google.apigee.environments_trace_config + name: environments_trace_config + title: Environments_trace_config + methods: + organizations_environments_update_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_delete: + organizations_environments_get_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_envgroups_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.environmentGroups - organizations_envgroups_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get - - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list - insert: - - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config + insert: [] update: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_update_trace_config replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete - envgroups_deployed_ingress_config: - id: google.apigee.envgroups_deployed_ingress_config - name: envgroups_deployed_ingress_config - title: Envgroups_deployed_ingress_config + delete: [] + endpoint_attachments: + id: google.apigee.endpoint_attachments + name: endpoint_attachments + title: Endpoint_attachments methods: - organizations_envgroups_get_deployed_ingress_config: + organizations_endpoint_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config - insert: [] - update: [] - replace: [] - delete: [] - attachments: - id: google.apigee.attachments - name: attachments - title: Attachments - methods: - organizations_envgroups_attachments_list: + organizations_endpoint_attachments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.environmentGroupAttachments - organizations_envgroups_attachments_create: + organizations_endpoint_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_get: + organizations_endpoint_attachments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_delete: + objectKey: $.endpointAttachments + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_get + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_list + insert: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete + datacollectors: + id: google.apigee.datacollectors + name: datacollectors + title: Datacollectors + methods: + organizations_datacollectors_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_create: + organizations_datacollectors_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_list: + organizations_datacollectors_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.attachments - organizations_instances_attachments_get: + organizations_datacollectors_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_delete: + objectKey: $.dataCollectors + organizations_datacollectors_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list insert: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create + update: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create - update: [] + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete - balance: - id: google.apigee.balance - name: balance - title: Balance + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete + operations: + id: google.apigee.operations + name: operations + title: Operations methods: - organizations_developers_balance_adjust: + organizations_operations_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_balance_credit: + objectKey: $.operations + organizations_operations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post + #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_operations_list insert: [] update: [] replace: [] delete: [] - subscriptions: - id: google.apigee.subscriptions - name: subscriptions - title: Subscriptions + apidocs: + id: google.apigee.apidocs + name: apidocs + title: Apidocs methods: - organizations_developers_subscriptions_get: + organizations_sites_apidocs_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sites_apidocs_update: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sites_apidocs_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sites_apidocs_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_create: + objectKey: $.data + organizations_sites_apidocs_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update + delete: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete + apidocs_documentation: + id: google.apigee.apidocs_documentation + name: apidocs_documentation + title: Apidocs_documentation + methods: + organizations_sites_apidocs_get_documentation: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_expire: + organizations_sites_apidocs_update_documentation: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get - - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list - insert: + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create - update: [] + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_update_documentation replace: [] delete: [] - attributes: - id: google.apigee.attributes - name: attributes - title: Attributes + apicategories: + id: google.apigee.apicategories + name: apicategories + title: Apicategories methods: - organizations_developers_apps_attributes_list: + organizations_sites_apicategories_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_delete: + organizations_sites_apicategories_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_get: + organizations_sites_apicategories_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_list: + organizations_sites_apicategories_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_get: + organizations_sites_apicategories_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get + - $ref: >- + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list + insert: + - $ref: >- + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create + update: + - $ref: >- + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete + envgroups: + id: google.apigee.envgroups + name: envgroups + title: Envgroups + methods: + organizations_envgroups_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_delete: + organizations_envgroups_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_get: + organizations_envgroups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_list: + organizations_envgroups_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.environmentGroups + organizations_envgroups_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_get - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_list - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_get + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_get + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list + insert: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_list + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create + update: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_list - insert: [] - update: [] + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_delete - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_delete - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_delete - attributes_developer_app_attribute: - id: google.apigee.attributes_developer_app_attribute - name: attributes_developer_app_attribute - title: Attributes_developer_app_attribute + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete + envgroups_deployed_ingress_config: + id: google.apigee.envgroups_deployed_ingress_config + name: envgroups_deployed_ingress_config + title: Envgroups_deployed_ingress_config methods: - organizations_developers_apps_attributes_update_developer_app_attribute: + organizations_envgroups_get_deployed_ingress_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: + select: - $ref: >- - #/components/x-stackQL-resources/attributes_developer_app_attribute/methods/organizations_developers_apps_attributes_update_developer_app_attribute + #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config + insert: [] + update: [] replace: [] delete: [] - create: - id: google.apigee.create - name: create - title: Create + keys_app_group_app_key: + id: google.apigee.keys_app_group_app_key + name: keys_app_group_app_key + title: Keys_app_group_app_key methods: - organizations_developers_apps_keys_create_create: + organizations_appgroups_apps_keys_update_app_group_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] - insert: + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create - update: [] + #/components/x-stackQL-resources/keys_app_group_app_key/methods/organizations_appgroups_apps_keys_update_app_group_app_key replace: [] delete: [] - apiproducts_developer_app_key_api_product: - id: google.apigee.apiproducts_developer_app_key_api_product - name: apiproducts_developer_app_key_api_product - title: Apiproducts_developer_app_key_api_product + apiproducts_app_group_app_key_api_product: + id: google.apigee.apiproducts_app_group_app_key_api_product + name: apiproducts_app_group_app_key_api_product + title: Apiproducts_app_group_app_key_api_product methods: - organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: + organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post response: mediaType: application/json openAPIDocKey: '200' @@ -12062,18 +12029,73 @@ components: insert: [] update: - $ref: >- - #/components/x-stackQL-resources/apiproducts_developer_app_key_api_product/methods/organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product + #/components/x-stackQL-resources/apiproducts_app_group_app_key_api_product/methods/organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product replace: [] delete: [] - keys_developer_app_key: - id: google.apigee.keys_developer_app_key - name: keys_developer_app_key - title: Keys_developer_app_key + appgroups: + id: google.apigee.appgroups + name: appgroups + title: Appgroups + methods: + organizations_appgroups_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.appGroups + organizations_appgroups_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_appgroups_update: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_appgroups_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_appgroups_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list + insert: + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update + delete: + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete + attributes_api_product_attribute: + id: google.apigee.attributes_api_product_attribute + name: attributes_api_product_attribute + title: Attributes_api_product_attribute methods: - organizations_developers_apps_keys_update_developer_app_key: + organizations_apiproducts_attributes_update_api_product_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' @@ -12082,341 +12104,268 @@ components: insert: [] update: - $ref: >- - #/components/x-stackQL-resources/keys_developer_app_key/methods/organizations_developers_apps_keys_update_developer_app_key + #/components/x-stackQL-resources/attributes_api_product_attribute/methods/organizations_apiproducts_attributes_update_api_product_attribute replace: [] delete: [] - developers: - id: google.apigee.developers - name: developers - title: Developers + rateplans: + id: google.apigee.rateplans + name: rateplans + title: Rateplans methods: - organizations_developers_attributes: + organizations_apiproducts_rateplans_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_update: + organizations_apiproducts_rateplans_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_set_developer_status: + organizations_apiproducts_rateplans_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_delete: + organizations_apiproducts_rateplans_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_get: + organizations_apiproducts_rateplans_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_get + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_list + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list insert: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_create + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_update + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update delete: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_delete - attributes_developer_attribute: - id: google.apigee.attributes_developer_attribute - name: attributes_developer_attribute - title: Attributes_developer_attribute + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete + security_profiles: + id: google.apigee.security_profiles + name: security_profiles + title: Security_profiles methods: - organizations_developers_attributes_update_developer_attribute: + organizations_security_profiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/attributes_developer_attribute/methods/organizations_developers_attributes_update_developer_attribute - replace: [] - delete: [] - developers_monetization_config: - id: google.apigee.developers_monetization_config - name: developers_monetization_config - title: Developers_monetization_config - methods: - organizations_developers_update_monetization_config: + organizations_security_profiles_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_get_monetization_config: + organizations_security_profiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_update_monetization_config - delete: [] - developers_balance: - id: google.apigee.developers_balance - name: developers_balance - title: Developers_balance - methods: - organizations_developers_get_balance: + organizations_security_profiles_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/developers_balance/methods/organizations_developers_get_balance - insert: [] - update: [] - replace: [] - delete: [] - host_stats: - id: google.apigee.host_stats - name: host_stats - title: Host_stats - methods: - organizations_host_stats_get: + objectKey: $.securityProfiles + organizations_security_profiles_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get - insert: [] - update: [] + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_get + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_list + insert: + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_create + update: + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_patch replace: [] - delete: [] - optimized_host_stats: - id: google.apigee.optimized_host_stats - name: optimized_host_stats - title: Optimized_host_stats + delete: + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_delete + security_profiles_revisions: + id: google.apigee.security_profiles_revisions + name: security_profiles_revisions + title: Security_profiles_revisions methods: - organizations_optimized_host_stats_get: + organizations_security_profiles_list_revisions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}:listRevisions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.securityProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/optimized_host_stats/methods/organizations_optimized_host_stats_get + #/components/x-stackQL-resources/security_profiles_revisions/methods/organizations_security_profiles_list_revisions insert: [] update: [] replace: [] delete: [] - canaryevaluations: - id: google.apigee.canaryevaluations - name: canaryevaluations - title: Canaryevaluations + host_stats: + id: google.apigee.host_stats + name: host_stats + title: Host_stats methods: - organizations_instances_canaryevaluations_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations~1{canaryevaluationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_instances_canaryevaluations_create: + organizations_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_get - insert: - - $ref: >- - #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_create + #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get + insert: [] update: [] replace: [] delete: [] - nat_addresses: - id: google.apigee.nat_addresses - name: nat_addresses - title: Nat_addresses + host_queries: + id: google.apigee.host_queries + name: host_queries + title: Host_queries methods: - organizations_instances_nat_addresses_activate: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}:activate/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_instances_nat_addresses_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_instances_nat_addresses_list: + organizations_host_queries_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.natAddresses - organizations_instances_nat_addresses_delete: + organizations_host_queries_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_get: + organizations_host_queries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_get + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_list + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list insert: - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_create + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_delete - instances: - id: google.apigee.instances - name: instances - title: Instances - methods: - organizations_instances_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.instances - organizations_instances_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_instances_report_status: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_instances_patch: + delete: [] + host_queries_result_view: + id: google.apigee.host_queries_result_view + name: host_queries_result_view + title: Host_queries_result_view + methods: + organizations_host_queries_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_queries_result_view/methods/organizations_host_queries_get_result_view + insert: [] + update: [] + replace: [] + delete: [] + host_queries_result: + id: google.apigee.host_queries_result + name: host_queries_result + title: Host_queries_result + methods: + organizations_host_queries_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result + insert: [] + update: [] + replace: [] + delete: [] + optimized_host_stats: + id: google.apigee.optimized_host_stats + name: optimized_host_stats + title: Optimized_host_stats + methods: + organizations_optimized_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_get - - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_list - insert: - - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_create - update: - - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_patch + #/components/x-stackQL-resources/optimized_host_stats/methods/organizations_optimized_host_stats_get + insert: [] + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_delete - attributes_api_product_attribute: - id: google.apigee.attributes_api_product_attribute - name: attributes_api_product_attribute - title: Attributes_api_product_attribute + delete: [] + revisions_shared_flow_revision: + id: google.apigee.revisions_shared_flow_revision + name: revisions_shared_flow_revision + title: Revisions_shared_flow_revision methods: - organizations_apiproducts_attributes_update_api_product_attribute: + organizations_sharedflows_revisions_update_shared_flow_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post response: mediaType: application/json openAPIDocKey: '200' @@ -12425,65 +12374,54 @@ components: insert: [] update: - $ref: >- - #/components/x-stackQL-resources/attributes_api_product_attribute/methods/organizations_apiproducts_attributes_update_api_product_attribute + #/components/x-stackQL-resources/revisions_shared_flow_revision/methods/organizations_sharedflows_revisions_update_shared_flow_revision replace: [] delete: [] - rateplans: - id: google.apigee.rateplans - name: rateplans - title: Rateplans + sharedflows: + id: google.apigee.sharedflows + name: sharedflows + title: Sharedflows methods: - organizations_apiproducts_rateplans_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apiproducts_rateplans_list: + organizations_sharedflows_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_update: + organizations_sharedflows_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_delete: + organizations_sharedflows_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_get: + organizations_sharedflows_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_get - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_list insert: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete datastores: id: google.apigee.datastores name: datastores @@ -12503,10 +12441,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_get: + organizations_analytics_datastores_test: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post response: mediaType: application/json openAPIDocKey: '200' @@ -12517,17 +12455,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_delete: + organizations_analytics_datastores_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_test: + organizations_analytics_datastores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -12547,112 +12485,174 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_delete - revisions_api_proxy_revision: - id: google.apigee.revisions_api_proxy_revision - name: revisions_api_proxy_revision - title: Revisions_api_proxy_revision + project_mapping: + id: google.apigee.project_mapping + name: project_mapping + title: Project_mapping methods: - organizations_apis_revisions_update_api_proxy_revision: + organizations_get_project_mapping: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}:getProjectMapping/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: + select: - $ref: >- - #/components/x-stackQL-resources/revisions_api_proxy_revision/methods/organizations_apis_revisions_update_api_proxy_revision + #/components/x-stackQL-resources/project_mapping/methods/organizations_get_project_mapping + insert: [] + update: [] replace: [] delete: [] - apis: - id: google.apigee.apis - name: apis - title: Apis + sync_authorization: + id: google.apigee.sync_authorization + name: sync_authorization + title: Sync_authorization methods: - organizations_apis_delete: + organizations_get_sync_authorization: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete + #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sync_authorization/methods/organizations_get_sync_authorization + insert: [] + update: [] + replace: [] + delete: [] + organizations: + id: google.apigee.organizations + name: organizations + title: Organizations + methods: + organizations_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' + $ref: '#/paths/~1v1~1organizations/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_patch: + organizations_create: + operation: + $ref: '#/paths/~1v1~1organizations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_set_sync_authorization: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch + #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_create: + organizations_set_addons: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}:setAddons/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_list: + organizations_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_get: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_delete: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_get + #/components/x-stackQL-resources/organizations/methods/organizations_get - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_list + #/components/x-stackQL-resources/organizations/methods/organizations_list insert: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_create - update: + #/components/x-stackQL-resources/organizations/methods/organizations_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_patch - replace: [] + #/components/x-stackQL-resources/organizations/methods/organizations_update delete: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_delete - security_assessment_results: - id: google.apigee.security_assessment_results - name: security_assessment_results - title: Security_assessment_results + #/components/x-stackQL-resources/organizations/methods/organizations_delete + runtime_config: + id: google.apigee.runtime_config + name: runtime_config + title: Runtime_config methods: - organizations_security_assessment_results_batch_compute: + organizations_get_runtime_config: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1runtimeConfig/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_config/methods/organizations_get_runtime_config + insert: [] + update: [] + replace: [] + delete: [] + security_settings: + id: google.apigee.security_settings + name: security_settings + title: Security_settings + methods: + organizations_get_security_settings: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_update_security_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/security_settings/methods/organizations_update_security_settings replace: [] delete: [] - issuers: - id: google.apigee.issuers - name: issuers - title: Issuers + deployed_ingress_config: + id: google.apigee.deployed_ingress_config + name: deployed_ingress_config + title: Deployed_ingress_config methods: - hybrid_issuers_list: + organizations_get_deployed_ingress_config: operation: - $ref: '#/paths/~1v1~1hybrid~1issuers/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list + #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config insert: [] update: [] replace: [] @@ -12675,52 +12675,26 @@ components: replace: [] delete: [] paths: - /v1/organizations: + /v1/hybrid/issuers: parameters: &ref_1 + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - post: - description: >- - Creates an Apigee organization. See [Create an Apigee - organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). - operationId: apigee.organizations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: query - name: parent - schema: - type: string + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' get: description: >- - Lists the Apigee organizations and associated Google Cloud projects that - you have permission to access. See [Understanding - organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). - operationId: apigee.organizations.list + Lists hybrid services and its trusted issuers service account ids. This + api is authenticated and unauthorized(allow all the users) and used by + runtime authn-authz service to query control plane's issuer service + account ids. + operationId: apigee.hybrid.issuers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12733,13 +12707,13 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse + #/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse parameters: [] - /v1/organizations/{organizationsId}/deployedIngressConfig: + /v1/organizations/{organizationsId}/reports/{reportsId}: parameters: *ref_1 - get: - description: Gets the deployed ingress configuration for an organization. - operationId: apigee.organizations.getDeployedIngressConfig + delete: + description: Deletes an existing custom report definition + operationId: apigee.organizations.reports.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12751,22 +12725,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1IngressConfig' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: view + - in: path + name: reportsId + required: true schema: type: string - /v1/organizations/{organizationsId}/securitySettings: - parameters: *ref_1 get: - description: GetSecuritySettings gets the security settings for API Security. - operationId: apigee.organizations.getSecuritySettings + description: Retrieve a custom report definition. + operationId: apigee.organizations.reports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12778,116 +12752,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId required: true schema: type: string - patch: - description: >- - UpdateSecuritySettings updates the current security settings for API - Security. - operationId: apigee.organizations.updateSecuritySettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' - parameters: - in: path - name: organizationsId + name: reportsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}: - parameters: *ref_1 put: - description: >- - Updates the properties for an Apigee organization. No other fields in - the organization profile will be updated. - operationId: apigee.organizations.update + description: Update an existing custom report definition + operationId: apigee.organizations.reports.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - delete: - description: >- - Delete an Apigee organization. For organizations with BillingType - EVALUATION, an immediate deletion is performed. For paid organizations - (Subscription or Pay-as-you-go), a soft-deletion is performed. The - organization can be restored within the soft-deletion period, which is - specified using the `retention` field in the request or by filing a - support ticket with Apigee. During the data retention period specified - in the request, the Apigee organization cannot be recreated in the same - Google Cloud project. **IMPORTANT: The default data retention setting - for this operation is 7 days. To permanently delete the organization in - 24 hours, set the retention parameter to `MINIMUM`.** - operationId: apigee.organizations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: retention - schema: - type: string - get: - description: >- - Gets the profile for an Apigee organization. See [Understanding - organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). - operationId: apigee.organizations.get + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12899,64 +12783,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:setSyncAuthorization: - parameters: *ref_1 - post: - description: >- - Sets the permissions required to allow the Synchronizer to download - environment data from the control plane. You must call this API to - enable proper functioning of hybrid. Pass the ETag when calling - `setSyncAuthorization` to ensure that you are updating the correct - version. To get an ETag, call - [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag - in the call to `setSyncAuthorization`, then the existing authorization - is overwritten indiscriminately. For more information, see [Configure - the - Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). - **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.setSyncAuthorization - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' - parameters: - in: path - name: organizationsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}:setAddons: - parameters: *ref_1 - post: - description: >- - Configures the add-ons for the Apigee organization. The existing add-on - configuration will be fully replaced. - operationId: apigee.organizations.setAddons - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' + name: reportsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/reports: + parameters: *ref_1 + get: + description: Return a list of Custom Reports + operationId: apigee.organizations.reports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12968,18 +12811,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/runtimeConfig: - parameters: *ref_1 - get: - description: Get runtime config for an organization. - operationId: apigee.organizations.getRuntimeConfig + - in: query + name: expand + schema: + type: boolean + post: + description: >- + Creates a Custom Report for an Organization. A Custom Report provides + Apigee Customers to create custom dashboards in addition to the standard + dashboards which are provided. The Custom Report in its simplest form + contains specifications about metrics, dimensions and filters. It is + important to note that the custom report by itself does not provide an + executable entity. The Edge UI converts the custom report definition + into an analytics query and displays the result in a chart. + operationId: apigee.organizations.reports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12991,18 +12849,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:getProjectMapping: + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: parameters: *ref_1 get: - description: Gets the project ID and region for an Apigee organization. - operationId: apigee.organizations.getProjectMapping + description: Lists all deployments of an API proxy revision. + operationId: apigee.organizations.apis.revisions.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13015,33 +12873,31 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:getSyncAuthorization: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: parameters: *ref_1 - post: + delete: description: >- - Lists the service accounts with the permissions required to allow the - Synchronizer to download environment data from the control plane. An - ETag is returned in the response to `getSyncAuthorization`. Pass that - ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure - that you are updating the correct version. If you don't pass the ETag in - the call to `setSyncAuthorization`, then the existing authorization is - overwritten indiscriminately. For more information, see [Configure the - Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). - **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.getSyncAuthorization - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest + Deletes an API proxy revision and all policies, resources, endpoints, + and revisions associated with it. The API proxy revision must be + undeployed before you can delete it. + operationId: apigee.organizations.apis.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13053,23 +12909,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: - parameters: *ref_1 - patch: - description: Updates an API category. - operationId: apigee.organizations.sites.apicategories.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + get: + description: >- + Gets an API proxy revision. To download the API proxy configuration + bundle for the specified revision as a zip file, set the `format` query + parameter to `bundle`. If you are using curl, specify `-o filename.zip` + to save the output to a file; otherwise, it displays to `stdout`. Then, + develop the API proxy configuration locally and upload the updated API + proxy configuration revision, as described in + [updateApiProxyRevision](updateApiProxyRevision). + operationId: apigee.organizations.apis.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13081,7 +12947,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -13089,18 +12955,33 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId required: true schema: type: string - in: path - name: apicategoriesId + name: revisionsId required: true schema: type: string - get: - description: Gets an API category. - operationId: apigee.organizations.sites.apicategories.get + - in: query + name: format + schema: + type: string + post: + description: >- + Updates an existing API proxy revision by uploading the API proxy + configuration bundle as a zip file from your local machine. You can + update only API proxy revisions that have never been deployed. After + deployment, an API proxy revision becomes immutable, even if it is + undeployed. Set the `Content-Type` header to either + `multipart/form-data` or `application/octet-stream`. + operationId: apigee.organizations.apis.revisions.updateApiProxyRevision + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13112,7 +12993,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId @@ -13120,18 +13001,24 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId required: true schema: type: string - in: path - name: apicategoriesId + name: revisionsId required: true schema: type: string - delete: - description: Deletes an API category. - operationId: apigee.organizations.sites.apicategories.delete + - in: query + name: validate + schema: + type: boolean + /v1/organizations/{organizationsId}/apis/{apisId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of an API proxy. + operationId: apigee.organizations.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13143,7 +13030,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -13151,25 +13039,23 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apicategoriesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_1 post: - description: Creates a new API category. - operationId: apigee.organizations.sites.apicategories.create + description: >- + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13181,7 +13067,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -13189,13 +13075,21 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId required: true schema: type: string get: - description: Returns the API categories associated with a portal. - operationId: apigee.organizations.sites.apicategories.list + description: >- + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13208,7 +13102,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -13216,15 +13110,32 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_1 - delete: - description: Deletes a catalog item. - operationId: apigee.organizations.sites.apidocs.delete + get: + description: >- + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13236,7 +13147,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -13244,23 +13155,28 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId required: true schema: type: string - in: path - name: apidocsId + name: keyvaluemapsId required: true schema: type: string - put: - description: Updates a catalog item. - operationId: apigee.organizations.sites.apidocs.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + - in: path + name: entriesId + required: true + schema: + type: string + delete: + description: >- + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13272,26 +13188,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path - name: organizationsId + name: organizationsId + required: true + schema: + type: string + - in: path + name: apisId required: true schema: type: string - in: path - name: sitesId + name: keyvaluemapsId required: true schema: type: string - in: path - name: apidocsId + name: entriesId required: true schema: type: string - get: - description: Gets a catalog item. - operationId: apigee.organizations.sites.apidocs.get + put: + description: >- + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.apis.keyvaluemaps.entries.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13303,7 +13231,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -13311,20 +13239,25 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId required: true schema: type: string - in: path - name: apidocsId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: + - in: path + name: entriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: parameters: *ref_1 - get: - description: Gets the documentation for the specified catalog item. - operationId: apigee.organizations.sites.apidocs.getDocumentation + delete: + description: Deletes a key value map from an API proxy. + operationId: apigee.organizations.apis.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13336,8 +13269,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -13345,25 +13277,25 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId required: true schema: type: string - in: path - name: apidocsId + name: keyvaluemapsId required: true schema: type: string - patch: - description: >- - Updates the documentation for the specified catalog item. Note that the - documentation file contents will not be populated in the return message. - operationId: apigee.organizations.sites.apidocs.updateDocumentation + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: + parameters: *ref_1 + post: + description: Creates a key value map in an API proxy. + operationId: apigee.organizations.apis.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13375,8 +13307,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -13384,25 +13315,20 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: + /v1/organizations/{organizationsId}/apis/{apisId}: parameters: *ref_1 - post: - description: Creates a new catalog item. - operationId: apigee.organizations.sites.apidocs.create + patch: + description: Updates an existing API proxy. + operationId: apigee.organizations.apis.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13414,7 +13340,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -13422,13 +13348,21 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId required: true schema: type: string - get: - description: Returns the catalog items associated with a portal. - operationId: apigee.organizations.sites.apidocs.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes an API proxy and all associated endpoints, policies, resources, + and revisions. The API proxy must be undeployed before you can delete + it. + operationId: apigee.organizations.apis.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13440,7 +13374,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -13448,28 +13382,13 @@ paths: schema: type: string - in: path - name: sitesId + name: apisId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}: - parameters: *ref_1 - delete: - description: >- - Deletes an environment from an organization. **Warning: You must delete - all key value maps and key value entries before you delete an - environment.** Otherwise, if you re-create the environment the key value - map entry operations will encounter encryption/decryption discrepancies. - operationId: apigee.organizations.environments.delete + get: + description: Gets an API proxy including a list of existing revisions. + operationId: apigee.organizations.apis.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13481,7 +13400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -13489,24 +13408,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string + /v1/organizations/{organizationsId}/apis: + parameters: *ref_1 post: description: >- - Updates an existing environment. When updating properties, you must pass - all existing properties to the API, even if they are not being changed. - If you omit properties from the payload, the properties are removed. To - get the current list of properties for the environment, use the [Get - Environment API](get). **Note**: Both `PUT` and `POST` methods are - supported for updating an existing environment. - operationId: apigee.organizations.environments.updateEnvironment + Creates an API proxy. The API proxy created will not be accessible at + runtime until it is deployed to an environment. Create a new API proxy + by setting the `name` query parameter to the name of the API proxy. + Import an API proxy configuration bundle stored in zip format on your + local machine to your organization by doing the following: * Set the + `name` query parameter to the name of the API proxy. * Set the `action` + query parameter to `import`. * Set the `Content-Type` header to + `multipart/form-data`. * Pass as a file the name of API proxy + configuration bundle stored in zip format on your local machine using + the `file` form field. **Note**: To validate the API proxy configuration + bundle only without importing it, set the `action` query parameter to + `validate`. When importing an API proxy configuration bundle, if the API + proxy does not exist, it will be created. If the API proxy exists, then + a new revision is created. Invalid API proxy configurations are + rejected, and a list of validation errors is returned to the client. + operationId: apigee.organizations.apis.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13518,28 +13448,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: action schema: type: string - patch: + - in: query + name: name + schema: + type: string + - in: query + name: validate + schema: + type: boolean + get: description: >- - Updates properties for an Apigee environment with patch semantics using - a field mask. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.environments.modifyEnvironment - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + Lists the names of all API proxies in an organization. The names + returned correspond to the names defined in the configuration files for + each API proxy. + operationId: apigee.organizations.apis.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13551,37 +13484,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: includeMetaData schema: - type: string + type: boolean - in: query - name: updateMask + name: includeRevisions schema: - type: string - format: google-fieldmask - put: + type: boolean + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: + parameters: *ref_1 + get: description: >- - Updates an existing environment. When updating properties, you must pass - all existing properties to the API, even if they are not being changed. - If you omit properties from the payload, the properties are removed. To - get the current list of properties for the environment, use the [Get - Environment API](get). **Note**: Both `PUT` and `POST` methods are - supported for updating an existing environment. - operationId: apigee.organizations.environments.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + Get status of a query submitted at host level. If the query is still in + progress, the `state` is set to "running" After the query has completed + successfully, `state` is set to "completed" + operationId: apigee.organizations.hostSecurityReports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13593,7 +13518,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -13601,13 +13526,17 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostSecurityReportsId required: true schema: type: string + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: + parameters: *ref_1 get: - description: Gets environment details. - operationId: apigee.organizations.environments.get + description: >- + After the query is completed, use this API to view the query result when + result size is small. + operationId: apigee.organizations.hostSecurityReports.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13619,7 +13548,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -13627,15 +13557,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostSecurityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: + /v1/organizations/{organizationsId}/hostSecurityReports: parameters: *ref_1 - get: - description: Gets the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.getDebugmask + post: + description: >- + Submit a query at host level to be processed in the background. If the + submission of the query succeeds, the API returns a 201 status and an ID + that refer to the query. In addition to the HTTP status 201, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.hostSecurityReports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13647,26 +13586,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - patch: - description: Updates the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.updateDebugmask - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + get: + description: Return a list of Security Reports at host level. + operationId: apigee.organizations.hostSecurityReports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13678,43 +13607,57 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: status schema: type: string - format: google-fieldmask - in: query - name: replaceRepeatedFields + name: to schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: + type: string + - in: query + name: dataset + schema: + type: string + - in: query + name: from + schema: + type: string + - in: query + name: submittedBy + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: parameters: *ref_1 - post: + get: description: >- - Sets the IAM policy on an environment, if the policy already exists it - will be replaced. For more information, see [Manage users, roles, and - permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.environments.setIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.hostSecurityReports.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13726,7 +13669,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -13734,20 +13677,21 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostSecurityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy: + /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: parameters: *ref_1 - get: - description: >- - Gets the IAM policy on an environment. For more information, see [Manage - users, roles, and permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.environments.getIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.getIamPolicy + put: + description: Updates the monetization configuration for the developer. + operationId: apigee.organizations.developers.updateMonetizationConfig + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13759,7 +13703,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig parameters: - in: path name: organizationsId @@ -13767,20 +13712,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: - parameters: *ref_1 get: - description: Gets the add-ons config of an environment. - operationId: apigee.organizations.environments.getAddonsConfig + description: Gets the monetization configuration for the developer. + operationId: apigee.organizations.developers.getMonetizationConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13792,7 +13730,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig parameters: - in: path name: organizationsId @@ -13800,20 +13739,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: + /v1/organizations/{organizationsId}/developers: parameters: *ref_1 post: - description: Deletes a subscription for the environment's Pub/Sub topic. - operationId: apigee.organizations.environments.unsubscribe + description: >- + Creates a developer. Once created, the developer can register an app and + obtain an API key. At creation time, a developer is set as `active`. To + change the developer status, use the SetDeveloperStatus API. + operationId: apigee.organizations.developers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13825,32 +13767,85 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Lists all developers in an organization by email address. By default, + the response does not include company developers. Set the + `includeCompany` query parameter to `true` to include company + developers. **Note**: A maximum of 1000 developers are returned in the + response. You paginate the list of developers returned using the + `startKey` and `count` query parameters. + operationId: apigee.organizations.developers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse + parameters: - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: + - in: query + name: includeCompany + schema: + type: boolean + - in: query + name: startKey + schema: + type: string + - in: query + name: app + schema: + type: string + - in: query + name: expand + schema: + type: boolean + - in: query + name: count + schema: + type: string + format: int64 + - in: query + name: ids + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}: parameters: *ref_1 - patch: + put: description: >- - Updates the trace configurations in an environment. Note that the - repeated fields have replace semantics when included in the field mask - and that they will be overwritten by the value of the fields in the - request body. - operationId: apigee.organizations.environments.updateTraceConfig + Updates a developer. This API replaces the existing developer details + with those specified in the request. Include or exclude any existing + details that you want to retain or delete, respectively. The custom + attribute limit is 18. **Note**: OAuth access tokens and Key Management + Service (KMS) entities (apps, developers, and API products) are cached + for 180 seconds (current default). Any custom attributes associated with + these entities are cached for at least 180 seconds after the entity is + accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 + policy won't be able to expire an access token in less than 180 seconds. + operationId: apigee.organizations.developers.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13862,7 +13857,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -13870,18 +13865,21 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Get distributed trace configuration in an environment. - operationId: apigee.organizations.environments.getTraceConfig + delete: + description: >- + Deletes a developer. All apps and API keys associated with the developer + are also removed. **Warning**: This API will permanently delete the + developer and related artifacts. To avoid permanently deleting + developers and their artifacts, set the developer status to `inactive` + using the SetDeveloperStatus API. **Note**: The delete operation is + asynchronous. The developer app is deleted immediately, but its + associated resources, such as apps and API keys, may take anywhere from + a few seconds to a few minutes to be deleted. + operationId: apigee.organizations.developers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13893,7 +13891,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -13901,15 +13899,16 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig: - parameters: *ref_1 get: - description: Gets the deployed configuration for an environment. - operationId: apigee.organizations.environments.getDeployedConfig + description: >- + Returns the developer details, including the developer's name, email + address, apps, and other information. **Note**: The response includes + only the first 100 developer apps. + operationId: apigee.organizations.developers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13921,7 +13920,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -13929,17 +13928,26 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: - parameters: *ref_1 - get: + - in: query + name: action + schema: + type: string + post: description: >- - GetSecurityActionConfig returns the current SecurityActions - configuration. - operationId: apigee.organizations.environments.getSecurityActionsConfig + Sets the status of a developer. A developer is `active` by default. If + you set a developer's status to `inactive`, the API keys assigned to the + developer apps are no longer valid even though the API keys are set to + `approved`. Inactive developers can still sign in to the developer + portal and create apps; however, any new API keys generated during app + creation won't work. To set the status of a developer, set the `action` + query parameter to `active` or `inactive`, and the `Content-Type` header + to `application/octet-stream`. If successful, the API call returns the + following HTTP status code: `204 No Content` + operationId: apigee.organizations.developers.setDeveloperStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13951,7 +13959,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13959,21 +13967,34 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - patch: + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/attributes: + parameters: *ref_1 + post: description: >- - UpdateSecurityActionConfig updates the current SecurityActions - configuration. This method is used to enable/disable the feature at the - environment level. - operationId: apigee.organizations.environments.updateSecurityActionsConfig + Updates developer attributes. This API replaces the existing attributes + with those specified in the request. Add new attributes, and include or + exclude any existing attributes that you want to retain or remove, + respectively. The custom attribute limit is 18. **Note**: OAuth access + tokens and Key Management Service (KMS) entities (apps, developers, and + API products) are cached for 180 seconds (default). Any custom + attributes associated with these entities are cached for at least 180 + seconds after the entity is accessed at runtime. Therefore, an + `ExpiresIn` element on the OAuthV2 policy won't be able to expire an + access token in less than 180 seconds. + operationId: apigee.organizations.developers.attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13985,7 +14006,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -13993,23 +14014,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: - parameters: *ref_1 - post: - description: >- - Creates a subscription for the environment's Pub/Sub topic. The server - will assign a random name for this subscription. The "name" and - "push_config" must *not* be specified. - operationId: apigee.organizations.environments.subscribe + get: + description: Returns a list of all developer attributes. + operationId: apigee.organizations.developers.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14021,7 +14032,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -14029,18 +14040,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: + /v1/organizations/{organizationsId}/developers/{developersId}/balance: parameters: *ref_1 get: - description: >- - Gets the API Security runtime configuration for an environment. This - named ApiSecurityRuntimeConfig to prevent conflicts with - ApiSecurityConfig from addon config. - operationId: apigee.organizations.environments.getApiSecurityRuntimeConfig + description: Gets the account balance for the developer. + operationId: apigee.organizations.developers.getBalance security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14052,8 +14060,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -14061,24 +14068,26 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: + /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: parameters: *ref_1 post: description: >- - Tests the permissions of a user on an environment, and returns a subset - of permissions that the user has on the environment. If the environment - does not exist, an empty permission set is returned (a NOT_FOUND error - is not returned). - operationId: apigee.organizations.environments.testIamPermissions + Updates a developer attribute. **Note**: OAuth access tokens and Key + Management Service (KMS) entities (apps, developers, and API products) + are cached for 180 seconds (default). Any custom attributes associated + with these entities are cached for at least 180 seconds after the entity + is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 + policy won't be able to expire an access token in less than 180 seconds. + operationId: apigee.organizations.developers.attributes.updateDeveloperAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14090,7 +14099,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -14098,20 +14107,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments: - parameters: *ref_1 - post: - description: Creates an environment in an organization. - operationId: apigee.organizations.environments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + - in: path + name: attributesId + required: true + schema: + type: string + delete: + description: Deletes a developer attribute. + operationId: apigee.organizations.developers.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14123,27 +14130,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: name + - in: path + name: developersId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: - parameters: *ref_1 - put: - description: Attaches a shared flow to a flow hook. - operationId: apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + - in: path + name: attributesId + required: true + schema: + type: string + get: + description: Returns the value of the specified developer attribute. + operationId: apigee.organizations.developers.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14155,7 +14161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -14163,18 +14169,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: flowhooksId + name: attributesId required: true schema: type: string - delete: - description: Detaches a shared flow from a flow hook. - operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: + parameters: *ref_1 + get: + description: Returns a list of all developer app attributes. + operationId: apigee.organizations.developers.apps.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14186,7 +14194,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -14194,21 +14202,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: flowhooksId + name: appsId required: true schema: type: string - get: + post: description: >- - Returns the name of the shared flow attached to the specified flow hook. - If there's no shared flow attached to the flow hook, the API does not - return an error; it simply does not return a name in the response. - operationId: apigee.organizations.environments.flowhooks.get + Updates attributes for a developer app. This API replaces the current + attributes with those specified in the request. + operationId: apigee.organizations.developers.apps.attributes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14220,7 +14232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -14228,28 +14240,33 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: flowhooksId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: parameters: *ref_1 - put: + post: description: >- - Updates an existing TargetServer. Note that this operation has PUT - semantics; it will replace the entirety of the existing TargetServer - with the resource in the request body. - operationId: apigee.organizations.environments.targetservers.update + Updates a developer app attribute. **Note**: OAuth access tokens and Key + Management Service (KMS) entities (apps, developers, and API products) + are cached for 180 seconds (current default). Any custom attributes + associated with these entities are cached for at least 180 seconds after + the entity is accessed at runtime. Therefore, an `ExpiresIn` element on + the OAuthV2 policy won't be able to expire an access token in less than + 180 seconds. + operationId: >- + apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14261,7 +14278,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -14269,18 +14286,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: targetserversId + name: appsId + required: true + schema: + type: string + - in: path + name: attributesId required: true schema: type: string get: - description: Gets a TargetServer resource. - operationId: apigee.organizations.environments.targetservers.get + description: Returns a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14292,7 +14314,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -14300,20 +14322,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: targetserversId + name: appsId + required: true + schema: + type: string + - in: path + name: attributesId required: true schema: type: string delete: - description: >- - Deletes a TargetServer from an environment. Returns the deleted - TargetServer resource. - operationId: apigee.organizations.environments.targetservers.delete + description: Deletes a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14325,7 +14350,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -14333,25 +14358,32 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: targetserversId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: + - in: path + name: attributesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: parameters: *ref_1 post: - description: Creates a TargetServer in the specified environment. - operationId: apigee.organizations.environments.targetservers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + description: >- + Approves or revokes the consumer key for an API product. After a + consumer key is approved, the app can use it to access APIs. A consumer + key that is revoked or pending cannot be used to access an API. Any + access tokens associated with a revoked consumer key will remain active. + However, Apigee checks the status of the consumer key and if set to + `revoked` will not allow access to the API. + operationId: >- + apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14363,7 +14395,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14371,19 +14403,36 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId required: true schema: type: string - in: query - name: name + name: action schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: - parameters: *ref_1 - get: - description: Gets a keystore or truststore. - operationId: apigee.organizations.environments.keystores.get + delete: + description: >- + Removes an API product from an app's consumer key. After the API product + is removed, the app cannot access the API resources defined in that API + product. **Note**: The consumer key is not removed, only its association + with the API product. + operationId: apigee.organizations.developers.apps.keys.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14395,7 +14444,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -14403,18 +14452,49 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - delete: - description: Deletes a keystore or truststore. - operationId: apigee.organizations.environments.keystores.delete + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: + parameters: *ref_1 + post: + description: >- + Creates a custom consumer key and secret for a developer app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateDeveloperAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteDeveloperAppKey API. **Note**: All keys start out with + status=approved, even if status=revoked is passed when the key is + created. To revoke a key, use the UpdateDeveloperAppKey API. + operationId: apigee.organizations.developers.apps.keys.create.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14426,7 +14506,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -14434,30 +14514,39 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: parameters: *ref_1 post: description: >- - Creates a keystore or truststore. - Keystore: Contains certificates and - their associated keys. - Truststore: Contains trusted certificates used - to validate a server's certificate. These certificates are typically - self-signed certificates or certificates that are not signed by a - trusted CA. - operationId: apigee.organizations.environments.keystores.create + Creates a custom consumer key and secret for a developer app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateDeveloperAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteDeveloperAppKey API. **Note**: All keys start out with + status=approved, even if status=revoked is passed when the key is + created. To revoke a key, use the UpdateDeveloperAppKey API. + operationId: apigee.organizations.developers.apps.keys.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14469,7 +14558,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -14477,19 +14566,31 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: name + - in: path + name: appsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: parameters: *ref_1 - get: - description: Gets an alias. - operationId: apigee.organizations.environments.keystores.aliases.get + put: + description: >- + Updates the scope of an app. This API replaces the existing scopes with + those specified in the request. Include or exclude any existing scopes + that you want to retain or delete, respectively. The specified scopes + must already be defined for the API products associated with the app. + This API sets the `scopes` element under the `apiProducts` element in + the attributes of the app. + operationId: apigee.organizations.developers.apps.keys.replaceDeveloperAppKey + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14501,7 +14602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -14509,23 +14610,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - in: path - name: aliasesId + name: keysId required: true schema: type: string delete: - description: Deletes an alias. - operationId: apigee.organizations.environments.keystores.aliases.delete + description: >- + Deletes an app's consumer key and removes all API products associated + with the app. After the consumer key is deleted, it cannot be used to + access any APIs. **Note**: After you delete a consumer key, you may want + to: 1. Create a new consumer key and secret for the developer app using + the CreateDeveloperAppKey API, and subsequently add an API product to + the key using the UpdateDeveloperAppKey API. 2. Delete the developer + app, if it is no longer required. + operationId: apigee.organizations.developers.apps.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14537,7 +14645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -14545,28 +14653,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - in: path - name: aliasesId + name: keysId required: true schema: type: string - put: - description: Updates the certificate in an alias. - operationId: apigee.organizations.environments.keystores.aliases.update + post: + description: >- + Adds an API product to a developer app key, enabling the app that holds + the key to access the API resources bundled in the API product. In + addition, you can add attributes to a developer app key. This API + replaces the existing attributes with those specified in the request. + Include or exclude any existing attributes that you want to retain or + delete, respectively. You can use the same key to access all API + products associated with the app. + operationId: apigee.organizations.developers.apps.keys.updateDeveloperAppKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14578,7 +14693,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -14586,35 +14701,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - in: path - name: aliasesId + name: keysId required: true schema: type: string - in: query - name: ignoreNewlineValidation - schema: - type: boolean - - in: query - name: ignoreExpiryValidation + name: action schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr: - parameters: *ref_1 + type: string get: description: >- - Generates a PKCS #10 Certificate Signing Request for the private key in - an alias. - operationId: apigee.organizations.environments.keystores.aliases.csr + Gets details for a consumer key for a developer app, including the key + and secret value, associated API products, and other information. + operationId: apigee.organizations.developers.apps.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14626,7 +14735,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -14634,42 +14743,71 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - in: path - name: aliasesId + name: keysId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: parameters: *ref_1 - post: + put: description: >- - Creates an alias from a key/certificate pair. The structure of the - request is controlled by the `format` query parameter: - `keycertfile` - - Separate PEM-encoded key and certificate files are uploaded. Set - `Content-Type: multipart/form-data` and include the `keyFile`, - `certFile`, and `password` (if keys are encrypted) fields in the request - body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A - PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, - provide the file in the `file` field, and include the `password` field - if the file is encrypted in the request body. - `selfsignedcert` - A new - private key and certificate are generated. Set `Content-Type: - application/json` and include CertificateGenerationSpec in the request - body. - operationId: apigee.organizations.environments.keystores.aliases.create + Updates the details for a developer app. In addition, you can add an API + product to a developer app and automatically generate an API key for the + app to use when calling APIs in the API product. If you want to use an + existing API key for the API product, add the API product to the API key + using the UpdateDeveloperAppKey API. Using this API, you cannot update + the following: * App name as it is the primary key used to identify the + app and cannot be changed. * Scopes associated with the app. Instead, + use the ReplaceDeveloperAppKey API. This API replaces the existing + attributes with those specified in the request. Include or exclude any + existing attributes that you want to retain or delete, respectively. + operationId: apigee.organizations.developers.apps.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + get: + description: Returns the details for a developer app. + operationId: apigee.organizations.developers.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14681,7 +14819,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -14689,40 +14827,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - in: query - name: format - schema: - type: string - - in: query - name: alias + name: query schema: type: string - in: query - name: ignoreNewlineValidation - schema: - type: boolean - - in: query - name: _password + name: entity schema: type: string - - in: query - name: ignoreExpiryValidation - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: - parameters: *ref_1 - get: - description: Gets the certificate from an alias in PEM-encoded form. - operationId: apigee.organizations.environments.keystores.aliases.getCertificate + delete: + description: >- + Deletes a developer app. **Note**: The delete operation is asynchronous. + The developer app is deleted immediately, but its associated resources, + such as app keys or access tokens, may take anywhere from a few seconds + to a few minutes to be deleted. + operationId: apigee.organizations.developers.apps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14734,7 +14862,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -14742,25 +14870,49 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: developersId required: true schema: type: string - in: path - name: aliasesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: - parameters: *ref_1 - delete: - description: Deletes a cache. - operationId: apigee.organizations.environments.caches.delete + post: + description: >- + Manages access to a developer app by enabling you to: * Approve or + revoke a developer app * Generate a new consumer key and secret for a + developer app To approve or revoke a developer app, set the `action` + query parameter to `approve` or `revoke`, respectively, and the + `Content-Type` header to `application/octet-stream`. If a developer app + is revoked, none of its API keys are valid for API calls even though the + keys are still approved. If successful, the API call returns the + following HTTP status code: `204 No Content` To generate a new consumer + key and secret for a developer app, pass the new key/secret details. + Rather than replace an existing key, this API generates a new key. In + this case, multiple key pairs may be associated with a single developer + app. Each key pair has an independent status (`approve` or `revoke`) and + expiration time. Any approved, non-expired key can be used in an API + call. For example, if you're using API key rotation, you can generate + new keys with expiration times that overlap keys that are going to + expire. You might also generate a new consumer key/secret if the + security of the original key/secret is compromised. The `keyExpiresIn` + property defines the expiration time for the API key in milliseconds. If + you don't set this property or set it to `-1`, the API key never + expires. **Notes**: * When generating a new key/secret, this API + replaces the existing attributes, notes, and callback URLs with those + specified in the request. Include or exclude any existing information + that you want to retain or delete, respectively. * To migrate existing + consumer keys and secrets to hybrid from another system, see the + CreateDeveloperAppKey API. + operationId: >- + apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14772,7 +14924,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -14780,26 +14932,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: cachesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps: parameters: *ref_1 - get: + post: description: >- - Retrieve metrics grouped by dimensions. The types of metrics you can - retrieve include traffic, message counts, API call latency, response - size, and cache hits and counts. Dimensions let you view metrics in - meaningful groups. You can optionally pass dimensions as path parameters - to the `stats` API. If dimensions are not specified, the metrics are - computed on the entire set of data for the given time range. - operationId: apigee.organizations.environments.stats.get + Creates an app associated with a developer. This API associates the + developer app with the specified API product and auto-generates an API + key for the app to use in calls to API proxies inside that API product. + The `name` is the unique ID of the app that you can use in API calls. + The `DisplayName` (set as an attribute) appears in the UI. If you don't + set the `DisplayName` attribute, the `name` appears in the UI. + operationId: apigee.organizations.developers.apps.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14811,7 +14972,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -14819,80 +14980,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: statsId + name: developersId required: true schema: type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: tzo - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: sonar - schema: - type: boolean - - in: query - name: sortby - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: - parameters: *ref_1 get: - description: Lists all deployments of a shared flow in an environment. - operationId: apigee.organizations.environments.sharedflows.deployments.list + description: >- + Lists all apps created by a developer in an Apigee organization. + Optionally, you can request an expanded view of the developer apps. A + maximum of 100 developer apps are returned per API call. You can + paginate the list of deveoper apps returned using the `startKey` and + `count` query parameters. + operationId: apigee.organizations.developers.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14905,7 +15004,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse parameters: - in: path name: organizationsId @@ -14913,30 +15012,32 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: path - name: sharedflowsId - required: true + - in: query + name: count schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + format: int64 + - in: query + name: startKey + schema: + type: string + - in: query + name: expand + schema: + type: boolean + - in: query + name: shallowExpand + schema: + type: boolean + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: parameters: *ref_1 - post: - description: >- - Deploys a revision of a shared flow. If another revision of the same - shared flow is currently deployed, set the `override` parameter to - `true` to have this revision replace the currently deployed revision. - You cannot use a shared flow until it has been deployed to an - environment. For a request path - `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.sharedflowrevisions.deploy` on the resource - `organizations/{org}/sharedflows/{sf}/revisions/{rev}` - operationId: apigee.organizations.environments.sharedflows.revisions.deploy + get: + description: Gets details for an API product subscription. + operationId: apigee.organizations.developers.subscriptions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14948,45 +15049,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + parameters: - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - in: path - name: sharedflowsId + name: developersId required: true schema: type: string - in: path - name: revisionsId + name: subscriptionsId required: true schema: type: string - - in: query - name: override - schema: - type: boolean - - in: query - name: serviceAccount - schema: - type: string - delete: - description: >- - Undeploys a shared flow revision from an environment. For a request path - `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.sharedflowrevisions.undeploy` on the resource - `organizations/{org}/sharedflows/{sf}/revisions/{rev}` - operationId: apigee.organizations.environments.sharedflows.revisions.undeploy + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + parameters: *ref_1 + post: + description: 'Creates a subscription to an API product. ' + operationId: apigee.organizations.developers.subscriptions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14998,7 +15087,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -15006,25 +15095,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: developersId required: true schema: type: string get: - description: >- - Gets the deployment of a shared flow revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.sharedflows.revisions.getDeployments + description: Lists all API product subscriptions for a developer. + operationId: apigee.organizations.developers.subscriptions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15036,7 +15113,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse parameters: - in: path name: organizationsId @@ -15044,27 +15122,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: path - name: sharedflowsId - required: true + - in: query + name: count schema: - type: string - - in: path - name: revisionsId - required: true + type: integer + format: int32 + - in: query + name: startKey schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: parameters: *ref_1 - get: - description: >- - Lists the details and status of all analytics export jobs belonging to - the parent organization and environment. - operationId: apigee.organizations.environments.analytics.exports.list + post: + description: Expires an API product subscription immediately. + operationId: apigee.organizations.developers.subscriptions.expire + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15076,7 +15157,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -15084,22 +15165,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId + required: true + schema: + type: string + - in: path + name: subscriptionsId required: true schema: type: string + /v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust: + parameters: *ref_1 post: description: >- - Submit a data export job to be processed in the background. If the - request is successful, the API returns a 201 status, a URI that can be - used to retrieve the status of the export job, and the `state` value of - "enqueued". - operationId: apigee.organizations.environments.analytics.exports.create + Adjust the prepaid balance for the developer. This API will be used in + scenarios where the developer has been under-charged or over-charged. + operationId: apigee.organizations.developers.balance.adjust requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15111,7 +15198,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -15119,19 +15206,21 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: + /v1/organizations/{organizationsId}/developers/{developersId}/balance:credit: parameters: *ref_1 - get: - description: >- - Gets the details and status of an analytics export job. If the export - job is still in progress, its `state` is set to "running". After the - export job has completed successfully, its `state` is set to - "completed". If the export job fails, its `state` is set to `failed`. - operationId: apigee.organizations.environments.analytics.exports.get + post: + description: Credits the account balance for the developer. + operationId: apigee.organizations.developers.balance.credit + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15143,7 +15232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -15151,24 +15240,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: exportsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: parameters: *ref_1 get: - description: >- - Gets a list of metrics and dimensions that can be used to create - analytics queries and reports. Each schema element contains the name of - the field, its associated type, and a flag indicating whether it is a - standard or custom field. - operationId: apigee.organizations.environments.analytics.admin.getSchemav2 + description: Gets a CanaryEvaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15180,7 +15260,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' parameters: - in: path name: organizationsId @@ -15188,32 +15268,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - - in: query - name: disableCache - schema: - type: boolean - - in: query - name: type + - in: path + name: canaryevaluationsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions: + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: parameters: *ref_1 post: - description: >- - Tests the permissions of a user on a deployment, and returns a subset of - permissions that the user has on the deployment. If the deployment does - not exist, an empty permission set is returned (a NOT_FOUND error is not - returned). - operationId: apigee.organizations.environments.deployments.testIamPermissions + description: Creates a new canary evaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15225,7 +15298,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15233,22 +15306,26 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}: + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: parameters: *ref_1 - get: + post: description: >- - Gets a particular deployment of Api proxy or a shared flow in an - environment - operationId: apigee.organizations.environments.deployments.get + Creates a NAT address. The address is created in the RESERVED state and + a static external IP address will be provisioned. At this time, the + instance will not use this IP address for Internet egress traffic. The + address can be activated for use once any required firewall IP + whitelisting has been completed. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15260,7 +15337,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15268,31 +15345,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy: - parameters: *ref_1 - post: + get: description: >- - Sets the IAM policy on a deployment, if the policy already exists it - will be replaced. For more information, see [Manage users, roles, and - permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.deployments.setIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.deployments.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + Lists the NAT addresses for an Apigee instance. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.natAddresses.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15304,7 +15365,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse parameters: - in: path name: organizationsId @@ -15312,25 +15374,26 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy: + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: parameters: *ref_1 get: description: >- - Gets the IAM policy on a deployment. For more information, see [Manage - users, roles, and permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.deployments.getIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.deployments.getIamPolicy + Gets the details of a NAT address. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15342,7 +15405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' parameters: - in: path name: organizationsId @@ -15350,25 +15413,21 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - in: path - name: deploymentsId + name: natAddressesId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: - parameters: *ref_1 - get: - description: Lists all deployments of API proxies or shared flows in an environment. - operationId: apigee.organizations.environments.deployments.list + delete: + description: >- + Deletes the NAT address. Connections that are actively using the address + are drained before it is removed. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15380,8 +15439,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15389,19 +15447,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - - in: query - name: sharedFlows + - in: path + name: natAddressesId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: + type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: parameters: *ref_1 - delete: - description: Deletes a key value map from an environment. - operationId: apigee.organizations.environments.keyvaluemaps.delete + post: + description: >- + Activates the NAT address. The Apigee instance can now use this for + Internet egress traffic. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.natAddresses.activate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15413,7 +15480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15421,25 +15488,27 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - in: path - name: keyvaluemapsId + name: natAddressesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: parameters: *ref_1 post: - description: Creates a key value map in an environment. - operationId: apigee.organizations.environments.keyvaluemaps.create + description: >- + Creates a new attachment of an environment to an instance. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15451,7 +15520,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15459,20 +15528,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: - parameters: *ref_1 - delete: + get: description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.delete + Lists all attachments to an instance. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15484,7 +15548,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse parameters: - in: path name: organizationsId @@ -15492,30 +15557,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - - in: path - name: keyvaluemapsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: entriesId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - put: - description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.environments.keyvaluemaps.entries.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: + parameters: *ref_1 + get: + description: Gets an attachment. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15527,7 +15586,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' parameters: - in: path name: organizationsId @@ -15535,26 +15594,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: instancesId required: true schema: type: string - in: path - name: entriesId + name: attachmentsId required: true schema: type: string - get: - description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.get + delete: + description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15566,7 +15617,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15574,33 +15625,28 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: instancesId required: true schema: type: string - in: path - name: entriesId + name: attachmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: + /v1/organizations/{organizationsId}/instances/{instancesId}: parameters: *ref_1 - post: + patch: description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.create + Updates an Apigee runtime instance. You can update the fields described + in NodeConfig. No other fields will be updated. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15612,7 +15658,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15620,21 +15666,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - - in: path - name: keyvaluemapsId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask get: description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.list + Gets the details for an Apigee runtime instance. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15646,8 +15691,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' parameters: - in: path name: organizationsId @@ -15655,29 +15699,16 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: instancesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: - parameters: *ref_1 - get: - description: Gets a Reference resource. - operationId: apigee.organizations.environments.references.get + delete: + description: >- + Deletes an Apigee runtime instance. The instance stops serving requests + and the runtime data is deleted. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15689,7 +15720,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15697,20 +15728,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: referencesId + name: instancesId required: true schema: type: string - delete: + /v1/organizations/{organizationsId}/instances: + parameters: *ref_1 + post: description: >- - Deletes a Reference from an environment. Returns the deleted Reference - resource. - operationId: apigee.organizations.environments.references.delete + Creates an Apigee runtime instance. The instance is accessible from the + authorized network configured on the organization. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15722,34 +15756,56 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Lists all Apigee runtime instances for the organization. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' + parameters: - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - - in: path - name: referencesId - required: true + - in: query + name: pageToken schema: type: string - put: - description: >- - Updates an existing Reference. Note that this operation has PUT - semantics; it will replace the entirety of the existing Reference with - the resource in the request body. - operationId: apigee.organizations.environments.references.update + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: + parameters: *ref_1 + post: + description: Reports the latest status for a runtime instance. + operationId: apigee.organizations.instances.reportStatus requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15761,7 +15817,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse parameters: - in: path name: organizationsId @@ -15769,25 +15826,21 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: referencesId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references: + /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: parameters: *ref_1 post: - description: Creates a Reference in the specified environment. - operationId: apigee.organizations.environments.references.create + description: Compute RAV2 security scores for a set of resources. + operationId: apigee.organizations.securityAssessmentResults.batchCompute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15799,28 +15852,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: parameters: *ref_1 - get: + post: description: >- - After the query is completed, use this API to retrieve the results as - file. If the request succeeds, and there is a non-zero result set, the - result is downloaded to the client as a zipped JSON file. The name of - the downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.environments.securityReports.getResult + Creates a trace configuration override. The response contains a + system-generated UUID, that can be used to view, update, or delete the + configuration override. Use the List API to view the existing trace + configuration overrides. + operationId: apigee.organizations.environments.traceConfig.overrides.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15832,7 +15885,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -15844,19 +15897,11 @@ paths: required: true schema: type: string - - in: path - name: securityReportsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: - parameters: *ref_1 get: description: >- - Get security report status If the query is still in progress, the - `state` is set to "running" After the query has completed successfully, - `state` is set to "completed" - operationId: apigee.organizations.environments.securityReports.get + Lists all of the distributed trace configuration overrides in an + environment. + operationId: apigee.organizations.environments.traceConfig.overrides.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15868,7 +15913,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse parameters: - in: path name: organizationsId @@ -15880,25 +15926,20 @@ paths: required: true schema: type: string - - in: path - name: securityReportsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: parameters: *ref_1 - post: - description: >- - Submit a report request to be processed in the background. If the - submission succeeds, the API returns a 200 status and an ID that refer - to the report request. In addition to the HTTP status 200, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.environments.securityReports.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + get: + description: Gets a trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15910,7 +15951,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -15922,9 +15963,14 @@ paths: required: true schema: type: string - get: - description: Return a list of Security Reports - operationId: apigee.organizations.environments.securityReports.list + - in: path + name: overridesId + required: true + schema: + type: string + delete: + description: Deletes a distributed trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15936,8 +15982,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -15949,42 +15994,23 @@ paths: required: true schema: type: string - - in: query - name: from - schema: - type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: status - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: dataset + - in: path + name: overridesId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: - parameters: *ref_1 - get: + patch: description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.environments.securityReports.getResultView + Updates a distributed trace configuration override. Note that the + repeated fields have replace semantics when included in the field mask + and that they will be overwritten by the value of the fields in the + request body. + operationId: apigee.organizations.environments.traceConfig.overrides.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15996,8 +16022,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -16010,15 +16035,23 @@ paths: schema: type: string - in: path - name: securityReportsId + name: overridesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: parameters: *ref_1 get: - description: Lists all deployments of an API proxy in an environment. - operationId: apigee.organizations.environments.apis.deployments.list + description: >- + Lists all resource files, optionally filtering by type. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16031,7 +16064,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -16043,22 +16076,22 @@ paths: required: true schema: type: string - - in: path - name: apisId - required: true + - in: query + name: type schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: - parameters: *ref_1 - delete: + post: description: >- - Undeploys an API proxy revision from an environment. For a request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.undeploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: apigee.organizations.environments.apis.revisions.undeploy + Creates a resource file. Specify the `Content-Type` as + `application/octet-stream` or `multipart/form-data`. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16070,7 +16103,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -16082,25 +16115,22 @@ paths: required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true + - in: query + name: name schema: type: string - in: query - name: sequencedRollout + name: type schema: - type: boolean + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: + parameters: *ref_1 get: description: >- - Gets the deployment of an API proxy revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.apis.revisions.getDeployments + Lists all resource files, optionally filtering by type. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.listEnvironmentResources security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16112,7 +16142,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -16125,30 +16156,24 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: type required: true schema: type: string - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: + parameters: *ref_1 + put: description: >- - Deploys a revision of an API proxy. If another revision of the same API - proxy revision is currently deployed, set the `override` parameter to - `true` to have this revision replace the currently deployed revision. - You cannot invoke an API proxy until it has been deployed to an - environment. After you deploy an API proxy revision, you cannot edit it. - To edit the API proxy, you must create and deploy a new revision. For a - request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.deploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: apigee.organizations.environments.apis.revisions.deploy + Updates a resource file. Specify the `Content-Type` as + `application/octet-stream` or `multipart/form-data`. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16160,7 +16185,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -16173,46 +16198,21 @@ paths: schema: type: string - in: path - name: apisId + name: type required: true schema: type: string - in: path - name: revisionsId + name: name required: true schema: type: string - - in: query - name: serviceAccount - schema: - type: string - - in: query - name: override - schema: - type: boolean - - in: query - name: sequencedRollout - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: - parameters: *ref_1 - post: + get: description: >- - Generates a report for a dry run analysis of a DeployApiProxy request - without committing the deployment. In addition to the standard - validations performed when adding deployments, additional analysis will - be done to detect possible traffic routing changes that would result - from this deployment being created. Any potential routing conflicts or - unsafe changes will be reported in the response. This routing analysis - is not performed for a non-dry-run DeployApiProxy request. For a request - path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.deploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: >- - apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport + Gets the contents of a resource file. For more information about + resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16224,7 +16224,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -16237,37 +16237,21 @@ paths: schema: type: string - in: path - name: apisId + name: type required: true schema: type: string - in: path - name: revisionsId + name: name required: true schema: type: string - - in: query - name: override - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: - parameters: *ref_1 - post: + delete: description: >- - Generates a report for a dry run analysis of an UndeployApiProxy request - without committing the undeploy. In addition to the standard validations - performed when removing deployments, additional analysis will be done to - detect possible traffic routing changes that would result from this - deployment being removed. Any potential routing conflicts or unsafe - changes will be reported in the response. This routing analysis is not - performed for a non-dry-run UndeployApiProxy request. For a request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.undeploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: >- - apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport + Deletes a resource file. For more information about resource files, see + [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16279,7 +16263,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -16292,20 +16276,24 @@ paths: schema: type: string - in: path - name: apisId + name: type required: true schema: type: string - in: path - name: revisionsId + name: name required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: parameters: *ref_1 get: - description: Gets the debug data from a transaction. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get + description: >- + Gets a list of metrics and dimensions that can be used to create + analytics queries and reports. Each schema element contains the name of + the field, its associated type, and a flag indicating whether it is a + standard or custom field. + operationId: apigee.organizations.environments.analytics.admin.getSchemav2 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16317,8 +16305,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction + $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' parameters: - in: path name: organizationsId @@ -16330,35 +16317,21 @@ paths: required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId - required: true + - in: query + name: type schema: type: string - - in: path - name: dataId - required: true + - in: query + name: disableCache schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: parameters: *ref_1 - delete: + get: description: >- - Deletes the data from a debug session. This does not cancel the debug - session or prevent further data from being collected if the session is - still active in runtime pods. - operationId: >- - apigee.organizations.environments.apis.revisions.debugsessions.deleteData + Lists the details and status of all analytics export jobs belonging to + the parent organization and environment. + operationId: apigee.organizations.environments.analytics.exports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16370,7 +16343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' parameters: - in: path name: organizationsId @@ -16382,28 +16355,50 @@ paths: required: true schema: type: string + post: + description: >- + Submit a data export job to be processed in the background. If the + request is successful, the API returns a 201 status, a URI that can be + used to retrieve the status of the export job, and the `state` value of + "enqueued". + operationId: apigee.organizations.environments.analytics.exports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + parameters: - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: organizationsId required: true schema: type: string - in: path - name: debugsessionsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: parameters: *ref_1 get: description: >- - Lists debug sessions that are currently active in the given API Proxy - revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.list + Gets the details and status of an analytics export job. If the export + job is still in progress, its `state` is set to "running". After the + export job has completed successfully, its `state` is set to + "completed". If the export job fails, its `state` is set to `failed`. + operationId: apigee.organizations.environments.analytics.exports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16415,8 +16410,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -16429,32 +16423,26 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: exportsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy: + parameters: *ref_1 post: - description: Creates a debug session for a deployed API Proxy revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.create + description: >- + Sets the IAM policy on a deployment, if the policy already exists it + will be replaced. For more information, see [Manage users, roles, and + permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.deployments.setIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.deployments.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16466,7 +16454,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -16479,25 +16467,24 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: deploymentsId required: true schema: - type: string - - in: query - name: timeout - schema: - type: string - format: int64 - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions: parameters: *ref_1 - get: - description: Retrieves a debug session. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.get + post: + description: >- + Tests the permissions of a user on a deployment, and returns a subset of + permissions that the user has on the deployment. If the deployment does + not exist, an empty permission set is returned (a NOT_FOUND error is not + returned). + operationId: apigee.organizations.environments.deployments.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16509,7 +16496,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId @@ -16522,28 +16509,17 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId + name: deploymentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}: parameters: *ref_1 get: description: >- - Gets the contents of a resource file. For more information about - resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.get + Gets a particular deployment of Api proxy or a shared flow in an + environment + operationId: apigee.organizations.environments.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16555,7 +16531,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -16568,21 +16544,15 @@ paths: schema: type: string - in: path - name: type - required: true - schema: - type: string - - in: path - name: name + name: deploymentsId required: true schema: type: string - delete: - description: >- - Deletes a resource file. For more information about resource files, see - [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of API proxies or shared flows in an environment. + operationId: apigee.organizations.environments.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16594,7 +16564,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -16606,28 +16577,20 @@ paths: required: true schema: type: string - - in: path - name: type - required: true - schema: - type: string - - in: path - name: name - required: true + - in: query + name: sharedFlows schema: - type: string - put: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy: + parameters: *ref_1 + get: description: >- - Updates a resource file. Specify the `Content-Type` as - `application/octet-stream` or `multipart/form-data`. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + Gets the IAM policy on a deployment. For more information, see [Manage + users, roles, and permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.deployments.getIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.deployments.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16639,7 +16602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -16652,29 +16615,20 @@ paths: schema: type: string - in: path - name: type + name: deploymentsId required: true schema: type: string - - in: path - name: name - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: parameters: *ref_1 - post: - description: >- - Creates a resource file. Specify the `Content-Type` as - `application/octet-stream` or `multipart/form-data`. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + get: + description: Similar to GetStats except that the response is less verbose. + operationId: apigee.organizations.environments.optimizedStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16686,7 +16640,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId @@ -16698,20 +16652,76 @@ paths: required: true schema: type: string + - in: path + name: optimizedStatsId + required: true + schema: + type: string - in: query - name: name + name: topk schema: type: string - in: query - name: type + name: aggTable schema: type: string - get: - description: >- - Lists all resource files, optionally filtering by type. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.list + - in: query + name: timeRange + schema: + type: string + - in: query + name: sonar + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: limit + schema: + type: string + - in: query + name: select + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: offset + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: accuracy + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: + parameters: *ref_1 + delete: + description: Deletes a keystore or truststore. + operationId: apigee.organizations.environments.keystores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16723,8 +16733,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -16736,18 +16745,14 @@ paths: required: true schema: type: string - - in: query - name: type + - in: path + name: keystoresId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: - parameters: *ref_1 get: - description: >- - Lists all resource files, optionally filtering by type. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.listEnvironmentResources + description: Gets a keystore or truststore. + operationId: apigee.organizations.environments.keystores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16759,8 +16764,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -16773,15 +16777,25 @@ paths: schema: type: string - in: path - name: type + name: keystoresId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: parameters: *ref_1 - get: - description: Gets the specified ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.get + post: + description: >- + Creates a keystore or truststore. - Keystore: Contains certificates and + their associated keys. - Truststore: Contains trusted certificates used + to validate a server's certificate. These certificates are typically + self-signed certificates or certificates that are not signed by a + trusted CA. + operationId: apigee.organizations.environments.keystores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16793,7 +16807,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -16805,21 +16819,32 @@ paths: required: true schema: type: string - - in: path - name: archiveDeploymentsId - required: true + - in: query + name: name schema: type: string - patch: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: + parameters: *ref_1 + post: description: >- - Updates an existing ArchiveDeployment. Labels can modified but most of - the other fields are not modifiable. - operationId: apigee.organizations.environments.archiveDeployments.patch + Creates an alias from a key/certificate pair. The structure of the + request is controlled by the `format` query parameter: - `keycertfile` - + Separate PEM-encoded key and certificate files are uploaded. Set + `Content-Type: multipart/form-data` and include the `keyFile`, + `certFile`, and `password` (if keys are encrypted) fields in the request + body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A + PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, + provide the file in the `file` field, and include the `password` field + if the file is encrypted in the request body. - `selfsignedcert` - A new + private key and certificate are generated. Set `Content-Type: + application/json` and include CertificateGenerationSpec in the request + body. + operationId: apigee.organizations.environments.keystores.aliases.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16831,7 +16856,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -16844,18 +16869,35 @@ paths: schema: type: string - in: path - name: archiveDeploymentsId + name: keystoresId required: true schema: type: string - in: query - name: updateMask + name: format schema: type: string - format: google-fieldmask - delete: - description: Deletes an archive deployment. - operationId: apigee.organizations.environments.archiveDeployments.delete + - in: query + name: _password + schema: + type: string + - in: query + name: alias + schema: + type: string + - in: query + name: ignoreNewlineValidation + schema: + type: boolean + - in: query + name: ignoreExpiryValidation + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: + parameters: *ref_1 + get: + description: Gets an alias. + operationId: apigee.organizations.environments.keystores.aliases.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16867,7 +16909,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -16880,20 +16922,23 @@ paths: schema: type: string - in: path - name: archiveDeploymentsId + name: keystoresId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: - parameters: *ref_1 - post: - description: Creates a new ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.create + - in: path + name: aliasesId + required: true + schema: + type: string + put: + description: Updates the certificate in an alias. + operationId: apigee.organizations.environments.keystores.aliases.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16905,7 +16950,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -16917,9 +16962,27 @@ paths: required: true schema: type: string - get: - description: Lists the ArchiveDeployments in the specified Environment. - operationId: apigee.organizations.environments.archiveDeployments.list + - in: path + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId + required: true + schema: + type: string + - in: query + name: ignoreNewlineValidation + schema: + type: boolean + - in: query + name: ignoreExpiryValidation + schema: + type: boolean + delete: + description: Deletes an alias. + operationId: apigee.organizations.environments.keystores.aliases.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16931,8 +16994,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -16944,41 +17006,21 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: keystoresId + required: true schema: type: string - - in: query - name: filter + - in: path + name: aliasesId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: parameters: *ref_1 - post: - description: >- - Generates a signed URL for uploading an Archive zip file to Google Cloud - Storage. Once the upload is complete, the signed URL should be passed to - CreateArchiveDeployment. When uploading to the generated signed URL, - please follow these restrictions: * Source file type should be a zip - file. * Source file size should not exceed 1GB limit. * No credentials - should be attached - the signed URLs provide access to the target bucket - using internal service identity; if credentials were attached, the - identity from the credentials would be used, but that identity does not - have permissions to upload files to the URL. When making a HTTP PUT - request, these two headers need to be specified: * `content-type: - application/zip` * `x-goog-content-length-range: 0,1073741824` And this - header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` - operationId: apigee.organizations.environments.archiveDeployments.generateUploadUrl - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlRequest' + get: + description: Gets the certificate from an alias in PEM-encoded form. + operationId: apigee.organizations.environments.keystores.aliases.getCertificate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16990,8 +17032,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -17003,21 +17044,23 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: + - in: path + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr: parameters: *ref_1 - post: + get: description: >- - Generates a signed URL for downloading the original zip file used to - create an Archive Deployment. The URL is only valid for a limited period - and should be used within minutes after generation. Each call returns a - new upload URL. - operationId: apigee.organizations.environments.archiveDeployments.generateDownloadUrl - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlRequest + Generates a PKCS #10 Certificate Signing Request for the private key in + an alias. + operationId: apigee.organizations.environments.keystores.aliases.csr security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17029,8 +17072,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -17043,15 +17085,25 @@ paths: schema: type: string - in: path - name: archiveDeploymentsId + name: keystoresId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: + - in: path + name: aliasesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: parameters: *ref_1 get: - description: Similar to GetStats except that the response is less verbose. - operationId: apigee.organizations.environments.optimizedStats.get + description: >- + After the query is completed, use this API to retrieve the results as + file. If the request succeeds, and there is a non-zero result set, the + result is downloaded to the client as a zipped JSON file. The name of + the downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.environments.securityReports.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17063,7 +17115,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -17076,84 +17128,24 @@ paths: schema: type: string - in: path - name: optimizedStatsId + name: securityReportsId required: true schema: type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: sonar - schema: - type: boolean - - in: query - name: realtime - schema: - type: boolean - - in: query - name: filter - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: tzo - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: sort - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: parameters: *ref_1 - patch: - description: >- - Updates a distributed trace configuration override. Note that the - repeated fields have replace semantics when included in the field mask - and that they will be overwritten by the value of the fields in the - request body. - operationId: apigee.organizations.environments.traceConfig.overrides.patch + post: + description: >- + Submit a report request to be processed in the background. If the + submission succeeds, the API returns a 200 status and an ID that refer + to the report request. In addition to the HTTP status 200, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.environments.securityReports.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17165,7 +17157,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -17177,19 +17169,70 @@ paths: required: true schema: type: string + get: + description: Return a list of Security Reports + operationId: apigee.organizations.environments.securityReports.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + parameters: - in: path - name: overridesId + name: organizationsId + required: true + schema: + type: string + - in: path + name: environmentsId required: true schema: type: string - in: query - name: updateMask + name: from schema: type: string - format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: dataset + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: submittedBy + schema: + type: string + - in: query + name: to + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: + parameters: *ref_1 get: - description: Gets a trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.get + description: >- + Get security report status If the query is still in progress, the + `state` is set to "running" After the query has completed successfully, + `state` is set to "completed" + operationId: apigee.organizations.environments.securityReports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17201,7 +17244,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -17214,13 +17257,17 @@ paths: schema: type: string - in: path - name: overridesId + name: securityReportsId required: true schema: type: string - delete: - description: Deletes a distributed trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: + parameters: *ref_1 + get: + description: >- + After the query is completed, use this API to view the query result when + result size is small. + operationId: apigee.organizations.environments.securityReports.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17232,7 +17279,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -17245,17 +17293,15 @@ paths: schema: type: string - in: path - name: overridesId + name: securityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: parameters: *ref_1 get: - description: >- - Lists all of the distributed trace configuration overrides in an - environment. - operationId: apigee.organizations.environments.traceConfig.overrides.list + description: Return a list of Asynchronous Queries + operationId: apigee.organizations.environments.queries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17268,7 +17314,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId @@ -17281,26 +17327,41 @@ paths: schema: type: string - in: query - name: pageSize + name: submittedBy schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: status + schema: + type: string + - in: query + name: to + schema: + type: string + - in: query + name: dataset + schema: + type: string + - in: query + name: from + schema: + type: string + - in: query + name: inclQueriesWithoutReport schema: type: string post: description: >- - Creates a trace configuration override. The response contains a - system-generated UUID, that can be used to view, update, or delete the - configuration override. Use the List API to view the existing trace - configuration overrides. - operationId: apigee.organizations.environments.traceConfig.overrides.create + Submit a query to be processed in the background. If the submission of + the query succeeds, the API returns a 201 status and an ID that refer to + the query. In addition to the HTTP status 201, the `state` of "enqueued" + means that the request succeeded. + operationId: apigee.organizations.environments.queries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17312,7 +17373,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -17324,13 +17385,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: parameters: *ref_1 get: description: >- - Returns a list of SecurityActions. This returns both enabled and - disabled actions. - operationId: apigee.organizations.environments.securityActions.list + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.environments.queries.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17342,8 +17406,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -17355,27 +17418,19 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: queriesId + required: true schema: type: string - post: - description: CreateSecurityAction creates a SecurityAction. - operationId: apigee.organizations.environments.securityActions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: + parameters: *ref_1 + get: + description: >- + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + sent to the client as a list of urls to JSON files. + operationId: apigee.organizations.environments.queries.getResulturl security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17387,7 +17442,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse parameters: - in: path name: organizationsId @@ -17399,15 +17455,19 @@ paths: required: true schema: type: string - - in: query - name: securityActionId + - in: path + name: queriesId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: parameters: *ref_1 get: - description: Get a SecurityAction by name. - operationId: apigee.organizations.environments.securityActions.get + description: >- + Get query status If the query is still in progress, the `state` is set + to "running" After the query has completed successfully, `state` is set + to "completed" + operationId: apigee.organizations.environments.queries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17419,7 +17479,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -17432,25 +17492,15 @@ paths: schema: type: string - in: path - name: securityActionsId + name: queriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: parameters: *ref_1 - post: - description: >- - Enable a SecurityAction. The `state` of the SecurityAction after - enabling is `ENABLED`. `EnableSecurityAction` can be called on - SecurityActions in the state `DISABLED`; SecurityActions in a different - state (including `ENABLED) return an error. - operationId: apigee.organizations.environments.securityActions.enable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnableSecurityActionRequest + delete: + description: Deletes a key value map from an environment. + operationId: apigee.organizations.environments.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17462,7 +17512,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -17475,25 +17525,20 @@ paths: schema: type: string - in: path - name: securityActionsId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: parameters: *ref_1 post: - description: >- - Disable a SecurityAction. The `state` of the SecurityAction after - disabling is `DISABLED`. `DisableSecurityAction` can be called on - SecurityActions in the state `ENABLED`; SecurityActions in a different - state (including `DISABLED`) return an error. - operationId: apigee.organizations.environments.securityActions.disable + description: Creates a key value map in an environment. + operationId: apigee.organizations.environments.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17505,7 +17550,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -17517,21 +17562,18 @@ paths: required: true schema: type: string - - in: path - name: securityActionsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_1 - patch: - description: UpdateSecurityIncidents updates an existing security incident. - operationId: apigee.organizations.environments.securityIncidents.patch + put: + description: >- + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.environments.keyvaluemaps.entries.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17543,7 +17585,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -17556,21 +17598,23 @@ paths: schema: type: string - in: path - name: securityIncidentsId + name: keyvaluemapsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: entriesId + required: true schema: type: string - format: google-fieldmask - get: + delete: description: >- - GetSecurityIncident gets the specified security incident. Returns - NOT_FOUND if security incident is not present for the specified - organization and environment. - operationId: apigee.organizations.environments.securityIncidents.get + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17582,7 +17626,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -17595,17 +17639,21 @@ paths: schema: type: string - in: path - name: securityIncidentsId + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: - parameters: *ref_1 get: description: >- - ListSecurityIncidents lists all the security incident associated with - the environment. - operationId: apigee.organizations.environments.securityIncidents.list + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17617,8 +17665,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -17630,32 +17677,24 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: keyvaluemapsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: entriesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_1 - post: + get: description: >- - BatchUpdateSecurityIncident updates multiple existing security - incidents. - operationId: apigee.organizations.environments.securityIncidents.batchUpdate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17668,7 +17707,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -17680,16 +17719,31 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: - parameters: *ref_1 + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Retrieve security statistics as tabular rows. - operationId: apigee.organizations.environments.securityStats.queryTabularStats + description: >- + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17701,8 +17755,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -17714,17 +17767,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: parameters: *ref_1 - post: - description: Retrieve security statistics as a collection of time series. - operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + get: + description: Lists all deployments of an API proxy in an environment. + operationId: apigee.organizations.environments.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17737,7 +17789,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -17749,16 +17801,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: + - in: path + name: apisId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: parameters: *ref_1 get: - description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.environments.queries.getResult + description: Gets the debug data from a transaction. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17770,7 +17822,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction parameters: - in: path name: organizationsId @@ -17783,24 +17836,35 @@ paths: schema: type: string - in: path - name: queriesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: path + name: debugsessionsId + required: true + schema: + type: string + - in: path + name: dataId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: parameters: *ref_1 post: - description: >- - Submit a query to be processed in the background. If the submission of - the query succeeds, the API returns a 201 status and an ID that refer to - the query. In addition to the HTTP status 201, the `state` of "enqueued" - means that the request succeeded. - operationId: apigee.organizations.environments.queries.create + description: Creates a debug session for a deployed API Proxy revision. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Query' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17812,7 +17876,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId @@ -17824,65 +17888,26 @@ paths: required: true schema: type: string - get: - description: Return a list of Asynchronous Queries - operationId: apigee.organizations.environments.queries.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse - parameters: - in: path - name: organizationsId + name: apisId required: true schema: type: string - in: path - name: environmentsId + name: revisionsId required: true schema: type: string - in: query - name: to - schema: - type: string - - in: query - name: inclQueriesWithoutReport - schema: - type: string - - in: query - name: from - schema: - type: string - - in: query - name: status - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: submittedBy + name: timeout schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: - parameters: *ref_1 + format: int64 get: description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - sent to the client as a list of urls to JSON files. - operationId: apigee.organizations.environments.queries.getResulturl + Lists debug sessions that are currently active in the given API Proxy + revision. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17895,7 +17920,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse + #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse parameters: - in: path name: organizationsId @@ -17908,18 +17933,33 @@ paths: schema: type: string - in: path - name: queriesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: parameters: *ref_1 - get: - description: >- - Get query status If the query is still in progress, the `state` is set - to "running" After the query has completed successfully, `state` is set - to "completed" - operationId: apigee.organizations.environments.queries.get + delete: + description: >- + Deletes the data from a debug session. This does not cancel the debug + session or prevent further data from being collected if the session is + still active in runtime pods. + operationId: >- + apigee.organizations.environments.apis.revisions.debugsessions.deleteData security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17931,7 +17971,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17944,49 +17984,25 @@ paths: schema: type: string - in: path - name: queriesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: - parameters: *ref_1 - post: - description: Updates an add-on enablement status of an environment. - operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SetAddonEnablementRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: organizationsId + name: revisionsId required: true schema: type: string - in: path - name: environmentsId + name: debugsessionsId required: true schema: type: string - /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}: parameters: *ref_1 get: - description: Gets the endpoint attachment. - operationId: apigee.organizations.endpointAttachments.get + description: Retrieves a debug session. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17998,7 +18014,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId @@ -18006,48 +18022,43 @@ paths: schema: type: string - in: path - name: endpointAttachmentsId + name: environmentsId required: true schema: type: string - delete: - description: Deletes an endpoint attachment. - operationId: apigee.organizations.endpointAttachments.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: organizationsId + name: apisId required: true schema: type: string - in: path - name: endpointAttachmentsId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/endpointAttachments: + - in: path + name: debugsessionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: parameters: *ref_1 post: description: >- - Creates an endpoint attachment. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.endpointAttachments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + Generates a report for a dry run analysis of an UndeployApiProxy request + without committing the undeploy. In addition to the standard validations + performed when removing deployments, additional analysis will be done to + detect possible traffic routing changes that would result from this + deployment being removed. Any potential routing conflicts or unsafe + changes will be reported in the response. This routing analysis is not + performed for a non-dry-run UndeployApiProxy request. For a request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.undeploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: >- + apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18059,58 +18070,47 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: endpointAttachmentId + - in: path + name: environmentsId + required: true schema: type: string - get: - description: Lists the endpoint attachments in an organization. - operationId: apigee.organizations.endpointAttachments.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse - parameters: - in: path - name: organizationsId + name: apisId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: revisionsId + required: true schema: type: string - /v1/organizations/{organizationsId}/reports/{reportsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: parameters: *ref_1 - put: - description: Update an existing custom report definition - operationId: apigee.organizations.reports.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + post: + description: >- + Generates a report for a dry run analysis of a DeployApiProxy request + without committing the deployment. In addition to the standard + validations performed when adding deployments, additional analysis will + be done to detect possible traffic routing changes that would result + from this deployment being created. Any potential routing conflicts or + unsafe changes will be reported in the response. This routing analysis + is not performed for a non-dry-run DeployApiProxy request. For a request + path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.deploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: >- + apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18122,7 +18122,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId @@ -18130,40 +18130,41 @@ paths: schema: type: string - in: path - name: reportsId + name: environmentsId required: true schema: type: string - delete: - description: Deletes an existing custom report definition - operationId: apigee.organizations.reports.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse - parameters: - in: path - name: organizationsId + name: apisId required: true schema: type: string - in: path - name: reportsId + name: revisionsId required: true schema: type: string - get: - description: Retrieve a custom report definition. - operationId: apigee.organizations.reports.get + - in: query + name: override + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 + post: + description: >- + Deploys a revision of an API proxy. If another revision of the same API + proxy revision is currently deployed, set the `override` parameter to + `true` to have this revision replace the currently deployed revision. + You cannot invoke an API proxy until it has been deployed to an + environment. After you deploy an API proxy revision, you cannot edit it. + To edit the API proxy, you must create and deploy a new revision. For a + request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.deploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: apigee.organizations.environments.apis.revisions.deploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18175,7 +18176,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -18183,27 +18184,41 @@ paths: schema: type: string - in: path - name: reportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/reports: - parameters: *ref_1 - post: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: override + schema: + type: boolean + - in: query + name: serviceAccount + schema: + type: string + - in: query + name: sequencedRollout + schema: + type: boolean + delete: description: >- - Creates a Custom Report for an Organization. A Custom Report provides - Apigee Customers to create custom dashboards in addition to the standard - dashboards which are provided. The Custom Report in its simplest form - contains specifications about metrics, dimensions and filters. It is - important to note that the custom report by itself does not provide an - executable entity. The Edge UI converts the custom report definition - into an analytics query and displays the result in a chart. - operationId: apigee.organizations.reports.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + Undeploys an API proxy revision from an environment. For a request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.undeploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: apigee.organizations.environments.apis.revisions.undeploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18215,16 +18230,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: sequencedRollout + schema: + type: boolean get: - description: Return a list of Custom Reports - operationId: apigee.organizations.reports.list + description: >- + Gets the deployment of an API proxy revision and actual state reported + by runtime pods. + operationId: apigee.organizations.environments.apis.revisions.getDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18236,26 +18272,43 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: expand + - in: path + name: environmentsId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/apps: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: parameters: *ref_1 - get: + post: description: >- - Lists IDs of apps within an organization that have the specified app - status (approved or revoked) or are of the specified app type (developer - or company). - operationId: apigee.organizations.apps.list + Generates a signed URL for downloading the original zip file used to + create an Archive Deployment. The URL is only valid for a limited period + and should be used within minutes after generation. Each call returns a + new upload URL. + operationId: apigee.organizations.environments.archiveDeployments.generateDownloadUrl + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18267,68 +18320,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: ids - schema: - type: string - - in: query - name: includeCred - schema: - type: boolean - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: status - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: keyStatus - schema: - type: string - - in: query - name: rows - schema: - type: string - format: int64 - - in: query - name: expand - schema: - type: boolean - - in: query - name: apiProduct - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: startKey + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: apptype + - in: path + name: archiveDeploymentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/apps/{appsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: parameters: *ref_1 - get: - description: Gets the app profile for the specified app ID. - operationId: apigee.organizations.apps.get + post: + description: >- + Generates a signed URL for uploading an Archive zip file to Google Cloud + Storage. Once the upload is complete, the signed URL should be passed to + CreateArchiveDeployment. When uploading to the generated signed URL, + please follow these restrictions: * Source file type should be a zip + file. * Source file size should not exceed 1GB limit. * No credentials + should be attached - the signed URLs provide access to the target bucket + using internal service identity; if credentials were attached, the + identity from the credentials would be used, but that identity does not + have permissions to upload files to the URL. When making a HTTP PUT + request, these two headers need to be specified: * `content-type: + application/zip` * `x-goog-content-length-range: 0,1073741824` And this + header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` + operationId: apigee.organizations.environments.archiveDeployments.generateUploadUrl + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18340,7 +18371,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse parameters: - in: path name: organizationsId @@ -18348,15 +18380,15 @@ paths: schema: type: string - in: path - name: appsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: parameters: *ref_1 - get: - description: '' - operationId: apigee.organizations.hostQueries.getResultView + delete: + description: Deletes an archive deployment. + operationId: apigee.organizations.environments.archiveDeployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18368,7 +18400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -18376,15 +18408,25 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries: - parameters: *ref_1 - get: - description: Return a list of Asynchronous Queries at host level. - operationId: apigee.organizations.hostQueries.list + - in: path + name: archiveDeploymentsId + required: true + schema: + type: string + patch: + description: >- + Updates an existing ArchiveDeployment. Labels can modified but most of + the other fields are not modifiable. + operationId: apigee.organizations.environments.archiveDeployments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18396,54 +18438,31 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: from - schema: - type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: inclQueriesWithoutReport + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: envgroupHostname + - in: path + name: archiveDeploymentsId + required: true schema: type: string - in: query - name: status + name: updateMask schema: type: string - post: - description: >- - Submit a query at host level to be processed in the background. If the - submission of the query succeeds, the API returns a 201 status and an ID - that refer to the query. In addition to the HTTP status 201, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.hostQueries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Query' + format: google-fieldmask + get: + description: Gets the specified ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18455,23 +18474,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: - parameters: *ref_1 - get: - description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.hostQueries.getResult + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: archiveDeploymentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: + parameters: *ref_1 + post: + description: Creates a new ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18483,7 +18512,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18491,18 +18520,13 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: - parameters: *ref_1 get: - description: >- - Get status of a query submitted at host level. If the query is still in - progress, the `state` is set to "running" After the query has completed - successfully, `state` is set to "completed" - operationId: apigee.organizations.hostQueries.get + description: Lists the ArchiveDeployments in the specified Environment. + operationId: apigee.organizations.environments.archiveDeployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18514,7 +18538,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse parameters: - in: path name: organizationsId @@ -18522,23 +18547,28 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: parameters: *ref_1 - post: - description: >- - CreateSecurityProfileEnvironmentAssociation creates profile environment - association i.e. attaches environment to security profile. - operationId: apigee.organizations.securityProfiles.environments.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + get: + description: Gets a TargetServer resource. + operationId: apigee.organizations.environments.targetservers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18550,8 +18580,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -18559,17 +18588,20 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId + required: true + schema: + type: string + - in: path + name: targetserversId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: - parameters: *ref_1 delete: description: >- - DeleteSecurityProfileEnvironmentAssociation removes profile environment - association i.e. detaches environment from security profile. - operationId: apigee.organizations.securityProfiles.environments.delete + Deletes a TargetServer from an environment. Returns the deleted + TargetServer resource. + operationId: apigee.organizations.environments.targetservers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18581,7 +18613,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -18589,29 +18621,26 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - in: path - name: environmentsId + name: targetserversId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: - parameters: *ref_1 - post: + put: description: >- - ComputeEnvironmentScores calculates scores for requested time range for - the specified security profile and environment. - operationId: >- - apigee.organizations.securityProfiles.environments.computeEnvironmentScores + Updates an existing TargetServer. Note that this operation has PUT + semantics; it will replace the entirety of the existing TargetServer + with the resource in the request body. + operationId: apigee.organizations.environments.targetservers.update requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18623,8 +18652,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -18632,23 +18660,25 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - in: path - name: environmentsId + name: targetserversId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: parameters: *ref_1 - get: - description: >- - GetSecurityProfile gets the specified security profile. Returns - NOT_FOUND if security profile is not present for the specified - organization. - operationId: apigee.organizations.securityProfiles.get + post: + description: Creates a TargetServer in the specified environment. + operationId: apigee.organizations.environments.targetservers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18660,7 +18690,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -18668,13 +18698,27 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - delete: - description: DeleteSecurityProfile delete a profile with all its revisions. - operationId: apigee.organizations.securityProfiles.delete + - in: query + name: name + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: + parameters: *ref_1 + put: + description: >- + Updates an existing Reference. Note that this operation has PUT + semantics; it will replace the entirety of the existing Reference with + the resource in the request body. + operationId: apigee.organizations.environments.references.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18686,7 +18730,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -18694,18 +18738,20 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - patch: - description: UpdateSecurityProfile update the metadata of security profile. - operationId: apigee.organizations.securityProfiles.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + - in: path + name: referencesId + required: true + schema: + type: string + delete: + description: >- + Deletes a Reference from an environment. Returns the deleted Reference + resource. + operationId: apigee.organizations.environments.references.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18717,7 +18763,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -18725,25 +18771,18 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: referencesId + required: true schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/securityProfiles: - parameters: *ref_1 - post: - description: CreateSecurityProfile create a new custom security profile. - operationId: apigee.organizations.securityProfiles.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + get: + description: Gets a Reference resource. + operationId: apigee.organizations.environments.references.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18755,22 +18794,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: securityProfileId + - in: path + name: environmentsId + required: true schema: type: string - get: - description: >- - ListSecurityProfiles lists all the security profiles associated with the - org including attached and unattached profiles. - operationId: apigee.organizations.securityProfiles.list + - in: path + name: referencesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/references: + parameters: *ref_1 + post: + description: Creates a Reference in the specified environment. + operationId: apigee.organizations.environments.references.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18782,30 +18832,29 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: parameters: *ref_1 - get: - description: >- - ListSecurityProfileRevisions lists all the revisions of the security - profile. - operationId: apigee.organizations.securityProfiles.listRevisions + post: + description: Updates an add-on enablement status of an environment. + operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SetAddonEnablementRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18817,8 +18866,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18826,24 +18874,18 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: parameters: *ref_1 get: - description: Lists all deployments of a shared flow revision. - operationId: apigee.organizations.sharedflows.revisions.deployments.list + description: >- + GetSecurityIncident gets the specified security incident. Returns + NOT_FOUND if security incident is not present for the specified + organization and environment. + operationId: apigee.organizations.environments.securityIncidents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18855,8 +18897,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId @@ -18864,30 +18905,23 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - in: path - name: revisionsId + name: securityIncidentsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: - parameters: *ref_1 - post: - description: >- - Updates a shared flow revision. This operation is only allowed on - revisions which have never been deployed. After deployment a revision - becomes immutable, even if it becomes undeployed. The payload is a - ZIP-formatted shared flow. Content type must be either - multipart/form-data or application/octet-stream. - operationId: apigee.organizations.sharedflows.revisions.updateSharedFlowRevision + patch: + description: UpdateSecurityIncidents updates an existing security incident. + operationId: apigee.organizations.environments.securityIncidents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18899,7 +18933,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId @@ -18907,29 +18941,33 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - in: path - name: revisionsId + name: securityIncidentsId required: true schema: type: string - in: query - name: validate + name: updateMask schema: - type: boolean - get: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: + parameters: *ref_1 + post: description: >- - Gets a revision of a shared flow. To download the shared flow - configuration bundle for the specified revision as a zip file, set the - `format` query parameter to `bundle`. If you are using curl, specify `-o - filename.zip` to save the output to a file; otherwise, it displays to - `stdout`. Then, develop the shared flow configuration locally and upload - the updated sharedFlow configuration revision, as described in - [updateSharedFlowRevision](updateSharedFlowRevision). - operationId: apigee.organizations.sharedflows.revisions.get + BatchUpdateSecurityIncident updates multiple existing security + incidents. + operationId: apigee.organizations.environments.securityIncidents.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18941,7 +18979,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -18949,24 +18988,17 @@ paths: schema: type: string - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: environmentsId required: true schema: type: string - - in: query - name: format - schema: - type: string - delete: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: + parameters: *ref_1 + get: description: >- - Deletes a shared flow and all associated policies, resources, and - revisions. You must undeploy the shared flow before deleting it. - operationId: apigee.organizations.sharedflows.revisions.delete + ListSecurityIncidents lists all the security incident associated with + the environment. + operationId: apigee.organizations.environments.securityIncidents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18978,7 +19010,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -18986,20 +19019,34 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: parameters: *ref_1 - get: - description: Lists all deployments of a shared flow. - operationId: apigee.organizations.sharedflows.deployments.list + post: + description: Retrieve security statistics as a collection of time series. + operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19012,7 +19059,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse parameters: - in: path name: organizationsId @@ -19020,15 +19067,20 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: parameters: *ref_1 - get: - description: Gets a shared flow by name, including a list of its revisions. - operationId: apigee.organizations.sharedflows.get + post: + description: Retrieve security statistics as tabular rows. + operationId: apigee.organizations.environments.securityStats.queryTabularStats + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19040,7 +19092,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse parameters: - in: path name: organizationsId @@ -19048,15 +19101,21 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - delete: + /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: + parameters: *ref_1 + get: description: >- - Deletes a shared flow and all it's revisions. The shared flow must be - undeployed before you can delete it. - operationId: apigee.organizations.sharedflows.delete + Retrieve metrics grouped by dimensions. The types of metrics you can + retrieve include traffic, message counts, API call latency, response + size, and cache hits and counts. Dimensions let you view metrics in + meaningful groups. You can optionally pass dimensions as path parameters + to the `stats` API. If dimensions are not specified, the metrics are + computed on the entire set of data for the given time range. + operationId: apigee.organizations.environments.stats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19068,7 +19127,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId @@ -19076,25 +19135,85 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows: + - in: path + name: statsId + required: true + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: aggTable + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: sonar + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: offset + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: timeRange + schema: + type: string + - in: query + name: select + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: parameters: *ref_1 post: - description: >- - Uploads a ZIP-formatted shared flow configuration bundle to an - organization. If the shared flow already exists, this creates a new - revision of it. If the shared flow does not exist, this creates it. Once - imported, the shared flow revision must be deployed before it can be - accessed at runtime. The size limit of a shared flow bundle is 15 MB. - operationId: apigee.organizations.sharedflows.create + description: CreateSecurityAction creates a SecurityAction. + operationId: apigee.organizations.environments.securityActions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19106,24 +19225,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: action + - in: path + name: environmentsId + required: true schema: type: string - in: query - name: name + name: securityActionId schema: type: string get: - description: Lists all shared flows in the organization. - operationId: apigee.organizations.sharedflows.list + description: >- + Returns a list of SecurityActions. This returns both enabled and + disabled actions. + operationId: apigee.organizations.environments.securityActions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19136,32 +19258,46 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse + #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: query - name: includeRevisions + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: includeMetaData + name: pageToken schema: - type: boolean - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: parameters: *ref_1 - delete: + post: description: >- - Deletes an AppGroup. All app and API keys associations with the AppGroup - are also removed. **Warning**: This API will permanently delete the - AppGroup and related artifacts. **Note**: The delete operation is - asynchronous. The AppGroup app is deleted immediately, but its - associated resources, such as apps and API keys, may take anywhere from - a few seconds to a few minutes to be deleted. - operationId: apigee.organizations.appgroups.delete + Enable a SecurityAction. The `state` of the SecurityAction after + enabling is `ENABLED`. `EnableSecurityAction` can be called on + SecurityActions in the state `DISABLED`; SecurityActions in a different + state (including `ENABLED) return an error. + operationId: apigee.organizations.environments.securityActions.enable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19173,7 +19309,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -19181,15 +19317,20 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: securityActionsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: + parameters: *ref_1 get: - description: >- - Returns the AppGroup details for the provided AppGroup name in the - request URI. - operationId: apigee.organizations.appgroups.get + description: Get a SecurityAction by name. + operationId: apigee.organizations.environments.securityActions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19201,7 +19342,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -19209,23 +19350,30 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - put: + - in: path + name: securityActionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: + parameters: *ref_1 + post: description: >- - Updates an AppGroup. This API replaces the existing AppGroup details - with those specified in the request. Include or exclude any existing - details that you want to retain or delete, respectively. Note that the - state of the AppGroup should be updated using `action`, and not via - AppGroup. - operationId: apigee.organizations.appgroups.update + Disable a SecurityAction. The `state` of the SecurityAction after + disabling is `DISABLED`. `DisableSecurityAction` can be called on + SecurityActions in the state `ENABLED`; SecurityActions in a different + state (including `DISABLED`) return an error. + operationId: apigee.organizations.environments.securityActions.disable requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19237,7 +19385,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -19245,27 +19393,20 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: action + - in: path + name: securityActionsId + required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups: + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: parameters: *ref_1 - post: - description: >- - Creates an AppGroup. Once created, user can register apps under the - AppGroup to obtain secret key and password. At creation time, the - AppGroup's state is set as `active`. - operationId: apigee.organizations.appgroups.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + get: + description: Lists all deployments of a shared flow in an environment. + operationId: apigee.organizations.environments.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19277,19 +19418,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: sharedflowsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 get: description: >- - Lists all AppGroups in an organization. A maximum of 1000 AppGroups are - returned in the response if PageSize is not specified, or if the - PageSize is greater than 1000. - operationId: apigee.organizations.appgroups.list + Gets the deployment of a shared flow revision and actual state reported + by runtime pods. + operationId: apigee.organizations.environments.sharedflows.revisions.getDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19301,34 +19454,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: sharedflowsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: revisionsId + required: true schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: - parameters: *ref_1 + type: string delete: description: >- - Deletes an app's consumer key and removes all API products associated - with the app. After the consumer key is deleted, it cannot be used to - access any APIs. - operationId: apigee.organizations.appgroups.apps.keys.delete + Undeploys a shared flow revision from an environment. For a request path + `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.sharedflowrevisions.undeploy` on the resource + `organizations/{org}/sharedflows/{sf}/revisions/{rev}` + operationId: apigee.organizations.environments.sharedflows.revisions.undeploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19340,7 +19496,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -19348,36 +19504,33 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: sharedflowsId required: true schema: type: string - in: path - name: keysId + name: revisionsId required: true schema: type: string post: description: >- - Adds an API product to an AppGroupAppKey, enabling the app that holds - the key to access the API resources bundled in the API product. In - addition, you can add attributes to the AppGroupAppKey. This API - replaces the existing attributes with those specified in the request. - Include or exclude any existing attributes that you want to retain or - delete, respectively. You can use the same key to access all API - products associated with the app. - operationId: apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + Deploys a revision of a shared flow. If another revision of the same + shared flow is currently deployed, set the `override` parameter to + `true` to have this revision replace the currently deployed revision. + You cannot use a shared flow until it has been deployed to an + environment. For a request path + `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.sharedflowrevisions.deploy` on the resource + `organizations/{org}/sharedflows/{sf}/revisions/{rev}` + operationId: apigee.organizations.environments.sharedflows.revisions.deploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19389,7 +19542,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -19397,25 +19550,69 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: sharedflowsId required: true schema: type: string - in: path - name: keysId + name: revisionsId required: true schema: type: string - get: - description: >- - Gets details for a consumer key for a AppGroup app, including the key - and secret value, associated API products, and other information. - operationId: apigee.organizations.appgroups.apps.keys.get + - in: query + name: override + schema: + type: boolean + - in: query + name: serviceAccount + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: + parameters: *ref_1 + put: + description: Attaches a shared flow to a flow hook. + operationId: apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: flowhooksId + required: true + schema: + type: string + delete: + description: Detaches a shared flow from a flow hook. + operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19427,7 +19624,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -19435,42 +19632,21 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: flowhooksId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: - parameters: *ref_1 - post: + get: description: >- - Creates a custom consumer key and secret for a AppGroup app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the ProductizeAppGroupAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteAppGroupAppKey API. - operationId: apigee.organizations.appgroups.apps.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + Returns the name of the shared flow attached to the specified flow hook. + If there's no shared flow attached to the flow hook, the API does not + return an error; it simply does not return a name in the response. + operationId: apigee.organizations.environments.flowhooks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19482,7 +19658,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -19490,24 +19666,20 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: flowhooksId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: parameters: *ref_1 delete: - description: >- - Removes an API product from an app's consumer key. After the API product - is removed, the app cannot access the API resources defined in that API - product. **Note**: The consumer key is not removed, only its association - with the API product. - operationId: apigee.organizations.appgroups.apps.keys.apiproducts.delete + description: Deletes a cache. + operationId: apigee.organizations.environments.caches.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19519,7 +19691,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -19527,35 +19699,31 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId + name: environmentsId required: true schema: type: string - in: path - name: apiproductsId + name: cachesId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: + parameters: *ref_1 post: description: >- - Approves or revokes the consumer key for an API product. After a - consumer key is approved, the app can use it to access APIs. A consumer - key that is revoked or pending cannot be used to access an API. Any - access tokens associated with a revoked consumer key will remain active. - However, Apigee checks the status of the consumer key and if set to - `revoked` will not allow access to the API. - operationId: >- - apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct + Sets the IAM policy on an environment, if the policy already exists it + will be replaced. For more information, see [Manage users, roles, and + permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.environments.setIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19567,7 +19735,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -19575,38 +19743,20 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - - in: query - name: action - schema: - type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: + /v1/organizations/{organizationsId}/environments: parameters: *ref_1 - delete: - description: >- - Deletes an AppGroup app. **Note**: The delete operation is asynchronous. - The AppGroup app is deleted immediately, but its associated resources, - such as app keys or access tokens, may take anywhere from a few seconds - to a few minutes to be deleted. - operationId: apigee.organizations.appgroups.apps.delete + post: + description: Creates an environment in an organization. + operationId: apigee.organizations.environments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19618,26 +19768,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId - required: true + - in: query + name: name schema: type: string - get: - description: Returns the details for an AppGroup app. - operationId: apigee.organizations.appgroups.apps.get + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: + parameters: *ref_1 + patch: + description: >- + UpdateSecurityActionConfig updates the current SecurityActions + configuration. This method is used to enable/disable the feature at the + environment level. + operationId: apigee.organizations.environments.updateSecurityActionsConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19649,7 +19803,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -19657,32 +19811,20 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: updateMask schema: type: string - put: + format: google-fieldmask + get: description: >- - Updates the details for an AppGroup app. In addition, you can add an API - product to an AppGroup app and automatically generate an API key for the - app to use when calling APIs in the API product. If you want to use an - existing API key for the API product, add the API product to the API key - using the UpdateAppGroupAppKey API. Using this API, you cannot update - the app name, as it is the primary key used to identify the app and - cannot be changed. This API replaces the existing attributes with those - specified in the request. Include or exclude any existing attributes - that you want to retain or delete, respectively. - operationId: apigee.organizations.appgroups.apps.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + GetSecurityActionConfig returns the current SecurityActions + configuration. + operationId: apigee.organizations.environments.getSecurityActionsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19694,7 +19836,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -19702,29 +19844,15 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - - in: query - name: action - schema: - type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig: parameters: *ref_1 get: - description: >- - Lists all apps created by an AppGroup in an Apigee organization. - Optionally, you can request an expanded view of the AppGroup apps. Lists - all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are - returned in the response if PageSize is not specified, or if the - PageSize is greater than 1000. - operationId: apigee.organizations.appgroups.apps.list + description: Gets the deployed configuration for an environment. + operationId: apigee.organizations.environments.getDeployedConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19736,8 +19864,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentConfig' parameters: - in: path name: organizationsId @@ -19745,32 +19872,15 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: >- - Creates an app and associates it with an AppGroup. This API associates - the AppGroup app with the specified API product and auto-generates an - API key for the app to use in calls to API proxies inside that API - product. The `name` is the unique ID of the app that you can use in API - calls. - operationId: apigee.organizations.appgroups.apps.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: + parameters: *ref_1 + get: + description: Gets the add-ons config of an environment. + operationId: apigee.organizations.environments.getAddonsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19782,7 +19892,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' parameters: - in: path name: organizationsId @@ -19790,15 +19900,19 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/datacollectors: + /v1/organizations/{organizationsId}/environments/{environmentsId}: parameters: *ref_1 - get: - description: Lists all data collectors. - operationId: apigee.organizations.datacollectors.list + delete: + description: >- + Deletes an environment from an organization. **Warning: You must delete + all key value maps and key value entries before you delete an + environment.** Otherwise, if you re-create the environment the key value + map entry operations will encounter encryption/decryption discrepancies. + operationId: apigee.organizations.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19810,31 +19924,32 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - post: - description: Creates a new data collector. - operationId: apigee.organizations.datacollectors.create + put: + description: >- + Updates an existing environment. When updating properties, you must pass + all existing properties to the API, even if they are not being changed. + If you omit properties from the payload, the properties are removed. To + get the current list of properties for the environment, use the [Get + Environment API](get). **Note**: Both `PUT` and `POST` methods are + supported for updating an existing environment. + operationId: apigee.organizations.environments.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19846,27 +19961,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: dataCollectorId + - in: path + name: environmentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: - parameters: *ref_1 - patch: - description: Updates a data collector. - operationId: apigee.organizations.datacollectors.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + get: + description: Gets environment details. + operationId: apigee.organizations.environments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19878,7 +19987,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -19886,18 +19995,20 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a data collector. - operationId: apigee.organizations.datacollectors.delete + patch: + description: >- + Updates properties for an Apigee environment with patch semantics using + a field mask. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.environments.modifyEnvironment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19909,7 +20020,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -19917,13 +20028,29 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - get: - description: Gets a data collector. - operationId: apigee.organizations.datacollectors.get + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + post: + description: >- + Updates an existing environment. When updating properties, you must pass + all existing properties to the API, even if they are not being changed. + If you omit properties from the payload, the properties are removed. To + get the current list of properties for the environment, use the [Get + Environment API](get). **Note**: Both `PUT` and `POST` methods are + supported for updating an existing environment. + operationId: apigee.organizations.environments.updateEnvironment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19935,7 +20062,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -19943,20 +20070,20 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: + /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: parameters: *ref_1 - get: - description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.hostSecurityReports.getResult + post: + description: Deletes a subscription for the environment's Pub/Sub topic. + operationId: apigee.organizations.environments.unsubscribe + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19968,7 +20095,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -19976,17 +20103,15 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: + /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: parameters: *ref_1 get: - description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.hostSecurityReports.getResultView + description: Gets the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.getDebugmask security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19998,8 +20123,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' parameters: - in: path name: organizationsId @@ -20007,18 +20131,18 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: - parameters: *ref_1 - get: - description: >- - Get status of a query submitted at host level. If the query is still in - progress, the `state` is set to "running" After the query has completed - successfully, `state` is set to "completed" - operationId: apigee.organizations.hostSecurityReports.get + patch: + description: Updates the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.updateDebugmask + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20030,7 +20154,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' parameters: - in: path name: organizationsId @@ -20038,15 +20162,27 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: replaceRepeatedFields + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: parameters: *ref_1 get: - description: Return a list of Security Reports at host level. - operationId: apigee.organizations.hostSecurityReports.list + description: >- + Gets the API Security runtime configuration for an environment. This + named ApiSecurityRuntimeConfig to prevent conflicts with + ApiSecurityConfig from addon config. + operationId: apigee.organizations.environments.getApiSecurityRuntimeConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20059,58 +20195,32 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: from - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: status - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: envgroupHostname + - in: path + name: environmentsId + required: true schema: type: string - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: + parameters: *ref_1 + patch: description: >- - Submit a query at host level to be processed in the background. If the - submission of the query succeeds, the API returns a 201 status and an ID - that refer to the query. In addition to the HTTP status 201, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.hostSecurityReports.create + Updates the trace configurations in an environment. Note that the + repeated fields have replace semantics when included in the field mask + and that they will be overwritten by the value of the fields in the + request body. + operationId: apigee.organizations.environments.updateTraceConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20122,21 +20232,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/operations/{operationsId}: - parameters: *ref_1 + - in: path + name: environmentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask 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. - operationId: apigee.organizations.operations.get + description: Get distributed trace configuration in an environment. + operationId: apigee.organizations.environments.getTraceConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20148,7 +20263,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId @@ -20156,17 +20271,18 @@ paths: schema: type: string - in: path - name: operationsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/operations: + /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: apigee.organizations.operations.list + Creates a subscription for the environment's Pub/Sub topic. The server + will assign a random name for this subscription. The "name" and + "push_config" must *not* be specified. + operationId: apigee.organizations.environments.subscribe security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20178,31 +20294,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy: parameters: *ref_1 get: - description: Gets an environment group. - operationId: apigee.organizations.envgroups.get + description: >- + Gets the IAM policy on an environment. For more information, see [Manage + users, roles, and permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.environments.getIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20214,7 +20327,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -20222,18 +20335,29 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - patch: - description: Updates an environment group. - operationId: apigee.organizations.envgroups.patch + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Tests the permissions of a user on an environment, and returns a subset + of permissions that the user has on the environment. If the environment + does not exist, an empty permission set is returned (a NOT_FOUND error + is not returned). + operationId: apigee.organizations.environments.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20245,7 +20369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId @@ -20253,18 +20377,15 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: + parameters: *ref_1 delete: - description: Deletes an environment group. - operationId: apigee.organizations.envgroups.delete + description: Deletes an endpoint attachment. + operationId: apigee.organizations.endpointAttachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20284,15 +20405,13 @@ paths: schema: type: string - in: path - name: envgroupsId + name: endpointAttachmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: - parameters: *ref_1 get: - description: Gets the deployed ingress configuration for an environment group. - operationId: apigee.organizations.envgroups.getDeployedIngressConfig + description: Gets the endpoint attachment. + operationId: apigee.organizations.endpointAttachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20304,7 +20423,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' parameters: - in: path name: organizationsId @@ -20312,19 +20431,22 @@ paths: schema: type: string - in: path - name: envgroupsId + name: endpointAttachmentsId required: true schema: type: string - - in: query - name: view - schema: - type: string - /v1/organizations/{organizationsId}/envgroups: + /v1/organizations/{organizationsId}/endpointAttachments: parameters: *ref_1 - get: - description: Lists all environment groups. - operationId: apigee.organizations.envgroups.list + post: + description: >- + Creates an endpoint attachment. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.endpointAttachments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20336,8 +20458,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -20345,22 +20466,12 @@ paths: schema: type: string - in: query - name: pageToken + name: endpointAttachmentId schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new environment group. - operationId: apigee.organizations.envgroups.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + get: + description: Lists the endpoint attachments in an organization. + operationId: apigee.organizations.endpointAttachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20372,7 +20483,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse parameters: - in: path name: organizationsId @@ -20380,14 +20492,24 @@ paths: schema: type: string - in: query - name: name + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: + /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: parameters: *ref_1 - get: - description: Lists all attachments of an environment group. - operationId: apigee.organizations.envgroups.attachments.list + patch: + description: Updates a data collector. + operationId: apigee.organizations.datacollectors.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20399,8 +20521,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -20408,28 +20529,18 @@ paths: schema: type: string - in: path - name: envgroupsId + name: datacollectorsId required: true schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new attachment of an environment to an environment group. - operationId: apigee.organizations.envgroups.attachments.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + format: google-fieldmask + get: + description: Gets a data collector. + operationId: apigee.organizations.datacollectors.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20441,7 +20552,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -20449,15 +20560,13 @@ paths: schema: type: string - in: path - name: envgroupsId + name: datacollectorsId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: - parameters: *ref_1 - get: - description: Gets an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.get + delete: + description: Deletes a data collector. + operationId: apigee.organizations.datacollectors.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20469,8 +20578,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -20478,18 +20586,15 @@ paths: schema: type: string - in: path - name: envgroupsId - required: true - schema: - type: string - - in: path - name: attachmentsId + name: datacollectorsId required: true schema: type: string - delete: - description: Deletes an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.delete + /v1/organizations/{organizationsId}/datacollectors: + parameters: *ref_1 + get: + description: Lists all data collectors. + operationId: apigee.organizations.datacollectors.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20501,36 +20606,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: envgroupsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: attachmentsId - required: true + - in: query + name: pageSize schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust: - parameters: *ref_1 + type: integer + format: int32 post: - description: >- - Adjust the prepaid balance for the developer. This API will be used in - scenarios where the developer has been under-charged or over-charged. - operationId: apigee.organizations.developers.balance.adjust + description: Creates a new data collector. + operationId: apigee.organizations.datacollectors.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20542,29 +20642,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance:credit: - parameters: *ref_1 - post: - description: Credits the account balance for the developer. - operationId: apigee.organizations.developers.balance.credit - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest + - in: query + name: dataCollectorId + schema: + type: string + /v1/organizations/{organizationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: apigee.organizations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20576,23 +20671,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets details for an API product subscription. - operationId: apigee.organizations.developers.subscriptions.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. + operationId: apigee.organizations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20604,7 +20710,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -20612,25 +20718,15 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: subscriptionsId + name: operationsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: parameters: *ref_1 - post: - description: 'Creates a subscription to an API product. ' - operationId: apigee.organizations.developers.subscriptions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + delete: + description: Deletes a catalog item. + operationId: apigee.organizations.sites.apidocs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20642,7 +20738,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -20650,13 +20746,23 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - get: - description: Lists all API product subscriptions for a developer. - operationId: apigee.organizations.developers.subscriptions.list + - in: path + name: apidocsId + required: true + schema: + type: string + put: + description: Updates a catalog item. + operationId: apigee.organizations.sites.apidocs.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20668,8 +20774,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -20677,30 +20782,18 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - - in: query - name: startKey + - in: path + name: apidocsId + required: true schema: type: string - - in: query - name: count - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: - parameters: *ref_1 - post: - description: Expires an API product subscription immediately. - operationId: apigee.organizations.developers.subscriptions.expire - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + get: + description: Gets a catalog item. + operationId: apigee.organizations.sites.apidocs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20712,7 +20805,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -20720,20 +20813,20 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: subscriptionsId + name: apidocsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: parameters: *ref_1 get: - description: Returns the details for a developer app. - operationId: apigee.organizations.developers.apps.get + description: Returns the catalog items associated with a portal. + operationId: apigee.organizations.sites.apidocs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20745,7 +20838,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' parameters: - in: path name: organizationsId @@ -20753,41 +20846,27 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: sitesId required: true schema: type: string - in: query - name: query + name: pageToken schema: type: string - in: query - name: entity + name: pageSize schema: - type: string - put: - description: >- - Updates the details for a developer app. In addition, you can add an API - product to a developer app and automatically generate an API key for the - app to use when calling APIs in the API product. If you want to use an - existing API key for the API product, add the API product to the API key - using the UpdateDeveloperAppKey API. Using this API, you cannot update - the following: * App name as it is the primary key used to identify the - app and cannot be changed. * Scopes associated with the app. Instead, - use the ReplaceDeveloperAppKey API. This API replaces the existing - attributes with those specified in the request. Include or exclude any - existing attributes that you want to retain or delete, respectively. - operationId: apigee.organizations.developers.apps.update + type: integer + format: int32 + post: + description: Creates a new catalog item. + operationId: apigee.organizations.sites.apidocs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20799,7 +20878,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -20807,22 +20886,15 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: sitesId required: true schema: type: string - delete: - description: >- - Deletes a developer app. **Note**: The delete operation is asynchronous. - The developer app is deleted immediately, but its associated resources, - such as app keys or access tokens, may take anywhere from a few seconds - to a few minutes to be deleted. - operationId: apigee.organizations.developers.apps.delete + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: + parameters: *ref_1 + get: + description: Gets the documentation for the specified catalog item. + operationId: apigee.organizations.sites.apidocs.getDocumentation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20834,7 +20906,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -20842,49 +20915,25 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apidocsId required: true schema: type: string - post: + patch: description: >- - Manages access to a developer app by enabling you to: * Approve or - revoke a developer app * Generate a new consumer key and secret for a - developer app To approve or revoke a developer app, set the `action` - query parameter to `approve` or `revoke`, respectively, and the - `Content-Type` header to `application/octet-stream`. If a developer app - is revoked, none of its API keys are valid for API calls even though the - keys are still approved. If successful, the API call returns the - following HTTP status code: `204 No Content` To generate a new consumer - key and secret for a developer app, pass the new key/secret details. - Rather than replace an existing key, this API generates a new key. In - this case, multiple key pairs may be associated with a single developer - app. Each key pair has an independent status (`approve` or `revoke`) and - expiration time. Any approved, non-expired key can be used in an API - call. For example, if you're using API key rotation, you can generate - new keys with expiration times that overlap keys that are going to - expire. You might also generate a new consumer key/secret if the - security of the original key/secret is compromised. The `keyExpiresIn` - property defines the expiration time for the API key in milliseconds. If - you don't set this property or set it to `-1`, the API key never - expires. **Notes**: * When generating a new key/secret, this API - replaces the existing attributes, notes, and callback URLs with those - specified in the request. Include or exclude any existing information - that you want to retain or delete, respectively. * To migrate existing - consumer keys and secrets to hybrid from another system, see the - CreateDeveloperAppKey API. - operationId: >- - apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus + Updates the documentation for the specified catalog item. Note that the + documentation file contents will not be populated in the return message. + operationId: apigee.organizations.sites.apidocs.updateDocumentation requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20896,7 +20945,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -20904,31 +20954,51 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apidocsId required: true schema: type: string - - in: query - name: action + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: + parameters: *ref_1 + get: + description: Gets an API category. + operationId: apigee.organizations.sites.apicategories.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: - parameters: *ref_1 - post: - description: >- - Updates attributes for a developer app. This API replaces the current - attributes with those specified in the request. - operationId: apigee.organizations.developers.apps.attributes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + - in: path + name: sitesId + required: true + schema: + type: string + - in: path + name: apicategoriesId + required: true + schema: + type: string + delete: + description: Deletes an API category. + operationId: apigee.organizations.sites.apicategories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20940,7 +21010,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -20948,18 +21018,23 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apicategoriesId required: true schema: type: string - get: - description: Returns a list of all developer app attributes. - operationId: apigee.organizations.developers.apps.attributes.list + patch: + description: Updates an API category. + operationId: apigee.organizations.sites.apicategories.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20971,7 +21046,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -20979,31 +21054,25 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apicategoriesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps: + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: parameters: *ref_1 post: - description: >- - Creates an app associated with a developer. This API associates the - developer app with the specified API product and auto-generates an API - key for the app to use in calls to API proxies inside that API product. - The `name` is the unique ID of the app that you can use in API calls. - The `DisplayName` (set as an attribute) appears in the UI. If you don't - set the `DisplayName` attribute, the `name` appears in the UI. - operationId: apigee.organizations.developers.apps.create + description: Creates a new API category. + operationId: apigee.organizations.sites.apicategories.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21015,7 +21084,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -21023,18 +21092,13 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string get: - description: >- - Lists all apps created by a developer in an Apigee organization. - Optionally, you can request an expanded view of the developer apps. A - maximum of 100 developer apps are returned per API call. You can - paginate the list of deveoper apps returned using the `startKey` and - `count` query parameters. - operationId: apigee.organizations.developers.apps.list + description: Returns the API categories associated with a portal. + operationId: apigee.organizations.sites.apicategories.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21047,7 +21111,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse + #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse parameters: - in: path name: organizationsId @@ -21055,32 +21119,15 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: count - schema: - type: string - format: int64 - - in: query - name: startKey - schema: - type: string - - in: query - name: shallowExpand - schema: - type: boolean - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: parameters: *ref_1 delete: - description: Deletes a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.delete + description: Deletes an environment group. + operationId: apigee.organizations.envgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21092,7 +21139,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -21100,36 +21147,18 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: attributesId + name: envgroupsId required: true schema: type: string - post: - description: >- - Updates a developer app attribute. **Note**: OAuth access tokens and Key - Management Service (KMS) entities (apps, developers, and API products) - are cached for 180 seconds (current default). Any custom attributes - associated with these entities are cached for at least 180 seconds after - the entity is accessed at runtime. Therefore, an `ExpiresIn` element on - the OAuthV2 policy won't be able to expire an access token in less than - 180 seconds. - operationId: >- - apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute + patch: + description: Updates an environment group. + operationId: apigee.organizations.envgroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21141,7 +21170,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -21149,23 +21178,18 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: envgroupsId required: true schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask get: - description: Returns a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.get + description: Gets an environment group. + operationId: apigee.organizations.envgroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21177,7 +21201,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' parameters: - in: path name: organizationsId @@ -21185,44 +21209,15 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: attributesId + name: envgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: parameters: *ref_1 - post: - description: >- - Creates a custom consumer key and secret for a developer app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the UpdateDeveloperAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteDeveloperAppKey API. **Note**: All keys start out with - status=approved, even if status=revoked is passed when the key is - created. To revoke a key, use the UpdateDeveloperAppKey API. - operationId: apigee.organizations.developers.apps.keys.create.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + get: + description: Gets the deployed ingress configuration for an environment group. + operationId: apigee.organizations.envgroups.getDeployedIngressConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21234,7 +21229,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' parameters: - in: path name: organizationsId @@ -21242,24 +21237,19 @@ paths: schema: type: string - in: path - name: developersId + name: envgroupsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: view schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + /v1/organizations/{organizationsId}/envgroups: parameters: *ref_1 - delete: - description: >- - Removes an API product from an app's consumer key. After the API product - is removed, the app cannot access the API resources defined in that API - product. **Note**: The consumer key is not removed, only its association - with the API product. - operationId: apigee.organizations.developers.apps.keys.apiproducts.delete + get: + description: Lists all environment groups. + operationId: apigee.organizations.envgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21271,43 +21261,58 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: keysId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 + post: + description: Creates a new environment group. + operationId: apigee.organizations.envgroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: apiproductsId + name: organizationsId required: true schema: type: string - post: - description: >- - Approves or revokes the consumer key for an API product. After a - consumer key is approved, the app can use it to access APIs. A consumer - key that is revoked or pending cannot be used to access an API. Any - access tokens associated with a revoked consumer key will remain active. - However, Apigee checks the status of the consumer key and if set to - `revoked` will not allow access to the API. - operationId: >- - apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct + - in: query + name: name + schema: + type: string + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: + parameters: *ref_1 + delete: + description: Deletes an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21319,7 +21324,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -21327,36 +21332,18 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId + name: envgroupsId required: true schema: type: string - in: path - name: apiproductsId + name: attachmentsId required: true schema: type: string - - in: query - name: action - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: - parameters: *ref_1 get: - description: >- - Gets details for a consumer key for a developer app, including the key - and secret value, associated API products, and other information. - operationId: apigee.organizations.developers.apps.keys.get + description: Gets an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21368,7 +21355,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment parameters: - in: path name: organizationsId @@ -21376,35 +21364,26 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: envgroupsId required: true schema: type: string - in: path - name: keysId + name: attachmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: + parameters: *ref_1 post: - description: >- - Adds an API product to a developer app key, enabling the app that holds - the key to access the API resources bundled in the API product. In - addition, you can add attributes to a developer app key. This API - replaces the existing attributes with those specified in the request. - Include or exclude any existing attributes that you want to retain or - delete, respectively. You can use the same key to access all API - products associated with the app. - operationId: apigee.organizations.developers.apps.keys.updateDeveloperAppKey + description: Creates a new attachment of an environment to an environment group. + operationId: apigee.organizations.envgroups.attachments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21416,7 +21395,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -21424,38 +21403,68 @@ paths: schema: type: string - in: path - name: developersId + name: envgroupsId required: true schema: type: string + get: + description: Lists all attachments of an environment group. + operationId: apigee.organizations.envgroups.attachments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + parameters: - in: path - name: appsId + name: organizationsId required: true schema: type: string - in: path - name: keysId + name: envgroupsId required: true schema: type: string - in: query - name: action + name: pageToken schema: type: string - put: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: + parameters: *ref_1 + post: description: >- - Updates the scope of an app. This API replaces the existing scopes with - those specified in the request. Include or exclude any existing scopes - that you want to retain or delete, respectively. The specified scopes - must already be defined for the API products associated with the app. - This API sets the `scopes` element under the `apiProducts` element in - the attributes of the app. - operationId: apigee.organizations.developers.apps.keys.replaceDeveloperAppKey + Creates a custom consumer key and secret for a AppGroup app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the ProductizeAppGroupAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteAppGroupAppKey API. + operationId: apigee.organizations.appgroups.apps.keys.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21467,7 +21476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -21475,7 +21484,7 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string @@ -21484,21 +21493,13 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - delete: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: + parameters: *ref_1 + get: description: >- - Deletes an app's consumer key and removes all API products associated - with the app. After the consumer key is deleted, it cannot be used to - access any APIs. **Note**: After you delete a consumer key, you may want - to: 1. Create a new consumer key and secret for the developer app using - the CreateDeveloperAppKey API, and subsequently add an API product to - the key using the UpdateDeveloperAppKey API. 2. Delete the developer - app, if it is no longer required. - operationId: apigee.organizations.developers.apps.keys.delete + Gets details for a consumer key for a AppGroup app, including the key + and secret value, associated API products, and other information. + operationId: apigee.organizations.appgroups.apps.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21510,7 +21511,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -21518,7 +21519,7 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string @@ -21532,30 +21533,12 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: - parameters: *ref_1 - post: + delete: description: >- - Creates a custom consumer key and secret for a developer app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the UpdateDeveloperAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteDeveloperAppKey API. **Note**: All keys start out with - status=approved, even if status=revoked is passed when the key is - created. To revoke a key, use the UpdateDeveloperAppKey API. - operationId: apigee.organizations.developers.apps.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + Deletes an app's consumer key and removes all API products associated + with the app. After the consumer key is deleted, it cannot be used to + access any APIs. + operationId: apigee.organizations.appgroups.apps.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21567,7 +21550,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -21575,7 +21558,7 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string @@ -21584,52 +21567,27 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes: - parameters: *ref_1 - get: - description: Returns a list of all developer attributes. - operationId: apigee.organizations.developers.attributes.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - in: path - name: developersId + name: keysId required: true schema: type: string post: description: >- - Updates developer attributes. This API replaces the existing attributes - with those specified in the request. Add new attributes, and include or - exclude any existing attributes that you want to retain or remove, - respectively. The custom attribute limit is 18. **Note**: OAuth access - tokens and Key Management Service (KMS) entities (apps, developers, and - API products) are cached for 180 seconds (default). Any custom - attributes associated with these entities are cached for at least 180 - seconds after the entity is accessed at runtime. Therefore, an - `ExpiresIn` element on the OAuthV2 policy won't be able to expire an - access token in less than 180 seconds. - operationId: apigee.organizations.developers.attributes + Adds an API product to an AppGroupAppKey, enabling the app that holds + the key to access the API resources bundled in the API product. In + addition, you can add attributes to the AppGroupAppKey. This API + replaces the existing attributes with those specified in the request. + Include or exclude any existing attributes that you want to retain or + delete, respectively. You can use the same key to access all API + products associated with the app. + operationId: apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21641,7 +21599,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -21649,15 +21607,29 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: parameters: *ref_1 - get: - description: Returns the value of the specified developer attribute. - operationId: apigee.organizations.developers.attributes.get + delete: + description: >- + Removes an API product from an app's consumer key. After the API product + is removed, the app cannot access the API resources defined in that API + product. **Note**: The consumer key is not removed, only its association + with the API product. + operationId: apigee.organizations.appgroups.apps.keys.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21669,7 +21641,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -21677,29 +21649,35 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - in: path - name: attributesId + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId required: true schema: type: string post: description: >- - Updates a developer attribute. **Note**: OAuth access tokens and Key - Management Service (KMS) entities (apps, developers, and API products) - are cached for 180 seconds (default). Any custom attributes associated - with these entities are cached for at least 180 seconds after the entity - is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 - policy won't be able to expire an access token in less than 180 seconds. - operationId: apigee.organizations.developers.attributes.updateDeveloperAttribute - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + Approves or revokes the consumer key for an API product. After a + consumer key is approved, the app can use it to access APIs. A consumer + key that is revoked or pending cannot be used to access an API. Any + access tokens associated with a revoked consumer key will remain active. + However, Apigee checks the status of the consumer key and if set to + `revoked` will not allow access to the API. + operationId: >- + apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21711,7 +21689,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -21719,18 +21697,38 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - in: path - name: attributesId + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId required: true schema: type: string + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: + parameters: *ref_1 delete: - description: Deletes a developer attribute. - operationId: apigee.organizations.developers.attributes.delete + description: >- + Deletes an AppGroup app. **Note**: The delete operation is asynchronous. + The AppGroup app is deleted immediately, but its associated resources, + such as app keys or access tokens, may take anywhere from a few seconds + to a few minutes to be deleted. + operationId: apigee.organizations.appgroups.apps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21742,7 +21740,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -21750,34 +21748,32 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - in: path - name: attributesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}: - parameters: *ref_1 put: description: >- - Updates a developer. This API replaces the existing developer details - with those specified in the request. Include or exclude any existing - details that you want to retain or delete, respectively. The custom - attribute limit is 18. **Note**: OAuth access tokens and Key Management - Service (KMS) entities (apps, developers, and API products) are cached - for 180 seconds (current default). Any custom attributes associated with - these entities are cached for at least 180 seconds after the entity is - accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 - policy won't be able to expire an access token in less than 180 seconds. - operationId: apigee.organizations.developers.update + Updates the details for an AppGroup app. In addition, you can add an API + product to an AppGroup app and automatically generate an API key for the + app to use when calling APIs in the API product. If you want to use an + existing API key for the API product, add the API product to the API key + using the UpdateAppGroupAppKey API. Using this API, you cannot update + the app name, as it is the primary key used to identify the app and + cannot be changed. This API replaces the existing attributes with those + specified in the request. Include or exclude any existing attributes + that you want to retain or delete, respectively. + operationId: apigee.organizations.appgroups.apps.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21789,7 +21785,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -21797,42 +21793,12 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - post: - description: >- - Sets the status of a developer. A developer is `active` by default. If - you set a developer's status to `inactive`, the API keys assigned to the - developer apps are no longer valid even though the API keys are set to - `approved`. Inactive developers can still sign in to the developer - portal and create apps; however, any new API keys generated during app - creation won't work. To set the status of a developer, set the `action` - query parameter to `active` or `inactive`, and the `Content-Type` header - to `application/octet-stream`. If successful, the API call returns the - following HTTP status code: `204 No Content` - operationId: apigee.organizations.developers.setDeveloperStatus - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: organizationsId + name: appgroupsId required: true schema: type: string - in: path - name: developersId + name: appsId required: true schema: type: string @@ -21840,17 +21806,9 @@ paths: name: action schema: type: string - delete: - description: >- - Deletes a developer. All apps and API keys associated with the developer - are also removed. **Warning**: This API will permanently delete the - developer and related artifacts. To avoid permanently deleting - developers and their artifacts, set the developer status to `inactive` - using the SetDeveloperStatus API. **Note**: The delete operation is - asynchronous. The developer app is deleted immediately, but its - associated resources, such as apps and API keys, may take anywhere from - a few seconds to a few minutes to be deleted. - operationId: apigee.organizations.developers.delete + get: + description: Returns the details for an AppGroup app. + operationId: apigee.organizations.appgroups.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21862,7 +21820,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -21870,16 +21828,25 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId + required: true + schema: + type: string + - in: path + name: appsId required: true schema: type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: + parameters: *ref_1 get: description: >- - Returns the developer details, including the developer's name, email - address, apps, and other information. **Note**: The response includes - only the first 100 developer apps. - operationId: apigee.organizations.developers.get + Lists all apps created by an AppGroup in an Apigee organization. + Optionally, you can request an expanded view of the AppGroup apps. Lists + all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are + returned in the response if PageSize is not specified, or if the + PageSize is greater than 1000. + operationId: apigee.organizations.appgroups.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21891,7 +21858,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse parameters: - in: path name: organizationsId @@ -21899,27 +21867,32 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - in: query - name: action + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/developers: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- - Creates a developer. Once created, the developer can register an app and - obtain an API key. At creation time, a developer is set as `active`. To - change the developer status, use the SetDeveloperStatus API. - operationId: apigee.organizations.developers.create + Creates an app and associates it with an AppGroup. This API associates + the AppGroup app with the specified API product and auto-generates an + API key for the app to use in calls to API proxies inside that API + product. The `name` is the unique ID of the app that you can use in API + calls. + operationId: apigee.organizations.appgroups.apps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21931,22 +21904,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: appgroupsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/appgroups: + parameters: *ref_1 get: description: >- - Lists all developers in an organization by email address. By default, - the response does not include company developers. Set the - `includeCompany` query parameter to `true` to include company - developers. **Note**: A maximum of 1000 developers are returned in the - response. You paginate the list of developers returned using the - `startKey` and `count` query parameters. - operationId: apigee.organizations.developers.list + Lists all AppGroups in an organization. A maximum of 1000 AppGroups are + returned in the response if PageSize is not specified, or if the + PageSize is greater than 1000. + operationId: apigee.organizations.appgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21958,8 +21935,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' parameters: - in: path name: organizationsId @@ -21967,41 +21943,62 @@ paths: schema: type: string - in: query - name: expand - schema: - type: boolean - - in: query - name: count + name: filter schema: type: string - format: int64 - - in: query - name: includeCompany - schema: - type: boolean - in: query - name: ids + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: app + name: pageToken schema: type: string - - in: query - name: startKey + post: + description: >- + Creates an AppGroup. Once created, user can register apps under the + AppGroup to obtain secret key and password. At creation time, the + AppGroup's state is set as `active`. + operationId: apigee.organizations.appgroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: parameters: *ref_1 put: - description: Updates the monetization configuration for the developer. - operationId: apigee.organizations.developers.updateMonetizationConfig + description: >- + Updates an AppGroup. This API replaces the existing AppGroup details + with those specified in the request. Include or exclude any existing + details that you want to retain or delete, respectively. Note that the + state of the AppGroup should be updated using `action`, and not via + AppGroup. + operationId: apigee.organizations.appgroups.update requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22013,8 +22010,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -22022,13 +22018,23 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - get: - description: Gets the monetization configuration for the developer. - operationId: apigee.organizations.developers.getMonetizationConfig + - in: query + name: action + schema: + type: string + delete: + description: >- + Deletes an AppGroup. All app and API keys associations with the AppGroup + are also removed. **Warning**: This API will permanently delete the + AppGroup and related artifacts. **Note**: The delete operation is + asynchronous. The AppGroup app is deleted immediately, but its + associated resources, such as apps and API keys, may take anywhere from + a few seconds to a few minutes to be deleted. + operationId: apigee.organizations.appgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22040,8 +22046,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -22049,15 +22054,15 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance: - parameters: *ref_1 get: - description: Gets the account balance for the developer. - operationId: apigee.organizations.developers.getBalance + description: >- + Returns the AppGroup details for the provided AppGroup name in the + request URI. + operationId: apigee.organizations.appgroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22069,7 +22074,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -22077,21 +22082,38 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: + /v1/organizations/{organizationsId}/apiproducts: parameters: *ref_1 - get: + post: description: >- - Retrieve metrics grouped by dimensions in host level. The types of - metrics you can retrieve include traffic, message counts, API call - latency, response size, and cache hits and counts. Dimensions let you - view metrics in meaningful groups. You can optionally pass dimensions as - path parameters to the `stats` API. If dimensions are not specified, the - metrics are computed on the entire set of data for the given time range. - operationId: apigee.organizations.hostStats.get + Creates an API product in an organization. You create API products after + you have proxied backend services using API proxies. An API product is a + collection of API resources combined with quota settings and metadata + that you can use to deliver customized and productized API bundles to + your developer community. This metadata can include: - Scope - + Environments - API proxies - Extensible profile API products enable you + repackage APIs on the fly, without having to do any additional coding or + configuration. Apigee recommends that you start with a simple API + product including only required elements. You then provision credentials + to apps to enable them to start testing your APIs. After you have + authentication and authorization working against a simple API product, + you can iterate to create finer-grained API products, defining different + sets of API resources for each API product. **WARNING:** - If you don't + specify an API proxy in the request body, *any* app associated with the + product can make calls to *any* API in your entire organization. - If + you don't specify an environment in the request body, the product allows + access to all environments. For more information, see What is an API + product? + operationId: apigee.organizations.apiproducts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22103,79 +22125,70 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Lists all API product names for an organization. Filter the list by + passing an `attributename` and `attibutevalue`. The maximum number of + API products returned is 1000. You can paginate the list of API products + returned using the `startKey` and `count` query parameters. + operationId: apigee.organizations.apiproducts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse + parameters: - in: path - name: hostStatsId + name: organizationsId required: true schema: type: string - in: query - name: sort - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: sortby - schema: - type: string - - in: query - name: select + name: startKey schema: type: string - in: query - name: timeRange + name: attributevalue schema: type: string - in: query - name: realtime + name: expand schema: type: boolean - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: offset + name: count schema: type: string + format: int64 - in: query - name: tzo + name: attributename schema: type: string - /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: parameters: *ref_1 get: - description: Similar to GetHostStats except that the response is less verbose. - operationId: apigee.organizations.optimizedHostStats.get + description: >- + Gets configuration details for an API product. The API product name + required in the request URL is the internal name of the product, not the + display name. While they may be the same, it depends on whether the API + product was created via the UI or the API. View the list of API products + to verify the internal name. + operationId: apigee.organizations.apiproducts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22187,7 +22200,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -22195,78 +22208,103 @@ paths: schema: type: string - in: path - name: optimizedHostStatsId + name: apiproductsId required: true schema: type: string - - in: query - name: limit - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: select - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: tzo - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: timeUnit + put: + description: >- + Updates an existing API product. You must include all required values, + whether or not you are updating them, as well as any optional values + that you are updating. The API product name required in the request URL + is the internal name of the product, not the display name. While they + may be the same, it depends on whether the API product was created via + UI or API. View the list of API products to identify their internal + names. + operationId: apigee.organizations.apiproducts.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: timeRange + - in: path + name: apiproductsId + required: true schema: type: string - - in: query - name: offset + delete: + description: >- + Deletes an API product from an organization. Deleting an API product + causes app requests to the resource URIs defined in the API product to + fail. Ensure that you create a new API product to serve existing apps, + unless your intention is to disable access to the resources defined in + the API product. The API product name required in the request URL is the + internal name of the product, not the display name. While they may be + the same, it depends on whether the API product was created via the UI + or the API. View the list of API products to verify the internal name. + operationId: apigee.organizations.apiproducts.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: envgroupHostname + - in: path + name: apiproductsId + required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: parameters: *ref_1 post: description: >- - Creates a new attachment of an environment to an instance. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.create + Updates or creates API product attributes. This API **replaces** the + current list of attributes with the attributes specified in the request + body. In this way, you can update existing attributes, add new + attributes, or delete existing attributes by omitting them from the + request body. **Note**: OAuth access tokens and Key Management Service + (KMS) entities (apps, developers, and API products) are cached for 180 + seconds (current default). Any custom attributes associated with + entities also get cached for at least 180 seconds after entity is + accessed during runtime. In this case, the `ExpiresIn` element on the + OAuthV2 policy won't be able to expire an access token in less than 180 + seconds. + operationId: apigee.organizations.apiproducts.attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22278,7 +22316,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -22286,15 +22324,13 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string get: - description: >- - Lists all attachments to an instance. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.attachments.list + description: Lists all API product attributes. + operationId: apigee.organizations.apiproducts.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22306,8 +22342,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -22315,24 +22350,15 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: parameters: *ref_1 - get: - description: Gets an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.get + delete: + description: Deletes an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22344,7 +22370,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22352,18 +22378,30 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string - in: path - name: attachmentsId + name: attributesId required: true schema: type: string - delete: - description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.delete + post: + description: >- + Updates the value of an API product attribute. **Note**: OAuth access + tokens and Key Management Service (KMS) entities (apps, developers, and + API products) are cached for 180 seconds (current default). Any custom + attributes associated with entities also get cached for at least 180 + seconds after entity is accessed during runtime. In this case, the + `ExpiresIn` element on the OAuthV2 policy won't be able to expire an + access token in less than 180 seconds. + operationId: apigee.organizations.apiproducts.attributes.updateApiProductAttribute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22375,7 +22413,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22383,20 +22421,18 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string - in: path - name: attachmentsId + name: attributesId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: - parameters: *ref_1 get: - description: Gets a CanaryEvaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.get + description: Gets the value of an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22408,7 +22444,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22416,25 +22452,25 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string - in: path - name: canaryevaluationsId + name: attributesId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: parameters: *ref_1 - post: - description: Creates a new canary evaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.create + put: + description: Updates an existing rate plan. + operationId: apigee.organizations.apiproducts.rateplans.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22446,7 +22482,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -22454,23 +22490,18 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: - parameters: *ref_1 - post: - description: >- - Activates the NAT address. The Apigee instance can now use this for - Internet egress traffic. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.natAddresses.activate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest + - in: path + name: rateplansId + required: true + schema: + type: string + get: + description: Gets the details of a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22482,7 +22513,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -22490,31 +22521,18 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string - in: path - name: natAddressesId + name: rateplansId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: - parameters: *ref_1 - post: - description: >- - Creates a NAT address. The address is created in the RESERVED state and - a static external IP address will be provisioned. At this time, the - instance will not use this IP address for Internet egress traffic. The - address can be activated for use once any required firewall IP - whitelisting has been completed. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + delete: + description: Deletes a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22526,7 +22544,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -22534,15 +22552,35 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string - get: + - in: path + name: rateplansId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: + parameters: *ref_1 + post: description: >- - Lists the NAT addresses for an Apigee instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.natAddresses.list + Create a rate plan that is associated with an API product in an + organization. Using rate plans, API product owners can monetize their + API products by configuring one or more of the following: - Billing + frequency - Initial setup fees for using an API product - Payment + funding model (postpaid only) - Fixed recurring or consumption-based + charges for using an API product - Revenue sharing with developer + partners An API product can have multiple rate plans associated with it + but *only one* rate plan can be active at any point of time. **Note: + From the developer's perspective, they purchase API products not rate + plans. + operationId: apigee.organizations.apiproducts.rateplans.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22554,8 +22592,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -22563,27 +22600,13 @@ paths: schema: type: string - in: path - name: instancesId + name: apiproductsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: - parameters: *ref_1 - delete: - description: >- - Deletes the NAT address. Connections that are actively using the address - are drained before it is removed. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.delete + get: + description: Lists all the rate plans for an API product. + operationId: apigee.organizations.apiproducts.rateplans.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22595,28 +22618,53 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: instancesId - required: true + - in: path + name: apiproductsId + required: true + schema: + type: string + - in: query + name: expand + schema: + type: boolean + - in: query + name: count + schema: + type: integer + format: int32 + - in: query + name: state + schema: + type: string + - in: query + name: orderBy schema: type: string - - in: path - name: natAddressesId - required: true + - in: query + name: startKey schema: type: string - get: + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: + parameters: *ref_1 + post: description: >- - Gets the details of a NAT address. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.get + ComputeEnvironmentScores calculates scores for requested time range for + the specified security profile and environment. + operationId: >- + apigee.organizations.securityProfiles.environments.computeEnvironmentScores + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22628,7 +22676,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse parameters: - in: path name: organizationsId @@ -22636,22 +22685,22 @@ paths: schema: type: string - in: path - name: instancesId + name: securityProfilesId required: true schema: type: string - in: path - name: natAddressesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances: + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: parameters: *ref_1 - get: + delete: description: >- - Lists all Apigee runtime instances for the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.list + DeleteSecurityProfileEnvironmentAssociation removes profile environment + association i.e. detaches environment from security profile. + operationId: apigee.organizations.securityProfiles.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22663,33 +22712,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: securityProfilesId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: environmentsId + required: true schema: type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: + parameters: *ref_1 post: description: >- - Creates an Apigee runtime instance. The instance is accessible from the - authorized network configured on the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.create + CreateSecurityProfileEnvironmentAssociation creates profile environment + association i.e. attaches environment to security profile. + operationId: apigee.organizations.securityProfiles.environments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22701,24 +22753,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: + - in: path + name: securityProfilesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: parameters: *ref_1 - post: - description: Reports the latest status for a runtime instance. - operationId: apigee.organizations.instances.reportStatus - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest + delete: + description: DeleteSecurityProfile delete a profile with all its revisions. + operationId: apigee.organizations.securityProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22730,8 +22782,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -22739,23 +22790,18 @@ paths: schema: type: string - in: path - name: instancesId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}: - parameters: *ref_1 patch: - description: >- - Updates an Apigee runtime instance. You can update the fields described - in NodeConfig. No other fields will be updated. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.patch + description: UpdateSecurityProfile update the metadata of security profile. + operationId: apigee.organizations.securityProfiles.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22767,7 +22813,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId @@ -22775,7 +22821,7 @@ paths: schema: type: string - in: path - name: instancesId + name: securityProfilesId required: true schema: type: string @@ -22784,12 +22830,12 @@ paths: schema: type: string format: google-fieldmask - delete: + get: description: >- - Deletes an Apigee runtime instance. The instance stops serving requests - and the runtime data is deleted. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.delete + GetSecurityProfile gets the specified security profile. Returns + NOT_FOUND if security profile is not present for the specified + organization. + operationId: apigee.organizations.securityProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22801,7 +22847,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId @@ -22809,15 +22855,17 @@ paths: schema: type: string - in: path - name: instancesId + name: securityProfilesId required: true schema: type: string + /v1/organizations/{organizationsId}/securityProfiles: + parameters: *ref_1 get: description: >- - Gets the details for an Apigee runtime instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.get + ListSecurityProfiles lists all the security profiles associated with the + org including attached and unattached profiles. + operationId: apigee.organizations.securityProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22829,35 +22877,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: instancesId - required: true + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: >- - Updates the value of an API product attribute. **Note**: OAuth access - tokens and Key Management Service (KMS) entities (apps, developers, and - API products) are cached for 180 seconds (current default). Any custom - attributes associated with entities also get cached for at least 180 - seconds after entity is accessed during runtime. In this case, the - `ExpiresIn` element on the OAuthV2 policy won't be able to expire an - access token in less than 180 seconds. - operationId: apigee.organizations.apiproducts.attributes.updateApiProductAttribute + description: CreateSecurityProfile create a new custom security profile. + operationId: apigee.organizations.securityProfiles.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22869,26 +22913,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apiproductsId - required: true - schema: - type: string - - in: path - name: attributesId - required: true + - in: query + name: securityProfileId schema: type: string - delete: - description: Deletes an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.delete + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: + parameters: *ref_1 + get: + description: >- + ListSecurityProfileRevisions lists all the revisions of the security + profile. + operationId: apigee.organizations.securityProfiles.listRevisions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22900,7 +22942,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse parameters: - in: path name: organizationsId @@ -22908,18 +22951,30 @@ paths: schema: type: string - in: path - name: apiproductsId + name: securityProfilesId required: true schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: + parameters: *ref_1 get: - description: Gets the value of an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.get + description: >- + Retrieve metrics grouped by dimensions in host level. The types of + metrics you can retrieve include traffic, message counts, API call + latency, response size, and cache hits and counts. Dimensions let you + view metrics in meaningful groups. You can optionally pass dimensions as + path parameters to the `stats` API. If dimensions are not specified, the + metrics are computed on the entire set of data for the given time range. + operationId: apigee.organizations.hostStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22931,70 +22986,79 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apiproductsId - required: true + - in: path + name: hostStatsId + required: true + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: sort + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: tzo + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: timeUnit schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: timeRange schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: - parameters: *ref_1 - get: - description: Lists all API product attributes. - operationId: apigee.organizations.apiproducts.attributes.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' - parameters: - - in: path - name: organizationsId - required: true + - in: query + name: select schema: type: string - - in: path - name: apiproductsId - required: true + - in: query + name: offset schema: type: string - post: - description: >- - Updates or creates API product attributes. This API **replaces** the - current list of attributes with the attributes specified in the request - body. In this way, you can update existing attributes, add new - attributes, or delete existing attributes by omitting them from the - request body. **Note**: OAuth access tokens and Key Management Service - (KMS) entities (apps, developers, and API products) are cached for 180 - seconds (current default). Any custom attributes associated with - entities also get cached for at least 180 seconds after entity is - accessed during runtime. In this case, the `ExpiresIn` element on the - OAuthV2 policy won't be able to expire an access token in less than 180 - seconds. - operationId: apigee.organizations.apiproducts.attributes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + - in: query + name: sortby + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 + delete: + description: Deletes a key value map from an organization. + operationId: apigee.organizations.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23006,7 +23070,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -23014,30 +23078,20 @@ paths: schema: type: string - in: path - name: apiproductsId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: + /v1/organizations/{organizationsId}/keyvaluemaps: parameters: *ref_1 post: - description: >- - Create a rate plan that is associated with an API product in an - organization. Using rate plans, API product owners can monetize their - API products by configuring one or more of the following: - Billing - frequency - Initial setup fees for using an API product - Payment - funding model (postpaid only) - Fixed recurring or consumption-based - charges for using an API product - Revenue sharing with developer - partners An API product can have multiple rate plans associated with it - but *only one* rate plan can be active at any point of time. **Note: - From the developer's perspective, they purchase API products not rate - plans. - operationId: apigee.organizations.apiproducts.rateplans.create + description: Creates a key value map in an organization. + operationId: apigee.organizations.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23049,21 +23103,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apiproductsId - required: true - schema: - type: string - get: - description: Lists all the rate plans for an API product. - operationId: apigee.organizations.apiproducts.rateplans.list + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + parameters: *ref_1 + delete: + description: >- + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23075,7 +23131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -23083,41 +23139,25 @@ paths: schema: type: string - in: path - name: apiproductsId + name: keyvaluemapsId required: true schema: type: string - - in: query - name: count - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: startKey - schema: - type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: state + - in: path + name: entriesId + required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: - parameters: *ref_1 put: - description: Updates an existing rate plan. - operationId: apigee.organizations.apiproducts.rateplans.update + description: >- + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.keyvaluemaps.entries.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23129,7 +23169,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -23137,18 +23177,21 @@ paths: schema: type: string - in: path - name: apiproductsId + name: keyvaluemapsId required: true schema: type: string - in: path - name: rateplansId + name: entriesId required: true schema: type: string - delete: - description: Deletes a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.delete + get: + description: >- + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23160,7 +23203,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -23168,18 +23211,28 @@ paths: schema: type: string - in: path - name: apiproductsId + name: keyvaluemapsId required: true schema: type: string - in: path - name: rateplansId + name: entriesId required: true schema: type: string - get: - description: Gets the details of a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.get + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: + parameters: *ref_1 + post: + description: >- + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.keyvaluemaps.entries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23191,7 +23244,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -23199,43 +23252,16 @@ paths: schema: type: string - in: path - name: apiproductsId - required: true - schema: - type: string - - in: path - name: rateplansId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts: - parameters: *ref_1 - post: + get: description: >- - Creates an API product in an organization. You create API products after - you have proxied backend services using API proxies. An API product is a - collection of API resources combined with quota settings and metadata - that you can use to deliver customized and productized API bundles to - your developer community. This metadata can include: - Scope - - Environments - API proxies - Extensible profile API products enable you - repackage APIs on the fly, without having to do any additional coding or - configuration. Apigee recommends that you start with a simple API - product including only required elements. You then provision credentials - to apps to enable them to start testing your APIs. After you have - authentication and authorization working against a simple API product, - you can iterate to create finer-grained API products, defining different - sets of API resources for each API product. **WARNING:** - If you don't - specify an API proxy in the request body, *any* app associated with the - product can make calls to *any* API in your entire organization. - If - you don't specify an environment in the request body, the product allows - access to all environments. For more information, see What is an API - product? - operationId: apigee.organizations.apiproducts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23247,20 +23273,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId required: true schema: type: string - get: - description: >- - Lists all API product names for an organization. Filter the list by - passing an `attributename` and `attibutevalue`. The maximum number of - API products returned is 1000. You can paginate the list of API products - returned using the `startKey` and `count` query parameters. - operationId: apigee.organizations.apiproducts.list + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/hostQueries: + parameters: *ref_1 + get: + description: Return a list of Asynchronous Queries at host level. + operationId: apigee.organizations.hostQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23273,7 +23312,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId @@ -23281,77 +23320,45 @@ paths: schema: type: string - in: query - name: attributename + name: dataset schema: type: string - in: query - name: count + name: status schema: type: string - format: int64 - in: query - name: startKey + name: submittedBy schema: type: string - in: query - name: attributevalue + name: to schema: type: string - in: query - name: expand + name: inclQueriesWithoutReport schema: - type: boolean - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: - parameters: *ref_1 - delete: - description: >- - Deletes an API product from an organization. Deleting an API product - causes app requests to the resource URIs defined in the API product to - fail. Ensure that you create a new API product to serve existing apps, - unless your intention is to disable access to the resources defined in - the API product. The API product name required in the request URL is the - internal name of the product, not the display name. While they may be - the same, it depends on whether the API product was created via the UI - or the API. View the list of API products to verify the internal name. - operationId: apigee.organizations.apiproducts.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' - parameters: - - in: path - name: organizationsId - required: true + type: string + - in: query + name: envgroupHostname schema: type: string - - in: path - name: apiproductsId - required: true + - in: query + name: from schema: type: string - put: + post: description: >- - Updates an existing API product. You must include all required values, - whether or not you are updating them, as well as any optional values - that you are updating. The API product name required in the request URL - is the internal name of the product, not the display name. While they - may be the same, it depends on whether the API product was created via - UI or API. View the list of API products to identify their internal - names. - operationId: apigee.organizations.apiproducts.update + Submit a query at host level to be processed in the background. If the + submission of the query succeeds, the API returns a 201 status and an ID + that refer to the query. In addition to the HTTP status 201, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.hostQueries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23363,26 +23370,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apiproductsId - required: true - schema: - type: string + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: + parameters: *ref_1 get: - description: >- - Gets configuration details for an API product. The API product name - required in the request URL is the internal name of the product, not the - display name. While they may be the same, it depends on whether the API - product was created via the UI or the API. View the list of API products - to verify the internal name. - operationId: apigee.organizations.apiproducts.get + description: '' + operationId: apigee.organizations.hostQueries.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23394,7 +23393,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' parameters: - in: path name: organizationsId @@ -23402,22 +23401,20 @@ paths: schema: type: string - in: path - name: apiproductsId + name: hostQueriesId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: parameters: *ref_1 - put: + get: description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.keyvaluemaps.entries.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.hostQueries.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23429,7 +23426,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -23437,23 +23434,18 @@ paths: schema: type: string - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: hostQueriesId required: true schema: type: string - delete: + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: + parameters: *ref_1 + get: description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.keyvaluemaps.entries.delete + Get status of a query submitted at host level. If the query is still in + progress, the `state` is set to "running" After the query has completed + successfully, `state` is set to "completed" + operationId: apigee.organizations.hostQueries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23465,7 +23457,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -23473,21 +23465,15 @@ paths: schema: type: string - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: hostQueriesId required: true schema: type: string + /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: + parameters: *ref_1 get: - description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.keyvaluemaps.entries.get + description: Similar to GetHostStats except that the response is less verbose. + operationId: apigee.organizations.optimizedHostStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23499,7 +23485,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId @@ -23507,28 +23493,71 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: optimizedHostStatsId required: true schema: type: string - - in: path - name: entriesId - required: true + - in: query + name: sort schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: + - in: query + name: accuracy + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: select + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: parameters: *ref_1 - post: - description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.keyvaluemaps.entries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + get: + description: Lists all deployments of a shared flow revision. + operationId: apigee.organizations.sharedflows.revisions.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23540,7 +23569,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -23548,16 +23578,30 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: sharedflowsId required: true schema: type: string - get: + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: + parameters: *ref_1 + post: description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.keyvaluemaps.entries.list + Updates a shared flow revision. This operation is only allowed on + revisions which have never been deployed. After deployment a revision + becomes immutable, even if it becomes undeployed. The payload is a + ZIP-formatted shared flow. Content type must be either + multipart/form-data or application/octet-stream. + operationId: apigee.organizations.sharedflows.revisions.updateSharedFlowRevision + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23569,8 +23613,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -23578,24 +23621,29 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: sharedflowsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: revisionsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: validate schema: - type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_1 - delete: - description: Deletes a key value map from an organization. - operationId: apigee.organizations.keyvaluemaps.delete + type: boolean + get: + description: >- + Gets a revision of a shared flow. To download the shared flow + configuration bundle for the specified revision as a zip file, set the + `format` query parameter to `bundle`. If you are using curl, specify `-o + filename.zip` to save the output to a file; otherwise, it displays to + `stdout`. Then, develop the shared flow configuration locally and upload + the updated sharedFlow configuration revision, as described in + [updateSharedFlowRevision](updateSharedFlowRevision). + operationId: apigee.organizations.sharedflows.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23607,7 +23655,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -23615,43 +23663,24 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps: - parameters: *ref_1 - post: - description: Creates a key value map in an organization. - operationId: apigee.organizations.keyvaluemaps.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' - parameters: - in: path - name: organizationsId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores: - parameters: *ref_1 - get: - description: List Datastores - operationId: apigee.organizations.analytics.datastores.list + - in: query + name: format + schema: + type: string + delete: + description: >- + Deletes a shared flow and all associated policies, resources, and + revisions. You must undeploy the shared flow before deleting it. + operationId: apigee.organizations.sharedflows.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23663,25 +23692,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: targetType + - in: path + name: sharedflowsId + required: true schema: type: string - post: - description: Create a Datastore for an org - operationId: apigee.organizations.analytics.datastores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of a shared flow. + operationId: apigee.organizations.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23693,18 +23725,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: + - in: path + name: sharedflowsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/sharedflows: parameters: *ref_1 get: - description: Get a Datastore - operationId: apigee.organizations.analytics.datastores.get + description: Lists all shared flows in the organization. + operationId: apigee.organizations.sharedflows.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23716,26 +23754,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: datastoresId - required: true + - in: query + name: includeMetaData schema: - type: string - put: - description: Update a Datastore - operationId: apigee.organizations.analytics.datastores.update + type: boolean + - in: query + name: includeRevisions + schema: + type: boolean + post: + description: >- + Uploads a ZIP-formatted shared flow configuration bundle to an + organization. If the shared flow already exists, this creates a new + revision of it. If the shared flow does not exist, this creates it. Once + imported, the shared flow revision must be deployed before it can be + accessed at runtime. The size limit of a shared flow bundle is 15 MB. + operationId: apigee.organizations.sharedflows.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23747,21 +23794,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: datastoresId - required: true + - in: query + name: name schema: type: string - delete: - description: Delete a Datastore from an org. - operationId: apigee.organizations.analytics.datastores.delete + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: + parameters: *ref_1 + get: + description: Gets a shared flow by name, including a list of its revisions. + operationId: apigee.organizations.sharedflows.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23773,7 +23825,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId @@ -23781,23 +23833,15 @@ paths: schema: type: string - in: path - name: datastoresId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores:test: - parameters: *ref_1 - post: + delete: description: >- - Test if Datastore configuration is correct. This includes checking if - credentials provided by customer have required permissions in target - destination storage - operationId: apigee.organizations.analytics.datastores.test - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + Deletes a shared flow and all it's revisions. The shared flow must be + undeployed before you can delete it. + operationId: apigee.organizations.sharedflows.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23809,13 +23853,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: sharedflowsId + required: true + schema: + type: string /v1/organizations/{organizationsId}/deployments: parameters: *ref_1 get: @@ -23844,11 +23893,14 @@ paths: name: sharedFlows schema: type: boolean - /v1/organizations/{organizationsId}/apis/{apisId}/deployments: + /v1/organizations/{organizationsId}/apps: parameters: *ref_1 get: - description: Lists all deployments of an API proxy. - operationId: apigee.organizations.apis.deployments.list + description: >- + Lists IDs of apps within an organization that have the specified app + status (approved or revoked) or are of the specified app type (developer + or company). + operationId: apigee.organizations.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23860,24 +23912,68 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true + - in: query + name: ids schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + - in: query + name: expand + schema: + type: boolean + - in: query + name: status + schema: + type: string + - in: query + name: rows + schema: + type: string + format: int64 + - in: query + name: apptype + schema: + type: string + - in: query + name: includeCred + schema: + type: boolean + - in: query + name: filter + schema: + type: string + - in: query + name: keyStatus + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: startKey + schema: + type: string + - in: query + name: apiProduct + schema: + type: string + /v1/organizations/{organizationsId}/apps/{appsId}: parameters: *ref_1 get: - description: Lists all deployments of an API proxy revision. - operationId: apigee.organizations.apis.revisions.deployments.list + description: Gets the app profile for the specified app ID. + operationId: apigee.organizations.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23889,8 +23985,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1App' parameters: - in: path name: organizationsId @@ -23898,23 +23993,15 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: + /v1/organizations/{organizationsId}/analytics/datastores: parameters: *ref_1 - delete: - description: >- - Deletes an API proxy revision and all policies, resources, endpoints, - and revisions associated with it. The API proxy revision must be - undeployed before you can delete it. - operationId: apigee.organizations.apis.revisions.delete + get: + description: List Datastores + operationId: apigee.organizations.analytics.datastores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23926,33 +24013,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true + - in: query + name: targetType schema: type: string - get: - description: >- - Gets an API proxy revision. To download the API proxy configuration - bundle for the specified revision as a zip file, set the `format` query - parameter to `bundle`. If you are using curl, specify `-o filename.zip` - to save the output to a file; otherwise, it displays to `stdout`. Then, - develop the API proxy configuration locally and upload the updated API - proxy configuration revision, as described in - [updateApiProxyRevision](updateApiProxyRevision). - operationId: apigee.organizations.apis.revisions.get + post: + description: Create a Datastore for an org + operationId: apigee.organizations.analytics.datastores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23964,41 +24043,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: query - name: format - schema: - type: string + /v1/organizations/{organizationsId}/analytics/datastores:test: + parameters: *ref_1 post: description: >- - Updates an existing API proxy revision by uploading the API proxy - configuration bundle as a zip file from your local machine. You can - update only API proxy revisions that have never been deployed. After - deployment, an API proxy revision becomes immutable, even if it is - undeployed. Set the `Content-Type` header to either - `multipart/form-data` or `application/octet-stream`. - operationId: apigee.organizations.apis.revisions.updateApiProxyRevision + Test if Datastore configuration is correct. This includes checking if + credentials provided by customer have required permissions in target + destination storage + operationId: apigee.organizations.analytics.datastores.test requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24010,37 +24074,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: query - name: validate - schema: - type: boolean - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: + /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: parameters: *ref_1 - post: - description: Creates a key value map in an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.create + put: + description: Update a Datastore + operationId: apigee.organizations.analytics.datastores.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24052,7 +24102,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId @@ -24060,15 +24110,13 @@ paths: schema: type: string - in: path - name: apisId + name: datastoresId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_1 - delete: - description: Deletes a key value map from an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.delete + get: + description: Get a Datastore + operationId: apigee.organizations.analytics.datastores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24080,7 +24128,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId @@ -24088,23 +24136,13 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: datastoresId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: - parameters: *ref_1 - get: - description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.get + delete: + description: Delete a Datastore from an org. + operationId: apigee.organizations.analytics.datastores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24116,7 +24154,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -24124,28 +24162,15 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: datastoresId required: true schema: type: string - delete: - description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.delete + /v1/organizations/{organizationsId}:getProjectMapping: + parameters: *ref_1 + get: + description: Gets the project ID and region for an Apigee organization. + operationId: apigee.organizations.getProjectMapping security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24157,38 +24182,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId - required: true - schema: - type: string - put: + /v1/organizations/{organizationsId}:getSyncAuthorization: + parameters: *ref_1 + post: description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.apis.keyvaluemaps.entries.update + Lists the service accounts with the permissions required to allow the + Synchronizer to download environment data from the control plane. An + ETag is returned in the response to `getSyncAuthorization`. Pass that + ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure + that you are updating the correct version. If you don't pass the ETag in + the call to `setSyncAuthorization`, then the existing authorization is + overwritten indiscriminately. For more information, see [Configure the + Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). + **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.getSyncAuthorization requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24200,41 +24221,83 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId - required: true + /v1/organizations: + parameters: *ref_1 + get: + description: >- + Lists the Apigee organizations and associated Google Cloud projects that + you have permission to access. See [Understanding + organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). + operationId: apigee.organizations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse + parameters: [] + post: + description: >- + Creates an Apigee organization. See [Create an Apigee + organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + operationId: apigee.organizations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: query + name: parent schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: + /v1/organizations/{organizationsId}:setSyncAuthorization: parameters: *ref_1 post: description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.create + Sets the permissions required to allow the Synchronizer to download + environment data from the control plane. You must call this API to + enable proper functioning of hybrid. Pass the ETag when calling + `setSyncAuthorization` to ensure that you are updating the correct + version. To get an ETag, call + [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag + in the call to `setSyncAuthorization`, then the existing authorization + is overwritten indiscriminately. For more information, see [Configure + the + Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). + **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.setSyncAuthorization requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24246,29 +24309,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - get: + /v1/organizations/{organizationsId}:setAddons: + parameters: *ref_1 + post: description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.list + Configures the add-ons for the Apigee organization. The existing add-on + configuration will be fully replaced. + operationId: apigee.organizations.setAddons + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24280,41 +24339,25 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/apis/{apisId}: + /v1/organizations/{organizationsId}: parameters: *ref_1 - delete: + put: description: >- - Deletes an API proxy and all associated endpoints, policies, resources, - and revisions. The API proxy must be undeployed before you can delete - it. - operationId: apigee.organizations.apis.delete + Updates the properties for an Apigee organization. No other fields in + the organization profile will be updated. + operationId: apigee.organizations.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24326,21 +24369,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string get: - description: Gets an API proxy including a list of existing revisions. - operationId: apigee.organizations.apis.get + description: >- + Gets the profile for an Apigee organization. See [Understanding + organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). + operationId: apigee.organizations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24352,26 +24392,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - patch: - description: Updates an existing API proxy. - operationId: apigee.organizations.apis.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + delete: + description: >- + Delete an Apigee organization. For organizations with BillingType + EVALUATION, an immediate deletion is performed. For paid organizations + (Subscription or Pay-as-you-go), a soft-deletion is performed. The + organization can be restored within the soft-deletion period, which is + specified using the `retention` field in the request or by filing a + support ticket with Apigee. During the data retention period specified + in the request, the Apigee organization cannot be recreated in the same + Google Cloud project. **IMPORTANT: The default data retention setting + for this operation is 7 days. To permanently delete the organization in + 24 hours, set the retention parameter to `MINIMUM`.** + operationId: apigee.organizations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24383,48 +24423,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - in: query - name: updateMask + name: retention schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/apis: + /v1/organizations/{organizationsId}/runtimeConfig: parameters: *ref_1 - post: - description: >- - Creates an API proxy. The API proxy created will not be accessible at - runtime until it is deployed to an environment. Create a new API proxy - by setting the `name` query parameter to the name of the API proxy. - Import an API proxy configuration bundle stored in zip format on your - local machine to your organization by doing the following: * Set the - `name` query parameter to the name of the API proxy. * Set the `action` - query parameter to `import`. * Set the `Content-Type` header to - `multipart/form-data`. * Pass as a file the name of API proxy - configuration bundle stored in zip format on your local machine using - the `file` form field. **Note**: To validate the API proxy configuration - bundle only without importing it, set the `action` query parameter to - `validate`. When importing an API proxy configuration bundle, if the API - proxy does not exist, it will be created. If the API proxy exists, then - a new revision is created. Invalid API proxy configurations are - rejected, and a list of validation errors is returned to the client. - operationId: apigee.organizations.apis.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + get: + description: Get runtime config for an organization. + operationId: apigee.organizations.getRuntimeConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24436,31 +24450,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: action - schema: - type: string - - in: query - name: name - schema: - type: string - - in: query - name: validate - schema: - type: boolean + /v1/organizations/{organizationsId}/securitySettings: + parameters: *ref_1 get: - description: >- - Lists the names of all API proxies in an organization. The names - returned correspond to the names defined in the configuration files for - each API proxy. - operationId: apigee.organizations.apis.list + description: GetSecuritySettings gets the security settings for API Security. + operationId: apigee.organizations.getSecuritySettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24472,32 +24473,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: includeRevisions - schema: - type: boolean - - in: query - name: includeMetaData - schema: - type: boolean - /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: - parameters: *ref_1 - post: - description: Compute RAV2 security scores for a set of resources. - operationId: apigee.organizations.securityAssessmentResults.batchCompute + patch: + description: >- + UpdateSecuritySettings updates the current security settings for API + Security. + operationId: apigee.organizations.updateSecuritySettings requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24509,23 +24501,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/hybrid/issuers: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/deployedIngressConfig: parameters: *ref_1 get: - description: >- - Lists hybrid services and its trusted issuers service account ids. This - api is authenticated and unauthorized(allow all the users) and used by - runtime authn-authz service to query control plane's issuer service - account ids. - operationId: apigee.hybrid.issuers.list + description: Gets the deployed ingress configuration for an organization. + operationId: apigee.organizations.getDeployedIngressConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24537,9 +24529,17 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse - parameters: [] + $ref: '#/components/schemas/GoogleCloudApigeeV1IngressConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string /v1/projects/{projectsId}:provisionOrganization: parameters: *ref_1 post: diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml index 4b672d8c..3804e66f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20231204' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml b/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml index 6a9b821d..2dcabd4b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml @@ -8,7 +8,7 @@ info: description: Manages the API keys associated with developer projects. version: v2 x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/api-keys/docs servers: @@ -37,94 +37,93 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - V2AndroidKeyRestrictions: - properties: - allowedApplications: - items: - $ref: '#/components/schemas/V2AndroidApplication' - type: array - description: >- - A list of Android applications that are allowed to make API calls - with this key. - type: object - id: V2AndroidKeyRestrictions - description: The Android apps that are allowed to use the key. V2UndeleteKeyRequest: - description: Request message for `UndeleteKey` method. - id: V2UndeleteKeyRequest properties: {} type: object + id: V2UndeleteKeyRequest + description: Request message for `UndeleteKey` method. V2LookupKeyResponse: + type: object + description: Response message for `LookupKey` method. id: V2LookupKeyResponse properties: parent: + type: string description: >- The project that owns the key with the value specified in the request. - type: string name: + type: string description: >- The resource name of the API key. If the API key has been purged, resource name is empty. - type: string - description: Response message for `LookupKey` method. + V2ListKeysResponse: type: object - V2BrowserKeyRestrictions: - description: The HTTP referrers (websites) that are allowed to use the key. + id: V2ListKeysResponse properties: - allowedReferrers: + keys: items: - type: string - description: >- - A list of regular expressions for the referrer URLs that are allowed - to make API calls with this key. + $ref: '#/components/schemas/V2Key' + description: A list of API keys. type: array - id: V2BrowserKeyRestrictions - type: object - V2AndroidApplication: - description: Identifier of an Android application for key use. - type: object - id: V2AndroidApplication - properties: - packageName: - description: The package name of the application. - type: string - sha1Fingerprint: + nextPageToken: + description: The pagination token for the next page of results. type: string - description: >- - The SHA1 fingerprint of the application. For example, both sha1 - formats are acceptable : - DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or - DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the - latter. + description: Response message for `ListKeys` method. V2Key: type: object + description: The representation of a key managed by the API Keys API. id: V2Key properties: - name: + restrictions: + description: Key restrictions. + $ref: '#/components/schemas/V2Restrictions' + uid: + description: Output only. Unique id in UUID4 format. + readOnly: true type: string + keyString: + description: >- + Output only. An encrypted and signed value held by this key. This + field can be accessed only through the `GetKeyString` method. readOnly: true + type: string + name: description: >- Output only. 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`. + readOnly: true + type: string + displayName: + description: >- + Human-readable display name of this key that you can modify. The + maximum length is 63 characters. + type: string etag: + type: string readOnly: true description: >- Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154. + updateTime: type: string + readOnly: true + format: google-datetime + description: >- + Output only. A timestamp identifying the time this key was last + updated. createTime: - type: string format: google-datetime description: >- Output only. A timestamp identifying the time this key was originally created. readOnly: true + type: string annotations: type: object description: >- @@ -134,218 +133,231 @@ components: modifying objects. additionalProperties: type: string - uid: + deleteTime: + format: google-datetime + description: >- + Output only. A timestamp when this key was deleted. If the resource + is not deleted, this must be empty. type: string - description: Output only. Unique id in UUID4 format. readOnly: true + V2GetKeyStringResponse: + id: V2GetKeyStringResponse + description: Response message for `GetKeyString` method. + properties: keyString: + description: An encrypted and signed value of the key. type: string - readOnly: true - description: >- - Output only. An encrypted and signed value held by this key. This - field can be accessed only through the `GetKeyString` method. - restrictions: - description: Key restrictions. - $ref: '#/components/schemas/V2Restrictions' - displayName: - type: string + type: object + V2AndroidApplication: + properties: + sha1Fingerprint: description: >- - Human-readable display name of this key that you can modify. The - maximum length is 63 characters. - updateTime: - readOnly: true + The SHA1 fingerprint of the application. For example, both sha1 + formats are acceptable : + DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or + DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the + latter. type: string - description: >- - Output only. A timestamp identifying the time this key was last - updated. - format: google-datetime - deleteTime: + packageName: type: string - readOnly: true - description: >- - Output only. A timestamp when this key was deleted. If the resource - is not deleted, this must be empty. - format: google-datetime - description: The representation of a key managed by the API Keys API. - V2IosKeyRestrictions: - id: V2IosKeyRestrictions + description: The package name of the application. + id: V2AndroidApplication + description: Identifier of an Android application for key use. type: object + V2AndroidKeyRestrictions: + id: V2AndroidKeyRestrictions properties: - allowedBundleIds: + allowedApplications: + type: array items: - type: string + $ref: '#/components/schemas/V2AndroidApplication' description: >- - A list of bundle IDs that are allowed when making API calls with - this key. + A list of Android applications that are allowed to make API calls + with this key. + description: The Android apps that are allowed to use the key. + type: object + V2Restrictions: + type: object + id: V2Restrictions + description: Describes the restrictions on the key. + properties: + apiTargets: type: array - description: The iOS apps that are allowed to use the key. - V2ServerKeyRestrictions: + description: >- + A restriction for a specific service and optionally one or more + specific methods. Requests are allowed if they match any of these + restrictions. If no restrictions are specified, all targets are + allowed. + items: + $ref: '#/components/schemas/V2ApiTarget' + androidKeyRestrictions: + $ref: '#/components/schemas/V2AndroidKeyRestrictions' + description: The Android apps that are allowed to use the key. + iosKeyRestrictions: + description: The iOS apps that are allowed to use the key. + $ref: '#/components/schemas/V2IosKeyRestrictions' + browserKeyRestrictions: + description: The HTTP referrers (websites) that are allowed to use the key. + $ref: '#/components/schemas/V2BrowserKeyRestrictions' + serverKeyRestrictions: + $ref: '#/components/schemas/V2ServerKeyRestrictions' + description: The IP addresses of callers that are allowed to use the key. + V2ApiTarget: type: object properties: - allowedIps: + methods: items: type: string - description: >- - A list of the caller IP addresses that are allowed to make API calls - with this key. type: array - description: The IP addresses of callers that are allowed to use the key. - id: V2ServerKeyRestrictions - Operation: + description: >- + Optional. List of one or more methods that can be called. If empty, + all methods for the service are allowed. A wildcard (*) can be used + as the last symbol. Valid examples: + `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` + `TranslateText` `Get*` `translate.googleapis.com.Get*` + service: + type: string + description: >- + The service for this restriction. It should be the canonical service + name, for example: `translate.googleapis.com`. You can use [`gcloud + services + list`](https://cloud.google.com/sdk/gcloud/reference/services/list) + to get a list of services that are enabled in the project. description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: Operation + A restriction for a specific service and optionally one or multiple + specific methods. Both fields are case insensitive. + id: V2ApiTarget + Operation: properties: - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object done: + type: boolean description: >- If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - type: boolean - name: + error: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' metadata: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object description: >- Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. - error: - $ref: '#/components/schemas/Status' + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + name: description: >- - The error result of the operation in case of failure or - cancellation. - type: object - V2Restrictions: - id: V2Restrictions - properties: - serverKeyRestrictions: - description: The IP addresses of callers that are allowed to use the key. - $ref: '#/components/schemas/V2ServerKeyRestrictions' - apiTargets: - type: array - items: - $ref: '#/components/schemas/V2ApiTarget' + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - A restriction for a specific service and optionally one or more - specific methods. Requests are allowed if they match any of these - restrictions. If no restrictions are specified, all targets are - allowed. - iosKeyRestrictions: - $ref: '#/components/schemas/V2IosKeyRestrictions' - description: The iOS apps that are allowed to use the key. - androidKeyRestrictions: - $ref: '#/components/schemas/V2AndroidKeyRestrictions' - description: The Android apps that are allowed to use the key. - browserKeyRestrictions: - description: The HTTP referrers (websites) that are allowed to use the key. - $ref: '#/components/schemas/V2BrowserKeyRestrictions' - description: Describes the restrictions on the key. - type: object - V2GetKeyStringResponse: - id: V2GetKeyStringResponse + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object type: object - description: Response message for `GetKeyString` method. - properties: - keyString: - type: string - description: An encrypted and signed value of the key. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: Operation Status: + type: object + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. details: items: additionalProperties: description: Properties of the object. Contains field @type with type URL. type: any type: object - type: array description: >- A list of messages that carry the error details. There is a common set of message types for APIs to use. - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + type: array + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + V2ServerKeyRestrictions: + description: The IP addresses of callers that are allowed to use the key. type: object - id: Status - V2ListKeysResponse: properties: - nextPageToken: - description: The pagination token for the next page of results. - type: string - keys: - items: - $ref: '#/components/schemas/V2Key' + allowedIps: + description: >- + A list of the caller IP addresses that are allowed to make API calls + with this key. type: array - description: A list of API keys. + items: + type: string + id: V2ServerKeyRestrictions + V2BrowserKeyRestrictions: type: object - id: V2ListKeysResponse - description: Response message for `ListKeys` method. - V2ApiTarget: - id: V2ApiTarget properties: - service: - type: string + allowedReferrers: description: >- - The service for this restriction. It should be the canonical service - name, for example: `translate.googleapis.com`. You can use [`gcloud - services - list`](https://cloud.google.com/sdk/gcloud/reference/services/list) - to get a list of services that are enabled in the project. - methods: + A list of regular expressions for the referrer URLs that are allowed + to make API calls with this key. items: type: string + type: array + id: V2BrowserKeyRestrictions + description: The HTTP referrers (websites) that are allowed to use the key. + V2IosKeyRestrictions: + description: The iOS apps that are allowed to use the key. + properties: + allowedBundleIds: description: >- - Optional. List of one or more methods that can be called. If empty, - all methods for the service are allowed. A wildcard (*) can be used - as the last symbol. Valid examples: - `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` - `TranslateText` `Get*` `translate.googleapis.com.Get*` + A list of bundle IDs that are allowed when making API calls with + this key. + items: + type: string type: array type: object - description: >- - A restriction for a specific service and optionally one or multiple - specific methods. Both fields are case insensitive. + id: V2IosKeyRestrictions parameters: + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string alt: description: Data format for response. in: query @@ -356,28 +368,22 @@ components: - json - media - proto - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: upload_protocol + name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + 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. in: query - name: uploadType + name: key schema: type: string access_token: @@ -386,6 +392,12 @@ components: name: access_token schema: type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -395,34 +407,22 @@ components: enum: - '1' - '2' - 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. - in: query - name: key - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + callback: + description: JSONP in: query - name: quotaUser + name: callback schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol schema: type: string x-stackQL-resources: @@ -431,42 +431,42 @@ components: name: keys title: Keys methods: - list: + get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keys - create: + delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.keys undelete: operation: $ref: >- @@ -530,25 +530,25 @@ components: replace: [] delete: [] paths: - /v2/projects/{projectsId}/locations/{locationsId}/keys: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' get: description: >- - Lists the API keys owned by a project. The key string of the API key - isn't included in the response. NOTE: Key is a global resource; hence - the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.list + Gets the metadata for an API key. The key string of the API key isn't + included in the response. NOTE: Key is a global resource; hence the only + supported value for location is `global`. + operationId: apikeys.projects.locations.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -564,7 +564,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/V2ListKeysResponse' + $ref: '#/components/schemas/V2Key' parameters: - in: path name: projectsId @@ -576,29 +576,18 @@ paths: required: true schema: type: string - - in: query - name: showDeleted - schema: - type: boolean - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: keysId + required: true schema: type: string - post: + delete: description: >- - Creates a new API key. NOTE: Key is a global resource; hence the only - supported value for location is `global`. - operationId: apikeys.projects.locations.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2Key' + Deletes an API key. Deleted key can be retrieved within 30 days of + deletion. Afterward, key will be purged from the project. NOTE: Key is a + global resource; hence the only supported value for location is + `global`. + operationId: apikeys.projects.locations.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -622,34 +611,38 @@ paths: required: true schema: type: string + - in: path + name: keysId + required: true + schema: + type: string - in: query - name: keyId + name: etag schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: - parameters: *ref_1 - get: + patch: description: >- - Gets the metadata for an API key. The key string of the API key isn't - included in the response. NOTE: Key is a global resource; hence the only - supported value for location is `global`. - operationId: apikeys.projects.locations.keys.get + Patches the modifiable fields of an API key. The key string of the API + key isn't included in the response. NOTE: Key is a global resource; + hence the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/V2Key' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -666,13 +659,23 @@ paths: required: true schema: type: string - delete: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v2/projects/{projectsId}/locations/{locationsId}/keys: + parameters: *ref_1 + post: description: >- - Deletes an API key. Deleted key can be retrieved within 30 days of - deletion. Afterward, key will be purged from the project. NOTE: Key is a - global resource; hence the only supported value for location is - `global`. - operationId: apikeys.projects.locations.keys.delete + Creates a new API key. NOTE: Key is a global resource; hence the only + supported value for location is `global`. + operationId: apikeys.projects.locations.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -696,38 +699,32 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - in: query - name: etag + name: keyId schema: type: string - patch: + get: description: >- - Patches the modifiable fields of an API key. The key string of the API - key isn't included in the response. NOTE: Key is a global resource; - hence the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2Key' + Lists the API keys owned by a project. The key string of the API key + isn't included in the response. NOTE: Key is a global resource; hence + the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/V2ListKeysResponse' parameters: - in: path name: projectsId @@ -739,41 +736,42 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: + type: integer + format: int32 + - in: query + name: showDeleted + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: parameters: *ref_1 - post: + get: description: >- - Undeletes an API key which was deleted within 30 days. NOTE: Key is a - global resource; hence the only supported value for location is - `global`. - operationId: apikeys.projects.locations.keys.undelete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2UndeleteKeyRequest' + Get the key string for an API key. NOTE: Key is a global resource; hence + the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.getKeyString security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/V2GetKeyStringResponse' parameters: - in: path name: projectsId @@ -790,29 +788,31 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: parameters: *ref_1 - get: + post: description: >- - Get the key string for an API key. NOTE: Key is a global resource; hence - the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.getKeyString + Undeletes an API key which was deleted within 30 days. NOTE: Key is a + global resource; hence the only supported value for location is + `global`. + operationId: apikeys.projects.locations.keys.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2UndeleteKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/V2GetKeyStringResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId diff --git a/providers/src/googleapis.com/v00.00.00000/services/apim.yaml b/providers/src/googleapis.com/v00.00.00000/services/apim.yaml index 1d285389..1d613533 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apim.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apim.yaml @@ -10,7 +10,7 @@ info: infrastructure. version: v1alpha x-discovery-doc-revision: '20240731' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/apigee/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml index 2f0ebb3f..bd2d4cab 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml @@ -7,8 +7,8 @@ info: title: App Engine Admin API description: Provisions and manages developers' App Engine applications. version: v1 - x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/appengine/docs/admin-api/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml b/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml index 14a1d4ef..ddbbdf73 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240814' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/app-hub/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml b/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml index 26e3fd39..16cc5d94 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml @@ -9,8 +9,8 @@ info: Store and manage build artifacts in a scalable and integrated service built on Google infrastructure. version: v1 - x-discovery-doc-revision: '20240903' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/artifacts/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml b/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml index adea76e0..7b55745c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/learnmoreurl servers: @@ -34,18 +34,119 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: - id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo + GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: + description: >- + Response containing the analysis results for the hypothetical resource + move. + id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse + properties: + nextPageToken: + description: The next page token. Is empty if the last page is reached. + type: string + assetMoveAnalyses: + description: List of analysis results for each asset in scope. + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis + type: array type: object - description: Represent the resources that are children of this Workload. + GoogleRpcStatus: + type: object + id: GoogleRpcStatus + properties: + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + details: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: + properties: + ekmProvisioningErrorMapping: + description: Detailed error message if Ekm provisioning fails + type: string + enum: + - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED + - INVALID_SERVICE_ACCOUNT + - MISSING_METRICS_SCOPE_ADMIN_PERMISSION + - MISSING_EKM_CONNECTION_ADMIN_PERMISSION + enumDescriptions: + - Error is unspecified. + - Service account is used is invalid. + - Iam permission monitoring.MetricsScopeAdmin wasn't applied. + - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. + ekmProvisioningErrorDomain: + enumDescriptions: + - No error domain + - Error but domain is unspecified. + - Internal logic breaks within provisioning code. + - >- + Error occurred with the customer not granting permission/creating + resource. + - Error occurred within the partner's provisioning cluster. + - Resource wasn't provisioned in the required 7 day time period + enum: + - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED + - UNSPECIFIED_ERROR + - GOOGLE_SERVER_ERROR + - EXTERNAL_USER_ERROR + - EXTERNAL_PARTNER_ERROR + - TIMEOUT_ERROR + type: string + description: Indicates Ekm provisioning error if any. + ekmProvisioningState: + enum: + - EKM_PROVISIONING_STATE_UNSPECIFIED + - EKM_PROVISIONING_STATE_PENDING + - EKM_PROVISIONING_STATE_FAILED + - EKM_PROVISIONING_STATE_COMPLETED + type: string + description: Indicates Ekm enrollment Provisioning of a given workload. + enumDescriptions: + - Default State for Ekm Provisioning + - Pending State for Ekm Provisioning + - Failed State for Ekm Provisioning + - Completed State for Ekm Provisioning + type: object + id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse + description: External key management systems(EKM) Provisioning response + GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: properties: + displayName: + description: >- + User-assigned resource display name. If not empty it will be used to + create a resource with the specified name. + type: string resourceId: - description: Resource identifier. For a project this represents project_number. - format: int64 type: string + description: >- + Resource identifier. For a project this represents project_id. If + the project is already taken, the workload creation will fail. For + KeyRing, this represents the keyring_id. For a folder, don't set + this value as folder_id is assigned by Google. resourceType: - type: string - description: Indicates the type of resource. enumDescriptions: - Unknown resource type. - >- @@ -55,6 +156,7 @@ components: - Consumer Folder. - Consumer project containing encryption keys. - Keyring resource that hosts encryption keys. + type: string enum: - RESOURCE_TYPE_UNSPECIFIED - CONSUMER_PROJECT @@ -67,248 +169,291 @@ components: - false - false - false - GoogleRpcStatus: + description: >- + Indicates the type of resource. This field should be specified to + correspond the id to the right project type (CONSUMER_PROJECT or + ENCRYPTION_KEYS_PROJECT) + type: object + id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + description: Represent the custom settings for the resources to be created. + GoogleCloudAssuredworkloadsV1ListViolationsResponse: + description: Response of ListViolations endpoint. + id: GoogleCloudAssuredworkloadsV1ListViolationsResponse + type: object properties: - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + nextPageToken: + description: The next page token. Returns empty if reached the last page. + type: string + violations: + description: List of Violations under a Workload. type: array + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + GoogleCloudAssuredworkloadsV1ViolationExceptionContext: + properties: + comment: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: + Business justification provided towards the acknowledgement of the + violation. + type: string + acknowledgementTime: + type: string + description: Timestamp when the violation was acknowledged. + format: google-datetime + userName: + type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Name of the user (or service account) who acknowledged the + violation. + description: Violation exception detail. + type: object + id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext + GoogleLongrunningListOperationsResponse: + type: object + properties: + operations: + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: >- + A list of operations that matches the specified filter in the + request. + type: array + nextPageToken: + description: The standard List next-page token. type: string - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: + type: object + properties: {} + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + description: Response for restricting the list of allowed resources. + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: + type: object + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions + properties: + consoleInstructions: + description: Remediation instructions to resolve violation via cloud console + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole + gcloudInstructions: + description: Remediation instructions to resolve violation via gcloud cli + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + description: Instructions to remediate violation + GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: + properties: + serviceAccessApprover: + type: boolean + description: Optional. Allow partner to view access approval logs. + assuredWorkloadsMonitoring: + description: Optional. Allow partner to view violation alerts. + type: boolean + dataLogsViewer: + description: >- + Allow the partner to view inspectability logs and monitoring + violations. + type: boolean + accessTransparencyLogsSupportCaseViewer: + type: boolean + description: Optional. Allow partner to view support case details for an AXT log description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus + Permissions granted to the AW Partner SA account for the customer + workload type: object + id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions GoogleCloudAssuredworkloadsV1Violation: - type: object properties: - updateTime: + category: type: string - description: Output only. The last time when the Violation record was updated. - format: google-datetime + description: >- + Output only. Category under which this violation is mapped. e.g. + Location, Service Usage, Access, Encryption, etc. readOnly: true - resourceName: - type: string + name: description: >- - Optional. Output only. Name of the resource like - //storage.googleapis.com/myprojectxyz-testbucket. Empty for - org-policy violations. + Output only. Immutable. Name of the Violation. Format: + organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} readOnly: true + type: string nonCompliantOrgPolicy: + type: string description: >- Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name} + readOnly: true + beginTime: type: string readOnly: true - acknowledged: - description: A boolean that indicates if the violation is acknowledged - type: boolean - exceptionContexts: + description: Output only. Time of the event which triggered the Violation. + format: google-datetime + updateTime: + description: Output only. The last time when the Violation record was updated. + format: google-datetime readOnly: true - type: array - description: >- - Output only. List of all the exception detail added for the - violation. - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext - beginTime: - format: google-datetime - type: string - description: Output only. Time of the event which triggered the Violation. - readOnly: true - category: - description: >- - Output only. Category under which this violation is mapped. e.g. - Location, Service Usage, Access, Encryption, etc. - readOnly: true - type: string - resourceType: type: string - readOnly: true - description: >- - Optional. Output only. Type of the resource like - compute.googleapis.com/Disk, etc. Empty for org-policy violations. - name: - readOnly: true + resourceName: type: string description: >- - Output only. Immutable. Name of the Violation. Format: - organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} - description: - description: >- - Output only. Description for the Violation. e.g. OrgPolicy - gcp.resourceLocations has non compliant value. - type: string + Optional. Output only. Name of the resource like + //storage.googleapis.com/myprojectxyz-testbucket. Empty for + org-policy violations. readOnly: true exceptionAuditLogLink: + type: string description: >- Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} - type: string readOnly: true + remediation: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation + description: Output only. Compliance violation remediation acknowledgementTime: + format: google-datetime + type: string description: >- Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. - type: string - format: google-datetime - orgPolicyConstraint: - type: string - deprecated: true + description: description: >- - Output only. Immutable. The org-policy-constraint that was - incorrectly changed, which resulted in this violation. + Output only. Description for the Violation. e.g. OrgPolicy + gcp.resourceLocations has non compliant value. + type: string readOnly: true - associatedOrgPolicyViolationId: + violationType: + enumDescriptions: + - Unspecified type. + - Org Policy Violation. + - Resource Violation. + enum: + - VIOLATION_TYPE_UNSPECIFIED + - ORG_POLICY + - RESOURCE + description: Output only. Type of the violation + type: string readOnly: true + resolveTime: type: string description: >- - Optional. Output only. Violation Id of the org-policy violation due - to which the resource violation is caused. Empty for org-policy - violations. + Output only. Time of the event which fixed the Violation. If the + violation is ACTIVE this will be empty. + format: google-datetime + readOnly: true state: + readOnly: true enumDescriptions: - Unspecified state. - Violation is resolved. - Violation is Unresolved - Violation is Exception - type: string - readOnly: true description: Output only. State of the violation + type: string enum: - STATE_UNSPECIFIED - RESOLVED - UNRESOLVED - EXCEPTION - resolveTime: - format: google-datetime - type: string - description: >- - Output only. Time of the event which fixed the Violation. If the - violation is ACTIVE this will be empty. - readOnly: true - remediation: + exceptionContexts: + type: array readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation - description: Output only. Compliance violation remediation - parentProjectNumber: + description: >- + Output only. List of all the exception detail added for the + violation. + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext + acknowledged: + description: A boolean that indicates if the violation is acknowledged + type: boolean + resourceType: readOnly: true description: >- - Optional. Output only. Parent project number where resource is - present. Empty for org-policy violations. + Optional. Output only. Type of the resource like + compute.googleapis.com/Disk, etc. Empty for org-policy violations. + type: string + orgPolicyConstraint: type: string - auditLogLink: readOnly: true + deprecated: true + description: >- + Output only. Immutable. The org-policy-constraint that was + incorrectly changed, which resulted in this violation. + auditLogLink: type: string + readOnly: true description: >- Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} - violationType: - description: Output only. Type of the violation - enum: - - VIOLATION_TYPE_UNSPECIFIED - - ORG_POLICY - - RESOURCE + associatedOrgPolicyViolationId: + type: string + description: >- + Optional. Output only. Violation Id of the org-policy violation due + to which the resource violation is caused. Empty for org-policy + violations. readOnly: true + parentProjectNumber: type: string - enumDescriptions: - - Unspecified type. - - Org Policy Violation. - - Resource Violation. + readOnly: true + description: >- + Optional. Output only. Parent project number where resource is + present. Empty for org-policy violations. id: GoogleCloudAssuredworkloadsV1Violation - description: Workload monitoring Violation. - GoogleCloudAssuredworkloadsV1MoveAnalysisResult: - id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult - description: Represents the successful move analysis results for a group. type: object + description: Workload monitoring Violation. + GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: properties: - blockers: - description: >- - List of blockers. If not resolved, these will result in compliance - violations in the target. - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' - type: array - warnings: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' - description: >- - List of warnings. These are risks that may or may not result in - compliance violations. - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - properties: - steps: - type: array - description: Steps to resolve violation via gcloud cli - items: - type: string - gcloudCommands: - type: array - description: Gcloud command to resolve violation - items: - type: string - additionalLinks: + setupErrors: type: array - description: Additional urls for more information about steps + description: Indicates SAA enrollment setup error if any. items: + enumDescriptions: + - Unspecified. + - >- + Invalid states for all customers, to be redirected to AA UI for + additional details. + - Returned when there is not an EKM key configured. + - >- + Returned when there are no enrolled services or the customer is + enrolled in CAA only for a subset of services. + - >- + Returned when exception was encountered during evaluation of + other criteria. type: string + enum: + - SETUP_ERROR_UNSPECIFIED + - ERROR_INVALID_BASE_SETUP + - ERROR_MISSING_EXTERNAL_SIGNING_KEY + - ERROR_NOT_ALL_SERVICES_ENROLLED + - ERROR_SETUP_CHECK_FAILED + setupStatus: + enumDescriptions: + - Unspecified. + - SAA enrollment pending. + - SAA enrollment comopleted. + description: Indicates SAA enrollment status of a given workload. + enum: + - SETUP_STATE_UNSPECIFIED + - STATUS_PENDING + - STATUS_COMPLETE + type: string type: object - description: Remediation instructions to resolve violation via gcloud cli - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - type: object - description: Instructions to remediate violation - properties: - gcloudInstructions: - description: Remediation instructions to resolve violation via gcloud cli - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - consoleInstructions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - description: Remediation instructions to resolve violation via cloud console + description: Signed Access Approvals (SAA) enrollment response. + id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata: - type: object - description: Operation metadata to give request details of CreateWorkload. - id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata properties: - parent: - description: Optional. The parent of the workload. - type: string - displayName: - description: Optional. The display name of the workload. - type: string complianceRegime: + type: string + description: >- + Optional. Compliance controls that should be applied to the + resources managed by the workload. enumDescriptions: - Unknown compliance regime. - Information protection as per DoD IL4 requirements. @@ -333,7 +478,6 @@ components: - Assured Workloads for Regional Controls - Healthcare and Life Science Controls - Healthcare and Life Science Controls with US Support - type: string enum: - COMPLIANCE_REGIME_UNSPECIFIED - IL4 @@ -358,124 +502,98 @@ components: - REGIONAL_CONTROLS - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT - description: >- - Optional. Compliance controls that should be applied to the - resources managed by the workload. - createTime: + displayName: type: string + description: Optional. The display name of the workload. + createTime: description: Optional. Time when the operation was created. format: google-datetime - GoogleLongrunningOperation: - id: GoogleLongrunningOperation + type: string + parent: + type: string + description: Optional. The parent of the workload. + type: object + id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata + description: Operation metadata to give request details of CreateWorkload. + GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: type: object + description: Request for acknowledging the violation + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest properties: - metadata: + comment: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + Required. Business justification explaining the need for violation + acknowledgement + type: string + acknowledgeType: + description: Optional. Acknowledge type of specified violation. + enumDescriptions: + - Acknowledge type unspecified. + - Acknowledge only the specific violation. + - >- + Acknowledge specified orgPolicy violation and also associated + resource violations. + enum: + - ACKNOWLEDGE_TYPE_UNSPECIFIED + - SINGLE_VIOLATION + - EXISTING_CHILD_RESOURCE_VIOLATIONS + type: string + nonCompliantOrgPolicy: + deprecated: true type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - response: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: + Optional. This field is deprecated and will be removed in future + version of the API. Name of the OrgPolicy which was modified with + non-compliant change and resulted in this violation. Format: + projects/{project_number}/policies/{constraint_name} + folders/{folder_id}/policies/{constraint_name} + organizations/{organization_id}/policies/{constraint_name} + GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: + description: Response for violation acknowledgement + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse + properties: {} type: object - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - description: Remediation instructions to resolve violation via cloud console - properties: - steps: - items: - type: string - type: array - description: Steps to resolve violation via cloud console - consoleUris: - description: Link to console page where violations can be resolved - type: array - items: - type: string - additionalLinks: - description: Additional urls for more information about steps - items: - type: string - type: array GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: - type: object description: Response for EnableResourceMonitoring endpoint. id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse properties: {} - GoogleCloudAssuredworkloadsV1Workload: - description: >- - A Workload object for managing highly regulated workloads of cloud - customers. - id: GoogleCloudAssuredworkloadsV1Workload + type: object + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: type: object properties: - saaEnrollmentResponse: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse - description: >- - Output only. Represents the SAA enrollment response of the given - workload. SAA enrollment response is queried during GetWorkload - call. In failure cases, user friendly error message is shown in SAA - details page. - resourceSettings: + restrictionType: + enumDescriptions: + - Unknown restriction type. + - >- + Allow the use all of all gcp products, irrespective of the + compliance posture. This effectively removes + gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder. + - >- + Based on Workload's compliance regime, allowed list changes. See - + https://cloud.google.com/assured-workloads/docs/supported-products + for the list of supported resources. + - >- + Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of + compliant resources to the existing list of compliant resources. + Effective org-policy of the Folder is considered to ensure there + is no disruption to the existing customer workflows. description: >- - Input only. Resource properties that are used to customize workload - resources. These properties (such as custom project id) will be used - to create workload resources if possible. This field is optional. - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings - type: array - partner: + Required. The type of restriction for using gcp products in the + Workload environment. enum: - - PARTNER_UNSPECIFIED - - LOCAL_CONTROLS_BY_S3NS - - SOVEREIGN_CONTROLS_BY_T_SYSTEMS - - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT - - SOVEREIGN_CONTROLS_BY_PSN - - SOVEREIGN_CONTROLS_BY_CNTXT - - SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM + - RESTRICTION_TYPE_UNSPECIFIED + - ALLOW_ALL_GCP_RESOURCES + - ALLOW_COMPLIANT_RESOURCES + - APPEND_COMPLIANT_RESOURCES type: string - description: Optional. Partner regime associated with this workload. + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + description: >- + Request for restricting list of available resources in Workload + environment. + GoogleCloudAssuredworkloadsV1Workload: + id: GoogleCloudAssuredworkloadsV1Workload + properties: + partner: enumDescriptions: - '' - Enum representing S3NS (Thales) partner. @@ -486,11 +604,32 @@ components: - >- Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering without EKM. + enum: + - PARTNER_UNSPECIFIED + - LOCAL_CONTROLS_BY_S3NS + - SOVEREIGN_CONTROLS_BY_T_SYSTEMS + - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT + - SOVEREIGN_CONTROLS_BY_PSN + - SOVEREIGN_CONTROLS_BY_CNTXT + - SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM + description: Optional. Partner regime associated with this workload. + type: string + partnerPermissions: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + description: >- + Optional. Permissions granted to the AW Partner SA account for the + customer workload createTime: - description: Output only. Immutable. The Workload creation timestamp. readOnly: true - format: google-datetime type: string + description: Output only. Immutable. The Workload creation timestamp. + format: google-datetime + labels: + type: object + description: Optional. Labels applied to the workload. + additionalProperties: + type: string resources: items: $ref: >- @@ -500,76 +639,36 @@ components: resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only. - type: array readOnly: true - displayName: - description: >- - Required. The user-assigned display name of the Workload. When - present it must be between 4 to 30 characters. Allowed characters - are: lowercase and uppercase letters, numbers, hyphen, and spaces. - Example: My Workload - type: string + type: array kmsSettings: deprecated: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings description: >- Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. + ekmProvisioningResponse: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings - partnerServicesBillingAccount: - type: string - description: >- - Optional. Billing account necessary for purchasing services from - Sovereign Partners. This field is required for creating - SIA/PSN/CNTXT partner workloads. The caller should have - 'billing.resourceAssociations.create' IAM permission on this - billing-account. The format of this string is - billingAccounts/AAAAAA-BBBBBB-CCCCCC - complianceStatus: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - description: Output only. Count of active Violations in the Workload. - readOnly: true - resourceMonitoringEnabled: - readOnly: true - type: boolean - description: >- - Output only. Indicates whether resource monitoring is enabled for - workload or not. It is true when Resource feed is subscribed to AWM - topic and AWM Service Agent Role is binded to AW Service Account for - resource Assured workload. - kajEnrollmentState: - enumDescriptions: - - Default State for KAJ Enrollment. - - Pending State for KAJ Enrollment. - - Complete State for KAJ Enrollment. + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse description: >- - Output only. Represents the KAJ enrollment state of the given + Output only. Represents the Ekm Provisioning State of the given workload. readOnly: true - type: string - enum: - - KAJ_ENROLLMENT_STATE_UNSPECIFIED - - KAJ_ENROLLMENT_STATE_PENDING - - KAJ_ENROLLMENT_STATE_COMPLETE - violationNotificationsEnabled: - type: boolean - description: >- - Optional. Indicates whether the e-mail notification for a violation - is enabled for a workload. This value will be by default True, and - if not present will be considered as true. This should only be - updated via updateWorkload call. Any Changes to this field during - the createWorkload call will not be honored. This will always be - true while creating the workload. - enableSovereignControls: - type: boolean + resourceSettings: + type: array description: >- - Optional. Indicates the sovereignty status of the given workload. - Currently meant to be used by Europe/Canada customers. + Input only. Resource properties that are used to customize workload + resources. These properties (such as custom project id) will be used + to create workload resources if possible. This field is optional. + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings billingAccount: + type: string description: >- Optional. The billing account used for the resources which are direct children of workload. This billing account is initially @@ -578,13 +677,45 @@ components: change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. - type: string - etag: + resourceMonitoringEnabled: + type: boolean + readOnly: true description: >- - Optional. ETag of the workload, it is calculated on the basis of the - Workload contents. It will be used in Update & Delete operations. - type: string - complianceRegime: + Output only. Indicates whether resource monitoring is enabled for + workload or not. It is true when Resource feed is subscribed to AWM + topic and AWM Service Agent Role is binded to AW Service Account for + resource Assured workload. + saaEnrollmentResponse: + readOnly: true + description: >- + Output only. Represents the SAA enrollment response of the given + workload. SAA enrollment response is queried during GetWorkload + call. In failure cases, user friendly error message is shown in SAA + details page. + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + compliantButDisallowedServices: + items: + type: string + readOnly: true + type: array + description: >- + Output only. Urls for services which are compliant for this Assured + Workload, but which are currently disallowed by the + ResourceUsageRestriction org policy. Invoke RestrictAllowedResources + endpoint to allow your project developers to use these services in + their environment. + displayName: + description: >- + Required. The user-assigned display name of the Workload. When + present it must be between 4 to 30 characters. Allowed characters + are: lowercase and uppercase letters, numbers, hyphen, and spaces. + Example: My Workload + type: string + complianceRegime: + description: >- + Required. Immutable. Compliance Regime associated with this + workload. enumDescriptions: - Unknown compliance regime. - Information protection as per DoD IL4 requirements. @@ -634,386 +765,203 @@ components: - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT type: string + enableSovereignControls: description: >- - Required. Immutable. Compliance Regime associated with this - workload. - partnerPermissions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + Optional. Indicates the sovereignty status of the given workload. + Currently meant to be used by Europe/Canada customers. + type: boolean + kajEnrollmentState: + enumDescriptions: + - Default State for KAJ Enrollment. + - Pending State for KAJ Enrollment. + - Complete State for KAJ Enrollment. + readOnly: true + enum: + - KAJ_ENROLLMENT_STATE_UNSPECIFIED + - KAJ_ENROLLMENT_STATE_PENDING + - KAJ_ENROLLMENT_STATE_COMPLETE description: >- - Optional. Permissions granted to the AW Partner SA account for the - customer workload - compliantButDisallowedServices: - items: - type: string + Output only. Represents the KAJ enrollment state of the given + workload. + type: string + etag: + type: string description: >- - Output only. Urls for services which are compliant for this Assured - Workload, but which are currently disallowed by the - ResourceUsageRestriction org policy. Invoke RestrictAllowedResources - endpoint to allow your project developers to use these services in - their environment. - type: array + Optional. ETag of the workload, it is calculated on the basis of the + Workload contents. It will be used in Update & Delete operations. + complianceStatus: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus readOnly: true + description: Output only. Count of active Violations in the Workload. + violationNotificationsEnabled: + description: >- + Optional. Indicates whether the e-mail notification for a violation + is enabled for a workload. This value will be by default True, and + if not present will be considered as true. This should only be + updated via updateWorkload call. Any Changes to this field during + the createWorkload call will not be honored. This will always be + true while creating the workload. + type: boolean provisionedResourcesParent: - type: string description: >- Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} - labels: - type: object - description: Optional. Labels applied to the workload. - additionalProperties: - type: string - ekmProvisioningResponse: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse - description: >- - Output only. Represents the Ekm Provisioning State of the given - workload. + type: string name: + type: string description: >- Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. + partnerServicesBillingAccount: type: string - GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: - description: Signed Access Approvals (SAA) enrollment response. - id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + description: >- + Optional. Billing account necessary for purchasing services from + Sovereign Partners. This field is required for creating + SIA/PSN/CNTXT partner workloads. The caller should have + 'billing.resourceAssociations.create' IAM permission on this + billing-account. The format of this string is + billingAccounts/AAAAAA-BBBBBB-CCCCCC + description: >- + A Workload object for managing highly regulated workloads of cloud + customers. + type: object + GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: + id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + type: object + description: >- + Represents a logical group of checks performed for an asset. If + successful, the group contains the analysis result, otherwise it + contains an error with the failure reason. properties: - setupStatus: - description: Indicates SAA enrollment status of a given workload. - enumDescriptions: - - Unspecified. - - SAA enrollment pending. - - SAA enrollment comopleted. - enum: - - SETUP_STATE_UNSPECIFIED - - STATUS_PENDING - - STATUS_COMPLETE + analysisResult: + description: Result of a successful analysis. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' + displayName: type: string - setupErrors: - description: Indicates SAA enrollment setup error if any. + description: Name of the analysis group. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Error details for a failed analysis. + GoogleCloudAssuredworkloadsV1MoveAnalysisResult: + id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult + description: Represents the successful move analysis results for a group. + properties: + blockers: + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' + description: >- + List of blockers. If not resolved, these will result in compliance + violations in the target. type: array + warnings: items: - type: string - enum: - - SETUP_ERROR_UNSPECIFIED - - ERROR_INVALID_BASE_SETUP - - ERROR_MISSING_EXTERNAL_SIGNING_KEY - - ERROR_NOT_ALL_SERVICES_ENROLLED - - ERROR_SETUP_CHECK_FAILED - enumDescriptions: - - Unspecified. - - >- - Invalid states for all customers, to be redirected to AA UI for - additional details. - - Returned when there is not an EKM key configured. - - >- - Returned when there are no enrolled services or the customer is - enrolled in CAA only for a subset of services. - - >- - Returned when exception was encountered during evaluation of - other criteria. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' + type: array + description: >- + List of warnings. These are risks that may or may not result in + compliance violations. type: object - GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: - description: Settings specific to the Key Management Service. - id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings - deprecated: true + GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: properties: - nextRotationTime: + asset: description: >- - Required. Input only. Immutable. The time at which the Key - Management Service will automatically create a new version of the - crypto key and mark it as the primary. - format: google-datetime + The full resource name of the asset being analyzed. Example: + //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 type: string - rotationPeriod: - format: google-duration + assetType: description: >- - Required. Input only. Immutable. [next_rotation_time] will be - advanced by this period when the Key Management Service - automatically rotates a key. Must be at least 24 hours and at most - 876,000 hours. + Type of the asset being analyzed. Possible values will be among the + ones listed + [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). type: string + analysisGroups: + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + description: List of eligible analyses performed for the asset. + type: array + type: object + description: Represents move analysis results for an asset. + id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis + GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: + description: Request for updating permission settings for a partner workload. + id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest type: object - GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: properties: - resourceId: + updateMask: type: string description: >- - Resource identifier. For a project this represents project_id. If - the project is already taken, the workload creation will fail. For - KeyRing, this represents the keyring_id. For a folder, don't set - this value as folder_id is assigned by Google. - displayName: - type: string + Required. The list of fields to be updated. E.g. update_mask { + paths: "partner_permissions.data_logs_viewer"} + format: google-fieldmask + partnerPermissions: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + description: Required. The partner permissions to be updated. + etag: description: >- - User-assigned resource display name. If not empty it will be used to - create a resource with the specified name. - resourceType: - enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING - enumDeprecated: - - false - - true - - false - - false - - false + Optional. The etag of the workload. If this is provided, it must + match the server's etag. type: string - enumDescriptions: - - Unknown resource type. - - >- - Deprecated. Existing workloads will continue to support this, but - new CreateWorkloadRequests should not specify this as an input - value. - - Consumer Folder. - - Consumer project containing encryption keys. - - Keyring resource that hosts encryption keys. - description: >- - Indicates the type of resource. This field should be specified to - correspond the id to the right project type (CONSUMER_PROJECT or - ENCRYPTION_KEYS_PROJECT) - id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings - type: object - description: Represent the custom settings for the resources to be created. - GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: - type: object - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse - description: Response for violation acknowledgement - properties: {} - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: - properties: - restrictionType: - description: >- - Required. The type of restriction for using gcp products in the - Workload environment. - type: string - enum: - - RESTRICTION_TYPE_UNSPECIFIED - - ALLOW_ALL_GCP_RESOURCES - - ALLOW_COMPLIANT_RESOURCES - - APPEND_COMPLIANT_RESOURCES - enumDescriptions: - - Unknown restriction type. - - >- - Allow the use all of all gcp products, irrespective of the - compliance posture. This effectively removes - gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder. - - >- - Based on Workload's compliance regime, allowed list changes. See - - https://cloud.google.com/assured-workloads/docs/supported-products - for the list of supported resources. - - >- - Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of - compliant resources to the existing list of compliant resources. - Effective org-policy of the Folder is considered to ensure there - is no disruption to the existing customer workflows. - type: object - description: >- - Request for restricting list of available resources in Workload - environment. - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest - GoogleCloudAssuredworkloadsV1ListViolationsResponse: - description: Response of ListViolations endpoint. + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: properties: - violations: - description: List of Violations under a Workload. - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + additionalLinks: type: array - nextPageToken: - type: string - description: The next page token. Returns empty if reached the last page. - id: GoogleCloudAssuredworkloadsV1ListViolationsResponse - type: object - GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: - description: >- - Response containing the analysis results for the hypothetical resource - move. - properties: - nextPageToken: - description: The next page token. Is empty if the last page is reached. - type: string - assetMoveAnalyses: - description: List of analysis results for each asset in scope. items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis + type: string + description: Additional urls for more information about steps + steps: type: array - id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse - type: object - GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: - description: Represents move analysis results for an asset. - properties: - asset: - type: string - description: >- - The full resource name of the asset being analyzed. Example: - //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 - analysisGroups: + description: Steps to resolve violation via gcloud cli items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - description: List of eligible analyses performed for the asset. + type: string + gcloudCommands: + description: Gcloud command to resolve violation type: array - assetType: - description: >- - Type of the asset being analyzed. Possible values will be among the - ones listed - [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). - type: string - type: object - id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis - GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: - properties: - assuredWorkloadsMonitoring: - type: boolean - description: Optional. Allow partner to view violation alerts. - serviceAccessApprover: - type: boolean - description: Optional. Allow partner to view access approval logs. - dataLogsViewer: - description: >- - Allow the partner to view inspectability logs and monitoring - violations. - type: boolean - accessTransparencyLogsSupportCaseViewer: - type: boolean - description: Optional. Allow partner to view support case details for an AXT log - description: >- - Permissions granted to the AW Partner SA account for the customer - workload - id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - type: object - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse - description: Response for restricting the list of allowed resources. - properties: {} - type: object - GoogleCloudAssuredworkloadsV1MoveImpact: - properties: - detail: - type: string - description: Explanation of the impact. - description: Represents the impact of moving the asset to the target. - id: GoogleCloudAssuredworkloadsV1MoveImpact - type: object - GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: - type: object - description: Represents the Compliance Status of this workload - id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - properties: - activeResourceViolationCount: - description: Number of current resource violations which are acknowledged. - type: integer - format: int32 - acknowledgedViolationCount: - format: int32 - description: Number of current orgPolicy violations which are acknowledged. - type: integer - activeViolationCount: - type: integer - description: Number of current orgPolicy violations which are not acknowledged. - format: int32 - acknowledgedResourceViolationCount: - format: int32 - type: integer - description: Number of current resource violations which are not acknowledged. - GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: - properties: - ekmProvisioningErrorMapping: - enumDescriptions: - - Error is unspecified. - - Service account is used is invalid. - - Iam permission monitoring.MetricsScopeAdmin wasn't applied. - - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. - type: string - description: Detailed error message if Ekm provisioning fails - enum: - - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED - - INVALID_SERVICE_ACCOUNT - - MISSING_METRICS_SCOPE_ADMIN_PERMISSION - - MISSING_EKM_CONNECTION_ADMIN_PERMISSION - ekmProvisioningState: - enum: - - EKM_PROVISIONING_STATE_UNSPECIFIED - - EKM_PROVISIONING_STATE_PENDING - - EKM_PROVISIONING_STATE_FAILED - - EKM_PROVISIONING_STATE_COMPLETED - type: string - description: Indicates Ekm enrollment Provisioning of a given workload. - enumDescriptions: - - Default State for Ekm Provisioning - - Pending State for Ekm Provisioning - - Failed State for Ekm Provisioning - - Completed State for Ekm Provisioning - ekmProvisioningErrorDomain: - enumDescriptions: - - No error domain - - Error but domain is unspecified. - - Internal logic breaks within provisioning code. - - >- - Error occurred with the customer not granting permission/creating - resource. - - Error occurred within the partner's provisioning cluster. - - Resource wasn't provisioned in the required 7 day time period - description: Indicates Ekm provisioning error if any. - enum: - - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED - - UNSPECIFIED_ERROR - - GOOGLE_SERVER_ERROR - - EXTERNAL_USER_ERROR - - EXTERNAL_PARTNER_ERROR - - TIMEOUT_ERROR - type: string + items: + type: string + description: Remediation instructions to resolve violation via gcloud cli type: object - id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse - description: External key management systems(EKM) Provisioning response - GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: - id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: type: object properties: - nextPageToken: - description: The next page token. Return empty if reached the last page. - type: string - workloads: - description: List of Workloads under a given parent. + additionalLinks: + type: array items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + type: string + description: Additional urls for more information about steps + steps: + items: + type: string type: array - description: Response of ListWorkloads endpoint. - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse - properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: + description: Steps to resolve violation via cloud console + consoleUris: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + type: string type: array - description: >- - A list of operations that matches the specified filter in the - request. - type: object - description: The response message for Operations.ListOperations. + description: Link to console page where violations can be resolved + description: Remediation instructions to resolve violation via cloud console + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole GoogleCloudAssuredworkloadsV1ViolationRemediation: properties: instructions: description: Required. Remediation instructions to resolve violations $ref: >- #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - remediationType: + compliantValues: description: >- - Output only. Reemediation type based on the type of org policy - values violated + Values that can resolve the violation For example: for list org + policy violations, this will either be the list of allowed or denied + values + items: + type: string + type: array + remediationType: enumDescriptions: - Unspecified remediation type - Remediation type for boolean org policy @@ -1028,6 +976,11 @@ components: - >- Remediation type for resource violation due to gcp.restrictNonCmekServices + readOnly: true + type: string + description: >- + Output only. Reemediation type based on the type of org policy + values violated enum: - REMEDIATION_TYPE_UNSPECIFIED - REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION @@ -1036,152 +989,177 @@ components: - REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION - REMEDIATION_RESOURCE_VIOLATION - REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES - type: string - readOnly: true - compliantValues: - description: >- - Values that can resolve the violation For example: for list org - policy violations, this will either be the list of allowed or denied - values - items: - type: string - type: array id: GoogleCloudAssuredworkloadsV1ViolationRemediation type: object description: >- Represents remediation guidance to resolve compliance violation for AssuredWorkload - GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: - type: object + GoogleCloudAssuredworkloadsV1MoveImpact: properties: - etag: - description: >- - Optional. The etag of the workload. If this is provided, it must - match the server's etag. - type: string - updateMask: + detail: + description: Explanation of the impact. type: string - description: >- - Required. The list of fields to be updated. E.g. update_mask { - paths: "partner_permissions.data_logs_viewer"} - format: google-fieldmask - partnerPermissions: - description: Required. The partner permissions to be updated. - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest - description: Request for updating permission settings for a partner workload. - GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: + id: GoogleCloudAssuredworkloadsV1MoveImpact + type: object + description: Represents the impact of moving the asset to the target. + GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: + type: object + id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo + description: Represent the resources that are children of this Workload. properties: - acknowledgeType: - enum: - - ACKNOWLEDGE_TYPE_UNSPECIFIED - - SINGLE_VIOLATION - - EXISTING_CHILD_RESOURCE_VIOLATIONS + resourceType: + description: Indicates the type of resource. type: string - description: Optional. Acknowledge type of specified violation. enumDescriptions: - - Acknowledge type unspecified. - - Acknowledge only the specific violation. + - Unknown resource type. - >- - Acknowledge specified orgPolicy violation and also associated - resource violations. - comment: - type: string - description: >- - Required. Business justification explaining the need for violation - acknowledgement - nonCompliantOrgPolicy: + Deprecated. Existing workloads will continue to support this, but + new CreateWorkloadRequests should not specify this as an input + value. + - Consumer Folder. + - Consumer project containing encryption keys. + - Keyring resource that hosts encryption keys. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - CONSUMER_PROJECT + - CONSUMER_FOLDER + - ENCRYPTION_KEYS_PROJECT + - KEYRING + enumDeprecated: + - false + - true + - false + - false + - false + resourceId: + format: int64 type: string - description: >- - Optional. This field is deprecated and will be removed in future - version of the API. Name of the OrgPolicy which was modified with - non-compliant change and resulted in this violation. Format: - projects/{project_number}/policies/{constraint_name} - folders/{folder_id}/policies/{constraint_name} - organizations/{organization_id}/policies/{constraint_name} - deprecated: true - description: Request for acknowledging the violation - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest - type: object - GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: + description: Resource identifier. For a project this represents project_number. + GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: + description: Represents the Compliance Status of this workload type: object + id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus properties: - analysisResult: - description: Result of a successful analysis. - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' - displayName: - type: string - description: Name of the analysis group. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Error details for a failed analysis. - id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - description: >- - Represents a logical group of checks performed for an asset. If - successful, the group contains the analysis result, otherwise it - contains an error with the failure reason. - GoogleCloudAssuredworkloadsV1ViolationExceptionContext: - properties: - comment: - type: string - description: >- - Business justification provided towards the acknowledgement of the - violation. - userName: - description: >- - Name of the user (or service account) who acknowledged the - violation. - type: string - acknowledgementTime: - format: google-datetime - description: Timestamp when the violation was acknowledged. - type: string - description: Violation exception detail. - type: object - id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext + activeViolationCount: + description: Number of current orgPolicy violations which are not acknowledged. + format: int32 + type: integer + acknowledgedViolationCount: + type: integer + description: Number of current orgPolicy violations which are acknowledged. + format: int32 + acknowledgedResourceViolationCount: + description: Number of current resource violations which are not acknowledged. + type: integer + format: int32 + activeResourceViolationCount: + type: integer + format: int32 + description: Number of current resource violations which are acknowledged. GoogleProtobufEmpty: - properties: {} type: object - id: GoogleProtobufEmpty 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); } - parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string + properties: {} + id: GoogleProtobufEmpty + GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: + type: object + id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + description: Response of ListWorkloads endpoint. + properties: + workloads: + type: array + description: List of Workloads under a given parent. + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + nextPageToken: + description: The next page token. Return empty if reached the last page. + type: string + GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: + type: object + id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + deprecated: true + properties: + rotationPeriod: + description: >- + Required. Input only. Immutable. [next_rotation_time] will be + advanced by this period when the Key Management Service + automatically rotates a key. Must be at least 24 hours and at most + 876,000 hours. + format: google-duration + type: string + nextRotationTime: + type: string + description: >- + Required. Input only. Immutable. The time at which the Key + Management Service will automatically create a new version of the + crypto key and mark it as the primary. + format: google-datetime + description: Settings specific to the Key Management Service. + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + name: + type: string + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + parameters: upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string quotaUser: @@ -1193,13 +1171,22 @@ components: name: quotaUser schema: 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. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: key + name: fields + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + callback: + description: JSONP + in: query + name: callback schema: type: string prettyPrint: @@ -1214,10 +1201,13 @@ components: name: oauth_token schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + 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. in: query - name: fields + name: key schema: type: string _.xgafv: @@ -1229,47 +1219,22 @@ components: enum: - '1' - '2' + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto x-stackQL-resources: - operations: - id: google.assuredworkloads.operations - name: operations - title: Operations - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] - replace: [] - delete: [] violations: id: google.assuredworkloads.violations name: violations title: Violations methods: - get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' acknowledge: operation: $ref: >- @@ -1285,6 +1250,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.violations + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/violations/methods/get' @@ -1298,13 +1270,6 @@ components: name: workloads title: Workloads methods: - restrict_allowed_resources: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:restrictAllowedResources/post - response: - mediaType: application/json - openAPIDocKey: '200' patch: operation: $ref: >- @@ -1312,17 +1277,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -1341,6 +1306,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.workloads + restrict_allowed_resources: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:restrictAllowedResources/post + response: + mediaType: application/json + openAPIDocKey: '200' enable_resource_monitoring: operation: $ref: >- @@ -1373,137 +1345,48 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/workloads/methods/delete' -paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/operations: - parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/_.xgafv' - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: assuredworkloads.organizations.locations.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 - 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. - operationId: assuredworkloads.organizations.locations.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: - parameters: *ref_1 - get: - description: Retrieves Assured Workload Violation based on ID. - operationId: assuredworkloads.organizations.locations.workloads.violations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: workloadsId - required: true - schema: - type: string - - in: path - name: violationsId - required: true - schema: - type: string + operations: + id: google.assuredworkloads.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge: - parameters: *ref_1 + parameters: &ref_1 + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' post: description: >- Acknowledges an existing violation. By acknowledging a violation, users @@ -1591,17 +1474,22 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: interval.endTime schema: type: string format: google-datetime - in: query - name: filter + name: interval.startTime schema: type: string + format: google-datetime - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -1609,29 +1497,11 @@ paths: schema: type: integer format: int32 - - in: query - name: interval.startTime - schema: - type: string - format: google-datetime - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: parameters: *ref_1 - post: - description: >- - Restrict the list of resources allowed in the Workload environment. The - current list of allowed products can be found at - https://cloud.google.com/assured-workloads/docs/supported-products In - addition to assuredworkloads.workload.update permission, the user should - also have orgpolicy.policy.set permission on the folder resource to use - this functionality. - operationId: >- - assuredworkloads.organizations.locations.workloads.restrictAllowedResources - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + get: + description: Retrieves Assured Workload Violation based on ID. + operationId: assuredworkloads.organizations.locations.workloads.violations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1643,8 +1513,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' parameters: - in: path name: organizationsId @@ -1661,6 +1530,11 @@ paths: required: true schema: type: string + - in: path + name: violationsId + required: true + schema: + type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}: parameters: *ref_1 patch: @@ -1707,15 +1581,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: >- - Deletes the workload. Make sure that workload's direct children are - already in a deleted state, otherwise the request will fail with a - FAILED_PRECONDITION error. In addition to - assuredworkloads.workload.delete permission, the user should also have - orgpolicy.policy.set permission on the deleted folder to remove Assured - Workloads OrgPolicies. - operationId: assuredworkloads.organizations.locations.workloads.delete + get: + description: Gets Assured Workload associated with a CRM Node + operationId: assuredworkloads.organizations.locations.workloads.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1727,7 +1595,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1744,13 +1612,15 @@ paths: required: true schema: type: string - - in: query - name: etag - schema: - type: string - get: - description: Gets Assured Workload associated with a CRM Node - operationId: assuredworkloads.organizations.locations.workloads.get + delete: + description: >- + Deletes the workload. Make sure that workload's direct children are + already in a deleted state, otherwise the request will fail with a + FAILED_PRECONDITION error. In addition to + assuredworkloads.workload.delete permission, the user should also have + orgpolicy.policy.set permission on the deleted folder to remove Assured + Workloads OrgPolicies. + operationId: assuredworkloads.organizations.locations.workloads.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1762,7 +1632,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -1779,6 +1649,10 @@ paths: required: true schema: type: string + - in: query + name: etag + schema: + type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads: parameters: *ref_1 post: @@ -1847,13 +1721,60 @@ paths: name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: + parameters: *ref_1 + post: + description: >- + Restrict the list of resources allowed in the Workload environment. The + current list of allowed products can be found at + https://cloud.google.com/assured-workloads/docs/supported-products In + addition to assuredworkloads.workload.update permission, the user should + also have orgpolicy.policy.set permission on the folder resource to use + this functionality. + operationId: >- + assuredworkloads.organizations.locations.workloads.restrictAllowedResources + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadsId + required: true schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring: @@ -1929,22 +1850,22 @@ paths: schema: type: string - in: query - name: project + name: assetTypes schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: assetTypes + name: project schema: type: string - in: query name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: parameters: *ref_1 patch: @@ -1988,3 +1909,82 @@ paths: required: true schema: type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: assuredworkloads.organizations.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: assuredworkloads.organizations.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml b/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml index fae80a6a..351705f8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/backup-disaster-recovery servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml b/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml index aa2c11ed..7275029b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml @@ -9,8 +9,8 @@ info: Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center. version: v2 - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bare-metal servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/batch.yaml b/providers/src/googleapis.com/v00.00.00000/services/batch.yaml index e31257ed..e9dd6089 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/batch.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/batch.yaml @@ -8,7 +8,7 @@ info: description: An API to manage the running of Batch resources on Google Cloud Platform. version: v1 x-discovery-doc-revision: '20240828' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/batch/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml b/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml index 757b4530..cacbb1c5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml @@ -12,7 +12,7 @@ info: solutions. version: v1 x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml b/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml index 41d3ebf2..6b5364b8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml @@ -11,7 +11,7 @@ info: used for querying Apache Iceberg tables in BigQuery. version: v1 x-discovery-doc-revision: '20240902' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bigquery/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml index 42db9c59..881dc5a9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml @@ -7,8 +7,8 @@ info: title: BigQuery API description: A data platform for customers to create, manage, share and query data. version: v2 - x-discovery-doc-revision: '20240803' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -1614,14 +1614,14 @@ components: additionalProperties: type: string description: >- - Optional. The [tags](/bigquery/docs/tags) attached to this dataset. - Tag keys are globally unique. Tag key is expected to be in the - namespaced format, for example "123456789012/environment" where - 123456789012 is the ID of the parent organization or project - resource for this tag key. Tag value is expected to be the short - name, for example "Production". See [Tag - definitions](/iam/docs/tags-access-control#definitions) for more - details. + Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) + attached to this dataset. Tag keys are globally unique. Tag key is + expected to be in the namespaced format, for example + "123456789012/environment" where 123456789012 is the ID of the + parent organization or project resource for this tag key. Tag value + is expected to be the short name, for example "Production". See [Tag + definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) + for more details. type: object restrictions: $ref: '#/components/schemas/RestrictionConfig' @@ -1629,8 +1629,8 @@ components: Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data - egress](/bigquery/docs/analytics-hub-introduction#data_egress) for - more details. + egress](https://cloud.google.com/bigquery/docs/analytics-hub-introduction#data_egress) + for more details. readOnly: true satisfiesPzi: description: Output only. Reserved for future use. @@ -3026,7 +3026,7 @@ components: HparamTuningTrial: description: >- Training info of a trial in [hyperparameter - tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) + tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models. id: HparamTuningTrial properties: @@ -3121,6 +3121,7 @@ components: - NOT_SUPPORTED_IN_STANDARD_EDITION - INDEX_SUPPRESSED_BY_FUNCTION_OPTION - QUERY_CACHE_HIT + - STALE_INDEX - INTERNAL_ERROR - OTHER_REASON enumDescriptions: @@ -3177,6 +3178,7 @@ components: - >- Indicates that the query was cached, and thus the search index was not used. + - The index cannot be used in the search query because it is stale. - >- Indicates an internal error that causes the search index to be unused. @@ -3317,9 +3319,8 @@ components: jobCreationReason: $ref: '#/components/schemas/JobCreationReason' description: >- - Output only. If set, it provides the reason why a Job was created. - If not set, it should be treated as the default: REQUESTED. This - feature is not yet available. Jobs will always be created. + Output only. The reason why a Job was created. + [Preview](https://cloud.google.com/products/#product-launch-stages) readOnly: true jobReference: $ref: '#/components/schemas/JobReference' @@ -4156,8 +4157,8 @@ components: [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) - method calls it will always be `REQUESTED`. This feature is not yet - available. Jobs will always be created. + method calls it will always be `REQUESTED`. + [Preview](https://cloud.google.com/products/#product-launch-stages) id: JobCreationReason properties: code: @@ -4650,88 +4651,88 @@ components: description: >- Output only. The type of query statement, if valid. Possible values: * `SELECT`: - [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) + [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: - [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) + [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: - [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) + [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: - [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) + [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: - [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) + [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: - [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) + [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE - TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) + TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS - SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) + SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE - VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) + VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE - MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) + MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED - VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) + VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE - FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) + FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE - FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) + FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE - PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) + PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS - POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) + POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE - SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) + SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT - TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) + TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH - INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) + INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP - TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) + TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL - TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) + TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP - VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) + VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP - MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) + MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED - VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) + VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP - FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) + FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE - FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) + FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP - PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) + PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH - INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) + INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP - SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) + SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT - TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) + TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS - POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) + POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER - TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) + TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER - VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) + VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED - VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) + VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER - SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) + SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: - [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). + [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE - TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) + TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL - TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) + TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT - DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) + DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT - MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) + MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD - DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) + DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: - [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) + [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. readOnly: true type: string @@ -5277,7 +5278,7 @@ components: hparamTrials: description: >- Output only. Trials of a [hyperparameter tuning - job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) + job](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id. items: $ref: '#/components/schemas/HparamTuningTrial' @@ -5287,7 +5288,7 @@ components: description: >- Results for all completed iterations. Empty for [hyperparameter tuning - jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview). + jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview). items: $ref: '#/components/schemas/IterationResult' type: array @@ -5368,7 +5369,7 @@ components: - Single training with fixed parameter space. - >- [Hyperparameter tuning - training](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview). + training](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview). readOnly: true type: string type: object @@ -5391,10 +5392,10 @@ components: description: >- Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter - tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) + tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter - tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) + tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials. format: int64 @@ -5442,7 +5443,7 @@ components: hparamTrials: description: >- Output only. Trials of a [hyperparameter - tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) + tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id. items: $ref: '#/components/schemas/HparamTuningTrial' @@ -5545,10 +5546,10 @@ components: optimalTrialIds: description: >- Output only. For single-objective [hyperparameter - tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) + tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter - tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) + tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id. items: format: int64 @@ -5604,7 +5605,7 @@ components: description: >- The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = - [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId + [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. format: int64 @@ -6062,8 +6063,8 @@ components: jobCreationMode: description: >- Optional. If not set, jobs are always required. If set, the query - request will follow the behavior described JobCreationMode. This - feature is not yet available. Jobs will always be created. + request will follow the behavior described JobCreationMode. + [Preview](https://cloud.google.com/products/#product-launch-stages) enum: - JOB_CREATION_MODE_UNSPECIFIED - JOB_CREATION_REQUIRED @@ -6229,12 +6230,10 @@ components: jobCreationReason: $ref: '#/components/schemas/JobCreationReason' description: >- - Optional. Only relevant when a job_reference is present in the - response. If job_reference is not present it will always be unset. - When job_reference is present, this field should be interpreted as - follows: If set, it will provide the reason of why a Job was - created. If not set, it should be treated as the default: REQUESTED. - This feature is not yet available. Jobs will always be created. + Optional. The reason why a Job was created. Only relevant when a + job_reference is present in the response. If job_reference is not + present it will always be unset. + [Preview](https://cloud.google.com/products/#product-launch-stages) jobReference: $ref: '#/components/schemas/JobReference' description: >- @@ -6243,7 +6242,9 @@ components: case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism - (GetQueryResults). + (GetQueryResults). If job_creation_mode was set to + `JOB_CREATION_OPTIONAL` and the query completes without creating a + job, this field will be empty. kind: default: bigquery#queryResponse description: The resource type. @@ -6266,9 +6267,8 @@ components: type: string queryId: description: >- - Query ID for the completed query. This ID will be auto-generated. - This field is not yet available and it is currently not guaranteed - to be populated. + Auto-generated ID for the query. + [Preview](https://cloud.google.com/products/#product-launch-stages) type: string rows: description: >- @@ -6552,8 +6552,8 @@ components: - Should never be used. - >- Restrict data egress. See [Data - egress](/bigquery/docs/analytics-hub-introduction#data_egress) for - more details. + egress](https://cloud.google.com/bigquery/docs/analytics-hub-introduction#data_egress) + for more details. readOnly: true type: string type: object @@ -7249,7 +7249,8 @@ components: "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", - "arrayElementType": {"typeKind": "DATE"} } } ] } } + "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { + "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } id: StandardSqlDataType properties: arrayElementType: @@ -7363,8 +7364,8 @@ components: locationUri: description: >- Optional. The physical location of the table (e.g. - 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or - 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is + `gs://spark-dataproc-data/pangea-data/case_sensitive/` or + `gs://spark-dataproc-data/pangea-data/*`). The maximum length is 2056 bytes. type: string outputFormat: @@ -7709,7 +7710,8 @@ components: description: >- Optional. Output only. Restriction config for table. If set, restrict certain accesses on the table based on the config. See - [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) + [Data + egress](https://cloud.google.com/bigquery/docs/analytics-hub-introduction#data_egress) for more details. readOnly: true schema: @@ -7757,8 +7759,8 @@ components: query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table - snapshots](/bigquery/docs/table-snapshots-intro). The default value - is `TABLE`. + snapshots](https://cloud.google.com/bigquery/docs/table-snapshots-intro). + The default value is `TABLE`. readOnly: true type: string view: @@ -8079,8 +8081,7 @@ components: Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * - BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE - ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT + BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. type: string type: object @@ -8196,7 +8197,7 @@ components: tableType: description: >- [Table - type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type). + type](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type). type: string unusedReason: description: Reason for not using metadata caching for the table. diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml index 67c2257b..12028395 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml @@ -7,8 +7,8 @@ info: title: BigQuery Connection API description: Allows users to manage BigQuery connections to external data sources. version: v1 - x-discovery-doc-revision: '20240803' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bigquery/docs/connections-api-intro servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml index b72dca78..e34843fd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml @@ -7,8 +7,8 @@ info: title: BigQuery Data Policy API description: Allows users to manage BigQuery data policies. version: v1 - x-discovery-doc-revision: '20240829' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bigquery/docs/column-data-masking servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml index c53241f7..e74dbd52 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml @@ -10,7 +10,7 @@ info: BigQuery on a regular basis. version: v1 x-discovery-doc-revision: '20240831' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bigquery-transfer/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml index cdc56fc0..f6d462fb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml @@ -7,8 +7,8 @@ info: title: BigQuery Reservation API description: A service to modify your BigQuery flat-rate reservations. version: v1 - x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bigquery/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml index cce9b4a9..72897465 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml @@ -7,8 +7,8 @@ info: title: Cloud Bigtable Admin API description: Administer your Cloud Bigtable tables and instances. version: v2 - x-discovery-doc-revision: '20240824' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/bigtable/ servers: @@ -537,6 +537,21 @@ components: type: array items: type: string + rowAffinity: + description: >- + Row affinity sticky routing based on the row key of the request. + Requests that span multiple rows are routed non-deterministically. + $ref: '#/components/schemas/RowAffinity' + RowAffinity: + id: RowAffinity + description: >- + If enabled, the AFE will route the request based on the row key of the + request, rather than randomly. Instead, each row key will be assigned to + a cluster, and will stick to that cluster. If clusters are added or + removed, then this may affect which row keys stick to which clusters. To + avoid this, users can specify a group cluster. + type: object + properties: {} SingleClusterRouting: id: SingleClusterRouting description: >- @@ -2132,6 +2147,34 @@ components: description: Output only. The encryption information for the backup. readOnly: true $ref: '#/components/schemas/EncryptionInfo' + backupType: + description: Indicates the backup type of the backup. + type: string + enumDescriptions: + - Not specified. + - >- + The default type for Cloud Bigtable managed backups. Supported for + backups created in both HDD and SSD instances. Requires + optimization when restored to a table in an SSD instance. + - >- + A backup type with faster restore to SSD performance. Only + supported for backups created in SSD instances. A new SSD table + restored from a hot backup reaches production performance more + quickly than a standard backup. + enum: + - BACKUP_TYPE_UNSPECIFIED + - STANDARD + - HOT + hotToStandardTime: + description: >- + The time at which the hot backup will be converted to a standard + backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable + will convert the hot backup to a standard backup. This value must be + greater than the backup creation time by: - At least 24 hours This + field only applies for hot backups. When creating or updating a + standard backup, attempting to set this field will fail the request. + type: string + format: google-datetime ListBackupsResponse: id: ListBackupsResponse description: The response for ListBackups. diff --git a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml index 8dc2aa7d..29e5f159 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml @@ -9,8 +9,8 @@ info: The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan. version: v1 - x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240914' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/billing/docs/how-to/budget-api-overview servers: @@ -24,10 +24,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/cloud-billing: View and manage your Google Cloud Platform billing accounts https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. - https://www.googleapis.com/auth/cloud-billing: View and manage your Google Cloud Platform billing accounts Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -37,28 +37,31 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleTypeDate: + GoogleTypeMoney: properties: - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - type: integer - month: + nanos: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. format: int32 type: integer - day: - type: integer + units: + type: string + format: int64 description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + id: GoogleTypeMoney type: object + description: Represents an amount of money with its currency type. + GoogleTypeDate: id: GoogleTypeDate description: >- Represents a whole or partial calendar date, such as a birthday. The @@ -70,59 +73,161 @@ components: * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - GoogleCloudBillingBudgetsV1Filter: - description: A filter for a budget, limiting the scope of the cost to calculate. - id: GoogleCloudBillingBudgetsV1Filter type: object properties: - calendarPeriod: - type: string - enumDescriptions: - - >- - Calendar period is unset. This is the default if the budget is for - a custom time period (CustomPeriod). - - >- - A month. Month starts on the first day of each month, such as - January 1, February 1, March 1, and so on. - - >- - A quarter. Quarters start on dates January 1, April 1, July 1, and - October 1 of each year. - - A year. Year starts on January 1. + year: + format: int32 description: >- - Optional. Specifies to track usage for recurring calendar period. - For example, assume that CalendarPeriod.QUARTER is set. The budget - tracks usage from April 1 to June 30, when the current calendar - month is April, May, June. After that, it tracks usage from July 1 - to September 30 when the current calendar month is July, August, - September, so on. - enum: - - CALENDAR_PERIOD_UNSPECIFIED - - MONTH - - QUARTER - - YEAR - projects: - type: array + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + type: integer + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + format: int32 + type: integer + GoogleCloudBillingBudgetsV1LastPeriodAmount: + properties: {} + type: object + id: GoogleCloudBillingBudgetsV1LastPeriodAmount + description: >- + Describes a budget amount targeted to the last Filter.calendar_period + spend. At this time, the amount is automatically 100% of the last + calendar period's spend; that is, there are no other options yet. + LastPeriodAmount cannot be set for a budget configured with a + Filter.custom_period. + GoogleCloudBillingBudgetsV1BudgetAmount: + id: GoogleCloudBillingBudgetsV1BudgetAmount + description: The budgeted amount for each usage period. + type: object + properties: + lastPeriodAmount: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' + description: >- + Use the last period's actual spend as the budget for the present + period. LastPeriodAmount can only be set when the budget's time + period is a Filter.calendar_period. It cannot be set in combination + with Filter.custom_period. + specifiedAmount: + description: >- + A specified amount to use as the budget. `currency_code` is + optional. If specified when creating a budget, it must match the + currency of the billing account. If specified when updating a + budget, it must match the currency_code of the existing budget. The + `currency_code` is provided on output. + $ref: '#/components/schemas/GoogleTypeMoney' + GoogleCloudBillingBudgetsV1NotificationsRule: + properties: + enableProjectLevelRecipients: + type: boolean + description: >- + Optional. When set to true, and when the budget has a single project + configured, notifications will be sent to project level recipients + of that project. This field will be ignored if the budget has + multiple or no project configured. Currently, project level + recipients are the users with `Owner` role on a cloud project. + monitoringNotificationChannels: + description: >- + Optional. Email targets to send notifications to when a threshold is + exceeded. This is in addition to the `DefaultIamRecipients` who + receive alert emails based on their billing account IAM role. The + value is the full REST resource name of a Cloud Monitoring email + notification channel with the form + `projects/{project_id}/notificationChannels/{channel_id}`. A maximum + of 5 email notifications are allowed. To customize budget alert + email recipients with monitoring notification channels, you _must + create the monitoring notification channels before you link them to + a budget_. For guidance on setting up notification channels to use + with budgets, see [Customize budget alert email + recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). + For Cloud Billing budget alerts, you _must use email notification + channels_. The other types of notification channels are _not_ + supported, such as Slack, SMS, or PagerDuty. If you want to [send + budget notifications to + Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), + use a pubsubTopic and configure [programmatic + notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). items: type: string + type: array + schemaVersion: description: >- - Optional. A set of projects of the form `projects/{project}`, - specifying that usage from only this set of projects should be - included in the budget. If omitted, the report includes all usage - for the billing account, regardless of which project the usage - occurred on. - labels: - type: object - additionalProperties: - type: array - items: - type: any + Optional. Required when NotificationsRule.pubsub_topic is set. The + schema version of the notification sent to + NotificationsRule.pubsub_topic. Only "1.0" is accepted. It + represents the JSON schema as defined in + https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + type: string + disableDefaultIamRecipients: + type: boolean description: >- - Optional. A single label and value pair specifying that usage from - only this set of labeled resources should be included in the budget. - If omitted, the report includes all labeled and unlabeled usage. An - object containing a single `"key": value` pair. Example: `{ "name": - "wrench" }`. _Currently, multiple entries or multiple values per - entry are not allowed._ + Optional. When set to true, disables default notifications sent when + a threshold is exceeded. Default notifications are sent to those + with Billing Account Administrator and Billing Account User IAM + roles for the target account. + pubsubTopic: + description: >- + Optional. The name of the Pub/Sub topic where budget-related + messages are published, in the form + `projects/{project_id}/topics/{topic_id}`. Updates are sent to the + topic at regular intervals; the timing of the updates is not + dependent on the [threshold rules](#thresholdrule) you've set. Note + that if you want your [Pub/Sub JSON + object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) + to contain data for `alertThresholdExceeded`, you need at least one + [alert threshold rule](#thresholdrule). When you set threshold + rules, you must also enable at least one of the email notification + options, either using the default IAM recipients or Cloud Monitoring + email notification channels. To use Pub/Sub topics with budgets, you + must do the following: 1. Create the Pub/Sub topic before connecting + it to your budget. For guidance, see [Manage programmatic budget + alert + notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission + on the Pub/Sub topic. If not set, the API call fails with + PERMISSION_DENIED. For additional details on Pub/Sub roles and + permissions, see [Permissions required for this + task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). + type: string + id: GoogleCloudBillingBudgetsV1NotificationsRule + type: object + description: >- + NotificationsRule defines notifications that are sent based on budget + spend and thresholds. + GoogleCloudBillingBudgetsV1ListBudgetsResponse: + description: Response for ListBudgets + id: GoogleCloudBillingBudgetsV1ListBudgetsResponse + properties: + budgets: + items: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + description: List of the budgets owned by the requested billing account. + type: array + nextPageToken: + type: string + description: >- + If not empty, indicates that there may be more budgets that match + the request; this value should be passed in a new + `ListBudgetsRequest`. + type: object + GoogleCloudBillingBudgetsV1Filter: + type: object + id: GoogleCloudBillingBudgetsV1Filter + properties: + customPeriod: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' + description: >- + Optional. Specifies to track usage from any start date (required) to + any end date (optional). This time period is static, it does not + recur. creditTypesTreatment: enumDescriptions: - '' @@ -138,12 +243,34 @@ components: specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations. type: string + description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. enum: - CREDIT_TYPES_TREATMENT_UNSPECIFIED - INCLUDE_ALL_CREDITS - EXCLUDE_ALL_CREDITS - INCLUDE_SPECIFIED_CREDITS - description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. + subaccounts: + items: + type: string + type: array + description: >- + Optional. A set of subaccounts of the form + `billingAccounts/{account_id}`, specifying that usage from only this + set of subaccounts should be included in the budget. If a subaccount + is set to the name of the parent account, usage from the parent + account is included. If the field is omitted, the report includes + usage from the parent account and all subaccounts, if they exist. + services: + items: + type: string + description: >- + Optional. A set of services of the form `services/{service_id}`, + specifying that usage from only this set of services should be + included in the budget. If omitted, the report includes usage for + all the services. The service names are available through the + Catalog API: + https://cloud.google.com/billing/v1/how-tos/catalog-api. + type: array creditTypes: type: array description: >- @@ -156,188 +283,88 @@ components: INCLUDE_SPECIFIED_CREDITS, this field must be empty. items: type: string - resourceAncestors: - description: >- - Optional. A set of folder and organization names of the form - `folders/{folderId}` or `organizations/{organizationId}`, specifying - that usage from only this set of folders and organizations should be - included in the budget. If omitted, the budget includes all usage - that the billing account pays for. If the folder or organization - contains projects that are paid for by a different Cloud Billing - account, the budget *doesn't* apply to those projects. - items: - type: string - type: array - subaccounts: + projects: description: >- - Optional. A set of subaccounts of the form - `billingAccounts/{account_id}`, specifying that usage from only this - set of subaccounts should be included in the budget. If a subaccount - is set to the name of the parent account, usage from the parent - account is included. If the field is omitted, the report includes - usage from the parent account and all subaccounts, if they exist. - type: array - items: - type: string - services: + Optional. A set of projects of the form `projects/{project}`, + specifying that usage from only this set of projects should be + included in the budget. If omitted, the report includes all usage + for the billing account, regardless of which project the usage + occurred on. type: array - description: >- - Optional. A set of services of the form `services/{service_id}`, - specifying that usage from only this set of services should be - included in the budget. If omitted, the report includes usage for - all the services. The service names are available through the - Catalog API: - https://cloud.google.com/billing/v1/how-tos/catalog-api. items: type: string - customPeriod: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' - description: >- - Optional. Specifies to track usage from any start date (required) to - any end date (optional). This time period is static, it does not - recur. - GoogleCloudBillingBudgetsV1ListBudgetsResponse: - description: Response for ListBudgets - id: GoogleCloudBillingBudgetsV1ListBudgetsResponse - type: object - properties: - nextPageToken: - description: >- - If not empty, indicates that there may be more budgets that match - the request; this value should be passed in a new - `ListBudgetsRequest`. - type: string - budgets: - items: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' - description: List of the budgets owned by the requested billing account. - type: array - GoogleCloudBillingBudgetsV1ThresholdRule: - description: >- - ThresholdRule contains the definition of a threshold. Threshold rules - define the triggering events used to generate a budget notification - email. When a threshold is crossed (spend exceeds the specified - percentages of the budget), budget alert emails are sent to the email - recipients you specify in the [NotificationsRule](#notificationsrule). - Threshold rules also affect the fields included in the [JSON data - object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) - sent to a Pub/Sub topic. Threshold rules are _required_ if using email - notifications. Threshold rules are _optional_ if only setting a - [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want - your JSON data object to include data about the thresholds you set. For - more information, see [set budget threshold rules and - actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). - type: object - properties: - thresholdPercent: - type: number - format: double - description: >- - Required. Send an alert when this threshold is exceeded. This is a - 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. - spendBasis: - enum: - - BASIS_UNSPECIFIED - - CURRENT_SPEND - - FORECASTED_SPEND + calendarPeriod: enumDescriptions: - - Unspecified threshold basis. - >- - Use current spend as the basis for comparison against the - threshold. + Calendar period is unset. This is the default if the budget is for + a custom time period (CustomPeriod). - >- - Use forecasted spend for the period as the basis for comparison - against the threshold. FORECASTED_SPEND can only be set when the - budget's time period is a Filter.calendar_period. It cannot be set - in combination with Filter.custom_period. - type: string - description: >- - Optional. The type of basis used to determine if spend has passed - the threshold. Behavior defaults to CURRENT_SPEND if not set. - id: GoogleCloudBillingBudgetsV1ThresholdRule - GoogleProtobufEmpty: - 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); } - type: object - properties: {} - id: GoogleProtobufEmpty - GoogleCloudBillingBudgetsV1CustomPeriod: - description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). - type: object - properties: - endDate: - $ref: '#/components/schemas/GoogleTypeDate' + A month. Month starts on the first day of each month, such as + January 1, February 1, March 1, and so on. + - >- + A quarter. Quarters start on dates January 1, April 1, July 1, and + October 1 of each year. + - A year. Year starts on January 1. description: >- - Optional. The end date of the time period. Budgets with elapsed end - date won't be processed. If unset, specifies to track all usage - incurred since the start_date. - startDate: - description: Required. The start date must be after January 1, 2017. - $ref: '#/components/schemas/GoogleTypeDate' - id: GoogleCloudBillingBudgetsV1CustomPeriod - GoogleTypeMoney: - description: Represents an amount of money with its currency type. - id: GoogleTypeMoney - properties: - currencyCode: + Optional. Specifies to track usage for recurring calendar period. + For example, assume that CalendarPeriod.QUARTER is set. The budget + tracks usage from April 1 to June 30, when the current calendar + month is April, May, June. After that, it tracks usage from July 1 + to September 30 when the current calendar month is July, August, + September, so on. type: string - description: The three-letter currency code defined in ISO 4217. - nanos: + enum: + - CALENDAR_PERIOD_UNSPECIFIED + - MONTH + - QUARTER + - YEAR + labels: description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - units: - type: string + Optional. A single label and value pair specifying that usage from + only this set of labeled resources should be included in the budget. + If omitted, the report includes all labeled and unlabeled usage. An + object containing a single `"key": value` pair. Example: `{ "name": + "wrench" }`. _Currently, multiple entries or multiple values per + entry are not allowed._ + type: object + additionalProperties: + type: array + items: + type: any + resourceAncestors: + items: + type: string + type: array description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - format: int64 - type: object - GoogleCloudBillingBudgetsV1LastPeriodAmount: - description: >- - Describes a budget amount targeted to the last Filter.calendar_period - spend. At this time, the amount is automatically 100% of the last - calendar period's spend; that is, there are no other options yet. - LastPeriodAmount cannot be set for a budget configured with a - Filter.custom_period. - type: object - properties: {} - id: GoogleCloudBillingBudgetsV1LastPeriodAmount - GoogleCloudBillingBudgetsV1BudgetAmount: + Optional. A set of folder and organization names of the form + `folders/{folderId}` or `organizations/{organizationId}`, specifying + that usage from only this set of folders and organizations should be + included in the budget. If omitted, the budget includes all usage + that the billing account pays for. If the folder or organization + contains projects that are paid for by a different Cloud Billing + account, the budget *doesn't* apply to those projects. + description: A filter for a budget, limiting the scope of the cost to calculate. + GoogleCloudBillingBudgetsV1Budget: properties: - specifiedAmount: - $ref: '#/components/schemas/GoogleTypeMoney' + etag: + type: string description: >- - A specified amount to use as the budget. `currency_code` is - optional. If specified when creating a budget, it must match the - currency of the billing account. If specified when updating a - budget, it must match the currency_code of the existing budget. The - `currency_code` is provided on output. - lastPeriodAmount: + Optional. Etag to validate that the object is unchanged for a + read-modify-write operation. An empty etag causes an update to + overwrite other changes. + name: + readOnly: true description: >- - Use the last period's actual spend as the budget for the present - period. LastPeriodAmount can only be set when the budget's time - period is a Filter.calendar_period. It cannot be set in combination - with Filter.custom_period. - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' - description: The budgeted amount for each usage period. - type: object - id: GoogleCloudBillingBudgetsV1BudgetAmount - GoogleCloudBillingBudgetsV1Budget: - id: GoogleCloudBillingBudgetsV1Budget - type: object - properties: + Output only. Resource name of the budget. The resource name implies + the scope of a budget. Values are of the form + `billingAccounts/{billingAccountId}/budgets/{budgetId}`. + type: string ownershipScope: type: string + enum: + - OWNERSHIP_SCOPE_UNSPECIFIED + - ALL_USERS + - BILLING_ACCOUNT enumDescriptions: - Unspecified ownership scope, same as ALL_USERS. - >- @@ -348,142 +375,119 @@ components: Only billing account-level users have full access to the budget. Project-level users have read-only access, even if they have the required IAM permissions. - enum: - - OWNERSHIP_SCOPE_UNSPECIFIED - - ALL_USERS - - BILLING_ACCOUNT - thresholdRules: - type: array - items: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1ThresholdRule' + budgetFilter: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Filter' description: >- - Optional. Rules that trigger alerts (notifications of thresholds - being crossed) when spend exceeds the specified percentages of the - budget. Optional for `pubsubTopic` notifications. Required if using - email notifications. + Optional. Filters that define which resources are used to compute + the actual spend against the budget amount, such as projects, + services, and the budget's time period, as well as other filters. + amount: + description: Required. Budgeted amount. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1BudgetAmount' notificationsRule: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' description: >- Optional. Rules to apply to notifications sent based on budget spend and thresholds. - name: - type: string - description: >- - Output only. Resource name of the budget. The resource name implies - the scope of a budget. Values are of the form - `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - readOnly: true + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' displayName: description: >- User data for display name in UI. The name must be less than or equal to 60 characters. type: string - budgetFilter: - description: >- - Optional. Filters that define which resources are used to compute - the actual spend against the budget amount, such as projects, - services, and the budget's time period, as well as other filters. - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Filter' - amount: - description: Required. Budgeted amount. - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1BudgetAmount' - etag: + thresholdRules: description: >- - Optional. Etag to validate that the object is unchanged for a - read-modify-write operation. An empty etag causes an update to - overwrite other changes. - type: string + Optional. Rules that trigger alerts (notifications of thresholds + being crossed) when spend exceeds the specified percentages of the + budget. Optional for `pubsubTopic` notifications. Required if using + email notifications. + items: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1ThresholdRule' + type: array + id: GoogleCloudBillingBudgetsV1Budget + type: object description: >- A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period. - GoogleCloudBillingBudgetsV1NotificationsRule: + GoogleCloudBillingBudgetsV1ThresholdRule: description: >- - NotificationsRule defines notifications that are sent based on budget - spend and thresholds. - properties: - pubsubTopic: - type: string - description: >- - Optional. The name of the Pub/Sub topic where budget-related - messages are published, in the form - `projects/{project_id}/topics/{topic_id}`. Updates are sent to the - topic at regular intervals; the timing of the updates is not - dependent on the [threshold rules](#thresholdrule) you've set. Note - that if you want your [Pub/Sub JSON - object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) - to contain data for `alertThresholdExceeded`, you need at least one - [alert threshold rule](#thresholdrule). When you set threshold - rules, you must also enable at least one of the email notification - options, either using the default IAM recipients or Cloud Monitoring - email notification channels. To use Pub/Sub topics with budgets, you - must do the following: 1. Create the Pub/Sub topic before connecting - it to your budget. For guidance, see [Manage programmatic budget - alert - notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). - 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission - on the Pub/Sub topic. If not set, the API call fails with - PERMISSION_DENIED. For additional details on Pub/Sub roles and - permissions, see [Permissions required for this - task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - disableDefaultIamRecipients: + ThresholdRule contains the definition of a threshold. Threshold rules + define the triggering events used to generate a budget notification + email. When a threshold is crossed (spend exceeds the specified + percentages of the budget), budget alert emails are sent to the email + recipients you specify in the [NotificationsRule](#notificationsrule). + Threshold rules also affect the fields included in the [JSON data + object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) + sent to a Pub/Sub topic. Threshold rules are _required_ if using email + notifications. Threshold rules are _optional_ if only setting a + [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want + your JSON data object to include data about the thresholds you set. For + more information, see [set budget threshold rules and + actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). + id: GoogleCloudBillingBudgetsV1ThresholdRule + properties: + thresholdPercent: description: >- - Optional. When set to true, disables default notifications sent when - a threshold is exceeded. Default notifications are sent to those - with Billing Account Administrator and Billing Account User IAM - roles for the target account. - type: boolean - enableProjectLevelRecipients: + Required. Send an alert when this threshold is exceeded. This is a + 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + type: number + format: double + spendBasis: + enum: + - BASIS_UNSPECIFIED + - CURRENT_SPEND + - FORECASTED_SPEND + enumDescriptions: + - Unspecified threshold basis. + - >- + Use current spend as the basis for comparison against the + threshold. + - >- + Use forecasted spend for the period as the basis for comparison + against the threshold. FORECASTED_SPEND can only be set when the + budget's time period is a Filter.calendar_period. It cannot be set + in combination with Filter.custom_period. description: >- - Optional. When set to true, and when the budget has a single project - configured, notifications will be sent to project level recipients - of that project. This field will be ignored if the budget has - multiple or no project configured. Currently, project level - recipients are the users with `Owner` role on a cloud project. - type: boolean - schemaVersion: + Optional. The type of basis used to determine if spend has passed + the threshold. Behavior defaults to CURRENT_SPEND if not set. type: string + type: object + GoogleCloudBillingBudgetsV1CustomPeriod: + description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). + type: object + properties: + endDate: description: >- - Optional. Required when NotificationsRule.pubsub_topic is set. The - schema version of the notification sent to - NotificationsRule.pubsub_topic. Only "1.0" is accepted. It - represents the JSON schema as defined in - https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. - monitoringNotificationChannels: - description: >- - Optional. Email targets to send notifications to when a threshold is - exceeded. This is in addition to the `DefaultIamRecipients` who - receive alert emails based on their billing account IAM role. The - value is the full REST resource name of a Cloud Monitoring email - notification channel with the form - `projects/{project_id}/notificationChannels/{channel_id}`. A maximum - of 5 email notifications are allowed. To customize budget alert - email recipients with monitoring notification channels, you _must - create the monitoring notification channels before you link them to - a budget_. For guidance on setting up notification channels to use - with budgets, see [Customize budget alert email - recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). - For Cloud Billing budget alerts, you _must use email notification - channels_. The other types of notification channels are _not_ - supported, such as Slack, SMS, or PagerDuty. If you want to [send - budget notifications to - Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), - use a pubsubTopic and configure [programmatic - notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). - items: - type: string - type: array - id: GoogleCloudBillingBudgetsV1NotificationsRule + Optional. The end date of the time period. Budgets with elapsed end + date won't be processed. If unset, specifies to track all usage + incurred since the start_date. + $ref: '#/components/schemas/GoogleTypeDate' + startDate: + $ref: '#/components/schemas/GoogleTypeDate' + description: Required. The start date must be after January 1, 2017. + id: GoogleCloudBillingBudgetsV1CustomPeriod + GoogleProtobufEmpty: type: object + properties: {} + 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: GoogleProtobufEmpty parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + alt: + description: Data format for response. in: query - name: uploadType + name: alt schema: type: string + enum: + - json + - media + - proto _.xgafv: description: V1 error format. in: query @@ -493,52 +497,51 @@ components: enum: - '1' - '2' - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol schema: type: string - alt: - description: Data format for response. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: alt + name: fields schema: type: string - enum: - - json - - media - - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: upload_protocol + name: quotaUser schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: prettyPrint + name: oauth_token schema: - type: boolean - access_token: - description: OAuth access token. + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: access_token + name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + callback: + description: JSONP in: query - name: fields + name: callback schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: oauth_token + name: prettyPrint schema: - type: string + type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -548,13 +551,10 @@ components: name: key schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token schema: type: string x-stackQL-resources: @@ -563,24 +563,24 @@ components: name: budgets title: Budgets methods: - patch: + get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/patch + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/delete + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -611,29 +611,24 @@ components: paths: /v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' - patch: + - $ref: '#/components/parameters/access_token' + get: description: >- - Updates a budget and returns the updated budget. WARNING: There are some - fields exposed on the Google Cloud Console that aren't available on this - API. Budget fields that are not exposed in this API will not be changed - by this method. - operationId: billingbudgets.billingAccounts.budgets.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + Returns a budget. WARNING: There are some fields exposed on the Google + Cloud Console that aren't available on this API. When reading from the + API, you will not see these fields in the return value, though they may + have been set in the Cloud Console. + operationId: billingbudgets.billingAccounts.budgets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -661,18 +656,9 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: >- - Returns a budget. WARNING: There are some fields exposed on the Google - Cloud Console that aren't available on this API. When reading from the - API, you will not see these fields in the return value, though they may - have been set in the Cloud Console. - operationId: billingbudgets.billingAccounts.budgets.get + delete: + description: Deletes a budget. Returns successfully if already deleted. + operationId: billingbudgets.billingAccounts.budgets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -688,7 +674,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: billingAccountsId @@ -700,9 +686,18 @@ paths: required: true schema: type: string - delete: - description: Deletes a budget. Returns successfully if already deleted. - operationId: billingbudgets.billingAccounts.budgets.delete + patch: + description: >- + Updates a budget and returns the updated budget. WARNING: There are some + fields exposed on the Google Cloud Console that aren't available on this + API. Budget fields that are not exposed in this API will not be changed + by this method. + operationId: billingbudgets.billingAccounts.budgets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -718,7 +713,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' parameters: - in: path name: billingAccountsId @@ -730,6 +725,11 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask /v1/billingAccounts/{billingAccountsId}/budgets: parameters: *ref_1 get: @@ -762,15 +762,15 @@ paths: required: true schema: type: string - - in: query - name: scope - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: scope + schema: + type: string - in: query name: pageToken schema: diff --git a/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml b/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml index 9c585f70..9e3c8101 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml @@ -12,7 +12,7 @@ info: Run. version: v1 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/binary-authorization/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml index 6b19130c..a84cc2b2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml @@ -7,8 +7,8 @@ info: title: Blockchain Node Engine API description: '' version: v1 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240911' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/blockchain-node-engine servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml index 7e24294a..1c5b2246 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml @@ -7,8 +7,8 @@ info: title: Certificate Manager API description: '' version: v1 - x-discovery-doc-revision: '20240821' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/certificate-manager servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml index a16864a3..d984f687 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml @@ -9,8 +9,8 @@ info: The Cloud Asset API manages the history and inventory of Google Cloud resources. version: v1 - x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240913' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/asset-inventory/docs/quickstart servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml index 35fc3c80..3d07215d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml @@ -9,8 +9,8 @@ info: Allows developers to manage billing for their Google Cloud Platform projects programmatically. version: v1 - x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/billing/docs/apis servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml index b5bbc011..38ca8fcb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml @@ -7,8 +7,8 @@ info: title: Cloud Build API description: Creates and manages builds on Google Cloud Platform. version: v2 - x-discovery-doc-revision: '20240903' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/cloud-build/docs/ servers: @@ -34,209 +34,108 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - TimeoutFields: + SecretVolumeSource: type: object + description: Secret Volume Source. properties: - finally: - description: Finally sets the maximum allowed duration of this pipeline's finally - type: string - format: google-duration - pipeline: + secretVersion: type: string description: >- - Pipeline sets the maximum allowed duration for execution of the - entire pipeline. The sum of individual timeouts for tasks and - finally must not exceed this value. - format: google-duration - tasks: + Optional. Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* + secretName: type: string - format: google-duration - description: Tasks sets the maximum allowed duration of this pipeline's tasks - id: TimeoutFields - description: >- - TimeoutFields allows granular specification of pipeline, task, and - finally timeouts - TaskRef: - type: object - id: TaskRef + description: Name of the secret referenced by the WorkspaceBinding. + id: SecretVolumeSource + Worker: + id: Worker properties: - resolver: - description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT - type: string - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. - name: + machineType: + description: Optional. Machine type of a worker, default is "e2-standard-2". type: string - description: Optional. Name of the task. + description: Configuration for the worker. + type: object + PipelineTask: + properties: params: - type: array items: $ref: '#/components/schemas/Param' + type: array + description: Params is a list of parameter names and values. + timeout: description: >- - Params contains the parameters used to identify the referenced - Tekton resource. Example entries might include "repo" or "path" but - the set of params ultimately depends on the chosen resolver. - description: >- - TaskRef can be used to refer to a specific instance of a task. - PipelineRef can be used to refer to a specific instance of a Pipeline. - CreateRepositoryRequest: - description: Message for creating a Repository. - type: object - properties: - repositoryId: - description: >- - Required. The ID to use for the repository, which will become the - final component of the repository's resource name. This ID should be - unique in the connection. Allows alphanumeric characters and any of - -._~%!$&'()*+,;=@. - type: string - repository: - description: Required. The repository to create. - $ref: '#/components/schemas/Repository' - parent: - type: string - description: >- - Required. The connection to contain the repository. If the request - is part of a BatchCreateRepositoriesRequest, this field should be - empty or match the parent specified there. - id: CreateRepositoryRequest - OAuthCredential: - properties: - username: - type: string - description: Output only. The username associated to this token. - readOnly: true - oauthTokenSecretVersion: - description: >- - Optional. A SecretManager resource containing the OAuth token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. - type: string - description: >- - Represents an OAuth token of the account that authorized the Connection, - and associated metadata. - type: object - id: OAuthCredential - BitbucketCloudConfig: - id: BitbucketCloudConfig - properties: - authorizerCredential: - description: >- - Required. An access token with the `webhook`, `repository`, - `repository:admin` and `pullrequest` scope access. It can be either - a workspace, project or repository access token. It's recommended to - use a system account to generate these credentials. - $ref: '#/components/schemas/UserCredential' - webhookSecretSecretVersion: - type: string - description: >- - Required. SecretManager resource containing the webhook secret used - to verify webhook events, formatted as - `projects/*/secrets/*/versions/*`. - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: >- - Required. An access token with the `repository` access. It can be - either a workspace, project or repository access token. It's - recommended to use a system account to generate the credentials. - workspace: - type: string - description: >- - Required. The Bitbucket Cloud Workspace ID to be connected to Google - Cloud Platform. - description: Configuration for connections to Bitbucket Cloud. - type: object - ParamSpec: - type: object - description: >- - ParamSpec defines parameters needed beyond typed inputs (such as - resources). Parameter values are provided by users as inputs on a - TaskRun or PipelineRun. - properties: - type: - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type. - - Object type. - type: string - description: Type of ParamSpec - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - default: - $ref: '#/components/schemas/ParamValue' - description: The default value a parameter takes if no input value is supplied - description: - description: Description of the ParamSpec + Time after which the TaskRun times out. Defaults to 1 hour. + Specified TaskRun timeout should be less than 24h. + format: google-duration type: string name: type: string - description: Name of the ParamSpec - id: ParamSpec - TestIamPermissionsRequest: - type: object - description: Request message for `TestIamPermissions` method. - properties: - permissions: - items: - type: string + description: Name of the task. + runAfter: type: array 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). - id: TestIamPermissionsRequest - Capabilities: - properties: - add: - type: array + RunAfter is the list of PipelineTask names that should be executed + before this Task executes. (Used to force a specific ordering in + graph execution.) items: type: string - description: Optional. Added capabilities +optional - drop: + workspaces: items: - type: string + $ref: '#/components/schemas/WorkspacePipelineTaskBinding' + description: >- + Workspaces maps workspaces from the pipeline spec to the workspaces + declared in the Task. type: array - description: Optional. Removed capabilities +optional - id: Capabilities - description: >- - Capabilities adds and removes POSIX capabilities from running - containers. + whenExpressions: + description: Conditions that need to be true for the task to run. + type: array + items: + $ref: '#/components/schemas/WhenExpression' + taskSpec: + $ref: '#/components/schemas/EmbeddedTask' + description: Spec to instantiate this TaskRun. + taskRef: + description: Reference to a specific instance of a task. + $ref: '#/components/schemas/TaskRef' + retries: + format: int32 + description: >- + Retries represents how many times this task should be retried in + case of task failure. + type: integer + type: object + id: PipelineTask + description: PipelineTask defines a task in a Pipeline. + CancelOperationRequest: + properties: {} + description: The request message for Operations.CancelOperation. + id: CancelOperationRequest type: object OperationMetadata: + type: object + id: OperationMetadata properties: - target: - description: >- - Output only. Server-defined resource path for the target of the - operation. + statusDetail: readOnly: true type: string - createTime: + description: Output only. Human-readable status of the operation, if any. + verb: + description: Output only. Name of the verb executed by the operation. + type: string + readOnly: true + endTime: readOnly: true + description: Output only. The time the operation finished running. + type: string + format: google-datetime + createTime: description: Output only. The time the operation was created. + type: string format: google-datetime + readOnly: true + apiVersion: + readOnly: true + description: Output only. API version used to start the operation. type: string cancelRequested: description: >- @@ -246,938 +145,901 @@ components: corresponding to `Code.CANCELLED`. type: boolean readOnly: true - verb: + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. readOnly: true type: string - description: Output only. Name of the verb executed by the operation. - statusDetail: + description: Represents the metadata of the long-running operation. + Param: + properties: + value: + $ref: '#/components/schemas/ParamValue' + description: Value of the parameter. + name: + type: string + description: Name of the parameter. + type: object + id: Param + description: >- + Param defined with name and value. PipelineRef can be used to refer to a + specific instance of a Pipeline. + GoogleDevtoolsCloudbuildV2OperationMetadata: + type: object + description: Represents the metadata of the long-running operation. + id: GoogleDevtoolsCloudbuildV2OperationMetadata + properties: + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. type: string - description: Output only. Human-readable status of the operation, if any. readOnly: true apiVersion: readOnly: true - description: Output only. API version used to start the operation. type: string - endTime: + description: Output only. API version used to start the operation. + requestedCancellation: readOnly: true + type: boolean + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + endTime: format: google-datetime - type: string + readOnly: true description: Output only. The time the operation finished running. - description: Represents the metadata of the long-running operation. + type: string + statusMessage: + readOnly: true + description: Output only. Human-readable status of the operation, if any. + type: string + verb: + description: Output only. Name of the verb executed by the operation. + type: string + readOnly: true + createTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time the operation was created. + ExecAction: + id: ExecAction + description: ExecAction describes a "run in container" action. type: object - id: OperationMetadata - GitHubConfig: - id: GitHubConfig - description: Configuration for connections to github.com. properties: - authorizerCredential: - $ref: '#/components/schemas/OAuthCredential' + command: + type: array + items: + type: string description: >- - Optional. OAuth credential of the account that authorized the Cloud - Build GitHub App. It is recommended to use a robot account instead - of a human user account. The OAuth token must be tied to the Cloud - Build GitHub App. - appInstallationId: - type: string - description: Optional. GitHub App installation id. - format: int64 - type: object - PipelineWorkspaceDeclaration: - id: PipelineWorkspaceDeclaration - description: >- - Workspaces declares a set of named workspaces that are expected to be - provided by a PipelineRun. + Optional. Command is the command line to execute inside the + container, the working directory for the command is root ('/') in + the container's filesystem. The command is simply exec'd, it is not + run inside a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly call out to that + shell. Exit status of 0 is treated as live/healthy and non-zero is + unhealthy. +optional + AuditConfig: type: object + id: AuditConfig properties: - name: - type: string - description: Name is the name of a workspace to be provided by a PipelineRun. - optional: + auditLogConfigs: + type: array + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/AuditLogConfig' + service: description: >- - Optional marks a Workspace as not being required in PipelineRuns. By - default this field is false and so declared workspaces are required. - type: boolean - description: + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. type: string - description: >- - Description is a human readable string describing how the workspace - will be used in the Pipeline. - Operation: description: >- - This resource represents a long-running operation that is the result of - a network API call. + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + Connection: + description: >- + A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data + Center, Bitbucket Cloud or GitLab. + id: Connection properties: - response: + gitlabConfig: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. + githubConfig: + $ref: '#/components/schemas/GitHubConfig' + description: Configuration for connections to github.com. + bitbucketCloudConfig: + description: Configuration for connections to Bitbucket Cloud. + $ref: '#/components/schemas/BitbucketCloudConfig' + annotations: + description: Optional. Allows clients to store small amounts of arbitrary data. type: object additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - error: + type: string + installationState: + readOnly: true + $ref: '#/components/schemas/InstallationState' + description: Output only. Installation state of the Connection. + createTime: + readOnly: true + format: google-datetime + type: string description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - name: + Output only. Server assigned timestamp for when the connection was + created. + githubEnterpriseConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + description: Configuration for connections to an instance of GitHub Enterprise. + etag: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. type: string - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + disabled: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - done: + Optional. If disabled is set to true, functionality is disabled for + this connection. Repository based API methods and webhooks + processing for repositories in this connection will be disabled. + type: boolean + updateTime: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. + Output only. Server assigned timestamp for when the connection was + updated. + readOnly: true + type: string + format: google-datetime + reconciling: + readOnly: true type: boolean + description: >- + Output only. Set to true when the connection is being set up or + updated in the background. + bitbucketDataCenterConfig: + description: Configuration for connections to Bitbucket Data Center. + $ref: '#/components/schemas/BitbucketDataCenterConfig' + name: + description: >- + Immutable. The resource name of the connection, in the format + `projects/{project}/locations/{location}/connections/{connection_id}`. + type: string type: object - id: Operation - Provenance: - description: Provenance configuration. + EmbeddedTask: type: object + id: EmbeddedTask + description: EmbeddedTask defines a Task that is embedded in a Pipeline. properties: - storage: - description: Optional. Where provenance is stored. - enumDescriptions: - - Default PREFER_ARTIFACT_PROJECT. - - >- - GCB will attempt to push provenance to the artifact project. If it - is not available, fallback to build project. - - Only push to artifact project. - - Only push to build project. + taskSpec: + description: Spec to instantiate this TaskRun. + $ref: '#/components/schemas/TaskSpec' + annotations: + type: object + additionalProperties: + type: string + description: User annotations. See https://google.aip.dev/128#annotations + WorkspacePipelineTaskBinding: + description: >- + WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to + the workspaces declared in the Task. + id: WorkspacePipelineTaskBinding + properties: + name: type: string - enum: - - STORAGE_UNSPECIFIED - - PREFER_ARTIFACT_PROJECT - - ARTIFACT_PROJECT_ONLY - - BUILD_PROJECT_ONLY - enabled: - enumDescriptions: - - Default to disabled (before AA regionalization), optimistic after - - Provenance failures would fail the run - - >- - GCB will attempt to push to artifact analaysis and build state - would not be impacted by the push failures. - - Disable the provenance push entirely. - enum: - - ENABLED_UNSPECIFIED - - REQUIRED - - OPTIMISTIC - - DISABLED - description: Optional. Provenance push mode. - type: string - region: - type: string - description: Optional. Provenance region. - enumDescriptions: - - >- - The PipelineRun/TaskRun/Workflow will be rejected. Update this - comment to push to the same region as the run in Artifact Analysis - when it's regionalized. - - Push provenance to Artifact Analysis in global region. - enum: - - REGION_UNSPECIFIED - - GLOBAL - id: Provenance - SecurityContext: - type: object - properties: - runAsUser: - description: >- - Optional. The UID to run the entrypoint of the container process. - Defaults to user specified in image metadata if unspecified. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext takes - precedence. Note that this field cannot be set when spec.os.name is - windows. +optional - format: int64 + description: Name of the workspace as declared by the task. + workspace: + description: Name of the workspace declared by the pipeline. type: string - capabilities: - description: >- - Optional. Adds and removes POSIX capabilities from running - containers. - $ref: '#/components/schemas/Capabilities' - privileged: - type: boolean - description: Run container in privileged mode. - allowPrivilegeEscalation: - description: >- - Optional. AllowPrivilegeEscalation controls whether a process can - gain more privileges than its parent process. This bool directly - controls if the no_new_privs flag will be set on the container - process. AllowPrivilegeEscalation is true always when the container - is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field - cannot be set when spec.os.name is windows. +optional - type: boolean - runAsGroup: - description: >- - Optional. The GID to run the entrypoint of the container process. - Uses runtime default if unset. May also be set in - PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes - precedence. Note that this field cannot be set when spec.os.name is - windows. +optional - format: int64 + subPath: type: string - runAsNonRoot: - type: boolean description: >- - Optional. Indicates that the container must run as a non-root user. - If true, the Kubelet will validate the image at runtime to ensure - that it does not run as UID 0 (root) and fail to start the container - if it does. If unset or false, no such validation will be performed. - May also be set in PodSecurityContext. If set in both - SecurityContext and PodSecurityContext, the value specified in - SecurityContext takes precedence. +optional - id: SecurityContext - description: Security options the container should be run with. - GoogleDevtoolsCloudbuildV2Condition: - id: GoogleDevtoolsCloudbuildV2Condition + Optional. SubPath is optionally a directory on the volume which + should be used for this binding (i.e. the volume will be mounted at + this sub directory). +optional type: object - description: Conditions defines a readiness condition for a Knative resource. + GoogleDevtoolsCloudbuildV2Condition: properties: - type: - description: Type of condition. - type: string - reason: - type: string - description: The reason for the condition's last transition. severity: - enum: - - SEVERITY_UNSPECIFIED - - WARNING - - INFO - description: Severity with which to treat failures of this type of condition. + type: string enumDescriptions: - Default enum type; should not be used. - Severity is warning. - Severity is informational only. + description: Severity with which to treat failures of this type of condition. + enum: + - SEVERITY_UNSPECIFIED + - WARNING + - INFO + lastTransitionTime: + description: >- + LastTransitionTime is the last time the condition transitioned from + one status to another. type: string + format: google-datetime message: description: A human readable message indicating details about the transition. type: string + reason: + type: string + description: The reason for the condition's last transition. status: + description: Status of the condition. enum: - UNKNOWN - 'TRUE' - 'FALSE' + type: string enumDescriptions: - Default enum type indicating execution is still ongoing. - Success - Failure - description: Status of the condition. + type: type: string - lastTransitionTime: - format: google-datetime + description: Type of condition. + type: object + description: Conditions defines a readiness condition for a Knative resource. + id: GoogleDevtoolsCloudbuildV2Condition + InstallationState: + type: object + id: InstallationState + description: >- + Describes stage and necessary actions to be taken by the user to + complete the installation. Used for GitHub and GitHub Enterprise based + connections. + properties: + actionUri: + description: >- + Output only. Link to follow for next action. Empty string if the + installation is already complete. + readOnly: true + type: string + stage: + readOnly: true + enumDescriptions: + - No stage specified. + - >- + Only for GitHub Enterprise. An App creation has been requested. + The user needs to confirm the creation in their GitHub enterprise + host. + - User needs to authorize the GitHub (or Enterprise) App via OAuth. + - >- + User needs to follow the link to install the GitHub (or + Enterprise) App. + - Installation process has been completed. + type: string + description: Output only. Current step of the installation process. + enum: + - STAGE_UNSPECIFIED + - PENDING_CREATE_APP + - PENDING_USER_OAUTH + - PENDING_INSTALL_APP + - COMPLETE + message: type: string description: >- - LastTransitionTime is the last time the condition transitioned from - one status to another. + Output only. Message of what the user should do next to continue the + installation. Empty string if the installation is already complete. + readOnly: true TaskResult: + description: TaskResult is used to describe the results of a task. properties: - properties: - type: object - description: >- - When type is OBJECT, this map holds the names of fields inside that - object along with the type of data each field holds. - additionalProperties: - $ref: '#/components/schemas/PropertySpec' - value: - $ref: '#/components/schemas/ParamValue' - description: >- - Optional. Optionally used to initialize a Task's result with a - Step's result. type: - type: string enumDescriptions: - Default enum type; should not be used. - Default - Array type - Object type + type: string + description: The type of data that the result holds. enum: - TYPE_UNSPECIFIED - STRING - ARRAY - OBJECT - description: The type of data that the result holds. name: - description: Name of the result. type: string + description: Name of the result. description: - description: Description of the result. type: string - id: TaskResult + description: Description of the result. + value: + description: >- + Optional. Optionally used to initialize a Task's result with a + Step's result. + $ref: '#/components/schemas/ParamValue' + properties: + description: >- + When type is OBJECT, this map holds the names of fields inside that + object along with the type of data each field holds. + additionalProperties: + $ref: '#/components/schemas/PropertySpec' + type: object type: object - description: TaskResult is used to describe the results of a task. - FetchReadTokenResponse: - description: Message for responding to get read token. - id: FetchReadTokenResponse + id: TaskResult + WorkspaceBinding: type: object + description: >- + WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used + to refer to a specific instance of a Pipeline. + id: WorkspaceBinding properties: - token: + secret: + description: Secret Volume Source. + $ref: '#/components/schemas/SecretVolumeSource' + name: type: string - description: The token content. - expirationTime: - description: Expiration timestamp. Can be empty if unknown or non-expiring. - format: google-datetime + description: Name of the workspace. + subPath: type: string - FetchLinkableRepositoriesResponse: + description: >- + Optional. SubPath is optionally a directory on the volume which + should be used for this binding (i.e. the volume will be mounted at + this sub directory). +optional + EmptyDirVolumeSource: + type: object + description: Represents an empty Volume source. + properties: {} + id: EmptyDirVolumeSource + ListLocationsResponse: type: object + id: ListLocationsResponse + description: The response message for Locations.ListLocations. properties: nextPageToken: - description: A token identifying a page of results the server should return. type: string - repositories: - description: repositories ready to be created. - items: - $ref: '#/components/schemas/Repository' + description: The standard List next-page token. + locations: type: array - description: Response message for FetchLinkableRepositories. - id: FetchLinkableRepositoriesResponse - ParamValue: - description: Parameter value. + description: >- + A list of locations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/Location' + Location: properties: - stringVal: - description: Value of the parameter if type is string. - type: string - type: - type: string - description: Type of parameter. - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - arrayVal: - type: array - items: - type: string - description: Value of the parameter if type is array. - objectVal: - description: Optional. Value of the parameter if type is object. - type: object - additionalProperties: - type: string - id: ParamValue - type: object - TaskSpec: - type: object - description: TaskSpec contains the Spec to instantiate a TaskRun. - properties: - managedSidecars: - type: array + name: description: >- - Sidecars that run alongside the Task’s step containers that should - be added to this Task. - items: - enumDescriptions: - - Default enum type; should not be used. - - Sidecar for a privileged docker daemon. - type: string - enum: - - MANAGED_SIDECAR_UNSPECIFIED - - PRIVILEGED_DOCKER_DAEMON - results: - type: array - description: Values that this Task can output. - items: - $ref: '#/components/schemas/TaskResult' - description: + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` type: string - description: Description of the task. - workspaces: - type: array - description: The volumes that this Task requires. - items: - $ref: '#/components/schemas/WorkspaceDeclaration' - sidecars: - type: array - description: Sidecars that run alongside the Task's step containers. - items: - $ref: '#/components/schemas/Sidecar' - stepTemplate: - $ref: '#/components/schemas/StepTemplate' + metadata: description: >- - Optional. StepTemplate can be used as the basis for all step - containers within the Task, so that the steps inherit settings on - the base container. - steps: - type: array - items: - $ref: '#/components/schemas/Step' - description: Steps of the task. - volumes: - items: - $ref: '#/components/schemas/VolumeSource' - type: array - description: A collection of volumes that are available to mount into steps. - params: - items: - $ref: '#/components/schemas/ParamSpec' - type: array - description: List of parameters. - id: TaskSpec - TestIamPermissionsResponse: - properties: - permissions: + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + displayName: description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + type: object + additionalProperties: type: string - description: Response message for `TestIamPermissions` method. - type: object - id: TestIamPermissionsResponse - ListRepositoriesResponse: - description: Message for response to listing Repositories. - properties: - repositories: - description: The list of Repositories. - items: - $ref: '#/components/schemas/Repository' - type: array - nextPageToken: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + locationId: type: string - description: A token identifying a page of results the server should return. - id: ListRepositoriesResponse + description: 'The canonical id for this location. For example: `"us-east1"`.' + description: A resource that represents a Google Cloud location. type: object - GoogleDevtoolsCloudbuildV2OperationMetadata: - id: GoogleDevtoolsCloudbuildV2OperationMetadata + id: Location + GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: properties: - endTime: - format: google-datetime - description: Output only. The time the operation finished running. - readOnly: true + webhookSecretSecretVersion: type: string - apiVersion: + description: >- + Optional. SecretManager resource containing the webhook secret of + the GitHub App, formatted as `projects/*/secrets/*/versions/*`. + serverVersion: type: string - description: Output only. API version used to start the operation. readOnly: true - statusMessage: + description: Output only. GitHub Enterprise version installed at the host_uri. + sslCa: + description: Optional. SSL certificate to use for requests to GitHub Enterprise. type: string - readOnly: true - description: Output only. Human-readable status of the operation, if any. - target: - readOnly: true + serviceDirectoryConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + description: >- + Optional. Configuration for using Service Directory to privately + connect to a GitHub Enterprise server. This should only be set if + the GitHub Enterprise server is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the GitHub + Enterprise server will be made over the public internet. + appId: + description: Optional. Id of the GitHub App created from the manifest. + type: string + format: int64 + appSlug: type: string + description: Optional. The URL-friendly name of the GitHub App. + hostUri: description: >- - Output only. Server-defined resource path for the target of the - operation. - verb: + Required. The URI of the GitHub Enterprise host this connection is + for. type: string - readOnly: true - description: Output only. Name of the verb executed by the operation. - createTime: - description: Output only. The time the operation was created. - readOnly: true + apiKey: + description: Required. API Key used for authentication of webhook events. + type: string + privateKeySecretVersion: type: string - format: google-datetime - requestedCancellation: - readOnly: true - type: boolean description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - type: object - description: Represents the metadata of the long-running operation. - StepRef: - description: A reference to a remote Step, i.e. a StepAction. + Optional. SecretManager resource containing the private key of the + GitHub App, formatted as `projects/*/secrets/*/versions/*`. + appInstallationId: + type: string + description: Optional. ID of the installation of the GitHub App. + format: int64 + id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + description: Configuration for connections to an instance of GitHub Enterprise. type: object + PropertySpec: properties: - name: - description: Optional. Name of the step. + type: + enum: + - TYPE_UNSPECIFIED + - STRING + description: A type for the object. type: string - params: - type: array - items: - $ref: '#/components/schemas/Param' - description: Optional. Parameters used to control the resolution. - resolver: enumDescriptions: - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT - type: string - description: Optional. Type of the resolver. - id: StepRef - ExecAction: - properties: - command: - type: array - items: - type: string - description: >- - Optional. Command is the command line to execute inside the - container, the working directory for the command is root ('/') in - the container's filesystem. The command is simply exec'd, it is not - run inside a shell, so traditional shell instructions ('|', etc) - won't work. To use a shell, you need to explicitly call out to that - shell. Exit status of 0 is treated as live/healthy and non-zero is - unhealthy. +optional + - Default type: object - description: ExecAction describes a "run in container" action. - id: ExecAction - CancelOperationRequest: + id: PropertySpec + description: PropertySpec holds information about a property in an object. + FetchReadTokenRequest: + id: FetchReadTokenRequest type: object properties: {} - description: The request message for Operations.CancelOperation. - id: CancelOperationRequest - PipelineResult: - description: A value produced by a Pipeline. + description: Message for fetching SCM read token. + TimeoutFields: + id: TimeoutFields properties: - name: - readOnly: true - description: Output only. Name of the result. + finally: + description: Finally sets the maximum allowed duration of this pipeline's finally + type: string + format: google-duration + tasks: + format: google-duration + type: string + description: Tasks sets the maximum allowed duration of this pipeline's tasks + pipeline: + description: >- + Pipeline sets the maximum allowed duration for execution of the + entire pipeline. The sum of individual timeouts for tasks and + finally must not exceed this value. + format: google-duration + type: string + type: object + description: >- + TimeoutFields allows granular specification of pipeline, task, and + finally timeouts + FetchGitRefsResponse: + type: object + id: FetchGitRefsResponse + description: Response for fetching git refs + properties: + refNames: + items: + type: string + type: array + description: Name of the refs fetched. + nextPageToken: type: string + description: A token identifying a page of results the server should return. + PipelineWorkspaceDeclaration: + type: object + id: PipelineWorkspaceDeclaration + properties: description: + type: string + description: >- + Description is a human readable string describing how the workspace + will be used in the Pipeline. + name: + description: Name is the name of a workspace to be provided by a PipelineRun. + type: string + optional: + description: >- + Optional marks a Workspace as not being required in PipelineRuns. By + default this field is false and so declared workspaces are required. + type: boolean + description: >- + Workspaces declares a set of named workspaces that are expected to be + provided by a PipelineRun. + Repository: + type: object + id: Repository + description: A repository associated to a parent connection. + properties: + webhookId: + description: Output only. External ID of the webhook created for the repository. readOnly: true - description: Output only. Description of the result. type: string - value: - description: Output only. Value of the result. - $ref: '#/components/schemas/ResultValue' + annotations: + type: object + description: Optional. Allows clients to store small amounts of arbitrary data. + additionalProperties: + type: string + updateTime: + description: >- + Output only. Server assigned timestamp for when the connection was + updated. + format: google-datetime readOnly: true - type: type: string - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - description: Output only. The type of data that the result holds. - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type + remoteUri: + type: string + description: Required. Git Clone HTTPS URI. + etag: + type: string + description: >- + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. + name: + description: >- + Immutable. Resource name of the repository, in the format + `projects/*/locations/*/connections/*/repositories/*`. + type: string + createTime: + format: google-datetime + description: >- + Output only. Server assigned timestamp for when the connection was + created. + type: string readOnly: true - type: object - id: PipelineResult AuditLogConfig: type: object + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + id: AuditLogConfig properties: exemptedMembers: - items: - type: string description: >- Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + items: + type: string type: array logType: - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ + description: The log type that this config enables. enumDescriptions: - Default case. Should never be this. - 'Admin reads. Example: CloudIAM getIamPolicy' - 'Data writes. Example: CloudSQL Users create' - 'Data reads. Example: CloudSQL Users list' - description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ type: string - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - id: AuditLogConfig - ListLocationsResponse: + ChildStatusReference: properties: - locations: - description: >- - A list of locations that matches the specified filter in the - request. + whenExpressions: items: - $ref: '#/components/schemas/Location' - type: array - nextPageToken: - type: string - description: The standard List next-page token. - type: object - description: The response message for Locations.ListLocations. - id: ListLocationsResponse - BitbucketDataCenterConfig: - id: BitbucketDataCenterConfig - properties: - serviceDirectoryConfig: - description: >- - Optional. Configuration for using Service Directory to privately - connect to a Bitbucket Data Center. This should only be set if the - Bitbucket Data Center is hosted on-premises and not reachable by - public internet. If this field is left empty, calls to the Bitbucket - Data Center will be made over the public internet. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - authorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: Required. A http access token with the `REPO_ADMIN` scope access. - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: Required. A http access token with the `REPO_READ` access. - hostUri: + $ref: '#/components/schemas/WhenExpression' description: >- - Required. The URI of the Bitbucket Data Center instance or cluster - this connection is for. - type: string - sslCa: + WhenExpressions is the list of checks guarding the execution of the + PipelineTask + type: array + pipelineTaskName: type: string description: >- - Optional. SSL certificate to use for requests to the Bitbucket Data - Center. - webhookSecretSecretVersion: + PipelineTaskName is the name of the PipelineTask this is + referencing. + type: + description: Output only. Type of the child reference. + enumDescriptions: + - Default enum type; should not be used. + - TaskRun. type: string - description: >- - Required. Immutable. SecretManager resource containing the webhook - secret used to verify webhook events, formatted as - `projects/*/secrets/*/versions/*`. - serverVersion: - description: >- - Output only. Version of the Bitbucket Data Center running on the - `host_uri`. + enum: + - TYPE_UNSPECIFIED + - TASK_RUN readOnly: true + name: type: string + description: Name is the name of the TaskRun or Run this is referencing. + description: >- + ChildStatusReference is used to point to the statuses of individual + TaskRuns and Runs within this PipelineRun. + id: ChildStatusReference type: object - description: Configuration for connections to Bitbucket Data Center. - BatchCreateRepositoriesResponse: - id: BatchCreateRepositoriesResponse - description: Message for response of creating repositories in batch. + BatchCreateRepositoriesRequest: + id: BatchCreateRepositoriesRequest properties: - repositories: - items: - $ref: '#/components/schemas/Repository' - description: Repository resources created. + requests: type: array + description: >- + Required. The request messages specifying the repositories to + create. + items: + $ref: '#/components/schemas/CreateRepositoryRequest' + description: Message for creating repositoritories in batch. type: object - WorkspaceBinding: - description: >- - WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used - to refer to a specific instance of a Pipeline. + ListRepositoriesResponse: + description: Message for response to listing Repositories. properties: - subPath: - type: string - description: >- - Optional. SubPath is optionally a directory on the volume which - should be used for this binding (i.e. the volume will be mounted at - this sub directory). +optional - secret: - description: Secret Volume Source. - $ref: '#/components/schemas/SecretVolumeSource' - name: + nextPageToken: + description: A token identifying a page of results the server should return. type: string - description: Name of the workspace. + repositories: + type: array + description: The list of Repositories. + items: + $ref: '#/components/schemas/Repository' + id: ListRepositoriesResponse type: object - id: WorkspaceBinding - ResultValue: - id: ResultValue + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. type: object properties: - arrayVal: + permissions: + type: array items: type: string - type: array - description: Value of the result if type is array. - type: + 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). + Provenance: + properties: + storage: type: string + description: Optional. Where provenance is stored. enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - description: Output only. The type of data that the result holds. + - Default PREFER_ARTIFACT_PROJECT. + - >- + GCB will attempt to push provenance to the artifact project. If it + is not available, fallback to build project. + - Only push to artifact project. + - Only push to build project. enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - readOnly: true - objectVal: - additionalProperties: - type: string - type: object - description: Value of the result if type is object. - stringVal: - description: Value of the result if type is string. + - STORAGE_UNSPECIFIED + - PREFER_ARTIFACT_PROJECT + - ARTIFACT_PROJECT_ONLY + - BUILD_PROJECT_ONLY + enabled: + enumDescriptions: + - Default to disabled (before AA regionalization), optimistic after + - Provenance failures would fail the run + - >- + GCB will attempt to push to artifact analaysis and build state + would not be impacted by the push failures. + - Disable the provenance push entirely. + enum: + - ENABLED_UNSPECIFIED + - REQUIRED + - OPTIMISTIC + - DISABLED + description: Optional. Provenance push mode. type: string - description: ResultValue holds different types of data for a single result. - SetIamPolicyRequest: - id: SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. + region: + type: string + enum: + - REGION_UNSPECIFIED + - GLOBAL + enumDescriptions: + - >- + The PipelineRun/TaskRun/Workflow will be rejected. Update this + comment to push to the same region as the run in Artifact Analysis + when it's regionalized. + - Push provenance to Artifact Analysis in global region. + description: Optional. Provenance region. + id: Provenance + type: object + description: Provenance configuration. + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. type: object properties: - policy: - $ref: '#/components/schemas/Policy' - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - updateMask: - type: string + permissions: + items: + type: string description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - format: google-fieldmask - PipelineRun: + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + TaskSpec: + description: TaskSpec contains the Spec to instantiate a TaskRun. + type: object + id: TaskSpec properties: - pipelineRef: - $ref: '#/components/schemas/PipelineRef' - description: PipelineRef refer to a specific instance of a Pipeline. - completionTime: - readOnly: true - description: Output only. Time the pipeline completed. - type: string - format: google-datetime + steps: + description: Steps of the task. + items: + $ref: '#/components/schemas/Step' + type: array workspaces: + items: + $ref: '#/components/schemas/WorkspaceDeclaration' + description: The volumes that this Task requires. + type: array + volumes: + type: array + description: A collection of volumes that are available to mount into steps. + items: + $ref: '#/components/schemas/VolumeSource' + description: + description: Description of the task. + type: string + stepTemplate: description: >- - Workspaces is a list of WorkspaceBindings from volumes to - workspaces. + Optional. StepTemplate can be used as the basis for all step + containers within the Task, so that the steps inherit settings on + the base container. + $ref: '#/components/schemas/StepTemplate' + params: + items: + $ref: '#/components/schemas/ParamSpec' + description: List of parameters. type: array + managedSidecars: + description: >- + Sidecars that run alongside the Task’s step containers that should + be added to this Task. items: - $ref: '#/components/schemas/WorkspaceBinding' - gcbParams: - readOnly: true - type: object - description: Output only. GCB default params. - additionalProperties: type: string + enum: + - MANAGED_SIDECAR_UNSPECIFIED + - PRIVILEGED_DOCKER_DAEMON + enumDescriptions: + - Default enum type; should not be used. + - Sidecar for a privileged docker daemon. + type: array results: - readOnly: true - description: >- - Optional. Output only. List of results written out by the pipeline's - containers + description: Values that this Task can output. items: - $ref: '#/components/schemas/PipelineRunResult' + $ref: '#/components/schemas/TaskResult' type: array - timeouts: - $ref: '#/components/schemas/TimeoutFields' - description: >- - Time after which the Pipeline times out. Currently three keys are - accepted in the map pipeline, tasks and finally with - Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally - childReferences: + sidecars: + description: Sidecars that run alongside the Task's step containers. items: - $ref: '#/components/schemas/ChildStatusReference' + $ref: '#/components/schemas/Sidecar' type: array - description: >- - Output only. List of TaskRun and Run names and PipelineTask names - for children of this PipelineRun. - readOnly: true - uid: - readOnly: true + BatchCreateRepositoriesResponse: + description: Message for response of creating repositories in batch. + properties: + repositories: + items: + $ref: '#/components/schemas/Repository' + type: array + description: Repository resources created. + type: object + id: BatchCreateRepositoriesResponse + ParamSpec: + properties: + name: type: string - description: Output only. A unique identifier for the `PipelineRun`. - etag: + description: Name of the ParamSpec + type: + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type. + - Object type. + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT type: string - description: Needed for declarative-friendly resources. - name: - readOnly: true + description: Type of ParamSpec + description: type: string + description: Description of the ParamSpec + default: + description: The default value a parameter takes if no input value is supplied + $ref: '#/components/schemas/ParamValue' + description: >- + ParamSpec defines parameters needed beyond typed inputs (such as + resources). Parameter values are provided by users as inputs on a + TaskRun or PipelineRun. + type: object + id: ParamSpec + RunWorkflowCustomOperationMetadata: + type: object + properties: + requestedCancellation: description: >- - Output only. The `PipelineRun` name with format - `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` - serviceAccount: - deprecated: true + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + target: + readOnly: true description: >- - Service account used in the Pipeline. Deprecated; please use - security.service_account instead. + Output only. Server-defined resource path for the target of the + operation. + type: string + pipelineRunId: + description: Output only. ID of the pipeline run created by RunWorkflow. type: string + readOnly: true createTime: - description: >- - Output only. Time at which the request to create the `PipelineRun` - was received. - format: google-datetime type: string readOnly: true - skippedTasks: - description: >- - Output only. List of tasks that were skipped due to when expressions - evaluating to false. - items: - $ref: '#/components/schemas/SkippedTask' - type: array - readOnly: true - worker: - $ref: '#/components/schemas/Worker' - description: Optional. Worker configuration. - params: - type: array - items: - $ref: '#/components/schemas/Param' - description: Params is a list of parameter names and values. - pipelineRunStatus: - enum: - - PIPELINE_RUN_STATUS_UNSPECIFIED - - PIPELINE_RUN_CANCELLED - enumDescriptions: - - Default enum type; should not be used. - - Cancelled status. - type: string - description: Pipelinerun status the user can provide. Used for cancellation. - pipelineSpecYaml: - readOnly: true - description: >- - Output only. Inline pipelineSpec yaml string, used by workflow run - requests. - type: string - startTime: - format: google-datetime - description: Output only. Time the pipeline is actually started. - type: string - readOnly: true - updateTime: - readOnly: true - description: >- - Output only. Time at which the request to update the `PipelineRun` - was received. format: google-datetime - type: string - record: - readOnly: true - type: string - description: >- - Output only. The `Record` of this `PipelineRun`. Format: - `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` - conditions: - description: >- - Output only. Kubernetes Conditions convention for PipelineRun status - and error. - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' - readOnly: true - annotations: - description: User annotations. See https://google.aip.dev/128#annotations - type: object - additionalProperties: - type: string - workerPool: + description: Output only. The time the operation was created. + apiVersion: readOnly: true - description: Output only. The WorkerPool used to run this PipelineRun. + description: Output only. API version used to start the operation. type: string - workflow: + endTime: type: string - description: Output only. The Workflow used to create this PipelineRun. - readOnly: true - security: - $ref: '#/components/schemas/Security' - description: Optional. Security configuration. - pipelineSpec: - description: PipelineSpec defines the desired state of Pipeline. - $ref: '#/components/schemas/PipelineSpec' - finallyStartTime: - description: >- - Output only. FinallyStartTime is when all non-finally tasks have - been completed and only finally tasks are being executed. +optional + format: google-datetime + description: Output only. The time the operation finished running. readOnly: true + verb: type: string - format: google-datetime - provenance: - description: Optional. Provenance configuration. - $ref: '#/components/schemas/Provenance' - resolvedPipelineSpec: - description: Output only. The exact PipelineSpec used to instantiate the run. - $ref: '#/components/schemas/PipelineSpec' readOnly: true - description: Message describing PipelineRun object - id: PipelineRun + description: Output only. Name of the verb executed by the operation. + id: RunWorkflowCustomOperationMetadata + description: >- + Represents the custom metadata of the RunWorkflow long-running + operation. + HttpBody: type: object - GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: + id: HttpBody properties: - appSlug: - type: string - description: Optional. The URL-friendly name of the GitHub App. - serviceDirectoryConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - description: >- - Optional. Configuration for using Service Directory to privately - connect to a GitHub Enterprise server. This should only be set if - the GitHub Enterprise server is hosted on-premises and not reachable - by public internet. If this field is left empty, calls to the GitHub - Enterprise server will be made over the public internet. - sslCa: - description: Optional. SSL certificate to use for requests to GitHub Enterprise. - type: string - apiKey: - type: string - description: Required. API Key used for authentication of webhook events. - webhookSecretSecretVersion: - type: string - description: >- - Optional. SecretManager resource containing the webhook secret of - the GitHub App, formatted as `projects/*/secrets/*/versions/*`. - appId: - format: int64 - type: string - description: Optional. Id of the GitHub App created from the manifest. - serverVersion: - type: string - readOnly: true - description: Output only. GitHub Enterprise version installed at the host_uri. - privateKeySecretVersion: + extensions: + type: array + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Optional. SecretManager resource containing the private key of the - GitHub App, formatted as `projects/*/secrets/*/versions/*`. - type: string - appInstallationId: - format: int64 - description: Optional. ID of the installation of the GitHub App. + Application specific response metadata. Must be set in the first + response for streaming APIs. + contentType: type: string - hostUri: description: >- - Required. The URI of the GitHub Enterprise host this connection is - for. + The HTTP Content-Type header value specifying the content type of + the body. + data: + description: The HTTP request/response body as raw binary. + format: byte type: string - type: object - id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - description: Configuration for connections to an instance of GitHub Enterprise. - HttpBody: description: >- Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw @@ -1197,944 +1059,1143 @@ components: returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. - id: HttpBody + ListConnectionsResponse: + properties: + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + connections: + items: + $ref: '#/components/schemas/Connection' + type: array + description: The list of Connections. type: object + id: ListConnectionsResponse + description: Message for response to listing Connections. + PipelineSpec: properties: - extensions: + generatedYaml: + type: string + description: >- + Output only. auto-generated yaml that is output only for display + purpose for workflows using pipeline_spec, used by UI/gcloud cli for + Workflows. + readOnly: true + tasks: + items: + $ref: '#/components/schemas/PipelineTask' + description: List of Tasks that execute when this Pipeline is run. type: array + finallyTasks: + items: + $ref: '#/components/schemas/PipelineTask' description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. + List of Tasks that execute just before leaving the Pipeline i.e. + either after all Tasks are finished executing successfully or after + a failure which would result in ending the Pipeline. + type: array + workspaces: + type: array + description: >- + Workspaces declares a set of named workspaces that are expected to + be provided by a PipelineRun. items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - data: - type: string - description: The HTTP request/response body as raw binary. - format: byte - contentType: - type: string + $ref: '#/components/schemas/PipelineWorkspaceDeclaration' + results: + type: array + readOnly: true + items: + $ref: '#/components/schemas/PipelineResult' description: >- - The HTTP Content-Type header value specifying the content type of - the body. - EmptyDirVolumeSource: - type: object - id: EmptyDirVolumeSource - properties: {} - description: Represents an empty Volume source. - WorkspaceDeclaration: - id: WorkspaceDeclaration + Optional. Output only. List of results written out by the pipeline's + containers + params: + items: + $ref: '#/components/schemas/ParamSpec' + description: List of parameters. + type: array type: object + description: PipelineSpec defines the desired state of Pipeline. + id: PipelineSpec + EnvVar: properties: - optional: - type: boolean - description: >- - Optional. Optional marks a Workspace as not being required in - TaskRuns. By default this field is false and so declared workspaces - are required. name: + description: Name of the environment variable. type: string - description: Name is the name by which you can bind the volume at runtime. - readOnly: - description: ReadOnly dictates whether a mounted volume is writable. - type: boolean - mountPath: + value: type: string + description: Value of the environment variable. + type: object + description: Environment variable. + id: EnvVar + GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: + properties: + service: description: >- - MountPath overrides the directory that the volume will be made - available at. - description: + Required. The Service Directory service name. Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. type: string - description: Description is a human readable description of this volume. - description: WorkspaceDeclaration is a declaration of a volume that a Task requires. - GoogleDevtoolsCloudbuildV2GitLabConfig: - id: GoogleDevtoolsCloudbuildV2GitLabConfig description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. + ServiceDirectoryConfig represents Service Directory configuration for a + connection. + type: object + id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + WhenExpression: + description: Conditions that need to be true for the task to run. + id: WhenExpression type: object properties: - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' + expressionOperator: + enum: + - EXPRESSION_OPERATOR_UNSPECIFIED + - IN + - NOT_IN + enumDescriptions: + - Default enum type; should not be used. + - Input is in values. + - Input is not in values. + description: Operator that represents an Input's relationship to the values + type: string + values: description: >- - Required. A GitLab personal access token with the minimum `read_api` - scope access. + Values is an array of strings, which is compared against the input, + for guard checking. + items: + type: string + type: array + input: + type: string + description: >- + Input is the string for guard checking which can be a static input + or an output from a parent Task. + BitbucketDataCenterConfig: + description: Configuration for connections to Bitbucket Data Center. + properties: + serviceDirectoryConfig: + description: >- + Optional. Configuration for using Service Directory to privately + connect to a Bitbucket Data Center. This should only be set if the + Bitbucket Data Center is hosted on-premises and not reachable by + public internet. If this field is left empty, calls to the Bitbucket + Data Center will be made over the public internet. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig authorizerCredential: + description: Required. A http access token with the `REPO_ADMIN` scope access. $ref: '#/components/schemas/UserCredential' + sslCa: description: >- - Required. A GitLab personal access token with the `api` scope - access. - webhookSecretSecretVersion: + Optional. SSL certificate to use for requests to the Bitbucket Data + Center. type: string + readAuthorizerCredential: + description: Required. A http access token with the `REPO_READ` access. + $ref: '#/components/schemas/UserCredential' + hostUri: + type: string + description: >- + Required. The URI of the Bitbucket Data Center instance or cluster + this connection is for. + webhookSecretSecretVersion: description: >- Required. Immutable. SecretManager resource containing the webhook - secret of a GitLab Enterprise project, formatted as + secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. - sslCa: type: string - description: Optional. SSL certificate to use for requests to GitLab Enterprise. serverVersion: - readOnly: true type: string + readOnly: true description: >- - Output only. Version of the GitLab Enterprise server running on the + Output only. Version of the Bitbucket Data Center running on the `host_uri`. - hostUri: - description: >- - Optional. The URI of the GitLab Enterprise host this connection is - for. If not specified, the default value is https://gitlab.com. - type: string - serviceDirectoryConfig: - description: >- - Optional. Configuration for using Service Directory to privately - connect to a GitLab Enterprise server. This should only be set if - the GitLab Enterprise server is hosted on-premises and not reachable - by public internet. If this field is left empty, calls to the GitLab - Enterprise server will be made over the public internet. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - PipelineSpec: - id: PipelineSpec - description: PipelineSpec defines the desired state of Pipeline. + id: BitbucketDataCenterConfig + type: object + PipelineRef: + id: PipelineRef type: object properties: - results: - items: - $ref: '#/components/schemas/PipelineResult' - description: >- - Optional. Output only. List of results written out by the pipeline's - containers - readOnly: true - type: array - workspaces: - type: array - items: - $ref: '#/components/schemas/PipelineWorkspaceDeclaration' - description: >- - Workspaces declares a set of named workspaces that are expected to - be provided by a PipelineRun. - tasks: - items: - $ref: '#/components/schemas/PipelineTask' - type: array - description: List of Tasks that execute when this Pipeline is run. - generatedYaml: + resolver: + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT type: string - readOnly: true description: >- - Output only. auto-generated yaml that is output only for display - purpose for workflows using pipeline_spec, used by UI/gcloud cli for - Workflows. + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. + name: + type: string + description: Optional. Name of the Pipeline. params: - description: List of parameters. - items: - $ref: '#/components/schemas/ParamSpec' - type: array - finallyTasks: type: array - items: - $ref: '#/components/schemas/PipelineTask' description: >- - List of Tasks that execute just before leaving the Pipeline i.e. - either after all Tasks are finished executing successfully or after - a failure which would result in ending the Pipeline. - InstallationState: - type: object - id: InstallationState + Params contains the parameters used to identify the referenced + Tekton resource. Example entries might include "repo" or "path" but + the set of params ultimately depends on the chosen resolver. + items: + $ref: '#/components/schemas/Param' + description: PipelineRef can be used to refer to a specific instance of a Pipeline. + TaskRef: description: >- - Describes stage and necessary actions to be taken by the user to - complete the installation. Used for GitHub and GitHub Enterprise based - connections. + TaskRef can be used to refer to a specific instance of a task. + PipelineRef can be used to refer to a specific instance of a Pipeline. + id: TaskRef + type: object properties: - actionUri: - description: >- - Output only. Link to follow for next action. Empty string if the - installation is already complete. - type: string - readOnly: true - message: - readOnly: true + resolver: description: >- - Output only. Message of what the user should do next to continue the - installation. Empty string if the installation is already complete. - type: string - stage: + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT type: string - description: Output only. Current step of the installation process. - readOnly: true enumDescriptions: - - No stage specified. + - Default enum type; should not be used. - >- - Only for GitHub Enterprise. An App creation has been requested. - The user needs to confirm the creation in their GitHub enterprise - host. - - User needs to authorize the GitHub (or Enterprise) App via OAuth. + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. - >- - User needs to follow the link to install the GitHub (or - Enterprise) App. - - Installation process has been completed. - enum: - - STAGE_UNSPECIFIED - - PENDING_CREATE_APP - - PENDING_USER_OAUTH - - PENDING_INSTALL_APP - - COMPLETE - EnvVar: - type: object - id: EnvVar - properties: + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + params: + items: + $ref: '#/components/schemas/Param' + type: array + description: >- + Params contains the parameters used to identify the referenced + Tekton resource. Example entries might include "repo" or "path" but + the set of params ultimately depends on the chosen resolver. name: - description: Name of the environment variable. - type: string - value: + description: Optional. Name of the task. type: string - description: Value of the environment variable. - description: Environment variable. - Repository: + Probe: + id: Probe + description: >- + Probe describes a health check to be performed against a container to + determine whether it is alive or ready to receive traffic. + type: object properties: - updateTime: - readOnly: true - format: google-datetime + exec: + $ref: '#/components/schemas/ExecAction' + description: Optional. Exec specifies the action to take. +optional + periodSeconds: + format: int32 description: >- - Output only. Server assigned timestamp for when the connection was - updated. - type: string - annotations: - type: object - additionalProperties: - type: string - description: Optional. Allows clients to store small amounts of arbitrary data. - name: + Optional. How often (in seconds) to perform the probe. Default to 10 + seconds. Minimum value is 1. +optional + type: integer + SecurityContext: + properties: + runAsGroup: + format: int64 type: string description: >- - Immutable. Resource name of the repository, in the format - `projects/*/locations/*/connections/*/repositories/*`. - etag: - description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. - type: string - webhookId: - description: Output only. External ID of the webhook created for the repository. - type: string - readOnly: true - remoteUri: + Optional. The GID to run the entrypoint of the container process. + Uses runtime default if unset. May also be set in + PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes + precedence. Note that this field cannot be set when spec.os.name is + windows. +optional + runAsUser: type: string - description: Required. Git Clone HTTPS URI. - createTime: - format: google-datetime + format: int64 description: >- - Output only. Server assigned timestamp for when the connection was - created. - readOnly: true - type: string - description: A repository associated to a parent connection. + Optional. The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. May + also be set in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext takes + precedence. Note that this field cannot be set when spec.os.name is + windows. +optional + capabilities: + description: >- + Optional. Adds and removes POSIX capabilities from running + containers. + $ref: '#/components/schemas/Capabilities' + runAsNonRoot: + type: boolean + description: >- + Optional. Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure + that it does not run as UID 0 (root) and fail to start the container + if it does. If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both + SecurityContext and PodSecurityContext, the value specified in + SecurityContext takes precedence. +optional + allowPrivilegeEscalation: + description: >- + Optional. AllowPrivilegeEscalation controls whether a process can + gain more privileges than its parent process. This bool directly + controls if the no_new_privs flag will be set on the container + process. AllowPrivilegeEscalation is true always when the container + is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field + cannot be set when spec.os.name is windows. +optional + type: boolean + privileged: + type: boolean + description: Run container in privileged mode. + id: SecurityContext type: object - id: Repository - FetchReadTokenRequest: + description: Security options the container should be run with. + FetchReadWriteTokenResponse: type: object - properties: {} - id: FetchReadTokenRequest - description: Message for fetching SCM read token. - ChildStatusReference: + id: FetchReadWriteTokenResponse + properties: + expirationTime: + format: google-datetime + description: Expiration timestamp. Can be empty if unknown or non-expiring. + type: string + token: + description: The token content. + type: string + description: Message for responding to get read/write token. + WorkspaceDeclaration: type: object - id: ChildStatusReference - description: >- - ChildStatusReference is used to point to the statuses of individual - TaskRuns and Runs within this PipelineRun. properties: - type: - description: Output only. Type of the child reference. - enum: - - TYPE_UNSPECIFIED - - TASK_RUN - readOnly: true + description: type: string - enumDescriptions: - - Default enum type; should not be used. - - TaskRun. - whenExpressions: - type: array + description: Description is a human readable description of this volume. + mountPath: description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask - items: - $ref: '#/components/schemas/WhenExpression' - name: - description: Name is the name of the TaskRun or Run this is referencing. + MountPath overrides the directory that the volume will be made + available at. type: string - pipelineTaskName: + name: + description: Name is the name by which you can bind the volume at runtime. type: string + optional: + type: boolean description: >- - PipelineTaskName is the name of the PipelineTask this is - referencing. - AuditConfig: - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. + Optional. Optional marks a Workspace as not being required in + TaskRuns. By default this field is false and so declared workspaces + are required. + readOnly: + type: boolean + description: ReadOnly dictates whether a mounted volume is writable. + id: WorkspaceDeclaration + description: WorkspaceDeclaration is a declaration of a volume that a Task requires. + PipelineRun: + description: Message describing PipelineRun object properties: - service: - type: string - description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - auditLogConfigs: - description: The configuration for logging of each type of permission. + annotations: + description: User annotations. See https://google.aip.dev/128#annotations + additionalProperties: + type: string + type: object + childReferences: items: - $ref: '#/components/schemas/AuditLogConfig' + $ref: '#/components/schemas/ChildStatusReference' type: array - type: object - id: AuditConfig - PipelineRef: - properties: - name: + description: >- + Output only. List of TaskRun and Run names and PipelineTask names + for children of this PipelineRun. + readOnly: true + pipelineSpecYaml: + description: >- + Output only. Inline pipelineSpec yaml string, used by workflow run + requests. + readOnly: true type: string - description: Optional. Name of the Pipeline. - resolver: - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. + startTime: type: string - description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT - params: + readOnly: true + description: Output only. Time the pipeline is actually started. + format: google-datetime + conditions: items: - $ref: '#/components/schemas/Param' - type: array + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' description: >- - Params contains the parameters used to identify the referenced - Tekton resource. Example entries might include "repo" or "path" but - the set of params ultimately depends on the chosen resolver. - id: PipelineRef - description: PipelineRef can be used to refer to a specific instance of a Pipeline. - type: object - PipelineTask: - type: object - description: PipelineTask defines a task in a Pipeline. - properties: - params: - description: Params is a list of parameter names and values. - items: - $ref: '#/components/schemas/Param' + Output only. Kubernetes Conditions convention for PipelineRun status + and error. type: array - taskSpec: - description: Spec to instantiate this TaskRun. - $ref: '#/components/schemas/EmbeddedTask' - name: - description: Name of the task. + readOnly: true + etag: type: string - timeout: + description: Needed for declarative-friendly resources. + pipelineRef: + description: PipelineRef refer to a specific instance of a Pipeline. + $ref: '#/components/schemas/PipelineRef' + serviceAccount: type: string description: >- - Time after which the TaskRun times out. Defaults to 1 hour. - Specified TaskRun timeout should be less than 24h. - format: google-duration - whenExpressions: - description: Conditions that need to be true for the task to run. - items: - $ref: '#/components/schemas/WhenExpression' - type: array - retries: - type: integer - description: >- - Retries represents how many times this task should be retried in - case of task failure. - format: int32 - runAfter: + Service account used in the Pipeline. Deprecated; please use + security.service_account instead. + deprecated: true + workflow: + readOnly: true + type: string + description: Output only. The Workflow used to create this PipelineRun. + pipelineSpec: + description: PipelineSpec defines the desired state of Pipeline. + $ref: '#/components/schemas/PipelineSpec' + record: + type: string description: >- - RunAfter is the list of PipelineTask names that should be executed - before this Task executes. (Used to force a specific ordering in - graph execution.) - items: - type: string - type: array - workspaces: + Output only. The `Record` of this `PipelineRun`. Format: + `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` + readOnly: true + worker: + $ref: '#/components/schemas/Worker' + description: Optional. Worker configuration. + skippedTasks: description: >- - Workspaces maps workspaces from the pipeline spec to the workspaces - declared in the Task. - items: - $ref: '#/components/schemas/WorkspacePipelineTaskBinding' + Output only. List of tasks that were skipped due to when expressions + evaluating to false. type: array - taskRef: - $ref: '#/components/schemas/TaskRef' - description: Reference to a specific instance of a task. - id: PipelineTask - ListConnectionsResponse: - description: Message for response to listing Connections. - properties: - nextPageToken: - type: string - description: A token identifying a page of results the server should return. - connections: - description: The list of Connections. + readOnly: true items: - $ref: '#/components/schemas/Connection' - type: array - type: object - id: ListConnectionsResponse - Location: - properties: - metadata: - type: object + $ref: '#/components/schemas/SkippedTask' + timeouts: description: >- - Service-specific metadata. For example the available capacity at the - given location. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - name: + Time after which the Pipeline times out. Currently three keys are + accepted in the map pipeline, tasks and finally with + Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally + $ref: '#/components/schemas/TimeoutFields' + uid: + readOnly: true + description: Output only. A unique identifier for the `PipelineRun`. type: string - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - locationId: + createTime: + readOnly: true type: string - description: 'The canonical id for this location. For example: `"us-east1"`.' - displayName: description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". + Output only. Time at which the request to create the `PipelineRun` + was received. + format: google-datetime + completionTime: type: string - labels: - type: object - additionalProperties: - type: string - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - id: Location - type: object - description: A resource that represents a Google Cloud location. - GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: - id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - properties: - service: - description: >- - Required. The Service Directory service name. Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. + description: Output only. Time the pipeline completed. + format: google-datetime + readOnly: true + pipelineRunStatus: + description: Pipelinerun status the user can provide. Used for cancellation. type: string - type: object - description: >- - ServiceDirectoryConfig represents Service Directory configuration for a - connection. - WhenExpression: - description: Conditions that need to be true for the task to run. - type: object - id: WhenExpression - properties: - expressionOperator: - description: Operator that represents an Input's relationship to the values enum: - - EXPRESSION_OPERATOR_UNSPECIFIED - - IN - - NOT_IN - type: string + - PIPELINE_RUN_STATUS_UNSPECIFIED + - PIPELINE_RUN_CANCELLED enumDescriptions: - Default enum type; should not be used. - - Input is in values. - - Input is not in values. - input: + - Cancelled status. + workerPool: + type: string + description: Output only. The WorkerPool used to run this PipelineRun. + readOnly: true + security: + description: Optional. Security configuration. + $ref: '#/components/schemas/Security' + params: + items: + $ref: '#/components/schemas/Param' + type: array + description: Params is a list of parameter names and values. + updateTime: type: string + readOnly: true + format: google-datetime description: >- - Input is the string for guard checking which can be a static input - or an output from a parent Task. - values: + Output only. Time at which the request to update the `PipelineRun` + was received. + name: description: >- - Values is an array of strings, which is compared against the input, - for guard checking. + Output only. The `PipelineRun` name with format + `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` + readOnly: true + type: string + finallyStartTime: + readOnly: true + type: string + format: google-datetime + description: >- + Output only. FinallyStartTime is when all non-finally tasks have + been completed and only finally tasks are being executed. +optional + workspaces: + description: >- + Workspaces is a list of WorkspaceBindings from volumes to + workspaces. + type: array items: + $ref: '#/components/schemas/WorkspaceBinding' + gcbParams: + type: object + description: Output only. GCB default params. + readOnly: true + additionalProperties: type: string + results: + description: >- + Optional. Output only. List of results written out by the pipeline's + containers type: array - UserCredential: - id: UserCredential - properties: - username: + items: + $ref: '#/components/schemas/PipelineRunResult' readOnly: true - description: Output only. The username associated to this token. - type: string - userTokenSecretVersion: - description: >- - Required. A SecretManager resource containing the user token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. - type: string + resolvedPipelineSpec: + readOnly: true + description: Output only. The exact PipelineSpec used to instantiate the run. + $ref: '#/components/schemas/PipelineSpec' + provenance: + description: Optional. Provenance configuration. + $ref: '#/components/schemas/Provenance' + type: object + id: PipelineRun + Empty: + properties: {} description: >- - Represents a personal access token that authorized the Connection, and - associated metadata. + 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); } type: object - PropertySpec: + id: Empty + ParamValue: + description: Parameter value. properties: type: - description: A type for the object. enum: - TYPE_UNSPECIFIED - STRING + - ARRAY + - OBJECT + description: Type of parameter. type: string enumDescriptions: - Default enum type; should not be used. - Default - id: PropertySpec + - Array type + - Object type + arrayVal: + items: + type: string + description: Value of the parameter if type is array. + type: array + stringVal: + description: Value of the parameter if type is string. + type: string + objectVal: + description: Optional. Value of the parameter if type is object. + type: object + additionalProperties: + type: string type: object - description: PropertySpec holds information about a property in an object. - Step: - description: >- - Step embeds the Container type, which allows it to include fields not - provided by Container. - id: Step + id: ParamValue + FetchReadWriteTokenRequest: + description: Message for fetching SCM read/write token. type: object + id: FetchReadWriteTokenRequest + properties: {} + VolumeSource: properties: - timeout: - format: google-duration - type: string - description: Time after which the Step times out. Defaults to never. + emptyDir: + description: A temporary directory that shares a pod's lifetime. + $ref: '#/components/schemas/EmptyDirVolumeSource' name: - description: Name of the container specified as a DNS_LABEL. type: string - args: - description: Arguments to the entrypoint. - items: - type: string - type: array - params: - items: - $ref: '#/components/schemas/Param' - type: array - description: Optional. Optional parameters passed to the StepAction. - workingDir: - description: Container's working directory. + description: >- + Name of the Volume. Must be a DNS_LABEL and unique within the pod. + More info: + https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + description: Volumes available to mount. + type: object + id: VolumeSource + Operation: + id: Operation + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + properties: + error: + $ref: '#/components/schemas/Status' + description: >- + The error result of the operation in case of failure or + cancellation. + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + name: type: string - image: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + done: + type: boolean + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + Binding: + properties: + role: type: string - description: Docker image name. - env: - description: List of environment variables to set in the container. + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + condition: + $ref: '#/components/schemas/Expr' + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + members: type: array items: - $ref: '#/components/schemas/EnvVar' - onError: + type: string + description: >- + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + id: Binding + type: object + description: Associates `members`, or principals, with a `role`. + PipelineRunResult: + id: PipelineRunResult + description: PipelineRunResult used to describe the results of a pipeline + properties: + name: + description: Output only. Name of the TaskRun type: string + readOnly: true + value: + readOnly: true + $ref: '#/components/schemas/ResultValue' + description: Output only. Value of the result. + type: object + GoogleDevtoolsCloudbuildV2GitLabConfig: + properties: + hostUri: description: >- - Optional. OnError defines the exiting behavior on error can be set - to [ continue | stopAndFail ] - enumDescriptions: - - Default enum type; should not be used. - - >- - StopAndFail indicates exit if the step/task exits with non-zero - exit code - - >- - Continue indicates continue executing the rest of the steps/tasks - irrespective of the exit code - enum: - - ON_ERROR_TYPE_UNSPECIFIED - - STOP_AND_FAIL - - CONTINUE - ref: - $ref: '#/components/schemas/StepRef' - description: Optional. Optional reference to a remote StepAction. - securityContext: + Optional. The URI of the GitLab Enterprise host this connection is + for. If not specified, the default value is https://gitlab.com. + type: string + authorizerCredential: + $ref: '#/components/schemas/UserCredential' + description: >- + Required. A GitLab personal access token with the `api` scope + access. + sslCa: + type: string + description: Optional. SSL certificate to use for requests to GitLab Enterprise. + webhookSecretSecretVersion: + type: string + description: >- + Required. Immutable. SecretManager resource containing the webhook + secret of a GitLab Enterprise project, formatted as + `projects/*/secrets/*/versions/*`. + serviceDirectoryConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + description: >- + Optional. Configuration for using Service Directory to privately + connect to a GitLab Enterprise server. This should only be set if + the GitLab Enterprise server is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the GitLab + Enterprise server will be made over the public internet. + serverVersion: + description: >- + Output only. Version of the GitLab Enterprise server running on the + `host_uri`. + readOnly: true + type: string + readAuthorizerCredential: + description: >- + Required. A GitLab personal access token with the minimum `read_api` + scope access. + $ref: '#/components/schemas/UserCredential' + type: object + description: >- + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. + id: GoogleDevtoolsCloudbuildV2GitLabConfig + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + etag: description: >- - Optional. SecurityContext defines the security options the Step - should be run with. If set, the fields of SecurityContext override - the equivalent fields of PodSecurityContext. More info: - https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - +optional - $ref: '#/components/schemas/SecurityContext' - script: + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. type: string - description: The contents of an executable file to execute. - volumeMounts: + format: byte + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. items: - $ref: '#/components/schemas/VolumeMount' + $ref: '#/components/schemas/Binding' type: array - description: Pod volumes to mount into the container's filesystem. - command: + version: + type: integer + format: int32 + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. items: - type: string + $ref: '#/components/schemas/AuditConfig' type: array - description: Entrypoint array. - Security: - description: Security configuration. + SetIamPolicyRequest: + description: Request message for `SetIamPolicy` method. + id: SetIamPolicyRequest properties: - serviceAccount: - type: string - description: IAM service account whose credentials will be used at runtime. - privilegeMode: - deprecated: true - description: Optional. Privilege mode. - enumDescriptions: - - Default to PRIVILEGED. - - Privileged mode. - - Unprivileged mode. + policy: + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/Policy' + updateMask: type: string - enum: - - PRIVILEGE_MODE_UNSPECIFIED - - PRIVILEGED - - UNPRIVILEGED - id: Security + format: google-fieldmask + description: >- + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` type: object - Probe: + GitHubConfig: + id: GitHubConfig + description: Configuration for connections to github.com. type: object - description: >- - Probe describes a health check to be performed against a container to - determine whether it is alive or ready to receive traffic. - id: Probe - properties: - exec: - $ref: '#/components/schemas/ExecAction' - description: Optional. Exec specifies the action to take. +optional - periodSeconds: - description: >- - Optional. How often (in seconds) to perform the probe. Default to 10 - seconds. Minimum value is 1. +optional - type: integer - format: int32 - Expr: - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - id: Expr properties: - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - location: - type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. + appInstallationId: type: string - description: + description: Optional. GitHub App installation id. + format: int64 + authorizerCredential: + $ref: '#/components/schemas/OAuthCredential' description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string + Optional. OAuth credential of the account that authorized the Cloud + Build GitHub App. It is recommended to use a robot account instead + of a human user account. The OAuth token must be tied to the Cloud + Build GitHub App. + StepRef: + description: A reference to a remote Step, i.e. a StepAction. + id: StepRef type: object - WorkspacePipelineTaskBinding: - id: WorkspacePipelineTaskBinding properties: - subPath: - type: string - description: >- - Optional. SubPath is optionally a directory on the volume which - should be used for this binding (i.e. the volume will be mounted at - this sub directory). +optional name: + description: Optional. Name of the step. type: string - description: Name of the workspace as declared by the task. - workspace: - type: string - description: Name of the workspace declared by the pipeline. - type: object - description: >- - WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to - the workspaces declared in the Task. - 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); } - type: object - id: Empty - properties: {} - StepTemplate: - type: object - properties: - env: - items: - $ref: '#/components/schemas/EnvVar' + params: type: array - description: >- - Optional. List of environment variables to set in the Step. Cannot - be updated. - volumeMounts: - description: Optional. Pod volumes to mount into the container's filesystem. + description: Optional. Parameters used to control the resolution. items: - $ref: '#/components/schemas/VolumeMount' - type: array - id: StepTemplate + $ref: '#/components/schemas/Param' + resolver: + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT + description: Optional. Type of the resolver. + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + type: string + SkippedTask: description: >- - StepTemplate can be used as the basis for all step containers within the - Task, so that the steps inherit settings on the base container. - VolumeSource: + SkippedTask is used to describe the Tasks that were skipped due to their + When Expressions evaluating to False. type: object + id: SkippedTask properties: - emptyDir: - $ref: '#/components/schemas/EmptyDirVolumeSource' - description: A temporary directory that shares a pod's lifetime. name: - description: >- - Name of the Volume. Must be a DNS_LABEL and unique within the pod. - More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string - description: Volumes available to mount. - id: VolumeSource - BatchCreateRepositoriesRequest: - id: BatchCreateRepositoriesRequest - description: Message for creating repositoritories in batch. - properties: - requests: + description: Name is the Pipeline Task name + whenExpressions: description: >- - Required. The request messages specifying the repositories to - create. + WhenExpressions is the list of checks guarding the execution of the + PipelineTask type: array items: - $ref: '#/components/schemas/CreateRepositoryRequest' - type: object - Binding: + $ref: '#/components/schemas/WhenExpression' + reason: + description: Output only. Reason is the cause of the PipelineTask being skipped. + type: string + readOnly: true + StepTemplate: type: object - description: Associates `members`, or principals, with a `role`. + id: StepTemplate properties: - condition: - $ref: '#/components/schemas/Expr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - members: + volumeMounts: + items: + $ref: '#/components/schemas/VolumeMount' + type: array + description: Optional. Pod volumes to mount into the container's filesystem. + env: description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + Optional. List of environment variables to set in the Step. Cannot + be updated. items: - type: string + $ref: '#/components/schemas/EnvVar' type: array - id: Binding - FetchReadWriteTokenResponse: - id: FetchReadWriteTokenResponse - description: Message for responding to get read/write token. - type: object + description: >- + StepTemplate can be used as the basis for all step containers within the + Task, so that the steps inherit settings on the base container. + FetchReadTokenResponse: + id: FetchReadTokenResponse properties: - expirationTime: - description: Expiration timestamp. Can be empty if unknown or non-expiring. - format: google-datetime - type: string token: description: The token content. type: string - PipelineRunResult: + expirationTime: + type: string + format: google-datetime + description: Expiration timestamp. Can be empty if unknown or non-expiring. + description: Message for responding to get read token. + type: object + VolumeMount: type: object - description: PipelineRunResult used to describe the results of a pipeline properties: + subPathExpr: + description: >- + Expanded path within the volume from which the container's volume + should be mounted. Behaves similarly to SubPath but environment + variable references $(VAR_NAME) are expanded using the container's + environment. Defaults to "" (volume's root). + type: string name: - readOnly: true type: string - description: Output only. Name of the TaskRun - value: - readOnly: true - description: Output only. Value of the result. - $ref: '#/components/schemas/ResultValue' - id: PipelineRunResult - FetchGitRefsResponse: - id: FetchGitRefsResponse + description: Name of the volume. + mountPath: + description: >- + Path within the container at which the volume should be mounted. + Must not contain ':'. + type: string + readOnly: + type: boolean + description: >- + Mounted read-only if true, read-write otherwise (false or + unspecified). + subPath: + type: string + description: >- + Path within the volume from which the container's volume should be + mounted. Defaults to "" (volume's root). + description: Pod volumes to mount into the container's filesystem. + id: VolumeMount + ResultValue: type: object properties: - refNames: + type: + description: Output only. The type of data that the result holds. + type: string + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + readOnly: true + objectVal: + type: object + description: Value of the result if type is object. + additionalProperties: + type: string + stringVal: + type: string + description: Value of the result if type is string. + arrayVal: type: array + description: Value of the result if type is array. items: type: string - description: Name of the refs fetched. + description: ResultValue holds different types of data for a single result. + id: ResultValue + FetchLinkableRepositoriesResponse: + properties: nextPageToken: - description: A token identifying a page of results the server should return. type: string - description: Response for fetching git refs - FetchReadWriteTokenRequest: - description: Message for fetching SCM read/write token. + description: A token identifying a page of results the server should return. + repositories: + items: + $ref: '#/components/schemas/Repository' + description: repositories ready to be created. + type: array type: object - id: FetchReadWriteTokenRequest - properties: {} - EmbeddedTask: - description: EmbeddedTask defines a Task that is embedded in a Pipeline. + description: Response message for FetchLinkableRepositories. + id: FetchLinkableRepositoriesResponse + Security: + id: Security properties: - taskSpec: - $ref: '#/components/schemas/TaskSpec' - description: Spec to instantiate this TaskRun. - annotations: - description: User annotations. See https://google.aip.dev/128#annotations - additionalProperties: - type: string - type: object - id: EmbeddedTask + privilegeMode: + type: string + description: Optional. Privilege mode. + enumDescriptions: + - Default to PRIVILEGED. + - Privileged mode. + - Unprivileged mode. + enum: + - PRIVILEGE_MODE_UNSPECIFIED + - PRIVILEGED + - UNPRIVILEGED + deprecated: true + serviceAccount: + description: IAM service account whose credentials will be used at runtime. + type: string + type: object + description: Security configuration. + PipelineResult: type: object - Param: properties: - value: - description: Value of the parameter. - $ref: '#/components/schemas/ParamValue' name: + readOnly: true + description: Output only. Name of the result. type: string - description: Name of the parameter. - id: Param - type: object - description: >- - Param defined with name and value. PipelineRef can be used to refer to a - specific instance of a Pipeline. + value: + $ref: '#/components/schemas/ResultValue' + description: Output only. Value of the result. + readOnly: true + description: + readOnly: true + description: Output only. Description of the result. + type: string + type: + type: string + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + description: Output only. The type of data that the result holds. + readOnly: true + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + description: A value produced by a Pipeline. + id: PipelineResult Sidecar: + type: object description: Sidecars run alongside the Task's step containers. id: Sidecar properties: + securityContext: + description: Optional. Security options the container should be run with. + $ref: '#/components/schemas/SecurityContext' + command: + type: array + description: Entrypoint array. + items: + type: string + workingDir: + type: string + description: Container's working directory. volumeMounts: description: Pod volumes to mount into the container's filesystem. - type: array items: $ref: '#/components/schemas/VolumeMount' + type: array image: type: string description: Docker image name. - env: - description: List of environment variables to set in the container. - items: - $ref: '#/components/schemas/EnvVar' - type: array script: - type: string description: The contents of an executable file to execute. - securityContext: - $ref: '#/components/schemas/SecurityContext' - description: Optional. Security options the container should be run with. - name: - type: string - description: Name of the Sidecar. - workingDir: type: string - description: Container's working directory. - args: + env: + type: array items: - type: string + $ref: '#/components/schemas/EnvVar' + description: List of environment variables to set in the container. + args: type: array - description: Arguments to the entrypoint. - command: items: type: string - description: Entrypoint array. - type: array + description: Arguments to the entrypoint. + name: + type: string + description: Name of the Sidecar. readinessProbe: $ref: '#/components/schemas/Probe' description: >- @@ -2143,296 +2204,247 @@ components: updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional - type: object - RunWorkflowCustomOperationMetadata: + CreateRepositoryRequest: + description: Message for creating a Repository. properties: - verb: - type: string - description: Output only. Name of the verb executed by the operation. - readOnly: true - endTime: - type: string - readOnly: true - description: Output only. The time the operation finished running. - format: google-datetime - pipelineRunId: - readOnly: true - type: string - description: Output only. ID of the pipeline run created by RunWorkflow. - apiVersion: - readOnly: true + repositoryId: type: string - description: Output only. API version used to start the operation. - requestedCancellation: - type: boolean - readOnly: true description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - createTime: - readOnly: true - format: google-datetime - description: Output only. The time the operation was created. - type: string - target: + Required. The ID to use for the repository, which will become the + final component of the repository's resource name. This ID should be + unique in the connection. Allows alphanumeric characters and any of + -._~%!$&'()*+,;=@. + repository: + $ref: '#/components/schemas/Repository' + description: Required. The repository to create. + parent: type: string description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true - id: RunWorkflowCustomOperationMetadata - description: >- - Represents the custom metadata of the RunWorkflow long-running - operation. + Required. The connection to contain the repository. If the request + is part of a BatchCreateRepositoriesRequest, this field should be + empty or match the parent specified there. type: object - VolumeMount: - id: VolumeMount - description: Pod volumes to mount into the container's filesystem. + id: CreateRepositoryRequest + OAuthCredential: properties: - name: + oauthTokenSecretVersion: + description: >- + Optional. A SecretManager resource containing the OAuth token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. type: string - description: Name of the volume. - subPath: + username: + description: Output only. The username associated to this token. + readOnly: true type: string - description: >- - Path within the volume from which the container's volume should be - mounted. Defaults to "" (volume's root). - mountPath: - description: >- - Path within the container at which the volume should be mounted. - Must not contain ':'. + type: object + description: >- + Represents an OAuth token of the account that authorized the Connection, + and associated metadata. + id: OAuthCredential + UserCredential: + properties: + userTokenSecretVersion: type: string - readOnly: - description: >- - Mounted read-only if true, read-write otherwise (false or - unspecified). - type: boolean - subPathExpr: description: >- - Expanded path within the volume from which the container's volume - should be mounted. Behaves similarly to SubPath but environment - variable references $(VAR_NAME) are expanded using the container's - environment. Defaults to "" (volume's root). + Required. A SecretManager resource containing the user token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. + username: + readOnly: true + description: Output only. The username associated to this token. type: string + description: >- + Represents a personal access token that authorized the Connection, and + associated metadata. + id: UserCredential type: object - SkippedTask: - id: SkippedTask + Step: type: object + id: Step properties: - reason: - description: Output only. Reason is the cause of the PipelineTask being skipped. - readOnly: true - type: string - name: - type: string - description: Name is the Pipeline Task name - whenExpressions: - description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask + env: items: - $ref: '#/components/schemas/WhenExpression' + $ref: '#/components/schemas/EnvVar' + description: List of environment variables to set in the container. type: array - description: >- - SkippedTask is used to describe the Tasks that were skipped due to their - When Expressions evaluating to False. - Policy: - id: Policy - properties: - version: + command: + type: array + description: Entrypoint array. + items: + type: string + securityContext: description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - format: int32 - type: integer - auditConfigs: + Optional. SecurityContext defines the security options the Step + should be run with. If set, the fields of SecurityContext override + the equivalent fields of PodSecurityContext. More info: + https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + +optional + $ref: '#/components/schemas/SecurityContext' + ref: + $ref: '#/components/schemas/StepRef' + description: Optional. Optional reference to a remote StepAction. + args: + description: Arguments to the entrypoint. items: - $ref: '#/components/schemas/AuditConfig' + type: string type: array - description: Specifies cloud audit logging configuration for this policy. - etag: + onError: + type: string description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - format: byte + Optional. OnError defines the exiting behavior on error can be set + to [ continue | stopAndFail ] + enumDescriptions: + - Default enum type; should not be used. + - >- + StopAndFail indicates exit if the step/task exits with non-zero + exit code + - >- + Continue indicates continue executing the rest of the steps/tasks + irrespective of the exit code + enum: + - ON_ERROR_TYPE_UNSPECIFIED + - STOP_AND_FAIL + - CONTINUE + script: type: string - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. + description: The contents of an executable file to execute. + timeout: + description: Time after which the Step times out. Defaults to never. + type: string + format: google-duration + volumeMounts: items: - $ref: '#/components/schemas/Binding' + $ref: '#/components/schemas/VolumeMount' + description: Pod volumes to mount into the container's filesystem. + type: array + image: + type: string + description: Docker image name. + workingDir: + type: string + description: Container's working directory. + params: + description: Optional. Optional parameters passed to the StepAction. type: array + items: + $ref: '#/components/schemas/Param' + name: + type: string + description: Name of the container specified as a DNS_LABEL. description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + Step embeds the Container type, which allows it to include fields not + provided by Container. + Expr: type: object - Connection: description: >- - A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data - Center, Bitbucket Cloud or GitLab. - type: object + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + id: Expr properties: - updateTime: + description: + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + type: string + title: type: string - format: google-datetime description: >- - Output only. Server assigned timestamp for when the connection was - updated. - readOnly: true - githubConfig: - description: Configuration for connections to github.com. - $ref: '#/components/schemas/GitHubConfig' - etag: + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + location: type: string description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. - bitbucketDataCenterConfig: - description: Configuration for connections to Bitbucket Data Center. - $ref: '#/components/schemas/BitbucketDataCenterConfig' - gitlabConfig: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + expression: + type: string description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. - annotations: - description: Optional. Allows clients to store small amounts of arbitrary data. - additionalProperties: + Textual representation of an expression in Common Expression + Language syntax. + Capabilities: + description: >- + Capabilities adds and removes POSIX capabilities from running + containers. + type: object + id: Capabilities + properties: + drop: + description: Optional. Removed capabilities +optional + items: type: string - type: object - name: - type: string + type: array + add: + items: + type: string + type: array + description: Optional. Added capabilities +optional + BitbucketCloudConfig: + type: object + description: Configuration for connections to Bitbucket Cloud. + properties: + readAuthorizerCredential: description: >- - Immutable. The resource name of the connection, in the format - `projects/{project}/locations/{location}/connections/{connection_id}`. - reconciling: - readOnly: true + Required. An access token with the `repository` access. It can be + either a workspace, project or repository access token. It's + recommended to use a system account to generate the credentials. + $ref: '#/components/schemas/UserCredential' + webhookSecretSecretVersion: + type: string description: >- - Output only. Set to true when the connection is being set up or - updated in the background. - type: boolean - githubEnterpriseConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - description: Configuration for connections to an instance of GitHub Enterprise. - bitbucketCloudConfig: - $ref: '#/components/schemas/BitbucketCloudConfig' - description: Configuration for connections to Bitbucket Cloud. - createTime: + Required. SecretManager resource containing the webhook secret used + to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. + authorizerCredential: + $ref: '#/components/schemas/UserCredential' description: >- - Output only. Server assigned timestamp for when the connection was - created. - readOnly: true - format: google-datetime - type: string - installationState: - readOnly: true - description: Output only. Installation state of the Connection. - $ref: '#/components/schemas/InstallationState' - disabled: + Required. An access token with the `webhook`, `repository`, + `repository:admin` and `pullrequest` scope access. It can be either + a workspace, project or repository access token. It's recommended to + use a system account to generate these credentials. + workspace: description: >- - Optional. If disabled is set to true, functionality is disabled for - this connection. Repository based API methods and webhooks - processing for repositories in this connection will be disabled. - type: boolean - id: Connection - Worker: - description: Configuration for the worker. - type: object - properties: - machineType: - description: Optional. Machine type of a worker, default is "e2-standard-2". + Required. The Bitbucket Cloud Workspace ID to be connected to Google + Cloud Platform. type: string - id: Worker + id: BitbucketCloudConfig Status: - id: Status type: object properties: message: + type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - type: string details: items: - type: object additionalProperties: - description: Properties of the object. Contains field @type with type URL. type: any + description: Properties of the object. Contains field @type with type URL. + type: object description: >- A list of messages that carry the error details. There is a common set of message types for APIs to use. type: array code: - format: int32 type: integer + format: int32 description: The status code, which should be an enum value of google.rpc.Code. description: >- The `Status` type defines a logical error model that is suitable for @@ -2442,41 +2454,35 @@ components: details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - SecretVolumeSource: - id: SecretVolumeSource - properties: - secretName: - description: Name of the secret referenced by the WorkspaceBinding. - type: string - secretVersion: - description: >- - Optional. Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* - type: string - description: Secret Volume Source. - type: object + id: Status parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + _.xgafv: + description: V1 error format. in: query - name: uploadType + name: $.xgafv schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: fields + name: oauth_token schema: type: string - _.xgafv: - description: V1 error format. + callback: + description: JSONP + in: query + name: callback + schema: + type: string + access_token: + description: OAuth access token. in: query - name: $.xgafv + name: access_token schema: type: string - enum: - - '1' - - '2' alt: description: Data format for response. in: query @@ -2496,6 +2502,24 @@ components: name: quotaUser schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -2505,294 +2529,270 @@ components: name: key schema: type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string x-stackQL-resources: - operations: - id: google.cloudbuild.operations - name: operations - title: Operations + connections: + id: google.cloudbuild.connections + name: connections + title: Connections methods: - projects_locations_operations_get: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_cancel: + objectKey: $.connections + projects_locations_connections_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - insert: [] - update: [] - replace: [] - delete: [] - repositories: - id: google.cloudbuild.repositories - name: repositories - title: Repositories - methods: - projects_locations_connections_repositories_access_read_token: + projects_locations_connections_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadToken/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_delete: + projects_locations_connections_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_get: + projects_locations_connections_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_create: + projects_locations_connections_process_webhook: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:processWebhook/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + insert: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create + update: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete + connections_iam_policies: + id: google.cloudbuild.connections_iam_policies + name: connections_iam_policies + title: Connections_iam_policies + methods: + projects_locations_connections_test_iam_permissions: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.repositories - projects_locations_connections_repositories_access_read_write_token: + projects_locations_connections_set_iam_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadWriteToken/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_batch_create: + projects_locations_connections_get_iam_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.bindings sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_get - - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_list - insert: - - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_create - - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_batch_create + #/components/x-stackQL-resources/connections_iam_policies/methods/projects_locations_connections_get_iam_policy + insert: [] update: [] - replace: [] - delete: + replace: - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_delete - repositories_git_refs: - id: google.cloudbuild.repositories_git_refs - name: repositories_git_refs - title: Repositories_git_refs + #/components/x-stackQL-resources/connections_iam_policies/methods/projects_locations_connections_set_iam_policy + delete: [] + connections_linkable_repositories: + id: google.cloudbuild.connections_linkable_repositories + name: connections_linkable_repositories + title: Connections_linkable_repositories methods: - projects_locations_connections_repositories_fetch_git_refs: + projects_locations_connections_fetch_linkable_repositories: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:fetchGitRefs/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:fetchLinkableRepositories/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/repositories_git_refs/methods/projects_locations_connections_repositories_fetch_git_refs + #/components/x-stackQL-resources/connections_linkable_repositories/methods/projects_locations_connections_fetch_linkable_repositories insert: [] update: [] replace: [] delete: [] - connections: - id: google.cloudbuild.connections - name: connections - title: Connections + repositories: + id: google.cloudbuild.repositories + name: repositories + title: Repositories methods: - projects_locations_connections_get: + projects_locations_connections_repositories_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_patch: + projects_locations_connections_repositories_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_delete: + projects_locations_connections_repositories_access_read_write_token: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadWriteToken/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_create: + projects_locations_connections_repositories_batch_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_list: + projects_locations_connections_repositories_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_process_webhook: + projects_locations_connections_repositories_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:processWebhook/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.repositories + projects_locations_connections_repositories_access_read_token: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadToken/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_get - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_list insert: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create - update: + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_batch_create - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_create + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete - connections_linkable_repositories: - id: google.cloudbuild.connections_linkable_repositories - name: connections_linkable_repositories - title: Connections_linkable_repositories + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_delete + repositories_git_refs: + id: google.cloudbuild.repositories_git_refs + name: repositories_git_refs + title: Repositories_git_refs methods: - projects_locations_connections_fetch_linkable_repositories: + projects_locations_connections_repositories_fetch_git_refs: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:fetchLinkableRepositories/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:fetchGitRefs/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections_linkable_repositories/methods/projects_locations_connections_fetch_linkable_repositories + #/components/x-stackQL-resources/repositories_git_refs/methods/projects_locations_connections_repositories_fetch_git_refs insert: [] update: [] replace: [] delete: [] - connections_iam_policies: - id: google.cloudbuild.connections_iam_policies - name: connections_iam_policies - title: Connections_iam_policies + operations: + id: google.cloudbuild.operations + name: operations + title: Operations methods: - projects_locations_connections_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_get_iam_policy: + projects_locations_operations_cancel: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:getIamPolicy/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_connections_set_iam_policy: + projects_locations_operations_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections_iam_policies/methods/projects_locations_connections_get_iam_policy + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/connections_iam_policies/methods/projects_locations_connections_set_iam_policy + update: [] + replace: [] delete: [] locations: id: google.cloudbuild.locations name: locations title: Locations methods: - projects_locations_list: + projects_locations_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations - projects_locations_get: + projects_locations_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.locations sqlVerbs: select: - $ref: >- @@ -2804,25 +2804,22 @@ components: replace: [] delete: [] paths: - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v2/projects/{projectsId}/locations/{locationsId}/connections: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' 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. - operationId: cloudbuild.projects.locations.operations.get + description: Lists Connections in a given project and location. + operationId: cloudbuild.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2834,7 +2831,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListConnectionsResponse' parameters: - in: path name: projectsId @@ -2846,30 +2843,23 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - 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`. - operationId: cloudbuild.projects.locations.operations.cancel + description: Creates a Connection. + operationId: cloudbuild.projects.locations.connections.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/CancelOperationRequest' + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2881,7 +2871,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -2893,21 +2883,25 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: connectionId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: parameters: *ref_1 post: - description: Fetches read token of a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.accessReadToken + 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. + operationId: cloudbuild.projects.locations.connections.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/FetchReadTokenRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2919,7 +2913,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadTokenResponse' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -2936,16 +2930,16 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: parameters: *ref_1 - delete: - description: Deletes a single repository. - operationId: cloudbuild.projects.locations.connections.repositories.delete + patch: + description: Updates a single connection. + operationId: cloudbuild.projects.locations.connections.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2974,13 +2968,13 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: validateOnly + name: allowMissing schema: type: boolean - in: query @@ -2988,8 +2982,8 @@ paths: schema: type: string get: - description: Gets details of a single repository. - operationId: cloudbuild.projects.locations.connections.repositories.get + description: Gets details of a single connection. + operationId: cloudbuild.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3001,7 +2995,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Repository' + $ref: '#/components/schemas/Connection' parameters: - in: path name: projectsId @@ -3018,21 +3012,9 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: - parameters: *ref_1 - post: - description: Creates a Repository. - operationId: cloudbuild.projects.locations.connections.repositories.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Repository' + delete: + description: Deletes a single connection. + operationId: cloudbuild.projects.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3062,12 +3044,20 @@ paths: schema: type: string - in: query - name: repositoryId + name: validateOnly + schema: + type: boolean + - in: query + name: etag schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableRepositories: + parameters: *ref_1 get: - description: Lists Repositories in a given connection. - operationId: cloudbuild.projects.locations.connections.repositories.list + description: >- + FetchLinkableRepositories get repositories from SCM that are accessible + and could be added to the connection. + operationId: cloudbuild.projects.locations.connections.fetchLinkableRepositories security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3079,7 +3069,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListRepositoriesResponse' + $ref: '#/components/schemas/FetchLinkableRepositoriesResponse' parameters: - in: path name: projectsId @@ -3096,30 +3086,61 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: type: string - - in: query - name: filter + /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: + parameters: *ref_1 + post: + description: ProcessWebhook is called by the external SCM for notifying of events. + operationId: cloudbuild.projects.locations.connections.processWebhook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string - in: query - name: pageSize + name: webhookKey schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: parameters: *ref_1 post: - description: Fetches read/write token of a given repository. - operationId: >- - cloudbuild.projects.locations.connections.repositories.accessReadWriteToken + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: cloudbuild.projects.locations.connections.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/FetchReadWriteTokenRequest' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3131,7 +3152,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadWriteTokenResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -3148,16 +3169,13 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: parameters: *ref_1 get: - description: Fetch the list of branches or tags for a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: cloudbuild.projects.locations.connections.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3169,7 +3187,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchGitRefsResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -3186,34 +3204,16 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: refType - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}: parameters: *ref_1 - post: - description: Creates multiple repositories inside a connection. - operationId: cloudbuild.projects.locations.connections.repositories.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateRepositoriesRequest' + get: + description: Gets details of a single repository. + operationId: cloudbuild.projects.locations.connections.repositories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3225,7 +3225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Repository' parameters: - in: path name: projectsId @@ -3242,11 +3242,14 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: - parameters: *ref_1 - get: - description: Gets details of a single connection. - operationId: cloudbuild.projects.locations.connections.get + - in: path + name: repositoriesId + required: true + schema: + type: string + delete: + description: Deletes a single repository. + operationId: cloudbuild.projects.locations.connections.repositories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3258,7 +3261,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3275,14 +3278,24 @@ paths: required: true schema: type: string - patch: - description: Updates a single connection. - operationId: cloudbuild.projects.locations.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: + parameters: *ref_1 + get: + description: Fetch the list of branches or tags for a given repository. + operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3294,7 +3307,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchGitRefsResponse' parameters: - in: path name: projectsId @@ -3311,22 +3324,35 @@ paths: required: true schema: type: string + - in: path + name: repositoriesId + required: true + schema: + type: string - in: query - name: etag + name: refType schema: type: string - in: query - name: allowMissing + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - delete: - description: Deletes a single connection. - operationId: cloudbuild.projects.locations.connections.delete + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: + parameters: *ref_1 + post: + description: Fetches read/write token of a given repository. + operationId: >- + cloudbuild.projects.locations.connections.repositories.accessReadWriteToken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FetchReadWriteTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3338,7 +3364,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchReadWriteTokenResponse' parameters: - in: path name: projectsId @@ -3355,24 +3381,21 @@ paths: required: true schema: type: string - - in: query - name: etag + - in: path + name: repositoriesId + required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - /v2/projects/{projectsId}/locations/{locationsId}/connections: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: parameters: *ref_1 post: - description: Creates a Connection. - operationId: cloudbuild.projects.locations.connections.create + description: Creates multiple repositories inside a connection. + operationId: cloudbuild.projects.locations.connections.repositories.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/BatchCreateRepositoriesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3396,13 +3419,21 @@ paths: required: true schema: type: string - - in: query - name: connectionId + - in: path + name: connectionsId + required: true schema: type: string - get: - description: Lists Connections in a given project and location. - operationId: cloudbuild.projects.locations.connections.list + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: + parameters: *ref_1 + post: + description: Creates a Repository. + operationId: cloudbuild.projects.locations.connections.repositories.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Repository' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3414,7 +3445,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3426,22 +3457,18 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: connectionsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: repositoryId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableRepositories: - parameters: *ref_1 get: - description: >- - FetchLinkableRepositories get repositories from SCM that are accessible - and could be added to the connection. - operationId: cloudbuild.projects.locations.connections.fetchLinkableRepositories + description: Lists Repositories in a given connection. + operationId: cloudbuild.projects.locations.connections.repositories.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3453,7 +3480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchLinkableRepositoriesResponse' + $ref: '#/components/schemas/ListRepositoriesResponse' parameters: - in: path name: projectsId @@ -3470,30 +3497,29 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: parameters: *ref_1 post: - 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. - operationId: cloudbuild.projects.locations.connections.testIamPermissions + description: Fetches read token of a given repository. + operationId: cloudbuild.projects.locations.connections.repositories.accessReadToken requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/FetchReadTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3505,7 +3531,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/FetchReadTokenResponse' parameters: - in: path name: projectsId @@ -3522,17 +3548,35 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: + - in: path + name: repositoriesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: ProcessWebhook is called by the external SCM for notifying of events. - operationId: cloudbuild.projects.locations.connections.processWebhook + 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`. + operationId: cloudbuild.projects.locations.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpBody' - security: [] + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform responses: '200': description: Successful response @@ -3551,17 +3595,19 @@ paths: required: true schema: type: string - - in: query - name: webhookKey + - in: path + name: operationsId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: cloudbuild.projects.locations.connections.getIamPolicy + 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. + operationId: cloudbuild.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3573,7 +3619,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3586,28 +3632,15 @@ paths: schema: type: string - in: path - name: connectionsId + name: operationsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: + /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: cloudbuild.projects.locations.connections.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + get: + description: Gets information about a location. + operationId: cloudbuild.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3619,7 +3652,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Location' parameters: - in: path name: projectsId @@ -3631,11 +3664,6 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string /v2/projects/{projectsId}/locations: parameters: *ref_1 get: @@ -3659,10 +3687,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: @@ -3672,31 +3696,7 @@ paths: name: filter schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_1 - get: - description: Gets information about a location. - operationId: cloudbuild.projects.locations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Location' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml index 8015539d..ae878742 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml @@ -7,8 +7,8 @@ info: title: Cloud Commerce Partner Procurement API description: Partner API for the Cloud Commerce Procurement Service. version: v1 - x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/marketplace/docs/partners/ servers: @@ -34,300 +34,55 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ResetAccountRequest: - description: Request message for PartnerProcurementService.ResetAccount. - properties: {} - id: ResetAccountRequest - type: object - Approval: - type: object - description: An approval for some action on an account. - id: Approval - properties: - state: - type: string - enumDescriptions: - - Sentinel value; do not use. - - >- - The approval is pending response from the provider. The approval - state can transition to Account.Approval.State.APPROVED or - Account.Approval.State.REJECTED. - - The approval has been granted by the provider. - - >- - The approval has been rejected by the provider. A provider may - choose to approve a previously rejected approval, so is it - possible to transition to Account.Approval.State.APPROVED. - description: Output only. The state of the approval. - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - name: - type: string - description: Output only. The name of the approval. - updateTime: - description: Optional. The last update timestamp of the approval. - type: string - format: google-datetime - reason: - type: string - description: Output only. An explanation for the state of the approval. - SuspendEntitlementRequest: - properties: - reason: - type: string - description: >- - A free-form reason string, explaining the reason for suspension - request. - description: >- - Request message for ParterProcurementService.SuspendEntitlement. This is - not yet supported. - type: object - id: SuspendEntitlementRequest ListAccountsResponse: + description: Response message for [PartnerProcurementService.ListAccounts[]. properties: nextPageToken: - type: string description: The token for fetching the next page. + type: string accounts: + type: array description: The list of accounts in this response. items: $ref: '#/components/schemas/Account' - type: array id: ListAccountsResponse - description: Response message for [PartnerProcurementService.ListAccounts[]. - type: object - Account: - id: Account - description: >- - Represents an account that was established by the customer on the - service provider's system. - type: object - properties: - name: - type: string - description: >- - Output only. The resource name of the account. Account names have - the form `accounts/{account_id}`. - updateTime: - description: Output only. The last update timestamp. - format: google-datetime - type: string - inputProperties: - description: >- - Output only. The custom properties that were collected from the user - to create this account. - type: object - deprecated: true - additionalProperties: - type: any - description: Properties of the object. - state: - enumDescriptions: - - >- - Default state of the account. It's only set to this value when the - account is first created and has not been initialized. - - >- - The customer has requested the creation of the account resource, - and the provider notification message is dispatched. This state - has been deprecated, as accounts now immediately transition to - AccountState.ACCOUNT_ACTIVE. - - >- - The account is active and ready for use. The next possible states - are: - Account getting deleted: After the user invokes delete from - another API. - enum: - - ACCOUNT_STATE_UNSPECIFIED - - ACCOUNT_ACTIVATION_REQUESTED - - ACCOUNT_ACTIVE - description: >- - Output only. The state of the account. This is used to decide - whether the customer is in good standing with the provider and is - able to make purchases. An account might not be able to make a - purchase if the billing account is suspended, for example. - type: string - createTime: - type: string - format: google-datetime - description: Output only. The creation timestamp. - provider: - type: string - description: >- - Output only. The identifier of the service provider that this - account was created against. Each service provider is assigned a - unique provider value when they onboard with Cloud Commerce - platform. - approvals: - items: - $ref: '#/components/schemas/Approval' - type: array - description: >- - Output only. The approvals for this account. These approvals are - used to track actions that are permitted or have been completed by a - customer within the context of the provider. This might include a - sign up flow or a provisioning step, for example, that the provider - can admit to having happened. - Consumer: - type: object - id: Consumer - properties: - project: - type: string - description: A project name with format `projects/`. - description: A resource using (consuming) this entitlement. - ApproveEntitlementRequest: - description: Request message for [PartnerProcurementService.ApproveEntitlement[]. - properties: - entitlementMigrated: - type: string - description: >- - Optional. The resource name of the entitlement that was migrated, - with the format - `providers/{provider_id}/entitlements/{entitlement_id}`. Should only - be sent when resources have been migrated from entitlement_migrated - to the new entitlement. Optional. - properties: - type: object - description: >- - Set of properties that should be associated with the entitlement. - Optional. - additionalProperties: - type: string - deprecated: true type: object - id: ApproveEntitlementRequest Entitlement: + id: Entitlement + type: object description: Represents a procured product of a customer. properties: - provider: - description: >- - Output only. The identifier of the service provider that this - entitlement was created against. Each service provider is assigned a - unique provider value when they onboard with Cloud Commerce - platform. - type: string - offer: - description: >- - Output only. The name of the offer that was procured. Field is empty - if order was not made using an offer. Format: - 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR - 'projects/{project}/services/{service}/standardOffers/{offer-id}', - depending on whether the offer is private or public. The {service} - in the name is the listing service of the offer. It could be either - the product service that the offer is referencing, or a generic - private offer parent service. We recommend that you don't build your - integration to rely on the meaning of this {service} part. - type: string - readOnly: true - orderId: - description: >- - Output only. The order ID of this entitlement, without any `orders/` - resource name prefix. - readOnly: true - type: string - inputProperties: - deprecated: true - description: >- - Output only. The custom properties that were collected from the user - to create this entitlement. - additionalProperties: - type: any - description: Properties of the object. - type: object - subscriptionEndTime: - description: >- - Output only. End time for the subscription corresponding to this - entitlement. - format: google-datetime - type: string - readOnly: true - newPendingOffer: - readOnly: true - type: string - description: >- - Output only. The name of the offer the entitlement is switching to - upon a pending plan change. Only exists if the pending plan change - is moving to an offer. This field isn't populated for entitlements - which aren't active yet. Format: - 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR - 'projects/{project}/services/{service}/standardOffers/{offer-id}', - depending on whether the offer is private or public. The {service} - in the name is the listing service of the offer. It could be either - the product service that the offer is referencing, or a generic - private offer parent service. We recommend that you don't build your - integration to rely on the meaning of this {service} part. product: deprecated: true - type: string description: >- Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer. - messageToUser: - description: >- - Provider-supplied message that is displayed to the end user. - Currently this is used to communicate progress and ETA for - provisioning. This field can be updated only when a user is waiting - for an action from the provider, i.e. entitlement state is - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This - field is cleared automatically when the entitlement state changes. - type: string - offerDuration: - description: >- - Output only. The offer duration of the current offer in ISO 8601 - duration format. Field is empty if entitlement was not made using an - offer. If the offer was created with a specified end date instead of - a duration, this field is empty. - readOnly: true - type: string - createTime: type: string - format: google-datetime - description: Output only. The creation timestamp. - offerEndTime: + orderId: readOnly: true - format: google-datetime - type: string - description: >- - Output only. End time for the Offer association corresponding to - this entitlement. The field is only populated if the entitlement is - currently associated with an Offer. - consumers: - type: array - items: - $ref: '#/components/schemas/Consumer' - description: Output only. The resources using this entitlement, if applicable. - plan: description: >- - Output only. The identifier of the plan that was procured. Required - if the product has plans. + Output only. The order ID of this entitlement, without any `orders/` + resource name prefix. + type: string + newPendingOfferDuration: type: string - entitlementBenefitIds: description: >- - Output only. The entitlement benefit IDs associated with the - purchase. + Output only. The duration of the new offer, in ISO 8601 duration + format. This field isn't populated for entitlements which aren't + active yet, only for pending offer changes. If the offer was created + with a specified end date instead of a duration, this field is + empty. readOnly: true - items: - type: string - type: array - account: - type: string + subscriptionEndTime: description: >- - Output only. The resource name of the account that this entitlement - is based on, if any. - usageReportingId: + Output only. End time for the subscription corresponding to this + entitlement. + format: google-datetime type: string - description: >- - Output only. The consumerId to use when reporting usage through the - Service Control API. See the consumerId field at [Reporting - Metrics](https://cloud.google.com/service-control/reporting-metrics) - for more details. This field is present only if the product has - usage-based billing configured. + readOnly: true cancellationReason: - type: string description: >- Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values @@ -337,22 +92,33 @@ components: has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields. - readOnly: true - newOfferEndTime: - format: google-datetime + readOnly: true + type: string + messageToUser: type: string description: >- - Output only. The end time of the new offer. If the offer was created - with a term instead of a specified end date, this field is empty. - This field is populated even if the entitlement isn't active yet. If - there's no upcoming offer, the field is be empty. + Provider-supplied message that is displayed to the end user. + Currently this is used to communicate progress and ETA for + provisioning. This field can be updated only when a user is waiting + for an action from the provider, i.e. entitlement state is + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This + field is cleared automatically when the entitlement state changes. + offer: readOnly: true - productExternalName: type: string - readOnly: true - description: Output only. The identifier of the product that was procured. + description: >- + Output only. The name of the offer that was procured. Field is empty + if order was not made using an offer. Format: + 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR + 'projects/{project}/services/{service}/standardOffers/{offer-id}', + depending on whether the offer is private or public. The {service} + in the name is the listing service of the offer. It could be either + the product service that the offer is referencing, or a generic + private offer parent service. We recommend that you don't build your + integration to rely on the meaning of this {service} part. state: - description: Output only. The state of the entitlement. + type: string enumDescriptions: - >- Default state of the entitlement. It's only set to this value when @@ -415,7 +181,7 @@ components: violation of terms-of-service of the provider etc.). As such, any remediating action needs to be taken externally, before the entitlement can be activated. This is not yet supported. - type: string + description: Output only. The state of the entitlement. enum: - ENTITLEMENT_STATE_UNSPECIFIED - ENTITLEMENT_ACTIVATION_REQUESTED @@ -425,58 +191,193 @@ components: - ENTITLEMENT_PENDING_PLAN_CHANGE - ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL - ENTITLEMENT_SUSPENDED - newPendingOfferDuration: + createTime: + description: Output only. The creation timestamp. + type: string + format: google-datetime + updateTime: type: string + format: google-datetime + description: Output only. The last update timestamp. + consumers: + items: + $ref: '#/components/schemas/Consumer' + type: array + description: Output only. The resources using this entitlement, if applicable. + newOfferEndTime: + description: >- + Output only. The end time of the new offer. If the offer was created + with a term instead of a specified end date, this field is empty. + This field is populated even if the entitlement isn't active yet. If + there's no upcoming offer, the field is be empty. + format: google-datetime readOnly: true + type: string + name: + type: string description: >- - Output only. The duration of the new offer, in ISO 8601 duration - format. This field isn't populated for entitlements which aren't - active yet, only for pending offer changes. If the offer was created - with a specified end date instead of a duration, this field is - empty. + Output only. The resource name of the entitlement. Entitlement names + have the form + `providers/{provider_id}/entitlements/{entitlement_id}`. + newPendingPlan: + description: >- + Output only. The identifier of the pending new plan. Required if the + product has plans and the entitlement has a pending plan change. + type: string quoteExternalName: description: >- Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. readOnly: true type: string + usageReportingId: + type: string + description: >- + Output only. The consumerId to use when reporting usage through the + Service Control API. See the consumerId field at [Reporting + Metrics](https://cloud.google.com/service-control/reporting-metrics) + for more details. This field is present only if the product has + usage-based billing configured. + provider: + type: string + description: >- + Output only. The identifier of the service provider that this + entitlement was created against. Each service provider is assigned a + unique provider value when they onboard with Cloud Commerce + platform. + plan: + description: >- + Output only. The identifier of the plan that was procured. Required + if the product has plans. + type: string + offerEndTime: + readOnly: true + type: string + description: >- + Output only. End time for the Offer association corresponding to + this entitlement. The field is only populated if the entitlement is + currently associated with an Offer. + format: google-datetime + offerDuration: + readOnly: true + description: >- + Output only. The offer duration of the current offer in ISO 8601 + duration format. Field is empty if entitlement was not made using an + offer. If the offer was created with a specified end date instead of + a duration, this field is empty. + type: string newOfferStartTime: + format: google-datetime + type: string readOnly: true description: >- Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. - type: string - format: google-datetime - name: + inputProperties: + additionalProperties: + description: Properties of the object. + type: any + type: object + deprecated: true description: >- - Output only. The resource name of the entitlement. Entitlement names - have the form - `providers/{provider_id}/entitlements/{entitlement_id}`. + Output only. The custom properties that were collected from the user + to create this entitlement. + productExternalName: + description: Output only. The identifier of the product that was procured. + readOnly: true type: string - newPendingPlan: - description: >- - Output only. The identifier of the pending new plan. Required if the - product has plans and the entitlement has a pending plan change. + newPendingOffer: type: string - updateTime: - description: Output only. The last update timestamp. - format: google-datetime + description: >- + Output only. The name of the offer the entitlement is switching to + upon a pending plan change. Only exists if the pending plan change + is moving to an offer. This field isn't populated for entitlements + which aren't active yet. Format: + 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR + 'projects/{project}/services/{service}/standardOffers/{offer-id}', + depending on whether the offer is private or public. The {service} + in the name is the listing service of the offer. It could be either + the product service that the offer is referencing, or a generic + private offer parent service. We recommend that you don't build your + integration to rely on the meaning of this {service} part. + readOnly: true + entitlementBenefitIds: + type: array + readOnly: true + items: + type: string + description: >- + Output only. The entitlement benefit IDs associated with the + purchase. + account: type: string + description: >- + Output only. The resource name of the account that this entitlement + is based on, if any. + Consumer: type: object - id: Entitlement + description: A resource using (consuming) this entitlement. + properties: + project: + description: A project name with format `projects/`. + type: string + id: Consumer Empty: + properties: {} 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); } - properties: {} id: Empty type: object - RejectEntitlementPlanChangeRequest: - id: RejectEntitlementPlanChangeRequest + ApproveEntitlementPlanChangeRequest: + properties: + pendingPlanName: + description: Required. Name of the pending plan that's being approved. + type: string + type: object + id: ApproveEntitlementPlanChangeRequest + description: >- + Request message for + [PartnerProcurementService.ApproveEntitlementPlanChange[]. + RejectAccountRequest: + description: Request message for PartnerProcurementService.RejectAccount. + properties: + reason: + type: string + description: >- + Free form text string explaining the rejection reason. Max allowed + length: 256 bytes. Longer strings will be truncated. + approvalName: + type: string + description: >- + The name of the approval being rejected. If absent and there is only + one approval possible, that approval will be rejected. If absent and + there are many approvals possible, the request will fail with a 400 + Bad Request. Optional. + type: object + id: RejectAccountRequest + ListEntitlementsResponse: + properties: + entitlements: + description: The list of entitlements in this response. + type: array + items: + $ref: '#/components/schemas/Entitlement' + nextPageToken: + type: string + description: The token for fetching the next page. + description: Response message for PartnerProcurementService.ListEntitlements. + id: ListEntitlementsResponse + type: object + ResetAccountRequest: + properties: {} + description: Request message for PartnerProcurementService.ResetAccount. + id: ResetAccountRequest type: object + RejectEntitlementPlanChangeRequest: properties: pendingPlanName: description: Required. Name of the pending plan that is being rejected. @@ -489,91 +390,190 @@ components: description: >- Request message for PartnerProcurementService.RejectEntitlementPlanChange. + id: RejectEntitlementPlanChangeRequest + type: object + ApproveAccountRequest: + description: Request message for PartnerProcurementService.ApproveAccount. + type: object + id: ApproveAccountRequest + properties: + reason: + description: >- + Free form text string explaining the approval reason. Optional. Max + allowed length: 256 bytes. Longer strings will be truncated. + type: string + approvalName: + type: string + description: >- + The name of the approval being approved. If absent and there is only + one approval possible, that approval will be granted. If absent and + there are many approvals possible, the request will fail with a 400 + Bad Request. Optional. + properties: + description: >- + Set of properties that should be associated with the account. + Optional. + type: object + additionalProperties: + type: string + ApproveEntitlementRequest: + properties: + properties: + type: object + deprecated: true + additionalProperties: + type: string + description: >- + Set of properties that should be associated with the entitlement. + Optional. + entitlementMigrated: + type: string + description: >- + Optional. The resource name of the entitlement that was migrated, + with the format + `providers/{provider_id}/entitlements/{entitlement_id}`. Should only + be sent when resources have been migrated from entitlement_migrated + to the new entitlement. Optional. + id: ApproveEntitlementRequest + description: Request message for [PartnerProcurementService.ApproveEntitlement[]. + type: object RejectEntitlementRequest: + type: object properties: reason: type: string description: >- Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. - description: Request message for PartnerProcurementService.RejectEntitlement. - type: object id: RejectEntitlementRequest - ApproveAccountRequest: + description: Request message for PartnerProcurementService.RejectEntitlement. + SuspendEntitlementRequest: + id: SuspendEntitlementRequest type: object - description: Request message for PartnerProcurementService.ApproveAccount. + description: >- + Request message for ParterProcurementService.SuspendEntitlement. This is + not yet supported. properties: - properties: - additionalProperties: - type: string + reason: description: >- - Set of properties that should be associated with the account. - Optional. + A free-form reason string, explaining the reason for suspension + request. + type: string + Account: + properties: + inputProperties: + description: >- + Output only. The custom properties that were collected from the user + to create this account. type: object - approvalName: + additionalProperties: + description: Properties of the object. + type: any + deprecated: true + createTime: + type: string + format: google-datetime + description: Output only. The creation timestamp. + state: + enum: + - ACCOUNT_STATE_UNSPECIFIED + - ACCOUNT_ACTIVATION_REQUESTED + - ACCOUNT_ACTIVE + type: string description: >- - The name of the approval being approved. If absent and there is only - one approval possible, that approval will be granted. If absent and - there are many approvals possible, the request will fail with a 400 - Bad Request. Optional. + Output only. The state of the account. This is used to decide + whether the customer is in good standing with the provider and is + able to make purchases. An account might not be able to make a + purchase if the billing account is suspended, for example. + enumDescriptions: + - >- + Default state of the account. It's only set to this value when the + account is first created and has not been initialized. + - >- + The customer has requested the creation of the account resource, + and the provider notification message is dispatched. This state + has been deprecated, as accounts now immediately transition to + AccountState.ACCOUNT_ACTIVE. + - >- + The account is active and ready for use. The next possible states + are: - Account getting deleted: After the user invokes delete from + another API. + updateTime: + format: google-datetime type: string - reason: + description: Output only. The last update timestamp. + provider: + description: >- + Output only. The identifier of the service provider that this + account was created against. Each service provider is assigned a + unique provider value when they onboard with Cloud Commerce + platform. type: string + name: description: >- - Free form text string explaining the approval reason. Optional. Max - allowed length: 256 bytes. Longer strings will be truncated. - id: ApproveAccountRequest - ListEntitlementsResponse: - type: object - properties: - nextPageToken: - description: The token for fetching the next page. + Output only. The resource name of the account. Account names have + the form `accounts/{account_id}`. type: string - entitlements: - type: array + approvals: items: - $ref: '#/components/schemas/Entitlement' - description: The list of entitlements in this response. - id: ListEntitlementsResponse - description: Response message for PartnerProcurementService.ListEntitlements. - RejectAccountRequest: - description: Request message for PartnerProcurementService.RejectAccount. + $ref: '#/components/schemas/Approval' + description: >- + Output only. The approvals for this account. These approvals are + used to track actions that are permitted or have been completed by a + customer within the context of the provider. This might include a + sign up flow or a provisioning step, for example, that the provider + can admit to having happened. + type: array type: object - id: RejectAccountRequest + id: Account + description: >- + Represents an account that was established by the customer on the + service provider's system. + Approval: + description: An approval for some action on an account. properties: + updateTime: + type: string + description: Optional. The last update timestamp of the approval. + format: google-datetime reason: type: string - description: >- - Free form text string explaining the rejection reason. Max allowed - length: 256 bytes. Longer strings will be truncated. - approvalName: + description: Output only. An explanation for the state of the approval. + name: type: string - description: >- - The name of the approval being rejected. If absent and there is only - one approval possible, that approval will be rejected. If absent and - there are many approvals possible, the request will fail with a 400 - Bad Request. Optional. - ApproveEntitlementPlanChangeRequest: - properties: - pendingPlanName: + description: Output only. The name of the approval. + state: + description: Output only. The state of the approval. + enum: + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + enumDescriptions: + - Sentinel value; do not use. + - >- + The approval is pending response from the provider. The approval + state can transition to Account.Approval.State.APPROVED or + Account.Approval.State.REJECTED. + - The approval has been granted by the provider. + - >- + The approval has been rejected by the provider. A provider may + choose to approve a previously rejected approval, so is it + possible to transition to Account.Approval.State.APPROVED. type: string - description: Required. Name of the pending plan that's being approved. + id: Approval type: object - description: >- - Request message for - [PartnerProcurementService.ApproveEntitlementPlanChange[]. - id: ApproveEntitlementPlanChangeRequest parameters: - access_token: - description: OAuth access token. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: access_token + name: uploadType schema: type: string - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token schema: type: string upload_protocol: @@ -582,34 +582,34 @@ components: name: upload_protocol schema: 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. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: key + name: fields schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + _.xgafv: + description: V1 error format. in: query - name: quotaUser + name: $.xgafv schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + enum: + - '1' + - '2' + 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. in: query - name: fields + name: key schema: type: string alt: @@ -622,10 +622,19 @@ components: - json - media - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser schema: type: string prettyPrint: @@ -634,74 +643,65 @@ components: name: prettyPrint schema: type: boolean - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' x-stackQL-resources: entitlements: id: google.cloudcommerceprocurement.entitlements name: entitlements title: Entitlements methods: - reject: + approve: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: - $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/get + $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.entitlements + reject: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/patch + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post response: mediaType: application/json openAPIDocKey: '200' - list: + suspend: operation: - $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:suspend/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.entitlements - reject_plan_change: + get: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:rejectPlanChange/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/get response: mediaType: application/json openAPIDocKey: '200' - approve: + patch: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/patch response: mediaType: application/json openAPIDocKey: '200' - suspend: + approve_plan_change: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:suspend/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post response: mediaType: application/json openAPIDocKey: '200' - approve_plan_change: + reject_plan_change: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:rejectPlanChange/post response: mediaType: application/json openAPIDocKey: '200' @@ -719,10 +719,16 @@ components: name: accounts title: Accounts methods: - reject: + reset: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reject/post + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reset/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -740,16 +746,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - reset: + reject: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reset/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}/get' + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reject/post response: mediaType: application/json openAPIDocKey: '200' @@ -762,31 +762,31 @@ components: replace: [] delete: [] paths: - /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: + /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' post: description: >- - Rejects an entitlement that is in the + Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is - invoked by the provider to reject the creation of the entitlement + invoked by the provider to approve the creation of the entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.reject + operationId: cloudcommerceprocurement.providers.entitlements.approve requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectEntitlementRequest' + $ref: '#/components/schemas/ApproveEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -810,11 +810,11 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}: + /v1/providers/{providersId}/entitlements: parameters: *ref_1 get: - description: Gets a requested Entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.get + description: Lists Entitlements for which the provider has read access. + operationId: cloudcommerceprocurement.providers.entitlements.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -826,7 +826,52 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/ListEntitlementsResponse' + parameters: + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: + parameters: *ref_1 + post: + description: >- + Rejects an entitlement that is in the + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is + invoked by the provider to reject the creation of the entitlement + resource. + operationId: cloudcommerceprocurement.providers.entitlements.reject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectEntitlementRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -838,14 +883,16 @@ paths: required: true schema: type: string - patch: - description: Updates an existing Entitlement. - operationId: cloudcommerceprocurement.providers.entitlements.patch + /v1/providers/{providersId}/entitlements/{entitlementsId}:suspend: + parameters: *ref_1 + post: + description: Requests suspension of an active Entitlement. This is not yet supported. + operationId: cloudcommerceprocurement.providers.entitlements.suspend requestBody: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/SuspendEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -857,7 +904,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -869,16 +916,11 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/providers/{providersId}/entitlements: + /v1/providers/{providersId}/entitlements/{entitlementsId}: parameters: *ref_1 get: - description: Lists Entitlements for which the provider has read access. - operationId: cloudcommerceprocurement.providers.entitlements.list + description: Gets a requested Entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -890,40 +932,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListEntitlementsResponse' + $ref: '#/components/schemas/Entitlement' parameters: - in: path name: providersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: entitlementsId + required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange: - parameters: *ref_1 - post: - description: >- - Rejects an entitlement plan change that is in the - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This - method is invoked by the provider to reject the plan change on the - entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.rejectPlanChange + patch: + description: Updates an existing Entitlement. + operationId: cloudcommerceprocurement.providers.entitlements.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectEntitlementPlanChangeRequest' + $ref: '#/components/schemas/Entitlement' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -935,7 +963,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Entitlement' parameters: - in: path name: providersId @@ -947,20 +975,25 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange: parameters: *ref_1 post: description: >- - Approves an entitlement that is in the - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is - invoked by the provider to approve the creation of the entitlement - resource. - operationId: cloudcommerceprocurement.providers.entitlements.approve + Approves an entitlement plan change that is in the + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This + method is invoked by the provider to approve the plan change on the + entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.approvePlanChange requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApproveEntitlementRequest' + $ref: '#/components/schemas/ApproveEntitlementPlanChangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -984,16 +1017,20 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:suspend: + /v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange: parameters: *ref_1 post: - description: Requests suspension of an active Entitlement. This is not yet supported. - operationId: cloudcommerceprocurement.providers.entitlements.suspend + description: >- + Rejects an entitlement plan change that is in the + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This + method is invoked by the provider to reject the plan change on the + entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.rejectPlanChange requestBody: content: application/json: schema: - $ref: '#/components/schemas/SuspendEntitlementRequest' + $ref: '#/components/schemas/RejectEntitlementPlanChangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1017,20 +1054,18 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange: + /v1/providers/{providersId}/accounts/{accountsId}:reset: parameters: *ref_1 post: description: >- - Approves an entitlement plan change that is in the - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This - method is invoked by the provider to approve the plan change on the - entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.approvePlanChange + Resets an Account and cancels all associated Entitlements. Partner can + only reset accounts they own rather than customer accounts. + operationId: cloudcommerceprocurement.providers.accounts.reset requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApproveEntitlementPlanChangeRequest' + $ref: '#/components/schemas/ResetAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1050,20 +1085,15 @@ paths: schema: type: string - in: path - name: entitlementsId + name: accountsId required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:reject: + /v1/providers/{providersId}/accounts/{accountsId}: parameters: *ref_1 - post: - description: Rejects an approval on an Account. - operationId: cloudcommerceprocurement.providers.accounts.reject - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RejectAccountRequest' + get: + description: Gets a requested Account resource. + operationId: cloudcommerceprocurement.providers.accounts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1075,7 +1105,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Account' parameters: - in: path name: providersId @@ -1152,18 +1182,16 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:reset: + /v1/providers/{providersId}/accounts/{accountsId}:reject: parameters: *ref_1 post: - description: >- - Resets an Account and cancels all associated Entitlements. Partner can - only reset accounts they own rather than customer accounts. - operationId: cloudcommerceprocurement.providers.accounts.reset + description: Rejects an approval on an Account. + operationId: cloudcommerceprocurement.providers.accounts.reject requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResetAccountRequest' + $ref: '#/components/schemas/RejectAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1187,31 +1215,3 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}: - parameters: *ref_1 - get: - description: Gets a requested Account resource. - operationId: cloudcommerceprocurement.providers.accounts.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Account' - parameters: - - in: path - name: providersId - required: true - schema: - type: string - - in: path - name: accountsId - required: true - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml index d19c2700..b3a15e5e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml @@ -9,8 +9,8 @@ info: Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering. version: v1 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240911' + x-generated-date: '2024-09-19' externalDocs: url: >- https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest diff --git a/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml b/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml index 6b735f93..4f6ec024 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml @@ -7,8 +7,8 @@ info: title: Cloud Deploy API description: '' version: v1 - x-discovery-doc-revision: '20240820' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240902' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/deploy/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml b/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml index 86c7f6d1..ccc4b441 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml @@ -11,7 +11,7 @@ info: errors. version: v1beta1 x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/error-reporting/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml index 0a99f6bf..f99d05ad 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml @@ -7,8 +7,8 @@ info: title: Cloud Functions API description: Manages lightweight user-provided functions executed in response to events. version: v2 - x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/functions servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml index ed13e478..94a81c93 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml @@ -7,8 +7,8 @@ info: title: Cloud Identity API description: API for provisioning and managing identity resources. version: v1 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/identity/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml index 3724fc8b..12c87fbc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml @@ -9,8 +9,8 @@ info: Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications. version: v1 - x-discovery-doc-revision: '20240903' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/kms/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml index 8e288b20..4b8dc515 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml @@ -8,7 +8,7 @@ info: description: Manages continuous profiling information. version: v2 x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/profiler/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml index 643c4b78..99766970 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml @@ -10,7 +10,7 @@ info: containers. version: v3 x-discovery-doc-revision: '20240829' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/resource-manager servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml index d181ad22..e0a5f1df 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml @@ -8,7 +8,7 @@ info: description: Creates and manages jobs run on a regular recurring schedule. version: v1 x-discovery-doc-revision: '20240827' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/scheduler/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml index 7ba4714f..85c68969 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml @@ -9,8 +9,8 @@ info: Allows users to start, configure, and connect to interactive shell sessions running in the cloud. version: v1 - x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/shell/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml index 75ec494e..b660544e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml @@ -9,8 +9,8 @@ info: Manages Google Cloud technical support cases for Customer Care support offerings. version: v2 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/support/docs/apis servers: @@ -36,11 +36,76 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - WorkflowOperationMetadata: + SearchCasesResponse: + id: SearchCasesResponse + properties: + cases: + items: + $ref: '#/components/schemas/Case' + type: array + description: >- + The list of cases associated with the parent after any filters have + been applied. + nextPageToken: + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.search` requests. If + unspecified, there are no more results to retrieve. + type: string + description: The response message for the SearchCases endpoint. + type: object + DiffUploadResponse: + description: '# gdata.* are outside protos with mising documentation' + properties: + originalObject: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + objectVersion: + type: string + description: '# gdata.* are outside protos with mising documentation' + id: DiffUploadResponse + type: object + DiffUploadRequest: + description: '# gdata.* are outside protos with mising documentation' type: object properties: - operationAction: + objectVersion: + type: string + description: '# gdata.* are outside protos with mising documentation' + objectInfo: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + checksumsInfo: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + id: DiffUploadRequest + DownloadParameters: + type: object + description: '# gdata.* are outside protos with mising documentation' + properties: + ignoreRange: + type: boolean + description: '# gdata.* are outside protos with mising documentation' + allowGzipCompression: + description: '# gdata.* are outside protos with mising documentation' + type: boolean + id: DownloadParameters + WorkflowOperationMetadata: + description: Metadata about the operation. Used to lookup the current status. + id: WorkflowOperationMetadata + properties: + workflowOperationType: + enum: + - UNKNOWN_OPERATION_TYPE + - WORKFLOWS_V1 + - WORKFLOWS_V2 type: string + description: Which version of the workflow service this operation came from. + enumDescriptions: + - Unknown version. + - Version 1. + - Version 2. + operationAction: enumDescriptions: - Operation action is not specified. - Operation pertains to the creation of a new support account. @@ -48,6 +113,7 @@ components: - >- Operation pertains to the purchasing of a support plan that may either create or update a support account. + type: string enum: - OPERATION_ACTION_UNSPECIFIED - CREATE_SUPPORT_ACCOUNT @@ -55,120 +121,195 @@ components: - PURCHASE_SUPPORT_ACCOUNT description: The type of action the operation is classified as. namespace: + type: string description: >- The namespace that the job was scheduled in. Must be included in the workflow metadata so the workflow status can be retrieved. - type: string - workflowOperationType: - type: string - description: Which version of the workflow service this operation came from. - enum: - - UNKNOWN_OPERATION_TYPE - - WORKFLOWS_V1 - - WORKFLOWS_V2 - enumDescriptions: - - Unknown version. - - Version 1. - - Version 2. - id: WorkflowOperationMetadata - description: Metadata about the operation. Used to lookup the current status. - CaseClassification: - id: CaseClassification type: object + SearchCaseClassificationsResponse: properties: - id: + nextPageToken: + type: string description: >- - The unique ID for a classification. Must be specified for case - creation. To retrieve valid classification IDs for case creation, - use `caseClassifications.search`. Classification IDs returned by - `caseClassifications.search` are guaranteed to be valid for at least - 6 months. If a given classification is deactiveated, it will - immediately stop being returned. After 6 months, `case.create` - requests using the classification ID will fail. + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `caseClassifications.list` + requests. If unspecified, there are no more results to retrieve. + caseClassifications: + items: + $ref: '#/components/schemas/CaseClassification' + description: The classifications retrieved. + type: array + description: The response message for SearchCaseClassifications endpoint. + id: SearchCaseClassificationsResponse + type: object + Attachment: + properties: + mimeType: + readOnly: true type: string - displayName: + description: Output only. The MIME type of the attachment (e.g. text/plain). + name: + readOnly: true + description: Output only. The resource name of the attachment. + type: string + sizeBytes: + format: int64 + readOnly: true type: string + description: Output only. The size of the attachment in bytes. + creator: + readOnly: true description: >- - A display name for the classification. The display name is not - static and can change. To uniquely and consistently identify - classifications, use the `CaseClassification.id` field. + Output only. The user who uploaded the attachment. Note, the name + and email will be obfuscated if the attachment was uploaded by + Google support. + $ref: '#/components/schemas/Actor' + createTime: + description: Output only. The time at which the attachment was created. + format: google-datetime + readOnly: true + type: string + filename: + type: string + description: The filename of the attachment (e.g. `"graph.jpg"`). description: >- - A Case Classification represents the topic that a case is about. It's - very important to use accurate classifications, because they're used to - route your cases to specialists who can help you. A classification - always has an ID that is its unique identifier. A valid ID is required - when creating a case. - DiffUploadResponse: + An Attachment contains metadata about a file that was uploaded to a case + - it is NOT a file itself. That being said, the name of an Attachment + object can be used to download its accompanying file through the + `media.download` endpoint. While attachments can be uploaded in the + console at the same time as a comment, they're associated on a "case" + level, not a "comment" level. type: object - description: '# gdata.* are outside protos with mising documentation' + id: Attachment + Case: + id: Case + description: >- + A Case is an object that contains the details of a support case. It + contains fields for the time it was created, its priority, its + classification, and more. Cases can also have comments and attachments + that get added over time. A case is parented by a Google Cloud + organization or project. Organizations are identified by a number, so + the name of a case parented by an organization would look like this: ``` + organizations/123/cases/456 ``` Projects have two unique identifiers, an + ID and a number, and they look like this: ``` projects/abc/cases/456 ``` + ``` projects/123/cases/456 ``` You can use either of them when calling + the API. To learn more about project identifiers, see + [AIP-2510](https://google.aip.dev/cloud/2510). properties: - originalObject: - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - objectVersion: - description: '# gdata.* are outside protos with mising documentation' + languageCode: type: string - id: DiffUploadResponse - DiffVersionResponse: - type: object - description: '# gdata.* are outside protos with mising documentation' - properties: - objectVersion: + description: >- + The language the user has requested to receive support in. This + should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, + `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported + language is specified, this field defaults to English (en). Language + selection during case creation may affect your available support + options. For a list of supported languages and their support working + hours, see: + https://cloud.google.com/support/docs/language-working-hours + testCase: + type: boolean + description: >- + Whether this case was created for internal API testing and should + not be acted on by the support team. + updateTime: + description: Output only. The time this case was last updated. + format: google-datetime type: string - description: '# gdata.* are outside protos with mising documentation' - objectSizeBytes: - format: int64 - description: '# gdata.* are outside protos with mising documentation' + readOnly: true + description: type: string - id: DiffVersionResponse - SearchCaseClassificationsResponse: - properties: - caseClassifications: - description: The classifications retrieved. - type: array - items: - $ref: '#/components/schemas/CaseClassification' - nextPageToken: + description: A broad description of the issue. + timeZone: description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `caseClassifications.list` - requests. If unspecified, there are no more results to retrieve. + The timezone of the user who created the support case. It should be + in a format IANA recognizes: https://www.iana.org/time-zones. There + is no additional validation done by the API. type: string + creator: + description: >- + The user who created the case. Note: The name and email will be + obfuscated if the case was created by Google Support. + $ref: '#/components/schemas/Actor' + escalated: + type: boolean + description: Whether the case is currently escalated. + name: + type: string + description: The resource name for the case. + subscriberEmailAddresses: + items: + type: string + description: The email addresses to receive updates on this case. + type: array + priority: + description: The priority of this case. + type: string + enum: + - PRIORITY_UNSPECIFIED + - P0 + - P1 + - P2 + - P3 + - P4 + enumDescriptions: + - Priority is undefined or has not been set yet. + - Extreme impact on a production service. Service is hard down. + - >- + Critical impact on a production service. Service is currently + unusable. + - >- + Severe impact on a production service. Service is usable but + greatly impaired. + - >- + Medium impact on a production service. Service is available, but + moderately impaired. + - >- + General questions or minor issues. Production service is fully + available. + displayName: + type: string + description: The short summary of the issue reported in this case. + classification: + description: The issue classification applicable to this case. + $ref: '#/components/schemas/CaseClassification' + state: + enum: + - STATE_UNSPECIFIED + - NEW + - IN_PROGRESS_GOOGLE_SUPPORT + - ACTION_REQUIRED + - SOLUTION_PROVIDED + - CLOSED + type: string + readOnly: true + enumDescriptions: + - Case is in an unknown state. + - >- + The case has been created but no one is assigned to work on it + yet. + - The case is currently being handled by Google support. + - Google is waiting for a response. + - A solution has been offered for the case, but it isn't yet closed. + - The case has been resolved. + description: Output only. The current status of the support case. + createTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time this case was created. + contactEmail: + type: string + description: >- + A user-supplied email address to send case update notifications for. + This should only be used in BYOID flows, where we cannot infer the + user's email address directly from their EUCs. type: object - description: The response message for SearchCaseClassifications endpoint. - id: SearchCaseClassificationsResponse - CompositeMedia: - type: object - description: '# gdata.* are outside protos with mising documentation' + CompositeMedia: id: CompositeMedia + description: '# gdata.* are outside protos with mising documentation' properties: cosmoBinaryReference: - format: byte - type: string - description: '# gdata.* are outside protos with mising documentation' - objectId: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/ObjectId' - crc32cHash: - format: uint32 - description: '# gdata.* are outside protos with mising documentation' - type: integer - blobstore2Info: - $ref: '#/components/schemas/Blobstore2Info' - description: '# gdata.* are outside protos with mising documentation' - path: - type: string - description: '# gdata.* are outside protos with mising documentation' - blobRef: - type: string - deprecated: true - description: '# gdata.* are outside protos with mising documentation' - format: byte - sha1Hash: - description: '# gdata.* are outside protos with mising documentation' - format: byte - type: string - md5Hash: type: string format: byte description: '# gdata.* are outside protos with mising documentation' @@ -176,11 +317,19 @@ components: type: string format: int64 description: '# gdata.* are outside protos with mising documentation' - inline: + path: type: string description: '# gdata.* are outside protos with mising documentation' + inline: + description: '# gdata.* are outside protos with mising documentation' + type: string format: byte + crc32cHash: + type: integer + format: uint32 + description: '# gdata.* are outside protos with mising documentation' referenceType: + description: '# gdata.* are outside protos with mising documentation' enum: - PATH - BLOB_REF @@ -194,270 +343,170 @@ components: - '# gdata.* are outside protos with mising documentation' - '# gdata.* are outside protos with mising documentation' - '# gdata.* are outside protos with mising documentation' + blobRef: + deprecated: true + format: byte + type: string description: '# gdata.* are outside protos with mising documentation' - CloseCaseRequest: - description: The request message for the CloseCase endpoint. + sha1Hash: + type: string + description: '# gdata.* are outside protos with mising documentation' + format: byte + objectId: + $ref: '#/components/schemas/ObjectId' + description: '# gdata.* are outside protos with mising documentation' + blobstore2Info: + $ref: '#/components/schemas/Blobstore2Info' + description: '# gdata.* are outside protos with mising documentation' + md5Hash: + type: string + description: '# gdata.* are outside protos with mising documentation' + format: byte + type: object + CaseClassification: + description: >- + A Case Classification represents the topic that a case is about. It's + very important to use accurate classifications, because they're used to + route your cases to specialists who can help you. A classification + always has an ID that is its unique identifier. A valid ID is required + when creating a case. + id: CaseClassification type: object - properties: {} - id: CloseCaseRequest - ListCommentsResponse: - description: The response message for the ListComments endpoint. properties: - comments: - description: List of the comments associated with the case. - items: - $ref: '#/components/schemas/Comment' - type: array - nextPageToken: + displayName: description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.comments.list` requests. If - unspecified, there are no more results to retrieve. + A display name for the classification. The display name is not + static and can change. To uniquely and consistently identify + classifications, use the `CaseClassification.id` field. type: string - id: ListCommentsResponse + id: + type: string + description: >- + The unique ID for a classification. Must be specified for case + creation. To retrieve valid classification IDs for case creation, + use `caseClassifications.search`. Classification IDs returned by + `caseClassifications.search` are guaranteed to be valid for at least + 6 months. If a given classification is deactiveated, it will + immediately stop being returned. After 6 months, `case.create` + requests using the classification ID will fail. + Blobstore2Info: + id: Blobstore2Info type: object + properties: + blobGeneration: + format: int64 + type: string + description: '# gdata.* are outside protos with mising documentation' + blobId: + description: '# gdata.* are outside protos with mising documentation' + type: string + downloadReadHandle: + description: '# gdata.* are outside protos with mising documentation' + format: byte + type: string + readToken: + type: string + description: '# gdata.* are outside protos with mising documentation' + uploadMetadataContainer: + type: string + description: '# gdata.* are outside protos with mising documentation' + format: byte + description: '# gdata.* are outside protos with mising documentation' Comment: - type: object description: >- A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. + id: Comment properties: plainTextBody: - type: string + deprecated: true readOnly: true + type: string description: >- Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons. - deprecated: true - body: - description: The full comment body. Maximum of 12800 characters. - type: string createTime: - format: google-datetime description: Output only. The time when the comment was created. + format: google-datetime readOnly: true type: string - name: - description: Output only. Identifier. The resource name of the comment. + body: + description: The full comment body. Maximum of 12800 characters. type: string - readOnly: true creator: readOnly: true + $ref: '#/components/schemas/Actor' description: >- Output only. The user or Google Support agent who created the comment. - $ref: '#/components/schemas/Actor' - id: Comment - ListCasesResponse: - id: ListCasesResponse - type: object - description: The response message for the ListCases endpoint. - properties: - cases: - type: array - description: >- - The list of cases associated with the parent after any filters have - been applied. - items: - $ref: '#/components/schemas/Case' - nextPageToken: - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.list` requests. If - unspecified, there are no more results to retrieve. - type: string - EscalateCaseRequest: - id: EscalateCaseRequest - type: object - description: The request message for the EscalateCase endpoint. - properties: - escalation: - $ref: '#/components/schemas/Escalation' - description: The escalation information to be sent with the escalation request. - Actor: - type: object - properties: - email: - deprecated: true - type: string - description: >- - The email address of the actor. If not provided, it is inferred from - the credentials supplied during case creation. When a name is - provided, an email must also be provided. If the user is a Google - Support agent, this is obfuscated. This field is deprecated. Use - **username** field instead. - googleSupport: - readOnly: true - type: boolean - description: Output only. Whether the actor is a Google support actor. - username: + name: type: string readOnly: true - description: >- - Output only. The username of the actor. It may look like an email or - other format provided by the identity provider. If not provided, it - is inferred from the credentials supplied. When a name is provided, - a username must also be provided. If the user is a Google Support - agent, this will not be set. - displayName: - description: >- - The name to display for the actor. If not provided, it is inferred - from credentials supplied during case creation. When an email is - provided, a display name must also be provided. This will be - obfuscated if the user is a Google Support agent. - type: string - description: >- - An Actor represents an entity that performed an action. For example, an - actor could be a user who posted a comment on a support case, a user who - uploaded an attachment, or a service account that created a support - case. - id: Actor - ObjectId: - description: '# gdata.* are outside protos with mising documentation' - id: ObjectId - type: object - properties: - objectName: - description: '# gdata.* are outside protos with mising documentation' - type: string - generation: - description: '# gdata.* are outside protos with mising documentation' - type: string - format: int64 - bucketName: - type: string - description: '# gdata.* are outside protos with mising documentation' - DiffUploadRequest: - type: object - properties: - objectVersion: - type: string - description: '# gdata.* are outside protos with mising documentation' - objectInfo: - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - checksumsInfo: - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - id: DiffUploadRequest - description: '# gdata.* are outside protos with mising documentation' - SearchCasesResponse: + description: Output only. Identifier. The resource name of the comment. type: object - properties: - cases: - type: array - description: >- - The list of cases associated with the parent after any filters have - been applied. - items: - $ref: '#/components/schemas/Case' - nextPageToken: - type: string - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.search` requests. If - unspecified, there are no more results to retrieve. - id: SearchCasesResponse - description: The response message for the SearchCases endpoint. Media: - type: object description: '# gdata.* are outside protos with mising documentation' id: Media properties: - algorithm: - deprecated: true - description: '# gdata.* are outside protos with mising documentation' - type: string - path: - type: string + token: description: '# gdata.* are outside protos with mising documentation' - contentType: + type: string + blobRef: description: '# gdata.* are outside protos with mising documentation' type: string - sha1Hash: + deprecated: true format: byte + length: + format: int64 description: '# gdata.* are outside protos with mising documentation' type: string - token: + mediaId: description: '# gdata.* are outside protos with mising documentation' - type: string - md5Hash: - type: string format: byte + type: string + contentTypeInfo: description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/ContentTypeInfo' bigstoreObjectRef: - format: byte - description: '# gdata.* are outside protos with mising documentation' - deprecated: true type: string - crc32cHash: - type: integer - format: uint32 description: '# gdata.* are outside protos with mising documentation' - diffVersionResponse: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffVersionResponse' - sha256Hash: + deprecated: true format: byte + downloadParameters: description: '# gdata.* are outside protos with mising documentation' - type: string - compositeMedia: - description: '# gdata.* are outside protos with mising documentation' - items: - $ref: '#/components/schemas/CompositeMedia' - type: array - blobRef: + $ref: '#/components/schemas/DownloadParameters' + diffDownloadResponse: description: '# gdata.* are outside protos with mising documentation' - format: byte - deprecated: true - type: string + $ref: '#/components/schemas/DiffDownloadResponse' diffUploadRequest: + description: '# gdata.* are outside protos with mising documentation' $ref: '#/components/schemas/DiffUploadRequest' + algorithm: description: '# gdata.* are outside protos with mising documentation' + type: string + deprecated: true hashVerified: type: boolean description: '# gdata.* are outside protos with mising documentation' - hash: - type: string - deprecated: true + crc32cHash: description: '# gdata.* are outside protos with mising documentation' - mediaId: - type: string - format: byte + type: integer + format: uint32 + objectId: description: '# gdata.* are outside protos with mising documentation' - diffDownloadResponse: - $ref: '#/components/schemas/DiffDownloadResponse' + $ref: '#/components/schemas/ObjectId' + isPotentialRetry: + type: boolean description: '# gdata.* are outside protos with mising documentation' inline: - format: byte - type: string description: '# gdata.* are outside protos with mising documentation' - length: - type: string - description: '# gdata.* are outside protos with mising documentation' - format: int64 - cosmoBinaryReference: type: string format: byte - description: '# gdata.* are outside protos with mising documentation' referenceType: + description: '# gdata.* are outside protos with mising documentation' type: string - enumDescriptions: - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' enum: - PATH - BLOB_REF @@ -472,298 +521,197 @@ components: - DIFF_UPLOAD_RESPONSE - COSMO_BINARY_REFERENCE - ARBITRARY_BYTES - description: '# gdata.* are outside protos with mising documentation' - downloadParameters: - $ref: '#/components/schemas/DownloadParameters' - description: '# gdata.* are outside protos with mising documentation' - filename: - type: string - description: '# gdata.* are outside protos with mising documentation' - timestamp: - type: string - format: uint64 - description: '# gdata.* are outside protos with mising documentation' - blobstore2Info: - $ref: '#/components/schemas/Blobstore2Info' - description: '# gdata.* are outside protos with mising documentation' - diffChecksumsResponse: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffChecksumsResponse' - isPotentialRetry: - description: '# gdata.* are outside protos with mising documentation' - type: boolean - objectId: - $ref: '#/components/schemas/ObjectId' - description: '# gdata.* are outside protos with mising documentation' + enumDescriptions: + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' diffUploadResponse: $ref: '#/components/schemas/DiffUploadResponse' description: '# gdata.* are outside protos with mising documentation' - contentTypeInfo: - $ref: '#/components/schemas/ContentTypeInfo' - description: '# gdata.* are outside protos with mising documentation' - Blobstore2Info: - id: Blobstore2Info - description: '# gdata.* are outside protos with mising documentation' - type: object - properties: - uploadMetadataContainer: - description: '# gdata.* are outside protos with mising documentation' - type: string - format: byte - downloadReadHandle: - format: byte - description: '# gdata.* are outside protos with mising documentation' - type: string - blobId: - description: '# gdata.* are outside protos with mising documentation' - type: string - blobGeneration: - format: int64 - description: '# gdata.* are outside protos with mising documentation' - type: string - readToken: + compositeMedia: + items: + $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' - type: string - Case: - type: object - description: >- - A Case is an object that contains the details of a support case. It - contains fields for the time it was created, its priority, its - classification, and more. Cases can also have comments and attachments - that get added over time. A case is parented by a Google Cloud - organization or project. Organizations are identified by a number, so - the name of a case parented by an organization would look like this: ``` - organizations/123/cases/456 ``` Projects have two unique identifiers, an - ID and a number, and they look like this: ``` projects/abc/cases/456 ``` - ``` projects/123/cases/456 ``` You can use either of them when calling - the API. To learn more about project identifiers, see - [AIP-2510](https://google.aip.dev/cloud/2510). - id: Case - properties: - timeZone: - type: string - description: >- - The timezone of the user who created the support case. It should be - in a format IANA recognizes: https://www.iana.org/time-zones. There - is no additional validation done by the API. - subscriberEmailAddresses: - description: The email addresses to receive updates on this case. type: array - items: - type: string - creator: - $ref: '#/components/schemas/Actor' - description: >- - The user who created the case. Note: The name and email will be - obfuscated if the case was created by Google Support. - createTime: - format: google-datetime - type: string - readOnly: true - description: Output only. The time this case was created. - name: - description: The resource name for the case. - type: string - languageCode: - type: string - description: >- - The language the user has requested to receive support in. This - should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, - `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported - language is specified, this field defaults to English (en). Language - selection during case creation may affect your available support - options. For a list of supported languages and their support working - hours, see: - https://cloud.google.com/support/docs/language-working-hours - testCase: - description: >- - Whether this case was created for internal API testing and should - not be acted on by the support team. - type: boolean - classification: - $ref: '#/components/schemas/CaseClassification' - description: The issue classification applicable to this case. - description: - type: string - description: A broad description of the issue. - priority: - type: string - enumDescriptions: - - Priority is undefined or has not been set yet. - - Extreme impact on a production service. Service is hard down. - - >- - Critical impact on a production service. Service is currently - unusable. - - >- - Severe impact on a production service. Service is usable but - greatly impaired. - - >- - Medium impact on a production service. Service is available, but - moderately impaired. - - >- - General questions or minor issues. Production service is fully - available. - enum: - - PRIORITY_UNSPECIFIED - - P0 - - P1 - - P2 - - P3 - - P4 - description: The priority of this case. - state: - enum: - - STATE_UNSPECIFIED - - NEW - - IN_PROGRESS_GOOGLE_SUPPORT - - ACTION_REQUIRED - - SOLUTION_PROVIDED - - CLOSED - readOnly: true - type: string - description: Output only. The current status of the support case. - enumDescriptions: - - Case is in an unknown state. - - >- - The case has been created but no one is assigned to work on it - yet. - - The case is currently being handled by Google support. - - Google is waiting for a response. - - A solution has been offered for the case, but it isn't yet closed. - - The case has been resolved. - escalated: - type: boolean - description: Whether the case is currently escalated. - displayName: + cosmoBinaryReference: + description: '# gdata.* are outside protos with mising documentation' + format: byte type: string - description: The short summary of the issue reported in this case. - updateTime: + path: + description: '# gdata.* are outside protos with mising documentation' type: string - description: Output only. The time this case was last updated. - readOnly: true - format: google-datetime - contactEmail: + hash: type: string - description: >- - A user-supplied email address to send case update notifications for. - This should only be used in BYOID flows, where we cannot infer the - user's email address directly from their EUCs. - DiffChecksumsResponse: - properties: - objectLocation: description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - chunkSizeBytes: + deprecated: true + md5Hash: + format: byte type: string description: '# gdata.* are outside protos with mising documentation' - format: int64 - objectSizeBytes: - format: int64 - type: string + diffChecksumsResponse: + $ref: '#/components/schemas/DiffChecksumsResponse' + description: '# gdata.* are outside protos with mising documentation' + sha256Hash: description: '# gdata.* are outside protos with mising documentation' - objectVersion: type: string + format: byte + diffVersionResponse: + $ref: '#/components/schemas/DiffVersionResponse' description: '# gdata.* are outside protos with mising documentation' - checksumsLocation: + sha1Hash: + type: string description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - id: DiffChecksumsResponse - type: object - DiffDownloadResponse: - properties: - objectLocation: + format: byte + blobstore2Info: description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - type: object - id: DiffDownloadResponse - CreateAttachmentRequest: - properties: - attachment: - $ref: '#/components/schemas/Attachment' - description: Required. The attachment to be created. - id: CreateAttachmentRequest - description: The request message for the CreateAttachment endpoint. - type: object - ContentTypeInfo: - description: '# gdata.* are outside protos with mising documentation' - properties: - fromBytes: + $ref: '#/components/schemas/Blobstore2Info' + filename: type: string description: '# gdata.* are outside protos with mising documentation' - fromHeader: + contentType: + description: '# gdata.* are outside protos with mising documentation' + type: string + timestamp: type: string description: '# gdata.* are outside protos with mising documentation' - fromFileName: + format: uint64 + type: object + DiffChecksumsResponse: + properties: + chunkSizeBytes: + description: '# gdata.* are outside protos with mising documentation' + format: int64 type: string + checksumsLocation: + $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' - fromUrlPath: + objectSizeBytes: type: string description: '# gdata.* are outside protos with mising documentation' - bestGuess: + format: int64 + objectLocation: + $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' + objectVersion: type: string + description: '# gdata.* are outside protos with mising documentation' type: object - id: ContentTypeInfo + id: DiffChecksumsResponse + description: '# gdata.* are outside protos with mising documentation' ListAttachmentsResponse: properties: + attachments: + description: The list of attachments associated with a case. + type: array + items: + $ref: '#/components/schemas/Attachment' nextPageToken: - type: string description: >- A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.attachments.list` requests. If unspecified, there are no more results to retrieve. - attachments: - type: array - description: The list of attachments associated with a case. - items: - $ref: '#/components/schemas/Attachment' - description: The response message for the ListAttachments endpoint. - id: ListAttachmentsResponse + type: string type: object - Attachment: - id: Attachment + id: ListAttachmentsResponse + description: The response message for the ListAttachments endpoint. + ListCasesResponse: + description: The response message for the ListCases endpoint. properties: - name: - readOnly: true + nextPageToken: type: string - description: Output only. The resource name of the attachment. - filename: + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.list` requests. If + unspecified, there are no more results to retrieve. + cases: + items: + $ref: '#/components/schemas/Case' + type: array + description: >- + The list of cases associated with the parent after any filters have + been applied. + id: ListCasesResponse + type: object + Actor: + id: Actor + description: >- + An Actor represents an entity that performed an action. For example, an + actor could be a user who posted a comment on a support case, a user who + uploaded an attachment, or a service account that created a support + case. + type: object + properties: + email: + deprecated: true + description: >- + The email address of the actor. If not provided, it is inferred from + the credentials supplied during case creation. When a name is + provided, an email must also be provided. If the user is a Google + Support agent, this is obfuscated. This field is deprecated. Use + **username** field instead. type: string - description: The filename of the attachment (e.g. `"graph.jpg"`). - mimeType: + username: + description: >- + Output only. The username of the actor. It may look like an email or + other format provided by the identity provider. If not provided, it + is inferred from the credentials supplied. When a name is provided, + a username must also be provided. If the user is a Google Support + agent, this will not be set. readOnly: true - description: Output only. The MIME type of the attachment (e.g. text/plain). - type: string - createTime: - format: google-datetime type: string + googleSupport: + type: boolean + description: Output only. Whether the actor is a Google support actor. readOnly: true - description: Output only. The time at which the attachment was created. - creator: - $ref: '#/components/schemas/Actor' - readOnly: true - description: >- - Output only. The user who uploaded the attachment. Note, the name - and email will be obfuscated if the attachment was uploaded by - Google support. - sizeBytes: - format: int64 - readOnly: true - description: Output only. The size of the attachment in bytes. + displayName: type: string - description: >- - An Attachment contains metadata about a file that was uploaded to a case - - it is NOT a file itself. That being said, the name of an Attachment - object can be used to download its accompanying file through the - `media.download` endpoint. While attachments can be uploaded in the - console at the same time as a comment, they're associated on a "case" - level, not a "comment" level. + description: >- + The name to display for the actor. If not provided, it is inferred + from credentials supplied during case creation. When an email is + provided, a display name must also be provided. This will be + obfuscated if the user is a Google Support agent. + ListCommentsResponse: type: object + properties: + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.comments.list` requests. If + unspecified, there are no more results to retrieve. + comments: + items: + $ref: '#/components/schemas/Comment' + description: List of the comments associated with the case. + type: array + id: ListCommentsResponse + description: The response message for the ListComments endpoint. Escalation: properties: + justification: + type: string + description: >- + Required. A free text description to accompany the `reason` field + above. Provides additional context on why the case is being + escalated. reason: + enum: + - REASON_UNSPECIFIED + - RESOLUTION_TIME + - TECHNICAL_EXPERTISE + - BUSINESS_IMPACT + description: Required. The reason why the Case is being escalated. + type: string enumDescriptions: - >- The escalation reason is in an unknown state or has not been @@ -773,63 +721,105 @@ components: The support agent does not have the expertise required to successfully resolve the issue. - The issue is having a significant business impact. - description: Required. The reason why the Case is being escalated. + description: An escalation of a support case. + id: Escalation + type: object + DiffVersionResponse: + properties: + objectSizeBytes: + format: int64 + description: '# gdata.* are outside protos with mising documentation' type: string - enum: - - REASON_UNSPECIFIED - - RESOLUTION_TIME - - TECHNICAL_EXPERTISE - - BUSINESS_IMPACT - justification: - description: >- - Required. A free text description to accompany the `reason` field - above. Provides additional context on why the case is being - escalated. + objectVersion: + description: '# gdata.* are outside protos with mising documentation' type: string - id: Escalation - description: An escalation of a support case. + id: DiffVersionResponse + description: '# gdata.* are outside protos with mising documentation' + type: object + DiffDownloadResponse: + description: '# gdata.* are outside protos with mising documentation' + properties: + objectLocation: + $ref: '#/components/schemas/CompositeMedia' + description: '# gdata.* are outside protos with mising documentation' + id: DiffDownloadResponse + type: object + CloseCaseRequest: + type: object + id: CloseCaseRequest + description: The request message for the CloseCase endpoint. + properties: {} + EscalateCaseRequest: + properties: + escalation: + $ref: '#/components/schemas/Escalation' + description: The escalation information to be sent with the escalation request. + id: EscalateCaseRequest type: object - DownloadParameters: - id: DownloadParameters + description: The request message for the EscalateCase endpoint. + ContentTypeInfo: properties: - allowGzipCompression: + fromUrlPath: description: '# gdata.* are outside protos with mising documentation' - type: boolean - ignoreRange: + type: string + fromHeader: description: '# gdata.* are outside protos with mising documentation' - type: boolean + type: string + fromFileName: + type: string + description: '# gdata.* are outside protos with mising documentation' + bestGuess: + type: string + description: '# gdata.* are outside protos with mising documentation' + fromBytes: + type: string + description: '# gdata.* are outside protos with mising documentation' + id: ContentTypeInfo + description: '# gdata.* are outside protos with mising documentation' + type: object + CreateAttachmentRequest: + properties: + attachment: + description: Required. The attachment to be created. + $ref: '#/components/schemas/Attachment' + id: CreateAttachmentRequest + description: The request message for the CreateAttachment endpoint. + type: object + ObjectId: description: '# gdata.* are outside protos with mising documentation' type: object + properties: + bucketName: + type: string + description: '# gdata.* are outside protos with mising documentation' + objectName: + description: '# gdata.* are outside protos with mising documentation' + type: string + generation: + format: int64 + type: string + description: '# gdata.* are outside protos with mising documentation' + id: ObjectId parameters: - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + 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. in: query - name: fields + name: key schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: quotaUser + name: oauth_token schema: type: string _.xgafv: @@ -841,65 +831,88 @@ components: enum: - '1' - '2' - prettyPrint: - description: Returns response with indentations and line breaks. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: prettyPrint + name: upload_protocol schema: - type: boolean - access_token: - description: OAuth access token. + type: string + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string - key: + quotaUser: 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. + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: key + name: quotaUser schema: type: string - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + alt: + description: Data format for response. in: query - name: oauth_token + name: alt schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + enum: + - json + - media + - proto + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean x-stackQL-resources: media: id: google.cloudsupport.media name: media title: Media methods: - download: + upload: operation: - $ref: '#/paths/~1v2~1{name}/get' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/post' response: mediaType: application/json openAPIDocKey: '200' - upload: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + attachments: + id: google.cloudsupport.attachments + name: attachments + title: Attachments + methods: + list: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/post' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.attachments sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/attachments/methods/list' insert: [] update: [] replace: [] @@ -909,13 +922,19 @@ components: name: cases title: Cases methods: + get: + operation: + $ref: '#/paths/~1v2~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' patch: operation: $ref: '#/paths/~1v2~1{name}/patch' response: mediaType: application/json openAPIDocKey: '200' - escalate: + close: operation: $ref: '#/paths/~1v2~1{name}/post' response: @@ -937,27 +956,26 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/cases/methods/list' + - $ref: '#/components/x-stackQL-resources/cases/methods/get' insert: - $ref: '#/components/x-stackQL-resources/cases/methods/create' update: - $ref: '#/components/x-stackQL-resources/cases/methods/patch' replace: [] delete: [] - attachments: - id: google.cloudsupport.attachments - name: attachments - title: Attachments + case_classifications: + id: google.cloudsupport.case_classifications + name: case_classifications + title: Case_classifications methods: - list: + search: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/get' + $ref: '#/paths/~1v2~1caseClassifications:search/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.attachments sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attachments/methods/list' + select: [] insert: [] update: [] replace: [] @@ -988,54 +1006,131 @@ components: update: [] replace: [] delete: [] - case_classifications: - id: google.cloudsupport.case_classifications - name: case_classifications - title: Case_classifications - methods: - search: - operation: - $ref: '#/paths/~1v2~1caseClassifications:search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] paths: - /v2/{name}: + /v2/{parentType}/{parent}/attachments: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' + post: + description: >- + Create a file attachment on a case or Cloud resource. The attachment + must have the following fields set: `filename`. EXAMPLES: cURL: ```shell + echo "This text is in a file I'm uploading using CSAPI." \ > + "./example_file.txt" case="projects/some-project/cases/43594844" curl \ + --header "Authorization: Bearer $(gcloud auth print-access-token)" \ + --data-binary @"./example_file.txt" \ + "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" + ``` Python: ```python import googleapiclient.discovery api_version = + "v2" supportApiService = googleapiclient.discovery.build( + serviceName="cloudsupport", version=api_version, + discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", + ) file_path = "./example_file.txt" with open(file_path, "w") as file: + file.write( "This text is inside a file I'm going to upload using the + Cloud Support API.", ) request = supportApiService.media().upload( + parent="projects/some-project/cases/43595344", media_body=file_path ) + request.uri = request.uri.split("?")[0] + + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) + ``` + operationId: cloudsupport.media.upload + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAttachmentRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Attachment' + parameters: + - in: path + name: parentType + required: true + schema: + type: string + - in: path + name: parent + required: true + schema: + type: string get: description: >- - Download a file attached to a case. Note: HTTP requests must append - "?alt=media" to the URL. EXAMPLES: cURL: ```shell - name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" - curl \ --header "Authorization: Bearer $(gcloud auth - print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` - Python: ```python import googleapiclient.discovery api_version = "v2" + List all the attachments associated with a support case. EXAMPLES: cURL: + ```shell case="projects/some-project/cases/23598314" curl \ --header + "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: + ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.media().download( - name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" - ) request.uri = request.uri.split("?")[0] + "?alt=media" + ) request = ( supportApiService.cases() .attachments() + .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ``` - operationId: cloudsupport.media.download + operationId: cloudsupport.cases.attachments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAttachmentsResponse' + parameters: + - in: path + name: parentType + required: true + schema: + type: string + - in: path + name: parent + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/{name}: + parameters: *ref_1 + get: + description: >- + Retrieve a case. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/16033687" curl \ --header + "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python + import googleapiclient.discovery api_version = "v2" supportApiService = + googleapiclient.discovery.build( serviceName="cloudsupport", + version=api_version, + discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", + ) request = supportApiService.cases().get( + name="projects/some-project/cases/43595344", ) print(request.execute()) + ``` + operationId: cloudsupport.cases.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1047,7 +1142,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Media' + $ref: '#/components/schemas/Case' parameters: - in: path name: name @@ -1099,30 +1194,23 @@ paths: format: google-fieldmask post: description: >- - Escalate a case, starting the Google Cloud Support escalation management - process. This operation is only available for some support services. Go - to https://cloud.google.com/support and look for 'Technical support - escalations' in the feature list to find out which ones let you do that. - EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" - curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth - print-access-token)" \ --header "Content-Type: application/json" \ - --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": - "This is a test escalation." } }' \ - "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: + Close a case. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43595344" curl \ --request POST \ + --header "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.cases().escalate( - name="projects/some-project/cases/43595344", body={ "escalation": { - "reason": "BUSINESS_IMPACT", "justification": "This is a test - escalation.", }, }, ) print(request.execute()) ``` - operationId: cloudsupport.cases.escalate + ) request = supportApiService.cases().close( + name="projects/some-project/cases/43595344" ) print(request.execute()) + ``` + operationId: cloudsupport.cases.close requestBody: content: application/json: schema: - $ref: '#/components/schemas/EscalateCaseRequest' + $ref: '#/components/schemas/CloseCaseRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1141,6 +1229,53 @@ paths: required: true schema: type: string + /v2/caseClassifications:search: + parameters: *ref_1 + get: + description: >- + Retrieve valid classifications to use when creating a support case. + Classifications are hierarchical. Each classification is a string + containing all levels of the hierarchy separated by `" > "`. For + example, `"Technical Issue > Compute > Compute Engine"`. Classification + IDs returned by this endpoint are valid for at least six months. When a + classification is deactivated, this endpoint immediately stops returning + it. After six months, `case.create` requests using the classification + will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: + Bearer $(gcloud auth print-access-token)" \ + 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' + ``` Python: ```python import googleapiclient.discovery supportApiService + = googleapiclient.discovery.build( serviceName="cloudsupport", + version="v2", + discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", + ) request = supportApiService.caseClassifications().search( + query='display_name:"*Compute Engine*"' ) print(request.execute()) ``` + operationId: cloudsupport.caseClassifications.search + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SearchCaseClassificationsResponse' + parameters: + - in: query + name: query + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v2/{parentType}/{parent}/cases: parameters: *ref_1 get: @@ -1183,10 +1318,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: @@ -1196,6 +1327,10 @@ paths: name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string post: description: >- Create a new case and associate it with a parent. It must have the @@ -1250,103 +1385,6 @@ paths: required: true schema: type: string - /v2/{parentType}/{parent}/attachments: - parameters: *ref_1 - get: - description: >- - List all the attachments associated with a support case. EXAMPLES: cURL: - ```shell case="projects/some-project/cases/23598314" curl \ --header - "Authorization: Bearer $(gcloud auth print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: - ```python import googleapiclient.discovery api_version = "v2" - supportApiService = googleapiclient.discovery.build( - serviceName="cloudsupport", version=api_version, - discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = ( supportApiService.cases() .attachments() - .list(parent="projects/some-project/cases/43595344") ) - print(request.execute()) ``` - operationId: cloudsupport.cases.attachments.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListAttachmentsResponse' - parameters: - - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: >- - Create a file attachment on a case or Cloud resource. The attachment - must have the following fields set: `filename`. EXAMPLES: cURL: ```shell - echo "This text is in a file I'm uploading using CSAPI." \ > - "./example_file.txt" case="projects/some-project/cases/43594844" curl \ - --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - --data-binary @"./example_file.txt" \ - "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" - ``` Python: ```python import googleapiclient.discovery api_version = - "v2" supportApiService = googleapiclient.discovery.build( - serviceName="cloudsupport", version=api_version, - discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) file_path = "./example_file.txt" with open(file_path, "w") as file: - file.write( "This text is inside a file I'm going to upload using the - Cloud Support API.", ) request = supportApiService.media().upload( - parent="projects/some-project/cases/43595344", media_body=file_path ) - request.uri = request.uri.split("?")[0] + - "?attachment.filename=uploaded_via_python.txt" print(request.execute()) - ``` - operationId: cloudsupport.media.upload - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAttachmentRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Attachment' - parameters: - - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent - required: true - schema: - type: string /v2/{parentType}/{parent}/comments: parameters: *ref_1 post: @@ -1440,50 +1478,3 @@ paths: schema: type: integer format: int32 - /v2/caseClassifications:search: - parameters: *ref_1 - get: - description: >- - Retrieve valid classifications to use when creating a support case. - Classifications are hierarchical. Each classification is a string - containing all levels of the hierarchy separated by `" > "`. For - example, `"Technical Issue > Compute > Compute Engine"`. Classification - IDs returned by this endpoint are valid for at least six months. When a - classification is deactivated, this endpoint immediately stops returning - it. After six months, `case.create` requests using the classification - will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: - Bearer $(gcloud auth print-access-token)" \ - 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' - ``` Python: ```python import googleapiclient.discovery supportApiService - = googleapiclient.discovery.build( serviceName="cloudsupport", - version="v2", - discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", - ) request = supportApiService.caseClassifications().search( - query='display_name:"*Compute Engine*"' ) print(request.execute()) ``` - operationId: cloudsupport.caseClassifications.search - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SearchCaseClassificationsResponse' - parameters: - - in: query - name: query - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml index 5ebac79b..c79fac29 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml @@ -7,8 +7,8 @@ info: title: Cloud Tasks API description: Manages the execution of large numbers of distributed requests. version: v2 - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/tasks/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml index 76fc2ee1..cb8257d2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml @@ -13,7 +13,7 @@ info: your application for Cloud Trace, we recommend using OpenTelemetry. version: v2 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/trace servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/composer.yaml b/providers/src/googleapis.com/v00.00.00000/services/composer.yaml index 43666022..474aa905 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/composer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/composer.yaml @@ -8,7 +8,7 @@ info: description: Manages Apache Airflow environments on Google Cloud Platform. version: v1 x-discovery-doc-revision: '20240831' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/composer/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/compute.yaml b/providers/src/googleapis.com/v00.00.00000/services/compute.yaml index 6dde7a82..d677f32a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/compute.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/compute.yaml @@ -7,8 +7,8 @@ info: title: Compute Engine API description: 'Creates and runs virtual machines on Google Cloud Platform. ' version: v1 - x-discovery-doc-revision: '20240903' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/compute/ servers: @@ -9904,10 +9904,12 @@ components: - No type specified. Do not use this value. - AMD Secure Encrypted Virtualization. - AMD Secure Encrypted Virtualization - Secure Nested Paging. + - Intel Trust Domain eXtension. enum: - CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED - SEV - SEV_SNP + - TDX AdvancedMachineFeatures: id: AdvancedMachineFeatures description: >- @@ -30145,12 +30147,12 @@ components: requestedFeatures: description: >- Optional. List of features requested for this Interconnect - connection, which can take one of the following values: - MACSEC If - specified then the connection is created on MACsec capable hardware - ports. If not specified, the default value is false, which allocates - non-MACsec capable ports first if available. This parameter can be - provided only with Interconnect INSERT. It isn't valid for - Interconnect PATCH. + connection, which can take one of the following values: - IF_MACSEC + If specified then the connection is created on MACsec capable + hardware ports. If not specified, the default value is false, which + allocates non-MACsec capable ports first if available. This + parameter can be provided only with Interconnect INSERT. It isn't + valid for Interconnect PATCH. type: array items: type: string @@ -30161,8 +30163,8 @@ components: availableFeatures: description: >- [Output only] List of features available for this Interconnect - connection, which can take one of the following values: - MACSEC If - present then the Interconnect connection is provisioned on MACsec + connection, which can take one of the following values: - IF_MACSEC + If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. diff --git a/providers/src/googleapis.com/v00.00.00000/services/config.yaml b/providers/src/googleapis.com/v00.00.00000/services/config.yaml index 842b05ec..73e648fd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/config.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/config.yaml @@ -7,8 +7,8 @@ info: title: Infrastructure Manager API description: Creates and manages Google Cloud Platform resources and infrastructure. version: v1 - x-discovery-doc-revision: '20240828' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/infrastructure-manager/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml b/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml index 70017e98..787e312c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml @@ -10,7 +10,7 @@ info: third-party business applications using the Connectors interface. version: v2 x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: >- https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors diff --git a/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml b/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml index 1db30765..55a8e78d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml @@ -7,8 +7,8 @@ info: title: Contact Center AI Platform API description: '' version: v1alpha1 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240911' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/solutions/contact-center-ai-platform servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml index 805ef09e..e7d4525b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml @@ -7,8 +7,8 @@ info: title: Contact Center AI Insights API description: '' version: v1 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/contact-center/insights/docs servers: @@ -34,1329 +34,1489 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: - description: The response for a bulk analyze conversations operation. - properties: - successfulAnalysisCount: - description: Count of successful analyses. - format: int32 - type: integer - failedAnalysisCount: - format: int32 - description: Count of failed analyses. - type: integer - type: object - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse - GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: + GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: properties: - bucketUri: - type: string - description: Required. The Cloud Storage bucket containing source objects. - bucketObjectType: - enumDescriptions: - - The object type is unspecified and will default to `TRANSCRIPT`. - - The object is a transcript. - - The object is an audio file. - description: Optional. Specifies the type of the objects in `bucket_uri`. - enum: - - BUCKET_OBJECT_TYPE_UNSPECIFIED - - TRANSCRIPT - - AUDIO + queryRecord: type: string - customMetadataKeys: - type: array description: >- - Optional. Custom keys to extract as conversation labels from - metadata files in `metadata_bucket_uri`. Keys not included in this - field will be ignored. Note that there is a limit of 20 labels per - conversation. - items: + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + source: + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + type: string + uri: + type: string + description: Article URI. + metadata: + type: object + additionalProperties: type: string - metadataBucketUri: description: >- - Optional. The Cloud Storage path to the conversation metadata. Note - that: [1] Metadata files are expected to be in JSON format. [2] - Metadata and source files (transcripts or audio) must be in separate - buckets. [3] A source file and its corresponding metadata file must - share the same name to be properly ingested, E.g. - `gs://bucket/audio/conversation1.mp3` and - `gs://bucket/metadata/conversation1.json`. + Map that contains metadata about the Article Suggestion and the + document that it originates from. + title: + description: Article title. type: string - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource + confidenceScore: + description: >- + The system's confidence score that this article is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + format: float + type: number + description: Agent Assist Article Suggestion data. + id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData type: object - description: Configuration for Cloud Storage bucket sources. - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: + GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: properties: - name: - description: Required. The issue model to deploy. + issue: type: string - description: The request to deploy an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - type: object - GoogleCloudContactcenterinsightsV1PhraseMatcher: - id: GoogleCloudContactcenterinsightsV1PhraseMatcher - properties: - activationUpdateTime: description: >- - Output only. The most recent time at which the activation status was - updated. - format: google-datetime - type: string - readOnly: true - name: + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + labeledConversationsCount: type: string - description: >- - The resource name of the phrase matcher. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + description: Number of conversations attached to the issue at this point in time. + format: int64 displayName: - description: The human-readable name of the phrase matcher. - type: string - revisionCreateTime: - readOnly: true - format: google-datetime - description: >- - Output only. The timestamp of when the revision was created. It is - also the create time when a new matcher is added. type: string - roleMatch: - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT + description: Display name of the issue. + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + type: object + description: Aggregated statistics about an issue. + GoogleCloudContactcenterinsightsV1ExactMatchConfig: + id: GoogleCloudContactcenterinsightsV1ExactMatchConfig + type: object + properties: + caseSensitive: + description: Whether to consider case sensitivity when performing an exact match. + type: boolean + description: Exact match configuration. + GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: + id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + properties: + suggestion: type: string + description: The content of the suggestion. + confidenceScore: description: >- - The role whose utterances the phrase matcher should be matched - against. If the role is ROLE_UNSPECIFIED it will be matched against - any utterances in the transcript. - updateTime: + The system's confidence score that this suggestion is a good match + for this conversation, ranging from 0.0 (completely uncertain) to + 1.0 (completely certain). + type: number + format: double + queryRecord: description: >- - Output only. The most recent time at which the phrase matcher was - updated. + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - readOnly: true - format: google-datetime - phraseMatchRuleGroups: + metadata: + type: object + additionalProperties: + type: string + description: >- + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. + description: Agent Assist Smart Compose suggestion data. + type: object + GoogleProtobufEmpty: + properties: {} + id: GoogleProtobufEmpty + 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); } + type: object + GoogleCloudContactcenterinsightsV1ListAnalysesResponse: + properties: + analyses: type: array - description: A list of phase match rule groups that are included in this matcher. items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup - revisionId: - readOnly: true - description: >- - Output only. Immutable. The revision ID of the phrase matcher. A new - revision is committed whenever the matcher is changed, except when - it is activated or deactivated. A server generated random ID will be - used. Example: - locations/global/phraseMatchers/my-first-matcher@1234567 - type: string - active: - type: boolean - description: Applies the phrase matcher only when it is active. - type: - type: string - description: Required. The type of this phrase matcher. - enum: - - PHRASE_MATCHER_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - enumDescriptions: - - Unspecified. - - Must meet all phrase match rule groups or there is no match. - - If any of the phrase match rule groups are met, there is a match. - versionTag: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + description: The analyses that match the request. + nextPageToken: description: >- - The customized version tag to use for the phrase matcher. If not - specified, it will default to `revision_id`. + 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 - description: The phrase matcher resource. + id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse + description: The response to list analyses. type: object - GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: - description: Conversation metadata related to quality management. + GoogleCloudContactcenterinsightsV1HoldData: type: object + description: The data for a hold annotation. + properties: {} + id: GoogleCloudContactcenterinsightsV1HoldData + GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: + id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse properties: - waitDuration: - format: google-duration - description: The amount of time the customer waited to connect with an agent. - type: string - agentInfo: - description: Information about agents involved in the call. - type: array + phraseMatchers: + description: The phrase matchers that match the request. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo - menuPath: - type: string - description: >- - An arbitrary string value specifying the menu path the customer - took. - customerSatisfactionRating: - type: integer - format: int32 + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + type: array + nextPageToken: description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - GoogleCloudContactcenterinsightsV1PhraseMatchRule: + 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 + description: The response of listing phrase matchers. + type: object + GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: type: object - description: The data for a phrase match rule. - id: GoogleCloudContactcenterinsightsV1PhraseMatchRule properties: - query: + inspectTemplate: type: string - description: Required. The phrase to be matched. - negated: description: >- - Specifies whether the phrase must be missing from the transcript - segment or present in the transcript segment. - type: boolean - config: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` + deidentifyTemplate: description: >- - Provides additional information about the rule that specifies how to - apply the rule. - GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` + type: string + id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + description: >- + DLP resources used for redaction while ingesting conversations. DLP + settings are applied to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversation coming from CCAI Platform. They are not applied to + conversations ingested from the `CreateConversation` endpoint or the + Dialogflow / Agent Assist runtime integrations. When using Dialogflow / + Agent Assist runtime integrations, redaction should be performed in + Dialogflow / Agent Assist. + GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: type: object - description: A message representing a rule in the phrase matcher. + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource + description: Configuration for Cloud Storage bucket sources. properties: - type: - description: Required. The type of this phrase match rule group. + bucketUri: type: string - enum: - - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - enumDescriptions: - - Unspecified. - - Must meet all phrase match rules or there is no match. - - If any of the phrase match rules are met, there is a match. - phraseMatchRules: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule + description: Required. The Cloud Storage bucket containing source objects. + metadataBucketUri: + description: >- + Optional. The Cloud Storage path to the conversation metadata. Note + that: [1] Metadata files are expected to be in JSON format. [2] + Metadata and source files (transcripts or audio) must be in separate + buckets. [3] A source file and its corresponding metadata file must + share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. + type: string + customMetadataKeys: + description: >- + Optional. Custom keys to extract as conversation labels from + metadata files in `metadata_bucket_uri`. Keys not included in this + field will be ignored. Note that there is a limit of 20 labels per + conversation. type: array - description: A list of phrase match rules that are included in this group. - GoogleCloudContactcenterinsightsV1Analysis: + items: + type: string + bucketObjectType: + description: Optional. Specifies the type of the objects in `bucket_uri`. + type: string + enumDescriptions: + - The object type is unspecified and will default to `TRANSCRIPT`. + - The object is a transcript. + - The object is an audio file. + enum: + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO + GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: type: object properties: - requestTime: - description: Output only. The time at which the analysis was requested. - format: google-datetime - type: string - readOnly: true - name: + medium: + deprecated: true type: string + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - analysisResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult + Medium of conversations used in training data. This field is being + deprecated. To specify the medium to be used in training a new issue + model, set the `medium` field on `filter`. + filter: description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. + A filter to reduce the conversations used for training the model to + a specific subset. + type: string + trainingConversationsCount: + type: string + format: int64 + description: Output only. Number of conversations used in training. Output only. readOnly: true + description: Configs for the input data used to create the issue model. + id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: + description: The response to undeploy an issue model. + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse + properties: {} + type: object + GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: + properties: {} + description: Response for an export insights operation. + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse + type: object + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: + properties: + request: + description: The original import request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + endTime: + type: string + format: google-datetime + description: The time the operation finished running. createTime: - description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. + description: The time the operation was created. type: string + format: google-datetime + type: object + description: Metadata used for import issue model. + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata + GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata + type: object + properties: + createTime: + format: google-datetime + description: Output only. The time the operation was created. readOnly: true + type: string + endTime: format: google-datetime + type: string + description: Output only. The time the operation finished running. + readOnly: true + conversation: + type: string + readOnly: true + description: >- + Output only. The Conversation that this Analysis Operation belongs + to. annotatorSelector: + readOnly: true + description: Output only. The annotator selector used for the analysis (if any). $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - description: The analysis resource. - id: GoogleCloudContactcenterinsightsV1Analysis - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + description: Metadata for a create analysis operation. + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse type: object + description: The response for a bulk delete conversations operation. + GoogleCloudContactcenterinsightsV1Settings: + type: object + description: >- + The CCAI Insights project wide settings. Use these settings to configure + the behavior of Insights. View these settings with + [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) + and change the settings with + [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). + id: GoogleCloudContactcenterinsightsV1Settings properties: - name: + createTime: type: string - description: Required. The issue model to undeploy. - description: The request to undeploy an issue model. - GoogleCloudContactcenterinsightsV1ArticleSuggestionData: - id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData - properties: - source: + description: Output only. The time at which the settings was created. + format: google-datetime + readOnly: true + updateTime: + format: google-datetime + description: Output only. The time at which the settings were last updated. type: string + readOnly: true + conversationTtl: description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} - confidenceScore: - format: float + The default TTL for newly-created conversations. If a conversation + has a specified expiration, that value will be used instead. + Changing this value will not change the expiration of existing + conversations. Conversations with no expire time persist until they + are deleted. + format: google-duration + type: string + analysisConfig: + description: Default analysis settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + speechConfig: description: >- - The system's confidence score that this article is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - type: number - queryRecord: + Optional. Default Speech-to-Text resources to use while ingesting + audio files. Optional, CCAI Insights will create a default if not + provided. This applies to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversations coming from CCAI Platform. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + name: + description: >- + Immutable. The resource name of the settings resource. Format: + projects/{project}/locations/{location}/settings type: string + redactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - title: + Default DLP redaction resources to be applied while ingesting + conversations. This applies to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversations coming from CCAI Platform. + languageCode: + description: >- + A language code to be applied to each transcript segment unless the + segment already specifies a language code. Language code defaults to + "en-US" if it is neither specified on the segment nor here. type: string - description: Article title. - metadata: - type: object + pubsubNotificationSettings: additionalProperties: type: string description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. - uri: - description: Article URI. + A map that maps a notification trigger to a Pub/Sub topic. Each time + a specified trigger occurs, Insights will notify the corresponding + Pub/Sub topic. Keys are notification triggers. Supported keys are: * + "all-triggers": Notify each time any of the supported triggers + occurs. * "create-analysis": Notify each time an analysis is + created. * "create-conversation": Notify each time a conversation is + created. * "export-insights-data": Notify each time an export is + complete. * "ingest-conversations": Notify each time an + IngestConversations LRO is complete. * "update-conversation": Notify + each time a conversation is updated via UpdateConversation. * + "upload-conversation": Notify when an UploadConversation LRO is + complete. Values are Pub/Sub topics. The format of each Pub/Sub + topic is: projects/{project}/topics/{topic} + type: object + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: + properties: + bigQueryDestination: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + description: Specified if sink is a BigQuery table. + writeDisposition: + enumDescriptions: + - Write disposition is not specified. Defaults to WRITE_TRUNCATE. + - >- + If the table already exists, BigQuery will overwrite the table + data and use the schema from the load. + - >- + If the table already exists, BigQuery will append data to the + table. + type: string + enum: + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND + description: Options for what to do if the destination table already exists. + filter: + description: >- + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. + type: string + kmsKey: + description: >- + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + type: string + parent: type: string + description: Required. The parent resource to export data from. + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest type: object - description: Agent Assist Article Suggestion data. - GoogleCloudContactcenterinsightsV1AnnotationBoundary: + description: The request to export insights. + GoogleCloudContactcenterinsightsV1CalculateStatsResponse: + description: The response for calculating conversation statistics. + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse type: object - id: GoogleCloudContactcenterinsightsV1AnnotationBoundary properties: - wordIndex: + conversationCount: format: int32 type: integer + description: The total number of conversations. + conversationCountTimeSeries: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. - transcriptIndex: - type: integer + A time series representing the count of conversations created over + time that match that requested filter criteria. + smartHighlighterMatches: + additionalProperties: + format: int32 + type: integer + type: object description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. + A map associating each smart highlighter display name with its + respective number of matches in the set of conversations. + issueMatchesStats: + description: >- + A map associating each issue resource name with its respective + number of matches in the set of conversations. Key has the format: + `projects//locations//issueModels//issues/` + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + type: object + issueMatches: + deprecated: true + type: object + description: >- + A map associating each issue resource name with its respective + number of matches in the set of conversations. Key has the format: + `projects//locations//issueModels//issues/` Deprecated, use + `issue_matches_stats` field instead. + additionalProperties: + type: integer + format: int32 + customHighlighterMatches: + additionalProperties: + type: integer + format: int32 + description: >- + A map associating each custom highlighter resource name with its + respective number of matches in the set of conversations. + type: object + averageTurnCount: + description: The average number of turns per conversation. format: int32 - description: >- - A point in a conversation that marks the start or the end of an - annotation. - GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: - description: Response of querying an issue model's statistics. - type: object - id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse - properties: - currentStats: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + type: integer + averageDuration: + type: string + format: google-duration description: >- - The latest label statistics for the queried issue model. Includes - results on both training data and data labeled after deployment. - GoogleCloudContactcenterinsightsV1SpeechConfig: - id: GoogleCloudContactcenterinsightsV1SpeechConfig - description: >- - Speech-to-Text configuration. Speech-to-Text settings are applied to - conversations ingested from the `UploadConversation` and - `IngestConversations` endpoints, including conversation coming from CCAI - Platform. They are not applied to conversations ingested from the - `CreateConversation` endpoint. + The average duration of all conversations. The average is calculated + using only conversations that have a time duration. + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. type: object properties: - speechRecognizer: + nextPageToken: + description: The standard List next-page token. type: string + operations: description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` - GoogleCloudContactcenterinsightsV1ConversationTranscript: - properties: - transcriptSegments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment - description: >- - A list of sequential transcript segments that comprise the - conversation. + A list of operations that matches the specified filter in the + request. type: array - description: A message representing the transcript of a conversation. + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + description: A Dialogflow source of conversation data. type: object - id: GoogleCloudContactcenterinsightsV1ConversationTranscript - GoogleCloudContactcenterinsightsV1DialogflowSource: properties: audioUri: + type: string description: >- Cloud Storage URI that points to a file that contains the conversation audio. - type: string dialogflowConversation: - readOnly: true type: string + readOnly: true description: >- Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} - id: GoogleCloudContactcenterinsightsV1DialogflowSource - type: object - description: A Dialogflow source of conversation data. - GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: - id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse - properties: {} - description: The response to deploy an issue model. - type: object - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: - description: Google Cloud Storage Object URI to get the issue model file from. + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata: properties: - objectUri: + createTime: + readOnly: true + format: google-datetime + description: Output only. The time the operation was created. type: string - description: 'Required. Format: `gs:///`' - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - type: object - GoogleCloudContactcenterinsightsV1RedactionConfig: - type: object - properties: - inspectTemplate: + request: + description: Output only. The original request for initialization. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + partialErrors: description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` - type: string - deidentifyTemplate: + Partial errors during initialising operation that might cause the + operation output to be incomplete. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + endTime: + readOnly: true + format: google-datetime + description: Output only. The time the operation finished running. type: string - description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` - description: >- - DLP resources used for redaction while ingesting conversations. DLP - settings are applied to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversation coming from CCAI Platform. They are not applied to - conversations ingested from the `CreateConversation` endpoint or the - Dialogflow / Agent Assist runtime integrations. When using Dialogflow / - Agent Assist runtime integrations, redaction should be performed in - Dialogflow / Agent Assist. - id: GoogleCloudContactcenterinsightsV1RedactionConfig - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: - description: Metadata from Dialogflow relating to the current transcript segment. + description: Metadata for initializing a location-level encryption specification. + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata type: object - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - properties: - smartReplyAllowlistCovered: - type: boolean - description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - GoogleCloudContactcenterinsightsV1IntentMatchData: + GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: + description: Request to import an issue model. type: object - id: GoogleCloudContactcenterinsightsV1IntentMatchData - description: >- - The data for an intent match. Represents an intent match for a text - segment in the conversation. A text segment can be part of a sentence, a - complete sentence, or an utterance with multiple sentences. properties: - intentUniqueId: + gcsSource: + description: Google Cloud Storage source message. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource + createNewModel: + type: boolean description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. + Optional. If set to true, will create an issue model from the + imported file with randomly generated IDs for the issue model and + corresponding issues. Otherwise, replaces an existing model with the + same ID as the file. + parent: type: string - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: + description: Required. The parent resource of the issue model. + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + GoogleCloudContactcenterinsightsV1PhraseMatcher: + description: The phrase matcher resource. + id: GoogleCloudContactcenterinsightsV1PhraseMatcher properties: - unclassifiedConversationsCount: - type: string - format: int64 - description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. - issueStats: - type: object - description: Statistics on each issue. Key is the issue's resource name. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats - analyzedConversationsCount: - format: int64 + updateTime: description: >- - Number of conversations the issue model has analyzed at this point - in time. + Output only. The most recent time at which the phrase matcher was + updated. + readOnly: true + format: google-datetime type: string - type: object - description: Aggregated statistics about an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats - GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: - id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse - description: Response from import issue model - properties: {} - type: object - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: - type: object - properties: - conversationConfig: - description: Configuration that applies to all conversations. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + roleMatch: + type: string + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - transcriptObjectConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for when `source` contains conversation transcripts. - parent: + The role whose utterances the phrase matcher should be matched + against. If the role is ROLE_UNSPECIFIED it will be matched against + any utterances in the transcript. + type: + type: string + enumDescriptions: + - Unspecified. + - Must meet all phrase match rule groups or there is no match. + - If any of the phrase match rule groups are met, there is a match. + description: Required. The type of this phrase matcher. + enum: + - PHRASE_MATCHER_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + displayName: + type: string + description: The human-readable name of the phrase matcher. + name: type: string - description: Required. The parent resource for new conversations. - speechConfig: description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - gcsSource: + The resource name of the phrase matcher. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + revisionCreateTime: + type: string + format: google-datetime + readOnly: true description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - sampleSize: + Output only. The timestamp of when the revision was created. It is + also the create time when a new matcher is added. + revisionId: description: >- - Optional. If set, this fields indicates the number of objects to - ingest from the Cloud Storage bucket. If empty, the entire bucket - will be ingested. Unless they are first deleted, conversations - produced through sampling won't be ingested by subsequent ingest - requests. - format: int32 - type: integer - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - description: The request to ingest conversations. - GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - description: The request to create an issue model. - properties: - issueModel: - description: Required. The issue model to create. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - parent: - description: Required. The parent resource of the issue model. + Output only. Immutable. The revision ID of the phrase matcher. A new + revision is committed whenever the matcher is changed, except when + it is activated or deactivated. A server generated random ID will be + used. Example: + locations/global/phraseMatchers/my-first-matcher@1234567 + readOnly: true type: string - type: object - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: - type: object - properties: - createTime: - format: google-datetime - description: The time the operation was created. + versionTag: + description: >- + The customized version tag to use for the phrase matcher. If not + specified, it will default to `revision_id`. type: string - request: - description: The original request for bulk delete. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest - partialErrors: - type: array + phraseMatchRuleGroups: items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Partial errors during bulk delete conversations operation that might - cause the operation output to be incomplete. - endTime: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + type: array + description: A list of phase match rule groups that are included in this matcher. + activationUpdateTime: + readOnly: true type: string - description: The time the operation finished running. format: google-datetime - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata - description: The metadata for a bulk delete conversations operation. - GoogleCloudContactcenterinsightsV1alpha1Analysis: - description: The analysis resource. - id: GoogleCloudContactcenterinsightsV1alpha1Analysis + description: >- + Output only. The most recent time at which the activation status was + updated. + active: + type: boolean + description: Applies the phrase matcher only when it is active. type: object + GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: properties: - analysisResult: + endTime: + description: Output only. The time the operation finished running. readOnly: true - description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. + type: string + format: google-datetime + annotatorSelector: + readOnly: true + description: Output only. The annotator selector used for the analysis (if any). $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector createTime: readOnly: true format: google-datetime type: string - description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. - name: + description: Output only. The time the operation was created. + conversation: type: string description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - requestTime: - format: google-datetime + Output only. The Conversation that this Analysis Operation belongs + to. readOnly: true - description: Output only. The time at which the analysis was requested. - type: string - annotatorSelector: - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - GoogleCloudContactcenterinsightsV1EncryptionSpec: - id: GoogleCloudContactcenterinsightsV1EncryptionSpec + description: Metadata for a create analysis operation. type: object - description: >- - A customer-managed encryption key specification that can be applied to - all created resources (e.g. Conversation). + id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata + GoogleCloudContactcenterinsightsV1AnnotatorSelector: properties: - kmsKey: - type: string + phraseMatchers: description: >- - Required. The name of customer-managed encryption key that is used - to secure a resource and its sub-resources. If empty, the resource - is secured by the default Google encryption key. Only the key in the - same location as this resource is allowed to be used for encryption. - Format: - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` - name: - type: string + The list of phrase matchers to run. If not provided, all active + phrase matchers will be used. If inactive phrase matchers are + provided, they will not be used. Phrase matchers will be run only if + run_phrase_matcher_annotator is set to true. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + type: array + items: + type: string + runSentimentAnnotator: + type: boolean + description: Whether to run the sentiment annotator. + summarizationConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + description: Configuration for the summarization annotator. + runInterruptionAnnotator: + description: Whether to run the interruption annotator. + type: boolean + issueModels: + items: + type: string description: >- - Immutable. The resource name of the encryption key specification - resource. Format: - projects/{project}/locations/{location}/encryptionSpec - GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: - description: Configuration for summarization. - type: object - id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - properties: - summarizationModel: - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - type: string - description: Default summarization model to be used. - enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 - conversationProfile: - type: string - description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination - description: A BigQuery Table Reference. - properties: - projectId: - type: string - description: >- - A project ID or number. If specified, then export will attempt to - write data to this project instead of the resource project. - Otherwise, the resource project will be used. - table: - type: string - description: >- - The BigQuery table name to which the insights data should be - written. If this table does not exist, the export call returns an - INVALID_ARGUMENT error. - dataset: - type: string + The issue model to run. If not provided, the most recently deployed + topic model will be used. The provided issue model will only be used + for inference if the issue model is deployed and if + run_issue_model_annotator is set to true. If more than one issue + model is provided, only the first provided issue model will be used + for inference. + type: array + runIssueModelAnnotator: description: >- - Required. The name of the BigQuery dataset that the snapshot result - should be exported to. If this dataset does not exist, the export - call returns an INVALID_ARGUMENT error. - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse - properties: {} - description: Response from export issue model + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + type: boolean + runPhraseMatcherAnnotator: + type: boolean + description: Whether to run the active phrase matcher annotator(s). + runEntityAnnotator: + type: boolean + description: Whether to run the entity annotator. + runSummarizationAnnotator: + type: boolean + description: Whether to run the summarization annotator. + runSilenceAnnotator: + description: Whether to run the silence annotator. + type: boolean + runIntentAnnotator: + description: Whether to run the intent annotator. + type: boolean + description: Selector of all available annotators and phrase matchers to run. + id: GoogleCloudContactcenterinsightsV1AnnotatorSelector type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: + GoogleCloudContactcenterinsightsV1alpha1IssueModel: + description: The issue model resource. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModel type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo properties: - startOffset: + name: type: string - format: google-duration - description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. - confidence: - type: number description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - word. A default value of 0.0 indicates that the value is unset. - format: float - endOffset: - format: google-duration + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + displayName: type: string + description: The representative name for the issue model. + trainingStats: description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. - word: - description: The word itself. Includes punctuation marks that surround the word. - type: string - description: Word-level info for words in a transcript. - GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: - properties: - endTime: + Output only. Immutable. The issue model's label statistics on its + training data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats readOnly: true + modelType: + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 + description: Type of the model. type: string - description: Output only. The time the operation finished running. - format: google-datetime - annotatorSelector: + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + state: + type: string + description: Output only. State of the model. readOnly: true - description: Output only. The annotator selector used for the analysis (if any). + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + enumDescriptions: + - Unspecified. + - Model is not deployed but is ready to deploy. + - Model is being deployed. + - >- + Model is deployed and is ready to be used. A model can only be + used in analysis if it's in this state. + - Model is being undeployed. + - Model is being deleted. + inputDataConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - conversation: - readOnly: true - description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - type: string + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + description: Configs for the input data that used to create the issue model. createTime: readOnly: true + type: string + description: Output only. The time at which this issue model was created. format: google-datetime - description: Output only. The time the operation was created. + issueCount: type: string - id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata - type: object - description: Metadata for a create analysis operation. - GoogleCloudContactcenterinsightsV1DialogflowInteractionData: - description: Dialogflow interaction data. - id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData - properties: - confidence: + format: int64 + readOnly: true + description: Output only. Number of issues in this issue model. + updateTime: + readOnly: true + format: google-datetime description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). - format: float - type: number - dialogflowIntentId: + Output only. The most recent time at which the issue model was + updated. type: string - description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} - type: object - GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: - description: The request to delete an issue model. + languageCode: + type: string + description: Language of the model. + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: properties: - name: + parent: type: string - description: Required. The name of the issue model to delete. + description: Required. The parent resource of the issue model. + gcsSource: + description: Google Cloud Storage source message. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + createNewModel: + description: >- + Optional. If set to true, will create an issue model from the + imported file with randomly generated IDs for the issue model and + corresponding issues. Otherwise, replaces an existing model with the + same ID as the file. + type: boolean type: object - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + description: Request to import an issue model. + GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: properties: - endTime: - readOnly: true - description: Output only. The time the operation finished running. - type: string - format: google-datetime - createTime: - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true + displayName: type: string - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - description: The original request for deletion. - description: Metadata for deleting an issue model. + description: The human-readable name of the intent. + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. type: object - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata - GoogleCloudContactcenterinsightsV1ListIssuesResponse: + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - description: The response of listing issues. properties: - issues: + details: items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - description: The issues that match the request. - id: GoogleCloudContactcenterinsightsV1ListIssuesResponse - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: - description: Request to export an issue model. - properties: - name: - type: string - description: Required. The issue model to export. - gcsDestination: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - description: Google Cloud Storage URI to export the issue model to. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + id: GoogleRpcStatus + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: + description: Conversation summarization suggestion data. + id: >- + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData properties: - filter: + text: + description: The summarization content that is concatenated into one string. type: string - description: Filter used to select the subset of conversations to delete. - parent: + conversationModel: description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} type: string - maxDeleteCount: - format: int32 - description: Maximum number of conversations to delete. - type: integer - force: - description: >- - If set to true, all of this conversation's analyses will also be - deleted. Otherwise, the request will only succeed if the - conversation has no analyses. - type: boolean - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest - type: object - description: The request to delete conversations in bulk. - GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse - type: object - description: The response to undeploy an issue model. - properties: {} - GoogleCloudContactcenterinsightsV1ListAnalysesResponse: - description: The response to list analyses. - properties: - nextPageToken: + answerRecord: 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. + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - analyses: - type: array - description: The analyses that match the request. - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' - id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse - type: object - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: - type: object - description: Call-specific metadata created during analysis. - properties: - annotations: - type: array - description: A list of call annotations that apply to this call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation - phraseMatchers: - description: All the matched phrase matchers in the call. + confidence: + format: float + type: number + description: The confidence score of the summarization. + metadata: additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + type: string + description: >- + A map that contains metadata about the summarization and the + document from which it originates. type: object - intents: - description: All the matched intents in the call. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent + textSections: type: object - sentiments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - type: array - description: Overall conversation-level sentiment for each channel of the call. - entities: - description: All the entities in the call. additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity - type: object - issueModelResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - description: Overall conversation-level issue modeling result. - silence: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence - description: Overall conversation-level silence during the call. + type: string + description: >- + The summarization content that is divided into sections. The key is + the section's name and the value is the section's content. There is + no specific format for the key or value. + type: object + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: + description: Configuration for summarization. id: >- - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: - description: Conversation-level silence data. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + type: object properties: - silencePercentage: + conversationProfile: + description: >- + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + type: string + summarizationModel: + type: string + enum: + - SUMMARIZATION_MODEL_UNSPECIFIED + - BASELINE_MODEL + - BASELINE_MODEL_V2_0 + enumDescriptions: + - Unspecified summarization model. + - The CCAI baseline model. + - The CCAI baseline model, V2.0. + description: Default summarization model to be used. + GoogleCloudContactcenterinsightsV1SentimentData: + type: object + id: GoogleCloudContactcenterinsightsV1SentimentData + properties: + score: + type: number + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + format: float + magnitude: + description: >- + A non-negative number from 0 to infinity which represents the + abolute magnitude of sentiment regardless of score. format: float type: number - description: Percentage of the total conversation spent in silence. - silenceDuration: - type: string - description: Amount of time calculated to be in silence. - format: google-duration + description: The data for a sentiment annotation. + GoogleCloudContactcenterinsightsV1IngestConversationsRequest: type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: - description: Conversation metadata related to quality management. + description: The request to ingest conversations. properties: - menuPath: + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + description: >- + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. + parent: type: string + description: Required. The parent resource for new conversations. + transcriptObjectConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for when `source` contains conversation transcripts. + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource description: >- - An arbitrary string value specifying the menu path the customer - took. - agentInfo: - type: array - description: Information about agents involved in the call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - customerSatisfactionRating: - type: integer + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + conversationConfig: + description: Configuration that applies to all conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig + redactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + description: >- + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. + sampleSize: format: int32 description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - waitDuration: - format: google-duration - type: string - description: The amount of time the customer waited to connect with an agent. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata + Optional. If set, this fields indicates the number of objects to + ingest from the Cloud Storage bucket. If empty, the entire bucket + will be ingested. Unless they are first deleted, conversations + produced through sampling won't be ingested by subsequent ingest + requests. + type: integer + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: + description: The response to deploy an issue model. + properties: {} type: object - description: Metadata for an export insights operation. + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: properties: - endTime: + word: type: string - description: Output only. The time the operation finished running. - readOnly: true - format: google-datetime - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array + description: The word itself. Includes punctuation marks that surround the word. + confidence: description: >- - Partial errors during export operation that might cause the - operation output to be incomplete. - createTime: + A confidence estimate between 0.0 and 1.0 of the fidelity of this + word. A default value of 0.0 indicates that the value is unset. + type: number + format: float + endOffset: type: string - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true - request: - description: The original request for export. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest - GoogleCloudContactcenterinsightsV1IngestConversationsResponse: - type: object - description: The response to an IngestConversations operation. - properties: {} - id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse - GoogleCloudContactcenterinsightsV1AnswerFeedback: - description: >- - The feedback that the customer has about a certain answer in the - conversation. - properties: - correctnessLevel: - enum: - - CORRECTNESS_LEVEL_UNSPECIFIED - - NOT_CORRECT - - PARTIALLY_CORRECT - - FULLY_CORRECT - enumDescriptions: - - Correctness level unspecified. - - Answer is totally wrong. - - Answer is partially correct. - - Answer is fully correct. + format: google-duration + description: >- + Time offset of the end of this word relative to the beginning of the + total conversation. + startOffset: type: string - description: The correctness level of an answer. - clicked: - type: boolean - description: Indicates whether an answer or item was clicked by the human agent. - displayed: description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. - type: boolean - id: GoogleCloudContactcenterinsightsV1AnswerFeedback - type: object - GoogleCloudContactcenterinsightsV1alpha1SilenceData: - properties: {} + Time offset of the start of this word relative to the beginning of + the total conversation. + format: google-duration + description: Word-level info for words in a transcript. + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo type: object - id: GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: The data for a silence annotation. - GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata + GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: type: object + description: Request to upload a conversation. + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest properties: - request: - description: The original import request. + redactionConfig: + description: >- + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - endTime: - format: google-datetime + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + speechConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + description: >- + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + conversation: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation + description: Required. The conversation resource to create. + conversationId: type: string - description: The time the operation finished running. - createTime: + description: >- + Optional. A unique ID for the new conversation. This ID will become + the final component of the conversation's resource name. If no ID is + specified, a server-generated ID will be used. This value should be + 4-64 characters and must match the regular expression + `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` + parent: + description: Required. The parent resource of the conversation. type: string - format: google-datetime - description: The time the operation was created. - description: Metadata used for import issue model. - GoogleCloudContactcenterinsightsV1FaqAnswerData: - id: GoogleCloudContactcenterinsightsV1FaqAnswerData - description: Agent Assist frequently-asked-question answer data. + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig type: object + description: Configuration that applies to all conversations. properties: - metadata: + agentChannel: + type: integer + format: int32 description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + agentId: + description: >- + Optional. An opaque, user-specified string representing a human + agent who handled all conversations in the import. Note that this + will be overridden if per-conversation metadata is provided through + the `metadata_bucket_uri`. + type: string + customerChannel: + format: int32 + type: integer + description: >- + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + GoogleCloudContactcenterinsightsV1alpha1Entity: + type: object + description: >- + The data for an entity annotation. Represents a phrase in the + conversation that is a known entity, such as a person, an organization, + or location. + properties: + type: + description: The entity type. + enumDescriptions: + - Unspecified. + - Person. + - Location. + - Organization. + - Event. + - Artwork. + - Consumer product. + - Other types of entities. + - >- + Phone number. The metadata lists the phone number (formatted + according to local convention), plus whichever additional elements + appear in the text: * `number` - The actual number, broken down + into sections according to local convention. * `national_prefix` - + Country code, if detected. * `area_code` - Region or area code, if + detected. * `extension` - Phone extension (to be dialed after + connection), if detected. + - >- + Address. The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - Street number. * `locality` - City or town. * + `street_name` - Street/route name, if detected. * `postal_code` - + Postal code, if detected. * `country` - Country, if detected. * + `broad_region` - Administrative area, such as the state, if + detected. * `narrow_region` - Smaller administrative area, such as + county, if detected. * `sublocality` - Used in Asian addresses to + demark a district within a city, if detected. + - >- + Date. The metadata identifies the components of the date: * `year` + - Four digit year, if detected. * `month` - Two digit month + number, if detected. * `day` - Two digit day number, if detected. + - Number. The metadata is the number itself. + - Price. The metadata identifies the `value` and `currency`. + enum: + - TYPE_UNSPECIFIED + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + type: string + displayName: + type: string + description: The representative name for the entity. + salience: + type: number + format: float + description: >- + The salience score associated with the entity in the [0, 1.0] range. + The salience score for an entity provides information about the + importance or centrality of that entity to the entire document text. + Scores closer to 0 are less salient, while scores closer to 1.0 are + highly salient. + metadata: + type: object additionalProperties: type: string - type: object - queryRecord: + description: >- + Metadata associated with the entity. For most entity types, the + metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph + MID (`mid`), if they are available. For the metadata associated with + other entity types, see the Type table below. + sentiment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: >- + The aggregate sentiment expressed for this entity in the + conversation. + id: GoogleCloudContactcenterinsightsV1alpha1Entity + GoogleCloudContactcenterinsightsV1RedactionConfig: + description: >- + DLP resources used for redaction while ingesting conversations. DLP + settings are applied to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversation coming from CCAI Platform. They are not applied to + conversations ingested from the `CreateConversation` endpoint or the + Dialogflow / Agent Assist runtime integrations. When using Dialogflow / + Agent Assist runtime integrations, redaction should be performed in + Dialogflow / Agent Assist. + id: GoogleCloudContactcenterinsightsV1RedactionConfig + type: object + properties: + inspectTemplate: + description: >- + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` + type: string + deidentifyTemplate: type: string description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` + GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: + type: object + description: The response of listing issue models. + id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + properties: + issueModels: + type: array + description: The issue models that match the request. + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + GoogleCloudContactcenterinsightsV1FaqAnswerData: + type: object + id: GoogleCloudContactcenterinsightsV1FaqAnswerData + description: Agent Assist frequently-asked-question answer data. + properties: + source: + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. + type: string + answer: + type: string + description: The piece of text from the `source` knowledge base document. confidenceScore: - type: number description: >- The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). + type: number format: float - answer: - type: string - description: The piece of text from the `source` knowledge base document. - source: - type: string - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. question: description: The corresponding FAQ question. type: string - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: - properties: - runInterruptionAnnotator: - description: Whether to run the interruption annotator. - type: boolean - issueModels: - type: array - items: + metadata: + additionalProperties: type: string + type: object description: >- - The issue model to run. If not provided, the most recently deployed - topic model will be used. The provided issue model will only be used - for inference if the issue model is deployed and if - run_issue_model_annotator is set to true. If more than one issue - model is provided, only the first provided issue model will be used - for inference. - runSummarizationAnnotator: - description: Whether to run the summarization annotator. - type: boolean - runPhraseMatcherAnnotator: - description: Whether to run the active phrase matcher annotator(s). - type: boolean - runIntentAnnotator: - type: boolean - description: Whether to run the intent annotator. - runIssueModelAnnotator: - type: boolean - description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - summarizationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - description: Configuration for the summarization annotator. - phraseMatchers: + Map that contains metadata about the FAQ answer and the document + that it originates from. + queryRecord: description: >- - The list of phrase matchers to run. If not provided, all active - phrase matchers will be used. If inactive phrase matchers are - provided, they will not be used. Phrase matchers will be run only if - run_phrase_matcher_annotator is set to true. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - type: array - items: - type: string - runEntityAnnotator: - description: Whether to run the entity annotator. - type: boolean - runSentimentAnnotator: - description: Whether to run the sentiment annotator. - type: boolean - runSilenceAnnotator: - type: boolean - description: Whether to run the silence annotator. - description: Selector of all available annotators and phrase matchers to run. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata - description: The metadata for a bulk delete conversations operation. - properties: - endTime: - format: google-datetime + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - description: The time the operation finished running. + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: + properties: createTime: type: string - description: The time the operation was created. + description: Output only. The time the operation was created. + format: google-datetime + readOnly: true + endTime: format: google-datetime + type: string + readOnly: true + description: Output only. The time the operation finished running. request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest - description: The original request for bulk delete. - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Partial errors during bulk delete conversations operation that might - cause the operation output to be incomplete. - type: array - type: object - GoogleCloudContactcenterinsightsV1IssueMatchData: - id: GoogleCloudContactcenterinsightsV1IssueMatchData - description: The data for an issue match annotation. - properties: - issueAssignment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - description: Information about the issue's assignment. - type: object - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + description: The original request for creation. type: object - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse - description: The response to deploy an issue model. - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: - description: A segment of a full transcript. + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata + description: Metadata for creating an issue model. + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata type: object properties: - dialogflowSegmentMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - description: CCAI metadata relating to the current transcript segment. - text: - description: The text of this segment. - type: string - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: The sentiment for this transcript segment. - words: - description: >- - A list of the word-specific information for each word in the - segment. - type: array + agentInfo: items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo - messageTime: - description: The time that the message occurred, if provided. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + type: array + description: Information about agents involved in the call. + menuPath: type: string - format: google-datetime - languageCode: + description: >- + An arbitrary string value specifying the menu path the customer + took. + customerSatisfactionRating: + format: int32 + type: integer + description: >- + An arbitrary integer value indicating the customer's satisfaction + rating. + waitDuration: + description: The amount of time the customer waited to connect with an agent. + format: google-duration + type: string + description: Conversation metadata related to quality management. + GoogleCloudContactcenterinsightsV1UploadConversationRequest: + properties: + parent: + type: string + description: Required. The parent resource of the conversation. + conversationId: type: string description: >- - The language code of this segment as a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". - segmentParticipant: + Optional. A unique ID for the new conversation. This ID will become + the final component of the conversation's resource name. If no ID is + specified, a server-generated ID will be used. This value should be + 4-64 characters and must match the regular expression + `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` + redactionConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant - description: The participant of this segment. - confidence: - format: float - type: number + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - segment. A default value of 0.0 indicates that the value is unset. - channelTag: - type: integer + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' description: >- - For conversations derived from multi-channel audio, this is the - channel number corresponding to the audio from that channel. For - audioChannelCount = N, its output values can range from '1' to 'N'. - A channel tag of 0 indicates that the audio is mono. - format: int32 - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment - GoogleCloudContactcenterinsightsV1IssueAssignment: - description: Information about the issue. - id: GoogleCloudContactcenterinsightsV1IssueAssignment + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + conversation: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' + description: Required. The conversation resource to create. + id: GoogleCloudContactcenterinsightsV1UploadConversationRequest + type: object + description: Request to upload a conversation. + GoogleCloudContactcenterinsightsV1AnalysisResult: properties: - displayName: + endTime: + description: The time at which the analysis ended. + type: string + format: google-datetime + callAnalysisMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + description: Call-specific metadata created by the analysis. + type: object + description: The result of an analysis. + id: GoogleCloudContactcenterinsightsV1AnalysisResult + GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: + id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + properties: + issue: + description: Resource name of the assigned issue. type: string + displayName: description: >- Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + type: string score: + type: number format: double description: >- Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. - type: number - issue: - description: Resource name of the assigned issue. - type: string type: object + description: Information about the issue. GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: - type: object - description: The request to analyze conversations in bulk. id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + description: The request to analyze conversations in bulk. properties: - annotatorSelector: - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector analysisPercentage: - type: number - format: float description: >- Required. Percentage of selected conversation to analyze, between [0, 100]. + format: float + type: number parent: - description: Required. The parent resource to create analyses in. type: string + description: Required. The parent resource to create analyses in. + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. filter: + type: string description: >- Required. Filter used to select the subset of conversations to analyze. + type: object + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse + type: object + description: Response from export issue model + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: + properties: + objectUri: + description: 'Required. Format: `gs:///`' type: string - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + description: Google Cloud Storage Object URI to get the issue model file from. type: object - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata - description: Metadata for creating an issue model. + GoogleCloudContactcenterinsightsV1ConversationParticipant: + id: GoogleCloudContactcenterinsightsV1ConversationParticipant + description: The call participant speaking for a given utterance. properties: - request: - description: The original request for creation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - createTime: - description: Output only. The time the operation was created. - readOnly: true - format: google-datetime + obfuscatedExternalUserId: type: string - endTime: - readOnly: true - description: Output only. The time the operation finished running. + description: Obfuscated user ID from Dialogflow. + dialogflowParticipantName: + description: >- + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} type: string - format: google-datetime - GoogleCloudContactcenterinsightsV1IssueModelResult: + userId: + type: string + description: A user-specified ID representing the participant. + role: + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + description: The role of the participant. + type: string + dialogflowParticipant: + deprecated: true + type: string + description: >- + Deprecated. Use `dialogflow_participant_name` instead. The name of + the Dialogflow participant. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + type: object + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: + description: Metadata used for export issue model. + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata type: object - description: Issue Modeling result on a conversation. - id: GoogleCloudContactcenterinsightsV1IssueModelResult properties: - issueModel: + createTime: type: string - description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - issues: - description: All the matched issues. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: - description: A piece of metadata that applies to a window of a call. + description: The time the operation was created. + format: google-datetime + endTime: + description: The time the operation finished running. + format: google-datetime + type: string + request: + description: The original export request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: + type: object properties: - annotationStartBoundary: + annotatorSelector: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector description: >- - The boundary in the conversation where the annotation starts, - inclusive. - intentMatchData: - description: Data specifying an intent match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - issueMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - description: Data specifying an issue match. - holdData: - description: Data specifying a hold. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData - sentimentData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Data specifying sentiment. - annotationEndBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + runtimeIntegrationAnalysisPercentage: + type: number description: >- - The boundary in the conversation where the annotation ends, - inclusive. - entityMentionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData - description: Data specifying an entity mention. - interruptionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData - description: Data specifying an interruption. - silenceData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: Data specifying silence. - phraseMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - description: Data specifying a phrase match. - channelTag: + Percentage of conversations created using Dialogflow runtime + integration to analyze automatically, between [0, 100]. + format: double + uploadConversationAnalysisPercentage: description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. - format: int32 - type: integer + Percentage of conversations created using the UploadConversation + endpoint to analyze automatically, between [0, 100]. + format: double + type: number + description: Default configuration when creating Analyses in Insights. + id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: + description: Response for an export insights operation. + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse type: object - id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation - GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: - properties: - objectUri: - description: 'Required. Format: `gs:///`' - type: string + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: type: object - description: Google Cloud Storage Object URI to get the issue model file from. - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: - id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - description: Agent Assist frequently-asked-question answer data. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats properties: - metadata: + analyzedConversationsCount: description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - type: object + Number of conversations the issue model has analyzed at this point + in time. + format: int64 + type: string + issueStats: additionalProperties: - type: string - answer: - description: The piece of text from the `source` knowledge base document. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + description: Statistics on each issue. Key is the issue's resource name. + type: object + unclassifiedConversationsCount: + format: int64 + description: >- + Number of analyzed conversations for which no issue was applicable + at this point in time. type: string - question: - description: The corresponding FAQ question. + description: Aggregated statistics about an issue model. + GoogleCloudContactcenterinsightsV1SmartReplyData: + properties: + reply: type: string + description: The content of the reply. + metadata: + additionalProperties: + type: string + description: >- + Map that contains metadata about the Smart Reply and the document + from which it originates. + type: object queryRecord: description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - source: - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - type: string confidenceScore: - format: float type: number description: >- - The system's confidence score that this answer is a good match for + The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). + format: double + description: Agent Assist Smart Reply data. type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: + id: GoogleCloudContactcenterinsightsV1SmartReplyData + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: + description: Configuration for processing transcript objects. + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig properties: medium: enum: @@ -1367,296 +1527,224 @@ components: - Default value, if unspecified will default to PHONE_CALL. - The format for conversations that took place over the phone. - The format for conversations that took place over chat. - description: >- - Medium of conversations used in training data. This field is being - deprecated. To specify the medium to be used in training a new issue - model, set the `medium` field on `filter`. - deprecated: true - type: string - trainingConversationsCount: - format: int64 - type: string - readOnly: true - description: Output only. Number of conversations used in training. Output only. - filter: - description: >- - A filter to reduce the conversations used for training the model to - a specific subset. type: string - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - description: Configs for the input data used to create the issue model. + description: Required. The medium transcript objects represent. type: object - GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + description: Request to export an issue model. type: object - description: Information about an agent involved in the conversation. properties: - displayName: + gcsDestination: + description: Google Cloud Storage URI to export the issue model to. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + name: type: string - description: The agent's name. - agentId: + description: Required. The issue model to export. + GoogleCloudContactcenterinsightsV1DialogflowSource: + type: object + description: A Dialogflow source of conversation data. + properties: + audioUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. type: string - description: A user-specified string representing the agent. - team: + dialogflowConversation: + readOnly: true type: string - description: A user-specified string representing the agent's team. - dispositionCode: description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. - type: string - GoogleCloudContactcenterinsightsV1Settings: + Output only. The name of the Dialogflow conversation that this + conversation resource is derived from. Format: + projects/{project}/locations/{location}/conversations/{conversation} + id: GoogleCloudContactcenterinsightsV1DialogflowSource + GoogleCloudContactcenterinsightsV1PhraseMatchRule: type: object - description: >- - The CCAI Insights project wide settings. Use these settings to configure - the behavior of Insights. View these settings with - [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) - and change the settings with - [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). - id: GoogleCloudContactcenterinsightsV1Settings + description: The data for a phrase match rule. properties: - analysisConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig - description: Default analysis settings. - conversationTtl: + negated: + type: boolean description: >- - The default TTL for newly-created conversations. If a conversation - has a specified expiration, that value will be used instead. - Changing this value will not change the expiration of existing - conversations. Conversations with no expire time persist until they - are deleted. + Specifies whether the phrase must be missing from the transcript + segment or present in the transcript segment. + query: + description: Required. The phrase to be matched. type: string - format: google-duration - redactionConfig: - description: >- - Default DLP redaction resources to be applied while ingesting - conversations. This applies to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversations coming from CCAI Platform. + config: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - updateTime: - format: google-datetime - type: string - readOnly: true - description: Output only. The time at which the settings were last updated. - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - description: >- - Optional. Default Speech-to-Text resources to use while ingesting - audio files. Optional, CCAI Insights will create a default if not - provided. This applies to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversations coming from CCAI Platform. - pubsubNotificationSettings: - additionalProperties: - type: string - type: object - description: >- - A map that maps a notification trigger to a Pub/Sub topic. Each time - a specified trigger occurs, Insights will notify the corresponding - Pub/Sub topic. Keys are notification triggers. Supported keys are: * - "all-triggers": Notify each time any of the supported triggers - occurs. * "create-analysis": Notify each time an analysis is - created. * "create-conversation": Notify each time a conversation is - created. * "export-insights-data": Notify each time an export is - complete. * "ingest-conversations": Notify each time an - IngestConversations LRO is complete. * "update-conversation": Notify - each time a conversation is updated via UpdateConversation. * - "upload-conversation": Notify when an UploadConversation LRO is - complete. Values are Pub/Sub topics. The format of each Pub/Sub - topic is: projects/{project}/topics/{topic} - languageCode: - description: >- - A language code to be applied to each transcript segment unless the - segment already specifies a language code. Language code defaults to - "en-US" if it is neither specified on the segment nor here. - type: string - createTime: - type: string - format: google-datetime - description: Output only. The time at which the settings was created. - readOnly: true - name: + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig description: >- - Immutable. The resource name of the settings resource. Format: - projects/{project}/locations/{location}/settings - type: string - GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. + Provides additional information about the rule that specifies how to + apply the rule. + id: GoogleCloudContactcenterinsightsV1PhraseMatchRule + GoogleCloudContactcenterinsightsV1alpha1InterruptionData: type: object - properties: - displayName: - description: The human-readable name of the intent. - type: string - GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: - description: Response for an export insights operation. - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse + id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData + description: The data for an interruption annotation. properties: {} + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: type: object - GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig - type: object - description: Configuration information of a phrase match rule. properties: - exactMatchConfig: - description: The configuration for the exact match rule. + annotatorSelector: + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + parent: + type: string + description: Required. The parent resource to create analyses in. + filter: + type: string + description: >- + Required. Filter used to select the subset of conversations to + analyze. + analysisPercentage: + type: number + description: >- + Required. Percentage of selected conversation to analyze, between + [0, 100]. + format: float + description: The request to analyze conversations in bulk. + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: + description: The metadata for a bulk analyze conversations operation. type: object - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata properties: endTime: - format: google-datetime type: string - readOnly: true - description: Output only. The time the operation finished running. - createTime: + description: The time the operation finished running. format: google-datetime - type: string + failedAnalysesCount: + description: The number of requested analyses that have failed so far. + format: int32 + type: integer + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' readOnly: true - description: Output only. The time the operation was created. - request: - description: The original request for deletion. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest - description: Metadata for deleting an issue model. - GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: - description: >- - An annotation that was generated during the customer and agent - interaction. - properties: - endBoundary: + type: array description: >- - The boundary in the conversation where the annotation ends, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - faqAnswer: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - description: Agent Assist FAQ answer data. - articleSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - userInput: + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. + request: + description: The original request for bulk analyze. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput - description: Explicit input used for generating the answer - annotationId: - type: string + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + totalRequestedAnalysesCount: + format: int32 description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - answerFeedback: - description: The feedback that the customer has about the answer in `data`. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback - startBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. + type: integer + completedAnalysesCount: + format: int32 + type: integer description: >- - The boundary in the conversation where the annotation starts, - inclusive. + The number of requested analyses that have completed successfully so + far. createTime: + description: The time the operation was created. type: string - description: The time at which this annotation was created. format: google-datetime - conversationSummarizationSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - description: Conversation summarization suggestion data. - dialogflowInteraction: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData - description: Dialogflow interaction data. - smartComposeSuggestion: - description: Agent Assist Smart Compose suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData - smartReply: - description: Agent Assist Smart Reply data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData - type: object - id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation - GoogleCloudContactcenterinsightsV1Issue: - type: object - description: The issue resource. + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata + GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: + description: Configs for the input data used to create the issue model. properties: - updateTime: - readOnly: true + filter: + description: >- + A filter to reduce the conversations used for training the model to + a specific subset. type: string - format: google-datetime - description: Output only. The most recent time that this issue was updated. - createTime: - readOnly: true - description: Output only. The time at which this issue was created. + medium: + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. type: string - format: google-datetime - sampleUtterances: - items: - type: string - type: array description: >- - Output only. Resource names of the sample representative utterances - that match to this issue. + Medium of conversations used in training data. This field is being + deprecated. To specify the medium to be used in training a new issue + model, set the `medium` field on `filter`. + deprecated: true + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + trainingConversationsCount: + description: Output only. Number of conversations used in training. Output only. readOnly: true - displayDescription: - type: string - description: Representative description of the issue. - name: - type: string - description: >- - Immutable. The resource name of the issue. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - displayName: - description: The representative name for the issue. + format: int64 type: string - id: GoogleCloudContactcenterinsightsV1Issue - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: properties: - parent: - type: string - description: Required. The parent resource to create analyses in. - analysisPercentage: + runSentimentAnnotator: + description: Whether to run the sentiment annotator. + type: boolean + issueModels: description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. - type: number - format: float - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + The issue model to run. If not provided, the most recently deployed + topic model will be used. The provided issue model will only be used + for inference if the issue model is deployed and if + run_issue_model_annotator is set to true. If more than one issue + model is provided, only the first provided issue model will be used + for inference. + type: array + items: + type: string + runInterruptionAnnotator: + description: Whether to run the interruption annotator. + type: boolean + runSummarizationAnnotator: + description: Whether to run the summarization annotator. + type: boolean + phraseMatchers: description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - filter: + The list of phrase matchers to run. If not provided, all active + phrase matchers will be used. If inactive phrase matchers are + provided, they will not be used. Phrase matchers will be run only if + run_phrase_matcher_annotator is set to true. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + items: + type: string + type: array + summarizationConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + description: Configuration for the summarization annotator. + runIntentAnnotator: + description: Whether to run the intent annotator. + type: boolean + runEntityAnnotator: + type: boolean + description: Whether to run the entity annotator. + runPhraseMatcherAnnotator: + type: boolean + description: Whether to run the active phrase matcher annotator(s). + runSilenceAnnotator: + type: boolean + description: Whether to run the silence annotator. + runIssueModelAnnotator: + type: boolean description: >- - Required. Filter used to select the subset of conversations to - analyze. - type: string - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. type: object - description: The request to analyze conversations in bulk. + id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + description: Selector of all available annotators and phrase matchers to run. GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + description: Configuration for Cloud Storage bucket sources. + type: object properties: - metadataBucketUri: + bucketUri: type: string - description: >- - Optional. The Cloud Storage path to the conversation metadata. Note - that: [1] Metadata files are expected to be in JSON format. [2] - Metadata and source files (transcripts or audio) must be in separate - buckets. [3] A source file and its corresponding metadata file must - share the same name to be properly ingested, E.g. - `gs://bucket/audio/conversation1.mp3` and - `gs://bucket/metadata/conversation1.json`. + description: Required. The Cloud Storage bucket containing source objects. customMetadataKeys: description: >- Optional. Custom keys to extract as conversation labels from @@ -1666,9 +1754,18 @@ components: items: type: string type: array + metadataBucketUri: + type: string + description: >- + Optional. The Cloud Storage path to the conversation metadata. Note + that: [1] Metadata files are expected to be in JSON format. [2] + Metadata and source files (transcripts or audio) must be in separate + buckets. [3] A source file and its corresponding metadata file must + share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. bucketObjectType: type: string - description: Optional. Specifies the type of the objects in `bucket_uri`. enumDescriptions: - The object type is unspecified and will default to `TRANSCRIPT`. - The object is a transcript. @@ -1677,889 +1774,134 @@ components: - BUCKET_OBJECT_TYPE_UNSPECIFIED - TRANSCRIPT - AUDIO - bucketUri: - type: string - description: Required. The Cloud Storage bucket containing source objects. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - description: Configuration for Cloud Storage bucket sources. - type: object - GoogleCloudContactcenterinsightsV1Conversation: - id: GoogleCloudContactcenterinsightsV1Conversation - description: The conversation resource. + description: Optional. Specifies the type of the objects in `bucket_uri`. + GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: type: object properties: - transcript: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript - description: Output only. The conversation transcript. - latestSummary: - description: Output only. Latest summary of the conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - readOnly: true - expireTime: - format: google-datetime - description: >- - The time at which this conversation should expire. After this time, - the conversation data and any associated analyses will be deleted. + dialogflowParticipant: type: string - startTime: - format: google-datetime - description: The time at which the conversation started. + description: >- + Deprecated. Use `dialogflow_participant_name` instead. The name of + the Dialogflow participant. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + deprecated: true + obfuscatedExternalUserId: + description: Obfuscated user ID from Dialogflow. type: string - updateTime: - format: google-datetime - readOnly: true + dialogflowParticipantName: type: string description: >- - Output only. The most recent time at which the conversation was - updated. - runtimeAnnotations: - type: array - description: >- - Output only. The annotations that were generated during the customer - and agent interaction. - readOnly: true - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation - turnCount: - description: Output only. The number of turns in the conversation. - type: integer - readOnly: true - format: int32 - qualityMetadata: - description: Conversation metadata related to quality management. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - duration: + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + role: + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. type: string - description: Output only. The duration of the conversation. - readOnly: true - format: google-duration - dataSource: - description: The source of the audio and transcription for the conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource - latestAnalysis: - description: Output only. The conversation's latest analysis, if one exists. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' - readOnly: true - metadataJson: - description: >- - Input only. JSON Metadata encoded as a string. This field is - primarily used by Insights integrations with various telphony - systems and must be in one of Insights' supported formats. + description: The role of the participant. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + userId: type: string - name: - description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} + description: A user-specified ID representing the participant. + description: The call participant speaking for a given utterance. + id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + properties: + filter: + description: Filter used to select the subset of conversations to delete. type: string - labels: - type: object - additionalProperties: - type: string + force: + type: boolean description: >- - A map for the user to specify any custom fields. A maximum of 20 - labels per conversation is allowed, with a maximum of 256 characters - per entry. - createTime: - type: string - readOnly: true - description: Output only. The time at which the conversation was created. - format: google-datetime - callMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata - description: Call-specific metadata. - obfuscatedUserId: - description: Obfuscated user ID which the customer sent to us. - type: string - medium: - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - type: string - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: >- - Immutable. The conversation medium, if unspecified will default to - PHONE_CALL. - dialogflowIntents: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent - readOnly: true - description: >- - Output only. All the matched Dialogflow intents in the call. The key - corresponds to a Dialogflow intent, format: - projects/{project}/agent/{agent}/intents/{intent} - type: object - languageCode: - type: string - description: A user-specified language code for the conversation. - ttl: - description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. - type: string - format: google-duration - agentId: - description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. - type: string - GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: - description: >- - A point in a conversation that marks the start or the end of an - annotation. - properties: - wordIndex: - description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. - format: int32 - type: integer - transcriptIndex: - format: int32 - type: integer - description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: - properties: - processedObjectCount: - description: >- - Output only. The number of objects processed during the ingest - operation. - format: int32 - type: integer - readOnly: true - successfulIngestCount: - format: int32 - description: >- - Output only. The number of new conversations added during this - ingest operation. - type: integer - readOnly: true - duplicatesSkippedCount: - format: int32 - description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. - type: integer - readOnly: true - failedIngestCount: - format: int32 - readOnly: true - type: integer - description: >- - Output only. The number of objects which were unable to be ingested - due to errors. The errors are populated in the partial_errors field. - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats - type: object - description: Statistics for IngestConversations operation. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: - type: object - description: Statistics for IngestConversations operation. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats - properties: - failedIngestCount: - readOnly: true - format: int32 - type: integer - description: >- - Output only. The number of objects which were unable to be ingested - due to errors. The errors are populated in the partial_errors field. - processedObjectCount: - type: integer - readOnly: true - format: int32 - description: >- - Output only. The number of objects processed during the ingest - operation. - duplicatesSkippedCount: - description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. - readOnly: true - type: integer - format: int32 - successfulIngestCount: - type: integer - readOnly: true - description: >- - Output only. The number of new conversations added during this - ingest operation. - format: int32 - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: - type: object - description: Metadata used for export issue model. - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata - properties: - createTime: - description: The time the operation was created. - format: google-datetime - type: string - request: - description: The original export request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest - endTime: - format: google-datetime - description: The time the operation finished running. - type: string - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest: - type: object - properties: - encryptionSpec: - description: >- - Required. The encryption spec used for CMEK encryption. It is - required that the kms key is in the same region as the endpoint. The - same key will be used for all provisioned resources, if encryption - is available. If the kms_key_name is left empty, no encryption will - be enforced. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest - description: The request to initialize a location-level encryption specification. - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - description: One channel of conversation-level sentiment data. - properties: - channelTag: - format: int32 - type: integer - description: The channel of the audio that the data applies to. - sentimentData: - description: Data specifying sentiment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - GoogleCloudContactcenterinsightsV1SilenceData: - type: object - description: The data for a silence annotation. - properties: {} - id: GoogleCloudContactcenterinsightsV1SilenceData - GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: - properties: - trainingConversationsCount: - readOnly: true - type: string - description: Output only. Number of conversations used in training. Output only. - format: int64 - filter: - type: string - description: >- - A filter to reduce the conversations used for training the model to - a specific subset. - medium: - deprecated: true - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: >- - Medium of conversations used in training data. This field is being - deprecated. To specify the medium to be used in training a new issue - model, set the `medium` field on `filter`. - type: string - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - description: Configs for the input data used to create the issue model. - type: object - GoogleLongrunningOperation: - type: object - id: GoogleLongrunningOperation - properties: - name: - type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - response: - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - metadata: - type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: - description: The response to undeploy an issue model. - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse - type: object - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: - type: object - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse - description: The response for a bulk analyze conversations operation. - properties: - failedAnalysisCount: - format: int32 - description: Count of failed analyses. - type: integer - successfulAnalysisCount: - type: integer - format: int32 - description: Count of successful analyses. - GoogleCloudContactcenterinsightsV1InterruptionData: - id: GoogleCloudContactcenterinsightsV1InterruptionData - properties: {} - description: The data for an interruption annotation. - type: object - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo - type: object - description: Word-level info for words in a transcript. - properties: - confidence: - type: number - format: float - description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - word. A default value of 0.0 indicates that the value is unset. - word: - type: string - description: The word itself. Includes punctuation marks that surround the word. - endOffset: - type: string - format: google-duration - description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. - startOffset: - type: string - description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. - format: google-duration - GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: - id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData - type: object - description: Agent Assist Article Suggestion data. - properties: - queryRecord: - type: string - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - confidenceScore: - type: number - format: float - description: >- - The system's confidence score that this article is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - uri: - description: Article URI. - type: string - metadata: - type: object - description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. - additionalProperties: - type: string - title: - type: string - description: Article title. - source: - type: string - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} - GoogleCloudContactcenterinsightsV1DialogflowIntent: - type: object - id: GoogleCloudContactcenterinsightsV1DialogflowIntent - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. - properties: - displayName: - type: string - description: The human-readable name of the intent. - GoogleCloudContactcenterinsightsV1IngestConversationsRequest: - properties: - sampleSize: - type: integer - format: int32 - description: >- - Optional. If set, this fields indicates the number of objects to - ingest from the Cloud Storage bucket. If empty, the entire bucket - will be ingested. Unless they are first deleted, conversations - produced through sampling won't be ingested by subsequent ingest - requests. - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - conversationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig - description: Configuration that applies to all conversations. - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - transcriptObjectConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for when `source` contains conversation transcripts. - parent: - description: Required. The parent resource for new conversations. - type: string - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource - description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - type: object - description: The request to ingest conversations. - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse - description: Response for an export insights operation. - type: object - GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata - properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - description: The original request for creation. - endTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The time the operation finished running. - createTime: - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true - type: string - type: object - description: Metadata for creating an issue model. - GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: - id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult - properties: - endTime: - description: The time at which the analysis ended. - format: google-datetime - type: string - callAnalysisMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata - description: Call-specific metadata created by the analysis. - type: object - description: The result of an analysis. - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: - description: A single interval in a time series. - properties: - conversationCount: - description: The number of conversations created in this interval. - type: integer - format: int32 - startTime: - type: string - format: google-datetime - description: The start time of this interval. - id: >- - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval - type: object - GoogleCloudContactcenterinsightsV1EntityMentionData: - id: GoogleCloudContactcenterinsightsV1EntityMentionData - type: object - properties: - sentiment: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: Sentiment expressed for this mention of the entity. - type: - enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON - description: The type of the entity mention. - enumDescriptions: - - Unspecified. - - Proper noun. - - Common noun (or noun compound). - type: string - entityUniqueId: - description: >- - The key of this entity in conversation entities. Can be used to - retrieve the exact `Entity` this mention is attached to. - type: string - description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. - GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: - id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - type: object - description: Information about the issue. - properties: - issue: - type: string - description: Resource name of the assigned issue. - displayName: + If set to true, all of this conversation's analyses will also be + deleted. Otherwise, the request will only succeed if the + conversation has no analyses. + parent: type: string description: >- - Immutable. Display name of the assigned issue. This field is set at - time of analyis and immutable since then. - score: - type: number - description: >- - Score indicating the likelihood of the issue assignment. currently - bounded on [0,1]. - format: double - GoogleCloudContactcenterinsightsV1ConversationCallMetadata: - id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata - type: object - description: Call-specific metadata. - properties: - agentChannel: - format: int32 - description: The audio channel that contains the agent. - type: integer - customerChannel: + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} + maxDeleteCount: + description: Maximum number of conversations to delete. format: int32 type: integer - description: The audio channel that contains the customer. - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse: - properties: {} - type: object - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse - description: The response to initialize a location-level encryption specification. - GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest - type: object - properties: - name: - type: string - description: Required. The issue model to export. - gcsDestination: - description: Google Cloud Storage URI to export the issue model to. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - description: Request to export an issue model. - GoogleCloudContactcenterinsightsV1Intent: - properties: - id: - type: string - description: The unique identifier of the intent. - displayName: - type: string - description: The human-readable name of the intent. - type: object - description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. - id: GoogleCloudContactcenterinsightsV1Intent - GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: - description: The conversation source, which is a combination of transcript and audio. + description: The request to delete conversations in bulk. type: object - id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + GoogleCloudContactcenterinsightsV1ConversationDataSource: + type: object + id: GoogleCloudContactcenterinsightsV1ConversationDataSource + description: The conversation source, which is a combination of transcript and audio. properties: gcsSource: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' description: A Cloud Storage location specification for the audio and transcript. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource dialogflowSource: description: The source when the conversation comes from Dialogflow. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse - type: object - properties: - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - nextPageToken: - type: string - description: The standard List next-page token. - description: The response message for Operations.ListOperations. - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: - properties: - summarizationModel: - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 - type: string - description: Default summarization model to be used. - conversationProfile: - type: string - description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - description: Configuration for summarization. - GoogleCloudContactcenterinsightsV1PhraseMatchData: - id: GoogleCloudContactcenterinsightsV1PhraseMatchData - type: object + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: + description: The response for a bulk analyze conversations operation. properties: - displayName: - type: string - description: The human-readable name of the phrase matcher. - phraseMatcher: - type: string - description: The unique identifier (the resource name) of the phrase matcher. - description: >- - The data for a matched phrase matcher. Represents information - identifying a phrase matcher for a given match. - GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: - description: Response from export issue model - properties: {} - id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse - type: object - GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput: - id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput - description: Explicit input used for generating the answer + successfulAnalysisCount: + description: Count of successful analyses. + type: integer + format: int32 + failedAnalysisCount: + type: integer + format: int32 + description: Count of failed analyses. + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse type: object - properties: - querySource: - enumDescriptions: - - Unknown query source. - - The query is from agents. - - >- - The query is a query from previous suggestions, e.g. from a - preceding SuggestKnowledgeAssist response. - enum: - - QUERY_SOURCE_UNSPECIFIED - - AGENT_QUERY - - SUGGESTED_QUERY - type: string - description: Query source for the answer. - generatorName: - type: string - description: >- - The resource name of associated generator. Format: - `projects//locations//generators/` - query: - description: >- - Query text. Article Search uses this to store the input query used - to generate the search results. - type: string - GoogleCloudContactcenterinsightsV1Entity: - id: GoogleCloudContactcenterinsightsV1Entity + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: type: object - description: >- - The data for an entity annotation. Represents a phrase in the - conversation that is a known entity, such as a person, an organization, - or location. + description: Google Cloud Storage Object URI to save the issue model to. properties: - sentiment: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: >- - The aggregate sentiment expressed for this entity in the - conversation. - metadata: - type: object - description: >- - Metadata associated with the entity. For most entity types, the - metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph - MID (`mid`), if they are available. For the metadata associated with - other entity types, see the Type table below. - additionalProperties: - type: string - type: - type: string - enum: - - TYPE_UNSPECIFIED - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - enumDescriptions: - - Unspecified. - - Person. - - Location. - - Organization. - - Event. - - Artwork. - - Consumer product. - - Other types of entities. - - >- - Phone number. The metadata lists the phone number (formatted - according to local convention), plus whichever additional elements - appear in the text: * `number` - The actual number, broken down - into sections according to local convention. * `national_prefix` - - Country code, if detected. * `area_code` - Region or area code, if - detected. * `extension` - Phone extension (to be dialed after - connection), if detected. - - >- - Address. The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - Street number. * `locality` - City or town. * - `street_name` - Street/route name, if detected. * `postal_code` - - Postal code, if detected. * `country` - Country, if detected. * - `broad_region` - Administrative area, such as the state, if - detected. * `narrow_region` - Smaller administrative area, such as - county, if detected. * `sublocality` - Used in Asian addresses to - demark a district within a city, if detected. - - >- - Date. The metadata identifies the components of the date: * `year` - - Four digit year, if detected. * `month` - Two digit month - number, if detected. * `day` - Two digit day number, if detected. - - Number. The metadata is the number itself. - - Price. The metadata identifies the `value` and `currency`. - description: The entity type. - salience: - description: >- - The salience score associated with the entity in the [0, 1.0] range. - The salience score for an entity provides information about the - importance or centrality of that entity to the entire document text. - Scores closer to 0 are less salient, while scores closer to 1.0 are - highly salient. - type: number - format: float - displayName: + objectUri: type: string - description: The representative name for the entity. - GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: + description: 'Required. Format: `gs:///`' + id: >- + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: type: object - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata + description: Issue Modeling result on a conversation. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult properties: - endTime: - description: Output only. The time the operation finished running. - type: string - readOnly: true - format: google-datetime - appliedRedactionConfig: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + issueModel: description: >- - Output only. The redaction config applied to the uploaded - conversation. - createTime: - type: string - description: Output only. The time the operation was created. - readOnly: true - format: google-datetime - analysisOperation: - readOnly: true + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} type: string - description: >- - Output only. The operation name for a successfully created analysis - operation, if any. - request: - readOnly: true - description: Output only. The original request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest - description: The metadata for an `UploadConversation` operation. - GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: - type: object - properties: - partialErrors: - type: array + issues: + description: All the matched issues. items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Partial errors during export operation that might cause the - operation output to be incomplete. - createTime: - format: google-datetime - type: string - description: Output only. The time the operation was created. - readOnly: true - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest - description: The original request for export. - endTime: - description: Output only. The time the operation finished running. - readOnly: true - format: google-datetime - type: string - description: Metadata for an export insights operation. - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata - GoogleCloudContactcenterinsightsV1HoldData: - description: The data for a hold annotation. - id: GoogleCloudContactcenterinsightsV1HoldData + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + type: array + GoogleCloudContactcenterinsightsV1InterruptionData: type: object properties: {} - GoogleCloudContactcenterinsightsV1alpha1Entity: + description: The data for an interruption annotation. + id: GoogleCloudContactcenterinsightsV1InterruptionData + GoogleCloudContactcenterinsightsV1Entity: type: object - description: >- - The data for an entity annotation. Represents a phrase in the - conversation that is a known entity, such as a person, an organization, - or location. - id: GoogleCloudContactcenterinsightsV1alpha1Entity properties: + sentiment: + description: >- + The aggregate sentiment expressed for this entity in the + conversation. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' type: + description: The entity type. + type: string enumDescriptions: - Unspecified. - Person. @@ -2593,8 +1935,6 @@ components: number, if detected. * `day` - Two digit day number, if detected. - Number. The metadata is the number itself. - Price. The metadata identifies the `value` and `currency`. - description: The entity type. - type: string enum: - TYPE_UNSPECIFIED - PERSON @@ -2609,21 +1949,9 @@ components: - DATE - NUMBER - PRICE - metadata: - additionalProperties: - type: string - type: object - description: >- - Metadata associated with the entity. For most entity types, the - metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph - MID (`mid`), if they are available. For the metadata associated with - other entity types, see the Type table below. - sentiment: - description: >- - The aggregate sentiment expressed for this entity in the - conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + displayName: + description: The representative name for the entity. + type: string salience: type: number format: float @@ -2633,180 +1961,237 @@ components: importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. - displayName: - description: The representative name for the entity. - type: string - GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: - properties: - inspectTemplate: - description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` - type: string - deidentifyTemplate: + metadata: description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` - type: string - id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + Metadata associated with the entity. For most entity types, the + metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph + MID (`mid`), if they are available. For the metadata associated with + other entity types, see the Type table below. + type: object + additionalProperties: + type: string description: >- - DLP resources used for redaction while ingesting conversations. DLP - settings are applied to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversation coming from CCAI Platform. They are not applied to - conversations ingested from the `CreateConversation` endpoint or the - Dialogflow / Agent Assist runtime integrations. When using Dialogflow / - Agent Assist runtime integrations, redaction should be performed in - Dialogflow / Agent Assist. - type: object - GoogleCloudContactcenterinsightsV1ExactMatchConfig: - type: object - description: Exact match configuration. - id: GoogleCloudContactcenterinsightsV1ExactMatchConfig - properties: - caseSensitive: - description: Whether to consider case sensitivity when performing an exact match. - type: boolean - GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - type: object - description: Google Cloud Storage Object URI to save the issue model to. + The data for an entity annotation. Represents a phrase in the + conversation that is a known entity, such as a person, an organization, + or location. + id: GoogleCloudContactcenterinsightsV1Entity + GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + description: The conversation source, which is a combination of transcript and audio. properties: - objectUri: - type: string - description: 'Required. Format: `gs:///`' - GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: + dialogflowSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + description: The source when the conversation comes from Dialogflow. + gcsSource: + description: A Cloud Storage location specification for the audio and transcript. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource type: object + GoogleCloudContactcenterinsightsV1alpha1SentimentData: + id: GoogleCloudContactcenterinsightsV1alpha1SentimentData properties: - displayed: - type: boolean + magnitude: + format: float description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. - clicked: - description: Indicates whether an answer or item was clicked by the human agent. - type: boolean - correctnessLevel: - description: The correctness level of an answer. - enum: - - CORRECTNESS_LEVEL_UNSPECIFIED - - NOT_CORRECT - - PARTIALLY_CORRECT - - FULLY_CORRECT - enumDescriptions: - - Correctness level unspecified. - - Answer is totally wrong. - - Answer is partially correct. - - Answer is fully correct. - type: string - id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback - description: >- - The feedback that the customer has about a certain answer in the - conversation. - GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: + A non-negative number from 0 to infinity which represents the + abolute magnitude of sentiment regardless of score. + type: number + score: + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + format: float + type: number + description: The data for a sentiment annotation. type: object - description: Default configuration when creating Analyses in Insights. + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: properties: - runtimeIntegrationAnalysisPercentage: - format: double + startBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary description: >- - Percentage of conversations created using Dialogflow runtime - integration to analyze automatically, between [0, 100]. - type: number - uploadConversationAnalysisPercentage: - type: number - format: double + The boundary in the conversation where the annotation starts, + inclusive. + conversationSummarizationSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + annotationId: description: >- - Percentage of conversations created using the UploadConversation - endpoint to analyze automatically, between [0, 100]. - annotatorSelector: + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + type: string + smartReply: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData + description: Agent Assist Smart Reply data. + userInput: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer + faqAnswer: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + description: Agent Assist FAQ answer data. + createTime: + description: The time at which this annotation was created. + type: string + format: google-datetime + endBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + The boundary in the conversation where the annotation ends, + inclusive. + answerFeedback: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + description: The feedback that the customer has about the answer in `data`. + smartComposeSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + description: Agent Assist Smart Compose suggestion data. + dialogflowInteraction: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + description: Dialogflow interaction data. + articleSuggestion: + description: Agent Assist Article Suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + type: object + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + description: >- + An annotation that was generated during the customer and agent + interaction. + GoogleCloudContactcenterinsightsV1SpeechConfig: + description: >- + Speech-to-Text configuration. Speech-to-Text settings are applied to + conversations ingested from the `UploadConversation` and + `IngestConversations` endpoints, including conversation coming from CCAI + Platform. They are not applied to conversations ingested from the + `CreateConversation` endpoint. type: object properties: - answerRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string - textSections: - additionalProperties: - type: string - type: object - description: >- - The summarization content that is divided into sections. The key is - the section's name and the value is the section's content. There is - no specific format for the key or value. - text: - description: The summarization content that is concatenated into one string. - type: string - confidence: - type: number - format: float - description: The confidence score of the summarization. - metadata: - additionalProperties: - type: string - type: object + speechRecognizer: description: >- - A map that contains metadata about the summarization and the - document from which it originates. - conversationModel: + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` type: string - description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} - description: Conversation summarization suggestion data. - GoogleCloudContactcenterinsightsV1alpha1GcsSource: - description: A Cloud Storage source of conversation data. - id: GoogleCloudContactcenterinsightsV1alpha1GcsSource + id: GoogleCloudContactcenterinsightsV1SpeechConfig + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse: + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse + properties: {} + type: object + description: The response to initialize a location-level encryption specification. + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata: + description: Metadata for initializing a location-level encryption specification. properties: - audioUri: + endTime: + readOnly: true + format: google-datetime + description: Output only. The time the operation finished running. type: string - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - transcriptUri: + request: + description: Output only. The original request for initialization. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest + readOnly: true + createTime: type: string + format: google-datetime + readOnly: true + description: Output only. The time the operation was created. + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. + Partial errors during initialising operation that might cause the + operation output to be incomplete. + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata type: object - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: + GoogleCloudContactcenterinsightsV1alpha1Intent: + description: >- + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. + id: GoogleCloudContactcenterinsightsV1alpha1Intent type: object - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata + properties: + id: + type: string + description: The unique identifier of the intent. + displayName: + type: string + description: The human-readable name of the intent. + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: properties: partialErrors: - type: array - description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. items: $ref: '#/components/schemas/GoogleRpcStatus' + type: array + description: >- + Partial errors during export operation that might cause the + operation output to be incomplete. + endTime: + type: string + format: google-datetime + description: Output only. The time the operation finished running. readOnly: true request: - description: The original request for bulk analyze. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - failedAnalysesCount: - description: The number of requested analyses that have failed so far. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest + description: The original request for export. + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. The time the operation was created. + description: Metadata for an export insights operation. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: + type: object + properties: + processedObjectCount: + type: integer + readOnly: true + description: >- + Output only. The number of objects processed during the ingest + operation. + format: int32 + duplicatesSkippedCount: + readOnly: true + format: int32 + description: >- + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + type: integer + failedIngestCount: + description: >- + Output only. The number of objects which were unable to be ingested + due to errors. The errors are populated in the partial_errors field. + type: integer + format: int32 + readOnly: true + successfulIngestCount: type: integer + readOnly: true format: int32 + description: >- + Output only. The number of new conversations added during this + ingest operation. + description: Statistics for IngestConversations operation. + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: + description: The metadata for a bulk analyze conversations operation. + type: object + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata + properties: endTime: - description: The time the operation finished running. - format: google-datetime - type: string - createTime: format: google-datetime + description: The time the operation finished running. type: string - description: The time the operation was created. totalRequestedAnalysesCount: format: int32 description: >- @@ -2814,698 +2199,1202 @@ components: conversations returned by `filter` multiplied by `analysis_percentage` in the request. type: integer - completedAnalysesCount: + failedAnalysesCount: format: int32 + description: The number of requested analyses that have failed so far. + type: integer + createTime: + description: The time the operation was created. + format: google-datetime + type: string + completedAnalysesCount: description: >- The number of requested analyses that have completed successfully so far. type: integer - description: The metadata for a bulk analyze conversations operation. - GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: - id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - description: The data for an issue match annotation. - type: object + format: int32 + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + description: The original request for bulk analyze. + partialErrors: + readOnly: true + items: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. + type: array + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: + description: Metadata for deploying an issue model. properties: - issueAssignment: + createTime: + type: string + format: google-datetime + description: Output only. The time the operation was created. + readOnly: true + endTime: + type: string + format: google-datetime + description: Output only. The time the operation finished running. + readOnly: true + request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - description: Information about the issue's assignment. - GoogleCloudContactcenterinsightsV1alpha1Conversation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest + description: The original request for deployment. type: object + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata + GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest properties: - turnCount: - format: int32 - type: integer - description: Output only. The number of turns in the conversation. + name: + type: string + description: Required. The name of the issue model to delete. + type: object + description: The request to delete an issue model. + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + properties: + smartReplyAllowlistCovered: + description: >- + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + type: boolean + type: object + description: Metadata from Dialogflow relating to the current transcript segment. + GoogleCloudContactcenterinsightsV1alpha1Analysis: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1Analysis + properties: + createTime: + description: >- + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. readOnly: true - latestAnalysis: - description: Output only. The conversation's latest analysis, if one exists. + type: string + format: google-datetime + annotatorSelector: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + analysisResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + description: >- + Output only. The result of the analysis, which is populated when the + analysis finishes. readOnly: true - agentId: - type: string + name: description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. - obfuscatedUserId: + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} type: string - description: Obfuscated user ID which the customer sent to us. - languageCode: + requestTime: type: string - description: A user-specified language code for the conversation. - updateTime: format: google-datetime + readOnly: true + description: Output only. The time at which the analysis was requested. + description: The analysis resource. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: + type: object + properties: + duplicatesSkippedCount: readOnly: true description: >- - Output only. The most recent time at which the conversation was - updated. + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + type: integer + format: int32 + successfulIngestCount: + description: >- + Output only. The number of new conversations added during this + ingest operation. + readOnly: true + format: int32 + type: integer + processedObjectCount: + description: >- + Output only. The number of objects processed during the ingest + operation. + readOnly: true + format: int32 + type: integer + failedIngestCount: + readOnly: true + type: integer + description: >- + Output only. The number of objects which were unable to be ingested + due to errors. The errors are populated in the partial_errors field. + format: int32 + description: Statistics for IngestConversations operation. + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: + type: object + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + description: Request to export an issue model. + properties: + name: type: string - latestSummary: - readOnly: true + description: Required. The issue model to export. + gcsDestination: + description: Google Cloud Storage URI to export the issue model to. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - description: Output only. Latest summary of the conversation. + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + GoogleCloudContactcenterinsightsV1alpha1HoldData: + type: object + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1HoldData + description: The data for a hold annotation. + GoogleCloudContactcenterinsightsV1alpha1Conversation: + properties: expireTime: - format: google-datetime type: string + format: google-datetime description: >- The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. - medium: + startTime: + format: google-datetime type: string - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT + description: The time at which the conversation started. + name: description: >- - Immutable. The conversation medium, if unspecified will default to - PHONE_CALL. - callMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - description: Call-specific metadata. - metadataJson: + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} type: string - description: >- - Input only. JSON Metadata encoded as a string. This field is - primarily used by Insights integrations with various telphony - systems and must be in one of Insights' supported formats. - transcript: + dataSource: + description: The source of the audio and transcription for the conversation. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript - readOnly: true - description: Output only. The conversation transcript. - ttl: - format: google-duration + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + obfuscatedUserId: type: string - description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. - duration: + description: Obfuscated user ID which the customer sent to us. + turnCount: readOnly: true - format: google-duration - type: string - description: Output only. The duration of the conversation. - dataSource: + type: integer + description: Output only. The number of turns in the conversation. + format: int32 + callMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - description: The source of the audio and transcription for the conversation. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + description: Call-specific metadata. createTime: - readOnly: true + description: Output only. The time at which the conversation was created. type: string + readOnly: true format: google-datetime - description: Output only. The time at which the conversation was created. dialogflowIntents: + readOnly: true type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent description: >- Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} - readOnly: true - labels: - type: object additionalProperties: - type: string + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent + labels: description: >- A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. + type: object + additionalProperties: + type: string + transcript: + readOnly: true + description: Output only. The conversation transcript. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript + languageCode: + type: string + description: A user-specified language code for the conversation. + agentId: + type: string + description: >- + An opaque, user-specified string representing the human agent who + handled the conversation. runtimeAnnotations: + readOnly: true + type: array description: >- Output only. The annotations that were generated during the customer and agent interaction. - type: array items: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + duration: readOnly: true - qualityMetadata: + format: google-duration + type: string + description: Output only. The duration of the conversation. + latestAnalysis: + description: Output only. The conversation's latest analysis, if one exists. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - description: Conversation metadata related to quality management. - startTime: - description: The time at which the conversation started. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis + readOnly: true + metadataJson: + description: >- + Input only. JSON Metadata encoded as a string. This field is + primarily used by Insights integrations with various telphony + systems and must be in one of Insights' supported formats. + type: string + updateTime: + description: >- + Output only. The most recent time at which the conversation was + updated. type: string + readOnly: true format: google-datetime - name: + ttl: type: string description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} + Input only. The TTL for this resource. If specified, then this TTL + will be used to calculate the expire time. + format: google-duration + latestSummary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + description: Output only. Latest summary of the conversation. + readOnly: true + qualityMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata + description: Conversation metadata related to quality management. + medium: + description: >- + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + type: string + type: object id: GoogleCloudContactcenterinsightsV1alpha1Conversation description: The conversation resource. - GoogleCloudContactcenterinsightsV1AnnotatorSelector: + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest: + description: The request to initialize a location-level encryption specification. type: object + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest properties: - runEntityAnnotator: - type: boolean - description: Whether to run the entity annotator. - issueModels: - type: array - items: - type: string - description: >- - The issue model to run. If not provided, the most recently deployed - topic model will be used. The provided issue model will only be used - for inference if the issue model is deployed and if - run_issue_model_annotator is set to true. If more than one issue - model is provided, only the first provided issue model will be used - for inference. - runIssueModelAnnotator: - type: boolean + encryptionSpec: description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - runSummarizationAnnotator: - description: Whether to run the summarization annotator. - type: boolean - summarizationConfig: - description: Configuration for the summarization annotator. + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - runSentimentAnnotator: - type: boolean - description: Whether to run the sentiment annotator. - runInterruptionAnnotator: - type: boolean - description: Whether to run the interruption annotator. - runPhraseMatcherAnnotator: - description: Whether to run the active phrase matcher annotator(s). - type: boolean - runIntentAnnotator: - description: Whether to run the intent annotator. - type: boolean - phraseMatchers: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: + type: object + properties: + endTime: + type: string + description: Output only. The time the operation finished running. + readOnly: true + format: google-datetime + request: + description: Output only. The original request for ingest. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + partialErrors: items: - type: string - type: array + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - The list of phrase matchers to run. If not provided, all active - phrase matchers will be used. If inactive phrase matchers are - provided, they will not be used. Phrase matchers will be run only if - run_phrase_matcher_annotator is set to true. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - runSilenceAnnotator: - type: boolean - description: Whether to run the silence annotator. - description: Selector of all available annotators and phrase matchers to run. - id: GoogleCloudContactcenterinsightsV1AnnotatorSelector - GoogleCloudContactcenterinsightsV1GcsSource: + Output only. Partial errors during ingest operation that might cause + the operation output to be incomplete. + readOnly: true + type: array + createTime: + type: string + description: Output only. The time the operation was created. + format: google-datetime + readOnly: true + ingestConversationsStats: + description: Output only. Statistics for IngestConversations operation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + readOnly: true + description: The metadata for an IngestConversations operation. + id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata + GoogleCloudContactcenterinsightsV1View: properties: - audioUri: + value: type: string - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - transcriptUri: + description: String with specific view properties, must be non-empty. + name: type: string description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. - id: GoogleCloudContactcenterinsightsV1GcsSource - type: object - description: A Cloud Storage source of conversation data. - GoogleCloudContactcenterinsightsV1alpha1SentimentData: - id: GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: The data for a sentiment annotation. - properties: - score: - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - format: float - type: number - magnitude: - type: number - format: float - description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. + Immutable. The resource name of the view. Format: + projects/{project}/locations/{location}/views/{view} + updateTime: + description: Output only. The most recent time at which the view was updated. + format: google-datetime + readOnly: true + type: string + displayName: + description: The human-readable display name of the view. + type: string + createTime: + type: string + format: google-datetime + description: Output only. The time at which this view was created. + readOnly: true + id: GoogleCloudContactcenterinsightsV1View type: object - GoogleCloudContactcenterinsightsV1CalculateStatsResponse: + description: The View resource. + GoogleCloudContactcenterinsightsV1IssueModelLabelStats: + description: Aggregated statistics about an issue model. + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats type: object - description: The response for calculating conversation statistics. - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse properties: - smartHighlighterMatches: - type: object - additionalProperties: - format: int32 - type: integer - description: >- - A map associating each smart highlighter display name with its - respective number of matches in the set of conversations. - customHighlighterMatches: - additionalProperties: - type: integer - format: int32 + analyzedConversationsCount: + type: string description: >- - A map associating each custom highlighter resource name with its - respective number of matches in the set of conversations. - type: object - conversationCount: - format: int32 - description: The total number of conversations. - type: integer - issueMatchesStats: + Number of conversations the issue model has analyzed at this point + in time. + format: int64 + issueStats: + description: Statistics on each issue. Key is the issue's resource name. additionalProperties: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - description: >- - A map associating each issue resource name with its respective - number of matches in the set of conversations. Key has the format: - `projects//locations//issueModels//issues/` type: object - conversationCountTimeSeries: + unclassifiedConversationsCount: + type: string + format: int64 + description: >- + Number of analyzed conversations for which no issue was applicable + at this point in time. + GoogleCloudContactcenterinsightsV1CallAnnotation: + id: GoogleCloudContactcenterinsightsV1CallAnnotation + properties: + sentimentData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + description: Data specifying sentiment. + silenceData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' + description: Data specifying silence. + issueMatchData: + description: Data specifying an issue match. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData + annotationEndBoundary: description: >- - A time series representing the count of conversations created over - time that match that requested filter criteria. - averageTurnCount: + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + annotationStartBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + description: >- + The boundary in the conversation where the annotation starts, + inclusive. + channelTag: + description: >- + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. format: int32 - description: The average number of turns per conversation. type: integer - averageDuration: + phraseMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + description: Data specifying a phrase match. + intentMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData + description: Data specifying an intent match. + entityMentionData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData + description: Data specifying an entity mention. + interruptionData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData + description: Data specifying an interruption. + holdData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' + description: Data specifying a hold. + description: A piece of metadata that applies to a window of a call. + type: object + GoogleCloudContactcenterinsightsV1ListIssuesResponse: + properties: + issues: + type: array + description: The issues that match the request. + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + id: GoogleCloudContactcenterinsightsV1ListIssuesResponse + description: The response of listing issues. + type: object + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: + properties: + issueModel: + description: Required. The issue model to create. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel + parent: + type: string + description: Required. The parent resource of the issue model. + type: object + description: The request to create an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + description: Aggregated statistics about an issue. + type: object + properties: + displayName: + type: string + description: Display name of the issue. + issue: description: >- - The average duration of all conversations. The average is calculated - using only conversations that have a time duration. + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + type: string + labeledConversationsCount: + description: Number of conversations attached to the issue at this point in time. + type: string + format: int64 + GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: + properties: + speechRecognizer: type: string - format: google-duration - issueMatches: - type: object - additionalProperties: - format: int32 - type: integer description: >- - A map associating each issue resource name with its respective - number of matches in the set of conversations. Key has the format: - `projects//locations//issueModels//issues/` Deprecated, use - `issue_matches_stats` field instead. - deprecated: true - GoogleProtobufEmpty: + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + description: >- + Speech-to-Text configuration. Speech-to-Text settings are applied to + conversations ingested from the `UploadConversation` and + `IngestConversations` endpoints, including conversation coming from CCAI + Platform. They are not applied to conversations ingested from the + `CreateConversation` endpoint. + id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + type: object + GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: + properties: + clicked: + description: Indicates whether an answer or item was clicked by the human agent. + type: boolean + displayed: + type: boolean + description: >- + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. + correctnessLevel: + enum: + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT + enumDescriptions: + - Correctness level unspecified. + - Answer is totally wrong. + - Answer is partially correct. + - Answer is fully correct. + type: string + description: The correctness level of an answer. type: object + id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + The feedback that the customer has about a certain answer in the + conversation. + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: + properties: + name: + type: string + description: Required. The name of the issue model to delete. + description: The request to delete an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + type: object + GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: properties: {} - id: GoogleProtobufEmpty - GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse type: object - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - description: Issue Modeling result on a conversation. + description: Response from export issue model + GoogleCloudContactcenterinsightsV1Issue: properties: - issueModel: - description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} + displayDescription: type: string - issues: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + description: Representative description of the issue. + sampleUtterances: type: array - description: All the matched issues. - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript - description: A message representing the transcript of a conversation. - type: object - properties: - transcriptSegments: + readOnly: true + description: >- + Output only. Resource names of the sample representative utterances + that match to this issue. items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + type: string + name: + type: string description: >- - A list of sequential transcript segments that comprise the - conversation. - type: array - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata: - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata - description: Metadata for initializing a location-level encryption specification. - type: object - properties: - endTime: - description: Output only. The time the operation finished running. + Immutable. The resource name of the issue. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + createTime: + description: Output only. The time at which this issue was created. readOnly: true + type: string + format: google-datetime + displayName: + type: string + description: The representative name for the issue. + updateTime: format: google-datetime type: string + description: Output only. The most recent time that this issue was updated. + readOnly: true + id: GoogleCloudContactcenterinsightsV1Issue + type: object + description: The issue resource. + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: + description: The request to undeploy an issue model. + type: object + properties: + name: + description: Required. The issue model to undeploy. + type: string + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: + type: object + properties: partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - Partial errors during initialising operation that might cause the + Partial errors during export operation that might cause the operation output to be incomplete. - type: array - createTime: - type: string + items: + $ref: '#/components/schemas/GoogleRpcStatus' + endTime: format: google-datetime readOnly: true - description: Output only. The time the operation was created. + type: string + description: Output only. The time the operation finished running. request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + description: The original request for export. + createTime: + description: Output only. The time the operation was created. + type: string readOnly: true - description: Output only. The original request for initialization. - GoogleCloudContactcenterinsightsV1View: + format: google-datetime + description: Metadata for an export insights operation. + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: type: object - id: GoogleCloudContactcenterinsightsV1View - description: The View resource. + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for processing transcript objects. properties: - value: + medium: type: string - description: String with specific view properties, must be non-empty. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + description: Required. The medium transcript objects represent. + GoogleCloudContactcenterinsightsV1ConversationTranscript: + type: object + properties: + transcriptSegments: + description: >- + A list of sequential transcript segments that comprise the + conversation. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + type: array + id: GoogleCloudContactcenterinsightsV1ConversationTranscript + description: A message representing the transcript of a conversation. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: + description: The response to an IngestConversations operation. + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse + properties: {} + type: object + GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: + description: The request to undeploy an issue model. + properties: + name: + type: string + description: Required. The issue model to undeploy. + type: object + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + GoogleCloudContactcenterinsightsV1IngestConversationsResponse: + id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse + type: object + properties: {} + description: The response to an IngestConversations operation. + GoogleCloudContactcenterinsightsV1EncryptionSpec: + id: GoogleCloudContactcenterinsightsV1EncryptionSpec + type: object + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + properties: name: description: >- - Immutable. The resource name of the view. Format: - projects/{project}/locations/{location}/views/{view} + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec type: string - displayName: + kmsKey: type: string - description: The human-readable display name of the view. + description: >- + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + GoogleCloudContactcenterinsightsV1IssueMatchData: + type: object + properties: + issueAssignment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + description: Information about the issue's assignment. + description: The data for an issue match annotation. + id: GoogleCloudContactcenterinsightsV1IssueMatchData + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata + type: object + properties: createTime: - readOnly: true - description: Output only. The time at which this view was created. - format: google-datetime + description: The time the operation was created. type: string - updateTime: + format: google-datetime + endTime: type: string - description: Output only. The most recent time at which the view was updated. + description: The time the operation finished running. format: google-datetime - readOnly: true - GoogleCloudContactcenterinsightsV1CallAnnotation: - properties: - issueMatchData: - description: Data specifying an issue match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData - silenceData: - description: Data specifying silence. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' - channelTag: - type: integer - format: int32 - description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. - phraseMatchData: - description: Data specifying a phrase match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - annotationEndBoundary: + request: + description: The original request for bulk delete. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - description: >- - The boundary in the conversation where the annotation ends, - inclusive. - annotationStartBoundary: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - The boundary in the conversation where the annotation starts, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - entityMentionData: - description: Data specifying an entity mention. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData - holdData: - description: Data specifying a hold. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' - interruptionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData - description: Data specifying an interruption. - sentimentData: - description: Data specifying sentiment. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - intentMatchData: - description: Data specifying an intent match. + Partial errors during bulk delete conversations operation that might + cause the operation output to be incomplete. + description: The metadata for a bulk delete conversations operation. + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: + properties: + request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData - id: GoogleCloudContactcenterinsightsV1CallAnnotation - description: A piece of metadata that applies to a window of a call. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + description: The original request for deletion. + createTime: + readOnly: true + type: string + description: Output only. The time the operation was created. + format: google-datetime + endTime: + format: google-datetime + description: Output only. The time the operation finished running. + type: string + readOnly: true + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata type: object - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: - description: Conversation summarization suggestion data. + description: Metadata for deleting an issue model. + GoogleCloudContactcenterinsightsV1PhraseMatchData: + description: >- + The data for a matched phrase matcher. Represents information + identifying a phrase matcher for a given match. + id: GoogleCloudContactcenterinsightsV1PhraseMatchData properties: - answerRecord: + displayName: + type: string + description: The human-readable name of the phrase matcher. + phraseMatcher: + description: The unique identifier (the resource name) of the phrase matcher. + type: string + type: object + GoogleCloudContactcenterinsightsV1Analysis: + description: The analysis resource. + id: GoogleCloudContactcenterinsightsV1Analysis + type: object + properties: + createTime: + readOnly: true type: string description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - textSections: + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. + format: google-datetime + requestTime: + description: Output only. The time at which the analysis was requested. + format: google-datetime + readOnly: true + type: string + name: description: >- - The summarization content that is divided into sections. The key is - the section's name and the value is the section's content. There is - no specific format for the key or value. - type: object - additionalProperties: - type: string - text: + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} type: string - description: The summarization content that is concatenated into one string. - confidence: - type: number - format: float - description: The confidence score of the summarization. - metadata: - additionalProperties: - type: string + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector description: >- - A map that contains metadata about the summarization and the - document from which it originates. - type: object - conversationModel: + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + analysisResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} - type: string - id: >- - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - type: object - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: + Output only. The result of the analysis, which is populated when the + analysis finishes. + readOnly: true + GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata description: Metadata for deploying an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata - type: object properties: + request: + description: The original request for deployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + endTime: + format: google-datetime + description: Output only. The time the operation finished running. + readOnly: true + type: string createTime: description: Output only. The time the operation was created. format: google-datetime + type: string readOnly: true + type: object + GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput: + type: object + properties: + query: + description: >- + Query text. Article Search uses this to store the input query used + to generate the search results. + type: string + querySource: + enum: + - QUERY_SOURCE_UNSPECIFIED + - AGENT_QUERY + - SUGGESTED_QUERY + description: Query source for the answer. + enumDescriptions: + - Unknown query source. + - The query is from agents. + - >- + The query is a query from previous suggestions, e.g. from a + preceding SuggestKnowledgeAssist response. + type: string + generatorName: type: string + description: >- + The resource name of associated generator. Format: + `projects//locations//generators/` + description: Explicit input used for generating the answer + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse + description: The response for a bulk analyze conversations operation. + properties: + failedAnalysisCount: + format: int32 + type: integer + description: Count of failed analyses. + successfulAnalysisCount: + type: integer + description: Count of successful analyses. + format: int32 + type: object + GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: + properties: {} + description: Response from import issue model + type: object + id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse + GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: + description: Metadata for creating an issue model. + id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata + properties: request: - description: The original request for deployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - endTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + description: The original request for creation. + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string format: google-datetime + endTime: readOnly: true + format: google-datetime description: Output only. The time the operation finished running. - GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: - description: The call participant speaking for a given utterance. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + type: string + type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: + description: A segment of a full transcript. type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment properties: - dialogflowParticipantName: + confidence: + type: number + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + segment. A default value of 0.0 indicates that the value is unset. + format: float + messageTime: + description: The time that the message occurred, if provided. + format: google-datetime type: string + languageCode: description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - dialogflowParticipant: - deprecated: true + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". type: string + dialogflowSegmentMetadata: + description: CCAI metadata relating to the current transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + segmentParticipant: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + description: The participant of this segment. + channelTag: + format: int32 description: >- - Deprecated. Use `dialogflow_participant_name` instead. The name of - the Dialogflow participant. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - obfuscatedExternalUserId: - description: Obfuscated user ID from Dialogflow. + For conversations derived from multi-channel audio, this is the + channel number corresponding to the audio from that channel. For + audioChannelCount = N, its output values can range from '1' to 'N'. + A channel tag of 0 indicates that the audio is mono. + type: integer + text: type: string - role: + description: The text of this segment. + sentiment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: The sentiment for this transcript segment. + words: + type: array + description: >- + A list of the word-specific information for each word in the + segment. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: + type: object + properties: + segmentParticipant: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant + description: The participant of this segment. + text: + description: The text of this segment. type: string - description: The role of the participant. - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - userId: + messageTime: + description: The time that the message occurred, if provided. + type: string + format: google-datetime + channelTag: + format: int32 + type: integer + description: >- + For conversations derived from multi-channel audio, this is the + channel number corresponding to the audio from that channel. For + audioChannelCount = N, its output values can range from '1' to 'N'. + A channel tag of 0 indicates that the audio is mono. + dialogflowSegmentMetadata: + description: CCAI metadata relating to the current transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + sentiment: + description: The sentiment for this transcript segment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + words: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + type: array + description: >- + A list of the word-specific information for each word in the + segment. + confidence: + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + segment. A default value of 0.0 indicates that the value is unset. + type: number + format: float + languageCode: type: string - description: A user-specified ID representing the participant. - GoogleCloudContactcenterinsightsV1alpha1Intent: - id: GoogleCloudContactcenterinsightsV1alpha1Intent + description: >- + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + description: A segment of a full transcript. + GoogleCloudContactcenterinsightsV1AnswerFeedback: type: object + id: GoogleCloudContactcenterinsightsV1AnswerFeedback description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. + The feedback that the customer has about a certain answer in the + conversation. properties: - displayName: - description: The human-readable name of the intent. - type: string - id: + correctnessLevel: + enum: + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT + enumDescriptions: + - Correctness level unspecified. + - Answer is totally wrong. + - Answer is partially correct. + - Answer is fully correct. + description: The correctness level of an answer. type: string - description: The unique identifier of the intent. - GoogleCloudContactcenterinsightsV1ConversationParticipant: + clicked: + description: Indicates whether an answer or item was clicked by the human agent. + type: boolean + displayed: + description: >- + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. + type: boolean + GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + type: object properties: - obfuscatedExternalUserId: - type: string - description: Obfuscated user ID from Dialogflow. - role: - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - description: The role of the participant. + team: type: string - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - userId: - description: A user-specified ID representing the participant. + description: A user-specified string representing the agent's team. + displayName: type: string - dialogflowParticipant: + description: The agent's name. + agentId: + description: A user-specified string representing the agent. type: string - deprecated: true + dispositionCode: description: >- - Deprecated. Use `dialogflow_participant_name` instead. The name of - the Dialogflow participant. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - dialogflowParticipantName: + A user-provided string indicating the outcome of the agent's segment + of the call. type: string - description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - description: The call participant speaking for a given utterance. - id: GoogleCloudContactcenterinsightsV1ConversationParticipant - type: object - GoogleCloudContactcenterinsightsV1alpha1HoldData: + description: Information about an agent involved in the conversation. + GoogleCloudContactcenterinsightsV1SilenceData: properties: {} - description: The data for a hold annotation. - id: GoogleCloudContactcenterinsightsV1alpha1HoldData type: object - GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec: + id: GoogleCloudContactcenterinsightsV1SilenceData + description: The data for a silence annotation. + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: + id: >- + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + description: A single interval in a time series. properties: - kmsKey: - type: string - description: >- - Required. The name of customer-managed encryption key that is used - to secure a resource and its sub-resources. If empty, the resource - is secured by the default Google encryption key. Only the key in the - same location as this resource is allowed to be used for encryption. - Format: - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` - name: - description: >- - Immutable. The resource name of the encryption key specification - resource. Format: - projects/{project}/locations/{location}/encryptionSpec + startTime: + format: google-datetime type: string + description: The start time of this interval. + conversationCount: + description: The number of conversations created in this interval. + format: int32 + type: integer type: object - description: >- - A customer-managed encryption key specification that can be applied to - all created resources (e.g. Conversation). - id: GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: + GoogleCloudContactcenterinsightsV1ConversationCallMetadata: + id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - description: The original import request. + customerChannel: + type: integer + format: int32 + description: The audio channel that contains the customer. + agentChannel: + format: int32 + type: integer + description: The audio channel that contains the agent. + type: object + description: Call-specific metadata. + GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: + type: object + description: The metadata for an `UploadConversation` operation. + properties: + analysisOperation: + readOnly: true + description: >- + Output only. The operation name for a successfully created analysis + operation, if any. + type: string createTime: - format: google-datetime type: string - description: The time the operation was created. + readOnly: true + description: Output only. The time the operation was created. + format: google-datetime + appliedRedactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + description: >- + Output only. The redaction config applied to the uploaded + conversation. + readOnly: true + request: + description: Output only. The original request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest + readOnly: true endTime: + description: Output only. The time the operation finished running. format: google-datetime type: string - description: The time the operation finished running. + readOnly: true + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata + GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: type: object - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata + id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata description: Metadata used for import issue model. - GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: - type: object - description: Metadata used for export issue model. properties: request: - description: The original export request. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + description: The original import request. + endTime: + type: string + description: The time the operation finished running. + format: google-datetime createTime: + format: google-datetime + type: string description: The time the operation was created. + GoogleCloudContactcenterinsightsV1IntentMatchData: + description: >- + The data for an intent match. Represents an intent match for a text + segment in the conversation. A text segment can be part of a sentence, a + complete sentence, or an utterance with multiple sentences. + type: object + properties: + intentUniqueId: type: string + description: >- + The id of the matched intent. Can be used to retrieve the + corresponding intent information. + id: GoogleCloudContactcenterinsightsV1IntentMatchData + GoogleCloudContactcenterinsightsV1UploadConversationMetadata: + id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata + properties: + createTime: format: google-datetime + type: string + readOnly: true + description: Output only. The time the operation was created. + analysisOperation: + description: >- + Output only. The operation name for a successfully created analysis + operation, if any. + type: string + readOnly: true + appliedRedactionConfig: + description: >- + Output only. The redaction config applied to the uploaded + conversation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - description: The time the operation finished running. format: google-datetime - id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata - GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: + request: + description: Output only. The original request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + readOnly: true + description: The metadata for an `UploadConversation` operation. + type: object + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse: + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse + properties: {} + description: The response to initialize a location-level encryption specification. + type: object + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest: + description: The request to initialize a location-level encryption specification. + type: object + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + properties: + encryptionSpec: + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + GoogleCloudContactcenterinsightsV1alpha1SilenceData: + id: GoogleCloudContactcenterinsightsV1alpha1SilenceData + description: The data for a silence annotation. + properties: {} type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: properties: - metadata: + confidence: + format: float + type: number description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - type: object - additionalProperties: - type: string - suggestion: - type: string - description: The content of the suggestion. - queryRecord: + A confidence estimate between 0.0 and 1.0 of the fidelity of this + word. A default value of 0.0 indicates that the value is unset. + startOffset: type: string + format: google-duration description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - confidenceScore: - type: number + Time offset of the start of this word relative to the beginning of + the total conversation. + word: + description: The word itself. Includes punctuation marks that surround the word. + type: string + endOffset: + type: string + format: google-duration description: >- - The system's confidence score that this suggestion is a good match - for this conversation, ranging from 0.0 (completely uncertain) to - 1.0 (completely certain). - format: double - description: Agent Assist Smart Compose suggestion data. - id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse: - description: The response to initialize a location-level encryption specification. - type: object - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse - properties: {} - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: - properties: {} + Time offset of the end of this word relative to the beginning of the + total conversation. + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + description: Word-level info for words in a transcript. type: object - description: Response from import issue model - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse - GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput: - id: GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput: type: object properties: + query: + type: string + description: >- + Query text. Article Search uses this to store the input query used + to generate the search results. generatorName: + type: string description: >- The resource name of associated generator. Format: `projects//locations//generators/` - type: string querySource: + enum: + - QUERY_SOURCE_UNSPECIFIED + - AGENT_QUERY + - SUGGESTED_QUERY description: Query source for the answer. enumDescriptions: - Unknown query source. @@ -3513,497 +3402,422 @@ components: - >- The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response. - enum: - - QUERY_SOURCE_UNSPECIFIED - - AGENT_QUERY - - SUGGESTED_QUERY - type: string - query: - description: >- - Query text. Article Search uses this to store the input query used - to generate the search results. type: string description: Explicit input used for generating the answer - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest - properties: - parent: - type: string - description: Required. The parent resource to export data from. - writeDisposition: - enumDescriptions: - - Write disposition is not specified. Defaults to WRITE_TRUNCATE. - - >- - If the table already exists, BigQuery will overwrite the table - data and use the schema from the load. - - >- - If the table already exists, BigQuery will append data to the - table. - type: string - enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - description: Options for what to do if the destination table already exists. - bigQueryDestination: - description: Specified if sink is a BigQuery table. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination - filter: - type: string - description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. - kmsKey: - type: string - description: >- - A fully qualified KMS key name for BigQuery tables protected by - CMEK. Format: - projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} - description: The request to export insights. - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: - type: object - description: A BigQuery Table Reference. - id: >- - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - properties: - table: - description: >- - The BigQuery table name to which the insights data should be - written. If this table does not exist, the export call returns an - INVALID_ARGUMENT error. - type: string - projectId: - type: string - description: >- - A project ID or number. If specified, then export will attempt to - write data to this project instead of the resource project. - Otherwise, the resource project will be used. - dataset: - description: >- - Required. The name of the BigQuery dataset that the snapshot result - should be exported to. If this dataset does not exist, the export - call returns an INVALID_ARGUMENT error. - type: string - GoogleCloudContactcenterinsightsV1ConversationLevelSilence: - description: Conversation-level silence data. - id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence properties: - silenceDuration: - format: google-duration - description: Amount of time calculated to be in silence. - type: string silencePercentage: - type: number description: Percentage of the total conversation spent in silence. format: float - type: object - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: - properties: - medium: + type: number + silenceDuration: + description: Amount of time calculated to be in silence. + format: google-duration type: string - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - description: Required. The medium transcript objects represent. - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. type: object - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for processing transcript objects. - GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: - type: object - description: Aggregated statistics about an issue. - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - properties: - labeledConversationsCount: - description: Number of conversations attached to the issue at this point in time. - type: string - format: int64 - issue: - description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - type: string - displayName: - description: Display name of the issue. - type: string - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: - description: The metadata for a bulk analyze conversations operation. - properties: - completedAnalysesCount: - type: integer - description: >- - The number of requested analyses that have completed successfully so - far. - format: int32 - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - description: The original request for bulk analyze. - partialErrors: - readOnly: true - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. - type: array - failedAnalysesCount: - format: int32 - type: integer - description: The number of requested analyses that have failed so far. - createTime: - format: google-datetime - type: string - description: The time the operation was created. - endTime: - description: The time the operation finished running. - type: string - format: google-datetime - totalRequestedAnalysesCount: - type: integer - description: >- - Total number of analyses requested. Computed by the number of - conversations returned by `filter` multiplied by - `analysis_percentage` in the request. - format: int32 - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata + description: Conversation-level silence data. + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: type: object - GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: - id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData + description: The response to undeploy an issue model. + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: type: object + description: Conversation summarization suggestion data. properties: - queryRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string - confidenceScore: - type: number + textSections: + additionalProperties: + type: string + type: object description: >- - The system's confidence score that this reply is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - format: double - reply: - description: The content of the reply. - type: string + The summarization content that is divided into sections. The key is + the section's name and the value is the section's content. There is + no specific format for the key or value. metadata: - type: object description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. + A map that contains metadata about the summarization and the + document from which it originates. + type: object additionalProperties: type: string - description: Agent Assist Smart Reply data. - GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: - type: object - description: Request to import an issue model. - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - properties: - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - description: Google Cloud Storage source message. - parent: + conversationModel: type: string - description: Required. The parent resource of the issue model. - createNewModel: - type: boolean description: >- - Optional. If set to true, will create an issue model from the - imported file with randomly generated IDs for the issue model and - corresponding issues. Otherwise, replaces an existing model with the - same ID as the file. - GoogleCloudContactcenterinsightsV1IssueModel: - properties: - languageCode: + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} + answerRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - description: Language of the model. - createTime: - readOnly: true - description: Output only. The time at which this issue model was created. + confidence: + format: float + type: number + description: The confidence score of the summarization. + text: + description: The summarization content that is concatenated into one string. type: string - format: google-datetime - updateTime: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: + properties: + endTime: + description: The time at which the analysis ended. type: string - readOnly: true format: google-datetime - description: >- - Output only. The most recent time at which the issue model was - updated. - inputDataConfig: + callAnalysisMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - description: Configs for the input data that used to create the issue model. - name: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + description: Call-specific metadata created by the analysis. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + description: The result of an analysis. + GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: + id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + properties: + sentiment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Sentiment expressed for this mention of the entity. + entityUniqueId: type: string description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - issueCount: - format: int64 - readOnly: true - description: Output only. Number of issues in this issue model. - type: string - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. + type: type: string enumDescriptions: - Unspecified. - - Model is not deployed but is ready to deploy. - - Model is being deployed. - - >- - Model is deployed and is ready to be used. A model can only be - used in analysis if it's in this state. - - Model is being undeployed. - - Model is being deleted. - description: Output only. State of the model. - trainingStats: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats - description: >- - Output only. Immutable. The issue model's label statistics on its - training data. - modelType: - description: Type of the model. - enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. + - Proper noun. + - Common noun (or noun compound). enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 - type: string - displayName: - description: The representative name for the issue model. - type: string + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + description: The type of the entity mention. type: object - description: The issue model resource. - id: GoogleCloudContactcenterinsightsV1IssueModel - GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: + description: >- + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: type: object + description: A message representing the transcript of a conversation. + id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript properties: - conversation: + transcriptSegments: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + type: array description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - type: string - readOnly: true + A list of sequential transcript segments that comprise the + conversation. + GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata + type: object + description: Metadata used for export issue model. + properties: endTime: - readOnly: true - type: string format: google-datetime - description: Output only. The time the operation finished running. - annotatorSelector: - readOnly: true - description: Output only. The annotator selector used for the analysis (if any). - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + type: string + description: The time the operation finished running. createTime: - readOnly: true - description: Output only. The time the operation was created. + description: The time the operation was created. + type: string format: google-datetime + request: + description: The original export request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + description: A BigQuery Table Reference. + type: object + properties: + projectId: + description: >- + A project ID or number. If specified, then export will attempt to + write data to this project instead of the resource project. + Otherwise, the resource project will be used. type: string - description: Metadata for a create analysis operation. - id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: + table: + type: string + description: >- + The BigQuery table name to which the insights data should be + written. If this table does not exist, the export call returns an + INVALID_ARGUMENT error. + dataset: + description: >- + Required. The name of the BigQuery dataset that the snapshot result + should be exported to. If this dataset does not exist, the export + call returns an INVALID_ARGUMENT error. + type: string + GoogleCloudContactcenterinsightsV1IssueModelResult: properties: - agentId: + issues: + description: All the matched issues. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + issueModel: type: string - description: A user-specified string representing the agent. - team: + description: >- + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + id: GoogleCloudContactcenterinsightsV1IssueModelResult + type: object + description: Issue Modeling result on a conversation. + GoogleCloudContactcenterinsightsV1ListConversationsResponse: + properties: + conversations: + description: The conversations that match the request. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + type: array + nextPageToken: + description: >- + A token which can be sent as `page_token` to retrieve the next page. + If this field is set, it means there is another page available. If + it is not set, it means no other pages are available. type: string - description: A user-specified string representing the agent's team. - displayName: + type: object + description: The response of listing conversations. + id: GoogleCloudContactcenterinsightsV1ListConversationsResponse + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + properties: + smartReplyAllowlistCovered: + description: >- + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + type: boolean + type: object + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + description: Metadata from Dialogflow relating to the current transcript segment. + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: + description: Metadata for undeploying an issue model. + properties: + request: + description: The original request for undeployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + endTime: + readOnly: true type: string - description: The agent's name. - dispositionCode: - description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. + format: google-datetime + description: Output only. The time the operation finished running. + createTime: type: string + description: Output only. The time the operation was created. + readOnly: true + format: google-datetime type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - description: Information about an agent involved in the conversation. - GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment properties: + sentimentData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Data specifying sentiment. channelTag: format: int32 - description: The channel of the audio that the data applies to. type: integer - sentimentData: - description: Data specifying sentiment. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + description: The channel of the audio that the data applies to. description: One channel of conversation-level sentiment data. type: object - GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: + GoogleCloudContactcenterinsightsV1Intent: type: object - description: Request to upload a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest properties: - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. - speechConfig: - description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - conversationId: + id: type: string - description: >- - Optional. A unique ID for the new conversation. This ID will become - the final component of the conversation's resource name. If no ID is - specified, a server-generated ID will be used. This value should be - 4-64 characters and must match the regular expression - `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` - conversation: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation - description: Required. The conversation resource to create. - parent: - description: Required. The parent resource of the conversation. + description: The unique identifier of the intent. + displayName: + description: The human-readable name of the intent. type: string - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: + id: GoogleCloudContactcenterinsightsV1Intent + description: >- + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. + GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: + description: Google Cloud Storage Object URI to get the issue model file from. type: object - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse - properties: {} - description: The response to an IngestConversations operation. - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata: + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource properties: - endTime: - format: google-datetime - readOnly: true - description: Output only. The time the operation finished running. + objectUri: + description: 'Required. Format: `gs:///`' type: string + GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: + description: Metadata for undeploying an issue model. + type: object + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata + properties: request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + description: The original request for undeployment. + endTime: + type: string readOnly: true - description: Output only. The original request for initialization. - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Partial errors during initialising operation that might cause the - operation output to be incomplete. - type: array + format: google-datetime + description: Output only. The time the operation finished running. createTime: - type: string description: Output only. The time the operation was created. - format: google-datetime readOnly: true - type: object - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata - description: Metadata for initializing a location-level encryption specification. - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest: - description: The request to initialize a location-level encryption specification. + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1alpha1GcsSource: properties: - encryptionSpec: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + transcriptUri: description: >- - Required. The encryption spec used for CMEK encryption. It is - required that the kms key is in the same region as the endpoint. The - same key will be used for all provisioned resources, if encryption - is available. If the kms_key_name is left empty, no encryption will - be enforced. - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. + type: string + audioUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. + type: string + id: GoogleCloudContactcenterinsightsV1alpha1GcsSource + description: A Cloud Storage source of conversation data. type: object - GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: - description: Agent Assist Smart Compose suggestion data. + GoogleCloudContactcenterinsightsV1GcsSource: + type: object + id: GoogleCloudContactcenterinsightsV1GcsSource + description: A Cloud Storage source of conversation data. properties: - suggestion: + audioUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. type: string - description: The content of the suggestion. - queryRecord: + transcriptUri: type: string description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - confidenceScore: - format: double - type: number - description: >- - The system's confidence score that this suggestion is a good match - for this conversation, ranging from 0.0 (completely uncertain) to - 1.0 (completely certain). - metadata: + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: + description: The response for a bulk delete conversations operation. + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse + properties: {} + type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: + type: object + properties: + agentChannel: + format: int32 + type: integer + description: The audio channel that contains the agent. + customerChannel: + type: integer + description: The audio channel that contains the customer. + format: int32 + description: Call-specific metadata. + id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: + id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + properties: + annotations: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation + description: A list of call annotations that apply to this call. + type: array + issueModelResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult + description: Overall conversation-level issue modeling result. + entities: type: object additionalProperties: - type: string - description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData - type: object - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest - description: The request to export insights. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' + description: All the entities in the call. + intents: + type: object + description: All the matched intents in the call. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' + sentiments: + description: Overall conversation-level sentiment for each channel of the call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + type: array + silence: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence + description: Overall conversation-level silence during the call. + phraseMatchers: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + description: All the matched phrase matchers in the call. + type: object + description: Call-specific metadata created during analysis. type: object + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest properties: - kmsKey: - type: string + conversationConfig: + description: Configuration that applies to all conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig + sampleSize: + type: integer description: >- - A fully qualified KMS key name for BigQuery tables protected by - CMEK. Format: - projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} - bigQueryDestination: + Optional. If set, this fields indicates the number of objects to + ingest from the Cloud Storage bucket. If empty, the entire bucket + will be ingested. Unless they are first deleted, conversations + produced through sampling won't be ingested by subsequent ingest + requests. + format: int32 + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + description: >- + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + transcriptObjectConfig: + description: Configuration for when `source` contains conversation transcripts. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig + speechConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - description: Specified if sink is a BigQuery table. - writeDisposition: - description: Options for what to do if the destination table already exists. - enumDescriptions: - - Write disposition is not specified. Defaults to WRITE_TRUNCATE. - - >- - If the table already exists, BigQuery will overwrite the table - data and use the schema from the load. - - >- - If the table already exists, BigQuery will append data to the - table. - enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - type: string + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + description: >- + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. parent: + description: Required. The parent resource for new conversations. type: string - description: Required. The parent resource to export data from. - filter: + redactionConfig: description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. - type: string - GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: - description: The request to undeploy an issue model. + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + type: object + description: The request to ingest conversations. + GoogleCloudContactcenterinsightsV1DialogflowInteractionData: properties: - name: + confidence: + description: >- + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + type: number + format: float + dialogflowIntentId: + description: >- + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} type: string - description: Required. The issue model to undeploy. - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + description: Dialogflow interaction data. + id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData type: object GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: properties: @@ -4011,972 +3825,1139 @@ components: items: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + type: array description: >- An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window. - type: array intervalDuration: - description: The duration of each interval. - format: google-duration type: string + format: google-duration + description: The duration of each interval. + type: object id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries description: A time series representing conversations over time. + GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - description: Google Cloud Storage Object URI to save the issue model to. + description: Agent Assist Smart Reply data. + id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData properties: - objectUri: + confidenceScore: + description: >- + The system's confidence score that this reply is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + format: double + queryRecord: type: string - description: 'Required. Format: `gs:///`' + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + metadata: + type: object + additionalProperties: + type: string + description: >- + Map that contains metadata about the Smart Reply and the document + from which it originates. + reply: + description: The content of the reply. + type: string + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo type: object - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: - description: The request to delete an issue model. properties: - name: - description: Required. The name of the issue model to delete. + displayName: type: string - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest - type: object + description: The agent's name. + agentId: + description: A user-specified string representing the agent. + type: string + team: + type: string + description: A user-specified string representing the agent's team. + dispositionCode: + description: >- + A user-provided string indicating the outcome of the agent's segment + of the call. + type: string + description: Information about an agent involved in the conversation. GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: - description: The metadata for an IngestConversations operation. properties: - request: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - description: Output only. The original request for ingest. partialErrors: - readOnly: true type: array items: $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true description: >- Output only. Partial errors during ingest operation that might cause the operation output to be incomplete. - ingestConversationsStats: - readOnly: true - description: Output only. Statistics for IngestConversations operation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats - endTime: - type: string - readOnly: true - description: Output only. The time the operation finished running. - format: google-datetime createTime: - readOnly: true type: string description: Output only. The time the operation was created. format: google-datetime - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata - type: object - GoogleCloudContactcenterinsightsV1alpha1IntentMatchData: - id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - description: >- - The data for an intent match. Represents an intent match for a text - segment in the conversation. A text segment can be part of a sentence, a - complete sentence, or an utterance with multiple sentences. - properties: - intentUniqueId: - type: string - description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. - type: object - GoogleCloudContactcenterinsightsV1ListViewsResponse: - properties: - nextPageToken: + readOnly: true + endTime: type: string - 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. - views: - description: The views that match the request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' - type: object - id: GoogleCloudContactcenterinsightsV1ListViewsResponse - description: The response of listing views. - GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: - description: Call-specific metadata. - properties: - agentChannel: - type: integer - description: The audio channel that contains the agent. - format: int32 - customerChannel: - description: The audio channel that contains the customer. - format: int32 - type: integer - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse - type: object - description: The response for a bulk delete conversations operation. - properties: {} - GoogleCloudContactcenterinsightsV1alpha1InterruptionData: - id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData - type: object - description: The data for an interruption annotation. - properties: {} - GoogleCloudContactcenterinsightsV1UploadConversationMetadata: - id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata - description: The metadata for an `UploadConversation` operation. - type: object - properties: - request: + description: Output only. The time the operation finished running. + format: google-datetime readOnly: true + ingestConversationsStats: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest - description: Output only. The original request. - appliedRedactionConfig: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats readOnly: true - description: >- - Output only. The redaction config applied to the uploaded - conversation. + description: Output only. Statistics for IngestConversations operation. + request: + description: Output only. The original request for ingest. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - analysisOperation: - description: >- - Output only. The operation name for a successfully created analysis - operation, if any. - type: string - readOnly: true - endTime: - description: Output only. The time the operation finished running. - readOnly: true - type: string - format: google-datetime - createTime: - type: string - description: Output only. The time the operation was created. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest readOnly: true - format: google-datetime - GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: + type: object + description: The metadata for an IngestConversations operation. + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata + GoogleCloudContactcenterinsightsV1ArticleSuggestionData: type: object properties: - confidence: + uri: + description: Article URI. + type: string + metadata: + type: object + additionalProperties: + type: string description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). - type: number - format: float - dialogflowIntentId: + Map that contains metadata about the Article Suggestion and the + document that it originates from. + title: + type: string + description: Article title. + source: type: string description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} - description: Dialogflow interaction data. - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData - GoogleCloudContactcenterinsightsV1SmartReplyData: - type: object - properties: + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} queryRecord: - type: string description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - reply: - description: The content of the reply. type: string confidenceScore: + format: float + type: number description: >- - The system's confidence score that this reply is a good match for + The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). - format: double + id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData + description: Agent Assist Article Suggestion data. + GoogleCloudContactcenterinsightsV1ConversationLevelSilence: + properties: + silenceDuration: + description: Amount of time calculated to be in silence. + format: google-duration + type: string + silencePercentage: + format: float type: number - metadata: + description: Percentage of the total conversation spent in silence. + id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence + type: object + description: Conversation-level silence data. + GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: + description: Response of querying an issue model's statistics. + id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + properties: + currentStats: description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. - type: object - additionalProperties: - type: string - id: GoogleCloudContactcenterinsightsV1SmartReplyData - description: Agent Assist Smart Reply data. + The latest label statistics for the queried issue model. Includes + results on both training data and data labeled after deployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + type: object GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: - id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData properties: displayName: - type: string description: The human-readable name of the phrase matcher. + type: string phraseMatcher: - description: The unique identifier (the resource name) of the phrase matcher. type: string + description: The unique identifier (the resource name) of the phrase matcher. description: >- The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. type: object - GoogleCloudContactcenterinsightsV1ConversationDataSource: - description: The conversation source, which is a combination of transcript and audio. - id: GoogleCloudContactcenterinsightsV1ConversationDataSource - properties: - dialogflowSource: - description: The source when the conversation comes from Dialogflow. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource - gcsSource: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' - description: A Cloud Storage location specification for the audio and transcript. - type: object - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: - type: object - description: Metadata for undeploying an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + GoogleCloudContactcenterinsightsV1IssueModel: properties: - endTime: + updateTime: + readOnly: true format: google-datetime type: string - readOnly: true - description: Output only. The time the operation finished running. + description: >- + Output only. The most recent time at which the issue model was + updated. createTime: - format: google-datetime - description: Output only. The time the operation was created. + type: string readOnly: true + format: google-datetime + description: Output only. The time at which this issue model was created. + name: + description: >- + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} type: string - request: - description: The original request for undeployment. + modelType: + type: string + description: Type of the model. + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + inputDataConfig: + description: Configs for the input data that used to create the issue model. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata - GoogleCloudContactcenterinsightsV1IssueModelLabelStats: - properties: - analyzedConversationsCount: + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + issueCount: + description: Output only. Number of issues in this issue model. format: int64 - description: >- - Number of conversations the issue model has analyzed at this point - in time. type: string - unclassifiedConversationsCount: + readOnly: true + languageCode: + description: Language of the model. + type: string + trainingStats: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + readOnly: true description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. + Output only. Immutable. The issue model's label statistics on its + training data. + displayName: + description: The representative name for the issue model. type: string - format: int64 - issueStats: - description: Statistics on each issue. Key is the issue's resource name. + state: + readOnly: true + type: string + description: Output only. State of the model. + enumDescriptions: + - Unspecified. + - Model is not deployed but is ready to deploy. + - Model is being deployed. + - >- + Model is deployed and is ready to be used. A model can only be + used in analysis if it's in this state. + - Model is being undeployed. + - Model is being deleted. + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + id: GoogleCloudContactcenterinsightsV1IssueModel + description: The issue model resource. + type: object + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: + type: object + description: Call-specific metadata created during analysis. + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + properties: + sentiments: + type: array + description: Overall conversation-level sentiment for each channel of the call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment + phraseMatchers: + description: All the matched phrase matchers in the call. type: object additionalProperties: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - description: Aggregated statistics about an issue model. - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + intents: + description: All the matched intents in the call. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent + annotations: + description: A list of call annotations that apply to this call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + type: array + silence: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + description: Overall conversation-level silence during the call. + issueModelResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + description: Overall conversation-level issue modeling result. + entities: + description: All the entities in the call. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity + type: object + GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: + description: Google Cloud Storage Object URI to save the issue model to. + properties: + objectUri: + description: 'Required. Format: `gs:///`' + type: string type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModel: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: + description: Configuration that applies to all conversations. + properties: + agentId: + type: string + description: >- + Optional. An opaque, user-specified string representing a human + agent who handled all conversations in the import. Note that this + will be overridden if per-conversation metadata is provided through + the `metadata_bucket_uri`. + customerChannel: + format: int32 + description: >- + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + type: integer + agentChannel: + format: int32 + description: >- + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + type: integer type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig + GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: properties: - updateTime: - format: google-datetime - readOnly: true + confidenceScore: description: >- - Output only. The most recent time at which the issue model was - updated. - type: string - languageCode: - type: string - description: Language of the model. - name: + The system's confidence score that this suggestion is a good match + for this conversation, ranging from 0.0 (completely uncertain) to + 1.0 (completely certain). + type: number + format: double + queryRecord: type: string description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - inputDataConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - description: Configs for the input data that used to create the issue model. - trainingStats: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + suggestion: + description: The content of the suggestion. + type: string + metadata: description: >- - Output only. Immutable. The issue model's label statistics on its - training data. - readOnly: true - issueCount: + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. + type: object + additionalProperties: + type: string + type: object + description: Agent Assist Smart Compose suggestion data. + id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + properties: + parent: type: string - format: int64 - description: Output only. Number of issues in this issue model. - readOnly: true - modelType: + description: Required. The parent resource to export data from. + kmsKey: + description: >- + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} type: string + writeDisposition: + description: Options for what to do if the destination table already exists. enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 - description: Type of the model. - displayName: - type: string - description: The representative name for the issue model. - state: + - Write disposition is not specified. Defaults to WRITE_TRUNCATE. + - >- + If the table already exists, BigQuery will overwrite the table + data and use the schema from the load. + - >- + If the table already exists, BigQuery will append data to the + table. enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING - readOnly: true + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND type: string - enumDescriptions: - - Unspecified. - - Model is not deployed but is ready to deploy. - - Model is being deployed. - - >- - Model is deployed and is ready to be used. A model can only be - used in analysis if it's in this state. - - Model is being undeployed. - - Model is being deleted. - description: Output only. State of the model. - createTime: - readOnly: true - format: google-datetime - description: Output only. The time at which this issue model was created. + bigQueryDestination: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination + description: Specified if sink is a BigQuery table. + filter: type: string - id: GoogleCloudContactcenterinsightsV1alpha1IssueModel - description: The issue model resource. - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: + description: >- + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. type: object - description: The request to create an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + description: The request to export insights. + GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: + type: object + id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + description: Configuration for summarization. properties: - parent: + summarizationModel: type: string - description: Required. The parent resource of the issue model. - issueModel: + enum: + - SUMMARIZATION_MODEL_UNSPECIFIED + - BASELINE_MODEL + - BASELINE_MODEL_V2_0 + enumDescriptions: + - Unspecified summarization model. + - The CCAI baseline model. + - The CCAI baseline model, V2.0. + description: Default summarization model to be used. + conversationProfile: + description: >- + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + type: string + GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: + properties: + exactMatchConfig: + description: The configuration for the exact match rule. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel - description: Required. The issue model to create. - GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: + #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + description: Configuration information of a phrase match rule. type: object - properties: - issueModels: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - description: The issue models that match the request. - id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse - description: The response of listing issue models. - GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: + GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec: description: >- - Speech-to-Text configuration. Speech-to-Text settings are applied to - conversations ingested from the `UploadConversation` and - `IngestConversations` endpoints, including conversation coming from CCAI - Platform. They are not applied to conversations ingested from the - `CreateConversation` endpoint. + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + id: GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec type: object - id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig properties: - speechRecognizer: + kmsKey: description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` type: string - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse - properties: {} + name: + description: >- + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec + type: string + GoogleCloudContactcenterinsightsV1IssueAssignment: + description: Information about the issue. type: object - description: The response for a bulk delete conversations operation. - GoogleRpcStatus: - id: GoogleRpcStatus + id: GoogleCloudContactcenterinsightsV1IssueAssignment properties: - details: + displayName: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: + Immutable. Display name of the assigned issue. This field is set at + time of analyis and immutable since then. type: string + score: + type: number + format: double description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Score indicating the likelihood of the issue assignment. currently + bounded on [0,1]. + issue: + description: Resource name of the assigned issue. + type: string + GoogleCloudContactcenterinsightsV1alpha1IntentMatchData: + properties: + intentUniqueId: + type: string + description: >- + The id of the matched intent. Can be used to retrieve the + corresponding intent information. + id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + The data for an intent match. Represents an intent match for a text + segment in the conversation. A text segment can be part of a sentence, a + complete sentence, or an utterance with multiple sentences. type: object - GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: - id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse - description: The response of listing phrase matchers. + GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: type: object properties: - phraseMatchers: - description: The phrase matchers that match the request. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher - nextPageToken: + confidenceScore: + format: float + type: number 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. + The system's confidence score that this answer is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + source: + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. type: string - GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: - type: object - id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata - description: Metadata for deploying an issue model. + metadata: + description: >- + Map that contains metadata about the FAQ answer and the document + that it originates from. + type: object + additionalProperties: + type: string + answer: + type: string + description: The piece of text from the `source` knowledge base document. + queryRecord: + type: string + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + question: + type: string + description: The corresponding FAQ question. + description: Agent Assist frequently-asked-question answer data. + id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: + type: object + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata + description: Metadata for deleting an issue model. properties: + endTime: + format: google-datetime + type: string + description: Output only. The time the operation finished running. + readOnly: true request: - description: The original request for deployment. + description: The original request for deletion. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest createTime: description: Output only. The time the operation was created. - type: string readOnly: true format: google-datetime - endTime: - description: Output only. The time the operation finished running. type: string - readOnly: true - format: google-datetime GoogleCloudContactcenterinsightsV1RuntimeAnnotation: - description: >- - An annotation that was generated during the customer and agent - interaction. - type: object - id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation properties: - smartReply: - description: Agent Assist Smart Reply data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData - userInput: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput - description: Explicit input used for generating the answer - createTime: - type: string - format: google-datetime - description: The time at which this annotation was created. - conversationSummarizationSuggestion: - description: Conversation summarization suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - answerFeedback: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback - description: The feedback that the customer has about the answer in `data`. articleSuggestion: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData description: Agent Assist Article Suggestion data. - dialogflowInteraction: + smartReply: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData - description: Dialogflow interaction data. - faqAnswer: - description: Agent Assist FAQ answer data. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData + description: Agent Assist Smart Reply data. + smartComposeSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + description: Agent Assist Smart Compose suggestion data. + endBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + description: >- + The boundary in the conversation where the annotation ends, + inclusive. annotationId: type: string description: >- The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - endBoundary: - description: >- - The boundary in the conversation where the annotation ends, - inclusive. + dialogflowInteraction: + description: Dialogflow interaction data. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - smartComposeSuggestion: + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData + createTime: + format: google-datetime + type: string + description: The time at which this annotation was created. + userInput: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer + faqAnswer: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' + description: Agent Assist FAQ answer data. startBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary description: >- The boundary in the conversation where the annotation starts, inclusive. + conversationSummarizationSuggestion: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + answerFeedback: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback + description: The feedback that the customer has about the answer in `data`. + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation + type: object + description: >- + An annotation that was generated during the customer and agent + interaction. + GoogleCloudContactcenterinsightsV1EntityMentionData: type: object + description: >- + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. + id: GoogleCloudContactcenterinsightsV1EntityMentionData properties: - gcsSource: - description: Google Cloud Storage source message. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - createNewModel: - type: boolean + type: + description: The type of the entity mention. + enumDescriptions: + - Unspecified. + - Proper noun. + - Common noun (or noun compound). + type: string + enum: + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + sentiment: + description: Sentiment expressed for this mention of the entity. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + entityUniqueId: + type: string description: >- - Optional. If set to true, will create an issue model from the - imported file with randomly generated IDs for the issue model and - corresponding issues. Otherwise, replaces an existing model with the - same ID as the file. + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. + GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + properties: parent: description: Required. The parent resource of the issue model. type: string - description: Request to import an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: + issueModel: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + description: Required. The issue model to create. + description: The request to create an issue model. + type: object + GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig properties: - agentId: + name: type: string - description: >- - Optional. An opaque, user-specified string representing a human - agent who handled all conversations in the import. Note that this - will be overridden if per-conversation metadata is provided through - the `metadata_bucket_uri`. - agentChannel: - type: integer - description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - format: int32 - customerChannel: + description: Required. The issue model to deploy. + description: The request to deploy an issue model. + id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: + description: The request to delete conversations in bulk. + type: object + properties: + maxDeleteCount: + description: Maximum number of conversations to delete. format: int32 type: integer + force: + type: boolean description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - description: Configuration that applies to all conversations. - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment - type: object - description: A segment of a full transcript. + If set to true, all of this conversation's analyses will also be + deleted. Otherwise, the request will only succeed if the + conversation has no analyses. + parent: + description: >- + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} + type: string + filter: + type: string + description: Filter used to select the subset of conversations to delete. + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata + description: The metadata for a bulk delete conversations operation. properties: - words: + createTime: + type: string + description: The time the operation was created. + format: google-datetime + partialErrors: description: >- - A list of the word-specific information for each word in the - segment. + Partial errors during bulk delete conversations operation that might + cause the operation output to be incomplete. type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + description: The original request for bulk delete. + endTime: + type: string + description: The time the operation finished running. + format: google-datetime + type: object + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: + description: Response from import issue model + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse + type: object + GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: + type: object + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + description: A message representing a rule in the phrase matcher. + properties: + phraseMatchRules: + description: A list of phrase match rules that are included in this group. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo - confidence: - type: number - description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - segment. A default value of 0.0 indicates that the value is unset. - format: float - languageCode: - description: >- - The language code of this segment as a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule + type: array + type: type: string - messageTime: - description: The time that the message occurred, if provided. + description: Required. The type of this phrase match rule group. + enum: + - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + enumDescriptions: + - Unspecified. + - Must meet all phrase match rules or there is no match. + - If any of the phrase match rules are met, there is a match. + GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: + properties: {} + description: The response to deploy an issue model. + type: object + id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse + GoogleCloudContactcenterinsightsV1DialogflowIntent: + id: GoogleCloudContactcenterinsightsV1DialogflowIntent + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. + properties: + displayName: + description: The human-readable name of the intent. type: string - format: google-datetime - dialogflowSegmentMetadata: - description: CCAI metadata relating to the current transcript segment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - channelTag: + type: object + GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: + description: >- + A point in a conversation that marks the start or the end of an + annotation. + id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + type: object + properties: + transcriptIndex: format: int32 description: >- - For conversations derived from multi-channel audio, this is the - channel number corresponding to the audio from that channel. For - audioChannelCount = N, its output values can range from '1' to 'N'. - A channel tag of 0 indicates that the audio is mono. + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. type: integer - segmentParticipant: - description: The participant of this segment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant - text: - type: string - description: The text of this segment. - sentiment: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: The sentiment for this transcript segment. - GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: + wordIndex: + description: >- + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1Conversation: properties: - endTime: + ttl: + type: string + format: google-duration + description: >- + Input only. The TTL for this resource. If specified, then this TTL + will be used to calculate the expire time. + startTime: format: google-datetime type: string + description: The time at which the conversation started. + turnCount: readOnly: true - description: Output only. The time the operation finished running. - request: - description: Output only. The original request for ingest. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest - readOnly: true - ingestConversationsStats: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats - description: Output only. Statistics for IngestConversations operation. + type: integer + format: int32 + description: Output only. The number of turns in the conversation. createTime: - description: Output only. The time the operation was created. + description: Output only. The time at which the conversation was created. type: string readOnly: true format: google-datetime - partialErrors: - type: array + callMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata + description: Call-specific metadata. + duration: + format: google-duration + description: Output only. The duration of the conversation. readOnly: true - description: >- - Output only. Partial errors during ingest operation that might cause - the operation output to be incomplete. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: object - id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata - description: The metadata for an IngestConversations operation. - GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: - type: object - description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. - properties: - type: - enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON - description: The type of the entity mention. - enumDescriptions: - - Unspecified. - - Proper noun. - - Common noun (or noun compound). type: string - sentiment: + obfuscatedUserId: + description: Obfuscated user ID which the customer sent to us. + type: string + qualityMetadata: + description: Conversation metadata related to quality management. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Sentiment expressed for this mention of the entity. - entityUniqueId: + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + latestAnalysis: + description: Output only. The conversation's latest analysis, if one exists. + readOnly: true + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + agentId: + type: string description: >- - The key of this entity in conversation entities. Can be used to - retrieve the exact `Entity` this mention is attached to. + An opaque, user-specified string representing the human agent who + handled the conversation. + dialogflowIntents: + readOnly: true + description: >- + Output only. All the matched Dialogflow intents in the call. The key + corresponds to a Dialogflow intent, format: + projects/{project}/agent/{agent}/intents/{intent} + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent + type: object + expireTime: + description: >- + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. type: string - id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData - GoogleCloudContactcenterinsightsV1AnalysisResult: - id: GoogleCloudContactcenterinsightsV1AnalysisResult - description: The result of an analysis. - properties: - endTime: format: google-datetime - description: The time at which the analysis ended. - type: string - callAnalysisMetadata: + latestSummary: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata - description: Call-specific metadata created by the analysis. - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: - properties: - smartReplyAllowlistCovered: + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + description: Output only. Latest summary of the conversation. + readOnly: true + metadataJson: + type: string description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - type: boolean - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - type: object - description: Metadata from Dialogflow relating to the current transcript segment. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: - type: object - properties: + Input only. JSON Metadata encoded as a string. This field is + primarily used by Insights integrations with various telphony + systems and must be in one of Insights' supported formats. + name: + type: string + description: >- + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} medium: enumDescriptions: - Default value, if unspecified will default to PHONE_CALL. - The format for conversations that took place over the phone. - The format for conversations that took place over chat. - type: string - description: Required. The medium transcript objects represent. enum: - MEDIUM_UNSPECIFIED - PHONE_CALL - CHAT - description: Configuration for processing transcript objects. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - GoogleCloudContactcenterinsightsV1ListConversationsResponse: - description: The response of listing conversations. - id: GoogleCloudContactcenterinsightsV1ListConversationsResponse - type: object - properties: - conversations: + description: >- + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. + type: string + transcript: + readOnly: true + description: Output only. The conversation transcript. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript + dataSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource + description: The source of the audio and transcription for the conversation. + runtimeAnnotations: + description: >- + Output only. The annotations that were generated during the customer + and agent interaction. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation - description: The conversations that match the request. + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation type: array - nextPageToken: + readOnly: true + languageCode: + type: string + description: A user-specified language code for the conversation. + labels: + additionalProperties: + type: string + description: >- + A map for the user to specify any custom fields. A maximum of 20 + labels per conversation is allowed, with a maximum of 256 characters + per entry. + type: object + updateTime: + description: >- + Output only. The most recent time at which the conversation was + updated. + format: google-datetime + type: string + readOnly: true + type: object + description: The conversation resource. + id: GoogleCloudContactcenterinsightsV1Conversation + GoogleLongrunningOperation: + description: >- + This resource represents a long-running operation that is the result of + a network API call. + properties: + metadata: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + name: type: string description: >- - A token which can be sent as `page_token` to retrieve the next page. - If this field is set, it means there is another page available. If - it is not set, it means no other pages are available. - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest - properties: - force: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. type: boolean + response: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - If set to true, all of this conversation's analyses will also be - deleted. Otherwise, the request will only succeed if the - conversation has no analyses. - maxDeleteCount: - description: Maximum number of conversations to delete. - type: integer - format: int32 - filter: - type: string - description: Filter used to select the subset of conversations to delete. - parent: - type: string + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} + The error result of the operation in case of failure or + cancellation. type: object - description: The request to delete conversations in bulk. - GoogleCloudContactcenterinsightsV1SentimentData: + id: GoogleLongrunningOperation + GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + description: Dialogflow interaction data. properties: - score: - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - format: float + confidence: type: number - magnitude: - description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. format: float - type: number - description: The data for a sentiment annotation. - type: object - id: GoogleCloudContactcenterinsightsV1SentimentData - GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: - properties: - audioUri: - type: string description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - dialogflowConversation: - readOnly: true + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + dialogflowIntentId: description: >- - Output only. The name of the Dialogflow conversation that this - conversation resource is derived from. Format: - projects/{project}/locations/{location}/conversations/{conversation} + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} type: string + GoogleCloudContactcenterinsightsV1ListViewsResponse: + id: GoogleCloudContactcenterinsightsV1ListViewsResponse + description: The response of listing views. type: object - description: A Dialogflow source of conversation data. - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource - GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: properties: - createTime: + nextPageToken: type: string - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true - request: - description: The original request for undeployment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest - endTime: - format: google-datetime - readOnly: true - description: Output only. The time the operation finished running. + 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. + views: + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + type: array + description: The views that match the request. + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: + properties: + name: type: string - description: Metadata for undeploying an issue model. - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata + description: Required. The issue model to deploy. type: object - GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: + description: The request to deploy an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest + GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: type: object + id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + description: One channel of conversation-level sentiment data. properties: - issueModelResult: - description: Overall conversation-level issue modeling result. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult - silence: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence - description: Overall conversation-level silence during the call. - sentiments: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment - description: Overall conversation-level sentiment for each channel of the call. - annotations: - description: A list of call annotations that apply to this call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation - type: array - phraseMatchers: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - description: All the matched phrase matchers in the call. - type: object - entities: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' - description: All the entities in the call. - intents: - type: object - description: All the matched intents in the call. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' - description: Call-specific metadata created during analysis. - id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: - description: Aggregated statistics about an issue. + sentimentData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + description: Data specifying sentiment. + channelTag: + type: integer + format: int32 + description: The channel of the audio that the data applies to. + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: + id: >- + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination type: object properties: - displayName: - description: Display name of the issue. + dataset: + description: >- + Required. The name of the BigQuery dataset that the snapshot result + should be exported to. If this dataset does not exist, the export + call returns an INVALID_ARGUMENT error. type: string - labeledConversationsCount: - description: Number of conversations attached to the issue at this point in time. - format: int64 + table: type: string - issue: description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + The BigQuery table name to which the insights data should be + written. If this table does not exist, the export call returns an + INVALID_ARGUMENT error. + projectId: type: string - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats - GoogleCloudContactcenterinsightsV1UploadConversationRequest: - description: Request to upload a conversation. - type: object - id: GoogleCloudContactcenterinsightsV1UploadConversationRequest + description: >- + A project ID or number. If specified, then export will attempt to + write data to this project instead of the resource project. + Otherwise, the resource project will be used. + description: A BigQuery Table Reference. + GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: + id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation properties: - conversationId: + channelTag: description: >- - Optional. A unique ID for the new conversation. This ID will become - the final component of the conversation's resource name. If no ID is - specified, a server-generated ID will be used. This value should be - 4-64 characters and must match the regular expression - `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` - type: string - parent: - type: string - description: Required. The parent resource of the conversation. - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. + type: integer + format: int32 + intentMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData + description: Data specifying an intent match. + interruptionData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData + description: Data specifying an interruption. + annotationEndBoundary: description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. - redactionConfig: + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + silenceData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData + description: Data specifying silence. + phraseMatchData: + description: Data specifying a phrase match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + annotationStartBoundary: + description: >- + The boundary in the conversation where the annotation starts, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + holdData: + description: Data specifying a hold. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData + issueMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData + description: Data specifying an issue match. + sentimentData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Data specifying sentiment. + entityMentionData: + description: Data specifying an entity mention. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. - conversation: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' - description: Required. The conversation resource to create. - GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: - description: The request to deploy an issue model. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + type: object + description: A piece of metadata that applies to a window of a call. + GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData properties: - name: - description: Required. The issue model to deploy. - type: string - id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + issueAssignment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + description: Information about the issue's assignment. + description: The data for an issue match annotation. type: object - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: - description: Configuration that applies to all conversations. + GoogleCloudContactcenterinsightsV1AnnotationBoundary: + id: GoogleCloudContactcenterinsightsV1AnnotationBoundary type: object - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig + description: >- + A point in a conversation that marks the start or the end of an + annotation. properties: - agentId: + transcriptIndex: + format: int32 description: >- - Optional. An opaque, user-specified string representing a human - agent who handled all conversations in the import. Note that this - will be overridden if per-conversation metadata is provided through - the `metadata_bucket_uri`. - type: string - agentChannel: + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. + type: integer + wordIndex: format: int32 description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. type: integer - customerChannel: + GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: + properties: + agentInfo: + description: Information about agents involved in the call. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + customerSatisfactionRating: type: integer format: int32 description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. + An arbitrary integer value indicating the customer's satisfaction + rating. + menuPath: + description: >- + An arbitrary string value specifying the menu path the customer + took. + type: string + waitDuration: + type: string + format: google-duration + description: The amount of time the customer waited to connect with an agent. + description: Conversation metadata related to quality management. + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + type: object parameters: - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string - callback: - description: JSONP + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv schema: type: string + enum: + - '1' + - '2' fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - access_token: - description: OAuth access token. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: access_token + name: quotaUser schema: type: string key: @@ -4994,15 +4975,34 @@ components: name: uploadType schema: type: string - _.xgafv: - description: V1 error format. + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' + - json + - media + - proto + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string x-stackQL-resources: insightsdata: id: google.contactcenterinsights.insightsdata @@ -5017,218 +5017,146 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - phrase_matchers: - id: google.contactcenterinsights.phrase_matchers - name: phrase_matchers - title: Phrase_matchers - methods: - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.phraseMatchers - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' - conversations: - id: google.contactcenterinsights.conversations - name: conversations - title: Conversations - methods: - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - calculate_stats: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:calculateStats/get - response: - mediaType: application/json - openAPIDocKey: '200' - bulk_analyze: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post - response: - mediaType: application/json - openAPIDocKey: '200' - upload: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + views: + id: google.contactcenterinsights.views + name: views + title: Views + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.views create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.conversations - bulk_delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkDelete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get response: mediaType: application/json openAPIDocKey: '200' - ingest: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/conversations/methods/get' - - $ref: '#/components/x-stackQL-resources/conversations/methods/list' + - $ref: '#/components/x-stackQL-resources/views/methods/get' + - $ref: '#/components/x-stackQL-resources/views/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/conversations/methods/create' + - $ref: '#/components/x-stackQL-resources/views/methods/create' update: - - $ref: '#/components/x-stackQL-resources/conversations/methods/patch' + - $ref: '#/components/x-stackQL-resources/views/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' - - $ref: '#/components/x-stackQL-resources/conversations/methods/bulk_delete' - analyses: - id: google.contactcenterinsights.analyses - name: analyses - title: Analyses + - $ref: '#/components/x-stackQL-resources/views/methods/delete' + phrase_matchers: + id: google.contactcenterinsights.phrase_matchers + name: phrase_matchers + title: Phrase_matchers methods: - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.phraseMatchers + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.analyses - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/analyses/methods/get' - - $ref: '#/components/x-stackQL-resources/analyses/methods/list' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/analyses/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' - encryption_spec: - id: google.contactcenterinsights.encryption_spec - name: encryption_spec - title: Encryption_spec + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' + operations: + id: google.contactcenterinsights.operations + name: operations + title: Operations methods: - initialize: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec:initialize/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - get_encryption_spec: + objectKey: $.operations + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/encryption_spec/methods/get_encryption_spec + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] replace: [] @@ -5238,73 +5166,73 @@ components: name: issue_models title: Issue_models methods: - undeploy: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - export: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get response: mediaType: application/json openAPIDocKey: '200' - deploy: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post response: mediaType: application/json openAPIDocKey: '200' - patch: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post response: mediaType: application/json openAPIDocKey: '200' - delete: + deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' - get: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post response: mediaType: application/json openAPIDocKey: '200' - import: + calculate_issue_model_stats: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:calculateIssueModelStats/get response: mediaType: application/json openAPIDocKey: '200' - calculate_issue_model_stats: + undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:calculateIssueModelStats/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' @@ -5324,10 +5252,10 @@ components: name: issues title: Issues methods: - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -5338,10 +5266,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -5362,109 +5290,181 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/issues/methods/delete' - operations: - id: google.contactcenterinsights.operations - name: operations - title: Operations + analyses: + id: google.contactcenterinsights.analyses + name: analyses + title: Analyses methods: - cancel: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations + objectKey: $.analyses sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] + - $ref: '#/components/x-stackQL-resources/analyses/methods/get' + - $ref: '#/components/x-stackQL-resources/analyses/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/analyses/methods/create' update: [] replace: [] - delete: [] - views: - id: google.contactcenterinsights.views - name: views - title: Views - methods: delete: + - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' + conversations: + id: google.contactcenterinsights.conversations + name: conversations + title: Conversations + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/get response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_analyze: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkDelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + ingest: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post + response: + mediaType: application/json + openAPIDocKey: '200' + calculate_stats: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:calculateStats/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.conversations + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post response: mediaType: application/json openAPIDocKey: '200' - create: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/conversations/methods/get' + - $ref: '#/components/x-stackQL-resources/conversations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/conversations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/conversations/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' + - $ref: '#/components/x-stackQL-resources/conversations/methods/bulk_delete' + encryption_spec: + id: google.contactcenterinsights.encryption_spec + name: encryption_spec + title: Encryption_spec + methods: + initialize: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec:initialize/post response: mediaType: application/json openAPIDocKey: '200' - list: + get_encryption_spec: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.views sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/views/methods/get' - - $ref: '#/components/x-stackQL-resources/views/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/views/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/views/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/encryption_spec/methods/get_encryption_spec + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/views/methods/delete' + delete: [] settings: id: google.contactcenterinsights.settings name: settings title: Settings methods: - get_settings: + update_settings: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/patch response: mediaType: application/json openAPIDocKey: '200' - update_settings: + get_settings: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/get response: mediaType: application/json openAPIDocKey: '200' @@ -5479,17 +5479,17 @@ components: paths: /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: parameters: &ref_1 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' post: description: Export insights data to a destination defined in the request body. operationId: contactcenterinsights.projects.locations.insightsdata.export @@ -5522,44 +5522,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers: + /v1/projects/{projectsId}/locations/{locationsId}/views: parameters: *ref_1 - post: - description: Creates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string get: - description: Lists phrase matchers. - operationId: contactcenterinsights.projects.locations.phraseMatchers.list + description: Lists views. + operationId: contactcenterinsights.projects.locations.views.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5572,7 +5539,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse parameters: - in: path name: projectsId @@ -5584,24 +5551,23 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: - parameters: *ref_1 - delete: - description: Deletes a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.delete + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a view. + operationId: contactcenterinsights.projects.locations.views.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5613,7 +5579,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -5625,20 +5591,16 @@ paths: required: true schema: type: string - - in: path - name: phraseMatchersId - required: true - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: + parameters: *ref_1 patch: - description: Updates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.patch + description: Updates a view. + operationId: contactcenterinsights.projects.locations.views.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5650,8 +5612,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -5664,7 +5625,7 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: viewsId required: true schema: type: string @@ -5674,8 +5635,8 @@ paths: type: string format: google-fieldmask get: - description: Gets a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.get + description: Gets a view. + operationId: contactcenterinsights.projects.locations.views.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5687,8 +5648,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -5701,21 +5661,13 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: viewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: - parameters: *ref_1 - patch: - description: Updates a conversation. - operationId: contactcenterinsights.projects.locations.conversations.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + delete: + description: Deletes a view. + operationId: contactcenterinsights.projects.locations.views.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5727,8 +5679,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5741,18 +5692,21 @@ paths: schema: type: string - in: path - name: conversationsId + name: viewsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a conversation. - operationId: contactcenterinsights.projects.locations.conversations.delete + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers: + parameters: *ref_1 + post: + description: Creates a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5764,7 +5718,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -5776,18 +5731,9 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: query - name: force - schema: - type: boolean get: - description: Gets a conversation. - operationId: contactcenterinsights.projects.locations.conversations.get + description: Lists phrase matchers. + operationId: contactcenterinsights.projects.locations.phraseMatchers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5800,7 +5746,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse parameters: - in: path name: projectsId @@ -5812,59 +5758,30 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - in: query - name: view - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats: - parameters: *ref_1 - get: - description: Gets conversation statistics. - operationId: contactcenterinsights.projects.locations.conversations.calculateStats - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse - parameters: - - in: path - name: projectsId - required: true + name: pageToken schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: parameters: *ref_1 - post: - description: Analyzes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze + patch: + description: Updates a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5876,7 +5793,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -5888,20 +5806,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: - parameters: *ref_1 - post: - description: >- - Create a long-running conversation upload operation. This method differs - from `CreateConversation` by allowing audio transcription and optional - DLP redaction. - operationId: contactcenterinsights.projects.locations.conversations.upload - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + - in: path + name: phraseMatchersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5913,7 +5830,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5925,19 +5842,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations: - parameters: *ref_1 - post: - description: >- - Creates a conversation. Does not support audio transcription or DLP - redaction. Use `conversations.upload` instead. - operationId: contactcenterinsights.projects.locations.conversations.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + - in: path + name: phraseMatchersId + required: true + schema: + type: string + get: + description: Gets a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5950,7 +5862,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -5962,13 +5874,18 @@ paths: required: true schema: type: string - - in: query - name: conversationId + - in: path + name: phraseMatchersId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 get: - description: Lists conversations. - operationId: contactcenterinsights.projects.locations.conversations.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: contactcenterinsights.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5980,8 +5897,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -5993,38 +5909,27 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter - schema: - type: string - - in: query - name: view + name: pageToken schema: type: string - in: query - name: orderBy + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Deletes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkDelete - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + 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. + operationId: contactcenterinsights.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6048,19 +5953,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Imports conversations and processes them according to the user's - configuration. - operationId: contactcenterinsights.projects.locations.conversations.ingest - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + 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`. + operationId: contactcenterinsights.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6072,7 +5983,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6084,11 +5995,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: parameters: *ref_1 get: - description: Gets an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.get + description: Gets an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6101,7 +6017,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel parameters: - in: path name: projectsId @@ -6114,18 +6030,19 @@ paths: schema: type: string - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: analysesId + name: issueModelsId required: true schema: type: string - delete: - description: Deletes an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.delete + patch: + description: Updates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6137,7 +6054,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel parameters: - in: path name: projectsId @@ -6150,20 +6068,18 @@ paths: schema: type: string - in: path - name: conversationsId + name: issueModelsId required: true schema: type: string - - in: path - name: analysesId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: - parameters: *ref_1 - get: - description: Lists analyses. - operationId: contactcenterinsights.projects.locations.conversations.analyses.list + format: google-fieldmask + delete: + description: Deletes an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6175,8 +6091,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6189,33 +6104,48 @@ paths: schema: type: string - in: path - name: conversationsId + name: issueModelsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + /v1/projects/{projectsId}/locations/{locationsId}/issueModels: + parameters: *ref_1 + get: + description: Lists issue models. + operationId: contactcenterinsights.projects.locations.issueModels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string post: - description: >- - Creates an analysis. The long running operation is done when the - analysis has completed. - operationId: contactcenterinsights.projects.locations.conversations.analyses.create + description: Creates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6239,27 +6169,17 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize: - parameters: *ref_1 - post: - description: >- - Initializes a location-level encryption key specification. An error will - be thrown if the location has resources already created before the - initialization. Once the encryption specification is initialized at a - location, it is immutable and all newly created resources under the - location will be encrypted with the existing specification. - operationId: contactcenterinsights.projects.locations.encryptionSpec.initialize + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: + parameters: *ref_1 + post: + description: Exports an issue model to the provided destination. + operationId: contactcenterinsights.projects.locations.issueModels.export requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6283,19 +6203,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: parameters: *ref_1 post: description: >- - Undeploys an issue model. An issue model can not be used in analysis - after it has been undeployed. - operationId: contactcenterinsights.projects.locations.issueModels.undeploy + Deploys an issue model. Returns an error if a model is already deployed. + An issue model can only be used in analysis after it has been deployed. + operationId: contactcenterinsights.projects.locations.issueModels.deploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6324,17 +6249,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: parameters: *ref_1 post: - description: Creates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.create + description: Imports an issue model from a Cloud Storage bucket. + operationId: contactcenterinsights.projects.locations.issueModels.import requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6358,9 +6283,12 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: + parameters: *ref_1 get: - description: Lists issue models. - operationId: contactcenterinsights.projects.locations.issueModels.list + description: Gets an issue model's statistics. + operationId: >- + contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6373,7 +6301,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse parameters: - in: path name: projectsId @@ -6385,17 +6313,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: parameters: *ref_1 post: - description: Exports an issue model to the provided destination. - operationId: contactcenterinsights.projects.locations.issueModels.export + description: >- + Undeploys an issue model. An issue model can not be used in analysis + after it has been undeployed. + operationId: contactcenterinsights.projects.locations.issueModels.undeploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6424,19 +6359,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: parameters: *ref_1 - post: - description: >- - Deploys an issue model. Returns an error if a model is already deployed. - An issue model can only be used in analysis after it has been deployed. - operationId: contactcenterinsights.projects.locations.issueModels.deploy - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + delete: + description: Deletes an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6448,7 +6375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6465,17 +6392,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: - parameters: *ref_1 - patch: - description: Updates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + - in: path + name: issuesId + required: true + schema: + type: string + get: + description: Gets an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6487,8 +6411,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' parameters: - in: path name: projectsId @@ -6505,14 +6428,19 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: issuesId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.delete + patch: + description: Updates an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6524,7 +6452,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' parameters: - in: path name: projectsId @@ -6541,9 +6469,21 @@ paths: required: true schema: type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: + parameters: *ref_1 get: - description: Gets an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.get + description: Lists issues. + operationId: contactcenterinsights.projects.locations.issueModels.issues.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6556,7 +6496,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse parameters: - in: path name: projectsId @@ -6573,17 +6513,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: parameters: *ref_1 - post: - description: Imports an issue model from a Cloud Storage bucket. - operationId: contactcenterinsights.projects.locations.issueModels.import - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + delete: + description: Deletes an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6595,7 +6529,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6607,12 +6541,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: - parameters: *ref_1 + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: analysesId + required: true + schema: + type: string get: - description: Gets an issue model's statistics. - operationId: >- - contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats + description: Gets an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6625,7 +6566,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis parameters: - in: path name: projectsId @@ -6638,20 +6579,27 @@ paths: schema: type: string - in: path - name: issueModelsId + name: conversationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: + - in: path + name: analysesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: parameters: *ref_1 - patch: - description: Updates an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.patch + post: + description: >- + Creates an analysis. The long running operation is done when the + analysis has completed. + operationId: contactcenterinsights.projects.locations.conversations.analyses.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6663,7 +6611,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6676,23 +6624,60 @@ paths: schema: type: string - in: path - name: issueModelsId + name: conversationsId + required: true + schema: + type: string + get: + description: Lists analyses. + operationId: contactcenterinsights.projects.locations.conversations.analyses.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: issuesId + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId required: true schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: + parameters: *ref_1 get: - description: Gets an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.get + description: Gets a conversation. + operationId: contactcenterinsights.projects.locations.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6704,7 +6689,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -6717,18 +6703,23 @@ paths: schema: type: string - in: path - name: issueModelsId + name: conversationsId required: true schema: type: string - - in: path - name: issuesId - required: true + - in: query + name: view schema: type: string - delete: - description: Deletes an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.delete + patch: + description: Updates a conversation. + operationId: contactcenterinsights.projects.locations.conversations.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6740,7 +6731,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -6753,20 +6745,18 @@ paths: schema: type: string - in: path - name: issueModelsId + name: conversationsId required: true schema: type: string - - in: path - name: issuesId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: - parameters: *ref_1 - get: - description: Lists issues. - operationId: contactcenterinsights.projects.locations.issueModels.issues.list + format: google-fieldmask + delete: + description: Deletes a conversation. + operationId: contactcenterinsights.projects.locations.conversations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6778,8 +6768,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6792,24 +6781,28 @@ paths: schema: type: string - in: path - name: issueModelsId + name: conversationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: parameters: *ref_1 post: 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`. - operationId: contactcenterinsights.projects.locations.operations.cancel + Create a long-running conversation upload operation. This method differs + from `CreateConversation` by allowing audio transcription and optional + DLP redaction. + operationId: contactcenterinsights.projects.locations.conversations.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6821,7 +6814,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6833,19 +6826,17 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: parameters: *ref_1 - 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. - operationId: contactcenterinsights.projects.locations.operations.get + post: + description: Analyzes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6869,18 +6860,17 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: contactcenterinsights.projects.locations.operations.list + post: + description: Deletes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6892,7 +6882,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6904,24 +6894,19 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: + /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: parameters: *ref_1 - delete: - description: Deletes a view. - operationId: contactcenterinsights.projects.locations.views.delete + post: + description: >- + Imports conversations and processes them according to the user's + configuration. + operationId: contactcenterinsights.projects.locations.conversations.ingest + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6933,7 +6918,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6945,19 +6930,11 @@ paths: required: true schema: type: string - - in: path - name: viewsId - required: true - schema: - type: string - patch: - description: Updates a view. - operationId: contactcenterinsights.projects.locations.views.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + /v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats: + parameters: *ref_1 + get: + description: Gets conversation statistics. + operationId: contactcenterinsights.projects.locations.conversations.calculateStats security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6969,7 +6946,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse parameters: - in: path name: projectsId @@ -6981,19 +6959,15 @@ paths: required: true schema: type: string - - in: path - name: viewsId - required: true - schema: - type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/conversations: + parameters: *ref_1 get: - description: Gets a view. - operationId: contactcenterinsights.projects.locations.views.get + description: Lists conversations. + operationId: contactcenterinsights.projects.locations.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7005,7 +6979,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse parameters: - in: path name: projectsId @@ -7017,21 +6992,38 @@ paths: required: true schema: type: string - - in: path - name: viewsId - required: true + - in: query + name: orderBy + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/views: - parameters: *ref_1 post: - description: Creates a view. - operationId: contactcenterinsights.projects.locations.views.create + description: >- + Creates a conversation. Does not support audio transcription or DLP + redaction. Use `conversations.upload` instead. + operationId: contactcenterinsights.projects.locations.conversations.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7043,7 +7035,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -7055,9 +7048,26 @@ paths: required: true schema: type: string - get: - description: Lists views. - operationId: contactcenterinsights.projects.locations.views.list + - in: query + name: conversationId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize: + parameters: *ref_1 + post: + description: >- + Initializes a location-level encryption key specification. An error will + be thrown if the location has resources already created before the + initialization. Once the encryption specification is initialized at a + location, it is immutable and all newly created resources under the + location will be encrypted with the existing specification. + operationId: contactcenterinsights.projects.locations.encryptionSpec.initialize + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7069,8 +7079,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -7082,20 +7091,11 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/settings: + /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec: parameters: *ref_1 get: - description: Gets project-level settings. - operationId: contactcenterinsights.projects.locations.getSettings + description: Gets location-level encryption key specification. + operationId: contactcenterinsights.projects.locations.getEncryptionSpec security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7108,7 +7108,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Settings + #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec parameters: - in: path name: projectsId @@ -7120,6 +7120,8 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/settings: + parameters: *ref_1 patch: description: Updates project-level settings. operationId: contactcenterinsights.projects.locations.updateSettings @@ -7157,11 +7159,9 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec: - parameters: *ref_1 get: - description: Gets location-level encryption key specification. - operationId: contactcenterinsights.projects.locations.getEncryptionSpec + description: Gets project-level settings. + operationId: contactcenterinsights.projects.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7174,7 +7174,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + #/components/schemas/GoogleCloudContactcenterinsightsV1Settings parameters: - in: path name: projectsId diff --git a/providers/src/googleapis.com/v00.00.00000/services/container.yaml b/providers/src/googleapis.com/v00.00.00000/services/container.yaml index af456040..96a9aaf6 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/container.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/container.yaml @@ -10,7 +10,7 @@ info: Kubernetes technology. version: v1 x-discovery-doc-revision: '20240814' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/kubernetes-engine/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml index 02ea576e..dcd54f8f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml @@ -12,8 +12,8 @@ info: is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts. version: v1 - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/container-analysis/api/reference/rest/ servers: @@ -39,759 +39,950 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SetIamPolicyRequest: - id: SetIamPolicyRequest - type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact properties: - policy: - $ref: '#/components/schemas/Policy' + version: description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - description: Request message for `SetIamPolicy` method. - Envelope: - id: Envelope + Maven `version` value used when uploading the artifact to Artifact + Registry. + type: string + groupId: + type: string + description: >- + Maven `groupId` value used when uploading the artifact to Artifact + Registry. + artifactId: + description: >- + Maven `artifactId` value used when uploading the artifact to + Artifact Registry. + type: string + repository: + type: string + description: >- + Artifact Registry repository, in the form + "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the + workspace specified by path will be uploaded to Artifact Registry + with this location as a prefix. + path: + description: >- + Path to an artifact in the build's workspace to be uploaded to + Artifact Registry. This can be either an absolute path, e.g. + /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path + from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + type: string + type: object + description: >- + A Maven artifact to upload to Artifact Registry upon successful + completion of all build steps. + GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: type: object + id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder properties: - signatures: - type: array - items: - $ref: '#/components/schemas/EnvelopeSignature' - payload: - format: byte - type: string - payloadType: + id: type: string description: >- - MUST match - https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. - An authenticated message of arbitrary type. - GetPolicyOptions: - description: Encapsulates settings provided to GetIamPolicy. + Identifies the entity that executed the recipe, which is trusted to have + correctly performed the operation and populated this provenance. + ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: + type: object + description: >- + Location of the source in a 2nd-gen Google Cloud Build repository + resource. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository properties: - requestedPolicyVersion: - format: int32 - type: integer + revision: 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). - id: GetPolicyOptions + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. + type: string + dir: + description: >- + Optional. Directory, relative to the source root, in which to run + the build. + type: string + repository: + description: >- + Required. Name of the Google Cloud Build repository, formatted as + `projects/*/locations/*/connections/*/repositories/*`. + type: string + NonCompliantFile: + properties: + reason: + type: string + description: Explains why a file is non compliant for a CIS check. + displayCommand: + description: Command to display the non-compliant files. + type: string + path: + type: string + description: Empty if `display_command` is set. + id: NonCompliantFile type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage + description: >- + Details about files that caused a compliance check to fail. + display_command is a single command that can be used to display a list + of non compliant files. When there is no such command, we can also + iterate a list of non compliant file using 'path'. + ImageNote: type: object + id: ImageNote description: >- - Npm package to upload to Artifact Registry upon successful completion of - all build steps. + Basis describes the base image portion (Note) of the DockerImage + relationship. Linked occurrences are derived from this or an equivalent + image via: FROM Or an equivalent reference, e.g., a tag of the + resource_url. properties: - repository: + fingerprint: + $ref: '#/components/schemas/Fingerprint' + description: Required. Immutable. The fingerprint of the base image. + resourceUrl: type: string description: >- - Artifact Registry repository, in the form - "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in - the workspace specified by path will be zipped and uploaded to - Artifact Registry with this location as a prefix. - packagePath: - description: Path to the package.json. e.g. workspace/path/to/package - type: string - InTotoSlsaProvenanceV1: - id: InTotoSlsaProvenanceV1 + Required. Immutable. The resource_url for the resource representing + the basis of associated occurrence images. + GrafeasV1FileLocation: type: object + id: GrafeasV1FileLocation + description: Indicates the location at which a package was found. properties: - _type: + filePath: type: string description: >- - InToto spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement - predicate: - $ref: '#/components/schemas/SlsaProvenanceV1' - predicateType: + For jars that are contained inside .war files, this filepath can + indicate the path to war file combined with the path to jar file. + BuildDefinition: + properties: + externalParameters: + additionalProperties: + description: Properties of the object. + type: any + type: object + buildType: type: string + internalParameters: + additionalProperties: + description: Properties of the object. + type: any + type: object + resolvedDependencies: + type: array + items: + $ref: '#/components/schemas/ResourceDescriptor' + id: BuildDefinition + type: object + SbomReferenceIntotoPayload: + properties: + predicate: + description: >- + Additional parameters of the Predicate. Includes the actual data + about the SBOM. + $ref: '#/components/schemas/SbomReferenceIntotoPredicate' subject: + description: >- + Set of software artifacts that the attestation applies to. Each + element represents a single software artifact. items: $ref: '#/components/schemas/Subject' type: array - DeploymentNote: + predicateType: + description: URI identifying the type of the Predicate. + type: string + _type: + description: Identifier for the schema of the Statement. + type: string + description: >- + The actual payload that contains the SBOM Reference data. The payload + follows the intoto statement specification. See + https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md + for more details. + type: object + id: SbomReferenceIntotoPayload + Fingerprint: properties: - resourceUri: + v1Name: + description: >- + Required. The layer ID of the final layer in the Docker image's v1 + representation. + type: string + v2Blob: type: array - description: Required. Resource URI for the artifact being deployed. items: type: string + description: Required. The ordered list of v2 blobs that represent a given image. + v2Name: + description: >- + Output only. The name of the image's v2 blobs computed via: [bottom] + := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the + name of the final blob is kept. + type: string + description: A set of properties that uniquely identify a given Docker image. + id: Fingerprint type: object - id: DeploymentNote - description: An artifact that can be deployed in some runtime. - TestIamPermissionsRequest: + Empty: + type: object + id: 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); } + properties: {} + BatchCreateNotesResponse: + id: BatchCreateNotesResponse properties: - permissions: - type: array - 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). + notes: + description: The notes that were created. items: - type: string - description: Request message for `TestIamPermissions` method. - type: object - id: TestIamPermissionsRequest - SBOMStatus: - id: SBOMStatus + $ref: '#/components/schemas/Note' + type: array type: object + description: Response for creating notes in batch. + SlsaProvenanceZeroTwo: + id: SlsaProvenanceZeroTwo + description: See full explanation of fields at slsa.dev/provenance/v0.2. properties: - error: - type: string - description: >- - If there was an error generating an SBOM, this will indicate what - that error was. - sbomState: - description: The progress of the SBOM generation. + invocation: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' + materials: + items: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' + type: array + builder: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' + buildType: + type: string + metadata: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' + buildConfig: + additionalProperties: + type: any + description: Properties of the object. + type: object + type: object + DiscoveryOccurrence: + description: Provides information about the analysis status of a discovered resource. + properties: + lastScanTime: + type: string + description: The last time this resource was scanned. + format: google-datetime + analysisCompleted: + $ref: '#/components/schemas/AnalysisCompleted' + archiveTime: + readOnly: true + format: google-datetime + description: >- + Output only. The time occurrences related to this discovery + occurrence were archived. + type: string + sbomStatus: + $ref: '#/components/schemas/SBOMStatus' + description: The status of an SBOM generation. + analysisStatusError: + description: >- + When an error is encountered this will contain a LocalizedMessage + under details to show to the user. The LocalizedMessage is output + only and populated by the API. + $ref: '#/components/schemas/Status' + continuousAnalysis: + description: Whether the resource is continuously analyzed. type: string + enum: + - CONTINUOUS_ANALYSIS_UNSPECIFIED + - ACTIVE + - INACTIVE enumDescriptions: - - Default unknown state. - - SBOM scanning is pending. - - SBOM scanning has completed. + - Unknown. + - The resource is continuously analyzed. + - The resource is ignored for continuous analysis. + cpe: + type: string + description: The CPE of the resource being scanned. + analysisStatus: + description: The status of discovery for the resource. enum: - - SBOM_STATE_UNSPECIFIED + - ANALYSIS_STATUS_UNSPECIFIED - PENDING + - SCANNING + - FINISHED_SUCCESS - COMPLETE - description: The status of an SBOM generation. - VexAssessment: - properties: - state: - description: Provides the state of this Vulnerability assessment. - enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION + - FINISHED_FAILED + - FINISHED_UNSUPPORTED + type: string enumDescriptions: - - No state is specified. - - This product is known to be affected by this vulnerability. - - This product is known to be not affected by this vulnerability. - - This product contains a fix for this vulnerability. + - Unknown. + - Resource is known but no action has been taken yet. + - Resource is being analyzed. + - Analysis has finished successfully. + - Analysis has completed. - >- - It is not known yet whether these versions are or are not affected - by the vulnerability. However, it is still under investigation. - type: string - cve: - type: string - description: >- - Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) - tracking number for the vulnerability. Deprecated: Use - vulnerability_id instead to denote CVEs. - deprecated: true - relatedUris: - type: array - description: >- - Holds a list of references associated with this vulnerability item - and assessment. + Analysis has finished unsuccessfully, the analysis itself is in a + bad state. + - The resource is known not to be supported. + analysisError: items: - $ref: '#/components/schemas/RelatedUrl' - justification: + $ref: '#/components/schemas/Status' description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - $ref: '#/components/schemas/Justification' - impacts: + Indicates any errors encountered during analysis of a resource. + There could be 0 or more of these errors. type: array + type: object + id: DiscoveryOccurrence + ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + type: object + properties: + gitRepositoryLink: + type: string description: >- - Contains information about the impact of this vulnerability, this - will change with time. - items: - type: string - remediations: - items: - $ref: '#/components/schemas/Remediation' - type: array + Required. The Developer Connect Git repository link, formatted as + `projects/*/locations/*/connections/*/gitRepositoryLink/*`. + dir: + type: string description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - noteName: + Required. Directory, relative to the source root, in which to run + the build. + revision: description: >- - The VulnerabilityAssessment note from which this VexAssessment was - generated. This will be of the form: - `projects/[PROJECT_ID]/notes/[NOTE_ID]`. + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. type: string - vulnerabilityId: + description: This config defines the location of a source through Developer Connect. + GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: + type: object + description: >- + Metadata for all operations used and required for all operations that + created by Container Analysis Providers + properties: + endTime: description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. + Output only. The time that this operation was marked completed or + failed. type: string + format: google-datetime + createTime: + description: Output only. The time this operation was created. + format: google-datetime + type: string + id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata + ListNotesResponse: + description: Response for listing notes. type: object - description: >- - VexAssessment provides all publisher provided Vex information that is - related to this vulnerability. - id: VexAssessment - PackageIssue: + id: ListNotesResponse properties: - fixedVersion: + notes: + items: + $ref: '#/components/schemas/Note' + type: array + description: The notes requested. + nextPageToken: description: >- - Required. The version of the package this vulnerability was fixed - in. Setting this to VersionKind.MAXIMUM means no fix is yet - available. - $ref: '#/components/schemas/Version' - fileLocation: + The next pagination token in the list response. It should be used as + `page_token` for the following request. An empty value means no more + results. + type: string + PackageNote: + type: object + description: PackageNote represents a particular package version. + properties: + packageType: + type: string + description: >- + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + distribution: + items: + $ref: '#/components/schemas/Distribution' + description: Deprecated. The various channels by which a package is distributed. type: array + digest: + description: >- + Hash value, typically a file digest, that allows unique + identification a specific package. items: - $ref: '#/components/schemas/GrafeasV1FileLocation' - description: The location at which this package was found. - fixedCpeUri: + $ref: '#/components/schemas/Digest' + type: array + architecture: type: string description: >- - The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was fixed in. It is possible for this to be different - from the affected_cpe_uri. - fixAvailable: - description: Output only. Whether a fix is available for this package. - type: boolean - effectiveSeverity: + The CPU architecture for which packages in this distribution channel + were built. Architecture will be blank for language packages. enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - readOnly: true + - Unknown architecture. + - X86 architecture. + - X64 architecture. + name: type: string + description: Required. Immutable. The name of the package. + license: + $ref: '#/components/schemas/License' + description: Licenses that have been declared by the authors of the package. + cpeUri: description: >- - Output only. The distro or language system assigned severity for - this vulnerability when that is available and note provider assigned - severity when it is not available. - fixedPackage: + The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) + denoting the package manager version distributing a package. The + cpe_uri will be blank for language packages. type: string - description: >- - The package this vulnerability was fixed in. It is possible for this - to be different from the affected_package. - affectedCpeUri: - description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was found in. - type: string - packageType: + description: + description: The description of this package. type: string - description: The type of package (e.g. OS, MAVEN, GO). - affectedVersion: - $ref: '#/components/schemas/Version' - description: >- - Required. The version of the package that is installed on the - resource affected by this vulnerability. - affectedPackage: + url: type: string - description: Required. The package this vulnerability was found in. - id: PackageIssue - description: >- - A detail for a distro and package this vulnerability occurrence was - found in and its associated fix (if one is available). - type: object - UpgradeNote: - properties: - windowsUpdate: - description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - $ref: '#/components/schemas/WindowsUpdate' - package: + description: The homepage for this package. + maintainer: + description: A freeform text denoting the maintainer of this package. type: string - description: Required for non-Windows OS. The package this Upgrade is for. - distributions: - items: - $ref: '#/components/schemas/UpgradeDistribution' - type: array - description: Metadata about the upgrade for each specific operating system. version: - description: >- - Required for non-Windows OS. The version of the package in machine + - human readable form. $ref: '#/components/schemas/Version' + description: The version of the package. + id: PackageNote + Recipe: + id: Recipe type: object - id: UpgradeNote description: >- - An Upgrade Note represents a potential upgrade of a package to a given - version. For each package version combination (i.e. bash 4.0, bash 4.1, - bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update - field represents the information related to the update. - Material: - type: object + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. properties: - uri: + definedInMaterial: type: string - digest: - additionalProperties: - type: string - type: object - id: Material - Assessment: - type: object - properties: - impacts: - type: array - items: - type: string description: >- - Contains information about the impact of this vulnerability, this - will change with time. - relatedUris: + Index in materials containing the recipe steps that are not implied + by recipe.type. For example, if the recipe type were "make", then + this would point to the source containing the Makefile, not the make + program itself. Set to -1 if the recipe doesn't come from a + material, as zero is default unset value for int64. + format: int64 + environment: items: - $ref: '#/components/schemas/RelatedUrl' + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object type: array description: >- - Holds a list of references associated with this vulnerability item - and assessment. These uris have additional information about the - vulnerability and the assessment itself. E.g. Link to a document - which details how this assessment concluded the state of this - vulnerability. - longDescription: - type: string - description: A detailed description of this Vex. - cve: - deprecated: true + Any other builder-controlled inputs necessary for correctly + evaluating the recipe. Usually only needed for reproducing the build + but not evaluated as part of policy. Since the environment field can + greatly vary in structure, depending on the builder and recipe type, + this is of form "Any". + type: + description: >- + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. type: string + arguments: description: >- - Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) - tracking number for the vulnerability. Deprecated: Use - vulnerability_id instead to denote CVEs. - state: + Collection of all external inputs that influenced the build on top + of recipe.definedInMaterial and recipe.entryPoint. For example, if + the recipe type were "make", then this might be the flags passed to + make aside from the target, which is captured in recipe.entryPoint. + Since the arguments field can greatly vary in structure, depending + on the builder and recipe type, this is of form "Any". + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array + entryPoint: + description: >- + String identifying the entry point into the build. This is often a + path to a configuration file and/or a target label within that file. + The syntax and meaning are defined by recipe.type. For example, if + the recipe type were "make", then this would reference the directory + in which to run make as well as which target to use. type: string - enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION - enumDescriptions: - - No state is specified. - - This product is known to be affected by this vulnerability. - - This product is known to be not affected by this vulnerability. - - This product contains a fix for this vulnerability. - - >- - It is not known yet whether these versions are or are not affected - by the vulnerability. However, it is still under investigation. - description: Provides the state of this Vulnerability assessment. - shortDescription: - description: A one sentence description of this Vex. + ComplianceVersion: + description: >- + Describes the CIS benchmark version that is applicable to a given OS and + os version. + id: ComplianceVersion + properties: + benchmarkDocument: type: string - remediations: description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - type: array - items: - $ref: '#/components/schemas/Remediation' - justification: + The name of the document that defines this benchmark, e.g. "CIS + Container-Optimized OS". + version: description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - $ref: '#/components/schemas/Justification' - vulnerabilityId: + The version of the benchmark. This is set to the version of the + OS-specific CIS document the benchmark is defined in. + type: string + cpeUri: description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. + The CPE URI (https://cpe.mitre.org/specification/) this benchmark is + applicable to. type: string - id: Assessment + type: object + Volume: + type: object + properties: + path: + description: >- + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. + type: string + name: + type: string + description: >- + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. description: >- - Assessment provides all information that is related to a single - vulnerability for this product. - AnalysisCompleted: + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. Next ID: 3 + id: Volume + SBOMStatus: + type: object + properties: + sbomState: + enumDescriptions: + - Default unknown state. + - SBOM scanning is pending. + - SBOM scanning has completed. + enum: + - SBOM_STATE_UNSPECIFIED + - PENDING + - COMPLETE + description: The progress of the SBOM generation. + type: string + error: + type: string + description: >- + If there was an error generating an SBOM, this will indicate what + that error was. + id: SBOMStatus + description: The status of an SBOM generation. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption description: >- - Indicates which analysis completed successfully. Multiple types of - analysis can be performed on a single resource. + Details about how a build should be executed on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. properties: - analysisType: - items: - type: string - type: array + name: + description: >- + The `WorkerPool` resource to execute the build on. You must have + `cloudbuild.workerpools.use` on the project hosting the WorkerPool. + Format + projects/{project}/locations/{location}/workerPools/{workerPoolId} + type: string type: object - id: AnalysisCompleted - Signature: + UpgradeDistribution: type: object - id: Signature + id: UpgradeDistribution properties: - signature: + cpeUri: type: string description: >- - The content of the signature, an opaque bytestring. The payload that - this signature verifies MUST be unambiguously provided with the - Signature during verification. A wrapper message might provide the - payload explicitly. Alternatively, a message might have a canonical - serialization that can always be unambiguously computed to derive - the payload. - format: byte - publicKeyId: - description: >- - The identifier for the public key that verifies this signature. * - The `public_key_id` is required. * The `public_key_id` SHOULD be an - RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD - be an immutable reference, such as a cryptographic digest. Examples - of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * - "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See - https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for - more details on this scheme. RFC6920 digest-named - SubjectPublicKeyInfo (digest of the DER serialization): * - "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * - "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" - type: string - description: >- - Verifiers (e.g. Kritis implementations) MUST verify signatures with - respect to the trust anchors defined in policy (e.g. a Kritis policy). - Typically this means that the verifier has been configured with a map - from `public_key_id` to public key material (and any required - parameters, e.g. signing algorithm). In particular, verification - implementations MUST NOT treat the signature `public_key_id` as anything - more than a key lookup hint. The `public_key_id` DOES NOT validate or - authenticate a public key; it only provides a mechanism for quickly - selecting a public key ALREADY CONFIGURED on the verifier through a - trusted channel. Verification implementations MUST reject signatures in - any of the following circumstances: * The `public_key_id` is not - recognized by the verifier. * The public key that `public_key_id` refers - to does not verify the signature with respect to the payload. The - `signature` contents SHOULD NOT be "attached" (where the payload is - included with the serialized `signature` bytes). Verifiers MUST ignore - any "attached" payload and only verify signatures with respect to - explicitly provided payload (e.g. a `payload` field on the proto message - that holds this Signature, or the canonical serialization of the proto - message that holds this signature). - Expr: - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - type: object - properties: - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. + Required - The specific operating system this metadata applies to. + See https://cpe.mitre.org/specification/. + severity: type: string - description: + description: The severity as specified by the upstream operating system. + cve: + items: + type: string + type: array + description: The cve tied to this Upgrade. + classification: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string - location: + The operating system classification of this Upgrade, as specified by + the upstream operating system upgrade feed. For Windows the + classification is one of the category_ids listed at + https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - id: Expr - Product: - type: object - id: Product description: >- - Product contains information about a product and how to uniquely - identify it. + The Upgrade Distribution represents metadata about the Upgrade for each + operating system (CPE). Some distributions have additional metadata + around updates, classifying them into various categories and severities. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + description: Optional arguments to enable specific features of builds. properties: - genericUri: + secretEnv: + type: array description: >- - Contains a URI which is vendor-specific. Example: The artifact - repository URL of an image. - type: string - id: + A list of global environment variables, which are encrypted using a + Cloud Key Management Service crypto key. These values must be + specified in the build's `Secret`. These variables will be available + to all build steps in this build. + items: + type: string + substitutionOption: description: >- - Token that identifies a product so that it can be referred to from - other parts in the document. There is no predefined format as long - as it uniquely identifies a group in the context of the current - document. - type: string - name: - type: string - description: Name of the product. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: - type: object - properties: - type: + Option to specify behavior when there is an error in the + substitution checks. NOTE: this is always set to ALLOW_LOOSE for + triggered builds and cannot be overridden in the build configuration + file. enum: - - FAILURE_TYPE_UNSPECIFIED - - PUSH_FAILED - - PUSH_IMAGE_NOT_FOUND - - PUSH_NOT_AUTHORIZED - - LOGGING_FAILURE - - USER_BUILD_STEP - - FETCH_SOURCE_FAILED - description: The name of the failure. - type: string + - MUST_MATCH + - ALLOW_LOOSE enumDescriptions: - - Type unspecified - - Unable to push the image to the repository. - - Final image not found. - - Unauthorized push of the final image. - - Backend logging failures. Should retry. - - A build step has failed. - - The source fetching has failed. - detail: - type: string - description: Explains the failure issue in more detail using hard-coded text. - description: A fatal problem encountered during the execution of the build. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo - SlsaBuilder: - type: object - id: SlsaBuilder - properties: - id: + - >- + Fails the build if error in substitutions checks, like missing a + substitution in the template or in the map. + - Do not fail the build if error in substitutions checks. type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: - type: object - properties: - pushTiming: - description: >- - Output only. Stores timing information for pushing the specified - image. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - name: + automapSubstitutions: + type: boolean description: >- - Name used to push the container image to Google Container Registry, - as presented to `docker push`. + Option to include built-in and custom substitutions as env variables + for all build steps. + diskSizeGb: + format: int64 type: string - digest: - description: Docker Registry 2.0 digest. + description: >- + Requested disk size for the VM that runs the build. Note that this + is *NOT* "disk free"; some of the space will be used by the + operating system and build utilities. Also note that this is the + minimum disk size that will be allocated for the build -- the build + may run with a larger disk than requested. At present, the maximum + disk size is 4000GB; builds that request more than the maximum are + rejected with an error. + workerPool: + deprecated: true type: string - description: An image built by the pipeline. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - CVSSv3: - properties: - attackVector: + description: This field deprecated; please use `pool.name` instead. + machineType: + enumDeprecated: + - false + - true + - true + - false + - false + - false + description: Compute Engine machine type on which to run the build. enumDescriptions: - - '' - - '' - - '' - - '' - - '' + - Standard machine type. + - Highcpu machine with 8 CPUs. + - Highcpu machine with 32 CPUs. + - Highcpu e2 machine with 8 CPUs. + - Highcpu e2 machine with 32 CPUs. + - E2 machine with 1 CPU. enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL + - UNSPECIFIED + - N1_HIGHCPU_8 + - N1_HIGHCPU_32 + - E2_HIGHCPU_8 + - E2_HIGHCPU_32 + - E2_MEDIUM type: string + logging: + enumDeprecated: + - false + - false + - false + - true + - false + - false description: >- - Base Metrics Represents the intrinsic characteristics of a - vulnerability that are constant over time and across user - environments. - integrityImpact: - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - enumDescriptions: - - '' - - '' - - '' - - '' - type: string - scope: + Option to specify the logging mode, which determines if and where + build logs are stored. type: string enumDescriptions: - - '' - - '' - - '' - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED - availabilityImpact: - enumDescriptions: - - '' - - '' - - '' - - '' - type: string + - >- + The service determines the logging mode. The default is `LEGACY`. + Do not rely on the default logging behavior as it may change in + the future. + - Build logs are stored in Cloud Logging and Cloud Storage. + - Build logs are stored in Cloud Storage. + - This option is the same as CLOUD_LOGGING_ONLY. + - >- + Build logs are stored in Cloud Logging. Selecting this option will + not allow [logs + streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log). + - Turn off all logging. No build logs will be captured. enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - confidentialityImpact: - type: string + - LOGGING_UNSPECIFIED + - LEGACY + - GCS_ONLY + - STACKDRIVER_ONLY + - CLOUD_LOGGING_ONLY + - NONE + dynamicSubstitutions: + description: >- + Option to specify whether or not to apply bash style string + operations to the substitutions. NOTE: this is always enabled for + triggered builds and cannot be overridden in the build configuration + file. + type: boolean + logStreamingOption: enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE + - STREAM_DEFAULT + - STREAM_ON + - STREAM_OFF enumDescriptions: - - '' - - '' - - '' - - '' - impactScore: - type: number - format: float - attackComplexity: + - Service may automatically determine build log streaming behavior. + - Build logs should be streamed to Cloud Storage. + - >- + Build logs should not be streamed to Cloud Storage; they will be + written when the build is completed. + description: Option to define build log streaming behavior to Cloud Storage. type: string - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH - enumDescriptions: - - '' - - '' - - '' - privilegesRequired: - enumDescriptions: - - '' - - '' - - '' - - '' + env: + description: >- + A list of global environment variable definitions that will exist + for all build steps in this build. If a variable is defined in both + globally and in a build step, the variable will use the build step + value. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + type: array + items: + type: string + sourceProvenanceHash: + items: + enum: + - NONE + - SHA256 + - MD5 + - SHA512 + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Use a sha512 hash. + type: string + type: array + description: Requested hash for SourceProvenance. + requestedVerifyOption: type: string - enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH - exploitabilityScore: - format: float - type: number - baseScore: - type: number - format: float - description: The base score is a function of the base metric scores. - userInteraction: + description: Requested verifiability options. enumDescriptions: - - '' - - '' - - '' + - Not a verifiable build (the default). + - Build must be verified. enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - type: string - id: CVSSv3 - type: object - description: >- - Common Vulnerability Scoring System version 3. For details, see - https://www.first.org/cvss/specification-document - InTotoStatement: - description: >- - Spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement The - serialized InTotoStatement will be stored as Envelope.payload. - Envelope.payloadType is always "application/vnd.in-toto+json". - properties: - predicateType: - description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' + - NOT_VERIFIED + - VERIFIED + pool: + description: >- + Optional. Specification for execution on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + defaultLogsBucketBehavior: + enumDescriptions: + - Unspecified. + - >- + Bucket is located in user-owned project in the same region as the + build. The builder service account must have access to create and + write to Cloud Storage buckets in the build project. type: string - subject: + description: Optional. Option to specify how default logs buckets are setup. + enum: + - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED + - REGIONAL_USER_OWNED_BUCKET + volumes: + description: >- + Global list of volumes to mount for ALL build steps Each volume is + created as an empty volume prior to starting the build process. Upon + completion of the build, volumes and their contents are discarded. + Global volume names and paths cannot conflict with the volumes + defined a build step. Using a global volume in a build with only one + step is not valid as it is indicative of a build request with an + incorrect configuration. items: - $ref: '#/components/schemas/Subject' + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume type: array - _type: - type: string - description: Always `https://in-toto.io/Statement/v0.1`. - slsaProvenanceZeroTwo: - $ref: '#/components/schemas/SlsaProvenanceZeroTwo' - slsaProvenance: - $ref: '#/components/schemas/SlsaProvenance' - provenance: - $ref: '#/components/schemas/InTotoProvenance' type: object - id: InTotoStatement - SlsaCompleteness: - description: >- - Indicates that the builder claims certain fields in this message to be - complete. + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: + description: HttpConfig is a configuration for HTTP related git operations. type: object - id: SlsaCompleteness - properties: - arguments: - type: boolean - description: >- - If true, the builder claims that recipe.arguments is complete, - meaning that all external inputs are properly captured in the - recipe. - materials: - description: >- - If true, the builder claims that materials are complete, usually - through some controls to prevent network access. Sometimes called - "hermetic". - type: boolean - environment: - description: >- - If true, the builder claims that recipe.environment is claimed to be - complete. - type: boolean - ExportSBOMResponse: properties: - discoveryOccurrence: + proxySecretVersionName: type: string description: >- - The name of the discovery occurrence in the form - "projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to - track the progress of the SBOM export. - type: object - id: ExportSBOMResponse - description: The response from a call to ExportSBOM. - GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: + SecretVersion resource of the HTTP proxy URL. The Service Account + used in the build (either the default Service Account or + user-specified Service Account) should have + `secretmanager.versions.access` permissions on this secret. The + proxy URL should be in format `protocol://@]proxyhost[:port]`. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + FixableTotalByDigest: properties: - createTime: - format: google-datetime - description: Output only. The time this operation was created. + totalCount: + description: The total number of vulnerabilities associated with this resource. type: string - endTime: + format: int64 + resourceUri: + type: string + description: The affected resource. + fixableCount: + format: int64 + type: string + description: The number of fixable vulnerabilities associated with this resource. + severity: description: >- - Output only. The time that this operation was marked completed or - failed. + The severity for this count. SEVERITY_UNSPECIFIED indicates total + across all severities. type: string - format: google-datetime - id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata - type: object - description: >- - Metadata for all operations used and required for all operations that - created by Container Analysis Providers - AttestationOccurrence: - type: object - id: AttestationOccurrence - description: >- - Occurrence that represents a single "attestation". The authenticity of - an attestation can be verified using the attached signature. If the - verifier trusts the public key of the signer, then verifying the + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + id: FixableTotalByDigest + type: object + description: Per resource and severity counts of fixable and total vulnerabilities. + GerritSourceContext: + properties: + revisionId: + type: string + description: A revision (commit) ID. + gerritProject: + type: string + description: >- + The full project name within the host. Projects may be nested, so + "project/subproject" is a valid project name. The "repo name" is the + hostURI/project. + hostUri: + description: The URI of a running Gerrit instance. + type: string + aliasContext: + description: An alias, which may be a branch or tag. + $ref: '#/components/schemas/AliasContext' + description: A SourceContext referring to a Gerrit project. + type: object + id: GerritSourceContext + TestIamPermissionsResponse: + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + type: object + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + TimeSpan: + properties: + startTime: + format: google-datetime + description: Start of time span. + type: string + endTime: + format: google-datetime + type: string + description: End of time span. + id: TimeSpan + type: object + description: 'Start and end times for a build execution phase. Next ID: 3' + BatchCreateOccurrencesResponse: + id: BatchCreateOccurrencesResponse + type: object + description: Response for creating occurrences in batch. + properties: + occurrences: + items: + $ref: '#/components/schemas/Occurrence' + type: array + description: The occurrences that were created. + BatchCreateNotesRequest: + id: BatchCreateNotesRequest + properties: + notes: + type: object + additionalProperties: + $ref: '#/components/schemas/Note' + description: Required. The notes to create. Max allowed length is 1000. + type: object + description: Request to create notes in batch. + ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: + description: Secrets and secret environment variables. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + type: object + properties: + inline: + description: >- + Secrets encrypted with KMS key and the associated secret environment + variable. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret + secretManager: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret + description: >- + Secrets in Secret Manager and associated secret environment + variable. + type: array + Envelope: + properties: + signatures: + type: array + items: + $ref: '#/components/schemas/EnvelopeSignature' + payload: + format: byte + type: string + payloadType: + type: string + id: Envelope + type: object + description: >- + MUST match + https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. + An authenticated message of arbitrary type. + GetPolicyOptions: + properties: + requestedPolicyVersion: + format: int32 + type: integer + 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). + description: Encapsulates settings provided to GetIamPolicy. + type: object + id: GetPolicyOptions + AttestationOccurrence: + description: >- + Occurrence that represents a single "attestation". The authenticity of + an attestation can be verified using the attached signature. If the + verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. + type: object + id: AttestationOccurrence properties: jwts: + items: + $ref: '#/components/schemas/Jwt' type: array description: >- One or more JWTs encoding a self-contained attestation. Each JWT @@ -802,90 +993,103 @@ components: empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas. - items: - $ref: '#/components/schemas/Jwt' - serializedPayload: - type: string - description: >- - Required. The serialized payload that is verified by one or more - `signatures`. - format: byte signatures: - type: array - items: - $ref: '#/components/schemas/Signature' description: >- One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification. - BatchCreateNotesRequest: - type: object - description: Request to create notes in batch. - id: BatchCreateNotesRequest + type: array + items: + $ref: '#/components/schemas/Signature' + serializedPayload: + description: >- + Required. The serialized payload that is verified by one or more + `signatures`. + type: string + format: byte + AnalysisCompleted: + id: AnalysisCompleted properties: - notes: - additionalProperties: - $ref: '#/components/schemas/Note' - type: object - description: Required. The notes to create. Max allowed length is 1000. - VulnerabilityAssessmentNote: + analysisType: + type: array + items: + type: string + description: >- + Indicates which analysis completed successfully. Multiple types of + analysis can be performed on a single resource. type: object + WindowsUpdate: properties: - longDescription: - type: string - description: A detailed description of this Vex. - product: - $ref: '#/components/schemas/Product' - description: The product affected by this vex. + identity: + description: Required - The unique identifier for the update. + $ref: '#/components/schemas/Identity' + kbArticleIds: + type: array + items: + type: string + description: >- + The Microsoft Knowledge Base article IDs that are associated with + the update. title: + description: The localized title of the update. type: string - description: The title of the note. E.g. `Vex-Debian-11.4` - publisher: - description: Publisher details of this Note. - $ref: '#/components/schemas/Publisher' - languageCode: - description: >- - Identifies the language used by this document, corresponding to IETF - BCP 47 / RFC 5646. + description: type: string - shortDescription: - description: A one sentence description of this Vex. + description: The localized description of the update. + supportUrl: + description: The hyperlink to the support information for the update. type: string - assessment: - description: Represents a vulnerability assessment for the product. - $ref: '#/components/schemas/Assessment' + categories: + items: + $ref: '#/components/schemas/Category' + description: The list of categories to which the update belongs. + type: array + lastPublishedTimestamp: + description: The last published timestamp of the update. + format: google-datetime + type: string + type: object description: >- - A single VulnerabilityAssessmentNote represents one particular product's - vulnerability assessment for one CVE. - id: VulnerabilityAssessmentNote - GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: + Windows Update represents the metadata about the update for the Windows + operating system. The fields in this message come from the Windows + Update API documented at + https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. + id: WindowsUpdate + SlsaCompleteness: + description: >- + Indicates that the builder claims certain fields in this message to be + complete. + id: SlsaCompleteness type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation - description: Identifies the event that kicked off the build. properties: environment: - type: object - additionalProperties: - description: Properties of the object. - type: any - configSource: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' - parameters: - type: object - additionalProperties: - type: any - description: Properties of the object. + description: >- + If true, the builder claims that recipe.environment is claimed to be + complete. + type: boolean + arguments: + type: boolean + description: >- + If true, the builder claims that recipe.arguments is complete, + meaning that all external inputs are properly captured in the + recipe. + materials: + type: boolean + description: >- + If true, the builder claims that materials are complete, usually + through some controls to prevent network access. Sometimes called + "hermetic". Hint: - type: object - id: Hint properties: humanReadableName: type: string description: >- Required. The human readable name of this attestation authority, for example "qa". + type: object + id: Hint description: >- This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it @@ -894,1242 +1098,1656 @@ components: debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. - CloudStorageLocation: + SlsaRecipe: + id: SlsaRecipe type: object - description: >- - Empty placeholder to denote that this is a Google Cloud Storage export - request. - id: CloudStorageLocation - properties: {} - Hash: properties: - value: - type: string - format: byte - description: Required. The hash value. type: type: string - description: Required. The type of hash that was performed, e.g. "SHA-256". - description: Container message for hash values. - type: object - id: Hash - Empty: - id: Empty - type: object - properties: {} - 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); } - Artifact: - id: Artifact - properties: - names: description: >- - Related artifact names. This may be the path to a binary or jar - file, or in the case of a container build, the name used to push the - container image to Google Container Registry, as presented to - `docker push`. Note that a single Artifact ID can have multiple - names, for example if two tags are applied to one image. - items: - type: string - type: array - id: - type: string + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. + arguments: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - Artifact ID, if any; for container images, this will be a URL by - digest like `gcr.io/projectID/imagename@sha256:123456`. - checksum: - type: string + Collection of all external inputs that influenced the build on top + of recipe.definedInMaterial and recipe.entryPoint. For example, if + the recipe type were "make", then this might be the flags passed to + make aside from the target, which is captured in recipe.entryPoint. + Depending on the recipe Type, the structure may be different. + definedInMaterial: + format: int64 description: >- - Hash or checksum value of a binary, or Docker Registry 2.0 digest of - a container. - description: Artifact describes a build product. - type: object - Remediation: - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - properties: - remediationType: - enum: - - REMEDIATION_TYPE_UNSPECIFIED - - MITIGATION - - NO_FIX_PLANNED - - NONE_AVAILABLE - - VENDOR_FIX - - WORKAROUND - description: The type of remediation that can be applied. + Index in materials containing the recipe steps that are not implied + by recipe.type. For example, if the recipe type were "make", then + this would point to the source containing the Makefile, not the make + program itself. Set to -1 if the recipe doesn't come from a + material, as zero is default unset value for int64. type: string - enumDescriptions: - - No remediation type specified. - - A MITIGATION is available. - - No fix is planned. - - Not available. - - A vendor fix is available. - - A workaround is available. - details: + entryPoint: description: >- - Contains a comprehensive human-readable discussion of the - remediation. + String identifying the entry point into the build. This is often a + path to a configuration file and/or a target label within that file. + The syntax and meaning are defined by recipe.type. For example, if + the recipe type were "make", then this would reference the directory + in which to run make as well as which target to use. type: string - remediationUri: - description: Contains the URL where to obtain the remediation. - $ref: '#/components/schemas/RelatedUrl' - id: Remediation - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption - properties: - name: + environment: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - The `WorkerPool` resource to execute the build on. You must have - `cloudbuild.workerpools.use` on the project hosting the WorkerPool. - Format - projects/{project}/locations/{location}/workerPools/{workerPoolId} - type: string + Any other builder-controlled inputs necessary for correctly + evaluating the recipe. Usually only needed for reproducing the build + but not evaluated as part of policy. Depending on the recipe Type, + the structure may be different. + type: object description: >- - Details about how a build should be executed on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. - type: object - ImageOccurrence: + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. + Subject: + id: Subject properties: - distance: - format: int32 - description: >- - Output only. The number of layers by which this image differs from - the associated image basis. - type: integer - fingerprint: - description: Required. The fingerprint of the derived image. - $ref: '#/components/schemas/Fingerprint' - baseResourceUrl: + name: type: string + digest: + type: object description: >- - Output only. This contains the base image URL for the derived image - occurrence. - layerInfo: - description: >- - This contains layer-specific metadata, if populated it has length - "distance" and is ordered with [distance] being the layer - immediately following the base image and [1] being the final layer. - type: array - items: - $ref: '#/components/schemas/Layer' + `"": ""` Algorithms can be e.g. sha256, sha512 See + https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet + additionalProperties: + type: string type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: description: >- - Details of the derived image portion of the DockerImage relationship. - This image would be produced from a Dockerfile with FROM . - id: ImageOccurrence - DSSEAttestationNote: - properties: - hint: - $ref: '#/components/schemas/DSSEHint' - description: DSSEHint hints at the purpose of the attestation authority. - id: DSSEAttestationNote + Location of the source manifest in Cloud Storage. This feature is in + Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). type: object - GerritSourceContext: - id: GerritSourceContext + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest properties: - gerritProject: + object: + description: >- + Required. Cloud Storage object containing the source manifest. This + object must be a JSON file. type: string + generation: + format: int64 description: >- - The full project name within the host. Projects may be nested, so - "project/subproject" is a valid project name. The "repo name" is the - hostURI/project. - aliasContext: - $ref: '#/components/schemas/AliasContext' - description: An alias, which may be a branch or tag. - hostUri: + Cloud Storage generation for the object. If the generation is + omitted, the latest generation will be used. type: string - description: The URI of a running Gerrit instance. - revisionId: - description: A revision (commit) ID. + bucket: + description: >- + Required. Cloud Storage bucket containing the source manifest (see + [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). type: string - description: A SourceContext referring to a Gerrit project. - type: object - BuildMetadata: + EnvelopeSignature: + id: EnvelopeSignature type: object - id: BuildMetadata properties: - invocationId: - type: string - finishedOn: - format: google-datetime + sig: type: string - startedOn: - format: google-datetime + format: byte + keyid: type: string - ImageNote: - id: ImageNote + InTotoProvenance: + type: object properties: - fingerprint: - description: Required. Immutable. The fingerprint of the base image. - $ref: '#/components/schemas/Fingerprint' - resourceUrl: - type: string + materials: + items: + type: string description: >- - Required. Immutable. The resource_url for the resource representing - the basis of associated occurrence images. - description: >- - Basis describes the base image portion (Note) of the DockerImage - relationship. Linked occurrences are derived from this or an equivalent - image via: FROM Or an equivalent reference, e.g., a tag of the - resource_url. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: + The collection of artifacts that influenced the build including + sources, dependencies, build tools, base images, and so on. This is + considered to be incomplete unless metadata.completeness.materials + is true. Unset or null is equivalent to empty. + type: array + metadata: + $ref: '#/components/schemas/Metadata' + builderConfig: + description: required + $ref: '#/components/schemas/BuilderConfig' + recipe: + $ref: '#/components/schemas/Recipe' + description: >- + Identifies the configuration used for the build. When combined with + materials, this SHOULD fully describe the build, such that + re-running this recipe results in bit-for-bit identical output (if + the build is reproducible). required + id: InTotoProvenance + Publisher: + description: Publisher contains information about the publisher of this Note. + id: Publisher type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret - description: >- - Pairs a secret environment variable with a SecretVersion in Secret - Manager. properties: - env: - type: string - description: >- - Environment variable name to associate with the secret. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. - versionName: + issuingAuthority: description: >- - Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* + Provides information about the authority of the issuing party to + release the document, in particular, the party's constituency and + responsibilities or other obligations. type: string - RelatedUrl: - type: object - id: RelatedUrl - description: Metadata for any related URL information. - properties: - url: - description: Specific URL associated with the resource. + name: + description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' type: string - label: + publisherNamespace: type: string - description: Label to describe usage of the URL. - ExportSBOMRequest: + description: >- + The context or namespace. Contains a URL which is under control of + the issuing party and can be used as a globally unique identifier + for that issuing party. Example: https://csaf.io + DeploymentOccurrence: + description: The period during which some deployable was active in a runtime. properties: - cloudStorageLocation: + address: + description: Address of the runtime element hosting this deployment. + type: string + platform: + enumDescriptions: + - Unknown. + - Google Container Engine. + - 'Google App Engine: Flexible Environment.' + - Custom user-defined platform. + enum: + - PLATFORM_UNSPECIFIED + - GKE + - FLEX + - CUSTOM + description: Platform hosting this deployment. + type: string + undeployTime: + format: google-datetime + type: string + description: End of the lifetime of this deployment. + config: + type: string + description: Configuration used to create this deployment. + resourceUri: description: >- - Empty placeholder to denote that this is a Google Cloud Storage - export request. - $ref: '#/components/schemas/CloudStorageLocation' - description: >- - The request to generate and export SBOM. Target must be specified for - the request. - id: ExportSBOMRequest + Output only. Resource URI for the artifact being deployed taken from + the deployable field with the same name. + items: + type: string + type: array + deployTime: + description: Required. Beginning of the lifetime of this deployment. + type: string + format: google-datetime + userEmail: + type: string + description: Identity of the user that triggered this deployment. type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: + id: DeploymentOccurrence + SlsaMetadata: type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance - description: >- - Provenance of the source. Ways to find the original source, or verify - that some source was used for this build. + id: SlsaMetadata + description: Other properties of the build. properties: - resolvedStorageSource: - description: >- - A copy of the build's `source.storage_source`, if exists, with any - generations resolved. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - fileHashes: - additionalProperties: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: >- - Output only. Hash(es) of the build source, which can be used to - verify that the original source integrity was maintained in the - build. Note that `FileHashes` will only be populated if - `BuildOptions` has requested a `SourceProvenanceHash`. The keys to - this map are file paths used as build source and the values contain - the hash values for those files. If the build source came in a - single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` - will be for the single path to that file. - readOnly: true - type: object - resolvedGitSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - description: >- - Output only. A copy of the build's `source.git_source`, if exists, - with any revisions resolved. - readOnly: true - resolvedConnectedRepository: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + buildFinishedOn: + description: The timestamp of when the build completed. + type: string + format: google-datetime + completeness: description: >- - Output only. A copy of the build's `source.connected_repository`, if - exists, with any revisions resolved. - readOnly: true - resolvedRepoSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + Indicates that the builder claims certain fields in this message to + be complete. + $ref: '#/components/schemas/SlsaCompleteness' + reproducible: description: >- - A copy of the build's `source.repo_source`, if exists, with any - revisions resolved. - resolvedStorageSourceManifest: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. + type: boolean + buildStartedOn: + format: google-datetime + type: string + description: The timestamp of when the build started. + buildInvocationId: description: >- - A copy of the build's `source.storage_source_manifest`, if exists, - with any revisions resolved. This feature is in Preview. - GrafeasV1FileLocation: + Identifies the particular build invocation, which can be useful for + finding associated logs or other ad-hoc analysis. The value SHOULD + be globally unique, per in-toto Provenance spec. + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + description: A fatal problem encountered during the execution of the build. + properties: + detail: + type: string + description: Explains the failure issue in more detail using hard-coded text. + type: + type: string + enum: + - FAILURE_TYPE_UNSPECIFIED + - PUSH_FAILED + - PUSH_IMAGE_NOT_FOUND + - PUSH_NOT_AUTHORIZED + - LOGGING_FAILURE + - USER_BUILD_STEP + - FETCH_SOURCE_FAILED + description: The name of the failure. + enumDescriptions: + - Type unspecified + - Unable to push the image to the repository. + - Final image not found. + - Unauthorized push of the final image. + - Backend logging failures. Should retry. + - A build step has failed. + - The source fetching has failed. type: object - description: Indicates the location at which a package was found. - id: GrafeasV1FileLocation + SlsaBuilder: properties: - filePath: - description: >- - For jars that are contained inside .war files, this filepath can - indicate the path to war file combined with the path to jar file. + id: type: string - SbomReferenceIntotoPredicate: - id: SbomReferenceIntotoPredicate - description: A predicate which describes the SBOM being referenced. + id: SlsaBuilder type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: properties: - mimeType: + kmsKeyName: type: string - description: The mime type of the SBOM. - digest: + description: Cloud KMS key name to use to decrypt these envs. + secretEnv: + description: >- + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. type: object additionalProperties: type: string - description: A map of algorithm to digest of the contents of the SBOM. - referrerId: - type: string - description: The person or system referring this predicate to the consumer. - location: - type: string - description: The location of the SBOM. - GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata + format: byte + description: >- + Pairs a set of secret environment variables containing encrypted values + with the Cloud KMS key to use to decrypt the value. Note: Use + `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with + `secret`. For instructions see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secret + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: properties: - buildInvocationId: - type: string - reproducible: + approvalRequired: type: boolean - buildFinishedOn: - type: string - format: google-datetime - buildStartedOn: - type: string - format: google-datetime - completeness: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' - description: Other properties of the build. + description: >- + Whether or not approval is needed. If this is set on a build, it + will become pending when created, and will need to be explicitly + approved to start. + description: ApprovalConfig describes configuration for manual approval of a build. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig type: object - RepoId: + GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: + properties: + configSource: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' + parameters: + additionalProperties: + description: Properties of the object. + type: any + type: object + environment: + additionalProperties: + description: Properties of the object. + type: any + type: object + description: Identifies the event that kicked off the build. + id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation + type: object + VulnerabilityAssessmentNote: type: object properties: - projectRepoId: - $ref: '#/components/schemas/ProjectRepoId' - description: A combination of a project ID and a repo name. - uid: - description: A server-assigned, globally unique identifier. + shortDescription: + description: A one sentence description of this Vex. type: string - description: A unique identifier for a Cloud Repo. - id: RepoId - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: - properties: - volumes: + publisher: + $ref: '#/components/schemas/Publisher' + description: Publisher details of this Note. + longDescription: + description: A detailed description of this Vex. + type: string + languageCode: description: >- - Global list of volumes to mount for ALL build steps Each volume is - created as an empty volume prior to starting the build process. Upon - completion of the build, volumes and their contents are discarded. - Global volume names and paths cannot conflict with the volumes - defined a build step. Using a global volume in a build with only one - step is not valid as it is indicative of a build request with an - incorrect configuration. + Identifies the language used by this document, corresponding to IETF + BCP 47 / RFC 5646. + type: string + title: + description: The title of the note. E.g. `Vex-Debian-11.4` + type: string + product: + description: The product affected by this vex. + $ref: '#/components/schemas/Product' + assessment: + description: Represents a vulnerability assessment for the product. + $ref: '#/components/schemas/Assessment' + description: >- + A single VulnerabilityAssessmentNote represents one particular product's + vulnerability assessment for one CVE. + id: VulnerabilityAssessmentNote + ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + type: object + properties: + fileHash: items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + description: Collection of file hashes. type: array - machineType: - enumDeprecated: - - false - - true - - true - - false - - false - - false - enumDescriptions: - - Standard machine type. - - Highcpu machine with 8 CPUs. - - Highcpu machine with 32 CPUs. - - Highcpu e2 machine with 8 CPUs. - - Highcpu e2 machine with 32 CPUs. - - E2 machine with 1 CPU. - description: Compute Engine machine type on which to run the build. - enum: - - UNSPECIFIED - - N1_HIGHCPU_8 - - N1_HIGHCPU_32 - - E2_HIGHCPU_8 - - E2_HIGHCPU_32 - - E2_MEDIUM + description: >- + Container message for hashes of byte content of files, used in + SourceProvenance messages to verify integrity of source input to the + build. + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage + properties: + packagePath: + type: string + description: Path to the package.json. e.g. workspace/path/to/package + repository: type: string - env: - type: array description: >- - A list of global environment variable definitions that will exist - for all build steps in this build. If a variable is defined in both - globally and in a build step, the variable will use the build step - value. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - items: - type: string - diskSizeGb: - format: int64 + Artifact Registry repository, in the form + "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in + the workspace specified by path will be zipped and uploaded to + Artifact Registry with this location as a prefix. + type: object + description: >- + Npm package to upload to Artifact Registry upon successful completion of + all build steps. + ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: + properties: + name: description: >- - Requested disk size for the VM that runs the build. Note that this - is *NOT* "disk free"; some of the space will be used by the - operating system and build utilities. Also note that this is the - minimum disk size that will be allocated for the build -- the build - may run with a larger disk than requested. At present, the maximum - disk size is 4000GB; builds that request more than the maximum are - rejected with an error. + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. type: string - dynamicSubstitutions: + path: description: >- - Option to specify whether or not to apply bash style string - operations to the substitutions. NOTE: this is always enabled for - triggered builds and cannot be overridden in the build configuration - file. - type: boolean - workerPool: - deprecated: true - description: This field deprecated; please use `pool.name` instead. + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. type: string - defaultLogsBucketBehavior: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + type: object + description: >- + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. + ListOccurrencesResponse: + id: ListOccurrencesResponse + description: Response for listing occurrences. + type: object + properties: + occurrences: + items: + $ref: '#/components/schemas/Occurrence' + description: The occurrences requested. + type: array + nextPageToken: type: string - description: Optional. Option to specify how default logs buckets are setup. - enum: - - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED - - REGIONAL_USER_OWNED_BUCKET - enumDescriptions: - - Unspecified. - - >- - Bucket is located in user-owned project in the same region as the - build. The builder service account must have access to create and - write to Cloud Storage buckets in the build project. - substitutionOption: - enumDescriptions: - - >- - Fails the build if error in substitutions checks, like missing a - substitution in the template or in the map. - - Do not fail the build if error in substitutions checks. + description: >- + The next pagination token in the list response. It should be used as + `page_token` for the following request. An empty value means no more + results. + CisBenchmark: + id: CisBenchmark + type: object + description: A compliance check that is a CIS benchmark. + properties: + severity: type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. enum: - - MUST_MATCH - - ALLOW_LOOSE + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + profileLevel: + type: integer + format: int32 + BuildMetadata: + id: BuildMetadata + type: object + properties: + startedOn: + format: google-datetime + type: string + invocationId: + type: string + finishedOn: + type: string + format: google-datetime + Metadata: + id: Metadata + properties: + buildInvocationId: + type: string description: >- - Option to specify behavior when there is an error in the - substitution checks. NOTE: this is always set to ALLOW_LOOSE for - triggered builds and cannot be overridden in the build configuration - file. - automapSubstitutions: - type: boolean + Identifies the particular build invocation, which can be useful for + finding associated logs or other ad-hoc analysis. The value SHOULD + be globally unique, per in-toto Provenance spec. + buildStartedOn: + description: The timestamp of when the build started. + type: string + format: google-datetime + buildFinishedOn: + description: The timestamp of when the build completed. + format: google-datetime + type: string + reproducible: description: >- - Option to include built-in and custom substitutions as env variables - for all build steps. - pool: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. + type: boolean + completeness: + $ref: '#/components/schemas/Completeness' description: >- - Optional. Specification for execution on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. - logging: - enum: - - LOGGING_UNSPECIFIED - - LEGACY - - GCS_ONLY - - STACKDRIVER_ONLY - - CLOUD_LOGGING_ONLY - - NONE + Indicates that the builder claims certain fields in this message to + be complete. + description: Other properties of the build. + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult + type: object + description: >- + ApprovalResult describes the decision and associated metadata of a + manual approval of a build. + properties: + approvalTime: + readOnly: true + description: Output only. The time when the approval decision was made. + format: google-datetime + type: string + decision: type: string enumDescriptions: - - >- - The service determines the logging mode. The default is `LEGACY`. - Do not rely on the default logging behavior as it may change in - the future. - - Build logs are stored in Cloud Logging and Cloud Storage. - - Build logs are stored in Cloud Storage. - - This option is the same as CLOUD_LOGGING_ONLY. - - >- - Build logs are stored in Cloud Logging. Selecting this option will - not allow [logs - streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log). - - Turn off all logging. No build logs will be captured. - description: >- - Option to specify the logging mode, which determines if and where - build logs are stored. - enumDeprecated: - - false - - false - - false - - true - - false - - false - requestedVerifyOption: - description: Requested verifiability options. - enumDescriptions: - - Not a verifiable build (the default). - - Build must be verified. + - Default enum type. This should not be used. + - Build is approved. + - Build is rejected. enum: - - NOT_VERIFIED - - VERIFIED + - DECISION_UNSPECIFIED + - APPROVED + - REJECTED + description: Required. The decision of this manual approval. + comment: type: string - sourceProvenanceHash: + description: Optional. An optional comment for this manual approval result. + url: + type: string + description: >- + Optional. An optional URL tied to this manual approval result. This + field is essentially the same as comment, except that it will be + rendered by the UI differently. An example use case is a link to an + external job that approved this Build. + approverAccount: + type: string + description: >- + Output only. Email of the user that called the ApproveBuild API to + approve or reject a build at the time that the API was called. + readOnly: true + Command: + description: Command describes a step performed as part of the build pipeline. + type: object + properties: + dir: + type: string + description: >- + Working directory (relative to project source root) used when + running this command. + env: items: - enum: - - NONE - - SHA256 - - MD5 - - SHA512 - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. type: string - description: Requested hash for SourceProvenance. type: array - logStreamingOption: - enumDescriptions: - - Service may automatically determine build log streaming behavior. - - Build logs should be streamed to Cloud Storage. - - >- - Build logs should not be streamed to Cloud Storage; they will be - written when the build is completed. - type: string - description: Option to define build log streaming behavior to Cloud Storage. - enum: - - STREAM_DEFAULT - - STREAM_ON - - STREAM_OFF - secretEnv: + description: Environment variables set before running this command. + waitFor: + items: + type: string + description: The ID(s) of the command(s) that this command depends on. type: array + name: description: >- - A list of global environment variables, which are encrypted using a - Cloud Key Management Service crypto key. These values must be - specified in the build's `Secret`. These variables will be available - to all build steps in this build. + Required. Name of the command, as presented on the command line, or + if the command is packaged as a Docker container, as presented to + `docker pull`. + type: string + args: + description: Command-line arguments used when executing this command. items: type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions - type: object - description: Optional arguments to enable specific features of builds. - Justification: - description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - properties: - justificationType: - type: string - description: The justification type for this vulnerability. - enumDescriptions: - - JUSTIFICATION_TYPE_UNSPECIFIED. - - The vulnerable component is not present in the product. - - >- - The vulnerable code is not present. Typically this case occurs - when source code is configured or built in a way that excludes the - vulnerable code. - - >- - The vulnerable code can not be executed. Typically this case - occurs when the product includes the vulnerable code but does not - call or use the vulnerable code. - - >- - The vulnerable code cannot be controlled by an attacker to exploit - the vulnerability. - - >- - The product includes built-in protections or features that prevent - exploitation of the vulnerability. These built-in protections - cannot be subverted by the attacker and cannot be configured or - disabled by the user. These mitigations completely prevent - exploitation based on known attack vectors. - enum: - - JUSTIFICATION_TYPE_UNSPECIFIED - - COMPONENT_NOT_PRESENT - - VULNERABLE_CODE_NOT_PRESENT - - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH - - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY - - INLINE_MITIGATIONS_ALREADY_EXIST - details: - description: Additional details on why this justification was chosen. + type: array + id: + description: >- + Optional unique identifier for this command, used in wait_for to + reference this command as a dependency. type: string - id: Justification + id: Command + GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: type: object - NonCompliantFile: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness + description: >- + Indicates that the builder claims certain fields in this message to be + complete. properties: - reason: - type: string - description: Explains why a file is non compliant for a CIS check. - path: - description: Empty if `display_command` is set. - type: string - displayCommand: - type: string - description: Command to display the non-compliant files. + materials: + type: boolean + environment: + type: boolean + parameters: + type: boolean + UpgradeOccurrence: description: >- - Details about files that caused a compliance check to fail. - display_command is a single command that can be used to display a list - of non compliant files. When there is no such command, we can also - iterate a list of non compliant file using 'path'. + An Upgrade Occurrence represents that a specific resource_url could + install a specific upgrade. This presence is supplied via local sources + (i.e. it is present in the mirror and the running system has noticed its + availability). For Windows, both distribution and windows_update contain + information for the Windows update. + id: UpgradeOccurrence type: object - id: NonCompliantFile - SourceContext: properties: - gerrit: - $ref: '#/components/schemas/GerritSourceContext' - description: A SourceContext referring to a Gerrit project. - cloudRepo: + distribution: + $ref: '#/components/schemas/UpgradeDistribution' description: >- - A SourceContext referring to a revision in a Google Cloud Source - Repo. - $ref: '#/components/schemas/CloudRepoSourceContext' - labels: - description: Labels with user defined metadata. - additionalProperties: - type: string - type: object - git: + Metadata about the upgrade for available for the specific operating + system for the resource_url. This allows efficient filtering, as + well as making it easier to use the occurrence. + package: + description: Required for non-Windows OS. The package this Upgrade is for. + type: string + windowsUpdate: description: >- - A SourceContext referring to any third party Git repo (e.g., - GitHub). - $ref: '#/components/schemas/GitSourceContext' - id: SourceContext - description: >- - A SourceContext is a reference to a tree of files. A SourceContext - together with a path point to a unique revision of a single file or - directory. - type: object - AttestationNote: - description: >- - Note kind that represents a logical attestation "role" or "authority". - For example, an organization might have one `Authority` for "QA" and one - for "build". This note is intended to act strictly as a grouping - mechanism for the attached occurrences (Attestations). This grouping - mechanism also provides a security boundary, since IAM ACLs gate the - ability for a principle to attach an occurrence to a given note. It also - provides a single point of lookup to find all attached attestation - occurrences, even if they don't all live in the same project. - type: object - id: AttestationNote - properties: - hint: - description: Hint hints at the purpose of the attestation authority. - $ref: '#/components/schemas/Hint' - ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - type: object - description: Location of the source in any accessible Git repository. - properties: - dir: - description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. - type: string - revision: - description: >- - Optional. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git - fetch` to fetch the revision from the Git repository; therefore make - sure that the string you provide for `revision` is parsable by the - command. For information on string values accepted by `git fetch`, - see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For - information on `git fetch`, see https://git-scm.com/docs/git-fetch. - type: string - url: + Required for Windows OS. Represents the metadata about the Windows + update. + $ref: '#/components/schemas/WindowsUpdate' + parsedVersion: description: >- - Required. Location of the Git repo to build. This will be used as a - `git remote`, see https://git-scm.com/docs/git-remote. - type: string - PackageNote: - type: object + Required for non-Windows OS. The version of the package in a machine + + human readable form. + $ref: '#/components/schemas/Version' + CVSSv3: + id: CVSSv3 properties: - url: - description: The homepage for this package. + baseScore: + description: The base score is a function of the base metric scores. + type: number + format: float + privilegesRequired: type: string - license: - description: Licenses that have been declared by the authors of the package. - $ref: '#/components/schemas/License' - version: - $ref: '#/components/schemas/Version' - description: The version of the package. - digest: - type: array - items: - $ref: '#/components/schemas/Digest' - description: >- - Hash value, typically a file digest, that allows unique - identification a specific package. - architecture: enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. + - '' + - '' + - '' + - '' enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 - description: >- - The CPU architecture for which packages in this distribution channel - were built. Architecture will be blank for language packages. + - PRIVILEGES_REQUIRED_UNSPECIFIED + - PRIVILEGES_REQUIRED_NONE + - PRIVILEGES_REQUIRED_LOW + - PRIVILEGES_REQUIRED_HIGH + confidentialityImpact: type: string - name: - description: Required. Immutable. The name of the package. + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + userInteraction: + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED + enumDescriptions: + - '' + - '' + - '' type: string - distribution: - description: Deprecated. The various channels by which a package is distributed. - type: array - items: - $ref: '#/components/schemas/Distribution' - maintainer: + exploitabilityScore: + format: float + type: number + scope: + enumDescriptions: + - '' + - '' + - '' type: string - description: A freeform text denoting the maintainer of this package. - packageType: + enum: + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED + availabilityImpact: type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + attackVector: description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - description: - description: The description of this package. + Base Metrics Represents the intrinsic characteristics of a + vulnerability that are constant over time and across user + environments. + enum: + - ATTACK_VECTOR_UNSPECIFIED + - ATTACK_VECTOR_NETWORK + - ATTACK_VECTOR_ADJACENT + - ATTACK_VECTOR_LOCAL + - ATTACK_VECTOR_PHYSICAL type: string - cpeUri: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + impactScore: + format: float + type: number + integrityImpact: type: string - description: >- - The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) - denoting the package manager version distributing a package. The - cpe_uri will be blank for language packages. - description: PackageNote represents a particular package version. - id: PackageNote - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + attackComplexity: + enumDescriptions: + - '' + - '' + - '' + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH + type: string + type: object + description: >- + Common Vulnerability Scoring System version 3. For details, see + https://www.first.org/cvss/specification-document + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). type: object properties: - object: + etag: description: >- - Required. Cloud Storage object containing the source manifest. This - object must be a JSON file. + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. type: string - generation: + format: byte + bindings: + type: array + items: + $ref: '#/components/schemas/Binding' description: >- - Cloud Storage generation for the object. If the generation is - omitted, the latest generation will be used. - format: int64 + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + version: + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + format: int32 + Category: + description: The category to which the update belongs. + type: object + id: Category + properties: + name: type: string - bucket: + description: The localized name of the category. + categoryId: + description: The identifier of the category. type: string - description: >- - Required. Cloud Storage bucket containing the source manifest (see - [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + BuildProvenance: + type: object description: >- - Location of the source manifest in Cloud Storage. This feature is in - Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest - AliasContext: - description: An alias to a repo revision. + Provenance of a build. Contains all information needed to verify the + full details about the build from source to completion. + id: BuildProvenance properties: - name: + logsUri: + description: URI where any logs for this provenance were written. type: string - description: The alias name. - kind: + creator: + description: >- + E-mail address of the user who initiated this build. Note that this + was the user's e-mail address at the time the build was initiated; + this address may not represent the same end-user for all time. + type: string + sourceProvenance: + $ref: '#/components/schemas/Source' + description: Details of the Source input to the build. + startTime: + type: string + description: Time at which execution of the build was started. + format: google-datetime + endTime: + description: Time at which execution of the build was finished. + type: string + format: google-datetime + projectId: + type: string + description: ID of the project. + builderVersion: + description: Version string of the builder at the time this build was executed. + type: string + id: + type: string + description: Required. Unique identifier of the build. + createTime: + format: google-datetime + description: Time at which the build was created. + type: string + buildOptions: + type: object + additionalProperties: + type: string + description: >- + Special options applied to this build. This is a catch-all field + where build providers can enter any desired additional details. + triggerId: type: string + description: >- + Trigger identifier if the build was triggered automatically; empty + if not. + builtArtifacts: + description: Output of the build. + type: array + items: + $ref: '#/components/schemas/Artifact' + commands: + type: array + description: Commands requested by the build. + items: + $ref: '#/components/schemas/Command' + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval + description: >- + BuildApproval describes a build's approval configuration, state, and + result. + properties: + config: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + readOnly: true + description: Output only. Configuration for manual approval of this build. + state: + description: Output only. The state of this build's approval. + readOnly: true enum: - - KIND_UNSPECIFIED - - FIXED - - MOVABLE - - OTHER + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + - CANCELLED enumDescriptions: - - Unknown. - - Git tag. - - Git branch. - - >- - Used to specify non-standard aliases. For example, if a Git repo - has a ref named "refs/foo/bar". - description: The alias kind. - type: object - id: AliasContext + - Default enum type. This should not be used. + - Build approval is pending. + - Build approval has been approved. + - Build approval has been rejected. + - Build was cancelled while it was still pending approval. + type: string + result: + description: Output only. Result of manual approval for this Build. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult SBOMReferenceOccurrence: - description: >- - The occurrence representing an SBOM reference as applied to a specific - resource. The occurrence follows the DSSE specification. See - https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for - more details. + id: SBOMReferenceOccurrence + type: object properties: + payload: + $ref: '#/components/schemas/SbomReferenceIntotoPayload' + description: The actual payload that contains the SBOM reference data. payloadType: - type: string description: >- The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'. - payload: - $ref: '#/components/schemas/SbomReferenceIntotoPayload' - description: The actual payload that contains the SBOM reference data. + type: string signatures: items: $ref: '#/components/schemas/EnvelopeSignature' description: The signatures over the payload. type: array + description: >- + The occurrence representing an SBOM reference as applied to a specific + resource. The occurrence follows the DSSE specification. See + https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for + more details. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: type: object - id: SBOMReferenceOccurrence - GitSourceContext: + description: A non-fatal problem encountered during the execution of the build. properties: - revisionId: - description: Git commit hash. + text: + description: Explanation of the warning generated. type: string - url: - description: Git repository URL. + priority: + enumDescriptions: + - Should not be used. + - e.g. deprecation warnings and alternative feature highlights. + - e.g. automated detection of possible issues with the build. + - e.g. alerts that a feature used in the build is pending removal + description: The priority for this warning. + enum: + - PRIORITY_UNSPECIFIED + - INFO + - WARNING + - ALERT type: string - id: GitSourceContext + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + DSSEHint: type: object description: >- - A GitSourceContext denotes a particular revision in a third party Git - repository (e.g., GitHub). - BatchCreateOccurrencesResponse: - type: object - id: BatchCreateOccurrencesResponse - properties: - occurrences: - type: array - description: The occurrences that were created. - items: - $ref: '#/components/schemas/Occurrence' - description: Response for creating occurrences in batch. - Detail: + This submessage provides human-readable hints about the purpose of the + authority. Because the name of a note acts as its resource reference, it + is important to disambiguate the canonical name of the Note (which might + be a UUID for security purposes) from "readable" names more suitable for + debug output. Note that these hints should not be used to look up + authorities in security sensitive contexts, such as when looking up + attestations to verify. + id: DSSEHint properties: - source: + humanReadableName: type: string - description: The source from which the information in this Detail was obtained. - fixedCpeUri: description: >- - The distro recommended [CPE - URI](https://cpe.mitre.org/specification/) to update to that - contains a fix for this vulnerability. It is possible for this to be - different from the affected_cpe_uri. + Required. The human readable name of this attestation authority, for + example "cloudbuild-prod". + ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + type: object + properties: + value: type: string - sourceUpdateTime: + format: byte + description: The hash value. + type: + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Use a sha512 hash. type: string + description: The type of hash that was performed. + enum: + - NONE + - SHA256 + - MD5 + - SHA512 + description: Container message for hash values. + ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: + description: >- + Artifacts produced by a build that should be uploaded upon successful + completion of all build steps. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts + properties: + pythonPackages: description: >- - The time this information was last changed at the source. This is an - upstream timestamp from the underlying information source - e.g. - Ubuntu security tracker. - format: google-datetime - affectedVersionEnd: - $ref: '#/components/schemas/Version' - description: >- - The version number at the end of an interval in which this - vulnerability exists. A vulnerability can affect a package between - version numbers that are disjoint sets of intervals (example: - [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will - be represented in its own Detail. If a specific affected version is - provided by a vulnerability database, affected_version_start and - affected_version_end will be the same in that Detail. - fixedVersion: - $ref: '#/components/schemas/Version' - description: >- - The distro recommended version to update to that contains a fix for - this vulnerability. Setting this to VersionKind.MAXIMUM means no - such version is yet available. - packageType: - type: string + A list of Python packages to be uploaded to Artifact Registry upon + successful completion of all build steps. The build service account + credentials will be used to perform the upload. If any objects fail + to be pushed, the build is marked FAILURE. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + objects: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - affectedPackage: - description: Required. The package this vulnerability affects. - type: string - fixedPackage: - type: string + A list of objects to be uploaded to Cloud Storage upon successful + completion of all build steps. Files in the workspace matching + specified paths globs will be uploaded to the specified Cloud + Storage location using the builder service account's credentials. + The location and generation of the uploaded objects will be stored + in the Build resource's results field. If any objects fail to be + pushed, the build is marked FAILURE. + images: description: >- - The distro recommended package to update to that contains a fix for - this vulnerability. It is possible for this to be different from the - affected_package. - isObsolete: - type: boolean + A list of images to be pushed upon the successful completion of all + build steps. The images will be pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the Build resource's results field. If any of the images + fail to be pushed, the build is marked FAILURE. + type: array + items: + type: string + npmPackages: + type: array description: >- - Whether this detail is obsolete. Occurrences are expected not to - point to obsolete details. - description: + A list of npm packages to be uploaded to Artifact Registry upon + successful completion of all build steps. Npm packages in the + specified paths will be uploaded to the specified Artifact Registry + repository using the builder service account's credentials. If any + packages fail to be pushed, the build is marked FAILURE. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage + mavenArtifacts: + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + description: >- + A list of Maven artifacts to be uploaded to Artifact Registry upon + successful completion of all build steps. Artifacts in the workspace + matching specified paths globs will be uploaded to the specified + Artifact Registry repository using the builder service account's + credentials. If any artifacts fail to be pushed, the build is marked + FAILURE. + type: object + VexAssessment: + description: >- + VexAssessment provides all publisher provided Vex information that is + related to this vulnerability. + id: VexAssessment + properties: + state: type: string - description: A vendor-specific description of this vulnerability. - affectedVersionStart: - $ref: '#/components/schemas/Version' + enumDescriptions: + - No state is specified. + - This product is known to be affected by this vulnerability. + - This product is known to be not affected by this vulnerability. + - This product contains a fix for this vulnerability. + - >- + It is not known yet whether these versions are or are not affected + by the vulnerability. However, it is still under investigation. + enum: + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION + description: Provides the state of this Vulnerability assessment. + vulnerabilityId: description: >- - The version number at the start of an interval in which this - vulnerability exists. A vulnerability can affect a package between - version numbers that are disjoint sets of intervals (example: - [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will - be represented in its own Detail. If a specific affected version is - provided by a vulnerability database, affected_version_start and - affected_version_end will be the same in that Detail. - severityName: + The vulnerability identifier for this Assessment. Will hold one of + common identifiers e.g. CVE, GHSA etc. type: string - description: The distro assigned severity of this vulnerability. - affectedCpeUri: + justification: + $ref: '#/components/schemas/Justification' description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + impacts: + type: array + items: + type: string + description: >- + Contains information about the impact of this vulnerability, this + will change with time. + cve: + deprecated: true + description: >- + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. type: string - vendor: + relatedUris: + type: array + items: + $ref: '#/components/schemas/RelatedUrl' + description: >- + Holds a list of references associated with this vulnerability item + and assessment. + noteName: + description: >- + The VulnerabilityAssessment note from which this VexAssessment was + generated. This will be of the form: + `projects/[PROJECT_ID]/notes/[NOTE_ID]`. type: string - description: The name of the vendor of the product. - description: >- - A detail for a distro and package affected by this vulnerability and its - associated fix (if one is available). - id: Detail + remediations: + type: array + items: + $ref: '#/components/schemas/Remediation' + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. type: object - Publisher: - description: Publisher contains information about the publisher of this Note. - id: Publisher + DeploymentNote: + id: DeploymentNote + description: An artifact that can be deployed in some runtime. + properties: + resourceUri: + items: + type: string + type: array + description: Required. Resource URI for the artifact being deployed. + type: object + BatchCreateOccurrencesRequest: type: object + description: Request to create occurrences in batch. + id: BatchCreateOccurrencesRequest properties: - publisherNamespace: + occurrences: + type: array + description: Required. The occurrences to create. Max allowed length is 1000. + items: + $ref: '#/components/schemas/Occurrence' + BuildOccurrence: + id: BuildOccurrence + properties: + intotoStatement: + $ref: '#/components/schemas/InTotoStatement' description: >- - The context or namespace. Contains a URL which is under control of - the issuing party and can be used as a globally unique identifier - for that issuing party. Example: https://csaf.io - type: string - name: - description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' - type: string - issuingAuthority: + In-toto Statement representation as defined in spec. The + intoto_statement can contain any type of provenance. The serialized + payload of the statement can be stored and signed in the + Occurrence's envelope. + inTotoSlsaProvenanceV1: + $ref: '#/components/schemas/InTotoSlsaProvenanceV1' + description: >- + In-Toto Slsa Provenance V1 represents a slsa provenance meeting the + slsa spec, wrapped in an in-toto statement. This allows for direct + jsonification of a to-spec in-toto slsa statement with a to-spec + slsa provenance. + provenance: + $ref: '#/components/schemas/BuildProvenance' + description: The actual provenance for the build. + provenanceBytes: + description: >- + Serialized JSON representation of the provenance, used in generating + the build signature in the corresponding build note. After verifying + the signature, `provenance_bytes` can be unmarshalled and compared + to the provenance to confirm that it is unchanged. A base64-encoded + string representation of the provenance bytes is used for the + signature in order to interoperate with openssl which expects this + format for signature verification. The serialized form is captured + both to avoid ambiguity in how the provenance is marshalled to json + as well to prevent incompatibilities with future changes. type: string + intotoProvenance: + $ref: '#/components/schemas/InTotoProvenance' description: >- - Provides information about the authority of the issuing party to - release the document, in particular, the party's constituency and - responsibilities or other obligations. - ContaineranalysisGoogleDevtoolsCloudbuildV1Build: + Deprecated. See InTotoStatement for the replacement. In-toto + Provenance representation as defined in spec. + description: Details of a build occurrence. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build + Location: properties: - serviceAccount: - type: string + path: description: >- - IAM service account whose credentials will be used at build runtime. - Must be of the format - `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be - email address or uniqueId of the service account. - statusDetail: - description: Output only. Customer-readable message about the current status. + The path from which we gathered that this package/version is + installed. type: string - readOnly: true - finishTime: - format: google-datetime + cpeUri: type: string - readOnly: true description: >- - Output only. Time at which execution of the build was finished. The - difference between finish_time and start_time is the duration of the - build's execution. - logsBucket: + Deprecated. The CPE URI in [CPE + format](https://cpe.mitre.org/specification/) + version: + $ref: '#/components/schemas/Version' + description: Deprecated. The version installed at this location. + description: >- + An occurrence of a particular package installation found within a + system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. + type: object + id: Location + Note: + description: A type of analysis that can be done for a resource. + properties: + shortDescription: + description: A one sentence description of this note. type: string + updateTime: description: >- - Cloud Storage bucket where logs should be written (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Logs file names will be of the format - `${logs_bucket}/log-${build_id}.txt`. - steps: - description: Required. The operations to be performed on the workspace. + Output only. The time this note was last updated. This field can be + used as a filter in list requests. + format: google-datetime + type: string + discovery: + $ref: '#/components/schemas/DiscoveryNote' + description: A note describing the initial analysis of a resource. + sbomReference: + $ref: '#/components/schemas/SBOMReferenceNote' + description: A note describing an SBOM reference. + deployment: + $ref: '#/components/schemas/DeploymentNote' + description: A note describing something that can be deployed. + relatedUrl: type: array items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - availableSecrets: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - description: Secrets and secret environment variables. - source: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source - description: Optional. The location of the source files to build. - sourceProvenance: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance - description: Output only. A permanent fixed identifier for source. - readOnly: true - artifacts: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - description: >- - Artifacts produced by the build that should be uploaded upon - successful completion of all build steps. - warnings: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning - readOnly: true - description: >- - Output only. Non-fatal problems encountered during the execution of - the build. + $ref: '#/components/schemas/RelatedUrl' + description: URLs associated with this note. + dsseAttestation: + description: A note describing a dsse attestation note. + $ref: '#/components/schemas/DSSEAttestationNote' + relatedNoteNames: + description: Other notes related to this note. type: array - timing: - additionalProperties: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: >- - Output only. Stores timing information for phases of the build. - Valid keys are: * BUILD: time to execute all build steps. * PUSH: - time to push all artifacts including docker images and non docker - artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time - to set up build. If the build does not specify source or images, - these keys will not be included. - type: object - readOnly: true - images: - description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images are pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the `Build` resource's results field. If any of the images - fail to be pushed, the build status is marked `FAILURE`. items: type: string - type: array - substitutions: - description: Substitutions data for `Build` resource. - additionalProperties: - type: string - type: object - results: - description: Output only. Results of the build. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results - readOnly: true - startTime: - type: string + createTime: format: google-datetime - description: Output only. Time at which execution of the build was started. - readOnly: true - options: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions - description: Special options for this build. - status: - enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. type: string - description: Output only. Status of the build. - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED - readOnly: true - gitConfig: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - description: Optional. Configuration for git operations. - approval: description: >- - Output only. Describes this build's approval configuration, status, - and result. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - readOnly: true - buildTriggerId: - readOnly: true + Output only. The time this note was created. This field can be used + as a filter in list requests. + compliance: + description: A note describing a compliance check. + $ref: '#/components/schemas/ComplianceNote' + package: + description: A note describing a package hosted by various package managers. + $ref: '#/components/schemas/PackageNote' + longDescription: + description: A detailed description of this note. type: string + vulnerability: + $ref: '#/components/schemas/VulnerabilityNote' + description: A note describing a package vulnerability. + build: + description: A note describing build provenance for a verifiable build. + $ref: '#/components/schemas/BuildNote' + upgrade: + $ref: '#/components/schemas/UpgradeNote' + description: A note describing available package upgrades. + image: + $ref: '#/components/schemas/ImageNote' + description: A note describing a base image. + kind: description: >- - Output only. The ID of the `BuildTrigger` that triggered this build, - if it was triggered automatically. - failureInfo: - readOnly: true - description: >- - Output only. Contains information about the build when - status=FAILURE. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo - createTime: + Output only. The type of analysis. This field can be used as a + filter in list requests. + enumDescriptions: + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE type: string - description: >- - Output only. Time at which the request to create the build was - received. - readOnly: true + vulnerabilityAssessment: + description: A note describing a vulnerability assessment. + $ref: '#/components/schemas/VulnerabilityAssessmentNote' + expirationTime: + type: string + description: Time of expiration for this note. Empty if note does not expire. format: google-datetime - tags: - items: - type: string - description: Tags for annotation of a `Build`. These are not docker tags. - type: array + attestation: + $ref: '#/components/schemas/AttestationNote' + description: A note describing an attestation role. name: - readOnly: true - type: string description: >- - Output only. The 'Build' name with format: - `projects/{project}/locations/{location}/builds/{build}`, where - {build} is a unique identifier generated by the service. - logUrl: - readOnly: true - description: Output only. URL to logs for this build in Google Cloud Console. - type: string - projectId: - type: string - description: Output only. ID of the project. - readOnly: true - queueTtl: + Output only. The name of the note in the form of + `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. type: string + type: object + id: Note + Source: + description: Source describes the location of the source used for the build. + properties: + additionalContexts: description: >- - TTL in queue for this build. If provided and the build is enqueued - longer than this value, the build will expire and the build status - will be `EXPIRED`. The TTL starts ticking from create_time. - format: google-duration - id: + If provided, some of the source code used for the build may be found + in these locations, in the case where the source repository had + multiple remotes or submodules. This list will not include the + context specified in the context field. + type: array + items: + $ref: '#/components/schemas/SourceContext' + context: + $ref: '#/components/schemas/SourceContext' + description: >- + If provided, the source code used for the build came from this + location. + fileHashes: + additionalProperties: + $ref: '#/components/schemas/FileHashes' + type: object + description: >- + Hash(es) of the build source, which can be used to verify that the + original source integrity was maintained in the build. The keys to + this map are file paths used as build source and the values contain + the hash values for those files. If the build source came in a + single package such as a gzipped tarfile (.tar.gz), the FileHash + will be for the single path to that file. + artifactStorageSourceUri: + description: >- + If provided, the input binary artifacts for the build came from this + location. type: string + type: object + id: Source + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + properties: + paths: + description: Path globs used to match files in the build's workspace. + type: array + items: + type: string + timing: + description: >- + Output only. Stores timing information for pushing all artifact + objects. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan readOnly: true - description: Output only. Unique identifier of the build. - timeout: - format: google-duration + location: description: >- - Amount of time that this build should be allowed to run, to second - granularity. If this amount of time elapses, work on the build will - cease and the build status will be `TIMEOUT`. `timeout` starts - ticking from `startTime`. Default time is 60 minutes. + Cloud Storage bucket and optional object path, in the form + "gs://bucket/path/to/somewhere/". (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Files in the workspace matching any path pattern will be uploaded to + Cloud Storage with this location as a prefix. type: string - secrets: - items: + description: >- + Files in the workspace to upload to Cloud Storage upon successful + completion of all build steps. + ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: + properties: + resolvedRepoSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + description: >- + A copy of the build's `source.repo_source`, if exists, with any + revisions resolved. + resolvedGitSource: + description: >- + Output only. A copy of the build's `source.git_source`, if exists, + with any revisions resolved. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + fileHashes: + description: >- + Output only. Hash(es) of the build source, which can be used to + verify that the original source integrity was maintained in the + build. Note that `FileHashes` will only be populated if + `BuildOptions` has requested a `SourceProvenanceHash`. The keys to + this map are file paths used as build source and the values contain + the hash values for those files. If the build source came in a + single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` + will be for the single path to that file. + readOnly: true + type: object + additionalProperties: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret - type: array + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + resolvedStorageSourceManifest: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest description: >- - Secrets to decrypt using Cloud Key Management Service. Note: Secret - Manager is the recommended technique for managing sensitive data - with Cloud Build. Use `available_secrets` to configure builds to - access secrets from Secret Manager. For instructions, see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets + A copy of the build's `source.storage_source_manifest`, if exists, + with any revisions resolved. This feature is in Preview. + resolvedStorageSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + description: >- + A copy of the build's `source.storage_source`, if exists, with any + generations resolved. + resolvedConnectedRepository: + description: >- + Output only. A copy of the build's `source.connected_repository`, if + exists, with any revisions resolved. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance description: >- - A build resource in the Cloud Build API. At a high level, a `Build` - describes where to find source code, how to build it (for example, the - builder image to run on the source), and where to store the built - artifacts. Fields can include the following variables, which will be - expanded when the build is created: - $PROJECT_ID: the project ID of the - build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: - the location/region of the build. - $BUILD_ID: the autogenerated ID of - the build. - $REPO_NAME: the source repository name specified by - RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or - $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the - specified branch or tag. - $SHORT_SHA: first 7 characters of - $REVISION_ID or $COMMIT_SHA. - TestIamPermissionsResponse: - id: TestIamPermissionsResponse + Provenance of the source. Ways to find the original source, or verify + that some source was used for this build. type: object - description: Response message for `TestIamPermissions` method. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: + type: object + description: An image built by the pipeline. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage properties: - permissions: - items: - type: string - type: array + pushTiming: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - WindowsUpdate: - id: WindowsUpdate - description: >- - Windows Update represents the metadata about the update for the Windows - operating system. The fields in this message come from the Windows - Update API documented at - https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. + Output only. Stores timing information for pushing the specified + image. + digest: + type: string + description: Docker Registry 2.0 digest. + name: + type: string + description: >- + Name used to push the container image to Google Container Registry, + as presented to `docker push`. + ExportSBOMResponse: type: object + id: ExportSBOMResponse + description: The response from a call to ExportSBOM. properties: - title: - type: string - description: The localized title of the update. - categories: - description: The list of categories to which the update belongs. - items: - $ref: '#/components/schemas/Category' - type: array - identity: - description: Required - The unique identifier for the update. - $ref: '#/components/schemas/Identity' - description: - description: The localized description of the update. + discoveryOccurrence: + description: >- + The name of the discovery occurrence in the form + "projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to + track the progress of the SBOM export. type: string - kbArticleIds: - type: array + BuildStep: + type: object + description: 'A step in the build pipeline. Next ID: 21' + id: BuildStep + properties: + waitFor: description: >- - The Microsoft Knowledge Base article IDs that are associated with - the update. + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. + type: array items: type: string - lastPublishedTimestamp: - description: The last published timestamp of the update. - format: google-datetime - type: string - supportUrl: - description: The hyperlink to the support information for the update. + name: type: string - Occurrence: - description: An instance of an analysis type that has been found on a resource. - id: Occurrence - properties: - resourceUri: description: >- - Required. Immutable. A URI that represents the resource for which - the occurrence applies. For example, - `https://gcr.io/project/image@sha256:123abc` for a Docker image. + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. + script: + description: >- + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. type: string - discovery: - description: Describes when a resource was discovered. - $ref: '#/components/schemas/DiscoveryOccurrence' - image: - $ref: '#/components/schemas/ImageOccurrence' + volumes: description: >- - Describes how this resource derives from the basis in the associated - note. - vulnerability: - description: Describes a security vulnerability. - $ref: '#/components/schemas/VulnerabilityOccurrence' - package: - $ref: '#/components/schemas/PackageOccurrence' - description: Describes the installation of a package on the linked resource. - attestation: - $ref: '#/components/schemas/AttestationOccurrence' - description: Describes an attestation of an artifact. - build: - description: Describes a verifiable build. - $ref: '#/components/schemas/BuildOccurrence' - kind: + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon + completion of the build, volumes and their contents are discarded. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + items: + $ref: '#/components/schemas/Volume' + type: array + timeout: + type: string + description: >- + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. + format: google-duration + entrypoint: + description: >- + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. + type: string + timing: + description: >- + Output only. Stores timing information for executing this build + step. + $ref: '#/components/schemas/TimeSpan' + allowFailure: + type: boolean + description: >- + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. + exitCode: + description: Output only. Return code from running the step. + format: int32 + type: integer + status: + enumDescriptions: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build has been received and is being queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE + - STATUS_UNKNOWN + - PENDING + - QUEUING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + type: string + description: >- + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. + id: + description: >- + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. + type: string + env: + items: + type: string + description: >- + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + type: array + allowExitCodes: + items: + format: int32 + type: integer + description: >- + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. + type: array + secretEnv: + description: >- + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. + items: + type: string + type: array + pullTiming: + $ref: '#/components/schemas/TimeSpan' + description: >- + Output only. Stores timing information for pulling this build step's + builder image only. + dir: + description: >- + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. + type: string + args: + type: array + items: + type: string + description: >- + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. + automapSubstitutions: + type: boolean + description: >- + Option to include built-in and custom substitutions as env variables + for this build step. This option will override the global option in + BuildOption. + BuildNote: + properties: + builderVersion: + description: >- + Required. Immutable. Version of the builder which produced this + build. + type: string + id: BuildNote + type: object + description: >- + Note holding the version of the provider's builder and the signature of + the provenance message in the build details occurrence. + Artifact: + properties: + id: + description: >- + Artifact ID, if any; for container images, this will be a URL by + digest like `gcr.io/projectID/imagename@sha256:123456`. + type: string + names: + items: + type: string + type: array + description: >- + Related artifact names. This may be the path to a binary or jar + file, or in the case of a container build, the name used to push the + container image to Google Container Registry, as presented to + `docker push`. Note that a single Artifact ID can have multiple + names, for example if two tags are applied to one image. + checksum: + type: string + description: >- + Hash or checksum value of a binary, or Docker Registry 2.0 digest of + a container. + description: Artifact describes a build product. + type: object + id: Artifact + DiscoveryNote: + description: >- + A note that indicates a type of analysis a provider would perform. This + note exists in a provider's project. A `Discovery` occurrence is created + in a consumer's project at the start of analysis. + type: object + id: DiscoveryNote + properties: + analysisKind: enumDescriptions: - Default value. This value is unused. - The note and occurrence represent a package vulnerability. @@ -2148,438 +2766,605 @@ components: - This represents an SBOM Reference. type: string description: >- - Output only. This explicitly denotes which of the occurrence details - are specified. This field can be used as a filter in list requests. - updateTime: + Required. Immutable. The kind of analysis that is handled by this + discovery. + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE + CloudStorageLocation: + properties: {} + id: CloudStorageLocation + type: object + description: >- + Empty placeholder to denote that this is a Google Cloud Storage export + request. + GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: + properties: + buildInvocationId: + type: string + buildStartedOn: format: google-datetime - description: Output only. The time this occurrence was last updated. type: string - createTime: + buildFinishedOn: format: google-datetime type: string - description: Output only. The time this occurrence was created. - compliance: - description: Describes a compliance violation on a linked resource. - $ref: '#/components/schemas/ComplianceOccurrence' - remediation: + completeness: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' + reproducible: + type: boolean + description: Other properties of the build. + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata + type: object + RelatedUrl: + type: object + description: Metadata for any related URL information. + properties: + url: type: string - description: A description of actions that can be taken to remedy the note. - sbomReference: - $ref: '#/components/schemas/SBOMReferenceOccurrence' - description: Describes a specific SBOM reference occurrences. - name: + description: Specific URL associated with the resource. + label: + description: Label to describe usage of the URL. type: string + id: RelatedUrl + Status: + type: object + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + properties: + details: + type: array description: >- - Output only. The name of the occurrence in the form of - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - envelope: - description: https://github.com/secure-systems-lab/dsse - $ref: '#/components/schemas/Envelope' - upgrade: - description: Describes an available package upgrade on the linked resource. - $ref: '#/components/schemas/UpgradeOccurrence' - dsseAttestation: - description: Describes an attestation of an artifact using dsse. - $ref: '#/components/schemas/DSSEAttestationOccurrence' - deployment: - $ref: '#/components/schemas/DeploymentOccurrence' - description: Describes the deployment of an artifact on a runtime. - noteName: - description: >- - Required. Immutable. The analysis note associated with this - occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - This field can be used as a filter in list requests. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + message: type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + TestIamPermissionsRequest: + properties: + permissions: + type: array + items: + type: string + 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). type: object - Layer: + description: Request message for `TestIamPermissions` method. + id: TestIamPermissionsRequest + AttestationNote: + description: >- + Note kind that represents a logical attestation "role" or "authority". + For example, an organization might have one `Authority` for "QA" and one + for "build". This note is intended to act strictly as a grouping + mechanism for the attached occurrences (Attestations). This grouping + mechanism also provides a security boundary, since IAM ACLs gate the + ability for a principle to attach an occurrence to a given note. It also + provides a single point of lookup to find all attached attestation + occurrences, even if they don't all live in the same project. type: object - description: Layer holds metadata specific to a layer of a Docker image. properties: - directive: - type: string + hint: + $ref: '#/components/schemas/Hint' + description: Hint hints at the purpose of the attestation authority. + id: AttestationNote + License: + type: object + properties: + expression: description: >- - Required. The recovered Dockerfile directive used to construct this - layer. See https://docs.docker.com/engine/reference/builder/ for - more information. - arguments: + Often a single license can be used to represent the licensing terms. + Sometimes it is necessary to include a choice of one or more + licenses or some combination of license identifiers. Examples: + "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later + WITH Bison-exception-2.2". type: string - description: The recovered arguments to the Dockerfile directive. - id: Layer - Note: - description: A type of analysis that can be done for a resource. + comments: + description: Comments + type: string + description: License information. + id: License + KnowledgeBase: + id: KnowledgeBase type: object properties: - longDescription: - type: string - description: A detailed description of this note. - vulnerability: - $ref: '#/components/schemas/VulnerabilityNote' - description: A note describing a package vulnerability. - vulnerabilityAssessment: - description: A note describing a vulnerability assessment. - $ref: '#/components/schemas/VulnerabilityAssessmentNote' - discovery: - description: A note describing the initial analysis of a resource. - $ref: '#/components/schemas/DiscoveryNote' - kind: - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE + url: description: >- - Output only. The type of analysis. This field can be used as a - filter in list requests. + A link to the KB in the [Windows update catalog] + (https://www.catalog.update.microsoft.com/). + type: string + name: type: string + description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). + AliasContext: + description: An alias to a repo revision. + type: object + properties: + kind: enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. + - Unknown. + - Git tag. + - Git branch. - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. - dsseAttestation: - description: A note describing a dsse attestation note. - $ref: '#/components/schemas/DSSEAttestationNote' - shortDescription: - description: A one sentence description of this note. + Used to specify non-standard aliases. For example, if a Git repo + has a ref named "refs/foo/bar". + description: The alias kind. + enum: + - KIND_UNSPECIFIED + - FIXED + - MOVABLE + - OTHER type: string - build: - description: A note describing build provenance for a verifiable build. - $ref: '#/components/schemas/BuildNote' - updateTime: + name: + description: The alias name. + type: string + id: AliasContext + Product: + id: Product + properties: + id: type: string - format: google-datetime description: >- - Output only. The time this note was last updated. This field can be - used as a filter in list requests. + Token that identifies a product so that it can be referred to from + other parts in the document. There is no predefined format as long + as it uniquely identifies a group in the context of the current + document. name: + description: Name of the product. + type: string + genericUri: type: string description: >- - Output only. The name of the note in the form of - `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - createTime: - format: google-datetime + Contains a URI which is vendor-specific. Example: The artifact + repository URL of an image. + description: >- + Product contains information about a product and how to uniquely + identify it. + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1Source: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source + description: Location of the source in a supported storage service. + properties: + developerConnectConfig: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + description: If provided, get the source from this Developer Connect config. + storageSourceManifest: description: >- - Output only. The time this note was created. This field can be used - as a filter in list requests. - type: string - relatedNoteNames: - description: Other notes related to this note. - items: - type: string - type: array - compliance: - description: A note describing a compliance check. - $ref: '#/components/schemas/ComplianceNote' - sbomReference: - $ref: '#/components/schemas/SBOMReferenceNote' - description: A note describing an SBOM reference. - package: - description: A note describing a package hosted by various package managers. - $ref: '#/components/schemas/PackageNote' - upgrade: - $ref: '#/components/schemas/UpgradeNote' - description: A note describing available package upgrades. - image: - $ref: '#/components/schemas/ImageNote' - description: A note describing a base image. - attestation: - $ref: '#/components/schemas/AttestationNote' - description: A note describing an attestation role. - deployment: - $ref: '#/components/schemas/DeploymentNote' - description: A note describing something that can be deployed. - relatedUrl: - description: URLs associated with this note. - items: - $ref: '#/components/schemas/RelatedUrl' - type: array - expirationTime: - format: google-datetime - type: string - description: Time of expiration for this note. Empty if note does not expire. - id: Note - GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: - properties: - uri: - type: string - entryPoint: + If provided, get the source from this manifest in Cloud Storage. + This feature is in Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + storageSource: + description: If provided, get the source from this location in Cloud Storage. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + connectedRepository: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + description: >- + Optional. If provided, get the source from this 2nd-gen Google Cloud + Build repository resource. + repoSource: + description: >- + If provided, get the source from this location in a Cloud Source + Repository. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + gitSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + description: If provided, get the source from this Git repository. + SbomReferenceIntotoPredicate: + properties: + location: type: string + description: The location of the SBOM. digest: type: object + description: A map of algorithm to digest of the contents of the SBOM. additionalProperties: type: string - id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource - description: >- - Describes where the config file that kicked off the build came from. - This is effectively a pointer to the source where buildConfig came from. + referrerId: + type: string + description: The person or system referring this predicate to the consumer. + mimeType: + type: string + description: The mime type of the SBOM. type: object - ComplianceVersion: - description: >- - Describes the CIS benchmark version that is applicable to a given OS and - os version. + description: A predicate which describes the SBOM being referenced. + id: SbomReferenceIntotoPredicate + ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: properties: - cpeUri: - type: string + invertRegex: + type: boolean description: >- - The CPE URI (https://cpe.mitre.org/specification/) this benchmark is - applicable to. - benchmarkDocument: + Optional. Only trigger a build if the revision regex does NOT match + the revision regex. + branchName: description: >- - The name of the document that defines this benchmark, e.g. "CIS - Container-Optimized OS". + Regex matching branches to build. The syntax of the regular + expressions accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax type: string - version: + projectId: + description: >- + Optional. ID of the project that owns the Cloud Source Repository. + If omitted, the project ID requesting the build is assumed. + type: string + commitSha: type: string + description: Explicit commit SHA to build. + substitutions: + type: object description: >- - The version of the benchmark. This is set to the version of the - OS-specific CIS document the benchmark is defined in. - id: ComplianceVersion - type: object - VulnerabilityOccurrencesSummary: - type: object - id: VulnerabilityOccurrencesSummary - properties: - counts: - type: array - items: - $ref: '#/components/schemas/FixableTotalByDigest' + Optional. Substitutions to use in a triggered build. Should only be + used with RunBuildTrigger + additionalProperties: + type: string + dir: description: >- - A listing by resource of the number of fixable and total - vulnerabilities. - description: >- - A summary of how many vulnerability occurrences there are per resource - and severity type. - ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: + Optional. Directory, relative to the source root, in which to run + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. + type: string + tagName: + type: string + description: >- + Regex matching tags to build. The syntax of the regular expressions + accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax + repoName: + type: string + description: Required. Name of the Cloud Source Repository. type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + description: Location of the source in a Google Cloud Source Repository. + InTotoStatement: description: >- - Container message for hashes of byte content of files, used in - SourceProvenance messages to verify integrity of source input to the - build. + Spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement The + serialized InTotoStatement will be stored as Envelope.payload. + Envelope.payloadType is always "application/vnd.in-toto+json". + id: InTotoStatement properties: - fileHash: - description: Collection of file hashes. - type: array + subject: items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash - id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: - description: >- - BuildApproval describes a build's approval configuration, state, and - result. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - properties: - result: - description: Output only. Result of manual approval for this Build. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - state: - enumDescriptions: - - Default enum type. This should not be used. - - Build approval is pending. - - Build approval has been approved. - - Build approval has been rejected. - - Build was cancelled while it was still pending approval. + $ref: '#/components/schemas/Subject' + type: array + provenance: + $ref: '#/components/schemas/InTotoProvenance' + slsaProvenance: + $ref: '#/components/schemas/SlsaProvenance' + slsaProvenanceZeroTwo: + $ref: '#/components/schemas/SlsaProvenanceZeroTwo' + predicateType: + type: string + description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' + _type: + description: Always `https://in-toto.io/Statement/v0.1`. type: string - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - - CANCELLED - description: Output only. The state of this build's approval. - readOnly: true - config: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - description: Output only. Configuration for manual approval of this build. type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: + CVSS: description: >- - ApprovalResult describes the decision and associated metadata of a - manual approval of a build. + Common Vulnerability Scoring System. For details, see + https://www.first.org/cvss/specification-document This is a message we + will try to use for storing various versions of CVSS rather than making + a separate proto for storing a specific version. properties: - comment: - type: string - description: Optional. An optional comment for this manual approval result. - approverAccount: + baseScore: + description: The base score is a function of the base metric scores. + type: number + format: float + integrityImpact: type: string - description: >- - Output only. Email of the user that called the ApproveBuild API to - approve or reject a build at the time that the API was called. - readOnly: true - decision: - description: Required. The decision of this manual approval. enum: - - DECISION_UNSPECIFIED - - APPROVED - - REJECTED - type: string + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE enumDescriptions: - - Default enum type. This should not be used. - - Build is approved. - - Build is rejected. - url: + - '' + - '' + - '' + - '' + - '' + - '' + availabilityImpact: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' type: string - description: >- - Optional. An optional URL tied to this manual approval result. This - field is essentially the same as comment, except that it will be - rendered by the UI differently. An example use case is a link to an - external job that approved this Build. - approvalTime: - readOnly: true - type: string - format: google-datetime - description: Output only. The time when the approval decision was made. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - BatchCreateOccurrencesRequest: - properties: - occurrences: - description: Required. The occurrences to create. Max allowed length is 1000. - items: - $ref: '#/components/schemas/Occurrence' - type: array - description: Request to create occurrences in batch. - id: BatchCreateOccurrencesRequest - type: object - ListOccurrencesResponse: - type: object - properties: - occurrences: - type: array - items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences requested. - nextPageToken: + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + scope: + enumDescriptions: + - '' + - '' + - '' + enum: + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED type: string + attackVector: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + enum: + - ATTACK_VECTOR_UNSPECIFIED + - ATTACK_VECTOR_NETWORK + - ATTACK_VECTOR_ADJACENT + - ATTACK_VECTOR_LOCAL + - ATTACK_VECTOR_PHYSICAL description: >- - The next pagination token in the list response. It should be used as - `page_token` for the following request. An empty value means no more - results. - id: ListOccurrencesResponse - description: Response for listing occurrences. - ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: - description: >- - Pairs a set of secret environment variables containing encrypted values - with the Cloud KMS key to use to decrypt the value. Note: Use - `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with - `secret`. For instructions see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secret - properties: - kmsKeyName: + Base Metrics Represents the intrinsic characteristics of a + vulnerability that are constant over time and across user + environments. type: string - description: Cloud KMS key name to use to decrypt these envs. - secretEnv: - description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. - additionalProperties: - type: string - format: byte - type: object - GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - properties: - parameters: - type: boolean - materials: - type: boolean - environment: - type: boolean + userInteraction: + enumDescriptions: + - '' + - '' + - '' + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED + type: string + attackComplexity: + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH + - ATTACK_COMPLEXITY_MEDIUM + enumDescriptions: + - '' + - '' + - '' + - '' + type: string + impactScore: + type: number + format: float + privilegesRequired: + enum: + - PRIVILEGES_REQUIRED_UNSPECIFIED + - PRIVILEGES_REQUIRED_NONE + - PRIVILEGES_REQUIRED_LOW + - PRIVILEGES_REQUIRED_HIGH + enumDescriptions: + - '' + - '' + - '' + - '' + type: string + authentication: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - AUTHENTICATION_UNSPECIFIED + - AUTHENTICATION_MULTIPLE + - AUTHENTICATION_SINGLE + - AUTHENTICATION_NONE + type: string + exploitabilityScore: + format: float + type: number + confidentialityImpact: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + type: string + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + id: CVSS type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness - License: + ContaineranalysisGoogleDevtoolsCloudbuildV1Build: type: object - description: License information. - id: License + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build properties: - comments: + options: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + description: Special options for this build. + queueTtl: type: string - description: Comments - expression: + format: google-duration + description: >- + TTL in queue for this build. If provided and the build is enqueued + longer than this value, the build will expire and the build status + will be `EXPIRED`. The TTL starts ticking from create_time. + finishTime: type: string description: >- - Often a single license can be used to represent the licensing terms. - Sometimes it is necessary to include a choice of one or more - licenses or some combination of license identifiers. Examples: - "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later - WITH Bison-exception-2.2". - BuildStep: - id: BuildStep - properties: - allowExitCodes: + Output only. Time at which execution of the build was finished. The + difference between finish_time and start_time is the duration of the + build's execution. + format: google-datetime + readOnly: true + timeout: + format: google-duration + type: string description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. + Amount of time that this build should be allowed to run, to second + granularity. If this amount of time elapses, work on the build will + cease and the build status will be `TIMEOUT`. `timeout` starts + ticking from `startTime`. Default time is 60 minutes. + logUrl: + readOnly: true + description: Output only. URL to logs for this build in Google Cloud Console. + type: string + source: + description: Optional. The location of the source files to build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source + results: + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results + description: Output only. Results of the build. + sourceProvenance: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + description: Output only. A permanent fixed identifier for source. + readOnly: true + tags: items: - format: int32 - type: integer + type: string type: array - waitFor: + description: Tags for annotation of a `Build`. These are not docker tags. + id: + description: Output only. Unique identifier of the build. + type: string + readOnly: true + createTime: + format: google-datetime + readOnly: true + type: string description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. + Output only. Time at which the request to create the build was + received. + statusDetail: + type: string + readOnly: true + description: Output only. Customer-readable message about the current status. + availableSecrets: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + description: Secrets and secret environment variables. + images: items: type: string type: array - status: - type: string - enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build has been received and is being queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. + A list of images to be pushed upon the successful completion of all + build steps. The images are pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the `Build` resource's results field. If any of the images + fail to be pushed, the build status is marked `FAILURE`. + logsBucket: + type: string + description: >- + Cloud Storage bucket where logs should be written (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Logs file names will be of the format + `${logs_bucket}/log-${build_id}.txt`. + projectId: + readOnly: true + type: string + description: Output only. ID of the project. + buildTriggerId: + type: string + description: >- + Output only. The ID of the `BuildTrigger` that triggered this build, + if it was triggered automatically. + readOnly: true + secrets: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret + type: array + description: >- + Secrets to decrypt using Cloud Key Management Service. Note: Secret + Manager is the recommended technique for managing sensitive data + with Cloud Build. Use `available_secrets` to configure builds to + access secrets from Secret Manager. For instructions, see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets + timing: + description: >- + Output only. Stores timing information for phases of the build. + Valid keys are: * BUILD: time to execute all build steps. * PUSH: + time to push all artifacts including docker images and non docker + artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time + to set up build. If the build does not specify source or images, + these keys will not be included. + readOnly: true + type: object + additionalProperties: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + gitConfig: + description: Optional. Configuration for git operations. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + status: + enumDescriptions: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. enum: - STATUS_UNKNOWN - PENDING - - QUEUING - QUEUED - WORKING - SUCCESS @@ -2588,1548 +3373,775 @@ components: - TIMEOUT - CANCELLED - EXPIRED - volumes: - type: array - items: - $ref: '#/components/schemas/Volume' - description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - args: + type: string + readOnly: true + description: Output only. Status of the build. + steps: type: array - description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. + description: Required. The operations to be performed on the workspace. items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep + substitutions: + additionalProperties: type: string - dir: - type: string - description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. - automapSubstitutions: - description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - type: boolean - timeout: + type: object + description: Substitutions data for `Build` resource. + startTime: + readOnly: true + description: Output only. Time at which execution of the build was started. type: string - format: google-duration - description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. - entrypoint: - description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. + format: google-datetime + serviceAccount: type: string - allowFailure: description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - type: boolean - id: + IAM service account whose credentials will be used at build runtime. + Must be of the format + `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be + email address or uniqueId of the service account. + failureInfo: + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. - type: string - timing: + Output only. Contains information about the build when + status=FAILURE. + warnings: description: >- - Output only. Stores timing information for executing this build - step. - $ref: '#/components/schemas/TimeSpan' - secretEnv: + Output only. Non-fatal problems encountered during the execution of + the build. + readOnly: true items: - type: string + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning type: array + artifacts: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - exitCode: - description: Output only. Return code from running the step. - type: integer - format: int32 - script: - type: string - description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. - env: - items: - type: string - description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - type: array - pullTiming: + Artifacts produced by the build that should be uploaded upon + successful completion of all build steps. + approval: + readOnly: true description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - $ref: '#/components/schemas/TimeSpan' + Output only. Describes this build's approval configuration, status, + and result. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval name: type: string description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. - type: object - description: 'A step in the build pipeline. Next ID: 21' - GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: + Output only. The 'Build' name with format: + `projects/{project}/locations/{location}/builds/{build}`, where + {build} is a unique identifier generated by the service. + readOnly: true description: >- - The collection of artifacts that influenced the build including sources, - dependencies, build tools, base images, and so on. - properties: - uri: - type: string - digest: - additionalProperties: - type: string - type: object + A build resource in the Cloud Build API. At a high level, a `Build` + describes where to find source code, how to build it (for example, the + builder image to run on the source), and where to store the built + artifacts. Fields can include the following variables, which will be + expanded when the build is created: - $PROJECT_ID: the project ID of the + build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: + the location/region of the build. - $BUILD_ID: the autogenerated ID of + the build. - $REPO_NAME: the source repository name specified by + RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - + $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or + $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the + specified branch or tag. - $SHORT_SHA: first 7 characters of + $REVISION_ID or $COMMIT_SHA. + Remediation: + id: Remediation type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial - FileHashes: - id: FileHashes description: >- - Container message for hashes of byte content of files, used in source - messages to verify integrity of source input to the build. - properties: - fileHash: - description: Required. Collection of file hashes. - items: - $ref: '#/components/schemas/Hash' - type: array - type: object - ResourceDescriptor: + Specifies details on how to handle (and presumably, fix) a + vulnerability. properties: - annotations: - additionalProperties: - type: any - type: object - mediaType: - type: string - content: - format: byte - type: string - downloadLocation: - type: string - digest: - additionalProperties: - type: string - type: object - name: - type: string - uri: - type: string - type: object - id: ResourceDescriptor - Source: - type: object - properties: - additionalContexts: - items: - $ref: '#/components/schemas/SourceContext' - type: array - description: >- - If provided, some of the source code used for the build may be found - in these locations, in the case where the source repository had - multiple remotes or submodules. This list will not include the - context specified in the context field. - context: - description: >- - If provided, the source code used for the build came from this - location. - $ref: '#/components/schemas/SourceContext' - fileHashes: - type: object - additionalProperties: - $ref: '#/components/schemas/FileHashes' - description: >- - Hash(es) of the build source, which can be used to verify that the - original source integrity was maintained in the build. The keys to - this map are file paths used as build source and the values contain - the hash values for those files. If the build source came in a - single package such as a gzipped tarfile (.tar.gz), the FileHash - will be for the single path to that file. - artifactStorageSourceUri: - description: >- - If provided, the input binary artifacts for the build came from this - location. - type: string - description: Source describes the location of the source used for the build. - id: Source - ProvenanceBuilder: - type: object - properties: - version: - type: object - additionalProperties: - type: string - id: - type: string - builderDependencies: - items: - $ref: '#/components/schemas/ResourceDescriptor' - type: array - id: ProvenanceBuilder - Subject: - properties: - digest: - description: >- - `"": ""` Algorithms can be e.g. sha256, sha512 See - https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet - type: object - additionalProperties: - type: string - name: - type: string - type: object - id: Subject - Digest: - properties: - digestBytes: - format: byte - type: string - description: Value of the digest. - algo: - description: '`SHA1`, `SHA512` etc.' - type: string - id: Digest - description: Digest information. - type: object - Version: - properties: - kind: - enumDescriptions: - - Unknown. - - A standard package version. - - A special version representing negative infinity. - - A special version representing positive infinity. - enum: - - VERSION_KIND_UNSPECIFIED - - NORMAL - - MINIMUM - - MAXIMUM - type: string - description: >- - Required. Distinguishes between sentinel MIN/MAX versions and normal - versions. - fullName: - description: >- - Human readable version string. This string is of the form :- and is - only set when kind is NORMAL. - type: string - revision: - description: The iteration of the package build from the above version. - type: string - name: - description: >- - Required only when version kind is NORMAL. The main part of the - version name. - type: string - inclusive: - description: >- - Whether this version is specifying part of an inclusive range. - Grafeas does not have the capability to specify version ranges; - instead we have fields that specify start version and end versions. - At times this is insufficient - we also need to specify whether the - version is included in the range or is excluded from the range. This - boolean is expected to be set to true when the version is included - in a range. - type: boolean - epoch: - description: Used to correct mistakes in the version numbering scheme. - type: integer - format: int32 - id: Version - description: Version contains structured information about the version of a package. - type: object - BuildOccurrence: - id: BuildOccurrence - type: object - properties: - inTotoSlsaProvenanceV1: - $ref: '#/components/schemas/InTotoSlsaProvenanceV1' - description: >- - In-Toto Slsa Provenance V1 represents a slsa provenance meeting the - slsa spec, wrapped in an in-toto statement. This allows for direct - jsonification of a to-spec in-toto slsa statement with a to-spec - slsa provenance. - intotoStatement: - $ref: '#/components/schemas/InTotoStatement' - description: >- - In-toto Statement representation as defined in spec. The - intoto_statement can contain any type of provenance. The serialized - payload of the statement can be stored and signed in the - Occurrence's envelope. - intotoProvenance: - description: >- - Deprecated. See InTotoStatement for the replacement. In-toto - Provenance representation as defined in spec. - $ref: '#/components/schemas/InTotoProvenance' - provenance: - description: The actual provenance for the build. - $ref: '#/components/schemas/BuildProvenance' - provenanceBytes: - description: >- - Serialized JSON representation of the provenance, used in generating - the build signature in the corresponding build note. After verifying - the signature, `provenance_bytes` can be unmarshalled and compared - to the provenance to confirm that it is unchanged. A base64-encoded - string representation of the provenance bytes is used for the - signature in order to interoperate with openssl which expects this - format for signature verification. The serialized form is captured - both to avoid ambiguity in how the provenance is marshalled to json - as well to prevent incompatibilities with future changes. - type: string - description: Details of a build occurrence. - SlsaMetadata: - id: SlsaMetadata - description: Other properties of the build. - type: object - properties: - buildInvocationId: - description: >- - Identifies the particular build invocation, which can be useful for - finding associated logs or other ad-hoc analysis. The value SHOULD - be globally unique, per in-toto Provenance spec. - type: string - completeness: - description: >- - Indicates that the builder claims certain fields in this message to - be complete. - $ref: '#/components/schemas/SlsaCompleteness' - reproducible: - description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. - type: boolean - buildFinishedOn: - type: string - description: The timestamp of when the build completed. - format: google-datetime - buildStartedOn: - description: The timestamp of when the build started. - format: google-datetime - type: string - SBOMReferenceNote: - properties: - format: - type: string - description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... - version: - type: string - description: >- - The version of the format that the SBOM takes. E.g. if the format is - spdx, the version may be 2.3. - id: SBOMReferenceNote - description: The note representing an SBOM reference. - type: object - DiscoveryNote: - id: DiscoveryNote - description: >- - A note that indicates a type of analysis a provider would perform. This - note exists in a provider's project. A `Discovery` occurrence is created - in a consumer's project at the start of analysis. - type: object - properties: - analysisKind: - description: >- - Required. Immutable. The kind of analysis that is handled by this - discovery. - enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. - - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE - type: string - InTotoProvenance: - type: object - id: InTotoProvenance - properties: - materials: - description: >- - The collection of artifacts that influenced the build including - sources, dependencies, build tools, base images, and so on. This is - considered to be incomplete unless metadata.completeness.materials - is true. Unset or null is equivalent to empty. - items: - type: string - type: array - metadata: - $ref: '#/components/schemas/Metadata' - builderConfig: - description: required - $ref: '#/components/schemas/BuilderConfig' - recipe: - description: >- - Identifies the configuration used for the build. When combined with - materials, this SHOULD fully describe the build, such that - re-running this recipe results in bit-for-bit identical output (if - the build is reproducible). required - $ref: '#/components/schemas/Recipe' - ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash - description: Container message for hash values. - properties: - value: - type: string - format: byte - description: The hash value. - type: - enum: - - NONE - - SHA256 - - MD5 - - SHA512 - description: The type of hash that was performed. - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. - type: string - type: object - Category: - description: The category to which the update belongs. - properties: - name: - type: string - description: The localized name of the category. - categoryId: - description: The identifier of the category. - type: string - id: Category - type: object - BuildDefinition: - id: BuildDefinition - properties: - buildType: - type: string - internalParameters: - additionalProperties: - type: any - description: Properties of the object. - type: object - externalParameters: - additionalProperties: - description: Properties of the object. - type: any - type: object - resolvedDependencies: - items: - $ref: '#/components/schemas/ResourceDescriptor' - type: array - type: object - SlsaProvenanceV1: - properties: - buildDefinition: - $ref: '#/components/schemas/BuildDefinition' - runDetails: - $ref: '#/components/schemas/RunDetails' - type: object - id: SlsaProvenanceV1 - description: >- - Keep in sync with schema at - https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto - Builder renamed to ProvenanceBuilder because of Java conflicts. - ComplianceOccurrence: - type: object - id: ComplianceOccurrence - description: >- - An indication that the compliance checks in the associated - ComplianceNote were not satisfied for particular resources or a - specified reason. - properties: - nonComplianceReason: - type: string - version: - $ref: '#/components/schemas/ComplianceVersion' - description: The OS and config version the benchmark was run on. - nonCompliantFiles: - type: array - items: - $ref: '#/components/schemas/NonCompliantFile' - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: - description: A step in the build pipeline. - properties: - waitFor: - type: array - description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. - items: - type: string - timing: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - description: >- - Output only. Stores timing information for executing this build - step. - script: - description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. - type: string - dir: - description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. - type: string - exitCode: - readOnly: true - format: int32 - type: integer - description: Output only. Return code from running the step. - automapSubstitutions: - description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - type: boolean - allowExitCodes: - description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. - type: array - items: - format: int32 - type: integer - args: - description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. - items: - type: string - type: array - entrypoint: - type: string - description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. - timeout: - format: google-duration - type: string - description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. - id: - description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. - type: string - pullTiming: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - name: - type: string - description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. - status: - enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED - readOnly: true - description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. - type: string - volumes: - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - env: - type: array - description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - items: - type: string - secretEnv: - items: - type: string - description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - type: array - allowFailure: - type: boolean - description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - type: object - DeploymentOccurrence: - id: DeploymentOccurrence - properties: - config: - type: string - description: Configuration used to create this deployment. - platform: - description: Platform hosting this deployment. - enum: - - PLATFORM_UNSPECIFIED - - GKE - - FLEX - - CUSTOM - enumDescriptions: - - Unknown. - - Google Container Engine. - - 'Google App Engine: Flexible Environment.' - - Custom user-defined platform. - type: string - deployTime: - format: google-datetime - description: Required. Beginning of the lifetime of this deployment. - type: string - undeployTime: - type: string - format: google-datetime - description: End of the lifetime of this deployment. - address: - description: Address of the runtime element hosting this deployment. - type: string - resourceUri: - type: array - description: >- - Output only. Resource URI for the artifact being deployed taken from - the deployable field with the same name. - items: - type: string - userEmail: - description: Identity of the user that triggered this deployment. - type: string - type: object - description: The period during which some deployable was active in a runtime. - Distribution: - properties: - latestVersion: - description: >- - The latest available version of this package in this distribution - channel. - $ref: '#/components/schemas/Version' - url: - description: The distribution channel-specific homepage for this package. - type: string - description: - type: string - description: The distribution channel-specific description of this package. - cpeUri: - description: >- - Required. The cpe_uri in [CPE - format](https://cpe.mitre.org/specification/) denoting the package - manager version distributing a package. - type: string - maintainer: - description: A freeform string denoting the maintainer of this package. - type: string - architecture: - type: string - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 - enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. - description: >- - The CPU architecture for which packages in this distribution channel - were built. - id: Distribution - description: >- - This represents a particular channel of distribution for a given - package. E.g., Debian's jessie-backports dpkg mirror. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: - description: >- - Pairs a set of secret environment variables mapped to encrypted values - with the Cloud KMS key to use to decrypt the value. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret - type: object - properties: - kmsKeyName: - type: string - description: >- - Resource name of Cloud KMS crypto key to decrypt the encrypted - value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* - envMap: - description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. - additionalProperties: - type: string - format: byte - type: object - Recipe: - id: Recipe - description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. - properties: - entryPoint: - description: >- - String identifying the entry point into the build. This is often a - path to a configuration file and/or a target label within that file. - The syntax and meaning are defined by recipe.type. For example, if - the recipe type were "make", then this would reference the directory - in which to run make as well as which target to use. - type: string - definedInMaterial: - type: string - description: >- - Index in materials containing the recipe steps that are not implied - by recipe.type. For example, if the recipe type were "make", then - this would point to the source containing the Makefile, not the make - program itself. Set to -1 if the recipe doesn't come from a - material, as zero is default unset value for int64. - format: int64 - environment: - type: array - description: >- - Any other builder-controlled inputs necessary for correctly - evaluating the recipe. Usually only needed for reproducing the build - but not evaluated as part of policy. Since the environment field can - greatly vary in structure, depending on the builder and recipe type, - this is of form "Any". - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: - description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. - type: string - arguments: - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: array - description: >- - Collection of all external inputs that influenced the build on top - of recipe.definedInMaterial and recipe.entryPoint. For example, if - the recipe type were "make", then this might be the flags passed to - make aside from the target, which is captured in recipe.entryPoint. - Since the arguments field can greatly vary in structure, depending - on the builder and recipe type, this is of form "Any". - type: object - Jwt: - type: object - id: Jwt - properties: - compactJwt: - type: string - description: >- - The compact encoding of a JWS, which is always three base64 encoded - strings joined by periods. For details, see: - https://tools.ietf.org/html/rfc7515.html#section-3.1 - Volume: - properties: - name: - type: string - description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. - path: - description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. - type: string - type: object - description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. Next ID: 3 - id: Volume - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: - description: ApprovalConfig describes configuration for manual approval of a build. - type: object - properties: - approvalRequired: - type: boolean - description: >- - Whether or not approval is needed. If this is set on a build, it - will become pending when created, and will need to be explicitly - approved to start. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - Identity: - id: Identity - properties: - revision: - format: int32 - description: The revision number of the update. - type: integer - updateId: - description: The revision independent identifier of the update. - type: string - type: object - description: The unique identifier of the update. - BatchCreateNotesResponse: - description: Response for creating notes in batch. - properties: - notes: - description: The notes that were created. - type: array - items: - $ref: '#/components/schemas/Note' - id: BatchCreateNotesResponse - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: - description: This config defines the location of a source through Developer Connect. - properties: - gitRepositoryLink: - description: >- - Required. The Developer Connect Git repository link, formatted as - `projects/*/locations/*/connections/*/gitRepositoryLink/*`. - type: string - dir: - type: string - description: >- - Required. Directory, relative to the source root, in which to run - the build. - revision: - description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. - type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig - type: object - SlsaProvenance: - type: object - id: SlsaProvenance - properties: - metadata: - $ref: '#/components/schemas/SlsaMetadata' - materials: - items: - $ref: '#/components/schemas/Material' - description: >- - The collection of artifacts that influenced the build including - sources, dependencies, build tools, base images, and so on. This is - considered to be incomplete unless metadata.completeness.materials - is true. Unset or null is equivalent to empty. - type: array - recipe: - $ref: '#/components/schemas/SlsaRecipe' - description: >- - Identifies the configuration used for the build. When combined with - materials, this SHOULD fully describe the build, such that - re-running this recipe results in bit-for-bit identical output (if - the build is reproducible). required - builder: - description: required - $ref: '#/components/schemas/SlsaBuilder' - DiscoveryOccurrence: - id: DiscoveryOccurrence - type: object - properties: - sbomStatus: - description: The status of an SBOM generation. - $ref: '#/components/schemas/SBOMStatus' - continuousAnalysis: - description: Whether the resource is continuously analyzed. - type: string - enum: - - CONTINUOUS_ANALYSIS_UNSPECIFIED - - ACTIVE - - INACTIVE + remediationUri: + $ref: '#/components/schemas/RelatedUrl' + description: Contains the URL where to obtain the remediation. + remediationType: enumDescriptions: - - Unknown. - - The resource is continuously analyzed. - - The resource is ignored for continuous analysis. - cpe: - description: The CPE of the resource being scanned. - type: string - analysisCompleted: - $ref: '#/components/schemas/AnalysisCompleted' - analysisStatusError: - $ref: '#/components/schemas/Status' - description: >- - When an error is encountered this will contain a LocalizedMessage - under details to show to the user. The LocalizedMessage is output - only and populated by the API. - analysisError: - items: - $ref: '#/components/schemas/Status' - type: array - description: >- - Indicates any errors encountered during analysis of a resource. - There could be 0 or more of these errors. - archiveTime: - format: google-datetime + - No remediation type specified. + - A MITIGATION is available. + - No fix is planned. + - Not available. + - A vendor fix is available. + - A workaround is available. type: string - readOnly: true - description: >- - Output only. The time occurrences related to this discovery - occurrence were archived. - analysisStatus: - enumDescriptions: - - Unknown. - - Resource is known but no action has been taken yet. - - Resource is being analyzed. - - Analysis has finished successfully. - - Analysis has completed. - - >- - Analysis has finished unsuccessfully, the analysis itself is in a - bad state. - - The resource is known not to be supported. - description: The status of discovery for the resource. + description: The type of remediation that can be applied. enum: - - ANALYSIS_STATUS_UNSPECIFIED - - PENDING - - SCANNING - - FINISHED_SUCCESS - - COMPLETE - - FINISHED_FAILED - - FINISHED_UNSUPPORTED - type: string - lastScanTime: - description: The last time this resource was scanned. - format: google-datetime - type: string - description: Provides information about the analysis status of a discovered resource. - ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. - properties: - path: - description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. - type: string - name: - type: string - description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: - description: HttpConfig is a configuration for HTTP related git operations. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - properties: - proxySecretVersionName: - type: string - description: >- - SecretVersion resource of the HTTP proxy URL. The Service Account - used in the build (either the default Service Account or - user-specified Service Account) should have - `secretmanager.versions.access` permissions on this secret. The - proxy URL should be in format `protocol://@]proxyhost[:port]`. - type: object - Policy: - type: object - properties: - version: - format: int32 - type: integer - description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - format: byte - type: string - bindings: + - REMEDIATION_TYPE_UNSPECIFIED + - MITIGATION + - NO_FIX_PLANNED + - NONE_AVAILABLE + - VENDOR_FIX + - WORKAROUND + details: description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - items: - $ref: '#/components/schemas/Binding' - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - ContaineranalysisGoogleDevtoolsCloudbuildV1Results: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results - description: Artifacts created by the build pipeline. + Contains a comprehensive human-readable discussion of the + remediation. + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: + description: Start and end times for a build execution phase. type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan properties: - artifactTiming: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: Time to push all non-container artifacts to Cloud Storage. - images: - description: Container images that were built as a part of the build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - type: array - buildStepImages: - type: array - description: >- - List of build step digests, in the order corresponding to build step - indices. - items: + startTime: + format: google-datetime + type: string + description: Start of time span. + endTime: + type: string + description: End of time span. + format: google-datetime + GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource + properties: + digest: + type: object + additionalProperties: type: string - mavenArtifacts: - description: >- - Maven artifacts uploaded to Artifact Registry at the end of the - build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact - type: array - numArtifacts: - format: int64 - description: >- - Number of non-container artifacts uploaded to Cloud Storage. Only - populated when artifacts are uploaded to Cloud Storage. + entryPoint: type: string - artifactManifest: + uri: type: string + type: object + description: >- + Describes where the config file that kicked off the build came from. + This is effectively a pointer to the source where buildConfig came from. + ExportSBOMRequest: + description: >- + The request to generate and export SBOM. Target must be specified for + the request. + id: ExportSBOMRequest + properties: + cloudStorageLocation: description: >- - Path to the artifact manifest for non-container artifacts uploaded - to Cloud Storage. Only populated when artifacts are uploaded to - Cloud Storage. - npmPackages: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage - type: array - description: Npm packages uploaded to Artifact Registry at the end of the build. - pythonPackages: - description: >- - Python artifacts uploaded to Artifact Registry at the end of the - build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage - type: array - buildStepOutputs: - items: - type: string - format: byte + Empty placeholder to denote that this is a Google Cloud Storage + export request. + $ref: '#/components/schemas/CloudStorageLocation' + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + description: A Maven artifact uploaded using the MavenArtifact directive. + properties: + uri: + type: string + description: URI of the uploaded artifact. + pushTiming: description: >- - List of build step outputs, produced by builder images, in the order - corresponding to build step indices. [Cloud - Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) - can produce this output by writing to `$BUILDER_OUTPUT/output`. Only - the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` - variable is read-only and can't be substituted. - type: array + Output only. Stores timing information for pushing the specified + artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true + fileHashes: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + description: Hash types and values of the Maven Artifact. ProjectRepoId: - type: object - id: ProjectRepoId + description: >- + Selects a repo using a Google Cloud Platform project ID (e.g., + winged-cargo-31) and a repo name within that project. properties: + projectId: + description: The ID of the project. + type: string repoName: type: string description: The name of the repo. Leave empty for the default repo. - projectId: + id: ProjectRepoId + type: object + ImageOccurrence: + id: ImageOccurrence + properties: + baseResourceUrl: + description: >- + Output only. This contains the base image URL for the derived image + occurrence. type: string - description: The ID of the project. - description: >- - Selects a repo using a Google Cloud Platform project ID (e.g., - winged-cargo-31) and a repo name within that project. - KnowledgeBase: + layerInfo: + items: + $ref: '#/components/schemas/Layer' + type: array + description: >- + This contains layer-specific metadata, if populated it has length + "distance" and is ordered with [distance] being the layer + immediately following the base image and [1] being the final layer. + fingerprint: + description: Required. The fingerprint of the derived image. + $ref: '#/components/schemas/Fingerprint' + distance: + description: >- + Output only. The number of layers by which this image differs from + the associated image basis. + format: int32 + type: integer type: object + description: >- + Details of the derived image portion of the DockerImage relationship. + This image would be produced from a Dockerfile with FROM . + WindowsDetail: properties: name: - description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). + description: Required. The name of this vulnerability. type: string - url: + description: + type: string + description: The description of this vulnerability. + cpeUri: + description: >- + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. type: string + fixingKbs: + items: + $ref: '#/components/schemas/KnowledgeBase' description: >- - A link to the KB in the [Windows update catalog] - (https://www.catalog.update.microsoft.com/). - id: KnowledgeBase - GetIamPolicyRequest: - id: GetIamPolicyRequest + Required. The names of the KBs which have hotfixes to mitigate this + vulnerability. Note that there may be multiple hotfixes (and thus + multiple KBs) that mitigate a given vulnerability. Currently any + listed KBs presence is considered a fix. + type: array + id: WindowsDetail + type: object + Material: + id: Material type: object - description: Request message for `GetIamPolicy` method. properties: - options: - description: >- - OPTIONAL: A `GetPolicyOptions` object for specifying options to - `GetIamPolicy`. - $ref: '#/components/schemas/GetPolicyOptions' - UpgradeOccurrence: + digest: + additionalProperties: + type: string + type: object + uri: + type: string + SlsaProvenanceV1: type: object - id: UpgradeOccurrence + properties: + buildDefinition: + $ref: '#/components/schemas/BuildDefinition' + runDetails: + $ref: '#/components/schemas/RunDetails' description: >- - An Upgrade Occurrence represents that a specific resource_url could - install a specific upgrade. This presence is supplied via local sources - (i.e. it is present in the mirror and the running system has noticed its - availability). For Windows, both distribution and windows_update contain - information for the Windows update. + Keep in sync with schema at + https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto + Builder renamed to ProvenanceBuilder because of Java conflicts. + id: SlsaProvenanceV1 + PackageIssue: + description: >- + A detail for a distro and package this vulnerability occurrence was + found in and its associated fix (if one is available). + id: PackageIssue + type: object properties: - windowsUpdate: + effectiveSeverity: + description: >- + Output only. The distro or language system assigned severity for + this vulnerability when that is available and note provider assigned + severity when it is not available. + type: string + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + readOnly: true + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + affectedCpeUri: + description: >- + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was found in. + type: string + fixAvailable: + type: boolean + description: Output only. Whether a fix is available for this package. + fixedVersion: + $ref: '#/components/schemas/Version' + description: >- + Required. The version of the package this vulnerability was fixed + in. Setting this to VersionKind.MAXIMUM means no fix is yet + available. + fileLocation: + items: + $ref: '#/components/schemas/GrafeasV1FileLocation' + type: array + description: The location at which this package was found. + affectedVersion: description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - $ref: '#/components/schemas/WindowsUpdate' - parsedVersion: + Required. The version of the package that is installed on the + resource affected by this vulnerability. $ref: '#/components/schemas/Version' - description: >- - Required for non-Windows OS. The version of the package in a machine - + human readable form. - package: + packageType: type: string - description: Required for non-Windows OS. The package this Upgrade is for. - distribution: + description: The type of package (e.g. OS, MAVEN, GO). + fixedCpeUri: description: >- - Metadata about the upgrade for available for the specific operating - system for the resource_url. This allows efficient filtering, as - well as making it easier to use the occurrence. - $ref: '#/components/schemas/UpgradeDistribution' - BuildProvenance: - id: BuildProvenance - type: object - properties: - createTime: - description: Time at which the build was created. + The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was fixed in. It is possible for this to be different + from the affected_cpe_uri. type: string - format: google-datetime - endTime: - format: google-datetime + affectedPackage: type: string - description: Time at which execution of the build was finished. - creator: + description: Required. The package this vulnerability was found in. + fixedPackage: type: string description: >- - E-mail address of the user who initiated this build. Note that this - was the user's e-mail address at the time the build was initiated; - this address may not represent the same end-user for all time. - id: - type: string - description: Required. Unique identifier of the build. - projectId: - description: ID of the project. + The package this vulnerability was fixed in. It is possible for this + to be different from the affected_package. + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: + description: >- + Python package to upload to Artifact Registry upon successful completion + of all build steps. A package can encapsulate multiple objects to be + uploaded to a single repository. + type: object + properties: + paths: + items: + type: string + description: >- + Path globs used to match files in the build's workspace. For Python/ + Twine, this is usually `dist/*`, and sometimes additionally an + `.asc` file. + type: array + repository: type: string - commands: + description: >- + Artifact Registry repository, in the form + "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the + workspace matching any path pattern will be uploaded to Artifact + Registry with this location as a prefix. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + SourceContext: + properties: + gerrit: + $ref: '#/components/schemas/GerritSourceContext' + description: A SourceContext referring to a Gerrit project. + git: + description: >- + A SourceContext referring to any third party Git repo (e.g., + GitHub). + $ref: '#/components/schemas/GitSourceContext' + cloudRepo: + $ref: '#/components/schemas/CloudRepoSourceContext' + description: >- + A SourceContext referring to a revision in a Google Cloud Source + Repo. + labels: + type: object + additionalProperties: + type: string + description: Labels with user defined metadata. + description: >- + A SourceContext is a reference to a tree of files. A SourceContext + together with a path point to a unique revision of a single file or + directory. + id: SourceContext + type: object + RunDetails: + properties: + builder: + $ref: '#/components/schemas/ProvenanceBuilder' + metadata: + $ref: '#/components/schemas/BuildMetadata' + byproducts: items: - $ref: '#/components/schemas/Command' + $ref: '#/components/schemas/ResourceDescriptor' type: array - description: Commands requested by the build. - startTime: + type: object + id: RunDetails + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: + type: object + description: A step in the build pipeline. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep + properties: + status: + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + enumDescriptions: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. + description: >- + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. + readOnly: true type: string - description: Time at which execution of the build was started. - format: google-datetime - builderVersion: - description: Version string of the builder at the time this build was executed. + timeout: + description: >- + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. type: string - logsUri: + format: google-duration + allowExitCodes: + type: array + items: + format: int32 + type: integer + description: >- + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. + timing: + readOnly: true + description: >- + Output only. Stores timing information for executing this build + step. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + script: type: string - description: URI where any logs for this provenance were written. - triggerId: + description: >- + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. + id: type: string description: >- - Trigger identifier if the build was triggered automatically; empty - if not. - buildOptions: - type: object + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. + name: description: >- - Special options applied to this build. This is a catch-all field - where build providers can enter any desired additional details. - additionalProperties: - type: string - builtArtifacts: - description: Output of the build. + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. + type: string + waitFor: type: array items: - $ref: '#/components/schemas/Artifact' - sourceProvenance: - $ref: '#/components/schemas/Source' - description: Details of the Source input to the build. - description: >- - Provenance of a build. Contains all information needed to verify the - full details about the build from source to completion. - Fingerprint: - description: A set of properties that uniquely identify a given Docker image. - type: object - properties: - v2Name: + type: string + description: >- + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. + dir: + description: >- + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. type: string + allowFailure: + type: boolean description: >- - Output only. The name of the image's v2 blobs computed via: [bottom] - := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the - name of the final blob is kept. - v1Name: + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. + entrypoint: description: >- - Required. The layer ID of the final layer in the Docker image's v1 - representation. + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. type: string - v2Blob: + volumes: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume type: array - description: Required. The ordered list of v2 blobs that represent a given image. + description: >- + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon + completion of the build, volumes and their contents are discarded. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + secretEnv: + description: >- + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. items: type: string - id: Fingerprint - SbomReferenceIntotoPayload: - description: >- - The actual payload that contains the SBOM Reference data. The payload - follows the intoto statement specification. See - https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md - for more details. - properties: - predicate: - $ref: '#/components/schemas/SbomReferenceIntotoPredicate' + type: array + pullTiming: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan description: >- - Additional parameters of the Predicate. Includes the actual data - about the SBOM. - subject: + Output only. Stores timing information for pulling this build step's + builder image only. + readOnly: true + args: + description: >- + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. items: - $ref: '#/components/schemas/Subject' + type: string + type: array + exitCode: + readOnly: true + type: integer + format: int32 + description: Output only. Return code from running the step. + automapSubstitutions: description: >- - Set of software artifacts that the attestation applies to. Each - element represents a single software artifact. + Option to include built-in and custom substitutions as env variables + for this build step. This option will override the global option in + BuildOption. + type: boolean + env: type: array - predicateType: - type: string - description: URI identifying the type of the Predicate. - _type: - type: string - description: Identifier for the schema of the Statement. - type: object - id: SbomReferenceIntotoPayload + description: >- + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + items: + type: string ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage - description: Artifact uploaded using the PythonPackage directive. properties: uri: - description: URI of the uploaded artifact. type: string + description: URI of the uploaded artifact. fileHashes: + description: Hash types and values of the Python Artifact. $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the Python Artifact. pushTiming: + readOnly: true description: >- Output only. Stores timing information for pushing the specified artifact. $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage type: object + description: Artifact uploaded using the PythonPackage directive. + GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: properties: - pushTiming: - description: >- - Output only. Stores timing information for pushing the specified - artifact. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - fileHashes: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the npm package. + digest: + type: object + additionalProperties: + type: string uri: type: string - description: URI of the uploaded npm package. - description: >- - An npm package uploaded to Artifact Registry using the NpmPackage - directive. - UpgradeDistribution: + type: object + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial description: >- - The Upgrade Distribution represents metadata about the Upgrade for each - operating system (CPE). Some distributions have additional metadata - around updates, classifying them into various categories and severities. - id: UpgradeDistribution + The collection of artifacts that influenced the build including sources, + dependencies, build tools, base images, and so on. + Distribution: + id: Distribution type: object + description: >- + This represents a particular channel of distribution for a given + package. E.g., Debian's jessie-backports dpkg mirror. properties: cpeUri: type: string description: >- - Required - The specific operating system this metadata applies to. - See https://cpe.mitre.org/specification/. - classification: + Required. The cpe_uri in [CPE + format](https://cpe.mitre.org/specification/) denoting the package + manager version distributing a package. + latestVersion: description: >- - The operating system classification of this Upgrade, as specified by - the upstream operating system upgrade feed. For Windows the - classification is one of the category_ids listed at - https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) + The latest available version of this package in this distribution + channel. + $ref: '#/components/schemas/Version' + maintainer: + description: A freeform string denoting the maintainer of this package. type: string - cve: - description: The cve tied to this Upgrade. - items: - type: string - type: array - severity: + description: + description: The distribution channel-specific description of this package. type: string - description: The severity as specified by the upstream operating system. - DSSEHint: - id: DSSEHint + url: + description: The distribution channel-specific homepage for this package. + type: string + architecture: + enumDescriptions: + - Unknown architecture. + - X86 architecture. + - X64 architecture. + type: string + description: >- + The CPU architecture for which packages in this distribution channel + were built. + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + type: object properties: - humanReadableName: + revision: type: string description: >- - Required. The human readable name of this attestation authority, for - example "cloudbuild-prod". + Optional. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git + fetch` to fetch the revision from the Git repository; therefore make + sure that the string you provide for `revision` is parsable by the + command. For information on string values accepted by `git fetch`, + see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For + information on `git fetch`, see https://git-scm.com/docs/git-fetch. + url: + type: string + description: >- + Required. Location of the Git repo to build. This will be used as a + `git remote`, see https://git-scm.com/docs/git-remote. + dir: + type: string + description: >- + Optional. Directory, relative to the source root, in which to run + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. + description: Location of the source in any accessible Git repository. + Signature: type: object + properties: + publicKeyId: + description: >- + The identifier for the public key that verifies this signature. * + The `public_key_id` is required. * The `public_key_id` SHOULD be an + RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD + be an immutable reference, such as a cryptographic digest. Examples + of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * + "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See + https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for + more details on this scheme. RFC6920 digest-named + SubjectPublicKeyInfo (digest of the DER serialization): * + "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * + "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" + type: string + signature: + format: byte + type: string + description: >- + The content of the signature, an opaque bytestring. The payload that + this signature verifies MUST be unambiguously provided with the + Signature during verification. A wrapper message might provide the + payload explicitly. Alternatively, a message might have a canonical + serialization that can always be unambiguously computed to derive + the payload. + id: Signature description: >- - This submessage provides human-readable hints about the purpose of the - authority. Because the name of a note acts as its resource reference, it - is important to disambiguate the canonical name of the Note (which might - be a UUID for security purposes) from "readable" names more suitable for - debug output. Note that these hints should not be used to look up - authorities in security sensitive contexts, such as when looking up - attestations to verify. - WindowsDetail: - id: WindowsDetail + Verifiers (e.g. Kritis implementations) MUST verify signatures with + respect to the trust anchors defined in policy (e.g. a Kritis policy). + Typically this means that the verifier has been configured with a map + from `public_key_id` to public key material (and any required + parameters, e.g. signing algorithm). In particular, verification + implementations MUST NOT treat the signature `public_key_id` as anything + more than a key lookup hint. The `public_key_id` DOES NOT validate or + authenticate a public key; it only provides a mechanism for quickly + selecting a public key ALREADY CONFIGURED on the verifier through a + trusted channel. Verification implementations MUST reject signatures in + any of the following circumstances: * The `public_key_id` is not + recognized by the verifier. * The public key that `public_key_id` refers + to does not verify the signature with respect to the payload. The + `signature` contents SHOULD NOT be "attached" (where the payload is + included with the serialized `signature` bytes). Verifiers MUST ignore + any "attached" payload and only verify signatures with respect to + explicitly provided payload (e.g. a `payload` field on the proto message + that holds this Signature, or the canonical serialization of the proto + message that holds this signature). + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + description: Location of the source in an archive file in Cloud Storage. properties: - description: + generation: + format: int64 + description: >- + Optional. Cloud Storage generation for the object. If the generation + is omitted, the latest generation will be used. + type: string + object: + description: >- + Required. Cloud Storage object containing the source. This object + must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) + containing source to build. type: string - description: The description of this vulnerability. - cpeUri: + sourceFetcher: + enum: + - SOURCE_FETCHER_UNSPECIFIED + - GSUTIL + - GCS_FETCHER type: string description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. - fixingKbs: - description: >- - Required. The names of the KBs which have hotfixes to mitigate this - vulnerability. Note that there may be multiple hotfixes (and thus - multiple KBs) that mitigate a given vulnerability. Currently any - listed KBs presence is considered a fix. - items: - $ref: '#/components/schemas/KnowledgeBase' - type: array - name: - description: Required. The name of this vulnerability. + Optional. Option to specify the tool to fetch the source file for + the build. + enumDescriptions: + - Unspecified defaults to GSUTIL. + - Use the "gsutil" tool to download the source file. + - Use the Cloud Storage Fetcher tool to download the source file. + bucket: type: string - SlsaProvenanceZeroTwo: - id: SlsaProvenanceZeroTwo + description: >- + Cloud Storage bucket containing the source (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + VulnerabilityOccurrencesSummary: properties: - builder: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' - buildType: - type: string - invocation: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' - buildConfig: - additionalProperties: - description: Properties of the object. - type: any - type: object - materials: + counts: + description: >- + A listing by resource of the number of fixable and total + vulnerabilities. items: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' + $ref: '#/components/schemas/FixableTotalByDigest' type: array - metadata: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' - description: See full explanation of fields at slsa.dev/provenance/v0.2. - type: object - CloudRepoSourceContext: - id: CloudRepoSourceContext - properties: - aliasContext: - description: An alias, which may be a branch or tag. - $ref: '#/components/schemas/AliasContext' - repoId: - $ref: '#/components/schemas/RepoId' - description: The ID of the repo. - revisionId: - type: string - description: A revision ID. type: object description: >- - A CloudRepoSourceContext denotes a particular revision in a Google Cloud - Source Repo. + A summary of how many vulnerability occurrences there are per resource + and severity type. + id: VulnerabilityOccurrencesSummary VulnerabilityOccurrence: - description: An occurrence of a severity vulnerability on a resource. type: object + description: An occurrence of a severity vulnerability on a resource. + id: VulnerabilityOccurrence properties: - vexAssessment: - $ref: '#/components/schemas/VexAssessment' + shortDescription: + type: string + description: Output only. A one sentence description of this vulnerability. + cvssv3: + description: The cvss v3 score for the vulnerability. + $ref: '#/components/schemas/CVSS' + longDescription: + type: string + description: Output only. A detailed description of this vulnerability. effectiveSeverity: enum: - SEVERITY_UNSPECIFIED @@ -4139,6 +4151,13 @@ components: - HIGH - CRITICAL type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. description: >- The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. @@ -4149,6 +4168,15 @@ components: the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. + severity: + type: string + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL enumDescriptions: - Unknown. - Minimal severity. @@ -4156,1185 +4184,1157 @@ components: - Medium severity. - High severity. - Critical severity. + description: >- + Output only. The note provider assigned severity of this + vulnerability. + vexAssessment: + $ref: '#/components/schemas/VexAssessment' + type: + type: string + description: >- + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). packageIssue: description: >- Required. The set of affected locations and their fixes (if available) within the associated resource. - type: array items: $ref: '#/components/schemas/PackageIssue' - fixAvailable: - type: boolean - description: >- - Output only. Whether at least one of the affected packages has a fix - available. + type: array cvssScore: - format: float description: >- Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. + format: float type: number - type: - description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). + extraDetails: type: string - relatedUrls: - items: - $ref: '#/components/schemas/RelatedUrl' - type: array - description: Output only. URLs related to this vulnerability. + description: Occurrence-specific extra details about the vulnerability. + cvssV2: + description: The cvss v2 score for the vulnerability. + $ref: '#/components/schemas/CVSS' + fixAvailable: + description: >- + Output only. Whether at least one of the affected packages has a fix + available. + type: boolean cvssVersion: - enumDescriptions: - - '' - - '' - - '' - description: Output only. CVSS version used to populate cvss_score and severity. enum: - CVSS_VERSION_UNSPECIFIED - CVSS_VERSION_2 - CVSS_VERSION_3 type: string - severity: - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - type: string enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - description: >- - Output only. The note provider assigned severity of this - vulnerability. - shortDescription: - type: string - description: Output only. A one sentence description of this vulnerability. - longDescription: - description: Output only. A detailed description of this vulnerability. - type: string - cvssV2: - $ref: '#/components/schemas/CVSS' - description: The cvss v2 score for the vulnerability. - extraDetails: - type: string - description: Occurrence-specific extra details about the vulnerability. - cvssv3: - $ref: '#/components/schemas/CVSS' - description: The cvss v3 score for the vulnerability. - id: VulnerabilityOccurrence - VulnerabilityNote: - description: A security vulnerability that can be found in resources. - id: VulnerabilityNote + - '' + - '' + - '' + description: Output only. CVSS version used to populate cvss_score and severity. + relatedUrls: + type: array + description: Output only. URLs related to this vulnerability. + items: + $ref: '#/components/schemas/RelatedUrl' + ComplianceOccurrence: type: object + id: ComplianceOccurrence properties: - windowsDetails: - type: array + nonCompliantFiles: items: - $ref: '#/components/schemas/WindowsDetail' - description: >- - Windows details get their own format because the information format - and model don't match a normal detail. Specifically Windows updates - are done as patches, thus Windows vulnerabilities really are a - missing package, rather than a package being at an incorrect - version. - details: + $ref: '#/components/schemas/NonCompliantFile' type: array - description: >- - Details of all known distros and packages affected by this - vulnerability. - items: - $ref: '#/components/schemas/Detail' - cvssScore: - description: >- - The CVSS score of this vulnerability. CVSS score is on a scale of 0 - - 10 where 0 indicates low severity and 10 indicates high severity. - type: number - format: float - cvssVersion: - enumDescriptions: - - '' - - '' - - '' + version: + description: The OS and config version the benchmark was run on. + $ref: '#/components/schemas/ComplianceVersion' + nonComplianceReason: + type: string + description: >- + An indication that the compliance checks in the associated + ComplianceNote were not satisfied for particular resources or a + specified reason. + CloudRepoSourceContext: + description: >- + A CloudRepoSourceContext denotes a particular revision in a Google Cloud + Source Repo. + id: CloudRepoSourceContext + type: object + properties: + revisionId: + type: string + description: A revision ID. + aliasContext: + description: An alias, which may be a branch or tag. + $ref: '#/components/schemas/AliasContext' + repoId: + description: The ID of the repo. + $ref: '#/components/schemas/RepoId' + Detail: + properties: + severityName: + description: The distro assigned severity of this vulnerability. + type: string + source: + description: The source from which the information in this Detail was obtained. + type: string + description: type: string - enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 - description: CVSS version used to populate cvss_score and severity. - cvssV2: - description: The full description of the v2 CVSS for this vulnerability. - $ref: '#/components/schemas/CVSS' + description: A vendor-specific description of this vulnerability. + fixedVersion: + description: >- + The distro recommended version to update to that contains a fix for + this vulnerability. Setting this to VersionKind.MAXIMUM means no + such version is yet available. + $ref: '#/components/schemas/Version' sourceUpdateTime: - type: string format: google-datetime + type: string description: >- The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. - cvssV3: - $ref: '#/components/schemas/CVSSv3' - description: The full description of the CVSSv3 for this vulnerability. - severity: - description: The note provider assigned severity of this vulnerability. - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + affectedPackage: + description: Required. The package this vulnerability affects. type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - type: object - properties: - mavenArtifacts: - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + affectedCpeUri: description: >- - A list of Maven artifacts to be uploaded to Artifact Registry upon - successful completion of all build steps. Artifacts in the workspace - matching specified paths globs will be uploaded to the specified - Artifact Registry repository using the builder service account's - credentials. If any artifacts fail to be pushed, the build is marked - FAILURE. - images: + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. + type: string + isObsolete: description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images will be pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the Build resource's results field. If any of the images - fail to be pushed, the build is marked FAILURE. - type: array - items: - type: string - npmPackages: + Whether this detail is obsolete. Occurrences are expected not to + point to obsolete details. + type: boolean + packageType: description: >- - A list of npm packages to be uploaded to Artifact Registry upon - successful completion of all build steps. Npm packages in the - specified paths will be uploaded to the specified Artifact Registry - repository using the builder service account's credentials. If any - packages fail to be pushed, the build is marked FAILURE. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - type: array - pythonPackages: - type: array + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + type: string + fixedCpeUri: description: >- - A list of Python packages to be uploaded to Artifact Registry upon - successful completion of all build steps. The build service account - credentials will be used to perform the upload. If any objects fail - to be pushed, the build is marked FAILURE. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage - objects: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + The distro recommended [CPE + URI](https://cpe.mitre.org/specification/) to update to that + contains a fix for this vulnerability. It is possible for this to be + different from the affected_cpe_uri. + type: string + affectedVersionStart: + $ref: '#/components/schemas/Version' description: >- - A list of objects to be uploaded to Cloud Storage upon successful - completion of all build steps. Files in the workspace matching - specified paths globs will be uploaded to the specified Cloud - Storage location using the builder service account's credentials. - The location and generation of the uploaded objects will be stored - in the Build resource's results field. If any objects fail to be - pushed, the build is marked FAILURE. + The version number at the start of an interval in which this + vulnerability exists. A vulnerability can affect a package between + version numbers that are disjoint sets of intervals (example: + [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will + be represented in its own Detail. If a specific affected version is + provided by a vulnerability database, affected_version_start and + affected_version_end will be the same in that Detail. + fixedPackage: + description: >- + The distro recommended package to update to that contains a fix for + this vulnerability. It is possible for this to be different from the + affected_package. + type: string + vendor: + description: The name of the vendor of the product. + type: string + affectedVersionEnd: + $ref: '#/components/schemas/Version' + description: >- + The version number at the end of an interval in which this + vulnerability exists. A vulnerability can affect a package between + version numbers that are disjoint sets of intervals (example: + [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will + be represented in its own Detail. If a specific affected version is + provided by a vulnerability database, affected_version_start and + affected_version_end will be the same in that Detail. + id: Detail description: >- - Artifacts produced by a build that should be uploaded upon successful - completion of all build steps. - CisBenchmark: + A detail for a distro and package affected by this vulnerability and its + associated fix (if one is available). + type: object + DSSEAttestationOccurrence: properties: - profileLevel: - type: integer - format: int32 - severity: - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - type: string + envelope: + description: >- + If doing something security critical, make sure to verify the + signatures in this metadata. + $ref: '#/components/schemas/Envelope' + statement: + $ref: '#/components/schemas/InTotoStatement' type: object - id: CisBenchmark - description: A compliance check that is a CIS benchmark. - ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: description: >- - Location of the source in a 2nd-gen Google Cloud Build repository - resource. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + Deprecated. Prefer to use a regular Occurrence, and populate the + Envelope at the top level of the Occurrence. + id: DSSEAttestationOccurrence + ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret properties: - dir: - type: string - description: >- - Optional. Directory, relative to the source root, in which to run - the build. - revision: - type: string + envMap: description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. - repository: + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. + type: object + additionalProperties: + format: byte + type: string + kmsKeyName: type: string description: >- - Required. Name of the Google Cloud Build repository, formatted as - `projects/*/locations/*/connections/*/repositories/*`. + Resource name of Cloud KMS crypto key to decrypt the encrypted + value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* type: object - EnvelopeSignature: + description: >- + Pairs a set of secret environment variables mapped to encrypted values + with the Cloud KMS key to use to decrypt the value. + Identity: + description: The unique identifier of the update. type: object properties: - keyid: - type: string - sig: - format: byte + revision: + description: The revision number of the update. + format: int32 + type: integer + updateId: type: string - id: EnvelopeSignature - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: - description: >- - Files in the workspace to upload to Cloud Storage upon successful - completion of all build steps. + description: The revision independent identifier of the update. + id: Identity + Binding: + type: object properties: - timing: + role: description: >- - Output only. Stores timing information for pushing all artifact - objects. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - location: + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + members: description: >- - Cloud Storage bucket and optional object path, in the form - "gs://bucket/path/to/somewhere/". (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Files in the workspace matching any path pattern will be uploaded to - Cloud Storage with this location as a prefix. - paths: + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. items: type: string - description: Path globs used to match files in the build's workspace. type: array + description: Associates `members`, or principals, with a `role`. + id: Binding + Jwt: + id: Jwt type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: - properties: - http: - description: Configuration for HTTP related git operations. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - description: GitConfig is a configuration for git operations. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact properties: - pushTiming: - description: >- - Output only. Stores timing information for pushing the specified - artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - uri: - description: URI of the uploaded artifact. + compactJwt: type: string - fileHashes: - description: Hash types and values of the Maven Artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: A Maven artifact uploaded using the MavenArtifact directive. - type: object - ListNoteOccurrencesResponse: - id: ListNoteOccurrencesResponse + description: >- + The compact encoding of a JWS, which is always three base64 encoded + strings joined by periods. For details, see: + https://tools.ietf.org/html/rfc7515.html#section-3.1 + RepoId: + id: RepoId type: object properties: - occurrences: - items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences attached to the specified note. - type: array - nextPageToken: + uid: type: string - description: Token to provide to skip to a particular spot in the list. - description: Response for listing occurrences for a note. - ComplianceNote: - id: ComplianceNote + description: A server-assigned, globally unique identifier. + projectRepoId: + description: A combination of a project ID and a repo name. + $ref: '#/components/schemas/ProjectRepoId' + description: A unique identifier for a Cloud Repo. + FileHashes: type: object + description: >- + Container message for hashes of byte content of files, used in source + messages to verify integrity of source input to the build. + id: FileHashes properties: - impact: - type: string - remediation: - type: string - description: A description of remediation steps if the compliance check fails. - rationale: - description: A rationale for the existence of this compliance check. - type: string - cisBenchmark: - $ref: '#/components/schemas/CisBenchmark' - version: + fileHash: items: - $ref: '#/components/schemas/ComplianceVersion' - description: The OS and config versions the benchmark applies to. + $ref: '#/components/schemas/Hash' type: array - scanInstructions: - type: string - format: byte - description: Serialized scan instructions with a predefined format. - title: - type: string - description: The title that identifies this compliance check. - description: - type: string - description: A description about this compliance check. - ListNotesResponse: + description: Required. Collection of file hashes. + GetIamPolicyRequest: type: object - description: Response for listing notes. - id: ListNotesResponse + description: Request message for `GetIamPolicy` method. + id: GetIamPolicyRequest properties: - notes: - type: array - items: - $ref: '#/components/schemas/Note' - description: The notes requested. - nextPageToken: - type: string + options: description: >- - The next pagination token in the list response. It should be used as - `page_token` for the following request. An empty value means no more - results. - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: + OPTIONAL: A `GetPolicyOptions` object for specifying options to + `GetIamPolicy`. + $ref: '#/components/schemas/GetPolicyOptions' + InTotoSlsaProvenanceV1: type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage - description: >- - Python package to upload to Artifact Registry upon successful completion - of all build steps. A package can encapsulate multiple objects to be - uploaded to a single repository. + id: InTotoSlsaProvenanceV1 properties: - repository: - description: >- - Artifact Registry repository, in the form - "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the - workspace matching any path pattern will be uploaded to Artifact - Registry with this location as a prefix. - type: string - paths: + subject: type: array - description: >- - Path globs used to match files in the build's workspace. For Python/ - Twine, this is usually `dist/*`, and sometimes additionally an - `.asc` file. items: - type: string - SlsaRecipe: - description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. - properties: - type: - description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. - type: string - arguments: - type: object - description: >- - Collection of all external inputs that influenced the build on top - of recipe.definedInMaterial and recipe.entryPoint. For example, if - the recipe type were "make", then this might be the flags passed to - make aside from the target, which is captured in recipe.entryPoint. - Depending on the recipe Type, the structure may be different. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - definedInMaterial: - description: >- - Index in materials containing the recipe steps that are not implied - by recipe.type. For example, if the recipe type were "make", then - this would point to the source containing the Makefile, not the make - program itself. Set to -1 if the recipe doesn't come from a - material, as zero is default unset value for int64. + $ref: '#/components/schemas/Subject' + predicateType: type: string - format: int64 - entryPoint: - description: >- - String identifying the entry point into the build. This is often a - path to a configuration file and/or a target label within that file. - The syntax and meaning are defined by recipe.type. For example, if - the recipe type were "make", then this would reference the directory - in which to run make as well as which target to use. + _type: type: string - environment: description: >- - Any other builder-controlled inputs necessary for correctly - evaluating the recipe. Usually only needed for reproducing the build - but not evaluated as part of policy. Depending on the recipe Type, - the structure may be different. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - id: SlsaRecipe - BuildNote: - type: object - id: BuildNote - description: >- - Note holding the version of the provider's builder and the signature of - the provenance message in the build details occurrence. + InToto spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement + predicate: + $ref: '#/components/schemas/SlsaProvenanceV1' + SlsaProvenance: + id: SlsaProvenance properties: - builderVersion: - type: string + materials: + type: array + items: + $ref: '#/components/schemas/Material' description: >- - Required. Immutable. Version of the builder which produced this - build. - PackageOccurrence: - description: Details on how a particular software package was installed on a system. + The collection of artifacts that influenced the build including + sources, dependencies, build tools, base images, and so on. This is + considered to be incomplete unless metadata.completeness.materials + is true. Unset or null is equivalent to empty. + metadata: + $ref: '#/components/schemas/SlsaMetadata' + recipe: + description: >- + Identifies the configuration used for the build. When combined with + materials, this SHOULD fully describe the build, such that + re-running this recipe results in bit-for-bit identical output (if + the build is reproducible). required + $ref: '#/components/schemas/SlsaRecipe' + builder: + $ref: '#/components/schemas/SlsaBuilder' + description: required type: object - id: PackageOccurrence + Expr: properties: location: - items: - $ref: '#/components/schemas/Location' + type: string description: >- - All of the places within the filesystem versions of this package - have been found. - type: array - version: - description: Output only. The version of the package. - readOnly: true - $ref: '#/components/schemas/Version' - packageType: - readOnly: true + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + title: type: string description: >- - Output only. The type of package; whether native or non native - (e.g., ruby gems, node.js packages, etc.). - architecture: - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + expression: description: >- - Output only. The CPU architecture for which packages in this - distribution channel were built. Architecture will be blank for - language packages. + Textual representation of an expression in Common Expression + Language syntax. type: string - readOnly: true - enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. - cpeUri: + description: description: >- - Output only. The cpe_uri in [CPE - format](https://cpe.mitre.org/specification/) denoting the package - manager version distributing a package. The cpe_uri will be blank - for language packages. - readOnly: true - type: string - name: + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. type: string - description: Required. Output only. The name of the installed package. - readOnly: true - license: - description: Licenses that have been declared by the authors of the package. - $ref: '#/components/schemas/License' - ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: - description: Start and end times for a build execution phase. type: object + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + id: Expr + GitSourceContext: + description: >- + A GitSourceContext denotes a particular revision in a third party Git + repository (e.g., GitHub). properties: - startTime: - format: google-datetime - description: Start of time span. + url: + description: Git repository URL. type: string - endTime: - description: End of time span. + revisionId: + description: Git commit hash. type: string - format: google-datetime - id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + id: GitSourceContext + type: object + ResourceDescriptor: properties: - generation: + digest: + type: object + additionalProperties: + type: string + name: type: string - description: >- - Optional. Cloud Storage generation for the object. If the generation - is omitted, the latest generation will be used. - format: int64 - object: - description: >- - Required. Cloud Storage object containing the source. This object - must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) - containing source to build. + uri: type: string - bucket: + mediaType: type: string - description: >- - Cloud Storage bucket containing the source (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - sourceFetcher: + downloadLocation: type: string - enum: - - SOURCE_FETCHER_UNSPECIFIED - - GSUTIL - - GCS_FETCHER - description: >- - Optional. Option to specify the tool to fetch the source file for - the build. - enumDescriptions: - - Unspecified defaults to GSUTIL. - - Use the "gsutil" tool to download the source file. - - Use the Cloud Storage Fetcher tool to download the source file. - type: object - description: Location of the source in an archive file in Cloud Storage. - ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: + content: + format: byte + type: string + annotations: + type: object + additionalProperties: + type: any + id: ResourceDescriptor type: object - description: Location of the source in a Google Cloud Source Repository. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + Layer: + id: Layer properties: - projectId: - type: string - description: >- - Optional. ID of the project that owns the Cloud Source Repository. - If omitted, the project ID requesting the build is assumed. - repoName: - description: Required. Name of the Cloud Source Repository. - type: string - invertRegex: - type: boolean + directive: description: >- - Optional. Only trigger a build if the revision regex does NOT match - the revision regex. - branchName: + Required. The recovered Dockerfile directive used to construct this + layer. See https://docs.docker.com/engine/reference/builder/ for + more information. type: string - description: >- - Regex matching branches to build. The syntax of the regular - expressions accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - dir: + arguments: + description: The recovered arguments to the Dockerfile directive. type: string - description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. - commitSha: - description: Explicit commit SHA to build. + description: Layer holds metadata specific to a layer of a Docker image. + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + type: object + properties: + http: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + description: Configuration for HTTP related git operations. + description: GitConfig is a configuration for git operations. + Digest: + properties: + digestBytes: + description: Value of the digest. + format: byte type: string - tagName: + algo: type: string - description: >- - Regex matching tags to build. The syntax of the regular expressions - accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - substitutions: - description: >- - Optional. Substitutions to use in a triggered build. Should only be - used with RunBuildTrigger - type: object - additionalProperties: - type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: - description: A non-fatal problem encountered during the execution of the build. + description: '`SHA1`, `SHA512` etc.' + id: Digest type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + description: Digest information. + Hash: properties: - priority: - enum: - - PRIORITY_UNSPECIFIED - - INFO - - WARNING - - ALERT + value: + type: string + description: Required. The hash value. + format: byte + type: + description: Required. The type of hash that was performed, e.g. "SHA-256". + type: string + description: Container message for hash values. + type: object + id: Hash + Justification: + id: Justification + type: object + properties: + details: type: string - description: The priority for this warning. + description: Additional details on why this justification was chosen. + justificationType: + enum: + - JUSTIFICATION_TYPE_UNSPECIFIED + - COMPONENT_NOT_PRESENT + - VULNERABLE_CODE_NOT_PRESENT + - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH + - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY + - INLINE_MITIGATIONS_ALREADY_EXIST + description: The justification type for this vulnerability. enumDescriptions: - - Should not be used. - - e.g. deprecation warnings and alternative feature highlights. - - e.g. automated detection of possible issues with the build. - - e.g. alerts that a feature used in the build is pending removal - text: + - JUSTIFICATION_TYPE_UNSPECIFIED. + - The vulnerable component is not present in the product. + - >- + The vulnerable code is not present. Typically this case occurs + when source code is configured or built in a way that excludes the + vulnerable code. + - >- + The vulnerable code can not be executed. Typically this case + occurs when the product includes the vulnerable code but does not + call or use the vulnerable code. + - >- + The vulnerable code cannot be controlled by an attacker to exploit + the vulnerability. + - >- + The product includes built-in protections or features that prevent + exploitation of the vulnerability. These built-in protections + cannot be subverted by the attacker and cannot be configured or + disabled by the user. These mitigations completely prevent + exploitation based on known attack vectors. type: string - description: Explanation of the warning generated. - Status: - type: object description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + BuilderConfig: properties: - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - description: The status code, which should be an enum value of google.rpc.Code. + id: + type: string + id: BuilderConfig + type: object + Version: + type: object + properties: + revision: + type: string + description: The iteration of the package build from the above version. + epoch: format: int32 type: integer - message: + description: Used to correct mistakes in the version numbering scheme. + fullName: type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - id: Status - Completeness: - properties: - arguments: + Human readable version string. This string is of the form :- and is + only set when kind is NORMAL. + kind: description: >- - If true, the builder claims that recipe.arguments is complete, - meaning that all external inputs are properly captured in the - recipe. + Required. Distinguishes between sentinel MIN/MAX versions and normal + versions. + enumDescriptions: + - Unknown. + - A standard package version. + - A special version representing negative infinity. + - A special version representing positive infinity. + type: string + enum: + - VERSION_KIND_UNSPECIFIED + - NORMAL + - MINIMUM + - MAXIMUM + inclusive: type: boolean - materials: description: >- - If true, the builder claims that materials are complete, usually - through some controls to prevent network access. Sometimes called - "hermetic". - type: boolean - environment: - type: boolean + Whether this version is specifying part of an inclusive range. + Grafeas does not have the capability to specify version ranges; + instead we have fields that specify start version and end versions. + At times this is insufficient - we also need to specify whether the + version is included in the range or is excluded from the range. This + boolean is expected to be set to true when the version is included + in a range. + name: description: >- - If true, the builder claims that recipe.environment is claimed to be - complete. - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - type: object - id: Completeness - ContaineranalysisGoogleDevtoolsCloudbuildV1Source: - description: Location of the source in a supported storage service. + Required only when version kind is NORMAL. The main part of the + version name. + type: string + id: Version + description: Version contains structured information about the version of a package. + ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: type: object + description: >- + Pairs a secret environment variable with a SecretVersion in Secret + Manager. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret properties: - storageSource: - description: If provided, get the source from this location in Cloud Storage. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - repoSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + env: + type: string description: >- - If provided, get the source from this location in a Cloud Source - Repository. - gitSource: - description: If provided, get the source from this Git repository. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - developerConnectConfig: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig - description: If provided, get the source from this Developer Connect config. - storageSourceManifest: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + Environment variable name to associate with the secret. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. + versionName: + type: string description: >- - If provided, get the source from this manifest in Cloud Storage. - This feature is in Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). - connectedRepository: + Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: + type: object + properties: + uri: + description: URI of the uploaded npm package. + type: string + pushTiming: + readOnly: true $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan description: >- - Optional. If provided, get the source from this 2nd-gen Google Cloud - Build repository resource. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source - GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: + Output only. Stores timing information for pushing the specified + artifact. + fileHashes: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + description: Hash types and values of the npm package. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage description: >- - Identifies the entity that executed the recipe, which is trusted to have - correctly performed the operation and populated this provenance. - id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder + An npm package uploaded to Artifact Registry using the NpmPackage + directive. + SetIamPolicyRequest: + type: object + description: Request message for `SetIamPolicy` method. + id: SetIamPolicyRequest + properties: + policy: + $ref: '#/components/schemas/Policy' + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + ProvenanceBuilder: + id: ProvenanceBuilder + type: object properties: + builderDependencies: + items: + $ref: '#/components/schemas/ResourceDescriptor' + type: array + version: + additionalProperties: + type: string + type: object id: type: string - type: object - DSSEAttestationOccurrence: - type: object - id: DSSEAttestationOccurrence + UpgradeNote: + description: >- + An Upgrade Note represents a potential upgrade of a package to a given + version. For each package version combination (i.e. bash 4.0, bash 4.1, + bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update + field represents the information related to the update. properties: - statement: - $ref: '#/components/schemas/InTotoStatement' - envelope: + distributions: + items: + $ref: '#/components/schemas/UpgradeDistribution' + type: array + description: Metadata about the upgrade for each specific operating system. + package: + type: string + description: Required for non-Windows OS. The package this Upgrade is for. + version: + $ref: '#/components/schemas/Version' description: >- - If doing something security critical, make sure to verify the - signatures in this metadata. - $ref: '#/components/schemas/Envelope' - description: >- - Deprecated. Prefer to use a regular Occurrence, and populate the - Envelope at the top level of the Occurrence. - Command: + Required for non-Windows OS. The version of the package in machine + + human readable form. + windowsUpdate: + $ref: '#/components/schemas/WindowsUpdate' + description: >- + Required for Windows OS. Represents the metadata about the Windows + update. + id: UpgradeNote + type: object + SBOMReferenceNote: + type: object properties: - id: + format: type: string + description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... + version: description: >- - Optional unique identifier for this command, used in wait_for to - reference this command as a dependency. - args: - description: Command-line arguments used when executing this command. - items: - type: string - type: array - env: - description: Environment variables set before running this command. - items: - type: string - type: array - dir: + The version of the format that the SBOM takes. E.g. if the format is + spdx, the version may be 2.3. + type: string + description: The note representing an SBOM reference. + id: SBOMReferenceNote + PackageOccurrence: + properties: + architecture: + enumDescriptions: + - Unknown architecture. + - X86 architecture. + - X64 architecture. + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + readOnly: true description: >- - Working directory (relative to project source root) used when - running this command. + Output only. The CPU architecture for which packages in this + distribution channel were built. Architecture will be blank for + language packages. type: string name: - description: >- - Required. Name of the command, as presented on the command line, or - if the command is packaged as a Docker container, as presented to - `docker pull`. + description: Required. Output only. The name of the installed package. type: string - waitFor: - description: The ID(s) of the command(s) that this command depends on. + readOnly: true + location: + description: >- + All of the places within the filesystem versions of this package + have been found. type: array items: - type: string + $ref: '#/components/schemas/Location' + version: + readOnly: true + $ref: '#/components/schemas/Version' + description: Output only. The version of the package. + license: + $ref: '#/components/schemas/License' + description: Licenses that have been declared by the authors of the package. + cpeUri: + type: string + readOnly: true + description: >- + Output only. The cpe_uri in [CPE + format](https://cpe.mitre.org/specification/) denoting the package + manager version distributing a package. The cpe_uri will be blank + for language packages. + packageType: + type: string + readOnly: true + description: >- + Output only. The type of package; whether native or non native + (e.g., ruby gems, node.js packages, etc.). + id: PackageOccurrence + description: Details on how a particular software package was installed on a system. type: object - description: Command describes a step performed as part of the build pipeline. - id: Command - BuilderConfig: + ComplianceNote: type: object + id: ComplianceNote properties: - id: + version: + items: + $ref: '#/components/schemas/ComplianceVersion' + description: The OS and config versions the benchmark applies to. + type: array + title: type: string - id: BuilderConfig - Binding: - type: object - description: Associates `members`, or principals, with a `role`. + description: The title that identifies this compliance check. + rationale: + type: string + description: A rationale for the existence of this compliance check. + remediation: + description: A description of remediation steps if the compliance check fails. + type: string + scanInstructions: + type: string + format: byte + description: Serialized scan instructions with a predefined format. + description: + description: A description about this compliance check. + type: string + impact: + type: string + cisBenchmark: + $ref: '#/components/schemas/CisBenchmark' + Occurrence: properties: - condition: + vulnerability: + $ref: '#/components/schemas/VulnerabilityOccurrence' + description: Describes a security vulnerability. + envelope: + $ref: '#/components/schemas/Envelope' + description: https://github.com/secure-systems-lab/dsse + createTime: + description: Output only. The time this occurrence was created. + format: google-datetime + type: string + sbomReference: + description: Describes a specific SBOM reference occurrences. + $ref: '#/components/schemas/SBOMReferenceOccurrence' + dsseAttestation: + $ref: '#/components/schemas/DSSEAttestationOccurrence' + description: Describes an attestation of an artifact using dsse. + image: + $ref: '#/components/schemas/ImageOccurrence' description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - members: + Describes how this resource derives from the basis in the associated + note. + remediation: + type: string + description: A description of actions that can be taken to remedy the note. + noteName: description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - items: - type: string - type: array - role: + Required. Immutable. The analysis note associated with this + occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + This field can be used as a filter in list requests. + type: string + build: + $ref: '#/components/schemas/BuildOccurrence' + description: Describes a verifiable build. + name: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). + Output only. The name of the occurrence in the form of + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + type: string + discovery: + description: Describes when a resource was discovered. + $ref: '#/components/schemas/DiscoveryOccurrence' + resourceUri: + type: string + description: >- + Required. Immutable. A URI that represents the resource for which + the occurrence applies. For example, + `https://gcr.io/project/image@sha256:123abc` for a Docker image. + upgrade: + description: Describes an available package upgrade on the linked resource. + $ref: '#/components/schemas/UpgradeOccurrence' + package: + $ref: '#/components/schemas/PackageOccurrence' + description: Describes the installation of a package on the linked resource. + attestation: + $ref: '#/components/schemas/AttestationOccurrence' + description: Describes an attestation of an artifact. + deployment: + description: Describes the deployment of an artifact on a runtime. + $ref: '#/components/schemas/DeploymentOccurrence' + compliance: + $ref: '#/components/schemas/ComplianceOccurrence' + description: Describes a compliance violation on a linked resource. + kind: type: string - id: Binding - Metadata: - properties: - completeness: + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE description: >- - Indicates that the builder claims certain fields in this message to - be complete. - $ref: '#/components/schemas/Completeness' - buildStartedOn: + Output only. This explicitly denotes which of the occurrence details + are specified. This field can be used as a filter in list requests. + enumDescriptions: + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + updateTime: type: string format: google-datetime - description: The timestamp of when the build started. - buildInvocationId: - type: string + description: Output only. The time this occurrence was last updated. + description: An instance of an analysis type that has been found on a resource. + id: Occurrence + type: object + Completeness: + description: >- + Indicates that the builder claims certain fields in this message to be + complete. + id: Completeness + properties: + arguments: description: >- - Identifies the particular build invocation, which can be useful for - finding associated logs or other ad-hoc analysis. The value SHOULD - be globally unique, per in-toto Provenance spec. - buildFinishedOn: - format: google-datetime - type: string - description: The timestamp of when the build completed. - reproducible: + If true, the builder claims that recipe.arguments is complete, + meaning that all external inputs are properly captured in the + recipe. + type: boolean + environment: type: boolean description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. + If true, the builder claims that recipe.environment is claimed to be + complete. + materials: + description: >- + If true, the builder claims that materials are complete, usually + through some controls to prevent network access. Sometimes called + "hermetic". + type: boolean type: object - description: Other properties of the build. - id: Metadata - FixableTotalByDigest: - description: Per resource and severity counts of fixable and total vulnerabilities. + DSSEAttestationNote: + properties: + hint: + description: DSSEHint hints at the purpose of the attestation authority. + $ref: '#/components/schemas/DSSEHint' + type: object + id: DSSEAttestationNote + Assessment: + id: Assessment type: object + description: >- + Assessment provides all information that is related to a single + vulnerability for this product. properties: - fixableCount: - format: int64 + relatedUris: + description: >- + Holds a list of references associated with this vulnerability item + and assessment. These uris have additional information about the + vulnerability and the assessment itself. E.g. Link to a document + which details how this assessment concluded the state of this + vulnerability. + type: array + items: + $ref: '#/components/schemas/RelatedUrl' + shortDescription: + description: A one sentence description of this Vex. type: string - description: The number of fixable vulnerabilities associated with this resource. - resourceUri: + longDescription: type: string - description: The affected resource. - totalCount: - format: int64 - description: The total number of vulnerabilities associated with this resource. + description: A detailed description of this Vex. + impacts: + description: >- + Contains information about the impact of this vulnerability, this + will change with time. + items: + type: string + type: array + cve: type: string - severity: + deprecated: true description: >- - The severity for this count. SEVERITY_UNSPECIFIED indicates total - across all severities. + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. + vulnerabilityId: + description: >- + The vulnerability identifier for this Assessment. Will hold one of + common identifiers e.g. CVE, GHSA etc. + type: string + remediations: + type: array + items: + $ref: '#/components/schemas/Remediation' + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. + state: + description: Provides the state of this Vulnerability assessment. + type: string enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + - No state is specified. + - This product is known to be affected by this vulnerability. + - This product is known to be not affected by this vulnerability. + - This product contains a fix for this vulnerability. + - >- + It is not known yet whether these versions are or are not affected + by the vulnerability. However, it is still under investigation. enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - type: string - id: FixableTotalByDigest - TimeSpan: - description: 'Start and end times for a build execution phase. Next ID: 3' + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION + justification: + description: >- + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + $ref: '#/components/schemas/Justification' + ListNoteOccurrencesResponse: properties: - startTime: - type: string - description: Start of time span. - format: google-datetime - endTime: - format: google-datetime + occurrences: + items: + $ref: '#/components/schemas/Occurrence' + description: The occurrences attached to the specified note. + type: array + nextPageToken: + description: Token to provide to skip to a particular spot in the list. type: string - description: End of time span. - type: object - id: TimeSpan - ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: - description: Secrets and secret environment variables. type: object + description: Response for listing occurrences for a note. + id: ListNoteOccurrencesResponse + ContaineranalysisGoogleDevtoolsCloudbuildV1Results: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results + description: Artifacts created by the build pipeline. properties: - secretManager: + pythonPackages: + type: array items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret - type: array - description: >- - Secrets in Secret Manager and associated secret environment - variable. - inline: - type: array + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage description: >- - Secrets encrypted with KMS key and the associated secret environment - variable. + Python artifacts uploaded to Artifact Registry at the end of the + build. + artifactTiming: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: Time to push all non-container artifacts to Cloud Storage. + images: + description: Container images that were built as a part of the build. items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: - description: >- - A Maven artifact to upload to Artifact Registry upon successful - completion of all build steps. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact - properties: - groupId: - description: >- - Maven `groupId` value used when uploading the artifact to Artifact - Registry. - type: string - path: - type: string - description: >- - Path to an artifact in the build's workspace to be uploaded to - Artifact Registry. This can be either an absolute path, e.g. - /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path - from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. - repository: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage + type: array + artifactManifest: type: string description: >- - Artifact Registry repository, in the form - "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the - workspace specified by path will be uploaded to Artifact Registry - with this location as a prefix. - version: + Path to the artifact manifest for non-container artifacts uploaded + to Cloud Storage. Only populated when artifacts are uploaded to + Cloud Storage. + mavenArtifacts: + type: array description: >- - Maven `version` value used when uploading the artifact to Artifact - Registry. - type: string - artifactId: + Maven artifacts uploaded to Artifact Registry at the end of the + build. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + numArtifacts: + format: int64 description: >- - Maven `artifactId` value used when uploading the artifact to - Artifact Registry. - type: string - Location: - description: >- - An occurrence of a particular package installation found within a - system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. - properties: - cpeUri: + Number of non-container artifacts uploaded to Cloud Storage. Only + populated when artifacts are uploaded to Cloud Storage. type: string + buildStepImages: + items: + type: string description: >- - Deprecated. The CPE URI in [CPE - format](https://cpe.mitre.org/specification/) - version: - $ref: '#/components/schemas/Version' - description: Deprecated. The version installed at this location. - path: - type: string + List of build step digests, in the order corresponding to build step + indices. + type: array + buildStepOutputs: + items: + format: byte + type: string description: >- - The path from which we gathered that this package/version is - installed. - id: Location + List of build step outputs, produced by builder images, in the order + corresponding to build step indices. [Cloud + Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) + can produce this output by writing to `$BUILDER_OUTPUT/output`. Only + the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` + variable is read-only and can't be substituted. + type: array + npmPackages: + description: Npm packages uploaded to Artifact Registry at the end of the build. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + type: array type: object - CVSS: - description: >- - Common Vulnerability Scoring System. For details, see - https://www.first.org/cvss/specification-document This is a message we - will try to use for storing various versions of CVSS rather than making - a separate proto for storing a specific version. + VulnerabilityNote: type: object - id: CVSS + id: VulnerabilityNote properties: - baseScore: - description: The base score is a function of the base metric scores. - format: float - type: number - authentication: - enumDescriptions: - - '' - - '' - - '' - - '' - type: string - enum: - - AUTHENTICATION_UNSPECIFIED - - AUTHENTICATION_MULTIPLE - - AUTHENTICATION_SINGLE - - AUTHENTICATION_NONE - attackComplexity: - type: string - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH - - ATTACK_COMPLEXITY_MEDIUM - enumDescriptions: - - '' - - '' - - '' - - '' - scope: - enumDescriptions: - - '' - - '' - - '' - type: string - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED - attackVector: - type: string + cvssV2: + $ref: '#/components/schemas/CVSS' + description: The full description of the v2 CVSS for this vulnerability. + cvssScore: description: >- - Base Metrics Represents the intrinsic characteristics of a - vulnerability that are constant over time and across user - environments. - enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - impactScore: + The CVSS score of this vulnerability. CVSS score is on a scale of 0 + - 10 where 0 indicates low severity and 10 indicates high severity. format: float type: number - availabilityImpact: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - type: string - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - privilegesRequired: + sourceUpdateTime: + format: google-datetime + description: >- + The time this information was last changed at the source. This is an + upstream timestamp from the underlying information source - e.g. + Ubuntu security tracker. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH - userInteraction: + cvssV3: + $ref: '#/components/schemas/CVSSv3' + description: The full description of the CVSSv3 for this vulnerability. + windowsDetails: + items: + $ref: '#/components/schemas/WindowsDetail' + type: array + description: >- + Windows details get their own format because the information format + and model don't match a normal detail. Specifically Windows updates + are done as patches, thus Windows vulnerabilities really are a + missing package, rather than a package being at an incorrect + version. + details: + items: + $ref: '#/components/schemas/Detail' + type: array + description: >- + Details of all known distros and packages affected by this + vulnerability. + cvssVersion: enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - type: string + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 + description: CVSS version used to populate cvss_score and severity. enumDescriptions: - '' - '' - '' - exploitabilityScore: - type: number - format: float - confidentialityImpact: type: string - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE + severity: enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - integrityImpact: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + description: The note provider assigned severity of this vulnerability. type: string - RunDetails: - properties: - byproducts: - type: array - items: - $ref: '#/components/schemas/ResourceDescriptor' - builder: - $ref: '#/components/schemas/ProvenanceBuilder' - metadata: - $ref: '#/components/schemas/BuildMetadata' - type: object - id: RunDetails + description: A security vulnerability that can be found in resources. parameters: quotaUser: description: >- @@ -5345,36 +5345,55 @@ components: name: quotaUser schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + callback: + description: JSONP in: query - name: fields + name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + _.xgafv: + description: V1 error format. in: query - name: prettyPrint + name: $.xgafv schema: - type: boolean + type: string + enum: + - '1' + - '2' access_token: description: OAuth access token. in: query name: access_token schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - callback: - description: JSONP + alt: + description: Data format for response. in: query - name: callback + name: alt schema: type: string + enum: + - json + - media + - proto + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -5384,63 +5403,19 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: upload_protocol + name: fields schema: type: string x-stackQL-resources: - resources: - id: google.containeranalysis.resources - name: resources - title: Resources - methods: - projects_resources_export_sbom: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1resources~1{resourcesId}:exportSBOM/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_resources_export_sbom: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1resources~1{resourcesId}:exportSBOM/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] occurrences: id: google.containeranalysis.occurrences name: occurrences @@ -5459,24 +5434,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get: + projects_occurrences_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_patch: + projects_occurrences_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_delete: + projects_occurrences_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -5494,13 +5469,14 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_locations_occurrences_delete: + projects_locations_notes_occurrences_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.occurrences projects_locations_occurrences_patch: operation: $ref: >- @@ -5515,6 +5491,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_occurrences_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_occurrences_create: operation: $ref: >- @@ -5537,20 +5520,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_occurrences_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.occurrences sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_get - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_locations_notes_occurrences_list + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_get - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_get - $ref: >- @@ -5579,6 +5554,35 @@ components: #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_delete - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_delete + occurrences_vulnerability_summary: + id: google.containeranalysis.occurrences_vulnerability_summary + name: occurrences_vulnerability_summary + title: Occurrences_vulnerability_summary + methods: + projects_occurrences_get_vulnerability_summary: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_occurrences_get_vulnerability_summary: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary + - $ref: >- + #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary + insert: [] + update: [] + replace: [] + delete: [] occurrences_iam_policies: id: google.containeranalysis.occurrences_iam_policies name: occurrences_iam_policies @@ -5591,21 +5595,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_test_iam_permissions: + projects_occurrences_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get_iam_policy: + objectKey: $.bindings + projects_occurrences_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings projects_locations_occurrences_get_iam_policy: operation: $ref: >- @@ -5614,17 +5618,17 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_occurrences_test_iam_permissions: + projects_locations_occurrences_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_set_iam_policy: + projects_locations_occurrences_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' @@ -5671,49 +5675,20 @@ components: update: [] replace: [] delete: [] - occurrences_vulnerability_summary: - id: google.containeranalysis.occurrences_vulnerability_summary - name: occurrences_vulnerability_summary - title: Occurrences_vulnerability_summary - methods: - projects_occurrences_get_vulnerability_summary: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_occurrences_get_vulnerability_summary: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary - - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary - insert: [] - update: [] - replace: [] - delete: [] notes: id: google.containeranalysis.notes name: notes title: Notes methods: - projects_notes_patch: + projects_notes_get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_notes_get: + projects_notes_patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' response: mediaType: application/json openAPIDocKey: '200' @@ -5757,17 +5732,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_patch: + projects_locations_notes_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_get: + projects_locations_notes_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -5818,6 +5793,14 @@ components: name: notes_iam_policies title: Notes_iam_policies methods: + projects_notes_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings projects_notes_set_iam_policy: operation: $ref: >- @@ -5832,10 +5815,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_notes_get_iam_policy: + projects_locations_notes_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' @@ -5847,14 +5830,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:getIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings projects_locations_notes_test_iam_permissions: operation: $ref: >- @@ -5870,59 +5845,51 @@ components: #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_get_iam_policy insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_set_iam_policy - - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_set_iam_policy + replace: + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_set_iam_policy + delete: [] + resources: + id: google.containeranalysis.resources + name: resources + title: Resources + methods: + projects_locations_resources_export_sbom: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1resources~1{resourcesId}:exportSBOM/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_resources_export_sbom: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1resources~1{resourcesId}:exportSBOM/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] delete: [] paths: - /v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM: + /v1/projects/{projectsId}/occurrences: parameters: &ref_1 - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - post: - description: Generates an SBOM for the given resource. - operationId: containeranalysis.projects.resources.exportSBOM - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExportSBOMRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ExportSBOMResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: resourcesId - required: true - schema: - type: string - /v1/projects/{projectsId}/occurrences: - parameters: *ref_1 + - $ref: '#/components/parameters/fields' get: description: Lists occurrences for the specified project. operationId: containeranalysis.projects.occurrences.list @@ -5985,32 +5952,6 @@ paths: type: string /v1/projects/{projectsId}/occurrences/{occurrencesId}: parameters: *ref_1 - get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.occurrences.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Occurrence' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: occurrencesId - required: true - schema: - type: string patch: description: Updates the specified occurrence. operationId: containeranalysis.projects.occurrences.patch @@ -6076,22 +6017,9 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + get: + description: Gets the specified occurrence. + operationId: containeranalysis.projects.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6103,7 +6031,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6115,21 +6043,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: + /v1/projects/{projectsId}/occurrences:batchCreate: parameters: *ref_1 post: - description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.testIamPermissions + description: Creates new occurrences in batch. + operationId: containeranalysis.projects.occurrences.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/BatchCreateOccurrencesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6141,34 +6064,56 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/BatchCreateOccurrencesResponse' parameters: - in: path name: projectsId required: true schema: type: string + /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: + parameters: *ref_1 + get: + description: Gets a summary of the number and severity of occurrences. + operationId: containeranalysis.projects.occurrences.getVulnerabilitySummary + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + parameters: - in: path - name: occurrencesId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: parameters: *ref_1 post: description: >- - Gets the access control policy for a note or an occurrence resource. + Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format + is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.getIamPolicy + operationId: containeranalysis.projects.occurrences.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6222,11 +6167,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: + /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: parameters: *ref_1 - get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.occurrences.getVulnerabilitySummary + post: + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.occurrences.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6238,27 +6194,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: occurrencesId + required: true schema: type: string - /v1/projects/{projectsId}/occurrences:batchCreate: + /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: parameters: *ref_1 post: - description: Creates new occurrences in batch. - operationId: containeranalysis.projects.occurrences.batchCreate + description: >- + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.occurrences.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6270,13 +6232,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesResponse' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: occurrencesId + required: true + schema: + type: string /v1/projects/{projectsId}/notes/{notesId}/occurrences: parameters: *ref_1 get: @@ -6312,17 +6279,43 @@ paths: name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string /v1/projects/{projectsId}/notes/{notesId}: parameters: *ref_1 + get: + description: Gets the specified note. + operationId: containeranalysis.projects.notes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: notesId + required: true + schema: + type: string patch: description: Updates the specified note. operationId: containeranalysis.projects.notes.patch @@ -6359,9 +6352,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Gets the specified note. - operationId: containeranalysis.projects.notes.get + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6373,7 +6366,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6385,9 +6378,22 @@ paths: required: true schema: type: string - delete: - description: Deletes the specified note. - operationId: containeranalysis.projects.notes.delete + /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.notes.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6399,7 +6405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6434,6 +6440,11 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: filter schema: @@ -6442,11 +6453,6 @@ paths: name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 post: description: Creates a new note. operationId: containeranalysis.projects.notes.create @@ -6582,22 +6588,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/notes: parameters: *ref_1 - post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.notes.getIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + get: + description: Lists notes for the specified project. + operationId: containeranalysis.projects.locations.notes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6609,7 +6604,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListNotesResponse' parameters: - in: path name: projectsId @@ -6617,20 +6612,31 @@ paths: schema: type: string - in: path - name: notesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: - parameters: *ref_1 + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Generates an SBOM for the given resource. - operationId: containeranalysis.projects.locations.resources.exportSBOM + description: Creates a new note. + operationId: containeranalysis.projects.locations.notes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMRequest' + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6642,7 +6648,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMResponse' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6654,19 +6660,15 @@ paths: required: true schema: type: string - - in: path - name: resourcesId - required: true + - in: query + name: noteId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: parameters: *ref_1 - delete: - description: >- - Deletes the specified occurrence. For example, use this method to delete - an occurrence when the occurrence is no longer applicable for the given - resource. - operationId: containeranalysis.projects.locations.occurrences.delete + get: + description: Gets the specified note. + operationId: containeranalysis.projects.locations.notes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6678,7 +6680,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6691,18 +6693,18 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string patch: - description: Updates the specified occurrence. - operationId: containeranalysis.projects.locations.occurrences.patch + description: Updates the specified note. + operationId: containeranalysis.projects.locations.notes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6714,7 +6716,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6727,7 +6729,7 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string @@ -6736,9 +6738,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.locations.occurrences.get + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.locations.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6750,7 +6752,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6763,15 +6765,26 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy: parameters: *ref_1 - get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary + post: + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.notes.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6783,7 +6796,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6795,20 +6808,27 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: notesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy: parameters: *ref_1 post: - description: Creates a new occurrence. - operationId: containeranalysis.projects.locations.occurrences.create + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.notes.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6820,7 +6840,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6832,9 +6852,26 @@ paths: required: true schema: type: string - get: - description: Lists occurrences for the specified project. - operationId: containeranalysis.projects.locations.occurrences.list + - in: path + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.notes.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6846,7 +6883,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOccurrencesResponse' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -6858,35 +6895,21 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: notesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate: parameters: *ref_1 post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.getIamPolicy + description: Creates new notes in batch. + operationId: containeranalysis.projects.locations.notes.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/BatchCreateNotesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6898,7 +6921,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/BatchCreateNotesResponse' parameters: - in: path name: projectsId @@ -6910,26 +6933,14 @@ paths: required: true schema: type: string - - in: path - name: occurrencesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: parameters: *ref_1 - post: + get: description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + Lists occurrences referencing the specified note. Provider projects can + use this method to get all occurrences across consumer projects + referencing the specified note. + operationId: containeranalysis.projects.locations.notes.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6941,7 +6952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/ListNoteOccurrencesResponse' parameters: - in: path name: projectsId @@ -6954,26 +6965,33 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy: + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.setIamPolicy + patch: + description: Updates the specified occurrence. + operationId: containeranalysis.projects.locations.occurrences.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6985,7 +7003,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -7002,16 +7020,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate: - parameters: *ref_1 - post: - description: Creates new occurrences in batch. - operationId: containeranalysis.projects.locations.occurrences.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateOccurrencesRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets the specified occurrence. + operationId: containeranalysis.projects.locations.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7023,7 +7039,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesResponse' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -7035,13 +7051,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: - parameters: *ref_1 - get: + - in: path + name: occurrencesId + required: true + schema: + type: string + delete: description: >- - Gets the note attached to the specified occurrence. Consumer projects - can use this method to get a note that belongs to a provider project. - operationId: containeranalysis.projects.locations.occurrences.getNotes + Deletes the specified occurrence. For example, use this method to delete + an occurrence when the occurrence is no longer applicable for the given + resource. + operationId: containeranalysis.projects.locations.occurrences.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7053,7 +7073,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -7070,14 +7090,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: parameters: *ref_1 get: description: >- - Lists occurrences referencing the specified note. Provider projects can - use this method to get all occurrences across consumer projects - referencing the specified note. - operationId: containeranalysis.projects.locations.notes.occurrences.list + Gets the note attached to the specified occurrence. Consumer projects + can use this method to get a note that belongs to a provider project. + operationId: containeranalysis.projects.locations.occurrences.getNotes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7089,7 +7108,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNoteOccurrencesResponse' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -7102,28 +7121,26 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notes: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy: parameters: *ref_1 - get: - description: Lists notes for the specified project. - operationId: containeranalysis.projects.locations.notes.list + post: + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7135,7 +7152,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNotesResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -7147,27 +7164,21 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: occurrencesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/occurrences: + parameters: *ref_1 post: - description: Creates a new note. - operationId: containeranalysis.projects.locations.notes.create + description: Creates a new occurrence. + operationId: containeranalysis.projects.locations.occurrences.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7179,7 +7190,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -7191,20 +7202,9 @@ paths: required: true schema: type: string - - in: query - name: noteId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: - parameters: *ref_1 - patch: - description: Updates the specified note. - operationId: containeranalysis.projects.locations.notes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Note' + get: + description: Lists occurrences for the specified project. + operationId: containeranalysis.projects.locations.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7216,7 +7216,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/ListOccurrencesResponse' parameters: - in: path name: projectsId @@ -7228,19 +7228,35 @@ paths: required: true schema: type: string - - in: path - name: notesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - get: - description: Gets the specified note. - operationId: containeranalysis.projects.locations.notes.get + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7252,7 +7268,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -7265,13 +7281,15 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - delete: - description: Deletes the specified note. - operationId: containeranalysis.projects.locations.notes.delete + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: + parameters: *ref_1 + get: + description: Gets a summary of the number and severity of occurrences. + operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7283,7 +7301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' parameters: - in: path name: projectsId @@ -7295,27 +7313,25 @@ paths: required: true schema: type: string - - in: path - name: notesId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.setIamPolicy + operationId: containeranalysis.projects.locations.occurrences.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7327,7 +7343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -7340,26 +7356,20 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate: parameters: *ref_1 post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.getIamPolicy + description: Creates new occurrences in batch. + operationId: containeranalysis.projects.locations.occurrences.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/BatchCreateOccurrencesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7371,7 +7381,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/BatchCreateOccurrencesResponse' parameters: - in: path name: projectsId @@ -7383,21 +7393,16 @@ paths: required: true schema: type: string - - in: path - name: notesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: parameters: *ref_1 post: - description: Creates new notes in batch. - operationId: containeranalysis.projects.locations.notes.batchCreate + description: Generates an SBOM for the given resource. + operationId: containeranalysis.projects.locations.resources.exportSBOM requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesRequest' + $ref: '#/components/schemas/ExportSBOMRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7409,7 +7414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesResponse' + $ref: '#/components/schemas/ExportSBOMResponse' parameters: - in: path name: projectsId @@ -7421,21 +7426,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions: + - in: path + name: resourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM: parameters: *ref_1 post: - description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.testIamPermissions + description: Generates an SBOM for the given resource. + operationId: containeranalysis.projects.resources.exportSBOM requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/ExportSBOMRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7447,7 +7452,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/ExportSBOMResponse' parameters: - in: path name: projectsId @@ -7455,12 +7460,7 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: notesId + name: resourcesId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml b/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml index 1eac2af9..baaa4630 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240809' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/document-warehouse servers: @@ -34,341 +34,491 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudContentwarehouseV1TimestampArray: - description: Timestamp values. - properties: - values: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - description: List of timestamp values. - type: array - id: GoogleCloudContentwarehouseV1TimestampArray - type: object - GoogleCloudDocumentaiV1DocumentPageToken: + GoogleCloudDocumentaiV1DocumentChunkedDocument: + id: GoogleCloudDocumentaiV1DocumentChunkedDocument type: object + description: Represents the chunks that the document is divided into. properties: - detectedLanguages: - type: array - description: A list of detected languages together with confidence. + chunks: + description: List of chunks. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - provenance: - description: The history of this annotation. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Text style attributes. - detectedBreak: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - description: A detected token. - id: GoogleCloudDocumentaiV1DocumentPageToken - GoogleCloudContentwarehouseV1SearchDocumentsRequest: - id: GoogleCloudContentwarehouseV1SearchDocumentsRequest + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + type: array + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores properties: - totalResultSize: - enumDescriptions: - - Total number calculation will be skipped. - - >- - Estimate total number. The total result size will be accurated up - to 10,000. This option will add cost and latency to your request. - - It may adversely impact performance. The limit is 1000,000. - enum: - - TOTAL_RESULT_SIZE_UNSPECIFIED - - ESTIMATED_SIZE - - ACTUAL_SIZE - description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. - type: string - qaSizeLimit: - type: integer - description: >- - Experimental, do not use. The limit on the number of documents - returned for the question-answering feature. To enable the - question-answering feature, set [DocumentQuery].is_nl_query to true. - format: int32 - pageToken: - type: string - description: >- - The token specifying the current offset within search results. See - SearchDocumentsResponse.next_page_token for an explanation of how to - obtain the next set of query results. - pageSize: - type: integer - format: int32 - description: >- - A limit on the number of documents returned in the search results. - Increasing this value above the default value of 10 can increase - search response time. The value can be between 1 and 100. - histogramQueries: + qualityScore: description: >- - An expression specifying a histogram request against matching - documents. Expression syntax is an aggregation function call with - histogram facets and other options. The following aggregation - functions are supported: * `count(string_histogram_facet)`: Count - the number of matching entities for each distinct attribute value. - Data types: * Histogram facet (aka filterable properties): Facet - names with format .. Facets will have the format - of: `a-zA-Z`. If the facet is a child facet, then the parent - hierarchy needs to be specified separated by dots in the prefix - after the schema id. Thus, the format for a multi- level facet is: - .. . Example: - schema123.root_parent_facet.middle_facet.child_facet * - DocumentSchemaId: (with no schema id prefix) to get histograms for - each document type (returns the schema id path, e.g. - projects/12345/locations/us-west/documentSchemas/abc123). Example - expression: * Document type counts: count('DocumentSchemaId') * For - schema id, abc123, get the counts for MORTGAGE_TYPE: - count('abc123.MORTGAGE_TYPE') + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + format: float + type: number + detectedDefects: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: A list of detected defects. type: array - requestMetadata: - description: >- - The meta information collected about the end user, used to enforce - access control and improve the search quality of the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - requireTotalSize: + type: object + description: Image quality scores for the page image. + GoogleCloudContentwarehouseV1Value: + properties: + floatValue: + description: Represents a float value. + type: number + format: float + booleanValue: type: boolean - description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. Enabling this flag may adversely - impact performance. Hint: If this is used with pagination, set this - flag on the initial query but set this to false on subsequent page - calls (keep the total count locally). Defaults to false. - offset: + description: Represents a boolean value. + enumValue: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' + description: Represents an enum value. + timestampValue: + description: Represents a timestamp value. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + datetimeValue: + description: Represents a datetime value. + $ref: '#/components/schemas/GoogleTypeDateTime' + stringValue: + type: string + description: Represents a string value. + intValue: format: int32 - description: >- - An integer that specifies the current offset (that is, starting - result location, amongst the documents deemed by the API as - relevant) in search results. This field is only considered if - page_token is unset. The maximum allowed value is 5000. Otherwise an - error is thrown. For example, 0 means to return results starting - from the first matching document, and 10 means to return from the - 11th document. This can be used for pagination, (for example, - pageSize = 10 and offset = 10 means to return from the second page). type: integer - documentQuery: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' - description: Query used to search against documents (keyword, filters, etc.). - orderBy: - type: string - description: >- - The criteria determining how search results are sorted. For - non-empty query, default is `"relevance desc"`. For empty query, - default is `"upload_date desc"`. Supported options are: * - `"relevance desc"`: By relevance descending, as determined by the - API algorithms. * `"upload_date desc"`: By upload date descending. * - `"upload_date"`: By upload date ascending. * `"update_date desc"`: - By last updated date descending. * `"update_date"`: By last updated - date ascending. * `"retrieval_importance desc"`: By retrieval - importance of properties descending. This feature is still under - development, please do not use unless otherwise instructed to do so. - description: Request message for DocumentService.SearchDocuments. - type: object - GoogleCloudDocumentaiV1DocumentPageVisualElement: + description: Represents a integer value. description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - id: GoogleCloudDocumentaiV1DocumentPageVisualElement + `Value` represents a dynamically typed value which can be either be a + float, a integer, a string, or a datetime value. A producer of value is + expected to set one of these variants. Absence of any variant indicates + an error. + id: GoogleCloudContentwarehouseV1Value type: object + GoogleCloudContentwarehouseV1RuleEngineOutput: + id: GoogleCloudContentwarehouseV1RuleEngineOutput properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for VisualElement. - type: - description: Type of the VisualElement. + ruleEvaluatorOutput: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput + description: >- + Output from Rule Evaluator containing matched, unmatched and invalid + rules. + actionExecutorOutput: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput + description: >- + Output from Action Executor containing rule and corresponding + actions execution result. + documentName: type: string - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - GoogleCloudContentwarehouseV1MapTypeOptions: - properties: {} - id: GoogleCloudContentwarehouseV1MapTypeOptions + description: >- + Name of the document against which the rules and actions were + evaluated. type: object - description: Configurations for a Map property. - GoogleCloudDocumentaiV1DocumentPageMatrix: - id: GoogleCloudDocumentaiV1DocumentPageMatrix description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. + Records the output of Rule Engine including rule evaluation and actions + result. + CloudAiPlatformTenantresourceInfraSpannerConfig: properties: - rows: - type: integer - format: int32 - description: Number of rows in the matrix. - cols: - type: integer - format: int32 - description: Number of columns in the matrix. - type: - description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - type: integer - format: int32 - data: + spannerNamespace: type: string - format: byte - description: The matrix data. - type: object - GoogleCloudContentwarehouseV1SearchDocumentsResponse: - description: Response message for DocumentService.SearchDocuments. - type: object - id: GoogleCloudContentwarehouseV1SearchDocumentsResponse - properties: - nextPageToken: - description: >- - The token that specifies the starting position of the next page of - results. This field is empty if there are no more results. + kmsKeyReference: type: string - matchingDocuments: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument - type: array description: >- - The document entities that match the specified - SearchDocumentsRequest. - histogramQueryResults: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult + Input [Optional]. The KMS key name or the KMS grant name used for + CMEK encryption. Only set this field when provisioning new Infra + Spanner databases. For existing Infra Spanner databases, this field + will be ignored because CMEK re-encryption is not supported. For + example, projects//locations//keyRings//cryptoKeys/ + spannerUniverse: + type: string description: >- - The histogram results that match with the specified - SearchDocumentsRequest.histogram_queries. - metadata: + Input [Required]. Every database in Spanner can be identified by the + following path name: /span//: + sdlBundlePath: + type: string + description: Input [Required]. The file path to the spanner SDL bundle. + createDatabaseOptions: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - totalSize: - format: int32 - type: integer + Input [Optional]. The options to create a spanner database. Note: + give the right options to ensure the right KMS key access audit + logging and AxT logging in expected logging category. + spannerLocalNamePrefix: + type: string + spannerBorgServiceAccount: + type: string description: >- - The total number of matched documents which is available only if the - client set SearchDocumentsRequest.require_total_size to `true` or - set SearchDocumentsRequest.total_result_size to `ESTIMATED_SIZE` or - `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI - would handle this condition by displaying "of many", for example: - "Displaying 10 of many". - questionAnswer: + Input [Optional]. The spanner borg service account for delegating + the kms key to. For example, + spanner-infra-cmek-nonprod@system.gserviceaccount.com, for the + nonprod universe. + id: CloudAiPlatformTenantresourceInfraSpannerConfig + type: object + description: 'The configuration for a spanner database provisioning. Next ID: 8' + GoogleCloudContentwarehouseV1Property: + properties: + textValues: + description: String/text property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' + name: type: string - description: Experimental. Question answer from the query against the document. - GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: + description: >- + Required. Must match the name of a PropertyDefinition in the + DocumentSchema. + dateTimeValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' + description: >- + Date time property values. It is not supported by CMEK compliant + deployment. + integerValues: + description: Integer property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' + enumValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' + description: Enum property values. + propertyValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' + description: Nested structured data property values. + floatValues: + description: Float property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' + mapProperty: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' + description: Map property values. + timestampValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' + description: >- + Timestamp property values. It is not supported by CMEK compliant + deployment. + id: GoogleCloudContentwarehouseV1Property + description: Property of a document. type: object - description: Response message for DocumentLinkService.ListLinkedSources. - id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + GoogleCloudContentwarehouseV1ActionOutput: properties: - pageSize: - type: integer + outputMessage: + type: string + description: Action execution output message. + actionState: + enum: + - UNKNOWN + - ACTION_SUCCEEDED + - ACTION_FAILED + - ACTION_TIMED_OUT + - ACTION_PENDING + enumDescriptions: + - The unknown state. + - State indicating action executed successfully. + - State indicating action failed. + - State indicating action timed out. + - State indicating action is pending. + description: State of an action. + type: string + actionId: + type: string + description: ID of the action. + id: GoogleCloudContentwarehouseV1ActionOutput + type: object + description: Represents the result of executing an action. + GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: + description: >- + The configuration of processing documents in Document Warehouse with + DocAi processors pipeline. + type: object + properties: + exportFolderPath: + type: string description: >- - The maximum number of document-links to return. The service may - return fewer than this value. If unspecified, at most 50 - document-links will be returned. The maximum value is 1000; values - above 1000 will be coerced to 1000. - format: int32 - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. + processorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The CDW processor information. + processorResultsFolderPath: description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - pageToken: + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. type: string + documents: + items: + type: string + type: array description: >- - A page token, received from a previous `ListLinkedSources` call. - Provide this to retrieve the subsequent page. When paginating, all - other parameters provided to `ListLinkedSources` must match the call - that provided the page token. - CloudAiPlatformTenantresourceTenantResource: - description: A collection of tenant resources. - id: CloudAiPlatformTenantresourceTenantResource + The list of all the resource names of the documents to be processed. + Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + GoogleCloudContentwarehouseV1FloatArray: type: object + id: GoogleCloudContentwarehouseV1FloatArray properties: - tenantProjectResources: + values: items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource - description: >- - A list of tenant projects and tenant resources to provision or - deprovision. - type: array - p4ServiceAccounts: - description: A list of P4 service accounts (go/p4sa) to provision or deprovision. + type: number + format: float type: array - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity - GoogleCloudDocumentaiV1DocumentPageImage: - description: Rendered image contents for this page. - type: object - id: GoogleCloudDocumentaiV1DocumentPageImage + description: List of float values. + description: Float values. + GoogleCloudDocumentaiV1Vertex: + id: GoogleCloudDocumentaiV1Vertex properties: - width: - description: Width of the image in pixels. + x: format: int32 type: integer - content: - type: string - description: Raw byte content of the image. - format: byte - height: - type: integer + description: X coordinate. + 'y': format: int32 - description: Height of the image in pixels. - mimeType: - type: string - description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - GoogleCloudContentwarehouseV1UpdateRuleSetRequest: - id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest - description: Request message for RuleSetService.UpdateRuleSet. + description: Y coordinate (starts from the top of the image). + type: integer + type: object + description: >- + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. + GoogleCloudContentwarehouseV1TimestampArray: + description: Timestamp values. type: object + id: GoogleCloudContentwarehouseV1TimestampArray properties: - ruleSet: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - description: Required. The rule set to update. - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + values: + description: List of timestamp values. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + GoogleCloudDocumentaiV1DocumentShardInfo: + description: >- + For a large document, sharding may be performed to produce several + document shards. Each document shard contains this field to detail which + shard it is. + type: object + id: GoogleCloudDocumentaiV1DocumentShardInfo properties: - type: - description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` + shardIndex: + format: int64 + description: The 0-based index of this shard. type: string - confidence: + textOffset: description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - format: float - type: number - type: object - description: Image Quality Defects - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - GoogleTypeColor: - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations + The index of the first character in Document.text in the overall + document global text. + format: int64 + type: string + shardCount: + description: Total number of shards. + format: int64 + type: string + GoogleCloudContentwarehouseV1TimestampValue: + id: GoogleCloudContentwarehouseV1TimestampValue + type: object + properties: + textValue: + description: >- + The string must represent a valid instant in UTC and is parsed using + java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. + "2013-09-29T18:46:19Z" + type: string + timestampValue: + format: google-datetime + type: string + description: Timestamp value + description: Timestamp value type. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: + properties: + blocks: + type: array + description: >- + A table cell is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + colSpan: + type: integer + format: int32 + description: How many columns this cell spans. + rowSpan: + description: How many rows this cell spans. + format: int32 + type: integer + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + description: Represents a cell in a table row. + type: object + GoogleCloudContentwarehouseV1CreateDocumentResponse: + id: GoogleCloudContentwarehouseV1CreateDocumentResponse + properties: + longRunningOperations: + description: post-processing LROs + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + ruleEngineOutput: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + description: >- + Output from Rule Engine recording the rule evaluator and action + executor's output. Refer format in: + google/cloud/contentwarehouse/v1/rule_engine.proto + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Document created after executing create request. + metadata: + description: >- + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + type: object + description: Response message for DocumentService.CreateDocument. + GoogleCloudContentwarehouseV1MapProperty: + type: object + id: GoogleCloudContentwarehouseV1MapProperty + description: >- + Map property value. Represents a structured entries of key value pairs, + consisting of field names which map to dynamically typed values. + properties: + fields: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' + description: Unordered map of dynamically typed values. + type: object + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + description: Human Review information of the document. + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + type: object + properties: + state: + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. + type: string + stateMessage: + type: string + description: >- + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. + GoogleCloudContentwarehouseV1UpdateDocumentMetadata: + description: Metadata object for UpdateDocument request (currently empty). + type: object + id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata + properties: {} + CloudAiPlatformTenantresourceTenantProjectResource: + properties: + iamPolicyBindings: + type: array + items: + $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' + description: >- + The dynamic IAM bindings that are granted under the tenant project. + Note: this should only add new bindings to the project if they don't + exist and the existing bindings won't be affected. + gcsBuckets: + type: array + description: The GCS buckets that are provisioned under the tenant project. + items: + $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' + tenantProjectNumber: + format: int64 + type: string + description: Output only. The tenant project number that has been created. + cloudSqlInstances: + description: >- + The CloudSQL instances that are provisioned under the tenant + project. + type: array + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig + tenantProjectId: + type: string + description: Output only. The tenant project ID that has been created. + tenantProjectConfig: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectConfig + description: The configurations of a tenant project. + infraSpannerConfigs: + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig + type: array + description: >- + The Infra Spanner databases that are provisioned under the tenant + project. Note: this is an experimental feature. + tenantServiceAccounts: + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity + type: array + description: >- + The service account identities (or enabled API service's P4SA) that + are expclicitly created under the tenant project (before JIT + provisioning during enabled API services). + tag: + type: string + description: >- + Input/Output [Required]. The tag that uniquely identifies a tenant + project within a tenancy unit. Note: for the same tenant project + tag, all tenant manager operations should be idempotent. + id: CloudAiPlatformTenantresourceTenantProjectResource + type: object + description: 'The tenant project and tenant resources. Next ID: 10' + GoogleCloudContentwarehouseV1AccessControlAction: + description: >- + Represents the action responsible for access control list management + operations. + id: GoogleCloudContentwarehouseV1AccessControlAction + type: object + properties: + operationType: + description: Identifies the type of operation. + type: string + enum: + - UNKNOWN + - ADD_POLICY_BINDING + - REMOVE_POLICY_BINDING + - REPLACE_POLICY_BINDING + enumDescriptions: + - The unknown operation type. + - Adds newly given policy bindings in the existing bindings list. + - >- + Removes newly given policy bindings from the existing bindings + list. + - >- + Replaces existing policy bindings with the given policy binding + list + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: >- + Represents the new policy from which bindings are added, removed or + replaced based on the type of the operation. the policy is limited + to a few 10s of KB. + GoogleCloudContentwarehouseV1MergeFieldsOptions: + type: object + description: Options for merging updated fields. + properties: + replaceRepeatedFields: + description: >- + When merging repeated fields, the default behavior is to append + entries from the source repeated field to the destination repeated + field. If you instead want to keep only the entries from the source + repeated field, set this flag to true. If you want to replace a + repeated field within a message field on the destination message, + you must set both replace_repeated_fields and replace_message_fields + to true, otherwise the repeated fields will be appended. + type: boolean + replaceMessageFields: + type: boolean + description: >- + When merging message fields, the default behavior is to merge the + content of two message fields together. If you instead want to use + the field from the source message to replace the corresponding field + in the destination message, set this flag to true. When this flag is + set, specified submessage fields that are missing in source will be + cleared in destination. + id: GoogleCloudContentwarehouseV1MergeFieldsOptions + GoogleTypeColor: + id: GoogleTypeColor + type: object + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's @@ -420,9 +570,14 @@ components: properties: green: description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + red: + description: The amount of red in the color as a value in the interval [0, 1]. format: float type: number alpha: + format: float type: number description: >- The fraction of this color that should be applied to the pixel. That @@ -435,387 +590,462 @@ components: being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). - format: float - red: - format: float - type: number - description: The amount of red in the color as a value in the interval [0, 1]. blue: format: float description: The amount of blue in the color as a value in the interval [0, 1]. type: number - id: GoogleTypeColor - type: object - GoogleCloudContentwarehouseV1UpdateDocumentRequest: + GoogleCloudContentwarehouseV1RunPipelineMetadata: + description: Metadata message of RunPipeline method. properties: - updateOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' - description: Options for the update operation. - cloudAiDocumentOption: - description: >- - Request Option for processing Cloud AI Document in Document - Warehouse. This field offers limited support for mapping entities - from Cloud AI Document to Warehouse Document. Please consult with - product team before using this field and other available options. + individualDocumentStatuses: + type: array + description: The list of response details of each document. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + exportToCdwPipelineMetadata: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Required. The document to update. + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + description: The pipeline metadata for Export-to-CDW pipeline. + userInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: User unique identification and groups information. + totalFileCount: + description: Number of files that were processed by the pipeline. + format: int32 + type: integer + processWithDocAiPipelineMetadata: + description: The pipeline metadata for Process-with-DocAi pipeline. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + gcsIngestPipelineMetadata: + description: The pipeline metadata for GcsIngest pipeline. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + failedFileCount: + type: integer + format: int32 + description: Number of files that have failed at some point in the pipeline. type: object - id: GoogleCloudContentwarehouseV1UpdateDocumentRequest - description: Request message for DocumentService.UpdateDocument. - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: + id: GoogleCloudContentwarehouseV1RunPipelineMetadata + GoogleCloudContentwarehouseV1PropertyFilter: + id: GoogleCloudContentwarehouseV1PropertyFilter type: object - description: Represents the page header associated with the chunk. properties: - pageSpan: - description: Page span of the header. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - text: - description: Header in text format. + documentSchemaName: + description: >- + The Document schema name Document.document_schema_name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. type: string - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - GoogleCloudDocumentaiV1DocumentPageBlock: + condition: + description: >- + The filter condition. The syntax for this expression is a subset of + SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, + `>=`, and `~~` where the left of the operator is a property name and + the right of the operator is a number or a quoted string. You must + escape backslash (\\) and quote (\") characters. `~~` is the LIKE + operator. The right of the operator must be a string. The only + supported property data type for LIKE is text_values. It provides + semantic search functionality by parsing, stemming and doing + synonyms expansion against the input query. It matches if the + property contains semantic similar content to the query. It is not + regex matching or wildcard matching. For example, "property.company + ~~ \"google\"" will match records whose property `property.compnay` + have values like "Google Inc.", "Google LLC" or "Google Company". + Supported functions are `LOWER([property_name])` to perform a case + insensitive match and `EMPTY([property_name])` to filter on the + existence of a key. Boolean expressions (AND/OR/NOT) are supported + up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) + AND E"), a maximum of 100 comparisons or functions are allowed in + the expression. The expression must be < 6000 bytes in length. Only + properties that are marked filterable are allowed + (PropertyDefinition.is_filterable). Property names do not need to be + prefixed by the document schema id (as is the case with histograms), + however property names will need to be prefixed by its parent + hierarchy, if any. For example: top_property_name.sub_property_name. + Sample Query: `(LOWER(driving_license)="class \"a\"" OR + EMPTY(driving_license)) AND driving_years > 10` CMEK compliant + deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and + `>=`. * Boolean expressions: AND and OR. + type: string + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig + description: >- + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this annotation. - layout: - description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: + service: + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + type: string + auditLogConfigs: type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - id: GoogleCloudDocumentaiV1DocumentPageBlock + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + description: The configuration for logging of each type of permission. type: object + GoogleCloudDocumentaiV1DocumentProvenanceParent: description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. - GoogleCloudContentwarehouseV1InitializeProjectResponse: + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. + type: object + id: GoogleCloudDocumentaiV1DocumentProvenanceParent properties: - message: - type: string - description: The message of the project initialization process. - state: - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - RUNNING - enumDescriptions: - - Clients should never see this. - - Finished project initialization without error. - - Finished project initialization with an error. - - Client canceled the LRO. - - Ask the customer to check the operation for results. - description: The state of the project initialization process. - type: string - description: Response message for projectService.InitializeProject - id: GoogleCloudContentwarehouseV1InitializeProjectResponse + id: + deprecated: true + description: The id of the parent provenance. + format: int32 + type: integer + index: + format: int32 + type: integer + description: >- + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. + revision: + description: The index of the index into current revision's parent_ids list. + type: integer + format: int32 + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + 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); } type: object - GoogleCloudContentwarehouseV1ListSynonymSetsResponse: - description: Response message for SynonymSetService.ListSynonymSets. + properties: {} + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: + properties: + pageEnd: + format: int32 + type: integer + description: Page where block ends in the document. + pageStart: + type: integer + description: Page where block starts in the document. + format: int32 + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan type: object + description: Represents where the block starts and ends in the document. + GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: + description: Response message for DocumentLinkService.ListLinkedSources. + id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse properties: - synonymSets: - type: array - description: The synonymSets from the specified parent. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' nextPageToken: - description: >- - A page token, received from a previous `ListSynonymSets` call. - Provide this to retrieve the subsequent page. type: string - id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Font and other text style attributes. + 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. + documentLinks: + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + description: Source document-links. + type: object + GoogleCloudContentwarehouseV1EnumArray: + type: object + description: Enum values. + id: GoogleCloudContentwarehouseV1EnumArray properties: - strikeout: - type: boolean + values: + items: + type: string + description: List of enum values. + type: array + CloudAiPlatformTenantresourceGcsBucketConfig: + properties: + bucketName: + type: string description: >- - Whether the text is strikethrough. This feature is not supported - yet. - letterSpacing: - type: number - description: Letter spacing in points. - format: double - superscript: + Input/Output [Optional]. The name of a GCS bucket with max length of + 63 chars. If not set, a random UUID will be generated as bucket + name. + kmsKeyReference: + type: string description: >- - Whether the text is a superscript. This feature is not supported - yet. - type: boolean - fontSize: - format: int32 - description: Font size in points (`1` point is `¹⁄₇₂` inches). - type: integer - textColor: - description: Color of the text. - $ref: '#/components/schemas/GoogleTypeColor' - smallcaps: + Input/Output [Optional]. The KMS key name or the KMS grant name used + for CMEK encryption. Only set this field when provisioning new GCS + bucket. For existing GCS bucket, this field will be ignored because + CMEK re-encryption is not supported. + admins: + type: array + items: + type: string + entityName: description: >- - Whether the text is in small caps. This feature is not supported - yet. - type: boolean - handwritten: - description: Whether the text is handwritten. - type: boolean - fontWeight: - format: int32 - description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - type: integer - underlined: - description: Whether the text is underlined. - type: boolean - italic: - description: Whether the text is italic. - type: boolean - backgroundColor: - description: Color of the background. - $ref: '#/components/schemas/GoogleTypeColor' - pixelFontSize: - description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - type: number - format: double - fontType: - description: Name or style of the font. + Input/Output [Optional]. Only needed for per-entity tenant GCP + resources. During Deprovision API, the on-demand deletion will only + cover the tenant GCP resources with the specified entity name. type: string - bold: - type: boolean - description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - subscript: - type: boolean - description: Whether the text is a subscript. This feature is not supported yet. - type: object - GoogleCloudContentwarehouseV1TimestampValue: - properties: - textValue: + viewers: + description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. + items: + type: string + type: array + ttlDays: + type: integer description: >- - The string must represent a valid instant in UTC and is parsed using - java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. - "2013-09-29T18:46:19Z" - type: string - timestampValue: - format: google-datetime - type: string - description: Timestamp value - description: Timestamp value type. - type: object - id: GoogleCloudContentwarehouseV1TimestampValue - GoogleCloudContentwarehouseV1MergeFieldsOptions: + Input/Output [Optional]. Only needed when the content in bucket need + to be garbage collected within some amount of days. + format: int32 + description: The identity to configure a GCS bucket. + id: CloudAiPlatformTenantresourceGcsBucketConfig type: object - properties: - replaceRepeatedFields: - description: >- - When merging repeated fields, the default behavior is to append - entries from the source repeated field to the destination repeated - field. If you instead want to keep only the entries from the source - repeated field, set this flag to true. If you want to replace a - repeated field within a message field on the destination message, - you must set both replace_repeated_fields and replace_message_fields - to true, otherwise the repeated fields will be appended. - type: boolean - replaceMessageFields: - description: >- - When merging message fields, the default behavior is to merge the - content of two message fields together. If you instead want to use - the field from the source message to replace the corresponding field - in the destination message, set this flag to true. When this flag is - set, specified submessage fields that are missing in source will be - cleared in destination. - type: boolean - id: GoogleCloudContentwarehouseV1MergeFieldsOptions - description: Options for merging updated fields. - GoogleCloudContentwarehouseV1GetDocumentRequest: - description: Request message for DocumentService.GetDocument. - id: GoogleCloudContentwarehouseV1GetDocumentRequest - properties: - requestMetadata: - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + GoogleCloudContentwarehouseV1TimeFilter: type: object - GoogleCloudContentwarehouseV1InitializeProjectRequest: - id: GoogleCloudContentwarehouseV1InitializeProjectRequest - description: Request message for projectService.InitializeProject + description: Filter on create timestamp or update timestamp of documents. + id: GoogleCloudContentwarehouseV1TimeFilter properties: - enableCalUserEmailLogging: - type: boolean - description: Optional. Whether to enable CAL user email logging. - kmsKey: - description: >- - Optional. The KMS key used for CMEK encryption. It is required that - the kms key is in the same region as the endpoint. The same key will - be used for all provisioned resources, if encryption is available. - If the kms_key is left empty, no encryption will be enforced. - type: string - documentCreatorDefaultRole: - enumDescriptions: - - Unspecified, will be default to document admin role. - - >- - Document Admin, same as - contentwarehouse.googleapis.com/documentAdmin. - - >- - Document Editor, same as - contentwarehouse.googleapis.com/documentEditor. - - >- - Document Viewer, same as - contentwarehouse.googleapis.com/documentViewer. - type: string - enum: - - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED - - DOCUMENT_ADMIN - - DOCUMENT_EDITOR - - DOCUMENT_VIEWER - description: Optional. The default role for the person who create a document. - databaseType: - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - description: Required. The type of database used to store customer data - enumDeprecated: - - false - - false - - true - type: string - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - accessControlMode: - type: string - description: Required. The access control mode for accessing the customer data + timeField: enumDescriptions: - - This value is required by protobuf best practices - - 'Universal Access: No document level access control.' - - Document level access control with customer own Identity Service. - - Document level access control using Google Cloud Identity. - enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - type: object - GoogleCloudContentwarehouseV1ActionOutput: - properties: - actionId: - type: string - description: ID of the action. - outputMessage: - type: string - description: Action execution output message. - actionState: + - Default value. + - Earliest document create time. + - Latest document update time. + - Time when document becomes mutable again. + description: >- + Specifies which time field to filter documents on. Defaults to + TimeField.UPLOAD_TIME. type: string enum: - - UNKNOWN - - ACTION_SUCCEEDED - - ACTION_FAILED - - ACTION_TIMED_OUT - - ACTION_PENDING - description: State of an action. - enumDescriptions: - - The unknown state. - - State indicating action executed successfully. - - State indicating action failed. - - State indicating action timed out. - - State indicating action is pending. - id: GoogleCloudContentwarehouseV1ActionOutput - type: object - description: Represents the result of executing an action. - GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: + - TIME_FIELD_UNSPECIFIED + - CREATE_TIME + - UPDATE_TIME + - DISPOSITION_TIME + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: properties: - nextPageToken: - type: string - 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. - documentSchemas: + cells: + description: A table row is a list of table cells. type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - description: The document schemas from the specified parent. - description: Response message for DocumentSchemaService.ListDocumentSchemas. - id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell type: object - CloudAiPlatformTenantresourceGcsBucketConfig: - id: CloudAiPlatformTenantresourceGcsBucketConfig + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Represents a row in a table. + CloudAiPlatformTenantresourceTenantResource: type: object + description: A collection of tenant resources. + id: CloudAiPlatformTenantresourceTenantResource properties: - admins: + tenantProjectResources: + description: >- + A list of tenant projects and tenant resources to provision or + deprovision. type: array items: - type: string - viewers: - description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource + p4ServiceAccounts: type: array + description: A list of P4 service accounts (go/p4sa) to provision or deprovision. items: - type: string - ttlDays: - format: int32 + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity + GoogleTypePostalAddress: + description: >- + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 + id: GoogleTypePostalAddress + type: object + properties: + sublocality: description: >- - Input/Output [Optional]. Only needed when the content in bucket need - to be garbage collected within some amount of days. + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + type: string + recipients: + items: + type: string + type: array + description: >- + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. + revision: type: integer - kmsKeyReference: + description: >- + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + format: int32 + sortingCode: + description: >- + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). + type: string + organization: + type: string + description: Optional. The name of the organization at the address. + postalCode: type: string description: >- - Input/Output [Optional]. The KMS key name or the KMS grant name used - for CMEK encryption. Only set this field when provisioning new GCS - bucket. For existing GCS bucket, this field will be ignored because - CMEK re-encryption is not supported. - bucketName: + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (e.g. state/zip validation in the U.S.A.). + addressLines: + description: >- + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (e.g. "Austin, TX"), it is important that the line order is + clear. The order of address lines should be "envelope order" for the + country/region of the address. In places where this can vary (e.g. + Japan), address_language is used to make it explicit (e.g. "ja" for + large-to-small ordering and "ja-Latn" or "en" for small-to-large). + This way, the most specific line of an address can be selected based + on the language. The minimum permitted structural representation of + an address consists of a region_code with all remaining information + placed in the address_lines. It would be possible to format such an + address very approximately without geocoding, but no semantic + reasoning could be made about any of the address components until it + was at least partially resolved. Creating an address only containing + a region_code and address_lines, and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). + type: array + items: + type: string + administrativeArea: type: string description: >- - Input/Output [Optional]. The name of a GCS bucket with max length of - 63 chars. If not set, a random UUID will be generated as bucket - name. - entityName: + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. Specifically, for + Spain this is the province and not the autonomous community (e.g. + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. E.g. in Switzerland this + should be left unpopulated. + locality: + description: >- + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. type: string + regionCode: description: >- - Input/Output [Optional]. Only needed for per-entity tenant GCP - resources. During Deprovision API, the on-demand deletion will only - cover the tenant GCP resources with the specified entity name. - description: The identity to configure a GCS bucket. - GoogleCloudContentwarehouseV1IntegerArray: + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + type: string + languageCode: + type: string + description: >- + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + GoogleCloudContentwarehouseV1PublishAction: properties: - values: - description: List of integer values. - items: - format: int32 - type: integer + messages: type: array + items: + type: string + description: Messages to be published. + topicId: + type: string + description: >- + The topic id in the Pub/Sub service for which messages will be + published to. type: object - id: GoogleCloudContentwarehouseV1IntegerArray - description: Integer values. + id: GoogleCloudContentwarehouseV1PublishAction + description: >- + Represents the action responsible for publishing messages to a Pub/Sub + topic. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: + properties: + textBlock: + description: Block consisting of text content. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + tableBlock: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + description: Block consisting of table content/structure. + listBlock: + description: Block consisting of list content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + blockId: + type: string + description: ID of the block. + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + description: Page span of the block. + id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + description: >- + Represents a block. A block could be one of the various types (text, + table, list) supported. + type: object + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + properties: + confidence: + format: float + type: number + description: Confidence of detected language. Range `[0, 1]`. + languageCode: + description: >- + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. + type: string + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: object + description: Detected language for a structural component. GoogleCloudContentwarehouseV1EnumTypeOptions: description: Configurations for an enum/categorical property. properties: possibleValues: + description: Required. List of possible enum values. items: type: string type: array - description: Required. List of possible enum values. validationCheckDisabled: type: boolean description: >- @@ -824,546 +1054,477 @@ components: runs by default. id: GoogleCloudContentwarehouseV1EnumTypeOptions type: object - CloudAiPlatformTenantresourceIamPolicyBinding: - type: object + GoogleCloudDocumentaiV1DocumentTextChange: + id: GoogleCloudDocumentaiV1DocumentTextChange + description: This message is used for text changes aka. OCR corrections. properties: - members: - description: >- - Input/Output [Required]. The member service accounts with the roles - above. Note: placeholders are same as the resource above. + provenance: + description: The history of this annotation. + deprecated: true items: - type: string + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' type: array - resource: - type: string - description: >- - Input/Output [Required]. The resource name that will be accessed by - members, which also depends on resource_type. Note: placeholders are - supported in resource names. For example, ${tpn} will be used when - the tenant project number is not ready. - role: - type: string - description: Input/Output [Required]. The role for members below. - resourceType: + changedText: type: string + description: The text that replaces the text identified in the `text_anchor`. + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' description: >- - Input/Output [Required]. Specifies the type of resource that will be - accessed by members. + Provenance of the correction. Text anchor indexing into the + Document.text. There can only be a single `TextAnchor.text_segments` + element. If the start and end index of the text segment are the + same, the text change is inserted before that index. + type: object + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + type: object + properties: + type: enum: - - RESOURCE_TYPE_UNSPECIFIED - - PROJECT - - SERVICE_ACCOUNT - - GCS_BUCKET - - SERVICE_CONSUMER - - AR_REPO + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN enumDescriptions: - - '' - - >- - The value of resource field is the ID or number of a project. - Format is - - >- - The value of resource field is the resource name of a service - account. Format is projects//serviceAccounts/ - - >- - The value of resource field is the name of a GCS bucket (not its - resource name). Format is . - - >- - The value of resource field is the resource name of a service - consumer. Format is services//consumers/ - - >- - The value of the resource field is the AR Image Uri which - identifies an AR REPO. Allowed formats are: /// ///: ///@ - id: CloudAiPlatformTenantresourceIamPolicyBinding - description: >- - The dynamic IAM bindings to be granted after tenant projects are - created. - GoogleCloudContentwarehouseV1QAResult: - id: GoogleCloudContentwarehouseV1QAResult + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. + type: string + description: Detected break type. + description: Detected break at the end of a Token. + GoogleCloudDocumentaiV1DocumentTextAnchor: type: object properties: - confidenceScore: - description: >- - The calibrated confidence score for this document, in the range [0., - 1.]. This represents the confidence level for whether the returned - document and snippet answers the user's query. - type: number - format: float - highlights: - description: Highlighted sections in the snippet. + textSegments: items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment type: array - description: Additional result info for the question-answering feature. - GoogleCloudContentwarehouseV1ResponseMetadata: - description: >- - Additional information returned to client, such as debugging - information. + description: The text segments from the Document.text. + content: + description: >- + Contains the content of the text span so that users do not have to + look it up in the text_segments. It is always populated for + formFields. + type: string + description: Text reference indexing into the Document.text. + id: GoogleCloudDocumentaiV1DocumentTextAnchor + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + description: A detected barcode. + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + type: object properties: - requestId: + layout: + description: Layout for DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + barcode: + description: Detailed barcode information of the DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + GoogleCloudDocumentaiV1DocumentEntityRelation: + id: GoogleCloudDocumentaiV1DocumentEntityRelation + type: object + description: Relationship between Entities. + properties: + subjectId: + type: string + description: Subject entity id. + relation: + type: string + description: Relationship description. + objectId: + type: string + description: Object entity id. + GoogleCloudContentwarehouseV1FileTypeFilter: + id: GoogleCloudContentwarehouseV1FileTypeFilter + type: object + description: Filter for the specific types of documents returned. + properties: + fileType: + enumDescriptions: + - Default document type. If set, disables the filter. + - Returns all document types, including folders. + - Returns only folders. + - Returns only non-folder documents. + - Returns only root folders type: string + enum: + - FILE_TYPE_UNSPECIFIED + - ALL + - FOLDER + - DOCUMENT + - ROOT_FOLDER + description: The type of files to return. + GoogleCloudContentwarehouseV1SetAclResponse: + id: GoogleCloudContentwarehouseV1SetAclResponse + type: object + description: Response message for DocumentService.SetAcl. + properties: + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: The policy will be attached to a resource (e.g. projecct, document). + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- - A unique id associated with this call. This id is logged for - tracking purpose. - id: GoogleCloudContentwarehouseV1ResponseMetadata + Additional information for the API invocation, such as the request + tracking id. + GoogleCloudDocumentaiV1DocumentPageToken: + properties: + styleInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Text style attributes. + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this annotation. + detectedBreak: + description: Detected break at the end of a Token. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + layout: + description: Layout for Token. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + id: GoogleCloudDocumentaiV1DocumentPageToken type: object - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + description: A detected token. + GoogleCloudDocumentaiV1DocumentPageSymbol: + properties: + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + layout: + description: Layout for Symbol. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + id: GoogleCloudDocumentaiV1DocumentPageSymbol + description: A detected symbol. type: object - description: Human Review information of the document. + CloudAiPlatformTenantresourceCloudSqlInstanceConfig: + type: object + id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig + description: >- + The identity to configure a CloudSQL instance provisioned via SLM + Terraform. properties: - stateMessage: + kmsKeyReference: description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. + Input [Optional]. The KMS key name or the KMS grant name used for + CMEK encryption. Only set this field when provisioning new CloudSQL + instances. For existing CloudSQL instances, this field will be + ignored because CMEK re-encryption is not supported. type: string - state: + cloudSqlInstanceName: + description: >- + Input/Output [Optional]. The CloudSQL instance name within SLM + instance. If not set, a random UUIC will be generated as instance + name. type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - GoogleCloudContentwarehouseV1DocumentReference: + mdbRolesForCorpAccess: + items: + type: string + type: array + description: Input [Optional]. MDB roles for corp access to CloudSQL instance. + slmInstanceType: + type: string + description: Input [Required]. The SLM instance type to provision CloudSQL. + cloudSqlInstanceConnectionName: + description: Output only. The CloudSQL instance connection name. + type: string + slmInstanceName: + description: Output only. The SLM instance's full resource name. + type: string + slmInstanceTemplate: + type: string + description: Input [Required]. The SLM instance template to provision CloudSQL. + GoogleCloudContentwarehouseV1DocumentSchema: + type: object properties: - documentIsFolder: - type: boolean - description: The document type of the document being referenced. - deleteTime: - readOnly: true - description: Output only. The time when the document is deleted. + updateTime: type: string + description: Output only. The time when the document schema is last updated. format: google-datetime - updateTime: readOnly: true + propertyDefinitions: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + description: Document details. + type: array + createTime: + description: Output only. The time when the document schema is created. type: string - description: Output only. The time when the document is last updated. format: google-datetime - documentIsLegalHoldFolder: - description: Document is a folder with legal hold. + readOnly: true + documentIsFolder: type: boolean - documentName: - description: Required. Name of the referenced document. - type: string - snippet: - type: string description: >- - Stores the subset of the referenced document's content. This is - useful to allow user peek the information of the referenced - document. - createTime: - format: google-datetime - readOnly: true - description: Output only. The time when the document is created. + Document Type, true refers the document is a folder, otherwise it is + a typical document. + name: + description: >- + The resource name of the document schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + The name is ignored when creating a document schema. type: string - documentIsRetentionFolder: - description: Document is a folder with retention policy. - type: boolean + description: + type: string + description: Schema description. displayName: - description: >- - display_name of the referenced document; this name does not need to - be consistent to the display_name in the Document proto, depending - on the ACL constraint. type: string + description: >- + Required. Name of the schema given by the user. Must be unique per + project. + description: A document schema used to define document structure. + id: GoogleCloudContentwarehouseV1DocumentSchema + GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: + properties: {} + description: Metadata object for UpdateDocument request (currently empty). type: object - id: GoogleCloudContentwarehouseV1DocumentReference - description: References to the documents. - GoogleCloudContentwarehouseV1ProcessorInfo: - description: The DocAI processor information. + id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata + GoogleCloudContentwarehouseV1ActionExecutorOutput: + id: GoogleCloudContentwarehouseV1ActionExecutorOutput + properties: + ruleActionsPairs: + type: array + description: List of rule and corresponding actions result. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' type: object - id: GoogleCloudContentwarehouseV1ProcessorInfo + description: Represents the output of the Action Executor. + GoogleCloudContentwarehouseV1ListRuleSetsResponse: + description: Response message for RuleSetService.ListRuleSets. properties: - documentType: - description: The processor will process the documents with this document type. - type: string - schemaName: - type: string - description: >- - The Document schema resource name. All documents processed by this - processor will use this schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - processorName: + nextPageToken: type: string description: >- - The processor resource name. Format is - `projects/{project}/locations/{location}/processors/{processor}`, or - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - GoogleCloudContentwarehouseV1DeleteDocumentRequest: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + ruleSets: + description: The rule sets from the specified parent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + id: GoogleCloudContentwarehouseV1ListRuleSetsResponse + type: object + GoogleCloudContentwarehouseV1QAResult: + type: object + description: Additional result info for the question-answering feature. properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + highlights: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight + description: Highlighted sections in the snippet. + type: array + confidenceScore: description: >- - The meta information collected about the end user, used to enforce - access control for the service. - description: Request message for DocumentService.DeleteDocument. - id: GoogleCloudContentwarehouseV1DeleteDocumentRequest - type: object - GoogleCloudContentwarehouseV1CloudAIDocumentOption: + The calibrated confidence score for this document, in the range [0., + 1.]. This represents the confidence level for whether the returned + document and snippet answers the user's query. + format: float + type: number + id: GoogleCloudContentwarehouseV1QAResult + GoogleCloudContentwarehouseV1HistogramQueryResult: type: object - id: GoogleCloudContentwarehouseV1CloudAIDocumentOption - description: Request Option for processing Cloud AI Document in CW Document. + id: GoogleCloudContentwarehouseV1HistogramQueryResult + description: Histogram result that matches HistogramQuery specified in searches. properties: - customizedEntitiesPropertiesConversions: - description: If set, only selected entities will be converted to properties. + histogram: additionalProperties: + format: int64 type: string + description: >- + A map from the values of the facet associated with distinct values + to the number of matching entries with corresponding value. The key + format is: * (for string histogram) string values stored in the + field. type: object - enableEntitiesConversions: - description: Whether to convert all the entities to properties. - type: boolean - GoogleCloudContentwarehouseV1Action: - properties: - dataValidation: - description: Action triggering data validation operations. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction - actionId: - description: ID of the action. Managed internally. + histogramQuery: type: string - dataUpdate: - description: Action triggering data update operations. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' - removeFromFolderAction: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction - description: Action removing a document from a folder. - deleteDocumentAction: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction - description: Action deleting the document. - accessControl: - description: Action triggering access control operations. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction - addToFolder: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' - description: Action triggering create document link operation. - publishToPubSub: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' - description: Action publish to Pub/Sub operation. - description: Represents the action triggered by Rule Engine when the rule is true. - id: GoogleCloudContentwarehouseV1Action + description: Requested histogram expression. + GoogleCloudDocumentaiV1DocumentStyleFontSize: + id: GoogleCloudDocumentaiV1DocumentStyleFontSize type: object - GoogleTypeDate: - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp properties: - month: - type: integer - format: int32 - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - type: integer - day: - type: integer + unit: + type: string description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 - id: GoogleTypeDate - type: object - GoogleCloudDocumentaiV1DocumentPage: - id: GoogleCloudDocumentaiV1DocumentPage + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). + size: + description: Font size for the text. + type: number + format: float + description: Font size with unit. + GoogleCloudContentwarehouseV1TextArray: type: object - description: A page in a Document. properties: - lines: - description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. + values: type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' - paragraphs: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - type: array - description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - blocks: + type: string + description: List of text values. + id: GoogleCloudContentwarehouseV1TextArray + description: String/text values. + GoogleCloudContentwarehouseV1DateTimeArray: + description: DateTime values. + id: GoogleCloudContentwarehouseV1DateTimeArray + properties: + values: type: array description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. + List of datetime values. Both OffsetDateTime and ZonedDateTime are + supported. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' - dimension: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - description: Physical dimension of the page. - pageNumber: - format: int32 - type: integer + $ref: '#/components/schemas/GoogleTypeDateTime' + type: object + GoogleCloudDocumentaiV1DocumentStyle: + properties: + fontSize: + description: Font size. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + textDecoration: + type: string description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - formFields: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - description: A list of visually detected form fields on the page. - symbols: - type: array - description: A list of visually detected symbols on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - tokens: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - description: A list of visually detected tokens on the page. - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this page. - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - visualElements: - type: array + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + fontFamily: + type: string description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - imageQualityScores: - description: Image quality scores. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - detectedBarcodes: - type: array - description: A list of detected barcodes. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - tables: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - description: A list of visually detected tables on the page. - image: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + fontWeight: + type: string description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the page. - transforms: + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + textStyle: description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' - GoogleCloudDocumentaiV1DocumentTextAnchor: - description: Text reference indexing into the Document.text. - id: GoogleCloudDocumentaiV1DocumentTextAnchor - properties: - textSegments: - type: array - description: The text segments from the Document.text. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - content: - description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. type: string + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text color. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text background color. + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. type: object - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: - description: Image quality scores for the page image. + id: GoogleCloudDocumentaiV1DocumentStyle + GoogleCloudContentwarehouseV1IntegerTypeOptions: + id: GoogleCloudContentwarehouseV1IntegerTypeOptions type: object - properties: - qualityScore: - type: number - format: float - description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - detectedDefects: - description: A list of detected defects. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - type: array - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: - properties: - pageEnd: - format: int32 - type: integer - description: Page where block ends in the document. - pageStart: - description: Page where block starts in the document. - type: integer - format: int32 + description: Configurations for an integer property. + properties: {} + GoogleCloudContentwarehouseV1UpdateDocumentResponse: + description: Response message for DocumentService.UpdateDocument. type: object - description: Represents where the block starts and ends in the document. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig properties: - service: + ruleEngineOutput: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - type: string - auditLogConfigs: + Output from Rule Engine recording the rule evaluator and action + executor's output. Refer format in: + google/cloud/contentwarehouse/v1/rule_engine.proto + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Updated document after executing update request. + metadata: + description: >- + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + id: GoogleCloudContentwarehouseV1UpdateDocumentResponse + GoogleCloudContentwarehouseV1PropertyArray: + properties: + properties: + description: List of property values. type: array - description: The configuration for logging of each type of permission. items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' + description: Property values. type: object - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: + id: GoogleCloudContentwarehouseV1PropertyArray + GoogleCloudContentwarehouseV1DataUpdateAction: properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + entries: + type: object description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest + Map of (K, V) -> (valid name of the field, new value of the field) + E.g., ("age", "60") entry triggers update of field age with a value + of 60. If the field is not present then new entry is added. During + update action execution, value strings will be casted to appropriate + types. + additionalProperties: + type: string + id: GoogleCloudContentwarehouseV1DataUpdateAction + description: Represents the action responsible for properties update operations. type: object - description: Request message for DocumentLinkService.DeleteDocumentLink. GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + type: object + description: >- + A text segment in the Document.text. The indices may be out of bounds + which indicate that the text extends into another document shard for + large sharded documents. See ShardInfo.text_offset properties: - startIndex: + endIndex: + description: TextSegment half open end UTF-8 char index in the Document.text. + format: int64 type: string + startIndex: format: int64 description: TextSegment start UTF-8 char index in the Document.text. - endIndex: - format: int64 type: string - description: TextSegment half open end UTF-8 char index in the Document.text. id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + GoogleCloudDocumentaiV1DocumentPageLine: type: object + id: GoogleCloudDocumentaiV1DocumentPageLine description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset - GoogleCloudDocumentaiV1DocumentRevision: - id: GoogleCloudDocumentaiV1DocumentRevision - type: object + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. properties: - parent: - type: array + provenance: + description: The history of this annotation. deprecated: true - items: - type: integer - format: int32 - description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - id: - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - type: string - createTime: - type: string - format: google-datetime - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - humanReview: - description: Human Review information of this revision. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - parentIds: - items: - type: string - description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + layout: + description: Layout for Line. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. type: array - processor: - type: string - description: >- - If the annotation was made by processor identify the processor by - its resource name. - agent: - type: string - description: >- - If the change was made by a person specify the name or id of that - person. - description: Contains past or forward revisions of this document. - GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: - properties: {} - description: Metadata object for CreateDocument request (currently empty). - type: object - id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata - GoogleCloudContentwarehouseV1DateTimeTypeOptions: - id: GoogleCloudContentwarehouseV1DateTimeTypeOptions - description: Configurations for a date time property. - properties: {} - type: object - GoogleCloudContentwarehouseV1FetchAclResponse: - type: object - properties: - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: The IAM policy. - metadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - description: >- - Additional information for the API invocation, such as the request - tracking id. - description: Response message for DocumentService.FetchAcl. - id: GoogleCloudContentwarehouseV1FetchAclResponse + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage GoogleTypeMoney: + description: Represents an amount of money with its currency type. properties: - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. units: + type: string + format: int64 description: >- The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - type: string - format: int64 nanos: + format: int32 + type: integer description: >- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is @@ -1371,1468 +1532,1480 @@ components: `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - description: Represents an amount of money with its currency type. + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string id: GoogleTypeMoney type: object - GoogleCloudContentwarehouseV1WeightedSchemaProperty: + GoogleCloudDocumentaiV1DocumentPageFormField: + id: GoogleCloudDocumentaiV1DocumentPageFormField + description: A form field detected on the page. + type: object properties: - documentSchemaName: - description: The document schema name. + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + valueType: type: string - propertyNames: - description: The property definition names in the schema. - items: - type: string - type: array - type: object - id: GoogleCloudContentwarehouseV1WeightedSchemaProperty - description: Specifies the schema property name. - CloudAiPlatformTenantresourceTenantServiceAccountIdentity: - id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity - properties: - serviceAccountEmail: - type: string - description: Output only. The email address of the generated service account. - serviceName: description: >- - Input/Output [Required]. The service that the service account - belongs to. (e.g. cloudbuild.googleapis.com for GCB service - accounts) + If the value is non-textual, this field represents the type. Current + valid values are: - blank (this indicates the `field_value` is + normal text) - `unfilled_checkbox` - `filled_checkbox` + correctedValueText: type: string - type: object - description: >- - The identity of service accounts that have been explicitly created under - tenant projects. - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: - type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - properties: - pageEnd: - type: integer - description: Page where chunk ends in the document. - format: int32 - pageStart: - type: integer - description: Page where chunk starts in the document. - format: int32 - description: Represents where the chunk starts and ends in the document. - GoogleCloudContentwarehouseV1DataUpdateAction: - id: GoogleCloudContentwarehouseV1DataUpdateAction - properties: - entries: - type: object - additionalProperties: - type: string description: >- - Map of (K, V) -> (valid name of the field, new value of the field) - E.g., ("age", "60") entry triggers update of field age with a value - of 60. If the field is not present then new entry is added. During - update action execution, value strings will be casted to appropriate - types. - description: Represents the action responsible for properties update operations. - type: object - GoogleIamV1Policy: - properties: - etag: - format: byte + Created for Labeling UI to export value text. If corrections were + made to the text identified by the `field_value.text_anchor`, this + field will contain the correction. + correctedKeyText: description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. + Created for Labeling UI to export key text. If corrections were made + to the text identified by the `field_name.text_anchor`, this field + will contain the correction. type: string - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. + fieldName: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: >- + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + fieldValue: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the FormField value. + valueDetectedLanguages: type: array + description: A list of detected languages for value together with confidence. items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - version: - format: int32 - type: integer - description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - bindings: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + nameDetectedLanguages: + description: A list of detected languages for name together with confidence. items: - $ref: '#/components/schemas/GoogleIamV1Binding' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: + properties: + nextPageToken: description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. + 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 + documentSchemas: type: array - id: GoogleIamV1Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + description: The document schemas from the specified parent. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + description: Response message for DocumentSchemaService.ListDocumentSchemas. + id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse type: object - GoogleCloudContentwarehouseV1DataValidationAction: + GoogleCloudDocumentaiV1DocumentPageDimension: properties: - conditions: - additionalProperties: - type: string - description: >- - Map of (K, V) -> (field, string condition to be evaluated on the - field) E.g., ("age", "age > 18 && age < 60") entry triggers - validation of field age with the given condition. Map entries will - be ANDed during validation. - type: object + width: + type: number + description: Page width. + format: float + height: + type: number + description: Page height. + format: float + unit: + description: Dimension unit. + type: string type: object - description: Represents the action responsible for data validation operations. - id: GoogleCloudContentwarehouseV1DataValidationAction - GoogleIamV1AuditLogConfig: + id: GoogleCloudDocumentaiV1DocumentPageDimension + description: Dimension for the page. + GoogleCloudContentwarehouseV1InitializeProjectResponse: + description: Response message for projectService.InitializeProject type: object - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - id: GoogleIamV1AuditLogConfig + id: GoogleCloudContentwarehouseV1InitializeProjectResponse properties: - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - items: - type: string - type: array - logType: - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' + state: enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING type: string - description: The log type that this config enables. - GoogleCloudContentwarehouseV1CreateDocumentRequest: - type: object + description: The state of the project initialization process. + enumDescriptions: + - Clients should never see this. + - Finished project initialization without error. + - Finished project initialization with an error. + - Client canceled the LRO. + - Ask the customer to check the operation for results. + message: + type: string + description: The message of the project initialization process. + GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: properties: - cloudAiDocumentOption: + yAxis: + type: string + enumDescriptions: + - Count the documents per property name. + - Count the properties per property name. description: >- - Request Option for processing Cloud AI Document in Document - Warehouse. This field offers limited support for mapping entities - from Cloud AI Document to Warehouse Document. Please consult with - product team before using this field and other available options. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: >- - Default document policy during creation. This refers to an Identity - and Access (IAM) policy, which specifies access controls for the - Document. Conditions defined in the policy will be ignored. - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Required. The document to create. - requestMetadata: + By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is + not set. + enum: + - HISTOGRAM_YAXIS_DOCUMENT + - HISTOGRAM_YAXIS_PROPERTY + propertyNames: + items: + type: string + type: array description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - createMask: - format: google-fieldmask + It is optional. It will perform histogram for all the property names + if it is not set. The properties need to be defined with the + is_filterable flag set to true and the name of the property should + be in the format: "schemaId.propertyName". The property needs to be + defined in the schema. Example: the schema id is abc. Then the name + of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE". + documentSchemas: + type: array + items: + type: string description: >- - Field mask for creating Document fields. If mask path is empty, it - means all fields are masked. For the `FieldMask` definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. - type: string - description: Request message for DocumentService.CreateDocument. - id: GoogleCloudContentwarehouseV1CreateDocumentRequest - GoogleTypeInterval: - id: GoogleTypeInterval + This filter specifies the exact document schema(s) + Document.document_schema_name to run histogram query against. It is + optional. It will perform histogram for property names for all the + document schemas if it is not set. At most 10 document schema names + are allowed. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + type: object + id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter + GoogleCloudContentwarehouseV1UpdateRuleSetRequest: type: object properties: - endTime: - format: google-datetime + ruleSet: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + description: Required. The rule set to update. + id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest + description: Request message for RuleSetService.UpdateRuleSet. + GoogleCloudContentwarehouseV1AddToFolderAction: + description: Represents the action responsible for adding document under a folder. + type: object + properties: + folders: description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. + Names of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + items: + type: string + type: array + id: GoogleCloudContentwarehouseV1AddToFolderAction + GoogleCloudContentwarehouseV1PropertyDefinition: + description: Defines the metadata for a schema property. + id: GoogleCloudContentwarehouseV1PropertyDefinition + properties: + isRequired: + type: boolean + description: >- + Whether the property is mandatory. Default is 'false', i.e. + populating property value can be skipped. If 'true' then user must + populate the value for this property. + isFilterable: + description: >- + Whether the property can be filtered. If this is a sub-property, all + the parent properties must be marked filterable. + type: boolean + timestampTypeOptions: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions + description: >- + Timestamp property. It is not supported by CMEK compliant + deployment. + dateTimeTypeOptions: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions + description: >- + Date time property. It is not supported by CMEK compliant + deployment. + isMetadata: + description: >- + Whether the property is user supplied metadata. This out-of-the box + placeholder setting can be used to tag derived properties. Its value + and interpretation logic should be implemented by API user. + type: boolean + displayName: type: string - startTime: + description: The display-name for the property, used for front-end. + name: type: string - format: google-datetime - description: >- - Optional. Inclusive start of the interval. If specified, a Timestamp - matching this interval will have to be the same or after the start. - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - GoogleCloudContentwarehouseV1AccessControlAction: - type: object - properties: - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - Represents the new policy from which bindings are added, removed or - replaced based on the type of the operation. the policy is limited - to a few 10s of KB. - operationType: - enumDescriptions: - - The unknown operation type. - - Adds newly given policy bindings in the existing bindings list. - - >- - Removes newly given policy bindings from the existing bindings - list. - - >- - Replaces existing policy bindings with the given policy binding - list - description: Identifies the type of operation. + Required. The name of the metadata property. Must be unique within a + document schema and is case insensitive. Names must be non-blank, + start with a letter, and can contain alphanumeric characters and: /, + :, -, _, and . + propertyTypeOptions: + description: Nested structured data property. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions + floatTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' + description: Float property. + retrievalImportance: type: string + enumDescriptions: + - No importance specified. Default medium importance. + - Highest importance. + - Higher importance. + - High importance. + - Medium importance. + - Low importance (negative). + - Lowest importance (negative). enum: - - UNKNOWN - - ADD_POLICY_BINDING - - REMOVE_POLICY_BINDING - - REPLACE_POLICY_BINDING - description: >- - Represents the action responsible for access control list management - operations. - id: GoogleCloudContentwarehouseV1AccessControlAction - GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: - id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - documentId: - type: string - description: Document identifier of an existing document. - description: The status of processing a document. - type: object - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow - type: object - properties: - cells: - type: array - description: Cells that make up this row. + - RETRIEVAL_IMPORTANCE_UNSPECIFIED + - HIGHEST + - HIGHER + - HIGH + - MEDIUM + - LOW + - LOWEST + description: The retrieval importance of the property during search. + integerTypeOptions: + description: Integer property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' + textTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' + description: Text/string property. + isRepeatable: + description: Whether the property can have multiple values. + type: boolean + enumTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' + description: Enum/categorical property. + schemaSources: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell - description: A row of table cells. - GoogleCloudDocumentaiV1DocumentPageLine: - id: GoogleCloudDocumentaiV1DocumentPageLine + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + description: >- + The mapping information between this property to another schema + source. + type: array + mapTypeOptions: + description: Map property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' + isSearchable: + type: boolean + description: Indicates that the property should be included in a global search. + type: object + GoogleIamV1Binding: + description: Associates `members`, or principals, with a `role`. type: object properties: - provenance: - deprecated: true - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - detectedLanguages: + role: + type: string + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + members: type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Line. - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. - GoogleCloudContentwarehouseV1PropertyFilter: - properties: - documentSchemaName: - description: >- - The Document schema name Document.document_schema_name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - type: string - condition: + type: string description: >- - The filter condition. The syntax for this expression is a subset of - SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, - `>=`, and `~~` where the left of the operator is a property name and - the right of the operator is a number or a quoted string. You must - escape backslash (\\) and quote (\") characters. `~~` is the LIKE - operator. The right of the operator must be a string. The only - supported property data type for LIKE is text_values. It provides - semantic search functionality by parsing, stemming and doing - synonyms expansion against the input query. It matches if the - property contains semantic similar content to the query. It is not - regex matching or wildcard matching. For example, "property.company - ~~ \"google\"" will match records whose property `property.compnay` - have values like "Google Inc.", "Google LLC" or "Google Company". - Supported functions are `LOWER([property_name])` to perform a case - insensitive match and `EMPTY([property_name])` to filter on the - existence of a key. Boolean expressions (AND/OR/NOT) are supported - up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) - AND E"), a maximum of 100 comparisons or functions are allowed in - the expression. The expression must be < 6000 bytes in length. Only - properties that are marked filterable are allowed - (PropertyDefinition.is_filterable). Property names do not need to be - prefixed by the document schema id (as is the case with histograms), - however property names will need to be prefixed by its parent - hierarchy, if any. For example: top_property_name.sub_property_name. - Sample Query: `(LOWER(driving_license)="class \"a\"" OR - EMPTY(driving_license)) AND driving_years > 10` CMEK compliant - deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and - `>=`. * Boolean expressions: AND and OR. - type: string - id: GoogleCloudContentwarehouseV1PropertyFilter - type: object - GoogleCloudContentwarehouseV1EnumArray: + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + condition: + $ref: '#/components/schemas/GoogleTypeExpr' + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + id: GoogleIamV1Binding + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: properties: - values: + headerRows: + description: Header rows at the top of the table. + type: array items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + caption: + type: string + description: Table caption/title. + bodyRows: type: array - description: List of enum values. - description: Enum values. - type: object - id: GoogleCloudContentwarehouseV1EnumArray - GoogleProtobufEmpty: - properties: {} + description: Body rows containing main table content. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Represents a table type block. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: GoogleProtobufEmpty - GoogleApiServiceconsumermanagementV1PolicyBinding: - id: GoogleApiServiceconsumermanagementV1PolicyBinding - description: Translates to IAM Policy bindings (without auditing at this level) + CloudAiPlatformTenantresourceTenantProjectConfig: + description: The identity to configure a tenant project. properties: - members: - type: array + folder: + type: string description: >- - Uses the same format as in IAM policy. `member` must include both a - prefix and ID. For example, `user:{emailId}`, - `serviceAccount:{emailId}`, `group:{emailId}`. + Input/Output [Required]. The folder that holds tenant projects and + folder-level permissions will be automatically granted to all tenant + projects under the folder. Note: the valid folder format is + `folders/{folder_number}`. + services: + type: array items: type: string - role: description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. - type: string + Input/Output [Required]. The API services that are enabled on the + tenant project during creation. + billingConfig: + description: >- + Input/Output [Required]. The billing account properties to create + the tenant project. + $ref: >- + #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig + policyBindings: + type: array + description: >- + Input/Output [Required]. The policy bindings that are applied to the + tenant project during creation. At least one binding must have the + role `roles/owner` with either `user` or `group` type. + items: + $ref: >- + #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding type: object - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + id: CloudAiPlatformTenantresourceTenantProjectConfig + GoogleCloudDocumentaiV1NormalizedVertex: type: object - description: A detected barcode. + description: >- + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for DetectedBarcode. - barcode: - description: Detailed barcode information of the DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - GoogleCloudContentwarehouseV1Document: + 'y': + format: float + type: number + description: Y coordinate (starts from the top of the image). + x: + description: X coordinate. + type: number + format: float + id: GoogleCloudDocumentaiV1NormalizedVertex + GoogleCloudContentwarehouseV1UpdateOptions: + description: Options for Update operations. + type: object properties: - displayUri: - type: string - description: Uri to display the document, for example, in the UI. - dispositionTime: - type: string - format: google-datetime + updateMask: description: >- - Output only. If linked to a Collection with RetentionPolicy, the - date when the document becomes mutable. - readOnly: true - displayName: + Field mask for merging Document fields. For the `FieldMask` + definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask type: string - description: >- - Required. Display name of the document given by the user. This name - will be displayed in the UI. Customer can populate this field with - the name of the document. This differs from the 'title' field as - 'title' is optional and stores the top heading in the document. - updater: - description: The user who lastly updates the document. + format: google-fieldmask + updateType: + description: Type for update. + enumDescriptions: + - Defaults to full replace behavior, ie. FULL_REPLACE. + - >- + Fully replace all the fields (including previously linked raw + document). Any field masks will be ignored. + - Merge the fields into the existing entities. + - Inserts the properties by names. + - Replace the properties by names. + - Delete the properties by names. + - >- + For each of the property, replaces the property if the it exists, + otherwise inserts a new property. And for the rest of the fields, + merge them based on update mask and merge fields options. type: string - plainText: - description: Other document format, such as PPTX, XLXS - type: string - textExtractionEnabled: - type: boolean - description: If true, text extraction will be performed. - inlineRawDocument: - description: Raw document content. - format: byte - type: string - name: + enum: + - UPDATE_TYPE_UNSPECIFIED + - UPDATE_TYPE_REPLACE + - UPDATE_TYPE_MERGE + - UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES + - UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES + - UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES + - UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES + mergeFieldsOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' + description: Options for merging. + id: GoogleCloudContentwarehouseV1UpdateOptions + GoogleCloudContentwarehouseV1GcsIngestPipeline: + type: object + properties: + processorType: type: string description: >- - The resource name of the document. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - The name is ignored when creating a document. - rawDocumentFileType: - enumDescriptions: - - No raw document specified or it is non-parsable - - Adobe PDF format - - Microsoft Word format - - Microsoft Excel format - - Microsoft Powerpoint format - - UTF-8 encoded text format - - TIFF or TIF image file format + The Doc AI processor type name. Only used when the format of + ingested files is Doc AI Document proto format. + skipIngestedDocuments: description: >- - This is used when DocAI was not used to load the document and - parsing/ extracting is needed for the inline_raw_document. For - example, if inline_raw_document is the byte representation of a PDF - file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. - type: string - enum: - - RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED - - RAW_DOCUMENT_FILE_TYPE_PDF - - RAW_DOCUMENT_FILE_TYPE_DOCX - - RAW_DOCUMENT_FILE_TYPE_XLSX - - RAW_DOCUMENT_FILE_TYPE_PPTX - - RAW_DOCUMENT_FILE_TYPE_TEXT - - RAW_DOCUMENT_FILE_TYPE_TIFF - documentSchemaName: + The flag whether to skip ingested documents. If it is set to true, + documents in Cloud Storage contains key "status" with value + "status=ingested" in custom metadata will be skipped to ingest. + type: boolean + pipelineConfig: + description: >- + Optional. The config for the Cloud Storage Ingestion pipeline. It + provides additional customization options to run the pipeline and + can be skipped if it is not applicable. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig + inputPath: + description: >- + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. type: string + schemaName: description: >- - The Document schema name. Format: + The Document Warehouse schema resource name. All documents processed + by this pipeline will use this schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - properties: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - type: array - description: List of values that are user supplied metadata. - createTime: - format: google-datetime - readOnly: true type: string - description: Output only. The time when the document is created. - referenceId: + id: GoogleCloudContentwarehouseV1GcsIngestPipeline + description: The configuration of the Cloud Storage Ingestion pipeline. + GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: + properties: + nextPageToken: type: string description: >- - The reference ID set by customers. Must be unique per project and - location. - cloudAiDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: Document AI format to save the structured content, including OCR. - rawDocumentPath: - type: string - description: Raw document file in Cloud Storage path. - contentCategory: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + documentLinks: + description: Target document-links. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + type: array + description: Response message for DocumentLinkService.ListLinkedTargets. + type: object + id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + GoogleCloudContentwarehouseV1DeleteDocumentAction: + properties: + enableHardDelete: + type: boolean description: >- - Indicates the category (image, audio, video etc.) of the original - content. - type: string + Boolean field to select between hard vs soft delete options. Set + 'true' for 'hard delete' and 'false' for 'soft delete'. + type: object + description: Represents the action responsible for deleting the document. + id: GoogleCloudContentwarehouseV1DeleteDocumentAction + GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: + properties: + state: + description: The state of the project initialization process. enumDescriptions: - - No category is specified. - - Content is of image type. - - Content is of audio type. - - Content is of video type. + - Clients should never see this. + - Finished project initialization without error. + - Finished project initialization with an error. + - Client canceled the LRO. + - Ask the customer to check the operation for results. enum: - - CONTENT_CATEGORY_UNSPECIFIED - - CONTENT_CATEGORY_IMAGE - - CONTENT_CATEGORY_AUDIO - - CONTENT_CATEGORY_VIDEO - textExtractionDisabled: - type: boolean - description: If true, text extraction will not be performed. - deprecated: true - updateTime: - description: Output only. The time when the document is last updated. - readOnly: true - format: google-datetime - type: string - creator: - description: The user who creates the document. + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING type: string - legalHold: - readOnly: true - description: Output only. Indicates if the document has a legal hold on it. - type: boolean - title: - description: >- - Title that describes the document. This can be the top heading or - text that describes the document. + message: type: string + description: The message of the project initialization process. + description: Response message for projectService.InitializeProject + id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse type: object - description: Defines the structure for content warehouse document proto. - id: GoogleCloudContentwarehouseV1Document - GoogleRpcStatus: + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus properties: - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - message: + text: + description: Header in text format. type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - GoogleCloudContentwarehouseV1FloatArray: - id: GoogleCloudContentwarehouseV1FloatArray + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the header. + description: Represents the page header associated with the chunk. + GoogleCloudDocumentaiV1DocumentPageParagraph: + description: A collection of lines that a human would perceive as a paragraph. type: object + id: GoogleCloudDocumentaiV1DocumentPageParagraph properties: - values: - description: List of float values. - items: - format: float - type: number + detectedLanguages: type: array - description: Float values. - GoogleCloudContentwarehouseV1FloatTypeOptions: - properties: {} - id: GoogleCloudContentwarehouseV1FloatTypeOptions - description: Configurations for a float property. - type: object - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: - properties: - listEntries: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry - description: List entries that constitute a list block. - type: array - type: - type: string - description: >- - Type of the list_entries (if exist). Available options are `ordered` - and `unordered`. - type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - description: Represents a list type block. - GoogleCloudContentwarehouseV1FetchAclRequest: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + provenance: + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + layout: + description: Layout for Paragraph. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + GoogleCloudContentwarehouseV1GetDocumentRequest: properties: - projectOwner: - description: >- - For Get Project ACL only. Authorization check for end user will be - ignored when project_owner=true. - type: boolean requestMetadata: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- The meta information collected about the end user, used to enforce access control for the service. - id: GoogleCloudContentwarehouseV1FetchAclRequest - description: Request message for DocumentService.FetchAcl - type: object - GoogleCloudContentwarehouseV1TextTypeOptions: + description: Request message for DocumentService.GetDocument. + id: GoogleCloudContentwarehouseV1GetDocumentRequest type: object - description: Configurations for a text property. - id: GoogleCloudContentwarehouseV1TextTypeOptions - properties: {} - GoogleCloudContentwarehouseV1EnumValue: - description: Represents the string value of the enum field. - id: GoogleCloudContentwarehouseV1EnumValue + GoogleCloudContentwarehouseV1UserInfo: type: object properties: - value: + groupIds: + description: >- + The unique group identifications which the user is belong to. The + format is "group:yyyy@example.com"; + type: array + items: + type: string + id: type: string description: >- - String value of the enum field. This must match defined set of enums - in document schema using EnumTypeOptions. - GoogleCloudContentwarehouseV1HistogramQueryResult: - id: GoogleCloudContentwarehouseV1HistogramQueryResult - description: Histogram result that matches HistogramQuery specified in searches. + A unique user identification string, as determined by the client. + The maximum number of allowed characters is 255. Allowed characters + include numbers 0 to 9, uppercase and lowercase letters, and + restricted special symbols (:, @, +, -, _, ~) The format is + "user:xxxx@example.com"; + id: GoogleCloudContentwarehouseV1UserInfo + description: The user information. + GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: + description: Document entry with metadata inside SearchDocumentsResponse type: object + id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument properties: - histogramQuery: + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: >- + Document that matches the specified SearchDocumentsRequest. This + document only contains indexed metadata information. + searchTextSnippet: + description: >- + Contains snippets of text from the document full raw text that most + closely match a search query's keywords, if available. All HTML tags + in the original fields are stripped when returned in this field, and + matching query keywords are enclosed in HTML bold tags. If the + question-answering feature is enabled, this field will instead + contain a snippet that answers the user's natural-language query. No + HTML bold tags will be present, and highlights in the answer snippet + can be found in QAResult.highlights. type: string - description: Requested histogram expression. - histogram: + qaResult: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' description: >- - A map from the values of the facet associated with distinct values - to the number of matching entries with corresponding value. The key - format is: * (for string histogram) string values stored in the - field. - additionalProperties: + Experimental. Additional result info if the question-answering + feature is enabled. + matchedTokenPageIndices: + items: type: string format: int64 - type: object - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: - type: object - properties: - type: - type: string - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - description: Detected break type. - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - GoogleCloudContentwarehouseV1UpdateOptions: - properties: - updateMask: + type: array description: >- - Field mask for merging Document fields. For the `FieldMask` - definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - format: google-fieldmask - type: string - mergeFieldsOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' - description: Options for merging. - updateType: - type: string - description: Type for update. - enumDescriptions: - - Defaults to full replace behavior, ie. FULL_REPLACE. - - >- - Fully replace all the fields (including previously linked raw - document). Any field masks will be ignored. - - Merge the fields into the existing entities. - - Inserts the properties by names. - - Replace the properties by names. - - Delete the properties by names. - - >- - For each of the property, replaces the property if the it exists, - otherwise inserts a new property. And for the rest of the fields, - merge them based on update mask and merge fields options. - enum: - - UPDATE_TYPE_UNSPECIFIED - - UPDATE_TYPE_REPLACE - - UPDATE_TYPE_MERGE - - UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES - - UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES - - UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES - - UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES + Return the 1-based page indices where those pages have one or more + matched tokens. + GoogleCloudContentwarehouseV1MapTypeOptions: type: object - id: GoogleCloudContentwarehouseV1UpdateOptions - description: Options for Update operations. - GoogleCloudContentwarehouseV1DocumentLink: - id: GoogleCloudContentwarehouseV1DocumentLink - description: A document-link between source and target document. + properties: {} + id: GoogleCloudContentwarehouseV1MapTypeOptions + description: Configurations for a Map property. + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: properties: - name: - description: >- - Name of this document-link. It is required that the parent derived - form the name to be consistent with the source document reference. - Otherwise an exception will be thrown. Format: - projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. + layoutId: + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + deprecated: true type: string - sourceDocumentReference: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - description: Document references of the source document. - updateTime: + page: type: string - description: Output only. The time when the documentLink is last updated. - readOnly: true - format: google-datetime - targetDocumentReference: - description: Document references of the target document. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - createTime: + description: >- + Required. Index into the Document.pages element, for example using + `Document.pages` to locate the related page element. This field is + skipped when its value is the default `0`. See + https://developers.google.com/protocol-buffers/docs/proto3#json. + format: int64 + confidence: + description: >- + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + type: number + format: float + layoutType: type: string - readOnly: true - description: Output only. The time when the documentLink is created. - format: google-datetime - state: + description: >- + Optional. The type of the layout element that is being referenced if + any. enum: - - STATE_UNSPECIFIED - - ACTIVE - - SOFT_DELETED + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD enumDescriptions: - - Unknown state of documentlink. - - The documentlink has both source and target documents detected. - - >- - Target document is deleted, and mark the documentlink as - soft-deleted. - type: string + - Layout Unspecified. + - References a Page.blocks element. + - References a Page.paragraphs element. + - References a Page.lines element. + - References a Page.tokens element. + - References a Page.visual_elements element. + - Refrrences a Page.tables element. + - References a Page.form_fields element. + boundingPoly: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' description: >- - The state of the documentlink. If target node has been deleted, the - link is marked as invalid. Removing a source node will result in - removal of all associated links. - description: - type: string - description: Description of this document-link. + Optional. Identifies the bounding polygon of a layout element on the + page. If `layout_type` is set, the bounding polygon must be exactly + the same to the layout element it's referring to. + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef type: object - GoogleCloudContentwarehouseV1DeleteDocumentAction: - description: Represents the action responsible for deleting the document. + description: Represents a weak reference to a page element within a document. + GoogleTypeDateTime: type: object + id: GoogleTypeDateTime properties: - enableHardDelete: + seconds: + format: int32 description: >- - Boolean field to select between hard vs soft delete options. Set - 'true' for 'hard delete' and 'false' for 'soft delete'. - type: boolean - id: GoogleCloudContentwarehouseV1DeleteDocumentAction - GoogleCloudDocumentaiV1DocumentShardInfo: - description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. - properties: - shardCount: - format: int64 - description: Total number of shards. - type: string - shardIndex: - type: string - description: The 0-based index of this shard. - format: int64 - textOffset: - format: int64 + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. + type: integer + utcOffset: type: string + format: google-duration description: >- - The index of the first character in Document.text in the overall - document global text. - type: object - id: GoogleCloudDocumentaiV1DocumentShardInfo - GoogleCloudDocumentaiV1DocumentProvenance: - properties: - revision: - deprecated: true - description: The index of the revision that produced this element. - format: int32 + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. + nanos: + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. type: integer - id: - deprecated: true + format: int32 + timeZone: + $ref: '#/components/schemas/GoogleTypeTimeZone' + description: Time zone. + day: type: integer format: int32 description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - type: - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + hours: + format: int32 + description: >- + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. + type: integer + month: + type: integer + description: >- + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + format: int32 + year: + type: integer + description: >- + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. + format: int32 + minutes: + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + type: integer + format: int32 + description: >- + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + properties: + inputPath: type: string - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - description: The type of provenance operation. - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. - parents: - description: References to the original elements that are replaced. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent - type: array + description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' type: object - id: GoogleCloudDocumentaiV1DocumentProvenance - description: >- - Structure to identify provenance relationships between annotations in - different revisions. - GoogleCloudContentwarehouseV1RuleSet: - description: Represents a set of rules from a single customer. + description: The metadata message for GcsIngest pipeline. + GoogleCloudContentwarehouseV1RuleActionsPair: properties: - rules: - description: List of rules given by the customer. + actionOutputs: type: array + description: Outputs of executing the actions associated with the above rule. items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: - description: Short description of the rule-set. - type: string - name: - type: string - description: >- - The resource name of the rule set. Managed internally. Format: - projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. - The name is ignored when creating a rule set. - source: - type: string - description: Source of the rules i.e., customer name. - id: GoogleCloudContentwarehouseV1RuleSet + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' + rule: + description: Represents the rule. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' type: object - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata - description: The metadata message for Export-to-CDW pipeline. + id: GoogleCloudContentwarehouseV1RuleActionsPair + description: Represents a rule and outputs of associated actions. + GoogleCloudContentwarehouseV1WeightedSchemaProperty: + id: GoogleCloudContentwarehouseV1WeightedSchemaProperty + description: Specifies the schema property name. properties: - documents: - type: array - description: >- - The input list of all the resource names of the documents to be - exported. + propertyNames: + description: The property definition names in the schema. items: type: string - outputPath: - type: string - description: The output Cloud Storage folder in this pipeline. - docAiDataset: + type: array + documentSchemaName: + description: The document schema name. type: string - description: The output CDW dataset resource name. type: object - GoogleCloudContentwarehouseV1LockDocumentRequest: - type: object - description: Request message for DocumentService.LockDocument. - id: GoogleCloudContentwarehouseV1LockDocumentRequest - properties: - collectionId: - description: The collection the document connects to. - type: string - lockingUser: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: The user information who locks the document. - CloudAiPlatformTenantresourceServiceAccountIdentity: + GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: + id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline properties: - tag: + inputPath: description: >- - Input/Output [Optional]. The tag that configures the service - account, as defined in - google3/configs/production/cdpush/acl-zanzibar-cloud-prod/activation_grants/activation_grants.gcl. - Note: The default P4 service account has the empty tag. - type: string - serviceAccountEmail: + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. type: string - description: Output only. The service account email that has been created. - id: CloudAiPlatformTenantresourceServiceAccountIdentity - type: object - description: The identity to configure a service account. - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: - properties: - languageCode: + splitClassifyProcessorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. + The split and classify processor information. The split and classify + result will be used to find a matched extract processor. + processorResultsFolderPath: + description: >- + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. type: string - confidence: - description: Confidence of detected language. Range `[0, 1]`. - type: number - format: float + skipIngestedDocuments: + type: boolean + description: >- + The flag whether to skip ingested documents. If it is set to true, + documents in Cloud Storage contains key "status" with value + "status=ingested" in custom metadata will be skipped to ingest. + pipelineConfig: + description: >- + Optional. The config for the Cloud Storage Ingestion with DocAI + Processors pipeline. It provides additional customization options to + run the pipeline and can be skipped if it is not applicable. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig + extractProcessorInfos: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: >- + The extract processors information. One matched extract processor + will be used to process documents based on the classify processor + result. If no classify processor is specified, the first extract + processor will be used. + type: array + description: >- + The configuration of the Cloud Storage Ingestion with DocAI Processors + pipeline. type: object - description: Detected language for a structural component. - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - GoogleCloudDocumentaiV1DocumentEntity: + GoogleLongrunningOperation: type: object - id: GoogleCloudDocumentaiV1DocumentEntity description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation properties: - mentionText: - type: string - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - pageAnchor: - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' - id: + metadata: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - type: string - mentionId: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + name: type: string - description: Optional. Deprecated. Use `id` field instead. - normalizedValue: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - redacted: description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + done: type: boolean - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: Optional. The history of this annotation. - confidence: - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - format: float - type: number - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - type: - type: string - description: Required. Entity type from a schema e.g. `Address`. - properties: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - type: array + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + response: description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. - GoogleCloudDocumentaiV1BoundingPoly: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleApiServiceconsumermanagementV1PolicyBinding: + description: Translates to IAM Policy bindings (without auditing at this level) + id: GoogleApiServiceconsumermanagementV1PolicyBinding + type: object properties: - normalizedVertices: - description: The bounding polygon normalized vertices. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + members: + description: >- + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. type: array - vertices: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - description: The bounding polygon vertices. + type: string + role: + description: >- + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. + type: string + GoogleCloudContentwarehouseV1RequestMetadata: + id: GoogleCloudContentwarehouseV1RequestMetadata + description: Meta information is used to improve the performance of the service. + type: object + properties: + userInfo: + description: Provides user unique identification and groups information. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + GoogleCloudDocumentaiV1DocumentPageTableTableRow: + description: A row of table cells. + properties: + cells: type: array - description: A bounding polygon for the detected image annotation. + description: Cells that make up this row. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell type: object - id: GoogleCloudDocumentaiV1BoundingPoly - GoogleCloudDocumentaiV1DocumentProvenanceParent: - id: GoogleCloudDocumentaiV1DocumentProvenanceParent + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + GoogleCloudContentwarehouseV1RemoveFromFolderAction: + properties: + condition: + type: string + description: Condition of the action to be executed. + folder: + description: >- + Name of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + type: string + description: >- + Represents the action responsible for remove a document from a specific + folder. + type: object + id: GoogleCloudContentwarehouseV1RemoveFromFolderAction + GoogleCloudDocumentaiV1DocumentPageMatrix: type: object properties: - index: + data: + type: string + format: byte + description: The matrix data. + type: type: integer description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. + This encodes information about what data type the matrix uses. For + example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of + OpenCV primitive data types, please refer to + https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html format: int32 - revision: - description: The index of the index into current revision's parent_ids list. + rows: format: int32 type: integer - id: - deprecated: true - description: The id of the parent provenance. + description: Number of rows in the matrix. + cols: + description: Number of columns in the matrix. type: integer format: int32 description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - GoogleCloudContentwarehouseV1RunPipelineRequest: + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. + id: GoogleCloudDocumentaiV1DocumentPageMatrix + GoogleCloudContentwarehouseV1SearchDocumentsRequest: + id: GoogleCloudContentwarehouseV1SearchDocumentsRequest type: object - id: GoogleCloudContentwarehouseV1RunPipelineRequest - description: Request message for DocumentService.RunPipeline. properties: - processWithDocAiPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + qaSizeLimit: description: >- - Use a DocAI processor to process documents in Document Warehouse, - and re-ingest the updated results into Document Warehouse. - gcsIngestWithDocAiProcessorsPipeline: + Experimental, do not use. The limit on the number of documents + returned for the question-answering feature. To enable the + question-answering feature, set [DocumentQuery].is_nl_query to true. + format: int32 + type: integer + totalResultSize: + enumDescriptions: + - Total number calculation will be skipped. + - >- + Estimate total number. The total result size will be accurated up + to 10,000. This option will add cost and latency to your request. + - It may adversely impact performance. The limit is 1000,000. + enum: + - TOTAL_RESULT_SIZE_UNSPECIFIED + - ESTIMATED_SIZE + - ACTUAL_SIZE + type: string description: >- - Use DocAI processors to process documents in Cloud Storage and - ingest them to Document Warehouse. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline - exportCdwPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. + orderBy: + type: string description: >- - Export docuemnts from Document Warehouse to CDW for training - purpose. - gcsIngestPipeline: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' - description: Cloud Storage ingestion pipeline. + The criteria determining how search results are sorted. For + non-empty query, default is `"relevance desc"`. For empty query, + default is `"upload_date desc"`. Supported options are: * + `"relevance desc"`: By relevance descending, as determined by the + API algorithms. * `"upload_date desc"`: By upload date descending. * + `"upload_date"`: By upload date ascending. * `"update_date desc"`: + By last updated date descending. * `"update_date"`: By last updated + date ascending. * `"retrieval_importance desc"`: By retrieval + importance of properties descending. This feature is still under + development, please do not use unless otherwise instructed to do so. + pageToken: + type: string + description: >- + The token specifying the current offset within search results. See + SearchDocumentsResponse.next_page_token for an explanation of how to + obtain the next set of query results. + pageSize: + type: integer + description: >- + A limit on the number of documents returned in the search results. + Increasing this value above the default value of 10 can increase + search response time. The value can be between 1 and 100. + format: int32 requestMetadata: description: >- The meta information collected about the end user, used to enforce - access control for the service. + access control and improve the search quality of the service. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - GoogleCloudContentwarehouseV1RuleEvaluatorOutput: - id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput - description: Represents the output of the Rule Evaluator. - type: object - properties: - invalidRules: - description: >- - A subset of triggered rules that failed the validation check(s) - after parsing. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' + histogramQueries: type: array - matchedRules: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - type: array + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' description: >- - A subset of triggered rules that are evaluated true for a given - request. - triggeredRules: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + An expression specifying a histogram request against matching + documents. Expression syntax is an aggregation function call with + histogram facets and other options. The following aggregation + functions are supported: * `count(string_histogram_facet)`: Count + the number of matching entities for each distinct attribute value. + Data types: * Histogram facet (aka filterable properties): Facet + names with format .. Facets will have the format + of: `a-zA-Z`. If the facet is a child facet, then the parent + hierarchy needs to be specified separated by dots in the prefix + after the schema id. Thus, the format for a multi- level facet is: + .. . Example: + schema123.root_parent_facet.middle_facet.child_facet * + DocumentSchemaId: (with no schema id prefix) to get histograms for + each document type (returns the schema id path, e.g. + projects/12345/locations/us-west/documentSchemas/abc123). Example + expression: * Document type counts: count('DocumentSchemaId') * For + schema id, abc123, get the counts for MORTGAGE_TYPE: + count('abc123.MORTGAGE_TYPE') + requireTotalSize: + type: boolean description: >- - List of rules fetched from database for the given request trigger - type. - GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: - description: >- - The configuration of the Cloud Storage Ingestion with DocAI Processors - pipeline. - id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline - properties: - splitClassifyProcessorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - description: >- - The split and classify processor information. The split and classify - result will be used to find a matched extract processor. - processorResultsFolderPath: - type: string - description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - skipIngestedDocuments: - type: boolean - description: >- - The flag whether to skip ingested documents. If it is set to true, - documents in Cloud Storage contains key "status" with value - "status=ingested" in custom metadata will be skipped to ingest. - extractProcessorInfos: - type: array - description: >- - The extract processors information. One matched extract processor - will be used to process documents based on the classify processor - result. If no classify processor is specified, the first extract - processor will be used. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - pipelineConfig: - description: >- - Optional. The config for the Cloud Storage Ingestion with DocAI - Processors pipeline. It provides additional customization options to - run the pipeline and can be skipped if it is not applicable. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig - inputPath: - type: string + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. Enabling this flag may adversely + impact performance. Hint: If this is used with pagination, set this + flag on the initial query but set this to false on subsequent page + calls (keep the total count locally). Defaults to false. + offset: + type: integer description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. - type: object - GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: + An integer that specifies the current offset (that is, starting + result location, amongst the documents deemed by the API as + relevant) in search results. This field is only considered if + page_token is unset. The maximum allowed value is 5000. Otherwise an + error is thrown. For example, 0 means to return results starting + from the first matching document, and 10 means to return from the + 11th document. This can be used for pagination, (for example, + pageSize = 10 and offset = 10 means to return from the second page). + format: int32 + documentQuery: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' + description: Query used to search against documents (keyword, filters, etc.). + description: Request message for DocumentService.SearchDocuments. + GoogleCloudContentwarehouseV1DeleteDocumentRequest: type: object - description: Document entry with metadata inside SearchDocumentsResponse - id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument properties: - document: - description: >- - Document that matches the specified SearchDocumentsRequest. This - document only contains indexed metadata information. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - qaResult: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' - description: >- - Experimental. Additional result info if the question-answering - feature is enabled. - searchTextSnippet: + requestMetadata: description: >- - Contains snippets of text from the document full raw text that most - closely match a search query's keywords, if available. All HTML tags - in the original fields are stripped when returned in this field, and - matching query keywords are enclosed in HTML bold tags. If the - question-answering feature is enabled, this field will instead - contain a snippet that answers the user's natural-language query. No - HTML bold tags will be present, and highlights in the answer snippet - can be found in QAResult.highlights. + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + id: GoogleCloudContentwarehouseV1DeleteDocumentRequest + description: Request message for DocumentService.DeleteDocument. + GoogleCloudContentwarehouseV1DocumentLink: + properties: + description: + type: string + description: Description of this document-link. + name: type: string - matchedTokenPageIndices: - items: - type: string - format: int64 - type: array description: >- - Return the 1-based page indices where those pages have one or more - matched tokens. - GoogleCloudContentwarehouseV1IntegerTypeOptions: - type: object - id: GoogleCloudContentwarehouseV1IntegerTypeOptions - properties: {} - description: Configurations for an integer property. - GoogleTypeTimeZone: - type: object - id: GoogleTypeTimeZone - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - properties: - version: + Name of this document-link. It is required that the parent derived + form the name to be consistent with the source document reference. + Otherwise an exception will be thrown. Format: + projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. + targetDocumentReference: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + description: Document references of the target document. + updateTime: + readOnly: true + description: Output only. The time when the documentLink is last updated. + format: google-datetime type: string - description: Optional. IANA Time Zone Database version number, e.g. "2019a". - id: + state: + enumDescriptions: + - Unknown state of documentlink. + - The documentlink has both source and target documents detected. + - >- + Target document is deleted, and mark the documentlink as + soft-deleted. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - SOFT_DELETED type: string - description: IANA Time Zone Database time zone, e.g. "America/New_York". - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: - properties: - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the footer. - text: + description: >- + The state of the documentlink. If target node has been deleted, the + link is marked as invalid. Removing a source node will result in + removal of all associated links. + sourceDocumentReference: + description: Document references of the source document. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + createTime: + description: Output only. The time when the documentLink is created. type: string - description: Footer in text format. + format: google-datetime + readOnly: true + description: A document-link between source and target document. + id: GoogleCloudContentwarehouseV1DocumentLink type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - description: Represents the page footer associated with the chunk. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + GoogleCloudContentwarehouseV1DataValidationAction: + description: Represents the action responsible for data validation operations. type: object properties: - bodyRows: - description: Body rows containing main table content. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - headerRows: + conditions: + type: object + description: >- + Map of (K, V) -> (field, string condition to be evaluated on the + field) E.g., ("age", "age > 18 && age < 60") entry triggers + validation of field age with the given condition. Map entries will + be ANDed during validation. + additionalProperties: + type: string + id: GoogleCloudContentwarehouseV1DataValidationAction + GoogleCloudDocumentaiV1DocumentPageVisualElement: + properties: + detectedLanguages: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array - description: Header rows at the top of the table. - caption: + description: A list of detected languages together with confidence. + type: type: string - description: Table caption/title. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - description: Represents a table type block. - GoogleCloudContentwarehouseV1ExportToCdwPipeline: + description: Type of the VisualElement. + layout: + description: Layout for VisualElement. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + id: GoogleCloudDocumentaiV1DocumentPageVisualElement + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + type: object + GoogleTypeExpr: type: object description: >- - The configuration of exporting documents from the Document Warehouse to - CDW pipeline. + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + id: GoogleTypeExpr properties: - docAiDataset: + expression: + type: string description: >- - Optional. The CDW dataset resource name. This field is optional. If - not set, the documents will be exported to Cloud Storage only. - Format: - projects/{project}/locations/{location}/processors/{processor}/dataset + Textual representation of an expression in Common Expression + Language syntax. + location: type: string - documents: - items: - type: string description: >- - The list of all the resource names of the documents to be processed. - Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - type: array - exportFolderPath: + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + title: type: string description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. - trainingSplitRatio: + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + description: + type: string description: >- - Ratio of training dataset split. When importing into Document AI - Workbench, documents will be automatically split into training and - test split category with the specified ratio. This field is required - if doc_ai_dataset is set. - type: number + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + GoogleCloudDocumentaiV1DocumentEntity: + type: object + properties: + mentionText: + type: string + description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. + confidence: format: float - id: GoogleCloudContentwarehouseV1ExportToCdwPipeline - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + type: number + id: + type: string + description: >- + Optional. Canonical id. This will be a unique value in the entity + list for this document. + type: + description: Required. Entity type from a schema e.g. `Address`. + type: string + properties: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + description: >- + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + type: array + pageAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' + description: >- + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: >- + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + mentionId: + description: Optional. Deprecated. Use `id` field instead. + type: string + provenance: + description: Optional. The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + redacted: + type: boolean + description: >- + Optional. Whether the entity will be redacted for de-identification + purposes. + normalizedValue: + description: >- + Optional. Normalized entity value. Absent if the extracted value + could not be converted or the type (e.g. address) is not supported + for certain parsers. This field is also only populated for certain + supported document types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + description: >- + An entity that could be a phrase in the text or a property that belongs + to the document. It is a known entity type, such as a person, an + organization, or location. + id: GoogleCloudDocumentaiV1DocumentEntity + GoogleCloudDocumentaiV1DocumentPage: + id: GoogleCloudDocumentaiV1DocumentPage properties: - blocks: + provenance: + description: The history of this page. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + paragraphs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' description: >- - A list entry is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. + A list of visually detected text paragraphs on the page. A + collection of lines that a human would perceive as a paragraph. + pageNumber: + format: int32 + type: integer + description: >- + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. + detectedBarcodes: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode type: array - description: Represents an entry in the list. - type: object - GoogleCloudDocumentaiV1DocumentPageParagraph: - id: GoogleCloudDocumentaiV1DocumentPageParagraph - properties: - detectedLanguages: - description: A list of detected languages together with confidence. + description: A list of detected barcodes. + dimension: + description: Physical dimension of the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + visualElements: type: array + description: >- + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - provenance: - deprecated: true - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + tokens: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + type: array + description: A list of visually detected tokens on the page. + symbols: + type: array + description: A list of visually detected symbols on the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' layout: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Paragraph. - type: object - description: A collection of lines that a human would perceive as a paragraph. - GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: - type: object - description: Metadata object for UpdateDocument request (currently empty). - properties: {} - id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata - CloudAiPlatformTenantresourceTenantProjectConfig: - type: object - id: CloudAiPlatformTenantresourceTenantProjectConfig - description: The identity to configure a tenant project. - properties: - billingConfig: - $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig + description: Layout for the page. + image: description: >- - Input/Output [Required]. The billing account properties to create - the tenant project. - policyBindings: + Rendered image for this page. This image is preprocessed to remove + any skew, rotation, and distortions such that the annotation + bounding boxes can be upright and axis-aligned. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + transforms: + description: >- + Transformation matrices that were applied to the original document + image to produce Page.image. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' type: array + blocks: description: >- - Input/Output [Required]. The policy bindings that are applied to the - tenant project during creation. At least one binding must have the - role `roles/owner` with either `user` or `group` type. + A list of visually detected text blocks on the page. A block has a + set of lines (collected into paragraphs) that have a common + line-spacing and orientation. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + type: array + formFields: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + description: A list of visually detected form fields on the page. + type: array + detectedLanguages: items: $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding - services: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + imageQualityScores: + description: Image quality scores. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + lines: description: >- - Input/Output [Required]. The API services that are enabled on the - tenant project during creation. + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. type: array items: - type: string - folder: - description: >- - Input/Output [Required]. The folder that holds tenant projects and - folder-level permissions will be automatically granted to all tenant - projects under the folder. Note: the valid folder format is - `folders/{folder_number}`. - type: string - GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: - description: Response message for projectService.InitializeProject + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' + tables: + type: array + description: A list of visually detected tables on the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' type: object + description: A page in a Document. + GoogleCloudContentwarehouseV1UpdateDocumentRequest: + description: Request message for DocumentService.UpdateDocument. + id: GoogleCloudContentwarehouseV1UpdateDocumentRequest properties: - message: - description: The message of the project initialization process. - type: string - state: - enumDescriptions: - - Clients should never see this. - - Finished project initialization without error. - - Finished project initialization with an error. - - Client canceled the LRO. - - Ask the customer to check the operation for results. - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - RUNNING - description: The state of the project initialization process. - type: string - id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse - GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: - id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + document: + description: Required. The document to update. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + cloudAiDocumentOption: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption + description: >- + Request Option for processing Cloud AI Document in Document + Warehouse. This field offers limited support for mapping entities + from Cloud AI Document to Warehouse Document. Please consult with + product team before using this field and other available options. + updateOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' + description: Options for the update operation. + requestMetadata: + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + type: object + GoogleCloudContentwarehouseV1TextTypeOptions: + type: object + id: GoogleCloudContentwarehouseV1TextTypeOptions + description: Configurations for a text property. + properties: {} + GoogleCloudContentwarehouseV1ExportToCdwPipeline: + id: GoogleCloudContentwarehouseV1ExportToCdwPipeline type: object - description: Response message for DocumentLinkService.ListLinkedSources. properties: - nextPageToken: + exportFolderPath: type: string 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. - documentLinks: + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. + documents: type: array - description: Source document-links. + description: >- + The list of all the resource names of the documents to be processed. + Format: + projects/{project_number}/locations/{location}/documents/{document_id}. items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - GoogleCloudDocumentaiV1Barcode: - type: object - properties: - format: - type: string + type: string + trainingSplitRatio: + format: float description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. - valueFormat: + Ratio of training dataset split. When importing into Document AI + Workbench, documents will be automatically split into training and + test split category with the specified ratio. This field is required + if doc_ai_dataset is set. + type: number + docAiDataset: type: string description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - rawValue: - description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - type: string - description: Encodes the detailed information of a barcode. - id: GoogleCloudDocumentaiV1Barcode - GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: + Optional. The CDW dataset resource name. This field is optional. If + not set, the documents will be exported to Cloud Storage only. + Format: + projects/{project}/locations/{location}/processors/{processor}/dataset + description: >- + The configuration of exporting documents from the Document Warehouse to + CDW pipeline. + GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: + properties: {} + description: Metadata object for CreateDocument request (currently empty). + id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata type: object + GoogleCloudContentwarehouseV1RuleEvaluatorOutput: properties: - propertyNames: + triggeredRules: + type: array description: >- - It is optional. It will perform histogram for all the property names - if it is not set. The properties need to be defined with the - is_filterable flag set to true and the name of the property should - be in the format: "schemaId.propertyName". The property needs to be - defined in the schema. Example: the schema id is abc. Then the name - of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE". + List of rules fetched from database for the given request trigger + type. items: - type: string + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + invalidRules: type: array - yAxis: - enum: - - HISTOGRAM_YAXIS_DOCUMENT - - HISTOGRAM_YAXIS_PROPERTY - enumDescriptions: - - Count the documents per property name. - - Count the properties per property name. - type: string - description: >- - By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is - not set. - documentSchemas: items: - type: string + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' description: >- - This filter specifies the exact document schema(s) - Document.document_schema_name to run histogram query against. It is - optional. It will perform histogram for property names for all the - document schemas if it is not set. At most 10 document schema names - are allowed. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + A subset of triggered rules that failed the validation check(s) + after parsing. + matchedRules: type: array - id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - GoogleCloudContentwarehouseV1QAResultHighlight: - properties: - endIndex: - type: integer - description: End index of the highlight, exclusive. - format: int32 - startIndex: - type: integer - description: Start index of the highlight. - format: int32 + description: >- + A subset of triggered rules that are evaluated true for a given + request. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput + description: Represents the output of the Rule Evaluator. type: object - description: >- - A text span in the search text snippet that represents a highlighted - section (answer context, highly relevant sentence, etc.). - id: GoogleCloudContentwarehouseV1QAResultHighlight - GoogleCloudContentwarehouseV1RemoveFromFolderAction: + GoogleApiServiceconsumermanagementV1BillingConfig: type: object + id: GoogleApiServiceconsumermanagementV1BillingConfig properties: - condition: + billingAccount: type: string - description: Condition of the action to be executed. - folder: description: >- - Name of the folder under which new document is to be added. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - type: string - description: >- - Represents the action responsible for remove a document from a specific - folder. - id: GoogleCloudContentwarehouseV1RemoveFromFolderAction + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. + description: Describes the billing configuration for a new tenant project. GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: + type: object properties: requestMetadata: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' @@ -2840,425 +3013,552 @@ components: The meta information collected about the document creator, used to enforce access control for the service. id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest - type: object description: Request message for DocumentLinkService.ListLinkedTargets. - GoogleCloudDocumentaiV1DocumentPageDimension: - description: Dimension for the page. + GoogleCloudContentwarehouseV1ListSynonymSetsResponse: type: object - id: GoogleCloudDocumentaiV1DocumentPageDimension + description: Response message for SynonymSetService.ListSynonymSets. properties: - unit: - description: Dimension unit. + synonymSets: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + type: array + description: The synonymSets from the specified parent. + nextPageToken: + description: >- + A page token, received from a previous `ListSynonymSets` call. + Provide this to retrieve the subsequent page. type: string - width: - type: number - format: float - description: Page width. - height: - description: Page height. - type: number - format: float - GoogleCloudContentwarehouseV1RequestMetadata: - description: Meta information is used to improve the performance of the service. - properties: - userInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: Provides user unique identification and groups information. - id: GoogleCloudContentwarehouseV1RequestMetadata - type: object - GoogleCloudContentwarehouseV1PropertyArray: + id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: type: object - id: GoogleCloudContentwarehouseV1PropertyArray - description: Property values. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry properties: - properties: - type: array - description: List of property values. + blocks: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - GoogleCloudContentwarehouseV1CreateDocumentResponse: - description: Response message for DocumentService.CreateDocument. - type: object - id: GoogleCloudContentwarehouseV1CreateDocumentResponse + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + description: >- + A list entry is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + type: array + description: Represents an entry in the list. + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: properties: - longRunningOperations: + documents: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - description: post-processing LROs - type: array - ruleEngineOutput: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + type: string description: >- - Output from Rule Engine recording the rule evaluator and action - executor's output. Refer format in: - google/cloud/contentwarehouse/v1/rule_engine.proto - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Document created after executing create request. + The input list of all the resource names of the documents to be + processed. + type: array + processorInfo: + description: The DocAI processor to process the documents with. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The metadata message for Process-with-DocAi pipeline. + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + type: object + GoogleCloudContentwarehouseV1FetchAclResponse: + type: object + description: Response message for DocumentService.FetchAcl. + id: GoogleCloudContentwarehouseV1FetchAclResponse + properties: metadata: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- Additional information for the API invocation, such as the request tracking id. - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: Parsed and normalized entity value. + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: The IAM policy. + GoogleCloudContentwarehouseV1CreateDocumentMetadata: + type: object + id: GoogleCloudContentwarehouseV1CreateDocumentMetadata + description: Metadata object for CreateDocument request (currently empty). + properties: {} + GoogleCloudContentwarehouseV1SearchDocumentsResponse: + id: GoogleCloudContentwarehouseV1SearchDocumentsResponse + description: Response message for DocumentService.SearchDocuments. + type: object properties: - moneyValue: - $ref: '#/components/schemas/GoogleTypeMoney' + nextPageToken: description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - addressValue: + The token that specifies the starting position of the next page of + results. This field is empty if there are no more results. + type: string + questionAnswer: + description: Experimental. Question answer from the query against the document. + type: string + histogramQueryResults: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - datetimeValue: + The histogram results that match with the specified + SearchDocumentsRequest.histogram_queries. + type: array + metadata: description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - $ref: '#/components/schemas/GoogleTypeDateTime' - integerValue: + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + matchingDocuments: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument + description: >- + The document entities that match the specified + SearchDocumentsRequest. + type: array + totalSize: format: int32 - description: Integer value. type: integer - floatValue: - format: float - type: number - description: Float value. - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - text: + The total number of matched documents which is available only if the + client set SearchDocumentsRequest.require_total_size to `true` or + set SearchDocumentsRequest.total_result_size to `ESTIMATED_SIZE` or + `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI + would handle this condition by displaying "of many", for example: + "Displaying 10 of many". + GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: + id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + properties: + pageToken: type: string description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - booleanValue: + A page token, received from a previous `ListLinkedSources` call. + Provide this to retrieve the subsequent page. When paginating, all + other parameters provided to `ListLinkedSources` must match the call + that provided the page token. + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - type: boolean + The meta information collected about the document creator, used to + enforce access control for the service. + pageSize: + type: integer + format: int32 + description: >- + The maximum number of document-links to return. The service may + return fewer than this value. If unspecified, at most 50 + document-links will be returned. The maximum value is 1000; values + above 1000 will be coerced to 1000. + description: Response message for DocumentLinkService.ListLinkedSources. type: object - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: + CloudAiPlatformTenantresourceIamPolicyBinding: description: >- - Represents a block. A block could be one of the various types (text, - table, list) supported. - id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - type: object + The dynamic IAM bindings to be granted after tenant projects are + created. properties: - tableBlock: - description: Block consisting of table content/structure. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - textBlock: - description: Block consisting of text content. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - listBlock: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - description: Block consisting of list content/structure. - pageSpan: - description: Page span of the block. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - blockId: - description: ID of the block. + role: + description: Input/Output [Required]. The role for members below. type: string - GoogleApiServiceconsumermanagementV1BillingConfig: - id: GoogleApiServiceconsumermanagementV1BillingConfig - properties: - billingAccount: + resourceType: type: string + enum: + - RESOURCE_TYPE_UNSPECIFIED + - PROJECT + - SERVICE_ACCOUNT + - GCS_BUCKET + - SERVICE_CONSUMER + - AR_REPO description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. - type: object - description: Describes the billing configuration for a new tenant project. - GoogleCloudDocumentaiV1DocumentPageSymbol: - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Symbol. - detectedLanguages: - type: array + Input/Output [Required]. Specifies the type of resource that will be + accessed by members. + enumDescriptions: + - '' + - >- + The value of resource field is the ID or number of a project. + Format is + - >- + The value of resource field is the resource name of a service + account. Format is projects//serviceAccounts/ + - >- + The value of resource field is the name of a GCS bucket (not its + resource name). Format is . + - >- + The value of resource field is the resource name of a service + consumer. Format is services//consumers/ + - >- + The value of the resource field is the AR Image Uri which + identifies an AR REPO. Allowed formats are: /// ///: ///@ + resource: + type: string + description: >- + Input/Output [Required]. The resource name that will be accessed by + members, which also depends on resource_type. Note: placeholders are + supported in resource names. For example, ${tpn} will be used when + the tenant project number is not ready. + members: + description: >- + Input/Output [Required]. The member service accounts with the roles + above. Note: placeholders are same as the resource above. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - id: GoogleCloudDocumentaiV1DocumentPageSymbol - description: A detected symbol. + type: string + type: array type: object - GoogleCloudContentwarehouseV1RuleEngineOutput: - id: GoogleCloudContentwarehouseV1RuleEngineOutput + id: CloudAiPlatformTenantresourceIamPolicyBinding + GoogleCloudContentwarehouseV1IntegerArray: type: object - description: >- - Records the output of Rule Engine including rule evaluation and actions - result. + id: GoogleCloudContentwarehouseV1IntegerArray + description: Integer values. properties: - actionExecutorOutput: + values: + items: + type: integer + format: int32 + description: List of integer values. + type: array + GoogleCloudContentwarehouseV1HistogramQuery: + properties: + requirePreciseResultSize: description: >- - Output from Action Executor containing rule and corresponding - actions execution result. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput - ruleEvaluatorOutput: + Controls if the histogram query requires the return of a precise + count. Enable this flag may adversely impact performance. Defaults + to true. + type: boolean + histogramQuery: + type: string + description: >- + An expression specifies a histogram request against matching + documents for searches. See SearchDocumentsRequest.histogram_queries + for details about syntax. + filters: + description: >- + Optional. Filter the result of histogram query by the property + names. It only works with histogram query + count('FilterableProperties'). It is an optional. It will perform + histogram on all the property names for all the document schemas. + Setting this field will have a better performance. $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter + description: The histogram request. + type: object + id: GoogleCloudContentwarehouseV1HistogramQuery + GoogleCloudContentwarehouseV1FetchAclRequest: + properties: + projectOwner: description: >- - Output from Rule Evaluator containing matched, unmatched and invalid - rules. - documentName: - type: string + For Get Project ACL only. Authorization check for end user will be + ignored when project_owner=true. + type: boolean + requestMetadata: description: >- - Name of the document against which the rules and actions were - evaluated. - GoogleCloudDocumentaiV1DocumentPageFormField: + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + id: GoogleCloudContentwarehouseV1FetchAclRequest type: object - description: A form field detected on the page. - id: GoogleCloudDocumentaiV1DocumentPageFormField + description: Request message for DocumentService.FetchAcl + GoogleCloudContentwarehouseV1DocumentReference: + description: References to the documents. + id: GoogleCloudContentwarehouseV1DocumentReference properties: - correctedKeyText: + documentIsRetentionFolder: + description: Document is a folder with retention policy. + type: boolean + documentIsFolder: + type: boolean + description: The document type of the document being referenced. + documentName: + description: Required. Name of the referenced document. + type: string + displayName: type: string description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. - valueDetectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages for value together with confidence. - fieldName: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - fieldValue: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the FormField value. - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - valueType: + display_name of the referenced document; this name does not need to + be consistent to the display_name in the Document proto, depending + on the ACL constraint. + deleteTime: type: string - description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` - correctedValueText: + description: Output only. The time when the document is deleted. + format: google-datetime + readOnly: true + updateTime: type: string - description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. - nameDetectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages for name together with confidence. - type: array - GoogleCloudContentwarehouseV1ListRuleSetsResponse: - properties: - nextPageToken: + readOnly: true + format: google-datetime + description: Output only. The time when the document is last updated. + documentIsLegalHoldFolder: + type: boolean + description: Document is a folder with legal hold. + createTime: type: string + description: Output only. The time when the document is created. + readOnly: true + format: google-datetime + snippet: 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. - ruleSets: - description: The rule sets from the specified parent. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - id: GoogleCloudContentwarehouseV1ListRuleSetsResponse + Stores the subset of the referenced document's content. This is + useful to allow user peek the information of the referenced + document. + type: string type: object - description: Response message for RuleSetService.ListRuleSets. - GoogleCloudContentwarehouseV1PropertyTypeOptions: - id: GoogleCloudContentwarehouseV1PropertyTypeOptions - description: Configurations for a nested structured data property. + GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: + id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + description: The status of processing a document. type: object properties: - propertyDefinitions: - type: array + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status processing the document. + documentId: + description: Document identifier of an existing document. + type: string + GoogleCloudContentwarehouseV1CustomWeightsMetadata: + properties: + weightedSchemaProperties: + description: >- + List of schema and property name. Allows a maximum of 10 schemas to + be specified for relevance boosting. items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition - description: Required. List of property definitions. - GoogleCloudDocumentaiV1NormalizedVertex: - id: GoogleCloudDocumentaiV1NormalizedVertex - properties: - x: - format: float - description: X coordinate. - type: number - 'y': - format: float - type: number - description: Y coordinate (starts from the top of the image). + #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty + type: array + id: GoogleCloudContentwarehouseV1CustomWeightsMetadata type: object - description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. + description: To support the custom weighting across document schemas. GoogleCloudContentwarehouseV1TimestampTypeOptions: - id: GoogleCloudContentwarehouseV1TimestampTypeOptions - description: Configurations for a timestamp property. type: object + description: Configurations for a timestamp property. properties: {} - GoogleCloudDocumentaiV1DocumentDocumentLayout: + id: GoogleCloudContentwarehouseV1TimestampTypeOptions + GoogleIamV1AuditLogConfig: + type: object + id: GoogleIamV1AuditLogConfig + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. properties: - blocks: + logType: + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + description: The log type that this config enables. + type: string + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + items: + type: string + type: array + GoogleCloudDocumentaiV1DocumentPageTableTableCell: + properties: + detectedLanguages: + description: A list of detected languages together with confidence. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - description: List of blocks in the document. - id: GoogleCloudDocumentaiV1DocumentDocumentLayout - type: object - description: >- - Represents the parsed layout of a document as a collection of blocks - that the document is divided into. - GoogleCloudContentwarehouseV1UpdateDocumentMetadata: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + rowSpan: + type: integer + description: How many rows this cell spans. + format: int32 + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for TableCell. + colSpan: + format: int32 + type: integer + description: How many columns this cell spans. + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: A cell representation inside the table. type: object - properties: {} - description: Metadata object for UpdateDocument request (currently empty). - id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata - GoogleCloudContentwarehouseV1AddToFolderAction: - id: GoogleCloudContentwarehouseV1AddToFolderAction - description: Represents the action responsible for adding document under a folder. + GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: properties: - folders: - type: array + requestMetadata: description: >- - Names of the folder under which new document is to be added. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - items: - type: string + The meta information collected about the document creator, used to + enforce access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: Request message for DocumentLinkService.DeleteDocumentLink. type: object - GoogleCloudContentwarehouseV1GcsIngestPipeline: - description: The configuration of the Cloud Storage Ingestion pipeline. + id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest + GoogleCloudContentwarehouseV1Action: type: object - id: GoogleCloudContentwarehouseV1GcsIngestPipeline properties: - schemaName: - type: string - description: >- - The Document Warehouse schema resource name. All documents processed - by this pipeline will use this schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - skipIngestedDocuments: - description: >- - The flag whether to skip ingested documents. If it is set to true, - documents in Cloud Storage contains key "status" with value - "status=ingested" in custom metadata will be skipped to ingest. - type: boolean - pipelineConfig: - description: >- - Optional. The config for the Cloud Storage Ingestion pipeline. It - provides additional customization options to run the pipeline and - can be skipped if it is not applicable. + deleteDocumentAction: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig - inputPath: - description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. - type: string - processorType: + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction + description: Action deleting the document. + dataValidation: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction + description: Action triggering data validation operations. + actionId: + description: ID of the action. Managed internally. type: string - description: >- - The Doc AI processor type name. Only used when the format of - ingested files is Doc AI Document proto format. - GoogleCloudDocumentaiV1DocumentStyle: - id: GoogleCloudDocumentaiV1DocumentStyle + accessControl: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction + description: Action triggering access control operations. + addToFolder: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' + description: Action triggering create document link operation. + publishToPubSub: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' + description: Action publish to Pub/Sub operation. + dataUpdate: + description: Action triggering data update operations. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' + removeFromFolderAction: + description: Action removing a document from a folder. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction + id: GoogleCloudContentwarehouseV1Action + description: Represents the action triggered by Rule Engine when the rule is true. + GoogleCloudContentwarehouseV1ProcessorInfo: + description: The DocAI processor information. properties: - textStyle: + schemaName: type: string description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - fontSize: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' - description: Font size. - backgroundColor: - description: Text background color. - $ref: '#/components/schemas/GoogleTypeColor' - fontFamily: + The Document schema resource name. All documents processed by this + processor will use this schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + processorName: type: string description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - color: - description: Text color. - $ref: '#/components/schemas/GoogleTypeColor' - textDecoration: - type: string - description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - fontWeight: + The processor resource name. Format is + `projects/{project}/locations/{location}/processors/{processor}`, or + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + documentType: type: string - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. + description: The processor will process the documents with this document type. + id: GoogleCloudContentwarehouseV1ProcessorInfo type: object + GoogleTypeInterval: + id: GoogleTypeInterval description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. - GoogleCloudContentwarehouseV1FileTypeFilter: + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + type: object properties: - fileType: - enum: - - FILE_TYPE_UNSPECIFIED - - ALL - - FOLDER - - DOCUMENT - - ROOT_FOLDER + 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 type: string - description: The type of files to return. - enumDescriptions: - - Default document type. If set, disables the filter. - - Returns all document types, including folders. - - Returns only folders. - - Returns only non-folder documents. - - Returns only root folders + 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 + type: string + GoogleCloudDocumentaiV1DocumentRevision: + id: GoogleCloudDocumentaiV1DocumentRevision type: object - id: GoogleCloudContentwarehouseV1FileTypeFilter - description: Filter for the specific types of documents returned. - GoogleCloudDocumentaiV1DocumentPageAnchor: - id: GoogleCloudDocumentaiV1DocumentPageAnchor - description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. + description: Contains past or forward revisions of this document. properties: - pageRefs: - description: One or more references to visual page elements + agent: + type: string + description: >- + If the change was made by a person specify the name or id of that + person. + processor: + description: >- + If the annotation was made by processor identify the processor by + its resource name. + type: string + id: + description: >- + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. + type: string + parentIds: + description: >- + The revisions that this revision is based on. Must include all the + ids that have anything to do with this revision - eg. there are + `provenance.parent.revision` fields that index into this field. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + type: string + type: array + createTime: + format: google-datetime + type: string + description: >- + The time that the revision was created, internally generated by doc + proto storage at the time of create. + parent: + deprecated: true type: array + items: + format: int32 + type: integer + description: >- + The revisions that this revision is based on. This can include one + or more parent (when documents are merged.) This field represents + the index into the `revisions` field. + humanReview: + description: Human Review information of this revision. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Represents where the chunk starts and ends in the document. + properties: + pageStart: + format: int32 + type: integer + description: Page where chunk starts in the document. + pageEnd: + description: Page where chunk ends in the document. + type: integer + format: int32 type: object GoogleCloudContentwarehouseV1DocumentQuery: - id: GoogleCloudContentwarehouseV1DocumentQuery - type: object properties: + fileTypeFilter: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' + description: >- + This filter specifies the types of files to return: ALL, FOLDER, or + FILE. If FOLDER or FILE is specified, then only either folders or + files will be returned, respectively. If ALL is specified, both + folders and files will be returned. If no value is specified, ALL + files will be returned. + customWeightsMetadata: + description: >- + To support the custom weighting across document schemas, customers + need to provide the properties to be used to boost the ranking in + the search request. For a search query with CustomWeightsMetadata + specified, only the RetrievalImportance for the properties in the + CustomWeightsMetadata will be honored. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata + propertyFilter: + description: >- + This filter specifies a structured syntax to match against the + PropertyDefinition.is_filterable marked as `true`. The relationship + between the PropertyFilters is OR. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' + documentCreatorFilter: + description: >- + The exact creator(s) of the documents to search against. If a value + isn't specified, documents within the search results are associated + with any creator. If multiple values are specified, documents within + the search results may be associated with any of the specified + creators. + items: + type: string + type: array queryContext: description: >- For custom synonyms. Customers provide the synonyms based on @@ -3270,33 +3570,13 @@ components: items: type: string type: array - customPropertyFilter: + folderNameFilter: type: string - deprecated: true - description: >- - This filter specifies a structured syntax to match against the - [PropertyDefinition].is_filterable marked as `true`. The syntax for - this expression is a subset of SQL syntax. Supported operators are: - `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator - is a property name and the right of the operator is a number or a - quoted string. You must escape backslash (\\) and quote (\") - characters. Supported functions are `LOWER([property_name])` to - perform a case insensitive match and `EMPTY([property_name])` to - filter on the existence of a key. Boolean expressions (AND/OR/NOT) - are supported up to 3 levels of nesting (for example, "((A AND B AND - C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are - allowed in the expression. The expression must be < 6000 bytes in - length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR - EMPTY(driving_license)) AND driving_years > 10` - fileTypeFilter: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' description: >- - This filter specifies the types of files to return: ALL, FOLDER, or - FILE. If FOLDER or FILE is specified, then only either folders or - files will be returned, respectively. If ALL is specified, both - folders and files will be returned. If no value is specified, ALL - files will be returned. + Search all the documents under this specified folder. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. query: + type: string description: >- The query string that matches against the full text of the document and the searchable properties. The query partially supports [Google @@ -3328,46 +3608,49 @@ components: other filters e.g. `time_filters` and `folder_name_filter`. They are connected with `AND` operator under the hood. The maximum number of allowed characters is 255. - type: string - documentCreatorFilter: + documentNameFilter: type: array - description: >- - The exact creator(s) of the documents to search against. If a value - isn't specified, documents within the search results are associated - with any creator. If multiple values are specified, documents within - the search results may be associated with any of the specified - creators. items: type: string - folderNameFilter: - type: string description: >- - Search all the documents under this specified folder. Format: + Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}. - propertyFilter: - description: >- - This filter specifies a structured syntax to match against the - PropertyDefinition.is_filterable marked as `true`. The relationship - between the PropertyFilters is OR. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' + documentSchemaNames: type: array - documentNameFilter: description: >- - Search the documents in the list. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. + This filter specifies the exact document schema + Document.document_schema_name of the documents to search against. If + a value isn't specified, documents within the search results are + associated with any schema. If multiple values are specified, + documents within the search results may be associated with any of + the specified schemas. At most 20 document schema names are allowed. items: type: string + customPropertyFilter: + type: string + description: >- + This filter specifies a structured syntax to match against the + [PropertyDefinition].is_filterable marked as `true`. The syntax for + this expression is a subset of SQL syntax. Supported operators are: + `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator + is a property name and the right of the operator is a number or a + quoted string. You must escape backslash (\\) and quote (\") + characters. Supported functions are `LOWER([property_name])` to + perform a case insensitive match and `EMPTY([property_name])` to + filter on the existence of a key. Boolean expressions (AND/OR/NOT) + are supported up to 3 levels of nesting (for example, "((A AND B AND + C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are + allowed in the expression. The expression must be < 6000 bytes in + length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR + EMPTY(driving_license)) AND driving_years > 10` + deprecated: true + timeFilters: type: array - customWeightsMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' description: >- - To support the custom weighting across document schemas, customers - need to provide the properties to be used to boost the ranking in - the search request. For a search query with CustomWeightsMetadata - specified, only the RetrievalImportance for the properties in the - CustomWeightsMetadata will be honored. + Documents created/updated within a range specified by this filter + are searched against. isNlQuery: description: >- Experimental, do not use. If the query is a natural language @@ -3377,403 +3660,349 @@ components: fields related to search (pagination, histograms, etc.) will be ignored. type: boolean - documentSchemaNames: - type: array - items: - type: string - description: >- - This filter specifies the exact document schema - Document.document_schema_name of the documents to search against. If - a value isn't specified, documents within the search results are - associated with any schema. If multiple values are specified, - documents within the search results may be associated with any of - the specified schemas. At most 20 document schema names are allowed. - timeFilters: - description: >- - Documents created/updated within a range specified by this filter - are searched against. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' - GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: - description: Request message for DocumentSchemaService.UpdateDocumentSchema. - properties: - documentSchema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - description: Required. The document schema to update with. type: object - id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest - GoogleCloudContentwarehouseV1CustomWeightsMetadata: - description: To support the custom weighting across document schemas. + id: GoogleCloudContentwarehouseV1DocumentQuery + GoogleCloudContentwarehouseV1SynonymSetSynonym: properties: - weightedSchemaProperties: + words: + description: 'For example: sale, invoice, bill, order' items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty - description: >- - List of schema and property name. Allows a maximum of 10 schemas to - be specified for relevance boosting. + type: string type: array type: object - id: GoogleCloudContentwarehouseV1CustomWeightsMetadata - GoogleCloudDocumentaiV1Document: + id: GoogleCloudContentwarehouseV1SynonymSetSynonym description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. - id: GoogleCloudDocumentaiV1Document + Represents a list of words given by the customer All these words are + synonyms of each other. + GoogleCloudContentwarehouseV1EnumValue: + id: GoogleCloudContentwarehouseV1EnumValue type: object + description: Represents the string value of the enum field. properties: - content: - type: string - description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. - format: byte - textStyles: - deprecated: true - description: Styles for the Document.text. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - shardInfo: + value: description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' - pages: - description: Visual page layout for the Document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - type: array - documentLayout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' - description: Parsed layout of the document. - error: - description: Any error that occurred while processing this document. - $ref: '#/components/schemas/GoogleRpcStatus' - mimeType: + String value of the enum field. This must match defined set of enums + in document schema using EnumTypeOptions. type: string - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - text: - description: Optional. UTF-8 encoded text in reading order from the document. + GoogleCloudContentwarehouseV1FloatTypeOptions: + description: Configurations for a float property. + type: object + id: GoogleCloudContentwarehouseV1FloatTypeOptions + properties: {} + GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: + properties: + name: + description: The schema name in the source. type: string - entities: - type: array - description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - revisions: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' - type: array - description: Placeholder. Revision history of this document. - textChanges: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' - description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. - type: array - chunkedDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' - description: Document chunked based on chunking config. - uri: + processorType: type: string - description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - entityRelations: - description: Placeholder. Relationship among Document.entities. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + description: The Doc AI processor type name. + description: The schema source information. + id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + type: object + GoogleCloudContentwarehouseV1PropertyTypeOptions: + id: GoogleCloudContentwarehouseV1PropertyTypeOptions + properties: + propertyDefinitions: type: array - GoogleCloudContentwarehouseV1TimeFilter: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + description: Required. List of property definitions. + description: Configurations for a nested structured data property. type: object + GoogleCloudContentwarehouseV1CreateDocumentRequest: properties: - timeField: + cloudAiDocumentOption: description: >- - Specifies which time field to filter documents on. Defaults to - TimeField.UPLOAD_TIME. - type: string - enumDescriptions: - - Default value. - - Earliest document create time. - - Latest document update time. - - Time when document becomes mutable again. - enum: - - TIME_FIELD_UNSPECIFIED - - CREATE_TIME - - UPDATE_TIME - - DISPOSITION_TIME - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - id: GoogleCloudContentwarehouseV1TimeFilter - description: Filter on create timestamp or update timestamp of documents. - GoogleCloudContentwarehouseV1UpdateDocumentResponse: - description: Response message for DocumentService.UpdateDocument. - id: GoogleCloudContentwarehouseV1UpdateDocumentResponse - properties: + Request Option for processing Cloud AI Document in Document + Warehouse. This field offers limited support for mapping entities + from Cloud AI Document to Warehouse Document. Please consult with + product team before using this field and other available options. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + policy: + description: >- + Default document policy during creation. This refers to an Identity + and Access (IAM) policy, which specifies access controls for the + Document. Conditions defined in the policy will be ignored. + $ref: '#/components/schemas/GoogleIamV1Policy' document: + description: Required. The document to create. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Updated document after executing update request. - ruleEngineOutput: - description: >- - Output from Rule Engine recording the rule evaluator and action - executor's output. Refer format in: - google/cloud/contentwarehouse/v1/rule_engine.proto - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' - metadata: + createMask: description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - type: object - GoogleCloudContentwarehouseV1SynonymSetSynonym: + Field mask for creating Document fields. If mask path is empty, it + means all fields are masked. For the `FieldMask` definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. + format: google-fieldmask + type: string + id: GoogleCloudContentwarehouseV1CreateDocumentRequest type: object - id: GoogleCloudContentwarehouseV1SynonymSetSynonym - properties: - words: - type: array - description: 'For example: sale, invoice, bill, order' - items: - type: string - description: >- - Represents a list of words given by the customer All these words are - synonyms of each other. - GoogleCloudContentwarehouseV1ActionExecutorOutput: - description: Represents the output of the Action Executor. + description: Request message for DocumentService.CreateDocument. + GoogleCloudContentwarehouseV1SetAclRequest: + id: GoogleCloudContentwarehouseV1SetAclRequest type: object + description: Request message for DocumentService.SetAcl. properties: - ruleActionsPairs: - description: List of rule and corresponding actions result. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' - id: GoogleCloudContentwarehouseV1ActionExecutorOutput - GoogleCloudContentwarehouseV1Value: - description: >- - `Value` represents a dynamically typed value which can be either be a - float, a integer, a string, or a datetime value. A producer of value is - expected to set one of these variants. Absence of any variant indicates - an error. - properties: - datetimeValue: - description: Represents a datetime value. - $ref: '#/components/schemas/GoogleTypeDateTime' - timestampValue: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - description: Represents a timestamp value. - intValue: - type: integer - description: Represents a integer value. - format: int32 - stringValue: - description: Represents a string value. - type: string - floatValue: - type: number - description: Represents a float value. - format: float - enumValue: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' - description: Represents an enum value. - booleanValue: - description: Represents a boolean value. + projectOwner: type: boolean - id: GoogleCloudContentwarehouseV1Value - type: object - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - description: Represents a chunk. - type: object - properties: - pageFooters: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - type: array - description: Page footers associated with the chunk. - chunkId: - type: string - description: ID of the chunk. - pageHeaders: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - description: Page headers associated with the chunk. - content: - type: string - description: Text content of the chunk. - sourceBlockIds: - type: array - items: - type: string - description: Unused. - pageSpan: - description: Page span of the chunk. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - GoogleCloudContentwarehouseV1DateTimeArray: - properties: - values: - items: - $ref: '#/components/schemas/GoogleTypeDateTime' - type: array - description: >- - List of datetime values. Both OffsetDateTime and ZonedDateTime are - supported. - type: object - description: DateTime values. - id: GoogleCloudContentwarehouseV1DateTimeArray - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: - properties: - cells: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - type: array - description: A table row is a list of table cells. - type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - description: Represents a row in a table. - GoogleTypeExpr: - id: GoogleTypeExpr - type: object - properties: - title: - type: string description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - expression: - type: string + For Set Project ACL only. Authorization check for end user will be + ignored when project_owner=true. + policy: description: >- - Textual representation of an expression in Common Expression - Language syntax. - description: + Required. REQUIRED: The complete policy to be applied to the + `resource`. The size of the policy is limited to a few 10s of KB. + This refers to an Identity and Access (IAM) policy, which specifies + access controls for the Document. You can set ACL with condition for + projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, + and `>=` where the left of the operator is `DocumentSchemaId` or + property name and the right of the operator is a number or a quoted + string. You must escape backslash (\\) and quote (\") characters. + Boolean expressions (AND/OR) are supported up to 3 levels of nesting + (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 + comparisons are allowed in the expression. The expression must be < + 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some + schema id\" OR SchemaId.floatPropertyName >= 10"` + $ref: '#/components/schemas/GoogleIamV1Policy' + requestMetadata: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + GoogleCloudDocumentaiV1DocumentPageImage: + properties: + mimeType: type: string - location: description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + width: + type: integer + format: int32 + description: Width of the image in pixels. + height: + format: int32 + description: Height of the image in pixels. + type: integer + content: + description: Raw byte content of the image. type: string + format: byte + id: GoogleCloudDocumentaiV1DocumentPageImage + type: object + description: Rendered image contents for this page. + GoogleCloudDocumentaiV1DocumentProvenance: description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: + Structure to identify provenance relationships between annotations in + different revisions. + id: GoogleCloudDocumentaiV1DocumentProvenance type: object properties: - nextPageToken: - type: string - 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. - documentLinks: - description: Target document-links. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + revision: + type: integer + deprecated: true + description: The index of the revision that produced this element. + format: int32 + parents: + description: References to the original elements that are replaced. type: array - description: Response message for DocumentLinkService.ListLinkedTargets. - id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse - GoogleCloudContentwarehouseV1SetAclResponse: - id: GoogleCloudContentwarehouseV1SetAclResponse + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + id: + description: >- + The Id of this operation. Needs to be unique within the scope of the + revision. + format: int32 + type: integer + deprecated: true + type: + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED + type: string + enumDescriptions: + - >- + Operation type unspecified. If no operation is specified a + provenance entry is simply used to match against a `parent`. + - Add an element. + - Remove an element identified by `parent`. + - >- + Updates any fields within the given provenance scope of the + message. It overwrites the fields rather than replacing them. Use + this when you want to update a field value of an entity without + also updating all the child properties. + - Currently unused. Replace an element identified by `parent`. + - >- + Deprecated. Request human review for the element identified by + `parent`. + - >- + Deprecated. Element is reviewed and approved at human review, + confidence will be set to 1.0. + - Deprecated. Element is skipped in the validation process. + description: The type of provenance operation. + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: type: object - description: Response message for DocumentService.SetAcl. properties: - metadata: + confidence: description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - policy: - description: The policy will be attached to a resource (e.g. projecct, document). - $ref: '#/components/schemas/GoogleIamV1Policy' - GoogleCloudContentwarehouseV1PublishAction: - properties: - messages: - type: array - items: - type: string - description: Messages to be published. - topicId: + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + type: number + format: float + type: type: string description: >- - The topic id in the Pub/Sub service for which messages will be - published to. + Name of the defect type. Supported values are: - + `quality/defect_blurry` - `quality/defect_noisy` - + `quality/defect_dark` - `quality/defect_faint` - + `quality/defect_text_too_small` - `quality/defect_document_cutoff` - + `quality/defect_text_cutoff` - `quality/defect_glare` + description: Image Quality Defects + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + GoogleCloudContentwarehouseV1ProjectStatus: type: object - id: GoogleCloudContentwarehouseV1PublishAction + id: GoogleCloudContentwarehouseV1ProjectStatus description: >- - Represents the action responsible for publishing messages to a Pub/Sub - topic. - GoogleCloudDocumentaiV1DocumentTextChange: - type: object - description: This message is used for text changes aka. OCR corrections. + Status of a project, including the project state, dbType, aclMode and + etc. properties: - provenance: - description: The history of this annotation. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - type: array - deprecated: true - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + accessControlMode: + enum: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI + type: string + description: Access control mode. + enumDescriptions: + - This value is required by protobuf best practices + - 'Universal Access: No document level access control.' + - Document level access control with customer own Identity Service. + - Document level access control using Google Cloud Identity. + location: + description: The location of the queried project. + type: string + state: + description: State of the project. + enum: + - PROJECT_STATE_UNSPECIFIED + - PROJECT_STATE_PENDING + - PROJECT_STATE_COMPLETED + - PROJECT_STATE_FAILED + - PROJECT_STATE_DELETING + - PROJECT_STATE_DELETING_FAILED + - PROJECT_STATE_DELETED + - PROJECT_STATE_NOT_FOUND + enumDescriptions: + - Default status, required by protobuf best practices. + - The project is in the middle of a provision process. + - All dependencies have been provisioned. + - A provision process was previously initiated, but failed. + - The project is in the middle of a deletion process. + - A deleting process was initiated, but failed. + - The project is deleted. + - The project is not found. + type: string + databaseType: + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + description: Database type. + type: string + enumDeprecated: + - false + - false + - true + documentCreatorDefaultRole: + type: string + description: The default role for the person who create a document. + qaEnabled: + type: boolean + description: If the qa is enabled on this project. + GoogleCloudDocumentaiV1Barcode: + properties: + valueFormat: description: >- - Provenance of the correction. Text anchor indexing into the - Document.text. There can only be a single `TextAnchor.text_segments` - element. If the start and end index of the text segment are the - same, the text change is inserted before that index. - changedText: - description: The text that replaces the text identified in the `text_anchor`. + Value format describes the format of the value that a barcode + encodes. The supported formats are: - `CONTACT_INFO`: Contact + information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - + `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - + `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi + information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar + event. - `DRIVER_LICENSE`: Driver's license. type: string - id: GoogleCloudDocumentaiV1DocumentTextChange + format: + type: string + description: >- + Format of a barcode. The supported formats are: - `CODE_128`: Code + 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - + `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - + `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - + `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E + type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - + `DATABAR`: GS1 DataBar code type. + rawValue: + description: >- + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + type: string + type: object + description: Encodes the detailed information of a barcode. + id: GoogleCloudDocumentaiV1Barcode + GoogleTypeTimeZone: + id: GoogleTypeTimeZone + properties: + version: + description: Optional. IANA Time Zone Database version number, e.g. "2019a". + type: string + id: + type: string + description: IANA Time Zone Database time zone, e.g. "America/New_York". + type: object + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). GoogleCloudDocumentaiV1DocumentPageLayout: + id: GoogleCloudDocumentaiV1DocumentPageLayout + type: object properties: - confidence: - description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. - format: float - type: number boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' textAnchor: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' description: Text anchor indexing into the Document.text. orientation: - description: Detected orientation for the Layout. + type: string enum: - ORIENTATION_UNSPECIFIED - PAGE_UP @@ -3792,582 +4021,396 @@ components: - >- Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read. - type: string - id: GoogleCloudDocumentaiV1DocumentPageLayout + description: Detected orientation for the Layout. + confidence: + description: >- + Confidence of the current Layout within context of the object this + layout is for. e.g. confidence can be for a single token, a table, a + visual element, etc. depending on context. Range `[0, 1]`. + format: float + type: number description: Visual element describing a layout unit on a page. - type: object - GoogleCloudContentwarehouseV1RuleActionsPair: + CloudAiPlatformTenantresourceServiceAccountIdentity: + description: The identity to configure a service account. properties: - rule: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: Represents the rule. - actionOutputs: - description: Outputs of executing the actions associated with the above rule. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' - type: array - id: GoogleCloudContentwarehouseV1RuleActionsPair + serviceAccountEmail: + description: Output only. The service account email that has been created. + type: string + tag: + type: string + description: >- + Input/Output [Optional]. The tag that configures the service + account, as defined in + google3/configs/production/cdpush/acl-zanzibar-cloud-prod/activation_grants/activation_grants.gcl. + Note: The default P4 service account has the empty tag. type: object - description: Represents a rule and outputs of associated actions. - GoogleCloudContentwarehouseV1Rule: + id: CloudAiPlatformTenantresourceServiceAccountIdentity + GoogleCloudContentwarehouseV1LockDocumentRequest: + id: GoogleCloudContentwarehouseV1LockDocumentRequest + description: Request message for DocumentService.LockDocument. properties: - triggerType: - enum: - - UNKNOWN - - ON_CREATE - - ON_UPDATE - - ON_CREATE_LINK - - ON_DELETE_LINK - description: Identifies the trigger type for running the policy. + lockingUser: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: The user information who locks the document. + collectionId: type: string - enumDescriptions: - - Trigger for unknown action. - - Trigger for create document action. - - Trigger for update document action. - - Trigger for create link action. - - Trigger for delete link action. - actions: + description: The collection the document connects to. + type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: + description: Represents a text type block. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + type: object + properties: + blocks: type: array - description: List of actions that are executed when the rule is satisfied. items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' - description: - description: Short description of the rule and its context. - type: string - condition: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock description: >- - Represents the conditional expression to be evaluated. Expression - should evaluate to a boolean result. When the condition is true - actions are executed. Example: user_role = "hsbc_role_1" AND - doc.salary > 20000 - ruleId: + A text block could further have child blocks. Repeated blocks + support further hierarchies and nested blocks. + type: + type: string description: >- - ID of the rule. It has to be unique across all the examples. This is - managed internally. + Type of the text in the block. Available options are: `paragraph`, + `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + `heading-5`, `header`, `footer`. + text: type: string - id: GoogleCloudContentwarehouseV1Rule - description: Represents the rule for a content warehouse trigger. + description: Text content stored in the block. + GoogleCloudContentwarehouseV1InvalidRule: + properties: + rule: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + description: Triggered rule. + error: + type: string + description: Validation error on a parsed expression. type: object - GoogleLongrunningOperation: + id: GoogleCloudContentwarehouseV1InvalidRule + description: A triggered rule that failed the validation check(s) after parsing. + GoogleCloudContentwarehouseV1ResponseMetadata: + properties: + requestId: + type: string + description: >- + A unique id associated with this call. This id is logged for + tracking purpose. type: object - id: GoogleLongrunningOperation + id: GoogleCloudContentwarehouseV1ResponseMetadata description: >- - This resource represents a long-running operation that is the result of - a network API call. + Additional information returned to client, such as debugging + information. + GoogleCloudDocumentaiV1DocumentPageAnchor: + type: object + description: >- + Referencing the visual context of the entity in the Document.pages. Page + anchors can be cross-page, consist of multiple bounding polygons and + optionally reference specific layout element types. properties: - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - name: - type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - CloudAiPlatformTenantresourceTenantProjectResource: - properties: - gcsBuckets: - items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' - description: The GCS buckets that are provisioned under the tenant project. - type: array - iamPolicyBindings: - items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' - type: array - description: >- - The dynamic IAM bindings that are granted under the tenant project. - Note: this should only add new bindings to the project if they don't - exist and the existing bindings won't be affected. - infraSpannerConfigs: + pageRefs: type: array items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig - description: >- - The Infra Spanner databases that are provisioned under the tenant - project. Note: this is an experimental feature. - tag: - type: string + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + description: One or more references to visual page elements + id: GoogleCloudDocumentaiV1DocumentPageAnchor + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + message: description: >- - Input/Output [Required]. The tag that uniquely identifies a tenant - project within a tenancy unit. Note: for the same tenant project - tag, all tenant manager operations should be idempotent. - tenantProjectId: - type: string - description: Output only. The tenant project ID that has been created. - tenantProjectNumber: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - description: Output only. The tenant project number that has been created. - format: int64 - tenantProjectConfig: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectConfig - description: The configurations of a tenant project. - tenantServiceAccounts: - description: >- - The service account identities (or enabled API service's P4SA) that - are expclicitly created under the tenant project (before JIT - provisioning during enabled API services). - type: array - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity - cloudSqlInstances: - description: >- - The CloudSQL instances that are provisioned under the tenant - project. + details: items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object type: array - id: CloudAiPlatformTenantresourceTenantProjectResource + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: + type: integer + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + GoogleCloudContentwarehouseV1CloudAIDocumentOption: + description: Request Option for processing Cloud AI Document in CW Document. type: object - description: 'The tenant project and tenant resources. Next ID: 10' - GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: + properties: + customizedEntitiesPropertiesConversions: + additionalProperties: + type: string + type: object + description: If set, only selected entities will be converted to properties. + enableEntitiesConversions: + type: boolean + description: Whether to convert all the entities to properties. + id: GoogleCloudContentwarehouseV1CloudAIDocumentOption + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: type: object - id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource - description: The schema source information. + description: Font and other text style attributes. + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo properties: - name: - type: string - description: The schema name in the source. - processorType: + bold: + type: boolean + description: >- + Whether the text is bold (equivalent to font_weight is at least + `700`). + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + strikeout: + type: boolean + description: >- + Whether the text is strikethrough. This feature is not supported + yet. + fontSize: + format: int32 + type: integer + description: Font size in points (`1` point is `¹⁄₇₂` inches). + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. + letterSpacing: + type: number + format: double + description: Letter spacing in points. + pixelFontSize: + description: >- + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + type: number + format: double + superscript: + description: >- + Whether the text is a superscript. This feature is not supported + yet. + type: boolean + subscript: + type: boolean + description: Whether the text is a subscript. This feature is not supported yet. + italic: + description: Whether the text is italic. + type: boolean + fontWeight: + format: int32 + type: integer + description: >- + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + underlined: + type: boolean + description: Whether the text is underlined. + handwritten: + type: boolean + description: Whether the text is handwritten. + smallcaps: + type: boolean + description: >- + Whether the text is in small caps. This feature is not supported + yet. + fontType: type: string - description: The Doc AI processor type name. - GoogleCloudContentwarehouseV1DocumentSchema: + description: Name or style of the font. + GoogleCloudContentwarehouseV1Document: + description: Defines the structure for content warehouse document proto. + type: object properties: - name: + dispositionTime: + readOnly: true type: string description: >- - The resource name of the document schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - The name is ignored when creating a document schema. - updateTime: - description: Output only. The time when the document schema is last updated. - readOnly: true + Output only. If linked to a Collection with RetentionPolicy, the + date when the document becomes mutable. format: google-datetime + inlineRawDocument: + format: byte type: string - description: - description: Schema description. + description: Raw document content. + documentSchemaName: type: string - createTime: - readOnly: true - description: Output only. The time when the document schema is created. - format: google-datetime + description: >- + The Document schema name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + plainText: type: string - propertyDefinitions: + description: Other document format, such as PPTX, XLXS + textExtractionEnabled: + description: If true, text extraction will be performed. + type: boolean + properties: items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' + description: List of values that are user supplied metadata. type: array - description: Document details. - displayName: + updater: type: string - description: >- - Required. Name of the schema given by the user. Must be unique per - project. - documentIsFolder: + description: The user who lastly updates the document. + legalHold: type: boolean + readOnly: true + description: Output only. Indicates if the document has a legal hold on it. + referenceId: + type: string description: >- - Document Type, true refers the document is a folder, otherwise it is - a typical document. - id: GoogleCloudContentwarehouseV1DocumentSchema - description: A document schema used to define document structure. - type: object - GoogleCloudContentwarehouseV1ProjectStatus: - id: GoogleCloudContentwarehouseV1ProjectStatus - type: object - description: >- - Status of a project, including the project state, dbType, aclMode and - etc. - properties: - state: - description: State of the project. - enum: - - PROJECT_STATE_UNSPECIFIED - - PROJECT_STATE_PENDING - - PROJECT_STATE_COMPLETED - - PROJECT_STATE_FAILED - - PROJECT_STATE_DELETING - - PROJECT_STATE_DELETING_FAILED - - PROJECT_STATE_DELETED - - PROJECT_STATE_NOT_FOUND - enumDescriptions: - - Default status, required by protobuf best practices. - - The project is in the middle of a provision process. - - All dependencies have been provisioned. - - A provision process was previously initiated, but failed. - - The project is in the middle of a deletion process. - - A deleting process was initiated, but failed. - - The project is deleted. - - The project is not found. + The reference ID set by customers. Must be unique per project and + location. + displayUri: type: string - accessControlMode: + description: Uri to display the document, for example, in the UI. + rawDocumentPath: + description: Raw document file in Cloud Storage path. + type: string + name: + type: string + description: >- + The resource name of the document. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + The name is ignored when creating a document. + title: type: string + description: >- + Title that describes the document. This can be the top heading or + text that describes the document. + rawDocumentFileType: enumDescriptions: - - This value is required by protobuf best practices - - 'Universal Access: No document level access control.' - - Document level access control with customer own Identity Service. - - Document level access control using Google Cloud Identity. - description: Access control mode. + - No raw document specified or it is non-parsable + - Adobe PDF format + - Microsoft Word format + - Microsoft Excel format + - Microsoft Powerpoint format + - UTF-8 encoded text format + - TIFF or TIF image file format + description: >- + This is used when DocAI was not used to load the document and + parsing/ extracting is needed for the inline_raw_document. For + example, if inline_raw_document is the byte representation of a PDF + file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. + type: string enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - documentCreatorDefaultRole: - description: The default role for the person who create a document. + - RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED + - RAW_DOCUMENT_FILE_TYPE_PDF + - RAW_DOCUMENT_FILE_TYPE_DOCX + - RAW_DOCUMENT_FILE_TYPE_XLSX + - RAW_DOCUMENT_FILE_TYPE_PPTX + - RAW_DOCUMENT_FILE_TYPE_TEXT + - RAW_DOCUMENT_FILE_TYPE_TIFF + contentCategory: type: string - qaEnabled: - description: If the qa is enabled on this project. - type: boolean - databaseType: + description: >- + Indicates the category (image, audio, video etc.) of the original + content. enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES + - CONTENT_CATEGORY_UNSPECIFIED + - CONTENT_CATEGORY_IMAGE + - CONTENT_CATEGORY_AUDIO + - CONTENT_CATEGORY_VIDEO enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance + - No category is specified. + - Content is of image type. + - Content is of audio type. + - Content is of video type. + cloudAiDocument: + description: Document AI format to save the structured content, including OCR. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + createTime: type: string - description: Database type. - enumDeprecated: - - false - - false - - true - location: + description: Output only. The time when the document is created. + readOnly: true + format: google-datetime + displayName: type: string - description: The location of the queried project. - GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: - id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline - description: >- - The configuration of processing documents in Document Warehouse with - DocAi processors pipeline. - properties: - documents: description: >- - The list of all the resource names of the documents to be processed. - Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - items: - type: string - type: array - exportFolderPath: + Required. Display name of the document given by the user. This name + will be displayed in the UI. Customer can populate this field with + the name of the document. This differs from the 'title' field as + 'title' is optional and stores the top heading in the document. + updateTime: type: string - description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. - processorResultsFolderPath: + description: Output only. The time when the document is last updated. + format: google-datetime + readOnly: true + textExtractionDisabled: + description: If true, text extraction will not be performed. + deprecated: true + type: boolean + creator: + description: The user who creates the document. type: string - description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - processorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - description: The CDW processor information. + id: GoogleCloudContentwarehouseV1Document + GoogleCloudContentwarehouseV1QAResultHighlight: + id: GoogleCloudContentwarehouseV1QAResultHighlight type: object - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - description: Represents a weak reference to a page element within a document. + properties: + startIndex: + description: Start index of the highlight. + type: integer + format: int32 + endIndex: + format: int32 + description: End index of the highlight, exclusive. + type: integer + description: >- + A text span in the search text snippet that represents a highlighted + section (answer context, highly relevant sentence, etc.). + CloudAiPlatformTenantresourceTenantServiceAccountIdentity: type: object + description: >- + The identity of service accounts that have been explicitly created under + tenant projects. + id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity properties: - confidence: - type: number - format: float - description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - layoutId: - type: string - deprecated: true - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - page: - format: int64 + serviceName: description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. + Input/Output [Required]. The service that the service account + belongs to. (e.g. cloudbuild.googleapis.com for GCB service + accounts) type: string - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - layoutType: - description: >- - Optional. The type of the layout element that is being referenced if - any. - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD + serviceAccountEmail: + description: Output only. The email address of the generated service account. type: string - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: - type: object - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata - properties: - processorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - description: The DocAI processor to process the documents with. - documents: - description: >- - The input list of all the resource names of the documents to be - processed. - items: - type: string - type: array - description: The metadata message for Process-with-DocAi pipeline. - GoogleCloudContentwarehouseV1UserInfo: - description: The user information. + GoogleCloudContentwarehouseV1RuleSet: properties: - groupIds: + rules: items: - type: string - description: >- - The unique group identifications which the user is belong to. The - format is "group:yyyy@example.com"; + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + description: List of rules given by the customer. type: array - id: + source: type: string + description: Source of the rules i.e., customer name. + name: description: >- - A unique user identification string, as determined by the client. - The maximum number of allowed characters is 255. Allowed characters - include numbers 0 to 9, uppercase and lowercase letters, and - restricted special symbols (:, @, +, -, _, ~) The format is - "user:xxxx@example.com"; - id: GoogleCloudContentwarehouseV1UserInfo - type: object - GoogleCloudDocumentaiV1DocumentPageTable: - type: object - properties: - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this table. - deprecated: true - headerRows: - description: Header rows of the table. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - type: array - layout: - description: Layout for Table. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - bodyRows: - description: Body rows of the table. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - description: A table representation similar to HTML table structure. - id: GoogleCloudDocumentaiV1DocumentPageTable - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. - properties: - members: - type: array - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - items: - type: string - role: - type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' - id: GoogleIamV1Binding - type: object - GoogleCloudContentwarehouseV1CreateDocumentMetadata: - properties: {} - description: Metadata object for CreateDocument request (currently empty). - id: GoogleCloudContentwarehouseV1CreateDocumentMetadata - type: object - CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: - properties: - cmekCloudResourceName: - description: >- - The cloud resource name for the CMEK encryption. For example, - projects//locations/ - type: string - cmekCloudResourceType: - description: >- - The cloud resource type for the CMEK encryption. For example, - contentwarehouse.googleapis.com/Location + The resource name of the rule set. Managed internally. Format: + projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. + The name is ignored when creating a rule set. type: string - cmekServiceName: + description: type: string - description: >- - The service name for the CMEK encryption. For example, - contentwarehouse.googleapis.com - description: >- - The options to create a spanner database. KMS key access audit logging - and AxT logging will be associated with the given resource name, - resource type and service name. Please ensure to give right options to - enable correct audit logging and AxT logging. + description: Short description of the rule-set. type: object - id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + id: GoogleCloudContentwarehouseV1RuleSet + description: Represents a set of rules from a single customer. GoogleCloudContentwarehouseV1IngestPipelineConfig: - type: object id: GoogleCloudContentwarehouseV1IngestPipelineConfig properties: - enableDocumentTextExtraction: - type: boolean - description: >- - The document text extraction enabled flag. If the flag is set to - true, DWH will perform text extraction on the raw document. - folder: - type: string - description: >- - Optional. The name of the folder to which all ingested documents - will be linked during ingestion process. Format is - `projects/{project}/locations/{location}/documents/{folder_id}` - documentAclPolicy: - description: >- - The document level acl policy config. This refers to an Identity and - Access (IAM) policy, which specifies access controls for all - documents ingested by the pipeline. The role and members under the - policy needs to be specified. The following roles are supported for - document level acl control: * roles/contentwarehouse.documentAdmin * - roles/contentwarehouse.documentEditor * - roles/contentwarehouse.documentViewer The following members are - supported for document level acl control: * - user:user-email@example.com * group:group-email@example.com Note - that for documents searched with LLM, only single level user or - group acl check is supported. - $ref: '#/components/schemas/GoogleIamV1Policy' cloudFunction: + type: string description: >- The Cloud Function resource name. The Cloud Function needs to live inside consumer project and is accessible to Document AI Warehouse @@ -4383,727 +4426,697 @@ components: proto content and/or related information. The original values will be overridden if any key is present in the response. * display_name * properties * plain_text * document_acl_policy * folder + documentAclPolicy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: >- + The document level acl policy config. This refers to an Identity and + Access (IAM) policy, which specifies access controls for all + documents ingested by the pipeline. The role and members under the + policy needs to be specified. The following roles are supported for + document level acl control: * roles/contentwarehouse.documentAdmin * + roles/contentwarehouse.documentEditor * + roles/contentwarehouse.documentViewer The following members are + supported for document level acl control: * + user:user-email@example.com * group:group-email@example.com Note + that for documents searched with LLM, only single level user or + group acl check is supported. + enableDocumentTextExtraction: + description: >- + The document text extraction enabled flag. If the flag is set to + true, DWH will perform text extraction on the raw document. + type: boolean + folder: type: string + description: >- + Optional. The name of the folder to which all ingested documents + will be linked during ingestion process. Format is + `projects/{project}/locations/{location}/documents/{folder_id}` + type: object description: The ingestion pipeline config. - GoogleCloudDocumentaiV1DocumentPageTableTableCell: + GoogleCloudDocumentaiV1DocumentDocumentLayout: + type: object + description: >- + Represents the parsed layout of a document as a collection of blocks + that the document is divided into. properties: - colSpan: - description: How many columns this cell spans. - type: integer - format: int32 - rowSpan: - description: How many rows this cell spans. - type: integer - format: int32 - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for TableCell. - detectedLanguages: + blocks: + type: array + description: List of blocks in the document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - description: A cell representation inside the table. - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + id: GoogleCloudDocumentaiV1DocumentDocumentLayout + GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: + description: Request message for DocumentSchemaService.UpdateDocumentSchema. + id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + properties: + documentSchema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + description: Required. The document schema to update with. type: object - GoogleCloudContentwarehouseV1SetAclRequest: - description: Request message for DocumentService.SetAcl. + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: + description: Represents a chunk. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + properties: + pageFooters: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + description: Page footers associated with the chunk. + sourceBlockIds: + description: Unused. + items: + type: string + type: array + pageHeaders: + description: Page headers associated with the chunk. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + content: + description: Text content of the chunk. + type: string + chunkId: + type: string + description: ID of the chunk. + pageSpan: + description: Page span of the chunk. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + type: object + GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: properties: - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: >- - Required. REQUIRED: The complete policy to be applied to the - `resource`. The size of the policy is limited to a few 10s of KB. - This refers to an Identity and Access (IAM) policy, which specifies - access controls for the Document. You can set ACL with condition for - projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, - and `>=` where the left of the operator is `DocumentSchemaId` or - property name and the right of the operator is a number or a quoted - string. You must escape backslash (\\) and quote (\") characters. - Boolean expressions (AND/OR) are supported up to 3 levels of nesting - (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 - comparisons are allowed in the expression. The expression must be < - 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some - schema id\" OR SchemaId.floatPropertyName >= 10"` requestMetadata: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - The meta information collected about the end user, used to enforce - access control for the service. - projectOwner: - type: boolean + The meta information collected about the document creator, used to + enforce access control for the service. + documentLink: description: >- - For Set Project ACL only. Authorization check for end user will be - ignored when project_owner=true. - type: object - id: GoogleCloudContentwarehouseV1SetAclRequest - GoogleCloudContentwarehouseV1HistogramQuery: + Required. Document links associated with the source documents + (source_document_id). + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' type: object - id: GoogleCloudContentwarehouseV1HistogramQuery - description: The histogram request. + id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + description: Request message for DocumentLinkService.CreateDocumentLink. + GoogleCloudContentwarehouseV1InitializeProjectRequest: + id: GoogleCloudContentwarehouseV1InitializeProjectRequest + description: Request message for projectService.InitializeProject properties: - filters: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - description: >- - Optional. Filter the result of histogram query by the property - names. It only works with histogram query - count('FilterableProperties'). It is an optional. It will perform - histogram on all the property names for all the document schemas. - Setting this field will have a better performance. - histogramQuery: + documentCreatorDefaultRole: + enum: + - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED + - DOCUMENT_ADMIN + - DOCUMENT_EDITOR + - DOCUMENT_VIEWER + enumDescriptions: + - Unspecified, will be default to document admin role. + - >- + Document Admin, same as + contentwarehouse.googleapis.com/documentAdmin. + - >- + Document Editor, same as + contentwarehouse.googleapis.com/documentEditor. + - >- + Document Viewer, same as + contentwarehouse.googleapis.com/documentViewer. + description: Optional. The default role for the person who create a document. + type: string + databaseType: + type: string + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + enumDeprecated: + - false + - false + - true + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + description: Required. The type of database used to store customer data + kmsKey: + type: string description: >- - An expression specifies a histogram request against matching - documents for searches. See SearchDocumentsRequest.histogram_queries - for details about syntax. + Optional. The KMS key used for CMEK encryption. It is required that + the kms key is in the same region as the endpoint. The same key will + be used for all provisioned resources, if encryption is available. + If the kms_key is left empty, no encryption will be enforced. + accessControlMode: + description: Required. The access control mode for accessing the customer data type: string - requirePreciseResultSize: + enumDescriptions: + - This value is required by protobuf best practices + - 'Universal Access: No document level access control.' + - Document level access control with customer own Identity Service. + - Document level access control using Google Cloud Identity. + enum: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI + enableCalUserEmailLogging: type: boolean - description: >- - Controls if the histogram query requires the return of a precise - count. Enable this flag may adversely impact performance. Defaults - to true. - GoogleCloudContentwarehouseV1MapProperty: - properties: - fields: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' - description: Unordered map of dynamically typed values. - description: >- - Map property value. Represents a structured entries of key value pairs, - consisting of field names which map to dynamically typed values. + description: Optional. Whether to enable CAL user email logging. type: object - id: GoogleCloudContentwarehouseV1MapProperty - GoogleTypeDateTime: + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: type: object - id: GoogleTypeDateTime - description: >- - Represents civil time (or occasionally physical time). This type can - represent a civil time in one of a few possible ways: * When utc_offset - is set and time_zone is unset: a civil time on a calendar day with a - particular offset from UTC. * When time_zone is set and utc_offset is - unset: a civil time on a calendar day in a particular time zone. * When - neither time_zone nor utc_offset is set: a civil time on a calendar day - in local time. The date is relative to the Proleptic Gregorian Calendar. - If year, month, or day are 0, the DateTime is considered not to have a - specific year, month, or day respectively. This type may also be used to - represent a physical time if all the date and time fields are set and - either case of the `time_offset` oneof is set. Consider using - `Timestamp` message for physical time instead. If your use case also - would like to store the user's timezone, that can be done in another - field. This type is more flexible than some applications may want. Make - sure to document and validate your application's limitations. + description: The metadata message for Export-to-CDW pipeline. + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata properties: - utcOffset: - format: google-duration - description: >- - UTC offset. Must be whole seconds, between -18 hours and +18 hours. - For example, a UTC offset of -4:00 would be represented as { - seconds: -14400 }. + docAiDataset: + description: The output CDW dataset resource name. type: string - hours: - format: int32 - type: integer - description: >- - Optional. Hours of day in 24 hour format. Should be from 0 to 23, - defaults to 0 (midnight). An API may choose to allow the value - "24:00:00" for scenarios like business closing time. - minutes: - type: integer + outputPath: + description: The output Cloud Storage folder in this pipeline. + type: string + documents: description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. - format: int32 + The input list of all the resource names of the documents to be + exported. + type: array + items: + type: string + GoogleTypeDate: + id: GoogleTypeDate + properties: month: - description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. - type: integer - format: int32 - day: format: int32 type: integer description: >- - Optional. Day of month. Must be from 1 to 31 and valid for the year - and month, or 0 if specifying a datetime without a day. - timeZone: - $ref: '#/components/schemas/GoogleTypeTimeZone' - description: Time zone. - year: - format: int32 + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + day: type: integer description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - seconds: + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. format: int32 - description: >- - Optional. Seconds of minutes of the time. Must normally be from 0 to - 59, defaults to 0. An API may allow the value 60 if it allows - leap-seconds. - type: integer - nanos: + year: format: int32 - description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. type: integer - GoogleCloudContentwarehouseV1TextArray: - description: String/text values. + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + GoogleCloudDocumentaiV1BoundingPoly: + description: A bounding polygon for the detected image annotation. type: object - id: GoogleCloudContentwarehouseV1TextArray properties: - values: - type: array + normalizedVertices: items: - type: string - description: List of text values. - GoogleCloudDocumentaiV1DocumentEntityRelation: - id: GoogleCloudDocumentaiV1DocumentEntityRelation - type: object - properties: - subjectId: - type: string - description: Subject entity id. - relation: - type: string - description: Relationship description. - objectId: - description: Object entity id. - type: string - description: Relationship between Entities. - GoogleCloudDocumentaiV1DocumentChunkedDocument: - type: object - properties: - chunks: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + description: The bounding polygon normalized vertices. type: array - description: List of chunks. - id: GoogleCloudDocumentaiV1DocumentChunkedDocument - description: Represents the chunks that the document is divided into. - CloudAiPlatformTenantresourceCloudSqlInstanceConfig: - properties: - slmInstanceType: - description: Input [Required]. The SLM instance type to provision CloudSQL. - type: string - slmInstanceTemplate: - type: string - description: Input [Required]. The SLM instance template to provision CloudSQL. - mdbRolesForCorpAccess: - items: - type: string + vertices: + description: The bounding polygon vertices. type: array - description: Input [Optional]. MDB roles for corp access to CloudSQL instance. - slmInstanceName: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + id: GoogleCloudDocumentaiV1BoundingPoly + CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: + description: >- + The options to create a spanner database. KMS key access audit logging + and AxT logging will be associated with the given resource name, + resource type and service name. Please ensure to give right options to + enable correct audit logging and AxT logging. + type: object + properties: + cmekServiceName: + description: >- + The service name for the CMEK encryption. For example, + contentwarehouse.googleapis.com type: string - description: Output only. The SLM instance's full resource name. - kmsKeyReference: + cmekCloudResourceType: description: >- - Input [Optional]. The KMS key name or the KMS grant name used for - CMEK encryption. Only set this field when provisioning new CloudSQL - instances. For existing CloudSQL instances, this field will be - ignored because CMEK re-encryption is not supported. + The cloud resource type for the CMEK encryption. For example, + contentwarehouse.googleapis.com/Location type: string - cloudSqlInstanceName: + cmekCloudResourceName: type: string description: >- - Input/Output [Optional]. The CloudSQL instance name within SLM - instance. If not set, a random UUIC will be generated as instance - name. - cloudSqlInstanceConnectionName: - description: Output only. The CloudSQL instance connection name. - type: string + The cloud resource name for the CMEK encryption. For example, + projects//locations/ + id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + GoogleCloudContentwarehouseV1SynonymSet: description: >- - The identity to configure a CloudSQL instance provisioned via SLM - Terraform. + Represents a list of synonyms for a given context. For example a context + "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: + money, credit, finance, payment Synonym 3: shipping, freight, transport + Each SynonymSets should be disjoint + id: GoogleCloudContentwarehouseV1SynonymSet type: object - id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig - CloudAiPlatformTenantresourceInfraSpannerConfig: properties: - spannerBorgServiceAccount: + context: type: string description: >- - Input [Optional]. The spanner borg service account for delegating - the kms key to. For example, - spanner-infra-cmek-nonprod@system.gserviceaccount.com, for the - nonprod universe. - sdlBundlePath: - type: string - description: Input [Required]. The file path to the spanner SDL bundle. - kmsKeyReference: + This is a freeform field. Example contexts can be "sales," + "engineering," "real estate," "accounting," etc. The context can be + supplied during search requests. + synonyms: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym + type: array + description: List of Synonyms for the context. + name: description: >- - Input [Optional]. The KMS key name or the KMS grant name used for - CMEK encryption. Only set this field when provisioning new Infra - Spanner databases. For existing Infra Spanner databases, this field - will be ignored because CMEK re-encryption is not supported. For - example, projects//locations//keyRings//cryptoKeys/ - type: string - spannerNamespace: - type: string - spannerLocalNamePrefix: + The resource name of the SynonymSet This is mandatory for + google.api.resource. Format: + projects/{project_number}/locations/{location}/synonymSets/{context}. type: string - createDatabaseOptions: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions - description: >- - Input [Optional]. The options to create a spanner database. Note: - give the right options to ensure the right KMS key access audit - logging and AxT logging in expected logging category. - spannerUniverse: + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + type: object + properties: + listEntries: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + description: List entries that constitute a list block. + type: type: string description: >- - Input [Required]. Every database in Spanner can be identified by the - following path name: /span//: - id: CloudAiPlatformTenantresourceInfraSpannerConfig + Type of the list_entries (if exist). Available options are `ordered` + and `unordered`. + description: Represents a list type block. + GoogleCloudDocumentaiV1DocumentPageBlock: + id: GoogleCloudDocumentaiV1DocumentPageBlock + description: >- + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. type: object - description: 'The configuration for a spanner database provisioning. Next ID: 8' - GoogleCloudContentwarehouseV1InvalidRule: properties: - rule: - description: Triggered rule. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - error: - description: Validation error on a parsed expression. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Block. + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this annotation. + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + properties: + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the footer. + text: type: string - id: GoogleCloudContentwarehouseV1InvalidRule - description: A triggered rule that failed the validation check(s) after parsing. + description: Footer in text format. type: object - GoogleTypePostalAddress: - description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - id: GoogleTypePostalAddress + description: Represents the page footer associated with the chunk. + GoogleCloudContentwarehouseV1Rule: properties: - organization: - description: Optional. The name of the organization at the address. + description: type: string - sublocality: + description: Short description of the rule and its context. + condition: description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. + Represents the conditional expression to be evaluated. Expression + should evaluate to a boolean result. When the condition is true + actions are executed. Example: user_role = "hsbc_role_1" AND + doc.salary > 20000 type: string - administrativeArea: - description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. + ruleId: type: string - revision: - format: int32 - description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - type: integer - postalCode: description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). + ID of the rule. It has to be unique across all the examples. This is + managed internally. + triggerType: + enumDescriptions: + - Trigger for unknown action. + - Trigger for create document action. + - Trigger for update document action. + - Trigger for create link action. + - Trigger for delete link action. type: string - addressLines: + description: Identifies the trigger type for running the policy. + enum: + - UNKNOWN + - ON_CREATE + - ON_UPDATE + - ON_CREATE_LINK + - ON_DELETE_LINK + actions: items: - type: string + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' type: array - description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). - recipients: + description: List of actions that are executed when the rule is satisfied. + type: object + id: GoogleCloudContentwarehouseV1Rule + description: Represents the rule for a content warehouse trigger. + GoogleCloudDocumentaiV1DocumentPageTable: + id: GoogleCloudDocumentaiV1DocumentPageTable + type: object + description: A table representation similar to HTML table structure. + properties: + headerRows: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: Header rows of the table. type: array + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this table. + layout: + description: Layout for Table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + bodyRows: + description: Body rows of the table. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + detectedLanguages: + type: array + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudContentwarehouseV1RunPipelineRequest: + properties: + exportCdwPipeline: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. - sortingCode: - type: string - description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). - locality: + Export docuemnts from Document Warehouse to CDW for training + purpose. + processWithDocAiPipeline: description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - type: string - languageCode: + Use a DocAI processor to process documents in Document Warehouse, + and re-ingest the updated results into Document Warehouse. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + gcsIngestPipeline: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' + description: Cloud Storage ingestion pipeline. + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - type: string - regionCode: - type: string + The meta information collected about the end user, used to enforce + access control for the service. + gcsIngestWithDocAiProcessorsPipeline: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. + Use DocAI processors to process documents in Cloud Storage and + ingest them to Document Warehouse. + description: Request message for DocumentService.RunPipeline. type: object - GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: + id: GoogleCloudContentwarehouseV1RunPipelineRequest + GoogleIamV1Policy: + id: GoogleIamV1Policy properties: - documentLink: + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + bindings: + items: + $ref: '#/components/schemas/GoogleIamV1Binding' description: >- - Required. Document links associated with the source documents - (source_document_id). - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + version: description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest - type: object - description: Request message for DocumentLinkService.CreateDocumentLink. - GoogleCloudDocumentaiV1Vertex: - description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. - properties: - x: + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). type: integer format: int32 - description: X coordinate. - 'y': - description: Y coordinate (starts from the top of the image). - format: int32 - type: integer - type: object - id: GoogleCloudDocumentaiV1Vertex - GoogleCloudContentwarehouseV1Property: - properties: - textValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' - description: String/text property values. - enumValues: - description: Enum property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' - integerValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' - description: Integer property values. - dateTimeValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' - description: >- - Date time property values. It is not supported by CMEK compliant - deployment. - mapProperty: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' - description: Map property values. - floatValues: - description: Float property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' - timestampValues: - description: >- - Timestamp property values. It is not supported by CMEK compliant - deployment. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' - name: - type: string - description: >- - Required. Must match the name of a PropertyDefinition in the - DocumentSchema. - propertyValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' - description: Nested structured data property values. - description: Property of a document. - type: object - id: GoogleCloudContentwarehouseV1Property - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: - type: object - description: The metadata message for GcsIngest pipeline. - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata - properties: - inputPath: - type: string - description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' - GoogleCloudDocumentaiV1DocumentStyleFontSize: - id: GoogleCloudDocumentaiV1DocumentStyleFontSize - properties: - unit: + etag: type: string description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - size: - description: Font size for the text. - format: float - type: number - description: Font size with unit. + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + format: byte + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). type: object - GoogleCloudContentwarehouseV1PropertyDefinition: - properties: - isSearchable: - type: boolean - description: Indicates that the property should be included in a global search. - propertyTypeOptions: - description: Nested structured data property. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions - schemaSources: + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + properties: + text: + type: string description: >- - The mapping information between this property to another schema - source. - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource - type: array - floatTypeOptions: - description: Float property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' - isRepeatable: - type: boolean - description: Whether the property can have multiple values. - isFilterable: - type: boolean + Optional. An optional field to store a normalized string. For some + entity types, one of respective `structured_value` fields may also + be populated. Also not all the types of `structured_value` will be + normalized. For example, some processors may not generate `float` or + `integer` normalized text by default. Below are sample formats + mapped to structured values. - Money/Currency type (`money_value`) + is in the ISO 4217 text format. - Date type (`date_value`) is in the + ISO 8601 text format. - Datetime type (`datetime_value`) is in the + ISO 8601 text format. + addressValue: description: >- - Whether the property can be filtered. If this is a sub-property, all - the parent properties must be marked filterable. - retrievalImportance: - description: The retrieval importance of the property during search. - type: string - enumDescriptions: - - No importance specified. Default medium importance. - - Highest importance. - - Higher importance. - - High importance. - - Medium importance. - - Low importance (negative). - - Lowest importance (negative). - enum: - - RETRIEVAL_IMPORTANCE_UNSPECIFIED - - HIGHEST - - HIGHER - - HIGH - - MEDIUM - - LOW - - LOWEST - isMetadata: + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + $ref: '#/components/schemas/GoogleTypePostalAddress' + datetimeValue: + $ref: '#/components/schemas/GoogleTypeDateTime' description: >- - Whether the property is user supplied metadata. This out-of-the box - placeholder setting can be used to tag derived properties. Its value - and interpretation logic should be implemented by API user. + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + floatValue: + type: number + format: float + description: Float value. + booleanValue: type: boolean - enumTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' - description: Enum/categorical property. - displayName: - description: The display-name for the property, used for front-end. - type: string - mapTypeOptions: - description: Map property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' - textTypeOptions: - description: Text/string property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' - name: - type: string - description: >- - Required. The name of the metadata property. Must be unique within a - document schema and is case insensitive. Names must be non-blank, - start with a letter, and can contain alphanumeric characters and: /, - :, -, _, and . - timestampTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions description: >- - Timestamp property. It is not supported by CMEK compliant - deployment. - dateTimeTypeOptions: + Boolean value. Can be used for entities with binary values, or for + checkboxes. + dateValue: + $ref: '#/components/schemas/GoogleTypeDate' description: >- - Date time property. It is not supported by CMEK compliant - deployment. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions - isRequired: + Date value. Includes year, month, day. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + integerValue: + type: integer + description: Integer value. + format: int32 + moneyValue: description: >- - Whether the property is mandatory. Default is 'false', i.e. - populating property value can be skipped. If 'true' then user must - populate the value for this property. - type: boolean - integerTypeOptions: - description: Integer property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' - id: GoogleCloudContentwarehouseV1PropertyDefinition - description: Defines the metadata for a schema property. - type: object - GoogleCloudContentwarehouseV1SynonymSet: + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + $ref: '#/components/schemas/GoogleTypeMoney' type: object + description: Parsed and normalized entity value. + GoogleCloudDocumentaiV1Document: description: >- - Represents a list of synonyms for a given context. For example a context - "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: - money, credit, finance, payment Synonym 3: shipping, freight, transport - Each SynonymSets should be disjoint - id: GoogleCloudContentwarehouseV1SynonymSet + Document represents the canonical document resource in Document AI. It + is an interchange format that provides insights into documents and + allows for collaboration between users and Document AI to iterate and + optimize for quality. + id: GoogleCloudDocumentaiV1Document properties: - name: + entityRelations: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + type: array + description: Placeholder. Relationship among Document.entities. + documentLayout: + description: Parsed layout of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' + uri: + type: string description: >- - The resource name of the SynonymSet This is mandatory for - google.api.resource. Format: - projects/{project_number}/locations/{location}/synonymSets/{context}. + Optional. Currently supports Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. + For more information, refer to [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris). + content: + format: byte + description: >- + Optional. Inline document content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary + representation, whereas JSON representations use base64. type: string - synonyms: - description: List of Synonyms for the context. - type: array + textStyles: items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym - context: - description: >- - This is a freeform field. Example contexts can be "sales," - "engineering," "real estate," "accounting," etc. The context can be - supplied during search requests. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + type: array + deprecated: true + description: Styles for the Document.text. + text: + description: Optional. UTF-8 encoded text in reading order from the document. type: string - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: - description: Represents a cell in a table row. - type: object - properties: - rowSpan: - format: int32 - type: integer - description: How many rows this cell spans. - blocks: - description: >- - A table cell is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. + revisions: type: array + description: Placeholder. Revision history of this document. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - colSpan: - description: How many columns this cell spans. - type: integer - format: int32 - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: - properties: - blocks: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + textChanges: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' description: >- - A text block could further have child blocks. Repeated blocks - support further hierarchies and nested blocks. + Placeholder. A list of text corrections made to Document.text. This + is usually used for annotating corrections to OCR mistakes. Text + changes for a given revision may not overlap with each other. type: array - text: - type: string - description: Text content stored in the block. - type: - type: string - description: >- - Type of the text in the block. Available options are: `paragraph`, - `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, - `heading-5`, `header`, `footer`. - description: Represents a text type block. - type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - GoogleCloudContentwarehouseV1RunPipelineMetadata: - id: GoogleCloudContentwarehouseV1RunPipelineMetadata - properties: - processWithDocAiPipelineMetadata: - description: The pipeline metadata for Process-with-DocAi pipeline. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata - individualDocumentStatuses: + pages: items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - type: array - description: The list of response details of each document. - gcsIngestPipelineMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata - description: The pipeline metadata for GcsIngest pipeline. - failedFileCount: - format: int32 - description: Number of files that have failed at some point in the pipeline. - type: integer - userInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: User unique identification and groups information. - totalFileCount: - type: integer - format: int32 - description: Number of files that were processed by the pipeline. - exportToCdwPipelineMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata - description: The pipeline metadata for Export-to-CDW pipeline. - description: Metadata message of RunPipeline method. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + description: Visual page layout for the Document. + type: array + entities: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + type: array + description: >- + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. + chunkedDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' + description: Document chunked based on chunking config. + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + mimeType: + description: >- + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + type: string + shardInfo: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' + description: >- + Information about the sharding if this document is sharded part of a + larger document. If the document is not sharded, this message is not + specified. + type: object + GoogleCloudContentwarehouseV1DateTimeTypeOptions: + id: GoogleCloudContentwarehouseV1DateTimeTypeOptions + properties: {} + description: Configurations for a date time property. type: object parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + alt: + description: Data format for response. in: query - name: upload_protocol + name: alt schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + enum: + - json + - media + - proto + callback: + description: JSONP in: query - name: oauth_token + name: callback schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: fields + name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: uploadType + name: upload_protocol + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string prettyPrint: @@ -5112,20 +5125,16 @@ components: name: prettyPrint schema: type: boolean - alt: - description: Data format for response. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: alt + name: uploadType schema: type: string - enum: - - json - - media - - proto - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string key: @@ -5137,10 +5146,10 @@ components: name: key schema: type: string - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token schema: type: string _.xgafv: @@ -5152,16 +5161,24 @@ components: enum: - '1' - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string x-stackQL-resources: + projects: + id: google.contentwarehouse.projects + name: projects + title: Projects + methods: + set_acl: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}:setAcl/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] acl: id: google.contentwarehouse.acl name: acl @@ -5180,117 +5197,204 @@ components: update: [] replace: [] delete: [] - projects: - id: google.contentwarehouse.projects - name: projects - title: Projects + document_schemas: + id: google.contentwarehouse.document_schemas + name: document_schemas + title: Document_schemas methods: - set_acl: + get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}:setAcl/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get response: mediaType: application/json openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.documentSchemas sqlVerbs: - select: [] - insert: [] - update: [] + select: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/patch' replace: [] - delete: [] - locations: - id: google.contentwarehouse.locations - name: locations - title: Locations + delete: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' + rule_sets: + id: google.contentwarehouse.rule_sets + name: rule_sets + title: Rule_sets methods: - run_pipeline: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:runPipeline/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete response: mediaType: application/json openAPIDocKey: '200' - initialize: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:initialize/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/post response: mediaType: application/json openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ruleSets sqlVerbs: - select: [] - insert: [] - update: [] + select: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/patch' replace: [] - delete: [] - status: - id: google.contentwarehouse.status - name: status - title: Status + delete: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/delete' + operations: + id: google.contentwarehouse.operations + name: operations + title: Operations methods: - get_status: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:getStatus/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/status/methods/get_status' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] replace: [] delete: [] - document_links: - id: google.contentwarehouse.document_links - name: document_links - title: Document_links + synonym_sets: + id: google.contentwarehouse.synonym_sets + name: synonym_sets + title: Synonym_sets methods: create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.synonymSets + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/document_links/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/document_links/methods/delete' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' reference_id: id: google.contentwarehouse.reference_id name: reference_id title: Reference_id methods: - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:get/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:get/post response: mediaType: application/json openAPIDocKey: '200' @@ -5303,25 +5407,33 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/reference_id/methods/delete' - documents_acl: - id: google.contentwarehouse.documents_acl - name: documents_acl - title: Documents_acl + document_links: + id: google.contentwarehouse.document_links + name: document_links + title: Document_links methods: - fetch_acl: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:fetchAcl/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/documents_acl/methods/fetch_acl' - insert: [] + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/document_links/methods/create' update: [] replace: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/document_links/methods/delete' documents: id: google.contentwarehouse.documents name: documents @@ -5334,24 +5446,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - set_acl: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:setAcl/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:search/post response: mediaType: application/json openAPIDocKey: '200' - linked_sources: + set_acl: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedSources/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:setAcl/post response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post response: mediaType: application/json openAPIDocKey: '200' @@ -5362,17 +5474,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - linked_targets: + linked_sources: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedTargets/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedSources/post response: mediaType: application/json openAPIDocKey: '200' - search: + linked_targets: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:search/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedTargets/post response: mediaType: application/json openAPIDocKey: '200' @@ -5383,10 +5495,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post response: mediaType: application/json openAPIDocKey: '200' @@ -5400,207 +5512,93 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/documents/methods/delete' - synonym_sets: - id: google.contentwarehouse.synonym_sets - name: synonym_sets - title: Synonym_sets - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.synonymSets - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/post - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/get' - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' - operations: - id: google.contentwarehouse.operations - name: operations - title: Operations + documents_acl: + id: google.contentwarehouse.documents_acl + name: documents_acl + title: Documents_acl methods: - get: + fetch_acl: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:fetchAcl/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/documents_acl/methods/fetch_acl' insert: [] update: [] replace: [] delete: [] - rule_sets: - id: google.contentwarehouse.rule_sets - name: rule_sets - title: Rule_sets + locations: + id: google.contentwarehouse.locations + name: locations + title: Locations methods: - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.ruleSets - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: + initialize: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:initialize/post response: mediaType: application/json openAPIDocKey: '200' - patch: + run_pipeline: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:runPipeline/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/rule_sets/methods/get' - - $ref: '#/components/x-stackQL-resources/rule_sets/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/rule_sets/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/rule_sets/methods/patch' + select: [] + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/rule_sets/methods/delete' - document_schemas: - id: google.contentwarehouse.document_schemas - name: document_schemas - title: Document_schemas + delete: [] + status: + id: google.contentwarehouse.status + name: status + title: Status methods: - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.documentSchemas - create: + get_status: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:getStatus/get response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/get' - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/patch' + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/status/methods/get_status' + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' + delete: [] paths: - /v1/projects/{projectsId}:fetchAcl: + /v1/projects/{projectsId}:setAcl: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' post: description: >- - Gets the access control policy for a resource. Returns NOT_FOUND error - if the resource does not exist. Returns an empty policy if the resource - exists but does not have a policy set. - operationId: contentwarehouse.projects.fetchAcl + Sets the access control policy for a resource. Replaces any existing + policy. + operationId: contentwarehouse.projects.setAcl requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5613,25 +5611,27 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}:setAcl: + /v1/projects/{projectsId}:fetchAcl: parameters: *ref_1 post: description: >- - Sets the access control policy for a resource. Replaces any existing - policy. - operationId: contentwarehouse.projects.setAcl + Gets the access control policy for a resource. Returns NOT_FOUND error + if the resource does not exist. Returns an empty policy if the resource + exists but does not have a policy set. + operationId: contentwarehouse.projects.fetchAcl requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5644,24 +5644,20 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: parameters: *ref_1 - post: - description: Run a predefined pipeline. - operationId: contentwarehouse.projects.locations.runPipeline - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest + get: + description: >- + Gets a document schema. Returns NOT_FOUND if the document schema does + not exist. + operationId: contentwarehouse.projects.locations.documentSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5673,7 +5669,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -5685,19 +5682,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:initialize: - parameters: *ref_1 - post: + - in: path + name: documentSchemasId + required: true + schema: + type: string + delete: description: >- - Provisions resources for given tenant project. Returns a long running - operation. - operationId: contentwarehouse.projects.locations.initialize - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1InitializeProjectRequest + Deletes a document schema. Returns NOT_FOUND if the document schema does + not exist. Returns BAD_REQUEST if the document schema has documents + depending on it. + operationId: contentwarehouse.projects.locations.documentSchemas.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5709,7 +5704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5721,11 +5716,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:getStatus: - parameters: *ref_1 - get: - description: Get the project status. - operationId: contentwarehouse.projects.locations.getStatus + - in: path + name: documentSchemasId + required: true + schema: + type: string + patch: + description: >- + Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the + Document Schema is non-empty and does not equal the existing name. + Supports only appending new properties, adding new ENUM possible values, + and updating the EnumTypeOptions.validation_check_disabled flag for ENUM + possible values. Updating existing properties will result into + INVALID_ARGUMENT. + operationId: contentwarehouse.projects.locations.documentSchemas.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5738,7 +5748,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -5750,17 +5760,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: + - in: path + name: documentSchemasId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: parameters: *ref_1 post: - description: Create a link between a source document and a target document. - operationId: contentwarehouse.projects.locations.documents.documentLinks.create + description: Creates a document schema. + operationId: contentwarehouse.projects.locations.documentSchemas.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5772,7 +5786,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -5784,22 +5799,9 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete: - parameters: *ref_1 - post: - description: Remove the link between the source and target documents. - operationId: contentwarehouse.projects.locations.documents.documentLinks.delete - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest + get: + description: Lists document schemas. + operationId: contentwarehouse.projects.locations.documentSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5811,7 +5813,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse parameters: - in: path name: projectsId @@ -5823,27 +5826,20 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: documentLinksId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: + /v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}: parameters: *ref_1 - post: - description: Gets a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.get - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest + delete: + description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.ruleSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5855,7 +5851,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5868,21 +5864,13 @@ paths: schema: type: string - in: path - name: referenceIdId + name: ruleSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: - parameters: *ref_1 - post: - description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.delete - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest + get: + description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. + operationId: contentwarehouse.projects.locations.ruleSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5894,7 +5882,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -5907,23 +5895,21 @@ paths: schema: type: string - in: path - name: referenceIdId + name: ruleSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: - parameters: *ref_1 patch: description: >- - Updates a document. Returns INVALID_ARGUMENT if the name of the document + Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.documents.referenceId.patch + operationId: contentwarehouse.projects.locations.ruleSets.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1UpdateRuleSetRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5935,8 +5921,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -5949,24 +5934,46 @@ paths: schema: type: string - in: path - name: referenceIdId + name: ruleSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: + /v1/projects/{projectsId}/locations/{locationsId}/ruleSets: parameters: *ref_1 post: - description: >- - Gets the access control policy for a resource. Returns NOT_FOUND error - if the resource does not exist. Returns an empty policy if the resource - exists but does not have a policy set. - operationId: contentwarehouse.projects.locations.documents.fetchAcl + description: Creates a ruleset. + operationId: contentwarehouse.projects.locations.ruleSets.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + get: + description: Lists rulesets. + operationId: contentwarehouse.projects.locations.ruleSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5979,7 +5986,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1ListRuleSetsResponse parameters: - in: path name: projectsId @@ -5991,22 +5998,23 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Lock the document so the document cannot be updated by other users. - operationId: contentwarehouse.projects.locations.documents.lock - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest + 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. + operationId: contentwarehouse.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6018,7 +6026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6031,22 +6039,22 @@ paths: schema: type: string - in: path - name: documentsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: parameters: *ref_1 post: description: >- - Sets the access control policy for a resource. Replaces any existing - policy. - operationId: contentwarehouse.projects.locations.documents.setAcl + Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS + exception if a synonymset already exists for the context. + operationId: contentwarehouse.projects.locations.synonymSets.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6058,8 +6066,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6071,22 +6078,9 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: - parameters: *ref_1 - post: - description: Return all source document-links from the document. - operationId: contentwarehouse.projects.locations.documents.linkedSources - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + get: + description: Returns all SynonymSets (for all contexts) for the specified location. + operationId: contentwarehouse.projects.locations.synonymSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6099,7 +6093,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse parameters: - in: path name: projectsId @@ -6111,22 +6105,27 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:get: + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: parameters: *ref_1 - post: - description: Gets a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.get + patch: + description: >- + Remove the existing SynonymSet for the context and replaces it with a + new one. Throws a NOT_FOUND exception if the SynonymSet is not found. + operationId: contentwarehouse.projects.locations.synonymSets.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6138,7 +6137,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6151,21 +6150,15 @@ paths: schema: type: string - in: path - name: documentsId + name: synonymSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents: - parameters: *ref_1 - post: - description: Creates a document. - operationId: contentwarehouse.projects.locations.documents.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentRequest + delete: + description: >- + Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception + if the SynonymSet is not found. + operationId: contentwarehouse.projects.locations.synonymSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6177,8 +6170,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6190,17 +6182,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedTargets: - parameters: *ref_1 - post: - description: Return all target document-links from the document. - operationId: contentwarehouse.projects.locations.documents.linkedTargets - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsRequest + - in: path + name: synonymSetsId + required: true + schema: + type: string + get: + description: >- + Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception + if the Synonymset does not exist + operationId: contentwarehouse.projects.locations.synonymSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6212,8 +6203,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6226,23 +6216,21 @@ paths: schema: type: string - in: path - name: documentsId + name: synonymSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents:search: + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: parameters: *ref_1 post: - description: >- - Searches for documents using provided SearchDocumentsRequest. This call - only returns documents that the caller has permission to search against. - operationId: contentwarehouse.projects.locations.documents.search + description: Deletes a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.referenceId.delete requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6254,8 +6242,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6267,13 +6254,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: + - in: path + name: referenceIdId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: parameters: *ref_1 patch: description: >- Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.documents.patch + operationId: contentwarehouse.projects.locations.documents.referenceId.patch requestBody: content: application/json: @@ -6305,21 +6297,21 @@ paths: schema: type: string - in: path - name: documentsId + name: referenceIdId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: parameters: *ref_1 post: - description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.delete + description: Gets a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.referenceId.get requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6331,7 +6323,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -6344,15 +6336,21 @@ paths: schema: type: string - in: path - name: documentsId + name: referenceIdId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: parameters: *ref_1 - get: - description: Returns all SynonymSets (for all contexts) for the specified location. - operationId: contentwarehouse.projects.locations.synonymSets.list + post: + description: Create a link between a source document and a target document. + operationId: contentwarehouse.projects.locations.documents.documentLinks.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6364,8 +6362,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' parameters: - in: path name: projectsId @@ -6377,55 +6374,22 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: documentsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete: + parameters: *ref_1 post: - description: >- - Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS - exception if a synonymset already exists for the context. - operationId: contentwarehouse.projects.locations.synonymSets.create + description: Remove the link between the source and target documents. + operationId: contentwarehouse.projects.locations.documents.documentLinks.delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: - parameters: *ref_1 - delete: - description: >- - Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception - if the SynonymSet is not found. - operationId: contentwarehouse.projects.locations.synonymSets.delete + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6450,15 +6414,26 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: documentsId required: true schema: type: string - get: - description: >- - Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception - if the Synonymset does not exist - operationId: contentwarehouse.projects.locations.synonymSets.get + - in: path + name: documentLinksId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: + parameters: *ref_1 + post: + description: Lock the document so the document cannot be updated by other users. + operationId: contentwarehouse.projects.locations.documents.lock + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6470,7 +6445,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -6483,20 +6458,23 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: documentsId required: true schema: type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/documents:search: + parameters: *ref_1 + post: description: >- - Remove the existing SynonymSet for the context and replaces it with a - new one. Throws a NOT_FOUND exception if the SynonymSet is not found. - operationId: contentwarehouse.projects.locations.synonymSets.patch + Searches for documents using provided SearchDocumentsRequest. This call + only returns documents that the caller has permission to search against. + operationId: contentwarehouse.projects.locations.documents.search requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6508,7 +6486,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse parameters: - in: path name: projectsId @@ -6520,19 +6499,18 @@ paths: required: true schema: type: string - - in: path - name: synonymSetsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: parameters: *ref_1 - get: + post: 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. - operationId: contentwarehouse.projects.locations.operations.get + Sets the access control policy for a resource. Replaces any existing + policy. + operationId: contentwarehouse.projects.locations.documents.setAcl + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6544,7 +6522,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse parameters: - in: path name: projectsId @@ -6557,20 +6536,21 @@ paths: schema: type: string - in: path - name: operationsId + name: documentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/ruleSets: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: parameters: *ref_1 post: - description: Creates a ruleset. - operationId: contentwarehouse.projects.locations.ruleSets.create + description: Deletes a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6582,7 +6562,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6594,9 +6574,25 @@ paths: required: true schema: type: string - get: - description: Lists rulesets. - operationId: contentwarehouse.projects.locations.ruleSets.list + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns NOT_FOUND error + if the resource does not exist. Returns an empty policy if the resource + exists but does not have a policy set. + operationId: contentwarehouse.projects.locations.documents.fetchAcl + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6609,7 +6605,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListRuleSetsResponse + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse parameters: - in: path name: projectsId @@ -6621,20 +6617,22 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: documentsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}: + /v1/projects/{projectsId}/locations/{locationsId}/documents: parameters: *ref_1 - get: - description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.get + post: + description: Creates a document. + operationId: contentwarehouse.projects.locations.documents.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6646,7 +6644,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentResponse parameters: - in: path name: projectsId @@ -6658,14 +6657,17 @@ paths: required: true schema: type: string - - in: path - name: ruleSetsId - required: true - schema: - type: string - delete: - description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.delete + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: + parameters: *ref_1 + post: + description: Return all source document-links from the document. + operationId: contentwarehouse.projects.locations.documents.linkedSources + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6677,7 +6679,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse parameters: - in: path name: projectsId @@ -6690,21 +6693,21 @@ paths: schema: type: string - in: path - name: ruleSetsId + name: documentsId required: true schema: type: string - patch: - description: >- - Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset - is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.ruleSets.patch + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedTargets: + parameters: *ref_1 + post: + description: Return all target document-links from the document. + operationId: contentwarehouse.projects.locations.documents.linkedTargets requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateRuleSetRequest + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6716,7 +6719,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsResponse parameters: - in: path name: projectsId @@ -6729,27 +6733,23 @@ paths: schema: type: string - in: path - name: ruleSetsId + name: documentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: parameters: *ref_1 patch: description: >- - Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the - Document Schema is non-empty and does not equal the existing name. - Supports only appending new properties, adding new ENUM possible values, - and updating the EnumTypeOptions.validation_check_disabled flag for ENUM - possible values. Updating existing properties will result into - INVALID_ARGUMENT. - operationId: contentwarehouse.projects.locations.documentSchemas.patch + Updates a document. Returns INVALID_ARGUMENT if the name of the document + is non-empty and does not equal the existing name. + operationId: contentwarehouse.projects.locations.documents.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6762,7 +6762,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse parameters: - in: path name: projectsId @@ -6775,15 +6775,21 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: documentsId required: true schema: type: string - get: - description: >- - Gets a document schema. Returns NOT_FOUND if the document schema does - not exist. - operationId: contentwarehouse.projects.locations.documentSchemas.get + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:get: + parameters: *ref_1 + post: + description: Gets a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.get + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6795,8 +6801,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -6809,16 +6814,23 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: documentsId required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}:initialize: + parameters: *ref_1 + post: description: >- - Deletes a document schema. Returns NOT_FOUND if the document schema does - not exist. Returns BAD_REQUEST if the document schema has documents - depending on it. - operationId: contentwarehouse.projects.locations.documentSchemas.delete + Provisions resources for given tenant project. Returns a long running + operation. + operationId: contentwarehouse.projects.locations.initialize + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1InitializeProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6830,7 +6842,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6842,16 +6854,11 @@ paths: required: true schema: type: string - - in: path - name: documentSchemasId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: + /v1/projects/{projectsId}/locations/{locationsId}:getStatus: parameters: *ref_1 get: - description: Lists document schemas. - operationId: contentwarehouse.projects.locations.documentSchemas.list + description: Get the project status. + operationId: contentwarehouse.projects.locations.getStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6864,7 +6871,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus parameters: - in: path name: projectsId @@ -6876,23 +6883,17 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: + parameters: *ref_1 post: - description: Creates a document schema. - operationId: contentwarehouse.projects.locations.documentSchemas.create + description: Run a predefined pipeline. + operationId: contentwarehouse.projects.locations.runPipeline requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6904,8 +6905,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId diff --git a/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml b/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml index dc41ad7c..9b1f8894 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml @@ -10,7 +10,7 @@ info: service. version: v1 x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/data-catalog/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml index ceef8345..ab6940f5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml @@ -8,7 +8,7 @@ info: description: Manages Google Cloud Dataflow projects on Google Cloud Platform. version: v1b3 x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dataflow servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml index 1460ed49..dd84759e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml @@ -10,7 +10,7 @@ info: BigQuery. version: v1beta1 x-discovery-doc-revision: '20240824' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dataform/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml b/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml index fdb08ddd..132dd139 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml @@ -15,7 +15,7 @@ info: infrastructure. version: v1 x-discovery-doc-revision: '20240703' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/data-fusion/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml b/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml index 201346a0..f64f989a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml @@ -8,7 +8,7 @@ info: description: Public API for Google Cloud AI Data Labeling Service. version: v1beta1 x-discovery-doc-revision: '20240807' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/data-labeling/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml index a4b6f27f..1f27b878 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml @@ -7,8 +7,8 @@ info: title: Data Lineage API description: '' version: v1 - x-discovery-doc-revision: '20240902' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/data-catalog servers: @@ -34,121 +34,118 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDatacatalogLineageV1EntityReference: - description: The soft reference to everything you can attach a lineage event to. - properties: - fullyQualifiedName: - description: >- - Required. [Fully Qualified Name - (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) - of the entity. - type: string - id: GoogleCloudDatacatalogLineageV1EntityReference - type: object - GoogleCloudDatacatalogLineageV1SearchLinksRequest: + GoogleCloudDatacatalogLineageV1OperationMetadata: + id: GoogleCloudDatacatalogLineageV1OperationMetadata type: object properties: - pageSize: - type: integer - description: >- - Optional. The maximum number of links to return in a single page of - the response. A page may contain fewer links than this value. If - unspecified, at most 10 links are returned. Maximum value is 100; - values greater than 100 are reduced to 100. - format: int32 - target: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: >- - Optional. Send asset information in the **target** field to retrieve - all links that lead from upstream assets to the specified asset. - pageToken: + operationType: + description: Output only. The type of the operation being performed. type: string - description: >- - Optional. The page token received from a previous - `SearchLinksRequest` call. Use it to get the next page. When - requesting subsequent pages of a response, remember that all - parameters must match the values you provided in the original - request. - source: - description: >- - Optional. Send asset information in the **source** field to retrieve - all links that lead from the specified asset to downstream assets. - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - id: GoogleCloudDatacatalogLineageV1SearchLinksRequest - description: Request message for SearchLinks. - GoogleCloudDatacatalogLineageV1Link: - properties: - name: + enum: + - TYPE_UNSPECIFIED + - DELETE + - CREATE + readOnly: true + enumDescriptions: + - Unused. + - The resource deletion operation. + - The resource creation operation. + state: + readOnly: true + type: string + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + description: Output only. The current operation state. + enumDescriptions: + - Unused. + - The operation has been created but is not yet started. + - The operation is underway. + - The operation completed successfully. + - The operation is no longer running and did not succeed. + createTime: type: string description: >- - Output only. Immutable. The name of the link. Format: - `projects/{project}/locations/{location}/links/{link}`. + Output only. The timestamp of the operation submission to the + server. readOnly: true - source: - description: The pointer to the entity that is the **source** of this link. - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - endTime: - type: string format: google-datetime - description: The end of the last event establishing this link. - target: - description: The pointer to the entity that is the **target** of this link. - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - startTime: - description: The start of the first event establishing this link. + resourceUuid: + readOnly: true + type: string + description: Output only. The UUID of the resource being operated on. + resource: + readOnly: true + description: >- + Output only. The [relative name] + (https://cloud.google.com//apis/design/resource_names#relative_resource_name) + of the resource being operated on. + type: string + endTime: format: google-datetime type: string + readOnly: true + description: >- + Output only. The timestamp of the operation termination, regardless + of its success. This field is unset if the operation is still + ongoing. + description: Metadata describing the operation. + GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: type: object - description: >- - Links represent the data flow between **source** (upstream) and - **target** (downstream) assets in transformation pipelines. Links are - created when LineageEvents record data transformation between related - assets. - id: GoogleCloudDatacatalogLineageV1Link - GoogleCloudDatacatalogLineageV1ProcessLinks: - type: object + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + description: Response message for BatchSearchLinkProcesses. properties: - links: - type: array - description: >- - An array containing link details objects of the links provided in - the original request. A single process can result in creating - multiple links. If any of the links you provide in the request are - created by the same process, they all are included in this array. - items: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo - process: - description: >- - The process name in the format of - `projects/{project}/locations/{location}/processes/{process}`. + nextPageToken: type: string - description: Links associated with a specific process. - id: GoogleCloudDatacatalogLineageV1ProcessLinks - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - properties: - operations: - type: array description: >- - A list of operations that matches the specified filter in the - request. + The token to specify as `page_token` in the subsequent call to get + the next page. Omitted if there are no more pages in the response. + processLinks: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' + type: array + description: An array of processes associated with the specified links. + GoogleCloudDatacatalogLineageV1SearchLinksResponse: + description: Response message for SearchLinks. + id: GoogleCloudDatacatalogLineageV1SearchLinksResponse + properties: nextPageToken: + description: >- + The token to specify as `page_token` in the subsequent call to get + the next page. Omitted if there are no more pages in the response. type: string - description: The standard List next-page token. + links: + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Link' + description: >- + The list of links for a given asset. Can be empty if the asset has + no relations of requested type (source or target). + type: array type: object GoogleCloudDatacatalogLineageV1Origin: id: GoogleCloudDatacatalogLineageV1Origin + type: object + description: Origin of a process. properties: + name: + type: string + description: >- + If the source_type isn't CUSTOM, the value of this field should be a + GCP resource name of the system, which reports lineage. The project + and location parts of the resource name must match the project and + location of the lineage resource being created. Examples: - + `{source_type: COMPOSER, name: + "projects/foo/locations/us/environments/bar"}` - `{source_type: + BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: + CUSTOM, name: "myCustomIntegration"}` sourceType: description: >- Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice. - type: string enum: - SOURCE_TYPE_UNSPECIFIED - CUSTOM @@ -158,6 +155,7 @@ components: - LOOKER_STUDIO - DATAPROC - VERTEX_AI + type: string enumDescriptions: - Source is Unspecified - A custom source @@ -167,72 +165,22 @@ components: - Looker Studio - Dataproc - Vertex AI - name: - description: >- - If the source_type isn't CUSTOM, the value of this field should be a - GCP resource name of the system, which reports lineage. The project - and location parts of the resource name must match the project and - location of the lineage resource being created. Examples: - - `{source_type: COMPOSER, name: - "projects/foo/locations/us/environments/bar"}` - `{source_type: - BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: - CUSTOM, name: "myCustomIntegration"}` - type: string - type: object - description: Origin of a process. - GoogleLongrunningOperation: - type: object + GoogleCloudDatacatalogLineageV1ListLineageEventsResponse: properties: - metadata: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - name: + nextPageToken: type: string description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation - GoogleRpcStatus: + The token to specify as `page_token` in the next call to get the + next page. If this field is omitted, there are no subsequent pages. + lineageEvents: + description: Lineage events from the specified project and location. + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' + type: array type: object - id: GoogleRpcStatus + id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse + description: Response message for ListLineageEvents. + GoogleRpcStatus: description: >- The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It @@ -241,28 +189,65 @@ components: details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus + type: object properties: message: + type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - type: string + code: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + type: integer details: - type: array items: type: object additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + type: array description: >- A list of messages that carry the error details. There is a common set of message types for APIs to use. - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. + GoogleCloudDatacatalogLineageV1ProcessLinkInfo: + id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo + properties: + link: + type: string + description: >- + The name of the link in the format of + `projects/{project}/locations/{location}/links/{link}`. + endTime: + description: The end of the last event establishing this link-process tuple. + format: google-datetime + type: string + startTime: + format: google-datetime + type: string + description: The start of the first event establishing this link-process tuple. + description: Link details. + type: object + GoogleLongrunningListOperationsResponse: + type: object + description: The response message for Operations.ListOperations. + id: GoogleLongrunningListOperationsResponse + properties: + nextPageToken: + description: The standard List next-page token. + type: string + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest: + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + type: object properties: pageToken: description: >- @@ -273,13 +258,11 @@ components: type: string pageSize: type: integer - format: int32 description: >- The maximum number of processes to return in a single page of the response. A page may contain fewer results than this value. + format: int32 links: - items: - type: string description: >- Required. An array of links to check for their associated LineageProcesses. The maximum number of items in this array is 100. @@ -287,158 +270,183 @@ components: `INVALID_ARGUMENT` error. Format: `projects/{project}/locations/{location}/links/{link}`. type: array + items: + type: string description: Request message for BatchSearchLinkProcesses. - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest - type: object - GoogleProtobufEmpty: + GoogleLongrunningOperation: type: object + properties: + done: + type: boolean + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error result of the operation in case of failure or + cancellation. 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: GoogleProtobufEmpty - properties: {} + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation + GoogleCloudDatacatalogLineageV1EntityReference: + properties: + fullyQualifiedName: + description: >- + Required. [Fully Qualified Name + (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) + of the entity. + type: string + description: The soft reference to everything you can attach a lineage event to. + type: object + id: GoogleCloudDatacatalogLineageV1EntityReference GoogleCloudDatacatalogLineageV1LineageEvent: + type: object description: >- A lineage event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field. properties: + endTime: + description: >- + Optional. The end of the transformation which resulted in this + lineage event. For streaming scenarios, it should be the end of the + period from which the lineage is being reported. + type: string + format: google-datetime startTime: format: google-datetime + type: string description: >- Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported. - type: string - links: - description: >- - Optional. List of source-target pairs. Can't contain more than 100 - tuples. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' name: - type: string description: >- Immutable. The resource name of the lineage event. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` - endTime: - format: google-datetime - description: >- - Optional. The end of the transformation which resulted in this - lineage event. For streaming scenarios, it should be the end of the - period from which the lineage is being reported. type: string + links: + description: >- + Optional. List of source-target pairs. Can't contain more than 100 + tuples. + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' + type: array id: GoogleCloudDatacatalogLineageV1LineageEvent - type: object - GoogleCloudDatacatalogLineageV1EventLink: - description: A lineage between source and target entities. - id: GoogleCloudDatacatalogLineageV1EventLink - type: object + GoogleCloudDatacatalogLineageV1Link: + description: >- + Links represent the data flow between **source** (upstream) and + **target** (downstream) assets in transformation pipelines. Links are + created when LineageEvents record data transformation between related + assets. properties: - source: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: Required. Reference to the source entity target: - description: Required. Reference to the target entity $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - GoogleLongrunningCancelOperationRequest: - type: object - description: The request message for Operations.CancelOperation. - properties: {} - id: GoogleLongrunningCancelOperationRequest - GoogleCloudDatacatalogLineageV1ListRunsResponse: - description: Response message for ListRuns. - properties: - nextPageToken: - description: >- - The token to specify as `page_token` in the next call to get the - next page. If this field is omitted, there are no subsequent pages. + description: The pointer to the entity that is the **target** of this link. + source: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + description: The pointer to the entity that is the **source** of this link. + startTime: + description: The start of the first event establishing this link. type: string - runs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' - description: The runs from the specified project and location. - id: GoogleCloudDatacatalogLineageV1ListRunsResponse - type: object - GoogleCloudDatacatalogLineageV1ListProcessesResponse: - properties: - processes: - description: The processes from the specified project and location. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - nextPageToken: + format: google-datetime + name: + type: string + readOnly: true description: >- - The token to specify as `page_token` in the next call to get the - next page. If this field is omitted, there are no subsequent pages. + Output only. Immutable. The name of the link. Format: + `projects/{project}/locations/{location}/links/{link}`. + endTime: type: string - description: Response message for ListProcesses. - id: GoogleCloudDatacatalogLineageV1ListProcessesResponse + format: google-datetime + description: The end of the last event establishing this link. + id: GoogleCloudDatacatalogLineageV1Link type: object GoogleCloudDatacatalogLineageV1Process: + description: A process is the definition of a data transformation operation. + type: object properties: + origin: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Origin' + description: >- + Optional. The origin of this process and its runs and lineage + events. name: - type: string description: >- Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` - displayName: - description: >- - Optional. A human-readable name you can set to display in a user - interface. Must be not longer than 200 characters and only contain - UTF-8 letters or numbers, spaces or characters like `_-:&.` type: string - origin: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Origin' - description: >- - Optional. The origin of this process and its runs and lineage - events. attributes: + additionalProperties: + type: any description: >- Optional. The attributes of the process. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the process). Up to 100 attributes are allowed. type: object - additionalProperties: - type: any - description: A process is the definition of a data transformation operation. - type: object - id: GoogleCloudDatacatalogLineageV1Process - GoogleCloudDatacatalogLineageV1ProcessLinkInfo: - id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo - description: Link details. - properties: - startTime: - type: string - format: google-datetime - description: The start of the first event establishing this link-process tuple. - link: + displayName: type: string description: >- - The name of the link in the format of - `projects/{project}/locations/{location}/links/{link}`. - endTime: - type: string - description: The end of the last event establishing this link-process tuple. - format: google-datetime + Optional. A human-readable name you can set to display in a user + interface. Must be not longer than 200 characters and only contain + UTF-8 letters or numbers, spaces or characters like `_-:&.` + id: GoogleCloudDatacatalogLineageV1Process + GoogleLongrunningCancelOperationRequest: type: object + id: GoogleLongrunningCancelOperationRequest + properties: {} + description: The request message for Operations.CancelOperation. GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: - id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse - type: object properties: + run: + description: >- + Created run name. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. + type: string process: + type: string description: >- Created process name. Format: `projects/{project}/locations/{location}/processes/{process}`. - type: string lineageEvents: items: type: string @@ -446,32 +454,52 @@ components: description: >- Created lineage event names. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. - run: + type: object + id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + description: Response message for ProcessOpenLineageRunEvent. + GoogleCloudDatacatalogLineageV1ListRunsResponse: + description: Response message for ListRuns. + type: object + properties: + nextPageToken: type: string description: >- - Created run name. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. - description: Response message for ProcessOpenLineageRunEvent. - GoogleCloudDatacatalogLineageV1ListLineageEventsResponse: + The token to specify as `page_token` in the next call to get the + next page. If this field is omitted, there are no subsequent pages. + runs: + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + description: The runs from the specified project and location. + type: array + id: GoogleCloudDatacatalogLineageV1ListRunsResponse + GoogleCloudDatacatalogLineageV1EventLink: + properties: + target: + description: Required. Reference to the target entity + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + source: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + description: Required. Reference to the source entity type: object - id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse + description: A lineage between source and target entities. + id: GoogleCloudDatacatalogLineageV1EventLink + GoogleCloudDatacatalogLineageV1ListProcessesResponse: + description: Response message for ListProcesses. + type: object + id: GoogleCloudDatacatalogLineageV1ListProcessesResponse properties: - lineageEvents: + processes: type: array - description: Lineage events from the specified project and location. items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + description: The processes from the specified project and location. nextPageToken: - type: string description: >- The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages. - description: Response message for ListLineageEvents. + type: string GoogleCloudDatacatalogLineageV1Run: id: GoogleCloudDatacatalogLineageV1Run - description: >- - A lineage run represents an execution of a process that creates lineage - events. properties: attributes: additionalProperties: @@ -481,14 +509,6 @@ components: purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed. type: object - startTime: - type: string - description: Required. The timestamp of the start of the run. - format: google-datetime - endTime: - type: string - description: Optional. The timestamp of the end of the run. - format: google-datetime name: type: string description: >- @@ -496,14 +516,25 @@ components: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` + displayName: + type: string + description: >- + Optional. A human-readable name you can set to display in a user + interface. Must be not longer than 1024 characters and only contain + UTF-8 letters or numbers, spaces or characters like `_-:&.` + endTime: + type: string + format: google-datetime + description: Optional. The timestamp of the end of the run. state: - description: Required. The state of the run. enum: - UNKNOWN - STARTED - COMPLETED - FAILED - ABORTED + description: Required. The state of the run. + type: string enumDescriptions: - >- The state is unknown. The true state may be any of the below or a @@ -512,116 +543,88 @@ components: - The run completed. - The run failed. - The run aborted. + startTime: type: string - displayName: - type: string - description: >- - Optional. A human-readable name you can set to display in a user - interface. Must be not longer than 1024 characters and only contain - UTF-8 letters or numbers, spaces or characters like `_-:&.` + description: Required. The timestamp of the start of the run. + format: google-datetime type: object - GoogleCloudDatacatalogLineageV1OperationMetadata: - description: Metadata describing the operation. + description: >- + A lineage run represents an execution of a process that creates lineage + events. + GoogleCloudDatacatalogLineageV1SearchLinksRequest: + type: object + description: Request message for SearchLinks. + id: GoogleCloudDatacatalogLineageV1SearchLinksRequest properties: - endTime: - readOnly: true + target: description: >- - Output only. The timestamp of the operation termination, regardless - of its success. This field is unset if the operation is still - ongoing. - format: google-datetime - type: string - resource: + Optional. Send asset information in the **target** field to retrieve + all links that lead from upstream assets to the specified asset. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + pageSize: + type: integer description: >- - Output only. The [relative name] - (https://cloud.google.com//apis/design/resource_names#relative_resource_name) - of the resource being operated on. - readOnly: true - type: string - operationType: - description: Output only. The type of the operation being performed. - type: string - enumDescriptions: - - Unused. - - The resource deletion operation. - - The resource creation operation. - readOnly: true - enum: - - TYPE_UNSPECIFIED - - DELETE - - CREATE - createTime: - type: string - readOnly: true + Optional. The maximum number of links to return in a single page of + the response. A page may contain fewer links than this value. If + unspecified, at most 10 links are returned. Maximum value is 100; + values greater than 100 are reduced to 100. + format: int32 + pageToken: description: >- - Output only. The timestamp of the operation submission to the - server. - format: google-datetime - resourceUuid: - readOnly: true - description: Output only. The UUID of the resource being operated on. - type: string - state: - description: Output only. The current operation state. - enumDescriptions: - - Unused. - - The operation has been created but is not yet started. - - The operation is underway. - - The operation completed successfully. - - The operation is no longer running and did not succeed. + Optional. The page token received from a previous + `SearchLinksRequest` call. Use it to get the next page. When + requesting subsequent pages of a response, remember that all + parameters must match the values you provided in the original + request. type: string - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - readOnly: true - type: object - id: GoogleCloudDatacatalogLineageV1OperationMetadata - GoogleCloudDatacatalogLineageV1SearchLinksResponse: + source: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + description: >- + Optional. Send asset information in the **source** field to retrieve + all links that lead from the specified asset to downstream assets. + GoogleProtobufEmpty: + id: GoogleProtobufEmpty type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + properties: {} + GoogleCloudDatacatalogLineageV1ProcessLinks: properties: links: description: >- - The list of links for a given asset. Can be empty if the asset has - no relations of requested type (source or target). - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Link' - type: array - nextPageToken: - type: string - description: >- - The token to specify as `page_token` in the subsequent call to get - the next page. Omitted if there are no more pages in the response. - id: GoogleCloudDatacatalogLineageV1SearchLinksResponse - description: Response message for SearchLinks. - GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: - description: Response message for BatchSearchLinkProcesses. - properties: - processLinks: + An array containing link details objects of the links provided in + the original request. A single process can result in creating + multiple links. If any of the links you provide in the request are + created by the same process, they all are included in this array. items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo type: array - description: An array of processes associated with the specified links. - nextPageToken: + process: type: string description: >- - The token to specify as `page_token` in the subsequent call to get - the next page. Omitted if there are no more pages in the response. - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + The process name in the format of + `projects/{project}/locations/{location}/processes/{process}`. + id: GoogleCloudDatacatalogLineageV1ProcessLinks type: object + description: Links associated with a specific process. parameters: - oauth_token: - description: OAuth 2.0 token for the current user. + _.xgafv: + description: V1 error format. in: query - name: oauth_token + name: $.xgafv schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + name: oauth_token schema: type: string alt: @@ -634,6 +637,18 @@ components: - json - media - proto + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query @@ -646,42 +661,21 @@ components: name: access_token schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string callback: description: JSONP in: query name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - _.xgafv: - description: V1 error format. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -691,39 +685,13 @@ components: name: key schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean x-stackQL-resources: - locations: - id: google.datalineage.locations - name: locations - title: Locations - methods: - batch_search_link_processes: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post - response: - mediaType: application/json - openAPIDocKey: '200' - process_open_lineage_run_event: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post - response: - mediaType: application/json - openAPIDocKey: '200' - search_links: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchLinks/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] processes: id: google.datalineage.processes name: processes @@ -750,21 +718,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processes - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.processes sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/processes/methods/get' @@ -776,114 +744,107 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/processes/methods/delete' - runs: - id: google.datalineage.runs - name: runs - title: Runs + lineage_events: + id: google.datalineage.lineage_events + name: lineage_events + title: Lineage_events methods: delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents~1{lineageEventsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents~1{lineageEventsId}/get response: mediaType: application/json openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runs + objectKey: $.lineageEvents sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/runs/methods/get' - - $ref: '#/components/x-stackQL-resources/runs/methods/list' + - $ref: '#/components/x-stackQL-resources/lineage_events/methods/get' + - $ref: '#/components/x-stackQL-resources/lineage_events/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/runs/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/runs/methods/patch' + - $ref: '#/components/x-stackQL-resources/lineage_events/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/runs/methods/delete' - lineage_events: - id: google.datalineage.lineage_events - name: lineage_events - title: Lineage_events + - $ref: '#/components/x-stackQL-resources/lineage_events/methods/delete' + runs: + id: google.datalineage.runs + name: runs + title: Runs methods: + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents~1{lineageEventsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents~1{lineageEventsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.runs + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.lineageEvents sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/lineage_events/methods/get' - - $ref: '#/components/x-stackQL-resources/lineage_events/methods/list' + - $ref: '#/components/x-stackQL-resources/runs/methods/get' + - $ref: '#/components/x-stackQL-resources/runs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/lineage_events/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/runs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/runs/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/lineage_events/methods/delete' + - $ref: '#/components/x-stackQL-resources/runs/methods/delete' operations: id: google.datalineage.operations name: operations title: Operations methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' delete: operation: $ref: >- @@ -891,10 +852,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - cancel: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -906,6 +867,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -915,38 +883,60 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + locations: + id: google.datalineage.locations + name: locations + title: Locations + methods: + batch_search_link_processes: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post + response: + mediaType: application/json + openAPIDocKey: '200' + process_open_lineage_run_event: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post + response: + mediaType: application/json + openAPIDocKey: '200' + search_links: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchLinks/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: parameters: &ref_1 - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - post: - description: >- - Retrieve information about LineageProcesses associated with specific - links. LineageProcesses are transformation pipelines that result in data - flowing from **source** to **target** assets. Links between assets - represent this operation. If you have specific link names, you can use - this method to verify which LineageProcesses contribute to creating - those links. See the SearchLinks method for more information on how to - retrieve link name. You can retrieve the LineageProcess information in - every project where you have the `datalineage.events.get` permission. - The project provided in the URL is used for Billing and Quota. - operationId: datalineage.projects.locations.batchSearchLinkProcesses + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/prettyPrint' + patch: + description: Updates a process. + operationId: datalineage.projects.locations.processes.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -958,8 +948,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -971,94 +960,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: - parameters: *ref_1 - post: - description: >- - Creates new lineage events together with their parents: process and run. - Updates the process and run if they already exist. Mapped from Open - Lineage specification: - https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json. - operationId: datalineage.projects.locations.processOpenLineageRunEvent - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: processesId required: true schema: type: string - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}:searchLinks: - parameters: *ref_1 - post: - description: >- - Retrieve a list of links connected to a specific asset. Links represent - the data flow between **source** (upstream) and **target** (downstream) - assets in transformation pipelines. Links are stored in the same project - as the Lineage Events that create them. You can retrieve links in every - project where you have the `datalineage.events.get` permission. The - project provided in the URL is used for Billing and Quota. - operationId: datalineage.projects.locations.searchLinks - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1SearchLinksRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1SearchLinksResponse - parameters: - - in: path - name: projectsId - required: true + name: allowMissing schema: - type: string - - in: path - name: locationsId - required: true + type: boolean + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: - parameters: *ref_1 - patch: - description: Updates a process. - operationId: datalineage.projects.locations.processes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + format: google-fieldmask + delete: + description: Deletes the process with the specified name. + operationId: datalineage.projects.locations.processes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1070,7 +988,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1091,14 +1009,9 @@ paths: name: allowMissing schema: type: boolean - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes the process with the specified name. - operationId: datalineage.projects.locations.processes.delete + get: + description: Gets the details of the specified process. + operationId: datalineage.projects.locations.processes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1110,7 +1023,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1127,13 +1040,16 @@ paths: required: true schema: type: string - - in: query - name: allowMissing - schema: - type: boolean - get: - description: Gets the details of the specified process. - operationId: datalineage.projects.locations.processes.get + /v1/projects/{projectsId}/locations/{locationsId}/processes: + parameters: *ref_1 + post: + description: Creates a new process. + operationId: datalineage.projects.locations.processes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1157,13 +1073,10 @@ paths: required: true schema: type: string - - in: path - name: processesId - required: true + - in: query + name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes: - parameters: *ref_1 get: description: >- List processes in the given project and location. List order is @@ -1202,14 +1115,11 @@ paths: name: pageToken schema: type: string - post: - description: Creates a new process. - operationId: datalineage.projects.locations.processes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}: + parameters: *ref_1 + delete: + description: Deletes the lineage event with the specified name. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1221,7 +1131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1233,15 +1143,28 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: processesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}: - parameters: *ref_1 - delete: - description: Deletes the run with the specified name. - operationId: datalineage.projects.locations.processes.runs.delete + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: lineageEventsId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + get: + description: Gets details of a specified lineage event. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1253,7 +1176,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent parameters: - in: path name: projectsId @@ -1275,13 +1199,21 @@ paths: required: true schema: type: string - - in: query - name: allowMissing + - in: path + name: lineageEventsId + required: true schema: - type: boolean - get: - description: Gets the details of the specified run. - operationId: datalineage.projects.locations.processes.runs.get + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents: + parameters: *ref_1 + post: + description: Creates a new lineage event. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1293,7 +1225,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent parameters: - in: path name: projectsId @@ -1315,14 +1248,15 @@ paths: required: true schema: type: string - patch: - description: Updates a run. - operationId: datalineage.projects.locations.processes.runs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + - in: query + name: requestId + schema: + type: string + get: + description: >- + Lists lineage events in the given project and location. The list order + is not defined. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1334,7 +1268,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ListLineageEventsResponse parameters: - in: path name: projectsId @@ -1357,19 +1292,19 @@ paths: schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - in: query - name: allowMissing + name: pageSize schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}: parameters: *ref_1 - post: - description: Creates a new run. - operationId: datalineage.projects.locations.processes.runs.create + patch: + description: Updates a run. + operationId: datalineage.projects.locations.processes.runs.patch requestBody: content: application/json: @@ -1399,19 +1334,27 @@ paths: schema: type: string - in: path - name: processesId + name: processesId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string - in: query - name: requestId + name: updateMask schema: type: string + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean get: - description: >- - Lists runs in the given project and location. List order is descending - by `start_time`. - operationId: datalineage.projects.locations.processes.runs.list + description: Gets the details of the specified run. + operationId: datalineage.projects.locations.processes.runs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1423,8 +1366,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListRunsResponse + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' parameters: - in: path name: projectsId @@ -1441,20 +1383,14 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: runsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}: - parameters: *ref_1 - get: - description: Gets details of a specified lineage event. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.get + delete: + description: Deletes the run with the specified name. + operationId: datalineage.projects.locations.processes.runs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1466,8 +1402,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1489,14 +1424,17 @@ paths: required: true schema: type: string - - in: path - name: lineageEventsId - required: true + - in: query + name: allowMissing schema: - type: string - delete: - description: Deletes the lineage event with the specified name. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.delete + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs: + parameters: *ref_1 + get: + description: >- + Lists runs in the given project and location. List order is descending + by `start_time`. + operationId: datalineage.projects.locations.processes.runs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1508,7 +1446,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ListRunsResponse parameters: - in: path name: projectsId @@ -1525,30 +1464,23 @@ paths: required: true schema: type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: lineageEventsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: allowMissing + name: pageSize schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents: - parameters: *ref_1 + type: integer + format: int32 post: - description: Creates a new lineage event. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.create + description: Creates a new run. + operationId: datalineage.projects.locations.processes.runs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1560,8 +1492,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' parameters: - in: path name: projectsId @@ -1578,20 +1509,19 @@ paths: required: true schema: type: string - - in: path - name: runsId - required: true - schema: - type: string - in: query name: requestId schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + delete: description: >- - Lists lineage events in the given project and location. The list order - is not defined. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.list + 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`. + operationId: datalineage.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1603,8 +1533,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListLineageEventsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1617,26 +1546,10 @@ paths: schema: type: string - in: path - name: processesId - required: true - schema: - type: string - - in: path - name: runsId + name: operationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1671,13 +1584,13 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: 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`. - operationId: datalineage.projects.locations.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: datalineage.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1689,7 +1602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -1701,9 +1614,17 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: @@ -1753,13 +1674,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: datalineage.projects.locations.operations.list + Retrieve information about LineageProcesses associated with specific + links. LineageProcesses are transformation pipelines that result in data + flowing from **source** to **target** assets. Links between assets + represent this operation. If you have specific link names, you can use + this method to verify which LineageProcesses contribute to creating + those links. See the SearchLinks method for more information on how to + retrieve link name. You can retrieve the LineageProcess information in + every project where you have the `datalineage.events.get` permission. + The project provided in the URL is used for Billing and Quota. + operationId: datalineage.projects.locations.batchSearchLinkProcesses + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1771,7 +1705,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse parameters: - in: path name: projectsId @@ -1783,16 +1718,81 @@ paths: required: true schema: type: string - - in: query - name: pageToken + /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: + parameters: *ref_1 + post: + description: >- + Creates new lineage events together with their parents: process and run. + Updates the process and run if they already exist. Mapped from Open + Lineage specification: + https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json. + operationId: datalineage.projects.locations.processOpenLineageRunEvent + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: locationsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: filter + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:searchLinks: + parameters: *ref_1 + post: + description: >- + Retrieve a list of links connected to a specific asset. Links represent + the data flow between **source** (upstream) and **target** (downstream) + assets in transformation pipelines. Links are stored in the same project + as the Lineage Events that create them. You can retrieve links in every + project where you have the `datalineage.events.get` permission. The + project provided in the URL is used for Billing and Quota. + operationId: datalineage.projects.locations.searchLinks + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1SearchLinksRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1SearchLinksResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml b/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml index c6a24857..b8eef016 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml @@ -8,7 +8,7 @@ info: description: Manage Cloud Database Migration Service resources on Google Cloud Platform. version: v1 x-discovery-doc-revision: '20240907' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/database-migration/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml b/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml index e6f8227f..515f8bf7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml @@ -10,7 +10,7 @@ info: recurring Data Analytics jobs. version: v1 x-discovery-doc-revision: '20240901' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dataflow/docs/guides/data-pipelines servers: @@ -36,378 +36,48 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: - type: object - id: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment - properties: - kmsKeyName: - type: string - description: >- - Name for the Cloud KMS key for the job. Key format is: - projects//locations//keyRings//cryptoKeys/ - network: - description: >- - Network to which VMs will be assigned. If empty or unspecified, the - service will use the network "default". - type: string - machineType: - description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. - type: string - ipConfiguration: - enumDescriptions: - - The configuration is unknown, or unspecified. - - Workers should have public IP addresses. - - Workers should have private IP addresses. - enum: - - WORKER_IP_UNSPECIFIED - - WORKER_IP_PUBLIC - - WORKER_IP_PRIVATE - type: string - description: Configuration for VM IPs. - subnetwork: - type: string - description: >- - Subnetwork to which VMs will be assigned, if desired. You can - specify a subnetwork using either a complete URL or an abbreviated - path. Expected to be of the form - "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" - or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is - located in a Shared VPC network, you must use the complete URL. - tempLocation: - type: string - description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. - numWorkers: - format: int32 - type: integer - description: The initial number of Compute Engine instances for the job. - workerZone: - type: string - description: >- - The Compute Engine zone - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1-a". Mutually - exclusive with worker_region. If neither worker_region nor - worker_zone is specified, a zone in the control plane region is - chosen based on available capacity. If both `worker_zone` and `zone` - are set, `worker_zone` takes precedence. - additionalUserLabels: - description: >- - Additional user labels to be specified for the job. Keys and values - must follow the restrictions specified in the [labeling - restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). - An object containing a list of key/value pairs. Example: `{ "name": - "wrench", "mass": "1kg", "count": "3" }`. - type: object - additionalProperties: - type: string - flexrsGoal: - type: string - enumDescriptions: - - Run in the default mode. - - Optimize for lower execution time. - - Optimize for lower cost. - enum: - - FLEXRS_UNSPECIFIED - - FLEXRS_SPEED_OPTIMIZED - - FLEXRS_COST_OPTIMIZED - description: >- - Set FlexRS goal for the job. - https://cloud.google.com/dataflow/docs/guides/flexrs - additionalExperiments: - items: - type: string - type: array - description: Additional experiment flags for the job. - serviceAccountEmail: - type: string - description: The email address of the service account to run the job as. - maxWorkers: - format: int32 - type: integer - description: >- - The maximum number of Compute Engine instances to be made available - to your pipeline during execution, from 1 to 1000. - workerRegion: - type: string - description: >- - The Compute Engine region - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1". Mutually - exclusive with worker_zone. If neither worker_region nor worker_zone - is specified, defaults to the control plane region. - enableStreamingEngine: - type: boolean - description: Whether to enable Streaming Engine for the job. - zone: - description: >- - The Compute Engine [availability - zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - for launching worker instances to run your pipeline. In the future, - worker_zone will take precedence. - type: string - description: The environment values to be set at runtime for a Flex Template. - GoogleCloudDatapipelinesV1RunPipelineRequest: - properties: {} - id: GoogleCloudDatapipelinesV1RunPipelineRequest - description: Request message for RunPipeline - type: object - GoogleCloudDatapipelinesV1ScheduleSpec: - type: object - description: Details of the schedule the pipeline runs on. - id: GoogleCloudDatapipelinesV1ScheduleSpec - properties: - timeZone: - description: >- - Timezone ID. This matches the timezone IDs used by the Cloud - Scheduler API. If empty, UTC time is assumed. - type: string - nextJobTime: - description: Output only. When the next Scheduler job is going to run. - readOnly: true - format: google-datetime - type: string - schedule: - type: string - description: >- - Unix-cron format of the schedule. This information is retrieved from - the linked Cloud Scheduler. - GoogleCloudDatapipelinesV1Job: - id: GoogleCloudDatapipelinesV1Job - type: object - description: >- - Definition of the job information maintained by the pipeline. Fields in - this entity are retrieved from the executor API (e.g. Dataflow API). - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Status capturing any error code or message related to job creation - or execution. - dataflowJobDetails: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' - description: All the details that are specific to a Dataflow job. - state: - enum: - - STATE_UNSPECIFIED - - STATE_PENDING - - STATE_RUNNING - - STATE_DONE - - STATE_FAILED - - STATE_CANCELLED - enumDescriptions: - - The job state isn't specified. - - The job is waiting to start execution. - - The job is executing. - - The job has finished execution successfully. - - The job has finished execution with a failure. - - The job has been terminated upon user request. - description: The current state of the job. - type: string - endTime: - format: google-datetime - type: string - readOnly: true - description: >- - Output only. The time of job termination. This is absent if the job - is still running. - name: - type: string - description: Required. The fully qualified resource name for the job. - id: - description: Output only. The internal ID for the job. - readOnly: true - type: string - createTime: - readOnly: true - type: string - format: google-datetime - description: Output only. The time of job creation. - GoogleCloudDatapipelinesV1LaunchTemplateRequest: - id: GoogleCloudDatapipelinesV1LaunchTemplateRequest - properties: - gcsPath: - description: >- - A Cloud Storage path to the template from which to create the job. - Must be a valid Cloud Storage URL, beginning with 'gs://'. - type: string - validateOnly: - type: boolean - description: >- - If true, the request is validated but not actually executed. - Defaults to false. - location: - type: string - description: >- - The [regional endpoint] - (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. - projectId: - type: string - description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - launchParameters: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters - description: >- - The parameters of the template to launch. This should be part of the - body of the POST request. - type: object - description: A request to launch a template. - GoogleCloudDatapipelinesV1RunPipelineResponse: - description: Response message for RunPipeline - type: object - properties: - job: - description: Job that was created as part of RunPipeline operation. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' - id: GoogleCloudDatapipelinesV1RunPipelineResponse - GoogleCloudDatapipelinesV1ListJobsResponse: - properties: - nextPageToken: - type: string - 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. - jobs: - description: >- - Results that were accessible to the caller. Results are always in - descending order of job creation date. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' - id: GoogleCloudDatapipelinesV1ListJobsResponse - description: Response message for ListJobs - type: object - GoogleRpcStatus: - type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - properties: - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - details: - type: array - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - GoogleCloudDatapipelinesV1StopPipelineRequest: - id: GoogleCloudDatapipelinesV1StopPipelineRequest - properties: {} - type: object - description: Request message for StopPipeline. - GoogleCloudDatapipelinesV1LaunchTemplateParameters: - type: object - description: Parameters to provide to the template being launched. - id: GoogleCloudDatapipelinesV1LaunchTemplateParameters - properties: - parameters: - description: The runtime parameters to pass to the job. - type: object - additionalProperties: - type: string - update: - type: boolean - description: >- - If set, replace the existing pipeline with the name specified by - jobName with this pipeline, preserving state. - environment: - description: The runtime environment for the job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' - transformNameMapping: - description: >- - Map of transform name prefixes of the job to be replaced to the - corresponding name prefixes of the new job. Only applicable when - updating a pipeline. - additionalProperties: - type: string - type: object - jobName: - description: Required. The job name to use for the created job. - type: string - GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: - description: A request to launch a Dataflow job from a Flex Template. - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest - type: object - properties: - projectId: - type: string - description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - location: - description: >- - Required. The [regional endpoint] - (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. For example, `us-central1`, - `us-west1`. - type: string - launchParameter: - description: Required. Parameter to launch a job from a Flex Template. - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - validateOnly: - description: >- - If true, the request is validated but not actually executed. - Defaults to false. - type: boolean - GoogleProtobufEmpty: - type: object - id: GoogleProtobufEmpty - properties: {} - 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); } - GoogleCloudDatapipelinesV1ListPipelinesResponse: - id: GoogleCloudDatapipelinesV1ListPipelinesResponse - description: Response message for ListPipelines. - type: object + GoogleCloudDatapipelinesV1LaunchTemplateParameters: properties: - 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. + parameters: + description: The runtime parameters to pass to the job. + type: object + additionalProperties: + type: string + jobName: + description: Required. The job name to use for the created job. type: string - pipelines: - items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + update: description: >- - Results that matched the filter criteria and were accessible to the - caller. Results are always in descending order of pipeline creation - date. - type: array - GoogleCloudDatapipelinesV1Pipeline: - id: GoogleCloudDatapipelinesV1Pipeline + If set, replace the existing pipeline with the name specified by + jobName with this pipeline, preserving state. + type: boolean + transformNameMapping: + type: object + description: >- + Map of transform name prefixes of the job to be replaced to the + corresponding name prefixes of the new job. Only applicable when + updating a pipeline. + additionalProperties: + type: string + environment: + description: The runtime environment for the job. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' + description: Parameters to provide to the template being launched. + id: GoogleCloudDatapipelinesV1LaunchTemplateParameters + type: object + GoogleCloudDatapipelinesV1RunPipelineResponse: + id: GoogleCloudDatapipelinesV1RunPipelineResponse + properties: + job: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' + description: Job that was created as part of RunPipeline operation. type: object + description: Response message for RunPipeline + GoogleCloudDatapipelinesV1Pipeline: description: >- The main pipeline entity and all the necessary metadata for launching and managing linked jobs. + type: object properties: pipelineSources: description: >- @@ -417,35 +87,30 @@ components: additionalProperties: type: string type: object - createTime: - type: string - description: >- - Output only. Immutable. The timestamp when the pipeline was - initially created. Set by the Data Pipelines service. - readOnly: true - format: google-datetime + workload: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' + description: Workload information for creating new jobs. displayName: - type: string description: >- Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). - lastUpdateTime: - readOnly: true type: string - format: google-datetime - description: >- - Output only. Immutable. The timestamp when the pipeline was last - modified. Set by the Data Pipelines service. jobCount: - description: Output only. Number of jobs. - readOnly: true format: int32 + description: Output only. Number of jobs. type: integer - workload: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' - description: Workload information for creating new jobs. + readOnly: true type: + enum: + - PIPELINE_TYPE_UNSPECIFIED + - PIPELINE_TYPE_BATCH + - PIPELINE_TYPE_STREAMING + type: string + description: >- + Required. The type of the pipeline. This field affects the + scheduling of the pipeline and the type of metrics to show for the + pipeline. enumDescriptions: - The pipeline type isn't specified. - >- @@ -456,29 +121,20 @@ components: until it is manually terminated by the user. This type of pipeline doesn't have a schedule to run on, and the linked job gets created when the pipeline is created. - description: >- - Required. The type of the pipeline. This field affects the - scheduling of the pipeline and the type of metrics to show for the - pipeline. - enum: - - PIPELINE_TYPE_UNSPECIFIED - - PIPELINE_TYPE_BATCH - - PIPELINE_TYPE_STREAMING - type: string scheduleInfo: description: >- Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs externally. $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' - schedulerServiceAccountEmail: + lastUpdateTime: + format: google-datetime + readOnly: true description: >- - Optional. A service account email to be used with the Cloud - Scheduler job. If not specified, the default compute engine service - account will be used. + Output only. Immutable. The timestamp when the pipeline was last + modified. Set by the Data Pipelines service. type: string state: - type: string enumDescriptions: - The pipeline state isn't specified. - >- @@ -497,12 +153,6 @@ components: resumed later. For a batch pipeline, this means pausing the scheduler job. For a streaming pipeline, creating a job snapshot to resume from will give the same effect. - description: >- - Required. The state of the pipeline. When the pipeline is created, - the state is set to 'PIPELINE_STATE_ACTIVE' by default. State - changes can be requested by setting the state to stopping, paused, - or resuming. State cannot be changed through UpdatePipeline - requests. enum: - STATE_UNSPECIFIED - STATE_RESUMING @@ -510,6 +160,26 @@ components: - STATE_STOPPING - STATE_ARCHIVED - STATE_PAUSED + description: >- + Required. The state of the pipeline. When the pipeline is created, + the state is set to 'PIPELINE_STATE_ACTIVE' by default. State + changes can be requested by setting the state to stopping, paused, + or resuming. State cannot be changed through UpdatePipeline + requests. + type: string + schedulerServiceAccountEmail: + description: >- + Optional. A service account email to be used with the Cloud + Scheduler job. If not specified, the default compute engine service + account will be used. + type: string + createTime: + description: >- + Output only. Immutable. The timestamp when the pipeline was + initially created. Set by the Data Pipelines service. + readOnly: true + type: string + format: google-datetime name: description: >- The pipeline name. For example: @@ -528,61 +198,229 @@ components: `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. type: string - GoogleCloudDatapipelinesV1SdkVersion: - id: GoogleCloudDatapipelinesV1SdkVersion - description: The version of the SDK used to run the job. + id: GoogleCloudDatapipelinesV1Pipeline + GoogleCloudDatapipelinesV1DataflowJobDetails: + id: GoogleCloudDatapipelinesV1DataflowJobDetails + properties: + resourceInfo: + description: >- + Cached version of all the metrics of interest for the job. This + value gets stored here when the job is terminated. As long as the + job is running, this field is populated from the Dataflow API. + type: object + additionalProperties: + format: double + type: number + sdkVersion: + description: Output only. The SDK version used to run the job. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' + currentWorkers: + readOnly: true + format: int32 + description: >- + Output only. The current number of workers used to run the jobs. + Only set to a value if the job is still running. + type: integer type: object + description: >- + Pipeline job details specific to the Dataflow API. This is encapsulated + here to allow for more executors to store their specific details + separately. + GoogleCloudDatapipelinesV1SdkVersion: properties: - version: - description: The version of the SDK used to run the job. + versionDisplayName: type: string + description: A readable string describing the version of the SDK. sdkSupportStatus: + type: string description: The support status for this SDK version. + enum: + - UNKNOWN + - SUPPORTED + - STALE + - DEPRECATED + - UNSUPPORTED + enumDescriptions: + - Dataflow is unaware of this version. + - This is a known version of an SDK, and is supported. + - A newer version of the SDK exists, and an update is recommended. + - >- + This version of the SDK is deprecated and will eventually be + unsupported. + - >- + Support for this SDK version has ended and it should no longer be + used. + version: + description: The version of the SDK used to run the job. + type: string + description: The version of the SDK used to run the job. + type: object + id: GoogleCloudDatapipelinesV1SdkVersion + GoogleCloudDatapipelinesV1ScheduleSpec: + id: GoogleCloudDatapipelinesV1ScheduleSpec + description: Details of the schedule the pipeline runs on. + type: object + properties: + nextJobTime: + readOnly: true + description: Output only. When the next Scheduler job is going to run. + type: string + format: google-datetime + schedule: + description: >- + Unix-cron format of the schedule. This information is retrieved from + the linked Cloud Scheduler. + type: string + timeZone: + type: string + description: >- + Timezone ID. This matches the timezone IDs used by the Cloud + Scheduler API. If empty, UTC time is assumed. + GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: + id: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + properties: + machineType: + description: >- + The machine type to use for the job. Defaults to the value from the + template if not specified. + type: string + numWorkers: + format: int32 + type: integer + description: The initial number of Compute Engine instances for the job. + flexrsGoal: + type: string + enum: + - FLEXRS_UNSPECIFIED + - FLEXRS_SPEED_OPTIMIZED + - FLEXRS_COST_OPTIMIZED + enumDescriptions: + - Run in the default mode. + - Optimize for lower execution time. + - Optimize for lower cost. + description: >- + Set FlexRS goal for the job. + https://cloud.google.com/dataflow/docs/guides/flexrs + enableStreamingEngine: + type: boolean + description: Whether to enable Streaming Engine for the job. + subnetwork: + description: >- + Subnetwork to which VMs will be assigned, if desired. You can + specify a subnetwork using either a complete URL or an abbreviated + path. Expected to be of the form + "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" + or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is + located in a Shared VPC network, you must use the complete URL. + type: string + maxWorkers: + description: >- + The maximum number of Compute Engine instances to be made available + to your pipeline during execution, from 1 to 1000. + type: integer + format: int32 + workerRegion: + description: >- + The Compute Engine region + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1". Mutually + exclusive with worker_zone. If neither worker_region nor worker_zone + is specified, defaults to the control plane region. + type: string + ipConfiguration: enumDescriptions: - - Dataflow is unaware of this version. - - This is a known version of an SDK, and is supported. - - A newer version of the SDK exists, and an update is recommended. - - >- - This version of the SDK is deprecated and will eventually be - unsupported. - - >- - Support for this SDK version has ended and it should no longer be - used. + - The configuration is unknown, or unspecified. + - Workers should have public IP addresses. + - Workers should have private IP addresses. + description: Configuration for VM IPs. enum: - - UNKNOWN - - SUPPORTED - - STALE - - DEPRECATED - - UNSUPPORTED + - WORKER_IP_UNSPECIFIED + - WORKER_IP_PUBLIC + - WORKER_IP_PRIVATE type: string - versionDisplayName: + kmsKeyName: type: string - description: A readable string describing the version of the SDK. - GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: - type: object - properties: - transformNameMappings: description: >- - Use this to pass transform name mappings for streaming update jobs. - Example: `{"oldTransformName":"newTransformName",...}` - additionalProperties: + Name for the Cloud KMS key for the job. Key format is: + projects//locations//keyRings//cryptoKeys/ + workerZone: + description: >- + The Compute Engine zone + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1-a". Mutually + exclusive with worker_region. If neither worker_region nor + worker_zone is specified, a zone in the control plane region is + chosen based on available capacity. If both `worker_zone` and `zone` + are set, `worker_zone` takes precedence. + type: string + additionalExperiments: + description: Additional experiment flags for the job. + type: array + items: type: string - type: object - environment: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment - description: The runtime environment for the Flex Template job. - parameters: + tempLocation: + type: string + description: >- + The Cloud Storage path to use for temporary files. Must be a valid + Cloud Storage URL, beginning with `gs://`. + serviceAccountEmail: + description: The email address of the service account to run the job as. + type: string + additionalUserLabels: additionalProperties: type: string + description: >- + Additional user labels to be specified for the job. Keys and values + must follow the restrictions specified in the [labeling + restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). + An object containing a list of key/value pairs. Example: `{ "name": + "wrench", "mass": "1kg", "count": "3" }`. type: object - description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' + zone: + type: string + description: >- + The Compute Engine [availability + zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) + for launching worker instances to run your pipeline. In the future, + worker_zone will take precedence. + network: + type: string + description: >- + Network to which VMs will be assigned. If empty or unspecified, the + service will use the network "default". + description: The environment values to be set at runtime for a Flex Template. + type: object + GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: + description: Launch Flex Template parameter. + type: object + properties: jobName: + type: string description: >- Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job. + containerSpecGcsPath: type: string + description: >- + Cloud Storage path to a file with a JSON-serialized ContainerSpec as + content. + parameters: + description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' + additionalProperties: + type: string + type: object + environment: + description: The runtime environment for the Flex Template job. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + update: + description: >- + Set this to true if you are sending a request to update a running + streaming job. When set, the job name should be the same as the + running job. + type: boolean launchOptions: type: object description: >- @@ -591,63 +429,149 @@ components: pass job parameters. additionalProperties: type: string - update: - type: boolean + transformNameMappings: description: >- - Set this to true if you are sending a request to update a running - streaming job. When set, the job name should be the same as the - running job. - containerSpecGcsPath: + Use this to pass transform name mappings for streaming update jobs. + Example: `{"oldTransformName":"newTransformName",...}` + type: object + additionalProperties: + type: string + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + GoogleCloudDatapipelinesV1ListPipelinesResponse: + properties: + nextPageToken: type: string description: >- - Cloud Storage path to a file with a JSON-serialized ContainerSpec as - content. - description: Launch Flex Template parameter. - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - GoogleCloudDatapipelinesV1DataflowJobDetails: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + pipelines: + items: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + description: >- + Results that matched the filter criteria and were accessible to the + caller. Results are always in descending order of pipeline creation + date. + type: array + type: object + id: GoogleCloudDatapipelinesV1ListPipelinesResponse + description: Response message for ListPipelines. + GoogleCloudDatapipelinesV1LaunchTemplateRequest: + description: A request to launch a template. + id: GoogleCloudDatapipelinesV1LaunchTemplateRequest properties: - resourceInfo: - additionalProperties: - type: number - format: double + validateOnly: + type: boolean description: >- - Cached version of all the metrics of interest for the job. This - value gets stored here when the job is terminated. As long as the - job is running, this field is populated from the Dataflow API. - type: object - currentWorkers: + If true, the request is validated but not actually executed. + Defaults to false. + gcsPath: description: >- - Output only. The current number of workers used to run the jobs. - Only set to a value if the job is still running. - readOnly: true - format: int32 - type: integer - sdkVersion: - description: Output only. The SDK version used to run the job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' - readOnly: true - description: >- - Pipeline job details specific to the Dataflow API. This is encapsulated - here to allow for more executors to store their specific details - separately. + A Cloud Storage path to the template from which to create the job. + Must be a valid Cloud Storage URL, beginning with 'gs://'. + type: string + launchParameters: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters + description: >- + The parameters of the template to launch. This should be part of the + body of the POST request. + projectId: + type: string + description: >- + Required. The ID of the Cloud Platform project that the job belongs + to. + location: + description: >- + The [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) + to which to direct the request. + type: string type: object - id: GoogleCloudDatapipelinesV1DataflowJobDetails + GoogleProtobufEmpty: + properties: {} + type: object + id: GoogleProtobufEmpty + 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); } GoogleCloudDatapipelinesV1RuntimeEnvironment: + id: GoogleCloudDatapipelinesV1RuntimeEnvironment + type: object + description: The environment values to set at runtime. properties: + network: + description: >- + Network to which VMs will be assigned. If empty or unspecified, the + service will use the network "default". + type: string + serviceAccountEmail: + type: string + description: The email address of the service account to run the job as. + workerRegion: + description: >- + The Compute Engine region + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1". Mutually + exclusive with worker_zone. If neither worker_region nor worker_zone + is specified, default to the control plane's region. + type: string + enableStreamingEngine: + type: boolean + description: Whether to enable Streaming Engine for the job. + workerZone: + description: >- + The Compute Engine zone + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1-a". Mutually + exclusive with worker_region. If neither worker_region nor + worker_zone is specified, a zone in the control plane's region is + chosen based on available capacity. If both `worker_zone` and `zone` + are set, `worker_zone` takes precedence. + type: string + tempLocation: + description: >- + The Cloud Storage path to use for temporary files. Must be a valid + Cloud Storage URL, beginning with `gs://`. + type: string + bypassTempDirValidation: + type: boolean + description: >- + Whether to bypass the safety checks for the job's temporary + directory. Use with caution. + machineType: + type: string + description: >- + The machine type to use for the job. Defaults to the value from the + template if not specified. + additionalExperiments: + description: Additional experiment flags for the job. + type: array + items: + type: string numWorkers: - format: int32 - type: integer description: The initial number of Compute Engine instances for the job. - serviceAccountEmail: - description: The email address of the service account to run the job as. + type: integer + format: int32 + zone: type: string - kmsKeyName: description: >- - Name for the Cloud KMS key for the job. The key format is: - projects//locations//keyRings//cryptoKeys/ - type: string + The Compute Engine [availability + zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) + for launching worker instances to run your pipeline. In the future, + worker_zone will take precedence. + additionalUserLabels: + description: >- + Additional user labels to be specified for the job. Keys and values + should follow the restrictions specified in the [labeling + restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) + page. An object containing a list of key/value pairs. Example: { + "name": "wrench", "mass": "1kg", "count": "3" }. + type: object + additionalProperties: + type: string subnetwork: - type: string description: >- Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated @@ -655,110 +579,186 @@ components: "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. - workerZone: type: string - description: >- - The Compute Engine zone - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1-a". Mutually - exclusive with worker_region. If neither worker_region nor - worker_zone is specified, a zone in the control plane's region is - chosen based on available capacity. If both `worker_zone` and `zone` - are set, `worker_zone` takes precedence. - additionalExperiments: - type: array - items: - type: string - description: Additional experiment flags for the job. ipConfiguration: - type: string - description: Configuration for VM IPs. enumDescriptions: - The configuration is unknown, or unspecified. - Workers should have public IP addresses. - Workers should have private IP addresses. + description: Configuration for VM IPs. enum: - WORKER_IP_UNSPECIFIED - WORKER_IP_PUBLIC - WORKER_IP_PRIVATE - enableStreamingEngine: - description: Whether to enable Streaming Engine for the job. - type: boolean - workerRegion: - description: >- - The Compute Engine region - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1". Mutually - exclusive with worker_zone. If neither worker_region nor worker_zone - is specified, default to the control plane's region. type: string - machineType: + kmsKeyName: description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. - type: string - zone: + Name for the Cloud KMS key for the job. The key format is: + projects//locations//keyRings//cryptoKeys/ type: string - description: >- - The Compute Engine [availability - zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - for launching worker instances to run your pipeline. In the future, - worker_zone will take precedence. maxWorkers: type: integer + format: int32 description: >- The maximum number of Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. - format: int32 - tempLocation: - type: string - description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. - network: - description: >- - Network to which VMs will be assigned. If empty or unspecified, the - service will use the network "default". - type: string - additionalUserLabels: - additionalProperties: - type: string - type: object - description: >- - Additional user labels to be specified for the job. Keys and values - should follow the restrictions specified in the [labeling - restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) - page. An object containing a list of key/value pairs. Example: { - "name": "wrench", "mass": "1kg", "count": "3" }. - bypassTempDirValidation: - description: >- - Whether to bypass the safety checks for the job's temporary - directory. Use with caution. - type: boolean - type: object - id: GoogleCloudDatapipelinesV1RuntimeEnvironment - description: The environment values to set at runtime. GoogleCloudDatapipelinesV1Workload: - description: Workload details for creating the pipeline jobs. type: object - id: GoogleCloudDatapipelinesV1Workload + description: Workload details for creating the pipeline jobs. properties: dataflowFlexTemplateRequest: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest description: >- Template information and additional parameters needed to launch a Dataflow job using the flex launch API. - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest dataflowLaunchTemplateRequest: $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' description: >- Template information and additional parameters needed to launch a Dataflow job using the standard launch API. + id: GoogleCloudDatapipelinesV1Workload + GoogleCloudDatapipelinesV1ListJobsResponse: + type: object + id: GoogleCloudDatapipelinesV1ListJobsResponse + description: Response message for ListJobs + properties: + jobs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' + description: >- + Results that were accessible to the caller. Results are always in + descending order of job creation date. + 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 + GoogleCloudDatapipelinesV1StopPipelineRequest: + description: Request message for StopPipeline. + properties: {} + id: GoogleCloudDatapipelinesV1StopPipelineRequest + type: object + GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: + properties: + projectId: + type: string + description: >- + Required. The ID of the Cloud Platform project that the job belongs + to. + location: + type: string + description: >- + Required. The [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) + to which to direct the request. For example, `us-central1`, + `us-west1`. + launchParameter: + description: Required. Parameter to launch a job from a Flex Template. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + validateOnly: + type: boolean + description: >- + If true, the request is validated but not actually executed. + Defaults to false. + type: object + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest + description: A request to launch a Dataflow job from a Flex Template. + GoogleCloudDatapipelinesV1Job: + description: >- + Definition of the job information maintained by the pipeline. Fields in + this entity are retrieved from the executor API (e.g. Dataflow API). + properties: + dataflowJobDetails: + description: All the details that are specific to a Dataflow job. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' + endTime: + format: google-datetime + description: >- + Output only. The time of job termination. This is absent if the job + is still running. + type: string + readOnly: true + name: + type: string + description: Required. The fully qualified resource name for the job. + createTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The time of job creation. + id: + description: Output only. The internal ID for the job. + type: string + readOnly: true + state: + enum: + - STATE_UNSPECIFIED + - STATE_PENDING + - STATE_RUNNING + - STATE_DONE + - STATE_FAILED + - STATE_CANCELLED + type: string + description: The current state of the job. + enumDescriptions: + - The job state isn't specified. + - The job is waiting to start execution. + - The job is executing. + - The job has finished execution successfully. + - The job has finished execution with a failure. + - The job has been terminated upon user request. + status: + description: >- + Status capturing any error code or message related to job creation + or execution. + $ref: '#/components/schemas/GoogleRpcStatus' + type: object + id: GoogleCloudDatapipelinesV1Job + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + id: GoogleRpcStatus + properties: + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: array + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + GoogleCloudDatapipelinesV1RunPipelineRequest: + properties: {} + description: Request message for RunPipeline + id: GoogleCloudDatapipelinesV1RunPipelineRequest + type: object parameters: - fields: - description: Selector specifying which fields to include in a partial response. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: fields + name: uploadType schema: type: string upload_protocol: @@ -767,6 +767,12 @@ components: name: upload_protocol schema: type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string alt: description: Data format for response. in: query @@ -777,12 +783,21 @@ components: - json - media - proto - oauth_token: - description: OAuth 2.0 token for the current user. + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + _.xgafv: + description: V1 error format. in: query - name: oauth_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -792,18 +807,6 @@ components: name: quotaUser schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -813,25 +816,22 @@ components: name: key schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: prettyPrint + name: fields schema: - type: boolean - _.xgafv: - description: V1 error format. + type: string + access_token: + description: OAuth access token. in: query - name: $.xgafv + name: access_token schema: type: string - enum: - - '1' - - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + name: oauth_token schema: type: string x-stackQL-resources: @@ -840,53 +840,53 @@ components: name: pipelines title: Pipelines methods: - run: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:run/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/get response: mediaType: application/json openAPIDocKey: '200' - stop: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.pipelines - create: + stop: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.pipelines + run: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:run/post response: mediaType: application/json openAPIDocKey: '200' @@ -922,34 +922,25 @@ components: replace: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}: parameters: &ref_1 - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' - post: + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' + get: description: >- - Creates a job for the specified pipeline directly. You can use this - method when the internal scheduler is not configured and you want to - trigger the job directly or through an external system. Returns a - "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" - error if the user doesn't have permission to access the pipeline or run - jobs for the pipeline. - operationId: datapipelines.projects.locations.pipelines.run - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineRequest + Looks up a single pipeline. Returns a "NOT_FOUND" error if no such + pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have + permission to access it. + operationId: datapipelines.projects.locations.pipelines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -961,8 +952,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineResponse + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -979,20 +969,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: - parameters: *ref_1 - post: + delete: description: >- - Freezes pipeline execution permanently. If there's a corresponding - scheduler entry, it's deleted, and the pipeline state is changed to - "ARCHIVED". However, pipeline metadata is retained. - operationId: datapipelines.projects.locations.pipelines.stop - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1StopPipelineRequest + Deletes a pipeline. If a scheduler job is attached to the pipeline, it + will be deleted. + operationId: datapipelines.projects.locations.pipelines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1004,7 +985,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1021,13 +1002,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines: - parameters: *ref_1 - get: + patch: description: >- - Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have - permission to access it. - operationId: datapipelines.projects.locations.pipelines.list + Updates a pipeline. If successful, the updated Pipeline is returned. + Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline + does not return successfully, you can retry the UpdatePipeline request + until you receive a successful response. + operationId: datapipelines.projects.locations.pipelines.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1039,8 +1025,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1ListPipelinesResponse + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1052,31 +1037,30 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: pipelinesId + required: true schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: + parameters: *ref_1 post: description: >- - Creates a pipeline. For a batch pipeline, you can pass scheduler - information. Data Pipelines uses the scheduler information to create an - internal scheduler that runs jobs periodically. If the internal - scheduler is not configured, you can use RunPipeline to run jobs. - operationId: datapipelines.projects.locations.pipelines.create + Freezes pipeline execution permanently. If there's a corresponding + scheduler entry, it's deleted, and the pipeline state is changed to + "ARCHIVED". However, pipeline metadata is retained. + operationId: datapipelines.projects.locations.pipelines.stop requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1StopPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1100,13 +1084,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}: + - in: path + name: pipelinesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelines: parameters: *ref_1 - delete: + post: description: >- - Deletes a pipeline. If a scheduler job is attached to the pipeline, it - will be deleted. - operationId: datapipelines.projects.locations.pipelines.delete + Creates a pipeline. For a batch pipeline, you can pass scheduler + information. Data Pipelines uses the scheduler information to create an + internal scheduler that runs jobs periodically. If the internal + scheduler is not configured, you can use RunPipeline to run jobs. + operationId: datapipelines.projects.locations.pipelines.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1118,7 +1114,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1130,17 +1126,11 @@ paths: required: true schema: type: string - - in: path - name: pipelinesId - required: true - schema: - type: string get: description: >- - Looks up a single pipeline. Returns a "NOT_FOUND" error if no such - pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have + Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. - operationId: datapipelines.projects.locations.pipelines.get + operationId: datapipelines.projects.locations.pipelines.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1152,7 +1142,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1ListPipelinesResponse parameters: - in: path name: projectsId @@ -1164,23 +1155,36 @@ paths: required: true schema: type: string - - in: path - name: pipelinesId - required: true + - in: query + name: filter schema: type: string - patch: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run: + parameters: *ref_1 + post: description: >- - Updates a pipeline. If successful, the updated Pipeline is returned. - Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline - does not return successfully, you can retry the UpdatePipeline request - until you receive a successful response. - operationId: datapipelines.projects.locations.pipelines.patch + Creates a job for the specified pipeline directly. You can use this + method when the internal scheduler is not configured and you want to + trigger the job directly or through an external system. Returns a + "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" + error if the user doesn't have permission to access the pipeline or run + jobs for the pipeline. + operationId: datapipelines.projects.locations.pipelines.run requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1192,7 +1196,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineResponse parameters: - in: path name: projectsId @@ -1209,11 +1214,6 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml index 256c2921..1456eb50 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml @@ -8,7 +8,7 @@ info: description: Dataplex API is used to manage the lifecycle of data lakes. version: v1 x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dataplex/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml index c7182131..9598a41d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml @@ -8,7 +8,7 @@ info: description: Manages Hadoop-based clusters and jobs on Google Cloud Platform. version: v1 x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dataproc/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml b/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml index 622137d9..7c0522b9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml @@ -9,8 +9,8 @@ info: Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. version: v1 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/datastore/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml b/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml index 6e724ebb..afe86b49 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240826' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/datastream/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml index da585df0..55de3962 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml @@ -11,7 +11,7 @@ info: templates which specify deployments of Cloud resources. version: v2 x-discovery-doc-revision: '20240404' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/deployment-manager servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml b/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml index 7c7b4a6a..d4c837e6 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml @@ -7,8 +7,8 @@ info: title: Developer Connect API description: Connect third-party source code management to Google version: v1 - x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: http://cloud.google.com/developer-connect/docs/overview servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml b/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml index dabcc54d..0a4e6890 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml @@ -9,8 +9,8 @@ info: Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). version: v3 - x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dialogflow/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml index c21116b1..4b5d15ac 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml @@ -8,7 +8,7 @@ info: description: Discovery Engine API. version: v1 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/generative-ai-app-builder/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml index 976b62f5..aa13af61 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml @@ -10,8 +10,8 @@ info: to help you discover, classify, and protect your valuable data assets with ease. version: v2 - x-discovery-doc-revision: '20240901' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/sensitive-data-protection/docs/ servers: @@ -37,1483 +37,1353 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GooglePrivacyDlpV2StoredInfoTypeStats: + GooglePrivacyDlpV2InspectJobConfig: + description: Controls what and how to inspect for findings. properties: - largeCustomDictionary: + actions: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + description: Actions to execute at the completion of the job. + type: array + storageConfig: + description: The data to scan. + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: How and what to scan for. + inspectTemplateName: + type: string description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' - description: Statistics for a StoredInfoType. - type: object - id: GooglePrivacyDlpV2StoredInfoTypeStats - GooglePrivacyDlpV2DataProfilePubSubMessage: - id: GooglePrivacyDlpV2DataProfilePubSubMessage + If provided, will be used as the default for all values in + InspectConfig. `inspect_config` will be merged into the values + persisted as part of the template. type: object + id: GooglePrivacyDlpV2InspectJobConfig + GooglePrivacyDlpV2KAnonymityEquivalenceClass: + id: GooglePrivacyDlpV2KAnonymityEquivalenceClass properties: - profile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + quasiIdsValues: description: >- - If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. - Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and - `full_resource` will be populated. - event: - description: The event that caused the Pub/Sub message to be sent. + Set of values defining the equivalence class. One value per + quasi-identifier column in the original KAnonymity metric message. + The order is always the same as the original request. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + equivalenceClassSize: type: string - enum: - - EVENT_TYPE_UNSPECIFIED - - NEW_PROFILE - - CHANGED_PROFILE - - SCORE_INCREASED - - ERROR_CHANGED - enumDescriptions: - - Unused. - - New profile (not a re-profile). - - >- - One of the following profile metrics changed: Data risk score, - Sensitivity score, Resource visibility, Encryption type, Predicted - infoTypes, Other infoTypes - - Table data risk score or sensitivity score increased. - - A user (non-internal) error occurred. - fileStoreProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + format: int64 description: >- - If `DetailLevel` is `FILE_STORE_PROFILE` this will be fully - populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only - `name` and `file_store_path` will be populated. - description: >- - Pub/Sub topic message for a DataProfileAction.PubSubNotification event. - To receive a message of protocol buffer schema type, convert the message - data to an object of this proto class. - GooglePrivacyDlpV2ListFileStoreDataProfilesResponse: + Size of the equivalence class, for example number of rows with the + above set of values. + description: The set of columns' values that share the same ldiversity value + type: object + GooglePrivacyDlpV2LDiversityHistogramBucket: type: object + id: GooglePrivacyDlpV2LDiversityHistogramBucket + description: Histogram of l-diversity equivalence class sensitive value frequencies. properties: - nextPageToken: + sensitiveValueFrequencyUpperBound: + description: >- + Upper bound on the sensitive value frequencies of the equivalence + classes in this bucket. + format: int64 type: string - description: The next page token. - fileStoreDataProfiles: + sensitiveValueFrequencyLowerBound: + type: string + description: >- + Lower bound on the sensitive value frequencies of the equivalence + classes in this bucket. + format: int64 + bucketValues: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' - description: List of data profiles. - id: GooglePrivacyDlpV2ListFileStoreDataProfilesResponse - description: >- - List of file store data profiles generated for a given organization or - project. - GooglePrivacyDlpV2TransformationResultStatus: - properties: - resultStatusType: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' description: >- - Transformation result status type, this will be either SUCCESS, or - it will be the reason for why the transformation was not completely - successful. + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. + bucketValueCount: + type: string + description: Total number of distinct equivalence classes in this bucket. + format: int64 + bucketSize: + description: Total number of equivalence classes in this bucket. + format: int64 type: string + GooglePrivacyDlpV2Condition: + type: object + id: GooglePrivacyDlpV2Condition + properties: + value: + description: Value to compare against. [Mandatory, except for `EXISTS` tests.] + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + operator: enum: - - STATE_TYPE_UNSPECIFIED - - INVALID_TRANSFORM - - BIGQUERY_MAX_ROW_SIZE_EXCEEDED - - METADATA_UNRETRIEVABLE - - SUCCESS + - RELATIONAL_OPERATOR_UNSPECIFIED + - EQUAL_TO + - NOT_EQUAL_TO + - GREATER_THAN + - LESS_THAN + - GREATER_THAN_OR_EQUALS + - LESS_THAN_OR_EQUALS + - EXISTS + description: >- + Required. Operator used to compare the field or infoType to the + value. + type: string enumDescriptions: - - Unused. - - >- - This will be set when a finding could not be transformed (i.e. - outside user set bucket range). - - >- - This will be set when a BigQuery transformation was successful but - could not be stored back in BigQuery because the transformed row - exceeds BigQuery's max row size. - - >- - This will be set when there is a finding in the custom metadata of - a file, but at the write time of the transformed file, this key / - value pair is unretrievable. - - >- - This will be set when the transformation and storing of it is - successful. - details: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Detailed error codes and messages - id: GooglePrivacyDlpV2TransformationResultStatus - description: The outcome of a transformation. + - Unused + - Equal. Attempts to match even with incompatible types. + - Not equal to. Attempts to match even with incompatible types. + - Greater than. + - Less than. + - Greater than or equals. + - Less than or equals. + - Exists + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + Required. Field within the record this condition is evaluated + against. + description: >- + The field type of `value` and `field` do not need to match to be + considered equal, but not all comparisons are possible. EQUAL_TO and + NOT_EQUAL_TO attempt to compare even with incompatible types, but all + other comparisons are invalid with incompatible types. A `value` of + type: - `string` can be compared against all other types - `boolean` can + only be compared against other booleans - `integer` can be compared + against doubles or a string if the string value can be parsed as an + integer. - `double` can be compared against integers or a string if the + string can be parsed as a double. - `Timestamp` can be compared against + strings in RFC 3339 date string format. - `TimeOfDay` can be compared + against timestamps and strings in the format of 'HH:mm:ss'. If we fail + to compare do to type mismatch, a warning will be given and the + condition will evaluate to false. + GooglePrivacyDlpV2Bucket: type: object - GooglePrivacyDlpV2InspectDataSourceDetails: + id: GooglePrivacyDlpV2Bucket properties: - result: - description: A summary of the outcome of this inspection job. - $ref: '#/components/schemas/GooglePrivacyDlpV2Result' - requestedOptions: - description: The configuration used for this job. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' - id: GooglePrivacyDlpV2InspectDataSourceDetails - description: The results of an inspect DataSource job. + min: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: >- + Lower bound of the range, inclusive. Type should be the same as max + if used. + max: + description: Upper bound of the range, exclusive; type must match min. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + replacementValue: + description: Required. Replacement value for this bucket. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Bucket is represented as a range, along with replacement values. + GooglePrivacyDlpV2SecretsDiscoveryTarget: type: object - GooglePrivacyDlpV2TableOptions: + id: GooglePrivacyDlpV2SecretsDiscoveryTarget + properties: {} + description: >- + Discovery target for credentials and secrets in cloud resource metadata. + This target does not include any filtering or frequency controls. Cloud + DLP will scan cloud resource metadata for secrets daily. No inspect + template should be included in the discovery config for a security + benchmarks scan. Instead, the built-in list of secrets and credentials + infoTypes will be used (see + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). + Credentials and secrets discovered will be reported as vulnerabilities + to Security Command Center. + GooglePrivacyDlpV2DeltaPresenceEstimationConfig: + description: >- + δ-presence metric, used to estimate how likely it is for an attacker to + figure out that one given individual appears in a de-identified dataset. + Similarly to the k-map metric, we cannot compute δ-presence exactly + without knowing the attack dataset, so we use a statistical model + instead. type: object - id: GooglePrivacyDlpV2TableOptions - description: Instructions regarding the table content being inspected. + id: GooglePrivacyDlpV2DeltaPresenceEstimationConfig properties: - identifyingFields: + quasiIds: type: array description: >- - The columns that are the primary keys for table objects included in - ContentItem. A copy of this cell's value will stored alongside - alongside each finding so that the finding can be traced to the - specific row it came from. No more than 3 may be provided. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - GooglePrivacyDlpV2InfoTypeTransformation: - type: object - properties: - infoTypes: + Required. Fields considered to be quasi-identifiers. No two fields + can have the same tag. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiId' + regionCode: description: >- - InfoTypes to apply the transformation to. An empty list will cause - this transformation to apply to all findings that correspond to - infoTypes that were requested in `InspectConfig`. - type: array - primitiveTransformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - description: Required. Primitive transformation to apply to the infoType. + ISO 3166-1 alpha-2 region code to use in the statistical modeling. + Set if no column is tagged with a region-specific InfoType (like + US_ZIP_5) or a region code. + type: string + auxiliaryTables: + description: >- + Several auxiliary tables can be used in the analysis. Each + custom_tag used to tag a quasi-identifiers field must appear in + exactly one field of one auxiliary table. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StatisticalTable' + type: array + GooglePrivacyDlpV2AllOtherBigQueryTables: + properties: {} + type: object + id: GooglePrivacyDlpV2AllOtherBigQueryTables description: >- - A transformation to apply to text that is identified as a specific - info_type. - id: GooglePrivacyDlpV2InfoTypeTransformation - GooglePrivacyDlpV2InspectContentRequest: + Catch-all for all other tables not specified by other filters. Should + always be last, except for single-table configurations, which will only + have a TableReference target. + GooglePrivacyDlpV2PrivacyMetric: + description: Privacy metric to compute for reidentification risk analysis. + properties: + kAnonymityConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' + description: K-anonymity + deltaPresenceEstimationConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' + description: delta-presence + kMapEstimationConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' + description: k-map + numericalStatsConfig: + description: Numerical stats + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' + categoricalStatsConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' + description: Categorical stats + lDiversityConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' + description: l-diversity type: object + id: GooglePrivacyDlpV2PrivacyMetric + GooglePrivacyDlpV2FixedSizeBucketingConfig: + id: GooglePrivacyDlpV2FixedSizeBucketingConfig + description: >- + Buckets values based on fixed size ranges. The Bucketing transformation + can provide all of this functionality, but requires more configuration. + This message is provided as a convenience to the user for simple + bucketing strategies. The transformed value will be a hyphenated string + of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and + upper_bound = 20, all values that are within this bucket will be + replaced with "10-20". This can be used on data of type: double, long. + If the bound Value type differs from the type of data being transformed, + we will first attempt converting the type of the data to be transformed + to match the type of the bound before comparing. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing + to learn more. properties: - inspectTemplateName: - type: string + lowerBound: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: >- - Template to use. Any configuration directly specified in - inspect_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - inspectConfig: + Required. Lower bound value of buckets. All values less than + `lower_bound` are grouped together into a single bucket; for example + if `lower_bound` = 10, then all values less than 10 are replaced + with the value "-10". + bucketSize: description: >- - Configuration for the inspector. What specified here will override - the template referenced by the inspect_template_name argument. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - item: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - locationId: - description: Deprecated. This field has no effect. - type: string - id: GooglePrivacyDlpV2InspectContentRequest - description: Request to search for potentially sensitive info in a ContentItem. - GooglePrivacyDlpV2KMapEstimationHistogramBucket: + Required. Size of each bucket (except for minimum and maximum + buckets). So if `lower_bound` = 10, `upper_bound` = 89, and + `bucket_size` = 10, then the following buckets would be used: -10, + 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. + Precision up to 2 decimals works. + format: double + type: number + upperBound: + description: >- + Required. Upper bound value of buckets. All values greater than + upper_bound are grouped together into a single bucket; for example + if `upper_bound` = 89, then all values greater than 89 are replaced + with the value "89+". + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' type: object + GooglePrivacyDlpV2ImageTransformation: + type: object + id: GooglePrivacyDlpV2ImageTransformation properties: - bucketValueCount: - format: int64 - type: string + allInfoTypes: description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - minAnonymity: - type: string - format: int64 - description: Always positive. - maxAnonymity: - description: Always greater than or equal to min_anonymity. - type: string - format: int64 - bucketValues: + Apply transformation to all findings not specified in other + ImageTransformation's selected_info_types. Only one instance is + allowed within the ImageTransformations message. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' + selectedInfoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' + description: Apply transformation to the selected info_types. + redactionColor: + $ref: '#/components/schemas/GooglePrivacyDlpV2Color' description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationQuasiIdValues' - type: array - bucketSize: - type: string - format: int64 - description: Number of records within these anonymity bounds. - description: >- - A KMapEstimationHistogramBucket message with the following values: - min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 - records whose quasi-identifier values correspond to 3, 4 or 5 people in - the overlying population. An important particular case is when - min_anonymity = max_anonymity = 1: the frequency field then corresponds - to the number of uniquely identifiable records. - id: GooglePrivacyDlpV2KMapEstimationHistogramBucket - GooglePrivacyDlpV2CryptoDeterministicConfig: + The color to use when redacting content from an image. If not + specified, the default is black. + allText: + description: >- + Apply transformation to all text that doesn't match an infoType. + Only one instance is allowed within the ImageTransformations + message. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' + description: Configuration for determining how redaction of images should occur. + GooglePrivacyDlpV2CloudSqlDiscoveryTarget: + type: object + id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget properties: - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + filter: description: >- - The key used by the encryption function. For deterministic - encryption using AES-SIV, the provided key is internally expanded to - 64 bytes prior to use. - context: + Required. The tables the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlFilter' + disabled: + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + description: Disable profiling for database resources that match this filter. + conditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' description: >- - A context may be used for higher security and maintaining - referential integrity such that the same identifier in two different - contexts will be given a distinct surrogate. The context is appended - to plaintext value being encrypted. On decryption the provided - context is validated against the value used during encryption. If a - context was provided during encryption, same context must be - provided during decryption as well. If the context is not set, - plaintext would be used as is for encryption. If the context is set - but: 1. there is no record present when transforming a given value - or 2. the field is not present when transforming a given value, - plaintext would be used as is for encryption. Note that case (1) is - expected when an `InfoTypeTransformation` is applied to both - structured and unstructured `ContentItem`s. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - surrogateInfoType: + In addition to matching the filter, these conditions must be true + before a profile is generated. + generationCadence: description: >- - The custom info type to annotate the surrogate with. This annotation - will be applied to the surrogate by prefixing it with the name of - the custom info type followed by the number of characters comprising - the surrogate. The following scheme defines the format: {info type - name}({surrogate character count}):{surrogate} For example, if the - name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate - is 'abc', the full replacement value will be: - 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate - when inspecting content using the custom info type 'Surrogate'. This - facilitates reversal of the surrogate when it occurs in free text. - Note: For record transformations where the entire cell in a table is - being transformed, surrogates are not mandatory. Surrogates are used - to denote the location of the token and are necessary for - re-identification in free form text. In order for inspection to work - properly, the name of this info type must not occur naturally - anywhere in your data; otherwise, inspection may either - reverse a - surrogate that does not correspond to an actual identifier - be - unable to parse the surrogate and result in an error Therefore, - choose your custom info type name carefully after considering what - your data looks like. One way to select a name that has a high - chance of yielding reliable detection is to include one or more - unicode characters that are highly improbable to exist in your data. - For example, assuming your data is entered from a regular ASCII - keyboard, the symbol with the hex code point 29DD might be used like - so: ⧝MY_TOKEN_TYPE. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - id: GooglePrivacyDlpV2CryptoDeterministicConfig - type: object - description: >- - Pseudonymization method that generates deterministic encryption for the - given input. Outputs a base64 encoded representation of the encrypted - output. Uses AES-SIV based on the RFC - https://tools.ietf.org/html/rfc5297. - GooglePrivacyDlpV2KindExpression: + How often and when to update profiles. New tables that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + description: Target used to match against for discovery with Cloud SQL tables. + GooglePrivacyDlpV2ValueFrequency: type: object - id: GooglePrivacyDlpV2KindExpression - description: A representation of a Datastore kind. properties: - name: - description: The name of the kind. + count: + format: int64 type: string - GooglePrivacyDlpV2StorageConfig: + description: How many times the value is contained in the field. + value: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: A value contained in the field in question. + id: GooglePrivacyDlpV2ValueFrequency + description: A value of a field, including its frequency. + GooglePrivacyDlpV2DocumentLocation: properties: - hybridOptions: - description: Hybrid inspection options. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' - timespanConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' - description: Configuration of the timespan of the items to include in scanning. - datastoreOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' - description: Google Cloud Datastore options. - cloudStorageOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' - description: Cloud Storage options. - bigQueryOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' - description: BigQuery options. - description: Shared message indicating Cloud storage type. + fileOffset: + type: string + format: int64 + description: >- + Offset of the line, from the beginning of the file, where the + finding is located. + description: Location of a finding within a document. type: object - id: GooglePrivacyDlpV2StorageConfig - GooglePrivacyDlpV2LDiversityEquivalenceClass: - id: GooglePrivacyDlpV2LDiversityEquivalenceClass + id: GooglePrivacyDlpV2DocumentLocation + GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: + type: object + id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + description: Request message for UpdateStoredInfoType. properties: - equivalenceClassSize: - description: Size of the k-anonymity equivalence class. - format: int64 + updateMask: type: string - quasiIdsValues: + description: Mask to control which fields get updated. + format: google-fieldmask + config: description: >- - Quasi-identifier values defining the k-anonymity equivalence class. - The order is always the same as the original request. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - type: array - topSensitiveValues: - description: Estimated frequencies of top sensitive values. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' - type: array - numDistinctSensitiveValues: - type: string - format: int64 - description: Number of distinct sensitive values in this equivalence class. - type: object - description: The set of columns' values that share the same ldiversity value. - GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence: + Updated configuration for the storedInfoType. If not provided, a new + version of the storedInfoType will be created with the existing + configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + GooglePrivacyDlpV2InfoTypeLikelihood: + description: >- + Configuration for setting a minimum likelihood per infotype. Used to + customize the minimum likelihood level for specific infotypes in the + request. For example, use this if you want to lower the precision for + PERSON_NAME without lowering the precision for the other infotypes in + the request. properties: - frequency: + minLikelihood: enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - description: >- - How frequently data profiles can be updated when the template is - modified. Defaults to never. + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + description: >- + Only returns findings equal to or above this threshold. This field + is required or else the configuration fails. type: string - id: GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + Type of information the likelihood threshold applies to. Only one + likelihood per info_type should be provided. If InfoTypeLikelihood + does not have an info_type, the configuration fails. type: object - description: >- - The cadence at which to update data profiles when the inspection rules - defined by the `InspectTemplate` change. + id: GooglePrivacyDlpV2InfoTypeLikelihood + GooglePrivacyDlpV2FieldId: + properties: + name: + type: string + description: Name describing the field. + type: object + id: GooglePrivacyDlpV2FieldId + description: General identifier of a data field in a storage service. + GooglePrivacyDlpV2DataProfileConfigSnapshot: + type: object + id: GooglePrivacyDlpV2DataProfileConfigSnapshot + properties: + dataProfileJob: + deprecated: true + description: >- + A copy of the configuration used to generate this profile. This is + deprecated, and the DiscoveryConfig field is preferred moving + forward. DataProfileJobConfig will still be written here for + Discovery in BigQuery for backwards compatibility, but will not be + updated with new fields, while DiscoveryConfig will. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' + inspectTemplateModifiedTime: + type: string + format: google-datetime + description: Timestamp when the template was modified + inspectConfig: + description: >- + A copy of the inspection config used to generate this profile. This + is a copy of the inspect_template specified in + `DataProfileJobConfig`. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + discoveryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: A copy of the configuration used to generate this profile. + inspectTemplateName: + type: string + description: Name of the inspection template used to generate this profile + description: Snapshot of the configurations used to generate the profile. GooglePrivacyDlpV2ProfileStatus: + type: object + id: GooglePrivacyDlpV2ProfileStatus + description: Success or errors for the profile generation. properties: status: - $ref: '#/components/schemas/GoogleRpcStatus' description: >- Profiling status code and optional message. The `status.code` value is 0 (default value) for OK. + $ref: '#/components/schemas/GoogleRpcStatus' timestamp: format: google-datetime - description: Time when the profile generation status was updated type: string + description: Time when the profile generation status was updated + GooglePrivacyDlpV2PublishSummaryToCscc: type: object - id: GooglePrivacyDlpV2ProfileStatus - description: Success or errors for the profile generation. - GooglePrivacyDlpV2DiscoveryCloudSqlConditions: - id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions - properties: - types: - type: array - items: - type: string - enum: - - DATABASE_RESOURCE_TYPE_UNSPECIFIED - - DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES - - DATABASE_RESOURCE_TYPE_TABLE - enumDescriptions: - - Unused. - - >- - Includes database resource types that become supported at a - later time. - - Tables. - description: >- - Data profiles will only be generated for the database resource types - specified in this field. If not specified, defaults to - [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. - databaseEngines: - items: - type: string - enum: - - DATABASE_ENGINE_UNSPECIFIED - - ALL_SUPPORTED_DATABASE_ENGINES - - MYSQL - - POSTGRES - enumDescriptions: - - Unused. - - Include all supported database engines. - - MySQL database. - - PostgreSQL database. - type: array - description: >- - Optional. Database engines that should be profiled. Optional. - Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. description: >- - Requirements that must be true before a table is profiled for the first - time. - type: object - GooglePrivacyDlpV2ListDiscoveryConfigsResponse: + Publish the result summary of a DlpJob to [Security Command + Center](https://cloud.google.com/security-command-center). This action + is available for only projects that belong to an organization. This + action publishes the count of finding instances and their infoTypes. The + summary of findings are persisted in Security Command Center and are + governed by [service-specific policies for Security Command + Center](https://cloud.google.com/terms/service-terms). Only a single + instance of this action can be specified. Compatible with: Inspect + id: GooglePrivacyDlpV2PublishSummaryToCscc + properties: {} + GooglePrivacyDlpV2CreateStoredInfoTypeRequest: properties: - nextPageToken: + locationId: type: string + description: Deprecated. This field has no effect. + config: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + description: Required. Configuration of the storedInfoType to create. + storedInfoTypeId: description: >- - If the next page is available then this value is the next page token - to be used in the following ListDiscoveryConfigs request. - discoveryConfigs: - description: List of configs, up to page_size in ListDiscoveryConfigsRequest. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - type: array - id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse - description: Response message for ListDiscoveryConfigs. + The storedInfoType ID can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + type: string type: object - GooglePrivacyDlpV2UpdateConnectionRequest: + description: Request message for CreateStoredInfoType. + id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest + GooglePrivacyDlpV2CharsToIgnore: + id: GooglePrivacyDlpV2CharsToIgnore + description: >- + Characters to skip when doing deidentification of a value. These will be + left alone and skipped. type: object - id: GooglePrivacyDlpV2UpdateConnectionRequest - description: Request message for UpdateConnection. properties: - updateMask: - description: Optional. Mask to control which fields get updated. + charactersToSkip: type: string - format: google-fieldmask - connection: - description: Required. The connection with new values for the relevant fields. - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - GooglePrivacyDlpV2OtherInfoTypeSummary: - id: GooglePrivacyDlpV2OtherInfoTypeSummary - properties: - excludedFromAnalysis: - description: >- - Whether this infoType was excluded from sensitivity and risk - analysis due to factors such as low prevalence (subject to change). - type: boolean - infoType: - description: The other infoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - estimatedPrevalence: - description: >- - Approximate percentage of non-null rows that contained data detected - by this infotype. - type: integer - format: int32 - description: Infotype details for other infoTypes found within a column. - type: object - GooglePrivacyDlpV2DateTime: - type: object - description: Message for a date time object. e.g. 2018-01-01, 5th August. - properties: - date: - description: >- - One or more of the following must be set. Must be a valid date or - time value. - $ref: '#/components/schemas/GoogleTypeDate' - timeZone: - description: Time zone - $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' - dayOfWeek: - description: Day of week + description: Characters to not transform when masking. + commonCharactersToIgnore: type: string enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY + - COMMON_CHARS_TO_IGNORE_UNSPECIFIED + - NUMERIC + - ALPHA_UPPER_CASE + - ALPHA_LOWER_CASE + - PUNCTUATION + - WHITESPACE enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - time: - description: Time of day - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - id: GooglePrivacyDlpV2DateTime - GooglePrivacyDlpV2TransformationDetailsStorageConfig: - properties: - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + - Unused. + - 0-9 + - A-Z + - a-z + - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ + - Whitespace character, one of [ \t\n\x0B\f\r] description: >- - The BigQuery table in which to store the output. This may be an - existing table or in a new table in an existing dataset. If table_id - is not set a new one will be generated for you with the following - format: - dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. - Pacific time zone will be used for generating the date details. - id: GooglePrivacyDlpV2TransformationDetailsStorageConfig - type: object - description: Config for storing transformation details. - GooglePrivacyDlpV2CreateStoredInfoTypeRequest: - id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest - description: Request message for CreateStoredInfoType. + Common characters to not transform when masking. Useful to avoid + removing punctuation. + GoogleProtobufEmpty: + properties: {} + 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: GoogleProtobufEmpty type: object + GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: properties: - storedInfoTypeId: - type: string + maxProbability: + format: double + type: number + description: Always greater than or equal to min_probability. + minProbability: + description: Between 0 and 1. + format: double + type: number + bucketValueCount: description: >- - The storedInfoType ID can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - locationId: - description: Deprecated. This field has no effect. + Total number of distinct quasi-identifier tuple values in this + bucket. + format: int64 type: string - config: - description: Required. Configuration of the storedInfoType to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - GooglePrivacyDlpV2FixedSizeBucketingConfig: + bucketSize: + type: string + format: int64 + description: Number of records within these probability bounds. + bucketValues: + description: >- + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + type: array description: >- - Buckets values based on fixed size ranges. The Bucketing transformation - can provide all of this functionality, but requires more configuration. - This message is provided as a convenience to the user for simple - bucketing strategies. The transformed value will be a hyphenated string - of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and - upper_bound = 20, all values that are within this bucket will be - replaced with "10-20". This can be used on data of type: double, long. - If the bound Value type differs from the type of data being transformed, - we will first attempt converting the type of the data to be transformed - to match the type of the bound before comparing. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing - to learn more. + A DeltaPresenceEstimationHistogramBucket message with the following + values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means + that there are 42 records for which δ is in [0.1, 0.2). An important + particular case is when min_probability = max_probability = 1: then, + every individual who shares this quasi-identifier combination is in the + dataset. + id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket type: object - id: GooglePrivacyDlpV2FixedSizeBucketingConfig + GooglePrivacyDlpV2ImageRedactionConfig: + type: object + description: Configuration for determining how redaction of images should occur. properties: - upperBound: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + redactionColor: description: >- - Required. Upper bound value of buckets. All values greater than - upper_bound are grouped together into a single bucket; for example - if `upper_bound` = 89, then all values greater than 89 are replaced - with the value "89+". - lowerBound: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + The color to use when redacting content from an image. If not + specified, the default is black. + $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - Required. Lower bound value of buckets. All values less than - `lower_bound` are grouped together into a single bucket; for example - if `lower_bound` = 10, then all values less than 10 are replaced - with the value "-10". - bucketSize: - type: number - format: double + Only one per info_type should be provided per request. If not + specified, and redact_all_text is false, the DLP API will redact all + text that it matches against all info_types that are found, but not + specified in another ImageRedactionConfig. + redactAllText: + type: boolean description: >- - Required. Size of each bucket (except for minimum and maximum - buckets). So if `lower_bound` = 10, `upper_bound` = 89, and - `bucket_size` = 10, then the following buckets would be used: -10, - 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. - Precision up to 2 decimals works. - GooglePrivacyDlpV2CustomInfoType: + If true, all text found in the image, regardless whether it matches + an info_type, is redacted. Only one should be provided. + id: GooglePrivacyDlpV2ImageRedactionConfig + GooglePrivacyDlpV2InfoTypeSummary: properties: - regex: - description: Regular expression based CustomInfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + estimatedPrevalence: + type: integer + format: int32 + deprecated: true + description: Not populated for predicted infotypes. infoType: $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - CustomInfoType can either be a new infoType, or an extension of - built-in infoType, when the name matches one of existing infoTypes - and that infoType is specified in `InspectContent.info_types` field. - Specifying the latter adds findings to the one detected by the - system. If built-in info type is not specified in - `InspectContent.info_types` list then the name is treated as a - custom info type. - exclusionType: - enumDescriptions: - - >- - A finding of this custom info type will not be excluded from - results. - - >- - A finding of this custom info type will be excluded from final - results, but can still affect rule execution. + description: The infoType. + id: GooglePrivacyDlpV2InfoTypeSummary + description: The infoType details for this column. + type: object + GooglePrivacyDlpV2StoredInfoTypeVersion: + id: GooglePrivacyDlpV2StoredInfoTypeVersion + type: object + properties: + stats: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' + description: Statistics about this storedInfoType version. + config: + description: StoredInfoType configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + state: enum: - - EXCLUSION_TYPE_UNSPECIFIED - - EXCLUSION_TYPE_EXCLUDE - type: string - description: >- - If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a - finding to be returned. It still can be used for rules matching. - likelihood: + - STORED_INFO_TYPE_STATE_UNSPECIFIED + - PENDING + - READY + - FAILED + - INVALID type: string enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. + - Unused + - StoredInfoType version is being created. + - StoredInfoType version is ready for use. + - >- + StoredInfoType creation failed. All relevant error messages are + returned in the `StoredInfoTypeVersion` message. + - >- + StoredInfoType is no longer valid because artifacts stored in + user-controlled storage were modified. To fix an invalid + StoredInfoType, use the `UpdateStoredInfoType` method to create a + new version. description: >- - Likelihood to return for this CustomInfoType. This base value can be - altered by a detection rule if the finding meets the criteria - specified by the rule. Defaults to `VERY_LIKELY` if not specified. - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + Stored info type version state. Read-only, updated by the system + during dictionary creation. + errors: description: >- - Sensitivity for this CustomInfoType. If this CustomInfoType extends - an existing InfoType, the sensitivity here will take precedence over - that of the original InfoType. If unset for a CustomInfoType, it - will default to HIGH. This only applies to data profiling. - dictionary: - description: A list of phrases to detect as a CustomInfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - surrogateType: - description: >- - Message for detecting output from deidentification transformations - that support reversing. - $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' - detectionRules: - description: >- - Set of detection rules to apply to all findings of this - CustomInfoType. Rules are applied in order that they are specified. - Not supported for the `surrogate_type` CustomInfoType. + Errors that occurred when creating this storedInfoType version, or + anomalies detected in the storedInfoType data that render it + unusable. Only the five most recent errors will be displayed, with + the most recent error appearing first. For example, some of the data + for stored custom dictionaries is put in the user's Cloud Storage + bucket, and if this data is modified or deleted by the user or + another system, the dictionary becomes invalid. If any errors occur, + fix the problem indicated by the error message and use the + UpdateStoredInfoType API method to create another version of the + storedInfoType to continue using it, reusing the same `config` if it + was not the source of the error. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' - storedType: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + createTime: + format: google-datetime description: >- - Load an existing `StoredInfoType` resource for use in - `InspectDataSource`. Not currently supported in `InspectContent`. + Create timestamp of the version. Read-only, determined by the system + when the version is created. + type: string description: >- - Custom information type provided by the user. Used to find - domain-specific sensitive information configurable to the data in - question. - id: GooglePrivacyDlpV2CustomInfoType + Version of a StoredInfoType, including the configuration used to build + it, create timestamp, and current state. + GooglePrivacyDlpV2AllInfoTypes: type: object - GooglePrivacyDlpV2SchemaModifiedCadence: + description: Apply transformation to all findings. + properties: {} + id: GooglePrivacyDlpV2AllInfoTypes + GooglePrivacyDlpV2DataSourceType: properties: - types: - type: array - description: >- - The types of schema modifications to consider. Defaults to - NEW_COLUMNS. - items: - enum: - - SQL_SCHEMA_MODIFICATION_UNSPECIFIED - - NEW_COLUMNS - - REMOVED_COLUMNS - enumDescriptions: - - Unused. - - New columns have appeared. - - Columns have been removed from the table. - type: string - frequency: + dataSource: type: string description: >- - Frequency to regenerate data profiles when the schema is modified. - Defaults to monthly. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - id: GooglePrivacyDlpV2SchemaModifiedCadence - description: >- - How frequently to modify the profile when the table's schema is - modified. - type: object - GooglePrivacyDlpV2DeltaPresenceEstimationResult: + Output only. An identifying string to the type of resource being + profiled. Current values: * google/bigquery/table * google/project * + google/sql/table * google/gcs/bucket + readOnly: true type: object - description: >- - Result of the δ-presence computation. Note that these results are an - estimation, not exact values. - id: GooglePrivacyDlpV2DeltaPresenceEstimationResult + description: Message used to identify the type of resource being profiled. + id: GooglePrivacyDlpV2DataSourceType + GooglePrivacyDlpV2FileClusterSummary: properties: - deltaPresenceEstimationHistogram: - type: array + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' description: >- - The intervals [min_probability, max_probability) do not overlap. If - a value doesn't correspond to any such interval, the associated - frequency is zero. For example, the following records: - {min_probability: 0, max_probability: 0.1, frequency: 17} - {min_probability: 0.2, max_probability: 0.3, frequency: 42} - {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean - that there are no record with an estimated probability in [0.1, 0.2) - nor larger or equal to 0.4. + The data risk level of this cluster. RISK_LOW if nothing has been + scanned. + fileExtensionsSeen: + description: >- + A sample of file types seen in this cluster. Empty if no files were + seen. File extensions can be derived from the file name or the file + content. + type: array items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket - GooglePrivacyDlpV2HybridContentItem: - id: GooglePrivacyDlpV2HybridContentItem - description: >- - An individual hybrid item to inspect. Will be stored temporarily during - processing. - type: object - properties: - item: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - findingDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' - description: Supplementary information that will be added to each finding. - GooglePrivacyDlpV2InspectResult: - properties: - findingsTruncated: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' + fileStoreInfoTypeSummaries: + description: InfoTypes detected in this cluster. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' + noFilesExist: type: boolean description: >- - If true, then this item might have more findings than were returned, - and the findings returned are an arbitrary subset of all findings. - The findings list might be truncated because the input items were - too large, or because the server reached the maximum amount of - resources allowed for a single API call. For best results, divide - the input into smaller batches. - findings: + True if no files exist in this cluster. If the bucket had more files + than could be listed, this will be false even if no files for this + cluster were seen and file_extensions_seen is empty. + sensitivityScore: + description: >- + The sensitivity score of this cluster. The score will be + SENSITIVITY_LOW if nothing has been scanned. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + errors: + description: >- + A list of errors detected while scanning this cluster. The list is + truncated to 10 per cluster. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' - description: List of findings for an item. + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + fileExtensionsScanned: type: array - description: All the findings for a single scanned item. + description: >- + A sample of file types scanned in this cluster. Empty if no files + were scanned. File extensions can be derived from the file name or + the file content. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' + fileClusterType: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterType' + description: The file cluster type. + description: The file cluster summary. type: object - id: GooglePrivacyDlpV2InspectResult - GooglePrivacyDlpV2DiscoveryBigQueryFilter: + id: GooglePrivacyDlpV2FileClusterSummary + GooglePrivacyDlpV2RedactImageResponse: properties: - otherTables: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' - description: >- - Catch-all. This should always be the last filter in the list because - anything above it will apply first. Should only appear once in a - configuration. If none is specified, a default one will be added - automatically. - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableReference' + inspectResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' description: >- - The table to scan. Discovery configurations including this can only - include one DiscoveryTarget (the DiscoveryTarget with this - TableReference). - tables: + The findings. Populated when include_findings in the request is + true. + redactedImage: + type: string + description: The redacted image. The type will be the same as the original image. + format: byte + extractedText: description: >- - A specific set of tables for this filter to apply to. A table - collection must be specified in only one filter per config. If a - table id or dataset is empty, Cloud DLP assumes all tables in that - collection must be profiled. Must specify a project ID. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableCollection' - id: GooglePrivacyDlpV2DiscoveryBigQueryFilter + If an image was being inspected and the InspectConfig's + include_quote was set to true, then this field will include all + text, if any, that was found in the image. + type: string + description: Results of redacting an image. + id: GooglePrivacyDlpV2RedactImageResponse type: object - description: >- - Determines what tables will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID, dataset ID, and table ID. - GooglePrivacyDlpV2TransformationDescription: + GooglePrivacyDlpV2Schedule: + properties: + recurrencePeriodDuration: + type: string + description: >- + With this option a job is started on a regular periodic basis. For + example: every day (86400 seconds). A scheduled start time will be + skipped if the previous execution has not ended when its scheduled + time occurs. This value must be set to a time duration greater than + or equal to 1 day and can be no longer than 60 days. + format: google-duration + description: Schedule for inspect job triggers. + id: GooglePrivacyDlpV2Schedule type: object + GooglePrivacyDlpV2ContentItem: properties: - infoType: - description: Set if the transformation was limited to a specific `InfoType`. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - type: + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2Table' + description: >- + Structured content for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table + to learn more. + byteItem: + description: Content data to inspect or redact. Replaces `type` and `data`. + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + value: type: string - enum: - - TRANSFORMATION_TYPE_UNSPECIFIED - - RECORD_SUPPRESSION - - REPLACE_VALUE - - REPLACE_DICTIONARY - - REDACT - - CHARACTER_MASK - - CRYPTO_REPLACE_FFX_FPE - - FIXED_SIZE_BUCKETING - - BUCKETING - - REPLACE_WITH_INFO_TYPE - - TIME_PART - - CRYPTO_HASH - - DATE_SHIFT - - CRYPTO_DETERMINISTIC_CONFIG - - REDACT_IMAGE - description: The transformation type. - enumDescriptions: - - Unused - - Record suppression - - Replace value - - Replace value using a dictionary. - - Redact - - Character mask - - FFX-FPE - - Fixed size bucketing - - Bucketing - - Replace with info type - - Time part - - Crypto hash - - Date shift - - Deterministic crypto - - Redact image - description: - type: string - description: >- - A description of the transformation. This is empty for a - RECORD_SUPPRESSION, or is the output of calling toString() on the - `PrimitiveTransformation` protocol buffer message for any other type - of transformation. - condition: - type: string - description: >- - A human-readable string representation of the `RecordCondition` - corresponding to this transformation. Set if a `RecordCondition` was - used to determine whether or not to apply this transformation. - Examples: * (age_field > 85) * (age_field <= 18) * (zip_field - exists) * (zip_field == 01234) && (city_field != "Springville") * - (zip_field == 01234) && (age_field <= 18) && (city_field exists) - id: GooglePrivacyDlpV2TransformationDescription - description: >- - A flattened description of a `PrimitiveTransformation` or - `RecordSuppression`. - GooglePrivacyDlpV2CharsToIgnore: - description: >- - Characters to skip when doing deidentification of a value. These will be - left alone and skipped. + description: String data to inspect or redact. + id: GooglePrivacyDlpV2ContentItem + description: Type of content to inspect. type: object - id: GooglePrivacyDlpV2CharsToIgnore + GooglePrivacyDlpV2BoundingBox: + id: GooglePrivacyDlpV2BoundingBox + type: object + description: Bounding box encompassing detected text within an image. properties: - commonCharactersToIgnore: - enumDescriptions: - - Unused. - - 0-9 - - A-Z - - a-z - - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ - - Whitespace character, one of [ \t\n\x0B\f\r] - enum: - - COMMON_CHARS_TO_IGNORE_UNSPECIFIED - - NUMERIC - - ALPHA_UPPER_CASE - - ALPHA_LOWER_CASE - - PUNCTUATION - - WHITESPACE - description: >- - Common characters to not transform when masking. Useful to avoid - removing punctuation. - type: string - charactersToSkip: - type: string - description: Characters to not transform when masking. - GooglePrivacyDlpV2CreateInspectTemplateRequest: - id: GooglePrivacyDlpV2CreateInspectTemplateRequest + height: + description: Height of the bounding box in pixels. + format: int32 + type: integer + width: + type: integer + format: int32 + description: Width of the bounding box in pixels. + top: + format: int32 + description: Top coordinate of the bounding box. (0,0) is upper left. + type: integer + left: + format: int32 + description: Left coordinate of the bounding box. (0,0) is upper left. + type: integer + GooglePrivacyDlpV2UnwrappedCryptoKey: properties: - templateId: - description: >- - The template id can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: string - locationId: + key: + format: byte + description: Required. A 128/192/256 bit key. type: string - description: Deprecated. This field has no effect. - inspectTemplate: - description: Required. The InspectTemplate to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + id: GooglePrivacyDlpV2UnwrappedCryptoKey + description: >- + Using raw keys is prone to security risks due to accidentally leaking + the key. Choose another type of key if possible. type: object - description: Request message for CreateInspectTemplate. - GooglePrivacyDlpV2ListInfoTypesResponse: - id: GooglePrivacyDlpV2ListInfoTypesResponse + GooglePrivacyDlpV2InfoTypeDescription: + description: InfoType description. properties: - infoTypes: + categories: type: array - description: Set of sensitive infoTypes. + description: The category of the infoType. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' - description: Response to the ListInfoTypes request. - type: object - GooglePrivacyDlpV2ProjectDataProfile: - properties: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' sensitivityScore: $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity score of this project. - tableDataProfileCount: - type: string - description: The number of table data profiles generated for this project. - format: int64 - projectId: + description: The default sensitivity of the infoType. + supportedBy: + items: + enum: + - ENUM_TYPE_UNSPECIFIED + - INSPECT + - RISK_ANALYSIS + enumDescriptions: + - Unused. + - Supported by the inspect operations. + - Supported by the risk analysis operations. + type: string + type: array + description: Which parts of the API supports this InfoType. + description: type: string - description: Project ID or account that was profiled. + description: >- + Description of the infotype. Translated when language is provided in + the request. + versions: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' + description: A list of available versions for the infotype. name: - description: The resource name of the profile. - type: string - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level of this project. - fileStoreDataProfileCount: - format: int64 + description: Internal name of the infoType. type: string - description: The number of file store data profiles generated for this project. - profileStatus: - description: Success or error status of the last attempt to profile the project. - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - profileLastGenerated: - format: google-datetime - description: The last time the profile was generated. + displayName: type: string - description: >- - An aggregated profile for this project, based on the resources profiled - within it. + description: Human readable form of the infoType name. type: object - id: GooglePrivacyDlpV2ProjectDataProfile - GooglePrivacyDlpV2LDiversityConfig: - id: GooglePrivacyDlpV2LDiversityConfig + id: GooglePrivacyDlpV2InfoTypeDescription + GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: + properties: {} + id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog type: object - description: l-diversity metric, used for analysis of reidentification risk. + description: >- + Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag + templates are applied to the resource that Cloud DLP scanned. Data + Catalog tag templates are stored in the same project and region where + the BigQuery table exists. For Cloud DLP to create and apply the tag + template, the Cloud DLP service agent must have the + `roles/datacatalog.tagTemplateOwner` permission on the project. The tag + template contains fields summarizing the results of the DlpJob. Any + field values previously written by another DlpJob are deleted. InfoType + naming patterns are strictly enforced when using this feature. Findings + are persisted in Data Catalog storage and are governed by + service-specific policies for Data Catalog. For more information, see + [Service Specific Terms](https://cloud.google.com/terms/service-terms). + Only a single instance of this action can be specified. This action is + allowed only if all resources being scanned are BigQuery tables. + Compatible with: Inspect + GooglePrivacyDlpV2QuoteInfo: properties: - sensitiveAttribute: - description: Sensitive field for computing the l-value. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - quasiIds: - description: >- - Set of quasi-identifiers indicating how equivalence classes are - defined for the l-diversity computation. When multiple fields are - specified, they are considered a single composite key. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - GooglePrivacyDlpV2OutputStorageConfig: - description: Cloud repository for storing output. - id: GooglePrivacyDlpV2OutputStorageConfig + dateTime: + description: The date time indicated by the quote. + $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' + description: Message for infoType-dependent details parsed from quote. + id: GooglePrivacyDlpV2QuoteInfo type: object + GooglePrivacyDlpV2ExclusionRule: properties: - outputSchema: - enum: - - OUTPUT_SCHEMA_UNSPECIFIED - - BASIC_COLUMNS - - GCS_COLUMNS - - DATASTORE_COLUMNS - - BIG_QUERY_COLUMNS - - ALL_COLUMNS + matchingType: type: string - description: >- - Schema used for writing the findings for Inspect jobs. This field is - only used for Inspect and must be unspecified for Risk jobs. Columns - are derived from the `Finding` object. If appending to an existing - table, any columns from the predefined schema that are missing will - be added. No columns in the existing table will be deleted. If - unspecified, then all available columns will be used for a new table - or an (existing) table with no schema, and no changes will be made - to an existing table that has a schema. Only for use with external - storage. + enum: + - MATCHING_TYPE_UNSPECIFIED + - MATCHING_TYPE_FULL_MATCH + - MATCHING_TYPE_PARTIAL_MATCH + - MATCHING_TYPE_INVERSE_MATCH + description: How the rule is applied, see MatchingType documentation for details. enumDescriptions: - - Unused. + - Invalid. - >- - Basic schema including only `info_type`, `quote`, `certainty`, and - `timestamp`. - - Schema tailored to findings from scanning Cloud Storage. - - Schema tailored to findings from scanning Google Datastore. - - Schema tailored to findings from scanning Google BigQuery. - - Schema containing all columns. - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + Full match. - Dictionary: join of Dictionary results matched + complete finding quote - Regex: all regex matches fill a finding + quote start to end - Exclude info type: completely inside + affecting info types findings + - >- + Partial match. - Dictionary: at least one of the tokens in the + finding matches - Regex: substring of the finding matches - + Exclude info type: intersects with affecting info types findings + - >- + Inverse match. - Dictionary: no tokens in the finding match the + dictionary - Regex: finding doesn't match the regex - Exclude info + type: no intersection with affecting info types findings + excludeByHotword: description: >- - Store findings in an existing table or a new table in an existing - dataset. If table_id is not set a new one will be generated for you - with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. - Pacific time zone will be used for generating the date details. For - Inspect, each column in an existing output table must have the same - name, type, and mode of a field in the `Finding` object. For Risk, - an existing output table should be the output of a previous Risk - analysis job run on the same source table, with the same privacy - metric and quasi-identifiers. Risk jobs that analyze the same table - but compute a different privacy metric, or use different sets of - quasi-identifiers, cannot store their results in the same table. - GooglePrivacyDlpV2Table: - id: GooglePrivacyDlpV2Table + Drop if the hotword rule is contained in the proximate context. For + tabular data, the context includes the column name. + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' + regex: + description: Regular expression which defines the rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + excludeInfoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' + description: Set of infoTypes for which findings would affect this rule. + dictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + description: Dictionary which defines the rule. + id: GooglePrivacyDlpV2ExclusionRule + description: >- + The rule that specifies conditions when findings of infoTypes specified + in `InspectionRuleSet` are removed from results. + type: object + GooglePrivacyDlpV2CreateConnectionRequest: + properties: + connection: + description: Required. The connection resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' type: object + description: Request message for CreateConnection. + id: GooglePrivacyDlpV2CreateConnectionRequest + GooglePrivacyDlpV2StoredType: + description: A reference to a StoredInfoType to use with scanning. properties: - headers: - description: Headers of the table. + createTime: + format: google-datetime + description: >- + Timestamp indicating when the version of the `StoredInfoType` used + for inspection was created. Output-only field, populated by the + system. + type: string + name: + description: >- + Resource name of the requested `StoredInfoType`, for example + `organizations/433245324/storedInfoTypes/432452342` or + `projects/project-id/storedInfoTypes/432452342`. + type: string + type: object + id: GooglePrivacyDlpV2StoredType + GooglePrivacyDlpV2UpdateJobTriggerRequest: + properties: + updateMask: + format: google-fieldmask + type: string + description: Mask to control which fields get updated. + jobTrigger: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + description: New JobTrigger value. + id: GooglePrivacyDlpV2UpdateJobTriggerRequest + type: object + description: Request message for UpdateJobTrigger. + GooglePrivacyDlpV2DataProfileJobConfig: + type: object + properties: + inspectTemplates: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - rows: - description: Rows of the table. + type: string + description: >- + Detection logic for profile generation. Not all template features + are used by profiles. FindingLimits, include_quote and + exclude_info_types have no impact on data profiling. Multiple + templates may be provided if there is data in multiple regions. At + most one template must be specified per-region (including "global"). + Each region is scanned using the applicable template. If no + region-specific template is specified, but a "global" template is + specified, it will be copied to that region and used instead. If no + global or region-specific template is provided for a region with + data, that region's data will not be scanned. For more information, + see + https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + projectId: + type: string + description: >- + The project that will run the scan. The DLP service account that + exists within this project must have access to all resources that + are profiled, and the Cloud DLP API must be enabled. + location: + description: The data to scan. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' + dataProfileActions: + description: Actions to execute at the completion of the job. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Row' + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' type: array description: >- - Structured content to inspect. Up to 50,000 `Value`s per request - allowed. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table - to learn more. - GooglePrivacyDlpV2StoredInfoTypeVersion: + Configuration for setting up a job to scan resources for profile + generation. Only one data profile configuration may exist per + organization, folder, or project. The generated data profiles are + retained according to the [data retention policy] + (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + id: GooglePrivacyDlpV2DataProfileJobConfig + GooglePrivacyDlpV2DeidentifyTemplate: + type: object description: >- - Version of a StoredInfoType, including the configuration used to build - it, create timestamp, and current state. - id: GooglePrivacyDlpV2StoredInfoTypeVersion + DeidentifyTemplates contains instructions on how to de-identify content. + See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates + to learn more. + id: GooglePrivacyDlpV2DeidentifyTemplate properties: - state: + deidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + description: The core content of the template. + name: type: string - enumDescriptions: - - Unused - - StoredInfoType version is being created. - - StoredInfoType version is ready for use. - - >- - StoredInfoType creation failed. All relevant error messages are - returned in the `StoredInfoTypeVersion` message. - - >- - StoredInfoType is no longer valid because artifacts stored in - user-controlled storage were modified. To fix an invalid - StoredInfoType, use the `UpdateStoredInfoType` method to create a - new version. - enum: - - STORED_INFO_TYPE_STATE_UNSPECIFIED - - PENDING - - READY - - FAILED - - INVALID + readOnly: true description: >- - Stored info type version state. Read-only, updated by the system - during dictionary creation. - config: - description: StoredInfoType configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + Output only. The template name. The template will have one of the + following formats: + `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR + `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` createTime: + format: google-datetime type: string - description: >- - Create timestamp of the version. Read-only, determined by the system - when the version is created. + readOnly: true + description: Output only. The creation timestamp of an inspectTemplate. + displayName: + type: string + description: Display name (max 256 chars). + description: + description: Short description (max 256 chars). + type: string + updateTime: format: google-datetime - stats: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' - description: Statistics about this storedInfoType version. - errors: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + readOnly: true + type: string + description: Output only. The last update timestamp of an inspectTemplate. + GooglePrivacyDlpV2Proximity: + description: >- + Message for specifying a window around a finding to apply a detection + rule. + properties: + windowAfter: + type: integer + description: Number of characters after the finding to consider. + format: int32 + windowBefore: + type: integer description: >- - Errors that occurred when creating this storedInfoType version, or - anomalies detected in the storedInfoType data that render it - unusable. Only the five most recent errors will be displayed, with - the most recent error appearing first. For example, some of the data - for stored custom dictionaries is put in the user's Cloud Storage - bucket, and if this data is modified or deleted by the user or - another system, the dictionary becomes invalid. If any errors occur, - fix the problem indicated by the error message and use the - UpdateStoredInfoType API method to create another version of the - storedInfoType to continue using it, reusing the same `config` if it - was not the source of the error. + Number of characters before the finding to consider. For tabular + data, if you want to modify the likelihood of an entire column of + findngs, set this to 1. For more information, see [Hotword example: + Set the match likelihood of a table column] + (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + format: int32 type: object - GooglePrivacyDlpV2ExcludeInfoTypes: + id: GooglePrivacyDlpV2Proximity + GooglePrivacyDlpV2KMapEstimationQuasiIdValues: + description: A tuple of values for the quasi-identifier columns. type: object - description: List of excluded infoTypes. + id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues properties: - infoTypes: + estimatedAnonymity: + description: The estimated anonymity for these quasi-identifier values. + type: string + format: int64 + quasiIdsValues: + description: The quasi-identifier values. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' type: array + GooglePrivacyDlpV2QuasiId: + id: GooglePrivacyDlpV2QuasiId + description: A column with a semantic tag attached. + type: object + properties: + customTag: + type: string description: >- - InfoType list in ExclusionRule rule drops a finding when it overlaps - or contained within with a finding of an infoType from this list. - For example, for `InspectionRuleSet.info_types` containing - "PHONE_NUMBER"` and `exclusion_rule` containing - `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone - number findings are dropped if they overlap with EMAIL_ADDRESS - finding. That leads to "555-222-2222@example.org" to generate only a - single finding, namely email address. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - id: GooglePrivacyDlpV2ExcludeInfoTypes - GooglePrivacyDlpV2CloudSqlProperties: + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column (below). + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Required. Identifies the column. + infoType: + description: >- + A column can be tagged with a InfoType to use the relevant public + dataset as a statistical model of population, if available. We + currently support US ZIP codes, region codes, ages and genders. To + programmatically obtain the list of supported InfoTypes, use + ListInfoTypes with the supported_by=RISK_ANALYSIS filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + inferred: + $ref: '#/components/schemas/GoogleProtobufEmpty' + description: >- + If no semantic tag is indicated, we infer the statistical model from + the distribution of values in the input data + GooglePrivacyDlpV2LargeCustomDictionaryConfig: properties: - connectionName: + cloudStorageFileSet: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' description: >- - Optional. Immutable. The Cloud SQL instance for which the connection - is defined. Only one connection per instance is allowed. This can - only be set at creation time, and cannot be updated. It is an error - to use a connection_name from different project or region than the - one that holds the connection. For example, a Connection resource - for Cloud SQL connection_name `project-id:us-central1:sql-instance` - must be created under the parent - `projects/project-id/locations/us-central1` - type: string - usernamePassword: - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' - description: A username and password stored in Secret Manager. - cloudSqlIam: - description: Built-in IAM authentication (must be configured in Cloud SQL). - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' - maxConnections: + Set of files containing newline-delimited lists of dictionary + phrases. + outputPath: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' description: >- - Required. DLP will limit its connections to max_connections. Must be - 2 or greater. - type: integer - format: int32 - databaseEngine: - type: string + Location to store dictionary artifacts in Cloud Storage. These files + will only be accessible by project owners and the DLP API. If any of + these artifacts are modified, the dictionary is considered invalid + and can no longer be used. + bigQueryField: description: >- - Required. The database engine used by the Cloud SQL instance that - this connection configures. - enum: - - DATABASE_ENGINE_UNKNOWN - - DATABASE_ENGINE_MYSQL - - DATABASE_ENGINE_POSTGRES - enumDescriptions: - - >- - An engine that is not currently supported by Sensitive Data - Protection. - - Cloud SQL for MySQL instance. - - Cloud SQL for PostgreSQL instance. + Field in a BigQuery table where each cell represents a dictionary + phrase. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' + type: object + id: GooglePrivacyDlpV2LargeCustomDictionaryConfig + description: >- + Configuration for a custom dictionary created from a data source of any + size up to the maximum size defined in the + [limits](https://cloud.google.com/sensitive-data-protection/limits) + page. The artifacts of dictionary creation are stored in the specified + Cloud Storage location. Consider using `CustomInfoType.Dictionary` for + smaller dictionaries that satisfy the size requirements. + GooglePrivacyDlpV2RecordKey: + description: Message for a unique key indicating a record that contains a finding. + id: GooglePrivacyDlpV2RecordKey type: object - description: Cloud SQL connection properties. - id: GooglePrivacyDlpV2CloudSqlProperties - GooglePrivacyDlpV2LDiversityHistogramBucket: - id: GooglePrivacyDlpV2LDiversityHistogramBucket properties: - bucketValueCount: - type: string - format: int64 - description: Total number of distinct equivalence classes in this bucket. - sensitiveValueFrequencyUpperBound: - format: int64 + datastoreKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' + description: BigQuery key + idValues: + type: array + items: + type: string description: >- - Upper bound on the sensitive value frequencies of the equivalence - classes in this bucket. + Values of identifying columns in the given row. Order of values + matches the order of `identifying_fields` specified in the scanning + request. + bigQueryKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' + description: Datastore key + GooglePrivacyDlpV2Deidentify: + properties: + cloudStorageOutput: type: string - sensitiveValueFrequencyLowerBound: - format: int64 description: >- - Lower bound on the sensitive value frequencies of the equivalence - classes in this bucket. - type: string - bucketSize: - format: int64 - description: Total number of equivalence classes in this bucket. - type: string - bucketValues: + Required. User settable Cloud Storage bucket and folders to store + de-identified files. This field must be set for Cloud Storage + deidentification. The output Cloud Storage bucket must be different + from the input bucket. De-identified files will overwrite files in + the output path. Form of: gs://bucket/folder/ or gs://bucket + transformationConfig: description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. - type: array + User specified deidentify templates and configs for structured, + unstructured, and image files. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' + transformationDetailsStorageConfig: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig + description: >- + Config for storing transformation details. This is separate from the + de-identified content, and contains metadata about the successful + transformations and/or failures that occurred while de-identifying. + This needs to be set in order for users to access information about + the status of each transformation (see TransformationDetails message + for more information about what is noted). + fileTypesToTransform: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' + enumDescriptions: + - Includes all files. + - >- + Includes all file extensions not covered by another entry. + Binary scanning attempts to convert the content of the file to + utf_8 to scan the file. If you wish to avoid this fall back, + specify one or more of the other file types in your storage + scan. + - >- + Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, + cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, + go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, + mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, + rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, + xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, + md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, + xsd, yml, yaml. + - >- + Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting + bytes_limit_per_file or bytes_limit_per_file_percent has no + effect on image files. Image inspection is restricted to the + `global`, `us`, `asia`, and `europe` regions. + - >- + Microsoft Word files larger than 30 MB will be scanned as binary + files. Included file extensions: docx, dotx, docm, dotm. Setting + `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no + effect on Word files. + - >- + PDF files larger than 30 MB will be scanned as binary files. + Included file extensions: pdf. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PDF files. + - 'Included file extensions: avro' + - 'Included file extensions: csv' + - 'Included file extensions: tsv' + - >- + Microsoft PowerPoint files larger than 30 MB will be scanned as + binary files. Included file extensions: pptx, pptm, potx, potm, + pot. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PowerPoint + files. + - >- + Microsoft Excel files larger than 30 MB will be scanned as + binary files. Included file extensions: xlsx, xlsm, xltx, xltm. + Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` + has no effect on Excel files. + enum: + - FILE_TYPE_UNSPECIFIED + - BINARY_FILE + - TEXT_FILE + - IMAGE + - WORD + - PDF + - AVRO + - CSV + - TSV + - POWERPOINT + - EXCEL + type: string + description: >- + List of user-specified file type groups to transform. If specified, + only the files with these file types will be transformed. If empty, + all supported files will be transformed. Supported types may be + automatically added over time. If a file type is set in this field + that isn't supported by the Deidentify action then the job will fail + and will not be successfully created/started. Currently the only + file types supported are: IMAGES, TEXT_FILES, CSV, TSV. + type: array type: object - description: Histogram of l-diversity equivalence class sensitive value frequencies. - GooglePrivacyDlpV2InfoTypeCategory: + description: >- + Create a de-identified copy of the requested table or files. A + TransformationDetail will be created for each transformation. If any + rows in BigQuery are skipped during de-identification (transformation + errors or row size exceeds BigQuery insert API limits) they are placed + in the failure output table. If the original row exceeds the BigQuery + insert API limit it will be truncated when written to the failure output + table. The failure output table can be set in the + action.deidentify.output.big_query_output.deidentified_failure_output_table + field, if no table is set, a table will be automatically created in the + same project and dataset as the original table. Compatible with: Inspect + id: GooglePrivacyDlpV2Deidentify + GooglePrivacyDlpV2InspectContentRequest: + type: object + description: Request to search for potentially sensitive info in a ContentItem. properties: - typeCategory: - description: The class of identifiers where this infoType belongs + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: The item to inspect. + inspectTemplateName: + description: >- + Template to use. Any configuration directly specified in + inspect_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. type: string - enumDescriptions: - - Unused type - - >- - Personally identifiable information, for example, a name or phone - number - - >- - Personally identifiable information that is especially sensitive, - for example, a passport number. - - >- - Attributes that can partially identify someone, especially in - combination with other attributes, like age, height, and gender. - - Confidential or secret information, for example, a password. - - An identification document issued by a government. - - A document, for example, a resume or source code. - - >- - Information that is not sensitive on its own, but provides details - about the circumstances surrounding an entity or an event. - enum: - - TYPE_UNSPECIFIED - - PII - - SPII - - DEMOGRAPHIC - - CREDENTIAL - - GOVERNMENT_ID - - DOCUMENT - - CONTEXTUAL_INFORMATION - locationCategory: + locationId: + description: Deprecated. This field has no effect. type: string - enumDescriptions: - - Unused location - - >- - The infoType is not issued by or tied to a specific region, but is - used almost everywhere. - - The infoType is typically used in Argentina. - - The infoType is typically used in Armenia. - - The infoType is typically used in Australia. - - The infoType is typically used in Azerbaijan. - - The infoType is typically used in Belarus. - - The infoType is typically used in Belgium. - - The infoType is typically used in Brazil. - - The infoType is typically used in Canada. - - The infoType is typically used in Chile. - - The infoType is typically used in China. - - The infoType is typically used in Colombia. - - The infoType is typically used in Croatia. - - The infoType is typically used in Denmark. - - The infoType is typically used in France. - - The infoType is typically used in Finland. - - The infoType is typically used in Germany. - - The infoType is typically used in Hong Kong. - - The infoType is typically used in India. - - The infoType is typically used in Indonesia. - - The infoType is typically used in Ireland. - - The infoType is typically used in Israel. - - The infoType is typically used in Italy. - - The infoType is typically used in Japan. - - The infoType is typically used in Kazakhstan. - - The infoType is typically used in Korea. - - The infoType is typically used in Mexico. - - The infoType is typically used in the Netherlands. - - The infoType is typically used in New Zealand. - - The infoType is typically used in Norway. - - The infoType is typically used in Paraguay. - - The infoType is typically used in Peru. - - The infoType is typically used in Poland. - - The infoType is typically used in Portugal. - - The infoType is typically used in Russia. - - The infoType is typically used in Singapore. - - The infoType is typically used in South Africa. - - The infoType is typically used in Spain. - - The infoType is typically used in Sweden. - - The infoType is typically used in Switzerland. - - The infoType is typically used in Taiwan. - - The infoType is typically used in Thailand. - - The infoType is typically used in Turkey. - - The infoType is typically used in Ukraine. - - The infoType is typically used in the United Kingdom. - - The infoType is typically used in the United States. - - The infoType is typically used in Uruguay. - - The infoType is typically used in Uzbekistan. - - The infoType is typically used in Venezuela. - - The infoType is typically used in Google internally. - description: >- - The region or country that issued the ID or document represented by - the infoType. - enum: - - LOCATION_UNSPECIFIED - - GLOBAL - - ARGENTINA - - ARMENIA - - AUSTRALIA - - AZERBAIJAN - - BELARUS - - BELGIUM - - BRAZIL - - CANADA - - CHILE - - CHINA - - COLOMBIA - - CROATIA - - DENMARK - - FRANCE - - FINLAND - - GERMANY - - HONG_KONG - - INDIA - - INDONESIA - - IRELAND - - ISRAEL - - ITALY - - JAPAN - - KAZAKHSTAN - - KOREA - - MEXICO - - THE_NETHERLANDS - - NEW_ZEALAND - - NORWAY - - PARAGUAY - - PERU - - POLAND - - PORTUGAL - - RUSSIA - - SINGAPORE - - SOUTH_AFRICA - - SPAIN - - SWEDEN - - SWITZERLAND - - TAIWAN - - THAILAND - - TURKEY - - UKRAINE - - UNITED_KINGDOM - - UNITED_STATES - - URUGUAY - - UZBEKISTAN - - VENEZUELA - - INTERNAL - industryCategory: - enumDescriptions: - - Unused industry - - The infoType is typically used in the finance industry. - - The infoType is typically used in the health industry. - - The infoType is typically used in the telecommunications industry. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' description: >- - The group of relevant businesses where this infoType is commonly - used - type: string - enum: - - INDUSTRY_UNSPECIFIED - - FINANCE - - HEALTH - - TELECOMMUNICATIONS - id: GooglePrivacyDlpV2InfoTypeCategory - type: object + Configuration for the inspector. What specified here will override + the template referenced by the inspect_template_name argument. + id: GooglePrivacyDlpV2InspectContentRequest + GooglePrivacyDlpV2BigQueryTable: description: >- - Classification of infoTypes to organize them according to geographic - location, industry, and data type. - GooglePrivacyDlpV2InfoTypeSummary: - description: The infoType details for this column. - id: GooglePrivacyDlpV2InfoTypeSummary + Message defining the location of a BigQuery table. A table is uniquely + identified by its project_id, dataset_id, and table_name. Within a query + a table is often referenced with a string in the format of: `:.` or + `..`. + id: GooglePrivacyDlpV2BigQueryTable properties: - estimatedPrevalence: - format: int32 - deprecated: true - description: Not populated for predicted infotypes. - type: integer - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The infoType. + tableId: + type: string + description: Name of the table. + datasetId: + description: Dataset ID of the table. + type: string + projectId: + type: string + description: >- + The Google Cloud Platform project ID of the project containing the + table. If omitted, project ID is inferred from the API call. type: object - GooglePrivacyDlpV2FileStoreRegexes: - id: GooglePrivacyDlpV2FileStoreRegexes + GooglePrivacyDlpV2StorageMetadataLabel: description: >- - A collection of regular expressions to determine what file store to - match against. + Storage metadata label to indicate which metadata entry contains + findings. type: object properties: - patterns: - type: array - description: >- - Required. The group of regular expression patterns to match against - one or more file stores. Maximum of 100 entries. The sum of all - regular expression's length can't exceed 10 KiB. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegex' - GooglePrivacyDlpV2DeidentifyConfig: - description: The configuration that controls how the data will change. + key: + description: Label name. + type: string + id: GooglePrivacyDlpV2StorageMetadataLabel + GooglePrivacyDlpV2CreateInspectTemplateRequest: properties: - imageTransformations: - description: Treat the dataset as an image and redact. - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' - recordTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' - description: >- - Treat the dataset as structured. Transformations can be applied to - specific locations within structured datasets, such as transforming - a column within a table. - infoTypeTransformations: - description: >- - Treat the dataset as free-form text and apply the same free text - transformation everywhere. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - transformationErrorHandling: + locationId: + description: Deprecated. This field has no effect. + type: string + inspectTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + description: Required. The InspectTemplate to create. + templateId: description: >- - Mode for handling transformation errors. If left unspecified, the - default mode is `TransformationErrorHandling.ThrowError`. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' + The template id can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + type: string + id: GooglePrivacyDlpV2CreateInspectTemplateRequest + description: Request message for CreateInspectTemplate. type: object - id: GooglePrivacyDlpV2DeidentifyConfig - GooglePrivacyDlpV2PublishToChronicle: - properties: {} - description: Message expressing intention to publish to Google Security Operations. + GooglePrivacyDlpV2StoredInfoTypeConfig: + id: GooglePrivacyDlpV2StoredInfoTypeConfig + description: >- + Configuration for stored infoTypes. All fields and subfield are provided + by the user. For more information, see + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. type: object - id: GooglePrivacyDlpV2PublishToChronicle - GooglePrivacyDlpV2InspectTemplate: - id: GooglePrivacyDlpV2InspectTemplate properties: - displayName: - description: Display name (max 256 chars). - type: string - createTime: - type: string - format: google-datetime - readOnly: true - description: Output only. The creation timestamp of an inspectTemplate. description: - description: Short description (max 256 chars). type: string - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: >- - The core content of the template. Configuration of the scanning - process. - updateTime: - format: google-datetime - type: string - description: Output only. The last update timestamp of an inspectTemplate. - readOnly: true - name: - description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; + description: Description of the StoredInfoType (max 256 characters). + regex: + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + description: Store regular expression-based StoredInfoType. + displayName: type: string - readOnly: true - description: >- - The inspectTemplate contains a configuration (set of types of sensitive - data to be detected) to be used anywhere you otherwise would normally - specify InspectConfig. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. - type: object - GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: - id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails - description: Result of a risk analysis operation request. - type: object - properties: - requestedSourceTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Input dataset to compute metrics over. - categoricalStatsResult: - description: Categorical stats result - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' - kAnonymityResult: - description: K-anonymity result - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' - requestedPrivacyMetric: - description: Privacy metric to compute. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - numericalStatsResult: - description: Numerical stats result - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' - kMapEstimationResult: - description: K-map result - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' - requestedOptions: - description: The configuration used for this job. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' - lDiversityResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' - description: L-divesity result - deltaPresenceEstimationResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' - description: Delta-presence result - GooglePrivacyDlpV2InspectContentResponse: - properties: - result: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' - description: The findings. - id: GooglePrivacyDlpV2InspectContentResponse - type: object - description: Results of inspecting an item. - GooglePrivacyDlpV2PrimitiveTransformation: - description: A rule for transforming a value. - type: object - id: GooglePrivacyDlpV2PrimitiveTransformation - properties: - replaceDictionaryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' + description: Display name of the StoredInfoType (max 256 characters). + largeCustomDictionary: description: >- - Replace with a value randomly drawn (with replacement) from a - dictionary. - cryptoDeterministicConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' - description: Deterministic Crypto - bucketingConfig: - description: Bucketing - $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' - replaceWithInfoTypeConfig: - description: Replace with infotype - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' - characterMaskConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' - description: Mask - timePartConfig: - description: Time extraction - $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' - cryptoHashConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' - description: Crypto - redactConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' - description: Redact - dateShiftConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' - description: Date Shift - fixedSizeBucketingConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' - description: Fixed size bucketing - replaceConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' - description: Replace with a specified value. - cryptoReplaceFfxFpeConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' - description: Ffx-Fpe + StoredInfoType where findings are defined by a dictionary of + phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' + dictionary: + description: Store dictionary-based CustomInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' GooglePrivacyDlpV2DiscoveryCloudStorageConditions: properties: + includedBucketAttributes: + description: >- + Required. Only objects with the specified attributes will be + scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. + type: array + items: + enumDescriptions: + - Unused. + - Scan buckets regardless of the attribute. + - >- + Buckets with autoclass disabled + (https://cloud.google.com/storage/docs/autoclass). Only one of + AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. + - >- + Buckets with autoclass enabled + (https://cloud.google.com/storage/docs/autoclass). Only one of + AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning + Autoclass-enabled buckets can affect object storage classes. + type: string + enum: + - CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED + - ALL_SUPPORTED_BUCKETS + - AUTOCLASS_DISABLED + - AUTOCLASS_ENABLED includedObjectAttributes: description: >- Required. Only objects with the specified attributes will be @@ -1522,17 +1392,6 @@ components: [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no objects match the included_object_attributes. items: - type: string - enum: - - CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED - - ALL_SUPPORTED_OBJECTS - - STANDARD - - NEARLINE - - COLDLINE - - ARCHIVE - - REGIONAL - - MULTI_REGIONAL - - DURABLE_REDUCED_AVAILABILITY enumDescriptions: - Unused. - Scan objects regardless of the attribute. @@ -1551,964 +1410,786 @@ components: - >- Scan objects with the dual-regional storage class. This will incur retrieval fees. - type: array - includedBucketAttributes: - items: enum: - - CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED - - ALL_SUPPORTED_BUCKETS - - AUTOCLASS_DISABLED - - AUTOCLASS_ENABLED - enumDescriptions: - - Unused. - - Scan buckets regardless of the attribute. - - >- - Buckets with autoclass disabled - (https://cloud.google.com/storage/docs/autoclass). Only one of - AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. - - >- - Buckets with autoclass enabled - (https://cloud.google.com/storage/docs/autoclass). Only one of - AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning - Autoclass-enabled buckets can affect object storage classes. + - CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED + - ALL_SUPPORTED_OBJECTS + - STANDARD + - NEARLINE + - COLDLINE + - ARCHIVE + - REGIONAL + - MULTI_REGIONAL + - DURABLE_REDUCED_AVAILABILITY type: string type: array - description: >- - Required. Only objects with the specified attributes will be - scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. - id: GooglePrivacyDlpV2DiscoveryCloudStorageConditions + type: object description: >- Requirements that must be true before a Cloud Storage bucket or object is scanned in discovery for the first time. There is an AND relationship between the top-level attributes. - type: object - GooglePrivacyDlpV2Error: - type: object - id: GooglePrivacyDlpV2Error - description: >- - Details information about an error encountered during job execution or - the results of an unsuccessful activation of the JobTrigger. + id: GooglePrivacyDlpV2DiscoveryCloudStorageConditions + GooglePrivacyDlpV2Finding: + description: Represents a piece of potentially sensitive content. properties: - details: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Detailed error codes and messages. - timestamps: + findingId: + type: string + description: The unique finding id. + infoType: description: >- - The times the error occurred. List includes the oldest timestamp and - the last 9 timestamps. - items: - format: google-datetime - type: string - type: array - extraInfo: + The type of content that might have been found. Provided if + `excluded_types` is false. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + likelihood: + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY type: string + description: Confidence of how likely it is that the `info_type` is correct. enumDescriptions: - - Unused. - - Image scan is not available in the region. - - File store cluster is not supported for profile generation. - description: Additional information about the error. - enum: - - ERROR_INFO_UNSPECIFIED - - IMAGE_SCAN_UNAVAILABLE_IN_REGION - - FILE_STORE_CLUSTER_UNSUPPORTED - GooglePrivacyDlpV2DiscoveryCloudStorageFilter: - type: object - properties: - others: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + location: + description: Where the content was found. + $ref: '#/components/schemas/GooglePrivacyDlpV2Location' + jobCreateTime: + description: Time the job started that produced this finding. + type: string + format: google-datetime + jobName: + type: string + description: The job that stored the finding. + quoteInfo: description: >- - Optional. Catch-all. This should always be the last target in the - list because anything above it will apply first. Should only appear - once in a configuration. If none is specified, a default one will be - added automatically. - collection: - description: Optional. A specific set of buckets for this filter to apply to. - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreCollection' - cloudStorageResourceReference: + Contains data parsed from quotes. Only populated if include_quote + was set to true and a supported infoType was requested. Currently + supported infoTypes: DATE, DATE_OF_BIRTH and TIME. + $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' + name: description: >- - Optional. The bucket to scan. Targets including this can only - include one target (the target with this bucket). This enables - profiling the contents of a single bucket, while the other options - allow for easy profiling of many bucets within a project or an - organization. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageResourceReference' - id: GooglePrivacyDlpV2DiscoveryCloudStorageFilter - description: >- - Determines which buckets will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID and bucket name. - GooglePrivacyDlpV2BigQueryTable: - type: object - id: GooglePrivacyDlpV2BigQueryTable - properties: - tableId: + Resource name in format + projects/{project}/locations/{location}/findings/{finding} Populated + only when viewing persisted findings. type: string - description: Name of the table. - projectId: + triggerName: + description: Job trigger name, if applicable, for this finding. + type: string + createTime: + type: string + description: Timestamp when finding was detected. + format: google-datetime + resourceName: + description: The job that stored the finding. type: string + labels: + type: object + additionalProperties: + type: string description: >- - The Google Cloud Platform project ID of the project containing the - table. If omitted, project ID is inferred from the API call. - datasetId: - description: Dataset ID of the table. + The labels associated with this `Finding`. Label keys must be + between 1 and 63 characters long and must conform to the following + regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must + be between 0 and 63 characters long and must conform to the regular + expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels + can be associated with a given finding. Examples: * `"environment" : + "production"` * `"pipeline" : "etl"` + quote: type: string - description: >- - Message defining the location of a BigQuery table. A table is uniquely - identified by its project_id, dataset_id, and table_name. Within a query - a table is often referenced with a string in the format of: `:.` or - `..`. - GooglePrivacyDlpV2ListTableDataProfilesResponse: - id: GooglePrivacyDlpV2ListTableDataProfilesResponse + description: >- + The content that was found. Even if the content is not textual, it + may be converted to a textual representation here. Provided if + `include_quote` is true and the finding is less than or equal to + 4096 bytes long. If the finding exceeds 4096 bytes in length, the + quote may be omitted. type: object - properties: - tableDataProfiles: - description: List of data profiles. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - nextPageToken: - type: string - description: The next page token. - description: List of profiles generated for a given organization or project. - GooglePrivacyDlpV2TransformationDetails: + id: GooglePrivacyDlpV2Finding + GooglePrivacyDlpV2DiscoveryConfig: type: object - id: GooglePrivacyDlpV2TransformationDetails + description: >- + Configuration for discovery to scan resources for profile generation. + Only one discovery configuration may exist per organization, folder, or + project. The generated data profiles are retained according to the [data + retention policy] + (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + id: GooglePrivacyDlpV2DiscoveryConfig properties: - statusDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' + updateTime: + readOnly: true + type: string + description: Output only. The last update timestamp of a DiscoveryConfig. + format: google-datetime + targets: description: >- - Status of the transformation, if transformation was not successful, - this will specify what caused it to fail, otherwise it will show - that the transformation was successful. - transformedBytes: + Target to match against for determining what to scan and how + frequently. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' + type: array + name: description: >- - The number of bytes that were transformed. If transformation was - unsuccessful or did not take place because there was no content to - transform, this will be zero. + Unique resource name for the DiscoveryConfig, assigned by the + service when the DiscoveryConfig is created, for example + `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. type: string - format: int64 - resourceName: + orgConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' + description: Only set when the parent is an org. + status: + description: Required. A status for this configuration. type: string - description: The name of the job that completed the transformation. - transformationLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' - description: >- - The precise location of the transformed content in the original - container. - transformation: - description: >- - Description of transformation. This would only contain more than one - element if there were multiple matching transformations and which - one to apply was ambiguous. Not set for states that contain no - transformation, currently only state that contains no transformation - is TransformationResultStateType.METADATA_UNRETRIEVABLE. + enum: + - STATUS_UNSPECIFIED + - RUNNING + - PAUSED + enumDescriptions: + - Unused + - The discovery config is currently active. + - The discovery config is paused temporarily. + createTime: + format: google-datetime + description: Output only. The creation timestamp of a DiscoveryConfig. + type: string + readOnly: true + errors: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + readOnly: true + description: >- + Output only. A stream of errors encountered when the config was + activated. Repeated errors may result in the config automatically + being paused. Output only field. Will return the last 100 errors. + Whenever the config is modified this list will be cleared. type: array - containerName: + actions: + description: Actions to execute at the completion of scanning. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + lastRunTime: + format: google-datetime + readOnly: true + description: >- + Output only. The timestamp of the last time this config was + executed. type: string + displayName: + type: string + description: Display name (max 100 chars) + inspectTemplates: + items: + type: string description: >- - The top level name of the container where the transformation is - located (this will be the source file name or table name). - description: >- - Details about a single transformation. This object contains a - description of the transformation, information about whether the - transformation was successfully applied, and the precise location where - the transformation occurred. These details are stored in a - user-specified BigQuery table. - GooglePrivacyDlpV2LeaveUntransformed: + Detection logic for profile generation. Not all template features + are used by Discovery. FindingLimits, include_quote and + exclude_info_types have no impact on Discovery. Multiple templates + may be provided if there is data in multiple regions. At most one + template must be specified per-region (including "global"). Each + region is scanned using the applicable template. If no + region-specific template is specified, but a "global" template is + specified, it will be copied to that region and used instead. If no + global or region-specific template is provided for a region with + data, that region's data will not be scanned. For more information, + see + https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + type: array + GooglePrivacyDlpV2LDiversityConfig: + id: GooglePrivacyDlpV2LDiversityConfig + description: l-diversity metric, used for analysis of reidentification risk. type: object - properties: {} - description: >- - Skips the data without modifying it if the requested transformation - would cause an error. For example, if a `DateShift` transformation were - applied an an IP address, this mode would leave the IP address unchanged - in the response. - id: GooglePrivacyDlpV2LeaveUntransformed - GooglePrivacyDlpV2Action: - description: >- - A task to execute on the completion of a job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-actions - to learn more. properties: - publishSummaryToCscc: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' - description: Publish summary to Cloud Security Command Center (Alpha). - saveFindings: - $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' - description: Save resulting findings in a provided location. - jobNotificationEmails: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobNotificationEmails' + quasiIds: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Sends an email when the job completes. The email goes to IAM project - owners and technical [Essential - Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). - publishFindingsToCloudDataCatalog: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog - description: Publish findings to Cloud Datahub. - pubSub: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' - description: Publish a notification to a Pub/Sub topic. - deidentify: - $ref: '#/components/schemas/GooglePrivacyDlpV2Deidentify' - description: Create a de-identified copy of the input data. - publishToStackdriver: - description: Enable Stackdriver metric dlp.googleapis.com/finding_count. - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' - type: object - id: GooglePrivacyDlpV2Action - GooglePrivacyDlpV2AllOtherDatabaseResources: - description: Match database resources not covered by any other filter. - id: GooglePrivacyDlpV2AllOtherDatabaseResources - type: object - properties: {} - GooglePrivacyDlpV2CloudSqlDiscoveryTarget: - description: Target used to match against for discovery with Cloud SQL tables. - id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget + Set of quasi-identifiers indicating how equivalence classes are + defined for the l-diversity computation. When multiple fields are + specified, they are considered a single composite key. + type: array + sensitiveAttribute: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Sensitive field for computing the l-value. + GooglePrivacyDlpV2ExcludeByHotword: + id: GooglePrivacyDlpV2ExcludeByHotword type: object properties: - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Disable profiling for database resources that match this filter. - filter: - description: >- - Required. The tables the discovery cadence applies to. The first - target with a matching filter will be the one to apply to a table. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlFilter' - generationCadence: - description: >- - How often and when to update profiles. New tables that match both - the filter and conditions are scanned as quickly as possible - depending on system capacity. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' - description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - GooglePrivacyDlpV2LDiversityResult: - id: GooglePrivacyDlpV2LDiversityResult - properties: - sensitiveValueFrequencyHistogramBuckets: - type: array + proximity: + $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' description: >- - Histogram of l-diversity equivalence class sensitive value - frequencies. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' - description: Result of the l-diversity computation. - type: object - GooglePrivacyDlpV2Proximity: + Range of characters within which the entire hotword must reside. The + total length of the window cannot exceed 1000 characters. The + windowBefore property in proximity should be set to 1 if the hotword + needs to be included in a column header. + hotwordRegex: + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + description: Regular expression pattern defining what qualifies as a hotword. description: >- - Message for specifying a window around a finding to apply a detection - rule. - properties: - windowAfter: - type: integer - format: int32 - description: Number of characters after the finding to consider. - windowBefore: - format: int32 - type: integer - description: >- - Number of characters before the finding to consider. For tabular - data, if you want to modify the likelihood of an entire column of - findngs, set this to 1. For more information, see [Hotword example: - Set the match likelihood of a table column] - (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - id: GooglePrivacyDlpV2Proximity - type: object - GooglePrivacyDlpV2LargeCustomDictionaryStats: + The rule to exclude findings based on a hotword. For record inspection + of tables, column names are considered hotwords. An example of this is + to exclude a finding if it belongs to a BigQuery column that matches a + specific pattern. + GooglePrivacyDlpV2CloudStorageFileSet: + id: GooglePrivacyDlpV2CloudStorageFileSet type: object properties: - approxNumPhrases: - format: int64 - description: Approximate number of distinct phrases in the dictionary. + url: type: string - description: Summary statistics of a custom dictionary. - id: GooglePrivacyDlpV2LargeCustomDictionaryStats - GooglePrivacyDlpV2KMapEstimationConfig: - description: >- - Reidentifiability metric. This corresponds to a risk model similar to - what is called "journalist risk" in the literature, except the attack - dataset is statistically modeled instead of being perfectly known. This - can be done using publicly available data (like the US Census), or using - a custom statistical model (indicated as one or several BigQuery - tables), or by extrapolating from the distribution of values in the - input dataset. - id: GooglePrivacyDlpV2KMapEstimationConfig + description: >- + The url, in the format `gs:///`. Trailing wildcard in the path is + allowed. + description: Message representing a set of files in Cloud Storage. + GooglePrivacyDlpV2DatabaseResourceRegex: + type: object properties: - auxiliaryTables: + instanceRegex: description: >- - Several auxiliary tables can be used in the analysis. Each - custom_tag used to tag a quasi-identifiers column must appear in - exactly one column of one auxiliary table. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' - type: array - quasiIds: + Regex to test the instance name against. If empty, all instances + match. + type: string + projectIdRegex: description: >- - Required. Fields considered to be quasi-identifiers. No two columns - can have the same tag. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' - regionCode: + For organizations, if unset, will match all projects. Has no effect + for configurations created within a project. type: string + databaseRegex: description: >- - ISO 3166-1 alpha-2 region code to use in the statistical modeling. - Set if no column is tagged with a region-specific InfoType (like - US_ZIP_5) or a region code. - type: object - GooglePrivacyDlpV2UpdateInspectTemplateRequest: - id: GooglePrivacyDlpV2UpdateInspectTemplateRequest - description: Request message for UpdateInspectTemplate. - properties: - inspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - description: New InspectTemplate value. - updateMask: - format: google-fieldmask - description: Mask to control which fields get updated. + Regex to test the database name against. If empty, all databases + match. type: string - type: object - GooglePrivacyDlpV2QuasiId: + databaseResourceNameRegex: + type: string + description: >- + Regex to test the database resource's name against. An example of a + database resource name is a table's name. Other database resource + names like view names could be included in the future. If empty, all + database resources match. + description: >- + A pattern to match against one or more database resources. At least one + pattern must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + id: GooglePrivacyDlpV2DatabaseResourceRegex + GooglePrivacyDlpV2QuasiIdentifierField: + description: >- + A quasi-identifier column has a custom_tag, used to know which column in + the data corresponds to which column in the statistical model. properties: field: - description: Required. Identifies the column. $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - infoType: - description: >- - A column can be tagged with a InfoType to use the relevant public - dataset as a statistical model of population, if available. We - currently support US ZIP codes, region codes, ages and genders. To - programmatically obtain the list of supported InfoTypes, use - ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: Identifies the column. customTag: type: string description: >- A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below). - inferred: - description: >- - If no semantic tag is indicated, we infer the statistical model from - the distribution of values in the input data - $ref: '#/components/schemas/GoogleProtobufEmpty' type: object - description: A column with a semantic tag attached. - id: GooglePrivacyDlpV2QuasiId - GooglePrivacyDlpV2BigQueryRegexes: + id: GooglePrivacyDlpV2QuasiIdentifierField + GooglePrivacyDlpV2RecordLocation: type: object - description: >- - A collection of regular expressions to determine what tables to match - against. - id: GooglePrivacyDlpV2BigQueryRegexes + id: GooglePrivacyDlpV2RecordLocation + description: Location of a finding within a row or record. properties: - patterns: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' + recordKey: + description: Key of the finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' + fieldId: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Field id of the field containing the finding. + tableLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' + description: Location within a `ContentItem.Table`. + GooglePrivacyDlpV2ListDlpJobsResponse: + description: The response message for listing DLP jobs. + properties: + nextPageToken: + description: The standard List next-page token. + type: string + jobs: type: array - description: >- - A single BigQuery regular expression pattern to match against one or - more tables, datasets, or projects that contain BigQuery tables. - GooglePrivacyDlpV2FindingLimits: - id: GooglePrivacyDlpV2FindingLimits - description: >- - Configuration to control the number of findings returned for inspection. - This is not used for de-identification or data profiling. When redacting - sensitive data from images, finding limits don't apply. They can cause - unexpected or inconsistent results, where only some data is redacted. - Don't include finding limits in RedactImage requests. Otherwise, Cloud - DLP returns an error. + description: A list of DlpJobs that matches the specified filter in the request. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + id: GooglePrivacyDlpV2ListDlpJobsResponse + type: object + GooglePrivacyDlpV2LDiversityEquivalenceClass: type: object properties: - maxFindingsPerItem: - type: integer - format: int32 - description: >- - Max number of findings that are returned for each item scanned. When - set within an InspectContentRequest, this field is ignored. This - value isn't a hard limit. If the number of findings for an item - reaches this limit, the inspection of that item ends gradually, not - abruptly. Therefore, the actual number of findings that Cloud DLP - returns for the item can be multiple times higher than this value. - maxFindingsPerRequest: - format: int32 - description: >- - Max number of findings that are returned per request or job. If you - set this field in an InspectContentRequest, the resulting maximum - value is the value that you set or 3,000, whichever is lower. This - value isn't a hard limit. If an inspection reaches this limit, the - inspection ends gradually, not abruptly. Therefore, the actual - number of findings that Cloud DLP returns can be multiple times - higher than this value. - type: integer - maxFindingsPerInfoType: + quasiIdsValues: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' - description: Configuration of findings limit given for specified infoTypes. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: >- + Quasi-identifier values defining the k-anonymity equivalence class. + The order is always the same as the original request. type: array - GooglePrivacyDlpV2TransformationLocation: + topSensitiveValues: + type: array + description: Estimated frequencies of top sensitive values. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + equivalenceClassSize: + format: int64 + description: Size of the k-anonymity equivalence class. + type: string + numDistinctSensitiveValues: + format: int64 + description: Number of distinct sensitive values in this equivalence class. + type: string + id: GooglePrivacyDlpV2LDiversityEquivalenceClass + description: The set of columns' values that share the same ldiversity value. + GooglePrivacyDlpV2LDiversityResult: + id: GooglePrivacyDlpV2LDiversityResult + type: object properties: - recordTransformation: + sensitiveValueFrequencyHistogramBuckets: description: >- - For record transformations, provide a field and container - information. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' - containerType: - type: string - description: >- - Information about the functionality of the container where this - finding occurred, if available. + Histogram of l-diversity equivalence class sensitive value + frequencies. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' + description: Result of the l-diversity computation. + GooglePrivacyDlpV2DataProfilePubSubMessage: + description: >- + Pub/Sub topic message for a DataProfileAction.PubSubNotification event. + To receive a message of protocol buffer schema type, convert the message + data to an object of this proto class. + properties: + event: + description: The event that caused the Pub/Sub message to be sent. + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED enumDescriptions: - Unused. - - Body of a file. - - Metadata for a file. - - A table. - enum: - - TRANSFORM_UNKNOWN_CONTAINER - - TRANSFORM_BODY - - TRANSFORM_METADATA - - TRANSFORM_TABLE - findingId: + - New profile (not a re-profile). + - >- + One of the following profile metrics changed: Data risk score, + Sensitivity score, Resource visibility, Encryption type, Predicted + infoTypes, Other infoTypes + - Table data risk score or sensitivity score increased. + - A user (non-internal) error occurred. type: string + fileStoreProfile: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' description: >- - For infotype transformations, link to the corresponding findings ID - so that location information does not need to be duplicated. Each - findings ID correlates to an entry in the findings output table, - this table only gets created when users specify to save findings - (add the save findings action to the request). - description: Specifies the location of a transformation. - type: object - id: GooglePrivacyDlpV2TransformationLocation - GooglePrivacyDlpV2Row: - properties: - values: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Individual cells. - id: GooglePrivacyDlpV2Row - description: Values of the row. + If `DetailLevel` is `FILE_STORE_PROFILE` this will be fully + populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only + `name` and `file_store_path` will be populated. + profile: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + description: >- + If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. + Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and + `full_resource` will be populated. type: object - GooglePrivacyDlpV2SelectedInfoTypes: - description: Apply transformation to the selected info_types. - id: GooglePrivacyDlpV2SelectedInfoTypes + id: GooglePrivacyDlpV2DataProfilePubSubMessage + GooglePrivacyDlpV2SecretManagerCredential: properties: - infoTypes: + username: + type: string + description: Required. The username. + passwordSecretVersionName: description: >- - Required. InfoTypes to apply the transformation to. Required. - Provided InfoType must be unique within the ImageTransformations - message. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + Required. The name of the Secret Manager resource that stores the + password, in the form + `projects/project-id/secrets/secret-name/versions/version`. + type: string + description: >- + A credential consisting of a username and password, where the password + is stored in a Secret Manager resource. Note: Secret Manager [charges + apply](https://cloud.google.com/secret-manager/pricing). type: object - GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: + id: GooglePrivacyDlpV2SecretManagerCredential + GooglePrivacyDlpV2DlpJob: + description: Combines all of the information about a DLP job. type: object - description: The cadence at which to update data profiles when a schema is modified. properties: - types: + lastModified: + type: string + description: Time when the job was last modified by the system. + format: google-datetime + riskDetails: + description: Results from analyzing risk of a data source. + $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' + inspectDetails: + description: Results from inspecting a data source. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' + name: + type: string + description: The server-assigned name. + jobTriggerName: + type: string description: >- - The type of events to consider when deciding if the table's schema - has been modified and should have the profile updated. Defaults to - NEW_COLUMNS. + If created by a job trigger, the resource name of the trigger that + instantiated the job. + createTime: + format: google-datetime + type: string + description: Time when the job was created. + errors: + description: A stream of errors encountered running the job. type: array items: - enum: - - SCHEMA_MODIFICATION_UNSPECIFIED - - SCHEMA_NEW_COLUMNS - - SCHEMA_REMOVED_COLUMNS - type: string - enumDescriptions: - - Unused - - >- - Profiles should be regenerated when new columns are added to the - table. Default. - - >- - Profiles should be regenerated when columns are removed from the - table. - frequency: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + startTime: + format: google-datetime + description: Time when the job started. + type: string + endTime: type: string - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - description: >- - How frequently profiles may be updated when schemas are modified. - Defaults to monthly. - id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - GooglePrivacyDlpV2Value: - type: object - properties: - timestampValue: format: google-datetime - description: timestamp + description: Time when the job finished. + actionDetails: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' + description: Events that should occur after the job has completed. + type: type: string - dateValue: - description: date - $ref: '#/components/schemas/GoogleTypeDate' - dayOfWeekValue: + enumDescriptions: + - Defaults to INSPECT_JOB. + - The job inspected Google Cloud for sensitive data. + - The job executed a Risk Analysis computation. + description: The type of job. enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY + - DLP_JOB_TYPE_UNSPECIFIED + - INSPECT_JOB + - RISK_ANALYSIS_JOB + state: + enum: + - JOB_STATE_UNSPECIFIED + - PENDING + - RUNNING + - DONE + - CANCELED + - FAILED + - ACTIVE enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - type: string - description: day of week - stringValue: - description: string - type: string - booleanValue: - description: boolean - type: boolean - timeValue: - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - description: time of day - floatValue: - format: double - description: float - type: number - integerValue: - format: int64 - description: integer + - Unused. + - The job has not yet started. + - >- + The job is currently running. Once a job has finished it will + transition to FAILED or DONE. + - The job is no longer running. + - The job was canceled before it could be completed. + - The job had an error and did not complete. + - >- + The job is currently accepting findings via hybridInspect. A + hybrid job in ACTIVE state may continue to have findings added to + it through the calling of hybridInspect. After the job has + finished no more calls to hybridInspect may be made. ACTIVE jobs + can transition to DONE. + description: State of a job. type: string + id: GooglePrivacyDlpV2DlpJob + GooglePrivacyDlpV2TimespanConfig: + id: GooglePrivacyDlpV2TimespanConfig description: >- - Set of primitive values supported by the system. Note that for the - purposes of inspection or transformation, the number of bytes considered - to comprise a 'Value' is based on its representation as a UTF-8 encoded - string. For example, if 'integer_value' is set to 123456789, the number - of bytes would be counted as 9, even though an int64 only holds up to 8 - bytes of data. - id: GooglePrivacyDlpV2Value - GooglePrivacyDlpV2CloudStorageRegex: - description: >- - A pattern to match against one or more file stores. At least one pattern - must be specified. Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. + Configuration of the timespan of the items to include in scanning. + Currently only supported when inspecting Cloud Storage and BigQuery. + type: object properties: - bucketNameRegex: - type: string + enableAutoPopulationOfTimespanConfig: + type: boolean description: >- - Optional. Regex to test the bucket name against. If empty, all - buckets match. Example: "marketing2021" or "(marketing)\d{4}" will - both match the bucket gs://marketing2021 - projectIdRegex: + When the job is started by a JobTrigger we will automatically figure + out a valid start_time to avoid scanning files that have not been + modified since the last time the JobTrigger executed. This will be + based on the time of the execution of the last run of the JobTrigger + or the timespan end_time used in the last run of the JobTrigger. + **For BigQuery** Inspect jobs triggered by automatic population will + scan data that is at least three hours old when the job starts. This + is because streaming buffer rows are not read during inspection and + reading up to the current timestamp will result in skipped rows. See + the [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) + related to this operation. + timestampField: + description: >- + Specification of the field containing the timestamp of scanned + items. Used for data sources like Datastore and BigQuery. **For + BigQuery** If this value is not specified and the table was modified + between the given start and end times, the entire table will be + scanned. If this value is specified, then rows are filtered based on + the given start and end times. Rows with a `NULL` value in the + provided BigQuery column are skipped. Valid data types of the + provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and + `DATETIME`. If your BigQuery table is [partitioned at ingestion + time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), + you can use any of the following pseudo-columns as your timestamp + field. When used with Cloud DLP, these pseudo-column names are case + sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - + `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, + then entities are filtered based on the given start and end times. + If an entity does not contain the provided timestamp property or + contains empty or invalid values, then it is included. Valid data + types of the provided timestamp property are: `TIMESTAMP`. See the + [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) + related to this operation. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + endTime: + description: >- + Exclude files, tables, or rows newer than this value. If not set, no + upper time limit is applied. + format: google-datetime type: string - description: Optional. For organizations, if unset, will match all projects. - type: object - id: GooglePrivacyDlpV2CloudStorageRegex - GooglePrivacyDlpV2Regex: - properties: - pattern: + startTime: + format: google-datetime type: string description: >- - Pattern defining the regular expression. Its syntax - (https://github.com/google/re2/wiki/Syntax) can be found under the - google/re2 repository on GitHub. - groupIndexes: - description: >- - The index of the submatch to extract as findings. When not - specified, the entire match is returned. No more than 3 may be - included. - items: - type: integer - format: int32 - type: array - id: GooglePrivacyDlpV2Regex - description: Message defining a custom regular expression. - type: object - GooglePrivacyDlpV2DataProfileJobConfig: - description: >- - Configuration for setting up a job to scan resources for profile - generation. Only one data profile configuration may exist per - organization, folder, or project. The generated data profiles are - retained according to the [data retention policy] - (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + Exclude files, tables, or rows older than this value. If not set, no + lower time limit is applied. + GooglePrivacyDlpV2CreateJobTriggerRequest: type: object - id: GooglePrivacyDlpV2DataProfileJobConfig + description: Request message for CreateJobTrigger. properties: - inspectTemplates: - description: >- - Detection logic for profile generation. Not all template features - are used by profiles. FindingLimits, include_quote and - exclude_info_types have no impact on data profiling. Multiple - templates may be provided if there is data in multiple regions. At - most one template must be specified per-region (including "global"). - Each region is scanned using the applicable template. If no - region-specific template is specified, but a "global" template is - specified, it will be copied to that region and used instead. If no - global or region-specific template is provided for a region with - data, that region's data will not be scanned. For more information, - see - https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. - items: - type: string - type: array - dataProfileActions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - type: array - description: Actions to execute at the completion of the job. - location: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' - description: The data to scan. - projectId: + jobTrigger: + description: Required. The JobTrigger to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + locationId: + type: string + description: Deprecated. This field has no effect. + triggerId: description: >- - The project that will run the scan. The DLP service account that - exists within this project must have access to all resources that - are profiled, and the Cloud DLP API must be enabled. + The trigger id can contain uppercase and lowercase letters, numbers, + and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - GooglePrivacyDlpV2OrConditions: - id: GooglePrivacyDlpV2OrConditions + id: GooglePrivacyDlpV2CreateJobTriggerRequest + GooglePrivacyDlpV2CharacterMaskConfig: + id: GooglePrivacyDlpV2CharacterMaskConfig properties: - minRowCount: + maskingCharacter: + type: string description: >- - Minimum number of rows that should be present before Cloud DLP - profiles a table - format: int32 + Character to use to mask the sensitive values—for example, `*` for + an alphabetic string such as a name, or `0` for a numeric string + such as ZIP code or credit card number. This string must have a + length of 1. If not supplied, this value defaults to `*` for + strings, and `0` for digits. + numberToMask: + description: >- + Number of characters to mask. If not set, all matching chars will be + masked. Skipped characters do not count towards this tally. If + `number_to_mask` is negative, this denotes inverse masking. Cloud + DLP masks all but a number of characters. For example, suppose you + have the following values: - `masking_character` is `*` - + `number_to_mask` is `-4` - `reverse_order` is `false` - + `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` + The resulting de-identified string is `****-****-****-3456`. Cloud + DLP masks all but the last four characters. If `reverse_order` is + `true`, all but the first four characters are masked as + `1234-****-****-****`. type: integer - minAge: - type: string - format: google-duration + format: int32 + charactersToIgnore: description: >- - Minimum age a table must have before Cloud DLP can profile it. Value - must be 1 hour or greater. - type: object - description: >- - There is an OR relationship between these attributes. They are used to - determine if a table should be scanned or not in Discovery. - GooglePrivacyDlpV2ListJobTriggersResponse: - id: GooglePrivacyDlpV2ListJobTriggersResponse - description: Response message for ListJobTriggers. - type: object - properties: - jobTriggers: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + When masking a string, items in this list will be skipped when + replacing characters. For example, if the input string is + `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 + characters with `*`, Cloud DLP returns `***-**5-5555`. type: array - description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. - nextPageToken: - type: string + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' + reverseOrder: + type: boolean description: >- - If the next page is available then this value is the next page token - to be used in the following ListJobTriggers request. - GooglePrivacyDlpV2DeidentifyDataSourceDetails: - id: GooglePrivacyDlpV2DeidentifyDataSourceDetails - description: The results of a Deidentify action from an inspect job. + Mask characters in reverse order. For example, if + `masking_character` is `0`, `number_to_mask` is `14`, and + `reverse_order` is `false`, then the input string + `1234-5678-9012-3456` is masked as `00000000000000-3456`. If + `masking_character` is `*`, `number_to_mask` is `3`, and + `reverse_order` is `true`, then the string `12345` is masked as + `12***`. type: object - properties: - requestedOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' - description: De-identification config used for the request. - deidentifyStats: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' - description: Stats about the de-identification operation. - GoogleProtobufEmpty: 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); } + Partially mask a string by replacing a given number of characters with a + fixed character. Masking can start from the beginning or end of the + string. This can be used on data of any type (numbers, longs, and so on) + and when de-identifying structured data we'll attempt to preserve the + original data's type. (This allows you to take a long like 123 and + modify it to a string like **3. + GooglePrivacyDlpV2DiscoveryStartingLocation: type: object - id: GoogleProtobufEmpty - properties: {} - GooglePrivacyDlpV2PublishSummaryToCscc: - id: GooglePrivacyDlpV2PublishSummaryToCscc - properties: {} + id: GooglePrivacyDlpV2DiscoveryStartingLocation + properties: + folderId: + description: The ID of the folder within an organization to be scanned. + type: string + format: int64 + organizationId: + description: The ID of an organization to scan. + type: string + format: int64 description: >- - Publish the result summary of a DlpJob to [Security Command - Center](https://cloud.google.com/security-command-center). This action - is available for only projects that belong to an organization. This - action publishes the count of finding instances and their infoTypes. The - summary of findings are persisted in Security Command Center and are - governed by [service-specific policies for Security Command - Center](https://cloud.google.com/terms/service-terms). Only a single - instance of this action can be specified. Compatible with: Inspect - type: object - GooglePrivacyDlpV2PublishToSecurityCommandCenter: - properties: {} + The location to begin a discovery scan. Denotes an organization ID or + folder ID within an organization. + GooglePrivacyDlpV2CryptoDeterministicConfig: + id: GooglePrivacyDlpV2CryptoDeterministicConfig type: object - id: GooglePrivacyDlpV2PublishToSecurityCommandCenter description: >- - If set, a summary finding will be created/updated in SCC for each - profile. - GooglePrivacyDlpV2Schedule: - type: object - properties: - recurrencePeriodDuration: - format: google-duration - type: string - description: >- - With this option a job is started on a regular periodic basis. For - example: every day (86400 seconds). A scheduled start time will be - skipped if the previous execution has not ended when its scheduled - time occurs. This value must be set to a time duration greater than - or equal to 1 day and can be no longer than 60 days. - description: Schedule for inspect job triggers. - id: GooglePrivacyDlpV2Schedule - GooglePrivacyDlpV2DataProfileAction: - type: object + Pseudonymization method that generates deterministic encryption for the + given input. Outputs a base64 encoded representation of the encrypted + output. Uses AES-SIV based on the RFC + https://tools.ietf.org/html/rfc5297. properties: - tagResources: - description: Tags the profiled resources with the specified tag values. - $ref: '#/components/schemas/GooglePrivacyDlpV2TagResources' - pubSubNotification: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' - description: Publish a message into the Pub/Sub topic. - exportData: - $ref: '#/components/schemas/GooglePrivacyDlpV2Export' - description: Export data profiles into a provided location. - publishToScc: - description: Publishes findings to SCC for each data profile. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2PublishToSecurityCommandCenter - publishToChronicle: + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' description: >- - Publishes generated data profiles to Google Security Operations. For - more information, see [Use Sensitive Data Protection data in - context-aware - analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToChronicle' - description: A task to execute when a data profile has been generated. - id: GooglePrivacyDlpV2DataProfileAction - GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: + The key used by the encryption function. For deterministic + encryption using AES-SIV, the provided key is internally expanded to + 64 bytes prior to use. + context: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + A context may be used for higher security and maintaining + referential integrity such that the same identifier in two different + contexts will be given a distinct surrogate. The context is appended + to plaintext value being encrypted. On decryption the provided + context is validated against the value used during encryption. If a + context was provided during encryption, same context must be + provided during decryption as well. If the context is not set, + plaintext would be used as is for encryption. If the context is set + but: 1. there is no record present when transforming a given value + or 2. the field is not present when transforming a given value, + plaintext would be used as is for encryption. Note that case (1) is + expected when an `InfoTypeTransformation` is applied to both + structured and unstructured `ContentItem`s. + surrogateInfoType: + description: >- + The custom info type to annotate the surrogate with. This annotation + will be applied to the surrogate by prefixing it with the name of + the custom info type followed by the number of characters comprising + the surrogate. The following scheme defines the format: {info type + name}({surrogate character count}):{surrogate} For example, if the + name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate + is 'abc', the full replacement value will be: + 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate + when inspecting content using the custom info type 'Surrogate'. This + facilitates reversal of the surrogate when it occurs in free text. + Note: For record transformations where the entire cell in a table is + being transformed, surrogates are not mandatory. Surrogates are used + to denote the location of the token and are necessary for + re-identification in free form text. In order for inspection to work + properly, the name of this info type must not occur naturally + anywhere in your data; otherwise, inspection may either - reverse a + surrogate that does not correspond to an actual identifier - be + unable to parse the surrogate and result in an error Therefore, + choose your custom info type name carefully after considering what + your data looks like. One way to select a name that has a high + chance of yielding reliable detection is to include one or more + unicode characters that are highly improbable to exist in your data. + For example, assuming your data is entered from a regular ASCII + keyboard, the symbol with the hex code point 29DD might be used like + so: ⧝MY_TOKEN_TYPE. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + GooglePrivacyDlpV2DiscoveryCloudStorageFilter: + id: GooglePrivacyDlpV2DiscoveryCloudStorageFilter + type: object properties: - bucketValues: - type: array - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + others: description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. - bucketSize: - format: int64 - type: string - description: Number of records within these probability bounds. - maxProbability: - format: double - type: number - description: Always greater than or equal to min_probability. - bucketValueCount: - type: string - format: int64 + Optional. Catch-all. This should always be the last target in the + list because anything above it will apply first. Should only appear + once in a configuration. If none is specified, a default one will be + added automatically. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' + collection: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreCollection' + description: Optional. A specific set of buckets for this filter to apply to. + cloudStorageResourceReference: description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - minProbability: - type: number - description: Between 0 and 1. - format: double - id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + Optional. The bucket to scan. Targets including this can only + include one target (the target with this bucket). This enables + profiling the contents of a single bucket, while the other options + allow for easy profiling of many bucets within a project or an + organization. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageResourceReference' description: >- - A DeltaPresenceEstimationHistogramBucket message with the following - values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means - that there are 42 records for which δ is in [0.1, 0.2). An important - particular case is when min_probability = max_probability = 1: then, - every individual who shares this quasi-identifier combination is in the - dataset. - type: object - GooglePrivacyDlpV2CloudStorageRegexFileSet: - id: GooglePrivacyDlpV2CloudStorageRegexFileSet + Determines which buckets will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID and bucket name. + GooglePrivacyDlpV2ListDiscoveryConfigsResponse: + description: Response message for ListDiscoveryConfigs. + id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse type: object - description: >- - Message representing a set of files in a Cloud Storage bucket. Regular - expressions are used to allow fine-grained control over which files in - the bucket to include. Included files are those that match at least one - item in `include_regex` and do not match any items in `exclude_regex`. - Note that a file that matches items from both lists will _not_ be - included. For a match to occur, the entire file path (i.e., everything - in the url after the bucket name) must match the regular expression. For - example, given the input `{bucket_name: "mybucket", include_regex: - ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * - `gs://mybucket/directory1/myfile` will be included * - `gs://mybucket/directory1/directory2/myfile` will be included (`.*` - matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will - _not_ be included (the full path doesn't match any items in - `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be - included (the path matches an item in `exclude_regex`) If - `include_regex` is left empty, it will match all files by default (this - is equivalent to setting `include_regex: [".*"]`). Some other common use - cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will - include all files in `mybucket` except for .pdf files * `{bucket_name: - "mybucket", include_regex: ["directory/[^/]+"]}` will include all files - directly under `gs://mybucket/directory/`, without matching across `/` properties: - excludeRegex: - description: >- - A list of regular expressions matching file paths to exclude. All - files in the bucket that match at least one of these regular - expressions will be excluded from the scan. Regular expressions use - RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can - be found under the google/re2 repository on GitHub. + discoveryConfigs: + description: List of configs, up to page_size in ListDiscoveryConfigsRequest. type: array items: - type: string - includeRegex: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + nextPageToken: description: >- - A list of regular expressions matching file paths to include. All - files in the bucket that match at least one of these regular - expressions will be included in the set of files, except for those - that also match an item in `exclude_regex`. Leaving this field empty - will match all files by default (this is equivalent to including - `.*` in the list). Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - type: array - items: - type: string - bucketName: + If the next page is available then this value is the next page token + to be used in the following ListDiscoveryConfigs request. type: string - description: The name of a Cloud Storage bucket. Required. - GooglePrivacyDlpV2StoredType: - id: GooglePrivacyDlpV2StoredType - type: object + GooglePrivacyDlpV2CloudStorageOptions: properties: - createTime: - format: google-datetime + sampleMethod: + enumDescriptions: + - No sampling. + - Scan from the top (default). + - >- + For each file larger than bytes_limit_per_file, randomly pick the + offset to start scanning. The scanned bytes are contiguous. + enum: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START type: string + description: How to sample the data. + bytesLimitPerFile: + format: int64 description: >- - Timestamp indicating when the version of the `StoredInfoType` used - for inspection was created. Output-only field, populated by the - system. - name: + Max number of bytes to scan from a file. If a scanned file's size is + bigger than this value then the rest of the bytes are omitted. Only + one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can + be specified. This field can't be set if de-identification is + requested. For certain file types, setting this field has no effect. + For more information, see [Limits on bytes scanned per + file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). type: string + bytesLimitPerFilePercent: + type: integer description: >- - Resource name of the requested `StoredInfoType`, for example - `organizations/433245324/storedInfoTypes/432452342` or - `projects/project-id/storedInfoTypes/432452342`. - description: A reference to a StoredInfoType to use with scanning. - GooglePrivacyDlpV2JobNotificationEmails: - description: >- - Sends an email when the job completes. The email goes to IAM project - owners and technical [Essential - Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). - id: GooglePrivacyDlpV2JobNotificationEmails - type: object - properties: {} - GooglePrivacyDlpV2ImageLocation: - id: GooglePrivacyDlpV2ImageLocation - description: Location of the finding within an image. - properties: - boundingBoxes: - description: >- - Bounding boxes locating the pixels within the image containing the - finding. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' - type: object - GooglePrivacyDlpV2TimespanConfig: - description: >- - Configuration of the timespan of the items to include in scanning. - Currently only supported when inspecting Cloud Storage and BigQuery. - type: object - id: GooglePrivacyDlpV2TimespanConfig - properties: - startTime: - format: google-datetime - description: >- - Exclude files, tables, or rows older than this value. If not set, no - lower time limit is applied. - type: string - timestampField: - description: >- - Specification of the field containing the timestamp of scanned - items. Used for data sources like Datastore and BigQuery. **For - BigQuery** If this value is not specified and the table was modified - between the given start and end times, the entire table will be - scanned. If this value is specified, then rows are filtered based on - the given start and end times. Rows with a `NULL` value in the - provided BigQuery column are skipped. Valid data types of the - provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and - `DATETIME`. If your BigQuery table is [partitioned at ingestion - time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), - you can use any of the following pseudo-columns as your timestamp - field. When used with Cloud DLP, these pseudo-column names are case - sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, - then entities are filtered based on the given start and end times. - If an entity does not contain the provided timestamp property or - contains empty or invalid values, then it is included. Valid data - types of the provided timestamp property are: `TIMESTAMP`. See the - [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) - related to this operation. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - endTime: - type: string - format: google-datetime - description: >- - Exclude files, tables, or rows newer than this value. If not set, no - upper time limit is applied. - enableAutoPopulationOfTimespanConfig: - type: boolean - description: >- - When the job is started by a JobTrigger we will automatically figure - out a valid start_time to avoid scanning files that have not been - modified since the last time the JobTrigger executed. This will be - based on the time of the execution of the last run of the JobTrigger - or the timespan end_time used in the last run of the JobTrigger. - **For BigQuery** Inspect jobs triggered by automatic population will - scan data that is at least three hours old when the job starts. This - is because streaming buffer rows are not read during inspection and - reading up to the current timestamp will result in skipped rows. See - the [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) - related to this operation. - GooglePrivacyDlpV2Deidentify: - type: object - id: GooglePrivacyDlpV2Deidentify - properties: - cloudStorageOutput: - description: >- - Required. User settable Cloud Storage bucket and folders to store - de-identified files. This field must be set for Cloud Storage - deidentification. The output Cloud Storage bucket must be different - from the input bucket. De-identified files will overwrite files in - the output path. Form of: gs://bucket/folder/ or gs://bucket - type: string - transformationConfig: + Max percentage of bytes to scan from a file. The rest are omitted. + The number of bytes scanned is rounded down. Must be between 0 and + 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only + one of bytes_limit_per_file and bytes_limit_per_file_percent can be + specified. This field can't be set if de-identification is + requested. For certain file types, setting this field has no effect. + For more information, see [Limits on bytes scanned per + file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + format: int32 + filesLimitPercent: + type: integer description: >- - User specified deidentify templates and configs for structured, - unstructured, and image files. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' - transformationDetailsStorageConfig: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig + Limits the number of files to scan to this percentage of the input + FileSet. Number of files scanned is rounded down. Must be between 0 + and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. + format: int32 + fileTypes: description: >- - Config for storing transformation details. This is separate from the - de-identified content, and contains metadata about the successful - transformations and/or failures that occurred while de-identifying. - This needs to be set in order for users to access information about - the status of each transformation (see TransformationDetails message - for more information about what is noted). - fileTypesToTransform: + List of file type groups to include in the scan. If empty, all files + are scanned and available data format processors are applied. In + addition, the binary content of the selected files is always scanned + as well. Images are scanned only as binary if the specified region + does not support image inspection and no file_types were specified. + Image inspection is restricted to 'global', 'us', 'asia', and + 'europe'. type: array items: enumDescriptions: @@ -2556,7 +2237,6 @@ components: binary files. Included file extensions: xlsx, xlsm, xltx, xltm. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on Excel files. - type: string enum: - FILE_TYPE_UNSPECIFIED - BINARY_FILE @@ -2569,1797 +2249,1553 @@ components: - TSV - POWERPOINT - EXCEL - description: >- - List of user-specified file type groups to transform. If specified, - only the files with these file types will be transformed. If empty, - all supported files will be transformed. Supported types may be - automatically added over time. If a file type is set in this field - that isn't supported by the Deidentify action then the job will fail - and will not be successfully created/started. Currently the only - file types supported are: IMAGES, TEXT_FILES, CSV, TSV. - description: >- - Create a de-identified copy of the requested table or files. A - TransformationDetail will be created for each transformation. If any - rows in BigQuery are skipped during de-identification (transformation - errors or row size exceeds BigQuery insert API limits) they are placed - in the failure output table. If the original row exceeds the BigQuery - insert API limit it will be truncated when written to the failure output - table. The failure output table can be set in the - action.deidentify.output.big_query_output.deidentified_failure_output_table - field, if no table is set, a table will be automatically created in the - same project and dataset as the original table. Compatible with: Inspect - GooglePrivacyDlpV2HotwordRule: - properties: - proximity: - $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' - description: >- - Range of characters within which the entire hotword must reside. The - total length of the window cannot exceed 1000 characters. The - finding itself will be included in the window, so that hotwords can - be used to match substrings of the finding itself. Suppose you want - Cloud DLP to promote the likelihood of the phone number regex - "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area - code of a company's office. In this case, use the hotword regex - "\(xxx\)", where "xxx" is the area code in question. For tabular - data, if you want to modify the likelihood of an entire column of - findngs, see [Hotword example: Set the match likelihood of a table - column] - (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - likelihoodAdjustment: - description: Likelihood adjustment to apply to all matching findings. - $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' - hotwordRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression pattern defining what qualifies as a hotword. + type: string + fileSet: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' + description: The set of one or more files to scan. + id: GooglePrivacyDlpV2CloudStorageOptions + description: Options defining a file or a set of files within a Cloud Storage bucket. + type: object + GooglePrivacyDlpV2DataProfileBigQueryRowSchema: type: object + id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema + properties: + fileStoreProfile: + description: File store data profile column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + columnProfile: + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + description: Column data profile column + tableProfile: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + description: Table data profile column description: >- - The rule that adjusts the likelihood of findings within a certain - proximity of hotwords. - id: GooglePrivacyDlpV2HotwordRule - GooglePrivacyDlpV2TagCondition: + The schema of data to be saved to the BigQuery table when the + `DataProfileAction` is enabled. + GooglePrivacyDlpV2RequestedOptions: + id: GooglePrivacyDlpV2RequestedOptions + description: Snapshot of the inspection configuration. + type: object properties: - sensitivityScore: + snapshotInspectTemplate: description: >- - Conditions attaching the tag to a resource on its profile having - this sensitivity score. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - tag: - $ref: '#/components/schemas/GooglePrivacyDlpV2TagValue' - description: The tag value to attach to resources. + If run with an InspectTemplate, a snapshot of its state at the time + of this run. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + jobConfig: + description: Inspect config. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + GooglePrivacyDlpV2HybridOptions: + id: GooglePrivacyDlpV2HybridOptions type: object - id: GooglePrivacyDlpV2TagCondition description: >- - The tag to attach to profiles matching the condition. At most one - `TagCondition` can be specified per sensitivity level. - GooglePrivacyDlpV2ListStoredInfoTypesResponse: - id: GooglePrivacyDlpV2ListStoredInfoTypesResponse + Configuration to control jobs where the content being inspected is + outside of Google Cloud Platform. properties: - nextPageToken: + labels: + description: >- + To organize findings, these labels will be added to each finding. + Label keys must be between 1 and 63 characters long and must conform + to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. + Label values must be between 0 and 63 characters long and must + conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. + No more than 10 labels can be associated with a given finding. + Examples: * `"environment" : "production"` * `"pipeline" : "etl"` + type: object + additionalProperties: + type: string + tableOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + description: >- + If the container is a table, additional information to make findings + meaningful such as the columns that are primary keys. + requiredFindingLabelKeys: + items: + type: string + type: array + description: >- + These are labels that each inspection request must include within + their 'finding_labels' map. Request may contain others, but any + missing one of these will be rejected. Label keys must be between 1 + and 63 characters long and must conform to the following regular + expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can + be required. + description: type: string description: >- - If the next page is available then the next page token to be used in - the following ListStoredInfoTypes request. - storedInfoTypes: + A short description of where the data is coming from. Will be stored + once in the job. 256 max length. + GooglePrivacyDlpV2ExcludeInfoTypes: + description: List of excluded infoTypes. + id: GooglePrivacyDlpV2ExcludeInfoTypes + properties: + infoTypes: type: array description: >- - List of storedInfoTypes, up to page_size in - ListStoredInfoTypesRequest. + InfoType list in ExclusionRule rule drops a finding when it overlaps + or contained within with a finding of an infoType from this list. + For example, for `InspectionRuleSet.info_types` containing + "PHONE_NUMBER"` and `exclusion_rule` containing + `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone + number findings are dropped if they overlap with EMAIL_ADDRESS + finding. That leads to "555-222-2222@example.org" to generate only a + single finding, namely email address. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' - type: object - description: Response message for ListStoredInfoTypes. - GooglePrivacyDlpV2RedactConfig: - properties: {} + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' type: object - id: GooglePrivacyDlpV2RedactConfig - description: >- - Redact a given value. For example, if used with an - `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone - number is 206-555-0123', the output would be 'My phone number is '. - GooglePrivacyDlpV2HybridInspectResponse: - description: Quota exceeded errors will be thrown once quota has been met. - id: GooglePrivacyDlpV2HybridInspectResponse - properties: {} - type: object - GooglePrivacyDlpV2TransformationOverview: - type: object - description: Overview of the modifications that occurred. + GooglePrivacyDlpV2SummaryResult: properties: - transformedBytes: - description: Total size in bytes that were transformed in some way. + count: format: int64 + description: Number of transformations counted by this result. type: string - transformationSummaries: - description: Transformations applied to the dataset. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' - id: GooglePrivacyDlpV2TransformationOverview - GooglePrivacyDlpV2PubSubExpressions: - description: An expression, consisting of an operator and conditions. - type: object - id: GooglePrivacyDlpV2PubSubExpressions - properties: - conditions: - type: array - description: Conditions to apply to the expression. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' - logicalOperator: - enumDescriptions: - - Unused. - - Conditional OR. - - Conditional AND. - enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - OR - - AND - type: string - description: The operator to apply to the collection of conditions. - GooglePrivacyDlpV2FileStoreDataProfile: - properties: - projectId: - description: The Google Cloud project ID that owns the resource. - type: string - projectDataProfile: - type: string - description: The resource name of the project data profile for this file store. - state: - enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. - type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE - description: State of a profile. - fullResource: - type: string - description: >- - The resource name of the resource profiled. - https://cloud.google.com/apis/design/resource_names#full_resource_name - configSnapshot: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' - description: The snapshot of the configurations used to generate the profile. - dataStorageLocations: - items: - type: string - description: >- - For resources that have multiple storage locations, these are those - regions. For Cloud Storage this is the list of regions chosen for - dual-region storage. `file_store_location` will normally be the - corresponding multi-region for the list of individual locations. The - first region is always picked as the processing and storage location - for the data profile. - type: array - profileStatus: - description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - resourceAttributes: - description: >- - Attributes of the resource being profiled. Currently used - attributes: * customer_managed_encryption: boolean - true: the - resource is encrypted with a customer-managed key. - false: the - resource is encrypted with a provider-managed key. - type: object - additionalProperties: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - profileLastGenerated: - type: string - format: google-datetime - description: The last time the profile was generated. - fileStorePath: - type: string - description: 'The file store path. * Cloud Storage: `gs://{bucket}`' - createTime: - format: google-datetime - description: The time the file store was first created. - type: string - fileStoreLocation: - description: >- - The location of the file store. * Cloud Storage: - https://cloud.google.com/storage/docs/locations#available-locations - type: string - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' - description: The resource type that was profiled. - resourceLabels: - description: >- - The labels applied to the resource at the time the profile was - generated. - type: object - additionalProperties: - type: string - fileClusterSummaries: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterSummary' - description: FileClusterSummary per each cluster. - locationType: - type: string + details: description: >- - The location type of the bucket (region, dual-region, multi-region, - etc). If dual-region, expect data_storage_locations to be populated. - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity score of this resource. - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level of this resource. - lastModifiedTime: - description: The time the file store was last modified. + A place for warnings or errors to show up if a transformation didn't + work as expected. type: string - format: google-datetime - fileStoreInfoTypeSummaries: - description: InfoTypes detected in this file store. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' - type: array - resourceVisibility: - description: How broadly a resource has been shared. + code: enum: - - RESOURCE_VISIBILITY_UNSPECIFIED - - RESOURCE_VISIBILITY_PUBLIC - - RESOURCE_VISIBILITY_INCONCLUSIVE - - RESOURCE_VISIBILITY_RESTRICTED + - TRANSFORMATION_RESULT_CODE_UNSPECIFIED + - SUCCESS + - ERROR + description: Outcome of the transformation. type: string enumDescriptions: - - Unused. - - Visible to any user. - - >- - May contain public items. For example, if a Cloud Storage bucket - has uniform bucket level access disabled, some objects inside it - may be public, but none are known yet. - - Visible only to specific users. - name: - type: string - description: The name of the profile. - fileStoreIsEmpty: - type: boolean - description: The file store does not have any files. - id: GooglePrivacyDlpV2FileStoreDataProfile - description: 'The profile for a file store. * Cloud Storage: maps 1:1 with a bucket.' + - Unused + - Transformation completed without an error. + - Transformation had an error. + id: GooglePrivacyDlpV2SummaryResult type: object + description: >- + A collection that informs the user the number of times a particular + `TransformationResultCode` and error details occurred. GooglePrivacyDlpV2DataProfileLocation: - description: The data that will be profiled. - type: object id: GooglePrivacyDlpV2DataProfileLocation properties: organizationId: format: int64 - type: string description: The ID of an organization to scan. + type: string folderId: description: The ID of the folder within an organization to scan. - type: string format: int64 - GooglePrivacyDlpV2TransformationErrorHandling: + type: string + description: The data that will be profiled. type: object - id: GooglePrivacyDlpV2TransformationErrorHandling - description: >- - How to handle transformation errors during de-identification. A - transformation error occurs when the requested transformation is - incompatible with the data. For example, trying to de-identify an IP - address using a `DateShift` transformation would result in a - transformation error, since date info cannot be extracted from an IP - address. Information about any incompatible transformations, and how - they were handled, is returned in the response as part of the - `TransformationOverviews`. - properties: - leaveUntransformed: - $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' - description: Ignore errors - throwError: - description: Throw an error - $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' - GooglePrivacyDlpV2BigQueryKey: - id: GooglePrivacyDlpV2BigQueryKey - description: Row key for identifying a record in BigQuery table. + GooglePrivacyDlpV2RequestedRiskAnalysisOptions: type: object properties: - rowNumber: - description: >- - Row number inferred at the time the table was scanned. This value is - nondeterministic, cannot be queried, and may be null for inspection - jobs. To locate findings within a table, specify - `inspect_job.storage_config.big_query_options.identifying_fields` in - `CreateDlpJobRequest`. - format: int64 - type: string - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Complete BigQuery table reference. - GooglePrivacyDlpV2DiscoveryTableModifiedCadence: + jobConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + description: The job config for the risk job. + description: Risk analysis options. + id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions + GooglePrivacyDlpV2Dictionary: properties: - types: - items: - enum: - - TABLE_MODIFICATION_UNSPECIFIED - - TABLE_MODIFIED_TIMESTAMP - enumDescriptions: - - Unused. - - >- - A table will be considered modified when the last_modified_time - from BigQuery has been updated. - type: string - description: >- - The type of events to consider when deciding if the table has been - modified and should have the profile updated. Defaults to - MODIFIED_TIMESTAMP. - type: array - frequency: + wordList: + description: List of words or phrases to search for. + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + cloudStoragePath: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' description: >- - How frequently data profiles can be updated when tables are - modified. Defaults to never. - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - type: string - type: object - id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence - description: The cadence at which to update data profiles when a table is modified. - GooglePrivacyDlpV2DeidentifyContentRequest: + Newline-delimited file of words in Cloud Storage. Only a single file + is accepted. type: object - description: Request to de-identify a ContentItem. + description: >- + Custom information type based on a dictionary of words or phrases. This + can be used to match sensitive information specific to the data, such as + a list of employee IDs or job titles. Dictionary words are + case-insensitive and all characters other than letters and digits in the + unicode [Basic Multilingual + Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) + will be replaced with whitespace when scanning for matches, so the + dictionary phrase "Sam Johnson" will match all three phrases "sam + johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the + characters surrounding any match must be of a different type than the + adjacent characters within the word, so letters must be next to + non-letters and digits next to non-digits. For example, the dictionary + word "jen" will match the first three letters of the text "jen123" but + will return no matches for "jennifer". Dictionary words containing a + large number of characters that are not letters or digits may result in + unexpected findings because such characters are treated as whitespace. + The [limits](https://cloud.google.com/sensitive-data-protection/limits) + page contains details about the size limits of dictionaries. For + dictionaries that do not fit within these constraints, consider using + `LargeCustomDictionaryConfig` in the `StoredInfoType` API. + id: GooglePrivacyDlpV2Dictionary + GooglePrivacyDlpV2TransformationDetailsStorageConfig: properties: - item: + table: description: >- - The item to de-identify. Will be treated as text. This value must be - of type Table if your deidentify_config is a RecordTransformations - object. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - deidentifyTemplateName: + The BigQuery table in which to store the output. This may be an + existing table or in a new table in an existing dataset. If table_id + is not set a new one will be generated for you with the following + format: + dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. + Pacific time zone will be used for generating the date details. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + type: object + id: GooglePrivacyDlpV2TransformationDetailsStorageConfig + description: Config for storing transformation details. + GooglePrivacyDlpV2AllText: + description: Apply to all text. + type: object + id: GooglePrivacyDlpV2AllText + properties: {} + GooglePrivacyDlpV2InfoTypeStats: + id: GooglePrivacyDlpV2InfoTypeStats + type: object + description: Statistics regarding a specific InfoType. + properties: + count: + description: Number of findings for this infoType. + format: int64 type: string + infoType: + description: The type of finding this stat is for. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + GooglePrivacyDlpV2DateShiftConfig: + properties: + context: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Template to use. Any configuration directly specified in - deidentify_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + Points to the field that contains the context, for example, an + entity id. If set, must also set cryptoKey. If set, shift will be + consistent for the given context. + cryptoKey: description: >- - Configuration for the inspector. Items specified here will override - the template referenced by the inspect_template_name argument. - deidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + Causes the shift to be computed based on this key and the context. + This results in the same shift for the same context and crypto_key. + If set, must also set context. Can only be applied to table items. + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + upperBoundDays: + format: int32 + type: integer description: >- - Configuration for the de-identification of the content item. Items - specified here will override the template referenced by the - deidentify_template_name argument. - locationId: - type: string - description: Deprecated. This field has no effect. - inspectTemplateName: - type: string + Required. Range of shift in days. Actual shift will be selected at + random within this range (inclusive ends). Negative means shift to + earlier in time. Must not be more than 365250 days (1000 years) each + direction. For example, 3 means shift date to at most 3 days into + the future. + lowerBoundDays: description: >- - Template to use. Any configuration directly specified in - inspect_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - id: GooglePrivacyDlpV2DeidentifyContentRequest - GooglePrivacyDlpV2RecordSuppression: + Required. For example, -5 means shift date to at most 5 days back in + the past. + type: integer + format: int32 type: object - properties: - condition: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' - description: >- - A condition that when it evaluates to true will result in the record - being evaluated to be suppressed from the transformed content. - id: GooglePrivacyDlpV2RecordSuppression description: >- - Configuration to suppress records whose suppression conditions evaluate - to true. - GooglePrivacyDlpV2BigQueryField: - properties: - field: - description: Designated field in the BigQuery table. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - table: - description: Source table of the field. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Message defining a field of a BigQuery table. - id: GooglePrivacyDlpV2BigQueryField - type: object - GooglePrivacyDlpV2ByteContentItem: + Shifts dates by random number of days, with option to be consistent for + the same context. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting + to learn more. + id: GooglePrivacyDlpV2DateShiftConfig + GooglePrivacyDlpV2RedactConfig: + id: GooglePrivacyDlpV2RedactConfig + properties: {} + description: >- + Redact a given value. For example, if used with an + `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone + number is 206-555-0123', the output would be 'My phone number is '. type: object - description: Container for bytes to inspect or redact. - id: GooglePrivacyDlpV2ByteContentItem + GooglePrivacyDlpV2Error: properties: - type: + extraInfo: enumDescriptions: - - Unused - - Any image type. - - jpeg - - bmp - - png - - svg - - plain text - - docx, docm, dotx, dotm - - pdf - - pptx, pptm, potx, potm, pot - - xlsx, xlsm, xltx, xltm - - avro - - csv - - tsv - - Audio file types. Only used for profiling. - - Video file types. Only used for profiling. - - Executable file types. Only used for profiling. + - Unused. + - Image scan is not available in the region. + - File store cluster is not supported for profile generation. enum: - - BYTES_TYPE_UNSPECIFIED - - IMAGE - - IMAGE_JPEG - - IMAGE_BMP - - IMAGE_PNG - - IMAGE_SVG - - TEXT_UTF8 - - WORD_DOCUMENT - - PDF - - POWERPOINT_DOCUMENT - - EXCEL_DOCUMENT - - AVRO - - CSV - - TSV - - AUDIO - - VIDEO - - EXECUTABLE + - ERROR_INFO_UNSPECIFIED + - IMAGE_SCAN_UNAVAILABLE_IN_REGION + - FILE_STORE_CLUSTER_UNSUPPORTED type: string + description: Additional information about the error. + timestamps: + type: array + items: + format: google-datetime + type: string description: >- - The type of data stored in the bytes string. Default will be - TEXT_UTF8. - data: - type: string - description: Content data to inspect or redact. - format: byte - GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: - id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig - properties: {} - description: Replace each matching finding with the name of the info_type. + The times the error occurred. List includes the oldest timestamp and + the last 9 timestamps. + details: + description: Detailed error codes and messages. + $ref: '#/components/schemas/GoogleRpcStatus' + id: GooglePrivacyDlpV2Error + description: >- + Details information about an error encountered during job execution or + the results of an unsuccessful activation of the JobTrigger. type: object - GooglePrivacyDlpV2OrgConfig: + GooglePrivacyDlpV2ContentLocation: description: >- - Project and scan location information. Only set when the parent is an - org. - id: GooglePrivacyDlpV2OrgConfig + Precise location of the finding within a document, record, image, or + metadata container. + id: GooglePrivacyDlpV2ContentLocation + type: object properties: - projectId: + imageLocation: + description: Location within an image's pixels. + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' + recordLocation: + description: Location within a row or record of a database table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' + metadataLocation: + description: Location within the metadata for inspected content. + $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' + containerVersion: + description: >- + Finding container version, if available ("generation" for Cloud + Storage). type: string + containerName: description: >- - The project that will run the scan. The DLP service account that - exists within this project must have access to all resources that - are profiled, and the Cloud DLP API must be enabled. - location: - description: 'The data to scan: folder, org, or project' - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' - type: object - GooglePrivacyDlpV2CreateDiscoveryConfigRequest: - description: Request message for CreateDiscoveryConfig. - id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest - type: object - properties: - configId: - description: >- - The config ID can contain uppercase and lowercase letters, numbers, - and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. + Name of the container where the finding is located. The top level + name is the source file name or table name. Names of some common + storage containers are formatted as follows: * BigQuery tables: + `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: + `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested + names could be absent if the embedded object has no string + identifier (for example, an image contained within a document). type: string - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: Required. The DiscoveryConfig to create. - GooglePrivacyDlpV2ActivateJobTriggerRequest: + containerTimestamp: + type: string + format: google-datetime + description: >- + Finding container modification timestamp, if applicable. For Cloud + Storage, this field contains the last file modification timestamp. + For a BigQuery table, this field contains the last_modified_time + property. For Datastore, this field isn't populated. + documentLocation: + description: Location data for document files. + $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' + GooglePrivacyDlpV2ListInspectTemplatesResponse: type: object - description: Request message for ActivateJobTrigger. - id: GooglePrivacyDlpV2ActivateJobTriggerRequest - properties: {} - GooglePrivacyDlpV2InspectConfig: properties: - limits: - $ref: '#/components/schemas/GooglePrivacyDlpV2FindingLimits' - description: >- - Configuration to control the number of findings returned. This is - not used for data profiling. When redacting sensitive data from - images, finding limits don't apply. They can cause unexpected or - inconsistent results, where only some data is redacted. Don't - include finding limits in RedactImage requests. Otherwise, Cloud DLP - returns an error. When set within an InspectJobConfig, the specified - maximum values aren't hard limits. If an inspection job reaches - these limits, the job ends gradually, not abruptly. Therefore, the - actual number of findings that Cloud DLP returns can be multiple - times higher than these maximum values. - contentOptions: - items: - enum: - - CONTENT_UNSPECIFIED - - CONTENT_TEXT - - CONTENT_IMAGE - type: string - enumDescriptions: - - Includes entire content of a file or a data stream. - - Text content within the data, excluding any metadata. - - Images found in the data. - type: array - description: Deprecated and unused. - includeQuote: + inspectTemplates: description: >- - When true, a contextual quote from the data that triggered a finding - is included in the response; see Finding.quote. This is not used for - data profiling. - type: boolean - customInfoTypes: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' + List of inspectTemplates, up to page_size in + ListInspectTemplatesRequest. type: array - description: >- - CustomInfoTypes provided by the user. See - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes - to learn more. - minLikelihoodPerInfoType: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' - description: >- - Minimum likelihood per infotype. For each infotype, a user can - specify a minimum likelihood. The system only returns a finding if - its likelihood is above this threshold. If this field is not set, - the system uses the InspectConfig min_likelihood. - type: array - infoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + nextPageToken: + type: string description: >- - Restricts what info_types to look for. The values must correspond to - InfoType values returned by ListInfoTypes or listed at - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. - When no InfoTypes or CustomInfoTypes are specified in a request, the - system may automatically choose a default list of detectors to run, - which may change over time. If you need precise control and - predictability as to what detectors are run you should specify - specific InfoTypes listed in the reference, otherwise a default list - will be used, which may change over time. + If the next page is available then the next page token to be used in + the following ListInspectTemplates request. + description: Response message for ListInspectTemplates. + id: GooglePrivacyDlpV2ListInspectTemplatesResponse + GooglePrivacyDlpV2Table: + description: >- + Structured content to inspect. Up to 50,000 `Value`s per request + allowed. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table + to learn more. + id: GooglePrivacyDlpV2Table + type: object + properties: + headers: type: array + description: Headers of the table. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - minLikelihood: - type: string - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - description: >- - Only returns findings equal to or above this threshold. The default - is POSSIBLE. In general, the highest likelihood setting yields the - fewest findings in results and the lowest chance of a false - positive. For more information, see [Match - likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). - excludeInfoTypes: - description: >- - When true, excludes type information of the findings. This is not - used for data profiling. - type: boolean - ruleSet: - description: >- - Set of rules to apply to the findings for this InspectConfig. - Exclusion rules, contained in the set are executed in the end, other - rules are executed in the order they are specified for each info - type. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + rows: type: array + description: Rows of the table. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' - description: >- - Configuration description of the scanning process. When used with - redactContent only info_types and min_likelihood are currently used. + $ref: '#/components/schemas/GooglePrivacyDlpV2Row' + GooglePrivacyDlpV2UpdateConnectionRequest: + id: GooglePrivacyDlpV2UpdateConnectionRequest type: object - id: GooglePrivacyDlpV2InspectConfig - GooglePrivacyDlpV2UnwrappedCryptoKey: + description: Request message for UpdateConnection. properties: - key: + updateMask: + format: google-fieldmask + description: Optional. Mask to control which fields get updated. type: string - description: Required. A 128/192/256 bit key. - format: byte - id: GooglePrivacyDlpV2UnwrappedCryptoKey + connection: + description: Required. The connection with new values for the relevant fields. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + GooglePrivacyDlpV2SurrogateType: + id: GooglePrivacyDlpV2SurrogateType type: object description: >- - Using raw keys is prone to security risks due to accidentally leaking - the key. Choose another type of key if possible. - GooglePrivacyDlpV2WordList: + Message for detecting output from deidentification transformations such + as + [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). + These types of transformations are those that perform pseudonymization, + thereby producing a "surrogate" as output. This should be used in + conjunction with a field on the transformation such as + `surrogate_info_type`. This CustomInfoType does not support the use of + `detection_rules`. + properties: {} + GooglePrivacyDlpV2DeltaPresenceEstimationResult: properties: - words: + deltaPresenceEstimationHistogram: description: >- - Words or phrases defining the dictionary. The dictionary must - contain at least one phrase and every phrase must contain at least 2 - characters that are letters or digits. [required] + The intervals [min_probability, max_probability) do not overlap. If + a value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_probability: 0, max_probability: 0.1, frequency: 17} + {min_probability: 0.2, max_probability: 0.3, frequency: 42} + {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean + that there are no record with an estimated probability in [0.1, 0.2) + nor larger or equal to 0.4. type: array items: - type: string - description: Message defining a list of words or phrases to search for in the data. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + id: GooglePrivacyDlpV2DeltaPresenceEstimationResult type: object - id: GooglePrivacyDlpV2WordList - GooglePrivacyDlpV2FinishDlpJobRequest: - properties: {} - description: The request message for finishing a DLP hybrid job. - id: GooglePrivacyDlpV2FinishDlpJobRequest + description: >- + Result of the δ-presence computation. Note that these results are an + estimation, not exact values. + GooglePrivacyDlpV2DeidentifyContentResponse: + id: GooglePrivacyDlpV2DeidentifyContentResponse type: object - GooglePrivacyDlpV2Conditions: + properties: + item: + description: The de-identified item. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + overview: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' + description: An overview of the changes that were made on the `item`. + description: Results of de-identifying a ContentItem. + GooglePrivacyDlpV2Regex: + id: GooglePrivacyDlpV2Regex type: object - description: A collection of conditions. properties: - conditions: + pattern: + type: string + description: >- + Pattern defining the regular expression. Its syntax + (https://github.com/google/re2/wiki/Syntax) can be found under the + google/re2 repository on GitHub. + groupIndexes: + description: >- + The index of the submatch to extract as findings. When not + specified, the entire match is returned. No more than 3 may be + included. type: array - description: A collection of conditions. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' - id: GooglePrivacyDlpV2Conditions - GooglePrivacyDlpV2StatisticalTable: - id: GooglePrivacyDlpV2StatisticalTable - type: object + format: int32 + type: integer + description: Message defining a custom regular expression. + GooglePrivacyDlpV2Manual: description: >- - An auxiliary table containing statistical information on the relative - frequency of different quasi-identifiers values. It has one or several - quasi-identifiers columns, and one column that indicates the relative - frequency of each quasi-identifier tuple. If a tuple is present in the - data but not in the auxiliary table, the corresponding relative - frequency is assumed to be zero (and thus, the tuple is highly - reidentifiable). - properties: - relativeFrequency: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Required. The relative frequency column must contain a - floating-point number between 0 and 1 (inclusive). Null values are - assumed to be zero. - table: - description: Required. Auxiliary table location. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - quasiIds: - type: array - description: Required. Quasi-identifier columns. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' - GooglePrivacyDlpV2DiscoveryConfig: + Job trigger option for hybrid jobs. Jobs must be manually created and + finished. + properties: {} type: object - description: >- - Configuration for discovery to scan resources for profile generation. - Only one discovery configuration may exist per organization, folder, or - project. The generated data profiles are retained according to the [data - retention policy] - (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + id: GooglePrivacyDlpV2Manual + GooglePrivacyDlpV2ReidentifyContentRequest: + type: object + id: GooglePrivacyDlpV2ReidentifyContentRequest properties: - targets: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' + inspectTemplateName: description: >- - Target to match against for determining what to scan and how - frequently. - status: - description: Required. A status for this configuration. - enum: - - STATUS_UNSPECIFIED - - RUNNING - - PAUSED - enumDescriptions: - - Unused - - The discovery config is currently active. - - The discovery config is paused temporarily. - type: string - displayName: - type: string - description: Display name (max 100 chars) - updateTime: - description: Output only. The last update timestamp of a DiscoveryConfig. + Template to use. Any configuration directly specified in + `inspect_config` will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. type: string - format: google-datetime - readOnly: true - lastRunTime: - description: >- - Output only. The timestamp of the last time this config was - executed. - readOnly: true - format: google-datetime + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: Configuration for the inspector. + locationId: + description: Deprecated. This field has no effect. type: string - inspectTemplates: - type: array - description: >- - Detection logic for profile generation. Not all template features - are used by Discovery. FindingLimits, include_quote and - exclude_info_types have no impact on Discovery. Multiple templates - may be provided if there is data in multiple regions. At most one - template must be specified per-region (including "global"). Each - region is scanned using the applicable template. If no - region-specific template is specified, but a "global" template is - specified, it will be copied to that region and used instead. If no - global or region-specific template is provided for a region with - data, that region's data will not be scanned. For more information, - see - https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. - items: - type: string - createTime: - format: google-datetime + item: + description: The item to re-identify. Will be treated as text. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + reidentifyTemplateName: type: string - readOnly: true - description: Output only. The creation timestamp of a DiscoveryConfig. - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - type: array description: >- - Output only. A stream of errors encountered when the config was - activated. Repeated errors may result in the config automatically - being paused. Output only field. Will return the last 100 errors. - Whenever the config is modified this list will be cleared. - readOnly: true - name: - type: string + Template to use. References an instance of `DeidentifyTemplate`. Any + configuration directly specified in `reidentify_config` or + `inspect_config` will override those set in the template. The + `DeidentifyTemplate` used must include only reversible + transformations. Singular fields that are set in this request will + replace their corresponding fields in the template. Repeated fields + are appended. Singular sub-messages and groups are recursively + merged. + reidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' description: >- - Unique resource name for the DiscoveryConfig, assigned by the - service when the DiscoveryConfig is created, for example - `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. - actions: - type: array - description: Actions to execute at the completion of scanning. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - orgConfig: - description: Only set when the parent is an org. - $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' - id: GooglePrivacyDlpV2DiscoveryConfig - GooglePrivacyDlpV2DeidentifyTemplate: + Configuration for the re-identification of the content item. This + field shares the same proto message type that is used for + de-identification, however its usage here is for the reversal of the + previous de-identification. Re-identification is performed by + examining the transformations used to de-identify the items and + executing the reverse. This requires that only reversible + transformations be provided here. The reversible transformations + are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` + description: Request to re-identify an item. + GooglePrivacyDlpV2TransientCryptoKey: description: >- - DeidentifyTemplates contains instructions on how to de-identify content. - See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. - id: GooglePrivacyDlpV2DeidentifyTemplate + Use this to have a random data crypto key generated. It will be + discarded after the request finishes. properties: name: - readOnly: true description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` - type: string - deidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - description: The core content of the template. - createTime: - type: string - format: google-datetime - description: Output only. The creation timestamp of an inspectTemplate. - readOnly: true - description: - description: Short description (max 256 chars). - type: string - updateTime: - format: google-datetime - readOnly: true - type: string - description: Output only. The last update timestamp of an inspectTemplate. - displayName: - description: Display name (max 256 chars). + Required. Name of the key. This is an arbitrary string used to + differentiate different keys. A unique key is generated per name: + two separate `TransientCryptoKey` protos share the same generated + key if their names are the same. When the data crypto key is + generated, this name is not used in any way (repeating the api call + will result in a different key being generated). type: string + id: GooglePrivacyDlpV2TransientCryptoKey type: object - GooglePrivacyDlpV2SecretManagerCredential: + GooglePrivacyDlpV2PrimitiveTransformation: type: object - description: >- - A credential consisting of a username and password, where the password - is stored in a Secret Manager resource. Note: Secret Manager [charges - apply](https://cloud.google.com/secret-manager/pricing). + description: A rule for transforming a value. properties: - passwordSecretVersionName: - type: string + cryptoDeterministicConfig: + description: Deterministic Crypto + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' + dateShiftConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' + description: Date Shift + fixedSizeBucketingConfig: + description: Fixed size bucketing + $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' + characterMaskConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' + description: Mask + replaceConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' + description: Replace with a specified value. + redactConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' + description: Redact + bucketingConfig: + description: Bucketing + $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' + cryptoReplaceFfxFpeConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' + description: Ffx-Fpe + replaceDictionaryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' description: >- - Required. The name of the Secret Manager resource that stores the - password, in the form - `projects/project-id/secrets/secret-name/versions/version`. - username: - type: string - description: Required. The username. - id: GooglePrivacyDlpV2SecretManagerCredential - GooglePrivacyDlpV2DiscoveryCloudSqlFilter: + Replace with a value randomly drawn (with replacement) from a + dictionary. + cryptoHashConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' + description: Crypto + replaceWithInfoTypeConfig: + description: Replace with infotype + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' + timePartConfig: + description: Time extraction + $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' + id: GooglePrivacyDlpV2PrimitiveTransformation + GooglePrivacyDlpV2SaveFindings: type: object - properties: - collection: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' - description: A specific set of database resources for this filter to apply to. - databaseResourceReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' - description: >- - The database resource to scan. Targets including this can only - include one target (the target with this database resource - reference). - others: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherDatabaseResources' - description: >- - Catch-all. This should always be the last target in the list because - anything above it will apply first. Should only appear once in a - configuration. If none is specified, a default one will be added - automatically. description: >- - Determines what tables will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID, location, instance, database, and - database resource name. - id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter - GooglePrivacyDlpV2TagResources: - description: >- - If set, attaches the [tags] - (https://cloud.google.com/resource-manager/docs/tags/tags-overview) - provided to profiled resources. Tags support [access - control](https://cloud.google.com/iam/docs/tags-access-control). You can - conditionally grant or deny access to a resource based on whether the - resource has a specific tag. - id: GooglePrivacyDlpV2TagResources + If set, the detailed findings will be persisted to the specified + OutputStorageConfig. Only a single instance of this action can be + specified. Compatible with: Inspect, Risk + id: GooglePrivacyDlpV2SaveFindings properties: - lowerDataRiskToLow: + outputConfig: + description: Location to store findings outside of DLP. + $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' + GooglePrivacyDlpV2HybridInspectStatistics: + type: object + id: GooglePrivacyDlpV2HybridInspectStatistics + description: Statistics related to processing hybrid inspect requests. + properties: + processedCount: + type: string + description: The number of hybrid inspection requests processed within this job. + format: int64 + pendingCount: + type: string description: >- - Whether applying a tag to a resource should lower the risk of the - profile for that resource. For example, in conjunction with an [IAM - deny policy](https://cloud.google.com/iam/docs/deny-overview), you - can deny all principals a permission if a tag value is present, - mitigating the risk of the resource. This also lowers the data risk - of resources at the lower levels of the resource hierarchy. For - example, reducing the data risk of a table data profile also reduces - the data risk of the constituent column data profiles. - type: boolean - tagConditions: - type: array - description: The tags to associate with different conditions. + The number of hybrid requests currently being processed. Only + populated when called via method `getDlpJob`. A burst of traffic may + cause hybrid inspect requests to be enqueued. Processing will take + place as quickly as possible, but resource limitations may impact + how long a request is enqueued for. + format: int64 + abortedCount: + description: >- + The number of hybrid inspection requests aborted because the job ran + out of quota or was ended before they could be processed. + type: string + format: int64 + GooglePrivacyDlpV2InspectConfig: + description: >- + Configuration description of the scanning process. When used with + redactContent only info_types and min_likelihood are currently used. + id: GooglePrivacyDlpV2InspectConfig + properties: + ruleSet: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TagCondition' - profileGenerationsToTag: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' + type: array description: >- - The profile generations for which the tag should be attached to - resources. If you attach a tag to only new profiles, then if the - sensitivity score of a profile subsequently changes, its tag doesn't - change. By default, this field includes only new profiles. To - include both new and updated profiles for tagging, this field should - explicitly include both `PROFILE_GENERATION_NEW` and - `PROFILE_GENERATION_UPDATE`. + Set of rules to apply to the findings for this InspectConfig. + Exclusion rules, contained in the set are executed in the end, other + rules are executed in the order they are specified for each info + type. + contentOptions: items: - enumDescriptions: - - Unused. - - The profile is the first profile for the resource. - - The profile is an update to a previous profile. type: string enum: - - PROFILE_GENERATION_UNSPECIFIED - - PROFILE_GENERATION_NEW - - PROFILE_GENERATION_UPDATE + - CONTENT_UNSPECIFIED + - CONTENT_TEXT + - CONTENT_IMAGE + enumDescriptions: + - Includes entire content of a file or a data stream. + - Text content within the data, excluding any metadata. + - Images found in the data. + type: array + description: Deprecated and unused. + minLikelihoodPerInfoType: type: array - type: object - GooglePrivacyDlpV2DateShiftConfig: - properties: - context: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Points to the field that contains the context, for example, an - entity id. If set, must also set cryptoKey. If set, shift will be - consistent for the given context. - lowerBoundDays: - type: integer + Minimum likelihood per infotype. For each infotype, a user can + specify a minimum likelihood. The system only returns a finding if + its likelihood is above this threshold. If this field is not set, + the system uses the InspectConfig min_likelihood. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' + customInfoTypes: description: >- - Required. For example, -5 means shift date to at most 5 days back in - the past. - format: int32 - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + CustomInfoTypes provided by the user. See + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes + to learn more. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' + infoTypes: description: >- - Causes the shift to be computed based on this key and the context. - This results in the same shift for the same context and crypto_key. - If set, must also set context. Can only be applied to table items. - upperBoundDays: - format: int32 - type: integer + Restricts what info_types to look for. The values must correspond to + InfoType values returned by ListInfoTypes or listed at + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. + When no InfoTypes or CustomInfoTypes are specified in a request, the + system may automatically choose a default list of detectors to run, + which may change over time. If you need precise control and + predictability as to what detectors are run you should specify + specific InfoTypes listed in the reference, otherwise a default list + will be used, which may change over time. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + type: array + minLikelihood: description: >- - Required. Range of shift in days. Actual shift will be selected at - random within this range (inclusive ends). Negative means shift to - earlier in time. Must not be more than 365250 days (1000 years) each - direction. For example, 3 means shift date to at most 3 days into - the future. - description: >- - Shifts dates by random number of days, with option to be consistent for - the same context. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting - to learn more. - id: GooglePrivacyDlpV2DateShiftConfig - type: object - GooglePrivacyDlpV2ActionDetails: - properties: - deidentifyDetails: - description: Outcome of a de-identification action. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' - type: object - id: GooglePrivacyDlpV2ActionDetails - description: The results of an Action. - GooglePrivacyDlpV2HybridInspectJobTriggerRequest: - description: Request to search for potentially sensitive info in a custom location. - properties: - hybridItem: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest - type: object - GooglePrivacyDlpV2AllText: - type: object - id: GooglePrivacyDlpV2AllText - description: Apply to all text. - properties: {} - GooglePrivacyDlpV2Condition: - type: object - description: >- - The field type of `value` and `field` do not need to match to be - considered equal, but not all comparisons are possible. EQUAL_TO and - NOT_EQUAL_TO attempt to compare even with incompatible types, but all - other comparisons are invalid with incompatible types. A `value` of - type: - `string` can be compared against all other types - `boolean` can - only be compared against other booleans - `integer` can be compared - against doubles or a string if the string value can be parsed as an - integer. - `double` can be compared against integers or a string if the - string can be parsed as a double. - `Timestamp` can be compared against - strings in RFC 3339 date string format. - `TimeOfDay` can be compared - against timestamps and strings in the format of 'HH:mm:ss'. If we fail - to compare do to type mismatch, a warning will be given and the - condition will evaluate to false. - properties: - operator: + Only returns findings equal to or above this threshold. The default + is POSSIBLE. In general, the highest likelihood setting yields the + fewest findings in results and the lowest chance of a false + positive. For more information, see [Match + likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). enumDescriptions: - - Unused - - Equal. Attempts to match even with incompatible types. - - Not equal to. Attempts to match even with incompatible types. - - Greater than. - - Less than. - - Greater than or equals. - - Less than or equals. - - Exists - description: >- - Required. Operator used to compare the field or infoType to the - value. + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. enum: - - RELATIONAL_OPERATOR_UNSPECIFIED - - EQUAL_TO - - NOT_EQUAL_TO - - GREATER_THAN - - LESS_THAN - - GREATER_THAN_OR_EQUALS - - LESS_THAN_OR_EQUALS - - EXISTS + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY type: string - value: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Value to compare against. [Mandatory, except for `EXISTS` tests.] - field: + includeQuote: + type: boolean description: >- - Required. Field within the record this condition is evaluated - against. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - id: GooglePrivacyDlpV2Condition - GooglePrivacyDlpV2RequestedRiskAnalysisOptions: - type: object - id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions - properties: - jobConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - description: The job config for the risk job. - description: Risk analysis options. - GooglePrivacyDlpV2ListConnectionsResponse: - description: Response message for ListConnections. - id: GooglePrivacyDlpV2ListConnectionsResponse - type: object - properties: - nextPageToken: - type: string + When true, a contextual quote from the data that triggered a finding + is included in the response; see Finding.quote. This is not used for + data profiling. + limits: + $ref: '#/components/schemas/GooglePrivacyDlpV2FindingLimits' description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. - connections: - description: List of connections. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - type: array - GooglePrivacyDlpV2DataProfileBigQueryRowSchema: - properties: - tableProfile: - description: Table data profile column - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - fileStoreProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' - description: File store data profile column. - columnProfile: - description: Column data profile column - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - description: >- - The schema of data to be saved to the BigQuery table when the - `DataProfileAction` is enabled. - id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema + Configuration to control the number of findings returned. This is + not used for data profiling. When redacting sensitive data from + images, finding limits don't apply. They can cause unexpected or + inconsistent results, where only some data is redacted. Don't + include finding limits in RedactImage requests. Otherwise, Cloud DLP + returns an error. When set within an InspectJobConfig, the specified + maximum values aren't hard limits. If an inspection job reaches + these limits, the job ends gradually, not abruptly. Therefore, the + actual number of findings that Cloud DLP returns can be multiple + times higher than these maximum values. + excludeInfoTypes: + description: >- + When true, excludes type information of the findings. This is not + used for data profiling. + type: boolean type: object - GooglePrivacyDlpV2NumericalStatsResult: - id: GooglePrivacyDlpV2NumericalStatsResult + GooglePrivacyDlpV2FileSet: + properties: + url: + description: >- + The Cloud Storage url of the file(s) to scan, in the format + `gs:///`. Trailing wildcard in the path is allowed. If the url ends + in a trailing slash, the bucket or directory represented by the url + will be scanned non-recursively (content in sub-directories will not + be scanned). This means that `gs://mybucket/` is equivalent to + `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to + `gs://mybucket/directory/*`. Exactly one of `url` or + `regex_file_set` must be set. + type: string + regexFileSet: + description: >- + The regex-filtered set of files to scan. Exactly one of `url` or + `regex_file_set` must be set. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegexFileSet' + description: Set of files to scan. type: object - description: Result of the numerical stats computation. + id: GooglePrivacyDlpV2FileSet + GooglePrivacyDlpV2CustomInfoType: + id: GooglePrivacyDlpV2CustomInfoType + description: >- + Custom information type provided by the user. Used to find + domain-specific sensitive information configurable to the data in + question. properties: - maxValue: - description: Maximum value appearing in the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - minValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Minimum value appearing in the column. - quantileValues: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + storedType: + description: >- + Load an existing `StoredInfoType` resource for use in + `InspectDataSource`. Not currently supported in `InspectContent`. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: >- + Sensitivity for this CustomInfoType. If this CustomInfoType extends + an existing InfoType, the sensitivity here will take precedence over + that of the original InfoType. If unset for a CustomInfoType, it + will default to HIGH. This only applies to data profiling. + surrogateType: + $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' + description: >- + Message for detecting output from deidentification transformations + that support reversing. + infoType: + description: >- + CustomInfoType can either be a new infoType, or an extension of + built-in infoType, when the name matches one of existing infoTypes + and that infoType is specified in `InspectContent.info_types` field. + Specifying the latter adds findings to the one detected by the + system. If built-in info type is not specified in + `InspectContent.info_types` list then the name is treated as a + custom info type. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + likelihood: + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY + description: >- + Likelihood to return for this CustomInfoType. This base value can be + altered by a detection rule if the finding meets the criteria + specified by the rule. Defaults to `VERY_LIKELY` if not specified. + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + type: string + detectionRules: type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' description: >- - List of 99 values that partition the set of field values into 100 - equal sized buckets. - GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: - description: Request message for UpdateDeidentifyTemplate. - properties: - deidentifyTemplate: - description: New DeidentifyTemplate value. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - updateMask: - format: google-fieldmask - description: Mask to control which fields get updated. + Set of detection rules to apply to all findings of this + CustomInfoType. Rules are applied in order that they are specified. + Not supported for the `surrogate_type` CustomInfoType. + exclusionType: type: string - id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + enumDescriptions: + - >- + A finding of this custom info type will not be excluded from + results. + - >- + A finding of this custom info type will be excluded from final + results, but can still affect rule execution. + enum: + - EXCLUSION_TYPE_UNSPECIFIED + - EXCLUSION_TYPE_EXCLUDE + description: >- + If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a + finding to be returned. It still can be used for rules matching. + dictionary: + description: A list of phrases to detect as a CustomInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + regex: + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + description: Regular expression based CustomInfoType. type: object - GooglePrivacyDlpV2VersionDescription: + GooglePrivacyDlpV2DeidentifyDataSourceStats: type: object + id: GooglePrivacyDlpV2DeidentifyDataSourceStats properties: - description: + transformationErrorCount: + description: Number of errors encountered while trying to apply transformations. + format: int64 type: string - description: Description of the version. - version: - description: Name of the version + transformedBytes: + description: Total size in bytes that were transformed in some way. type: string - id: GooglePrivacyDlpV2VersionDescription - description: Details about each available version for an infotype. - GooglePrivacyDlpV2FieldId: - properties: - name: - description: Name describing the field. + format: int64 + transformationCount: + description: Number of successfully applied transformations. type: string - type: object - id: GooglePrivacyDlpV2FieldId - description: General identifier of a data field in a storage service. - GooglePrivacyDlpV2DatabaseResourceRegexes: - type: object - id: GooglePrivacyDlpV2DatabaseResourceRegexes + format: int64 + description: Summary of what was modified during a transformation. + GooglePrivacyDlpV2DiscoveryCloudSqlConditions: + id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions properties: - patterns: + databaseEngines: type: array description: >- - A group of regular expression patterns to match against one or more - database resources. Maximum of 100 entries. The sum of all regular - expression's length can't exceed 10 KiB. + Optional. Database engines that should be profiled. Optional. + Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' - description: >- - A collection of regular expressions to determine what database resources - to match against. - GooglePrivacyDlpV2ContentItem: - properties: - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2Table' + enum: + - DATABASE_ENGINE_UNSPECIFIED + - ALL_SUPPORTED_DATABASE_ENGINES + - MYSQL + - POSTGRES + type: string + enumDescriptions: + - Unused. + - Include all supported database engines. + - MySQL database. + - PostgreSQL database. + types: description: >- - Structured content for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table - to learn more. - byteItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' - description: Content data to inspect or redact. Replaces `type` and `data`. - value: - description: String data to inspect or redact. - type: string + Data profiles will only be generated for the database resource types + specified in this field. If not specified, defaults to + [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + items: + enumDescriptions: + - Unused. + - >- + Includes database resource types that become supported at a + later time. + - Tables. + enum: + - DATABASE_RESOURCE_TYPE_UNSPECIFIED + - DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES + - DATABASE_RESOURCE_TYPE_TABLE + type: string + type: array + description: >- + Requirements that must be true before a table is profiled for the first + time. type: object - id: GooglePrivacyDlpV2ContentItem - description: Type of content to inspect. - GooglePrivacyDlpV2BigQueryTableCollection: - description: Specifies a collection of BigQuery tables. Used for Discovery. - id: GooglePrivacyDlpV2BigQueryTableCollection - type: object - properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' - description: >- - A collection of regular expressions to match a BigQuery table - against. - GooglePrivacyDlpV2InspectJobConfig: - description: Controls what and how to inspect for findings. - id: GooglePrivacyDlpV2InspectJobConfig + GooglePrivacyDlpV2PubSubCondition: + id: GooglePrivacyDlpV2PubSubCondition + description: A condition consisting of a value. properties: - storageConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' - description: The data to scan. - inspectTemplateName: + minimumRiskScore: + description: The minimum data risk score that triggers the condition. + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH type: string - description: >- - If provided, will be used as the default for all values in - InspectConfig. `inspect_config` will be merged into the values - persisted as part of the template. - actions: + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + minimumSensitivityScore: + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH + description: The minimum sensitivity level that triggers the condition. + type: string + type: object + GooglePrivacyDlpV2ImageLocation: + id: GooglePrivacyDlpV2ImageLocation + properties: + boundingBoxes: type: array - description: Actions to execute at the completion of the job. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: How and what to scan for. + $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' + description: >- + Bounding boxes locating the pixels within the image containing the + finding. + description: Location of the finding within an image. type: object - GooglePrivacyDlpV2NumericalStatsConfig: + GooglePrivacyDlpV2SearchConnectionsResponse: type: object - description: >- - Compute numerical stats over an individual column, including min, max, - and quantiles. - id: GooglePrivacyDlpV2NumericalStatsConfig - properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Field to compute numerical stats on. Supported types are integer, - float, date, datetime, timestamp, time. - GooglePrivacyDlpV2RiskAnalysisJobConfig: - description: >- - Configuration for a risk analysis job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis - to learn more. + description: Response message for SearchConnections. properties: - sourceTable: - description: Input dataset to compute metrics over. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - privacyMetric: - description: Privacy metric to compute. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - actions: + connections: description: >- - Actions to execute at the completion of the job. Are executed in the - order provided. + List of connections that match the search query. Note that only a + subset of the fields will be populated, and only "name" is + guaranteed to be set. For full details of a Connection, call + GetConnection with the name. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + nextPageToken: + type: string + description: >- + Token to retrieve the next page of results. An empty value means + there are no more results. + id: GooglePrivacyDlpV2SearchConnectionsResponse + GooglePrivacyDlpV2DataRiskLevel: + id: GooglePrivacyDlpV2DataRiskLevel + description: >- + Score is a summary of all elements in the data profile. A higher number + means more risk. type: object - id: GooglePrivacyDlpV2RiskAnalysisJobConfig - GooglePrivacyDlpV2Disabled: - properties: {} - description: Do not profile the tables. + properties: + score: + type: string + enum: + - RISK_SCORE_UNSPECIFIED + - RISK_LOW + - RISK_UNKNOWN + - RISK_MODERATE + - RISK_HIGH + enumDescriptions: + - Unused. + - >- + Low risk - Lower indication of sensitive data that appears to have + additional access restrictions in place or no indication of + sensitive data found. + - Unable to determine risk. + - >- + Medium risk - Sensitive data may be present but additional access + or fine grain access restrictions appear to be present. Consider + limiting access even further or transform data to mask. + - >- + High risk – SPII may be present. Access controls may include + public ACLs. Exfiltration of data may lead to user data loss. + Re-identification of users may be possible. Consider limiting + usage and or removing SPII. + description: The score applied to the resource. + GooglePrivacyDlpV2DetectionRule: type: object - id: GooglePrivacyDlpV2Disabled - GooglePrivacyDlpV2CloudStorageDiscoveryTarget: + description: >- + Deprecated; use `InspectionRuleSet` instead. Rule for modifying a + `CustomInfoType` to alter behavior under certain circumstances, + depending on the specific details of the rule. Not supported for the + `surrogate_type` custom infoType. + id: GooglePrivacyDlpV2DetectionRule + properties: + hotwordRule: + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + description: Hotword-based detection rule. + GooglePrivacyDlpV2HybridFindingDetails: + id: GooglePrivacyDlpV2HybridFindingDetails type: object properties: - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryFileStoreConditions' + fileOffset: description: >- - Optional. In addition to matching the filter, these conditions must - be true before a profile is generated. - disabled: - description: Optional. Disable profiling for buckets that match this filter. - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - filter: + Offset in bytes of the line, from the beginning of the file, where + the finding is located. Populate if the item being scanned is only + part of a bigger item, such as a shard of a file and you want to + track the absolute position of the finding. + type: string + format: int64 + labels: + additionalProperties: + type: string description: >- - Required. The buckets the generation_cadence applies to. The first - target with a matching filter will be the one to apply to a bucket. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageFilter' - generationCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence + Labels to represent user provided metadata about the data being + inspected. If configured by the job, some key values may be + required. The labels associated with `Finding`'s produced by hybrid + inspection. Label keys must be between 1 and 63 characters long and + must conform to the following regular expression: + `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 + characters long and must conform to the regular expression + `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be + associated with a given finding. Examples: * `"environment" : + "production"` * `"pipeline" : "etl"` + type: object + containerDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' description: >- - Optional. How often and when to update profiles. New buckets that - match both the filter and conditions are scanned as quickly as - possible depending on system capacity. - id: GooglePrivacyDlpV2CloudStorageDiscoveryTarget - description: Target used to match against for discovery with Cloud Storage buckets. - GooglePrivacyDlpV2RedactImageResponse: - id: GooglePrivacyDlpV2RedactImageResponse - properties: - inspectResult: + Details about the container where the content being inspected is + from. + tableOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' description: >- - The findings. Populated when include_findings in the request is - true. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' - redactedImage: - type: string - description: The redacted image. The type will be the same as the original image. - format: byte - extractedText: + If the container is a table, additional information to make findings + meaningful such as the columns that are primary keys. If not known + ahead of time, can also be set within each inspect hybrid call and + the two will be merged. Note that identifying_fields will only be + stored to BigQuery, and only if the BigQuery action has been + included. + rowOffset: + format: int64 description: >- - If an image was being inspected and the InspectConfig's - include_quote was set to true, then this field will include all - text, if any, that was found in the image. + Offset of the row for tables. Populate if the row(s) being scanned + are part of a bigger dataset and you want to keep track of their + absolute position. type: string - type: object - description: Results of redacting an image. - GooglePrivacyDlpV2AuxiliaryTable: - id: GooglePrivacyDlpV2AuxiliaryTable - type: object - description: >- - An auxiliary table contains statistical information on the relative - frequency of different quasi-identifiers values. It has one or several - quasi-identifiers columns, and one column that indicates the relative - frequency of each quasi-identifier tuple. If a tuple is present in the - data but not in the auxiliary table, the corresponding relative - frequency is assumed to be zero (and thus, the tuple is highly - reidentifiable). + description: Populate to associate additional data with each finding. + GooglePrivacyDlpV2FieldTransformation: + description: The transformation to apply to the field. properties: - relativeFrequency: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + primitiveTransformation: + description: Apply the transformation to the entire field. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + fields: description: >- - Required. The relative frequency column must contain a - floating-point number between 0 and 1 (inclusive). Null values are - assumed to be zero. - table: - description: Required. Auxiliary table location. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - quasiIds: - description: Required. Quasi-identifier columns. + Required. Input field(s) to apply the transformation to. When you + have columns that reference their position within a list, omit the + index from the FieldId. FieldId name matching ignores the index. For + example, instead of "contact.nums[0].type", use "contact.nums.type". type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' - GooglePrivacyDlpV2CreateConnectionRequest: - id: GooglePrivacyDlpV2CreateConnectionRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + infoTypeTransformations: + description: >- + Treat the contents of the field as free text, and selectively + transform content that matches an `InfoType`. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + condition: + description: >- + Only apply the transformation if the condition evaluates to true for + the given `RecordCondition`. The conditions are allowed to reference + fields that are not used in the actual transformation. Example Use + Cases: - Apply a different bucket transformation to an age column if + the zip code column for the same record is within a specific range. + - Redact a field if the date of birth field is greater than 85. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + id: GooglePrivacyDlpV2FieldTransformation type: object - properties: - connection: - description: Required. The connection resource. - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: Request message for CreateConnection. - GooglePrivacyDlpV2DiscoveryGenerationCadence: + GooglePrivacyDlpV2DatabaseResourceRegexes: type: object + description: >- + A collection of regular expressions to determine what database resources + to match against. properties: - inspectTemplateModifiedCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - description: >- - Governs when to update data profiles when the inspection rules - defined by the `InspectTemplate` change. If not set, changing the - template will not cause a data profile to update. - schemaModifiedCadence: - description: Governs when to update data profiles when a schema is modified. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - tableModifiedCadence: - description: Governs when to update data profiles when a table is modified. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' - refreshFrequency: - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - type: string + patterns: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' + type: array description: >- - Frequency at which profiles should be updated, regardless of whether - the underlying resource has changed. Defaults to never. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - id: GooglePrivacyDlpV2DiscoveryGenerationCadence - description: >- - What must take place for a profile to be updated and how frequently it - should occur. New tables are scanned as quickly as possible depending on - system capacity. - GooglePrivacyDlpV2Location: - id: GooglePrivacyDlpV2Location + A group of regular expression patterns to match against one or more + database resources. Maximum of 100 entries. The sum of all regular + expression's length can't exceed 10 KiB. + id: GooglePrivacyDlpV2DatabaseResourceRegexes + GooglePrivacyDlpV2TableOptions: type: object properties: - codepointRange: - $ref: '#/components/schemas/GooglePrivacyDlpV2Range' - description: >- - Unicode character offsets delimiting the finding. These are relative - to the finding's containing element. Provided when the content is - text. - container: - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - description: >- - Information about the container where this finding occurred, if - available. - byteRange: + identifyingFields: description: >- - Zero-based byte offsets delimiting the finding. These are relative - to the finding's containing element. Note that when the content is - not textual, this references the UTF-8 encoded textual - representation of the content. Omitted if content is an image. - $ref: '#/components/schemas/GooglePrivacyDlpV2Range' - contentLocations: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' + The columns that are the primary keys for table objects included in + ContentItem. A copy of this cell's value will stored alongside + alongside each finding so that the finding can be traced to the + specific row it came from. No more than 3 may be provided. type: array - description: >- - List of nested objects pointing to the precise location of the - finding within the file or record. - description: Specifies the location of the finding. - GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + id: GooglePrivacyDlpV2TableOptions + description: Instructions regarding the table content being inspected. + GooglePrivacyDlpV2DiscoveryFileStoreConditions: properties: - refreshFrequency: - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY + createdAfter: + format: google-datetime type: string description: >- - Optional. Data changes in Cloud Storage can't trigger reprofiling. - If you set this field, profiles are refreshed at this frequency - regardless of whether the underlying buckets have changed. Defaults - to never. - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - inspectTemplateModifiedCadence: + Optional. File store must have been created after this date. Used to + avoid backfilling. + minAge: description: >- - Optional. Governs when to update data profiles when the inspection - rules defined by the `InspectTemplate` change. If not set, changing - the template will not cause a data profile to update. + Optional. Minimum age a file store must have. If set, the value must + be 1 hour or greater. + type: string + format: google-duration + cloudStorageConditions: + description: Optional. Cloud Storage conditions. $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - id: GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence - type: object + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageConditions description: >- - How often existing buckets should have their profiles refreshed. New - buckets are scanned as quickly as possible depending on system capacity. - GooglePrivacyDlpV2CharacterMaskConfig: + Requirements that must be true before a file store is scanned in + discovery for the first time. There is an AND relationship between the + top-level attributes. type: object - id: GooglePrivacyDlpV2CharacterMaskConfig + id: GooglePrivacyDlpV2DiscoveryFileStoreConditions + GooglePrivacyDlpV2PathElement: properties: - numberToMask: - type: integer - format: int32 - description: >- - Number of characters to mask. If not set, all matching chars will be - masked. Skipped characters do not count towards this tally. If - `number_to_mask` is negative, this denotes inverse masking. Cloud - DLP masks all but a number of characters. For example, suppose you - have the following values: - `masking_character` is `*` - - `number_to_mask` is `-4` - `reverse_order` is `false` - - `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` - The resulting de-identified string is `****-****-****-3456`. Cloud - DLP masks all but the last four characters. If `reverse_order` is - `true`, all but the first four characters are masked as - `1234-****-****-****`. - charactersToIgnore: + id: description: >- - When masking a string, items in this list will be skipped when - replacing characters. For example, if the input string is - `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 - characters with `*`, Cloud DLP returns `***-**5-5555`. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' - reverseOrder: + The auto-allocated ID of the entity. Never equal to zero. Values + less than zero are discouraged and may not be supported in the + future. + format: int64 + type: string + kind: description: >- - Mask characters in reverse order. For example, if - `masking_character` is `0`, `number_to_mask` is `14`, and - `reverse_order` is `false`, then the input string - `1234-5678-9012-3456` is masked as `00000000000000-3456`. If - `masking_character` is `*`, `number_to_mask` is `3`, and - `reverse_order` is `true`, then the string `12345` is masked as - `12***`. - type: boolean - maskingCharacter: + The kind of the entity. A kind matching regex `__.*__` is + reserved/read-only. A kind must not contain more than 1500 bytes + when UTF-8 encoded. Cannot be `""`. + type: string + name: type: string description: >- - Character to use to mask the sensitive values—for example, `*` for - an alphabetic string such as a name, or `0` for a numeric string - such as ZIP code or credit card number. This string must have a - length of 1. If not supplied, this value defaults to `*` for - strings, and `0` for digits. + The name of the entity. A name matching regex `__.*__` is + reserved/read-only. A name must not be more than 1500 bytes when + UTF-8 encoded. Cannot be `""`. description: >- - Partially mask a string by replacing a given number of characters with a - fixed character. Masking can start from the beginning or end of the - string. This can be used on data of any type (numbers, longs, and so on) - and when de-identifying structured data we'll attempt to preserve the - original data's type. (This allows you to take a long like 123 and - modify it to a string like **3. - GooglePrivacyDlpV2RequestedOptions: - properties: - snapshotInspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - description: >- - If run with an InspectTemplate, a snapshot of its state at the time - of this run. - jobConfig: - description: Inspect config. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + A (kind, ID/name) pair used to construct a key path. If either name or + ID is set, the element is complete. If neither is set, the element is + incomplete. + id: GooglePrivacyDlpV2PathElement type: object - id: GooglePrivacyDlpV2RequestedOptions - description: Snapshot of the inspection configuration. - GooglePrivacyDlpV2RecordCondition: + GooglePrivacyDlpV2DeidentifyContentRequest: type: object - id: GooglePrivacyDlpV2RecordCondition - description: >- - A condition for determining whether a transformation should be applied - to a field. - properties: - expressions: - description: An expression. - $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' - GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: + description: Request to de-identify a ContentItem. properties: - commonAlphabet: - type: string - enumDescriptions: - - Unused. - - '`[0-9]` (radix of 10)' - - '`[0-9A-F]` (radix of 16)' - - '`[0-9A-Z]` (radix of 36)' - - '`[0-9A-Za-z]` (radix of 62)' - description: Common alphabets. - enum: - - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED - - NUMERIC - - HEXADECIMAL - - UPPER_CASE_ALPHA_NUMERIC - - ALPHA_NUMERIC - surrogateInfoType: + inspectTemplateName: description: >- - The custom infoType to annotate the surrogate with. This annotation - will be applied to the surrogate by prefixing it with the name of - the custom infoType followed by the number of characters comprising - the surrogate. The following scheme defines the format: - info_type_name(surrogate_character_count):surrogate For example, if - the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the - surrogate is 'abc', the full replacement value will be: - 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate - when inspecting content using the custom infoType - [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). - This facilitates reversal of the surrogate when it occurs in free - text. In order for inspection to work properly, the name of this - infoType must not occur naturally anywhere in your data; otherwise, - inspection may find a surrogate that does not correspond to an - actual identifier. Therefore, choose your custom infoType name - carefully after considering what your data looks like. One way to - select a name that has a high chance of yielding reliable detection - is to include one or more unicode characters that are highly - improbable to exist in your data. For example, assuming your data is - entered from a regular ASCII keyboard, the symbol with the hex code - point 29DD might be used like so: ⧝MY_TOKEN_TYPE - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - cryptoKey: - description: Required. The key used by the encryption algorithm. - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - context: + Template to use. Any configuration directly specified in + inspect_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + type: string + locationId: + type: string + description: Deprecated. This field has no effect. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' description: >- - The 'tweak', a context may be used for higher security since the - same identifier in two different contexts won't be given the same - surrogate. If the context is not set, a default tweak will be used. - If the context is set but: 1. there is no record present when - transforming a given value or 1. the field is not present when - transforming a given value, a default tweak will be used. Note that - case (1) is expected when an `InfoTypeTransformation` is applied to - both structured and unstructured `ContentItem`s. Currently, the - referenced field may be of value type integer or string. The tweak - is constructed as a sequence of bytes in big endian byte order such - that: - a 64 bit integer is encoded followed by a single byte of - value 1 - a string is encoded in UTF-8 format followed by a single - byte of value 2 - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - customAlphabet: + Configuration for the inspector. Items specified here will override + the template referenced by the inspect_template_name argument. + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' description: >- - This is supported by mapping these to the alphanumeric characters - that the FFX mode natively supports. This happens before/after - encryption/decryption. Each character listed must appear only once. - Number of characters must be in the range [2, 95]. This must be - encoded as ASCII. The order of characters does not matter. The full - list of allowed characters is: - ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` + The item to de-identify. Will be treated as text. This value must be + of type Table if your deidentify_config is a RecordTransformations + object. + deidentifyTemplateName: type: string - radix: + description: >- + Template to use. Any configuration directly specified in + deidentify_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + deidentifyConfig: + description: >- + Configuration for the de-identification of the content item. Items + specified here will override the template referenced by the + deidentify_template_name argument. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + id: GooglePrivacyDlpV2DeidentifyContentRequest + GooglePrivacyDlpV2InfoTypeLimit: + properties: + infoType: + description: >- + Type of information the findings limit applies to. Only one limit + per info_type should be provided. If InfoTypeLimit does not have an + info_type, the DLP API applies the limit against all info_types that + are found but not specified in another InfoTypeLimit. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + maxFindings: format: int32 type: integer - description: The native way to select the alphabet. Must be in the range [2, 95]. - id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig - description: >- - Replaces an identifier with a surrogate using Format Preserving - Encryption (FPE) with the FFX mode of operation; however when used in - the `ReidentifyContent` API method, it serves the opposite function by - reversing the surrogate back into the original identifier. The - identifier must be encoded as ASCII. For a given crypto key and context, - the same identifier will be replaced with the same surrogate. - Identifiers must be at least two characters long. In the case that the - identifier is the empty string, it will be skipped. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization - to learn more. Note: We recommend using CryptoDeterministicConfig for - all use cases which do not require preserving the input alphabet space - and size, plus warrant referential integrity. + description: Max findings limit for the given infoType. + id: GooglePrivacyDlpV2InfoTypeLimit type: object - GooglePrivacyDlpV2InfoTypeStats: + description: >- + Max findings configuration per infoType, per content item or long + running DlpJob. + GooglePrivacyDlpV2CategoricalStatsHistogramBucket: type: object - description: Statistics regarding a specific InfoType. - id: GooglePrivacyDlpV2InfoTypeStats properties: - count: + valueFrequencyLowerBound: format: int64 + description: Lower bound on the value frequency of the values in this bucket. type: string - description: Number of findings for this infoType. - infoType: - description: The type of finding this stat is for. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - GooglePrivacyDlpV2CancelDlpJobRequest: - properties: {} - id: GooglePrivacyDlpV2CancelDlpJobRequest - description: The request message for canceling a DLP job. - type: object - GooglePrivacyDlpV2Manual: - properties: {} - id: GooglePrivacyDlpV2Manual - type: object - description: >- - Job trigger option for hybrid jobs. Jobs must be manually created and - finished. - GooglePrivacyDlpV2BigQueryTableTypes: - id: GooglePrivacyDlpV2BigQueryTableTypes - properties: - types: + bucketValueCount: + description: Total number of distinct values in this bucket. + type: string + format: int64 + bucketSize: + format: int64 + type: string + description: Total number of values in this bucket. + bucketValues: type: array items: - enum: - - BIG_QUERY_TABLE_TYPE_UNSPECIFIED - - BIG_QUERY_TABLE_TYPE_TABLE - - BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE - enumDescriptions: - - Unused. - - A normal BigQuery table. - - A table that references data stored in Cloud Storage. - type: string - description: A set of BigQuery table types. - description: The types of BigQuery tables supported by Cloud DLP. - type: object - GooglePrivacyDlpV2SecretsDiscoveryTarget: - id: GooglePrivacyDlpV2SecretsDiscoveryTarget - properties: {} - type: object - description: >- - Discovery target for credentials and secrets in cloud resource metadata. - This target does not include any filtering or frequency controls. Cloud - DLP will scan cloud resource metadata for secrets daily. No inspect - template should be included in the discovery config for a security - benchmarks scan. Instead, the built-in list of secrets and credentials - infoTypes will be used (see - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). - Credentials and secrets discovered will be reported as vulnerabilities - to Security Command Center. - GooglePrivacyDlpV2DiscoveryBigQueryConditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + description: >- + Sample of value frequencies in this bucket. The total number of + values returned per bucket is capped at 20. + valueFrequencyUpperBound: + format: int64 + description: Upper bound on the value frequency of the values in this bucket. + type: string + id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket + description: Histogram of value frequencies in the column. + GooglePrivacyDlpV2Value: properties: - createdAfter: + stringValue: type: string - description: >- - BigQuery table must have been created after this date. Used to avoid - backfilling. - format: google-datetime - orConditions: - description: >- - At least one of the conditions must be true for a table to be - scanned. - $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' - typeCollection: - enum: - - BIG_QUERY_COLLECTION_UNSPECIFIED - - BIG_QUERY_COLLECTION_ALL_TYPES - - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES + description: string + dayOfWeekValue: type: string - description: Restrict discovery to categories of table types. + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY enumDescriptions: - - Unused. - - >- - Automatically generate profiles for all tables, even if the table - type is not yet fully supported for analysis. Profiles for - unsupported tables will be generated with errors to indicate their - partial support. When full support is added, the tables will - automatically be profiled during the next scheduled run. - - >- - Only those types fully supported will be profiled. Will expand - automatically as Cloud DLP adds support for new table types. - Unsupported table types will not have partial profiles generated. - types: - description: Restrict discovery to specific table types. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' - id: GooglePrivacyDlpV2DiscoveryBigQueryConditions + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + description: day of week + timestampValue: + format: google-datetime + description: timestamp + type: string + timeValue: + description: time of day + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + dateValue: + $ref: '#/components/schemas/GoogleTypeDate' + description: date + booleanValue: + description: boolean + type: boolean + integerValue: + type: string + format: int64 + description: integer + floatValue: + format: double + type: number + description: float + id: GooglePrivacyDlpV2Value type: object description: >- - Requirements that must be true before a table is scanned in discovery - for the first time. There is an AND relationship between the top-level - attributes. Additionally, minimum conditions with an OR relationship - that must be met before Cloud DLP scans a table can be set (like a - minimum row count or a minimum table age). - GooglePrivacyDlpV2ImageRedactionConfig: - description: Configuration for determining how redaction of images should occur. + Set of primitive values supported by the system. Note that for the + purposes of inspection or transformation, the number of bytes considered + to comprise a 'Value' is based on its representation as a UTF-8 encoded + string. For example, if 'integer_value' is set to 123456789, the number + of bytes would be counted as 9, even though an int64 only holds up to 8 + bytes of data. + GooglePrivacyDlpV2DateTime: + id: GooglePrivacyDlpV2DateTime properties: - redactionColor: - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' - description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - redactAllText: - type: boolean - description: >- - If true, all text found in the image, regardless whether it matches - an info_type, is redacted. Only one should be provided. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + dayOfWeek: + description: Day of week + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + type: string + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + timeZone: + $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' + description: Time zone + time: + description: Time of day + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + date: description: >- - Only one per info_type should be provided per request. If not - specified, and redact_all_text is false, the DLP API will redact all - text that it matches against all info_types that are found, but not - specified in another ImageRedactionConfig. + One or more of the following must be set. Must be a valid date or + time value. + $ref: '#/components/schemas/GoogleTypeDate' type: object - id: GooglePrivacyDlpV2ImageRedactionConfig - GooglePrivacyDlpV2ImageTransformations: + description: Message for a date time object. e.g. 2018-01-01, 5th August. + GooglePrivacyDlpV2InfoType: type: object + description: Type of information detected by the API. properties: - transforms: - description: List of transforms to make. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' - type: array - id: GooglePrivacyDlpV2ImageTransformations - description: A type of transformation that is applied over images. - GooglePrivacyDlpV2DataProfilePubSubCondition: - description: A condition for determining whether a Pub/Sub should be triggered. + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: >- + Optional custom sensitivity for this InfoType. This only applies to + data profiling. + name: + type: string + description: >- + Name of the information type. Either a name of your choosing when + creating a CustomInfoType, or one of the names listed at + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + when specifying a built-in type. When sending Cloud DLP results to + Data Catalog, infoType names should conform to the pattern + `[A-Za-z0-9$_-]{1,64}`. + version: + description: Optional version name for this InfoType. + type: string + id: GooglePrivacyDlpV2InfoType + GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: type: object + description: Request message for CreateDeidentifyTemplate. + id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest properties: - expressions: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' - description: An expression. - id: GooglePrivacyDlpV2DataProfilePubSubCondition - GooglePrivacyDlpV2CategoricalStatsResult: - id: GooglePrivacyDlpV2CategoricalStatsResult + locationId: + description: Deprecated. This field has no effect. + type: string + templateId: + description: >- + The template id can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + type: string + deidentifyTemplate: + description: Required. The DeidentifyTemplate to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + GooglePrivacyDlpV2TableReference: type: object + id: GooglePrivacyDlpV2TableReference properties: - valueFrequencyHistogramBuckets: - type: array - description: Histogram of value frequencies in the column. - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket - description: Result of the categorical stats computation. - GooglePrivacyDlpV2QuoteInfo: - id: GooglePrivacyDlpV2QuoteInfo - description: Message for infoType-dependent details parsed from quote. + datasetId: + description: Dataset ID of the table. + type: string + tableId: + description: Name of the table. + type: string + description: >- + Message defining the location of a BigQuery table with the projectId + inferred from the parent project. + GooglePrivacyDlpV2DiscoveryCloudSqlFilter: + description: >- + Determines what tables will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID, location, instance, database, and + database resource name. type: object properties: - dateTime: - $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' - description: The date time indicated by the quote. - GooglePrivacyDlpV2SummaryResult: + collection: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' + description: A specific set of database resources for this filter to apply to. + databaseResourceReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' + description: >- + The database resource to scan. Targets including this can only + include one target (the target with this database resource + reference). + others: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherDatabaseResources' + description: >- + Catch-all. This should always be the last target in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. + id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter + GooglePrivacyDlpV2CategoricalStatsConfig: + description: >- + Compute numerical stats over an individual column, including number of + distinct values and value count distribution. + type: object properties: - count: - format: int64 - type: string - description: Number of transformations counted by this result. - code: - enum: - - TRANSFORMATION_RESULT_CODE_UNSPECIFIED - - SUCCESS - - ERROR - enumDescriptions: - - Unused - - Transformation completed without an error. - - Transformation had an error. - type: string - description: Outcome of the transformation. - details: + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - A place for warnings or errors to show up if a transformation didn't - work as expected. - type: string + Field to compute categorical stats on. All column types are + supported except for arrays and structs. However, it may be more + informative to use NumericalStats when the field type is supported, + depending on the data. + id: GooglePrivacyDlpV2CategoricalStatsConfig + GooglePrivacyDlpV2ActivateJobTriggerRequest: + description: Request message for ActivateJobTrigger. + properties: {} type: object - id: GooglePrivacyDlpV2SummaryResult + id: GooglePrivacyDlpV2ActivateJobTriggerRequest + GooglePrivacyDlpV2HybridContentItem: description: >- - A collection that informs the user the number of times a particular - `TransformationResultCode` and error details occurred. - GooglePrivacyDlpV2TimeZone: + An individual hybrid item to inspect. Will be stored temporarily during + processing. + properties: + findingDetails: + description: Supplementary information that will be added to each finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' + item: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + id: GooglePrivacyDlpV2HybridContentItem type: object - id: GooglePrivacyDlpV2TimeZone + GooglePrivacyDlpV2FileStoreInfoTypeSummary: + description: Information regarding the discovered InfoType. properties: - offsetMinutes: - type: integer + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: The InfoType seen. + type: object + id: GooglePrivacyDlpV2FileStoreInfoTypeSummary + GooglePrivacyDlpV2ListConnectionsResponse: + type: object + description: Response message for ListConnections. + id: GooglePrivacyDlpV2ListConnectionsResponse + properties: + nextPageToken: + type: string description: >- - Set only if the offset can be determined. Positive for time ahead of - UTC. E.g. For "UTC-9", this value is -540. - format: int32 - description: Time zone of the date time object. - GooglePrivacyDlpV2KAnonymityConfig: - id: GooglePrivacyDlpV2KAnonymityConfig + Token to retrieve the next page of results. An empty value means + there are no more results. + connections: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + description: List of connections. + type: array + GooglePrivacyDlpV2ReplaceDictionaryConfig: type: object - description: k-anonymity metric, used for analysis of reidentification risk. + id: GooglePrivacyDlpV2ReplaceDictionaryConfig properties: - entityId: - $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' + wordList: + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' description: >- - Message indicating that multiple rows might be associated to a - single individual. If the same entity_id is associated to multiple - quasi-identifier tuples over distinct rows, we consider the entire - collection of tuples as the composite quasi-identifier. This - collection is a multiset: the order in which the different tuples - appear in the dataset is ignored, but their frequency is taken into - account. Important note: a maximum of 1000 rows can be associated to - a single entity ID. If more rows are associated with the same entity - ID, some might be ignored. - quasiIds: - description: >- - Set of fields to compute k-anonymity over. When multiple fields are - specified, they are considered a single composite key. Structs and - repeated data types are not supported; however, nested fields are - supported so long as they are not structs themselves or nested - within a repeated field. + A list of words to select from for random replacement. The + [limits](https://cloud.google.com/sensitive-data-protection/limits) + page contains details about the size limits of dictionaries. + description: >- + Replace each input value with a value randomly selected from the + dictionary. + GooglePrivacyDlpV2Key: + properties: + path: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' type: array - GooglePrivacyDlpV2TagValue: - properties: - namespacedValue: - type: string description: >- - The namespaced name for the tag value to attach to resources. Must - be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, - for example, "123456/environment/prod". - description: A value of a tag. - id: GooglePrivacyDlpV2TagValue + The entity path. An entity path consists of one or more elements + composed of a kind and a string or numerical identifier, which + identify entities. The first element identifies a _root entity_, the + second element identifies a _child_ of the root entity, the third + element identifies a child of the second entity, and so forth. The + entities identified by all prefixes of the path are called the + element's _ancestors_. A path can never be empty, and a path can + have at most 100 elements. + partitionId: + $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' + description: >- + Entities are partitioned into subsets, currently identified by a + project ID and namespace ID. Queries are scoped to a single + partition. + description: >- + A unique identifier for a Datastore entity. If a key's partition ID or + any of its path kinds or names are reserved/read-only, the key is + reserved/read-only. A reserved/read-only key is forbidden in certain + documented contexts. type: object - GooglePrivacyDlpV2InfoTypeLimit: - id: GooglePrivacyDlpV2InfoTypeLimit + id: GooglePrivacyDlpV2Key + GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: + description: Result of a risk analysis operation request. + id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails type: object properties: - maxFindings: + requestedPrivacyMetric: + description: Privacy metric to compute. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + categoricalStatsResult: + description: Categorical stats result + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' + deltaPresenceEstimationResult: + description: Delta-presence result + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' + lDiversityResult: + description: L-divesity result + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' + requestedSourceTable: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Input dataset to compute metrics over. + numericalStatsResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' + description: Numerical stats result + kMapEstimationResult: + description: K-map result + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' + requestedOptions: + description: The configuration used for this job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' + kAnonymityResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' + description: K-anonymity result + GooglePrivacyDlpV2HybridInspectJobTriggerRequest: + description: Request to search for potentially sensitive info in a custom location. + type: object + properties: + hybridItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + description: The item to inspect. + id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest + GooglePrivacyDlpV2FindingLimits: + description: >- + Configuration to control the number of findings returned for inspection. + This is not used for de-identification or data profiling. When redacting + sensitive data from images, finding limits don't apply. They can cause + unexpected or inconsistent results, where only some data is redacted. + Don't include finding limits in RedactImage requests. Otherwise, Cloud + DLP returns an error. + type: object + properties: + maxFindingsPerItem: format: int32 - description: Max findings limit for the given infoType. type: integer - infoType: description: >- - Type of information the findings limit applies to. Only one limit - per info_type should be provided. If InfoTypeLimit does not have an - info_type, the DLP API applies the limit against all info_types that - are found but not specified in another InfoTypeLimit. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - Max findings configuration per infoType, per content item or long - running DlpJob. - GooglePrivacyDlpV2DeidentifyDataSourceStats: - properties: - transformationErrorCount: - format: int64 - description: Number of errors encountered while trying to apply transformations. - type: string - transformationCount: - type: string - description: Number of successfully applied transformations. - format: int64 - transformedBytes: - type: string - description: Total size in bytes that were transformed in some way. - format: int64 - id: GooglePrivacyDlpV2DeidentifyDataSourceStats - description: Summary of what was modified during a transformation. + Max number of findings that are returned for each item scanned. When + set within an InspectContentRequest, this field is ignored. This + value isn't a hard limit. If the number of findings for an item + reaches this limit, the inspection of that item ends gradually, not + abruptly. Therefore, the actual number of findings that Cloud DLP + returns for the item can be multiple times higher than this value. + maxFindingsPerInfoType: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' + description: Configuration of findings limit given for specified infoTypes. + maxFindingsPerRequest: + type: integer + format: int32 + description: >- + Max number of findings that are returned per request or job. If you + set this field in an InspectContentRequest, the resulting maximum + value is the value that you set or 3,000, whichever is lower. This + value isn't a hard limit. If an inspection reaches this limit, the + inspection ends gradually, not abruptly. Therefore, the actual + number of findings that Cloud DLP returns can be multiple times + higher than this value. + id: GooglePrivacyDlpV2FindingLimits + GooglePrivacyDlpV2ThrowError: + description: Throw an error and fail the request when a transformation error occurs. type: object + properties: {} + id: GooglePrivacyDlpV2ThrowError GooglePrivacyDlpV2EntityId: type: object properties: @@ -4373,970 +3809,800 @@ components: patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity. - GooglePrivacyDlpV2RequestedDeidentifyOptions: - id: GooglePrivacyDlpV2RequestedDeidentifyOptions - properties: - snapshotImageRedactTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: >- - Snapshot of the state of the image transformation - `DeidentifyTemplate` from the `Deidentify` action at the time this - job was run. - snapshotDeidentifyTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: >- - Snapshot of the state of the `DeidentifyTemplate` from the - Deidentify action at the time this job was run. - snapshotStructuredDeidentifyTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: >- - Snapshot of the state of the structured `DeidentifyTemplate` from - the `Deidentify` action at the time this job was run. - description: De-identification options. - type: object - GooglePrivacyDlpV2TransientCryptoKey: - id: GooglePrivacyDlpV2TransientCryptoKey - type: object + GooglePrivacyDlpV2BigQueryRegexes: description: >- - Use this to have a random data crypto key generated. It will be - discarded after the request finishes. + A collection of regular expressions to determine what tables to match + against. + id: GooglePrivacyDlpV2BigQueryRegexes + type: object properties: - name: - type: string + patterns: description: >- - Required. Name of the key. This is an arbitrary string used to - differentiate different keys. A unique key is generated per name: - two separate `TransientCryptoKey` protos share the same generated - key if their names are the same. When the data crypto key is - generated, this name is not used in any way (repeating the api call - will result in a different key being generated). - GooglePrivacyDlpV2DatabaseResourceCollection: + A single BigQuery regular expression pattern to match against one or + more tables, datasets, or projects that contain BigQuery tables. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' + GooglePrivacyDlpV2CryptoHashConfig: type: object properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' - description: >- - A collection of regular expressions to match a database resource - against. - id: GooglePrivacyDlpV2DatabaseResourceCollection + cryptoKey: + description: The key used by the hash function. + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + id: GooglePrivacyDlpV2CryptoHashConfig description: >- - Match database resources using regex filters. Examples of database - resources are tables, views, and stored procedures. - GooglePrivacyDlpV2DataRiskLevel: + Pseudonymization method that generates surrogates via cryptographic + hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. + Outputs a base64 encoded representation of the hashed output (for + example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only + string and integer values can be hashed. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + to learn more. + GooglePrivacyDlpV2StorageConfig: + description: Shared message indicating Cloud storage type. + type: object + properties: + timespanConfig: + description: Configuration of the timespan of the items to include in scanning. + $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' + bigQueryOptions: + description: BigQuery options. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' + hybridOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' + description: Hybrid inspection options. + cloudStorageOptions: + description: Cloud Storage options. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' + datastoreOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' + description: Google Cloud Datastore options. + id: GooglePrivacyDlpV2StorageConfig + GooglePrivacyDlpV2RecordTransformations: description: >- - Score is a summary of all elements in the data profile. A higher number - means more risk. + A type of transformation that is applied over structured data such as a + table. + id: GooglePrivacyDlpV2RecordTransformations type: object - id: GooglePrivacyDlpV2DataRiskLevel properties: - score: - description: The score applied to the resource. - enumDescriptions: - - Unused. - - >- - Low risk - Lower indication of sensitive data that appears to have - additional access restrictions in place or no indication of - sensitive data found. - - Unable to determine risk. - - >- - Medium risk - Sensitive data may be present but additional access - or fine grain access restrictions appear to be present. Consider - limiting access even further or transform data to mask. - - >- - High risk – SPII may be present. Access controls may include - public ACLs. Exfiltration of data may lead to user data loss. - Re-identification of users may be possible. Consider limiting - usage and or removing SPII. - enum: - - RISK_SCORE_UNSPECIFIED - - RISK_LOW - - RISK_UNKNOWN - - RISK_MODERATE - - RISK_HIGH - type: string - GooglePrivacyDlpV2Container: - properties: - projectId: - type: string - description: >- - Project where the finding was found. Can be different from the - project that owns the finding. - relativePath: - type: string - description: >- - The rest of the path after the root. Examples: - For BigQuery table - `project_id:dataset_id.table_id`, the relative path is `table_id` - - For Cloud Storage file `gs://bucket/folder/filename.txt`, the - relative path is `folder/filename.txt` - fullPath: - type: string - description: >- - A string representation of the full container name. Examples: - - BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: - 'gs://Bucket/folders/filename.txt' - updateTime: - description: >- - Findings container modification timestamp, if applicable. For Cloud - Storage, this field contains the last file modification timestamp. - For a BigQuery table, this field contains the last_modified_time - property. For Datastore, this field isn't populated. - format: google-datetime - type: string - rootPath: - description: >- - The root of the container. Examples: - For BigQuery table - `project_id:dataset_id.table_id`, the root is `dataset_id` - For - Cloud Storage file `gs://bucket/folder/filename.txt`, the root is - `gs://bucket` - type: string - type: - description: Container type, for example BigQuery or Cloud Storage. - type: string - version: - type: string - description: >- - Findings container version, if available ("generation" for Cloud - Storage). - type: object - description: >- - Represents a container that may contain DLP findings. Examples of a - container include a file, table, or database record. - id: GooglePrivacyDlpV2Container - GooglePrivacyDlpV2HybridFindingDetails: - description: Populate to associate additional data with each finding. - properties: - tableOptions: - description: >- - If the container is a table, additional information to make findings - meaningful such as the columns that are primary keys. If not known - ahead of time, can also be set within each inspect hybrid call and - the two will be merged. Note that identifying_fields will only be - stored to BigQuery, and only if the BigQuery action has been - included. - $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' - rowOffset: - type: string - description: >- - Offset of the row for tables. Populate if the row(s) being scanned - are part of a bigger dataset and you want to keep track of their - absolute position. - format: int64 - fileOffset: - type: string - description: >- - Offset in bytes of the line, from the beginning of the file, where - the finding is located. Populate if the item being scanned is only - part of a bigger item, such as a shard of a file and you want to - track the absolute position of the finding. - format: int64 - containerDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - description: >- - Details about the container where the content being inspected is - from. - labels: - additionalProperties: - type: string - description: >- - Labels to represent user provided metadata about the data being - inspected. If configured by the job, some key values may be - required. The labels associated with `Finding`'s produced by hybrid - inspection. Label keys must be between 1 and 63 characters long and - must conform to the following regular expression: - `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 - characters long and must conform to the regular expression - `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be - associated with a given finding. Examples: * `"environment" : - "production"` * `"pipeline" : "etl"` - type: object - id: GooglePrivacyDlpV2HybridFindingDetails - type: object - GooglePrivacyDlpV2KMapEstimationResult: - type: object - description: >- - Result of the reidentifiability analysis. Note that these results are an - estimation, not exact values. - id: GooglePrivacyDlpV2KMapEstimationResult - properties: - kMapEstimationHistogram: - description: >- - The intervals [min_anonymity, max_anonymity] do not overlap. If a - value doesn't correspond to any such interval, the associated - frequency is zero. For example, the following records: - {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: - 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, - max_anonymity: 10, frequency: 99} mean that there are no record with - an estimated anonymity of 4, 5, or larger than 10. + fieldTransformations: + type: array items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + description: Transform the record by applying various field transformations. + recordSuppressions: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + description: >- + Configuration defining which records get suppressed entirely. + Records that match any suppression rule are omitted from the output. type: array - GooglePrivacyDlpV2SensitivityScore: - description: >- - Score is calculated from of all elements in the data profile. A higher - level means the data is more sensitive. - type: object - properties: - score: - enumDescriptions: - - Unused. - - >- - No sensitive information detected. The resource isn't publicly - accessible. - - Unable to determine sensitivity. - - >- - Medium risk. Contains personally identifiable information (PII), - potentially sensitive data, or fields with free-text data that are - at a higher risk of having intermittent sensitive data. Consider - limiting access. - - >- - High risk. Sensitive personally identifiable information (SPII) - can be present. Exfiltration of data can lead to user data loss. - Re-identification of users might be possible. Consider limiting - usage and or removing SPII. - enum: - - SENSITIVITY_SCORE_UNSPECIFIED - - SENSITIVITY_LOW - - SENSITIVITY_UNKNOWN - - SENSITIVITY_MODERATE - - SENSITIVITY_HIGH - description: The sensitivity score applied to the resource. - type: string - id: GooglePrivacyDlpV2SensitivityScore - GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: + GooglePrivacyDlpV2DiscoveryGenerationCadence: + id: GooglePrivacyDlpV2DiscoveryGenerationCadence properties: - schemaModifiedCadence: - $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' - description: When to reprofile if the schema has changed. - inspectTemplateModifiedCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - description: >- - Governs when to update data profiles when the inspection rules - defined by the `InspectTemplate` change. If not set, changing the - template will not cause a data profile to update. + tableModifiedCadence: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' + description: Governs when to update data profiles when a table is modified. refreshFrequency: enumDescriptions: - Unspecified. - After the data profile is created, it will never be updated. - The data profile can be updated up to once every 24 hours. - The data profile can be updated up to once every 30 days. Default. + description: >- + Frequency at which profiles should be updated, regardless of whether + the underlying resource has changed. Defaults to never. enum: - UPDATE_FREQUENCY_UNSPECIFIED - UPDATE_FREQUENCY_NEVER - UPDATE_FREQUENCY_DAILY - UPDATE_FREQUENCY_MONTHLY - description: >- - Data changes (non-schema changes) in Cloud SQL tables can't trigger - reprofiling. If you set this field, profiles are refreshed at this - frequency regardless of whether the underlying tables have changed. - Defaults to never. type: string - type: object - id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + schemaModifiedCadence: + description: Governs when to update data profiles when a schema is modified. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + inspectTemplateModifiedCadence: + description: >- + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence description: >- - How often existing tables should have their profiles refreshed. New - tables are scanned as quickly as possible depending on system capacity. - GooglePrivacyDlpV2CategoricalStatsHistogramBucket: - description: Histogram of value frequencies in the column. - id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket + What must take place for a profile to be updated and how frequently it + should occur. New tables are scanned as quickly as possible depending on + system capacity. + type: object + GooglePrivacyDlpV2BigQueryOptions: type: object + description: Options defining BigQuery table and row identifiers. properties: - valueFrequencyUpperBound: - description: Upper bound on the value frequency of the values in this bucket. - type: string - format: int64 - bucketValueCount: - type: string - format: int64 - description: Total number of distinct values in this bucket. - bucketSize: - type: string - format: int64 - description: Total number of values in this bucket. - bucketValues: + identifyingFields: + description: >- + Table fields that may uniquely identify a row within the table. When + `actions.saveFindings.outputConfig.table` is specified, the values + of columns specified here are available in the output table under + `location.content_locations.record_location.record_key.id_values`. + Nested fields such as `person.birthdate.year` are allowed. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + tableReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Complete BigQuery table reference. + includedFields: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Sample of value frequencies in this bucket. The total number of - values returned per bucket is capped at 20. - valueFrequencyLowerBound: - description: Lower bound on the value frequency of the values in this bucket. + Limit scanning only to these fields. When inspecting a table, we + recommend that you inspect all columns. Otherwise, findings might be + affected because hints from excluded columns will not be used. + type: array + rowsLimit: format: int64 type: string - GooglePrivacyDlpV2ReplaceDictionaryConfig: + description: >- + Max number of rows to scan. If the table has more rows than this + value, the rest of the rows are omitted. If not set, or if set to 0, + all rows will be scanned. Only one of rows_limit and + rows_limit_percent can be specified. Cannot be used in conjunction + with TimespanConfig. + sampleMethod: + enum: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START + enumDescriptions: + - No sampling. + - >- + Scan groups of rows in the order BigQuery provides (default). + Multiple groups of rows may be scanned in parallel, so results may + not appear in the same order the rows are read. + - Randomly pick groups of rows to scan. + description: How to sample the data. + type: string + excludedFields: + description: >- + References to fields excluded from scanning. This allows you to skip + inspection of entire columns which you know have no findings. When + inspecting a table, we recommend that you inspect all columns. + Otherwise, findings might be affected because hints from excluded + columns will not be used. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + rowsLimitPercent: + description: >- + Max percentage of rows to scan. The rest are omitted. The number of + rows scanned is rounded down. Must be between 0 and 100, + inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one + of rows_limit and rows_limit_percent can be specified. Cannot be + used in conjunction with TimespanConfig. Caution: A [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) + is causing the `rowsLimitPercent` field to behave unexpectedly. We + recommend using `rowsLimit` instead. + format: int32 + type: integer + id: GooglePrivacyDlpV2BigQueryOptions + GooglePrivacyDlpV2TagCondition: + type: object properties: - wordList: - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + tag: + description: The tag value to attach to resources. + $ref: '#/components/schemas/GooglePrivacyDlpV2TagValue' + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' description: >- - A list of words to select from for random replacement. The - [limits](https://cloud.google.com/sensitive-data-protection/limits) - page contains details about the size limits of dictionaries. + Conditions attaching the tag to a resource on its profile having + this sensitivity score. + id: GooglePrivacyDlpV2TagCondition description: >- - Replace each input value with a value randomly selected from the - dictionary. - id: GooglePrivacyDlpV2ReplaceDictionaryConfig + The tag to attach to profiles matching the condition. At most one + `TagCondition` can be specified per sensitivity level. + GooglePrivacyDlpV2DatastoreOptions: + description: Options defining a data set within Google Cloud Datastore. + properties: + kind: + description: The kind to process. + $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' + partitionId: + $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' + description: >- + A partition ID identifies a grouping of entities. The grouping is + always by project and namespace, however the namespace ID may be + empty. + id: GooglePrivacyDlpV2DatastoreOptions type: object - GooglePrivacyDlpV2StoredInfoTypeConfig: + GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: + properties: {} type: object - id: GooglePrivacyDlpV2StoredInfoTypeConfig + id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig + description: Replace each matching finding with the name of the info_type. + GooglePrivacyDlpV2CloudStorageRegex: description: >- - Configuration for stored infoTypes. All fields and subfield are provided - by the user. For more information, see - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. + A pattern to match against one or more file stores. At least one pattern + must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + id: GooglePrivacyDlpV2CloudStorageRegex properties: - dictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - description: Store dictionary-based CustomInfoType. - description: + projectIdRegex: type: string - description: Description of the StoredInfoType (max 256 characters). - regex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Store regular expression-based StoredInfoType. - displayName: + description: Optional. For organizations, if unset, will match all projects. + bucketNameRegex: type: string - description: Display name of the StoredInfoType (max 256 characters). - largeCustomDictionary: description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' - GooglePrivacyDlpV2Range: - id: GooglePrivacyDlpV2Range + Optional. Regex to test the bucket name against. If empty, all + buckets match. Example: "marketing2021" or "(marketing)\d{4}" will + both match the bucket gs://marketing2021 type: object - description: Generic half-open interval [start, end) + GooglePrivacyDlpV2TransformationDetails: properties: - start: + transformation: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' + type: array + description: >- + Description of transformation. This would only contain more than one + element if there were multiple matching transformations and which + one to apply was ambiguous. Not set for states that contain no + transformation, currently only state that contains no transformation + is TransformationResultStateType.METADATA_UNRETRIEVABLE. + transformationLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' + description: >- + The precise location of the transformed content in the original + container. + resourceName: + description: The name of the job that completed the transformation. type: string - description: Index of the first character of the range (inclusive). - format: int64 - end: - description: Index of the last character of the range (exclusive). + containerName: + description: >- + The top level name of the container where the transformation is + located (this will be the source file name or table name). + type: string + statusDetails: + description: >- + Status of the transformation, if transformation was not successful, + this will specify what caused it to fail, otherwise it will show + that the transformation was successful. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' + transformedBytes: format: int64 + description: >- + The number of bytes that were transformed. If transformation was + unsuccessful or did not take place because there was no content to + transform, this will be zero. type: string - GooglePrivacyDlpV2ValueFrequency: - description: A value of a field, including its frequency. - id: GooglePrivacyDlpV2ValueFrequency type: object + description: >- + Details about a single transformation. This object contains a + description of the transformation, information about whether the + transformation was successfully applied, and the precise location where + the transformation occurred. These details are stored in a + user-specified BigQuery table. + id: GooglePrivacyDlpV2TransformationDetails + GooglePrivacyDlpV2WordList: properties: - value: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: A value contained in the field in question. - count: - description: How many times the value is contained in the field. - type: string - format: int64 - GooglePrivacyDlpV2JobTrigger: - properties: - createTime: - format: google-datetime - description: Output only. The creation timestamp of a triggeredJob. - readOnly: true - type: string - name: - type: string - description: >- - Unique resource name for the triggeredJob, assigned by the service - when the triggeredJob is created, for example - `projects/dlp-test-project/jobTriggers/53234423`. - errors: + words: description: >- - Output only. A stream of errors encountered when the trigger was - activated. Repeated errors may result in the JobTrigger - automatically being paused. Will return the last 100 errors. - Whenever the JobTrigger is modified this list will be cleared. + Words or phrases defining the dictionary. The dictionary must + contain at least one phrase and every phrase must contain at least 2 + characters that are letters or digits. [required] items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + type: string type: array - readOnly: true - triggers: + id: GooglePrivacyDlpV2WordList + type: object + description: Message defining a list of words or phrases to search for in the data. + GooglePrivacyDlpV2DatabaseResourceReference: + type: object + description: Identifies a single database resource, like a table within a database. + id: GooglePrivacyDlpV2DatabaseResourceReference + properties: + instance: description: >- - A list of triggers which will be OR'ed together. Only one in the - list needs to trigger for a job to be started. The list may contain - only a single Schedule trigger and must have at least one object. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' - lastRunTime: - type: string - format: google-datetime - readOnly: true - description: Output only. The timestamp of the last time this trigger executed. - status: - enumDescriptions: - - Unused. - - Trigger is healthy. - - Trigger is temporarily paused. - - Trigger is cancelled and can not be resumed. - description: Required. A status for this trigger. + Required. The instance where this resource is located. For example: + Cloud SQL instance ID. type: string - enum: - - STATUS_UNSPECIFIED - - HEALTHY - - PAUSED - - CANCELLED - displayName: + database: + description: Required. Name of a database within the instance. type: string - description: Display name (max 100 chars) - description: - description: User provided description (max 256 chars) + databaseResource: type: string - inspectJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: For inspect jobs, a snapshot of the configuration. - updateTime: - description: Output only. The last update timestamp of a triggeredJob. + description: >- + Required. Name of a database resource, for example, a table within + the database. + projectId: type: string - format: google-datetime - readOnly: true - description: >- - Contains a configuration to make API calls on a repeating basis. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers - to learn more. + description: >- + Required. If within a project-level config, then this must match the + config's project ID. + GooglePrivacyDlpV2CancelDlpJobRequest: + type: object + id: GooglePrivacyDlpV2CancelDlpJobRequest + description: The request message for canceling a DLP job. + properties: {} + GooglePrivacyDlpV2OrConditions: + id: GooglePrivacyDlpV2OrConditions type: object - id: GooglePrivacyDlpV2JobTrigger - GooglePrivacyDlpV2CategoricalStatsConfig: description: >- - Compute numerical stats over an individual column, including number of - distinct values and value count distribution. - id: GooglePrivacyDlpV2CategoricalStatsConfig + There is an OR relationship between these attributes. They are used to + determine if a table should be scanned or not in Discovery. + properties: + minAge: + type: string + description: >- + Minimum age a table must have before Cloud DLP can profile it. Value + must be 1 hour or greater. + format: google-duration + minRowCount: + description: >- + Minimum number of rows that should be present before Cloud DLP + profiles a table + format: int32 + type: integer + GooglePrivacyDlpV2CloudStoragePath: + id: GooglePrivacyDlpV2CloudStoragePath type: object properties: - field: + path: + type: string description: >- - Field to compute categorical stats on. All column types are - supported except for arrays and structs. However, it may be more - informative to use NumericalStats when the field type is supported, - depending on the data. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - GooglePrivacyDlpV2KmsWrappedCryptoKey: + A URL representing a file or path (no wildcards) in Cloud Storage. + Example: `gs://[BUCKET_NAME]/dictionary.txt` + description: Message representing a single file or path in Cloud Storage. + GooglePrivacyDlpV2SelectedInfoTypes: + type: object + id: GooglePrivacyDlpV2SelectedInfoTypes + description: Apply transformation to the selected info_types. properties: - cryptoKeyName: + infoTypes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - Required. The resource name of the KMS CryptoKey to use for - unwrapping. + Required. InfoTypes to apply the transformation to. Required. + Provided InfoType must be unique within the ImageTransformations + message. + type: array + GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: + properties: + commonAlphabet: type: string - wrappedKey: - format: byte - description: Required. The wrapped data crypto key. + enum: + - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED + - NUMERIC + - HEXADECIMAL + - UPPER_CASE_ALPHA_NUMERIC + - ALPHA_NUMERIC + description: Common alphabets. + enumDescriptions: + - Unused. + - '`[0-9]` (radix of 10)' + - '`[0-9A-F]` (radix of 16)' + - '`[0-9A-Z]` (radix of 36)' + - '`[0-9A-Za-z]` (radix of 62)' + customAlphabet: + description: >- + This is supported by mapping these to the alphanumeric characters + that the FFX mode natively supports. This happens before/after + encryption/decryption. Each character listed must appear only once. + Number of characters must be in the range [2, 95]. This must be + encoded as ASCII. The order of characters does not matter. The full + list of allowed characters is: + ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` type: string - description: >- - Include to use an existing data crypto key wrapped by KMS. The wrapped - key must be a 128-, 192-, or 256-bit key. Authorization requires the - following IAM permissions when sending a request to perform a crypto - transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more - information, see [Creating a wrapped key] - (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). - Note: When you use Cloud KMS for cryptographic operations, [charges - apply](https://cloud.google.com/kms/pricing). - id: GooglePrivacyDlpV2KmsWrappedCryptoKey + surrogateInfoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + The custom infoType to annotate the surrogate with. This annotation + will be applied to the surrogate by prefixing it with the name of + the custom infoType followed by the number of characters comprising + the surrogate. The following scheme defines the format: + info_type_name(surrogate_character_count):surrogate For example, if + the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the + surrogate is 'abc', the full replacement value will be: + 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate + when inspecting content using the custom infoType + [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). + This facilitates reversal of the surrogate when it occurs in free + text. In order for inspection to work properly, the name of this + infoType must not occur naturally anywhere in your data; otherwise, + inspection may find a surrogate that does not correspond to an + actual identifier. Therefore, choose your custom infoType name + carefully after considering what your data looks like. One way to + select a name that has a high chance of yielding reliable detection + is to include one or more unicode characters that are highly + improbable to exist in your data. For example, assuming your data is + entered from a regular ASCII keyboard, the symbol with the hex code + point 29DD might be used like so: ⧝MY_TOKEN_TYPE + radix: + format: int32 + type: integer + description: The native way to select the alphabet. Must be in the range [2, 95]. + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + description: Required. The key used by the encryption algorithm. + context: + description: >- + The 'tweak', a context may be used for higher security since the + same identifier in two different contexts won't be given the same + surrogate. If the context is not set, a default tweak will be used. + If the context is set but: 1. there is no record present when + transforming a given value or 1. the field is not present when + transforming a given value, a default tweak will be used. Note that + case (1) is expected when an `InfoTypeTransformation` is applied to + both structured and unstructured `ContentItem`s. Currently, the + referenced field may be of value type integer or string. The tweak + is constructed as a sequence of bytes in big endian byte order such + that: - a 64 bit integer is encoded followed by a single byte of + value 1 - a string is encoded in UTF-8 format followed by a single + byte of value 2 + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' type: object - GooglePrivacyDlpV2ListInspectTemplatesResponse: + id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig + description: >- + Replaces an identifier with a surrogate using Format Preserving + Encryption (FPE) with the FFX mode of operation; however when used in + the `ReidentifyContent` API method, it serves the opposite function by + reversing the surrogate back into the original identifier. The + identifier must be encoded as ASCII. For a given crypto key and context, + the same identifier will be replaced with the same surrogate. + Identifiers must be at least two characters long. In the case that the + identifier is the empty string, it will be skipped. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + to learn more. Note: We recommend using CryptoDeterministicConfig for + all use cases which do not require preserving the input alphabet space + and size, plus warrant referential integrity. + GooglePrivacyDlpV2Range: properties: - nextPageToken: + start: + description: Index of the first character of the range (inclusive). type: string + format: int64 + end: + description: Index of the last character of the range (exclusive). + format: int64 + type: string + description: Generic half-open interval [start, end) + id: GooglePrivacyDlpV2Range + type: object + GooglePrivacyDlpV2FileStoreRegexes: + id: GooglePrivacyDlpV2FileStoreRegexes + description: >- + A collection of regular expressions to determine what file store to + match against. + type: object + properties: + patterns: description: >- - If the next page is available then the next page token to be used in - the following ListInspectTemplates request. - inspectTemplates: - description: >- - List of inspectTemplates, up to page_size in - ListInspectTemplatesRequest. - type: array + Required. The group of regular expression patterns to match against + one or more file stores. Maximum of 100 entries. The sum of all + regular expression's length can't exceed 10 KiB. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - type: object - id: GooglePrivacyDlpV2ListInspectTemplatesResponse - description: Response message for ListInspectTemplates. - GooglePrivacyDlpV2DlpJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegex' + type: array + GooglePrivacyDlpV2ListStoredInfoTypesResponse: + id: GooglePrivacyDlpV2ListStoredInfoTypesResponse + description: Response message for ListStoredInfoTypes. type: object - id: GooglePrivacyDlpV2DlpJob properties: - endTime: - format: google-datetime + nextPageToken: + description: >- + If the next page is available then the next page token to be used in + the following ListStoredInfoTypes request. type: string - description: Time when the job finished. - actionDetails: - description: Events that should occur after the job has completed. + storedInfoTypes: + description: >- + List of storedInfoTypes, up to page_size in + ListStoredInfoTypesRequest. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' type: array - inspectDetails: - description: Results from inspecting a data source. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' - lastModified: - description: Time when the job was last modified by the system. - type: string + GooglePrivacyDlpV2Container: + properties: + updateTime: format: google-datetime - name: + description: >- + Findings container modification timestamp, if applicable. For Cloud + Storage, this field contains the last file modification timestamp. + For a BigQuery table, this field contains the last_modified_time + property. For Datastore, this field isn't populated. type: string - description: The server-assigned name. - type: - description: The type of job. + version: + description: >- + Findings container version, if available ("generation" for Cloud + Storage). type: string - enumDescriptions: - - Defaults to INSPECT_JOB. - - The job inspected Google Cloud for sensitive data. - - The job executed a Risk Analysis computation. - enum: - - DLP_JOB_TYPE_UNSPECIFIED - - INSPECT_JOB - - RISK_ANALYSIS_JOB - jobTriggerName: + rootPath: + description: >- + The root of the container. Examples: - For BigQuery table + `project_id:dataset_id.table_id`, the root is `dataset_id` - For + Cloud Storage file `gs://bucket/folder/filename.txt`, the root is + `gs://bucket` type: string + projectId: description: >- - If created by a job trigger, the resource name of the trigger that - instantiated the job. - state: - description: State of a job. - enum: - - JOB_STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - - CANCELED - - FAILED - - ACTIVE - enumDescriptions: - - Unused. - - The job has not yet started. - - >- - The job is currently running. Once a job has finished it will - transition to FAILED or DONE. - - The job is no longer running. - - The job was canceled before it could be completed. - - The job had an error and did not complete. - - >- - The job is currently accepting findings via hybridInspect. A - hybrid job in ACTIVE state may continue to have findings added to - it through the calling of hybridInspect. After the job has - finished no more calls to hybridInspect may be made. ACTIVE jobs - can transition to DONE. + Project where the finding was found. Can be different from the + project that owns the finding. type: string - createTime: + relativePath: + description: >- + The rest of the path after the root. Examples: - For BigQuery table + `project_id:dataset_id.table_id`, the relative path is `table_id` - + For Cloud Storage file `gs://bucket/folder/filename.txt`, the + relative path is `folder/filename.txt` type: string - format: google-datetime - description: Time when the job was created. - errors: - description: A stream of errors encountered running the job. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - riskDetails: - description: Results from analyzing risk of a data source. - $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' - startTime: - description: Time when the job started. - format: google-datetime + type: type: string - description: Combines all of the information about a DLP job. - GooglePrivacyDlpV2Connection: + description: Container type, for example BigQuery or Cloud Storage. + fullPath: + type: string + description: >- + A string representation of the full container name. Examples: - + BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: + 'gs://Bucket/folders/filename.txt' + type: object + id: GooglePrivacyDlpV2Container description: >- - A data connection to allow DLP to profile data in locations that require - additional configuration. + Represents a container that may contain DLP findings. Examples of a + container include a file, table, or database record. + GooglePrivacyDlpV2FileStoreRegex: + id: GooglePrivacyDlpV2FileStoreRegex + description: A pattern to match against one or more file stores. + properties: + cloudStorageRegex: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegex' + description: Optional. Regex for Cloud Storage. + type: object + GooglePrivacyDlpV2Action: type: object + description: >- + A task to execute on the completion of a job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-actions + to learn more. properties: - state: - description: Required. The connection's state in its lifecycle. - enumDescriptions: - - Unused - - >- - DLP automatically created this connection during an initial scan, - and it is awaiting full configuration by a user. - - A configured connection that has not encountered any errors. - - >- - A configured connection that encountered errors during its last - use. It will not be used again until it is set to AVAILABLE. If - the resolution requires external action, then the client must send - a request to set the status to AVAILABLE when the connection is - ready for use. If the resolution doesn't require external action, - then any changes to the connection properties will automatically - mark it as AVAILABLE. - type: string - enum: - - CONNECTION_STATE_UNSPECIFIED - - MISSING_CREDENTIALS - - AVAILABLE - - ERROR - cloudSql: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' - description: Connect to a Cloud SQL instance. - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - type: array - readOnly: true - description: >- - Output only. Set if status == ERROR, to provide additional details. - Will store the last 10 errors sorted with the most recent first. - name: - readOnly: true - type: string + publishSummaryToCscc: + description: Publish summary to Cloud Security Command Center (Alpha). + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' + publishToStackdriver: + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' + description: Enable Stackdriver metric dlp.googleapis.com/finding_count. + jobNotificationEmails: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobNotificationEmails' description: >- - Output only. Name of the connection: - `projects/{project}/locations/{location}/connections/{name}`. - id: GooglePrivacyDlpV2Connection - GooglePrivacyDlpV2InfoTypeLikelihood: + Sends an email when the job completes. The email goes to IAM project + owners and technical [Essential + Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + deidentify: + description: Create a de-identified copy of the input data. + $ref: '#/components/schemas/GooglePrivacyDlpV2Deidentify' + publishFindingsToCloudDataCatalog: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + description: Publish findings to Cloud Datahub. + pubSub: + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' + description: Publish a notification to a Pub/Sub topic. + saveFindings: + description: Save resulting findings in a provided location. + $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' + id: GooglePrivacyDlpV2Action + GooglePrivacyDlpV2Result: + id: GooglePrivacyDlpV2Result properties: - minLikelihood: - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - type: string + hybridStats: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' + description: Statistics related to the processing of hybrid inspect. + numRowsProcessed: description: >- - Only returns findings equal to or above this threshold. This field - is required or else the configuration fails. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + Number of rows scanned after sampling and time filtering (applicable + for row based stores such as BigQuery). + type: string + format: int64 + infoTypeStats: description: >- - Type of information the likelihood threshold applies to. Only one - likelihood per info_type should be provided. If InfoTypeLikelihood - does not have an info_type, the configuration fails. - id: GooglePrivacyDlpV2InfoTypeLikelihood - type: object + Statistics of how many instances of each info type were found during + inspect job. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' + processedBytes: + format: int64 + description: Total size in bytes that were processed. + type: string + totalEstimatedBytes: + description: Estimate of the number of bytes to process. + type: string + format: int64 description: >- - Configuration for setting a minimum likelihood per infotype. Used to - customize the minimum likelihood level for specific infotypes in the - request. For example, use this if you want to lower the precision for - PERSON_NAME without lowering the precision for the other infotypes in - the request. - GooglePrivacyDlpV2DataProfileConfigSnapshot: - id: GooglePrivacyDlpV2DataProfileConfigSnapshot + All result fields mentioned below are updated while the job is + processing. type: object + GooglePrivacyDlpV2OrgConfig: + description: >- + Project and scan location information. Only set when the parent is an + org. properties: - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: A copy of the configuration used to generate this profile. - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: >- - A copy of the inspection config used to generate this profile. This - is a copy of the inspect_template specified in - `DataProfileJobConfig`. - inspectTemplateName: - description: Name of the inspection template used to generate this profile - type: string - dataProfileJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' - deprecated: true + location: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' + description: 'The data to scan: folder, org, or project' + projectId: description: >- - A copy of the configuration used to generate this profile. This is - deprecated, and the DiscoveryConfig field is preferred moving - forward. DataProfileJobConfig will still be written here for - Discovery in BigQuery for backwards compatibility, but will not be - updated with new fields, while DiscoveryConfig will. - inspectTemplateModifiedTime: + The project that will run the scan. The DLP service account that + exists within this project must have access to all resources that + are profiled, and the Cloud DLP API must be enabled. type: string - format: google-datetime - description: Timestamp when the template was modified - description: Snapshot of the configurations used to generate the profile. - GooglePrivacyDlpV2TableDataProfile: + id: GooglePrivacyDlpV2OrgConfig + type: object + GoogleTypeTimeOfDay: + id: GoogleTypeTimeOfDay + description: >- + Represents a time of day. The date and time zone are either not + significant or are specified elsewhere. An API may choose to allow leap + seconds. Related types are google.type.Date and + `google.protobuf.Timestamp`. + type: object properties: - rowCount: - type: string + hours: description: >- - Number of rows in the table when the profile was generated. This - will not be populated for BigLake tables. - format: int64 - state: - enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. - type: string - description: State of a profile. - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE - datasetId: - type: string - description: If the resource is BigQuery, the dataset ID. - predictedInfoTypes: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' - description: The infoTypes predicted from this table's data. - configSnapshot: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' - description: The snapshot of the configurations used to generate the profile. - datasetLocation: - type: string - description: >- - If supported, the location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - locations. - fullResource: + Hours of day in 24 hour format. Should be from 0 to 23. An API may + choose to allow the value "24:00:00" for scenarios like business + closing time. + type: integer + format: int32 + seconds: description: >- - The resource name of the resource profiled. - https://cloud.google.com/apis/design/resource_names#full_resource_name - type: string - projectDataProfile: - description: The resource name of the project data profile for this table. - type: string - profileLastGenerated: + Seconds of minutes of the time. Must normally be from 0 to 59. An + API may allow the value 60 if it allows leap-seconds. + format: int32 + type: integer + nanos: + type: integer + description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + format: int32 + minutes: + type: integer + format: int32 + description: Minutes of hour of day. Must be from 0 to 59. + GooglePrivacyDlpV2KmsWrappedCryptoKey: + type: object + id: GooglePrivacyDlpV2KmsWrappedCryptoKey + properties: + wrappedKey: + description: Required. The wrapped data crypto key. + format: byte type: string - description: The last time the profile was generated. - format: google-datetime - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + cryptoKeyName: description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - failedColumnCount: - format: int64 - type: string - description: The number of columns skipped in the table because of an error. - resourceVisibility: - enumDescriptions: - - Unused. - - Visible to any user. - - >- - May contain public items. For example, if a Cloud Storage bucket - has uniform bucket level access disabled, some objects inside it - may be public, but none are known yet. - - Visible only to specific users. - type: string - description: How broadly a resource has been shared. - enum: - - RESOURCE_VISIBILITY_UNSPECIFIED - - RESOURCE_VISIBILITY_PUBLIC - - RESOURCE_VISIBILITY_INCONCLUSIVE - - RESOURCE_VISIBILITY_RESTRICTED - expirationTime: - format: google-datetime - description: Optional. The time when this table expires. - type: string - lastModifiedTime: - type: string - format: google-datetime - description: The time when this table was last modified - createTime: - description: The time at which the table was created. + Required. The resource name of the KMS CryptoKey to use for + unwrapping. type: string - format: google-datetime - dataRiskLevel: - description: The data risk level of this table. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - sensitivityScore: - description: The sensitivity score of this table. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - scannedColumnCount: + description: >- + Include to use an existing data crypto key wrapped by KMS. The wrapped + key must be a 128-, 192-, or 256-bit key. Authorization requires the + following IAM permissions when sending a request to perform a crypto + transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more + information, see [Creating a wrapped key] + (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). + Note: When you use Cloud KMS for cryptographic operations, [charges + apply](https://cloud.google.com/kms/pricing). + GooglePrivacyDlpV2UpdateInspectTemplateRequest: + type: object + description: Request message for UpdateInspectTemplate. + properties: + updateMask: + description: Mask to control which fields get updated. type: string - description: The number of columns profiled in the table. - format: int64 - resourceLabels: - type: object + format: google-fieldmask + inspectTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + description: New InspectTemplate value. + id: GooglePrivacyDlpV2UpdateInspectTemplateRequest + GooglePrivacyDlpV2TagResources: + properties: + lowerDataRiskToLow: + type: boolean description: >- - The labels applied to the resource at the time the profile was - generated. - additionalProperties: - type: string - encryptionStatus: - type: string - description: How the table is encrypted. - enum: - - ENCRYPTION_STATUS_UNSPECIFIED - - ENCRYPTION_GOOGLE_MANAGED - - ENCRYPTION_CUSTOMER_MANAGED - enumDescriptions: - - Unused. - - Google manages server-side encryption keys on your behalf. - - Customer provides the key. - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' - description: The resource type that was profiled. - otherInfoTypes: + Whether applying a tag to a resource should lower the risk of the + profile for that resource. For example, in conjunction with an [IAM + deny policy](https://cloud.google.com/iam/docs/deny-overview), you + can deny all principals a permission if a tag value is present, + mitigating the risk of the resource. This also lowers the data risk + of resources at the lower levels of the resource hierarchy. For + example, reducing the data risk of a table data profile also reduces + the data risk of the constituent column data profiles. + profileGenerationsToTag: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - description: Other infoTypes found in this table's data. + type: string + enumDescriptions: + - Unused. + - The profile is the first profile for the resource. + - The profile is an update to a previous profile. + enum: + - PROFILE_GENERATION_UNSPECIFIED + - PROFILE_GENERATION_NEW + - PROFILE_GENERATION_UPDATE type: array - tableSizeBytes: - format: int64 - type: string - description: The size of the table when the profile was generated. - datasetProjectId: - type: string - description: The Google Cloud project ID that owns the resource. - name: - description: The name of the profile. - type: string - tableId: - type: string - description: If the resource is BigQuery, the BigQuery table ID. - id: GooglePrivacyDlpV2TableDataProfile - description: The profile for a scanned table. + description: >- + The profile generations for which the tag should be attached to + resources. If you attach a tag to only new profiles, then if the + sensitivity score of a profile subsequently changes, its tag doesn't + change. By default, this field includes only new profiles. To + include both new and updated profiles for tagging, this field should + explicitly include both `PROFILE_GENERATION_NEW` and + `PROFILE_GENERATION_UPDATE`. + tagConditions: + type: array + description: The tags to associate with different conditions. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TagCondition' + id: GooglePrivacyDlpV2TagResources type: object - GooglePrivacyDlpV2DiscoveryStartingLocation: description: >- - The location to begin a discovery scan. Denotes an organization ID or - folder ID within an organization. - id: GooglePrivacyDlpV2DiscoveryStartingLocation + If set, attaches the [tags] + (https://cloud.google.com/resource-manager/docs/tags/tags-overview) + provided to profiled resources. Tags support [access + control](https://cloud.google.com/iam/docs/tags-access-control). You can + conditionally grant or deny access to a resource based on whether the + resource has a specific tag. + GooglePrivacyDlpV2Row: properties: - folderId: - format: int64 + values: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + type: array + description: Individual cells. + id: GooglePrivacyDlpV2Row + description: Values of the row. + type: object + GooglePrivacyDlpV2CloudStorageResourceReference: + type: object + description: Identifies a single Cloud Storage bucket. + properties: + bucketName: type: string - description: The ID of the folder within an organization to be scanned. - organizationId: + description: Required. The bucket to scan. + projectId: type: string - format: int64 - description: The ID of an organization to scan. - type: object - GooglePrivacyDlpV2CryptoKey: + description: >- + Required. If within a project-level config, then this must match the + config's project id. + id: GooglePrivacyDlpV2CloudStorageResourceReference + GooglePrivacyDlpV2HybridInspectDlpJobRequest: + properties: + hybridItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + description: The item to inspect. type: object + id: GooglePrivacyDlpV2HybridInspectDlpJobRequest + description: Request to search for potentially sensitive info in a custom location. + GooglePrivacyDlpV2KAnonymityResult: properties: - unwrapped: - $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' - description: Unwrapped crypto key - transient: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' - description: Transient crypto key - kmsWrapped: - description: Key wrapped using Cloud KMS - $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' - id: GooglePrivacyDlpV2CryptoKey - description: >- - This is a data encryption key (DEK) (as opposed to a key encryption key - (KEK) stored by Cloud Key Management Service (Cloud KMS). When using - Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM - policy on the KEK to ensure an attacker cannot unwrap the DEK. - GooglePrivacyDlpV2CloudStoragePath: - id: GooglePrivacyDlpV2CloudStoragePath - description: Message representing a single file or path in Cloud Storage. - properties: - path: - description: >- - A URL representing a file or path (no wildcards) in Cloud Storage. - Example: `gs://[BUCKET_NAME]/dictionary.txt` - type: string - type: object - GooglePrivacyDlpV2KAnonymityEquivalenceClass: - description: The set of columns' values that share the same ldiversity value - properties: - equivalenceClassSize: - format: int64 - description: >- - Size of the equivalence class, for example number of rows with the - above set of values. - type: string - quasiIdsValues: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: >- - Set of values defining the equivalence class. One value per - quasi-identifier column in the original KAnonymity metric message. - The order is always the same as the original request. - type: object - id: GooglePrivacyDlpV2KAnonymityEquivalenceClass - GooglePrivacyDlpV2ReplaceValueConfig: - id: GooglePrivacyDlpV2ReplaceValueConfig - type: object - properties: - newValue: - description: Value to replace it with. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Replace each input value with a given `Value`. - GooglePrivacyDlpV2PublishToPubSub: - properties: - topic: - description: >- - Cloud Pub/Sub topic to send notifications to. The topic must have - given publishing access rights to the DLP API service account - executing the long running DlpJob sending the notifications. Format - is projects/{project}/topics/{topic}. - type: string - type: object - id: GooglePrivacyDlpV2PublishToPubSub - description: >- - Publish a message into a given Pub/Sub topic when DlpJob has completed. - The message contains a single field, `DlpJobName`, which is equal to the - finished job's - [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). - Compatible with: Inspect, Risk - GooglePrivacyDlpV2ThrowError: - type: object - id: GooglePrivacyDlpV2ThrowError - description: Throw an error and fail the request when a transformation error occurs. - properties: {} - GooglePrivacyDlpV2PrivacyMetric: - description: Privacy metric to compute for reidentification risk analysis. - id: GooglePrivacyDlpV2PrivacyMetric - type: object - properties: - kMapEstimationConfig: - description: k-map - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' - lDiversityConfig: - description: l-diversity - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' - numericalStatsConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' - description: Numerical stats - deltaPresenceEstimationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' - description: delta-presence - kAnonymityConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' - description: K-anonymity - categoricalStatsConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' - description: Categorical stats - GooglePrivacyDlpV2ListDlpJobsResponse: - id: GooglePrivacyDlpV2ListDlpJobsResponse - properties: - nextPageToken: - type: string - description: The standard List next-page token. - jobs: + equivalenceClassHistogramBuckets: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' + description: Histogram of k-anonymity equivalence classes. type: array - description: A list of DlpJobs that matches the specified filter in the request. + description: Result of the k-anonymity computation. type: object - description: The response message for listing DLP jobs. + id: GooglePrivacyDlpV2KAnonymityResult GooglePrivacyDlpV2TransformationConfig: id: GooglePrivacyDlpV2TransformationConfig - type: object description: >- User specified templates and configs for how to deidentify structured, unstructures, and image files. User must provide either a unstructured deidentify template or at least one redact image config. properties: - structuredDeidentifyTemplate: - type: string - description: >- - Structured de-identify template. If this template is specified, it - will serve as the de-identify template for structured content such - as delimited files and tables. If this template is not set but the - `deidentify_template` is set, then `deidentify_template` will also - apply to the structured content. If neither template is set, a - default `ReplaceWithInfoTypeConfig` will be used to de-identify - structured content. imageRedactTemplate: - type: string description: >- Image redact template. If this template is specified, it will serve as the de-identify template for images. If this template is not set, all findings in the image will be redacted with a black box. + type: string deidentifyTemplate: + type: string description: >- De-identify template. If this template is specified, it will serve as the default de-identify template. This template cannot contain @@ -5344,1665 +4610,2407 @@ components: content such as free-form text files. If this template is not set, a default `ReplaceWithInfoTypeConfig` will be used to de-identify unstructured content. + structuredDeidentifyTemplate: type: string - GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: - id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest - description: Request message for UpdateStoredInfoType. + description: >- + Structured de-identify template. If this template is specified, it + will serve as the de-identify template for structured content such + as delimited files and tables. If this template is not set but the + `deidentify_template` is set, then `deidentify_template` will also + apply to the structured content. If neither template is set, a + default `ReplaceWithInfoTypeConfig` will be used to de-identify + structured content. + type: object + GooglePrivacyDlpV2DeidentifyDataSourceDetails: + type: object properties: - updateMask: - type: string - description: Mask to control which fields get updated. - format: google-fieldmask - config: + requestedOptions: + description: De-identification config used for the request. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' + deidentifyStats: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' + description: Stats about the de-identification operation. + description: The results of a Deidentify action from an inspect job. + id: GooglePrivacyDlpV2DeidentifyDataSourceDetails + GooglePrivacyDlpV2KAnonymityConfig: + properties: + entityId: + $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' description: >- - Updated configuration for the storedInfoType. If not provided, a new - version of the storedInfoType will be created with the existing - configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + Message indicating that multiple rows might be associated to a + single individual. If the same entity_id is associated to multiple + quasi-identifier tuples over distinct rows, we consider the entire + collection of tuples as the composite quasi-identifier. This + collection is a multiset: the order in which the different tuples + appear in the dataset is ignored, but their frequency is taken into + account. Important note: a maximum of 1000 rows can be associated to + a single entity ID. If more rows are associated with the same entity + ID, some might be ignored. + quasiIds: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + Set of fields to compute k-anonymity over. When multiple fields are + specified, they are considered a single composite key. Structs and + repeated data types are not supported; however, nested fields are + supported so long as they are not structs themselves or nested + within a repeated field. type: object - GooglePrivacyDlpV2KMapEstimationQuasiIdValues: + description: k-anonymity metric, used for analysis of reidentification risk. + id: GooglePrivacyDlpV2KAnonymityConfig + GooglePrivacyDlpV2AllOtherDatabaseResources: + description: Match database resources not covered by any other filter. + properties: {} type: object + id: GooglePrivacyDlpV2AllOtherDatabaseResources + GooglePrivacyDlpV2ListProjectDataProfilesResponse: properties: - quasiIdsValues: + nextPageToken: + description: The next page token. + type: string + projectDataProfiles: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: The quasi-identifier values. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + description: List of data profiles. type: array - estimatedAnonymity: - description: The estimated anonymity for these quasi-identifier values. - type: string - format: int64 - description: A tuple of values for the quasi-identifier columns. - id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues - GooglePrivacyDlpV2Color: - properties: - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - type: number - format: float - red: - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - green: - description: The amount of green in the color as a value in the interval [0, 1]. - format: float - type: number type: object - id: GooglePrivacyDlpV2Color - description: Represents a color in the RGB color space. - GooglePrivacyDlpV2SearchConnectionsResponse: - description: Response message for SearchConnections. - id: GooglePrivacyDlpV2SearchConnectionsResponse + id: GooglePrivacyDlpV2ListProjectDataProfilesResponse + description: List of profiles generated for a given organization or project. + GooglePrivacyDlpV2CreateDiscoveryConfigRequest: + id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest + description: Request message for CreateDiscoveryConfig. + type: object properties: - nextPageToken: + discoveryConfig: + description: Required. The DiscoveryConfig to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + configId: description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. + The config ID can contain uppercase and lowercase letters, numbers, + and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - connections: + GooglePrivacyDlpV2ListInfoTypesResponse: + description: Response to the ListInfoTypes request. + id: GooglePrivacyDlpV2ListInfoTypesResponse + properties: + infoTypes: type: array - description: >- - List of connections that match the search query. Note that only a - subset of the fields will be populated, and only "name" is - guaranteed to be set. For full details of a Connection, call - GetConnection with the name. + description: Set of sensitive infoTypes. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' type: object - GooglePrivacyDlpV2BoundingBox: + GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: + id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence properties: - width: - description: Width of the bounding box in pixels. - type: integer - format: int32 - height: - description: Height of the bounding box in pixels. - format: int32 - type: integer - top: - type: integer - format: int32 - description: Top coordinate of the bounding box. (0,0) is upper left. - left: - format: int32 - description: Left coordinate of the bounding box. (0,0) is upper left. - type: integer - type: object - id: GooglePrivacyDlpV2BoundingBox - description: Bounding box encompassing detected text within an image. - GooglePrivacyDlpV2BigQueryDiscoveryTarget: - id: GooglePrivacyDlpV2BigQueryDiscoveryTarget - description: Target used to match against for discovery with BigQuery tables - type: object - properties: - filter: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' - description: >- - Required. The tables the discovery cadence applies to. The first - target with a matching filter will be the one to apply to a table. - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Tables that match this filter will not have profiles created. - conditions: - description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' - cadence: - description: >- - How often and when to update profiles. New tables that match both - the filter and conditions are scanned as quickly as possible - depending on system capacity. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryGenerationCadence' - GooglePrivacyDlpV2InfoTypeTransformations: - description: >- - A type of transformation that will scan unstructured text and apply - various `PrimitiveTransformation`s to each finding, where the - transformation is applied to only values that were identified as a - specific info_type. - id: GooglePrivacyDlpV2InfoTypeTransformations - properties: - transformations: + frequency: + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + type: string description: >- - Required. Transformation for each infoType. Cannot specify more than - one for a given infoType. + How frequently profiles may be updated when schemas are modified. + Defaults to monthly. + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + types: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' + enumDescriptions: + - Unused + - >- + Profiles should be regenerated when new columns are added to the + table. Default. + - >- + Profiles should be regenerated when columns are removed from the + table. + enum: + - SCHEMA_MODIFICATION_UNSPECIFIED + - SCHEMA_NEW_COLUMNS + - SCHEMA_REMOVED_COLUMNS + type: string + description: >- + The type of events to consider when deciding if the table's schema + has been modified and should have the profile updated. Defaults to + NEW_COLUMNS. type: array + description: The cadence at which to update data profiles when a schema is modified. type: object - GooglePrivacyDlpV2CloudStorageFileSet: - id: GooglePrivacyDlpV2CloudStorageFileSet + GoogleRpcStatus: properties: - url: + code: + type: integer + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + details: description: >- - The url, in the format `gs:///`. Trailing wildcard in the path is - allowed. - type: string - type: object - description: Message representing a set of files in Cloud Storage. - GooglePrivacyDlpV2FileClusterSummary: - description: The file cluster summary. - properties: - errors: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - description: >- - A list of errors detected while scanning this cluster. The list is - truncated to 10 per cluster. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object type: array - fileClusterType: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterType' - description: The file cluster type. - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: >- - The sensitivity score of this cluster. The score will be - SENSITIVITY_LOW if nothing has been scanned. - fileExtensionsSeen: + message: + type: string description: >- - A sample of file types seen in this cluster. Empty if no files were - seen. File extensions can be derived from the file name or the file - content. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' - noFilesExist: - type: boolean + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: object + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + GooglePrivacyDlpV2CryptoKey: + type: object + id: GooglePrivacyDlpV2CryptoKey + description: >- + This is a data encryption key (DEK) (as opposed to a key encryption key + (KEK) stored by Cloud Key Management Service (Cloud KMS). When using + Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM + policy on the KEK to ensure an attacker cannot unwrap the DEK. + properties: + unwrapped: + $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' + description: Unwrapped crypto key + transient: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' + description: Transient crypto key + kmsWrapped: + $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' + description: Key wrapped using Cloud KMS + GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: + properties: + nextPageToken: + type: string description: >- - True if no files exist in this cluster. If the bucket had more files - than could be listed, this will be false even if no files for this - cluster were seen and file_extensions_seen is empty. - fileStoreInfoTypeSummaries: - description: InfoTypes detected in this cluster. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' - fileExtensionsScanned: + If the next page is available then the next page token to be used in + the following ListDeidentifyTemplates request. + deidentifyTemplates: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' - description: >- - A sample of file types scanned in this cluster. Empty if no files - were scanned. File extensions can be derived from the file name or - the file content. - dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' description: >- - The data risk level of this cluster. RISK_LOW if nothing has been - scanned. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - id: GooglePrivacyDlpV2FileClusterSummary - type: object - GooglePrivacyDlpV2CloudStorageResourceReference: - id: GooglePrivacyDlpV2CloudStorageResourceReference + List of deidentify templates, up to page_size in + ListDeidentifyTemplatesRequest. + description: Response message for ListDeidentifyTemplates. type: object + id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + GoogleTypeDate: properties: - projectId: + day: description: >- - Required. If within a project-level config, then this must match the - config's project id. - type: string - bucketName: - description: Required. The bucket to scan. - type: string - description: Identifies a single Cloud Storage bucket. - GooglePrivacyDlpV2RecordKey: + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + type: integer + year: + type: integer + format: int32 + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + month: + format: int32 + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer type: object - id: GooglePrivacyDlpV2RecordKey + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + GooglePrivacyDlpV2BigQueryTableTypes: properties: - idValues: - type: array - description: >- - Values of identifying columns in the given row. Order of values - matches the order of `identifying_fields` specified in the scanning - request. + types: + description: A set of BigQuery table types. items: + enum: + - BIG_QUERY_TABLE_TYPE_UNSPECIFIED + - BIG_QUERY_TABLE_TYPE_TABLE + - BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE + enumDescriptions: + - Unused. + - A normal BigQuery table. + - A table that references data stored in Cloud Storage. type: string - bigQueryKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' - description: Datastore key - datastoreKey: - description: BigQuery key - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' - description: Message for a unique key indicating a record that contains a finding. - GooglePrivacyDlpV2PubSubCondition: + type: array + type: object + id: GooglePrivacyDlpV2BigQueryTableTypes + description: The types of BigQuery tables supported by Cloud DLP. + GooglePrivacyDlpV2HotwordRule: + id: GooglePrivacyDlpV2HotwordRule properties: - minimumSensitivityScore: - description: The minimum sensitivity level that triggers the condition. - enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH - type: string - enumDescriptions: - - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. - minimumRiskScore: - type: string - enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH - description: The minimum data risk score that triggers the condition. - enumDescriptions: - - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. + hotwordRegex: + description: Regular expression pattern defining what qualifies as a hotword. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + proximity: + $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' + description: >- + Range of characters within which the entire hotword must reside. The + total length of the window cannot exceed 1000 characters. The + finding itself will be included in the window, so that hotwords can + be used to match substrings of the finding itself. Suppose you want + Cloud DLP to promote the likelihood of the phone number regex + "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area + code of a company's office. In this case, use the hotword regex + "\(xxx\)", where "xxx" is the area code in question. For tabular + data, if you want to modify the likelihood of an entire column of + findngs, see [Hotword example: Set the match likelihood of a table + column] + (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + likelihoodAdjustment: + $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' + description: Likelihood adjustment to apply to all matching findings. type: object - id: GooglePrivacyDlpV2PubSubCondition - description: A condition consisting of a value. - GooglePrivacyDlpV2SurrogateType: - properties: {} description: >- - Message for detecting output from deidentification transformations such - as - [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). - These types of transformations are those that perform pseudonymization, - thereby producing a "surrogate" as output. This should be used in - conjunction with a field on the transformation such as - `surrogate_info_type`. This CustomInfoType does not support the use of - `detection_rules`. - id: GooglePrivacyDlpV2SurrogateType + The rule that adjusts the likelihood of findings within a certain + proximity of hotwords. + GooglePrivacyDlpV2PartitionId: + description: >- + Datastore partition ID. A partition ID identifies a grouping of + entities. The grouping is always by project and namespace, however the + namespace ID may be empty. A partition ID contains several dimensions: + project ID and namespace ID. type: object - GooglePrivacyDlpV2DeltaPresenceEstimationConfig: + properties: + namespaceId: + description: If not empty, the ID of the namespace to which the entities belong. + type: string + projectId: + description: The ID of the project to which the entities belong. + type: string + id: GooglePrivacyDlpV2PartitionId + GooglePrivacyDlpV2FileExtensionInfo: + id: GooglePrivacyDlpV2FileExtensionInfo + description: Information regarding the discovered file extension. + properties: + fileExtension: + type: string + description: The file extension if set. (aka .pdf, .jpg, .txt) type: object - description: >- - δ-presence metric, used to estimate how likely it is for an attacker to - figure out that one given individual appears in a de-identified dataset. - Similarly to the k-map metric, we cannot compute δ-presence exactly - without knowing the attack dataset, so we use a statistical model - instead. + GooglePrivacyDlpV2KAnonymityHistogramBucket: properties: - regionCode: + bucketSize: + description: Total number of equivalence classes in this bucket. + type: string + format: int64 + equivalenceClassSizeUpperBound: + description: Upper bound on the size of the equivalence classes in this bucket. + format: int64 + type: string + equivalenceClassSizeLowerBound: + description: Lower bound on the size of the equivalence classes in this bucket. + format: int64 + type: string + bucketValueCount: + description: Total number of distinct equivalence classes in this bucket. + format: int64 type: string + bucketValues: description: >- - ISO 3166-1 alpha-2 region code to use in the statistical modeling. - Set if no column is tagged with a region-specific InfoType (like - US_ZIP_5) or a region code. - quasiIds: + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiId' + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' + id: GooglePrivacyDlpV2KAnonymityHistogramBucket + description: Histogram of k-anonymity equivalence classes. + type: object + GooglePrivacyDlpV2KMapEstimationResult: + description: >- + Result of the reidentifiability analysis. Note that these results are an + estimation, not exact values. + id: GooglePrivacyDlpV2KMapEstimationResult + type: object + properties: + kMapEstimationHistogram: description: >- - Required. Fields considered to be quasi-identifiers. No two fields - can have the same tag. - auxiliaryTables: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StatisticalTable' + The intervals [min_anonymity, max_anonymity] do not overlap. If a + value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: + 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, + max_anonymity: 10, frequency: 99} mean that there are no record with + an estimated anonymity of 4, 5, or larger than 10. type: array - description: >- - Several auxiliary tables can be used in the analysis. Each - custom_tag used to tag a quasi-identifiers field must appear in - exactly one field of one auxiliary table. - id: GooglePrivacyDlpV2DeltaPresenceEstimationConfig - GooglePrivacyDlpV2ExclusionRule: - id: GooglePrivacyDlpV2ExclusionRule + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket + GooglePrivacyDlpV2StatisticalTable: + id: GooglePrivacyDlpV2StatisticalTable properties: - excludeInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' - description: Set of infoTypes for which findings would affect this rule. - matchingType: - description: How the rule is applied, see MatchingType documentation for details. - enumDescriptions: - - Invalid. - - >- - Full match. - Dictionary: join of Dictionary results matched - complete finding quote - Regex: all regex matches fill a finding - quote start to end - Exclude info type: completely inside - affecting info types findings - - >- - Partial match. - Dictionary: at least one of the tokens in the - finding matches - Regex: substring of the finding matches - - Exclude info type: intersects with affecting info types findings - - >- - Inverse match. - Dictionary: no tokens in the finding match the - dictionary - Regex: finding doesn't match the regex - Exclude info - type: no intersection with affecting info types findings - type: string - enum: - - MATCHING_TYPE_UNSPECIFIED - - MATCHING_TYPE_FULL_MATCH - - MATCHING_TYPE_PARTIAL_MATCH - - MATCHING_TYPE_INVERSE_MATCH - regex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression which defines the rule. - excludeByHotword: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Required. Auxiliary table location. + quasiIds: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' + description: Required. Quasi-identifier columns. + type: array + relativeFrequency: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Drop if the hotword rule is contained in the proximate context. For - tabular data, the context includes the column name. - dictionary: - description: Dictionary which defines the rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + Required. The relative frequency column must contain a + floating-point number between 0 and 1 (inclusive). Null values are + assumed to be zero. type: object description: >- - The rule that specifies conditions when findings of infoTypes specified - in `InspectionRuleSet` are removed from results. - GooglePrivacyDlpV2LikelihoodAdjustment: - id: GooglePrivacyDlpV2LikelihoodAdjustment + An auxiliary table containing statistical information on the relative + frequency of different quasi-identifiers values. It has one or several + quasi-identifiers columns, and one column that indicates the relative + frequency of each quasi-identifier tuple. If a tuple is present in the + data but not in the auxiliary table, the corresponding relative + frequency is assumed to be zero (and thus, the tuple is highly + reidentifiable). + GooglePrivacyDlpV2TableDataProfile: type: object properties: - relativeLikelihood: + name: + description: The name of the profile. + type: string + failedColumnCount: + description: The number of columns skipped in the table because of an error. + type: string + format: int64 + datasetLocation: + type: string description: >- - Increase or decrease the likelihood by the specified number of - levels. For example, if a finding would be `POSSIBLE` without the - detection rule and `relative_likelihood` is 1, then it is upgraded - to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. - Likelihood may never drop below `VERY_UNLIKELY` or exceed - `VERY_LIKELY`, so applying an adjustment of 1 followed by an - adjustment of -1 when base likelihood is `VERY_LIKELY` will result - in a final likelihood of `LIKELY`. - type: integer - format: int32 - fixedLikelihood: - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. + If supported, the location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + locations. + resourceVisibility: type: string - description: Set the likelihood of a finding to a fixed value. - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - description: >- - Message for specifying an adjustment to the likelihood of a finding as - part of a detection rule. - GooglePrivacyDlpV2FieldTransformation: - description: The transformation to apply to the field. - id: GooglePrivacyDlpV2FieldTransformation - type: object - properties: - condition: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' - description: >- - Only apply the transformation if the condition evaluates to true for - the given `RecordCondition`. The conditions are allowed to reference - fields that are not used in the actual transformation. Example Use - Cases: - Apply a different bucket transformation to an age column if - the zip code column for the same record is within a specific range. - - Redact a field if the date of birth field is greater than 85. - primitiveTransformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - description: Apply the transformation to the entire field. - infoTypeTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - description: >- - Treat the contents of the field as free text, and selectively - transform content that matches an `InfoType`. - fields: - type: array - description: >- - Required. Input field(s) to apply the transformation to. When you - have columns that reference their position within a list, omit the - index from the FieldId. FieldId name matching ignores the index. For - example, instead of "contact.nums[0].type", use "contact.nums.type". - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - GooglePrivacyDlpV2FileStoreCollection: - properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegexes' - description: >- - Optional. A collection of regular expressions to match a file store - against. - type: object - description: Match file stores (e.g. buckets) using regex filters. - id: GooglePrivacyDlpV2FileStoreCollection - GooglePrivacyDlpV2BigQueryOptions: - type: object - properties: - includedFields: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Limit scanning only to these fields. When inspecting a table, we - recommend that you inspect all columns. Otherwise, findings might be - affected because hints from excluded columns will not be used. - identifyingFields: - description: >- - Table fields that may uniquely identify a row within the table. When - `actions.saveFindings.outputConfig.table` is specified, the values - of columns specified here are available in the output table under - `location.content_locations.record_location.record_key.id_values`. - Nested fields such as `person.birthdate.year` are allowed. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Complete BigQuery table reference. - excludedFields: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - type: array - description: >- - References to fields excluded from scanning. This allows you to skip - inspection of entire columns which you know have no findings. When - inspecting a table, we recommend that you inspect all columns. - Otherwise, findings might be affected because hints from excluded - columns will not be used. - rowsLimitPercent: - format: int32 - description: >- - Max percentage of rows to scan. The rest are omitted. The number of - rows scanned is rounded down. Must be between 0 and 100, - inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one - of rows_limit and rows_limit_percent can be specified. Cannot be - used in conjunction with TimespanConfig. Caution: A [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) - is causing the `rowsLimitPercent` field to behave unexpectedly. We - recommend using `rowsLimit` instead. - type: integer - rowsLimit: - format: int64 - description: >- - Max number of rows to scan. If the table has more rows than this - value, the rest of the rows are omitted. If not set, or if set to 0, - all rows will be scanned. Only one of rows_limit and - rows_limit_percent can be specified. Cannot be used in conjunction - with TimespanConfig. - type: string - sampleMethod: - type: string - enumDescriptions: - - No sampling. - - >- - Scan groups of rows in the order BigQuery provides (default). - Multiple groups of rows may be scanned in parallel, so results may - not appear in the same order the rows are read. - - Randomly pick groups of rows to scan. - description: How to sample the data. - enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START - description: Options defining BigQuery table and row identifiers. - id: GooglePrivacyDlpV2BigQueryOptions - GooglePrivacyDlpV2FileClusterType: - properties: - cluster: enumDescriptions: - Unused. - - Unsupported files. - - Plain text. - - Structured data like CSV, TSV etc. - - Source code. - - Rich document like docx, xlsx etc. - - Images like jpeg, bmp. - - Archives and containers like .zip, .tar etc. - - Multimedia like .mp4, .avi etc. - - Executable files like .exe, .class, .apk etc. - type: string + - Visible to any user. + - >- + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. enum: - - CLUSTER_UNSPECIFIED - - CLUSTER_UNKNOWN - - CLUSTER_TEXT - - CLUSTER_STRUCTURED_DATA - - CLUSTER_SOURCE_CODE - - CLUSTER_RICH_DOCUMENT - - CLUSTER_IMAGE - - CLUSTER_ARCHIVE - - CLUSTER_MULTIMEDIA - - CLUSTER_EXECUTABLE - description: Cluster type. - id: GooglePrivacyDlpV2FileClusterType - description: Message used to identify file cluster type being profiled. - type: object - GooglePrivacyDlpV2FileExtensionInfo: - type: object - description: Information regarding the discovered file extension. - id: GooglePrivacyDlpV2FileExtensionInfo - properties: - fileExtension: - description: The file extension if set. (aka .pdf, .jpg, .txt) + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + description: How broadly a resource has been shared. + projectDataProfile: + description: The resource name of the project data profile for this table. type: string - GooglePrivacyDlpV2KAnonymityHistogramBucket: - properties: - bucketValueCount: - description: Total number of distinct equivalence classes in this bucket. - format: int64 + tableId: type: string - bucketSize: - description: Total number of equivalence classes in this bucket. - format: int64 + description: If the resource is BigQuery, the BigQuery table ID. + datasetId: type: string - equivalenceClassSizeLowerBound: + description: If the resource is BigQuery, the dataset ID. + lastModifiedTime: + description: The time when this table was last modified type: string - description: Lower bound on the size of the equivalence classes in this bucket. - format: int64 - equivalenceClassSizeUpperBound: - description: Upper bound on the size of the equivalence classes in this bucket. + format: google-datetime + rowCount: + description: >- + Number of rows in the table when the profile was generated. This + will not be populated for BigLake tables. type: string format: int64 - bucketValues: - type: array + otherInfoTypes: + description: Other infoTypes found in this table's data. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' - description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. - type: object - description: Histogram of k-anonymity equivalence classes. - id: GooglePrivacyDlpV2KAnonymityHistogramBucket - GooglePrivacyDlpV2Finding: - type: object - description: Represents a piece of potentially sensitive content. - properties: - quote: - description: >- - The content that was found. Even if the content is not textual, it - may be converted to a textual representation here. Provided if - `include_quote` is true and the finding is less than or equal to - 4096 bytes long. If the finding exceeds 4096 bytes in length, the - quote may be omitted. - type: string - location: - $ref: '#/components/schemas/GooglePrivacyDlpV2Location' - description: Where the content was found. - triggerName: - description: Job trigger name, if applicable, for this finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + type: array + encryptionStatus: + enum: + - ENCRYPTION_STATUS_UNSPECIFIED + - ENCRYPTION_GOOGLE_MANAGED + - ENCRYPTION_CUSTOMER_MANAGED + enumDescriptions: + - Unused. + - Google manages server-side encryption keys on your behalf. + - Customer provides the key. + description: How the table is encrypted. type: string - name: + expirationTime: + description: Optional. The time when this table expires. type: string + format: google-datetime + fullResource: description: >- - Resource name in format - projects/{project}/locations/{location}/findings/{finding} Populated - only when viewing persisted findings. - jobCreateTime: - description: Time the job started that produced this finding. + The resource name of the resource profiled. + https://cloud.google.com/apis/design/resource_names#full_resource_name type: string - format: google-datetime - labels: + dataSourceType: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + description: The resource type that was profiled. + dataRiskLevel: + description: The data risk level of this table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + resourceLabels: type: object additionalProperties: type: string description: >- - The labels associated with this `Finding`. Label keys must be - between 1 and 63 characters long and must conform to the following - regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must - be between 0 and 63 characters long and must conform to the regular - expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels - can be associated with a given finding. Examples: * `"environment" : - "production"` * `"pipeline" : "etl"` - quoteInfo: - description: >- - Contains data parsed from quotes. Only populated if include_quote - was set to true and a supported infoType was requested. Currently - supported infoTypes: DATE, DATE_OF_BIRTH and TIME. - $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' - infoType: - description: >- - The type of content that might have been found. Provided if - `excluded_types` is false. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - findingId: - description: The unique finding id. - type: string - likelihood: - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - type: string - description: Confidence of how likely it is that the `info_type` is correct. - resourceName: - description: The job that stored the finding. + The labels applied to the resource at the time the profile was + generated. + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: The sensitivity score of this table. + predictedInfoTypes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + type: array + description: The infoTypes predicted from this table's data. + tableSizeBytes: type: string + format: int64 + description: The size of the table when the profile was generated. createTime: + type: string format: google-datetime + description: The time at which the table was created. + profileStatus: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + description: >- + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + configSnapshot: + description: The snapshot of the configurations used to generate the profile. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + scannedColumnCount: + description: The number of columns profiled in the table. + format: int64 type: string - description: Timestamp when finding was detected. - jobName: - description: The job that stored the finding. + profileLastGenerated: type: string - id: GooglePrivacyDlpV2Finding - GooglePrivacyDlpV2CreateDlpJobRequest: - type: object - description: >- - Request message for CreateDlpJobRequest. Used to initiate long running - jobs such as calculating risk metrics or inspecting Google Cloud - Storage. - id: GooglePrivacyDlpV2CreateDlpJobRequest - properties: - jobId: + description: The last time the profile was generated. + format: google-datetime + state: type: string - description: >- - The job id can contain uppercase and lowercase letters, numbers, and - hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - inspectJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: An inspection job scans a storage repository for InfoTypes. - locationId: + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + description: State of a profile. + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + datasetProjectId: + description: The Google Cloud project ID that owns the resource. type: string - description: Deprecated. This field has no effect. - riskJob: - description: >- - A risk analysis job calculates re-identification risk metrics for a - BigQuery table. - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - GooglePrivacyDlpV2StoredInfoType: + description: The profile for a scanned table. + id: GooglePrivacyDlpV2TableDataProfile + GooglePrivacyDlpV2InfoTypeTransformations: + type: object properties: - currentVersion: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' - description: Current version of the stored info type. - pendingVersions: + transformations: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' type: array description: >- - Pending versions of the stored info type. Empty if no versions are - pending. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' - name: - type: string - description: Resource name. - id: GooglePrivacyDlpV2StoredInfoType + Required. Transformation for each infoType. Cannot specify more than + one for a given infoType. + id: GooglePrivacyDlpV2InfoTypeTransformations description: >- - StoredInfoType resource message that contains information about the - current version and any pending updates. + A type of transformation that will scan unstructured text and apply + various `PrimitiveTransformation`s to each finding, where the + transformation is applied to only values that were identified as a + specific info_type. + GooglePrivacyDlpV2InspectionRule: + description: >- + A single inspection rule to be applied to infoTypes, specified in + `InspectionRuleSet`. + properties: + hotwordRule: + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + description: Hotword-based detection rule. + exclusionRule: + $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' + description: Exclusion rule. type: object - GooglePrivacyDlpV2DatabaseResourceRegex: + id: GooglePrivacyDlpV2InspectionRule + GooglePrivacyDlpV2ListColumnDataProfilesResponse: properties: - instanceRegex: - type: string - description: >- - Regex to test the instance name against. If empty, all instances - match. - databaseRegex: - description: >- - Regex to test the database name against. If empty, all databases - match. - type: string - projectIdRegex: - description: >- - For organizations, if unset, will match all projects. Has no effect - for configurations created within a project. - type: string - databaseResourceNameRegex: + nextPageToken: type: string - description: >- - Regex to test the database resource's name against. An example of a - database resource name is a table's name. Other database resource - names like view names could be included in the future. If empty, all - database resources match. - description: >- - A pattern to match against one or more database resources. At least one - pattern must be specified. Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. + description: The next page token. + columnDataProfiles: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + type: array + description: List of data profiles. type: object - id: GooglePrivacyDlpV2DatabaseResourceRegex - GooglePrivacyDlpV2DeidentifyContentResponse: + id: GooglePrivacyDlpV2ListColumnDataProfilesResponse + description: List of profiles generated for a given organization or project. + GooglePrivacyDlpV2InspectContentResponse: type: object - id: GooglePrivacyDlpV2DeidentifyContentResponse - description: Results of de-identifying a ContentItem. + id: GooglePrivacyDlpV2InspectContentResponse properties: - item: - description: The de-identified item. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - overview: - description: An overview of the changes that were made on the `item`. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' - GooglePrivacyDlpV2TimePartConfig: + result: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + description: The findings. + description: Results of inspecting an item. + GooglePrivacyDlpV2JobNotificationEmails: type: object - id: GooglePrivacyDlpV2TimePartConfig + id: GooglePrivacyDlpV2JobNotificationEmails description: >- - For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a - portion of the value. - properties: - partToExtract: - enumDescriptions: - - Unused - - '[0-9999]' - - '[1-12]' - - '[1-31]' - - '[1-7]' - - '[1-53]' - - '[0-23]' - type: string - enum: - - TIME_PART_UNSPECIFIED - - YEAR - - MONTH - - DAY_OF_MONTH - - DAY_OF_WEEK - - WEEK_OF_YEAR - - HOUR_OF_DAY - description: The part of the time to keep. - GooglePrivacyDlpV2InspectionRuleSet: + Sends an email when the job completes. The email goes to IAM project + owners and technical [Essential + Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + properties: {} + GooglePrivacyDlpV2CategoricalStatsResult: properties: - infoTypes: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: List of infoTypes this rule set is applied to. - rules: + valueFrequencyHistogramBuckets: + description: Histogram of value frequencies in the column. type: array - description: >- - Set of rules to be applied to infoTypes. The rules are applied in - order. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket type: object - id: GooglePrivacyDlpV2InspectionRuleSet - description: >- - Rule set for modifying a set of infoTypes to alter behavior under - certain circumstances, depending on the specific details of the rules - within the set. - GooglePrivacyDlpV2Bucket: + id: GooglePrivacyDlpV2CategoricalStatsResult + description: Result of the categorical stats computation. + GooglePrivacyDlpV2InspectResult: properties: - min: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + findings: + description: List of findings for an item. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' + type: array + findingsTruncated: + type: boolean description: >- - Lower bound of the range, inclusive. Type should be the same as max - if used. - replacementValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Required. Replacement value for this bucket. - max: - description: Upper bound of the range, exclusive; type must match min. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Bucket is represented as a range, along with replacement values. + If true, then this item might have more findings than were returned, + and the findings returned are an arbitrary subset of all findings. + The findings list might be truncated because the input items were + too large, or because the server reached the maximum amount of + resources allowed for a single API call. For best results, divide + the input into smaller batches. + description: All the findings for a single scanned item. type: object - id: GooglePrivacyDlpV2Bucket - GooglePrivacyDlpV2Trigger: - description: What event needs to occur for a new job to be started. + id: GooglePrivacyDlpV2InspectResult + GooglePrivacyDlpV2KindExpression: properties: - schedule: - $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' - description: Create a job on a repeating basis based on the elapse of time. - manual: - $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' - description: >- - For use with hybrid jobs. Jobs must be manually created and - finished. - id: GooglePrivacyDlpV2Trigger + name: + description: The name of the kind. + type: string type: object - GoogleTypeTimeOfDay: + description: A representation of a Datastore kind. + id: GooglePrivacyDlpV2KindExpression + GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: + type: object + description: A tuple of values for the quasi-identifier columns. + id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + properties: + estimatedProbability: + format: double + type: number + description: >- + The estimated probability that a given individual sharing these + quasi-identifier values is in the dataset. This value, typically + called δ, is the ratio between the number of records in the dataset + with these quasi-identifier values, and the total number of + individuals (inside *and* outside the dataset) with these + quasi-identifier values. For example, if there are 15 individuals in + the dataset who share the same quasi-identifier values, and an + estimated 100 people in the entire population with these values, + then δ is 0.15. + quasiIdsValues: + description: The quasi-identifier values. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + GooglePrivacyDlpV2PubSubNotification: description: >- - Represents a time of day. The date and time zone are either not - significant or are specified elsewhere. An API may choose to allow leap - seconds. Related types are google.type.Date and - `google.protobuf.Timestamp`. + Send a Pub/Sub message into the given Pub/Sub topic to connect other + systems to data profile generation. The message payload data will be the + byte serialization of `DataProfilePubSubMessage`. + id: GooglePrivacyDlpV2PubSubNotification properties: - nanos: - description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - format: int32 - type: integer - minutes: - type: integer - format: int32 - description: Minutes of hour of day. Must be from 0 to 59. - seconds: - type: integer - format: int32 + event: description: >- - Seconds of minutes of the time. Must normally be from 0 to 59. An - API may allow the value 60 if it allows leap-seconds. - hours: - format: int32 + The type of event that triggers a Pub/Sub. At most one + `PubSubNotification` per EventType is permitted. + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED + type: string + enumDescriptions: + - Unused. + - New profile (not a re-profile). + - >- + One of the following profile metrics changed: Data risk score, + Sensitivity score, Resource visibility, Encryption type, Predicted + infoTypes, Other infoTypes + - Table data risk score or sensitivity score increased. + - A user (non-internal) error occurred. + topic: + type: string description: >- - Hours of day in 24 hour format. Should be from 0 to 23. An API may - choose to allow the value "24:00:00" for scenarios like business - closing time. - type: integer - id: GoogleTypeTimeOfDay + Cloud Pub/Sub topic to send notifications to. Format is + projects/{project}/topics/{topic}. + detailOfMessage: + type: string + enumDescriptions: + - Unused. + - The full table data profile. + - The name of the profiled resource. + - The full file store data profile. + description: >- + How much data to include in the Pub/Sub message. If the user wishes + to limit the size of the message, they can use resource_name and + fetch the profile fields they wish to. Per table profile (not per + column). + enum: + - DETAIL_LEVEL_UNSPECIFIED + - TABLE_PROFILE + - RESOURCE_NAME + - FILE_STORE_PROFILE + pubsubCondition: + description: >- + Conditions (e.g., data risk or sensitivity level) for triggering a + Pub/Sub. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' + type: object + GooglePrivacyDlpV2ByteContentItem: + description: Container for bytes to inspect or redact. type: object - GooglePrivacyDlpV2ListProjectDataProfilesResponse: - id: GooglePrivacyDlpV2ListProjectDataProfilesResponse properties: - nextPageToken: + data: + description: Content data to inspect or redact. + format: byte type: string - description: The next page token. - projectDataProfiles: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' - description: List of data profiles. - type: array - description: List of profiles generated for a given organization or project. - type: object - GooglePrivacyDlpV2Dictionary: + type: + enumDescriptions: + - Unused + - Any image type. + - jpeg + - bmp + - png + - svg + - plain text + - docx, docm, dotx, dotm + - pdf + - pptx, pptm, potx, potm, pot + - xlsx, xlsm, xltx, xltm + - avro + - csv + - tsv + - Audio file types. Only used for profiling. + - Video file types. Only used for profiling. + - Executable file types. Only used for profiling. + enum: + - BYTES_TYPE_UNSPECIFIED + - IMAGE + - IMAGE_JPEG + - IMAGE_BMP + - IMAGE_PNG + - IMAGE_SVG + - TEXT_UTF8 + - WORD_DOCUMENT + - PDF + - POWERPOINT_DOCUMENT + - EXCEL_DOCUMENT + - AVRO + - CSV + - TSV + - AUDIO + - VIDEO + - EXECUTABLE + type: string + description: >- + The type of data stored in the bytes string. Default will be + TEXT_UTF8. + id: GooglePrivacyDlpV2ByteContentItem + GooglePrivacyDlpV2BigQueryKey: + description: Row key for identifying a record in BigQuery table. properties: - cloudStoragePath: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' + tableReference: + description: Complete BigQuery table reference. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + rowNumber: description: >- - Newline-delimited file of words in Cloud Storage. Only a single file - is accepted. - wordList: - description: List of words or phrases to search for. - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' - description: >- - Custom information type based on a dictionary of words or phrases. This - can be used to match sensitive information specific to the data, such as - a list of employee IDs or job titles. Dictionary words are - case-insensitive and all characters other than letters and digits in the - unicode [Basic Multilingual - Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) - will be replaced with whitespace when scanning for matches, so the - dictionary phrase "Sam Johnson" will match all three phrases "sam - johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the - characters surrounding any match must be of a different type than the - adjacent characters within the word, so letters must be next to - non-letters and digits next to non-digits. For example, the dictionary - word "jen" will match the first three letters of the text "jen123" but - will return no matches for "jennifer". Dictionary words containing a - large number of characters that are not letters or digits may result in - unexpected findings because such characters are treated as whitespace. - The [limits](https://cloud.google.com/sensitive-data-protection/limits) - page contains details about the size limits of dictionaries. For - dictionaries that do not fit within these constraints, consider using - `LargeCustomDictionaryConfig` in the `StoredInfoType` API. - id: GooglePrivacyDlpV2Dictionary + Row number inferred at the time the table was scanned. This value is + nondeterministic, cannot be queried, and may be null for inspection + jobs. To locate findings within a table, specify + `inspect_job.storage_config.big_query_options.identifying_fields` in + `CreateDlpJobRequest`. + format: int64 + type: string + id: GooglePrivacyDlpV2BigQueryKey type: object - GooglePrivacyDlpV2StorageMetadataLabel: + GooglePrivacyDlpV2RecordTransformation: + description: The field in a record to transform. + type: object + id: GooglePrivacyDlpV2RecordTransformation properties: - key: + containerTimestamp: + description: Findings container modification timestamp, if applicable. type: string - description: Label name. - description: >- - Storage metadata label to indicate which metadata entry contains - findings. - id: GooglePrivacyDlpV2StorageMetadataLabel - type: object - GooglePrivacyDlpV2CloudStorageOptions: + format: google-datetime + containerVersion: + type: string + description: Container version, if available ("generation" for Cloud Storage). + fieldId: + description: For record transformations, provide a field. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: + id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + description: >- + How often existing tables should have their profiles refreshed. New + tables are scanned as quickly as possible depending on system capacity. properties: - bytesLimitPerFilePercent: - description: >- - Max percentage of bytes to scan from a file. The rest are omitted. - The number of bytes scanned is rounded down. Must be between 0 and - 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only - one of bytes_limit_per_file and bytes_limit_per_file_percent can be - specified. This field can't be set if de-identification is - requested. For certain file types, setting this field has no effect. - For more information, see [Limits on bytes scanned per - file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - format: int32 - type: integer - filesLimitPercent: + refreshFrequency: description: >- - Limits the number of files to scan to this percentage of the input - FileSet. Number of files scanned is rounded down. Must be between 0 - and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. - type: integer - format: int32 - fileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' - description: The set of one or more files to scan. - bytesLimitPerFile: + Data changes (non-schema changes) in Cloud SQL tables can't trigger + reprofiling. If you set this field, profiles are refreshed at this + frequency regardless of whether the underlying tables have changed. + Defaults to never. + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. type: string - format: int64 + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + schemaModifiedCadence: + description: When to reprofile if the schema has changed. + $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' + inspectTemplateModifiedCadence: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence description: >- - Max number of bytes to scan from a file. If a scanned file's size is - bigger than this value then the rest of the bytes are omitted. Only - one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can - be specified. This field can't be set if de-identification is - requested. For certain file types, setting this field has no effect. - For more information, see [Limits on bytes scanned per - file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - fileTypes: + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to update. + type: object + GooglePrivacyDlpV2StoredInfoType: + properties: + pendingVersions: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' description: >- - List of file type groups to include in the scan. If empty, all files - are scanned and available data format processors are applied. In - addition, the binary content of the selected files is always scanned - as well. Images are scanned only as binary if the specified region - does not support image inspection and no file_types were specified. - Image inspection is restricted to 'global', 'us', 'asia', and - 'europe'. + Pending versions of the stored info type. Empty if no versions are + pending. type: array - items: - enumDescriptions: - - Includes all files. - - >- - Includes all file extensions not covered by another entry. - Binary scanning attempts to convert the content of the file to - utf_8 to scan the file. If you wish to avoid this fall back, - specify one or more of the other file types in your storage - scan. - - >- - Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, - cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, - go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, - mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, - rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, - xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, - md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, - xsd, yml, yaml. - - >- - Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting - bytes_limit_per_file or bytes_limit_per_file_percent has no - effect on image files. Image inspection is restricted to the - `global`, `us`, `asia`, and `europe` regions. - - >- - Microsoft Word files larger than 30 MB will be scanned as binary - files. Included file extensions: docx, dotx, docm, dotm. Setting - `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no - effect on Word files. - - >- - PDF files larger than 30 MB will be scanned as binary files. - Included file extensions: pdf. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PDF files. - - 'Included file extensions: avro' - - 'Included file extensions: csv' - - 'Included file extensions: tsv' - - >- - Microsoft PowerPoint files larger than 30 MB will be scanned as - binary files. Included file extensions: pptx, pptm, potx, potm, - pot. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PowerPoint - files. - - >- - Microsoft Excel files larger than 30 MB will be scanned as - binary files. Included file extensions: xlsx, xlsm, xltx, xltm. - Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` - has no effect on Excel files. - enum: - - FILE_TYPE_UNSPECIFIED - - BINARY_FILE - - TEXT_FILE - - IMAGE - - WORD - - PDF - - AVRO - - CSV - - TSV - - POWERPOINT - - EXCEL - type: string - sampleMethod: - enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START - description: How to sample the data. + name: type: string - enumDescriptions: - - No sampling. - - Scan from the top (default). - - >- - For each file larger than bytes_limit_per_file, randomly pick the - offset to start scanning. The scanned bytes are contiguous. - description: Options defining a file or a set of files within a Cloud Storage bucket. - type: object - id: GooglePrivacyDlpV2CloudStorageOptions - GooglePrivacyDlpV2SaveFindings: - properties: - outputConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' - description: Location to store findings outside of DLP. + description: Resource name. + currentVersion: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + description: Current version of the stored info type. type: object - id: GooglePrivacyDlpV2SaveFindings + id: GooglePrivacyDlpV2StoredInfoType description: >- - If set, the detailed findings will be persisted to the specified - OutputStorageConfig. Only a single instance of this action can be - specified. Compatible with: Inspect, Risk - GooglePrivacyDlpV2TableReference: - properties: - tableId: - description: Name of the table. - type: string - datasetId: - description: Dataset ID of the table. - type: string + StoredInfoType resource message that contains information about the + current version and any pending updates. + GooglePrivacyDlpV2InfoTypeTransformation: description: >- - Message defining the location of a BigQuery table with the projectId - inferred from the parent project. - type: object - id: GooglePrivacyDlpV2TableReference - GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: - description: A tuple of values for the quasi-identifier columns. + A transformation to apply to text that is identified as a specific + info_type. + id: GooglePrivacyDlpV2InfoTypeTransformation properties: - quasiIdsValues: - type: array - description: The quasi-identifier values. + primitiveTransformation: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + description: Required. Primitive transformation to apply to the infoType. + infoTypes: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - estimatedProbability: - type: number + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - The estimated probability that a given individual sharing these - quasi-identifier values is in the dataset. This value, typically - called δ, is the ratio between the number of records in the dataset - with these quasi-identifier values, and the total number of - individuals (inside *and* outside the dataset) with these - quasi-identifier values. For example, if there are 15 individuals in - the dataset who share the same quasi-identifier values, and an - estimated 100 people in the entire population with these values, - then δ is 0.15. - format: double + InfoTypes to apply the transformation to. An empty list will cause + this transformation to apply to all findings that correspond to + infoTypes that were requested in `InspectConfig`. + type: array type: object - id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues - GooglePrivacyDlpV2CloudSqlIamCredential: + GooglePrivacyDlpV2OtherInfoTypeSummary: type: object - description: >- - Use IAM authentication to connect. This requires the Cloud SQL IAM - feature to be enabled on the instance, which is not the default for - Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication - and https://cloud.google.com/sql/docs/mysql/authentication. - properties: {} - id: GooglePrivacyDlpV2CloudSqlIamCredential - GooglePrivacyDlpV2DocumentLocation: + properties: + excludedFromAnalysis: + description: >- + Whether this infoType was excluded from sensitivity and risk + analysis due to factors such as low prevalence (subject to change). + type: boolean + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: The other infoType. + estimatedPrevalence: + description: >- + Approximate percentage of non-null rows that contained data detected + by this infotype. + format: int32 + type: integer + description: Infotype details for other infoTypes found within a column. + id: GooglePrivacyDlpV2OtherInfoTypeSummary + GooglePrivacyDlpV2TransformationLocation: type: object - description: Location of a finding within a document. + id: GooglePrivacyDlpV2TransformationLocation + description: Specifies the location of a transformation. properties: - fileOffset: + findingId: + type: string description: >- - Offset of the line, from the beginning of the file, where the - finding is located. - format: int64 - type: string - id: GooglePrivacyDlpV2DocumentLocation - GooglePrivacyDlpV2PubSubNotification: - description: >- - Send a Pub/Sub message into the given Pub/Sub topic to connect other - systems to data profile generation. The message payload data will be the - byte serialization of `DataProfilePubSubMessage`. - id: GooglePrivacyDlpV2PubSubNotification - type: object - properties: - detailOfMessage: + For infotype transformations, link to the corresponding findings ID + so that location information does not need to be duplicated. Each + findings ID correlates to an entry in the findings output table, + this table only gets created when users specify to save findings + (add the save findings action to the request). + recordTransformation: + description: >- + For record transformations, provide a field and container + information. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' + containerType: enum: - - DETAIL_LEVEL_UNSPECIFIED - - TABLE_PROFILE - - RESOURCE_NAME - - FILE_STORE_PROFILE + - TRANSFORM_UNKNOWN_CONTAINER + - TRANSFORM_BODY + - TRANSFORM_METADATA + - TRANSFORM_TABLE + description: >- + Information about the functionality of the container where this + finding occurred, if available. enumDescriptions: - Unused. - - The full table data profile. - - The name of the profiled resource. - - The full file store data profile. - type: string - description: >- - How much data to include in the Pub/Sub message. If the user wishes - to limit the size of the message, they can use resource_name and - fetch the profile fields they wish to. Per table profile (not per - column). - event: + - Body of a file. + - Metadata for a file. + - A table. type: string - description: >- - The type of event that triggers a Pub/Sub. At most one - `PubSubNotification` per EventType is permitted. + GooglePrivacyDlpV2ActionDetails: + description: The results of an Action. + type: object + properties: + deidentifyDetails: + description: Outcome of a de-identification action. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' + id: GooglePrivacyDlpV2ActionDetails + GooglePrivacyDlpV2SensitivityScore: + properties: + score: enumDescriptions: - Unused. - - New profile (not a re-profile). - >- - One of the following profile metrics changed: Data risk score, - Sensitivity score, Resource visibility, Encryption type, Predicted - infoTypes, Other infoTypes - - Table data risk score or sensitivity score increased. - - A user (non-internal) error occurred. + No sensitive information detected. The resource isn't publicly + accessible. + - Unable to determine sensitivity. + - >- + Medium risk. Contains personally identifiable information (PII), + potentially sensitive data, or fields with free-text data that are + at a higher risk of having intermittent sensitive data. Consider + limiting access. + - >- + High risk. Sensitive personally identifiable information (SPII) + can be present. Exfiltration of data can lead to user data loss. + Re-identification of users might be possible. Consider limiting + usage and or removing SPII. + description: The sensitivity score applied to the resource. enum: - - EVENT_TYPE_UNSPECIFIED - - NEW_PROFILE - - CHANGED_PROFILE - - SCORE_INCREASED - - ERROR_CHANGED - pubsubCondition: - description: >- - Conditions (e.g., data risk or sensitivity level) for triggering a - Pub/Sub. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' - topic: - description: >- - Cloud Pub/Sub topic to send notifications to. Format is - projects/{project}/topics/{topic}. + - SENSITIVITY_SCORE_UNSPECIFIED + - SENSITIVITY_LOW + - SENSITIVITY_UNKNOWN + - SENSITIVITY_MODERATE + - SENSITIVITY_HIGH type: string - GooglePrivacyDlpV2InfoTypeDescription: - description: InfoType description. type: object - properties: - categories: - description: The category of the infoType. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' - name: - description: Internal name of the infoType. - type: string - versions: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' - description: A list of available versions for the infotype. - description: - type: string - description: >- - Description of the infotype. Translated when language is provided in - the request. - displayName: - description: Human readable form of the infoType name. - type: string - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The default sensitivity of the infoType. - supportedBy: - description: Which parts of the API supports this InfoType. - items: - type: string - enum: - - ENUM_TYPE_UNSPECIFIED - - INSPECT - - RISK_ANALYSIS - enumDescriptions: - - Unused. - - Supported by the inspect operations. - - Supported by the risk analysis operations. - type: array - id: GooglePrivacyDlpV2InfoTypeDescription - GooglePrivacyDlpV2ExcludeByHotword: + id: GooglePrivacyDlpV2SensitivityScore description: >- - The rule to exclude findings based on a hotword. For record inspection - of tables, column names are considered hotwords. An example of this is - to exclude a finding if it belongs to a BigQuery column that matches a - specific pattern. - type: object - id: GooglePrivacyDlpV2ExcludeByHotword - properties: - proximity: - description: >- - Range of characters within which the entire hotword must reside. The - total length of the window cannot exceed 1000 characters. The - windowBefore property in proximity should be set to 1 if the hotword - needs to be included in a column header. - $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' - hotwordRegex: - description: Regular expression pattern defining what qualifies as a hotword. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - GooglePrivacyDlpV2CreateJobTriggerRequest: + Score is calculated from of all elements in the data profile. A higher + level means the data is more sensitive. + GooglePrivacyDlpV2CloudSqlIamCredential: type: object - id: GooglePrivacyDlpV2CreateJobTriggerRequest - description: Request message for CreateJobTrigger. - properties: - jobTrigger: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - description: Required. The JobTrigger to create. - triggerId: - type: string - description: >- - The trigger id can contain uppercase and lowercase letters, numbers, - and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - locationId: - type: string - description: Deprecated. This field has no effect. - GooglePrivacyDlpV2PublishToStackdriver: - id: GooglePrivacyDlpV2PublishToStackdriver description: >- - Enable Stackdriver metric dlp.googleapis.com/finding_count. This will - publish a metric to stack driver on each infotype requested and how many - findings were found for it. CustomDetectors will be bucketed as 'Custom' - under the Stackdriver label 'info_type'. - type: object + Use IAM authentication to connect. This requires the Cloud SQL IAM + feature to be enabled on the instance, which is not the default for + Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication + and https://cloud.google.com/sql/docs/mysql/authentication. properties: {} - GooglePrivacyDlpV2UpdateJobTriggerRequest: - description: Request message for UpdateJobTrigger. - type: object - id: GooglePrivacyDlpV2UpdateJobTriggerRequest + id: GooglePrivacyDlpV2CloudSqlIamCredential + GooglePrivacyDlpV2RedactImageRequest: + id: GooglePrivacyDlpV2RedactImageRequest properties: - updateMask: - format: google-fieldmask + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: Configuration for the inspector. + locationId: type: string - description: Mask to control which fields get updated. - jobTrigger: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - description: New JobTrigger value. - GooglePrivacyDlpV2FileStoreRegex: - properties: - cloudStorageRegex: - description: Optional. Regex for Cloud Storage. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegex' - id: GooglePrivacyDlpV2FileStoreRegex - description: A pattern to match against one or more file stores. - type: object - GooglePrivacyDlpV2KAnonymityResult: - id: GooglePrivacyDlpV2KAnonymityResult - description: Result of the k-anonymity computation. - properties: - equivalenceClassHistogramBuckets: + description: Deprecated. This field has no effect. + includeFindings: + type: boolean + description: >- + Whether the response should include findings along with the redacted + image. + byteItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + description: The content must be PNG, JPEG, SVG or BMP. + imageRedactionConfigs: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' - description: Histogram of k-anonymity equivalence classes. + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' + description: The configuration for specifying what content to redact from images. type: object - GooglePrivacyDlpV2HybridInspectStatistics: + description: >- + Request to search for potentially sensitive info in an image and redact + it by covering it with a colored rectangle. + GooglePrivacyDlpV2ColumnDataProfile: + id: GooglePrivacyDlpV2ColumnDataProfile type: object - id: GooglePrivacyDlpV2HybridInspectStatistics + description: The profile for a scanned column within a table. properties: - abortedCount: - description: >- - The number of hybrid inspection requests aborted because the job ran - out of quota or was ended before they could be processed. - type: string - format: int64 - processedCount: - description: The number of hybrid inspection requests processed within this job. - format: int64 + tableDataProfile: + description: The resource name of the table data profile. type: string - pendingCount: + datasetLocation: description: >- - The number of hybrid requests currently being processed. Only - populated when called via method `getDlpJob`. A burst of traffic may - cause hybrid inspect requests to be enqueued. Processing will take - place as quickly as possible, but resource limitations may impact - how long a request is enqueued for. + The BigQuery location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + locations. type: string - format: int64 - description: Statistics related to processing hybrid inspect requests. - GooglePrivacyDlpV2AllInfoTypes: - id: GooglePrivacyDlpV2AllInfoTypes + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: The data risk level for this column. + name: + type: string + description: The name of the profile. + tableFullResource: + description: The resource name of the resource this column is within. + type: string + columnType: + enum: + - COLUMN_DATA_TYPE_UNSPECIFIED + - TYPE_INT64 + - TYPE_BOOL + - TYPE_FLOAT64 + - TYPE_STRING + - TYPE_BYTES + - TYPE_TIMESTAMP + - TYPE_DATE + - TYPE_TIME + - TYPE_DATETIME + - TYPE_GEOGRAPHY + - TYPE_NUMERIC + - TYPE_RECORD + - TYPE_BIGNUMERIC + - TYPE_JSON + - TYPE_INTERVAL + - TYPE_RANGE_DATE + - TYPE_RANGE_DATETIME + - TYPE_RANGE_TIMESTAMP + type: string + enumDescriptions: + - Invalid type. + - Encoded as a string in decimal format. + - Encoded as a boolean "false" or "true". + - Encoded as a number, or string "NaN", "Infinity" or "-Infinity". + - Encoded as a string value. + - Encoded as a base64 string per RFC 4648, section 4. + - >- + Encoded as an RFC 3339 timestamp with mandatory "Z" time zone + string: 1985-04-12T23:20:50.52Z + - 'Encoded as RFC 3339 full-date format string: 1985-04-12' + - 'Encoded as RFC 3339 partial-time format string: 23:20:50.52' + - >- + Encoded as RFC 3339 full-date "T" partial-time: + 1985-04-12T23:20:50.52 + - Encoded as WKT + - Encoded as a decimal string. + - Container of ordered fields, each with a type and field name. + - Decimal type. + - Json type. + - Interval type. + - '`Range` type.' + - '`Range` type.' + - '`Range` type.' + description: The data type of a given column. + profileStatus: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + description: >- + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + profileLastGenerated: + description: The last time the profile was generated. + type: string + format: google-datetime + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: The sensitivity of this column. + columnInfoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + description: >- + If it's been determined this column can be identified as a single + type, this will be set. Otherwise the column either has + unidentifiable content or mixed types. + otherMatches: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + description: Other types found within this column. List will be unordered. + type: array + datasetId: + type: string + description: The BigQuery dataset ID. + tableId: + type: string + description: The BigQuery table ID. + column: + type: string + description: The name of the column. + estimatedNullPercentage: + enum: + - NULL_PERCENTAGE_LEVEL_UNSPECIFIED + - NULL_PERCENTAGE_VERY_LOW + - NULL_PERCENTAGE_LOW + - NULL_PERCENTAGE_MEDIUM + - NULL_PERCENTAGE_HIGH + enumDescriptions: + - Unused. + - Very few null entries. + - Some null entries. + - A few null entries. + - A lot of null entries. + type: string + description: Approximate percentage of entries being null in the column. + datasetProjectId: + type: string + description: The Google Cloud project ID that owns the profiled resource. + state: + type: string + description: State of a profile. + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + policyState: + enum: + - COLUMN_POLICY_STATE_UNSPECIFIED + - COLUMN_POLICY_TAGGED + description: Indicates if a policy tag has been applied to the column. + type: string + enumDescriptions: + - No policy tags. + - Column has policy tag applied. + estimatedUniquenessScore: + enum: + - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED + - UNIQUENESS_SCORE_LOW + - UNIQUENESS_SCORE_MEDIUM + - UNIQUENESS_SCORE_HIGH + description: Approximate uniqueness of the column. + enumDescriptions: + - >- + Some columns do not have estimated uniqueness. Possible reasons + include having too few values. + - >- + Low uniqueness, possibly a boolean, enum or similiarly typed + column. + - Medium uniqueness. + - >- + High uniqueness, possibly a column of free text or unique + identifiers. + type: string + freeTextScore: + description: >- + The likelihood that this column contains free-form text. A value + close to 1 may indicate the column is likely to contain free-form or + natural language text. Range in 0-1. + format: double + type: number + GooglePrivacyDlpV2RecordSuppression: + id: GooglePrivacyDlpV2RecordSuppression + description: >- + Configuration to suppress records whose suppression conditions evaluate + to true. type: object - description: Apply transformation to all findings. + properties: + condition: + description: >- + A condition that when it evaluates to true will result in the record + being evaluated to be suppressed from the transformed content. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + GooglePrivacyDlpV2AllOtherResources: properties: {} - GooglePrivacyDlpV2RecordLocation: type: object - description: Location of a finding within a row or record. - id: GooglePrivacyDlpV2RecordLocation + description: Match discovery resources not covered by any other filter. + id: GooglePrivacyDlpV2AllOtherResources + GooglePrivacyDlpV2RecordCondition: properties: - fieldId: - description: Field id of the field containing the finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - recordKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' - description: Key of the finding. - tableLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' - description: Location within a `ContentItem.Table`. - GooglePrivacyDlpV2Result: + expressions: + description: An expression. + $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' + id: GooglePrivacyDlpV2RecordCondition description: >- - All result fields mentioned below are updated while the job is - processing. + A condition for determining whether a transformation should be applied + to a field. + type: object + GooglePrivacyDlpV2JobTrigger: + id: GooglePrivacyDlpV2JobTrigger type: object + description: >- + Contains a configuration to make API calls on a repeating basis. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers + to learn more. properties: - infoTypeStats: + errors: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + readOnly: true description: >- - Statistics of how many instances of each info type were found during - inspect job. + Output only. A stream of errors encountered when the trigger was + activated. Repeated errors may result in the JobTrigger + automatically being paused. Will return the last 100 errors. + Whenever the JobTrigger is modified this list will be cleared. type: array - hybridStats: - description: Statistics related to the processing of hybrid inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' - numRowsProcessed: - format: int64 - description: >- - Number of rows scanned after sampling and time filtering (applicable - for row based stores such as BigQuery). + lastRunTime: + description: Output only. The timestamp of the last time this trigger executed. + readOnly: true type: string - totalEstimatedBytes: + format: google-datetime + triggers: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' + type: array + description: >- + A list of triggers which will be OR'ed together. Only one in the + list needs to trigger for a job to be started. The list may contain + only a single Schedule trigger and must have at least one object. + status: + enumDescriptions: + - Unused. + - Trigger is healthy. + - Trigger is temporarily paused. + - Trigger is cancelled and can not be resumed. + description: Required. A status for this trigger. type: string - description: Estimate of the number of bytes to process. - format: int64 - processedBytes: - format: int64 - description: Total size in bytes that were processed. + enum: + - STATUS_UNSPECIFIED + - HEALTHY + - PAUSED + - CANCELLED + updateTime: + readOnly: true type: string - id: GooglePrivacyDlpV2Result - GooglePrivacyDlpV2CryptoHashConfig: - id: GooglePrivacyDlpV2CryptoHashConfig - properties: - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - description: The key used by the hash function. + description: Output only. The last update timestamp of a triggeredJob. + format: google-datetime + inspectJob: + description: For inspect jobs, a snapshot of the configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + description: + description: User provided description (max 256 chars) + type: string + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The creation timestamp of a triggeredJob. + name: + type: string + description: >- + Unique resource name for the triggeredJob, assigned by the service + when the triggeredJob is created, for example + `projects/dlp-test-project/jobTriggers/53234423`. + displayName: + description: Display name (max 100 chars) + type: string + GooglePrivacyDlpV2RiskAnalysisJobConfig: + type: object description: >- - Pseudonymization method that generates surrogates via cryptographic - hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. - Outputs a base64 encoded representation of the hashed output (for - example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only - string and integer values can be hashed. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + Configuration for a risk analysis job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. - type: object - GooglePrivacyDlpV2ImageTransformation: + properties: + sourceTable: + description: Input dataset to compute metrics over. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + privacyMetric: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + description: Privacy metric to compute. + actions: + type: array + description: >- + Actions to execute at the completion of the job. Are executed in the + order provided. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + id: GooglePrivacyDlpV2RiskAnalysisJobConfig + GooglePrivacyDlpV2DiscoveryTableModifiedCadence: + description: The cadence at which to update data profiles when a table is modified. + id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence type: object properties: - allInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' + types: + items: + type: string + enum: + - TABLE_MODIFICATION_UNSPECIFIED + - TABLE_MODIFIED_TIMESTAMP + enumDescriptions: + - Unused. + - >- + A table will be considered modified when the last_modified_time + from BigQuery has been updated. + type: array description: >- - Apply transformation to all findings not specified in other - ImageTransformation's selected_info_types. Only one instance is - allowed within the ImageTransformations message. - selectedInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' - description: Apply transformation to the selected info_types. - redactionColor: + The type of events to consider when deciding if the table has been + modified and should have the profile updated. Defaults to + MODIFIED_TIMESTAMP. + frequency: + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + type: string description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' - allText: + How frequently data profiles can be updated when tables are + modified. Defaults to never. + GooglePrivacyDlpV2Export: + id: GooglePrivacyDlpV2Export + type: object + description: >- + If set, the detailed data profiles will be persisted to the location of + your choice whenever updated. + properties: + profileTable: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' description: >- - Apply transformation to all text that doesn't match an infoType. - Only one instance is allowed within the ImageTransformations - message. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' - description: Configuration for determining how redaction of images should occur. - id: GooglePrivacyDlpV2ImageTransformation - GooglePrivacyDlpV2QuasiIdField: + Store all table and column profiles in an existing table or a new + table in an existing dataset. Each re-generation will result in new + rows in BigQuery. Data is inserted using [streaming + insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) + and so data may be in the buffer for a period of time after the + profile has finished. The Pub/Sub notification is sent before the + streaming buffer is guaranteed to be written, so data may not be + instantly visible to queries by the time your topic receives the + Pub/Sub notification. + GooglePrivacyDlpV2OutputStorageConfig: properties: - customTag: - description: A auxiliary field. + outputSchema: + enumDescriptions: + - Unused. + - >- + Basic schema including only `info_type`, `quote`, `certainty`, and + `timestamp`. + - Schema tailored to findings from scanning Cloud Storage. + - Schema tailored to findings from scanning Google Datastore. + - Schema tailored to findings from scanning Google BigQuery. + - Schema containing all columns. + enum: + - OUTPUT_SCHEMA_UNSPECIFIED + - BASIC_COLUMNS + - GCS_COLUMNS + - DATASTORE_COLUMNS + - BIG_QUERY_COLUMNS + - ALL_COLUMNS type: string - field: - description: Identifies the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - A quasi-identifier column has a custom_tag, used to know which column in - the data corresponds to which column in the statistical model. - id: GooglePrivacyDlpV2QuasiIdField + description: >- + Schema used for writing the findings for Inspect jobs. This field is + only used for Inspect and must be unspecified for Risk jobs. Columns + are derived from the `Finding` object. If appending to an existing + table, any columns from the predefined schema that are missing will + be added. No columns in the existing table will be deleted. If + unspecified, then all available columns will be used for a new table + or an (existing) table with no schema, and no changes will be made + to an existing table that has a schema. Only for use with external + storage. + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: >- + Store findings in an existing table or a new table in an existing + dataset. If table_id is not set a new one will be generated for you + with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. + Pacific time zone will be used for generating the date details. For + Inspect, each column in an existing output table must have the same + name, type, and mode of a field in the `Finding` object. For Risk, + an existing output table should be the output of a previous Risk + analysis job run on the same source table, with the same privacy + metric and quasi-identifiers. Risk jobs that analyze the same table + but compute a different privacy metric, or use different sets of + quasi-identifiers, cannot store their results in the same table. + id: GooglePrivacyDlpV2OutputStorageConfig type: object - GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: - description: Request message for UpdateDiscoveryConfig. - id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + description: Cloud repository for storing output. + GooglePrivacyDlpV2DeidentifyConfig: + description: The configuration that controls how the data will change. + id: GooglePrivacyDlpV2DeidentifyConfig properties: - updateMask: - format: google-fieldmask - description: Mask to control which fields get updated. + transformationErrorHandling: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' + description: >- + Mode for handling transformation errors. If left unspecified, the + default mode is `TransformationErrorHandling.ThrowError`. + infoTypeTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + description: >- + Treat the dataset as free-form text and apply the same free text + transformation everywhere. + imageTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' + description: Treat the dataset as an image and redact. + recordTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' + description: >- + Treat the dataset as structured. Transformations can be applied to + specific locations within structured datasets, such as transforming + a column within a table. + type: object + GooglePrivacyDlpV2ListTableDataProfilesResponse: + description: List of profiles generated for a given organization or project. + type: object + properties: + tableDataProfiles: + description: List of data profiles. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + type: array + nextPageToken: type: string - discoveryConfig: - description: Required. New DiscoveryConfig value. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: The next page token. + id: GooglePrivacyDlpV2ListTableDataProfilesResponse + GooglePrivacyDlpV2DiscoveryBigQueryFilter: type: object - GoogleRpcStatus: description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + Determines what tables will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID, dataset ID, and table ID. properties: - message: + otherTables: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - details: - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + Catch-all. This should always be the last filter in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. + tableReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableReference' + description: >- + The table to scan. Discovery configurations including this can only + include one DiscoveryTarget (the DiscoveryTarget with this + TableReference). + tables: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableCollection' + description: >- + A specific set of tables for this filter to apply to. A table + collection must be specified in only one filter per config. If a + table id or dataset is empty, Cloud DLP assumes all tables in that + collection must be profiled. Must specify a project ID. + id: GooglePrivacyDlpV2DiscoveryBigQueryFilter + GooglePrivacyDlpV2FileStoreDataProfile: + description: 'The profile for a file store. * Cloud Storage: maps 1:1 with a bucket.' + type: object + id: GooglePrivacyDlpV2FileStoreDataProfile + properties: + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: The sensitivity score of this resource. + fileClusterSummaries: + description: FileClusterSummary per each cluster. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterSummary' + type: array + fileStoreInfoTypeSummaries: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' + description: InfoTypes detected in this file store. + dataStorageLocations: + items: + type: string + type: array + description: >- + For resources that have multiple storage locations, these are those + regions. For Cloud Storage this is the list of regions chosen for + dual-region storage. `file_store_location` will normally be the + corresponding multi-region for the list of individual locations. The + first region is always picked as the processing and storage location + for the data profile. + fileStoreLocation: + type: string + description: >- + The location of the file store. * Cloud Storage: + https://cloud.google.com/storage/docs/locations#available-locations + profileLastGenerated: + type: string + description: The last time the profile was generated. + format: google-datetime + configSnapshot: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + description: The snapshot of the configurations used to generate the profile. + fileStorePath: + type: string + description: 'The file store path. * Cloud Storage: `gs://{bucket}`' + profileStatus: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + description: >- + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + resourceAttributes: + additionalProperties: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: >- + Attributes of the resource being profiled. Currently used + attributes: * customer_managed_encryption: boolean - true: the + resource is encrypted with a customer-managed key. - false: the + resource is encrypted with a provider-managed key. + type: object + projectId: + type: string + description: The Google Cloud project ID that owns the resource. + state: + description: State of a profile. + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + type: string + projectDataProfile: + description: The resource name of the project data profile for this file store. + type: string + dataSourceType: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + description: The resource type that was profiled. + fullResource: + type: string + description: >- + The resource name of the resource profiled. + https://cloud.google.com/apis/design/resource_names#full_resource_name + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: The data risk level of this resource. + resourceLabels: + type: object + description: >- + The labels applied to the resource at the time the profile was + generated. + additionalProperties: + type: string + createTime: + format: google-datetime + description: The time the file store was first created. + type: string + lastModifiedTime: + type: string + format: google-datetime + description: The time the file store was last modified. + fileStoreIsEmpty: + type: boolean + description: The file store does not have any files. + name: + type: string + description: The name of the profile. + resourceVisibility: + enum: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + type: string + enumDescriptions: + - Unused. + - Visible to any user. + - >- + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. + description: How broadly a resource has been shared. + locationType: + type: string + description: >- + The location type of the bucket (region, dual-region, multi-region, + etc). If dual-region, expect data_storage_locations to be populated. + GooglePrivacyDlpV2NumericalStatsConfig: + id: GooglePrivacyDlpV2NumericalStatsConfig + description: >- + Compute numerical stats over an individual column, including min, max, + and quantiles. + properties: + field: + description: >- + Field to compute numerical stats on. Supported types are integer, + float, date, datetime, timestamp, time. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + type: object + GooglePrivacyDlpV2TimeZone: + id: GooglePrivacyDlpV2TimeZone + properties: + offsetMinutes: + format: int32 + description: >- + Set only if the offset can be determined. Positive for time ahead of + UTC. E.g. For "UTC-9", this value is -540. + type: integer + type: object + description: Time zone of the date time object. + GooglePrivacyDlpV2BucketingConfig: + id: GooglePrivacyDlpV2BucketingConfig + description: >- + Generalization function that buckets values based on ranges. The ranges + and replacement values are dynamically provided by the user for custom + behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can + be used on data of type: number, long, string, timestamp. If the bound + `Value` type differs from the type of data being transformed, we will + first attempt converting the type of the data to be transformed to match + the type of the bound before comparing. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing + to learn more. + properties: + buckets: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' + description: Set of buckets. Ranges must be non-overlapping. + type: object + GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence: + id: GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence + properties: + inspectTemplateModifiedCadence: + description: >- + Optional. Governs when to update data profiles when the inspection + rules defined by the `InspectTemplate` change. If not set, changing + the template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + refreshFrequency: + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + type: string + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + description: >- + Optional. Data changes in Cloud Storage can't trigger reprofiling. + If you set this field, profiles are refreshed at this frequency + regardless of whether the underlying buckets have changed. Defaults + to never. + description: >- + How often existing buckets should have their profiles refreshed. New + buckets are scanned as quickly as possible depending on system capacity. + type: object + GooglePrivacyDlpV2TransformationDescription: + type: object + description: >- + A flattened description of a `PrimitiveTransformation` or + `RecordSuppression`. + properties: + type: + type: string + enumDescriptions: + - Unused + - Record suppression + - Replace value + - Replace value using a dictionary. + - Redact + - Character mask + - FFX-FPE + - Fixed size bucketing + - Bucketing + - Replace with info type + - Time part + - Crypto hash + - Date shift + - Deterministic crypto + - Redact image + description: The transformation type. + enum: + - TRANSFORMATION_TYPE_UNSPECIFIED + - RECORD_SUPPRESSION + - REPLACE_VALUE + - REPLACE_DICTIONARY + - REDACT + - CHARACTER_MASK + - CRYPTO_REPLACE_FFX_FPE + - FIXED_SIZE_BUCKETING + - BUCKETING + - REPLACE_WITH_INFO_TYPE + - TIME_PART + - CRYPTO_HASH + - DATE_SHIFT + - CRYPTO_DETERMINISTIC_CONFIG + - REDACT_IMAGE + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: Set if the transformation was limited to a specific `InfoType`. + description: + type: string + description: >- + A description of the transformation. This is empty for a + RECORD_SUPPRESSION, or is the output of calling toString() on the + `PrimitiveTransformation` protocol buffer message for any other type + of transformation. + condition: + type: string + description: >- + A human-readable string representation of the `RecordCondition` + corresponding to this transformation. Set if a `RecordCondition` was + used to determine whether or not to apply this transformation. + Examples: * (age_field > 85) * (age_field <= 18) * (zip_field + exists) * (zip_field == 01234) && (city_field != "Springville") * + (zip_field == 01234) && (age_field <= 18) && (city_field exists) + id: GooglePrivacyDlpV2TransformationDescription + GooglePrivacyDlpV2PublishToPubSub: + id: GooglePrivacyDlpV2PublishToPubSub + properties: + topic: + description: >- + Cloud Pub/Sub topic to send notifications to. The topic must have + given publishing access rights to the DLP API service account + executing the long running DlpJob sending the notifications. Format + is projects/{project}/topics/{topic}. + type: string + description: >- + Publish a message into a given Pub/Sub topic when DlpJob has completed. + The message contains a single field, `DlpJobName`, which is equal to the + finished job's + [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). + Compatible with: Inspect, Risk + type: object + GooglePrivacyDlpV2DiscoveryTarget: + properties: + secretsTarget: + description: >- + Discovery target that looks for credentials and secrets stored in + cloud resource metadata and reports them as vulnerabilities to + Security Command Center. Only one target of this type is allowed. + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' + cloudSqlTarget: + description: >- + Cloud SQL target for Discovery. The first target to match a table + will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' + cloudStorageTarget: + description: >- + Cloud Storage target for Discovery. The first target to match a + table will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageDiscoveryTarget' + bigQueryTarget: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' + description: >- + BigQuery target for Discovery. The first target to match a table + will be the one applied. + id: GooglePrivacyDlpV2DiscoveryTarget + type: object + description: Target used to match against for Discovery. + GooglePrivacyDlpV2Connection: + description: >- + A data connection to allow DLP to profile data in locations that require + additional configuration. + type: object + properties: + state: + enum: + - CONNECTION_STATE_UNSPECIFIED + - MISSING_CREDENTIALS + - AVAILABLE + - ERROR + description: Required. The connection's state in its lifecycle. + enumDescriptions: + - Unused + - >- + DLP automatically created this connection during an initial scan, + and it is awaiting full configuration by a user. + - A configured connection that has not encountered any errors. + - >- + A configured connection that encountered errors during its last + use. It will not be used again until it is set to AVAILABLE. If + the resolution requires external action, then the client must send + a request to set the status to AVAILABLE when the connection is + ready for use. If the resolution doesn't require external action, + then any changes to the connection properties will automatically + mark it as AVAILABLE. + type: string + errors: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + readOnly: true + type: array + description: >- + Output only. Set if status == ERROR, to provide additional details. + Will store the last 10 errors sorted with the most recent first. + name: + type: string + description: >- + Output only. Name of the connection: + `projects/{project}/locations/{location}/connections/{name}`. + readOnly: true + cloudSql: + description: Connect to a Cloud SQL instance. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' + id: GooglePrivacyDlpV2Connection + GooglePrivacyDlpV2ReidentifyContentResponse: + description: Results of re-identifying an item. + properties: + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: The re-identified item. + overview: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' + description: An overview of the changes that were made to the `item`. + id: GooglePrivacyDlpV2ReidentifyContentResponse + type: object + GooglePrivacyDlpV2PublishToChronicle: + properties: {} + type: object + description: Message expressing intention to publish to Google Security Operations. + id: GooglePrivacyDlpV2PublishToChronicle + GooglePrivacyDlpV2TableLocation: + type: object + id: GooglePrivacyDlpV2TableLocation + properties: + rowIndex: + description: >- + The zero-based index of the row where the finding is located. Only + populated for resources that have a natural ordering, not BigQuery. + In BigQuery, to identify the row a finding came from, populate + BigQueryOptions.identifying_fields with your primary key column + names and when you store the findings the value of those columns + will be stored inside of Finding. + type: string + format: int64 + description: Location of a finding within a table. + GooglePrivacyDlpV2NumericalStatsResult: + properties: + maxValue: + description: Maximum value appearing in the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + minValue: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Minimum value appearing in the column. + quantileValues: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: >- + List of 99 values that partition the set of field values into 100 + equal sized buckets. + id: GooglePrivacyDlpV2NumericalStatsResult + description: Result of the numerical stats computation. + type: object + GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: + description: Request message for UpdateDiscoveryConfig. + properties: + updateMask: + type: string + format: google-fieldmask + description: Mask to control which fields get updated. + discoveryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: Required. New DiscoveryConfig value. + id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + type: object + GooglePrivacyDlpV2CreateDlpJobRequest: + properties: + riskJob: + description: >- + A risk analysis job calculates re-identification risk metrics for a + BigQuery table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + inspectJob: + description: An inspection job scans a storage repository for InfoTypes. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + locationId: + type: string + description: Deprecated. This field has no effect. + jobId: + type: string + description: >- + The job id can contain uppercase and lowercase letters, numbers, and + hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + description: >- + Request message for CreateDlpJobRequest. Used to initiate long running + jobs such as calculating risk metrics or inspecting Google Cloud + Storage. + id: GooglePrivacyDlpV2CreateDlpJobRequest + type: object + GooglePrivacyDlpV2TransformationSummary: + id: GooglePrivacyDlpV2TransformationSummary + properties: + fieldTransformations: + description: >- + The field transformation that was applied. If multiple field + transformations are requested for a single field, this list will + contain all of them; otherwise, only one is supplied. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + type: array + recordSuppress: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + description: The specific suppression option these stats apply to. + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Set if the transformation was limited to a specific FieldId. + transformedBytes: + description: Total size in bytes that were transformed in some way. + type: string + format: int64 + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: Set if the transformation was limited to a specific InfoType. + transformation: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + description: The specific transformation these stats apply to. + results: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' + description: Collection of all transformations that took place or had an error. + type: object + description: >- + Summary of a single transformation. Only one of 'transformation', + 'field_transformation', or 'record_suppress' will be set. + GooglePrivacyDlpV2BigQueryRegex: + description: >- + A pattern to match against one or more tables, datasets, or projects + that contain BigQuery tables. At least one pattern must be specified. + Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + type: object + properties: + tableIdRegex: + type: string + description: If unset, this property matches all tables. + datasetIdRegex: + type: string + description: If unset, this property matches all datasets. + projectIdRegex: + description: >- + For organizations, if unset, will match all projects. Has no effect + for data profile configurations created within a project. + type: string + id: GooglePrivacyDlpV2BigQueryRegex + GooglePrivacyDlpV2PubSubExpressions: + type: object + id: GooglePrivacyDlpV2PubSubExpressions + description: An expression, consisting of an operator and conditions. + properties: + logicalOperator: + type: string + description: The operator to apply to the collection of conditions. + enumDescriptions: + - Unused. + - Conditional OR. + - Conditional AND. + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - OR + - AND + conditions: + description: Conditions to apply to the expression. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' + type: array + GooglePrivacyDlpV2MetadataLocation: + id: GooglePrivacyDlpV2MetadataLocation + properties: + type: + enum: + - METADATATYPE_UNSPECIFIED + - STORAGE_METADATA + enumDescriptions: + - Unused + - General file metadata provided by Cloud Storage. + description: Type of metadata containing the finding. + type: string + storageLabel: + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' + description: Storage metadata. + type: object + description: Metadata Location + GooglePrivacyDlpV2ListJobTriggersResponse: + type: object + id: GooglePrivacyDlpV2ListJobTriggersResponse + properties: + jobTriggers: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + type: array + description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. + nextPageToken: + type: string + description: >- + If the next page is available then this value is the next page token + to be used in the following ListJobTriggers request. + description: Response message for ListJobTriggers. + GooglePrivacyDlpV2ProjectDataProfile: + id: GooglePrivacyDlpV2ProjectDataProfile + type: object + properties: + name: + type: string + description: The resource name of the profile. + sensitivityScore: + description: The sensitivity score of this project. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + tableDataProfileCount: + type: string + description: The number of table data profiles generated for this project. + format: int64 + fileStoreDataProfileCount: + type: string + format: int64 + description: The number of file store data profiles generated for this project. + profileLastGenerated: + description: The last time the profile was generated. + format: google-datetime + type: string + dataRiskLevel: + description: The data risk level of this project. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + projectId: + type: string + description: Project ID or account that was profiled. + profileStatus: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + description: Success or error status of the last attempt to profile the project. + description: >- + An aggregated profile for this project, based on the resources profiled + within it. + GooglePrivacyDlpV2ReplaceValueConfig: + description: Replace each input value with a given `Value`. + id: GooglePrivacyDlpV2ReplaceValueConfig + type: object + properties: + newValue: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Value to replace it with. + GooglePrivacyDlpV2DatastoreKey: + id: GooglePrivacyDlpV2DatastoreKey + description: Record key for a finding in Cloud Datastore. + properties: + entityKey: + description: Datastore entity key. + $ref: '#/components/schemas/GooglePrivacyDlpV2Key' + type: object + GooglePrivacyDlpV2InspectDataSourceDetails: + properties: + requestedOptions: + description: The configuration used for this job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' + result: + $ref: '#/components/schemas/GooglePrivacyDlpV2Result' + description: A summary of the outcome of this inspection job. + id: GooglePrivacyDlpV2InspectDataSourceDetails + type: object + description: The results of an inspect DataSource job. + GooglePrivacyDlpV2Expressions: + type: object + description: An expression, consisting of an operator and conditions. + id: GooglePrivacyDlpV2Expressions + properties: + logicalOperator: + type: string + description: >- + The operator to apply to the result of conditions. Default and + currently only supported value is `AND`. + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - AND + enumDescriptions: + - Unused + - Conditional AND + conditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' + description: Conditions to apply to the expression. + GooglePrivacyDlpV2InfoTypeCategory: + description: >- + Classification of infoTypes to organize them according to geographic + location, industry, and data type. + type: object + id: GooglePrivacyDlpV2InfoTypeCategory + properties: + industryCategory: + enum: + - INDUSTRY_UNSPECIFIED + - FINANCE + - HEALTH + - TELECOMMUNICATIONS + enumDescriptions: + - Unused industry + - The infoType is typically used in the finance industry. + - The infoType is typically used in the health industry. + - The infoType is typically used in the telecommunications industry. + type: string + description: >- + The group of relevant businesses where this infoType is commonly + used + locationCategory: + enumDescriptions: + - Unused location + - >- + The infoType is not issued by or tied to a specific region, but is + used almost everywhere. + - The infoType is typically used in Argentina. + - The infoType is typically used in Armenia. + - The infoType is typically used in Australia. + - The infoType is typically used in Azerbaijan. + - The infoType is typically used in Belarus. + - The infoType is typically used in Belgium. + - The infoType is typically used in Brazil. + - The infoType is typically used in Canada. + - The infoType is typically used in Chile. + - The infoType is typically used in China. + - The infoType is typically used in Colombia. + - The infoType is typically used in Croatia. + - The infoType is typically used in Denmark. + - The infoType is typically used in France. + - The infoType is typically used in Finland. + - The infoType is typically used in Germany. + - The infoType is typically used in Hong Kong. + - The infoType is typically used in India. + - The infoType is typically used in Indonesia. + - The infoType is typically used in Ireland. + - The infoType is typically used in Israel. + - The infoType is typically used in Italy. + - The infoType is typically used in Japan. + - The infoType is typically used in Kazakhstan. + - The infoType is typically used in Korea. + - The infoType is typically used in Mexico. + - The infoType is typically used in the Netherlands. + - The infoType is typically used in New Zealand. + - The infoType is typically used in Norway. + - The infoType is typically used in Paraguay. + - The infoType is typically used in Peru. + - The infoType is typically used in Poland. + - The infoType is typically used in Portugal. + - The infoType is typically used in Russia. + - The infoType is typically used in Singapore. + - The infoType is typically used in South Africa. + - The infoType is typically used in Spain. + - The infoType is typically used in Sweden. + - The infoType is typically used in Switzerland. + - The infoType is typically used in Taiwan. + - The infoType is typically used in Thailand. + - The infoType is typically used in Turkey. + - The infoType is typically used in Ukraine. + - The infoType is typically used in the United Kingdom. + - The infoType is typically used in the United States. + - The infoType is typically used in Uruguay. + - The infoType is typically used in Uzbekistan. + - The infoType is typically used in Venezuela. + - The infoType is typically used in Google internally. + enum: + - LOCATION_UNSPECIFIED + - GLOBAL + - ARGENTINA + - ARMENIA + - AUSTRALIA + - AZERBAIJAN + - BELARUS + - BELGIUM + - BRAZIL + - CANADA + - CHILE + - CHINA + - COLOMBIA + - CROATIA + - DENMARK + - FRANCE + - FINLAND + - GERMANY + - HONG_KONG + - INDIA + - INDONESIA + - IRELAND + - ISRAEL + - ITALY + - JAPAN + - KAZAKHSTAN + - KOREA + - MEXICO + - THE_NETHERLANDS + - NEW_ZEALAND + - NORWAY + - PARAGUAY + - PERU + - POLAND + - PORTUGAL + - RUSSIA + - SINGAPORE + - SOUTH_AFRICA + - SPAIN + - SWEDEN + - SWITZERLAND + - TAIWAN + - THAILAND + - TURKEY + - UKRAINE + - UNITED_KINGDOM + - UNITED_STATES + - URUGUAY + - UZBEKISTAN + - VENEZUELA + - INTERNAL + description: >- + The region or country that issued the ID or document represented by + the infoType. + type: string + typeCategory: + enumDescriptions: + - Unused type + - >- + Personally identifiable information, for example, a name or phone + number + - >- + Personally identifiable information that is especially sensitive, + for example, a passport number. + - >- + Attributes that can partially identify someone, especially in + combination with other attributes, like age, height, and gender. + - Confidential or secret information, for example, a password. + - An identification document issued by a government. + - A document, for example, a resume or source code. + - >- + Information that is not sensitive on its own, but provides details + about the circumstances surrounding an entity or an event. + enum: + - TYPE_UNSPECIFIED + - PII + - SPII + - DEMOGRAPHIC + - CREDENTIAL + - GOVERNMENT_ID + - DOCUMENT + - CONTEXTUAL_INFORMATION + description: The class of identifiers where this infoType belongs + type: string + GooglePrivacyDlpV2RequestedDeidentifyOptions: + type: object + id: GooglePrivacyDlpV2RequestedDeidentifyOptions + properties: + snapshotImageRedactTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: >- + Snapshot of the state of the image transformation + `DeidentifyTemplate` from the `Deidentify` action at the time this + job was run. + snapshotStructuredDeidentifyTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: >- + Snapshot of the state of the structured `DeidentifyTemplate` from + the `Deidentify` action at the time this job was run. + snapshotDeidentifyTemplate: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: object - id: GoogleRpcStatus - GooglePrivacyDlpV2PartitionId: - properties: - namespaceId: - type: string - description: If not empty, the ID of the namespace to which the entities belong. - projectId: - description: The ID of the project to which the entities belong. - type: string - type: object - id: GooglePrivacyDlpV2PartitionId + Snapshot of the state of the `DeidentifyTemplate` from the + Deidentify action at the time this job was run. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: De-identification options. + GooglePrivacyDlpV2DatabaseResourceCollection: description: >- - Datastore partition ID. A partition ID identifies a grouping of - entities. The grouping is always by project and namespace, however the - namespace ID may be empty. A partition ID contains several dimensions: - project ID and namespace ID. - GooglePrivacyDlpV2DetectionRule: - id: GooglePrivacyDlpV2DetectionRule + Match database resources using regex filters. Examples of database + resources are tables, views, and stored procedures. type: object - description: >- - Deprecated; use `InspectionRuleSet` instead. Rule for modifying a - `CustomInfoType` to alter behavior under certain circumstances, - depending on the specific details of the rule. Not supported for the - `surrogate_type` custom infoType. + id: GooglePrivacyDlpV2DatabaseResourceCollection properties: - hotwordRule: - description: Hotword-based detection rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - GooglePrivacyDlpV2Expressions: + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' + description: >- + A collection of regular expressions to match a database resource + against. + GooglePrivacyDlpV2VersionDescription: type: object - id: GooglePrivacyDlpV2Expressions - description: An expression, consisting of an operator and conditions. + description: Details about each available version for an infotype. + id: GooglePrivacyDlpV2VersionDescription properties: - logicalOperator: - enumDescriptions: - - Unused - - Conditional AND + version: + description: Name of the version + type: string + description: + type: string + description: Description of the version. + GooglePrivacyDlpV2SchemaModifiedCadence: + properties: + frequency: type: string description: >- - The operator to apply to the result of conditions. Default and - currently only supported value is `AND`. + Frequency to regenerate data profiles when the schema is modified. + Defaults to monthly. + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - AND - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' - description: Conditions to apply to the expression. - GooglePrivacyDlpV2RecordTransformations: - id: GooglePrivacyDlpV2RecordTransformations - type: object - properties: - fieldTransformations: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + types: type: array - description: Transform the record by applying various field transformations. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' - recordSuppressions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' description: >- - Configuration defining which records get suppressed entirely. - Records that match any suppression rule are omitted from the output. - type: array - description: >- - A type of transformation that is applied over structured data such as a - table. - GooglePrivacyDlpV2HybridOptions: - description: >- - Configuration to control jobs where the content being inspected is - outside of Google Cloud Platform. - type: object - properties: - requiredFindingLabelKeys: - type: array + The types of schema modifications to consider. Defaults to + NEW_COLUMNS. items: + enum: + - SQL_SCHEMA_MODIFICATION_UNSPECIFIED + - NEW_COLUMNS + - REMOVED_COLUMNS + enumDescriptions: + - Unused. + - New columns have appeared. + - Columns have been removed from the table. type: string - description: >- - These are labels that each inspection request must include within - their 'finding_labels' map. Request may contain others, but any - missing one of these will be rejected. Label keys must be between 1 - and 63 characters long and must conform to the following regular - expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can - be required. - labels: - description: >- - To organize findings, these labels will be added to each finding. - Label keys must be between 1 and 63 characters long and must conform - to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. - Label values must be between 0 and 63 characters long and must - conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. - No more than 10 labels can be associated with a given finding. - Examples: * `"environment" : "production"` * `"pipeline" : "etl"` - additionalProperties: - type: string - type: object - description: - type: string - description: >- - A short description of where the data is coming from. Will be stored - once in the job. 256 max length. - tableOptions: - description: >- - If the container is a table, additional information to make findings - meaningful such as the columns that are primary keys. - $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' - id: GooglePrivacyDlpV2HybridOptions - GooglePrivacyDlpV2TransformationSummary: - id: GooglePrivacyDlpV2TransformationSummary + id: GooglePrivacyDlpV2SchemaModifiedCadence + type: object + description: >- + How frequently to modify the profile when the table's schema is + modified. + GooglePrivacyDlpV2Conditions: properties: - infoType: - description: Set if the transformation was limited to a specific InfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - fieldTransformations: + conditions: + description: A collection of conditions. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' - type: array - description: >- - The field transformation that was applied. If multiple field - transformations are requested for a single field, this list will - contain all of them; otherwise, only one is supplied. - transformation: - description: The specific transformation these stats apply to. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - results: + $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' type: array - description: Collection of all transformations that took place or had an error. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' - recordSuppress: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' - description: The specific suppression option these stats apply to. + id: GooglePrivacyDlpV2Conditions + description: A collection of conditions. + type: object + GooglePrivacyDlpV2BigQueryField: + properties: + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Source table of the field. field: + description: Designated field in the BigQuery table. $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Set if the transformation was limited to a specific FieldId. - transformedBytes: - description: Total size in bytes that were transformed in some way. - type: string - format: int64 - description: >- - Summary of a single transformation. Only one of 'transformation', - 'field_transformation', or 'record_suppress' will be set. + id: GooglePrivacyDlpV2BigQueryField type: object - GooglePrivacyDlpV2Export: - description: >- - If set, the detailed data profiles will be persisted to the location of - your choice whenever updated. + description: Message defining a field of a BigQuery table. + GooglePrivacyDlpV2FileStoreCollection: + id: GooglePrivacyDlpV2FileStoreCollection type: object + description: Match file stores (e.g. buckets) using regex filters. properties: - profileTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegexes' description: >- - Store all table and column profiles in an existing table or a new - table in an existing dataset. Each re-generation will result in new - rows in BigQuery. Data is inserted using [streaming - insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) - and so data may be in the buffer for a period of time after the - profile has finished. The Pub/Sub notification is sent before the - streaming buffer is guaranteed to be written, so data may not be - instantly visible to queries by the time your topic receives the - Pub/Sub notification. - id: GooglePrivacyDlpV2Export - GooglePrivacyDlpV2FileSet: + Optional. A collection of regular expressions to match a file store + against. + GooglePrivacyDlpV2LargeCustomDictionaryStats: + type: object properties: - regexFileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegexFileSet' - description: >- - The regex-filtered set of files to scan. Exactly one of `url` or - `regex_file_set` must be set. - url: - description: >- - The Cloud Storage url of the file(s) to scan, in the format - `gs:///`. Trailing wildcard in the path is allowed. If the url ends - in a trailing slash, the bucket or directory represented by the url - will be scanned non-recursively (content in sub-directories will not - be scanned). This means that `gs://mybucket/` is equivalent to - `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to - `gs://mybucket/directory/*`. Exactly one of `url` or - `regex_file_set` must be set. + approxNumPhrases: type: string - id: GooglePrivacyDlpV2FileSet - description: Set of files to scan. - type: object - GooglePrivacyDlpV2HybridInspectDlpJobRequest: - description: Request to search for potentially sensitive info in a custom location. - id: GooglePrivacyDlpV2HybridInspectDlpJobRequest + format: int64 + description: Approximate number of distinct phrases in the dictionary. + id: GooglePrivacyDlpV2LargeCustomDictionaryStats + description: Summary statistics of a custom dictionary. + GooglePrivacyDlpV2FinishDlpJobRequest: + id: GooglePrivacyDlpV2FinishDlpJobRequest type: object - properties: - hybridItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - description: The item to inspect. - GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: + description: The request message for finishing a DLP hybrid job. + properties: {} + GooglePrivacyDlpV2InspectTemplate: + id: GooglePrivacyDlpV2InspectTemplate + description: >- + The inspectTemplate contains a configuration (set of types of sensitive + data to be detected) to be used anywhere you otherwise would normally + specify InspectConfig. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates + to learn more. type: object properties: - locationId: - description: Deprecated. This field has no effect. + updateTime: + readOnly: true type: string - deidentifyTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: Required. The DeidentifyTemplate to create. - templateId: + format: google-datetime + description: Output only. The last update timestamp of an inspectTemplate. + displayName: + description: Display name (max 256 chars). + type: string + createTime: + format: google-datetime + description: Output only. The creation timestamp of an inspectTemplate. type: string + readOnly: true + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' description: >- - The template id can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest - description: Request message for CreateDeidentifyTemplate. - GooglePrivacyDlpV2InspectionRule: - type: object - description: >- - A single inspection rule to be applied to infoTypes, specified in - `InspectionRuleSet`. - id: GooglePrivacyDlpV2InspectionRule - properties: - exclusionRule: - description: Exclusion rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' - hotwordRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - description: Hotword-based detection rule. - GooglePrivacyDlpV2TableLocation: + The core content of the template. Configuration of the scanning + process. + name: + description: >- + Output only. The template name. The template will have one of the + following formats: + `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR + `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; + readOnly: true + type: string + description: + type: string + description: Short description (max 256 chars). + GooglePrivacyDlpV2TransformationOverview: + description: Overview of the modifications that occurred. + id: GooglePrivacyDlpV2TransformationOverview type: object - id: GooglePrivacyDlpV2TableLocation - description: Location of a finding within a table. properties: - rowIndex: + transformationSummaries: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' + description: Transformations applied to the dataset. + transformedBytes: type: string - description: >- - The zero-based index of the row where the finding is located. Only - populated for resources that have a natural ordering, not BigQuery. - In BigQuery, to identify the row a finding came from, populate - BigQueryOptions.identifying_fields with your primary key column - names and when you store the findings the value of those columns - will be stored inside of Finding. format: int64 - GooglePrivacyDlpV2ReidentifyContentResponse: - id: GooglePrivacyDlpV2ReidentifyContentResponse - properties: - overview: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' - description: An overview of the changes that were made to the `item`. - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The re-identified item. - type: object - description: Results of re-identifying an item. + description: Total size in bytes that were transformed in some way. GooglePrivacyDlpV2TaggedField: + description: A column with a semantic tag attached. + type: object properties: customTag: description: >- @@ -7018,704 +7026,711 @@ components: programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Required. Identifies the column. inferred: description: >- If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data $ref: '#/components/schemas/GoogleProtobufEmpty' - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Required. Identifies the column. - description: A column with a semantic tag attached. id: GooglePrivacyDlpV2TaggedField - type: object - GooglePrivacyDlpV2BigQueryRegex: - description: >- - A pattern to match against one or more tables, datasets, or projects - that contain BigQuery tables. At least one pattern must be specified. - Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - properties: - tableIdRegex: - description: If unset, this property matches all tables. - type: string - projectIdRegex: - type: string - description: >- - For organizations, if unset, will match all projects. Has no effect - for data profile configurations created within a project. - datasetIdRegex: - type: string - description: If unset, this property matches all datasets. - id: GooglePrivacyDlpV2BigQueryRegex - type: object - GooglePrivacyDlpV2MetadataLocation: - type: object - properties: - type: - enum: - - METADATATYPE_UNSPECIFIED - - STORAGE_METADATA - enumDescriptions: - - Unused - - General file metadata provided by Cloud Storage. - description: Type of metadata containing the finding. - type: string - storageLabel: - description: Storage metadata. - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' - id: GooglePrivacyDlpV2MetadataLocation - description: Metadata Location - GooglePrivacyDlpV2DiscoveryTarget: - properties: - secretsTarget: - description: >- - Discovery target that looks for credentials and secrets stored in - cloud resource metadata and reports them as vulnerabilities to - Security Command Center. Only one target of this type is allowed. - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' - cloudStorageTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageDiscoveryTarget' - description: >- - Cloud Storage target for Discovery. The first target to match a - table will be the one applied. - cloudSqlTarget: - description: >- - Cloud SQL target for Discovery. The first target to match a table - will be the one applied. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' - bigQueryTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' - description: >- - BigQuery target for Discovery. The first target to match a table - will be the one applied. - type: object - description: Target used to match against for Discovery. - id: GooglePrivacyDlpV2DiscoveryTarget - GooglePrivacyDlpV2DataSourceType: - id: GooglePrivacyDlpV2DataSourceType - type: object - description: Message used to identify the type of resource being profiled. - properties: - dataSource: - description: >- - Output only. An identifying string to the type of resource being - profiled. Current values: * google/bigquery/table * google/project * - google/sql/table * google/gcs/bucket - type: string - readOnly: true - GooglePrivacyDlpV2QuasiIdentifierField: - type: object - properties: - customTag: - type: string - description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Identifies the column. - description: >- - A quasi-identifier column has a custom_tag, used to know which column in - the data corresponds to which column in the statistical model. - id: GooglePrivacyDlpV2QuasiIdentifierField - GoogleTypeDate: - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - type: object - id: GoogleTypeDate + GooglePrivacyDlpV2CloudStorageDiscoveryTarget: properties: - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - type: integer - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - type: integer - day: + conditions: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 - type: integer - GooglePrivacyDlpV2LargeCustomDictionaryConfig: - properties: - cloudStorageFileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' + Optional. In addition to matching the filter, these conditions must + be true before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryFileStoreConditions' + disabled: + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + description: Optional. Disable profiling for buckets that match this filter. + filter: description: >- - Set of files containing newline-delimited lists of dictionary - phrases. - outputPath: + Required. The buckets the generation_cadence applies to. The first + target with a matching filter will be the one to apply to a bucket. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageFilter' + generationCadence: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence description: >- - Location to store dictionary artifacts in Cloud Storage. These files - will only be accessible by project owners and the DLP API. If any of - these artifacts are modified, the dictionary is considered invalid - and can no longer be used. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' - bigQueryField: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' + Optional. How often and when to update profiles. New buckets that + match both the filter and conditions are scanned as quickly as + possible depending on system capacity. + id: GooglePrivacyDlpV2CloudStorageDiscoveryTarget + description: Target used to match against for discovery with Cloud Storage buckets. + type: object + GooglePrivacyDlpV2TransformationResultStatus: + properties: + resultStatusType: + enumDescriptions: + - Unused. + - >- + This will be set when a finding could not be transformed (i.e. + outside user set bucket range). + - >- + This will be set when a BigQuery transformation was successful but + could not be stored back in BigQuery because the transformed row + exceeds BigQuery's max row size. + - >- + This will be set when there is a finding in the custom metadata of + a file, but at the write time of the transformed file, this key / + value pair is unretrievable. + - >- + This will be set when the transformation and storing of it is + successful. description: >- - Field in a BigQuery table where each cell represents a dictionary - phrase. + Transformation result status type, this will be either SUCCESS, or + it will be the reason for why the transformation was not completely + successful. + type: string + enum: + - STATE_TYPE_UNSPECIFIED + - INVALID_TRANSFORM + - BIGQUERY_MAX_ROW_SIZE_EXCEEDED + - METADATA_UNRETRIEVABLE + - SUCCESS + details: + description: Detailed error codes and messages + $ref: '#/components/schemas/GoogleRpcStatus' + description: The outcome of a transformation. + id: GooglePrivacyDlpV2TransformationResultStatus type: object - id: GooglePrivacyDlpV2LargeCustomDictionaryConfig - description: >- - Configuration for a custom dictionary created from a data source of any - size up to the maximum size defined in the - [limits](https://cloud.google.com/sensitive-data-protection/limits) - page. The artifacts of dictionary creation are stored in the specified - Cloud Storage location. Consider using `CustomInfoType.Dictionary` for - smaller dictionaries that satisfy the size requirements. - GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: + GooglePrivacyDlpV2Disabled: type: object + description: Do not profile the tables. + id: GooglePrivacyDlpV2Disabled properties: {} - id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog - description: >- - Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag - templates are applied to the resource that Cloud DLP scanned. Data - Catalog tag templates are stored in the same project and region where - the BigQuery table exists. For Cloud DLP to create and apply the tag - template, the Cloud DLP service agent must have the - `roles/datacatalog.tagTemplateOwner` permission on the project. The tag - template contains fields summarizing the results of the DlpJob. Any - field values previously written by another DlpJob are deleted. InfoType - naming patterns are strictly enforced when using this feature. Findings - are persisted in Data Catalog storage and are governed by - service-specific policies for Data Catalog. For more information, see - [Service Specific Terms](https://cloud.google.com/terms/service-terms). - Only a single instance of this action can be specified. This action is - allowed only if all resources being scanned are BigQuery tables. - Compatible with: Inspect - GooglePrivacyDlpV2DatastoreKey: + GooglePrivacyDlpV2FileClusterType: type: object + description: Message used to identify file cluster type being profiled. properties: - entityKey: - description: Datastore entity key. - $ref: '#/components/schemas/GooglePrivacyDlpV2Key' - description: Record key for a finding in Cloud Datastore. - id: GooglePrivacyDlpV2DatastoreKey - GooglePrivacyDlpV2AllOtherResources: + cluster: + enumDescriptions: + - Unused. + - Unsupported files. + - Plain text. + - Structured data like CSV, TSV etc. + - Source code. + - Rich document like docx, xlsx etc. + - Images like jpeg, bmp. + - Archives and containers like .zip, .tar etc. + - Multimedia like .mp4, .avi etc. + - Executable files like .exe, .class, .apk etc. + enum: + - CLUSTER_UNSPECIFIED + - CLUSTER_UNKNOWN + - CLUSTER_TEXT + - CLUSTER_STRUCTURED_DATA + - CLUSTER_SOURCE_CODE + - CLUSTER_RICH_DOCUMENT + - CLUSTER_IMAGE + - CLUSTER_ARCHIVE + - CLUSTER_MULTIMEDIA + - CLUSTER_EXECUTABLE + type: string + description: Cluster type. + id: GooglePrivacyDlpV2FileClusterType + GooglePrivacyDlpV2InspectionRuleSet: + id: GooglePrivacyDlpV2InspectionRuleSet type: object - properties: {} - id: GooglePrivacyDlpV2AllOtherResources - description: Match discovery resources not covered by any other filter. - GooglePrivacyDlpV2BucketingConfig: - id: GooglePrivacyDlpV2BucketingConfig description: >- - Generalization function that buckets values based on ranges. The ranges - and replacement values are dynamically provided by the user for custom - behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can - be used on data of type: number, long, string, timestamp. If the bound - `Value` type differs from the type of data being transformed, we will - first attempt converting the type of the data to be transformed to match - the type of the bound before comparing. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing - to learn more. - type: object + Rule set for modifying a set of infoTypes to alter behavior under + certain circumstances, depending on the specific details of the rules + within the set. properties: - buckets: + infoTypes: + description: List of infoTypes this rule set is applied to. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' - description: Set of buckets. Ranges must be non-overlapping. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + rules: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' type: array - GooglePrivacyDlpV2ContentLocation: - id: GooglePrivacyDlpV2ContentLocation + description: >- + Set of rules to be applied to infoTypes. The rules are applied in + order. + GooglePrivacyDlpV2KMapEstimationConfig: description: >- - Precise location of the finding within a document, record, image, or - metadata container. + Reidentifiability metric. This corresponds to a risk model similar to + what is called "journalist risk" in the literature, except the attack + dataset is statistically modeled instead of being perfectly known. This + can be done using publicly available data (like the US Census), or using + a custom statistical model (indicated as one or several BigQuery + tables), or by extrapolating from the distribution of values in the + input dataset. + id: GooglePrivacyDlpV2KMapEstimationConfig properties: - containerVersion: + regionCode: description: >- - Finding container version, if available ("generation" for Cloud - Storage). + ISO 3166-1 alpha-2 region code to use in the statistical modeling. + Set if no column is tagged with a region-specific InfoType (like + US_ZIP_5) or a region code. type: string - containerName: + quasiIds: + type: array description: >- - Name of the container where the finding is located. The top level - name is the source file name or table name. Names of some common - storage containers are formatted as follows: * BigQuery tables: - `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: - `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested - names could be absent if the embedded object has no string - identifier (for example, an image contained within a document). - type: string - recordLocation: - description: Location within a row or record of a database table. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' - imageLocation: - description: Location within an image's pixels. - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' - containerTimestamp: - type: string + Required. Fields considered to be quasi-identifiers. No two columns + can have the same tag. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' + auxiliaryTables: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' description: >- - Finding container modification timestamp, if applicable. For Cloud - Storage, this field contains the last file modification timestamp. - For a BigQuery table, this field contains the last_modified_time - property. For Datastore, this field isn't populated. - format: google-datetime - documentLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' - description: Location data for document files. - metadataLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' - description: Location within the metadata for inspected content. + Several auxiliary tables can be used in the analysis. Each + custom_tag used to tag a quasi-identifiers column must appear in + exactly one column of one auxiliary table. type: object - GooglePrivacyDlpV2ReidentifyContentRequest: - description: Request to re-identify an item. - id: GooglePrivacyDlpV2ReidentifyContentRequest + GooglePrivacyDlpV2KMapEstimationHistogramBucket: + description: >- + A KMapEstimationHistogramBucket message with the following values: + min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 + records whose quasi-identifier values correspond to 3, 4 or 5 people in + the overlying population. An important particular case is when + min_anonymity = max_anonymity = 1: the frequency field then corresponds + to the number of uniquely identifiable records. type: object + id: GooglePrivacyDlpV2KMapEstimationHistogramBucket properties: - inspectConfig: - description: Configuration for the inspector. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - reidentifyTemplateName: - type: string + bucketValueCount: description: >- - Template to use. References an instance of `DeidentifyTemplate`. Any - configuration directly specified in `reidentify_config` or - `inspect_config` will override those set in the template. The - `DeidentifyTemplate` used must include only reversible - transformations. Singular fields that are set in this request will - replace their corresponding fields in the template. Repeated fields - are appended. Singular sub-messages and groups are recursively - merged. - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The item to re-identify. Will be treated as text. - inspectTemplateName: + Total number of distinct quasi-identifier tuple values in this + bucket. type: string - description: >- - Template to use. Any configuration directly specified in - `inspect_config` will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - reidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - description: >- - Configuration for the re-identification of the content item. This - field shares the same proto message type that is used for - de-identification, however its usage here is for the reversal of the - previous de-identification. Re-identification is performed by - examining the transformations used to de-identify the items and - executing the reverse. This requires that only reversible - transformations be provided here. The reversible transformations - are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` - locationId: - description: Deprecated. This field has no effect. + format: int64 + minAnonymity: + type: string + format: int64 + description: Always positive. + bucketSize: + type: string + description: Number of records within these anonymity bounds. + format: int64 + maxAnonymity: type: string - GooglePrivacyDlpV2DiscoveryFileStoreConditions: + format: int64 + description: Always greater than or equal to min_anonymity. + bucketValues: + description: >- + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationQuasiIdValues' + GooglePrivacyDlpV2CloudStorageRegexFileSet: description: >- - Requirements that must be true before a file store is scanned in - discovery for the first time. There is an AND relationship between the - top-level attributes. - id: GooglePrivacyDlpV2DiscoveryFileStoreConditions + Message representing a set of files in a Cloud Storage bucket. Regular + expressions are used to allow fine-grained control over which files in + the bucket to include. Included files are those that match at least one + item in `include_regex` and do not match any items in `exclude_regex`. + Note that a file that matches items from both lists will _not_ be + included. For a match to occur, the entire file path (i.e., everything + in the url after the bucket name) must match the regular expression. For + example, given the input `{bucket_name: "mybucket", include_regex: + ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * + `gs://mybucket/directory1/myfile` will be included * + `gs://mybucket/directory1/directory2/myfile` will be included (`.*` + matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will + _not_ be included (the full path doesn't match any items in + `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be + included (the path matches an item in `exclude_regex`) If + `include_regex` is left empty, it will match all files by default (this + is equivalent to setting `include_regex: [".*"]`). Some other common use + cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will + include all files in `mybucket` except for .pdf files * `{bucket_name: + "mybucket", include_regex: ["directory/[^/]+"]}` will include all files + directly under `gs://mybucket/directory/`, without matching across `/` type: object properties: - createdAfter: + includeRegex: + items: + type: string description: >- - Optional. File store must have been created after this date. Used to - avoid backfilling. - format: google-datetime + A list of regular expressions matching file paths to include. All + files in the bucket that match at least one of these regular + expressions will be included in the set of files, except for those + that also match an item in `exclude_regex`. Leaving this field empty + will match all files by default (this is equivalent to including + `.*` in the list). Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + type: array + bucketName: + description: The name of a Cloud Storage bucket. Required. type: string - cloudStorageConditions: - description: Optional. Cloud Storage conditions. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageConditions - minAge: + excludeRegex: description: >- - Optional. Minimum age a file store must have. If set, the value must - be 1 hour or greater. - type: string - format: google-duration - GooglePrivacyDlpV2Key: - id: GooglePrivacyDlpV2Key - type: object - description: >- - A unique identifier for a Datastore entity. If a key's partition ID or - any of its path kinds or names are reserved/read-only, the key is - reserved/read-only. A reserved/read-only key is forbidden in certain - documented contexts. - properties: - path: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' + A list of regular expressions matching file paths to exclude. All + files in the bucket that match at least one of these regular + expressions will be excluded from the scan. Regular expressions use + RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can + be found under the google/re2 repository on GitHub. type: array - description: >- - The entity path. An entity path consists of one or more elements - composed of a kind and a string or numerical identifier, which - identify entities. The first element identifies a _root entity_, the - second element identifies a _child_ of the root entity, the third - element identifies a child of the second entity, and so forth. The - entities identified by all prefixes of the path are called the - element's _ancestors_. A path can never be empty, and a path can - have at most 100 elements. - partitionId: - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' - description: >- - Entities are partitioned into subsets, currently identified by a - project ID and namespace ID. Queries are scoped to a single - partition. - GooglePrivacyDlpV2ListColumnDataProfilesResponse: + items: + type: string + id: GooglePrivacyDlpV2CloudStorageRegexFileSet + GooglePrivacyDlpV2ListFileStoreDataProfilesResponse: + description: >- + List of file store data profiles generated for a given organization or + project. properties: nextPageToken: type: string description: The next page token. - columnDataProfiles: - type: array + fileStoreDataProfiles: description: List of data profiles. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - description: List of profiles generated for a given organization or project. - type: object - id: GooglePrivacyDlpV2ListColumnDataProfilesResponse - GooglePrivacyDlpV2FileStoreInfoTypeSummary: - description: Information regarding the discovered InfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + type: array + id: GooglePrivacyDlpV2ListFileStoreDataProfilesResponse type: object + GooglePrivacyDlpV2DataProfilePubSubCondition: properties: - infoType: - description: The InfoType seen. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - id: GooglePrivacyDlpV2FileStoreInfoTypeSummary - GooglePrivacyDlpV2ColumnDataProfile: - id: GooglePrivacyDlpV2ColumnDataProfile + expressions: + description: An expression. + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' + description: A condition for determining whether a Pub/Sub should be triggered. + id: GooglePrivacyDlpV2DataProfilePubSubCondition type: object - description: The profile for a scanned column within a table. + GooglePrivacyDlpV2DataProfileAction: + type: object + id: GooglePrivacyDlpV2DataProfileAction + description: A task to execute when a data profile has been generated. properties: - state: - enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. - description: State of a profile. - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE - type: string - profileStatus: - description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - datasetId: - description: The BigQuery dataset ID. - type: string - column: - description: The name of the column. - type: string - tableDataProfile: - type: string - description: The resource name of the table data profile. - tableFullResource: - type: string - description: The resource name of the resource this column is within. - columnType: - description: The data type of a given column. - enumDescriptions: - - Invalid type. - - Encoded as a string in decimal format. - - Encoded as a boolean "false" or "true". - - Encoded as a number, or string "NaN", "Infinity" or "-Infinity". - - Encoded as a string value. - - Encoded as a base64 string per RFC 4648, section 4. - - >- - Encoded as an RFC 3339 timestamp with mandatory "Z" time zone - string: 1985-04-12T23:20:50.52Z - - 'Encoded as RFC 3339 full-date format string: 1985-04-12' - - 'Encoded as RFC 3339 partial-time format string: 23:20:50.52' - - >- - Encoded as RFC 3339 full-date "T" partial-time: - 1985-04-12T23:20:50.52 - - Encoded as WKT - - Encoded as a decimal string. - - Container of ordered fields, each with a type and field name. - - Decimal type. - - Json type. - - Interval type. - - '`Range` type.' - - '`Range` type.' - - '`Range` type.' - enum: - - COLUMN_DATA_TYPE_UNSPECIFIED - - TYPE_INT64 - - TYPE_BOOL - - TYPE_FLOAT64 - - TYPE_STRING - - TYPE_BYTES - - TYPE_TIMESTAMP - - TYPE_DATE - - TYPE_TIME - - TYPE_DATETIME - - TYPE_GEOGRAPHY - - TYPE_NUMERIC - - TYPE_RECORD - - TYPE_BIGNUMERIC - - TYPE_JSON - - TYPE_INTERVAL - - TYPE_RANGE_DATE - - TYPE_RANGE_DATETIME - - TYPE_RANGE_TIMESTAMP - type: string - datasetLocation: - type: string - description: >- - The BigQuery location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - locations. - columnInfoType: + exportData: + $ref: '#/components/schemas/GooglePrivacyDlpV2Export' + description: Export data profiles into a provided location. + pubSubNotification: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' + description: Publish a message into the Pub/Sub topic. + tagResources: + description: Tags the profiled resources with the specified tag values. + $ref: '#/components/schemas/GooglePrivacyDlpV2TagResources' + publishToScc: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2PublishToSecurityCommandCenter + description: Publishes findings to SCC for each data profile. + publishToChronicle: + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToChronicle' description: >- - If it's been determined this column can be identified as a single - type, this will be set. Otherwise the column either has - unidentifiable content or mixed types. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' - otherMatches: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - description: Other types found within this column. List will be unordered. - type: array - datasetProjectId: - description: The Google Cloud project ID that owns the profiled resource. + Publishes generated data profiles to Google Security Operations. For + more information, see [Use Sensitive Data Protection data in + context-aware + analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + GooglePrivacyDlpV2CloudSqlProperties: + type: object + properties: + maxConnections: + type: integer + format: int32 + description: >- + Required. DLP will limit its connections to max_connections. Must be + 2 or greater. + connectionName: type: string - estimatedUniquenessScore: + description: >- + Optional. Immutable. The Cloud SQL instance for which the connection + is defined. Only one connection per instance is allowed. This can + only be set at creation time, and cannot be updated. It is an error + to use a connection_name from different project or region than the + one that holds the connection. For example, a Connection resource + for Cloud SQL connection_name `project-id:us-central1:sql-instance` + must be created under the parent + `projects/project-id/locations/us-central1` + usernamePassword: + description: A username and password stored in Secret Manager. + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' + cloudSqlIam: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' + description: Built-in IAM authentication (must be configured in Cloud SQL). + databaseEngine: enumDescriptions: - >- - Some columns do not have estimated uniqueness. Possible reasons - include having too few values. - - >- - Low uniqueness, possibly a boolean, enum or similiarly typed - column. - - Medium uniqueness. - - >- - High uniqueness, possibly a column of free text or unique - identifiers. - enum: - - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED - - UNIQUENESS_SCORE_LOW - - UNIQUENESS_SCORE_MEDIUM - - UNIQUENESS_SCORE_HIGH - type: string - description: Approximate uniqueness of the column. - dataRiskLevel: - description: The data risk level for this column. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - policyState: + An engine that is not currently supported by Sensitive Data + Protection. + - Cloud SQL for MySQL instance. + - Cloud SQL for PostgreSQL instance. + description: >- + Required. The database engine used by the Cloud SQL instance that + this connection configures. enum: - - COLUMN_POLICY_STATE_UNSPECIFIED - - COLUMN_POLICY_TAGGED - enumDescriptions: - - No policy tags. - - Column has policy tag applied. - type: string - description: Indicates if a policy tag has been applied to the column. - profileLastGenerated: - description: The last time the profile was generated. + - DATABASE_ENGINE_UNKNOWN + - DATABASE_ENGINE_MYSQL + - DATABASE_ENGINE_POSTGRES type: string - format: google-datetime - estimatedNullPercentage: + description: Cloud SQL connection properties. + id: GooglePrivacyDlpV2CloudSqlProperties + GooglePrivacyDlpV2TimePartConfig: + properties: + partToExtract: + description: The part of the time to keep. enum: - - NULL_PERCENTAGE_LEVEL_UNSPECIFIED - - NULL_PERCENTAGE_VERY_LOW - - NULL_PERCENTAGE_LOW - - NULL_PERCENTAGE_MEDIUM - - NULL_PERCENTAGE_HIGH + - TIME_PART_UNSPECIFIED + - YEAR + - MONTH + - DAY_OF_MONTH + - DAY_OF_WEEK + - WEEK_OF_YEAR + - HOUR_OF_DAY type: string enumDescriptions: - - Unused. - - Very few null entries. - - Some null entries. - - A few null entries. - - A lot of null entries. - description: Approximate percentage of entries being null in the column. - tableId: - description: The BigQuery table ID. - type: string - freeTextScore: + - Unused + - '[0-9999]' + - '[1-12]' + - '[1-31]' + - '[1-7]' + - '[1-53]' + - '[0-23]' + id: GooglePrivacyDlpV2TimePartConfig + description: >- + For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a + portion of the value. + type: object + GooglePrivacyDlpV2Color: + properties: + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float type: number - format: double - description: >- - The likelihood that this column contains free-form text. A value - close to 1 may indicate the column is likely to contain free-form or - natural language text. Range in 0-1. - name: - type: string - description: The name of the profile. - sensitivityScore: - description: The sensitivity of this column. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - GooglePrivacyDlpV2DatabaseResourceReference: + green: + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + red: + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + format: float + type: object + description: Represents a color in the RGB color space. + id: GooglePrivacyDlpV2Color + GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: + description: Request message for UpdateDeidentifyTemplate. + id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest type: object properties: - databaseResource: + updateMask: type: string + format: google-fieldmask + description: Mask to control which fields get updated. + deidentifyTemplate: + description: New DeidentifyTemplate value. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + GooglePrivacyDlpV2TagValue: + description: A value of a tag. + properties: + namespacedValue: description: >- - Required. Name of a database resource, for example, a table within - the database. - projectId: + The namespaced name for the tag value to attach to resources. Must + be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, + for example, "123456/environment/prod". type: string + type: object + id: GooglePrivacyDlpV2TagValue + GooglePrivacyDlpV2BigQueryDiscoveryTarget: + type: object + description: Target used to match against for discovery with BigQuery tables + id: GooglePrivacyDlpV2BigQueryDiscoveryTarget + properties: + cadence: description: >- - Required. If within a project-level config, then this must match the - config's project ID. - database: + How often and when to update profiles. New tables that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryGenerationCadence' + conditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' + description: >- + In addition to matching the filter, these conditions must be true + before a profile is generated. + filter: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' + description: >- + Required. The tables the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a table. + disabled: + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + description: Tables that match this filter will not have profiles created. + GooglePrivacyDlpV2StoredInfoTypeStats: + type: object + id: GooglePrivacyDlpV2StoredInfoTypeStats + description: Statistics for a StoredInfoType. + properties: + largeCustomDictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' + description: >- + StoredInfoType where findings are defined by a dictionary of + phrases. + GooglePrivacyDlpV2QuasiIdField: + type: object + description: >- + A quasi-identifier column has a custom_tag, used to know which column in + the data corresponds to which column in the statistical model. + id: GooglePrivacyDlpV2QuasiIdField + properties: + customTag: type: string - description: Required. Name of a database within the instance. - instance: + description: A auxiliary field. + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Identifies the column. + GooglePrivacyDlpV2TransformationErrorHandling: + description: >- + How to handle transformation errors during de-identification. A + transformation error occurs when the requested transformation is + incompatible with the data. For example, trying to de-identify an IP + address using a `DateShift` transformation would result in a + transformation error, since date info cannot be extracted from an IP + address. Information about any incompatible transformations, and how + they were handled, is returned in the response as part of the + `TransformationOverviews`. + id: GooglePrivacyDlpV2TransformationErrorHandling + type: object + properties: + throwError: + $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' + description: Throw an error + leaveUntransformed: + $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' + description: Ignore errors + GooglePrivacyDlpV2LeaveUntransformed: + id: GooglePrivacyDlpV2LeaveUntransformed + description: >- + Skips the data without modifying it if the requested transformation + would cause an error. For example, if a `DateShift` transformation were + applied an an IP address, this mode would leave the IP address unchanged + in the response. + properties: {} + type: object + GooglePrivacyDlpV2LikelihoodAdjustment: + type: object + description: >- + Message for specifying an adjustment to the likelihood of a finding as + part of a detection rule. + id: GooglePrivacyDlpV2LikelihoodAdjustment + properties: + relativeLikelihood: + type: integer + format: int32 + description: >- + Increase or decrease the likelihood by the specified number of + levels. For example, if a finding would be `POSSIBLE` without the + detection rule and `relative_likelihood` is 1, then it is upgraded + to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. + Likelihood may never drop below `VERY_UNLIKELY` or exceed + `VERY_LIKELY`, so applying an adjustment of 1 followed by an + adjustment of -1 when base likelihood is `VERY_LIKELY` will result + in a final likelihood of `LIKELY`. + fixedLikelihood: + description: Set the likelihood of a finding to a fixed value. + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. type: string - description: >- - Required. The instance where this resource is located. For example: - Cloud SQL instance ID. - id: GooglePrivacyDlpV2DatabaseResourceReference - description: Identifies a single database resource, like a table within a database. - GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY + GooglePrivacyDlpV2ImageTransformations: + description: A type of transformation that is applied over images. + id: GooglePrivacyDlpV2ImageTransformations + type: object properties: - nextPageToken: - type: string - description: >- - If the next page is available then the next page token to be used in - the following ListDeidentifyTemplates request. - deidentifyTemplates: - type: array + transforms: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: >- - List of deidentify templates, up to page_size in - ListDeidentifyTemplatesRequest. - type: object - id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse - description: Response message for ListDeidentifyTemplates. - GooglePrivacyDlpV2AllOtherBigQueryTables: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' + description: List of transforms to make. + type: array + GooglePrivacyDlpV2HybridInspectResponse: + id: GooglePrivacyDlpV2HybridInspectResponse + description: Quota exceeded errors will be thrown once quota has been met. type: object properties: {} + GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence: + id: GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + properties: + frequency: + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + description: >- + How frequently data profiles can be updated when the template is + modified. Defaults to never. + type: string description: >- - Catch-all for all other tables not specified by other filters. Should - always be last, except for single-table configurations, which will only - have a TableReference target. - id: GooglePrivacyDlpV2AllOtherBigQueryTables - GooglePrivacyDlpV2DatastoreOptions: - description: Options defining a data set within Google Cloud Datastore. + The cadence at which to update data profiles when the inspection rules + defined by the `InspectTemplate` change. type: object + GooglePrivacyDlpV2BigQueryTableCollection: + id: GooglePrivacyDlpV2BigQueryTableCollection properties: - kind: - $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' - description: The kind to process. - partitionId: + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' description: >- - A partition ID identifies a grouping of entities. The grouping is - always by project and namespace, however the namespace ID may be - empty. - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' - id: GooglePrivacyDlpV2DatastoreOptions - GooglePrivacyDlpV2PathElement: + A collection of regular expressions to match a BigQuery table + against. + type: object + description: Specifies a collection of BigQuery tables. Used for Discovery. + GooglePrivacyDlpV2Trigger: + type: object + description: What event needs to occur for a new job to be started. properties: - id: - type: string - format: int64 - description: >- - The auto-allocated ID of the entity. Never equal to zero. Values - less than zero are discouraged and may not be supported in the - future. - name: - type: string - description: >- - The name of the entity. A name matching regex `__.*__` is - reserved/read-only. A name must not be more than 1500 bytes when - UTF-8 encoded. Cannot be `""`. - kind: + schedule: + $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' + description: Create a job on a repeating basis based on the elapse of time. + manual: + $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' description: >- - The kind of the entity. A kind matching regex `__.*__` is - reserved/read-only. A kind must not contain more than 1500 bytes - when UTF-8 encoded. Cannot be `""`. - type: string - id: GooglePrivacyDlpV2PathElement + For use with hybrid jobs. Jobs must be manually created and + finished. + id: GooglePrivacyDlpV2Trigger + GooglePrivacyDlpV2PublishToStackdriver: description: >- - A (kind, ID/name) pair used to construct a key path. If either name or - ID is set, the element is complete. If neither is set, the element is - incomplete. + Enable Stackdriver metric dlp.googleapis.com/finding_count. This will + publish a metric to stack driver on each infotype requested and how many + findings were found for it. CustomDetectors will be bucketed as 'Custom' + under the Stackdriver label 'info_type'. + properties: {} + id: GooglePrivacyDlpV2PublishToStackdriver type: object - GooglePrivacyDlpV2InfoType: + GooglePrivacyDlpV2DiscoveryBigQueryConditions: properties: - version: - description: Optional version name for this InfoType. - type: string - name: + orConditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' description: >- - Name of the information type. Either a name of your choosing when - creating a CustomInfoType, or one of the names listed at - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference - when specifying a built-in type. When sending Cloud DLP results to - Data Catalog, infoType names should conform to the pattern - `[A-Za-z0-9$_-]{1,64}`. + At least one of the conditions must be true for a table to be + scanned. + typeCollection: + type: string + description: Restrict discovery to categories of table types. + enum: + - BIG_QUERY_COLLECTION_UNSPECIFIED + - BIG_QUERY_COLLECTION_ALL_TYPES + - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES + enumDescriptions: + - Unused. + - >- + Automatically generate profiles for all tables, even if the table + type is not yet fully supported for analysis. Profiles for + unsupported tables will be generated with errors to indicate their + partial support. When full support is added, the tables will + automatically be profiled during the next scheduled run. + - >- + Only those types fully supported will be profiled. Will expand + automatically as Cloud DLP adds support for new table types. + Unsupported table types will not have partial profiles generated. + types: + description: Restrict discovery to specific table types. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' + createdAfter: + format: google-datetime type: string - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' description: >- - Optional custom sensitivity for this InfoType. This only applies to - data profiling. + BigQuery table must have been created after this date. Used to avoid + backfilling. + id: GooglePrivacyDlpV2DiscoveryBigQueryConditions type: object - description: Type of information detected by the API. - id: GooglePrivacyDlpV2InfoType - GooglePrivacyDlpV2RedactImageRequest: + description: >- + Requirements that must be true before a table is scanned in discovery + for the first time. There is an AND relationship between the top-level + attributes. Additionally, minimum conditions with an OR relationship + that must be met before Cloud DLP scans a table can be set (like a + minimum row count or a minimum table age). + GooglePrivacyDlpV2PublishToSecurityCommandCenter: + id: GooglePrivacyDlpV2PublishToSecurityCommandCenter type: object + properties: {} description: >- - Request to search for potentially sensitive info in an image and redact - it by covering it with a colored rectangle. + If set, a summary finding will be created/updated in SCC for each + profile. + GooglePrivacyDlpV2AuxiliaryTable: + id: GooglePrivacyDlpV2AuxiliaryTable + description: >- + An auxiliary table contains statistical information on the relative + frequency of different quasi-identifiers values. It has one or several + quasi-identifiers columns, and one column that indicates the relative + frequency of each quasi-identifier tuple. If a tuple is present in the + data but not in the auxiliary table, the corresponding relative + frequency is assumed to be zero (and thus, the tuple is highly + reidentifiable). properties: - imageRedactionConfigs: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' - description: The configuration for specifying what content to redact from images. + quasiIds: type: array - locationId: - description: Deprecated. This field has no effect. - type: string - byteItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' - description: The content must be PNG, JPEG, SVG or BMP. - includeFindings: - type: boolean + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' + description: Required. Quasi-identifier columns. + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Required. Auxiliary table location. + relativeFrequency: description: >- - Whether the response should include findings along with the redacted - image. - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: Configuration for the inspector. - id: GooglePrivacyDlpV2RedactImageRequest - GooglePrivacyDlpV2RecordTransformation: - id: GooglePrivacyDlpV2RecordTransformation - properties: - containerVersion: - type: string - description: Container version, if available ("generation" for Cloud Storage). - fieldId: - description: For record transformations, provide a field. + Required. The relative frequency column must contain a + floating-point number between 0 and 1 (inclusive). Null values are + assumed to be zero. $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - containerTimestamp: - format: google-datetime - type: string - description: Findings container modification timestamp, if applicable. - description: The field in a record to transform. type: object + GooglePrivacyDlpV2Location: + type: object + properties: + contentLocations: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' + description: >- + List of nested objects pointing to the precise location of the + finding within the file or record. + type: array + byteRange: + description: >- + Zero-based byte offsets delimiting the finding. These are relative + to the finding's containing element. Note that when the content is + not textual, this references the UTF-8 encoded textual + representation of the content. Omitted if content is an image. + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + container: + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' + description: >- + Information about the container where this finding occurred, if + available. + codepointRange: + description: >- + Unicode character offsets delimiting the finding. These are relative + to the finding's containing element. Provided when the content is + text. + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + description: Specifies the location of the finding. + id: GooglePrivacyDlpV2Location parameters: + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + 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. + in: query + name: key + schema: + type: string alt: description: Data format for response. in: query @@ -7726,28 +7741,25 @@ components: - json - media - proto - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: oauth_token + name: quotaUser schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string _.xgafv: @@ -7759,218 +7771,89 @@ components: enum: - '1' - '2' - 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. - in: query - name: key - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: quotaUser + name: upload_protocol schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + callback: + description: JSONP in: query - name: fields + name: callback schema: type: string x-stackQL-resources: - info_types: - id: google.dlp.info_types - name: info_types - title: Info_types + image: + id: google.dlp.image + name: image + title: Image methods: - info_types_list: + projects_image_redact: operation: - $ref: '#/paths/~1v2~1infoTypes/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' response: mediaType: application/json openAPIDocKey: '200' - locations_info_types_list: + projects_locations_image_redact: operation: - $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/info_types/methods/locations_info_types_list - - $ref: >- - #/components/x-stackQL-resources/info_types/methods/info_types_list + select: [] insert: [] update: [] replace: [] delete: [] - connections: - id: google.dlp.connections - name: connections - title: Connections - methods: - projects_locations_connections_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_patch: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_search: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_list: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_connections_list: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.connections - organizations_locations_connections_create: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_connections_delete: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_connections_get: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_connections_patch: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_connections_search: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get - - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_get - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_list - insert: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create - - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_create - update: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch - - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete - - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_delete dlp_jobs: id: google.dlp.dlp_jobs name: dlp_jobs title: Dlp_jobs methods: - projects_locations_dlp_jobs_hybrid_inspect: + projects_dlp_jobs_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_list: + projects_dlp_jobs_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - projects_locations_dlp_jobs_create: + projects_dlp_jobs_cancel: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post + #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_delete: + projects_dlp_jobs_delete: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_get: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -7981,10 +7864,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_cancel: + projects_locations_dlp_jobs_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -7995,38 +7878,35 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_dlp_jobs_get: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_dlp_jobs_delete: + projects_locations_dlp_jobs_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/delete' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post response: mediaType: application/json openAPIDocKey: '200' - projects_dlp_jobs_cancel: + projects_locations_dlp_jobs_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get response: mediaType: application/json openAPIDocKey: '200' - projects_dlp_jobs_create: + objectKey: $.jobs + projects_locations_dlp_jobs_cancel: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - projects_dlp_jobs_list: + projects_locations_dlp_jobs_hybrid_inspect: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobs organizations_locations_dlp_jobs_list: operation: $ref: >- @@ -8039,10 +7919,10 @@ components: select: - $ref: >- #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_get - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_list - $ref: >- #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_get + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_list - $ref: >- #/components/x-stackQL-resources/dlp_jobs/methods/organizations_locations_dlp_jobs_list - $ref: >- @@ -8059,930 +7939,919 @@ components: #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_delete - $ref: >- #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_delete - job_triggers: - id: google.dlp.job_triggers - name: job_triggers - title: Job_triggers + deidentify_templates: + id: google.dlp.deidentify_templates + name: deidentify_templates + title: Deidentify_templates methods: - projects_locations_job_triggers_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_job_triggers_list: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_locations_job_triggers_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_job_triggers_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_job_triggers_patch: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_job_triggers_hybrid_inspect: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:hybridInspect/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_job_triggers_activate: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:activate/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_job_triggers_delete: + projects_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_get: + projects_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_patch: + projects_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_job_triggers_create: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_list: + projects_deidentify_templates_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_job_triggers_activate: + objectKey: $.deidentifyTemplates + projects_deidentify_templates_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_patch: + projects_locations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_delete: + projects_locations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_get: + projects_locations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_create: + projects_locations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_list: + objectKey: $.deidentifyTemplates + projects_locations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_get - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_get - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_list - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_get - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_list - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_list - insert: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_create - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_create - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_create - update: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_patch - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_patch - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_delete - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_delete - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_delete - discovery_configs: - id: google.dlp.discovery_configs - name: discovery_configs - title: Discovery_configs - methods: - projects_locations_discovery_configs_list: + organizations_locations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.discoveryConfigs - projects_locations_discovery_configs_create: + organizations_locations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_get: + organizations_locations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_patch: + organizations_locations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_delete: + objectKey: $.deidentifyTemplates + organizations_locations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_create: + organizations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_list: + organizations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.discoveryConfigs - organizations_locations_discovery_configs_delete: + organizations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_patch: + organizations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_get: + organizations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.deidentifyTemplates sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_list + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_list + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_get + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_list + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_list insert: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_create - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_create + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_create + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_create update: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_patch + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_patch + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_patch - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_patch + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_patch + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_delete - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete - deidentify_templates: - id: google.dlp.deidentify_templates - name: deidentify_templates - title: Deidentify_templates + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_delete + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_delete + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_delete + job_triggers: + id: google.dlp.job_triggers + name: job_triggers + title: Job_triggers methods: - projects_locations_deidentify_templates_get: + projects_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_patch: + projects_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_delete: + projects_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_create: + projects_job_triggers_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_list: + objectKey: $.jobTriggers + projects_job_triggers_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - projects_deidentify_templates_get: + projects_job_triggers_activate: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_patch: + projects_locations_job_triggers_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/get response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_delete: + objectKey: $.jobTriggers + projects_locations_job_triggers_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_deidentify_templates_list: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - projects_deidentify_templates_create: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_list: + projects_locations_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - organizations_locations_deidentify_templates_create: + projects_locations_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_get: + projects_locations_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_delete: + projects_locations_job_triggers_hybrid_inspect: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:hybridInspect/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_patch: + projects_locations_job_triggers_activate: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_delete: + organizations_locations_job_triggers_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_patch: + objectKey: $.jobTriggers + organizations_locations_job_triggers_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_get: + organizations_locations_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_create: + organizations_locations_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_list: + organizations_locations_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_get - - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_get - - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_list + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_get + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_list + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_get + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_list - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_list + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_list - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_list + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_list insert: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_create - - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_create + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_create - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_create + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_create - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_create + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_create update: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_patch - - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_patch + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_patch - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_patch + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_patch - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_patch + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_delete - - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_delete + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_delete - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_delete + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_delete - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_delete - image: - id: google.dlp.image - name: image - title: Image + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_delete + stored_info_types: + id: google.dlp.stored_info_types + name: stored_info_types + title: Stored_info_types methods: - projects_locations_image_redact: + projects_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_image_redact: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - inspect_templates: - id: google.dlp.inspect_templates - name: inspect_templates - title: Inspect_templates - methods: - projects_locations_inspect_templates_patch: + projects_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_get: + projects_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_delete: + projects_stored_info_types_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_create: + projects_stored_info_types_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_list: + objectKey: $.storedInfoTypes + projects_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.inspectTemplates - projects_inspect_templates_create: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/post' + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_list: + projects_locations_stored_info_types_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - projects_inspect_templates_get: + projects_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_delete: + projects_locations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_patch: + projects_locations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_patch: + objectKey: $.storedInfoTypes + organizations_locations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_get: + organizations_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_delete: + organizations_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_create: + organizations_locations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_list: + organizations_locations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_inspect_templates_list: + objectKey: $.storedInfoTypes + organizations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_inspect_templates_create: + organizations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_get: + organizations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_delete: + organizations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_patch: + organizations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.storedInfoTypes sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_get + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_get + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_list + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_get + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_list + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_get + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_list + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_list + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_list insert: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_create + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_create - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_create + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_create - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_create + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_create - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_create + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_create update: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_patch + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_patch + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_patch + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_patch + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_delete + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_delete + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_delete - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_delete + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_delete - content: - id: google.dlp.content - name: content - title: Content + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete + connections: + id: google.dlp.connections + name: connections + title: Connections methods: - projects_locations_content_inspect: + projects_locations_connections_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_deidentify: + projects_locations_connections_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_reidentify: + projects_locations_connections_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_content_deidentify: + projects_locations_connections_search: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get response: mediaType: application/json openAPIDocKey: '200' - projects_content_reidentify: + projects_locations_connections_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_content_inspect: + objectKey: $.connections + projects_locations_connections_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_create: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + organizations_locations_connections_search: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: [] + select: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_get + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_list + insert: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_create + update: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_patch replace: [] - delete: [] - stored_info_types: - id: google.dlp.stored_info_types - name: stored_info_types - title: Stored_info_types + delete: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_delete + inspect_templates: + id: google.dlp.inspect_templates + name: inspect_templates + title: Inspect_templates methods: - projects_locations_stored_info_types_patch: + projects_locations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_delete: + objectKey: $.inspectTemplates + projects_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_get: + projects_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_list: + projects_locations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - projects_locations_stored_info_types_create: + projects_locations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_get: + projects_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_delete: + projects_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_patch: + projects_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_create: + projects_inspect_templates_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/post' response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_list: + projects_inspect_templates_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_stored_info_types_patch: + objectKey: $.inspectTemplates + organizations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_get: + organizations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_delete: + organizations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_list: + organizations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_stored_info_types_create: + organizations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_get: + objectKey: $.inspectTemplates + organizations_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_delete: + organizations_locations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_patch: + objectKey: $.inspectTemplates + organizations_locations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_create: + organizations_locations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_list: + organizations_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_get + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_get + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_list + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_list insert: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_create + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_create + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_create + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_create + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_create update: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_patch + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_patch + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_patch + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_patch + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_delete + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_delete + column_data_profiles: + id: google.dlp.column_data_profiles + name: column_data_profiles + title: Column_data_profiles + methods: + projects_locations_column_data_profiles_list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.columnDataProfiles + projects_locations_column_data_profiles_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_column_data_profiles_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_column_data_profiles_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.columnDataProfiles + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_list + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_list + insert: [] + update: [] + replace: [] + delete: [] project_data_profiles: id: google.dlp.project_data_profiles name: project_data_profiles @@ -9032,210 +8901,471 @@ components: update: [] replace: [] delete: [] - file_store_data_profiles: - id: google.dlp.file_store_data_profiles - name: file_store_data_profiles - title: File_store_data_profiles + content: + id: google.dlp.content + name: content + title: Content methods: - projects_locations_file_store_data_profiles_list: + projects_locations_content_inspect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.fileStoreDataProfiles - projects_locations_file_store_data_profiles_get: + projects_locations_content_deidentify: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_file_store_data_profiles_delete: + projects_locations_content_reidentify: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_file_store_data_profiles_list: + projects_content_reidentify: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_content_inspect: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_content_deidentify: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + discovery_configs: + id: google.dlp.discovery_configs + name: discovery_configs + title: Discovery_configs + methods: + projects_locations_discovery_configs_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.fileStoreDataProfiles - organizations_locations_file_store_data_profiles_get: + projects_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_file_store_data_profiles_delete: + projects_locations_discovery_configs_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_discovery_configs_list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.discoveryConfigs + projects_locations_discovery_configs_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_discovery_configs_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_discovery_configs_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_discovery_configs_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_discovery_configs_create: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_discovery_configs_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.discoveryConfigs sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_get + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_get + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_list + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_list - insert: [] - update: [] + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_patch + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_delete + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_delete - column_data_profiles: - id: google.dlp.column_data_profiles - name: column_data_profiles - title: Column_data_profiles + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete + table_data_profiles: + id: google.dlp.table_data_profiles + name: table_data_profiles + title: Table_data_profiles methods: - projects_locations_column_data_profiles_get: + projects_locations_table_data_profiles_delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_table_data_profiles_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_table_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_column_data_profiles_list: + objectKey: $.tableDataProfiles + organizations_locations_table_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.columnDataProfiles - organizations_locations_column_data_profiles_get: + organizations_locations_table_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_column_data_profiles_list: + organizations_locations_table_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.columnDataProfiles + objectKey: $.tableDataProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_get + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_get + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_list + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_list + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list insert: [] update: [] replace: [] - delete: [] - table_data_profiles: - id: google.dlp.table_data_profiles - name: table_data_profiles - title: Table_data_profiles + delete: + - $ref: >- + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete + - $ref: >- + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete + file_store_data_profiles: + id: google.dlp.file_store_data_profiles + name: file_store_data_profiles + title: File_store_data_profiles methods: - projects_locations_table_data_profiles_get: + projects_locations_file_store_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_table_data_profiles_delete: + objectKey: $.fileStoreDataProfiles + projects_locations_file_store_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_table_data_profiles_list: + projects_locations_file_store_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles - organizations_locations_table_data_profiles_get: + organizations_locations_file_store_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_table_data_profiles_delete: + organizations_locations_file_store_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_table_data_profiles_list: + organizations_locations_file_store_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles + objectKey: $.fileStoreDataProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_list - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_list insert: [] update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_delete - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_delete + info_types: + id: google.dlp.info_types + name: info_types + title: Info_types + methods: + locations_info_types_list: + operation: + $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + info_types_list: + operation: + $ref: '#/paths/~1v2~1infoTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/info_types/methods/locations_info_types_list + - $ref: >- + #/components/x-stackQL-resources/info_types/methods/info_types_list + insert: [] + update: [] + replace: [] + delete: [] paths: - /v2/infoTypes: + /v2/projects/{projectsId}/image:redact: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' + post: + description: >- + Redacts potentially sensitive info from an image. This method has limits + on input size, processing time, and output size. See + https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.image.redact + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v2/projects/{projectsId}/dlpJobs: + parameters: *ref_1 + post: + description: >- + Creates a new job to inspect storage or calculate risk metrics. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. When no InfoTypes or CustomInfoTypes are specified in + inspect jobs, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.dlpJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string get: description: >- - Returns a list of the sensitive information types that DLP API supports. + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.dlpJobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: type + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running DlpJob. The server + makes a best effort to cancel the DlpJob, but success is not guaranteed. See - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.infoTypes.list + operationId: dlp.projects.dlpJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9247,33 +9377,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - - in: query - name: filter - schema: - type: string - - in: query - name: parent - schema: - type: string - - in: query - name: languageCode + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: locationId + - in: path + name: dlpJobsId + required: true schema: type: string - /v2/locations/{locationsId}/infoTypes: + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: parameters: *ref_1 - get: + delete: description: >- - Returns a list of the sensitive information types that DLP API supports. - See - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + Deletes a long-running DlpJob. This method indicates that the client is + no longer interested in the DlpJob result. The job will be canceled if + possible. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.locations.infoTypes.list + operationId: dlp.projects.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9285,30 +9412,57 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: locationsId + name: projectsId required: true schema: type: string - - in: query - name: locationId + - in: path + name: dlpJobsId + required: true schema: type: string - - in: query - name: filter + get: + description: >- + Gets the latest state of a long-running DlpJob. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.dlpJobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: languageCode + - in: path + name: dlpJobsId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_1 - delete: - description: Delete a Connection. - operationId: dlp.projects.locations.connections.delete + get: + description: >- + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9320,7 +9474,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -9328,23 +9482,16 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: connectionsId + name: deidentifyTemplatesId required: true schema: type: string - patch: - description: Update a Connection. - operationId: dlp.projects.locations.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' + delete: + description: >- + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9356,7 +9503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9364,18 +9511,22 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: connectionsId + name: deidentifyTemplatesId required: true schema: type: string - get: - description: Get a Connection by name. - operationId: dlp.projects.locations.connections.get + patch: + description: >- + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9387,7 +9538,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -9395,20 +9546,18 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: connectionsId + name: deidentifyTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:search: + /v2/projects/{projectsId}/deidentifyTemplates: parameters: *ref_1 get: - description: Searches for Connections in a parent. - operationId: dlp.projects.locations.connections.search + description: >- + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9421,20 +9570,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: query - name: filter + name: orderBy schema: type: string - in: query @@ -9446,13 +9590,23 @@ paths: name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_1 - get: + - in: query + name: locationId + schema: + type: string + post: description: >- - Lists Connections in a parent. Use SearchConnections to see all - connections within an organization. - operationId: dlp.projects.locations.connections.list + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9464,39 +9618,55 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId required: true schema: type: string + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_1 + get: + description: >- + Gets a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + parameters: - in: path - name: locationsId + name: projectsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: jobTriggersId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Create a Connection to an external data source. - operationId: dlp.projects.locations.connections.create + patch: + description: >- + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9508,31 +9678,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: - parameters: *ref_1 - post: - description: >- - Inspect hybrid content and store findings to a job. To review the - findings, inspect the job. Inspection will occur asynchronously. - operationId: dlp.projects.locations.dlpJobs.hybridInspect - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest + - in: path + name: jobTriggersId + required: true + schema: + type: string + delete: + description: >- + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9544,7 +9707,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9552,25 +9715,18 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dlpJobsId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs: + /v2/projects/{projectsId}/jobTriggers: parameters: *ref_1 get: description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.locations.dlpJobs.list + operationId: dlp.projects.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9582,25 +9738,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query - name: filter + name: type schema: type: string - in: query @@ -9608,33 +9758,30 @@ paths: schema: type: string - in: query - name: type + name: pageToken schema: type: string - in: query - name: orderBy + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: pageToken + name: orderBy schema: type: string post: description: >- - Creates a new job to inspect storage or calculate risk metrics. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. When no InfoTypes or CustomInfoTypes are specified in - inspect jobs, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.dlpJobs.create + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9646,30 +9793,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: parameters: *ref_1 - delete: + post: description: >- - Deletes a long-running DlpJob. This method indicates that the client is - no longer interested in the DlpJob result. The job will be canceled if - possible. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.locations.dlpJobs.delete + Activate a job trigger. Causes the immediate execute of a trigger + instead of waiting on the trigger event to occur. + operationId: dlp.projects.jobTriggers.activate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9681,7 +9823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -9689,23 +9831,18 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dlpJobsId + name: jobTriggersId required: true schema: type: string - get: + /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_1 + delete: description: >- - Gets the latest state of a long-running DlpJob. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.locations.dlpJobs.get + operationId: dlp.projects.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9717,7 +9854,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9725,32 +9862,16 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dlpJobsId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: - parameters: *ref_1 - post: + get: description: >- - Starts asynchronous cancellation on a long-running DlpJob. The server - makes a best effort to cancel the DlpJob, but success is not guaranteed. - See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.locations.dlpJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' + operationId: dlp.projects.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9762,7 +9883,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -9770,27 +9891,23 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dlpJobsId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: - parameters: *ref_1 - post: + patch: description: >- - Finish a running hybrid DlpJob. Triggers the finalization steps and - running of any enabled actions that have not yet run. - operationId: dlp.projects.locations.dlpJobs.finish + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.storedInfoTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FinishDlpJobRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9802,7 +9919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -9810,29 +9927,24 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dlpJobsId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: + /v2/projects/{projectsId}/storedInfoTypes: parameters: *ref_1 post: description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.locations.jobTriggers.create + operationId: dlp.projects.storedInfoTypes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9844,24 +9956,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string get: description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.locations.jobTriggers.list + operationId: dlp.projects.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9873,85 +9980,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: type - schema: - type: string - in: query name: pageToken schema: type: string - - in: query - name: orderBy - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: - parameters: *ref_1 - delete: - description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: locationId schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + parameters: *ref_1 get: - description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.get + description: Get a Connection by name. + operationId: dlp.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9963,7 +10021,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: projectsId @@ -9976,21 +10034,18 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: connectionsId required: true schema: type: string patch: - description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.patch + description: Update a Connection. + operationId: dlp.projects.locations.connections.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10002,7 +10057,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: projectsId @@ -10015,24 +10070,13 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: connectionsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect: - parameters: *ref_1 - post: - description: >- - Inspect hybrid content and store findings to a trigger. The inspection - will be processed asynchronously. To review the findings monitor the - jobs within the trigger. - operationId: dlp.projects.locations.jobTriggers.hybridInspect - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2HybridInspectJobTriggerRequest + delete: + description: Delete a Connection. + operationId: dlp.projects.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10044,7 +10088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10057,22 +10101,15 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: connectionsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate: + /v2/projects/{projectsId}/locations/{locationsId}/connections:search: parameters: *ref_1 - post: - description: >- - Activate a job trigger. Causes the immediate execute of a trigger - instead of waiting on the trigger event to occur. - operationId: dlp.projects.locations.jobTriggers.activate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' + get: + description: Searches for Connections in a parent. + operationId: dlp.projects.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10084,7 +10121,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path name: projectsId @@ -10096,16 +10134,26 @@ paths: required: true schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections: parameters: *ref_1 get: - description: Lists discovery configurations. - operationId: dlp.projects.locations.discoveryConfigs.list + description: >- + Lists Connections in a parent. Use SearchConnections to see all + connections within an organization. + operationId: dlp.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10117,8 +10165,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' parameters: - in: path name: projectsId @@ -10135,7 +10182,7 @@ paths: schema: type: string - in: query - name: orderBy + name: filter schema: type: string - in: query @@ -10144,14 +10191,13 @@ paths: type: integer format: int32 post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.projects.locations.discoveryConfigs.create + description: Create a Connection to an external data source. + operationId: dlp.projects.locations.connections.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10163,7 +10209,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: projectsId @@ -10175,11 +10221,14 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: parameters: *ref_1 get: - description: Gets a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.get + description: >- + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10191,7 +10240,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: projectsId @@ -10203,20 +10253,36 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - in: query + name: orderBy schema: type: string - patch: - description: Updates a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.patch + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10228,7 +10294,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + parameters: *ref_1 + delete: + description: >- + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10241,13 +10338,16 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: inspectTemplatesId required: true schema: type: string - delete: - description: Deletes a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.delete + get: + description: >- + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10259,7 +10359,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -10272,18 +10372,22 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: inspectTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: - parameters: *ref_1 - get: + patch: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.get + operationId: dlp.projects.locations.inspectTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10295,7 +10399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -10308,10 +10412,12 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + parameters: *ref_1 patch: description: >- Updates the DeidentifyTemplate. See @@ -10352,12 +10458,12 @@ paths: required: true schema: type: string - delete: + get: description: >- - Deletes a DeidentifyTemplate. See + Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.delete + operationId: dlp.projects.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10369,7 +10475,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -10386,21 +10492,12 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: - parameters: *ref_1 - post: + delete: description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See + Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + operationId: dlp.projects.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10412,7 +10509,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10424,6 +10521,13 @@ paths: required: true schema: type: string + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: + parameters: *ref_1 get: description: >- Lists DeidentifyTemplates. See @@ -10455,11 +10559,11 @@ paths: schema: type: string - in: query - name: orderBy + name: locationId schema: type: string - in: query - name: locationId + name: pageToken schema: type: string - in: query @@ -10468,26 +10572,22 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: orderBy schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/image:redact: - parameters: *ref_1 post: description: >- - Redacts potentially sensitive info from an image. This method has limits - on input size, processing time, and output size. See - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.image.redact + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.locations.deidentifyTemplates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10499,7 +10599,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -10511,20 +10611,23 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + /v2/projects/{projectsId}/locations/{locationsId}/image:redact: parameters: *ref_1 - patch: + post: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.patch + Redacts potentially sensitive info from an image. This method has limits + on input size, processing time, and output size. See + https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.image.redact requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10536,7 +10639,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' parameters: - in: path name: projectsId @@ -10548,17 +10651,11 @@ paths: required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true - schema: - type: string + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: + parameters: *ref_1 get: - description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.get + description: Lists column data profiles for an organization. + operationId: dlp.projects.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10570,7 +10667,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path name: projectsId @@ -10582,17 +10680,28 @@ paths: required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true + - in: query + name: filter schema: type: string - delete: - description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.delete + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a column data profile. + operationId: dlp.projects.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10604,7 +10713,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path name: projectsId @@ -10617,25 +10726,20 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: columnDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: parameters: *ref_1 - post: + get: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets the latest state of a long-running DlpJob. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.inspectTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + operationId: dlp.projects.locations.dlpJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10647,7 +10751,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -10659,12 +10763,21 @@ paths: required: true schema: type: string - get: + - in: path + name: dlpJobsId + required: true + schema: + type: string + delete: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a long-running DlpJob. This method indicates that the client is + no longer interested in the DlpJob result. The job will be canceled if + possible. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.inspectTemplates.list + operationId: dlp.projects.locations.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10676,8 +10789,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10689,42 +10801,23 @@ paths: required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: dlpJobsId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: parameters: *ref_1 post: description: >- - Finds potentially sensitive info in content. This method has limits on - input size, processing time, and output size. When no InfoTypes or - CustomInfoTypes are specified in this request, the system will - automatically choose what detectors to run. By default this may be all - types, but may change over time as detectors are updated. For how to - guides, see - https://cloud.google.com/sensitive-data-protection/docs/inspecting-images - and - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, - operationId: dlp.projects.locations.content.inspect + Finish a running hybrid DlpJob. Triggers the finalization steps and + running of any enabled actions that have not yet run. + operationId: dlp.projects.locations.dlpJobs.finish requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2FinishDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10736,7 +10829,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10748,23 +10841,29 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: + - in: path + name: dlpJobsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs: parameters: *ref_1 post: description: >- - De-identifies potentially sensitive info from a ContentItem. This method - has limits on input size and output size. See - https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + Creates a new job to inspect storage or calculate risk metrics. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to + inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. - operationId: dlp.projects.locations.content.deidentify + operationId: dlp.projects.locations.dlpJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10776,8 +10875,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -10789,19 +10887,14 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: - parameters: *ref_1 - post: + get: description: >- - Re-identifies content that has been de-identified. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.content.reidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + operationId: dlp.projects.locations.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10813,8 +10906,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path name: projectsId @@ -10826,21 +10918,48 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + - in: query + name: locationId + schema: + type: string + - in: query + name: type + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: parameters: *ref_1 - patch: + post: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Starts asynchronous cancellation on a long-running DlpJob. The server + makes a best effort to cancel the DlpJob, but success is not guaranteed. + See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.storedInfoTypes.patch + operationId: dlp.projects.locations.dlpJobs.cancel requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10852,7 +10971,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10865,16 +10984,23 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: dlpJobsId required: true schema: type: string - delete: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: + parameters: *ref_1 + post: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.delete + Inspect hybrid content and store findings to a job. To review the + findings, inspect the job. Inspection will occur asynchronously. + operationId: dlp.projects.locations.dlpJobs.hybridInspect + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10886,7 +11012,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' parameters: - in: path name: projectsId @@ -10899,16 +11025,15 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: dlpJobsId required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: + parameters: *ref_1 get: - description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.get + description: Lists project data profiles for an organization. + operationId: dlp.projects.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10920,7 +11045,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path name: projectsId @@ -10932,19 +11058,28 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: parameters: *ref_1 get: - description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.list + description: Gets a project data profile. + operationId: dlp.projects.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10956,8 +11091,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path name: projectsId @@ -10969,35 +11103,30 @@ paths: required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: projectDataProfilesId + required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: + parameters: *ref_1 post: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.create + Finds potentially sensitive info in content. This method has limits on + input size, processing time, and output size. When no InfoTypes or + CustomInfoTypes are specified in this request, the system will + automatically choose what detectors to run. By default this may be all + types, but may change over time as detectors are updated. For how to + guides, see + https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + and + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + operationId: dlp.projects.locations.content.inspect requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11009,7 +11138,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path name: projectsId @@ -11021,11 +11150,23 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: + /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: parameters: *ref_1 - get: - description: Lists project data profiles for an organization. - operationId: dlp.projects.locations.projectDataProfiles.list + post: + description: >- + De-identifies potentially sensitive info from a ContentItem. This method + has limits on input size and output size. See + https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.content.deidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11038,7 +11179,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path name: projectsId @@ -11050,28 +11191,19 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: + /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: parameters: *ref_1 - get: - description: Gets a project data profile. - operationId: dlp.projects.locations.projectDataProfiles.get + post: + description: >- + Re-identifies content that has been de-identified. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + to learn more. + operationId: dlp.projects.locations.content.reidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11083,7 +11215,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path name: projectsId @@ -11095,16 +11228,17 @@ paths: required: true schema: type: string - - in: path - name: projectDataProfilesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles: + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: parameters: *ref_1 - get: - description: Lists file store data profiles for an organization. - operationId: dlp.projects.locations.fileStoreDataProfiles.list + patch: + description: Updates a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11116,8 +11250,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -11129,28 +11262,14 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter + - in: path + name: discoveryConfigsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: - parameters: *ref_1 - get: - description: Gets a file store data profile. - operationId: dlp.projects.locations.fileStoreDataProfiles.get + delete: + description: Deletes a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11162,7 +11281,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11175,16 +11294,13 @@ paths: schema: type: string - in: path - name: fileStoreDataProfilesId + name: discoveryConfigsId required: true schema: type: string - delete: - description: >- - Delete a FileStoreDataProfile. Will not prevent the profile from being - regenerated if the resource is still included in a discovery - configuration. - operationId: dlp.projects.locations.fileStoreDataProfiles.delete + get: + description: Gets a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11196,7 +11312,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -11209,15 +11325,15 @@ paths: schema: type: string - in: path - name: fileStoreDataProfilesId + name: discoveryConfigsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: parameters: *ref_1 get: - description: Gets a column data profile. - operationId: dlp.projects.locations.columnDataProfiles.get + description: Lists discovery configurations. + operationId: dlp.projects.locations.discoveryConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11229,7 +11345,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path name: projectsId @@ -11241,16 +11358,28 @@ paths: required: true schema: type: string - - in: path - name: columnDataProfilesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: - parameters: *ref_1 - get: - description: Lists column data profiles for an organization. - operationId: dlp.projects.locations.columnDataProfiles.list + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a config for discovery to scan and profile storage. + operationId: dlp.projects.locations.discoveryConfigs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11262,8 +11391,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -11275,28 +11403,13 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: parameters: *ref_1 - get: - description: Gets a table data profile. - operationId: dlp.projects.locations.tableDataProfiles.get + delete: + description: >- + Delete a TableDataProfile. Will not prevent the profile from being + regenerated if the table is still included in a discovery configuration. + operationId: dlp.projects.locations.tableDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11308,7 +11421,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11325,11 +11438,9 @@ paths: required: true schema: type: string - delete: - description: >- - Delete a TableDataProfile. Will not prevent the profile from being - regenerated if the table is still included in a discovery configuration. - operationId: dlp.projects.locations.tableDataProfiles.delete + get: + description: Gets a table data profile. + operationId: dlp.projects.locations.tableDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11341,7 +11452,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' parameters: - in: path name: projectsId @@ -11388,39 +11499,27 @@ paths: schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query name: orderBy schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v2/projects/{projectsId}/content:deidentify: + /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles: parameters: *ref_1 - post: - description: >- - De-identifies potentially sensitive info from a ContentItem. This method - has limits on input size and output size. See - https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.content.deidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' + get: + description: Lists file store data profiles for an organization. + operationId: dlp.projects.locations.fileStoreDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11433,26 +11532,40 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse + #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/content:reidentify: + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: parameters: *ref_1 - post: - description: >- - Re-identifies content that has been de-identified. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example - to learn more. - operationId: dlp.projects.content.reidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + get: + description: Gets a file store data profile. + operationId: dlp.projects.locations.fileStoreDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11464,33 +11577,29 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/content:inspect: - parameters: *ref_1 - post: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: fileStoreDataProfilesId + required: true + schema: + type: string + delete: description: >- - Finds potentially sensitive info in content. This method has limits on - input size, processing time, and output size. When no InfoTypes or - CustomInfoTypes are specified in this request, the system will - automatically choose what detectors to run. By default this may be all - types, but may change over time as detectors are updated. For how to - guides, see - https://cloud.google.com/sensitive-data-protection/docs/inspecting-images - and - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, - operationId: dlp.projects.content.inspect - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' + Delete a FileStoreDataProfile. Will not prevent the profile from being + regenerated if the resource is still included in a discovery + configuration. + operationId: dlp.projects.locations.fileStoreDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11502,23 +11611,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: fileStoreDataProfilesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 - get: + delete: description: >- - Gets the latest state of a long-running DlpJob. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.dlpJobs.get + operationId: dlp.projects.locations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11530,7 +11647,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11538,20 +11655,21 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: locationsId required: true schema: type: string - delete: + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + get: description: >- - Deletes a long-running DlpJob. This method indicates that the client is - no longer interested in the DlpJob result. The job will be canceled if - possible. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.dlpJobs.delete + operationId: dlp.projects.locations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11563,7 +11681,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -11571,27 +11689,28 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: - parameters: *ref_1 - post: + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + patch: description: >- - Starts asynchronous cancellation on a long-running DlpJob. The server - makes a best effort to cancel the DlpJob, but success is not guaranteed. - See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.dlpJobs.cancel + operationId: dlp.projects.locations.storedInfoTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11603,7 +11722,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -11611,28 +11730,29 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs: + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: parameters: *ref_1 post: description: >- - Creates a new job to inspect storage or calculate risk metrics. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. When no InfoTypes or CustomInfoTypes are specified in - inspect jobs, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.dlpJobs.create + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11644,21 +11764,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string get: description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.dlpJobs.list + operationId: dlp.projects.locations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11670,19 +11793,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - in: query @@ -11691,25 +11812,25 @@ paths: type: integer format: int32 - in: query - name: type + name: orderBy schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query - name: pageToken + name: locationId schema: type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: parameters: *ref_1 - delete: + get: description: >- - Deletes a job trigger. See + Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.delete + operationId: dlp.projects.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11721,7 +11842,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: projectsId @@ -11729,16 +11850,47 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: locationsId required: true schema: type: string - get: + - in: query + name: locationId + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: type + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: description: >- - Gets a job trigger. See + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.get + operationId: dlp.projects.locations.jobTriggers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11758,21 +11910,18 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: locationsId required: true schema: type: string - patch: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_1 + get: description: >- - Updates a job trigger. See + Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + operationId: dlp.projects.locations.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11791,25 +11940,27 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers: - parameters: *ref_1 - post: + patch: description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See + Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.create + operationId: dlp.projects.locations.jobTriggers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11828,12 +11979,22 @@ paths: required: true schema: type: string - get: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobTriggersId + required: true + schema: + type: string + delete: description: >- - Lists job triggers. See + Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.list + operationId: dlp.projects.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11845,50 +12006,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: locationId + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: jobTriggersId + required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect: parameters: *ref_1 post: description: >- - Activate a job trigger. Causes the immediate execute of a trigger - instead of waiting on the trigger event to occur. - operationId: dlp.projects.jobTriggers.activate + Inspect hybrid content and store findings to a trigger. The inspection + will be processed asynchronously. To review the findings monitor the + jobs within the trigger. + operationId: dlp.projects.locations.jobTriggers.hybridInspect requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2HybridInspectJobTriggerRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11900,7 +12048,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' parameters: - in: path name: projectsId @@ -11908,84 +12056,27 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/image:redact: - parameters: *ref_1 - post: - description: >- - Redacts potentially sensitive info from an image. This method has limits - on input size, processing time, and output size. See - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.image.redact - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' - parameters: - in: path - name: projectsId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/inspectTemplates: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate: parameters: *ref_1 post: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.inspectTemplates.create + Activate a job trigger. Causes the immediate execute of a trigger + instead of waiting on the trigger event to occur. + operationId: dlp.projects.locations.jobTriggers.activate requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - get: - description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.inspectTemplates.list + $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11997,29 +12088,21 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: locationId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: jobTriggersId + required: true schema: type: string /v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}: @@ -12117,49 +12200,21 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/projects/{projectsId}/inspectTemplates: parameters: *ref_1 - get: - description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.deidentifyTemplates.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: deidentifyTemplatesId - required: true - schema: - type: string - patch: + post: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.deidentifyTemplates.patch + operationId: dlp.projects.inspectTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12171,24 +12226,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true - schema: - type: string - delete: + get: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.deidentifyTemplates.delete + operationId: dlp.projects.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12200,26 +12250,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true + - in: query + name: orderBy schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates: + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/projects/{projectsId}/content:reidentify: parameters: *ref_1 - get: + post: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Re-identifies content that has been de-identified. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. - operationId: dlp.projects.deidentifyTemplates.list + operationId: dlp.projects.content.reidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12232,43 +12300,32 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: locationId - schema: - type: string + /v2/projects/{projectsId}/content:inspect: + parameters: *ref_1 post: description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.deidentifyTemplates.create + Finds potentially sensitive info in content. This method has limits on + input size, processing time, and output size. When no InfoTypes or + CustomInfoTypes are specified in this request, the system will + automatically choose what detectors to run. By default this may be all + types, but may change over time as detectors are updated. For how to + guides, see + https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + and + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + operationId: dlp.projects.content.inspect requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12280,21 +12337,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: + /v2/projects/{projectsId}/content:deidentify: parameters: *ref_1 - get: + post: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.storedInfoTypes.get + De-identifies potentially sensitive info from a ContentItem. This method + has limits on input size and output size. See + https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.content.deidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12306,24 +12372,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - delete: + /v2/locations/{locationsId}/infoTypes: + parameters: *ref_1 + get: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Returns a list of the sensitive information types that DLP API supports. + See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. - operationId: dlp.projects.storedInfoTypes.delete + operationId: dlp.locations.infoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12335,31 +12400,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: languageCode schema: type: string - patch: + - in: query + name: filter + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/infoTypes: + parameters: *ref_1 + get: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Returns a list of the sensitive information types that DLP API supports. + See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. - operationId: dlp.projects.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + operationId: dlp.infoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12371,32 +12439,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' parameters: - - in: path - name: projectsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: parent schema: type: string - /v2/projects/{projectsId}/storedInfoTypes: + - in: query + name: locationId + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 - post: + get: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.storedInfoTypes.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + operationId: dlp.organizations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12408,19 +12476,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - get: + - in: path + name: inspectTemplatesId + required: true + schema: + type: string + delete: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.storedInfoTypes.list + operationId: dlp.organizations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12432,46 +12505,30 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: inspectTemplatesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_1 patch: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.storedInfoTypes.patch + operationId: dlp.organizations.inspectTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12483,7 +12540,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -12491,16 +12548,25 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: inspectTemplatesId required: true schema: type: string - get: + /v2/organizations/{organizationsId}/inspectTemplates: + parameters: *ref_1 + post: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.storedInfoTypes.get + operationId: dlp.organizations.inspectTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12512,24 +12578,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - delete: + get: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.storedInfoTypes.delete + operationId: dlp.organizations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12541,26 +12602,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: locationId schema: type: string - /v2/organizations/{organizationsId}/storedInfoTypes: + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: parameters: *ref_1 get: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.organizations.storedInfoTypes.list + operationId: dlp.organizations.locations.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12572,18 +12648,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: @@ -12593,54 +12674,25 @@ paths: schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 - post: - description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' - parameters: - - in: path - name: organizationsId - required: true + type: string + - in: query + name: orderBy schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + - in: query + name: type + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 - patch: + get: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + operationId: dlp.organizations.locations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12652,7 +12704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -12665,16 +12717,23 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: storedInfoTypesId required: true schema: type: string - get: + patch: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.get + operationId: dlp.organizations.locations.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12686,7 +12745,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -12699,16 +12758,16 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: storedInfoTypesId required: true schema: type: string delete: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.delete + operationId: dlp.organizations.locations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12733,25 +12792,24 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: storedInfoTypesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: parameters: *ref_1 post: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.create + operationId: dlp.organizations.locations.storedInfoTypes.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12763,7 +12821,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -12777,10 +12835,10 @@ paths: type: string get: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.list + operationId: dlp.organizations.locations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12793,7 +12851,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: organizationsId @@ -12805,31 +12863,33 @@ paths: required: true schema: type: string + - in: query + name: locationId + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: orderBy - schema: - type: string - in: query name: pageToken schema: type: string - in: query - name: locationId + name: orderBy schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}: parameters: *ref_1 - get: - description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.get + patch: + description: Update a Connection. + operationId: dlp.organizations.locations.connections.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12841,7 +12901,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -12854,16 +12914,13 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: connectionsId required: true schema: type: string delete: - description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.delete + description: Delete a Connection. + operationId: dlp.organizations.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12888,23 +12945,13 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: connectionsId required: true schema: type: string - patch: - description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + get: + description: Get a Connection by name. + operationId: dlp.organizations.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12916,7 +12963,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -12929,24 +12976,20 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: connectionsId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: + /v2/organizations/{organizationsId}/locations/{locationsId}/connections: parameters: *ref_1 post: - description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.create + description: Create a Connection to an external data source. + operationId: dlp.organizations.locations.connections.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12958,7 +13001,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -12972,10 +13015,9 @@ paths: type: string get: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.list + Lists Connections in a parent. Use SearchConnections to see all + connections within an organization. + operationId: dlp.organizations.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12987,8 +13029,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' parameters: - in: path name: organizationsId @@ -13000,16 +13041,12 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - in: query name: pageToken schema: type: string - in: query - name: locationId + name: filter schema: type: string - in: query @@ -13017,11 +13054,11 @@ paths: schema: type: integer format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: parameters: *ref_1 get: - description: Gets a table data profile. - operationId: dlp.organizations.locations.tableDataProfiles.get + description: Searches for Connections in a parent. + operationId: dlp.organizations.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13033,7 +13070,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path name: organizationsId @@ -13045,16 +13083,24 @@ paths: required: true schema: type: string - - in: path - name: tableDataProfilesId - required: true + - in: query + name: filter schema: type: string - delete: - description: >- - Delete a TableDataProfile. Will not prevent the profile from being - regenerated if the table is still included in a discovery configuration. - operationId: dlp.organizations.locations.tableDataProfiles.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a column data profile. + operationId: dlp.organizations.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13066,7 +13112,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path name: organizationsId @@ -13079,15 +13125,15 @@ paths: schema: type: string - in: path - name: tableDataProfilesId + name: columnDataProfilesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: parameters: *ref_1 get: - description: Lists table data profiles for an organization. - operationId: dlp.organizations.locations.tableDataProfiles.list + description: Lists column data profiles for an organization. + operationId: dlp.organizations.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13100,7 +13146,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path name: organizationsId @@ -13112,11 +13158,6 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: pageToken schema: @@ -13129,11 +13170,16 @@ paths: name: filter schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: parameters: *ref_1 - get: - description: Gets a project data profile. - operationId: dlp.organizations.locations.projectDataProfiles.get + delete: + description: Deletes a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13145,7 +13191,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13158,15 +13204,19 @@ paths: schema: type: string - in: path - name: projectDataProfilesId + name: discoveryConfigsId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: - parameters: *ref_1 - get: - description: Lists project data profiles for an organization. - operationId: dlp.organizations.locations.projectDataProfiles.list + patch: + description: Updates a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13178,8 +13228,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13191,36 +13240,53 @@ paths: required: true schema: type: string - - in: query - name: orderBy + - in: path + name: discoveryConfigsId + required: true schema: type: string - - in: query - name: filter + get: + description: Gets a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: discoveryConfigsId + required: true schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: parameters: *ref_1 - patch: - description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.patch + post: + description: Creates a config for discovery to scan and profile storage. + operationId: dlp.organizations.locations.discoveryConfigs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13232,7 +13298,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13244,17 +13310,51 @@ paths: required: true schema: type: string + get: + description: Lists discovery configurations. + operationId: dlp.organizations.locations.discoveryConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string - in: path - name: jobTriggersId + name: locationsId required: true schema: type: string - delete: - description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.delete + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a project data profile. + operationId: dlp.organizations.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13266,7 +13366,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path name: organizationsId @@ -13279,16 +13379,15 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: projectDataProfilesId required: true schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: + parameters: *ref_1 get: - description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.get + description: Lists project data profiles for an organization. + operationId: dlp.organizations.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13300,7 +13399,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path name: organizationsId @@ -13312,25 +13412,31 @@ paths: required: true schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: filter schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_1 - post: + delete: description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.locations.jobTriggers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + operationId: dlp.organizations.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13342,7 +13448,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13354,12 +13460,17 @@ paths: required: true schema: type: string + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string get: description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.locations.jobTriggers.list + operationId: dlp.organizations.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13371,7 +13482,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -13383,41 +13494,23 @@ paths: required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: deidentifyTemplatesId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: - parameters: *ref_1 - get: + patch: description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.locations.dlpJobs.list + operationId: dlp.organizations.locations.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13429,7 +13522,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -13441,36 +13534,19 @@ paths: required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: deidentifyTemplatesId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles: + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: parameters: *ref_1 get: - description: Lists file store data profiles for an organization. - operationId: dlp.organizations.locations.fileStoreDataProfiles.list + description: >- + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13483,7 +13559,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: organizationsId @@ -13496,7 +13572,7 @@ paths: schema: type: string - in: query - name: filter + name: locationId schema: type: string - in: query @@ -13512,11 +13588,19 @@ paths: name: orderBy schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: - parameters: *ref_1 - get: - description: Gets a file store data profile. - operationId: dlp.organizations.locations.fileStoreDataProfiles.get + post: + description: >- + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13528,7 +13612,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -13540,17 +13624,21 @@ paths: required: true schema: type: string - - in: path - name: fileStoreDataProfilesId - required: true - schema: - type: string - delete: + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: + parameters: *ref_1 + post: description: >- - Delete a FileStoreDataProfile. Will not prevent the profile from being - regenerated if the resource is still included in a discovery - configuration. - operationId: dlp.organizations.locations.fileStoreDataProfiles.delete + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13562,7 +13650,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -13574,18 +13662,12 @@ paths: required: true schema: type: string - - in: path - name: fileStoreDataProfilesId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections: - parameters: *ref_1 get: description: >- - Lists Connections in a parent. Use SearchConnections to see all - connections within an organization. - operationId: dlp.organizations.locations.connections.list + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13597,7 +13679,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: organizationsId @@ -13610,11 +13693,11 @@ paths: schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -13622,42 +13705,24 @@ paths: schema: type: integer format: int32 - post: - description: Create a Connection to an external data source. - operationId: dlp.organizations.locations.connections.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: locationId schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 - delete: - description: Delete a Connection. - operationId: dlp.organizations.locations.connections.delete + patch: + description: >- + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13669,7 +13734,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -13682,13 +13747,16 @@ paths: schema: type: string - in: path - name: connectionsId + name: inspectTemplatesId required: true schema: type: string get: - description: Get a Connection by name. - operationId: dlp.organizations.locations.connections.get + description: >- + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13700,7 +13768,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -13713,18 +13781,16 @@ paths: schema: type: string - in: path - name: connectionsId + name: inspectTemplatesId required: true schema: type: string - patch: - description: Update a Connection. - operationId: dlp.organizations.locations.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' + delete: + description: >- + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13736,7 +13802,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13749,15 +13815,18 @@ paths: schema: type: string - in: path - name: connectionsId + name: inspectTemplatesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: + /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: parameters: *ref_1 - get: - description: Searches for Connections in a parent. - operationId: dlp.organizations.locations.connections.search + delete: + description: >- + Delete a FileStoreDataProfile. Will not prevent the profile from being + regenerated if the resource is still included in a discovery + configuration. + operationId: dlp.organizations.locations.fileStoreDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13769,8 +13838,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13782,24 +13850,14 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: fileStoreDataProfilesId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: - parameters: *ref_1 get: - description: Gets a column data profile. - operationId: dlp.organizations.locations.columnDataProfiles.get + description: Gets a file store data profile. + operationId: dlp.organizations.locations.fileStoreDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13811,7 +13869,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' parameters: - in: path name: organizationsId @@ -13824,15 +13882,15 @@ paths: schema: type: string - in: path - name: columnDataProfilesId + name: fileStoreDataProfilesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: + /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles: parameters: *ref_1 get: - description: Lists column data profiles for an organization. - operationId: dlp.organizations.locations.columnDataProfiles.list + description: Lists file store data profiles for an organization. + operationId: dlp.organizations.locations.fileStoreDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13845,7 +13903,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse parameters: - in: path name: organizationsId @@ -13861,6 +13919,10 @@ paths: name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: @@ -13870,18 +13932,14 @@ paths: name: orderBy schema: type: string - - in: query - name: pageToken - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: parameters: *ref_1 get: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.list + operationId: dlp.organizations.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13893,8 +13951,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: organizationsId @@ -13906,36 +13963,43 @@ paths: required: true schema: type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: locationId + name: filter schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query - name: pageToken + name: type schema: type: string post: description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.create + operationId: dlp.organizations.locations.jobTriggers.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13947,7 +14011,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -13959,14 +14023,14 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: parameters: *ref_1 - get: + delete: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.get + operationId: dlp.organizations.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13978,7 +14042,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13991,16 +14055,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: jobTriggersId required: true schema: type: string - delete: + get: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Gets a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.delete + operationId: dlp.organizations.locations.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14012,7 +14076,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -14025,61 +14089,21 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: jobTriggersId required: true schema: type: string patch: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: deidentifyTemplatesId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: - parameters: *ref_1 - post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.organizations.locations.discoveryConfigs.create + operationId: dlp.organizations.locations.jobTriggers.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14091,7 +14115,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -14103,51 +14127,18 @@ paths: required: true schema: type: string - get: - description: Lists discovery configurations. - operationId: dlp.organizations.locations.discoveryConfigs.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - in: path - name: locationsId + name: jobTriggersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: parameters: *ref_1 delete: - description: Deletes a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.delete + description: >- + Delete a TableDataProfile. Will not prevent the profile from being + regenerated if the table is still included in a discovery configuration. + operationId: dlp.organizations.locations.tableDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14172,19 +14163,13 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: tableDataProfilesId required: true schema: type: string - patch: - description: Updates a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + get: + description: Gets a table data profile. + operationId: dlp.organizations.locations.tableDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14196,7 +14181,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' parameters: - in: path name: organizationsId @@ -14209,13 +14194,15 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: tableDataProfilesId required: true schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: + parameters: *ref_1 get: - description: Gets a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.get + description: Lists table data profiles for an organization. + operationId: dlp.organizations.locations.tableDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14227,7 +14214,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse parameters: - in: path name: organizationsId @@ -14239,19 +14227,38 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 - delete: + patch: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.deidentifyTemplates.delete + operationId: dlp.organizations.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14263,7 +14270,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -14271,22 +14278,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: storedInfoTypesId required: true schema: type: string - patch: + delete: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.deidentifyTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + operationId: dlp.organizations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14298,7 +14299,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14306,16 +14307,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: storedInfoTypesId required: true schema: type: string get: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.deidentifyTemplates.get + operationId: dlp.organizations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14327,7 +14328,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -14335,25 +14336,24 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: storedInfoTypesId required: true schema: type: string - /v2/organizations/{organizationsId}/deidentifyTemplates: + /v2/organizations/{organizationsId}/storedInfoTypes: parameters: *ref_1 post: description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.deidentifyTemplates.create + operationId: dlp.organizations.storedInfoTypes.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14365,7 +14365,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -14374,10 +14374,10 @@ paths: type: string get: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.deidentifyTemplates.list + operationId: dlp.organizations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14390,23 +14390,19 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - in: query name: pageToken schema: type: string - in: query - name: locationId + name: orderBy schema: type: string - in: query @@ -14414,63 +14410,24 @@ paths: schema: type: integer format: int32 - /v2/organizations/{organizationsId}/inspectTemplates: - parameters: *ref_1 - get: - description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.inspectTemplates.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - in: query name: locationId schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - post: + /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + parameters: *ref_1 + patch: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.inspectTemplates.create + operationId: dlp.organizations.deidentifyTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14482,21 +14439,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId required: true schema: type: string - /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: - parameters: *ref_1 + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string get: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.inspectTemplates.get + operationId: dlp.organizations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14508,7 +14468,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -14516,16 +14476,16 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: deidentifyTemplatesId required: true schema: type: string delete: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.inspectTemplates.delete + operationId: dlp.organizations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14545,22 +14505,25 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: deidentifyTemplatesId required: true schema: type: string - patch: + /v2/organizations/{organizationsId}/deidentifyTemplates: + parameters: *ref_1 + post: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.inspectTemplates.patch + operationId: dlp.organizations.deidentifyTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14572,15 +14535,52 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.deidentifyTemplates.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + parameters: - in: path - name: inspectTemplatesId + name: organizationsId required: true schema: type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/dns.yaml b/providers/src/googleapis.com/v00.00.00000/services/dns.yaml index e75567bc..49ade5dc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dns.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dns.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dns/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml b/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml index 191b7df3..5d6bfd93 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml @@ -11,7 +11,7 @@ info: computer vision, translation, and AutoML. version: v1 x-discovery-doc-revision: '20240911' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/document-ai/docs/ servers: @@ -37,780 +37,725 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - questionId: - description: The Crowd Compute question ID. + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata type: object - description: The long-running operation metadata for the ReviewDocument method. - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: - description: Parsed and normalized entity value. + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: + properties: {} + description: Response message for the UndeployProcessorVersion method. + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse type: object + GoogleCloudDocumentaiV1HumanReviewStatus: + id: GoogleCloudDocumentaiV1HumanReviewStatus + description: The status of human review on a processed document. properties: - moneyValue: - description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - $ref: '#/components/schemas/GoogleTypeMoney' - addressValue: - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - booleanValue: - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - type: boolean - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' - description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - floatValue: - description: Float value. - type: number - format: float - datetimeValue: - description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - $ref: '#/components/schemas/GoogleTypeDateTime' - integerValue: - type: integer - format: int32 - description: Integer value. - text: + state: + enumDescriptions: + - >- + Human review state is unspecified. Most likely due to an internal + error. + - >- + Human review is skipped for the document. This can happen because + human review isn't enabled on the processor or the processing + request has been set to skip this document. + - >- + Human review validation is triggered and passed, so no review is + needed. + - >- + Human review validation is triggered and the document is under + review. + - >- + Some error happened during triggering human review, see the + state_message for details. type: string + enum: + - STATE_UNSPECIFIED + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR + description: The state of human review on the processing request. + humanReviewOperation: description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - GoogleCloudDocumentaiV1DocumentOutputConfig: + The name of the operation triggered by the processed document. This + field is populated only when the state is + `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + metadata as the long-running operation returned by ReviewDocument. + type: string + stateMessage: + type: string + description: A message providing more details about the human review state. type: object + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo: properties: - gcsOutputConfig: + customGenAiModelInfo: + description: Information for a custom Generative AI model created by the user. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig - description: Output config to write the results to Cloud Storage. + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + foundationGenAiModelInfo: + description: Information for a pretrained Google-managed foundation model. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + id: GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo + type: object + description: Information about Generative AI model-based processor versions. + GoogleTypeDateTime: description: >- - Config that controls the output of documents. All documents will be - written as a JSON file. - id: GoogleCloudDocumentaiV1DocumentOutputConfig - GoogleCloudDocumentaiV1DocumentChunkedDocument: - description: Represents the chunks that the document is divided into. + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocument properties: - chunks: - description: List of chunks. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - type: array - GoogleCloudDocumentaiV1DocumentPage: - description: A page in a Document. + timeZone: + $ref: '#/components/schemas/GoogleTypeTimeZone' + description: Time zone. + hours: + description: >- + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. + type: integer + format: int32 + year: + description: >- + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. + type: integer + format: int32 + utcOffset: + type: string + description: >- + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. + format: google-duration + nanos: + type: integer + format: int32 + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + month: + format: int32 + description: >- + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + type: integer + day: + type: integer + description: >- + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + format: int32 + seconds: + description: >- + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. + format: int32 + type: integer + minutes: + format: int32 + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + type: integer + id: GoogleTypeDateTime + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: properties: - blocks: + documentErrorCount: + type: integer + description: The total number of document errors. + format: int32 + documentErrors: type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + datasetErrors: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' - image: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - tokens: + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. type: array + datasetErrorCount: + description: The total number of dataset errors. + type: integer + format: int32 + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + id: >- + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + type: object + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: + id: >- + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + type: object + properties: + datasetErrors: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - description: A list of visually detected tokens on the page. - imageQualityScores: - description: Image quality scores. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - detectedBarcodes: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - description: A list of detected barcodes. - dimension: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - description: Physical dimension of the page. - lines: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' - type: array + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. - formFields: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - type: array - description: A list of visually detected form fields on the page. - detectedLanguages: - type: array - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - symbols: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - description: A list of visually detected symbols on the page. - visualElements: + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - pageNumber: - description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. + documentErrorCount: + description: The total number of document errors. format: int32 type: integer - provenance: - deprecated: true - description: The history of this page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - paragraphs: - type: array + datasetErrorCount: + format: int32 + type: integer + description: The total number of dataset errors. + documentErrors: description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the page. - tables: - description: A list of visually detected tables on the page. - type: array + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - transforms: - description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. + $ref: '#/components/schemas/GoogleRpcStatus' type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' - id: GoogleCloudDocumentaiV1DocumentPage - type: object - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: - type: object - properties: - status: - description: The status of the exporting of the document. - $ref: '#/components/schemas/GoogleRpcStatus' - outputGcsDestination: - description: >- - The output_gcs_destination of the exported document if it was - successful, otherwise empty. - type: string - documentId: - description: The path to source docproto of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The status of each individual document in the export process. + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: + description: Information for a pretrained Google-managed foundation model. id: >- - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: - properties: - trainingDatasetValidation: - description: The training dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - testDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata - type: object - description: The metadata that represents a processor version being created. - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: - type: object - description: Response message for the SetDefaultProcessorVersion method. - properties: {} - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse - GoogleCloudDocumentaiV1DeployProcessorVersionResponse: - properties: {} - description: Response message for the DeployProcessorVersion method. - id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse - type: object - GoogleCloudDocumentaiV1BoundingPoly: - id: GoogleCloudDocumentaiV1BoundingPoly - description: A bounding polygon for the detected image annotation. + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo type: object properties: - normalizedVertices: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' - description: The bounding polygon normalized vertices. - type: array - vertices: - description: The bounding polygon vertices. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - type: object - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: - description: Metadata of the import document operation. - type: object - id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata + finetuningAllowed: + type: boolean + description: Whether finetuning is allowed for this base processor version. + minTrainLabeledDocuments: + format: int32 + description: >- + The minimum number of labeled documents in the training dataset + required for finetuning. + type: integer + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: properties: - importConfigValidationResults: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult - description: Validation statuses of the batch documents import config. commonMetadata: description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - totalDocumentCount: - type: integer - description: Total number of the documents that are qualified for importing. - format: int32 - individualImportStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus - description: The list of response details of each document. - GoogleCloudDocumentaiV1DisableProcessorRequest: - description: Request message for the DisableProcessor method. - properties: {} - id: GoogleCloudDocumentaiV1DisableProcessorRequest type: object - GoogleCloudDocumentaiV1DocumentPageToken: + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata + description: Metadata of the EvaluateProcessorVersion method. + GoogleCloudDocumentaiV1DocumentTextAnchor: type: object - id: GoogleCloudDocumentaiV1DocumentPageToken - description: A detected token. + id: GoogleCloudDocumentaiV1DocumentTextAnchor properties: - styleInfo: - description: Text style attributes. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - provenance: - deprecated: true - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedBreak: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - detectedLanguages: - description: A list of detected languages together with confidence. + content: + type: string + description: >- + Contains the content of the text span so that users do not have to + look it up in the text_segments. It is always populated for + formFields. + textSegments: type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - GoogleCloudDocumentaiV1BatchProcessRequest: + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + description: The text segments from the Document.text. + description: Text reference indexing into the Document.text. + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: type: object - description: Request message for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1BatchProcessRequest + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. properties: - documentOutputConfig: - description: The output configuration for the BatchProcessDocuments method. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' - labels: - description: >- - Optional. The labels with user-defined metadata for the request. - 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. - additionalProperties: - type: string - type: object - skipHumanReview: - type: boolean - description: >- - Whether human review should be skipped for this request. Default to - `false`. - processOptions: - description: Inference-time options for the process API - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - inputDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The input documents for the BatchProcessDocuments method. - GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: - id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata - description: The long-running operation metadata for the DisableProcessor method. - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1beta3RevisionRef: - description: The revision reference specifies which revision on the document to read. - properties: - latestProcessorVersion: - description: >- - Reads the revision generated by the processor version. The format - takes the full resource name of processor version. - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - type: string - revisionCase: - type: string + type: enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN enumDescriptions: - - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. - - The latest revision made by a human. - - The latest revision based on timestamp. - - The first (OCR) revision. - description: Reads the revision by the predefined case. - revisionId: - description: Reads the revision given by the id. + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. type: string - type: object - id: GoogleCloudDocumentaiV1beta3RevisionRef - GoogleCloudDocumentaiV1beta3BatchProcessMetadata: - type: object - description: The long-running operation metadata for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata + description: Detected break type. + GoogleCloudDocumentaiV1ProcessorVersion: + id: GoogleCloudDocumentaiV1ProcessorVersion properties: - updateTime: - description: The last update time of the operation. - format: google-datetime - type: string - createTime: - format: google-datetime - description: The creation time of the operation. - type: string - stateMessage: - type: string + name: description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - individualProcessStatuses: - description: The list of response details of each document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus - type: array - state: + Identifier. The resource name of the processor version. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` type: string + state: + readOnly: true enum: - STATE_UNSPECIFIED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLING - - CANCELLED + - DEPLOYED + - DEPLOYING + - UNDEPLOYED + - UNDEPLOYING + - CREATING + - DELETING - FAILED + - IMPORTING + description: Output only. The state of the processor version. enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was being cancelled. - - The batch processing was cancelled. - - The batch processing has failed. - description: The state of the current batch processing. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: - properties: - blocks: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + - The processor version is in an unspecified state. + - The processor version is deployed and can be used for processing. + - The processor version is being deployed. + - >- + The processor version is not deployed and cannot be used for + processing. + - The processor version is being undeployed. + - The processor version is being created. + - The processor version is being deleted. + - The processor version failed and is in an indeterminate state. + - The processor version is being imported. + type: string + deprecationInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + description: If set, information about the eventual deprecation of this version. + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + kmsKeyVersionName: + type: string + description: The KMS key version with which data is encrypted. + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: The schema of the processor version. Describes the output. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + googleManaged: + readOnly: true + type: boolean description: >- - A text block could further have child blocks. Repeated blocks - support further hierarchies and nested blocks. - type: array - text: + Output only. Denotes that this `ProcessorVersion` is managed by + Google. + modelType: type: string - description: Text content stored in the block. - type: + enum: + - MODEL_TYPE_UNSPECIFIED + - MODEL_TYPE_GENERATIVE + - MODEL_TYPE_CUSTOM + description: Output only. The model type of this processor version. + readOnly: true + enumDescriptions: + - The processor version has unspecified model type. + - The processor version has generative model type. + - The processor version has custom model type. + displayName: + description: The display name of the processor version. + type: string + latestEvaluation: + description: The most recently invoked evaluation for the processor version. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' + createTime: type: string + description: The time the processor version was created. + format: google-datetime + genAiModelInfo: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo description: >- - Type of the text in the block. Available options are: `paragraph`, - `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, - `heading-5`, `header`, `footer`. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - description: Represents a text type block. + Output only. Information about Generative AI model-based processor + versions. + kmsKeyName: + type: string + description: The KMS key name used for encryption. type: object - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. + A processor version is an implementation of a processor. Each processor + can have multiple versions, pretrained by Google internally or uptrained + by the customer. A processor can only have one default version at a + time. Its document-processing behavior is defined by that version. + GoogleCloudDocumentaiV1beta3DocumentId: type: object + description: Document Identifier. properties: - commonMetadata: + revisionRef: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3RevisionRef' + description: Points to a specific revision of the document if set. + unmanagedDocId: + description: A document id within unmanaged dataset. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata - GoogleCloudDocumentaiV1BatchProcessResponse: - id: GoogleCloudDocumentaiV1BatchProcessResponse - description: Response message for BatchProcessDocuments. - type: object - properties: {} - GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: - description: The long-running operation metadata for the ReviewDocument method. - type: object - id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + gcsManagedDocId: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + description: A document id within user-managed Cloud Storage. + id: GoogleCloudDocumentaiV1beta3DocumentId + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: + description: Resync status against inconsistency types on the dataset level. + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus properties: - stateMessage: - type: string + status: description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - createTime: - description: The creation time of the operation. - type: string - format: google-datetime - updateTime: - type: string - description: The last update time of the operation. - format: google-datetime - questionId: + The status of resyncing the dataset with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + $ref: '#/components/schemas/GoogleRpcStatus' + datasetInconsistencyType: type: string - description: The Crowd Compute question ID. - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - state: - description: Used only when Operation.done is false. - type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - GoogleCloudDocumentaiV1Vertex: - description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. - id: GoogleCloudDocumentaiV1Vertex - properties: - x: - type: integer - format: int32 - description: X coordinate. - 'y': - description: Y coordinate (starts from the top of the image). - type: integer - format: int32 + - Default value. + - The marker file under the dataset folder is not found. + enum: + - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED + - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER + description: The type of the inconsistency of the dataset. type: object - GoogleCloudDocumentaiV1ListProcessorTypesResponse: + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + type: object + description: The status of each individual document in the batch delete process. properties: - processorTypes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' - description: The processor types. - nextPageToken: - description: Points to the next page, otherwise empty. + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of deleting the document in storage. + documentId: + description: The document id of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + id: >- + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + GoogleCloudDocumentaiV1GcsDocument: + description: Specifies a document stored on Cloud Storage. + properties: + gcsUri: + description: The Cloud Storage object uri. type: string - id: GoogleCloudDocumentaiV1ListProcessorTypesResponse - description: Response message for the ListProcessorTypes method. + mimeType: + type: string + description: An IANA MIME type (RFC6838) of the content. + id: GoogleCloudDocumentaiV1GcsDocument type: object - GoogleCloudDocumentaiV1Evaluation: + GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: + description: The input data used to train a new ProcessorVersion. type: object - id: GoogleCloudDocumentaiV1Evaluation properties: - allEntitiesMetrics: + trainingDocuments: + description: The documents used for training the new version. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - description: Metrics for all the entities in aggregate. - documentCounters: - description: Counters for the documents used in the evaluation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' - entityMetrics: - description: Metrics across confidence levels, for different entities. - additionalProperties: + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + testDocuments: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The documents used for testing the trained version. + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: + description: Response of the sample documents operation. + type: object + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse + properties: + sampleTestStatus: + description: The status of sampling documents in test split. + $ref: '#/components/schemas/GoogleRpcStatus' + sampleTrainingStatus: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of sampling documents in training split. + selectedDocuments: + description: The result of the sampling process. + type: array + items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - type: object - createTime: - description: The time that the evaluation was created. - type: string - format: google-datetime - kmsKeyName: - type: string - description: The KMS key name used for encryption. - name: - description: >- - The resource name of the evaluation. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` - type: string - kmsKeyVersionName: - description: The KMS key version with which data is encrypted. - type: string - description: An evaluation of a ProcessorVersion's performance. - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument + GoogleCloudDocumentaiV1DocumentStyleFontSize: + id: GoogleCloudDocumentaiV1DocumentStyleFontSize + description: Font size with unit. type: object - description: Options to control foundation model tuning of the processor. - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions properties: - learningRateMultiplier: - description: >- - Optional. The multiplier to apply to the recommended learning rate. - Valid values are between 0.1 and 10. If not provided, recommended - learning rate will be used. + size: format: float + description: Font size for the text. type: number - trainSteps: + unit: description: >- - Optional. The number of steps to run for model tuning. Valid values - are between 1 and 400. If not provided, recommended steps will be - used. - type: integer - format: int32 - GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: - id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - type: object + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). + type: string + GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: properties: - schema: - description: >- - Output only. The schema in Document AI Warehouse associated with the - dataset. + defaultProcessorVersion: type: string - readOnly: true - collection: description: >- - Output only. The collection in Document AI Warehouse associated with - the dataset. - readOnly: true - type: string - description: >- - Configuration specific to the Document AI Warehouse-based - implementation. - GoogleCloudDocumentaiV1beta3DocumentId: - type: object - id: GoogleCloudDocumentaiV1beta3DocumentId - properties: - unmanagedDocId: - description: A document id within unmanaged dataset. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId - gcsManagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId - description: A document id within user-managed Cloud Storage. - revisionRef: - description: Points to a specific revision of the document if set. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3RevisionRef' - description: Document Identifier. - GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: + Required. The resource name of child ProcessorVersion to use as + default. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` type: object - id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + description: Request message for the SetDefaultProcessorVersion method. + GoogleCloudDocumentaiV1Document: properties: - docId: - description: Required. The id of the document. + text: type: string - description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. - GoogleCloudDocumentaiV1DocumentPageVisualElement: - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for VisualElement. - detectedLanguages: - description: A list of detected languages together with confidence. + description: Optional. UTF-8 encoded text in reading order from the document. + pages: + description: Visual page layout for the Document. + type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + entities: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + description: >- + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. type: array - type: - description: Type of the VisualElement. - type: string - id: GoogleCloudDocumentaiV1DocumentPageVisualElement - type: object - GoogleTypePostalAddress: - description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - type: object - properties: - languageCode: + revisions: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + type: array + description: Placeholder. Revision history of this document. + textChanges: + type: array + description: >- + Placeholder. A list of text corrections made to Document.text. This + is usually used for annotating corrections to OCR mistakes. Text + changes for a given revision may not overlap with each other. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' + entityRelations: + description: Placeholder. Relationship among Document.entities. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + type: array + uri: type: string description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - revision: - type: integer - description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - format: int32 - sortingCode: + Optional. Currently supports Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. + For more information, refer to [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris). + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + chunkedDocument: + description: Document chunked based on chunking config. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' + mimeType: description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). type: string - regionCode: + shardInfo: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. - type: string - locality: + Information about the sharding if this document is sharded part of a + larger document. If the document is not sharded, this message is not + specified. + content: type: string description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - recipients: - description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. - type: array + Optional. Inline document content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary + representation, whereas JSON representations use base64. + format: byte + textStyles: + deprecated: true items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + type: array + description: Styles for the Document.text. + documentLayout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' + description: Parsed layout of the document. + description: >- + Document represents the canonical document resource in Document AI. It + is an interchange format that provides insights into documents and + allows for collaboration between users and Document AI to iterate and + optimize for quality. + type: object + id: GoogleCloudDocumentaiV1Document + GoogleCloudDocumentaiV1BatchProcessRequest: + id: GoogleCloudDocumentaiV1BatchProcessRequest + properties: + inputDocuments: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The input documents for the BatchProcessDocuments method. + skipHumanReview: + description: >- + Whether human review should be skipped for this request. Default to + `false`. + type: boolean + processOptions: + description: Inference-time options for the process API + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + documentOutputConfig: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' + description: The output configuration for the BatchProcessDocuments method. + labels: + additionalProperties: type: string - organization: - type: string - description: Optional. The name of the organization at the address. - administrativeArea: - type: string description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. - addressLines: + Optional. The labels with user-defined metadata for the request. + 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 + description: Request message for BatchProcessDocuments. + type: object + GoogleCloudDocumentaiV1ListEvaluationsResponse: + id: GoogleCloudDocumentaiV1ListEvaluationsResponse + description: The response from `ListEvaluations`. + type: object + properties: + 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 + evaluations: + description: The evaluations requested. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' type: array + GoogleCloudDocumentaiV1DocumentPageTableTableRow: + description: A row of table cells. + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + properties: + cells: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + type: array + description: Cells that make up this row. + type: object + GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + testDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: The test dataset validation information. + trainingDatasetValidation: + description: The training dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: The metadata that represents a processor version being created. + type: object + GoogleLongrunningListOperationsResponse: + type: object + id: GoogleLongrunningListOperationsResponse + properties: + operations: + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). - sublocality: + A list of operations that matches the specified filter in the + request. + nextPageToken: type: string + description: The standard List next-page token. + description: The response message for Operations.ListOperations. + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: + properties: {} + description: Response message for the UndeployProcessorVersion method. + type: object + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse + GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: >- + The long-running operation metadata for the DeleteProcessorVersion + method. + GoogleCloudDocumentaiV1EvaluationCounters: + type: object + description: Evaluation counters for the documents that were used. + id: GoogleCloudDocumentaiV1EvaluationCounters + properties: + evaluatedDocumentsCount: + description: How many documents were used in the evaluation. + format: int32 + type: integer + invalidDocumentsCount: description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - postalCode: - type: string + How many documents were not included in the evaluation as they + didn't pass validation. + type: integer + format: int32 + inputDocumentsCount: + type: integer + format: int32 + description: How many documents were sent for evaluation. + failedDocumentsCount: + type: integer description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). - id: GoogleTypePostalAddress + How many documents were not included in the evaluation as Document + AI failed to process them. + format: int32 GoogleCloudDocumentaiV1DocumentPageImage: id: GoogleCloudDocumentaiV1DocumentPageImage - description: Rendered image contents for this page. properties: - height: - type: integer - format: int32 - description: Height of the image in pixels. width: + description: Width of the image in pixels. type: integer format: int32 - description: Width of the image in pixels. + height: + format: int32 + type: integer + description: Height of the image in pixels. mimeType: description: >- Encoding [media type (MIME @@ -818,911 +763,844 @@ components: for the image. type: string content: - type: string format: byte + type: string description: Raw byte content of the image. + description: Rendered image contents for this page. type: object - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: - id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset + GoogleCloudDocumentaiV1DocumentPageToken: type: object properties: - endIndex: - format: int64 - description: TextSegment half open end UTF-8 char index in the Document.text. + styleInfo: + description: Text style attributes. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + detectedBreak: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Token. + id: GoogleCloudDocumentaiV1DocumentPageToken + description: A detected token. + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: + properties: + evaluation: type: string - startIndex: + description: The resource name of the created evaluation. + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse + type: object + description: Response of the EvaluateProcessorVersion method. + GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: + description: Response of the EvaluateProcessorVersion method. + type: object + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse + properties: + evaluation: type: string - format: int64 - description: TextSegment start UTF-8 char index in the Document.text. - GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig: - description: Serving config for chunking. + description: The resource name of the created evaluation. + GoogleCloudDocumentaiV1EvaluationMetrics: + type: object properties: - includeAncestorHeadings: - type: boolean - description: >- - Optional. Whether or not to include ancestor headings when - splitting. - chunkSize: - description: >- - Optional. The chunk sizes to use when splitting documents, in order - of level. + predictedDocumentCount: + type: integer + format: int32 + description: The amount of documents with a predicted occurrence. + truePositivesCount: + type: integer + format: int32 + description: The amount of true positives. + falseNegativesCount: + type: integer + description: The amount of false negatives. + format: int32 + f1Score: + format: float + type: number + description: The calculated f1 score. + groundTruthDocumentCount: + format: int32 + type: integer + description: The amount of documents with a ground truth occurrence. + totalDocumentsCount: + description: The amount of documents that had an occurrence of this label. + format: int32 + type: integer + falsePositivesCount: + type: integer + format: int32 + description: The amount of false positives. + predictedOccurrencesCount: + type: integer + format: int32 + description: The amount of occurrences in predicted documents. + recall: + description: The calculated recall. + format: float + type: number + precision: + description: The calculated precision. + type: number + format: float + groundTruthOccurrencesCount: type: integer + description: The amount of occurrences in ground truth documents. format: int32 + id: GoogleCloudDocumentaiV1EvaluationMetrics + description: Evaluation metrics, either in aggregate or about a specific entity. + GoogleTypeMoney: type: object - id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig - GoogleCloudDocumentaiV1GcsDocuments: - id: GoogleCloudDocumentaiV1GcsDocuments properties: - documents: - type: array - description: The list of documents. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + format: int32 + type: integer + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + units: + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + format: int64 + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. + GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse + description: The response proto of ExportDocuments method. type: object - description: Specifies a set of documents on Cloud Storage. - GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: properties: {} - description: Response message for the SetDefaultProcessorVersion method. - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse - type: object - GoogleCloudDocumentaiV1DocumentRevision: - id: GoogleCloudDocumentaiV1DocumentRevision + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: + description: The metadata proto of `ResyncDataset` method. + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata type: object properties: - id: - type: string - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - processor: - description: >- - If the annotation was made by processor identify the processor by - its resource name. - type: string - agent: - type: string - description: >- - If the change was made by a person specify the name or id of that - person. - parentIds: - items: - type: string - description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. + individualDocumentResyncStatuses: type: array - createTime: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - format: google-datetime - type: string - parent: - type: array + The list of document resync statuses. The same document could have + multiple `individual_document_resync_statuses` if it has multiple + inconsistencies. + datasetResyncStatuses: items: - format: int32 - type: integer + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - deprecated: true - humanReview: - description: Human Review information of this revision. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - description: Contains past or forward revisions of this document. - GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: - properties: + The list of dataset resync statuses. Not checked when + ResyncDatasetRequest.dataset_documents is specified. + type: array commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata - type: object - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: type: object + id: >- + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo properties: - type: - description: Detected break type. + customModelType: enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN + - CUSTOM_MODEL_TYPE_UNSPECIFIED + - VERSIONED_FOUNDATION + - FINE_TUNED + type: string + description: The type of custom model created by the user. enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. + - The model type is unspecified. + - The model is a versioned foundation model. + - The model is a finetuned foundation model. + baseProcessorVersionId: + description: The base processor version ID for the custom model. type: string - GoogleCloudDocumentaiV1GcsDocument: + description: >- + Information for a custom Generative AI model created by the user. These + are created with `Create New Version` in either the `Call foundation + model` or `Fine tuning` tabs. + GoogleCloudDocumentaiV1ListProcessorVersionsResponse: properties: - mimeType: - type: string - description: An IANA MIME type (RFC6838) of the content. - gcsUri: - description: The Cloud Storage object uri. + nextPageToken: type: string - description: Specifies a document stored on Cloud Storage. - id: GoogleCloudDocumentaiV1GcsDocument + description: Points to the next processor, otherwise empty. + processorVersions: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + type: array + description: The list of processors. + id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse type: object - GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: - properties: {} - type: object - id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse - description: Response of the import document operation. - GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: - description: >- - The long-running operation metadata for updating the human review - configuration. - id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + description: Response message for the ListProcessorVersions method. + GoogleCloudDocumentaiV1DisableProcessorMetadata: properties: commonMetadata: description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' type: object - GoogleCloudDocumentaiV1ListEvaluationsResponse: + id: GoogleCloudDocumentaiV1DisableProcessorMetadata + description: The long-running operation metadata for the DisableProcessor method. + GoogleCloudDocumentaiV1ProcessRequest: + id: GoogleCloudDocumentaiV1ProcessRequest type: object - id: GoogleCloudDocumentaiV1ListEvaluationsResponse + description: Request message for the ProcessDocument method. properties: - nextPageToken: - type: string + inlineDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: An inline document proto. + skipHumanReview: 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. - evaluations: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' - description: The evaluations requested. - type: array - description: The response from `ListEvaluations`. - GoogleCloudDocumentaiV1DocumentEntityRelation: - id: GoogleCloudDocumentaiV1DocumentEntityRelation - description: Relationship between Entities. - type: object - properties: - subjectId: - description: Subject entity id. - type: string - objectId: - type: string - description: Object entity id. - relation: - description: Relationship description. + Whether human review should be skipped for this request. Default to + `false`. + type: boolean + labels: + additionalProperties: + type: string + type: object + description: >- + Optional. The labels with user-defined metadata for the request. + 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. + imagelessMode: + type: boolean + description: Optional. Option to remove images from the document. + fieldMask: + format: google-fieldmask + description: >- + Specifies which fields to include in the ProcessResponse.document + output. Only supports top-level document and pages field, so it must + be in the form of `{document_field_name}` or + `pages.{page_field_name}`. type: string - GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata - type: object - description: Metadata of the EvaluateProcessorVersion method. - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: + processOptions: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + description: Inference-time options for the process API + rawDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' + description: A raw document content (bytes). + gcsDocument: + description: A raw document on Google Cloud Storage. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: + description: Metadata of the batch export documents operation. properties: - totalDocumentCount: - format: int32 - description: Total number of the documents that are qualified for importing. - type: integer commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - individualImportStatuses: + splitExportStats: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus - description: The list of response details of each document. - type: array - importConfigValidationResults: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat type: array - description: Validation statuses of the batch documents import config. + description: The list of statistics for each dataset split type. + individualExportStatuses: + description: The list of response details of each document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata - description: Metadata of the import document operation. - type: object - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for DetectedBarcode. - barcode: - description: Detailed barcode information of the DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - description: A detected barcode. - type: object - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - GoogleCloudDocumentaiV1ReviewDocumentResponse: - description: Response message for the ReviewDocument method. - properties: - state: - type: string - enumDescriptions: - - The default value. This value is used if the state is omitted. - - The review operation is rejected by the reviewer. - - The review operation is succeeded. - description: The state of the review operation. - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - rejectionReason: - type: string - description: The reason why the review is rejected by reviewer. - gcsDestination: - type: string - description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. - id: GoogleCloudDocumentaiV1ReviewDocumentResponse + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + type: array type: object - GoogleCloudDocumentaiV1ProcessorVersionAlias: + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata + GoogleCloudDocumentaiV1BoundingPoly: + id: GoogleCloudDocumentaiV1BoundingPoly type: object - description: Contains the alias and the aliased resource name of processor version. + description: A bounding polygon for the detected image annotation. properties: - processorVersion: - type: string - description: The resource name of aliased processor version. - alias: - type: string - description: The alias in the form of `processor_version` resource name. - id: GoogleCloudDocumentaiV1ProcessorVersionAlias + vertices: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + type: array + description: The bounding polygon vertices. + normalizedVertices: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + description: The bounding polygon normalized vertices. GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: description: The status of each individual document in the batch delete process. + type: object properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. status: - $ref: '#/components/schemas/GoogleRpcStatus' description: The status of deleting the document in storage. + $ref: '#/components/schemas/GoogleRpcStatus' + documentId: + description: The document id of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' id: >- GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - type: object - GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: - type: object - description: Metadata of the sample documents operation. - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata - description: The metadata proto of `ResyncDataset` method. + GoogleCloudDocumentaiV1DocumentPageTable: + id: GoogleCloudDocumentaiV1DocumentPageTable type: object properties: - individualDocumentResyncStatuses: - description: >- - The list of document resync statuses. The same document could have - multiple `individual_document_resync_statuses` if it has multiple - inconsistencies. - type: array + bodyRows: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus - datasetResyncStatuses: - description: >- - The list of dataset resync statuses. Not checked when - ResyncDatasetRequest.dataset_documents is specified. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1BatchDocumentsInputConfig: - id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig - properties: - gcsPrefix: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' - description: >- - The set of documents that match the specified Cloud Storage - `gcs_prefix`. - gcsDocuments: - description: The set of documents individually specified on Cloud Storage. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' - type: object - description: The common config to specify a set of documents used as input. - GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: - type: object - description: The long-running operation metadata for UpdateLabelerPool. - id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1DocumentPageParagraph: - description: A collection of lines that a human would perceive as a paragraph. - id: GoogleCloudDocumentaiV1DocumentPageParagraph - properties: + description: Body rows of the table. provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' deprecated: true - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Paragraph. + description: The history of this table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + headerRows: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: Header rows of the table. + type: array detectedLanguages: type: array description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: object - GoogleCloudDocumentaiV1beta3BatchProcessResponse: - properties: {} - description: Response message for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1beta3BatchProcessResponse - type: object - GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig: - type: object - properties: - chunkingConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig - description: Optional. Config for chunking in layout parser processor. - description: Serving config for layout parser processor. - id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig - GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse - type: object - description: The response proto of ResyncDataset method. - properties: {} - GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: - description: The long-running operation metadata for the DeleteProcessor method. - type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata - GoogleCloudDocumentaiUiv1beta3DocumentId: + layout: + description: Layout for Table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: A table representation similar to HTML table structure. + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk properties: - unmanagedDocId: - description: A document id within unmanaged dataset. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId - gcsManagedDocId: + pageFooters: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + type: array + description: Page footers associated with the chunk. + pageSpan: + description: Page span of the chunk. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - description: A document id within user-managed Cloud Storage. - revisionRef: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' - description: Points to a specific revision of the document if set. - type: object - id: GoogleCloudDocumentaiUiv1beta3DocumentId - description: Document Identifier. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse - type: object - description: Response of the import document operation. - properties: {} - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: - id: >- - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo - properties: - baseProcessorVersionId: - description: The base processor version ID for the custom model. + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + content: type: string - customModelType: + description: Text content of the chunk. + chunkId: + description: ID of the chunk. type: string - enumDescriptions: - - The model type is unspecified. - - The model is a versioned foundation model. - - The model is a finetuned foundation model. - description: The type of custom model created by the user. - enum: - - CUSTOM_MODEL_TYPE_UNSPECIFIED - - VERSIONED_FOUNDATION - - FINE_TUNED - description: >- - Information for a custom Generative AI model created by the user. These - are created with `Create New Version` in either the `Call foundation - model` or `Fine tuning` tabs. - type: object - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata - description: The metadata that represents a processor version being created. - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - testDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - trainingDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - description: The training dataset validation information. - GoogleCloudDocumentaiV1DeployProcessorVersionRequest: - type: object - id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest - description: Request message for the DeployProcessorVersion method. - properties: {} - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: - properties: - rowSpan: - type: integer - format: int32 - description: How many rows this cell spans. - colSpan: - description: How many columns this cell spans. - format: int32 - type: integer - blocks: + sourceBlockIds: + type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + type: string + description: Unused. + pageHeaders: type: array - description: >- - A table cell is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. + description: Page headers associated with the chunk. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + description: Represents a chunk. type: object - description: Represents a cell in a table row. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell GoogleCloudDocumentaiV1DocumentTextChange: - type: object id: GoogleCloudDocumentaiV1DocumentTextChange - description: This message is used for text changes aka. OCR corrections. + type: object properties: + changedText: + type: string + description: The text that replaces the text identified in the `text_anchor`. textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' description: >- Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' provenance: - deprecated: true - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' description: The history of this annotation. type: array - changedText: - type: string - description: The text that replaces the text identified in the `text_anchor`. - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - id: GoogleRpcStatus + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: This message is used for text changes aka. OCR corrections. + GoogleCloudDocumentaiV1DocumentPageAnchor: properties: - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - details: + pageRefs: items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The long-running operation metadata for the EnableProcessor method. - type: object - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata - GoogleCloudDocumentaiV1DeleteProcessorMetadata: - type: object - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1DeleteProcessorMetadata - description: The long-running operation metadata for the DeleteProcessor method. - GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: - id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata - type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1EnableProcessorResponse: + description: One or more references to visual page elements description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. + Referencing the visual context of the entity in the Document.pages. Page + anchors can be cross-page, consist of multiple bounding polygons and + optionally reference specific layout element types. + id: GoogleCloudDocumentaiV1DocumentPageAnchor + type: object + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse type: object properties: {} - id: GoogleCloudDocumentaiV1EnableProcessorResponse - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + description: Response message for the SetDefaultProcessorVersion method. + GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: + properties: {} + id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse + type: object + description: Response of the import document operation. + GoogleCloudDocumentaiV1DocumentPageBlock: properties: - bodyRows: + layout: + description: Layout for Block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: type: array - description: Body rows containing main table content. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - caption: - description: Table caption/title. - type: string - headerRows: - description: Header rows at the top of the table. + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - type: array - type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - description: Represents a table type block. - GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: - type: object - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest - description: Request message for the SetDefaultProcessorVersion method. - properties: - defaultProcessorVersion: - type: string - description: >- - Required. The resource name of child ProcessorVersion to use as - default. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: - description: Represents the page header associated with the chunk. - properties: - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the header. - text: - description: Header in text format. - type: string - type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: - description: Response message associated with the ExportProcessorVersion operation. - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this annotation. type: object + description: >- + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. + id: GoogleCloudDocumentaiV1DocumentPageBlock + GoogleCloudDocumentaiV1beta3BatchProcessMetadata: properties: - gcsUri: - description: The Cloud Storage URI containing the output artifacts. + createTime: + format: google-datetime + description: The creation time of the operation. type: string - GoogleLongrunningListOperationsResponse: - description: The response message for Operations.ListOperations. - type: object - properties: - nextPageToken: + stateMessage: type: string - description: The standard List next-page token. - operations: - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - A list of operations that matches the specified filter in the - request. - id: GoogleLongrunningListOperationsResponse - GoogleCloudDocumentaiV1FetchProcessorTypesResponse: - type: object - description: Response message for the FetchProcessorTypes method. - id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse - properties: - processorTypes: + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + individualProcessStatuses: + description: The list of response details of each document. type: array - description: The list of processor types. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' - GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + state: + description: The state of the current batch processing. + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was being cancelled. + - The batch processing was cancelled. + - The batch processing has failed. + enum: + - STATE_UNSPECIFIED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLING + - CANCELLED + - FAILED + type: string + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata type: object - properties: {} - GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: + description: The long-running operation metadata for BatchProcessDocuments. + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: type: object + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: - properties: - splitExportStats: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat - type: array - description: The list of statistics for each dataset split type. - individualExportStatuses: + individualBatchMoveStatuses: type: array + description: The list of response details of each document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - description: The list of response details of each document. + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata - type: object - description: Metadata of the batch export documents operation. - GoogleCloudDocumentaiV1DocumentSchema: - properties: - entityTypes: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType - description: Entity types of the schema. - displayName: + destDatasetType: type: string - description: Display name to show to users. - description: + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + description: The destination dataset split type. + deprecated: true + destSplitType: type: string - description: Description of the schema. - metadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' - description: Metadata of the schema. - description: The schema defines the output of the processed document by a processor. - id: GoogleCloudDocumentaiV1DocumentSchema + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + description: The destination dataset split type. + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + properties: + pageStart: + format: int32 + description: Page where chunk starts in the document. + type: integer + pageEnd: + format: int32 + type: integer + description: Page where chunk ends in the document. type: object - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: - description: >- - The validation status of each import config. Status is set to an error - if there are no documents to import in the `import_config`, or `OK` if - the operation will try to proceed with at least one document. + description: Represents where the chunk starts and ends in the document. + GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: + id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + type: object + description: Evaluations metrics, at a specific confidence level. properties: - status: - description: The validation status of import config. - $ref: '#/components/schemas/GoogleRpcStatus' - inputGcsSource: - description: The source Cloud Storage URI specified in the import config. - type: string + metrics: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + description: The metrics at the specific confidence level. + confidenceLevel: + type: number + description: The confidence level. + format: float + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: + id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata type: object - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata + description: Metadata of the import document operation. properties: + importConfigValidationResults: + description: Validation statuses of the batch documents import config. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + totalDocumentCount: + type: integer + description: Total number of the documents that are qualified for importing. + format: int32 commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. + individualImportStatuses: + description: The list of response details of each document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + type: array + GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: type: object + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata description: >- - The long-running operation metadata for the DeleteProcessorVersion + The long-running operation metadata for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: properties: - humanReviewStatus: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' - description: The status of human review on the processed document. - status: - description: The status processing the document. - $ref: '#/components/schemas/GoogleRpcStatus' - outputGcsDestination: - type: string - description: >- - The Cloud Storage output destination (in the request as - DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed - document if it was successful, otherwise empty. - inputGcsSource: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1ProcessOptions: + id: GoogleCloudDocumentaiV1ProcessOptions + properties: + fromEnd: + format: int32 + type: integer + description: Only process certain pages from the end, same as above. + schemaOverride: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. - type: string - id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - description: The status of a each individual document in the batch process. + Optional. Override the schema of the ProcessorVersion. Will return + an Invalid Argument error if this field is set when the underlying + ProcessorVersion doesn't support schema override. + layoutConfig: + description: >- + Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns + error if set on other processor types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig + fromStart: + description: >- + Only process certain pages from the start. Process all if the + document has fewer pages. + type: integer + format: int32 + ocrConfig: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfig' + description: >- + Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. + Returns error if set on other processor types. + individualPageSelector: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + description: Which pages to process (1-indexed). + description: Options for Process API type: object - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: + GoogleCloudDocumentaiV1BatchProcessResponse: + type: object + id: GoogleCloudDocumentaiV1BatchProcessResponse + description: Response message for BatchProcessDocuments. + properties: {} + GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. properties: {} + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse type: object - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse - description: The response proto of AutoLabelDocuments method. - GoogleCloudDocumentaiV1ListProcessorVersionsResponse: + GoogleCloudDocumentaiV1ListProcessorTypesResponse: + type: object + description: Response message for the ListProcessorTypes method. properties: - processorVersions: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - description: The list of processors. + processorTypes: + description: The processor types. type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' nextPageToken: type: string - description: Points to the next processor, otherwise empty. - description: Response message for the ListProcessorVersions method. - id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse - type: object + description: Points to the next page, otherwise empty. + id: GoogleCloudDocumentaiV1ListProcessorTypesResponse GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: + id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + type: object properties: pages: description: Optional. Indices of the pages (starting from 1). + type: array items: format: int32 type: integer - type: array - type: object description: A list of individual page numbers. - id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: - description: Defines the a list of enum values. - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues - properties: - values: - type: array - description: The individual values that this enum values type can include. - items: - type: string + GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: + id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig type: object - GoogleCloudDocumentaiV1DocumentPageSymbol: + description: Configuration specific to spanner-based indexing. + properties: {} + GoogleCloudDocumentaiV1RawDocument: type: object - id: GoogleCloudDocumentaiV1DocumentPageSymbol - description: A detected symbol. - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Symbol. - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: properties: - chunkId: - description: ID of the chunk. + mimeType: + description: >- + An IANA MIME type (RFC6838) indicating the nature and format of the + content. type: string - sourceBlockIds: - items: - type: string - type: array - description: Unused. + displayName: + type: string + description: >- + The display name of the document, it supports all Unicode characters + except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, + `,` `~`, `=` and `:` are reserved. If not specified, a default ID is + generated. content: + description: Inline document content. type: string - description: Text content of the chunk. - pageFooters: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - description: Page footers associated with the chunk. - type: array - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the chunk. - pageHeaders: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - type: array - description: Page headers associated with the chunk. + format: byte + id: GoogleCloudDocumentaiV1RawDocument + description: Payload message of raw document content (bytes). + GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: + description: The response for TrainProcessorVersion. + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse type: object - description: Represents a chunk. - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - GoogleCloudDocumentaiV1DocumentPageTableTableCell: - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell - description: A cell representation inside the table. properties: - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - colSpan: - type: integer - description: How many columns this cell spans. - format: int32 - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for TableCell. - rowSpan: - format: int32 - type: integer - description: How many rows this cell spans. - type: object - GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: - id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - type: object - description: Evaluations metrics, at a specific confidence level. + processorVersion: + description: The resource name of the processor version produced by training. + type: string + GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: + id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata properties: - metrics: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - description: The metrics at the specific confidence level. - confidenceLevel: - format: float - type: number - description: The confidence level. - GoogleCloudDocumentaiV1DocumentSchemaEntityType: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: The long-running operation metadata for the DeleteProcessor method. + type: object + GoogleCloudDocumentaiV1DocumentRevision: properties: - enumValues: + createTime: + format: google-datetime + description: >- + The time that the revision was created, internally generated by doc + proto storage at the time of create. + type: string + humanReview: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + description: Human Review information of this revision. + agent: + type: string description: >- - If specified, lists all the possible values for this entity. This - should not be more than a handful of values. If the number of values - is >10 or could change frequently use the - `EntityType.value_ontology` field and specify a list of all possible - values in a value ontology file. - properties: - type: array + If the change was made by a person specify the name or id of that + person. + parent: + description: >- + The revisions that this revision is based on. This can include one + or more parent (when documents are merged.) This field represents + the index into the `revisions` field. + deprecated: true items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - description: Description the nested structure, or composition of an entity. - baseTypes: + type: integer + format: int32 + type: array + parentIds: items: type: string type: array description: >- - The entity type that this type is derived from. For now, one and - only one should be set. - displayName: - description: User defined name for the type. - type: string - name: + The revisions that this revision is based on. Must include all the + ids that have anything to do with this revision - eg. there are + `provenance.parent.revision` fields that index into this field. + id: + description: >- + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. type: string + processor: description: >- - Name of the type. It must be unique within the schema file and - cannot be a "Common Type". The following naming conventions are - used: - Use `snake_casing`. - Name matching is case-sensitive. - - Maximum 64 characters. - Must start with a letter. - Allowed - characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility - internal infrastructure and tooling can handle any ascii character.) - - The `/` is sometimes used to denote a property of a type. For - example `line_item/amount`. This convention is deprecated, but will - still be honored for backward compatibility. - id: GoogleCloudDocumentaiV1DocumentSchemaEntityType + If the annotation was made by processor identify the processor by + its resource name. + type: string + description: Contains past or forward revisions of this document. + id: GoogleCloudDocumentaiV1DocumentRevision type: object - description: >- - EntityType is the wrapper of a label of the corresponding model with - detailed attributes and limitations for entity-based processors. - Multiple types can also compose a dependency tree to represent nested - types. - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: + GoogleCloudDocumentaiV1ReviewDocumentResponse: + description: Response message for the ReviewDocument method. type: object - properties: {} - description: Response message for the UndeployProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse - GoogleCloudDocumentaiV1ReviewDocumentRequest: + properties: + rejectionReason: + description: The reason why the review is rejected by reviewer. + type: string + gcsDestination: + description: >- + The Cloud Storage uri for the human reviewed document if the review + is succeeded. + type: string + state: + enumDescriptions: + - The default value. This value is used if the state is omitted. + - The review operation is rejected by the reviewer. + - The review operation is succeeded. + type: string + description: The state of the review operation. + enum: + - STATE_UNSPECIFIED + - REJECTED + - SUCCEEDED + id: GoogleCloudDocumentaiV1ReviewDocumentResponse + GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata + type: object + GoogleCloudDocumentaiV1DocumentProvenance: + properties: + type: + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED + type: string + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + description: The type of provenance operation. + enumDescriptions: + - >- + Operation type unspecified. If no operation is specified a + provenance entry is simply used to match against a `parent`. + - Add an element. + - Remove an element identified by `parent`. + - >- + Updates any fields within the given provenance scope of the + message. It overwrites the fields rather than replacing them. Use + this when you want to update a field value of an entity without + also updating all the child properties. + - Currently unused. Replace an element identified by `parent`. + - >- + Deprecated. Request human review for the element identified by + `parent`. + - >- + Deprecated. Element is reviewed and approved at human review, + confidence will be set to 1.0. + - Deprecated. Element is skipped in the validation process. + id: + format: int32 + deprecated: true + type: integer + description: >- + The Id of this operation. Needs to be unique within the scope of the + revision. + revision: + deprecated: true + description: The index of the revision that produced this element. + type: integer + format: int32 + parents: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + type: array + description: References to the original elements that are replaced. + type: object + description: >- + Structure to identify provenance relationships between annotations in + different revisions. + id: GoogleCloudDocumentaiV1DocumentProvenance + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: type: object + description: The metadata that represents a processor version being created. + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + testDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: The test dataset validation information. + trainingDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: The training dataset validation information. + GoogleCloudDocumentaiV1ReviewDocumentRequest: description: Request message for the ReviewDocument method. - id: GoogleCloudDocumentaiV1ReviewDocumentRequest properties: documentSchema: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' @@ -1732,1292 +1610,1528 @@ components: description: >- Whether the validation should be performed on the ad-hoc review request. + inlineDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: An inline document proto. priority: - description: The priority of the human review task. - type: string enumDescriptions: - The default priority level. - >- The urgent priority level. The labeling manager should allocate labeler resource to the urgent task queue to respect this priority level. + description: The priority of the human review task. + type: string enum: - DEFAULT - URGENT - inlineDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: An inline document proto. - GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - type: object - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: - properties: {} - description: Response of the batch update documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse - type: object - GoogleCloudDocumentaiV1GcsPrefix: - description: Specifies all documents on Cloud Storage with a common prefix. - id: GoogleCloudDocumentaiV1GcsPrefix - properties: - gcsUriPrefix: - type: string - description: The URI prefix. - type: object - GoogleCloudDocumentaiV1DocumentPageTable: + id: GoogleCloudDocumentaiV1ReviewDocumentRequest type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: + description: Represents a text type block. properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Table. - detectedLanguages: - type: array - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - bodyRows: - type: array - description: Body rows of the table. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this table. - deprecated: true - headerRows: + blocks: type: array - description: Header rows of the table. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - id: GoogleCloudDocumentaiV1DocumentPageTable - description: A table representation similar to HTML table structure. - GoogleTypeDate: - id: GoogleTypeDate - type: object - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - properties: - day: - format: int32 - type: integer - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - year: - type: integer - format: int32 + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - month: - format: int32 - type: integer + A text block could further have child blocks. Repeated blocks + support further hierarchies and nested blocks. + text: + description: Text content stored in the block. + type: string + type: + type: string description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: + Type of the text in the block. Available options are: `paragraph`, + `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + `heading-5`, `header`, `footer`. id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - description: Represents where the block starts and ends in the document. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock type: object - properties: - pageEnd: - type: integer - format: int32 - description: Page where block ends in the document. - pageStart: - description: Page where block starts in the document. - format: int32 - type: integer - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: + description: Response message for the DeployProcessorVersion method. type: object + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + properties: {} + GoogleCloudDocumentaiV1DocumentSchemaEntityType: properties: - sampleTrainingStatus: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of sampling documents in training split. - sampleTestStatus: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of sampling documents in test split. - selectedDocuments: + properties: type: array - description: The result of the sampling process. + description: Description the nested structure, or composition of an entity. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument - description: Response of the sample documents operation. - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: - type: object - description: Response message for the UndeployProcessorVersion method. - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse - properties: {} - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: - type: object - properties: - commonMetadata: + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + displayName: + type: string + description: User defined name for the type. + enumValues: + description: >- + If specified, lists all the possible values for this entity. This + should not be more than a handful of values. If the number of values + is >10 or could change frequently use the + `EntityType.value_ontology` field and specify a list of all possible + values in a value ontology file. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues + name: + description: >- + Name of the type. It must be unique within the schema file and + cannot be a "Common Type". The following naming conventions are + used: - Use `snake_casing`. - Name matching is case-sensitive. - + Maximum 64 characters. - Must start with a letter. - Allowed + characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility + internal infrastructure and tooling can handle any ascii character.) + - The `/` is sometimes used to denote a property of a type. For + example `line_item/amount`. This convention is deprecated, but will + still be honored for backward compatibility. + type: string + baseTypes: + description: >- + The entity type that this type is derived from. For now, one and + only one should be set. + type: array + items: + type: string description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + EntityType is the wrapper of a label of the corresponding model with + detailed attributes and limitations for entity-based processors. + Multiple types can also compose a dependency tree to represent nested + types. + type: object + id: GoogleCloudDocumentaiV1DocumentSchemaEntityType + GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: + description: The response message for the ImportProcessorVersion method. + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse + type: object + properties: + processorVersion: + type: string + description: The destination processor version name. + GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: + type: object properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata for the long-running operation. - type: object - description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata + description: The long-running operation metadata for the DeleteProcessor method. + GoogleLongrunningOperation: description: >- - Represents a block. A block could be one of the various types (text, - table, list) supported. - id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + This resource represents a long-running operation that is the result of + a network API call. + type: object properties: - tableBlock: - description: Block consisting of table content/structure. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - textBlock: - description: Block consisting of text content. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - listBlock: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - description: Block consisting of list content/structure. - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - description: Page span of the block. - blockId: + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + metadata: + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - description: ID of the block. - type: object - GoogleCloudDocumentaiV1ProcessResponse: - type: object - description: Response message for the ProcessDocument method. + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + id: GoogleLongrunningOperation + GoogleCloudDocumentaiV1DocumentPageMatrix: properties: - humanReviewStatus: - description: The status of human review on the processed document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' - document: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + rows: + description: Number of rows in the matrix. + format: int32 + type: integer + cols: + type: integer + format: int32 + description: Number of columns in the matrix. + data: + format: byte + type: string + description: The matrix data. + type: description: >- - The document payload, will populate fields based on the processor's - behavior. - id: GoogleCloudDocumentaiV1ProcessResponse - GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: - description: Information about the upcoming deprecation of this processor version. + This encodes information about what data type the matrix uses. For + example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of + OpenCV primitive data types, please refer to + https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + type: integer + format: int32 type: object - id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + description: >- + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. + id: GoogleCloudDocumentaiV1DocumentPageMatrix + GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: properties: - replacementProcessorVersion: - type: string - description: If set, the processor version that will be used as a replacement. - deprecationTime: - format: google-datetime - description: The time at which this processor version will be deprecated. + gcsDestination: type: string - GoogleCloudDocumentaiV1beta3HumanReviewStatus: - properties: - humanReviewOperation: description: >- - The name of the operation triggered by the processed document. This - field is populated only when the state is - `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and - metadata as the long-running operation returned by ReviewDocument. - type: string - stateMessage: - description: A message providing more details about the human review state. - type: string + The Cloud Storage uri for the human reviewed document if the review + is succeeded. state: - enumDescriptions: - - >- - Human review state is unspecified. Most likely due to an internal - error. - - >- - Human review is skipped for the document. This can happen because - human review isn't enabled on the processor or the processing - request has been set to skip this document. - - >- - Human review validation is triggered and passed, so no review is - needed. - - >- - Human review validation is triggered and the document is under - review. - - >- - Some error happened during triggering human review, see the - state_message for details. + description: The state of the review operation. enum: - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR - description: The state of human review on the processing request. + - REJECTED + - SUCCEEDED + type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - The review operation is rejected by the reviewer. + - The review operation is succeeded. + rejectionReason: + description: The reason why the review is rejected by reviewer. type: string - description: The status of human review on a processed document. - id: GoogleCloudDocumentaiV1beta3HumanReviewStatus - type: object - GoogleCloudDocumentaiV1beta3Dataset: type: object - description: >- - A singleton resource under a Processor which configures a collection of - documents. - id: GoogleCloudDocumentaiV1beta3Dataset + description: Response message for the ReviewDocument method. + id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: properties: - name: + datasetErrorCount: + format: int32 + description: The total number of dataset errors. + type: integer + documentErrors: description: >- - Dataset resource name. Format: - `projects/{project}/locations/{location}/processors/{processor}/dataset` - type: string - state: - enumDescriptions: - - Default unspecified enum, should not be used. - - Dataset has not been initialized. - - Dataset is being initialized. - - Dataset has been initialized. - enum: - - STATE_UNSPECIFIED - - UNINITIALIZED - - INITIALIZING - - INITIALIZED - description: Required. State of the dataset. Ignored when updating dataset. - type: string - spannerIndexingConfig: - description: >- - Optional. A lightweight indexing source with low latency and high - reliability, but lacking advanced features like CMEK and - content-based search. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - documentWarehouseConfig: - deprecated: true - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - description: >- - Optional. Deprecated. Warehouse-based dataset configuration is not - supported. - satisfiesPzs: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - unmanagedDatasetConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - description: >- - Optional. Unmanaged dataset configuration. Use this configuration if - the dataset documents are managed by the document service internally - (not user-managed). - gcsManagedConfig: + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + documentErrorCount: + type: integer + description: The total number of document errors. + format: int32 + datasetErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Optional. User-managed Cloud Storage dataset configuration. Use this - configuration if the dataset documents are stored under a - user-managed Cloud Storage location. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig - GoogleCloudLocationLocation: - description: A resource that represents a Google Cloud location. - id: GoogleCloudLocationLocation + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. + type: array + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + type: object + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata + description: Metadata of the auto-labeling documents operation. + type: object properties: - displayName: - type: string - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - locationId: - type: string - description: 'The canonical id for this location. For example: `"us-east1"`.' - metadata: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - Service-specific metadata. For example the available capacity at the - given location. - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - labels: - additionalProperties: - type: string + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + totalDocumentCount: + type: integer + format: int32 + description: Total number of the auto-labeling documents. + individualAutoLabelStatuses: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object + The list of individual auto-labeling statuses of the dataset + documents. + GoogleCloudDocumentaiV1DocumentPageLayout: type: object - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: - description: The configuration used when outputting documents. - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + id: GoogleCloudDocumentaiV1DocumentPageLayout properties: - shardingConfig: - description: Specifies the sharding config for the output document. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - gcsUri: - description: The Cloud Storage uri (a directory) of the output. + orientation: type: string - fieldMask: + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + enumDescriptions: + - Unspecified orientation. + - Orientation is aligned with page up. + - >- + Orientation is aligned with page right. Turn the head 90 degrees + clockwise from upright to read. + - >- + Orientation is aligned with page down. Turn the head 180 degrees + from upright to read. + - >- + Orientation is aligned with page left. Turn the head 90 degrees + counterclockwise from upright to read. + description: Detected orientation for the Layout. + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + boundingPoly: + description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + confidence: description: >- - Specifies which fields to include in the output documents. Only - supports top level document and pages field so it must be in the - form of `{document_field_name}` or `pages.{page_field_name}`. - format: google-fieldmask - type: string + Confidence of the current Layout within context of the object this + layout is for. e.g. confidence can be for a single token, a table, a + visual element, etc. depending on context. Range `[0, 1]`. + format: float + type: number + description: Visual element describing a layout unit on a page. + GoogleCloudDocumentaiV1DeployProcessorVersionResponse: + properties: {} + description: Response message for the DeployProcessorVersion method. type: object - GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: + id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse + GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: type: object - id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse - description: Response message for the ReviewDocument method. + description: Information about the upcoming deprecation of this processor version. + id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo properties: - gcsDestination: - type: string - description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. - state: - description: The state of the review operation. + replacementProcessorVersion: + description: If set, the processor version that will be used as a replacement. type: string - enumDescriptions: - - The default value. This value is used if the state is omitted. - - The review operation is rejected by the reviewer. - - The review operation is succeeded. - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - rejectionReason: + deprecationTime: + description: The time at which this processor version will be deprecated. + format: google-datetime type: string - description: The reason why the review is rejected by reviewer. - GoogleCloudDocumentaiV1EnableProcessorMetadata: - description: The long-running operation metadata for the EnableProcessor method. + GoogleCloudDocumentaiV1DisableProcessorRequest: type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - id: GoogleCloudDocumentaiV1EnableProcessorMetadata - GoogleCloudDocumentaiV1DisableProcessorMetadata: - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + id: GoogleCloudDocumentaiV1DisableProcessorRequest + properties: {} + description: Request message for the DisableProcessor method. + GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: + properties: {} + description: Response message for the UndeployProcessorVersion method. type: object - id: GoogleCloudDocumentaiV1DisableProcessorMetadata - description: The long-running operation metadata for the DisableProcessor method. - GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - description: The input data used to train a new ProcessorVersion. + id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse + GoogleCloudDocumentaiV1DisableProcessorResponse: + type: object + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + properties: {} + id: GoogleCloudDocumentaiV1DisableProcessorResponse + GoogleCloudDocumentaiV1DocumentDocumentLayout: + description: >- + Represents the parsed layout of a document as a collection of blocks + that the document is divided into. + id: GoogleCloudDocumentaiV1DocumentDocumentLayout properties: - testDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The documents used for testing the trained version. - trainingDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The documents used for training the new version. + blocks: + type: array + description: List of blocks in the document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock type: object - GoogleLongrunningOperation: + GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: type: object + description: Response message for the SetDefaultProcessorVersion method. + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse + properties: {} + GoogleCloudDocumentaiV1DocumentPageVisualElement: + id: GoogleCloudDocumentaiV1DocumentPageVisualElement description: >- - This resource represents a long-running operation that is the result of - a network API call. - properties: - response: + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + type: object + properties: + type: + description: Type of the VisualElement. + type: string + layout: + description: Layout for VisualElement. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: + properties: + individualImportStatuses: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + type: array + description: The list of response details of each document. + importConfigValidationResults: + type: array + description: Validation statuses of the batch documents import config. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + totalDocumentCount: + format: int32 + description: Total number of the documents that are qualified for importing. + type: integer + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: Metadata of the import document operation. + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + type: object + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse + type: object + properties: {} + description: Response of the delete documents operation. + GoogleCloudDocumentaiV1ProcessorVersionAlias: + description: Contains the alias and the aliased resource name of processor version. + type: object + properties: + alias: + type: string + description: The alias in the form of `processor_version` resource name. + processorVersion: + type: string + description: The resource name of aliased processor version. + id: GoogleCloudDocumentaiV1ProcessorVersionAlias + GoogleCloudDocumentaiV1OcrConfig: + description: Config for Document OCR. + id: GoogleCloudDocumentaiV1OcrConfig + properties: + disableCharacterBoxesDetection: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - done: + Turn off character box detector in OCR engine. Character box + detection is enabled by default in OCR 2.0 (and later) processors. type: boolean + premiumFeatures: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' + description: Configurations for premium OCR features. + enableImageQualityScores: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - metadata: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + Enables intelligent document quality scores after OCR. Can help with + diagnosing why OCR responses are of poor quality for a given input. + Adds additional latency comparable to regular OCR to the process + call. + type: boolean + computeStyleInfo: + type: boolean description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - name: + Turn on font identification model and return font style information. + Deprecated, use PremiumFeatures.compute_style_info instead. + deprecated: true + hints: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' + description: Hints for the OCR model. + enableNativePdfParsing: + type: boolean description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - error: + Enables special handling for PDFs with existing text information. + Results in better text extraction quality in such PDF inputs. + enableSymbol: + description: Includes symbol level OCR information if set to true. + type: boolean + advancedOcrOptions: + type: array description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - id: GoogleLongrunningOperation - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: - `legacy_layout`: a heuristics layout + detection algorithm, which serves as an alternative to the current + ML-based layout detection algorithm. Customers can choose the best + suitable layout algorithm based on their situation. + items: + type: string + type: object + GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: + description: Response of the import document operation. + properties: {} + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse + type: object + GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: + id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId properties: - text: - description: Footer in text format. + gcsUri: type: string - pageSpan: - description: Page span of the footer. + description: Required. The Cloud Storage URI where the actual document is stored. + cwDocId: + description: Id of the document (indexed) managed by Content Warehouse. + deprecated: true + type: string + type: object + description: >- + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. + GoogleCloudDocumentaiV1beta3GcsPrefix: + id: GoogleCloudDocumentaiV1beta3GcsPrefix + properties: + gcsUriPrefix: + type: string + description: The URI prefix. + description: Specifies all documents on Cloud Storage with a common prefix. + type: object + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: + properties: + shardingConfig: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Represents the page footer associated with the chunk. - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + description: Specifies the sharding config for the output document. + gcsUri: + description: The Cloud Storage uri (a directory) of the output. + type: string + fieldMask: + format: google-fieldmask + type: string + description: >- + Specifies which fields to include in the output documents. Only + supports top level document and pages field so it must be in the + form of `{document_field_name}` or `pages.{page_field_name}`. + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + description: The configuration used when outputting documents. type: object - GoogleCloudDocumentaiV1DocumentProvenance: + GoogleCloudDocumentaiV1DocumentPage: type: object - id: GoogleCloudDocumentaiV1DocumentProvenance - description: >- - Structure to identify provenance relationships between annotations in - different revisions. + description: A page in a Document. properties: - id: + imageQualityScores: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + description: Image quality scores. + detectedBarcodes: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + description: A list of detected barcodes. + provenance: deprecated: true - format: int32 + description: The history of this page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + formFields: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + description: A list of visually detected form fields on the page. + type: array + tokens: + description: A list of visually detected tokens on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + blocks: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + type: array description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - type: integer - type: - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - description: The type of provenance operation. - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - type: string - revision: - description: The index of the revision that produced this element. + A list of visually detected text blocks on the page. A block has a + set of lines (collected into paragraphs) that have a common + line-spacing and orientation. + transforms: + description: >- + Transformation matrices that were applied to the original document + image to produce Page.image. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + type: array + pageNumber: format: int32 + description: >- + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. type: integer - deprecated: true - parents: + detectedLanguages: + description: A list of detected languages together with confidence. type: array - description: References to the original elements that are replaced. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent - GoogleCloudDocumentaiV1TrainProcessorVersionRequest: - description: Request message for the TrainProcessorVersion method. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + lines: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' + type: array + description: >- + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. + tables: + type: array + description: A list of visually detected tables on the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' + image: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + description: >- + Rendered image for this page. This image is preprocessed to remove + any skew, rotation, and distortions such that the annotation + bounding boxes can be upright and axis-aligned. + paragraphs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' + description: >- + A list of visually detected text paragraphs on the page. A + collection of lines that a human would perceive as a paragraph. + layout: + description: Layout for the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + symbols: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' + description: A list of visually detected symbols on the page. + type: array + visualElements: + description: >- + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + type: array + dimension: + description: Physical dimension of the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + id: GoogleCloudDocumentaiV1DocumentPage + GoogleCloudDocumentaiV1DocumentStyle: + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. + id: GoogleCloudDocumentaiV1DocumentStyle + properties: + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + color: + description: Text color. + $ref: '#/components/schemas/GoogleTypeColor' + fontSize: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' + description: Font size. + textDecoration: + description: >- + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + type: string + textStyle: + description: >- + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. + type: string + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text background color. + fontWeight: + type: string + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + fontFamily: + type: string + description: >- + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + type: object + GoogleCloudDocumentaiV1FetchProcessorTypesResponse: + type: object + properties: + processorTypes: + type: array + description: The list of processor types. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse + description: Response message for the FetchProcessorTypes method. + GoogleCloudLocationListLocationsResponse: + description: The response message for Locations.ListLocations. properties: - processorVersion: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - description: Required. The processor version to be created. - baseProcessorVersion: + nextPageToken: type: string + description: The standard List next-page token. + locations: + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' description: >- - Optional. The processor version to use as a base for training. This - processor version must be a child of `parent`. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. - inputData: - description: Optional. The input data used to train the ProcessorVersion. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - customDocumentExtractionOptions: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions - description: Options to control Custom Document Extraction (CDE) Processor. - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: Optional. The schema the processor version will be trained with. - foundationModelTuningOptions: - description: Options to control foundation model tuning of a processor. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions - type: object - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest - GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: - description: Configuration specific to an unmanaged dataset. + A list of locations that matches the specified filter in the + request. + type: array type: object - id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - properties: {} - GoogleCloudDocumentaiV1Processor: - id: GoogleCloudDocumentaiV1Processor + id: GoogleCloudLocationListLocationsResponse + GoogleCloudDocumentaiV1beta3Dataset: properties: + documentWarehouseConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + description: >- + Optional. Deprecated. Warehouse-based dataset configuration is not + supported. + deprecated: true + gcsManagedConfig: + description: >- + Optional. User-managed Cloud Storage dataset configuration. Use this + configuration if the dataset documents are stored under a + user-managed Cloud Storage location. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + name: + type: string + description: >- + Dataset resource name. Format: + `projects/{project}/locations/{location}/processors/{processor}/dataset` state: enumDescriptions: - - The processor is in an unspecified state. - - >- - The processor is enabled, i.e., has an enabled version which can - currently serve processing requests and all the feature - dependencies have been successfully initialized. - - The processor is disabled. - - >- - The processor is being enabled, will become `ENABLED` if - successful. - - >- - The processor is being disabled, will become `DISABLED` if - successful. - - >- - The processor is being created, will become either `ENABLED` (for - successful creation) or `FAILED` (for failed ones). Once a - processor is in this state, it can then be used for document - processing, but the feature dependencies of the processor might - not be fully created yet. - - >- - The processor failed during creation or initialization of feature - dependencies. The user should delete the processor and recreate - one as all the functionalities of the processor are disabled. - - The processor is being deleted, will be removed if successful. - readOnly: true - description: Output only. The state of the processor. + - Default unspecified enum, should not be used. + - Dataset has not been initialized. + - Dataset is being initialized. + - Dataset has been initialized. + description: Required. State of the dataset. Ignored when updating dataset. + type: string enum: - STATE_UNSPECIFIED - - ENABLED - - DISABLED - - ENABLING - - DISABLING - - CREATING - - FAILED - - DELETING - type: string - createTime: - description: The time the processor was created. - format: google-datetime - type: string - defaultProcessorVersion: - description: The default processor version. - type: string - processorVersionAliases: - description: Output only. The processor version aliases. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' + - UNINITIALIZED + - INITIALIZING + - INITIALIZED + satisfiesPzi: + description: Output only. Reserved for future use. readOnly: true - type: array + type: boolean satisfiesPzs: description: Output only. Reserved for future use. type: boolean readOnly: true - displayName: - description: The display name of the processor. - type: string - processEndpoint: - readOnly: true + spannerIndexingConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig description: >- - Output only. Immutable. The http endpoint that can be called to - invoke processing. - type: string - kmsKeyName: + Optional. A lightweight indexing source with low latency and high + reliability, but lacking advanced features like CMEK and + content-based search. + unmanagedDatasetConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig + description: >- + Optional. Unmanaged dataset configuration. Use this configuration if + the dataset documents are managed by the document service internally + (not user-managed). + description: >- + A singleton resource under a Processor which configures a collection of + documents. + id: GoogleCloudDocumentaiV1beta3Dataset + type: object + GoogleCloudDocumentaiV1DocumentPageDimension: + id: GoogleCloudDocumentaiV1DocumentPageDimension + type: object + properties: + height: + type: number + description: Page height. + format: float + unit: type: string + description: Dimension unit. + width: + format: float + type: number + description: Page width. + description: Dimension for the page. + GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig: + type: object + id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig + description: Serving config for chunking. + properties: + chunkSize: + type: integer description: >- - The [KMS key](https://cloud.google.com/security-key-management) used - for encryption and decryption in CMEK scenarios. - satisfiesPzi: - description: Output only. Reserved for future use. + Optional. The chunk sizes to use when splitting documents, in order + of level. + format: int32 + includeAncestorHeadings: type: boolean - readOnly: true - name: - readOnly: true description: >- - Output only. Immutable. The resource name of the processor. Format: - `projects/{project}/locations/{location}/processors/{processor}` + Optional. Whether or not to include ancestor headings when + splitting. + GoogleCloudDocumentaiV1DocumentPageTableTableCell: + properties: + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + layout: + description: Layout for TableCell. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + rowSpan: + format: int32 + description: How many rows this cell spans. + type: integer + colSpan: + type: integer + description: How many columns this cell spans. + format: int32 + type: object + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: A cell representation inside the table. + GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: Metadata of the EvaluateProcessorVersion method. + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: + description: Response message for the SetDefaultProcessorVersion method. + properties: {} + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse + type: object + GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: + description: Metadata of the sample documents operation. + type: object + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: + properties: {} + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + type: object + GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: + properties: + gcsPrefix: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' + description: >- + Required. The Cloud Storage URI (a directory) where the documents + belonging to the dataset must be stored. + type: object + id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + description: Configuration specific to the Cloud Storage-based implementation. + GoogleCloudDocumentaiV1Barcode: + id: GoogleCloudDocumentaiV1Barcode + description: Encodes the detailed information of a barcode. + type: object + properties: + valueFormat: + type: string + description: >- + Value format describes the format of the value that a barcode + encodes. The supported formats are: - `CONTACT_INFO`: Contact + information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - + `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - + `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi + information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar + event. - `DRIVER_LICENSE`: Driver's license. + rawValue: + description: >- + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. type: string - type: + format: type: string description: >- - The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. - To get a list of processor types, see FetchProcessorTypes. - description: >- - The first-class citizen for Document AI. Each processor defines how to - extract structural information from a document. - type: object - GoogleCloudDocumentaiV1CommonOperationMetadata: + Format of a barcode. The supported formats are: - `CODE_128`: Code + 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - + `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - + `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - + `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E + type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - + `DATABAR`: GS1 DataBar code type. + GoogleCloudDocumentaiV1beta3CommonOperationMetadata: + description: The common metadata for long running operations. properties: resource: - description: A related resource to this operation. type: string - state: + description: A related resource to this operation. + createTime: + description: The creation time of the operation. + format: google-datetime type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - description: The state of the operation. stateMessage: type: string description: >- A message providing more details about the current state of processing. - createTime: - format: google-datetime - type: string - description: The creation time of the operation. updateTime: format: google-datetime + type: string description: The last update time of the operation. + state: + description: The state of the operation. + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. type: string + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED type: object - id: GoogleCloudDocumentaiV1CommonOperationMetadata - description: The common metadata for long running operations. - GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata + id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1DocumentEntity: + id: GoogleCloudDocumentaiV1DocumentEntity type: object description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1ProcessRequest: + An entity that could be a phrase in the text or a property that belongs + to the document. It is a known entity type, such as a person, an + organization, or location. properties: - labels: - type: object - description: >- - Optional. The labels with user-defined metadata for the request. - 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. - additionalProperties: - type: string - inlineDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: An inline document proto. - skipHumanReview: + redacted: description: >- - Whether human review should be skipped for this request. Default to - `false`. + Optional. Whether the entity will be redacted for de-identification + purposes. type: boolean - fieldMask: + id: + type: string description: >- - Specifies which fields to include in the ProcessResponse.document - output. Only supports top-level document and pages field, so it must - be in the form of `{document_field_name}` or - `pages.{page_field_name}`. + Optional. Canonical id. This will be a unique value in the entity + list for this document. + pageAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' + description: >- + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + mentionText: + description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. type: string - format: google-fieldmask - rawDocument: - description: A raw document content (bytes). - $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' - gcsDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' - description: A raw document on Google Cloud Storage. - processOptions: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - description: Inference-time options for the process API - imagelessMode: - type: boolean - description: Optional. Option to remove images from the document. - id: GoogleCloudDocumentaiV1ProcessRequest - description: Request message for the ProcessDocument method. - type: object - GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: - description: The long-running operation metadata for DeleteLabelerPool. - id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata + mentionId: + type: string + description: Optional. Deprecated. Use `id` field instead. + properties: + description: >- + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + type: array + type: + type: string + description: Required. Entity type from a schema e.g. `Address`. + provenance: + description: Optional. The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + confidence: + type: number + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + format: float + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: >- + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + normalizedValue: + description: >- + Optional. Normalized entity value. Absent if the extracted value + could not be converted or the type (e.g. address) is not supported + for certain parsers. This field is also only populated for certain + supported document types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: type: object + properties: + status: + description: The status of moving the document. + $ref: '#/components/schemas/GoogleRpcStatus' + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document id of the document. + description: The status of each individual document in the batch move process. + id: >- + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: properties: commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: - properties: - finetuningAllowed: - type: boolean - description: Whether finetuning is allowed for this base processor version. - minTrainLabeledDocuments: - description: >- - The minimum number of labeled documents in the training dataset - required for finetuning. - format: int32 - type: integer - id: >- - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo - description: Information for a pretrained Google-managed foundation model. + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata type: object - GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. + GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig: properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata + chunkingConfig: + description: Optional. Config for chunking in layout parser processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig + id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig + description: Serving config for layout parser processor. type: object - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: - description: The sharding config for the output document. + GoogleTypeTimeZone: type: object + id: GoogleTypeTimeZone + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). properties: - pagesPerShard: - type: integer - format: int32 - description: The number of pages per shard. - pagesOverlap: - type: integer - format: int32 - description: The number of overlapping pages between consecutive shards. - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: + version: + description: Optional. IANA Time Zone Database version number, e.g. "2019a". + type: string + id: + type: string + description: IANA Time Zone Database time zone, e.g. "America/New_York". + GoogleTypePostalAddress: + type: object properties: - documentId: - description: An internal identifier for document. + languageCode: + description: >- + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + type: string + addressLines: + type: array + items: + type: string + description: >- + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (e.g. "Austin, TX"), it is important that the line order is + clear. The order of address lines should be "envelope order" for the + country/region of the address. In places where this can vary (e.g. + Japan), address_language is used to make it explicit (e.g. "ja" for + large-to-small ordering and "ja-Latn" or "en" for small-to-large). + This way, the most specific line of an address can be selected based + on the language. The minimum permitted structural representation of + an address consists of a region_code with all remaining information + placed in the address_lines. It would be possible to format such an + address very approximately without geocoding, but no semantic + reasoning could be made about any of the address components until it + was at least partially resolved. Creating an address only containing + a region_code and address_lines, and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). + organization: type: string - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument - type: object - GoogleCloudDocumentaiV1DocumentProvenanceParent: - id: GoogleCloudDocumentaiV1DocumentProvenanceParent - type: object - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - properties: - id: - deprecated: true - format: int32 - description: The id of the parent provenance. - type: integer - index: + description: Optional. The name of the organization at the address. + revision: + description: >- + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. format: int32 type: integer + administrativeArea: + type: string description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. - revision: - type: integer - description: The index of the index into current revision's parent_ids list. - format: int32 - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: - properties: - layoutType: - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. Specifically, for + Spain this is the province and not the autonomous community (e.g. + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. E.g. in Switzerland this + should be left unpopulated. + locality: description: >- - Optional. The type of the layout element that is being referenced if - any. + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. + type: string + postalCode: type: string - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD - boundingPoly: description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - layoutId: - description: Optional. Deprecated. Use PageRef.bounding_poly instead. + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (e.g. state/zip validation in the U.S.A.). + sublocality: type: string - deprecated: true - page: - format: int64 + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + regionCode: type: string description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - confidence: - type: number - format: float + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + sortingCode: description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - type: object - description: Represents a weak reference to a page element within a document. - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: - type: object + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). + type: string + recipients: + description: >- + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. + items: + type: string + type: array + id: GoogleTypePostalAddress description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. - id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 + GoogleCloudDocumentaiV1TrainProcessorVersionRequest: + description: Request message for the TrainProcessorVersion method. + type: object properties: - docId: - description: Required. The id of the document. + foundationModelTuningOptions: + description: Options to control foundation model tuning of a processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions + customDocumentExtractionOptions: + description: Options to control Custom Document Extraction (CDE) Processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + inputData: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + description: Optional. The input data used to train the ProcessorVersion. + processorVersion: + description: Required. The processor version to be created. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + documentSchema: + description: Optional. The schema the processor version will be trained with. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + baseProcessorVersion: + description: >- + Optional. The processor version to use as a base for training. This + processor version must be a child of `parent`. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. type: string - GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: properties: - auprcExact: - format: float + stateMessage: + type: string description: >- - The AUPRC for metrics with fuzzy matching disabled, i.e., exact - matching only. - type: number - confidenceLevelMetricsExact: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - description: Metrics across confidence levels with only exact matching. - type: array - confidenceLevelMetrics: - description: Metrics across confidence levels with fuzzy matching enabled. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - type: array - metricsType: - enumDescriptions: - - >- - The metrics type is unspecified. By default, metrics without a - particular specification are for leaf entity types (i.e., - top-level entity types without child types, or child types which - are not parent types themselves). - - >- - Indicates whether metrics for this particular label type represent - an aggregate of metrics for other types instead of being based on - actual TP/FP/FN values for the label type. Metrics for parent - (i.e., non-leaf) entity types are an aggregate of metrics for - their children. - description: The metrics type for the label. + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. + state: type: string - enum: - - METRICS_TYPE_UNSPECIFIED - - AGGREGATE - auprc: + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + type: object + description: Human Review information of the document. + GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: + description: Response message for the DeployProcessorVersion method. + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse + properties: {} + type: object + GoogleCloudDocumentaiUiv1beta3DocumentId: + id: GoogleCloudDocumentaiUiv1beta3DocumentId + properties: + gcsManagedDocId: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId + description: A document id within user-managed Cloud Storage. + unmanagedDocId: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + description: A document id within unmanaged dataset. + revisionRef: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' + description: Points to a specific revision of the document if set. + type: object + description: Document Identifier. + GoogleCloudDocumentaiV1beta3BatchProcessResponse: + type: object + properties: {} + description: Response message for BatchProcessDocuments. + id: GoogleCloudDocumentaiV1beta3BatchProcessResponse + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: + properties: + learningRateMultiplier: format: float - description: >- - The calculated area under the precision recall curve (AUPRC), - computed by integrating over all confidence thresholds. type: number - estimatedCalibrationErrorExact: description: >- - The ECE for the predicted entities with fuzzy matching disabled, - i.e., exact matching only. - type: number - format: float - estimatedCalibrationError: - type: number - format: float + Optional. The multiplier to apply to the recommended learning rate. + Valid values are between 0.1 and 10. If not provided, recommended + learning rate will be used. + trainSteps: + format: int32 description: >- - The Estimated Calibration Error (ECE) of the confidence of the - predicted entities. - description: Metrics across multiple confidence levels. - id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + Optional. The number of steps to run for model tuning. Valid values + are between 1 and 400. If not provided, recommended steps will be + used. + type: integer + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions + description: Options to control foundation model tuning of the processor. type: object - GoogleCloudDocumentaiUiv1beta3RevisionRef: - description: The revision reference specifies which revision on the document to read. - id: GoogleCloudDocumentaiUiv1beta3RevisionRef + GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: type: object + description: The long-running operation metadata for the ReviewDocument method. + id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata properties: - revisionId: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + questionId: type: string - description: Reads the revision given by the id. - latestProcessorVersion: - description: >- - Reads the revision generated by the processor version. The format - takes the full resource name of processor version. - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + description: The Crowd Compute question ID. + GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + createTime: + format: google-datetime type: string - revisionCase: + description: The creation time of the operation. + stateMessage: type: string - description: Reads the revision by the predefined case. - enumDescriptions: - - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. - - The latest revision made by a human. - - The latest revision based on timestamp. - - The first (OCR) revision. + description: >- + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + state: enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + type: string + description: Used only when Operation.done is false. + questionId: + description: The Crowd Compute question ID. + type: string + description: The long-running operation metadata for the ReviewDocument method. + id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + type: object + GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + type: object + description: The long-running operation metadata for the EnableProcessor method. properties: - testDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - trainingDatasetValidation: - description: The training dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues + description: Defines the a list of enum values. type: object - description: The metadata that represents a processor version being created. - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse - properties: {} + properties: + values: + type: array + description: The individual values that this enum values type can include. + items: + type: string + GoogleCloudDocumentaiV1DocumentProvenanceParent: + type: object + description: >- + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. + properties: + index: + format: int32 + type: integer + description: >- + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. + revision: + description: The index of the index into current revision's parent_ids list. + type: integer + format: int32 + id: + description: The id of the parent provenance. + format: int32 + deprecated: true + type: integer + id: GoogleCloudDocumentaiV1DocumentProvenanceParent + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + description: Represents a table type block. type: object - description: Response message for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock properties: - inputGcsSource: + caption: + description: Table caption/title. type: string - description: The source Cloud Storage URI of the document. - status: - description: The status of the importing of the document. - $ref: '#/components/schemas/GoogleRpcStatus' - outputDocumentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' - description: >- - The document id of imported document if it was successful, otherwise - empty. - description: The status of each individual document in the import process. + headerRows: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Header rows at the top of the table. + type: array + bodyRows: + description: Body rows containing main table content. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + type: array + GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: + description: >- + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. type: object + properties: + gcsUri: + description: Required. The Cloud Storage URI where the actual document is stored. + type: string + cwDocId: + type: string + deprecated: true + description: Id of the document (indexed) managed by Content Warehouse. + id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId GoogleCloudDocumentaiV1beta3EnableProcessorResponse: properties: {} description: >- Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. - id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse type: object - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: + properties: + individualBatchUpdateStatuses: + description: The list of response details of each document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + type: array + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata type: object - description: Font and other text style attributes. - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata + GoogleCloudDocumentaiV1DocumentSchemaMetadata: properties: - strikeout: - type: boolean - description: >- - Whether the text is strikethrough. This feature is not supported - yet. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - bold: - type: boolean - description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - superscript: - description: >- - Whether the text is a superscript. This feature is not supported - yet. - type: boolean - fontSize: - type: integer - format: int32 - description: Font size in points (`1` point is `¹⁄₇₂` inches). - letterSpacing: - type: number - description: Letter spacing in points. - format: double - textColor: - description: Color of the text. - $ref: '#/components/schemas/GoogleTypeColor' - fontWeight: - type: integer - description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - format: int32 - smallcaps: + documentSplitter: description: >- - Whether the text is in small caps. This feature is not supported - yet. - type: boolean - underlined: - description: Whether the text is underlined. + If true, a `document` entity type can be applied to subdocument + (splitting). Otherwise, it can only be applied to the entire + document (classification). type: boolean - fontType: - type: string - description: Name or style of the font. - handwritten: - description: Whether the text is handwritten. + prefixedNamingOnProperties: type: boolean - subscript: + description: If set, all the nested entities must be prefixed with the parents. + documentAllowMultipleLabels: type: boolean - description: Whether the text is a subscript. This feature is not supported yet. - pixelFontSize: - type: number - format: double description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - italic: + If true, on a given page, there can be multiple `document` + annotations covering it. + skipNamingValidation: + description: >- + If set, we will skip the naming format validation in the schema. So + the string values in `DocumentSchema.EntityType.name` and + `DocumentSchema.EntityType.Property.name` will not be checked. type: boolean - description: Whether the text is italic. - GoogleCloudDocumentaiV1HumanReviewStatus: + id: GoogleCloudDocumentaiV1DocumentSchemaMetadata + description: Metadata for global schema behavior. + type: object + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. + type: object properties: - state: - type: string - description: The state of human review on the processing request. - enumDescriptions: - - >- - Human review state is unspecified. Most likely due to an internal - error. - - >- - Human review is skipped for the document. This can happen because - human review isn't enabled on the processor or the processing - request has been set to skip this document. - - >- - Human review validation is triggered and passed, so no review is - needed. - - >- - Human review validation is triggered and the document is under - review. - - >- - Some error happened during triggering human review, see the - state_message for details. - enum: - - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR - stateMessage: - description: A message providing more details about the human review state. - type: string - humanReviewOperation: - type: string - description: >- - The name of the operation triggered by the processed document. This - field is populated only when the state is - `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and - metadata as the long-running operation returned by ReviewDocument. - description: The status of human review on a processed document. - id: GoogleCloudDocumentaiV1HumanReviewStatus + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata for the long-running operation. + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: type: object - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - totalDocumentCount: - format: int32 - type: integer - description: Total number of the auto-labeling documents. - individualAutoLabelStatuses: + description: The common metadata about the operation. + description: Metadata message associated with the ExportProcessorVersion operation. + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: + type: object + properties: + blocks: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock type: array description: >- - The list of individual auto-labeling statuses of the dataset - documents. + A list entry is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + description: Represents an entry in the list. + GoogleCloudDocumentaiV1DocumentEntityRelation: type: object - description: Metadata of the auto-labeling documents operation. - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata - GoogleCloudDocumentaiV1DocumentPageAnchor: + description: Relationship between Entities. + id: GoogleCloudDocumentaiV1DocumentEntityRelation properties: - pageRefs: - type: array - description: One or more references to visual page elements - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + relation: + type: string + description: Relationship description. + objectId: + type: string + description: Object entity id. + subjectId: + type: string + description: Subject entity id. + GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: + description: The status of a each individual document in the batch process. + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus type: object - description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. - id: GoogleCloudDocumentaiV1DocumentPageAnchor - GoogleTypeMoney: properties: - units: - format: int64 + humanReviewOperation: + deprecated: true + type: string description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + The name of the operation triggered by the processed document. If + the human review process isn't triggered, this field will be empty. + It has the same response type and metadata as the long-running + operation returned by the ReviewDocument method. + outputGcsDestination: type: string - nanos: - format: int32 - type: integer description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - currencyCode: - description: The three-letter currency code defined in ISO 4217. + The Cloud Storage output destination (in the request as + DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed + document if it was successful, otherwise empty. + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' + inputGcsSource: type: string - description: Represents an amount of money with its currency type. - type: object - id: GoogleTypeMoney - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: - description: The status of each individual document in the batch delete process. - type: object - properties: + description: >- + The source of the document, same as the input_gcs_source field in + the request when the batch process started. status: $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of deleting the document in storage. - documentId: - description: The document id of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' - id: >- - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse - description: Response of the delete documents operation. - properties: {} - type: object - GoogleCloudDocumentaiV1DocumentPageDimension: + description: The status processing the document. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: + description: >- + Represents a block. A block could be one of the various types (text, + table, list) supported. type: object - id: GoogleCloudDocumentaiV1DocumentPageDimension - description: Dimension for the page. - properties: - height: - description: Page height. - format: float - type: number - unit: - type: string - description: Dimension unit. - width: - format: float - description: Page width. - type: number - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock properties: - confidence: - description: Confidence of detected language. Range `[0, 1]`. - format: float - type: number - languageCode: - description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. + textBlock: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + description: Block consisting of text content. + listBlock: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + description: Block consisting of list content/structure. + tableBlock: + description: Block consisting of table content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + blockId: + description: ID of the block. type: string - description: Detected language for a structural component. + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + description: Page span of the block. + GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: type: object - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - GoogleCloudDocumentaiV1ListProcessorsResponse: + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + description: >- + A text segment in the Document.text. The indices may be out of bounds + which indicate that the text extends into another document shard for + large sharded documents. See ShardInfo.text_offset properties: - nextPageToken: - description: Points to the next processor, otherwise empty. + startIndex: + type: string + description: TextSegment start UTF-8 char index in the Document.text. + format: int64 + endIndex: + format: int64 type: string - processors: - description: The list of processors. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' - type: array - id: GoogleCloudDocumentaiV1ListProcessorsResponse - description: Response message for the ListProcessors method. - type: object - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - description: A row of table cells. + description: TextSegment half open end UTF-8 char index in the Document.text. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: type: object - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock properties: - cells: + listEntries: + description: List entries that constitute a list block. + type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell - type: array - description: Cells that make up this row. - GoogleCloudDocumentaiV1beta3CommonOperationMetadata: - id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata - properties: - resource: - description: A related resource to this operation. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + type: type: string + description: >- + Type of the list_entries (if exist). Available options are `ordered` + and `unordered`. + description: Represents a list type block. + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: + description: The response proto of AutoLabelDocuments method. + properties: {} + type: object + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse + GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: + properties: state: - type: string description: The state of the operation. - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED enumDescriptions: - Unspecified state. - Operation is still running. @@ -3025,37 +3139,7 @@ components: - Operation succeeded. - Operation failed. - Operation is cancelled. - createTime: - description: The creation time of the operation. - type: string - format: google-datetime - stateMessage: - type: string - description: >- - A message providing more details about the current state of - processing. - updateTime: - format: google-datetime - type: string - description: The last update time of the operation. - type: object - description: The common metadata for long running operations. - GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: - id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - properties: - resource: - type: string - description: A related resource to this operation. - updateTime: - format: google-datetime - description: The last update time of the operation. type: string - createTime: - description: The creation time of the operation. - format: google-datetime - type: string - state: - description: The state of the operation. enum: - STATE_UNSPECIFIED - RUNNING @@ -3063,2052 +3147,1941 @@ components: - SUCCEEDED - FAILED - CANCELLED - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. + updateTime: + description: The last update time of the operation. type: string + format: google-datetime stateMessage: description: >- A message providing more details about the current state of processing. type: string + createTime: + format: google-datetime + description: The creation time of the operation. + type: string + resource: + type: string + description: A related resource to this operation. + id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata type: object description: The common metadata for long running operations. - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: - type: object - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata - description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. + GoogleCloudDocumentaiV1Evaluation: + description: An evaluation of a ProcessorVersion's performance. + id: GoogleCloudDocumentaiV1Evaluation properties: - commonMetadata: - description: The basic metadata of the long-running operation. + allEntitiesMetrics: + description: Metrics for all the entities in aggregate. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleProtobufEmpty: - properties: {} - id: GoogleProtobufEmpty - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: - type: object - id: >- - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + entityMetrics: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + description: Metrics across confidence levels, for different entities. + type: object + createTime: + format: google-datetime + description: The time that the evaluation was created. + type: string + name: + type: string description: >- - The document id of the auto-labeled document. This will replace the - gcs_uri. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the document auto-labeling. - description: The status of individual documents in the auto-labeling process. - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: + The resource name of the evaluation. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` + documentCounters: + description: Counters for the documents used in the evaluation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' + kmsKeyName: + type: string + description: The KMS key name used for encryption. + kmsKeyVersionName: + description: The KMS key version with which data is encrypted. + type: string type: object + GoogleCloudDocumentaiV1beta3HumanReviewStatus: properties: - destDatasetType: + state: enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - deprecated: true - description: The destination dataset split type. - type: string - destSplitType: + - STATE_UNSPECIFIED + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED + - >- + Human review state is unspecified. Most likely due to an internal + error. + - >- + Human review is skipped for the document. This can happen because + human review isn't enabled on the processor or the processing + request has been set to skip this document. + - >- + Human review validation is triggered and passed, so no review is + needed. + - >- + Human review validation is triggered and the document is under + review. + - >- + Some error happened during triggering human review, see the + state_message for details. type: string - description: The destination dataset split type. - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - individualBatchMoveStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - type: array - description: The list of response details of each document. - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata - GoogleCloudDocumentaiV1DocumentPageBlock: - description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. - type: object - properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - deprecated: true - layout: - description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - description: A list of detected languages together with confidence. - id: GoogleCloudDocumentaiV1DocumentPageBlock - GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: - description: Response message for the DeployProcessorVersion method. - type: object - properties: {} - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: - type: object - properties: - documentErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - datasetErrorCount: - type: integer - format: int32 - description: The total number of dataset errors. - datasetErrors: + description: The state of human review on the processing request. + stateMessage: + description: A message providing more details about the human review state. + type: string + humanReviewOperation: description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - documentErrorCount: - format: int32 - description: The total number of document errors. - type: integer - id: >- - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. - GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: - type: object - description: Response of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse - properties: - evaluation: - description: The resource name of the created evaluation. + The name of the operation triggered by the processed document. This + field is populated only when the state is + `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + metadata as the long-running operation returned by ReviewDocument. type: string - GoogleCloudDocumentaiV1DocumentDocumentLayout: - description: >- - Represents the parsed layout of a document as a collection of blocks - that the document is divided into. - properties: - blocks: - description: List of blocks in the document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - type: array - id: GoogleCloudDocumentaiV1DocumentDocumentLayout type: object - GoogleCloudDocumentaiV1EvaluationMetrics: + id: GoogleCloudDocumentaiV1beta3HumanReviewStatus + description: The status of human review on a processed document. + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + type: object + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage properties: - groundTruthOccurrencesCount: - type: integer - description: The amount of occurrences in ground truth documents. - format: int32 - predictedOccurrencesCount: - type: integer - description: The amount of occurrences in predicted documents. - format: int32 - truePositivesCount: - type: integer - format: int32 - description: The amount of true positives. - groundTruthDocumentCount: - type: integer - description: The amount of documents with a ground truth occurrence. - format: int32 - totalDocumentsCount: - type: integer - description: The amount of documents that had an occurrence of this label. - format: int32 - recall: - type: number - format: float - description: The calculated recall. - falseNegativesCount: - format: int32 - type: integer - description: The amount of false negatives. - f1Score: - description: The calculated f1 score. + languageCode: + type: string + description: >- + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. + confidence: format: float type: number - falsePositivesCount: - format: int32 - type: integer - description: The amount of false positives. - precision: - description: The calculated precision. - type: number - format: float - predictedDocumentCount: - description: The amount of documents with a predicted occurrence. - type: integer - format: int32 - type: object - description: Evaluation metrics, either in aggregate or about a specific entity. - id: GoogleCloudDocumentaiV1EvaluationMetrics - GoogleCloudDocumentaiV1ProcessorType: - type: object - id: GoogleCloudDocumentaiV1ProcessorType - description: >- - A processor type is responsible for performing a certain document - understanding task on a certain type of document. + description: Confidence of detected language. Range `[0, 1]`. + description: Detected language for a structural component. + GoogleCloudDocumentaiV1OcrConfigHints: properties: - sampleDocumentUris: + languageHints: + type: array + description: >- + List of BCP-47 language codes to use for OCR. In most cases, not + specifying it yields the best results since it enables automatic + language detection. For languages based on the Latin alphabet, + setting hints is not needed. In rare cases, when the language of the + text in the image is known, setting a hint will help get better + results (although it will be a significant hindrance if the hint is + wrong). items: type: string - description: A set of Cloud Storage URIs of sample documents for this processor. - type: array - category: - description: The processor category, used by UI to group processor types. + description: Hints for OCR Engine + id: GoogleCloudDocumentaiV1OcrConfigHints + type: object + GoogleCloudDocumentaiV1Processor: + description: >- + The first-class citizen for Document AI. Each processor defines how to + extract structural information from a document. + type: object + id: GoogleCloudDocumentaiV1Processor + properties: + displayName: type: string - availableLocations: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - type: array - description: The locations in which this processor is available. - name: + description: The display name of the processor. + kmsKeyName: + description: >- + The [KMS key](https://cloud.google.com/security-key-management) used + for encryption and decryption in CMEK scenarios. type: string + name: description: >- - The resource name of the processor type. Format: - `projects/{project}/processorTypes/{processor_type}` - allowCreation: + Output only. Immutable. The resource name of the processor. Format: + `projects/{project}/locations/{location}/processors/{processor}` + readOnly: true + type: string + satisfiesPzi: + readOnly: true type: boolean + description: Output only. Reserved for future use. + processEndpoint: + type: string + readOnly: true description: >- - Whether the processor type allows creation. If true, users can - create a processor of this processor type. Otherwise, users need to - request access. - launchStage: + Output only. Immutable. The http endpoint that can be called to + invoke processing. + processorVersionAliases: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' + readOnly: true + description: Output only. The processor version aliases. + createTime: + format: google-datetime + type: string + description: The time the processor was created. + defaultProcessorVersion: + type: string + description: The default processor version. + type: + type: string + description: >- + The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + To get a list of processor types, see FetchProcessorTypes. + state: + readOnly: true enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Launch stage of the processor type + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + - ENABLING + - DISABLING + - CREATING + - FAILED + - DELETING type: string enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. + - The processor is in an unspecified state. - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. + The processor is enabled, i.e., has an enabled version which can + currently serve processing requests and all the feature + dependencies have been successfully initialized. + - The processor is disabled. - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: - type: string - description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' - GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: - description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata - type: object + The processor is being enabled, will become `ENABLED` if + successful. + - >- + The processor is being disabled, will become `DISABLED` if + successful. + - >- + The processor is being created, will become either `ENABLED` (for + successful creation) or `FAILED` (for failed ones). Once a + processor is in this state, it can then be used for document + processing, but the feature dependencies of the processor might + not be fully created yet. + - >- + The processor failed during creation or initialization of feature + dependencies. The user should delete the processor and recreate + one as all the functionalities of the processor are disabled. + - The processor is being deleted, will be removed if successful. + description: Output only. The state of the processor. + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: + description: Represents where the block starts and ends in the document. properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata for the long-running operation. - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: + pageEnd: + type: integer + description: Page where block ends in the document. + format: int32 + pageStart: + description: Page where block starts in the document. + format: int32 + type: integer + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + type: object + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: + type: object + description: The statistic representing a dataset split type for this export. + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat properties: totalDocumentCount: - description: Total number of documents deleting from dataset. format: int32 type: integer - individualBatchDeleteStatuses: - description: The list of response details of each document. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - errorDocumentCount: - type: integer - description: Total number of documents that failed to be deleted in storage. - format: int32 - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata - type: object - GoogleCloudDocumentaiV1DocumentPageLine: + description: >- + Total number of documents with the given dataset split type to be + exported. + splitType: + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + description: The dataset split type. + type: string + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + GoogleCloudDocumentaiV1ListProcessorsResponse: properties: - layout: - description: Layout for Line. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: - description: A list of detected languages together with confidence. + processors: + description: The list of processors. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - deprecated: true - id: GoogleCloudDocumentaiV1DocumentPageLine - type: object - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo: - description: Information about Generative AI model-based processor versions. - properties: - foundationGenAiModelInfo: - description: Information for a pretrained Google-managed foundation model. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo - customGenAiModelInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo - description: Information for a custom Generative AI model created by the user. - id: GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo - type: object - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + nextPageToken: + type: string + description: Points to the next processor, otherwise empty. + id: GoogleCloudDocumentaiV1ListProcessorsResponse + description: Response message for the ListProcessors method. type: object - description: Represents an entry in the list. - properties: - blocks: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - description: >- - A list entry is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. - type: array - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse + GoogleCloudDocumentaiV1DeployProcessorVersionRequest: type: object - description: Response of the EvaluateProcessorVersion method. - properties: - evaluation: - type: string - description: The resource name of the created evaluation. + id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest + properties: {} + description: Request message for the DeployProcessorVersion method. GoogleCloudDocumentaiV1DocumentShardInfo: id: GoogleCloudDocumentaiV1DocumentShardInfo - description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. + type: object properties: shardCount: - format: int64 - description: Total number of shards. type: string + description: Total number of shards. + format: int64 shardIndex: type: string description: The 0-based index of this shard. format: int64 textOffset: - type: string description: >- The index of the first character in Document.text in the overall document global text. + type: string format: int64 - type: object - GoogleCloudDocumentaiV1Document: + description: >- + For a large document, sharding may be performed to produce several + document shards. Each document shard contains this field to detail which + shard it is. + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult type: object properties: - text: - description: Optional. UTF-8 encoded text in reading order from the document. - type: string - textStyles: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - deprecated: true - type: array - description: Styles for the Document.text. - uri: - type: string - description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - textChanges: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' - description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. - revisions: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' - type: array - description: Placeholder. Revision history of this document. - pages: - type: array - description: Visual page layout for the Document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - shardInfo: - description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' - mimeType: - type: string - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - documentLayout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' - description: Parsed layout of the document. - content: + inputGcsSource: type: string - format: byte - description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. - error: - description: Any error that occurred while processing this document. + description: The source Cloud Storage URI specified in the import config. + status: + description: The validation status of import config. $ref: '#/components/schemas/GoogleRpcStatus' - entityRelations: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' - type: array - description: Placeholder. Relationship among Document.entities. - chunkedDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' - description: Document chunked based on chunking config. - entities: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - type: array - description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - id: GoogleCloudDocumentaiV1Document - description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata - type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + The validation status of each import config. Status is set to an error + if there are no documents to import in the `import_config`, or `OK` if + the operation will try to proceed with at least one document. + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: + description: The sharding config for the output document. + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + type: object properties: - documentErrorCount: + pagesPerShard: + format: int32 + type: integer + description: The number of pages per shard. + pagesOverlap: type: integer format: int32 - description: The total number of document errors. - documentErrors: + description: The number of overlapping pages between consecutive shards. + GoogleCloudDocumentaiV1DocumentPageFormField: + type: object + description: A form field detected on the page. + properties: + valueDetectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages for value together with confidence. type: array + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + fieldName: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - datasetErrors: + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + correctedKeyText: description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - items: - $ref: '#/components/schemas/GoogleRpcStatus' + Created for Labeling UI to export key text. If corrections were made + to the text identified by the `field_name.text_anchor`, this field + will contain the correction. + type: string + fieldValue: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the FormField value. + nameDetectedLanguages: + description: A list of detected languages for name together with confidence. type: array - datasetErrorCount: - format: int32 - type: integer - description: The total number of dataset errors. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + correctedValueText: + type: string + description: >- + Created for Labeling UI to export value text. If corrections were + made to the text identified by the `field_value.text_anchor`, this + field will contain the correction. + valueType: + type: string + description: >- + If the value is non-textual, this field represents the type. Current + valid values are: - blank (this indicates the `field_value` is + normal text) - `unfilled_checkbox` - `filled_checkbox` + id: GoogleCloudDocumentaiV1DocumentPageFormField + GoogleCloudDocumentaiV1EnableProcessorRequest: type: object + description: Request message for the EnableProcessor method. + properties: {} + id: GoogleCloudDocumentaiV1EnableProcessorRequest + GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: + properties: + docId: + type: string + description: Required. The id of the document. description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. - GoogleCloudDocumentaiV1RawDocument: - description: Payload message of raw document content (bytes). - id: GoogleCloudDocumentaiV1RawDocument + Identifies a document uniquely within the scope of a dataset in + unmanaged option. + id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + type: object + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: properties: - displayName: + evaluation: type: string + description: The resource name of the created evaluation. + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse + description: Response of the EvaluateProcessorVersion method. + type: object + GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: + type: object + id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + description: The status of a each individual document in the batch process. + properties: + outputGcsDestination: description: >- - The display name of the document, it supports all Unicode characters - except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, - `,` `~`, `=` and `:` are reserved. If not specified, a default ID is - generated. - mimeType: + The Cloud Storage output destination (in the request as + DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed + document if it was successful, otherwise empty. + type: string + humanReviewStatus: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + description: The status of human review on the processed document. + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status processing the document. + inputGcsSource: description: >- - An IANA MIME type (RFC6838) indicating the nature and format of the - content. + The source of the document, same as the input_gcs_source field in + the request when the batch process started. type: string - content: - description: Inline document content. - format: byte + GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: + properties: + docId: type: string + description: Required. The id of the document. + description: >- + Identifies a document uniquely within the scope of a dataset in + unmanaged option. type: object - GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: - type: object - description: The long-running operation metadata for the CreateLabelerPool method. + id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata - GoogleCloudDocumentaiV1NormalizedVertex: + collection: + type: string + readOnly: true + description: >- + Output only. The collection in Document AI Warehouse associated with + the dataset. + schema: + description: >- + Output only. The schema in Document AI Warehouse associated with the + dataset. + readOnly: true + type: string + description: >- + Configuration specific to the Document AI Warehouse-based + implementation. + id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + type: object + GoogleCloudDocumentaiV1TrainProcessorVersionResponse: + type: object properties: - 'y': - description: Y coordinate (starts from the top of the image). - format: float - type: number - x: - format: float - description: X coordinate. - type: number - id: GoogleCloudDocumentaiV1NormalizedVertex + processorVersion: + description: The resource name of the processor version produced by training. + type: string + description: The response for TrainProcessorVersion. + id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: + description: Response of the batch update documents operation. + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse + properties: {} type: object + GoogleCloudDocumentaiV1EnableProcessorResponse: + id: GoogleCloudDocumentaiV1EnableProcessorResponse + properties: {} description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + type: object + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + description: Represents a weak reference to a page element within a document. properties: - type: + layoutId: + deprecated: true + type: string + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + layoutType: + description: >- + Optional. The type of the layout element that is being referenced if + any. + type: string + enum: + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD + enumDescriptions: + - Layout Unspecified. + - References a Page.blocks element. + - References a Page.paragraphs element. + - References a Page.lines element. + - References a Page.tokens element. + - References a Page.visual_elements element. + - Refrrences a Page.tables element. + - References a Page.form_fields element. + page: + format: int64 type: string description: >- - Type of the list_entries (if exist). Available options are `ordered` - and `unordered`. - listEntries: - type: array + Required. Index into the Document.pages element, for example using + `Document.pages` to locate the related page element. This field is + skipped when its value is the default `0`. See + https://developers.google.com/protocol-buffers/docs/proto3#json. + confidence: + type: number + description: >- + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + format: float + boundingPoly: + description: >- + Optional. Identifies the bounding polygon of a layout element on the + page. If `layout_type` is set, the bounding polygon must be exactly + the same to the layout element it's referring to. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + type: object + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: + properties: + individualBatchDeleteStatuses: + description: The list of response details of each document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry - description: List entries that constitute a list block. + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + type: array + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + errorDocumentCount: + format: int32 + type: integer + description: Total number of documents that failed to be deleted in storage. + totalDocumentCount: + format: int32 + description: Total number of documents deleting from dataset. + type: integer type: object - description: Represents a list type block. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + properties: + layout: + description: Layout for DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + barcode: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + description: Detailed barcode information of the DetectedBarcode. + description: A detected barcode. type: object - properties: {} - description: Configuration specific to spanner-based indexing. - id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig - GoogleCloudLocationListLocationsResponse: + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata type: object properties: - nextPageToken: - description: The standard List next-page token. - type: string - locations: + individualBatchDeleteStatuses: + description: The list of response details of each document. type: array - description: >- - A list of locations that matches the specified filter in the - request. items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' - description: The response message for Locations.ListLocations. - id: GoogleCloudLocationListLocationsResponse - GoogleCloudDocumentaiV1beta3GcsPrefix: - type: object - id: GoogleCloudDocumentaiV1beta3GcsPrefix - description: Specifies all documents on Cloud Storage with a common prefix. - properties: - gcsUriPrefix: - type: string - description: The URI prefix. - GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata - description: The long-running operation metadata for the DeleteProcessor method. - properties: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + errorDocumentCount: + type: integer + format: int32 + description: Total number of documents that failed to be deleted in storage. commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + totalDocumentCount: + type: integer + format: int32 + description: Total number of documents deleting from dataset. + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: + type: object + description: Response of the delete documents operation. + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse + properties: {} + GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: + properties: + commonMetadata: description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata type: object - GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: - description: The location information about where the processor is available. + description: The long-running operation metadata for the EnableProcessor method. + id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + type: object + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + description: Parsed and normalized entity value. properties: - locationId: + floatValue: + description: Float value. + format: float + type: number + booleanValue: + description: >- + Boolean value. Can be used for entities with binary values, or for + checkboxes. + type: boolean + dateValue: + description: >- + Date value. Includes year, month, day. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + $ref: '#/components/schemas/GoogleTypeDate' + datetimeValue: + $ref: '#/components/schemas/GoogleTypeDateTime' + description: >- + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + text: type: string description: >- - The location ID. For supported locations, refer to [regional and - multi-regional support](/document-ai/docs/regions). - type: object - id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - description: Human Review information of the document. + Optional. An optional field to store a normalized string. For some + entity types, one of respective `structured_value` fields may also + be populated. Also not all the types of `structured_value` will be + normalized. For example, some processors may not generate `float` or + `integer` normalized text by default. Below are sample formats + mapped to structured values. - Money/Currency type (`money_value`) + is in the ISO 4217 text format. - Date type (`date_value`) is in the + ISO 8601 text format. - Datetime type (`datetime_value`) is in the + ISO 8601 text format. + addressValue: + description: >- + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + $ref: '#/components/schemas/GoogleTypePostalAddress' + integerValue: + type: integer + format: int32 + description: Integer value. + moneyValue: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: type: object - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus properties: - stateMessage: + inputGcsSource: + description: The source Cloud Storage URI of the document. type: string + outputDocumentId: description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - state: - type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + The document id of imported document if it was successful, otherwise + empty. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the importing of the document. + description: The status of each individual document in the import process. + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - type: object - properties: - cells: - type: array - description: A table row is a list of table cells. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - description: Represents a row in a table. - GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: - description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus type: object properties: - gcsUri: - description: Required. The Cloud Storage URI where the actual document is stored. - type: string - cwDocId: + outputGcsDestination: + description: >- + The output_gcs_destination of the exported document if it was + successful, otherwise empty. type: string - description: Id of the document (indexed) managed by Content Warehouse. - deprecated: true - id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - GoogleCloudDocumentaiV1ProcessOptions: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the exporting of the document. + documentId: + description: The path to source docproto of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The status of each individual document in the export process. + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: properties: - fromEnd: - type: integer - format: int32 - description: Only process certain pages from the end, same as above. - layoutConfig: - description: >- - Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns - error if set on other processor types. + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig - fromStart: - type: integer - format: int32 - description: >- - Only process certain pages from the start. Process all if the - document has fewer pages. - schemaOverride: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: >- - Optional. Override the schema of the ProcessorVersion. Will return - an Invalid Argument error if this field is set when the underlying - ProcessorVersion doesn't support schema override. - individualPageSelector: - description: Which pages to process (1-indexed). + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + testDatasetValidation: + description: The test dataset validation information. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector - ocrConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfig' - description: >- - Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. - Returns error if set on other processor types. - type: object - description: Options for Process API - id: GoogleCloudDocumentaiV1ProcessOptions - GoogleCloudDocumentaiV1DocumentStyleFontSize: + #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + trainingDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + description: The training dataset validation information. + description: The metadata that represents a processor version being created. type: object + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata + GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: properties: - unit: - type: string - description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - size: - type: number - description: Font size for the text. - format: float - id: GoogleCloudDocumentaiV1DocumentStyleFontSize - description: Font size with unit. - GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata type: object - description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. + description: The long-running operation metadata for UpdateLabelerPool. + GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: + id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + description: Request message for the UndeployProcessorVersion method. properties: {} - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: type: object - description: Metadata message associated with the ExportProcessorVersion operation. - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The common metadata about the operation. - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse + GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: type: object - description: The response message for the ImportProcessorVersion method. properties: - processorVersion: - description: The destination processor version name. + locationId: + description: >- + The location ID. For supported locations, refer to [regional and + multi-regional support](/document-ai/docs/regions). type: string - GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: + id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo + description: The location information about where the processor is available. + GoogleCloudDocumentaiV1DocumentPageLine: + id: GoogleCloudDocumentaiV1DocumentPageLine properties: - gcsUri: - type: string - description: Required. The Cloud Storage URI where the actual document is stored. - cwDocId: + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + provenance: deprecated: true - type: string - description: Id of the document (indexed) managed by Content Warehouse. - id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Line. + type: object description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. + GoogleCloudDocumentaiV1ProcessResponse: + description: Response message for the ProcessDocument method. type: object - GoogleCloudDocumentaiV1DocumentEntity: properties: - normalizedValue: - description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - id: - type: string + document: description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - confidence: + The document payload, will populate fields based on the processor's + behavior. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + id: GoogleCloudDocumentaiV1ProcessResponse + GoogleTypeColor: + type: object + properties: + red: + type: number + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + type: number + green: + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + alpha: format: float - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. type: number - type: - type: string - description: Required. Entity type from a schema e.g. `Address`. - textAnchor: - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - properties: - type: array - description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: Optional. The history of this annotation. - mentionId: - type: string - description: Optional. Deprecated. Use `id` field instead. - mentionText: - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - type: string - redacted: description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - type: boolean - type: object - id: GoogleCloudDocumentaiV1DocumentEntity + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + id: GoogleTypeColor + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: properties: - inputGcsSource: - type: string - description: The source Cloud Storage URI specified in the import config. status: - description: The validation status of import config. $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of updating the document in storage. + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document id of the document. + type: object + description: The status of each individual document in the batch update process. id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: + properties: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the document auto-labeling. + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: >- + The document id of the auto-labeled document. This will replace the + gcs_uri. + description: The status of individual documents in the auto-labeling process. + id: >- + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus type: object - description: >- - The validation status of each import config. Status is set to an error - if there are no documents to import in the `import_config`, or `OK` if - the operation will try to proceed with at least one document. - GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: - description: The long-running operation metadata for the DisableProcessor method. + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. type: object - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata - GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: - description: The long-running operation metadata for the EnableProcessor method. + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + properties: {} + 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); } + type: object + GoogleCloudDocumentaiV1DocumentPageParagraph: + properties: + layout: + description: Layout for Paragraph. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + description: A collection of lines that a human would perceive as a paragraph. + type: object + id: GoogleCloudDocumentaiV1DocumentPageParagraph + GoogleCloudDocumentaiV1BatchDocumentsInputConfig: + type: object + description: The common config to specify a set of documents used as input. + properties: + gcsPrefix: + description: >- + The set of documents that match the specified Cloud Storage + `gcs_prefix`. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' + gcsDocuments: + description: The set of documents individually specified on Cloud Storage. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' + id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata - type: object - GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: - properties: {} - description: The response proto of ExportDocuments method. + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. type: object - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata + GoogleCloudDocumentaiUiv1beta3RevisionRef: type: object - description: Image Quality Defects - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: The revision reference specifies which revision on the document to read. + id: GoogleCloudDocumentaiUiv1beta3RevisionRef properties: - type: - description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` + revisionId: type: string - confidence: - format: float - description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - type: number - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: - type: object - properties: - splitType: + description: Reads the revision given by the id. + revisionCase: enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - description: The dataset split type. - type: string + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - totalDocumentCount: - description: >- - Total number of documents with the given dataset split type to be - exported. - format: int32 - type: integer - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat - description: The statistic representing a dataset split type for this export. - GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: - type: object - id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures - properties: - enableMathOcr: - description: Turn on the model that can extract LaTeX math formulas. - type: boolean - computeStyleInfo: - description: Turn on font identification model and return font style information. - type: boolean - enableSelectionMarkDetection: - type: boolean - description: >- - Turn on selection mark detector in OCR engine. Only available in OCR - 2.0 (and later) processors. - description: Configurations for premium OCR features. - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus - properties: - status: + - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. + - The latest revision made by a human. + - The latest revision based on timestamp. + - The first (OCR) revision. + type: string + description: Reads the revision by the predefined case. + latestProcessorVersion: description: >- - The status of resyncing the dataset with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. - $ref: '#/components/schemas/GoogleRpcStatus' - datasetInconsistencyType: - description: The type of the inconsistency of the dataset. + Reads the revision generated by the processor version. The format + takes the full resource name of processor version. + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` type: string - enumDescriptions: - - Default value. - - The marker file under the dataset folder is not found. - enum: - - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED - - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER - description: Resync status against inconsistency types on the dataset level. - type: object - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: type: object properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - individualBatchUpdateStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus - description: The list of response details of each document. - GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - outputGcsDestination: - type: string - description: >- - The Cloud Storage output destination (in the request as - DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed - document if it was successful, otherwise empty. - humanReviewStatus: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' - description: The status of human review on the processed document. - inputGcsSource: - type: string - description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. - humanReviewOperation: - deprecated: true - description: >- - The name of the operation triggered by the processed document. If - the human review process isn't triggered, this field will be empty. - It has the same response type and metadata as the long-running - operation returned by the ReviewDocument method. - type: string - description: The status of a each individual document in the batch process. + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. + GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: + properties: {} + description: Configuration specific to an unmanaged dataset. + id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig type: object - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus - GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: - description: The response for TrainProcessorVersion. - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse + GoogleCloudDocumentaiV1beta3DisableProcessorResponse: + id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + properties: {} type: object - properties: - processorVersion: - description: The resource name of the processor version produced by training. - type: string - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: + GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: type: object properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of updating the document in storage. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. - description: The status of each individual document in the batch update process. - id: >- - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. + GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of moving the document. - id: >- - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - type: object - description: The status of each individual document in the batch move process. - GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: - description: Response message for the UndeployProcessorVersion method. - id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: The long-running operation metadata for the DisableProcessor method. type: object - properties: {} - GoogleCloudDocumentaiV1DocumentPageMatrix: + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. + Options to control the training of the Custom Document Extraction (CDE) + Processor. + type: object + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions properties: - data: - format: byte - description: The matrix data. + trainingMethod: + enum: + - TRAINING_METHOD_UNSPECIFIED + - MODEL_BASED + - TEMPLATE_BASED + description: Training method to use for CDE training. type: string - type: - format: int32 - type: integer - description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - rows: - type: integer - format: int32 - description: Number of rows in the matrix. - cols: - description: Number of columns in the matrix. - format: int32 - type: integer - id: GoogleCloudDocumentaiV1DocumentPageMatrix - type: object - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse + enumDescriptions: + - '' + - '' + - '' + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse properties: processorVersion: type: string - description: The resource name of the processor version produced by training. - type: object - description: The response for TrainProcessorVersion. - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse + description: The destination processor version name. + description: The response message for the ImportProcessorVersion method. type: object + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: properties: - evaluation: - description: The resource name of the created evaluation. - type: string - description: Response of the EvaluateProcessorVersion method. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: - description: The status of each individual document in the import process. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. type: object - properties: - outputDocumentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: >- - The document id of imported document if it was successful, otherwise - empty. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the importing of the document. - outputGcsDestination: - description: >- - The output_gcs_destination of the processed document if it was - successful, otherwise empty. - type: string - inputGcsSource: - description: The source Cloud Storage URI of the document. - type: string - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: + GoogleCloudDocumentaiV1Vertex: + description: >- + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. type: object - description: Represents where the chunk starts and ends in the document. properties: - pageStart: - type: integer - description: Page where chunk starts in the document. - format: int32 - pageEnd: - description: Page where chunk ends in the document. + 'y': + description: Y coordinate (starts from the top of the image). format: int32 type: integer - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - GoogleCloudDocumentaiV1OcrConfig: - id: GoogleCloudDocumentaiV1OcrConfig + x: + type: integer + description: X coordinate. + format: int32 + id: GoogleCloudDocumentaiV1Vertex + GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: + type: object + description: The long-running operation metadata for the CreateLabelerPool method. + id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata properties: - disableCharacterBoxesDetection: - type: boolean - description: >- - Turn off character box detector in OCR engine. Character box - detection is enabled by default in OCR 2.0 (and later) processors. - computeStyleInfo: - type: boolean - deprecated: true - description: >- - Turn on font identification model and return font style information. - Deprecated, use PremiumFeatures.compute_style_info instead. - enableSymbol: - type: boolean - description: Includes symbol level OCR information if set to true. - hints: - description: Hints for the OCR model. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' - enableNativePdfParsing: - type: boolean - description: >- - Enables special handling for PDFs with existing text information. - Results in better text extraction quality in such PDF inputs. - premiumFeatures: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' - description: Configurations for premium OCR features. - enableImageQualityScores: - description: >- - Enables intelligent document quality scores after OCR. Can help with - diagnosing why OCR responses are of poor quality for a given input. - Adds additional latency comparable to regular OCR to the process - call. - type: boolean - advancedOcrOptions: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1BatchProcessMetadata: + properties: + stateMessage: description: >- - A list of advanced OCR options to further fine-tune OCR behavior. - Current valid values are: - `legacy_layout`: a heuristics layout - detection algorithm, which serves as an alternative to the current - ML-based layout detection algorithm. Customers can choose the best - suitable layout algorithm based on their situation. - items: - type: string + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + type: string + individualProcessStatuses: type: array - type: object - description: Config for Document OCR. - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: - properties: - documentId: - description: The document identifier. - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - documentInconsistencyType: - enum: - - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED - - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO - - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA - - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE - description: The type of document inconsistency. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + description: The list of response details of each document. + updateTime: + format: google-datetime + description: The last update time of the operation. type: string - enumDescriptions: - - Default value. - - The document proto is invalid. - - Indexed docproto metadata is mismatched. - - The page image or thumbnails are missing. - status: - description: >- - The status of resyncing the document with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. - $ref: '#/components/schemas/GoogleRpcStatus' - id: >- - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus - description: Resync status for each document per inconsistency type. - type: object - GoogleTypeTimeZone: - id: GoogleTypeTimeZone - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - type: object - properties: - id: + createTime: + format: google-datetime + description: The creation time of the operation. type: string - description: IANA Time Zone Database time zone, e.g. "America/New_York". - version: + state: + enum: + - STATE_UNSPECIFIED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLING + - CANCELLED + - FAILED + description: The state of the current batch processing. + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was being cancelled. + - The batch processing was cancelled. + - The batch processing has failed. type: string - description: Optional. IANA Time Zone Database version number, e.g. "2019a". - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: - properties: {} - description: Response of the batch move documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse - type: object - GoogleCloudDocumentaiV1TrainProcessorVersionResponse: + description: The long-running operation metadata for BatchProcessDocuments. + id: GoogleCloudDocumentaiV1BatchProcessMetadata type: object - properties: - processorVersion: - description: The resource name of the processor version produced by training. - type: string - description: The response for TrainProcessorVersion. - id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse - GoogleTypeColor: - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: + description: Response message associated with the ExportProcessorVersion operation. type: object - id: GoogleTypeColor + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse properties: - alpha: - type: number - format: float + gcsUri: + description: The Cloud Storage URI containing the output artifacts. + type: string + GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: + type: object + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + properties: + evaluationDocuments: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - blue: - format: float - type: number - description: The amount of blue in the color as a value in the interval [0, 1]. - red: - type: number - description: The amount of red in the color as a value in the interval [0, 1]. + Optional. The documents used in the evaluation. If unspecified, use + the processor's dataset as evaluation input. + description: Evaluates the given ProcessorVersion against the supplied documents. + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + type: object + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + properties: + qualityScore: + description: >- + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. format: float - green: type: number - description: The amount of green in the color as a value in the interval [0, 1]. - format: float - GoogleCloudDocumentaiV1DocumentPageFormField: + detectedDefects: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: A list of detected defects. + description: Image quality scores for the page image. + GoogleCloudDocumentaiV1EnableProcessorMetadata: + description: The long-running operation metadata for the EnableProcessor method. + id: GoogleCloudDocumentaiV1EnableProcessorMetadata type: object properties: - fieldName: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: + id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + properties: + estimatedCalibrationErrorExact: + format: float description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - correctedKeyText: + The ECE for the predicted entities with fuzzy matching disabled, + i.e., exact matching only. + type: number + auprc: + type: number description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. - type: string - nameDetectedLanguages: - type: array - description: A list of detected languages for name together with confidence. + The calculated area under the precision recall curve (AUPRC), + computed by integrating over all confidence thresholds. + format: float + confidenceLevelMetricsExact: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - valueDetectedLanguages: - description: A list of detected languages for value together with confidence. + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + type: array + description: Metrics across confidence levels with only exact matching. + auprcExact: + format: float + type: number + description: >- + The AUPRC for metrics with fuzzy matching disabled, i.e., exact + matching only. + confidenceLevelMetrics: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics type: array - valueType: - description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` - type: string - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - fieldValue: - description: Layout for the FormField value. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - correctedValueText: - type: string - description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. - description: A form field detected on the page. - id: GoogleCloudDocumentaiV1DocumentPageFormField - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions - description: >- - Options to control the training of the Custom Document Extraction (CDE) - Processor. - type: object - properties: - trainingMethod: - enumDescriptions: - - '' - - '' - - '' - description: Training method to use for CDE training. + description: Metrics across confidence levels with fuzzy matching enabled. + metricsType: enum: - - TRAINING_METHOD_UNSPECIFIED - - MODEL_BASED - - TEMPLATE_BASED + - METRICS_TYPE_UNSPECIFIED + - AGGREGATE + enumDescriptions: + - >- + The metrics type is unspecified. By default, metrics without a + particular specification are for leaf entity types (i.e., + top-level entity types without child types, or child types which + are not parent types themselves). + - >- + Indicates whether metrics for this particular label type represent + an aggregate of metrics for other types instead of being based on + actual TP/FP/FN values for the label type. Metrics for parent + (i.e., non-leaf) entity types are an aggregate of metrics for + their children. + description: The metrics type for the label. type: string - GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: - properties: - gcsPrefix: + estimatedCalibrationError: description: >- - Required. The Cloud Storage URI (a directory) where the documents - belonging to the dataset must be stored. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' + The Estimated Calibration Error (ECE) of the confidence of the + predicted entities. + format: float + type: number + description: Metrics across multiple confidence levels. type: object - id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig - description: Configuration specific to the Cloud Storage-based implementation. - GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument type: object - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: - id: >- - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + documentId: + type: string + description: An internal identifier for document. + GoogleTypeDate: properties: - documentErrors: - description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - documentErrorCount: + day: type: integer + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. format: int32 - description: The total number of document errors. - datasetErrorCount: - description: The total number of dataset errors. type: integer + month: format: int32 - datasetErrors: description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - type: array + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + id: GoogleTypeDate + type: object + GoogleCloudDocumentaiV1DocumentSchema: + properties: + metadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' + description: Metadata of the schema. + displayName: + description: Display name to show to users. + type: string + description: + description: Description of the schema. + type: string + entityTypes: items: - $ref: '#/components/schemas/GoogleRpcStatus' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType + description: Entity types of the schema. + type: array + description: The schema defines the output of the processed document by a processor. + id: GoogleCloudDocumentaiV1DocumentSchema + type: object + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata + GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: type: object + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. - GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: - description: Evaluates the given ProcessorVersion against the supplied documents. + The long-running operation metadata for the DeleteProcessorVersion + method. + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata + GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + type: object + id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata properties: - evaluationDocuments: + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: >- - Optional. The documents used in the evaluation. If unspecified, use - the processor's dataset as evaluation input. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: >- + The long-running operation metadata for the DeleteProcessorVersion + method. + GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: + properties: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. type: object - GoogleCloudDocumentaiV1Barcode: + id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata + GoogleCloudDocumentaiV1CommonOperationMetadata: + id: GoogleCloudDocumentaiV1CommonOperationMetadata + description: The common metadata for long running operations. properties: - format: + state: + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. type: string + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + description: The state of the operation. + stateMessage: description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. - valueFormat: + A message providing more details about the current state of + processing. + type: string + resource: + description: A related resource to this operation. + type: string + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + createTime: + description: The creation time of the operation. + format: google-datetime type: string + type: object + GoogleCloudDocumentaiV1EvaluationReference: + id: GoogleCloudDocumentaiV1EvaluationReference + properties: + aggregateMetrics: description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - rawValue: + An aggregate of the statistics for the evaluation with fuzzy + matching on. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + operation: + description: The resource name of the Long Running Operation for the evaluation. + type: string + aggregateMetricsExact: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + An aggregate of the statistics for the evaluation with fuzzy + matching off. + evaluation: type: string + description: The resource name of the evaluation. type: object - description: Encodes the detailed information of a barcode. - id: GoogleCloudDocumentaiV1Barcode - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: + description: >- + Gives a short summary of an evaluation, and links to the evaluation + itself. + GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: + description: >- + The long-running operation metadata for updating the human review + configuration. properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + type: object + id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: + properties: + commonMetadata: description: The basic metadata of the long-running operation. - description: Metadata of the EvaluateProcessorVersion method. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata type: object - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. + GoogleCloudLocationLocation: + type: object + description: A resource that represents a Google Cloud location. + id: GoogleCloudLocationLocation properties: displayName: type: string - description: User defined name for the property. - valueType: description: >- - A reference to the value type of the property. This type is subject - to the same conventions as the `Entity.base_types` field. + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' type: string name: - type: string description: >- - The name of the property. Follows the same guidelines as the - EntityType name. - occurrenceType: - enumDescriptions: - - Unspecified occurrence type. - - >- - There will be zero or one instance of this entity type. The same - entity instance may be mentioned multiple times. - - The entity type will appear zero or multiple times. - - >- - The entity type will only appear exactly once. The same entity - instance may be mentioned multiple times. - - The entity type will appear once or more times. + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` type: string + metadata: + type: object description: >- - Occurrence type limits the number of instances an entity type - appears in the document. - enum: - - OCCURRENCE_TYPE_UNSPECIFIED - - OPTIONAL_ONCE - - OPTIONAL_MULTIPLE - - REQUIRED_ONCE - - REQUIRED_MULTIPLE - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - type: object - description: Defines properties that can be part of the entity type. - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse - description: Response of the delete documents operation. - type: object - properties: {} - GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: - properties: - processorVersion: - description: The destination processor version name. - type: string - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse - type: object - description: The response message for the ImportProcessorVersion method. - GoogleCloudDocumentaiV1BatchProcessMetadata: - id: GoogleCloudDocumentaiV1BatchProcessMetadata + Service-specific metadata. For example the available capacity at the + given location. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + labels: + additionalProperties: + type: string + type: object + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo type: object + description: Font and other text style attributes. properties: - updateTime: - description: The last update time of the operation. - type: string - format: google-datetime - state: - description: The state of the current batch processing. - enum: - - STATE_UNSPECIFIED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLING - - CANCELLED - - FAILED + fontType: type: string - enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was being cancelled. - - The batch processing was cancelled. - - The batch processing has failed. - stateMessage: + description: Name or style of the font. + fontSize: + description: Font size in points (`1` point is `¹⁄₇₂` inches). + format: int32 + type: integer + bold: + type: boolean + description: >- + Whether the text is bold (equivalent to font_weight is at least + `700`). + underlined: + description: Whether the text is underlined. + type: boolean + subscript: + description: Whether the text is a subscript. This feature is not supported yet. + type: boolean + superscript: + description: >- + Whether the text is a superscript. This feature is not supported + yet. + type: boolean + italic: + description: Whether the text is italic. + type: boolean + letterSpacing: + format: double + description: Letter spacing in points. + type: number + fontWeight: description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - type: string - individualProcessStatuses: - type: array - description: The list of response details of each document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - createTime: - description: The creation time of the operation. - type: string - format: google-datetime - description: The long-running operation metadata for BatchProcessDocuments. - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse - description: Response message for the DeployProcessorVersion method. + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + format: int32 + type: integer + smallcaps: + description: >- + Whether the text is in small caps. This feature is not supported + yet. + type: boolean + strikeout: + type: boolean + description: >- + Whether the text is strikethrough. This feature is not supported + yet. + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. + handwritten: + type: boolean + description: Whether the text is handwritten. + pixelFontSize: + format: double + type: number + description: >- + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse type: object properties: {} - GoogleCloudDocumentaiV1DocumentTextAnchor: + description: Response of the batch move documents operation. + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: type: object + description: Metadata of the EvaluateProcessorVersion method. + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata properties: - content: - description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. - type: string - textSegments: - type: array - description: The text segments from the Document.text. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - description: Text reference indexing into the Document.text. - id: GoogleCloudDocumentaiV1DocumentTextAnchor - GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: - properties: {} - id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest - description: Request message for the UndeployProcessorVersion method. - type: object - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores - type: object + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1ProcessorType: properties: - qualityScore: - format: float - type: number + allowCreation: description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - detectedDefects: + Whether the processor type allows creation. If true, users can + create a processor of this processor type. Otherwise, users need to + request access. + type: boolean + name: + description: >- + The resource name of the processor type. Format: + `projects/{project}/processorTypes/{processor_type}` + type: string + type: + description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' + type: string + availableLocations: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo type: array - description: A list of detected defects. - description: Image quality scores for the page image. - GoogleCloudDocumentaiV1EvaluationReference: - id: GoogleCloudDocumentaiV1EvaluationReference - type: object - properties: - operation: + description: The locations in which this processor is available. + category: type: string - description: The resource name of the Long Running Operation for the evaluation. - evaluation: + description: The processor category, used by UI to group processor types. + sampleDocumentUris: + items: + type: string + description: A set of Cloud Storage URIs of sample documents for this processor. + type: array + launchStage: + description: Launch stage of the processor type + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. type: string - description: The resource name of the evaluation. - aggregateMetrics: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching on. - aggregateMetricsExact: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching off. - description: >- - Gives a short summary of an evaluation, and links to the evaluation - itself. - GoogleCloudDocumentaiV1ProcessorVersion: + id: GoogleCloudDocumentaiV1ProcessorType description: >- - A processor version is an implementation of a processor. Each processor - can have multiple versions, pretrained by Google internally or uptrained - by the customer. A processor can only have one default version at a - time. Its document-processing behavior is defined by that version. + A processor type is responsible for performing a certain document + understanding task on a certain type of document. + type: object + GoogleCloudDocumentaiV1beta3RevisionRef: type: object - id: GoogleCloudDocumentaiV1ProcessorVersion properties: - satisfiesPzs: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - genAiModelInfo: - description: >- - Output only. Information about Generative AI model-based processor - versions. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo - readOnly: true - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: The schema of the processor version. Describes the output. - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - modelType: - enumDescriptions: - - The processor version has unspecified model type. - - The processor version has generative model type. - - The processor version has custom model type. - readOnly: true - description: Output only. The model type of this processor version. - type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - MODEL_TYPE_GENERATIVE - - MODEL_TYPE_CUSTOM - kmsKeyName: + latestProcessorVersion: type: string - description: The KMS key name used for encryption. - googleManaged: - readOnly: true - type: boolean description: >- - Output only. Denotes that this `ProcessorVersion` is managed by - Google. - createTime: - format: google-datetime - description: The time the processor version was created. - type: string - displayName: - description: The display name of the processor version. - type: string - deprecationInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo - description: If set, information about the eventual deprecation of this version. - kmsKeyVersionName: - description: The KMS key version with which data is encrypted. + Reads the revision generated by the processor version. The format + takes the full resource name of processor version. + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + revisionId: type: string - state: + description: Reads the revision given by the id. + revisionCase: + description: Reads the revision by the predefined case. enum: - - STATE_UNSPECIFIED - - DEPLOYED - - DEPLOYING - - UNDEPLOYED - - UNDEPLOYING - - CREATING - - DELETING - - FAILED - - IMPORTING - readOnly: true - description: Output only. The state of the processor version. - type: string + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION enumDescriptions: - - The processor version is in an unspecified state. - - The processor version is deployed and can be used for processing. - - The processor version is being deployed. - - >- - The processor version is not deployed and cannot be used for - processing. - - The processor version is being undeployed. - - The processor version is being created. - - The processor version is being deleted. - - The processor version failed and is in an indeterminate state. - - The processor version is being imported. - latestEvaluation: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' - description: The most recently invoked evaluation for the processor version. - name: - description: >- - Identifier. The resource name of the processor version. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. + - The latest revision made by a human. + - The latest revision based on timestamp. + - The first (OCR) revision. type: string - GoogleCloudDocumentaiV1DisableProcessorResponse: - id: GoogleCloudDocumentaiV1DisableProcessorResponse + description: The revision reference specifies which revision on the document to read. + id: GoogleCloudDocumentaiV1beta3RevisionRef + GoogleCloudDocumentaiV1GcsPrefix: type: object - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. + properties: + gcsUriPrefix: + type: string + description: The URI prefix. + id: GoogleCloudDocumentaiV1GcsPrefix + description: Specifies all documents on Cloud Storage with a common prefix. + GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: + type: object + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse properties: {} - GoogleCloudDocumentaiV1EvaluationCounters: + description: The response proto of ResyncDataset method. + GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata properties: - failedDocumentsCount: - description: >- - How many documents were not included in the evaluation as Document - AI failed to process them. - type: integer - format: int32 - inputDocumentsCount: - type: integer - format: int32 - description: How many documents were sent for evaluation. - evaluatedDocumentsCount: - type: integer - format: int32 - description: How many documents were used in the evaluation. - invalidDocumentsCount: - type: integer - description: >- - How many documents were not included in the evaluation as they - didn't pass validation. - format: int32 - description: Evaluation counters for the documents that were used. - id: GoogleCloudDocumentaiV1EvaluationCounters + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: The long-running operation metadata for DeleteLabelerPool. type: object - GoogleCloudDocumentaiV1OcrConfigHints: - id: GoogleCloudDocumentaiV1OcrConfigHints - description: Hints for OCR Engine + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: + id: >- + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + type: object + description: >- + The validation status of each import config. Status is set to an error + if there are no documents to import in the `import_config`, or `OK` if + the operation will try to proceed with at least one document. properties: - languageHints: - description: >- - List of BCP-47 language codes to use for OCR. In most cases, not - specifying it yields the best results since it enables automatic - language detection. For languages based on the Latin alphabet, - setting hints is not needed. In rare cases, when the language of the - text in the image is known, setting a hint will help get better - results (although it will be a significant hindrance if the hint is - wrong). + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The validation status of import config. + inputGcsSource: + description: The source Cloud Storage URI specified in the import config. + type: string + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + type: object + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Represents a row in a table. + properties: + cells: + description: A table row is a list of table cells. type: array items: - type: string - type: object - GoogleTypeDateTime: - id: GoogleTypeDateTime - description: >- - Represents civil time (or occasionally physical time). This type can - represent a civil time in one of a few possible ways: * When utc_offset - is set and time_zone is unset: a civil time on a calendar day with a - particular offset from UTC. * When time_zone is set and utc_offset is - unset: a civil time on a calendar day in a particular time zone. * When - neither time_zone nor utc_offset is set: a civil time on a calendar day - in local time. The date is relative to the Proleptic Gregorian Calendar. - If year, month, or day are 0, the DateTime is considered not to have a - specific year, month, or day respectively. This type may also be used to - represent a physical time if all the date and time fields are set and - either case of the `time_offset` oneof is set. Consider using - `Timestamp` message for physical time instead. If your use case also - would like to store the user's timezone, that can be done in another - field. This type is more flexible than some applications may want. Make - sure to document and validate your application's limitations. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: type: object + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader properties: - minutes: - description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. - type: integer - format: int32 - year: - type: integer - format: int32 + text: + description: Header in text format. + type: string + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the header. + description: Represents the page header associated with the chunk. + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: Image Quality Defects + properties: + type: + type: string description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - nanos: - type: integer + Name of the defect type. Supported values are: - + `quality/defect_blurry` - `quality/defect_noisy` - + `quality/defect_dark` - `quality/defect_faint` - + `quality/defect_text_too_small` - `quality/defect_document_cutoff` - + `quality/defect_text_cutoff` - `quality/defect_glare` + confidence: + format: float description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. - format: int32 - utcOffset: + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + type: number + type: object + GoogleCloudDocumentaiV1DeleteProcessorMetadata: + description: The long-running operation metadata for the DeleteProcessor method. + id: GoogleCloudDocumentaiV1DeleteProcessorMetadata + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + type: object + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: + type: object + properties: + displayName: + description: User defined name for the property. + type: string + name: type: string - format: google-duration description: >- - UTC offset. Must be whole seconds, between -18 hours and +18 hours. - For example, a UTC offset of -4:00 would be represented as { - seconds: -14400 }. - seconds: - format: int32 - type: integer + The name of the property. Follows the same guidelines as the + EntityType name. + occurrenceType: description: >- - Optional. Seconds of minutes of the time. Must normally be from 0 to - 59, defaults to 0. An API may allow the value 60 if it allows - leap-seconds. - timeZone: - $ref: '#/components/schemas/GoogleTypeTimeZone' - description: Time zone. - hours: - format: int32 + Occurrence type limits the number of instances an entity type + appears in the document. + enumDescriptions: + - Unspecified occurrence type. + - >- + There will be zero or one instance of this entity type. The same + entity instance may be mentioned multiple times. + - The entity type will appear zero or multiple times. + - >- + The entity type will only appear exactly once. The same entity + instance may be mentioned multiple times. + - The entity type will appear once or more times. + enum: + - OCCURRENCE_TYPE_UNSPECIFIED + - OPTIONAL_ONCE + - OPTIONAL_MULTIPLE + - REQUIRED_ONCE + - REQUIRED_MULTIPLE + type: string + valueType: description: >- - Optional. Hours of day in 24 hour format. Should be from 0 to 23, - defaults to 0 (midnight). An API may choose to allow the value - "24:00:00" for scenarios like business closing time. - type: integer - day: + A reference to the value type of the property. This type is subject + to the same conventions as the `Entity.base_types` field. + type: string + description: Defines properties that can be part of the entity type. + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: + properties: + colSpan: + description: How many columns this cell spans. format: int32 + type: integer + blocks: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock description: >- - Optional. Day of month. Must be from 1 to 31 and valid for the year - and month, or 0 if specifying a datetime without a day. + A table cell is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + type: array + rowSpan: type: integer - month: + description: How many rows this cell spans. format: int32 - type: integer - description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. - GoogleCloudDocumentaiV1EnableProcessorRequest: - id: GoogleCloudDocumentaiV1EnableProcessorRequest - type: object - description: Request message for the EnableProcessor method. - properties: {} - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata - description: Metadata of the EvaluateProcessorVersion method. - GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: + description: Represents a cell in a table row. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + GoogleCloudDocumentaiV1DocumentOutputConfig: type: object properties: - commonMetadata: + gcsOutputConfig: + description: Output config to write the results to Cloud Storage. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + id: GoogleCloudDocumentaiV1DocumentOutputConfig description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - GoogleCloudDocumentaiV1DocumentPageLayout: + Config that controls the output of documents. All documents will be + written as a JSON file. + GoogleCloudDocumentaiV1NormalizedVertex: + description: >- + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. type: object - id: GoogleCloudDocumentaiV1DocumentPageLayout - description: Visual element describing a layout unit on a page. + id: GoogleCloudDocumentaiV1NormalizedVertex properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - boundingPoly: - description: The bounding polygon for the Layout. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - orientation: - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - description: Detected orientation for the Layout. - type: string - enumDescriptions: - - Unspecified orientation. - - Orientation is aligned with page up. - - >- - Orientation is aligned with page right. Turn the head 90 degrees - clockwise from upright to read. - - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. - - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - confidence: - description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. + 'y': + description: Y coordinate (starts from the top of the image). + format: float + type: number + x: type: number format: float - GoogleCloudDocumentaiV1DocumentSchemaMetadata: - properties: - documentAllowMultipleLabels: - description: >- - If true, on a given page, there can be multiple `document` - annotations covering it. - type: boolean - documentSplitter: - type: boolean - description: >- - If true, a `document` entity type can be applied to subdocument - (splitting). Otherwise, it can only be applied to the entire - document (classification). - skipNamingValidation: - description: >- - If set, we will skip the naming format validation in the schema. So - the string values in `DocumentSchema.EntityType.name` and - `DocumentSchema.EntityType.Property.name` will not be checked. - type: boolean - prefixedNamingOnProperties: - type: boolean - description: If set, all the nested entities must be prefixed with the parents. + description: X coordinate. + GoogleCloudDocumentaiV1DocumentPageSymbol: + description: A detected symbol. type: object - description: Metadata for global schema behavior. - id: GoogleCloudDocumentaiV1DocumentSchemaMetadata - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata + id: GoogleCloudDocumentaiV1DocumentPageSymbol properties: - individualBatchDeleteStatuses: + layout: + description: Layout for Symbol. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. type: array - description: The list of response details of each document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - totalDocumentCount: - type: integer - format: int32 - description: Total number of documents deleting from dataset. - errorDocumentCount: - type: integer - description: Total number of documents that failed to be deleted in storage. - format: int32 + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: + properties: + status: + description: >- + The status of resyncing the document with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + $ref: '#/components/schemas/GoogleRpcStatus' + documentInconsistencyType: + description: The type of document inconsistency. + type: string + enum: + - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED + - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO + - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA + - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE + enumDescriptions: + - Default value. + - The document proto is invalid. + - Indexed docproto metadata is mismatched. + - The page image or thumbnails are missing. + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document identifier. + id: >- + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + description: Resync status for each document per inconsistency type. + type: object + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + type: object + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + description: Represents the page footer associated with the chunk. + properties: + text: + type: string + description: Footer in text format. + pageSpan: + description: Page span of the footer. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: + id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata + description: The long-running operation metadata for the DisableProcessor method. + properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. type: object - GoogleCloudDocumentaiV1DocumentStyle: - id: GoogleCloudDocumentaiV1DocumentStyle + GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: properties: - fontSize: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' - description: Font size. - textDecoration: + commonMetadata: + description: The basic metadata for the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata + type: object + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: + description: The status of each individual document in the import process. + properties: + inputGcsSource: type: string + description: The source Cloud Storage URI of the document. + outputDocumentId: description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - color: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text color. - fontWeight: - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. + The document id of imported document if it was successful, otherwise + empty. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the importing of the document. + outputGcsDestination: type: string - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - fontFamily: description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - type: string - textStyle: - type: string + The output_gcs_destination of the processed document if it was + successful, otherwise empty. + id: >- + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + type: object + GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: + properties: + enableMathOcr: + type: boolean + description: Turn on the model that can extract LaTeX math formulas. + enableSelectionMarkDetection: + type: boolean description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - textAnchor: - description: Text anchor indexing into the Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + Turn on selection mark detector in OCR engine. Only available in OCR + 2.0 (and later) processors. + computeStyleInfo: + description: Turn on font identification model and return font style information. + type: boolean type: object - description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. - GoogleCloudDocumentaiV1beta3DisableProcessorResponse: + id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures + description: Configurations for premium OCR features. + GoogleCloudDocumentaiV1GcsDocuments: + id: GoogleCloudDocumentaiV1GcsDocuments + type: object + description: Specifies a set of documents on Cloud Storage. + properties: + documents: + description: The list of documents. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + type: array + GoogleCloudDocumentaiV1DocumentChunkedDocument: + id: GoogleCloudDocumentaiV1DocumentChunkedDocument + description: Represents the chunks that the document is divided into. + properties: + chunks: + description: List of chunks. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + type: array + type: object + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: + description: The response for TrainProcessorVersion. + properties: + processorVersion: + description: The resource name of the processor version produced by training. + type: string + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse type: object - properties: {} - id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string callback: description: JSONP in: query name: callback schema: 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. - in: query - name: key - schema: - type: string fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: oauth_token + name: quotaUser schema: type: string alt: @@ -5121,25 +5094,52 @@ components: - json - media - proto + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - quotaUser: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + key: description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + 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. in: query - name: quotaUser + name: key schema: type: string - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token schema: type: string x-stackQL-resources: @@ -5154,20 +5154,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_operations_get: + projects_locations_operations_cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_cancel: + projects_locations_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations projects_locations_operations_get: operation: $ref: >- @@ -5175,133 +5176,130 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_list: + projects_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_operations_get insert: [] update: [] replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/operations_delete - locations: - id: google.documentai.locations - name: locations - title: Locations + processors: + id: google.documentai.processors + name: processors + title: Processors methods: - projects_locations_get: + projects_locations_processors_disable: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_list: + projects_locations_processors_batch_process: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - insert: [] - update: [] - replace: [] - delete: [] - processor_types: - id: google.documentai.processor_types - name: processor_types - title: Processor_types - methods: - projects_locations_fetch_processor_types: + projects_locations_processors_enable: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:fetchProcessorTypes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processor_types_get: + projects_locations_processors_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes~1{processorTypesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processor_types_list: + objectKey: $.processors + projects_locations_processors_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processorTypes - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_get - - $ref: >- - #/components/x-stackQL-resources/processor_types/methods/projects_locations_fetch_processor_types - - $ref: >- - #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_list - insert: [] - update: [] - replace: [] - delete: [] - human_review_config: - id: google.documentai.human_review_config - name: human_review_config - title: Human_review_config - methods: - projects_locations_processors_human_review_config_review_document: + projects_locations_processors_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1humanReviewConfig:reviewDocument/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_process: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:process/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_set_default_processor_version: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:setDefaultProcessorVersion/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: >- + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_get + - $ref: >- + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_list + insert: + - $ref: >- + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_create update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete evaluations: id: google.documentai.evaluations name: evaluations title: Evaluations methods: - projects_locations_processors_processor_versions_evaluations_get: + projects_locations_processors_processor_versions_evaluations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations~1{evaluationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_evaluations_list: + objectKey: $.evaluations + projects_locations_processors_processor_versions_evaluations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations~1{evaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.evaluations sqlVerbs: select: - $ref: >- @@ -5317,67 +5315,67 @@ components: name: processor_versions title: Processor_versions methods: - projects_locations_processors_processor_versions_batch_process: + projects_locations_processors_processor_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:batchProcess/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_deploy: + projects_locations_processors_processor_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_get: + projects_locations_processors_processor_versions_deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_delete: + projects_locations_processors_processor_versions_batch_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_undeploy: + projects_locations_processors_processor_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_process: + objectKey: $.processorVersions + projects_locations_processors_processor_versions_train: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:process/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions:train/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_list: + projects_locations_processors_processor_versions_undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processorVersions - projects_locations_processors_processor_versions_evaluate_processor_version: + projects_locations_processors_processor_versions_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:evaluateProcessorVersion/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:process/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_train: + projects_locations_processors_processor_versions_evaluate_processor_version: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions:train/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:evaluateProcessorVersion/post response: mediaType: application/json openAPIDocKey: '200' @@ -5393,103 +5391,105 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_delete - processors: - id: google.documentai.processors - name: processors - title: Processors + human_review_config: + id: google.documentai.human_review_config + name: human_review_config + title: Human_review_config methods: - projects_locations_processors_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.processors - projects_locations_processors_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_processors_enable: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:enable/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_processors_set_default_processor_version: + projects_locations_processors_human_review_config_review_document: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:setDefaultProcessorVersion/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1humanReviewConfig:reviewDocument/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_batch_process: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + processor_types: + id: google.documentai.processor_types + name: processor_types + title: Processor_types + methods: + projects_locations_processor_types_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:batchProcess/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes~1{processorTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_get: + projects_locations_processor_types_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_delete: + objectKey: $.processorTypes + projects_locations_fetch_processor_types: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:fetchProcessorTypes/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_disable: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_get + - $ref: >- + #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_list + - $ref: >- + #/components/x-stackQL-resources/processor_types/methods/projects_locations_fetch_processor_types + insert: [] + update: [] + replace: [] + delete: [] + locations: + id: google.documentai.locations + name: locations + title: Locations + methods: + projects_locations_get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:disable/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_process: + projects_locations_list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:process/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.locations sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_get - - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_list - insert: + #/components/x-stackQL-resources/locations/methods/projects_locations_get - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_create + #/components/x-stackQL-resources/locations/methods/projects_locations_list + insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete + delete: [] paths: /v1/operations/{operationsId}: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' delete: description: >- Deletes a long-running operation. This method indicates that the client @@ -5515,14 +5515,57 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: parameters: *ref_1 - get: + post: + description: Disables a processor + operationId: documentai.projects.locations.processors.disable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DisableProcessorRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: processorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess: + parameters: *ref_1 + post: 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. - operationId: documentai.projects.operations.get + LRO endpoint to batch process many documents. The output is written to + Cloud Storage as JSON in the [Document] format. + operationId: documentai.projects.locations.processors.batchProcess + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5542,15 +5585,26 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + - in: path + name: processorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: parameters: *ref_1 - get: - description: Gets information about a location. - operationId: documentai.projects.locations.get + post: + description: Enables a processor + operationId: documentai.projects.locations.processors.enable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5562,7 +5616,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5574,11 +5628,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations: + - in: path + name: processorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors: parameters: *ref_1 get: - description: Lists information about the supported locations for this service. - operationId: documentai.projects.locations.list + description: Lists all processors which belong to this project. + operationId: documentai.projects.locations.processors.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5590,15 +5649,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - in: query @@ -5610,13 +5671,20 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes: - parameters: *ref_1 - get: + post: description: >- - Fetches processor types. Note that we don't use ListProcessorTypes here, - because it isn't paginated. - operationId: documentai.projects.locations.fetchProcessorTypes + Creates a processor from the ProcessorType provided. The processor will + be at `ENABLED` state by default after its creation. Note that this + method requires the `documentai.processors.create` permission on the + project, which is highly privileged. A user or service account with this + permission can create new processors that can interact with any gcs + bucket in your project. + operationId: documentai.projects.locations.processors.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5628,8 +5696,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1FetchProcessorTypesResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' parameters: - in: path name: projectsId @@ -5641,11 +5708,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: parameters: *ref_1 - get: - description: Gets a processor type detail. - operationId: documentai.projects.locations.processorTypes.get + delete: + description: >- + Deletes the processor, unloads all deployed model artifacts if it was + enabled and then deletes all artifacts associated with this processor. + operationId: documentai.projects.locations.processors.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5657,7 +5726,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5670,15 +5739,13 @@ paths: schema: type: string - in: path - name: processorTypesId + name: processorsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: - parameters: *ref_1 get: - description: Lists the processor types that exist. - operationId: documentai.projects.locations.processorTypes.list + description: Gets a processor detail. + operationId: documentai.projects.locations.processors.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5690,8 +5757,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorTypesResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' parameters: - in: path name: projectsId @@ -5703,29 +5769,21 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: processorsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: parameters: *ref_1 post: - 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`. - operationId: documentai.projects.locations.operations.cancel + description: Processes a single document. + operationId: documentai.projects.locations.processors.process + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5737,7 +5795,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' parameters: - in: path name: projectsId @@ -5750,18 +5808,23 @@ paths: schema: type: string - in: path - name: operationsId + name: processorsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: parameters: *ref_1 - get: + post: 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. - operationId: documentai.projects.locations.operations.get + Set the default (active) version of a Processor that will be used in + ProcessDocument and BatchProcessDocuments. + operationId: documentai.projects.locations.processors.setDefaultProcessorVersion + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5786,17 +5849,16 @@ paths: schema: type: string - in: path - name: operationsId + name: processorsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: documentai.projects.locations.operations.list + description: Retrieves a set of evaluations for a given processor version. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5808,7 +5870,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse parameters: - in: path name: projectsId @@ -5820,12 +5883,14 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: processorsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: processorVersionsId + required: true schema: type: string - in: query @@ -5833,46 +5898,8 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: - parameters: *ref_1 - post: - description: >- - Send a document for Human Review. The input document should be processed - by the specified processor. - operationId: >- - documentai.projects.locations.processors.humanReviewConfig.reviewDocument - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ReviewDocumentRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: processorsId - required: true + - in: query + name: pageToken schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}: @@ -5919,12 +5946,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}: parameters: *ref_1 - get: - description: Retrieves a set of evaluations for a given processor version. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluations.list + delete: + description: >- + Deletes the processor version, all artifacts under the processor version + will be deleted. + operationId: documentai.projects.locations.processors.processorVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5936,8 +5964,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5959,27 +5986,9 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: - parameters: *ref_1 - post: - description: >- - LRO endpoint to batch process many documents. The output is written to - Cloud Storage as JSON in the [Document] format. - operationId: documentai.projects.locations.processors.processorVersions.batchProcess - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' + get: + description: Gets a processor version detail. + operationId: documentai.projects.locations.processors.processorVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5991,7 +6000,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' parameters: - in: path name: projectsId @@ -6057,11 +6066,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: parameters: *ref_1 - get: - description: Gets a processor version detail. - operationId: documentai.projects.locations.processors.processorVersions.get + post: + description: >- + LRO endpoint to batch process many documents. The output is written to + Cloud Storage as JSON in the [Document] format. + operationId: documentai.projects.locations.processors.processorVersions.batchProcess + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6073,7 +6089,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6095,11 +6111,11 @@ paths: required: true schema: type: string - delete: - description: >- - Deletes the processor version, all artifacts under the processor version - will be deleted. - operationId: documentai.projects.locations.processors.processorVersions.delete + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: + parameters: *ref_1 + get: + description: Lists all versions of a processor. + operationId: documentai.projects.locations.processors.processorVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6111,7 +6127,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse parameters: - in: path name: projectsId @@ -6128,22 +6145,28 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: parameters: *ref_1 post: - description: Undeploys the processor version. - operationId: documentai.projects.locations.processors.processorVersions.undeploy + description: >- + Trains a new processor version. Operation metadata is returned as + TrainProcessorVersionMetadata. + operationId: documentai.projects.locations.processors.processorVersions.train requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6172,21 +6195,17 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: parameters: *ref_1 post: - description: Processes a single document. - operationId: documentai.projects.locations.processors.processorVersions.process + description: Undeploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.undeploy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6198,7 +6217,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6220,11 +6239,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process: parameters: *ref_1 - get: - description: Lists all versions of a processor. - operationId: documentai.projects.locations.processors.processorVersions.list + post: + description: Processes a single document. + operationId: documentai.projects.locations.processors.processorVersions.process + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6236,8 +6260,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' parameters: - in: path name: projectsId @@ -6254,13 +6277,9 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: processorVersionsId + required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion: @@ -6310,19 +6329,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: parameters: *ref_1 post: description: >- - Trains a new processor version. Operation metadata is returned as - TrainProcessorVersionMetadata. - operationId: documentai.projects.locations.processors.processorVersions.train + Send a document for Human Review. The input document should be processed + by the specified processor. + operationId: >- + documentai.projects.locations.processors.humanReviewConfig.reviewDocument requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1ReviewDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6351,11 +6371,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: - description: Lists all processors which belong to this project. - operationId: documentai.projects.locations.processors.list + post: + 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`. + operationId: documentai.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6367,8 +6396,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6380,29 +6408,18 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - post: + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: description: >- - Creates a processor from the ProcessorType provided. The processor will - be at `ENABLED` state by default after its creation. Note that this - method requires the `documentai.processors.create` permission on the - project, which is highly privileged. A user or service account with this - permission can create new processors that can interact with any gcs - bucket in your project. - operationId: documentai.projects.locations.processors.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: documentai.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6414,7 +6431,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -6426,17 +6443,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Enables a processor - operationId: documentai.projects.locations.processors.enable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest + 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. + operationId: documentai.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6461,23 +6488,15 @@ paths: schema: type: string - in: path - name: processorsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: + /v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}: parameters: *ref_1 - post: - description: >- - Set the default (active) version of a Processor that will be used in - ProcessDocument and BatchProcessDocuments. - operationId: documentai.projects.locations.processors.setDefaultProcessorVersion - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + get: + description: Gets a processor type detail. + operationId: documentai.projects.locations.processorTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6489,7 +6508,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' parameters: - in: path name: projectsId @@ -6502,22 +6521,15 @@ paths: schema: type: string - in: path - name: processorsId + name: processorTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess: + /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: parameters: *ref_1 - post: - description: >- - LRO endpoint to batch process many documents. The output is written to - Cloud Storage as JSON in the [Document] format. - operationId: documentai.projects.locations.processors.batchProcess - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' + get: + description: Lists the processor types that exist. + operationId: documentai.projects.locations.processorTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6529,7 +6541,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorTypesResponse parameters: - in: path name: projectsId @@ -6541,16 +6554,20 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: - description: Gets a processor detail. - operationId: documentai.projects.locations.processors.get + description: Gets information about a location. + operationId: documentai.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6562,7 +6579,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: '#/components/schemas/GoogleCloudLocationLocation' parameters: - in: path name: projectsId @@ -6574,16 +6591,11 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true - schema: - type: string - delete: - description: >- - Deletes the processor, unloads all deployed model artifacts if it was - enabled and then deletes all artifacts associated with this processor. - operationId: documentai.projects.locations.processors.delete + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: documentai.projects.locations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6595,34 +6607,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: processorsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: + /v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes: parameters: *ref_1 - post: - description: Disables a processor - operationId: documentai.projects.locations.processors.disable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DisableProcessorRequest + get: + description: >- + Fetches processor types. Note that we don't use ListProcessorTypes here, + because it isn't paginated. + operationId: documentai.projects.locations.fetchProcessorTypes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6634,7 +6645,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1FetchProcessorTypesResponse parameters: - in: path name: projectsId @@ -6646,21 +6658,14 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: + /v1/projects/{projectsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Processes a single document. - operationId: documentai.projects.locations.processors.process - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' + 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. + operationId: documentai.projects.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6672,7 +6677,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6680,12 +6685,7 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: processorsId + name: operationsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/domains.yaml b/providers/src/googleapis.com/v00.00.00000/services/domains.yaml index 1a93dfb8..7e14fd71 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/domains.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/domains.yaml @@ -7,8 +7,8 @@ info: title: Cloud Domains API description: Enables management and configuration of domain names. version: v1 - x-discovery-doc-revision: '20240821' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/domains/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml index e015d1b9..9cda12c1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml @@ -7,8 +7,8 @@ info: title: Essential Contacts API description: '' version: v1 - x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/essentialcontacts/docs/ servers: @@ -34,144 +34,19 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudEssentialcontactsV1Contact: - id: GoogleCloudEssentialcontactsV1Contact - properties: - validateTime: - description: >- - The last time the validation_state was updated, either manually or - automatically. A contact is considered stale if its validation state - was updated more than 1 year ago. - type: string - format: google-datetime - languageTag: - type: string - description: >- - Required. The preferred language for notifications, as a ISO 639-1 - language code. See [Supported - languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) - for a list of supported languages. - notificationCategorySubscriptions: - description: >- - Required. The categories of notifications that the contact will - receive communications for. - items: - type: string - enumDescriptions: - - Notification category is unrecognized or unspecified. - - >- - All notifications related to the resource, including - notifications pertaining to categories added in the future. - - Notifications related to imminent account suspension. - - >- - Notifications related to security/privacy incidents, - notifications, and vulnerabilities. - - >- - Notifications related to technical events and issues such as - outages, errors, or bugs. - - >- - Notifications related to billing and payments notifications, - price updates, errors, or credits. - - >- - Notifications related to enforcement actions, regulatory - compliance, or government notices. - - >- - Notifications related to new versions, product terms updates, or - deprecations. - - >- - Child category of TECHNICAL. If assigned, technical incident - notifications will go to these contacts instead of TECHNICAL. - enum: - - NOTIFICATION_CATEGORY_UNSPECIFIED - - ALL - - SUSPENSION - - SECURITY - - TECHNICAL - - BILLING - - LEGAL - - PRODUCT_UPDATES - - TECHNICAL_INCIDENTS - type: array - email: - description: >- - Required. The email address to send notifications to. The email - address does not need to be a Google Account. - type: string - validationState: - readOnly: true - description: >- - Output only. The validity of the contact. A contact is considered - valid if it is the correct recipient for notifications for a - particular resource. - enum: - - VALIDATION_STATE_UNSPECIFIED - - VALID - - INVALID - type: string - enumDescriptions: - - The validation state is unknown or unspecified. - - >- - The contact is marked as valid. This is usually done manually by - the contact admin. All new contacts begin in the valid state. - - >- - The contact is considered invalid. This may become the state if - the contact's email is found to be unreachable. - name: - description: >- - Output only. The identifier for the contact. Format: - {resource_type}/{resource_id}/contacts/{contact_id} - type: string - readOnly: true - type: object - description: A contact that will receive notifications from Google Cloud. - GoogleCloudEssentialcontactsV1ComputeContactsResponse: - type: object - description: Response message for the ComputeContacts method. - id: GoogleCloudEssentialcontactsV1ComputeContactsResponse - properties: - contacts: - items: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' - description: >- - All contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any - parent resources. - type: array - nextPageToken: - type: string - description: >- - If there are 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` and the rest of the parameters the same as the original - request. - GoogleProtobufEmpty: - properties: {} - type: object - id: GoogleProtobufEmpty - 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); } GoogleCloudEssentialcontactsV1SendTestMessageRequest: - type: object id: GoogleCloudEssentialcontactsV1SendTestMessageRequest properties: contacts: items: type: string + type: array description: >- Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} - type: array notificationCategory: - description: >- - Required. The notification category to send the test message for. - All contacts must be subscribed to this category. - type: string enum: - NOTIFICATION_CATEGORY_UNSPECIFIED - ALL @@ -206,17 +81,33 @@ components: - >- Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL. + type: string + description: >- + Required. The notification category to send the test message for. + All contacts must be subscribed to this category. + type: object description: Request message for the SendTestMessage method. GoogleCloudEssentialcontactsV1ListContactsResponse: - id: GoogleCloudEssentialcontactsV1ListContactsResponse - description: Response message for the ListContacts method. type: object + id: GoogleCloudEssentialcontactsV1ListContactsResponse properties: + nextPageToken: + type: string + description: >- + If there are 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` and the rest of the parameters the same as the original + request. contacts: - type: array items: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + type: array description: The contacts for the specified resource. + description: Response message for the ListContacts method. + GoogleCloudEssentialcontactsV1ComputeContactsResponse: + description: Response message for the ComputeContacts method. + properties: nextPageToken: type: string description: >- @@ -225,17 +116,130 @@ components: call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. + contacts: + type: array + description: >- + All contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any + parent resources. + items: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + id: GoogleCloudEssentialcontactsV1ComputeContactsResponse + type: object + GoogleCloudEssentialcontactsV1Contact: + type: object + properties: + languageTag: + type: string + description: >- + Required. The preferred language for notifications, as a ISO 639-1 + language code. See [Supported + languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) + for a list of supported languages. + validationState: + description: >- + Output only. The validity of the contact. A contact is considered + valid if it is the correct recipient for notifications for a + particular resource. + enumDescriptions: + - The validation state is unknown or unspecified. + - >- + The contact is marked as valid. This is usually done manually by + the contact admin. All new contacts begin in the valid state. + - >- + The contact is considered invalid. This may become the state if + the contact's email is found to be unreachable. + type: string + enum: + - VALIDATION_STATE_UNSPECIFIED + - VALID + - INVALID + readOnly: true + notificationCategorySubscriptions: + type: array + description: >- + Required. The categories of notifications that the contact will + receive communications for. + items: + enum: + - NOTIFICATION_CATEGORY_UNSPECIFIED + - ALL + - SUSPENSION + - SECURITY + - TECHNICAL + - BILLING + - LEGAL + - PRODUCT_UPDATES + - TECHNICAL_INCIDENTS + enumDescriptions: + - Notification category is unrecognized or unspecified. + - >- + All notifications related to the resource, including + notifications pertaining to categories added in the future. + - Notifications related to imminent account suspension. + - >- + Notifications related to security/privacy incidents, + notifications, and vulnerabilities. + - >- + Notifications related to technical events and issues such as + outages, errors, or bugs. + - >- + Notifications related to billing and payments notifications, + price updates, errors, or credits. + - >- + Notifications related to enforcement actions, regulatory + compliance, or government notices. + - >- + Notifications related to new versions, product terms updates, or + deprecations. + - >- + Child category of TECHNICAL. If assigned, technical incident + notifications will go to these contacts instead of TECHNICAL. + type: string + validateTime: + format: google-datetime + description: >- + The last time the validation_state was updated, either manually or + automatically. A contact is considered stale if its validation state + was updated more than 1 year ago. + type: string + name: + readOnly: true + description: >- + Output only. The identifier for the contact. Format: + {resource_type}/{resource_id}/contacts/{contact_id} + type: string + email: + description: >- + Required. The email address to send notifications to. The email + address does not need to be a Google Account. + type: string + id: GoogleCloudEssentialcontactsV1Contact + description: A contact that will receive notifications from Google Cloud. + GoogleProtobufEmpty: + 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); } + properties: {} + type: object + id: GoogleProtobufEmpty parameters: - access_token: - description: OAuth access token. + alt: + description: Data format for response. in: query - name: access_token + name: alt schema: type: string - callback: - description: JSONP + enum: + - json + - media + - proto + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string _.xgafv: @@ -247,10 +251,16 @@ components: enum: - '1' - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: uploadType + name: prettyPrint + schema: + type: boolean + callback: + description: JSONP + in: query + name: callback schema: type: string key: @@ -262,26 +272,16 @@ components: name: key schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - alt: - description: Data format for response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: alt + name: oauth_token schema: type: string - enum: - - json - - media - - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: upload_protocol + name: fields schema: type: string quotaUser: @@ -293,16 +293,16 @@ components: name: quotaUser schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: fields + name: upload_protocol schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string x-stackQL-resources: @@ -311,139 +311,139 @@ components: name: contacts title: Contacts methods: - projects_contacts_send_test_message: + projects_contacts_compute: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts:sendTestMessage/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_get: + projects_contacts_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_delete: + projects_contacts_list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/get' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_patch: + objectKey: $.contacts + projects_contacts_send_test_message: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/patch' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1contacts:sendTestMessage/post response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_create: + projects_contacts_get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_list: + projects_contacts_delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contacts - projects_contacts_compute: + projects_contacts_patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/patch' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_patch: + folders_contacts_patch: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/patch + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/patch' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_delete: + folders_contacts_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_get: + folders_contacts_delete: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/get + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_create: + folders_contacts_compute: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_list: + folders_contacts_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/get' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.contacts - organizations_contacts_compute: + folders_contacts_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:compute/get + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_send_test_message: + folders_contacts_send_test_message: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:sendTestMessage/post' response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_patch: + organizations_contacts_create: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/patch' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_get: + organizations_contacts_list: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/get' response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_delete: + objectKey: $.contacts + organizations_contacts_delete: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/delete' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_list: + organizations_contacts_get: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contacts - folders_contacts_create: + organizations_contacts_patch: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/patch response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_send_test_message: + organizations_contacts_compute: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:sendTestMessage/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:compute/get response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_compute: + organizations_contacts_send_test_message: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post response: mediaType: application/json openAPIDocKey: '200' @@ -451,63 +451,58 @@ components: select: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_get - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_get - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_get - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_list + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_get - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list + #/components/x-stackQL-resources/contacts/methods/projects_contacts_list - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_list + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list insert: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_create - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_create - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_create + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_create update: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_patch - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_patch - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_patch + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_patch replace: [] delete: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_delete - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_delete - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_delete + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_delete paths: - /v1/projects/{projectsId}/contacts:sendTestMessage: + /v1/projects/{projectsId}/contacts:compute: parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - post: + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + get: description: >- - Allows a contact admin to send a test message to contact to verify that - it has been configured correctly. - operationId: essentialcontacts.projects.contacts.sendTestMessage - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.projects.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -519,18 +514,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/contacts/{contactsId}: + - in: query + name: notificationCategories + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/contacts: parameters: *ref_1 - get: - description: Gets a single contact. - operationId: essentialcontacts.projects.contacts.get + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.projects.contacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -549,14 +563,9 @@ paths: required: true schema: type: string - - in: path - name: contactsId - required: true - schema: - type: string - delete: - description: Deletes a contact. - operationId: essentialcontacts.projects.contacts.delete + get: + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.projects.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -568,26 +577,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: contactsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: - description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.projects.contacts.patch + /v1/projects/{projectsId}/contacts:sendTestMessage: + parameters: *ref_1 + post: + description: >- + Allows a contact admin to send a test message to contact to verify that + it has been configured correctly. + operationId: essentialcontacts.projects.contacts.sendTestMessage requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -599,33 +618,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: contactsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/contacts: + /v1/projects/{projectsId}/contacts/{contactsId}: parameters: *ref_1 - post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.projects.contacts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + get: + description: Gets a single contact. + operationId: essentialcontacts.projects.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -644,9 +648,14 @@ paths: required: true schema: type: string - get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.projects.contacts.list + - in: path + name: contactsId + required: true + schema: + type: string + delete: + description: Deletes a contact. + operationId: essentialcontacts.projects.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -658,31 +667,26 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: contactsId + required: true schema: type: string - /v1/projects/{projectsId}/contacts:compute: - parameters: *ref_1 - get: - description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.projects.contacts.compute + patch: + description: 'Updates a contact. Note: A contact''s email address cannot be changed.' + operationId: essentialcontacts.projects.contacts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -694,32 +698,28 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: notificationCategories + - in: path + name: contactsId + required: true schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/contacts/{contactsId}: + format: google-fieldmask + /v1/folders/{foldersId}/contacts/{contactsId}: parameters: *ref_1 patch: description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.organizations.contacts.patch + operationId: essentialcontacts.folders.contacts.patch requestBody: content: application/json: @@ -739,7 +739,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -753,9 +753,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a contact. - operationId: essentialcontacts.organizations.contacts.delete + get: + description: Gets a single contact. + operationId: essentialcontacts.folders.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -767,10 +767,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -779,9 +779,9 @@ paths: required: true schema: type: string - get: - description: Gets a single contact. - operationId: essentialcontacts.organizations.contacts.get + delete: + description: Deletes a contact. + operationId: essentialcontacts.folders.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -793,10 +793,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -805,16 +805,14 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/contacts: + /v1/folders/{foldersId}/contacts:compute: parameters: *ref_1 - post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.organizations.contacts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + get: + description: >- + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.folders.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -826,16 +824,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string + - in: query + name: notificationCategories + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/contacts: + parameters: *ref_1 get: description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.organizations.contacts.list + operationId: essentialcontacts.folders.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -851,27 +865,27 @@ paths: #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/organizations/{organizationsId}/contacts:compute: - parameters: *ref_1 - get: - description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.organizations.contacts.compute + - in: query + name: pageToken + schema: + type: string + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.folders.contacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -883,34 +897,20 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: notificationCategories - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/contacts:sendTestMessage: + /v1/folders/{foldersId}/contacts:sendTestMessage: parameters: *ref_1 post: description: >- Allows a contact admin to send a test message to contact to verify that it has been configured correctly. - operationId: essentialcontacts.organizations.contacts.sendTestMessage + operationId: essentialcontacts.folders.contacts.sendTestMessage requestBody: content: application/json: @@ -931,15 +931,15 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - /v1/folders/{foldersId}/contacts/{contactsId}: + /v1/organizations/{organizationsId}/contacts: parameters: *ref_1 - patch: - description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.folders.contacts.patch + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.organizations.contacts.create requestBody: content: application/json: @@ -959,23 +959,13 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: contactsId + name: organizationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask get: - description: Gets a single contact. - operationId: essentialcontacts.folders.contacts.get + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.organizations.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -987,21 +977,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: path - name: contactsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + /v1/organizations/{organizationsId}/contacts/{contactsId}: + parameters: *ref_1 delete: description: Deletes a contact. - operationId: essentialcontacts.folders.contacts.delete + operationId: essentialcontacts.organizations.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1016,7 +1013,7 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1025,11 +1022,9 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/contacts: - parameters: *ref_1 get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.folders.contacts.list + description: Gets a single contact. + operationId: essentialcontacts.organizations.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1041,26 +1036,21 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: contactsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.folders.contacts.create + patch: + description: 'Updates a contact. Note: A contact''s email address cannot be changed.' + operationId: essentialcontacts.organizations.contacts.patch requestBody: content: application/json: @@ -1080,49 +1070,28 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - /v1/folders/{foldersId}/contacts:sendTestMessage: - parameters: *ref_1 - post: - description: >- - Allows a contact admin to send a test message to contact to verify that - it has been configured correctly. - operationId: essentialcontacts.folders.contacts.sendTestMessage - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - in: path - name: foldersId + name: contactsId required: true schema: type: string - /v1/folders/{foldersId}/contacts:compute: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/contacts:compute: parameters: *ref_1 get: description: >- Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources. - operationId: essentialcontacts.folders.contacts.compute + operationId: essentialcontacts.organizations.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1138,16 +1107,16 @@ paths: #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - in: query - name: notificationCategories + name: pageToken schema: type: string - in: query - name: pageToken + name: notificationCategories schema: type: string - in: query @@ -1155,3 +1124,34 @@ paths: schema: type: integer format: int32 + /v1/organizations/{organizationsId}/contacts:sendTestMessage: + parameters: *ref_1 + post: + description: >- + Allows a contact admin to send a test message to contact to verify that + it has been configured correctly. + operationId: essentialcontacts.organizations.contacts.sendTestMessage + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml b/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml index 39988559..d4949cbe 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml @@ -7,8 +7,8 @@ info: title: Eventarc API description: Build event-driven applications on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/eventarc servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/file.yaml b/providers/src/googleapis.com/v00.00.00000/services/file.yaml index f03f68a4..f8f0d27a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/file.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/file.yaml @@ -10,7 +10,7 @@ info: servers. version: v1 x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/filestore/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml b/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml index a7fa022b..0529d309 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml @@ -9,8 +9,8 @@ info: Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. version: v1 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/firestore servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml index c8e53838..851a81b9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml @@ -10,7 +10,7 @@ info: for GKE clusters. version: v1 x-discovery-doc-revision: '20240902' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml index dfe4d611..587fb49b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml @@ -7,8 +7,8 @@ info: title: GKE Hub API description: '' version: v2 - x-discovery-doc-revision: '20240902' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-19' externalDocs: url: >- https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml index 4a5e9950..7bbb45e1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml @@ -7,8 +7,8 @@ info: title: GDC Virtual API description: '' version: v1 - x-discovery-doc-revision: '20240814' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/anthos/clusters/docs/on-prem/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml b/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml index 093ee0cb..cd291133 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml @@ -8,7 +8,7 @@ info: description: Manage, store, and access healthcare data in Google Cloud Platform. version: v1 x-discovery-doc-revision: '20240828' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/healthcare servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml index 9c5f2c68..20807b61 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml @@ -12,8 +12,8 @@ info: Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. version: v1 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -2678,7 +2678,7 @@ components: name: oauth_clients title: Oauth_clients methods: - list: + projects_locations_oauth_clients_list: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients/get @@ -2686,35 +2686,35 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.oauthClients - create: + projects_locations_oauth_clients_create: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients/post response: mediaType: application/json openAPIDocKey: '200' - get: + projects_locations_oauth_clients_get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + projects_locations_oauth_clients_patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + projects_locations_oauth_clients_delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/delete response: mediaType: application/json openAPIDocKey: '200' - undelete: + projects_locations_oauth_clients_undelete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}:undelete/post @@ -2723,49 +2723,54 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/get' - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/list' + - $ref: >- + #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_get + - $ref: >- + #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_list insert: - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/create' + - $ref: >- + #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_create update: - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_delete credentials: id: google.iam.credentials name: credentials title: Credentials methods: - list: + projects_locations_oauth_clients_credentials_list: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials/get response: mediaType: application/json openAPIDocKey: '200' - create: + projects_locations_oauth_clients_credentials_create: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials/post response: mediaType: application/json openAPIDocKey: '200' - get: + projects_locations_oauth_clients_credentials_get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + projects_locations_oauth_clients_credentials_patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + projects_locations_oauth_clients_credentials_delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/delete @@ -2774,21 +2779,26 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/credentials/methods/get' - - $ref: '#/components/x-stackQL-resources/credentials/methods/list' + - $ref: >- + #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_get + - $ref: >- + #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_list insert: - - $ref: '#/components/x-stackQL-resources/credentials/methods/create' + - $ref: >- + #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_create update: - - $ref: '#/components/x-stackQL-resources/credentials/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/credentials/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_delete workload_identity_pools: id: google.iam.workload_identity_pools name: workload_identity_pools title: Workload_identity_pools methods: - list: + projects_locations_workload_identity_pools_list: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools/get @@ -2796,35 +2806,35 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.workloadIdentityPools - create: + projects_locations_workload_identity_pools_create: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools/post response: mediaType: application/json openAPIDocKey: '200' - get: + projects_locations_workload_identity_pools_get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + projects_locations_workload_identity_pools_patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + projects_locations_workload_identity_pools_delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' - undelete: + projects_locations_workload_identity_pools_undelete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}:undelete/post @@ -2834,25 +2844,88 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/get + #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_get - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/list + #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_list insert: - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/create + #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_create update: - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/patch + #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/delete + #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_delete operations: id: google.iam.operations name: operations title: Operations methods: - get: + projects_locations_workload_identity_pools_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_namespaces_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_namespaces_managed_identities_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_namespaces_managed_identities_workload_sources_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}~1workloadSources~1{workloadSourcesId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_providers_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_providers_keys_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys~1{keysId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + locations_workforce_pools_operations_get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + locations_workforce_pools_providers_operations_get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + locations_workforce_pools_providers_keys_operations_get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + locations_workforce_pools_subjects_operations_get: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}~1operations~1{operationsId}/get @@ -2861,7 +2934,26 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_namespaces_managed_identities_workload_sources_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_namespaces_managed_identities_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_providers_keys_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_namespaces_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_providers_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/locations_workforce_pools_providers_keys_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/locations_workforce_pools_providers_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/locations_workforce_pools_subjects_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/locations_workforce_pools_operations_get insert: [] update: [] replace: [] @@ -2871,7 +2963,50 @@ components: name: providers title: Providers methods: - list: + projects_locations_workload_identity_pools_providers_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workloadIdentityPoolProviders + projects_locations_workload_identity_pools_providers_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_providers_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_providers_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_providers_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_workload_identity_pools_providers_undelete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + locations_workforce_pools_providers_list: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers/get @@ -2879,35 +3014,35 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.workforcePoolProviders - create: + locations_workforce_pools_providers_create: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers/post response: mediaType: application/json openAPIDocKey: '200' - get: + locations_workforce_pools_providers_get: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + locations_workforce_pools_providers_patch: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + locations_workforce_pools_providers_delete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/delete response: mediaType: application/json openAPIDocKey: '200' - undelete: + locations_workforce_pools_providers_undelete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}:undelete/post @@ -2916,162 +3051,261 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/providers/methods/get' - - $ref: '#/components/x-stackQL-resources/providers/methods/list' + - $ref: >- + #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_get + - $ref: >- + #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_list + - $ref: >- + #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_get + - $ref: >- + #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_list insert: - - $ref: '#/components/x-stackQL-resources/providers/methods/create' + - $ref: >- + #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_create + - $ref: >- + #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_create update: - - $ref: '#/components/x-stackQL-resources/providers/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_patch + - $ref: >- + #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/providers/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_delete + - $ref: >- + #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_delete keys: id: google.iam.keys name: keys title: Keys methods: - list: + projects_locations_workload_identity_pools_providers_keys_list: operation: $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.workforcePoolProviderKeys - create: + objectKey: $.workloadIdentityPoolProviderKeys + projects_locations_workload_identity_pools_providers_keys_create: operation: $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - get: + projects_locations_workload_identity_pools_providers_keys_get: operation: $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + projects_locations_workload_identity_pools_providers_keys_delete: operation: $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - undelete: + projects_locations_workload_identity_pools_providers_keys_undelete: operation: $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}:undelete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys~1{keysId}:undelete/post response: mediaType: application/json openAPIDocKey: '200' - upload: + projects_service_accounts_keys_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_service_accounts_keys_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_service_accounts_keys_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_service_accounts_keys_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_service_accounts_keys_upload: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys:upload/post response: mediaType: application/json openAPIDocKey: '200' - disable: + projects_service_accounts_keys_disable: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}:disable/post response: mediaType: application/json openAPIDocKey: '200' - enable: + projects_service_accounts_keys_enable: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}:enable/post response: mediaType: application/json openAPIDocKey: '200' + locations_workforce_pools_providers_keys_list: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workforcePoolProviderKeys + locations_workforce_pools_providers_keys_create: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/post + response: + mediaType: application/json + openAPIDocKey: '200' + locations_workforce_pools_providers_keys_get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + locations_workforce_pools_providers_keys_delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + locations_workforce_pools_providers_keys_undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/keys/methods/get' - - $ref: '#/components/x-stackQL-resources/keys/methods/list' + - $ref: >- + #/components/x-stackQL-resources/keys/methods/projects_locations_workload_identity_pools_providers_keys_get + - $ref: >- + #/components/x-stackQL-resources/keys/methods/projects_locations_workload_identity_pools_providers_keys_list + - $ref: >- + #/components/x-stackQL-resources/keys/methods/locations_workforce_pools_providers_keys_get + - $ref: >- + #/components/x-stackQL-resources/keys/methods/projects_service_accounts_keys_get + - $ref: >- + #/components/x-stackQL-resources/keys/methods/locations_workforce_pools_providers_keys_list + - $ref: >- + #/components/x-stackQL-resources/keys/methods/projects_service_accounts_keys_list insert: - - $ref: '#/components/x-stackQL-resources/keys/methods/create' + - $ref: >- + #/components/x-stackQL-resources/keys/methods/projects_locations_workload_identity_pools_providers_keys_create + - $ref: >- + #/components/x-stackQL-resources/keys/methods/locations_workforce_pools_providers_keys_create + - $ref: >- + #/components/x-stackQL-resources/keys/methods/projects_service_accounts_keys_create update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/keys/methods/projects_locations_workload_identity_pools_providers_keys_delete + - $ref: >- + #/components/x-stackQL-resources/keys/methods/locations_workforce_pools_providers_keys_delete + - $ref: >- + #/components/x-stackQL-resources/keys/methods/projects_service_accounts_keys_delete service_accounts: id: google.iam.service_accounts name: service_accounts title: Service_accounts methods: - list: + projects_service_accounts_list: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1serviceAccounts/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.accounts - create: + projects_service_accounts_create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1serviceAccounts/post' response: mediaType: application/json openAPIDocKey: '200' - get: + projects_service_accounts_get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/get response: mediaType: application/json openAPIDocKey: '200' - update: + projects_service_accounts_update: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/put response: mediaType: application/json openAPIDocKey: '200' - patch: + projects_service_accounts_patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + projects_service_accounts_delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/delete response: mediaType: application/json openAPIDocKey: '200' - undelete: + projects_service_accounts_undelete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:undelete/post response: mediaType: application/json openAPIDocKey: '200' - enable: + projects_service_accounts_enable: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' - disable: + projects_service_accounts_disable: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' - sign_blob: + projects_service_accounts_sign_blob: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:signBlob/post response: mediaType: application/json openAPIDocKey: '200' - sign_jwt: + projects_service_accounts_sign_jwt: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:signJwt/post @@ -3080,22 +3314,28 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/service_accounts/methods/get' - - $ref: '#/components/x-stackQL-resources/service_accounts/methods/list' + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_get + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_list insert: - - $ref: '#/components/x-stackQL-resources/service_accounts/methods/create' + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_create update: - - $ref: '#/components/x-stackQL-resources/service_accounts/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_patch replace: - - $ref: '#/components/x-stackQL-resources/service_accounts/methods/update' + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_update delete: - - $ref: '#/components/x-stackQL-resources/service_accounts/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_delete service_accounts_iam_policies: id: google.iam.service_accounts_iam_policies name: service_accounts_iam_policies title: Service_accounts_iam_policies methods: - get_iam_policy: + projects_service_accounts_get_iam_policy: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:getIamPolicy/post @@ -3103,14 +3343,14 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - set_iam_policy: + projects_service_accounts_set_iam_policy: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + projects_service_accounts_test_iam_permissions: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:testIamPermissions/post @@ -3120,116 +3360,182 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/service_accounts_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/service_accounts_iam_policies/methods/projects_service_accounts_get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/service_accounts_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/service_accounts_iam_policies/methods/projects_service_accounts_set_iam_policy delete: [] roles: id: google.iam.roles name: roles title: Roles methods: - list: + projects_roles_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.roles + projects_roles_create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_roles_get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles~1{rolesId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_roles_patch: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles~1{rolesId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_roles_delete: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles~1{rolesId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_roles_undelete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1roles~1{rolesId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + roles_query_grantable_roles: + operation: + $ref: '#/paths/~1v1~1roles:queryGrantableRoles/post' + response: + mediaType: application/json + openAPIDocKey: '200' + roles_list: + operation: + $ref: '#/paths/~1v1~1roles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.roles + roles_get: + operation: + $ref: '#/paths/~1v1~1roles~1{rolesId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_roles_list: operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1roles/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.roles - create: + organizations_roles_create: operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1roles/post' response: mediaType: application/json openAPIDocKey: '200' - get: + organizations_roles_get: operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + organizations_roles_patch: operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + organizations_roles_delete: operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/delete response: mediaType: application/json openAPIDocKey: '200' - undelete: + organizations_roles_undelete: operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}:undelete/post response: mediaType: application/json openAPIDocKey: '200' - query_grantable_roles: - operation: - $ref: '#/paths/~1v1~1roles:queryGrantableRoles/post' - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/roles/methods/get' - - $ref: '#/components/x-stackQL-resources/roles/methods/list' + - $ref: '#/components/x-stackQL-resources/roles/methods/projects_roles_get' + - $ref: >- + #/components/x-stackQL-resources/roles/methods/organizations_roles_get + - $ref: '#/components/x-stackQL-resources/roles/methods/projects_roles_list' + - $ref: '#/components/x-stackQL-resources/roles/methods/roles_get' + - $ref: >- + #/components/x-stackQL-resources/roles/methods/organizations_roles_list + - $ref: '#/components/x-stackQL-resources/roles/methods/roles_list' insert: - - $ref: '#/components/x-stackQL-resources/roles/methods/create' + - $ref: >- + #/components/x-stackQL-resources/roles/methods/projects_roles_create + - $ref: >- + #/components/x-stackQL-resources/roles/methods/organizations_roles_create update: - - $ref: '#/components/x-stackQL-resources/roles/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/roles/methods/projects_roles_patch + - $ref: >- + #/components/x-stackQL-resources/roles/methods/organizations_roles_patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/roles/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/roles/methods/projects_roles_delete + - $ref: >- + #/components/x-stackQL-resources/roles/methods/organizations_roles_delete workforce_pools: id: google.iam.workforce_pools name: workforce_pools title: Workforce_pools methods: - list: + locations_workforce_pools_list: operation: $ref: '#/paths/~1v1~1locations~1{locationsId}~1workforcePools/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workforcePools - create: + locations_workforce_pools_create: operation: $ref: '#/paths/~1v1~1locations~1{locationsId}~1workforcePools/post' response: mediaType: application/json openAPIDocKey: '200' - get: + locations_workforce_pools_get: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + locations_workforce_pools_patch: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + locations_workforce_pools_delete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' - undelete: + locations_workforce_pools_undelete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:undelete/post @@ -3238,21 +3544,26 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/get' - - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/list' + - $ref: >- + #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_get + - $ref: >- + #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_list insert: - - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/create' + - $ref: >- + #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_create update: - - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_delete workforce_pools_iam_policies: id: google.iam.workforce_pools_iam_policies name: workforce_pools_iam_policies title: Workforce_pools_iam_policies methods: - get_iam_policy: + locations_workforce_pools_get_iam_policy: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:getIamPolicy/post @@ -3260,14 +3571,14 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - set_iam_policy: + locations_workforce_pools_set_iam_policy: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + locations_workforce_pools_test_iam_permissions: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:testIamPermissions/post @@ -3277,26 +3588,26 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/locations_workforce_pools_get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/locations_workforce_pools_set_iam_policy delete: [] subjects: id: google.iam.subjects name: subjects title: Subjects methods: - delete: + locations_workforce_pools_subjects_delete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}/delete response: mediaType: application/json openAPIDocKey: '200' - undelete: + locations_workforce_pools_subjects_undelete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}:undelete/post @@ -3309,13 +3620,14 @@ components: update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/subjects/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/subjects/methods/locations_workforce_pools_subjects_delete permissions: id: google.iam.permissions name: permissions title: Permissions methods: - query_testable_permissions: + permissions_query_testable_permissions: operation: $ref: '#/paths/~1v1~1permissions:queryTestablePermissions/post' response: @@ -3332,13 +3644,13 @@ components: name: iam_policies title: Iam_policies methods: - query_auditable_services: + iam_policies_query_auditable_services: operation: $ref: '#/paths/~1v1~1iamPolicies:queryAuditableServices/post' response: mediaType: application/json openAPIDocKey: '200' - lint_policy: + iam_policies_lint_policy: operation: $ref: '#/paths/~1v1~1iamPolicies:lintPolicy/post' response: diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml index 9b5c10da..c430c948 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml @@ -11,7 +11,7 @@ info: enabling this API doesn't enable the IAM API. version: v1 x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: >- https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml index 1eac222c..a50e72a9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml @@ -12,8 +12,8 @@ info: Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. version: v2 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/iam/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml index e4269d19..915c9fba 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml @@ -12,8 +12,8 @@ info: Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. version: v2beta - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/iam/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/iap.yaml b/providers/src/googleapis.com/v00.00.00000/services/iap.yaml index f30cd85c..b20a92b8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iap.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iap.yaml @@ -8,7 +8,7 @@ info: description: Controls access to cloud applications running on Google Cloud Platform. version: v1 x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/iap servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml b/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml index 49b611c4..e36ba1e6 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml @@ -8,7 +8,7 @@ info: description: Help the third party sites to implement federated login. version: v3 x-discovery-doc-revision: '20180723' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/identity-toolkit/v3/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/ids.yaml b/providers/src/googleapis.com/v00.00.00000/services/ids.yaml index aacb7bf0..ed24a162 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ids.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ids.yaml @@ -13,7 +13,7 @@ info: will be shared with Palo Alto Networks. version: v1 x-discovery-doc-revision: '20240815' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml b/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml index 5e15f2ca..f1336eeb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240902' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/application-integration servers: @@ -34,74 +34,159 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - CrmlogErrorCode: - id: CrmlogErrorCode + GoogleCloudIntegrationsV1alphaTaskConfig: type: object + id: GoogleCloudIntegrationsV1alphaTaskConfig + description: >- + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. properties: - commonErrorCode: - enumDeprecated: - - false - - true - - false - - false - - true - - true - - true - - false - - false - - true - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false + task: + type: string + description: Optional. The name for the task. + failurePolicy: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). + externalTaskType: + enum: + - EXTERNAL_TASK_TYPE_UNSPECIFIED + - NORMAL_TASK + - ERROR_TASK + enumDescriptions: + - Default value. External task type is not specified + - Tasks belongs to the normal task flows + - Task belongs to the error catch task flows + type: string + description: Optional. External task type of the task + taskTemplate: + type: string + description: >- + Optional. Used to define task-template name if task is of type + task-template + nextTasks: + type: array + description: >- + Optional. The set of tasks that are next in line to be executed as + per the execution graph defined for the parent event, specified by + `event_config_id`. Each of these next tasks are executed only if the + condition associated with them evaluates to true. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + displayName: + type: string + description: >- + Optional. User-provided label that is attached to this TaskConfig in + the UI. + synchronousCallFailurePolicy: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + nextTasksExecutionPolicy: + description: >- + Optional. The policy dictating the execution of the next set of + tasks for the current task. + type: string + enum: + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + enumDescriptions: + - Default. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + conditionalFailurePolicies: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + description: >- + Optional. The list of conditional failure policies that will be + applied to the task in order. + taskId: + type: string + description: >- + Required. The identifier of this task within its parent event + config, specified by the client. This should be unique among all the + tasks belong to the same event config. We use this field as the + identifier to find next tasks (via field `next_tasks.task_id`). + taskExecutionStrategy: + type: string + enum: + - TASK_EXECUTION_STRATEGY_UNSPECIFIED + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + enumDescriptions: + - >- + Default. If the strategy is not set explicitly, it will default to + `WHEN_ALL_SUCCEED`. + - >- + Wait until all of its previous tasks finished execution, then + verify at least one of the edge conditions is met, and execute if + possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. + - >- + Start execution as long as any of its previous tasks finished + execution and the corresponding edge condition is met (since we + will execute if only that succeeding edge condition is met). + - >- + Wait until all of its previous tasks finished execution, then + verify the all edge conditions are met and execute if possible. + description: Optional. The policy dictating the execution strategy of this task. + position: + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + errorCatcherId: + type: string + description: >- + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task + successPolicy: + description: >- + Optional. Determines what action to take upon successful task + completion. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' + parameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' + type: object + description: Optional. The customized parameters the user can pass to this task. + description: + type: string + description: >- + Optional. User-provided description intended to give additional + business context about the task. + jsonValidationOption: + type: string + description: >- + Optional. If set, overrides the option configured in the Task + implementation class. + enum: + - JSON_VALIDATION_OPTION_UNSPECIFIED + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION + enumDescriptions: + - >- + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. + - >- + Validate all potential input JSON parameters against schemas + specified in IntegrationParameter. + - >- + Validate all potential output JSON parameters against schemas + specified in IntegrationParameter. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. + EnterpriseCrmEventbusProtoJsonFunction: + properties: + functionName: + type: string enumDescriptions: - '' - '' @@ -127,6 +212,39 @@ components: - '' - '' - '' + enum: + - UNSPECIFIED + - GET_PROPERTY + - GET_ELEMENT + - APPEND_ELEMENT + - SIZE + - SET_PROPERTY + - FLATTEN + - FLATTEN_ONCE + - MERGE + - TO_STRING + - TO_INT + - TO_DOUBLE + - TO_BOOLEAN + - TO_PROTO + - TO_STRING_ARRAY + - TO_INT_ARRAY + - TO_DOUBLE_ARRAY + - TO_PROTO_ARRAY + - TO_BOOLEAN_ARRAY + - REMOVE_PROPERTY + - RESOLVE_TEMPLATE + - EQUALS + - FOR_EACH + - FILTER_ELEMENTS + id: EnterpriseCrmEventbusProtoJsonFunction + type: object + EnterpriseCrmEventbusProtoStringArrayFunction: + type: object + id: EnterpriseCrmEventbusProtoStringArrayFunction + properties: + functionName: + enumDescriptions: - '' - '' - '' @@ -140,6 +258,149 @@ components: - '' - '' - '' + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + type: string + GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails: + id: GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + description: Sub Integration which would be created via templates. + properties: + integration: + type: string + description: >- + Required. Name of the sub integration which would be created via + templates. + integrationDescription: + type: string + description: >- + Optional. Description of the sub integration which would be created + via templates. + type: object + GoogleCloudIntegrationsV1alphaFailurePolicy: + properties: + maxRetries: + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the number of times the task will be retried if failed. + format: int32 + type: integer + condition: + description: >- + Optional. The string condition that will be evaluated to determine + if the task should be retried with this failure policy. + type: string + retryStrategy: + enum: + - RETRY_STRATEGY_UNSPECIFIED + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_INTEGRATION_WITH_BACKOFF + enumDescriptions: + - UNSPECIFIED. + - >- + Ignores the failure of this task. The rest of the integration will + be executed Assuming this task succeeded. + - >- + Causes a permanent failure of the task. However, if the last + task(s) of event was successfully completed despite the failure of + this task, it has no impact on the integration. + - >- + Causes a permanent failure of the event. It is different from NONE + because this will mark the event as FAILED by shutting down the + event execution. + - >- + The task will be retried from the failed task onwards after a + fixed delay. A max-retry count is required to be specified with + this strategy. A jitter is added to each exponential interval so + that concurrently failing tasks of the same type do not end up + retrying after the exact same exponential interval. max_retries + and interval_in_seconds must be specified. + - >- + The task will be retried from the failed task onwards after a + fixed delay that linearly increases with each retry attempt. A + jitter is added to each exponential interval so that concurrently + failing tasks of the same type do not end up retrying after the + exact same exponential interval. A max-retry count is required to + be specified with this strategy. max_retries and + interval_in_seconds must be specified. + - >- + The task will be retried after an exponentially increasing period + of time with each failure. A jitter is added to each exponential + interval so that concurrently failing tasks of the same type do + not end up retrying after the exact same exponential interval. A + max-retry count is required to be specified with this strategy. + `max_retries` and `interval_in_seconds` must be specified. + - >- + The entire integration will be restarted with the initial + parameters that were set when the event was fired. A max-retry + count is required to be specified with this strategy. + `max_retries` and `interval_in_seconds` must be specified. + type: string + description: Defines what happens to the task upon failure. + intervalTime: + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the initial interval in seconds for backoff. + type: string + format: google-datetime + description: >- + Policy that defines the task retry logic and failure type. If no + FailurePolicy is defined for a task, all its dependent tasks will not be + executed (i.e, a `retry_strategy` of NONE will be applied). + type: object + id: GoogleCloudIntegrationsV1alphaFailurePolicy + EnterpriseCrmFrontendsEventbusProtoParameterMap: + properties: + entries: + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + type: array + keyType: + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + type: string + description: >- + Option to specify key value type for all entries of the map. If + provided then field types for all entries must conform to this. + enumDescriptions: + - '' + - '' - '' - '' - '' @@ -152,284 +413,350 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. - >- - ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use - only. This error will be counted as server availability error. + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + valueType: + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + enumDescriptions: + - '' + - '' + - '' - '' - '' - '' - '' - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' type: string - enum: - - COMMON_ERROR_CODE_UNSPECIFIED - - INVALID_CREDENTIALS - - REQUIRED_FIELDS_MISSING - - INVALID_FIELDS - - BACKEND - - GENERAL - - INTERNAL - - IO_ERROR - - NOT_FOUND - - EVENT_BUS - - ALREADY_EXISTS - - CONCORD - - CONVERSION - - FLUME - - PERMISSION - - SALES_FORCE - - SPANNER - - UNIMPLEMENTED - - RELTIO - - WORKFLOW_NOT_FOUND - - QUOTA_THROTTLED - - QUOTA_ENQUEUED - - INVALID_QUOTA_CONFIGURATION - - TASK_NOT_FOUND - - EXECUTION_TIMEOUT - - INVALID_EVENT_EXECUTION_STATE - - INVALID_ATTRIBUTE - - MISSING_ATTRIBUTE - - CLIENT_UNAUTHORIZED_FOR_WORKFLOW - - INVALID_PARAMETER - - MISSING_PARAMETER - - UNAUTHROIZED_WORKFLOW_EDITOR_ACTION - - FAILED_PRECONDITION - - INVALID_CLIENT - - MISSING_CLIENT - - INVALID_WORKFLOW - - MISSING_QUOTA_CONFIGURATION - - UNHANDLED_TASK_ERROR - - SCRIPT_TASK_RUNTIME_ERROR - - RPC - - INVALID_PROTO - - UNHANDLED_EVENTBUS_ERROR - - INVALID_TASK_STATE - - TYPED_TASK_INVALID_INPUT_OPERATION - - TYPED_TASK_INVALID_OUTPUT_OPERATION - - VALIDATION_ERROR - - RESUME_ERROR - - APPS_SCRIPT_EXECUTION_ERROR - - INVALID_VECTOR_USER - - INFORMATICA - - RETRYABLE_TASK_ERROR - - INVALID_TENANT - - WRONG_TENANT - - INFORMATICA_BACKEND_UNAVAILABLE - - RPC_PERMISSION_DENIED - - SYNC_EVENTBUS_EXECUTION_TIMEOUT - - ASYNC_EVENTBUS_EXECUTION_TIMEOUT - - NOT_SUPPORTED_DATA_TYPE - - UNSANITIZED_USER_INPUT - - TRANSFORM_EXPRESSION_EVALUATION_ERROR - - HTTP_EXCEPTION - - EXECUTION_CANCELLED description: >- - Registered ids for errors, as "oneof" enums. Each task or logical - grouping of tasks may share the same enum. - GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: - description: The response for executing an integration. - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. + id: EnterpriseCrmFrontendsEventbusProtoParameterMap type: object - properties: - executionInfoIds: - items: - type: string - type: array - description: The execution info id for the executed integrations. - GoogleCloudIntegrationsV1alphaGenerateTokenResponse: - id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse + EnterpriseCrmEventbusStatsDimensions: + id: EnterpriseCrmEventbusStatsDimensions type: object properties: - message: + clientId: type: string - description: The message that notifies the user if the request succeeded or not. - description: Returns success or error message - EnterpriseCrmEventbusProtoParameterValueType: - type: object - id: EnterpriseCrmEventbusProtoParameterValueType - properties: - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' - booleanValue: - type: boolean - stringValue: + triggerId: type: string - protoArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' - serializedObjectValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter - intValue: + description: >- + Stats have been or will be aggregated on set fields for any + semantically-meaningful combination. + retryAttempt: + enumDescriptions: + - '' + - >- + Task has completed successfully or has depleted all retry + attempts. + - Task has failed but may be retried. + - Task has been deliberately canceled. + enum: + - UNSPECIFIED + - FINAL + - RETRYABLE + - CANCELED type: string - format: int64 - protoValue: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - doubleValue: - type: number - format: double - booleanArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' - description: >- - LINT.IfChange To support various types of parameter values. Next - available id: 14 - GoogleCloudIntegrationsV1alphaDownloadTemplateResponse: - id: GoogleCloudIntegrationsV1alphaDownloadTemplateResponse - properties: - content: + enumFilterType: + enum: + - DEFAULT_INCLUSIVE + - EXCLUSIVE + enumDescriptions: + - '' + - '' + description: Whether to include or exclude the enums matching the regex. type: string - description: String representation of the template. - type: object - description: Response for DownloadTemplate. - EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: - id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - type: object - properties: - objectValue: - format: byte + taskName: type: string - GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: - description: 'The request for scheduling an integration. Next available id: 11' - properties: - userGeneratedExecutionId: + workflowId: type: string - description: >- - Optional. This is a unique id provided by the method caller. If - provided this will be used as the execution_id when a new execution - info is created. This is a string representation of a UUID. Must - have no more than 36 characters and contain only alphanumeric - characters and hyphens. - inputParameters: - description: Optional. Input parameters used by integration execution. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - parameters: - description: Passed in as parameters to each integration execution. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - deprecated: true - triggerId: - description: >- - Required. Matched against all {@link TriggerConfig}s across all - integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) + taskNumber: type: string - requestId: + workflowName: type: string - description: >- - This is used to de-dup incoming request: if the duplicate request - was detected, the response from the previous execution is returned. - scheduleTime: + errorEnumString: type: string - format: google-datetime - description: >- - The time that the integration should be executed. If the time is - less or equal to the current time, the integration is executed - immediately. - parameterEntries: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - type: array - deprecated: true - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + warningEnumString: + type: string + EnterpriseCrmEventbusProtoCoordinate: + id: EnterpriseCrmEventbusProtoCoordinate type: object - EnterpriseCrmFrontendsEventbusProtoEventParameters: + description: Represents two-dimensional positions. properties: - parameters: - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same workflow - execution. - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - id: EnterpriseCrmFrontendsEventbusProtoEventParameters - type: object - description: >- - LINT.IfChange This message is used for processing and persisting (when - applicable) key value pair parameters for each event in the event bus. - Please see - GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged: - id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + 'y': + type: integer + format: int32 + x: + format: int32 + type: integer + GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: description: >- - Parameters to support Oauth 2.0 Auth Code Grant Authentication using - Google Provided OAuth Client. See - https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. + Integration Config Parameter is defined in the integration config and + are used to provide external configuration for integration. It provide + information about data types of the expected parameters and provide any + default values or value. They can also be used to add custom attributes. + type: object + id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter properties: - scopes: - items: - type: string - type: array + value: description: >- - Required. Scopes the connection will request when the user performs - the auth code flow. - authCode: - type: string + Values for the defined keys. Each value can either be string, int, + double or any proto message or a serialized object. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + parameter: description: >- - Optional. Authorization code to be exchanged for access and refresh - tokens. - redirectUri: - description: Optional. Redirect URI to be provided during the auth code exchange. - type: string - type: object - GoogleCloudIntegrationsV1alphaCloudLoggingDetails: + Optional. Integration Parameter to provide the default value, data + type and attributes required for the Integration config variables. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + GoogleCloudIntegrationsV1alphaProjectProperties: + id: GoogleCloudIntegrationsV1alphaProjectProperties type: object - description: Cloud Logging details for execution info + description: Metadata information for the given project properties: - cloudLoggingSeverity: + ipEnablementState: + description: An enum value of what the enablement state is for the given project + enumDescriptions: + - The client enablement status is unspecified + - The client is enabled on Standalone IP + - The client is enabled on Apigee + - The client is entitled for Apigee but not enabled + type: string + enum: + - IP_ENABLEMENT_STATE_UNSPECIFIED + - IP_ENABLEMENT_STATE_STANDALONE + - IP_ENABLEMENT_STATE_APIGEE + - IP_ENABLEMENT_STATE_APIGEE_ENTITLED + billingType: + description: 'Required. Required: The client billing type that was requested' + enum: + - BILLING_TYPE_UNSPECIFIED + - APIGEE_TRIALS + - APIGEE_SUBSCRIPTION + - PAYG + - SUBSCRIPTION + - NO_BILLING type: string enumDescriptions: - - Unspecified + - '' + - A trial org provisioned through Apigee Provisioning Wizard - >- - If Severity selected is `INFO`, then all the Integration Execution - States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, - `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + Subscription based on concurrency model for Apigee and Application + Integration users. + - Consumption based users of IP - >- - If Severity selected is `ERROR`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. + Argentum subscription for Application Integration users. To be + used in the future. - >- - If Severity selected is `WARNING`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. - description: >- - Optional. Severity selected by the customer for the logs to be sent - to Cloud Logging, for the integration version getting executed. - enum: - - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - - INFO - - ERROR - - WARNING - enableCloudLogging: - type: boolean - description: >- - Optional. Status of whether Cloud Logging is enabled or not for the - integration version getting executed. - id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails - EnterpriseCrmEventbusProtoStringArrayFunction: - id: EnterpriseCrmEventbusProtoStringArrayFunction + Special billing type to avoid any billing to clients (eg: trusted + tester program). This should not be used without consulting with + the leads. + provisionedRegions: + type: array + description: A list of provisioned regions on the current project + items: + type: string + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: + id: >- + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata type: object properties: - functionName: + ancestorTaskNumbers: + type: array + description: >- + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') + items: + type: string + taskAttemptNum: + description: the task attempt number this snapshot belongs to. Could be empty. + format: int32 + type: integer + ancestorIterationNumbers: + items: + type: string + type: array + description: >- + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') + taskLabel: + type: string + description: the task label associated with this snapshot. Could be empty. + eventAttemptNum: + format: int32 + description: the event attempt number this snapshot belongs to. + type: integer + integrationName: + description: >- + The direct integration which the event execution snapshots belongs + to + type: string + taskNumber: + description: The task number associated with this snapshot. Could be empty. + type: string + taskName: + description: the task name associated with this snapshot. Could be empty. + type: string + GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: + properties: + scopes: + type: array + description: >- + Scopes the connection will request when the user performs the auth + code flow. + items: + type: string + clientId: + description: Client ID for user-provided OAuth app. + type: string + authCode: + description: Authorization code to be exchanged for access and refresh tokens. + type: string + pkceVerifier: + type: string + description: PKCE verifier to be used during the auth code exchange. + authUri: + type: string + description: Auth URL for Authorization Code Flow + enablePkce: + description: Whether to enable PKCE when the user performs the auth code flow. + type: boolean + redirectUri: + type: string + description: Redirect URI to be provided during the auth code exchange. + clientSecret: + description: Client secret for user-provided OAuth app. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow + description: >- + Parameters to support Oauth 2.0 Auth Code Grant Authentication. See + https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. + type: object + GoogleCloudIntegrationsV1alphaSearchTemplatesResponse: + type: object + properties: + nextPageToken: + description: The token used to retrieve the next page results. + type: string + templates: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + type: array + description: List of templates retrieved. + description: Response for a request to search templates + id: GoogleCloudIntegrationsV1alphaSearchTemplatesResponse + GoogleCloudIntegrationsV1alphaProvisionClientRequest: + id: GoogleCloudIntegrationsV1alphaProvisionClientRequest + properties: + provisionGmek: + type: boolean + deprecated: true + description: >- + Optional. Deprecated. Indicates provision with GMEK or CMEK. This + field is deprecated and the provision would always be GMEK if + cloud_kms_config is not present in the request. + createSampleWorkflows: + description: >- + Optional. Indicates if sample workflow should be created along with + provisioning + type: boolean + cloudKmsConfig: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + description: >- + Optional. OPTIONAL: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + runAsServiceAccount: + type: string + description: >- + Optional. User input run-as service account, if empty, will bring up + a new default service account + skipCpProvision: + description: Optional. Indicates if skip CP provision or not + type: boolean + type: object + description: Request for the Provision rpc + EnterpriseCrmEventbusProtoFunction: + id: EnterpriseCrmEventbusProtoFunction + type: object + properties: + parameters: + description: List of parameters required for the transformation. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' + type: array + functionType: + description: The name of the function to perform. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' + EnterpriseCrmFrontendsEventbusProtoStringParameterArray: + type: object + properties: + stringValues: + type: array + items: + type: string + id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray + EnterpriseCrmEventbusProtoTaskMetadata: + type: object + properties: + externalDocHtml: + description: External-facing documention embedded in the RHP for this task. + type: string + descriptiveName: + description: >- + The string name to show on the task list on the Workflow editor + screen. This should be a very short, one to two words name for the + task. (e.g. "Send Mail") + type: string + system: + type: string + enum: + - UNSPECIFIED_SYSTEM + - GENERIC + - BUGANIZER + - SALESFORCE + - CLOUD_SQL + - PLX + - SHEETS + - GOOGLE_GROUPS + - EMAIL + - SPANNER + - DATA_BRIDGE enumDescriptions: - '' - '' @@ -442,236 +769,306 @@ components: - '' - '' - '' + description: + type: string + description: In a few sentences, describe the purpose and usage of the task. + externalDocMarkdown: + type: string + description: 'DEPRECATED: Use external_doc_html.' + category: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' - '' - '' - type: string + - Internal IP tasks that should not be available in the UI. + - Tasks that are relevant to cloud systems teams and typically + - Task entities that derive from a custom task template. + - Category to show task recommendations enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: - type: object - description: Request for PublishIntegrationVersion. - properties: - configParameters: - additionalProperties: - type: any - description: Properties of the object. - type: object - description: Optional. Config parameters used during integration execution. - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest - EnterpriseCrmEventbusProtoWorkflowAlertConfig: - type: object - properties: - playbookUrl: + - UNSPECIFIED_CATEGORY + - CUSTOM + - FLOW_CONTROL + - DATA_MANIPULATION + - SCRIPTING + - CONNECTOR + - HIDDEN + - CLOUD_SYSTEMS + - CUSTOM_TASK_TEMPLATE + - TASK_RECOMMENDATIONS + isDeprecated: + type: boolean + description: The deprecation status of the current task. Default value is false; + admins: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' + externalDocLink: + type: string + description: Doc link for external-facing documentation (separate from g3doc). + defaultSpec: type: string description: >- - Link to a playbook for resolving the issue that triggered this - alert. - aggregationPeriod: + Contains the initial configuration of the task with default values + set. For now, The string should be compatible to an ASCII-proto + format. + activeTaskName: + description: >- + The new task name to replace the current task if it is deprecated. + Otherwise, it is the same as the current task name. type: string + iconLink: description: >- - For an EXPECTED_MIN threshold, this aggregation_period must be - lesser than 24 hours. - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - thresholdType: + URL to gstatic image icon for this task. This icon shows up on the + task list panel along with the task name in the Workflow Editor + screen. Use the 24p, 2x, gray color icon image format. + type: string + status: enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX + - UNSPECIFIED_STATUS + - DEFAULT_INACTIVE + - ACTIVE + type: string enumDescriptions: - - '' - >- - Note that this field will only trigger alerts if the workflow - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. - - '' - type: string - description: >- - The threshold type, whether lower(expected_min) or - upper(expected_max), for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. - alertDisabled: - type: boolean + Default value. Actual Task Status should always be set to either + INACTIVE or ACTIVE. If none is specified at runtime, it will be + set to INACTIVE. + - Still in-progress or incomplete, and not intended for use. + - Available for use. description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. - thresholdValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + Allows author to indicate if the task is ready to use or not. If not + set, then it will default to INACTIVE. + tags: + items: + type: string + type: array description: >- - The metric value, above or below which the alert should be - triggered. - durationThresholdMs: + A set of tags that pertain to a particular task. This can be used to + improve the searchability of tasks with several names ("REST Caller" + vs. "Call REST Endpoint") or to help users find tasks based on + related words. + docMarkdown: type: string - format: int64 - description: >- - Should be specified only for *AVERAGE_DURATION and - *PERCENTILE_DURATION metrics. This member should be used to specify - what duration value the metrics should exceed for the alert to - trigger. - metricType: + description: Snippet of markdown documentation to embed in the RHP for this task. + externalCategory: + enumDescriptions: + - '' + - '' + - '' + - HTTP tasks, e.g. rest api call task + - Integration services, e.g. connector task + - Customer ations, e.g. email task + - Flow control, e.g. while loop task + - Workspace tasks, e.g. list drive task + - Security, e.g. kms related tasks + - Database operation tasks, e.g. read firestore info tasks + - Analytics tasks, e.g. dataflow creattion tasks + - BYOC tasks + - BYOT tasks + - AI related tasks. + - Data manipulation related tasks, e.g. data mapping task + enum: + - UNSPECIFIED_EXTERNAL_CATEGORY + - CORE + - CONNECTORS + - EXTERNAL_HTTP + - EXTERNAL_INTEGRATION_SERVICES + - EXTERNAL_CUSTOMER_ACTIONS + - EXTERNAL_FLOW_CONTROL + - EXTERNAL_WORKSPACE + - EXTERNAL_SECURITY + - EXTERNAL_DATABASES + - EXTERNAL_ANALYTICS + - EXTERNAL_BYOC + - EXTERNAL_BYOT + - EXTERNAL_ARTIFICIAL_INTELIGENCE + - EXTERNAL_DATA_MANIPULATION + type: string + g3DocLink: + description: URL to the associated G3 Doc for the task if available + type: string + defaultJsonValidationOption: + enum: + - UNSPECIFIED_JSON_VALIDATION_OPTION + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION type: string + description: >- + Controls whether JSON workflow parameters are validated against + provided schemas before and/or after this task's execution. enumDescriptions: - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors for the enclosing - workflow. - - >- - Specifies alerting on the rate of warnings for the enclosing - workflow. Warnings use the same enum values as errors. - - >- - Specifies alerting on the rate of errors for any task in the - enclosing workflow. - - >- - Specifies alerting on the rate of warnings for any task in the - enclosing workflow. - - >- - Specifies alerting on the rate of executions over all tasks in the - enclosing workflow. - - >- - Specifies alerting on the number of events executed in the given - aggregation_period. - - >- - Specifies alerting on the average duration of executions for this - workflow. - - >- - Specifies alerting on the duration value of a particular - percentile of workflow executions. E.g. If 10% or more of the - workflow executions have durations above 5 seconds, alert. + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. - >- - Specifies alerting on the average duration of any task in the - enclosing workflow, + Validate all potential input JSON parameters against schemas + specified in WorkflowParameters. - >- - Specifies alerting on the duration value of a particular - percentile of any task executions within the enclosing workflow. - E.g. If 10% or more of the task executions in the workflow have - durations above 5 seconds, alert. - enum: - - METRIC_TYPE_UNSPECIFIED - - EVENT_ERROR_RATE - - EVENT_WARNING_RATE - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - EVENT_RATE - - EVENT_AVERAGE_DURATION - - EVENT_PERCENTILE_DURATION - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - onlyFinalAttempt: - type: boolean - description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. - alertName: + Validate all potential output JSON parameters against schemas + specified in WorkflowParameters. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. + name: description: >- - A name to identify this alert. This will be displayed in the alert - subject. If set, this name should be unique within the scope of the - workflow. + The actual class name or the annotated name of the task. Task Author + should initialize this field with value from the getName() method of + the Task class. type: string - numAggregationPeriods: + codeSearchLink: + description: The Code Search link to the Task Java file. + type: string + externalCategorySequence: + format: int32 type: integer description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - format: int32 - clientId: - description: Client associated with this alert configuration. + Sequence with which the task in specific category to be displayed in + task discovery panel for external users. + standaloneExternalDocHtml: + description: >- + External-facing documention for standalone IP in pantheon embedded + in the RHP for this task. Non null only if different from + external_doc_html type: string - id: EnterpriseCrmEventbusProtoWorkflowAlertConfig + id: EnterpriseCrmEventbusProtoTaskMetadata description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. - GoogleCloudConnectorsV1ConnectionStatus: - id: GoogleCloudConnectorsV1ConnectionStatus - properties: - status: - description: Status provides detailed information for the state. - type: string - state: - description: State. - type: string - enumDescriptions: - - Connection does not have a state yet. - - Connection is being created. - - Connection is running and ready for requests. - - Connection is stopped. - - Connection is being deleted. - - Connection is being updated. - - Connection is not running due to an error. - - >- - Connection is not running because the authorization configuration - is not complete. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - INACTIVE - - DELETING - - UPDATING - - ERROR - - AUTHORIZATION_REQUIRED - description: - type: string - description: Description. - type: object - description: ConnectionStatus indicates the state of the connection. - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: + TaskMetadata are attributes that are associated to every common Task we + have. + CrmlogErrorCode: properties: - content: - type: string - description: The textproto of the integration_version. - fileFormat: - enumDescriptions: - - Unspecified file format - - JSON File Format - - YAML File Format - type: string + commonErrorCode: enum: - - FILE_FORMAT_UNSPECIFIED - - JSON - - YAML - description: File format for upload request. - type: object - description: Request for UploadIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest - GoogleCloudIntegrationsV1alphaUploadTemplateResponse: - description: Response for UploadTemplate. - properties: - template: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' - description: The uploaded Template - id: GoogleCloudIntegrationsV1alphaUploadTemplateResponse - type: object - EnterpriseCrmEventbusProtoParameterMap: - properties: - entries: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' - keyType: + - COMMON_ERROR_CODE_UNSPECIFIED + - INVALID_CREDENTIALS + - REQUIRED_FIELDS_MISSING + - INVALID_FIELDS + - BACKEND + - GENERAL + - INTERNAL + - IO_ERROR + - NOT_FOUND + - EVENT_BUS + - ALREADY_EXISTS + - CONCORD + - CONVERSION + - FLUME + - PERMISSION + - SALES_FORCE + - SPANNER + - UNIMPLEMENTED + - RELTIO + - WORKFLOW_NOT_FOUND + - QUOTA_THROTTLED + - QUOTA_ENQUEUED + - INVALID_QUOTA_CONFIGURATION + - TASK_NOT_FOUND + - EXECUTION_TIMEOUT + - INVALID_EVENT_EXECUTION_STATE + - INVALID_ATTRIBUTE + - MISSING_ATTRIBUTE + - CLIENT_UNAUTHORIZED_FOR_WORKFLOW + - INVALID_PARAMETER + - MISSING_PARAMETER + - UNAUTHROIZED_WORKFLOW_EDITOR_ACTION + - FAILED_PRECONDITION + - INVALID_CLIENT + - MISSING_CLIENT + - INVALID_WORKFLOW + - MISSING_QUOTA_CONFIGURATION + - UNHANDLED_TASK_ERROR + - SCRIPT_TASK_RUNTIME_ERROR + - RPC + - INVALID_PROTO + - UNHANDLED_EVENTBUS_ERROR + - INVALID_TASK_STATE + - TYPED_TASK_INVALID_INPUT_OPERATION + - TYPED_TASK_INVALID_OUTPUT_OPERATION + - VALIDATION_ERROR + - RESUME_ERROR + - APPS_SCRIPT_EXECUTION_ERROR + - INVALID_VECTOR_USER + - INFORMATICA + - RETRYABLE_TASK_ERROR + - INVALID_TENANT + - WRONG_TENANT + - INFORMATICA_BACKEND_UNAVAILABLE + - RPC_PERMISSION_DENIED + - SYNC_EVENTBUS_EXECUTION_TIMEOUT + - ASYNC_EVENTBUS_EXECUTION_TIMEOUT + - NOT_SUPPORTED_DATA_TYPE + - UNSANITIZED_USER_INPUT + - TRANSFORM_EXPRESSION_EVALUATION_ERROR + - HTTP_EXCEPTION + - EXECUTION_CANCELLED + enumDeprecated: + - false + - true + - false + - false + - true + - true + - true + - false + - false + - true + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + type: string enumDescriptions: - '' - '' @@ -687,57 +1084,9 @@ components: - '' - '' - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - '' - '' - '' - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - type: string - description: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. - valueType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - enumDescriptions: - '' - '' - '' @@ -752,1661 +1101,1382 @@ components: - '' - '' - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. + ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use + only. This error will be counted as server availability error. - '' - '' - '' - type: string - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - type: object - id: EnterpriseCrmEventbusProtoParameterMap - GoogleCloudIntegrationsV1alphaProjectProperties: - id: GoogleCloudIntegrationsV1alphaProjectProperties + - '' + - '' + id: CrmlogErrorCode type: object - description: Metadata information for the given project + description: >- + Registered ids for errors, as "oneof" enums. Each task or logical + grouping of tasks may share the same enum. + EnterpriseCrmEventbusProtoIntArrayFunction: properties: - ipEnablementState: - enum: - - IP_ENABLEMENT_STATE_UNSPECIFIED - - IP_ENABLEMENT_STATE_STANDALONE - - IP_ENABLEMENT_STATE_APIGEE - - IP_ENABLEMENT_STATE_APIGEE_ENTITLED - description: An enum value of what the enablement state is for the given project - enumDescriptions: - - The client enablement status is unspecified - - The client is enabled on Standalone IP - - The client is enabled on Apigee - - The client is entitled for Apigee but not enabled + functionName: type: string - billingType: - enumDescriptions: - - '' - - A trial org provisioned through Apigee Provisioning Wizard - - >- - Subscription based on concurrency model for Apigee and Application - Integration users. - - Consumption based users of IP - - >- - Argentum subscription for Application Integration users. To be - used in the future. - - >- - Special billing type to avoid any billing to clients (eg: trusted - tester program). This should not be used without consulting with - the leads. enum: - - BILLING_TYPE_UNSPECIFIED - - APIGEE_TRIALS - - APIGEE_SUBSCRIPTION - - PAYG - - SUBSCRIPTION - - NO_BILLING - description: 'Required. Required: The client billing type that was requested' - type: string - provisionedRegions: - items: - type: string - type: array - description: A list of provisioned regions on the current project - EnterpriseCrmEventbusProtoAddress: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + id: EnterpriseCrmEventbusProtoIntArrayFunction + type: object + GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: properties: - name: - type: string - email: + content: + description: String representation of the requested file. type: string - description: Required. - tokens: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' + files: type: array - description: >- - Email address along with optional name and tokens. These tokens will be - substituted for the variables in the form of [{var_name}], where - var_name could be any string of no more than 32 bytes. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' + description: List containing String represendation for multiple file with type. + id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + description: Response for DownloadIntegrationVersion. type: object - id: EnterpriseCrmEventbusProtoAddress - GoogleCloudIntegrationsV1alphaSuspension: - id: GoogleCloudIntegrationsV1alphaSuspension + GoogleCloudIntegrationsV1alphaCloudLoggingDetails: + type: object + description: Cloud Logging details for execution info + id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails properties: - approvalConfig: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + enableCloudLogging: description: >- - Controls the notifications and approval permissions for this - suspension. - createTime: - format: google-datetime + Optional. Status of whether Cloud Logging is enabled or not for the + integration version getting executed. + type: boolean + cloudLoggingSeverity: + enumDescriptions: + - Unspecified + - >- + If Severity selected is `INFO`, then all the Integration Execution + States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, + `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + - >- + If Severity selected is `ERROR`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + - >- + If Severity selected is `WARNING`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + description: >- + Optional. Severity selected by the customer for the logs to be sent + to Cloud Logging, for the integration version getting executed. + enum: + - CLOUD_LOGGING_SEVERITY_UNSPECIFIED + - INFO + - ERROR + - WARNING type: string - description: Output only. Auto-generated. - readOnly: true - integration: - description: Required. The name of the originating integration. + EnterpriseCrmEventbusProtoBooleanFunction: + id: EnterpriseCrmEventbusProtoBooleanFunction + properties: + functionName: + enum: + - UNSPECIFIED + - TO_JSON + - NOT + - AND + - NAND + - OR + - XOR + - NOR + - XNOR + - TO_STRING + - EQUALS + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - eventExecutionInfoId: - description: Required. ID of the associated execution. + type: object + GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: + description: Cloud Scheduler Trigger configuration + properties: + errorMessage: type: string - name: + description: >- + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations + location: type: string - description: Resource name for suspensions suspension/{suspension_id} - taskId: + description: >- + Required. The location where associated cloud scheduler job will be + created + cronTab: type: string - description: Required. Task id of the associated SuspensionTask. - state: + description: Required. The cron tab of cloud scheduler trigger. + serviceAccountEmail: type: string description: >- - Required. State of this suspension, indicating what action a - resolver has taken. - enumDescriptions: - - Unset state. - - The suspension has not yet been resolved. - - The resolver has rejected the suspension. - - The resolver has lifted the suspension. - enum: - - RESOLUTION_STATE_UNSPECIFIED - - PENDING - - REJECTED - - LIFTED - suspensionConfig: - deprecated: true - description: >- - Controls the notifications and resolver permissions for this - suspension. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - lastModifyTime: - type: string - description: Output only. Auto-generated. - readOnly: true - format: google-datetime - audit: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' - description: Metadata pertaining to the resolution of this suspension. - description: A record representing a suspension. + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time + id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig type: object - EnterpriseCrmEventbusProtoValueType: + GoogleCloudConnectorsV1NodeConfig: type: object - description: >- - Used for define type for values. Currently supported value types include - int, string, double, array, and any proto message. properties: - protoValue: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' - doubleValue: - format: double - type: number - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' - stringValue: - type: string - intValue: - format: int64 - type: string - booleanValue: - type: boolean - id: EnterpriseCrmEventbusProtoValueType - EnterpriseCrmEventbusProtoFailurePolicy: - id: EnterpriseCrmEventbusProtoFailurePolicy + maxNodeCount: + type: integer + format: int32 + description: Maximum number of nodes in the runtime nodes. + minNodeCount: + format: int32 + type: integer + description: Minimum number of nodes in the runtime nodes. + id: GoogleCloudConnectorsV1NodeConfig + description: Node configuration for the connection. + GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: + id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + description: Request for the Deprovision rpc + type: object + properties: {} + EnterpriseCrmEventbusProtoBooleanArrayFunction: properties: - retryCondition: - description: >- - Optional. The retry condition that will be evaluated for this - failure policy with the corresponding retry strategy. + functionName: type: string - retryStrategy: + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + id: EnterpriseCrmEventbusProtoBooleanArrayFunction + type: object + EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails: + description: >- + Contains the details of the execution info of this event: this includes + the tasks execution details plus the event execution statistics. Next + available id: 12 + properties: + eventExecutionSnapshot: + description: >- + After snapshot migration, this field will no longer be populated, + but old execution snapshots will still be accessible. + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + type: array + nextExecutionTime: + format: int64 type: string - description: Defines what happens to the task upon failure. + description: >- + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. + eventExecutionSnapshotsSize: + type: string + description: Total size of all event_execution_snapshots for an execution + format: int64 + eventRetriesFromBeginningCount: + description: >- + Indicates the number of times the execution has restarted from the + beginning. + format: int32 + type: integer + logFilePath: + description: The log file path (aka. cns address) for this event. + type: string + networkAddress: + type: string + description: >- + The network address (aka. bns address) that indicates where the + event executor is running. + ryeLockUnheldCount: + format: int32 + type: integer + description: >- + Used internally and shouldn't be exposed to users. A counter for the + cron job to record how many times this event is in in_process state + but don't have a lock consecutively/ + cancelReason: + type: string + description: >- + If the execution is manually canceled, this field will contain the + reason for cancellation. + eventExecutionState: enumDescriptions: - '' - >- - Ignores the failure of this task. The rest of the workflow will be - executed Assuming this task succeeded. - - >- - Causes a permanent failure of the task. However, if the last - task(s) of event was successfully completed despite the failure of - this task, it has no impact on the workflow. - - >- - Causes a permanent failure of the event. It is different from NONE - because this will mark the event as FAILED by shutting down the - event execution. - - >- - The task will be retried from the failed task onwards after a - fixed delay. A max-retry count is required to be specified with - this strategy. A jitter is added to each exponential interval so - that concurrently failing tasks of the same type do not end up - retrying after the exact same exponential interval. - Max_num_retries and interval_in_seconds must be specified. - - >- - The task will be retried from the failed task onwards after a - fixed delay that linearly increases with each retry attempt. A - jitter is added to each exponential interval so that concurrently - failing tasks of the same type do not end up retrying after the - exact same exponential interval. A max-retry count is required to - be specified with this strategy. Max_num_retries and - interval_in_seconds must be specified. + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. - >- - The task will be retried after an exponentially increasing period - of time with each failure. A jitter is added to each exponential - interval so that concurrently failing tasks of the same type do - not end up retrying after the exact same exponential interval. A - max-retry count is required to be specified with this strategy. - `max_num_retries` and `interval_in_seconds` must be specified. + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. - >- - The entire workflow will be restarted with the initial parameters - that were set when the event was fired. A max-retry count is - required to be specified with this strategy. `max_num_retries` and - `interval_in_seconds` must be specified. + Event execution canceled by user. There's no more change after + this state. + - Event execution failed and waiting for retry. + - Event execution suspended and waiting for manual intervention. + description: The execution state of this event. enum: - UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_WORKFLOW_WITH_BACKOFF - intervalInSeconds: + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED + type: string + eventAttemptStats: + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + type: array + type: object + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails + EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: + properties: + rollbackTaskImplementationClassName: description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the initial interval for backoff. + Required. This is the name of the task that needs to be executed + upon rollback of this task. type: string - format: int64 - maxNumRetries: - type: integer - format: int32 + parameters: + description: Optional. The customized parameters the user can pass to this task. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + taskNumbersToRollback: + type: array + items: + type: string description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the number of times the task will be retried if failed. - description: >- - Policy that defines the task retry logic and failure type. If no - FailurePolicy is defined for a task, all its dependent tasks will not be - executed (i.e, a `retry_strategy` of NONE will be applied). - type: object - GoogleCloudIntegrationsV1alphaRuntimeActionSchema: + Required. These are the tasks numbers of the tasks whose + `rollback_strategy.rollback_task_implementation_class_name` needs to + be executed upon failure of this task. + id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy type: object + description: 'Next available id: 4' + EnterpriseCrmEventbusProtoPropertyEntry: properties: - action: - description: Name of the action. - type: string - outputSchema: - description: Output parameter schema for the action. - type: string - inputSchema: + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. + key: type: string - description: Input parameter schema for the action. - id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema - description: Metadata of an action, including schemas for its inputs and outputs. - EnterpriseCrmEventbusProtoExternalTraffic: + description: >- + Key is used to retrieve the corresponding property value. This + should be unique for a given fired event. The Tasks should be aware + of the keys used while firing the events for them to be able to + retrieve the values. type: object - id: EnterpriseCrmEventbusProtoExternalTraffic - description: Represents external traffic type and id. + id: EnterpriseCrmEventbusProtoPropertyEntry + description: Key-value pair of EventBus property. + EnterpriseCrmEventbusProtoIntFunction: properties: - retryRequestForQuota: - description: Enqueue the execution request due to quota issue - type: boolean - gcpProjectNumber: - type: string - description: User’s GCP project number the traffic is referring to. - location: - description: Location for the user's request. - type: string - gcpProjectId: - type: string - description: User’s GCP project id the traffic is referring to. - source: - type: string - enum: - - SOURCE_UNSPECIFIED - - APIGEE - - SECURITY + functionName: enumDescriptions: - '' - '' - '' - enableInternalIp: - type: boolean - description: >- - Indicates the client enables internal IP feature, this is applicable - for internal clients only. - GoogleCloudConnectorsV1EventingConfig: - properties: - deadLetterConfig: - description: Optional. Dead letter configuration for eventing of a connection. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - proxyDestinationConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - description: Optional. Proxy for Eventing auto-registration. - authConfig: - description: Auth details for the webhook adapter. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - eventsListenerIngressEndpoint: - type: string - description: >- - Optional. Ingress endpoint of the event listener. This is used only - when private connectivity is enabled. - enrichmentEnabled: - type: boolean - description: Enrichment Enabled. - additionalVariables: - description: Additional eventing related field values - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - type: array - registrationDestinationConfig: - description: Registration endpoint for auto registration. - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - privateConnectivityEnabled: - description: Optional. Private Connectivity Enabled. - type: boolean - listenerAuthConfig: - description: Optional. Auth details for the event listener. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - id: GoogleCloudConnectorsV1EventingConfig - description: Eventing Configuration of a connection - type: object - GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: - id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse - properties: - nextPageToken: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - GREATER_THAN_EQUAL_TO + - GREATER_THAN + - LESS_THAN_EQUAL_TO + - LESS_THAN + - TO_DOUBLE + - TO_STRING + - EQUALS + - TO_JSON + - MOD + - EPOCH_TO_HUMAN_READABLE_TIME type: string - description: The token used to retrieve the next page of results. - sfdcInstances: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' - type: array - description: The list of SfdcInstances retrieved. - description: Response to list SfdcInstances. - type: object - EnterpriseCrmEventbusProtoTransformExpression: - properties: - transformationFunctions: - description: Transformations to be applied sequentially. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' - type: array - initialValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' - description: Initial value upon which to perform transformations. - id: EnterpriseCrmEventbusProtoTransformExpression - type: object - EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray - properties: - doubleValues: - items: - type: number - format: double - type: array type: object - GoogleCloudIntegrationsV1alphaIntParameterArray: - id: GoogleCloudIntegrationsV1alphaIntParameterArray - properties: - intValues: - description: Integer array. - items: - type: string - format: int64 - type: array - description: This message only contains a field of integer array. + id: EnterpriseCrmEventbusProtoIntFunction + GoogleCloudConnectorsV1EncryptionKey: + id: GoogleCloudConnectorsV1EncryptionKey type: object - EnterpriseCrmEventbusProtoParamSpecEntryConfig: - id: EnterpriseCrmEventbusProtoParamSpecEntryConfig + description: Encryption Key value. properties: - descriptivePhrase: - type: string - description: A short phrase to describe what this parameter contains. - label: - type: string - description: A user-friendly label for the parameter. - inputDisplayOption: + kmsKeyName: + description: >- + The [KMS key name] with which the content of the Operation is + encrypted. The expected format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty + string if google managed. type: string + type: + description: Type. enumDescriptions: - - >- - A single-line input for strings, a numeric input box for numbers, - or a checkbox for booleans. - - A multi-line input box for longer strings/string templates. - - >- - A slider to select a numerical value. The default range is [0, - 100]. - - A toggle button for boolean parameters. + - Value type is not specified. + - Google Managed. + - Customer Managed. + type: string enum: - - DEFAULT - - STRING_MULTI_LINE - - NUMBER_SLIDER - - BOOLEAN_TOGGLE - hideDefaultValue: - type: boolean - description: Whether the default value is hidden in the UI. - subSectionLabel: + - TYPE_UNSPECIFIED + - GOOGLE_MANAGED + - CUSTOMER_MANAGED + GoogleCloudIntegrationsV1alphaUsernameAndPassword: + properties: + password: type: string - description: >- - A user-friendly label for subSection under which the parameter will - be displayed. - helpText: + description: Password to be used + username: + description: Username to be used type: string - description: >- - Detailed help text for this parameter containing information not - provided elsewhere. For example, instructions on how to migrate from - a deprecated parameter. - uiPlaceholderText: - description: >- - Placeholder text which will appear in the UI input form for this - parameter. + id: GoogleCloudIntegrationsV1alphaUsernameAndPassword + description: Username and password pair. + type: object + EnterpriseCrmEventbusProtoNodeIdentifier: + description: 'Represents a node identifier (type + id). Next highest id: 3' + id: EnterpriseCrmEventbusProtoNodeIdentifier + type: object + properties: + elementIdentifier: type: string - isHidden: - type: boolean - description: Whether this field is hidden in the UI. - parameterNameOption: + description: Configuration of the edge. + elementType: + description: Destination node where the edge ends. It can only be a task config. enum: - - DEFAULT_NOT_PARAMETER_NAME - - IS_PARAMETER_NAME - - KEY_IS_PARAMETER_NAME - - VALUE_IS_PARAMETER_NAME - type: string + - UNKNOWN_TYPE + - TASK_CONFIG + - TRIGGER_CONFIG enumDescriptions: - - This field is not a parameter name. - - >- - If this field is a string and this option is selected, the field - will be interpreted as a parameter name. Users will be able to - choose a variable using the autocomplete, but the name will be - stored as a literal string. - - >- - If this field is a ParameterMap and this option is selected, the - map's keys will be interpreted as parameter names. Ignored if this - field is not a ParameterMap. - - >- - If this field is a ParameterMap and this option is selected, the - map's values will be interpreted as parameter names. Ignored if - this field is not a ParameterMap. - type: object - GoogleCloudConnectorsV1ConfigVariable: - type: object - id: GoogleCloudConnectorsV1ConfigVariable + - '' + - '' + - '' + type: string + GoogleCloudIntegrationsV1alphaOidcToken: properties: - intValue: + serviceAccountEmail: + description: The service account email to be used as the identity for the token. type: string - description: Value is an integer - format: int64 - encryptionKeyValue: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' - description: Value is a Encryption Key. - key: - description: Key of the config variable. + token: type: string - stringValue: - description: Value is a string. + description: ID token obtained for the service account + tokenExpireTime: + description: The approximate time until the token retrieved is valid. + format: google-datetime type: string - secretValue: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Value is a secret. - boolValue: - description: Value is a bool. - type: boolean + audience: + type: string + description: >- + Audience to be used when generating OIDC token. The audience claim + identifies the recipients that the JWT is intended for. + type: object + id: GoogleCloudIntegrationsV1alphaOidcToken + description: OIDC Token + EnterpriseCrmEventbusProtoTaskAlertConfig: description: >- - ConfigVariable represents a configuration variable present in a - Connection. or AuthConfig. - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: + Message to be used to configure alerting in the {@code TaskConfig} + protos for tasks in an event. + id: EnterpriseCrmEventbusProtoTaskAlertConfig properties: - taskName: - description: the task name associated with this snapshot. Could be empty. + durationThresholdMs: + format: int64 type: string - ancestorIterationNumbers: - items: - type: string - type: array description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - taskLabel: - description: the task label associated with this snapshot. Could be empty. + Should be specified only for TASK_AVERAGE_DURATION and + TASK_PERCENTILE_DURATION metrics. This member should be used to + specify what duration value the metrics should exceed for the alert + to trigger. + alertName: type: string - ancestorTaskNumbers: - type: array description: >- - Ancestor task number for the task(it will only be non-empty if the - task is under 'private workflow') - items: - type: string - integrationName: + A name to identify this alert. This will be displayed in the alert + subject. If set, this name should be unique in within the scope of + the containing workflow. + thresholdValue: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + description: >- + The metric value, above or below which the alert should be + triggered. + aggregationPeriod: type: string description: >- - The direct integration which the event execution snapshots belongs - to - eventAttemptNum: - description: the event attempt number this snapshot belongs to. + The period over which the metric value should be aggregated and + evaluated. Format is , where integer should be a positive integer + and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, + day, week). + numAggregationPeriods: format: int32 + description: >- + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. type: integer - taskNumber: + thresholdType: type: string - description: The task number associated with this snapshot. Could be empty. - taskAttemptNum: - description: the task attempt number this snapshot belongs to. Could be empty. - type: integer - format: int32 - type: object - id: >- - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - GoogleCloudIntegrationsV1alphaErrorCatcherConfig: - properties: - startErrorTasks: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - type: array - description: >- - Required. The set of start tasks that are to be executed for the - error catch flow - position: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - description: + The threshold type for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. + enumDescriptions: + - '' + - >- + Note that this field will only trigger alerts if the workflow + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. + - '' + enum: + - UNSPECIFIED_THRESHOLD_TYPE + - EXPECTED_MIN + - EXPECTED_MAX + playbookUrl: type: string description: >- - Optional. User-provided description intended to give more business - context about the error catcher config. - label: - type: string + Link to a playbook for resolving the issue that triggered this + alert. + onlyFinalAttempt: + type: boolean + description: Only count final task attempts, not retries. + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + alertDisabled: + type: boolean description: >- - Optional. The user created label for a particular error catcher. - Optional. - errorCatcherNumber: - type: string + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + clientId: description: >- - Required. A number to uniquely identify each error catcher config - within the workflow on UI. - errorCatcherId: + Client associated with this alert configuration. Must be a client + enabled in one of the containing workflow's triggers. type: string - description: >- - Required. An error catcher id is string representation for the error - catcher config. Within a workflow, error_catcher_id uniquely - identifies an error catcher config among all error catcher configs - for the workflow + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + metricType: + enumDescriptions: + - >- + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. + - >- + Specifies alerting on the rate of errors (potentially for a + specific set of enum values) for the enclosing TaskConfig. + - >- + Specifies alerting on the rate of warnings (potentially for a + specific set of enum values) for the enclosing TaskConfig. + Warnings use the same enum values as errors. + - >- + Specifies alerting on the number of instances for the enclosing + TaskConfig executed in the given aggregation_period. + - >- + Specifies alerting on the average duration of execution for the + enclosing task. + - >- + Specifies alerting on the duration of a particular percentile of + task executions. E.g. If 10% or more of the task executions have + durations above 5 seconds, alert. + type: string + enum: + - METRIC_TYPE_UNSPECIFIED + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION type: object - id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig - description: Configuration detail of a error catch task - GoogleCloudIntegrationsV1alphaAccessToken: + GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: + description: The response for executing an integration. properties: - accessToken: - type: string + outputParameters: + additionalProperties: + description: Properties of the object. + type: any description: >- - The access token encapsulating the security identity of a process or - thread. - refreshTokenExpireTime: - format: google-datetime - description: The approximate time until the refresh token retrieved is valid. - type: string - tokenType: + OUTPUT parameters in format of Map. Where Key is the name of the + parameter. Note: Name of the system generated parameters are wrapped + by backtick(`) to distinguish them from the user defined parameters. + type: object + eventParameters: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + deprecated: true + description: Details for the integration that were executed. + executionId: type: string + description: The id of the execution corresponding to this run of integration. + executionFailed: + description: Is true if any execution in the integration failed. False otherwise. + deprecated: true + type: boolean + parameterEntries: + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: array description: >- - Only support "bearer" token in v1 as bearer token is the predominant - type used with OAuth 2.0. - refreshToken: - type: string + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + type: object + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + GoogleCloudIntegrationsV1alphaListSuspensionsResponse: + type: object + properties: + suspensions: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' description: >- - If the access token will expire, use the refresh token to obtain - another access token. - accessTokenExpireTime: - format: google-datetime + The suspensions for the relevant execution which the caller has + permissions to view and resolve. + nextPageToken: + description: Token to retrieve the next page of results. type: string - description: >- - Required. The approximate time until the access token retrieved is - valid. - id: GoogleCloudIntegrationsV1alphaAccessToken - description: >- - The access token represents the authorization of a specific application - to access specific parts of a user’s data. + id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse + description: Response for Suspensions.ListSuspensions. + GoogleCloudConnectorsV1ConfigVariable: type: object - GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: - id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - description: Metadata of an entity, including a schema for its properties. properties: - entity: - description: Name of the entity. + boolValue: + type: boolean + description: Value is a bool. + intValue: type: string - fieldSchema: + description: Value is an integer + format: int64 + stringValue: type: string - description: List of fields in the entity. - arrayFieldSchema: - description: The above schema, but for an array of the associated entity. + description: Value is a string. + secretValue: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Value is a secret. + encryptionKeyValue: + description: Value is a Encryption Key. + $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' + key: type: string + description: Key of the config variable. + id: GoogleCloudConnectorsV1ConfigVariable + description: >- + ConfigVariable represents a configuration variable present in a + Connection. or AuthConfig. + GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: + type: object + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + description: Request for TakeoverEditLock. + properties: {} + GoogleCloudIntegrationsV1alphaExecutionReplayInfo: + id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo type: object - GoogleCloudIntegrationsV1alphaFailurePolicy: properties: - maxRetries: - type: integer - description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines - the number of times the task will be retried if failed. - format: int32 - condition: - description: >- - Optional. The string condition that will be evaluated to determine - if the task should be retried with this failure policy. + originalExecutionInfoId: type: string - retryStrategy: - description: Defines what happens to the task upon failure. - enum: - - RETRY_STRATEGY_UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_INTEGRATION_WITH_BACKOFF - type: string - enumDescriptions: - - UNSPECIFIED. - - >- - Ignores the failure of this task. The rest of the integration will - be executed Assuming this task succeeded. - - >- - Causes a permanent failure of the task. However, if the last - task(s) of event was successfully completed despite the failure of - this task, it has no impact on the integration. - - >- - Causes a permanent failure of the event. It is different from NONE - because this will mark the event as FAILED by shutting down the - event execution. - - >- - The task will be retried from the failed task onwards after a - fixed delay. A max-retry count is required to be specified with - this strategy. A jitter is added to each exponential interval so - that concurrently failing tasks of the same type do not end up - retrying after the exact same exponential interval. max_retries - and interval_in_seconds must be specified. - - >- - The task will be retried from the failed task onwards after a - fixed delay that linearly increases with each retry attempt. A - jitter is added to each exponential interval so that concurrently - failing tasks of the same type do not end up retrying after the - exact same exponential interval. A max-retry count is required to - be specified with this strategy. max_retries and - interval_in_seconds must be specified. - - >- - The task will be retried after an exponentially increasing period - of time with each failure. A jitter is added to each exponential - interval so that concurrently failing tasks of the same type do - not end up retrying after the exact same exponential interval. A - max-retry count is required to be specified with this strategy. - `max_retries` and `interval_in_seconds` must be specified. - - >- - The entire integration will be restarted with the initial - parameters that were set when the event was fired. A max-retry - count is required to be specified with this strategy. - `max_retries` and `interval_in_seconds` must be specified. - intervalTime: - format: google-datetime description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines - the initial interval in seconds for backoff. + If this execution is a replay of another execution, then this field + contains the original execution id. + replayedExecutionInfoIds: + type: array + items: + type: string + description: >- + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. + replayReason: type: string + description: reason for replay description: >- - Policy that defines the task retry logic and failure type. If no - FailurePolicy is defined for a task, all its dependent tasks will not be - executed (i.e, a `retry_strategy` of NONE will be applied). - type: object - id: GoogleCloudIntegrationsV1alphaFailurePolicy - GoogleCloudIntegrationsV1alphaExecuteEventResponse: - id: GoogleCloudIntegrationsV1alphaExecuteEventResponse - properties: - executionId: - description: The id of the execution corresponding to this run of integration. - type: string - description: The response for executing an integration. - type: object - GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship + GoogleCloudConnectorsV1LockConfig: + id: GoogleCloudConnectorsV1LockConfig + description: >- + Determines whether or no a connection is locked. If locked, a reason + must be specified. properties: - triggerId: - description: >- - Required. Matched against all {@link TriggerConfig}s across all - integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The - trigger_id is in the format of `api_trigger/TRIGGER_NAME`. - type: string - executionId: - type: string - description: Optional. The id of the ON_HOLD execution to be resumed. - inputParameters: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Optional. Input parameters used by integration execution. - requestId: - type: string - description: >- - Optional. This is used to de-dup incoming request: if the duplicate - request was detected, the response from the previous execution is - returned. - parameters: - deprecated: true - description: >- - Optional. Passed in as parameters to each integration execution. - Redacted - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - doNotPropagateError: - description: >- - Optional. Flag to determine how to should propagate errors. If this - flag is set to be true, it will not throw an exception. Instead, it - will return a {@link ExecuteIntegrationsResponse} with an execution - id and error messages as PostWithTriggerIdExecutionException in - {@link EventParameters}. The flag is set to be false by default. + locked: + description: Indicates whether or not the connection is locked. type: boolean - parameterEntries: - deprecated: true - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: >- - Optional. Parameters are a part of Event and can be used to - communicate between different tasks that are part of the same - integration execution. - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + reason: + description: Describes why a connection is locked. + type: string type: object - description: The request for executing an integration. - EnterpriseCrmEventbusProtoTaskAlertConfig: + EnterpriseCrmEventbusProtoLogSettings: description: >- - Message to be used to configure alerting in the {@code TaskConfig} - protos for tasks in an event. + The LogSettings define the logging attributes for an event property. + These attributes are used to map the property to the parameter in the + log proto. Also used to define scrubbing/truncation behavior and PII + information. + type: object properties: - alertDisabled: - type: boolean - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. - clientId: + logFieldName: type: string description: >- - Client associated with this alert configuration. Must be a client - enabled in one of the containing workflow's triggers. - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - thresholdType: + The name of corresponding logging field of the event property. If + omitted, assumes the same name as the event property key. + seedPeriod: enumDescriptions: - '' + - Sanitized values remain constant for the day of the event. - >- - Note that this field will only trigger alerts if the workflow - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. + Sanitized values remain constant for the week of the event; may + cross month boundaries. + - Sanitized values remain constant for the month of the event. + type: string + enum: + - SEED_PERIOD_UNSPECIFIED + - DAY + - WEEK + - MONTH + seedScope: + enum: + - SEED_SCOPE_UNSPECIFIED + - EVENT_NAME + - TIME_PERIOD + - PARAM_NAME + type: string + enumDescriptions: - '' + - Hash computations include the event name. + - Hash computations include a time period. + - Hash computations include the param name. + id: EnterpriseCrmEventbusProtoLogSettings + EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: + id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig + properties: + operation: enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX - description: >- - The threshold type for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. + - OPERATION_UNSPECIFIED + - EXECUTE_ACTION + - LIST_ENTITIES + - GET_ENTITY + - CREATE_ENTITY + - UPDATE_ENTITY + - DELETE_ENTITY + - EXECUTE_QUERY type: string - onlyFinalAttempt: - description: Only count final task attempts, not retries. - type: boolean - playbookUrl: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: Operation to perform using the configured connection. + connection: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' + description: User-selected connection. + type: object + GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: + properties: + fieldSchema: + description: List of fields in the entity. type: string - description: >- - Link to a playbook for resolving the issue that triggered this - alert. - numAggregationPeriods: - type: integer - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - format: int32 - alertName: - description: >- - A name to identify this alert. This will be displayed in the alert - subject. If set, this name should be unique in within the scope of - the containing workflow. + arrayFieldSchema: type: string - aggregationPeriod: + description: The above schema, but for an array of the associated entity. + entity: + type: string + description: Name of the entity. + id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + description: Metadata of an entity, including a schema for its properties. + type: object + EnterpriseCrmEventbusProtoCloudSchedulerConfig: + description: Cloud Scheduler Trigger configuration + properties: + serviceAccountEmail: type: string description: >- - The period over which the metric value should be aggregated and - evaluated. Format is , where integer should be a positive integer - and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, - day, week). - thresholdValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - description: >- - The metric value, above or below which the alert should be - triggered. - metricType: + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time + errorMessage: + description: >- + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations type: string - enumDescriptions: - - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors (potentially for a - specific set of enum values) for the enclosing TaskConfig. - - >- - Specifies alerting on the rate of warnings (potentially for a - specific set of enum values) for the enclosing TaskConfig. - Warnings use the same enum values as errors. - - >- - Specifies alerting on the number of instances for the enclosing - TaskConfig executed in the given aggregation_period. - - >- - Specifies alerting on the average duration of execution for the - enclosing task. - - >- - Specifies alerting on the duration of a particular percentile of - task executions. E.g. If 10% or more of the task executions have - durations above 5 seconds, alert. - enum: - - METRIC_TYPE_UNSPECIFIED - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - durationThresholdMs: - format: int64 + cronTab: + description: Required. The cron tab of cloud scheduler trigger. + type: string + location: type: string description: >- - Should be specified only for TASK_AVERAGE_DURATION and - TASK_PERCENTILE_DURATION metrics. This member should be used to - specify what duration value the metrics should exceed for the alert - to trigger. - id: EnterpriseCrmEventbusProtoTaskAlertConfig + Required. The location where associated cloud scheduler job will be + created + id: EnterpriseCrmEventbusProtoCloudSchedulerConfig type: object - GoogleCloudIntegrationsV1alphaSerializedFile: + EnterpriseCrmEventbusProtoEventBusProperties: + id: EnterpriseCrmEventbusProtoEventBusProperties + description: >- + LINT.IfChange This message is used for storing key value pair properties + for each Event / Task in the EventBus. type: object properties: - file: - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - description: >- - File information like Integration version, Integration Config - variables etc. + properties: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' + description: An unordered list of property entries. + GoogleCloudConnectorsV1EventingStatus: + description: EventingStatus indicates the state of eventing. + properties: + description: type: string - content: + description: Output only. Description of error if State is set to "ERROR". + readOnly: true + state: + readOnly: true type: string - description: String representation of the file content. - description: To store string representation of Integration file. - id: GoogleCloudIntegrationsV1alphaSerializedFile - EnterpriseCrmEventbusProtoSuspensionAuthPermissions: - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions + description: Output only. State. + enumDescriptions: + - Default state. + - Eventing is enabled and ready to receive events. + - Eventing is not active due to an error. + - Ingress endpoint required. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - ERROR + - INGRESS_ENDPOINT_REQUIRED type: object + id: GoogleCloudConnectorsV1EventingStatus + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: + description: Rule used to validate strings. + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex properties: - googleGroup: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - gaiaIdentity: - description: Represents a Gaia identity for a person or service account. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - loasRole: - type: string - mdbGroup: + exclusive: + type: boolean + description: >- + Whether the regex matcher is applied exclusively (if true, matching + values will be rejected). + regex: type: string - description: LINT.IfChange - GoogleCloudIntegrationsV1alphaTemplate: - id: GoogleCloudIntegrationsV1alphaTemplate + description: The regex applied to the input value(s). + type: object + GoogleCloudIntegrationsV1alphaSfdcChannel: properties: - usageInfo: - type: string - description: >- - Optional. Information on how to use the template. This should - contain detailed information about usage of the template. - templateBundle: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplateBundle' - description: >- - Required. Bundle which is part of the templates. The template - entities in the bundle would be converted to an actual entity. - docLink: + displayName: type: string - description: Optional. Link to template documentation. + description: Client level unique name/alias to easily reference a channel. name: type: string - description: Identifier. Resource name of the template. - lastUsedTime: - description: Optional. Time the template was last used. - format: google-datetime - type: string - components: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTemplateComponent description: >- - Optional. Components being used in the template. This could be used - to categorize and filter. - type: array - sharedWith: - items: - type: string - type: array + Resource name of the SFDC channel + projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. + isActive: + type: boolean description: >- - Required. Resource names with which the template is shared for - example ProjectNumber/Ord id - author: - type: string - description: Optional. Creator of the template. + Indicated if a channel has any active integrations referencing it. + Set to false when the channel is created, and set to true if there + is any integration published with the channel configured in it. updateTime: + readOnly: true + type: string + description: Output only. Time when the channel was last updated + format: google-datetime + createTime: type: string - description: Output only. Auto-generated format: google-datetime + description: Output only. Time when the channel is created readOnly: true - categories: - type: array - items: - type: string - enumDescriptions: - - Category is unspecified - - AI_MACHINE_LEARNING - - BUSINESS_INTELLIGENCE - - COLLABORATION - - CUSTOMER_SERVICE - - DATAABASES - - DEVOPS_IT - - CONTENT_AND_FILES - - FINANCE_AND_ACCOUNTING - - HUMAN_RESOURCES - - OPERATIONS - - PRODUCT_PROJECT_MANAGEMENT - - PRODUCTIVITY - - SALES_AND_MARKETING - - UNIVERSAL_CONNECTORS - - UTILITY - - OTHERS - enum: - - CATEGORY_UNSPECIFIED - - AI_MACHINE_LEARNING - - BUSINESS_INTELLIGENCE - - COLLABORATION - - CUSTOMER_SERVICE - - DATABASES - - DEVOPS_IT - - CONTENT_AND_FILES - - FINANCE_AND_ACCOUNTING - - HUMAN_RESOURCES - - OPERATIONS - - PRODUCT_PROJECT_MANAGEMENT - - PRODUCTIVITY - - SALES_AND_MARKETING - - UNIVERSAL_CONNECTORS - - UTILITY - - OTHERS - description: >- - Required. Categories associated with the Template. The categories - listed below will be utilized for the Template listing. + channelTopic: + description: The Channel topic defined by salesforce once an channel is opened + type: string + lastReplayId: + description: Last sfdc messsage replay id for channel + type: string description: + description: The description for this channel type: string + deleteTime: + format: google-datetime description: >- - Optional. Description of the template. The length should not be more - than 255 characters - visibility: - enum: - - VISIBILITY_UNSPECIFIED - - PRIVATE - - SHARED - - PUBLIC + Output only. Time when the channel was deleted. Empty if not + deleted. + readOnly: true type: string - enumDescriptions: - - Visibility is unspecified - - Visibility is private - - Visibility is shared - - Visibility is public - description: Required. Visibility of the template. - displayName: + id: GoogleCloudIntegrationsV1alphaSfdcChannel + description: The SfdcChannel that points to a CDC or Platform Event Channel. + type: object + GoogleCloudConnectorsV1EventingRuntimeData: + description: >- + Eventing runtime data has the details related to eventing managed by the + system. + id: GoogleCloudConnectorsV1EventingRuntimeData + properties: + status: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' + description: Output only. Current status of eventing. + webhookData: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + description: Output only. Webhook data. + readOnly: true + eventsListenerPscSa: type: string - description: Required. The name of the template - tags: + readOnly: true description: >- - Required. Tags which are used to identify templates. These tags - could be for business use case, connectors etc. - type: array - items: - type: string - usageCount: + Output only. Events listener PSC Service attachment. The value will + be populated after provisioning the events listener with private + connectivity enabled. + eventsListenerEndpoint: type: string - description: Optional. Number of template usages. - format: int64 - createTime: readOnly: true - format: google-datetime - type: string - description: Output only. Auto-generated. - description: Defines the template for Application Integration - type: object - EnterpriseCrmEventbusProtoNextTeardownTask: - properties: - name: - description: Required. Name of the next teardown task. - type: string - type: object - description: >- - The teardown task that is next in line to be executed. We support only - sequential execution of teardown tasks (i.e. no branching). - id: EnterpriseCrmEventbusProtoNextTeardownTask - EnterpriseCrmEventbusProtoErrorDetail: - id: EnterpriseCrmEventbusProtoErrorDetail + description: >- + Output only. Events listener endpoint. The value will populated + after provisioning the events listener. type: object + GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: + description: The response for testing an integration. properties: - errorMessage: + parameters: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' description: >- - The full text of the error message, including any parameters that - were thrown along with the exception. + Optional. Parameters are a part of Event and can be used to + communicate between different tasks that are part of the same + integration execution. + executionId: type: string - taskNumber: - format: int32 - type: integer + description: The id of the execution corresponding to this run of integration. + executionFailed: + description: Is true if any execution in the integration failed. False otherwise. + type: boolean + eventParameters: + description: Details for the integration that were executed. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + deprecated: true + parameterEntries: + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: array description: >- - The task try-number, in which, the error occurred. If zero, the - error happened at the event level. - severity: - description: 'The severity of the error: ERROR|WARN|INFO.' - enumDescriptions: - - '' - - '' - - '' - - '' - type: string - enum: - - SEVERITY_UNSPECIFIED - - ERROR - - WARN - - INFO - errorCode: - description: The associated error-code, which can be a common or internal code. - $ref: '#/components/schemas/CrmlogErrorCode' - description: An error, warning, or information message associated with a workflow. - EnterpriseCrmEventbusProtoToken: + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. type: object - id: EnterpriseCrmEventbusProtoToken - properties: - value: - type: string - name: - type: string - GoogleCloudIntegrationsV1alphaValueType: + id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: properties: - stringValue: - type: string - description: String. - doubleValue: - description: Double Number. - type: number - format: double - jsonValue: - type: string - description: Json. - booleanArray: - description: Boolean Array. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray - booleanValue: + enableVariableMasking: type: boolean - description: Boolean. - intValue: - format: int64 - type: string - description: Integer. - stringArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray - description: String Array. - intArray: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' - description: Integer Array. - doubleArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray - description: Double Number Array. - description: The type of the parameter. + description: >- + Required. REQUIRED: True if variable masking feature should be + turned on for this region + id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + description: Request to enable/disable variable masking for a provisioned client type: object - id: GoogleCloudIntegrationsV1alphaValueType - GoogleCloudIntegrationsV1alphaListConnectionsResponse: - id: GoogleCloudIntegrationsV1alphaListConnectionsResponse - description: Response containing Connections listed by region. + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: + type: object + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + description: Response for PublishIntegrationVersion. + properties: {} + GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: type: object + id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig properties: - nextPageToken: + projectId: type: string - description: Next page token. - connections: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' - description: Connections. - type: array - EnterpriseCrmEventbusProtoCloudKmsConfig: - id: EnterpriseCrmEventbusProtoCloudKmsConfig + description: Optional. Project which has the topic given. + topic: + type: string + description: Optional. Topic to push events which couldn't be processed. + description: Dead Letter configuration details provided by the user. + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: type: object properties: - gcpProjectId: - type: string - description: >- - Optional. The id of GCP project where the KMS key is stored. If not - provided, assume the key is stored in the same GCP project defined - in Client (tag 14). - keyVersionName: + scriptId: type: string - description: >- - Optional. Each version of a key contains key material used for - encryption or signing. A key's version is represented by an integer, - starting at 1. To decrypt data or verify a signature, you must use - the same key version that was used to encrypt or sign the data. - keyName: + description: The id of the linked Apps Script project. + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + description: Response for LinkAppsScriptProject rpc call. + GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: + id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + properties: + triggerId: type: string description: >- - A Cloud KMS key is a named object containing one or more key - versions, along with metadata for the key. A key exists on exactly - one key ring tied to a specific location. - serviceAccount: - type: string + Required. The trigger id of the integration trigger config. If both + trigger_id and client_id is present, the integration is executed + from the start tasks provided by the matching trigger config + otherwise it is executed from the default start tasks. + parameters: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Optional. Passed in as parameters to each integration execution. + deprecated: true + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Required. integration config to execute the workflow + testMode: + type: boolean description: >- - Optional. The service account used for authentication of this KMS - key. If this is not provided, the service account in - Client.clientSource will be used. - locationName: - description: Location name of the key ring, e.g. "us-west1". - type: string - keyRingName: + Optional. Can be specified in the event request, otherwise false + (default). If true, enables tasks with condition "test_mode = true". + If false, disables tasks with condition "test_mode = true" if global + test mode (set by platform) is also false {@link EventBusConfig}. + clientId: type: string description: >- - A key ring organizes keys in a specific Google Cloud location and - allows you to manage access control on groups of keys. A key ring's - name does not need to be unique across a Google Cloud project, but - must be unique within a given location. - GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: - id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - type: object - description: WebhookData has details of webhook configuration. - properties: - updateTime: + Required. This is used to identify the client on whose behalf the + event will be executed. + deadlineSecondsTime: type: string + description: Optional. custom deadline of the rpc format: google-datetime - readOnly: true - description: Output only. Timestamp when the webhook was last updated. - createTime: - description: Output only. Timestamp when the webhook was created. - readOnly: true - format: google-datetime + inputParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Optional. Input parameters used during integration execution. + type: object + configParameters: + description: Optional. Config parameters used during integration execution. + additionalProperties: + type: any + description: Properties of the object. + type: object + type: object + description: The request for testing an integration. + GoogleCloudConnectorsV1AuthConfig: + type: object + id: GoogleCloudConnectorsV1AuthConfig + properties: + authKey: type: string + description: Identifier key for auth config additionalVariables: + type: array + description: List containing additional auth configs. items: $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - description: Output only. Additional webhook related field values. - readOnly: true - type: array - nextRefreshTime: - format: google-datetime - readOnly: true - description: >- - Output only. Next webhook refresh time. Will be null if refresh is - not supported. - type: string - name: - type: string - readOnly: true - description: Output only. Name of the Webhook - id: - readOnly: true - description: Output only. ID to uniquely identify webhook. - type: string - EnterpriseCrmEventbusProtoStringFunction: - type: object - properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - CONCAT - - TO_UPPERCASE - - TO_LOWERCASE - - CONTAINS - - SPLIT - - LENGTH - - EQUALS - - TO_INT - - TO_DOUBLE - - TO_BOOLEAN - - TO_BASE_64 - - TO_JSON - - EQUALS_IGNORE_CASE - - REPLACE_ALL - - SUBSTRING - - RESOLVE_TEMPLATE - - DECODE_BASE64_STRING + authType: type: string - id: EnterpriseCrmEventbusProtoStringFunction - EnterpriseCrmEventbusProtoJsonFunction: - properties: - functionName: + description: The type of authentication configured. enum: - - UNSPECIFIED - - GET_PROPERTY - - GET_ELEMENT - - APPEND_ELEMENT - - SIZE - - SET_PROPERTY - - FLATTEN - - FLATTEN_ONCE - - MERGE - - TO_STRING - - TO_INT - - TO_DOUBLE - - TO_BOOLEAN - - TO_PROTO - - TO_STRING_ARRAY - - TO_INT_ARRAY - - TO_DOUBLE_ARRAY - - TO_PROTO_ARRAY - - TO_BOOLEAN_ARRAY - - REMOVE_PROPERTY - - RESOLVE_TEMPLATE - - EQUALS - - FOR_EACH - - FILTER_ELEMENTS - type: string + - AUTH_TYPE_UNSPECIFIED + - USER_PASSWORD + - OAUTH2_JWT_BEARER + - OAUTH2_CLIENT_CREDENTIALS + - SSH_PUBLIC_KEY + - OAUTH2_AUTH_CODE_FLOW + - GOOGLE_AUTHENTICATION + - OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - Authentication type not specified. + - Username and Password Authentication. + - >- + JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant + based authentication + - Oauth 2.0 Client Credentials Grant Authentication + - SSH Public Key Authentication + - Oauth 2.0 Authorization Code Flow + - Google authentication + - >- + Oauth 2.0 Authorization Code Flow with Google Provided OAuth + Client + oauth2JwtBearer: + description: Oauth2JwtBearer. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer + oauth2AuthCodeFlow: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow + description: Oauth2AuthCodeFlow. + sshPublicKey: + description: SSH Public Key. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' + oauth2AuthCodeFlowGoogleManaged: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + description: Oauth2AuthCodeFlowGoogleManaged. + userPassword: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' + description: UserPassword. + oauth2ClientCredentials: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + description: Oauth2ClientCredentials. + description: AuthConfig defines details of a authentication type. + GoogleCloudConnectorsV1DestinationConfig: type: object - id: EnterpriseCrmEventbusProtoJsonFunction - GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: - description: Conditional task failur retry strategies - id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + id: GoogleCloudConnectorsV1DestinationConfig properties: - failurePolicies: - description: >- - The list of failure policies that will be applied to the task in - order. + destinations: + description: The destinations for the key. type: array items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - defaultFailurePolicy: - description: >- - The default failure policy to be applied if no conditional failure - policy matches. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - type: object - GoogleCloudConnectorsV1Destination: - type: object - id: GoogleCloudConnectorsV1Destination - properties: - host: - type: string - description: For publicly routable host. - serviceAttachment: - description: >- - PSC service attachments. Format: - projects/*/regions/*/serviceAttachments/* + $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' + key: type: string - deprecated: true - port: description: >- - The port is the target port number that is accepted by the - destination. - format: int32 - type: integer - EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: + The key is the destination identifier that is supported by the + Connector. + description: Define the Connectors target endpoint. + GoogleCloudIntegrationsV1alphaExecutionSnapshot: + description: Contains the snapshot of the execution for a given checkpoint. + type: object properties: - eventExecutionSnapshotMetadata: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - eventExecutionInfoId: - description: Points to the event execution info this snapshot belongs to. - type: string - conditionResults: - type: array - description: All of the computed conditions that been calculated. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - eventParams: + executionSnapshotMetadata: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: The parameters in Event object. + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + description: Metadata of the execution snapshot. + params: + type: object + description: Parameters used during the execution. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' taskExecutionDetails: - type: array + description: All of the task execution details at the given point of time. items: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails - description: All of the task execution details at the given point of time. + #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails + type: array checkpointTaskNumber: + type: string description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. - type: string - snapshotTime: - type: string - description: Indicates when this snapshot is taken. - format: int64 - eventExecutionSnapshotId: - description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - type: string - taskName: - description: The task name associated with this snapshot. Could be empty. - type: string - deprecated: true - diffParams: - description: The parameters in Event object that differs from last snapshot. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + Indicates "after which checkpoint task's execution" this snapshot is + taken. + id: GoogleCloudIntegrationsV1alphaExecutionSnapshot + EnterpriseCrmEventbusProtoParameterMapEntry: + description: Entry is a pair of key and value. + properties: + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + key: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' type: object - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot - EnterpriseCrmEventbusProtoSuspensionConfig: + id: EnterpriseCrmEventbusProtoParameterMapEntry + EnterpriseCrmEventbusProtoEventParameters: properties: - whoMayResolve: + parameters: type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions - description: Identities able to resolve this suspension. - customMessage: - description: >- - Optional information to provide recipients of the suspension in - addition to the resolution URL, typically containing relevant - parameter values from the originating workflow. - type: string - suspensionExpiration: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' description: >- - Indicates the next steps when no external actions happen on the - suspension. - notifications: + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + description: >- + LINT.IfChange This message is used for processing and persisting (when + applicable) key value pair parameters for each event in the event bus. + Please see + id: EnterpriseCrmEventbusProtoEventParameters + type: object + GoogleCloudIntegrationsV1alphaUnshareTemplateRequest: + id: GoogleCloudIntegrationsV1alphaUnshareTemplateRequest + description: Request to Unshare template + properties: + resourceNames: type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' + type: string + description: >- + Optional. Project name resources to unshare the template. The + project names is expected in resource format Ex: + projects/{project-number} type: object - id: EnterpriseCrmEventbusProtoSuspensionConfig - GoogleCloudIntegrationsV1alphaTaskConfig: + GoogleCloudIntegrationsV1alphaSfdcInstance: + description: >- + The SfdcInstance resource use to hold channels and connection config + data. + type: object + id: GoogleCloudIntegrationsV1alphaSfdcInstance properties: - synchronousCallFailurePolicy: - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - successPolicy: - description: >- - Optional. Determines what action to take upon successful task - completion. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' - conditionalFailurePolicies: - description: >- - Optional. The list of conditional failure policies that will be - applied to the task in order. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies - displayName: + sfdcOrgId: + description: The SFDC Org Id. This is defined in salesforce. type: string - description: >- - Optional. User-provided label that is attached to this TaskConfig in - the UI. - jsonValidationOption: - enum: - - JSON_VALIDATION_OPTION_UNSPECIFIED - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION - description: >- - Optional. If set, overrides the option configured in the Task - implementation class. - enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in IntegrationParameter. - - >- - Validate all potential output JSON parameters against schemas - specified in IntegrationParameter. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. + deleteTime: type: string - nextTasksExecutionPolicy: description: >- - Optional. The policy dictating the execution of the next set of - tasks for the current task. - enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - type: string - taskExecutionStrategy: - enum: - - TASK_EXECUTION_STRATEGY_UNSPECIFIED - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - description: Optional. The policy dictating the execution strategy of this task. + Output only. Time when the instance was deleted. Empty if not + deleted. + format: google-datetime + readOnly: true + updateTime: + description: Output only. Time when the instance was last updated + readOnly: true + format: google-datetime type: string - enumDescriptions: - - >- - Default. If the strategy is not set explicitly, it will default to - `WHEN_ALL_SUCCEED`. - - >- - Wait until all of its previous tasks finished execution, then - verify at least one of the edge conditions is met, and execute if - possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - - >- - Start execution as long as any of its previous tasks finished - execution and the corresponding edge condition is met (since we - will execute if only that succeeding edge condition is met). - - >- - Wait until all of its previous tasks finished execution, then - verify the all edge conditions are met and execute if possible. - failurePolicy: - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - parameters: - description: Optional. The customized parameters the user can pass to this task. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' - type: object - position: - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - task: + name: type: string - description: Optional. The name for the task. - nextTasks: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - description: >- - Optional. The set of tasks that are next in line to be executed as - per the execution graph defined for the parent event, specified by - `event_config_id`. Each of these next tasks are executed only if the - condition associated with them evaluates to true. - type: array - taskId: description: >- - Required. The identifier of this task within its parent event - config, specified by the client. This should be unique among all the - tasks belong to the same event config. We use this field as the - identifier to find next tasks (via field `next_tasks.task_id`). + Resource name of the SFDC instance + projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. + createTime: + readOnly: true + description: Output only. Time when the instance is created + format: google-datetime type: string - externalTaskType: - enumDescriptions: - - Default value. External task type is not specified - - Tasks belongs to the normal task flows - - Task belongs to the error catch task flows - enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK + serviceAuthority: type: string - description: Optional. External task type of the task - taskTemplate: description: >- - Optional. Used to define task-template name if task is of type - task-template + URL used for API calls after authentication (the login authority is + configured within the referenced AuthConfig). + displayName: + description: User selected unique name/alias to easily reference an instance. type: string + authConfigId: + description: A list of AuthConfigs that can be tried to open the channel to SFDC + type: array + items: + type: string description: type: string - description: >- - Optional. User-provided description intended to give additional - business context about the task. - errorCatcherId: - description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task + description: A description of the sfdc instance. + EnterpriseCrmFrontendsEventbusProtoParameterMapField: + id: EnterpriseCrmFrontendsEventbusProtoParameterMapField + description: Field represents either the key or value in an entry. + properties: + referenceKey: type: string - id: GoogleCloudIntegrationsV1alphaTaskConfig + description: Referencing one of the WF variables. + literalValue: + description: Passing a literal value. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType type: object - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. - GoogleProtobufEmpty: - properties: {} - 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); } - type: object - id: GoogleProtobufEmpty - GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails: - description: Sub Integration which would be created via templates. - id: GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - properties: - integration: - type: string - description: >- - Required. Name of the sub integration which would be created via - templates. - integrationDescription: - type: string - description: >- - Optional. Description of the sub integration which would be created - via templates. - type: object - GoogleCloudIntegrationsV1alphaUseTemplateResponse: - id: GoogleCloudIntegrationsV1alphaUseTemplateResponse + EnterpriseCrmEventbusProtoTransformExpression: + id: EnterpriseCrmEventbusProtoTransformExpression type: object - description: Response for use template properties: - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: IntegrationVersion which is created. - subIntegrationVersions: + initialValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' + description: Initial value upon which to perform transformations. + transformationFunctions: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - type: array - description: Sub integration versions which are created. - GoogleCloudIntegrationsV1alphaImportTemplateResponse: - id: GoogleCloudIntegrationsV1alphaImportTemplateResponse - description: Response for import template - properties: - subIntegrationVersions: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' type: array - description: Sub integration versions which are imported. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: IntegrationVersion after the import. - type: object - EnterpriseCrmEventbusProtoEventExecutionSnapshot: + description: Transformations to be applied sequentially. + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: type: object + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange properties: - taskExecutionDetails: - description: All of the task execution details at the given point of time. - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails - type: array - taskName: - deprecated: true - description: The task name associated with this snapshot. Could be empty. + max: + format: int64 + description: The inclusive maximum of the acceptable range. type: string - workflowName: + min: + description: The inclusive minimum of the acceptable range. + format: int64 type: string - description: Name of the workflow this event execution snapshot belongs to. - eventExecutionInfoId: + description: Range used to validate longs and ints. + GoogleCloudIntegrationsV1alphaClientCertificate: + type: object + properties: + encryptedPrivateKey: type: string - description: Points to the event execution info this snapshot belongs to. - checkpointTaskNumber: description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. + The ssl certificate encoded in PEM format. This string must include + the begin header and end footer lines. For example, -----BEGIN + CERTIFICATE----- + MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV + BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw + MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET + MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA + vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 + JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB + xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P + AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB + Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey + Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW + JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr + 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H + wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- + sslCertificate: type: string - clientId: - description: Client that the execution snapshot is associated to. + description: >- + The ssl certificate encoded in PEM format. This string must include + the begin header and end footer lines. For example, -----BEGIN + CERTIFICATE----- + MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV + BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw + MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET + MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA + vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 + JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB + xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P + AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB + Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey + Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW + JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr + 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H + wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- + passphrase: + description: >- + 'passphrase' should be left unset if private key is not encrypted. + Note that 'passphrase' is not the password for web server, but an + extra layer of security to protected private key. type: string - eventExecutionSnapshotId: + id: GoogleCloudIntegrationsV1alphaClientCertificate + description: Contains client certificate information + GoogleCloudIntegrationsV1alphaSuspension: + description: A record representing a suspension. + type: object + id: GoogleCloudIntegrationsV1alphaSuspension + properties: + name: + description: Resource name for suspensions suspension/{suspension_id} type: string + approvalConfig: description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - eventExecutionSnapshotMetadata: + Controls the notifications and approval permissions for this + suspension. $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - snapshotTime: - description: Indicates when this snapshot is taken. - format: int64 + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + state: + enumDescriptions: + - Unset state. + - The suspension has not yet been resolved. + - The resolver has rejected the suspension. + - The resolver has lifted the suspension. + enum: + - RESOLUTION_STATE_UNSPECIFIED + - PENDING + - REJECTED + - LIFTED + description: >- + Required. State of this suspension, indicating what action a + resolver has taken. type: string - diffParams: - description: The parameters in Event object that differs from last snapshot. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - exceedMaxSize: - type: boolean - description: indicate whether snapshot exceeded maximum size before clean up - eventParams: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters in Event object. - conditionResults: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - type: array - description: All of the computed conditions that been calculated. - description: >- - Contains the snapshot of the event execution for a given checkpoint. - Next available id: 15 - id: EnterpriseCrmEventbusProtoEventExecutionSnapshot - EnterpriseCrmEventbusProtoBooleanArrayFunction: - id: EnterpriseCrmEventbusProtoBooleanArrayFunction - type: object + taskId: + type: string + description: Required. Task id of the associated SuspensionTask. + lastModifyTime: + format: google-datetime + description: Output only. Auto-generated. + readOnly: true + type: string + eventExecutionInfoId: + type: string + description: Required. ID of the associated execution. + suspensionConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' + deprecated: true + description: >- + Controls the notifications and resolver permissions for this + suspension. + integration: + description: Required. The name of the originating integration. + type: string + audit: + description: Metadata pertaining to the resolution of this suspension. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' + createTime: + format: google-datetime + type: string + description: Output only. Auto-generated. + readOnly: true + EnterpriseCrmEventbusProtoProtoArrayFunction: properties: functionName: + type: string enumDescriptions: - '' - '' @@ -2435,112 +2505,201 @@ components: - CONTAINS - FOR_EACH - FILTER - type: string - GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: + id: EnterpriseCrmEventbusProtoProtoArrayFunction + type: object + EnterpriseCrmEventbusProtoDoubleFunction: properties: - task: - description: the task name associated with this snapshot. - type: string - taskLabel: - description: the task label associated with this snapshot. Could be empty. - type: string - taskNumber: + functionName: + enum: + - UNSPECIFIED + - TO_JSON + - TO_STRING + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - ROUND + - FLOOR + - CEIL + - GREATER_THAN + - LESS_THAN + - EQUALS + - GREATER_THAN_EQUALS + - LESS_THAN_EQUALS + - MOD type: string - description: The task number associated with this snapshot. - ancestorIterationNumbers: - type: array - description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - items: - type: string - ancestorTaskNumbers: - description: >- - Ancestor task number for the task(it will only be non-empty if the - task is under 'private workflow') - type: array - items: - type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: object + id: EnterpriseCrmEventbusProtoDoubleFunction + GoogleCloudIntegrationsV1alphaJwt: + properties: + jwt: + type: string + description: The token calculated by the header, payload and signature. + jwtPayload: + type: string + description: >- + Contains a set of claims. The JWT specification defines seven + Registered Claim Names which are the standard fields commonly + included in tokens. Custom claims are usually also included, + depending on the purpose of the token. + jwtHeader: + description: Identifies which algorithm is used to generate the signature. + type: string + secret: + description: User's pre-shared secret to sign the token. + type: string + description: >- + Represents JSON web token(JWT), which is a compact, URL-safe means of + representing claims to be transferred between two parties, enabling the + claims to be digitally signed or integrity protected. + type: object + id: GoogleCloudIntegrationsV1alphaJwt + GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: + description: Metadata of the execution snapshot. + properties: executionAttempt: type: integer description: the execution attempt number this snapshot belongs to. format: int32 - integrationName: - description: >- - The direct integration which the event execution snapshots belongs - to + taskLabel: type: string + description: the task label associated with this snapshot. Could be empty. + ancestorIterationNumbers: + items: + type: string + description: >- + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') + type: array taskAttempt: type: integer - description: the task attempt number this snapshot belongs to. format: int32 - description: Metadata of the execution snapshot. - id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - type: object - GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: - description: Response for listing RuntimeEntitySchemas for a specific Connection. - id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse - type: object - properties: - nextPageToken: - description: Next page token. + description: the task attempt number this snapshot belongs to. + task: type: string - runtimeEntitySchemas: + description: the task name associated with this snapshot. + taskNumber: + type: string + description: The task number associated with this snapshot. + ancestorTaskNumbers: type: array - description: Runtime entity schemas. items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - GoogleCloudIntegrationsV1alphaCloudKmsConfig: - properties: - kmsRing: + type: string description: >- - Required. A key ring organizes keys in a specific Google Cloud - location and allows you to manage access control on groups of keys. - A key ring's name does not need to be unique across a Google Cloud - project, but must be unique within a given location. + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') + integrationName: type: string - keyVersion: description: >- - Optional. Each version of a key contains key material used for - encryption or signing. A key's version is represented by an integer, - starting at 1. To decrypt data or verify a signature, you must use - the same key version that was used to encrypt or sign the data. - type: string - kmsProjectId: - type: string + The direct integration which the event execution snapshots belongs + to + id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + type: object + EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: + type: object + id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + properties: + startTime: description: >- - Optional. The gcp project id of the project where the kms key - stored. If empty, the kms key is stored at the same project as - customer's project and ecrypted with CMEK, otherwise, the kms key is - stored in the tenant project and encrypted with GMEK - kmsLocation: - description: Required. Location name of the key ring, e.g. "us-west1". + The start time of the event execution for current attempt. This + could be in the future if it's been scheduled. + format: int64 type: string - key: + endTime: + description: The end time of the event execution for current attempt. type: string - description: >- - Required. A Cloud KMS key is a named object containing one or more - key versions, along with metadata for the key. A key exists on - exactly one key ring tied to a specific location. - description: Configuration information for Client's Cloud KMS information - id: GoogleCloudIntegrationsV1alphaCloudKmsConfig - type: object - EnterpriseCrmEventbusProtoBaseFunction: + format: int64 + EnterpriseCrmEventbusProtoParameterMap: + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. type: object - id: EnterpriseCrmEventbusProtoBaseFunction properties: - functionName: + valueType: enum: - - UNSPECIFIED - - NOW_IN_MILLIS - - INT_LIST - - ENVIRONMENT - - GET_EXECUTION_ID - - GET_INTEGRATION_NAME - - GET_REGION - - GET_UUID - - GET_PROJECT_ID + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + keyType: + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + description: >- + Option to specify key value type for all entries of the map. If + provided then field types for all entries must conform to this. enumDescriptions: - '' - '' @@ -2551,191 +2710,428 @@ components: - '' - '' - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' type: string - EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: - type: object - properties: - protoValues: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - EnterpriseCrmEventbusProtoEventBusProperties: - description: >- - LINT.IfChange This message is used for storing key value pair properties - for each Event / Task in the EventBus. - id: EnterpriseCrmEventbusProtoEventBusProperties - properties: - properties: + entries: type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' - description: An unordered list of property entries. - type: object - GoogleCloudIntegrationsV1alphaIntegration: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' + id: EnterpriseCrmEventbusProtoParameterMap + GoogleCloudIntegrationsV1alphaSerializedFile: type: object - description: The integration definition. + description: To store string representation of Integration file. + id: GoogleCloudIntegrationsV1alphaSerializedFile properties: - active: - type: boolean - description: Required. If any integration version is published. - description: - type: string - description: Optional. - createTime: - description: Required. Output only. Auto-generated. - type: string - format: google-datetime - readOnly: true - name: - description: Required. The resource name of the integration. - type: string - creatorEmail: - readOnly: true + file: + enum: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES description: >- - Output only. The creator's email address. Generated based on the End - User Credentials/LOAS role of the user making the call. - type: string - updateTime: + File information like Integration version, Integration Config + variables etc. type: string - readOnly: true - description: Output only. Auto-generated. - format: google-datetime - lastModifierEmail: + enumDescriptions: + - Default value. + - Integration file. + - Integration Config variables. + content: + description: String representation of the file content. type: string - description: Required. The last modifier of this integration - id: GoogleCloudIntegrationsV1alphaIntegration - GoogleCloudIntegrationsV1alphaListSuspensionsResponse: - id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse - description: Response for Suspensions.ListSuspensions. + GoogleCloudIntegrationsV1alphaListExecutionsResponse: type: object + id: GoogleCloudIntegrationsV1alphaListExecutionsResponse + description: Response for listing the integration execution data. properties: nextPageToken: type: string - description: Token to retrieve the next page of results. - suspensions: + description: The token used to retrieve the next page results. + executions: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + description: The detailed information of requested executions type: array + executionInfos: + description: Required. The detailed information of requested executions. items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' - description: >- - The suspensions for the relevant execution which the caller has - permissions to view and resolve. - GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate: - properties: - key: - type: string - description: Required. Unique Key of the IntegrationVersion. - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Required. Templatized version of integration. - id: GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate - description: Define the template of IntegrationVersion. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + type: array + deprecated: true + GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: + description: Response for Suspensions.ResolveSuspensions. type: object - EnterpriseCrmEventbusProtoCoordinate: - description: Represents two-dimensional positions. - id: EnterpriseCrmEventbusProtoCoordinate + properties: {} + id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + GoogleCloudIntegrationsV1alphaParameterMap: + id: GoogleCloudIntegrationsV1alphaParameterMap + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. type: object properties: - x: - type: integer - format: int32 - 'y': - format: int32 - type: integer - EnterpriseCrmEventbusProtoBaseValue: + entries: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry + description: A list of parameter map entries. + valueType: + enum: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + type: string + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + description: >- + Option to specify value type for all entries of the map. If provided + then field types for all entries must conform to this. + keyType: + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + enum: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + type: string + description: >- + Option to specify key type for all entries of the map. If provided + then field types for all entries must conform to this. + EnterpriseCrmEventbusProtoCloudLoggingDetails: properties: - baseFunction: + enableCloudLogging: description: >- - Start with a function that does not build on existing values. Eg. - CurrentTime, Min, Max, Exists, etc. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' - referenceValue: + Status of whether Cloud Logging is enabled or not for the + integration version getting executed. + type: boolean + cloudLoggingSeverity: + enumDescriptions: + - Unspecified + - >- + If Severity selected is `INFO`, then all the Integration Execution + States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, + `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + - >- + If Severity selected is `ERROR`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + - >- + If Severity selected is `WARNING`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. type: string - description: Start with a reference value to dereference. - literalValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: Start with a literal value. + enum: + - CLOUD_LOGGING_SEVERITY_UNSPECIFIED + - INFO + - ERROR + - WARNING + description: >- + Severity selected by the customer for the logs to be sent to Cloud + Logging, for the integration version getting executed. + description: >- + Cloud Logging details, selected by the user for the integration version + (workflow). This message field will be also used in ExecutionInfo, to + indicate the CloudLoggingDetails config at the time of workflow + (integration version) execution, since this field value can be changed + for an unpublished workflow. + id: EnterpriseCrmEventbusProtoCloudLoggingDetails type: object - id: EnterpriseCrmEventbusProtoBaseValue - GoogleCloudIntegrationsV1alphaClientConfig: - description: The configuration information for the Client - id: GoogleCloudIntegrationsV1alphaClientConfig + GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: + id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse type: object + description: Response for DownloadJsonPackage. properties: - clientState: + files: + type: array + description: List containing JSON for multiple file with type information. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' + GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: + id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + description: WebhookData has details of webhook configuration. + properties: + createTime: + readOnly: true + format: google-datetime + description: Output only. Timestamp when the webhook was created. type: string - description: Indicates the activity state the client - enumDescriptions: - - The client state is unspecified - - The client is active and able to make calls to the IP APIs - - The client is disabled and will soon be deleted - enum: - - CLIENT_STATE_UNSPECIFIED - - CLIENT_STATE_ACTIVE - - CLIENT_STATE_DISABLED - cloudKmsConfig: - description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + additionalVariables: + readOnly: true + description: Output only. Additional webhook related field values. + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + type: array + name: + type: string + description: Output only. Name of the Webhook + readOnly: true id: + description: Output only. ID to uniquely identify webhook. type: string - description: Globally unique ID (project_id + region) - p4ServiceAccount: - type: string - description: The service agent associated with this client - runAsServiceAccount: + readOnly: true + updateTime: + description: Output only. Timestamp when the webhook was last updated. + readOnly: true type: string + format: google-datetime + nextRefreshTime: + readOnly: true description: >- - Default run-as service account email, set up during project - provision time, that will be used to generate auth token to be used - in Connector task, Rest caller task, Cloud function task and - Subworkflows. - projectId: + Output only. Next webhook refresh time. Will be null if refresh is + not supported. type: string - description: The GCP project id of the client associated with - isGmek: - type: boolean - description: Optional. Indicates the client is provisioned with CMEK or GMEK. - createTime: format: google-datetime + type: object + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + description: JWT claims used for the jwt-bearer authorization grant. + properties: + issuer: + description: Value for the "iss" claim. type: string - description: The timestamp when the client was first created. - region: - description: The region the client is linked to. + subject: + description: Value for the "sub" claim. type: string - enableVariableMasking: + audience: + description: Value for the "aud" claim. + type: string + type: object + GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: + description: Request for [Suspensions.ResolveSuspensions]. + id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + properties: + suspension: description: >- - Optional. True if variable masking feature should be turned on for - this region - type: boolean - enableInternalIp: + Suspension, containing the event_execution_info_id, task_id, and + state to set on the corresponding suspension record. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' + type: object + EnterpriseCrmEventbusProtoDoubleParameterArray: + id: EnterpriseCrmEventbusProtoDoubleParameterArray + properties: + doubleValues: + items: + format: double + type: number + type: array + type: object + EnterpriseCrmEventbusProtoWorkflowAlertConfig: + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. + properties: + durationThresholdMs: + format: int64 + type: string + description: >- + Should be specified only for *AVERAGE_DURATION and + *PERCENTILE_DURATION metrics. This member should be used to specify + what duration value the metrics should exceed for the alert to + trigger. + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + clientId: + description: Client associated with this alert configuration. + type: string + alertName: + type: string + description: >- + A name to identify this alert. This will be displayed in the alert + subject. If set, this name should be unique within the scope of the + workflow. + numAggregationPeriods: + description: >- + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + type: integer + format: int32 + aggregationPeriod: + type: string + description: >- + For an EXPECTED_MIN threshold, this aggregation_period must be + lesser than 24 hours. + onlyFinalAttempt: + description: >- + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. type: boolean + thresholdValue: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue description: >- - Optional. Indicates the client enables internal IP feature, this is - applicable for internal clients only. - billingType: + The metric value, above or below which the alert should be + triggered. + metricType: type: string + enum: + - METRIC_TYPE_UNSPECIFIED + - EVENT_ERROR_RATE + - EVENT_WARNING_RATE + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - EVENT_RATE + - EVENT_AVERAGE_DURATION + - EVENT_PERCENTILE_DURATION + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION enumDescriptions: - - Unspecified billing type - - A trial org provisioned through Apigee Provisioning Wizard - - Subscription based users of Apigee - - Consumption based users of IP - description: Indicates the billing type of the client + - >- + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. + - >- + Specifies alerting on the rate of errors for the enclosing + workflow. + - >- + Specifies alerting on the rate of warnings for the enclosing + workflow. Warnings use the same enum values as errors. + - >- + Specifies alerting on the rate of errors for any task in the + enclosing workflow. + - >- + Specifies alerting on the rate of warnings for any task in the + enclosing workflow. + - >- + Specifies alerting on the rate of executions over all tasks in the + enclosing workflow. + - >- + Specifies alerting on the number of events executed in the given + aggregation_period. + - >- + Specifies alerting on the average duration of executions for this + workflow. + - >- + Specifies alerting on the duration value of a particular + percentile of workflow executions. E.g. If 10% or more of the + workflow executions have durations above 5 seconds, alert. + - >- + Specifies alerting on the average duration of any task in the + enclosing workflow, + - >- + Specifies alerting on the duration value of a particular + percentile of any task executions within the enclosing workflow. + E.g. If 10% or more of the task executions in the workflow have + durations above 5 seconds, alert. + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + alertDisabled: + type: boolean + description: >- + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + thresholdType: + description: >- + The threshold type, whether lower(expected_min) or + upper(expected_max), for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. enum: - - BILLING_TYPE_UNSPECIFIED - - BILLING_TYPE_APIGEE_TRIALS - - BILLING_TYPE_APIGEE_SUBSCRIPTION - - BILLING_TYPE_PAYG - description: - description: Description of what the client is used for + - UNSPECIFIED_THRESHOLD_TYPE + - EXPECTED_MIN + - EXPECTED_MAX + enumDescriptions: + - '' + - >- + Note that this field will only trigger alerts if the workflow + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. + - '' type: string - EnterpriseCrmEventbusProtoProtoFunction: + playbookUrl: + type: string + description: >- + Link to a playbook for resolving the issue that triggered this + alert. + type: object + id: EnterpriseCrmEventbusProtoWorkflowAlertConfig + EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: + id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition + type: object + properties: + fullName: + type: string + description: >- + The fully-qualified proto name. This message, for example, would be + "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". + path: + type: string + description: Path to the proto file that contains the message type's definition. + EnterpriseCrmEventbusProtoBaseFunction: type: object + id: EnterpriseCrmEventbusProtoBaseFunction properties: functionName: + enum: + - UNSPECIFIED + - NOW_IN_MILLIS + - INT_LIST + - ENVIRONMENT + - GET_EXECUTION_ID + - GET_INTEGRATION_NAME + - GET_REGION + - GET_UUID + - GET_PROJECT_ID enumDescriptions: - '' - '' @@ -2746,846 +3142,546 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - GET_STRING_SUBFIELD - - GET_INT_SUBFIELD - - GET_DOUBLE_SUBFIELD - - GET_BOOLEAN_SUBFIELD - - GET_STRING_ARRAY_SUBFIELD - - GET_INT_ARRAY_SUBFIELD - - GET_DOUBLE_ARRAY_SUBFIELD - - GET_BOOLEAN_ARRAY_SUBFIELD - - GET_PROTO_ARRAY_SUBFIELD - - GET_PROTO_SUBFIELD - - TO_JSON - - GET_BYTES_SUBFIELD_AS_UTF_8_STRING - - GET_BYTES_SUBFIELD_AS_PROTO - - EQUALS type: string - id: EnterpriseCrmEventbusProtoProtoFunction - GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: - id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest - description: Request for the Deprovision rpc - properties: {} - type: object - GoogleCloudIntegrationsV1alphaTemplateComponent: - description: Define the components that are present in a template. - type: object + GoogleCloudIntegrationsV1alphaShareTemplateRequest: + id: GoogleCloudIntegrationsV1alphaShareTemplateRequest + description: Request to Share template properties: - type: - type: string - enumDescriptions: - - Component type is unspecified - - Trigger component - - Task component - - Connector component - enum: - - TYPE_UNSPECIFIED - - TRIGGER - - TASK - - CONNECTOR - description: Optional. Type of the component. - name: - description: Optional. Name of the component. - type: string - id: GoogleCloudIntegrationsV1alphaTemplateComponent - GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: - description: Request for Creating Cloud Function rpc call. - properties: - projectId: - type: string + resourceNames: + items: + type: string + type: array description: >- - Indicates the id of the GCP project that the function will be - created in. - functionRegion: - description: The function region of CF to be created - type: string - functionName: - description: The function name of CF to be created - type: string - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + Optional. Project name resources to share the template. The project + names is expected in resource format Ex: projects/{project-number} + or organization/{org-id} type: object - GoogleCloudIntegrationsV1alphaIntegrationVersion: + GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate: + description: Define the template of IntegrationVersion. type: object properties: - integrationParametersInternal: - deprecated: true - description: >- - Optional. Parameters that are expected to be passed to the - integration when an event is triggered. This consists of all the - parameters that are expected in the integration execution. This - gives the user the ability to provide default values, add - information like PII and also provide data types of each parameter. + integrationVersion: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - runAsServiceAccount: + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Required. Templatized version of integration. + key: + description: Required. Unique Key of the IntegrationVersion. type: string - description: >- - Optional. The run-as service account email, if set and auth config - is not configured, that will be used to generate auth token to be - used in Connector task, Rest caller task and Cloud function task. - userLabel: + id: GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + GoogleCloudIntegrationsV1alphaCertificate: + properties: + name: + description: Output only. Auto generated primary key type: string - description: >- - Optional. A user-defined label that annotates an integration - version. Typically, this is only set when the integration version is - created. - cloudLoggingDetails: - description: Optional. Cloud Logging details for the integration version - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - integrationParameters: - description: >- - Optional. Parameters that are expected to be passed to the - integration when an event is triggered. This consists of all the - parameters that are expected in the integration execution. This - gives the user the ability to provide default values, add - information like PII and also provide data types of each parameter. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - integrationConfigParameters: - type: array - description: >- - Optional. Config Parameters that are expected to be passed to the - integration when an integration is published. This consists of all - the parameters that are expected to provide configuration in the - integration execution. This gives the user the ability to provide - default values, value, add information like connection url, project - based configuration value and also provide data types of each - parameter. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationConfigParameter - teardown: - description: >- - Optional. Contains a graph of tasks that will be executed before - putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), - regardless of success or failure, similar to "finally" in code. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' - deprecated: true - state: readOnly: true - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. - description: Output only. User should not set it as an input. - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - type: string - taskConfigsInternal: - type: array - description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - deprecated: true - items: - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' - triggerConfigsInternal: - deprecated: true - description: Optional. Trigger configurations. - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig - triggerConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' - description: Optional. Trigger configurations. - lockHolder: - type: string - description: >- - Optional. The edit lock holder's email address. Generated based on - the End User Credentials/LOAS role of the user making the call. - createdFromTemplate: - type: string - description: >- - Optional. Optional. The resource name of the template from which the - integration is created. - status: - enum: - - UNKNOWN - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT + displayName: type: string + description: Required. Name of the certificate + validStartTime: + description: Output only. The timestamp after which certificate will be valid readOnly: true - description: >- - Output only. Generated by eventbus. User should not set it as an - input. - deprecated: true - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - errorCatcherConfigs: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig - type: array - description: >- - Optional. Error Catch Task configuration for the integration. It's - optional. - lastModifierEmail: - description: >- - Optional. The last modifier's email address. Generated based on the - End User Credentials/LOAS role of the user making the call. type: string - enableVariableMasking: - type: boolean - description: >- - Optional. True if variable masking feature should be turned on for - this version - updateTime: format: google-datetime - description: Output only. Auto-generated. + validEndTime: + description: Output only. The timestamp after which certificate will expire type: string readOnly: true - taskConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' - description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - origin: - enumDeprecated: - - false - - false - - true - - false - - false - - false - deprecated: true - enumDescriptions: - - '' - - Workflow is being created via event bus UI. - - >- - User checked in this workflow in Piper as v2 textproto format and - we synced it into spanner. - - >- - User checked in this workflow in piper as v3 textproto format and - we synced it into spanner. - - Workflow is being created via Standalone IP Provisioning - - Workflow is being created via Test Case. + format: google-datetime + requestorId: type: string description: >- - Optional. The origin that indicates where this integration is coming - from. - enum: - - UNSPECIFIED - - UI - - PIPER_V2 - - PIPER_V3 - - APPLICATION_IP_PROVISIONING - - TEST_CASE - createTime: - type: string - format: google-datetime - description: Output only. Auto-generated. - readOnly: true + Immutable. Requestor ID to be used to register certificate with + trawler + rawCertificate: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' + description: >- + Input only. Raw client certificate which would be registered with + trawler description: type: string - description: Optional. The integration description. - name: + description: Description of the certificate + credentialId: type: string - description: Output only. Auto-generated primary key. - readOnly: true - databasePersistencePolicy: - enum: - - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED - - DATABASE_PERSISTENCE_DISABLED - - DATABASE_PERSISTENCE_ASYNC + description: Immutable. Credential id that will be used to register with trawler + certificateStatus: type: string - description: >- - Optional. Flag to disable database persistence for execution data, - including event execution info, execution export info, execution - metadata index and execution param index. enumDescriptions: - - Enables persistence for all execution data. - - Disables persistence for all execution data. - - Asynchronously persist all execution data. - parentTemplateId: - type: string - description: >- - Optional. The id of the template which was used to create this - integration_version. - snapshotNumber: - description: >- - Optional. An increasing sequence that is set when a new snapshot is - created. The last created snapshot can be identified by - [workflow_name, org_id latest(snapshot_number)]. However, last - created snapshot need not be same as the HEAD. So users should - always use "HEAD" tag to identify the head. - format: int64 - type: string - description: The integration version definition. - id: GoogleCloudIntegrationsV1alphaIntegrationVersion - EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: - id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam + - Unspecified certificate status + - Certificate in active state will be able to use + - Certificate in expired state needs to be updated + description: Status of the certificate + enum: + - STATE_UNSPECIFIED + - ACTIVE + - EXPIRED type: object - properties: - allowedCredentialTypes: - description: >- - Defines the credential types to be supported as Task may restrict - specific types to use, e.g. Cloud SQL Task will use - username/password type only. - items: - enumDescriptions: - - '' - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - type: string - type: array - authConfigId: - description: UUID of the AuthConfig. - type: string - scope: - description: A space-delimited list of requested scope permissions. - type: string - useServiceAccountInContext: - type: boolean - allowedServiceAccountInContext: - type: boolean - EnterpriseCrmEventbusProtoStringArray: + id: GoogleCloudIntegrationsV1alphaCertificate + description: The certificate definition + GoogleCloudIntegrationsV1alphaUploadTemplateResponse: type: object - id: EnterpriseCrmEventbusProtoStringArray - properties: - values: - items: - type: string - type: array - EnterpriseCrmEventbusProtoConditionResult: + id: GoogleCloudIntegrationsV1alphaUploadTemplateResponse properties: - currentTaskNumber: - description: the current task number. - type: string - result: - description: >- - the result comes out after evaluate the combined condition. True if - there's no combined condition specified. - type: boolean - nextTaskNumber: - type: string - description: the next task number. - description: Contains the combined condition calculation results. - id: EnterpriseCrmEventbusProtoConditionResult - type: object - GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: + template: + description: The uploaded Template + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + description: Response for UploadTemplate. + GoogleCloudIntegrationsV1alphaListCertificatesResponse: + description: Response to list Certificates. properties: nextPageToken: type: string - description: Next page token. - runtimeActionSchemas: + description: The token used to retrieve the next page of results. + certificates: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema - description: Runtime action schemas. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' type: array - description: Response for listing RuntimeActionSchemas for a specific Connection. - type: object - id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: - properties: - min: - format: double - description: The inclusive minimum of the acceptable range. - type: number - max: - description: The inclusive maximum of the acceptable range. - type: number - format: double + description: The list of Certificates retrieved. + id: GoogleCloudIntegrationsV1alphaListCertificatesResponse type: object - description: Range used to validate doubles and floats. - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange - GoogleCloudConnectorsV1EncryptionKey: - description: Encryption Key value. - id: GoogleCloudConnectorsV1EncryptionKey + GoogleCloudIntegrationsV1alphaCredential: + id: GoogleCloudIntegrationsV1alphaCredential + description: Defines parameters for a single, canonical credential. properties: - kmsKeyName: - type: string + oidcToken: + description: Google OIDC ID Token + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' + jwt: + description: JWT credential + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' + authToken: + description: Auth token credential + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' + oauth2ResourceOwnerCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + description: OAuth2 resource owner credentials + oauth2ClientCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials + oauth2AuthorizationCode: description: >- - The [KMS key name] with which the content of the Operation is - encrypted. The expected format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty - string if google managed. - type: - enumDescriptions: - - Value type is not specified. - - Google Managed. - - Customer Managed. + The api_key and oauth2_implicit are not covered in v1 and will be + picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 + authorization code credential + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode + serviceAccountCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials + description: Service account credential + usernameAndPassword: + description: Username and password credential + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword + credentialType: type: string - description: Type. enum: - - TYPE_UNSPECIFIED - - GOOGLE_MANAGED - - CUSTOMER_MANAGED + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + enumDescriptions: + - Unspecified credential type + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + description: Credential type associated with auth config. type: object - EnterpriseCrmEventbusProtoDoubleArray: - properties: - values: - items: - format: double - type: number - type: array + GoogleCloudIntegrationsV1alphaRuntimeActionSchema: type: object - id: EnterpriseCrmEventbusProtoDoubleArray - GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: properties: - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - description: >- - Required. REQUIRED: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. - description: Request for the SwitchEncryption rpc + action: + type: string + description: Name of the action. + inputSchema: + description: Input parameter schema for the action. + type: string + outputSchema: + description: Output parameter schema for the action. + type: string + id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema + description: Metadata of an action, including schemas for its inputs and outputs. + GoogleCloudConnectorsV1BillingConfig: type: object - id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest - EnterpriseCrmEventbusProtoNextTask: properties: - combinedConditions: - description: >- - Combined condition for this task to become an eligible next task. - Each of these combined_conditions are joined with logical OR. - DEPRECATED: use `condition` - type: array - deprecated: true - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' - condition: + billingCategory: + enum: + - BILLING_CATEGORY_UNSPECIFIED + - GCP_AND_TECHNICAL_CONNECTOR + - NON_GCP_CONNECTOR type: string - description: >- - Standard filter expression for this task to become an eligible next - task. - label: - description: User-provided label that is attached to this edge in the UI. + enumDescriptions: + - Billing category is not specified. + - GCP/Technical connector. + - Non-GCP connector. + readOnly: true + description: Output only. Billing category for the connector. + description: Billing config for the connection. + id: GoogleCloudConnectorsV1BillingConfig + GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: + id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode + description: >- + The OAuth Type where the client sends request with the client id and + requested scopes to auth endpoint. User sees a consent screen and auth + code is received at specified redirect url afterwards. The auth code is + then combined with the client id and secret and sent to the token + endpoint in exchange for the access and refresh token. The refresh token + can be used to fetch new access tokens. + type: object + properties: + tokenParams: + description: The token parameters sent along with the token request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + requestType: + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + description: Represent how to pass parameters to fetch access token type: string - description: + enumDescriptions: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + applyReauthPolicy: description: >- - User-provided description intended to give more business context - about the next task edge or condition. + Indicates if the user has opted in Google Reauth Policy. If opted + in, the refresh token will be valid for 20 hours, after which time + users must re-authenticate in order to obtain a new one. + type: boolean + authParams: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + description: The auth parameters sent along with the auth code request. + clientId: type: string - taskConfigId: - description: ID of the next task. + description: The client's id. + authEndpoint: type: string - taskNumber: + description: The auth url endpoint to send the auth code request to. + accessToken: + description: The access token received from the token endpoint. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + scope: + description: A space-delimited list of requested scope permissions. type: string - description: Task number of the next task. + tokenEndpoint: + type: string + description: The token url endpoint to send the token request to. + authCode: + description: The Auth Code that is used to initially retrieve the access token. + type: string + clientSecret: + type: string + description: The client's secret. + EnterpriseCrmFrontendsEventbusProtoTaskConfig: type: object description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. - id: EnterpriseCrmEventbusProtoNextTask - GoogleCloudIntegrationsV1alphaExecution: - description: >- - The Execution resource contains detailed information of an individual - integration execution. - id: GoogleCloudIntegrationsV1alphaExecution - type: object + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + id: EnterpriseCrmFrontendsEventbusProtoTaskConfig properties: - responseParams: - description: Event parameters come out as part of the response. - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - deprecated: true - cloudLoggingDetails: - description: Cloud Logging details for the integration version - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - executionMethod: - description: The ways user posts this event. + jsonValidationOption: + description: >- + If set, overrides the option configured in the Task implementation + class. enum: - - EXECUTION_METHOD_UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE + - UNSPECIFIED_JSON_VALIDATION_OPTION + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION type: string enumDescriptions: - - Default value. - - Sync post. - - Async post. - - Async post with schedule time. + - >- + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. + - >- + Validate all potential input JSON parameters against schemas + specified in WorkflowParameters. + - >- + Validate all potential output JSON parameters against schemas + specified in WorkflowParameters. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. createTime: - type: string - description: Output only. Created time of the execution. - readOnly: true format: google-datetime - executionDetails: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' - description: Detailed info of this execution. - directSubExecutions: - description: Direct sub executions of the following Execution. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - requestParameters: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Event parameters come in as part of the request. - name: type: string - description: Auto-generated primary key. - triggerId: + description: Auto-generated. + description: description: >- - The trigger id of the integration trigger config. If both trigger_id - and client_id is present, the integration is executed from the start - tasks provided by the matching trigger config otherwise it is - executed from the default start tasks. + User-provided description intended to give more business context + about the task. type: string - updateTime: - format: google-datetime + preconditionLabel: + description: >- + Optional. User-provided label that is attached to precondition in + the UI. type: string - description: Output only. Last modified time of the execution. - readOnly: true - integrationVersionState: - readOnly: true - description: Output only. State of the integration version + taskName: type: string - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - responseParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - description: Event parameters returned as part of the response. - eventExecutionDetails: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' - description: The execution info about this event. - deprecated: true - replayInfo: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo - description: Output only. Replay info for the execution - readOnly: true - requestParams: - deprecated: true - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: Event parameters come in as part of the request. - snapshotNumber: + description: The name for the task. + taskSpec: description: >- - Output only. An increasing sequence that is set when a new snapshot - is created - readOnly: true - format: int64 + A string template that allows user to configure task parameters + (with either literal default values or tokens which will be resolved + at execution time) for the task. It will eventually replace the old + "parameters" field. type: string - GoogleCloudIntegrationsV1alphaIntegrationParameter: - properties: - isTransient: - type: boolean - description: Whether this parameter is a transient parameter. - description: + taskExecutionStrategy: type: string - description: Optional. Description of the parameter. - containsLargeData: - description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - type: boolean - inputOutputType: - enum: - - IN_OUT_TYPE_UNSPECIFIED - - IN - - OUT - - IN_OUT enumDescriptions: - - Default. - >- - Input parameters for the integration. EventBus validates that - these parameters exist in the integrations before execution. + Wait until all of its previous tasks finished execution, then + verify at least one of the edge conditions is met, and execute if + possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - >- - Output Parameters for the integration. EventBus will only return - the integration parameters tagged with OUT in the response back. + Start execution as long as any of its previous tasks finished + execution and the corresponding edge condition is met (since we + will execute if only that succeeding edge condition is met). - >- - Input and Output Parameters. These can be used as both input and - output. EventBus will validate for the existence of these - parameters before execution and will also return this parameter - back in the response. - description: Specifies the input/output type for the parameter. - type: string - producer: - type: string + Wait until all of its previous tasks finished execution, then + verify the all edge conditions are met and execute if possible. + description: The policy dictating the execution strategy of this task. + enum: + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + nextTasks: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' description: >- - The identifier of the node (TaskConfig/TriggerConfig) this parameter - was produced by, if it is a transient param or a copy of an input - param. - masked: + The set of tasks that are next in line to be executed as per the + execution graph defined for the parent event, specified by + `event_config_id`. Each of these next tasks are executed only if the + condition associated with them evaluates to true. + disableStrictTypeValidation: type: boolean - description: True if this parameter should be masked in the logs - defaultValue: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - jsonSchema: + If this config contains a TypedTask, allow validation to succeed if + an input is read from the output of another TypedTask whose output + type is declared as a superclass of the requested input type. For + instance, if the previous task declares an output of type Message, + any task with this flag enabled will pass validation when attempting + to read any proto Message type from the resultant Event parameter. + externalTaskType: type: string + enumDescriptions: + - Default value. External task type is not specified + - Tasks belongs to the normal task flows + - Task belongs to the error catch task flows + enum: + - EXTERNAL_TASK_TYPE_UNSPECIFIED + - NORMAL_TASK + - ERROR_TASK + failurePolicy: description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - dataType: + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + taskType: + description: Defines the type of the task + enum: + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE type: string enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - - // Non-serializable object (Internal use only). - description: Type of the parameter. - enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - - NON_SERIALIZABLE_OBJECT - key: + - Normal IP task + - Task is of As-Is Template type + - Task is of I/O template type with a different underlying task + lastModifiedTime: + format: google-datetime + description: Auto-generated. + type: string + precondition: type: string description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - displayName: + Optional. Standard filter expression evaluated before execution. + Independent of other conditions and tasks. Can be used to enable + rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to + task. + alertConfigs: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' + description: >- + Alert configurations on error rate, warning rate, number of runs, + durations, etc. + type: array + taskNumber: + description: >- + REQUIRED: the identifier of this task within its parent event + config, specified by the client. This should be unique among all the + tasks belong to the same event config. We use this field as the + identifier to find next tasks (via field `next_tasks.task_number`). + type: string + taskTemplateName: type: string + description: Used to define task-template name if task is of type task-template + nextTasksExecutionPolicy: description: >- - The name (without prefix) to be displayed in the UI for this - parameter. E.g. if the key is "foo.bar.myName", then the name would - be "myName". - searchable: - description: Searchable in the execution log or not. - type: boolean - id: GoogleCloudIntegrationsV1alphaIntegrationParameter - type: object - description: >- - Integration Parameter is defined in the integration config and are used - to provide information about data types of the expected parameters and - provide any default values if needed. They can also be used to add - custom attributes. These are static in nature and should not be used for - dynamic event definition. - EnterpriseCrmEventbusProtoSerializedObjectParameter: - type: object - properties: - objectValue: - format: byte + The policy dictating the execution of the next set of tasks for the + current task. type: string - id: EnterpriseCrmEventbusProtoSerializedObjectParameter - GoogleCloudIntegrationsV1alphaCredential: - id: GoogleCloudIntegrationsV1alphaCredential - description: Defines parameters for a single, canonical credential. - properties: - credentialType: enumDescriptions: - - Unspecified credential type - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN + - UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + errorCatcherId: type: string - description: Credential type associated with auth config. - serviceAccountCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials - description: Service account credential - authToken: - description: Auth token credential - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' - oauth2ClientCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials - description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials - oauth2AuthorizationCode: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode description: >- - The api_key and oauth2_implicit are not covered in v1 and will be - picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 - authorization code credential - jwt: - description: JWT credential - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' - oidcToken: - description: Google OIDC ID Token - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' - oauth2ResourceOwnerCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials - description: OAuth2 resource owner credentials - usernameAndPassword: + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task + rollbackStrategy: + description: >- + Optional. Contains information about what needs to be done upon + failure (either a permanent error or after it has been retried too + many times). $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword - description: Username and password credential - type: object - GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: - type: object - properties: - absolute: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + creatorEmail: + description: The creator's email address. Auto-generated from the user's email. type: string - description: Absolute value threshold. - format: int64 - percentage: + label: + type: string + description: User-provided label that is attached to this TaskConfig in the UI. + successPolicy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' + description: Determines what action to take upon successful task completion. + parameters: + type: object + additionalProperties: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: The customized parameters the user can pass to this task. + synchronousCallFailurePolicy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + taskEntity: + description: Copy of the task entity that this task config is an instance of. + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' + incomingEdgeCount: format: int32 - description: Percentage threshold. + description: The number of edges leading into this TaskConfig. type: integer - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue - description: >- - The threshold value of the metric, above or below which the alert should - be triggered. See EventAlertConfig or TaskAlertConfig for the different - alert metric types in each case. For the *RATE metrics, one or both of - these fields may be set. Zero is the default value and can be left at - that. For *PERCENTILE_DURATION metrics, one or both of these fields may - be set, and also, the duration threshold value should be specified in - the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, - these fields should not be set at all. A different member, - threshold_duration_ms, must be set in the EventAlertConfig or the - TaskAlertConfig. - GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: - description: Response of lift Suspense - id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + conditionalFailurePolicies: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoConditionalFailurePolicies + position: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + description: >- + Optional. Informs the front-end application where to draw this task + config on the UI. + EnterpriseCrmEventbusProtoIntArray: + properties: + values: + items: + type: string + format: int64 + type: array + id: EnterpriseCrmEventbusProtoIntArray type: object + GoogleCloudIntegrationsV1alphaDownloadTemplateResponse: properties: - eventExecutionInfoId: + content: + description: String representation of the template. type: string - description: Execution Id that will be returned - EnterpriseCrmFrontendsEventbusProtoTaskEntity: - description: >- - Contains a task's metadata and associated information. Next available - id: 7 + description: Response for DownloadTemplate. + type: object + id: GoogleCloudIntegrationsV1alphaDownloadTemplateResponse + GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest properties: - stats: - description: Deprecated - statistics from the Monarch query. - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusStats' - metadata: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' - description: Metadata inclueds the task name, author and so on. - disabledForVpcSc: - type: boolean - description: True if the task has conflict with vpcsc - uiConfig: + triggerId: + type: string description: >- - UI configuration for this task Also associated with the METADATA - mask. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' - taskType: - description: Defines the type of the task - enumDescriptions: - - Normal IP task - - Task is of As-Is Template type - - Task is of I/O template type with a different underlying task - enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE + Required. Matched against all {@link TriggerConfig}s across all + integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The + trigger_id is in the format of `api_trigger/TRIGGER_NAME`. + executionId: + description: Optional. The id of the ON_HOLD execution to be resumed. type: string - paramSpecs: + parameters: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + deprecated: true description: >- - Declarations for inputs/outputs for a TypedTask. This is also - associated with the METADATA mask. + Optional. Passed in as parameters to each integration execution. + Redacted + inputParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + description: Optional. Input parameters used by integration execution. + requestId: + type: string + description: >- + Optional. This is used to de-dup incoming request: if the duplicate + request was detected, the response from the previous execution is + returned. + parameterEntries: + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: >- + Optional. Parameters are a part of Event and can be used to + communicate between different tasks that are part of the same + integration execution. + type: array + deprecated: true + doNotPropagateError: + type: boolean + description: >- + Optional. Flag to determine how to should propagate errors. If this + flag is set to be true, it will not throw an exception. Instead, it + will return a {@link ExecuteIntegrationsResponse} with an execution + id and error messages as PostWithTriggerIdExecutionException in + {@link EventParameters}. The flag is set to be false by default. + description: The request for executing an integration. type: object - id: EnterpriseCrmFrontendsEventbusProtoTaskEntity GoogleCloudIntegrationsV1alphaSuccessPolicy: type: object + id: GoogleCloudIntegrationsV1alphaSuccessPolicy description: >- Policy that dictates the behavior for the task after it completes successfully. properties: finalState: - type: string enumDescriptions: - UNSPECIFIED. - >- @@ -3596,6 +3692,7 @@ components: SuspensionTask; event execution will continue once the user calls ResolveSuspensions with the event_execution_info_id and the task number. + type: string enum: - FINAL_STATE_UNSPECIFIED - SUCCEEDED @@ -3603,1344 +3700,1581 @@ components: description: >- State to which the execution snapshot status will be set if the task succeeds. - id: GoogleCloudIntegrationsV1alphaSuccessPolicy - GoogleCloudConnectorsV1ResourceRequests: - description: Resource requests defined for connection pods of a given connector type. - id: GoogleCloudConnectorsV1ResourceRequests - type: object + GoogleCloudIntegrationsV1alphaTriggerConfig: + description: Configuration detail of a trigger. properties: - cpu: - description: Output only. CPU request. - readOnly: true - type: string - memory: - readOnly: true + description: type: string - description: Output only. Memory request. - GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: - type: object - id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse - properties: - regions: - description: All regions where Connector Platform is provisioned. - type: array - items: - type: string - description: Response containing all provisioned regions for Connector Platform. - GoogleCloudIntegrationsV1alphaParameterMap: - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - type: object - id: GoogleCloudIntegrationsV1alphaParameterMap - properties: - entries: + description: >- + Optional. User-provided description intended to give additional + business context about the task. + alertConfig: items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry - description: A list of parameter map entries. + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig + description: >- + Optional. An alert threshold configuration for the [trigger + client + + integration] tuple. If these values are not specified in the + trigger config, default values will be populated by the system. Note + that there must be exactly one alert threshold configured per + [client + trigger + integration] when published. type: array - keyType: + trigger: type: string description: >- - Option to specify key type for all entries of the map. If provided - then field types for all entries must conform to this. + Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub + Sub Trigger" When set will be sent out to monitoring dashabord for + tracking purpose. + triggerType: + type: string + description: Optional. Type of trigger enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - - NON_SERIALIZABLE_OBJECT + - TRIGGER_TYPE_UNSPECIFIED + - CRON + - API + - SFDC_CHANNEL + - CLOUD_PUBSUB_EXTERNAL + - SFDC_CDC_CHANNEL + - CLOUD_SCHEDULER + - INTEGRATION_CONNECTOR_TRIGGER + - PRIVATE_TRIGGER enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - - // Non-serializable object (Internal use only). - valueType: + - Unknown. + - Trigger by scheduled time. + - Trigger by API call. + - Trigger by Salesforce Channel. + - Trigger by Pub/Sub external. + - SFDC Channel Trigger for CDC. + - Trigger by Cloud Scheduler job. + - Trigger by Connector Event + - Trigger for private workflow + position: + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + startTasks: + description: >- + Optional. Set of tasks numbers from where the integration execution + is started by this trigger. If this is empty, then integration is + executed with default start tasks. In the list of start tasks, none + of two tasks can have direct ancestor-descendant relationships (i.e. + in a same integration execution graph). + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + type: array + nextTasksExecutionPolicy: + description: Optional. Dictates how next tasks will be executed. enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - - // Non-serializable object (Internal use only). + - Default. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + type: string enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - - NON_SERIALIZABLE_OBJECT + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + triggerId: description: >- - Option to specify value type for all entries of the map. If provided - then field types for all entries must conform to this. + Optional. Auto-generated trigger ID. The ID is based on the + properties that you define in the trigger config. For example, for + an API trigger, the trigger ID follows the format: + api_trigger/TRIGGER_NAME Where trigger config has properties with + value {"Trigger name": TRIGGER_NAME} type: string - EnterpriseCrmEventbusProtoCloudLoggingDetails: + triggerNumber: + description: >- + Required. A number to uniquely identify each trigger config within + the integration on UI. + type: string + label: + type: string + description: Optional. The user created label for a particular trigger. + properties: + description: >- + Optional. Configurable properties of the trigger, not to be confused + with integration parameters. E.g. "name" is a property for API + triggers and "subscription" is a property for Pub/sub triggers. + type: object + additionalProperties: + type: string + errorCatcherId: + type: string + description: >- + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task + cloudSchedulerConfig: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + description: Optional. Cloud Scheduler Trigger related metadata + id: GoogleCloudIntegrationsV1alphaTriggerConfig + type: object + GoogleCloudIntegrationsV1alphaUseTemplateResponse: + description: Response for use template type: object - id: EnterpriseCrmEventbusProtoCloudLoggingDetails properties: - cloudLoggingSeverity: + subIntegrationVersions: + description: Sub integration versions which are created. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: IntegrationVersion which is created. + id: GoogleCloudIntegrationsV1alphaUseTemplateResponse + EnterpriseCrmEventbusStats: + properties: + warningRate: + type: number + format: double + description: Average warning rate. + dimensions: + description: Dimensions that these stats have been aggregated on. + $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' + durationInSeconds: + description: Average duration in seconds. + type: number + format: double + qps: + format: double + description: Queries per second. + type: number + errorRate: + format: double + type: number + description: Average error rate. + id: EnterpriseCrmEventbusStats + description: >- + Stats for the requested dimensions: QPS, duration, and error/warning + rate + type: object + EnterpriseCrmEventbusProtoParamSpecEntryConfig: + properties: + inputDisplayOption: + enumDescriptions: + - >- + A single-line input for strings, a numeric input box for numbers, + or a checkbox for booleans. + - A multi-line input box for longer strings/string templates. + - >- + A slider to select a numerical value. The default range is [0, + 100]. + - A toggle button for boolean parameters. + type: string + enum: + - DEFAULT + - STRING_MULTI_LINE + - NUMBER_SLIDER + - BOOLEAN_TOGGLE + subSectionLabel: + type: string description: >- - Severity selected by the customer for the logs to be sent to Cloud - Logging, for the integration version getting executed. + A user-friendly label for subSection under which the parameter will + be displayed. + parameterNameOption: + type: string enum: - - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - - INFO - - ERROR - - WARNING + - DEFAULT_NOT_PARAMETER_NAME + - IS_PARAMETER_NAME + - KEY_IS_PARAMETER_NAME + - VALUE_IS_PARAMETER_NAME enumDescriptions: - - Unspecified + - This field is not a parameter name. - >- - If Severity selected is `INFO`, then all the Integration Execution - States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, - `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + If this field is a string and this option is selected, the field + will be interpreted as a parameter name. Users will be able to + choose a variable using the autocomplete, but the name will be + stored as a literal string. - >- - If Severity selected is `ERROR`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. + If this field is a ParameterMap and this option is selected, the + map's keys will be interpreted as parameter names. Ignored if this + field is not a ParameterMap. - >- - If Severity selected is `WARNING`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. + If this field is a ParameterMap and this option is selected, the + map's values will be interpreted as parameter names. Ignored if + this field is not a ParameterMap. + hideDefaultValue: + description: Whether the default value is hidden in the UI. + type: boolean + descriptivePhrase: + type: string + description: A short phrase to describe what this parameter contains. + uiPlaceholderText: type: string - enableCloudLogging: description: >- - Status of whether Cloud Logging is enabled or not for the - integration version getting executed. + Placeholder text which will appear in the UI input form for this + parameter. + isHidden: + description: Whether this field is hidden in the UI. type: boolean - description: >- - Cloud Logging details, selected by the user for the integration version - (workflow). This message field will be also used in ExecutionInfo, to - indicate the CloudLoggingDetails config at the time of workflow - (integration version) execution, since this field value can be changed - for an unpublished workflow. - EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: - properties: - rollbackTaskImplementationClassName: + label: + type: string + description: A user-friendly label for the parameter. + helpText: type: string description: >- - Required. This is the name of the task that needs to be executed - upon rollback of this task. - taskNumbersToRollback: - type: array - description: >- - Required. These are the tasks numbers of the tasks whose - `rollback_strategy.rollback_task_implementation_class_name` needs to - be executed upon failure of this task. - items: - type: string - parameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Optional. The customized parameters the user can pass to this task. + Detailed help text for this parameter containing information not + provided elsewhere. For example, instructions on how to migrate from + a deprecated parameter. type: object - id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy - description: 'Next available id: 4' - EnterpriseCrmEventbusProtoScatterResponse: + id: EnterpriseCrmEventbusProtoParamSpecEntryConfig + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: + description: Response for CreateAppsScriptProject rpc call. + properties: + projectId: + type: string + description: The created AppsScriptProject ID. type: object - id: EnterpriseCrmEventbusProtoScatterResponse + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + EnterpriseCrmEventbusProtoConditionResult: + description: Contains the combined condition calculation results. properties: - isSuccessful: - type: boolean + result: description: >- - If execution is sync, this is true if the execution passed and false - if it failed. If the execution is async, this is true if the WF was - fired off successfully, and false if it failed to execute. The - success or failure of the subworkflows executed are not captured. - executionIds: - description: The execution ids of each Subworkflow fired by this scatter. - type: array - items: - type: string - scatterElement: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: The element that was scattered for this execution. - errorMsg: + the result comes out after evaluate the combined condition. True if + there's no combined condition specified. + type: boolean + currentTaskNumber: + description: the current task number. type: string - description: The error message of the failure if applicable. - responseParams: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' - type: array - description: >- - A list of all the response parameters in the aggregtorMap stored - with the remapped key. - GoogleCloudIntegrationsV1alphaListCertificatesResponse: + nextTaskNumber: + type: string + description: the next task number. + id: EnterpriseCrmEventbusProtoConditionResult type: object - description: Response to list Certificates. - id: GoogleCloudIntegrationsV1alphaListCertificatesResponse + GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: + description: Response of lift Suspense + id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse properties: - certificates: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' - description: The list of Certificates retrieved. - nextPageToken: - description: The token used to retrieve the next page of results. + eventExecutionInfoId: type: string - GoogleCloudIntegrationsV1alphaGetClientResponse: + description: Execution Id that will be returned type: object - description: Response for the GetClient rpc - id: GoogleCloudIntegrationsV1alphaGetClientResponse - properties: - client: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' - description: 'Required. Required: The client configuration that was requested' - EnterpriseCrmEventbusProtoFunction: - id: EnterpriseCrmEventbusProtoFunction - properties: - parameters: - description: List of parameters required for the transformation. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - type: array - functionType: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' - description: The name of the function to perform. - type: object - GoogleCloudConnectorsV1DestinationConfig: + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest type: object - description: Define the Connectors target endpoint. + description: Request for CreateAppsScriptProject rpc call. properties: - key: + authConfigId: description: >- - The key is the destination identifier that is supported by the - Connector. + The auth config id necessary to fetch the necessary credentials to + create the project for external clients type: string - destinations: - description: The destinations for the key. - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' - type: array - id: GoogleCloudConnectorsV1DestinationConfig - EnterpriseCrmEventbusProtoCustomSuspensionRequest: - id: EnterpriseCrmEventbusProtoCustomSuspensionRequest - type: object + appsScriptProject: + description: The name of the Apps Script project to be created. + type: string + EnterpriseCrmEventbusProtoCloudKmsConfig: properties: - postToQueueWithTriggerIdRequest: - $ref: >- - #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest - description: Request to fire an event containing the SuspensionInfo message. - suspensionInfoEventParameterKey: + gcpProjectId: description: >- - In the fired event, set the SuspensionInfo message as the value for - this key. + Optional. The id of GCP project where the KMS key is stored. If not + provided, assume the key is stored in the same GCP project defined + in Client (tag 14). type: string - EnterpriseCrmEventbusProtoDoubleFunction: + keyName: + description: >- + A Cloud KMS key is a named object containing one or more key + versions, along with metadata for the key. A key exists on exactly + one key ring tied to a specific location. + type: string + keyRingName: + type: string + description: >- + A key ring organizes keys in a specific Google Cloud location and + allows you to manage access control on groups of keys. A key ring's + name does not need to be unique across a Google Cloud project, but + must be unique within a given location. + keyVersionName: + description: >- + Optional. Each version of a key contains key material used for + encryption or signing. A key's version is represented by an integer, + starting at 1. To decrypt data or verify a signature, you must use + the same key version that was used to encrypt or sign the data. + type: string + locationName: + type: string + description: Location name of the key ring, e.g. "us-west1". + serviceAccount: + description: >- + Optional. The service account used for authentication of this KMS + key. If this is not provided, the service account in + Client.clientSource will be used. + type: string + id: EnterpriseCrmEventbusProtoCloudKmsConfig + type: object + GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: type: object + id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials properties: - functionName: + clientSecret: + description: The client's secret. + type: string + scope: + type: string + description: A space-delimited list of requested scope permissions. + password: + description: The user's password. + type: string + username: + description: The user's username. + type: string + accessToken: + description: Access token fetched from the authorization server. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + clientId: + type: string + description: The client's ID. + tokenEndpoint: + type: string + description: >- + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. + tokenParams: + description: Token parameters for the auth request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + requestType: type: string - enum: - - UNSPECIFIED - - TO_JSON - - TO_STRING - - ADD - - SUBTRACT - - MULTIPLY - - DIVIDE - - EXPONENT - - ROUND - - FLOOR - - CEIL - - GREATER_THAN - - LESS_THAN - - EQUALS - - GREATER_THAN_EQUALS - - LESS_THAN_EQUALS - - MOD enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - id: EnterpriseCrmEventbusProtoDoubleFunction - GoogleCloudConnectorsV1LockConfig: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + description: Represent how to pass parameters to fetch access token description: >- - Determines whether or no a connection is locked. If locked, a reason - must be specified. - type: object + For resource owner credentials grant, the client will ask the user for + their authorization credentials (ususally a username and password) and + send a POST request to the authorization server. The authorization + server will respond with a JSON object containing the access token. + EnterpriseCrmEventbusProtoNextTeardownTask: + id: EnterpriseCrmEventbusProtoNextTeardownTask + description: >- + The teardown task that is next in line to be executed. We support only + sequential execution of teardown tasks (i.e. no branching). properties: - locked: - description: Indicates whether or not the connection is locked. - type: boolean - reason: + name: type: string - description: Describes why a connection is locked. - id: GoogleCloudConnectorsV1LockConfig - GoogleCloudIntegrationsV1alphaUseTemplateRequest: + description: Required. Name of the next teardown task. type: object + GoogleCloudConnectorsV1AuthConfigUserPassword: + id: GoogleCloudConnectorsV1AuthConfigUserPassword + description: Parameters to support Username and Password Authentication. properties: - integrationRegion: + password: + description: Secret version reference containing the password. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + username: + description: Username. type: string - description: Required. The region of the Integration to be created. - integrationDetails: - description: Required. Integration details which would be created via templates. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - subIntegrations: - description: Optional. Sub Integration which would be created via templates. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - type: object - id: GoogleCloudIntegrationsV1alphaUseTemplateRequest - description: Request to Use template - EnterpriseCrmEventbusProtoBooleanFunction: - id: EnterpriseCrmEventbusProtoBooleanFunction + type: object + GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - TO_JSON - - NOT - - AND - - NAND - - OR - - XOR - - NOR - - XNOR - - TO_STRING - - EQUALS - type: string + properties: + description: 'Required. Required: The client configuration that was requested' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' type: object - EnterpriseCrmEventbusProtoNotification: - id: EnterpriseCrmEventbusProtoNotification + id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + description: Response for the GetClientMetadata rpc + GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: + properties: + content: + description: The content of downloaded execution. + type: string + description: Response for downloading an execution. type: object + id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: properties: - escalatorQueue: + timestamp: type: string - pubsubTopic: + format: google-datetime + resolvedByCpi: type: string - request: - description: >- - If the out-of-the-box email/pubsub notifications are not suitable - and custom logic is required, fire a workflow containing all info - needed to notify users to resume execution. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest - buganizerNotification: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' - emailAddress: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' - EnterpriseCrmEventbusStats: - id: EnterpriseCrmEventbusStats - description: >- - Stats for the requested dimensions: QPS, duration, and error/warning - rate + resolvedBy: + type: string + type: object + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + GoogleCloudIntegrationsV1alphaAttemptStats: + description: Status for the execution attempt. properties: - durationInSeconds: - type: number - description: Average duration in seconds. - format: double - qps: - description: Queries per second. - format: double - type: number - dimensions: - $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' - description: Dimensions that these stats have been aggregated on. - warningRate: - format: double - description: Average warning rate. - type: number - errorRate: - description: Average error rate. - type: number - format: double + endTime: + type: string + description: The end time of the integration execution for current attempt. + format: google-datetime + startTime: + format: google-datetime + description: >- + The start time of the integration execution for current attempt. + This could be in the future if it's been scheduled. + type: string + id: GoogleCloudIntegrationsV1alphaAttemptStats + type: object + GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: type: object - GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: - id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse properties: - executionFailed: - type: boolean - description: Is true if any execution in the integration failed. False otherwise. - parameterEntries: + customMessage: + description: Information to provide for recipients. + type: string + emailAddresses: + description: Email addresses to send approval request to. type: array - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - deprecated: true items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - eventParameters: + type: string + expiration: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - deprecated: true - description: Details for the integration that were executed. - executionId: - description: The id of the execution corresponding to this run of integration. + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + description: >- + Indicates the next steps when no external actions happen on the + suspension. + description: Configurations for approving the Suspension. + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + EnterpriseCrmEventbusProtoParameterEntry: + properties: + key: type: string - parameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object description: >- - Optional. Parameters are a part of Event and can be used to - communicate between different tasks that are part of the same - integration execution. + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. + masked: + type: boolean + description: True if this parameter should be masked in the logs + value: + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: Key-value pair of EventBus parameters. + id: EnterpriseCrmEventbusProtoParameterEntry type: object - description: The response for testing an integration. - EnterpriseCrmEventbusProtoBooleanParameterArray: - id: EnterpriseCrmEventbusProtoBooleanParameterArray + EnterpriseCrmEventbusProtoTeardown: properties: - booleanValues: + teardownTaskConfigs: type: array items: - type: boolean - type: object - EnterpriseCrmEventbusProtoTaskUiModuleConfig: - id: EnterpriseCrmEventbusProtoTaskUiModuleConfig - properties: - moduleId: - enumDescriptions: - - Default - - Supports editing label of a task config. - - Supports editing error handling settings such as retry strategy. - - >- - Supports adding, removing and editing task parameter values in a - table with little assistance or restriction. - - >- - Supports editing values of declared input parameters of a task. - Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE. - - Supports editing preconditions of a task config. - - >- - Supports adding, editing, and deleting the scripts associated with - a script task, as well as modifying the input/output parameters. - - >- - Supports editing task parameters associated with an RPC/stubby - task. - - >- - Contains readonly task information, including input/output type - info. - - Configures a SuspensionTask. - - Configures a GenericStubbyTypedTask. - - Configures a SubWorkflowExecutorTask. - - Supports navigating to Apps Script editor - - Configures a SubWorkflowForEachLoopTask. - - Configures a FieldMappingTask. - - Contains embedded in-product documentation for a task. - - UI widget for the rest caller task. - - Configures a SubWorkflowScatterGatherTask. - - Configures a CloudSql Task. - - Configure a GenericConnectorTask. - description: ID of the config module. - enum: - - UNSPECIFIED_TASK_MODULE - - LABEL - - ERROR_HANDLING - - TASK_PARAM_TABLE - - TASK_PARAM_FORM - - PRECONDITION - - SCRIPT_EDITOR - - RPC - - TASK_SUMMARY - - SUSPENSION - - RPC_TYPED - - SUB_WORKFLOW - - APPS_SCRIPT_NAVIGATOR - - SUB_WORKFLOW_FOR_EACH_LOOP - - FIELD_MAPPING - - README - - REST_CALLER - - SUB_WORKFLOW_SCATTER_GATHER - - CLOUD_SQL - - GENERIC_CONNECTOR_TASK - type: string + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' + description: Required. type: object - description: Task author would use this type to configure a config module. - EnterpriseCrmEventbusProtoProtoParameterArray: - id: EnterpriseCrmEventbusProtoProtoParameterArray + id: EnterpriseCrmEventbusProtoTeardown + EnterpriseCrmEventbusProtoCombinedCondition: + deprecated: true type: object + id: EnterpriseCrmEventbusProtoCombinedCondition + description: >- + This message recursively combines constituent conditions using logical + AND. properties: - protoValues: + conditions: + description: A set of individual constituent conditions. items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' type: array - GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: - id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + GoogleCloudIntegrationsV1alphaTemplateComponent: + type: object properties: - scope: + name: + type: string + description: Optional. Name of the component. + type: type: string - description: A space-delimited list of requested scope permissions. - requestType: - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. + - Component type is unspecified + - Trigger component + - Task component + - Connector component + description: Optional. Type of the component. + enum: + - TYPE_UNSPECIFIED + - TRIGGER + - TASK + - CONNECTOR + id: GoogleCloudIntegrationsV1alphaTemplateComponent + description: Define the components that are present in a template. + GoogleCloudIntegrationsV1alphaListConnectionsResponse: + type: object + description: Response containing Connections listed by region. + properties: + connections: + description: Connections. + type: array + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' + nextPageToken: + description: Next page token. type: string - description: Represent how to pass parameters to fetch access token - clientId: + id: GoogleCloudIntegrationsV1alphaListConnectionsResponse + EnterpriseCrmEventbusProtoTeardownTaskConfig: + id: EnterpriseCrmEventbusProtoTeardownTaskConfig + type: object + properties: + teardownTaskImplementationClassName: type: string - description: The client's ID. - username: + description: Required. Implementation class name. + properties: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' + creatorEmail: type: string - description: The user's username. - password: - type: string - description: The user's password. - clientSecret: - description: The client's secret. - type: string - tokenEndpoint: + description: The creator's email address. + name: type: string description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. - tokenParams: - description: Token parameters for the auth request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - accessToken: - description: Access token fetched from the authorization server. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - type: object - description: >- - For resource owner credentials grant, the client will ask the user for - their authorization credentials (ususally a username and password) and - send a POST request to the authorization server. The authorization - server will respond with a JSON object containing the access token. - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: + Required. Unique identifier of the teardown task within this Config. + We use this field as the identifier to find next teardown tasks. + parameters: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: The parameters the user can pass to this task. + nextTeardownTask: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' + GoogleCloudIntegrationsV1alphaTemplateBundle: + description: Define the bundle of the template. + id: GoogleCloudIntegrationsV1alphaTemplateBundle properties: - integrationVersion: - description: The uploaded integration. + subIntegrationVersionTemplates: + type: array + description: >- + Optional. Sub integration templates which would be added along with + main integration. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + integrationVersionTemplate: + description: Required. Main integration templates of the template bundle. $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate type: object - description: Response for UploadIntegrationVersion. - EnterpriseCrmEventbusProtoBuganizerNotification: + EnterpriseCrmEventbusProtoParameterValueType: + id: EnterpriseCrmEventbusProtoParameterValueType + type: object + description: >- + LINT.IfChange To support various types of parameter values. Next + available id: 14 properties: - title: - description: Title of the issue to be created. Required. - type: string - componentId: - type: string - format: int64 - description: >- - ID of the buganizer component within which to create a new issue. - Required. - templateId: + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' + intValue: format: int64 - description: ID of the buganizer template to use. Optional. type: string - assigneeEmailAddress: + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' + protoArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' + stringValue: type: string - description: Whom to assign the new bug. Optional. - id: EnterpriseCrmEventbusProtoBuganizerNotification + protoValue: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + booleanArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter + doubleValue: + format: double + type: number + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' + booleanValue: + type: boolean + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: + properties: + jwtClaims: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + description: JwtClaims providers fields to generate the token. + clientKey: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: >- + Secret version reference containing a PKCS#8 PEM-encoded private key + associated with the Client Certificate. This private key will be + used to sign JWTs used for the jwt-bearer authorization grant. + Specified in the form as: `projects/*/secrets/*/versions/*`. + description: >- + Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 + Authorization Grant based authentication. See + https://tools.ietf.org/html/rfc7523 for more details. type: object - GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer + EnterpriseCrmEventbusProtoMappedField: type: object - properties: {} - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest - description: Request for TakeoverEditLock. - EnterpriseCrmFrontendsEventbusProtoTriggerConfig: - id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig + id: EnterpriseCrmEventbusProtoMappedField properties: - enabledClients: - description: >- - Required. The list of client ids which are enabled to execute the - workflow using this trigger. In other words, these clients have the - workflow execution privledges for this trigger. For API trigger, the - client id in the incoming request is validated against the list of - enabled clients. For non-API triggers, one workflow execution is - triggered on behalf of each enabled client. - items: - type: string - type: array - alertConfig: + outputField: + description: The output field being mapped to. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' + inputField: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' + description: The input field being mapped from. + description: Mapped field is a pair of input field and output field. + GoogleCloudConnectorsV1SslConfig: + type: object + id: GoogleCloudConnectorsV1SslConfig + properties: + clientPrivateKey: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Client Private Key + clientPrivateKeyPass: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Secret containing the passphrase protecting the Client Private Key + useSsl: + description: Bool for enabling SSL + type: boolean + additionalVariables: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' type: array + description: Additional SSL related field values + privateServerCertificate: description: >- - An alert threshold configuration for the [trigger + client + - workflow] tuple. If these values are not specified in the trigger - config, default values will be populated by the system. Note that - there must be exactly one alert threshold configured per [client + - trigger + workflow] when published. - triggerNumber: - description: >- - Required. A number to uniquely identify each trigger config within - the workflow on UI. + Private Server Certificate. Needs to be specified if trust model is + `PRIVATE`. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + serverCertType: type: string - errorCatcherId: + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type + description: Type of Server Cert (PEM/JKS/.. etc.) + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + type: + description: Controls the ssl type for the given connector version. + enum: + - SSL_TYPE_UNSPECIFIED + - TLS + - MTLS type: string - description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - nextTasksExecutionPolicy: - description: Dictates how next tasks will be executed. + enumDescriptions: + - No SSL configuration required. + - TLS Handshake + - mutual TLS (MTLS) Handshake + trustModel: type: string enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH + - PUBLIC + - PRIVATE + - INSECURE enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - triggerName: + - Public Trust Model. Takes the Default Java trust store. + - Private Trust Model. Takes custom/private trust store. + - Insecure Trust Model. Accept all certificates. + description: Trust Model of the SSL connection + clientCertificate: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Client Certificate + clientCertType: + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type type: string - description: >- - Optional. Name of the trigger This is added to identify the type of - trigger. This is avoid the logic on triggerId to identify the - trigger_type and push the same to monitoring. - pauseWorkflowExecutions: - type: boolean - description: >- - Optional. If set to true, any upcoming requests for this trigger - config will be paused and the executions will be resumed later when - the flag is reset. The workflow to which this trigger config belongs - has to be in ACTIVE status for the executions to be paused or - resumed. - properties: - additionalProperties: + description: Type of Client Cert (PEM/JKS/.. etc.) + description: SSL Configuration of a connection + GoogleProtobufEmpty: + properties: {} + 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); } + type: object + id: GoogleProtobufEmpty + GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: + description: Response containing all provisioned regions for Connector Platform. + id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse + type: object + properties: + regions: + items: type: string - description: >- - Configurable properties of the trigger, not to be confused with - workflow parameters. E.g. "name" is a property for API triggers and - "subscription" is a property for Cloud Pubsub triggers. - type: object - cloudSchedulerConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' - description: - type: string - description: >- - User-provided description intended to give more business context - about the task. - triggerCriteria: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria' - description: >- - Optional. When set, Eventbus will run the task specified in the - trigger_criteria and validate the result using the - trigger_criteria.condition, and only execute the workflow when - result is true. - label: - description: The user created label for a particular trigger. - type: string - position: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' - description: >- - Optional. Informs the front-end application where to draw this - trigger config on the UI. - startTasks: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' type: array - description: >- - Set of tasks numbers from where the workflow execution is started by - this trigger. If this is empty, then workflow is executed with - default start tasks. In the list of start tasks, none of two tasks - can have direct ancestor-descendant relationships (i.e. in a same - workflow execution graph). - triggerId: + description: All regions where Connector Platform is provisioned. + EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: + description: List of error enums for alerts. + properties: + enumStrings: + type: array + items: + type: string + filterType: type: string - description: The backend trigger ID. - triggerType: + enum: + - DEFAULT_INCLUSIVE + - EXCLUSIVE enumDescriptions: - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNKNOWN - - CLOUD_PUBSUB - - GOOPS - - SFDC_SYNC - - CRON - - API - - MANIFOLD_TRIGGER - - DATALAYER_DATA_CHANGE - - SFDC_CHANNEL - - CLOUD_PUBSUB_EXTERNAL - - SFDC_CDC_CHANNEL - - SFDC_PLATFORM_EVENTS_CHANNEL - - CLOUD_SCHEDULER - - INTEGRATION_CONNECTOR_TRIGGER - - PRIVATE_TRIGGER + id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + type: object + GoogleCloudIntegrationsV1alphaEventParameter: + description: >- + This message is used for processing and persisting (when applicable) key + value pair parameters for each event in the event bus. Next available + id: 4 + id: GoogleCloudIntegrationsV1alphaEventParameter + properties: + key: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. type: string - description: 'Configuration detail of a trigger. Next available id: 20' + masked: + type: boolean + description: True if this parameter should be masked in the logs + value: + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' type: object - EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: + GoogleCloudIntegrationsV1alphaListTemplatesResponse: + id: GoogleCloudIntegrationsV1alphaListTemplatesResponse type: object - id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + description: Response for a request to list templates properties: - startTime: - format: int64 + templates: + description: List of templates retrieved. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + nextPageToken: + description: The token used to retrieve the next page results. + type: string + EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: + type: object + properties: + booleanValues: + items: + type: boolean + type: array + id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + EnterpriseCrmEventbusProtoTriggerCriteria: + properties: + condition: + type: string description: >- - The start time of the event execution for current attempt. This - could be in the future if it's been scheduled. + Required. Standard filter expression, when true the workflow will be + executed. If there's no + trigger_criteria_task_implementation_class_name specified, the + condition will be validated directly. + triggerCriteriaTaskImplementationClassName: type: string - endTime: - description: The end time of the event execution for current attempt. + description: >- + Optional. Implementation class name. The class should implement the + “TypedTask” interface. + parameters: + description: Optional. To be used in TaskConfig for the implementation class. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + type: object + id: EnterpriseCrmEventbusProtoTriggerCriteria + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: + properties: + scriptId: type: string - format: int64 - GoogleCloudIntegrationsV1alphaSfdcChannel: - description: The SfdcChannel that points to a CDC or Platform Event Channel. - id: GoogleCloudIntegrationsV1alphaSfdcChannel + description: The id of the Apps Script project to be linked. + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + type: object + description: Request for LinkAppsScriptProject rpc call. + EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: + type: object + id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry properties: - name: + key: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + value: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + description: Entry is a pair of key and value. + GoogleCloudIntegrationsV1alphaFile: + description: >- + To store Integration version related file i.e. Integration Version, + Config variable etc. + id: GoogleCloudIntegrationsV1alphaFile + type: object + properties: + integrationConfig: + additionalProperties: + type: any + description: Properties of the object. + type: object + description: Integration version config file + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Integration version + type: description: >- - Resource name of the SFDC channel - projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. - type: string - updateTime: + File information like Integration version, Integration Config + variables etc. + enum: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES type: string - description: Output only. Time when the channel was last updated + enumDescriptions: + - Default value. + - Integration file. + - Integration Config variables. + GoogleCloudConnectorsV1Connection: + type: object + properties: + envoyImageLocation: + description: >- + Output only. GCR location where the envoy image is stored. formatted + like: gcr.io/{bucketName}/{imageName} readOnly: true - format: google-datetime + type: string + authConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + description: >- + Optional. Configuration for establishing the connection's + authentication with an external system. description: - description: The description for this channel type: string - deleteTime: + description: Optional. Description of the resource. + nodeConfig: + description: Optional. Node configuration for the connection. + $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' + configVariables: + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + type: array description: >- - Output only. Time when the channel was deleted. Empty if not - deleted. - format: google-datetime + Optional. Configuration for configuring the connection with an + external system. + subscriptionType: + description: >- + Output only. This subscription type enum states the subscription + type of the project. + enum: + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAY_G + - PAID type: string readOnly: true - displayName: - description: Client level unique name/alias to easily reference a channel. + enumDescriptions: + - Unspecified subscription type. + - PayG subscription. + - Paid Subscription. + imageLocation: + readOnly: true + description: >- + Output only. GCR location where the runtime image is stored. + formatted like: gcr.io/{bucketName}/{imageName} type: string - createTime: - description: Output only. Time when the channel is created + connectorVersionInfraConfig: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig + description: Output only. Infra configs supported by Connector Version. + readOnly: true + suspended: + description: >- + Optional. Suspended indicates if a user has suspended a connection + or not. + type: boolean + updateTime: + description: Output only. Updated time. type: string readOnly: true format: google-datetime - lastReplayId: + logConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' + description: Optional. Log configuration for the connection. + eventingRuntimeData: + readOnly: true + description: Output only. Eventing Runtime Data. + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' + connectionRevision: + readOnly: true + format: int64 + description: >- + Output only. Connection revision. This field is only updated when + the connection is created or updated by User. type: string - description: Last sfdc messsage replay id for channel - channelTopic: - description: The Channel topic defined by salesforce once an channel is opened + tlsServiceDirectory: type: string - isActive: + description: Output only. The name of the Service Directory service with TLS. + readOnly: true + labels: + additionalProperties: + type: string + type: object description: >- - Indicated if a channel has any active integrations referencing it. - Set to false when the channel is created, and set to true if there - is any integration published with the channel configured in it. - type: boolean - type: object - GoogleCloudIntegrationsV1alphaExecutionReplayInfo: - description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship - properties: - replayReason: + Optional. Resource labels to represent user-provided metadata. Refer + to cloud documentation on labels for more details. + https://cloud.google.com/compute/docs/labeling-resources + createTime: + description: Output only. Created time. + readOnly: true type: string - description: reason for replay - originalExecutionInfoId: + format: google-datetime + eventingEnablementType: + enumDescriptions: + - Eventing Enablement Type Unspecifeied. + - Both connection and eventing. + - Only Eventing. + description: >- + Optional. Eventing enablement type. Will be nil if eventing is not + enabled. + enum: + - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED + - EVENTING_AND_CONNECTION + - ONLY_EVENTING type: string + lockConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - replayedExecutionInfoIds: - type: array + Optional. Configuration that indicates whether or not the Connection + can be edited. + host: + type: string + readOnly: true description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. + Output only. The name of the Hostname of the Service Directory + service with TLS. + destinationConfigs: + description: >- + Optional. Configuration of the Connector's destination. Only + accepted for Connectors that accepts user defined destination(s). + type: array items: - type: string - id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo - type: object - GoogleCloudConnectorsV1ResourceLimits: - type: object - description: Resource limits defined for connection pods of a given connector type. - properties: - cpu: + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + connectorVersionLaunchStage: type: string - description: Output only. CPU limit. + enumDescriptions: + - LAUNCH_STAGE_UNSPECIFIED. + - PREVIEW. + - GA. + - DEPRECATED. + - PRIVATE_PREVIEW. + description: Output only. Flag to mark the version indicating the launch stage. readOnly: true - memory: - description: Output only. Memory limit. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - PREVIEW + - GA + - DEPRECATED + - PRIVATE_PREVIEW + status: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' + description: Output only. Current status of the connection. + serviceDirectory: type: string + description: >- + Output only. The name of the Service Directory service name. Used + for Private Harpoon to resolve the ILB address. e.g. + "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" readOnly: true - id: GoogleCloudConnectorsV1ResourceLimits - EnterpriseCrmEventbusProtoIntArray: - id: EnterpriseCrmEventbusProtoIntArray - type: object - properties: - values: - items: - type: string - format: int64 - type: array - GoogleCloudIntegrationsV1alphaListTemplatesResponse: - type: object - id: GoogleCloudIntegrationsV1alphaListTemplatesResponse - properties: - nextPageToken: - description: The token used to retrieve the next page results. + connectorVersion: type: string - templates: - description: List of templates retrieved. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' - type: array - description: Response for a request to list templates - GoogleCloudIntegrationsV1alphaTaskExecutionDetails: - description: Contains the details of the execution of this task. - id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails + description: >- + Required. Connector version on which the connection is created. The + format is: + projects/*/locations/*/providers/*/connectors/*/versions/* Only + global location is supported for ConnectorVersion resource. + eventingConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' + description: Optional. Eventing config of a connection + tlsMigrationState: + readOnly: true + enum: + - TLS_MIGRATION_STATE_UNSPECIFIED + - TLS_MIGRATION_NOT_STARTED + - TLS_MIGRATION_COMPLETED + type: string + description: Output only. Status of the TLS migration. + enumDescriptions: + - TLS migration state is not specified. + - TLS migration is in progress. + - TLS migration is completed. + name: + description: >- + Output only. Resource name of the Connection. Format: + projects/{project}/locations/{location}/connections/{connection} + type: string + readOnly: true + asyncOperationsEnabled: + description: >- + Optional. Async operations enabled for the connection. If Async + Operations is enabled, Connection allows the customers to initiate + async long running operations using the actions API. + type: boolean + serviceAccount: + description: >- + Optional. Service account needed for runtime plane to access Google + Cloud resources. + type: string + sslConfig: + description: Optional. Ssl config of a connection + $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' + isTrustedTester: + readOnly: true + type: boolean + description: Output only. Is trusted tester program enabled for the project. + billingConfig: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' + description: Output only. Billing config for the connection. + id: GoogleCloudConnectorsV1Connection + description: Connection represents an instance of connector. + GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: type: object + description: >- + LINT.IfChange Use this request to post all workflows associated with a + given trigger id. Next available id: 13 + id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest properties: - taskNumber: - description: Pointer to the task config it used for execution. + clientId: + description: >- + Optional. If the client id is provided, then the combination of + trigger id and client id is matched across all the workflows. If the + client id is not provided, then workflows with matching trigger id + are executed for each client id in the {@link TriggerConfig}. For + Api Trigger, the client id is required and will be validated against + the allowed clients. type: string - taskAttemptStats: - description: Status for the current task execution attempt. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - taskExecutionState: - description: The execution state of this task. + scheduledTime: + description: >- + Optional. Time in milliseconds since epoch when the given event + would be scheduled. + format: int64 + type: string + testMode: + type: boolean + description: >- + Optional. Sets test mode in {@link + enterprise/crm/eventbus/event_message.proto}. + triggerId: + type: string + description: >- + Matched against all {@link TriggerConfig}s across all workflows. + i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. + requestId: + type: string + description: >- + Optional. This is used to de-dup incoming request: if the duplicate + request was detected, the response from the previous execution is + returned. Must have no more than 36 characters and contain only + alphanumeric characters and hyphens. + parameters: + description: Passed in as parameters to each workflow execution. Optional. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + resourceName: type: string + description: >- + This field is only required when using Admin Access. The resource + name of target, or the parent resource name. For example: + "projects/*/locations/*/integrations/*" + priority: enum: - - TASK_EXECUTION_STATE_UNSPECIFIED - - PENDING_EXECUTION - - IN_PROCESS - - SUCCEED - - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - - CANCELLED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK - - SUSPENDED - enumDescriptions: - - Default value. - - >- - Task is waiting for its precondition tasks to finish to start the - execution. - - Task is under processing. - - >- - Task execution successfully finished. There's no more change after - this state. - - Task execution failed. There's no more change after this state. - - >- - Task execution failed and cause the whole integration execution to - fail immediately. There's no more change after this state. - - Task execution failed and waiting for retry. - - >- - Task execution skipped. This happens when its precondition wasn't - met, or the integration execution been canceled before reach to - the task. There's no more changes after this state. + - UNSPCIFIED + - SHEDDABLE + - SHEDDABLE_PLUS + - CRITICAL + - CRITICAL_PLUS + enumDescriptions: + - Unspecified - >- - Task execution canceled when in progress. This happens when - integration execution been canceled or any other task fall in - fatal state. + Frequent partial and occasional full unavailability is expected + and not pageable. * Requests to this band will be shed before all + other requests. * This is the default for async calls sent from + batch jobs. - >- - Task is waiting for its dependency tasks' rollback to finish to - start its rollback. - - Task is rolling back. + Partial unavailability is expected and is not necessarily + pageable. * Requests to this band will be shed before any critical + traffic. * This is the default for async calls sent from + production jobs. - >- - Task is rolled back. This is the state we will set regardless of - rollback succeeding or failing. + Any outage is a pageable event. * During a production outage + requests in this band will only be shed before CRITICAL_PLUS. * + This is the default for sync calls sent from production jobs. - >- - Task is a SuspensionTask which has executed once, creating a - pending suspension. - EnterpriseCrmEventbusProtoIntFunction: - properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - ADD - - SUBTRACT - - MULTIPLY - - DIVIDE - - EXPONENT - - GREATER_THAN_EQUAL_TO - - GREATER_THAN - - LESS_THAN_EQUAL_TO - - LESS_THAN - - TO_DOUBLE - - TO_STRING - - EQUALS - - TO_JSON - - MOD - - EPOCH_TO_HUMAN_READABLE_TIME - type: string - type: object - id: EnterpriseCrmEventbusProtoIntFunction - GoogleCloudConnectorsV1AuthConfigUserPassword: - description: Parameters to support Username and Password Authentication. - properties: - password: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret version reference containing the password. - username: - type: string - description: Username. - type: object - id: GoogleCloudConnectorsV1AuthConfigUserPassword - EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails: - type: object - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails - properties: - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution - format: int64 + Any outage is a pageable event. * The guideline is for < 10% of + requests to a service to be in this band. * During a production + outage requests in this band will be prioritized above all others. + * Opt-in to CRITICAL_PLUS when your workflow triggers by human. type: string - nextExecutionTime: - format: int64 description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. - type: string - eventRetriesFromBeginningCount: - type: integer + The request priority this request should be processed at. For + internal users: + quotaRetryCount: description: >- - Indicates the number of times the execution has restarted from the - beginning. + Optional. This is a field to see the quota retry count for + integration execution format: int32 - cancelReason: - type: string + type: integer + workflowName: description: >- - If the execution is manually canceled, this field will contain the - reason for cancellation. - networkAddress: + Optional. If provided, the workflow_name is used to filter all the + matched workflows having same trigger_id+client_id. A combination of + trigger_id, client_id and workflow_name identifies a unique + workflow. type: string + ignoreErrorIfNoActiveWorkflow: description: >- - The network address (aka. bns address) that indicates where the - event executor is running. - logFilePath: + Optional. Flag to determine whether clients would suppress a warning + when no ACTIVE workflows are not found. If this flag is set to be + true, an error will not be thrown if the requested trigger_id or + client_id is not found in any ACTIVE workflow. Otherwise, the error + is always thrown. The flag is set to be false by default. + type: boolean + userGeneratedExecutionId: type: string - description: The log file path (aka. cns address) for this event. - ryeLockUnheldCount: - format: int32 - type: integer description: >- - Used internally and shouldn't be exposed to users. A counter for the - cron job to record how many times this event is in in_process state - but don't have a lock consecutively/ - eventAttemptStats: - type: array + This is a unique id provided by the method caller. If provided this + will be used as the execution_id when a new execution info is + created. This is a string representation of a UUID. Must have no + more than 36 characters and contain only alphanumeric characters and + hyphens. + GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: + properties: + noPermission: + type: boolean + description: Whether the user has no permission on the version or not. + integrationVersions: + description: The integrations which match the request. items: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - eventExecutionState: - enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED - enumDescriptions: - - '' - - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. - - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. - - >- - Event execution canceled by user. There's no more change after - this state. - - Event execution failed and waiting for retry. - - Event execution suspended and waiting for manual intervention. + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + type: array + nextPageToken: type: string - description: The execution state of this event. - eventExecutionSnapshot: + 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. + id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + type: object + description: Response for ListIntegrationVersions. + EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: + type: object + id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + properties: + parameters: items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry type: array - description: >- - After snapshot migration, this field will no longer be populated, - but old execution snapshots will still be accessible. + GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: + properties: + clientId: + type: string + description: The client identifier. + clientSecret: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Secret version reference containing the client secret. + id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + type: object description: >- - Contains the details of the execution info of this event: this includes - the tasks execution details plus the event execution statistics. Next - available id: 12 - EnterpriseCrmEventbusStatsDimensions: - id: EnterpriseCrmEventbusStatsDimensions + Parameters to support Oauth 2.0 Client Credentials Grant Authentication. + See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. + EnterpriseCrmEventbusProtoSerializedObjectParameter: type: object properties: - warningEnumString: - type: string - retryAttempt: - enum: - - UNSPECIFIED - - FINAL - - RETRYABLE - - CANCELED - type: string - enumDescriptions: - - '' - - >- - Task has completed successfully or has depleted all retry - attempts. - - Task has failed but may be retried. - - Task has been deliberately canceled. - clientId: + objectValue: type: string - taskNumber: + format: byte + id: EnterpriseCrmEventbusProtoSerializedObjectParameter + GoogleCloudConnectorsV1HPAConfig: + type: object + properties: + memoryUtilizationThreshold: + readOnly: true type: string - errorEnumString: - type: string - workflowName: + format: int64 + description: >- + Output only. Percent Memory utilization where HPA triggers + autoscaling. + cpuUtilizationThreshold: + description: Output only. Percent CPU utilization where HPA triggers autoscaling. + readOnly: true type: string - taskName: + format: int64 + description: Autoscaling config for connector deployment system metrics. + id: GoogleCloudConnectorsV1HPAConfig + GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: + description: Metadata of runtime connection schema. + properties: + actions: + description: List of actions. + items: + type: string + type: array + entities: + type: array + items: + type: string + description: List of entity names. + type: object + id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: + type: object + properties: + configParameters: + type: object + additionalProperties: + type: any + description: Properties of the object. + description: Optional. Config parameters used during integration execution. + description: Request for PublishIntegrationVersion. + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: + type: object + id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + description: Response for listing RuntimeActionSchemas for a specific Connection. + properties: + nextPageToken: type: string - enumFilterType: + description: Next page token. + runtimeActionSchemas: + description: Runtime action schemas. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema + GoogleCloudConnectorsV1LogConfig: + type: object + id: GoogleCloudConnectorsV1LogConfig + properties: + level: + description: Optional. Log configuration level. enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE - description: Whether to include or exclude the enums matching the regex. + - LOG_LEVEL_UNSPECIFIED + - ERROR + - INFO + - DEBUG type: string enumDescriptions: - - '' - - '' - triggerId: - type: string + - Log level unspecified. + - Only error logs are enabled. + - Info and error logs are enabled. + - Debug and high verbosity logs are enabled. + enabled: description: >- - Stats have been or will be aggregated on set fields for any - semantically-meaningful combination. - workflowId: - type: string - GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: - id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - description: >- - Parameters to support Oauth 2.0 Client Credentials Grant Authentication. - See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. + Enabled represents whether logging is enabled or not for a + connection. + type: boolean + description: Log configuration for the connection. + EnterpriseCrmEventbusProtoValueType: properties: - clientSecret: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret version reference containing the client secret. - clientId: - description: The client identifier. + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' + intValue: + type: string + format: int64 + booleanValue: + type: boolean + protoValue: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' + doubleValue: + format: double + type: number + stringValue: type: string + id: EnterpriseCrmEventbusProtoValueType + description: >- + Used for define type for values. Currently supported value types include + int, string, double, array, and any proto message. type: object - GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: + EnterpriseCrmFrontendsEventbusProtoTriggerConfig: + id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig type: object - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + description: 'Configuration detail of a trigger. Next available id: 20' properties: - triggerUrl: + triggerName: type: string - description: The trigger url that will be returned - description: Response for Creating Cloud Function rpc call. - GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: - type: object - properties: - thresholdValue: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue description: >- - The metric value, above or below which the alert should be - triggered. - aggregationPeriod: + Optional. Name of the trigger This is added to identify the type of + trigger. This is avoid the logic on triggerId to identify the + trigger_type and push the same to monitoring. + triggerId: type: string + description: The backend trigger ID. + enabledClients: + items: + type: string + type: array description: >- - The period over which the metric value should be aggregated and - evaluated. Format is , where integer should be a positive integer - and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, - day, week). For an EXPECTED_MIN threshold, this aggregation_period - must be lesser than 24 hours. - onlyFinalAttempt: - type: boolean + Required. The list of client ids which are enabled to execute the + workflow using this trigger. In other words, these clients have the + workflow execution privledges for this trigger. For API trigger, the + client id in the incoming request is validated against the list of + enabled clients. For non-API triggers, one workflow execution is + triggered on behalf of each enabled client. + startTasks: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. - displayName: + Set of tasks numbers from where the workflow execution is started by + this trigger. If this is empty, then workflow is executed with + default start tasks. In the list of start tasks, none of two tasks + can have direct ancestor-descendant relationships (i.e. in a same + workflow execution graph). + type: array + label: + type: string + description: The user created label for a particular trigger. + position: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' description: >- - Name of the alert. This will be displayed in the alert subject. If - set, this name should be unique within the scope of the integration. + Optional. Informs the front-end application where to draw this + trigger config on the UI. + errorCatcherId: type: string - thresholdType: description: >- - The threshold type, whether lower(expected_min) or - upper(expected_max), for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task + nextTasksExecutionPolicy: + description: Dictates how next tasks will be executed. + enum: + - UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH enumDescriptions: - - Default. - - >- - Note that this field will only trigger alerts if the integration - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. Min value threshold. - - Max value threshold. + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. type: string + triggerType: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - THRESHOLD_TYPE_UNSPECIFIED - - EXPECTED_MIN - - EXPECTED_MAX - alertThreshold: - type: integer + - UNKNOWN + - CLOUD_PUBSUB + - GOOPS + - SFDC_SYNC + - CRON + - API + - MANIFOLD_TRIGGER + - DATALAYER_DATA_CHANGE + - SFDC_CHANNEL + - CLOUD_PUBSUB_EXTERNAL + - SFDC_CDC_CHANNEL + - SFDC_PLATFORM_EVENTS_CHANNEL + - CLOUD_SCHEDULER + - INTEGRATION_CONNECTOR_TRIGGER + - PRIVATE_TRIGGER + alertConfig: + type: array description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - format: int32 - metricType: - enum: - - METRIC_TYPE_UNSPECIFIED - - EVENT_ERROR_RATE - - EVENT_WARNING_RATE - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - EVENT_RATE - - EVENT_AVERAGE_DURATION - - EVENT_PERCENTILE_DURATION - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - enumDescriptions: - - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors for the enclosing - integration. - - >- - Specifies alerting on the rate of warnings for the enclosing - integration. Warnings use the same enum values as errors. - - >- - Specifies alerting on the rate of errors for any task in the - enclosing integration. - - >- - Specifies alerting on the rate of warnings for any task in the - enclosing integration. - - >- - Specifies alerting on the rate of executions over all tasks in the - enclosing integration. - - >- - Specifies alerting on the number of events executed in the given - aggregation_period. - - >- - Specifies alerting on the average duration of executions for this - integration. - - >- - Specifies alerting on the duration value of a particular - percentile of integration executions. E.g. If 10% or more of the - integration executions have durations above 5 seconds, alert. - - >- - Specifies alerting on the average duration of any task in the - enclosing integration, - - >- - Specifies alerting on the duration value of a particular - percentile of any task executions within the enclosing - integration. E.g. If 10% or more of the task executions in the - integration have durations above 5 seconds, alert. + An alert threshold configuration for the [trigger + client + + workflow] tuple. If these values are not specified in the trigger + config, default values will be populated by the system. Note that + there must be exactly one alert threshold configured per [client + + trigger + workflow] when published. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' + triggerNumber: type: string - description: The type of metric. - durationThreshold: + description: >- + Required. A number to uniquely identify each trigger config within + the workflow on UI. + description: type: string - format: google-duration description: >- - Should be specified only for *AVERAGE_DURATION and - *PERCENTILE_DURATION metrics. This member should be used to specify - what duration value the metrics should exceed for the alert to - trigger. - disableAlert: + User-provided description intended to give more business context + about the task. + triggerCriteria: description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this integration alert. + Optional. When set, Eventbus will run the task specified in the + trigger_criteria and validate the result using the + trigger_criteria.condition, and only execute the workflow when + result is true. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria' + pauseWorkflowExecutions: + description: >- + Optional. If set to true, any upcoming requests for this trigger + config will be paused and the executions will be resumed later when + the flag is reset. The workflow to which this trigger config belongs + has to be in ACTIVE status for the executions to be paused or + resumed. type: boolean - description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - EnterpriseCrmEventbusProtoParameterMapField: - id: EnterpriseCrmEventbusProtoParameterMapField + cloudSchedulerConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' + properties: + additionalProperties: + type: string + description: >- + Configurable properties of the trigger, not to be confused with + workflow parameters. E.g. "name" is a property for API triggers and + "subscription" is a property for Cloud Pubsub triggers. + type: object + GoogleCloudConnectorsV1AuthConfigSshPublicKey: + id: GoogleCloudConnectorsV1AuthConfigSshPublicKey + type: object properties: - referenceKey: - description: Referencing one of the WF variables. + username: + description: The user account used to authenticate. type: string - literalValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: Passing a literal value. - description: Field represents either the key or value in an entry. - type: object - GoogleCloudConnectorsV1HPAConfig: - description: Autoscaling config for connector deployment system metrics. - type: object - id: GoogleCloudConnectorsV1HPAConfig + sshClientCertPass: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Password (passphrase) for ssh client certificate if it has one. + certType: + type: string + description: Format of SSH Client cert. + sshClientCert: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: SSH Client Cert. It should contain both public and private key. + description: Parameters to support Ssh public key Authentication. + GoogleCloudConnectorsV1ConnectorVersionInfraConfig: + id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig properties: - cpuUtilizationThreshold: - readOnly: true - format: int64 + sharedDeployment: type: string - description: Output only. Percent CPU utilization where HPA triggers autoscaling. - memoryUtilizationThreshold: + description: Output only. The name of shared connector deployment. + readOnly: true + hpaConfig: + readOnly: true + description: Output only. HPA autoscaling config. + $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' + internalclientRatelimitThreshold: description: >- - Output only. Percent Memory utilization where HPA triggers - autoscaling. + Output only. Max QPS supported for internal requests originating + from Connd. format: int64 - readOnly: true type: string - EnterpriseCrmFrontendsEventbusProtoParameterMap: - properties: - keyType: - description: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. + readOnly: true + deploymentModelMigrationState: enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE + - DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED + - IN_PROGRESS + - COMPLETED + - ROLLEDBACK + - ROLLBACK_IN_PROGRESS + readOnly: true enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' + - Deployment model migration state is not specified. + - Deployment model migration is in progress. + - Deployment model migration is completed. + - Deployment model migration rolledback. + - Deployment model migration rollback in progress. + description: Output only. Status of the deployment model migration. type: string - valueType: + ratelimitThreshold: + type: string + format: int64 + readOnly: true + description: >- + Output only. Max QPS supported by the connector version before + throttling of requests. + resourceRequests: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' + description: Output only. System resource requests. + resourceLimits: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' + description: Output only. System resource limits. + maxInstanceRequestConcurrency: + readOnly: true + type: integer + format: int32 + description: Output only. Max instance request concurrency. + connectionRatelimitWindowSeconds: + type: string + readOnly: true + description: >- + Output only. The window used for ratelimiting runtime requests to + connections. + format: int64 + deploymentModel: enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE + - DEPLOYMENT_MODEL_UNSPECIFIED + - GKE_MST + - CLOUD_RUN_MST + description: Optional. Indicates whether connector is deployed on GKE/CloudRun type: string + enumDescriptions: + - Deployment model is not specified. + - Default model gke mst. + - Cloud run mst. + description: >- + This cofiguration provides infra configs like rate limit threshold which + need to be configurable for every connector version + type: object + EnterpriseCrmEventbusProtoConnectorsConnection: + type: object + id: EnterpriseCrmEventbusProtoConnectorsConnection + properties: + connectionName: + description: >- + Connection name Format: + projects/{project}/locations/{location}/connections/{connection} + type: string + connectorVersion: + type: string + description: >- + Connector version Format: + projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} + serviceName: + type: string + description: >- + Service name Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} + host: + description: >- + The name of the Hostname of the Service Directory service with TLS + if used. + type: string + EnterpriseCrmEventbusProtoStringFunction: + type: object + properties: + functionName: + enum: + - UNSPECIFIED + - CONCAT + - TO_UPPERCASE + - TO_LOWERCASE + - CONTAINS + - SPLIT + - LENGTH + - EQUALS + - TO_INT + - TO_DOUBLE + - TO_BOOLEAN + - TO_BASE_64 + - TO_JSON + - EQUALS_IGNORE_CASE + - REPLACE_ALL + - SUBSTRING + - RESOLVE_TEMPLATE + - DECODE_BASE64_STRING enumDescriptions: - '' - '' @@ -4954,1269 +5288,1319 @@ components: - '' - '' - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - entries: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - type: object - id: EnterpriseCrmFrontendsEventbusProtoParameterMap - GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: - id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse - properties: - authConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' - description: The list of AuthConfigs retrieved. - nextPageToken: + - '' + - '' + - '' + - '' + - '' + - '' type: string - description: The token used to retrieve the next page of results. - type: object - description: Response to list AuthConfigs. - EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: + id: EnterpriseCrmEventbusProtoStringFunction + EnterpriseCrmEventbusProtoLoopMetadata: properties: - parameters: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry - type: array - id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + failureLocation: + enumDescriptions: + - No error or Unknown. + - Subworkflow failed while firing/running. + - Param overrides failed. + - Param aggregation failed. + - Setting for loop current element failed. + - Getting the list to iterate. + - Evaluating the while loop condition. + - Building the iteration request + type: string + description: Indicates where in the loop logic did it error out. + enum: + - UNKNOWN + - SUBWORKFLOW + - PARAM_OVERRIDING + - PARAM_AGGREGATING + - SETTING_ITERATION_ELEMENT + - GETTING_LIST_TO_ITERATE + - CONDITION_EVALUATION + - BUILDING_REQUEST + errorMsg: + description: Add the error message when loops fail. + type: string + currentIterationDetail: + description: >- + Needs to be set by the loop impl class before each iteration. The + abstract loop class will append the request and response to it. Eg. + The foreach Loop will clean up and set it as the current iteration + element at the start of each loop. The post request and response + will be appended to the value once they are available. + type: string + currentIterationCount: + description: Starting from 1, not 0. + format: int64 + type: string + id: EnterpriseCrmEventbusProtoLoopMetadata type: object - GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: + EnterpriseCrmEventbusProtoAttributes: + description: >- + Attributes are additional options that can be associated with each event + property. For more information, see type: object properties: - inputParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Optional. Input parameters used during integration execution. - type: object - testMode: + defaultValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + description: Used to define defaults. + taskVisibility: + type: array + items: + type: string + description: List of tasks that can view this property, if empty then all. + masked: + type: boolean + description: True if this workflow parameter should be masked in the logs + isRequired: type: boolean description: >- - Optional. Can be specified in the event request, otherwise false - (default). If true, enables tasks with condition "test_mode = true". - If false, disables tasks with condition "test_mode = true" if global - test mode (set by platform) is also false {@link EventBusConfig}. - clientId: + Required for event execution. The validation will be done by the + event bus when the event is triggered. + logSettings: + description: See + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' + dataType: + enum: + - DATA_TYPE_UNSPECIFIED + - EMAIL + - URL + - CURRENCY + - TIMESTAMP + - DOMAIN_NAME + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - >- + Domain is a web url string with one top-level private domain and a + suffix (for example: google.com, walmart.com) description: >- - Required. This is used to identify the client on whose behalf the - event will be executed. + Things like URL, Email, Currency, Timestamp (rather than string, + int64...) + isSearchable: + deprecated: true + type: boolean + description: >- + Used to indicate if a ParameterEntry should be converted to + ParamIndexes for ST-Spanner full-text search. DEPRECATED: use + searchable. + searchable: + enumDescriptions: + - '' + - >- + If yes, the parameter key and value will be full-text indexed. In + a proto, this value will propagate to all children whose + searchable is unspecified. + - >- + If no, the parameter key and value will not be full-text indexed. + In a proto, this value will propagate to all children whose + searchable is unspecified. + enum: + - UNSPECIFIED + - 'YES' + - 'NO' type: string + readOnly: + description: Used to indicate if the ParameterEntry is a read only field or not. + type: boolean + id: EnterpriseCrmEventbusProtoAttributes + GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: + properties: integrationVersion: - description: Required. integration config to execute the workflow + description: Version after the lock is acquired by the new user. $ref: >- #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - triggerId: - type: string - description: >- - Required. The trigger id of the integration trigger config. If both - trigger_id and client_id is present, the integration is executed - from the start tasks provided by the matching trigger config - otherwise it is executed from the default start tasks. - configParameters: - additionalProperties: - type: any - description: Properties of the object. - description: Optional. Config parameters used during integration execution. - type: object - deadlineSecondsTime: - type: string - format: google-datetime - description: Optional. custom deadline of the rpc - parameters: - description: Optional. Passed in as parameters to each integration execution. - deprecated: true - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest - description: The request for testing an integration. - GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: type: object - description: The response for executing an integration. - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + description: Response for TakeoverEditLock. + GoogleCloudIntegrationsV1alphaCloudKmsConfig: + type: object + id: GoogleCloudIntegrationsV1alphaCloudKmsConfig + description: Configuration information for Client's Cloud KMS information properties: - executionId: - description: The id of the execution corresponding to this run of integration. - type: string - outputParameters: + keyVersion: description: >- - OUTPUT parameters in format of Map. Where Key is the name of the - parameter. Note: Name of the system generated parameters are wrapped - by backtick(`) to distinguish them from the user defined parameters. - type: object - additionalProperties: - description: Properties of the object. - type: any - parameterEntries: - deprecated: true + Optional. Each version of a key contains key material used for + encryption or signing. A key's version is represented by an integer, + starting at 1. To decrypt data or verify a signature, you must use + the same key version that was used to encrypt or sign the data. + type: string + key: + type: string description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - type: array - executionFailed: - description: Is true if any execution in the integration failed. False otherwise. - deprecated: true - type: boolean - eventParameters: - description: Details for the integration that were executed. - deprecated: true - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - GoogleCloudIntegrationsV1alphaExecutionSnapshot: - id: GoogleCloudIntegrationsV1alphaExecutionSnapshot - properties: - taskExecutionDetails: - description: All of the task execution details at the given point of time. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails - type: array - params: - description: Parameters used during the execution. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - executionSnapshotMetadata: - description: Metadata of the execution snapshot. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - checkpointTaskNumber: + Required. A Cloud KMS key is a named object containing one or more + key versions, along with metadata for the key. A key exists on + exactly one key ring tied to a specific location. + kmsProjectId: + type: string description: >- - Indicates "after which checkpoint task's execution" this snapshot is - taken. + Optional. The gcp project id of the project where the kms key + stored. If empty, the kms key is stored at the same project as + customer's project and ecrypted with CMEK, otherwise, the kms key is + stored in the tenant project and encrypted with GMEK + kmsLocation: + description: Required. Location name of the key ring, e.g. "us-west1". type: string - description: Contains the snapshot of the execution for a given checkpoint. - type: object - GoogleCloudIntegrationsV1alphaShareTemplateRequest: + kmsRing: + description: >- + Required. A key ring organizes keys in a specific Google Cloud + location and allows you to manage access control on groups of keys. + A key ring's name does not need to be unique across a Google Cloud + project, but must be unique within a given location. + type: string + GoogleCloudIntegrationsV1alphaIntParameterArray: + id: GoogleCloudIntegrationsV1alphaIntParameterArray type: object - id: GoogleCloudIntegrationsV1alphaShareTemplateRequest + description: This message only contains a field of integer array. properties: - resourceNames: + intValues: items: type: string + format: int64 + description: Integer array. type: array - description: >- - Optional. Project name resources to share the template. The project - names is expected in resource format Ex: projects/{project-number} - or organization/{org-id} - description: Request to Share template - GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: + GoogleCloudIntegrationsV1alphaClientConfig: + id: GoogleCloudIntegrationsV1alphaClientConfig + description: The configuration information for the Client properties: - location: + isGmek: + description: Optional. Indicates the client is provisioned with CMEK or GMEK. + type: boolean + id: + type: string + description: Globally unique ID (project_id + region) + p4ServiceAccount: + description: The service agent associated with this client + type: string + projectId: + type: string + description: The GCP project id of the client associated with + cloudKmsConfig: + description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + runAsServiceAccount: type: string description: >- - Required. The location where associated cloud scheduler job will be - created - cronTab: - description: Required. The cron tab of cloud scheduler trigger. + Default run-as service account email, set up during project + provision time, that will be used to generate auth token to be used + in Connector task, Rest caller task, Cloud function task and + Subworkflows. + createTime: + description: The timestamp when the client was first created. + format: google-datetime type: string - serviceAccountEmail: + enableInternalIp: description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time + Optional. Indicates the client enables internal IP feature, this is + applicable for internal clients only. + type: boolean + billingType: + enum: + - BILLING_TYPE_UNSPECIFIED + - BILLING_TYPE_APIGEE_TRIALS + - BILLING_TYPE_APIGEE_SUBSCRIPTION + - BILLING_TYPE_PAYG + description: Indicates the billing type of the client + enumDescriptions: + - Unspecified billing type + - A trial org provisioned through Apigee Provisioning Wizard + - Subscription based users of Apigee + - Consumption based users of IP type: string - errorMessage: + clientState: + enum: + - CLIENT_STATE_UNSPECIFIED + - CLIENT_STATE_ACTIVE + - CLIENT_STATE_DISABLED + type: string + description: Indicates the activity state the client + enumDescriptions: + - The client state is unspecified + - The client is active and able to make calls to the IP APIs + - The client is disabled and will soon be deleted + region: + type: string + description: The region the client is linked to. + enableVariableMasking: description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations + Optional. True if variable masking feature should be turned on for + this region + type: boolean + description: + description: Description of what the client is used for type: string - description: Cloud Scheduler Trigger configuration - type: object - id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: - id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest type: object - description: Request for lift Suspension + GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: properties: - suspensionResult: + expireTime: type: string + format: google-datetime + readOnly: true description: >- - User passed in suspension result and will be used to control - workflow execution branching behavior by setting up corresponnding - edge condition with suspension result. For example, if you want to - lift the suspension, you can pass "Approved", or if you want to - reject the suspension and terminate workfloe execution, you can pass - "Rejected" and terminate the workflow execution with configuring the - edge condition. - GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: - description: Response for DownloadJsonPackage. - type: object - id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse - properties: - files: - description: List containing JSON for multiple file with type information. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' - GoogleCloudConnectorsV1NodeConfig: - id: GoogleCloudConnectorsV1NodeConfig - type: object - description: Node configuration for the connection. - properties: - maxNodeCount: - description: Maximum number of nodes in the runtime nodes. - type: integer - format: int32 - minNodeCount: - type: integer - description: Minimum number of nodes in the runtime nodes. - format: int32 - GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: - properties: - entities: - items: - type: string - type: array - description: List of entity names. - actions: - type: array - items: - type: string - description: List of actions. - id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata - description: Metadata of runtime connection schema. - type: object - GoogleCloudIntegrationsV1alphaEventParameter: - properties: - value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + Output only. Time after which the suspension expires, if no action + taken. + liftWhenExpired: + type: boolean description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - key: + Whether the suspension will be REJECTED or LIFTED upon expiration. + REJECTED is the default behavior. + remindTime: description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. + Time after the previous suspension action reminder, if any, is sent + using the selected notification option, for a suspension which is + still PENDING_UNSPECIFIED. + format: google-datetime type: string - masked: - description: True if this parameter should be masked in the logs - type: boolean - id: GoogleCloudIntegrationsV1alphaEventParameter type: object - description: >- - This message is used for processing and persisting (when applicable) key - value pair parameters for each event in the event bus. Next available - id: 4 - GoogleCloudIntegrationsV1alphaParameterMapField: + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + description: Expiration configs for the approval request. + GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: properties: - literalValue: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Passing a literal value. - referenceKey: - type: string - description: Referencing one of the Integration variables. - description: Field represents either the key or value in an entry. - id: GoogleCloudIntegrationsV1alphaParameterMapField - type: object - GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: - type: object - description: Request for UnpublishIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest - properties: {} - GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: - description: >- - Parameters to support Oauth 2.0 Auth Code Grant Authentication. See - https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. - properties: - authUri: - description: Auth URL for Authorization Code Flow + parameters: + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: Passed in as parameters to each integration execution. + inputParameters: + description: Optional. Input parameters used by integration execution. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + userGeneratedExecutionId: type: string - scopes: description: >- - Scopes the connection will request when the user performs the auth - code flow. - type: array - items: - type: string - enablePkce: - type: boolean - description: Whether to enable PKCE when the user performs the auth code flow. - authCode: - type: string - description: Authorization code to be exchanged for access and refresh tokens. - clientId: - description: Client ID for user-provided OAuth app. + Optional. This is a unique id provided by the method caller. If + provided this will be used as the execution_id when a new execution + info is created. This is a string representation of a UUID. Must + have no more than 36 characters and contain only alphanumeric + characters and hyphens. + triggerId: type: string - redirectUri: - description: Redirect URI to be provided during the auth code exchange. + description: >- + Required. Matched against all {@link TriggerConfig}s across all + integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) + parameterEntries: + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: array + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + requestId: type: string - clientSecret: - description: Client secret for user-provided OAuth app. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - pkceVerifier: + description: >- + This is used to de-dup incoming request: if the duplicate request + was detected, the response from the previous execution is returned. + scheduleTime: type: string - description: PKCE verifier to be used during the auth code exchange. - type: object - id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - EnterpriseCrmFrontendsEventbusProtoTaskConfig: - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. + description: >- + The time that the integration should be executed. If the time is + less or equal to the current time, the integration is executed + immediately. + format: google-datetime type: object + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + description: 'The request for scheduling an integration. Next available id: 11' + GoogleCloudIntegrationsV1alphaErrorCatcherConfig: + description: Configuration detail of a error catch task + id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig properties: - taskSpec: + label: type: string description: >- - A string template that allows user to configure task parameters - (with either literal default values or tokens which will be resolved - at execution time) for the task. It will eventually replace the old - "parameters" field. - taskType: - description: Defines the type of the task - enumDescriptions: - - Normal IP task - - Task is of As-Is Template type - - Task is of I/O template type with a different underlying task - enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE + Optional. The user created label for a particular error catcher. + Optional. + errorCatcherNumber: type: string - jsonValidationOption: description: >- - If set, overrides the option configured in the Task implementation - class. - enum: - - UNSPECIFIED_JSON_VALIDATION_OPTION - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION - enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in WorkflowParameters. - - >- - Validate all potential output JSON parameters against schemas - specified in WorkflowParameters. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. - type: string - taskName: - description: The name for the task. - type: string - disableStrictTypeValidation: + Required. A number to uniquely identify each error catcher config + within the workflow on UI. + position: description: >- - If this config contains a TypedTask, allow validation to succeed if - an input is read from the output of another TypedTask whose output - type is declared as a superclass of the requested input type. For - instance, if the previous task declares an output of type Message, - any task with this flag enabled will pass validation when attempting - to read any proto Message type from the resultant Event parameter. - type: boolean - parameters: - additionalProperties: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - type: object - description: The customized parameters the user can pass to this task. - preconditionLabel: + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + description: type: string description: >- - Optional. User-provided label that is attached to precondition in - the UI. - synchronousCallFailurePolicy: - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - rollbackStrategy: + Optional. User-provided description intended to give more business + context about the error catcher config. + startErrorTasks: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' description: >- - Optional. Contains information about what needs to be done upon - failure (either a permanent error or after it has been retried too - many times). - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + Required. The set of start tasks that are to be executed for the + error catch flow errorCatcherId: type: string description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - successPolicy: - description: Determines what action to take upon successful task completion. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' - taskTemplateName: - type: string - description: Used to define task-template name if task is of type task-template - creatorEmail: - description: The creator's email address. Auto-generated from the user's email. - type: string - externalTaskType: + Required. An error catcher id is string representation for the error + catcher config. Within a workflow, error_catcher_id uniquely + identifies an error catcher config among all error catcher configs + for the workflow + type: object + EnterpriseCrmEventbusProtoDoubleArray: + properties: + values: + type: array + items: + format: double + type: number + type: object + id: EnterpriseCrmEventbusProtoDoubleArray + EnterpriseCrmEventbusProtoBaseValue: + id: EnterpriseCrmEventbusProtoBaseValue + type: object + properties: + referenceValue: type: string - enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK - enumDescriptions: - - Default value. External task type is not specified - - Tasks belongs to the normal task flows - - Task belongs to the error catch task flows - failurePolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). - position: + description: Start with a reference value to dereference. + baseFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' description: >- - Optional. Informs the front-end application where to draw this task - config on the UI. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' - conditionalFailurePolicies: + Start with a function that does not build on existing values. Eg. + CurrentTime, Min, Max, Exists, etc. + literalValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: Start with a literal value. + EnterpriseCrmEventbusProtoIntParameterArray: + properties: + intValues: + items: + format: int64 + type: string + type: array + type: object + id: EnterpriseCrmEventbusProtoIntParameterArray + EnterpriseCrmEventbusProtoCustomSuspensionRequest: + properties: + suspensionInfoEventParameterKey: description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoConditionalFailurePolicies - lastModifiedTime: - description: Auto-generated. + In the fired event, set the SuspensionInfo message as the value for + this key. type: string - format: google-datetime - taskNumber: - description: >- - REQUIRED: the identifier of this task within its parent event - config, specified by the client. This should be unique among all the - tasks belong to the same event config. We use this field as the - identifier to find next tasks (via field `next_tasks.task_number`). + postToQueueWithTriggerIdRequest: + description: Request to fire an event containing the SuspensionInfo message. + $ref: >- + #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest + type: object + id: EnterpriseCrmEventbusProtoCustomSuspensionRequest + GoogleCloudIntegrationsV1alphaTemplate: + description: Defines the template for Application Integration + type: object + id: GoogleCloudIntegrationsV1alphaTemplate + properties: + components: + type: array + description: >- + Optional. Components being used in the template. This could be used + to categorize and filter. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTemplateComponent + usageInfo: + description: >- + Optional. Information on how to use the template. This should + contain detailed information about usage of the template. type: string - nextTasksExecutionPolicy: + createTime: + description: Output only. Auto-generated. + format: google-datetime + readOnly: true type: string - enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - description: >- - The policy dictating the execution of the next set of tasks for the - current task. - enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - taskExecutionStrategy: + author: + description: Optional. Creator of the template. type: string - description: The policy dictating the execution strategy of this task. - enum: - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - enumDescriptions: - - >- - Wait until all of its previous tasks finished execution, then - verify at least one of the edge conditions is met, and execute if - possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - - >- - Start execution as long as any of its previous tasks finished - execution and the corresponding edge condition is met (since we - will execute if only that succeeding edge condition is met). - - >- - Wait until all of its previous tasks finished execution, then - verify the all edge conditions are met and execute if possible. - label: - description: User-provided label that is attached to this TaskConfig in the UI. + lastUsedTime: + format: google-datetime + description: Optional. Time the template was last used. type: string - nextTasks: + templateBundle: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplateBundle' description: >- - The set of tasks that are next in line to be executed as per the - execution graph defined for the parent event, specified by - `event_config_id`. Each of these next tasks are executed only if the - condition associated with them evaluates to true. + Required. Bundle which is part of the templates. The template + entities in the bundle would be converted to an actual entity. + sharedWith: type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' - createTime: + type: string + description: >- + Required. Resource names with which the template is shared for + example ProjectNumber/Ord id + description: + description: >- + Optional. Description of the template. The length should not be more + than 255 characters type: string - description: Auto-generated. - format: google-datetime - taskEntity: - description: Copy of the task entity that this task config is an instance of. - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' - alertConfigs: + name: + description: Identifier. Resource name of the template. + type: string + categories: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' - description: >- - Alert configurations on error rate, warning rate, number of runs, - durations, etc. + type: string + enumDescriptions: + - Category is unspecified + - AI_MACHINE_LEARNING + - BUSINESS_INTELLIGENCE + - COLLABORATION + - CUSTOMER_SERVICE + - DATAABASES + - DEVOPS_IT + - CONTENT_AND_FILES + - FINANCE_AND_ACCOUNTING + - HUMAN_RESOURCES + - OPERATIONS + - PRODUCT_PROJECT_MANAGEMENT + - PRODUCTIVITY + - SALES_AND_MARKETING + - UNIVERSAL_CONNECTORS + - UTILITY + - OTHERS + enum: + - CATEGORY_UNSPECIFIED + - AI_MACHINE_LEARNING + - BUSINESS_INTELLIGENCE + - COLLABORATION + - CUSTOMER_SERVICE + - DATABASES + - DEVOPS_IT + - CONTENT_AND_FILES + - FINANCE_AND_ACCOUNTING + - HUMAN_RESOURCES + - OPERATIONS + - PRODUCT_PROJECT_MANAGEMENT + - PRODUCTIVITY + - SALES_AND_MARKETING + - UNIVERSAL_CONNECTORS + - UTILITY + - OTHERS type: array - precondition: description: >- - Optional. Standard filter expression evaluated before execution. - Independent of other conditions and tasks. Can be used to enable - rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to - task. + Required. Categories associated with the Template. The categories + listed below will be utilized for the Template listing. + docLink: type: string - description: + description: Optional. Link to template documentation. + updateTime: + description: Output only. Auto-generated type: string - description: >- - User-provided description intended to give more business context - about the task. - incomingEdgeCount: - type: integer - format: int32 - description: The number of edges leading into this TaskConfig. - id: EnterpriseCrmFrontendsEventbusProtoTaskConfig - EnterpriseCrmFrontendsEventbusProtoStringParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray - type: object - properties: - stringValues: + readOnly: true + format: google-datetime + displayName: + description: Required. The name of the template + type: string + tags: type: array + description: >- + Required. Tags which are used to identify templates. These tags + could be for business use case, connectors etc. items: type: string - EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: - type: object - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - properties: - resolvedByCpi: - type: string - timestamp: - format: google-datetime + visibility: + enum: + - VISIBILITY_UNSPECIFIED + - PRIVATE + - SHARED + - PUBLIC type: string - resolvedBy: + enumDescriptions: + - Visibility is unspecified + - Visibility is private + - Visibility is shared + - Visibility is public + description: Required. Visibility of the template. + usageCount: type: string - GoogleCloudIntegrationsV1alphaListIntegrationsResponse: - type: object - description: Response for ListIntegrations. - id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse + format: int64 + description: Optional. Number of template usages. + GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: properties: - integrations: - type: array - description: The integrations which match the request. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' nextPageToken: + description: The token used to retrieve the next page of results. type: string - description: The next page token for the response. - GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: + sfdcChannels: + description: The list of SfdcChannels retrieved. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + type: array + description: Response to list SfdcChannels. + type: object + id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + EnterpriseCrmFrontendsEventbusProtoParameterEntry: properties: - authParams: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: The auth parameters sent along with the auth code request. - authCode: - type: string - description: The Auth Code that is used to initially retrieve the access token. - tokenParams: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: The token parameters sent along with the token request. - clientId: - description: The client's id. - type: string - scope: - type: string - description: A space-delimited list of requested scope permissions. - clientSecret: - description: The client's secret. - type: string - applyReauthPolicy: + value: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType description: >- - Indicates if the user has opted in Google Reauth Policy. If opted - in, the refresh token will be valid for 20 hours, after which time - users must re-authenticate in order to obtain a new one. + Values for the defined keys. Each value can either be string, int, + double or any proto message. + masked: + description: True if this parameter should be masked in the logs type: boolean - authEndpoint: - type: string - description: The auth url endpoint to send the auth code request to. - accessToken: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - description: The access token received from the token endpoint. - tokenEndpoint: + dataType: type: string - description: The token url endpoint to send the token request to. - requestType: - description: Represent how to pass parameters to fetch access token + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + description: Explicitly getting the type of the parameter. enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + key: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the workflow definition. type: string - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER type: object - id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode - description: >- - The OAuth Type where the client sends request with the client id and - requested scopes to auth endpoint. User sees a consent screen and auth - code is received at specified redirect url afterwards. The auth code is - then combined with the client id and secret and sent to the token - endpoint in exchange for the access and refresh token. The refresh token - can be used to fetch new access tokens. - EnterpriseCrmEventbusProtoSuspensionExpiration: + id: EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: Key-value pair of EventBus parameters. + GoogleCloudConnectorsV1Secret: + id: GoogleCloudConnectorsV1Secret properties: - expireAfterMs: - description: Milliseconds after which the suspension expires, if no action taken. - type: integer - format: int32 - liftWhenExpired: - description: >- - Whether the suspension will be REJECTED or LIFTED upon expiration. - REJECTED is the default behavior. - type: boolean - remindAfterMs: - format: int32 + secretVersion: + type: string description: >- - Milliseconds after which the previous suspension action reminder, if - any, is sent using the selected notification option, for a - suspension which is still PENDING_UNSPECIFIED. - type: integer - id: EnterpriseCrmEventbusProtoSuspensionExpiration + The resource name of the secret version in the format, format as: + `projects/*/secrets/*/versions/*`. type: object - GoogleCloudConnectorsV1ConnectorVersionInfraConfig: + description: Secret provides a reference to entries in Secret Manager. + EnterpriseCrmEventbusProtoAddress: description: >- - This cofiguration provides infra configs like rate limit threshold which - need to be configurable for every connector version + Email address along with optional name and tokens. These tokens will be + substituted for the variables in the form of [{var_name}], where + var_name could be any string of no more than 32 bytes. + id: EnterpriseCrmEventbusProtoAddress properties: - resourceRequests: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' - readOnly: true - description: Output only. System resource requests. - deploymentModelMigrationState: - type: string - readOnly: true - description: Output only. Status of the deployment model migration. - enumDescriptions: - - Deployment model migration state is not specified. - - Deployment model migration is in progress. - - Deployment model migration is completed. - - Deployment model migration rolledback. - - Deployment model migration rollback in progress. - enum: - - DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED - - IN_PROGRESS - - COMPLETED - - ROLLEDBACK - - ROLLBACK_IN_PROGRESS - internalclientRatelimitThreshold: + name: type: string - readOnly: true - description: >- - Output only. Max QPS supported for internal requests originating - from Connd. - format: int64 - ratelimitThreshold: + email: + description: Required. type: string + tokens: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' + type: object + EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: + type: object + properties: + producedBy: description: >- - Output only. Max QPS supported by the connector version before - throttling of requests. - readOnly: true - format: int64 - deploymentModel: + The identifier of the node (TaskConfig/TriggerConfig) this parameter + was produced by, if it is a transient param or a copy of an input + param. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNodeIdentifier' + dataType: type: string enumDescriptions: - - Deployment model is not specified. - - Default model gke mst. - - Cloud run mst. - description: Optional. Indicates whether connector is deployed on GKE/CloudRun + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' enum: - - DEPLOYMENT_MODEL_UNSPECIFIED - - GKE_MST - - CLOUD_RUN_MST - sharedDeployment: - description: Output only. The name of shared connector deployment. - type: string - readOnly: true - maxInstanceRequestConcurrency: - description: Output only. Max instance request concurrency. - type: integer - readOnly: true - format: int32 - hpaConfig: - readOnly: true - description: Output only. HPA autoscaling config. - $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' - connectionRatelimitWindowSeconds: - format: int64 - type: string - readOnly: true + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + description: The data type of the parameter. + isTransient: + type: boolean + description: Whether this parameter is a transient parameter. + key: description: >- - Output only. The window used for ratelimiting runtime requests to - connections. - resourceLimits: - description: Output only. System resource limits. - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' - id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig - type: object - GoogleCloudIntegrationsV1alphaImportTemplateRequest: - id: GoogleCloudIntegrationsV1alphaImportTemplateRequest - properties: - integration: + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the workflow definition. type: string + attributes: + description: Metadata information about the parameters. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' + protoDefName: description: >- - Required. Name of the integration where template needs to be - imported. - integrationRegion: + The name of the protobuf type if the parameter has a protobuf data + type. type: string - description: Required. The region of the Integration to be created. - subIntegrations: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - description: Optional. Sub Integration which would be created via templates. - description: Request to Import template - type: object - EnterpriseCrmFrontendsEventbusProtoParameterMapField: - id: EnterpriseCrmFrontendsEventbusProtoParameterMapField - type: object - description: Field represents either the key or value in an entry. - properties: - literalValue: + inOutType: + type: string + enumDescriptions: + - '' + - >- + Input parameters for the workflow. EventBus validates that these + parameters exist in the workflows before execution. + - >- + Output Parameters for the workflow. EventBus will only return the + workflow parameters tagged with OUT in the response back. + - >- + Input or Output Parameters. These can be used as both input and + output. EventBus will validate for the existence of these + parameters before execution and will also return this parameter + back in the response. + description: Specifies the input/output type for the parameter. + enum: + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT + children: + type: array + description: >- + Child parameters nested within this parameter. This field only + applies to protobuf parameters + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + containsLargeData: + type: boolean + description: >- + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + jsonSchema: + type: string + description: >- + This schema will be used to validate runtime JSON-typed values of + this parameter. + required: + type: boolean + protoDefPath: + type: string + description: >- + If the data type is of type proto or proto array, this field needs + to be populated with the fully qualified proto name. This message, + for example, would be + "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + name: + description: >- + The name (without prefix) to be displayed in the UI for this + parameter. E.g. if the key is "foo.bar.myName", then the name would + be "myName". + type: string + defaultValue: $ref: >- #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - description: Passing a literal value. - referenceKey: + description: >- + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + producer: type: string - description: Referencing one of the WF variables. - GoogleCloudIntegrationsV1alphaCoordinate: - description: Configuration detail of coordinate, it used for UI + description: + type: string + description: Optional. The description about the parameter + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + GoogleCloudIntegrationsV1alphaImportTemplateRequest: properties: - x: - description: Required. X axis of the coordinate - format: int32 - type: integer - 'y': - type: integer - description: Required. Y axis of the coordinate - format: int32 - type: object - id: GoogleCloudIntegrationsV1alphaCoordinate - GoogleCloudIntegrationsV1alphaStringParameterArray: - description: This message only contains a field of string array. + subIntegrations: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + description: Optional. Sub Integration which would be created via templates. + integration: + type: string + description: >- + Required. Name of the integration where template needs to be + imported. + integrationRegion: + description: Required. The region of the Integration to be created. + type: string type: object - id: GoogleCloudIntegrationsV1alphaStringParameterArray - properties: - stringValues: - items: - type: string - description: String array. - type: array - EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: + description: Request to Import template + id: GoogleCloudIntegrationsV1alphaImportTemplateRequest + GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: + description: Request for lift Suspension + id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest properties: - booleanValues: - items: - type: boolean - type: array - id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + suspensionResult: + description: >- + User passed in suspension result and will be used to control + workflow execution branching behavior by setting up corresponnding + edge condition with suspension result. For example, if you want to + lift the suspension, you can pass "Approved", or if you want to + reject the suspension and terminate workfloe execution, you can pass + "Rejected" and terminate the workflow execution with configuring the + edge condition. + type: string type: object - EnterpriseCrmEventbusProtoEventExecutionDetails: + GoogleCloudIntegrationsV1alphaNextTask: description: >- - Contains the details of the execution info of this event: this includes - the tasks execution details plus the event execution statistics. Next - available id: 12 - id: EnterpriseCrmEventbusProtoEventExecutionDetails - type: object + The task that is next in line to be executed, if the condition specified + evaluated to true. properties: - cancelReason: - description: >- - If the execution is manually canceled, this field will contain the - reason for cancellation. + displayName: + type: string + description: User-provided label that is attached to this edge in the UI. + taskId: + description: Task number of the next task. + type: string + condition: type: string - ryeLockUnheldCount: description: >- - Used internally and shouldn't be exposed to users. A counter for the - cron job to record how many times this event is in in_process state - but don't have a lock consecutively/ - type: integer - format: int32 - networkAddress: + Standard filter expression for this task to become an eligible next + task. + taskConfigId: + description: ID of the next task. + type: string + description: description: >- - The network address (aka. bns address) that indicates where the - event executor is running. + User-provided description intended to give additional business + context about the task. + type: string + type: object + id: GoogleCloudIntegrationsV1alphaNextTask + GoogleCloudIntegrationsV1alphaIntegrationVersion: + id: GoogleCloudIntegrationsV1alphaIntegrationVersion + description: The integration version definition. + properties: + name: + readOnly: true + type: string + description: Output only. Auto-generated primary key. + userLabel: type: string - eventRetriesFromBeginningCount: - format: int32 - type: integer description: >- - Indicates the number of times the execution has restarted from the - beginning. - eventExecutionSnapshot: + Optional. A user-defined label that annotates an integration + version. Typically, this is only set when the integration version is + created. + description: + type: string + description: Optional. The integration description. + triggerConfigs: type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot - logFilePath: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' + description: Optional. Trigger configurations. + updateTime: type: string - description: The log file path (aka. cns address) for this event. - eventAttemptStats: - type: array + description: Output only. Auto-generated. + readOnly: true + format: google-datetime + cloudLoggingDetails: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + description: Optional. Cloud Logging details for the integration version + status: + readOnly: true + deprecated: true + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + type: string + enum: + - UNKNOWN + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + description: >- + Output only. Generated by eventbus. User should not set it as an + input. + taskConfigs: items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - nextExecutionTime: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' + type: array description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. + createdFromTemplate: + description: >- + Optional. Optional. The resource name of the template from which the + integration is created. type: string - format: int64 - eventExecutionSnapshotsSize: - format: int64 + createTime: + description: Output only. Auto-generated. type: string - description: Total size of all event_execution_snapshots for an execution - eventExecutionState: + readOnly: true + format: google-datetime + teardown: + description: >- + Optional. Contains a graph of tasks that will be executed before + putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), + regardless of success or failure, similar to "finally" in code. + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' + state: enumDescriptions: - - '' - - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. - - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. - - >- - Event execution canceled by user. There's no more change after - this state. - - Event execution failed and waiting for retry. - - Event execution suspended and waiting for manual intervention. + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + readOnly: true + description: Output only. User should not set it as an input. enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT type: string - EnterpriseCrmEventbusProtoTeardown: - id: EnterpriseCrmEventbusProtoTeardown - type: object - properties: - teardownTaskConfigs: - description: Required. - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' - EnterpriseCrmEventbusProtoTaskUiConfig: - id: EnterpriseCrmEventbusProtoTaskUiConfig - description: >- - Task authors would use this type to configure the UI for a particular - task by specifying what UI config modules should be included to compose - the UI. Learn more about config module framework: - properties: - taskUiModuleConfigs: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' - type: array - description: Configurations of included config modules. - type: object - EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: - id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig - type: object - properties: - connection: - description: User-selected connection. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' - operation: + runAsServiceAccount: + description: >- + Optional. The run-as service account email, if set and auth config + is not configured, that will be used to generate auth token to be + used in Connector task, Rest caller task and Cloud function task. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - description: Operation to perform using the configured connection. - enum: - - OPERATION_UNSPECIFIED - - EXECUTE_ACTION - - LIST_ENTITIES - - GET_ENTITY - - CREATE_ENTITY - - UPDATE_ENTITY - - DELETE_ENTITY - - EXECUTE_QUERY - GoogleCloudIntegrationsV1alphaSfdcInstance: - description: >- - The SfdcInstance resource use to hold channels and connection config - data. - type: object - properties: - authConfigId: + integrationConfigParameters: type: array - description: A list of AuthConfigs that can be tried to open the channel to SFDC items: - type: string - description: - type: string - description: A description of the sfdc instance. - serviceAuthority: - type: string + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationConfigParameter description: >- - URL used for API calls after authentication (the login authority is - configured within the referenced AuthConfig). - displayName: - type: string - description: User selected unique name/alias to easily reference an instance. - sfdcOrgId: + Optional. Config Parameters that are expected to be passed to the + integration when an integration is published. This consists of all + the parameters that are expected to provide configuration in the + integration execution. This gives the user the ability to provide + default values, value, add information like connection url, project + based configuration value and also provide data types of each + parameter. + lastModifierEmail: + description: >- + Optional. The last modifier's email address. Generated based on the + End User Credentials/LOAS role of the user making the call. type: string - description: The SFDC Org Id. This is defined in salesforce. - deleteTime: - format: google-datetime - readOnly: true + lockHolder: type: string description: >- - Output only. Time when the instance was deleted. Empty if not - deleted. - name: + Optional. The edit lock holder's email address. Generated based on + the End User Credentials/LOAS role of the user making the call. + origin: description: >- - Resource name of the SFDC instance - projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. - type: string - createTime: - format: google-datetime - readOnly: true - type: string - description: Output only. Time when the instance is created - updateTime: - readOnly: true - format: google-datetime - description: Output only. Time when the instance was last updated + Optional. The origin that indicates where this integration is coming + from. + enum: + - UNSPECIFIED + - UI + - PIPER_V2 + - PIPER_V3 + - APPLICATION_IP_PROVISIONING + - TEST_CASE + deprecated: true type: string - id: GoogleCloudIntegrationsV1alphaSfdcInstance - EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: - properties: - parameters: + enumDescriptions: + - '' + - Workflow is being created via event bus UI. + - >- + User checked in this workflow in Piper as v2 textproto format and + we synced it into spanner. + - >- + User checked in this workflow in piper as v3 textproto format and + we synced it into spanner. + - Workflow is being created via Standalone IP Provisioning + - Workflow is being created via Test Case. + enumDeprecated: + - false + - false + - true + - false + - false + - false + parentTemplateId: description: >- - Parameters are a part of Event and can be used to communiticate - between different tasks that are part of the same workflow - execution. - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - description: >- - LINT.IfChange This is the frontend version of WorkflowParameters. It's - exactly like the backend version except that instead of flattening - protobuf parameters and treating every field and subfield of a protobuf - parameter as a separate parameter, the fields/subfields of a protobuf - parameter will be nested as "children" (see 'children' field below) - parameters of the parent parameter. Please refer to - enterprise/crm/eventbus/proto/workflow_parameters.proto for more - information about WorkflowParameters. - type: object - GoogleCloudIntegrationsV1alphaTriggerConfig: - id: GoogleCloudIntegrationsV1alphaTriggerConfig - properties: - triggerId: + Optional. The id of the template which was used to create this + integration_version. type: string + databasePersistencePolicy: + enum: + - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED + - DATABASE_PERSISTENCE_DISABLED + - DATABASE_PERSISTENCE_ASYNC description: >- - Optional. Auto-generated trigger ID. The ID is based on the - properties that you define in the trigger config. For example, for - an API trigger, the trigger ID follows the format: - api_trigger/TRIGGER_NAME Where trigger config has properties with - value {"Trigger name": TRIGGER_NAME} - triggerNumber: + Optional. Flag to disable database persistence for execution data, + including event execution info, execution export info, execution + metadata index and execution param index. type: string - description: >- - Required. A number to uniquely identify each trigger config within - the integration on UI. - label: + enumDescriptions: + - Enables persistence for all execution data. + - Disables persistence for all execution data. + - Asynchronously persist all execution data. + snapshotNumber: type: string - description: Optional. The user created label for a particular trigger. - cloudSchedulerConfig: - description: Optional. Cloud Scheduler Trigger related metadata + description: >- + Optional. An increasing sequence that is set when a new snapshot is + created. The last created snapshot can be identified by + [workflow_name, org_id latest(snapshot_number)]. However, last + created snapshot need not be same as the HEAD. So users should + always use "HEAD" tag to identify the head. + format: int64 + integrationParametersInternal: + description: >- + Optional. Parameters that are expected to be passed to the + integration when an event is triggered. This consists of all the + parameters that are expected in the integration execution. This + gives the user the ability to provide default values, add + information like PII and also provide data types of each parameter. + deprecated: true $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - startTasks: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + triggerConfigsInternal: + description: Optional. Trigger configurations. + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig type: array + deprecated: true + integrationParameters: description: >- - Optional. Set of tasks numbers from where the integration execution - is started by this trigger. If this is empty, then integration is - executed with default start tasks. In the list of start tasks, none - of two tasks can have direct ancestor-descendant relationships (i.e. - in a same integration execution graph). - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - triggerType: - enumDescriptions: - - Unknown. - - Trigger by scheduled time. - - Trigger by API call. - - Trigger by Salesforce Channel. - - Trigger by Pub/Sub external. - - SFDC Channel Trigger for CDC. - - Trigger by Cloud Scheduler job. - - Trigger by Connector Event - - Trigger for private workflow - description: Optional. Type of trigger - enum: - - TRIGGER_TYPE_UNSPECIFIED - - CRON - - API - - SFDC_CHANNEL - - CLOUD_PUBSUB_EXTERNAL - - SFDC_CDC_CHANNEL - - CLOUD_SCHEDULER - - INTEGRATION_CONNECTOR_TRIGGER - - PRIVATE_TRIGGER - type: string - trigger: - description: >- - Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub - Sub Trigger" When set will be sent out to monitoring dashabord for - tracking purpose. - type: string - errorCatcherId: - description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task - type: string - properties: - additionalProperties: - type: string - description: >- - Optional. Configurable properties of the trigger, not to be confused - with integration parameters. E.g. "name" is a property for API - triggers and "subscription" is a property for Pub/sub triggers. - type: object - alertConfig: + Optional. Parameters that are expected to be passed to the + integration when an event is triggered. This consists of all the + parameters that are expected in the integration execution. This + gives the user the ability to provide default values, add + information like PII and also provide data types of each parameter. type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + enableVariableMasking: description: >- - Optional. An alert threshold configuration for the [trigger + client - + integration] tuple. If these values are not specified in the - trigger config, default values will be populated by the system. Note - that there must be exactly one alert threshold configured per - [client + trigger + integration] when published. + Optional. True if variable masking feature should be turned on for + this version + type: boolean + errorCatcherConfigs: items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - position: + #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig + type: array description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - description: + Optional. Error Catch Task configuration for the integration. It's + optional. + taskConfigsInternal: + items: + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' description: >- - Optional. User-provided description intended to give additional - business context about the task. + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. + deprecated: true + type: array + type: object + GoogleCloudIntegrationsV1alphaAccessToken: + id: GoogleCloudIntegrationsV1alphaAccessToken + properties: + refreshToken: type: string - nextTasksExecutionPolicy: + description: >- + If the access token will expire, use the refresh token to obtain + another access token. + accessToken: type: string - description: Optional. Dictates how next tasks will be executed. - enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. + description: >- + The access token encapsulating the security identity of a process or + thread. + refreshTokenExpireTime: + type: string + format: google-datetime + description: The approximate time until the refresh token retrieved is valid. + accessTokenExpireTime: + type: string + format: google-datetime + description: >- + Required. The approximate time until the access token retrieved is + valid. + tokenType: + type: string + description: >- + Only support "bearer" token in v1 as bearer token is the predominant + type used with OAuth 2.0. type: object - description: Configuration detail of a trigger. - EnterpriseCrmEventbusProtoDoubleParameterArray: - id: EnterpriseCrmEventbusProtoDoubleParameterArray + description: >- + The access token represents the authorization of a specific application + to access specific parts of a user’s data. + EnterpriseCrmEventbusProtoStringArray: properties: - doubleValues: + values: items: - format: double - type: number + type: string type: array type: object - GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: + id: EnterpriseCrmEventbusProtoStringArray + GoogleCloudIntegrationsV1alphaCoordinate: type: object - id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse - description: Response for the GetClientMetadata rpc - properties: - properties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' - description: 'Required. Required: The client configuration that was requested' - GoogleCloudIntegrationsV1alphaDoubleParameterArray: + description: Configuration detail of coordinate, it used for UI properties: - doubleValues: - type: array - items: - format: double - type: number - description: Double number array. + 'y': + format: int32 + description: Required. Y axis of the coordinate + type: integer + x: + description: Required. X axis of the coordinate + type: integer + format: int32 + id: GoogleCloudIntegrationsV1alphaCoordinate + GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: + id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + description: >- + For client credentials grant, the client sends a POST request with + grant_type as 'client_credentials' to the authorization server. The + authorization server will respond with a JSON object containing the + access token. type: object - id: GoogleCloudIntegrationsV1alphaDoubleParameterArray - description: This message only contains a field of double number array. - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse - description: Response for LinkAppsScriptProject rpc call. properties: - scriptId: + clientId: + description: The client's ID. type: string - description: The id of the linked Apps Script project. - type: object - GoogleCloudIntegrationsV1alphaProvisionClientRequest: - type: object - id: GoogleCloudIntegrationsV1alphaProvisionClientRequest - description: Request for the Provision rpc - properties: - provisionGmek: - deprecated: true - type: boolean - description: >- - Optional. Deprecated. Indicates provision with GMEK or CMEK. This - field is deprecated and the provision would always be GMEK if - cloud_kms_config is not present in the request. - skipCpProvision: - type: boolean - description: Optional. Indicates if skip CP provision or not - runAsServiceAccount: - description: >- - Optional. User input run-as service account, if empty, will bring up - a new default service account + clientSecret: + description: The client's secret. type: string - createSampleWorkflows: - description: >- - Optional. Indicates if sample workflow should be created along with - provisioning - type: boolean - cloudKmsConfig: - description: >- - Optional. OPTIONAL: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - GoogleCloudIntegrationsV1alphaServiceAccountCredentials: - id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials - description: >- - Represents the service account which can be used to generate access - token for authenticating the service call. - type: object - properties: - serviceAccount: - description: >- - Name of the service account that has the permission to make the - request. + requestType: + enumDescriptions: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + description: Represent how to pass parameters to fetch access token type: string - scope: + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + tokenEndpoint: type: string + description: >- + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. + accessToken: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + description: Access token fetched from the authorization server. + tokenParams: + description: Token parameters for the auth request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + scope: description: A space-delimited list of requested scope permissions. - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: - type: object + type: string + EnterpriseCrmEventbusProtoEventExecutionDetails: properties: - createTime: - description: Auto-generated. + nextExecutionTime: format: int64 type: string - workflowName: + description: >- + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. + eventAttemptStats: + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + type: array + cancelReason: type: string - description: Name of the workflow. - integrationVersionUserLabel: - type: string - description: User-defined label that annotates the executed integration version. - errorCode: - description: Final error-code if event failed. - $ref: '#/components/schemas/CrmlogErrorCode' - requestParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Event parameters come in as part of the request. - lastModifiedTime: - format: int64 + description: >- + If the execution is manually canceled, this field will contain the + reason for cancellation. + eventExecutionSnapshot: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot + logFilePath: type: string - description: Auto-generated. - workflowId: - description: Required. Pointer to the workflow it is executing. + description: The log file path (aka. cns address) for this event. + networkAddress: type: string - workflowRetryBackoffIntervalSeconds: - format: int64 + description: >- + The network address (aka. bns address) that indicates where the + event executor is running. + eventExecutionState: type: string + enumDescriptions: + - '' + - >- + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. + - >- + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. + - >- + Event execution canceled by user. There's no more change after + this state. + - Event execution failed and waiting for retry. + - Event execution suspended and waiting for manual intervention. + enum: + - UNSPECIFIED + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED + ryeLockUnheldCount: + format: int32 description: >- - Time interval in seconds to schedule retry of workflow in manifold - when workflow is already running - snapshotNumber: - description: Workflow snapshot number. + Used internally and shouldn't be exposed to users. A counter for the + cron job to record how many times this event is in in_process state + but don't have a lock consecutively/ + type: integer + eventExecutionSnapshotsSize: + description: Total size of all event_execution_snapshots for an execution type: string format: int64 - responseParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Event parameters come out as part of the response. - tenant: + eventRetriesFromBeginningCount: + type: integer + format: int32 description: >- - Tenant this event is created. Used to reschedule the event to - correct tenant. + Indicates the number of times the execution has restarted from the + beginning. + description: >- + Contains the details of the execution info of this event: this includes + the tasks execution details plus the event execution statistics. Next + available id: 12 + type: object + id: EnterpriseCrmEventbusProtoEventExecutionDetails + EnterpriseCrmEventbusProtoExternalTraffic: + properties: + location: type: string - requestId: - description: Optional. This is used to de-dup incoming request. + description: Location for the user's request. + source: type: string - product: enum: - - UNSPECIFIED_PRODUCT - - IP + - SOURCE_UNSPECIFIED - APIGEE - SECURITY - description: >- - Which Google product the execution_info belongs to. If not set, the - execution_info belongs to Integration Platform by default. enumDescriptions: - '' - '' - '' - - '' - type: string - cloudLoggingDetails: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' - description: Cloud Logging details for execution info - clientId: + gcpProjectId: type: string - description: The event data user sends as request. - triggerId: + description: User’s GCP project id the traffic is referring to. + gcpProjectNumber: type: string + description: User’s GCP project number the traffic is referring to. + retryRequestForQuota: + description: Enqueue the execution request due to quota issue + type: boolean + enableInternalIp: description: >- - The trigger id of the workflow trigger config. If both trigger_id - and client_id is present, the workflow is executed from the start - tasks provided by the matching trigger config otherwise it is - executed from the default start tasks. - executionTraceInfo: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' - description: Execution trace info to aggregate parent-child executions. - errors: + Indicates the client enables internal IP feature, this is applicable + for internal clients only. + type: boolean + type: object + id: EnterpriseCrmEventbusProtoExternalTraffic + description: Represents external traffic type and id. + GoogleCloudIntegrationsV1alphaGenerateTokenResponse: + description: Returns success or error message + id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse + properties: + message: + type: string + description: The message that notifies the user if the request succeeded or not. + type: object + EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + type: object + properties: + protoValues: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any type: array + GoogleCloudConnectorsV1Destination: + properties: + serviceAttachment: + deprecated: true + type: string description: >- - Errors, warnings, and informationals associated with the - workflow/task. The order in which the errors were added by the - workflow/task is maintained. - replayInfo: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo - description: Replay info for the execution - eventExecutionInfoId: + PSC service attachments. Format: + projects/*/regions/*/serviceAttachments/* + port: + format: int32 + type: integer + description: >- + The port is the target port number that is accepted by the + destination. + host: + type: string + description: For publicly routable host. + id: GoogleCloudConnectorsV1Destination + type: object + EnterpriseCrmEventbusProtoDoubleArrayFunction: + id: EnterpriseCrmEventbusProtoDoubleArrayFunction + properties: + functionName: type: string - description: Auto-generated primary key. - eventExecutionDetails: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails - description: The execution info about this event. - postMethod: - description: The ways user posts this event. enumDescriptions: - '' - '' @@ -6224,935 +6608,848 @@ components: - '' - '' - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE - - POST_BY_EVENT_CONFIG_ID - - POST_WITH_EVENT_DETAILS - type: string - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - description: >- - Contains all the execution details for a workflow instance. Next - available id: 27 - GoogleCloudIntegrationsV1alphaUploadTemplateRequest: + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + type: object + GoogleCloudIntegrationsV1alphaListIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse + description: Response for ListIntegrations. properties: - fileFormat: - type: string - enumDescriptions: - - Unspecified file format - - JSON File Format - - YAML File Format - description: Required. File format for upload request. - enum: - - FILE_FORMAT_UNSPECIFIED - - JSON - - YAML - content: + nextPageToken: type: string - description: Required. The textproto of the template. - id: GoogleCloudIntegrationsV1alphaUploadTemplateRequest - description: Request for UploadTemplate. + description: The next page token for the response. + integrations: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' + type: array + description: The integrations which match the request. type: object - EnterpriseCrmEventbusProtoNodeIdentifier: + EnterpriseCrmEventbusProtoSuspensionConfig: properties: - elementType: - enum: - - UNKNOWN_TYPE - - TASK_CONFIG - - TRIGGER_CONFIG - enumDescriptions: - - '' - - '' - - '' - type: string - description: Destination node where the edge ends. It can only be a task config. - elementIdentifier: + suspensionExpiration: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' + description: >- + Indicates the next steps when no external actions happen on the + suspension. + customMessage: + description: >- + Optional information to provide recipients of the suspension in + addition to the resolution URL, typically containing relevant + parameter values from the originating workflow. type: string - description: Configuration of the edge. - id: EnterpriseCrmEventbusProtoNodeIdentifier - description: 'Represents a node identifier (type + id). Next highest id: 3' - type: object - EnterpriseCrmEventbusProtoStringParameterArray: - properties: - stringValues: - items: - type: string + notifications: type: array - type: object - id: EnterpriseCrmEventbusProtoStringParameterArray - EnterpriseCrmFrontendsEventbusProtoIntParameterArray: - type: object - properties: - intValues: items: - type: string - format: int64 + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' + whoMayResolve: + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions type: array - id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + description: Identities able to resolve this suspension. + id: EnterpriseCrmEventbusProtoSuspensionConfig + type: object + EnterpriseCrmEventbusProtoExecutionTraceInfo: description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship + Message that helps aggregate all sub-executions triggered by one + execution and keeps track of child-parent relationships. type: object properties: - originalExecutionInfoId: - type: string - description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - replayedExecutionInfoIds: - items: - type: string + parentEventExecutionInfoId: description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. - type: array - replayReason: - type: string - description: reason for replay - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo - GoogleCloudIntegrationsV1alphaExecutionDetails: - properties: - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution - format: int64 + Parent event execution info id that triggers the current execution + through SubWorkflowExecutorTask. type: string - state: + traceId: type: string - enum: - - STATE_UNSPECIFIED - - PENDING - - PROCESSING - - SUCCEEDED - - FAILED - - CANCELLED - - RETRY_ON_HOLD - - SUSPENDED - description: Status of the execution. + description: Used to aggregate ExecutionTraceInfo. + id: EnterpriseCrmEventbusProtoExecutionTraceInfo + EnterpriseCrmEventbusProtoTaskUiModuleConfig: + id: EnterpriseCrmEventbusProtoTaskUiModuleConfig + properties: + moduleId: enumDescriptions: - - Default. - - Execution is scheduled and awaiting to be triggered. - - Execution is processing. + - Default + - Supports editing label of a task config. + - Supports editing error handling settings such as retry strategy. - >- - Execution successfully finished. There's no more change after this - state. - - Execution failed. There's no more change after this state. + Supports adding, removing and editing task parameter values in a + table with little assistance or restriction. - >- - Execution canceled by user. There's no more change after this - state. - - Execution failed and waiting for retry. - - Execution suspended and waiting for manual intervention. - attemptStats: - type: array - description: List of Start and end time of the execution attempts. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - executionSnapshots: - description: List of snapshots taken during the execution. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot - type: array - id: GoogleCloudIntegrationsV1alphaExecutionDetails - description: >- - Contains the details of the execution info: this includes the tasks - execution details plus the event execution statistics. - type: object - GoogleCloudIntegrationsV1alphaUnshareTemplateRequest: + Supports editing values of declared input parameters of a task. + Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE. + - Supports editing preconditions of a task config. + - >- + Supports adding, editing, and deleting the scripts associated with + a script task, as well as modifying the input/output parameters. + - >- + Supports editing task parameters associated with an RPC/stubby + task. + - >- + Contains readonly task information, including input/output type + info. + - Configures a SuspensionTask. + - Configures a GenericStubbyTypedTask. + - Configures a SubWorkflowExecutorTask. + - Supports navigating to Apps Script editor + - Configures a SubWorkflowForEachLoopTask. + - Configures a FieldMappingTask. + - Contains embedded in-product documentation for a task. + - UI widget for the rest caller task. + - Configures a SubWorkflowScatterGatherTask. + - Configures a CloudSql Task. + - Configure a GenericConnectorTask. + type: string + description: ID of the config module. + enum: + - UNSPECIFIED_TASK_MODULE + - LABEL + - ERROR_HANDLING + - TASK_PARAM_TABLE + - TASK_PARAM_FORM + - PRECONDITION + - SCRIPT_EDITOR + - RPC + - TASK_SUMMARY + - SUSPENSION + - RPC_TYPED + - SUB_WORKFLOW + - APPS_SCRIPT_NAVIGATOR + - SUB_WORKFLOW_FOR_EACH_LOOP + - FIELD_MAPPING + - README + - REST_CALLER + - SUB_WORKFLOW_SCATTER_GATHER + - CLOUD_SQL + - GENERIC_CONNECTOR_TASK + description: Task author would use this type to configure a config module. type: object - properties: - resourceNames: - type: array - description: >- - Optional. Project name resources to unshare the template. The - project names is expected in resource format Ex: - projects/{project-number} - items: - type: string - id: GoogleCloudIntegrationsV1alphaUnshareTemplateRequest - description: Request to Unshare template - EnterpriseCrmEventbusProtoPropertyEntry: - id: EnterpriseCrmEventbusProtoPropertyEntry - description: Key-value pair of EventBus property. + EnterpriseCrmEventbusProtoErrorDetail: + id: EnterpriseCrmEventbusProtoErrorDetail type: object properties: - key: + errorMessage: description: >- - Key is used to retrieve the corresponding property value. This - should be unique for a given fired event. The Tasks should be aware - of the keys used while firing the events for them to be able to - retrieve the values. + The full text of the error message, including any parameters that + were thrown along with the exception. type: string - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + errorCode: + description: The associated error-code, which can be a common or internal code. + $ref: '#/components/schemas/CrmlogErrorCode' + taskNumber: + type: integer + format: int32 description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - GoogleCloudConnectorsV1BillingConfig: - description: Billing config for the connection. - type: object - id: GoogleCloudConnectorsV1BillingConfig - properties: - billingCategory: - readOnly: true - enum: - - BILLING_CATEGORY_UNSPECIFIED - - GCP_AND_TECHNICAL_CONNECTOR - - NON_GCP_CONNECTOR - description: Output only. Billing category for the connector. - enumDescriptions: - - Billing category is not specified. - - GCP/Technical connector. - - Non-GCP connector. - type: string - EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: - type: object - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - properties: - dataType: + The task try-number, in which, the error occurred. If zero, the + error happened at the event level. + severity: type: string + description: 'The severity of the error: ERROR|WARN|INFO.' + enum: + - SEVERITY_UNSPECIFIED + - ERROR + - WARN + - INFO enumDescriptions: - '' - '' - '' - '' + description: An error, warning, or information message associated with a workflow. + EnterpriseCrmEventbusProtoSuspensionResolutionInfo: + type: object + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo + properties: + product: + type: string + enum: + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY + description: >- + Which Google product the suspension belongs to. If not set, the + suspension belongs to Integration Platform by default. + enumDescriptions: - '' - '' - '' - '' + eventExecutionInfoId: + type: string + description: Required. ID of the associated execution. + wrappedDek: + format: byte + type: string + description: Wrapped dek + status: + type: string + enumDescriptions: - '' - '' - '' - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - description: The data type of the parameter. enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - description: - description: Optional. The description about the parameter - type: string - name: - description: >- - The name (without prefix) to be displayed in the UI for this - parameter. E.g. if the key is "foo.bar.myName", then the name would - be "myName". + - PENDING_UNSPECIFIED + - REJECTED + - LIFTED + - CANCELED + suspensionId: + description: Primary key for the SuspensionResolutionInfoTable. type: string - protoDefName: - description: >- - The name of the protobuf type if the parameter has a protobuf data - type. + externalTraffic: + description: The origin of the suspension for periodic notifications. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' + cloudKmsConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' + description: KMS info, used by cmek/gmek integration + clientId: type: string - producer: + description: The event data user sends as request. + workflowName: type: string - children: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - description: >- - Child parameters nested within this parameter. This field only - applies to protobuf parameters - type: array - key: + description: Required. The name of the originating workflow. + lastModifiedTimestamp: + format: google-datetime + description: Auto-generated. type: string - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the workflow definition. - containsLargeData: - description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - type: boolean - inOutType: - enumDescriptions: - - '' - - >- - Input parameters for the workflow. EventBus validates that these - parameters exist in the workflows before execution. - - >- - Output Parameters for the workflow. EventBus will only return the - workflow parameters tagged with OUT in the response back. - - >- - Input or Output Parameters. These can be used as both input and - output. EventBus will validate for the existence of these - parameters before execution and will also return this parameter - back in the response. - description: Specifies the input/output type for the parameter. - enum: - - IN_OUT_TYPE_UNSPECIFIED - - IN - - OUT - - IN_OUT + createdTimestamp: + format: google-datetime + description: Auto-generated. type: string - producedBy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNodeIdentifier' - description: >- - The identifier of the node (TaskConfig/TriggerConfig) this parameter - was produced by, if it is a transient param or a copy of an input - param. - defaultValue: - description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. + suspensionConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' + audit: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - jsonSchema: + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + encryptedSuspensionResolutionInfo: type: string - description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - isTransient: - description: Whether this parameter is a transient parameter. - type: boolean - attributes: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' - description: Metadata information about the parameters. - required: - type: boolean - protoDefPath: + format: byte + description: Encrypted SuspensionResolutionInfo + taskNumber: + description: Required. Task number of the associated SuspensionTask. type: string - description: >- - If the data type is of type proto or proto array, this field needs - to be populated with the fully qualified proto name. This message, - for example, would be - "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". - GoogleCloudConnectorsV1AuthConfigSshPublicKey: - id: GoogleCloudConnectorsV1AuthConfigSshPublicKey + GoogleCloudConnectorsV1ResourceRequests: + id: GoogleCloudConnectorsV1ResourceRequests + description: Resource requests defined for connection pods of a given connector type. properties: - sshClientCertPass: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Password (passphrase) for ssh client certificate if it has one. - sshClientCert: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: SSH Client Cert. It should contain both public and private key. - username: - description: The user account used to authenticate. + cpu: type: string - certType: + readOnly: true + description: Output only. CPU request. + memory: + description: Output only. Memory request. type: string - description: Format of SSH Client cert. + readOnly: true type: object - description: Parameters to support Ssh public key Authentication. - GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse - description: Response for TakeoverEditLock. + EnterpriseCrmEventbusProtoTaskUiConfig: + id: EnterpriseCrmEventbusProtoTaskUiConfig + description: >- + Task authors would use this type to configure the UI for a particular + task by specifying what UI config modules should be included to compose + the UI. Learn more about config module framework: type: object properties: - integrationVersion: - description: Version after the lock is acquired by the new user. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - EnterpriseCrmEventbusProtoTaskMetadata: - properties: - admins: + taskUiModuleConfigs: + description: Configurations of included config modules. items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' type: array - docMarkdown: - description: Snippet of markdown documentation to embed in the RHP for this task. - type: string - name: - description: >- - The actual class name or the annotated name of the task. Task Author - should initialize this field with value from the getName() method of - the Task class. - type: string - externalDocMarkdown: - type: string - description: 'DEPRECATED: Use external_doc_html.' - status: - enumDescriptions: - - >- - Default value. Actual Task Status should always be set to either - INACTIVE or ACTIVE. If none is specified at runtime, it will be - set to INACTIVE. - - Still in-progress or incomplete, and not intended for use. - - Available for use. - enum: - - UNSPECIFIED_STATUS - - DEFAULT_INACTIVE - - ACTIVE - type: string + GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: + id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + type: object + properties: + cloudKmsConfig: description: >- - Allows author to indicate if the task is ready to use or not. If not - set, then it will default to INACTIVE. - descriptiveName: + Required. REQUIRED: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + description: Request for the SwitchEncryption rpc + EnterpriseCrmEventbusProtoScatterResponse: + properties: + errorMsg: type: string + description: The error message of the failure if applicable. + executionIds: + type: array + items: + type: string + description: The execution ids of each Subworkflow fired by this scatter. + isSuccessful: + type: boolean description: >- - The string name to show on the task list on the Workflow editor - screen. This should be a very short, one to two words name for the - task. (e.g. "Send Mail") - defaultJsonValidationOption: + If execution is sync, this is true if the execution passed and false + if it failed. If the execution is async, this is true if the WF was + fired off successfully, and false if it failed to execute. The + success or failure of the subworkflows executed are not captured. + responseParams: + type: array description: >- - Controls whether JSON workflow parameters are validated against - provided schemas before and/or after this task's execution. - enum: - - UNSPECIFIED_JSON_VALIDATION_OPTION - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION - type: string - enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in WorkflowParameters. - - >- - Validate all potential output JSON parameters against schemas - specified in WorkflowParameters. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. - externalDocHtml: - description: External-facing documention embedded in the RHP for this task. + A list of all the response parameters in the aggregtorMap stored + with the remapped key. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + scatterElement: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: The element that was scattered for this execution. + type: object + id: EnterpriseCrmEventbusProtoScatterResponse + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + type: object + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + properties: + replayReason: type: string - externalCategorySequence: - type: integer - format: int32 - description: >- - Sequence with which the task in specific category to be displayed in - task discovery panel for external users. - tags: - type: array + description: reason for replay + replayedExecutionInfoIds: items: type: string description: >- - A set of tags that pertain to a particular task. This can be used to - improve the searchability of tasks with several names ("REST Caller" - vs. "Call REST Endpoint") or to help users find tasks based on - related words. - category: - enum: - - UNSPECIFIED_CATEGORY - - CUSTOM - - FLOW_CONTROL - - DATA_MANIPULATION - - SCRIPTING - - CONNECTOR - - HIDDEN - - CLOUD_SYSTEMS - - CUSTOM_TASK_TEMPLATE - - TASK_RECOMMENDATIONS - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - Internal IP tasks that should not be available in the UI. - - Tasks that are relevant to cloud systems teams and typically - - Task entities that derive from a custom task template. - - Category to show task recommendations - type: string - externalCategory: - enum: - - UNSPECIFIED_EXTERNAL_CATEGORY - - CORE - - CONNECTORS - - EXTERNAL_HTTP - - EXTERNAL_INTEGRATION_SERVICES - - EXTERNAL_CUSTOMER_ACTIONS - - EXTERNAL_FLOW_CONTROL - - EXTERNAL_WORKSPACE - - EXTERNAL_SECURITY - - EXTERNAL_DATABASES - - EXTERNAL_ANALYTICS - - EXTERNAL_BYOC - - EXTERNAL_BYOT - - EXTERNAL_ARTIFICIAL_INTELIGENCE - - EXTERNAL_DATA_MANIPULATION - type: string - enumDescriptions: - - '' - - '' - - '' - - HTTP tasks, e.g. rest api call task - - Integration services, e.g. connector task - - Customer ations, e.g. email task - - Flow control, e.g. while loop task - - Workspace tasks, e.g. list drive task - - Security, e.g. kms related tasks - - Database operation tasks, e.g. read firestore info tasks - - Analytics tasks, e.g. dataflow creattion tasks - - BYOC tasks - - BYOT tasks - - AI related tasks. - - Data manipulation related tasks, e.g. data mapping task - isDeprecated: - type: boolean - description: The deprecation status of the current task. Default value is false; - g3DocLink: - description: URL to the associated G3 Doc for the task if available - type: string - codeSearchLink: - type: string - description: The Code Search link to the Task Java file. - externalDocLink: - type: string - description: Doc link for external-facing documentation (separate from g3doc). - defaultSpec: - type: string - description: >- - Contains the initial configuration of the task with default values - set. For now, The string should be compatible to an ASCII-proto - format. - description: - type: string - description: In a few sentences, describe the purpose and usage of the task. - system: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED_SYSTEM - - GENERIC - - BUGANIZER - - SALESFORCE - - CLOUD_SQL - - PLX - - SHEETS - - GOOGLE_GROUPS - - EMAIL - - SPANNER - - DATA_BRIDGE - activeTaskName: - type: string - description: >- - The new task name to replace the current task if it is deprecated. - Otherwise, it is the same as the current task name. - iconLink: - description: >- - URL to gstatic image icon for this task. This icon shows up on the - task list panel along with the task name in the Workflow Editor - screen. Use the 24p, 2x, gray color icon image format. + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. + type: array + originalExecutionInfoId: type: string - standaloneExternalDocHtml: description: >- - External-facing documention for standalone IP in pantheon embedded - in the RHP for this task. Non null only if different from - external_doc_html - type: string - id: EnterpriseCrmEventbusProtoTaskMetadata + If this execution is a replay of another execution, then this field + contains the original execution id. description: >- - TaskMetadata are attributes that are associated to every common Task we - have. - type: object - EnterpriseCrmEventbusProtoCondition: + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship + GoogleCloudIntegrationsV1alphaServiceAccountCredentials: properties: - value: - description: Value that's checked for the key. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - eventPropertyKey: + serviceAccount: description: >- - Key that's evaluated against the `value`. Please note the data type - of the runtime value associated with the key should match the data - type of `value`, else an IllegalArgumentException is thrown. + Name of the service account that has the permission to make the + request. type: string - operator: - enum: - - UNSET - - EQUALS - - CONTAINS - - LESS_THAN - - GREATER_THAN - - EXISTS - - DOES_NOT_EXIST - - IS_EMPTY - - IS_NOT_EMPTY - description: >- - Operator used to evaluate the condition. Please note that an - operator with an inappropriate key/value operand will result in - IllegalArgumentException, e.g. CONTAINS with boolean key/value pair. + scope: type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - id: EnterpriseCrmEventbusProtoCondition - deprecated: true + description: A space-delimited list of requested scope permissions. type: object - description: Condition that uses `operator` to evaluate the key against the value. - EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + description: >- + Represents the service account which can be used to generate access + token for authenticating the service call. + id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials + EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + properties: + doubleValues: + items: + format: double + type: number + type: array + type: object + EnterpriseCrmEventbusProtoStringParameterArray: + id: EnterpriseCrmEventbusProtoStringParameterArray type: object properties: - gaiaId: - format: int64 - type: string - emailAddress: - type: string - EnterpriseCrmEventbusProtoField: + stringValues: + items: + type: string + type: array + GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: type: object - description: Information about the value and type of the field. - id: EnterpriseCrmEventbusProtoField + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig properties: - protoDefPath: + alertThreshold: description: >- - Optional. The fully qualified proto name (e.g. - enterprise.crm.storage.Account). Required for output field of type - PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES - and output field_type is PROTO_VALUE, then fully qualified proto - type url should be provided to parse the input bytes. If field_type - is *_ARRAY, then all the converted protos are of the same type. - type: string - referenceKey: + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + type: integer + format: int32 + metricType: + enumDescriptions: + - >- + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. + - >- + Specifies alerting on the rate of errors for the enclosing + integration. + - >- + Specifies alerting on the rate of warnings for the enclosing + integration. Warnings use the same enum values as errors. + - >- + Specifies alerting on the rate of errors for any task in the + enclosing integration. + - >- + Specifies alerting on the rate of warnings for any task in the + enclosing integration. + - >- + Specifies alerting on the rate of executions over all tasks in the + enclosing integration. + - >- + Specifies alerting on the number of events executed in the given + aggregation_period. + - >- + Specifies alerting on the average duration of executions for this + integration. + - >- + Specifies alerting on the duration value of a particular + percentile of integration executions. E.g. If 10% or more of the + integration executions have durations above 5 seconds, alert. + - >- + Specifies alerting on the average duration of any task in the + enclosing integration, + - >- + Specifies alerting on the duration value of a particular + percentile of any task executions within the enclosing + integration. E.g. If 10% or more of the task executions in the + integration have durations above 5 seconds, alert. + description: The type of metric. + enum: + - METRIC_TYPE_UNSPECIFIED + - EVENT_ERROR_RATE + - EVENT_WARNING_RATE + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - EVENT_RATE + - EVENT_AVERAGE_DURATION + - EVENT_PERCENTILE_DURATION + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION type: string + displayName: description: >- - This holds the reference key of the workflow or task parameter. 1. - Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input - or output parameter, for e.g. $task1_param1$. 3. Any workflow or - task parameters with subfield references, for e.g., - $task1_param1.employee.id$ - defaultValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + Name of the alert. This will be displayed in the alert subject. If + set, this name should be unique within the scope of the integration. + type: string + aggregationPeriod: description: >- - This holds the default values for the fields. This value is supplied - by user so may or may not contain PII or SPII data. - cardinality: + The period over which the metric value should be aggregated and + evaluated. Format is , where integer should be a positive integer + and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, + day, week). For an EXPECTED_MIN threshold, this aggregation_period + must be lesser than 24 hours. type: string - enum: - - UNSPECIFIED - - OPTIONAL + thresholdValue: description: >- - By default, if the cardinality is unspecified the field is - considered required while mapping. - enumDescriptions: - - For fields with unspecified cardinality. - - >- - If field cardinality is set to optional, ignore errors if input - field value is null or the reference_key is not found. - fieldType: + The metric value, above or below which the alert should be + triggered. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue + thresholdType: + enum: + - THRESHOLD_TYPE_UNSPECIFIED + - EXPECTED_MIN + - EXPECTED_MAX enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - Default. - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' + Note that this field will only trigger alerts if the integration + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. Min value threshold. + - Max value threshold. + description: >- + The threshold type, whether lower(expected_min) or + upper(expected_max), for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. type: string - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - description: Specifies the data type of the field. - transformExpression: + disableAlert: + type: boolean description: >- - This is the transform expression to fetch the input field value. for - e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can - have a transform expression. 2. If a transform expression is - provided, reference_key will be ignored. 3. If no value is returned - after evaluation of transform expression, default_value can be - mapped if provided. 4. The field_type should be the type of the - final object returned after the transform expression is evaluated. - Scrubs the transform expression before logging as value provided by - user so may or may not contain PII or SPII data. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - EnterpriseCrmEventbusProtoCombinedCondition: - description: >- - This message recursively combines constituent conditions using logical - AND. - id: EnterpriseCrmEventbusProtoCombinedCondition - deprecated: true - properties: - conditions: - description: A set of individual constituent conditions. - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' - type: object - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: - description: >- - Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 - Authorization Grant based authentication. See - https://tools.ietf.org/html/rfc7523 for more details. - properties: - clientKey: + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this integration alert. + durationThreshold: + format: google-duration description: >- - Secret version reference containing a PKCS#8 PEM-encoded private key - associated with the Client Certificate. This private key will be - used to sign JWTs used for the jwt-bearer authorization grant. - Specified in the form as: `projects/*/secrets/*/versions/*`. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - jwtClaims: - description: JwtClaims providers fields to generate the token. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + Should be specified only for *AVERAGE_DURATION and + *PERCENTILE_DURATION metrics. This member should be used to specify + what duration value the metrics should exceed for the alert to + trigger. + type: string + onlyFinalAttempt: + type: boolean + description: >- + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. + GoogleCloudIntegrationsV1alphaSuspensionAudit: + id: GoogleCloudIntegrationsV1alphaSuspensionAudit + description: Contains when and by whom the suspension was resolved. type: object - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - EnterpriseCrmEventbusProtoMappedField: properties: - inputField: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - description: The input field being mapped from. - outputField: - description: The output field being mapped to. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - description: Mapped field is a pair of input field and output field. - id: EnterpriseCrmEventbusProtoMappedField + resolver: + type: string + description: Email address of the person who resolved this suspension. + resolveTime: + description: Time at which this suspension was resolved. + type: string + format: google-datetime + GoogleCloudIntegrationsV1alphaImportTemplateResponse: + id: GoogleCloudIntegrationsV1alphaImportTemplateResponse + description: Response for import template type: object - EnterpriseCrmEventbusProtoIntParameterArray: properties: - intValues: + subIntegrationVersions: + type: array + description: Sub integration versions which are imported. items: - format: int64 - type: string + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: IntegrationVersion after the import. + EnterpriseCrmEventbusProtoFieldMappingConfig: + id: EnterpriseCrmEventbusProtoFieldMappingConfig + properties: + mappedFields: type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' + description: >- + Field Mapping Config to map multiple output fields values from input + fields values. type: object - id: EnterpriseCrmEventbusProtoIntParameterArray - GoogleCloudIntegrationsV1alphaAuthToken: + GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: type: object - id: GoogleCloudIntegrationsV1alphaAuthToken + description: Conditional task failur retry strategies properties: - token: + failurePolicies: + description: >- + The list of failure policies that will be applied to the task in + order. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + type: array + defaultFailurePolicy: + description: >- + The default failure policy to be applied if no conditional failure + policy matches. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: + description: Request for UnpublishIntegrationVersion. + type: object + id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + properties: {} + GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: + type: object + description: The response for executing an integration. + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + properties: + executionInfoIds: + description: The execution info id for the executed integrations. + type: array + items: + type: string + EnterpriseCrmEventbusProtoSuspensionAuthPermissions: + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions + type: object + properties: + googleGroup: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + loasRole: type: string - description: The token for the auth type. - type: + mdbGroup: type: string - description: Authentication type, e.g. "Basic", "Bearer", etc. + gaiaIdentity: + description: Represents a Gaia identity for a person or service account. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + description: LINT.IfChange + GoogleCloudIntegrationsV1alphaAuthToken: + id: GoogleCloudIntegrationsV1alphaAuthToken description: >- The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. - GoogleCloudIntegrationsV1alphaFile: - id: GoogleCloudIntegrationsV1alphaFile properties: + token: + description: The token for the auth type. + type: string type: - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - description: >- - File information like Integration version, Integration Config - variables etc. - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. type: string - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Integration version - integrationConfig: - additionalProperties: - description: Properties of the object. - type: any - type: object - description: Integration version config file + description: Authentication type, e.g. "Basic", "Bearer", etc. type: object - description: >- - To store Integration version related file i.e. Integration Version, - Config variable etc. - EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: - id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition + EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: properties: - path: - description: Path to the proto file that contains the message type's definition. + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + conditionResults: + type: array + description: All of the computed conditions that been calculated. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + taskExecutionDetails: + description: All of the task execution details at the given point of time. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + eventExecutionInfoId: + description: Points to the event execution info this snapshot belongs to. type: string - fullName: + checkpointTaskNumber: description: >- - The fully-qualified proto name. This message, for example, would be - "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". + Indicates "right after which checkpoint task's execution" this + snapshot is taken. type: string - type: object - EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: - properties: - percentage: - format: int32 - type: integer - absolute: - format: int64 + eventExecutionSnapshotId: type: string - type: object - description: >- - The threshold value of the metric, above or below which the alert should - be triggered. See EventAlertConfig or TaskAlertConfig for the different - alert metric types in each case. For the *RATE metrics, one or both of - these fields may be set. Zero is the default value and can be left at - that. For *PERCENTILE_DURATION metrics, one or both of these fields may - be set, and also, the duration threshold value should be specified in - the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, - these fields should not be set at all. A different member, - threshold_duration_ms, must be set in the EventAlertConfig or the - TaskAlertConfig. - id: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: - type: object - properties: - suspension: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' description: >- - Suspension, containing the event_execution_info_id, task_id, and - state to set on the corresponding suspension record. - description: Request for [Suspensions.ResolveSuspensions]. - id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest - GoogleCloudIntegrationsV1alphaAttemptStats: - description: Status for the execution attempt. - id: GoogleCloudIntegrationsV1alphaAttemptStats - properties: - endTime: - format: google-datetime + Auto-generated. Used as primary key for EventExecutionSnapshots + table. + diffParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: The parameters in Event object that differs from last snapshot. + eventParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: The parameters in Event object. + snapshotTime: type: string - description: The end time of the integration execution for current attempt. - startTime: - format: google-datetime + format: int64 + description: Indicates when this snapshot is taken. + taskName: + deprecated: true type: string - description: >- - The start time of the integration execution for current attempt. - This could be in the future if it's been scheduled. + description: The task name associated with this snapshot. Could be empty. + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot type: object - GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: + EnterpriseCrmEventbusProtoNotification: properties: - runAsServiceAccount: + emailAddress: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' + buganizerNotification: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' + escalatorQueue: type: string - description: 'Required. REQUIRED: Run-as service account to be updated' - id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest - type: object - description: Request for the ReplaceServiceAccount rpc - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - properties: - exclusive: - type: boolean + request: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest description: >- - Whether the regex matcher is applied exclusively (if true, matching - values will be rejected). - regex: + If the out-of-the-box email/pubsub notifications are not suitable + and custom logic is required, fire a workflow containing all info + needed to notify users to resume execution. + pubsubTopic: type: string - description: The regex applied to the input value(s). - type: object - description: Rule used to validate strings. - GoogleCloudIntegrationsV1alphaTemplateBundle: - id: GoogleCloudIntegrationsV1alphaTemplateBundle type: object - description: Define the bundle of the template. - properties: - subIntegrationVersionTemplates: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate - type: array - description: >- - Optional. Sub integration templates which would be added along with - main integration. - integrationVersionTemplate: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate - description: Required. Main integration templates of the template bundle. - GoogleCloudIntegrationsV1alphaOidcToken: + id: EnterpriseCrmEventbusProtoNotification + GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: type: object - id: GoogleCloudIntegrationsV1alphaOidcToken - description: OIDC Token + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + description: Request for Creating Cloud Function rpc call. properties: - tokenExpireTime: - format: google-datetime - type: string - description: The approximate time until the token retrieved is valid. - audience: - description: >- - Audience to be used when generating OIDC token. The audience claim - identifies the recipients that the JWT is intended for. + functionName: + description: The function name of CF to be created type: string - serviceAccountEmail: - description: The service account email to be used as the identity for the token. + functionRegion: + description: The function region of CF to be created type: string - token: + projectId: + description: >- + Indicates the id of the GCP project that the function will be + created in. type: string - description: ID token obtained for the service account - EnterpriseCrmEventbusProtoTaskExecutionDetails: - id: EnterpriseCrmEventbusProtoTaskExecutionDetails + EnterpriseCrmEventbusProtoProtoFunction: + type: object properties: - taskExecutionState: - enum: - - UNSPECIFIED - - PENDING_EXECUTION - - IN_PROCESS - - SUCCEED - - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - - CANCELED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK - - SUSPENDED + functionName: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET_STRING_SUBFIELD + - GET_INT_SUBFIELD + - GET_DOUBLE_SUBFIELD + - GET_BOOLEAN_SUBFIELD + - GET_STRING_ARRAY_SUBFIELD + - GET_INT_ARRAY_SUBFIELD + - GET_DOUBLE_ARRAY_SUBFIELD + - GET_BOOLEAN_ARRAY_SUBFIELD + - GET_PROTO_ARRAY_SUBFIELD + - GET_PROTO_SUBFIELD + - TO_JSON + - GET_BYTES_SUBFIELD_AS_UTF_8_STRING + - GET_BYTES_SUBFIELD_AS_PROTO + - EQUALS + type: string + id: EnterpriseCrmEventbusProtoProtoFunction + EnterpriseCrmEventbusProtoEventExecutionSnapshot: + properties: + checkpointTaskNumber: + type: string + description: >- + Indicates "right after which checkpoint task's execution" this + snapshot is taken. + eventExecutionInfoId: + type: string + description: Points to the event execution info this snapshot belongs to. + conditionResults: + description: All of the computed conditions that been calculated. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + type: array + diffParams: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: The parameters in Event object that differs from last snapshot. + eventParams: + description: The parameters in Event object. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + snapshotTime: + type: string + description: Indicates when this snapshot is taken. + format: int64 + clientId: + type: string + description: Client that the execution snapshot is associated to. + exceedMaxSize: + description: indicate whether snapshot exceeded maximum size before clean up + type: boolean + taskExecutionDetails: + description: All of the task execution details at the given point of time. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + eventExecutionSnapshotId: + type: string + description: >- + Auto-generated. Used as primary key for EventExecutionSnapshots + table. + workflowName: + description: Name of the workflow this event execution snapshot belongs to. + type: string + taskName: + description: The task name associated with this snapshot. Could be empty. + type: string + deprecated: true + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + id: EnterpriseCrmEventbusProtoEventExecutionSnapshot + description: >- + Contains the snapshot of the event execution for a given checkpoint. + Next available id: 15 + type: object + EnterpriseCrmEventbusProtoProtoParameterArray: + id: EnterpriseCrmEventbusProtoProtoParameterArray + type: object + properties: + protoValues: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array + EnterpriseCrmFrontendsEventbusProtoTaskEntity: + type: object + properties: + metadata: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' + description: Metadata inclueds the task name, author and so on. + uiConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' + description: >- + UI configuration for this task Also associated with the METADATA + mask. + taskType: + enumDescriptions: + - Normal IP task + - Task is of As-Is Template type + - Task is of I/O template type with a different underlying task + type: string + enum: + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE + description: Defines the type of the task + paramSpecs: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + description: >- + Declarations for inputs/outputs for a TypedTask. This is also + associated with the METADATA mask. + stats: + description: Deprecated - statistics from the Monarch query. + $ref: '#/components/schemas/EnterpriseCrmEventbusStats' + deprecated: true + disabledForVpcSc: + type: boolean + description: True if the task has conflict with vpcsc + description: >- + Contains a task's metadata and associated information. Next available + id: 7 + id: EnterpriseCrmFrontendsEventbusProtoTaskEntity + GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: + id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + type: object + properties: + nextPageToken: + type: string + description: The token used to retrieve the next page of results. + sfdcInstances: + description: The list of SfdcInstances retrieved. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + description: Response to list SfdcInstances. + EnterpriseCrmEventbusProtoTaskExecutionDetails: + description: >- + Contains the details of the execution of this task. Next available id: + 11 + type: object + properties: + taskAttemptStats: + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats + type: array + taskExecutionState: enumDescriptions: - '' - >- @@ -7185,450 +7482,484 @@ components: Task is a SuspensionTask which has executed once, creating a pending suspension. type: string - taskAttemptStats: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats + enum: + - UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED + - FATAL + - RETRY_ON_HOLD + - SKIPPED + - CANCELED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED taskNumber: type: string description: Pointer to the task config it used for execution. - type: object - description: >- - Contains the details of the execution of this task. Next available id: - 11 - GoogleCloudIntegrationsV1alphaBooleanParameterArray: - description: This message only contains a field of boolean array. - type: object - id: GoogleCloudIntegrationsV1alphaBooleanParameterArray - properties: - booleanValues: - description: Boolean array. - items: - type: boolean - type: array - EnterpriseCrmEventbusProtoSuccessPolicy: - description: >- - Policy that dictates the behavior for the task after it completes - successfully. - type: object + id: EnterpriseCrmEventbusProtoTaskExecutionDetails + EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: properties: - finalState: - enumDescriptions: - - '' - - >- - The default behavior, where successful tasks will be marked as - SUCCEEDED. - - >- - Sets the state to SUSPENDED after executing. This is required for - SuspensionTask; event execution will continue once the user calls - ResolveSuspensions with the event_execution_info_id and the task - number. + emailAddress: + type: string + gaiaId: + format: int64 type: string - enum: - - UNSPECIFIED - - SUCCEEDED - - SUSPENDED - description: >- - State to which the execution snapshot status will be set if the task - succeeds. - id: EnterpriseCrmEventbusProtoSuccessPolicy - EnterpriseCrmEventbusProtoEventParameters: - properties: - parameters: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - description: >- - LINT.IfChange This message is used for processing and persisting (when - applicable) key value pair parameters for each event in the event bus. - Please see type: object - id: EnterpriseCrmEventbusProtoEventParameters - GoogleCloudConnectorsV1AuthConfig: + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + GoogleCloudIntegrationsV1alphaIntegrationParameter: type: object - description: AuthConfig defines details of a authentication type. - id: GoogleCloudConnectorsV1AuthConfig properties: - authKey: - type: string - description: Identifier key for auth config - sshPublicKey: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' - description: SSH Public Key. - additionalVariables: - description: List containing additional auth configs. - type: array - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - userPassword: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' - description: UserPassword. - oauth2ClientCredentials: - description: Oauth2ClientCredentials. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - authType: + producer: + description: >- + The identifier of the node (TaskConfig/TriggerConfig) this parameter + was produced by, if it is a transient param or a copy of an input + param. + type: string + isTransient: + type: boolean + description: Whether this parameter is a transient parameter. + jsonSchema: + description: >- + This schema will be used to validate runtime JSON-typed values of + this parameter. + type: string + searchable: + description: Searchable in the execution log or not. + type: boolean + description: + type: string + description: Optional. Description of the parameter. + containsLargeData: + type: boolean + description: >- + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + displayName: + description: >- + The name (without prefix) to be displayed in the UI for this + parameter. E.g. if the key is "foo.bar.myName", then the name would + be "myName". + type: string + key: + type: string + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. + dataType: enumDescriptions: - - Authentication type not specified. - - Username and Password Authentication. + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + type: string + description: Type of the parameter. + enum: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + defaultValue: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: >- + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + masked: + type: boolean + description: True if this parameter should be masked in the logs + inputOutputType: + enumDescriptions: + - Default. - >- - JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant - based authentication - - Oauth 2.0 Client Credentials Grant Authentication - - SSH Public Key Authentication - - Oauth 2.0 Authorization Code Flow - - Google authentication + Input parameters for the integration. EventBus validates that + these parameters exist in the integrations before execution. - >- - Oauth 2.0 Authorization Code Flow with Google Provided OAuth - Client - description: The type of authentication configured. + Output Parameters for the integration. EventBus will only return + the integration parameters tagged with OUT in the response back. + - >- + Input and Output Parameters. These can be used as both input and + output. EventBus will validate for the existence of these + parameters before execution and will also return this parameter + back in the response. enum: - - AUTH_TYPE_UNSPECIFIED - - USER_PASSWORD - - OAUTH2_JWT_BEARER - - OAUTH2_CLIENT_CREDENTIALS - - SSH_PUBLIC_KEY - - OAUTH2_AUTH_CODE_FLOW - - GOOGLE_AUTHENTICATION - - OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED - type: string - oauth2JwtBearer: - description: Oauth2JwtBearer. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - oauth2AuthCodeFlow: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - description: Oauth2AuthCodeFlow. - oauth2AuthCodeFlowGoogleManaged: - description: Oauth2AuthCodeFlowGoogleManaged. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged - GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: - description: Response for DownloadIntegrationVersion. - type: object - properties: - files: - description: List containing String represendation for multiple file with type. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' - content: - description: String representation of the requested file. + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT + description: Specifies the input/output type for the parameter. type: string - id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: + description: >- + Integration Parameter is defined in the integration config and are used + to provide information about data types of the expected parameters and + provide any default values if needed. They can also be used to add + custom attributes. These are static in nature and should not be used for + dynamic event definition. + id: GoogleCloudIntegrationsV1alphaIntegrationParameter + GoogleCloudIntegrationsV1alphaParameterMapEntry: properties: - scriptId: - type: string - description: The id of the Apps Script project to be linked. + value: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + description: Value of the map entry. + key: + description: Key of the map entry. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + description: Entry is a pair of key and value. type: object - description: Request for LinkAppsScriptProject rpc call. - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest - EnterpriseCrmEventbusProtoLogSettings: + id: GoogleCloudIntegrationsV1alphaParameterMapEntry + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo description: >- - The LogSettings define the logging attributes for an event property. - These attributes are used to map the property to the parameter in the - log proto. Also used to define scrubbing/truncation behavior and PII - information. - type: object - id: EnterpriseCrmEventbusProtoLogSettings + Contains all the execution details for a workflow instance. Next + available id: 27 properties: - seedScope: + integrationVersionUserLabel: + description: User-defined label that annotates the executed integration version. + type: string + workflowId: + type: string + description: Required. Pointer to the workflow it is executing. + errorCode: + description: Final error-code if event failed. + $ref: '#/components/schemas/CrmlogErrorCode' + responseParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Event parameters come out as part of the response. + workflowRetryBackoffIntervalSeconds: + format: int64 + type: string + description: >- + Time interval in seconds to schedule retry of workflow in manifold + when workflow is already running + product: type: string enum: - - SEED_SCOPE_UNSPECIFIED - - EVENT_NAME - - TIME_PERIOD - - PARAM_NAME + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY enumDescriptions: - '' - - Hash computations include the event name. - - Hash computations include a time period. - - Hash computations include the param name. - logFieldName: + - '' + - '' + - '' description: >- - The name of corresponding logging field of the event property. If - omitted, assumes the same name as the event property key. + Which Google product the execution_info belongs to. If not set, the + execution_info belongs to Integration Platform by default. + workflowName: type: string - seedPeriod: - enumDescriptions: - - '' - - Sanitized values remain constant for the day of the event. - - >- - Sanitized values remain constant for the week of the event; may - cross month boundaries. - - Sanitized values remain constant for the month of the event. - enum: - - SEED_PERIOD_UNSPECIFIED - - DAY - - WEEK - - MONTH + description: Name of the workflow. + clientId: type: string - GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: - description: Configurations for approving the Suspension. - properties: - expiration: - description: >- - Indicates the next steps when no external actions happen on the - suspension. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration - customMessage: + description: The event data user sends as request. + triggerId: type: string - description: Information to provide for recipients. - emailAddresses: + description: >- + The trigger id of the workflow trigger config. If both trigger_id + and client_id is present, the workflow is executed from the start + tasks provided by the matching trigger config otherwise it is + executed from the default start tasks. + executionTraceInfo: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' + description: Execution trace info to aggregate parent-child executions. + lastModifiedTime: + description: Auto-generated. + type: string + format: int64 + postMethod: + description: The ways user posts this event. + type: string + enum: + - UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + - POST_BY_EVENT_CONFIG_ID + - POST_WITH_EVENT_DETAILS + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + replayInfo: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + description: Replay info for the execution + snapshotNumber: + type: string + description: Workflow snapshot number. + format: int64 + cloudLoggingDetails: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' + description: Cloud Logging details for execution info + tenant: + type: string + description: >- + Tenant this event is created. Used to reschedule the event to + correct tenant. + createTime: + description: Auto-generated. + format: int64 + type: string + requestId: + type: string + description: Optional. This is used to de-dup incoming request. + requestParams: + description: Event parameters come in as part of the request. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + errors: items: - type: string - description: Email addresses to send approval request to. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' type: array + description: >- + Errors, warnings, and informationals associated with the + workflow/task. The order in which the errors were added by the + workflow/task is maintained. + eventExecutionInfoId: + type: string + description: Auto-generated primary key. + eventExecutionDetails: + description: The execution info about this event. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails type: object - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: - description: Range used to validate longs and ints. + GoogleCloudConnectorsV1EventingConfig: + description: Eventing Configuration of a connection + type: object + id: GoogleCloudConnectorsV1EventingConfig properties: - min: + privateConnectivityEnabled: + type: boolean + description: Optional. Private Connectivity Enabled. + deadLetterConfig: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + description: Optional. Dead letter configuration for eventing of a connection. + enrichmentEnabled: + type: boolean + description: Enrichment Enabled. + additionalVariables: + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + type: array + description: Additional eventing related field values + eventsListenerIngressEndpoint: + description: >- + Optional. Ingress endpoint of the event listener. This is used only + when private connectivity is enabled. type: string - format: int64 - description: The inclusive minimum of the acceptable range. - max: + proxyDestinationConfig: + description: Optional. Proxy for Eventing auto-registration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + authConfig: + description: Auth details for the webhook adapter. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + listenerAuthConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + description: Optional. Auth details for the event listener. + registrationDestinationConfig: + description: Registration endpoint for auto registration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + EnterpriseCrmEventbusProtoParameterMapField: + properties: + referenceKey: type: string - format: int64 - description: The inclusive maximum of the acceptable range. + description: Referencing one of the WF variables. + literalValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: Passing a literal value. type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange - EnterpriseCrmEventbusProtoTaskMetadataAdmin: - id: EnterpriseCrmEventbusProtoTaskMetadataAdmin + id: EnterpriseCrmEventbusProtoParameterMapField + description: Field represents either the key or value in an entry. + GoogleCloudIntegrationsV1alphaDoubleParameterArray: + type: object + id: GoogleCloudIntegrationsV1alphaDoubleParameterArray + description: This message only contains a field of double number array. + properties: + doubleValues: + description: Double number array. + type: array + items: + format: double + type: number + EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: + type: object + properties: + parameters: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + description: >- + Parameters are a part of Event and can be used to communiticate + between different tasks that are part of the same workflow + execution. description: >- - Admins are owners of a Task, and have all permissions on a particular - task identified by the task name. By default, Eventbus periodically - scans all task metadata and syncs (adds) any new admins defined here to - Zanzibar. + LINT.IfChange This is the frontend version of WorkflowParameters. It's + exactly like the backend version except that instead of flattening + protobuf parameters and treating every field and subfield of a protobuf + parameter as a separate parameter, the fields/subfields of a protobuf + parameter will be nested as "children" (see 'children' field below) + parameters of the parent parameter. Please refer to + enterprise/crm/eventbus/proto/workflow_parameters.proto for more + information about WorkflowParameters. + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: + id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter type: object properties: - userEmail: - type: string - googleGroupEmail: + objectValue: type: string - GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: - description: Dead Letter configuration details provided by the user. + format: byte + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: type: object - id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig properties: - topic: + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: The uploaded integration. + description: Response for UploadIntegrationVersion. + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + GoogleCloudIntegrationsV1alphaValueType: + description: The type of the parameter. + id: GoogleCloudIntegrationsV1alphaValueType + type: object + properties: + doubleValue: + type: number + description: Double Number. + format: double + booleanValue: + type: boolean + description: Boolean. + doubleArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray + description: Double Number Array. + jsonValue: + description: Json. type: string - description: Optional. Topic to push events which couldn't be processed. - projectId: - description: Optional. Project which has the topic given. + stringValue: type: string - EnterpriseCrmEventbusProtoAttributes: + description: String. + intArray: + description: Integer Array. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' + intValue: + description: Integer. + format: int64 + type: string + stringArray: + description: String Array. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray + booleanArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray + description: Boolean Array. + GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged: + type: object description: >- - Attributes are additional options that can be associated with each event - property. For more information, see - id: EnterpriseCrmEventbusProtoAttributes + Parameters to support Oauth 2.0 Auth Code Grant Authentication using + Google Provided OAuth Client. See + https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. properties: - isRequired: - type: boolean + authCode: + type: string description: >- - Required for event execution. The validation will be done by the - event bus when the event is triggered. - taskVisibility: + Optional. Authorization code to be exchanged for access and refresh + tokens. + redirectUri: + description: Optional. Redirect URI to be provided during the auth code exchange. + type: string + scopes: type: array items: type: string - description: List of tasks that can view this property, if empty then all. - isSearchable: - type: boolean - deprecated: true description: >- - Used to indicate if a ParameterEntry should be converted to - ParamIndexes for ST-Spanner full-text search. DEPRECATED: use - searchable. - masked: - description: True if this workflow parameter should be masked in the logs - type: boolean - readOnly: - type: boolean - description: Used to indicate if the ParameterEntry is a read only field or not. - logSettings: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' - description: See - dataType: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - >- - Domain is a web url string with one top-level private domain and a - suffix (for example: google.com, walmart.com) - type: string - enum: - - DATA_TYPE_UNSPECIFIED - - EMAIL - - URL - - CURRENCY - - TIMESTAMP - - DOMAIN_NAME - description: >- - Things like URL, Email, Currency, Timestamp (rather than string, - int64...) - defaultValue: - description: Used to define defaults. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - searchable: - type: string - enumDescriptions: - - '' - - >- - If yes, the parameter key and value will be full-text indexed. In - a proto, this value will propagate to all children whose - searchable is unspecified. - - >- - If no, the parameter key and value will not be full-text indexed. - In a proto, this value will propagate to all children whose - searchable is unspecified. - enum: - - UNSPECIFIED - - 'YES' - - 'NO' + Required. Scopes the connection will request when the user performs + the auth code flow. + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + GoogleCloudIntegrationsV1alphaAuthConfig: type: object - EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: - description: 'Key-value pair of EventBus task parameters. Next id: 13' properties: - key: + credentialType: type: string - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given task. These parameters must be - predefined in the workflow definition. - dataType: + description: Credential type of the encrypted credential. + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - Unspecified credential type + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - description: The data type of the parameter. - type: string - config: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' - description: Optional fields, such as help text and other useful info. - collectionElementClassName: - description: >- - If it is a collection of objects, this would be the FCQN of every - individual element in the collection. If this is "java.lang.Object", - the parameter is a collection of any type. + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + createTime: type: string - protoDef: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition - description: Populated if this represents a proto or proto array. - defaultValue: - description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - isDeprecated: - type: boolean - description: >- - If set, this entry is deprecated, so further use of this parameter - should be prohibited. - validationRule: + readOnly: true + format: google-datetime + description: Output only. The timestamp when the auth config is created. + lastModifierEmail: description: >- - Rule used to validate inputs (individual values and collection - elements) for this parameter. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - isOutput: - type: boolean - jsonSchema: - description: If the data_type is JSON_VALUE, then this will define its schema. - type: string - required: - description: If set, the user must provide an input value for this parameter. - type: boolean - className: + The last modifier's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. type: string + decryptedCredential: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' + description: Raw auth credentials. + name: description: >- - The FQCN of the Java object this represents. A string, for example, - would be "java.lang.String". If this is "java.lang.Object", the - parameter can be of any type. - id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry - type: object - GoogleCloudConnectorsV1LogConfig: - properties: - enabled: - description: >- - Enabled represents whether logging is enabled or not for a - connection. - type: boolean - level: - type: string - description: Optional. Log configuration level. - enumDescriptions: - - Log level unspecified. - - Only error logs are enabled. - - Info and error logs are enabled. - - Debug and high verbosity logs are enabled. - enum: - - LOG_LEVEL_UNSPECIFIED - - ERROR - - INFO - - DEBUG - description: Log configuration for the connection. - id: GoogleCloudConnectorsV1LogConfig - type: object - GoogleCloudIntegrationsV1alphaAuthConfig: - description: The AuthConfig resource use to hold channels and connection config data. - id: GoogleCloudIntegrationsV1alphaAuthConfig - properties: - reason: + Resource name of the auth config. For more information, see Manage + authentication profiles. + projects/{project}/locations/{location}/authConfigs/{authConfig}. type: string - description: The reason / details of the current status. visibility: + description: The visibility of the auth config. + type: string enum: - AUTH_CONFIG_VISIBILITY_UNSPECIFIED - PRIVATE @@ -7637,568 +7968,411 @@ components: - Visibility not specified. - Profile visible to the creator only. - Profile visible within the client. - description: The visibility of the auth config. + updateTime: type: string - displayName: - description: Required. The name of the auth config. + readOnly: true + description: Output only. The timestamp when the auth config is modified. + format: google-datetime + state: + enumDescriptions: + - Status not specified. + - Valid Auth config. + - >- + General invalidity, if it doesn't fits in the detailed issue + below. + - Auth config soft deleted. + - Auth config expired. + - Auth config unauthorized. + - Auth config not supported. + description: The status of the auth config. type: string + enum: + - STATE_UNSPECIFIED + - VALID + - INVALID + - SOFT_DELETED + - EXPIRED + - UNAUTHORIZED + - UNSUPPORTED encryptedCredential: type: string format: byte description: >- Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. - name: + reason: type: string + description: The reason / details of the current status. + overrideValidTime: description: >- - Resource name of the auth config. For more information, see Manage - authentication profiles. - projects/{project}/locations/{location}/authConfigs/{authConfig}. - description: + User provided expiry time to override. For the example of + Salesforce, username/password credentials can be valid for 6 months + depending on the instance settings. + format: google-datetime type: string - description: A description of the auth config. - creatorEmail: - description: >- - The creator's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. - type: string - credentialType: - enumDescriptions: - - Unspecified credential type - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - description: Credential type of the encrypted credential. - type: string - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - validTime: - description: >- - The time until the auth config is valid. Empty or max value is - considered the auth config won't expire. - format: google-datetime - type: string - state: - type: string - enum: - - STATE_UNSPECIFIED - - VALID - - INVALID - - SOFT_DELETED - - EXPIRED - - UNAUTHORIZED - - UNSUPPORTED - description: The status of the auth config. - enumDescriptions: - - Status not specified. - - Valid Auth config. - - >- - General invalidity, if it doesn't fits in the detailed issue - below. - - Auth config soft deleted. - - Auth config expired. - - Auth config unauthorized. - - Auth config not supported. - lastModifierEmail: - type: string - description: >- - The last modifier's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. - overrideValidTime: - type: string - format: google-datetime - description: >- - User provided expiry time to override. For the example of - Salesforce, username/password credentials can be valid for 6 months - depending on the instance settings. - expiryNotificationDuration: + expiryNotificationDuration: description: >- User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. - type: array items: - type: string format: google-duration - createTime: - format: google-datetime - description: Output only. The timestamp when the auth config is created. - readOnly: true - type: string - updateTime: + type: string + type: array + description: + description: A description of the auth config. type: string - description: Output only. The timestamp when the auth config is modified. - readOnly: true - format: google-datetime certificateId: + type: string description: Certificate id for client certificate + creatorEmail: type: string - decryptedCredential: - description: Raw auth credentials. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' - type: object - GoogleCloudConnectorsV1EventingStatus: - description: EventingStatus indicates the state of eventing. - type: object - id: GoogleCloudConnectorsV1EventingStatus + description: >- + The creator's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. + displayName: + type: string + description: Required. The name of the auth config. + validTime: + description: >- + The time until the auth config is valid. Empty or max value is + considered the auth config won't expire. + format: google-datetime + type: string + id: GoogleCloudIntegrationsV1alphaAuthConfig + description: The AuthConfig resource use to hold channels and connection config data. + GoogleCloudIntegrationsV1alphaExecutionDetails: properties: - description: + eventExecutionSnapshotsSize: + format: int64 + description: Total size of all event_execution_snapshots for an execution type: string - readOnly: true - description: Output only. Description of error if State is set to "ERROR". + attemptStats: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + type: array + description: List of Start and end time of the execution attempts. state: - description: Output only. State. + type: string enumDescriptions: - - Default state. - - Eventing is enabled and ready to receive events. - - Eventing is not active due to an error. - - Ingress endpoint required. + - Default. + - Execution is scheduled and awaiting to be triggered. + - Execution is processing. + - >- + Execution successfully finished. There's no more change after this + state. + - Execution failed. There's no more change after this state. + - >- + Execution canceled by user. There's no more change after this + state. + - Execution failed and waiting for retry. + - Execution suspended and waiting for manual intervention. + description: Status of the execution. enum: - STATE_UNSPECIFIED - - ACTIVE - - ERROR - - INGRESS_ENDPOINT_REQUIRED - type: string - readOnly: true - GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: - type: object - id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse - description: Response for ListIntegrationVersions. - properties: - nextPageToken: - type: string - 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. - integrationVersions: - description: The integrations which match the request. + - PENDING + - PROCESSING + - SUCCEEDED + - FAILED + - CANCELLED + - RETRY_ON_HOLD + - SUSPENDED + executionSnapshots: + description: List of snapshots taken during the execution. type: array items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - noPermission: - type: boolean - description: Whether the user has no permission on the version or not. - GoogleCloudConnectorsV1Secret: - id: GoogleCloudConnectorsV1Secret - description: Secret provides a reference to entries in Secret Manager. + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot + id: GoogleCloudIntegrationsV1alphaExecutionDetails + description: >- + Contains the details of the execution info: this includes the tasks + execution details plus the event execution statistics. + type: object + EnterpriseCrmFrontendsEventbusProtoEventParameters: properties: - secretVersion: + parameters: + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: array description: >- - The resource name of the secret version in the format, format as: - `projects/*/secrets/*/versions/*`. - type: string + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same workflow + execution. + id: EnterpriseCrmFrontendsEventbusProtoEventParameters type: object - GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: + description: >- + LINT.IfChange This message is used for processing and persisting (when + applicable) key value pair parameters for each event in the event bus. + Please see + EnterpriseCrmEventbusProtoCondition: properties: - accessToken: - description: Access token fetched from the authorization server. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - tokenEndpoint: - type: string - description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. - clientId: - description: The client's ID. - type: string - clientSecret: - type: string - description: The client's secret. - tokenParams: - description: Token parameters for the auth request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - requestType: - description: Represent how to pass parameters to fetch access token - type: string + operator: enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: >- + Operator used to evaluate the condition. Please note that an + operator with an inappropriate key/value operand will result in + IllegalArgumentException, e.g. CONTAINS with boolean key/value pair. enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER - scope: + - UNSET + - EQUALS + - CONTAINS + - LESS_THAN + - GREATER_THAN + - EXISTS + - DOES_NOT_EXIST + - IS_EMPTY + - IS_NOT_EMPTY type: string - description: A space-delimited list of requested scope permissions. - type: object - description: >- - For client credentials grant, the client sends a POST request with - grant_type as 'client_credentials' to the authorization server. The - authorization server will respond with a JSON object containing the - access token. - id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials - EnterpriseCrmEventbusProtoParameterMapEntry: - properties: - key: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - description: Entry is a pair of key and value. - type: object - id: EnterpriseCrmEventbusProtoParameterMapEntry - EnterpriseCrmEventbusProtoParameterEntry: - description: Key-value pair of EventBus parameters. - properties: value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + description: Value that's checked for the key. + eventPropertyKey: description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - masked: - description: True if this parameter should be masked in the logs - type: boolean - key: + Key that's evaluated against the `value`. Please note the data type + of the runtime value associated with the key should match the data + type of `value`, else an IllegalArgumentException is thrown. type: string - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - type: object - id: EnterpriseCrmEventbusProtoParameterEntry - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse - properties: {} - description: Response for PublishIntegrationVersion. type: object - GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: - description: Expiration configs for the approval request. + description: Condition that uses `operator` to evaluate the key against the value. + id: EnterpriseCrmEventbusProtoCondition + deprecated: true + EnterpriseCrmEventbusProtoSuspensionExpiration: properties: - remindTime: - type: string - format: google-datetime - description: >- - Time after the previous suspension action reminder, if any, is sent - using the selected notification option, for a suspension which is - still PENDING_UNSPECIFIED. + expireAfterMs: + description: Milliseconds after which the suspension expires, if no action taken. + format: int32 + type: integer liftWhenExpired: type: boolean description: >- Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior. - expireTime: + remindAfterMs: description: >- - Output only. Time after which the suspension expires, if no action - taken. - readOnly: true - type: string - format: google-datetime - type: object - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration - GoogleCloudIntegrationsV1alphaSearchTemplatesResponse: - properties: - nextPageToken: - description: The token used to retrieve the next page results. - type: string - templates: - type: array - description: List of templates retrieved. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' - description: Response for a request to search templates - type: object - id: GoogleCloudIntegrationsV1alphaSearchTemplatesResponse - GoogleCloudIntegrationsV1alphaUsernameAndPassword: - id: GoogleCloudIntegrationsV1alphaUsernameAndPassword - description: Username and password pair. - properties: - username: - type: string - description: Username to be used - password: - type: string - description: Password to be used + Milliseconds after which the previous suspension action reminder, if + any, is sent using the selected notification option, for a + suspension which is still PENDING_UNSPECIFIED. + type: integer + format: int32 type: object - EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: + id: EnterpriseCrmEventbusProtoSuspensionExpiration + EnterpriseCrmEventbusProtoNextTask: type: object - id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats + id: EnterpriseCrmEventbusProtoNextTask properties: - startTime: - description: >- - The start time of the task execution for current attempt. This could - be in the future if it's been scheduled. + label: + description: User-provided label that is attached to this edge in the UI. type: string - format: int64 - endTime: - format: int64 + taskConfigId: + description: ID of the next task. type: string - description: The end time of the task execution for current attempt. - EnterpriseCrmEventbusProtoLoopMetadata: - properties: - currentIterationDetail: + description: type: string description: >- - Needs to be set by the loop impl class before each iteration. The - abstract loop class will append the request and response to it. Eg. - The foreach Loop will clean up and set it as the current iteration - element at the start of each loop. The post request and response - will be appended to the value once they are available. - currentIterationCount: - format: int64 - type: string - description: Starting from 1, not 0. - failureLocation: - description: Indicates where in the loop logic did it error out. - type: string - enum: - - UNKNOWN - - SUBWORKFLOW - - PARAM_OVERRIDING - - PARAM_AGGREGATING - - SETTING_ITERATION_ELEMENT - - GETTING_LIST_TO_ITERATE - - CONDITION_EVALUATION - - BUILDING_REQUEST - enumDescriptions: - - No error or Unknown. - - Subworkflow failed while firing/running. - - Param overrides failed. - - Param aggregation failed. - - Setting for loop current element failed. - - Getting the list to iterate. - - Evaluating the while loop condition. - - Building the iteration request - errorMsg: - description: Add the error message when loops fail. - type: string - id: EnterpriseCrmEventbusProtoLoopMetadata - type: object - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: - properties: - authConfigId: + User-provided description intended to give more business context + about the next task edge or condition. + combinedConditions: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' + deprecated: true + type: array description: >- - The auth config id necessary to fetch the necessary credentials to - create the project for external clients + Combined condition for this task to become an eligible next task. + Each of these combined_conditions are joined with logical OR. + DEPRECATED: use `condition` + taskNumber: type: string - appsScriptProject: + description: Task number of the next task. + condition: type: string - description: The name of the Apps Script project to be created. - description: Request for CreateAppsScriptProject rpc call. - type: object - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest - GoogleCloudIntegrationsV1alphaJwt: + description: >- + Standard filter expression for this task to become an eligible next + task. description: >- - Represents JSON web token(JWT), which is a compact, URL-safe means of - representing claims to be transferred between two parties, enabling the - claims to be digitally signed or integrity protected. + The task that is next in line to be executed, if the condition specified + evaluated to true. + GoogleCloudIntegrationsV1alphaStringParameterArray: + id: GoogleCloudIntegrationsV1alphaStringParameterArray properties: - jwtHeader: - type: string - description: Identifies which algorithm is used to generate the signature. - secret: - description: User's pre-shared secret to sign the token. - type: string - jwt: + stringValues: + description: String array. + items: + type: string + type: array + description: This message only contains a field of string array. + type: object + GoogleCloudConnectorsV1ResourceLimits: + properties: + memory: + readOnly: true type: string - description: The token calculated by the header, payload and signature. - jwtPayload: - description: >- - Contains a set of claims. The JWT specification defines seven - Registered Claim Names which are the standard fields commonly - included in tokens. Custom claims are usually also included, - depending on the purpose of the token. + description: Output only. Memory limit. + cpu: + description: Output only. CPU limit. type: string + readOnly: true + id: GoogleCloudConnectorsV1ResourceLimits type: object - id: GoogleCloudIntegrationsV1alphaJwt - EnterpriseCrmEventbusProtoTriggerCriteria: - id: EnterpriseCrmEventbusProtoTriggerCriteria + description: Resource limits defined for connection pods of a given connector type. + EnterpriseCrmEventbusProtoToken: + id: EnterpriseCrmEventbusProtoToken type: object properties: - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: Optional. To be used in TaskConfig for the implementation class. - triggerCriteriaTaskImplementationClassName: + value: type: string - description: >- - Optional. Implementation class name. The class should implement the - “TypedTask” interface. - condition: + name: type: string - description: >- - Required. Standard filter expression, when true the workflow will be - executed. If there's no - trigger_criteria_task_implementation_class_name specified, the - condition will be validated directly. - EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: - properties: - key: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - value: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry - type: object - description: Entry is a pair of key and value. - EnterpriseCrmFrontendsEventbusProtoParameterEntry: - id: EnterpriseCrmFrontendsEventbusProtoParameterEntry + EnterpriseCrmEventbusProtoBooleanParameterArray: type: object + id: EnterpriseCrmEventbusProtoBooleanParameterArray properties: - dataType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - type: string - description: Explicitly getting the type of the parameter. - masked: - type: boolean - description: True if this parameter should be masked in the logs - value: - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - key: - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the workflow definition. - type: string - description: Key-value pair of EventBus parameters. - EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: - id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - type: object - properties: - filterType: - enumDescriptions: - - '' - - '' - type: string - enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE - enumStrings: - type: array - items: - type: string - description: List of error enums for alerts. - EnterpriseCrmEventbusProtoFieldMappingConfig: - id: EnterpriseCrmEventbusProtoFieldMappingConfig - description: >- - Field Mapping Config to map multiple output fields values from input - fields values. - type: object - properties: - mappedFields: + booleanValues: type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' + type: boolean EnterpriseCrmEventbusProtoFunctionType: properties: + booleanArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' + doubleArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' + protoFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' baseFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' description: LINT.IfChange + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' booleanFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction' - protoArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' - stringFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' intArrayFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction' - protoFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' - booleanArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' intFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntFunction' jsonFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' stringArrayFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' + protoArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' doubleFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' - doubleArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' + stringFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' + type: object id: EnterpriseCrmEventbusProtoFunctionType + GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue type: object - EnterpriseCrmEventbusProtoDoubleArrayFunction: - id: EnterpriseCrmEventbusProtoDoubleArrayFunction + description: >- + The threshold value of the metric, above or below which the alert should + be triggered. See EventAlertConfig or TaskAlertConfig for the different + alert metric types in each case. For the *RATE metrics, one or both of + these fields may be set. Zero is the default value and can be left at + that. For *PERCENTILE_DURATION metrics, one or both of these fields may + be set, and also, the duration threshold value should be specified in + the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, + these fields should not be set at all. A different member, + threshold_duration_ms, must be set in the EventAlertConfig or the + TaskAlertConfig. properties: - functionName: - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + percentage: + type: integer + format: int32 + description: Percentage threshold. + absolute: + format: int64 + type: string + description: Absolute value threshold. + GoogleCloudIntegrationsV1alphaUseTemplateRequest: + id: GoogleCloudIntegrationsV1alphaUseTemplateRequest + type: object + description: Request to Use template + properties: + subIntegrations: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + description: Optional. Sub Integration which would be created via templates. + type: object + integrationDetails: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + description: Required. Integration details which would be created via templates. + integrationRegion: + type: string + description: Required. The region of the Integration to be created. + GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: + properties: + runtimeEntitySchemas: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + description: Runtime entity schemas. + nextPageToken: + type: string + description: Next page token. + description: Response for listing RuntimeEntitySchemas for a specific Connection. + id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + type: object + GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: + description: Request for the ReplaceServiceAccount rpc + id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + type: object + properties: + runAsServiceAccount: + type: string + description: 'Required. REQUIRED: Run-as service account to be updated' + EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: + properties: + required: + type: boolean + description: If set, the user must provide an input value for this parameter. + protoDef: + description: Populated if this represents a proto or proto array. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition + key: + type: string + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given task. These parameters must be + predefined in the workflow definition. + defaultValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + description: >- + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + collectionElementClassName: + description: >- + If it is a collection of objects, this would be the FCQN of every + individual element in the collection. If this is "java.lang.Object", + the parameter is a collection of any type. + type: string + config: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' + description: Optional fields, such as help text and other useful info. + jsonSchema: + description: If the data_type is JSON_VALUE, then this will define its schema. + type: string + validationRule: + description: >- + Rule used to validate inputs (individual values and collection + elements) for this parameter. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + dataType: + description: The data type of the parameter. enumDescriptions: - '' - '' @@ -8214,991 +8388,793 @@ components: - '' - '' - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. - '' - '' - '' type: string - type: object - EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - type: object - properties: - doubleRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange - intRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange - stringRegex: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - GoogleCloudIntegrationsV1alphaClientCertificate: - description: Contains client certificate information - properties: - passphrase: - description: >- - 'passphrase' should be left unset if private key is not encrypted. - Note that 'passphrase' is not the password for web server, but an - extra layer of security to protected private key. - type: string - sslCertificate: + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + className: type: string description: >- - The ssl certificate encoded in PEM format. This string must include - the begin header and end footer lines. For example, -----BEGIN - CERTIFICATE----- - MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV - BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw - MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET - MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA - vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 - JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB - xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P - AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB - Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey - Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW - JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr - 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H - wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- - encryptedPrivateKey: - type: string + The FQCN of the Java object this represents. A string, for example, + would be "java.lang.String". If this is "java.lang.Object", the + parameter can be of any type. + isOutput: + type: boolean + isDeprecated: + type: boolean description: >- - The ssl certificate encoded in PEM format. This string must include - the begin header and end footer lines. For example, -----BEGIN - CERTIFICATE----- - MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV - BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw - MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET - MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA - vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 - JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB - xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P - AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB - Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey - Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW - JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr - 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H - wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- - id: GoogleCloudIntegrationsV1alphaClientCertificate + If set, this entry is deprecated, so further use of this parameter + should be prohibited. type: object - EnterpriseCrmEventbusProtoIntArrayFunction: + description: 'Key-value pair of EventBus task parameters. Next id: 13' + id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry + GoogleCloudIntegrationsV1alphaIntegration: + id: GoogleCloudIntegrationsV1alphaIntegration type: object properties: - functionName: - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + creatorEmail: + readOnly: true type: string - id: EnterpriseCrmEventbusProtoIntArrayFunction - EnterpriseCrmEventbusProtoProtoArrayFunction: - id: EnterpriseCrmEventbusProtoProtoArrayFunction + description: >- + Output only. The creator's email address. Generated based on the End + User Credentials/LOAS role of the user making the call. + lastModifierEmail: + type: string + description: Required. The last modifier of this integration + active: + type: boolean + description: Required. If any integration version is published. + createTime: + format: google-datetime + type: string + description: Required. Output only. Auto-generated. + readOnly: true + updateTime: + readOnly: true + type: string + description: Output only. Auto-generated. + format: google-datetime + description: + description: Optional. + type: string + name: + type: string + description: Required. The resource name of the integration. + description: The integration definition. + EnterpriseCrmEventbusProtoSuccessPolicy: properties: - functionName: + finalState: enum: - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + - SUCCEEDED + - SUSPENDED + description: >- + State to which the execution snapshot status will be set if the task + succeeds. type: string enumDescriptions: - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - >- + The default behavior, where successful tasks will be marked as + SUCCEEDED. + - >- + Sets the state to SUSPENDED after executing. This is required for + SuspensionTask; event execution will continue once the user calls + ResolveSuspensions with the event_execution_info_id and the task + number. type: object - GoogleCloudIntegrationsV1alphaNextTask: description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. - id: GoogleCloudIntegrationsV1alphaNextTask - type: object + Policy that dictates the behavior for the task after it completes + successfully. + id: EnterpriseCrmEventbusProtoSuccessPolicy + GoogleCloudIntegrationsV1alphaUploadTemplateRequest: properties: - description: - type: string - description: >- - User-provided description intended to give additional business - context about the task. - taskConfigId: - type: string - description: ID of the next task. - condition: + content: + description: Required. The textproto of the template. type: string - description: >- - Standard filter expression for this task to become an eligible next - task. - displayName: + fileFormat: + description: Required. File format for upload request. type: string - description: User-provided label that is attached to this edge in the UI. - taskId: - description: Task number of the next task. + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + id: GoogleCloudIntegrationsV1alphaUploadTemplateRequest + type: object + description: Request for UploadTemplate. + GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: + type: object + id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + description: Response to list AuthConfigs. + properties: + nextPageToken: type: string - GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: - description: >- - LINT.IfChange Use this request to post all workflows associated with a - given trigger id. Next available id: 13 + description: The token used to retrieve the next page of results. + authConfigs: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + type: array + description: The list of AuthConfigs retrieved. + GoogleCloudIntegrationsV1alphaTaskExecutionDetails: + id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails type: object - id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest properties: - quotaRetryCount: - description: >- - Optional. This is a field to see the quota retry count for - integration execution - format: int32 - type: integer - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: Passed in as parameters to each workflow execution. Optional. - priority: + taskAttemptStats: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + description: Status for the current task execution attempt. + taskNumber: + type: string + description: Pointer to the task config it used for execution. + taskExecutionState: type: string enum: - - UNSPCIFIED - - SHEDDABLE - - SHEDDABLE_PLUS - - CRITICAL - - CRITICAL_PLUS + - TASK_EXECUTION_STATE_UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED + - FATAL + - RETRY_ON_HOLD + - SKIPPED + - CANCELLED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED + description: The execution state of this task. enumDescriptions: - - Unspecified + - Default value. - >- - Frequent partial and occasional full unavailability is expected - and not pageable. * Requests to this band will be shed before all - other requests. * This is the default for async calls sent from - batch jobs. + Task is waiting for its precondition tasks to finish to start the + execution. + - Task is under processing. - >- - Partial unavailability is expected and is not necessarily - pageable. * Requests to this band will be shed before any critical - traffic. * This is the default for async calls sent from - production jobs. + Task execution successfully finished. There's no more change after + this state. + - Task execution failed. There's no more change after this state. - >- - Any outage is a pageable event. * During a production outage - requests in this band will only be shed before CRITICAL_PLUS. * - This is the default for sync calls sent from production jobs. + Task execution failed and cause the whole integration execution to + fail immediately. There's no more change after this state. + - Task execution failed and waiting for retry. - >- - Any outage is a pageable event. * The guideline is for < 10% of - requests to a service to be in this band. * During a production - outage requests in this band will be prioritized above all others. - * Opt-in to CRITICAL_PLUS when your workflow triggers by human. + Task execution skipped. This happens when its precondition wasn't + met, or the integration execution been canceled before reach to + the task. There's no more changes after this state. + - >- + Task execution canceled when in progress. This happens when + integration execution been canceled or any other task fall in + fatal state. + - >- + Task is waiting for its dependency tasks' rollback to finish to + start its rollback. + - Task is rolling back. + - >- + Task is rolled back. This is the state we will set regardless of + rollback succeeding or failing. + - >- + Task is a SuspensionTask which has executed once, creating a + pending suspension. + description: Contains the details of the execution of this task. + GoogleCloudIntegrationsV1alphaExecution: + description: >- + The Execution resource contains detailed information of an individual + integration execution. + type: object + properties: + directSubExecutions: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + type: array + description: Direct sub executions of the following Execution. + requestParameters: + description: Event parameters come in as part of the request. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + requestParams: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: Event parameters come in as part of the request. + deprecated: true + eventExecutionDetails: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' + deprecated: true + description: The execution info about this event. + responseParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Event parameters returned as part of the response. + type: object + triggerId: description: >- - The request priority this request should be processed at. For - internal users: - resourceName: + The trigger id of the integration trigger config. If both trigger_id + and client_id is present, the integration is executed from the start + tasks provided by the matching trigger config otherwise it is + executed from the default start tasks. type: string - description: >- - This field is only required when using Admin Access. The resource - name of target, or the parent resource name. For example: - "projects/*/locations/*/integrations/*" - requestId: - description: >- - Optional. This is used to de-dup incoming request: if the duplicate - request was detected, the response from the previous execution is - returned. Must have no more than 36 characters and contain only - alphanumeric characters and hyphens. + replayInfo: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo + readOnly: true + description: Output only. Replay info for the execution + createTime: + readOnly: true + format: google-datetime type: string - userGeneratedExecutionId: + description: Output only. Created time of the execution. + executionDetails: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' + description: Detailed info of this execution. + integrationVersionState: + description: Output only. State of the integration version + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + readOnly: true type: string - description: >- - This is a unique id provided by the method caller. If provided this - will be used as the execution_id when a new execution info is - created. This is a string representation of a UUID. Must have no - more than 36 characters and contain only alphanumeric characters and - hyphens. - testMode: - description: >- - Optional. Sets test mode in {@link - enterprise/crm/eventbus/event_message.proto}. - type: boolean - scheduledTime: + enum: + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + responseParams: + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + deprecated: true + description: Event parameters come out as part of the response. + type: array + executionMethod: type: string - format: int64 - description: >- - Optional. Time in milliseconds since epoch when the given event - would be scheduled. - workflowName: - description: >- - Optional. If provided, the workflow_name is used to filter all the - matched workflows having same trigger_id+client_id. A combination of - trigger_id, client_id and workflow_name identifies a unique - workflow. + enum: + - EXECUTION_METHOD_UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + enumDescriptions: + - Default value. + - Sync post. + - Async post. + - Async post with schedule time. + description: The ways user posts this event. + name: type: string - ignoreErrorIfNoActiveWorkflow: - type: boolean - description: >- - Optional. Flag to determine whether clients would suppress a warning - when no ACTIVE workflows are not found. If this flag is set to be - true, an error will not be thrown if the requested trigger_id or - client_id is not found in any ACTIVE workflow. Otherwise, the error - is always thrown. The flag is set to be false by default. - triggerId: - description: >- - Matched against all {@link TriggerConfig}s across all workflows. - i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. + description: Auto-generated primary key. + snapshotNumber: + format: int64 type: string - clientId: description: >- - Optional. If the client id is provided, then the combination of - trigger id and client id is matched across all the workflows. If the - client id is not provided, then workflows with matching trigger id - are executed for each client id in the {@link TriggerConfig}. For - Api Trigger, the client id is required and will be validated against - the allowed clients. + Output only. An increasing sequence that is set when a new snapshot + is created + readOnly: true + updateTime: + description: Output only. Last modified time of the execution. + readOnly: true type: string - GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: - id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest - type: object - description: Request to enable/disable variable masking for a provisioned client - properties: - enableVariableMasking: - type: boolean - description: >- - Required. REQUIRED: True if variable masking feature should be - turned on for this region - EnterpriseCrmEventbusProtoConnectorsConnection: - id: EnterpriseCrmEventbusProtoConnectorsConnection + format: google-datetime + cloudLoggingDetails: + description: Cloud Logging details for the integration version + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + id: GoogleCloudIntegrationsV1alphaExecution + EnterpriseCrmEventbusProtoFailurePolicy: + description: >- + Policy that defines the task retry logic and failure type. If no + FailurePolicy is defined for a task, all its dependent tasks will not be + executed (i.e, a `retry_strategy` of NONE will be applied). + id: EnterpriseCrmEventbusProtoFailurePolicy type: object properties: - serviceName: + intervalInSeconds: type: string + format: int64 description: >- - Service name Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} - host: - type: string + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the initial interval for backoff. + maxNumRetries: + format: int32 + type: integer description: >- - The name of the Hostname of the Service Directory service with TLS - if used. - connectionName: + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the number of times the task will be retried if failed. + retryCondition: type: string description: >- - Connection name Format: - projects/{project}/locations/{location}/connections/{connection} - connectorVersion: - type: string - description: >- - Connector version Format: - projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} - GoogleCloudIntegrationsV1alphaCertificate: - description: The certificate definition - properties: - name: - description: Output only. Auto generated primary key - readOnly: true - type: string - validEndTime: - description: Output only. The timestamp after which certificate will expire - format: google-datetime - readOnly: true - type: string - requestorId: - type: string - description: >- - Immutable. Requestor ID to be used to register certificate with - trawler - certificateStatus: - description: Status of the certificate - enum: - - STATE_UNSPECIFIED - - ACTIVE - - EXPIRED - type: string + Optional. The retry condition that will be evaluated for this + failure policy with the corresponding retry strategy. + retryStrategy: enumDescriptions: - - Unspecified certificate status - - Certificate in active state will be able to use - - Certificate in expired state needs to be updated - credentialId: - type: string - description: Immutable. Credential id that will be used to register with trawler - rawCertificate: - description: >- - Input only. Raw client certificate which would be registered with - trawler - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' - validStartTime: + - '' + - >- + Ignores the failure of this task. The rest of the workflow will be + executed Assuming this task succeeded. + - >- + Causes a permanent failure of the task. However, if the last + task(s) of event was successfully completed despite the failure of + this task, it has no impact on the workflow. + - >- + Causes a permanent failure of the event. It is different from NONE + because this will mark the event as FAILED by shutting down the + event execution. + - >- + The task will be retried from the failed task onwards after a + fixed delay. A max-retry count is required to be specified with + this strategy. A jitter is added to each exponential interval so + that concurrently failing tasks of the same type do not end up + retrying after the exact same exponential interval. + Max_num_retries and interval_in_seconds must be specified. + - >- + The task will be retried from the failed task onwards after a + fixed delay that linearly increases with each retry attempt. A + jitter is added to each exponential interval so that concurrently + failing tasks of the same type do not end up retrying after the + exact same exponential interval. A max-retry count is required to + be specified with this strategy. Max_num_retries and + interval_in_seconds must be specified. + - >- + The task will be retried after an exponentially increasing period + of time with each failure. A jitter is added to each exponential + interval so that concurrently failing tasks of the same type do + not end up retrying after the exact same exponential interval. A + max-retry count is required to be specified with this strategy. + `max_num_retries` and `interval_in_seconds` must be specified. + - >- + The entire workflow will be restarted with the initial parameters + that were set when the event was fired. A max-retry count is + required to be specified with this strategy. `max_num_retries` and + `interval_in_seconds` must be specified. + enum: + - UNSPECIFIED + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_WORKFLOW_WITH_BACKOFF + description: Defines what happens to the task upon failure. type: string - format: google-datetime - description: Output only. The timestamp after which certificate will be valid - readOnly: true - description: + EnterpriseCrmEventbusProtoTaskMetadataAdmin: + id: EnterpriseCrmEventbusProtoTaskMetadataAdmin + type: object + properties: + userEmail: type: string - description: Description of the certificate - displayName: - description: Required. Name of the certificate + googleGroupEmail: type: string + description: >- + Admins are owners of a Task, and have all permissions on a particular + task identified by the task name. By default, Eventbus periodically + scans all task metadata and syncs (adds) any new admins defined here to + Zanzibar. + EnterpriseCrmFrontendsEventbusProtoParameterValueType: + id: EnterpriseCrmFrontendsEventbusProtoParameterValueType + description: 'To support various types of parameter values. Next available id: 14' type: object - id: GoogleCloudIntegrationsV1alphaCertificate - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: properties: - issuer: - description: Value for the "iss" claim. + intArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray + stringValue: type: string - subject: + stringArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + doubleValue: + format: double + type: number + doubleArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + protoValue: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + intValue: + format: int64 type: string - description: Value for the "sub" claim. - audience: + jsonValue: type: string - description: Value for the "aud" claim. - description: JWT claims used for the jwt-bearer authorization grant. - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + booleanValue: + type: boolean + protoArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + booleanArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + GoogleCloudIntegrationsV1alphaBooleanParameterArray: + properties: + booleanValues: + items: + type: boolean + type: array + description: Boolean array. + id: GoogleCloudIntegrationsV1alphaBooleanParameterArray + description: This message only contains a field of boolean array. type: object - EnterpriseCrmEventbusProtoExecutionTraceInfo: - id: EnterpriseCrmEventbusProtoExecutionTraceInfo + EnterpriseCrmFrontendsEventbusProtoIntParameterArray: + type: object + id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray properties: - traceId: + intValues: + items: + type: string + format: int64 + type: array + EnterpriseCrmEventbusProtoConditionalFailurePolicies: + type: object + properties: + defaultFailurePolicy: + description: >- + The default failure policy to be applied if no conditional failure + policy matches + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + failurePolicies: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + description: >- + The list of failure policies that will be applied to the task in + order. + type: array + id: EnterpriseCrmEventbusProtoConditionalFailurePolicies + EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: + id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam + properties: + allowedServiceAccountInContext: + type: boolean + scope: + description: A space-delimited list of requested scope permissions. type: string - description: Used to aggregate ExecutionTraceInfo. - parentEventExecutionInfoId: + authConfigId: + description: UUID of the AuthConfig. type: string + allowedCredentialTypes: + items: + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + enumDescriptions: + - '' + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + type: string + type: array description: >- - Parent event execution info id that triggers the current execution - through SubWorkflowExecutorTask. + Defines the credential types to be supported as Task may restrict + specific types to use, e.g. Cloud SQL Task will use + username/password type only. + useServiceAccountInContext: + type: boolean type: object - description: >- - Message that helps aggregate all sub-executions triggered by one - execution and keeps track of child-parent relationships. - EnterpriseCrmEventbusProtoSuspensionResolutionInfo: + GoogleCloudConnectorsV1ConnectionStatus: type: object - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo properties: status: + description: Status provides detailed information for the state. + type: string + description: + description: Description. + type: string + state: enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - PENDING_UNSPECIFIED - - REJECTED - - LIFTED - - CANCELED - type: string - clientId: - type: string - description: The event data user sends as request. - cloudKmsConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' - description: KMS info, used by cmek/gmek integration - eventExecutionInfoId: - type: string - description: Required. ID of the associated execution. - lastModifiedTimestamp: - description: Auto-generated. - type: string - format: google-datetime - wrappedDek: - format: byte - type: string - description: Wrapped dek - createdTimestamp: - type: string - format: google-datetime - description: Auto-generated. - suspensionConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - externalTraffic: - description: The origin of the suspension for periodic notifications. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' - encryptedSuspensionResolutionInfo: - format: byte - type: string - description: Encrypted SuspensionResolutionInfo - taskNumber: - type: string - description: Required. Task number of the associated SuspensionTask. - audit: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - suspensionId: - description: Primary key for the SuspensionResolutionInfoTable. - type: string - workflowName: - description: Required. The name of the originating workflow. - type: string - product: + - Connection does not have a state yet. + - Connection is being created. + - Connection is running and ready for requests. + - Connection is stopped. + - Connection is being deleted. + - Connection is being updated. + - Connection is not running due to an error. + - >- + Connection is not running because the authorization configuration + is not complete. + description: State. enum: - - UNSPECIFIED_PRODUCT - - IP - - APIGEE - - SECURITY - description: >- - Which Google product the suspension belongs to. If not set, the - suspension belongs to Integration Platform by default. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - EnterpriseCrmEventbusProtoConditionalFailurePolicies: - id: EnterpriseCrmEventbusProtoConditionalFailurePolicies - properties: - failurePolicies: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - description: >- - The list of failure policies that will be applied to the task in - order. - defaultFailurePolicy: - description: >- - The default failure policy to be applied if no conditional failure - policy matches - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - type: object - GoogleCloudIntegrationsV1alphaListExecutionsResponse: - description: Response for listing the integration execution data. - type: object - properties: - nextPageToken: - description: The token used to retrieve the next page results. - type: string - executionInfos: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - deprecated: true - description: Required. The detailed information of requested executions. - executions: - type: array - description: The detailed information of requested executions - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - id: GoogleCloudIntegrationsV1alphaListExecutionsResponse - GoogleCloudIntegrationsV1alphaSuspensionAudit: - description: Contains when and by whom the suspension was resolved. - id: GoogleCloudIntegrationsV1alphaSuspensionAudit - type: object - properties: - resolver: - description: Email address of the person who resolved this suspension. - type: string - resolveTime: - format: google-datetime - description: Time at which this suspension was resolved. - type: string - GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: - properties: - content: - description: The content of downloaded execution. + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - UPDATING + - ERROR + - AUTHORIZATION_REQUIRED type: string + description: ConnectionStatus indicates the state of the connection. + id: GoogleCloudConnectorsV1ConnectionStatus + EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: type: object - id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse - description: Response for downloading an execution. - GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: - properties: {} - description: Response for Suspensions.ResolveSuspensions. - id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse - type: object - GoogleCloudIntegrationsV1alphaParameterMapEntry: - id: GoogleCloudIntegrationsV1alphaParameterMapEntry - type: object - description: Entry is a pair of key and value. - properties: - value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - description: Value of the map entry. - key: - description: Key of the map entry. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - EnterpriseCrmFrontendsEventbusProtoParameterValueType: - description: 'To support various types of parameter values. Next available id: 14' - id: EnterpriseCrmFrontendsEventbusProtoParameterValueType properties: - jsonValue: - type: string - doubleArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray - booleanValue: - type: boolean - protoValue: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - intArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray - doubleValue: - format: double - type: number - stringArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray - stringValue: - type: string - intValue: - type: string - format: int64 - booleanArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray - protoArray: + intRange: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - serializedObjectValue: + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + doubleRange: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - type: object - EnterpriseCrmEventbusProtoCloudSchedulerConfig: - properties: - location: - description: >- - Required. The location where associated cloud scheduler job will be - created - type: string - cronTab: - description: Required. The cron tab of cloud scheduler trigger. - type: string - serviceAccountEmail: - description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time - type: string - errorMessage: - type: string - description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations - id: EnterpriseCrmEventbusProtoCloudSchedulerConfig - description: Cloud Scheduler Trigger configuration - type: object - GoogleCloudConnectorsV1SslConfig: - properties: - clientCertificate: - description: Client Certificate - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - clientCertType: - type: string - enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type - enum: - - CERT_TYPE_UNSPECIFIED - - PEM - description: Type of Client Cert (PEM/JKS/.. etc.) - trustModel: - description: Trust Model of the SSL connection - enumDescriptions: - - Public Trust Model. Takes the Default Java trust store. - - Private Trust Model. Takes custom/private trust store. - - Insecure Trust Model. Accept all certificates. - type: string - enum: - - PUBLIC - - PRIVATE - - INSECURE - additionalVariables: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - type: array - description: Additional SSL related field values - serverCertType: - type: string - enum: - - CERT_TYPE_UNSPECIFIED - - PEM - enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type - description: Type of Server Cert (PEM/JKS/.. etc.) - type: - description: Controls the ssl type for the given connector version. - type: string - enumDescriptions: - - No SSL configuration required. - - TLS Handshake - - mutual TLS (MTLS) Handshake - enum: - - SSL_TYPE_UNSPECIFIED - - TLS - - MTLS - privateServerCertificate: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: >- - Private Server Certificate. Needs to be specified if trust model is - `PRIVATE`. - clientPrivateKey: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Client Private Key - clientPrivateKeyPass: - description: Secret containing the passphrase protecting the Client Private Key - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - useSsl: - type: boolean - description: Bool for enabling SSL - description: SSL Configuration of a connection - id: GoogleCloudConnectorsV1SslConfig - type: object - GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: - id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter - type: object - properties: - value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message or a serialized object. - parameter: - description: >- - Optional. Integration Parameter to provide the default value, data - type and attributes required for the Integration config variables. + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + stringRegex: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - description: >- - Integration Config Parameter is defined in the integration config and - are used to provide external configuration for integration. It provide - information about data types of the expected parameters and provide any - default values or value. They can also be used to add custom attributes. - GoogleCloudConnectorsV1Connection: + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: properties: - status: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' - description: Output only. Current status of the connection. - tlsMigrationState: - description: Output only. Status of the TLS migration. - enumDescriptions: - - TLS migration state is not specified. - - TLS migration is in progress. - - TLS migration is completed. - readOnly: true - type: string - enum: - - TLS_MIGRATION_STATE_UNSPECIFIED - - TLS_MIGRATION_NOT_STARTED - - TLS_MIGRATION_COMPLETED - sslConfig: - description: Optional. Ssl config of a connection - $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' - destinationConfigs: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - description: >- - Optional. Configuration of the Connector's destination. Only - accepted for Connectors that accepts user defined destination(s). - type: array - name: - readOnly: true - type: string - description: >- - Output only. Resource name of the Connection. Format: - projects/{project}/locations/{location}/connections/{connection} - labels: - type: object - description: >- - Optional. Resource labels to represent user-provided metadata. Refer - to cloud documentation on labels for more details. - https://cloud.google.com/compute/docs/labeling-resources - additionalProperties: - type: string - nodeConfig: - description: Optional. Node configuration for the connection. - $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' - logConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' - description: Optional. Log configuration for the connection. - envoyImageLocation: - type: string - description: >- - Output only. GCR location where the envoy image is stored. formatted - like: gcr.io/{bucketName}/{imageName} - readOnly: true - billingConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' - readOnly: true - description: Output only. Billing config for the connection. - connectorVersion: - description: >- - Required. Connector version on which the connection is created. The - format is: - projects/*/locations/*/providers/*/connectors/*/versions/* Only - global location is supported for ConnectorVersion resource. - type: string - configVariables: - type: array - description: >- - Optional. Configuration for configuring the connection with an - external system. - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - serviceAccount: - type: string - description: >- - Optional. Service account needed for runtime plane to access Google - Cloud resources. - updateTime: - readOnly: true + triggerUrl: type: string - description: Output only. Updated time. - format: google-datetime - connectorVersionLaunchStage: - readOnly: true - description: Output only. Flag to mark the version indicating the launch stage. + description: The trigger url that will be returned + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + description: Response for Creating Cloud Function rpc call. + type: object + GoogleCloudIntegrationsV1alphaExecuteEventResponse: + type: object + properties: + executionId: type: string - enumDescriptions: - - LAUNCH_STAGE_UNSPECIFIED. - - PREVIEW. - - GA. - - DEPRECATED. - - PRIVATE_PREVIEW. + description: The id of the execution corresponding to this run of integration. + description: The response for executing an integration. + id: GoogleCloudIntegrationsV1alphaExecuteEventResponse + EnterpriseCrmEventbusProtoField: + description: Information about the value and type of the field. + properties: + fieldType: enum: - - LAUNCH_STAGE_UNSPECIFIED - - PREVIEW - - GA - - DEPRECATED - - PRIVATE_PREVIEW - host: - readOnly: true - description: >- - Output only. The name of the Hostname of the Service Directory - service with TLS. + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + description: Specifies the data type of the field. type: string - lockConfig: + transformExpression: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' description: >- - Optional. Configuration that indicates whether or not the Connection - can be edited. - $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' - isTrustedTester: - type: boolean - readOnly: true - description: Output only. Is trusted tester program enabled for the project. - description: - description: Optional. Description of the resource. + This is the transform expression to fetch the input field value. for + e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can + have a transform expression. 2. If a transform expression is + provided, reference_key will be ignored. 3. If no value is returned + after evaluation of transform expression, default_value can be + mapped if provided. 4. The field_type should be the type of the + final object returned after the transform expression is evaluated. + Scrubs the transform expression before logging as value provided by + user so may or may not contain PII or SPII data. + defaultValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: >- + This holds the default values for the fields. This value is supplied + by user so may or may not contain PII or SPII data. + protoDefPath: type: string - authConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' description: >- - Optional. Configuration for establishing the connection's - authentication with an external system. - subscriptionType: + Optional. The fully qualified proto name (e.g. + enterprise.crm.storage.Account). Required for output field of type + PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES + and output field_type is PROTO_VALUE, then fully qualified proto + type url should be provided to parse the input bytes. If field_type + is *_ARRAY, then all the converted protos are of the same type. + cardinality: type: string + enumDescriptions: + - For fields with unspecified cardinality. + - >- + If field cardinality is set to optional, ignore errors if input + field value is null or the reference_key is not found. description: >- - Output only. This subscription type enum states the subscription - type of the project. - readOnly: true + By default, if the cardinality is unspecified the field is + considered required while mapping. enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAY_G - - PAID - enumDescriptions: - - Unspecified subscription type. - - PayG subscription. - - Paid Subscription. - serviceDirectory: + - UNSPECIFIED + - OPTIONAL + referenceKey: type: string - readOnly: true description: >- - Output only. The name of the Service Directory service name. Used - for Private Harpoon to resolve the ILB address. e.g. - "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" - tlsServiceDirectory: + This holds the reference key of the workflow or task parameter. 1. + Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input + or output parameter, for e.g. $task1_param1$. 3. Any workflow or + task parameters with subfield references, for e.g., + $task1_param1.employee.id$ + type: object + id: EnterpriseCrmEventbusProtoField + EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: + properties: + endTime: + format: int64 + description: The end time of the task execution for current attempt. type: string - description: Output only. The name of the Service Directory service with TLS. - readOnly: true - imageLocation: - description: >- - Output only. GCR location where the runtime image is stored. - formatted like: gcr.io/{bucketName}/{imageName} + startTime: type: string - readOnly: true - eventingEnablementType: description: >- - Optional. Eventing enablement type. Will be nil if eventing is not - enabled. + The start time of the task execution for current attempt. This could + be in the future if it's been scheduled. + format: int64 + type: object + id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats + EnterpriseCrmEventbusProtoBuganizerNotification: + id: EnterpriseCrmEventbusProtoBuganizerNotification + type: object + properties: + title: + description: Title of the issue to be created. Required. type: string - enum: - - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED - - EVENTING_AND_CONNECTION - - ONLY_EVENTING - enumDescriptions: - - Eventing Enablement Type Unspecifeied. - - Both connection and eventing. - - Only Eventing. - connectorVersionInfraConfig: - readOnly: true - description: Output only. Infra configs supported by Connector Version. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig - createTime: - description: Output only. Created time. - readOnly: true + templateId: + format: int64 + description: ID of the buganizer template to use. Optional. type: string - format: google-datetime - connectionRevision: + assigneeEmailAddress: + description: Whom to assign the new bug. Optional. + type: string + componentId: type: string - readOnly: true - format: int64 - description: >- - Output only. Connection revision. This field is only updated when - the connection is created or updated by User. - suspended: - description: >- - Optional. Suspended indicates if a user has suspended a connection - or not. - type: boolean - eventingRuntimeData: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' - description: Output only. Eventing Runtime Data. - readOnly: true - asyncOperationsEnabled: - type: boolean description: >- - Optional. Async operations enabled for the connection. If Async - Operations is enabled, Connection allows the customers to initiate - async long running operations using the actions API. - eventingConfig: - description: Optional. Eventing config of a connection - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' - id: GoogleCloudConnectorsV1Connection - type: object - description: Connection represents an instance of connector. - GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: + ID of the buganizer component within which to create a new issue. + Required. + format: int64 + GoogleCloudIntegrationsV1alphaParameterMapField: properties: - nextPageToken: - description: The token used to retrieve the next page of results. + literalValue: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Passing a literal value. + referenceKey: type: string - sfdcChannels: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' - description: The list of SfdcChannels retrieved. + description: Referencing one of the Integration variables. + id: GoogleCloudIntegrationsV1alphaParameterMapField + description: Field represents either the key or value in an entry. type: object - description: Response to list SfdcChannels. - id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: - properties: - projectId: - description: The created AppsScriptProject ID. - type: string - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: + description: Request for UploadIntegrationVersion. type: object - description: Response for CreateAppsScriptProject rpc call. - EnterpriseCrmEventbusProtoTeardownTaskConfig: properties: - nextTeardownTask: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' - creatorEmail: - description: The creator's email address. - type: string - name: - description: >- - Required. Unique identifier of the teardown task within this Config. - We use this field as the identifier to find next teardown tasks. + fileFormat: + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML type: string - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters the user can pass to this task. - teardownTaskImplementationClassName: + description: File format for upload request. + content: + description: The textproto of the integration_version. type: string - description: Required. Implementation class name. - properties: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' - id: EnterpriseCrmEventbusProtoTeardownTaskConfig + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: + id: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue type: object - GoogleCloudConnectorsV1EventingRuntimeData: - id: GoogleCloudConnectorsV1EventingRuntimeData + description: >- + The threshold value of the metric, above or below which the alert should + be triggered. See EventAlertConfig or TaskAlertConfig for the different + alert metric types in each case. For the *RATE metrics, one or both of + these fields may be set. Zero is the default value and can be left at + that. For *PERCENTILE_DURATION metrics, one or both of these fields may + be set, and also, the duration threshold value should be specified in + the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, + these fields should not be set at all. A different member, + threshold_duration_ms, must be set in the EventAlertConfig or the + TaskAlertConfig. properties: - eventsListenerPscSa: - description: >- - Output only. Events listener PSC Service attachment. The value will - be populated after provisioning the events listener with private - connectivity enabled. - readOnly: true - type: string - eventsListenerEndpoint: - readOnly: true - description: >- - Output only. Events listener endpoint. The value will populated - after provisioning the events listener. + percentage: + type: integer + format: int32 + absolute: type: string - status: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' - description: Output only. Current status of eventing. - readOnly: true - webhookData: - description: Output only. Webhook data. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + format: int64 + GoogleCloudIntegrationsV1alphaGetClientResponse: + id: GoogleCloudIntegrationsV1alphaGetClientResponse + description: Response for the GetClient rpc type: object - description: >- - Eventing runtime data has the details related to eventing managed by the - system. + properties: + client: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' + description: 'Required. Required: The client configuration that was requested' + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: + properties: + max: + type: number + description: The inclusive maximum of the acceptable range. + format: double + min: + description: The inclusive minimum of the acceptable range. + format: double + type: number + description: Range used to validate doubles and floats. + type: object + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -9223,13 +9199,10 @@ components: enum: - '1' - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token schema: type: string oauth_token: @@ -9248,1119 +9221,1120 @@ components: - json - media - proto + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string x-stackQL-resources: - callback: - id: google.integrations.callback - name: callback - title: Callback - methods: - callback_generate_token: - operation: - $ref: '#/paths/~1v1~1callback:generateToken/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - connector_platform_regions: - id: google.integrations.connector_platform_regions - name: connector_platform_regions - title: Connector_platform_regions + versions: + id: google.integrations.versions + name: versions + title: Versions methods: - connector_platform_regions_enumerate: + projects_locations_integrations_versions_publish: operation: - $ref: '#/paths/~1v1~1connectorPlatformRegions:enumerate/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - clientmetadata: - id: google.integrations.clientmetadata - name: clientmetadata - title: Clientmetadata - methods: - projects_get_clientmetadata: + projects_locations_integrations_versions_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata - insert: [] - update: [] - replace: [] - delete: [] - clients: - id: google.integrations.clients - name: clients - title: Clients - methods: - projects_locations_get_clients: + projects_locations_integrations_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_switch: + objectKey: $.integrationVersions + projects_locations_integrations_versions_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_deprovision: + projects_locations_integrations_versions_download_json_package: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:downloadJsonPackage/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_provision: + projects_locations_integrations_versions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_switch_variable_masking: + projects_locations_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_replace: + projects_locations_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/clients/methods/projects_locations_clients_replace - delete: [] - auth_configs: - id: google.integrations.auth_configs - name: auth_configs - title: Auth_configs - methods: - projects_locations_auth_configs_list: + projects_locations_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_auth_configs_create: + projects_locations_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_get: + projects_locations_products_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_delete: + projects_locations_products_integrations_versions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_patch: + projects_locations_products_integrations_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_create: + objectKey: $.integrationVersions + projects_locations_products_integrations_versions_takeover_edit_lock: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_list: + projects_locations_products_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_products_auth_configs_patch: + projects_locations_products_integrations_versions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_get: + projects_locations_products_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_delete: + projects_locations_products_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_integrations_versions_upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_integrations_versions_publish: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_get + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_get + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_list + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_list + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list insert: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_create + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_create - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_create + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_create update: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_patch + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_patch - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_patch + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_delete - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_delete - connections_connection_schema_metadata: - id: google.integrations.connections_connection_schema_metadata - name: connections_connection_schema_metadata - title: Connections_connection_schema_metadata - methods: - projects_locations_connections_get_connection_schema_metadata: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections_connection_schema_metadata/methods/projects_locations_connections_get_connection_schema_metadata - insert: [] - update: [] - replace: [] - delete: [] - connections: - id: google.integrations.connections - name: connections - title: Connections - methods: - projects_locations_connections_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.connections - sqlVerbs: - select: + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_delete - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - insert: [] - update: [] - replace: [] - delete: [] - runtime_action_schemas: - id: google.integrations.runtime_action_schemas - name: runtime_action_schemas - title: Runtime_action_schemas + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_delete + suspensions: + id: google.integrations.suspensions + name: suspensions + title: Suspensions methods: - projects_locations_connections_runtime_action_schemas_list: + projects_locations_integrations_executions_suspensions_lift: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeActionSchemas/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runtimeActionSchemas - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/runtime_action_schemas/methods/projects_locations_connections_runtime_action_schemas_list - insert: [] - update: [] - replace: [] - delete: [] - runtime_entity_schemas: - id: google.integrations.runtime_entity_schemas - name: runtime_entity_schemas - title: Runtime_entity_schemas - methods: - projects_locations_connections_runtime_entity_schemas_list: + projects_locations_integrations_executions_suspensions_resolve: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeEntitySchemas/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runtimeEntitySchemas - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/runtime_entity_schemas/methods/projects_locations_connections_runtime_entity_schemas_list - insert: [] - update: [] - replace: [] - delete: [] - sfdc_instances: - id: google.integrations.sfdc_instances - name: sfdc_instances - title: Sfdc_instances - methods: - projects_locations_sfdc_instances_get: + projects_locations_integrations_executions_suspensions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_patch: + objectKey: $.suspensions + projects_locations_products_integrations_executions_suspensions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_delete: + objectKey: $.suspensions + projects_locations_products_integrations_executions_suspensions_lift: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_list: + projects_locations_products_integrations_executions_suspensions_resolve: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_sfdc_instances_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/suspensions/methods/projects_locations_products_integrations_executions_suspensions_list + - $ref: >- + #/components/x-stackQL-resources/suspensions/methods/projects_locations_integrations_executions_suspensions_list + insert: [] + update: [] + replace: [] + delete: [] + executions: + id: google.integrations.executions + name: executions + title: Executions + methods: + projects_locations_integrations_executions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_create: + objectKey: $.executions + projects_locations_integrations_executions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_list: + projects_locations_integrations_executions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_products_sfdc_instances_delete: + projects_locations_products_integrations_executions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_patch: + projects_locations_products_integrations_executions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_get: + projects_locations_products_integrations_executions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.executions sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list - insert: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create + #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_get - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_create - update: + #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_get - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_patch + #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_list - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_patch + #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_list + insert: [] + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete - sfdc_channels: - id: google.integrations.sfdc_channels - name: sfdc_channels - title: Sfdc_channels + delete: [] + integrations: + id: google.integrations.integrations + name: integrations + title: Integrations methods: - projects_locations_sfdc_instances_sfdc_channels_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_patch: + projects_locations_integrations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_delete: + objectKey: $.integrations + projects_locations_integrations_execute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_list: + projects_locations_integrations_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcChannels - projects_locations_sfdc_instances_sfdc_channels_create: + projects_locations_integrations_test: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_list: + projects_locations_integrations_schedule: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcChannels - projects_locations_products_sfdc_instances_sfdc_channels_create: + projects_locations_products_integrations_test: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:test/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_get: + projects_locations_products_integrations_execute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_delete: + projects_locations_products_integrations_schedule: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:schedule/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_patch: + projects_locations_products_integrations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.integrations sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_list - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_list - insert: - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_create - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_create - update: - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_patch + #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_patch + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list + insert: [] + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_delete - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_delete - templates: - id: google.integrations.templates - name: templates - title: Templates + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete + skip_this_resource: + id: google.integrations.skip_this_resource + name: skip_this_resource + title: Skip_this_resource methods: - projects_locations_templates_unshare: + projects_locations_integrations_execute_event: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:unshare/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_share: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + connections_connection_schema_metadata: + id: google.integrations.connections_connection_schema_metadata + name: connections_connection_schema_metadata + title: Connections_connection_schema_metadata + methods: + projects_locations_connections_get_connection_schema_metadata: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:share/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections_connection_schema_metadata/methods/projects_locations_connections_get_connection_schema_metadata + insert: [] + update: [] + replace: [] + delete: [] + connections: + id: google.integrations.connections + name: connections + title: Connections + methods: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_patch: + objectKey: $.connections + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + insert: [] + update: [] + replace: [] + delete: [] + runtime_action_schemas: + id: google.integrations.runtime_action_schemas + name: runtime_action_schemas + title: Runtime_action_schemas + methods: + projects_locations_connections_runtime_action_schemas_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeActionSchemas/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_get: + objectKey: $.runtimeActionSchemas + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_action_schemas/methods/projects_locations_connections_runtime_action_schemas_list + insert: [] + update: [] + replace: [] + delete: [] + runtime_entity_schemas: + id: google.integrations.runtime_entity_schemas + name: runtime_entity_schemas + title: Runtime_entity_schemas + methods: + projects_locations_connections_runtime_entity_schemas_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeEntitySchemas/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_import: + objectKey: $.runtimeEntitySchemas + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_entity_schemas/methods/projects_locations_connections_runtime_entity_schemas_list + insert: [] + update: [] + replace: [] + delete: [] + templates: + id: google.integrations.templates + name: templates + title: Templates + methods: + projects_locations_templates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_download: + projects_locations_templates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_search: + projects_locations_templates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:search/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_list: + projects_locations_templates_share: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:share/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.templates - projects_locations_templates_create: + projects_locations_templates_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_upload: + projects_locations_templates_use: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:use/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_use: + projects_locations_templates_import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:use/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:import/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_get - - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_list - insert: - - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_create - update: - - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_delete - cloud_functions: - id: google.integrations.cloud_functions - name: cloud_functions - title: Cloud_functions - methods: - projects_locations_cloud_functions_create: + projects_locations_templates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_cloud_functions_create: + objectKey: $.templates + projects_locations_templates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_products_cloud_functions_create - - $ref: >- - #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create - update: [] - replace: [] - delete: [] - integrations: - id: google.integrations.integrations - name: integrations - title: Integrations - methods: - projects_locations_integrations_execute: + projects_locations_templates_unshare: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:unshare/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_test: + projects_locations_templates_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_list: + projects_locations_templates_search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:search/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations - projects_locations_integrations_schedule: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_get + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_list + insert: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_create + update: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_delete + clients: + id: google.integrations.clients + name: clients + title: Clients + methods: + projects_locations_clients_replace: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_delete: + projects_locations_clients_deprovision: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_list: + projects_locations_clients_switch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations - projects_locations_products_integrations_execute: + projects_locations_clients_switch_variable_masking: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_test: + projects_locations_clients_provision: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:test/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_schedule: + projects_locations_get_clients: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:schedule/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list - - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list + #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients insert: [] update: [] - replace: [] - delete: + replace: - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete - skip_this_resource: - id: google.integrations.skip_this_resource - name: skip_this_resource - title: Skip_this_resource - methods: - projects_locations_integrations_execute_event: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] + #/components/x-stackQL-resources/clients/methods/projects_locations_clients_replace delete: [] - executions: - id: google.integrations.executions - name: executions - title: Executions + auth_configs: + id: google.integrations.auth_configs + name: auth_configs + title: Auth_configs methods: - projects_locations_integrations_executions_get: + projects_locations_auth_configs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_download: + objectKey: $.authConfigs + projects_locations_auth_configs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_list: + projects_locations_auth_configs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions - projects_locations_products_integrations_executions_download: + projects_locations_auth_configs_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_list: + projects_locations_auth_configs_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions - projects_locations_products_integrations_executions_get: + projects_locations_products_auth_configs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_get - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_get - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_list - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_list - insert: [] - update: [] - replace: [] - delete: [] - suspensions: - id: google.integrations.suspensions - name: suspensions - title: Suspensions - methods: - projects_locations_integrations_executions_suspensions_resolve: + projects_locations_products_auth_configs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_suspensions_lift: + objectKey: $.authConfigs + projects_locations_products_auth_configs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_suspensions_list: + projects_locations_products_auth_configs_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.suspensions - projects_locations_products_integrations_executions_suspensions_list: + projects_locations_products_auth_configs_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.suspensions - projects_locations_products_integrations_executions_suspensions_resolve: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_get + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_get + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_list + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_create + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_patch + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_delete + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_delete + cloud_functions: + id: google.integrations.cloud_functions + name: cloud_functions + title: Cloud_functions + methods: + projects_locations_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_suspensions_lift: + projects_locations_products_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: + select: [] + insert: - $ref: >- - #/components/x-stackQL-resources/suspensions/methods/projects_locations_products_integrations_executions_suspensions_list + #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_products_cloud_functions_create - $ref: >- - #/components/x-stackQL-resources/suspensions/methods/projects_locations_integrations_executions_suspensions_list - insert: [] + #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create update: [] replace: [] delete: [] - versions: - id: google.integrations.versions - name: versions - title: Versions + sfdc_channels: + id: google.integrations.sfdc_channels + name: sfdc_channels + title: Sfdc_channels methods: - projects_locations_integrations_versions_get: + projects_locations_sfdc_instances_sfdc_channels_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_delete: + projects_locations_sfdc_instances_sfdc_channels_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_patch: + projects_locations_sfdc_instances_sfdc_channels_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_list: + projects_locations_sfdc_instances_sfdc_channels_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_integrations_versions_create: + objectKey: $.sfdcChannels + projects_locations_sfdc_instances_sfdc_channels_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_download_json_package: + projects_locations_products_sfdc_instances_sfdc_channels_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:downloadJsonPackage/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_upload: + objectKey: $.sfdcChannels + projects_locations_products_sfdc_instances_sfdc_channels_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_unpublish: + projects_locations_products_sfdc_instances_sfdc_channels_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_publish: + projects_locations_products_sfdc_instances_sfdc_channels_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_download: + projects_locations_products_sfdc_instances_sfdc_channels_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_publish: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_list + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_create + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_create + update: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_patch + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_delete + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_delete + sfdc_instances: + id: google.integrations.sfdc_instances + name: sfdc_instances + title: Sfdc_instances + methods: + projects_locations_sfdc_instances_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_download: + projects_locations_sfdc_instances_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_upload: + projects_locations_sfdc_instances_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_delete: + projects_locations_sfdc_instances_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_get: + objectKey: $.sfdcInstances + projects_locations_sfdc_instances_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_patch: + projects_locations_products_sfdc_instances_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_takeover_edit_lock: + projects_locations_products_sfdc_instances_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_unpublish: + projects_locations_products_sfdc_instances_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_list: + projects_locations_products_sfdc_instances_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_products_integrations_versions_create: + objectKey: $.sfdcInstances + projects_locations_products_sfdc_instances_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list insert: - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_create + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_create + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_create update: - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_patch + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_patch - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_patch + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_delete + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_delete + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete + apps_script_projects: + id: google.integrations.apps_script_projects + name: apps_script_projects + title: Apps_script_projects + methods: + projects_locations_apps_script_projects_link: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_apps_script_projects_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create + update: [] + replace: [] + delete: [] certificates: id: google.integrations.certificates name: certificates title: Certificates methods: - projects_locations_products_certificates_delete: + projects_locations_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_get: + projects_locations_certificates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_patch: + objectKey: $.certificates + projects_locations_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_list: + projects_locations_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.certificates - projects_locations_products_certificates_create: + projects_locations_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_list: + projects_locations_products_certificates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificates - projects_locations_certificates_create: + projects_locations_products_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_patch: + projects_locations_products_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_get: + projects_locations_products_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_delete: + projects_locations_products_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -10368,10 +10342,10 @@ components: select: - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_get - - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_list - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_get + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_list - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_list insert: @@ -10390,53 +10364,133 @@ components: #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_delete - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_delete - apps_script_projects: - id: google.integrations.apps_script_projects - name: apps_script_projects - title: Apps_script_projects + clientmetadata: + id: google.integrations.clientmetadata + name: clientmetadata + title: Clientmetadata methods: - projects_locations_apps_script_projects_link: + projects_get_clientmetadata: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_apps_script_projects_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata + insert: [] + update: [] + replace: [] + delete: [] + callback: + id: google.integrations.callback + name: callback + title: Callback + methods: + callback_generate_token: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post + $ref: '#/paths/~1v1~1callback:generateToken/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create + insert: [] + update: [] + replace: [] + delete: [] + connector_platform_regions: + id: google.integrations.connector_platform_regions + name: connector_platform_regions + title: Connector_platform_regions + methods: + connector_platform_regions_enumerate: + operation: + $ref: '#/paths/~1v1~1connectorPlatformRegions:enumerate/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] update: [] replace: [] delete: [] paths: - /v1/callback:generateToken: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' - get: + - $ref: '#/components/parameters/uploadType' + post: description: >- - Receives the auth code and auth config id to combine that with the - client id and secret to retrieve access tokens from the token endpoint. - Returns either a success or error message when it's done. - operationId: integrations.callback.generateToken + This RPC throws an exception if the integration is in ARCHIVED or ACTIVE + state. This RPC throws an exception if the version being published is + DRAFT, and if the `locked_by` user is not the same as the user + performing the Publish. Audit fields updated include + last_published_timestamp, last_published_by, last_modified_timestamp, + last_modified_by. Any existing lock is on this integration is released. + operationId: integrations.projects.locations.integrations.versions.publish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: + parameters: *ref_1 + post: + description: Create a integration with a draft version in the specified project. + operationId: integrations.projects.locations.integrations.versions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10449,52 +10503,34 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - - in: query - name: gcpProjectId + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: code + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: state + - in: path + name: integrationsId + required: true schema: type: string - in: query - name: redirectUri + name: newIntegration schema: - type: string + type: boolean - in: query - name: product + name: createSampleIntegrations schema: - type: string - /v1/connectorPlatformRegions:enumerate: - parameters: *ref_1 - get: - description: Enumerates the regions for which Connector Platform is provisioned. - operationId: integrations.connectorPlatformRegions.enumerate - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse - parameters: [] - /v1/projects/{projectsId}/clientmetadata: - parameters: *ref_1 + type: boolean get: - description: Gets the metadata info for the requested client - operationId: integrations.projects.getClientmetadata + description: Returns the list of all integration versions in the specified project. + operationId: integrations.projects.locations.integrations.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10507,20 +10543,61 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: fieldMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: parameters: *ref_1 - get: + post: description: >- - Gets the client configuration for the given project and location - resource name - operationId: integrations.projects.locations.getClients + Uploads an integration. The content can be a previously downloaded + integration. Performs the same function as + CreateDraftIntegrationVersion, but accepts input in a string format, + which holds the complete representation of the IntegrationVersion + content. + operationId: integrations.projects.locations.integrations.versions.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10533,7 +10610,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -10545,13 +10622,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: parameters: *ref_1 get: description: >- - Lists all auth configs that match the filter. Restrict to auth configs - belong to the current client only. - operationId: integrations.projects.locations.authConfigs.list + Downloads an Integration version package like + IntegrationVersion,Integration Config etc. Retrieves the + IntegrationVersion package for a given `integration_id` and returns the + response as a JSON. + operationId: >- + integrations.projects.locations.integrations.versions.downloadJsonPackage security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10564,7 +10649,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse parameters: - in: path name: projectsId @@ -10576,36 +10661,31 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: integrationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: versionsId + required: true schema: type: string - in: query - name: pageToken + name: files schema: type: string - post: - description: >- - Creates an auth config record. Fetch corresponding credentials for - specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. - Encrypt the auth config with Cloud KMS and store the encrypted - credentials in Spanner. Returns the encrypted auth config. - operationId: integrations.projects.locations.authConfigs.create + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: + parameters: *ref_1 + patch: + description: Update a integration with a draft version in the specified project. + operationId: integrations.projects.locations.integrations.versions.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10617,7 +10697,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -10629,26 +10710,33 @@ paths: required: true schema: type: string - - in: query - name: clientCertificate.encryptedPrivateKey + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: clientCertificate.sslCertificate + - in: path + name: versionsId + required: true schema: type: string - in: query - name: clientCertificate.passphrase + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: - parameters: *ref_1 - get: + format: google-fieldmask + delete: description: >- - Gets a complete auth config. If the auth config doesn't exist, - Code.NOT_FOUND exception will be thrown. Returns the decrypted auth - config. - operationId: integrations.projects.locations.authConfigs.get + Soft-deletes the integration. Changes the status of the integration to + ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag + is removed from this snapshot and set to the previous non-ARCHIVED + snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. + This RPC throws an exception if the version being deleted is DRAFT, and + if the `locked_by` user is not the same as the user performing the + Delete. Audit fields updated include last_modified_timestamp, + last_modified_by. Any existing lock is released when Deleting a + integration. Currently, there is no undelete mechanism. + operationId: integrations.projects.locations.integrations.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10660,7 +10748,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10673,13 +10761,18 @@ paths: schema: type: string - in: path - name: authConfigsId + name: integrationsId required: true schema: type: string - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.authConfigs.delete + - in: path + name: versionsId + required: true + schema: + type: string + get: + description: Get a integration in the specified project. + operationId: integrations.projects.locations.integrations.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10691,7 +10784,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -10704,23 +10798,31 @@ paths: schema: type: string - in: path - name: authConfigsId + name: integrationsId required: true schema: type: string - patch: + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + parameters: *ref_1 + post: description: >- - Updates an auth config. If credential is updated, fetch the encrypted - auth config from Spanner, decrypt with Cloud KMS key, update the - credential fields, re-encrypt with Cloud KMS key and update the Spanner - record. For other fields, directly update the Spanner record. Returns - the encrypted auth config. - operationId: integrations.projects.locations.authConfigs.patch + Sets the status of the ACTIVE integration to SNAPSHOT with a new tag + "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and + "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if + the version being snapshot is not ACTIVE. Audit fields added include + action, action_by, action_timestamp. + operationId: integrations.projects.locations.integrations.versions.unpublish requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10732,7 +10834,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10745,32 +10847,22 @@ paths: schema: type: string - in: path - name: authConfigsId + name: integrationsId required: true schema: type: string - - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: updateMask + - in: path + name: versionsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: parameters: *ref_1 get: - description: Lists the available entities and actions associated with a Connection. - operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata + description: >- + Downloads an integration. Retrieves the `IntegrationVersion` for a given + `integration_id` and returns the response as a string. + operationId: integrations.projects.locations.integrations.versions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10783,7 +10875,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -10796,15 +10888,37 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections: + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: files + schema: + type: string + - in: query + name: fileFormat + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: parameters: *ref_1 - get: - description: Lists Connections in a given project and location. - operationId: integrations.projects.locations.connections.list + post: + description: >- + * Lifts suspension for the Suspension task. Fetch corresponding + suspension with provided suspension Id, resolve suspension, and set up + suspension result for the Suspension Task. + operationId: integrations.projects.locations.integrations.executions.suspensions.lift + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10817,7 +10931,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -10829,30 +10943,36 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: executionsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: suspensionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: parameters: *ref_1 - get: + post: description: >- - Lists the JSON schemas for the inputs and outputs of actions, filtered - by action name. - operationId: integrations.projects.locations.connections.runtimeActionSchemas.list + * Resolves (lifts/rejects) any number of suspensions. If the integration + is already running, only the status of the suspension is updated. + Otherwise, the suspended integration will begin execution again. + operationId: >- + integrations.projects.locations.integrations.executions.suspensions.resolve + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10865,7 +10985,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -10878,30 +10998,28 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: executionsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: suspensionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: parameters: *ref_1 get: description: >- - Lists the JSON schemas for the properties of runtime entities, filtered - by entity name. - operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list + * Lists suspensions associated with a specific execution. Only those + with permissions to resolve the relevant suspensions will be able to + view them. + operationId: integrations.projects.locations.integrations.executions.suspensions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10914,7 +11032,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse parameters: - in: path name: projectsId @@ -10927,7 +11045,12 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId + required: true + schema: + type: string + - in: path + name: executionsId required: true schema: type: string @@ -10936,7 +11059,7 @@ paths: schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - in: query @@ -10944,13 +11067,19 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions: parameters: *ref_1 get: description: >- - Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.sfdcInstances.get + Lists the results of all the integration executions. The response + includes the same information as the [execution + log](https://cloud.google.com/application-integration/docs/viewing-logs) + in the Integration UI. + operationId: integrations.projects.locations.integrations.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10963,7 +11092,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse parameters: - in: path name: projectsId @@ -10976,20 +11105,99 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - patch: - description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + - in: query + name: filterParams.parameterValue + schema: + type: string + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filterParams.parameterPairKey + schema: + type: string + - in: query + name: filterParams.parameterKey + schema: + type: string + - in: query + name: filterParams.parameterType + schema: + type: string + - in: query + name: filterParams.eventStatuses + schema: + type: string + - in: query + name: filterParams.executionId + schema: + type: string + - in: query + name: refreshAcl + schema: + type: boolean + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: filterParams.parameterPairValue + schema: + type: string + - in: query + name: filterParams.customFilter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filterParams.workflowName + schema: + type: string + - in: query + name: filterParams.taskStatuses + schema: + type: string + - in: query + name: filterParams.startTime + schema: + type: string + format: int64 + - in: query + name: filterParams.endTime + schema: + type: string + format: int64 + - in: query + name: truncateParams + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: + parameters: *ref_1 + get: + description: Download the execution. + operationId: integrations.projects.locations.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11002,7 +11210,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -11015,18 +11223,20 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: executionsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.delete + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: + parameters: *ref_1 + get: + description: Get an execution in the specified project. + operationId: integrations.projects.locations.integrations.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11038,7 +11248,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' parameters: - in: path name: projectsId @@ -11051,17 +11261,20 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: + - in: path + name: executionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations: parameters: *ref_1 get: - description: >- - Lists all sfdc instances that match the filter. Restrict to sfdc - instances belonging to the current client only. - operationId: integrations.projects.locations.sfdcInstances.list + description: Returns the list of all integrations in the specified project. + operationId: integrations.projects.locations.integrations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11074,7 +11287,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -11086,11 +11299,6 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: pageToken schema: @@ -11100,20 +11308,32 @@ paths: schema: type: string - in: query - name: readMask + name: orderBy schema: type: string - format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: + parameters: *ref_1 post: description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.create + Executes integrations synchronously by passing the trigger id in the + request body. The request is not returned until the requested executions + are either fulfilled or experienced an error. If the integration name is + not specified (passing `-`), all of the associated integration under the + given trigger_id will be executed. Otherwise only the specified + integration for the given `trigger_id` is executed. This is helpful for + execution the integration from UI. + operationId: integrations.projects.locations.integrations.execute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11126,37 +11346,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: - parameters: *ref_1 - get: - description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -11169,25 +11359,18 @@ paths: schema: type: string - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: integrationsId required: true schema: type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: + parameters: *ref_1 + post: description: >- - Updates an sfdc channel. Updates the sfdc channel in spanner. Returns - the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + Executes an integration on receiving events from Integration Connector + triggers, Eventarc or CPS Trigger. Input data to integration is received + in body in json format + operationId: integrations.projects.locations.integrations.executeEvent security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11199,7 +11382,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse parameters: - in: path name: projectsId @@ -11212,23 +11396,19 @@ paths: schema: type: string - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: integrationsId required: true schema: type: string - in: query - name: updateMask + name: triggerId schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: + parameters: *ref_1 delete: - description: Deletes an sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete + description: Delete the selected integration and all versions inside + operationId: integrations.projects.locations.integrations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11253,22 +11433,21 @@ paths: schema: type: string - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: parameters: *ref_1 - get: - description: >- - Lists all sfdc channels that match the filter. Restrict to sfdc channels - belonging to the current client only. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.list + post: + description: Execute the integration in draft state + operationId: integrations.projects.locations.integrations.test + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11281,7 +11460,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -11294,38 +11473,23 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: + parameters: *ref_1 post: description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create + Schedules an integration for execution by passing the trigger id and the + scheduled time in the request body. + operationId: integrations.projects.locations.integrations.schedule requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11337,7 +11501,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -11350,25 +11515,15 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare: + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: parameters: *ref_1 - post: - description: >- - Unshare a template from given clients. Owner of the template can unshare - template with clients. Shared client can only unshare the template from - itself. PERMISSION_DENIED would be thrown if request is not from owner - or for unsharing itself. - operationId: integrations.projects.locations.templates.unshare - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnshareTemplateRequest + get: + description: Lists the available entities and actions associated with a Connection. + operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11380,7 +11535,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata parameters: - in: path name: projectsId @@ -11393,24 +11549,15 @@ paths: schema: type: string - in: path - name: templatesId + name: connectionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share: + /v1/projects/{projectsId}/locations/{locationsId}/connections: parameters: *ref_1 - post: - description: >- - Share a template with other clients. Only the template owner can share - the templates with other projects. PERMISSION_DENIED would be thrown if - the request is not from the owner. - operationId: integrations.projects.locations.templates.share - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaShareTemplateRequest + get: + description: Lists Connections in a given project and location. + operationId: integrations.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11422,28 +11569,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken schema: type: string - - in: path - name: templatesId - required: true + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: parameters: *ref_1 - delete: - description: Deletes a template - operationId: integrations.projects.locations.templates.delete + get: + description: >- + Lists the JSON schemas for the inputs and outputs of actions, filtered + by action name. + operationId: integrations.projects.locations.connections.runtimeActionSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11455,7 +11617,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse parameters: - in: path name: projectsId @@ -11468,18 +11631,30 @@ paths: schema: type: string - in: path - name: templatesId + name: connectionsId required: true schema: type: string - patch: - description: Updates the template by given id. - operationId: integrations.projects.locations.templates.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: + parameters: *ref_1 + get: + description: >- + Lists the JSON schemas for the properties of runtime entities, filtered + by entity name. + operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11491,7 +11666,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse parameters: - in: path name: projectsId @@ -11504,15 +11680,25 @@ paths: schema: type: string - in: path - name: templatesId + name: connectionsId required: true schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}: + parameters: *ref_1 get: description: Get a template in the specified project. operationId: integrations.projects.locations.templates.get @@ -11544,20 +11730,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import: - parameters: *ref_1 - post: - description: >- - Import the template to an existing integration. This api would keep - track of usage_count and last_used_time. PERMISSION_DENIED would be - thrown if template is not accessible by client. - operationId: integrations.projects.locations.templates.import + patch: + description: Updates the template by given id. + operationId: integrations.projects.locations.templates.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11569,8 +11749,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -11587,13 +11766,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download: - parameters: *ref_1 - get: - description: >- - Downloads a template. Retrieves the `Template` and returns the response - as a string. - operationId: integrations.projects.locations.templates.download + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a template + operationId: integrations.projects.locations.templates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11605,8 +11785,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTemplateResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11623,17 +11802,20 @@ paths: required: true schema: type: string - - in: query - name: fileFormat - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates:search: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share: parameters: *ref_1 - get: + post: description: >- - Search templates based on user query and filters. This api would query - the templates and return a list of templates based on the user filter. - operationId: integrations.projects.locations.templates.search + Share a template with other clients. Only the template owner can share + the templates with other projects. PERMISSION_DENIED would be thrown if + the request is not from the owner. + operationId: integrations.projects.locations.templates.share + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaShareTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11645,8 +11827,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSearchTemplatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11658,33 +11839,26 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask + - in: path + name: templatesId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/templates: + /v1/projects/{projectsId}/locations/{locationsId}/templates:upload: parameters: *ref_1 - get: - description: Lists all templates matching the filter. - operationId: integrations.projects.locations.templates.list + post: + description: >- + Uploads a template. The content can be a previously downloaded template. + Performs the same function as CreateTemplate, but accepts input in a + string format, which holds the complete representation of the Template + content. + operationId: integrations.projects.locations.templates.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11697,7 +11871,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListTemplatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateResponse parameters: - in: path name: projectsId @@ -11709,36 +11883,20 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use: + parameters: *ref_1 post: - description: Creates a new template - operationId: integrations.projects.locations.templates.create + description: >- + Use the template to create integration. This api would keep track of + usage_count and last_used_time. PERMISSION_DENIED would be thrown if + template is not accessible by client. + operationId: integrations.projects.locations.templates.use requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11750,7 +11908,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateResponse parameters: - in: path name: projectsId @@ -11762,21 +11921,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates:upload: + - in: path + name: templatesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import: parameters: *ref_1 post: description: >- - Uploads a template. The content can be a previously downloaded template. - Performs the same function as CreateTemplate, but accepts input in a - string format, which holds the complete representation of the Template - content. - operationId: integrations.projects.locations.templates.upload + Import the template to an existing integration. This api would keep + track of usage_count and last_used_time. PERMISSION_DENIED would be + thrown if template is not accessible by client. + operationId: integrations.projects.locations.templates.import requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11789,7 +11952,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateResponse parameters: - in: path name: projectsId @@ -11801,20 +11964,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use: - parameters: *ref_1 - post: - description: >- - Use the template to create integration. This api would keep track of - usage_count and last_used_time. PERMISSION_DENIED would be thrown if - template is not accessible by client. - operationId: integrations.projects.locations.templates.use - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequest + - in: path + name: templatesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates: + parameters: *ref_1 + get: + description: Lists all templates matching the filter. + operationId: integrations.projects.locations.templates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11827,7 +11986,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListTemplatesResponse parameters: - in: path name: projectsId @@ -11839,22 +11998,36 @@ paths: required: true schema: type: string - - in: path - name: templatesId - required: true + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: - parameters: *ref_1 post: - description: Update client from GMEK to CMEK - operationId: integrations.projects.locations.clients.switch + description: Creates a new template + operationId: integrations.projects.locations.templates.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11866,7 +12039,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -11878,19 +12051,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare: parameters: *ref_1 post: description: >- - Perform the deprovisioning steps to disable a user GCP project to use IP - and purge all related data in a wipeout-compliant way. - operationId: integrations.projects.locations.clients.deprovision + Unshare a template from given clients. Owner of the template can unshare + template with clients. Shared client can only unshare the template from + itself. PERMISSION_DENIED would be thrown if request is not from owner + or for unsharing itself. + operationId: integrations.projects.locations.templates.unshare requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaUnshareTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11914,20 +12089,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: + - in: path + name: templatesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download: parameters: *ref_1 - post: + get: description: >- - Perform the provisioning steps to enable a user GCP project to use IP. - If GCP project already registered on IP end via Apigee Integration, - provisioning will fail. - operationId: integrations.projects.locations.clients.provision - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest + Downloads a template. Retrieves the `Template` and returns the response + as a string. + operationId: integrations.projects.locations.templates.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11939,7 +12112,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTemplateResponse parameters: - in: path name: projectsId @@ -11951,17 +12125,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: + - in: path + name: templatesId + required: true + schema: + type: string + - in: query + name: fileFormat + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates:search: parameters: *ref_1 - post: - description: Update variable masking for provisioned client - operationId: integrations.projects.locations.clients.switchVariableMasking - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + get: + description: >- + Search templates based on user query and filters. This api would query + the templates and return a list of templates based on the user filter. + operationId: integrations.projects.locations.templates.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11973,7 +12152,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSearchTemplatesResponse parameters: - in: path name: projectsId @@ -11985,6 +12165,28 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: parameters: *ref_1 post: @@ -12019,17 +12221,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: + /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: parameters: *ref_1 post: - description: Creates a cloud function project. - operationId: integrations.projects.locations.cloudFunctions.create + description: >- + Perform the deprovisioning steps to disable a user GCP project to use IP + and purge all related data in a wipeout-compliant way. + operationId: integrations.projects.locations.clients.deprovision requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12041,8 +12245,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12054,24 +12257,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: + /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: parameters: *ref_1 post: - description: >- - Executes integrations synchronously by passing the trigger id in the - request body. The request is not returned until the requested executions - are either fulfilled or experienced an error. If the integration name is - not specified (passing `-`), all of the associated integration under the - given trigger_id will be executed. Otherwise only the specified - integration for the given `trigger_id` is executed. This is helpful for - execution the integration from UI. - operationId: integrations.projects.locations.integrations.execute + description: Update client from GMEK to CMEK + operationId: integrations.projects.locations.clients.switch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12083,8 +12279,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12096,19 +12291,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: + /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: parameters: *ref_1 post: - description: >- - Executes an integration on receiving events from Integration Connector - triggers, Eventarc or CPS Trigger. Input data to integration is received - in body in json format - operationId: integrations.projects.locations.integrations.executeEvent + description: Update variable masking for provisioned client + operationId: integrations.projects.locations.clients.switchVariableMasking + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12120,8 +12313,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12133,26 +12325,20 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: triggerId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: + /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: parameters: *ref_1 post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.integrations.test + description: >- + Perform the provisioning steps to enable a user GCP project to use IP. + If GCP project already registered on IP end via Apigee Integration, + provisioning will fail. + operationId: integrations.projects.locations.clients.provision requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12164,8 +12350,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12177,16 +12362,13 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations: + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: parameters: *ref_1 get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.integrations.list + description: >- + Lists all auth configs that match the filter. Restrict to auth configs + belong to the current client only. + operationId: integrations.projects.locations.authConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12199,7 +12381,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -12212,35 +12394,35 @@ paths: schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 - in: query - name: orderBy + name: filter + schema: + type: string + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: - parameters: *ref_1 post: description: >- - Schedules an integration for execution by passing the trigger id and the - scheduled time in the request body. - operationId: integrations.projects.locations.integrations.schedule + Creates an auth config record. Fetch corresponding credentials for + specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. + Encrypt the auth config with Cloud KMS and store the encrypted + credentials in Spanner. Returns the encrypted auth config. + operationId: integrations.projects.locations.authConfigs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12252,8 +12434,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -12265,16 +12446,26 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + - in: query + name: clientCertificate.encryptedPrivateKey schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: parameters: *ref_1 - delete: - description: Delete the selected integration and all versions inside - operationId: integrations.projects.locations.integrations.delete + get: + description: >- + Gets a complete auth config. If the auth config doesn't exist, + Code.NOT_FOUND exception will be thrown. Returns the decrypted auth + config. + operationId: integrations.projects.locations.authConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12286,7 +12477,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -12299,15 +12490,23 @@ paths: schema: type: string - in: path - name: integrationsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: - parameters: *ref_1 - get: - description: Get an execution in the specified project. - operationId: integrations.projects.locations.integrations.executions.get + patch: + description: >- + Updates an auth config. If credential is updated, fetch the encrypted + auth config from Spanner, decrypt with Cloud KMS key, update the + credential fields, re-encrypt with Cloud KMS key and update the Spanner + record. For other fields, directly update the Spanner record. Returns + the encrypted auth config. + operationId: integrations.projects.locations.authConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12319,7 +12518,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -12332,20 +12531,30 @@ paths: schema: type: string - in: path - name: integrationsId + name: authConfigsId required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: clientCertificate.encryptedPrivateKey schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: - parameters: *ref_1 - get: - description: Download the execution. - operationId: integrations.projects.locations.integrations.executions.download + - in: query + name: clientCertificate.passphrase + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.authConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12357,8 +12566,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12371,24 +12579,21 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions: + /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: parameters: *ref_1 - get: - description: >- - Lists the results of all the integration executions. The response - includes the same information as the [execution - log](https://cloud.google.com/application-integration/docs/viewing-logs) - in the Integration UI. - operationId: integrations.projects.locations.integrations.executions.list + post: + description: Creates a cloud function project. + operationId: integrations.projects.locations.cloudFunctions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12401,7 +12606,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse parameters: - in: path name: projectsId @@ -12413,110 +12618,18 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: filterParams.parameterKey - schema: - type: string - - in: query - name: filterParams.startTime - schema: - type: string - format: int64 - - in: query - name: filterParams.parameterPairValue - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: refreshAcl - schema: - type: boolean - - in: query - name: filterParams.executionId - schema: - type: string - - in: query - name: filterParams.parameterPairKey - schema: - type: string - - in: query - name: filterParams.customFilter - schema: - type: string - - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: filterParams.workflowName - schema: - type: string - - in: query - name: filterParams.eventStatuses - schema: - type: string - - in: query - name: snapshotMetadataWithoutParams - schema: - type: boolean - - in: query - name: filterParams.endTime - schema: - type: string - format: int64 - - in: query - name: filterParams.parameterType - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filterParams.taskStatuses - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filterParams.parameterValue - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: parameters: *ref_1 - post: + patch: description: >- - * Resolves (lifts/rejects) any number of suspensions. If the integration - is already running, only the status of the suspension is updated. - Otherwise, the suspended integration will begin execution again. - operationId: >- - integrations.projects.locations.integrations.executions.suspensions.resolve + Updates an sfdc channel. Updates the sfdc channel in spanner. Returns + the sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12528,8 +12641,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12542,34 +12654,25 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: executionsId + name: sfdcChannelsId required: true schema: type: string - - in: path - name: suspensionsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: - parameters: *ref_1 - post: + format: google-fieldmask + get: description: >- - * Lifts suspension for the Suspension task. Fetch corresponding - suspension with provided suspension Id, resolve suspension, and set up - suspension result for the Suspension Task. - operationId: integrations.projects.locations.integrations.executions.suspensions.lift - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12581,8 +12684,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12595,28 +12697,18 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: suspensionsId + name: sfdcChannelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: - parameters: *ref_1 - get: - description: >- - * Lists suspensions associated with a specific execution. Only those - with permissions to resolve the relevant suspensions will be able to - view them. - operationId: integrations.projects.locations.integrations.executions.suspensions.list + delete: + description: Deletes an sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12628,8 +12720,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12642,37 +12733,22 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: executionsId + name: sfdcChannelsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: parameters: *ref_1 get: - description: Get a integration in the specified project. - operationId: integrations.projects.locations.integrations.versions.get + description: >- + Lists all sfdc channels that match the filter. Restrict to sfdc channels + belonging to the current client only. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12685,7 +12761,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -12698,27 +12774,38 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filter + schema: + type: string + post: description: >- - Soft-deletes the integration. Changes the status of the integration to - ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag - is removed from this snapshot and set to the previous non-ARCHIVED - snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. - This RPC throws an exception if the version being deleted is DRAFT, and - if the `locked_by` user is not the same as the user performing the - Delete. Audit fields updated include last_modified_timestamp, - last_modified_by. Any existing lock is released when Deleting a - integration. Currently, there is no undelete mechanism. - operationId: integrations.projects.locations.integrations.versions.delete + Creates an sfdc channel record. Store the sfdc channel in Spanner. + Returns the sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12730,7 +12817,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12743,24 +12830,22 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: sfdcInstancesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: + parameters: *ref_1 patch: - description: Update a integration with a draft version in the specified project. - operationId: integrations.projects.locations.integrations.versions.patch + description: >- + Updates an sfdc instance. Updates the sfdc instance in spanner. Returns + the sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12773,7 +12858,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -12786,12 +12871,7 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: sfdcInstancesId required: true schema: type: string @@ -12800,11 +12880,9 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: - parameters: *ref_1 - get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.integrations.versions.list + delete: + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12816,8 +12894,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12830,41 +12907,15 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: fieldMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Create a integration with a draft version in the specified project. - operationId: integrations.projects.locations.integrations.versions.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + get: + description: >- + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12877,7 +12928,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -12890,28 +12941,17 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: createSampleIntegrations - schema: - type: boolean - - in: query - name: newIntegration - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: parameters: *ref_1 get: description: >- - Downloads an Integration version package like - IntegrationVersion,Integration Config etc. Retrieves the - IntegrationVersion package for a given `integration_id` and returns the - response as a JSON. - operationId: >- - integrations.projects.locations.integrations.versions.downloadJsonPackage + Lists all sfdc instances that match the filter. Restrict to sfdc + instances belonging to the current client only. + operationId: integrations.projects.locations.sfdcInstances.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12924,7 +12964,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse parameters: - in: path name: projectsId @@ -12936,36 +12976,34 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: files + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: - parameters: *ref_1 + format: google-fieldmask post: description: >- - Uploads an integration. The content can be a previously downloaded - integration. Performs the same function as - CreateDraftIntegrationVersion, but accepts input in a string format, - which holds the complete representation of the IntegrationVersion - content. - operationId: integrations.projects.locations.integrations.versions.upload + Creates an sfdc instance record. Store the sfdc instance in Spanner. + Returns the sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12978,7 +13016,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -12990,27 +13028,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: parameters: *ref_1 post: - description: >- - Sets the status of the ACTIVE integration to SNAPSHOT with a new tag - "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and - "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if - the version being snapshot is not ACTIVE. Audit fields added include - action, action_by, action_timestamp. - operationId: integrations.projects.locations.integrations.versions.unpublish + description: Links a existing Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.link requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13022,7 +13050,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse parameters: - in: path name: projectsId @@ -13034,33 +13063,54 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: + parameters: *ref_1 + post: + description: Creates an Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + parameters: - in: path - name: integrationsId + name: projectsId required: true schema: type: string - in: path - name: versionsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + /v1/projects/{projectsId}/locations/{locationsId}/certificates: parameters: *ref_1 post: description: >- - This RPC throws an exception if the integration is in ARCHIVED or ACTIVE - state. This RPC throws an exception if the version being published is - DRAFT, and if the `locked_by` user is not the same as the user - performing the Publish. Audit fields updated include - last_published_timestamp, last_published_by, last_modified_timestamp, - last_modified_by. Any existing lock is on this integration is released. - operationId: integrations.projects.locations.integrations.versions.publish + Creates a new certificate. The certificate will be registered to the + trawler service and will be encrypted using cloud KMS and stored in + Spanner Returns the certificate. + operationId: integrations.projects.locations.certificates.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13072,8 +13122,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -13085,23 +13134,11 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: - parameters: *ref_1 get: description: >- - Downloads an integration. Retrieves the `IntegrationVersion` for a given - `integration_id` and returns the response as a string. - operationId: integrations.projects.locations.integrations.versions.download + List all the certificates that match the filter. Restrict to certificate + of current client only. + operationId: integrations.projects.locations.certificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13114,7 +13151,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -13126,31 +13163,29 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: files + name: readMask schema: type: string + format: google-fieldmask - in: query - name: fileFormat + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: parameters: *ref_1 get: - description: >- - Lists all sfdc channels that match the filter. Restrict to sfdc channels - belonging to the current client only. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.list + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.certificates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13162,8 +13197,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -13176,44 +13210,22 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: certificatesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - post: + patch: description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.create + Updates the certificate by id. If new certificate file is updated, it + will register with the trawler service, re-encrypt with cloud KMS and + update the Spanner record. Other fields will directly update the Spanner + record. Returns the Certificate. + operationId: integrations.projects.locations.certificates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13225,7 +13237,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -13238,22 +13250,18 @@ paths: schema: type: string - in: path - name: productsId + name: certificatesId required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: - parameters: *ref_1 - get: - description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get + format: google-fieldmask + delete: + description: Delete a certificate + operationId: integrations.projects.locations.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13265,7 +13273,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13278,24 +13286,17 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: certificatesId required: true schema: type: string - delete: - description: Deletes an sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: + parameters: *ref_1 + get: + description: >- + List all the certificates that match the filter. Restrict to certificate + of current client only. + operationId: integrations.projects.locations.products.certificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13307,7 +13308,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -13324,27 +13326,35 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: sfdcChannelsId - required: true + - in: query + name: readMask schema: type: string - patch: + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + post: description: >- - Updates an sfdc channel. Updates the sfdc channel in spanner. Returns - the sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch + Creates a new certificate. The certificate will be registered to the + trawler service and will be encrypted using cloud KMS and stored in + Spanner Returns the certificate. + operationId: integrations.projects.locations.products.certificates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13356,7 +13366,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -13373,33 +13383,47 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: + parameters: *ref_1 + get: + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.products.certificates.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + parameters: - in: path - name: sfdcInstancesId + name: projectsId required: true schema: type: string - in: path - name: sfdcChannelsId + name: locationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: productsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: - parameters: *ref_1 - post: - description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + - in: path + name: certificatesId + required: true + schema: + type: string + delete: + description: Delete a certificate + operationId: integrations.projects.locations.products.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13411,8 +13435,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13429,11 +13452,23 @@ paths: required: true schema: type: string - get: - description: >- - Lists all sfdc instances that match the filter. Restrict to sfdc - instances belonging to the current client only. - operationId: integrations.projects.locations.products.sfdcInstances.list + - in: path + name: certificatesId + required: true + schema: + type: string + patch: + description: >- + Updates the certificate by id. If new certificate file is updated, it + will register with the trawler service, re-encrypt with cloud KMS and + update the Spanner record. Other fields will directly update the Spanner + record. Returns the Certificate. + operationId: integrations.projects.locations.products.certificates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13445,8 +13480,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -13463,29 +13497,27 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: certificatesId + required: true schema: type: string - in: query - name: readMask + name: updateMask schema: type: string format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: parameters: *ref_1 - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.delete + post: + description: Execute the integration in draft state + operationId: integrations.projects.locations.products.integrations.test + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13497,7 +13529,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -13515,20 +13548,28 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: + parameters: *ref_1 + post: description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.patch + Executes integrations synchronously by passing the trigger id in the + request body. The request is not returned until the requested executions + are either fulfilled or experienced an error. If the integration name is + not specified (passing `-`), all of the associated integration under the + given trigger_id will be executed. Otherwise only the specified + integration for the given `trigger_id` is executed. This is helpful for + execution the integration from UI. + operationId: integrations.projects.locations.products.integrations.execute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13541,7 +13582,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -13559,20 +13600,23 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: + parameters: *ref_1 + post: description: >- - Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.get + Schedules an integration for execution by passing the trigger id and the + scheduled time in the request body. + operationId: integrations.projects.locations.products.integrations.schedule + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13585,7 +13629,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -13603,24 +13647,15 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: parameters: *ref_1 - post: - description: >- - Creates an auth config record. Fetch corresponding credentials for - specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. - Encrypt the auth config with Cloud KMS and store the encrypted - credentials in Spanner. Returns the encrypted auth config. - operationId: integrations.projects.locations.products.authConfigs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + get: + description: Returns the list of all integrations in the specified project. + operationId: integrations.projects.locations.products.integrations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13632,7 +13667,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -13650,22 +13686,27 @@ paths: schema: type: string - in: query - name: clientCertificate.sslCertificate + name: pageToken schema: type: string - in: query - name: clientCertificate.encryptedPrivateKey + name: orderBy schema: type: string - in: query - name: clientCertificate.passphrase + name: filter schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: + parameters: *ref_1 get: - description: >- - Lists all auth configs that match the filter. Restrict to auth configs - belong to the current client only. - operationId: integrations.projects.locations.products.authConfigs.list + description: Get an execution in the specified project. + operationId: integrations.projects.locations.products.integrations.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13677,8 +13718,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' parameters: - in: path name: projectsId @@ -13695,39 +13735,22 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: executionsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: parameters: *ref_1 - patch: - description: >- - Updates an auth config. If credential is updated, fetch the encrypted - auth config from Spanner, decrypt with Cloud KMS key, update the - credential fields, re-encrypt with Cloud KMS key and update the Spanner - record. For other fields, directly update the Spanner record. Returns - the encrypted auth config. - operationId: integrations.projects.locations.products.authConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + get: + description: Download the execution. + operationId: >- + integrations.projects.locations.products.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13739,7 +13762,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -13757,33 +13781,24 @@ paths: schema: type: string - in: path - name: authConfigsId + name: integrationsId required: true schema: type: string - - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: updateMask + - in: path + name: executionsId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: + parameters: *ref_1 get: description: >- - Gets a complete auth config. If the auth config doesn't exist, - Code.NOT_FOUND exception will be thrown. Returns the decrypted auth - config. - operationId: integrations.projects.locations.products.authConfigs.get + Lists the results of all the integration executions. The response + includes the same information as the [execution + log](https://cloud.google.com/application-integration/docs/viewing-logs) + in the Integration UI. + operationId: integrations.projects.locations.products.integrations.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13795,7 +13810,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse parameters: - in: path name: projectsId @@ -13813,86 +13829,79 @@ paths: schema: type: string - in: path - name: authConfigsId + name: integrationsId required: true schema: type: string - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.products.authConfigs.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: filterParams.executionId + schema: + type: string + - in: query + name: filterParams.workflowName + schema: + type: string + - in: query + name: filterParams.parameterKey + schema: + type: string + - in: query + name: filterParams.parameterValue + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: readMask schema: type: string - - in: path - name: locationsId - required: true + format: google-fieldmask + - in: query + name: filterParams.startTime schema: type: string - - in: path - name: productsId - required: true + format: int64 + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean + - in: query + name: filterParams.eventStatuses schema: type: string - - in: path - name: authConfigsId - required: true + - in: query + name: refreshAcl + schema: + type: boolean + - in: query + name: filterParams.parameterPairValue schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: - parameters: *ref_1 - get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.products.integrations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse - parameters: - - in: path - name: projectsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: truncateParams + schema: + type: boolean + - in: query + name: pageToken schema: type: string - - in: path - name: productsId - required: true + - in: query + name: filterParams.endTime schema: type: string + format: int64 - in: query - name: pageToken + name: filterParams.parameterPairKey schema: type: string - in: query - name: orderBy + name: filterParams.parameterType schema: type: string - in: query @@ -13901,27 +13910,22 @@ paths: type: integer format: int32 - in: query - name: filter + name: filterParams.customFilter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: + - in: query + name: filterParams.taskStatuses + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: parameters: *ref_1 - post: + get: description: >- - Executes integrations synchronously by passing the trigger id in the - request body. The request is not returned until the requested executions - are either fulfilled or experienced an error. If the integration name is - not specified (passing `-`), all of the associated integration under the - given trigger_id will be executed. Otherwise only the specified - integration for the given `trigger_id` is executed. This is helpful for - execution the integration from UI. - operationId: integrations.projects.locations.products.integrations.execute - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + * Lists suspensions associated with a specific execution. Only those + with permissions to resolve the relevant suspensions will be able to + view them. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13934,7 +13938,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse parameters: - in: path name: projectsId @@ -13956,64 +13960,43 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: - parameters: *ref_1 - post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.products.integrations.test - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse - parameters: - in: path - name: projectsId + name: executionsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: productsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: parameters: *ref_1 post: description: >- - Schedules an integration for execution by passing the trigger id and the - scheduled time in the request body. - operationId: integrations.projects.locations.products.integrations.schedule + * Lifts suspension for the Suspension task. Fetch corresponding + suspension with provided suspension Id, resolve suspension, and set up + suspension result for the Suspension Task. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.lift requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14026,7 +14009,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -14048,23 +14031,31 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + - in: path + name: executionsId + required: true + schema: + type: string + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: parameters: *ref_1 post: description: >- - This RPC throws an exception if the integration is in ARCHIVED or ACTIVE - state. This RPC throws an exception if the version being published is - DRAFT, and if the `locked_by` user is not the same as the user - performing the Publish. Audit fields updated include - last_published_timestamp, last_published_by, last_modified_timestamp, - last_modified_by. Any existing lock is on this integration is released. - operationId: integrations.projects.locations.products.integrations.versions.publish + * Resolves (lifts/rejects) any number of suspensions. If the integration + is already running, only the status of the suspension is updated. + Otherwise, the suspended integration will begin execution again. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.resolve requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14077,7 +14068,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -14100,17 +14091,31 @@ paths: schema: type: string - in: path - name: versionsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: parameters: *ref_1 - get: + post: description: >- - Downloads an integration. Retrieves the `IntegrationVersion` for a given - `integration_id` and returns the response as a string. - operationId: integrations.projects.locations.products.integrations.versions.download + Sets the status of the ACTIVE integration to SNAPSHOT with a new tag + "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and + "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if + the version being snapshot is not ACTIVE. Audit fields added include + action, action_by, action_timestamp. + operationId: integrations.projects.locations.products.integrations.versions.unpublish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14122,8 +14127,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14150,30 +14154,17 @@ paths: required: true schema: type: string - - in: query - name: files - schema: - type: string - - in: query - name: fileFormat - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: parameters: *ref_1 post: - description: >- - Uploads an integration. The content can be a previously downloaded - integration. Performs the same function as - CreateDraftIntegrationVersion, but accepts input in a string format, - which holds the complete representation of the IntegrationVersion - content. - operationId: integrations.projects.locations.products.integrations.versions.upload + description: Create a integration with a draft version in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14186,7 +14177,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14207,21 +14198,18 @@ paths: name: integrationsId required: true schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: - parameters: *ref_1 - delete: - description: >- - Soft-deletes the integration. Changes the status of the integration to - ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag - is removed from this snapshot and set to the previous non-ARCHIVED - snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. - This RPC throws an exception if the version being deleted is DRAFT, and - if the `locked_by` user is not the same as the user performing the - Delete. Audit fields updated include last_modified_timestamp, - last_modified_by. Any existing lock is released when Deleting a - integration. Currently, there is no undelete mechanism. - operationId: integrations.projects.locations.products.integrations.versions.delete + type: string + - in: query + name: createSampleIntegrations + schema: + type: boolean + - in: query + name: newIntegration + schema: + type: boolean + get: + description: Returns the list of all integration versions in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14233,7 +14221,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -14255,14 +14244,52 @@ paths: required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: orderBy schema: type: string - get: - description: Get a integration in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: fieldMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: + parameters: *ref_1 + post: + description: >- + Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of + this integration. It then performs the same action as the + CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the + integration as a SNAPSHOT and then creates a new DRAFT version with the + `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` + set to the current timestamp). Both the `locked_by` and + `user_taking_over` are notified via email about the takeover. This RPC + throws an exception if the integration is not in DRAFT status or if the + `locked_by` and `locked_at_timestamp` fields are not set.The + TakeoverEdit lock is treated the same as an edit of the integration, and + hence shares ACLs with edit. Audit fields updated include + last_modified_timestamp, last_modified_by. + operationId: >- + integrations.projects.locations.products.integrations.versions.takeoverEditLock + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14275,7 +14302,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse parameters: - in: path name: projectsId @@ -14302,15 +14329,13 @@ paths: required: true schema: type: string - patch: - description: Update a integration with a draft version in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: + parameters: *ref_1 + get: + description: >- + Downloads an integration. Retrieves the `IntegrationVersion` for a given + `integration_id` and returns the response as a string. + operationId: integrations.projects.locations.products.integrations.versions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14323,7 +14348,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14351,34 +14376,24 @@ paths: schema: type: string - in: query - name: updateMask + name: fileFormat schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: + - in: query + name: files + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: parameters: *ref_1 - post: - description: >- - Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of - this integration. It then performs the same action as the - CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the - integration as a SNAPSHOT and then creates a new DRAFT version with the - `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` - set to the current timestamp). Both the `locked_by` and - `user_taking_over` are notified via email about the takeover. This RPC - throws an exception if the integration is not in DRAFT status or if the - `locked_by` and `locked_at_timestamp` fields are not set.The - TakeoverEdit lock is treated the same as an edit of the integration, and - hence shares ACLs with edit. Audit fields updated include - last_modified_timestamp, last_modified_by. - operationId: >- - integrations.projects.locations.products.integrations.versions.takeoverEditLock + patch: + description: Update a integration with a draft version in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14391,7 +14406,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14418,22 +14433,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: - parameters: *ref_1 - post: - description: >- - Sets the status of the ACTIVE integration to SNAPSHOT with a new tag - "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and - "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if - the version being snapshot is not ACTIVE. Audit fields added include - action, action_by, action_timestamp. - operationId: integrations.projects.locations.products.integrations.versions.unpublish - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Get a integration in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14445,7 +14452,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14472,11 +14480,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: - parameters: *ref_1 - get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.list + delete: + description: >- + Soft-deletes the integration. Changes the status of the integration to + ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag + is removed from this snapshot and set to the previous non-ARCHIVED + snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. + This RPC throws an exception if the version being deleted is DRAFT, and + if the `locked_by` user is not the same as the user performing the + Delete. Audit fields updated include last_modified_timestamp, + last_modified_by. Any existing lock is released when Deleting a + integration. Currently, there is no undelete mechanism. + operationId: integrations.projects.locations.products.integrations.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14488,8 +14503,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14511,37 +14525,27 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: fieldMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: versionsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: + parameters: *ref_1 post: - description: Create a integration with a draft version in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.create + description: >- + Uploads an integration. The content can be a previously downloaded + integration. Performs the same function as + CreateDraftIntegrationVersion, but accepts input in a string format, + which holds the complete representation of the IntegrationVersion + content. + operationId: integrations.projects.locations.products.integrations.versions.upload requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14554,7 +14558,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14576,23 +14580,23 @@ paths: required: true schema: type: string - - in: query - name: createSampleIntegrations - schema: - type: boolean - - in: query - name: newIntegration - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: parameters: *ref_1 - get: + post: description: >- - * Lists suspensions associated with a specific execution. Only those - with permissions to resolve the relevant suspensions will be able to - view them. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.list + This RPC throws an exception if the integration is in ARCHIVED or ACTIVE + state. This RPC throws an exception if the version being published is + DRAFT, and if the `locked_by` user is not the same as the user + performing the Publish. Audit fields updated include + last_published_timestamp, last_published_by, last_modified_timestamp, + last_modified_by. Any existing lock is on this integration is released. + operationId: integrations.projects.locations.products.integrations.versions.publish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14605,7 +14609,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14628,42 +14632,17 @@ paths: schema: type: string - in: path - name: executionsId + name: versionsId required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: parameters: *ref_1 - post: + get: description: >- - * Resolves (lifts/rejects) any number of suspensions. If the integration - is already running, only the status of the suspension is updated. - Otherwise, the suspended integration will begin execution again. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.resolve - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + Lists all sfdc channels that match the filter. Restrict to sfdc channels + belonging to the current client only. + operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14676,7 +14655,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -14694,35 +14673,39 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: suspensionsId - required: true + format: google-fieldmask + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: - parameters: *ref_1 post: description: >- - * Lifts suspension for the Suspension task. Fetch corresponding - suspension with provided suspension Id, resolve suspension, and set up - suspension result for the Suspension Task. + Creates an sfdc channel record. Store the sfdc channel in Spanner. + Returns the sfdc channel. operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.lift + integrations.projects.locations.products.sfdcInstances.sfdcChannels.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14734,8 +14717,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -14753,26 +14735,23 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: suspensionsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: parameters: *ref_1 - get: - description: Download the execution. + patch: + description: >- + Updates an sfdc channel. Updates the sfdc channel in spanner. Returns + the sfdc channel. operationId: >- - integrations.projects.locations.products.integrations.executions.download + integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14784,8 +14763,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -14803,24 +14781,24 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: executionsId + name: sfdcChannelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: - parameters: *ref_1 - get: - description: >- - Lists the results of all the integration executions. The response - includes the same information as the [execution - log](https://cloud.google.com/application-integration/docs/viewing-logs) - in the Integration UI. - operationId: integrations.projects.locations.products.integrations.executions.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14832,8 +14810,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14851,99 +14828,20 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: filterParams.endTime - schema: - type: string - format: int64 - - in: query - name: filterParams.parameterPairValue - schema: - type: string - - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: filterParams.executionId - schema: - type: string - - in: query - name: filterParams.parameterPairKey - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: snapshotMetadataWithoutParams - schema: - type: boolean - - in: query - name: filterParams.workflowName - schema: - type: string - - in: query - name: filterParams.customFilter - schema: - type: string - - in: query - name: filterParams.taskStatuses - schema: - type: string - - in: query - name: filterParams.startTime - schema: - type: string - format: int64 - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filterParams.eventStatuses - schema: - type: string - - in: query - name: filterParams.parameterType - schema: - type: string - - in: query - name: refreshAcl - schema: - type: boolean - - in: query - name: filterParams.parameterKey - schema: - type: string - - in: query - name: filterParams.parameterValue - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask + - in: path + name: sfdcChannelsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: - parameters: *ref_1 get: - description: Get an execution in the specified project. - operationId: integrations.projects.locations.products.integrations.executions.get + description: >- + Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14955,7 +14853,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -14973,20 +14871,20 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: executionsId + name: sfdcChannelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: parameters: *ref_1 delete: - description: Delete a certificate - operationId: integrations.projects.locations.products.certificates.delete + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15016,13 +14914,15 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.products.certificates.get + description: >- + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.products.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15034,7 +14934,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -15052,22 +14953,20 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string patch: description: >- - Updates the certificate by id. If new certificate file is updated, it - will register with the trawler service, re-encrypt with cloud KMS and - update the Spanner record. Other fields will directly update the Spanner - record. Returns the Certificate. - operationId: integrations.projects.locations.products.certificates.patch + Updates an sfdc instance. Updates the sfdc instance in spanner. Returns + the sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15079,7 +14978,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -15097,7 +14997,7 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string @@ -15106,13 +15006,13 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: parameters: *ref_1 get: description: >- - List all the certificates that match the filter. Restrict to certificate - of current client only. - operationId: integrations.projects.locations.products.certificates.list + Lists all sfdc instances that match the filter. Restrict to sfdc + instances belonging to the current client only. + operationId: integrations.projects.locations.products.sfdcInstances.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15125,7 +15025,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse parameters: - in: path name: projectsId @@ -15162,15 +15062,14 @@ paths: type: string post: description: >- - Creates a new certificate. The certificate will be registered to the - trawler service and will be encrypted using cloud KMS and stored in - Spanner Returns the certificate. - operationId: integrations.projects.locations.products.certificates.create + Creates an sfdc instance record. Store the sfdc instance in Spanner. + Returns the sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15182,7 +15081,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -15199,17 +15099,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: parameters: *ref_1 post: - description: Creates a cloud function project. - operationId: integrations.projects.locations.products.cloudFunctions.create + description: >- + Creates an auth config record. Fetch corresponding credentials for + specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. + Encrypt the auth config with Cloud KMS and store the encrypted + credentials in Spanner. Returns the encrypted auth config. + operationId: integrations.projects.locations.products.authConfigs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15221,8 +15124,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -15239,13 +15141,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates: - parameters: *ref_1 + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + - in: query + name: clientCertificate.sslCertificate + schema: + type: string get: description: >- - List all the certificates that match the filter. Restrict to certificate - of current client only. - operationId: integrations.projects.locations.certificates.list + Lists all auth configs that match the filter. Restrict to auth configs + belong to the current client only. + operationId: integrations.projects.locations.products.authConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15258,7 +15170,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -15270,8 +15182,9 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: productsId + required: true schema: type: string - in: query @@ -15283,22 +15196,23 @@ paths: name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: readMask schema: type: string format: google-fieldmask - post: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: + parameters: *ref_1 + get: description: >- - Creates a new certificate. The certificate will be registered to the - trawler service and will be encrypted using cloud KMS and stored in - Spanner Returns the certificate. - operationId: integrations.projects.locations.certificates.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + Gets a complete auth config. If the auth config doesn't exist, + Code.NOT_FOUND exception will be thrown. Returns the decrypted auth + config. + operationId: integrations.projects.locations.products.authConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15310,7 +15224,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -15322,20 +15236,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: - parameters: *ref_1 + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: authConfigsId + required: true + schema: + type: string patch: description: >- - Updates the certificate by id. If new certificate file is updated, it - will register with the trawler service, re-encrypt with cloud KMS and - update the Spanner record. Other fields will directly update the Spanner - record. Returns the Certificate. - operationId: integrations.projects.locations.certificates.patch + Updates an auth config. If credential is updated, fetch the encrypted + auth config from Spanner, decrypt with Cloud KMS key, update the + credential fields, re-encrypt with Cloud KMS key and update the Spanner + record. For other fields, directly update the Spanner record. Returns + the encrypted auth config. + operationId: integrations.projects.locations.products.authConfigs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15347,7 +15270,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -15360,18 +15283,35 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId + required: true + schema: + type: string + - in: path + name: authConfigsId required: true schema: type: string + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string - in: query name: updateMask schema: type: string format: google-fieldmask - get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.certificates.get + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.products.authConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15383,7 +15323,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -15396,13 +15336,26 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId required: true schema: type: string - delete: - description: Delete a certificate - operationId: integrations.projects.locations.certificates.delete + - in: path + name: authConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: + parameters: *ref_1 + post: + description: Creates a cloud function project. + operationId: integrations.projects.locations.products.cloudFunctions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15414,7 +15367,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse parameters: - in: path name: projectsId @@ -15427,21 +15381,17 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: + /v1/projects/{projectsId}/locations/{locationsId}/clients: parameters: *ref_1 - post: - description: Links a existing Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.link - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + get: + description: >- + Gets the client configuration for the given project and location + resource name + operationId: integrations.projects.locations.getClients security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15454,7 +15404,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse parameters: - in: path name: projectsId @@ -15466,17 +15416,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: + /v1/projects/{projectsId}/clientmetadata: parameters: *ref_1 - post: - description: Creates an Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + get: + description: Gets the metadata info for the requested client + operationId: integrations.projects.getClientmetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15489,15 +15433,71 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + /v1/callback:generateToken: + parameters: *ref_1 + get: + description: >- + Receives the auth code and auth config id to combine that with the + client id and secret to retrieve access tokens from the token endpoint. + Returns either a success or error message when it's done. + operationId: integrations.callback.generateToken + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse + parameters: + - in: query + name: state + schema: + type: string + - in: query + name: redirectUri + schema: + type: string + - in: query + name: product + schema: + type: string + - in: query + name: gcpProjectId + schema: + type: string + - in: query + name: code schema: type: string + /v1/connectorPlatformRegions:enumerate: + parameters: *ref_1 + get: + description: Enumerates the regions for which Connector Platform is provisioned. + operationId: integrations.connectorPlatformRegions.enumerate + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse + parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml b/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml index 93397643..b57252a1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml @@ -9,8 +9,8 @@ info: Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. version: v4 - x-discovery-doc-revision: '20240620' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/talent-solution/job-search/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml b/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml index 700ccac8..9d89ca81 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/kms/ servers: @@ -34,55 +34,7 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudKmsV1KeyOperationAttestationCertificateChains: - id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains - description: >- - Certificate chains needed to verify the attestation. Certificates in - chains are PEM-encoded and are ordered based on - https://tools.ietf.org/html/rfc5246#section-7.4.2. - type: object - properties: - googleCardCerts: - type: array - description: Google card certificate chain corresponding to the attestation. - items: - type: string - googlePartitionCerts: - items: - type: string - description: Google partition certificate chain corresponding to the attestation. - type: array - caviumCerts: - items: - type: string - type: array - description: Cavium certificate chain corresponding to the attestation. - GoogleCloudKmsV1ExternalProtectionLevelOptions: - properties: - ekmConnectionKeyPath: - description: >- - The path to the external key material on the EKM when using - EkmConnection e.g., "v0/my/key". Set this field instead of - external_key_uri when using an EkmConnection. - type: string - externalKeyUri: - type: string - description: >- - The URI for an external resource that this CryptoKeyVersion - represents. - id: GoogleCloudKmsV1ExternalProtectionLevelOptions - type: object - description: >- - ExternalProtectionLevelOptions stores a group of additional fields for - configuring a CryptoKeyVersion that are specific to the EXTERNAL - protection level and EXTERNAL_VPC protection levels. GoogleCloudKmsV1KeyAccessJustificationsPolicy: - description: >- - A KeyAccessJustificationsPolicy specifies zero or more allowed - AccessReason values for encrypt, decrypt, and sign operations on a - CryptoKey. - id: GoogleCloudKmsV1KeyAccessJustificationsPolicy - type: object properties: allowedAccessReasons: description: >- @@ -91,7 +43,6 @@ components: the CryptoKey associated with this policy will fail. type: array items: - type: string enumDescriptions: - Unspecified access reason. - Customer-initiated support. @@ -152,160 +103,88 @@ components: - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING - GoogleCloudKmsInventoryV1ProtectedResource: - id: GoogleCloudKmsInventoryV1ProtectedResource + type: string + description: >- + A KeyAccessJustificationsPolicy specifies zero or more allowed + AccessReason values for encrypt, decrypt, and sign operations on a + CryptoKey. + id: GoogleCloudKmsV1KeyAccessJustificationsPolicy + type: object + GoogleCloudKmsV1CryptoKeyVersion: type: object + id: GoogleCloudKmsV1CryptoKeyVersion + description: >- + A CryptoKeyVersion represents an individual cryptographic key, and the + associated key material. An ENABLED version can be used for + cryptographic operations. For security reasons, the raw cryptographic + key material represented by a CryptoKeyVersion can never be viewed or + exported. It can only be used to encrypt, decrypt, or sign data when an + authorized user or application invokes Cloud KMS. properties: - name: - type: string - description: >- - The full resource name of the resource. Example: - `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. - labels: - description: A key-value pair of the resource's labels (v1) to their values. - additionalProperties: - type: string - type: object - cryptoKeyVersion: - type: string - description: >- - The name of the Cloud KMS - [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) - used to protect this resource via CMEK. This field is empty if the - Google Cloud product owning the resource does not provide key - version data to Asset Inventory. If there are multiple key versions - protecting the resource, then this is same value as the first - element of crypto_key_versions. - project: - description: 'Format: `projects/{PROJECT_NUMBER}`.' - type: string - projectId: - type: string - description: The ID of the project that owns the resource. - resourceType: + externalDestructionFailureReason: type: string - description: 'Example: `compute.googleapis.com/Disk`' - location: + readOnly: true description: >- - Location can be `global`, regional like `us-east1`, or zonal like - `us-west1-b`. - type: string - cryptoKeyVersions: - type: array + Output only. The root cause of the most recent external destruction + failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. + reimportEligible: description: >- - The names of the Cloud KMS - [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) - used to protect this resource via CMEK. This field is empty if the - Google Cloud product owning the resource does not provide key - versions data to Asset Inventory. The first element of this field is - stored in crypto_key_version. - items: - type: string + Output only. Whether or not this key version is eligible for + reimport, by being specified as a target in + ImportCryptoKeyVersionRequest.crypto_key_version. + readOnly: true + type: boolean createTime: - description: >- - Output only. The time at which this resource was created. The - granularity is in seconds. Timestamp.nanos will always be 0. + description: Output only. The time at which this CryptoKeyVersion was created. readOnly: true - type: string format: google-datetime - cloudProduct: type: string - description: 'The Cloud product that owns the resource. Example: `compute`' - description: Metadata about a resource protected by a Cloud KMS key. - GoogleCloudKmsInventoryV1ProtectedResourcesSummary: - id: GoogleCloudKmsInventoryV1ProtectedResourcesSummary - type: object - description: >- - Aggregate information about the resources protected by a Cloud KMS key - in the same Cloud organization as the key. - properties: - name: + protectionLevel: description: >- - The full name of the ProtectedResourcesSummary resource. Example: - projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary + Output only. The ProtectionLevel describing how crypto operations + are performed with this CryptoKeyVersion. + readOnly: true + enumDescriptions: + - Not specified. + - Crypto operations are performed in software. + - Crypto operations are performed in a Hardware Security Module. + - Crypto operations are performed by an external key manager. + - Crypto operations are performed in an EKM-over-VPC backend. + enum: + - PROTECTION_LEVEL_UNSPECIFIED + - SOFTWARE + - HSM + - EXTERNAL + - EXTERNAL_VPC type: string - projectCount: - type: integer + importFailureReason: description: >- - The number of distinct Cloud projects in the same Cloud organization - as the key that have resources protected by the key. - format: int32 - resourceTypes: - type: object + Output only. The root cause of the most recent import failure. Only + present if state is IMPORT_FAILED. + readOnly: true + type: string + externalProtectionLevelOptions: description: >- - The number of resources protected by the key grouped by resource - type. - additionalProperties: - format: int64 - type: string - cloudProducts: - additionalProperties: - format: int64 - type: string - type: object + ExternalProtectionLevelOptions stores a group of additional fields + for configuring a CryptoKeyVersion that are specific to the EXTERNAL + protection level and EXTERNAL_VPC protection levels. + $ref: '#/components/schemas/GoogleCloudKmsV1ExternalProtectionLevelOptions' + destroyTime: + type: string description: >- - The number of resources protected by the key grouped by Cloud - product. - resourceCount: + Output only. The time this CryptoKeyVersion's key material is + scheduled for destruction. Only present if state is + DESTROY_SCHEDULED. + readOnly: true + format: google-datetime + generateTime: description: >- - The total number of protected resources in the same Cloud - organization as the key. + Output only. The time this CryptoKeyVersion's key material was + generated. + format: google-datetime type: string - format: int64 - locations: - type: object - additionalProperties: - format: int64 - type: string - description: The number of resources protected by the key grouped by region. - GoogleCloudKmsV1CryptoKeyVersionTemplate: - type: object - id: GoogleCloudKmsV1CryptoKeyVersionTemplate - properties: + readOnly: true algorithm: - enum: - - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - - GOOGLE_SYMMETRIC_ENCRYPTION - - AES_128_GCM - - AES_256_GCM - - AES_128_CBC - - AES_256_CBC - - AES_128_CTR - - AES_256_CTR - - RSA_SIGN_PSS_2048_SHA256 - - RSA_SIGN_PSS_3072_SHA256 - - RSA_SIGN_PSS_4096_SHA256 - - RSA_SIGN_PSS_4096_SHA512 - - RSA_SIGN_PKCS1_2048_SHA256 - - RSA_SIGN_PKCS1_3072_SHA256 - - RSA_SIGN_PKCS1_4096_SHA256 - - RSA_SIGN_PKCS1_4096_SHA512 - - RSA_SIGN_RAW_PKCS1_2048 - - RSA_SIGN_RAW_PKCS1_3072 - - RSA_SIGN_RAW_PKCS1_4096 - - RSA_DECRYPT_OAEP_2048_SHA256 - - RSA_DECRYPT_OAEP_3072_SHA256 - - RSA_DECRYPT_OAEP_4096_SHA256 - - RSA_DECRYPT_OAEP_4096_SHA512 - - RSA_DECRYPT_OAEP_2048_SHA1 - - RSA_DECRYPT_OAEP_3072_SHA1 - - RSA_DECRYPT_OAEP_4096_SHA1 - - EC_SIGN_P256_SHA256 - - EC_SIGN_P384_SHA384 - - EC_SIGN_SECP256K1_SHA256 - - EC_SIGN_ED25519 - - HMAC_SHA256 - - HMAC_SHA1 - - HMAC_SHA384 - - HMAC_SHA512 - - HMAC_SHA224 - - EXTERNAL_SYMMETRIC_ENCRYPTION - type: string - description: >- - Required. Algorithm to use when creating a CryptoKeyVersion based on - this template. For backwards compatibility, - GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted - and CryptoKey.purpose is ENCRYPT_DECRYPT. enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -355,65 +234,319 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. - protectionLevel: - enum: - - PROTECTION_LEVEL_UNSPECIFIED - - SOFTWARE - - HSM - - EXTERNAL - - EXTERNAL_VPC + readOnly: true + type: string + description: >- + Output only. The CryptoKeyVersionAlgorithm that this + CryptoKeyVersion supports. + enum: + - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED + - GOOGLE_SYMMETRIC_ENCRYPTION + - AES_128_GCM + - AES_256_GCM + - AES_128_CBC + - AES_256_CBC + - AES_128_CTR + - AES_256_CTR + - RSA_SIGN_PSS_2048_SHA256 + - RSA_SIGN_PSS_3072_SHA256 + - RSA_SIGN_PSS_4096_SHA256 + - RSA_SIGN_PSS_4096_SHA512 + - RSA_SIGN_PKCS1_2048_SHA256 + - RSA_SIGN_PKCS1_3072_SHA256 + - RSA_SIGN_PKCS1_4096_SHA256 + - RSA_SIGN_PKCS1_4096_SHA512 + - RSA_SIGN_RAW_PKCS1_2048 + - RSA_SIGN_RAW_PKCS1_3072 + - RSA_SIGN_RAW_PKCS1_4096 + - RSA_DECRYPT_OAEP_2048_SHA256 + - RSA_DECRYPT_OAEP_3072_SHA256 + - RSA_DECRYPT_OAEP_4096_SHA256 + - RSA_DECRYPT_OAEP_4096_SHA512 + - RSA_DECRYPT_OAEP_2048_SHA1 + - RSA_DECRYPT_OAEP_3072_SHA1 + - RSA_DECRYPT_OAEP_4096_SHA1 + - EC_SIGN_P256_SHA256 + - EC_SIGN_P384_SHA384 + - EC_SIGN_SECP256K1_SHA256 + - EC_SIGN_ED25519 + - HMAC_SHA256 + - HMAC_SHA1 + - HMAC_SHA384 + - HMAC_SHA512 + - HMAC_SHA224 + - EXTERNAL_SYMMETRIC_ENCRYPTION + state: + type: string enumDescriptions: - Not specified. - - Crypto operations are performed in software. - - Crypto operations are performed in a Hardware Security Module. - - Crypto operations are performed by an external key manager. - - Crypto operations are performed in an EKM-over-VPC backend. + - >- + This version is still being generated. It may not be used, + enabled, disabled, or destroyed yet. Cloud KMS will automatically + mark this version ENABLED as soon as the version is ready. + - This version may be used for cryptographic operations. + - >- + This version may not be used, but the key material is still + available, and the version can be placed back into the ENABLED + state. + - >- + This version is destroyed, and the key material is no longer + stored. This version may only become ENABLED again if this version + is reimport_eligible and the original key material is reimported + with a call to KeyManagementService.ImportCryptoKeyVersion. + - >- + This version is scheduled for destruction, and will be destroyed + soon. Call RestoreCryptoKeyVersion to put it back into the + DISABLED state. + - >- + This version is still being imported. It may not be used, enabled, + disabled, or destroyed yet. Cloud KMS will automatically mark this + version ENABLED as soon as the version is ready. + - >- + This version was not imported successfully. It may not be used, + enabled, disabled, or destroyed. The submitted key material has + been discarded. Additional details can be found in + CryptoKeyVersion.import_failure_reason. + - >- + This version was not generated successfully. It may not be used, + enabled, disabled, or destroyed. Additional details can be found + in CryptoKeyVersion.generation_failure_reason. + - >- + This version was destroyed, and it may not be used or enabled + again. Cloud KMS is waiting for the corresponding key material + residing in an external key manager to be destroyed. + - >- + This version was destroyed, and it may not be used or enabled + again. However, Cloud KMS could not confirm that the corresponding + key material residing in an external key manager was destroyed. + Additional details can be found in + CryptoKeyVersion.external_destruction_failure_reason. + description: The current state of the CryptoKeyVersion. + enum: + - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED + - PENDING_GENERATION + - ENABLED + - DISABLED + - DESTROYED + - DESTROY_SCHEDULED + - PENDING_IMPORT + - IMPORT_FAILED + - GENERATION_FAILED + - PENDING_EXTERNAL_DESTRUCTION + - EXTERNAL_DESTRUCTION_FAILED + importJob: description: >- - ProtectionLevel to use when creating a CryptoKeyVersion based on - this template. Immutable. Defaults to SOFTWARE. + Output only. The name of the ImportJob used in the most recent + import of this CryptoKeyVersion. Only present if the underlying key + material was imported. + readOnly: true + type: string + generationFailureReason: + readOnly: true + description: >- + Output only. The root cause of the most recent generation failure. + Only present if state is GENERATION_FAILED. + type: string + importTime: + description: >- + Output only. The time at which this CryptoKeyVersion's key material + was most recently imported. + type: string + readOnly: true + format: google-datetime + attestation: + readOnly: true + $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' + description: >- + Output only. Statement that was generated and signed by the HSM at + key creation time. Use this statement to verify attributes of the + key as stored on the HSM, independently of Google. Only provided for + key versions with protection_level HSM. + destroyEventTime: + format: google-datetime + type: string + readOnly: true + description: >- + Output only. The time this CryptoKeyVersion's key material was + destroyed. Only present if state is DESTROYED. + name: + description: >- + Output only. The resource name for this CryptoKeyVersion in the + format + `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. type: string + readOnly: true + GoogleCloudKmsV1KeyOperationAttestationCertificateChains: + id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains + properties: + caviumCerts: + description: Cavium certificate chain corresponding to the attestation. + items: + type: string + type: array + googlePartitionCerts: + type: array + description: Google partition certificate chain corresponding to the attestation. + items: + type: string + googleCardCerts: + type: array + description: Google card certificate chain corresponding to the attestation. + items: + type: string description: >- - A CryptoKeyVersionTemplate specifies the properties to use when creating - a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or - automatically as a result of auto-rotation. - GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse: - description: Response message for KeyTrackingService.SearchProtectedResources. + Certificate chains needed to verify the attestation. Certificates in + chains are PEM-encoded and are ordered based on + https://tools.ietf.org/html/rfc5246#section-7.4.2. type: object + GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse: id: GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse properties: nextPageToken: + type: string description: >- A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - type: string protectedResources: items: $ref: '#/components/schemas/GoogleCloudKmsInventoryV1ProtectedResource' + type: array description: Protected resources for this page. + description: Response message for KeyTrackingService.SearchProtectedResources. + type: object + GoogleCloudKmsInventoryV1ListCryptoKeysResponse: + description: Response message for KeyDashboardService.ListCryptoKeys. + properties: + cryptoKeys: type: array - GoogleCloudKmsV1CryptoKey: + description: The list of CryptoKeys. + items: + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' + nextPageToken: + description: >- + The page token returned from the previous response if the next page + is desired. + type: string type: object + id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse + GoogleCloudKmsV1KeyOperationAttestation: description: >- - A CryptoKey represents a logical key that can be used for cryptographic - operations. A CryptoKey is made up of zero or more versions, which - represent the actual key material used in cryptographic operations. + Contains an HSM-generated attestation about a key operation. For more + information, see [Verifying attestations] + (https://cloud.google.com/kms/docs/attest-key). + id: GoogleCloudKmsV1KeyOperationAttestation properties: + certChains: + readOnly: true + description: >- + Output only. The certificate chains needed to validate the + attestation + $ref: >- + #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains + format: + enumDescriptions: + - Not specified. + - >- + Cavium HSM attestation compressed with gzip. Note that this format + is defined by Cavium and subject to change at any time. See + https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. + - >- + Cavium HSM attestation V2 compressed with gzip. This is a new + format introduced in Cavium's version 3.2-08. + type: string + description: Output only. The format of the attestation data. + readOnly: true + enum: + - ATTESTATION_FORMAT_UNSPECIFIED + - CAVIUM_V1_COMPRESSED + - CAVIUM_V2_COMPRESSED + content: + type: string + readOnly: true + format: byte + description: >- + Output only. The attestation data provided by the HSM when the key + operation was performed. + type: object + GoogleCloudKmsInventoryV1ProtectedResourcesSummary: + description: >- + Aggregate information about the resources protected by a Cloud KMS key + in the same Cloud organization as the key. + type: object + id: GoogleCloudKmsInventoryV1ProtectedResourcesSummary + properties: + locations: + description: The number of resources protected by the key grouped by region. + type: object + additionalProperties: + format: int64 + type: string + resourceTypes: + additionalProperties: + format: int64 + type: string + description: >- + The number of resources protected by the key grouped by resource + type. + type: object + cloudProducts: + type: object + additionalProperties: + format: int64 + type: string + description: >- + The number of resources protected by the key grouped by Cloud + product. name: + description: >- + The full name of the ProtectedResourcesSummary resource. Example: + projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary type: string + projectCount: description: >- - Output only. The resource name for this CryptoKey in the format - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. - readOnly: true + The number of distinct Cloud projects in the same Cloud organization + as the key that have resources protected by the key. + format: int32 + type: integer + resourceCount: + type: string + description: >- + The total number of protected resources in the same Cloud + organization as the key. + format: int64 + GoogleCloudKmsV1ExternalProtectionLevelOptions: + properties: + externalKeyUri: + type: string + description: >- + The URI for an external resource that this CryptoKeyVersion + represents. + ekmConnectionKeyPath: + type: string + description: >- + The path to the external key material on the EKM when using + EkmConnection e.g., "v0/my/key". Set this field instead of + external_key_uri when using an EkmConnection. + description: >- + ExternalProtectionLevelOptions stores a group of additional fields for + configuring a CryptoKeyVersion that are specific to the EXTERNAL + protection level and EXTERNAL_VPC protection levels. + id: GoogleCloudKmsV1ExternalProtectionLevelOptions + type: object + GoogleCloudKmsV1CryptoKey: + properties: importOnly: - type: boolean description: Immutable. Whether this key may contain imported versions only. - destroyScheduledDuration: + type: boolean + rotationPeriod: format: google-duration type: string description: >- - Immutable. The period of time that versions of this key spend in the - DESTROY_SCHEDULED state before transitioning to DESTROYED. If not - specified at creation time, the default duration is 30 days. + next_rotation_time will be advanced by this period when the service + automatically rotates a key. Must be at least 24 hours and at most + 876,000 hours. If rotation_period is set, next_rotation_time must + also be set. Keys with purpose ENCRYPT_DECRYPT support automatic + rotation. For other keys, this field must be omitted. keyAccessJustificationsPolicy: description: >- Optional. The policy used for Key Access Justifications Policy @@ -426,33 +559,46 @@ components: By default, this field is absent, and all justification codes are allowed. $ref: '#/components/schemas/GoogleCloudKmsV1KeyAccessJustificationsPolicy' - labels: - type: object - additionalProperties: - type: string + cryptoKeyBackend: + type: string description: >- - Labels with user-defined metadata. For more information, see - [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). + Immutable. The resource name of the backend environment where the + key material for all CryptoKeyVersions associated with this + CryptoKey reside and where all related cryptographic operations are + performed. Only applicable if CryptoKeyVersions have a + ProtectionLevel of EXTERNAL_VPC, with the resource name in the + format `projects/*/locations/*/ekmConnections/*`. Note, this list is + non-exhaustive and may apply to additional ProtectionLevels in the + future. + destroyScheduledDuration: + description: >- + Immutable. The period of time that versions of this key spend in the + DESTROY_SCHEDULED state before transitioning to DESTROYED. If not + specified at creation time, the default duration is 30 days. + type: string + format: google-duration primary: + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' + readOnly: true description: >- Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted. - readOnly: true - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' - rotationPeriod: + versionTemplate: description: >- - next_rotation_time will be advanced by this period when the service - automatically rotates a key. Must be at least 24 hours and at most - 876,000 hours. If rotation_period is set, next_rotation_time must - also be set. Keys with purpose ENCRYPT_DECRYPT support automatic - rotation. For other keys, this field must be omitted. - format: google-duration + A template describing settings for new CryptoKeyVersion instances. + The properties of new CryptoKeyVersion instances created by either + CreateCryptoKeyVersion or auto-rotation are controlled by this + template. + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersionTemplate' + createTime: + format: google-datetime type: string + description: Output only. The time at which this CryptoKey was created. + readOnly: true purpose: - description: Immutable. The immutable purpose of this CryptoKey. enumDescriptions: - Not specified. - CryptoKeys with this purpose may be used with Encrypt and Decrypt. @@ -468,6 +614,7 @@ components: symmetric encryption and does not support automatic CryptoKey rotation. - CryptoKeys with this purpose may be used with MacSign. + description: Immutable. The immutable purpose of this CryptoKey. enum: - CRYPTO_KEY_PURPOSE_UNSPECIFIED - ENCRYPT_DECRYPT @@ -476,9 +623,20 @@ components: - RAW_ENCRYPT_DECRYPT - MAC type: string - nextRotationTime: + name: + description: >- + Output only. The resource name for this CryptoKey in the format + `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + readOnly: true type: string - format: google-datetime + labels: + additionalProperties: + type: string + type: object + description: >- + Labels with user-defined metadata. For more information, see + [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). + nextRotationTime: description: >- At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark @@ -486,247 +644,41 @@ components: CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. - cryptoKeyBackend: - description: >- - Immutable. The resource name of the backend environment where the - key material for all CryptoKeyVersions associated with this - CryptoKey reside and where all related cryptographic operations are - performed. Only applicable if CryptoKeyVersions have a - ProtectionLevel of EXTERNAL_VPC, with the resource name in the - format `projects/*/locations/*/ekmConnections/*`. Note, this list is - non-exhaustive and may apply to additional ProtectionLevels in the - future. type: string - createTime: - type: string - description: Output only. The time at which this CryptoKey was created. - readOnly: true format: google-datetime - versionTemplate: - description: >- - A template describing settings for new CryptoKeyVersion instances. - The properties of new CryptoKeyVersion instances created by either - CreateCryptoKeyVersion or auto-rotation are controlled by this - template. - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersionTemplate' - id: GoogleCloudKmsV1CryptoKey - GoogleCloudKmsV1KeyOperationAttestation: - description: >- - Contains an HSM-generated attestation about a key operation. For more - information, see [Verifying attestations] - (https://cloud.google.com/kms/docs/attest-key). - type: object - properties: - content: - type: string - format: byte - readOnly: true - description: >- - Output only. The attestation data provided by the HSM when the key - operation was performed. - format: - description: Output only. The format of the attestation data. - enum: - - ATTESTATION_FORMAT_UNSPECIFIED - - CAVIUM_V1_COMPRESSED - - CAVIUM_V2_COMPRESSED - readOnly: true - enumDescriptions: - - Not specified. - - >- - Cavium HSM attestation compressed with gzip. Note that this format - is defined by Cavium and subject to change at any time. See - https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. - - >- - Cavium HSM attestation V2 compressed with gzip. This is a new - format introduced in Cavium's version 3.2-08. - type: string - certChains: - $ref: >- - #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains - description: >- - Output only. The certificate chains needed to validate the - attestation - readOnly: true - id: GoogleCloudKmsV1KeyOperationAttestation - GoogleCloudKmsInventoryV1ListCryptoKeysResponse: - id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse - type: object - description: Response message for KeyDashboardService.ListCryptoKeys. - properties: - nextPageToken: - type: string - description: >- - The page token returned from the previous response if the next page - is desired. - cryptoKeys: - description: The list of CryptoKeys. - items: - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' - type: array - GoogleCloudKmsV1CryptoKeyVersion: type: object + id: GoogleCloudKmsV1CryptoKey description: >- - A CryptoKeyVersion represents an individual cryptographic key, and the - associated key material. An ENABLED version can be used for - cryptographic operations. For security reasons, the raw cryptographic - key material represented by a CryptoKeyVersion can never be viewed or - exported. It can only be used to encrypt, decrypt, or sign data when an - authorized user or application invokes Cloud KMS. - id: GoogleCloudKmsV1CryptoKeyVersion - properties: - generateTime: - type: string - description: >- - Output only. The time this CryptoKeyVersion's key material was - generated. - readOnly: true - format: google-datetime - reimportEligible: - description: >- - Output only. Whether or not this key version is eligible for - reimport, by being specified as a target in - ImportCryptoKeyVersionRequest.crypto_key_version. - readOnly: true - type: boolean - importJob: - readOnly: true - type: string - description: >- - Output only. The name of the ImportJob used in the most recent - import of this CryptoKeyVersion. Only present if the underlying key - material was imported. - importTime: - description: >- - Output only. The time at which this CryptoKeyVersion's key material - was most recently imported. - format: google-datetime - type: string - readOnly: true - name: - description: >- - Output only. The resource name for this CryptoKeyVersion in the - format - `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. - type: string - readOnly: true - importFailureReason: - readOnly: true - description: >- - Output only. The root cause of the most recent import failure. Only - present if state is IMPORT_FAILED. - type: string - generationFailureReason: - type: string - description: >- - Output only. The root cause of the most recent generation failure. - Only present if state is GENERATION_FAILED. - readOnly: true - state: - enumDescriptions: - - Not specified. - - >- - This version is still being generated. It may not be used, - enabled, disabled, or destroyed yet. Cloud KMS will automatically - mark this version ENABLED as soon as the version is ready. - - This version may be used for cryptographic operations. - - >- - This version may not be used, but the key material is still - available, and the version can be placed back into the ENABLED - state. - - >- - This version is destroyed, and the key material is no longer - stored. This version may only become ENABLED again if this version - is reimport_eligible and the original key material is reimported - with a call to KeyManagementService.ImportCryptoKeyVersion. - - >- - This version is scheduled for destruction, and will be destroyed - soon. Call RestoreCryptoKeyVersion to put it back into the - DISABLED state. - - >- - This version is still being imported. It may not be used, enabled, - disabled, or destroyed yet. Cloud KMS will automatically mark this - version ENABLED as soon as the version is ready. - - >- - This version was not imported successfully. It may not be used, - enabled, disabled, or destroyed. The submitted key material has - been discarded. Additional details can be found in - CryptoKeyVersion.import_failure_reason. - - >- - This version was not generated successfully. It may not be used, - enabled, disabled, or destroyed. Additional details can be found - in CryptoKeyVersion.generation_failure_reason. - - >- - This version was destroyed, and it may not be used or enabled - again. Cloud KMS is waiting for the corresponding key material - residing in an external key manager to be destroyed. - - >- - This version was destroyed, and it may not be used or enabled - again. However, Cloud KMS could not confirm that the corresponding - key material residing in an external key manager was destroyed. - Additional details can be found in - CryptoKeyVersion.external_destruction_failure_reason. - description: The current state of the CryptoKeyVersion. - type: string - enum: - - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED - - PENDING_GENERATION - - ENABLED - - DISABLED - - DESTROYED - - DESTROY_SCHEDULED - - PENDING_IMPORT - - IMPORT_FAILED - - GENERATION_FAILED - - PENDING_EXTERNAL_DESTRUCTION - - EXTERNAL_DESTRUCTION_FAILED - destroyEventTime: - format: google-datetime - description: >- - Output only. The time this CryptoKeyVersion's key material was - destroyed. Only present if state is DESTROYED. - readOnly: true - type: string - algorithm: - type: string - enum: - - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - - GOOGLE_SYMMETRIC_ENCRYPTION - - AES_128_GCM - - AES_256_GCM - - AES_128_CBC - - AES_256_CBC - - AES_128_CTR - - AES_256_CTR - - RSA_SIGN_PSS_2048_SHA256 - - RSA_SIGN_PSS_3072_SHA256 - - RSA_SIGN_PSS_4096_SHA256 - - RSA_SIGN_PSS_4096_SHA512 - - RSA_SIGN_PKCS1_2048_SHA256 - - RSA_SIGN_PKCS1_3072_SHA256 - - RSA_SIGN_PKCS1_4096_SHA256 - - RSA_SIGN_PKCS1_4096_SHA512 - - RSA_SIGN_RAW_PKCS1_2048 - - RSA_SIGN_RAW_PKCS1_3072 - - RSA_SIGN_RAW_PKCS1_4096 - - RSA_DECRYPT_OAEP_2048_SHA256 - - RSA_DECRYPT_OAEP_3072_SHA256 - - RSA_DECRYPT_OAEP_4096_SHA256 - - RSA_DECRYPT_OAEP_4096_SHA512 - - RSA_DECRYPT_OAEP_2048_SHA1 - - RSA_DECRYPT_OAEP_3072_SHA1 - - RSA_DECRYPT_OAEP_4096_SHA1 - - EC_SIGN_P256_SHA256 - - EC_SIGN_P384_SHA384 - - EC_SIGN_SECP256K1_SHA256 - - EC_SIGN_ED25519 - - HMAC_SHA256 - - HMAC_SHA1 - - HMAC_SHA384 - - HMAC_SHA512 - - HMAC_SHA224 - - EXTERNAL_SYMMETRIC_ENCRYPTION - readOnly: true + A CryptoKey represents a logical key that can be used for cryptographic + operations. A CryptoKey is made up of zero or more versions, which + represent the actual key material used in cryptographic operations. + GoogleCloudKmsV1CryptoKeyVersionTemplate: + description: >- + A CryptoKeyVersionTemplate specifies the properties to use when creating + a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or + automatically as a result of auto-rotation. + type: object + id: GoogleCloudKmsV1CryptoKeyVersionTemplate + properties: + protectionLevel: + enum: + - PROTECTION_LEVEL_UNSPECIFIED + - SOFTWARE + - HSM + - EXTERNAL + - EXTERNAL_VPC + type: string + enumDescriptions: + - Not specified. + - Crypto operations are performed in software. + - Crypto operations are performed in a Hardware Security Module. + - Crypto operations are performed by an external key manager. + - Crypto operations are performed in an EKM-over-VPC backend. + description: >- + ProtectionLevel to use when creating a CryptoKeyVersion based on + this template. Immutable. Defaults to SOFTWARE. + algorithm: + type: string enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -776,71 +728,132 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. - description: >- - Output only. The CryptoKeyVersionAlgorithm that this - CryptoKeyVersion supports. - protectionLevel: enum: - - PROTECTION_LEVEL_UNSPECIFIED - - SOFTWARE - - HSM - - EXTERNAL - - EXTERNAL_VPC - readOnly: true - enumDescriptions: - - Not specified. - - Crypto operations are performed in software. - - Crypto operations are performed in a Hardware Security Module. - - Crypto operations are performed by an external key manager. - - Crypto operations are performed in an EKM-over-VPC backend. - type: string + - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED + - GOOGLE_SYMMETRIC_ENCRYPTION + - AES_128_GCM + - AES_256_GCM + - AES_128_CBC + - AES_256_CBC + - AES_128_CTR + - AES_256_CTR + - RSA_SIGN_PSS_2048_SHA256 + - RSA_SIGN_PSS_3072_SHA256 + - RSA_SIGN_PSS_4096_SHA256 + - RSA_SIGN_PSS_4096_SHA512 + - RSA_SIGN_PKCS1_2048_SHA256 + - RSA_SIGN_PKCS1_3072_SHA256 + - RSA_SIGN_PKCS1_4096_SHA256 + - RSA_SIGN_PKCS1_4096_SHA512 + - RSA_SIGN_RAW_PKCS1_2048 + - RSA_SIGN_RAW_PKCS1_3072 + - RSA_SIGN_RAW_PKCS1_4096 + - RSA_DECRYPT_OAEP_2048_SHA256 + - RSA_DECRYPT_OAEP_3072_SHA256 + - RSA_DECRYPT_OAEP_4096_SHA256 + - RSA_DECRYPT_OAEP_4096_SHA512 + - RSA_DECRYPT_OAEP_2048_SHA1 + - RSA_DECRYPT_OAEP_3072_SHA1 + - RSA_DECRYPT_OAEP_4096_SHA1 + - EC_SIGN_P256_SHA256 + - EC_SIGN_P384_SHA384 + - EC_SIGN_SECP256K1_SHA256 + - EC_SIGN_ED25519 + - HMAC_SHA256 + - HMAC_SHA1 + - HMAC_SHA384 + - HMAC_SHA512 + - HMAC_SHA224 + - EXTERNAL_SYMMETRIC_ENCRYPTION description: >- - Output only. The ProtectionLevel describing how crypto operations - are performed with this CryptoKeyVersion. - externalProtectionLevelOptions: - $ref: '#/components/schemas/GoogleCloudKmsV1ExternalProtectionLevelOptions' + Required. Algorithm to use when creating a CryptoKeyVersion based on + this template. For backwards compatibility, + GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted + and CryptoKey.purpose is ENCRYPT_DECRYPT. + GoogleCloudKmsInventoryV1ProtectedResource: + description: Metadata about a resource protected by a Cloud KMS key. + type: object + properties: + cryptoKeyVersion: description: >- - ExternalProtectionLevelOptions stores a group of additional fields - for configuring a CryptoKeyVersion that are specific to the EXTERNAL - protection level and EXTERNAL_VPC protection levels. - externalDestructionFailureReason: - readOnly: true + The name of the Cloud KMS + [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) + used to protect this resource via CMEK. This field is empty if the + Google Cloud product owning the resource does not provide key + version data to Asset Inventory. If there are multiple key versions + protecting the resource, then this is same value as the first + element of crypto_key_versions. + type: string + cryptoKeyVersions: + type: array description: >- - Output only. The root cause of the most recent external destruction - failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. + The names of the Cloud KMS + [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) + used to protect this resource via CMEK. This field is empty if the + Google Cloud product owning the resource does not provide key + versions data to Asset Inventory. The first element of this field is + stored in crypto_key_version. + items: + type: string + projectId: type: string - createTime: - readOnly: true - description: Output only. The time at which this CryptoKeyVersion was created. + description: The ID of the project that owns the resource. + labels: + type: object + additionalProperties: + type: string + description: A key-value pair of the resource's labels (v1) to their values. + location: type: string - format: google-datetime - attestation: - readOnly: true - $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' description: >- - Output only. Statement that was generated and signed by the HSM at - key creation time. Use this statement to verify attributes of the - key as stored on the HSM, independently of Google. Only provided for - key versions with protection_level HSM. - destroyTime: - readOnly: true - format: google-datetime + Location can be `global`, regional like `us-east1`, or zonal like + `us-west1-b`. + createTime: description: >- - Output only. The time this CryptoKeyVersion's key material is - scheduled for destruction. Only present if state is - DESTROY_SCHEDULED. + Output only. The time at which this resource was created. The + granularity is in seconds. Timestamp.nanos will always be 0. + format: google-datetime + type: string + readOnly: true + resourceType: + type: string + description: 'Example: `compute.googleapis.com/Disk`' + cloudProduct: + description: 'The Cloud product that owns the resource. Example: `compute`' + type: string + project: + type: string + description: 'Format: `projects/{PROJECT_NUMBER}`.' + name: type: string + description: >- + The full resource name of the resource. Example: + `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. + id: GoogleCloudKmsInventoryV1ProtectedResource parameters: + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: fields + name: quotaUser schema: type: string oauth_token: @@ -855,25 +868,6 @@ components: name: access_token schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -883,13 +877,10 @@ components: name: key schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + callback: + description: JSONP in: query - name: quotaUser + name: callback schema: type: string uploadType: @@ -898,18 +889,27 @@ components: name: uploadType schema: type: string - callback: - description: JSONP + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv schema: type: string + enum: + - '1' + - '2' prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string x-stackQL-resources: crypto_keys: id: google.kmsinventory.crypto_keys @@ -971,17 +971,17 @@ components: paths: /v1/projects/{projectsId}/cryptoKeys: parameters: &ref_1 + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' get: description: >- Returns cryptographic keys managed by Cloud KMS in a given Cloud @@ -1007,15 +1007,15 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/protectedResourcesSummary: parameters: *ref_1 get: @@ -1086,6 +1086,10 @@ paths: required: true schema: type: string + - in: query + name: cryptoKey + schema: + type: string - in: query name: pageSize schema: @@ -1099,7 +1103,3 @@ paths: name: pageToken schema: type: string - - in: query - name: cryptoKey - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/language.yaml b/providers/src/googleapis.com/v00.00.00000/services/language.yaml index ccfcce53..a1c98b2f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/language.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/language.yaml @@ -11,7 +11,7 @@ info: annotations, to developers. version: v2 x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/natural-language/ servers: @@ -40,259 +40,74 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - XPSModelArtifactItem: - id: XPSModelArtifactItem - type: object - description: A single model artifact item. + XPSFloat64Stats: + id: XPSFloat64Stats properties: - gcsUri: - type: string + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + histogramBuckets: description: >- - The Google Cloud Storage (GCS) uri that stores the model binary - files. - artifactFormat: - enumDescriptions: - - Should not be used. - - >- - The Tensorflow checkpoints. See - https://www.tensorflow.org/guide/checkpoint. - - The Tensorflow SavedModel binary. - - >- - Model artifact in generic TensorFlow Lite (.tflite) format. See - https://www.tensorflow.org/lite. - - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. - - >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be - used in the browser and in Node.js using JavaScript. - - >- - Used for iOS mobile devices in (.mlmodel) format. See - https://developer.apple.com/documentation/coreml - enum: - - ARTIFACT_FORMAT_UNSPECIFIED - - TF_CHECKPOINT - - TF_SAVED_MODEL - - TF_LITE - - EDGE_TPU_TF_LITE - - TF_JS - - CORE_ML - description: The model artifact format. - type: string - Color: - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... - id: Color - type: object - properties: - blue: - type: number - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - green: - description: The amount of green in the color as a value in the interval [0, 1]. - format: float - type: number - alpha: - type: number + Histogram buckets of the data series. Sorted by the min value of the + bucket, ascendingly, and the number of the buckets is dynamically + generated. The buckets are non-overlapping and completely cover + whole FLOAT64 range with min of first bucket being `"-Infinity"`, + and max of the last one being `"Infinity"`. + type: array + items: + $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' + quantiles: description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - format: float - red: - format: float - description: The amount of red in the color as a value in the interval [0, 1]. + Ordered from 0 to k k-quantile values of the data series of n + values. The value at index i is, approximately, the i*n/k-th + smallest value in the series; for i = 0 and i = k these are, + respectively, the min and max values. + type: array + items: + format: double + type: number + standardDeviation: + format: double + description: The standard deviation of the series. type: number - XPSVideoTrainingOperationMetadata: - id: XPSVideoTrainingOperationMetadata - properties: - trainCostMilliNodeHour: - type: string - description: >- - This is an estimation of the node hours necessary for training a - model, expressed in milli node hours (i.e. 1,000 value in this field - means 1 node hour). A node hour represents the time a virtual - machine spends running your training job. The cost of one node - running for one hour is a node hour. - format: int64 + mean: + format: double + type: number + description: The mean of the series. + description: The data statistics of a series of FLOAT64 values. type: object - XPSVideoActionMetricsEntry: - id: XPSVideoActionMetricsEntry + XPSTfJsFormat: + description: >- + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used + in the browser and in Node.js using JavaScript. + id: XPSTfJsFormat + properties: {} type: object - description: The Evaluation metrics entry given a specific precision_window_length. + XPSFloat64StatsHistogramBucket: + id: XPSFloat64StatsHistogramBucket + description: A bucket of a histogram. properties: - meanAveragePrecision: - format: float - description: The mean average precision. + max: type: number - confidenceMetricsEntries: - items: - $ref: >- - #/components/schemas/XPSVideoActionMetricsEntryConfidenceMetricsEntry - type: array + format: double description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - precisionWindowLength: - type: string + The maximum value of the bucket, exclusive unless max = + `"Infinity"`, in which case it's inclusive. + min: + description: The minimum value of the bucket, inclusive. + type: number + format: double + count: description: >- - This VideoActionMetricsEntry is calculated based on this prediction - window length. If the predicted action's timestamp is inside the - time window whose center is the ground truth action's timestamp with - this specific length, the prediction result is treated as a true - positive. - format: google-duration - XPSCommonStats: - type: object - description: Common statistics for a column with a specified data type. - properties: - nullValueCount: - type: string - format: int64 - validValueCount: + The number of data values that are in the bucket, i.e. are between + min and max values. type: string format: int64 - distinctValueCount: - format: int64 - type: string - id: XPSCommonStats - TextSpan: - type: object - properties: - content: - type: string - description: The content of the text span, which is a substring of the document. - beginOffset: - description: >- - The API calculates the beginning offset of the content in the - original document according to the EncodingType specified in the API - request. - type: integer - format: int32 - id: TextSpan - description: Represents a text span in the input document. - XPSTableSpec: type: object - id: XPSTableSpec - properties: - validRowCount: - format: int64 - description: The number of valid rows. - type: string - columnSpecs: - description: Mapping from column id to column spec. - type: object - additionalProperties: - $ref: '#/components/schemas/XPSColumnSpec' - rowCount: - format: int64 - description: The number of rows in the table. - type: string - importedDataSizeInBytes: - description: The total size of imported data of the table. - format: int64 - type: string - timeColumnId: - type: integer - format: int32 - description: The id of the time column. - XPSColorMapIntColor: + CpuMetric: type: object - description: RGB color and each channel is represented by an integer. - id: XPSColorMapIntColor + id: CpuMetric properties: - red: - type: integer - format: int32 - description: The value should be in range of [0, 255]. - blue: - description: The value should be in range of [0, 255]. - format: int32 - type: integer - green: - type: integer - description: The value should be in range of [0, 255]. - format: int32 - XPSBatchPredictResponse: - type: object - properties: - exampleSet: - $ref: '#/components/schemas/XPSExampleSet' - description: >- - Examples for batch prediction result. Under full API implementation, - results are stored in shared RecordIO of AnnotatedExample protobufs, - the annotations field of which is populated by XPS backend. - id: XPSBatchPredictResponse - DiskMetric: - properties: - gibSec: - format: int64 - type: string - description: Required. Seconds of physical disk usage, e.g. 3600. - diskType: - enum: - - UNKNOWN_DISK_TYPE - - REGIONAL_SSD - - REGIONAL_STORAGE - - PD_SSD - - PD_STANDARD - - STORAGE_SNAPSHOT - description: Required. Type of Disk, e.g. REGIONAL_SSD. + machineSpec: enumDescriptions: - '' - '' @@ -300,658 +115,588 @@ components: - '' - '' - '' - type: string - id: DiskMetric - type: object - XPSArrayStats: - id: XPSArrayStats - description: The data statistics of a series of ARRAY values. - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - memberStats: - $ref: '#/components/schemas/XPSDataStats' - description: >- - Stats of all the values of all arrays, as if they were a single long - series of data. The type depends on the element type of the array. - type: object - XPSRow: - properties: - values: - description: >- - The values of the row cells, given in the same order as the - column_ids. If column_ids is not set, then in the same order as the - input_feature_column_ids in TablesModelMetadata. - items: - type: any - type: array - columnIds: - items: - format: int32 - type: integer - description: >- - The ids of the columns. Note: The below `values` field must match - order of this field, if this field is set. - type: array - id: XPSRow - type: object - XPSTextSentimentEvaluationMetrics: - type: object - description: Model evaluation metrics for text sentiment problems. - properties: - f1Score: - description: Output only. The harmonic mean of recall and precision. - format: float - type: number - linearKappa: - format: float - type: number - description: >- - Output only. Linear weighted kappa. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - recall: - type: number - description: Output only. Recall. - format: float - meanSquaredError: - format: float - type: number - description: >- - Output only. Mean squared error. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - meanAbsoluteError: - type: number - description: >- - Output only. Mean absolute error. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - format: float - precision: - type: number - format: float - description: Output only. Precision. - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' - description: >- - Output only. Confusion matrix of the evaluation. Only set for the - overall model evaluation, not for evaluation of a single annotation - spec. - quadraticKappa: - description: >- - Output only. Quadratic weighted kappa. Only set for the overall - model evaluation, not for evaluation of a single annotation spec. - type: number - format: float - id: XPSTextSentimentEvaluationMetrics - Sentence: - properties: - text: - $ref: '#/components/schemas/TextSpan' - description: The sentence text. - sentiment: - $ref: '#/components/schemas/Sentiment' - description: >- - For calls to AnalyzeSentiment or if - AnnotateTextRequest.Features.extract_document_sentiment is set to - true, this field will contain the sentiment for the sentence. - type: object - description: Represents a sentence in the input document. - id: Sentence - XPSColorMap: - type: object - id: XPSColorMap - description: >- - Map from color to display name. Will only be used by Image Segmentation - for uCAIP. - properties: - intColor: - $ref: '#/components/schemas/XPSColorMapIntColor' - displayName: - description: Should be used during preprocessing. - type: string - color: - description: >- - This type is deprecated in favor of the IntColor below. This is - because google.type.Color represent color has a float which - semantically does not reflect discrete classes/categories concept. - Moreover, to handle it well we need to have some tolerance when - converting to a discretized color. As such, the recommendation is to - have API surface still use google.type.Color while internally - IntColor is used. - deprecated: true - $ref: '#/components/schemas/Color' - annotationSpecIdToken: - type: string - description: Should be used during training. - XPSSpeechModelSpecSubModelSpec: - type: object - properties: - isEnhancedModel: - type: boolean - description: >- - If true then it means we have an enhanced version of the biasing - models. - clientId: - description: In S3, Recognition ClientContextId.client_id - type: string - biasingModelType: - description: Type of the biasing model. - type: string - enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT - enumDescriptions: - '' - - Build biasing model on top of COMMAND_AND_SEARCH model - - Build biasing model on top of PHONE_CALL model - - Build biasing model on top of VIDEO model - - Build biasing model on top of DEFAULT model - contextId: - type: string - description: In S3, Recognition ClientContextId.context_id - id: XPSSpeechModelSpecSubModelSpec - XPSTablesRegressionMetrics: - properties: - rootMeanSquaredLogError: - description: Root mean squared log error. - type: number - format: double - meanAbsoluteError: - format: double - type: number - description: Mean absolute error. - rSquared: - format: double - type: number - description: R squared. - regressionMetricsEntries: - items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' - description: >- - A list of actual versus predicted points for the model being - evaluated. - type: array - meanAbsolutePercentageError: - type: number - description: >- - Mean absolute percentage error, only set if all of the target - column's values are positive. - format: double - rootMeanSquaredError: - type: number - format: double - description: Root mean squared error. - type: object - id: XPSTablesRegressionMetrics - description: Metrics for Tables regression problems. - XPSConfusionMatrix: - type: object - id: XPSConfusionMatrix - properties: - category: - items: - type: integer - format: int32 - type: array - description: >- - Category (mainly for segmentation). Set only for image segmentation - models. Note: uCAIP Image Segmentation should use - annotation_spec_id_token. - annotationSpecIdToken: - type: array - items: - type: string - description: >- - For the following three repeated fields, only one is intended to be - set. annotation_spec_id_token is preferable to be set. ID tokens of - the annotation specs used in the confusion matrix. - sentimentLabel: - items: - format: int32 - type: integer - type: array - description: >- - Sentiment labels used in the confusion matrix. Set only for text - sentiment models. For AutoML Text Revamp, use - `annotation_spec_id_token` instead and leave this field empty. - row: - type: array - description: >- - Rows in the confusion matrix. The number of rows is equal to the - size of `annotation_spec_id_token`. `row[i].value[j]` is the number - of examples that have ground truth of the - `annotation_spec_id_token[i]` and are predicted as - `annotation_spec_id_token[j]` by the model being evaluated. - items: - $ref: '#/components/schemas/XPSConfusionMatrixRow' - description: Confusion matrix of the model running the classification. - XPSResponseExplanationMetadataOutputMetadata: - type: object - properties: - outputTensorName: - description: Name of the output tensor. Only needed in train response. - type: string - description: Metadata of the prediction output to be explained. - id: XPSResponseExplanationMetadataOutputMetadata - XPSTranslationEvaluationMetrics: - id: XPSTranslationEvaluationMetrics - description: Evaluation metrics for the dataset. - type: object - properties: - baseBleuScore: - format: double - type: number - description: BLEU score for base model. - bleuScore: - description: BLEU score. - type: number - format: double - XPSExportModelOutputConfig: - type: object - id: XPSExportModelOutputConfig - properties: - tfSavedModelFormat: - $ref: '#/components/schemas/XPSTfSavedModelFormat' - dockerFormat: - $ref: '#/components/schemas/XPSDockerFormat' - outputGcsUri: - type: string - description: >- - The Google Cloud Storage (GCS) directory where XPS will output the - exported models and related files. Format: gs://bucket/directory - tfJsFormat: - $ref: '#/components/schemas/XPSTfJsFormat' - outputGcrUri: - description: >- - The Google Contained Registry (GCR) path the exported files to be - pushed to. This location is set if the exported format is DOCKDER. - type: string - edgeTpuTfLiteFormat: - $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' - exportFirebaseAuxiliaryInfo: - type: boolean - description: >- - For any model and format: If true, will additionally export - FirebaseExportedModelInfo in a firebase.txt file. - coreMlFormat: - $ref: '#/components/schemas/XPSCoreMlFormat' - tfLiteFormat: - $ref: '#/components/schemas/XPSTfLiteFormat' - XPSIntegratedGradientsAttribution: - deprecated: true - type: object - properties: - stepCount: - description: >- - The number of steps for approximating the path integral. A good - value to start is 50 and gradually increase until the sum to diff - property is within the desired error range. Valid range of its value - is [1, 100], inclusively. - format: int32 - type: integer - id: XPSIntegratedGradientsAttribution - description: >- - An attribution method that computes the Aumann-Shapley value taking - advantage of the model's fully differentiable structure. Refer to this - paper for more details: https://arxiv.org/abs/1703.01365 - XPSClassificationEvaluationMetrics: - description: >- - Model evaluation metrics for classification problems. It can be used for - image and video classification. Next tag: 9. - type: object - id: XPSClassificationEvaluationMetrics - properties: - confidenceMetricsEntries: - type: array - items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. - baseAuPrc: - format: float - description: The Area under precision recall curve metric based on priors. - type: number - auPrc: - format: float - description: The Area under precision recall curve metric. - type: number - auRoc: - format: float - description: >- - The Area Under Receiver Operating Characteristic curve metric. - Micro-averaged for the overall evaluation. - type: number - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' - description: >- - Confusion matrix of the evaluation. Only set for MULTICLASS - classification problems where number of annotation specs is no more - than 10. Only set for model level evaluation, not for evaluation per - label. - evaluatedExamplesCount: - description: The number of examples used for model evaluation. - format: int32 - type: integer - logLoss: - format: float - description: The Log Loss metric. - type: number - XPSTablesTrainingOperationMetadata: - properties: - topTrials: - description: >- - This field is for training. When the operation is terminated - successfully, AutoML Backend post this field to operation metadata - in spanner. If the metadata has no trials returned, the training - operation is supposed to be a failure. - items: - $ref: '#/components/schemas/XPSTuningTrial' - type: array - createModelStage: - description: Current stage of creating model. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - CREATE_MODEL_STAGE_UNSPECIFIED - - DATA_PREPROCESSING - - TRAINING - - EVALUATING - - MODEL_POST_PROCESSING - type: string - enumDescriptions: - - Unspecified stage. - - Prepare the model training pipeline and run data processing. - - Training model. - - Run evaluation. - - Finalizing model training pipeline. - trainingStartTime: - description: Timestamp when training process starts. - format: google-datetime - type: string - optimizationObjective: - description: The optimization objective for model. + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 + description: Required. Machine spec, e.g. N1_STANDARD_4. type: string - trainingObjectivePoints: - type: array - items: - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - description: >- - This field records the training objective value with respect to - time, giving insight into how the model architecture search is - performing as training time elapses. - trainBudgetMilliNodeHours: + coreNumber: format: int64 type: string - description: Creating model budget. - type: object - id: XPSTablesTrainingOperationMetadata - XPSTuningTrial: - properties: - trainingObjectivePoint: - description: The optimization objective evaluation of the eval split data. - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - modelStructure: - description: Model parameters for the trial. - $ref: '#/components/schemas/XPSTablesModelStructure' - type: object - id: XPSTuningTrial - description: >- - Metrics for a tuning job generated, will get forwarded to Stackdriver as - model tuning logs. Setting this as a standalone message out of - CreateModelMetadata to avoid confusion as we expose this message only to - users. - Entity: - id: Entity - type: object - properties: - sentiment: - $ref: '#/components/schemas/Sentiment' - description: >- - For calls to AnalyzeEntitySentiment or if - AnnotateTextRequest.Features.extract_entity_sentiment is set to - true, this field will contain the aggregate sentiment expressed for - this entity in the provided document. - metadata: + description: Required. Number of CPU cores. + cpuType: + enum: + - UNKNOWN_CPU_TYPE + - A2 + - A3 + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D + type: string + description: Required. Type of cpu, e.g. N2. + enumDescriptions: + - '' + - GPU-based machine, skip quota reporting. + - GPU-based machine, skip quota reporting. + - COMPUTE_OPTIMIZED + - '' + - '' + - '' + - GPU-based machine, skip quota reporting. + - '' + - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + - MEMORY_OPTIMIZED + - '' + - '' + - '' + - '' + trackingLabels: type: object additionalProperties: type: string description: >- - Metadata associated with the entity. For the metadata associated - with other entity types, see the Type table below. - name: - type: string - description: The representative name for the entity. - mentions: - description: >- - The mentions of this entity in the input document. The API currently - supports proper noun mentions. - items: - $ref: '#/components/schemas/EntityMention' - type: array - type: - enumDescriptions: - - Unknown - - Person - - Location - - Organization - - Event - - Artwork - - Consumer product - - Other types of entities - - >- - Phone number The metadata lists the phone number, formatted - according to local convention, plus whichever additional elements - appear in the text: * `number` - the actual number, broken down - into sections as per local convention * `national_prefix` - - country code, if detected * `area_code` - region or area code, if - detected * `extension` - phone extension (to be dialed after - connection), if detected - - >- - Address The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - street number * `locality` - city or town * - `street_name` - street/route name, if detected * `postal_code` - - postal code, if detected * `country` - country, if detected * - `broad_region` - administrative area, such as the state, if - detected * `narrow_region` - smaller administrative area, such as - county, if detected * `sublocality` - used in Asian addresses to - demark a district within a city, if detected - - >- - Date The metadata identifies the components of the date: * `year` - - four digit year, if detected * `month` - two digit month number, - if detected * `day` - two digit day number, if detected - - Number The metadata is the number itself. - - Price The metadata identifies the `value` and `currency`. + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" + coreSec: type: string - description: The entity type. - enum: - - UNKNOWN - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - description: >- - Represents a phrase in the text that is a known entity, such as a - person, an organization, or location. The API associates information, - such as probability and mentions, with entities. - XPSImageModelArtifactSpec: - description: >- - Stores the locations and related metadata of the model artifacts. - Populated for uCAIP requests only. - id: XPSImageModelArtifactSpec + description: Required. Total seconds of core usage, e.g. 4. + format: int64 + description: Metric for billing reports. + XPSTablesClassificationMetricsCurveMetrics: + id: XPSTablesClassificationMetricsCurveMetrics + description: Metrics curve data point for a single value. properties: - servingArtifact: - $ref: '#/components/schemas/XPSModelArtifactItem' - description: >- - The default model binary file used for serving (e.g. online predict, - batch predict) via public Cloud AI Platform API. - checkpointArtifact: - description: The Tensorflow checkpoint files. e.g. Used for resumable training. - $ref: '#/components/schemas/XPSModelArtifactItem' - tfJsBinaryGcsPrefix: + aucRoc: + format: double + description: The area under receiver operating characteristic curve. + type: number + confidenceMetricsEntries: + items: + $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' description: >- - GCS uri prefix of Tensorflow JavaScript binary files - 'groupX-shardXofX.bin' Deprecated. - type: string - exportArtifact: + Metrics that have confidence thresholds. Precision-recall curve and + ROC curve can be derived from them. type: array - description: The model binary files in different formats for model export. - items: - $ref: '#/components/schemas/XPSModelArtifactItem' - labelGcsUri: - description: GCS uri of decoded labels file for model export 'dict.txt'. - type: string - tfLiteMetadataGcsUri: - description: GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. + positionThreshold: + type: integer + format: int32 + description: The position threshold value used to compute the metrics. + aucPr: + type: number + format: double + description: The area under the precision-recall curve. + value: type: string - type: object - XPSResponseExplanationSpec: - description: >- - Specification of Model explanation. Feature-based XAI in AutoML Vision - ICN is deprecated, see b/288407203 for context. - deprecated: true - id: XPSResponseExplanationSpec - properties: - parameters: - description: Parameters that configure explaining of the Model's predictions. - $ref: '#/components/schemas/XPSResponseExplanationParameters' - explanationType: description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - type: string - metadata: - $ref: '#/components/schemas/XPSResponseExplanationMetadata' - description: Metadata describing the Model's input and output for explanation. - type: object - XPSTablesModelStructureModelParametersParameter: - id: XPSTablesModelStructureModelParametersParameter - properties: - floatValue: + The CATEGORY row value (for ARRAY unnested) the curve metrics are + for. + logLoss: format: double - description: Float type parameter value. type: number - intValue: - description: Integer type parameter value. - type: string - format: int64 - name: - description: Parameter name. - type: string - stringValue: - type: string - description: String type parameter value. + description: The Log loss metric. + type: object + XPSTimestampStatsGranularStats: type: object - XPSColumnSpecCorrelatedColumn: properties: - correlationStats: - $ref: '#/components/schemas/XPSCorrelationStats' - columnId: - type: integer - format: int32 + buckets: + description: >- + A map from granularity key to example count for that key. E.g. for + hour_of_day `13` means 1pm, or for month_of_year `5` means May). + additionalProperties: + format: int64 + type: string + type: object + description: Stats split by a defined in context granularity. + id: XPSTimestampStatsGranularStats + Status: description: >- - Identifies a table's column, and its correlation with the column this - ColumnSpec describes. - type: object - id: XPSColumnSpecCorrelatedColumn - XPSTablesConfidenceMetricsEntry: + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: Status properties: - precision: - type: number - format: double - description: 'Precision = #true positives / (#true positives + #false positives).' - truePositiveRate: - description: 'TPR = #true positives / (#true positives + #false negatvies)' - type: number - format: double - truePositiveCount: - description: True positive count. - format: int64 - type: string - f1Score: + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + details: description: >- - The harmonic mean of recall and precision. (2 * precision * recall) - / (precision + recall) - format: double - type: number - falseNegativeCount: - description: False negative count. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array + message: type: string - format: int64 - falsePositiveRate: - format: double - description: 'FPR = #false positives / (#false positives + #true negatives)' - type: number - falsePositiveCount: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: object + DiskMetric: + type: object + id: DiskMetric + properties: + gibSec: + description: Required. Seconds of physical disk usage, e.g. 3600. format: int64 type: string - description: False positive count. - trueNegativeCount: - description: True negative count. - format: int64 + diskType: + enum: + - UNKNOWN_DISK_TYPE + - REGIONAL_SSD + - REGIONAL_STORAGE + - PD_SSD + - PD_STANDARD + - STORAGE_SNAPSHOT + description: Required. Type of Disk, e.g. REGIONAL_SSD. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' type: string - recall: - description: 'Recall = #true positives / (#true positives + #false negatives).' - format: double + XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + type: object + properties: + diceScoreCoefficient: + type: number + format: float + description: 'DSC or the F1 score: The harmonic mean of recall and precision.' + iouScore: + description: IOU score. + format: float type: number confidenceThreshold: - format: double + type: number + format: float description: The confidence threshold value used to compute the metrics. + recall: type: number - id: XPSTablesConfidenceMetricsEntry - type: object + description: Recall for the given confidence threshold. + format: float + precision: + description: Precision for the given confidence threshold. + format: float + type: number + confusionMatrix: + $ref: '#/components/schemas/XPSConfusionMatrix' + description: >- + Confusion matrix of the per confidence_threshold evaluation. Pixel + counts are set here. Only set for model level evaluation, not for + evaluation per label. description: Metrics for a single confidence threshold. - AnalyzeSentimentResponse: - id: AnalyzeSentimentResponse + id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + XPSTextComponentModel: + type: object + description: 'Component model. Next ID: 10' + id: XPSTextComponentModel properties: - sentences: - items: - $ref: '#/components/schemas/Sentence' - description: The sentiment for all the sentences in the document. - type: array - languageSupported: - type: boolean - description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - languageCode: + tfRuntimeVersion: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list type: string - documentSentiment: - $ref: '#/components/schemas/Sentiment' - description: The overall sentiment of the input document. - type: object - description: The sentiment analysis response message. - TpuMetric: - properties: - tpuSec: - description: Required. Seconds of TPU usage, e.g. 3600. + onlinePredictionModelGcsUri: + description: The Cloud Storage resource path to hold online prediction model. + type: string + servoModelName: type: string + description: >- + The name of servo model. Populated by uCAIP BE as part of online + PredictRequest. + servingArtifact: + description: >- + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud Ai Platform API. + $ref: '#/components/schemas/XPSModelArtifactItem' + versionNumber: + description: >- + The servomatic model version number. Populated by uCAIP BE as part + of online PredictRequest. format: int64 - tpuType: + type: string + submodelName: + description: The name of the trained NL submodel. + type: string + partition: + type: string + description: >- + The partition where the model is deployed. Populated by uCAIP BE as + part of online PredictRequest. + enumDescriptions: + - '' + - The default partition. + - >- + It has significantly lower replication than partition-0 and is + located in the US only. It also has a larger model size limit and + higher default RAM quota than partition-0. Customers with batch + traffic, US-based traffic, or very large models should use this + partition. Capacity in this partition is significantly cheaper + than partition-0. + - >- + To be used by customers with Jellyfish-accelerated ops. See + go/servomatic-jellyfish for details. + - The partition used by regionalized servomatic cloud regions. + - The partition used for loading models from custom storage. enum: - - UNKNOWN_TPU_TYPE - - TPU_V2_POD - - TPU_V2 - - TPU_V3_POD - - TPU_V3 - - TPU_V5_LITEPOD - description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + submodelType: + enum: + - TEXT_MODEL_TYPE_UNSPECIFIED + - TEXT_MODEL_TYPE_DEFAULT + - TEXT_MODEL_TYPE_META_ARCHITECT + - TEXT_MODEL_TYPE_ATC + - TEXT_MODEL_TYPE_CLARA2 + - TEXT_MODEL_TYPE_CHATBASE + - TEXT_MODEL_TYPE_SAFT_SPAN_LABELING + - TEXT_MODEL_TYPE_TEXT_EXTRACTION + - TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION + - TEXT_MODEL_TYPE_COMPOSITE + - TEXT_MODEL_TYPE_ALL_MODELS + - TEXT_MODEL_TYPE_BERT + - TEXT_MODEL_TYPE_ENC_PALM type: string + description: The type of trained NL submodel enumDescriptions: - '' - '' @@ -959,898 +704,1063 @@ components: - '' - '' - '' + - '' + - Model type for entity extraction. + - Model type for relationship extraction. + - >- + A composite model represents a set of component models that have + to be used together for prediction. A composite model appears to + be a single model to the model user. It may contain only one + component model. Please refer to go/cnl-composite-models for more + information. + - >- + Model type used to train default, MA, and ATC models in a single + batch worker pipeline. + - >- + BERT pipeline needs a specific model type, since it uses a + different TFX configuration compared with DEFAULT (despite sharing + most of the code). + - Model type for EncPaLM. + batchPredictionModelGcsUri: + type: string + description: The Cloud Storage resource path to hold batch prediction model. + XPSDataStats: + properties: + timestampStats: + $ref: '#/components/schemas/XPSTimestampStats' + description: The statistics for TIMESTAMP DataType. + structStats: + description: The statistics for STRUCT DataType. + $ref: '#/components/schemas/XPSStructStats' + validValueCount: + format: int64 + description: The number of values that are valid. + type: string + distinctValueCount: + type: string + description: The number of distinct values. + format: int64 + arrayStats: + $ref: '#/components/schemas/XPSArrayStats' + description: The statistics for ARRAY DataType. + nullValueCount: + format: int64 + type: string + description: The number of values that are null. + stringStats: + description: The statistics for STRING DataType. + $ref: '#/components/schemas/XPSStringStats' + categoryStats: + description: The statistics for CATEGORY DataType. + $ref: '#/components/schemas/XPSCategoryStats' + float64Stats: + description: The statistics for FLOAT64 DataType. + $ref: '#/components/schemas/XPSFloat64Stats' type: object - id: TpuMetric - XPSTablesEvaluationMetrics: - type: object - id: XPSTablesEvaluationMetrics + description: The data statistics of a series of values that share the same DataType. + id: XPSDataStats + AnalyzeSentimentRequest: + id: AnalyzeSentimentRequest + description: The sentiment analysis request message. properties: - classificationMetrics: - $ref: '#/components/schemas/XPSTablesClassificationMetrics' - description: Classification metrics. - regressionMetrics: - $ref: '#/components/schemas/XPSTablesRegressionMetrics' - description: Regression metrics. - XPSCategoryStats: - description: The data statistics of a series of CATEGORY values. + encodingType: + type: string + enumDescriptions: + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + description: The encoding type used by the API to calculate sentence offsets. + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. type: object + XPSDataType: properties: - topCategoryStats: + timeFormat: description: >- - The statistics of the top 20 CATEGORY values, ordered by - CategoryStats.SingleCategoryStats.count. - items: - $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' + If type_code == TIMESTAMP then `time_format` provides the format in + which that time field is expressed. The time_format must be written + in `strftime` syntax. If time_format is not set, then the default + format as described on the field is used. + type: string + typeCode: + enum: + - TYPE_CODE_UNSPECIFIED + - FLOAT64 + - TIMESTAMP + - STRING + - ARRAY + - STRUCT + - CATEGORY + enumDescriptions: + - Not specified. Should not be used. + - >- + Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or + `"-Infinity"`. + - >- + Must be between 0AD and 9999AD. Encoded as `string` according to + time_format, or, if that format is not set, then in RFC 3339 + `date-time` format, where `time-offset` = `"Z"` (e.g. + 1985-04-12T23:20:50.52Z). + - Encoded as `string`. + - >- + Encoded as `list`, where the list elements are represented + according to list_element_type. + - >- + Encoded as `struct`, where field values are represented according + to struct_type. + - >- + Values of this type are not further understood by AutoML, e.g. + AutoML is unable to tell the order of values (as it could with + FLOAT64), or is unable to say if one value contains another (as it + could with STRING). Encoded as `string` (bytes should be + base64-encoded, as described in RFC 4648, section 4). + type: string + description: Required. The TypeCode for this type. + structType: + description: >- + If type_code == STRUCT, then `struct_type` provides type information + for the struct's fields. + $ref: '#/components/schemas/XPSStructType' + nullable: + type: boolean + description: If true, this DataType can also be `null`. + compatibleDataTypes: type: array - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - id: XPSCategoryStats - XPSReportingMetrics: + items: + $ref: '#/components/schemas/XPSDataType' + description: The highly compatible data types to this data type. + listElementType: + $ref: '#/components/schemas/XPSDataType' + description: >- + If type_code == ARRAY, then `list_element_type` is the type of the + elements. + type: object + id: XPSDataType + description: >- + Indicated the type of data that can be stored in a structured data + entity (e.g. a table). + XPSVideoActionMetricsEntryConfidenceMetricsEntry: + id: XPSVideoActionMetricsEntryConfidenceMetricsEntry type: object - id: XPSReportingMetrics properties: - effectiveTrainingDuration: + recall: + format: float + type: number + description: Output only. Recall for the given confidence threshold. + confidenceThreshold: + format: float description: >- - The effective time training used. If set, this is used for quota - management and billing. Deprecated. AutoML BE doesn't use this. - Don't set. - format: google-duration - type: string - deprecated: true - metricEntries: + Output only. The confidence threshold value used to compute the + metrics. + type: number + precision: + description: Output only. Precision for the given confidence threshold. + format: float + type: number + f1Score: + format: float + type: number + description: Output only. The harmonic mean of recall and precision. + description: Metrics for a single confidence threshold. + XPSRow: + id: XPSRow + properties: + values: description: >- - One entry per metric name. The values must be aggregated per metric - name. + The values of the row cells, given in the same order as the + column_ids. If column_ids is not set, then in the same order as the + input_feature_column_ids in TablesModelMetadata. + items: + type: any type: array + columnIds: + description: >- + The ids of the columns. Note: The below `values` field must match + order of this field, if this field is set. items: - $ref: '#/components/schemas/XPSMetricEntry' - XPSResponseExplanationMetadataInputMetadata: + type: integer + format: int32 + type: array type: object - description: Metadata of the input of a feature. - id: XPSResponseExplanationMetadataInputMetadata + XPSImageSegmentationTrainResponse: properties: - visualizationConfig: - $ref: '#/components/schemas/XPSVisualization' - description: Visualization configurations for image explanation. - modality: - description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. - enum: - - MODALITY_UNSPECIFIED - - NUMERIC - - IMAGE - - CATEGORICAL - enumDescriptions: - - '' - - '' - - '' - - '' + trainCostNodeSeconds: type: string - inputTensorName: + format: int64 description: >- - Name of the input tensor for this model. Only needed in train - response. - type: string - XPSDockerFormat: - description: >- - A model format used for Docker containers. Use the params field to - customize the container. The container is verified to work correctly on - ubuntu 16.04 operating system. - properties: - gpuArchitecture: - enum: - - GPU_ARCHITECTURE_UNSPECIFIED - - GPU_ARCHITECTURE_NVIDIA + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + modelArtifactSpec: + $ref: '#/components/schemas/XPSImageModelArtifactSpec' description: >- - Optional. Additional gpu information describing the requirements for - the to be exported model files. - type: string - enumDescriptions: - - '' - - '' - cpuArchitecture: + ## The fields below are only populated under uCAIP request scope. + Model artifact spec stores and model gcs pathes and related metadata + stopReason: type: string enum: - - CPU_ARCHITECTURE_UNSPECIFIED - - CPU_ARCHITECTURE_X86_64 + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED enumDescriptions: - '' - '' - description: >- - Optional. Additional cpu information describing the requirements for - the to be exported model files. - id: XPSDockerFormat - type: object - XPSTablesModelColumnInfo: - id: XPSTablesModelColumnInfo - description: >- - An information specific to given column and Tables Model, in context of - the Model and the predictions created by it. - properties: - featureImportance: - type: number - format: float - description: >- - When given as part of a Model: Measurement of how much model - predictions correctness on the TEST data depend on values in this - column. A value between 0 and 1, higher means higher influence. - These values are normalized - for all input feature columns of a - given model they add to 1. When given back by Predict or Batch - Predict: Measurement of how impactful for the prediction returned - for the given row the value in this column was. Specifically, the - feature importance specifies the marginal contribution that the - feature made to the prediction score compared to the baseline score. - These values are computed using the Sampled Shapley method. - columnId: - type: integer - format: int32 - description: The ID of the column. - type: object - XPSStructType: - type: object - id: XPSStructType - properties: - fields: - description: Unordered map of struct field names to their data types. - type: object - additionalProperties: - $ref: '#/components/schemas/XPSDataType' - description: '`StructType` defines the DataType-s of a STRUCT type.' - ModerateTextRequest: - type: object - description: The document moderation request message. - properties: - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - modelVersion: - enumDescriptions: - - The default model version. - - >- - Use the v1 model, this model is used by default when not provided. - The v1 model only returns probability (confidence) score for each - category. + - Model fully converged, can not be resumbed training. - >- - Use the v2 model. The v2 model only returns probability - (confidence) score for each category, and returns severity score - for a subset of the categories. - enum: - - MODEL_VERSION_UNSPECIFIED - - MODEL_VERSION_1 - - MODEL_VERSION_2 - description: Optional. The model version to use for ModerateText. - type: string - id: ModerateTextRequest - XPSTablesClassificationMetrics: - description: Metrics for Tables classification problems. + Model early converged, can be further trained till full + convergency. + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + colorMaps: + description: Color map of the model. + type: array + items: + $ref: '#/components/schemas/XPSColorMap' + exportModelSpec: + description: 'NOTE: These fields are not used/needed in EAP but will be set later.' + $ref: '#/components/schemas/XPSImageExportModelSpec' + type: object + id: XPSImageSegmentationTrainResponse + XPSImageModelArtifactSpec: + id: XPSImageModelArtifactSpec type: object properties: - curveMetrics: - description: Metrics building a curve. + checkpointArtifact: + $ref: '#/components/schemas/XPSModelArtifactItem' + description: The Tensorflow checkpoint files. e.g. Used for resumable training. + servingArtifact: + description: >- + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud AI Platform API. + $ref: '#/components/schemas/XPSModelArtifactItem' + tfLiteMetadataGcsUri: + description: GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. + type: string + exportArtifact: items: - $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' + $ref: '#/components/schemas/XPSModelArtifactItem' type: array - id: XPSTablesClassificationMetrics - GpuMetric: - id: GpuMetric - properties: - trackingLabels: - additionalProperties: - type: string + description: The model binary files in different formats for model export. + labelGcsUri: + type: string + description: GCS uri of decoded labels file for model export 'dict.txt'. + tfJsBinaryGcsPrefix: description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" - type: object - gpuType: - description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNKNOWN_GPU_TYPE - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_TESLA_K80 - - NVIDIA_L4 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_V100 - - NVIDIA_H100_80GB + GCS uri prefix of Tensorflow JavaScript binary files + 'groupX-shardXofX.bin' Deprecated. type: string - machineSpec: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - description: Required. Machine spec, e.g. N1_STANDARD_4. + description: >- + Stores the locations and related metadata of the model artifacts. + Populated for uCAIP requests only. + XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: + properties: + recall: + description: Recall for the given confidence threshold. + type: number + format: float + precision: + format: float + type: number + description: Precision for the given confidence threshold. + f1Score: + type: number + description: The harmonic mean of recall and precision. + format: float + confidenceThreshold: + type: number + format: float + description: The confidence threshold value used to compute the metrics. + description: Metrics for a single confidence threshold. + id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + type: object + XPSDataErrors: + type: object + id: XPSDataErrors + description: Different types of errors and the stats associatesd with each error. + properties: + errorType: type: string + description: Type of the error. + enumDescriptions: + - Not specified. + - >- + Audio format not in the formats by cloud-speech AutoML. Currently + only wav and flac file formats are supported. + - >- + File format differnt from what is specified in the file name + extension. + - File too large. Maximum allowed size is 50 MB. + - Transcript is missing. enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_2G - - A3_HIGHGPU_4G - - A3_HIGHGPU_8G - - A3_MEGAGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 - gpuSec: + - ERROR_TYPE_UNSPECIFIED + - UNSUPPORTED_AUDIO_FORMAT + - FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT + - FILE_TOO_LARGE + - MISSING_TRANSCRIPTION + count: + type: integer + format: int32 + description: Number of records having errors associated with the enum. + XPSEvaluationMetrics: + type: object + id: XPSEvaluationMetrics + description: >- + Contains xPS-specific model evaluation metrics either for a single + annotation spec (label), or for the model overall. Next tag: 18. + properties: + imageObjectDetectionEvalMetrics: + $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' + tablesEvalMetrics: + $ref: '#/components/schemas/XPSTablesEvaluationMetrics' + videoClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + videoActionRecognitionEvalMetrics: + $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' + annotationSpecIdToken: + type: string + description: >- + The annotation_spec for which this evaluation metrics instance had + been created. Empty iff this is an overall model evaluation (like + Tables evaluation metrics), i.e. aggregated across all labels. The + value comes from the input annotations in AnnotatedExample. For MVP + product or for text sentiment models where annotation_spec_id_token + is not available, set label instead. + videoObjectTrackingEvalMetrics: + $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' + textClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + regressionEvalMetrics: + $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' + translationEvalMetrics: + $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' + category: + type: integer + format: int32 + description: >- + The integer category label for which this evaluation metric instance + had been created. Valid categories are 0 or higher. Overall model + evaluation should set this to negative values (rather than implicit + zero). Only used for Image Segmentation (prefer to set + annotation_spec_id_token instead). Note: uCAIP Image Segmentation + should use annotation_spec_id_token. + tablesClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + imageSegmentationEvalMetrics: + $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' + label: + description: >- + The label for which this evaluation metrics instance had been + created. Empty iff this is an overall model evaluation (like Tables + evaluation metrics), i.e. aggregated across all labels. The label + maps to AnnotationSpec.display_name in Public API protos. Only used + by MVP implementation and text sentiment FULL implementation. + type: string + textExtractionEvalMetrics: + $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' + textSentimentEvalMetrics: + $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' + imageClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + evaluatedExampleCount: + description: >- + The number of examples used to create this evaluation metrics + instance. + format: int32 + type: integer + XPSTablesDatasetMetadata: + properties: + primaryTableSpec: + description: Primary table. + $ref: '#/components/schemas/XPSTableSpec' + mlUseColumnId: + format: int32 + description: Id the column to split the table. + type: integer + weightColumnId: + format: int32 + description: >- + Id of the primary table column that should be used as the weight + column. + type: integer + targetColumnCorrelations: + description: '(the column id : its CorrelationStats with target column).' + additionalProperties: + $ref: '#/components/schemas/XPSCorrelationStats' + type: object + targetColumnId: + description: >- + Id of the primary table column that should be used as the training + label. + type: integer + format: int32 + id: XPSTablesDatasetMetadata + type: object + description: 'Metadata for a dataset used for AutoML Tables. Next ID: 6' + Color: + id: Color + type: object + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + properties: + green: + type: number + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + blue: + type: number + format: float + description: The amount of blue in the color as a value in the interval [0, 1]. + alpha: + type: number + format: float + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + red: + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + format: float + XPSTablesTrainResponse: + properties: + predictionSampleRows: + type: array + description: Sample rows from the dataset this model was trained. + items: + $ref: '#/components/schemas/XPSRow' + trainCostMilliNodeHours: type: string - description: Required. Seconds of GPU usage, e.g. 3600. + description: >- + The actual training cost of the model, expressed in milli node + hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed + to not exceed the train budget. format: int64 + tablesModelColumnInfo: + description: >- + Output only. Auxiliary information for each of the + input_feature_column_specs, with respect to this particular model. + items: + $ref: '#/components/schemas/XPSTablesModelColumnInfo' + type: array + modelStructure: + $ref: '#/components/schemas/XPSTablesModelStructure' type: object - XPSStructStats: - description: The data statistics of a series of STRUCT values. + id: XPSTablesTrainResponse + XPSTablesClassificationMetrics: + id: XPSTablesClassificationMetrics + type: object + description: Metrics for Tables classification problems. properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - fieldStats: - description: >- - Map from a field name of the struct to data stats aggregated over - series of all data in that field across all the structs. - type: object - additionalProperties: - $ref: '#/components/schemas/XPSDataStats' - id: XPSStructStats + curveMetrics: + description: Metrics building a curve. + type: array + items: + $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' + XPSModelArtifactItem: type: object - XPSVideoBatchPredictOperationMetadata: + description: A single model artifact item. + id: XPSModelArtifactItem properties: - outputExamples: + gcsUri: + type: string + description: >- + The Google Cloud Storage (GCS) uri that stores the model binary + files. + artifactFormat: + description: The model artifact format. + enumDescriptions: + - Should not be used. + - >- + The Tensorflow checkpoints. See + https://www.tensorflow.org/guide/checkpoint. + - The Tensorflow SavedModel binary. + - >- + Model artifact in generic TensorFlow Lite (.tflite) format. See + https://www.tensorflow.org/lite. + - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. + - >- + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be + used in the browser and in Node.js using JavaScript. + - >- + Used for iOS mobile devices in (.mlmodel) format. See + https://developer.apple.com/documentation/coreml + type: string + enum: + - ARTIFACT_FORMAT_UNSPECIFIED + - TF_CHECKPOINT + - TF_SAVED_MODEL + - TF_LITE + - EDGE_TPU_TF_LITE + - TF_JS + - CORE_ML + XPSImageSegmentationEvaluationMetrics: + description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' + properties: + confidenceMetricsEntries: + items: + $ref: >- + #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + description: >- + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. type: array + id: XPSImageSegmentationEvaluationMetrics + type: object + XPSRegressionEvaluationMetrics: + description: >- + Model evaluation metrics for regression problems. It can be used for + Tables. + id: XPSRegressionEvaluationMetrics + type: object + properties: + rootMeanSquaredError: + description: Root Mean Squared Error (RMSE). + type: number + format: float + regressionMetricsEntries: items: - type: string + $ref: '#/components/schemas/XPSRegressionMetricsEntry' + type: array + description: >- + A list of actual versus predicted points for the model being + evaluated. + rSquared: + description: R squared. + type: number + format: float + meanAbsoluteError: + format: float + type: number + description: Mean Absolute Error (MAE). + rootMeanSquaredLogError: + type: number + description: Root mean squared log error. + format: float + meanAbsolutePercentageError: + description: >- + Mean absolute percentage error. Only set if all ground truth values + are positive. + type: number + format: float + XPSXpsOperationMetadata: + type: object + id: XPSXpsOperationMetadata + properties: + videoBatchPredictOperationMetadata: + $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' + videoTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' + reportingMetrics: + $ref: '#/components/schemas/XPSReportingMetrics' + description: >- + Metrics for the operation. By the time the operation is terminated + (whether succeeded or failed) as returned from XPS, AutoML BE + assumes the metrics are finalized. AutoML BE transparently posts the + metrics to Chemist if it's not empty, regardless of the response + content or error type. If user is supposed to be charged in case of + cancellation/error, this field should be set. In the case where the + type of LRO doesn't require any billing, this field should be left + unset. + exampleCount: + format: int64 description: >- - All the partial batch prediction results that are completed at the - moment. Output examples are sorted by completion time. The order - will not be changed. Each output example should be the path of a - single RecordIO file of AnnotatedExamples. - id: XPSVideoBatchPredictOperationMetadata + Optional. XPS server can opt to provide example count of the long + running operation (e.g. training, data importing, batch prediction). + type: string + tablesTrainingOperationMetadata: + $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' + visionTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' + XPSTablesConfidenceMetricsEntry: type: object - XPSTrainResponse: - description: 'Next ID: 18' properties: - tablesTrainResp: - $ref: '#/components/schemas/XPSTablesTrainResponse' - translationTrainResp: - $ref: '#/components/schemas/XPSTranslationTrainResponse' - videoClassificationTrainResp: - $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' - deployedModelSizeBytes: + falseNegativeCount: + format: int64 + description: False negative count. + type: string + trueNegativeCount: + description: True negative count. type: string - description: Estimated model size in bytes once deployed. format: int64 - imageClassificationTrainResp: - $ref: '#/components/schemas/XPSImageClassificationTrainResponse' - imageSegmentationTrainResp: - $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' - modelToken: + f1Score: + type: number + format: double description: >- - Token that represents the trained model. This is considered - immutable and is persisted in AutoML. xPS can put their own proto in - the byte string, to e.g. point to the model checkpoints. The token - is passed to other xPS APIs to refer to the model. + The harmonic mean of recall and precision. (2 * precision * recall) + / (precision + recall) + confidenceThreshold: + type: number + format: double + description: The confidence threshold value used to compute the metrics. + precision: + type: number + format: double + description: 'Precision = #true positives / (#true positives + #false positives).' + falsePositiveCount: type: string - format: byte - explanationConfigs: - type: array - items: - $ref: '#/components/schemas/XPSResponseExplanationSpec' - description: >- - VisionExplanationConfig for XAI on test set. Optional for when XAI - is enable in training request. - deprecated: true - errorAnalysisConfigs: - type: array - items: - $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' - description: >- - Optional vision model error analysis configuration. The field is set - when model error analysis is enabled in the training request. The - results of error analysis will be binded together with evaluation - results (in the format of AnnotatedExample). - imageObjectDetectionTrainResp: - $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' - speechTrainResp: - $ref: '#/components/schemas/XPSSpeechModelSpec' - textTrainResp: - $ref: '#/components/schemas/XPSTextTrainResponse' - description: Will only be needed for uCAIP from Beta. - videoObjectTrackingTrainResp: - $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' - textToSpeechTrainResp: - $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' - videoActionRecognitionTrainResp: - $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' - evaluationMetricsSet: + description: False positive count. + format: int64 + recall: + description: 'Recall = #true positives / (#true positives + #false negatives).' + type: number + format: double + falsePositiveRate: + type: number + format: double + description: 'FPR = #false positives / (#false positives + #true negatives)' + truePositiveCount: + format: int64 + type: string + description: True positive count. + truePositiveRate: + format: double + description: 'TPR = #true positives / (#true positives + #false negatvies)' + type: number + id: XPSTablesConfidenceMetricsEntry + description: Metrics for a single confidence threshold. + AnalyzeEntitiesResponse: + description: The entity analysis response message. + properties: + languageSupported: + type: boolean description: >- - The trained model evaluation metrics. This can be optionally - returned. - $ref: '#/components/schemas/XPSEvaluationMetricsSet' - evaluatedExampleSet: - $ref: '#/components/schemas/XPSExampleSet' + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + languageCode: + type: string description: >- - Examples used to evaluate the model (usually the test set), with the - predicted annotations. The file_spec should point to recordio - file(s) of AnnotatedExample. For each returned example, the - example_id_token and annotations predicted by the model must be set. - The example payload can and is recommended to be omitted. - type: object - id: XPSTrainResponse - AnalyzeSentimentRequest: - description: The sentiment analysis request message. + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + entities: + items: + $ref: '#/components/schemas/Entity' + description: The recognized entities in the input document. + type: array type: object + id: AnalyzeEntitiesResponse + XPSVisualization: + description: Visualization configurations for image explanation. + deprecated: true properties: - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - encodingType: - type: string + colorMap: + description: >- + The color scheme used for the highlighted areas. Defaults to + PINK_GREEN for Integrated Gradients attribution, which shows + positive attributions in green and negative in pink. Defaults to + VIRIDIS for XRAI attribution, which highlights the most influential + regions in yellow and the least influential in blue. enumDescriptions: + - Should not be used. + - 'Positive: green. Negative: pink.' - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - description: The encoding type used by the API to calculate sentence offsets. + Viridis color map: A perceptually uniform color mapping which is + easier to see by those with colorblindness and progresses from + yellow to green to blue. Positive: yellow. Negative: blue. + - 'Positive: red. Negative: red.' + - 'Positive: green. Negative: green.' + - 'Positive: green. Negative: red.' + - PiYG palette. + type: string enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - id: AnalyzeSentimentRequest - XPSVideoActionRecognitionTrainResponse: - properties: - trainCostNodeSeconds: + - COLOR_MAP_UNSPECIFIED + - PINK_GREEN + - VIRIDIS + - RED + - GREEN + - RED_GREEN + - PINK_WHITE_GREEN + clipPercentLowerbound: + format: float + type: number + description: >- + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. + type: type: string description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - format: int64 - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - type: object - id: XPSVideoActionRecognitionTrainResponse - XPSMetricEntry: - type: object - properties: - argentumMetricId: + Type of the image visualization. Only applicable to Integrated + Gradients attribution. OUTLINES shows regions of attribution, while + PIXELS shows per-pixel attribution. Defaults to OUTLINES. + enumDescriptions: + - Should not be used. + - Shows which pixel contributed to the image prediction. + - >- + Shows which region contributed to the image prediction by + outlining the region. + enum: + - TYPE_UNSPECIFIED + - PIXELS + - OUTLINES + clipPercentUpperbound: + description: >- + Excludes attributions above the specified percentile from the + highlighted areas. Using the clip_percent_upperbound and + clip_percent_lowerbound together can be useful for filtering out + noise and making it easier to see areas of strong attribution. + Defaults to 99.9. + type: number + format: float + overlayType: + description: >- + How the original image is displayed in the visualization. Adjusting + the overlay can help increase visual clarity if the original image + makes it difficult to view the visualization. Defaults to NONE. type: string + enum: + - OVERLAY_TYPE_UNSPECIFIED + - NONE + - ORIGINAL + - GRAYSCALE + - MASK_BLACK + enumDescriptions: + - Default value. This is the same as NONE. + - No overlay. + - The attributions are shown on top of the original image. + - >- + The attributions are shown on top of grayscaled version of the + original image. + - >- + The attributions are used as a mask to reveal predictive parts of + the image and hide the un-predictive parts. + polarity: description: >- - For billing metrics that are using legacy sku's, set the legacy - billing metric id here. This will be sent to Chemist as the - "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise - leave empty. - int64Value: - format: int64 - description: A signed 64-bit integer value. - type: string - systemLabels: - description: Billing system labels for this (metric, value) pair. - type: array - items: - $ref: '#/components/schemas/XPSMetricEntryLabel' - doubleValue: - type: number - format: double - description: A double value. - metricName: - description: The metric name defined in the service configuration. + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. type: string - id: XPSMetricEntry - XPSTextExtractionEvaluationMetrics: + enumDescriptions: + - Default value. This is the same as POSITIVE. + - >- + Highlights the pixels/outlines that were most influential to the + model's prediction. + - >- + Setting polarity to negative highlights areas that does not lead + to the models's current prediction. + - Shows both positive and negative attributions. + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + type: object + id: XPSVisualization + XPSStructStats: properties: - confidenceMetricsEntries: - description: >- - If the enclosing EvaluationMetrics.label is empty, - confidence_metrics_entries is an evaluation of the entire model - across all labels. If the enclosing EvaluationMetrics.label is set, - confidence_metrics_entries applies to that label. - type: array - items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - confusionMatrix: - description: >- - Confusion matrix of the model, at the default confidence threshold - (0.0). Only set for whole-model evaluation, not for evaluation per - label. - $ref: '#/components/schemas/XPSConfusionMatrix' - bestF1ConfidenceMetrics: - deprecated: true - description: >- - Values are at the highest F1 score on the precision-recall curve. - Only confidence_threshold, recall, precision, and f1_score will be - set. - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - perLabelConfidenceMetrics: + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + fieldStats: type: object - description: Only recall, precision, and f1_score will be set. + description: >- + Map from a field name of the struct to data stats aggregated over + series of all data in that field across all the structs. additionalProperties: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - deprecated: true + $ref: '#/components/schemas/XPSDataStats' type: object - id: XPSTextExtractionEvaluationMetrics - XPSTablesPreprocessResponse: + description: The data statistics of a series of STRUCT values. + id: XPSStructStats + XPSPreprocessResponse: properties: - tablesDatasetMetadata: - $ref: '#/components/schemas/XPSTablesDatasetMetadata' + speechPreprocessResp: + $ref: '#/components/schemas/XPSSpeechPreprocessResponse' + translationPreprocessResp: + $ref: '#/components/schemas/XPSTranslationPreprocessResponse' + outputExampleSet: + $ref: '#/components/schemas/XPSExampleSet' description: >- - The table/column id, column_name and the DataTypes of the columns - will be populated. + Preprocessed examples, that are to be imported into AutoML storage. + This should point to RecordIO file(s) of PreprocessedExample + messages. The PreprocessedExample.mvp_training_data-s returned here + are later verbatim passed to Train() call in + TrainExample.mvp_training_data. + tablesPreprocessResponse: + $ref: '#/components/schemas/XPSTablesPreprocessResponse' + id: XPSPreprocessResponse type: object - id: XPSTablesPreprocessResponse - XPSTablesModelStructure: - description: A description of Tables model structure. + description: 'Next ID: 8' + XPSImageModelServingSpecModelThroughputEstimation: type: object - id: XPSTablesModelStructure + id: XPSImageModelServingSpecModelThroughputEstimation properties: - modelParameters: - description: A list of models. - items: - $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' - type: array - XPSConfusionMatrixRow: + computeEngineAcceleratorType: + enum: + - UNSPECIFIED + - NVIDIA_TESLA_K80 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_V100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_L4 + - NVIDIA_H100_80GB + - NVIDIA_H100_MEGA_80GB + - TPU_V2 + - TPU_V3 + - TPU_V4_POD + - TPU_V5_LITEPOD + type: string + enumDescriptions: + - '' + - Nvidia Tesla K80 GPU. + - Nvidia Tesla P100 GPU. + - Nvidia Tesla V100 GPU. + - Nvidia Tesla P4 GPU. + - Nvidia Tesla T4 GPU. + - Nvidia Tesla A100 GPU. + - Nvidia A100 80GB GPU. + - Nvidia L4 GPU. + - Nvidia H100 80Gb GPU. + - Nvidia H100 80Gb GPU. + - TPU v2 (JellyFish). + - TPU v3 (DragonFish). + - TPU_v4 (PufferFish). + - TPU v5 Lite Pods. + latencyInMilliseconds: + format: double + description: Estimated latency. + type: number + nodeQps: + type: number + description: The approximate qps a deployed node can serve. + format: double + servomaticPartitionType: + enum: + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + enumDescriptions: + - '' + - The default partition. + - >- + It has significantly lower replication than partition-0 and is + located in the US only. It also has a larger model size limit and + higher default RAM quota than partition-0. Customers with batch + traffic, US-based traffic, or very large models should use this + partition. Capacity in this partition is significantly cheaper + than partition-0. + - >- + To be used by customers with Jellyfish-accelerated ops. See + go/servomatic-jellyfish for details. + - The partition used by regionalized servomatic cloud regions. + - The partition used for loading models from custom storage. + type: string + XPSTablesModelStructureModelParameters: + description: Model hyper-parameters for a model. type: object - id: XPSConfusionMatrixRow + id: XPSTablesModelStructureModelParameters properties: - count: - description: >- - Same as above except intended to represent other counts (for e.g. - for segmentation this is pixel count). NOTE(params): Only - example_count or count is set (oneoff does not support repeated - fields unless they are embedded inside another message). + hyperparameters: type: array items: - type: string - format: int64 - exampleCount: + $ref: >- + #/components/schemas/XPSTablesModelStructureModelParametersParameter + XPSTfLiteFormat: + properties: {} + id: XPSTfLiteFormat + type: object + description: >- + LINT.IfChange A model format used for mobile and IoT devices. See + https://www.tensorflow.org/lite. + XPSConfusionMatrix: + type: object + id: XPSConfusionMatrix + description: Confusion matrix of the model running the classification. + properties: + sentimentLabel: description: >- - Value of the specific cell in the confusion matrix. The number of - values each row has (i.e. the length of the row) is equal to the - length of the annotation_spec_id_token field. + Sentiment labels used in the confusion matrix. Set only for text + sentiment models. For AutoML Text Revamp, use + `annotation_spec_id_token` instead and leave this field empty. type: array items: + format: int32 type: integer + category: + items: format: int32 - description: A row in the confusion matrix. - XPSVideoModelArtifactSpec: - id: XPSVideoModelArtifactSpec - type: object - properties: - servingArtifact: - $ref: '#/components/schemas/XPSModelArtifactItem' + type: integer description: >- - The default model binary file used for serving (e.g. batch predict) - via public Cloud AI Platform API. - exportArtifact: - description: The model binary files in different formats for model export. + Category (mainly for segmentation). Set only for image segmentation + models. Note: uCAIP Image Segmentation should use + annotation_spec_id_token. + type: array + annotationSpecIdToken: type: array items: - $ref: '#/components/schemas/XPSModelArtifactItem' - XPSTablesClassificationMetricsCurveMetrics: - properties: - logLoss: - description: The Log loss metric. - format: double - type: number - aucRoc: - description: The area under receiver operating characteristic curve. - type: number - format: double - aucPr: - format: double - type: number - description: The area under the precision-recall curve. - value: - description: >- - The CATEGORY row value (for ARRAY unnested) the curve metrics are - for. - type: string - confidenceMetricsEntries: - description: >- - Metrics that have confidence thresholds. Precision-recall curve and - ROC curve can be derived from them. - items: - $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' + type: string + description: >- + For the following three repeated fields, only one is intended to be + set. annotation_spec_id_token is preferable to be set. ID tokens of + the annotation specs used in the confusion matrix. + row: type: array - positionThreshold: - description: The position threshold value used to compute the metrics. - format: int32 - type: integer - description: Metrics curve data point for a single value. + items: + $ref: '#/components/schemas/XPSConfusionMatrixRow' + description: >- + Rows in the confusion matrix. The number of rows is equal to the + size of `annotation_spec_id_token`. `row[i].value[j]` is the number + of examples that have ground truth of the + `annotation_spec_id_token[i]` and are predicted as + `annotation_spec_id_token[j]` by the model being evaluated. + XPSResponseExplanationParameters: type: object - id: XPSTablesClassificationMetricsCurveMetrics - XPSVisionErrorAnalysisConfig: - description: 'The vision model error analysis configuration. Next tag: 3' - id: XPSVisionErrorAnalysisConfig + id: XPSResponseExplanationParameters + deprecated: true properties: - exampleCount: - description: The number of query examples in error analysis. - format: int32 - type: integer - queryType: + xraiAttribution: + $ref: '#/components/schemas/XPSXraiAttribution' description: >- - The query type used in retrieval. The enum values are frozen in the - foreseeable future. - enum: - - QUERY_TYPE_UNSPECIFIED - - QUERY_TYPE_ALL_SIMILAR - - QUERY_TYPE_SAME_CLASS_SIMILAR - - QUERY_TYPE_SAME_CLASS_DISSIMILAR + An attribution method that redistributes Integrated Gradients + attribution to segmented regions, taking advantage of the model's + fully differentiable structure. Refer to this paper for more + details: https://arxiv.org/abs/1906.02825 XRAI currently performs + better on natural images, like a picture of a house or an animal. If + the images are taken in artificial environments, like a lab or + manufacturing line, or from diagnostic equipment, like x-rays or + quality-control cameras, use Integrated Gradients instead. + integratedGradientsAttribution: + $ref: '#/components/schemas/XPSIntegratedGradientsAttribution' + description: >- + An attribution method that computes Aumann-Shapley values taking + advantage of the model's fully differentiable structure. Refer to + this paper for more details: https://arxiv.org/abs/1703.01365 + ModerateTextRequest: + properties: + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + modelVersion: type: string enumDescriptions: - - Unspecified query type for model error analysis. - - Query similar samples across all classes in the dataset. - - Query similar samples from the same class of the input sample. - - Query dissimilar samples from the same class of the input sample. - type: object - XPSTablesModelStructureModelParameters: - description: Model hyper-parameters for a model. - properties: - hyperparameters: - items: - $ref: >- - #/components/schemas/XPSTablesModelStructureModelParametersParameter - type: array - id: XPSTablesModelStructureModelParameters + - The default model version. + - >- + Use the v1 model, this model is used by default when not provided. + The v1 model only returns probability (confidence) score for each + category. + - >- + Use the v2 model. The v2 model only returns probability + (confidence) score for each category, and returns severity score + for a subset of the categories. + description: Optional. The model version to use for ModerateText. + enum: + - MODEL_VERSION_UNSPECIFIED + - MODEL_VERSION_1 + - MODEL_VERSION_2 + id: ModerateTextRequest type: object + description: The document moderation request message. XPSImageObjectDetectionModelSpec: id: XPSImageObjectDetectionModelSpec - type: object properties: + exportModelSpec: + $ref: '#/components/schemas/XPSImageExportModelSpec' + maxBoundingBoxCount: + type: string + format: int64 + description: Max number of bounding box. + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' classCount: format: int64 - type: string description: Total number of classes. + type: string + trainCostNodeSeconds: + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + format: int64 + type: string modelArtifactSpec: description: '## The fields below are only populated under uCAIP request scope.' $ref: '#/components/schemas/XPSImageModelArtifactSpec' - maxBoundingBoxCount: - type: string - format: int64 - description: Max number of bounding box. - exportModelSpec: - $ref: '#/components/schemas/XPSImageExportModelSpec' stopReason: - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED type: string + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. enumDescriptions: - '' - '' @@ -1858,934 +1768,788 @@ components: - >- Model early converged, can be further trained till full convergency. - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. - trainCostNodeSeconds: - type: string - format: int64 - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - XPSTranslationTrainResponse: + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + type: object + XPSTrainingObjectivePoint: type: object properties: - modelType: - enum: - - MODEL_TYPE_UNSPECIFIED - - LEGACY - - CURRENT + createTime: type: string - enumDescriptions: - - Default - - Legacy model. Will be deprecated. - - Current model. - description: Type of the model. - description: Train response for translation. - id: XPSTranslationTrainResponse - XPSPreprocessResponse: - id: XPSPreprocessResponse - properties: - tablesPreprocessResponse: - $ref: '#/components/schemas/XPSTablesPreprocessResponse' - outputExampleSet: - description: >- - Preprocessed examples, that are to be imported into AutoML storage. - This should point to RecordIO file(s) of PreprocessedExample - messages. The PreprocessedExample.mvp_training_data-s returned here - are later verbatim passed to Train() call in - TrainExample.mvp_training_data. - $ref: '#/components/schemas/XPSExampleSet' - speechPreprocessResp: - $ref: '#/components/schemas/XPSSpeechPreprocessResponse' - translationPreprocessResp: - $ref: '#/components/schemas/XPSTranslationPreprocessResponse' - description: 'Next ID: 8' - type: object - XPSStringStats: + description: The time at which this point was recorded. + format: google-datetime + value: + type: number + description: The objective value when this point was recorded. + format: float + id: XPSTrainingObjectivePoint + XPSMetricEntry: properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - topUnigramStats: - description: >- - The statistics of the top 20 unigrams, ordered by - StringStats.UnigramStats.count. + doubleValue: + format: double + type: number + description: A double value. + int64Value: + type: string + description: A signed 64-bit integer value. + format: int64 + systemLabels: type: array + description: Billing system labels for this (metric, value) pair. items: - $ref: '#/components/schemas/XPSStringStatsUnigramStats' - id: XPSStringStats - description: The data statistics of a series of STRING values. - type: object - XPSEvaluationMetrics: - properties: - tablesClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - label: - type: string - description: >- - The label for which this evaluation metrics instance had been - created. Empty iff this is an overall model evaluation (like Tables - evaluation metrics), i.e. aggregated across all labels. The label - maps to AnnotationSpec.display_name in Public API protos. Only used - by MVP implementation and text sentiment FULL implementation. - textClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - textExtractionEvalMetrics: - $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' - imageClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - videoActionRecognitionEvalMetrics: - $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' - videoObjectTrackingEvalMetrics: - $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' - category: - description: >- - The integer category label for which this evaluation metric instance - had been created. Valid categories are 0 or higher. Overall model - evaluation should set this to negative values (rather than implicit - zero). Only used for Image Segmentation (prefer to set - annotation_spec_id_token instead). Note: uCAIP Image Segmentation - should use annotation_spec_id_token. - type: integer - format: int32 - tablesEvalMetrics: - $ref: '#/components/schemas/XPSTablesEvaluationMetrics' - regressionEvalMetrics: - $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' - translationEvalMetrics: - $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' - textSentimentEvalMetrics: - $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' - videoClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - imageObjectDetectionEvalMetrics: - $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' - imageSegmentationEvalMetrics: - $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' - evaluatedExampleCount: - format: int32 - type: integer - description: >- - The number of examples used to create this evaluation metrics - instance. - annotationSpecIdToken: + $ref: '#/components/schemas/XPSMetricEntryLabel' + metricName: + description: The metric name defined in the service configuration. + type: string + argentumMetricId: type: string description: >- - The annotation_spec for which this evaluation metrics instance had - been created. Empty iff this is an overall model evaluation (like - Tables evaluation metrics), i.e. aggregated across all labels. The - value comes from the input annotations in AnnotatedExample. For MVP - product or for text sentiment models where annotation_spec_id_token - is not available, set label instead. - description: >- - Contains xPS-specific model evaluation metrics either for a single - annotation spec (label), or for the model overall. Next tag: 18. - id: XPSEvaluationMetrics + For billing metrics that are using legacy sku's, set the legacy + billing metric id here. This will be sent to Chemist as the + "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise + leave empty. type: object - AnnotateTextRequestFeatures: - description: >- - All available features. Setting each one to true will enable that - specific analysis for the input. + id: XPSMetricEntry + XPSStringStats: + id: XPSStringStats properties: - extractDocumentSentiment: - type: boolean - description: Optional. Extract document-level sentiment. - extractEntities: - type: boolean - description: Optional. Extract entities. - classifyText: - description: Optional. Classify the full document into categories. - type: boolean - moderateText: + topUnigramStats: + items: + $ref: '#/components/schemas/XPSStringStatsUnigramStats' description: >- - Optional. Moderate the document for harmful and sensitive - categories. - type: boolean + The statistics of the top 20 unigrams, ordered by + StringStats.UnigramStats.count. + type: array + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + description: The data statistics of a series of STRING values. type: object - id: AnnotateTextRequestFeatures - XPSVisualization: + XPSSpeechEvaluationMetricsSubModelEvaluationMetric: + id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric type: object - id: XPSVisualization - deprecated: true properties: - clipPercentLowerbound: - type: number - description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. - format: float - colorMap: + isEnhancedModel: description: >- - The color scheme used for the highlighted areas. Defaults to - PINK_GREEN for Integrated Gradients attribution, which shows - positive attributions in green and negative in pink. Defaults to - VIRIDIS for XRAI attribution, which highlights the most influential - regions in yellow and the least influential in blue. + If true then it means we have an enhanced version of the biasing + models. + type: boolean + numDeletions: + format: int32 + type: integer + numWords: + description: Number of words over which the word error rate was computed. + format: int32 + type: integer + sentenceAccuracy: + format: double + type: number + description: Below fields are used for debugging purposes + wer: + format: double + type: number + description: Word error rate (standard error metric used for speech recognition). + numUtterances: + description: Number of utterances used in the wer computation. + format: int32 + type: integer + numSubstitutions: + format: int32 + type: integer + numInsertions: + type: integer + format: int32 + biasingModelType: + description: Type of the biasing model. enumDescriptions: - - Should not be used. - - 'Positive: green. Negative: pink.' - - >- - Viridis color map: A perceptually uniform color mapping which is - easier to see by those with colorblindness and progresses from - yellow to green to blue. Positive: yellow. Negative: blue. - - 'Positive: red. Negative: red.' - - 'Positive: green. Negative: green.' - - 'Positive: green. Negative: red.' - - PiYG palette. + - '' + - Build biasing model on top of COMMAND_AND_SEARCH model + - Build biasing model on top of PHONE_CALL model + - Build biasing model on top of VIDEO model + - Build biasing model on top of DEFAULT model enum: - - COLOR_MAP_UNSPECIFIED - - PINK_GREEN - - VIRIDIS - - RED - - GREEN - - RED_GREEN - - PINK_WHITE_GREEN + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT type: string - overlayType: - enumDescriptions: - - Default value. This is the same as NONE. - - No overlay. - - The attributions are shown on top of the original image. - - >- - The attributions are shown on top of grayscaled version of the - original image. - - >- - The attributions are used as a mask to reveal predictive parts of - the image and hide the un-predictive parts. - description: >- - How the original image is displayed in the visualization. Adjusting - the overlay can help increase visual clarity if the original image - makes it difficult to view the visualization. Defaults to NONE. + AnalyzeEntitiesRequest: + description: The entity analysis request message. + id: AnalyzeEntitiesRequest + properties: + encodingType: enum: - - OVERLAY_TYPE_UNSPECIFIED - NONE - - ORIGINAL - - GRAYSCALE - - MASK_BLACK - type: string - clipPercentUpperbound: - format: float - type: number - description: >- - Excludes attributions above the specified percentile from the - highlighted areas. Using the clip_percent_upperbound and - clip_percent_lowerbound together can be useful for filtering out - noise and making it easier to see areas of strong attribution. - Defaults to 99.9. - type: + - UTF8 + - UTF16 + - UTF32 + description: The encoding type used by the API to calculate offsets. enumDescriptions: - - Should not be used. - - Shows which pixel contributed to the image prediction. - >- - Shows which region contributed to the image prediction by - outlining the region. - enum: - - TYPE_UNSPECIFIED - - PIXELS - - OUTLINES - type: string - description: >- - Type of the image visualization. Only applicable to Integrated - Gradients attribution. OUTLINES shows regions of attribution, while - PIXELS shows per-pixel attribution. Defaults to OUTLINES. - polarity: - enum: - - POLARITY_UNSPECIFIED - - POSITIVE - - NEGATIVE - - BOTH - description: >- - Whether to only highlight pixels with positive contributions, - negative or both. Defaults to POSITIVE. - enumDescriptions: - - Default value. This is the same as POSITIVE. + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. - >- - Highlights the pixels/outlines that were most influential to the - model's prediction. + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. - >- - Setting polarity to negative highlights areas that does not lead - to the models's current prediction. - - Shows both positive and negative attributions. - type: string - description: Visualization configurations for image explanation. - ClassificationCategory: - type: object - id: ClassificationCategory - description: Represents a category returned from the text classifier. - properties: - severity: - description: >- - Optional. The classifier's severity of the category. This is only - present when the ModerateTextRequest.ModelVersion is set to - MODEL_VERSION_2, and the corresponding category has a severity - score. - type: number - format: float - name: - description: The name of the category representing the document. + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. type: string - confidence: - description: >- - The classifier's confidence of the category. Number represents how - certain the classifier is that this category represents the given - text. - format: float - type: number - InfraUsage: - properties: - ramMetrics: - type: array - items: - $ref: '#/components/schemas/RamMetric' - description: Aggregated ram metrics since requested start_time. - gpuMetrics: - items: - $ref: '#/components/schemas/GpuMetric' - description: Aggregated gpu metrics since requested start_time. - type: array - cpuMetrics: - type: array - items: - $ref: '#/components/schemas/CpuMetric' - description: Aggregated core metrics since requested start_time. - tpuMetrics: - items: - $ref: '#/components/schemas/TpuMetric' - type: array - description: Aggregated tpu metrics since requested start_time. - diskMetrics: - description: Aggregated persistent disk metrics since requested start_time. - type: array - items: - $ref: '#/components/schemas/DiskMetric' - description: 'Infra Usage of billing metrics. Next ID: 6' + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' type: object - id: InfraUsage - XPSSpeechPreprocessStats: - properties: - numLogsExamples: - format: int32 - description: The number of samples found in the previously recorded logs data. - type: integer - numHumanLabeledExamples: - type: integer - description: The number of rows marked HUMAN_LABELLED - format: int32 - trainSentencesCount: - format: int32 - type: integer - description: The number of sentences in the training data set. - trainExamplesCount: - description: The number of examples labeled as TRAIN by Speech xps server. - type: integer - format: int32 - dataErrors: - type: array - description: Different types of data errors and the counts associated with them. - items: - $ref: '#/components/schemas/XPSDataErrors' - testExamplesCount: - description: The number of examples labelled as TEST by Speech xps server. - format: int32 - type: integer - numMachineTranscribedExamples: - type: integer - format: int32 - description: The number of rows marked as MACHINE_TRANSCRIBED - testSentencesCount: - type: integer - description: The number of sentences in the test data set. - format: int32 - trainWordsCount: - format: int32 - description: The number of words in the training data set. - type: integer - testWordsCount: - format: int32 - type: integer - description: The number of words in the test data set. - id: XPSSpeechPreprocessStats + ClassifyTextRequest: + id: ClassifyTextRequest + description: The document classification request message. type: object - XPSTfJsFormat: - description: >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used - in the browser and in Node.js using JavaScript. - properties: {} + properties: + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + XPSResponseExplanationMetadata: + id: XPSResponseExplanationMetadata type: object - id: XPSTfJsFormat - Document: + properties: + outputs: + type: object + additionalProperties: + $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' + description: Metadata of the output. + inputs: + description: Metadata of the input. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' + deprecated: true + XPSImageObjectDetectionEvaluationMetrics: type: object - description: Represents the input to API methods. + description: >- + Model evaluation metrics for image object detection problems. Evaluates + prediction quality of labeled bounding boxes. + id: XPSImageObjectDetectionEvaluationMetrics properties: - type: - type: string + boundingBoxMeanAveragePrecision: + format: float + type: number description: >- - Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns - an `INVALID_ARGUMENT` error. - enumDescriptions: - - The content type is not specified. - - Plain text - - HTML - enum: - - TYPE_UNSPECIFIED - - PLAIN_TEXT - - HTML - languageCode: - type: string + The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. + boundingBoxMetricsEntries: + type: array + items: + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' description: >- - Optional. The language of the document (if not specified, the - language is automatically detected). Both ISO and BCP-47 language - codes are accepted. [Language - Support](https://cloud.google.com/natural-language/docs/languages) - lists currently supported languages for each API method. If the - language (either specified by the caller or automatically detected) - is not supported by the called API method, an `INVALID_ARGUMENT` - error is returned. - gcsContentUri: + The bounding boxes match metrics for each Intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + evaluatedBoundingBoxCount: description: >- - The Google Cloud Storage URI where the file content is located. This - URI must be of the form: gs://bucket_name/object_name. For more - details, see https://cloud.google.com/storage/docs/reference-uris. - NOTE: Cloud Storage object versioning is not supported. + The total number of bounding boxes (i.e. summed over all images) the + ground truth used to create this evaluation had. + type: integer + format: int32 + XPSMetricEntryLabel: + properties: + labelName: type: string - content: - description: >- - The content of the input in string format. Cloud audit logging - exempt since it is based on user data. + description: The name of the label. + labelValue: type: string - id: Document - XPSSpeechPreprocessResponse: - id: XPSSpeechPreprocessResponse + description: The value of the label. + id: XPSMetricEntryLabel + type: object + XPSTablesModelStructureModelParametersParameter: properties: - prebuiltModelEvaluationMetrics: - $ref: '#/components/schemas/XPSSpeechEvaluationMetrics' - description: >- - The metrics for prebuilt speech models. They are included here - because there is no prebuilt speech models stored in the AutoML. - cnsTestDataPath: + floatValue: + type: number + description: Float type parameter value. + format: double + name: + description: Parameter name. type: string - description: Location od shards of sstables (test data) of DataUtterance protos. - speechPreprocessStats: - $ref: '#/components/schemas/XPSSpeechPreprocessStats' - description: Stats associated with the data. - cnsTrainDataPath: + stringValue: + description: String type parameter value. type: string - description: >- - Location of shards of sstables (training data) of DataUtterance - protos. - type: object - XPSTablesTrainResponse: - id: XPSTablesTrainResponse + intValue: + type: string + description: Integer type parameter value. + format: int64 + id: XPSTablesModelStructureModelParametersParameter type: object + AnnotateTextResponse: + description: The text annotations response message. properties: - tablesModelColumnInfo: + languageSupported: + type: boolean description: >- - Output only. Auxiliary information for each of the - input_feature_column_specs, with respect to this particular model. + Whether the language is officially supported by all requested + features. The API may still return a response when the language is + not supported, but it is on a best effort basis. + categories: items: - $ref: '#/components/schemas/XPSTablesModelColumnInfo' - type: array - predictionSampleRows: + $ref: '#/components/schemas/ClassificationCategory' + description: Categories identified in the input document. type: array - description: Sample rows from the dataset this model was trained. - items: - $ref: '#/components/schemas/XPSRow' - modelStructure: - $ref: '#/components/schemas/XPSTablesModelStructure' - trainCostMilliNodeHours: + languageCode: type: string description: >- - The actual training cost of the model, expressed in milli node - hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed - to not exceed the train budget. - format: int64 - Status: - properties: - details: + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + documentSentiment: + $ref: '#/components/schemas/Sentiment' + description: >- + The overall sentiment for the document. Populated if the user + enables AnnotateTextRequest.Features.extract_document_sentiment. + moderationCategories: items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + $ref: '#/components/schemas/ClassificationCategory' + description: Harmful and sensitive categories identified in the input document. + type: array + entities: + type: array + items: + $ref: '#/components/schemas/Entity' description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Entities, along with their semantic information, in the input + document. Populated if the user enables + AnnotateTextRequest.Features.extract_entities or + AnnotateTextRequest.Features.extract_entity_sentiment. + sentences: type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: + items: + $ref: '#/components/schemas/Sentence' description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - type: object - id: Status - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - XPSEdgeTpuTfLiteFormat: - description: >- - A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) - devices. + Sentences in the input document. Populated if the user enables + AnnotateTextRequest.Features.extract_document_sentiment. + id: AnnotateTextResponse type: object - properties: {} - id: XPSEdgeTpuTfLiteFormat - XPSVideoExportModelSpec: - id: XPSVideoExportModelSpec + XPSVideoBatchPredictOperationMetadata: + id: XPSVideoBatchPredictOperationMetadata properties: - exportModelOutputConfig: - type: array + outputExamples: + items: + type: string description: >- - Contains the model format and internal location of the model files - to be exported/downloaded. Use the GCS bucket name which is provided - via TrainRequest.gcs_bucket_name to store the model files. + All the partial batch prediction results that are completed at the + moment. Output examples are sorted by completion time. The order + will not be changed. Each output example should be the path of a + single RecordIO file of AnnotatedExamples. + type: array + type: object + XPSEvaluationMetricsSet: + id: XPSEvaluationMetricsSet + properties: + evaluationMetrics: items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' + $ref: '#/components/schemas/XPSEvaluationMetrics' + type: array + description: >- + Inline EvaluationMetrics - should be relatively small. For passing + large quantities of exhaustive metrics, use file_spec. + numEvaluationMetrics: + type: string + format: int64 + description: >- + Number of the evaluation metrics (usually one per label plus + overall). + fileSpec: + $ref: '#/components/schemas/XPSFileSpec' + description: >- + File spec containing evaluation metrics of a model, must point to + RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics + messages. + description: Specifies location of model evaluation metrics. type: object - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Upon receiving - ExportModel request from user, AutoMl backend can serve the - pre-generated models to user if exists (by copying the files from - internal path to user provided location), otherwise, AutoMl backend will - call xPS ExportModel API to generate the model on the fly with the - requesting format. - XPSImageModelServingSpecModelThroughputEstimation: - id: XPSImageModelServingSpecModelThroughputEstimation + XPSTranslationPreprocessResponse: + description: Translation preprocess response. properties: - computeEngineAcceleratorType: - enumDescriptions: - - '' - - Nvidia Tesla K80 GPU. - - Nvidia Tesla P100 GPU. - - Nvidia Tesla V100 GPU. - - Nvidia Tesla P4 GPU. - - Nvidia Tesla T4 GPU. - - Nvidia Tesla A100 GPU. - - Nvidia A100 80GB GPU. - - Nvidia L4 GPU. - - Nvidia H100 80Gb GPU. - - Nvidia H100 80Gb GPU. - - TPU v2 (JellyFish). - - TPU v3 (DragonFish). - - TPU_v4 (PufferFish). - - TPU v5 Lite Pods. - enum: - - UNSPECIFIED - - NVIDIA_TESLA_K80 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_V100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_L4 - - NVIDIA_H100_80GB - - NVIDIA_H100_MEGA_80GB - - TPU_V2 - - TPU_V3 - - TPU_V4_POD - - TPU_V5_LITEPOD + validExampleCount: type: string - servomaticPartitionType: - enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU + description: Total valid example count. + format: int64 + parsedExampleCount: type: string - enumDescriptions: - - '' - - The default partition. - - >- - It has significantly lower replication than partition-0 and is - located in the US only. It also has a larger model size limit and - higher default RAM quota than partition-0. Customers with batch - traffic, US-based traffic, or very large models should use this - partition. Capacity in this partition is significantly cheaper - than partition-0. - - >- - To be used by customers with Jellyfish-accelerated ops. See - go/servomatic-jellyfish for details. - - The partition used by regionalized servomatic cloud regions. - - The partition used for loading models from custom storage. - nodeQps: - format: double - description: The approximate qps a deployed node can serve. - type: number - latencyInMilliseconds: - description: Estimated latency. - format: double - type: number - type: object - XPSSpeechEvaluationMetrics: + format: int64 + description: Total example count parsed. type: object + id: XPSTranslationPreprocessResponse + XPSVideoObjectTrackingEvaluationMetrics: properties: - subModelEvaluationMetrics: + evaluatedBoundingboxCount: + type: integer + description: The number of bounding boxes used for model evaluation. + format: int32 + boundingBoxMeanAveragePrecision: + type: number + description: >- + Output only. The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. + format: float + trackMeanMismatchRate: + type: number + format: float + description: >- + Output only. The single metric for tracking consistency evaluation: + the mean_mismatch_rate averaged over all track_metrics_entries. + trackMetricsEntries: + description: >- + Output only. The tracks match metrics for each + Intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. items: - $ref: >- - #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric - description: Evaluation metrics for all submodels contained in this model. - type: array - id: XPSSpeechEvaluationMetrics - XPSBoundingBoxMetricsEntry: - properties: - confidenceMetricsEntries: + $ref: '#/components/schemas/XPSTrackMetricsEntry' type: array + evaluatedTrackCount: + format: int32 + description: The number of tracks used for model evaluation. + type: integer + trackMeanAveragePrecision: + type: number + description: >- + Output only. The single metric for tracks accuracy evaluation: the + mean_average_precision averaged over all track_metrics_entries. + format: float + boundingBoxMetricsEntries: items: - $ref: >- - #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' description: >- - Metrics for each label-match confidence_threshold from + Output only. The bounding boxes match metrics for each + Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - meanAveragePrecision: - type: number - format: float - description: The mean average precision. - iouThreshold: + type: array + evaluatedFrameCount: + format: int32 + type: integer + description: The number of video frames used for model evaluation. + trackMeanBoundingBoxIou: description: >- - The intersection-over-union threshold value used to compute this - metrics entry. + Output only. The single metric for tracks bounding box iou + evaluation: the mean_bounding_box_iou averaged over all + track_metrics_entries. type: number format: float type: object + description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' + id: XPSVideoObjectTrackingEvaluationMetrics + AnnotateTextRequestFeatures: description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. - id: XPSBoundingBoxMetricsEntry - XPSTfLiteFormat: + All available features. Setting each one to true will enable that + specific analysis for the input. + type: object + id: AnnotateTextRequestFeatures + properties: + classifyText: + description: Optional. Classify the full document into categories. + type: boolean + extractEntities: + type: boolean + description: Optional. Extract entities. + extractDocumentSentiment: + type: boolean + description: Optional. Extract document-level sentiment. + moderateText: + description: >- + Optional. Moderate the document for harmful and sensitive + categories. + type: boolean + XPSXraiAttribution: + deprecated: true + id: XPSXraiAttribution description: >- - LINT.IfChange A model format used for mobile and IoT devices. See - https://www.tensorflow.org/lite. + An explanation method that redistributes Integrated Gradients + attributions to segmented regions, taking advantage of the model's fully + differentiable structure. Refer to this paper for more details: + https://arxiv.org/abs/1906.02825 Only supports image Models (modality is + IMAGE). + properties: + stepCount: + description: >- + The number of steps for approximating the path integral. A good + value to start is 50 and gradually increase until the sum to diff + property is met within the desired error range. Valid range of its + value is [1, 100], inclusively. + format: int32 + type: integer + type: object + XPSExampleSet: + properties: + fingerprint: + format: int64 + description: Fingerprint of the example set. + type: string + fileSpec: + $ref: '#/components/schemas/XPSFileSpec' + description: File spec of the examples or input sources. + numInputSources: + description: Number of input sources. + type: string + format: int64 + numExamples: + type: string + format: int64 + description: Number of examples. type: object - id: XPSTfLiteFormat - properties: {} - XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: + id: XPSExampleSet + description: Set of examples or input sources. + XPSTableSpec: + properties: + rowCount: + type: string + description: The number of rows in the table. + format: int64 + columnSpecs: + additionalProperties: + $ref: '#/components/schemas/XPSColumnSpec' + description: Mapping from column id to column spec. + type: object + timeColumnId: + format: int32 + type: integer + description: The id of the time column. + importedDataSizeInBytes: + format: int64 + description: The total size of imported data of the table. + type: string + validRowCount: + type: string + format: int64 + description: The number of valid rows. + type: object + id: XPSTableSpec + XPSRegressionMetricsEntry: + description: A pair of actual & observed values for the model being evaluated. + id: XPSRegressionMetricsEntry type: object - id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry - description: Metrics for a single confidence threshold. properties: - confidenceThreshold: - type: number - format: float - description: The confidence threshold value used to compute the metrics. - precision: - description: Precision for the given confidence threshold. + trueValue: type: number + description: The actual target value for a row in the dataset. format: float - recall: - format: float + predictedValue: + description: The observed value for a row in the dataset. type: number - description: Recall for the given confidence threshold. - f1Score: format: float - description: The harmonic mean of recall and precision. - type: number - Sentiment: - id: Sentiment + XPSReportingMetrics: properties: - score: + metricEntries: + type: array description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). - type: number - format: float - magnitude: - type: number + One entry per metric name. The values must be aggregated per metric + name. + items: + $ref: '#/components/schemas/XPSMetricEntry' + effectiveTrainingDuration: + format: google-duration description: >- - A non-negative number in the [0, +inf) range, which represents the - absolute magnitude of sentiment regardless of score (positive or - negative). - format: float - type: object - description: >- - Represents the feeling associated with the entire text or entities in - the text. - XPSMetricEntryLabel: - properties: - labelName: - description: The name of the label. - type: string - labelValue: + The effective time training used. If set, this is used for quota + management and billing. Deprecated. AutoML BE doesn't use this. + Don't set. + deprecated: true type: string - description: The value of the label. - id: XPSMetricEntryLabel type: object - XPSSpeechEvaluationMetricsSubModelEvaluationMetric: + id: XPSReportingMetrics + XPSIntegratedGradientsAttribution: + id: XPSIntegratedGradientsAttribution + description: >- + An attribution method that computes the Aumann-Shapley value taking + advantage of the model's fully differentiable structure. Refer to this + paper for more details: https://arxiv.org/abs/1703.01365 + deprecated: true type: object - id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric properties: - numSubstitutions: - format: int32 - type: integer - numUtterances: + stepCount: format: int32 type: integer - description: Number of utterances used in the wer computation. - isEnhancedModel: description: >- - If true then it means we have an enhanced version of the biasing - models. - type: boolean - numInsertions: - format: int32 - type: integer - sentenceAccuracy: - format: double - description: Below fields are used for debugging purposes - type: number - wer: - type: number - description: Word error rate (standard error metric used for speech recognition). - format: double - biasingModelType: - enumDescriptions: - - '' - - Build biasing model on top of COMMAND_AND_SEARCH model - - Build biasing model on top of PHONE_CALL model - - Build biasing model on top of VIDEO model - - Build biasing model on top of DEFAULT model - type: string - description: Type of the biasing model. - enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT - numWords: - description: Number of words over which the word error rate was computed. - type: integer - format: int32 - numDeletions: - format: int32 - type: integer - AnalyzeEntitiesResponse: + The number of steps for approximating the path integral. A good + value to start is 50 and gradually increase until the sum to diff + property is within the desired error range. Valid range of its value + is [1, 100], inclusively. + XPSTuningTrial: + id: XPSTuningTrial type: object + description: >- + Metrics for a tuning job generated, will get forwarded to Stackdriver as + model tuning logs. Setting this as a standalone message out of + CreateModelMetadata to avoid confusion as we expose this message only to + users. properties: - languageCode: - description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - type: string - languageSupported: - type: boolean - description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - entities: - items: - $ref: '#/components/schemas/Entity' - type: array - description: The recognized entities in the input document. - description: The entity analysis response message. - id: AnalyzeEntitiesResponse - XPSFloat64Stats: - properties: - quantiles: - description: >- - Ordered from 0 to k k-quantile values of the data series of n - values. The value at index i is, approximately, the i*n/k-th - smallest value in the series; for i = 0 and i = k these are, - respectively, the min and max values. - type: array - items: - format: double - type: number - standardDeviation: - type: number - format: double - description: The standard deviation of the series. - mean: - type: number - description: The mean of the series. - format: double - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - histogramBuckets: - description: >- - Histogram buckets of the data series. Sorted by the min value of the - bucket, ascendingly, and the number of the buckets is dynamically - generated. The buckets are non-overlapping and completely cover - whole FLOAT64 range with min of first bucket being `"-Infinity"`, - and max of the last one being `"Infinity"`. - items: - $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' - type: array - description: The data statistics of a series of FLOAT64 values. - id: XPSFloat64Stats - type: object - XPSTextComponentModel: + modelStructure: + $ref: '#/components/schemas/XPSTablesModelStructure' + description: Model parameters for the trial. + trainingObjectivePoint: + description: The optimization objective evaluation of the eval split data. + $ref: '#/components/schemas/XPSTrainingObjectivePoint' + XPSFileSpec: properties: - tfRuntimeVersion: + fileFormat: type: string - description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list - submodelType: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - Model type for entity extraction. - - Model type for relationship extraction. - - >- - A composite model represents a set of component models that have - to be used together for prediction. A composite model appears to - be a single model to the model user. It may contain only one - component model. Please refer to go/cnl-composite-models for more - information. + enumDeprecated: + - false + - true + - false + - false + - false + - false + enum: + - FILE_FORMAT_UNKNOWN + - FILE_FORMAT_SSTABLE + - FILE_FORMAT_TRANSLATION_RKV + - FILE_FORMAT_RECORDIO + - FILE_FORMAT_RAW_CSV + - FILE_FORMAT_RAW_CAPACITOR + enumDescriptions: + - '' + - '' - >- - Model type used to train default, MA, and ATC models in a single - batch worker pipeline. + Internal format for parallel text data used by Google Translate. + go/rkvtools + - '' - >- - BERT pipeline needs a specific model type, since it uses a - different TFX configuration compared with DEFAULT (despite sharing - most of the code). - - Model type for EncPaLM. + Only the lexicographically first file described by the file_spec + contains the header line. + - '' + singleFilePath: + description: Deprecated. Use file_spec. type: string - enum: - - TEXT_MODEL_TYPE_UNSPECIFIED - - TEXT_MODEL_TYPE_DEFAULT - - TEXT_MODEL_TYPE_META_ARCHITECT - - TEXT_MODEL_TYPE_ATC - - TEXT_MODEL_TYPE_CLARA2 - - TEXT_MODEL_TYPE_CHATBASE - - TEXT_MODEL_TYPE_SAFT_SPAN_LABELING - - TEXT_MODEL_TYPE_TEXT_EXTRACTION - - TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION - - TEXT_MODEL_TYPE_COMPOSITE - - TEXT_MODEL_TYPE_ALL_MODELS - - TEXT_MODEL_TYPE_BERT - - TEXT_MODEL_TYPE_ENC_PALM - description: The type of trained NL submodel - batchPredictionModelGcsUri: + deprecated: true + fileSpec: type: string - description: The Cloud Storage resource path to hold batch prediction model. - partition: description: >- - The partition where the model is deployed. Populated by uCAIP BE as - part of online PredictRequest. + Single file path, or file pattern of format + "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is + expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and + /cns/cell-d/somewhere/file-00001-of-00002. + directoryPath: + type: string + deprecated: true + description: Deprecated. Use file_spec. + description: >- + Spec of input and output files, on external file systems (CNS, GCS, + etc). + type: object + id: XPSFileSpec + XPSSpeechModelSpecSubModelSpec: + id: XPSSpeechModelSpecSubModelSpec + properties: + clientId: + type: string + description: In S3, Recognition ClientContextId.client_id + isEnhancedModel: + type: boolean + description: >- + If true then it means we have an enhanced version of the biasing + models. + contextId: + type: string + description: In S3, Recognition ClientContextId.context_id + biasingModelType: type: string - enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU enumDescriptions: - '' - - The default partition. - - >- - It has significantly lower replication than partition-0 and is - located in the US only. It also has a larger model size limit and - higher default RAM quota than partition-0. Customers with batch - traffic, US-based traffic, or very large models should use this - partition. Capacity in this partition is significantly cheaper - than partition-0. - - >- - To be used by customers with Jellyfish-accelerated ops. See - go/servomatic-jellyfish for details. - - The partition used by regionalized servomatic cloud regions. - - The partition used for loading models from custom storage. - submodelName: + - Build biasing model on top of COMMAND_AND_SEARCH model + - Build biasing model on top of PHONE_CALL model + - Build biasing model on top of VIDEO model + - Build biasing model on top of DEFAULT model + enum: + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT + description: Type of the biasing model. + type: object + XPSSpeechPreprocessResponse: + type: object + id: XPSSpeechPreprocessResponse + properties: + cnsTrainDataPath: type: string - description: The name of the trained NL submodel. - servoModelName: description: >- - The name of servo model. Populated by uCAIP BE as part of online - PredictRequest. + Location of shards of sstables (training data) of DataUtterance + protos. + speechPreprocessStats: + description: Stats associated with the data. + $ref: '#/components/schemas/XPSSpeechPreprocessStats' + cnsTestDataPath: type: string - servingArtifact: + description: Location od shards of sstables (test data) of DataUtterance protos. + prebuiltModelEvaluationMetrics: + $ref: '#/components/schemas/XPSSpeechEvaluationMetrics' description: >- - The default model binary file used for serving (e.g. online predict, - batch predict) via public Cloud Ai Platform API. - $ref: '#/components/schemas/XPSModelArtifactItem' - versionNumber: - type: string - format: int64 + The metrics for prebuilt speech models. They are included here + because there is no prebuilt speech models stored in the AutoML. + XPSVideoActionMetricsEntry: + id: XPSVideoActionMetricsEntry + properties: + meanAveragePrecision: + description: The mean average precision. + type: number + format: float + confidenceMetricsEntries: description: >- - The servomatic model version number. Populated by uCAIP BE as part - of online PredictRequest. - onlinePredictionModelGcsUri: - description: The Cloud Storage resource path to hold online prediction model. + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + items: + $ref: >- + #/components/schemas/XPSVideoActionMetricsEntryConfidenceMetricsEntry + type: array + precisionWindowLength: type: string + format: google-duration + description: >- + This VideoActionMetricsEntry is calculated based on this prediction + window length. If the predicted action's timestamp is inside the + time window whose center is the ground truth action's timestamp with + this specific length, the prediction result is treated as a true + positive. type: object - id: XPSTextComponentModel - description: 'Component model. Next ID: 10' - XPSTranslationPreprocessResponse: + description: The Evaluation metrics entry given a specific precision_window_length. + XPSVideoActionRecognitionTrainResponse: properties: - validExampleCount: + trainCostNodeSeconds: + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. format: int64 - description: Total valid example count. type: string - parsedExampleCount: - description: Total example count parsed. + modelArtifactSpec: + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + description: '## The fields below are only populated under uCAIP request scope.' + id: XPSVideoActionRecognitionTrainResponse + type: object + XPSResponseExplanationMetadataOutputMetadata: + type: object + id: XPSResponseExplanationMetadataOutputMetadata + properties: + outputTensorName: type: string - format: int64 - id: XPSTranslationPreprocessResponse + description: Name of the output tensor. Only needed in train response. + description: Metadata of the prediction output to be explained. + XPSResponseExplanationSpec: type: object - description: Translation preprocess response. - CpuMetric: + properties: + parameters: + $ref: '#/components/schemas/XPSResponseExplanationParameters' + description: Parameters that configure explaining of the Model's predictions. + metadata: + description: Metadata describing the Model's input and output for explanation. + $ref: '#/components/schemas/XPSResponseExplanationMetadata' + explanationType: + type: string + description: >- + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + id: XPSResponseExplanationSpec + deprecated: true + description: >- + Specification of Model explanation. Feature-based XAI in AutoML Vision + ICN is deprecated, see b/288407203 for context. + TextSpan: + properties: + content: + description: The content of the text span, which is a substring of the document. + type: string + beginOffset: + description: >- + The API calculates the beginning offset of the content in the + original document according to the EncodingType specified in the API + request. + format: int32 + type: integer + description: Represents a text span in the input document. + type: object + id: TextSpan + XPSSpeechPreprocessStats: type: object properties: - cpuType: + trainSentencesCount: + type: integer + description: The number of sentences in the training data set. + format: int32 + numLogsExamples: + format: int32 + description: The number of samples found in the previously recorded logs data. + type: integer + dataErrors: + description: Different types of data errors and the counts associated with them. + type: array + items: + $ref: '#/components/schemas/XPSDataErrors' + trainExamplesCount: + format: int32 + description: The number of examples labeled as TRAIN by Speech xps server. + type: integer + numMachineTranscribedExamples: + description: The number of rows marked as MACHINE_TRANSCRIBED + format: int32 + type: integer + numHumanLabeledExamples: + type: integer + description: The number of rows marked HUMAN_LABELLED + format: int32 + testWordsCount: + description: The number of words in the test data set. + format: int32 + type: integer + trainWordsCount: + type: integer + format: int32 + description: The number of words in the training data set. + testSentencesCount: + description: The number of sentences in the test data set. + format: int32 + type: integer + testExamplesCount: + type: integer + description: The number of examples labelled as TEST by Speech xps server. + format: int32 + id: XPSSpeechPreprocessStats + GpuMetric: + id: GpuMetric + properties: + gpuType: + enum: + - UNKNOWN_GPU_TYPE + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_TESLA_K80 + - NVIDIA_L4 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_V100 + - NVIDIA_H100_80GB + description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. type: string enumDescriptions: - '' - - GPU-based machine, skip quota reporting. - - GPU-based machine, skip quota reporting. - - COMPUTE_OPTIMIZED - '' - '' - '' - - GPU-based machine, skip quota reporting. - '' - - MEMORY_OPTIMIZED_UPGRADE_PREMIUM - - MEMORY_OPTIMIZED - '' - '' - '' - '' - description: Required. Type of cpu, e.g. N2. - enum: - - UNKNOWN_CPU_TYPE - - A2 - - A3 - - C2 - - C2D - - CUSTOM - - E2 - - G2 - - C3 - - M2 - - M1 - - N1 - - N2_CUSTOM - - N2 - - N2D - coreNumber: - description: Required. Number of CPU cores. + - '' + gpuSec: + description: Required. Seconds of GPU usage, e.g. 3600. format: int64 type: string trackingLabels: @@ -2798,168 +2562,7 @@ components: are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" machineSpec: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + description: Required. Machine spec, e.g. N1_STANDARD_4. type: string enum: - UNKNOWN_MACHINE_SPEC @@ -3123,1273 +2726,1146 @@ components: - C3_HIGHMEM_44 - C3_HIGHMEM_88 - C3_HIGHMEM_176 - description: Required. Machine spec, e.g. N1_STANDARD_4. - coreSec: - description: Required. Total seconds of core usage, e.g. 4. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: object + XPSImageClassificationTrainResponse: + type: object + properties: + stopReason: + enumDescriptions: + - '' + - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + type: string + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + modelArtifactSpec: + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + description: '## The fields below are only populated under uCAIP request scope.' + exportModelSpec: + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Populated for + AutoMl requests. + $ref: '#/components/schemas/XPSImageExportModelSpec' + trainCostInNodeTime: + description: >- + The actual cost to create this model. - For edge type model, the + cost is expressed in node hour. - For cloud type model,the cost is + expressed in compute hour. - Populated for models created before GA. + To be deprecated after GA. + format: google-duration + type: string + classCount: + description: Total number of classes. + format: int64 type: string + trainCostNodeSeconds: format: int64 - id: CpuMetric - description: Metric for billing reports. - XPSVideoActionRecognitionEvaluationMetrics: + description: >- + The actual training cost, expressed in node seconds. Populated for + models trained in node time. + type: string + id: XPSImageClassificationTrainResponse + XPSBoundingBoxMetricsEntry: + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. + type: object properties: - evaluatedActionCount: - type: integer - format: int32 + meanAveragePrecision: + type: number + format: float + description: The mean average precision. + iouThreshold: + format: float + type: number description: >- - Output only. The number of ground truth actions used to create this - evaluation. - videoActionMetricsEntries: + The intersection-over-union threshold value used to compute this + metrics entry. + confidenceMetricsEntries: items: - $ref: '#/components/schemas/XPSVideoActionMetricsEntry' - description: >- - Output only. The metric entries for precision window lengths: - 1s,2s,3s,4s, 5s. + $ref: >- + #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry type: array + description: >- + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + id: XPSBoundingBoxMetricsEntry + XPSColumnSpecForecastingMetadata: type: object - id: XPSVideoActionRecognitionEvaluationMetrics - description: Model evaluation metrics for video action recognition. - XPSRegressionEvaluationMetrics: + properties: + columnType: + enum: + - COLUMN_TYPE_UNSPECIFIED + - KEY + - KEY_METADATA + - TIME_SERIES_AVAILABLE_PAST_ONLY + - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE + description: The type of the column for FORECASTING model training purposes. + enumDescriptions: + - An un-set value of this enum. + - Key columns are used to identify timeseries. + - >- + This column contains information describing static properties of + the entities identified by the key column(s) (e.g. city's ZIP + code). + - >- + This column contains information for the given entity, at any time + poinrt, they are only available in the time series before. + - >- + This column contains information for the given entity is known + both for the past and the sufficiently far future. + type: string + id: XPSColumnSpecForecastingMetadata description: >- - Model evaluation metrics for regression problems. It can be used for - Tables. + =========================================================================== + # The fields below are used exclusively for Forecasting. + XPSTfSavedModelFormat: + description: A tensorflow model format in SavedModel format. + properties: {} + id: XPSTfSavedModelFormat + type: object + XPSSpeechModelSpec: + id: XPSSpeechModelSpec + type: object + properties: + language: + type: string + datasetId: + format: int64 + type: string + description: >- + Required for speech xps backend. Speech xps has to use dataset_id + and model_id as the primary key in db so that speech API can query + the db directly. + subModelSpecs: + description: Model specs for all submodels contained in this model. + type: array + items: + $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' + XPSTablesRegressionMetrics: type: object + description: Metrics for Tables regression problems. + id: XPSTablesRegressionMetrics properties: - rSquared: - format: float - type: number - description: R squared. - rootMeanSquaredError: - type: number - description: Root Mean Squared Error (RMSE). - format: float regressionMetricsEntries: + items: + $ref: '#/components/schemas/XPSRegressionMetricsEntry' description: >- A list of actual versus predicted points for the model being evaluated. type: array - items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' meanAbsolutePercentageError: description: >- - Mean absolute percentage error. Only set if all ground truth values - are positive. - format: float - type: number - meanAbsoluteError: + Mean absolute percentage error, only set if all of the target + column's values are positive. + format: double type: number - description: Mean Absolute Error (MAE). - format: float rootMeanSquaredLogError: - format: float - type: number description: Root mean squared log error. - id: XPSRegressionEvaluationMetrics - XPSFloat64StatsHistogramBucket: - type: object - properties: - max: - type: number - format: double - description: >- - The maximum value of the bucket, exclusive unless max = - `"Infinity"`, in which case it's inclusive. - count: - description: >- - The number of data values that are in the bucket, i.e. are between - min and max values. - format: int64 - type: string - min: format: double - description: The minimum value of the bucket, inclusive. type: number - description: A bucket of a histogram. - id: XPSFloat64StatsHistogramBucket - XPSEvaluationMetricsSet: - properties: - fileSpec: - $ref: '#/components/schemas/XPSFileSpec' - description: >- - File spec containing evaluation metrics of a model, must point to - RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics - messages. - evaluationMetrics: - type: array - items: - $ref: '#/components/schemas/XPSEvaluationMetrics' - description: >- - Inline EvaluationMetrics - should be relatively small. For passing - large quantities of exhaustive metrics, use file_spec. - numEvaluationMetrics: - type: string - format: int64 - description: >- - Number of the evaluation metrics (usually one per label plus - overall). - description: Specifies location of model evaluation metrics. - type: object - id: XPSEvaluationMetricsSet - XPSConfidenceMetricsEntry: - properties: - precision: + meanAbsoluteError: + description: Mean absolute error. + format: double type: number - description: Precision for the given confidence threshold. - format: float - f1ScoreAt1: + rootMeanSquaredError: type: number - description: The harmonic mean of recall_at1 and precision_at1. - format: float - falsePositiveRate: - format: float + format: double + description: Root mean squared error. + rSquared: + description: R squared. type: number - description: False Positive Rate for the given confidence threshold. - falseNegativeCount: - format: int64 - type: string - description: >- - The number of ground truth labels that are not matched by a model - created label. - positionThreshold: - type: integer + format: double + XPSTablesModelColumnInfo: + id: XPSTablesModelColumnInfo + properties: + columnId: format: int32 - description: >- - Metrics are computed with an assumption that the model always - returns at most this many predictions (ordered by their score, - descendingly), but they all still need to meet the - confidence_threshold. - recallAt1: - type: number - description: >- - The recall (true positive rate) when only considering the label that - has the highest prediction score and not below the confidence - threshold for each example. - format: float - precisionAt1: - type: number - format: float - description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - example. - recall: + description: The ID of the column. + type: integer + featureImportance: format: float - description: Recall (true positive rate) for the given confidence threshold. - type: number - confidenceThreshold: - description: >- - Metrics are computed with an assumption that the model never return - predictions with score lower than this value. type: number - format: float - truePositiveCount: - format: int64 - description: The number of model created labels that match a ground truth label. - type: string - trueNegativeCount: - type: string - format: int64 description: >- - The number of labels that were not created by the model, but if they - would, they would not match a ground truth label. - falsePositiveRateAt1: + When given as part of a Model: Measurement of how much model + predictions correctness on the TEST data depend on values in this + column. A value between 0 and 1, higher means higher influence. + These values are normalized - for all input feature columns of a + given model they add to 1. When given back by Predict or Batch + Predict: Measurement of how impactful for the prediction returned + for the given row the value in this column was. Specifically, the + feature importance specifies the marginal contribution that the + feature made to the prediction score compared to the baseline score. + These values are computed using the Sampled Shapley method. + description: >- + An information specific to given column and Tables Model, in context of + the Model and the predictions created by it. + type: object + EntityMention: + id: EntityMention + type: object + properties: + probability: format: float description: >- - The False Positive Rate when only considering the label that has the - highest prediction score and not below the confidence threshold for - each example. + Probability score associated with the entity. The score shows the + probability of the entity mention being the entity type. The score + is in (0, 1] range. type: number - falsePositiveCount: + sentiment: + $ref: '#/components/schemas/Sentiment' description: >- - The number of model created labels that do not match a ground truth - label. + For calls to AnalyzeEntitySentiment or if + AnnotateTextRequest.Features.extract_entity_sentiment is set to + true, this field will contain the sentiment expressed for this + mention of the entity in the provided document. + text: + $ref: '#/components/schemas/TextSpan' + description: The mention text. + type: + description: The type of the entity mention. type: string - format: int64 - f1Score: - format: float - type: number - description: The harmonic mean of recall and precision. - type: object - id: XPSConfidenceMetricsEntry + enumDescriptions: + - Unknown + - Proper name + - Common noun (or noun compound) + enum: + - TYPE_UNKNOWN + - PROPER + - COMMON description: >- - ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. - Next tag: 16. - XPSXpsOperationMetadata: - type: object - id: XPSXpsOperationMetadata + Represents a mention for an entity in the text. Currently, proper noun + mentions are supported. + XPSTablesPreprocessResponse: properties: - exampleCount: - format: int64 - type: string - description: >- - Optional. XPS server can opt to provide example count of the long - running operation (e.g. training, data importing, batch prediction). - reportingMetrics: - $ref: '#/components/schemas/XPSReportingMetrics' + tablesDatasetMetadata: + $ref: '#/components/schemas/XPSTablesDatasetMetadata' description: >- - Metrics for the operation. By the time the operation is terminated - (whether succeeded or failed) as returned from XPS, AutoML BE - assumes the metrics are finalized. AutoML BE transparently posts the - metrics to Chemist if it's not empty, regardless of the response - content or error type. If user is supposed to be charged in case of - cancellation/error, this field should be set. In the case where the - type of LRO doesn't require any billing, this field should be left - unset. - tablesTrainingOperationMetadata: - $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' - videoBatchPredictOperationMetadata: - $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' - visionTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' - videoTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' - XPSDataErrors: + The table/column id, column_name and the DataTypes of the columns + will be populated. + type: object + id: XPSTablesPreprocessResponse + XPSVisionErrorAnalysisConfig: properties: - count: - description: Number of records having errors associated with the enum. - format: int32 - type: integer - errorType: + queryType: + description: >- + The query type used in retrieval. The enum values are frozen in the + foreseeable future. type: string - description: Type of the error. enum: - - ERROR_TYPE_UNSPECIFIED - - UNSUPPORTED_AUDIO_FORMAT - - FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT - - FILE_TOO_LARGE - - MISSING_TRANSCRIPTION + - QUERY_TYPE_UNSPECIFIED + - QUERY_TYPE_ALL_SIMILAR + - QUERY_TYPE_SAME_CLASS_SIMILAR + - QUERY_TYPE_SAME_CLASS_DISSIMILAR enumDescriptions: - - Not specified. - - >- - Audio format not in the formats by cloud-speech AutoML. Currently - only wav and flac file formats are supported. - - >- - File format differnt from what is specified in the file name - extension. - - File too large. Maximum allowed size is 50 MB. - - Transcript is missing. - id: XPSDataErrors + - Unspecified query type for model error analysis. + - Query similar samples across all classes in the dataset. + - Query similar samples from the same class of the input sample. + - Query dissimilar samples from the same class of the input sample. + exampleCount: + format: int32 + type: integer + description: The number of query examples in error analysis. type: object - description: Different types of errors and the stats associatesd with each error. - XPSDataType: + id: XPSVisionErrorAnalysisConfig + description: 'The vision model error analysis configuration. Next tag: 3' + XPSResponseExplanationMetadataInputMetadata: + id: XPSResponseExplanationMetadataInputMetadata + description: Metadata of the input of a feature. type: object - description: >- - Indicated the type of data that can be stored in a structured data - entity (e.g. a table). - id: XPSDataType properties: - timeFormat: + inputTensorName: type: string description: >- - If type_code == TIMESTAMP then `time_format` provides the format in - which that time field is expressed. The time_format must be written - in `strftime` syntax. If time_format is not set, then the default - format as described on the field is used. - compatibleDataTypes: - description: The highly compatible data types to this data type. - items: - $ref: '#/components/schemas/XPSDataType' - type: array - listElementType: - $ref: '#/components/schemas/XPSDataType' - description: >- - If type_code == ARRAY, then `list_element_type` is the type of the - elements. - typeCode: - description: Required. The TypeCode for this type. + Name of the input tensor for this model. Only needed in train + response. + visualizationConfig: + $ref: '#/components/schemas/XPSVisualization' + description: Visualization configurations for image explanation. + modality: enum: - - TYPE_CODE_UNSPECIFIED - - FLOAT64 - - TIMESTAMP - - STRING - - ARRAY - - STRUCT - - CATEGORY + - MODALITY_UNSPECIFIED + - NUMERIC + - IMAGE + - CATEGORICAL enumDescriptions: - - Not specified. Should not be used. - - >- - Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or - `"-Infinity"`. - - >- - Must be between 0AD and 9999AD. Encoded as `string` according to - time_format, or, if that format is not set, then in RFC 3339 - `date-time` format, where `time-offset` = `"Z"` (e.g. - 1985-04-12T23:20:50.52Z). - - Encoded as `string`. - - >- - Encoded as `list`, where the list elements are represented - according to list_element_type. - - >- - Encoded as `struct`, where field values are represented according - to struct_type. - - >- - Values of this type are not further understood by AutoML, e.g. - AutoML is unable to tell the order of values (as it could with - FLOAT64), or is unable to say if one value contains another (as it - could with STRING). Encoded as `string` (bytes should be - base64-encoded, as described in RFC 4648, section 4). + - '' + - '' + - '' + - '' type: string - nullable: - type: boolean - description: If true, this DataType can also be `null`. - structType: - $ref: '#/components/schemas/XPSStructType' description: >- - If type_code == STRUCT, then `struct_type` provides type information - for the struct's fields. - AnnotateTextResponse: - description: The text annotations response message. + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. + ClassificationCategory: + type: object + id: ClassificationCategory properties: - sentences: - description: >- - Sentences in the input document. Populated if the user enables - AnnotateTextRequest.Features.extract_document_sentiment. - items: - $ref: '#/components/schemas/Sentence' - type: array - languageSupported: - description: >- - Whether the language is officially supported by all requested - features. The API may still return a response when the language is - not supported, but it is on a best effort basis. - type: boolean - languageCode: + name: type: string + description: The name of the category representing the document. + severity: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - categories: - description: Categories identified in the input document. - type: array - items: - $ref: '#/components/schemas/ClassificationCategory' - documentSentiment: - $ref: '#/components/schemas/Sentiment' - description: >- - The overall sentiment for the document. Populated if the user - enables AnnotateTextRequest.Features.extract_document_sentiment. - entities: - type: array + Optional. The classifier's severity of the category. This is only + present when the ModerateTextRequest.ModelVersion is set to + MODEL_VERSION_2, and the corresponding category has a severity + score. + type: number + format: float + confidence: description: >- - Entities, along with their semantic information, in the input - document. Populated if the user enables - AnnotateTextRequest.Features.extract_entities or - AnnotateTextRequest.Features.extract_entity_sentiment. - items: - $ref: '#/components/schemas/Entity' - moderationCategories: - items: - $ref: '#/components/schemas/ClassificationCategory' - type: array - description: Harmful and sensitive categories identified in the input document. + The classifier's confidence of the category. Number represents how + certain the classifier is that this category represents the given + text. + format: float + type: number + description: Represents a category returned from the text classifier. + XPSCategoryStats: + id: XPSCategoryStats type: object - id: AnnotateTextResponse - XPSTextTrainResponse: properties: - componentModel: - items: - $ref: '#/components/schemas/XPSTextComponentModel' + topCategoryStats: type: array - description: Component submodels. - type: object - id: XPSTextTrainResponse - XPSImageModelServingSpec: + description: >- + The statistics of the top 20 CATEGORY values, ordered by + CategoryStats.SingleCategoryStats.count. + items: + $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + description: The data statistics of a series of CATEGORY values. + Document: type: object - id: XPSImageModelServingSpec properties: - nodeQps: - type: number - format: double + gcsContentUri: + type: string description: >- - An estimated value of how much traffic a node can serve. Populated - for AutoMl request only. - tfRuntimeVersion: + The Google Cloud Storage URI where the file content is located. This + URI must be of the form: gs://bucket_name/object_name. For more + details, see https://cloud.google.com/storage/docs/reference-uris. + NOTE: Cloud Storage object versioning is not supported. + type: + enum: + - TYPE_UNSPECIFIED + - PLAIN_TEXT + - HTML + type: string description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list + Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns + an `INVALID_ARGUMENT` error. + enumDescriptions: + - The content type is not specified. + - Plain text + - HTML + content: type: string - modelThroughputEstimation: - type: array - items: - $ref: >- - #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation - description: Populate under uCAIP request scope. - description: Serving specification for image models. - XPSTrackMetricsEntryConfidenceMetricsEntry: - id: XPSTrackMetricsEntryConfidenceMetricsEntry - properties: - trackingPrecision: - description: Output only. Tracking precision. - format: float - type: number - trackingRecall: - format: float - description: Output only. Tracking recall. - type: number - confidenceThreshold: - type: number - format: float description: >- - Output only. The confidence threshold value used to compute the - metrics. - mismatchRate: - type: number + The content of the input in string format. Cloud audit logging + exempt since it is based on user data. + languageCode: + type: string + description: >- + Optional. The language of the document (if not specified, the + language is automatically detected). Both ISO and BCP-47 language + codes are accepted. [Language + Support](https://cloud.google.com/natural-language/docs/languages) + lists currently supported languages for each API method. If the + language (either specified by the caller or automatically detected) + is not supported by the called API method, an `INVALID_ARGUMENT` + error is returned. + id: Document + description: Represents the input to API methods. + ModerateTextResponse: + description: The document moderation response message. + id: ModerateTextResponse + properties: + moderationCategories: + description: Harmful and sensitive categories representing the input document. + items: + $ref: '#/components/schemas/ClassificationCategory' + type: array + languageSupported: + type: boolean description: >- - Output only. Mismatch rate, which measures the tracking consistency, - i.e. correctness of instance ID continuity. - format: float - boundingBoxIou: - format: float - type: number + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + languageCode: description: >- - Output only. Bounding box intersection-over-union precision. - Measures how well the bounding boxes overlap between each other - (e.g. complete overlap or just barely above iou_threshold). - description: 'Metrics for a single confidence threshold. Next tag: 6.' - type: object - XPSVideoObjectTrackingTrainResponse: - id: XPSVideoObjectTrackingTrainResponse - type: object - properties: - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - trainCostNodeSeconds: - format: int64 + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. type: string - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - exportModelSpec: - description: Populated for AutoML request only. - $ref: '#/components/schemas/XPSVideoExportModelSpec' + type: object XPSTrackMetricsEntry: id: XPSTrackMetricsEntry + description: >- + Track matching model metrics for a single track match threshold and + multiple label match confidence thresholds. Next tag: 6. properties: - meanBoundingBoxIou: - type: number - description: >- - Output only. The mean bounding box iou over all confidence - thresholds. - format: float - meanMismatchRate: - description: Output only. The mean mismatch rate over all confidence thresholds. - type: number - format: float meanTrackingAveragePrecision: - type: number - format: float description: >- Output only. The mean average precision over all confidence thresholds. - iouThreshold: + format: float type: number + meanMismatchRate: format: float - description: >- - Output only. The intersection-over-union threshold value between - bounding boxes across frames used to compute this metric entry. + description: Output only. The mean mismatch rate over all confidence thresholds. + type: number confidenceMetricsEntries: + items: + $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' description: >- Output only. Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them. - items: - $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' type: array - description: >- - Track matching model metrics for a single track match threshold and - multiple label match confidence thresholds. Next tag: 6. - type: object - XPSResponseExplanationParameters: - properties: - xraiAttribution: - description: >- - An attribution method that redistributes Integrated Gradients - attribution to segmented regions, taking advantage of the model's - fully differentiable structure. Refer to this paper for more - details: https://arxiv.org/abs/1906.02825 XRAI currently performs - better on natural images, like a picture of a house or an animal. If - the images are taken in artificial environments, like a lab or - manufacturing line, or from diagnostic equipment, like x-rays or - quality-control cameras, use Integrated Gradients instead. - $ref: '#/components/schemas/XPSXraiAttribution' - integratedGradientsAttribution: - $ref: '#/components/schemas/XPSIntegratedGradientsAttribution' - description: >- - An attribution method that computes Aumann-Shapley values taking - advantage of the model's fully differentiable structure. Refer to - this paper for more details: https://arxiv.org/abs/1703.01365 - type: object - id: XPSResponseExplanationParameters - deprecated: true - XPSImageObjectDetectionEvaluationMetrics: - properties: - boundingBoxMetricsEntries: - items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' + iouThreshold: + format: float description: >- - The bounding boxes match metrics for each Intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - type: array - boundingBoxMeanAveragePrecision: + Output only. The intersection-over-union threshold value between + bounding boxes across frames used to compute this metric entry. type: number - description: >- - The single metric for bounding boxes evaluation: the - mean_average_precision averaged over all - bounding_box_metrics_entries. + meanBoundingBoxIou: format: float - evaluatedBoundingBoxCount: - type: integer - description: >- - The total number of bounding boxes (i.e. summed over all images) the - ground truth used to create this evaluation had. - format: int32 - id: XPSImageObjectDetectionEvaluationMetrics - description: >- - Model evaluation metrics for image object detection problems. Evaluates - prediction quality of labeled bounding boxes. - type: object - XPSVisionTrainingOperationMetadata: - properties: - explanationUsage: - $ref: '#/components/schemas/InfraUsage' + type: number description: >- - Aggregated infra usage within certain time period, for billing - report purpose if XAI is enable in training request. + Output only. The mean bounding box iou over all confidence + thresholds. type: object - deprecated: true - id: XPSVisionTrainingOperationMetadata - XPSColumnSpec: - id: XPSColumnSpec + XPSColumnSpecCorrelatedColumn: + description: >- + Identifies a table's column, and its correlation with the column this + ColumnSpec describes. + id: XPSColumnSpecCorrelatedColumn properties: - topCorrelatedColumns: - items: - $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' - description: It's outputed in RefreshTablesStats, and a required input in Train. - type: array + correlationStats: + $ref: '#/components/schemas/XPSCorrelationStats' columnId: - format: int32 type: integer - description: >- - The unique id of the column. When Preprocess, the Tables BE will - popuate the order id of the column, which reflects the order of the - column inside the table, i.e. 0 means the first column in the table, - N-1 means the last column. AutoML BE will persist this order id in - Spanner and set the order id here when calling RefreshTablesStats - and Train. Note: it's different than the column_spec_id that is - generated in AutoML BE. - forecastingMetadata: - $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' - dataType: - $ref: '#/components/schemas/XPSDataType' - description: >- - The data type of the column. It's outputed in Preprocess rpc and a - required input for RefreshTablesStats and Train. - dataStats: - $ref: '#/components/schemas/XPSDataStats' - description: >- - The data stats of the column. It's outputed in RefreshTablesStats - and a required input for Train. - displayName: - description: >- - The display name of the column. It's outputed in Preprocess and a - required input for RefreshTablesStats and Train. - type: string - type: object - XPSTextToSpeechTrainResponse: - id: XPSTextToSpeechTrainResponse - type: object - properties: {} - description: TextToSpeech train response - XPSTimestampStats: - properties: - medianTimestampNanos: - format: int64 - type: string - granularStats: - additionalProperties: - $ref: '#/components/schemas/XPSTimestampStatsGranularStats' - description: >- - The string key is the pre-defined granularity. Currently supported: - hour_of_day, day_of_week, month_of_year. Granularities finer that - the granularity of timestamp data are not populated (e.g. if - timestamps are at day granularity, then hour_of_day is not - populated). - type: object - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - description: The data statistics of a series of TIMESTAMP values. - id: XPSTimestampStats + format: int32 type: object - AnnotateTextRequest: - properties: - encodingType: - enumDescriptions: - - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - description: The encoding type used by the API to calculate offsets. - type: string - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - features: - description: Required. The enabled features. - $ref: '#/components/schemas/AnnotateTextRequestFeatures' - description: >- - The request message for the text annotation API, which can perform - multiple analysis types in one call. + InfraUsage: type: object - id: AnnotateTextRequest - ClassifyTextResponse: - id: ClassifyTextResponse - description: The document classification response message. + id: InfraUsage + description: 'Infra Usage of billing metrics. Next ID: 6' properties: - categories: - description: Categories representing the input document. + ramMetrics: + description: Aggregated ram metrics since requested start_time. + type: array + items: + $ref: '#/components/schemas/RamMetric' + diskMetrics: + description: Aggregated persistent disk metrics since requested start_time. + type: array + items: + $ref: '#/components/schemas/DiskMetric' + cpuMetrics: + description: Aggregated core metrics since requested start_time. + type: array items: - $ref: '#/components/schemas/ClassificationCategory' + $ref: '#/components/schemas/CpuMetric' + gpuMetrics: + items: + $ref: '#/components/schemas/GpuMetric' + description: Aggregated gpu metrics since requested start_time. type: array - languageCode: - type: string + tpuMetrics: + type: array + items: + $ref: '#/components/schemas/TpuMetric' + description: Aggregated tpu metrics since requested start_time. + XPSTimestampStats: + properties: + granularStats: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - languageSupported: + The string key is the pre-defined granularity. Currently supported: + hour_of_day, day_of_week, month_of_year. Granularities finer that + the granularity of timestamp data are not populated (e.g. if + timestamps are at day granularity, then hour_of_day is not + populated). + additionalProperties: + $ref: '#/components/schemas/XPSTimestampStatsGranularStats' + type: object + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + medianTimestampNanos: + type: string + format: int64 + id: XPSTimestampStats + type: object + description: The data statistics of a series of TIMESTAMP values. + XPSArrayStats: + properties: + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + memberStats: + $ref: '#/components/schemas/XPSDataStats' description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - type: boolean + Stats of all the values of all arrays, as if they were a single long + series of data. The type depends on the element type of the array. type: object - XPSFileSpec: - id: XPSFileSpec + id: XPSArrayStats + description: The data statistics of a series of ARRAY values. + TpuMetric: + id: TpuMetric type: object properties: - fileSpec: - description: >- - Single file path, or file pattern of format - "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is - expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and - /cns/cell-d/somewhere/file-00001-of-00002. + tpuSec: + format: int64 type: string - directoryPath: - description: Deprecated. Use file_spec. + description: Required. Seconds of TPU usage, e.g. 3600. + tpuType: type: string - deprecated: true - fileFormat: - enum: - - FILE_FORMAT_UNKNOWN - - FILE_FORMAT_SSTABLE - - FILE_FORMAT_TRANSLATION_RKV - - FILE_FORMAT_RECORDIO - - FILE_FORMAT_RAW_CSV - - FILE_FORMAT_RAW_CAPACITOR enumDescriptions: - '' - '' - - >- - Internal format for parallel text data used by Google Translate. - go/rkvtools - '' - - >- - Only the lexicographically first file described by the file_spec - contains the header line. - '' - type: string - enumDeprecated: - - false - - true - - false - - false - - false - - false - singleFilePath: - description: Deprecated. Use file_spec. - type: string - deprecated: true - description: >- - Spec of input and output files, on external file systems (CNS, GCS, - etc). - XPSTrainingObjectivePoint: - id: XPSTrainingObjectivePoint - properties: - value: - description: The objective value when this point was recorded. - format: float - type: number - createTime: - description: The time at which this point was recorded. - format: google-datetime - type: string - type: object - XPSExampleSet: + - '' + - '' + enum: + - UNKNOWN_TPU_TYPE + - TPU_V2_POD + - TPU_V2 + - TPU_V3_POD + - TPU_V3 + - TPU_V5_LITEPOD + description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. + XPSVideoModelArtifactSpec: + id: XPSVideoModelArtifactSpec type: object - description: Set of examples or input sources. - id: XPSExampleSet properties: - numExamples: - description: Number of examples. - type: string - format: int64 - numInputSources: - format: int64 - description: Number of input sources. - type: string - fileSpec: - description: File spec of the examples or input sources. - $ref: '#/components/schemas/XPSFileSpec' - fingerprint: + servingArtifact: + $ref: '#/components/schemas/XPSModelArtifactItem' + description: >- + The default model binary file used for serving (e.g. batch predict) + via public Cloud AI Platform API. + exportArtifact: + items: + $ref: '#/components/schemas/XPSModelArtifactItem' + type: array + description: The model binary files in different formats for model export. + XPSTrainResponse: + properties: + videoClassificationTrainResp: + $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' + deployedModelSizeBytes: + description: Estimated model size in bytes once deployed. type: string - description: Fingerprint of the example set. format: int64 - XPSImageSegmentationEvaluationMetrics: - description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' - id: XPSImageSegmentationEvaluationMetrics - properties: - confidenceMetricsEntries: + explanationConfigs: + deprecated: true + description: >- + VisionExplanationConfig for XAI on test set. Optional for when XAI + is enable in training request. items: - $ref: >- - #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + $ref: '#/components/schemas/XPSResponseExplanationSpec' type: array + evaluatedExampleSet: + $ref: '#/components/schemas/XPSExampleSet' description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. + Examples used to evaluate the model (usually the test set), with the + predicted annotations. The file_spec should point to recordio + file(s) of AnnotatedExample. For each returned example, the + example_id_token and annotations predicted by the model must be set. + The example payload can and is recommended to be omitted. + textToSpeechTrainResp: + $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' + videoObjectTrackingTrainResp: + $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' + evaluationMetricsSet: + $ref: '#/components/schemas/XPSEvaluationMetricsSet' + description: >- + The trained model evaluation metrics. This can be optionally + returned. + textTrainResp: + $ref: '#/components/schemas/XPSTextTrainResponse' + description: Will only be needed for uCAIP from Beta. + translationTrainResp: + $ref: '#/components/schemas/XPSTranslationTrainResponse' + errorAnalysisConfigs: + type: array + description: >- + Optional vision model error analysis configuration. The field is set + when model error analysis is enabled in the training request. The + results of error analysis will be binded together with evaluation + results (in the format of AnnotatedExample). + items: + $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' + imageClassificationTrainResp: + $ref: '#/components/schemas/XPSImageClassificationTrainResponse' + videoActionRecognitionTrainResp: + $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' + imageObjectDetectionTrainResp: + $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' + imageSegmentationTrainResp: + $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' + tablesTrainResp: + $ref: '#/components/schemas/XPSTablesTrainResponse' + modelToken: + description: >- + Token that represents the trained model. This is considered + immutable and is persisted in AutoML. xPS can put their own proto in + the byte string, to e.g. point to the model checkpoints. The token + is passed to other xPS APIs to refer to the model. + type: string + format: byte + speechTrainResp: + $ref: '#/components/schemas/XPSSpeechModelSpec' type: object - ClassifyTextRequest: + id: XPSTrainResponse + description: 'Next ID: 18' + AnalyzeSentimentResponse: + description: The sentiment analysis response message. type: object + id: AnalyzeSentimentResponse properties: - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - description: The document classification request message. - id: ClassifyTextRequest - AnalyzeEntitiesRequest: + languageCode: + type: string + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + languageSupported: + type: boolean + description: >- + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + sentences: + items: + $ref: '#/components/schemas/Sentence' + type: array + description: The sentiment for all the sentences in the document. + documentSentiment: + $ref: '#/components/schemas/Sentiment' + description: The overall sentiment of the input document. + XPSTextSentimentEvaluationMetrics: type: object - id: AnalyzeEntitiesRequest - description: The entity analysis request message. - properties: - encodingType: - description: The encoding type used by the API to calculate offsets. - type: string - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - enumDescriptions: - - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - XPSVideoActionMetricsEntryConfidenceMetricsEntry: - id: XPSVideoActionMetricsEntryConfidenceMetricsEntry properties: - recall: - description: Output only. Recall for the given confidence threshold. - type: number + meanSquaredError: + description: >- + Output only. Mean squared error. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. format: float + type: number precision: - description: Output only. Precision for the given confidence threshold. + format: float + description: Output only. Precision. + type: number + recall: format: float type: number + description: Output only. Recall. f1Score: + type: number format: float description: Output only. The harmonic mean of recall and precision. + linearKappa: + description: >- + Output only. Linear weighted kappa. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. type: number - confidenceThreshold: + format: float + quadraticKappa: + description: >- + Output only. Quadratic weighted kappa. Only set for the overall + model evaluation, not for evaluation of a single annotation spec. format: float type: number + confusionMatrix: description: >- - Output only. The confidence threshold value used to compute the - metrics. - type: object - description: Metrics for a single confidence threshold. - XPSColumnSpecForecastingMetadata: - id: XPSColumnSpecForecastingMetadata + Output only. Confusion matrix of the evaluation. Only set for the + overall model evaluation, not for evaluation of a single annotation + spec. + $ref: '#/components/schemas/XPSConfusionMatrix' + meanAbsoluteError: + type: number + description: >- + Output only. Mean absolute error. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. + format: float + id: XPSTextSentimentEvaluationMetrics + description: Model evaluation metrics for text sentiment problems. + XPSEdgeTpuTfLiteFormat: + properties: {} description: >- - =========================================================================== - # The fields below are used exclusively for Forecasting. + A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) + devices. type: object - properties: - columnType: - type: string - enumDescriptions: - - An un-set value of this enum. - - Key columns are used to identify timeseries. - - >- - This column contains information describing static properties of - the entities identified by the key column(s) (e.g. city's ZIP - code). - - >- - This column contains information for the given entity, at any time - poinrt, they are only available in the time series before. - - >- - This column contains information for the given entity is known - both for the past and the sufficiently far future. - description: The type of the column for FORECASTING model training purposes. - enum: - - COLUMN_TYPE_UNSPECIFIED - - KEY - - KEY_METADATA - - TIME_SERIES_AVAILABLE_PAST_ONLY - - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE - XPSDataStats: + id: XPSEdgeTpuTfLiteFormat + XPSColorMap: type: object + description: >- + Map from color to display name. Will only be used by Image Segmentation + for uCAIP. + id: XPSColorMap properties: - categoryStats: - description: The statistics for CATEGORY DataType. - $ref: '#/components/schemas/XPSCategoryStats' - validValueCount: - description: The number of values that are valid. - type: string - format: int64 - nullValueCount: - description: The number of values that are null. + annotationSpecIdToken: type: string - format: int64 - distinctValueCount: - description: The number of distinct values. - format: int64 + description: Should be used during training. + intColor: + $ref: '#/components/schemas/XPSColorMapIntColor' + color: + description: >- + This type is deprecated in favor of the IntColor below. This is + because google.type.Color represent color has a float which + semantically does not reflect discrete classes/categories concept. + Moreover, to handle it well we need to have some tolerance when + converting to a discretized color. As such, the recommendation is to + have API surface still use google.type.Color while internally + IntColor is used. + $ref: '#/components/schemas/Color' + deprecated: true + displayName: type: string - stringStats: - description: The statistics for STRING DataType. - $ref: '#/components/schemas/XPSStringStats' - arrayStats: - description: The statistics for ARRAY DataType. - $ref: '#/components/schemas/XPSArrayStats' - float64Stats: - $ref: '#/components/schemas/XPSFloat64Stats' - description: The statistics for FLOAT64 DataType. - timestampStats: - $ref: '#/components/schemas/XPSTimestampStats' - description: The statistics for TIMESTAMP DataType. - structStats: - $ref: '#/components/schemas/XPSStructStats' - description: The statistics for STRUCT DataType. - id: XPSDataStats - description: The data statistics of a series of values that share the same DataType. - XPSImageSegmentationTrainResponse: + description: Should be used during preprocessing. + XPSVideoTrainingOperationMetadata: + id: XPSVideoTrainingOperationMetadata type: object properties: - stopReason: - enumDescriptions: - - '' - - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - type: string - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED - exportModelSpec: - description: 'NOTE: These fields are not used/needed in EAP but will be set later.' - $ref: '#/components/schemas/XPSImageExportModelSpec' - trainCostNodeSeconds: + trainCostMilliNodeHour: description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. + This is an estimation of the node hours necessary for training a + model, expressed in milli node hours (i.e. 1,000 value in this field + means 1 node hour). A node hour represents the time a virtual + machine spends running your training job. The cost of one node + running for one hour is a node hour. format: int64 type: string - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - colorMaps: - items: - $ref: '#/components/schemas/XPSColorMap' - description: Color map of the model. + XPSImageModelServingSpec: + type: object + description: Serving specification for image models. + id: XPSImageModelServingSpec + properties: + modelThroughputEstimation: type: array - modelArtifactSpec: + items: + $ref: >- + #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation + description: Populate under uCAIP request scope. + nodeQps: + type: number + format: double + description: >- + An estimated value of how much traffic a node can serve. Populated + for AutoMl request only. + tfRuntimeVersion: description: >- ## The fields below are only populated under uCAIP request scope. - Model artifact spec stores and model gcs pathes and related metadata - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - id: XPSImageSegmentationTrainResponse - XPSCorrelationStats: + https://cloud.google.com/ml-engine/docs/runtime-version-list + type: string + XPSColorMapIntColor: properties: - cramersV: - description: The correlation value using the Cramer's V measure. - format: double - type: number - id: XPSCorrelationStats + red: + format: int32 + description: The value should be in range of [0, 255]. + type: integer + blue: + description: The value should be in range of [0, 255]. + type: integer + format: int32 + green: + type: integer + description: The value should be in range of [0, 255]. + format: int32 + id: XPSColorMapIntColor type: object + description: RGB color and each channel is represented by an integer. + XPSCorrelationStats: description: >- A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same. - ModerateTextResponse: properties: - languageCode: - type: string - description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. + cramersV: + description: The correlation value using the Cramer's V measure. + type: number + format: double + type: object + id: XPSCorrelationStats + ClassifyTextResponse: + type: object + properties: languageSupported: - type: boolean description: >- Whether the language is officially supported. The API may still return a response when the language is not supported, but it is on a best effort basis. - moderationCategories: + type: boolean + categories: items: $ref: '#/components/schemas/ClassificationCategory' type: array - description: Harmful and sensitive categories representing the input document. - id: ModerateTextResponse - description: The document moderation response message. + description: Categories representing the input document. + languageCode: + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + type: string + description: The document classification response message. + id: ClassifyTextResponse + XPSConfidenceMetricsEntry: + id: XPSConfidenceMetricsEntry + description: >- + ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. + Next tag: 16. type: object + properties: + precisionAt1: + description: >- + The precision when only considering the label that has the highest + prediction score and not below the confidence threshold for each + example. + format: float + type: number + confidenceThreshold: + format: float + type: number + description: >- + Metrics are computed with an assumption that the model never return + predictions with score lower than this value. + falsePositiveCount: + description: >- + The number of model created labels that do not match a ground truth + label. + type: string + format: int64 + recall: + description: Recall (true positive rate) for the given confidence threshold. + format: float + type: number + falsePositiveRate: + type: number + description: False Positive Rate for the given confidence threshold. + format: float + falsePositiveRateAt1: + type: number + format: float + description: >- + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each example. + recallAt1: + type: number + format: float + description: >- + The recall (true positive rate) when only considering the label that + has the highest prediction score and not below the confidence + threshold for each example. + truePositiveCount: + description: The number of model created labels that match a ground truth label. + format: int64 + type: string + f1ScoreAt1: + format: float + description: The harmonic mean of recall_at1 and precision_at1. + type: number + precision: + format: float + description: Precision for the given confidence threshold. + type: number + positionThreshold: + format: int32 + type: integer + description: >- + Metrics are computed with an assumption that the model always + returns at most this many predictions (ordered by their score, + descendingly), but they all still need to meet the + confidence_threshold. + falseNegativeCount: + type: string + format: int64 + description: >- + The number of ground truth labels that are not matched by a model + created label. + trueNegativeCount: + description: >- + The number of labels that were not created by the model, but if they + would, they would not match a ground truth label. + type: string + format: int64 + f1Score: + type: number + description: The harmonic mean of recall and precision. + format: float XPSVideoClassificationTrainResponse: - id: XPSVideoClassificationTrainResponse properties: trainCostNodeSeconds: format: int64 + type: string description: >- The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. - type: string modelArtifactSpec: - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + id: XPSVideoClassificationTrainResponse type: object - XPSCoreMlFormat: - properties: {} - id: XPSCoreMlFormat + XPSTextTrainResponse: + id: XPSTextTrainResponse + properties: + componentModel: + items: + $ref: '#/components/schemas/XPSTextComponentModel' + type: array + description: Component submodels. type: object - description: A model format used for iOS mobile devices. - XPSSpeechModelSpec: + XPSTextExtractionEvaluationMetrics: + type: object + id: XPSTextExtractionEvaluationMetrics properties: - datasetId: - type: string - format: int64 + bestF1ConfidenceMetrics: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + deprecated: true description: >- - Required for speech xps backend. Speech xps has to use dataset_id - and model_id as the primary key in db so that speech API can query - the db directly. - language: - type: string - subModelSpecs: - description: Model specs for all submodels contained in this model. + Values are at the highest F1 score on the precision-recall curve. + Only confidence_threshold, recall, precision, and f1_score will be + set. + perLabelConfidenceMetrics: + description: Only recall, precision, and f1_score will be set. + deprecated: true + type: object + additionalProperties: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + confusionMatrix: + $ref: '#/components/schemas/XPSConfusionMatrix' + description: >- + Confusion matrix of the model, at the default confidence threshold + (0.0). Only set for whole-model evaluation, not for evaluation per + label. + confidenceMetricsEntries: type: array items: - $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + description: >- + If the enclosing EvaluationMetrics.label is empty, + confidence_metrics_entries is an evaluation of the entire model + across all labels. If the enclosing EvaluationMetrics.label is set, + confidence_metrics_entries applies to that label. + XPSBatchPredictResponse: type: object - id: XPSSpeechModelSpec - EntityMention: - description: >- - Represents a mention for an entity in the text. Currently, proper noun - mentions are supported. properties: - type: - enumDescriptions: - - Unknown - - Proper name - - Common noun (or noun compound) - enum: - - TYPE_UNKNOWN - - PROPER - - COMMON - type: string - description: The type of the entity mention. - text: - $ref: '#/components/schemas/TextSpan' - description: The mention text. - probability: - type: number - format: float - description: >- - Probability score associated with the entity. The score shows the - probability of the entity mention being the entity type. The score - is in (0, 1] range. - sentiment: - $ref: '#/components/schemas/Sentiment' + exampleSet: description: >- - For calls to AnalyzeEntitySentiment or if - AnnotateTextRequest.Features.extract_entity_sentiment is set to - true, this field will contain the sentiment expressed for this - mention of the entity in the provided document. - id: EntityMention - type: object - XPSImageExportModelSpec: - type: object + Examples for batch prediction result. Under full API implementation, + results are stored in shared RecordIO of AnnotatedExample protobufs, + the annotations field of which is populated by XPS backend. + $ref: '#/components/schemas/XPSExampleSet' + id: XPSBatchPredictResponse + XPSVideoActionRecognitionEvaluationMetrics: properties: - exportModelOutputConfig: - items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' + videoActionMetricsEntries: description: >- - Contains the model format and internal location of the model files - to be exported/downloaded. Use the GCS bucket name which is provided - via TrainRequest.gcs_bucket_name to store the model files. + Output only. The metric entries for precision window lengths: + 1s,2s,3s,4s, 5s. type: array - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Upon receiving - ExportModel request from user, AutoMl backend can serve the - pre-generated models to user if exists (by copying the files from - internal path to user provided location), otherwise, AutoMl backend will - call xPS ExportModel API to generate the model on the fly with the - requesting format. - id: XPSImageExportModelSpec - XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: - description: Metrics for a single confidence threshold. - properties: - confidenceThreshold: - format: float - type: number - description: The confidence threshold value used to compute the metrics. - diceScoreCoefficient: - description: 'DSC or the F1 score: The harmonic mean of recall and precision.' - type: number - format: float - recall: - description: Recall for the given confidence threshold. - format: float - type: number - iouScore: - type: number - format: float - description: IOU score. - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' + items: + $ref: '#/components/schemas/XPSVideoActionMetricsEntry' + evaluatedActionCount: description: >- - Confusion matrix of the per confidence_threshold evaluation. Pixel - counts are set here. Only set for model level evaluation, not for - evaluation per label. - precision: - type: number - description: Precision for the given confidence threshold. - format: float + Output only. The number of ground truth actions used to create this + evaluation. + type: integer + format: int32 + description: Model evaluation metrics for video action recognition. type: object - id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + id: XPSVideoActionRecognitionEvaluationMetrics XPSCategoryStatsSingleCategoryStats: description: The statistics of a single CATEGORY value. id: XPSCategoryStatsSingleCategoryStats properties: - count: - format: int64 - type: string - description: The number of occurrences of this value in the series. value: description: The CATEGORY value. type: string + count: + description: The number of occurrences of this value in the series. + type: string + format: int64 type: object RamMetric: properties: - gibSec: - description: >- - Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type - to match billing metrics definition. - type: string - format: int64 machineSpec: - enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_2G - - A3_HIGHGPU_4G - - A3_HIGHGPU_8G - - A3_MEGAGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 - description: Required. Machine spec, e.g. N1_STANDARD_4. - type: string enumDescriptions: - '' - '' @@ -4552,281 +4028,814 @@ components: - '' - '' - '' - trackingLabels: + description: Required. Machine spec, e.g. N1_STANDARD_4. + enum: + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 + type: string + trackingLabels: + additionalProperties: + type: string + description: >- + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" + type: object + ramType: + enum: + - UNKNOWN_RAM_TYPE + - A2 + - A3 + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D + type: string + enumDescriptions: + - '' + - '' + - '' + - COMPUTE_OPTIMIZED + - '' + - '' + - '' + - '' + - '' + - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + - MEMORY_OPTIMIZED + - '' + - '' + - '' + - '' + description: Required. Type of ram. + memories: + format: double + description: Required. VM memory in gb. + type: number + gibSec: + description: >- + Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type + to match billing metrics definition. + format: int64 + type: string + type: object + id: RamMetric + Sentiment: + id: Sentiment + description: >- + Represents the feeling associated with the entire text or entities in + the text. + type: object + properties: + score: + type: number + format: float + description: >- + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). + magnitude: + description: >- + A non-negative number in the [0, +inf) range, which represents the + absolute magnitude of sentiment regardless of score (positive or + negative). + format: float + type: number + XPSExportModelOutputConfig: + type: object + properties: + coreMlFormat: + $ref: '#/components/schemas/XPSCoreMlFormat' + tfSavedModelFormat: + $ref: '#/components/schemas/XPSTfSavedModelFormat' + outputGcrUri: + type: string + description: >- + The Google Contained Registry (GCR) path the exported files to be + pushed to. This location is set if the exported format is DOCKDER. + outputGcsUri: + description: >- + The Google Cloud Storage (GCS) directory where XPS will output the + exported models and related files. Format: gs://bucket/directory + type: string + tfJsFormat: + $ref: '#/components/schemas/XPSTfJsFormat' + tfLiteFormat: + $ref: '#/components/schemas/XPSTfLiteFormat' + exportFirebaseAuxiliaryInfo: + type: boolean + description: >- + For any model and format: If true, will additionally export + FirebaseExportedModelInfo in a firebase.txt file. + edgeTpuTfLiteFormat: + $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' + dockerFormat: + $ref: '#/components/schemas/XPSDockerFormat' + id: XPSExportModelOutputConfig + XPSConfusionMatrixRow: + id: XPSConfusionMatrixRow + type: object + properties: + count: + items: + format: int64 + type: string + description: >- + Same as above except intended to represent other counts (for e.g. + for segmentation this is pixel count). NOTE(params): Only + example_count or count is set (oneoff does not support repeated + fields unless they are embedded inside another message). + type: array + exampleCount: + type: array + description: >- + Value of the specific cell in the confusion matrix. The number of + values each row has (i.e. the length of the row) is equal to the + length of the annotation_spec_id_token field. + items: + type: integer + format: int32 + description: A row in the confusion matrix. + XPSCommonStats: + properties: + validValueCount: + type: string + format: int64 + distinctValueCount: + format: int64 + type: string + nullValueCount: + format: int64 + type: string + description: Common statistics for a column with a specified data type. + id: XPSCommonStats + type: object + XPSTrackMetricsEntryConfidenceMetricsEntry: + id: XPSTrackMetricsEntryConfidenceMetricsEntry + properties: + trackingRecall: + description: Output only. Tracking recall. + type: number + format: float + trackingPrecision: + format: float + description: Output only. Tracking precision. + type: number + boundingBoxIou: + description: >- + Output only. Bounding box intersection-over-union precision. + Measures how well the bounding boxes overlap between each other + (e.g. complete overlap or just barely above iou_threshold). + type: number + format: float + mismatchRate: + type: number description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" + Output only. Mismatch rate, which measures the tracking consistency, + i.e. correctness of instance ID continuity. + format: float + confidenceThreshold: + type: number + description: >- + Output only. The confidence threshold value used to compute the + metrics. + format: float + type: object + description: 'Metrics for a single confidence threshold. Next tag: 6.' + XPSTextToSpeechTrainResponse: + description: TextToSpeech train response + type: object + properties: {} + id: XPSTextToSpeechTrainResponse + XPSVisionTrainingOperationMetadata: + deprecated: true + id: XPSVisionTrainingOperationMetadata + properties: + explanationUsage: + description: >- + Aggregated infra usage within certain time period, for billing + report purpose if XAI is enable in training request. + $ref: '#/components/schemas/InfraUsage' + type: object + XPSTranslationEvaluationMetrics: + description: Evaluation metrics for the dataset. + properties: + baseBleuScore: + format: double + type: number + description: BLEU score for base model. + bleuScore: + format: double + description: BLEU score. + type: number + type: object + id: XPSTranslationEvaluationMetrics + XPSVideoExportModelSpec: + type: object + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Upon receiving + ExportModel request from user, AutoMl backend can serve the + pre-generated models to user if exists (by copying the files from + internal path to user provided location), otherwise, AutoMl backend will + call xPS ExportModel API to generate the model on the fly with the + requesting format. + properties: + exportModelOutputConfig: + items: + $ref: '#/components/schemas/XPSExportModelOutputConfig' + type: array + description: >- + Contains the model format and internal location of the model files + to be exported/downloaded. Use the GCS bucket name which is provided + via TrainRequest.gcs_bucket_name to store the model files. + id: XPSVideoExportModelSpec + XPSClassificationEvaluationMetrics: + type: object + id: XPSClassificationEvaluationMetrics + description: >- + Model evaluation metrics for classification problems. It can be used for + image and video classification. Next tag: 9. + properties: + logLoss: + format: float + type: number + description: The Log Loss metric. + auRoc: + description: >- + The Area Under Receiver Operating Characteristic curve metric. + Micro-averaged for the overall evaluation. + format: float + type: number + confusionMatrix: + $ref: '#/components/schemas/XPSConfusionMatrix' + description: >- + Confusion matrix of the evaluation. Only set for MULTICLASS + classification problems where number of annotation specs is no more + than 10. Only set for model level evaluation, not for evaluation per + label. + auPrc: + type: number + format: float + description: The Area under precision recall curve metric. + confidenceMetricsEntries: + items: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + type: array + description: >- + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. + baseAuPrc: + format: float + description: The Area under precision recall curve metric based on priors. + type: number + evaluatedExamplesCount: + format: int32 + description: The number of examples used for model evaluation. + type: integer + XPSTranslationTrainResponse: + type: object + properties: + modelType: + description: Type of the model. + enum: + - MODEL_TYPE_UNSPECIFIED + - LEGACY + - CURRENT + enumDescriptions: + - Default + - Legacy model. Will be deprecated. + - Current model. + type: string + description: Train response for translation. + id: XPSTranslationTrainResponse + XPSTablesEvaluationMetrics: + properties: + classificationMetrics: + $ref: '#/components/schemas/XPSTablesClassificationMetrics' + description: Classification metrics. + regressionMetrics: + $ref: '#/components/schemas/XPSTablesRegressionMetrics' + description: Regression metrics. + id: XPSTablesEvaluationMetrics + type: object + Entity: + properties: + sentiment: + $ref: '#/components/schemas/Sentiment' + description: >- + For calls to AnalyzeEntitySentiment or if + AnnotateTextRequest.Features.extract_entity_sentiment is set to + true, this field will contain the aggregate sentiment expressed for + this entity in the provided document. + name: + description: The representative name for the entity. + type: string + mentions: + description: >- + The mentions of this entity in the input document. The API currently + supports proper noun mentions. + type: array + items: + $ref: '#/components/schemas/EntityMention' + metadata: + type: object + description: >- + Metadata associated with the entity. For the metadata associated + with other entity types, see the Type table below. additionalProperties: type: string - type: object - ramType: - description: Required. Type of ram. - enumDescriptions: - - '' - - '' - - '' - - COMPUTE_OPTIMIZED - - '' - - '' - - '' - - '' - - '' - - MEMORY_OPTIMIZED_UPGRADE_PREMIUM - - MEMORY_OPTIMIZED - - '' - - '' - - '' - - '' - enum: - - UNKNOWN_RAM_TYPE - - A2 - - A3 - - C2 - - C2D - - CUSTOM - - E2 - - G2 - - C3 - - M2 - - M1 - - N1 - - N2_CUSTOM - - N2 - - N2D + type: type: string - memories: - format: double - type: number - description: Required. VM memory in gb. + enum: + - UNKNOWN + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + description: The entity type. + enumDescriptions: + - Unknown + - Person + - Location + - Organization + - Event + - Artwork + - Consumer product + - Other types of entities + - >- + Phone number The metadata lists the phone number, formatted + according to local convention, plus whichever additional elements + appear in the text: * `number` - the actual number, broken down + into sections as per local convention * `national_prefix` - + country code, if detected * `area_code` - region or area code, if + detected * `extension` - phone extension (to be dialed after + connection), if detected + - >- + Address The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - street number * `locality` - city or town * + `street_name` - street/route name, if detected * `postal_code` - + postal code, if detected * `country` - country, if detected * + `broad_region` - administrative area, such as the state, if + detected * `narrow_region` - smaller administrative area, such as + county, if detected * `sublocality` - used in Asian addresses to + demark a district within a city, if detected + - >- + Date The metadata identifies the components of the date: * `year` + - four digit year, if detected * `month` - two digit month number, + if detected * `day` - two digit day number, if detected + - Number The metadata is the number itself. + - Price The metadata identifies the `value` and `currency`. + id: Entity type: object - id: RamMetric - XPSVideoObjectTrackingEvaluationMetrics: + description: >- + Represents a phrase in the text that is a known entity, such as a + person, an organization, or location. The API associates information, + such as probability and mentions, with entities. + XPSStructType: + id: XPSStructType type: object + description: '`StructType` defines the DataType-s of a STRUCT type.' properties: - trackMeanBoundingBoxIou: + fields: + additionalProperties: + $ref: '#/components/schemas/XPSDataType' + type: object + description: Unordered map of struct field names to their data types. + XPSColumnSpec: + properties: + displayName: description: >- - Output only. The single metric for tracks bounding box iou - evaluation: the mean_bounding_box_iou averaged over all - track_metrics_entries. - type: number - format: float - evaluatedFrameCount: - description: The number of video frames used for model evaluation. + The display name of the column. It's outputed in Preprocess and a + required input for RefreshTablesStats and Train. + type: string + columnId: format: int32 - type: integer - trackMeanAveragePrecision: - format: float - type: number description: >- - Output only. The single metric for tracks accuracy evaluation: the - mean_average_precision averaged over all track_metrics_entries. - trackMetricsEntries: - items: - $ref: '#/components/schemas/XPSTrackMetricsEntry' - type: array - description: >- - Output only. The tracks match metrics for each - Intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - evaluatedBoundingboxCount: - description: The number of bounding boxes used for model evaluation. - format: int32 + The unique id of the column. When Preprocess, the Tables BE will + popuate the order id of the column, which reflects the order of the + column inside the table, i.e. 0 means the first column in the table, + N-1 means the last column. AutoML BE will persist this order id in + Spanner and set the order id here when calling RefreshTablesStats + and Train. Note: it's different than the column_spec_id that is + generated in AutoML BE. type: integer - boundingBoxMetricsEntries: - description: >- - Output only. The bounding boxes match metrics for each - Intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - type: array + topCorrelatedColumns: items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' - trackMeanMismatchRate: - type: number + $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' + description: It's outputed in RefreshTablesStats, and a required input in Train. + type: array + dataStats: + $ref: '#/components/schemas/XPSDataStats' description: >- - Output only. The single metric for tracking consistency evaluation: - the mean_mismatch_rate averaged over all track_metrics_entries. - format: float - boundingBoxMeanAveragePrecision: - format: float - type: number + The data stats of the column. It's outputed in RefreshTablesStats + and a required input for Train. + forecastingMetadata: + $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' + dataType: + $ref: '#/components/schemas/XPSDataType' description: >- - Output only. The single metric for bounding boxes evaluation: the - mean_average_precision averaged over all - bounding_box_metrics_entries. - evaluatedTrackCount: - format: int32 - type: integer - description: The number of tracks used for model evaluation. - description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' - id: XPSVideoObjectTrackingEvaluationMetrics - XPSRegressionMetricsEntry: - id: XPSRegressionMetricsEntry - properties: - trueValue: - description: The actual target value for a row in the dataset. - type: number - format: float - predictedValue: - type: number - description: The observed value for a row in the dataset. - format: float + The data type of the column. It's outputed in Preprocess rpc and a + required input for RefreshTablesStats and Train. type: object - description: A pair of actual & observed values for the model being evaluated. - XPSTimestampStatsGranularStats: - properties: - buckets: - additionalProperties: - format: int64 - type: string - description: >- - A map from granularity key to example count for that key. E.g. for - hour_of_day `13` means 1pm, or for month_of_year `5` means May). - type: object - id: XPSTimestampStatsGranularStats + id: XPSColumnSpec + AnnotateTextRequest: type: object - description: Stats split by a defined in context granularity. - XPSResponseExplanationMetadata: - id: XPSResponseExplanationMetadata properties: - outputs: - type: object - description: Metadata of the output. - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' - inputs: - type: object - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' - description: Metadata of the input. - deprecated: true - type: object - XPSTablesDatasetMetadata: + encodingType: + enumDescriptions: + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + type: string + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 + description: The encoding type used by the API to calculate offsets. + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + features: + $ref: '#/components/schemas/AnnotateTextRequestFeatures' + description: Required. The enabled features. + id: AnnotateTextRequest + description: >- + The request message for the text annotation API, which can perform + multiple analysis types in one call. + XPSTablesTrainingOperationMetadata: + id: XPSTablesTrainingOperationMetadata type: object - id: XPSTablesDatasetMetadata - description: 'Metadata for a dataset used for AutoML Tables. Next ID: 6' properties: - primaryTableSpec: - description: Primary table. - $ref: '#/components/schemas/XPSTableSpec' - mlUseColumnId: - type: integer - format: int32 - description: Id the column to split the table. - targetColumnCorrelations: - type: object - description: '(the column id : its CorrelationStats with target column).' - additionalProperties: - $ref: '#/components/schemas/XPSCorrelationStats' - weightColumnId: + trainBudgetMilliNodeHours: + type: string + description: Creating model budget. + format: int64 + optimizationObjective: + type: string + description: The optimization objective for model. + createModelStage: + description: Current stage of creating model. + enumDescriptions: + - Unspecified stage. + - Prepare the model training pipeline and run data processing. + - Training model. + - Run evaluation. + - Finalizing model training pipeline. + enum: + - CREATE_MODEL_STAGE_UNSPECIFIED + - DATA_PREPROCESSING + - TRAINING + - EVALUATING + - MODEL_POST_PROCESSING + type: string + trainingObjectivePoints: + items: + $ref: '#/components/schemas/XPSTrainingObjectivePoint' + type: array description: >- - Id of the primary table column that should be used as the weight - column. - type: integer - format: int32 - targetColumnId: + This field records the training objective value with respect to + time, giving insight into how the model architecture search is + performing as training time elapses. + trainingStartTime: + format: google-datetime + description: Timestamp when training process starts. + type: string + topTrials: description: >- - Id of the primary table column that should be used as the training - label. - format: int32 - type: integer - XPSTfSavedModelFormat: + This field is for training. When the operation is terminated + successfully, AutoML Backend post this field to operation metadata + in spanner. If the metadata has no trials returned, the training + operation is supposed to be a failure. + type: array + items: + $ref: '#/components/schemas/XPSTuningTrial' + XPSCoreMlFormat: + description: A model format used for iOS mobile devices. properties: {} - id: XPSTfSavedModelFormat - type: object - description: A tensorflow model format in SavedModel format. - XPSXraiAttribution: - properties: - stepCount: - description: >- - The number of steps for approximating the path integral. A good - value to start is 50 and gradually increase until the sum to diff - property is met within the desired error range. Valid range of its - value is [1, 100], inclusively. - type: integer - format: int32 - deprecated: true + id: XPSCoreMlFormat type: object - description: >- - An explanation method that redistributes Integrated Gradients - attributions to segmented regions, taking advantage of the model's fully - differentiable structure. Refer to this paper for more details: - https://arxiv.org/abs/1906.02825 Only supports image Models (modality is - IMAGE). - id: XPSXraiAttribution XPSStringStatsUnigramStats: - id: XPSStringStatsUnigramStats - description: The statistics of a unigram. properties: + count: + type: string + description: The number of occurrences of this unigram in the series. + format: int64 value: type: string description: The unigram. - count: - type: string - format: int64 - description: The number of occurrences of this unigram in the series. type: object - XPSImageClassificationTrainResponse: - id: XPSImageClassificationTrainResponse + id: XPSStringStatsUnigramStats + description: The statistics of a unigram. + Sentence: + properties: + text: + description: The sentence text. + $ref: '#/components/schemas/TextSpan' + sentiment: + description: >- + For calls to AnalyzeSentiment or if + AnnotateTextRequest.Features.extract_document_sentiment is set to + true, this field will contain the sentiment for the sentence. + $ref: '#/components/schemas/Sentiment' + id: Sentence type: object + description: Represents a sentence in the input document. + XPSTablesModelStructure: + type: object + description: A description of Tables model structure. properties: - classCount: - description: Total number of classes. + modelParameters: + description: A list of models. + type: array + items: + $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' + id: XPSTablesModelStructure + XPSVideoObjectTrackingTrainResponse: + id: XPSVideoObjectTrackingTrainResponse + type: object + properties: + trainCostNodeSeconds: format: int64 type: string - stopReason: - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED - enumDescriptions: - - '' - - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - type: string description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. modelArtifactSpec: + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSImageModelArtifactSpec' exportModelSpec: + $ref: '#/components/schemas/XPSVideoExportModelSpec' + description: Populated for AutoML request only. + XPSImageExportModelSpec: + type: object + properties: + exportModelOutputConfig: description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Populated for - AutoMl requests. - $ref: '#/components/schemas/XPSImageExportModelSpec' - trainCostNodeSeconds: - format: int64 + Contains the model format and internal location of the model files + to be exported/downloaded. Use the GCS bucket name which is provided + via TrainRequest.gcs_bucket_name to store the model files. + items: + $ref: '#/components/schemas/XPSExportModelOutputConfig' + type: array + id: XPSImageExportModelSpec + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Upon receiving + ExportModel request from user, AutoMl backend can serve the + pre-generated models to user if exists (by copying the files from + internal path to user provided location), otherwise, AutoMl backend will + call xPS ExportModel API to generate the model on the fly with the + requesting format. + XPSDockerFormat: + id: XPSDockerFormat + description: >- + A model format used for Docker containers. Use the params field to + customize the container. The container is verified to work correctly on + ubuntu 16.04 operating system. + properties: + gpuArchitecture: + enumDescriptions: + - '' + - '' + enum: + - GPU_ARCHITECTURE_UNSPECIFIED + - GPU_ARCHITECTURE_NVIDIA type: string description: >- - The actual training cost, expressed in node seconds. Populated for - models trained in node time. - trainCostInNodeTime: + Optional. Additional gpu information describing the requirements for + the to be exported model files. + cpuArchitecture: + enum: + - CPU_ARCHITECTURE_UNSPECIFIED + - CPU_ARCHITECTURE_X86_64 + enumDescriptions: + - '' + - '' description: >- - The actual cost to create this model. - For edge type model, the - cost is expressed in node hour. - For cloud type model,the cost is - expressed in compute hour. - Populated for models created before GA. - To be deprecated after GA. + Optional. Additional cpu information describing the requirements for + the to be exported model files. type: string - format: google-duration - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' + type: object + XPSSpeechEvaluationMetrics: + properties: + subModelEvaluationMetrics: + items: + $ref: >- + #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric + type: array + description: Evaluation metrics for all submodels contained in this model. + id: XPSSpeechEvaluationMetrics + type: object parameters: - _.xgafv: - description: V1 error format. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: $.xgafv + name: upload_protocol + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string - enum: - - '1' - - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -4842,6 +4851,12 @@ components: name: oauth_token schema: type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -4851,36 +4866,21 @@ components: name: key schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean callback: description: JSONP in: query name: callback schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string + enum: + - '1' + - '2' uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query @@ -4903,9 +4903,9 @@ components: name: documents title: Documents methods: - moderate_text: + analyze_sentiment: operation: - $ref: '#/paths/~1v2~1documents:moderateText/post' + $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4915,21 +4915,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - annotate_text: + analyze_entities: operation: - $ref: '#/paths/~1v2~1documents:annotateText/post' + $ref: '#/paths/~1v2~1documents:analyzeEntities/post' response: mediaType: application/json openAPIDocKey: '200' - analyze_entities: + annotate_text: operation: - $ref: '#/paths/~1v2~1documents:analyzeEntities/post' + $ref: '#/paths/~1v2~1documents:annotateText/post' response: mediaType: application/json openAPIDocKey: '200' - analyze_sentiment: + moderate_text: operation: - $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' + $ref: '#/paths/~1v2~1documents:moderateText/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4940,27 +4940,27 @@ components: replace: [] delete: [] paths: - /v2/documents:moderateText: + /v2/documents:analyzeSentiment: parameters: &ref_1 - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' post: - description: Moderates a document for harmful and sensitive categories. - operationId: language.documents.moderateText + description: Analyzes the sentiment of the provided text. + operationId: language.documents.analyzeSentiment requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModerateTextRequest' + $ref: '#/components/schemas/AnalyzeSentimentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -4976,7 +4976,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ModerateTextResponse' + $ref: '#/components/schemas/AnalyzeSentimentResponse' parameters: [] /v2/documents:classifyText: parameters: *ref_1 @@ -5005,16 +5005,19 @@ paths: schema: $ref: '#/components/schemas/ClassifyTextResponse' parameters: [] - /v2/documents:annotateText: + /v2/documents:analyzeEntities: parameters: *ref_1 post: - description: A convenience method that provides all features in one call. - operationId: language.documents.annotateText + description: >- + Finds named entities (currently proper names and common nouns) in the + text along with entity types, probability, mentions for each entity, and + other properties. + operationId: language.documents.analyzeEntities requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextRequest' + $ref: '#/components/schemas/AnalyzeEntitiesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5030,21 +5033,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextResponse' + $ref: '#/components/schemas/AnalyzeEntitiesResponse' parameters: [] - /v2/documents:analyzeEntities: + /v2/documents:annotateText: parameters: *ref_1 post: - description: >- - Finds named entities (currently proper names and common nouns) in the - text along with entity types, probability, mentions for each entity, and - other properties. - operationId: language.documents.analyzeEntities + description: A convenience method that provides all features in one call. + operationId: language.documents.annotateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesRequest' + $ref: '#/components/schemas/AnnotateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5060,18 +5060,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesResponse' + $ref: '#/components/schemas/AnnotateTextResponse' parameters: [] - /v2/documents:analyzeSentiment: + /v2/documents:moderateText: parameters: *ref_1 post: - description: Analyzes the sentiment of the provided text. - operationId: language.documents.analyzeSentiment + description: Moderates a document for harmful and sensitive categories. + operationId: language.documents.moderateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentRequest' + $ref: '#/components/schemas/ModerateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5087,5 +5087,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentResponse' + $ref: '#/components/schemas/ModerateTextResponse' parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml index d14eb5f1..8cc475de 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml @@ -7,8 +7,8 @@ info: title: Library Agent API description: A simple Google Example Library API. version: v1 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/docs/quota servers: @@ -35,7 +35,6 @@ components: scopes: *ref_0 schemas: GoogleExampleLibraryagentV1ListBooksResponse: - description: Response message for LibraryAgent.ListBooks. properties: nextPageToken: type: string @@ -44,73 +43,76 @@ components: ListBooksRequest.page_token field in the subsequent call to `ListBooks` method to retrieve the next page of results. books: + type: array description: The list of books. items: $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' - type: array - type: object id: GoogleExampleLibraryagentV1ListBooksResponse + type: object + description: Response message for LibraryAgent.ListBooks. GoogleExampleLibraryagentV1ListShelvesResponse: + id: GoogleExampleLibraryagentV1ListShelvesResponse + description: Response message for LibraryAgent.ListShelves. type: object properties: nextPageToken: - type: string description: >- A token to retrieve next page of results. Pass this value in the ListShelvesRequest.page_token field in the subsequent call to `ListShelves` method to retrieve the next page of results. + type: string shelves: + description: The list of shelves. + type: array items: $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' - type: array - description: The list of shelves. - description: Response message for LibraryAgent.ListShelves. - id: GoogleExampleLibraryagentV1ListShelvesResponse - GoogleExampleLibraryagentV1Shelf: - id: GoogleExampleLibraryagentV1Shelf - description: A Shelf contains a collection of books with a theme. - properties: - name: - type: string - description: >- - Output only. The resource name of the shelf. Shelf names have the - form `shelves/{shelf_id}`. The name is ignored when creating a - shelf. - theme: - type: string - description: The theme of the shelf - type: object GoogleExampleLibraryagentV1Book: id: GoogleExampleLibraryagentV1Book - type: object - description: A single book in the library. properties: + author: + description: The name of the book author. + type: string read: description: Value indicating whether the book has been read. type: boolean title: - description: The title of the book. type: string + description: The title of the book. name: type: string description: >- The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book. - author: + description: A single book in the library. + type: object + GoogleExampleLibraryagentV1Shelf: + description: A Shelf contains a collection of books with a theme. + properties: + theme: type: string - description: The name of the book author. + description: The theme of the shelf + name: + description: >- + Output only. The resource name of the shelf. Shelf names have the + form `shelves/{shelf_id}`. The name is ignored when creating a + shelf. + type: string + id: GoogleExampleLibraryagentV1Shelf + type: object parameters: - alt: - description: Data format for response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: alt + name: oauth_token + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string - enum: - - json - - media - - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -120,16 +122,19 @@ components: name: quotaUser schema: type: string - access_token: - description: OAuth access token. + 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. in: query - name: access_token + name: key schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + callback: + description: JSONP in: query - name: fields + name: callback schema: type: string _.xgafv: @@ -141,31 +146,26 @@ components: enum: - '1' - '2' - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - 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. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: key + name: fields schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + alt: + description: Data format for response. in: query - name: upload_protocol + name: alt schema: type: string - callback: - description: JSONP + enum: + - json + - media + - proto + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string prettyPrint: @@ -174,10 +174,10 @@ components: name: prettyPrint schema: type: boolean - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: uploadType + name: upload_protocol schema: type: string x-stackQL-resources: @@ -193,9 +193,9 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.books - get: + borrow: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}/get' + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:borrow/post' response: mediaType: application/json openAPIDocKey: '200' @@ -205,9 +205,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - borrow: + get: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:borrow/post' + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -248,17 +248,17 @@ components: paths: /v1/shelves/{shelvesId}/books: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' get: description: >- Lists books in a shelf. The order is unspecified but deterministic. @@ -284,20 +284,24 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/shelves/{shelvesId}/books/{booksId}: + /v1/shelves/{shelvesId}/books/{booksId}:borrow: parameters: *ref_1 - get: - description: Gets a book. Returns NOT_FOUND if the book does not exist. - operationId: libraryagent.shelves.books.get + post: + description: >- + Borrow a book from the library. Returns the book if it is borrowed + successfully. Returns NOT_FOUND if the book does not exist in the + library. Returns quota exceeded error if the amount of books borrowed + exceeds allocation quota in any dimensions. + operationId: libraryagent.shelves.books.borrow security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -352,15 +356,11 @@ paths: required: true schema: type: string - /v1/shelves/{shelvesId}/books/{booksId}:borrow: + /v1/shelves/{shelvesId}/books/{booksId}: parameters: *ref_1 - post: - description: >- - Borrow a book from the library. Returns the book if it is borrowed - successfully. Returns NOT_FOUND if the book does not exist in the - library. Returns quota exceeded error if the amount of books borrowed - exceeds allocation quota in any dimensions. - operationId: libraryagent.shelves.books.borrow + get: + description: Gets a book. Returns NOT_FOUND if the book does not exist. + operationId: libraryagent.shelves.books.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform diff --git a/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml b/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml index 66168611..109f03a8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml @@ -9,8 +9,8 @@ info: Cloud Life Sciences is a suite of services and tools for managing, processing, and transforming life sciences data. version: v2beta - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/life-sciences servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/logging.yaml b/providers/src/googleapis.com/v00.00.00000/services/logging.yaml index cd6f92f5..cf7a3625 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/logging.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/logging.yaml @@ -7,8 +7,8 @@ info: title: Cloud Logging API description: Writes log entries and manages your Cloud Logging configuration. version: v2 - x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240913' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/logging/docs/ servers: @@ -646,8 +646,8 @@ components: - FAILED analyticsEnabled: description: >- - Whether log analytics is enabled for this bucket.Once enabled, log - analytics features cannot be disabled. + Optional. Whether log analytics is enabled for this bucket.Once + enabled, log analytics features cannot be disabled. type: boolean restrictedFields: description: >- diff --git a/providers/src/googleapis.com/v00.00.00000/services/looker.yaml b/providers/src/googleapis.com/v00.00.00000/services/looker.yaml index 2167ca97..afadd210 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/looker.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/looker.yaml @@ -7,8 +7,8 @@ info: title: Looker (Google Cloud core) API description: '' version: v1 - x-discovery-doc-revision: '20240821' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/looker/docs/reference/rest/ servers: @@ -317,6 +317,14 @@ components: description: Optional. Linked Google Cloud Project Number for Looker Studio Pro. type: string format: int64 + fipsEnabled: + description: Optional. Whether FIPS is enabled on the Looker instance. + type: boolean + geminiEnabled: + description: >- + Optional. Whether Gemini feature is enabled on the Looker instance + or not. + type: boolean PscConfig: id: PscConfig description: >- diff --git a/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml b/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml index 3495f3fe..7835f931 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml @@ -10,8 +10,8 @@ info: a highly available, hardened service running Microsoft Active Directory (AD). version: v1 - x-discovery-doc-revision: '20240530' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/managed-microsoft-ad/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml b/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml index 503102ab..d0b34e40 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml @@ -9,8 +9,8 @@ info: Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP. version: v1 - x-discovery-doc-revision: '20240711' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240902' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/memorystore/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml b/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml index 4937bea6..ad745e10 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml @@ -9,8 +9,8 @@ info: The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services. version: v1 - x-discovery-doc-revision: '20240818' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dataproc-metastore/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml b/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml index aec011bd..c4e79475 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml @@ -10,7 +10,7 @@ info: from your current on-premises or cloud environments to Google Cloud. version: v1 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/migration-center servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/ml.yaml b/providers/src/googleapis.com/v00.00.00000/services/ml.yaml index 31182e67..d4a72ba4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ml.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ml.yaml @@ -8,7 +8,7 @@ info: description: An API to enable creating and using machine learning models. version: v1 x-discovery-doc-revision: '20240816' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/ml/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml b/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml index 8e28cf39..23c33456 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml @@ -7,8 +7,8 @@ info: title: Cloud Monitoring API description: Manages your Cloud Monitoring data and configurations. version: v3 - x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/monitoring/api/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml index 0ec5c88c..df78325f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml @@ -7,8 +7,8 @@ info: title: Network Connectivity API description: This API enables connectivity with and between Google Cloud resources. version: v1 - x-discovery-doc-revision: '20240807' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240911' + x-generated-date: '2024-09-19' externalDocs: url: >- https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest @@ -308,7 +308,10 @@ components: - POLICY_LIMIT_REACHED - CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED producerInstanceId: - description: Immutable. An immutable identifier for the producer instance. + description: >- + Immutable. Deprecated. Use producer_instance_metadata instead. An + immutable identifier for the producer instance. + deprecated: true type: string serviceAttachmentIpAddressMap: description: >- @@ -328,6 +331,11 @@ components: Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234' type: string + producerInstanceMetadata: + description: Immutable. An immutable map for the producer instance metadata. + type: object + additionalProperties: + type: string ConsumerPscConnection: id: ConsumerPscConnection description: PSC connection details on consumer side. @@ -343,7 +351,10 @@ components: type: string enumDescriptions: - An invalid state as the default case. - - The connection is fully established and ready to use. + - >- + The connection has been created successfully. However, for the + up-to-date connection status, please use the service attachment's + "ConnectedEndpoint.status" as the source of truth. - >- The connection is not functional since some resources on the connection fail to be created. @@ -381,6 +392,7 @@ components: description: >- The error type indicates whether the error is consumer facing, producer facing or system internal. + deprecated: true type: string enumDescriptions: - An invalid error type as the default case. @@ -417,8 +429,16 @@ components: readOnly: true type: string producerInstanceId: - description: Immutable. An immutable identifier for the producer instance. + description: >- + Immutable. Deprecated. Use producer_instance_metadata instead. An + immutable identifier for the producer instance. + deprecated: true type: string + producerInstanceMetadata: + description: Immutable. An immutable map for the producer instance metadata. + type: object + additionalProperties: + type: string GoogleRpcErrorInfo: id: GoogleRpcErrorInfo description: >- @@ -497,12 +517,12 @@ components: See: https://google.aip.dev/122#fields-representing-resource-names type: string createTime: - description: Output only. Time when the ServiceConnectionMap was created. + description: Output only. Time when the ServiceConnectionPolicy was created. readOnly: true type: string format: google-datetime updateTime: - description: Output only. Time when the ServiceConnectionMap was updated. + description: Output only. Time when the ServiceConnectionPolicy was updated. readOnly: true type: string format: google-datetime @@ -627,7 +647,10 @@ components: type: string enumDescriptions: - An invalid state as the default case. - - The connection is fully established and ready to use. + - >- + The connection has been created successfully. However, for the + up-to-date connection status, please use the created forwarding + rule's "PscConnectionStatus" as the source of truth. - >- The connection is not functional since some resources on the connection fail to be created. @@ -651,6 +674,7 @@ components: description: >- The error type indicates whether the error is consumer facing, producer facing or system internal. + deprecated: true type: string enumDescriptions: - An invalid error type as the default case. @@ -663,7 +687,9 @@ components: - ERROR_CONSUMER_SIDE - ERROR_PRODUCER_SIDE error: - description: The most recent error during operating this connection. + description: >- + The most recent error during operating this connection. Deprecated, + please use error_info instead. deprecated: true $ref: '#/components/schemas/GoogleRpcStatus' gceOperation: @@ -688,7 +714,22 @@ components: readOnly: true type: string producerInstanceId: - description: Immutable. An immutable identifier for the producer instance. + description: >- + Immutable. Deprecated. Use producer_instance_metadata instead. An + immutable identifier for the producer instance. + deprecated: true + type: string + producerInstanceMetadata: + description: Immutable. An immutable map for the producer instance metadata. + type: object + additionalProperties: + type: string + serviceClass: + description: >- + Output only. [Output only] The service class associated with this + PSC Connection. The value is derived from the SCPolicy and matches + the service class name provided by the customer. + readOnly: true type: string ListServiceClassesResponse: id: ListServiceClassesResponse @@ -1985,7 +2026,11 @@ components: description: A description of this resource. type: string ipCidrRange: - description: The IP range that this internal range defines. + description: >- + The IP range that this internal range defines. NOTE: IPv6 ranges are + limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For + IPv6 Ranges this field is compulsory, i.e. the address range must be + specified explicitly. type: string network: description: >- @@ -2014,10 +2059,16 @@ components: resources and are meant to block out address ranges for various use cases, like for example, usage on-prem, with dynamic route announcements via interconnect. + - >- + Ranges created FOR_MIGRATION can be used to lock a CIDR range + between a source and target subnet. If usage is set to + FOR_MIGRATION the peering value has to be set to FOR_SELF or + default to FOR_SELF when unset. enum: - USAGE_UNSPECIFIED - FOR_VPC - EXTERNAL_TO_VPC + - FOR_MIGRATION peering: description: The type of peering set for this internal range. type: string @@ -2052,11 +2103,14 @@ components: - NOT_SHARED prefixLength: description: >- - An alternate to ip_cidr_range. Can be set when trying to create a - reservation that automatically finds a free range of the given size. - If both ip_cidr_range and prefix_length are set, there is an error - if the range sizes do not match. Can also be used during updates to - change the range size. + An alternate to ip_cidr_range. Can be set when trying to create an + IPv4 reservation that automatically finds a free range of the given + size. If both ip_cidr_range and prefix_length are set, there is an + error if the range sizes do not match. Can also be used during + updates to change the range size. NOTE: For IPv6 this field only + works if ip_cidr_range is set as well, and both fields must match. + In other words, with IPv6 this field only works as a redundant + parameter. type: integer format: int32 targetCidrRange: @@ -2100,6 +2154,28 @@ components: - OVERLAP_UNSPECIFIED - OVERLAP_ROUTE_RANGE - OVERLAP_EXISTING_SUBNET_RANGE + migration: + description: Optional. Should be present if usage is set to FOR_MIGRATION. + $ref: '#/components/schemas/Migration' + Migration: + id: Migration + description: Specification for migration with source and target resource names. + type: object + properties: + source: + description: >- + Immutable. Resource path as an URI of the source resource, for + example a subnet. The project for the source resource should match + the project for the InternalRange. An example: + /projects/{project}/regions/{region}/subnetworks/{subnet} + type: string + target: + description: >- + Immutable. Resource path of the target resource. The target project + can be different, as in the cases when migrating to peer networks. + The resource For example: + /projects/{project}/regions/{region}/subnetworks/{subnet} + type: string ListPolicyBasedRoutesResponse: id: ListPolicyBasedRoutesResponse description: Response for PolicyBasedRouting.ListPolicyBasedRoutes method. diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml index dae788ef..c1105d24 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml @@ -10,7 +10,7 @@ info: monitoring and diagnostic capabilities. version: v1 x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml b/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml index 84998b76..5695c19b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240828' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/networking servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml index 4bc4c529..85640da5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml @@ -7,8 +7,8 @@ info: title: Network Services API description: '' version: v1 - x-discovery-doc-revision: '20240827' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/networking servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml b/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml index baaa9255..8bb879aa 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml @@ -8,7 +8,7 @@ info: description: Notebooks API is used to manage notebook resources in Google Cloud. version: v2 x-discovery-doc-revision: '20240820' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/notebooks/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml b/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml index 8d70f1d0..2e4f3cc0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml @@ -8,7 +8,7 @@ info: description: A service to scan container images for vulnerabilities. version: v1 x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/container-analysis/docs/on-demand-scanning/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/oracledatabase.yaml b/providers/src/googleapis.com/v00.00.00000/services/oracledatabase.yaml new file mode 100644 index 00000000..34b245e3 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/oracledatabase.yaml @@ -0,0 +1,4101 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Oracle Database@Google Cloud API + description: >- + The Oracle Database@Google Cloud API provides set of APIs to manage Oracle + databases such as Exadata and Autonomous Databases. + version: v1 + x-discovery-doc-revision: '20240913' + x-generated-date: '2024-09-19' +externalDocs: + url: https://cloud.google.com/oracle/database/docs +servers: + - url: https://oracledatabase.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: 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); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListCloudExadataInfrastructuresResponse: + id: ListCloudExadataInfrastructuresResponse + description: The response for `CloudExadataInfrastructures.list`. + type: object + properties: + cloudExadataInfrastructures: + description: The list of Exadata Infrastructures. + type: array + items: + $ref: '#/components/schemas/CloudExadataInfrastructure' + nextPageToken: + description: A token for fetching next page of response. + type: string + CloudExadataInfrastructure: + id: CloudExadataInfrastructure + description: >- + Represents CloudExadataInfrastructure resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/ + type: object + properties: + name: + description: >- + Identifier. The name of the Exadata Infrastructure resource with the + format: + projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} + type: string + displayName: + description: Optional. User friendly name for this resource. + type: string + gcpOracleZone: + description: Optional. GCP location where Oracle Exadata is hosted. + type: string + entitlementId: + description: >- + Output only. Entitlement ID of the private offer against which this + infrastructure resource is provisioned. + readOnly: true + type: string + properties: + description: Optional. Various properties of the infra. + $ref: '#/components/schemas/CloudExadataInfrastructureProperties' + labels: + description: Optional. Labels or tags associated with the resource. + type: object + additionalProperties: + type: string + createTime: + description: >- + Output only. The date and time that the Exadata Infrastructure was + created. + readOnly: true + type: string + format: google-datetime + CloudExadataInfrastructureProperties: + id: CloudExadataInfrastructureProperties + description: Various properties of Exadata Infrastructure. + type: object + properties: + ocid: + description: >- + Output only. OCID of created infra. + https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + readOnly: true + type: string + computeCount: + description: >- + Optional. The number of compute servers for the Exadata + Infrastructure. + type: integer + format: int32 + storageCount: + description: >- + Optional. The number of Cloud Exadata storage servers for the + Exadata Infrastructure. + type: integer + format: int32 + totalStorageSizeGb: + description: >- + Optional. The total storage allocated to the Exadata Infrastructure + resource, in gigabytes (GB). + type: integer + format: int32 + availableStorageSizeGb: + description: >- + Output only. The available storage can be allocated to the Exadata + Infrastructure resource, in gigabytes (GB). + readOnly: true + type: integer + format: int32 + maintenanceWindow: + description: Optional. Maintenance window for repair. + $ref: '#/components/schemas/MaintenanceWindow' + state: + description: >- + Output only. The current lifecycle state of the Exadata + Infrastructure. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - The Exadata Infrastructure is being provisioned. + - The Exadata Infrastructure is available for use. + - The Exadata Infrastructure is being updated. + - The Exadata Infrastructure is being terminated. + - The Exadata Infrastructure is terminated. + - The Exadata Infrastructure is in failed state. + - The Exadata Infrastructure is in maintenance. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + shape: + description: >- + Required. The shape of the Exadata Infrastructure. The shape + determines the amount of CPU, storage, and memory resources + allocated to the instance. + type: string + ociUrl: + description: Output only. Deep link to the OCI console to view this resource. + readOnly: true + type: string + cpuCount: + description: Optional. The number of enabled CPU cores. + type: integer + format: int32 + maxCpuCount: + description: Output only. The total number of CPU cores available. + readOnly: true + type: integer + format: int32 + memorySizeGb: + description: Optional. The memory allocated in GBs. + type: integer + format: int32 + maxMemoryGb: + description: Output only. The total memory available in GBs. + readOnly: true + type: integer + format: int32 + dbNodeStorageSizeGb: + description: Optional. The local node storage allocated in GBs. + type: integer + format: int32 + maxDbNodeStorageSizeGb: + description: Output only. The total local node storage available in GBs. + readOnly: true + type: integer + format: int32 + dataStorageSizeTb: + description: Output only. Size, in terabytes, of the DATA disk group. + readOnly: true + type: number + format: double + maxDataStorageTb: + description: Output only. The total available DATA disk group size. + readOnly: true + type: number + format: double + activatedStorageCount: + description: >- + Output only. The requested number of additional storage servers + activated for the Exadata Infrastructure. + readOnly: true + type: integer + format: int32 + additionalStorageCount: + description: >- + Output only. The requested number of additional storage servers for + the Exadata Infrastructure. + readOnly: true + type: integer + format: int32 + dbServerVersion: + description: >- + Output only. The software version of the database servers (dom0) in + the Exadata Infrastructure. + readOnly: true + type: string + storageServerVersion: + description: >- + Output only. The software version of the storage servers (cells) in + the Exadata Infrastructure. + readOnly: true + type: string + nextMaintenanceRunId: + description: Output only. The OCID of the next maintenance run. + readOnly: true + type: string + nextMaintenanceRunTime: + description: Output only. The time when the next maintenance run will occur. + readOnly: true + type: string + format: google-datetime + nextSecurityMaintenanceRunTime: + description: >- + Output only. The time when the next security maintenance run will + occur. + readOnly: true + type: string + format: google-datetime + customerContacts: + description: Optional. The list of customer contacts. + type: array + items: + $ref: '#/components/schemas/CustomerContact' + monthlyStorageServerVersion: + description: >- + Output only. The monthly software version of the storage servers + (cells) in the Exadata Infrastructure. Example: 20.1.15 + readOnly: true + type: string + monthlyDbServerVersion: + description: >- + Output only. The monthly software version of the database servers + (dom0) in the Exadata Infrastructure. Example: 20.1.15 + readOnly: true + type: string + MaintenanceWindow: + id: MaintenanceWindow + description: >- + Maintenance window as defined by Oracle. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow + type: object + properties: + preference: + description: Optional. The maintenance window scheduling preference. + type: string + enumDescriptions: + - Default unspecified value. + - Custom preference. + - No preference. + enum: + - MAINTENANCE_WINDOW_PREFERENCE_UNSPECIFIED + - CUSTOM_PREFERENCE + - NO_PREFERENCE + months: + description: >- + Optional. Months during the year when maintenance should be + performed. + type: array + items: + type: string + enumDescriptions: + - The unspecified month. + - The month of January. + - The month of February. + - The month of March. + - The month of April. + - The month of May. + - The month of June. + - The month of July. + - The month of August. + - The month of September. + - The month of October. + - The month of November. + - The month of December. + enum: + - MONTH_UNSPECIFIED + - JANUARY + - FEBRUARY + - MARCH + - APRIL + - MAY + - JUNE + - JULY + - AUGUST + - SEPTEMBER + - OCTOBER + - NOVEMBER + - DECEMBER + weeksOfMonth: + description: >- + Optional. Weeks during the month when maintenance should be + performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the + month, and have a duration of 7 days. Weeks start and end based on + calendar dates, not days of the week. + type: array + items: + type: integer + format: int32 + daysOfWeek: + description: Optional. Days during the week when maintenance should be performed. + type: array + items: + type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + hoursOfDay: + description: >- + Optional. The window of hours during the day when maintenance should + be performed. The window is a 4 hour slot. Valid values are: 0 - + represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - + 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents + time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 + UTC 20 - represents time slot 20:00 - 23:59 UTC + type: array + items: + type: integer + format: int32 + leadTimeWeek: + description: >- + Optional. Lead time window allows user to set a lead time to prepare + for a down time. The lead time is in weeks and valid value is + between 1 to 4. + type: integer + format: int32 + patchingMode: + description: >- + Optional. Cloud CloudExadataInfrastructure node patching method, + either "ROLLING" or "NONROLLING". Default value is ROLLING. + type: string + enumDescriptions: + - Default unspecified value. + - >- + Updates the Cloud Exadata database server hosts in a rolling + fashion. + - >- + The non-rolling maintenance method first updates your storage + servers at the same time, then your database servers at the same + time. + enum: + - PATCHING_MODE_UNSPECIFIED + - ROLLING + - NON_ROLLING + customActionTimeoutMins: + description: >- + Optional. Determines the amount of time the system will wait before + the start of each database server patching operation. Custom action + timeout is in minutes and valid value is between 15 to 120 + (inclusive). + type: integer + format: int32 + isCustomActionTimeoutEnabled: + description: >- + Optional. If true, enables the configuration of a custom action + timeout (waiting period) between database server patching + operations. + type: boolean + CustomerContact: + id: CustomerContact + description: >- + The CustomerContact reference as defined by Oracle. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact + type: object + properties: + email: + description: >- + Required. The email address used by Oracle to send notifications + regarding databases and infrastructure. + type: string + ListCloudVmClustersResponse: + id: ListCloudVmClustersResponse + description: The response for `CloudVmCluster.List`. + type: object + properties: + cloudVmClusters: + description: The list of VM Clusters. + type: array + items: + $ref: '#/components/schemas/CloudVmCluster' + nextPageToken: + description: A token to fetch the next page of results. + type: string + CloudVmCluster: + id: CloudVmCluster + description: >- + Details of the Cloud VM Cluster resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/ + type: object + properties: + name: + description: >- + Identifier. The name of the VM Cluster resource with the format: + projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster} + type: string + exadataInfrastructure: + description: >- + Required. The name of the Exadata Infrastructure resource on which + VM cluster resource is created, in the following format: + projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure} + type: string + displayName: + description: Optional. User friendly name for this resource. + type: string + gcpOracleZone: + description: >- + Output only. GCP location where Oracle Exadata is hosted. It is same + as GCP Oracle zone of Exadata infrastructure. + readOnly: true + type: string + properties: + description: Optional. Various properties of the VM Cluster. + $ref: '#/components/schemas/CloudVmClusterProperties' + labels: + description: Optional. Labels or tags associated with the VM Cluster. + type: object + additionalProperties: + type: string + createTime: + description: Output only. The date and time that the VM cluster was created. + readOnly: true + type: string + format: google-datetime + cidr: + description: Required. Network settings. CIDR to use for cluster IP allocation. + type: string + backupSubnetCidr: + description: Required. CIDR range of the backup subnet. + type: string + network: + description: >- + Required. The name of the VPC network. Format: + projects/{project}/global/networks/{network} + type: string + CloudVmClusterProperties: + id: CloudVmClusterProperties + description: Various properties and settings associated with Exadata VM cluster. + type: object + properties: + ocid: + description: Output only. Oracle Cloud Infrastructure ID of VM Cluster. + readOnly: true + type: string + licenseType: + description: Required. License type of VM Cluster. + type: string + enumDescriptions: + - Unspecified + - License included part of offer + - Bring your own license + enum: + - LICENSE_TYPE_UNSPECIFIED + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + giVersion: + description: Optional. Grid Infrastructure Version. + type: string + timeZone: + description: >- + Optional. Time zone of VM Cluster to set. Defaults to UTC if not + specified. + $ref: '#/components/schemas/TimeZone' + sshPublicKeys: + description: Optional. SSH public keys to be stored with cluster. + type: array + items: + type: string + nodeCount: + description: Optional. Number of database servers. + type: integer + format: int32 + shape: + description: Output only. Shape of VM Cluster. + readOnly: true + type: string + ocpuCount: + description: Optional. OCPU count per VM. Minimum is 0.1. + type: number + format: float + memorySizeGb: + description: Optional. Memory allocated in GBs. + type: integer + format: int32 + dbNodeStorageSizeGb: + description: Optional. Local storage per VM. + type: integer + format: int32 + storageSizeGb: + description: >- + Output only. The storage allocation for the disk group, in gigabytes + (GB). + readOnly: true + type: integer + format: int32 + dataStorageSizeTb: + description: Optional. The data disk group size to be allocated in TBs. + type: number + format: double + diskRedundancy: + description: Optional. The type of redundancy. + type: string + enumDescriptions: + - Unspecified. + - High - 3 way mirror. + - Normal - 2 way mirror. + enum: + - DISK_REDUNDANCY_UNSPECIFIED + - HIGH + - NORMAL + sparseDiskgroupEnabled: + description: Optional. Use exadata sparse snapshots. + type: boolean + localBackupEnabled: + description: Optional. Use local backup. + type: boolean + hostnamePrefix: + description: Optional. Prefix for VM cluster host names. + type: string + diagnosticsDataCollectionOptions: + description: Optional. Data collection options for diagnostics. + $ref: '#/components/schemas/DataCollectionOptions' + state: + description: Output only. State of the cluster. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Indicates that the resource is in Provisioning state. + - Indicates that the resource is in Available state. + - Indicates that the resource is in Updating state. + - Indicates that the resource is in Terminating state. + - Indicates that the resource is in Terminated state. + - Indicates that the resource is in Failed state. + - Indicates that the resource is in Maintenance In Progress state. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + scanListenerPortTcp: + description: Output only. SCAN listener port - TCP + readOnly: true + type: integer + format: int32 + scanListenerPortTcpSsl: + description: Output only. SCAN listener port - TLS + readOnly: true + type: integer + format: int32 + domain: + description: >- + Output only. Parent DNS domain where SCAN DNS and hosts names are + qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com + readOnly: true + type: string + scanDns: + description: >- + Output only. SCAN DNS name. ex: + sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com + readOnly: true + type: string + hostname: + description: >- + Output only. host name without domain. format: "-" with some suffix. + ex: sp2-yi0xq where "sp2" is the hostname_prefix. + readOnly: true + type: string + cpuCoreCount: + description: Required. Number of enabled CPU cores. + type: integer + format: int32 + systemVersion: + description: Output only. Operating system version of the image. + readOnly: true + type: string + scanIpIds: + description: Output only. OCIDs of scan IPs. + readOnly: true + type: array + items: + type: string + scanDnsRecordId: + description: Output only. OCID of scan DNS record. + readOnly: true + type: string + ociUrl: + description: Output only. Deep link to the OCI console to view this resource. + readOnly: true + type: string + dbServerOcids: + description: Optional. OCID of database servers. + type: array + items: + type: string + compartmentId: + description: Output only. Compartment ID of cluster. + readOnly: true + type: string + dnsListenerIp: + description: Output only. DNS listener IP. + readOnly: true + type: string + clusterName: + description: Optional. OCI Cluster name. + type: string + TimeZone: + id: TimeZone + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). + type: object + properties: + id: + description: IANA Time Zone Database time zone, e.g. "America/New_York". + type: string + version: + description: Optional. IANA Time Zone Database version number, e.g. "2019a". + type: string + DataCollectionOptions: + id: DataCollectionOptions + description: Data collection options for diagnostics. + type: object + properties: + diagnosticsEventsEnabled: + description: >- + Optional. Indicates whether diagnostic collection is enabled for the + VM cluster + type: boolean + healthMonitoringEnabled: + description: >- + Optional. Indicates whether health monitoring is enabled for the VM + cluster + type: boolean + incidentLogsEnabled: + description: >- + Optional. Indicates whether incident logs and trace collection are + enabled for the VM cluster + type: boolean + ListEntitlementsResponse: + id: ListEntitlementsResponse + description: The response for `Entitlement.List`. + type: object + properties: + entitlements: + description: The list of Entitlements + type: array + items: + $ref: '#/components/schemas/Entitlement' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + Entitlement: + id: Entitlement + description: Details of the Entitlement resource. + type: object + properties: + name: + description: >- + Identifier. The name of the Entitlement resource with the format: + projects/{project}/locations/{region}/entitlements/{entitlement} + type: string + cloudAccountDetails: + description: Details of the OCI Cloud Account. + $ref: '#/components/schemas/CloudAccountDetails' + entitlementId: + description: Output only. Google Cloud Marketplace order ID (aka entitlement ID) + readOnly: true + type: string + state: + description: Output only. Entitlement State. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Account not linked. + - Account is linked but not active. + - Entitlement and Account are active. + enum: + - STATE_UNSPECIFIED + - ACCOUNT_NOT_LINKED + - ACCOUNT_NOT_ACTIVE + - ACTIVE + CloudAccountDetails: + id: CloudAccountDetails + description: Details of the OCI Cloud Account. + type: object + properties: + cloudAccount: + description: Output only. OCI account name. + readOnly: true + type: string + cloudAccountHomeRegion: + description: Output only. OCI account home region. + readOnly: true + type: string + linkExistingAccountUri: + description: Output only. URL to link an existing account. + readOnly: true + type: string + accountCreationUri: + description: Output only. URL to create a new account and link. + readOnly: true + type: string + ListDbServersResponse: + id: ListDbServersResponse + description: The response for `DbServer.List`. + type: object + properties: + dbServers: + description: The list of database servers. + type: array + items: + $ref: '#/components/schemas/DbServer' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + DbServer: + id: DbServer + description: >- + Details of the database server resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/ + type: object + properties: + name: + description: >- + Identifier. The name of the database server resource with the + format: + projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} + type: string + displayName: + description: Optional. User friendly name for this resource. + type: string + properties: + description: Optional. Various properties of the database server. + $ref: '#/components/schemas/DbServerProperties' + DbServerProperties: + id: DbServerProperties + description: Various properties and settings associated with Exadata database server. + type: object + properties: + ocid: + description: Output only. OCID of database server. + readOnly: true + type: string + ocpuCount: + description: Optional. OCPU count per database. + type: integer + format: int32 + maxOcpuCount: + description: Optional. Maximum OCPU count per database. + type: integer + format: int32 + memorySizeGb: + description: Optional. Memory allocated in GBs. + type: integer + format: int32 + maxMemorySizeGb: + description: Optional. Maximum memory allocated in GBs. + type: integer + format: int32 + dbNodeStorageSizeGb: + description: Optional. Local storage per VM. + type: integer + format: int32 + maxDbNodeStorageSizeGb: + description: Optional. Maximum local storage per VM. + type: integer + format: int32 + vmCount: + description: Optional. Vm count per database. + type: integer + format: int32 + state: + description: Output only. State of the database server. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Indicates that the resource is in Creating state. + - Indicates that the resource is in Available state. + - Indicates that the resource is in Unavailable state. + - Indicates that the resource is in Deleting state. + - Indicates that the resource is in Deleted state. + enum: + - STATE_UNSPECIFIED + - CREATING + - AVAILABLE + - UNAVAILABLE + - DELETING + - DELETED + dbNodeIds: + description: >- + Output only. OCID of database nodes associated with the database + server. + readOnly: true + type: array + items: + type: string + ListDbNodesResponse: + id: ListDbNodesResponse + description: The response for `DbNode.List`. + type: object + properties: + dbNodes: + description: The list of DB Nodes + type: array + items: + $ref: '#/components/schemas/DbNode' + nextPageToken: + description: A token identifying a page of results the node should return. + type: string + DbNode: + id: DbNode + description: >- + Details of the database node resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/ + type: object + properties: + name: + description: >- + Identifier. The name of the database node resource in the following + format: + projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node} + type: string + properties: + description: Optional. Various properties of the database node. + $ref: '#/components/schemas/DbNodeProperties' + DbNodeProperties: + id: DbNodeProperties + description: Various properties and settings associated with Db node. + type: object + properties: + ocid: + description: Output only. OCID of database node. + readOnly: true + type: string + ocpuCount: + description: Optional. OCPU count per database node. + type: integer + format: int32 + memorySizeGb: + description: Memory allocated in GBs. + type: integer + format: int32 + dbNodeStorageSizeGb: + description: Optional. Local storage per database node. + type: integer + format: int32 + dbServerOcid: + description: Optional. Database server OCID. + type: string + hostname: + description: Optional. DNS + type: string + state: + description: Output only. State of the database node. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Indicates that the resource is in Provisioning state. + - Indicates that the resource is in Available state. + - Indicates that the resource is in Updating state. + - Indicates that the resource is in Stopping state. + - Indicates that the resource is in Stopped state. + - Indicates that the resource is in Starting state. + - Indicates that the resource is in Terminating state. + - Indicates that the resource is in Terminated state. + - Indicates that the resource is in Failed state. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - AVAILABLE + - UPDATING + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - FAILED + totalCpuCoreCount: + description: Total CPU core count of the database node. + type: integer + format: int32 + ListGiVersionsResponse: + id: ListGiVersionsResponse + description: The response for `GiVersion.List`. + type: object + properties: + giVersions: + description: The list of Oracle Grid Infrastructure (GI) versions. + type: array + items: + $ref: '#/components/schemas/GiVersion' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + GiVersion: + id: GiVersion + description: >- + Details of the Oracle Grid Infrastructure (GI) version resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/ + type: object + properties: + name: + description: >- + Identifier. The name of the Oracle Grid Infrastructure (GI) version + resource with the format: + projects/{project}/locations/{region}/giVersions/{gi_versions} + type: string + version: + description: Optional. version + type: string + ListDbSystemShapesResponse: + id: ListDbSystemShapesResponse + description: The response for `DbSystemShape.List`. + type: object + properties: + dbSystemShapes: + description: The list of Database System shapes. + type: array + items: + $ref: '#/components/schemas/DbSystemShape' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + DbSystemShape: + id: DbSystemShape + description: >- + Details of the Database System Shapes resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/ + type: object + properties: + name: + description: >- + Identifier. The name of the Database System Shape resource with the + format: + projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape} + type: string + shape: + description: Optional. shape + type: string + minNodeCount: + description: Optional. Minimum number of database servers. + type: integer + format: int32 + maxNodeCount: + description: Optional. Maximum number of database servers. + type: integer + format: int32 + minStorageCount: + description: Optional. Minimum number of storage servers. + type: integer + format: int32 + maxStorageCount: + description: Optional. Maximum number of storage servers. + type: integer + format: int32 + availableCoreCountPerNode: + description: Optional. Number of cores per node. + type: integer + format: int32 + availableMemoryPerNodeGb: + description: Optional. Memory per database server node in gigabytes. + type: integer + format: int32 + availableDataStorageTb: + description: Optional. Storage per storage server in terabytes. + type: integer + format: int32 + minCoreCountPerNode: + description: Optional. Minimum core count per node. + type: integer + format: int32 + minMemoryPerNodeGb: + description: Optional. Minimum memory per node in gigabytes. + type: integer + format: int32 + minDbNodeStoragePerNodeGb: + description: Optional. Minimum node storage per database server in gigabytes. + type: integer + format: int32 + ListAutonomousDatabasesResponse: + id: ListAutonomousDatabasesResponse + description: The response for `AutonomousDatabase.List`. + type: object + properties: + autonomousDatabases: + description: The list of Autonomous Databases. + type: array + items: + $ref: '#/components/schemas/AutonomousDatabase' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + AutonomousDatabase: + id: AutonomousDatabase + description: >- + Details of the Autonomous Database resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ + type: object + properties: + name: + description: >- + Identifier. The name of the Autonomous Database resource in the + following format: + projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} + type: string + database: + description: >- + Optional. The name of the Autonomous Database. The database name + must be unique in the project. The name must begin with a letter and + can contain a maximum of 30 alphanumeric characters. + type: string + displayName: + description: >- + Optional. The display name for the Autonomous Database. The name + does not have to be unique within your project. + type: string + entitlementId: + description: >- + Output only. The ID of the subscription entitlement associated with + the Autonomous Database. + readOnly: true + type: string + adminPassword: + description: Optional. The password for the default ADMIN user. + type: string + properties: + description: Optional. The properties of the Autonomous Database. + $ref: '#/components/schemas/AutonomousDatabaseProperties' + labels: + description: >- + Optional. The labels or tags associated with the Autonomous + Database. + type: object + additionalProperties: + type: string + network: + description: >- + Required. The name of the VPC network used by the Autonomous + Database. Format: projects/{project}/global/networks/{network} + type: string + cidr: + description: Required. The subnet CIDR range for the Autonmous Database. + type: string + createTime: + description: >- + Output only. The date and time that the Autonomous Database was + created. + readOnly: true + type: string + format: google-datetime + AutonomousDatabaseProperties: + id: AutonomousDatabaseProperties + description: The properties of an Autonomous Database. + type: object + properties: + ocid: + description: >- + Output only. OCID of the Autonomous Database. + https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + readOnly: true + type: string + computeCount: + description: Optional. The number of compute servers for the Autonomous Database. + type: number + format: float + cpuCoreCount: + description: >- + Optional. The number of CPU cores to be made available to the + database. + type: integer + format: int32 + dataStorageSizeTb: + description: Optional. The size of the data stored in the database, in terabytes. + type: integer + format: int32 + dataStorageSizeGb: + description: Optional. The size of the data stored in the database, in gigabytes. + type: integer + format: int32 + dbWorkload: + description: Required. The workload type of the Autonomous Database. + type: string + enumDescriptions: + - Default unspecified value. + - Autonomous Transaction Processing database. + - Autonomous Data Warehouse database. + - Autonomous JSON Database. + - >- + Autonomous Database with the Oracle APEX Application Development + workload type. + enum: + - DB_WORKLOAD_UNSPECIFIED + - OLTP + - DW + - AJD + - APEX + dbEdition: + description: Optional. The edition of the Autonomous Databases. + type: string + enumDescriptions: + - Default unspecified value. + - Standard Database Edition + - Enterprise Database Edition + enum: + - DATABASE_EDITION_UNSPECIFIED + - STANDARD_EDITION + - ENTERPRISE_EDITION + characterSet: + description: >- + Optional. The character set for the Autonomous Database. The default + is AL32UTF8. + type: string + nCharacterSet: + description: >- + Optional. The national character set for the Autonomous Database. + The default is AL16UTF16. + type: string + privateEndpointIp: + description: >- + Optional. The private endpoint IP address for the Autonomous + Database. + type: string + privateEndpointLabel: + description: Optional. The private endpoint label for the Autonomous Database. + type: string + dbVersion: + description: Optional. The Oracle Database version for the Autonomous Database. + type: string + isAutoScalingEnabled: + description: >- + Optional. This field indicates if auto scaling is enabled for the + Autonomous Database CPU core count. + type: boolean + isStorageAutoScalingEnabled: + description: >- + Optional. This field indicates if auto scaling is enabled for the + Autonomous Database storage. + type: boolean + licenseType: + description: Required. The license type used for the Autonomous Database. + type: string + enumDescriptions: + - Unspecified + - License included part of offer + - Bring your own license + enum: + - LICENSE_TYPE_UNSPECIFIED + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + customerContacts: + description: Optional. The list of customer contacts. + type: array + items: + $ref: '#/components/schemas/CustomerContact' + secretId: + description: Optional. The ID of the Oracle Cloud Infrastructure vault secret. + type: string + vaultId: + description: Optional. The ID of the Oracle Cloud Infrastructure vault. + type: string + maintenanceScheduleType: + description: Optional. The maintenance schedule of the Autonomous Database. + type: string + enumDescriptions: + - Default unspecified value. + - >- + An EARLY maintenance schedule patches the database before the the + regular scheduled maintenance. + - >- + A REGULAR maintenance schedule follows the normal maintenance + cycle. + enum: + - MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED + - EARLY + - REGULAR + mtlsConnectionRequired: + description: >- + Optional. This field specifies if the Autonomous Database requires + mTLS connections. + type: boolean + backupRetentionPeriodDays: + description: >- + Optional. The retention period for the Autonomous Database. This + field is specified in days, can range from 1 day to 60 days, and has + a default value of 60 days. + type: integer + format: int32 + actualUsedDataStorageSizeTb: + description: >- + Output only. The amount of storage currently being used for user and + system data, in terabytes. + readOnly: true + type: number + format: double + allocatedStorageSizeTb: + description: >- + Output only. The amount of storage currently allocated for the + database tables and billed for, rounded up in terabytes. + readOnly: true + type: number + format: double + apexDetails: + description: >- + Output only. The details for the Oracle APEX Application + Development. + readOnly: true + $ref: '#/components/schemas/AutonomousDatabaseApex' + arePrimaryAllowlistedIpsUsed: + description: >- + Output only. This field indicates the status of Data Guard and + Access control for the Autonomous Database. The field's value is + null if Data Guard is disabled or Access Control is disabled. The + field's value is TRUE if both Data Guard and Access Control are + enabled, and the Autonomous Database is using primary IP access + control list (ACL) for standby. The field's value is FALSE if both + Data Guard and Access Control are enabled, and the Autonomous + Database is using a different IP access control list (ACL) for + standby compared to primary. + readOnly: true + type: boolean + lifecycleDetails: + description: >- + Output only. The details of the current lifestyle state of the + Autonomous Database. + readOnly: true + type: string + state: + description: Output only. The current lifecycle state of the Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Indicates that the Autonomous Database is in Provisioning state. + - Indicates that the Autonomous Database is in Available state. + - Indicates that the Autonomous Database is in Stopping state. + - Indicates that the Autonomous Database is in Stopped state. + - Indicates that the Autonomous Database is in Starting state. + - Indicates that the Autonomous Database is in Terminating state. + - Indicates that the Autonomous Database is in Terminated state. + - Indicates that the Autonomous Database is in Unavailable state. + - Indicates that the Autonomous Database Restore is in progress. + - Indicates that the Autonomous Database failed to restore. + - Indicates that the Autonomous Database backup is in progress. + - Indicates that the Autonomous Database scale is in progress. + - >- + Indicates that the Autonomous Database is in Available Needs + Attention state. + - Indicates that the Autonomous Database is in Updating state. + - >- + Indicates that the Autonomous Database is in Maintenance In + Progress state. + - Indicates that the Autonomous Database is in Restarting state. + - Indicates that the Autonomous Database is in Recreating state. + - >- + Indicates that the Autonomous Database is in Role Change In + Progress state. + - Indicates that the Autonomous Database is in Upgrading state. + - Indicates that the Autonomous Database is in Inaccessible state. + - Indicates that the Autonomous Database is in Standby state. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - AVAILABLE + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - UNAVAILABLE + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - SCALE_IN_PROGRESS + - AVAILABLE_NEEDS_ATTENTION + - UPDATING + - MAINTENANCE_IN_PROGRESS + - RESTARTING + - RECREATING + - ROLE_CHANGE_IN_PROGRESS + - UPGRADING + - INACCESSIBLE + - STANDBY + autonomousContainerDatabaseId: + description: Output only. The Autonomous Container Database OCID. + readOnly: true + type: string + availableUpgradeVersions: + description: >- + Output only. The list of available Oracle Database upgrade versions + for an Autonomous Database. + readOnly: true + type: array + items: + type: string + connectionStrings: + description: >- + Output only. The connection strings used to connect to an Autonomous + Database. + readOnly: true + $ref: '#/components/schemas/AutonomousDatabaseConnectionStrings' + connectionUrls: + description: Output only. The Oracle Connection URLs for an Autonomous Database. + readOnly: true + $ref: '#/components/schemas/AutonomousDatabaseConnectionUrls' + failedDataRecoveryDuration: + description: >- + Output only. This field indicates the number of seconds of data loss + during a Data Guard failover. + readOnly: true + type: string + format: google-duration + memoryTableGbs: + description: >- + Output only. The memory assigned to in-memory tables in an + Autonomous Database. + readOnly: true + type: integer + format: int32 + isLocalDataGuardEnabled: + description: >- + Output only. This field indicates whether the Autonomous Database + has local (in-region) Data Guard enabled. + readOnly: true + type: boolean + localAdgAutoFailoverMaxDataLossLimit: + description: >- + Output only. This field indicates the maximum data loss limit for an + Autonomous Database, in seconds. + readOnly: true + type: integer + format: int32 + localStandbyDb: + description: >- + Output only. The details of the Autonomous Data Guard standby + database. + readOnly: true + $ref: '#/components/schemas/AutonomousDatabaseStandbySummary' + memoryPerOracleComputeUnitGbs: + description: Output only. The amount of memory enabled per ECPU, in gigabytes. + readOnly: true + type: integer + format: int32 + localDisasterRecoveryType: + description: >- + Output only. This field indicates the local disaster recovery (DR) + type of an Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Autonomous Data Guard recovery. + - Backup based recovery. + enum: + - LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED + - ADG + - BACKUP_BASED + dataSafeState: + description: >- + Output only. The current state of the Data Safe registration for the + Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Registering data safe state. + - Registered data safe state. + - Deregistering data safe state. + - Not registered data safe state. + - Failed data safe state. + enum: + - DATA_SAFE_STATE_UNSPECIFIED + - REGISTERING + - REGISTERED + - DEREGISTERING + - NOT_REGISTERED + - FAILED + databaseManagementState: + description: >- + Output only. The current state of database management for the + Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Enabling Database Management state + - Enabled Database Management state + - Disabling Database Management state + - Not Enabled Database Management state + - Failed enabling Database Management state + - Failed disabling Database Management state + enum: + - DATABASE_MANAGEMENT_STATE_UNSPECIFIED + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + openMode: + description: >- + Output only. This field indicates the current mode of the Autonomous + Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Read Only Mode + - Read Write Mode + enum: + - OPEN_MODE_UNSPECIFIED + - READ_ONLY + - READ_WRITE + operationsInsightsState: + description: >- + Output only. This field indicates the state of Operations Insights + for the Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Enabling status for operation insights. + - Enabled status for operation insights. + - Disabling status for operation insights. + - Not Enabled status for operation insights. + - Failed enabling status for operation insights. + - Failed disabling status for operation insights. + enum: + - OPERATIONS_INSIGHTS_STATE_UNSPECIFIED + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + peerDbIds: + description: >- + Output only. The list of OCIDs of standby databases located in + Autonomous Data Guard remote regions that are associated with the + source database. + readOnly: true + type: array + items: + type: string + permissionLevel: + description: Output only. The permission level of the Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Restricted mode allows access only by admin users. + - Normal access. + enum: + - PERMISSION_LEVEL_UNSPECIFIED + - RESTRICTED + - UNRESTRICTED + privateEndpoint: + description: Output only. The private endpoint for the Autonomous Database. + readOnly: true + type: string + refreshableMode: + description: Output only. The refresh mode of the cloned Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - The default unspecified value. + - >- + AUTOMATIC indicates that the cloned database is automatically + refreshed with data from the source Autonomous Database. + - >- + MANUAL indicates that the cloned database is manually refreshed + with data from the source Autonomous Database. + enum: + - REFRESHABLE_MODE_UNSPECIFIED + - AUTOMATIC + - MANUAL + refreshableState: + description: Output only. The refresh State of the clone. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Refreshing + - Not refreshed + enum: + - REFRESHABLE_STATE_UNSPECIFIED + - REFRESHING + - NOT_REFRESHING + role: + description: Output only. The Data Guard role of the Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Primary role + - Standby role + - Disabled standby role + - Backup copy role + - Snapshot standby role + enum: + - ROLE_UNSPECIFIED + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + scheduledOperationDetails: + description: >- + Output only. The list and details of the scheduled operations of the + Autonomous Database. + readOnly: true + type: array + items: + $ref: '#/components/schemas/ScheduledOperationDetails' + sqlWebDeveloperUrl: + description: Output only. The SQL Web Developer URL for the Autonomous Database. + readOnly: true + type: string + supportedCloneRegions: + description: >- + Output only. The list of available regions that can be used to + create a clone for the Autonomous Database. + readOnly: true + type: array + items: + type: string + usedDataStorageSizeTbs: + description: >- + Output only. The storage space used by Autonomous Database, in + gigabytes. + readOnly: true + type: integer + format: int32 + ociUrl: + description: >- + Output only. The Oracle Cloud Infrastructure link for the Autonomous + Database. + readOnly: true + type: string + totalAutoBackupStorageSizeGbs: + description: >- + Output only. The storage space used by automatic backups of + Autonomous Database, in gigabytes. + readOnly: true + type: number + format: float + nextLongTermBackupTime: + description: >- + Output only. The long term backup schedule of the Autonomous + Database. + readOnly: true + type: string + format: google-datetime + maintenanceBeginTime: + description: Output only. The date and time when maintenance will begin. + readOnly: true + type: string + format: google-datetime + maintenanceEndTime: + description: Output only. The date and time when maintenance will end. + readOnly: true + type: string + format: google-datetime + AutonomousDatabaseApex: + id: AutonomousDatabaseApex + description: >- + Oracle APEX Application Development. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex + type: object + properties: + apexVersion: + description: Output only. The Oracle APEX Application Development version. + readOnly: true + type: string + ordsVersion: + description: Output only. The Oracle REST Data Services (ORDS) version. + readOnly: true + type: string + AutonomousDatabaseConnectionStrings: + id: AutonomousDatabaseConnectionStrings + description: >- + The connection string used to connect to the Autonomous Database. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings + type: object + properties: + allConnectionStrings: + description: >- + Output only. Returns all connection strings that can be used to + connect to the Autonomous Database. + readOnly: true + $ref: '#/components/schemas/AllConnectionStrings' + dedicated: + description: >- + Output only. The database service provides the least level of + resources to each SQL statement, but supports the most number of + concurrent SQL statements. + readOnly: true + type: string + high: + description: >- + Output only. The database service provides the highest level of + resources to each SQL statement. + readOnly: true + type: string + low: + description: >- + Output only. The database service provides the least level of + resources to each SQL statement. + readOnly: true + type: string + medium: + description: >- + Output only. The database service provides a lower level of + resources to each SQL statement. + readOnly: true + type: string + profiles: + description: >- + Output only. A list of connection string profiles to allow clients + to group, filter, and select values based on the structured + metadata. + readOnly: true + type: array + items: + $ref: '#/components/schemas/DatabaseConnectionStringProfile' + AllConnectionStrings: + id: AllConnectionStrings + description: >- + A list of all connection strings that can be used to connect to the + Autonomous Database. + type: object + properties: + high: + description: >- + Output only. The database service provides the highest level of + resources to each SQL statement. + readOnly: true + type: string + low: + description: >- + Output only. The database service provides the least level of + resources to each SQL statement. + readOnly: true + type: string + medium: + description: >- + Output only. The database service provides a lower level of + resources to each SQL statement. + readOnly: true + type: string + DatabaseConnectionStringProfile: + id: DatabaseConnectionStringProfile + description: >- + The connection string profile to allow clients to group. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile + type: object + properties: + consumerGroup: + description: >- + Output only. The current consumer group being used by the + connection. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - High consumer group. + - Medium consumer group. + - Low consumer group. + - TP consumer group. + - TPURGENT consumer group. + enum: + - CONSUMER_GROUP_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + - TP + - TPURGENT + displayName: + description: Output only. The display name for the database connection. + readOnly: true + type: string + hostFormat: + description: >- + Output only. The host name format being currently used in connection + string. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - FQDN + - IP + enum: + - HOST_FORMAT_UNSPECIFIED + - FQDN + - IP + isRegional: + description: >- + Output only. This field indicates if the connection string is + regional and is only applicable for cross-region Data Guard. + readOnly: true + type: boolean + protocol: + description: Output only. The protocol being used by the connection. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Tcp + - Tcps + enum: + - PROTOCOL_UNSPECIFIED + - TCP + - TCPS + sessionMode: + description: Output only. The current session mode of the connection. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Direct + - Indirect + enum: + - SESSION_MODE_UNSPECIFIED + - DIRECT + - INDIRECT + syntaxFormat: + description: Output only. The syntax of the connection string. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Long + - Ezconnect + - Ezconnectplus + enum: + - SYNTAX_FORMAT_UNSPECIFIED + - LONG + - EZCONNECT + - EZCONNECTPLUS + tlsAuthentication: + description: >- + Output only. This field indicates the TLS authentication type of the + connection. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Server + - Mutual + enum: + - TLS_AUTHENTICATION_UNSPECIFIED + - SERVER + - MUTUAL + value: + description: Output only. The value of the connection string. + readOnly: true + type: string + AutonomousDatabaseConnectionUrls: + id: AutonomousDatabaseConnectionUrls + description: >- + The URLs for accessing Oracle Application Express (APEX) and SQL + Developer Web with a browser from a Compute instance. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls + type: object + properties: + apexUri: + description: Output only. Oracle Application Express (APEX) URL. + readOnly: true + type: string + databaseTransformsUri: + description: >- + Output only. The URL of the Database Transforms for the Autonomous + Database. + readOnly: true + type: string + graphStudioUri: + description: >- + Output only. The URL of the Graph Studio for the Autonomous + Database. + readOnly: true + type: string + machineLearningNotebookUri: + description: >- + Output only. The URL of the Oracle Machine Learning (OML) Notebook + for the Autonomous Database. + readOnly: true + type: string + machineLearningUserManagementUri: + description: >- + Output only. The URL of Machine Learning user management the + Autonomous Database. + readOnly: true + type: string + mongoDbUri: + description: Output only. The URL of the MongoDB API for the Autonomous Database. + readOnly: true + type: string + ordsUri: + description: >- + Output only. The Oracle REST Data Services (ORDS) URL of the Web + Access for the Autonomous Database. + readOnly: true + type: string + sqlDevWebUri: + description: >- + Output only. The URL of the Oracle SQL Developer Web for the + Autonomous Database. + readOnly: true + type: string + AutonomousDatabaseStandbySummary: + id: AutonomousDatabaseStandbySummary + description: >- + Autonomous Data Guard standby database details. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary + type: object + properties: + lagTimeDuration: + description: >- + Output only. The amount of time, in seconds, that the data of the + standby database lags in comparison to the data of the primary + database. + readOnly: true + type: string + format: google-duration + lifecycleDetails: + description: >- + Output only. The additional details about the current lifecycle + state of the Autonomous Database. + readOnly: true + type: string + state: + description: Output only. The current lifecycle state of the Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Indicates that the Autonomous Database is in Provisioning state. + - Indicates that the Autonomous Database is in Available state. + - Indicates that the Autonomous Database is in Stopping state. + - Indicates that the Autonomous Database is in Stopped state. + - Indicates that the Autonomous Database is in Starting state. + - Indicates that the Autonomous Database is in Terminating state. + - Indicates that the Autonomous Database is in Terminated state. + - Indicates that the Autonomous Database is in Unavailable state. + - Indicates that the Autonomous Database Restore is in progress. + - Indicates that the Autonomous Database failed to restore. + - Indicates that the Autonomous Database backup is in progress. + - Indicates that the Autonomous Database scale is in progress. + - >- + Indicates that the Autonomous Database is in Available Needs + Attention state. + - Indicates that the Autonomous Database is in Updating state. + - >- + Indicates that the Autonomous Database is in Maintenance In + Progress state. + - Indicates that the Autonomous Database is in Restarting state. + - Indicates that the Autonomous Database is in Recreating state. + - >- + Indicates that the Autonomous Database is in Role Change In + Progress state. + - Indicates that the Autonomous Database is in Upgrading state. + - Indicates that the Autonomous Database is in Inaccessible state. + - Indicates that the Autonomous Database is in Standby state. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - AVAILABLE + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - UNAVAILABLE + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - SCALE_IN_PROGRESS + - AVAILABLE_NEEDS_ATTENTION + - UPDATING + - MAINTENANCE_IN_PROGRESS + - RESTARTING + - RECREATING + - ROLE_CHANGE_IN_PROGRESS + - UPGRADING + - INACCESSIBLE + - STANDBY + dataGuardRoleChangedTime: + description: >- + Output only. The date and time the Autonomous Data Guard role was + switched for the standby Autonomous Database. + readOnly: true + type: string + format: google-datetime + disasterRecoveryRoleChangedTime: + description: >- + Output only. The date and time the Disaster Recovery role was + switched for the standby Autonomous Database. + readOnly: true + type: string + format: google-datetime + ScheduledOperationDetails: + id: ScheduledOperationDetails + description: >- + Details of scheduled operation. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails + type: object + properties: + dayOfWeek: + description: Output only. Day of week. + readOnly: true + type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + startTime: + description: Output only. Auto start time. + readOnly: true + $ref: '#/components/schemas/TimeOfDay' + stopTime: + description: Output only. Auto stop time. + readOnly: true + $ref: '#/components/schemas/TimeOfDay' + TimeOfDay: + id: TimeOfDay + description: >- + Represents a time of day. The date and time zone are either not + significant or are specified elsewhere. An API may choose to allow leap + seconds. Related types are google.type.Date and + `google.protobuf.Timestamp`. + type: object + properties: + hours: + description: >- + Hours of day in 24 hour format. Should be from 0 to 23. An API may + choose to allow the value "24:00:00" for scenarios like business + closing time. + type: integer + format: int32 + minutes: + description: Minutes of hour of day. Must be from 0 to 59. + type: integer + format: int32 + seconds: + description: >- + Seconds of minutes of the time. Must normally be from 0 to 59. An + API may allow the value 60 if it allows leap-seconds. + type: integer + format: int32 + nanos: + description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + type: integer + format: int32 + RestoreAutonomousDatabaseRequest: + id: RestoreAutonomousDatabaseRequest + description: The request for `AutonomousDatabase.Restore`. + type: object + properties: + restoreTime: + description: Required. The time and date to restore the database to. + type: string + format: google-datetime + GenerateAutonomousDatabaseWalletRequest: + id: GenerateAutonomousDatabaseWalletRequest + description: The request for `AutonomousDatabase.GenerateWallet`. + type: object + properties: + type: + description: >- + Optional. The type of wallet generation for the Autonomous Database. + The default value is SINGLE. + type: string + enumDescriptions: + - Default unspecified value. + - Used to generate wallet for all databases in the region. + - Used to generate wallet for a single database. + enum: + - GENERATE_TYPE_UNSPECIFIED + - ALL + - SINGLE + isRegional: + description: >- + Optional. True when requesting regional connection strings in PDB + connect info, applicable to cross-region Data Guard only. + type: boolean + password: + description: >- + Required. The password used to encrypt the keys inside the wallet. + The password must be a minimum of 8 characters. + type: string + GenerateAutonomousDatabaseWalletResponse: + id: GenerateAutonomousDatabaseWalletResponse + description: The response for `AutonomousDatabase.GenerateWallet`. + type: object + properties: + archiveContent: + description: Output only. The base64 encoded wallet files. + readOnly: true + type: string + format: byte + ListAutonomousDbVersionsResponse: + id: ListAutonomousDbVersionsResponse + description: The response for `AutonomousDbVersion.List`. + type: object + properties: + autonomousDbVersions: + description: The list of Autonomous Database versions. + type: array + items: + $ref: '#/components/schemas/AutonomousDbVersion' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + AutonomousDbVersion: + id: AutonomousDbVersion + description: >- + Details of the Autonomous Database version. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/ + type: object + properties: + name: + description: >- + Identifier. The name of the Autonomous Database Version resource + with the format: + projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version} + type: string + version: + description: Output only. An Oracle Database version for Autonomous Database. + readOnly: true + type: string + dbWorkload: + description: Output only. The Autonomous Database workload type. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Autonomous Transaction Processing database. + - Autonomous Data Warehouse database. + - Autonomous JSON Database. + - >- + Autonomous Database with the Oracle APEX Application Development + workload type. + enum: + - DB_WORKLOAD_UNSPECIFIED + - OLTP + - DW + - AJD + - APEX + workloadUri: + description: >- + Output only. A URL that points to a detailed description of the + Autonomous Database version. + readOnly: true + type: string + ListAutonomousDatabaseCharacterSetsResponse: + id: ListAutonomousDatabaseCharacterSetsResponse + description: The response for `AutonomousDatabaseCharacterSet.List`. + type: object + properties: + autonomousDatabaseCharacterSets: + description: The list of Autonomous Database Character Sets. + type: array + items: + $ref: '#/components/schemas/AutonomousDatabaseCharacterSet' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + AutonomousDatabaseCharacterSet: + id: AutonomousDatabaseCharacterSet + description: >- + Details of the Autonomous Database character set resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ + type: object + properties: + name: + description: >- + Identifier. The name of the Autonomous Database Character Set + resource in the following format: + projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set} + type: string + characterSetType: + description: Output only. The character set type for the Autonomous Database. + readOnly: true + type: string + enumDescriptions: + - Character set type is not specified. + - Character set type is set to database. + - Character set type is set to national. + enum: + - CHARACTER_SET_TYPE_UNSPECIFIED + - DATABASE + - NATIONAL + characterSet: + description: >- + Output only. The character set name for the Autonomous Database + which is the ID in the resource name. + readOnly: true + type: string + ListAutonomousDatabaseBackupsResponse: + id: ListAutonomousDatabaseBackupsResponse + description: The response for `AutonomousDatabaseBackup.List`. + type: object + properties: + autonomousDatabaseBackups: + description: The list of Autonomous Database Backups. + type: array + items: + $ref: '#/components/schemas/AutonomousDatabaseBackup' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + AutonomousDatabaseBackup: + id: AutonomousDatabaseBackup + description: >- + Details of the Autonomous Database Backup resource. + https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/ + type: object + properties: + name: + description: >- + Identifier. The name of the Autonomous Database Backup resource with + the format: + projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup} + type: string + autonomousDatabase: + description: >- + Required. The name of the Autonomous Database resource for which the + backup is being created. Format: + projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} + type: string + displayName: + description: >- + Optional. User friendly name for the Backup. The name does not have + to be unique. + type: string + properties: + description: Optional. Various properties of the backup. + $ref: '#/components/schemas/AutonomousDatabaseBackupProperties' + labels: + description: Optional. labels or tags associated with the resource. + type: object + additionalProperties: + type: string + AutonomousDatabaseBackupProperties: + id: AutonomousDatabaseBackupProperties + description: Properties of the Autonomous Database Backup resource. + type: object + properties: + ocid: + description: >- + Output only. OCID of the Autonomous Database backup. + https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + readOnly: true + type: string + retentionPeriodDays: + description: Optional. Retention period in days for the backup. + type: integer + format: int32 + compartmentId: + description: Output only. The OCID of the compartment. + readOnly: true + type: string + databaseSizeTb: + description: Output only. The quantity of data in the database, in terabytes. + readOnly: true + type: number + format: float + dbVersion: + description: >- + Output only. A valid Oracle Database version for Autonomous + Database. + readOnly: true + type: string + isLongTermBackup: + description: Output only. Indicates if the backup is long term backup. + readOnly: true + type: boolean + isAutomaticBackup: + description: Output only. Indicates if the backup is automatic or user initiated. + readOnly: true + type: boolean + isRestorable: + description: >- + Output only. Indicates if the backup can be used to restore the + Autonomous Database. + readOnly: true + type: boolean + keyStoreId: + description: Optional. The OCID of the key store of Oracle Vault. + type: string + keyStoreWallet: + description: Optional. The wallet name for Oracle Key Vault. + type: string + kmsKeyId: + description: >- + Optional. The OCID of the key container that is used as the master + encryption key in database transparent data encryption (TDE) + operations. + type: string + kmsKeyVersionId: + description: >- + Optional. The OCID of the key container version that is used in + database transparent data encryption (TDE) operations KMS Key can + have multiple key versions. If none is specified, the current key + version (latest) of the Key Id is used for the operation. Autonomous + Database Serverless does not use key versions, hence is not + applicable for Autonomous Database Serverless instances. + type: string + lifecycleDetails: + description: >- + Output only. Additional information about the current lifecycle + state. + readOnly: true + type: string + lifecycleState: + description: Output only. The lifecycle state of the backup. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Indicates that the resource is in Creating state. + - Indicates that the resource is in Active state. + - Indicates that the resource is in Deleting state. + - Indicates that the resource is in Deleted state. + - Indicates that the resource is in Failed state. + - Indicates that the resource is in Updating state. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + sizeTb: + description: Output only. The backup size in terabytes. + readOnly: true + type: number + format: float + availableTillTime: + description: Output only. Timestamp until when the backup will be available. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The date and time the backup completed. + readOnly: true + type: string + format: google-datetime + startTime: + description: Output only. The date and time the backup started. + readOnly: true + type: string + format: google-datetime + type: + description: Output only. The type of the backup. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Incremental backups. + - Full backups. + - Long term backups. + enum: + - TYPE_UNSPECIFIED + - INCREMENTAL + - FULL + - LONG_TERM + vaultId: + description: Optional. The OCID of the vault. + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. The status of the operation. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + percentComplete: + description: >- + Output only. An estimated percentage of the operation that has been + completed at a given moment of time, between 0 and 100. + readOnly: true + type: number + format: double + LocationMetadata: + id: LocationMetadata + description: Metadata for a given Location. + type: object + properties: + gcpOracleZones: + description: Output only. GCP Oracle zones in a location. + readOnly: true + type: array + items: + type: string + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + 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. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.oracledatabase.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.oracledatabase.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + cloud_exadata_infrastructures: + id: google.oracledatabase.cloud_exadata_infrastructures + name: cloud_exadata_infrastructures + title: Cloud_exadata_infrastructures + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudExadataInfrastructures/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloudExadataInfrastructures + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudExadataInfrastructures/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudExadataInfrastructures~1{cloudExadataInfrastructuresId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudExadataInfrastructures~1{cloudExadataInfrastructuresId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/get + - $ref: >- + #/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/delete + db_servers: + id: google.oracledatabase.db_servers + name: db_servers + title: Db_servers + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudExadataInfrastructures~1{cloudExadataInfrastructuresId}~1dbServers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dbServers + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_servers/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + cloud_vm_clusters: + id: google.oracledatabase.cloud_vm_clusters + name: cloud_vm_clusters + title: Cloud_vm_clusters + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudVmClusters/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloudVmClusters + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudVmClusters/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudVmClusters~1{cloudVmClustersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudVmClusters~1{cloudVmClustersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/delete' + db_nodes: + id: google.oracledatabase.db_nodes + name: db_nodes + title: Db_nodes + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudVmClusters~1{cloudVmClustersId}~1dbNodes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dbNodes + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_nodes/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + entitlements: + id: google.oracledatabase.entitlements + name: entitlements + title: Entitlements + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entitlements/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.entitlements + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + gi_versions: + id: google.oracledatabase.gi_versions + name: gi_versions + title: Gi_versions + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1giVersions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.giVersions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gi_versions/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + db_system_shapes: + id: google.oracledatabase.db_system_shapes + name: db_system_shapes + title: Db_system_shapes + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dbSystemShapes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dbSystemShapes + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_shapes/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + autonomous_databases: + id: google.oracledatabase.autonomous_databases + name: autonomous_databases + title: Autonomous_databases + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomousDatabases + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases~1{autonomousDatabasesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases~1{autonomousDatabasesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + restore: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases~1{autonomousDatabasesId}:restore/post + response: + mediaType: application/json + openAPIDocKey: '200' + generate_wallet: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases~1{autonomousDatabasesId}:generateWallet/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_databases/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_databases/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/autonomous_databases/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/autonomous_databases/methods/delete + autonomous_db_versions: + id: google.oracledatabase.autonomous_db_versions + name: autonomous_db_versions + title: Autonomous_db_versions + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDbVersions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomousDbVersions + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/autonomous_db_versions/methods/list + insert: [] + update: [] + replace: [] + delete: [] + autonomous_database_character_sets: + id: google.oracledatabase.autonomous_database_character_sets + name: autonomous_database_character_sets + title: Autonomous_database_character_sets + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabaseCharacterSets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomousDatabaseCharacterSets + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/autonomous_database_character_sets/methods/list + insert: [] + update: [] + replace: [] + delete: [] + autonomous_database_backups: + id: google.oracledatabase.autonomous_database_backups + name: autonomous_database_backups + title: Autonomous_database_backups + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabaseBackups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomousDatabaseBackups + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/autonomous_database_backups/methods/list + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: oracledatabase.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: oracledatabase.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: oracledatabase.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: oracledatabase.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: oracledatabase.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: oracledatabase.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures: + parameters: *ref_1 + get: + description: Lists Exadata Infrastructures in a given project and location. + operationId: oracledatabase.projects.locations.cloudExadataInfrastructures.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListCloudExadataInfrastructuresResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a new Exadata Infrastructure in a given project and location. + operationId: oracledatabase.projects.locations.cloudExadataInfrastructures.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloudExadataInfrastructure' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: cloudExadataInfrastructureId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}: + parameters: *ref_1 + get: + description: Gets details of a single Exadata Infrastructure. + operationId: oracledatabase.projects.locations.cloudExadataInfrastructures.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CloudExadataInfrastructure' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: cloudExadataInfrastructuresId + required: true + schema: + type: string + delete: + description: Deletes a single Exadata Infrastructure. + operationId: oracledatabase.projects.locations.cloudExadataInfrastructures.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: cloudExadataInfrastructuresId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}/dbServers: + parameters: *ref_1 + get: + description: Lists the database servers of an Exadata Infrastructure instance. + operationId: >- + oracledatabase.projects.locations.cloudExadataInfrastructures.dbServers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListDbServersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: cloudExadataInfrastructuresId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters: + parameters: *ref_1 + get: + description: Lists the VM Clusters in a given project and location. + operationId: oracledatabase.projects.locations.cloudVmClusters.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListCloudVmClustersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + post: + description: Creates a new VM Cluster in a given project and location. + operationId: oracledatabase.projects.locations.cloudVmClusters.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloudVmCluster' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: cloudVmClusterId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}: + parameters: *ref_1 + get: + description: Gets details of a single VM Cluster. + operationId: oracledatabase.projects.locations.cloudVmClusters.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CloudVmCluster' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: cloudVmClustersId + required: true + schema: + type: string + delete: + description: Deletes a single VM Cluster. + operationId: oracledatabase.projects.locations.cloudVmClusters.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: cloudVmClustersId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}/dbNodes: + parameters: *ref_1 + get: + description: Lists the database nodes of a VM Cluster. + operationId: oracledatabase.projects.locations.cloudVmClusters.dbNodes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListDbNodesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: cloudVmClustersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entitlements: + parameters: *ref_1 + get: + description: Lists the entitlements in a given project. + operationId: oracledatabase.projects.locations.entitlements.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListEntitlementsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/giVersions: + parameters: *ref_1 + get: + description: >- + Lists all the valid Oracle Grid Infrastructure (GI) versions for the + given project and location. + operationId: oracledatabase.projects.locations.giVersions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListGiVersionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dbSystemShapes: + parameters: *ref_1 + get: + description: Lists the database system shapes available for the project and location. + operationId: oracledatabase.projects.locations.dbSystemShapes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListDbSystemShapesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases: + parameters: *ref_1 + get: + description: Lists the Autonomous Databases in a given project and location. + operationId: oracledatabase.projects.locations.autonomousDatabases.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAutonomousDatabasesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new Autonomous Database in a given project and location. + operationId: oracledatabase.projects.locations.autonomousDatabases.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: autonomousDatabaseId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}: + parameters: *ref_1 + get: + description: Gets the details of a single Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabases.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: autonomousDatabasesId + required: true + schema: + type: string + delete: + description: Deletes a single Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabases.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: autonomousDatabasesId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restore: + parameters: *ref_1 + post: + description: Restores a single Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabases.restore + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreAutonomousDatabaseRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: autonomousDatabasesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:generateWallet: + parameters: *ref_1 + post: + description: Generates a wallet for a single Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabases.generateWallet + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateAutonomousDatabaseWalletRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateAutonomousDatabaseWalletResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: autonomousDatabasesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDbVersions: + parameters: *ref_1 + get: + description: >- + Lists all the available Autonomous Database versions for a project and + location. + operationId: oracledatabase.projects.locations.autonomousDbVersions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAutonomousDbVersionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseCharacterSets: + parameters: *ref_1 + get: + description: >- + Lists Autonomous Database Character Sets in a given project and + location. + operationId: oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/ListAutonomousDatabaseCharacterSetsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseBackups: + parameters: *ref_1 + get: + description: Lists the long term and automatic backups of an Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabaseBackups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAutonomousDatabaseBackupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml index cbd8b886..1e070cc5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml @@ -9,8 +9,8 @@ info: The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy. version: v2 - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240913' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/orgpolicy/docs/reference/rest/index.html servers: @@ -36,6 +36,77 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + GoogleCloudOrgpolicyV2ConstraintListConstraint: + id: GoogleCloudOrgpolicyV2ConstraintListConstraint + properties: + supportsUnder: + type: boolean + description: >- + Indicates whether subtrees of the Resource Manager resource + hierarchy can be used in `Policy.allowed_values` and + `Policy.denied_values`. For example, `"under:folders/123"` would + match any resource under the 'folders/123' folder. + supportsIn: + description: >- + Indicates whether values grouped into categories can be used in + `Policy.allowed_values` and `Policy.denied_values`. For example, + `"in:Python"` would match any value in the 'Python' group. + type: boolean + description: >- + A constraint that allows or disallows a list of string values, which are + configured by an Organization Policy administrator with a policy. + type: object + GoogleCloudOrgpolicyV2AlternatePolicySpec: + description: >- + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run/darklaunch. + id: GoogleCloudOrgpolicyV2AlternatePolicySpec + type: object + properties: + spec: + description: Specify constraint for configurations of Google Cloud resources. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + launch: + description: >- + Reference to the launch that will be used while audit logging and to + control the launch. Should be set only in the alternate policy. + type: string + GoogleCloudOrgpolicyV2ListConstraintsResponse: + properties: + constraints: + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' + description: >- + The collection of constraints that are available on the targeted + resource. + type: array + nextPageToken: + description: >- + Page token used to retrieve the next page. This is currently not + used. + type: string + id: GoogleCloudOrgpolicyV2ListConstraintsResponse + type: object + description: The response returned from the ListConstraints method. + GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: + properties: + customConstraints: + type: array + description: >- + All custom constraints that exist on the organization resource. It + will be empty if no custom constraints are set. + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + nextPageToken: + type: string + description: >- + Page token used to retrieve the next page. This is currently not + used, but the server may at any point start supplying a valid token. + id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + type: object + description: >- + The response returned from the ListCustomConstraints method. It will be + empty if no custom constraints are set on the organization resource. GoogleTypeExpr: properties: location: @@ -43,22 +114,22 @@ components: description: >- Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - title: + expression: type: string description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. + Textual representation of an expression in Common Expression + Language syntax. description: type: string description: >- Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - expression: - type: string + title: description: >- - Textual representation of an expression in Common Expression - Language syntax. + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string description: >- Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of @@ -76,53 +147,33 @@ components: string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. - id: GoogleTypeExpr - type: object - GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: - id: GoogleCloudOrgpolicyV2ConstraintBooleanConstraint - description: >- - A constraint that is either enforced or not. For example, a constraint - `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM - instance, serial port connections will not be opened to that instance. - properties: {} - type: object - GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: - description: >- - The response returned from the ListCustomConstraints method. It will be - empty if no custom constraints are set on the organization resource. - id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse - properties: - nextPageToken: - type: string - description: >- - Page token used to retrieve the next page. This is currently not - used, but the server may at any point start supplying a valid token. - customConstraints: - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - description: >- - All custom constraints that exist on the organization resource. It - will be empty if no custom constraints are set. - type: array type: object + id: GoogleTypeExpr GoogleCloudOrgpolicyV2Policy: + type: object properties: dryRunSpec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' description: >- Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + alternate: + deprecated: true + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' + description: Deprecated. + spec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: Basic information about the Organization Policy. etag: + type: string description: >- Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This 'etag' is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - type: string name: - type: string description: >- Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the @@ -134,20 +185,51 @@ components: Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. - spec: - description: Basic information about the Organization Policy. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - alternate: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - deprecated: true - description: Deprecated. - type: object - id: GoogleCloudOrgpolicyV2Policy + type: string description: >- Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources. - GoogleCloudOrgpolicyV2PolicySpec: + id: GoogleCloudOrgpolicyV2Policy + GoogleCloudOrgpolicyV2ListPoliciesResponse: + description: >- + The response returned from the ListPolicies method. It will be empty if + no policies are set on the resource. + properties: + nextPageToken: + description: >- + Page token used to retrieve the next page. This is currently not + used, but the server may at any point start supplying a valid token. + type: string + policies: + description: >- + All policies that exist on the resource. It will be empty if no + policies are set. + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + type: array + type: object + id: GoogleCloudOrgpolicyV2ListPoliciesResponse + GoogleProtobufEmpty: + type: object + properties: {} + id: GoogleProtobufEmpty + 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); } + GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: type: object + description: >- + A constraint that is either enforced or not. For example, a constraint + `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM + instance, serial port connections will not be opened to that instance. + id: GoogleCloudOrgpolicyV2ConstraintBooleanConstraint + properties: {} + GoogleCloudOrgpolicyV2PolicySpec: + description: >- + Defines a Google Cloud policy specification which is used to specify + constraints for configurations of Google Cloud resources. properties: inheritFromParent: type: boolean @@ -158,7 +240,16 @@ components: effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints. + updateTime: + description: >- + Output only. The time stamp this was previously updated. This + represents the last time a call to `CreatePolicy` or `UpdatePolicy` + was made for that policy. + type: string + format: google-datetime + readOnly: true etag: + type: string description: >- An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a @@ -167,7 +258,6 @@ components: version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the `etag` will be unset. - type: string reset: description: >- Ignores policies set above this resource and restores the @@ -176,15 +266,8 @@ components: or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false. type: boolean - updateTime: - readOnly: true - description: >- - Output only. The time stamp this was previously updated. This - represents the last time a call to `CreatePolicy` or `UpdatePolicy` - was made for that policy. - format: google-datetime - type: string rules: + type: array description: >- In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition @@ -194,126 +277,63 @@ components: target resource take precedence. items: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' - type: array + type: object id: GoogleCloudOrgpolicyV2PolicySpec + GoogleCloudOrgpolicyV2Constraint: description: >- - Defines a Google Cloud policy specification which is used to specify - constraints for configurations of Google Cloud resources. - GoogleCloudOrgpolicyV2ConstraintListConstraint: + A constraint describes a way to restrict resource's configuration. For + example, you could enforce a constraint that controls which Google Cloud + services can be activated across an organization, or whether a Compute + Engine instance can have serial port connections established. + Constraints can be configured by the organization policy administrator + to fit the needs of the organization by setting a policy that includes + constraints at different locations in the organization's resource + hierarchy. Policies are inherited down the resource hierarchy from + higher levels, but can also be overridden. For details about the + inheritance rules please read about `policies`. Constraints have a + default behavior determined by the `constraint_default` field, which is + the enforcement behavior that is used in the absence of a policy being + defined or inherited for the resource in question. type: object properties: - supportsUnder: - type: boolean + booleanConstraint: + description: Defines this constraint as being a BooleanConstraint. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint + constraintDefault: + enumDescriptions: + - >- + This is only used for distinguishing unset values and should never + be used. + - >- + Indicate that all values are allowed for list constraints. + Indicate that enforcement is off for boolean constraints. + - >- + Indicate that all values are denied for list constraints. Indicate + that enforcement is on for boolean constraints. + enum: + - CONSTRAINT_DEFAULT_UNSPECIFIED + - ALLOW + - DENY + type: string description: >- - Indicates whether subtrees of the Resource Manager resource - hierarchy can be used in `Policy.allowed_values` and - `Policy.denied_values`. For example, `"under:folders/123"` would - match any resource under the 'folders/123' folder. - supportsIn: + The evaluation behavior of this constraint in the absence of a + policy. + listConstraint: + description: Defines this constraint as being a ListConstraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' + displayName: + type: string + description: The human readable name. Mutable. + description: + type: string description: >- - Indicates whether values grouped into categories can be used in - `Policy.allowed_values` and `Policy.denied_values`. For example, - `"in:Python"` would match any value in the 'Python' group. - type: boolean - description: >- - A constraint that allows or disallows a list of string values, which are - configured by an Organization Policy administrator with a policy. - id: GoogleCloudOrgpolicyV2ConstraintListConstraint - GoogleCloudOrgpolicyV2CustomConstraint: - id: GoogleCloudOrgpolicyV2CustomConstraint - properties: - name: - description: >- - Immutable. Name of the constraint. This is unique within the - organization. Format of the name should be * - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The - max length is 70 characters and the minimum length is 1. Note that - the prefix `organizations/{organization_id}/customConstraints/` is - not counted. - type: string - methodTypes: - description: All the operations being applied for this constraint. - items: - enum: - - METHOD_TYPE_UNSPECIFIED - - CREATE - - UPDATE - - DELETE - - REMOVE_GRANT - - GOVERN_TAGS - type: string - enumDescriptions: - - Unspecified. Results in an error. - - Constraint applied when creating the resource. - - Constraint applied when updating the resource. - - >- - Constraint applied when deleting the resource. Not supported - yet. - - Constraint applied when removing an IAM grant. - - Constraint applied when enforcing forced tagging. - type: array - description: - type: string - description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. - resourceTypes: - items: - type: string - type: array - description: >- - Immutable. The resource instance type on which this policy applies. - Format will be of the form : `/` Example: * - `compute.googleapis.com/Instance`. - displayName: - description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. - type: string - updateTime: - readOnly: true - description: >- - Output only. The last time this custom constraint was updated. This - represents the last time that the `CreateCustomConstraint` or - `UpdateCustomConstraint` RPC was called - format: google-datetime - type: string - actionType: - description: Allow or deny type. - enumDescriptions: - - Unspecified. Results in an error. - - Allowed action type. - - Deny action type. - enum: - - ACTION_TYPE_UNSPECIFIED - - ALLOW - - DENY - type: string - condition: - type: string - description: >- - Org policy condition/expression. For example: - `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, - `resource.management.auto_upgrade == true` The max length of the - condition is 1000 characters. - description: >- - A custom constraint defined by customers which can *only* be applied to - the given resource types and organization. By creating a custom - constraint, customers can apply policies of this custom constraint. - *Creating a custom constraint itself does NOT apply any policy - enforcement*. - type: object - GoogleCloudOrgpolicyV2Constraint: - id: GoogleCloudOrgpolicyV2Constraint - type: object - properties: + Detailed description of what this constraint controls as well as how + and where it is enforced. Mutable. supportsDryRun: description: Shows if dry run is supported for this constraint or not. type: boolean name: - type: string description: >- Immutable. The resource name of the constraint. Must be in one of the following forms: * @@ -322,110 +342,10 @@ components: `organizations/{organization_id}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". - constraintDefault: - type: string - description: >- - The evaluation behavior of this constraint in the absence of a - policy. - enum: - - CONSTRAINT_DEFAULT_UNSPECIFIED - - ALLOW - - DENY - enumDescriptions: - - >- - This is only used for distinguishing unset values and should never - be used. - - >- - Indicate that all values are allowed for list constraints. - Indicate that enforcement is off for boolean constraints. - - >- - Indicate that all values are denied for list constraints. Indicate - that enforcement is on for boolean constraints. - booleanConstraint: - description: Defines this constraint as being a BooleanConstraint. - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint - description: - description: >- - Detailed description of what this constraint controls as well as how - and where it is enforced. Mutable. - type: string - listConstraint: - description: Defines this constraint as being a ListConstraint. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' - displayName: - description: The human readable name. Mutable. - type: string - description: >- - A constraint describes a way to restrict resource's configuration. For - example, you could enforce a constraint that controls which Google Cloud - services can be activated across an organization, or whether a Compute - Engine instance can have serial port connections established. - Constraints can be configured by the organization policy administrator - to fit the needs of the organization by setting a policy that includes - constraints at different locations in the organization's resource - hierarchy. Policies are inherited down the resource hierarchy from - higher levels, but can also be overridden. For details about the - inheritance rules please read about `policies`. Constraints have a - default behavior determined by the `constraint_default` field, which is - the enforcement behavior that is used in the absence of a policy being - defined or inherited for the resource in question. - GoogleCloudOrgpolicyV2AlternatePolicySpec: - description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. - properties: - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Specify constraint for configurations of Google Cloud resources. - launch: - description: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. type: string - type: object - id: GoogleCloudOrgpolicyV2AlternatePolicySpec - GoogleCloudOrgpolicyV2ListPoliciesResponse: - properties: - nextPageToken: - type: string - description: >- - Page token used to retrieve the next page. This is currently not - used, but the server may at any point start supplying a valid token. - policies: - description: >- - All policies that exist on the resource. It will be empty if no - policies are set. - type: array - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: >- - The response returned from the ListPolicies method. It will be empty if - no policies are set on the resource. - id: GoogleCloudOrgpolicyV2ListPoliciesResponse - type: object - GoogleProtobufEmpty: - 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); } - properties: {} - id: GoogleProtobufEmpty - type: object + id: GoogleCloudOrgpolicyV2Constraint GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: type: object - properties: - deniedValues: - description: List of values denied at this resource. - items: - type: string - type: array - allowedValues: - description: List of values allowed at this resource. - type: array - items: - type: string description: >- A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource @@ -441,19 +361,32 @@ components: `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + properties: + deniedValues: + items: + type: string + description: List of values denied at this resource. + type: array + allowedValues: + type: array + description: List of values allowed at this resource. + items: + type: string GoogleCloudOrgpolicyV2PolicySpecPolicyRule: description: A rule used to express this policy. id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule - type: object properties: - enforce: + denyAll: type: boolean description: >- - If `true`, then the policy is enforced. If `false`, then any - configuration is acceptable. This field can be set only in policies - for boolean constraints. + Setting this to true means that all values are denied. This field + can be set only in policies for list constraints. + allowAll: + description: >- + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. + type: boolean condition: - $ref: '#/components/schemas/GoogleTypeExpr' description: >- A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the @@ -465,10 +398,12 @@ components: and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". - denyAll: + $ref: '#/components/schemas/GoogleTypeExpr' + enforce: description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. + If `true`, then the policy is enforced. If `false`, then any + configuration is acceptable. This field can be set only in policies + for boolean constraints. type: boolean values: description: >- @@ -476,28 +411,93 @@ components: set only in policies for list constraints. $ref: >- #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - allowAll: - description: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - type: boolean - GoogleCloudOrgpolicyV2ListConstraintsResponse: type: object - description: The response returned from the ListConstraints method. + GoogleCloudOrgpolicyV2CustomConstraint: + description: >- + A custom constraint defined by customers which can *only* be applied to + the given resource types and organization. By creating a custom + constraint, customers can apply policies of this custom constraint. + *Creating a custom constraint itself does NOT apply any policy + enforcement*. properties: - nextPageToken: + name: + type: string + description: >- + Immutable. Name of the constraint. This is unique within the + organization. Format of the name should be * + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The + max length is 70 characters and the minimum length is 1. Note that + the prefix `organizations/{organization_id}/customConstraints/` is + not counted. + updateTime: + readOnly: true + format: google-datetime + description: >- + Output only. The last time this custom constraint was updated. This + represents the last time that the `CreateCustomConstraint` or + `UpdateCustomConstraint` RPC was called + type: string + description: + type: string + description: >- + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + actionType: + type: string + enumDescriptions: + - Unspecified. Results in an error. + - Allowed action type. + - Deny action type. + description: Allow or deny type. + enum: + - ACTION_TYPE_UNSPECIFIED + - ALLOW + - DENY + resourceTypes: + items: + type: string + description: >- + Immutable. The resource instance type on which this policy applies. + Format will be of the form : `/` Example: * + `compute.googleapis.com/Instance`. + type: array + methodTypes: + description: All the operations being applied for this constraint. + type: array + items: + type: string + enum: + - METHOD_TYPE_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + - REMOVE_GRANT + - GOVERN_TAGS + enumDescriptions: + - Unspecified. Results in an error. + - Constraint applied when creating the resource. + - Constraint applied when updating the resource. + - >- + Constraint applied when deleting the resource. Not supported + yet. + - Constraint applied when removing an IAM grant. + - Constraint applied when enforcing forced tagging. + condition: description: >- - Page token used to retrieve the next page. This is currently not - used. + Org policy condition/expression. For example: + `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, + `resource.management.auto_upgrade == true` The max length of the + condition is 1000 characters. + type: string + displayName: type: string - constraints: description: >- - The collection of constraints that are available on the targeted - resource. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' - type: array - id: GoogleCloudOrgpolicyV2ListConstraintsResponse + One line display name for the UI. The max length of the display_name + is 200 characters. + id: GoogleCloudOrgpolicyV2CustomConstraint + type: object parameters: access_token: description: OAuth access token. @@ -505,21 +505,30 @@ components: name: access_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string - quotaUser: + key: description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + 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. in: query - name: quotaUser + name: key schema: type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' callback: description: JSONP in: query @@ -542,19 +551,10 @@ components: name: prettyPrint schema: type: boolean - 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. - in: query - name: key - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: fields + name: uploadType schema: type: string upload_protocol: @@ -563,113 +563,56 @@ components: name: upload_protocol schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: oauth_token + name: quotaUser schema: type: string - _.xgafv: - description: V1 error format. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: $.xgafv + name: oauth_token schema: type: string - enum: - - '1' - - '2' x-stackQL-resources: - custom_constraints: - id: google.orgpolicy.custom_constraints - name: custom_constraints - title: Custom_constraints - methods: - organizations_custom_constraints_get: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_custom_constraints_delete: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_custom_constraints_patch: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_custom_constraints_list: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.customConstraints - organizations_custom_constraints_create: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_get - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_list - insert: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_create - update: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_delete - policies_effective_policy: - id: google.orgpolicy.policies_effective_policy - name: policies_effective_policy - title: Policies_effective_policy + constraints: + id: google.orgpolicy.constraints + name: constraints + title: Constraints methods: - organizations_policies_get_effective_policy: + folders_constraints_list: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}:getEffectivePolicy/get + $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_get_effective_policy: + objectKey: $.constraints + projects_constraints_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}:getEffectivePolicy/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_get_effective_policy: + objectKey: $.constraints + organizations_constraints_list: operation: - $ref: >- - #/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}:getEffectivePolicy/get + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.constraints sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/organizations_policies_get_effective_policy + #/components/x-stackQL-resources/constraints/methods/folders_constraints_list - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/projects_policies_get_effective_policy + #/components/x-stackQL-resources/constraints/methods/projects_constraints_list - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy + #/components/x-stackQL-resources/constraints/methods/organizations_constraints_list insert: [] update: [] replace: [] @@ -679,288 +622,251 @@ components: name: policies title: Policies methods: - organizations_policies_get: + folders_policies_delete: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/get + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_patch: + folders_policies_get: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/patch + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_delete: + folders_policies_patch: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/delete + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_create: + folders_policies_create: operation: - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/post' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_list: + folders_policies_list: operation: - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/get' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - projects_policies_delete: + projects_policies_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_patch: + objectKey: $.policies + projects_policies_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_get: + projects_policies_delete: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_policies_create: + projects_policies_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_list: + projects_policies_patch: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.policies - folders_policies_get: + organizations_policies_list: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/get' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_delete: + objectKey: $.policies + organizations_policies_create: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/delete' + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_patch: + organizations_policies_delete: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/delete response: mediaType: application/json openAPIDocKey: '200' - folders_policies_list: + organizations_policies_get: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/get' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.policies - folders_policies_create: + organizations_policies_patch: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/policies/methods/organizations_policies_get + #/components/x-stackQL-resources/policies/methods/folders_policies_get - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_get - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_get + #/components/x-stackQL-resources/policies/methods/organizations_policies_get - $ref: >- - #/components/x-stackQL-resources/policies/methods/organizations_policies_list + #/components/x-stackQL-resources/policies/methods/folders_policies_list - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_list - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_list + #/components/x-stackQL-resources/policies/methods/organizations_policies_list insert: - $ref: >- - #/components/x-stackQL-resources/policies/methods/organizations_policies_create + #/components/x-stackQL-resources/policies/methods/folders_policies_create - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_create - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_create + #/components/x-stackQL-resources/policies/methods/organizations_policies_create update: - $ref: >- - #/components/x-stackQL-resources/policies/methods/organizations_policies_patch + #/components/x-stackQL-resources/policies/methods/folders_policies_patch - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_patch - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_patch + #/components/x-stackQL-resources/policies/methods/organizations_policies_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/policies/methods/organizations_policies_delete + #/components/x-stackQL-resources/policies/methods/folders_policies_delete - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_delete - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_delete - constraints: - id: google.orgpolicy.constraints - name: constraints - title: Constraints + #/components/x-stackQL-resources/policies/methods/organizations_policies_delete + policies_effective_policy: + id: google.orgpolicy.policies_effective_policy + name: policies_effective_policy + title: Policies_effective_policy methods: - organizations_constraints_list: + folders_policies_get_effective_policy: operation: - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.constraints - projects_constraints_list: + projects_policies_get_effective_policy: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.constraints - folders_constraints_list: + organizations_policies_get_effective_policy: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.constraints sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/constraints/methods/organizations_constraints_list + #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy - $ref: >- - #/components/x-stackQL-resources/constraints/methods/projects_constraints_list + #/components/x-stackQL-resources/policies_effective_policy/methods/projects_policies_get_effective_policy - $ref: >- - #/components/x-stackQL-resources/constraints/methods/folders_constraints_list + #/components/x-stackQL-resources/policies_effective_policy/methods/organizations_policies_get_effective_policy insert: [] update: [] replace: [] delete: [] + custom_constraints: + id: google.orgpolicy.custom_constraints + name: custom_constraints + title: Custom_constraints + methods: + organizations_custom_constraints_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_custom_constraints_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_custom_constraints_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_custom_constraints_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.customConstraints + organizations_custom_constraints_create: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_get + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_list + insert: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_create + update: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_delete paths: - /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: + /v2/folders/{foldersId}/constraints: parameters: &ref_1 - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' - get: - description: >- - Gets a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist. - operationId: orgpolicy.organizations.customConstraints.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: customConstraintsId - required: true - schema: - type: string - delete: - description: >- - Deletes a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. - operationId: orgpolicy.organizations.customConstraints.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: customConstraintsId - required: true - schema: - type: string - patch: - description: >- - Updates a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the - supplied policy will perform a full overwrite of all fields. - operationId: orgpolicy.organizations.customConstraints.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: customConstraintsId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/customConstraints: - parameters: *ref_1 get: - description: >- - Retrieves all of the custom constraints that exist on a particular - organization resource. - operationId: orgpolicy.organizations.customConstraints.list + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.folders.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -973,62 +879,30 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: >- - Creates a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns - a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the - constraint already exists on the given organization. - operationId: orgpolicy.organizations.customConstraints.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - parameters: - - in: path - name: organizationsId - required: true + type: string + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/folders/{foldersId}/policies/{policiesId}: parameters: *ref_1 - get: + delete: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.organizations.policies.getEffectivePolicy + Deletes a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or organization policy + does not exist. + operationId: orgpolicy.folders.policies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1040,10 +914,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1052,14 +926,16 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/policies/{policiesId}: - parameters: *ref_1 + - in: query + name: etag + schema: + type: string get: description: >- Gets a policy on a resource. If no policy is set on the resource, `NOT_FOUND` is returned. The `etag` value can be used with `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.organizations.policies.get + operationId: orgpolicy.folders.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1074,7 +950,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1091,7 +967,7 @@ paths: the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields. - operationId: orgpolicy.organizations.policies.patch + operationId: orgpolicy.folders.policies.patch requestBody: content: application/json: @@ -1111,7 +987,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1125,40 +1001,7 @@ paths: schema: type: string format: google-fieldmask - delete: - description: >- - Deletes a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or organization policy - does not exist. - operationId: orgpolicy.organizations.policies.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: policiesId - required: true - schema: - type: string - - in: query - name: etag - schema: - type: string - /v2/organizations/{organizationsId}/policies: + /v2/folders/{foldersId}/policies: parameters: *ref_1 post: description: >- @@ -1166,7 +1009,7 @@ paths: `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy already exists on the given Google Cloud resource. - operationId: orgpolicy.organizations.policies.create + operationId: orgpolicy.folders.policies.create requestBody: content: application/json: @@ -1186,13 +1029,13 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string get: description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.organizations.policies.list + operationId: orgpolicy.folders.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1208,24 +1051,57 @@ paths: #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken + /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: + parameters: *ref_1 + get: + description: >- + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.folders.policies.getEffectivePolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + parameters: + - in: path + name: foldersId + required: true schema: type: string - /v2/organizations/{organizationsId}/constraints: + - in: path + name: policiesId + required: true + schema: + type: string + /v2/projects/{projectsId}/constraints: parameters: *ref_1 get: description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.organizations.constraints.list + operationId: orgpolicy.projects.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1241,7 +1117,7 @@ paths: #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1254,11 +1130,44 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/constraints: + /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: parameters: *ref_1 get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.projects.constraints.list + description: >- + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.projects.policies.getEffectivePolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: policiesId + required: true + schema: + type: string + /v2/projects/{projectsId}/policies: + parameters: *ref_1 + get: + description: Retrieves all of the policies that exist on a particular resource. + operationId: orgpolicy.projects.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1271,7 +1180,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path name: projectsId @@ -1287,6 +1196,36 @@ paths: name: pageToken schema: type: string + post: + description: >- + Creates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy + already exists on the given Google Cloud resource. + operationId: orgpolicy.projects.policies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string /v2/projects/{projectsId}/policies/{policiesId}: parameters: *ref_1 delete: @@ -1322,6 +1261,35 @@ paths: name: etag schema: type: string + get: + description: >- + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.projects.policies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: policiesId + required: true + schema: + type: string patch: description: >- Updates a policy. Returns a `google.rpc.Status` with @@ -1347,29 +1315,58 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: policiesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: + parameters: *ref_1 + get: + description: >- + Gets a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist. + operationId: orgpolicy.organizations.customConstraints.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: + delete: description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.projects.policies.get + Deletes a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. + operationId: orgpolicy.organizations.customConstraints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1381,32 +1378,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string - /v2/projects/{projectsId}/policies: - parameters: *ref_1 - post: + patch: description: >- - Creates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy - already exists on the given Google Cloud resource. - operationId: orgpolicy.projects.policies.create + Updates a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the + supplied policy will perform a full overwrite of all fields. + operationId: orgpolicy.organizations.customConstraints.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1418,16 +1412,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId + name: organizationsId + required: true + schema: + type: string + - in: path + name: customConstraintsId required: true schema: type: string + /v2/organizations/{organizationsId}/customConstraints: + parameters: *ref_1 get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.projects.policies.list + description: >- + Retrieves all of the custom constraints that exist on a particular + organization resource. + operationId: orgpolicy.organizations.customConstraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1440,10 +1443,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -1456,16 +1459,18 @@ paths: name: pageToken schema: type: string - /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_1 - get: + post: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.projects.policies.getEffectivePolicy + Creates a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns + a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the + constraint already exists on the given organization. + operationId: orgpolicy.organizations.customConstraints.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1477,23 +1482,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: policiesId + name: organizationsId required: true schema: type: string - /v2/folders/{foldersId}/constraints: + /v2/organizations/{organizationsId}/constraints: parameters: *ref_1 get: description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.folders.constraints.list + operationId: orgpolicy.organizations.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1509,7 +1509,7 @@ paths: #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1522,14 +1522,11 @@ paths: schema: type: integer format: int32 - /v2/folders/{foldersId}/policies/{policiesId}: + /v2/organizations/{organizationsId}/policies: parameters: *ref_1 get: - description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.folders.policies.get + description: Retrieves all of the policies that exist on a particular resource. + operationId: orgpolicy.organizations.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1541,24 +1538,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: path - name: policiesId - required: true + - in: query + name: pageToken schema: type: string - delete: + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: description: >- - Deletes a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or organization policy - does not exist. - operationId: orgpolicy.folders.policies.delete + Creates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy + already exists on the given Google Cloud resource. + operationId: orgpolicy.organizations.policies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1570,36 +1578,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: policiesId + name: organizationsId required: true schema: type: string - - in: query - name: etag - schema: - type: string - patch: + /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: + parameters: *ref_1 + get: description: >- - Updates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not - exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if - the etag supplied in the request does not match the persisted etag of - the policy Note: the supplied policy will perform a full overwrite of - all fields. - operationId: orgpolicy.folders.policies.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.organizations.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1614,7 +1609,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1623,21 +1618,14 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: + /v2/organizations/{organizationsId}/policies/{policiesId}: parameters: *ref_1 - get: + delete: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.folders.policies.getEffectivePolicy + Deletes a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or organization policy + does not exist. + operationId: orgpolicy.organizations.policies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1649,10 +1637,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1661,11 +1649,16 @@ paths: required: true schema: type: string - /v2/folders/{foldersId}/policies: - parameters: *ref_1 + - in: query + name: etag + schema: + type: string get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.folders.policies.list + description: >- + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.organizations.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1677,30 +1670,27 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: policiesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: + patch: description: >- - Creates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy - already exists on the given Google Cloud resource. - operationId: orgpolicy.folders.policies.create + Updates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not + exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if + the etag supplied in the request does not match the persisted etag of + the policy Note: the supplied policy will perform a full overwrite of + all fields. + operationId: orgpolicy.organizations.policies.patch requestBody: content: application/json: @@ -1720,7 +1710,17 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: organizationsId + required: true + schema: + type: string + - in: path + name: policiesId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask diff --git a/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml b/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml index 298640f3..3a40cfee 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml @@ -9,8 +9,8 @@ info: OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. version: v1 - x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/compute/docs/osconfig/rest servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml b/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml index 58b52158..ea5eaddb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml @@ -8,7 +8,7 @@ info: description: You can use OS Login to manage access to your VM instances using IAM roles. version: v1 x-discovery-doc-revision: '20240825' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/compute/docs/oslogin/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/places.yaml b/providers/src/googleapis.com/v00.00.00000/services/places.yaml index 01a7c0ed..3a07c903 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/places.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/places.yaml @@ -7,8 +7,8 @@ info: title: Places API (New) description: '' version: v1 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://mapsplatform.google.com/maps-products/#places-section servers: @@ -22,24 +22,24 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/maps-platform.places.autocomplete: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places.autocomplete https://www.googleapis.com/auth/maps-platform.places.nearbysearch: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.nearbysearch + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. https://www.googleapis.com/auth/maps-platform.places: >- Private Service: https://www.googleapis.com/auth/maps-platform.places - https://www.googleapis.com/auth/maps-platform.places.details: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.places.details - https://www.googleapis.com/auth/maps-platform.places.autocomplete: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.places.autocomplete https://www.googleapis.com/auth/maps-platform.places.textsearch: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.textsearch - https://www.googleapis.com/auth/cloud-platform: >- - See, edit, configure, and delete your Google Cloud data and see - the email address for your Google Account. + https://www.googleapis.com/auth/maps-platform.places.details: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places.details Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -49,100 +49,74 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: - description: Prediction results for a Place Autocomplete prediction. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: + description: The range of highlighted text. + id: >- + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange properties: - placeId: - type: string - description: >- - The unique identifier of the suggested Place. This identifier can be - used in other APIs that accept Place IDs. - structuredFormat: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - description: >- - A breakdown of the Place prediction into main text containing the - name of the Place and secondary text containing additional - disambiguating features (such as a city or region). - `structured_format` is recommended for developers who wish to show - two separate, but related, UI elements. Developers who wish to show - a single UI element may want to use `text` instead. They are two - different ways to represent a Place prediction. Users should not try - to parse `structured_format` into `text` or vice versa. - text: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - description: >- - Contains the human-readable name for the returned result. For - establishment results, this is usually the business name and - address. `text` is recommended for developers who wish to show a - single UI element. Developers who wish to show two separate, but - related, UI elements may want to use `structured_format` instead. - They are two different ways to represent a Place prediction. Users - should not try to parse `structured_format` into `text` or vice - versa. This text may be different from the `display_name` returned - by GetPlace. May be in mixed languages if the request `input` and - `language_code` are in different languages or if the Place does not - have a translation from the local language to `language_code`. - distanceMeters: + endIndex: type: integer format: int32 - description: >- - The length of the geodesic in meters from `origin` if `origin` is - specified. Certain predictions such as routes may not populate this - field. - types: - type: array - description: >- - List of types that apply to this Place from Table A or Table B in - https://developers.google.com/maps/documentation/places/web-service/place-types. - A type is a categorization of a Place. Places with shared types will - share similar characteristics. + startIndex: + format: int32 + type: integer + type: object + GoogleMapsPlacesV1PlaceAreaSummary: + properties: + contentBlocks: items: - type: string - place: - type: string + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' + type: array description: >- - The resource name of the suggested Place. This name can be used in - other APIs that accept Place names. - type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: - description: Prediction results for a Query Autocomplete prediction. + Content blocks that compose the area summary. Each block has a + separate topic about the area. + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the area that the place is in. + id: GoogleMapsPlacesV1PlaceAreaSummary type: object + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: + description: An Autocomplete suggestion result. properties: - text: - description: >- - The predicted text. This text does not represent a Place, but rather - a text query that could be used in a search endpoint (for example, - Text Search). `text` is recommended for developers who wish to show - a single UI element. Developers who wish to show two separate, but - related, UI elements may want to use `structured_format` instead. - They are two different ways to represent a query prediction. Users - should not try to parse `structured_format` into `text` or vice - versa. May be in mixed languages if the request `input` and - `language_code` are in different languages or if part of the query - does not have a translation from the local language to - `language_code`. + queryPrediction: $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - structuredFormat: - description: >- - A breakdown of the query prediction into main text containing the - query and secondary text containing additional disambiguating - features (such as a city or region). `structured_format` is - recommended for developers who wish to show two separate, but - related, UI elements. Developers who wish to show a single UI - element may want to use `text` instead. They are two different ways - to represent a query prediction. Users should not try to parse - `structured_format` into `text` or vice versa. + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + description: A prediction for a query. + placePrediction: + description: A prediction for a Place. $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + type: object + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion GoogleMapsPlacesV1SearchTextRequestEVOptions: + description: Searchable EV options of a place search request. + type: object + id: GoogleMapsPlacesV1SearchTextRequestEVOptions properties: + minimumChargingRateKw: + description: >- + Optional. Minimum required charging rate in kilowatts. A place with + a charging rate less than the specified rate is filtered out. + type: number + format: double connectorTypes: + type: array + description: >- + Optional. The list of preferred EV connector types. A place that + does not support any of the listed connector types is filtered out. items: + enum: + - EV_CONNECTOR_TYPE_UNSPECIFIED + - EV_CONNECTOR_TYPE_OTHER + - EV_CONNECTOR_TYPE_J1772 + - EV_CONNECTOR_TYPE_TYPE_2 + - EV_CONNECTOR_TYPE_CHADEMO + - EV_CONNECTOR_TYPE_CCS_COMBO_1 + - EV_CONNECTOR_TYPE_CCS_COMBO_2 + - EV_CONNECTOR_TYPE_TESLA + - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T + - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET enumDescriptions: - Unspecified connector. - Other connector types. @@ -166,400 +140,589 @@ components: covers all GB_T types. - Unspecified wall outlet. type: string - enum: - - EV_CONNECTOR_TYPE_UNSPECIFIED - - EV_CONNECTOR_TYPE_OTHER - - EV_CONNECTOR_TYPE_J1772 - - EV_CONNECTOR_TYPE_TYPE_2 - - EV_CONNECTOR_TYPE_CHADEMO - - EV_CONNECTOR_TYPE_CCS_COMBO_1 - - EV_CONNECTOR_TYPE_CCS_COMBO_2 - - EV_CONNECTOR_TYPE_TESLA - - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET + GoogleMapsPlacesV1RouteModifiers: + properties: + avoidHighways: description: >- - Optional. The list of preferred EV connector types. A place that - does not support any of the listed connector types is filtered out. + Optional. When set to true, avoids highways where reasonable, giving + preference to routes not containing highways. Applies only to the + `DRIVE` and `TWO_WHEELER` `TravelMode`. + type: boolean + avoidIndoor: + type: boolean + description: >- + Optional. When set to true, avoids navigating indoors where + reasonable, giving preference to routes not containing indoor + navigation. Applies only to the `WALK` `TravelMode`. + avoidFerries: + type: boolean + description: >- + Optional. When set to true, avoids ferries where reasonable, giving + preference to routes not containing ferries. Applies only to the + `DRIVE` and `TWO_WHEELER` `TravelMode`. + avoidTolls: + type: boolean + description: >- + Optional. When set to true, avoids toll roads where reasonable, + giving preference to routes not containing toll roads. Applies only + to the `DRIVE` and `TWO_WHEELER` `TravelMode`. + description: >- + Encapsulates a set of optional conditions to satisfy when calculating + the routes. + type: object + id: GoogleMapsPlacesV1RouteModifiers + GoogleMapsPlacesV1SearchTextResponse: + type: object + properties: + nextPageToken: + type: string + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted or empty, there are no subsequent pages. + places: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + description: A list of places that meet the user's text search criteria. type: array - minimumChargingRateKw: - format: double - type: number + contextualContents: description: >- - Optional. Minimum required charging rate in kilowatts. A place with - a charging rate less than the specified rate is filtered out. - description: Searchable EV options of a place search request. - id: GoogleMapsPlacesV1SearchTextRequestEVOptions + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. A list of contextual contents where each entry + associates to the corresponding place in the same index in the + places field. The contents that are relevant to the `text_query` in + the request are preferred. If the contextual content is not + available for one of the places, it will return non-contextual + content. It will be empty only when the content is unavailable for + this place. This list will have as many entries as the list of + places if requested. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' + routingSummaries: + type: array + description: >- + A list of routing summaries where each entry associates to the + corresponding place in the same index in the `places` field. If the + routing summary is not available for one of the places, it will + contain an empty entry. This list will have as many entries as the + list of places if requested. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' + id: GoogleMapsPlacesV1SearchTextResponse + description: 'Response proto for SearchText. ' + GoogleMapsPlacesV1Polyline: type: object - GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction description: >- - The region to search. The results will be restricted to the specified - region. - type: object + A route polyline. Only supports an [encoded + polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), + which can be passed as a string and includes compression with minimal + lossiness. This is the Routes API default output. properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by a center point and radius. - rectangle: - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: A viewport defined by a northeast and a southwest corner. + encodedPolyline: + type: string + description: >- + An [encoded + polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), + as returned by the [Routes API by + default](https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes#polylineencoding). + See the + [encoder](https://developers.google.com/maps/documentation/utilities/polylineutility) + and + [decoder](https://developers.google.com/maps/documentation/routes/polylinedecoder) + tools. + id: GoogleMapsPlacesV1Polyline + GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters: + description: >- + Specifies a precalculated polyline from the [Routes + API](https://developers.google.com/maps/documentation/routes) defining + the route to search. Searching along a route is similar to using the + `locationBias` or `locationRestriction` request option to bias the + search results. However, while the `locationBias` and + `locationRestriction` options let you specify a region to bias the + search results, this option lets you bias the results along a trip + route. Results are not guaranteed to be along the route provided, but + rather are ranked within the search area defined by the polyline and, + optionally, by the `locationBias` or `locationRestriction` based on + minimal detour times from origin to destination. The results might be + along an alternate route, especially if the provided polyline does not + define an optimal route from origin to destination. + properties: + polyline: + $ref: '#/components/schemas/GoogleMapsPlacesV1Polyline' + description: Required. The route polyline. + type: object + id: GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters GoogleTypeDate: id: GoogleTypeDate - type: object + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp properties: year: description: >- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + type: integer format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. type: integer + format: int32 day: format: int32 + type: integer description: >- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - type: integer - month: - format: int32 - type: integer - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: + type: object + GoogleMapsPlacesV1PlaceOpeningHours: + id: GoogleMapsPlacesV1PlaceOpeningHours type: object properties: - mainText: + periods: + type: array + description: >- + The periods that this place is open during the week. The periods are + in chronological order, starting with Sunday in the place-local + timezone. An empty (but not absent) value indicates a place that is + never open, e.g. because it is closed temporarily for renovations. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' + specialDays: + type: array + description: >- + Structured information for special days that fall within the period + that the returned opening hours cover. Special days are days that + could impact the business hours of a place, e.g. Christmas day. Set + for current_opening_hours and current_secondary_opening_hours if + there are exceptional hours. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' + secondaryHoursType: + enumDescriptions: + - Default value when secondary hour type is not specified. + - The drive-through hour for banks, restaurants, or pharmacies. + - The happy hour. + - The delivery hour. + - The takeout hour. + - The kitchen hour. + - The breakfast hour. + - The lunch hour. + - The dinner hour. + - The brunch hour. + - The pickup hour. + - The access hours for storage places. + - The special hours for seniors. + - The online service hours. + type: string + description: A type string used to identify the type of secondary hours. + enum: + - SECONDARY_HOURS_TYPE_UNSPECIFIED + - DRIVE_THROUGH + - HAPPY_HOUR + - DELIVERY + - TAKEOUT + - KITCHEN + - BREAKFAST + - LUNCH + - DINNER + - BRUNCH + - PICKUP + - ACCESS + - SENIOR_HOURS + - ONLINE_SERVICE_HOURS + weekdayDescriptions: + type: array + description: >- + Localized strings describing the opening hours of this place, one + string for each day of the week. Will be empty if the hours are + unknown or could not be converted to localized text. Example: "Sun: + 18:00–06:00" + items: + type: string + openNow: + type: boolean + description: >- + Whether the opening hours period is currently active. For regular + opening hours and current opening hours, this field means whether + the place is open. For secondary opening hours and current secondary + opening hours, this field means whether the secondary hours of this + place is active. + description: Information about business hour of the place. + GoogleMapsPlacesV1PlaceOpeningHoursPeriod: + properties: + open: + description: The time that the place starts to be open. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' + close: + description: The time that the place starts to be closed. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' + description: A period the place remains in open_now status. + type: object + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: + type: object + properties: + distanceMeters: + format: int32 + type: integer + description: >- + The length of the geodesic in meters from `origin` if `origin` is + specified. Certain predictions such as routes may not populate this + field. + text: $ref: >- #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - description: Represents the name of the Place or query. - secondaryText: + description: >- + Contains the human-readable name for the returned result. For + establishment results, this is usually the business name and + address. `text` is recommended for developers who wish to show a + single UI element. Developers who wish to show two separate, but + related, UI elements may want to use `structured_format` instead. + They are two different ways to represent a Place prediction. Users + should not try to parse `structured_format` into `text` or vice + versa. This text may be different from the `display_name` returned + by GetPlace. May be in mixed languages if the request `input` and + `language_code` are in different languages or if the Place does not + have a translation from the local language to `language_code`. + types: + description: >- + List of types that apply to this Place from Table A or Table B in + https://developers.google.com/maps/documentation/places/web-service/place-types. + A type is a categorization of a Place. Places with shared types will + share similar characteristics. + type: array + items: + type: string + placeId: + description: >- + The unique identifier of the suggested Place. This identifier can be + used in other APIs that accept Place IDs. + type: string + place: + type: string + description: >- + The resource name of the suggested Place. This name can be used in + other APIs that accept Place names. + structuredFormat: $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat description: >- - Represents additional disambiguating features (such as a city or - region) to further identify the Place or refine the query. + A breakdown of the Place prediction into main text containing the + name of the Place and secondary text containing additional + disambiguating features (such as a city or region). + `structured_format` is recommended for developers who wish to show + two separate, but related, UI elements. Developers who wish to show + a single UI element may want to use `text` instead. They are two + different ways to represent a Place prediction. Users should not try + to parse `structured_format` into `text` or vice versa. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + description: Prediction results for a Place Autocomplete prediction. + GoogleMapsPlacesV1Circle: + id: GoogleMapsPlacesV1Circle + type: object + description: Circle with a LatLng as center and radius. + properties: + radius: + type: number + description: >- + Required. Radius measured in meters. The radius must be within [0.0, + 50000.0]. + format: double + center: + description: >- + Required. Center latitude and longitude. The range of latitude must + be within [-90.0, 90.0]. The range of the longitude must be within + [-180.0, 180.0]. + $ref: '#/components/schemas/GoogleTypeLatLng' + GoogleMapsPlacesV1FuelOptions: + properties: + fuelPrices: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' + description: >- + The last known fuel price for each type of fuel this station has. + There is one entry per fuel type this station has. Order is not + important. description: >- - Contains a breakdown of a Place or query prediction into main text and - secondary text. For Place predictions, the main text contains the - specific name of the Place. For query predictions, the main text - contains the query. The secondary text contains additional - disambiguating features (such as a city or region) to further identify - the Place or refine the query. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + The most recent information about fuel options in a gas station. This + information is updated regularly. + id: GoogleMapsPlacesV1FuelOptions + type: object + GoogleMapsPlacesV1Photo: + id: GoogleMapsPlacesV1Photo + description: Information about a photo of a place. + type: object properties: - endOffset: - description: Zero-based offset of the last Unicode character (exclusive). - type: integer + heightPx: format: int32 - startOffset: type: integer - description: >- - Zero-based offset of the first Unicode character of the string - (inclusive). + description: The maximum available height, in pixels. + authorAttributions: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + description: This photo's authors. + widthPx: + type: integer + description: The maximum available width, in pixels. format: int32 + name: + type: string + description: >- + Identifier. A reference representing this place photo which may be + used to look up this place photo again (also called the API + "resource" name: `places/{place_id}/photos/{photo}`). + GoogleMapsPlacesV1ContextualContentJustification: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. Justifications answers + the question of why a place could interest an end user. + id: GoogleMapsPlacesV1ContextualContentJustification type: object - description: Identifies a substring within a given text. - GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: - type: object - id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by center point and radius. - description: The region to search. - GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: + businessAvailabilityAttributesJustification: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + reviewJustification: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + GoogleMapsPlacesV1FuelOptionsFuelPrice: + id: GoogleMapsPlacesV1FuelOptionsFuelPrice + description: Fuel price information for a given type. type: object - id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation - description: >- - EV charging information grouped by [type, max_charge_rate_kw]. Shows EV - charge aggregation of connectors that have the same type and max charge - rate in kw. properties: - availabilityLastUpdateTime: - type: string + updateTime: format: google-datetime - description: >- - The timestamp when the connector availability information in this - aggregation was last updated. - maxChargeRateKw: - type: number - format: double - description: >- - The static max charging rate in kw of each connector in the - aggregation. - outOfServiceCount: - type: integer - description: >- - Number of connectors in this aggregation that are currently out of - service. - format: int32 - count: - format: int32 - type: integer - description: Number of connectors in this aggregation. - type: type: string - description: The connector type of this aggregation. - enum: - - EV_CONNECTOR_TYPE_UNSPECIFIED - - EV_CONNECTOR_TYPE_OTHER - - EV_CONNECTOR_TYPE_J1772 - - EV_CONNECTOR_TYPE_TYPE_2 - - EV_CONNECTOR_TYPE_CHADEMO - - EV_CONNECTOR_TYPE_CCS_COMBO_1 - - EV_CONNECTOR_TYPE_CCS_COMBO_2 - - EV_CONNECTOR_TYPE_TESLA - - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET + description: The time the fuel price was last updated. + price: + $ref: '#/components/schemas/GoogleTypeMoney' + description: The price of the fuel. + type: enumDescriptions: - - Unspecified connector. - - Other connector types. - - J1772 type 1 connector. - - IEC 62196 type 2 connector. Often referred to as MENNEKES. - - CHAdeMO type connector. - - >- - Combined Charging System (AC and DC). Based on SAE. Type-1 J-1772 - connector - - >- - Combined Charging System (AC and DC). Based on Type-2 Mennekes - connector - - >- - The generic TESLA connector. This is NACS in the North America but - can be non-NACS in other parts of the world (e.g. CCS Combo 2 - (CCS2) or GB/T). This value is less representative of an actual - connector type, and more represents the ability to charge a Tesla - brand vehicle at a Tesla owned charging station. - - >- - GB/T type corresponds to the GB/T standard in China. This type - covers all GB_T types. - - Unspecified wall outlet. - availableCount: - description: >- - Number of connectors in this aggregation that are currently - available. - format: int32 - type: integer - GoogleMapsPlacesV1ContextualContent: + - Unspecified fuel type. + - Diesel fuel. + - Regular unleaded. + - Midgrade. + - Premium. + - SP 91. + - SP 91 E10. + - SP 92. + - SP 95. + - SP95 E10. + - SP 98. + - SP 99. + - SP 100. + - LPG. + - E 80. + - E 85. + - Methane. + - Bio-diesel. + - Truck diesel. + description: The type of fuel. + enum: + - FUEL_TYPE_UNSPECIFIED + - DIESEL + - REGULAR_UNLEADED + - MIDGRADE + - PREMIUM + - SP91 + - SP91_E10 + - SP92 + - SP95 + - SP95_E10 + - SP98 + - SP99 + - SP100 + - LPG + - E80 + - E85 + - METHANE + - BIO_DIESEL + - TRUCK_DIESEL + type: string + GoogleMapsPlacesV1PlaceAttribution: type: object - id: GoogleMapsPlacesV1ContextualContent properties: - justifications: - type: array - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Justifications for the place. - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification - photos: - type: array - description: >- - Information (including references) about photos of this place, - contexual to the place query. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' - reviews: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: List of reviews about this place, contexual to the place query. - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Content that is contextual to the place query. - GoogleMapsPlacesV1ContentBlock: - description: A block of content that can be served individually. + provider: + type: string + description: Name of the Place's data provider. + providerUri: + type: string + description: URI to the Place's data provider. + description: Information about data providers of this place. + id: GoogleMapsPlacesV1PlaceAttribution + GoogleMapsPlacesV1SearchTextRequest: type: object - id: GoogleMapsPlacesV1ContentBlock + id: GoogleMapsPlacesV1SearchTextRequest + description: 'Request proto for SearchText. ' properties: - references: + regionCode: description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. References that are related to this block of - content. - $ref: '#/components/schemas/GoogleMapsPlacesV1References' - topic: + The Unicode country/region code (CLDR) of the location where the + request is coming from. This parameter is used to display the place + details, like region-specific place name, if available. The + parameter can affect results based on applicable law. For more + information, see + https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. + Note that 3-digit region codes are not currently supported. type: string - description: The topic of the content, for example "overview" or "restaurant". - content: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: Content related to the topic. - GoogleMapsPlacesV1AutocompletePlacesRequest: - type: object - id: GoogleMapsPlacesV1AutocompletePlacesRequest - properties: - includedPrimaryTypes: - items: - type: string - type: array + routingParameters: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' + description: Optional. Additional parameters for routing to results. + openNow: + type: boolean description: >- - Optional. Included primary Place type (for example, "restaurant" or - "gas_station") in Place Types - (https://developers.google.com/maps/documentation/places/web-service/place-types), - or only `(regions)`, or only `(cities)`. A Place is only returned if - its primary type is included in this list. Up to 5 values can be - specified. If no types are specified, all Place types are returned. - locationRestriction: + Used to restrict the search to places that are currently open. The + default is false. + strictTypeFiltering: + type: boolean description: >- - Optional. Restrict results to a specified location. At most one of - `location_bias` or `location_restriction` should be set. If neither - are set, the results will be biased by IP address, meaning the IP - address will be mapped to an imprecise location and used as a - biasing signal. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction - languageCode: - type: string + Used to set strict type filtering for included_type. If set to true, + only results of the same type will be returned. Default to false. + locationBias: description: >- - Optional. The language in which to return results. Defaults to - en-US. The results may be in mixed languages if the language used in - `input` is different from `language_code` or if the returned Place - does not have a translation from the local language to - `language_code`. - includedRegionCodes: - items: - type: string - type: array + The region to search. This location serves as a bias which means + results around given location might be returned. Cannot be set along + with location_restriction. + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationBias' + minRating: + type: number description: >- - Optional. Only include results in the specified regions, specified - as up to 15 CLDR two-character region codes. An empty set will not - restrict the results. If both `location_restriction` and - `included_region_codes` are set, the results will be located in the - area of intersection. - sessionToken: + Filter out results whose average user rating is strictly less than + this limit. A valid value must be a float between 0 and 5 + (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] + inclusively. The input rating will round up to the nearest + 0.5(ceiling). For instance, a rating of 0.6 will eliminate all + results with a less than 1.0 rating. + format: double + languageCode: type: string description: >- - Optional. A string which identifies an Autocomplete session for - billing purposes. Must be a URL and filename safe base64 string with - at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT - error is returned. The session begins when the user starts typing a - query, and concludes when they select a place and a call to Place - Details or Address Validation is made. Each session can have - multiple queries, followed by one Place Details or Address - Validation request. The credentials used for each request within a - session must belong to the same Google Cloud Console project. Once a - session has concluded, the token is no longer valid; your app must - generate a fresh token for each session. If the `session_token` - parameter is omitted, or if you reuse a session token, the session - is charged as if no session token was provided (each request is - billed separately). We recommend the following guidelines: * Use - session tokens for all Place Autocomplete calls. * Generate a fresh - token for each session. Using a version 4 UUID is recommended. * - Ensure that the credentials used for all Place Autocomplete, Place - Details, and Address Validation requests within a session belong to - the same Cloud Console project. * Be sure to pass a unique session - token for each new session. Using the same token for more than one - session will result in each request being billed individually. - locationBias: - description: >- - Optional. Bias results to a specified location. At most one of - `location_bias` or `location_restriction` should be set. If neither - are set, the results will be biased by IP address, meaning the IP - address will be mapped to an imprecise location and used as a - biasing signal. + Place details will be displayed with the preferred language if + available. If the language code is unspecified or unrecognized, + place details of any language may be returned, with a preference for + English if such details exist. Current list of supported languages: + https://developers.google.com/maps/faq#languagesupport. + rankPreference: + enumDescriptions: + - >- + For a categorical query such as "Restaurants in New York City", + RELEVANCE is the default. For non-categorical queries such as + "Mountain View, CA" we recommend that you leave rankPreference + unset. + - Ranks results by distance. + - >- + Ranks results by relevance. Sort order determined by normal + ranking stack. + description: How results will be ranked in the response. + type: string + enum: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - RELEVANCE + searchAlongRouteParameters: $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - inputOffset: - description: >- - Optional. A zero-based Unicode character offset of `input` - indicating the cursor position in `input`. The cursor position may - influence what predictions are returned. If empty, defaults to the - length of `input`. - format: int32 + #/components/schemas/GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters + description: Optional. Additional parameters proto for searching along a route. + pageSize: type: integer - origin: - $ref: '#/components/schemas/GoogleTypeLatLng' + format: int32 description: >- - Optional. The origin point from which to calculate geodesic distance - to the destination (returned as `distance_meters`). If this value is - omitted, geodesic distance will not be returned. - regionCode: - type: string + Optional. The maximum number of results per page that can be + returned. If the number of available results is larger than + `page_size`, a `next_page_token` is returned which can be passed to + `page_token` to get the next page of results in subsequent requests. + If 0 or no value is provided, a default of 20 is used. The maximum + value is 20; values above 20 will be set to 20. Negative values will + return an INVALID_ARGUMENT error. If both `max_result_count` and + `page_size` are specified, `max_result_count` will be ignored. + evOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' + description: Optional. Set the searchable EV options of a place search request. + priceLevels: + type: array description: >- - Optional. The region code, specified as a CLDR two-character region - code. This affects address formatting, result ranking, and may - influence what results are returned. This does not restrict results - to the specified region. To restrict results to a region, use - `region_code_restriction`. - input: - type: string - description: Required. The text string on which to search. - includeQueryPredictions: - type: boolean + Used to restrict the search to places that are marked as certain + price levels. Users can choose any combinations of price levels. + Default to select all price levels. + items: + type: string + enum: + - PRICE_LEVEL_UNSPECIFIED + - PRICE_LEVEL_FREE + - PRICE_LEVEL_INEXPENSIVE + - PRICE_LEVEL_MODERATE + - PRICE_LEVEL_EXPENSIVE + - PRICE_LEVEL_VERY_EXPENSIVE + enumDescriptions: + - Place price level is unspecified or unknown. + - Place provides free services. + - Place provides inexpensive services. + - Place provides moderately priced services. + - Place provides expensive services. + - Place provides very expensive services. + locationRestriction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction + description: >- + The region to search. This location serves as a restriction which + means results outside given location will not be returned. Cannot be + set along with location_bias. + maxResultCount: description: >- - Optional. If true, the response will include both Place and query - predictions. Otherwise the response will only return Place - predictions. - description: Request proto for AutocompletePlaces. - GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: - type: object - description: >- - The region to search. The results may be biased around the specified - region. - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by a center point and radius. - rectangle: - description: A viewport defined by a northeast and a southwest corner. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: - type: object - id: >- - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange - description: The range of highlighted text. - properties: - startIndex: + Deprecated: Use `page_size` instead. The maximum number of results + per page that can be returned. If the number of available results is + larger than `max_result_count`, a `next_page_token` is returned + which can be passed to `page_token` to get the next page of results + in subsequent requests. If 0 or no value is provided, a default of + 20 is used. The maximum value is 20; values above 20 will be coerced + to 20. Negative values will return an INVALID_ARGUMENT error. If + both `max_result_count` and `page_size` are specified, + `max_result_count` will be ignored. + deprecated: true format: int32 type: integer - endIndex: - type: integer - format: int32 - GoogleMapsPlacesV1Circle: - type: object - description: Circle with a LatLng as center and radius. - id: GoogleMapsPlacesV1Circle - properties: - radius: - description: >- - Required. Radius measured in meters. The radius must be within [0.0, - 50000.0]. - type: number - format: double - center: + textQuery: + description: Required. The text query for textual search. + type: string + pageToken: + type: string description: >- - Required. Center latitude and longitude. The range of latitude must - be within [-90.0, 90.0]. The range of the longitude must be within - [-180.0, 180.0]. - $ref: '#/components/schemas/GoogleTypeLatLng' - GoogleMapsPlacesV1SearchNearbyResponse: - description: 'Response proto for Search Nearby. ' - properties: - places: + Optional. A page token, received from a previous TextSearch call. + Provide this to retrieve the subsequent page. When paginating, all + parameters other than `page_token`, `page_size`, and + `max_result_count` provided to TextSearch must match the initial + call that provided the page token. Otherwise an INVALID_ARGUMENT + error is returned. + includedType: + type: string description: >- - A list of places that meets user's requirements like places types, - number of places and specific location restriction. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - type: array - id: GoogleMapsPlacesV1SearchNearbyResponse - type: object + The requested place type. Full list of types supported: + https://developers.google.com/maps/documentation/places/web-service/place-types. + Only support one included type. GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: description: >- The text highlighted by the justification. This is a subset of the @@ -573,118 +736,135 @@ components: text: type: string highlightedTextRanges: - type: array items: $ref: >- #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange + type: array description: The list of the ranges of the highlighted text. - GoogleMapsPlacesV1ContextualContentJustification: - id: GoogleMapsPlacesV1ContextualContentJustification - type: object - properties: - businessAvailabilityAttributesJustification: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. - reviewJustification: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Justifications for the place. Justifications answers - the question of why a place could interest an end user. - GoogleMapsPlacesV1PlaceAddressComponent: + GoogleGeoTypeViewport: + id: GoogleGeoTypeViewport type: object - id: GoogleMapsPlacesV1PlaceAddressComponent properties: - languageCode: - type: string - description: The language used to format this components, in CLDR notation. - types: - type: array - items: - type: string - description: An array indicating the type(s) of the address component. - longText: - type: string - description: >- - The full text description or name of the address component. For - example, an address component for the country Australia may have a - long_name of "Australia". - shortText: - type: string - description: >- - An abbreviated textual name for the address component, if available. - For example, an address component for the country of Australia may - have a short_name of "AU". + high: + description: Required. The high point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + low: + description: Required. The low point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' description: >- - The structured components that form the formatted address, if this - information is available. + A latitude-longitude viewport, represented as two diagonally opposite + `low` and `high` points. A viewport is considered a closed region, i.e. + it includes its boundary. The latitude bounds must range between -90 to + 90 degrees inclusive, and the longitude bounds must range between -180 + to 180 degrees inclusive. Various cases include: - If `low` = `high`, + the viewport consists of that single point. - If `low.longitude` > + `high.longitude`, the longitude range is inverted (the viewport crosses + the 180 degree longitude line). - If `low.longitude` = -180 degrees and + `high.longitude` = 180 degrees, the viewport includes all longitudes. - + If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, + the longitude range is empty. - If `low.latitude` > `high.latitude`, the + latitude range is empty. Both `low` and `high` must be populated, and + the represented box cannot be empty (as specified by the definitions + above). An empty viewport will result in an error. For example, this + viewport fully encloses New York City: { "low": { "latitude": 40.477398, + "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": + -73.70018 } } GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification: + id: >- + GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + type: object description: >- Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. BusinessAvailabilityAttributes justifications. This shows some attributes a business has that could interest an end user. properties: - takeout: - description: If a place provides takeout. - type: boolean dineIn: type: boolean description: If a place provides dine-in. + takeout: + type: boolean + description: If a place provides takeout. delivery: description: If a place provides delivery. type: boolean - id: >- - GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + GoogleMapsPlacesV1PlacePaymentOptions: + properties: + acceptsNfc: + type: boolean + description: Place accepts NFC payments. + acceptsCreditCards: + description: Place accepts credit cards as payment. + type: boolean + acceptsCashOnly: + description: >- + Place accepts cash only as payment. Places with this attribute may + still accept other payment methods. + type: boolean + acceptsDebitCards: + description: Place accepts debit cards as payment. + type: boolean type: object - GoogleMapsPlacesV1SearchNearbyRequest: - description: 'Request proto for Search Nearby. ' + description: Payment options the place accepts. + id: GoogleMapsPlacesV1PlacePaymentOptions + GoogleMapsPlacesV1Review: type: object + description: Information about a review of a place. + id: GoogleMapsPlacesV1Review properties: - includedPrimaryTypes: - type: array - items: - type: string + originalText: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The review text in its original language. + relativePublishTimeDescription: description: >- - Included primary Place type (e.g. "restaurant" or "gas_station") - from - https://developers.google.com/maps/documentation/places/web-service/place-types. - A place can only have a single primary type from the supported types - table associated with it. Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting primary types, i.e. a - type appears in both included_primary_types and - excluded_primary_types, an INVALID_ARGUMENT error is returned. If a - Place type is specified with multiple type restrictions, only places - that satisfy all of the restrictions are returned. For example, if - we have {included_types = ["restaurant"], excluded_primary_types = - ["restaurant"]}, the returned places provide "restaurant" related - services but do not operate primarily as "restaurants". - maxResultCount: + A string of formatted recent time, expressing the review time + relative to the current time in a form appropriate for the language + and country. + type: string + rating: + type: number + format: double + description: A number between 1.0 and 5.0, also called the number of stars. + text: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The localized text of the review. + authorAttribution: + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + description: This review's author. + publishTime: + type: string + description: Timestamp for the review. + format: google-datetime + name: description: >- - Maximum number of results to return. It must be between 1 and 20 - (default), inclusively. If the number is unset, it falls back to the - upper limit. If the number is set to negative or exceeds the upper - limit, an INVALID_ARGUMENT error is returned. + A reference representing this place review which may be used to look + up this place review again (also called the API "resource" name: + `places/{place_id}/reviews/{review}`). + type: string + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: + type: object + properties: + startOffset: + description: >- + Zero-based offset of the first Unicode character of the string + (inclusive). + format: int32 type: integer + endOffset: + description: Zero-based offset of the last Unicode character (exclusive). format: int32 - excludedPrimaryTypes: - type: array + type: integer + description: Identifies a substring within a given text. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + GoogleMapsPlacesV1SearchNearbyRequest: + properties: + includedPrimaryTypes: description: >- - Excluded primary Place type (e.g. "restaurant" or "gas_station") + Included primary Place type (e.g. "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table + A place can only have a single primary type from the supported types + table associated with it. Up to 50 types from [Table A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) may be specified. If there are any conflicting primary types, i.e. a type appears in both included_primary_types and @@ -696,27 +876,19 @@ components: services but do not operate primarily as "restaurants". items: type: string - includedTypes: type: array - items: - type: string + routingParameters: + description: Optional. Parameters that affect the routing to the search results. + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' + maxResultCount: + type: integer + format: int32 description: >- - Included Place type (eg, "restaurant" or "gas_station") from - https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting types, i.e. a type - appears in both included_types and excluded_types, an - INVALID_ARGUMENT error is returned. If a Place type is specified - with multiple type restrictions, only places that satisfy all of the - restrictions are returned. For example, if we have {included_types = - ["restaurant"], excluded_primary_types = ["restaurant"]}, the - returned places provide "restaurant" related services but do not - operate primarily as "restaurants". + Maximum number of results to return. It must be between 1 and 20 + (default), inclusively. If the number is unset, it falls back to the + upper limit. If the number is set to negative or exceeds the upper + limit, an INVALID_ARGUMENT error is returned. excludedTypes: - type: array - items: - type: string description: >- Excluded Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. @@ -734,389 +906,282 @@ components: ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants". - regionCode: - type: string - description: >- - The Unicode country/region code (CLDR) of the location where the - request is coming from. This parameter is used to display the place - details, like region-specific place name, if available. The - parameter can affect results based on applicable law. For more - information, see - https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. - Note that 3-digit region codes are not currently supported. - languageCode: - type: string + type: array + items: + type: string + excludedPrimaryTypes: + items: + type: string description: >- - Place details will be displayed with the preferred language if - available. If the language code is unspecified or unrecognized, - place details of any language may be returned, with a preference for - English if such details exist. Current list of supported languages: - https://developers.google.com/maps/faq#languagesupport. + Excluded primary Place type (e.g. "restaurant" or "gas_station") + from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting primary types, i.e. a + type appears in both included_primary_types and + excluded_primary_types, an INVALID_ARGUMENT error is returned. If a + Place type is specified with multiple type restrictions, only places + that satisfy all of the restrictions are returned. For example, if + we have {included_types = ["restaurant"], excluded_primary_types = + ["restaurant"]}, the returned places provide "restaurant" related + services but do not operate primarily as "restaurants". + type: array locationRestriction: description: Required. The region to search. $ref: >- #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction rankPreference: - type: string - description: How results will be ranked in the response. enumDescriptions: - >- RankPreference value not set. Will use rank by POPULARITY by default. - Ranks results by distance. - Ranks results by popularity. - enum: - - RANK_PREFERENCE_UNSPECIFIED - - DISTANCE - - POPULARITY - id: GoogleMapsPlacesV1SearchNearbyRequest - GoogleMapsPlacesV1FuelOptionsFuelPrice: - properties: - price: - $ref: '#/components/schemas/GoogleTypeMoney' - description: The price of the fuel. - type: - enum: - - FUEL_TYPE_UNSPECIFIED - - DIESEL - - REGULAR_UNLEADED - - MIDGRADE - - PREMIUM - - SP91 - - SP91_E10 - - SP92 - - SP95 - - SP95_E10 - - SP98 - - SP99 - - SP100 - - LPG - - E80 - - E85 - - METHANE - - BIO_DIESEL - - TRUCK_DIESEL - enumDescriptions: - - Unspecified fuel type. - - Diesel fuel. - - Regular unleaded. - - Midgrade. - - Premium. - - SP 91. - - SP 91 E10. - - SP 92. - - SP 95. - - SP95 E10. - - SP 98. - - SP 99. - - SP 100. - - LPG. - - E 80. - - E 85. - - Methane. - - Bio-diesel. - - Truck diesel. - type: string - description: The type of fuel. - updateTime: - format: google-datetime - type: string - description: The time the fuel price was last updated. - id: GoogleMapsPlacesV1FuelOptionsFuelPrice - type: object - description: Fuel price information for a given type. - GoogleMapsPlacesV1SearchTextRequestLocationBias: - description: >- - The region to search. This location serves as a bias which means results - around given location might be returned. - id: GoogleMapsPlacesV1SearchTextRequestLocationBias - properties: - rectangle: - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: >- - A rectangle box defined by northeast and southwest corner. - `rectangle.high()` must be the northeast point of the rectangle - viewport. `rectangle.low()` must be the southwest point of the - rectangle viewport. `rectangle.low().latitude()` cannot be greater - than `rectangle.high().latitude()`. This will result in an empty - latitude range. A rectangle viewport cannot be wider than 180 - degrees. - circle: - description: A circle defined by center point and radius. - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - type: object - GoogleMapsPlacesV1PlaceAreaSummary: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the area that the place is in. - id: GoogleMapsPlacesV1PlaceAreaSummary - properties: - contentBlocks: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' - description: >- - Content blocks that compose the area summary. Each block has a - separate topic about the area. - type: object - GoogleMapsPlacesV1AutocompletePlacesResponse: - id: GoogleMapsPlacesV1AutocompletePlacesResponse - properties: - suggestions: - description: >- - Contains a list of suggestions, ordered in descending order of - relevance. - type: array - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion - description: Response proto for AutocompletePlaces. - type: object - GoogleMapsPlacesV1PlaceAttribution: - id: GoogleMapsPlacesV1PlaceAttribution - description: Information about data providers of this place. - properties: - provider: - description: Name of the Place's data provider. - type: string - providerUri: - type: string - description: URI to the Place's data provider. - type: object - GoogleMapsPlacesV1SearchTextResponse: - type: object - description: 'Response proto for SearchText. ' - properties: - places: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - type: array - description: A list of places that meet the user's text search criteria. - contextualContents: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. A list of contextual contents where each entry - associates to the corresponding place in the same index in the - places field. The contents that are relevant to the `text_query` in - the request are preferred. If the contextual content is not - available for one of the places, it will return non-contextual - content. It will be empty only when the content is unavailable for - this place. This list will have as many entries as the list of - places if requested. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' - nextPageToken: - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted or empty, there are no subsequent pages. - type: string - id: GoogleMapsPlacesV1SearchTextResponse - GoogleMapsPlacesV1PlaceParkingOptions: - properties: - paidStreetParking: - description: Place offers paid street parking. - type: boolean - paidParkingLot: - type: boolean - description: Place offers paid parking lots. - freeGarageParking: - description: Place offers free garage parking. - type: boolean - paidGarageParking: - description: Place offers paid garage parking. - type: boolean - freeParkingLot: - description: Place offers free parking lots. - type: boolean - freeStreetParking: - type: boolean - description: Place offers free street parking. - valetParking: - type: boolean - description: Place offers valet parking. - description: >- - Information about parking options for the place. A parking lot could - support more than one option at the same time. - type: object - id: GoogleMapsPlacesV1PlaceParkingOptions - GoogleMapsPlacesV1References: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Reference that the generative content is related to. - id: GoogleMapsPlacesV1References - properties: - places: + description: How results will be ranked in the response. + type: string + enum: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - POPULARITY + languageCode: + type: string description: >- - The list of resource names of the referenced places. This name can - be used in other APIs that accept Place resource names. + Place details will be displayed with the preferred language if + available. If the language code is unspecified or unrecognized, + place details of any language may be returned, with a preference for + English if such details exist. Current list of supported languages: + https://developers.google.com/maps/faq#languagesupport. + includedTypes: type: array + description: >- + Included Place type (eg, "restaurant" or "gas_station") from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting types, i.e. a type + appears in both included_types and excluded_types, an + INVALID_ARGUMENT error is returned. If a Place type is specified + with multiple type restrictions, only places that satisfy all of the + restrictions are returned. For example, if we have {included_types = + ["restaurant"], excluded_primary_types = ["restaurant"]}, the + returned places provide "restaurant" related services but do not + operate primarily as "restaurants". items: type: string - reviews: - description: Reviews that serve as references. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - type: array - type: object - GoogleMapsPlacesV1PlaceSubDestination: - description: >- - Place resource name and id of sub destinations that relate to the place. - For example, different terminals are different destinations of an - airport. - properties: - name: - type: string - description: The resource name of the sub destination. - id: + regionCode: type: string - description: The place id of the sub destination. - id: GoogleMapsPlacesV1PlaceSubDestination + description: >- + The Unicode country/region code (CLDR) of the location where the + request is coming from. This parameter is used to display the place + details, like region-specific place name, if available. The + parameter can affect results based on applicable law. For more + information, see + https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. + Note that 3-digit region codes are not currently supported. + id: GoogleMapsPlacesV1SearchNearbyRequest + description: 'Request proto for Search Nearby. ' type: object - GoogleMapsPlacesV1PlaceOpeningHoursPeriod: - description: A period the place remains in open_now status. - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod + GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: type: object + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. User review justifications. This highlights a section + of the user review that would interest an end user. For instance, if the + search query is "firewood pizza", the review justification highlights + the text relevant to the search query. + id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification properties: - open: - description: The time that the place starts to be open. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - close: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - description: The time that the place starts to be closed. - GoogleMapsPlacesV1PlacePaymentOptions: - id: GoogleMapsPlacesV1PlacePaymentOptions - description: Payment options the place accepts. + highlightedText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText + review: + description: The review that the highlighted text is generated from. + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + GoogleMapsPlacesV1SearchTextRequestLocationBias: + properties: + circle: + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: A circle defined by center point and radius. + rectangle: + $ref: '#/components/schemas/GoogleGeoTypeViewport' + description: >- + A rectangle box defined by northeast and southwest corner. + `rectangle.high()` must be the northeast point of the rectangle + viewport. `rectangle.low()` must be the southwest point of the + rectangle viewport. `rectangle.low().latitude()` cannot be greater + than `rectangle.high().latitude()`. This will result in an empty + latitude range. A rectangle viewport cannot be wider than 180 + degrees. + id: GoogleMapsPlacesV1SearchTextRequestLocationBias type: object + description: >- + The region to search. This location serves as a bias which means results + around given location might be returned. + GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint properties: - acceptsDebitCards: - type: boolean - description: Place accepts debit cards as payment. - acceptsNfc: - type: boolean - description: Place accepts NFC payments. - acceptsCashOnly: + day: + format: int32 + type: integer description: >- - Place accepts cash only as payment. Places with this attribute may - still accept other payment methods. - type: boolean - acceptsCreditCards: + A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is + Monday, etc. + minute: + type: integer + format: int32 + description: The minute in 2 digits. Ranges from 00 to 59. + truncated: type: boolean - description: Place accepts credit cards as payment. - GoogleTypeLatLng: - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. + description: >- + Whether or not this endpoint was truncated. Truncation occurs when + the real hours are outside the times we are willing to return hours + between, so we truncate the hours back to these boundaries. This + ensures that at most 24 * 7 hours from midnight of the day of the + request are returned. + hour: + format: int32 + description: The hour in 2 digits. Ranges from 00 to 23. + type: integer + date: + $ref: '#/components/schemas/GoogleTypeDate' + description: Date in the local timezone for the place. + description: Status changing points. type: object - id: GoogleTypeLatLng + GoogleMapsPlacesV1PhotoMedia: + type: object + description: A photo media from Places API. properties: - longitude: - type: number - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - format: double - latitude: - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - format: double - type: number + photoUri: + description: A short-lived uri that can be used to render the photo. + type: string + name: + type: string + description: >- + The resource name of a photo media in the format: + `places/{place_id}/photos/{photo_reference}/media`. + id: GoogleMapsPlacesV1PhotoMedia GoogleMapsPlacesV1Place: + id: GoogleMapsPlacesV1Place properties: - servesBeer: - type: boolean - description: Specifies if the place serves beer. - goodForChildren: - description: Place is good for children. - type: boolean - utcOffsetMinutes: - format: int32 + areaSummary: description: >- - Number of minutes this place's timezone is currently offset from - UTC. This is expressed in minutes to support timezones that are - offset by fractions of an hour, e.g. X hours and 15 minutes. - type: integer - servesWine: + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the area that the place is + in. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAreaSummary' + goodForGroups: + description: Place accommodates groups. type: boolean - description: Specifies if the place serves wine. - parkingOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' - description: Options of parking provided by the place. - fuelOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' - description: >- - The most recent information about fuel options in a gas station. - This information is updated regularly. - photos: - type: array + attributions: + description: A set of data provider that must be shown with this result. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' - description: >- - Information (including references) about photos of this place. A - maximum of 10 photos can be returned. - servesCocktails: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' + type: array + allowsDogs: type: boolean - description: Place serves cocktails. + description: Place allows dogs. + menuForChildren: + description: Place has a children's menu. + type: boolean + paymentOptions: + description: >- + Payment options the place accepts. If a payment option data is not + available, the payment option field will be unset. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions' + iconBackgroundColor: + description: 'Background color for icon_mask in hex format, e.g. #909CE1.' + type: string servesDessert: description: Place serves dessert. type: boolean - servesLunch: + takeout: + description: Specifies if the business supports takeout. type: boolean - description: Specifies if the place serves lunch. - reviews: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: >- - List of reviews about this place, sorted by relevance. A maximum of - 5 reviews can be returned. - iconMaskBaseUri: - description: >- - A truncated URL to an icon mask. User can access different icon type - by appending type suffix to the end (eg, ".svg" or ".png"). + id: type: string - location: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: The position of this place. - liveMusic: + description: The unique identifier of a place. + servesCocktails: + description: Place serves cocktails. type: boolean - description: Place provides live music. - menuForChildren: - description: Place has a children's menu. + servesBreakfast: + description: Specifies if the place serves breakfast. + type: boolean + servesLunch: + type: boolean + description: Specifies if the place serves lunch. + evChargeOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' + description: Information of ev charging options. + reservable: type: boolean + description: Specifies if the place supports reservations. shortFormattedAddress: type: string description: A short, human-readable address for this place. - userRatingCount: - format: int32 - description: The total number of reviews (with or without text) for this place. - type: integer + dineIn: + description: >- + Specifies if the business supports indoor or outdoor seating + options. + type: boolean + fuelOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' + description: >- + The most recent information about fuel options in a gas station. + This information is updated regularly. + restroom: + description: Place has restroom. + type: boolean + parkingOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' + description: Options of parking provided by the place. primaryType: - type: string description: >- The primary type of the given result. This type must one of the Places API supported types. For example, "restaurant", "cafe", "airport", etc. A place can only have a single primary type. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types + type: string + editorialSummary: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: >- + Contains a summary of the place. A summary is comprised of a textual + overview, and also includes the language code for these if + applicable. Summary text must be presented as-is and can not be + modified or altered. + servesBrunch: + type: boolean + description: Specifies if the place serves brunch. + generativeSummary: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGenerativeSummary' + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the place. businessStatus: description: The business status for the place. - enumDescriptions: - - Default value. This value is unused. - - The establishment is operational, not necessarily open now. - - The establishment is temporarily closed. - - The establishment is permanently closed. enum: - BUSINESS_STATUS_UNSPECIFIED - OPERATIONAL - CLOSED_TEMPORARILY - CLOSED_PERMANENTLY type: string - takeout: - description: Specifies if the business supports takeout. - type: boolean + enumDescriptions: + - Default value. This value is unused. + - The establishment is operational, not necessarily open now. + - The establishment is temporarily closed. + - The establishment is permanently closed. + internationalPhoneNumber: + description: >- + A human-readable phone number for the place, in international + format. + type: string + googleMapsUri: + description: A URL providing more information about this place. + type: string regularSecondaryOpeningHours: description: >- Contains an array of entries for information about regular secondary @@ -1126,40 +1191,52 @@ components: the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. + type: array items: $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - type: array - displayName: - description: >- - The localized name of the place, suitable as a short human-readable - description. For example, "Google Sydney", "Starbucks", "Pyrmont", - etc. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - reservable: - description: Specifies if the place supports reservations. + outdoorSeating: type: boolean - addressComponents: - type: array + description: Place provides outdoor seating. + userRatingCount: + description: The total number of reviews (with or without text) for this place. + format: int32 + type: integer + viewport: description: >- - Repeated components for each locality level. Note the following - facts about the address_components[] array: - The array of address - components may contain more components than the formatted_address. - - The array does not necessarily include all the political entities - that contain an address, apart from those included in the - formatted_address. To retrieve all the political entities that - contain a specific address, you should use reverse geocoding, - passing the latitude/longitude of the address as a parameter to the - request. - The format of the response is not guaranteed to remain - the same between requests. In particular, the number of - address_components varies based on the address requested and can - change over time for the same address. A component can change - position in the array. The type of the component can change. A - particular component may be missing in a later response. + A viewport suitable for displaying the place on an average-sized + map. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + currentSecondaryOpeningHours: + description: >- + Contains an array of entries for the next seven days including + information about secondary hours of a business. Secondary hours are + different from a business's main hours. For example, a restaurant + can specify drive through hours or delivery hours as its secondary + hours. This field populates the type subfield, which draws from a + predefined list of opening hours types (such as DRIVE_THROUGH, + PICKUP, or TAKEOUT) based on the types of the place. This field + includes the special_days subfield of all hours, set for dates that + have exceptional hours. + type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent' - outdoorSeating: - description: Place provides outdoor seating. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + rating: + format: double + type: number + description: A rating between 1.0 and 5.0, based on user reviews of this place. + photos: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + type: array + description: >- + Information (including references) about photos of this place. A + maximum of 10 photos can be returned. + servesWine: + description: Specifies if the place serves wine. + type: boolean + liveMusic: type: boolean + description: Place provides live music. priceLevel: enumDescriptions: - Place price level is unspecified or unknown. @@ -1168,8 +1245,6 @@ components: - Place provides moderately priced services. - Place provides expensive services. - Place provides very expensive services. - description: Price level of the place. - type: string enum: - PRICE_LEVEL_UNSPECIFIED - PRICE_LEVEL_FREE @@ -1177,458 +1252,459 @@ components: - PRICE_LEVEL_MODERATE - PRICE_LEVEL_EXPENSIVE - PRICE_LEVEL_VERY_EXPENSIVE - rating: - format: double - type: number - description: A rating between 1.0 and 5.0, based on user reviews of this place. - currentOpeningHours: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - description: >- - The hours of operation for the next seven days (including today). - The time period starts at midnight on the date of the request and - ends at 11:59 pm six days later. This field includes the - special_days subfield of all hours, set for dates that have - exceptional hours. - areaSummary: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAreaSummary' - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the area that the place is - in. - primaryTypeDisplayName: - description: >- - The display name of the primary type, localized to the request - language if applicable. For the complete list of possible values, - see Table A and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types - $ref: '#/components/schemas/GoogleTypeLocalizedText' - restroom: - description: Place has restroom. - type: boolean - viewport: - description: >- - A viewport suitable for displaying the place on an average-sized - map. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - allowsDogs: - type: boolean - description: Place allows dogs. - evChargeOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' - description: Information of ev charging options. - delivery: + description: Price level of the place. + type: string + servesVegetarianFood: + description: Specifies if the place serves vegetarian food. type: boolean - description: Specifies if the business supports delivery. - servesBrunch: + servesBeer: + description: Specifies if the place serves beer. type: boolean - description: Specifies if the place serves brunch. - attributions: - description: A set of data provider that must be shown with this result. + adrFormatAddress: + description: >- + The place's address in adr microformat: + http://microformats.org/wiki/adr. + type: string + reviews: + description: >- + List of reviews about this place, sorted by relevance. A maximum of + 5 reviews can be returned. type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + location: + description: The position of this place. + $ref: '#/components/schemas/GoogleTypeLatLng' websiteUri: - type: string description: >- The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain. - iconBackgroundColor: type: string - description: 'Background color for icon_mask in hex format, e.g. #909CE1.' - goodForGroups: - description: Place accommodates groups. + servesDinner: + description: Specifies if the place serves dinner. type: boolean - id: - description: The unique identifier of a place. + nationalPhoneNumber: type: string + description: A human-readable phone number for the place, in national format. plusCode: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' description: Plus code of the place location lat/long. - paymentOptions: - description: >- - Payment options the place accepts. If a payment option data is not - available, the payment option field will be unset. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions' - name: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' + currentOpeningHours: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' description: >- - This Place's resource name, in `places/{place_id}` format. Can be - used to look up the Place. + The hours of operation for the next seven days (including today). + The time period starts at midnight on the date of the request and + ends at 11:59 pm six days later. This field includes the + special_days subfield of all hours, set for dates that have + exceptional hours. + curbsidePickup: + description: Specifies if the business supports curbside pickup. + type: boolean + iconMaskBaseUri: type: string - generativeSummary: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGenerativeSummary' description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the place. - servesVegetarianFood: - description: Specifies if the place serves vegetarian food. - type: boolean - servesDinner: - type: boolean - description: Specifies if the place serves dinner. - dineIn: + A truncated URL to an icon mask. User can access different icon type + by appending type suffix to the end (eg, ".svg" or ".png"). + displayName: description: >- - Specifies if the business supports indoor or outdoor seating - options. - type: boolean - formattedAddress: - type: string - description: A full, human-readable address for this place. + The localized name of the place, suitable as a short human-readable + description. For example, "Google Sydney", "Starbucks", "Pyrmont", + etc. + $ref: '#/components/schemas/GoogleTypeLocalizedText' goodForWatchingSports: type: boolean description: Place is suitable for watching sports. - servesBreakfast: - description: Specifies if the place serves breakfast. - type: boolean - currentSecondaryOpeningHours: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + types: description: >- - Contains an array of entries for the next seven days including - information about secondary hours of a business. Secondary hours are - different from a business's main hours. For example, a restaurant - can specify drive through hours or delivery hours as its secondary - hours. This field populates the type subfield, which draws from a - predefined list of opening hours types (such as DRIVE_THROUGH, - PICKUP, or TAKEOUT) based on the types of the place. This field - includes the special_days subfield of all hours, set for dates that - have exceptional hours. - subDestinations: + A set of type tags for this result. For example, "political" and + "locality". For the complete list of possible values, see Table A + and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' - description: A list of sub destinations related to the place. - internationalPhoneNumber: + type: string + primaryTypeDisplayName: + $ref: '#/components/schemas/GoogleTypeLocalizedText' description: >- - A human-readable phone number for the place, in international - format. - type: string - googleMapsUri: - type: string - description: A URL providing more information about this place. + The display name of the primary type, localized to the request + language if applicable. For the complete list of possible values, + see Table A and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types regularOpeningHours: $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' description: The regular hours of operation. servesCoffee: type: boolean description: Place serves coffee. - curbsidePickup: - type: boolean - description: Specifies if the business supports curbside pickup. - editorialSummary: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: >- - Contains a summary of the place. A summary is comprised of a textual - overview, and also includes the language code for these if - applicable. Summary text must be presented as-is and can not be - modified or altered. - nationalPhoneNumber: - description: A human-readable phone number for the place, in national format. - type: string accessibilityOptions: description: Information about the accessibility options a place offers. $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' - adrFormatAddress: + utcOffsetMinutes: + type: integer + format: int32 description: >- - The place's address in adr microformat: - http://microformats.org/wiki/adr. + Number of minutes this place's timezone is currently offset from + UTC. This is expressed in minutes to support timezones that are + offset by fractions of an hour, e.g. X hours and 15 minutes. + goodForChildren: + description: Place is good for children. + type: boolean + delivery: + type: boolean + description: Specifies if the business supports delivery. + formattedAddress: + description: A full, human-readable address for this place. type: string - types: + subDestinations: type: array + description: A list of sub destinations related to the place. items: - type: string + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' + name: + type: string description: >- - A set of type tags for this result. For example, "political" and - "locality". For the complete list of possible values, see Table A - and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types - id: GoogleMapsPlacesV1Place - type: object + This Place's resource name, in `places/{place_id}` format. Can be + used to look up the Place. + addressComponents: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent' + description: >- + Repeated components for each locality level. Note the following + facts about the address_components[] array: - The array of address + components may contain more components than the formatted_address. - + The array does not necessarily include all the political entities + that contain an address, apart from those included in the + formatted_address. To retrieve all the political entities that + contain a specific address, you should use reverse geocoding, + passing the latitude/longitude of the address as a parameter to the + request. - The format of the response is not guaranteed to remain + the same between requests. In particular, the number of + address_components varies based on the address requested and can + change over time for the same address. A component can change + position in the array. The type of the component can change. A + particular component may be missing in a later response. description: All the information representing a Place. - GoogleMapsPlacesV1Review: + type: object + GoogleMapsPlacesV1EVChargeOptions: properties: - rating: - description: A number between 1.0 and 5.0, also called the number of stars. + connectorAggregation: + type: array + description: >- + A list of EV charging connector aggregations that contain connectors + of the same type and same charge rate. + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + connectorCount: + format: int32 + description: >- + Number of connectors at this station. However, because some ports + can have multiple connectors but only be able to charge one car at a + time (e.g.) the number of connectors may be greater than the total + number of cars which can charge simultaneously. + type: integer + id: GoogleMapsPlacesV1EVChargeOptions + type: object + description: >- + Information about the EV Charge Station hosted in Place. Terminology + follows https://afdc.energy.gov/fuels/electricity_infrastructure.html + One port could charge one car at a time. One port has one or more + connectors. One station has one or more ports. + GoogleMapsPlacesV1ContentBlock: + description: A block of content that can be served individually. + id: GoogleMapsPlacesV1ContentBlock + properties: + topic: + type: string + description: The topic of the content, for example "overview" or "restaurant". + content: + description: Content related to the topic. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + references: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. References that are related to this block of + content. + $ref: '#/components/schemas/GoogleMapsPlacesV1References' + type: object + GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: + properties: + count: + type: integer + description: Number of connectors in this aggregation. + format: int32 + availableCount: + format: int32 + type: integer + description: >- + Number of connectors in this aggregation that are currently + available. + maxChargeRateKw: format: double type: number - publishTime: - type: string - description: Timestamp for the review. - format: google-datetime - name: + description: >- + The static max charging rate in kw of each connector in the + aggregation. + outOfServiceCount: + description: >- + Number of connectors in this aggregation that are currently out of + service. + format: int32 + type: integer + availabilityLastUpdateTime: type: string description: >- - A reference representing this place review which may be used to look - up this place review again (also called the API "resource" name: - `places/{place_id}/reviews/{review}`). - originalText: - description: The review text in its original language. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - relativePublishTimeDescription: + The timestamp when the connector availability information in this + aggregation was last updated. + format: google-datetime + type: type: string + description: The connector type of this aggregation. + enumDescriptions: + - Unspecified connector. + - Other connector types. + - J1772 type 1 connector. + - IEC 62196 type 2 connector. Often referred to as MENNEKES. + - CHAdeMO type connector. + - >- + Combined Charging System (AC and DC). Based on SAE. Type-1 J-1772 + connector + - >- + Combined Charging System (AC and DC). Based on Type-2 Mennekes + connector + - >- + The generic TESLA connector. This is NACS in the North America but + can be non-NACS in other parts of the world (e.g. CCS Combo 2 + (CCS2) or GB/T). This value is less representative of an actual + connector type, and more represents the ability to charge a Tesla + brand vehicle at a Tesla owned charging station. + - >- + GB/T type corresponds to the GB/T standard in China. This type + covers all GB_T types. + - Unspecified wall outlet. + enum: + - EV_CONNECTOR_TYPE_UNSPECIFIED + - EV_CONNECTOR_TYPE_OTHER + - EV_CONNECTOR_TYPE_J1772 + - EV_CONNECTOR_TYPE_TYPE_2 + - EV_CONNECTOR_TYPE_CHADEMO + - EV_CONNECTOR_TYPE_CCS_COMBO_1 + - EV_CONNECTOR_TYPE_CCS_COMBO_2 + - EV_CONNECTOR_TYPE_TESLA + - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T + - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET + id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + description: >- + EV charging information grouped by [type, max_charge_rate_kw]. Shows EV + charge aggregation of connectors that have the same type and max charge + rate in kw. + type: object + GoogleMapsPlacesV1RoutingSummary: + properties: + legs: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummaryLeg' description: >- - A string of formatted recent time, expressing the review time - relative to the current time in a form appropriate for the language - and country. - authorAttribution: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - description: This review's author. - text: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The localized text of the review. - description: Information about a review of a place. + The legs of the trip. When you calculate travel duration and + distance from a set origin, `legs` contains a single leg containing + the duration and distance from the origin to the destination. When + you do a search along route, `legs` contains two legs: one from the + origin to place, and one from the place to the destination. + type: array type: object - id: GoogleMapsPlacesV1Review + id: GoogleMapsPlacesV1RoutingSummary + description: >- + The duration and distance from the routing origin to a place in the + response, and a second leg from that place to the destination, if + requested. **Note:** Adding `routingSummaries` in the field mask without + also including either the `routingParameters.origin` parameter or the + `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the + request causes an error. GoogleMapsPlacesV1SearchTextRequestLocationRestriction: + type: object description: >- The region to search. This location serves as a restriction which means results outside given location will not be returned. + id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction properties: rectangle: + $ref: '#/components/schemas/GoogleGeoTypeViewport' description: >- A rectangle box defined by northeast and southwest corner. `rectangle.high()` must be the northeast point of the rectangle viewport. `rectangle.low()` must be the southwest point of the - rectangle viewport. `rectangle.low().latitude()` cannot be greater - than `rectangle.high().latitude()`. This will result in an empty - latitude range. A rectangle viewport cannot be wider than 180 - degrees. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - type: object - id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction - GoogleTypeMoney: - description: Represents an amount of money with its currency type. + rectangle viewport. `rectangle.low().latitude()` cannot be greater + than `rectangle.high().latitude()`. This will result in an empty + latitude range. A rectangle viewport cannot be wider than 180 + degrees. + GoogleMapsPlacesV1SearchNearbyResponse: type: object + id: GoogleMapsPlacesV1SearchNearbyResponse + description: 'Response proto for Search Nearby. ' properties: - units: - format: int64 - type: string + routingSummaries: + type: array description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - nanos: + A list of routing summaries where each entry associates to the + corresponding place in the same index in the `places` field. If the + routing summary is not available for one of the places, it will + contain an empty entry. This list should have as many entries as the + list of places if requested. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' + places: + type: array description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - id: GoogleTypeMoney - GoogleMapsPlacesV1SearchTextRequest: + A list of places that meets user's requirements like places types, + number of places and specific location restriction. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: + description: >- + Text representing a Place or query prediction. The text may be used as + is or formatted. type: object - description: 'Request proto for SearchText. ' - id: GoogleMapsPlacesV1SearchTextRequest + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText properties: - pageToken: - description: >- - Optional. A page token, received from a previous TextSearch call. - Provide this to retrieve the subsequent page. When paginating, all - parameters other than `page_token`, `page_size`, and - `max_result_count` provided to TextSearch must match the initial - call that provided the page token. Otherwise an INVALID_ARGUMENT - error is returned. - type: string - languageCode: + text: type: string + description: Text that may be used as is or formatted with `matches`. + matches: description: >- - Place details will be displayed with the preferred language if - available. If the language code is unspecified or unrecognized, - place details of any language may be returned, with a preference for - English if such details exist. Current list of supported languages: - https://developers.google.com/maps/faq#languagesupport. - openNow: - description: >- - Used to restrict the search to places that are currently open. The - default is false. - type: boolean - locationRestriction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction - description: >- - The region to search. This location serves as a restriction which - means results outside given location will not be returned. Cannot be - set along with location_bias. - locationBias: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationBias' + A list of string ranges identifying where the input request matched + in `text`. The ranges can be used to format specific parts of + `text`. The substrings may not be exact matches of `input` if the + matching was determined by criteria other than string matching (for + example, spell corrections or transliterations). These values are + Unicode character offsets of `text`. The ranges are guaranteed to be + ordered in increasing offset values. + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + type: array + GoogleMapsPlacesV1References: + properties: + places: + type: array description: >- - The region to search. This location serves as a bias which means - results around given location might be returned. Cannot be set along - with location_restriction. - priceLevels: + The list of resource names of the referenced places. This name can + be used in other APIs that accept Place resource names. items: - enum: - - PRICE_LEVEL_UNSPECIFIED - - PRICE_LEVEL_FREE - - PRICE_LEVEL_INEXPENSIVE - - PRICE_LEVEL_MODERATE - - PRICE_LEVEL_EXPENSIVE - - PRICE_LEVEL_VERY_EXPENSIVE - enumDescriptions: - - Place price level is unspecified or unknown. - - Place provides free services. - - Place provides inexpensive services. - - Place provides moderately priced services. - - Place provides expensive services. - - Place provides very expensive services. type: string + reviews: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' type: array - description: >- - Used to restrict the search to places that are marked as certain - price levels. Users can choose any combinations of price levels. - Default to select all price levels. - includedType: - type: string - description: >- - The requested place type. Full list of types supported: - https://developers.google.com/maps/documentation/places/web-service/place-types. - Only support one included type. - rankPreference: - enumDescriptions: - - >- - For a categorical query such as "Restaurants in New York City", - RELEVANCE is the default. For non-categorical queries such as - "Mountain View, CA" we recommend that you leave rankPreference - unset. - - Ranks results by distance. - - >- - Ranks results by relevance. Sort order determined by normal - ranking stack. - enum: - - RANK_PREFERENCE_UNSPECIFIED - - DISTANCE - - RELEVANCE - description: How results will be ranked in the response. - type: string - regionCode: + description: Reviews that serve as references. + type: object + id: GoogleMapsPlacesV1References + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Reference that the generative content is related to. + GoogleTypeLocalizedText: + properties: + text: type: string description: >- - The Unicode country/region code (CLDR) of the location where the - request is coming from. This parameter is used to display the place - details, like region-specific place name, if available. The - parameter can affect results based on applicable law. For more - information, see - https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. - Note that 3-digit region codes are not currently supported. - maxResultCount: - deprecated: true - description: >- - Deprecated: Use `page_size` instead. The maximum number of results - per page that can be returned. If the number of available results is - larger than `max_result_count`, a `next_page_token` is returned - which can be passed to `page_token` to get the next page of results - in subsequent requests. If 0 or no value is provided, a default of - 20 is used. The maximum value is 20; values above 20 will be coerced - to 20. Negative values will return an INVALID_ARGUMENT error. If - both `max_result_count` and `page_size` are specified, - `max_result_count` will be ignored. - type: integer - format: int32 - evOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' - description: Optional. Set the searchable EV options of a place search request. - textQuery: + Localized string in the language corresponding to language_code + below. + languageCode: type: string - description: Required. The text query for textual search. - pageSize: - format: int32 - description: >- - Optional. The maximum number of results per page that can be - returned. If the number of available results is larger than - `page_size`, a `next_page_token` is returned which can be passed to - `page_token` to get the next page of results in subsequent requests. - If 0 or no value is provided, a default of 20 is used. The maximum - value is 20; values above 20 will be set to 20. Negative values will - return an INVALID_ARGUMENT error. If both `max_result_count` and - `page_size` are specified, `max_result_count` will be ignored. - type: integer - strictTypeFiltering: - type: boolean description: >- - Used to set strict type filtering for included_type. If set to true, - only results of the same type will be returned. Default to false. - minRating: - format: double - type: number - description: >- - Filter out results whose average user rating is strictly less than - this limit. A valid value must be a float between 0 and 5 - (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] - inclusively. The input rating will round up to the nearest - 0.5(ceiling). For instance, a rating of 0.6 will eliminate all - results with a less than 1.0 rating. - GoogleMapsPlacesV1Photo: - id: GoogleMapsPlacesV1Photo - description: Information about a photo of a place. + The text's BCP-47 language code, such as "en-US" or "sr-Latn". For + more information, see + http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + id: GoogleTypeLocalizedText + type: object + description: Localized variant of a text in a particular language. + GoogleMapsPlacesV1PlaceGenerativeSummary: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the place. + id: GoogleMapsPlacesV1PlaceGenerativeSummary properties: - widthPx: - type: integer - description: The maximum available width, in pixels. - format: int32 - name: - type: string - description: >- - Identifier. A reference representing this place photo which may be - used to look up this place photo again (also called the API - "resource" name: `places/{place_id}/photos/{photo}`). - heightPx: - type: integer - description: The maximum available height, in pixels. - format: int32 - authorAttributions: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - description: This photo's authors. - type: array + description: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The detailed description of the place. + references: + description: References that are used to generate the summary description. + $ref: '#/components/schemas/GoogleMapsPlacesV1References' + overview: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The overview of the place. type: object - GoogleMapsPlacesV1EVChargeOptions: - id: GoogleMapsPlacesV1EVChargeOptions + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: + properties: + text: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: >- + The predicted text. This text does not represent a Place, but rather + a text query that could be used in a search endpoint (for example, + Text Search). `text` is recommended for developers who wish to show + a single UI element. Developers who wish to show two separate, but + related, UI elements may want to use `structured_format` instead. + They are two different ways to represent a query prediction. Users + should not try to parse `structured_format` into `text` or vice + versa. May be in mixed languages if the request `input` and + `language_code` are in different languages or if part of the query + does not have a translation from the local language to + `language_code`. + structuredFormat: + description: >- + A breakdown of the query prediction into main text containing the + query and secondary text containing additional disambiguating + features (such as a city or region). `structured_format` is + recommended for developers who wish to show two separate, but + related, UI elements. Developers who wish to show a single UI + element may want to use `text` instead. They are two different ways + to represent a query prediction. Users should not try to parse + `structured_format` into `text` or vice versa. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat type: object + description: Prediction results for a Query Autocomplete prediction. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + GoogleMapsPlacesV1AutocompletePlacesResponse: + description: Response proto for AutocompletePlaces. properties: - connectorAggregation: - description: >- - A list of EV charging connector aggregations that contain connectors - of the same type and same charge rate. + suggestions: type: array items: $ref: >- - #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation - connectorCount: + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion description: >- - Number of connectors at this station. However, because some ports - can have multiple connectors but only be able to charge one car at a - time (e.g.) the number of connectors may be greater than the total - number of cars which can charge simultaneously. + Contains a list of suggestions, ordered in descending order of + relevance. + type: object + id: GoogleMapsPlacesV1AutocompletePlacesResponse + GoogleMapsPlacesV1RoutingSummaryLeg: + properties: + duration: + description: The time it takes to complete this leg of the trip. + type: string + format: google-duration + distanceMeters: type: integer format: int32 - description: >- - Information about the EV Charge Station hosted in Place. Terminology - follows https://afdc.energy.gov/fuels/electricity_infrastructure.html - One port could charge one car at a time. One port has one or more - connectors. One station has one or more ports. - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion - properties: - queryPrediction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction - description: A prediction for a query. - placePrediction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction - description: A prediction for a Place. - description: An Autocomplete suggestion result. + description: The distance of this leg of the trip. + description: A leg is a single portion of a journey from one location to another. + id: GoogleMapsPlacesV1RoutingSummaryLeg type: object GoogleMapsPlacesV1PlacePlusCode: + description: >- + Plus code (http://plus.codes) is a location reference with two formats: + global code defining a 14mx14m (1/8000th of a degree) or smaller + rectangle, and compound code, replacing the prefix with a reference + location. + type: object + id: GoogleMapsPlacesV1PlacePlusCode properties: globalCode: type: string @@ -1641,320 +1717,453 @@ components: containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity. type: string - id: GoogleMapsPlacesV1PlacePlusCode - type: object + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: + properties: + secondaryText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: >- + Represents additional disambiguating features (such as a city or + region) to further identify the Place or refine the query. + mainText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: Represents the name of the Place or query. description: >- - Plus code (http://plus.codes) is a location reference with two formats: - global code defining a 14mx14m (1/8000th of a degree) or smaller - rectangle, and compound code, replacing the prefix with a reference - location. - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: + Contains a breakdown of a Place or query prediction into main text and + secondary text. For Place predictions, the main text contains the + specific name of the Place. For query predictions, the main text + contains the query. The secondary text contains additional + disambiguating features (such as a city or region) to further identify + the Place or refine the query. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + type: object + GoogleMapsPlacesV1ContextualContent: properties: - text: - type: string - description: Text that may be used as is or formatted with `matches`. - matches: - type: array + justifications: description: >- - A list of string ranges identifying where the input request matched - in `text`. The ranges can be used to format specific parts of - `text`. The substrings may not be exact matches of `input` if the - matching was determined by criteria other than string matching (for - example, spell corrections or transliterations). These values are - Unicode character offsets of `text`. The ranges are guaranteed to be - ordered in increasing offset values. + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. + type: array items: $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification + photos: + description: >- + Information (including references) about photos of this place, + contexual to the place query. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + reviews: + description: List of reviews about this place, contexual to the place query. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Content that is contextual to the place query. type: object - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + id: GoogleMapsPlacesV1ContextualContent + GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: + type: object + properties: + circle: + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: A circle defined by center point and radius. + description: The region to search. + id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + GoogleMapsPlacesV1RoutingParameters: description: >- - Text representing a Place or query prediction. The text may be used as - is or formatted. - GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: + Parameters to configure the routing calculations to the places in the + response, both along a route (where result ranking will be influenced) + and for calculating travel times on results. + type: object + id: GoogleMapsPlacesV1RoutingParameters properties: - date: - $ref: '#/components/schemas/GoogleTypeDate' - description: Date in the local timezone for the place. - hour: - description: The hour in 2 digits. Ranges from 00 to 23. + routeModifiers: + $ref: '#/components/schemas/GoogleMapsPlacesV1RouteModifiers' + description: Optional. The route modifiers. + routingPreference: + enum: + - ROUTING_PREFERENCE_UNSPECIFIED + - TRAFFIC_UNAWARE + - TRAFFIC_AWARE + - TRAFFIC_AWARE_OPTIMAL + type: string + enumDescriptions: + - No routing preference specified. Default to `TRAFFIC_UNAWARE`. + - >- + Computes routes without taking live traffic conditions into + consideration. Suitable when traffic conditions don't matter or + are not applicable. Using this value produces the lowest latency. + Note: For `TravelMode` `DRIVE` and `TWO_WHEELER`, the route and + duration chosen are based on road network and average + time-independent traffic conditions, not current road conditions. + Consequently, routes may include roads that are temporarily + closed. Results for a given request may vary over time due to + changes in the road network, updated average traffic conditions, + and the distributed nature of the service. Results may also vary + between nearly-equivalent routes at any time or frequency. + - >- + Calculates routes taking live traffic conditions into + consideration. In contrast to `TRAFFIC_AWARE_OPTIMAL`, some + optimizations are applied to significantly reduce latency. + - >- + Calculates the routes taking live traffic conditions into + consideration, without applying most performance optimizations. + Using this value produces the highest latency. + description: >- + Optional. Specifies how to compute the routing summaries. The server + attempts to use the selected routing preference to compute the + route. The traffic aware routing preference is only available for + the `DRIVE` or `TWO_WHEELER` `travelMode`. + origin: + description: >- + Optional. An explicit routing origin that overrides the origin + defined in the polyline. By default, the polyline origin is used. + $ref: '#/components/schemas/GoogleTypeLatLng' + travelMode: + enumDescriptions: + - No travel mode specified. Defaults to `DRIVE`. + - Travel by passenger car. + - >- + Travel by bicycle. Not supported with + `search_along_route_parameters`. + - >- + Travel by walking. Not supported with + `search_along_route_parameters`. + - >- + Motorized two wheeled vehicles of all kinds such as scooters and + motorcycles. Note that this is distinct from the `BICYCLE` travel + mode which covers human-powered transport. Not supported with + `search_along_route_parameters`. Only supported in those countries + listed at [Countries and regions supported for two-wheeled + vehicles](https://developers.google.com/maps/documentation/routes/coverage-two-wheeled). + enum: + - TRAVEL_MODE_UNSPECIFIED + - DRIVE + - BICYCLE + - WALK + - TWO_WHEELER + description: Optional. The travel mode. + type: string + GoogleMapsPlacesV1AutocompletePlacesRequest: + id: GoogleMapsPlacesV1AutocompletePlacesRequest + type: object + properties: + inputOffset: format: int32 + description: >- + Optional. A zero-based Unicode character offset of `input` + indicating the cursor position in `input`. The cursor position may + influence what predictions are returned. If empty, defaults to the + length of `input`. type: integer - minute: - description: The minute in 2 digits. Ranges from 00 to 59. - type: integer - format: int32 - truncated: + locationRestriction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction + description: >- + Optional. Restrict results to a specified location. At most one of + `location_bias` or `location_restriction` should be set. If neither + are set, the results will be biased by IP address, meaning the IP + address will be mapped to an imprecise location and used as a + biasing signal. + origin: + description: >- + Optional. The origin point from which to calculate geodesic distance + to the destination (returned as `distance_meters`). If this value is + omitted, geodesic distance will not be returned. + $ref: '#/components/schemas/GoogleTypeLatLng' + languageCode: + description: >- + Optional. The language in which to return results. Defaults to + en-US. The results may be in mixed languages if the language used in + `input` is different from `language_code` or if the returned Place + does not have a translation from the local language to + `language_code`. + type: string + regionCode: + type: string + description: >- + Optional. The region code, specified as a CLDR two-character region + code. This affects address formatting, result ranking, and may + influence what results are returned. This does not restrict results + to the specified region. To restrict results to a region, use + `region_code_restriction`. + locationBias: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias + description: >- + Optional. Bias results to a specified location. At most one of + `location_bias` or `location_restriction` should be set. If neither + are set, the results will be biased by IP address, meaning the IP + address will be mapped to an imprecise location and used as a + biasing signal. + includeQueryPredictions: type: boolean description: >- - Whether or not this endpoint was truncated. Truncation occurs when - the real hours are outside the times we are willing to return hours - between, so we truncate the hours back to these boundaries. This - ensures that at most 24 * 7 hours from midnight of the day of the - request are returned. - day: + Optional. If true, the response will include both Place and query + predictions. Otherwise the response will only return Place + predictions. + sessionToken: + type: string + description: >- + Optional. A string which identifies an Autocomplete session for + billing purposes. Must be a URL and filename safe base64 string with + at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT + error is returned. The session begins when the user starts typing a + query, and concludes when they select a place and a call to Place + Details or Address Validation is made. Each session can have + multiple queries, followed by one Place Details or Address + Validation request. The credentials used for each request within a + session must belong to the same Google Cloud Console project. Once a + session has concluded, the token is no longer valid; your app must + generate a fresh token for each session. If the `session_token` + parameter is omitted, or if you reuse a session token, the session + is charged as if no session token was provided (each request is + billed separately). We recommend the following guidelines: * Use + session tokens for all Place Autocomplete calls. * Generate a fresh + token for each session. Using a version 4 UUID is recommended. * + Ensure that the credentials used for all Place Autocomplete, Place + Details, and Address Validation requests within a session belong to + the same Cloud Console project. * Be sure to pass a unique session + token for each new session. Using the same token for more than one + session will result in each request being billed individually. + input: + description: Required. The text string on which to search. + type: string + includedRegionCodes: + type: array description: >- - A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is - Monday, etc. - type: integer - format: int32 - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint - type: object - description: Status changing points. - GoogleGeoTypeViewport: - type: object - properties: - low: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The low point of the viewport. - high: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The high point of the viewport. - id: GoogleGeoTypeViewport - description: >- - A latitude-longitude viewport, represented as two diagonally opposite - `low` and `high` points. A viewport is considered a closed region, i.e. - it includes its boundary. The latitude bounds must range between -90 to - 90 degrees inclusive, and the longitude bounds must range between -180 - to 180 degrees inclusive. Various cases include: - If `low` = `high`, - the viewport consists of that single point. - If `low.longitude` > - `high.longitude`, the longitude range is inverted (the viewport crosses - the 180 degree longitude line). - If `low.longitude` = -180 degrees and - `high.longitude` = 180 degrees, the viewport includes all longitudes. - - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, - the longitude range is empty. - If `low.latitude` > `high.latitude`, the - latitude range is empty. Both `low` and `high` must be populated, and - the represented box cannot be empty (as specified by the definitions - above). An empty viewport will result in an error. For example, this - viewport fully encloses New York City: { "low": { "latitude": 40.477398, - "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": - -73.70018 } } - GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: - description: >- - Structured information for special days that fall within the period that - the returned opening hours cover. Special days are days that could - impact the business hours of a place, e.g. Christmas day. - type: object - id: GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay - properties: - date: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of this special day. - GoogleMapsPlacesV1FuelOptions: - id: GoogleMapsPlacesV1FuelOptions - properties: - fuelPrices: + Optional. Only include results in the specified regions, specified + as up to 15 CLDR two-character region codes. An empty set will not + restrict the results. If both `location_restriction` and + `included_region_codes` are set, the results will be located in the + area of intersection. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' - type: array + type: string + includedPrimaryTypes: description: >- - The last known fuel price for each type of fuel this station has. - There is one entry per fuel type this station has. Order is not - important. - type: object - description: >- - The most recent information about fuel options in a gas station. This - information is updated regularly. - GoogleMapsPlacesV1PhotoMedia: + Optional. Included primary Place type (for example, "restaurant" or + "gas_station") in Place Types + (https://developers.google.com/maps/documentation/places/web-service/place-types), + or only `(regions)`, or only `(cities)`. A Place is only returned if + its primary type is included in this list. Up to 5 values can be + specified. If no types are specified, all Place types are returned. + type: array + items: + type: string + description: Request proto for AutocompletePlaces. + GoogleMapsPlacesV1PlaceSubDestination: + id: GoogleMapsPlacesV1PlaceSubDestination properties: - name: + id: type: string - description: >- - The resource name of a photo media in the format: - `places/{place_id}/photos/{photo_reference}/media`. - photoUri: - description: A short-lived uri that can be used to render the photo. + description: The place id of the sub destination. + name: type: string - id: GoogleMapsPlacesV1PhotoMedia + description: The resource name of the sub destination. type: object - description: A photo media from Places API. - GoogleMapsPlacesV1PlaceGenerativeSummary: - properties: - overview: - description: The overview of the place. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - references: - description: References that are used to generate the summary description. - $ref: '#/components/schemas/GoogleMapsPlacesV1References' - description: - description: The detailed description of the place. - $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: >- + Place resource name and id of sub destinations that relate to the place. + For example, different terminals are different destinations of an + airport. + GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: type: object description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the place. - id: GoogleMapsPlacesV1PlaceGenerativeSummary + The region to search. The results may be biased around the specified + region. + properties: + circle: + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: A circle defined by a center point and radius. + rectangle: + description: A viewport defined by a northeast and a southwest corner. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias GoogleMapsPlacesV1AuthorAttribution: - description: Information about the author of the UGC data. Used in Photo, and Review. + type: object properties: uri: - description: URI of the author of the Photo or Review. type: string + description: URI of the author of the Photo or Review. displayName: - description: Name of the author of the Photo or Review. type: string + description: Name of the author of the Photo or Review. photoUri: type: string description: Profile photo URI of the author of the Photo or Review. + description: Information about the author of the UGC data. Used in Photo, and Review. id: GoogleMapsPlacesV1AuthorAttribution - type: object - GoogleMapsPlacesV1PlaceOpeningHours: - description: Information about business hour of the place. - id: GoogleMapsPlacesV1PlaceOpeningHours + GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: + id: GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay + description: >- + Structured information for special days that fall within the period that + the returned opening hours cover. Special days are days that could + impact the business hours of a place, e.g. Christmas day. type: object properties: - periods: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' - description: >- - The periods that this place is open during the week. The periods are - in chronological order, starting with Sunday in the place-local - timezone. An empty (but not absent) value indicates a place that is - never open, e.g. because it is closed temporarily for renovations. - type: array - weekdayDescriptions: - items: - type: string - type: array + date: + $ref: '#/components/schemas/GoogleTypeDate' + description: The date of this special day. + GoogleMapsPlacesV1PlaceAddressComponent: + id: GoogleMapsPlacesV1PlaceAddressComponent + properties: + shortText: + type: string description: >- - Localized strings describing the opening hours of this place, one - string for each day of the week. Will be empty if the hours are - unknown or could not be converted to localized text. Example: "Sun: - 18:00–06:00" - openNow: - type: boolean + An abbreviated textual name for the address component, if available. + For example, an address component for the country of Australia may + have a short_name of "AU". + longText: description: >- - Whether the opening hours period is currently active. For regular - opening hours and current opening hours, this field means whether - the place is open. For secondary opening hours and current secondary - opening hours, this field means whether the secondary hours of this - place is active. - secondaryHoursType: - enumDescriptions: - - Default value when secondary hour type is not specified. - - The drive-through hour for banks, restaurants, or pharmacies. - - The happy hour. - - The delivery hour. - - The takeout hour. - - The kitchen hour. - - The breakfast hour. - - The lunch hour. - - The dinner hour. - - The brunch hour. - - The pickup hour. - - The access hours for storage places. - - The special hours for seniors. - - The online service hours. - enum: - - SECONDARY_HOURS_TYPE_UNSPECIFIED - - DRIVE_THROUGH - - HAPPY_HOUR - - DELIVERY - - TAKEOUT - - KITCHEN - - BREAKFAST - - LUNCH - - DINNER - - BRUNCH - - PICKUP - - ACCESS - - SENIOR_HOURS - - ONLINE_SERVICE_HOURS + The full text description or name of the address component. For + example, an address component for the country Australia may have a + long_name of "Australia". type: string - description: A type string used to identify the type of secondary hours. - specialDays: + types: type: array - description: >- - Structured information for special days that fall within the period - that the returned opening hours cover. Special days are days that - could impact the business hours of a place, e.g. Christmas day. Set - for current_opening_hours and current_secondary_opening_hours if - there are exceptional hours. + description: An array indicating the type(s) of the address component. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' - GoogleTypeLocalizedText: - id: GoogleTypeLocalizedText - description: Localized variant of a text in a particular language. - type: object - properties: + type: string languageCode: + description: The language used to format this components, in CLDR notation. type: string - description: >- - The text's BCP-47 language code, such as "en-US" or "sr-Latn". For - more information, see - http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - text: - type: string - description: >- - Localized string in the language corresponding to language_code - below. - GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: + type: object + description: >- + The structured components that form the formatted address, if this + information is available. + GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: properties: - highlightedText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText - review: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: The review that the highlighted text is generated from. + circle: + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: A circle defined by a center point and radius. + rectangle: + $ref: '#/components/schemas/GoogleGeoTypeViewport' + description: A viewport defined by a northeast and a southwest corner. type: object + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. User review justifications. This highlights a section - of the user review that would interest an end user. For instance, if the - search query is "firewood pizza", the review justification highlights - the text relevant to the search query. - id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + The region to search. The results will be restricted to the specified + region. GoogleMapsPlacesV1PlaceAccessibilityOptions: - description: Information about the accessibility options a place offers. properties: - wheelchairAccessibleEntrance: - description: Places has wheelchair accessible entrance. - type: boolean wheelchairAccessibleSeating: description: Place has wheelchair accessible seating. type: boolean + wheelchairAccessibleRestroom: + description: Place has wheelchair accessible restroom. + type: boolean + wheelchairAccessibleEntrance: + description: Places has wheelchair accessible entrance. + type: boolean wheelchairAccessibleParking: type: boolean description: Place offers wheelchair accessible parking. - wheelchairAccessibleRestroom: + id: GoogleMapsPlacesV1PlaceAccessibilityOptions + type: object + description: Information about the accessibility options a place offers. + GoogleTypeMoney: + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. + type: object + properties: + units: + format: int64 + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + format: int32 + type: integer + GoogleMapsPlacesV1PlaceParkingOptions: + id: GoogleMapsPlacesV1PlaceParkingOptions + type: object + properties: + paidParkingLot: type: boolean - description: Place has wheelchair accessible restroom. + description: Place offers paid parking lots. + freeParkingLot: + type: boolean + description: Place offers free parking lots. + valetParking: + type: boolean + description: Place offers valet parking. + paidStreetParking: + type: boolean + description: Place offers paid street parking. + freeStreetParking: + description: Place offers free street parking. + type: boolean + freeGarageParking: + type: boolean + description: Place offers free garage parking. + paidGarageParking: + type: boolean + description: Place offers paid garage parking. + description: >- + Information about parking options for the place. A parking lot could + support more than one option at the same time. + GoogleTypeLatLng: + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. type: object - id: GoogleMapsPlacesV1PlaceAccessibilityOptions + id: GoogleTypeLatLng + properties: + latitude: + format: double + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: number + longitude: + type: number + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + format: double parameters: - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string - key: + enum: + - '1' + - '2' + quotaUser: 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. + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: key + name: quotaUser schema: type: string - access_token: - description: OAuth access token. + callback: + description: JSONP in: query - name: access_token + name: callback schema: type: string alt: @@ -1967,40 +2176,43 @@ components: - json - media - proto - _.xgafv: - description: V1 error format. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: $.xgafv + name: upload_protocol + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string - enum: - - '1' - - '2' prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + name: oauth_token schema: type: string - quotaUser: + key: description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + 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. in: query - name: quotaUser + name: key schema: type: string x-stackQL-resources: @@ -2033,12 +2245,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - search_text: - operation: - $ref: '#/paths/~1v1~1places:searchText/post' - response: - mediaType: application/json - openAPIDocKey: '200' search_nearby: operation: $ref: '#/paths/~1v1~1places:searchNearby/post' @@ -2051,6 +2257,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + search_text: + operation: + $ref: '#/paths/~1v1~1places:searchText/post' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/places/methods/get' @@ -2061,17 +2273,17 @@ components: paths: /v1/places/{placesId}/photos/{photosId}/media: parameters: &ref_1 - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' get: description: Get a photo media with a photo reference string. operationId: places.places.photos.getMedia @@ -2107,15 +2319,15 @@ paths: schema: type: integer format: int32 + - in: query + name: skipHttpRedirect + schema: + type: boolean - in: query name: maxHeightPx schema: type: integer format: int32 - - in: query - name: skipHttpRedirect - schema: - type: boolean /v1/places/{placesId}: parameters: *ref_1 get: @@ -2150,27 +2362,27 @@ paths: schema: type: string - in: query - name: sessionToken + name: regionCode schema: type: string - in: query - name: regionCode + name: sessionToken schema: type: string - in: query name: languageCode schema: type: string - /v1/places:searchText: + /v1/places:searchNearby: parameters: *ref_1 post: - description: Text query based place search. - operationId: places.places.searchText + description: Search for places near locations. + operationId: places.places.searchNearby requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequest' + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2181,27 +2393,27 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.textsearch + - https://www.googleapis.com/auth/maps-platform.places.nearbysearch Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.textsearch + - https://www.googleapis.com/auth/maps-platform.places.nearbysearch responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextResponse' + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse' parameters: [] - /v1/places:searchNearby: + /v1/places:autocomplete: parameters: *ref_1 post: - description: Search for places near locations. - operationId: places.places.searchNearby + description: Returns predictions for the given input. + operationId: places.places.autocomplete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest' + $ref: '#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2212,27 +2424,28 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.nearbysearch + - https://www.googleapis.com/auth/maps-platform.places.autocomplete Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.nearbysearch + - https://www.googleapis.com/auth/maps-platform.places.autocomplete responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse' + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse parameters: [] - /v1/places:autocomplete: + /v1/places:searchText: parameters: *ref_1 post: - description: Returns predictions for the given input. - operationId: places.places.autocomplete + description: Text query based place search. + operationId: places.places.searchText requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequest' + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2243,15 +2456,14 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.autocomplete + - https://www.googleapis.com/auth/maps-platform.places.textsearch Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.autocomplete + - https://www.googleapis.com/auth/maps-platform.places.textsearch responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextResponse' parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml b/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml index f93f2248..e4b0da83 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://www.google.com servers: @@ -35,67 +35,73 @@ components: scopes: *ref_0 schemas: GoogleCloudPolicyanalyzerV1ObservationPeriod: - type: object + description: Represents data observation period. + id: GoogleCloudPolicyanalyzerV1ObservationPeriod properties: - endTime: - type: string - description: >- - The observation end time. The time in this timestamp is always - `07:00:00Z`. - format: google-datetime startTime: description: >- The observation start time. The time in this timestamp is always `07:00:00Z`. format: google-datetime type: string - description: Represents data observation period. - id: GoogleCloudPolicyanalyzerV1ObservationPeriod - GoogleCloudPolicyanalyzerV1Activity: - description: Represents Activity on a GCP resource over specific observation period. - properties: - observationPeriod: - description: The data observation period to build the activity. - $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' - activity: - additionalProperties: - type: any - description: Properties of the object. - description: A struct of custom fields to explain the activity. - type: object - fullResourceName: - type: string + endTime: description: >- - The full resource name that identifies the resource. For examples of - full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - activityType: - description: The type of the activity. + The observation end time. The time in this timestamp is always + `07:00:00Z`. type: string - id: GoogleCloudPolicyanalyzerV1Activity + format: google-datetime type: object GoogleCloudPolicyanalyzerV1QueryActivityResponse: - id: GoogleCloudPolicyanalyzerV1QueryActivityResponse - description: Response to the `QueryActivity` method. properties: - activities: - type: array - items: - $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1Activity' - description: The set of activities that match the filter included in the request. nextPageToken: + type: string description: >- If there might be more results than those appearing in this response, then `nextPageToken` is included. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`. - type: string + activities: + type: array + items: + $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1Activity' + description: The set of activities that match the filter included in the request. + id: GoogleCloudPolicyanalyzerV1QueryActivityResponse + type: object + description: Response to the `QueryActivity` method. + GoogleCloudPolicyanalyzerV1Activity: type: object + description: Represents Activity on a GCP resource over specific observation period. + id: GoogleCloudPolicyanalyzerV1Activity + properties: + fullResourceName: + description: >- + The full resource name that identifies the resource. For examples of + full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + type: string + activityType: + description: The type of the activity. + type: string + activity: + description: A struct of custom fields to explain the activity. + type: object + additionalProperties: + description: Properties of the object. + type: any + observationPeriod: + $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' + description: The data observation period to build the activity. parameters: - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string quotaUser: @@ -107,12 +113,12 @@ components: name: quotaUser schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: upload_protocol + name: prettyPrint schema: - type: string + type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -122,34 +128,18 @@ components: name: key schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string - alt: - description: Data format for response. + callback: + description: JSONP in: query - name: alt + name: callback schema: type: string - enum: - - json - - media - - proto _.xgafv: description: V1 error format. in: query @@ -159,18 +149,28 @@ components: enum: - '1' - '2' - prettyPrint: - description: Returns response with indentations and line breaks. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: prettyPrint + name: fields schema: - type: boolean + type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto x-stackQL-resources: activities: id: google.policyanalyzer.activities @@ -180,7 +180,7 @@ components: query: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1activityTypes~1{activityTypesId}~1activities:query/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1activityTypes~1{activityTypesId}~1activities:query/get response: mediaType: application/json openAPIDocKey: '200' @@ -192,22 +192,22 @@ components: replace: [] delete: [] paths: - /v1/folders/{foldersId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + /v1/organizations/{organizationsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: &ref_1 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' get: description: Queries policy activities on Google Cloud resources. - operationId: policyanalyzer.folders.locations.activityTypes.activities.query + operationId: policyanalyzer.organizations.locations.activityTypes.activities.query security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -223,7 +223,7 @@ paths: #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -250,11 +250,11 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + /v1/projects/{projectsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: *ref_1 get: description: Queries policy activities on Google Cloud resources. - operationId: policyanalyzer.organizations.locations.activityTypes.activities.query + operationId: policyanalyzer.projects.locations.activityTypes.activities.query security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -270,7 +270,7 @@ paths: #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -284,6 +284,10 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: @@ -293,15 +297,11 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + /v1/folders/{foldersId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: *ref_1 get: description: Queries policy activities on Google Cloud resources. - operationId: policyanalyzer.projects.locations.activityTypes.activities.query + operationId: policyanalyzer.folders.locations.activityTypes.activities.query security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -317,7 +317,7 @@ paths: #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -331,6 +331,10 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: @@ -340,7 +344,3 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml b/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml index d28a1cef..f86d7279 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml @@ -8,7 +8,7 @@ info: description: ' Policy Simulator is a collection of endpoints for creating, running, and viewing a Replay. A `Replay` is a type of simulation that lets you see how your members'' access to resources might change if you changed your IAM policy. During a `Replay`, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your members'' access might change under the proposed policy.' version: v1 x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/iam/docs/simulating-access servers: @@ -34,141 +34,287 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudOrgpolicyV2CustomConstraint: + GoogleCloudPolicysimulatorV1ReplayOperationMetadata: + description: Metadata about a Replay operation. properties: - methodTypes: - description: All the operations being applied for this constraint. - type: array - items: - enumDescriptions: - - Unspecified. Results in an error. - - Constraint applied when creating the resource. - - Constraint applied when updating the resource. - - >- - Constraint applied when deleting the resource. Not supported - yet. - - Constraint applied when removing an IAM grant. - - Constraint applied when enforcing forced tagging. - type: string - enum: - - METHOD_TYPE_UNSPECIFIED - - CREATE - - UPDATE - - DELETE - - REMOVE_GRANT - - GOVERN_TAGS - resourceTypes: - type: array - description: >- - Immutable. The resource instance type on which this policy applies. - Format will be of the form : `/` Example: * - `compute.googleapis.com/Instance`. - items: - type: string - name: + startTime: + format: google-datetime + type: string + description: Time when the request was received. + id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata + type: object + GoogleCloudPolicysimulatorV1AccessTuple: + type: object + properties: + fullResourceName: type: string description: >- - Immutable. Name of the constraint. This is unique within the - organization. Format of the name should be * - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The - max length is 70 characters and the minimum length is 1. Note that - the prefix `organizations/{organization_id}/customConstraints/` is - not counted. - description: + Required. The full resource name that identifies the resource. For + example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + For examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + principal: description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. + Required. The principal whose access you want to check, in the form + of the email address that represents that principal. For example, + `alice@example.com` or + `my-service-account@my-project.iam.gserviceaccount.com`. The + principal must be a Google Account or a service account. Other types + of principals are not supported. type: string - condition: + permission: type: string description: >- - Org policy condition/expression. For example: - `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, - `resource.management.auto_upgrade == true` The max length of the - condition is 1000 characters. - displayName: - description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. + Required. The IAM permission to check for the specified principal + and resource. For a complete list of IAM permissions, see + https://cloud.google.com/iam/help/permissions/reference. For a + complete list of predefined IAM roles and the permissions in each + role, see https://cloud.google.com/iam/help/roles/reference. + id: GoogleCloudPolicysimulatorV1AccessTuple + description: Information about the principal, resource, and permission to check. + GoogleLongrunningListOperationsResponse: + type: object + id: GoogleLongrunningListOperationsResponse + properties: + nextPageToken: + description: The standard List next-page token. type: string - actionType: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array + description: The response message for Operations.ListOperations. + GoogleTypeDate: + properties: + day: + format: int32 + type: integer + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + month: + type: integer + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + format: int32 + year: + format: int32 + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + id: GoogleTypeDate + GoogleCloudPolicysimulatorV1ReplayConfig: + id: GoogleCloudPolicysimulatorV1ReplayConfig + properties: + policyOverlay: + description: >- + A mapping of the resources that you want to simulate policies for + and the policies that you want to simulate. Keys are the full + resource names for the resources. For example, + `//cloudresourcemanager.googleapis.com/projects/my-project`. For + examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + Values are Policy objects representing the policies that you want to + simulate. Replays automatically take into account any IAM policies + inherited through the resource hierarchy, and any policies set on + descendant resources. You do not need to include these policies in + the policy overlay. + additionalProperties: + $ref: '#/components/schemas/GoogleIamV1Policy' + type: object + logSource: + description: The logs to use as input for the Replay. enum: - - ACTION_TYPE_UNSPECIFIED - - ALLOW - - DENY + - LOG_SOURCE_UNSPECIFIED + - RECENT_ACCESSES enumDescriptions: - - Unspecified. Results in an error. - - Allowed action type. - - Deny action type. - type: string - description: Allow or deny type. - updateTime: + - >- + An unspecified log source. If the log source is unspecified, the + Replay defaults to using `RECENT_ACCESSES`. + - >- + All access logs from the last 90 days. These logs may not include + logs from the most recent 7 days. type: string - description: >- - Output only. The last time this custom constraint was updated. This - represents the last time that the `CreateCustomConstraint` or - `UpdateCustomConstraint` RPC was called - readOnly: true - format: google-datetime - description: >- - A custom constraint defined by customers which can *only* be applied to - the given resource types and organization. By creating a custom - constraint, customers can apply policies of this custom constraint. - *Creating a custom constraint itself does NOT apply any policy - enforcement*. - id: GoogleCloudOrgpolicyV2CustomConstraint type: object - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: + description: The configuration used for a Replay. + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + type: object + description: The proposed changes to OrgPolicy. + properties: + customConstraints: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay + description: >- + Optional. The OrgPolicy CustomConstraint changes to preview + violations for. Any existing CustomConstraints with the same name + will be overridden in the simulation. That is, violations will be + determined as if all custom constraints in the overlay were + instantiated. Only a single custom_constraint is supported in the + overlay at a time. For evaluating multiple constraints, multiple + `GenerateOrgPolicyViolationsPreview` requests are made, where each + request evaluates a single constraint. + policies: + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay + description: >- + Optional. The OrgPolicy changes to preview violations for. Any + existing OrgPolicies with the same name will be overridden in the + simulation. That is, violations will be determined as if all + policies in the overlay were created or updated. + type: array + GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata: type: object id: >- - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata + GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata description: >- CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation. properties: - resourcesFound: - type: integer - format: int32 - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending resourcesScanned: - format: int32 type: integer - description: Number of resources already scanned. - resourcesPending: - description: Number of resources still to scan. format: int32 - type: integer - requestTime: - format: google-datetime - type: string - description: Time when the request was received. + description: Number of resources already scanned. startTime: - type: string - format: google-datetime description: >- Time when the request started processing, i.e., when the state was set to RUNNING. + format: google-datetime + type: string + resourcesPending: + format: int32 + description: Number of resources still to scan. + type: integer + resourcesFound: + format: int32 + description: >- + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer state: - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED + type: string + readOnly: true + description: Output only. The current state of the operation. enumDescriptions: - The state is unspecified. - The OrgPolicyViolationsPreview has not been created yet. - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. - readOnly: true + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + requestTime: + format: google-datetime type: string - description: Output only. The current state of the operation. + description: Time when the request was received. + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview: + type: object + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview + description: >- + OrgPolicyViolationsPreview is a resource providing a preview of the + violations that will exist if an OrgPolicy change is made. The list of + violations are modeled as child resources and retrieved via a + ListOrgPolicyViolations API call. There are potentially more + OrgPolicyViolations than could fit in an embedded field. Thus, the use + of a child resource instead of a field. + properties: + resourceCounts: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + description: >- + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + readOnly: true + name: + readOnly: true + type: string + description: >- + Output only. The resource name of the `OrgPolicyViolationsPreview`. + It has the following format: + `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` + Example: + `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` + state: + type: string + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + readOnly: true + description: Output only. The state of the `OrgPolicyViolationsPreview`. + overlay: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + description: Required. The proposed changes we are previewing violations for. + createTime: + readOnly: true + format: google-datetime + description: >- + Output only. Time when this `OrgPolicyViolationsPreview` was + created. + type: string + customConstraints: + items: + type: string + description: >- + Output only. The names of the constraints against which all + `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only + contains `PolicyOverlay` then it contains the name of the configured + custom constraint, applicable to the specified policies. Otherwise + it contains the name of the constraint specified in + `CustomConstraintOverlay`. Format: + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` + readOnly: true + type: array + violationsCount: + description: >- + Output only. The number of OrgPolicyViolations in this + `OrgPolicyViolationsPreview`. This count may differ from + `resource_summary.noncompliant_count` because each + OrgPolicyViolation is specific to a resource **and** constraint. If + there are multiple constraints being evaluated (i.e. multiple + policies in the overlay), a single resource may violate multiple + constraints. + type: integer + readOnly: true + format: int32 GoogleCloudPolicysimulatorV1ListReplayResultsResponse: + type: object properties: replayResults: description: The results of running a Replay. @@ -181,198 +327,322 @@ components: A token that you can use to retrieve the next page of ReplayResult objects. If this field is omitted, there are no subsequent pages. id: GoogleCloudPolicysimulatorV1ListReplayResultsResponse - type: object description: Response message for Simulator.ListReplayResults. - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: + description: >- + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. properties: - errors: - type: integer + noncompliant: format: int32 + readOnly: true + type: integer + description: >- + Output only. Number of scanned resources with at least one + violation. + errors: readOnly: true description: >- Output only. Number of resources that returned an error when scanned. - compliant: format: int32 type: integer - description: Output only. Number of scanned resources with zero violations. - readOnly: true scanned: format: int32 - readOnly: true description: >- Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error type: integer - noncompliant: - description: >- - Output only. Number of scanned resources with at least one - violation. - format: int32 + readOnly: true + compliant: + description: Output only. Number of scanned resources with zero violations. readOnly: true type: integer + format: int32 unenforced: - type: integer - readOnly: true description: >- Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource. format: int32 - description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. + readOnly: true + type: integer + type: object + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + GoogleCloudOrgpolicyV2Policy: type: object - id: >- - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: properties: - resourcesPending: - description: Number of resources still to scan. - type: integer - format: int32 - startTime: + alternate: + description: Deprecated. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' + deprecated: true + etag: type: string description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. - format: google-datetime - resourcesFound: - format: int32 - type: integer + Optional. An opaque tag indicating the current state of the policy, + used for concurrency control. This 'etag' is computed by the server + based on the value of other fields, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + dryRunSpec: description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending + Dry-run policy. Audit-only policy, can be used to monitor how the + policy would have impacted the existing and future resources if it's + enforced. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + spec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: Basic information about the Organization Policy. + name: + description: >- + Immutable. The resource name of the policy. Must be one of the + following forms, where `constraint_name` is the name of the + constraint which this policy configures: * + `projects/{project_number}/policies/{constraint_name}` * + `folders/{folder_id}/policies/{constraint_name}` * + `organizations/{organization_id}/policies/{constraint_name}` For + example, `projects/123/policies/compute.disableSerialPortAccess`. + Note: `projects/{project_id}/policies/{constraint_name}` is also an + acceptable name for API requests, but responses will return the name + using the equivalent project number. + type: string + id: GoogleCloudOrgpolicyV2Policy + description: >- + Defines an organization policy which is used to specify constraints for + configurations of Google Cloud resources. + GoogleCloudPolicysimulatorV1Replay: + id: GoogleCloudPolicysimulatorV1Replay + description: A resource describing a `Replay`, or simulation. + properties: + name: + type: string + readOnly: true + description: >- + Output only. The resource name of the `Replay`, which has the + following format: + `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, + where `{resource-id}` is the ID of the project, folder, or + organization that owns the Replay. Example: + `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` + config: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' + description: Required. The configuration used for the `Replay`. + resultsSummary: + readOnly: true + description: Output only. Summary statistics about the replayed log entries. + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary state: + type: string enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. + - Default value. This value is unused. + - The `Replay` has not started yet. + - The `Replay` is currently running. + - The `Replay` has successfully completed. + - The `Replay` has finished with an error. + readOnly: true + description: Output only. The current state of the `Replay`. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + type: object + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview: + type: object + properties: + name: + type: string + readOnly: true + description: >- + Output only. The resource name of the `OrgPolicyViolationsPreview`. + It has the following format: + `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` + Example: + `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` + customConstraints: + type: array + description: >- + Output only. The names of the constraints against which all + `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only + contains `PolicyOverlay` then it contains the name of the configured + custom constraint, applicable to the specified policies. Otherwise + it contains the name of the constraint specified in + `CustomConstraintOverlay`. Format: + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` + readOnly: true + items: + type: string + state: + type: string enum: - PREVIEW_STATE_UNSPECIFIED - PREVIEW_PENDING - PREVIEW_RUNNING - PREVIEW_SUCCEEDED - PREVIEW_FAILED + readOnly: true + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + description: Output only. The state of the `OrgPolicyViolationsPreview`. + createTime: type: string - description: The current state of the operation. - resourcesScanned: - type: integer - format: int32 - description: Number of resources already scanned. - requestTime: - description: Time when the request was received. - format: google-datetime - type: string + format: google-datetime + readOnly: true + description: >- + Output only. Time when this `OrgPolicyViolationsPreview` was + created. + overlay: + description: Required. The proposed changes we are previewing violations for. + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + resourceCounts: + readOnly: true + description: >- + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts + violationsCount: + description: >- + Output only. The number of OrgPolicyViolations in this + `OrgPolicyViolationsPreview`. This count may differ from + `resource_summary.noncompliant_count` because each + OrgPolicyViolation is specific to a resource **and** constraint. If + there are multiple constraints being evaluated (i.e. multiple + policies in the overlay), a single resource may violate multiple + constraints. + format: int32 + type: integer + readOnly: true description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - id: >- - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata - type: object - GoogleCloudPolicysimulatorV1BindingExplanation: - id: GoogleCloudPolicysimulatorV1BindingExplanation + OrgPolicyViolationsPreview is a resource providing a preview of the + violations that will exist if an OrgPolicy change is made. The list of + violations are modeled as child resources and retrieved via a + ListOrgPolicyViolations API call. There are potentially more + OrgPolicyViolations than could fit in an embedded field. Thus, the use + of a child resource instead of a field. + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview + GoogleCloudOrgpolicyV2PolicySpec: + description: >- + Defines a Google Cloud policy specification which is used to specify + constraints for configurations of Google Cloud resources. properties: - memberships: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership + rules: + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + type: array description: >- - Indicates whether each principal in the binding includes the - principal specified in the request, either directly or indirectly. - Each key identifies a principal in the binding, and each value - indicates whether the principal in the binding includes the - principal in the request. For example, suppose that a binding - includes the following principals: * `user:alice@example.com` * - `group:product-eng@example.com` The principal in the replayed access - tuple is `user:bob@example.com`. This user is a principal of the - group `group:product-eng@example.com`. For the first principal in - the binding, the key is `user:alice@example.com`, and the - `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. - For the second principal in the binding, the key is - `group:product-eng@example.com`, and the `membership` field in the - value is set to `MEMBERSHIP_INCLUDED`. - type: object - rolePermission: + In policies for boolean constraints, the following requirements + apply: - There must be one and only one policy rule where condition + is unset. - Boolean policy rules with conditions must set `enforced` + to the opposite of the policy rule without a condition. - During + policy evaluation, policy rules with conditions that are true for a + target resource take precedence. + etag: + description: >- + An opaque tag indicating the current version of the policySpec, used + for concurrency control. This field is ignored if used in a + `CreatePolicy` request. When the policy is returned from either a + `GetPolicy` or a `ListPolicies` request, this `etag` indicates the + version of the current policySpec to use when executing a + read-modify-write loop. When the policy is returned from a + `GetEffectivePolicy` request, the `etag` will be unset. type: string - enumDescriptions: - - Default value. This value is unused. - - The permission is included in the role. - - The permission is not included in the role. - - >- - The user who created the Replay is not allowed to access the - binding. + reset: + type: boolean description: >- - Indicates whether the role granted by this binding contains the - specified permission. - enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED - role: + Ignores policies set above this resource and restores the + `constraint_default` enforcement behavior of the specific constraint + at this resource. This field can be set in policies for either list + or boolean constraints. If set, `rules` must be empty and + `inherit_from_parent` must be set to false. + updateTime: type: string + readOnly: true + format: google-datetime description: >- - The role that this binding grants. For example, - `roles/compute.serviceAgent`. For a complete list of predefined IAM - roles, as well as the permissions in each role, see - https://cloud.google.com/iam/help/roles/reference. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' + Output only. The time stamp this was previously updated. This + represents the last time a call to `CreatePolicy` or `UpdatePolicy` + was made for that policy. + inheritFromParent: description: >- - A condition expression that prevents this binding from granting - access unless the expression evaluates to `true`. To learn about IAM - Conditions, see - https://cloud.google.com/iam/docs/conditions-overview. - access: - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED + Determines the inheritance behavior for this policy. If + `inherit_from_parent` is true, policy rules set higher up in the + hierarchy (up to the closest root) are inherited and present in the + effective policy. If it is false, then no rules are inherited, and + this policy becomes the new root for evaluation. This field can be + set only for policies which configure list constraints. + type: boolean + type: object + id: GoogleCloudOrgpolicyV2PolicySpec + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: + properties: + requestTime: + type: string + format: google-datetime + description: Time when the request was received. + resourcesPending: + description: Number of resources still to scan. + type: integer + format: int32 + resourcesFound: description: >- - Required. Indicates whether _this binding_ provides the specified - permission to the specified principal for the specified resource. - This field does _not_ indicate whether the principal actually has - the permission for the resource. There might be another binding that - overrides this binding. To determine whether the principal actually - has the permission, use the `access` field in the - TroubleshootIamPolicyResponse. + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + format: int32 + state: + description: Output only. The current state of the operation. + readOnly: true enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + type: string + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + resourcesScanned: + format: int32 + description: Number of resources already scanned. + type: integer + startTime: + description: >- + Time when the request started processing, i.e., when the state was + set to RUNNING. type: string + format: google-datetime + id: >- + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata + type: object + description: >- + CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. + GoogleCloudPolicysimulatorV1ExplainedPolicy: + id: GoogleCloudPolicysimulatorV1ExplainedPolicy + properties: relevance: - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. + type: string enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL - HIGH - type: string - description: >- - The relevance of this binding to the overall determination for the - entire policy. - rolePermissionRelevance: - type: string description: >- - The relevance of the permission's existence, or nonexistence, in the - role to the overall determination for the entire policy. + The relevance of this policy to the overall determination in the + TroubleshootIamPolicyResponse. If the user who created the Replay + does not have access to the policy, this field is omitted. enumDescriptions: - Default value. This value is unused. - >- @@ -381,163 +651,97 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. - type: object - GoogleCloudPolicysimulatorV1AccessStateDiff: - description: >- - A summary and comparison of the principal's access under the current - (baseline) policies and the proposed (simulated) policies for a single - access tuple. - properties: - simulated: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + bindingExplanations: description: >- - The results of evaluating the access tuple under the proposed - (simulated) policies. If the AccessState couldn't be fully - evaluated, this field explains why. - accessChange: + Details about how each binding in the policy affects the principal's + ability, or inability, to use the permission for the resource. If + the user who created the Replay does not have access to the policy, + this field is omitted. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation + policy: + description: >- + The IAM policy attached to the resource. If the user who created the + Replay does not have access to the policy, this field is empty. + $ref: '#/components/schemas/GoogleIamV1Policy' + access: enumDescriptions: - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. - >- - The principal's access did not change. This includes the case - where both baseline and simulated are UNKNOWN, but the unknown - information is equivalent. - - >- - The principal's access under both the current policies and the - proposed policies is `UNKNOWN`, but the unknown information - differs between them. - - >- - The principal had access under the current policies (`GRANTED`), - but will no longer have access after the proposed changes - (`NOT_GRANTED`). - - >- - The principal did not have access under the current policies - (`NOT_GRANTED`), but will have access after the proposed changes - (`GRANTED`). - - >- - This result can occur for the following reasons: * The principal - had access under the current policies (`GRANTED`), but their - access after the proposed changes is `UNKNOWN`. * The principal's - access under the current policies is `UNKNOWN`, but they will not - have access after the proposed changes (`NOT_GRANTED`). + The principal has the permission only if a condition expression + evaluates to `true`. - >- - This result can occur for the following reasons: * The principal - did not have access under the current policies (`NOT_GRANTED`), - but their access after the proposed changes is `UNKNOWN`. * The - principal's access under the current policies is `UNKNOWN`, but - they will have access after the proposed changes (`GRANTED`). - enum: - - ACCESS_CHANGE_TYPE_UNSPECIFIED - - NO_CHANGE - - UNKNOWN_CHANGE - - ACCESS_REVOKED - - ACCESS_GAINED - - ACCESS_MAYBE_REVOKED - - ACCESS_MAYBE_GAINED - description: >- - How the principal's access, specified in the AccessState field, - changed between the current (baseline) policies and proposed - (simulated) policies. + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. type: string - baseline: description: >- - The results of evaluating the access tuple under the current - (baseline) policies. If the AccessState couldn't be fully evaluated, - this field explains why. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' - type: object - id: GoogleCloudPolicysimulatorV1AccessStateDiff - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: - properties: - policyParent: - type: string + Indicates whether _this policy_ provides the specified permission to + the specified principal for the specified resource. This field does + _not_ indicate whether the principal actually has the permission for + the resource. There might be another policy that overrides this + policy. To determine whether the principal actually has the + permission, use the `access` field in the + TroubleshootIamPolicyResponse. + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + fullResourceName: description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. + The full resource name that identifies the resource. For example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + If the user who created the Replay does not have access to the + policy, this field is omitted. For examples of full resource names + for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + type: string type: object - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay - description: A change to an OrgPolicy. - GoogleRpcStatus: - id: GoogleRpcStatus + description: Details about how a specific IAM Policy contributed to the access check. + GoogleCloudPolicysimulatorV1ReplayResultsSummary: + id: GoogleCloudPolicysimulatorV1ReplayResultsSummary type: object properties: - details: + unchangedCount: + format: int32 description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - code: + The number of replayed log entries with no difference between + baseline and simulated policies. type: integer + oldestDate: + description: The date of the oldest log entry replayed. + $ref: '#/components/schemas/GoogleTypeDate' + errorCount: + format: int32 + type: integer + description: The number of log entries that could not be replayed. + newestDate: + $ref: '#/components/schemas/GoogleTypeDate' + description: The date of the newest log entry replayed. + logCount: + description: The total number of log entries replayed. + format: int32 + type: integer + differenceCount: format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: - type: object - properties: - customConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - description: Optional. The new or updated custom constraint. - customConstraintParent: - type: string description: >- - Optional. Resource the constraint is attached to. Example: - "organization/987654" - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay - description: A change to an OrgPolicy custom constraint. - GoogleCloudPolicysimulatorV1ReplayOperationMetadata: - id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata - type: object - description: Metadata about a Replay operation. - properties: - startTime: - type: string - format: google-datetime - description: Time when the request was received. - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: - description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - type: object + The number of replayed log entries with a difference between + baseline and simulated policies. + type: integer + description: Summary statistics about the replayed log entries. + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: properties: - resourcesScanned: + resourcesPending: + description: Number of resources still to scan. format: int32 type: integer - description: Number of resources already scanned. state: type: string - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED description: The current state of the operation. enumDescriptions: - The state is unspecified. @@ -545,397 +749,217 @@ components: - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + requestTime: + description: Time when the request was received. + type: string + format: google-datetime + startTime: + format: google-datetime + description: >- + Time when the request started processing, i.e. when the state was + set to RUNNING. + type: string resourcesFound: description: >- Total number of resources that need scanning. Should equal resource_scanned + resources_pending type: integer format: int32 - resourcesPending: - format: int32 + resourcesScanned: + description: Number of resources already scanned. type: integer - description: Number of resources still to scan. - startTime: - description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. - type: string - format: google-datetime - requestTime: - type: string - format: google-datetime - description: Time when the request was received. + format: int32 + description: >- + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. + type: object id: >- - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview: + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata + GoogleCloudOrgpolicyV2PolicySpecPolicyRule: properties: - violationsCount: - format: int32 - type: integer + values: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues description: >- - Output only. The number of OrgPolicyViolations in this - `OrgPolicyViolationsPreview`. This count may differ from - `resource_summary.noncompliant_count` because each - OrgPolicyViolation is specific to a resource **and** constraint. If - there are multiple constraints being evaluated (i.e. multiple - policies in the overlay), a single resource may violate multiple - constraints. - readOnly: true - customConstraints: + List of values to be used for this policy rule. This field can be + set only in policies for list constraints. + denyAll: + type: boolean description: >- - Output only. The names of the constraints against which all - `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only - contains `PolicyOverlay` then it contains the name of the configured - custom constraint, applicable to the specified policies. Otherwise - it contains the name of the constraint specified in - `CustomConstraintOverlay`. Format: - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - type: array - readOnly: true - items: - type: string - resourceCounts: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts + Setting this to true means that all values are denied. This field + can be set only in policies for list constraints. + allowAll: description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - readOnly: true - createTime: - format: google-datetime - readOnly: true + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. + type: boolean + enforce: + type: boolean description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. - type: string - name: + If `true`, then the policy is enforced. If `false`, then any + configuration is acceptable. This field can be set only in policies + for boolean constraints. + condition: description: >- - Output only. The resource name of the `OrgPolicyViolationsPreview`. - It has the following format: - `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` - Example: - `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` - readOnly: true - type: string - overlay: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay - description: Required. The proposed changes we are previewing violations for. - state: - readOnly: true - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - type: string - description: Output only. The state of the `OrgPolicyViolationsPreview`. - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview + A condition which determines whether this rule is used in the + evaluation of the policy. When set, the `expression` field in the + `Expr' must include from 1 to 10 subexpressions, joined by the "||" + or "&&" operators. Each subexpression must be of the form + "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". + or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". + where key_name and value_name are the resource names for Label Keys + and Values. These names are available from the Tag Manager Service. + An example expression is: "resource.matchTag('123456789/environment, + 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". + $ref: '#/components/schemas/GoogleTypeExpr' + description: A rule used to express this policy. type: object + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule + GoogleCloudPolicysimulatorV1ExplainedAccess: description: >- - OrgPolicyViolationsPreview is a resource providing a preview of the - violations that will exist if an OrgPolicy change is made. The list of - violations are modeled as child resources and retrieved via a - ListOrgPolicyViolations API call. There are potentially more - OrgPolicyViolations than could fit in an embedded field. Thus, the use - of a child resource instead of a field. - GoogleTypeExpr: - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - id: GoogleTypeExpr + Details about how a set of policies, listed in ExplainedPolicy, resulted + in a certain AccessState when replaying an access tuple. + id: GoogleCloudPolicysimulatorV1ExplainedAccess + type: object properties: - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - location: + policies: + type: array + items: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - type: string - expression: - type: string + If the AccessState is `UNKNOWN`, this field contains the policies + that led to that result. If the `AccessState` is `GRANTED` or + `NOT_GRANTED`, this field is omitted. + errors: description: >- - Textual representation of an expression in Common Expression - Language syntax. - description: + If the AccessState is `UNKNOWN`, this field contains a list of + errors explaining why the result is `UNKNOWN`. If the `AccessState` + is `GRANTED` or `NOT_GRANTED`, this field is omitted. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + accessState: type: string description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: object - GoogleCloudPolicysimulatorV1Replay: - description: A resource describing a `Replay`, or simulation. - type: object - properties: - name: - description: >- - Output only. The resource name of the `Replay`, which has the - following format: - `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, - where `{resource-id}` is the ID of the project, folder, or - organization that owns the Replay. Example: - `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` - readOnly: true - type: string - config: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' - description: Required. The configuration used for the `Replay`. - state: - description: Output only. The current state of the `Replay`. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - type: string + Whether the principal in the access tuple has permission to access + the resource in the access tuple under the given policies. enumDescriptions: - Default value. This value is unused. - - The `Replay` has not started yet. - - The `Replay` is currently running. - - The `Replay` has successfully completed. - - The `Replay` has finished with an error. - readOnly: true - resultsSummary: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary - readOnly: true - description: Output only. Summary statistics about the replayed log entries. - id: GoogleCloudPolicysimulatorV1Replay - GoogleIamV1AuditLogConfig: - type: object - properties: - exemptedMembers: - items: - type: string - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - logType: - description: The log type that this config enables. - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - type: string - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - id: GoogleIamV1AuditLogConfig - GoogleIamV1Binding: - type: object - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + GoogleIamV1Policy: properties: - condition: + version: description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' - members: - type: array + format: int32 + type: integer + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. items: - type: string - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - role: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + type: array + bindings: + type: array description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + etag: + format: byte type: string - GoogleCloudPolicysimulatorV1ReplayResultsSummary: - description: Summary statistics about the replayed log entries. - type: object - properties: - unchangedCount: - type: integer - format: int32 - description: >- - The number of replayed log entries with no difference between - baseline and simulated policies. - newestDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of the newest log entry replayed. - oldestDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of the oldest log entry replayed. - differenceCount: - format: int32 - type: integer description: >- - The number of replayed log entries with a difference between - baseline and simulated policies. - logCount: - format: int32 - type: integer - description: The total number of log entries replayed. - errorCount: - type: integer - description: The number of log entries that could not be replayed. - format: int32 - id: GoogleCloudPolicysimulatorV1ReplayResultsSummary - GoogleCloudOrgpolicyV2AlternatePolicySpec: + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. - type: object - id: GoogleCloudOrgpolicyV2AlternatePolicySpec - properties: - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Specify constraint for configurations of Google Cloud resources. - launch: - description: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. - type: string - GoogleCloudPolicysimulatorV1AccessTuple: - description: Information about the principal, resource, and permission to check. - properties: - principal: - type: string - description: >- - Required. The principal whose access you want to check, in the form - of the email address that represents that principal. For example, - `alice@example.com` or - `my-service-account@my-project.iam.gserviceaccount.com`. The - principal must be a Google Account or a service account. Other types - of principals are not supported. - fullResourceName: - type: string - description: >- - Required. The full resource name that identifies the resource. For - example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - For examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - permission: - type: string - description: >- - Required. The IAM permission to check for the specified principal - and resource. For a complete list of IAM permissions, see - https://cloud.google.com/iam/help/permissions/reference. For a - complete list of predefined IAM roles and the permissions in each - role, see https://cloud.google.com/iam/help/roles/reference. - id: GoogleCloudPolicysimulatorV1AccessTuple + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + id: GoogleIamV1Policy type: object GoogleLongrunningOperation: - id: GoogleLongrunningOperation - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object properties: - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. metadata: description: >- Service-specific metadata associated with the operation. It @@ -952,14 +976,17 @@ components: description: >- The error result of the operation in case of failure or cancellation. - name: + done: + type: boolean description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. response: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is @@ -969,358 +996,97 @@ components: where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: + name: + type: string + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + id: GoogleLongrunningOperation + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + GoogleCloudPolicysimulatorV1AccessStateDiff: + description: >- + A summary and comparison of the principal's access under the current + (baseline) policies and the proposed (simulated) policies for a single + access tuple. + id: GoogleCloudPolicysimulatorV1AccessStateDiff type: object - description: The proposed changes to OrgPolicy. - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay properties: - policies: + simulated: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' description: >- - Optional. The OrgPolicy changes to preview violations for. Any - existing OrgPolicies with the same name will be overridden in the - simulation. That is, violations will be determined as if all - policies in the overlay were created or updated. - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay - type: array - customConstraints: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay - type: array - description: >- - Optional. The OrgPolicy CustomConstraint changes to preview - violations for. Any existing CustomConstraints with the same name - will be overridden in the simulation. That is, violations will be - determined as if all custom constraints in the overlay were - instantiated. Only a single custom_constraint is supported in the - overlay at a time. For evaluating multiple constraints, multiple - `GenerateOrgPolicyViolationsPreview` requests are made, where each - request evaluates a single constraint. - GoogleCloudPolicysimulatorV1ExplainedPolicy: - id: GoogleCloudPolicysimulatorV1ExplainedPolicy - type: object - description: Details about how a specific IAM Policy contributed to the access check. - properties: - relevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - type: string - description: >- - The relevance of this policy to the overall determination in the - TroubleshootIamPolicyResponse. If the user who created the Replay - does not have access to the policy, this field is omitted. - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - bindingExplanations: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation - description: >- - Details about how each binding in the policy affects the principal's - ability, or inability, to use the permission for the resource. If - the user who created the Replay does not have access to the policy, - this field is omitted. - type: array - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: >- - The IAM policy attached to the resource. If the user who created the - Replay does not have access to the policy, this field is empty. - fullResourceName: - type: string - description: >- - The full resource name that identifies the resource. For example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - If the user who created the Replay does not have access to the - policy, this field is omitted. For examples of full resource names - for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - access: - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. - type: string - description: >- - Indicates whether _this policy_ provides the specified permission to - the specified principal for the specified resource. This field does - _not_ indicate whether the principal actually has the permission for - the resource. There might be another policy that overrides this - policy. To determine whether the principal actually has the - permission, use the `access` field in the - TroubleshootIamPolicyResponse. - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - GoogleTypeDate: - type: object - id: GoogleTypeDate - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - properties: - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - format: int32 - year: - type: integer - format: int32 - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - month: - format: int32 - type: integer - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: - id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership - properties: - relevance: - description: >- - The relevance of the principal's status to the overall determination - for the binding. - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - type: string - membership: - description: Indicates whether the binding includes the principal. - enum: - - MEMBERSHIP_UNSPECIFIED - - MEMBERSHIP_INCLUDED - - MEMBERSHIP_NOT_INCLUDED - - MEMBERSHIP_UNKNOWN_INFO_DENIED - - MEMBERSHIP_UNKNOWN_UNSUPPORTED - enumDescriptions: - - Default value. This value is unused. - - >- - The binding includes the principal. The principal can be included - directly or indirectly. For example: * A principal is included - directly if that principal is listed in the binding. * A principal - is included indirectly if that principal is in a Google group or - Google Workspace domain that is listed in the binding. - - The binding does not include the principal. - - >- - The user who created the Replay is not allowed to access the - binding. - - >- - The principal is an unsupported type. Only Google Accounts and - service accounts are supported. - type: string - description: Details about whether the binding includes the principal. - type: object - GoogleCloudOrgpolicyV2PolicySpecPolicyRule: - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule - description: A rule used to express this policy. - type: object - properties: - enforce: - type: boolean - description: >- - If `true`, then the policy is enforced. If `false`, then any - configuration is acceptable. This field can be set only in policies - for boolean constraints. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - A condition which determines whether this rule is used in the - evaluation of the policy. When set, the `expression` field in the - `Expr' must include from 1 to 10 subexpressions, joined by the "||" - or "&&" operators. Each subexpression must be of the form - "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". - or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". - where key_name and value_name are the resource names for Label Keys - and Values. These names are available from the Tag Manager Service. - An example expression is: "resource.matchTag('123456789/environment, - 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". - values: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - description: >- - List of values to be used for this policy rule. This field can be - set only in policies for list constraints. - allowAll: - type: boolean - description: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - denyAll: - description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. - type: boolean - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview: - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview - type: object - properties: - createTime: - readOnly: true - format: google-datetime - description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. - type: string - overlay: - description: Required. The proposed changes we are previewing violations for. - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay - name: - readOnly: true - type: string - description: >- - Output only. The resource name of the `OrgPolicyViolationsPreview`. - It has the following format: - `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` - Example: - `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` - resourceCounts: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts - readOnly: true - description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - violationsCount: - description: >- - Output only. The number of OrgPolicyViolations in this - `OrgPolicyViolationsPreview`. This count may differ from - `resource_summary.noncompliant_count` because each - OrgPolicyViolation is specific to a resource **and** constraint. If - there are multiple constraints being evaluated (i.e. multiple - policies in the overlay), a single resource may violate multiple - constraints. - readOnly: true - format: int32 - type: integer - customConstraints: - description: >- - Output only. The names of the constraints against which all - `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only - contains `PolicyOverlay` then it contains the name of the configured - custom constraint, applicable to the specified policies. Otherwise - it contains the name of the constraint specified in - `CustomConstraintOverlay`. Format: - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - items: - type: string - readOnly: true - type: array - state: - type: string - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - description: Output only. The state of the `OrgPolicyViolationsPreview`. - readOnly: true - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - description: >- - OrgPolicyViolationsPreview is a resource providing a preview of the - violations that will exist if an OrgPolicy change is made. The list of - violations are modeled as child resources and retrieved via a - ListOrgPolicyViolations API call. There are potentially more - OrgPolicyViolations than could fit in an embedded field. Thus, the use - of a child resource instead of a field. - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: - properties: - noncompliant: - format: int32 - readOnly: true - description: >- - Output only. Number of scanned resources with at least one - violation. - type: integer - scanned: - format: int32 - description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - type: integer - readOnly: true - compliant: - type: integer - readOnly: true - description: Output only. Number of scanned resources with zero violations. - format: int32 - errors: - type: integer + The results of evaluating the access tuple under the proposed + (simulated) policies. If the AccessState couldn't be fully + evaluated, this field explains why. + baseline: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' description: >- - Output only. Number of resources that returned an error when - scanned. - readOnly: true - format: int32 - unenforced: - type: integer + The results of evaluating the access tuple under the current + (baseline) policies. If the AccessState couldn't be fully evaluated, + this field explains why. + accessChange: + enumDescriptions: + - Default value. This value is unused. + - >- + The principal's access did not change. This includes the case + where both baseline and simulated are UNKNOWN, but the unknown + information is equivalent. + - >- + The principal's access under both the current policies and the + proposed policies is `UNKNOWN`, but the unknown information + differs between them. + - >- + The principal had access under the current policies (`GRANTED`), + but will no longer have access after the proposed changes + (`NOT_GRANTED`). + - >- + The principal did not have access under the current policies + (`NOT_GRANTED`), but will have access after the proposed changes + (`GRANTED`). + - >- + This result can occur for the following reasons: * The principal + had access under the current policies (`GRANTED`), but their + access after the proposed changes is `UNKNOWN`. * The principal's + access under the current policies is `UNKNOWN`, but they will not + have access after the proposed changes (`NOT_GRANTED`). + - >- + This result can occur for the following reasons: * The principal + did not have access under the current policies (`NOT_GRANTED`), + but their access after the proposed changes is `UNKNOWN`. * The + principal's access under the current policies is `UNKNOWN`, but + they will have access after the proposed changes (`GRANTED`). + type: string + enum: + - ACCESS_CHANGE_TYPE_UNSPECIFIED + - NO_CHANGE + - UNKNOWN_CHANGE + - ACCESS_REVOKED + - ACCESS_GAINED + - ACCESS_MAYBE_REVOKED + - ACCESS_MAYBE_GAINED description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. - readOnly: true - format: int32 - type: object - description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts - GoogleCloudPolicysimulatorV1ExplainedAccess: + How the principal's access, specified in the AccessState field, + changed between the current (baseline) policies and proposed + (simulated) policies. + GoogleCloudPolicysimulatorV1BindingExplanation: description: >- - Details about how a set of policies, listed in ExplainedPolicy, resulted - in a certain AccessState when replaying an access tuple. + Details about how a binding in a policy affects a principal's ability to + use a permission. + id: GoogleCloudPolicysimulatorV1BindingExplanation properties: - accessState: + access: + description: >- + Required. Indicates whether _this binding_ provides the specified + permission to the specified principal for the specified resource. + This field does _not_ indicate whether the principal actually has + the permission for the resource. There might be another binding that + overrides this binding. To determine whether the principal actually + has the permission, use the `access` field in the + TroubleshootIamPolicyResponse. type: string enumDescriptions: - Default value. This value is unused. @@ -1332,41 +1098,106 @@ components: - >- The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate. - description: >- - Whether the principal in the access tuple has permission to access - the resource in the access tuple under the given policies. enum: - ACCESS_STATE_UNSPECIFIED - GRANTED - NOT_GRANTED - UNKNOWN_CONDITIONAL - UNKNOWN_INFO_DENIED - policies: - type: array - items: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' + rolePermission: + enumDescriptions: + - Default value. This value is unused. + - The permission is included in the role. + - The permission is not included in the role. + - >- + The user who created the Replay is not allowed to access the + binding. + enum: + - ROLE_PERMISSION_UNSPECIFIED + - ROLE_PERMISSION_INCLUDED + - ROLE_PERMISSION_NOT_INCLUDED + - ROLE_PERMISSION_UNKNOWN_INFO_DENIED + type: string description: >- - If the AccessState is `UNKNOWN`, this field contains the policies - that led to that result. If the `AccessState` is `GRANTED` or - `NOT_GRANTED`, this field is omitted. - errors: + Indicates whether the role granted by this binding contains the + specified permission. + role: description: >- - If the AccessState is `UNKNOWN`, this field contains a list of - errors explaining why the result is `UNKNOWN`. If the `AccessState` - is `GRANTED` or `NOT_GRANTED`, this field is omitted. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' + The role that this binding grants. For example, + `roles/compute.serviceAgent`. For a complete list of predefined IAM + roles, as well as the permissions in each role, see + https://cloud.google.com/iam/help/roles/reference. + type: string + relevance: + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + type: string + description: >- + The relevance of this binding to the overall determination for the + entire policy. + memberships: + description: >- + Indicates whether each principal in the binding includes the + principal specified in the request, either directly or indirectly. + Each key identifies a principal in the binding, and each value + indicates whether the principal in the binding includes the + principal in the request. For example, suppose that a binding + includes the following principals: * `user:alice@example.com` * + `group:product-eng@example.com` The principal in the replayed access + tuple is `user:bob@example.com`. This user is a principal of the + group `group:product-eng@example.com`. For the first principal in + the binding, the key is `user:alice@example.com`, and the + `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. + For the second principal in the binding, the key is + `group:product-eng@example.com`, and the `membership` field in the + value is set to `MEMBERSHIP_INCLUDED`. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership + condition: + $ref: '#/components/schemas/GoogleTypeExpr' + description: >- + A condition expression that prevents this binding from granting + access unless the expression evaluates to `true`. To learn about IAM + Conditions, see + https://cloud.google.com/iam/docs/conditions-overview. + rolePermissionRelevance: + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + type: string + description: >- + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH type: object - id: GoogleCloudPolicysimulatorV1ExplainedAccess GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig type: object + id: GoogleIamV1AuditConfig properties: auditLogConfigs: + type: array items: $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - type: array description: The configuration for logging of each type of permission. service: description: >- @@ -1392,104 +1223,26 @@ components: enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. - GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - description: >- - A message that holds specific allowed and denied values. This message - can define specific values and subtrees of the Resource Manager resource - hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or - denied. This is achieved by using the `under:` and optional `is:` - prefixes. The `under:` prefix is used to denote resource subtree values. - The `is:` prefix is used to denote specific values, and is required only - if the value contains a ":". Values prefixed with "is:" are treated the - same as values with no prefix. Ancestry subtrees must be in one of the - following formats: - `projects/` (for example, - `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - - `organizations/` (for example, `organizations/1234`) The - `supports_under` field of the associated `Constraint` defines whether - ancestry prefixes can be used. - type: object - properties: - deniedValues: - items: - type: string - description: List of values denied at this resource. - type: array - allowedValues: - description: List of values allowed at this resource. - items: - type: string - type: array - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: type: object - description: A change to an OrgPolicy. + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay properties: policyParent: type: string description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" - policy: - description: Optional. The new or updated OrgPolicy. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay - GoogleCloudOrgpolicyV2Policy: - type: object - description: >- - Defines an organization policy which is used to specify constraints for - configurations of Google Cloud resources. - properties: - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Basic information about the Organization Policy. - alternate: - description: Deprecated. - deprecated: true - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - dryRunSpec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: >- - Dry-run policy. Audit-only policy, can be used to monitor how the - policy would have impacted the existing and future resources if it's - enforced. - name: - description: >- - Immutable. The resource name of the policy. Must be one of the - following forms, where `constraint_name` is the name of the - constraint which this policy configures: * - `projects/{project_number}/policies/{constraint_name}` * - `folders/{folder_id}/policies/{constraint_name}` * - `organizations/{organization_id}/policies/{constraint_name}` For - example, `projects/123/policies/compute.disableSerialPortAccess`. - Note: `projects/{project_id}/policies/{constraint_name}` is also an - acceptable name for API requests, but responses will return the name - using the equivalent project number. - type: string - etag: - type: string - description: >- - Optional. An opaque tag indicating the current state of the policy, - used for concurrency control. This 'etag' is computed by the server - based on the value of other fields, and may be sent on update and - delete requests to ensure the client has an up-to-date value before - proceeding. - id: GoogleCloudOrgpolicyV2Policy - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata: + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" + policy: + description: Optional. The new or updated OrgPolicy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + description: A change to an OrgPolicy. + GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: + id: >- + GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata + description: >- + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. properties: - resourcesPending: - description: Number of resources still to scan. - type: integer - format: int32 - resourcesScanned: - type: integer - format: int32 - description: Number of resources already scanned. - resourcesFound: - type: integer - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - format: int32 state: enum: - PREVIEW_STATE_UNSPECIFIED @@ -1497,65 +1250,105 @@ components: - PREVIEW_RUNNING - PREVIEW_SUCCEEDED - PREVIEW_FAILED + type: string enumDescriptions: - The state is unspecified. - The OrgPolicyViolationsPreview has not been created yet. - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. - description: Output only. The current state of the operation. - readOnly: true - type: string + description: The current state of the operation. + resourcesFound: + type: integer + format: int32 + description: >- + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + resourcesPending: + format: int32 + description: Number of resources still to scan. + type: integer + resourcesScanned: + format: int32 + type: integer + description: Number of resources already scanned. requestTime: - type: string description: Time when the request was received. + type: string format: google-datetime startTime: description: >- - Time when the request started processing, i.e., when the state was + Time when the request started processing, i.e. when the state was set to RUNNING. - type: string format: google-datetime - id: >- - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata + type: string type: object - description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay properties: customConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' description: Optional. The new or updated custom constraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' customConstraintParent: type: string description: >- Optional. Resource the constraint is attached to. Example: "organization/987654" - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay - type: object description: A change to an OrgPolicy custom constraint. - GoogleCloudPolicysimulatorV1ReplayResult: + type: object + GoogleRpcStatus: + id: GoogleRpcStatus + type: object properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: + type: string description: >- - The error that caused the access tuple replay to fail. This field is - only included for access tuples that were not replayed successfully. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: + type: array + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudPolicysimulatorV1ReplayResult: + description: The result of replaying a single access tuple against a simulated state. + id: GoogleCloudPolicysimulatorV1ReplayResult + properties: diff: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayDiff' description: >- The difference between the principal's access under the current (baseline) policies and the principal's access under the proposed (simulated) policies. This field is only included for access tuples that were successfully replayed and had different results under the current policies and the proposed policies. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayDiff' + accessTuple: + description: >- + The access tuple that was replayed. This field includes information + about the principal, resource, and permission that were involved in + the access attempt. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' lastSeenDate: description: The latest date this access tuple was seen in the logs. $ref: '#/components/schemas/GoogleTypeDate' - parent: - type: string - description: The Replay that the access tuple was included in. name: type: string description: >- @@ -1564,159 +1357,111 @@ components: where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234` - accessTuple: + parent: + type: string + description: The Replay that the access tuple was included in. + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - The access tuple that was replayed. This field includes information - about the principal, resource, and permission that were involved in - the access attempt. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' - id: GoogleCloudPolicysimulatorV1ReplayResult + The error that caused the access tuple replay to fail. This field is + only included for access tuples that were not replayed successfully. type: object - description: The result of replaying a single access tuple against a simulated state. - GoogleCloudPolicysimulatorV1ReplayConfig: - id: GoogleCloudPolicysimulatorV1ReplayConfig - description: The configuration used for a Replay. - properties: - policyOverlay: - type: object - description: >- - A mapping of the resources that you want to simulate policies for - and the policies that you want to simulate. Keys are the full - resource names for the resources. For example, - `//cloudresourcemanager.googleapis.com/projects/my-project`. For - examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - Values are Policy objects representing the policies that you want to - simulate. Replays automatically take into account any IAM policies - inherited through the resource hierarchy, and any policies set on - descendant resources. You do not need to include these policies in - the policy overlay. - additionalProperties: - $ref: '#/components/schemas/GoogleIamV1Policy' - logSource: - type: string - description: The logs to use as input for the Replay. - enum: - - LOG_SOURCE_UNSPECIFIED - - RECENT_ACCESSES - enumDescriptions: - - >- - An unspecified log source. If the log source is unspecified, the - Replay defaults to using `RECENT_ACCESSES`. - - >- - All access logs from the last 90 days. These logs may not include - logs from the most recent 7 days. + GoogleIamV1Binding: + id: GoogleIamV1Binding type: object - GoogleIamV1Policy: + description: Associates `members`, or principals, with a `role`. properties: - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - format: byte - type: string - bindings: + members: description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. items: - $ref: '#/components/schemas/GoogleIamV1Binding' + type: string type: array - version: - format: int32 - type: integer + condition: description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - auditConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. - type: array - id: GoogleIamV1Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - type: object - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - type: object - properties: - nextPageToken: + $ref: '#/components/schemas/GoogleTypeExpr' + role: type: string - description: The standard List next-page token. - operations: - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - A list of operations that matches the specified filter in the - request. + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). GoogleCloudPolicysimulatorV1ReplayDiff: id: GoogleCloudPolicysimulatorV1ReplayDiff + type: object + description: >- + The difference between the results of evaluating an access tuple under + the current (baseline) policies and under the proposed (simulated) + policies. This difference explains how a principal's access could change + if the proposed policies were applied. properties: accessDiff: description: >- @@ -1725,81 +1470,153 @@ components: single access tuple. The evaluation of the principal's access is reported in the AccessState field. $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessStateDiff' - description: >- - The difference between the results of evaluating an access tuple under - the current (baseline) policies and under the proposed (simulated) - policies. This difference explains how a principal's access could change - if the proposed policies were applied. - type: object - GoogleCloudOrgpolicyV2PolicySpec: - description: >- - Defines a Google Cloud policy specification which is used to specify - constraints for configurations of Google Cloud resources. + GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: + properties: + relevance: + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + description: >- + The relevance of the principal's status to the overall determination + for the binding. + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + type: string + membership: + description: Indicates whether the binding includes the principal. + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + The binding includes the principal. The principal can be included + directly or indirectly. For example: * A principal is included + directly if that principal is listed in the binding. * A principal + is included indirectly if that principal is in a Google group or + Google Workspace domain that is listed in the binding. + - The binding does not include the principal. + - >- + The user who created the Replay is not allowed to access the + binding. + - >- + The principal is an unsupported type. Only Google Accounts and + service accounts are supported. + enum: + - MEMBERSHIP_UNSPECIFIED + - MEMBERSHIP_INCLUDED + - MEMBERSHIP_NOT_INCLUDED + - MEMBERSHIP_UNKNOWN_INFO_DENIED + - MEMBERSHIP_UNKNOWN_UNSUPPORTED + description: Details about whether the binding includes the principal. + id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership type: object - id: GoogleCloudOrgpolicyV2PolicySpec + GoogleTypeExpr: + id: GoogleTypeExpr properties: - inheritFromParent: + title: description: >- - Determines the inheritance behavior for this policy. If - `inherit_from_parent` is true, policy rules set higher up in the - hierarchy (up to the closest root) are inherited and present in the - effective policy. If it is false, then no rules are inherited, and - this policy becomes the new root for evaluation. This field can be - set only for policies which configure list constraints. - type: boolean - reset: - type: boolean + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + description: description: >- - Ignores policies set above this resource and restores the - `constraint_default` enforcement behavior of the specific constraint - at this resource. This field can be set in policies for either list - or boolean constraints. If set, `rules` must be empty and - `inherit_from_parent` must be set to false. - etag: + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + type: string + expression: type: string description: >- - An opaque tag indicating the current version of the policySpec, used - for concurrency control. This field is ignored if used in a - `CreatePolicy` request. When the policy is returned from either a - `GetPolicy` or a `ListPolicies` request, this `etag` indicates the - version of the current policySpec to use when executing a - read-modify-write loop. When the policy is returned from a - `GetEffectivePolicy` request, the `etag` will be unset. - updateTime: - format: google-datetime + Textual representation of an expression in Common Expression + Language syntax. + location: + type: string description: >- - Output only. The time stamp this was previously updated. This - represents the last time a call to `CreatePolicy` or `UpdatePolicy` - was made for that policy. + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + type: object + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay + properties: + customConstraint: + description: Optional. The new or updated custom constraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + customConstraintParent: type: string - readOnly: true - rules: description: >- - In policies for boolean constraints, the following requirements - apply: - There must be one and only one policy rule where condition - is unset. - Boolean policy rules with conditions must set `enforced` - to the opposite of the policy rule without a condition. - During - policy evaluation, policy rules with conditions that are true for a - target resource take precedence. - type: array - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + Optional. Resource the constraint is attached to. Example: + "organization/987654" + description: A change to an OrgPolicy custom constraint. + type: object + GoogleCloudOrgpolicyV2AlternatePolicySpec: + properties: + spec: + description: Specify constraint for configurations of Google Cloud resources. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + launch: + description: >- + Reference to the launch that will be used while audit logging and to + control the launch. Should be set only in the alternate policy. + type: string + type: object + description: >- + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run/darklaunch. + id: GoogleCloudOrgpolicyV2AlternatePolicySpec + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: + description: A change to an OrgPolicy. + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + type: object + properties: + policyParent: + description: >- + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" + type: string + policy: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + description: Optional. The new or updated OrgPolicy. GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay: - description: The proposed changes to OrgPolicy. type: object - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + description: The proposed changes to OrgPolicy. properties: policies: - type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay description: >- Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated. + type: array + customConstraints: items: $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay - customConstraints: + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay type: array description: >- Optional. The OrgPolicy CustomConstraint changes to preview @@ -1810,38 +1627,197 @@ components: overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint. + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + description: >- + A message that holds specific allowed and denied values. This message + can define specific values and subtrees of the Resource Manager resource + hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or + denied. This is achieved by using the `under:` and optional `is:` + prefixes. The `under:` prefix is used to denote resource subtree values. + The `is:` prefix is used to denote specific values, and is required only + if the value contains a ":". Values prefixed with "is:" are treated the + same as values with no prefix. Ancestry subtrees must be in one of the + following formats: - `projects/` (for example, + `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - + `organizations/` (for example, `organizations/1234`) The + `supports_under` field of the associated `Constraint` defines whether + ancestry prefixes can be used. + type: object + properties: + deniedValues: + type: array items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay - parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - quotaUser: + type: string + description: List of values denied at this resource. + allowedValues: + description: List of values allowed at this resource. + type: array + items: + type: string + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: + id: >- + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - key: + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. + type: object + properties: + scanned: + description: >- + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error + type: integer + format: int32 + readOnly: true + unenforced: + readOnly: true + description: >- + Output only. Number of resources where the constraint was not + enforced, i.e. the Policy set `enforced: false` for that resource. + type: integer + format: int32 + errors: + format: int32 + readOnly: true + description: >- + Output only. Number of resources that returned an error when + scanned. + type: integer + noncompliant: + readOnly: true + format: int32 + type: integer + description: >- + Output only. Number of scanned resources with at least one + violation. + compliant: + format: int32 + description: Output only. Number of scanned resources with zero violations. + readOnly: true + type: integer + GoogleCloudOrgpolicyV2CustomConstraint: + id: GoogleCloudOrgpolicyV2CustomConstraint + properties: + condition: + type: string + description: >- + Org policy condition/expression. For example: + `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, + `resource.management.auto_upgrade == true` The max length of the + condition is 1000 characters. + actionType: + enumDescriptions: + - Unspecified. Results in an error. + - Allowed action type. + - Deny action type. + enum: + - ACTION_TYPE_UNSPECIFIED + - ALLOW + - DENY + description: Allow or deny type. + type: string + resourceTypes: + items: + type: string + type: array + description: >- + Immutable. The resource instance type on which this policy applies. + Format will be of the form : `/` Example: * + `compute.googleapis.com/Instance`. + displayName: + description: >- + One line display name for the UI. The max length of the display_name + is 200 characters. + type: string + methodTypes: + description: All the operations being applied for this constraint. + items: + enumDescriptions: + - Unspecified. Results in an error. + - Constraint applied when creating the resource. + - Constraint applied when updating the resource. + - >- + Constraint applied when deleting the resource. Not supported + yet. + - Constraint applied when removing an IAM grant. + - Constraint applied when enforcing forced tagging. + type: string + enum: + - METHOD_TYPE_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + - REMOVE_GRANT + - GOVERN_TAGS + type: array + name: + type: string + description: >- + Immutable. Name of the constraint. This is unique within the + organization. Format of the name should be * + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The + max length is 70 characters and the minimum length is 1. Note that + the prefix `organizations/{organization_id}/customConstraints/` is + not counted. + updateTime: + readOnly: true + format: google-datetime + type: string + description: >- + Output only. The last time this custom constraint was updated. This + represents the last time that the `CreateCustomConstraint` or + `UpdateCustomConstraint` RPC was called + description: + type: string + description: >- + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + type: object 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. + A custom constraint defined by customers which can *only* be applied to + the given resource types and organization. By creating a custom + constraint, customers can apply policies of this custom constraint. + *Creating a custom constraint itself does NOT apply any policy + enforcement*. + GoogleIamV1AuditLogConfig: + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + id: GoogleIamV1AuditLogConfig + properties: + exemptedMembers: + items: + type: string + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + logType: + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + description: The log type that this config enables. + type: object + parameters: + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: key + name: uploadType schema: type: string alt: @@ -1854,25 +1830,40 @@ components: - json - media - proto - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string - _.xgafv: - description: V1 error format. + 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. in: query - name: $.xgafv + name: key schema: type: string - enum: - - '1' - - '2' - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token schema: type: string callback: @@ -1881,46 +1872,74 @@ components: name: callback schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: upload_protocol + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string x-stackQL-resources: - operations: - id: google.policysimulator.operations - name: operations - title: Operations + results: + id: google.policysimulator.results + name: results + title: Results methods: - folders_locations_org_policy_violations_previews_operations_get: + organizations_locations_replays_results_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_operations_list: + objectKey: $.replayResults + projects_locations_replays_results_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - folders_locations_replays_operations_get: + objectKey: $.replayResults + folders_locations_replays_results_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.replayResults + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/results/methods/organizations_locations_replays_results_list + - $ref: >- + #/components/x-stackQL-resources/results/methods/projects_locations_replays_results_list + - $ref: >- + #/components/x-stackQL-resources/results/methods/folders_locations_replays_results_list + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.policysimulator.operations + name: operations + title: Operations + methods: organizations_locations_replays_operations_get: operation: $ref: >- @@ -1943,10 +1962,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_org_policy_violations_previews_operations_get: + projects_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -1958,10 +1977,32 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_replays_operations_get: + projects_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_replays_operations_list: + operation: + $ref: >- + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + folders_locations_replays_operations_get: + operation: + $ref: >- + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_org_policy_violations_previews_operations_get: + operation: + $ref: >- + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -1980,24 +2021,24 @@ components: objectKey: $.operations sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_org_policy_violations_previews_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_org_policy_violations_previews_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_org_policy_violations_previews_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get + #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_list + #/components/x-stackQL-resources/operations/methods/folders_locations_org_policy_violations_previews_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_list - $ref: '#/components/x-stackQL-resources/operations/methods/operations_get' - $ref: >- #/components/x-stackQL-resources/operations/methods/operations_list @@ -2005,173 +2046,88 @@ components: update: [] replace: [] delete: [] - results: - id: google.policysimulator.results - name: results - title: Results - methods: - folders_locations_replays_results_list: - operation: - $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.replayResults - organizations_locations_replays_results_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.replayResults - projects_locations_replays_results_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.replayResults - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/results/methods/folders_locations_replays_results_list - - $ref: >- - #/components/x-stackQL-resources/results/methods/organizations_locations_replays_results_list - - $ref: >- - #/components/x-stackQL-resources/results/methods/projects_locations_replays_results_list - insert: [] - update: [] - replace: [] - delete: [] replays: id: google.policysimulator.replays name: replays title: Replays methods: - folders_locations_replays_create: + organizations_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_get: + organizations_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_get: + projects_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_create: + projects_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_create: + folders_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_get: + folders_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/replays/methods/folders_locations_replays_get - $ref: >- #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_get - $ref: >- #/components/x-stackQL-resources/replays/methods/projects_locations_replays_get - insert: - $ref: >- - #/components/x-stackQL-resources/replays/methods/folders_locations_replays_create + #/components/x-stackQL-resources/replays/methods/folders_locations_replays_get + insert: - $ref: >- #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_create - $ref: >- #/components/x-stackQL-resources/replays/methods/projects_locations_replays_create + - $ref: >- + #/components/x-stackQL-resources/replays/methods/folders_locations_replays_create update: [] replace: [] delete: [] paths: - /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - 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. - operationId: >- - policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: orgPolicyViolationsPreviewsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: - parameters: *ref_1 + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.folders.locations.replays.operations.list + description: Lists the results of running a Replay. + operationId: policysimulator.organizations.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2183,10 +2139,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2201,26 +2158,22 @@ paths: schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + type: integer + format: int32 + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: policysimulator.folders.locations.replays.operations.get + operationId: policysimulator.organizations.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2235,7 +2188,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2254,11 +2207,13 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_1 get: - description: Lists the results of running a Replay. - operationId: policysimulator.folders.locations.replays.results.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.organizations.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2270,11 +2225,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2297,11 +2251,15 @@ paths: name: pageToken schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays: + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/replays: parameters: *ref_1 post: description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.folders.locations.replays.create + operationId: policysimulator.organizations.locations.replays.create requestBody: content: application/json: @@ -2321,7 +2279,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2330,13 +2288,13 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_1 get: description: >- Gets the specified Replay. Each `Replay` is available for at least 7 days. - operationId: policysimulator.folders.locations.replays.get + operationId: policysimulator.organizations.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2351,7 +2309,7 @@ paths: $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2365,13 +2323,15 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.organizations.locations.replays.get + 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. + operationId: >- + policysimulator.organizations.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2383,7 +2343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -2396,15 +2356,20 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/replays: parameters: *ref_1 post: description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.organizations.locations.replays.create + operationId: policysimulator.projects.locations.replays.create requestBody: content: application/json: @@ -2424,7 +2389,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -2433,11 +2398,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_1 get: - description: Lists the results of running a Replay. - operationId: policysimulator.organizations.locations.replays.results.list + description: >- + Gets the specified Replay. Each `Replay` is available for at least 7 + days. + operationId: policysimulator.projects.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2449,11 +2416,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -2467,23 +2433,14 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: policysimulator.organizations.locations.replays.operations.get + operationId: policysimulator.projects.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2498,7 +2455,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -2517,13 +2474,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.organizations.locations.replays.operations.list + operationId: policysimulator.projects.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2538,7 +2495,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -2553,11 +2510,11 @@ paths: schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -2565,15 +2522,11 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_1 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. - operationId: >- - policysimulator.organizations.locations.orgPolicyViolationsPreviews.operations.get + description: Lists the results of running a Replay. + operationId: policysimulator.projects.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2585,10 +2538,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -2598,15 +2552,19 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: *ref_1 get: @@ -2649,11 +2607,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays: + /v1/folders/{foldersId}/locations/{locationsId}/replays: parameters: *ref_1 post: description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.projects.locations.replays.create + operationId: policysimulator.folders.locations.replays.create requestBody: content: application/json: @@ -2673,7 +2631,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2682,13 +2640,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_1 get: description: >- Gets the specified Replay. Each `Replay` is available for at least 7 days. - operationId: policysimulator.projects.locations.replays.get + operationId: policysimulator.folders.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2703,7 +2661,7 @@ paths: $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2717,11 +2675,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_1 get: - description: Lists the results of running a Replay. - operationId: policysimulator.projects.locations.replays.results.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.folders.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2733,11 +2693,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2752,21 +2711,26 @@ paths: schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.projects.locations.replays.operations.list + 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. + operationId: policysimulator.folders.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2778,10 +2742,49 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: replaysId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: + parameters: *ref_1 + get: + description: Lists the results of running a Replay. + operationId: policysimulator.folders.locations.replays.results.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + parameters: + - in: path + name: foldersId required: true schema: type: string @@ -2804,18 +2807,15 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: policysimulator.projects.locations.replays.operations.get + operationId: >- + policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2830,7 +2830,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2840,7 +2840,7 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId required: true schema: type: string @@ -2895,15 +2895,15 @@ paths: schema: $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: diff --git a/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml b/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml index 799b29ea..ceaa150d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -34,6 +34,200 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: + description: Response for TroubleshootIamPolicy. + type: object + id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + properties: + explainedPolicies: + description: >- + List of IAM policies that were evaluated to check the principal's + permissions, with annotations to indicate how each policy + contributed to the final result. The list of policies can include + the policy for the resource itself. It can also include policies + that are inherited from higher levels of the resource hierarchy, + including the organization, the folder, and the project. To learn + more about the resource hierarchy, see + https://cloud.google.com/iam/help/resource-hierarchy. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy + access: + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The sender of the request does not have access to all of the + policies that Policy Troubleshooter needs to evaluate. + description: >- + Indicates whether the principal has the specified permission for the + specified resource, based on evaluating all of the applicable IAM + policies. + type: string + errors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The general errors contained in the troubleshooting response. + type: array + GoogleRpcStatus: + properties: + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + id: GoogleRpcStatus + GoogleCloudPolicytroubleshooterV1BindingExplanation: + type: object + properties: + relevance: + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + description: >- + The relevance of this binding to the overall determination for the + entire policy. + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + type: string + memberships: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership + type: object + description: >- + Indicates whether each principal in the binding includes the + principal specified in the request, either directly or indirectly. + Each key identifies a principal in the binding, and each value + indicates whether the principal in the binding includes the + principal in the request. For example, suppose that a binding + includes the following principals: * `user:alice@example.com` * + `group:product-eng@example.com` You want to troubleshoot access for + `user:bob@example.com`. This user is a principal of the group + `group:product-eng@example.com`. For the first principal in the + binding, the key is `user:alice@example.com`, and the `membership` + field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the + second principal in the binding, the key is + `group:product-eng@example.com`, and the `membership` field in the + value is set to `MEMBERSHIP_INCLUDED`. + role: + type: string + description: >- + The role that this binding grants. For example, + `roles/compute.serviceAgent`. For a complete list of predefined IAM + roles, as well as the permissions in each role, see + https://cloud.google.com/iam/help/roles/reference. + access: + description: >- + Required. Indicates whether _this binding_ provides the specified + permission to the specified principal for the specified resource. + This field does _not_ indicate whether the principal actually has + the permission for the resource. There might be another binding that + overrides this binding. To determine whether the principal actually + has the permission, use the `access` field in the + TroubleshootIamPolicyResponse. + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The sender of the request does not have access to all of the + policies that Policy Troubleshooter needs to evaluate. + type: string + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + condition: + $ref: '#/components/schemas/GoogleTypeExpr' + description: >- + A condition expression that prevents this binding from granting + access unless the expression evaluates to `true`. To learn about IAM + Conditions, see + https://cloud.google.com/iam/help/conditions/overview. + rolePermission: + enumDescriptions: + - Default value. This value is unused. + - The permission is included in the role. + - The permission is not included in the role. + - The sender of the request is not allowed to access the binding. + enum: + - ROLE_PERMISSION_UNSPECIFIED + - ROLE_PERMISSION_INCLUDED + - ROLE_PERMISSION_NOT_INCLUDED + - ROLE_PERMISSION_UNKNOWN_INFO_DENIED + description: >- + Indicates whether the role granted by this binding contains the + specified permission. + type: string + rolePermissionRelevance: + type: string + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + description: >- + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. + id: GoogleCloudPolicytroubleshooterV1BindingExplanation + description: >- + Details about how a binding in a policy affects a principal's ability to + use a permission. GoogleIamV1Policy: description: >- An Identity and Access Management (IAM) policy, which specifies access @@ -69,11 +263,27 @@ components: timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - id: GoogleIamV1Policy - type: object properties: + bindings: + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + type: array + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' etag: - format: byte description: >- `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each @@ -88,21 +298,10 @@ components: overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. type: string - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - type: array + format: byte version: + format: int32 + type: integer description: >- Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any @@ -120,144 +319,41 @@ components: specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - format: int32 - type: integer - auditConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - type: array - description: Specifies cloud audit logging configuration for this policy. - GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest: type: object - id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest + id: GoogleIamV1Policy + GoogleIamV1AuditLogConfig: + id: GoogleIamV1AuditLogConfig + type: object properties: - accessTuple: + exemptedMembers: description: >- - The information to use for checking whether a principal has a - permission for a resource. - $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' - description: Request for TroubleshootIamPolicy. - GoogleTypeExpr: - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - description: - type: string - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - location: - type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - id: GoogleTypeExpr - type: object - GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: - type: object - id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse - description: Response for TroubleshootIamPolicy. - properties: - errors: - type: array - description: The general errors contained in the troubleshooting response. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - access: - description: >- - Indicates whether the principal has the specified permission for the - specified resource, based on evaluating all of the applicable IAM - policies. - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The sender of the request does not have access to all of the - policies that Policy Troubleshooter needs to evaluate. - type: string - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - explainedPolicies: - description: >- - List of IAM policies that were evaluated to check the principal's - permissions, with annotations to indicate how each policy - contributed to the final result. The list of policies can include - the policy for the resource itself. It can also include policies - that are inherited from higher levels of the resource hierarchy, - including the organization, the folder, and the project. To learn - more about the resource hierarchy, see - https://cloud.google.com/iam/help/resource-hierarchy. - items: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy - type: array - GoogleRpcStatus: - type: object - properties: - details: + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + type: string type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + logType: type: string - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. + description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. GoogleCloudPolicytroubleshooterV1AccessTuple: + description: Information about the principal, resource, and permission to check. + id: GoogleCloudPolicytroubleshooterV1AccessTuple type: object properties: fullResourceName: @@ -269,6 +365,7 @@ components: https://cloud.google.com/iam/help/troubleshooter/full-resource-names. type: string principal: + type: string description: >- Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, @@ -276,129 +373,29 @@ components: `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported. - type: string permission: - type: string description: >- Required. The IAM permission to check for the specified principal and resource. For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. - id: GoogleCloudPolicytroubleshooterV1AccessTuple - description: Information about the principal, resource, and permission to check. - GoogleIamV1AuditLogConfig: - type: object - properties: - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - logType: - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - type: string - description: The log type that this config enables. - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - id: GoogleIamV1AuditLogConfig - GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: - id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership - properties: - membership: - description: Indicates whether the binding includes the principal. - enumDescriptions: - - Default value. This value is unused. - - >- - The binding includes the principal. The principal can be included - directly or indirectly. For example: * A principal is included - directly if that principal is listed in the binding. * A principal - is included indirectly if that principal is in a Google group or - Google Workspace domain that is listed in the binding. - - The binding does not include the principal. - - The sender of the request is not allowed to access the binding. - - >- - The principal is an unsupported type. Only Google Accounts and - service accounts are supported. - enum: - - MEMBERSHIP_UNSPECIFIED - - MEMBERSHIP_INCLUDED - - MEMBERSHIP_NOT_INCLUDED - - MEMBERSHIP_UNKNOWN_INFO_DENIED - - MEMBERSHIP_UNKNOWN_UNSUPPORTED - type: string - relevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: >- - The relevance of the principal's status to the overall determination - for the binding. type: string - description: Details about whether the binding includes the principal. + GoogleCloudPolicytroubleshooterV1ExplainedPolicy: type: object - GoogleIamV1AuditConfig: + id: GoogleCloudPolicytroubleshooterV1ExplainedPolicy properties: - auditLogConfigs: - description: The configuration for logging of each type of permission. + bindingExplanations: type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - service: - type: string description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - id: GoogleIamV1AuditConfig - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - type: object - GoogleCloudPolicytroubleshooterV1BindingExplanation: - id: GoogleCloudPolicytroubleshooterV1BindingExplanation - type: object - properties: - rolePermissionRelevance: + Details about how each binding in the policy affects the principal's + ability, or inability, to use the permission for the resource. If + the sender of the request does not have access to the policy, this + field is omitted. + items: + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation + relevance: enumDescriptions: - Default value. This value is unused. - >- @@ -407,81 +404,31 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - type: string enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL - HIGH description: >- - The relevance of the permission's existence, or nonexistence, in the - role to the overall determination for the entire policy. - relevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. + The relevance of this policy to the overall determination in the + TroubleshootIamPolicyResponse. If the sender of the request does not + have access to the policy, this field is omitted. type: string + access: description: >- - The relevance of this binding to the overall determination for the - entire policy. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - A condition expression that prevents this binding from granting - access unless the expression evaluates to `true`. To learn about IAM - Conditions, see - https://cloud.google.com/iam/help/conditions/overview. - memberships: - description: >- - Indicates whether each principal in the binding includes the - principal specified in the request, either directly or indirectly. - Each key identifies a principal in the binding, and each value - indicates whether the principal in the binding includes the - principal in the request. For example, suppose that a binding - includes the following principals: * `user:alice@example.com` * - `group:product-eng@example.com` You want to troubleshoot access for - `user:bob@example.com`. This user is a principal of the group - `group:product-eng@example.com`. For the first principal in the - binding, the key is `user:alice@example.com`, and the `membership` - field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the - second principal in the binding, the key is - `group:product-eng@example.com`, and the `membership` field in the - value is set to `MEMBERSHIP_INCLUDED`. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership - role: - description: >- - The role that this binding grants. For example, - `roles/compute.serviceAgent`. For a complete list of predefined IAM - roles, as well as the permissions in each role, see - https://cloud.google.com/iam/help/roles/reference. - type: string - rolePermission: + Indicates whether _this policy_ provides the specified permission to + the specified principal for the specified resource. This field does + _not_ indicate whether the principal actually has the permission for + the resource. There might be another policy that overrides this + policy. To determine whether the principal actually has the + permission, use the `access` field in the + TroubleshootIamPolicyResponse. type: string - description: >- - Indicates whether the role granted by this binding contains the - specified permission. - enumDescriptions: - - Default value. This value is unused. - - The permission is included in the role. - - The permission is not included in the role. - - The sender of the request is not allowed to access the binding. enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED - access: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED enumDescriptions: - Default value. This value is unused. - The principal has the permission. @@ -492,43 +439,13 @@ components: - >- The sender of the request does not have access to all of the policies that Policy Troubleshooter needs to evaluate. - description: >- - Required. Indicates whether _this binding_ provides the specified - permission to the specified principal for the specified resource. - This field does _not_ indicate whether the principal actually has - the permission for the resource. There might be another binding that - overrides this binding. To determine whether the principal actually - has the permission, use the `access` field in the - TroubleshootIamPolicyResponse. - type: string - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. - GoogleCloudPolicytroubleshooterV1ExplainedPolicy: - id: GoogleCloudPolicytroubleshooterV1ExplainedPolicy - properties: - bindingExplanations: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation - description: >- - Details about how each binding in the policy affects the principal's - ability, or inability, to use the permission for the resource. If - the sender of the request does not have access to the policy, this - field is omitted. policy: + $ref: '#/components/schemas/GoogleIamV1Policy' description: >- The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty. - $ref: '#/components/schemas/GoogleIamV1Policy' fullResourceName: + type: string description: >- The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. @@ -536,17 +453,74 @@ components: this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + description: Details about how a specific IAM Policy contributed to the access check. + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig + type: object + description: >- + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + properties: + service: + type: string + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + auditLogConfigs: + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + type: array + GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: + type: object + properties: + membership: + enumDescriptions: + - Default value. This value is unused. + - >- + The binding includes the principal. The principal can be included + directly or indirectly. For example: * A principal is included + directly if that principal is listed in the binding. * A principal + is included indirectly if that principal is in a Google group or + Google Workspace domain that is listed in the binding. + - The binding does not include the principal. + - The sender of the request is not allowed to access the binding. + - >- + The principal is an unsupported type. Only Google Accounts and + service accounts are supported. + enum: + - MEMBERSHIP_UNSPECIFIED + - MEMBERSHIP_INCLUDED + - MEMBERSHIP_NOT_INCLUDED + - MEMBERSHIP_UNKNOWN_INFO_DENIED + - MEMBERSHIP_UNKNOWN_UNSUPPORTED + description: Indicates whether the binding includes the principal. type: string relevance: - description: >- - The relevance of this policy to the overall determination in the - TroubleshootIamPolicyResponse. If the sender of the request does not - have access to the policy, this field is omitted. enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL - HIGH type: string + description: >- + The relevance of the principal's status to the overall determination + for the binding. enumDescriptions: - Default value. This value is unused. - >- @@ -555,60 +529,67 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - access: - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED + description: Details about whether the binding includes the principal. + id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership + GoogleTypeExpr: + properties: + description: + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + type: string + location: type: string - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The sender of the request does not have access to all of the - policies that Policy Troubleshooter needs to evaluate. description: >- - Indicates whether _this policy_ provides the specified permission to - the specified principal for the specified resource. This field does - _not_ indicate whether the principal actually has the permission for - the resource. There might be another policy that overrides this - policy. To determine whether the principal actually has the - permission, use the `access` field in the - TroubleshootIamPolicyResponse. - description: Details about how a specific IAM Policy contributed to the access check. + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + expression: + type: string + description: >- + Textual representation of an expression in Common Expression + Language syntax. + title: + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string type: object - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. + id: GoogleTypeExpr + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest: + properties: + accessTuple: + $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' + description: >- + The information to use for checking whether a principal has a + permission for a resource. + description: Request for TroubleshootIamPolicy. type: object + id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest + GoogleIamV1Binding: id: GoogleIamV1Binding properties: - role: - type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' members: + type: array + items: + type: string description: >- Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A @@ -668,32 +649,48 @@ components: `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + condition: + $ref: '#/components/schemas/GoogleTypeExpr' + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: object + description: Associates `members`, or principals, with a `role`. parameters: - prettyPrint: - description: Returns response with indentations and line breaks. + access_token: + description: OAuth access token. in: query - name: prettyPrint + name: access_token schema: - type: boolean - _.xgafv: - description: V1 error format. + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' - 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. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: key + name: upload_protocol schema: type: string oauth_token: @@ -702,33 +699,33 @@ components: name: oauth_token schema: type: string - quotaUser: + key: description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + 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. in: query - name: quotaUser + name: key schema: type: string - callback: - description: JSONP + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: callback + name: fields schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string - access_token: - description: OAuth access token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: access_token + name: prettyPrint schema: - type: string + type: boolean alt: description: Data format for response. in: query @@ -739,18 +736,21 @@ components: - json - media - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: iam: id: google.policytroubleshooter.iam @@ -772,17 +772,17 @@ components: paths: /v1/iam:troubleshoot: parameters: - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' post: description: >- Checks whether a principal has a specific permission for a specific diff --git a/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml b/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml index 194d22ab..c6bf9045 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml @@ -7,8 +7,8 @@ info: title: Pollen API description: 'The Pollen API. ' version: v1 - x-discovery-doc-revision: '20240909' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/maps/documentation/pollen servers: @@ -34,98 +34,8 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - LookupForecastResponse: - properties: - nextPageToken: - type: string - description: Optional. The token to retrieve the next page. - regionCode: - type: string - description: >- - The ISO_3166-1 alpha-2 code of the country/region corresponding to - the location provided in the request. This field might be omitted - from the response if the location provided in the request resides in - a disputed territory. - dailyInfo: - type: array - items: - $ref: '#/components/schemas/DayInfo' - description: >- - Required. This object contains the daily forecast information for - each day requested. - id: LookupForecastResponse - type: object - HttpBody: - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - type: object - id: HttpBody - properties: - data: - type: string - description: The HTTP request/response body as raw binary. - format: byte - contentType: - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - type: string - extensions: - type: array - description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. Color: - id: Color - properties: - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - type: number - format: float - alpha: - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - type: number - format: float - red: - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - green: - type: number - format: float - description: The amount of green in the color as a value in the interval [0, 1]. + type: object description: >- Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations @@ -177,29 +87,60 @@ components: resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... - type: object - PlantDescription: - type: object + id: Color properties: - type: - type: string + alpha: description: >- - The plant's pollen type. For example: "GRASS". A list of all - available codes could be found here. - enum: - - POLLEN_TYPE_UNSPECIFIED - - GRASS - - TREE - - WEED - enumDescriptions: - - Unspecified plant type. - - Grass pollen type. - - Tree pollen type. - - Weed pollen type. + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + blue: + type: number + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + red: + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + green: + format: float + type: number + description: The amount of green in the color as a value in the interval [0, 1]. + PlantDescription: + description: >- + Contains general information about plants, including details on their + seasonality, special shapes and colors, information about allergic + cross-reactions, and plant photos. + properties: specialColors: + type: string description: >- Textual description of the plants' colors of leaves, bark, flowers or seeds that helps identify the plant. + crossReaction: + description: >- + Textual description of pollen cross reaction plants. Example: Alder, + Hazel, Hornbeam, Beech, Willow, and Oak pollen. + type: string + picture: + description: Link to the picture of the plant. + type: string + season: + type: string + description: >- + Textual list of explanations of seasons where the pollen is active. + Example: "Late winter, spring". + pictureCloseup: + description: Link to a closeup picture of the plant. type: string specialShapes: type: string @@ -211,119 +152,161 @@ components: description: >- A human readable representation of the plant family name. Example: "Betulaceae (the Birch family)". - crossReaction: - description: >- - Textual description of pollen cross reaction plants. Example: Alder, - Hazel, Hornbeam, Beech, Willow, and Oak pollen. - type: string - season: - type: string + type: description: >- - Textual list of explanations of seasons where the pollen is active. - Example: "Late winter, spring". - picture: - type: string - description: Link to the picture of the plant. - pictureCloseup: + The plant's pollen type. For example: "GRASS". A list of all + available codes could be found here. type: string - description: Link to a closeup picture of the plant. - description: >- - Contains general information about plants, including details on their - seasonality, special shapes and colors, information about allergic - cross-reactions, and plant photos. + enum: + - POLLEN_TYPE_UNSPECIFIED + - GRASS + - TREE + - WEED + enumDescriptions: + - Unspecified plant type. + - Grass pollen type. + - Tree pollen type. + - Weed pollen type. + type: object id: PlantDescription - Date: + IndexInfo: + type: object + id: IndexInfo + description: >- + This object contains data representing specific pollen index value, + category and description. properties: - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. + value: + description: The index's numeric score. Numeric range is between 0 and 5. format: int32 type: integer - day: - type: integer - format: int32 + color: + description: The color used to represent the Pollen Index numeric score. + $ref: '#/components/schemas/Color' + indexDescription: + type: string + description: Textual explanation of current index level. + category: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - month: - type: integer + Text classification of index numerical score interpretation. The + index consists of six categories: * 0: "None" * 1: "Very low" * 2: + "Low" * 3: "Moderate" * 4: "High" * 5: "Very high + type: string + displayName: + type: string description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - id: Date - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - type: object + A human readable representation of the index name. Example: + "Universal Pollen Index". + code: + enum: + - INDEX_UNSPECIFIED + - UPI + enumDescriptions: + - Unspecified index. + - Universal Pollen Index. + type: string + description: >- + The index's code. This field represents the index for programming + purposes by using snake cases instead of spaces. Example: "UPI". DayInfo: properties: pollenTypeInfo: + items: + $ref: '#/components/schemas/PollenTypeInfo' type: array description: >- This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request. - items: - $ref: '#/components/schemas/PollenTypeInfo' - date: - $ref: '#/components/schemas/Date' - description: The date in UTC at which the pollen forecast data is represented. plantInfo: - items: - $ref: '#/components/schemas/PlantInfo' description: >- This list will include up to 15 pollen species affecting the location specified in the request. type: array + items: + $ref: '#/components/schemas/PlantInfo' + date: + description: The date in UTC at which the pollen forecast data is represented. + $ref: '#/components/schemas/Date' id: DayInfo description: >- This object contains the daily forecast information for each day requested. type: object + PollenTypeInfo: + description: >- + This object contains the pollen type index and health recommendation + information on specific pollen type. + properties: + inSeason: + type: boolean + description: Indication whether the plant is in season or not. + code: + enumDescriptions: + - Unspecified plant type. + - Grass pollen type. + - Tree pollen type. + - Weed pollen type. + enum: + - POLLEN_TYPE_UNSPECIFIED + - GRASS + - TREE + - WEED + type: string + description: 'The pollen type''s code name. For example: "GRASS"' + indexInfo: + description: Contains the Universal Pollen Index (UPI) data for the pollen type. + $ref: '#/components/schemas/IndexInfo' + healthRecommendations: + description: >- + Textual list of explanations, related to health insights based on + the current pollen levels. + items: + type: string + type: array + displayName: + description: >- + A human readable representation of the pollen type name. Example: + "Grass" + type: string + id: PollenTypeInfo + type: object + LookupForecastResponse: + id: LookupForecastResponse + type: object + properties: + regionCode: + description: >- + The ISO_3166-1 alpha-2 code of the country/region corresponding to + the location provided in the request. This field might be omitted + from the response if the location provided in the request resides in + a disputed territory. + type: string + dailyInfo: + items: + $ref: '#/components/schemas/DayInfo' + description: >- + Required. This object contains the daily forecast information for + each day requested. + type: array + nextPageToken: + type: string + description: Optional. The token to retrieve the next page. PlantInfo: - description: This object contains the daily information on specific plant. properties: + displayName: + type: string + description: >- + A human readable representation of the plant name. Example: + “Cottonwood". indexInfo: $ref: '#/components/schemas/IndexInfo' description: >- This object contains data representing specific pollen index value, category and description. - plantDescription: - description: >- - Contains general information about plants, including details on - their seasonality, special shapes and colors, information about - allergic cross-reactions, and plant photos. - $ref: '#/components/schemas/PlantDescription' code: - enumDescriptions: - - Unspecified plant code. - - Alder is classified as a tree pollen type. - - Ash is classified as a tree pollen type. - - Birch is classified as a tree pollen type. - - Cottonwood is classified as a tree pollen type. - - Elm is classified as a tree pollen type. - - Maple is classified as a tree pollen type. - - Olive is classified as a tree pollen type. - - Juniper is classified as a tree pollen type. - - Oak is classified as a tree pollen type. - - Pine is classified as a tree pollen type. - - Cypress pine is classified as a tree pollen type. - - Hazel is classified as a tree pollen type. - - Graminales is classified as a grass pollen type. - - Ragweed is classified as a weed pollen type. - - Mugwort is classified as a weed pollen type. - - Japanese cedar is classified as a tree pollen type. - - Japanese cypress is classified as a tree pollen type. - type: string + description: >- + The plant code name. For example: "COTTONWOOD". A list of all + available codes could be found here. enum: - PLANT_UNSPECIFIED - ALDER @@ -343,125 +326,139 @@ components: - MUGWORT - JAPANESE_CEDAR - JAPANESE_CYPRESS - description: >- - The plant code name. For example: "COTTONWOOD". A list of all - available codes could be found here. - displayName: type: string + enumDescriptions: + - Unspecified plant code. + - Alder is classified as a tree pollen type. + - Ash is classified as a tree pollen type. + - Birch is classified as a tree pollen type. + - Cottonwood is classified as a tree pollen type. + - Elm is classified as a tree pollen type. + - Maple is classified as a tree pollen type. + - Olive is classified as a tree pollen type. + - Juniper is classified as a tree pollen type. + - Oak is classified as a tree pollen type. + - Pine is classified as a tree pollen type. + - Cypress pine is classified as a tree pollen type. + - Hazel is classified as a tree pollen type. + - Graminales is classified as a grass pollen type. + - Ragweed is classified as a weed pollen type. + - Mugwort is classified as a weed pollen type. + - Japanese cedar is classified as a tree pollen type. + - Japanese cypress is classified as a tree pollen type. + plantDescription: + $ref: '#/components/schemas/PlantDescription' description: >- - A human readable representation of the plant name. Example: - “Cottonwood". + Contains general information about plants, including details on + their seasonality, special shapes and colors, information about + allergic cross-reactions, and plant photos. inSeason: - description: Indication of either the plant is in season or not. type: boolean + description: Indication of either the plant is in season or not. + description: This object contains the daily information on specific plant. type: object id: PlantInfo - IndexInfo: - id: IndexInfo + Date: description: >- - This object contains data representing specific pollen index value, - category and description. + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp properties: - color: - $ref: '#/components/schemas/Color' - description: The color used to represent the Pollen Index numeric score. - value: - format: int32 - description: The index's numeric score. Numeric range is between 0 and 5. - type: integer - indexDescription: - type: string - description: Textual explanation of current index level. - category: - type: string + month: description: >- - Text classification of index numerical score interpretation. The - index consists of six categories: * 0: "None" * 1: "Very low" * 2: - "Low" * 3: "Moderate" * 4: "High" * 5: "Very high - code: - enumDescriptions: - - Unspecified index. - - Universal Pollen Index. - type: string + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + day: + format: int32 description: >- - The index's code. This field represents the index for programming - purposes by using snake cases instead of spaces. Example: "UPI". - enum: - - INDEX_UNSPECIFIED - - UPI - displayName: - type: string + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + year: description: >- - A human readable representation of the index name. Example: - "Universal Pollen Index". + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + id: Date type: object - PollenTypeInfo: - id: PollenTypeInfo + HttpBody: properties: - healthRecommendations: - type: array - description: >- - Textual list of explanations, related to health insights based on - the current pollen levels. - items: - type: string - inSeason: - type: boolean - description: Indication whether the plant is in season or not. - code: - description: 'The pollen type''s code name. For example: "GRASS"' - enum: - - POLLEN_TYPE_UNSPECIFIED - - GRASS - - TREE - - WEED - enumDescriptions: - - Unspecified plant type. - - Grass pollen type. - - Tree pollen type. - - Weed pollen type. + contentType: type: string - displayName: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + data: type: string + description: The HTTP request/response body as raw binary. + format: byte + extensions: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - A human readable representation of the pollen type name. Example: - "Grass" - indexInfo: - $ref: '#/components/schemas/IndexInfo' - description: Contains the Universal Pollen Index (UPI) data for the pollen type. - description: >- - This object contains the pollen type index and health recommendation - information on specific pollen type. + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array type: object - parameters: - quotaUser: + id: HttpBody description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + parameters: + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: quotaUser + name: upload_protocol schema: 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. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: key + name: oauth_token schema: type: string - access_token: - description: OAuth access token. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: access_token + name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback schema: type: string fields: @@ -470,26 +467,25 @@ components: name: fields schema: type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - oauth_token: - description: OAuth 2.0 token for the current user. + 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. in: query - name: oauth_token + name: key schema: type: string _.xgafv: @@ -501,18 +497,22 @@ components: enum: - '1' - '2' - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + alt: + description: Data format for response. in: query - name: upload_protocol + name: alt schema: type: string + enum: + - json + - media + - proto x-stackQL-resources: forecast: id: google.pollen.forecast @@ -552,17 +552,17 @@ components: paths: /v1/forecast:lookup: parameters: &ref_1 + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/alt' get: description: >- Returns up to 5 days of daily pollen information in more than 65 @@ -582,37 +582,37 @@ paths: $ref: '#/components/schemas/LookupForecastResponse' parameters: - in: query - name: days + name: languageCode schema: - type: integer - format: int32 + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: location.longitude + name: pageToken schema: - type: number - format: double + type: string - in: query - name: plantsDescription + name: location.latitude schema: - type: boolean + type: number + format: double - in: query - name: languageCode + name: location.longitude schema: - type: string + type: number + format: double - in: query - name: pageToken + name: days schema: - type: string + type: integer + format: int32 - in: query - name: location.latitude + name: plantsDescription schema: - type: number - format: double + type: boolean /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml b/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml index 709f54ec..834b753e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml @@ -11,8 +11,8 @@ info: certificate authorities (CAs) while staying in control of your private keys. version: v1 - x-discovery-doc-revision: '20240819' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml b/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml index 9cd5636b..2b90d5a9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml @@ -7,8 +7,8 @@ info: title: SAS Portal API (Testing) description: '' version: v1alpha1 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/spectrum-access-system/ servers: @@ -35,349 +35,313 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalListDeploymentsResponse: + SasPortalEmpty: + 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); } + properties: {} + id: SasPortalEmpty + type: object + SasPortalMigrateOrganizationMetadata: properties: - nextPageToken: + operationState: type: string + enumDescriptions: + - Unspecified. + - Pending (Not started). + - In-progress. + - Done successfully. + - Done with errors. + description: Output only. Current operation state + enum: + - OPERATION_STATE_UNSPECIFIED + - OPERATION_STATE_PENDING + - OPERATION_STATE_RUNNING + - OPERATION_STATE_SUCCEEDED + - OPERATION_STATE_FAILED + readOnly: true + id: SasPortalMigrateOrganizationMetadata + description: >- + Long-running operation metadata message returned by the + MigrateOrganization. + type: object + SasPortalSetupSasAnalyticsRequest: + properties: + userId: description: >- - A pagination token returned from a previous call to ListDeployments - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more deployments. - deployments: + Optional. User id to setup analytics for, if not provided the user + id associated with the project is used. optional + type: string + id: SasPortalSetupSasAnalyticsRequest + type: object + description: Request for the SetupSasAnalytics rpc. + SasPortalPolicy: + description: Defines an access control policy to the resources. + type: object + properties: + assignments: + description: List of assignments items: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalAssignment' type: array - description: The deployments that match the request. - type: object - description: Response for ListDeployments. - id: SasPortalListDeploymentsResponse - SasPortalListCustomersResponse: - id: SasPortalListCustomersResponse - description: Response for `ListCustomers`. + etag: + description: >- + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the etag in + the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An etag is returned in the response to + GetPolicy, and systems are expected to put that etag in the request + to SetPolicy to ensure that their change will be applied to the same + version of the policy. If no etag is provided in the call to + GetPolicy, then the existing policy is overwritten blindly. + type: string + format: byte + id: SasPortalPolicy + SasPortalDeviceAirInterface: + description: Information about the device's air interface. properties: - nextPageToken: + radioTechnology: + enum: + - RADIO_TECHNOLOGY_UNSPECIFIED + - E_UTRA + - CAMBIUM_NETWORKS + - FOUR_G_BBW_SAA_1 + - NR + - DOODLE_CBRS + - CW + - REDLINE + - TARANA_WIRELESS + - FAROS + description: >- + Conditional. This field specifies the radio access technology that + is used for the CBSD. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string + supportedSpec: description: >- - A pagination token returned from a previous call to ListCustomers - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more customers. - customers: - items: - $ref: '#/components/schemas/SasPortalCustomer' - description: The list of customers that match the request. - type: array + Optional. This field is related to the `radioTechnology` and + provides the air interface specification that the CBSD is compliant + with at the time of registration. + type: string + id: SasPortalDeviceAirInterface type: object - SasPortalSetPolicyRequest: - id: SasPortalSetPolicyRequest + SasPortalDpaMoveList: + description: An entry in a DPA's move list. type: object - description: Request message for `SetPolicy` method. properties: - policy: - description: Required. The policy to be applied to the `resource`. - $ref: '#/components/schemas/SasPortalPolicy' - disableNotification: - type: boolean - description: >- - Optional. Set the field as `true` to disable the onboarding - notification. - resource: + dpaId: type: string - description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - SasPortalInstallationParams: - description: Information about the device installation parameters. + description: The ID of the DPA. + frequencyRange: + description: The frequency range that the move list affects. + $ref: '#/components/schemas/SasPortalFrequencyRange' + id: SasPortalDpaMoveList + SasPortalListGcpProjectDeploymentsResponse: + description: Response for [ListGcpProjectDeployments]. type: object + id: SasPortalListGcpProjectDeploymentsResponse properties: - verticalAccuracy: - format: double - description: >- - A positive number in meters to indicate accuracy of the device - antenna vertical location. This optional parameter should only be - present if its value is less than the FCC requirement of 3 meters. - type: number - antennaAzimuth: - format: int32 - description: >- - Boresight direction of the horizontal plane of the antenna in - degrees with respect to true north. The value of this parameter is - an integer with a value between 0 and 359 inclusive. A value of 0 - degrees means true north; a value of 90 degrees means east. This - parameter is optional for Category A devices and conditional for - Category B devices. - type: integer - antennaModel: + deployments: + type: array + items: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + description: Optional. Deployments associated with the GCP project + SasPortalMoveDeviceRequest: + properties: + destination: type: string description: >- - If an external antenna is used, the antenna model is optionally - provided in this field. The string has a maximum length of 128 - octets. - horizontalAccuracy: - description: >- - A positive number in meters to indicate accuracy of the device - antenna horizontal location. This optional parameter should only be - present if its value is less than the FCC requirement of 50 meters. - format: double - type: number - height: - format: double - description: >- - Device antenna height in meters. When the `heightType` parameter - value is "AGL", the antenna height should be given relative to - ground level. When the `heightType` parameter value is "AMSL", it is - given with respect to WGS84 datum. - type: number - latitude: - format: double - description: >- - Latitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -90.000000 to +90.000000. - Positive values represent latitudes north of the equator; negative - values south of the equator. - type: number - indoorDeployment: - description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. - type: boolean - longitude: - format: double - type: number + Required. The name of the new parent resource node or customer to + reparent the device under. + id: SasPortalMoveDeviceRequest + type: object + description: Request for MoveDevice. + SasPortalProvisionDeploymentResponse: + id: SasPortalProvisionDeploymentResponse + type: object + description: >- + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. + properties: + errorMessage: description: >- - Longitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -180.000000 to +180.000000. - Positive values represent longitudes east of the prime meridian; - negative values west of the prime meridian. - heightType: - description: Specifies how the height is measured. - enum: - - HEIGHT_TYPE_UNSPECIFIED - - HEIGHT_TYPE_AGL - - HEIGHT_TYPE_AMSL + Optional. Optional error message if the provisioning request is not + successful. type: string - enumDescriptions: - - Unspecified height type. - - AGL height is measured relative to the ground level. - - AMSL height is measured relative to the mean sea level. - cpeCbsdIndication: - description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - type: boolean - antennaDowntilt: - type: integer - format: int32 - description: >- - Antenna downtilt in degrees and is an integer with a value between - -90 and +90 inclusive; a negative value means the antenna is tilted - up (above horizontal). This parameter is optional for Category A - devices and conditional for Category B devices. - eirpCapability: - format: int32 - type: integer - description: >- - This parameter is the maximum device EIRP in units of dBm/10MHz and - is an integer with a value between -127 and +47 (dBm/10 MHz) - inclusive. If not included, SAS interprets it as maximum allowable - EIRP in units of dBm/10MHz for device category. - antennaGain: - type: number - format: double - description: >- - Peak antenna gain in dBi. This parameter is a double with a value - between -127 and +128 (dBi) inclusive. Part of Release 2 to support - floating-point value - antennaBeamwidth: - type: integer - description: >- - 3-dB antenna beamwidth of the antenna in the horizontal-plane in - degrees. This parameter is an unsigned integer having a value - between 0 and 360 (degrees) inclusive; it is optional for Category A - devices and conditional for Category B devices. - format: int32 - id: SasPortalInstallationParams - SasPortalChannelWithScore: + SasPortalValidateInstallerResponse: + description: Response for ValidateInstaller. + id: SasPortalValidateInstallerResponse + properties: {} type: object - id: SasPortalChannelWithScore - description: The channel with score. + SasPortalDeviceModel: properties: - score: - format: double - description: The channel score, normalized to be in the range [0,100]. - type: number - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range of the channel. - SasPortalNrqzValidation: - description: Information about National Radio Quiet Zone validation. - id: SasPortalNrqzValidation + softwareVersion: + type: string + description: The software version of the device. + name: + description: The name of the device model. + type: string + vendor: + description: The name of the device vendor. + type: string + firmwareVersion: + description: The firmware version of the device. + type: string + hardwareVersion: + type: string + description: The hardware version of the device. + id: SasPortalDeviceModel type: object + description: Information about the model of the device. + SasPortalNode: properties: - state: - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL + name: + description: Output only. Resource name. type: string - description: State of the NRQZ validation info. - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. - latitude: - type: number - description: Device latitude that's associated with the validation. - format: double - caseId: - description: Validation case ID. + sasUserIds: + type: array + items: + type: string + description: User ids used by the devices belonging to this node. + displayName: + description: The node's display name. type: string - longitude: - type: number - description: Device longitude that's associated with the validation. - format: double - cpiId: - description: CPI who signed the validation. + id: SasPortalNode + type: object + description: The Node. + SasPortalValidateInstallerRequest: + properties: + secret: + description: Required. Secret returned by the GenerateSecret. + type: string + installerId: + type: string + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + encodedSecret: type: string + description: >- + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. + type: object + description: Request for ValidateInstaller. + id: SasPortalValidateInstallerRequest SasPortalSetupSasAnalyticsMetadata: - properties: {} - id: SasPortalSetupSasAnalyticsMetadata description: >- Metadata returned by the long running operation for the SetupSasAnalytics rpc. + id: SasPortalSetupSasAnalyticsMetadata type: object - SasPortalMoveNodeRequest: - description: Request for MoveNode. + properties: {} + SasPortalDeviceMetadata: type: object + description: Device data overridable by both SAS Portal and registration requests. + id: SasPortalDeviceMetadata properties: - destination: + nrqzValidation: + readOnly: true + $ref: '#/components/schemas/SasPortalNrqzValidation' + description: Output only. National Radio Quiet Zone validation info. + nrqzValidated: + type: boolean + description: >- + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + deprecated: true + readOnly: true + interferenceCoordinationGroup: type: string description: >- - Required. The name of the new parent resource node or customer to - reparent the node under. - id: SasPortalMoveNodeRequest - SasPortalMigrateOrganizationMetadata: - description: >- - Long-running operation metadata message returned by the - MigrateOrganization. - id: SasPortalMigrateOrganizationMetadata - properties: - operationState: + Interference Coordination Group (ICG). A group of CBSDs that manage + their own interference with the group. For more details, see + [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + antennaModel: + description: >- + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` type: string - readOnly: true - description: Output only. Current operation state - enumDescriptions: - - Unspecified. - - Pending (Not started). - - In-progress. - - Done successfully. - - Done with errors. - enum: - - OPERATION_STATE_UNSPECIFIED - - OPERATION_STATE_PENDING - - OPERATION_STATE_RUNNING - - OPERATION_STATE_SUCCEEDED - - OPERATION_STATE_FAILED - type: object - SasPortalGetPolicyRequest: - properties: - resource: - description: Required. The resource for which the policy is being requested. + commonChannelGroup: + description: >- + Common Channel Group (CCG). A group of CBSDs in the same ICG + requesting a common primary channel assignment. For more details, + see [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). type: string - type: object - description: Request message for `GetPolicy` method. - id: SasPortalGetPolicyRequest - SasPortalDpaMoveList: - type: object - description: An entry in a DPA's move list. - id: SasPortalDpaMoveList + SasPortalUpdateSignedDeviceRequest: + description: Request for UpdateSignedDevice. properties: - frequencyRange: - description: The frequency range that the move list affects. - $ref: '#/components/schemas/SasPortalFrequencyRange' - dpaId: + encodedDevice: + format: byte type: string - description: The ID of the DPA. - SasPortalOperation: + description: >- + Required. The JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + installerId: + description: >- + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. + type: string + id: SasPortalUpdateSignedDeviceRequest + type: object + SasPortalDeployment: type: object - id: SasPortalOperation properties: - response: - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. name: type: string + readOnly: true + description: Output only. Resource name. + frns: + readOnly: true + type: array description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/SasPortalStatus' - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - metadata: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. + items: + type: string + sasUserIds: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - description: >- - This resource represents a long-running operation that is the result of - a network API call. + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + type: array + items: + type: string + displayName: + type: string + description: The deployment's display name. + id: SasPortalDeployment + description: The Deployment. SasPortalDeviceGrant: description: >- Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. - id: SasPortalDeviceGrant properties: - grantId: - type: string - description: Grant Id. - lastHeartbeatTransmitExpireTime: - type: string - description: The transmit expiration time of the last heartbeat. - format: google-datetime - suspensionReason: - description: If the grant is suspended, the reason(s) for suspension. - type: array + moveList: items: - type: string - channelType: - type: string - enumDescriptions: - - '' - - '' - - '' - description: Type of channel used. - enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL + $ref: '#/components/schemas/SasPortalDpaMoveList' + description: The DPA move lists on which this grant appears. + type: array + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The transmission frequency range. state: + type: string enumDescriptions: - '' - >- @@ -394,359 +358,576 @@ components: - GRANT_STATE_SUSPENDED - GRANT_STATE_AUTHORIZED - GRANT_STATE_EXPIRED - type: string description: State of the grant. + suspensionReason: + description: If the grant is suspended, the reason(s) for suspension. + items: + type: string + type: array + grantId: + type: string + description: Grant Id. + lastHeartbeatTransmitExpireTime: + format: google-datetime + type: string + description: The transmit expiration time of the last heartbeat. + maxEirp: + type: number + description: >- + Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by + the grant. The maximum EIRP is in units of dBm/MHz. The value of + `maxEirp` represents the average (RMS) EIRP that would be measured + by the procedure defined in FCC part 96.41(e)(3). + format: double + channelType: + type: string + enum: + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL + description: Type of channel used. + enumDescriptions: + - '' + - '' + - '' + expireTime: + format: google-datetime + type: string + description: The expiration time of the grant. + id: SasPortalDeviceGrant + type: object + SasPortalMigrateOrganizationRequest: + type: object + id: SasPortalMigrateOrganizationRequest + properties: + organizationId: + description: Required. Id of the SAS organization to be migrated. + type: string + format: int64 + description: >- + Request for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP + Project, Organization Info, and caller's GAIA ID should be retrieved + from the RPC handler, and used to check authorization on SAS Portal + organization and to create GCP Projects. + SasPortalChannelWithScore: + id: SasPortalChannelWithScore + type: object + description: The channel with score. + properties: frequencyRange: $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The transmission frequency range. - expireTime: - format: google-datetime - type: string - description: The expiration time of the grant. - maxEirp: - description: >- - Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by - the grant. The maximum EIRP is in units of dBm/MHz. The value of - `maxEirp` represents the average (RMS) EIRP that would be measured - by the procedure defined in FCC part 96.41(e)(3). - format: double + description: The frequency range of the channel. + score: type: number - moveList: + description: The channel score, normalized to be in the range [0,100]. + format: double + SasPortalGcpProjectDeployment: + type: object + properties: + hasEnabledAnalytics: + description: Whether SAS analytics has been enabled. + type: boolean + deployment: + description: Deployment associated with the GCP project. + $ref: '#/components/schemas/SasPortalDeployment' + description: >- + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. + id: SasPortalGcpProjectDeployment + SasPortalStatus: + properties: + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - description: The DPA move lists on which this grant appears. items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - type: object - SasPortalEmpty: - properties: {} + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. 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: SasPortalEmpty + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - SasPortalDeviceConfig: - description: Information about the device configuration. + id: SasPortalStatus + SasPortalListCustomersResponse: + description: Response for `ListCustomers`. + id: SasPortalListCustomersResponse type: object properties: - state: - enumDescriptions: - - '' - - '' - - '' - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL - description: State of the configuration. + customers: + description: The list of customers that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalCustomer' + nextPageToken: + type: string + description: >- + A pagination token returned from a previous call to ListCustomers + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more customers. + SasPortalGetPolicyRequest: + type: object + description: Request message for `GetPolicy` method. + id: SasPortalGetPolicyRequest + properties: + resource: type: string + description: Required. The resource for which the policy is being requested. + SasPortalDeviceConfig: + description: Information about the device configuration. + id: SasPortalDeviceConfig + properties: + measurementCapabilities: + type: array + description: Measurement reporting capabilities of the device. + items: + enum: + - MEASUREMENT_CAPABILITY_UNSPECIFIED + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + enumDescriptions: + - '' + - '' + - '' + type: string installationParams: description: Installation parameters for the device. $ref: '#/components/schemas/SasPortalInstallationParams' + airInterface: + $ref: '#/components/schemas/SasPortalDeviceAirInterface' + description: Information about this device's air interface. + callSign: + type: string + description: The call sign of the device operator. updateTime: description: Output only. The last time the device configuration was edited. + type: string format: google-datetime + userId: + description: The identifier of a device user. type: string model: $ref: '#/components/schemas/SasPortalDeviceModel' description: Information about this device model. + category: + enumDescriptions: + - Unspecified device category. + - Category A. + - Category B. + enum: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B + type: string + description: FCC category of the device. + state: + enumDescriptions: + - '' + - '' + - '' + description: State of the configuration. + enum: + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL + type: string isSigned: description: Output only. Whether the configuration has been signed by a CPI. type: boolean - airInterface: - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - description: Information about this device's air interface. - measurementCapabilities: - description: Measurement reporting capabilities of the device. + type: object + SasPortalGenerateSecretResponse: + properties: + secret: + type: string + description: The secret generated by the string and used by ValidateInstaller. + type: object + description: Response for GenerateSecret. + id: SasPortalGenerateSecretResponse + SasPortalCustomer: + type: object + description: Entity representing a SAS customer. + properties: + displayName: + description: >- + Required. Name of the organization that the customer entity + represents. + type: string + sasUserIds: type: array items: type: string - enum: - - MEASUREMENT_CAPABILITY_UNSPECIFIED - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT - enumDescriptions: - - '' - - '' - - '' + description: User IDs used by the devices belonging to this customer. + name: + type: string + description: Output only. Resource name of the customer. + id: SasPortalCustomer + SasPortalSignDeviceRequest: + id: SasPortalSignDeviceRequest + description: Request for SignDevice. + properties: + device: + $ref: '#/components/schemas/SasPortalDevice' + description: >- + Required. The device to sign. The device fields name, fcc_id and + serial_number must be set. The user_id field must be set. + type: object + SasPortalDeploymentAssociation: + description: Association between a gcp project and a SAS user id. + id: SasPortalDeploymentAssociation + type: object + properties: userId: - description: The identifier of a device user. + description: User id of the deployment. type: string - callSign: + gcpProjectId: type: string - description: The call sign of the device operator. - category: + description: GCP project id of the associated project. + SasPortalOrganization: + description: Organization details. + id: SasPortalOrganization + properties: + displayName: + type: string + description: Name of organization + id: + format: int64 + type: string + description: Id of organization + type: object + SasPortalInstallationParams: + description: Information about the device installation parameters. + properties: + antennaModel: + description: >- + If an external antenna is used, the antenna model is optionally + provided in this field. The string has a maximum length of 128 + octets. + type: string + eirpCapability: + format: int32 + type: integer + description: >- + This parameter is the maximum device EIRP in units of dBm/10MHz and + is an integer with a value between -127 and +47 (dBm/10 MHz) + inclusive. If not included, SAS interprets it as maximum allowable + EIRP in units of dBm/10MHz for device category. + latitude: + type: number + format: double + description: >- + Latitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -90.000000 to +90.000000. + Positive values represent latitudes north of the equator; negative + values south of the equator. + horizontalAccuracy: + description: >- + A positive number in meters to indicate accuracy of the device + antenna horizontal location. This optional parameter should only be + present if its value is less than the FCC requirement of 50 meters. + format: double + type: number + indoorDeployment: + type: boolean + description: >- + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. + heightType: + description: Specifies how the height is measured. enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B + - HEIGHT_TYPE_UNSPECIFIED + - HEIGHT_TYPE_AGL + - HEIGHT_TYPE_AMSL enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. - type: string - description: FCC category of the device. - id: SasPortalDeviceConfig - SasPortalSetupSasAnalyticsRequest: - properties: - userId: + - Unspecified height type. + - AGL height is measured relative to the ground level. + - AMSL height is measured relative to the mean sea level. type: string + verticalAccuracy: description: >- - Optional. User id to setup analytics for, if not provided the user - id associated with the project is used. optional - id: SasPortalSetupSasAnalyticsRequest - type: object - description: Request for the SetupSasAnalytics rpc. - SasPortalGenerateSecretResponse: - id: SasPortalGenerateSecretResponse - properties: - secret: - type: string - description: The secret generated by the string and used by ValidateInstaller. + A positive number in meters to indicate accuracy of the device + antenna vertical location. This optional parameter should only be + present if its value is less than the FCC requirement of 3 meters. + format: double + type: number + antennaDowntilt: + format: int32 + description: >- + Antenna downtilt in degrees and is an integer with a value between + -90 and +90 inclusive; a negative value means the antenna is tilted + up (above horizontal). This parameter is optional for Category A + devices and conditional for Category B devices. + type: integer + antennaBeamwidth: + type: integer + description: >- + 3-dB antenna beamwidth of the antenna in the horizontal-plane in + degrees. This parameter is an unsigned integer having a value + between 0 and 360 (degrees) inclusive; it is optional for Category A + devices and conditional for Category B devices. + format: int32 + antennaGain: + type: number + description: >- + Peak antenna gain in dBi. This parameter is a double with a value + between -127 and +128 (dBi) inclusive. Part of Release 2 to support + floating-point value + format: double + height: + type: number + description: >- + Device antenna height in meters. When the `heightType` parameter + value is "AGL", the antenna height should be given relative to + ground level. When the `heightType` parameter value is "AMSL", it is + given with respect to WGS84 datum. + format: double + longitude: + type: number + format: double + description: >- + Longitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -180.000000 to +180.000000. + Positive values represent longitudes east of the prime meridian; + negative values west of the prime meridian. + cpeCbsdIndication: + type: boolean + description: >- + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + antennaAzimuth: + format: int32 + description: >- + Boresight direction of the horizontal plane of the antenna in + degrees with respect to true north. The value of this parameter is + an integer with a value between 0 and 359 inclusive. A value of 0 + degrees means true north; a value of 90 degrees means east. This + parameter is optional for Category A devices and conditional for + Category B devices. + type: integer type: object - description: Response for GenerateSecret. - SasPortalTestPermissionsResponse: + id: SasPortalInstallationParams + SasPortalTestPermissionsRequest: properties: permissions: - type: array + description: The set of permissions to check for the `resource`. items: type: string - description: A set of permissions that the caller is allowed. - id: SasPortalTestPermissionsResponse - type: object - description: Response message for `TestPermissions` method. - SasPortalDeploymentAssociation: + type: array + resource: + description: >- + Required. The resource for which the permissions are being + requested. + type: string + description: Request message for `TestPermissions` method. + id: SasPortalTestPermissionsRequest type: object - description: Association between a gcp project and a SAS user id. - id: SasPortalDeploymentAssociation + SasPortalMoveNodeRequest: + id: SasPortalMoveNodeRequest properties: - gcpProjectId: + destination: type: string - description: GCP project id of the associated project. - userId: + description: >- + Required. The name of the new parent resource node or customer to + reparent the node under. + type: object + description: Request for MoveNode. + SasPortalListDeploymentsResponse: + id: SasPortalListDeploymentsResponse + properties: + deployments: + description: The deployments that match the request. + items: + $ref: '#/components/schemas/SasPortalDeployment' + type: array + nextPageToken: + description: >- + A pagination token returned from a previous call to ListDeployments + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more deployments. type: string - description: User id of the deployment. - SasPortalListNodesResponse: - description: Response for ListNodes. - id: SasPortalListNodesResponse + description: Response for ListDeployments. type: object + SasPortalListDevicesResponse: + description: Response for ListDevices. properties: nextPageToken: description: >- - A pagination token returned from a previous call to ListNodes that + A pagination token returned from a previous call to ListDevices that indicates from where listing should continue. If the field is - missing or empty, it means there is no more nodes. + missing or empty, it means there is no more devices. type: string - nodes: - description: The nodes that match the request. + devices: + description: The devices that match the request. type: array items: - $ref: '#/components/schemas/SasPortalNode' - SasPortalGcpProjectDeployment: - id: SasPortalGcpProjectDeployment - properties: - hasEnabledAnalytics: - description: Whether SAS analytics has been enabled. - type: boolean - deployment: - $ref: '#/components/schemas/SasPortalDeployment' - description: Deployment associated with the GCP project. - type: object - description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. - SasPortalListGcpProjectDeploymentsResponse: - id: SasPortalListGcpProjectDeploymentsResponse + $ref: '#/components/schemas/SasPortalDevice' type: object - description: Response for [ListGcpProjectDeployments]. - properties: - deployments: - items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' - type: array - description: Optional. Deployments associated with the GCP project - SasPortalFrequencyRange: - description: Frequency range from `low_frequency` to `high_frequency`. - properties: - highFrequencyMhz: - description: The highest frequency of the frequency range in MHz. - format: double - type: number - lowFrequencyMhz: - format: double - description: The lowest frequency of the frequency range in MHz. - type: number - id: SasPortalFrequencyRange + id: SasPortalListDevicesResponse + SasPortalOperation: type: object - SasPortalNode: - description: The Node. - id: SasPortalNode + id: SasPortalOperation properties: + metadata: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. name: - type: string - description: Output only. Resource name. - sasUserIds: - items: - type: string - description: User ids used by the devices belonging to this node. - type: array - displayName: - type: string - description: The node's display name. - type: object - SasPortalTestPermissionsRequest: - properties: - permissions: - description: The set of permissions to check for the `resource`. - items: - type: string - type: array - resource: type: string description: >- - Required. The resource for which the permissions are being - requested. - id: SasPortalTestPermissionsRequest - description: Request message for `TestPermissions` method. - type: object - SasPortalProvisionDeploymentResponse: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + $ref: '#/components/schemas/SasPortalStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + SasPortalListNodesResponse: properties: - errorMessage: + nextPageToken: description: >- - Optional. Optional error message if the provisioning request is not - successful. + A pagination token returned from a previous call to ListNodes that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more nodes. type: string + nodes: + items: + $ref: '#/components/schemas/SasPortalNode' + type: array + description: The nodes that match the request. + description: Response for ListNodes. type: object - description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. - id: SasPortalProvisionDeploymentResponse - SasPortalProvisionDeploymentRequest: - description: >- - Request for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP - Project, Organization Info, and caller’s GAIA ID should be retrieved - from the RPC handler, and used as inputs to create a new SAS - organization (if not exists) and a new SAS deployment. + id: SasPortalListNodesResponse + SasPortalNrqzValidation: type: object - id: SasPortalProvisionDeploymentRequest properties: - organizationId: - format: int64 - description: >- - Optional. If this field is set then a new deployment will be created - under the organization specified by this id. + latitude: + format: double + type: number + description: Device latitude that's associated with the validation. + cpiId: type: string - newOrganizationDisplayName: + description: CPI who signed the validation. + longitude: + description: Device longitude that's associated with the validation. + format: double + type: number + caseId: + type: string + description: Validation case ID. + state: + description: State of the NRQZ validation info. type: string + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. + description: Information about National Radio Quiet Zone validation. + id: SasPortalNrqzValidation + SasPortalSetPolicyRequest: + id: SasPortalSetPolicyRequest + type: object + description: Request message for `SetPolicy` method. + properties: + disableNotification: description: >- - Optional. If this field is set, and a new SAS Portal Organization - needs to be created, its display name will be set to the value of - this field. - newDeploymentDisplayName: + Optional. Set the field as `true` to disable the onboarding + notification. + type: boolean + resource: description: >- - Optional. If this field is set, and a new SAS Portal Deployment - needs to be created, its display name will be set to the value of - this field. + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. type: string + policy: + $ref: '#/components/schemas/SasPortalPolicy' + description: Required. The policy to be applied to the `resource`. SasPortalSetupSasAnalyticsResponse: + properties: {} description: >- Response returned by the long running operation for the SetupSasAnalytics rpc. type: object - properties: {} id: SasPortalSetupSasAnalyticsResponse - SasPortalDeviceAirInterface: - type: object - description: Information about the device's air interface. - id: SasPortalDeviceAirInterface + SasPortalDevice: properties: - radioTechnology: - description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - RADIO_TECHNOLOGY_UNSPECIFIED - - E_UTRA - - CAMBIUM_NETWORKS - - FOUR_G_BBW_SAA_1 - - NR - - DOODLE_CBRS - - CW - - REDLINE - - TARANA_WIRELESS - - FAROS - type: string - supportedSpec: + fccId: type: string description: >- - Optional. This field is related to the `radioTechnology` and - provides the air interface specification that the CBSD is compliant - with at the time of registration. - SasPortalListLegacyOrganizationsResponse: - id: SasPortalListLegacyOrganizationsResponse - type: object - properties: - organizations: - description: Optional. Legacy SAS organizations. + The FCC identifier of the device. Refer to + https://www.fcc.gov/oet/ea/fccid for FccID format. Accept + underscores and periods because some test-SAS customers use them. + grants: type: array + description: Output only. Grants held by the device. items: - $ref: '#/components/schemas/SasPortalOrganization' - description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. - SasPortalOrganization: - description: Organization details. - type: object - properties: - id: - type: string - format: int64 - description: Id of organization - displayName: - type: string - description: Name of organization - id: SasPortalOrganization - SasPortalDevice: - type: object - id: SasPortalDevice - properties: - displayName: - type: string - description: Device display name. - currentChannels: - description: Output only. Current channels with scores. - readOnly: true - items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - type: array - deprecated: true + $ref: '#/components/schemas/SasPortalDeviceGrant' activeConfig: + $ref: '#/components/schemas/SasPortalDeviceConfig' description: >- Output only. Current configuration of the device as registered to the SAS. - $ref: '#/components/schemas/SasPortalDeviceConfig' - deviceMetadata: - $ref: '#/components/schemas/SasPortalDeviceMetadata' + grantRangeAllowlists: description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - preloadedConfig: - description: Configuration of the device, as specified via SAS Portal API. - $ref: '#/components/schemas/SasPortalDeviceConfig' + Only ranges that are within the allowlists are available for new + grants. + type: array + items: + $ref: '#/components/schemas/SasPortalFrequencyRange' state: + type: string enumDescriptions: - Unspecified state. - >- @@ -756,105 +937,36 @@ components: - Device de-registered with SAS. description: Output only. Device state. enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED - type: string - name: - description: Output only. The resource path name. - type: string - fccId: - type: string - description: >- - The FCC identifier of the device. Refer to - https://www.fcc.gov/oet/ea/fccid for FccID format. Accept - underscores and periods because some test-SAS customers use them. - grants: - description: Output only. Grants held by the device. - items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - type: array - serialNumber: - type: string - description: A serial number assigned to the device by the device manufacturer. - grantRangeAllowlists: - items: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: >- - Only ranges that are within the allowlists are available for new - grants. - type: array - SasPortalCreateSignedDeviceRequest: - description: Request for CreateSignedDevice. - id: SasPortalCreateSignedDeviceRequest - type: object - properties: - encodedDevice: - description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - type: string - format: byte - installerId: - type: string - description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - SasPortalDeviceModel: - id: SasPortalDeviceModel - description: Information about the model of the device. - properties: - name: - description: The name of the device model. - type: string - hardwareVersion: - type: string - description: The hardware version of the device. - vendor: - type: string - description: The name of the device vendor. - firmwareVersion: - type: string - description: The firmware version of the device. - softwareVersion: - type: string - description: The software version of the device. - type: object - SasPortalUpdateSignedDeviceRequest: - properties: - encodedDevice: + - DEVICE_STATE_UNSPECIFIED + - RESERVED + - REGISTERED + - DEREGISTERED + displayName: type: string - format: byte + description: Device display name. + deviceMetadata: + $ref: '#/components/schemas/SasPortalDeviceMetadata' description: >- - Required. The JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - installerId: + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + currentChannels: + readOnly: true + items: + $ref: '#/components/schemas/SasPortalChannelWithScore' + deprecated: true + description: Output only. Current channels with scores. + type: array + serialNumber: type: string - description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. - type: object - id: SasPortalUpdateSignedDeviceRequest - description: Request for UpdateSignedDevice. - SasPortalListDevicesResponse: - id: SasPortalListDevicesResponse - description: Response for ListDevices. - properties: - nextPageToken: - description: >- - A pagination token returned from a previous call to ListDevices that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more devices. + description: A serial number assigned to the device by the device manufacturer. + name: type: string - devices: - description: The devices that match the request. - type: array - items: - $ref: '#/components/schemas/SasPortalDevice' + description: Output only. The resource path name. + preloadedConfig: + $ref: '#/components/schemas/SasPortalDeviceConfig' + description: Configuration of the device, as specified via SAS Portal API. type: object + id: SasPortalDevice SasPortalMoveDeploymentRequest: id: SasPortalMoveDeploymentRequest properties: @@ -863,33 +975,14 @@ components: description: >- Required. The name of the new parent resource node or customer to reparent the deployment under. - type: object description: Request for MoveDeployment. - SasPortalPolicy: type: object - description: Defines an access control policy to the resources. - properties: - etag: - format: byte - description: >- - The etag is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the etag in - the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An etag is returned in the response to - GetPolicy, and systems are expected to put that etag in the request - to SetPolicy to ensure that their change will be applied to the same - version of the policy. If no etag is provided in the call to - GetPolicy, then the existing policy is overwritten blindly. - type: string - assignments: - description: List of assignments - type: array - items: - $ref: '#/components/schemas/SasPortalAssignment' - id: SasPortalPolicy SasPortalAssignment: + id: SasPortalAssignment properties: + role: + type: string + description: Required. Role that is assigned to `members`. members: type: array items: @@ -900,199 +993,106 @@ components: specific Google account. For example: `alice@gmail.com`. * `{group_email}`: An email address that represents a Google group. For example, `viewers@gmail.com`. - role: - type: string - description: Required. Role that is assigned to `members`. - type: object - id: SasPortalAssignment description: Associates `members` with a `role`. - SasPortalMigrateOrganizationRequest: - description: >- - Request for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP - Project, Organization Info, and caller's GAIA ID should be retrieved - from the RPC handler, and used to check authorization on SAS Portal - organization and to create GCP Projects. - id: SasPortalMigrateOrganizationRequest - properties: - organizationId: - format: int64 - type: string - description: Required. Id of the SAS organization to be migrated. - type: object - SasPortalGenerateSecretRequest: - type: object - properties: {} - description: Request for GenerateSecret. - id: SasPortalGenerateSecretRequest - SasPortalDeployment: type: object - id: SasPortalDeployment + SasPortalTestPermissionsResponse: properties: - sasUserIds: - items: - type: string - description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. + permissions: type: array - displayName: - type: string - description: The deployment's display name. - frns: - readOnly: true + description: A set of permissions that the caller is allowed. items: type: string - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. - type: array - name: - readOnly: true - description: Output only. Resource name. - type: string - description: The Deployment. - SasPortalSignDeviceRequest: - properties: - device: - description: >- - Required. The device to sign. The device fields name, fcc_id and - serial_number must be set. The user_id field must be set. - $ref: '#/components/schemas/SasPortalDevice' - id: SasPortalSignDeviceRequest - description: Request for SignDevice. - type: object - SasPortalMoveDeviceRequest: type: object - description: Request for MoveDevice. + description: Response message for `TestPermissions` method. + id: SasPortalTestPermissionsResponse + SasPortalCreateSignedDeviceRequest: properties: - destination: + installerId: type: string description: >- - Required. The name of the new parent resource node or customer to - reparent the device under. - id: SasPortalMoveDeviceRequest - SasPortalValidateInstallerResponse: - properties: {} - description: Response for ValidateInstaller. - id: SasPortalValidateInstallerResponse - type: object - SasPortalMigrateOrganizationResponse: - type: object - id: SasPortalMigrateOrganizationResponse - properties: - deploymentAssociation: - items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + encodedDevice: description: >- - Optional. A list of deployment association that were created for the - migration, or current associations if they already exist. - type: array - description: >- - Response for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. - SasPortalDeviceMetadata: - description: Device data overridable by both SAS Portal and registration requests. + Required. JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + type: string + format: byte + description: Request for CreateSignedDevice. type: object + id: SasPortalCreateSignedDeviceRequest + SasPortalFrequencyRange: properties: - antennaModel: - description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` - type: string - nrqzValidation: - readOnly: true - description: Output only. National Radio Quiet Zone validation info. - $ref: '#/components/schemas/SasPortalNrqzValidation' - commonChannelGroup: - description: >- - Common Channel Group (CCG). A group of CBSDs in the same ICG - requesting a common primary channel assignment. For more details, - see [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - type: string - interferenceCoordinationGroup: - description: >- - Interference Coordination Group (ICG). A group of CBSDs that manage - their own interference with the group. For more details, see - [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - type: string - nrqzValidated: - readOnly: true - description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. - deprecated: true - type: boolean - id: SasPortalDeviceMetadata - SasPortalStatus: - id: SasPortalStatus + highFrequencyMhz: + description: The highest frequency of the frequency range in MHz. + type: number + format: double + lowFrequencyMhz: + description: The lowest frequency of the frequency range in MHz. + format: double + type: number + description: Frequency range from `low_frequency` to `high_frequency`. + id: SasPortalFrequencyRange + type: object + SasPortalListLegacyOrganizationsResponse: + id: SasPortalListLegacyOrganizationsResponse type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). properties: - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - details: + organizations: + type: array items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + $ref: '#/components/schemas/SasPortalOrganization' + description: Optional. Legacy SAS organizations. + description: >- + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. + SasPortalMigrateOrganizationResponse: + id: SasPortalMigrateOrganizationResponse + type: object + properties: + deploymentAssociation: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Optional. A list of deployment association that were created for the + migration, or current associations if they already exist. + items: + $ref: '#/components/schemas/SasPortalDeploymentAssociation' type: array - SasPortalValidateInstallerRequest: - id: SasPortalValidateInstallerRequest + description: >- + Response for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + SasPortalProvisionDeploymentRequest: + id: SasPortalProvisionDeploymentRequest + description: >- + Request for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP + Project, Organization Info, and caller’s GAIA ID should be retrieved + from the RPC handler, and used as inputs to create a new SAS + organization (if not exists) and a new SAS deployment. + type: object properties: - secret: - type: string - description: Required. Secret returned by the GenerateSecret. - installerId: + organizationId: type: string description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - encodedSecret: + Optional. If this field is set then a new deployment will be created + under the organization specified by this id. + format: int64 + newDeploymentDisplayName: type: string description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must include a "secret" claim whose value is the secret. - type: object - description: Request for ValidateInstaller. - SasPortalCustomer: - description: Entity representing a SAS customer. - properties: - name: - description: Output only. Resource name of the customer. - type: string - sasUserIds: - type: array - items: - type: string - description: User IDs used by the devices belonging to this customer. - displayName: + Optional. If this field is set, and a new SAS Portal Deployment + needs to be created, its display name will be set to the value of + this field. + newOrganizationDisplayName: type: string description: >- - Required. Name of the organization that the customer entity - represents. - id: SasPortalCustomer + Optional. If this field is set, and a new SAS Portal Organization + needs to be created, its display name will be set to the value of + this field. + SasPortalGenerateSecretRequest: + id: SasPortalGenerateSecretRequest + properties: {} + description: Request for GenerateSecret. type: object parameters: prettyPrint: @@ -1101,46 +1101,18 @@ components: name: prettyPrint schema: type: boolean - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string - alt: - description: Data format for response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: alt + name: oauth_token schema: type: string - enum: - - json - - media - - proto upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query @@ -1153,6 +1125,27 @@ components: name: uploadType schema: type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -1162,40 +1155,63 @@ components: name: key schema: type: string - callback: - description: JSONP + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + enum: + - '1' + - '2' + alt: + description: Data format for response. in: query - name: oauth_token + name: alt schema: type: string + enum: + - json + - media + - proto x-stackQL-resources: devices: id: google.prod_tt_sasportal.devices name: devices title: Devices methods: - nodes_devices_create: + deployments_devices_get: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_list: + deployments_devices_patch: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_get: + deployments_devices_delete: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_sign_device: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_move: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' @@ -1211,39 +1227,36 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_sign_device: + nodes_devices_get: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_move: + nodes_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_list: + nodes_devices_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - nodes_nodes_devices_create: + nodes_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create: + nodes_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' @@ -1255,73 +1268,73 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - customers_devices_get: + nodes_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_delete: + nodes_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_patch: + objectKey: $.devices + nodes_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_sign_device: + customers_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create: + customers_devices_delete: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - customers_devices_list: + customers_devices_get: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_devices_move: + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create: + customers_devices_list: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_list: + objectKey: $.devices + customers_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_deployments_devices_create: + customers_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' @@ -1333,93 +1346,87 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - deployments_devices_get: - operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - deployments_devices_patch: - operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - deployments_devices_delete: + customers_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + customers_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_move: + customers_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.devices sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list + #/components/x-stackQL-resources/devices/methods/deployments_devices_get + - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_get + #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list + #/components/x-stackQL-resources/devices/methods/customers_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_get + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_list insert: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create + #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_create update: + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_patch - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_patch replace: [] delete: + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_delete - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_delete devices_signed: id: google.prod_tt_sasportal.devices_signed name: devices_signed title: Devices_signed methods: + deployments_devices_update_signed: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch + response: + mediaType: application/json + openAPIDocKey: '200' nodes_devices_update_signed: operation: $ref: >- @@ -1433,17 +1440,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + nodes_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create_signed: + nodes_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' @@ -1461,13 +1468,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create_signed: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post - response: - mediaType: application/json - openAPIDocKey: '200' customers_deployments_devices_create_signed: operation: $ref: >- @@ -1475,35 +1475,35 @@ components: response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_update_signed: + customers_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed + #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed update: + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed replace: [] delete: [] deployments: @@ -1511,25 +1511,16 @@ components: name: deployments title: Deployments methods: - nodes_nodes_deployments_list: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - nodes_nodes_deployments_create: + deployments_get: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_delete: + nodes_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' @@ -1547,10 +1538,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_move: + nodes_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -1561,46 +1552,46 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.deployments - customers_nodes_deployments_list: + nodes_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_nodes_deployments_create: + nodes_nodes_deployments_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_move: + objectKey: $.deployments + customers_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_get: + customers_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_delete: + customers_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_patch: + customers_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' @@ -1617,28 +1608,37 @@ components: response: mediaType: application/json openAPIDocKey: '200' - deployments_get: + customers_nodes_deployments_create: operation: - $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + customers_nodes_deployments_list: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.deployments sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + #/components/x-stackQL-resources/deployments/methods/deployments_get - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/deployments_get insert: - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create @@ -1662,13 +1662,6 @@ components: name: nodes title: Nodes methods: - nodes_nodes_nodes_create: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post - response: - mediaType: application/json - openAPIDocKey: '200' nodes_nodes_nodes_list: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' @@ -1676,37 +1669,44 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - nodes_nodes_patch: + nodes_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_delete: + nodes_nodes_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_move: + nodes_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.nodes nodes_nodes_create: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_list: + nodes_nodes_delete: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_patch: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes customers_nodes_move: operation: $ref: >- @@ -1762,121 +1762,55 @@ components: update: [] replace: [] delete: [] - policies: - id: google.prod_tt_sasportal.policies - name: policies - title: Policies + installer: + id: google.prod_tt_sasportal.installer + name: installer + title: Installer methods: - policies_get: - operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_test: + installer_generate_secret: operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' response: mediaType: application/json openAPIDocKey: '200' - policies_set: + installer_validate: operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' + $ref: '#/paths/~1v1alpha1~1installer:validate/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' + select: [] insert: [] update: [] replace: [] delete: [] - customers: - id: google.prod_tt_sasportal.customers - name: customers - title: Customers + policies: + id: google.prod_tt_sasportal.policies + name: policies + title: Policies methods: - customers_setup_sas_analytics: - operation: - $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_provision_deployment: - operation: - $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_list: - operation: - $ref: '#/paths/~1v1alpha1~1customers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.customers - customers_get: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_patch: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_migrate_organization: + policies_set: operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' - replace: [] - delete: [] - customers_legacy_organizations: - id: google.prod_tt_sasportal.customers_legacy_organizations - name: customers_legacy_organizations - title: Customers_legacy_organizations - methods: - customers_list_legacy_organizations: + $ref: '#/paths/~1v1alpha1~1policies:set/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' + $ref: '#/paths/~1v1alpha1~1policies:get/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations - insert: [] - update: [] - replace: [] - delete: [] - customers_gcp_project_deployments: - id: google.prod_tt_sasportal.customers_gcp_project_deployments - name: customers_gcp_project_deployments - title: Customers_gcp_project_deployments - methods: - customers_list_gcp_project_deployments: + policies_test: operation: - $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' + $ref: '#/paths/~1v1alpha1~1policies:test/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments + - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' insert: [] update: [] replace: [] @@ -1886,13 +1820,6 @@ components: name: customer_nodes title: Customer_nodes methods: - customers_nodes_nodes_create: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post - response: - mediaType: application/json - openAPIDocKey: '200' customers_nodes_nodes_list: operation: $ref: >- @@ -1901,19 +1828,26 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - customers_nodes_list: + customers_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes customers_nodes_create: operation: $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' + customers_nodes_list: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.nodes customers_nodes_delete: operation: $ref: >- @@ -1956,46 +1890,142 @@ components: update: [] replace: [] delete: [] - installer: - id: google.prod_tt_sasportal.installer - name: installer - title: Installer + customers: + id: google.prod_tt_sasportal.customers + name: customers + title: Customers methods: - installer_validate: + customers_setup_sas_analytics: operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' + $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' response: mediaType: application/json openAPIDocKey: '200' - installer_generate_secret: + customers_patch: operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_get: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_provision_deployment: + operation: + $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_list: + operation: + $ref: '#/paths/~1v1alpha1~1customers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.customers + customers_migrate_organization: + operation: + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' + replace: [] + delete: [] + customers_gcp_project_deployments: + id: google.prod_tt_sasportal.customers_gcp_project_deployments + name: customers_gcp_project_deployments + title: Customers_gcp_project_deployments + methods: + customers_list_gcp_project_deployments: + operation: + $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments + insert: [] + update: [] + replace: [] + delete: [] + customers_legacy_organizations: + id: google.prod_tt_sasportal.customers_legacy_organizations + name: customers_legacy_organizations + title: Customers_legacy_organizations + methods: + customers_list_legacy_organizations: + operation: + $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations insert: [] update: [] replace: [] delete: [] paths: - /v1alpha1/nodes/{nodesId}/devices: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: parameters: &ref_1 - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/oauth_token' - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.create + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.deployments.devices.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + patch: + description: Updates a device. + operationId: prod_tt_sasportal.deployments.devices.patch requestBody: content: application/json: @@ -2019,13 +2049,23 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.list + - in: path + name: devicesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2041,31 +2081,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: devicesId + required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: parameters: *ref_1 patch: description: Updates a signed device. - operationId: prod_tt_sasportal.nodes.devices.updateSigned + operationId: prod_tt_sasportal.deployments.devices.updateSigned requestBody: content: application/json: @@ -2086,10 +2118,47 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + parameters: *ref_1 + post: + description: Signs a device. + operationId: prod_tt_sasportal.deployments.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string @@ -2098,11 +2167,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: parameters: *ref_1 - get: - description: Gets details about a device. - operationId: prod_tt_sasportal.nodes.devices.get + post: + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.deployments.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2118,10 +2192,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string @@ -2130,9 +2204,11 @@ paths: required: true schema: type: string - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.nodes.devices.delete + /v1alpha1/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: Returns a requested deployment. + operationId: prod_tt_sasportal.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2148,26 +2224,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: devicesId + name: deploymentsId required: true schema: type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 patch: - description: Updates a device. - operationId: prod_tt_sasportal.nodes.devices.patch + description: Updates a signed device. + operationId: prod_tt_sasportal.nodes.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2195,11 +2268,6 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask /v1alpha1/nodes/{nodesId}/devices:createSigned: parameters: *ref_1 post: @@ -2232,16 +2300,11 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: parameters: *ref_1 - post: - description: Signs a device. - operationId: prod_tt_sasportal.nodes.devices.signDevice - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2269,16 +2332,14 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: - parameters: *ref_1 - post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.nodes.devices.move + patch: + description: Updates a device. + operationId: prod_tt_sasportal.nodes.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2294,7 +2355,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -2306,11 +2367,14 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: - parameters: *ref_1 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Lists deployments. - operationId: prod_tt_sasportal.nodes.nodes.deployments.list + description: Gets details about a device. + operationId: prod_tt_sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2326,7 +2390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -2334,31 +2398,20 @@ paths: schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1alpha1/nodes/{nodesId}/devices: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.nodes.nodes.deployments.create + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2374,28 +2427,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: - parameters: *ref_1 - post: - description: Creates a new node. - operationId: prod_tt_sasportal.nodes.nodes.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2411,21 +2452,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: nodesId1 - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - get: - description: Lists nodes. - operationId: prod_tt_sasportal.nodes.nodes.nodes.list + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: + parameters: *ref_1 + post: + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.nodes.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2441,7 +2497,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -2449,33 +2505,20 @@ paths: schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned + description: Signs a device. + operationId: prod_tt_sasportal.nodes.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2491,7 +2534,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -2499,15 +2542,20 @@ paths: schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: parameters: *ref_1 - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.list + post: + description: Moves a deployment under another node or customer. + operationId: prod_tt_sasportal.nodes.deployments.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2523,7 +2571,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -2531,31 +2579,15 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: Returns a requested deployment. + operationId: prod_tt_sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2571,7 +2603,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -2579,20 +2611,18 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: - parameters: *ref_1 patch: - description: Updates an existing node. - operationId: prod_tt_sasportal.nodes.nodes.patch + description: Updates an existing deployment. + operationId: prod_tt_sasportal.nodes.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2608,7 +2638,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -2616,7 +2646,7 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string @@ -2625,9 +2655,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Returns a requested node. - operationId: prod_tt_sasportal.nodes.nodes.get + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2643,7 +2673,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -2651,13 +2681,15 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - delete: - description: Deletes a node. - operationId: prod_tt_sasportal.nodes.nodes.delete + /v1alpha1/nodes/{nodesId}/deployments: + parameters: *ref_1 + get: + description: Lists deployments. + operationId: prod_tt_sasportal.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2673,28 +2705,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: nodesId1 - required: true + - in: query + name: pageToken schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: parameters: *ref_1 - post: - description: Moves a node under another node or customer. - operationId: prod_tt_sasportal.nodes.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2710,7 +2745,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId @@ -2718,20 +2753,31 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Creates a new node. - operationId: prod_tt_sasportal.nodes.nodes.create + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2747,16 +2793,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId required: true schema: type: string - get: - description: Lists nodes. - operationId: prod_tt_sasportal.nodes.nodes.list + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2772,36 +2830,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: deploymentsId + required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.createSigned + description: Creates a new deployment. + operationId: prod_tt_sasportal.nodes.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2817,7 +2867,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -2825,20 +2875,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: - parameters: *ref_1 - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + get: + description: Lists deployments. + operationId: prod_tt_sasportal.nodes.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2854,7 +2897,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId @@ -2862,13 +2905,28 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: + parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.list + description: Lists nodes. + operationId: prod_tt_sasportal.nodes.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2884,7 +2942,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: nodesId @@ -2892,28 +2950,31 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: - parameters: *ref_1 - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.nodes.deployments.delete + post: + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2929,7 +2990,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -2937,13 +2998,15 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.nodes.deployments.get + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2959,7 +3022,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId @@ -2967,18 +3030,31 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - patch: - description: Updates an existing deployment. - operationId: prod_tt_sasportal.nodes.deployments.patch + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2994,7 +3070,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -3002,25 +3078,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: parameters: *ref_1 post: - description: Moves a deployment under another node or customer. - operationId: prod_tt_sasportal.nodes.deployments.move + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3036,7 +3107,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -3044,15 +3115,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: parameters: *ref_1 - get: - description: Lists deployments. - operationId: prod_tt_sasportal.nodes.deployments.list + post: + description: Moves a node under another node or customer. + operationId: prod_tt_sasportal.nodes.nodes.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3068,31 +3144,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + required: true schema: type: string - - in: query - name: filter + - in: path + name: nodesId1 + required: true schema: type: string - /v1alpha1/nodes/{nodesId}: + /v1alpha1/nodes/{nodesId}/nodes: parameters: *ref_1 get: - description: Returns a requested node. - operationId: prod_tt_sasportal.nodes.get + description: Lists nodes. + operationId: prod_tt_sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3108,25 +3176,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/policies:get: - parameters: *ref_1 + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: prod_tt_sasportal.policies.get + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGetPolicyRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3142,18 +3219,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:test: + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: prod_tt_sasportal.policies.test - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' + get: + description: Returns a requested node. + operationId: prod_tt_sasportal.nodes.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3169,20 +3246,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' - parameters: [] - /v1alpha1/policies:set: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: prod_tt_sasportal.policies.set - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSetPolicyRequest' + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: nodesId1 + required: true + schema: + type: string + delete: + description: Deletes a node. + operationId: prod_tt_sasportal.nodes.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3198,21 +3276,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/customers:setupSasAnalytics: - parameters: *ref_1 - post: - description: >- - Setups the a GCP Project to receive SAS Analytics messages via GCP - Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and - BigQuery tables are created automatically as part of this service. - operationId: prod_tt_sasportal.customers.setupSasAnalytics + $ref: '#/components/schemas/SasPortalEmpty' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: nodesId1 + required: true + schema: + type: string + patch: + description: Updates an existing node. + operationId: prod_tt_sasportal.nodes.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3228,13 +3311,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers:listLegacyOrganizations: + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: nodesId1 + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}: parameters: *ref_1 get: - description: Returns a list of legacy organizations. - operationId: prod_tt_sasportal.customers.listLegacyOrganizations + description: Returns a requested node. + operationId: prod_tt_sasportal.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3250,20 +3348,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' - parameters: [] - /v1alpha1/customers:provisionDeployment: + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + /v1alpha1/installer:generateSecret: parameters: *ref_1 post: - description: >- - Creates a new SAS deployment through the GCP workflow. Creates a SAS - organization if an organization match is not found. - operationId: prod_tt_sasportal.customers.provisionDeployment + description: Generates a secret to be used with the ValidateInstaller. + operationId: prod_tt_sasportal.installer.generateSecret requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3279,13 +3380,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' parameters: [] - /v1alpha1/customers: + /v1alpha1/installer:validate: parameters: *ref_1 - get: - description: Returns a list of requested customers. - operationId: prod_tt_sasportal.customers.list + post: + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: prod_tt_sasportal.installer.validate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3301,52 +3407,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' - parameters: - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1alpha1/customers/{customersId}: + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + parameters: [] + /v1alpha1/policies:set: parameters: *ref_1 - get: - description: Returns a requested customer. - operationId: prod_tt_sasportal.customers.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCustomer' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - patch: - description: Updates an existing customer. - operationId: prod_tt_sasportal.customers.patch + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: prod_tt_sasportal.policies.set requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3362,25 +3436,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers:listGcpProjectDeployments: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:get: parameters: *ref_1 - get: + post: description: >- - Returns a list of SAS deployments associated with current GCP project. - Includes whether SAS analytics has been enabled or not. - operationId: prod_tt_sasportal.customers.listGcpProjectDeployments + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: prod_tt_sasportal.policies.get + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3395,24 +3464,19 @@ paths: description: Successful response content: application/json: - schema: - $ref: >- - #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + schema: + $ref: '#/components/schemas/SasPortalPolicy' parameters: [] - /v1alpha1/customers:migrateOrganization: + /v1alpha1/policies:test: parameters: *ref_1 post: - description: >- - Migrates a SAS organization to the cloud. This will create GCP projects - for each deployment and associate them. The SAS Organization is linked - to the gcp project that called the command. - go/sas-legacy-customer-migration - operationId: prod_tt_sasportal.customers.migrateOrganization + description: Returns permissions that a caller has on the specified resource. + operationId: prod_tt_sasportal.policies.test requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + $ref: '#/components/schemas/SasPortalTestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3428,13 +3492,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' parameters: [] - /v1alpha1/customers/{customersId}/devices/{devicesId}: + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: parameters: *ref_1 - get: - description: Gets details about a device. - operationId: prod_tt_sasportal.customers.devices.get + post: + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.customers.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3450,7 +3519,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -3462,6 +3531,8 @@ paths: required: true schema: type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}: + parameters: *ref_1 delete: description: Deletes a device. operationId: prod_tt_sasportal.customers.devices.delete @@ -3492,14 +3563,9 @@ paths: required: true schema: type: string - patch: - description: Updates a device. - operationId: prod_tt_sasportal.customers.devices.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.customers.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3527,21 +3593,14 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: - parameters: *ref_1 - post: - description: Signs a device. - operationId: prod_tt_sasportal.customers.devices.signDevice + patch: + description: Updates a device. + operationId: prod_tt_sasportal.customers.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3557,7 +3616,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3569,6 +3628,11 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: parameters: *ref_1 patch: @@ -3608,14 +3672,9 @@ paths: type: string /v1alpha1/customers/{customersId}/devices: parameters: *ref_1 - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3631,16 +3690,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: customersId required: true schema: type: string - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.devices.list + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3656,36 +3733,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1alpha1/customers/{customersId}/devices:createSigned: + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.devices.createSigned + description: Signs a device. + operationId: prod_tt_sasportal.customers.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3701,23 +3765,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices:createSigned: parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.customers.devices.move + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3733,28 +3802,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_1 post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.nodes.create + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3770,7 +3834,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3778,13 +3842,15 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.nodes.list + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3800,7 +3866,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: customersId @@ -3808,28 +3874,31 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: filter schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: - parameters: *ref_1 - get: - description: Lists deployments. - operationId: prod_tt_sasportal.customers.nodes.deployments.list + type: string + post: + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3845,7 +3914,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3853,31 +3922,15 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.customers.nodes.deployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + parameters: *ref_1 + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.customers.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3893,7 +3946,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -3901,20 +3954,18 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.createSigned + patch: + description: Updates an existing deployment. + operationId: prod_tt_sasportal.customers.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3930,7 +3981,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -3938,20 +3989,18 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: - parameters: *ref_1 - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Returns a requested deployment. + operationId: prod_tt_sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3967,7 +4016,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -3975,13 +4024,20 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.list + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + parameters: *ref_1 + post: + description: Moves a deployment under another node or customer. + operationId: prod_tt_sasportal.customers.deployments.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3997,7 +4053,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -4005,28 +4061,15 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1alpha1/customers/{customersId}/nodes: + /v1alpha1/customers/{customersId}/deployments: parameters: *ref_1 get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.list + description: Lists deployments. + operationId: prod_tt_sasportal.customers.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4042,7 +4085,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId @@ -4053,23 +4096,23 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.create + description: Creates a new deployment. + operationId: prod_tt_sasportal.customers.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4085,23 +4128,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: parameters: *ref_1 - post: - description: Moves a node under another node or customer. - operationId: prod_tt_sasportal.customers.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + get: + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4117,7 +4155,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId @@ -4129,41 +4167,27 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}: - parameters: *ref_1 - get: - description: Returns a requested node. - operationId: prod_tt_sasportal.customers.nodes.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: customersId - required: true + - in: query + name: filter schema: type: string - - in: path - name: nodesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a node. - operationId: prod_tt_sasportal.customers.nodes.delete + post: + description: Creates a new node. + operationId: prod_tt_sasportal.customers.nodes.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4179,7 +4203,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -4191,14 +4215,16 @@ paths: required: true schema: type: string - patch: - description: Updates an existing node. - operationId: prod_tt_sasportal.customers.nodes.patch + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4214,7 +4240,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -4226,16 +4252,11 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: parameters: *ref_1 post: description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.create + operationId: prod_tt_sasportal.customers.nodes.devices.create requestBody: content: application/json: @@ -4264,13 +4285,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string get: description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.list + operationId: prod_tt_sasportal.customers.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4294,7 +4315,7 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string @@ -4311,16 +4332,16 @@ paths: schema: type: integer format: int32 - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.createSigned + description: Creates a new deployment. + operationId: prod_tt_sasportal.customers.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4336,7 +4357,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -4344,20 +4365,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: - parameters: *ref_1 - post: - description: Moves a deployment under another node or customer. - operationId: prod_tt_sasportal.customers.deployments.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + get: + description: Lists deployments. + operationId: prod_tt_sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4373,7 +4387,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId @@ -4381,15 +4395,33 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers/{customersId}/nodes: parameters: *ref_1 - get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.customers.deployments.get + post: + description: Creates a new node. + operationId: prod_tt_sasportal.customers.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4405,21 +4437,61 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId required: true schema: type: string + get: + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalListNodesResponse' + parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.customers.deployments.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + parameters: *ref_1 + post: + description: Moves a node under another node or customer. + operationId: prod_tt_sasportal.customers.nodes.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4435,7 +4507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -4443,18 +4515,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}: + parameters: *ref_1 patch: - description: Updates an existing deployment. - operationId: prod_tt_sasportal.customers.deployments.patch + description: Updates an existing node. + operationId: prod_tt_sasportal.customers.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4470,7 +4544,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -4478,7 +4552,7 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string @@ -4487,11 +4561,9 @@ paths: schema: type: string format: google-fieldmask - /v1alpha1/customers/{customersId}/deployments: - parameters: *ref_1 get: - description: Lists deployments. - operationId: prod_tt_sasportal.customers.deployments.list + description: Returns a requested node. + operationId: prod_tt_sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4507,34 +4579,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: nodesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.customers.deployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + delete: + description: Deletes a node. + operationId: prod_tt_sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4550,18 +4609,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + - in: path + name: nodesId + required: true + schema: + type: string + /v1alpha1/customers:setupSasAnalytics: parameters: *ref_1 - get: - description: Gets details about a device. - operationId: prod_tt_sasportal.deployments.devices.get + post: + description: >- + Setups the a GCP Project to receive SAS Analytics messages via GCP + Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and + BigQuery tables are created automatically as part of this service. + operationId: prod_tt_sasportal.customers.setupSasAnalytics + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4577,26 +4649,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers/{customersId}: + parameters: *ref_1 patch: - description: Updates a device. - operationId: prod_tt_sasportal.deployments.devices.patch + description: Updates an existing customer. + operationId: prod_tt_sasportal.customers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCustomer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4612,15 +4676,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCustomer' parameters: - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId + name: customersId required: true schema: type: string @@ -4629,9 +4688,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.deployments.devices.delete + get: + description: Returns a requested customer. + operationId: prod_tt_sasportal.customers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4647,28 +4706,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalCustomer' parameters: - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId + name: customersId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + /v1alpha1/customers:provisionDeployment: parameters: *ref_1 post: - description: Signs a device. - operationId: prod_tt_sasportal.deployments.devices.signDevice + description: >- + Creates a new SAS deployment through the GCP workflow. Creates a SAS + organization if an organization match is not found. + operationId: prod_tt_sasportal.customers.provisionDeployment requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4684,28 +4740,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' + parameters: [] + /v1alpha1/customers:listGcpProjectDeployments: parameters: *ref_1 - patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.deployments.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + get: + description: >- + Returns a list of SAS deployments associated with current GCP project. + Includes whether SAS analytics has been enabled or not. + operationId: prod_tt_sasportal.customers.listGcpProjectDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4721,28 +4764,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers: parameters: *ref_1 - post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.deployments.devices.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + get: + description: Returns a list of requested customers. + operationId: prod_tt_sasportal.customers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4758,55 +4787,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListCustomersResponse' parameters: - - in: path - name: deploymentsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: pageSize schema: - type: string - /v1alpha1/deployments/{deploymentsId}: + type: integer + format: int32 + /v1alpha1/customers:listLegacyOrganizations: parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.deployments.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/installer:validate: - parameters: *ref_1 - post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: prod_tt_sasportal.installer.validate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerRequest' + description: Returns a list of legacy organizations. + operationId: prod_tt_sasportal.customers.listLegacyOrganizations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4822,18 +4818,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' parameters: [] - /v1alpha1/installer:generateSecret: + /v1alpha1/customers:migrateOrganization: parameters: *ref_1 post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: prod_tt_sasportal.installer.generateSecret + description: >- + Migrates a SAS organization to the cloud. This will create GCP projects + for each deployment and associate them. The SAS Organization is linked + to the gcp project that called the command. + go/sas-legacy-customer-migration + operationId: prod_tt_sasportal.customers.migrateOrganization requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4849,5 +4849,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml b/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml index a04d9469..cf062324 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml @@ -10,8 +10,8 @@ info: external account binding keys associated with Google Trust Services' publicly trusted certificate authority. version: v1 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/public-certificate-authority/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml b/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml index 8f41b9c8..643cecd6 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml @@ -10,7 +10,7 @@ info: applications. version: v1 x-discovery-doc-revision: '20240903' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/pubsub/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml b/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml index 50b7212a..42e73284 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml @@ -7,8 +7,8 @@ info: title: Pub/Sub Lite API description: '' version: v1 - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/pubsub/lite/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml b/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml index c0a2f2d4..ef787bc8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml @@ -10,7 +10,7 @@ info: assessment and planning tool. version: v1 x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/migration-center servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml b/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml index 202efbd4..e5faff85 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml @@ -10,7 +10,7 @@ info: creating friction. version: v1 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/recaptcha-enterprise/ servers: @@ -36,916 +36,651 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: - id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse + GoogleCloudRecaptchaenterpriseV1IpOverrideData: + description: Information about the IP or IP range override. + properties: + overrideType: + enumDescriptions: + - >- + Default override type that indicates this enum hasn't been + specified. + - >- + Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 + for all valid assessments. + description: Required. Describes the type of IP override. + enum: + - OVERRIDE_TYPE_UNSPECIFIED + - ALLOW + type: string + ip: + description: >- + Required. The IP address to override (can be IPv4, IPv6 or CIDR). + The IP override must be a valid IPv4 or IPv6 address, or a CIDR + range. The IP override must be a public IP address. Example of IPv4: + 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B + Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: + 2001:0DB8:1234::/48 + type: string + id: GoogleCloudRecaptchaenterpriseV1IpOverrideData type: object + GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest: properties: - relatedAccountGroups: + ipOverrideData: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' + description: Required. IP override added to the key. + id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest + description: The AddIpOverride request message. + type: object + GoogleCloudRecaptchaenterpriseV1ScoreMetrics: + type: object + properties: + actionMetrics: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + description: >- + Action-based metrics. The map key is the action name which specified + by the site owners at time of the "execute" client-side call. + overallMetrics: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + description: Aggregated score metrics for all traffic. + description: Metrics related to scoring. + id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: + id: >- + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + type: object + description: The response to a `ListRelatedAccountGroupMemberships` call. + properties: + relatedAccountGroupMemberships: type: array - description: The groups of related accounts listed by the query. items: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + description: The memberships listed by the query. 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 - description: The response to a `ListRelatedAccountGroups` call. - GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse: - type: object - description: Response for AddIpOverride. - id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse - properties: {} - GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: - id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: type: object - properties: {} description: >- - A block action serves an HTTP error code a prevents the request from - hitting the backend. - GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: - type: object - properties: - cardLabels: - description: Output only. The labels for the payment card in this transaction. - type: array - readOnly: true - items: - type: string - enum: - - CARD_LABEL_UNSPECIFIED - - PREPAID - - VIRTUAL - - UNEXPECTED_LOCATION - enumDescriptions: - - No label specified. - - This card has been detected as prepaid. - - >- - This card has been detected as virtual, such as a card number - generated for a single transaction or merchant. - - >- - This card has been detected as being used in an unexpected - geographic location. - description: Signals describing the payment card used in this transaction. - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - GoogleCloudRecaptchaenterpriseV1UserId: + A substitute action transparently serves a different page than the one + requested. properties: - email: - type: string - description: Optional. An email address. - username: + path: type: string description: >- - Optional. A unique username, if different from all the other - identifiers and `account_id` that are provided. Can be a unique - login handle or display name for a user. - phoneNumber: - description: Optional. A phone number. Should use the E.164 format. - type: string - id: GoogleCloudRecaptchaenterpriseV1UserId - type: object - description: An identifier associated with a user. - GoogleCloudRecaptchaenterpriseV1TransactionDataUser: + Optional. The address to redirect to. The target is a relative path + in the current host. Example: "/blog/404.html". + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: type: object properties: - emailVerified: + lastVerificationTime: description: >- - Optional. Whether the email has been verified to be accessible by - the user (OTP or similar). - type: boolean - phoneNumber: - type: string - description: Optional. The phone number of the user, with country code. - email: - description: Optional. The email address of the user. + Output only. Timestamp of the last successful verification for the + endpoint, if any. + format: google-datetime type: string - creationMs: - description: Optional. The epoch milliseconds of the user's account creation. - format: int64 + readOnly: true + requestToken: type: string - accountId: + readOnly: true description: >- - Optional. Unique account identifier for this user. If using account - defender, this should match the hashed_account_id field. Otherwise, - a unique and persistent identifier for this account. + Output only. Token to provide to the client to trigger endpoint + verification. It must be used within 15 minutes. + phoneNumber: type: string - phoneVerified: - description: >- - Optional. Whether the phone number has been verified to be - accessible by the user (OTP or similar). - type: boolean - description: Details about a user's account involved in the transaction. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser - GoogleCloudRecaptchaenterpriseV1IpOverrideData: - type: object - properties: - ip: description: >- - Required. The IP address to override (can be IPv4, IPv6 or CIDR). - The IP override must be a valid IPv4 or IPv6 address, or a CIDR - range. The IP override must be a public IP address. Example of IPv4: - 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B - Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: - 2001:0DB8:1234::/48 - type: string - overrideType: - enumDescriptions: - - >- - Default override type that indicates this enum hasn't been - specified. - - >- - Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 - for all valid assessments. - enum: - - OVERRIDE_TYPE_UNSPECIFIED - - ALLOW + Phone number for which to trigger a verification request. Should be + given in E.164 format. + emailAddress: type: string - description: Required. Describes the type of IP override. - description: Information about the IP or IP range override. - id: GoogleCloudRecaptchaenterpriseV1IpOverrideData - GoogleCloudRecaptchaenterpriseV1TestingOptions: + description: Email address for which to trigger a verification request. + description: Information about a verification endpoint that can be used for 2FA. + id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + GoogleCloudRecaptchaenterpriseV1ScoreDistribution: + description: Score distribution. properties: - testingScore: - description: >- - Optional. All assessments for this Key return this score. Must be - between 0 (likely not legitimate) and 1 (likely legitimate) - inclusive. - format: float - type: number - testingChallenge: - enum: - - TESTING_CHALLENGE_UNSPECIFIED - - NOCAPTCHA - - UNSOLVABLE_CHALLENGE - type: string - enumDescriptions: - - >- - Perform the normal risk analysis and return either nocaptcha or a - challenge depending on risk and trust factors. - - >- - Challenge requests for this key always return a nocaptcha, which - does not require a solution. - - >- - Challenge requests for this key always return an unsolvable - challenge. + scoreBuckets: description: >- - Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - challenge requests for this site return nocaptcha if NOCAPTCHA, or - an unsolvable challenge if CHALLENGE. - id: GoogleCloudRecaptchaenterpriseV1TestingOptions + Map key is score value multiplied by 100. The scores are discrete + values between [0, 1]. The maximum number of buckets is on order of + a few dozen, but typically much lower (ie. 10). + additionalProperties: + type: string + format: int64 + type: object type: object - description: Options for user acceptance testing. - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: + id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution + GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict + id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + description: Information about SMS toll fraud. properties: - risk: + reasons: + description: Output only. Reasons contributing to the SMS toll fraud verdict. + type: array + items: + type: string + enumDescriptions: + - Default unspecified reason + - The provided phone number was invalid + enum: + - SMS_TOLL_FRAUD_REASON_UNSPECIFIED + - INVALID_PHONE_NUMBER readOnly: true + risk: + format: float type: number description: >- - Output only. Probability of this transaction attempt being part of a - card testing attack. Values are from 0.0 (lowest) to 1.0 (highest). - format: float - description: >- - Information about card testing fraud, where an adversary is testing - fraudulently obtained cards or brute forcing their details. - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: - type: object - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse - description: The reorder firewall policies response message. - properties: {} - GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment: - description: >- - The environment creating the assessment. This describes your environment - (the system invoking CreateAssessment), NOT the environment of your - user. + Output only. Probability of an SMS event being fraudulent. Values + are from 0.0 (lowest) to 1.0 (highest). + readOnly: true + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: + description: The request message to search related account group memberships. + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest properties: - version: + pageSize: + format: int32 + description: >- + Optional. The maximum number of groups to return. The service might + return fewer than this value. If unspecified, at most 50 groups are + returned. The maximum value is 1000; values above 1000 are coerced + to 1000. + type: integer + pageToken: type: string - description: Optional. The version of the client module. For example, "1.0.0". - client: + description: >- + Optional. A page token, received from a previous + `SearchRelatedAccountGroupMemberships` call. Provide this to + retrieve the subsequent page. When paginating, all other parameters + provided to `SearchRelatedAccountGroupMemberships` must match the + call that provided the page token. + accountId: + description: >- + Optional. The unique stable account identifier used to search + connections. The identifier should correspond to an `account_id` + provided in a previous `CreateAssessment` or `AnnotateAssessment` + call. Either hashed_account_id or account_id must be set, but not + both. + type: string + hashedAccountId: + deprecated: true + format: byte type: string description: >- - Optional. Identifies the client module initiating the - CreateAssessment request. This can be the link to the client - module's project. Examples include: - - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - - "wordpress.org/plugins/recaptcha-something" + Optional. Deprecated: use `account_id` instead. The unique stable + hashed account identifier used to search connections. The identifier + should correspond to a `hashed_account_id` provided in a previous + `CreateAssessment` or `AnnotateAssessment` call. Either + hashed_account_id or account_id must be set, but not both. type: object - id: GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment - GoogleCloudRecaptchaenterpriseV1WafSettings: + GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest: type: object - id: GoogleCloudRecaptchaenterpriseV1WafSettings + id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest + description: The removeIpOverride request message. properties: - wafFeature: + ipOverrideData: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' + description: Required. IP override to be removed from the key. + GoogleCloudRecaptchaenterpriseV1Event: + properties: + wafTokenAssessment: + type: boolean + description: >- + Optional. Flag for running WAF token assessment. If enabled, the + token must be specified, and have been created by a WAF-enabled key. + userInfo: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' + description: >- + Optional. Information about the user that generates this event, when + they can be identified. They are often identified through the use of + an account for logged-in requests or login/registration requests, or + by providing user identifiers for guest actions like checkout. + ja3: type: string + description: Optional. JA3 fingerprint for SSL clients. + fraudPrevention: + description: Optional. The Fraud Prevention setting for this assessment. enum: - - WAF_FEATURE_UNSPECIFIED - - CHALLENGE_PAGE - - SESSION_TOKEN - - ACTION_TOKEN - - EXPRESS + - FRAUD_PREVENTION_UNSPECIFIED + - ENABLED + - DISABLED enumDescriptions: - - Undefined feature. - - Redirects suspicious traffic to reCAPTCHA. - >- - Use reCAPTCHA session-tokens to protect the whole user session on - the site's domain. - - Use reCAPTCHA action-tokens to protect user actions. + Default, unspecified setting. If opted in for automatic detection, + `fraud_prevention_assessment` is returned based on the request. + Otherwise, `fraud_prevention_assessment` is returned if + `transaction_data` is present in the `Event` and Fraud Prevention + is enabled in the Google Cloud console. - >- - Use reCAPTCHA WAF express protection to protect any content other - than web pages, like APIs and IoT devices. - description: Required. The WAF feature for which this key is enabled. - wafService: - enum: - - WAF_SERVICE_UNSPECIFIED - - CA - - FASTLY - - CLOUDFLARE - - AKAMAI - description: Required. The WAF service that uses this key. + Enable Fraud Prevention for this assessment, if Fraud Prevention + is enabled in the Google Cloud console. + - >- + Disable Fraud Prevention for this assessment, regardless of opt-in + status or Google Cloud console settings. + type: string + userAgent: type: string - enumDescriptions: - - Undefined WAF - - Cloud Armor - - Fastly - - Cloudflare - - Akamai - description: >- - Settings specific to keys that can be used for WAF (Web Application - Firewall). - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: - description: Information about behavioral trust of the transaction. - properties: - trust: - type: number - format: float - readOnly: true description: >- - Output only. Probability of this transaction attempt being executed - in a behaviorally trustworthy way. Values are from 0.0 (lowest) to - 1.0 (highest). - type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: - properties: - nextPageToken: + Optional. The user agent present in the request from the user's + device related to this event. + siteKey: + description: >- + Optional. The site key that was used to invoke reCAPTCHA Enterprise + on your site and generate the token. type: string + firewallPolicyEvaluation: + type: boolean 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. - relatedAccountGroupMemberships: - description: The queried memberships. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse - description: The response to a `SearchRelatedAccountGroupMemberships` call. - type: object - GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: - properties: - passedCount: + Optional. Flag for enabling firewall policy config assessment. If + this flag is enabled, the firewall policy is evaluated and a + suggested firewall action is returned in the response. + express: + type: boolean description: >- - Count of nocaptchas (successful verification without a challenge) - plus submitted challenge solutions that were correct and resulted in - verification. - format: int64 + Optional. Flag for a reCAPTCHA express request for an assessment + without a token. If enabled, `site_key` must reference an Express + site key. + token: type: string - nocaptchaCount: description: >- - Count of nocaptchas (successful verification without a challenge) - issued. - format: int64 + Optional. The user response token provided by the reCAPTCHA + Enterprise client-side integration on your site. + transactionData: + description: >- + Optional. Data describing a payment transaction to be assessed. + Sending this data enables reCAPTCHA Enterprise Fraud Prevention and + the FraudPreventionAssessment component in the response. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData' + requestedUri: + description: >- + Optional. The URI resource the user requested that triggered an + assessment. type: string - failedCount: + expectedAction: type: string - format: int64 description: >- - Count of submitted challenge solutions that were incorrect or - otherwise deemed suspicious such that a subsequent challenge was - triggered. - pageloadCount: + Optional. The expected action for this type of event. This should be + the same action provided at token generation time on client-side + platforms already integrated with recaptcha enterprise. + userIpAddress: type: string description: >- - Count of reCAPTCHA checkboxes or badges rendered. This is mostly - equivalent to a count of pageloads for pages that include reCAPTCHA. - format: int64 - description: Metrics related to challenges. - type: object - id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics - GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: - id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest - properties: - skipBillingCheck: - description: >- - Optional. If true, skips the billing check. A reCAPTCHA Enterprise - key or migrated key behaves differently than a reCAPTCHA - (non-Enterprise version) key when you reach a quota limit (see - https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any - disruption of your usage, we check that a billing account is - present. If your usage of reCAPTCHA is under the free quota, you can - safely skip the billing check and proceed with the migration. See - https://cloud.google.com/recaptcha/docs/billing-information. - type: boolean - description: The migrate key request message. - type: object - GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: - properties: - reasons: - description: Output only. Reasons contributing to the SMS toll fraud verdict. - type: array + Optional. The IP address in the request from the user's device + related to this event. + headers: items: type: string - enumDescriptions: - - Default unspecified reason - - The provided phone number was invalid - enum: - - SMS_TOLL_FRAUD_REASON_UNSPECIFIED - - INVALID_PHONE_NUMBER - readOnly: true - risk: + description: Optional. HTTP header information about the request. + type: array + hashedAccountId: + deprecated: true description: >- - Output only. Probability of an SMS event being fraudulent. Values - are from 0.0 (lowest) to 1.0 (highest). - type: number - readOnly: true - format: float - type: object - id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict - description: Information about SMS toll fraud. - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - properties: - details: - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Optional. Deprecated: use `user_info.account_id` instead. Unique + stable hashed user identifier for the request. The identifier must + be hashed using hmac-sha256 with stable secret. type: string - id: GoogleRpcStatus - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: - id: >- - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction + format: byte type: object + id: GoogleCloudRecaptchaenterpriseV1Event + description: The event being assessed. + GoogleCloudRecaptchaenterpriseV1ExpressKeySettings: properties: {} - description: >- - An include reCAPTCHA script action involves injecting reCAPTCHA - JavaScript code into the HTML returned by the site backend. This - reCAPTCHA script is tasked with collecting user signals on the requested - web page, issuing tokens as a cookie within the site domain, and - enabling their utilization in subsequent page requests. - GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: - description: >- - A redirect action returns a 307 (temporary redirect) response, pointing - the user to a reCAPTCHA interstitial page to attach a token. + description: Settings specific to keys that can be used for reCAPTCHA Express. type: object - properties: {} - id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + id: GoogleCloudRecaptchaenterpriseV1ExpressKeySettings GoogleCloudRecaptchaenterpriseV1TransactionDataItem: - description: Line items being purchased in this transaction. properties: - name: - description: Optional. The full name of the item. + quantity: + format: int64 type: string + description: Optional. The quantity of this item that is being purchased. merchantAccountId: type: string description: >- Optional. When a merchant is specified, its corresponding account_id. Necessary to populate marketplace-style transactions. - quantity: - format: int64 - type: string - description: Optional. The quantity of this item that is being purchased. value: + format: double type: number description: >- Optional. The value per item that the user is paying, in the transaction currency, after discounts. - format: double + name: + type: string + description: Optional. The full name of the item. id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem + description: Line items being purchased in this transaction. type: object - GoogleCloudRecaptchaenterpriseV1IOSKeySettings: - description: Settings specific to keys that can be used by iOS apps. - id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings + GoogleCloudRecaptchaenterpriseV1WebKeySettings: type: object + description: Settings specific to keys that can be used by websites. + id: GoogleCloudRecaptchaenterpriseV1WebKeySettings properties: - allowedBundleIds: - type: array + challengeSecurityPreference: + type: string + enum: + - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED + - USABILITY + - BALANCE + - SECURITY + enumDescriptions: + - Default type that indicates this enum hasn't been specified. + - Key tends to show fewer and easier challenges. + - Key tends to show balanced (in amount and difficulty) challenges. + - Key tends to show more and harder challenges. + description: >- + Optional. Settings for the frequency and difficulty at which this + key triggers captcha challenges. This should only be specified for + IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. + integrationType: + description: Required. Describes how this key is integrated with the website. + enumDescriptions: + - >- + Default type that indicates this enum hasn't been specified. This + is not a valid IntegrationType, one of the other types must be + specified instead. + - >- + Only used to produce scores. It doesn't display the "I'm not a + robot" checkbox and never shows captcha challenges. + - >- + Displays the "I'm not a robot" checkbox and may show captcha + challenges after it is checked. + - >- + Doesn't display the "I'm not a robot" checkbox, but may show + captcha challenges after risk analysis. + enum: + - INTEGRATION_TYPE_UNSPECIFIED + - SCORE + - CHECKBOX + - INVISIBLE + type: string + allowAllDomains: + type: boolean + description: Optional. If set to true, it means allowed_domains are not enforced. + allowedDomains: + description: >- + Optional. Domains or subdomains of websites allowed to use the key. + All subdomains of an allowed domain are automatically allowed. A + valid domain requires a host and must not include any path, port, + query or fragment. Examples: 'example.com' or + 'subdomain.example.com' items: type: string + type: array + allowAmpTraffic: description: >- - Optional. iOS bundle ids of apps allowed to use the key. Example: - 'com.companyname.productname.appname' - allowAllBundleIds: + Optional. If set to true, the key can be used on AMP (Accelerated + Mobile Pages) websites. This is supported only for the SCORE + integration type. type: boolean - description: Optional. If set to true, allowed_bundle_ids are not enforced. - appleDeveloperId: + GoogleCloudRecaptchaenterpriseV1UserInfo: + description: >- + User information associated with a request protected by reCAPTCHA + Enterprise. + properties: + createAccountTime: description: >- - Optional. Apple Developer account details for the app that is - protected by the reCAPTCHA Key. reCAPTCHA leverages - platform-specific checks like Apple App Attest and Apple DeviceCheck - to protect your app from abuse. Providing these fields allows - reCAPTCHA to get a better assessment of the integrity of your app. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId - GoogleCloudRecaptchaenterpriseV1TransactionEvent: - id: GoogleCloudRecaptchaenterpriseV1TransactionEvent - description: Describes an event in the lifecycle of a payment transaction. + Optional. Creation time for this account associated with this user. + Leave blank for non logged-in actions, guest checkout, or when there + is no account associated with the current user. + format: google-datetime + type: string + accountId: + description: >- + Optional. For logged-in requests or login/registration requests, the + unique account identifier associated with this user. You can use the + username if it is stable (meaning it is the same for every request + associated with the same user), or any stable user ID of your + choice. Leave blank for non logged-in actions or guest checkout. + type: string + userIds: + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' + description: Optional. Identifiers associated with this user or request. + type: object + id: GoogleCloudRecaptchaenterpriseV1UserInfo + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: + type: object + description: A membership in a group of related accounts. + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership properties: - value: + name: + type: string description: >- - Optional. The value that corresponds with this transaction event, if - one exists. For example, a refund event where $5.00 was refunded. - Currency is obtained from the original transaction data. - type: number - format: double - eventTime: + Required. Identifier. The resource name for this membership in the + format + `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. + accountId: + description: >- + The unique stable account identifier of the member. The identifier + corresponds to an `account_id` provided in a previous + `CreateAssessment` or `AnnotateAssessment` call. type: string + hashedAccountId: + deprecated: true + format: byte description: >- - Optional. Timestamp when this transaction event occurred; otherwise - assumed to be the time of the API call. - format: google-datetime - reason: + Deprecated: use `account_id` instead. The unique stable hashed + account identifier of the member. The identifier corresponds to a + `hashed_account_id` provided in a previous `CreateAssessment` or + `AnnotateAssessment` call. type: string + GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: + properties: {} + description: >- + A redirect action returns a 307 (temporary redirect) response, pointing + the user to a reCAPTCHA interstitial page to attach a token. + type: object + id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: + properties: + nextPageToken: description: >- - Optional. The reason or standardized code that corresponds with this - transaction event, if one exists. For example, a CHARGEBACK event - with code 6005. - eventType: - enumDescriptions: - - Default, unspecified event type. - - >- - Indicates that the transaction is approved by the merchant. The - accompanying reasons can include terms such as 'INHOUSE', - 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. - - >- - Indicates that the transaction is denied and concluded due to - risks detected by the merchant. The accompanying reasons can - include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or - 'MANUAL_REVIEW'. - - >- - Indicates that the transaction is being evaluated by a human, due - to suspicion or risk. - - >- - Indicates that the authorization attempt with the card issuer - succeeded. - - >- - Indicates that the authorization attempt with the card issuer - failed. The accompanying reasons can include Visa's '54' - indicating that the card is expired, or '82' indicating that the - CVV is incorrect. - - >- - Indicates that the transaction is completed because the funds were - settled. - - >- - Indicates that the transaction could not be completed because the - funds were not settled. - - >- - Indicates that the transaction has been canceled. Specify the - reason for the cancellation. For example, - 'INSUFFICIENT_INVENTORY'. - - >- - Indicates that the merchant has received a chargeback inquiry due - to fraud for the transaction, requesting additional information - before a fraud chargeback is officially issued and a formal - chargeback notification is sent. - - >- - Indicates that the merchant has received a chargeback alert due to - fraud for the transaction. The process of resolving the dispute - without involving the payment network is started. - - >- - Indicates that a fraud notification is issued for the transaction, - sent by the payment instrument's issuing bank because the - transaction appears to be fraudulent. We recommend including TC40 - or SAFE data in the `reason` field for this event type. For - partial chargebacks, we recommend that you include an amount in - the `value` field. - - >- - Indicates that the merchant is informed by the payment network - that the transaction has entered the chargeback process due to - fraud. Reason code examples include Discover's '6005' and '6041'. - For partial chargebacks, we recommend that you include an amount - in the `value` field. - - >- - Indicates that the transaction has entered the chargeback process - due to fraud, and that the merchant has chosen to enter - representment. Reason examples include Discover's '6005' and - '6041'. For partial chargebacks, we recommend that you include an - amount in the `value` field. - - >- - Indicates that the transaction has had a fraud chargeback which - was illegitimate and was reversed as a result. For partial - chargebacks, we recommend that you include an amount in the - `value` field. - - >- - Indicates that the merchant has received a refund for a completed - transaction. For partial refunds, we recommend that you include an - amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) - - >- - Indicates that the merchant has received a refund request for this - transaction, but that they have declined it. For partial refunds, - we recommend that you include an amount in the `value` field. - Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) - - >- - Indicates that the completed transaction was refunded by the - merchant. For partial refunds, we recommend that you include an - amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) - - >- - Indicates that the completed transaction was refunded by the - merchant, and that this refund was reversed. For partial refunds, - we recommend that you include an amount in the `value` field. - type: string - description: Optional. The type of this transaction event. - enum: - - TRANSACTION_EVENT_TYPE_UNSPECIFIED - - MERCHANT_APPROVE - - MERCHANT_DENY - - MANUAL_REVIEW - - AUTHORIZATION - - AUTHORIZATION_DECLINE - - PAYMENT_CAPTURE - - PAYMENT_CAPTURE_DECLINE - - CANCEL - - CHARGEBACK_INQUIRY - - CHARGEBACK_ALERT - - FRAUD_NOTIFICATION - - CHARGEBACK - - CHARGEBACK_REPRESENTMENT - - CHARGEBACK_REVERSE - - REFUND_REQUEST - - REFUND_DECLINE - - REFUND - - REFUND_REVERSE - type: object - GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse: - properties: {} - description: Response for RemoveIpOverride. - id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse - type: object - GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: - description: >- - A set header action sets a header and forwards the request to the - backend. This can be used to trigger custom protection implemented on - the backend. - properties: - value: - type: string - description: >- - Optional. The header value to set in the request to the backend - server. - key: + Token to retrieve the next page of results. It is set to empty if no + policies remain in results. type: string - description: >- - Optional. The header key to set in the request to the backend - server. - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + firewallPolicies: + description: Policy details. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + description: Response to request to list firewall policies belonging to a project. type: object - GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: + id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: properties: - phoneNumber: - type: string - description: >- - Phone number for which to trigger a verification request. Should be - given in E.164 format. - emailAddress: + gatewayResponseCode: type: string - description: Email address for which to trigger a verification request. - lastVerificationTime: description: >- - Output only. Timestamp of the last successful verification for the - endpoint, if any. - readOnly: true - format: google-datetime + Optional. Gateway response code describing the state of the + transaction. + name: type: string - requestToken: description: >- - Output only. Token to provide to the client to trigger endpoint - verification. It must be used within 15 minutes. - type: string - readOnly: true - description: Information about a verification endpoint that can be used for 2FA. - id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - type: object - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: - properties: - name: + Optional. Name of the gateway service (for example, stripe, square, + paypal). + avsResponseCode: description: >- - Required. Identifier. The resource name for this membership in the - format - `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. + Optional. AVS response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). type: string - accountId: + cvvResponseCode: type: string description: >- - The unique stable account identifier of the member. The identifier - corresponds to an `account_id` provided in a previous - `CreateAssessment` or `AnnotateAssessment` call. - hashedAccountId: - description: >- - Deprecated: use `account_id` instead. The unique stable hashed - account identifier of the member. The identifier corresponds to a - `hashed_account_id` provided in a previous `CreateAssessment` or - `AnnotateAssessment` call. - deprecated: true - format: byte - type: string - description: A membership in a group of related accounts. + Optional. CVV response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). type: object - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + description: Details about the transaction from the gateway. + id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo GoogleCloudRecaptchaenterpriseV1FirewallAction: + type: object + description: >- + An individual action. Each action represents what to do if a policy + matches. properties: - redirect: - description: >- - This action redirects the request to a reCAPTCHA interstitial to - attach a token. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction allow: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction description: >- The user request did not match any policy and should be allowed access to the requested resource. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction substitute: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction description: >- This action transparently serves a different page to an offending user. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction - includeRecaptchaScript: + redirect: description: >- - This action injects reCAPTCHA JavaScript code into the HTML page - returned by the site backend. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction - block: + This action redirects the request to a reCAPTCHA interstitial to + attach a token. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction - description: >- - This action denies access to a given page. The user gets an HTTP - error code. + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction setHeader: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction description: >- This action sets a custom header but allow the request to continue to the customer backend. + block: + description: >- + This action denies access to a given page. The user gets an HTTP + error code. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction - description: >- - An individual action. Each action represents what to do if a policy - matches. - type: object + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + includeRecaptchaScript: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction + description: >- + This action injects reCAPTCHA JavaScript code into the HTML page + returned by the site backend. id: GoogleCloudRecaptchaenterpriseV1FirewallAction - GoogleCloudRecaptchaenterpriseV1RiskAnalysis: + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: + description: >- + Information about stolen instrument fraud, where the user is not the + legitimate owner of the instrument being used for the purchase. + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict type: object - description: Risk analysis result for an event. properties: - score: - description: >- - Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very - likely legitimate traffic while 0.0 means very likely non-legitimate - traffic). + risk: type: number - format: float readOnly: true - extendedVerdictReasons: description: >- - Output only. Extended verdict reasons to be used for experimentation - only. The set of possible reasons is subject to change. + Output only. Probability of this transaction being executed with a + stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). + format: float + GoogleCloudRecaptchaenterpriseV1Assessment: + type: object + description: A reCAPTCHA Enterprise assessment resource. + id: GoogleCloudRecaptchaenterpriseV1Assessment + properties: + fraudPreventionAssessment: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + description: >- + Output only. Assessment returned by Fraud Prevention when + TransactionData is provided. readOnly: true - type: array - items: - type: string - reasons: - description: Output only. Reasons contributing to the risk analysis verdict. - type: array - items: - type: string - enum: - - CLASSIFICATION_REASON_UNSPECIFIED - - AUTOMATION - - UNEXPECTED_ENVIRONMENT - - TOO_MUCH_TRAFFIC - - UNEXPECTED_USAGE_PATTERNS - - LOW_CONFIDENCE_SCORE - - SUSPECTED_CARDING - - SUSPECTED_CHARGEBACK - enumDescriptions: - - Default unspecified type. - - Interactions matched the behavior of an automated agent. - - The event originated from an illegitimate environment. - - Traffic volume from the event source is higher than normal. - - >- - Interactions with the site were significantly different than - expected patterns. - - >- - Too little traffic has been received from this site thus far to - generate quality risk analysis. - - >- - The request matches behavioral characteristics of a carding - attack. - - >- - The request matches behavioral characteristics of chargebacks - for fraud. + event: + description: Optional. The event being assessed. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' + riskAnalysis: readOnly: true - id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis - GoogleCloudRecaptchaenterpriseV1Event: - id: GoogleCloudRecaptchaenterpriseV1Event - description: The event being assessed. - properties: - ja3: - description: Optional. JA3 fingerprint for SSL clients. - type: string - expectedAction: - type: string - description: >- - Optional. The expected action for this type of event. This should be - the same action provided at token generation time on client-side - platforms already integrated with recaptcha enterprise. - hashedAccountId: - deprecated: true - description: >- - Optional. Deprecated: use `user_info.account_id` instead. Unique - stable hashed user identifier for the request. The identifier must - be hashed using hmac-sha256 with stable secret. - type: string - format: byte - fraudPrevention: - enum: - - FRAUD_PREVENTION_UNSPECIFIED - - ENABLED - - DISABLED - enumDescriptions: - - >- - Default, unspecified setting. If opted in for automatic detection, - `fraud_prevention_assessment` is returned based on the request. - Otherwise, `fraud_prevention_assessment` is returned if - `transaction_data` is present in the `Event` and Fraud Prevention - is enabled in the Google Cloud console. - - >- - Enable Fraud Prevention for this assessment, if Fraud Prevention - is enabled in the Google Cloud console. - - >- - Disable Fraud Prevention for this assessment, regardless of opt-in - status or Google Cloud console settings. - description: Optional. The Fraud Prevention setting for this assessment. - type: string - wafTokenAssessment: - type: boolean - description: >- - Optional. Flag for running WAF token assessment. If enabled, the - token must be specified, and have been created by a WAF-enabled key. - express: - type: boolean + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' + description: Output only. The risk analysis result for the event being assessed. + tokenProperties: + description: Output only. Properties of the provided event token. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' + assessmentEnvironment: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment description: >- - Optional. Flag for a reCAPTCHA express request for an assessment - without a token. If enabled, `site_key` must reference an Express - site key. - firewallPolicyEvaluation: - type: boolean + Optional. The environment creating the assessment. This describes + your environment (the system invoking CreateAssessment), NOT the + environment of your user. + name: description: >- - Optional. Flag for enabling firewall policy config assessment. If - this flag is enabled, the firewall policy is evaluated and a - suggested firewall action is returned in the response. - userAgent: + Output only. Identifier. The resource name for the Assessment in the + format `projects/{project}/assessments/{assessment}`. + readOnly: true type: string + accountVerification: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo description: >- - Optional. The user agent present in the request from the user's - device related to this event. - transactionData: - description: >- - Optional. Data describing a payment transaction to be assessed. - Sending this data enables reCAPTCHA Enterprise Fraud Prevention and - the FraudPreventionAssessment component in the response. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData' - userInfo: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' - description: >- - Optional. Information about the user that generates this event, when - they can be identified. They are often identified through the use of - an account for logged-in requests or login/registration requests, or - by providing user identifiers for guest actions like checkout. - userIpAddress: - type: string + Optional. Account verification information for identity + verification. The assessment event must include a token and site key + to use this feature. + fraudSignals: + readOnly: true description: >- - Optional. The IP address in the request from the user's device - related to this event. - siteKey: + Output only. Fraud Signals specific to the users involved in a + payment transaction. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' + phoneFraudAssessment: description: >- - Optional. The site key that was used to invoke reCAPTCHA Enterprise - on your site and generate the token. - type: string - token: - type: string + Output only. Assessment returned when a site key, a token, and a + phone number as `user_id` are provided. Account defender and SMS + toll fraud protection need to be enabled. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + privatePasswordLeakVerification: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification description: >- - Optional. The user response token provided by the reCAPTCHA - Enterprise client-side integration on your site. - headers: - description: Optional. HTTP header information about the request. - type: array - items: - type: string - requestedUri: + Optional. The private password leak verification field contains the + parameters that are used to to check for leaks privately without + sharing user credentials. + accountDefenderAssessment: description: >- - Optional. The URI resource the user requested that triggered an - assessment. - type: string - type: object - GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: - properties: - smsTollFraudVerdict: + Output only. Assessment returned by account defender when an account + identifier is provided. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict - description: >- - Output only. Assessment of this phone event for risk of SMS toll - fraud. + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment readOnly: true - id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment - type: object - description: Assessment for Phone Fraud - GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest: - type: object - id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest - description: The AddIpOverride request message. - properties: - ipOverrideData: - description: Required. IP override added to the key. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' - GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse: - id: GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse + firewallPolicyAssessment: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + readOnly: true + description: >- + Output only. Assessment returned when firewall policies belonging to + the project are evaluated using the field + firewall_policy_evaluation. + GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: + id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId type: object - description: Response for ListIpOverrides. properties: - nextPageToken: + keyId: type: string - description: >- - Token to retrieve the next page of results. If this field is empty, - no keys remain in the results. - ipOverrides: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData - type: array - description: IP Overrides details. - GoogleCloudRecaptchaenterpriseV1UserInfo: - description: >- - User information associated with a request protected by reCAPTCHA - Enterprise. - properties: - userIds: - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' - type: array - description: Optional. Identifiers associated with this user or request. - accountId: + description: Required. The Apple developer key ID (10-character string). + privateKey: type: string description: >- - Optional. For logged-in requests or login/registration requests, the - unique account identifier associated with this user. You can use the - username if it is stable (meaning it is the same for every request - associated with the same user), or any stable user ID of your - choice. Leave blank for non logged-in actions or guest checkout. - createAccountTime: - description: >- - Optional. Creation time for this account associated with this user. - Leave blank for non logged-in actions, guest checkout, or when there - is no account associated with the current user. + Required. Input only. A private key (downloaded as a text file with + a .p8 file extension) generated for your Apple Developer account. + Ensure that Apple DeviceCheck is enabled for the private key. + teamId: type: string - format: google-datetime - id: GoogleCloudRecaptchaenterpriseV1UserInfo - type: object + description: >- + Required. The Apple team ID (10-character string) owning the + provisioning profile used to build your application. + description: >- + Contains fields that are required to perform Apple-specific integrity + checks. GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: - description: Information about account verification, used for identity verification. properties: username: description: >- @@ -954,23 +689,33 @@ components: `event.user_info`. deprecated: true type: string + endpoints: + type: array + description: Optional. Endpoints that can be used for identity verification. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo languageCode: description: >- Optional. Language code preference for the verification message, set as a IETF BCP 47 language code. type: string - endpoints: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - description: Optional. Endpoints that can be used for identity verification. - type: array latestVerificationResult: - description: Output only. Result of the latest account verification challenge. readOnly: true type: string - enumDescriptions: - - No information about the latest account verification. + enum: + - RESULT_UNSPECIFIED + - SUCCESS_USER_VERIFIED + - ERROR_USER_NOT_VERIFIED + - ERROR_SITE_ONBOARDING_INCOMPLETE + - ERROR_RECIPIENT_NOT_ALLOWED + - ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED + - ERROR_CRITICAL_INTERNAL + - ERROR_CUSTOMER_QUOTA_EXHAUSTED + - ERROR_VERIFICATION_BYPASSED + - ERROR_VERDICT_MISMATCH + enumDescriptions: + - No information about the latest account verification. - >- The user was successfully verified. This means the account verification challenge was successfully completed. @@ -998,618 +743,812 @@ components: - >- The request parameters do not match with the token provided and cannot be processed. - enum: - - RESULT_UNSPECIFIED - - SUCCESS_USER_VERIFIED - - ERROR_USER_NOT_VERIFIED - - ERROR_SITE_ONBOARDING_INCOMPLETE - - ERROR_RECIPIENT_NOT_ALLOWED - - ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED - - ERROR_CRITICAL_INTERNAL - - ERROR_CUSTOMER_QUOTA_EXHAUSTED - - ERROR_VERIFICATION_BYPASSED - - ERROR_VERDICT_MISMATCH - id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo - type: object - GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: + description: Output only. Result of the latest account verification challenge. type: object + id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + description: Information about account verification, used for identity verification. + GoogleCloudRecaptchaenterpriseV1Key: + description: >- + A key used to identify and configure applications (web and/or mobile) + that use reCAPTCHA Enterprise. properties: - address: - items: - type: string - type: array - description: >- - Optional. The first lines of the address. The first line generally - contains the street name and number, and further lines may include - information such as an apartment number. - administrativeArea: - description: >- - Optional. The state, province, or otherwise administrative area of - the address. + expressSettings: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ExpressKeySettings + description: Settings for keys that can be used by reCAPTCHA Express. + iosSettings: + description: Settings for keys that can be used by iOS apps. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' + testingOptions: + description: Optional. Options for user acceptance testing. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' + createTime: + format: google-datetime type: string - recipient: description: >- - Optional. The recipient name, potentially including information such - as "care of". - type: string - postalCode: - description: Optional. The postal or ZIP code of the address. - type: string - locality: + Output only. The timestamp corresponding to the creation of this + key. + readOnly: true + wafSettings: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' + description: Optional. Settings for WAF + name: + description: >- + Identifier. The resource name for the Key in the format + `projects/{project}/keys/{key}`. type: string - description: Optional. The town/city of the address. - regionCode: + webSettings: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' + description: Settings for keys that can be used by websites. + displayName: type: string - description: Optional. The CLDR country/region of the address. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - description: Structured address format for billing and shipping addresses. - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: - properties: - risk: - readOnly: true - type: number description: >- - Output only. Probability of this transaction being executed with a - stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). - format: float - type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict - description: >- - Information about stolen instrument fraud, where the user is not the - legitimate owner of the instrument being used for the purchase. - GoogleCloudRecaptchaenterpriseV1ScoreDistribution: - type: object - description: Score distribution. - properties: - scoreBuckets: + Required. Human-readable display name of this key. Modifiable by + user. + androidSettings: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + description: Settings for keys that can be used by Android apps. + labels: + description: >- + Optional. See [Creating and managing labels] + (https://cloud.google.com/recaptcha/docs/labels). additionalProperties: type: string - format: int64 type: object + type: object + id: GoogleCloudRecaptchaenterpriseV1Key + GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: + id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest + description: The migrate key request message. + type: object + properties: + skipBillingCheck: + type: boolean description: >- - Map key is score value multiplied by 100. The scores are discrete - values between [0, 1]. The maximum number of buckets is on order of - a few dozen, but typically much lower (ie. 10). - id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution - GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: + Optional. If true, skips the billing check. A reCAPTCHA Enterprise + key or migrated key behaves differently than a reCAPTCHA + (non-Enterprise version) key when you reach a quota limit (see + https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any + disruption of your usage, we check that a billing account is + present. If your usage of reCAPTCHA is under the free quota, you can + safely skip the billing check and proceed with the migration. See + https://cloud.google.com/recaptcha/docs/billing-information. + GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: type: object + description: >- + Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd + party integration with legacy reCAPTCHA. + id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse properties: - activeDaysLowerBound: - format: int32 + legacySecretKey: + type: string description: >- - Output only. This user (based on email, phone, and other - identifiers) has been seen on the internet for at least this number - of days. - type: integer + The secret key (also known as shared secret) authorizes + communication between your application backend and the reCAPTCHA + Enterprise server to create an assessment. The secret key needs to + be kept safe for security purposes. + GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: + description: Policy config assessment. + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + properties: + firewallPolicy: readOnly: true - syntheticRisk: + description: >- + Output only. The policy that matched the request. If more than one + policy may match, this is the first match. If no policy matches the + incoming request, the policy field is left empty. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' + error: + $ref: '#/components/schemas/GoogleRpcStatus' readOnly: true - type: number - format: float description: >- - Output only. Likelihood (from 0.0 to 1.0) this user includes - synthetic components in their identity, such as a randomly generated - email address, temporary phone number, or fake shipping address. - description: Signals describing the user involved in this transaction. - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals - GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: + Output only. If the processing of a policy config fails, an error is + populated and the firewall_policy is left empty. + type: object + GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse: + description: Response for ListIpOverrides. + type: object properties: - encryptedLeakMatchPrefixes: + nextPageToken: + description: >- + Token to retrieve the next page of results. If this field is empty, + no keys remain in the results. + type: string + ipOverrides: + type: array + description: IP Overrides details. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData + id: GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse + GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse: + properties: {} + id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse + description: Response for RemoveIpOverride. + type: object + GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: + properties: + cardLabels: items: + enumDescriptions: + - No label specified. + - This card has been detected as prepaid. + - >- + This card has been detected as virtual, such as a card number + generated for a single transaction or merchant. + - >- + This card has been detected as being used in an unexpected + geographic location. + enum: + - CARD_LABEL_UNSPECIFIED + - PREPAID + - VIRTUAL + - UNEXPECTED_LOCATION type: string - format: byte - description: >- - Output only. List of prefixes of the encrypted potential password - leaks that matched the given parameters. They must be compared with - the client-side decryption prefix of - `reencrypted_user_credentials_hash` - readOnly: true type: array - lookupHashPrefix: - description: >- - Required. Exactly 26-bit prefix of the SHA-256 hash of the - canonicalized username. It is used to look up password leaks - associated with that hash prefix. - format: byte - type: string - reencryptedUserCredentialsHash: + description: Output only. The labels for the payment card in this transaction. readOnly: true - type: string - description: >- - Output only. Corresponds to the re-encryption of the - `encrypted_user_credentials_hash` field. It is used to match - potential password leaks within `encrypted_leak_match_prefixes`. - format: byte - encryptedUserCredentialsHash: - description: >- - Optional. Encrypted Scrypt hash of the canonicalized - username+password. It is re-encrypted by the server and returned - through `reencrypted_user_credentials_hash`. - type: string - format: byte - id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification - description: Private password leak verification info. type: object - GoogleCloudRecaptchaenterpriseV1Assessment: + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + description: Signals describing the payment card used in this transaction. + GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse: + properties: {} + type: object + description: Response for AddIpOverride. + id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: properties: - accountVerification: - description: >- - Optional. Account verification information for identity - verification. The assessment event must include a token and site key - to use this feature. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo - event: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' - description: Optional. The event being assessed. - fraudSignals: + trust: description: >- - Output only. Fraud Signals specific to the users involved in a - payment transaction. + Output only. Probability of this transaction attempt being executed + in a behaviorally trustworthy way. Values are from 0.0 (lowest) to + 1.0 (highest). + type: number + format: float readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' - fraudPreventionAssessment: - description: >- - Output only. Assessment returned by Fraud Prevention when - TransactionData is provided. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + description: Information about behavioral trust of the transaction. + type: object + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: + type: object + id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + properties: + cardTestingVerdict: readOnly: true - assessmentEnvironment: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict description: >- - Optional. The environment creating the assessment. This describes - your environment (the system invoking CreateAssessment), NOT the - environment of your user. + Output only. Assessment of this transaction for risk of being part + of a card testing attack. + stolenInstrumentVerdict: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment - privatePasswordLeakVerification: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict description: >- - Optional. The private password leak verification field contains the - parameters that are used to to check for leaks privately without - sharing user credentials. + Output only. Assessment of this transaction for risk of a stolen + instrument. + readOnly: true + transactionRisk: + readOnly: true + format: float + description: >- + Output only. Probability of this transaction being fraudulent. + Summarizes the combined risk of attack vectors below. Values are + from 0.0 (lowest) to 1.0 (highest). + type: number + behavioralTrustVerdict: + readOnly: true $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification - accountDefenderAssessment: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + description: Output only. Assessment of this transaction for behavioral trust. + description: Assessment for Fraud Prevention. + GoogleCloudRecaptchaenterpriseV1FraudSignals: + properties: + userSignals: + description: Output only. Signals describing the end user in this transaction. readOnly: true $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + cardSignals: description: >- - Output only. Assessment returned by account defender when an account - identifier is provided. - firewallPolicyAssessment: + Output only. Signals describing the payment card or cards used in + this transaction. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + type: object + id: GoogleCloudRecaptchaenterpriseV1FraudSignals + description: Fraud signals describing users and cards involved in the transaction. + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + type: object + description: The response to a `SearchRelatedAccountGroupMemberships` call. + properties: + nextPageToken: description: >- - Output only. Assessment returned when firewall policies belonging to - the project are evaluated using the field - firewall_policy_evaluation. - readOnly: true - tokenProperties: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' - description: Output only. Properties of the provided event token. - readOnly: true - phoneFraudAssessment: + 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 + relatedAccountGroupMemberships: + description: The queried memberships. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + properties: + syntheticRisk: readOnly: true description: >- - Output only. Assessment returned when a site key, a token, and a - phone number as `user_id` are provided. Account defender and SMS - toll fraud protection need to be enabled. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment - riskAnalysis: - description: Output only. The risk analysis result for the event being assessed. - readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' - name: - type: string + Output only. Likelihood (from 0.0 to 1.0) this user includes + synthetic components in their identity, such as a randomly generated + email address, temporary phone number, or fake shipping address. + type: number + format: float + activeDaysLowerBound: + format: int32 description: >- - Output only. Identifier. The resource name for the Assessment in the - format `projects/{project}/assessments/{assessment}`. + Output only. This user (based on email, phone, and other + identifiers) has been seen on the internet for at least this number + of days. + type: integer readOnly: true type: object - description: A reCAPTCHA Enterprise assessment resource. - id: GoogleCloudRecaptchaenterpriseV1Assessment - GoogleCloudRecaptchaenterpriseV1TokenProperties: - description: Properties of the provided event token. + description: Signals describing the user involved in this transaction. + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: + properties: {} + description: Empty response for AnnotateAssessment. + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + type: object + GoogleCloudRecaptchaenterpriseV1WafSettings: + description: >- + Settings specific to keys that can be used for WAF (Web Application + Firewall). type: object + id: GoogleCloudRecaptchaenterpriseV1WafSettings properties: - invalidReason: + wafFeature: + enum: + - WAF_FEATURE_UNSPECIFIED + - CHALLENGE_PAGE + - SESSION_TOKEN + - ACTION_TOKEN + - EXPRESS enumDescriptions: - - Default unspecified type. - - If the failure reason was not accounted for. - - The provided user verification token was malformed. - - The user verification token had expired. - - The user verification had already been seen. - - The user verification token was not present. + - Undefined feature. + - Redirects suspicious traffic to reCAPTCHA. - >- - A retriable error (such as network failure) occurred on the - browser. Could easily be simulated by an attacker. - readOnly: true - description: Output only. Reason associated with the response when valid = false. - enum: - - INVALID_REASON_UNSPECIFIED - - UNKNOWN_INVALID_REASON - - MALFORMED - - EXPIRED - - DUPE - - MISSING - - BROWSER_ERROR - type: string - hostname: - description: >- - Output only. The hostname of the page on which the token was - generated (Web keys only). - readOnly: true + Use reCAPTCHA session-tokens to protect the whole user session on + the site's domain. + - Use reCAPTCHA action-tokens to protect user actions. + - >- + Use reCAPTCHA WAF express protection to protect any content other + than web pages, like APIs and IoT devices. + description: Required. The WAF feature for which this key is enabled. type: string - createTime: - format: google-datetime + wafService: + description: Required. The WAF service that uses this key. + enumDescriptions: + - Undefined WAF + - Cloud Armor + - Fastly + - Cloudflare + - Akamai type: string - readOnly: true - description: >- - Output only. The timestamp corresponding to the generation of the - token. - valid: - readOnly: true + enum: + - WAF_SERVICE_UNSPECIFIED + - CA + - FASTLY + - CLOUDFLARE + - AKAMAI + GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: + properties: + value: description: >- - Output only. Whether the provided user response token is valid. When - valid = false, the reason could be specified in invalid_reason or it - could also be due to a user failing to solve a challenge or a - sitekey mismatch (i.e the sitekey used to generate the token was - different than the one specified in the assessment). - type: boolean - iosBundleId: + Optional. The header value to set in the request to the backend + server. type: string - description: >- - Output only. The ID of the iOS bundle with which the token was - generated (iOS keys only). - readOnly: true - androidPackageName: - readOnly: true + key: type: string description: >- - Output only. The name of the Android package with which the token - was generated (Android keys only). - action: - type: string - readOnly: true - description: Output only. Action name provided at token generation. - id: GoogleCloudRecaptchaenterpriseV1TokenProperties - GoogleProtobufEmpty: - properties: {} + Optional. The header key to set in the request to the backend + server. + description: >- + A set header action sets a header and forwards the request to the + backend. This can be used to trigger custom protection implemented on + the backend. type: object - id: GoogleProtobufEmpty + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + GoogleProtobufEmpty: 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); } - GoogleCloudRecaptchaenterpriseV1FraudSignals: - properties: - cardSignals: - description: >- - Output only. Signals describing the payment card or cards used in - this transaction. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - userSignals: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals - description: Output only. Signals describing the end user in this transaction. - description: Fraud signals describing users and cards involved in the transaction. - id: GoogleCloudRecaptchaenterpriseV1FraudSignals type: object - GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: + id: GoogleProtobufEmpty + properties: {} + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: + description: The request message to annotate an Assessment. + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest + type: object properties: - labels: + reasons: type: array - readOnly: true - description: Output only. Labels for this request. + description: Optional. Reasons for the annotation that are assigned to the event. items: - type: string enumDescriptions: - - Default unspecified type. - - The request matches a known good profile for the user. + - Default unspecified reason. - >- - The request is potentially a suspicious login event and must be - further verified either through multi-factor authentication or - another system. + Indicates that the transaction had a chargeback issued with no + other details. When possible, specify the type by using + CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. - >- - The request matched a profile that previously had suspicious - account creation behavior. This can mean that this is a fake - account. + Indicates that the transaction had a chargeback issued related + to an alleged unauthorized transaction from the cardholder's + perspective (for example, the card number was stolen). - >- - The account in the request has a high number of related - accounts. It does not necessarily imply that the account is bad - but can require further investigation. + Indicates that the transaction had a chargeback issued related + to the cardholder having provided their card details but + allegedly not being satisfied with the purchase (for example, + misrepresentation, attempted cancellation). + - >- + Indicates that the completed payment transaction was refunded by + the seller. + - >- + Indicates that the completed payment transaction was determined + to be fraudulent by the seller, and was cancelled and refunded + as a result. + - >- + Indicates that the payment transaction was accepted, and the + user was charged. + - >- + Indicates that the payment transaction was declined, for example + due to invalid card details. + - >- + Indicates the transaction associated with the assessment is + suspected of being fraudulent based on the payment method, + billing details, shipping address or other transaction + information. + - >- + Indicates that the user was served a 2FA challenge. An old + assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that + has not been overwritten with `PASSED_TWO_FACTOR` is treated as + an abandoned 2FA flow. This is equivalent to + `FAILED_TWO_FACTOR`. + - Indicates that the user passed a 2FA challenge. + - Indicates that the user failed a 2FA challenge. + - Indicates the user provided the correct password. + - Indicates the user provided an incorrect password. + - >- + Indicates that the user sent unwanted and abusive messages to + other users of the platform, such as spam, scams, phishing, or + social engineering. enum: - - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED - - PROFILE_MATCH - - SUSPICIOUS_LOGIN_ACTIVITY - - SUSPICIOUS_ACCOUNT_CREATION - - RELATED_ACCOUNTS_NUMBER_HIGH - description: Account defender risk assessment. - type: object - id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - GoogleCloudRecaptchaenterpriseV1Key: - type: object - description: >- - A key used to identify and configure applications (web and/or mobile) - that use reCAPTCHA Enterprise. - properties: - displayName: + - REASON_UNSPECIFIED + - CHARGEBACK + - CHARGEBACK_FRAUD + - CHARGEBACK_DISPUTE + - REFUND + - REFUND_FRAUD + - TRANSACTION_ACCEPTED + - TRANSACTION_DECLINED + - PAYMENT_HEURISTICS + - INITIATED_TWO_FACTOR + - PASSED_TWO_FACTOR + - FAILED_TWO_FACTOR + - CORRECT_PASSWORD + - INCORRECT_PASSWORD + - SOCIAL_SPAM + type: string + hashedAccountId: + format: byte type: string description: >- - Required. Human-readable display name of this key. Modifiable by - user. - name: + Optional. A stable hashed account identifier to apply to the + assessment. This is an alternative to setting `hashed_account_id` in + `CreateAssessment`, for example when a stable account identifier is + not yet known in the initial request. + accountId: + type: string description: >- - Identifier. The resource name for the Key in the format - `projects/{project}/keys/{key}`. + Optional. A stable account identifier to apply to the assessment. + This is an alternative to setting `account_id` in + `CreateAssessment`, for example when a stable account identifier is + not yet known in the initial request. + transactionEvent: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent + description: >- + Optional. If the assessment is part of a payment transaction, + provide details on payment lifecycle events that occur in the + transaction. + annotation: + description: >- + Optional. The annotation that is assigned to the Event. This field + can be left empty to provide reasons that apply to an event without + concluding whether the event is legitimate or fraudulent. type: string - webSettings: - description: Settings for keys that can be used by websites. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' - wafSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' - description: Optional. Settings for WAF - testingOptions: - description: Optional. Options for user acceptance testing. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' - labels: - additionalProperties: + enumDescriptions: + - Default unspecified type. + - Provides information that the event turned out to be legitimate. + - Provides information that the event turned out to be fraudulent. + - >- + Provides information that the event was related to a login event + in which the user typed the correct password. Deprecated, prefer + indicating CORRECT_PASSWORD through the reasons field instead. + - >- + Provides information that the event was related to a login event + in which the user typed the incorrect password. Deprecated, prefer + indicating INCORRECT_PASSWORD through the reasons field instead. + enum: + - ANNOTATION_UNSPECIFIED + - LEGITIMATE + - FRAUDULENT + - PASSWORD_CORRECT + - PASSWORD_INCORRECT + enumDeprecated: + - false + - false + - false + - true + - true + GoogleCloudRecaptchaenterpriseV1IOSKeySettings: + id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings + properties: + allowAllBundleIds: + type: boolean + description: Optional. If set to true, allowed_bundle_ids are not enforced. + allowedBundleIds: + items: type: string description: >- - Optional. See [Creating and managing labels] - (https://cloud.google.com/recaptcha/docs/labels). - type: object - androidSettings: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - description: Settings for keys that can be used by Android apps. - expressSettings: + Optional. iOS bundle ids of apps allowed to use the key. Example: + 'com.companyname.productname.appname' + type: array + appleDeveloperId: + description: >- + Optional. Apple Developer account details for the app that is + protected by the reCAPTCHA Key. reCAPTCHA leverages + platform-specific checks like Apple App Attest and Apple DeviceCheck + to protect your app from abuse. Providing these fields allows + reCAPTCHA to get a better assessment of the integrity of your app. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ExpressKeySettings - description: Settings for keys that can be used by reCAPTCHA Express. - iosSettings: - description: Settings for keys that can be used by iOS apps. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' - createTime: - readOnly: true + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId + type: object + description: Settings specific to keys that can be used by iOS apps. + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: + properties: + names: + type: array + items: + type: string + description: >- + Required. A list containing all policy names, in the new order. Each + name is in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. + description: The reorder firewall policies request message. + type: object + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest + GoogleCloudRecaptchaenterpriseV1TransactionEvent: + properties: + eventTime: type: string + description: >- + Optional. Timestamp when this transaction event occurred; otherwise + assumed to be the time of the API call. format: google-datetime + reason: + type: string description: >- - Output only. The timestamp corresponding to the creation of this - key. - id: GoogleCloudRecaptchaenterpriseV1Key - GoogleCloudRecaptchaenterpriseV1ScoreMetrics: + Optional. The reason or standardized code that corresponds with this + transaction event, if one exists. For example, a CHARGEBACK event + with code 6005. + value: + type: number + format: double + description: >- + Optional. The value that corresponds with this transaction event, if + one exists. For example, a refund event where $5.00 was refunded. + Currency is obtained from the original transaction data. + eventType: + description: Optional. The type of this transaction event. + enumDescriptions: + - Default, unspecified event type. + - >- + Indicates that the transaction is approved by the merchant. The + accompanying reasons can include terms such as 'INHOUSE', + 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. + - >- + Indicates that the transaction is denied and concluded due to + risks detected by the merchant. The accompanying reasons can + include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or + 'MANUAL_REVIEW'. + - >- + Indicates that the transaction is being evaluated by a human, due + to suspicion or risk. + - >- + Indicates that the authorization attempt with the card issuer + succeeded. + - >- + Indicates that the authorization attempt with the card issuer + failed. The accompanying reasons can include Visa's '54' + indicating that the card is expired, or '82' indicating that the + CVV is incorrect. + - >- + Indicates that the transaction is completed because the funds were + settled. + - >- + Indicates that the transaction could not be completed because the + funds were not settled. + - >- + Indicates that the transaction has been canceled. Specify the + reason for the cancellation. For example, + 'INSUFFICIENT_INVENTORY'. + - >- + Indicates that the merchant has received a chargeback inquiry due + to fraud for the transaction, requesting additional information + before a fraud chargeback is officially issued and a formal + chargeback notification is sent. + - >- + Indicates that the merchant has received a chargeback alert due to + fraud for the transaction. The process of resolving the dispute + without involving the payment network is started. + - >- + Indicates that a fraud notification is issued for the transaction, + sent by the payment instrument's issuing bank because the + transaction appears to be fraudulent. We recommend including TC40 + or SAFE data in the `reason` field for this event type. For + partial chargebacks, we recommend that you include an amount in + the `value` field. + - >- + Indicates that the merchant is informed by the payment network + that the transaction has entered the chargeback process due to + fraud. Reason code examples include Discover's '6005' and '6041'. + For partial chargebacks, we recommend that you include an amount + in the `value` field. + - >- + Indicates that the transaction has entered the chargeback process + due to fraud, and that the merchant has chosen to enter + representment. Reason examples include Discover's '6005' and + '6041'. For partial chargebacks, we recommend that you include an + amount in the `value` field. + - >- + Indicates that the transaction has had a fraud chargeback which + was illegitimate and was reversed as a result. For partial + chargebacks, we recommend that you include an amount in the + `value` field. + - >- + Indicates that the merchant has received a refund for a completed + transaction. For partial refunds, we recommend that you include an + amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + - >- + Indicates that the merchant has received a refund request for this + transaction, but that they have declined it. For partial refunds, + we recommend that you include an amount in the `value` field. + Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) + - >- + Indicates that the completed transaction was refunded by the + merchant. For partial refunds, we recommend that you include an + amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + - >- + Indicates that the completed transaction was refunded by the + merchant, and that this refund was reversed. For partial refunds, + we recommend that you include an amount in the `value` field. + enum: + - TRANSACTION_EVENT_TYPE_UNSPECIFIED + - MERCHANT_APPROVE + - MERCHANT_DENY + - MANUAL_REVIEW + - AUTHORIZATION + - AUTHORIZATION_DECLINE + - PAYMENT_CAPTURE + - PAYMENT_CAPTURE_DECLINE + - CANCEL + - CHARGEBACK_INQUIRY + - CHARGEBACK_ALERT + - FRAUD_NOTIFICATION + - CHARGEBACK + - CHARGEBACK_REPRESENTMENT + - CHARGEBACK_REVERSE + - REFUND_REQUEST + - REFUND_DECLINE + - REFUND + - REFUND_REVERSE + type: string + id: GoogleCloudRecaptchaenterpriseV1TransactionEvent + type: object + description: Describes an event in the lifecycle of a payment transaction. + GoogleRpcStatus: type: object - id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics properties: - actionMetrics: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + message: + type: string description: >- - Action-based metrics. The map key is the action name which specified - by the site owners at time of the "execute" client-side call. - type: object - overallMetrics: - description: Aggregated score metrics for all traffic. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution - description: Metrics related to scoring. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: description: An allow action continues processing a request unimpeded. id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction type: object properties: {} - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment: properties: - hashedAccountId: - format: byte - deprecated: true - type: string - description: >- - Optional. Deprecated: use `account_id` instead. The unique stable - hashed account identifier used to search connections. The identifier - should correspond to a `hashed_account_id` provided in a previous - `CreateAssessment` or `AnnotateAssessment` call. Either - hashed_account_id or account_id must be set, but not both. - pageToken: - description: >- - Optional. A page token, received from a previous - `SearchRelatedAccountGroupMemberships` call. Provide this to - retrieve the subsequent page. When paginating, all other parameters - provided to `SearchRelatedAccountGroupMemberships` must match the - call that provided the page token. - type: string - accountId: - description: >- - Optional. The unique stable account identifier used to search - connections. The identifier should correspond to an `account_id` - provided in a previous `CreateAssessment` or `AnnotateAssessment` - call. Either hashed_account_id or account_id must be set, but not - both. + client: type: string - pageSize: - type: integer - format: int32 description: >- - Optional. The maximum number of groups to return. The service might - return fewer than this value. If unspecified, at most 50 groups are - returned. The maximum value is 1000; values above 1000 are coerced - to 1000. - description: The request message to search related account group memberships. - type: object - GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: - properties: - nextPageToken: + Optional. Identifies the client module initiating the + CreateAssessment request. This can be the link to the client + module's project. Examples include: - + "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" + - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - + "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - + "wordpress.org/plugins/recaptcha-something" + version: + description: Optional. The version of the client module. For example, "1.0.0". type: string - description: >- - Token to retrieve the next page of results. It is set to empty if no - policies remain in results. - firewallPolicies: - description: Policy details. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - description: Response to request to list firewall policies belonging to a project. type: object - id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse - GoogleCloudRecaptchaenterpriseV1TransactionData: + description: >- + The environment creating the assessment. This describes your environment + (the system invoking CreateAssessment), NOT the environment of your + user. + id: GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment + GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: properties: - value: - format: double - type: number + passedCount: description: >- - Optional. The decimal value of the transaction in the specified - currency. - currencyCode: - description: Optional. The currency code in ISO-4217 format. + Count of nocaptchas (successful verification without a challenge) + plus submitted challenge solutions that were correct and resulted in + verification. + format: int64 type: string - merchants: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser - type: array - description: >- - Optional. Information about the user or users fulfilling the - transaction. - transactionId: + pageloadCount: description: >- - Unique identifier for the transaction. This custom identifier can be - used to reference this transaction in the future, for example, - labeling a refund or chargeback event. Two attempts at the same - transaction should use the same transaction id. - type: string - cardBin: + Count of reCAPTCHA checkboxes or badges rendered. This is mostly + equivalent to a count of pageloads for pages that include reCAPTCHA. + format: int64 type: string + nocaptchaCount: + format: int64 description: >- - Optional. The Bank Identification Number - generally the first 6 or - 8 digits of the card. - billingAddress: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - description: >- - Optional. Address associated with the payment method when - applicable. - user: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser - description: >- - Optional. Information about the user paying/initiating the - transaction. - paymentMethod: + Count of nocaptchas (successful verification without a challenge) + issued. type: string + failedCount: description: >- - Optional. The payment method for the transaction. The allowed values - are: * credit-card * debit-card * gift-card * processor-{name} (If a - third-party is used, for example, processor-paypal) * custom-{name} - (If an alternative method is used, for example, custom-crypto) - cardLastFour: + Count of submitted challenge solutions that were incorrect or + otherwise deemed suspicious such that a subsequent challenge was + triggered. + format: int64 type: string - description: Optional. The last four digits of the card. - items: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataItem - type: array - description: Optional. Items purchased in this transaction. - shippingAddress: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - description: >- - Optional. Destination address if this transaction involves shipping - a physical item. - shippingValue: - description: >- - Optional. The value of shipping in the specified currency. 0 for - free or no shipping. - format: double - type: number - gatewayInfo: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo - description: >- - Optional. Information about the payment gateway's response to the - transaction. + id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + type: object + description: Metrics related to challenges. + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: description: >- - Transaction data associated with a payment protected by reCAPTCHA - Enterprise. + An include reCAPTCHA script action involves injecting reCAPTCHA + JavaScript code into the HTML returned by the site backend. This + reCAPTCHA script is tasked with collecting user signals on the requested + web page, issuing tokens as a cookie within the site domain, and + enabling their utilization in subsequent page requests. + id: >- + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction type: object - id: GoogleCloudRecaptchaenterpriseV1TransactionData - GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: - description: Policy config assessment. + properties: {} + GoogleCloudRecaptchaenterpriseV1TokenProperties: + description: Properties of the provided event token. type: object properties: - error: + androidPackageName: description: >- - Output only. If the processing of a policy config fails, an error is - populated and the firewall_policy is left empty. - $ref: '#/components/schemas/GoogleRpcStatus' + Output only. The name of the Android package with which the token + was generated (Android keys only). + type: string readOnly: true - firewallPolicy: + valid: description: >- - Output only. The policy that matched the request. If more than one - policy may match, this is the first match. If no policy matches the - incoming request, the policy field is left empty. + Output only. Whether the provided user response token is valid. When + valid = false, the reason could be specified in invalid_reason or it + could also be due to a user failing to solve a challenge or a + sitekey mismatch (i.e the sitekey used to generate the token was + different than the one specified in the assessment). + type: boolean readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: - description: Empty response for AnnotateAssessment. - properties: {} - type: object - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse - GoogleCloudRecaptchaenterpriseV1Metrics: - properties: - challengeMetrics: - type: array - description: >- - Metrics are continuous and in order by dates, and in the granularity - of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have - challenge-based data. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics - scoreMetrics: - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' + hostname: + readOnly: true + type: string description: >- - Metrics are continuous and in order by dates, and in the granularity - of day. All Key types should have score-based data. - startTime: + Output only. The hostname of the page on which the token was + generated (Web keys only). + iosBundleId: + readOnly: true + description: >- + Output only. The ID of the iOS bundle with which the token was + generated (iOS keys only). type: string - description: Inclusive start time aligned to a day (UTC). - format: google-datetime - name: + action: + type: string + readOnly: true + description: Output only. Action name provided at token generation. + createTime: readOnly: true + format: google-datetime + type: string description: >- - Output only. Identifier. The name of the metrics, in the format - `projects/{project}/keys/{key}/metrics`. + Output only. The timestamp corresponding to the generation of the + token. + invalidReason: + readOnly: true + description: Output only. Reason associated with the response when valid = false. + enum: + - INVALID_REASON_UNSPECIFIED + - UNKNOWN_INVALID_REASON + - MALFORMED + - EXPIRED + - DUPE + - MISSING + - BROWSER_ERROR type: string - id: GoogleCloudRecaptchaenterpriseV1Metrics - description: Metrics for a single Key. - type: object - GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: + enumDescriptions: + - Default unspecified type. + - If the failure reason was not accounted for. + - The provided user verification token was malformed. + - The user verification token had expired. + - The user verification had already been seen. + - The user verification token was not present. + - >- + A retriable error (such as network failure) occurred on the + browser. Could easily be simulated by an attacker. + id: GoogleCloudRecaptchaenterpriseV1TokenProperties + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: + description: The reorder firewall policies response message. type: object + properties: {} + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse + GoogleCloudRecaptchaenterpriseV1ListKeysResponse: + description: Response to request to list keys in a project. + id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse properties: - path: - type: string + nextPageToken: description: >- - Optional. The address to redirect to. The target is a relative path - in the current host. Example: "/blog/404.html". - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction - description: >- - A substitute action transparently serves a different page than the one - requested. + Token to retrieve the next page of results. It is set to empty if no + keys remain in results. + type: string + keys: + description: Key details. + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + type: array + type: object GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: properties: supportNonGoogleAppStoreDistribution: @@ -1619,365 +1558,216 @@ components: application that is available for download in app stores in addition to the Google Play Store. allowedPackageNames: - type: array items: type: string + type: array description: >- Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname' allowAllPackageNames: - description: Optional. If set to true, allowed_package_names are not enforced. type: boolean - type: object - id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + description: Optional. If set to true, allowed_package_names are not enforced. description: Settings specific to keys that can be used by Android apps. - GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest: - type: object - properties: - ipOverrideData: - description: Required. IP override to be removed from the key. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' - id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest - description: The removeIpOverride request message. - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: - properties: - names: - items: - type: string - type: array - description: >- - Required. A list containing all policy names, in the new order. Each - name is in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest - description: The reorder firewall policies request message. - type: object - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: - properties: - transactionEvent: - description: >- - Optional. If the assessment is part of a payment transaction, - provide details on payment lifecycle events that occur in the - transaction. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent - reasons: - type: array - items: - enumDescriptions: - - Default unspecified reason. - - >- - Indicates that the transaction had a chargeback issued with no - other details. When possible, specify the type by using - CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. - - >- - Indicates that the transaction had a chargeback issued related - to an alleged unauthorized transaction from the cardholder's - perspective (for example, the card number was stolen). - - >- - Indicates that the transaction had a chargeback issued related - to the cardholder having provided their card details but - allegedly not being satisfied with the purchase (for example, - misrepresentation, attempted cancellation). - - >- - Indicates that the completed payment transaction was refunded by - the seller. - - >- - Indicates that the completed payment transaction was determined - to be fraudulent by the seller, and was cancelled and refunded - as a result. - - >- - Indicates that the payment transaction was accepted, and the - user was charged. - - >- - Indicates that the payment transaction was declined, for example - due to invalid card details. - - >- - Indicates the transaction associated with the assessment is - suspected of being fraudulent based on the payment method, - billing details, shipping address or other transaction - information. - - >- - Indicates that the user was served a 2FA challenge. An old - assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that - has not been overwritten with `PASSED_TWO_FACTOR` is treated as - an abandoned 2FA flow. This is equivalent to - `FAILED_TWO_FACTOR`. - - Indicates that the user passed a 2FA challenge. - - Indicates that the user failed a 2FA challenge. - - Indicates the user provided the correct password. - - Indicates the user provided an incorrect password. - - >- - Indicates that the user sent unwanted and abusive messages to - other users of the platform, such as spam, scams, phishing, or - social engineering. - type: string - enum: - - REASON_UNSPECIFIED - - CHARGEBACK - - CHARGEBACK_FRAUD - - CHARGEBACK_DISPUTE - - REFUND - - REFUND_FRAUD - - TRANSACTION_ACCEPTED - - TRANSACTION_DECLINED - - PAYMENT_HEURISTICS - - INITIATED_TWO_FACTOR - - PASSED_TWO_FACTOR - - FAILED_TWO_FACTOR - - CORRECT_PASSWORD - - INCORRECT_PASSWORD - - SOCIAL_SPAM - description: Optional. Reasons for the annotation that are assigned to the event. - accountId: - type: string - description: >- - Optional. A stable account identifier to apply to the assessment. - This is an alternative to setting `account_id` in - `CreateAssessment`, for example when a stable account identifier is - not yet known in the initial request. - hashedAccountId: - type: string - description: >- - Optional. A stable hashed account identifier to apply to the - assessment. This is an alternative to setting `hashed_account_id` in - `CreateAssessment`, for example when a stable account identifier is - not yet known in the initial request. - format: byte - annotation: - enumDeprecated: - - false - - false - - false - - true - - true - enum: - - ANNOTATION_UNSPECIFIED - - LEGITIMATE - - FRAUDULENT - - PASSWORD_CORRECT - - PASSWORD_INCORRECT - type: string - description: >- - Optional. The annotation that is assigned to the Event. This field - can be left empty to provide reasons that apply to an event without - concluding whether the event is legitimate or fraudulent. - enumDescriptions: - - Default unspecified type. - - Provides information that the event turned out to be legitimate. - - Provides information that the event turned out to be fraudulent. - - >- - Provides information that the event was related to a login event - in which the user typed the correct password. Deprecated, prefer - indicating CORRECT_PASSWORD through the reasons field instead. - - >- - Provides information that the event was related to a login event - in which the user typed the incorrect password. Deprecated, prefer - indicating INCORRECT_PASSWORD through the reasons field instead. + id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings type: object - description: The request message to annotate an Assessment. - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: + GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: + description: >- + A block action serves an HTTP error code a prevents the request from + hitting the backend. + id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + description: A group of related accounts. type: object - description: The response to a `ListRelatedAccountGroupMemberships` call. - id: >- - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse - properties: - relatedAccountGroupMemberships: - description: The memberships listed by the query. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - type: array - nextPageToken: - type: string - 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. - GoogleCloudRecaptchaenterpriseV1ListKeysResponse: - description: Response to request to list keys in a project. properties: - nextPageToken: + name: type: string description: >- - Token to retrieve the next page of results. It is set to empty if no - keys remain in results. - keys: - description: Key details. + Required. Identifier. The resource name for the related account + group in the format + `projects/{project}/relatedaccountgroups/{related_account_group}`. + GoogleCloudRecaptchaenterpriseV1RiskAnalysis: + id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis + description: Risk analysis result for an event. + properties: + reasons: + type: array + readOnly: true items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + enumDescriptions: + - Default unspecified type. + - Interactions matched the behavior of an automated agent. + - The event originated from an illegitimate environment. + - Traffic volume from the event source is higher than normal. + - >- + Interactions with the site were significantly different than + expected patterns. + - >- + Too little traffic has been received from this site thus far to + generate quality risk analysis. + - >- + The request matches behavioral characteristics of a carding + attack. + - >- + The request matches behavioral characteristics of chargebacks + for fraud. + enum: + - CLASSIFICATION_REASON_UNSPECIFIED + - AUTOMATION + - UNEXPECTED_ENVIRONMENT + - TOO_MUCH_TRAFFIC + - UNEXPECTED_USAGE_PATTERNS + - LOW_CONFIDENCE_SCORE + - SUSPECTED_CARDING + - SUSPECTED_CHARGEBACK + type: string + description: Output only. Reasons contributing to the risk analysis verdict. + score: + type: number + description: >- + Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very + likely legitimate traffic while 0.0 means very likely non-legitimate + traffic). + readOnly: true + format: float + extendedVerdictReasons: + readOnly: true + description: >- + Output only. Extended verdict reasons to be used for experimentation + only. The set of possible reasons is subject to change. type: array + items: + type: string type: object - id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse - GoogleCloudRecaptchaenterpriseV1ExpressKeySettings: - id: GoogleCloudRecaptchaenterpriseV1ExpressKeySettings - properties: {} - type: object - description: Settings specific to keys that can be used for reCAPTCHA Express. - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: type: object + description: >- + Information about card testing fraud, where an adversary is testing + fraudulently obtained cards or brute forcing their details. properties: - behavioralTrustVerdict: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict - description: Output only. Assessment of this transaction for behavioral trust. + risk: readOnly: true - stolenInstrumentVerdict: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict description: >- - Output only. Assessment of this transaction for risk of a stolen - instrument. - readOnly: true - transactionRisk: - readOnly: true + Output only. Probability of this transaction attempt being part of a + card testing attack. Values are from 0.0 (lowest) to 1.0 (highest). format: float - description: >- - Output only. Probability of this transaction being fraudulent. - Summarizes the combined risk of attack vectors below. Values are - from 0.0 (lowest) to 1.0 (highest). type: number - cardTestingVerdict: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict - description: >- - Output only. Assessment of this transaction for risk of being part - of a card testing attack. - readOnly: true - id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment - description: Assessment for Fraud Prevention. - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: - properties: - name: - type: string - description: >- - Required. Identifier. The resource name for the related account - group in the format - `projects/{project}/relatedaccountgroups/{related_account_group}`. - type: object - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - description: A group of related accounts. - GoogleCloudRecaptchaenterpriseV1WebKeySettings: + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict + GoogleCloudRecaptchaenterpriseV1TransactionDataUser: + description: Details about a user's account involved in the transaction. + id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser type: object - description: Settings specific to keys that can be used by websites. - id: GoogleCloudRecaptchaenterpriseV1WebKeySettings properties: - challengeSecurityPreference: - enumDescriptions: - - Default type that indicates this enum hasn't been specified. - - Key tends to show fewer and easier challenges. - - Key tends to show balanced (in amount and difficulty) challenges. - - Key tends to show more and harder challenges. + accountId: description: >- - Optional. Settings for the frequency and difficulty at which this - key triggers captcha challenges. This should only be specified for - IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. + Optional. Unique account identifier for this user. If using account + defender, this should match the hashed_account_id field. Otherwise, + a unique and persistent identifier for this account. type: string - enum: - - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED - - USABILITY - - BALANCE - - SECURITY - allowAllDomains: + phoneVerified: type: boolean - description: Optional. If set to true, it means allowed_domains are not enforced. - allowAmpTraffic: description: >- - Optional. If set to true, the key can be used on AMP (Accelerated - Mobile Pages) websites. This is supported only for the SCORE - integration type. - type: boolean - integrationType: - enumDescriptions: - - >- - Default type that indicates this enum hasn't been specified. This - is not a valid IntegrationType, one of the other types must be - specified instead. - - >- - Only used to produce scores. It doesn't display the "I'm not a - robot" checkbox and never shows captcha challenges. - - >- - Displays the "I'm not a robot" checkbox and may show captcha - challenges after it is checked. - - >- - Doesn't display the "I'm not a robot" checkbox, but may show - captcha challenges after risk analysis. - description: Required. Describes how this key is integrated with the website. + Optional. Whether the phone number has been verified to be + accessible by the user (OTP or similar). + creationMs: + format: int64 + description: Optional. The epoch milliseconds of the user's account creation. type: string - enum: - - INTEGRATION_TYPE_UNSPECIFIED - - SCORE - - CHECKBOX - - INVISIBLE - allowedDomains: - type: array - items: - type: string + email: + description: Optional. The email address of the user. + type: string + emailVerified: + type: boolean description: >- - Optional. Domains or subdomains of websites allowed to use the key. - All subdomains of an allowed domain are automatically allowed. A - valid domain requires a host and must not include any path, port, - query or fragment. Examples: 'example.com' or - 'subdomain.example.com' - GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: + Optional. Whether the email has been verified to be accessible by + the user (OTP or similar). + phoneNumber: + type: string + description: Optional. The phone number of the user, with country code. + GoogleCloudRecaptchaenterpriseV1UserId: type: object + id: GoogleCloudRecaptchaenterpriseV1UserId + description: An identifier associated with a user. properties: - keyId: + email: type: string - description: Required. The Apple developer key ID (10-character string). - privateKey: - description: >- - Required. Input only. A private key (downloaded as a text file with - a .p8 file extension) generated for your Apple Developer account. - Ensure that Apple DeviceCheck is enabled for the private key. + description: Optional. An email address. + phoneNumber: type: string - teamId: - description: >- - Required. The Apple team ID (10-character string) owning the - provisioning profile used to build your application. + description: Optional. A phone number. Should use the E.164 format. + username: type: string - id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId - description: >- - Contains fields that are required to perform Apple-specific integrity - checks. - GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: + description: >- + Optional. A unique username, if different from all the other + identifiers and `account_id` that are provided. Can be a unique + login handle or display name for a user. + GoogleCloudRecaptchaenterpriseV1Metrics: + description: Metrics for a single Key. + id: GoogleCloudRecaptchaenterpriseV1Metrics + type: object properties: name: type: string description: >- - Optional. Name of the gateway service (for example, stripe, square, - paypal). - cvvResponseCode: - type: string + Output only. Identifier. The name of the metrics, in the format + `projects/{project}/keys/{key}/metrics`. + readOnly: true + challengeMetrics: + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + type: array description: >- - Optional. CVV response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). - avsResponseCode: + Metrics are continuous and in order by dates, and in the granularity + of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have + challenge-based data. + scoreMetrics: + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' description: >- - Optional. AVS response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). - type: string - gatewayResponseCode: + Metrics are continuous and in order by dates, and in the granularity + of day. All Key types should have score-based data. + type: array + startTime: type: string + description: Inclusive start time aligned to a day (UTC). + format: google-datetime + GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: + properties: + smsTollFraudVerdict: description: >- - Optional. Gateway response code describing the state of the - transaction. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo - description: Details about the transaction from the gateway. + Output only. Assessment of this phone event for risk of SMS toll + fraud. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict type: object + id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + description: Assessment for Phone Fraud GoogleCloudRecaptchaenterpriseV1FirewallPolicy: - type: object - description: >- - A FirewallPolicy represents a single matching pattern and resulting - actions to take. properties: name: + type: string description: >- Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. + description: type: string - condition: + description: >- + Optional. A description of what this policy aims to achieve, for + convenience purposes. The description can at most include 256 UTF-8 + characters. + path: + description: >- + Optional. The path for which this policy applies, specified as a + glob pattern. For more information on glob, see the [manual + page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has + a max length of 200 characters. type: string + condition: description: >- Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. @@ -1988,14 +1778,8 @@ components: spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters. - description: - description: >- - Optional. A description of what this policy aims to achieve, for - convenience purposes. The description can at most include 256 UTF-8 - characters. type: string actions: - type: array description: >- Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal @@ -2003,38 +1787,260 @@ components: `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions. + type: array items: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction - path: + description: >- + A FirewallPolicy represents a single matching pattern and resulting + actions to take. + type: object + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy + GoogleCloudRecaptchaenterpriseV1TransactionData: + type: object + id: GoogleCloudRecaptchaenterpriseV1TransactionData + properties: + merchants: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + description: >- + Optional. Information about the user or users fulfilling the + transaction. + cardLastFour: + description: Optional. The last four digits of the card. type: string + billingAddress: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress description: >- - Optional. The path for which this policy applies, specified as a - glob pattern. For more information on glob, see the [manual - page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has - a max length of 200 characters. - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy - GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: + Optional. Address associated with the payment method when + applicable. + cardBin: + description: >- + Optional. The Bank Identification Number - generally the first 6 or + 8 digits of the card. + type: string + currencyCode: + description: Optional. The currency code in ISO-4217 format. + type: string + shippingValue: + format: double + type: number + description: >- + Optional. The value of shipping in the specified currency. 0 for + free or no shipping. + shippingAddress: + description: >- + Optional. Destination address if this transaction involves shipping + a physical item. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + items: + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataItem + description: Optional. Items purchased in this transaction. + type: array + value: + format: double + description: >- + Optional. The decimal value of the transaction in the specified + currency. + type: number + transactionId: + type: string + description: >- + Unique identifier for the transaction. This custom identifier can be + used to reference this transaction in the future, for example, + labeling a refund or chargeback event. Two attempts at the same + transaction should use the same transaction id. + user: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + description: >- + Optional. Information about the user paying/initiating the + transaction. + paymentMethod: + type: string + description: >- + Optional. The payment method for the transaction. The allowed values + are: * credit-card * debit-card * gift-card * processor-{name} (If a + third-party is used, for example, processor-paypal) * custom-{name} + (If an alternative method is used, for example, custom-crypto) + gatewayInfo: + description: >- + Optional. Information about the payment gateway's response to the + transaction. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo description: >- - Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd - party integration with legacy reCAPTCHA. + Transaction data associated with a payment protected by reCAPTCHA + Enterprise. + GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: + description: Structured address format for billing and shipping addresses. + id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress type: object properties: - legacySecretKey: + recipient: + description: >- + Optional. The recipient name, potentially including information such + as "care of". + type: string + postalCode: + type: string + description: Optional. The postal or ZIP code of the address. + locality: + description: Optional. The town/city of the address. + type: string + regionCode: + description: Optional. The CLDR country/region of the address. + type: string + address: + description: >- + Optional. The first lines of the address. The first line generally + contains the street name and number, and further lines may include + information such as an apartment number. + type: array + items: + type: string + administrativeArea: + description: >- + Optional. The state, province, or otherwise administrative area of + the address. + type: string + GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: + description: Private password leak verification info. + properties: + encryptedLeakMatchPrefixes: + items: + type: string + format: byte + readOnly: true + description: >- + Output only. List of prefixes of the encrypted potential password + leaks that matched the given parameters. They must be compared with + the client-side decryption prefix of + `reencrypted_user_credentials_hash` + type: array + reencryptedUserCredentialsHash: + readOnly: true + format: byte + description: >- + Output only. Corresponds to the re-encryption of the + `encrypted_user_credentials_hash` field. It is used to match + potential password leaks within `encrypted_leak_match_prefixes`. + type: string + encryptedUserCredentialsHash: + description: >- + Optional. Encrypted Scrypt hash of the canonicalized + username+password. It is re-encrypted by the server and returned + through `reencrypted_user_credentials_hash`. + format: byte + type: string + lookupHashPrefix: + format: byte + description: >- + Required. Exactly 26-bit prefix of the SHA-256 hash of the + canonicalized username. It is used to look up password leaks + associated with that hash prefix. + type: string + type: object + id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: + properties: + relatedAccountGroups: + description: The groups of related accounts listed by the query. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + type: array + nextPageToken: + type: string + 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. + id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse + type: object + description: The response to a `ListRelatedAccountGroups` call. + GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: + type: object + description: Account defender risk assessment. + id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment + properties: + labels: + description: Output only. Labels for this request. + type: array + items: + enum: + - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED + - PROFILE_MATCH + - SUSPICIOUS_LOGIN_ACTIVITY + - SUSPICIOUS_ACCOUNT_CREATION + - RELATED_ACCOUNTS_NUMBER_HIGH + type: string + enumDescriptions: + - Default unspecified type. + - The request matches a known good profile for the user. + - >- + The request is potentially a suspicious login event and must be + further verified either through multi-factor authentication or + another system. + - >- + The request matched a profile that previously had suspicious + account creation behavior. This can mean that this is a fake + account. + - >- + The account in the request has a high number of related + accounts. It does not necessarily imply that the account is bad + but can require further investigation. + readOnly: true + GoogleCloudRecaptchaenterpriseV1TestingOptions: + properties: + testingScore: + type: number + format: float + description: >- + Optional. All assessments for this Key return this score. Must be + between 0 (likely not legitimate) and 1 (likely legitimate) + inclusive. + testingChallenge: + enumDescriptions: + - >- + Perform the normal risk analysis and return either nocaptcha or a + challenge depending on risk and trust factors. + - >- + Challenge requests for this key always return a nocaptcha, which + does not require a solution. + - >- + Challenge requests for this key always return an unsolvable + challenge. description: >- - The secret key (also known as shared secret) authorizes - communication between your application backend and the reCAPTCHA - Enterprise server to create an assessment. The secret key needs to - be kept safe for security purposes. + Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + challenge requests for this site return nocaptcha if NOCAPTCHA, or + an unsolvable challenge if CHALLENGE. + enum: + - TESTING_CHALLENGE_UNSPECIFIED + - NOCAPTCHA + - UNSOLVABLE_CHALLENGE type: string - id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + description: Options for user acceptance testing. + type: object + id: GoogleCloudRecaptchaenterpriseV1TestingOptions parameters: - prettyPrint: - description: Returns response with indentations and line breaks. + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string alt: description: Data format for response. in: query @@ -2045,6 +2051,12 @@ components: - json - media - proto + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -2063,28 +2075,19 @@ components: name: key schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - callback: - description: JSONP + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: callback + name: prettyPrint schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: uploadType + name: quotaUser schema: type: string fields: @@ -2099,87 +2102,82 @@ components: name: upload_protocol schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: quotaUser + name: uploadType schema: type: string x-stackQL-resources: - firewallpolicies: - id: google.recaptchaenterprise.firewallpolicies - name: firewallpolicies - title: Firewallpolicies + keys: + id: google.recaptchaenterprise.keys + name: keys + title: Keys methods: - get: + list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/get' response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.keys + create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/patch + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/delete + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' response: mediaType: application/json openAPIDocKey: '200' - reorder: + patch: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies:reorder/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/patch' response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.firewallPolicies - create: + migrate: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/get' - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/list' + - $ref: '#/components/x-stackQL-resources/keys/methods/get' + - $ref: '#/components/x-stackQL-resources/keys/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/create' + - $ref: '#/components/x-stackQL-resources/keys/methods/create' update: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/patch' + - $ref: '#/components/x-stackQL-resources/keys/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/delete' - keys_metrics: - id: google.recaptchaenterprise.keys_metrics - name: keys_metrics - title: Keys_metrics + - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + keys_legacy_secret_key: + id: google.recaptchaenterprise.keys_legacy_secret_key + name: keys_legacy_secret_key + title: Keys_legacy_secret_key methods: - get_metrics: + retrieve_legacy_secret_key: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}~1metrics/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:retrieveLegacySecretKey/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/keys_metrics/methods/get_metrics' + - $ref: >- + #/components/x-stackQL-resources/keys_legacy_secret_key/methods/retrieve_legacy_secret_key insert: [] update: [] replace: [] @@ -2213,59 +2211,24 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/keys_ip_override/methods/remove_ip_override - keys: - id: google.recaptchaenterprise.keys - name: keys - title: Keys + keys_metrics: + id: google.recaptchaenterprise.keys_metrics + name: keys_metrics + title: Keys_metrics methods: - migrate: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.keys - create: + get_metrics: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}~1metrics/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/keys/methods/get' - - $ref: '#/components/x-stackQL-resources/keys/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/keys/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/keys/methods/patch' + - $ref: '#/components/x-stackQL-resources/keys_metrics/methods/get_metrics' + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + delete: [] keys_ip_overrides: id: google.recaptchaenterprise.keys_ip_overrides name: keys_ip_overrides @@ -2287,22 +2250,20 @@ components: update: [] replace: [] delete: [] - keys_legacy_secret_key: - id: google.recaptchaenterprise.keys_legacy_secret_key - name: keys_legacy_secret_key - title: Keys_legacy_secret_key + relatedaccountgroupmemberships: + id: google.recaptchaenterprise.relatedaccountgroupmemberships + name: relatedaccountgroupmemberships + title: Relatedaccountgroupmemberships methods: - retrieve_legacy_secret_key: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:retrieveLegacySecretKey/get + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/keys_legacy_secret_key/methods/retrieve_legacy_secret_key + select: [] insert: [] update: [] replace: [] @@ -2315,43 +2276,80 @@ components: annotate: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1assessments~1{assessmentsId}:annotate/post + #/paths/~1v1~1projects~1{projectsId}~1assessments~1{assessmentsId}:annotate/post + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1assessments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/assessments/methods/create' + update: [] + replace: [] + delete: [] + firewallpolicies: + id: google.recaptchaenterprise.firewallpolicies + name: firewallpolicies + title: Firewallpolicies + methods: + create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.firewallPolicies + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1assessments/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/assessments/methods/create' - update: [] - replace: [] - delete: [] - memberships: - id: google.recaptchaenterprise.memberships - name: memberships - title: Memberships - methods: - list: + reorder: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups~1{relatedaccountgroupsId}~1memberships/get + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies:reorder/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.relatedAccountGroupMemberships sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/memberships/methods/list' - insert: [] - update: [] + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/get' + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/patch' replace: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/delete' relatedaccountgroups: id: google.recaptchaenterprise.relatedaccountgroups name: relatedaccountgroups @@ -2371,41 +2369,43 @@ components: update: [] replace: [] delete: [] - relatedaccountgroupmemberships: - id: google.recaptchaenterprise.relatedaccountgroupmemberships - name: relatedaccountgroupmemberships - title: Relatedaccountgroupmemberships + memberships: + id: google.recaptchaenterprise.memberships + name: memberships + title: Memberships methods: - search: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups~1{relatedaccountgroupsId}~1memberships/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.relatedAccountGroupMemberships sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/memberships/methods/list' insert: [] update: [] replace: [] delete: [] paths: - /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: + /v1/projects/{projectsId}/keys: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' get: - description: Returns the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.get + description: Returns the list of all keys that belong to a project. + operationId: recaptchaenterprise.projects.keys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2418,27 +2418,30 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: firewallpoliciesId - required: true + - in: query + name: pageToken schema: type: string - patch: - description: Updates the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new reCAPTCHA Enterprise key. + operationId: recaptchaenterprise.projects.keys.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2450,27 +2453,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: firewallpoliciesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/keys/{keysId}: + parameters: *ref_1 delete: - description: Deletes the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.delete + description: Deletes the specified key. + operationId: recaptchaenterprise.projects.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2490,21 +2484,18 @@ paths: schema: type: string - in: path - name: firewallpoliciesId + name: keysId required: true schema: type: string - /v1/projects/{projectsId}/firewallpolicies:reorder: - parameters: *ref_1 - post: - description: Reorders all firewall policies. - operationId: recaptchaenterprise.projects.firewallpolicies.reorder + patch: + description: Updates the specified key. + operationId: recaptchaenterprise.projects.keys.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2516,19 +2507,57 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/firewallpolicies: + - in: path + name: keysId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Returns the specified key. + operationId: recaptchaenterprise.projects.keys.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: parameters: *ref_1 get: - description: Returns the list of all firewall policies that belong to a project. - operationId: recaptchaenterprise.projects.firewallpolicies.list + description: >- + Returns the secret key related to the specified public key. You must use + the legacy secret key only in a 3rd party integration with legacy + reCAPTCHA. + operationId: recaptchaenterprise.projects.keys.retrieveLegacySecretKey security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2541,34 +2570,33 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: keysId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/keys/{keysId}:addIpOverride: + parameters: *ref_1 post: description: >- - Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA - Enterprise actions can be executed. A project may have a maximum of 1000 - policies. - operationId: recaptchaenterprise.projects.firewallpolicies.create + Adds an IP override to a key. The following restrictions hold: * The + maximum number of IP overrides per key is 100. * For any conflict (such + as IP already exists or IP part of an existing IP range), an error is + returned. + operationId: recaptchaenterprise.projects.keys.addIpOverride requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2581,13 +2609,18 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: keysId + required: true + schema: + type: string /v1/projects/{projectsId}/keys/{keysId}/metrics: parameters: *ref_1 get: @@ -2618,21 +2651,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:addIpOverride: + /v1/projects/{projectsId}/keys/{keysId}:listIpOverrides: parameters: *ref_1 - post: - description: >- - Adds an IP override to a key. The following restrictions hold: * The - maximum number of IP overrides per key is 100. * For any conflict (such - as IP already exists or IP part of an existing IP range), an error is - returned. - operationId: recaptchaenterprise.projects.keys.addIpOverride - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest + get: + description: Lists all IP overrides for a key. + operationId: recaptchaenterprise.projects.keys.listIpOverrides security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2645,7 +2668,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse parameters: - in: path name: projectsId @@ -2657,22 +2680,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:migrate: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/keys/{keysId}:removeIpOverride: parameters: *ref_1 post: description: >- - Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a - key is migrated, it can be used from either product. SiteVerify requests - are billed as CreateAssessment calls. You must be authenticated as one - of the current owners of the reCAPTCHA Key, and your user must have the - reCAPTCHA Enterprise Admin IAM role in the destination project. - operationId: recaptchaenterprise.projects.keys.migrate + Removes an IP override from a key. The following restrictions hold: * If + the IP isn't found in an existing IP override, a `NOT_FOUND` error is + returned. * If the IP is found in an existing IP override, but the + override type does not match, a `NOT_FOUND` error is returned. + operationId: recaptchaenterprise.projects.keys.removeIpOverride requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2684,7 +2715,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse parameters: - in: path name: projectsId @@ -2696,21 +2728,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:removeIpOverride: + /v1/projects/{projectsId}/keys/{keysId}:migrate: parameters: *ref_1 post: description: >- - Removes an IP override from a key. The following restrictions hold: * If - the IP isn't found in an existing IP override, a `NOT_FOUND` error is - returned. * If the IP is found in an existing IP override, but the - override type does not match, a `NOT_FOUND` error is returned. - operationId: recaptchaenterprise.projects.keys.removeIpOverride + Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a + key is migrated, it can be used from either product. SiteVerify requests + are billed as CreateAssessment calls. You must be authenticated as one + of the current owners of the reCAPTCHA Key, and your user must have the + reCAPTCHA Enterprise Admin IAM role in the destination project. + operationId: recaptchaenterprise.projects.keys.migrate requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2722,8 +2755,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId @@ -2735,11 +2767,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}: + /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: parameters: *ref_1 - delete: - description: Deletes the specified key. - operationId: recaptchaenterprise.projects.keys.delete + post: + description: Search group memberships related to a given account. + operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2751,21 +2789,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - get: - description: Returns the specified key. - operationId: recaptchaenterprise.projects.keys.get + /v1/projects/{projectsId}/assessments/{assessmentsId}:annotate: + parameters: *ref_1 + post: + description: >- + Annotates a previously created Assessment to provide additional + information on whether the event turned out to be authentic or + fraudulent. + operationId: recaptchaenterprise.projects.assessments.annotate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2777,7 +2822,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse parameters: - in: path name: projectsId @@ -2785,18 +2831,20 @@ paths: schema: type: string - in: path - name: keysId + name: assessmentsId required: true schema: type: string - patch: - description: Updates the specified key. - operationId: recaptchaenterprise.projects.keys.patch + /v1/projects/{projectsId}/assessments: + parameters: *ref_1 + post: + description: Creates an Assessment of the likelihood an event is legitimate. + operationId: recaptchaenterprise.projects.assessments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2808,28 +2856,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/keys/{keysId}:listIpOverrides: + /v1/projects/{projectsId}/firewallpolicies: parameters: *ref_1 - get: - description: Lists all IP overrides for a key. - operationId: recaptchaenterprise.projects.keys.listIpOverrides + post: + description: >- + Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA + Enterprise actions can be executed. A project may have a maximum of 1000 + policies. + operationId: recaptchaenterprise.projects.firewallpolicies.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2842,32 +2890,16 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/keys: - parameters: *ref_1 get: - description: Returns the list of all keys that belong to a project. - operationId: recaptchaenterprise.projects.keys.list + description: Returns the list of all firewall policies that belong to a project. + operationId: recaptchaenterprise.projects.firewallpolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2880,7 +2912,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse parameters: - in: path name: projectsId @@ -2896,14 +2928,17 @@ paths: name: pageToken schema: type: string - post: - description: Creates a new reCAPTCHA Enterprise key. - operationId: recaptchaenterprise.projects.keys.create + /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: + parameters: *ref_1 + patch: + description: Updates the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2915,21 +2950,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: - parameters: *ref_1 + - in: path + name: firewallpoliciesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: >- - Returns the secret key related to the specified public key. You must use - the legacy secret key only in a 3rd party integration with legacy - reCAPTCHA. - operationId: recaptchaenterprise.projects.keys.retrieveLegacySecretKey + description: Returns the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2942,7 +2983,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId @@ -2950,24 +2991,13 @@ paths: schema: type: string - in: path - name: keysId + name: firewallpoliciesId required: true schema: type: string - /v1/projects/{projectsId}/assessments/{assessmentsId}:annotate: - parameters: *ref_1 - post: - description: >- - Annotates a previously created Assessment to provide additional - information on whether the event turned out to be authentic or - fraudulent. - operationId: recaptchaenterprise.projects.assessments.annotate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest + delete: + description: Deletes the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2979,8 +3009,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -2988,20 +3017,21 @@ paths: schema: type: string - in: path - name: assessmentsId + name: firewallpoliciesId required: true schema: type: string - /v1/projects/{projectsId}/assessments: + /v1/projects/{projectsId}/firewallpolicies:reorder: parameters: *ref_1 post: - description: Creates an Assessment of the likelihood an event is legitimate. - operationId: recaptchaenterprise.projects.assessments.create + description: Reorders all firewall policies. + operationId: recaptchaenterprise.projects.firewallpolicies.reorder requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3014,18 +3044,18 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships: + /v1/projects/{projectsId}/relatedaccountgroups: parameters: *ref_1 get: - description: Get memberships in a group of related accounts. - operationId: recaptchaenterprise.projects.relatedaccountgroups.memberships.list + description: List groups of related accounts. + operationId: recaptchaenterprise.projects.relatedaccountgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3038,16 +3068,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: relatedaccountgroupsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -3055,15 +3084,11 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/relatedaccountgroups: + /v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships: parameters: *ref_1 get: - description: List groups of related accounts. - operationId: recaptchaenterprise.projects.relatedaccountgroups.list + description: Get memberships in a group of related accounts. + operationId: recaptchaenterprise.projects.relatedaccountgroups.memberships.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3076,15 +3101,16 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: relatedaccountgroupsId + required: true schema: type: string - in: query @@ -3092,33 +3118,7 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: - parameters: *ref_1 - post: - description: Search group memberships related to a given account. - operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse - parameters: - - in: path - name: projectsId - required: true + - in: query + name: pageToken schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml index 7c5f553d..873c0799 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml @@ -15,7 +15,7 @@ info: expertise in machine learning, recommendation system, or Google Cloud. version: v1beta1 x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/recommendations-ai/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml b/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml index 93624106..b511b6ef 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/recommender/docs/ servers: @@ -34,370 +34,182 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecommenderV1ReliabilityProjection: + GoogleCloudRecommenderV1OperationGroup: + id: GoogleCloudRecommenderV1OperationGroup + type: object + description: Group of operations that need to be performed atomically. properties: - risks: - type: array + operations: + description: >- + List of operations across one or more resources that belong to this + group. Loosely based on RFC6902 and should be performed in the order + they appear. items: - enum: - - RISK_TYPE_UNSPECIFIED - - SERVICE_DISRUPTION - - DATA_LOSS - - ACCESS_DENY - type: string - enumDescriptions: - - Default unspecified risk. Don't use directly. - - Potential service downtime. - - Potential data loss. - - >- - Potential access denial. The service is still up but some or all - clients can't access it. - description: Reliability risks mitigated by this recommendation. - details: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: Per-recommender projection. - description: Contains information on the impact of a reliability recommendation. - type: object - id: GoogleCloudRecommenderV1ReliabilityProjection + $ref: '#/components/schemas/GoogleCloudRecommenderV1Operation' + type: array GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: description: Request for the `MarkRecommendationSucceeded` Method. + type: object properties: etag: + type: string description: >- Required. Fingerprint of the Recommendation. Provides optimistic locking. - type: string stateMetadata: + type: object additionalProperties: type: string description: >- State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. - type: object id: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + GoogleTypeMoney: + description: Represents an amount of money with its currency type. type: object - GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: - description: Request for the `MarkRecommendationClaimed` Method. - type: object + id: GoogleTypeMoney properties: - stateMetadata: - type: object - description: >- - State properties to include with this state. Overwrites any existing - `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. - Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. - additionalProperties: - type: string - etag: + units: + type: string description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + format: int64 + currencyCode: + description: The three-letter currency code defined in ISO 4217. type: string - id: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest - GoogleCloudRecommenderV1InsightTypeGenerationConfig: - description: >- - A configuration to customize the generation of insights. Eg, customizing - the lookback period considered when generating a insight. - type: object - id: GoogleCloudRecommenderV1InsightTypeGenerationConfig - properties: - params: - additionalProperties: - description: Properties of the object. - type: any - type: object + nanos: description: >- - Parameters for this InsightTypeGenerationConfig. These configs can - be used by or are applied to all subtypes. - GoogleCloudRecommenderV1SecurityProjection: + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + format: int32 + type: integer + GoogleCloudRecommenderV1ReliabilityProjection: properties: details: - description: >- - Additional security impact details that is provided by the - recommender. - type: object additionalProperties: description: Properties of the object. type: any - type: object - id: GoogleCloudRecommenderV1SecurityProjection - description: Contains various ways of describing the impact on Security. - GoogleCloudRecommenderV1InsightStateInfo: - type: object - id: GoogleCloudRecommenderV1InsightStateInfo - properties: - state: - enumDescriptions: - - Unspecified state. - - >- - Insight is active. Content for ACTIVE insights can be updated by - Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. - - >- - Some action has been taken based on this insight. Insights become - accepted when a recommendation derived from the insight has been - marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be - marked ACCEPTED explicitly. Content for ACCEPTED insights is - immutable. ACCEPTED insights can only be marked ACCEPTED (which - may update state metadata). - - >- - Insight is dismissed. Content for DISMISSED insights can be - updated by Google. DISMISSED insights can be marked as ACTIVE. - type: string - description: Insight state. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - ACCEPTED - - DISMISSED - stateMetadata: - additionalProperties: - type: string type: object - description: >- - A map of metadata for the state, provided by user or automations - systems. - description: Information related to insight state. - GoogleCloudRecommenderV1ListInsightsResponse: - properties: - nextPageToken: - type: string - description: >- - A token that can be used to request the next page of results. This - field is empty if there are no additional results. - insights: + description: Per-recommender projection. + risks: type: array items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' - description: The set of insights for the `parent` resource. - id: GoogleCloudRecommenderV1ListInsightsResponse - type: object - description: Response to the `ListInsights` method. - GoogleCloudRecommenderV1Insight: + enum: + - RISK_TYPE_UNSPECIFIED + - SERVICE_DISRUPTION + - DATA_LOSS + - ACCESS_DENY + type: string + enumDescriptions: + - Default unspecified risk. Don't use directly. + - Potential service downtime. + - Potential data loss. + - >- + Potential access denial. The service is still up but some or all + clients can't access it. + description: Reliability risks mitigated by this recommendation. + id: GoogleCloudRecommenderV1ReliabilityProjection type: object + description: Contains information on the impact of a reliability recommendation. + GoogleCloudRecommenderV1Operation: + description: >- + Contains an operation for a resource loosely based on the JSON-PATCH + format with support for: * Custom filters for describing partial array + patch. * Extended path values for describing nested arrays. * Custom + fields for describing the resource for which the operation is being + described. * Allows extension to custom operations not natively + supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for + details on the original RFC. properties: - observationPeriod: + value: + type: any description: >- - Observation period that led to the insight. The source data used to - generate the insight ends at last_refresh_time and begins at - (last_refresh_time - observation_period). - type: string - format: google-duration - name: - type: string - description: Identifier. Name of the insight. - description: + Value for the `path` field. Will be set for actions:'add'/'replace'. + Maybe set for action: 'test'. Either this or `value_matcher` will be + set for 'test' operation. An exact match must be performed. + sourceResource: type: string description: >- - Free-form human readable summary in English. The maximum length is - 500 characters. - targetResources: - description: Fully qualified resource names that this insight is targeting. - type: array - items: - type: string - etag: - type: string + Can be set with action 'copy' to copy resource configuration across + different resources of the same type. Example: A resource clone can + be done via action = 'copy', path = "/", from = "/", source_resource + = and resource_name = . This field is empty for all other values of + `action`. + resource: description: >- - Fingerprint of the Insight. Provides optimistic locking when - updating states. - lastRefreshTime: - format: google-datetime - description: Timestamp of the latest data used to generate the insight. - type: string - stateInfo: - description: Information state and metadata. - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' - insightSubtype: + Contains the fully qualified resource name. This field is always + populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. type: string + valueMatcher: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' description: >- - Insight subtype. Insight content schema will be stable for a given - subtype. - content: + Can be set for action 'test' for advanced matching for the value of + 'path' field. Either this or `value` will be set for 'test' + operation. + resourceType: description: >- - A struct of custom fields to explain the insight. Example: - "grantedPermissionsCount": "1000" + Type of GCP resource being modified/tested. This field is always + populated. Example: cloudresourcemanager.googleapis.com/Project, + compute.googleapis.com/Instance + type: string + pathValueMatchers: type: object + description: >- + Similar to path_filters, this contains set of filters to apply if + `path` field refers to array elements. This is meant to support + value matching beyond exact match. To perform exact match, use + path_filters. When both path_filters and path_value_matchers are + set, an implicit AND must be performed. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' + pathFilters: + description: >- + Set of filters to apply if `path` refers to array elements or nested + array elements in order to narrow down to a single unique element + that is being tested/modified. This is intended to be an exact match + per filter. To perform advanced matching, use path_value_matchers. * + Example: ``` { "/versions/*/name" : "it-123" + "/versions/*/targetSize/percent": 20 } ``` * Example: ``` { + "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } + ``` * Example: ``` { "/bindings/*/role": "roles/owner" + "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ``` + When both path_filters and path_value_matchers are set, an implicit + AND must be performed. additionalProperties: - description: Properties of the object. type: any - category: - description: Category being targeted by the insight. - enumDescriptions: - - Unspecified category. - - The insight is related to cost. - - The insight is related to security. - - The insight is related to performance. - - This insight is related to manageability. - - The insight is related to sustainability. - - This insight is related to reliability. - enum: - - CATEGORY_UNSPECIFIED - - COST - - SECURITY - - PERFORMANCE - - MANAGEABILITY - - SUSTAINABILITY - - RELIABILITY - type: string - associatedRecommendations: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1InsightRecommendationReference - description: Recommendations derived from this insight. - severity: - enum: - - SEVERITY_UNSPECIFIED - - LOW - - MEDIUM - - HIGH - - CRITICAL - type: string - enumDescriptions: - - Insight has unspecified severity. - - Insight has low severity. - - Insight has medium severity. - - Insight has high severity. - - Insight has critical severity. - description: Insight's severity. - description: >- - An insight along with the information used to derive the insight. The - insight may have associated recommendations as well. - id: GoogleCloudRecommenderV1Insight - GoogleCloudRecommenderV1Impact: - type: object - description: Contains the impact a recommendation can have for a given category. - properties: - securityProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' - description: Use with CategoryType.SECURITY - reliabilityProjection: - description: Use with CategoryType.RELIABILITY - $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' - costProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' - description: Use with CategoryType.COST - category: - type: string - enumDescriptions: - - Default unspecified category. Don't use directly. - - Indicates a potential increase or decrease in cost. - - Indicates a potential increase or decrease in security. - - Indicates a potential increase or decrease in performance. - - Indicates a potential increase or decrease in manageability. - - Indicates a potential increase or decrease in sustainability. - - Indicates a potential increase or decrease in reliability. - description: Category that is being targeted. - enum: - - CATEGORY_UNSPECIFIED - - COST - - SECURITY - - PERFORMANCE - - MANAGEABILITY - - SUSTAINABILITY - - RELIABILITY - sustainabilityProjection: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection - description: Use with CategoryType.SUSTAINABILITY - id: GoogleCloudRecommenderV1Impact - GoogleTypeMoney: - properties: - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - units: + type: object + action: type: string description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - format: int64 - nanos: - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - description: Represents an amount of money with its currency type. - type: object - id: GoogleTypeMoney - GoogleCloudRecommenderV1CostProjection: - id: GoogleCloudRecommenderV1CostProjection - type: object - properties: - costInLocalCurrency: - description: >- - The approximate cost savings in the billing account's local - currency. - $ref: '#/components/schemas/GoogleTypeMoney' - cost: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - An approximate projection on amount saved or amount incurred. - Negative cost units indicate cost savings and positive cost units - indicate increase. See google.type.Money documentation for - positive/negative units. A user's permissions may affect whether the - cost is computed using list prices or custom contract prices. - duration: + Type of this operation. Contains one of 'add', 'remove', 'replace', + 'move', 'copy', 'test' and custom operations. This field is + case-insensitive and always populated. + sourcePath: type: string - description: Duration for which this cost applies. - format: google-duration - description: >- - Contains metadata about how much money a recommendation can save or - incur. - GoogleCloudRecommenderV1ListRecommendationsResponse: - id: GoogleCloudRecommenderV1ListRecommendationsResponse - description: Response to the `ListRecommendations` method. - properties: - nextPageToken: description: >- - A token that can be used to request the next page of results. This - field is empty if there are no additional results. + Can be set with action 'copy' or 'move' to indicate the source field + within resource or source_resource, ignored if provided for other + operation types. + path: type: string - recommendations: - description: The set of recommendations for the `parent` resource. - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' - type: object - GoogleCloudRecommenderV1MarkRecommendationFailedRequest: - description: Request for the `MarkRecommendationFailed` Method. - id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest - properties: - stateMetadata: - description: >- - State properties to include with this state. Overwrites any existing - `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. - Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. - type: object - additionalProperties: - type: string - etag: description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. - type: string + Path to the target field being operated on. If the operation is at + the resource level, then path should be "/". This field is always + populated. type: object + id: GoogleCloudRecommenderV1Operation GoogleCloudRecommenderV1InsightTypeConfig: + type: object + id: GoogleCloudRecommenderV1InsightTypeConfig properties: - name: - description: >- - Identifier. Name of insight type config. Eg, - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config - type: string - updateTime: - format: google-datetime - type: string - description: Last time when the config was updated. annotations: + type: object additionalProperties: type: string description: >- @@ -408,138 +220,141 @@ components: must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. - type: object + updateTime: + description: Last time when the config was updated. + format: google-datetime + type: string etag: type: string description: >- Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating. - displayName: + name: type: string description: >- - A user-settable field to provide a human-readable name to be used in - user interfaces. + Identifier. Name of insight type config. Eg, + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config revisionId: + type: string + readOnly: true description: >- Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string. - readOnly: true - type: string insightTypeGenerationConfig: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig description: >- InsightTypeGenerationConfig which configures the generation of insights for this insight type. - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig - id: GoogleCloudRecommenderV1InsightTypeConfig - description: Configuration for an InsightType. - type: object - GoogleCloudRecommenderV1ValueMatcher: - type: object - id: GoogleCloudRecommenderV1ValueMatcher - properties: - matchesPattern: + displayName: type: string description: >- - To be used for full regex matching. The regular expression is using - the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), - so to be used with RE2::FullMatch - description: Contains various matching options for values for a GCP resource field. + A user-settable field to provide a human-readable name to be used in + user interfaces. + description: Configuration for an InsightType. GoogleCloudRecommenderV1MarkInsightAcceptedRequest: - type: object description: Request for the `MarkInsightAccepted` method. + id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest + type: object properties: - etag: - description: Required. Fingerprint of the Insight. Provides optimistic locking. - type: string stateMetadata: + type: object additionalProperties: type: string description: >- Optional. State properties user wish to include with this state. Full replace of the current state_metadata. - type: object - id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest - GoogleCloudRecommenderV1RecommenderConfig: + etag: + type: string + description: Required. Fingerprint of the Insight. Provides optimistic locking. + GoogleCloudRecommenderV1RecommendationStateInfo: + id: GoogleCloudRecommenderV1RecommendationStateInfo + description: Information for state. Contains state and metadata. type: object - description: Configuration for a Recommender. properties: - revisionId: - type: string - description: >- - Output only. Immutable. The revision ID of the config. A new - revision is committed whenever the config is changed in any way. The - format is an 8-character hexadecimal string. - readOnly: true - name: - description: >- - Identifier. Name of recommender config. Eg, - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config - type: string - annotations: - description: >- - Allows clients to store small amounts of arbitrary data. Annotations - must follow the Kubernetes syntax. The total size of all keys and - values combined is limited to 256k. Key can have 2 segments: prefix - (optional) and name (required), separated by a slash (/). Prefix - must be a DNS subdomain. Name must be 63 characters or less, begin - and end with alphanumerics, with dashes (-), underscores (_), dots - (.), and alphanumerics between. - type: object + stateMetadata: additionalProperties: type: string - recommenderGenerationConfig: + type: object description: >- - RecommenderGenerationConfig which configures the Generation of - recommendations for this recommender. - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig - updateTime: - format: google-datetime - description: Last time when the config was updated. + A map of metadata for the state, provided by user or automations + systems. + state: type: string - displayName: + enumDescriptions: + - Default state. Don't use directly. + - >- + Recommendation is active and can be applied. Recommendations + content can be updated by Google. ACTIVE recommendations can be + marked as CLAIMED, SUCCEEDED, or FAILED. + - >- + Recommendation is in claimed state. Recommendations content is + immutable and cannot be updated by Google. CLAIMED recommendations + can be marked as CLAIMED, SUCCEEDED, or FAILED. + - >- + Recommendation is in succeeded state. Recommendations content is + immutable and cannot be updated by Google. SUCCEEDED + recommendations can be marked as SUCCEEDED, or FAILED. + - >- + Recommendation is in failed state. Recommendations content is + immutable and cannot be updated by Google. FAILED recommendations + can be marked as SUCCEEDED, or FAILED. + - >- + Recommendation is in dismissed state. Recommendation content can + be updated by Google. DISMISSED recommendations can be marked as + ACTIVE. + description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CLAIMED + - SUCCEEDED + - FAILED + - DISMISSED + GoogleCloudRecommenderV1RecommendationContent: + id: GoogleCloudRecommenderV1RecommendationContent + description: Contains what resources are changing and how they are changing. + type: object + properties: + overview: + description: Condensed overview information about the recommendation. + additionalProperties: + description: Properties of the object. + type: any + type: object + operationGroups: description: >- - A user-settable field to provide a human-readable name to be used in - user interfaces. + Operations to one or more Google Cloud resources grouped in such a + way that, all operations within one group are expected to be + performed atomically and in an order. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' + GoogleCloudRecommenderV1ListInsightsResponse: + type: object + id: GoogleCloudRecommenderV1ListInsightsResponse + properties: + insights: + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + description: The set of insights for the `parent` resource. + nextPageToken: type: string - etag: description: >- - Fingerprint of the RecommenderConfig. Provides optimistic locking - when updating. - type: string - id: GoogleCloudRecommenderV1RecommenderConfig + A token that can be used to request the next page of results. This + field is empty if there are no additional results. + description: Response to the `ListInsights` method. GoogleCloudRecommenderV1RecommendationInsightReference: - type: object + id: GoogleCloudRecommenderV1RecommendationInsightReference + description: Reference to an associated insight. properties: insight: - type: string description: >- Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] - description: Reference to an associated insight. - id: GoogleCloudRecommenderV1RecommendationInsightReference - GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: - id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest - type: object - properties: - etag: - description: Fingerprint of the Recommendation. Provides optimistic locking. type: string - description: Request for the `MarkRecommendationDismissed` Method. - GoogleCloudRecommenderV1OperationGroup: - description: Group of operations that need to be performed atomically. - properties: - operations: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Operation' - description: >- - List of operations across one or more resources that belong to this - group. Loosely based on RFC6902 and should be performed in the order - they appear. - type: array - id: GoogleCloudRecommenderV1OperationGroup type: object GoogleCloudRecommenderV1InsightRecommendationReference: description: Reference to an associated recommendation. @@ -547,122 +362,267 @@ components: type: object properties: recommendation: + type: string description: >- Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + GoogleCloudRecommenderV1InsightStateInfo: + properties: + stateMetadata: + description: >- + A map of metadata for the state, provided by user or automations + systems. + additionalProperties: + type: string + type: object + state: + enum: + - STATE_UNSPECIFIED + - ACTIVE + - ACCEPTED + - DISMISSED type: string - GoogleCloudRecommenderV1Recommendation: + enumDescriptions: + - Unspecified state. + - >- + Insight is active. Content for ACTIVE insights can be updated by + Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. + - >- + Some action has been taken based on this insight. Insights become + accepted when a recommendation derived from the insight has been + marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be + marked ACCEPTED explicitly. Content for ACCEPTED insights is + immutable. ACCEPTED insights can only be marked ACCEPTED (which + may update state metadata). + - >- + Insight is dismissed. Content for DISMISSED insights can be + updated by Google. DISMISSED insights can be marked as ACTIVE. + description: Insight state. + id: GoogleCloudRecommenderV1InsightStateInfo + description: Information related to insight state. + type: object + GoogleCloudRecommenderV1SecurityProjection: + id: GoogleCloudRecommenderV1SecurityProjection type: object - description: >- - A recommendation along with a suggested action. E.g., a rightsizing - recommendation for an underutilized VM, IAM role recommendations, etc - id: GoogleCloudRecommenderV1Recommendation properties: - associatedInsights: - description: Insights that led to this recommendation. - items: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference - type: array - description: + details: description: >- - Free-form human readable summary in English. The maximum length is - 500 characters. + Additional security impact details that is provided by the + recommender. + type: object + additionalProperties: + type: any + description: Properties of the object. + description: Contains various ways of describing the impact on Security. + GoogleCloudRecommenderV1ValueMatcher: + id: GoogleCloudRecommenderV1ValueMatcher + description: Contains various matching options for values for a GCP resource field. + type: object + properties: + matchesPattern: type: string - content: - description: >- - Content of the recommendation describing recommended changes to - resources. - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' - additionalImpact: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' - type: array description: >- - Optional set of additional impact that this recommendation may have - when trying to optimize for the primary category. These may be - positive or negative. + To be used for full regex matching. The regular expression is using + the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), + so to be used with RE2::FullMatch + GoogleCloudRecommenderV1RecommenderConfig: + id: GoogleCloudRecommenderV1RecommenderConfig + type: object + properties: name: - description: Identifier. Name of recommendation. type: string - primaryImpact: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' description: >- - The primary impact that this recommendation can have while trying to - optimize for one category. + Identifier. Name of recommender config. Eg, + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config + recommenderGenerationConfig: + description: >- + RecommenderGenerationConfig which configures the Generation of + recommendations for this recommender. + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig etag: description: >- - Fingerprint of the Recommendation. Provides optimistic locking when - updating states. + Fingerprint of the RecommenderConfig. Provides optimistic locking + when updating. type: string - recommenderSubtype: + updateTime: + description: Last time when the config was updated. + format: google-datetime + type: string + displayName: description: >- - Contains an identifier for a subtype of recommendations produced for - the same recommender. Subtype is a function of content and impact, - meaning a new subtype might be added when significant changes to - `content` or `primary_impact.category` are introduced. See the - Recommenders section to see a list of subtypes for a given - Recommender. Examples: For recommender = - "google.iam.policy.Recommender", recommender_subtype can be one of - "REMOVE_ROLE"/"REPLACE_ROLE" + A user-settable field to provide a human-readable name to be used in + user interfaces. type: string - targetResources: - items: + revisionId: + description: >- + Output only. Immutable. The revision ID of the config. A new + revision is committed whenever the config is changed in any way. The + format is an 8-character hexadecimal string. + type: string + readOnly: true + annotations: + type: object + additionalProperties: type: string description: >- - Fully qualified resource names that this recommendation is - targeting. - type: array - xorGroupId: + Allows clients to store small amounts of arbitrary data. Annotations + must follow the Kubernetes syntax. The total size of all keys and + values combined is limited to 256k. Key can have 2 segments: prefix + (optional) and name (required), separated by a slash (/). Prefix + must be a DNS subdomain. Name must be 63 characters or less, begin + and end with alphanumerics, with dashes (-), underscores (_), dots + (.), and alphanumerics between. + description: Configuration for a Recommender. + GoogleCloudRecommenderV1CostProjection: + type: object + description: >- + Contains metadata about how much money a recommendation can save or + incur. + properties: + duration: + format: google-duration type: string + description: Duration for which this cost applies. + costInLocalCurrency: description: >- - Corresponds to a mutually exclusive group ID within a recommender. A - non-empty ID indicates that the recommendation belongs to a mutually - exclusive group. This means that only one recommendation within the - group is suggested to be applied. - priority: - description: Recommendation's priority. - enum: - - PRIORITY_UNSPECIFIED - - P4 - - P3 - - P2 - - P1 - enumDescriptions: - - Recommendation has unspecified priority. - - Recommendation has P4 priority (lowest priority). - - Recommendation has P3 priority (second lowest priority). - - Recommendation has P2 priority (second highest priority). - - Recommendation has P1 priority (highest priority). - type: string - lastRefreshTime: + The approximate cost savings in the billing account's local + currency. + $ref: '#/components/schemas/GoogleTypeMoney' + cost: description: >- - Last time this recommendation was refreshed by the system that - created it in the first place. - format: google-datetime + An approximate projection on amount saved or amount incurred. + Negative cost units indicate cost savings and positive cost units + indicate increase. See google.type.Money documentation for + positive/negative units. A user's permissions may affect whether the + cost is computed using list prices or custom contract prices. + $ref: '#/components/schemas/GoogleTypeMoney' + id: GoogleCloudRecommenderV1CostProjection + GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: + properties: + etag: + description: >- + Required. Fingerprint of the Recommendation. Provides optimistic + locking. type: string - stateInfo: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' - description: Information for state. Contains state and metadata. - GoogleCloudRecommenderV1RecommendationContent: + stateMetadata: + type: object + description: >- + State properties to include with this state. Overwrites any existing + `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + additionalProperties: + type: string + description: Request for the `MarkRecommendationClaimed` Method. + id: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest type: object - id: GoogleCloudRecommenderV1RecommendationContent - description: Contains what resources are changing and how they are changing. + GoogleCloudRecommenderV1InsightTypeGenerationConfig: + description: >- + A configuration to customize the generation of insights. Eg, customizing + the lookback period considered when generating a insight. + type: object + id: GoogleCloudRecommenderV1InsightTypeGenerationConfig properties: - operationGroups: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' - type: array + params: description: >- - Operations to one or more Google Cloud resources grouped in such a - way that, all operations within one group are expected to be - performed atomically and in an order. - overview: + Parameters for this InsightTypeGenerationConfig. These configs can + be used by or are applied to all subtypes. + additionalProperties: + description: Properties of the object. + type: any type: object + GoogleCloudRecommenderV1Insight: + type: object + description: >- + An insight along with the information used to derive the insight. The + insight may have associated recommendations as well. + properties: + insightSubtype: + description: >- + Insight subtype. Insight content schema will be stable for a given + subtype. + type: string + stateInfo: + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' + description: Information state and metadata. + content: additionalProperties: description: Properties of the object. type: any - description: Condensed overview information about the recommendation. + description: >- + A struct of custom fields to explain the insight. Example: + "grantedPermissionsCount": "1000" + type: object + observationPeriod: + description: >- + Observation period that led to the insight. The source data used to + generate the insight ends at last_refresh_time and begins at + (last_refresh_time - observation_period). + format: google-duration + type: string + etag: + type: string + description: >- + Fingerprint of the Insight. Provides optimistic locking when + updating states. + severity: + type: string + description: Insight's severity. + enumDescriptions: + - Insight has unspecified severity. + - Insight has low severity. + - Insight has medium severity. + - Insight has high severity. + - Insight has critical severity. + enum: + - SEVERITY_UNSPECIFIED + - LOW + - MEDIUM + - HIGH + - CRITICAL + lastRefreshTime: + type: string + format: google-datetime + description: Timestamp of the latest data used to generate the insight. + category: + type: string + enumDescriptions: + - Unspecified category. + - The insight is related to cost. + - The insight is related to security. + - The insight is related to performance. + - This insight is related to manageability. + - The insight is related to sustainability. + - This insight is related to reliability. + description: Category being targeted by the insight. + enum: + - CATEGORY_UNSPECIFIED + - COST + - SECURITY + - PERFORMANCE + - MANAGEABILITY + - SUSTAINABILITY + - RELIABILITY + description: + type: string + description: >- + Free-form human readable summary in English. The maximum length is + 500 characters. + associatedRecommendations: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1InsightRecommendationReference + description: Recommendations derived from this insight. + name: + type: string + description: Identifier. Name of the insight. + targetResources: + items: + type: string + description: Fully qualified resource names that this insight is targeting. + type: array + id: GoogleCloudRecommenderV1Insight GoogleCloudRecommenderV1RecommenderGenerationConfig: description: >- A Configuration to customize the generation of recommendations. Eg, @@ -670,186 +630,226 @@ components: recommendation. properties: params: - additionalProperties: - type: any - description: Properties of the object. description: >- Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes. + additionalProperties: + description: Properties of the object. + type: any type: object - id: GoogleCloudRecommenderV1RecommenderGenerationConfig type: object - GoogleCloudRecommenderV1SustainabilityProjection: - id: GoogleCloudRecommenderV1SustainabilityProjection - description: >- - Contains metadata about how much sustainability a recommendation can - save or incur. - properties: - duration: - type: string - description: Duration for which this sustainability applies. - format: google-duration - kgCO2e: - format: double - type: number - description: >- - Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e - so that the name renders correctly in camelCase (kgCO2e). - type: object - GoogleCloudRecommenderV1Operation: - id: GoogleCloudRecommenderV1Operation + id: GoogleCloudRecommenderV1RecommenderGenerationConfig + GoogleCloudRecommenderV1Recommendation: description: >- - Contains an operation for a resource loosely based on the JSON-PATCH - format with support for: * Custom filters for describing partial array - patch. * Extended path values for describing nested arrays. * Custom - fields for describing the resource for which the operation is being - described. * Allows extension to custom operations not natively - supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for - details on the original RFC. + A recommendation along with a suggested action. E.g., a rightsizing + recommendation for an underutilized VM, IAM role recommendations, etc + id: GoogleCloudRecommenderV1Recommendation type: object properties: - resource: + content: + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' + description: >- + Content of the recommendation describing recommended changes to + resources. + description: + description: >- + Free-form human readable summary in English. The maximum length is + 500 characters. type: string + xorGroupId: description: >- - Contains the fully qualified resource name. This field is always - populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. - path: + Corresponds to a mutually exclusive group ID within a recommender. A + non-empty ID indicates that the recommendation belongs to a mutually + exclusive group. This means that only one recommendation within the + group is suggested to be applied. + type: string + associatedInsights: + items: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference + description: Insights that led to this recommendation. + type: array + lastRefreshTime: type: string description: >- - Path to the target field being operated on. If the operation is at - the resource level, then path should be "/". This field is always - populated. - pathFilters: - type: object + Last time this recommendation was refreshed by the system that + created it in the first place. + format: google-datetime + etag: description: >- - Set of filters to apply if `path` refers to array elements or nested - array elements in order to narrow down to a single unique element - that is being tested/modified. This is intended to be an exact match - per filter. To perform advanced matching, use path_value_matchers. * - Example: ``` { "/versions/*/name" : "it-123" - "/versions/*/targetSize/percent": 20 } ``` * Example: ``` { - "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } - ``` * Example: ``` { "/bindings/*/role": "roles/owner" - "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ``` - When both path_filters and path_value_matchers are set, an implicit - AND must be performed. - additionalProperties: - type: any - action: + Fingerprint of the Recommendation. Provides optimistic locking when + updating states. + type: string + priority: + enumDescriptions: + - Recommendation has unspecified priority. + - Recommendation has P4 priority (lowest priority). + - Recommendation has P3 priority (second lowest priority). + - Recommendation has P2 priority (second highest priority). + - Recommendation has P1 priority (highest priority). + enum: + - PRIORITY_UNSPECIFIED + - P4 + - P3 + - P2 + - P1 type: string + description: Recommendation's priority. + additionalImpact: + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' + type: array description: >- - Type of this operation. Contains one of 'add', 'remove', 'replace', - 'move', 'copy', 'test' and custom operations. This field is - case-insensitive and always populated. - sourceResource: + Optional set of additional impact that this recommendation may have + when trying to optimize for the primary category. These may be + positive or negative. + stateInfo: + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' + description: Information for state. Contains state and metadata. + targetResources: + items: + type: string + type: array description: >- - Can be set with action 'copy' to copy resource configuration across - different resources of the same type. Example: A resource clone can - be done via action = 'copy', path = "/", from = "/", source_resource - = and resource_name = . This field is empty for all other values of - `action`. + Fully qualified resource names that this recommendation is + targeting. + name: + description: Identifier. Name of recommendation. type: string - value: - type: any - description: >- - Value for the `path` field. Will be set for actions:'add'/'replace'. - Maybe set for action: 'test'. Either this or `value_matcher` will be - set for 'test' operation. An exact match must be performed. - sourcePath: + primaryImpact: description: >- - Can be set with action 'copy' or 'move' to indicate the source field - within resource or source_resource, ignored if provided for other - operation types. + The primary impact that this recommendation can have while trying to + optimize for one category. + $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' + recommenderSubtype: type: string - valueMatcher: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' description: >- - Can be set for action 'test' for advanced matching for the value of - 'path' field. Either this or `value` will be set for 'test' - operation. - resourceType: + Contains an identifier for a subtype of recommendations produced for + the same recommender. Subtype is a function of content and impact, + meaning a new subtype might be added when significant changes to + `content` or `primary_impact.category` are introduced. See the + Recommenders section to see a list of subtypes for a given + Recommender. Examples: For recommender = + "google.iam.policy.Recommender", recommender_subtype can be one of + "REMOVE_ROLE"/"REPLACE_ROLE" + GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: + type: object + id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + description: Request for the `MarkRecommendationDismissed` Method. + properties: + etag: + type: string + description: Fingerprint of the Recommendation. Provides optimistic locking. + GoogleCloudRecommenderV1Impact: + id: GoogleCloudRecommenderV1Impact + description: Contains the impact a recommendation can have for a given category. + type: object + properties: + reliabilityProjection: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' + description: Use with CategoryType.RELIABILITY + category: + description: Category that is being targeted. + enumDescriptions: + - Default unspecified category. Don't use directly. + - Indicates a potential increase or decrease in cost. + - Indicates a potential increase or decrease in security. + - Indicates a potential increase or decrease in performance. + - Indicates a potential increase or decrease in manageability. + - Indicates a potential increase or decrease in sustainability. + - Indicates a potential increase or decrease in reliability. type: string + enum: + - CATEGORY_UNSPECIFIED + - COST + - SECURITY + - PERFORMANCE + - MANAGEABILITY + - SUSTAINABILITY + - RELIABILITY + costProjection: + $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' + description: Use with CategoryType.COST + sustainabilityProjection: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection + description: Use with CategoryType.SUSTAINABILITY + securityProjection: + $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' + description: Use with CategoryType.SECURITY + GoogleCloudRecommenderV1ListRecommendationsResponse: + id: GoogleCloudRecommenderV1ListRecommendationsResponse + type: object + description: Response to the `ListRecommendations` method. + properties: + nextPageToken: description: >- - Type of GCP resource being modified/tested. This field is always - populated. Example: cloudresourcemanager.googleapis.com/Project, - compute.googleapis.com/Instance - pathValueMatchers: + A token that can be used to request the next page of results. This + field is empty if there are no additional results. + type: string + recommendations: + type: array + description: The set of recommendations for the `parent` resource. + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + GoogleCloudRecommenderV1SustainabilityProjection: + id: GoogleCloudRecommenderV1SustainabilityProjection + properties: + duration: + description: Duration for which this sustainability applies. + type: string + format: google-duration + kgCO2e: + type: number description: >- - Similar to path_filters, this contains set of filters to apply if - `path` field refers to array elements. This is meant to support - value matching beyond exact match. To perform exact match, use - path_filters. When both path_filters and path_value_matchers are - set, an implicit AND must be performed. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' - GoogleCloudRecommenderV1RecommendationStateInfo: - id: GoogleCloudRecommenderV1RecommendationStateInfo + Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e + so that the name renders correctly in camelCase (kgCO2e). + format: double type: object + description: >- + Contains metadata about how much sustainability a recommendation can + save or incur. + GoogleCloudRecommenderV1MarkRecommendationFailedRequest: + description: Request for the `MarkRecommendationFailed` Method. + type: object + id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest properties: - stateMetadata: - type: object - additionalProperties: - type: string - description: >- - A map of metadata for the state, provided by user or automations - systems. - state: - description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. + etag: type: string - enum: - - STATE_UNSPECIFIED - - ACTIVE - - CLAIMED - - SUCCEEDED - - FAILED - - DISMISSED - enumDescriptions: - - Default state. Don't use directly. - - >- - Recommendation is active and can be applied. Recommendations - content can be updated by Google. ACTIVE recommendations can be - marked as CLAIMED, SUCCEEDED, or FAILED. - - >- - Recommendation is in claimed state. Recommendations content is - immutable and cannot be updated by Google. CLAIMED recommendations - can be marked as CLAIMED, SUCCEEDED, or FAILED. - - >- - Recommendation is in succeeded state. Recommendations content is - immutable and cannot be updated by Google. SUCCEEDED - recommendations can be marked as SUCCEEDED, or FAILED. - - >- - Recommendation is in failed state. Recommendations content is - immutable and cannot be updated by Google. FAILED recommendations - can be marked as SUCCEEDED, or FAILED. - - >- - Recommendation is in dismissed state. Recommendation content can - be updated by Google. DISMISSED recommendations can be marked as - ACTIVE. - description: Information for state. Contains state and metadata. + description: >- + Required. Fingerprint of the Recommendation. Provides optimistic + locking. + stateMetadata: + type: object + description: >- + State properties to include with this state. Overwrites any existing + `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + additionalProperties: + type: string parameters: - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: fields + name: prettyPrint schema: - type: string - access_token: - description: OAuth access token. + type: boolean + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token schema: type: string quotaUser: @@ -861,18 +861,18 @@ components: name: quotaUser schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: prettyPrint + name: upload_protocol schema: - type: boolean + type: string _.xgafv: description: V1 error format. in: query @@ -882,6 +882,12 @@ components: enum: - '1' - '2' + callback: + description: JSONP + in: query + name: callback + schema: + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -891,12 +897,6 @@ components: name: key schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string alt: description: Data format for response. in: query @@ -913,76 +913,69 @@ components: name: insights title: Insights methods: - folders_locations_insight_types_insights_get: + organizations_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_insight_types_insights_list: + organizations_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.insights - folders_locations_insight_types_insights_mark_accepted: + organizations_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_insight_types_insights_mark_accepted: + objectKey: $.insights + billing_accounts_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_insight_types_insights_get: + billing_accounts_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_insight_types_insights_list: + billing_accounts_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.insights - billing_accounts_locations_insight_types_insights_get: - operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - billing_accounts_locations_insight_types_insights_list: + folders_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.insights - billing_accounts_locations_insight_types_insights_mark_accepted: + folders_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_insights_mark_accepted: + folders_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -1001,376 +994,383 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.insights + projects_locations_insight_types_insights_mark_accepted: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_get - $ref: >- - #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_get + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list + #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_list - $ref: >- #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_list + - $ref: >- + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list - $ref: >- #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_list insert: [] update: [] replace: [] delete: [] - recommendations: - id: google.recommender.recommendations - name: recommendations - title: Recommendations + insight_types_config: + id: google.recommender.insight_types_config + name: insight_types_config + title: Insight_types_config methods: - folders_locations_recommenders_recommendations_mark_dismissed: + organizations_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_failed: + organizations_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_get: + billing_accounts_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_list: + projects_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - folders_locations_recommenders_recommendations_mark_succeeded: + projects_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_succeeded: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_get_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_get_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_get_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_update_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_update_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_update_config + replace: [] + delete: [] + recommenders_config: + id: google.recommender.recommenders_config + name: recommenders_config + title: Recommenders_config + methods: + organizations_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_claimed: + organizations_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_dismissed: + billing_accounts_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_get: + billing_accounts_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_list: + projects_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - organizations_locations_recommenders_recommendations_mark_failed: + projects_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config + - $ref: >- + #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config + - $ref: >- + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_update_config + - $ref: >- + #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_update_config + - $ref: >- + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_update_config + replace: [] + delete: [] + recommendations: + id: google.recommender.recommendations + name: recommendations + title: Recommendations + methods: + organizations_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_dismissed: + organizations_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_failed: + organizations_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_list: + objectKey: $.recommendations + organizations_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - billing_accounts_locations_recommenders_recommendations_mark_claimed: + organizations_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_succeeded: + organizations_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_succeeded: + billing_accounts_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_failed: + objectKey: $.recommendations + billing_accounts_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_get: + billing_accounts_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_dismissed: + billing_accounts_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_list: + billing_accounts_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_list - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_list - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_list - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list - insert: [] - update: [] - replace: [] - delete: [] - insight_types_config: - id: google.recommender.insight_types_config - name: insight_types_config - title: Insight_types_config - methods: - organizations_locations_insight_types_get_config: + folders_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_insight_types_update_config: + folders_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_insight_types_update_config: + folders_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_insight_types_get_config: + folders_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_get_config: + objectKey: $.recommendations + folders_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_update_config: + folders_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_get_config - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_get_config - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_get_config - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_update_config - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_update_config - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_update_config - replace: [] - delete: [] - recommenders_config: - id: google.recommender.recommenders_config - name: recommenders_config - title: Recommenders_config - methods: - organizations_locations_recommenders_get_config: + projects_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_update_config: + projects_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_update_config: + projects_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_get_config: + projects_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_get_config: + objectKey: $.recommendations + projects_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_update_config: + projects_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config + #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config - insert: [] - update: + #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_get - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_update_config + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_get - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_update_config + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_list - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_update_config + #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list + insert: [] + update: [] replace: [] delete: [] paths: - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: &ref_1 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' get: description: >- Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. - operationId: recommender.folders.locations.insightTypes.insights.get + operationId: recommender.organizations.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1385,7 +1385,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1404,13 +1404,116 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + parameters: *ref_1 + post: + description: >- + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.organizations.locations.insightTypes.insights.markAccepted + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightTypesId + required: true + schema: + type: string + - in: path + name: insightsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_1 get: description: >- Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. - operationId: recommender.folders.locations.insightTypes.insights.list + operationId: recommender.organizations.locations.insightTypes.insights.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightTypesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + parameters: *ref_1 + patch: + description: >- + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.organizations.locations.insightTypes.updateConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1422,11 +1525,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1441,34 +1543,19 @@ paths: schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: validateOnly schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_1 - post: + type: boolean + get: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.folders.locations.insightTypes.insights.markAccepted - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.organizations.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1480,10 +1567,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1497,27 +1584,18 @@ paths: required: true schema: type: string - - in: path - name: insightsId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_1 - post: + patch: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markDismissed + Updates a Recommender Config. This will create a new revision of the + config. + operationId: recommender.organizations.locations.recommenders.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1529,10 +1607,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1546,30 +1624,20 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: updateMask schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: - parameters: *ref_1 - post: + format: google-fieldmask + get: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markFailed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.organizations.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1581,10 +1649,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1598,18 +1666,23 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 - get: + post: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.get + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markDismissed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1624,7 +1697,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1643,7 +1716,7 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 post: description: >- @@ -1654,7 +1727,8 @@ paths: state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markClaimed + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markClaimed requestBody: content: application/json: @@ -1675,7 +1749,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1694,13 +1768,13 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 get: description: >- Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.list + operationId: recommender.organizations.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1716,7 +1790,7 @@ paths: #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1731,19 +1805,19 @@ paths: schema: type: string - in: query - name: filter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_1 post: description: >- @@ -1755,7 +1829,8 @@ paths: be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markSucceeded + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: @@ -1776,7 +1851,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1795,13 +1870,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: parameters: *ref_1 get: description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.organizations.locations.insightTypes.getConfig + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.organizations.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1813,7 +1888,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: organizationsId @@ -1826,20 +1901,35 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - patch: + - in: path + name: recommendationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + parameters: *ref_1 + post: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.organizations.locations.insightTypes.updateConfig + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markFailed requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1851,7 +1941,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: organizationsId @@ -1864,20 +1954,56 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: recommendationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: validateOnly + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + parameters: *ref_1 + get: + description: >- + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.billingAccounts.locations.insightTypes.insights.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + parameters: + - in: path + name: billingAccountsId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightTypesId + required: true + schema: + type: string + - in: path + name: insightsId + required: true + schema: + type: string + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 post: description: >- @@ -1886,7 +2012,7 @@ paths: on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. - operationId: recommender.organizations.locations.insightTypes.insights.markAccepted + operationId: recommender.billingAccounts.locations.insightTypes.insights.markAccepted requestBody: content: application/json: @@ -1907,7 +2033,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -1926,13 +2052,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_1 get: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.organizations.locations.insightTypes.insights.get + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.billingAccounts.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1944,10 +2070,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -1961,18 +2088,31 @@ paths: required: true schema: type: string - - in: path - name: insightsId - required: true + - in: query + name: filter schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: *ref_1 - get: + patch: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.organizations.locations.insightTypes.insights.list + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.billingAccounts.locations.insightTypes.updateConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1984,11 +2124,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2003,38 +2142,19 @@ paths: schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: filter + name: validateOnly schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: - parameters: *ref_1 - post: + type: boolean + get: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markSucceeded - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.billingAccounts.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2046,10 +2166,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2059,34 +2179,17 @@ paths: schema: type: string - in: path - name: recommendersId - required: true - schema: - type: string - - in: path - name: recommendationsId + name: insightTypesId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 - post: + get: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markClaimed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.billingAccounts.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2098,10 +2201,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2115,28 +2219,38 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + - in: query + name: filter + schema: + type: string + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 post: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. operationId: >- - recommender.organizations.locations.recommenders.recommendations.markDismissed + recommender.billingAccounts.locations.recommenders.recommendations.markClaimed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2151,7 +2265,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2170,13 +2284,23 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 - get: + post: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.organizations.locations.recommenders.recommendations.get + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markDismissed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2191,7 +2315,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2210,13 +2334,26 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 - get: + post: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.organizations.locations.recommenders.recommendations.list + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markFailed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2228,11 +2365,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2246,39 +2382,31 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: recommendationsId + required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. operationId: >- - recommender.organizations.locations.recommenders.recommendations.markFailed + recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2293,7 +2421,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2312,13 +2440,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: parameters: *ref_1 get: description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.organizations.locations.recommenders.getConfig + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.billingAccounts.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2330,10 +2458,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2343,15 +2471,22 @@ paths: schema: type: string - in: path - name: recommendersId + name: recommendersId + required: true + schema: + type: string + - in: path + name: recommendationsId required: true schema: type: string + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + parameters: *ref_1 patch: description: >- Updates a Recommender Config. This will create a new revision of the config. - operationId: recommender.organizations.locations.recommenders.updateConfig + operationId: recommender.billingAccounts.locations.recommenders.updateConfig requestBody: content: application/json: @@ -2371,7 +2506,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -2385,22 +2520,20 @@ paths: required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - in: query name: updateMask schema: type: string format: google-fieldmask - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: - parameters: *ref_1 + - in: query + name: validateOnly + schema: + type: boolean get: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.billingAccounts.locations.insightTypes.insights.get + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.billingAccounts.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2412,7 +2545,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path name: billingAccountsId @@ -2425,22 +2558,17 @@ paths: schema: type: string - in: path - name: insightTypesId - required: true - schema: - type: string - - in: path - name: insightsId + name: recommendersId required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_1 get: description: >- Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. - operationId: recommender.billingAccounts.locations.insightTypes.insights.list + operationId: recommender.folders.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2456,7 +2584,7 @@ paths: #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2474,16 +2602,16 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 post: description: >- @@ -2492,7 +2620,7 @@ paths: on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. - operationId: recommender.billingAccounts.locations.insightTypes.insights.markAccepted + operationId: recommender.folders.locations.insightTypes.insights.markAccepted requestBody: content: application/json: @@ -2513,7 +2641,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2532,18 +2660,13 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 - patch: + get: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.billingAccounts.locations.insightTypes.updateConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.folders.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2555,10 +2678,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2572,55 +2695,18 @@ paths: required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.billingAccounts.locations.insightTypes.getConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' - parameters: - - in: path - name: billingAccountsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path - name: insightTypesId + name: insightsId required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: parameters: *ref_1 get: description: >- Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. - operationId: recommender.billingAccounts.locations.recommenders.recommendations.get + operationId: recommender.folders.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2635,7 +2721,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2654,7 +2740,7 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 post: description: >- @@ -2663,8 +2749,7 @@ paths: marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markDismissed + operationId: recommender.folders.locations.recommenders.recommendations.markDismissed requestBody: content: application/json: @@ -2685,7 +2770,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2704,7 +2789,7 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 post: description: >- @@ -2716,8 +2801,7 @@ paths: applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markFailed + operationId: recommender.folders.locations.recommenders.recommendations.markFailed requestBody: content: application/json: @@ -2738,7 +2822,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2757,13 +2841,13 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 get: description: >- Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. - operationId: recommender.billingAccounts.locations.recommenders.recommendations.list + operationId: recommender.folders.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2779,7 +2863,7 @@ paths: #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2806,7 +2890,7 @@ paths: schema: type: integer format: int32 - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 post: description: >- @@ -2817,8 +2901,7 @@ paths: state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markClaimed + operationId: recommender.folders.locations.recommenders.recommendations.markClaimed requestBody: content: application/json: @@ -2839,7 +2922,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2858,7 +2941,7 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_1 post: description: >- @@ -2870,8 +2953,7 @@ paths: be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded + operationId: recommender.folders.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: @@ -2892,7 +2974,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2911,18 +2993,13 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 - patch: + get: description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.billingAccounts.locations.recommenders.updateConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.projects.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2934,10 +3011,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: billingAccountsId + name: projectsId required: true schema: type: string @@ -2947,24 +3024,22 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: updateMask + - in: path + name: insightsId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + parameters: *ref_1 get: description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.billingAccounts.locations.recommenders.getConfig + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.projects.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2976,10 +3051,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: billingAccountsId + name: projectsId required: true schema: type: string @@ -2989,30 +3065,39 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.projects.locations.recommenders.recommendations.markSucceeded + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.projects.locations.insightTypes.insights.markAccepted requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3024,7 +3109,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: projectsId @@ -3037,34 +3122,27 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: *ref_1 - post: + patch: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.markFailed + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.projects.locations.insightTypes.updateConfig requestBody: content: application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3076,7 +3154,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: projectsId @@ -3089,22 +3167,24 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: - parameters: *ref_1 + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.get + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.projects.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3116,7 +3196,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: projectsId @@ -3129,12 +3209,7 @@ paths: schema: type: string - in: path - name: recommendersId - required: true - schema: - type: string - - in: path - name: recommendationsId + name: insightTypesId required: true schema: type: string @@ -3239,13 +3314,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: parameters: *ref_1 get: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.list + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3257,8 +3332,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: projectsId @@ -3275,26 +3349,18 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: recommendationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 get: description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.projects.locations.recommenders.getConfig + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3306,7 +3372,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path name: projectsId @@ -3323,98 +3390,38 @@ paths: required: true schema: type: string - patch: - description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.projects.locations.recommenders.updateConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: recommendersId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: validateOnly + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 - get: - description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.projects.locations.insightTypes.getConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: insightTypesId - required: true - schema: - type: string - patch: + post: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.projects.locations.insightTypes.updateConfig + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.markFailed requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3426,7 +3433,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: projectsId @@ -3439,35 +3446,35 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: updateMask + - in: path + name: recommendationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_1 post: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.projects.locations.insightTypes.insights.markAccepted + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.projects.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3479,7 +3486,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: projectsId @@ -3492,22 +3499,22 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: path - name: insightsId + name: recommendationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_1 get: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.projects.locations.insightTypes.insights.get + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.projects.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3519,7 +3526,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path name: projectsId @@ -3532,22 +3539,20 @@ paths: schema: type: string - in: path - name: insightTypesId - required: true - schema: - type: string - - in: path - name: insightsId + name: recommendersId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: - parameters: *ref_1 - get: + patch: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.projects.locations.insightTypes.insights.list + Updates a Recommender Config. This will create a new revision of the + config. + operationId: recommender.projects.locations.recommenders.updateConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3559,8 +3564,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path name: projectsId @@ -3573,20 +3577,16 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: query - name: pageToken + name: validateOnly schema: - type: string + type: boolean - in: query - name: filter + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + format: google-fieldmask diff --git a/providers/src/googleapis.com/v00.00.00000/services/redis.yaml b/providers/src/googleapis.com/v00.00.00000/services/redis.yaml index 5885e52c..a9ce8a4e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/redis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/redis.yaml @@ -7,8 +7,8 @@ info: title: Google Cloud Memorystore for Redis API description: Creates and manages Redis instances on the Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240904' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/memorystore/docs/redis/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml b/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml index 541c0ba8..b1a306e3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml @@ -10,8 +10,8 @@ info: their GCP resources (e.g., VM, firewall, Project, etc.) across the Cloud Resource Hierarchy. version: v1 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/resource-manager/docs/resource-settings/overview servers: @@ -37,87 +37,46 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudResourcesettingsV1SettingMetadata: - description: Metadata about a setting which is not editable by the end user. - id: GoogleCloudResourcesettingsV1SettingMetadata - properties: - defaultValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - description: >- - The value provided by Setting.effective_value if no setting value is - explicitly set. Note: not all settings have a default value. - dataType: - description: The data type for this setting. - enum: - - DATA_TYPE_UNSPECIFIED - - BOOLEAN - - STRING - - STRING_SET - - ENUM_VALUE - - DURATION_VALUE - - STRING_MAP - enumDescriptions: - - Unspecified data type. - - A boolean setting. - - A string setting. - - A string set setting. - - A Enum setting - - A Duration setting - - A string->string map setting - type: string - displayName: - type: string - description: The human readable name for this setting. - description: - description: A detailed description of what this setting does. - type: string - readOnly: - type: boolean - description: >- - A flag indicating that values of this setting cannot be modified. - See documentation for the specific setting for updates and reasons. - type: object - GoogleCloudResourcesettingsV1ValueStringMap: - description: >- - A string->string map value that can hold a map of string keys to string - values. The maximum length of each string is 200 characters and there - can be a maximum of 50 key-value pairs in the map. - id: GoogleCloudResourcesettingsV1ValueStringMap + GoogleCloudResourcesettingsV1ValueStringSet: properties: - mappings: - type: object - description: The key-value pairs in the map - additionalProperties: + values: + type: array + description: The strings in the set + items: type: string type: object + id: GoogleCloudResourcesettingsV1ValueStringSet + description: >- + A string set value that can hold a set of strings. The maximum length of + each string is 200 characters and there can be a maximum of 50 strings + in the string set. GoogleCloudResourcesettingsV1Value: properties: enumValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueEnumValue' description: Defines this value as being a Enum. + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueEnumValue' + stringValue: + type: string + description: Defines this value as being a string value. stringMapValue: - description: Defines this value as being a StringMap. $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringMap' + description: Defines this value as being a StringMap. + booleanValue: + type: boolean + description: Defines this value as being a boolean value. stringSetValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' description: Defines this value as being a StringSet. - stringValue: - type: string - description: Defines this value as being a string value. + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' durationValue: - format: google-duration description: Defines this value as being a Duration. type: string - booleanValue: - type: boolean - description: Defines this value as being a boolean value. + format: google-duration id: GoogleCloudResourcesettingsV1Value - description: The data in a setting value. type: object + description: The data in a setting value. GoogleCloudResourcesettingsV1Setting: properties: effectiveValue: - readOnly: true description: >- Output only. The effective value of the setting at the given parent resource, evaluated based on the resource hierarchy The effective @@ -131,17 +90,19 @@ components: `Value` with all fields unset. The data type of Value must always be consistent with the data type defined in Setting.metadata. $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' + readOnly: true localValue: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' description: >- The configured value of the setting at the given parent resource, ignoring the resource hierarchy. The data type of Value must always be consistent with the data type defined in Setting.metadata. - etag: + metadata: + readOnly: true + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1SettingMetadata' description: >- - A fingerprint used for optimistic concurrency. See UpdateSetting for - more details. - type: string + Output only. Metadata about a setting which is not editable by the + end user. name: type: string description: >- @@ -150,40 +111,70 @@ components: `folders/{folder_id}/settings/{setting_name}` * `organizations/{organization_id}/settings/{setting_name}` For example, "/projects/123/settings/gcp-enableMyFeature" - metadata: - readOnly: true - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1SettingMetadata' + etag: description: >- - Output only. Metadata about a setting which is not editable by the - end user. - type: object + A fingerprint used for optimistic concurrency. See UpdateSetting for + more details. + type: string id: GoogleCloudResourcesettingsV1Setting description: The schema for settings. - GoogleCloudResourcesettingsV1ValueEnumValue: - description: >- - A enum value that can hold any enum type setting values. Each enum type - is represented by a number, this representation is stored in the - definitions. - properties: - value: - type: string - description: The value of this enum type: object - id: GoogleCloudResourcesettingsV1ValueEnumValue - GoogleCloudResourcesettingsV1ValueStringSet: + GoogleCloudResourcesettingsV1ValueStringMap: type: object - description: >- - A string set value that can hold a set of strings. The maximum length of - each string is 200 characters and there can be a maximum of 50 strings - in the string set. + id: GoogleCloudResourcesettingsV1ValueStringMap properties: - values: - type: array - items: + mappings: + description: The key-value pairs in the map + additionalProperties: type: string - description: The strings in the set - id: GoogleCloudResourcesettingsV1ValueStringSet + type: object + description: >- + A string->string map value that can hold a map of string keys to string + values. The maximum length of each string is 200 characters and there + can be a maximum of 50 key-value pairs in the map. + GoogleCloudResourcesettingsV1SettingMetadata: + properties: + description: + description: A detailed description of what this setting does. + type: string + readOnly: + type: boolean + description: >- + A flag indicating that values of this setting cannot be modified. + See documentation for the specific setting for updates and reasons. + defaultValue: + description: >- + The value provided by Setting.effective_value if no setting value is + explicitly set. Note: not all settings have a default value. + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' + displayName: + type: string + description: The human readable name for this setting. + dataType: + enumDescriptions: + - Unspecified data type. + - A boolean setting. + - A string setting. + - A string set setting. + - A Enum setting + - A Duration setting + - A string->string map setting + description: The data type for this setting. + enum: + - DATA_TYPE_UNSPECIFIED + - BOOLEAN + - STRING + - STRING_SET + - ENUM_VALUE + - DURATION_VALUE + - STRING_MAP + type: string + id: GoogleCloudResourcesettingsV1SettingMetadata + type: object + description: Metadata about a setting which is not editable by the end user. GoogleCloudResourcesettingsV1ListSettingsResponse: + description: The response from ListSettings. + id: GoogleCloudResourcesettingsV1ListSettingsResponse properties: nextPageToken: type: string @@ -195,41 +186,53 @@ components: description: >- A list of settings that are available at the specified Cloud resource. - id: GoogleCloudResourcesettingsV1ListSettingsResponse - description: The response from ListSettings. type: object + GoogleCloudResourcesettingsV1ValueEnumValue: + id: GoogleCloudResourcesettingsV1ValueEnumValue + description: >- + A enum value that can hold any enum type setting values. Each enum type + is represented by a number, this representation is stored in the + definitions. + type: object + properties: + value: + type: string + description: The value of this enum parameters: - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + callback: + description: JSONP in: query - name: quotaUser + name: callback + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string alt: @@ -242,18 +245,6 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -263,10 +254,10 @@ components: enum: - '1' - '2' - callback: - description: JSONP + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: callback + name: fields schema: type: string key: @@ -278,19 +269,21 @@ components: name: key schema: type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string x-stackQL-resources: settings: id: google.resourcesettings.settings name: settings title: Settings methods: - projects_settings_list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.settings projects_settings_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/get' @@ -303,123 +296,91 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_settings_get: + projects_settings_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1settings~1{settingsId}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_settings_patch: + objectKey: $.settings + folders_settings_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1settings~1{settingsId}/patch + $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_settings_list: + folders_settings_patch: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1settings/get' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + folders_settings_list: + operation: + $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.settings - folders_settings_patch: + organizations_settings_list: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/patch' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1settings/get' response: mediaType: application/json openAPIDocKey: '200' - folders_settings_get: + objectKey: $.settings + organizations_settings_get: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1settings~1{settingsId}/get response: mediaType: application/json openAPIDocKey: '200' - folders_settings_list: + organizations_settings_patch: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1settings~1{settingsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.settings sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/settings/methods/projects_settings_get - - $ref: >- - #/components/x-stackQL-resources/settings/methods/organizations_settings_get - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_get - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_list + #/components/x-stackQL-resources/settings/methods/organizations_settings_get - $ref: >- - #/components/x-stackQL-resources/settings/methods/organizations_settings_list + #/components/x-stackQL-resources/settings/methods/projects_settings_list - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_list + - $ref: >- + #/components/x-stackQL-resources/settings/methods/organizations_settings_list insert: [] update: - $ref: >- #/components/x-stackQL-resources/settings/methods/projects_settings_patch - - $ref: >- - #/components/x-stackQL-resources/settings/methods/organizations_settings_patch - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_patch + - $ref: >- + #/components/x-stackQL-resources/settings/methods/organizations_settings_patch replace: [] delete: [] paths: - /v1/projects/{projectsId}/settings: + /v1/projects/{projectsId}/settings/{settingsId}: parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - get: - description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.projects.settings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/settings/{settingsId}: - parameters: *ref_1 + - $ref: '#/components/parameters/quotaUser' get: description: >- Returns a specified setting. Returns a `google.rpc.Status` with @@ -492,13 +453,52 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/settings/{settingsId}: + /v1/projects/{projectsId}/settings: + parameters: *ref_1 + get: + description: >- + Lists all the settings that are available on the Cloud resource + `parent`. + operationId: resourcesettings.projects.settings.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/settings/{settingsId}: parameters: *ref_1 get: description: >- Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.organizations.settings.get + operationId: resourcesettings.folders.settings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -513,7 +513,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -537,7 +537,7 @@ paths: will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.organizations.settings.patch + operationId: resourcesettings.folders.settings.patch requestBody: content: application/json: @@ -557,7 +557,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -566,13 +566,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/settings: + /v1/folders/{foldersId}/settings: parameters: *ref_1 get: description: >- Lists all the settings that are available on the Cloud resource `parent`. - operationId: resourcesettings.organizations.settings.list + operationId: resourcesettings.folders.settings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -588,7 +588,7 @@ paths: #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -598,32 +598,20 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: view schema: type: string - in: query - name: view + name: pageToken schema: type: string - /v1/folders/{foldersId}/settings/{settingsId}: + /v1/organizations/{organizationsId}/settings: parameters: *ref_1 - patch: + get: description: >- - Updates a specified setting. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the - setting is flagged as read only. Returns a `google.rpc.Status` with - `google.rpc.Code.ABORTED` if the etag supplied in the request does not - match the persisted etag of the setting value. On success, the response - will contain only `name`, `local_value` and `etag`. The `metadata` and - `effective_value` cannot be updated through this API. Note: the supplied - setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.folders.settings.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' + Lists all the settings that are available on the Cloud resource + `parent`. + operationId: resourcesettings.organizations.settings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -635,23 +623,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' + $ref: >- + #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: path - name: settingsId - required: true + - in: query + name: view + schema: + type: string + - in: query + name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/settings/{settingsId}: + parameters: *ref_1 get: description: >- Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.folders.settings.get + operationId: resourcesettings.organizations.settings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -666,7 +665,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -679,13 +678,23 @@ paths: name: view schema: type: string - /v1/folders/{foldersId}/settings: - parameters: *ref_1 - get: + patch: description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.folders.settings.list + Updates a specified setting. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the + setting is flagged as read only. Returns a `google.rpc.Status` with + `google.rpc.Code.ABORTED` if the etag supplied in the request does not + match the persisted etag of the setting value. On success, the response + will contain only `name`, `local_value` and `etag`. The `metadata` and + `effective_value` cannot be updated through this API. Note: the supplied + setting will perform a full overwrite of the `local_value` field. + operationId: resourcesettings.organizations.settings.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -697,24 +706,15 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageToken + - in: path + name: settingsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/retail.yaml b/providers/src/googleapis.com/v00.00.00000/services/retail.yaml index 1d57be05..2c186f38 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/retail.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/retail.yaml @@ -11,8 +11,8 @@ info: personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. version: v2 - x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/recommendations servers: @@ -1128,6 +1128,16 @@ components: be exactly matched with UserEvent.entity to get search results boosted by entity. type: string + conversationalSearchSpec: + description: >- + Optional. This field specifies all conversational related parameters + addition to traditional retail search. + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchRequestConversationalSearchSpec + tileNavigationSpec: + description: Optional. This field specifies tile navigation related parameters. + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchRequestTileNavigationSpec GoogleCloudRetailV2UserInfo: id: GoogleCloudRetailV2UserInfo description: Information of an end user. @@ -1489,6 +1499,135 @@ components: - MODE_UNSPECIFIED - SUGGESTION_ONLY - AUTO + GoogleCloudRetailV2SearchRequestConversationalSearchSpec: + id: GoogleCloudRetailV2SearchRequestConversationalSearchSpec + description: >- + This field specifies all conversational related parameters addition to + traditional retail search. + type: object + properties: + followupConversationRequested: + description: >- + This field specifies whether the customer would like to do + conversational search. If this field is set to true, conversational + related extra information will be returned from server side, + including follow-up question, answer options, etc. + type: boolean + conversationId: + description: >- + This field specifies the conversation id, which maintains the state + of the conversation between client side and server side. Use the + value from the previous ConversationalSearchResult.conversation_id. + For the initial request, this should be empty. + type: string + userAnswer: + description: >- + This field specifies the current user answer during the + conversational search. This can be either user selected from + suggested answers or user input plain text. + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer + GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer: + id: GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer + description: >- + This field specifies the current user answer during the conversational + search. This can be either user selected from suggested answers or user + input plain text. + type: object + properties: + textAnswer: + description: >- + This field specifies the incremental input text from the user during + the conversational search. + type: string + selectedAnswer: + description: >- + This field specifies the selected attributes during the + conversational search. This should be a subset of + ConversationalSearchResult.suggested_answers. + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer + GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer: + id: >- + GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer + description: >- + This field specifies the selected answers during the conversational + search. + type: object + properties: + productAttributeValues: + description: This field is deprecated and should not be set. + deprecated: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudRetailV2ProductAttributeValue' + productAttributeValue: + description: >- + This field specifies the selected answer which is a attribute + key-value. + $ref: '#/components/schemas/GoogleCloudRetailV2ProductAttributeValue' + GoogleCloudRetailV2ProductAttributeValue: + id: GoogleCloudRetailV2ProductAttributeValue + description: >- + Product attribute which structured by an attribute name and value. This + structure is used in conversational search filters and answers. For + example, if we have `name=color` and `value=red`, this means that the + color is `red`. + type: object + properties: + name: + description: The attribute name. + type: string + value: + description: The attribute value. + type: string + GoogleCloudRetailV2SearchRequestTileNavigationSpec: + id: GoogleCloudRetailV2SearchRequestTileNavigationSpec + description: This field specifies tile navigation related parameters. + type: object + properties: + tileNavigationRequested: + description: >- + This field specifies whether the customer would like to request tile + navigation. + type: boolean + appliedTiles: + description: >- + This field specifies the tiles which are already clicked in client + side. NOTE: This field is not being used for filtering search + products. Client side should also put all the applied tiles in + SearchRequest.filter. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRetailV2Tile' + GoogleCloudRetailV2Tile: + id: GoogleCloudRetailV2Tile + description: >- + This field specifies the tile information including an attribute key, + attribute value. More fields will be added in the future, eg: product id + or product counts, etc. + type: object + properties: + productAttributeValue: + description: The product attribute key-value. + $ref: '#/components/schemas/GoogleCloudRetailV2ProductAttributeValue' + productAttributeInterval: + description: The product attribute key-numeric interval. + $ref: '#/components/schemas/GoogleCloudRetailV2ProductAttributeInterval' + representativeProductId: + description: The representative product id for this tile. + type: string + GoogleCloudRetailV2ProductAttributeInterval: + id: GoogleCloudRetailV2ProductAttributeInterval + description: Product attribute name and numeric interval. + type: object + properties: + name: + description: The attribute name (e.g. "length") + type: string + interval: + description: The numeric interval (e.g. [10, 20)) + $ref: '#/components/schemas/GoogleCloudRetailV2Interval' GoogleCloudRetailV2SearchResponse: id: GoogleCloudRetailV2SearchResponse description: Response message for SearchService.Search method. @@ -1560,6 +1699,18 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudRetailV2ExperimentInfo' + conversationalSearchResult: + description: >- + This field specifies all related information that is needed on + client side for UI rendering of conversational retail search. + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchResponseConversationalSearchResult + tileNavigationResult: + description: >- + This field specifies all related information for tile navigation + that will be used in client side. + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchResponseTileNavigationResult GoogleCloudRetailV2SearchResponseSearchResult: id: GoogleCloudRetailV2SearchResponseSearchResult description: Represents the search results. @@ -2509,6 +2660,95 @@ components: the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`. type: string + GoogleCloudRetailV2SearchResponseConversationalSearchResult: + id: GoogleCloudRetailV2SearchResponseConversationalSearchResult + description: >- + This field specifies all related information that is needed on client + side for UI rendering of conversational retail search. + type: object + properties: + conversationId: + description: >- + Conversation UUID. This field will be stored in client side storage + to maintain the conversation session with server and will be used + for next search request's + SearchRequest.ConversationalSearchSpec.conversation_id to restore + conversation state in server. + type: string + refinedQuery: + description: >- + The current refined query for the conversational search. This field + will be used in customer UI that the query in the search bar should + be replaced with the refined query. For example, if + SearchRequest.query is `dress` and next + SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is + `red color`, which does not match any product attribute value + filters, the refined query will be `dress, red color`. + type: string + additionalFilters: + description: >- + This field is deprecated but will be kept for backward + compatibility. There is expected to have only one additional filter + and the value will be the same to the same as field + `additional_filter`. + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter + followupQuestion: + description: The follow-up question. e.g., `What is the color?` + type: string + suggestedAnswers: + description: The answer options provided to client for the follow-up question. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer + additionalFilter: + description: >- + This is the incremental additional filters implied from the current + user answer. User should add the suggested addition filters to the + previous SearchRequest.filter, and use the merged filter in the + follow up search request. + $ref: >- + #/components/schemas/GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter + GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter: + id: >- + GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter + description: Additional filter that client side need to apply. + type: object + properties: + productAttributeValue: + description: >- + Product attribute value, including an attribute key and an attribute + value. Other types can be added here in the future. + $ref: '#/components/schemas/GoogleCloudRetailV2ProductAttributeValue' + GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer: + id: >- + GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer + description: Suggested answers to the follow-up question. + type: object + properties: + productAttributeValue: + description: >- + Product attribute value, including an attribute key and an attribute + value. Other types can be added here in the future. + $ref: '#/components/schemas/GoogleCloudRetailV2ProductAttributeValue' + GoogleCloudRetailV2SearchResponseTileNavigationResult: + id: GoogleCloudRetailV2SearchResponseTileNavigationResult + description: >- + This field specifies all related information for tile navigation that + will be used in client side. + type: object + properties: + tiles: + description: >- + The current tiles that are used for tile navigation, sorted by + engagement. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRetailV2Tile' GoogleCloudRetailV2CompleteQueryResponse: id: GoogleCloudRetailV2CompleteQueryResponse description: Response of the autocomplete query. diff --git a/providers/src/googleapis.com/v00.00.00000/services/run.yaml b/providers/src/googleapis.com/v00.00.00000/services/run.yaml index ecb70cbc..07944dc1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/run.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/run.yaml @@ -12,7 +12,7 @@ info: API standards, as described in https://google.aip.dev/. version: v2 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/run/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml b/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml index a5e295b8..4d8f708a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml @@ -12,7 +12,7 @@ info: based on certain conditions. version: v1 x-discovery-doc-revision: '20240627' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/deployment-manager/runtime-configurator/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml b/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml index dae7c2df..dd81bb37 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1alpha1 x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/spectrum-access-system/ servers: @@ -22,10 +22,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/sasportal: Read, create, update, and delete your SAS Portal data. https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. - https://www.googleapis.com/auth/sasportal: Read, create, update, and delete your SAS Portal data. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -35,401 +35,497 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalGetPolicyRequest: - description: Request message for `GetPolicy` method. - id: SasPortalGetPolicyRequest - properties: - resource: - description: Required. The resource for which the policy is being requested. - type: string - type: object - SasPortalGcpProjectDeployment: - description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. - id: SasPortalGcpProjectDeployment - properties: - hasEnabledAnalytics: - type: boolean - description: Whether SAS analytics has been enabled. - deployment: - $ref: '#/components/schemas/SasPortalDeployment' - description: Deployment associated with the GCP project. - type: object - SasPortalSetupSasAnalyticsMetadata: - description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. - type: object - properties: {} - id: SasPortalSetupSasAnalyticsMetadata - SasPortalMigrateOrganizationMetadata: + SasPortalUpdateSignedDeviceRequest: + description: Request for UpdateSignedDevice. type: object - description: >- - Long-running operation metadata message returned by the - MigrateOrganization. + id: SasPortalUpdateSignedDeviceRequest properties: - operationState: - readOnly: true - enum: - - OPERATION_STATE_UNSPECIFIED - - OPERATION_STATE_PENDING - - OPERATION_STATE_RUNNING - - OPERATION_STATE_SUCCEEDED - - OPERATION_STATE_FAILED - enumDescriptions: - - Unspecified. - - Pending (Not started). - - In-progress. - - Done successfully. - - Done with errors. - description: Output only. Current operation state + encodedDevice: + description: >- + Required. The JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. type: string - id: SasPortalMigrateOrganizationMetadata - SasPortalSetupSasAnalyticsRequest: - properties: - userId: + format: byte + installerId: description: >- - Optional. User id to setup analytics for, if not provided the user - id associated with the project is used. optional + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. type: string - type: object - description: Request for the SetupSasAnalytics rpc. - id: SasPortalSetupSasAnalyticsRequest - SasPortalListGcpProjectDeploymentsResponse: - id: SasPortalListGcpProjectDeploymentsResponse - type: object - description: Response for [ListGcpProjectDeployments]. - properties: - deployments: - type: array - description: Optional. Deployments associated with the GCP project - items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' - SasPortalDeploymentAssociation: + SasPortalInstallationParams: properties: - userId: + heightType: type: string - description: User id of the deployment. - gcpProjectId: + description: Specifies how the height is measured. + enumDescriptions: + - Unspecified height type. + - AGL height is measured relative to the ground level. + - AMSL height is measured relative to the mean sea level. + enum: + - HEIGHT_TYPE_UNSPECIFIED + - HEIGHT_TYPE_AGL + - HEIGHT_TYPE_AMSL + verticalAccuracy: + format: double + type: number + description: >- + A positive number in meters to indicate accuracy of the device + antenna vertical location. This optional parameter should only be + present if its value is less than the FCC requirement of 3 meters. + antennaDowntilt: + description: >- + Antenna downtilt in degrees and is an integer with a value between + -90 and +90 inclusive; a negative value means the antenna is tilted + up (above horizontal). This parameter is optional for Category A + devices and conditional for Category B devices. + format: int32 + type: integer + longitude: + description: >- + Longitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -180.000000 to +180.000000. + Positive values represent longitudes east of the prime meridian; + negative values west of the prime meridian. + format: double + type: number + eirpCapability: + type: integer + format: int32 + description: >- + This parameter is the maximum device EIRP in units of dBm/10MHz and + is an integer with a value between -127 and +47 (dBm/10 MHz) + inclusive. If not included, SAS interprets it as maximum allowable + EIRP in units of dBm/10MHz for device category. + antennaModel: type: string - description: GCP project id of the associated project. - id: SasPortalDeploymentAssociation + description: >- + If an external antenna is used, the antenna model is optionally + provided in this field. The string has a maximum length of 128 + octets. + height: + description: >- + Device antenna height in meters. When the `heightType` parameter + value is "AGL", the antenna height should be given relative to + ground level. When the `heightType` parameter value is "AMSL", it is + given with respect to WGS84 datum. + format: double + type: number + antennaBeamwidth: + format: int32 + type: integer + description: >- + 3-dB antenna beamwidth of the antenna in the horizontal-plane in + degrees. This parameter is an unsigned integer having a value + between 0 and 360 (degrees) inclusive; it is optional for Category A + devices and conditional for Category B devices. + cpeCbsdIndication: + type: boolean + description: >- + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + antennaAzimuth: + description: >- + Boresight direction of the horizontal plane of the antenna in + degrees with respect to true north. The value of this parameter is + an integer with a value between 0 and 359 inclusive. A value of 0 + degrees means true north; a value of 90 degrees means east. This + parameter is optional for Category A devices and conditional for + Category B devices. + type: integer + format: int32 + latitude: + type: number + description: >- + Latitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -90.000000 to +90.000000. + Positive values represent latitudes north of the equator; negative + values south of the equator. + format: double + horizontalAccuracy: + format: double + type: number + description: >- + A positive number in meters to indicate accuracy of the device + antenna horizontal location. This optional parameter should only be + present if its value is less than the FCC requirement of 50 meters. + indoorDeployment: + description: >- + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. + type: boolean + antennaGain: + description: >- + Peak antenna gain in dBi. This parameter is a double with a value + between -127 and +128 (dBi) inclusive. Part of Release 2 to support + floating-point value + format: double + type: number + id: SasPortalInstallationParams + description: Information about the device installation parameters. type: object - description: Association between a gcp project and a SAS user id. - SasPortalCustomer: + SasPortalDeviceAirInterface: + id: SasPortalDeviceAirInterface properties: - displayName: + radioTechnology: type: string description: >- - Required. Name of the organization that the customer entity - represents. - sasUserIds: - items: - type: string - description: User IDs used by the devices belonging to this customer. - type: array - name: + Conditional. This field specifies the radio access technology that + is used for the CBSD. + enum: + - RADIO_TECHNOLOGY_UNSPECIFIED + - E_UTRA + - CAMBIUM_NETWORKS + - FOUR_G_BBW_SAA_1 + - NR + - DOODLE_CBRS + - CW + - REDLINE + - TARANA_WIRELESS + - FAROS + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + supportedSpec: + description: >- + Optional. This field is related to the `radioTechnology` and + provides the air interface specification that the CBSD is compliant + with at the time of registration. type: string - description: Output only. Resource name of the customer. type: object - id: SasPortalCustomer - description: Entity representing a SAS customer. - SasPortalChannelWithScore: - id: SasPortalChannelWithScore + description: Information about the device's air interface. + SasPortalSignDeviceRequest: type: object - description: The channel with score. + description: Request for SignDevice. properties: - score: - description: The channel score, normalized to be in the range [0,100]. - type: number - format: double - frequencyRange: - description: The frequency range of the channel. - $ref: '#/components/schemas/SasPortalFrequencyRange' - SasPortalSetupSasAnalyticsResponse: - properties: {} + device: + $ref: '#/components/schemas/SasPortalDevice' + description: >- + Required. The device to sign. The device fields name, fcc_id and + serial_number must be set. The user_id field must be set. + id: SasPortalSignDeviceRequest + SasPortalProvisionDeploymentResponse: description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. type: object - id: SasPortalSetupSasAnalyticsResponse + properties: + errorMessage: + type: string + description: >- + Optional. Optional error message if the provisioning request is not + successful. + id: SasPortalProvisionDeploymentResponse SasPortalProvisionDeploymentRequest: + type: object description: >- Request for [ProvisionDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP Project, Organization Info, and caller’s GAIA ID should be retrieved from the RPC handler, and used as inputs to create a new SAS organization (if not exists) and a new SAS deployment. - type: object + id: SasPortalProvisionDeploymentRequest properties: - newDeploymentDisplayName: - type: string - description: >- - Optional. If this field is set, and a new SAS Portal Deployment - needs to be created, its display name will be set to the value of - this field. organizationId: - type: string description: >- Optional. If this field is set then a new deployment will be created under the organization specified by this id. format: int64 + type: string newOrganizationDisplayName: type: string description: >- Optional. If this field is set, and a new SAS Portal Organization needs to be created, its display name will be set to the value of this field. - id: SasPortalProvisionDeploymentRequest + newDeploymentDisplayName: + description: >- + Optional. If this field is set, and a new SAS Portal Deployment + needs to be created, its display name will be set to the value of + this field. + type: string + SasPortalFrequencyRange: + type: object + properties: + lowFrequencyMhz: + format: double + type: number + description: The lowest frequency of the frequency range in MHz. + highFrequencyMhz: + description: The highest frequency of the frequency range in MHz. + format: double + type: number + description: Frequency range from `low_frequency` to `high_frequency`. + id: SasPortalFrequencyRange + SasPortalMoveDeploymentRequest: + properties: + destination: + type: string + description: >- + Required. The name of the new parent resource node or customer to + reparent the deployment under. + type: object + description: Request for MoveDeployment. + id: SasPortalMoveDeploymentRequest SasPortalDeviceMetadata: - id: SasPortalDeviceMetadata - description: Device data overridable by both SAS Portal and registration requests. properties: - nrqzValidated: + nrqzValidation: + description: Output only. National Radio Quiet Zone validation info. readOnly: true - deprecated: true - description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. - type: boolean - commonChannelGroup: - description: >- - Common Channel Group (CCG). A group of CBSDs in the same ICG - requesting a common primary channel assignment. For more details, - see [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - type: string + $ref: '#/components/schemas/SasPortalNrqzValidation' interferenceCoordinationGroup: + type: string description: >- Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + commonChannelGroup: type: string - nrqzValidation: + description: >- + Common Channel Group (CCG). A group of CBSDs in the same ICG + requesting a common primary channel assignment. For more details, + see [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + nrqzValidated: readOnly: true - $ref: '#/components/schemas/SasPortalNrqzValidation' - description: Output only. National Radio Quiet Zone validation info. + description: >- + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + type: boolean + deprecated: true antennaModel: description: >- If populated, the Antenna Model Pattern to use. Format is: `RecordCreatorId:PatternId` type: string + id: SasPortalDeviceMetadata + description: Device data overridable by both SAS Portal and registration requests. type: object - SasPortalSignDeviceRequest: - description: Request for SignDevice. - id: SasPortalSignDeviceRequest - properties: - device: - $ref: '#/components/schemas/SasPortalDevice' - description: >- - Required. The device to sign. The device fields name, fcc_id and - serial_number must be set. The user_id field must be set. - type: object - SasPortalStatus: - type: object - id: SasPortalStatus + SasPortalNrqzValidation: properties: - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - details: - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - message: + caseId: + type: string + description: Validation case ID. + latitude: + type: number + format: double + description: Device latitude that's associated with the validation. + state: + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. + description: State of the NRQZ validation info. + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - SasPortalMoveDeploymentRequest: + cpiId: + type: string + description: CPI who signed the validation. + longitude: + description: Device longitude that's associated with the validation. + format: double + type: number + id: SasPortalNrqzValidation + description: Information about National Radio Quiet Zone validation. type: object - id: SasPortalMoveDeploymentRequest - description: Request for MoveDeployment. + SasPortalMoveDeviceRequest: properties: destination: - type: string description: >- Required. The name of the new parent resource node or customer to - reparent the deployment under. - SasPortalDeployment: + reparent the device under. + type: string + type: object + description: Request for MoveDevice. + id: SasPortalMoveDeviceRequest + SasPortalDevice: properties: + grants: + items: + $ref: '#/components/schemas/SasPortalDeviceGrant' + description: Output only. Grants held by the device. + type: array + deviceMetadata: + $ref: '#/components/schemas/SasPortalDeviceMetadata' + description: >- + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + activeConfig: + $ref: '#/components/schemas/SasPortalDeviceConfig' + description: >- + Output only. Current configuration of the device as registered to + the SAS. + fccId: + description: >- + The FCC identifier of the device. Refer to + https://www.fcc.gov/oet/ea/fccid for FccID format. Accept + underscores and periods because some test-SAS customers use them. + type: string + preloadedConfig: + description: Configuration of the device, as specified via SAS Portal API. + $ref: '#/components/schemas/SasPortalDeviceConfig' + serialNumber: + description: A serial number assigned to the device by the device manufacturer. + type: string name: - readOnly: true - description: Output only. Resource name. + description: Output only. The resource path name. type: string - sasUserIds: + currentChannels: + deprecated: true + items: + $ref: '#/components/schemas/SasPortalChannelWithScore' + readOnly: true type: array + description: Output only. Current channels with scores. + grantRangeAllowlists: items: - type: string + $ref: '#/components/schemas/SasPortalFrequencyRange' + type: array description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. + Only ranges that are within the allowlists are available for new + grants. displayName: + description: Device display name. type: string - description: The deployment's display name. - frns: - type: array - items: - type: string - readOnly: true - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. - description: The Deployment. - type: object - id: SasPortalDeployment - SasPortalEmpty: - type: object - properties: {} - id: SasPortalEmpty - 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); } - SasPortalListNodesResponse: - id: SasPortalListNodesResponse - properties: - nextPageToken: + state: type: string - description: >- - A pagination token returned from a previous call to ListNodes that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more nodes. - nodes: - items: - $ref: '#/components/schemas/SasPortalNode' - type: array - description: The nodes that match the request. + enumDescriptions: + - Unspecified state. + - >- + Device created in the SAS Portal, however, not yet registered with + SAS. + - Device registered with SAS. + - Device de-registered with SAS. + enum: + - DEVICE_STATE_UNSPECIFIED + - RESERVED + - REGISTERED + - DEREGISTERED + description: Output only. Device state. + id: SasPortalDevice type: object - description: Response for ListNodes. SasPortalListLegacyOrganizationsResponse: + type: object + id: SasPortalListLegacyOrganizationsResponse + description: >- + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. properties: organizations: items: $ref: '#/components/schemas/SasPortalOrganization' type: array description: Optional. Legacy SAS organizations. - id: SasPortalListLegacyOrganizationsResponse - type: object + SasPortalStatus: description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. - SasPortalAssignment: - description: Associates `members` with a `role`. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object properties: - role: - description: Required. Role that is assigned to `members`. + message: type: string - members: - items: - type: string description: >- - The identities the role is assigned to. It can have the following - values: * `{user_email}`: An email address that represents a - specific Google account. For example: `alice@gmail.com`. * - `{group_email}`: An email address that represents a Google group. - For example, `viewers@gmail.com`. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + type: integer + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + details: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: array - id: SasPortalAssignment - SasPortalOrganization: - description: Organization details. - id: SasPortalOrganization + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + id: SasPortalStatus + SasPortalValidateInstallerRequest: type: object properties: - displayName: + installerId: type: string - description: Name of organization - id: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + encodedSecret: + description: >- + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. type: string - description: Id of organization - format: int64 - SasPortalListDevicesResponse: - id: SasPortalListDevicesResponse + secret: + type: string + description: Required. Secret returned by the GenerateSecret. + description: Request for ValidateInstaller. + id: SasPortalValidateInstallerRequest + SasPortalDpaMoveList: type: object - description: Response for ListDevices. + description: An entry in a DPA's move list. + id: SasPortalDpaMoveList properties: - nextPageToken: + dpaId: type: string - description: >- - A pagination token returned from a previous call to ListDevices that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more devices. - devices: - items: - $ref: '#/components/schemas/SasPortalDevice' + description: The ID of the DPA. + frequencyRange: + description: The frequency range that the move list affects. + $ref: '#/components/schemas/SasPortalFrequencyRange' + SasPortalTestPermissionsResponse: + properties: + permissions: type: array - description: The devices that match the request. - SasPortalListDeploymentsResponse: + description: A set of permissions that the caller is allowed. + items: + type: string + id: SasPortalTestPermissionsResponse + description: Response message for `TestPermissions` method. + type: object + SasPortalListGcpProjectDeploymentsResponse: type: object properties: deployments: - description: The deployments that match the request. - items: - $ref: '#/components/schemas/SasPortalDeployment' type: array - nextPageToken: - description: >- - A pagination token returned from a previous call to ListDeployments - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more deployments. - type: string - description: Response for ListDeployments. - id: SasPortalListDeploymentsResponse - SasPortalSetPolicyRequest: - type: object - description: Request message for `SetPolicy` method. - properties: - resource: - description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - type: string - policy: - description: Required. The policy to be applied to the `resource`. - $ref: '#/components/schemas/SasPortalPolicy' + description: Optional. Deployments associated with the GCP project + items: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + id: SasPortalListGcpProjectDeploymentsResponse + description: Response for [ListGcpProjectDeployments]. + SasPortalSetPolicyRequest: + type: object + properties: disableNotification: type: boolean description: >- Optional. Set the field as `true` to disable the onboarding notification. - id: SasPortalSetPolicyRequest - SasPortalUpdateSignedDeviceRequest: - description: Request for UpdateSignedDevice. - id: SasPortalUpdateSignedDeviceRequest - properties: - encodedDevice: - description: >- - Required. The JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - type: string - format: byte - installerId: + policy: + description: Required. The policy to be applied to the `resource`. + $ref: '#/components/schemas/SasPortalPolicy' + resource: description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. type: string - type: object + id: SasPortalSetPolicyRequest + description: Request message for `SetPolicy` method. SasPortalMigrateOrganizationResponse: type: object properties: @@ -437,461 +533,240 @@ components: description: >- Optional. A list of deployment association that were created for the migration, or current associations if they already exist. + type: array items: $ref: '#/components/schemas/SasPortalDeploymentAssociation' - type: array - id: SasPortalMigrateOrganizationResponse description: >- Response for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + id: SasPortalMigrateOrganizationResponse + SasPortalListCustomersResponse: + description: Response for `ListCustomers`. + properties: + customers: + items: + $ref: '#/components/schemas/SasPortalCustomer' + type: array + description: The list of customers that match the request. + nextPageToken: + description: >- + A pagination token returned from a previous call to ListCustomers + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more customers. + type: string + type: object + id: SasPortalListCustomersResponse SasPortalDeviceGrant: + id: SasPortalDeviceGrant + type: object properties: + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The transmission frequency range. + expireTime: + description: The expiration time of the grant. + format: google-datetime + type: string + moveList: + type: array + description: The DPA move lists on which this grant appears. + items: + $ref: '#/components/schemas/SasPortalDpaMoveList' channelType: - description: Type of channel used. enum: - CHANNEL_TYPE_UNSPECIFIED - CHANNEL_TYPE_GAA - CHANNEL_TYPE_PAL + description: Type of channel used. type: string enumDescriptions: - '' - '' - '' - expireTime: - type: string - description: The expiration time of the grant. - format: google-datetime - frequencyRange: - description: The transmission frequency range. - $ref: '#/components/schemas/SasPortalFrequencyRange' - state: - enum: - - GRANT_STATE_UNSPECIFIED - - GRANT_STATE_GRANTED - - GRANT_STATE_TERMINATED - - GRANT_STATE_SUSPENDED - - GRANT_STATE_AUTHORIZED - - GRANT_STATE_EXPIRED - description: State of the grant. - enumDescriptions: - - '' - - >- - The grant has been granted but the device is not heartbeating on - it. - - The grant has been terminated by the SAS. - - The grant has been suspended by the SAS. - - The device is currently transmitting. - - The grant has expired. - type: string - moveList: - type: array - items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - description: The DPA move lists on which this grant appears. - lastHeartbeatTransmitExpireTime: - format: google-datetime - type: string - description: The transmit expiration time of the last heartbeat. maxEirp: + format: double description: >- Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). - format: double type: number + lastHeartbeatTransmitExpireTime: + description: The transmit expiration time of the last heartbeat. + type: string + format: google-datetime grantId: type: string description: Grant Id. suspensionReason: items: type: string - description: If the grant is suspended, the reason(s) for suspension. type: array - type: object + description: If the grant is suspended, the reason(s) for suspension. + state: + description: State of the grant. + enumDescriptions: + - '' + - >- + The grant has been granted but the device is not heartbeating on + it. + - The grant has been terminated by the SAS. + - The grant has been suspended by the SAS. + - The device is currently transmitting. + - The grant has expired. + enum: + - GRANT_STATE_UNSPECIFIED + - GRANT_STATE_GRANTED + - GRANT_STATE_TERMINATED + - GRANT_STATE_SUSPENDED + - GRANT_STATE_AUTHORIZED + - GRANT_STATE_EXPIRED + type: string description: >- Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. - id: SasPortalDeviceGrant - SasPortalInstallationParams: - properties: - antennaDowntilt: - format: int32 - type: integer - description: >- - Antenna downtilt in degrees and is an integer with a value between - -90 and +90 inclusive; a negative value means the antenna is tilted - up (above horizontal). This parameter is optional for Category A - devices and conditional for Category B devices. - verticalAccuracy: - format: double - description: >- - A positive number in meters to indicate accuracy of the device - antenna vertical location. This optional parameter should only be - present if its value is less than the FCC requirement of 3 meters. - type: number - heightType: - enum: - - HEIGHT_TYPE_UNSPECIFIED - - HEIGHT_TYPE_AGL - - HEIGHT_TYPE_AMSL - description: Specifies how the height is measured. - type: string - enumDescriptions: - - Unspecified height type. - - AGL height is measured relative to the ground level. - - AMSL height is measured relative to the mean sea level. - antennaGain: - description: >- - Peak antenna gain in dBi. This parameter is a double with a value - between -127 and +128 (dBi) inclusive. Part of Release 2 to support - floating-point value - format: double - type: number - antennaModel: - type: string - description: >- - If an external antenna is used, the antenna model is optionally - provided in this field. The string has a maximum length of 128 - octets. - longitude: - format: double - type: number - description: >- - Longitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -180.000000 to +180.000000. - Positive values represent longitudes east of the prime meridian; - negative values west of the prime meridian. - indoorDeployment: - description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. - type: boolean - eirpCapability: - format: int32 - type: integer - description: >- - This parameter is the maximum device EIRP in units of dBm/10MHz and - is an integer with a value between -127 and +47 (dBm/10 MHz) - inclusive. If not included, SAS interprets it as maximum allowable - EIRP in units of dBm/10MHz for device category. - height: - type: number - format: double - description: >- - Device antenna height in meters. When the `heightType` parameter - value is "AGL", the antenna height should be given relative to - ground level. When the `heightType` parameter value is "AMSL", it is - given with respect to WGS84 datum. - horizontalAccuracy: - type: number - description: >- - A positive number in meters to indicate accuracy of the device - antenna horizontal location. This optional parameter should only be - present if its value is less than the FCC requirement of 50 meters. - format: double - antennaAzimuth: - description: >- - Boresight direction of the horizontal plane of the antenna in - degrees with respect to true north. The value of this parameter is - an integer with a value between 0 and 359 inclusive. A value of 0 - degrees means true north; a value of 90 degrees means east. This - parameter is optional for Category A devices and conditional for - Category B devices. - type: integer - format: int32 - antennaBeamwidth: - description: >- - 3-dB antenna beamwidth of the antenna in the horizontal-plane in - degrees. This parameter is an unsigned integer having a value - between 0 and 360 (degrees) inclusive; it is optional for Category A - devices and conditional for Category B devices. - type: integer - format: int32 - cpeCbsdIndication: - type: boolean - description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - latitude: - description: >- - Latitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -90.000000 to +90.000000. - Positive values represent latitudes north of the equator; negative - values south of the equator. - type: number - format: double - description: Information about the device installation parameters. - id: SasPortalInstallationParams + SasPortalSetupSasAnalyticsResponse: + id: SasPortalSetupSasAnalyticsResponse type: object - SasPortalDeviceAirInterface: - id: SasPortalDeviceAirInterface + description: >- + Response returned by the long running operation for the + SetupSasAnalytics rpc. + properties: {} + SasPortalEmpty: + 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); } + type: object + id: SasPortalEmpty + properties: {} + SasPortalSetupSasAnalyticsMetadata: + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. + id: SasPortalSetupSasAnalyticsMetadata type: object + properties: {} + SasPortalMoveNodeRequest: + id: SasPortalMoveNodeRequest properties: - radioTechnology: - enum: - - RADIO_TECHNOLOGY_UNSPECIFIED - - E_UTRA - - CAMBIUM_NETWORKS - - FOUR_G_BBW_SAA_1 - - NR - - DOODLE_CBRS - - CW - - REDLINE - - TARANA_WIRELESS - - FAROS - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. - type: string - supportedSpec: + destination: type: string description: >- - Optional. This field is related to the `radioTechnology` and - provides the air interface specification that the CBSD is compliant - with at the time of registration. - description: Information about the device's air interface. - SasPortalValidateInstallerResponse: - properties: {} - id: SasPortalValidateInstallerResponse + Required. The name of the new parent resource node or customer to + reparent the node under. + description: Request for MoveNode. type: object - description: Response for ValidateInstaller. - SasPortalDeviceModel: - id: SasPortalDeviceModel - description: Information about the model of the device. + SasPortalDeploymentAssociation: type: object properties: - hardwareVersion: - type: string - description: The hardware version of the device. - vendor: + userId: + description: User id of the deployment. type: string - description: The name of the device vendor. - firmwareVersion: + gcpProjectId: type: string - description: The firmware version of the device. - name: - description: The name of the device model. + description: GCP project id of the associated project. + id: SasPortalDeploymentAssociation + description: Association between a gcp project and a SAS user id. + SasPortalOrganization: + description: Organization details. + type: object + id: SasPortalOrganization + properties: + displayName: + description: Name of organization type: string - softwareVersion: - description: The software version of the device. + id: type: string - SasPortalMoveNodeRequest: + description: Id of organization + format: int64 + SasPortalPolicy: properties: - destination: + etag: description: >- - Required. The name of the new parent resource node or customer to - reparent the node under. + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the etag in + the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An etag is returned in the response to + GetPolicy, and systems are expected to put that etag in the request + to SetPolicy to ensure that their change will be applied to the same + version of the policy. If no etag is provided in the call to + GetPolicy, then the existing policy is overwritten blindly. + format: byte type: string + assignments: + type: array + items: + $ref: '#/components/schemas/SasPortalAssignment' + description: List of assignments + id: SasPortalPolicy + description: Defines an access control policy to the resources. type: object - description: Request for MoveNode. - id: SasPortalMoveNodeRequest SasPortalDeviceConfig: + id: SasPortalDeviceConfig description: Information about the device configuration. type: object properties: installationParams: $ref: '#/components/schemas/SasPortalInstallationParams' description: Installation parameters for the device. - userId: - type: string - description: The identifier of a device user. - airInterface: - description: Information about this device's air interface. - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - category: - type: string - description: FCC category of the device. - enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. - enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B measurementCapabilities: + type: array + description: Measurement reporting capabilities of the device. items: - type: string enum: - MEASUREMENT_CAPABILITY_UNSPECIFIED - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + type: string enumDescriptions: - '' - '' - '' - type: array - description: Measurement reporting capabilities of the device. - isSigned: - type: boolean - description: Output only. Whether the configuration has been signed by a CPI. - state: - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL - enumDescriptions: - - '' - - '' - - '' - type: string - description: State of the configuration. callSign: description: The call sign of the device operator. type: string - model: - description: Information about this device model. - $ref: '#/components/schemas/SasPortalDeviceModel' + airInterface: + $ref: '#/components/schemas/SasPortalDeviceAirInterface' + description: Information about this device's air interface. updateTime: - type: string - description: Output only. The last time the device configuration was edited. format: google-datetime - id: SasPortalDeviceConfig - SasPortalMoveDeviceRequest: - properties: - destination: - description: >- - Required. The name of the new parent resource node or customer to - reparent the device under. - type: string - type: object - description: Request for MoveDevice. - id: SasPortalMoveDeviceRequest - SasPortalNode: - properties: - sasUserIds: - description: User ids used by the devices belonging to this node. - items: - type: string - type: array - name: - type: string - description: Output only. Resource name. - displayName: - description: The node's display name. - type: string - description: The Node. - type: object - id: SasPortalNode - SasPortalGenerateSecretRequest: - type: object - id: SasPortalGenerateSecretRequest - description: Request for GenerateSecret. - properties: {} - SasPortalGenerateSecretResponse: - properties: - secret: - description: The secret generated by the string and used by ValidateInstaller. - type: string - id: SasPortalGenerateSecretResponse - type: object - description: Response for GenerateSecret. - SasPortalCreateSignedDeviceRequest: - id: SasPortalCreateSignedDeviceRequest - properties: - installerId: - type: string - description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - encodedDevice: - description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - format: byte - type: string - type: object - description: Request for CreateSignedDevice. - SasPortalDevice: - properties: - displayName: - description: Device display name. - type: string - preloadedConfig: - description: Configuration of the device, as specified via SAS Portal API. - $ref: '#/components/schemas/SasPortalDeviceConfig' - serialNumber: - description: A serial number assigned to the device by the device manufacturer. type: string - activeConfig: - description: >- - Output only. Current configuration of the device as registered to - the SAS. - $ref: '#/components/schemas/SasPortalDeviceConfig' - grants: - type: array - description: Output only. Grants held by the device. - items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - grantRangeAllowlists: - items: - $ref: '#/components/schemas/SasPortalFrequencyRange' - type: array - description: >- - Only ranges that are within the allowlists are available for new - grants. - deviceMetadata: - $ref: '#/components/schemas/SasPortalDeviceMetadata' - description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - currentChannels: - readOnly: true - type: array - description: Output only. Current channels with scores. - items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - deprecated: true - fccId: + description: Output only. The last time the device configuration was edited. + userId: type: string - description: >- - The FCC identifier of the device. Refer to - https://www.fcc.gov/oet/ea/fccid for FccID format. Accept - underscores and periods because some test-SAS customers use them. + description: The identifier of a device user. state: + description: State of the configuration. type: string - description: Output only. Device state. enumDescriptions: - - Unspecified state. - - >- - Device created in the SAS Portal, however, not yet registered with - SAS. - - Device registered with SAS. - - Device de-registered with SAS. + - '' + - '' + - '' enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED - name: - description: Output only. The resource path name. + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL + model: + $ref: '#/components/schemas/SasPortalDeviceModel' + description: Information about this device model. + isSigned: + description: Output only. Whether the configuration has been signed by a CPI. + type: boolean + category: type: string - type: object - id: SasPortalDevice - SasPortalTestPermissionsResponse: - properties: - permissions: - description: A set of permissions that the caller is allowed. - items: - type: string - type: array - id: SasPortalTestPermissionsResponse - type: object - description: Response message for `TestPermissions` method. + description: FCC category of the device. + enum: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B + enumDescriptions: + - Unspecified device category. + - Category A. + - Category B. SasPortalMigrateOrganizationRequest: properties: organizationId: @@ -906,23 +781,29 @@ components: organization and to create GCP Projects. type: object id: SasPortalMigrateOrganizationRequest + SasPortalListDevicesResponse: + description: Response for ListDevices. + id: SasPortalListDevicesResponse + properties: + devices: + description: The devices that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalDevice' + nextPageToken: + type: string + description: >- + A pagination token returned from a previous call to ListDevices that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more devices. + type: object SasPortalOperation: + type: object id: SasPortalOperation description: >- This resource represents a long-running operation that is the result of a network API call. properties: - error: - $ref: '#/components/schemas/SasPortalStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean response: additionalProperties: description: Properties of the object. Contains field @type with type URL. @@ -955,168 +836,265 @@ components: method that returns a long-running operation should document the metadata type, if any. type: object + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + $ref: '#/components/schemas/SasPortalStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + SasPortalTestPermissionsRequest: + id: SasPortalTestPermissionsRequest + properties: + permissions: + type: array + description: The set of permissions to check for the `resource`. + items: + type: string + resource: + description: >- + Required. The resource for which the permissions are being + requested. + type: string + description: Request message for `TestPermissions` method. type: object - SasPortalNrqzValidation: + SasPortalChannelWithScore: + type: object + id: SasPortalChannelWithScore properties: - longitude: - format: double + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The frequency range of the channel. + score: type: number - description: Device longitude that's associated with the validation. - state: - description: State of the NRQZ validation info. - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. + format: double + description: The channel score, normalized to be in the range [0,100]. + description: The channel with score. + SasPortalDeviceModel: + id: SasPortalDeviceModel + type: object + description: Information about the model of the device. + properties: + hardwareVersion: type: string - cpiId: + description: The hardware version of the device. + name: + description: The name of the device model. type: string - description: CPI who signed the validation. - caseId: - description: Validation case ID. + firmwareVersion: + description: The firmware version of the device. type: string - latitude: - format: double - description: Device latitude that's associated with the validation. - type: number - id: SasPortalNrqzValidation + vendor: + type: string + description: The name of the device vendor. + softwareVersion: + description: The software version of the device. + type: string + SasPortalListNodesResponse: + id: SasPortalListNodesResponse + properties: + nodes: + description: The nodes that match the request. + items: + $ref: '#/components/schemas/SasPortalNode' + type: array + nextPageToken: + type: string + description: >- + A pagination token returned from a previous call to ListNodes that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more nodes. + type: object + description: Response for ListNodes. + SasPortalListDeploymentsResponse: + description: Response for ListDeployments. + properties: + nextPageToken: + description: >- + A pagination token returned from a previous call to ListDeployments + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more deployments. + type: string + deployments: + type: array + description: The deployments that match the request. + items: + $ref: '#/components/schemas/SasPortalDeployment' + id: SasPortalListDeploymentsResponse + type: object + SasPortalCustomer: + properties: + sasUserIds: + description: User IDs used by the devices belonging to this customer. + type: array + items: + type: string + displayName: + type: string + description: >- + Required. Name of the organization that the customer entity + represents. + name: + description: Output only. Resource name of the customer. + type: string + type: object + id: SasPortalCustomer + description: Entity representing a SAS customer. + SasPortalMigrateOrganizationMetadata: + id: SasPortalMigrateOrganizationMetadata type: object - description: Information about National Radio Quiet Zone validation. - SasPortalProvisionDeploymentResponse: description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. + Long-running operation metadata message returned by the + MigrateOrganization. properties: - errorMessage: + operationState: + readOnly: true + enum: + - OPERATION_STATE_UNSPECIFIED + - OPERATION_STATE_PENDING + - OPERATION_STATE_RUNNING + - OPERATION_STATE_SUCCEEDED + - OPERATION_STATE_FAILED + enumDescriptions: + - Unspecified. + - Pending (Not started). + - In-progress. + - Done successfully. + - Done with errors. + type: string + description: Output only. Current operation state + SasPortalGenerateSecretResponse: + id: SasPortalGenerateSecretResponse + type: object + properties: + secret: + type: string + description: The secret generated by the string and used by ValidateInstaller. + description: Response for GenerateSecret. + SasPortalDeployment: + description: The Deployment. + type: object + id: SasPortalDeployment + properties: + displayName: + description: The deployment's display name. type: string + frns: + description: >- + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. + items: + type: string + type: array + readOnly: true + name: + type: string + description: Output only. Resource name. + readOnly: true + sasUserIds: + items: + type: string + type: array description: >- - Optional. Optional error message if the provisioning request is not - successful. - type: object - id: SasPortalProvisionDeploymentResponse - SasPortalDpaMoveList: - id: SasPortalDpaMoveList + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + SasPortalGetPolicyRequest: type: object + description: Request message for `GetPolicy` method. properties: - dpaId: + resource: type: string - description: The ID of the DPA. - frequencyRange: - description: The frequency range that the move list affects. - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: An entry in a DPA's move list. - SasPortalValidateInstallerRequest: + description: Required. The resource for which the policy is being requested. + id: SasPortalGetPolicyRequest + SasPortalGenerateSecretRequest: + properties: {} + id: SasPortalGenerateSecretRequest + type: object + description: Request for GenerateSecret. + SasPortalCreateSignedDeviceRequest: + description: Request for CreateSignedDevice. type: object + id: SasPortalCreateSignedDeviceRequest properties: - secret: - type: string - description: Required. Secret returned by the GenerateSecret. installerId: + type: string description: >- Required. Unique installer id (CPI ID) from the Certified Professional Installers database. + encodedDevice: type: string - encodedSecret: + format: byte description: >- Required. JSON Web Token signed using a CPI private key. Payload - must include a "secret" claim whose value is the secret. - type: string - description: Request for ValidateInstaller. - id: SasPortalValidateInstallerRequest - SasPortalFrequencyRange: + must be the JSON encoding of the device. The user_id field must be + set. + SasPortalGcpProjectDeployment: type: object + description: >- + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. + id: SasPortalGcpProjectDeployment properties: - lowFrequencyMhz: - format: double - type: number - description: The lowest frequency of the frequency range in MHz. - highFrequencyMhz: - type: number - description: The highest frequency of the frequency range in MHz. - format: double - description: Frequency range from `low_frequency` to `high_frequency`. - id: SasPortalFrequencyRange - SasPortalTestPermissionsRequest: - id: SasPortalTestPermissionsRequest - description: Request message for `TestPermissions` method. + hasEnabledAnalytics: + description: Whether SAS analytics has been enabled. + type: boolean + deployment: + description: Deployment associated with the GCP project. + $ref: '#/components/schemas/SasPortalDeployment' + SasPortalValidateInstallerResponse: + description: Response for ValidateInstaller. + id: SasPortalValidateInstallerResponse + properties: {} + type: object + SasPortalAssignment: type: object properties: - permissions: + members: + type: array items: type: string - type: array - description: The set of permissions to check for the `resource`. - resource: - type: string description: >- - Required. The resource for which the permissions are being - requested. - SasPortalPolicy: - description: Defines an access control policy to the resources. + The identities the role is assigned to. It can have the following + values: * `{user_email}`: An email address that represents a + specific Google account. For example: `alice@gmail.com`. * + `{group_email}`: An email address that represents a Google group. + For example, `viewers@gmail.com`. + role: + type: string + description: Required. Role that is assigned to `members`. + description: Associates `members` with a `role`. + id: SasPortalAssignment + SasPortalNode: + description: The Node. type: object + id: SasPortalNode properties: - assignments: - description: List of assignments + displayName: + type: string + description: The node's display name. + sasUserIds: + description: User ids used by the devices belonging to this node. items: - $ref: '#/components/schemas/SasPortalAssignment' + type: string type: array - etag: - description: >- - The etag is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the etag in - the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An etag is returned in the response to - GetPolicy, and systems are expected to put that etag in the request - to SetPolicy to ensure that their change will be applied to the same - version of the policy. If no etag is provided in the call to - GetPolicy, then the existing policy is overwritten blindly. - format: byte + name: type: string - id: SasPortalPolicy - SasPortalListCustomersResponse: - id: SasPortalListCustomersResponse + description: Output only. Resource name. + SasPortalSetupSasAnalyticsRequest: + type: object + id: SasPortalSetupSasAnalyticsRequest properties: - nextPageToken: - type: string + userId: description: >- - A pagination token returned from a previous call to ListCustomers - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more customers. - customers: - description: The list of customers that match the request. - items: - $ref: '#/components/schemas/SasPortalCustomer' - type: array - type: object - description: Response for `ListCustomers`. + Optional. User id to setup analytics for, if not provided the user + id associated with the project is used. optional + type: string + description: Request for the SetupSasAnalytics rpc. parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -1144,27 +1122,34 @@ components: name: fields schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - _.xgafv: - description: V1 error format. + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' + - json + - media + - proto prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -1174,588 +1159,701 @@ components: name: key schema: type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string x-stackQL-resources: - devices: - id: google.sasportal.devices - name: devices - title: Devices + policies: + id: google.sasportal.policies + name: policies + title: Policies + methods: + policies_test: + operation: + $ref: '#/paths/~1v1alpha1~1policies:test/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_set: + operation: + $ref: '#/paths/~1v1alpha1~1policies:set/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_get: + operation: + $ref: '#/paths/~1v1alpha1~1policies:get/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' + insert: [] + update: [] + replace: [] + delete: [] + customers_gcp_project_deployments: + id: google.sasportal.customers_gcp_project_deployments + name: customers_gcp_project_deployments + title: Customers_gcp_project_deployments + methods: + customers_list_gcp_project_deployments: + operation: + $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments + insert: [] + update: [] + replace: [] + delete: [] + customers: + id: google.sasportal.customers + name: customers + title: Customers methods: - deployments_devices_get: + customers_migrate_organization: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_patch: + customers_provision_deployment: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_delete: + customers_list: + operation: + $ref: '#/paths/~1v1alpha1~1customers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.customers + customers_get: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_patch: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_setup_sas_analytics: + operation: + $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' + replace: [] + delete: [] + customers_legacy_organizations: + id: google.sasportal.customers_legacy_organizations + name: customers_legacy_organizations + title: Customers_legacy_organizations + methods: + customers_list_legacy_organizations: + operation: + $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations + insert: [] + update: [] + replace: [] + delete: [] + deployments: + id: google.sasportal.deployments + name: deployments + title: Deployments + methods: + customers_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + customers_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_move: + customers_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_list: + customers_deployments_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_create: + objectKey: $.deployments + customers_deployments_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_move: + customers_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_delete: + customers_nodes_deployments_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_get: + objectKey: $.deployments + customers_nodes_deployments_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_patch: + nodes_deployments_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_sign_device: + objectKey: $.deployments + nodes_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create: + nodes_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_list: + nodes_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_deployments_devices_create: + nodes_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_list: + nodes_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_devices_patch: + nodes_nodes_deployments_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_delete: + objectKey: $.deployments + deployments_get: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/deployments_get + insert: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_create + update: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete + devices_signed: + id: google.sasportal.devices_signed + name: devices_signed + title: Devices_signed + methods: + customers_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create: + customers_nodes_devices_create_signed: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_list: + customers_devices_update_signed: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_devices_sign_device: + customers_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_move: + nodes_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create: + nodes_devices_create_signed: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_list: + nodes_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_nodes_devices_create: + nodes_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_list: + deployments_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_get - - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_get - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_list - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_list + select: [] insert: - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create + #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create + #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create + #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create + #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_create + #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_create + #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed update: - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_patch + #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_patch + #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_patch + #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_delete - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_delete - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_delete - devices_signed: - id: google.sasportal.devices_signed - name: devices_signed - title: Devices_signed + delete: [] + devices: + id: google.sasportal.devices + name: devices + title: Devices methods: - deployments_devices_update_signed: + customers_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create_signed: + objectKey: $.devices + customers_deployments_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_update_signed: + customers_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + customers_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create_signed: + objectKey: $.devices + customers_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create_signed: + customers_devices_list: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_update_signed: + objectKey: $.devices + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create_signed: + customers_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create_signed: + customers_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed - update: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed - replace: [] - delete: [] - deployments: - id: google.sasportal.deployments - name: deployments - title: Deployments - methods: - deployments_get: + customers_devices_move: operation: - $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_deployments_list: + customers_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - nodes_nodes_deployments_create: + nodes_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_patch: + nodes_devices_patch: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_get: + nodes_devices_delete: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_delete: + nodes_devices_get: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_move: + nodes_devices_create: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_devices_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.devices + nodes_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_list: + nodes_deployments_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_delete: + objectKey: $.devices + nodes_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_get: + nodes_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_patch: + objectKey: $.devices + nodes_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_create: + deployments_devices_move: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_list: + deployments_devices_patch: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_move: + deployments_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_deployments_list: + deployments_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_nodes_deployments_create: + deployments_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + #/components/x-stackQL-resources/devices/methods/customers_devices_get + - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list + #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/deployments_get + #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list + #/components/x-stackQL-resources/devices/methods/deployments_devices_get - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_list + #/components/x-stackQL-resources/devices/methods/customers_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_devices_list insert: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_create - update: + #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch + #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch - replace: [] - delete: + #/components/x-stackQL-resources/devices/methods/customers_devices_create - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete + #/components/x-stackQL-resources/devices/methods/nodes_devices_create + update: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete - installer: - id: google.sasportal.installer - name: installer - title: Installer - methods: - installer_generate_secret: - operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' - response: - mediaType: application/json - openAPIDocKey: '200' - installer_validate: - operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - policies: - id: google.sasportal.policies - name: policies - title: Policies + #/components/x-stackQL-resources/devices/methods/customers_devices_patch + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_devices_patch + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_devices_delete + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_devices_delete + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_delete + customer_nodes: + id: google.sasportal.customer_nodes + name: customer_nodes + title: Customer_nodes methods: - policies_get: + customers_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - policies_test: + customers_nodes_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get response: mediaType: application/json openAPIDocKey: '200' - policies_set: + objectKey: $.nodes + customers_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' - insert: [] - update: [] - replace: [] - delete: [] - node: - id: google.sasportal.node - name: node - title: Node - methods: - nodes_get: + objectKey: $.nodes + customers_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_get: + customers_nodes_delete: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' - insert: [] + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_list + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_list + insert: + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_create + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_create update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete nodes: id: google.sasportal.nodes name: nodes title: Nodes methods: - nodes_nodes_create: + customers_nodes_patch: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_list: + customers_nodes_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_move: + nodes_nodes_patch: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' response: mediaType: application/json openAPIDocKey: '200' @@ -1765,37 +1863,36 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_patch: + nodes_nodes_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_nodes_create: + nodes_nodes_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_nodes_list: + objectKey: $.nodes + nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_patch: + nodes_nodes_nodes_list: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_move: + objectKey: $.nodes + nodes_nodes_nodes_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' @@ -1809,193 +1906,101 @@ components: #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_create - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_create' update: - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' - $ref: >- #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' replace: [] delete: - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' - customers: - id: google.sasportal.customers - name: customers - title: Customers + customer_node: + id: google.sasportal.customer_node + name: customer_node + title: Customer_node methods: - customers_list: - operation: - $ref: '#/paths/~1v1alpha1~1customers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.customers - customers_migrate_organization: - operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_patch: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_get: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_provision_deployment: - operation: - $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_setup_sas_analytics: + customers_nodes_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' + - $ref: >- + #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get insert: [] - update: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' + update: [] replace: [] delete: [] - customers_gcp_project_deployments: - id: google.sasportal.customers_gcp_project_deployments - name: customers_gcp_project_deployments - title: Customers_gcp_project_deployments + node: + id: google.sasportal.node + name: node + title: Node methods: - customers_list_gcp_project_deployments: + nodes_nodes_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments - insert: [] - update: [] - replace: [] - delete: [] - customers_legacy_organizations: - id: google.sasportal.customers_legacy_organizations - name: customers_legacy_organizations - title: Customers_legacy_organizations - methods: - customers_list_legacy_organizations: + nodes_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' insert: [] update: [] replace: [] delete: [] - customer_nodes: - id: google.sasportal.customer_nodes - name: customer_nodes - title: Customer_nodes + installer: + id: google.sasportal.installer + name: installer + title: Installer methods: - customers_nodes_nodes_list: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_nodes_create: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_delete: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_create: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_list: + installer_generate_secret: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_list - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_list - insert: - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_create - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete - customer_node: - id: google.sasportal.customer_node - name: customer_node - title: Customer_node - methods: - customers_nodes_get: + installer_validate: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/get' + $ref: '#/paths/~1v1alpha1~1installer:validate/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get + select: [] insert: [] update: [] replace: [] delete: [] paths: - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + /v1alpha1/policies:test: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/key' - get: - description: Gets details about a device. - operationId: sasportal.deployments.devices.get + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + post: + description: Returns permissions that a caller has on the specified resource. + operationId: sasportal.policies.test + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalTestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2011,26 +2016,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - patch: - description: Updates a device. - operationId: sasportal.deployments.devices.patch + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + parameters: [] + /v1alpha1/policies:set: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: sasportal.policies.set requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2046,26 +2045,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: sasportal.deployments.devices.delete + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:get: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: sasportal.policies.get + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2081,28 +2074,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/customers:listGcpProjectDeployments: parameters: *ref_1 - patch: - description: Updates a signed device. - operationId: sasportal.deployments.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + get: + description: >- + Returns a list of SAS deployments associated with current GCP project. + Includes whether SAS analytics has been enabled or not. + operationId: sasportal.customers.listGcpProjectDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2118,28 +2098,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers:migrateOrganization: parameters: *ref_1 post: - description: Signs a device. - operationId: sasportal.deployments.devices.signDevice + description: >- + Migrates a SAS organization to the cloud. This will create GCP projects + for each deployment and associate them. The SAS Organization is linked + to the gcp project that called the command. + go/sas-legacy-customer-migration + operationId: sasportal.customers.migrateOrganization requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2155,28 +2130,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers:provisionDeployment: parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: sasportal.deployments.devices.move + description: >- + Creates a new SAS deployment through the GCP workflow. Creates a SAS + organization if an organization match is not found. + operationId: sasportal.customers.provisionDeployment requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2192,23 +2159,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}: + $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' + parameters: [] + /v1alpha1/customers: parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: sasportal.deployments.get + description: Returns a list of requested customers. + operationId: sasportal.customers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2224,23 +2181,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListCustomersResponse' parameters: - - in: path - name: deploymentsId - required: true + - in: query + name: pageToken schema: type: string - /v1alpha1/installer:generateSecret: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers/{customersId}: parameters: *ref_1 - post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: sasportal.installer.generateSecret - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' + get: + description: Returns a requested customer. + operationId: sasportal.customers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2256,18 +2212,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/installer:validate: - parameters: *ref_1 - post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: sasportal.installer.validate + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + patch: + description: Updates an existing customer. + operationId: sasportal.customers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerRequest' + $ref: '#/components/schemas/SasPortalCustomer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2283,20 +2242,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' - parameters: [] - /v1alpha1/policies:get: + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers:setupSasAnalytics: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: sasportal.policies.get + Setups the a GCP Project to receive SAS Analytics messages via GCP + Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and + BigQuery tables are created automatically as part of this service. + operationId: sasportal.customers.setupSasAnalytics requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGetPolicyRequest' + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2312,18 +2282,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' + $ref: '#/components/schemas/SasPortalOperation' parameters: [] - /v1alpha1/policies:test: + /v1alpha1/customers:listLegacyOrganizations: parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: sasportal.policies.test - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' + get: + description: Returns a list of legacy organizations. + operationId: sasportal.customers.listLegacyOrganizations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2339,20 +2304,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' parameters: [] - /v1alpha1/policies:set: + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: sasportal.policies.set - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSetPolicyRequest' + get: + description: Returns a requested deployment. + operationId: sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2368,13 +2326,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/nodes/{nodesId}: - parameters: *ref_1 - get: - description: Returns a requested node. - operationId: sasportal.nodes.get + $ref: '#/components/schemas/SasPortalDeployment' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + patch: + description: Updates an existing deployment. + operationId: sasportal.customers.deployments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2390,23 +2361,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a deployment. + operationId: sasportal.customers.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2422,18 +2396,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/deployments: parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.devices.list + description: Lists deployments. + operationId: sasportal.customers.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2449,15 +2428,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -2466,17 +2445,17 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.devices.create + description: Creates a new deployment. + operationId: sasportal.customers.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2492,23 +2471,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: sasportal.nodes.devices.move + description: Moves a deployment under another node or customer. + operationId: sasportal.customers.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2527,20 +2506,25 @@ paths: $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_1 - delete: - description: Deletes a device. - operationId: sasportal.nodes.devices.delete + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.deployments.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2556,21 +2540,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 get: - description: Gets details about a device. - operationId: sasportal.nodes.devices.get + description: Lists devices under a node or customer. + operationId: sasportal.customers.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2586,68 +2572,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - patch: - description: Updates a device. - operationId: sasportal.nodes.devices.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: nodesId - required: true + - in: query + name: filter schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: - parameters: *ref_1 - patch: - description: Updates a signed device. - operationId: sasportal.nodes.devices.updateSigned + type: integer + format: int32 + post: + description: Creates a device under a node or customer. + operationId: sasportal.customers.deployments.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2666,25 +2623,25 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: parameters: *ref_1 post: - description: Signs a device. - operationId: sasportal.nodes.devices.signDevice + description: Creates a new node. + operationId: sasportal.customers.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2700,28 +2657,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes: - parameters: *ref_1 - post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists nodes. + operationId: sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2737,16 +2687,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: + - in: path + name: customersId + required: true + schema: + type: string - in: path name: nodesId required: true schema: type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + parameters: *ref_1 get: - description: Lists nodes. - operationId: sasportal.nodes.nodes.list + description: Lists deployments. + operationId: sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2762,36 +2732,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: + - in: path + name: customersId + required: true + schema: + type: string - in: path name: nodesId required: true schema: type: string - in: query - name: filter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: - parameters: *ref_1 + type: string post: - description: Moves a node under another node or customer. - operationId: sasportal.nodes.nodes.move + description: Creates a new deployment. + operationId: sasportal.customers.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2807,23 +2780,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: parameters: *ref_1 - delete: - description: Deletes a node. - operationId: sasportal.nodes.nodes.delete + post: + description: Creates a device under a node or customer. + operationId: sasportal.customers.nodes.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2839,21 +2817,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string get: - description: Returns a requested node. - operationId: sasportal.nodes.nodes.get + description: Lists devices under a node or customer. + operationId: sasportal.customers.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2869,26 +2847,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - patch: - description: Updates an existing node. - operationId: sasportal.nodes.nodes.patch + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2904,33 +2897,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + /v1alpha1/customers/{customersId}/nodes: parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.nodes.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + get: + description: Lists nodes. + operationId: sasportal.customers.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2946,28 +2929,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - - in: path - name: nodesId1 - required: true + - in: query + name: pageToken schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: - parameters: *ref_1 + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.nodes.devices.create + description: Creates a new node. + operationId: sasportal.customers.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2983,21 +2972,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 + name: customersId required: true schema: type: string - get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.nodes.devices.list + /v1alpha1/customers/{customersId}/nodes/{nodesId}: + parameters: *ref_1 + delete: + description: Deletes a node. + operationId: sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3013,36 +2999,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: - parameters: *ref_1 - post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.nodes.create + patch: + description: Updates an existing node. + operationId: sasportal.customers.nodes.patch requestBody: content: application/json: @@ -3066,18 +3037,23 @@ paths: $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Lists nodes. - operationId: sasportal.nodes.nodes.nodes.list + description: Returns a requested node. + operationId: sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3093,36 +3069,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: parameters: *ref_1 - get: - description: Lists deployments. - operationId: sasportal.nodes.nodes.deployments.list + post: + description: Moves a node under another node or customer. + operationId: sasportal.customers.nodes.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3138,39 +3106,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + type: string + /v1alpha1/customers/{customersId}/devices: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: sasportal.nodes.nodes.deployments.create + description: Creates a device under a node or customer. + operationId: sasportal.customers.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3186,28 +3143,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 + name: customersId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: - parameters: *ref_1 - patch: - description: Updates an existing deployment. - operationId: sasportal.nodes.deployments.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + get: + description: Lists devices under a node or customer. + operationId: sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3223,26 +3168,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - get: - description: Returns a requested deployment. - operationId: sasportal.nodes.deployments.get + /v1alpha1/customers/{customersId}/devices/{devicesId}: + parameters: *ref_1 + patch: + description: Updates a device. + operationId: sasportal.customers.devices.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3258,21 +3213,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: - description: Deletes a deployment. - operationId: sasportal.nodes.deployments.delete + description: Deletes a device. + operationId: sasportal.customers.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3291,25 +3251,18 @@ paths: $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: - parameters: *ref_1 - post: - description: Moves a deployment under another node or customer. - operationId: sasportal.nodes.deployments.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + get: + description: Gets details about a device. + operationId: sasportal.customers.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3325,23 +3278,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments: + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: parameters: *ref_1 - get: - description: Lists deployments. - operationId: sasportal.nodes.deployments.list + post: + description: Moves a device under another node or customer. + operationId: sasportal.customers.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3357,36 +3315,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: devicesId + required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.deployments.devices.create + description: Signs a device. + operationId: sasportal.customers.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3402,21 +3352,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.deployments.devices.list + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: sasportal.customers.devices.updateSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3432,36 +3389,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/customers/{customersId}/devices:createSigned: parameters: *ref_1 post: description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.deployments.devices.createSigned + operationId: sasportal.customers.devices.createSigned requestBody: content: application/json: @@ -3485,20 +3429,20 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: customersId required: true schema: type: string - /v1alpha1/customers: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: parameters: *ref_1 - get: - description: Returns a list of requested customers. - operationId: sasportal.customers.list + post: + description: Signs a device. + operationId: sasportal.nodes.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3514,31 +3458,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - - in: query - name: pageToken + - in: path + name: nodesId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: devicesId + required: true schema: - type: integer - format: int32 - /v1alpha1/customers:migrateOrganization: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: parameters: *ref_1 - post: - description: >- - Migrates a SAS organization to the cloud. This will create GCP projects - for each deployment and associate them. The SAS Organization is linked - to the gcp project that called the command. - go/sas-legacy-customer-migration - operationId: sasportal.customers.migrateOrganization + patch: + description: Updates a device. + operationId: sasportal.nodes.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3554,15 +3495,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers:listGcpProjectDeployments: - parameters: *ref_1 - get: - description: >- - Returns a list of SAS deployments associated with current GCP project. - Includes whether SAS analytics has been enabled or not. - operationId: sasportal.customers.listGcpProjectDeployments + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a device. + operationId: sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3578,19 +3530,21 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/SasPortalListGcpProjectDeploymentsResponse - parameters: [] - /v1alpha1/customers/{customersId}: - parameters: *ref_1 - patch: - description: Updates an existing customer. - operationId: sasportal.customers.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalEmpty' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + get: + description: Gets details about a device. + operationId: sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3606,21 +3560,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: devicesId + required: true schema: type: string - format: google-fieldmask - get: - description: Returns a requested customer. - operationId: sasportal.customers.get + /v1alpha1/nodes/{nodesId}/devices: + parameters: *ref_1 + post: + description: Creates a device under a node or customer. + operationId: sasportal.nodes.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3636,18 +3597,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - /v1alpha1/customers:listLegacyOrganizations: - parameters: *ref_1 get: - description: Returns a list of legacy organizations. - operationId: sasportal.customers.listLegacyOrganizations + description: Lists devices under a node or customer. + operationId: sasportal.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3663,20 +3622,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' - parameters: [] - /v1alpha1/customers:provisionDeployment: + $ref: '#/components/schemas/SasPortalListDevicesResponse' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: parameters: *ref_1 post: - description: >- - Creates a new SAS deployment through the GCP workflow. Creates a SAS - organization if an organization match is not found. - operationId: sasportal.customers.provisionDeployment + description: Moves a device under another node or customer. + operationId: sasportal.nodes.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3692,21 +3667,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' - parameters: [] - /v1alpha1/customers:setupSasAnalytics: + $ref: '#/components/schemas/SasPortalOperation' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: parameters: *ref_1 - post: - description: >- - Setups the a GCP Project to receive SAS Analytics messages via GCP - Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and - BigQuery tables are created automatically as part of this service. - operationId: sasportal.customers.setupSasAnalytics + patch: + description: Updates a signed device. + operationId: sasportal.nodes.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3722,18 +3704,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers/{customersId}/devices/{devicesId}: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices:createSigned: parameters: *ref_1 - patch: - description: Updates a device. - operationId: sasportal.customers.devices.patch + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3752,23 +3744,20 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: devicesId + name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: sasportal.customers.devices.delete + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.deployments.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3784,21 +3773,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 get: - description: Gets details about a device. - operationId: sasportal.customers.devices.get + description: Lists devices under a node or customer. + operationId: sasportal.nodes.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3814,23 +3805,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string post: description: Creates a device under a node or customer. - operationId: sasportal.customers.devices.create + operationId: sasportal.nodes.deployments.devices.create requestBody: content: application/json: @@ -3854,13 +3856,20 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments: + parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.devices.list + description: Lists deployments. + operationId: sasportal.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3876,13 +3885,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: @@ -3892,20 +3905,16 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: parameters: *ref_1 post: - description: Signs a device. - operationId: sasportal.customers.devices.signDevice + description: Moves a deployment under another node or customer. + operationId: sasportal.nodes.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3921,28 +3930,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: - parameters: *ref_1 - post: - description: Moves a device under another node or customer. - operationId: sasportal.customers.devices.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: Returns a requested deployment. + operationId: sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3958,28 +3962,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + delete: + description: Deletes a deployment. + operationId: sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3995,23 +3992,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: nodesId + required: true + schema: + type: string + - in: path + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: - parameters: *ref_1 patch: - description: Updates a signed device. - operationId: sasportal.customers.devices.updateSigned + description: Updates an existing deployment. + operationId: sasportal.nodes.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4027,23 +4027,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: parameters: *ref_1 - delete: - description: Deletes a deployment. - operationId: sasportal.customers.deployments.delete + get: + description: Returns a requested node. + operationId: sasportal.nodes.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4059,21 +4064,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - get: - description: Returns a requested deployment. - operationId: sasportal.customers.deployments.get + patch: + description: Updates an existing node. + operationId: sasportal.nodes.nodes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4089,26 +4099,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - patch: - description: Updates an existing deployment. - operationId: sasportal.customers.deployments.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a node. + operationId: sasportal.nodes.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4124,33 +4134,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers/{customersId}/deployments: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: parameters: *ref_1 post: - description: Creates a new deployment. - operationId: sasportal.customers.deployments.create + description: Moves a node under another node or customer. + operationId: sasportal.nodes.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4166,16 +4171,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: nodesId + required: true + schema: + type: string + - in: path + name: nodesId1 required: true schema: type: string + /v1alpha1/nodes/{nodesId}/nodes: + parameters: *ref_1 get: - description: Lists deployments. - operationId: sasportal.customers.deployments.list + description: Lists nodes. + operationId: sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4191,10 +4203,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -4211,16 +4223,14 @@ paths: name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: - parameters: *ref_1 post: - description: Moves a deployment under another node or customer. - operationId: sasportal.customers.deployments.move + description: Creates a new node. + operationId: sasportal.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4236,28 +4246,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.deployments.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + get: + description: Lists nodes. + operationId: sasportal.nodes.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4273,28 +4273,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: - parameters: *ref_1 + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.deployments.devices.create + description: Creates a new node. + operationId: sasportal.nodes.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4310,21 +4321,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + parameters: *ref_1 get: description: Lists devices under a node or customer. - operationId: sasportal.customers.deployments.devices.list + operationId: sasportal.nodes.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4343,12 +4356,12 @@ paths: $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string @@ -4365,11 +4378,14 @@ paths: schema: type: integer format: int32 - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: - parameters: *ref_1 - get: - description: Lists deployments. - operationId: sasportal.customers.nodes.deployments.list + post: + description: Creates a device under a node or customer. + operationId: sasportal.nodes.nodes.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4385,34 +4401,60 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string + - in: path + name: nodesId1 + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.nodes.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' + parameters: - in: path name: nodesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: nodesId1 + required: true schema: type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + parameters: *ref_1 post: description: Creates a new deployment. - operationId: sasportal.customers.nodes.deployments.create + operationId: sasportal.nodes.nodes.deployments.create requestBody: content: application/json: @@ -4436,20 +4478,18 @@ paths: $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: nodesId1 required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: - parameters: *ref_1 get: - description: Lists nodes. - operationId: sasportal.customers.nodes.nodes.list + description: Lists deployments. + operationId: sasportal.nodes.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4465,22 +4505,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: nodesId1 required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: @@ -4490,14 +4526,15 @@ paths: name: filter schema: type: string - post: - description: Creates a new node. - operationId: sasportal.customers.nodes.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + - in: query + name: pageToken + schema: + type: string + /v1alpha1/nodes/{nodesId}: + parameters: *ref_1 + get: + description: Returns a requested node. + operationId: sasportal.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4515,26 +4552,21 @@ paths: schema: $ref: '#/components/schemas/SasPortalNode' parameters: - - in: path - name: customersId - required: true - schema: - type: string - in: path name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + /v1alpha1/installer:generateSecret: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.nodes.devices.create + description: Generates a secret to be used with the ValidateInstaller. + operationId: sasportal.installer.generateSecret requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4550,21 +4582,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.nodes.devices.list + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + parameters: [] + /v1alpha1/installer:validate: + parameters: *ref_1 + post: + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: sasportal.installer.validate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4580,41 +4609,55 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + parameters: [] + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + parameters: *ref_1 + post: + description: Moves a device under another node or customer. + operationId: sasportal.deployments.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.nodes.devices.createSigned + patch: + description: Updates a signed device. + operationId: sasportal.deployments.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4633,25 +4676,25 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: parameters: *ref_1 patch: - description: Updates an existing node. - operationId: sasportal.customers.nodes.patch + description: Updates a device. + operationId: sasportal.deployments.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4667,15 +4710,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string @@ -4685,8 +4728,8 @@ paths: type: string format: google-fieldmask get: - description: Returns a requested node. - operationId: sasportal.customers.nodes.get + description: Gets details about a device. + operationId: sasportal.deployments.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4702,21 +4745,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string delete: - description: Deletes a node. - operationId: sasportal.customers.nodes.delete + description: Deletes a device. + operationId: sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4735,25 +4778,25 @@ paths: $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: Creates a new node. - operationId: sasportal.customers.nodes.create + description: Signs a device. + operationId: sasportal.deployments.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4769,61 +4812,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - get: - description: Lists nodes. - operationId: sasportal.customers.nodes.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' - parameters: - in: path - name: customersId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + /v1alpha1/deployments/{deploymentsId}: parameters: *ref_1 - post: - description: Moves a node under another node or customer. - operationId: sasportal.customers.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + get: + description: Returns a requested deployment. + operationId: sasportal.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4839,15 +4844,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId + name: deploymentsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml index bd557b5c..fa559744 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml @@ -10,7 +10,7 @@ info: Provides convenience while improving security. version: v1 x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/secret-manager/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml b/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml index cb6c1693..ba51d7e3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml @@ -9,8 +9,8 @@ info: Security Command Center API provides access to temporal views of assets and findings within an organization. version: v1 - x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240918' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/security-command-center servers: @@ -4572,6 +4572,9 @@ components: The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". type: string + displayName: + description: The display name of the Azure tenant. + type: string ResourcePath: id: ResourcePath description: >- @@ -8791,6 +8794,9 @@ components: The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". type: string + displayName: + description: The display name of the Azure tenant. + type: string GoogleCloudSecuritycenterV2ResourcePath: id: GoogleCloudSecuritycenterV2ResourcePath description: >- diff --git a/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml index e9829abe..bac22943 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml @@ -8,7 +8,7 @@ info: description: Manages the service consumers of a Service Infrastructure service. version: v1 x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/service-consumer-management/docs/overview servers: @@ -34,509 +34,572 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Endpoint: - description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true + SearchTenancyUnitsResponse: + id: SearchTenancyUnitsResponse + description: Response for the search query. + properties: + nextPageToken: + type: string + description: Pagination token for large results. + tenancyUnits: + items: + $ref: '#/components/schemas/TenancyUnit' + type: array + description: Tenancy Units matching the request. + type: object + CppSettings: + id: CppSettings type: object properties: - allowCors: - type: boolean + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + description: Settings for C++ client libraries. + ServiceAccountConfig: + type: object + properties: + tenantProjectRoles: + items: + type: string + description: Roles for the associated service account for the tenant project. + type: array + accountId: description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - target: + ID of the IAM service account to be created in tenant project. The + email format of the service account is "@.iam.gserviceaccount.com". + This account ID must be unique within tenant project and service + producers have to guarantee it. The ID must be 6-30 characters long, + and match the following regular expression: + `[a-z]([-a-z0-9]*[a-z0-9])`. type: string + id: ServiceAccountConfig + description: Describes the service account configuration for the tenant project. + Logging: + properties: + producerDestinations: description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". - name: - description: The canonical name of this endpoint. - type: string - aliases: + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. + items: + $ref: '#/components/schemas/LoggingDestination' type: array + consumerDestinations: description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. items: - type: string - id: Endpoint - TenantProjectConfig: + $ref: '#/components/schemas/LoggingDestination' + type: array + type: object description: >- - This structure defines a tenant project to be added to the specified - tenancy unit and its initial configuration and properties. A project - lien is created for the tenant project to prevent the tenant project - from being deleted accidentally. The lien is deleted as part of tenant - project removal. + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history + id: Logging + Option: properties: - labels: - description: Labels that are applied to this project. + value: type: object + description: >- + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. additionalProperties: - type: string - tenantProjectPolicy: - $ref: '#/components/schemas/TenantProjectPolicy' - description: Describes ownership and policies for the new tenant project. - billingConfig: - description: Billing account properties. The billing account must be specified. - $ref: '#/components/schemas/BillingConfig' - serviceAccountConfig: - description: Configuration for the IAM service account on the tenant project. - $ref: '#/components/schemas/ServiceAccountConfig' - services: - items: - type: string + description: Properties of the object. Contains field @type with type URL. + type: any + name: + type: string description: >- - Google Cloud API names of services that are activated on this - project during provisioning. If any of these services can't be - activated, the request fails. For example: - 'compute.googleapis.com','cloudfunctions.googleapis.com' - type: array - folder: + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. + id: Option + type: object + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + AuthRequirement: + properties: + providerId: + description: >- + id from authentication provider. Example: provider_id: + bookstore_auth + type: string + audiences: type: string description: >- - Folder where project in this tenancy unit must be located This - folder must have been previously created with the required - permissions for the caller to create and configure a project in it. - Valid folder resource names have the format - `folders/{folder_number}` (for example, `folders/123456`). - id: TenantProjectConfig + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com type: object - V1Beta1ImportProducerQuotaPoliciesResponse: - id: V1Beta1ImportProducerQuotaPoliciesResponse - description: Response message for ImportProducerQuotaPolicies + id: AuthRequirement + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + V1RefreshConsumerResponse: + id: V1RefreshConsumerResponse + description: >- + Response message for the `RefreshConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. type: object - properties: - policies: - items: - $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' - description: The policies that were created from the imported data. - type: array - V1Beta1BatchCreateProducerOverridesResponse: + properties: {} + AuthenticationRule: type: object - id: V1Beta1BatchCreateProducerOverridesResponse + id: AuthenticationRule properties: - overrides: - description: The overrides that were created. - items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' + oauth: + description: The requirements for OAuth credentials. + $ref: '#/components/schemas/OAuthRequirements' + requirements: + description: Requirements for additional authentication providers. type: array - description: Response message for BatchCreateProducerOverrides - MetricRule: - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - properties: + items: + $ref: '#/components/schemas/AuthRequirement' selector: description: >- Selects the methods to which this rule applies. Refer to selector for syntax details. type: string - metricCosts: + allowWithoutCredential: + type: boolean description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - type: object - additionalProperties: - format: int64 - type: string - id: MetricRule + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + description: >- + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + NodeSettings: + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + id: NodeSettings type: object + description: Settings for Node client libraries. V1DisableConsumerResponse: type: object - properties: {} id: V1DisableConsumerResponse + properties: {} description: >- Response message for the `DisableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. - Usage: + Http: type: object - id: Usage properties: - producerNotificationChannel: - description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. - type: string rules: type: array items: - $ref: '#/components/schemas/UsageRule' + $ref: '#/components/schemas/HttpRule' description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - requirements: + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + fullyDecodeReservedExpansion: + type: boolean description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. - type: array - items: - type: string - description: Configuration controlling usage of a service. - Operation: + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + id: Http description: >- - This resource represents a long-running operation that is the result of - a network API call. + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + V1GenerateDefaultIdentityResponse: properties: - response: - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + attachStatus: type: string - error: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - metadata: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + enum: + - ATTACH_STATUS_UNSPECIFIED + - ATTACHED + - ATTACH_SKIPPED + - PREVIOUSLY_ATTACHED + - ATTACH_DENIED_BY_ORG_POLICY + enumDescriptions: + - Indicates that the AttachStatus was not set. + - >- + The default identity was attached to a role successfully in this + request. + - >- + The request specified that no attempt should be made to attach the + role. + - >- + Role was attached to the consumer project at some point in time. + Tenant manager doesn't make assertion about the current state of + the identity with respect to the consumer. Role attachment should + happen only once after activation and cannot be reattached after + customer removes it. (go/si-attach-role) + - >- + Role attachment was denied in this request by customer set org + policy. (go/si-attach-role) description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - done: + Status of the role attachment. Under development + (go/si-attach-role), currently always return + ATTACH_STATUS_UNSPECIFIED) + role: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - id: Operation - type: object - EnumValue: - type: object - properties: - name: + Role attached to consumer project. Empty if not attached in this + request. (Under development, currently always return empty.) type: string - description: Enum value name. - options: - items: - $ref: '#/components/schemas/Option' - type: array - description: Protocol buffer options. - number: - description: Enum value number. - format: int32 - type: integer - description: Enum value definition. - id: EnumValue - AuthRequirement: - id: AuthRequirement - type: object + identity: + $ref: '#/components/schemas/V1DefaultIdentity' + description: DefaultIdentity that was created or retrieved. description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + Response message for the `GenerateDefaultIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: V1GenerateDefaultIdentityResponse + type: object + TenantResource: + description: Resource constituting the TenancyUnit. + id: TenantResource properties: - audiences: + tag: type: string + description: Unique per single tenancy unit. + status: + enum: + - STATUS_UNSPECIFIED + - PENDING_CREATE + - ACTIVE + - PENDING_DELETE + - FAILED + - DELETED + description: Status of tenant resource. + enumDescriptions: + - Unspecified status is the default unset value. + - Creation of the tenant resource is ongoing. + - Active resource. + - Deletion of the resource is ongoing. + - Tenant resource creation or deletion has failed. + - Tenant resource has been deleted. + type: string + resource: + readOnly: true description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - providerId: - description: >- - id from authentication provider. Example: provider_id: - bookstore_auth + Output only. @OutputOnly Identifier of the tenant resource. For + cloud projects, it is in the form 'projects/{number}'. For example + 'projects/123456'. type: string - PhpSettings: - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - description: Settings for Php client libraries. type: object - id: PhpSettings - BillingConfig: + MethodPolicy: properties: - billingAccount: + requestPolicies: + type: array + description: Policies that are applicable to the request message. + items: + $ref: '#/components/schemas/FieldPolicy' + selector: type: string description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. - description: Describes the billing configuration for a new tenant project. + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . + description: Defines policies applying to an RPC method. + id: MethodPolicy type: object - id: BillingConfig - Service: - id: Service + CreateTenancyUnitRequest: + id: CreateTenancyUnitRequest + description: >- + Request to create a tenancy unit for a service consumer of a managed + service. properties: - title: - description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. + tenancyUnitId: type: string - endpoints: - description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. - items: - $ref: '#/components/schemas/Endpoint' - type: array - monitoredResources: - type: array - description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - sourceInfo: - $ref: '#/components/schemas/SourceInfo' - description: >- - Output only. The source information for this configuration if - available. - name: description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - type: string - types: - items: - $ref: '#/components/schemas/Type' - type: array + Optional. Optional service producer-provided identifier of the + tenancy unit. Must be no longer than 40 characters and preferably + URI friendly. If it isn't provided, a UID for the tenancy unit is + automatically generated. The identifier must be unique across a + managed service. If the tenancy unit already exists for the managed + service and service consumer pair, calling `CreateTenancyUnit` + returns the existing tenancy unit if the provided identifier is + identical or empty, otherwise the call fails. + type: object + Endpoint: + id: Endpoint + description: >- + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + properties: + target: + type: string description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - enums: - items: - $ref: '#/components/schemas/Enum' + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". + name: + description: The canonical name of this endpoint. + type: string + allowCors: + description: >- + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. + type: boolean + aliases: type: array description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum - metrics: + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. items: - $ref: '#/components/schemas/MetricDescriptor' - type: array - description: Defines the metrics used by this service. - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - apis: + type: string + type: object + V1Beta1BatchCreateProducerOverridesResponse: + properties: + overrides: + description: The overrides that were created. type: array items: - $ref: '#/components/schemas/Api' - description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. - publishing: - $ref: '#/components/schemas/Publishing' - description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - producerProjectId: + $ref: '#/components/schemas/V1Beta1QuotaOverride' + id: V1Beta1BatchCreateProducerOverridesResponse + description: Response message for BatchCreateProducerOverrides + type: object + BillingDestination: + id: BillingDestination + type: object + properties: + monitoredResource: type: string - description: The Google project that owns this service. - configVersion: description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - format: uint32 - type: integer - systemTypes: + The monitored resource type. The type must be defined in + Service.monitored_resources section. + metrics: + type: array items: - $ref: '#/components/schemas/Type' + type: string description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - type: array - id: + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + LabelDescriptor: + properties: + key: + description: The label key. type: string - description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - customError: - description: Custom error configuration. - $ref: '#/components/schemas/CustomError' - context: - $ref: '#/components/schemas/Context' - description: Context configuration. - control: - description: Configuration for the service control plane. - $ref: '#/components/schemas/Control' - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - billing: - description: Billing configuration. - $ref: '#/components/schemas/Billing' - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - logs: - type: array - items: - $ref: '#/components/schemas/LogDescriptor' - description: Defines the logs used by this service. - backend: - $ref: '#/components/schemas/Backend' - description: API backend configuration. + description: + description: A human-readable description for the label. + type: string + valueType: + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + description: The type of data that can be assigned to the label. + type: string + enum: + - STRING + - BOOL + - INT64 + id: LabelDescriptor type: object - description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - MonitoredResourceDescriptor: - id: MonitoredResourceDescriptor - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. + description: A description of a label. + Method: type: object + id: Method properties: - displayName: + responseTypeUrl: type: string - description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. - name: - description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. + description: The URL of the output message type. + requestTypeUrl: + description: A URL of the input message type. type: string - type: + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: Any metadata attached to the method. + syntax: type: string - description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - labels: - description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. + description: The source syntax of this method. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + name: + type: string + description: The simple name of this method. + responseStreaming: + type: boolean + description: If true, the response is streamed. + requestStreaming: + description: If true, the request is streamed. + type: boolean + description: Method represents a method of an API interface. + EnumValue: + description: Enum value definition. + type: object + id: EnumValue + properties: + name: + description: Enum value name. + type: string + options: + description: Protocol buffer options. items: - $ref: '#/components/schemas/LabelDescriptor' + $ref: '#/components/schemas/Option' type: array + number: + description: Enum value number. + format: int32 + type: integer + CustomHttpPattern: + description: A custom pattern is used for defining custom HTTP verb. + properties: + path: + type: string + description: The path matched by this custom verb. + kind: + type: string + description: The name of this custom HTTP verb. + type: object + id: CustomHttpPattern + FieldPolicy: + id: FieldPolicy + properties: + resourcePermission: + description: >- + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". + type: string + selector: + description: >- + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". + type: string + resourceType: + type: string + description: >- + Specifies the resource type for the resource referred to by the + field. + type: object + description: >- + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. + AddTenantProjectRequest: + properties: + projectConfig: + $ref: '#/components/schemas/TenantProjectConfig' + description: >- + Configuration of the new tenant project to be added to tenancy unit + resources. + tag: + description: >- + Required. Tag of the added project. Must be less than 128 + characters. Required. + type: string + id: AddTenantProjectRequest + description: >- + Request to add a newly created and configured tenant project to a + tenancy unit. + type: object + MetricDescriptor: + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + properties: + metricKind: + type: string + description: >- + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + displayName: + description: >- + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + type: string launchStage: - description: Optional. The launch stage of the monitored resource definition. + description: Optional. The launch stage of the metric definition. enum: - LAUNCH_STAGE_UNSPECIFIED - UNIMPLEMENTED @@ -546,6 +609,7 @@ components: - BETA - GA - DEPRECATED + type: string enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -584,283 +648,528 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. + type: + description: >- + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" type: string - description: + labels: + type: array description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - type: string - HttpRule: - description: >- - gRPC Transcoding gRPC Transcoding is a feature for mapping between a - gRPC method and one or more HTTP REST endpoints. It allows developers to - build a single API service that supports both gRPC APIs and REST APIs. - Many systems, including [Google - APIs](https://github.com/googleapis/googleapis), [Cloud - Endpoints](https://cloud.google.com/endpoints), [gRPC - Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - and use it for large scale production services. `HttpRule` defines the - schema of the gRPC/REST mapping. The mapping specifies how different - portions of the gRPC request message are mapped to the URL path, URL - query parameters, and HTTP request body. It also controls how the gRPC - response message is mapped to the HTTP response body. `HttpRule` is - typically specified as an `google.api.http` annotation on the gRPC - method. Each mapping specifies a URL path template and an HTTP method. - The path template may refer to one or more fields in the gRPC request - message, as long as each field is a non-repeated field with a primitive - (non-message) type. The path template controls how fields of the request - message are mapped to the URL path. Example: service Messaging { rpc - GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message - GetMessageRequest { string name = 1; // Mapped to URL path. } message - Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request - message which are not bound by the path template automatically become - HTTP query parameters if there is no HTTP request body. For example: - service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) - { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } - message GetMessageRequest { message SubMessage { string subfield = 1; } - string message_id = 1; // Mapped to URL path. int64 revision = 2; // - Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped - to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC - mapping as below: - HTTP: `GET - /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: - `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - "foo"))` Note that fields which are mapped to URL query parameters must - have a primitive type or a repeated primitive type or a non-repeated - message type. In the case of a repeated type, the parameter can be - repeated in the URL as `...?param=A¶m=B`. In the case of a message - type, each field of the message is mapped to a separate parameter, such - as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request - body, the `body` field specifies the mapping. Consider a REST update - method on the message resource collection: service Messaging { rpc - UpdateMessage(UpdateMessageRequest) returns (Message) { option - (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" - }; } } message UpdateMessageRequest { string message_id = 1; // mapped - to the URL Message message = 2; // mapped to the body } The following - HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: - HTTP: - `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The - special name `*` can be used in the body mapping to define that every - field not bound by the path template should be mapped to the request - body. This enables the following alternative definition of the update - method: service Messaging { rpc UpdateMessage(Message) returns (Message) - { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: - "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH - /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using - `*` in the body mapping, it is not possible to have HTTP parameters, as - all fields not bound by the path end in the body. This makes this option - more rarely used in practice when defining REST APIs. The common usage - of `*` is in custom methods which don't use the URL at all for - transferring data. It is possible to define multiple HTTP methods for - one RPC by using the `additional_bindings` option. Example: service - Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/messages/{message_id}" - additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } - }; } } message GetMessageRequest { string message_id = 1; string user_id - = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: - HTTP: `GET /v1/messages/123456` - gRPC: - `GetMessage(message_id: "123456")` - HTTP: `GET - /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" - message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields - (recursive expansion nested messages in the request message) are - classified into three categories: - Fields referred by the path - template. They are passed via the URL path. - Fields referred by the - HttpRule.body. They are passed via the HTTP request body. - All other - fields are passed via the URL query parameters, and the parameter name - is the field path in the request message. A repeated field can be - represented as multiple query parameters under the same name. 2. If - HttpRule.body is "*", there is no URL query parameter, all fields are - passed via URL path and HTTP request body. 3. If HttpRule.body is - omitted, there is no HTTP request body, all fields are passed via URL - path and URL query parameters. Path template syntax Template = "/" - Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | - "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] - "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax - `*` matches a single URL path segment. The syntax `**` matches zero or - more URL path segments, which must be the last part of the URL path - except the `Verb`. The syntax `Variable` matches part of the URL path as - specified by its template. A variable template must not contain other - variables. If a variable matches a single path segment, its template may - be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax - `LITERAL` matches literal text in the URL path. If the `LITERAL` - contains any reserved character, such characters should be - percent-encoded before the matching. If a variable contains exactly one - path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is - expanded into a URL path on the client side, all characters except - `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse - decoding. Such variables show up in the [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{var}`. If a variable contains multiple path segments, such as - `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a - URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` - are percent-encoded. The server side does the reverse decoding, except - "%2F" and "%2f" are left unchanged. Such variables show up in the - [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. Using gRPC API Service Configuration gRPC API Service - Configuration (service config) is a configuration language for - configuring a gRPC service to become a user-facing product. The service - config is simply the YAML representation of the `google.api.Service` - proto message. As an alternative to annotating your proto file, you can - configure gRPC transcoding in your service config YAML files. You do - this by specifying a `HttpRule` that maps the gRPC method to a REST - endpoint, achieving the same effect as the proto annotation. This can be - particularly useful if you have a proto that is reused in multiple - services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. The - following example selects a gRPC method and applies an `HttpRule` to it: - http: rules: - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC - Transcoding is used to map a gRPC to JSON REST endpoints, the proto to - JSON conversion must follow the [proto3 - specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - While the single segment variable follows the semantics of [RFC - 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - Expansion, the multi segment variable **does not** follow RFC 6570 - Section 3.2.3 Reserved Expansion. The reason is that the Reserved - Expansion does not expand special characters like `?` and `#`, which - would lead to invalid URLs. As the result, gRPC Transcoding uses a - custom encoding for multi segment variables. The path variables **must - not** refer to any repeated or mapped field, because client libraries - are not capable of handling such variable expansion. The path variables - **must not** capture the leading "/" character. The reason is that the - most common use case "{var}" does not capture the leading "/" character. - For consistency, all path variables must share the same behavior. - Repeated message fields must not be mapped to URL query parameters, - because no client library can support such complicated mapping. If an - API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. - id: HttpRule - properties: - get: - type: string - description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - additionalBindings: - type: array - description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - items: - $ref: '#/components/schemas/HttpRule' - body: + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. + items: + $ref: '#/components/schemas/LabelDescriptor' + valueType: type: string + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. - responseBody: + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + unit: description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. - type: string - patch: - type: string - description: Maps to HTTP PATCH. Used for updating a resource. - put: + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). type: string - description: Maps to HTTP PUT. Used for replacing a resource. - custom: - $ref: '#/components/schemas/CustomHttpPattern' - description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - delete: + metadata: + description: Optional. Metadata which can be used to guide usage of the metric. + $ref: '#/components/schemas/MetricDescriptorMetadata' + name: type: string - description: Maps to HTTP DELETE. Used for deleting a resource. - post: + description: The resource name of the metric descriptor. + description: type: string description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - selector: - type: string + A detailed description of the metric, which can be used in + documentation. + monitoredResourceTypes: + type: array + items: + type: string description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + id: MetricDescriptor + type: object + BillingConfig: + id: BillingConfig type: object - Publishing: properties: - docTagPrefix: + billingAccount: description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - type: string - githubLabel: + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. type: string + description: Describes the billing configuration for a new tenant project. + V1Beta1GenerateServiceIdentityResponse: + properties: + identity: + $ref: '#/components/schemas/V1Beta1ServiceIdentity' + description: ServiceIdentity that was created or retrieved. + description: >- + Response message for the `GenerateServiceIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: V1Beta1GenerateServiceIdentityResponse + type: object + Operation: + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: Operation + properties: + done: description: >- - GitHub label to apply to issues and pull requests opened for this - API. - apiShortName: + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + $ref: '#/components/schemas/Status' description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". - type: string - newIssueUri: - type: string + The error result of the operation in case of failure or + cancellation. + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - restReferenceDocumentationUri: - type: string + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + response: description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - organization: - description: For whom the client library is being published. - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - documentationUri: + type: object + Authentication: + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + id: Authentication + type: object + properties: + providers: + items: + $ref: '#/components/schemas/AuthProvider' + type: array + description: Defines a set of authentication providers that a service supports. + rules: + type: array + items: + $ref: '#/components/schemas/AuthenticationRule' + description: >- + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + HttpRule: + description: >- + gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC method and one or more HTTP REST endpoints. It allows developers to + build a single API service that supports both gRPC APIs and REST APIs. + Many systems, including [Google + APIs](https://github.com/googleapis/googleapis), [Cloud + Endpoints](https://cloud.google.com/endpoints), [gRPC + Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + and use it for large scale production services. `HttpRule` defines the + schema of the gRPC/REST mapping. The mapping specifies how different + portions of the gRPC request message are mapped to the URL path, URL + query parameters, and HTTP request body. It also controls how the gRPC + response message is mapped to the HTTP response body. `HttpRule` is + typically specified as an `google.api.http` annotation on the gRPC + method. Each mapping specifies a URL path template and an HTTP method. + The path template may refer to one or more fields in the gRPC request + message, as long as each field is a non-repeated field with a primitive + (non-message) type. The path template controls how fields of the request + message are mapped to the URL path. Example: service Messaging { rpc + GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message + GetMessageRequest { string name = 1; // Mapped to URL path. } message + Message { string text = 1; // The resource content. } This enables an + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + "foo"))` Note that fields which are mapped to URL query parameters must + have a primitive type or a repeated primitive type or a non-repeated + message type. In the case of a repeated type, the parameter can be + repeated in the URL as `...?param=A¶m=B`. In the case of a message + type, each field of the message is mapped to a separate parameter, such + as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request + body, the `body` field specifies the mapping. Consider a REST update + method on the message resource collection: service Messaging { rpc + UpdateMessage(UpdateMessageRequest) returns (Message) { option + (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" + }; } } message UpdateMessageRequest { string message_id = 1; // mapped + to the URL Message message = 2; // mapped to the body } The following + HTTP JSON to RPC mapping is enabled, where the representation of the + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The + special name `*` can be used in the body mapping to define that every + field not bound by the path template should be mapped to the request + body. This enables the following alternative definition of the update + method: service Messaging { rpc UpdateMessage(Message) returns (Message) + { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: + "*" }; } } message Message { string message_id = 1; string text = 2; } + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using + `*` in the body mapping, it is not possible to have HTTP parameters, as + all fields not bound by the path end in the body. This makes this option + more rarely used in practice when defining REST APIs. The common usage + of `*` is in custom methods which don't use the URL at all for + transferring data. It is possible to define multiple HTTP methods for + one RPC by using the `additional_bindings` option. Example: service + Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/messages/{message_id}" + additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } + }; } } message GetMessageRequest { string message_id = 1; string user_id + = 2; } This enables the following two alternative HTTP JSON to RPC + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{var}`. If a variable contains multiple path segments, such as + `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a + URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` + are percent-encoded. The server side does the reverse decoding, except + "%2F" and "%2f" are left unchanged. Such variables show up in the + [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{+var}`. Using gRPC API Service Configuration gRPC API Service + Configuration (service config) is a configuration language for + configuring a gRPC service to become a user-facing product. The service + config is simply the YAML representation of the `google.api.Service` + proto message. As an alternative to annotating your proto file, you can + configure gRPC transcoding in your service config YAML files. You do + this by specifying a `HttpRule` that maps the gRPC method to a REST + endpoint, achieving the same effect as the proto annotation. This can be + particularly useful if you have a proto that is reused in multiple + services. Note that any transcoding specified in the service config will + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC + Transcoding is used to map a gRPC to JSON REST endpoints, the proto to + JSON conversion must follow the [proto3 + specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + While the single segment variable follows the semantics of [RFC + 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + Expansion, the multi segment variable **does not** follow RFC 6570 + Section 3.2.3 Reserved Expansion. The reason is that the Reserved + Expansion does not expand special characters like `?` and `#`, which + would lead to invalid URLs. As the result, gRPC Transcoding uses a + custom encoding for multi segment variables. The path variables **must + not** refer to any repeated or mapped field, because client libraries + are not capable of handling such variable expansion. The path variables + **must not** capture the leading "/" character. The reason is that the + most common use case "{var}" does not capture the leading "/" character. + For consistency, all path variables must share the same behavior. + Repeated message fields must not be mapped to URL query parameters, + because no client library can support such complicated mapping. If an + API needs to use a JSON array for request or response body, it can map + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. + id: HttpRule + type: object + properties: + patch: type: string + description: Maps to HTTP PATCH. Used for updating a resource. + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. + type: string + put: + description: Maps to HTTP PUT. Used for replacing a resource. + type: string + responseBody: description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - protoReferenceDocumentationUri: + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + type: string + custom: + description: >- + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + $ref: '#/components/schemas/CustomHttpPattern' + additionalBindings: + description: >- + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). + type: array + items: + $ref: '#/components/schemas/HttpRule' + post: + description: >- + Maps to HTTP POST. Used for creating a resource or performing an + action. + type: string + get: + type: string + description: >- + Maps to HTTP GET. Used for listing and getting information about + resources. + body: + description: >- + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + type: string + selector: + type: string + description: >- + Selects a method to which this rule applies. Refer to selector for + syntax details. + DeleteTenantProjectRequest: + description: Request message to delete tenant project resource from the tenancy unit. + properties: + tag: + description: Required. Tag of the resource within the tenancy unit. + type: string + id: DeleteTenantProjectRequest + type: object + Control: + properties: + methodPolicies: + type: array + items: + $ref: '#/components/schemas/MethodPolicy' + description: Defines policies applying to the API methods of the service. + environment: + type: string + description: >- + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + id: Control + type: object + RemoveTenantProjectRequest: + properties: + tag: + type: string + description: Required. Tag of the resource within the tenancy unit. + description: >- + Request message to remove a tenant project resource from the tenancy + unit. + type: object + id: RemoveTenantProjectRequest + UsageRule: + description: >- + Usage configuration rules for the service. NOTE: Under development. Use + this rule to configure unregistered calls for the service. Unregistered + calls are calls that do not contain consumer project identity. (Example: + calls that do not contain an API key). By default, API methods do not + allow unregistered calls, and each method call must be identified by a + consumer project identity. Use this rule to allow/disallow unregistered + calls. Example of an API that wants to allow unregistered calls for + entire service. usage: rules: - selector: "*" allow_unregistered_calls: + true Example of a method that wants to allow unregistered calls. usage: + rules: - selector: "google.example.library.v1.LibraryService.CreateBook" + allow_unregistered_calls: true + id: UsageRule + properties: + allowUnregisteredCalls: + type: boolean + description: >- + If true, the selected method allows unregistered calls, e.g. calls + that don't identify any user or application. + skipServiceControl: + description: >- + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + type: boolean + selector: description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string + type: object + Publishing: + properties: librarySettings: + type: array description: >- Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded. - type: array items: $ref: '#/components/schemas/ClientLibrarySettings' + apiShortName: + type: string + description: >- + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". + restReferenceDocumentationUri: + description: >- + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + type: string + protoReferenceDocumentationUri: + type: string + description: >- + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc methodSettings: type: array description: >- @@ -868,85 +1177,251 @@ components: use the long-running operation pattern. items: $ref: '#/components/schemas/MethodSettings' + newIssueUri: + type: string + description: >- + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + githubLabel: + type: string + description: >- + GitHub label to apply to issues and pull requests opened for this + API. codeownerGithubTeams: + items: + type: string description: >- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API. - items: - type: string type: array - type: object + documentationUri: + type: string + description: >- + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + organization: + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + enumDescriptions: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + description: For whom the client library is being published. + type: string + docTagPrefix: + type: string + description: >- + A prefix used in sample code when demarking regions to be included + in documentation. + id: Publishing description: >- This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config. - id: Publishing - V1GenerateServiceAccountResponse: - properties: - account: - $ref: '#/components/schemas/V1ServiceAccount' - description: ServiceAccount that was created or retrieved. - description: >- - Response message for the `GenerateServiceAccount` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. type: object - id: V1GenerateServiceAccountResponse + ApplyTenantProjectConfigRequest: + description: Request to apply configuration to an existing tenant project. + id: ApplyTenantProjectConfigRequest + type: object + properties: + tag: + description: >- + Required. Tag of the project. Must be less than 128 characters. + Required. + type: string + projectConfig: + $ref: '#/components/schemas/TenantProjectConfig' + description: Configuration that should be applied to the existing tenant project. Enum: + type: object id: Enum description: Enum type definition. properties: - edition: + name: type: string - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - options: + description: Enum type name. + enumvalue: + items: + $ref: '#/components/schemas/EnumValue' + description: Enum value definitions. type: array + options: items: $ref: '#/components/schemas/Option' + type: array description: Protocol buffer options. - name: + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + edition: type: string - description: Enum type name. + description: >- + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. enum: - SYNTAX_PROTO2 - SYNTAX_PROTO3 - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. type: string description: The source syntax. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - enumvalue: + Field: + properties: + kind: + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + description: The field type. + type: string + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + oneofIndex: + format: int32 + type: integer + description: >- + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + typeUrl: + type: string + description: >- + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + packed: + type: boolean + description: Whether to use alternative packed wire representation. + jsonName: + description: The field JSON name. + type: string + number: + format: int32 + description: The field number. + type: integer + defaultValue: + type: string + description: >- + The string value of the default value of this field. Proto2 syntax + only. + options: items: - $ref: '#/components/schemas/EnumValue' + $ref: '#/components/schemas/Option' + description: The protocol buffer options. type: array - description: Enum value definitions. + name: + description: The field name. + type: string + cardinality: + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + description: The field cardinality. + type: string + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + description: A single field of a message type. + id: Field type: object - DeleteTenantProjectRequest: - description: Request message to delete tenant project resource from the tenancy unit. + SourceInfo: + properties: + sourceFiles: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + description: All files used during config generation. + description: Source information used to create a Service Config + type: object + id: SourceInfo + LongRunning: type: object + description: >- + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + id: LongRunning properties: - tag: + pollDelayMultiplier: + type: number + format: float + description: >- + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + maxPollDelay: + description: >- + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + format: google-duration type: string - description: Required. Tag of the resource within the tenancy unit. - id: DeleteTenantProjectRequest - NodeSettings: - type: object - id: NodeSettings - description: Settings for Node client libraries. - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' + initialPollDelay: + format: google-duration + description: >- + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + type: string + totalPollTimeout: + format: google-duration + type: string + description: 'Total polling timeout. Default value: 5 minutes.' Documentation: - type: object description: >- `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access @@ -977,479 +1452,162 @@ components: collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. - id: Documentation - properties: - rules: - description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - items: - $ref: '#/components/schemas/DocumentationRule' - summary: - type: string - description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. - pages: - type: array - description: The top level pages for the documentation set. - items: - $ref: '#/components/schemas/Page' - overview: - type: string - description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. - sectionOverrides: - items: - $ref: '#/components/schemas/Page' - description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - type: array - serviceRootUrl: - description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. - type: string - documentationRootUrl: - type: string - description: The URL to the root of documentation. - V1Beta1QuotaOverride: - id: V1Beta1QuotaOverride - properties: - unit: - description: >- - The limit unit of the limit to which this override applies. An - example unit would be: `1/{project}/{region}` Note that `{project}` - and `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - type: string - metric: - description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` - type: string - name: - type: string - description: >- - The resource name of the producer override. An example name would - be: - `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` - adminOverrideAncestor: - type: string - description: >- - The resource name of the ancestor that requested the override. For - example: "organizations/12345" or "folders/67890". Used by admin - overrides only. - overrideValue: - description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). - format: int64 - type: string - dimensions: - description: ' If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' - type: object - additionalProperties: - type: string - type: object - description: A quota override - UsageRule: - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true - properties: - allowUnregisteredCalls: - type: boolean - description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - selector: - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - type: string - skipServiceControl: - type: boolean - description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - id: UsageRule - type: object - LoggingDestination: - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - properties: - monitoredResource: - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - type: string - logs: - items: - type: string - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - type: array - id: LoggingDestination - type: object - Page: - properties: - content: - description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. - type: string - name: - description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - type: string - subpages: - items: - $ref: '#/components/schemas/Page' - type: array - description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - id: Page - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - type: object - ExperimentalFeatures: - properties: - restAsyncIoEnabled: - description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. - type: boolean - description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. - type: object - id: ExperimentalFeatures - V1AddVisibilityLabelsResponse: - properties: - labels: - description: >- - The updated set of visibility labels for this consumer on this - service. - items: - type: string - type: array - type: object - description: >- - Response message for the `AddVisibilityLabels` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - id: V1AddVisibilityLabelsResponse - PythonSettings: - id: PythonSettings - description: Settings for Python client libraries. - properties: - experimentalFeatures: - $ref: '#/components/schemas/ExperimentalFeatures' - description: >- - Experimental features to be included during client library - generation. - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object - Api: - type: object properties: - syntax: - description: The source syntax of the service. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - version: + overview: description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. type: string - name: + serviceRootUrl: description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. type: string - mixins: - description: Included interfaces. See Mixin. - type: array + sectionOverrides: + description: >- + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries items: - $ref: '#/components/schemas/Mixin' - methods: + $ref: '#/components/schemas/Page' type: array + documentationRootUrl: + description: The URL to the root of documentation. + type: string + pages: + description: The top level pages for the documentation set. items: - $ref: '#/components/schemas/Method' - description: The methods of this interface, in unspecified order. - options: + $ref: '#/components/schemas/Page' type: array + rules: items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the interface. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: >- - Source context for the protocol buffer service represented by this - message. - id: Api - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. - V1Beta1ServiceIdentity: - type: object - id: V1Beta1ServiceIdentity - properties: - uniqueId: - description: The unique and stable id of the service identity. - type: string - email: - type: string - description: The email address of the service identity. - tag: + $ref: '#/components/schemas/DocumentationRule' + type: array description: >- - The P4 service identity configuration tag. This must be defined in - activation_grants. If not specified when creating the account, the - tag is set to "default". - type: string - name: + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. + summary: type: string description: >- - P4 service identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` - description: A service identity in the Identity and Access Management API. - Http: + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. + id: Documentation + type: object + ExperimentalFeatures: + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. type: object - id: Http properties: - rules: - description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. - type: array - items: - $ref: '#/components/schemas/HttpRule' - fullyDecodeReservedExpansion: + restAsyncIoEnabled: description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. type: boolean - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - V1RefreshConsumerResponse: - id: V1RefreshConsumerResponse - properties: {} - description: >- - Response message for the `RefreshConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - type: object - AuthProvider: - id: AuthProvider + id: ExperimentalFeatures + PolicyBinding: type: object + id: PolicyBinding properties: - jwksUri: - description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - type: string - authorizationUrl: - type: string - description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - id: - type: string - description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - issuer: - description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - type: string - jwtLocations: + members: description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. type: array items: - $ref: '#/components/schemas/JwtLocation' - audiences: + type: string + role: description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. type: string - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - MetricDescriptor: - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. + description: Translates to IAM Policy bindings (without auditing at this level) + Billing: properties: - name: - description: The resource name of the metric descriptor. - type: string - displayName: - type: string - description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - metadata: - $ref: '#/components/schemas/MetricDescriptorMetadata' - description: Optional. Metadata which can be used to guide usage of the metric. - type: - description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - type: string - labels: + consumerDestinations: + items: + $ref: '#/components/schemas/BillingDestination' description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + type: array + id: Billing + type: object + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count + V1Beta1ImportProducerQuotaPoliciesResponse: + id: V1Beta1ImportProducerQuotaPoliciesResponse + type: object + properties: + policies: type: array + description: The policies that were created from the imported data. items: - $ref: '#/components/schemas/LabelDescriptor' - valueType: - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. + $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' + description: Response message for ImportProducerQuotaPolicies + MetricDescriptorMetadata: + properties: + timeSeriesResourceHierarchyLevel: + items: + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER + type: string + description: The scope of the timeseries data of the metric. + type: array + samplePeriod: description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. type: string - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY + format: google-duration + ingestDelay: + format: google-duration + type: string + description: >- + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. launchStage: enum: - LAUNCH_STAGE_UNSPECIFIED @@ -1460,7 +1618,6 @@ components: - BETA - GA - DEPRECATED - description: Optional. The launch stage of the metric definition. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -1487,1266 +1644,1299 @@ components: - >- Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - monitoredResourceTypes: - items: - type: string - type: array - description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. - unit: - type: string - description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). - metricKind: - description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - type: string - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - description: - type: string - description: >- - A detailed description of the metric, which can be used in - documentation. - id: MetricDescriptor - type: object - AddTenantProjectRequest: - properties: - projectConfig: - $ref: '#/components/schemas/TenantProjectConfig' - description: >- - Configuration of the new tenant project to be added to tenancy unit - resources. - tag: - description: >- - Required. Tag of the added project. Must be less than 128 - characters. Required. - type: string - description: >- - Request to add a newly created and configured tenant project to a - tenancy unit. - id: AddTenantProjectRequest - type: object - SystemParameters: - id: SystemParameters - description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - properties: - rules: - type: array - description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - items: - $ref: '#/components/schemas/SystemParameterRule' - type: object - V1GenerateDefaultIdentityResponse: - properties: - identity: - description: DefaultIdentity that was created or retrieved. - $ref: '#/components/schemas/V1DefaultIdentity' - attachStatus: - description: >- - Status of the role attachment. Under development - (go/si-attach-role), currently always return - ATTACH_STATUS_UNSPECIFIED) - enumDescriptions: - - Indicates that the AttachStatus was not set. - - >- - The default identity was attached to a role successfully in this - request. - - >- - The request specified that no attempt should be made to attach the - role. - - >- - Role was attached to the consumer project at some point in time. - Tenant manager doesn't make assertion about the current state of - the identity with respect to the consumer. Role attachment should - happen only once after activation and cannot be reattached after - customer removes it. (go/si-attach-role) + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. - >- - Role attachment was denied in this request by customer set org - policy. (go/si-attach-role) - type: string - enum: - - ATTACH_STATUS_UNSPECIFIED - - ATTACHED - - ATTACH_SKIPPED - - PREVIOUSLY_ATTACHED - - ATTACH_DENIED_BY_ORG_POLICY - role: - description: >- - Role attached to consumer project. Empty if not attached in this - request. (Under development, currently always return empty.) + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + deprecated: true + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. type: string - description: >- - Response message for the `GenerateDefaultIdentity` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. + id: MetricDescriptorMetadata type: object - id: V1GenerateDefaultIdentityResponse - LogDescriptor: - properties: - displayName: - description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - type: string - labels: - description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - items: - $ref: '#/components/schemas/LabelDescriptor' - type: array - name: - type: string - description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - description: - description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - type: string - id: LogDescriptor - description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer + description: Additional annotations that can be used to guide the usage of a metric. + SystemParameterRule: type: object - V1Beta1EnableConsumerResponse: - id: V1Beta1EnableConsumerResponse - properties: {} + id: SystemParameterRule description: >- - Response message for the `EnableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - type: object - ContextRule: - id: ContextRule + Define a system parameter rule mapping system parameter definitions to + methods. properties: - allowedRequestExtensions: - type: array - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - items: - type: string - allowedResponseExtensions: - type: array - items: - type: string - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - requested: + parameters: description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. type: array items: - type: string + $ref: '#/components/schemas/SystemParameter' selector: type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - provided: - description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. - items: - type: string - type: array - description: >- - A context rule provides information about the context for an individual - API element. - type: object - V1EnableConsumerResponse: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + Mixin: description: >- - Response message for the `EnableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - properties: {} - id: V1EnableConsumerResponse - type: object - CommonLanguageSettings: - id: CommonLanguageSettings + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + id: Mixin type: object - description: Required information for every language. properties: - destinations: - type: array - description: >- - The destination where API teams want this client library to be - published. - items: - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - type: string - referenceDocsUri: - deprecated: true + root: type: string description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - TenancyUnit: - id: TenancyUnit + If non-empty specifies a path under which inherited HTTP paths are + rooted. + name: + description: The fully qualified name of the interface which is included. + type: string + JwtLocation: + id: JwtLocation + type: object + description: Specifies a location to extract JWT from an API request. properties: - service: - readOnly: true + valuePrefix: type: string description: >- - Output only. Google Cloud API name of the managed service owning - this tenancy unit. For example - 'serviceconsumermanagement.googleapis.com'. - tenantResources: - items: - $ref: '#/components/schemas/TenantResource' - description: >- - Resources constituting the tenancy unit. There can be at most 512 - tenant resources in a tenancy unit. - type: array - name: + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + query: + description: Specifies URL query parameter name to extract JWT token. type: string - description: >- - Globally unique identifier of this tenancy unit - "services/{service}/{collection id}/{resource - id}/tenancyUnits/{unit}" - consumer: - description: >- - Output only. @OutputOnly Cloud resource name of the consumer of this - service. For example 'projects/123456'. - readOnly: true + cookie: + description: Specifies cookie name to extract JWT token. type: string - createTime: - readOnly: true - description: Output only. @OutputOnly The time this tenancy unit was created. - format: google-datetime + header: + description: Specifies HTTP header name to extract JWT token. + type: string + Status: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: type: string - description: Representation of a tenancy unit. + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array type: object - V1Beta1GenerateServiceIdentityResponse: - id: V1Beta1GenerateServiceIdentityResponse + id: Status + PythonSettings: properties: - identity: - description: ServiceIdentity that was created or retrieved. - $ref: '#/components/schemas/V1Beta1ServiceIdentity' - description: >- - Response message for the `GenerateServiceIdentity` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + experimentalFeatures: + $ref: '#/components/schemas/ExperimentalFeatures' + description: >- + Experimental features to be included during client library + generation. + id: PythonSettings type: object - V1Beta1RefreshConsumerResponse: - id: V1Beta1RefreshConsumerResponse + description: Settings for Python client libraries. + V1Beta1EnableConsumerResponse: type: object properties: {} description: >- - Response message for the `RefreshConsumer` method. This response message + Response message for the `EnableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. - Empty: - properties: {} - 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 - type: object - BillingDestination: - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - id: BillingDestination + id: V1Beta1EnableConsumerResponse + OAuthRequirements: properties: - metrics: - type: array + canonicalScopes: description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - items: - type: string - monitoredResource: + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read type: string - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. + description: >- + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. type: object - TenantProjectPolicy: - id: TenantProjectPolicy + id: OAuthRequirements + Page: type: object + id: Page + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. properties: - policyBindings: + subpages: description: >- - Policy bindings to be applied to the tenant project, in addition to - the 'roles/owner' role granted to the Service Consumer Management - service account. + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. type: array items: - $ref: '#/components/schemas/PolicyBinding' - description: >- - Describes policy settings that can be applied to a newly created tenant - project. - V1ServiceAccount: - type: object - properties: - iamAccountName: - deprecated: true - type: string - description: Deprecated. See b/136209818. - tag: - type: string + $ref: '#/components/schemas/Page' + content: description: >- - The P4 SA configuration tag. This must be defined in - activation_grants. If not specified when creating the account, the - tag is set to "default". - uniqueId: - type: string - description: The unique and stable id of the service account. - email: + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. type: string - description: The email address of the service account. name: type: string description: >- - P4 SA resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` - id: V1ServiceAccount - description: A service account in the Identity and Access Management API. - CreateTenancyUnitRequest: - properties: - tenancyUnitId: - type: string - description: >- - Optional. Optional service producer-provided identifier of the - tenancy unit. Must be no longer than 40 characters and preferably - URI friendly. If it isn't provided, a UID for the tenancy unit is - automatically generated. The identifier must be unique across a - managed service. If the tenancy unit already exists for the managed - service and service consumer pair, calling `CreateTenancyUnit` - returns the existing tenancy unit if the provided identifier is - identical or empty, otherwise the call fails. - type: object - id: CreateTenancyUnitRequest + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. + V1RemoveVisibilityLabelsResponse: description: >- - Request to create a tenancy unit for a service consumer of a managed - service. - V1DefaultIdentity: - description: A default identity in the Identity and Access Management API. - properties: - uniqueId: - type: string - description: The unique and stable id of the default identity. - tag: - type: string - description: >- - The Default Identity tag. If specified when creating the account, - the tag must be present in activation_grants. If not specified when - creating the account, the tag is set to the tag specified in - activation_grants. - email: - type: string - description: The email address of the default identity. - name: - description: >- - Default identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` - type: string - type: object - id: V1DefaultIdentity - MonitoringDestination: + Response message for the `RemoveVisibilityLabels` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. type: object - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - id: MonitoringDestination + id: V1RemoveVisibilityLabelsResponse properties: - monitoredResource: - type: string - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - metrics: - description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. + labels: items: type: string + description: >- + The updated set of visibility labels for this consumer on this + service. type: array - Status: + CancelOperationRequest: + type: object + description: The request message for Operations.CancelOperation. + properties: {} + id: CancelOperationRequest + ListTenancyUnitsResponse: + id: ListTenancyUnitsResponse properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + nextPageToken: + description: Pagination token for large results. type: string - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + tenancyUnits: items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + $ref: '#/components/schemas/TenancyUnit' type: array - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + description: Tenancy units matching the request. + description: Response for the list request. type: object - id: Status - MethodPolicy: - description: Defines policies applying to an RPC method. - id: MethodPolicy + DotnetSettings: type: object + id: DotnetSettings + description: Settings for Dotnet client libraries. properties: - requestPolicies: - description: Policies that are applicable to the request message. + renamedResources: + type: object + additionalProperties: + type: string + description: >- + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + handwrittenSignatures: type: array items: - $ref: '#/components/schemas/FieldPolicy' - selector: + type: string description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - type: string - ServiceAccountConfig: - description: Describes the service account configuration for the tenant project. - properties: - accountId: + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + forcedNamespaceAliases: description: >- - ID of the IAM service account to be created in tenant project. The - email format of the service account is "@.iam.gserviceaccount.com". - This account ID must be unique within tenant project and service - producers have to guarantee it. The ID must be 6-30 characters long, - and match the following regular expression: - `[a-z]([-a-z0-9]*[a-z0-9])`. - type: string - tenantProjectRoles: + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision items: type: string type: array - description: Roles for the associated service account for the tenant project. - id: ServiceAccountConfig - type: object - SourceContext: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + ignoredResources: + description: >- + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + type: array + items: + type: string + renamedServices: + description: >- + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + type: object + additionalProperties: + type: string + PhpSettings: + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. type: object - id: SourceContext - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. + description: Settings for Php client libraries. + id: PhpSettings + Backend: + id: Backend properties: - fileName: - type: string + rules: + type: array + items: + $ref: '#/components/schemas/BackendRule' description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - Type: - id: Type + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + description: '`Backend` defines the backend configuration for a service.' + type: object + Api: + type: object properties: - options: + mixins: items: - $ref: '#/components/schemas/Option' + $ref: '#/components/schemas/Mixin' + description: Included interfaces. See Mixin. type: array - description: The protocol buffer options. - edition: - type: string - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. syntax: - description: The source syntax. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS type: string enumDescriptions: - Syntax `proto2`. - Syntax `proto3`. - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS + description: The source syntax of the service. + methods: + type: array + description: The methods of this interface, in unspecified order. + items: + $ref: '#/components/schemas/Method' + options: + type: array + description: Any metadata attached to the interface. + items: + $ref: '#/components/schemas/Option' + name: + description: >- + The fully qualified name of this interface, including package name + followed by the interface's simple name. + type: string + version: + description: >- + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. + type: string sourceContext: - description: The source context. $ref: '#/components/schemas/SourceContext' - fields: - items: - $ref: '#/components/schemas/Field' - description: The list of fields. + description: >- + Source context for the protocol buffer service represented by this + message. + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + id: Api + CustomError: + id: CustomError + description: >- + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + type: object + properties: + types: type: array - oneofs: + description: >- + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. items: type: string - description: The list of types appearing in `oneof` definitions in this type. + rules: + description: >- + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. type: array + items: + $ref: '#/components/schemas/CustomErrorRule' + V1Beta1ServiceIdentity: + description: A service identity in the Identity and Access Management API. + id: V1Beta1ServiceIdentity + properties: + uniqueId: + type: string + description: The unique and stable id of the service identity. name: - description: The fully qualified message name. type: string - description: A protocol buffer message type. + description: >- + P4 service identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` + email: + description: The email address of the service identity. + type: string + tag: + type: string + description: >- + The P4 service identity configuration tag. This must be defined in + activation_grants. If not specified when creating the account, the + tag is set to "default". type: object - ApplyTenantProjectConfigRequest: - id: ApplyTenantProjectConfigRequest + ListOperationsResponse: + description: The response message for Operations.ListOperations. + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + id: ListOperationsResponse + type: object + AttachTenantProjectRequest: properties: - projectConfig: - $ref: '#/components/schemas/TenantProjectConfig' - description: Configuration that should be applied to the existing tenant project. tag: description: >- - Required. Tag of the project. Must be less than 128 characters. - Required. + Required. Tag of the tenant resource after attachment. Must be less + than 128 characters. Required. + type: string + reservedResource: + description: >- + When attaching a reserved project already in tenancy units, this is + the tag of a tenant resource under the tenancy unit for the managed + service's service producer project. The reserved tenant resource + must be in an active state. + type: string + externalResource: + type: string + description: >- + When attaching an external project, this is in the format of + `projects/{project_number}`. + id: AttachTenantProjectRequest + description: >- + Request to attach an existing project to the tenancy unit as a new + tenant resource. + type: object + TenancyUnit: + properties: + createTime: + type: string + description: Output only. @OutputOnly The time this tenancy unit was created. + readOnly: true + format: google-datetime + name: + type: string + description: >- + Globally unique identifier of this tenancy unit + "services/{service}/{collection id}/{resource + id}/tenancyUnits/{unit}" + tenantResources: + items: + $ref: '#/components/schemas/TenantResource' + type: array + description: >- + Resources constituting the tenancy unit. There can be at most 512 + tenant resources in a tenancy unit. + consumer: + description: >- + Output only. @OutputOnly Cloud resource name of the consumer of this + service. For example 'projects/123456'. + type: string + readOnly: true + service: type: string + readOnly: true + description: >- + Output only. Google Cloud API name of the managed service owning + this tenancy unit. For example + 'serviceconsumermanagement.googleapis.com'. type: object - description: Request to apply configuration to an existing tenant project. - OAuthRequirements: + id: TenancyUnit + description: Representation of a tenancy unit. + V1Beta1ImportProducerOverridesResponse: + id: V1Beta1ImportProducerOverridesResponse type: object properties: - canonicalScopes: + overrides: + type: array + items: + $ref: '#/components/schemas/V1Beta1QuotaOverride' + description: The overrides that were created from the imported data. + description: Response message for ImportProducerOverrides + SourceContext: + type: object + properties: + fileName: type: string description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read - id: OAuthRequirements + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + id: SourceContext description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. - Field: + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. + AuthProvider: + id: AuthProvider properties: - number: - type: integer - description: The field number. - format: int32 - options: - items: - $ref: '#/components/schemas/Option' - description: The protocol buffer options. - type: array - kind: - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - description: The field type. - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 + jwksUri: type: string - packed: - type: boolean - description: Whether to use alternative packed wire representation. - oneofIndex: - type: integer description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - format: int32 - name: - description: The field name. - type: string - cardinality: - type: string - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - description: The field cardinality. - defaultValue: + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs + id: + description: >- + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". type: string + issuer: description: >- - The string value of the default value of this field. Proto2 syntax - only. - jsonName: - description: The field JSON name. + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com type: string - typeUrl: + jwtLocations: + type: array + description: >- + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token + items: + $ref: '#/components/schemas/JwtLocation' + authorizationUrl: + description: >- + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. type: string + audiences: description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string type: object - id: Field - description: A single field of a message type. - TenantResource: - id: TenantResource + description: >- + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + V1ServiceAccount: type: object properties: - status: - description: Status of tenant resource. - enumDescriptions: - - Unspecified status is the default unset value. - - Creation of the tenant resource is ongoing. - - Active resource. - - Deletion of the resource is ongoing. - - Tenant resource creation or deletion has failed. - - Tenant resource has been deleted. + email: type: string - enum: - - STATUS_UNSPECIFIED - - PENDING_CREATE - - ACTIVE - - PENDING_DELETE - - FAILED - - DELETED + description: The email address of the service account. tag: - description: Unique per single tenancy unit. - type: string - resource: - readOnly: true type: string description: >- - Output only. @OutputOnly Identifier of the tenant resource. For - cloud projects, it is in the form 'projects/{number}'. For example - 'projects/123456'. - description: Resource constituting the TenancyUnit. - JwtLocation: - type: object - properties: - query: - description: Specifies URL query parameter name to extract JWT token. - type: string - cookie: - description: Specifies cookie name to extract JWT token. + The P4 SA configuration tag. This must be defined in + activation_grants. If not specified when creating the account, the + tag is set to "default". + iamAccountName: + deprecated: true type: string - header: - description: Specifies HTTP header name to extract JWT token. + description: Deprecated. See b/136209818. + uniqueId: + description: The unique and stable id of the service account. type: string - valuePrefix: + name: type: string description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - description: Specifies a location to extract JWT from an API request. - id: JwtLocation - PolicyBinding: - id: PolicyBinding + P4 SA resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` + description: A service account in the Identity and Access Management API. + id: V1ServiceAccount + V1EnableConsumerResponse: + properties: {} type: object + id: V1EnableConsumerResponse + description: >- + Response message for the `EnableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + TenantProjectConfig: + id: TenantProjectConfig + description: >- + This structure defines a tenant project to be added to the specified + tenancy unit and its initial configuration and properties. A project + lien is created for the tenant project to prevent the tenant project + from being deleted accidentally. The lien is deleted as part of tenant + project removal. properties: - members: + tenantProjectPolicy: + description: Describes ownership and policies for the new tenant project. + $ref: '#/components/schemas/TenantProjectPolicy' + serviceAccountConfig: + $ref: '#/components/schemas/ServiceAccountConfig' + description: Configuration for the IAM service account on the tenant project. + labels: + additionalProperties: + type: string + description: Labels that are applied to this project. + type: object + folder: + type: string description: >- - Uses the same format as in IAM policy. `member` must include both a - prefix and ID. For example, `user:{emailId}`, - `serviceAccount:{emailId}`, `group:{emailId}`. + Folder where project in this tenancy unit must be located This + folder must have been previously created with the required + permissions for the caller to create and configure a project in it. + Valid folder resource names have the format + `folders/{folder_number}` (for example, `folders/123456`). + services: type: array items: type: string - role: description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. - type: string - description: Translates to IAM Policy bindings (without auditing at this level) - ListTenancyUnitsResponse: + Google Cloud API names of services that are activated on this + project during provisioning. If any of these services can't be + activated, the request fails. For example: + 'compute.googleapis.com','cloudfunctions.googleapis.com' + billingConfig: + description: Billing account properties. The billing account must be specified. + $ref: '#/components/schemas/BillingConfig' type: object + V1Beta1ProducerQuotaPolicy: properties: - nextPageToken: - description: Pagination token for large results. + unit: + description: >- + The limit unit of the limit to which this policy applies. An example + unit would be: `1/{project}/{region}` Note that `{project}` and + `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. type: string - tenancyUnits: - type: array - items: - $ref: '#/components/schemas/TenancyUnit' - description: Tenancy units matching the request. - id: ListTenancyUnitsResponse - description: Response for the list request. - SearchTenancyUnitsResponse: - properties: - nextPageToken: + dimensions: + description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota polcies that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' + additionalProperties: + type: string + type: object + policyValue: + description: >- + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). + format: int64 type: string - description: Pagination token for large results. - tenancyUnits: - description: Tenancy Units matching the request. - type: array + container: + type: string + description: >- + The cloud resource container at which the quota policy is created. + The format is {container_type}/{container_number} + metric: + description: >- + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` + type: string + name: + description: >- + The resource name of the producer policy. An example name would be: + `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` + type: string + description: Quota policy created by service producer. + type: object + id: V1Beta1ProducerQuotaPolicy + TenantProjectPolicy: + type: object + description: >- + Describes policy settings that can be applied to a newly created tenant + project. + id: TenantProjectPolicy + properties: + policyBindings: + description: >- + Policy bindings to be applied to the tenant project, in addition to + the 'roles/owner' role granted to the Service Consumer Management + service account. items: - $ref: '#/components/schemas/TenancyUnit' + $ref: '#/components/schemas/PolicyBinding' + type: array + MonitoredResourceDescriptor: type: object - description: Response for the search query. - id: SearchTenancyUnitsResponse - JavaSettings: - id: JavaSettings - description: Settings for Java client libraries. properties: - libraryPackage: + displayName: + description: >- + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. type: string + labels: description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 - serviceClassNames: - additionalProperties: - type: string - type: object + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array + type: + type: string description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). + description: + type: string + description: >- + Optional. A detailed description of the monitored resource type that + might be used in documentation. + name: + type: string + description: >- + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: string + description: Optional. The launch stage of the monitored resource definition. + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. + id: MonitoredResourceDescriptor + V1Beta1RefreshConsumerResponse: + id: V1Beta1RefreshConsumerResponse + description: >- + Response message for the `RefreshConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. type: object - DotnetSettings: + properties: {} + BackendRule: properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - forcedNamespaceAliases: - type: array - description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - items: - type: string - renamedResources: - type: object + protocol: + type: string description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - additionalProperties: - type: string - ignoredResources: - type: array - items: - type: string + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. + disableAuth: + type: boolean description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - renamedServices: + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + overridesByRequestProtocol: + description: The map between request protocol and the backend address. type: object - description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. additionalProperties: - type: string - handwrittenSignatures: - type: array + $ref: '#/components/schemas/BackendRule' + pathTranslation: + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + type: string + deadline: + type: number + format: double description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - items: - type: string - type: object - description: Settings for Dotnet client libraries. - id: DotnetSettings - AuthenticationRule: - type: object - properties: - allowWithoutCredential: + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + minDeadline: + type: number + description: Deprecated, do not use. + deprecated: true + format: double + address: description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - type: boolean - oauth: - description: The requirements for OAuth credentials. - $ref: '#/components/schemas/OAuthRequirements' + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + type: string selector: type: string description: >- Selects the methods to which this rule applies. Refer to selector for syntax details. - requirements: - description: Requirements for additional authentication providers. - items: - $ref: '#/components/schemas/AuthRequirement' - type: array - id: AuthenticationRule - description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - RemoveTenantProjectRequest: - description: >- - Request message to remove a tenant project resource from the tenancy - unit. - id: RemoveTenantProjectRequest - type: object - properties: - tag: + operationDeadline: + type: number + description: >- + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + format: double + jwtAudience: type: string - description: Required. Tag of the resource within the tenancy unit. - CustomError: + description: >- + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. + id: BackendRule + description: A backend rule provides configuration for an individual API element. type: object + V1AddVisibilityLabelsResponse: description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - id: CustomError + Response message for the `AddVisibilityLabels` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: V1AddVisibilityLabelsResponse + type: object properties: - types: + labels: type: array - description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. items: type: string - rules: - items: - $ref: '#/components/schemas/CustomErrorRule' - type: array description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. - Authentication: - type: object - description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - id: Authentication + The updated set of visibility labels for this consumer on this + service. + LogDescriptor: properties: - providers: - items: - $ref: '#/components/schemas/AuthProvider' - type: array - description: Defines a set of authentication providers that a service supports. - rules: + name: description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - items: - $ref: '#/components/schemas/AuthenticationRule' - LongRunning: - type: object - id: LongRunning - properties: - totalPollTimeout: - description: 'Total polling timeout. Default value: 5 minutes.' - format: google-duration + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. type: string - pollDelayMultiplier: - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - format: float - type: number - initialPollDelay: - format: google-duration + description: description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. + A human-readable description of this log. This information appears + in the documentation and can contain details. type: string - maxPollDelay: + labels: description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. + type: array + items: + $ref: '#/components/schemas/LabelDescriptor' + displayName: + description: >- + The human-readable name for this log. This information appears on + the user interface and should be concise. type: string - format: google-duration + id: LogDescriptor + type: object description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - DocumentationRule: + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer + V1DefaultIdentity: + id: V1DefaultIdentity + description: A default identity in the Identity and Access Management API. properties: - description: + uniqueId: + description: The unique and stable id of the default identity. type: string + tag: description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. - disableReplacementWords: + The Default Identity tag. If specified when creating the account, + the tag must be present in activation_grants. If not specified when + creating the account, the tag is set to the tag specified in + activation_grants. type: string - description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. - deprecationDescription: + name: type: string description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - selector: + Default identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` + email: type: string - description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. - description: A documentation rule provides information about individual API elements. + description: The email address of the default identity. type: object - id: DocumentationRule - Quota: + CustomErrorRule: type: object properties: - metricRules: + selector: description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - type: array - items: - $ref: '#/components/schemas/MetricRule' - limits: + Selects messages to which this rule applies. Refer to selector for + syntax details. + type: string + isErrorType: + type: boolean + description: >- + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + description: A custom error rule. + id: CustomErrorRule + MethodSettings: + properties: + longRunning: + $ref: '#/components/schemas/LongRunning' + description: >- + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + autoPopulatedFields: type: array + description: >- + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id items: - $ref: '#/components/schemas/QuotaLimit' - description: List of QuotaLimit definitions for the service. - description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - id: Quota - Billing: - id: Billing + type: string + selector: + description: >- + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... + type: string + type: object + description: Describes the generator configuration for a method. + id: MethodSettings + Monitoring: type: object - description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count properties: consumerDestinations: description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + type: array items: - $ref: '#/components/schemas/BillingDestination' + $ref: '#/components/schemas/MonitoringDestination' + producerDestinations: type: array - RubySettings: - type: object - description: Settings for Ruby client libraries. + description: >- + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + items: + $ref: '#/components/schemas/MonitoringDestination' + id: Monitoring + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + V1GenerateServiceAccountResponse: properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: RubySettings - V1Beta1ProducerQuotaPolicy: - id: V1Beta1ProducerQuotaPolicy + account: + description: ServiceAccount that was created or retrieved. + $ref: '#/components/schemas/V1ServiceAccount' + id: V1GenerateServiceAccountResponse type: object - description: Quota policy created by service producer. + description: >- + Response message for the `GenerateServiceAccount` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + V1Beta1QuotaOverride: properties: - policyValue: - format: int64 - description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). - type: string unit: description: >- - The limit unit of the limit to which this policy applies. An example - unit would be: `1/{project}/{region}` Note that `{project}` and - `{region}` are not placeholders in this example; the literal + The limit unit of the limit to which this override applies. An + example unit would be: `1/{project}/{region}` Note that `{project}` + and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. type: string - container: + adminOverrideAncestor: + description: >- + The resource name of the ancestor that requested the override. For + example: "organizations/12345" or "folders/67890". Used by admin + overrides only. type: string - description: >- - The cloud resource container at which the quota policy is created. - The format is {container_type}/{container_number} name: type: string description: >- - The resource name of the producer policy. An example name would be: - `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` + The resource name of the producer override. An example name would + be: + `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` metric: - type: string description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` + type: string dimensions: type: object - description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota polcies that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' additionalProperties: type: string - V1Beta1DisableConsumerResponse: - id: V1Beta1DisableConsumerResponse - description: >- - Response message for the `DisableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - type: object - properties: {} - SystemParameter: - id: SystemParameter - description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. + description: ' If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' + overrideValue: + description: >- + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + type: string + format: int64 + description: A quota override + id: V1Beta1QuotaOverride type: object + Usage: + description: Configuration controlling usage of a service. properties: - urlQueryParameter: - type: string + rules: + items: + $ref: '#/components/schemas/UsageRule' + type: array description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - httpHeader: + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + producerNotificationChannel: + description: >- + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. type: string + requirements: + type: array description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - name: + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. + items: + type: string + id: Usage + type: object + MetricRule: + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + id: MetricRule + type: object + properties: + metricCosts: + additionalProperties: + type: string + format: int64 + description: >- + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + type: object + selector: type: string description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. + Selects the methods to which this rule applies. Refer to selector + for syntax details. QuotaLimit: - id: QuotaLimit + description: >- + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. properties: name: - type: string description: >- Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. + type: string + values: + type: object + description: >- + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + additionalProperties: + format: int64 + type: string + displayName: + type: string + description: >- + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + unit: + type: string + description: >- + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + defaultLimit: + type: string + description: >- + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + format: int64 description: + type: string description: >- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). - type: string maxLimit: - format: int64 type: string description: >- Maximum number of tokens that can be consumed during the specified @@ -2756,6 +2946,12 @@ components: the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. + format: int64 + duration: + type: string + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. metric: description: >- The name of the metric this quota limit applies to. The quota limits @@ -2763,8 +2959,6 @@ components: metric must be defined within the service config. type: string freeTier: - type: string - format: int64 description: >- Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from @@ -2773,257 +2967,244 @@ components: invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. - unit: - type: string - description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. - values: - description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - additionalProperties: - type: string - format: int64 - type: object - defaultLimit: - type: string - description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. format: int64 - duration: - type: string - description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - displayName: - description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. type: string + id: QuotaLimit type: object - description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - FieldPolicy: - id: FieldPolicy + CommonLanguageSettings: + description: Required information for every language. type: object - description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. properties: - resourceType: - description: >- - Specifies the resource type for the resource referred to by the - field. - type: string - resourcePermission: + destinations: description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - type: string - selector: + The destination where API teams want this client library to be + published. + type: array + items: + type: string + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + referenceDocsUri: + deprecated: true description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest type: string - LabelDescriptor: + id: CommonLanguageSettings + SystemParameter: type: object - id: LabelDescriptor + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + id: SystemParameter properties: - valueType: + name: type: string - enum: - - STRING - - BOOL - - INT64 - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - description: The type of data that can be assigned to the label. - description: - description: A human-readable description for the label. + description: >- + Define the name of the parameter, such as "api_key" . It is case + sensitive. + httpHeader: type: string - key: - description: The label key. + description: >- + Define the HTTP header name to use for the parameter. It is case + insensitive. + urlQueryParameter: type: string - description: A description of a label. - CustomErrorRule: - description: A custom error rule. - id: CustomErrorRule + description: >- + Define the URL query parameter name to use for the parameter. It is + case sensitive. + Quota: + id: Quota + description: >- + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 type: object properties: - selector: + limits: + type: array + description: List of QuotaLimit definitions for the service. + items: + $ref: '#/components/schemas/QuotaLimit' + metricRules: description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + items: + $ref: '#/components/schemas/MetricRule' + type: array + DocumentationRule: + description: A documentation rule provides information about individual API elements. + type: object + id: DocumentationRule + properties: + disableReplacementWords: + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. type: string - isErrorType: - type: boolean + deprecationDescription: description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - Control: - id: Control - description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - properties: - environment: + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + type: string + description: description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. type: string - methodPolicies: + selector: + description: >- + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + type: string + MonitoringDestination: + properties: + metrics: type: array - description: Defines policies applying to the API methods of the service. items: - $ref: '#/components/schemas/MethodPolicy' + type: string + description: >- + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + monitoredResource: + type: string + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + id: MonitoringDestination + description: >- + Configuration of a specific monitoring destination (the producer project + or the consumer project). type: object - Backend: + GoSettings: type: object properties: - rules: - type: array - description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/BackendRule' - id: Backend - description: '`Backend` defines the backend configuration for a service.' - Monitoring: - id: Monitoring + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + id: GoSettings + description: Settings for Go client libraries. + LoggingDestination: + id: LoggingDestination description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue + Configuration of a specific logging destination (the producer project or + the consumer project). type: object properties: - consumerDestinations: + monitoredResource: + type: string + description: >- + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + logs: type: array items: - $ref: '#/components/schemas/MonitoringDestination' - description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - producerDestinations: + type: string description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + Type: + properties: + oneofs: items: - $ref: '#/components/schemas/MonitoringDestination' + type: string type: array - UndeleteTenantProjectRequest: - description: >- - Request message to undelete tenant project resource previously deleted - from the tenancy unit. - id: UndeleteTenantProjectRequest - properties: - tag: + description: The list of types appearing in `oneof` definitions in this type. + fields: + type: array + description: The list of fields. + items: + $ref: '#/components/schemas/Field' + options: + description: The protocol buffer options. + items: + $ref: '#/components/schemas/Option' + type: array + name: + description: The fully qualified message name. + type: string + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax. type: string - description: Required. Tag of the resource within the tenancy unit. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + edition: + type: string + description: >- + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + description: A protocol buffer message type. type: object - MetricDescriptorMetadata: + id: Type + ClientLibrarySettings: + description: Details about how and where to publish client libraries. + id: ClientLibrarySettings properties: - ingestDelay: - description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - type: string - format: google-duration - samplePeriod: - format: google-duration + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. + version: description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". type: string - timeSeriesResourceHierarchyLevel: - type: array - items: - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER - enumDescriptions: - - Do not use this default value. - - Scopes a metric to a project. - - Scopes a metric to an organization. - - Scopes a metric to a folder. - type: string - description: The scope of the timeseries data of the metric. launchStage: - deprecated: true type: string - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + description: Launch stage of this version of the API. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -3071,590 +3252,394 @@ components: - BETA - GA - DEPRECATED - description: Additional annotations that can be used to guide the usage of a metric. - id: MetricDescriptorMetadata - type: object - Method: - description: Method represents a method of an API interface. - id: Method - type: object - properties: - requestTypeUrl: - type: string - description: A URL of the input message type. - options: - type: array - items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the method. - responseTypeUrl: - type: string - description: The URL of the output message type. - responseStreaming: - description: If true, the response is streamed. - type: boolean - syntax: - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of this method. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - name: - type: string - description: The simple name of this method. - requestStreaming: - description: If true, the request is streamed. - type: boolean - V1Beta1ImportProducerOverridesResponse: - type: object - description: Response message for ImportProducerOverrides - properties: - overrides: - items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - type: array - description: The overrides that were created from the imported data. - id: V1Beta1ImportProducerOverridesResponse - Context: - id: Context - description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. - properties: - rules: - description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/ContextRule' - type: array - type: object - ListOperationsResponse: - type: object - description: The response message for Operations.ListOperations. - id: ListOperationsResponse - properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: - type: array - description: >- - A list of operations that matches the specified filter in the - request. - items: - $ref: '#/components/schemas/Operation' - MethodSettings: - type: object - id: MethodSettings - description: Describes the generator configuration for a method. - properties: - autoPopulatedFields: - description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id - type: array - items: - type: string - longRunning: - $ref: '#/components/schemas/LongRunning' - description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - selector: - description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... - type: string - CppSettings: - description: Settings for C++ client libraries. - id: CppSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - type: object - Mixin: - id: Mixin - type: object - description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - properties: - name: - description: The fully qualified name of the interface which is included. - type: string - root: - type: string - description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. - Option: - type: object - properties: - value: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - name: + phpSettings: + description: Settings for PHP client libraries. + $ref: '#/components/schemas/PhpSettings' + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + cppSettings: + description: Settings for C++ client libraries. + $ref: '#/components/schemas/CppSettings' + rubySettings: + $ref: '#/components/schemas/RubySettings' + description: Settings for Ruby client libraries. + pythonSettings: + $ref: '#/components/schemas/PythonSettings' + description: Settings for Python client libraries. + goSettings: + $ref: '#/components/schemas/GoSettings' + description: Settings for Go client libraries. + restNumericEnums: + type: boolean description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - type: string - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - id: Option - SystemParameterRule: - id: SystemParameterRule - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. + When using transport=rest, the client request will encode enums as + numbers rather than strings. type: object + ContextRule: + id: ContextRule properties: - selector: - type: string - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - parameters: - type: array + provided: items: - $ref: '#/components/schemas/SystemParameter' + type: string description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. - CustomHttpPattern: - description: A custom pattern is used for defining custom HTTP verb. - type: object - properties: - path: - description: The path matched by this custom verb. - type: string - kind: - description: The name of this custom HTTP verb. - type: string - id: CustomHttpPattern - Logging: - type: object - id: Logging - properties: - consumerDestinations: + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. type: array - description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. - items: - $ref: '#/components/schemas/LoggingDestination' - producerDestinations: + allowedResponseExtensions: type: array items: - $ref: '#/components/schemas/LoggingDestination' + type: string description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - AttachTenantProjectRequest: - properties: - tag: - type: string + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + allowedRequestExtensions: + type: array description: >- - Required. Tag of the tenant resource after attachment. Must be less - than 128 characters. Required. - externalResource: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + items: + type: string + selector: description: >- - When attaching an external project, this is in the format of - `projects/{project_number}`. + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string - reservedResource: + requested: description: >- - When attaching a reserved project already in tenancy units, this is - the tag of a tenant resource under the tenancy unit for the managed - service's service producer project. The reserved tenant resource - must be in an active state. - type: string + A list of full type names of requested contexts, only the requested + context will be made available to the backend. + items: + type: string + type: array + type: object description: >- - Request to attach an existing project to the tenancy unit as a new - tenant resource. - id: AttachTenantProjectRequest + A context rule provides information about the context for an individual + API element. + V1Beta1DisableConsumerResponse: + id: V1Beta1DisableConsumerResponse + properties: {} type: object - GoSettings: - description: Settings for Go client libraries. - id: GoSettings + description: >- + Response message for the `DisableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + RubySettings: type: object + id: RubySettings properties: common: - $ref: '#/components/schemas/CommonLanguageSettings' description: Some settings. - BackendRule: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Settings for Ruby client libraries. + SystemParameters: + type: object + description: >- + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + id: SystemParameters properties: - operationDeadline: - format: double - description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - type: number - pathTranslation: - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - type: string - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST - protocol: - description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. - type: string - address: - type: string + rules: description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - jwtAudience: + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + type: array + items: + $ref: '#/components/schemas/SystemParameterRule' + Context: + description: >- + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. + properties: + rules: description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/ContextRule' + id: Context + 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); } + type: object + properties: {} + id: Empty + UndeleteTenantProjectRequest: + type: object + id: UndeleteTenantProjectRequest + description: >- + Request message to undelete tenant project resource previously deleted + from the tenancy unit. + properties: + tag: + description: Required. Tag of the resource within the tenancy unit. type: string - minDeadline: - deprecated: true - format: double - type: number - description: Deprecated, do not use. - disableAuth: - type: boolean + JavaSettings: + properties: + serviceClassNames: + additionalProperties: + type: string description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - deadline: - type: number - format: double + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + type: object + libraryPackage: description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - selector: + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - overridesByRequestProtocol: - description: The map between request protocol and the backend address. - additionalProperties: - $ref: '#/components/schemas/BackendRule' - type: object - description: A backend rule provides configuration for an individual API element. + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + id: JavaSettings type: object - id: BackendRule - SourceInfo: - description: Source information used to create a Service Config - id: SourceInfo + description: Settings for Java client libraries. + Service: type: object + id: Service properties: - sourceFiles: + sourceInfo: + $ref: '#/components/schemas/SourceInfo' + description: >- + Output only. The source information for this configuration if + available. + producerProjectId: + type: string + description: The Google project that owns this service. + enums: + items: + $ref: '#/components/schemas/Enum' + description: >- + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum type: array - description: All files used during config generation. + types: + type: array + description: >- + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - ClientLibrarySettings: - description: Details about how and where to publish client libraries. - type: object - id: ClientLibrarySettings - properties: - version: + $ref: '#/components/schemas/Type' + logs: + items: + $ref: '#/components/schemas/LogDescriptor' + type: array + description: Defines the logs used by this service. + context: + $ref: '#/components/schemas/Context' + description: Context configuration. + billing: + description: Billing configuration. + $ref: '#/components/schemas/Billing' + title: description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". + The product title for this service, it is the name displayed in + Google Cloud Console. type: string - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. - dotnetSettings: - description: Settings for .NET client libraries. - $ref: '#/components/schemas/DotnetSettings' - nodeSettings: - description: Settings for Node client libraries. - $ref: '#/components/schemas/NodeSettings' - pythonSettings: - description: Settings for Python client libraries. - $ref: '#/components/schemas/PythonSettings' - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + endpoints: + description: >- + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + items: + $ref: '#/components/schemas/Endpoint' + type: array + apis: + items: + $ref: '#/components/schemas/Api' + type: array + description: >- + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + control: + $ref: '#/components/schemas/Control' + description: Configuration for the service control plane. + configVersion: + format: uint32 + description: >- + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + type: integer + id: type: string - description: Launch stage of this version of the API. - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - restNumericEnums: - type: boolean description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - rubySettings: - $ref: '#/components/schemas/RubySettings' - description: Settings for Ruby client libraries. - V1RemoveVisibilityLabelsResponse: - properties: - labels: + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + publishing: + description: >- + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + $ref: '#/components/schemas/Publishing' + systemTypes: + type: array + items: + $ref: '#/components/schemas/Type' + description: >- + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. + monitoring: + description: Monitoring configuration. + $ref: '#/components/schemas/Monitoring' + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + systemParameters: + description: System parameter configuration. + $ref: '#/components/schemas/SystemParameters' + backend: + $ref: '#/components/schemas/Backend' + description: API backend configuration. + name: + type: string + description: >- + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. + metrics: + items: + $ref: '#/components/schemas/MetricDescriptor' + description: Defines the metrics used by this service. type: array + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. + logging: + description: Logging configuration. + $ref: '#/components/schemas/Logging' + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + monitoredResources: description: >- - The updated set of visibility labels for this consumer on this - service. + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. items: - type: string - id: V1RemoveVisibilityLabelsResponse + $ref: '#/components/schemas/MonitoredResourceDescriptor' + type: array description: >- - Response message for the `RemoveVisibilityLabels` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - type: object - CancelOperationRequest: - properties: {} - description: The request message for Operations.CancelOperation. - type: object - id: CancelOperationRequest + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth parameters: - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: oauth_token + name: upload_protocol schema: type: string - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string - _.xgafv: - description: V1 error format. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: $.xgafv + name: uploadType schema: type: string - enum: - - '1' - - '2' - fields: - description: Selector specifying which fields to include in a partial response. + alt: + description: Data format for response. in: query - name: fields + name: alt schema: type: string + enum: + - json + - media + - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -3664,10 +3649,25 @@ components: name: quotaUser schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string key: @@ -3679,10 +3679,10 @@ components: name: key schema: type: string - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string x-stackQL-resources: @@ -3697,15 +3697,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -3730,46 +3730,46 @@ components: name: tenancy_units title: Tenancy_units methods: - list: + attach_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/get + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:attachProject/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tenancyUnits - create: + undelete_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post response: mediaType: application/json openAPIDocKey: '200' - undelete_project: + list: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.tenancyUnits + create: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}/delete + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/post response: mediaType: application/json openAPIDocKey: '200' - attach_project: + apply_project_config: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:attachProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:applyProjectConfig/post response: mediaType: application/json openAPIDocKey: '200' - apply_project_config: + delete: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:applyProjectConfig/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -3787,10 +3787,10 @@ components: name: tenancy_units_project title: Tenancy_units_project methods: - delete_project: + add_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:addProject/post response: mediaType: application/json openAPIDocKey: '200' @@ -3801,10 +3801,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - add_project: + delete_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:addProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post response: mediaType: application/json openAPIDocKey: '200' @@ -3816,10 +3816,10 @@ components: update: [] replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/tenancy_units_project/methods/delete_project - $ref: >- #/components/x-stackQL-resources/tenancy_units_project/methods/remove_project + - $ref: >- + #/components/x-stackQL-resources/tenancy_units_project/methods/delete_project services: id: google.serviceconsumermanagement.services name: services @@ -3840,17 +3840,17 @@ components: paths: /v1/operations/{operationsId}:cancel: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/access_token' post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3888,13 +3888,12 @@ paths: type: string /v1/operations/{operationsId}: parameters: *ref_1 - delete: + get: 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`. - operationId: serviceconsumermanagement.operations.delete + 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. + operationId: serviceconsumermanagement.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3906,19 +3905,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: operationsId required: true schema: type: string - get: + delete: 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. - operationId: serviceconsumermanagement.operations.get + 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`. + operationId: serviceconsumermanagement.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3930,7 +3930,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: operationsId @@ -3957,10 +3957,6 @@ paths: schema: $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: @@ -3970,16 +3966,30 @@ paths: name: filter schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits: + - in: query + name: pageToken + schema: + type: string + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: parameters: *ref_1 - get: + post: description: >- - Find the tenancy unit for a managed service and service consumer. This - method shouldn't be used in a service producer's runtime path, for - example to find the tenant project number when creating VMs. Service - producers must persist the tenant project's information after the - project is created. - operationId: serviceconsumermanagement.services.tenancyUnits.list + Attach an existing project to the tenancy unit as a new tenant resource. + The project could either be the tenant project reserved by calling + `AddTenantProject` under a tenancy unit of a service producer's project + of a managed service, or from a separate project. The caller is checked + against a set of permissions as if calling `AddTenantProject` on the + same service consumer. To trigger the attachment, the targeted tenant + project must be in a folder. Make sure the ServiceConsumerManagement + service account is the owner of that project. These two requirements are + already met if the project is reserved by calling `AddTenantProject`. + Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.attachProject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AttachTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3991,7 +4001,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListTenancyUnitsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -4008,31 +4018,26 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: tenancyUnitsId + required: true schema: type: string + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: + parameters: *ref_1 post: description: >- - Creates a tenancy unit with no tenant resources. If tenancy unit already - exists, it will be returned, however, in this case, returned TenancyUnit - does not have tenant_resources field set and ListTenancyUnits has to be - used to get a complete TenancyUnit with all fields populated. - operationId: serviceconsumermanagement.services.tenancyUnits.create + Attempts to undelete a previously deleted tenant project. The project + must be in a DELETED state. There are no guarantees that an undeleted + project will be in a fully restored and functional state. Call the + `ApplyTenantProjectConfig` method to update its configuration and then + validate all managed service resources. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.undeleteProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateTenancyUnitRequest' + $ref: '#/components/schemas/UndeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4044,7 +4049,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenancyUnit' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -4061,24 +4066,26 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: + - in: path + name: tenancyUnitsId + required: true + schema: + type: string + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject: parameters: *ref_1 post: description: >- - Deletes the specified project resource identified by a tenant resource - tag. The mothod removes a project lien with a 'TenantManager' origin if - that was added. It will then attempt to delete the project. If that - operation fails, this method also fails. After the project has been - deleted, the tenant resource state is set to DELETED. To permanently - remove resource metadata, call the `RemoveTenantProject` method. New - resources with the same tag can't be added if there are existing - resources in a DELETED state. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.deleteProject + Add a new tenant project to the tenancy unit. There can be a maximum of + 1024 tenant projects in a tenancy unit. If there are previously failed + `AddTenantProject` calls, you might need to call `RemoveTenantProject` + first to resolve them before you can make another call to + `AddTenantProject` with the same tag. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.addProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteTenantProjectRequest' + $ref: '#/components/schemas/AddTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4112,23 +4119,16 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits: parameters: *ref_1 - post: + get: description: >- - Removes the specified project resource identified by a tenant resource - tag. The method removes the project lien with 'TenantManager' origin if - that was added. It then attempts to delete the project. If that - operation fails, this method also fails. Calls to remove already removed - or non-existent tenant project succeed. After the project has been - deleted, or if was already in a DELETED state, resource metadata is - permanently removed from the tenancy unit. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.removeProject - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RemoveTenantProjectRequest' + Find the tenancy unit for a managed service and service consumer. This + method shouldn't be used in a service producer's runtime path, for + example to find the tenant project number when creating VMs. Service + producers must persist the tenant project's information after the + project is created. + operationId: serviceconsumermanagement.services.tenancyUnits.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4140,7 +4140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListTenancyUnitsResponse' parameters: - in: path name: servicesId @@ -4157,26 +4157,31 @@ paths: required: true schema: type: string - - in: path - name: tenancyUnitsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: - parameters: *ref_1 post: description: >- - Attempts to undelete a previously deleted tenant project. The project - must be in a DELETED state. There are no guarantees that an undeleted - project will be in a fully restored and functional state. Call the - `ApplyTenantProjectConfig` method to update its configuration and then - validate all managed service resources. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.undeleteProject + Creates a tenancy unit with no tenant resources. If tenancy unit already + exists, it will be returned, however, in this case, returned TenancyUnit + does not have tenant_resources field set and ListTenancyUnits has to be + used to get a complete TenancyUnit with all fields populated. + operationId: serviceconsumermanagement.services.tenancyUnits.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteTenantProjectRequest' + $ref: '#/components/schemas/CreateTenancyUnitRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4188,7 +4193,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TenancyUnit' parameters: - in: path name: servicesId @@ -4205,18 +4210,23 @@ paths: required: true schema: type: string - - in: path - name: tenancyUnitsId - required: true - schema: - type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: parameters: *ref_1 - delete: + post: description: >- - Delete a tenancy unit. Before you delete the tenancy unit, there should - be no tenant resources in it that aren't in a DELETED state. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.delete + Removes the specified project resource identified by a tenant resource + tag. The method removes the project lien with 'TenantManager' origin if + that was added. It then attempts to delete the project. If that + operation fails, this method also fails. Calls to remove already removed + or non-existent tenant project succeed. After the project has been + deleted, or if was already in a DELETED state, resource metadata is + permanently removed from the tenancy unit. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.removeProject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4250,26 +4260,30 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: parameters: *ref_1 post: description: >- - Attach an existing project to the tenancy unit as a new tenant resource. - The project could either be the tenant project reserved by calling - `AddTenantProject` under a tenancy unit of a service producer's project - of a managed service, or from a separate project. The caller is checked - against a set of permissions as if calling `AddTenantProject` on the - same service consumer. To trigger the attachment, the targeted tenant - project must be in a folder. Make sure the ServiceConsumerManagement - service account is the owner of that project. These two requirements are - already met if the project is reserved by calling `AddTenantProject`. - Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.attachProject + Apply a configuration to an existing tenant project. This project must + exist in an active state and have the original owner account. The caller + must have permission to add a project to the given tenancy unit. The + configuration is applied, but any existing settings on the project + aren't modified. Specified policy bindings are applied. Existing + bindings aren't modified. Specified services are activated. No service + is deactivated. If specified, new billing configuration is applied. Omit + a billing configuration to keep the existing one. A service account in + the project is created if previously non existed. Specified labels will + be appended to tenant project, note that the value of existing label key + will be updated if the same label key is requested. The specified folder + is ignored, as moving a tenant project to a different folder isn't + supported. The operation fails if any of the steps fail, but no rollback + of already applied configuration changes is attempted. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.applyProjectConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/AttachTenantProjectRequest' + $ref: '#/components/schemas/ApplyTenantProjectConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4303,21 +4317,13 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}: parameters: *ref_1 - post: + delete: description: >- - Add a new tenant project to the tenancy unit. There can be a maximum of - 1024 tenant projects in a tenancy unit. If there are previously failed - `AddTenantProject` calls, you might need to call `RemoveTenantProject` - first to resolve them before you can make another call to - `AddTenantProject` with the same tag. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.addProject - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddTenantProjectRequest' + Delete a tenancy unit. Before you delete the tenancy unit, there should + be no tenant resources in it that aren't in a DELETED state. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4351,30 +4357,24 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: parameters: *ref_1 post: description: >- - Apply a configuration to an existing tenant project. This project must - exist in an active state and have the original owner account. The caller - must have permission to add a project to the given tenancy unit. The - configuration is applied, but any existing settings on the project - aren't modified. Specified policy bindings are applied. Existing - bindings aren't modified. Specified services are activated. No service - is deactivated. If specified, new billing configuration is applied. Omit - a billing configuration to keep the existing one. A service account in - the project is created if previously non existed. Specified labels will - be appended to tenant project, note that the value of existing label key - will be updated if the same label key is requested. The specified folder - is ignored, as moving a tenant project to a different folder isn't - supported. The operation fails if any of the steps fail, but no rollback - of already applied configuration changes is attempted. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.applyProjectConfig + Deletes the specified project resource identified by a tenant resource + tag. The mothod removes a project lien with a 'TenantManager' origin if + that was added. It will then attempt to delete the project. If that + operation fails, this method also fails. After the project has been + deleted, the tenant resource state is set to DELETED. To permanently + remove resource metadata, call the `RemoveTenantProject` method. New + resources with the same tag can't be added if there are existing + resources in a DELETED state. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.deleteProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplyTenantProjectConfigRequest' + $ref: '#/components/schemas/DeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4435,12 +4435,12 @@ paths: name: pageToken schema: type: string + - in: query + name: query + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: query - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml index eed1114f..b20cf842 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml @@ -9,8 +9,8 @@ info: Provides admission control and telemetry reporting for services integrated with Service Infrastructure. version: v2 - x-discovery-doc-revision: '20240830' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/service-control/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml index f513e202..3eed7c7a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml @@ -9,8 +9,8 @@ info: Service Directory is a platform for discovering, publishing, and connecting services. version: v1 - x-discovery-doc-revision: '20240821' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/service-directory servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml index 85e0faf1..6ebdade1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml @@ -11,7 +11,7 @@ info: consumers. version: v1 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/service-management/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml index 89356e03..1bb80dfc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml @@ -9,8 +9,8 @@ info: Provides automatic management of network configurations necessary for certain services. version: v1 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240916' + x-generated-date: '2024-09-19' externalDocs: url: >- https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started @@ -38,296 +38,452 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Endpoint: - description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true + MethodSettings: + type: object properties: - target: - description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". + selector: type: string - aliases: - type: array description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... + longRunning: + $ref: '#/components/schemas/LongRunning' + description: >- + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + autoPopulatedFields: items: type: string - allowCors: + type: array description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - type: boolean - name: - type: string - description: The canonical name of this endpoint. - id: Endpoint + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id + description: Describes the generator configuration for a method. + id: MethodSettings + QuotaLimit: type: object - Usage: + id: QuotaLimit properties: - rules: - type: array - items: - $ref: '#/components/schemas/UsageRule' + maxLimit: + format: int64 + type: string description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - producerNotificationChannel: + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + duration: + type: string description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + unit: + description: >- + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + type: string + name: type: string - requirements: - type: array - items: - type: string description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. - id: Usage - description: Configuration controlling usage of a service. - type: object - Route: - id: Route - properties: - nextHopGateway: + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + defaultLimit: + description: >- + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + format: int64 type: string + freeTier: description: >- - Fully-qualified URL of the gateway that should handle matching - packets that this route applies to. For example: - `projects/123456/global/gateways/default-internet-gateway` - network: + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + format: int64 + type: string + values: + additionalProperties: + type: string + format: int64 + description: >- + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + type: object + displayName: + description: >- + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. type: string + description: description: >- - Fully-qualified URL of the VPC network in the producer host tenant - project that this route applies to. For example: - `projects/123456/global/networks/host-network` - name: - description: Route name. See https://cloud.google.com/vpc/docs/routes + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). type: string - destRange: - description: Destination CIDR range that this route applies to. + metric: + description: >- + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. type: string description: >- - Represents a route that was created or discovered by a private access - management service. - type: object - LabelDescriptor: + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. + CustomErrorRule: type: object - id: LabelDescriptor + description: A custom error rule. + id: CustomErrorRule properties: - valueType: - enum: - - STRING - - BOOL - - INT64 - type: string - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - description: The type of data that can be assigned to the label. - description: + selector: type: string - description: A human-readable description for the label. - key: + description: >- + Selects messages to which this rule applies. Refer to selector for + syntax details. + isErrorType: + type: boolean + description: >- + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + Control: + type: object + properties: + methodPolicies: + items: + $ref: '#/components/schemas/MethodPolicy' + type: array + description: Defines policies applying to the API methods of the service. + environment: type: string - description: The label key. - description: A description of a label. - DnsZonePair: - id: DnsZonePair + description: >- + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + id: Control + SystemParameters: type: object - description: '* Represents a pair of private and peering DNS zone resources. *' properties: - consumerPeeringZone: - description: The DNS peering zone in the consumer project. - $ref: '#/components/schemas/DnsZone' - producerPrivateZone: - $ref: '#/components/schemas/DnsZone' - description: The private DNS zone in the shared producer host project. - GoSettings: - description: Settings for Go client libraries. - id: GoSettings - type: object - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - Billing: - id: Billing - type: object - description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count - properties: - consumerDestinations: - description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. + rules: type: array - items: - $ref: '#/components/schemas/BillingDestination' - Control: - type: object - id: Control - properties: - environment: - type: string description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com - methodPolicies: - description: Defines policies applying to the API methods of the service. - type: array + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. items: - $ref: '#/components/schemas/MethodPolicy' - description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - DeleteConnectionRequest: + $ref: '#/components/schemas/SystemParameterRule' + id: SystemParameters description: >- - Request to delete a private service access connection. The call will - fail if there are any managed service instances using this connection. - id: DeleteConnectionRequest + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + CloudSQLConfig: properties: - consumerNetwork: + umbrellaNetwork: + type: string + description: The name of the umbrella network in the Cloud SQL umbrella project. + umbrellaProject: + type: string + format: int64 + description: The project number of the Cloud SQL umbrella project. + service: + description: Peering service used for peering with the Cloud SQL project. + type: string + type: object + id: CloudSQLConfig + description: Cloud SQL configuration. + AuthRequirement: + properties: + providerId: + type: string description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is a network name. + id from authentication provider. Example: provider_id: + bookstore_auth + audiences: type: string + description: >- + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + id: AuthRequirement type: object - DeleteConnectionMetadata: description: >- - Metadata provided through GetOperation request for the LRO generated by - Delete Connection API - properties: {} - id: DeleteConnectionMetadata - type: object - ContextRule: + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + ConsumerConfigMetadata: type: object + id: ConsumerConfigMetadata + properties: {} description: >- - A context rule provides information about the context for an individual - API element. - id: ContextRule + Metadata provided through GetOperation request for the LRO generated by + UpdateConsumerConfig API. + Documentation: + description: >- + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. properties: - provided: - type: array - description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. - items: - type: string - requested: - items: - type: string + serviceRootUrl: description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. - type: array - allowedResponseExtensions: + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. + type: string + documentationRootUrl: + type: string + description: The URL to the root of documentation. + sectionOverrides: items: - type: string + $ref: '#/components/schemas/Page' type: array description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - selector: + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries + summary: + description: >- + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. + type: string + overview: type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - allowedRequestExtensions: - items: - type: string + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. + rules: description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/DocumentationRule' type: array - DnsRecordSet: + pages: + items: + $ref: '#/components/schemas/Page' + description: The top level pages for the documentation set. + type: array + type: object + id: Documentation + SystemParameter: + type: object properties: - type: - description: Required. The identifier of a supported record type. - type: string - ttl: + httpHeader: description: >- - Required. The period of time for which this RecordSet can be cached - by resolvers. - format: google-duration + Define the HTTP header name to use for the parameter. It is case + insensitive. type: string - data: - type: array - description: >- - Required. As defined in RFC 1035 (section 5) and RFC 1034 (section - 3.6.1) for examples see - https://cloud.google.com/dns/records/json-record. - items: - type: string - domain: + urlQueryParameter: type: string description: >- - Required. The DNS or domain name of the record set, e.g. - `test.example.com`. Cloud DNS requires that a DNS suffix ends with a - trailing dot. - description: Represents a DNS record set resource. - id: DnsRecordSet + Define the URL query parameter name to use for the parameter. It is + case sensitive. + name: + description: >- + Define the name of the parameter, such as "api_key" . It is case + sensitive. + type: string + id: SystemParameter + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + MonitoredResourceDescriptor: + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. type: object + properties: + name: + type: string + description: >- + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + type: string + description: Optional. The launch stage of the monitored resource definition. + description: + type: string + description: >- + Optional. A detailed description of the monitored resource type that + might be used in documentation. + displayName: + type: string + description: >- + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. + type: + description: >- + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). + type: string + labels: + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array + description: >- + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + id: MonitoredResourceDescriptor SourceInfo: + id: SourceInfo description: Source information used to create a Service Config + type: object properties: sourceFiles: items: @@ -337,192 +493,275 @@ components: type: object type: array description: All files used during config generation. - type: object - id: SourceInfo - LoggingDestination: - type: object - id: LoggingDestination + ListDnsRecordSetsResponse: + id: ListDnsRecordSetsResponse + description: Represents all DNS RecordSets associated with the producer network properties: - logs: - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - items: - type: string + dnsRecordSets: type: array - monitoredResource: - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - type: string - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - AuthProvider: - id: AuthProvider + items: + $ref: '#/components/schemas/DnsRecordSet' + description: DNS record Set Resource type: object - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + BackendRule: properties: - jwtLocations: - items: - $ref: '#/components/schemas/JwtLocation' + protocol: description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - type: array - issuer: + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. type: string - description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - audiences: + minDeadline: + description: Deprecated, do not use. + deprecated: true + format: double + type: number + address: type: string description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - authorizationUrl: + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + pathTranslation: type: string + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + jwtAudience: description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - jwksUri: + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. type: string - description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - id: + overridesByRequestProtocol: + additionalProperties: + $ref: '#/components/schemas/BackendRule' + type: object + description: The map between request protocol and the backend address. + deadline: + description: >- + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + format: double + type: number + operationDeadline: + description: >- + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + type: number + format: double + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string + disableAuth: + type: boolean description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - DnsZone: + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. type: object - description: Represents a DNS zone resource. + id: BackendRule + description: A backend rule provides configuration for an individual API element. + ValidateConsumerConfigResponse: + id: ValidateConsumerConfigResponse properties: - name: + existingSubnetworkCandidates: + type: array + items: + $ref: '#/components/schemas/Subnetwork' + description: >- + List of subnetwork candidates from the request which exist with the + `ip_cidr_range`, `secondary_ip_cider_ranges`, and + `outside_allocation` fields set. + isValid: + description: Indicates whether all the requested validations passed. + type: boolean + validationError: + enum: + - VALIDATION_ERROR_UNSPECIFIED + - VALIDATION_NOT_REQUESTED + - SERVICE_NETWORKING_NOT_ENABLED + - NETWORK_NOT_FOUND + - NETWORK_NOT_PEERED + - NETWORK_PEERING_DELETED + - NETWORK_NOT_IN_CONSUMERS_PROJECT + - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT + - HOST_PROJECT_NOT_FOUND + - CONSUMER_PROJECT_NOT_SERVICE_PROJECT + - RANGES_EXHAUSTED + - RANGES_NOT_RESERVED + - RANGES_DELETED_LATER + - COMPUTE_API_NOT_ENABLED + - USE_PERMISSION_NOT_FOUND + enumDescriptions: + - '' + - In case none of the validations are requested. + - '' + - The network provided by the consumer does not exist. + - The network has not been peered with the producer org. + - The peering was created and later deleted. + - >- + The network is a regular VPC but the network is not in the + consumer's project. + - >- + The consumer project is a service project, and network is a shared + VPC, but the network is not in the host project of this consumer + project. + - >- + The host project associated with the consumer project was not + found. + - >- + The consumer project is not a service project for the specified + host project. + - >- + The reserved IP ranges do not have enough space to create a subnet + of desired size. + - The IP ranges were not reserved. + - The IP ranges were reserved but deleted later. + - The consumer project does not have the compute api enabled. + - >- + The consumer project does not have the permission from the host + project. + type: string + description: The first validation which failed. + type: object + Route: + type: object + description: >- + Represents a route that was created or discovered by a private access + management service. + properties: + network: type: string description: >- - User assigned name for this resource. Must be unique within the - project. The name must be 1-63 characters long, must begin with a - letter, end with a letter or digit, and only contain lowercase - letters, digits or dashes. - dnsSuffix: + Fully-qualified URL of the VPC network in the producer host tenant + project that this route applies to. For example: + `projects/123456/global/networks/host-network` + name: + description: Route name. See https://cloud.google.com/vpc/docs/routes + type: string + destRange: + description: Destination CIDR range that this route applies to. type: string + nextHopGateway: description: >- - The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS - requires that a DNS suffix ends with a trailing dot. - id: DnsZone - EnableVpcServiceControlsRequest: - id: EnableVpcServiceControlsRequest + Fully-qualified URL of the gateway that should handle matching + packets that this route applies to. For example: + `projects/123456/global/gateways/default-internet-gateway` + type: string + id: Route + UpdateDnsRecordSetRequest: + description: >- + Request to update a record set from a private managed DNS zone in the + shared producer host project. The name, type, ttl, and data values of + the existing record set must all exactly match an existing record set in + the specified zone. + id: UpdateDnsRecordSetRequest properties: + newDnsRecordSet: + $ref: '#/components/schemas/DnsRecordSet' + description: >- + Required. The new values that the DNS record set should be updated + to hold. consumerNetwork: - type: string description: >- Required. The network that the consumer is using to connect with services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + type: string + zone: + type: string + description: >- + Required. The name of the private DNS zone in the shared producer + host project from which the record set will be removed. + existingDnsRecordSet: + description: Required. The existing DNS record set to update. + $ref: '#/components/schemas/DnsRecordSet' type: object - description: Request to enable VPC service controls. - Quota: - description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 + LogDescriptor: + id: LogDescriptor type: object properties: - limits: - items: - $ref: '#/components/schemas/QuotaLimit' + displayName: + description: >- + The human-readable name for this log. This information appears on + the user interface and should be concise. + type: string + labels: type: array - description: List of QuotaLimit definitions for the service. - metricRules: items: - $ref: '#/components/schemas/MetricRule' + $ref: '#/components/schemas/LabelDescriptor' description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - type: array - id: Quota - ExperimentalFeatures: - description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. - id: ExperimentalFeatures - properties: - restAsyncIoEnabled: - type: boolean + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. + name: description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. - type: object - OAuthRequirements: - type: object - id: OAuthRequirements - properties: - canonicalScopes: + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + type: string + description: type: string description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read + A human-readable description of this log. This information appears + in the documentation and can contain details. + description: >- + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer + OAuthRequirements: + id: OAuthRequirements + type: object description: >- OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google @@ -538,525 +777,371 @@ components: that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. - SystemParameter: - description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. properties: - urlQueryParameter: - description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - type: string - name: - description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - type: string - httpHeader: - type: string - description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - id: SystemParameter - type: object - AddRolesRequest: - type: object - properties: - policyBinding: - items: - $ref: '#/components/schemas/PolicyBinding' - description: Required. List of policy bindings to add to shared VPC host project. - type: array - consumerNetwork: + canonicalScopes: type: string description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is a network name. - id: AddRolesRequest + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read + UsageRule: description: >- - Request for AddRoles to allow Service Producers to add roles in the - shared VPC host project for them to use. - ConsumerConfig: + Usage configuration rules for the service. NOTE: Under development. Use + this rule to configure unregistered calls for the service. Unregistered + calls are calls that do not contain consumer project identity. (Example: + calls that do not contain an API key). By default, API methods do not + allow unregistered calls, and each method call must be identified by a + consumer project identity. Use this rule to allow/disallow unregistered + calls. Example of an API that wants to allow unregistered calls for + entire service. usage: rules: - selector: "*" allow_unregistered_calls: + true Example of a method that wants to allow unregistered calls. usage: + rules: - selector: "google.example.library.v1.LibraryService.CreateBook" + allow_unregistered_calls: true type: object - id: ConsumerConfig + id: UsageRule properties: - consumerExportCustomRoutes: - type: boolean - description: >- - Export custom routes flag value for peering from consumer to - producer. - reservedRanges: - readOnly: true - items: - $ref: >- - #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange - description: >- - Output only. The reserved ranges associated with this private - service access connection. - type: array - producerImportCustomRoutes: - description: >- - Import custom routes flag value for peering from producer to - consumer. - type: boolean - producerExportCustomRoutes: - type: boolean - description: >- - Export custom routes flag value for peering from producer to - consumer. - usedIpRanges: - items: - type: string - readOnly: true - description: Output only. The IP ranges already in use by consumer or producer - type: array - producerExportSubnetRoutesWithPublicIp: + skipServiceControl: type: boolean description: >- - Export subnet routes with public ip flag value for peering from - producer to consumer. - cloudsqlConfigs: - items: - $ref: '#/components/schemas/CloudSQLConfig' - description: Represents one or multiple Cloud SQL configurations. - type: array - vpcScReferenceArchitectureEnabled: - type: boolean + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + allowUnregisteredCalls: description: >- - Output only. Indicates whether the VPC Service Controls reference - architecture is configured for the producer VPC host network. - readOnly: true - producerImportSubnetRoutesWithPublicIp: + If true, the selected method allows unregistered calls, e.g. calls + that don't identify any user or application. type: boolean - description: >- - Import subnet routes with public ip flag value for peering from - producer to consumer. - producerNetwork: + selector: type: string description: >- - Output only. The VPC host network that is used to host managed - service instances. In the format, - projects/{project}/global/networks/{network} where {project} is the - project number e.g. '12345' and {network} is the network name. - readOnly: true - consumerImportSubnetRoutesWithPublicIp: - type: boolean - description: >- - Import subnet routes with public ip flag value for peering from - consumer to producer. - consumerExportSubnetRoutesWithPublicIp: - description: >- - Export subnet routes with public ip flag value for peering from - consumer to producer. - type: boolean - consumerImportCustomRoutes: - description: >- - Import custom routes flag value for peering from consumer to - producer. - type: boolean - description: Configuration information for a private service access connection. - PeeredDnsDomain: - id: PeeredDnsDomain + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + PolicyBinding: properties: - name: - description: >- - User assigned name for this resource. Must be unique within the - consumer network. The name must be 1-63 characters long, must begin - with a letter, end with a letter or digit, and only contain - lowercase letters, digits or dashes. + member: type: string - dnsSuffix: + description: >- + Required. Member to bind the role with. See + /iam/docs/reference/rest/v1/Policy#Binding for how to format each + member. Eg. - user:myuser@mydomain.com - + serviceAccount:my-service-account@app.gserviceaccount.com + role: type: string description: >- - The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires - that a DNS suffix ends with a trailing dot. + Required. Role to apply. Only allowlisted roles can be used at the + specified granularity. The role must be one of the following: - + 'roles/container.hostServiceAgentUser' applied on the shared VPC + host project - 'roles/compute.securityAdmin' applied on the shared + VPC host project - 'roles/compute.networkAdmin' applied on the + shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared + VPC host project - 'roles/dns.admin' applied on the shared VPC host + project - 'roles/logging.admin' applied on the shared VPC host + project - 'roles/monitoring.viewer' applied on the shared VPC host + project - 'roles/servicemanagement.quotaViewer' applied on the + shared VPC host project + description: Grouping of IAM role and IAM member. type: object - description: >- - DNS domain suffix for which requests originating in the producer VPC - network are resolved in the associated consumer VPC network. - Backend: + id: PolicyBinding + NodeSettings: + id: NodeSettings properties: - rules: - items: - $ref: '#/components/schemas/BackendRule' - type: array - description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - id: Backend - description: '`Backend` defines the backend configuration for a service.' - type: object - PeeredDnsDomainMetadata: - type: object - id: PeeredDnsDomainMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - CreatePeeredDnsDomain API. - properties: {} - AddDnsZoneRequest: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' type: object + description: Settings for Node client libraries. + MonitoringDestination: properties: - name: - type: string - description: >- - Required. The name for both the private zone in the shared producer - host project and the peering zone in the consumer project. Must be - unique within both projects. The name must be 1-63 characters long, - must begin with a letter, end with a letter or digit, and only - contain lowercase letters, digits or dashes. - dnsSuffix: + monitoredResource: type: string description: >- - Required. The DNS name suffix for the zones e.g. `example.com.`. - Cloud DNS requires that a DNS suffix ends with a trailing dot. - consumerNetwork: - type: string + The monitored resource type. The type must be defined in + Service.monitored_resources section. + metrics: + type: array + items: + type: string description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - id: AddDnsZoneRequest + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + id: MonitoringDestination description: >- - Request to add a private managed DNS zone in the shared producer host - project and a matching DNS peering zone in the consumer project. - ListDnsRecordSetsResponse: - description: Represents all DNS RecordSets associated with the producer network + Configuration of a specific monitoring destination (the producer project + or the consumer project). type: object - id: ListDnsRecordSetsResponse + AddDnsZoneMetadata: + id: AddDnsZoneMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsZone API + type: object + properties: {} + Quota: properties: - dnsRecordSets: - description: DNS record Set Resource + limits: items: - $ref: '#/components/schemas/DnsRecordSet' + $ref: '#/components/schemas/QuotaLimit' + description: List of QuotaLimit definitions for the service. type: array - AuthenticationRule: - id: AuthenticationRule + metricRules: + description: >- + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + type: array + items: + $ref: '#/components/schemas/MetricRule' + type: object description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + id: Quota + CommonLanguageSettings: type: object + description: Required information for every language. properties: - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - allowWithoutCredential: + selectiveGapicGeneration: + $ref: '#/components/schemas/SelectiveGapicGeneration' description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - type: boolean - requirements: - items: - $ref: '#/components/schemas/AuthRequirement' - type: array - description: Requirements for additional authentication providers. - selector: + Configuration for which RPCs should be generated in the GAPIC + client. + referenceDocsUri: type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - MonitoringDestination: - properties: - metrics: + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + deprecated: true + destinations: + type: array items: type: string + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. - type: array - monitoredResource: - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: string + The destination where API teams want this client library to be + published. + id: CommonLanguageSettings + DnsZonePair: type: object - id: MonitoringDestination - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - AuthRequirement: - id: AuthRequirement - description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + description: '* Represents a pair of private and peering DNS zone resources. *' + id: DnsZonePair + properties: + producerPrivateZone: + description: The private DNS zone in the shared producer host project. + $ref: '#/components/schemas/DnsZone' + consumerPeeringZone: + description: The DNS peering zone in the consumer project. + $ref: '#/components/schemas/DnsZone' + VpcServiceControls: type: object properties: - providerId: - type: string - description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - audiences: + enabled: description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - type: string - Mixin: + Output only. Indicates whether the VPC Service Controls are enabled + or disabled for the connection. If the consumer called the + EnableVpcServiceControls method, then this is true. If the consumer + called DisableVpcServiceControls, then this is false. The default is + false. + type: boolean + readOnly: true + id: VpcServiceControls + description: Response for the get VPC Service Controls request. + PartialDeleteConnectionMetadata: + type: object + id: PartialDeleteConnectionMetadata + properties: {} description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - id: Mixin + Metadata provided through GetOperation request for the LRO generated by + Partial Delete Connection API + RemoveDnsRecordSetResponse: + description: Blank message response type for RemoveDnsRecordSet API + properties: {} + type: object + id: RemoveDnsRecordSetResponse + UpdateDnsRecordSetMetadata: + id: UpdateDnsRecordSetMetadata + properties: {} + type: object + description: >- + Metadata provided through GetOperation request for the LRO generated by + UpdateDnsRecordSet API + Type: + description: A protocol buffer message type. + id: Type properties: name: - description: The fully qualified name of the interface which is included. + description: The fully qualified message name. type: string - root: + edition: type: string description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + syntax: + description: The source syntax. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + fields: + description: The list of fields. + items: + $ref: '#/components/schemas/Field' + type: array + oneofs: + type: array + description: The list of types appearing in `oneof` definitions in this type. + items: + type: string + options: + description: The protocol buffer options. + items: + $ref: '#/components/schemas/Option' + type: array type: object - UsageRule: - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true + Endpoint: properties: - skipServiceControl: - type: boolean - description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - selector: + aliases: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + items: + type: string + type: array + name: type: string - allowUnregisteredCalls: + description: The canonical name of this endpoint. + allowCors: type: boolean description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - type: object - id: UsageRule - Api: - type: object - id: Api - properties: - options: - type: array - items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the interface. - version: - type: string - description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. - name: - type: string - description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - description: The source syntax of the service. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: >- - Source context for the protocol buffer service represented by this - message. - methods: - description: The methods of this interface, in unspecified order. - items: - $ref: '#/components/schemas/Method' - type: array - mixins: - items: - $ref: '#/components/schemas/Mixin' - type: array - description: Included interfaces. See Mixin. - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. - GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: - description: Allocated IP address ranges for this private service access connection. - properties: - address: + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. + target: type: string description: >- - The starting address of the reserved range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix length is the CIDR range for the reserved range. - name: - description: The name of the reserved range. - type: string - ipPrefixLength: - format: int32 - type: integer - description: The prefix length of the reserved range. - id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". type: object + description: >- + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + id: Endpoint Range: properties: - ipCidrRange: - type: string - description: >- - CIDR range in "10.x.x.x/y" format that is within the allocated - ranges and currently unused. network: type: string description: >- In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` - description: Represents a found unused range. - type: object - id: Range - SecondaryIpRange: - properties: - rangeName: - description: Name of the secondary IP range. - type: string ipCidrRange: - description: Secondary IP CIDR range in `x.x.x.x/y` format. + description: >- + CIDR range in "10.x.x.x/y" format that is within the allocated + ranges and currently unused. type: string - id: SecondaryIpRange + id: Range + description: Represents a found unused range. type: object - SecondaryIpRangeSpec: - id: SecondaryIpRangeSpec + Page: type: object + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. properties: - outsideAllocationPublicIpRange: - type: string - description: >- - Optional. Enable outside allocation using public IP addresses. Any - public IP range may be specified. If this field is provided, we will - not use customer reserved ranges for this secondary IP range. - rangeName: + content: type: string description: >- - Required. A name for the secondary IP range. The name must be 1-63 - characters long, and comply with RFC1035. The name must be unique - within the subnetwork. - ipPrefixLength: - format: int32 - type: integer + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. + name: description: >- - Required. The prefix length of the secondary IP range. Use CIDR - range notation, such as `30` to provision a secondary IP range with - an `x.x.x.x/30` CIDR range. The IP address range is drawn from a - pool of available ranges in the service consumer's allocated range. - requestedAddress: + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. type: string + subpages: + type: array description: >- - Optional. The starting address of a range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix range is the CIDR range for the secondary IP range. - The range must be within the allocated range that is assigned to the - private connection. If the CIDR range isn't available, the call - fails. - AddDnsZoneResponse: - properties: - producerPrivateZone: - description: The private DNS zone created in the shared producer host project. - $ref: '#/components/schemas/DnsZone' - consumerPeeringZone: - description: The DNS peering zone created in the consumer project. - $ref: '#/components/schemas/DnsZone' - id: AddDnsZoneResponse - type: object - description: >- - Represents managed DNS zones created in the shared producer host and - consumer projects. + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. + items: + $ref: '#/components/schemas/Page' + id: Page FieldPolicy: - description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. - type: object properties: + resourceType: + type: string + description: >- + Specifies the resource type for the resource referred to by the + field. selector: type: string description: >- @@ -1074,562 +1159,692 @@ components: the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get". - resourceType: - description: >- - Specifies the resource type for the resource referred to by the - field. - type: string + type: object id: FieldPolicy - MetricRule: description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - id: MetricRule + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. + Operation: + id: Operation type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. properties: - metricCosts: - type: object - description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. + response: additionalProperties: - type: string - format: int64 - selector: - type: string + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - PartialDeleteConnectionMetadata: - description: >- - Metadata provided through GetOperation request for the LRO generated by - Partial Delete Connection API - id: PartialDeleteConnectionMetadata - type: object - properties: {} - RemoveDnsRecordSetResponse: - properties: {} - type: object - id: RemoveDnsRecordSetResponse - description: Blank message response type for RemoveDnsRecordSet API - CloudSQLConfig: - type: object - id: CloudSQLConfig - properties: - umbrellaProject: - type: string - format: int64 - description: The project number of the Cloud SQL umbrella project. - umbrellaNetwork: - description: The name of the umbrella network in the Cloud SQL umbrella project. - type: string - service: - description: Peering service used for peering with the Cloud SQL project. - type: string - description: Cloud SQL configuration. - ValidateConsumerConfigResponse: - properties: - existingSubnetworkCandidates: - type: array - items: - $ref: '#/components/schemas/Subnetwork' - description: >- - List of subnetwork candidates from the request which exist with the - `ip_cidr_range`, `secondary_ip_cider_ranges`, and - `outside_allocation` fields set. - isValid: - description: Indicates whether all the requested validations passed. - type: boolean - validationError: - type: string - enum: - - VALIDATION_ERROR_UNSPECIFIED - - VALIDATION_NOT_REQUESTED - - SERVICE_NETWORKING_NOT_ENABLED - - NETWORK_NOT_FOUND - - NETWORK_NOT_PEERED - - NETWORK_PEERING_DELETED - - NETWORK_NOT_IN_CONSUMERS_PROJECT - - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT - - HOST_PROJECT_NOT_FOUND - - CONSUMER_PROJECT_NOT_SERVICE_PROJECT - - RANGES_EXHAUSTED - - RANGES_NOT_RESERVED - - RANGES_DELETED_LATER - - COMPUTE_API_NOT_ENABLED - - USE_PERMISSION_NOT_FOUND - enumDescriptions: - - '' - - In case none of the validations are requested. - - '' - - The network provided by the consumer does not exist. - - The network has not been peered with the producer org. - - The peering was created and later deleted. - - >- - The network is a regular VPC but the network is not in the - consumer's project. - - >- - The consumer project is a service project, and network is a shared - VPC, but the network is not in the host project of this consumer - project. - - >- - The host project associated with the consumer project was not - found. - - >- - The consumer project is not a service project for the specified - host project. - - >- - The reserved IP ranges do not have enough space to create a subnet - of desired size. - - The IP ranges were not reserved. - - The IP ranges were reserved but deleted later. - - The consumer project does not have the compute api enabled. - - >- - The consumer project does not have the permission from the host - project. - description: The first validation which failed. - type: object - id: ValidateConsumerConfigResponse - Option: - id: Option - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - type: object - properties: - name: - type: string + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + metadata: description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - value: - type: object + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. additionalProperties: - type: any description: Properties of the object. Contains field @type with type URL. - description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - BackendRule: - properties: - protocol: - description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. - type: string - deadline: - format: double - description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - type: number - overridesByRequestProtocol: - description: The map between request protocol and the backend address. + type: any type: object - additionalProperties: - $ref: '#/components/schemas/BackendRule' - pathTranslation: - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + name: type: string - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - operationDeadline: description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - format: double - type: number - disableAuth: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + done: type: boolean description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - selector: - type: string + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + error: + $ref: '#/components/schemas/Status' description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - minDeadline: - format: double - description: Deprecated, do not use. - type: number - deprecated: true - address: + The error result of the operation in case of failure or + cancellation. + RemoveDnsRecordSetRequest: + id: RemoveDnsRecordSetRequest + description: >- + Request to remove a record set from a private managed DNS zone in the + shared producer host project. The name, type, ttl, and data values must + all exactly match an existing record set in the specified zone. + type: object + properties: + dnsRecordSet: + description: Required. The DNS record set to remove. + $ref: '#/components/schemas/DnsRecordSet' + consumerNetwork: type: string description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - jwtAudience: + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + zone: type: string description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. - type: object - description: A backend rule provides configuration for an individual API element. - id: BackendRule - Authentication: - id: Authentication - properties: - providers: - items: - $ref: '#/components/schemas/AuthProvider' - description: Defines a set of authentication providers that a service supports. - type: array - rules: - items: - $ref: '#/components/schemas/AuthenticationRule' - description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array + Required. The name of the private DNS zone in the shared producer + host project from which the record set will be removed. + HttpRule: + id: HttpRule description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC method and one or more HTTP REST endpoints. It allows developers to + build a single API service that supports both gRPC APIs and REST APIs. + Many systems, including [Google + APIs](https://github.com/googleapis/googleapis), [Cloud + Endpoints](https://cloud.google.com/endpoints), [gRPC + Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + and use it for large scale production services. `HttpRule` defines the + schema of the gRPC/REST mapping. The mapping specifies how different + portions of the gRPC request message are mapped to the URL path, URL + query parameters, and HTTP request body. It also controls how the gRPC + response message is mapped to the HTTP response body. `HttpRule` is + typically specified as an `google.api.http` annotation on the gRPC + method. Each mapping specifies a URL path template and an HTTP method. + The path template may refer to one or more fields in the gRPC request + message, as long as each field is a non-repeated field with a primitive + (non-message) type. The path template controls how fields of the request + message are mapped to the URL path. Example: service Messaging { rpc + GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message + GetMessageRequest { string name = 1; // Mapped to URL path. } message + Message { string text = 1; // The resource content. } This enables an + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + "foo"))` Note that fields which are mapped to URL query parameters must + have a primitive type or a repeated primitive type or a non-repeated + message type. In the case of a repeated type, the parameter can be + repeated in the URL as `...?param=A¶m=B`. In the case of a message + type, each field of the message is mapped to a separate parameter, such + as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request + body, the `body` field specifies the mapping. Consider a REST update + method on the message resource collection: service Messaging { rpc + UpdateMessage(UpdateMessageRequest) returns (Message) { option + (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" + }; } } message UpdateMessageRequest { string message_id = 1; // mapped + to the URL Message message = 2; // mapped to the body } The following + HTTP JSON to RPC mapping is enabled, where the representation of the + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The + special name `*` can be used in the body mapping to define that every + field not bound by the path template should be mapped to the request + body. This enables the following alternative definition of the update + method: service Messaging { rpc UpdateMessage(Message) returns (Message) + { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: + "*" }; } } message Message { string message_id = 1; string text = 2; } + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using + `*` in the body mapping, it is not possible to have HTTP parameters, as + all fields not bound by the path end in the body. This makes this option + more rarely used in practice when defining REST APIs. The common usage + of `*` is in custom methods which don't use the URL at all for + transferring data. It is possible to define multiple HTTP methods for + one RPC by using the `additional_bindings` option. Example: service + Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/messages/{message_id}" + additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } + }; } } message GetMessageRequest { string message_id = 1; string user_id + = 2; } This enables the following two alternative HTTP JSON to RPC + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{var}`. If a variable contains multiple path segments, such as + `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a + URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` + are percent-encoded. The server side does the reverse decoding, except + "%2F" and "%2f" are left unchanged. Such variables show up in the + [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{+var}`. Using gRPC API Service Configuration gRPC API Service + Configuration (service config) is a configuration language for + configuring a gRPC service to become a user-facing product. The service + config is simply the YAML representation of the `google.api.Service` + proto message. As an alternative to annotating your proto file, you can + configure gRPC transcoding in your service config YAML files. You do + this by specifying a `HttpRule` that maps the gRPC method to a REST + endpoint, achieving the same effect as the proto annotation. This can be + particularly useful if you have a proto that is reused in multiple + services. Note that any transcoding specified in the service config will + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC + Transcoding is used to map a gRPC to JSON REST endpoints, the proto to + JSON conversion must follow the [proto3 + specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + While the single segment variable follows the semantics of [RFC + 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + Expansion, the multi segment variable **does not** follow RFC 6570 + Section 3.2.3 Reserved Expansion. The reason is that the Reserved + Expansion does not expand special characters like `?` and `#`, which + would lead to invalid URLs. As the result, gRPC Transcoding uses a + custom encoding for multi segment variables. The path variables **must + not** refer to any repeated or mapped field, because client libraries + are not capable of handling such variable expansion. The path variables + **must not** capture the leading "/" character. The reason is that the + most common use case "{var}" does not capture the leading "/" character. + For consistency, all path variables must share the same behavior. + Repeated message fields must not be mapped to URL query parameters, + because no client library can support such complicated mapping. If an + API needs to use a JSON array for request or response body, it can map + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. type: object - SystemParameterRule: properties: - parameters: + delete: + type: string + description: Maps to HTTP DELETE. Used for deleting a resource. + body: + type: string + description: >- + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + post: + type: string + description: >- + Maps to HTTP POST. Used for creating a resource or performing an + action. + put: + description: Maps to HTTP PUT. Used for replacing a resource. + type: string + custom: + $ref: '#/components/schemas/CustomHttpPattern' + description: >- + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + additionalBindings: type: array items: - $ref: '#/components/schemas/SystemParameter' + $ref: '#/components/schemas/HttpRule' description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). + get: + description: >- + Maps to HTTP GET. Used for listing and getting information about + resources. + type: string selector: + type: string description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + Selects a method to which this rule applies. Refer to selector for + syntax details. + responseBody: + description: >- + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. type: string - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - type: object - id: SystemParameterRule - RemoveDnsZoneResponse: - id: RemoveDnsZoneResponse + patch: + type: string + description: Maps to HTTP PATCH. Used for updating a resource. + PeeredDnsDomainMetadata: properties: {} - description: Blank message response type for RemoveDnsZone API + id: PeeredDnsDomainMetadata type: object - Subnetwork: description: >- - Represents a subnet that was created or discovered by a private access - management service. + Metadata provided through GetOperation request for the LRO generated by + CreatePeeredDnsDomain API. + Field: properties: - secondaryIpRanges: + cardinality: + type: string + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + description: The field cardinality. + options: items: - $ref: '#/components/schemas/SecondaryIpRange' + $ref: '#/components/schemas/Option' type: array - description: List of secondary IP ranges in this subnetwork. - outsideAllocation: - description: >- - This is a discovered subnet that is not within the current consumer - allocated ranges. + description: The protocol buffer options. + packed: + description: Whether to use alternative packed wire representation. type: boolean - name: - type: string - description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ - region: - type: string - description: GCP region where the subnetwork is located. - ipCidrRange: - type: string - description: Subnetwork CIDR range in `10.x.x.x/y` format. - network: + oneofIndex: + format: int32 description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + type: integer + name: type: string - type: object - id: Subnetwork - DocumentationRule: - id: DocumentationRule - type: object - description: A documentation rule provides information about individual API elements. - properties: - selector: + description: The field name. + jsonName: + description: The field JSON name. type: string + defaultValue: description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. - description: + The string value of the default value of this field. Proto2 syntax + only. type: string - description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. - deprecationDescription: - description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. + kind: + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + description: The field type. + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. type: string - disableReplacementWords: + number: + format: int32 + description: The field number. + type: integer + typeUrl: description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. type: string - MethodPolicy: + description: A single field of a message type. + id: Field + type: object + SelectiveGapicGeneration: + description: >- + This message is used to configure the generation of a subset of the RPCs + in a service for client libraries. type: object + id: SelectiveGapicGeneration properties: - selector: - type: string + methods: description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - requestPolicies: - description: Policies that are applicable to the request message. - items: - $ref: '#/components/schemas/FieldPolicy' + An allowlist of the fully qualified names of RPCs that should be + included on public client surfaces. type: array - description: Defines policies applying to an RPC method. - id: MethodPolicy - ListPeeredDnsDomainsResponse: - description: Response to list peered DNS domains for a given connection. - properties: - peeredDnsDomains: items: - $ref: '#/components/schemas/PeeredDnsDomain' - description: The list of peered DNS domains. - type: array - id: ListPeeredDnsDomainsResponse + type: string + RemoveDnsZoneResponse: + description: Blank message response type for RemoveDnsZone API + id: RemoveDnsZoneResponse + properties: {} type: object - Connection: - description: >- - Represents a private connection resource. A private connection is - implemented as a VPC Network Peering connection between a service - producer's VPC network and a service consumer's VPC network. + CppSettings: + id: CppSettings type: object - id: Connection properties: - peering: - readOnly: true - type: string - description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. - reservedPeeringRanges: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + description: Settings for C++ client libraries. + LoggingDestination: + type: object + properties: + logs: type: array description: >- - The name of one or more allocated IP address ranges for this service - producer of type `PEERING`. Note that invoking CreateConnection - method with a different range when connection is already established - will not modify already provisioned service producer subnetworks. If - CreateConnection method is invoked repeatedly to reconnect when - peering connection had been disconnected on the consumer side, - leaving this field empty will restore previously allocated IP - ranges. + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". items: type: string - service: - type: string - readOnly: true + monitoredResource: description: >- - Output only. The name of the peering service that's associated with - this connection, in the following format: `services/{service name}`. - network: + The monitored resource type. The type must be defined in the + Service.monitored_resources section. type: string - description: >- - The name of service consumer's VPC network that's connected with - service producer network, in the following format: - `projects/{project}/global/networks/{network}`. `{project}` is a - project number, such as in `12345` that includes the VPC service - consumer's VPC network. `{network}` is the name of the service - consumer's VPC network. - ListOperationsResponse: + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). + id: LoggingDestination + SecondaryIpRange: type: object - description: The response message for Operations.ListOperations. - id: ListOperationsResponse properties: - nextPageToken: + ipCidrRange: + description: Secondary IP CIDR range in `x.x.x.x/y` format. type: string - description: The standard List next-page token. - operations: - type: array - items: - $ref: '#/components/schemas/Operation' - description: >- - A list of operations that matches the specified filter in the - request. - AddDnsRecordSetMetadata: - id: AddDnsRecordSetMetadata + rangeName: + type: string + description: Name of the secondary IP range. + id: SecondaryIpRange + UpdateConsumerConfigRequest: + type: object + id: UpdateConsumerConfigRequest + properties: + consumerConfig: + $ref: '#/components/schemas/ConsumerConfig' + description: Required. The updated peering config. description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsRecordSet API + Request to update the configuration of a service networking connection + including the import/export of custom routes and subnetwork routes with + public IP. + AddDnsRecordSetRequest: + description: >- + Request to add a record set to a private managed DNS zone in the shared + producer host project. type: object - properties: {} - Monitoring: + properties: + dnsRecordSet: + description: Required. The DNS record set to add. + $ref: '#/components/schemas/DnsRecordSet' + consumerNetwork: + type: string + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + zone: + type: string + description: >- + Required. The name of the private DNS zone in the shared producer + host project to which the record set will be added. + id: AddDnsRecordSetRequest + Service: description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth + id: Service + type: object properties: - consumerDestinations: + control: + $ref: '#/components/schemas/Control' + description: Configuration for the service control plane. + http: + description: HTTP configuration. + $ref: '#/components/schemas/Http' + publishing: + $ref: '#/components/schemas/Publishing' + description: >- + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + systemTypes: + description: >- + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. items: - $ref: '#/components/schemas/MonitoringDestination' + $ref: '#/components/schemas/Type' type: array + authentication: + description: Auth configuration. + $ref: '#/components/schemas/Authentication' + endpoints: description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - producerDestinations: - description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + items: + $ref: '#/components/schemas/Endpoint' + type: array + metrics: type: array + description: Defines the metrics used by this service. items: - $ref: '#/components/schemas/MonitoringDestination' - type: object - id: Monitoring - JwtLocation: - id: JwtLocation - properties: - valuePrefix: + $ref: '#/components/schemas/MetricDescriptor' + logs: + type: array + items: + $ref: '#/components/schemas/LogDescriptor' + description: Defines the logs used by this service. + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + billing: + description: Billing configuration. + $ref: '#/components/schemas/Billing' + id: description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. type: string - header: + title: type: string - description: Specifies HTTP header name to extract JWT token. - cookie: + description: >- + The product title for this service, it is the name displayed in + Google Cloud Console. + apis: + description: >- + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + items: + $ref: '#/components/schemas/Api' + type: array + backend: + description: API backend configuration. + $ref: '#/components/schemas/Backend' + enums: + description: >- + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + items: + $ref: '#/components/schemas/Enum' + type: array + configVersion: + format: uint32 + type: integer + description: >- + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + systemParameters: + description: System parameter configuration. + $ref: '#/components/schemas/SystemParameters' + monitoredResources: + type: array + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + description: >- + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + types: + items: + $ref: '#/components/schemas/Type' + description: >- + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 + type: array + producerProjectId: type: string - description: Specifies cookie name to extract JWT token. - query: - description: Specifies URL query parameter name to extract JWT token. + description: The Google project that owns this service. + name: type: string + description: >- + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + sourceInfo: + description: >- + Output only. The source information for this configuration if + available. + $ref: '#/components/schemas/SourceInfo' + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + logging: + description: Logging configuration. + $ref: '#/components/schemas/Logging' + MetricDescriptorMetadata: + description: Additional annotations that can be used to guide the usage of a metric. type: object - description: Specifies a location to extract JWT from an API request. - MetricDescriptor: properties: - description: + samplePeriod: type: string + format: google-duration description: >- - A detailed description of the metric, which can be used in - documentation. - monitoredResourceTypes: + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. + ingestDelay: description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. + format: google-duration + type: string + timeSeriesResourceHierarchyLevel: + type: array + description: The scope of the timeseries data of the metric. items: type: string - type: array + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER launchStage: - enum: + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + type: string + enum: - LAUNCH_STAGE_UNSPECIFIED - UNIMPLEMENTED - PRELAUNCH @@ -1638,7 +1853,6 @@ components: - BETA - GA - DEPRECATED - type: string enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -1677,827 +1891,616 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - description: Optional. The launch stage of the metric definition. - name: - type: string - description: The resource name of the metric descriptor. - displayName: + deprecated: true + id: MetricDescriptorMetadata + GetDnsZoneResponse: + type: object + id: GetDnsZoneResponse + properties: + producerPrivateZone: + $ref: '#/components/schemas/DnsZone' + description: The private DNS zone created in the shared producer host project. + consumerPeeringZone: + description: The DNS peering zone created in the consumer project. + $ref: '#/components/schemas/DnsZone' + description: >- + Represents managed DNS zones created in the shared Producer host and + consumer projects. + LabelDescriptor: + type: object + id: LabelDescriptor + description: A description of a label. + properties: + description: + description: A human-readable description for the label. type: string - description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - type: - description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" + key: type: string + description: The label key. valueType: - type: string enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. - description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + type: string + description: The type of data that can be assigned to the label. enum: - - VALUE_TYPE_UNSPECIFIED + - STRING - BOOL - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY - labels: + ClientLibrarySettings: + id: ClientLibrarySettings + description: Details about how and where to publish client libraries. + type: object + properties: + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + version: + type: string description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. - type: array - items: - $ref: '#/components/schemas/LabelDescriptor' - metricKind: + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". + phpSettings: + $ref: '#/components/schemas/PhpSettings' + description: Settings for PHP client libraries. + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Launch stage of this version of the API. enumDescriptions: - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. + - The feature is not yet implemented. Users can not use it. - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - type: string - unit: + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. type: string + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' + cppSettings: + $ref: '#/components/schemas/CppSettings' + description: Settings for C++ client libraries. + restNumericEnums: description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). - metadata: - description: Optional. Metadata which can be used to guide usage of the metric. - $ref: '#/components/schemas/MetricDescriptorMetadata' - type: object - id: MetricDescriptor - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. - CustomHttpPattern: - id: CustomHttpPattern - type: object - properties: - path: - type: string - description: The path matched by this custom verb. - kind: - type: string - description: The name of this custom HTTP verb. - description: A custom pattern is used for defining custom HTTP verb. - JavaSettings: - type: object - description: Settings for Java client libraries. - id: JavaSettings - properties: - serviceClassNames: - type: object - description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - additionalProperties: - type: string - libraryPackage: - description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 - type: string - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - RemoveDnsZoneRequest: - type: object - properties: - name: - description: >- - Required. The name for both the private zone in the shared producer - host project and the peering zone in the consumer project. - type: string - consumerNetwork: - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - type: string - id: RemoveDnsZoneRequest - description: >- - Request to remove a private managed DNS zone in the shared producer host - project and a matching DNS peering zone in the consumer project. - Publishing: + When using transport=rest, the client request will encode enums as + numbers rather than strings. + type: boolean + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. + rubySettings: + $ref: '#/components/schemas/RubySettings' + description: Settings for Ruby client libraries. + goSettings: + description: Settings for Go client libraries. + $ref: '#/components/schemas/GoSettings' + RangeReservation: + description: Represents a range reservation. + id: RangeReservation properties: - protoReferenceDocumentationUri: - description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - type: string - restReferenceDocumentationUri: - type: string - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - codeownerGithubTeams: - description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. - type: array - items: - type: string - librarySettings: + subnetworkCandidates: type: array description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. - items: - $ref: '#/components/schemas/ClientLibrarySettings' - newIssueUri: - type: string - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - apiShortName: - description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". - type: string - docTagPrefix: - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - type: string - githubLabel: - description: >- - GitHub label to apply to issues and pull requests opened for this - API. - type: string - organization: - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - type: string - description: For whom the client library is being published. - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - documentationUri: - description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - type: string - methodSettings: - items: - $ref: '#/components/schemas/MethodSettings' - description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - type: array - type: object - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - id: Publishing - HttpRule: - type: object - id: HttpRule - description: >- - gRPC Transcoding gRPC Transcoding is a feature for mapping between a - gRPC method and one or more HTTP REST endpoints. It allows developers to - build a single API service that supports both gRPC APIs and REST APIs. - Many systems, including [Google - APIs](https://github.com/googleapis/googleapis), [Cloud - Endpoints](https://cloud.google.com/endpoints), [gRPC - Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - and use it for large scale production services. `HttpRule` defines the - schema of the gRPC/REST mapping. The mapping specifies how different - portions of the gRPC request message are mapped to the URL path, URL - query parameters, and HTTP request body. It also controls how the gRPC - response message is mapped to the HTTP response body. `HttpRule` is - typically specified as an `google.api.http` annotation on the gRPC - method. Each mapping specifies a URL path template and an HTTP method. - The path template may refer to one or more fields in the gRPC request - message, as long as each field is a non-repeated field with a primitive - (non-message) type. The path template controls how fields of the request - message are mapped to the URL path. Example: service Messaging { rpc - GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message - GetMessageRequest { string name = 1; // Mapped to URL path. } message - Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request - message which are not bound by the path template automatically become - HTTP query parameters if there is no HTTP request body. For example: - service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) - { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } - message GetMessageRequest { message SubMessage { string subfield = 1; } - string message_id = 1; // Mapped to URL path. int64 revision = 2; // - Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped - to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC - mapping as below: - HTTP: `GET - /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: - `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - "foo"))` Note that fields which are mapped to URL query parameters must - have a primitive type or a repeated primitive type or a non-repeated - message type. In the case of a repeated type, the parameter can be - repeated in the URL as `...?param=A¶m=B`. In the case of a message - type, each field of the message is mapped to a separate parameter, such - as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request - body, the `body` field specifies the mapping. Consider a REST update - method on the message resource collection: service Messaging { rpc - UpdateMessage(UpdateMessageRequest) returns (Message) { option - (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" - }; } } message UpdateMessageRequest { string message_id = 1; // mapped - to the URL Message message = 2; // mapped to the body } The following - HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: - HTTP: - `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The - special name `*` can be used in the body mapping to define that every - field not bound by the path template should be mapped to the request - body. This enables the following alternative definition of the update - method: service Messaging { rpc UpdateMessage(Message) returns (Message) - { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: - "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH - /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using - `*` in the body mapping, it is not possible to have HTTP parameters, as - all fields not bound by the path end in the body. This makes this option - more rarely used in practice when defining REST APIs. The common usage - of `*` is in custom methods which don't use the URL at all for - transferring data. It is possible to define multiple HTTP methods for - one RPC by using the `additional_bindings` option. Example: service - Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/messages/{message_id}" - additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } - }; } } message GetMessageRequest { string message_id = 1; string user_id - = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: - HTTP: `GET /v1/messages/123456` - gRPC: - `GetMessage(message_id: "123456")` - HTTP: `GET - /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" - message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields - (recursive expansion nested messages in the request message) are - classified into three categories: - Fields referred by the path - template. They are passed via the URL path. - Fields referred by the - HttpRule.body. They are passed via the HTTP request body. - All other - fields are passed via the URL query parameters, and the parameter name - is the field path in the request message. A repeated field can be - represented as multiple query parameters under the same name. 2. If - HttpRule.body is "*", there is no URL query parameter, all fields are - passed via URL path and HTTP request body. 3. If HttpRule.body is - omitted, there is no HTTP request body, all fields are passed via URL - path and URL query parameters. Path template syntax Template = "/" - Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | - "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] - "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax - `*` matches a single URL path segment. The syntax `**` matches zero or - more URL path segments, which must be the last part of the URL path - except the `Verb`. The syntax `Variable` matches part of the URL path as - specified by its template. A variable template must not contain other - variables. If a variable matches a single path segment, its template may - be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax - `LITERAL` matches literal text in the URL path. If the `LITERAL` - contains any reserved character, such characters should be - percent-encoded before the matching. If a variable contains exactly one - path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is - expanded into a URL path on the client side, all characters except - `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse - decoding. Such variables show up in the [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{var}`. If a variable contains multiple path segments, such as - `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a - URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` - are percent-encoded. The server side does the reverse decoding, except - "%2F" and "%2f" are left unchanged. Such variables show up in the - [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. Using gRPC API Service Configuration gRPC API Service - Configuration (service config) is a configuration language for - configuring a gRPC service to become a user-facing product. The service - config is simply the YAML representation of the `google.api.Service` - proto message. As an alternative to annotating your proto file, you can - configure gRPC transcoding in your service config YAML files. You do - this by specifying a `HttpRule` that maps the gRPC method to a REST - endpoint, achieving the same effect as the proto annotation. This can be - particularly useful if you have a proto that is reused in multiple - services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. The - following example selects a gRPC method and applies an `HttpRule` to it: - http: rules: - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC - Transcoding is used to map a gRPC to JSON REST endpoints, the proto to - JSON conversion must follow the [proto3 - specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - While the single segment variable follows the semantics of [RFC - 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - Expansion, the multi segment variable **does not** follow RFC 6570 - Section 3.2.3 Reserved Expansion. The reason is that the Reserved - Expansion does not expand special characters like `?` and `#`, which - would lead to invalid URLs. As the result, gRPC Transcoding uses a - custom encoding for multi segment variables. The path variables **must - not** refer to any repeated or mapped field, because client libraries - are not capable of handling such variable expansion. The path variables - **must not** capture the leading "/" character. The reason is that the - most common use case "{var}" does not capture the leading "/" character. - For consistency, all path variables must share the same behavior. - Repeated message fields must not be mapped to URL query parameters, - because no client library can support such complicated mapping. If an - API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. + Optional. List of subnetwork candidates to validate. The required + input fields are `name`, `network`, and `region`. Subnetworks from + this list which exist will be returned in the response with the + `ip_cidr_range`, `secondary_ip_cider_ranges`, and + `outside_allocation` fields set. + items: + $ref: '#/components/schemas/Subnetwork' + ipPrefixLength: + type: integer + format: int32 + description: >- + Required. The size of the desired subnet. Use usual CIDR range + notation. For example, '29' to find unused x.x.x.x/29 CIDR range. + The goal is to determine if one of the allocated ranges has enough + free space for a subnet of the requested size. GCE disallows subnets + with prefix_length > 29 + requestedRanges: + items: + type: string + type: array + description: >- + Optional. The name of one or more allocated IP address ranges + associated with this private service access connection. If no range + names are provided all ranges associated with this connection will + be considered. If a CIDR range with the specified IP prefix length + is not available within these ranges the validation fails. + secondaryRangeIpPrefixLengths: + type: array + items: + format: int32 + type: integer + description: >- + Optional. The size of the desired secondary ranges for the subnet. + Use usual CIDR range notation. For example, '29' to find unused + x.x.x.x/29 CIDR range. The goal is to determine that the allocated + ranges have enough free space for all the requested secondary + ranges. GCE disallows subnets with prefix_length > 29 + type: object + Enum: properties: - put: - description: Maps to HTTP PUT. Used for replacing a resource. + enumvalue: + type: array + items: + $ref: '#/components/schemas/EnumValue' + description: Enum value definitions. + syntax: + description: The source syntax. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS type: string - responseBody: - description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + name: type: string - body: + description: Enum type name. + edition: type: string description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. - additionalBindings: + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + options: items: - $ref: '#/components/schemas/HttpRule' + $ref: '#/components/schemas/Option' type: array - description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - patch: + description: Protocol buffer options. + description: Enum type definition. + type: object + id: Enum + Connection: + description: >- + Represents a private connection resource. A private connection is + implemented as a VPC Network Peering connection between a service + producer's VPC network and a service consumer's VPC network. + properties: + network: type: string - description: Maps to HTTP PATCH. Used for updating a resource. - custom: description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - $ref: '#/components/schemas/CustomHttpPattern' - selector: + The name of service consumer's VPC network that's connected with + service producer network, in the following format: + `projects/{project}/global/networks/{network}`. `{project}` is a + project number, such as in `12345` that includes the VPC service + consumer's VPC network. `{network}` is the name of the service + consumer's VPC network. + peering: description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - type: string - delete: - description: Maps to HTTP DELETE. Used for deleting a resource. - type: string - get: + Output only. The name of the VPC Network Peering connection that was + created by the service producer. type: string + readOnly: true + reservedPeeringRanges: + items: + type: string + type: array description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - post: + The name of one or more allocated IP address ranges for this service + producer of type `PEERING`. Note that invoking CreateConnection + method with a different range when connection is already established + will not modify already provisioned service producer subnetworks. If + CreateConnection method is invoked repeatedly to reconnect when + peering connection had been disconnected on the consumer side, + leaving this field empty will restore previously allocated IP + ranges. + service: type: string description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - RubySettings: - description: Settings for Ruby client libraries. + Output only. The name of the peering service that's associated with + this connection, in the following format: `services/{service name}`. + readOnly: true + id: Connection type: object - id: RubySettings - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - LongRunning: - id: LongRunning + GoogleCloudServicenetworkingV1betaSubnetwork: + description: >- + Represents a subnet that was created or discovered by a private access + management service. + id: GoogleCloudServicenetworkingV1betaSubnetwork type: object properties: - pollDelayMultiplier: - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - type: number - format: float - totalPollTimeout: - description: 'Total polling timeout. Default value: 5 minutes.' + name: type: string - format: google-duration - initialPollDelay: - format: google-duration + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + network: type: string description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - maxPollDelay: + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` + outsideAllocation: + type: boolean description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. + This is a discovered subnet that is not within the current consumer + allocated ranges. + ipCidrRange: + description: Subnetwork CIDR range in `10.x.x.x/y` format. type: string - format: google-duration - description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - UpdateConsumerConfigRequest: - type: object - id: UpdateConsumerConfigRequest - description: >- - Request to update the configuration of a service networking connection - including the import/export of custom routes and subnetwork routes with - public IP. + ValidateConsumerConfigRequest: properties: - consumerConfig: - $ref: '#/components/schemas/ConsumerConfig' - description: Required. The updated peering config. - Http: + rangeReservation: + $ref: '#/components/schemas/RangeReservation' + description: >- + RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are + done when range_reservation is provided. + validateNetwork: + type: boolean + description: >- + The validations will be performed in the order listed in the + ValidationError enum. The first failure will return. If a validation + is not requested, then the next one will be performed. + SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are + performed for all requests where validation is requested. + NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for + requests that have validate_network set to true. + consumerProject: + $ref: '#/components/schemas/ConsumerProject' + description: >- + NETWORK_NOT_IN_CONSUMERS_PROJECT, + NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND + are done when consumer_project is provided. + consumerNetwork: + type: string + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. + checkServiceNetworkingUsePermission: + description: >- + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + type: boolean + type: object + id: ValidateConsumerConfigRequest + Option: + type: object + id: Option properties: - rules: - items: - $ref: '#/components/schemas/HttpRule' - type: array + value: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. - fullyDecodeReservedExpansion: + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + name: + type: string description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - type: boolean - id: Http - type: object + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - NodeSettings: + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + DotnetSettings: type: object - description: Settings for Node client libraries. - id: NodeSettings + id: DotnetSettings properties: common: $ref: '#/components/schemas/CommonLanguageSettings' description: Some settings. - Context: - description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. - properties: - rules: + ignoredResources: + items: + type: string + description: >- + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" type: array + forcedNamespaceAliases: items: - $ref: '#/components/schemas/ContextRule' + type: string description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: object - id: Context - GoogleCloudServicenetworkingV1betaSubnetwork: - type: object - properties: - network: + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision + type: array + handwrittenSignatures: + type: array + items: + type: string description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` - type: string - outsideAllocation: + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + renamedServices: + type: object + additionalProperties: + type: string description: >- - This is a discovered subnet that is not within the current consumer - allocated ranges. - type: boolean - name: - description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ - type: string - ipCidrRange: - description: Subnetwork CIDR range in `10.x.x.x/y` format. - type: string - description: >- - Represents a subnet that was created or discovered by a private access - management service. - id: GoogleCloudServicenetworkingV1betaSubnetwork - AddSubnetworkRequest: - description: Request to create a subnetwork in a previously peered service network. - id: AddSubnetworkRequest - type: object + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + renamedResources: + type: object + description: >- + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + additionalProperties: + type: string + description: Settings for Dotnet client libraries. + Monitoring: properties: - useCustomComputeIdempotencyWindow: - type: boolean + producerDestinations: description: >- - Optional. Specifies if Service Networking should use a custom time - bucket for Arcus idempotency. If false, Service Networking uses a - 300 second (5 minute) Arcus idempotency window. If true, Service - Networking uses a custom idempotency window provided by the user in - field compute_idempotency_window. For more information on how to - use, see: go/revisit-sn-idempotency-window - subnetworkUsers: + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. items: - type: string + $ref: '#/components/schemas/MonitoringDestination' type: array + consumerDestinations: + items: + $ref: '#/components/schemas/MonitoringDestination' description: >- - A list of members that are granted the - `roles/servicenetworking.subnetworkAdmin` role on the subnet. - outsideAllocationPublicIpRange: + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + type: array + type: object + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + id: Monitoring + AddDnsZoneRequest: + id: AddDnsZoneRequest + properties: + name: type: string description: >- - Optional. Enable outside allocation using public IP addresses. Any - public IP range may be specified. If this field is provided, we will - not use customer reserved ranges for this primary IP range. - role: - type: string + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. Must be + unique within both projects. The name must be 1-63 characters long, + must begin with a letter, end with a letter or digit, and only + contain lowercase letters, digits or dashes. + consumerNetwork: description: >- - Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For - information about the roles that can be set using this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - purpose: + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + type: string + dnsSuffix: type: string description: >- - Optional. Defines the purpose field of the subnet, e.g. - 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that - can be set using this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - requestedAddress: + Required. The DNS name suffix for the zones e.g. `example.com.`. + Cloud DNS requires that a DNS suffix ends with a trailing dot. + description: >- + Request to add a private managed DNS zone in the shared producer host + project and a matching DNS peering zone in the consumer project. + type: object + Status: + properties: + details: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - Optional. The starting address of a range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix range is the CIDR range for the subnet. The range must - be within the allocated range that is assigned to the private - connection. If the CIDR range isn't available, the call fails. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + message: type: string - description: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: Status + type: object + RemoveDnsZoneMetadata: + id: RemoveDnsZoneMetadata + type: object + properties: {} + description: >- + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsZone API + MetricDescriptor: + properties: + name: type: string - description: Optional. Description of the subnet. - secondaryIpRangeSpecs: + description: The resource name of the metric descriptor. + labels: type: array description: >- - Optional. A list of secondary IP ranges to be created within the new - subnetwork. + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. items: - $ref: '#/components/schemas/SecondaryIpRangeSpec' - requestedRanges: + $ref: '#/components/schemas/LabelDescriptor' + monitoredResourceTypes: description: >- - Optional. The name of one or more allocated IP address ranges - associated with this private service access connection. If no range - names are provided all ranges associated with this connection will - be considered. If a CIDR range with the specified IP prefix length - is not available within these ranges, the call fails. + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. items: type: string type: array - consumer: - type: string - description: >- - Required. A resource that represents the service consumer, such as - `projects/123456`. The project number can be different from the - value in the consumer network parameter. For example, the network - might be part of a Shared VPC network. In those cases, Service - Networking validates that this resource belongs to that Shared VPC. - skipRequestedAddressValidation: - type: boolean - description: >- - Optional. Skips validating if the requested_address is in use by SN - VPC’s peering group. Compute Engine will still perform this check - and fail the request if the requested_address is in use. Note that - Compute Engine does not check for the existence of dynamic routes - when performing this check. Caller of this API should make sure that - there are no dynamic routes overlapping with the - requested_address/prefix_length IP address range otherwise the - created subnet could cause misrouting. - region: - type: string - description: >- - Required. The name of a [region](/compute/docs/regions-zones) for - the subnet, such `europe-west1`. - allowSubnetCidrRoutesOverlap: - description: >- - Optional. Defines the allowSubnetCidrRoutesOverlap field of the - subnet, e.g. Available in alpha and beta according to [Compute API - documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert) - type: boolean - checkServiceNetworkingUsePermission: - type: boolean - description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - subnetwork: - type: string - description: >- - Required. A name for the new subnet. For information about the - naming requirements, see - [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the - Compute API documentation. - computeIdempotencyWindow: - format: google-duration - description: >- - Optional. Specifies a custom time bucket for Arcus subnetwork - request idempotency. If two equivalent concurrent requests are made, - Arcus will know to ignore the request if it has already been - completed or is in progress. Only requests with matching - compute_idempotency_window have guaranteed idempotency. Changing - this time window between requests results in undefined behavior. - Zero (or empty) value with custom_compute_idempotency_window=true - specifies no idempotency (i.e. no request ID is provided to Arcus). - Maximum value of 14 days (enforced by Arcus limit). For more - information on how to use, see: go/revisit-sn-idempotency-window + type: type: string - consumerNetwork: description: >- - Required. The name of the service consumer's VPC network. The - network must have an existing private connection that was - provisioned through the connections.create method. The name must be - in the following format: - `projects/{project}/global/networks/{network}`, where {project} is a - project number, such as `12345`. {network} is the name of a VPC - network in the project. + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" + unit: type: string - privateIpv6GoogleAccess: description: >- - Optional. The private IPv6 google access type for the VMs in this - subnet. For information about the access types that can be set using - this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - type: string - ipPrefixLength: - format: int32 + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + description: description: >- - Required. The prefix length of the subnet's IP address range. Use - CIDR range notation, such as `29` to provision a subnet with an - `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool - of available ranges in the service consumer's allocated range. GCE - disallows subnets with prefix_length > 29 - type: integer - internalRange: + A detailed description of the metric, which can be used in + documentation. type: string - description: >- - Optional. The url of an Internal Range. Eg: - `projects//locations/global/internalRanges/`. If specified, it means - that the subnetwork cidr will be created using the combination of - requested_address/ip_prefix_length. Note that the subnet cidr has to - be within the cidr range of this Internal Range. - AddDnsZoneMetadata: - properties: {} - type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsZone API - id: AddDnsZoneMetadata - ClientLibrarySettings: - id: ClientLibrarySettings - description: Details about how and where to publish client libraries. - type: object - properties: - rubySettings: - description: Settings for Ruby client libraries. - $ref: '#/components/schemas/RubySettings' - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. launchStage: - description: Launch stage of this version of the API. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED + type: string + description: Optional. The launch stage of the metric definition. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -2531,1608 +2534,1630 @@ components: GA features are open to all developers and are considered stable and fully qualified for production use. - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - restNumericEnums: - type: boolean - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - nodeSettings: - $ref: '#/components/schemas/NodeSettings' - description: Settings for Node client libraries. - cppSettings: - description: Settings for C++ client libraries. - $ref: '#/components/schemas/CppSettings' - dotnetSettings: - $ref: '#/components/schemas/DotnetSettings' - description: Settings for .NET client libraries. - phpSettings: - description: Settings for PHP client libraries. - $ref: '#/components/schemas/PhpSettings' - version: + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + metadata: + $ref: '#/components/schemas/MetricDescriptorMetadata' + description: Optional. Metadata which can be used to guide usage of the metric. + metricKind: + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + description: >- + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + type: string + valueType: + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. type: string - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - PhpSettings: - id: PhpSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - type: object - description: Settings for Php client libraries. - Enum: - description: Enum type definition. + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + displayName: + type: string + description: >- + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. type: object + id: MetricDescriptor + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + Logging: properties: - enumvalue: - items: - $ref: '#/components/schemas/EnumValue' - description: Enum value definitions. + consumerDestinations: type: array - name: - description: Enum type name. - type: string - edition: - type: string description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - options: + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. + items: + $ref: '#/components/schemas/LoggingDestination' + producerDestinations: type: array items: - $ref: '#/components/schemas/Option' - description: Protocol buffer options. - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. - type: string - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - id: Enum - AddDnsRecordSetRequest: + $ref: '#/components/schemas/LoggingDestination' + description: >- + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. + type: object + id: Logging description: >- - Request to add a record set to a private managed DNS zone in the shared - producer host project. + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history + ConsumerConfig: + type: object + id: ConsumerConfig properties: - zone: + producerImportCustomRoutes: description: >- - Required. The name of the private DNS zone in the shared producer - host project to which the record set will be added. - type: string - dnsRecordSet: - description: Required. The DNS record set to add. - $ref: '#/components/schemas/DnsRecordSet' - consumerNetwork: - type: string + Import custom routes flag value for peering from producer to + consumer. + type: boolean + consumerExportCustomRoutes: + type: boolean description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - type: object - id: AddDnsRecordSetRequest - Operation: - properties: - name: + Export custom routes flag value for peering from consumer to + producer. + producerExportSubnetRoutesWithPublicIp: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - done: + Export subnet routes with public ip flag value for peering from + producer to consumer. + type: boolean + consumerImportSubnetRoutesWithPublicIp: type: boolean description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - metadata: + Import subnet routes with public ip flag value for peering from + consumer to producer. + consumerExportSubnetRoutesWithPublicIp: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - error: + Export subnet routes with public ip flag value for peering from + consumer to producer. + type: boolean + cloudsqlConfigs: + type: array + items: + $ref: '#/components/schemas/CloudSQLConfig' + description: Represents one or multiple Cloud SQL configurations. + producerExportCustomRoutes: description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - response: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + Export custom routes flag value for peering from producer to + consumer. + type: boolean + producerImportSubnetRoutesWithPublicIp: + type: boolean description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: Operation - type: object - Status: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - details: + Import subnet routes with public ip flag value for peering from + producer to consumer. + usedIpRanges: items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + type: string type: array + description: Output only. The IP ranges already in use by consumer or producer + readOnly: true + consumerImportCustomRoutes: + type: boolean description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - id: Status - type: object - Logging: - properties: - consumerDestinations: + Import custom routes flag value for peering from consumer to + producer. + vpcScReferenceArchitectureEnabled: description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. - items: - $ref: '#/components/schemas/LoggingDestination' + Output only. Indicates whether the VPC Service Controls reference + architecture is configured for the producer VPC host network. + type: boolean + readOnly: true + reservedRanges: + readOnly: true type: array - producerDestinations: description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. + Output only. The reserved ranges associated with this private + service access connection. items: - $ref: '#/components/schemas/LoggingDestination' - type: array - id: Logging - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - type: object + $ref: >- + #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + producerNetwork: + type: string + description: >- + Output only. The VPC host network that is used to host managed + service instances. In the format, + projects/{project}/global/networks/{network} where {project} is the + project number e.g. '12345' and {network} is the network name. + readOnly: true + description: Configuration information for a private service access connection. DeletePeeredDnsDomainMetadata: - type: object - id: DeletePeeredDnsDomainMetadata properties: {} description: >- Metadata provided through GetOperation request for the LRO generated by DeletePeeredDnsDomain API. - RemoveDnsZoneMetadata: - properties: {} + id: DeletePeeredDnsDomainMetadata type: object - id: RemoveDnsZoneMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsZone API - PythonSettings: - id: PythonSettings + PeeredDnsDomain: + id: PeeredDnsDomain type: object - description: Settings for Python client libraries. properties: - experimentalFeatures: - $ref: '#/components/schemas/ExperimentalFeatures' + name: description: >- - Experimental features to be included during client library - generation. - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - Method: - description: Method represents a method of an API interface. - type: object - id: Method - properties: - responseStreaming: - description: If true, the response is streamed. - type: boolean - responseTypeUrl: + User assigned name for this resource. Must be unique within the + consumer network. The name must be 1-63 characters long, must begin + with a letter, end with a letter or digit, and only contain + lowercase letters, digits or dashes. type: string - description: The URL of the output message type. - requestTypeUrl: - description: A URL of the input message type. + dnsSuffix: + description: >- + The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires + that a DNS suffix ends with a trailing dot. + type: string + description: >- + DNS domain suffix for which requests originating in the producer VPC + network are resolved in the associated consumer VPC network. + RemoveDnsZoneRequest: + description: >- + Request to remove a private managed DNS zone in the shared producer host + project and a matching DNS peering zone in the consumer project. + id: RemoveDnsZoneRequest + properties: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. type: string name: - description: The simple name of this method. + description: >- + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. type: string + type: object + Empty: + id: 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); } + properties: {} + type: object + Method: + properties: requestStreaming: - description: If true, the request is streamed. type: boolean + description: If true, the request is streamed. syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string description: The source syntax of this method. enumDescriptions: - Syntax `proto2`. - Syntax `proto3`. - Syntax `editions`. - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS options: - items: - $ref: '#/components/schemas/Option' type: array description: Any metadata attached to the method. - MetricDescriptorMetadata: - description: Additional annotations that can be used to guide the usage of a metric. - type: object - properties: - samplePeriod: - type: string - format: google-duration - description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. - timeSeriesResourceHierarchyLevel: - description: The scope of the timeseries data of the metric. items: - enumDescriptions: - - Do not use this default value. - - Scopes a metric to a project. - - Scopes a metric to an organization. - - Scopes a metric to a folder. - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER - type: string - type: array - launchStage: + $ref: '#/components/schemas/Option' + responseStreaming: + description: If true, the response is streamed. + type: boolean + responseTypeUrl: type: string - deprecated: true - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - ingestDelay: + description: The URL of the output message type. + requestTypeUrl: type: string - format: google-duration - description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - id: MetricDescriptorMetadata - Empty: + description: A URL of the input message type. + name: + description: The simple name of this method. + type: string + description: Method represents a method of an API interface. + id: Method type: object - properties: {} - id: 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); } - CppSettings: - description: Settings for C++ client libraries. + RubySettings: + description: Settings for Ruby client libraries. properties: common: - description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - id: CppSettings - type: object - AddRolesMetadata: - properties: {} - description: >- - Metadata provided through GetOperation request for the LRO generated by - AddRoles API - type: object - id: AddRolesMetadata - Page: + description: Some settings. + id: RubySettings type: object + LongRunning: description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - id: Page + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). properties: - name: + pollDelayMultiplier: + format: float + type: number description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - type: string - content: + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + initialPollDelay: description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. + Initial delay after which the first poll request will be made. + Default value: 5 seconds. type: string - subpages: + format: google-duration + maxPollDelay: description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + type: string + format: google-duration + totalPollTimeout: + description: 'Total polling timeout. Default value: 5 minutes.' + format: google-duration + type: string + id: LongRunning + type: object + Context: + properties: + rules: type: array items: - $ref: '#/components/schemas/Page' - Documentation: - id: Documentation + $ref: '#/components/schemas/ContextRule' + description: >- + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + id: Context + type: object + description: >- + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. + ConsumerProject: + description: Represents a consumer project. + id: ConsumerProject + type: object properties: - documentationRootUrl: + projectNum: + description: >- + Required. Project number of the consumer that is launching the + service instance. It can own the network that is peered with Google + or, be a service project in an XPN where the host project has the + network. + format: int64 type: string - description: The URL to the root of documentation. - serviceRootUrl: + JavaSettings: + properties: + libraryPackage: type: string description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. - overview: - type: string + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 + serviceClassNames: + type: object + additionalProperties: + type: string description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. - pages: - description: The top level pages for the documentation set. + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + id: JavaSettings + description: Settings for Java client libraries. + type: object + Http: + properties: + rules: items: - $ref: '#/components/schemas/Page' + $ref: '#/components/schemas/HttpRule' type: array - sectionOverrides: + description: >- + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + fullyDecodeReservedExpansion: + description: >- + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: boolean + description: >- + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + id: Http + type: object + AddRolesResponse: + properties: + policyBinding: + items: + $ref: '#/components/schemas/PolicyBinding' + type: array + description: >- + Required. List of policy bindings that were added to the shared VPC + host project. + id: AddRolesResponse + description: Represents IAM roles added to the shared VPC host project. + type: object + CancelOperationRequest: + id: CancelOperationRequest + properties: {} + type: object + description: The request message for Operations.CancelOperation. + DnsZone: + properties: + dnsSuffix: + type: string + description: >- + The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS + requires that a DNS suffix ends with a trailing dot. + name: + description: >- + User assigned name for this resource. Must be unique within the + project. The name must be 1-63 characters long, must begin with a + letter, end with a letter or digit, and only contain lowercase + letters, digits or dashes. + type: string + type: object + description: Represents a DNS zone resource. + id: DnsZone + AddDnsZoneResponse: + description: >- + Represents managed DNS zones created in the shared producer host and + consumer projects. + id: AddDnsZoneResponse + type: object + properties: + consumerPeeringZone: + description: The DNS peering zone created in the consumer project. + $ref: '#/components/schemas/DnsZone' + producerPrivateZone: + description: The private DNS zone created in the shared producer host project. + $ref: '#/components/schemas/DnsZone' + AddRolesRequest: + id: AddRolesRequest + type: object + properties: + policyBinding: type: array + description: Required. List of policy bindings to add to shared VPC host project. items: - $ref: '#/components/schemas/Page' + $ref: '#/components/schemas/PolicyBinding' + consumerNetwork: + type: string description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - rules: + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is a network name. + description: >- + Request for AddRoles to allow Service Producers to add roles in the + shared VPC host project for them to use. + RemoveDnsRecordSetMetadata: + id: RemoveDnsRecordSetMetadata + type: object + description: >- + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsRecordSet API + properties: {} + SourceContext: + type: object + id: SourceContext + properties: + fileName: + description: >- + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + type: string + description: >- + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. + ListPeeredDnsDomainsResponse: + description: Response to list peered DNS domains for a given connection. + properties: + peeredDnsDomains: + description: The list of peered DNS domains. type: array items: - $ref: '#/components/schemas/DocumentationRule' - description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - summary: + $ref: '#/components/schemas/PeeredDnsDomain' + id: ListPeeredDnsDomainsResponse + type: object + Mixin: + properties: + root: type: string description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. + If non-empty specifies a path under which inherited HTTP paths are + rooted. + name: + type: string + description: The fully qualified name of the interface which is included. + id: Mixin type: object description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. - SearchRangeRequest: + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + AuthenticationRule: + id: AuthenticationRule + type: object properties: - ipPrefixLength: - type: integer - format: int32 - description: >- - Required. The prefix length of the IP range. Use usual CIDR range - notation. For example, '30' to find unused x.x.x.x/30 CIDR range. - Actual range will be determined using allocated range for the - consumer peered network and returned in the result. - network: + allowWithoutCredential: description: >- - Network name in the consumer project. This network must have been - already peered with a shared VPC network using CreateConnection - method. Must be in a form - 'projects/{project}/global/networks/{network}'. {project} is a - project number, as in '12345' {network} is network name. + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + type: boolean + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + selector: type: string - type: object - id: SearchRangeRequest - description: Request to search for an unused range within allocated ranges. - Field: - description: A single field of a message type. - id: Field + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + requirements: + description: Requirements for additional authentication providers. + type: array + items: + $ref: '#/components/schemas/AuthRequirement' + description: >- + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + EnumValue: + description: Enum value definition. + id: EnumValue type: object properties: - kind: - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - description: The field type. - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 - type: string name: type: string - description: The field name. - packed: - type: boolean - description: Whether to use alternative packed wire representation. - jsonName: - description: The field JSON name. - type: string + description: Enum value name. number: - format: int32 - description: The field number. - type: integer - oneofIndex: + description: Enum value number. format: int32 type: integer - description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - typeUrl: - type: string - description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - cardinality: - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - type: string - description: The field cardinality. options: - description: The protocol buffer options. type: array + description: Protocol buffer options. items: $ref: '#/components/schemas/Option' - defaultValue: - description: >- - The string value of the default value of this field. Proto2 syntax - only. - type: string - CancelOperationRequest: - id: CancelOperationRequest - description: The request message for Operations.CancelOperation. + SearchRangeRequest: type: object - properties: {} - ListConnectionsResponse: - id: ListConnectionsResponse + id: SearchRangeRequest + description: Request to search for an unused range within allocated ranges. properties: - connections: + network: + type: string + description: >- + Network name in the consumer project. This network must have been + already peered with a shared VPC network using CreateConnection + method. Must be in a form + 'projects/{project}/global/networks/{network}'. {project} is a + project number, as in '12345' {network} is network name. + ipPrefixLength: + format: int32 + description: >- + Required. The prefix length of the IP range. Use usual CIDR range + notation. For example, '30' to find unused x.x.x.x/30 CIDR range. + Actual range will be determined using allocated range for the + consumer peered network and returned in the result. + type: integer + Authentication: + properties: + rules: + items: + $ref: '#/components/schemas/AuthenticationRule' + description: >- + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + providers: + description: Defines a set of authentication providers that a service supports. items: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/AuthProvider' type: array - description: The list of Connections. - type: object description: >- - ListConnectionsResponse is the response to list peering states for the - given service and consumer project. - Type: - description: A protocol buffer message type. - id: Type + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + type: object + id: Authentication + Subnetwork: type: object + description: >- + Represents a subnet that was created or discovered by a private access + management service. + id: Subnetwork properties: - edition: + name: + type: string + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + outsideAllocation: + type: boolean description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + This is a discovered subnet that is not within the current consumer + allocated ranges. + ipCidrRange: + description: Subnetwork CIDR range in `10.x.x.x/y` format. type: string - fields: - description: The list of fields. - items: - $ref: '#/components/schemas/Field' - type: array - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. + network: + description: >- + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` type: string - oneofs: - description: The list of types appearing in `oneof` definitions in this type. - type: array + secondaryIpRanges: + description: List of secondary IP ranges in this subnetwork. items: - type: string - name: - type: string - description: The fully qualified message name. - options: + $ref: '#/components/schemas/SecondaryIpRange' type: array - items: - $ref: '#/components/schemas/Option' - description: The protocol buffer options. - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - UpdateDnsRecordSetMetadata: + region: + type: string + description: GCP region where the subnetwork is located. + AuthProvider: description: >- - Metadata provided through GetOperation request for the LRO generated by - UpdateDnsRecordSet API + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). type: object - id: UpdateDnsRecordSetMetadata - properties: {} - ConsumerProject: + id: AuthProvider properties: - projectNum: - format: int64 + jwksUri: + type: string description: >- - Required. Project number of the consumer that is launching the - service instance. It can own the network that is peered with Google - or, be a service project in an XPN where the host project has the - network. + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs + authorizationUrl: type: string - description: Represents a consumer project. - type: object - id: ConsumerProject - DotnetSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - forcedNamespaceAliases: description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - items: - type: string - type: array - renamedServices: - additionalProperties: - type: string + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. + audiences: description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - type: object - ignoredResources: - type: array - items: - type: string + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string + id: description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - handwrittenSignatures: + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". + type: string + jwtLocations: + description: >- + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token items: - type: string + $ref: '#/components/schemas/JwtLocation' type: array + issuer: + type: string description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - renamedResources: - description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - additionalProperties: - type: string - type: object + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com + AddRolesMetadata: type: object - description: Settings for Dotnet client libraries. - id: DotnetSettings - SystemParameters: + properties: {} description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - id: SystemParameters - type: object - properties: - rules: - description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - type: array - items: - $ref: '#/components/schemas/SystemParameterRule' - CustomErrorRule: - properties: - isErrorType: - type: boolean - description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - selector: - description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. - type: string + Metadata provided through GetOperation request for the LRO generated by + AddRoles API + id: AddRolesMetadata + PhpSettings: type: object - description: A custom error rule. - id: CustomErrorRule - VpcServiceControls: properties: - enabled: - readOnly: true - type: boolean - description: >- - Output only. Indicates whether the VPC Service Controls are enabled - or disabled for the connection. If the consumer called the - EnableVpcServiceControls method, then this is true. If the consumer - called DisableVpcServiceControls, then this is false. The default is - false. - id: VpcServiceControls - description: Response for the get VPC Service Controls request. + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + description: Settings for Php client libraries. + id: PhpSettings + ExperimentalFeatures: type: object - RangeReservation: + id: ExperimentalFeatures properties: - requestedRanges: + restAsyncIoEnabled: + type: boolean + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + Api: + properties: + syntax: + description: The source syntax of the service. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + methods: items: - type: string + $ref: '#/components/schemas/Method' + description: The methods of this interface, in unspecified order. type: array - description: >- - Optional. The name of one or more allocated IP address ranges - associated with this private service access connection. If no range - names are provided all ranges associated with this connection will - be considered. If a CIDR range with the specified IP prefix length - is not available within these ranges the validation fails. - subnetworkCandidates: + options: + description: Any metadata attached to the interface. type: array - description: >- - Optional. List of subnetwork candidates to validate. The required - input fields are `name`, `network`, and `region`. Subnetworks from - this list which exist will be returned in the response with the - `ip_cidr_range`, `secondary_ip_cider_ranges`, and - `outside_allocation` fields set. items: - $ref: '#/components/schemas/Subnetwork' - secondaryRangeIpPrefixLengths: + $ref: '#/components/schemas/Option' + mixins: type: array + description: Included interfaces. See Mixin. items: - format: int32 - type: integer + $ref: '#/components/schemas/Mixin' + version: description: >- - Optional. The size of the desired secondary ranges for the subnet. - Use usual CIDR range notation. For example, '29' to find unused - x.x.x.x/29 CIDR range. The goal is to determine that the allocated - ranges have enough free space for all the requested secondary - ranges. GCE disallows subnets with prefix_length > 29 - ipPrefixLength: + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. + type: string + name: description: >- - Required. The size of the desired subnet. Use usual CIDR range - notation. For example, '29' to find unused x.x.x.x/29 CIDR range. - The goal is to determine if one of the allocated ranges has enough - free space for a subnet of the requested size. GCE disallows subnets - with prefix_length > 29 - format: int32 - type: integer - description: Represents a range reservation. + The fully qualified name of this interface, including package name + followed by the interface's simple name. + type: string + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: >- + Source context for the protocol buffer service represented by this + message. + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. type: object - id: RangeReservation - BillingDestination: - id: BillingDestination + id: Api + ListConnectionsResponse: description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). + ListConnectionsResponse is the response to list peering states for the + given service and consumer project. + id: ListConnectionsResponse + properties: + connections: + description: The list of Connections. + items: + $ref: '#/components/schemas/Connection' + type: array type: object + JwtLocation: + id: JwtLocation properties: - monitoredResource: + query: + description: Specifies URL query parameter name to extract JWT token. + type: string + valuePrefix: type: string description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - metrics: + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + header: + description: Specifies HTTP header name to extract JWT token. + type: string + cookie: + type: string + description: Specifies cookie name to extract JWT token. + type: object + description: Specifies a location to extract JWT from an API request. + Usage: + id: Usage + description: Configuration controlling usage of a service. + type: object + properties: + requirements: + description: >- + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. + type: array items: type: string + rules: description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. type: array - RemoveDnsRecordSetMetadata: - description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsRecordSet API - properties: {} - type: object - id: RemoveDnsRecordSetMetadata - CustomError: - id: CustomError - properties: - rules: items: - $ref: '#/components/schemas/CustomErrorRule' + $ref: '#/components/schemas/UsageRule' + producerNotificationChannel: description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. - type: array - types: - type: array + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + type: string + DnsRecordSet: + properties: + data: items: type: string description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - type: object - description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - CommonLanguageSettings: - id: CommonLanguageSettings - description: Required information for every language. + Required. As defined in RFC 1035 (section 5) and RFC 1034 (section + 3.6.1) for examples see + https://cloud.google.com/dns/records/json-record. + type: array + type: + type: string + description: Required. The identifier of a supported record type. + domain: + description: >- + Required. The DNS or domain name of the record set, e.g. + `test.example.com`. Cloud DNS requires that a DNS suffix ends with a + trailing dot. + type: string + ttl: + type: string + format: google-duration + description: >- + Required. The period of time for which this RecordSet can be cached + by resolvers. type: object + description: Represents a DNS record set resource. + id: DnsRecordSet + DisableVpcServiceControlsRequest: + description: Request to disable VPC service controls. properties: - referenceDocsUri: - deprecated: true + consumerNetwork: + type: string description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. + type: object + id: DisableVpcServiceControlsRequest + ListOperationsResponse: + id: ListOperationsResponse + properties: + nextPageToken: + description: The standard List next-page token. type: string - destinations: + operations: + items: + $ref: '#/components/schemas/Operation' description: >- - The destination where API teams want this client library to be - published. + A list of operations that matches the specified filter in the + request. type: array - items: - type: string - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - ConsumerConfigMetadata: + type: object + description: The response message for Operations.ListOperations. + DeleteConnectionMetadata: + id: DeleteConnectionMetadata + type: object description: >- Metadata provided through GetOperation request for the LRO generated by - UpdateConsumerConfig API. - id: ConsumerConfigMetadata + Delete Connection API properties: {} + GoSettings: type: object - GetDnsZoneResponse: - type: object - description: >- - Represents managed DNS zones created in the shared Producer host and - consumer projects. properties: - consumerPeeringZone: - $ref: '#/components/schemas/DnsZone' - description: The DNS peering zone created in the consumer project. - producerPrivateZone: - description: The private DNS zone created in the shared producer host project. - $ref: '#/components/schemas/DnsZone' - id: GetDnsZoneResponse - EnumValue: - description: Enum value definition. - id: EnumValue + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + description: Settings for Go client libraries. + id: GoSettings + ListDnsZonesResponse: + properties: + dnsZonePairs: + description: >- + All pairs of private DNS zones in the shared producer host project + and the matching peering zones in the consumer project.. + type: array + items: + $ref: '#/components/schemas/DnsZonePair' type: object + description: >- + Represents all DNS zones in the shared producer host project and the + matching peering zones in the consumer project. + id: ListDnsZonesResponse + GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: + description: Allocated IP address ranges for this private service access connection. + id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange properties: - number: + address: + description: >- + The starting address of the reserved range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix length is the CIDR range for the reserved range. + type: string + ipPrefixLength: + description: The prefix length of the reserved range. type: integer - description: Enum value number. format: int32 - options: - items: - $ref: '#/components/schemas/Option' - description: Protocol buffer options. - type: array name: + description: The name of the reserved range. type: string - description: Enum value name. - QuotaLimit: + type: object + MetricRule: + id: MetricRule + type: object properties: - maxLimit: - format: int64 - type: string - description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - duration: - type: string - description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - values: - description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - type: object + metricCosts: additionalProperties: - type: string format: int64 - freeTier: + type: string + type: object description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - type: string - format: int64 - displayName: + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + selector: type: string description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - metric: - description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - type: string - defaultLimit: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + SystemParameterRule: + type: object + id: SystemParameterRule + properties: + selector: type: string description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - format: int64 - name: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + parameters: + items: + $ref: '#/components/schemas/SystemParameter' description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. + type: array + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + SecondaryIpRangeSpec: + properties: + requestedAddress: type: string - unit: description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. + Optional. The starting address of a range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix range is the CIDR range for the secondary IP range. + The range must be within the allocated range that is assigned to the + private connection. If the CIDR range isn't available, the call + fails. + rangeName: type: string - description: description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). + Required. A name for the secondary IP range. The name must be 1-63 + characters long, and comply with RFC1035. The name must be unique + within the subnetwork. + outsideAllocationPublicIpRange: type: string - id: QuotaLimit + description: >- + Optional. Enable outside allocation using public IP addresses. Any + public IP range may be specified. If this field is provided, we will + not use customer reserved ranges for this secondary IP range. + ipPrefixLength: + description: >- + Required. The prefix length of the secondary IP range. Use CIDR + range notation, such as `30` to provision a secondary IP range with + an `x.x.x.x/30` CIDR range. The IP address range is drawn from a + pool of available ranges in the service consumer's allocated range. + format: int32 + type: integer + id: SecondaryIpRangeSpec type: object - description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - LogDescriptor: - id: LogDescriptor + DeleteConnectionRequest: + id: DeleteConnectionRequest type: object + properties: + consumerNetwork: + type: string + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is a network name. description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer + Request to delete a private service access connection. The call will + fail if there are any managed service instances using this connection. + AddDnsRecordSetMetadata: + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsRecordSet API + type: object + id: AddDnsRecordSetMetadata + properties: {} + CustomHttpPattern: + id: CustomHttpPattern + description: A custom pattern is used for defining custom HTTP verb. + type: object + properties: + path: + type: string + description: The path matched by this custom verb. + kind: + type: string + description: The name of this custom HTTP verb. + EnableVpcServiceControlsRequest: + type: object + id: EnableVpcServiceControlsRequest properties: - displayName: + consumerNetwork: type: string description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - labels: - items: - $ref: '#/components/schemas/LabelDescriptor' + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. + description: Request to enable VPC service controls. + GoogleCloudServicenetworkingV1betaConnection: + properties: + reservedPeeringRanges: description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. + The name of one or more allocated IP address ranges for this service + producer of type `PEERING`. Note that invoking this method with a + different range when connection is already established will not + modify already provisioned service producer subnetworks. type: array - description: + items: + type: string + service: description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. + Output only. The name of the peering service that's associated with + this connection, in the following format: `services/{service name}`. type: string - name: + peering: type: string description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - Service: - properties: - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - id: - type: string + Output only. The name of the VPC Network Peering connection that was + created by the service producer. + network: description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. - title: + The name of service consumer's VPC network that's connected with + service producer network, in the following format: + `projects/{project}/global/networks/{network}`. `{project}` is a + project number, such as in `12345` that includes the VPC service + consumer's VPC network. `{network}` is the name of the service + consumer's VPC network. type: string + description: >- + Represents a private connection resource. A private connection is + implemented as a VPC Network Peering connection between a service + producer's VPC network and a service consumer's VPC network. + id: GoogleCloudServicenetworkingV1betaConnection + type: object + PythonSettings: + description: Settings for Python client libraries. + id: PythonSettings + type: object + properties: + experimentalFeatures: + $ref: '#/components/schemas/ExperimentalFeatures' description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - context: - $ref: '#/components/schemas/Context' - description: Context configuration. - apis: + Experimental features to be included during client library + generation. + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + MethodPolicy: + properties: + requestPolicies: type: array items: - $ref: '#/components/schemas/Api' - description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - sourceInfo: - $ref: '#/components/schemas/SourceInfo' - description: >- - Output only. The source information for this configuration if - available. - monitoredResources: + $ref: '#/components/schemas/FieldPolicy' + description: Policies that are applicable to the request message. + selector: description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . + type: string + type: object + id: MethodPolicy + description: Defines policies applying to an RPC method. + ContextRule: + type: object + properties: + allowedRequestExtensions: type: array items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - name: + type: string description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - type: string - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - http: - description: HTTP configuration. - $ref: '#/components/schemas/Http' - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - control: - $ref: '#/components/schemas/Control' - description: Configuration for the service control plane. - logs: - items: - $ref: '#/components/schemas/LogDescriptor' - description: Defines the logs used by this service. + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + requested: type: array - publishing: description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - $ref: '#/components/schemas/Publishing' - systemTypes: - type: array + A list of full type names of requested contexts, only the requested + context will be made available to the backend. items: - $ref: '#/components/schemas/Type' - description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - backend: - description: API backend configuration. - $ref: '#/components/schemas/Backend' - configVersion: - description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - type: integer - format: uint32 - systemParameters: - description: System parameter configuration. - $ref: '#/components/schemas/SystemParameters' - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - metrics: - description: Defines the metrics used by this service. + type: string + provided: type: array + description: >- + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. items: - $ref: '#/components/schemas/MetricDescriptor' - enums: + type: string + allowedResponseExtensions: description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. type: array items: - $ref: '#/components/schemas/Enum' - producerProjectId: - description: The Google project that owns this service. + type: string + selector: type: string - endpoints: - type: array - items: - $ref: '#/components/schemas/Endpoint' - description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. - types: description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - type: array - items: - $ref: '#/components/schemas/Type' - id: Service - type: object + Selects the methods to which this rule applies. Refer to selector + for syntax details. + id: ContextRule description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - MethodSettings: + A context rule provides information about the context for an individual + API element. + AddSubnetworkRequest: type: object properties: - selector: + ipPrefixLength: + format: int32 + type: integer description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... + Required. The prefix length of the subnet's IP address range. Use + CIDR range notation, such as `29` to provision a subnet with an + `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool + of available ranges in the service consumer's allocated range. GCE + disallows subnets with prefix_length > 29 + allowSubnetCidrRoutesOverlap: + description: >- + Optional. Defines the allowSubnetCidrRoutesOverlap field of the + subnet, e.g. Available in alpha and beta according to [Compute API + documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert) + type: boolean + subnetworkUsers: + description: >- + A list of members that are granted the + `roles/servicenetworking.subnetworkAdmin` role on the subnet. + type: array + items: + type: string + computeIdempotencyWindow: + format: google-duration type: string - autoPopulatedFields: description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id + Optional. Specifies a custom time bucket for Arcus subnetwork + request idempotency. If two equivalent concurrent requests are made, + Arcus will know to ignore the request if it has already been + completed or is in progress. Only requests with matching + compute_idempotency_window have guaranteed idempotency. Changing + this time window between requests results in undefined behavior. + Zero (or empty) value with custom_compute_idempotency_window=true + specifies no idempotency (i.e. no request ID is provided to Arcus). + Maximum value of 14 days (enforced by Arcus limit). For more + information on how to use, see: go/revisit-sn-idempotency-window + useCustomComputeIdempotencyWindow: + type: boolean + description: >- + Optional. Specifies if Service Networking should use a custom time + bucket for Arcus idempotency. If false, Service Networking uses a + 300 second (5 minute) Arcus idempotency window. If true, Service + Networking uses a custom idempotency window provided by the user in + field compute_idempotency_window. For more information on how to + use, see: go/revisit-sn-idempotency-window + requestedRanges: + description: >- + Optional. The name of one or more allocated IP address ranges + associated with this private service access connection. If no range + names are provided all ranges associated with this connection will + be considered. If a CIDR range with the specified IP prefix length + is not available within these ranges, the call fails. items: type: string type: array - longRunning: - description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - $ref: '#/components/schemas/LongRunning' - description: Describes the generator configuration for a method. - id: MethodSettings - ListDnsZonesResponse: - id: ListDnsZonesResponse - properties: - dnsZonePairs: + secondaryIpRangeSpecs: type: array items: - $ref: '#/components/schemas/DnsZonePair' + $ref: '#/components/schemas/SecondaryIpRangeSpec' description: >- - All pairs of private DNS zones in the shared producer host project - and the matching peering zones in the consumer project.. - description: >- - Represents all DNS zones in the shared producer host project and the - matching peering zones in the consumer project. - type: object - SourceContext: - id: SourceContext - type: object - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - properties: - fileName: + Optional. A list of secondary IP ranges to be created within the new + subnetwork. + checkServiceNetworkingUsePermission: + type: boolean + description: >- + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + region: type: string description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - UpdateDnsRecordSetRequest: - type: object - properties: - zone: + Required. The name of a [region](/compute/docs/regions-zones) for + the subnet, such `europe-west1`. + description: + type: string + description: Optional. Description of the subnet. + role: + type: string description: >- - Required. The name of the private DNS zone in the shared producer - host project from which the record set will be removed. + Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For + information about the roles that can be set using this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. + subnetwork: + type: string + description: >- + Required. A name for the new subnet. For information about the + naming requirements, see + [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the + Compute API documentation. + outsideAllocationPublicIpRange: + description: >- + Optional. Enable outside allocation using public IP addresses. Any + public IP range may be specified. If this field is provided, we will + not use customer reserved ranges for this primary IP range. + type: string + consumer: + description: >- + Required. A resource that represents the service consumer, such as + `projects/123456`. The project number can be different from the + value in the consumer network parameter. For example, the network + might be part of a Shared VPC network. In those cases, Service + Networking validates that this resource belongs to that Shared VPC. type: string - existingDnsRecordSet: - $ref: '#/components/schemas/DnsRecordSet' - description: Required. The existing DNS record set to update. consumerNetwork: type: string description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - newDnsRecordSet: - $ref: '#/components/schemas/DnsRecordSet' + Required. The name of the service consumer's VPC network. The + network must have an existing private connection that was + provisioned through the connections.create method. The name must be + in the following format: + `projects/{project}/global/networks/{network}`, where {project} is a + project number, such as `12345`. {network} is the name of a VPC + network in the project. + purpose: + type: string description: >- - Required. The new values that the DNS record set should be updated - to hold. - description: >- - Request to update a record set from a private managed DNS zone in the - shared producer host project. The name, type, ttl, and data values of - the existing record set must all exactly match an existing record set in - the specified zone. - id: UpdateDnsRecordSetRequest - RemoveDnsRecordSetRequest: - properties: - zone: + Optional. Defines the purpose field of the subnet, e.g. + 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that + can be set using this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. + internalRange: type: string description: >- - Required. The name of the private DNS zone in the shared producer - host project from which the record set will be removed. - dnsRecordSet: - $ref: '#/components/schemas/DnsRecordSet' - description: Required. The DNS record set to remove. - consumerNetwork: + Optional. The url of an Internal Range. Eg: + `projects//locations/global/internalRanges/`. If specified, it means + that the subnetwork cidr will be created using the combination of + requested_address/ip_prefix_length. Note that the subnet cidr has to + be within the cidr range of this Internal Range. + skipRequestedAddressValidation: + type: boolean description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. + Optional. Skips validating if the requested_address is in use by SN + VPC’s peering group. Compute Engine will still perform this check + and fail the request if the requested_address is in use. Note that + Compute Engine does not check for the existence of dynamic routes + when performing this check. Caller of this API should make sure that + there are no dynamic routes overlapping with the + requested_address/prefix_length IP address range otherwise the + created subnet could cause misrouting. + requestedAddress: + type: string + description: >- + Optional. The starting address of a range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix range is the CIDR range for the subnet. The range must + be within the allocated range that is assigned to the private + connection. If the CIDR range isn't available, the call fails. + privateIpv6GoogleAccess: + description: >- + Optional. The private IPv6 google access type for the VMs in this + subnet. For information about the access types that can be set using + this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. type: string + description: Request to create a subnetwork in a previously peered service network. + id: AddSubnetworkRequest + Billing: description: >- - Request to remove a record set from a private managed DNS zone in the - shared producer host project. The name, type, ttl, and data values must - all exactly match an existing record set in the specified zone. + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count + id: Billing + type: object + properties: + consumerDestinations: + items: + $ref: '#/components/schemas/BillingDestination' + description: >- + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + type: array + Backend: + description: '`Backend` defines the backend configuration for a service.' + properties: + rules: + description: >- + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/BackendRule' + type: array + id: Backend type: object - id: RemoveDnsRecordSetRequest - ValidateConsumerConfigRequest: + Publishing: + description: >- + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. type: object - id: ValidateConsumerConfigRequest + id: Publishing properties: - checkServiceNetworkingUsePermission: - description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - type: boolean - consumerProject: + newIssueUri: + type: string description: >- - NETWORK_NOT_IN_CONSUMERS_PROJECT, - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND - are done when consumer_project is provided. - $ref: '#/components/schemas/ConsumerProject' - consumerNetwork: + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + protoReferenceDocumentationUri: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc type: string - validateNetwork: - description: >- - The validations will be performed in the order listed in the - ValidationError enum. The first failure will return. If a validation - is not requested, then the next one will be performed. - SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are - performed for all requests where validation is requested. - NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for - requests that have validate_network set to true. - type: boolean - rangeReservation: - $ref: '#/components/schemas/RangeReservation' + githubLabel: description: >- - RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are - done when range_reservation is provided. - MonitoredResourceDescriptor: - id: MonitoredResourceDescriptor - properties: - name: + GitHub label to apply to issues and pull requests opened for this + API. + type: string + apiShortName: type: string description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. - labels: + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". + librarySettings: description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. items: - $ref: '#/components/schemas/LabelDescriptor' + $ref: '#/components/schemas/ClientLibrarySettings' type: array - type: + organization: type: string - description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - launchStage: - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - type: string - description: Optional. The launch stage of the monitored resource definition. - displayName: - type: string + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + enumDescriptions: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + description: For whom the client library is being published. + methodSettings: + type: array + items: + $ref: '#/components/schemas/MethodSettings' description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. - description: + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + documentationUri: description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview type: string - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. - type: object - GoogleCloudServicenetworkingV1betaConnection: - properties: - reservedPeeringRanges: + codeownerGithubTeams: + description: >- + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + type: array items: type: string - type: array + docTagPrefix: description: >- - The name of one or more allocated IP address ranges for this service - producer of type `PEERING`. Note that invoking this method with a - different range when connection is already established will not - modify already provisioned service producer subnetworks. - peering: + A prefix used in sample code when demarking regions to be included + in documentation. + type: string + restReferenceDocumentationUri: + type: string description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + DocumentationRule: + properties: + disableReplacementWords: type: string - network: + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + deprecationDescription: type: string description: >- - The name of service consumer's VPC network that's connected with - service producer network, in the following format: - `projects/{project}/global/networks/{network}`. `{project}` is a - project number, such as in `12345` that includes the VPC service - consumer's VPC network. `{network}` is the name of the service - consumer's VPC network. - service: + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + selector: + description: >- + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + type: string + description: type: string description: >- - Output only. The name of the peering service that's associated with - this connection, in the following format: `services/{service name}`. - type: object - description: >- - Represents a private connection resource. A private connection is - implemented as a VPC Network Peering connection between a service - producer's VPC network and a service consumer's VPC network. - id: GoogleCloudServicenetworkingV1betaConnection - AddRolesResponse: + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. + description: A documentation rule provides information about individual API elements. + type: object + id: DocumentationRule + CustomError: + description: >- + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + id: CustomError type: object - id: AddRolesResponse - description: Represents IAM roles added to the shared VPC host project. properties: - policyBinding: + rules: items: - $ref: '#/components/schemas/PolicyBinding' - type: array - description: >- - Required. List of policy bindings that were added to the shared VPC - host project. - PolicyBinding: - description: Grouping of IAM role and IAM member. - properties: - member: - type: string + $ref: '#/components/schemas/CustomErrorRule' description: >- - Required. Member to bind the role with. See - /iam/docs/reference/rest/v1/Policy#Binding for how to format each - member. Eg. - user:myuser@mydomain.com - - serviceAccount:my-service-account@app.gserviceaccount.com - role: + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array + types: + type: array description: >- - Required. Role to apply. Only allowlisted roles can be used at the - specified granularity. The role must be one of the following: - - 'roles/container.hostServiceAgentUser' applied on the shared VPC - host project - 'roles/compute.securityAdmin' applied on the shared - VPC host project - 'roles/compute.networkAdmin' applied on the - shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared - VPC host project - 'roles/dns.admin' applied on the shared VPC host - project - 'roles/logging.admin' applied on the shared VPC host - project - 'roles/monitoring.viewer' applied on the shared VPC host - project - 'roles/servicemanagement.quotaViewer' applied on the - shared VPC host project - type: string - id: PolicyBinding + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + items: + type: string + BillingDestination: type: object - DisableVpcServiceControlsRequest: - description: Request to disable VPC service controls. + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). properties: - consumerNetwork: + metrics: + items: + type: string description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + type: array + monitoredResource: type: string - type: object - id: DisableVpcServiceControlsRequest + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + id: BillingDestination parameters: + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -4164,21 +4189,18 @@ components: - json - media - proto - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: 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. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: key + name: prettyPrint schema: - type: string + type: boolean _.xgafv: description: V1 error format. in: query @@ -4188,45 +4210,81 @@ components: enum: - '1' - '2' - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token + schema: + 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. + in: query + name: key schema: type: string x-stackQL-resources: + operations: + id: google.servicenetworking.operations + name: operations + title: Operations + methods: + get: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + cancel: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' dns_zones: id: google.servicenetworking.dns_zones name: dns_zones title: Dns_zones methods: - add: + remove: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:add/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:remove/post' response: mediaType: application/json openAPIDocKey: '200' - remove: + add: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:remove/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:add/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4254,33 +4312,14 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/dns_zones/methods/remove' - roles: - id: google.servicenetworking.roles - name: roles - title: Roles - methods: - add: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1roles:add/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/roles/methods/add' - update: [] - replace: [] - delete: [] connections: id: google.servicenetworking.connections name: connections title: Connections methods: - patch: + list: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/patch + $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/get' response: mediaType: application/json openAPIDocKey: '200' @@ -4290,9 +4329,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/get' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -4325,41 +4365,26 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/connections_connection/methods/delete_connection - peered_dns_domains: - id: google.servicenetworking.peered_dns_domains - name: peered_dns_domains - title: Peered_dns_domains + networks_vpc_service_controls: + id: google.servicenetworking.networks_vpc_service_controls + name: networks_vpc_service_controls + title: Networks_vpc_service_controls methods: - delete: - operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains~1{peeredDnsDomainsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/get - response: - mediaType: application/json - openAPIDocKey: '200' - create: + get_vpc_service_controls: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/post + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1vpcServiceControls/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/create' + - $ref: >- + #/components/x-stackQL-resources/networks_vpc_service_controls/methods/get_vpc_service_controls + insert: [] update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/delete' + delete: [] networks_consumer_config: id: google.servicenetworking.networks_consumer_config name: networks_consumer_config @@ -4380,26 +4405,6 @@ components: #/components/x-stackQL-resources/networks_consumer_config/methods/update_consumer_config replace: [] delete: [] - networks_vpc_service_controls: - id: google.servicenetworking.networks_vpc_service_controls - name: networks_vpc_service_controls - title: Networks_vpc_service_controls - methods: - get_vpc_service_controls: - operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1vpcServiceControls/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/networks_vpc_service_controls/methods/get_vpc_service_controls - insert: [] - update: [] - replace: [] - delete: [] networks: id: google.servicenetworking.networks name: networks @@ -4419,38 +4424,55 @@ components: update: [] replace: [] delete: [] - dns_record_set: - id: google.servicenetworking.dns_record_set - name: dns_record_set - title: Dns_record_set + peered_dns_domains: + id: google.servicenetworking.peered_dns_domains + name: peered_dns_domains + title: Peered_dns_domains methods: - get: + list: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains~1{peeredDnsDomainsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' - insert: [] + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/create' update: [] replace: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/delete' dns_record_sets: id: google.servicenetworking.dns_record_sets name: dns_record_sets title: Dns_record_sets methods: - remove: + add: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' response: mediaType: application/json openAPIDocKey: '200' - add: + remove: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4476,34 +4498,70 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/remove' + dns_record_set: + id: google.servicenetworking.dns_record_set + name: dns_record_set + title: Dns_record_set + methods: + get: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + roles: + id: google.servicenetworking.roles + name: roles + title: Roles + methods: + add: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1roles:add/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/roles/methods/add' + update: [] + replace: [] + delete: [] services: id: google.servicenetworking.services name: services title: Services methods: - search_range: + validate: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:searchRange/post' + $ref: '#/paths/~1v1~1services~1{servicesId}:validate/post' response: mediaType: application/json openAPIDocKey: '200' - disable_vpc_service_controls: + enable_vpc_service_controls: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch + #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' - enable_vpc_service_controls: + search_range: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch + $ref: '#/paths/~1v1~1services~1{servicesId}:searchRange/post' response: mediaType: application/json openAPIDocKey: '200' - validate: + disable_vpc_service_controls: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:validate/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' @@ -4533,70 +4591,133 @@ components: update: [] replace: [] delete: [] - operations: - id: google.servicenetworking.operations - name: operations - title: Operations - methods: - cancel: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - get: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: - /v1/services/{servicesId}/dnsZones:add: + /v1/operations/{operationsId}: parameters: &ref_1 + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + 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. + operationId: servicenetworking.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: servicenetworking.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: servicenetworking.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- - Service producers can use this method to add private DNS zones in the - shared producer host project and matching peering zones in the consumer - project. - operationId: servicenetworking.services.dnsZones.add + 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`. + operationId: servicenetworking.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddDnsZoneRequest' + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4612,10 +4733,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: servicesId + name: operationsId required: true schema: type: string @@ -4654,20 +4775,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/roles:add: + /v1/services/{servicesId}/dnsZones:add: parameters: *ref_1 post: description: >- - Service producers can use this method to add roles in the shared VPC - host project. Each role is bound to the provided member. Each role must - be selected from within an allowlisted set of roles. Each role is - applied at only the granularity specified in the allowlist. - operationId: servicenetworking.services.roles.add + Service producers can use this method to add private DNS zones in the + shared producer host project and matching peering zones in the consumer + project. + operationId: servicenetworking.services.dnsZones.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddRolesRequest' + $ref: '#/components/schemas/AddDnsZoneRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4690,16 +4810,13 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/connections/{connectionsId}: + /v1/services/{servicesId}/connections: parameters: *ref_1 - patch: - description: Updates the allocated ranges that are assigned to a connection. - operationId: servicenetworking.services.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + get: + description: >- + List the private connections that are configured in a service consumer's + VPC network. + operationId: servicenetworking.services.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4715,35 +4832,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListConnectionsResponse' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - - in: query - name: force - schema: - type: boolean - in: query - name: updateMask + name: network schema: type: string - format: google-fieldmask post: - description: Deletes a private service access connection. - operationId: servicenetworking.services.connections.deleteConnection + description: >- + Creates a private connection that establishes a VPC Network Peering + connection to a VPC network in the service producer's organization. The + administrator of the service consumer's VPC network invokes this method. + The administrator must assign one or more allocated IP ranges for + provisioning subnetworks in the service producer's VPC network. This + connection is used for all supported services in the service producer's + organization, so it only needs to be invoked once. + operationId: servicenetworking.services.connections.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteConnectionRequest' + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4766,23 +4880,11 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - /v1/services/{servicesId}/connections: + /v1/services/{servicesId}/connections/{connectionsId}: parameters: *ref_1 - post: - description: >- - Creates a private connection that establishes a VPC Network Peering - connection to a VPC network in the service producer's organization. The - administrator of the service consumer's VPC network invokes this method. - The administrator must assign one or more allocated IP ranges for - provisioning subnetworks in the service producer's VPC network. This - connection is used for all supported services in the service producer's - organization, so it only needs to be invoked once. - operationId: servicenetworking.services.connections.create + patch: + description: Updates the allocated ranges that are assigned to a connection. + operationId: servicenetworking.services.connections.patch requestBody: content: application/json: @@ -4810,11 +4912,28 @@ paths: required: true schema: type: string - get: - description: >- - List the private connections that are configured in a service consumer's - VPC network. - operationId: servicenetworking.services.connections.list + - in: path + name: connectionsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + post: + description: Deletes a private service access connection. + operationId: servicenetworking.services.connections.deleteConnection + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4830,25 +4949,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: network + - in: path + name: connectionsId + required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones/{dnsZonesId}: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: parameters: *ref_1 get: description: >- - Service producers can use this method to retrieve a DNS zone in the - shared producer host project and the matching peering zones in consumer - project - operationId: servicenetworking.services.projects.global.networks.dnsZones.get + Consumers use this method to find out the state of VPC Service Controls. + The controls could be enabled or disabled for a connection. + operationId: >- + servicenetworking.services.projects.global.networks.getVpcServiceControls security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4864,7 +4984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetDnsZoneResponse' + $ref: '#/components/schemas/VpcServiceControls' parameters: - in: path name: servicesId @@ -4881,19 +5001,19 @@ paths: required: true schema: type: string - - in: path - name: dnsZonesId - required: true - schema: - type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones:list: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: parameters: *ref_1 - get: + patch: description: >- - * Service producers can use this method to retrieve a list of available - DNS zones in the shared producer host project and the matching peering - zones in the consumer project. * - operationId: servicenetworking.services.projects.global.networks.dnsZones.list + Service producers use this method to update the configuration of their + connection including the import/export of custom routes and subnetwork + routes with public IP. + operationId: servicenetworking.services.projects.global.networks.updateConsumerConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConsumerConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4909,7 +5029,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDnsZonesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -4926,12 +5046,14 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: parameters: *ref_1 - delete: - description: Deletes a peered DNS domain. - operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.delete + get: + description: >- + Service producers use this method to get the configuration of their + connection including the import/export of custom routes and subnetwork + routes with public IP. + operationId: servicenetworking.services.projects.global.networks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4947,7 +5069,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ConsumerConfig' parameters: - in: path name: servicesId @@ -4964,11 +5086,10 @@ paths: required: true schema: type: string - - in: path - name: peeredDnsDomainsId - required: true + - in: query + name: includeUsedIpRanges schema: - type: string + type: boolean /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains: parameters: *ref_1 get: @@ -5051,19 +5172,12 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: parameters: *ref_1 - patch: - description: >- - Service producers use this method to update the configuration of their - connection including the import/export of custom routes and subnetwork - routes with public IP. - operationId: servicenetworking.services.projects.global.networks.updateConsumerConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateConsumerConfigRequest' + delete: + description: Deletes a peered DNS domain. + operationId: >- + servicenetworking.services.projects.global.networks.peeredDnsDomains.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5096,54 +5210,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: - parameters: *ref_1 - get: - description: >- - Consumers use this method to find out the state of VPC Service Controls. - The controls could be enabled or disabled for a connection. - operationId: >- - servicenetworking.services.projects.global.networks.getVpcServiceControls - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/service.management - Oauth2c: - - https://www.googleapis.com/auth/service.management - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/VpcServiceControls' - parameters: - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: networksId + name: peeredDnsDomainsId required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones/{dnsZonesId}: parameters: *ref_1 get: description: >- - Service producers use this method to get the configuration of their - connection including the import/export of custom routes and subnetwork - routes with public IP. - operationId: servicenetworking.services.projects.global.networks.get + Service producers can use this method to retrieve a DNS zone in the + shared producer host project and the matching peering zones in consumer + project + operationId: servicenetworking.services.projects.global.networks.dnsZones.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5159,7 +5238,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConsumerConfig' + $ref: '#/components/schemas/GetDnsZoneResponse' parameters: - in: path name: servicesId @@ -5176,18 +5255,19 @@ paths: required: true schema: type: string - - in: query - name: includeUsedIpRanges + - in: path + name: dnsZonesId + required: true schema: - type: boolean - /v1/services/{servicesId}/dnsRecordSets:get: - parameters: *ref_1 - get: - description: >- - Producers can use this method to retrieve information about the DNS - record set added to the private zone inside the shared tenant host - project associated with a consumer network. - operationId: servicenetworking.services.dnsRecordSets.get + type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones:list: + parameters: *ref_1 + get: + description: >- + * Service producers can use this method to retrieve a list of available + DNS zones in the shared producer host project and the matching peering + zones in the consumer project. * + operationId: servicenetworking.services.projects.global.networks.dnsZones.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5203,41 +5283,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DnsRecordSet' + $ref: '#/components/schemas/ListDnsZonesResponse' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: consumerNetwork - schema: - type: string - - in: query - name: domain - schema: - type: string - - in: query - name: type + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: zone + - in: path + name: networksId + required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:remove: + /v1/services/{servicesId}/dnsRecordSets:add: parameters: *ref_1 post: description: >- - Service producers can use this method to remove DNS record sets from - private DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.remove + Service producers can use this method to add DNS record sets to private + DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveDnsRecordSetRequest' + $ref: '#/components/schemas/AddDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5260,18 +5334,18 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:add: + /v1/services/{servicesId}/dnsRecordSets:remove: parameters: *ref_1 post: description: >- - Service producers can use this method to add DNS record sets to private - DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.add + Service producers can use this method to remove DNS record sets from + private DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.remove requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddDnsRecordSetRequest' + $ref: '#/components/schemas/RemoveDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5328,14 +5402,14 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:list: + /v1/services/{servicesId}/dnsRecordSets:get: parameters: *ref_1 get: description: >- - Producers can use this method to retrieve a list of available DNS - RecordSets available inside the private zone on the tenant host project - accessible from their network. - operationId: servicenetworking.services.dnsRecordSets.list + Producers can use this method to retrieve information about the DNS + record set added to the private zone inside the shared tenant host + project associated with a consumer network. + operationId: servicenetworking.services.dnsRecordSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5351,37 +5425,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDnsRecordSetsResponse' + $ref: '#/components/schemas/DnsRecordSet' parameters: - in: path name: servicesId required: true schema: type: string + - in: query + name: consumerNetwork + schema: + type: string + - in: query + name: domain + schema: + type: string - in: query name: zone schema: type: string - in: query - name: consumerNetwork + name: type schema: type: string - /v1/services/{servicesId}:searchRange: + /v1/services/{servicesId}/dnsRecordSets:list: parameters: *ref_1 - post: + get: description: >- - Service producers can use this method to find a currently unused range - within consumer allocated ranges. This returned range is not reserved, - and not guaranteed to remain unused. It will validate previously - provided allocated ranges, find non-conflicting sub-range of requested - size (expressed in number of leading bits of ipv4 network mask, as in - CIDR range notation). - operationId: servicenetworking.services.searchRange - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SearchRangeRequest' + Producers can use this method to retrieve a list of available DNS + RecordSets available inside the private zone on the tenant host project + accessible from their network. + operationId: servicenetworking.services.dnsRecordSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5397,23 +5471,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListDnsRecordSetsResponse' parameters: - in: path name: servicesId required: true schema: type: string - /v1/services/{servicesId}:disableVpcServiceControls: + - in: query + name: consumerNetwork + schema: + type: string + - in: query + name: zone + schema: + type: string + /v1/services/{servicesId}/roles:add: parameters: *ref_1 - patch: - description: Disables VPC service controls for a connection. - operationId: servicenetworking.services.disableVpcServiceControls + post: + description: >- + Service producers can use this method to add roles in the shared VPC + host project. Each role is bound to the provided member. Each role must + be selected from within an allowlisted set of roles. Each role is + applied at only the granularity specified in the allowlist. + operationId: servicenetworking.services.roles.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableVpcServiceControlsRequest' + $ref: '#/components/schemas/AddRolesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5436,16 +5522,21 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:enableVpcServiceControls: + /v1/services/{servicesId}:validate: parameters: *ref_1 - patch: - description: Enables VPC service controls for a connection. - operationId: servicenetworking.services.enableVpcServiceControls + post: + description: >- + Service producers use this method to validate if the consumer provided + network, project and requested range are valid. This allows them to use + a fail-fast mechanism for consumer requests, and not have to wait for + AddSubnetwork operation completion to determine if user request is + invalid. + operationId: servicenetworking.services.validate requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnableVpcServiceControlsRequest' + $ref: '#/components/schemas/ValidateConsumerConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5461,7 +5552,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ValidateConsumerConfigResponse' parameters: - in: path name: servicesId @@ -5518,21 +5609,16 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:validate: + /v1/services/{servicesId}:enableVpcServiceControls: parameters: *ref_1 - post: - description: >- - Service producers use this method to validate if the consumer provided - network, project and requested range are valid. This allows them to use - a fail-fast mechanism for consumer requests, and not have to wait for - AddSubnetwork operation completion to determine if user request is - invalid. - operationId: servicenetworking.services.validate + patch: + description: Enables VPC service controls for a connection. + operationId: servicenetworking.services.enableVpcServiceControls requestBody: content: application/json: schema: - $ref: '#/components/schemas/ValidateConsumerConfigRequest' + $ref: '#/components/schemas/EnableVpcServiceControlsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5548,32 +5634,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ValidateConsumerConfigResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - /v1/operations/{operationsId}:cancel: + /v1/services/{servicesId}:searchRange: parameters: *ref_1 post: 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`. - operationId: servicenetworking.operations.cancel + Service producers can use this method to find a currently unused range + within consumer allocated ranges. This returned range is not reserved, + and not guaranteed to remain unused. It will validate previously + provided allocated ranges, find non-conflicting sub-range of requested + size (expressed in number of leading bits of ipv4 network mask, as in + CIDR range notation). + operationId: servicenetworking.services.searchRange requestBody: content: application/json: schema: - $ref: '#/components/schemas/CancelOperationRequest' + $ref: '#/components/schemas/SearchRangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5589,58 +5672,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: servicesId required: true schema: type: string - /v1/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: servicenetworking.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/service.management - Oauth2c: - - https://www.googleapis.com/auth/service.management - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOperationsResponse' - parameters: - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/operations/{operationsId}: + /v1/services/{servicesId}:disableVpcServiceControls: parameters: *ref_1 - 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. - operationId: servicenetworking.operations.get + patch: + description: Disables VPC service controls for a connection. + operationId: servicenetworking.services.disableVpcServiceControls + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisableVpcServiceControlsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5659,36 +5707,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId - required: true - schema: - type: string - 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`. - operationId: servicenetworking.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/service.management - Oauth2c: - - https://www.googleapis.com/auth/service.management - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: operationsId + name: servicesId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml b/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml index 77c8a18d..b1dcd44a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml @@ -11,7 +11,7 @@ info: service consumers no longer use. version: v1 x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/service-usage/ servers: @@ -28,10 +28,10 @@ components: https://www.googleapis.com/auth/cloud-platform.read-only: >- View your data across Google Cloud services and see the email address of your Google Account + https://www.googleapis.com/auth/service.management: Manage your Google API service configuration https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. - https://www.googleapis.com/auth/service.management: Manage your Google API service configuration Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -41,1161 +41,769 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - DisableServiceRequest: + EnumValue: + type: object + description: Enum value definition. + id: EnumValue properties: - disableDependentServices: - type: boolean - description: >- - Indicates if services that are enabled and which depend on this - service should also be disabled. If not set, an error will be - generated if any enabled services depend on the service to be - disabled. When set, the service, and any enabled services that - depend on it, will be disabled together. - checkIfServiceHasUsage: + number: + type: integer + format: int32 + description: Enum value number. + options: + type: array + description: Protocol buffer options. + items: + $ref: '#/components/schemas/Option' + name: type: string - description: >- - Defines the behavior for checking service usage when disabling a - service. - enumDescriptions: - - When unset, the default behavior is used, which is SKIP. - - If set, skip checking service usage when disabling a service. - - >- - If set, service usage is checked when disabling the service. If a - service, or its dependents, has usage in the last 30 days, the - request returns a FAILED_PRECONDITION error. - enum: - - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED - - SKIP - - CHECK + description: Enum value name. + Empty: + properties: {} + 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 type: object - description: Request message for the `DisableService` method. - id: DisableServiceRequest - QuotaLimit: + LongRunning: + id: LongRunning type: object - id: QuotaLimit description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). properties: - description: + pollDelayMultiplier: + type: number description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). - type: string - freeTier: + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + format: float + totalPollTimeout: + description: 'Total polling timeout. Default value: 5 minutes.' type: string - format: int64 + format: google-duration + initialPollDelay: description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - displayName: + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + type: string + format: google-duration + maxPollDelay: + type: string description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + format: google-duration + GoogleApiServiceusageV1beta1ServiceIdentity: + properties: + uniqueId: type: string - maxLimit: + description: >- + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + email: type: string description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - format: int64 - metric: + The email address of the service account that a service producer + would use to access consumer resources. + id: GoogleApiServiceusageV1beta1ServiceIdentity + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + type: object + GoogleApiServiceusageV1ServiceConfig: + id: GoogleApiServiceusageV1ServiceConfig + properties: + apis: + type: array + description: >- + A list of API interfaces exported by this service. Contains only the + names, versions, and method names of the interfaces. + items: + $ref: '#/components/schemas/Api' + monitoredResources: + type: array + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + description: >- + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + name: type: string description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - values: - type: object - additionalProperties: - format: int64 - type: string + The DNS address at which this service is available. An example DNS + address would be: `calendar.googleapis.com`. + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + monitoring: + $ref: '#/components/schemas/Monitoring' description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - duration: + Monitoring configuration. This should not include the + 'producer_destinations' field. + documentation: description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. + Additional API documentation. Contains only the summary and the + documentation URL. + $ref: '#/components/schemas/Documentation' + endpoints: + description: >- + Configuration for network endpoints. Contains only the names and + aliases of the endpoints. + type: array + items: + $ref: '#/components/schemas/Endpoint' + title: + description: The product title for this service. type: string - name: + authentication: + description: Auth configuration. Contains only the OAuth rules. + $ref: '#/components/schemas/Authentication' + type: object + description: The configuration of the service. + Analysis: + type: object + description: A message to group the analysis information. + id: Analysis + properties: + service: description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. + The names of the service that has analysis result of warnings or + blockers. Example: `services/storage.googleapis.com`. type: string - unit: + displayName: type: string + readOnly: true description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. - defaultLimit: - format: int64 + Output only. The user friendly display name of the analysis type. + E.g. service dependency analysis, service resource usage analysis, + etc. + analysisType: type: string - description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - ClientLibrarySettings: - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings + enumDescriptions: + - Unspecified analysis type. Do not use. + - The analysis of service dependencies. + - The analysis of service resource usage. + readOnly: true + enum: + - ANALYSIS_TYPE_UNSPECIFIED + - ANALYSIS_TYPE_DEPENDENCY + - ANALYSIS_TYPE_RESOURCE_USAGE + description: Output only. The type of analysis. + analysis: + description: Output only. Analysis result of updating a policy. + readOnly: true + $ref: '#/components/schemas/AnalysisResult' + SystemParameters: properties: - phpSettings: - description: Settings for PHP client libraries. - $ref: '#/components/schemas/PhpSettings' - restNumericEnums: - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - type: boolean - version: + rules: + items: + $ref: '#/components/schemas/SystemParameterRule' + type: array description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - type: string - goSettings: - description: Settings for Go client libraries. - $ref: '#/components/schemas/GoSettings' - nodeSettings: - description: Settings for Node client libraries. - $ref: '#/components/schemas/NodeSettings' - rubySettings: - description: Settings for Ruby client libraries. - $ref: '#/components/schemas/RubySettings' - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - launchStage: - type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - description: Launch stage of this version of the API. - dotnetSettings: - description: Settings for .NET client libraries. - $ref: '#/components/schemas/DotnetSettings' - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + description: >- + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. type: object - CustomError: + id: SystemParameters + Authentication: properties: - types: - type: array - description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. + providers: items: - type: string + $ref: '#/components/schemas/AuthProvider' + description: Defines a set of authentication providers that a service supports. + type: array rules: + description: >- + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. type: array items: - $ref: '#/components/schemas/CustomErrorRule' - description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. - description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - id: CustomError + $ref: '#/components/schemas/AuthenticationRule' type: object - GoogleApiServiceusageV2alphaConsumerPolicy: + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + id: Authentication + Status: properties: - etag: - readOnly: true + code: + type: integer + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + details: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Output only. An opaque tag indicating the current version of the - policy, used for concurrency control. - type: string - name: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + message: description: >- - Output only. The resource name of the policy. Only the `default` - policy is supported: `projects/12345/consumerPolicies/default`, - `folders/12345/consumerPolicies/default`, - `organizations/12345/consumerPolicies/default`. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - readOnly: true - enableRules: + id: Status + type: object + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + LoggingDestination: + id: LoggingDestination + properties: + logs: type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' description: >- - Enable rules define usable services, groups, and categories. There - can currently be at most one `EnableRule`. This restriction will be - lifted in later releases. - annotations: - additionalProperties: + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + items: type: string - type: object + monitoredResource: description: >- - Optional. Annotations is an unstructured key-value map stored with a - policy that may be set by external tools to store and retrieve - arbitrary metadata. They are not queryable and should be preserved - when modifying objects. - [AIP-128](https://google.aip.dev/128#annotations) - updateTime: - readOnly: true - format: google-datetime - description: Output only. The time the policy was last updated. - type: string - createTime: + The monitored resource type. The type must be defined in the + Service.monitored_resources section. type: string - description: >- - Output only. The time the policy was created. For singleton - policies, this is the first touch of the policy. - readOnly: true - format: google-datetime - id: GoogleApiServiceusageV2alphaConsumerPolicy type: object description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. - MetricDescriptorMetadata: - id: MetricDescriptorMetadata + Configuration of a specific logging destination (the producer project or + the consumer project). + AnalysisResult: properties: - ingestDelay: - format: google-duration - type: string - description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - timeSeriesResourceHierarchyLevel: + warnings: items: - enumDescriptions: - - Do not use this default value. - - Scopes a metric to a project. - - Scopes a metric to an organization. - - Scopes a metric to a folder. - type: string - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER + $ref: '#/components/schemas/Impact' + description: >- + Warning information indicating that the policy changes might be + unsafe, but will not block the changes at runtime. type: array - description: The scope of the timeseries data of the metric. - samplePeriod: - type: string - format: google-duration + blockers: description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. - launchStage: - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. + Blocking information that would prevent the policy changes at + runtime. + items: + $ref: '#/components/schemas/Impact' + type: array + type: object + description: An analysis result including blockers and warnings. + id: AnalysisResult + BatchCreateAdminOverridesResponse: + type: object + properties: + overrides: + description: The overrides that were created. + type: array + items: + $ref: '#/components/schemas/QuotaOverride' + description: Response message for BatchCreateAdminOverrides + id: BatchCreateAdminOverridesResponse + Impact: + properties: + detail: + description: Output only. User friendly impact detail in a free form message. + readOnly: true + type: string + impactType: + enumDescriptions: - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. + Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 + Block 0 - Special/Admin codes Block 1 - Impact Type of + ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of + ANALYSIS_TYPE_RESOURCE_USAGE ... + - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY + type: string + readOnly: true enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED + - IMPACT_TYPE_UNSPECIFIED + - DEPENDENCY_MISSING_DEPENDENCIES + description: Output only. The type of impact. + type: object + id: Impact + description: A message to group impacts of updating a policy. + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + DocumentationRule: + properties: + disableReplacementWords: + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + type: string + selector: + type: string + description: >- + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + deprecationDescription: + type: string + description: >- + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + description: + description: >- + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. type: string - deprecated: true - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. type: object - description: Additional annotations that can be used to guide the usage of a metric. + id: DocumentationRule + description: A documentation rule provides information about individual API elements. + Publishing: + description: >- + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. + properties: + docTagPrefix: + description: >- + A prefix used in sample code when demarking regions to be included + in documentation. + type: string + newIssueUri: + type: string + description: >- + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + protoReferenceDocumentationUri: + description: >- + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc + type: string + apiShortName: + type: string + description: >- + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". + codeownerGithubTeams: + description: >- + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + type: array + items: + type: string + githubLabel: + type: string + description: >- + GitHub label to apply to issues and pull requests opened for this + API. + restReferenceDocumentationUri: + type: string + description: >- + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + organization: + description: For whom the client library is being published. + enumDescriptions: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + type: string + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + documentationUri: + type: string + description: >- + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + librarySettings: + type: array + items: + $ref: '#/components/schemas/ClientLibrarySettings' + description: >- + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. + methodSettings: + description: >- + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + items: + $ref: '#/components/schemas/MethodSettings' + type: array + type: object + id: Publishing + Control: + type: object + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + properties: + methodPolicies: + description: Defines policies applying to the API methods of the service. + type: array + items: + $ref: '#/components/schemas/MethodPolicy' + environment: + description: >- + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + type: string + id: Control + MetricRule: + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + properties: + selector: + type: string + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + metricCosts: + description: >- + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + type: object + additionalProperties: + format: int64 + type: string + id: MetricRule + type: object GoogleApiServiceusageV1beta1GetServiceIdentityResponse: type: object + description: Response message for getting service identity. properties: state: - type: string - enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE description: Service identity state. enumDescriptions: - >- Default service identity state. This value is used if the state is omitted. - Service identity has been created and can be used. + type: string + enum: + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE identity: + $ref: '#/components/schemas/GoogleApiServiceusageV1beta1ServiceIdentity' description: >- Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id. - $ref: '#/components/schemas/GoogleApiServiceusageV1beta1ServiceIdentity' - description: Response message for getting service identity. id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse - ImportConsumerOverridesMetadata: - id: ImportConsumerOverridesMetadata - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportConsumerOverrides. + Type: type: object - properties: {} - Authentication: + description: A protocol buffer message type. properties: - rules: + edition: + type: string description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + name: + type: string + description: The fully qualified message name. + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + oneofs: + description: The list of types appearing in `oneof` definitions in this type. type: array items: - $ref: '#/components/schemas/AuthenticationRule' - providers: - description: Defines a set of authentication providers that a service supports. - type: array + type: string + options: items: - $ref: '#/components/schemas/AuthProvider' - type: object - description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - id: Authentication - GetServiceIdentityResponse: - id: GetServiceIdentityResponse - type: object - properties: - state: - enumDescriptions: - - >- - Default service identity state. This value is used if the state is - omitted. - - Service identity has been created and can be used. - description: Service identity state. + $ref: '#/components/schemas/Option' + type: array + description: The protocol buffer options. + syntax: enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. type: string - identity: - $ref: '#/components/schemas/ServiceIdentity' - description: >- - Service identity that service producer can use to access consumer - resources. If exists is true, it contains email and unique_id. If - exists is false, it contains pre-constructed email and empty - unique_id. - description: Response message for getting service identity. + fields: + description: The list of fields. + items: + $ref: '#/components/schemas/Field' + type: array + id: Type + RubySettings: + description: Settings for Ruby client libraries. + id: RubySettings + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + type: object ImportAdminQuotaPoliciesMetadata: - properties: {} + id: ImportAdminQuotaPoliciesMetadata description: >- Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminQuotaPolicies. type: object - id: ImportAdminQuotaPoliciesMetadata - CreateAdminQuotaPolicyMetadata: properties: {} + ClientLibrarySettings: type: object - id: CreateAdminQuotaPolicyMetadata - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by CreateAdminQuotaPolicy. - PythonSettings: - description: Settings for Python client libraries. + id: ClientLibrarySettings properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - experimentalFeatures: + dotnetSettings: + $ref: '#/components/schemas/DotnetSettings' + description: Settings for .NET client libraries. + nodeSettings: + description: Settings for Node client libraries. + $ref: '#/components/schemas/NodeSettings' + goSettings: + $ref: '#/components/schemas/GoSettings' + description: Settings for Go client libraries. + pythonSettings: + $ref: '#/components/schemas/PythonSettings' + description: Settings for Python client libraries. + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + restNumericEnums: description: >- - Experimental features to be included during client library - generation. - $ref: '#/components/schemas/ExperimentalFeatures' - type: object - id: PythonSettings - AnalyzeConsumerPolicyResponse: - description: The response of analyzing a consumer policy update. + When using transport=rest, the client request will encode enums as + numbers rather than strings. + type: boolean + cppSettings: + description: Settings for C++ client libraries. + $ref: '#/components/schemas/CppSettings' + launchStage: + description: Launch stage of this version of the API. + type: string + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + version: + description: >- + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". + type: string + javaSettings: + description: Settings for legacy Java features, supported in the Service YAML. + $ref: '#/components/schemas/JavaSettings' + phpSettings: + $ref: '#/components/schemas/PhpSettings' + description: Settings for PHP client libraries. + description: Details about how and where to publish client libraries. + LabelDescriptor: + description: A description of a label. + properties: + key: + type: string + description: The label key. + valueType: + description: The type of data that can be assigned to the label. + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + type: string + enum: + - STRING + - BOOL + - INT64 + description: + description: A human-readable description for the label. + type: string + id: LabelDescriptor type: object - id: AnalyzeConsumerPolicyResponse + OAuthRequirements: properties: - analysis: + canonicalScopes: description: >- - The list of analyses returned from performing the intended policy - update analysis. The analysis is grouped by service name and - different analysis types. The empty analysis list means that the - consumer policy can be updated without any warnings or blockers. - items: - $ref: '#/components/schemas/Analysis' - type: array - UpdateAdminQuotaPolicyMetadata: - type: object - id: UpdateAdminQuotaPolicyMetadata - properties: {} - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by UpdateAdminQuotaPolicy. - DisableServiceResponse: + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read + type: string + id: OAuthRequirements type: object description: >- - Response message for the `DisableService` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - id: DisableServiceResponse - properties: - service: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: The new state of the service after disabling. - ImportAdminOverridesResponse: - description: Response message for ImportAdminOverrides - id: ImportAdminOverridesResponse - properties: - overrides: - description: The overrides that were created from the imported data. - type: array - items: - $ref: '#/components/schemas/QuotaOverride' - type: object - MethodSettings: - type: object - description: Describes the generator configuration for a method. - id: MethodSettings + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. + HttpRule: + id: HttpRule properties: - autoPopulatedFields: - items: - type: string - type: array + custom: + $ref: '#/components/schemas/CustomHttpPattern' description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + patch: + description: Maps to HTTP PATCH. Used for updating a resource. + type: string selector: type: string description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... - longRunning: - $ref: '#/components/schemas/LongRunning' - description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - EnableServiceRequest: - properties: {} - description: Request message for the `EnableService` method. - type: object - id: EnableServiceRequest - AdminQuotaPolicy: - type: object - description: Quota policy created by quota administrator. - properties: - policyValue: - format: int64 - description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). + Selects a method to which this rule applies. Refer to selector for + syntax details. + responseBody: type: string - unit: description: >- - The limit unit of the limit to which this policy applies. An example - unit would be: `1/{project}/{region}` Note that `{project}` and - `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - type: string - name: + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + post: description: >- - The resource name of the policy. This name is generated by the - server when the policy is created. Example names would be: - `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` - type: string - container: + Maps to HTTP POST. Used for creating a resource or performing an + action. type: string - description: >- - The cloud resource container at which the quota policy is created. - The format is `{container_type}/{container_number}` - dimensions: - type: object - additionalProperties: - type: string - description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.' - metric: + get: type: string description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` - id: AdminQuotaPolicy - GoogleApiServiceusageV1beta1ServiceIdentity: - description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - properties: - email: + Maps to HTTP GET. Used for listing and getting information about + resources. + put: + description: Maps to HTTP PUT. Used for replacing a resource. type: string + additionalBindings: + type: array description: >- - The email address of the service account that a service producer - would use to access consumer resources. - uniqueId: - description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount - type: string - type: object - id: GoogleApiServiceusageV1beta1ServiceIdentity - RemoveEnableRulesMetadata: - type: object - description: Metadata for the `RemoveEnableRules` method. - id: RemoveEnableRulesMetadata - properties: {} - LabelDescriptor: - properties: - valueType: - enum: - - STRING - - BOOL - - INT64 - type: string - description: The type of data that can be assigned to the label. - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - key: - description: The label key. - type: string - description: + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). + items: + $ref: '#/components/schemas/HttpRule' + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. type: string - description: A human-readable description for the label. - description: A description of a label. - type: object - id: LabelDescriptor - MetricRule: - id: MetricRule - type: object - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - properties: - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + body: type: string - metricCosts: - additionalProperties: - format: int64 - type: string description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - type: object - SystemParameters: + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. type: object - properties: - rules: - description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - type: array - items: - $ref: '#/components/schemas/SystemParameterRule' - id: SystemParameters - description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - Method: - description: Method represents a method of an API interface. - id: Method - type: object - properties: - requestStreaming: - type: boolean - description: If true, the request is streamed. - responseTypeUrl: - type: string - description: The URL of the output message type. - responseStreaming: - type: boolean - description: If true, the response is streamed. - requestTypeUrl: - type: string - description: A URL of the input message type. - options: - type: array - items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the method. - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of this method. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: string - name: - type: string - description: The simple name of this method. - Mixin: - type: object - id: Mixin - properties: - name: - description: The fully qualified name of the interface which is included. - type: string - root: - description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. - type: string - description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: - description: Metadata for the `UpdateConsumerPolicy` method. - type: object - id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata - properties: {} - GoogleApiServiceusageV1Service: - properties: - parent: - description: >- - The resource name of the consumer. A valid name would be: - - projects/123 - type: string - state: - enumDescriptions: - - >- - The default value, which indicates that the enabled state of the - service is unspecified or not meaningful. Currently, all consumers - other than projects (such as folders and organizations) are always - in this state. - - >- - The service cannot be used by this consumer. It has either been - explicitly disabled, or has never been enabled. - - The service has been explicitly enabled for use by this consumer. - type: string - enum: - - STATE_UNSPECIFIED - - DISABLED - - ENABLED - description: Whether or not the service has been enabled for use by the consumer. - name: - type: string - description: >- - The resource name of the consumer and service. A valid name would - be: - projects/123/services/serviceusage.googleapis.com - config: - description: >- - The service configuration of the available service. Some fields may - be filtered out of the configuration in responses to the - `ListServices` method. These fields are present only in responses to - the `GetService` method. - $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' - type: object - id: GoogleApiServiceusageV1Service - description: A service that is available for use by the consumer. - PhpSettings: - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - id: PhpSettings - description: Settings for Php client libraries. - type: object - Enum: - id: Enum - type: object - properties: - enumvalue: - items: - $ref: '#/components/schemas/EnumValue' - description: Enum value definitions. - type: array - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - name: - type: string - description: Enum type name. - edition: - type: string - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - options: - type: array - items: - $ref: '#/components/schemas/Option' - description: Protocol buffer options. - syntax: - type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. - description: Enum type definition. - MonitoringDestination: - id: MonitoringDestination - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - properties: - monitoredResource: - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: string - metrics: - description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. - items: - type: string - type: array - type: object - MethodPolicy: - id: MethodPolicy - type: object - properties: - requestPolicies: - type: array - items: - $ref: '#/components/schemas/FieldPolicy' - description: Policies that are applicable to the request message. - selector: - description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - type: string - description: Defines policies applying to an RPC method. - ConsumerPolicy: - description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. - id: ConsumerPolicy - type: object - properties: - enableRules: - description: Enable rules define usable services and service groups. - items: - $ref: '#/components/schemas/EnableRule' - type: array - name: - readOnly: true - type: string - description: >- - Output only. The resource name of the policy. We only allow consumer - policy name as `default` for now: - `projects/12345/consumerPolicies/default`, - `folders/12345/consumerPolicies/default`, - `organizations/12345/consumerPolicies/default`. - updateTime: - format: google-datetime - type: string - description: The last-modified time. - annotations: - description: >- - Optional. Annotations is an unstructured key-value map stored with a - policy that may be set by external tools to store and retrieve - arbitrary metadata. They are not queryable and should be preserved - when modifying objects. - [AIP-128](https://google.aip.dev/128#annotations) - type: object - additionalProperties: - type: string - etag: - description: >- - An opaque tag indicating the current version of the policy, used for - concurrency control. - type: string - Api: - type: object - properties: - methods: - description: The methods of this interface, in unspecified order. - type: array - items: - $ref: '#/components/schemas/Method' - name: - type: string - description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - syntax: - description: The source syntax of the service. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: string - version: - type: string - description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. - options: - type: array - description: Any metadata attached to the interface. - items: - $ref: '#/components/schemas/Option' - mixins: - type: array - description: Included interfaces. See Mixin. - items: - $ref: '#/components/schemas/Mixin' - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: >- - Source context for the protocol buffer service represented by this - message. - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. - id: Api - AuthRequirement: - type: object - id: AuthRequirement - description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - properties: - audiences: - type: string - description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - providerId: - type: string - description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - AuthenticationRule: - type: object - properties: - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - allowWithoutCredential: - description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - type: boolean - requirements: - items: - $ref: '#/components/schemas/AuthRequirement' - type: array - description: Requirements for additional authentication providers. - id: AuthenticationRule - description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - Page: - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - properties: - subpages: - description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - items: - $ref: '#/components/schemas/Page' - type: array - content: - description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. - type: string - name: - description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - type: string - type: object - id: Page - HttpRule: - properties: - patch: - type: string - description: Maps to HTTP PATCH. Used for updating a resource. - put: - type: string - description: Maps to HTTP PUT. Used for replacing a resource. - responseBody: - type: string - description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. - get: - type: string - description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - custom: - $ref: '#/components/schemas/CustomHttpPattern' - description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - post: - description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - type: string - delete: - description: Maps to HTTP DELETE. Used for deleting a resource. - type: string - additionalBindings: - items: - $ref: '#/components/schemas/HttpRule' - description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - type: array - body: - description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. - type: string - selector: - type: string - description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. description: >- gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to @@ -1342,789 +950,997 @@ components: API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + LogDescriptor: + description: >- + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer + id: LogDescriptor + type: object + properties: + description: + type: string + description: >- + A human-readable description of this log. This information appears + in the documentation and can contain details. + displayName: + type: string + description: >- + The human-readable name for this log. This information appears on + the user interface and should be concise. + labels: + description: >- + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array + name: + type: string + description: >- + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + GoogleApiServiceusageV1OperationMetadata: + properties: + resourceNames: + description: >- + The full name of the resources that this operation is directly + associated with. + type: array + items: + type: string + id: GoogleApiServiceusageV1OperationMetadata type: object - id: HttpRule - BackendRule: - description: A backend rule provides configuration for an individual API element. - id: BackendRule + description: The operation metadata returned for the batchend services operation. + GetServiceIdentityMetadata: + type: object + id: GetServiceIdentityMetadata + properties: {} + description: Metadata for the `GetServiceIdentity` method. + Operation: + description: >- + This resource represents a long-running operation that is the result of + a network API call. type: object + id: Operation properties: - selector: + name: type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - overridesByRequestProtocol: - type: object - description: The map between request protocol and the backend address. + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + response: additionalProperties: - $ref: '#/components/schemas/BackendRule' - address: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - type: string - disableAuth: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + done: type: boolean description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - deadline: + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + error: description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - format: double - type: number - operationDeadline: + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + metadata: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - format: double - type: number - minDeadline: - description: Deprecated, do not use. - deprecated: true - type: number - format: double - jwtAudience: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + GoSettings: + description: Settings for Go client libraries. + id: GoSettings + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + type: object + SourceContext: + type: object + id: SourceContext + properties: + fileName: + type: string description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + description: >- + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. + RemoveEnableRulesMetadata: + type: object + id: RemoveEnableRulesMetadata + properties: {} + description: Metadata for the `RemoveEnableRules` method. + Api: + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + type: object + id: Api + properties: + mixins: + items: + $ref: '#/components/schemas/Mixin' + description: Included interfaces. See Mixin. + type: array + name: type: string - protocol: description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. + The fully qualified name of this interface, including package name + followed by the interface's simple name. + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: Any metadata attached to the interface. + sourceContext: + description: >- + Source context for the protocol buffer service represented by this + message. + $ref: '#/components/schemas/SourceContext' + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS type: string - pathTranslation: enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax of the service. + methods: + items: + $ref: '#/components/schemas/Method' + type: array + description: The methods of this interface, in unspecified order. + version: + description: >- + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. type: string - GetServiceIdentityMetadata: - id: GetServiceIdentityMetadata + QuotaOverride: + id: QuotaOverride type: object - description: Metadata for the `GetServiceIdentity` method. - properties: {} - Field: properties: - defaultValue: + unit: description: >- - The string value of the default value of this field. Proto2 syntax - only. + The limit unit of the limit to which this override applies. An + example unit would be: `1/{project}/{region}` Note that `{project}` + and `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. type: string - typeUrl: + dimensions: description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + If this map is nonempty, then this override applies only to specific + values for dimensions defined in the limit unit. For example, an + override on a limit with the unit `1/{project}/{region}` could + contain an entry with the key `region` and the value `us-east-1`; + the override is only applied to quota consumed in that region. This + map has the following restrictions: * Keys that are not defined in + the limit's unit are not valid keys. Any string appearing in + `{brackets}` in the unit (besides `{project}` or `{user}`) is a + defined key. * `project` is not a valid key; the project is already + specified in the parent resource name. * `user` is not a valid key; + the API does not support quota overrides that apply only to a + specific user. * If `region` appears as a key, its value must be a + valid Cloud region. * If `zone` appears as a key, its value must be + a valid Cloud zone. * If any valid key other than `region` or `zone` + appears in the map, then all valid keys other than `region` or + `zone` must also appear in the map. + type: object + additionalProperties: + type: string + overrideValue: type: string - number: - format: int32 - type: integer - description: The field number. - oneofIndex: - format: int32 + format: int64 description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - type: integer - kind: - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + metric: + description: >- + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` type: string - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - description: The field type. - options: - items: - $ref: '#/components/schemas/Option' - type: array - description: The protocol buffer options. - packed: - description: Whether to use alternative packed wire representation. - type: boolean - jsonName: + adminOverrideAncestor: + description: >- + The resource name of the ancestor that requested the override. For + example: `organizations/12345` or `folders/67890`. Used by admin + overrides only. type: string - description: The field JSON name. name: - description: The field name. - type: string - cardinality: + description: >- + The resource name of the override. This name is generated by the + server when the override is created. Example names would be: + `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` + `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` + The resource name is intended to be opaque and should not be parsed + for its component strings, since its representation could change in + the future. type: string - description: The field cardinality. - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - description: A single field of a message type. - type: object - id: Field - Publishing: + description: A quota override + AuthRequirement: + id: AuthRequirement + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). properties: - protoReferenceDocumentationUri: + providerId: description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc + id from authentication provider. Example: provider_id: + bookstore_auth type: string - documentationUri: + audiences: type: string description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - librarySettings: + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: object + Option: + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + properties: + value: description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + name: + type: string + description: >- + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. + type: object + id: Option + ImportConsumerOverridesMetadata: + properties: {} + type: object + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportConsumerOverrides. + id: ImportConsumerOverridesMetadata + AddEnableRulesMetadata: + description: Metadata for the `AddEnableRules` method. + properties: {} + id: AddEnableRulesMetadata + type: object + Billing: + type: object + id: Billing + properties: + consumerDestinations: items: - $ref: '#/components/schemas/ClientLibrarySettings' + $ref: '#/components/schemas/BillingDestination' type: array - docTagPrefix: + description: >- + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count + DeleteAdminQuotaPolicyMetadata: + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by DeleteAdminQuotaPolicy. + type: object + id: DeleteAdminQuotaPolicyMetadata + properties: {} + OperationMetadata: + id: OperationMetadata + type: object + properties: + resourceNames: + type: array + items: + type: string + description: >- + The full name of the resources that this operation is directly + associated with. + description: The operation metadata returned for the batchend services operation. + Documentation: + id: Documentation + properties: + overview: + type: string + description: >- + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. + documentationRootUrl: type: string - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - methodSettings: + description: The URL to the root of documentation. + rules: type: array items: - $ref: '#/components/schemas/MethodSettings' + $ref: '#/components/schemas/DocumentationRule' description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - newIssueUri: - type: string + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. + pages: + type: array + items: + $ref: '#/components/schemas/Page' + description: The top level pages for the documentation set. + sectionOverrides: + type: array + items: + $ref: '#/components/schemas/Page' description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - githubLabel: + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries + serviceRootUrl: type: string description: >- - GitHub label to apply to issues and pull requests opened for this - API. - organization: - description: For whom the client library is being published. - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - type: string - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - restReferenceDocumentationUri: + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. + summary: description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. type: string - codeownerGithubTeams: + description: >- + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. + type: object + EnableServiceRequest: + type: object + description: Request message for the `EnableService` method. + properties: {} + id: EnableServiceRequest + AnalyzeConsumerPolicyResponse: + type: object + properties: + analysis: description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. + The list of analyses returned from performing the intended policy + update analysis. The analysis is grouped by service name and + different analysis types. The empty analysis list means that the + consumer policy can be updated without any warnings or blockers. + items: + $ref: '#/components/schemas/Analysis' type: array + id: AnalyzeConsumerPolicyResponse + description: The response of analyzing a consumer policy update. + ImportAdminQuotaPoliciesResponse: + type: object + id: ImportAdminQuotaPoliciesResponse + properties: + policies: items: - type: string - apiShortName: - type: string - description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". + $ref: '#/components/schemas/AdminQuotaPolicy' + description: The policies that were created from the imported data. + type: array + description: Response message for ImportAdminQuotaPolicies + CppSettings: + id: CppSettings + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + description: Settings for C++ client libraries. type: object - id: Publishing - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - CommonLanguageSettings: + SystemParameter: properties: - referenceDocsUri: + urlQueryParameter: description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest + Define the URL query parameter name to use for the parameter. It is + case sensitive. + type: string + httpHeader: type: string - deprecated: true - destinations: - items: - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - type: string description: >- - The destination where API teams want this client library to be - published. - type: array + Define the HTTP header name to use for the parameter. It is case + insensitive. + name: + type: string + description: >- + Define the name of the parameter, such as "api_key" . It is case + sensitive. type: object - description: Required information for every language. - id: CommonLanguageSettings - UsageRule: - id: UsageRule + id: SystemParameter + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + DisableServiceRequest: + id: DisableServiceRequest + description: Request message for the `DisableService` method. properties: - selector: + checkIfServiceHasUsage: + enumDescriptions: + - When unset, the default behavior is used, which is SKIP. + - If set, skip checking service usage when disabling a service. + - >- + If set, service usage is checked when disabling the service. If a + service, or its dependents, has usage in the last 30 days, the + request returns a FAILED_PRECONDITION error. type: string description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - skipServiceControl: - description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - type: boolean - allowUnregisteredCalls: + Defines the behavior for checking service usage when disabling a + service. + enum: + - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED + - SKIP + - CHECK + disableDependentServices: type: boolean description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true - type: object - ImportAdminOverridesMetadata: - properties: {} - id: ImportAdminOverridesMetadata - type: object - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportAdminOverrides. - Http: - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - id: Http + Indicates if services that are enabled and which depend on this + service should also be disabled. If not set, an error will be + generated if any enabled services depend on the service to be + disabled. When set, the service, and any enabled services that + depend on it, will be disabled together. type: object + Http: properties: - rules: - type: array - items: - $ref: '#/components/schemas/HttpRule' - description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. fullyDecodeReservedExpansion: + type: boolean description: >- When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. - type: boolean - Status: - type: object - properties: - details: + rules: + description: >- + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + $ref: '#/components/schemas/HttpRule' type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - id: Status - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - Analysis: + id: Http type: object + description: >- + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + GoogleApiServiceusageV2alphaConsumerPolicy: properties: - displayName: + createTime: + type: string description: >- - Output only. The user friendly display name of the analysis type. - E.g. service dependency analysis, service resource usage analysis, - etc. + Output only. The time the policy was created. For singleton + policies, this is the first touch of the policy. + format: google-datetime readOnly: true + updateTime: + description: Output only. The time the policy was last updated. type: string - service: - type: string - description: >- - The names of the service that has analysis result of warnings or - blockers. Example: `services/storage.googleapis.com`. - analysis: readOnly: true - description: Output only. Analysis result of updating a policy. - $ref: '#/components/schemas/AnalysisResult' - analysisType: + format: google-datetime + name: + description: >- + Output only. The resource name of the policy. Only the `default` + policy is supported: `projects/12345/consumerPolicies/default`, + `folders/12345/consumerPolicies/default`, + `organizations/12345/consumerPolicies/default`. readOnly: true - enumDescriptions: - - Unspecified analysis type. Do not use. - - The analysis of service dependencies. - - The analysis of service resource usage. - enum: - - ANALYSIS_TYPE_UNSPECIFIED - - ANALYSIS_TYPE_DEPENDENCY - - ANALYSIS_TYPE_RESOURCE_USAGE - description: Output only. The type of analysis. type: string - id: Analysis - description: A message to group the analysis information. - BatchGetServicesResponse: - description: Response message for the `BatchGetServices` method. - properties: - services: + etag: + description: >- + Output only. An opaque tag indicating the current version of the + policy, used for concurrency control. + type: string + readOnly: true + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + policy that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. + [AIP-128](https://google.aip.dev/128#annotations) + type: object + additionalProperties: + type: string + enableRules: type: array - description: The requested Service states. items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - id: BatchGetServicesResponse - type: object - Context: + $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' + description: >- + Enable rules define usable services, groups, and categories. There + can currently be at most one `EnableRule`. This restriction will be + lifted in later releases. description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. + type: object + id: GoogleApiServiceusageV2alphaConsumerPolicy + Endpoint: type: object - id: Context properties: - rules: - type: array + allowCors: + type: boolean description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. + aliases: + type: array items: - $ref: '#/components/schemas/ContextRule' - BillingDestination: + type: string + description: >- + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + name: + description: The canonical name of this endpoint. + type: string + target: + type: string + description: >- + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". + id: Endpoint description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + Field: + description: A single field of a message type. type: object + id: Field properties: - metrics: - type: array + name: + description: The field name. + type: string + options: + description: The protocol buffer options. items: - type: string + $ref: '#/components/schemas/Option' + type: array + kind: + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + description: The field type. + type: string + number: + type: integer + description: The field number. + format: int32 + jsonName: + type: string + description: The field JSON name. + defaultValue: description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - monitoredResource: + The string value of the default value of this field. Proto2 syntax + only. + type: string + typeUrl: type: string description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - id: BillingDestination - LoggingDestination: - properties: - monitoredResource: + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + packed: + type: boolean + description: Whether to use alternative packed wire representation. + oneofIndex: description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + format: int32 + type: integer + cardinality: + description: The field cardinality. + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED type: string - logs: - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - items: - type: string - type: array - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - type: object - id: LoggingDestination - UpdateConsumerPolicyMetadata: - id: UpdateConsumerPolicyMetadata - properties: {} - type: object - description: Metadata for the `UpdateConsumerPolicy` method. - Monitoring: + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + SystemParameterRule: + id: SystemParameterRule type: object - id: Monitoring - properties: - producerDestinations: - type: array - items: - $ref: '#/components/schemas/MonitoringDestination' - description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - consumerDestinations: - type: array - description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - items: - $ref: '#/components/schemas/MonitoringDestination' description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue - AnalysisResult: - type: object + Define a system parameter rule mapping system parameter definitions to + methods. properties: - warnings: - description: >- - Warning information indicating that the policy changes might be - unsafe, but will not block the changes at runtime. + parameters: type: array + description: >- + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. items: - $ref: '#/components/schemas/Impact' - blockers: - items: - $ref: '#/components/schemas/Impact' + $ref: '#/components/schemas/SystemParameter' + selector: + type: string description: >- - Blocking information that would prevent the policy changes at - runtime. - type: array - description: An analysis result including blockers and warnings. - id: AnalysisResult - ExperimentalFeatures: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + Mixin: + id: Mixin + type: object properties: - restAsyncIoEnabled: + name: + description: The fully qualified name of the interface which is included. + type: string + root: + type: string description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. - type: boolean - type: object - id: ExperimentalFeatures + If non-empty specifies a path under which inherited HTTP paths are + rooted. description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. - GoSettings: + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + DotnetSettings: type: object - description: Settings for Go client libraries. + description: Settings for Dotnet client libraries. properties: common: description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - id: GoSettings - GoogleApiServiceusageV1OperationMetadata: - id: GoogleApiServiceusageV1OperationMetadata - description: The operation metadata returned for the batchend services operation. - type: object - properties: - resourceNames: + ignoredResources: + type: array items: type: string - type: array description: >- - The full name of the resources that this operation is directly - associated with. - AddEnableRulesResponse: - type: object - id: AddEnableRulesResponse - properties: - addedValues: - type: array + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + forcedNamespaceAliases: items: type: string - description: The values added to the parent consumer policy. - parent: + type: array description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. - type: string - description: The response message of `AddEnableRules` method. + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision + renamedResources: + description: >- + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + type: object + additionalProperties: + type: string + renamedServices: + description: >- + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + type: object + additionalProperties: + type: string + handwrittenSignatures: + items: + type: string + type: array + description: >- + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + id: DotnetSettings ImportConsumerOverridesResponse: + id: ImportConsumerOverridesResponse properties: overrides: items: $ref: '#/components/schemas/QuotaOverride' description: The overrides that were created from the imported data. type: array - id: ImportConsumerOverridesResponse description: Response message for ImportConsumerOverrides type: object - BatchEnableServicesResponse: - type: object + GetServiceIdentityResponse: properties: - services: - type: array - description: The new state of the services after enabling. - items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - failures: - items: - $ref: '#/components/schemas/EnableFailure' - type: array + identity: + $ref: '#/components/schemas/ServiceIdentity' description: >- - If allow_partial_success is true, and one or more services could not - be enabled, this field contains the details about each failure. - description: >- - Response message for the `BatchEnableServices` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - id: BatchEnableServicesResponse - MetricDescriptor: - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. + Service identity that service producer can use to access consumer + resources. If exists is true, it contains email and unique_id. If + exists is false, it contains pre-constructed email and empty + unique_id. + state: + description: Service identity state. + enumDescriptions: + - >- + Default service identity state. This value is used if the state is + omitted. + - Service identity has been created and can be used. + type: string + enum: + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE + description: Response message for getting service identity. type: object + id: GetServiceIdentityResponse + MonitoredResourceDescriptor: properties: - displayName: + description: type: string description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - description: + Optional. A detailed description of the monitored resource type that + might be used in documentation. + labels: + description: >- + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array + displayName: type: string description: >- - A detailed description of the metric, which can be used in - documentation. + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. type: type: string description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - monitoredResourceTypes: + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). + name: + type: string description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. - items: - type: string - type: array - valueType: + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + launchStage: + description: Optional. The launch stage of the monitored resource definition. enumDescriptions: - Do not use this default value. + - The feature is not yet implemented. Users can not use it. - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. + Prelaunch features are hidden from users and are only visible + internally. - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. - description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY - type: string - metricKind: - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - type: string - name: - type: string - description: The resource name of the metric descriptor. - launchStage: + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. type: string enum: - LAUNCH_STAGE_UNSPECIFIED @@ -2135,7 +1951,60 @@ components: - BETA - GA - DEPRECATED - description: Optional. The launch stage of the metric definition. + id: MonitoredResourceDescriptor + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. + type: object + BillingDestination: + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + id: BillingDestination + properties: + metrics: + description: >- + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + type: array + items: + type: string + monitoredResource: + type: string + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + type: object + MetricDescriptor: + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + type: object + properties: + name: + type: string + description: The resource name of the metric descriptor. + monitoredResourceTypes: + description: >- + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + items: + type: string + type: array + description: + type: string + description: >- + A detailed description of the metric, which can be used in + documentation. + launchStage: enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -2174,9 +2043,28 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - metadata: - description: Optional. Metadata which can be used to guide usage of the metric. - $ref: '#/components/schemas/MetricDescriptorMetadata' + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Optional. The launch stage of the metric definition. + type: string + labels: + description: >- + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. + type: array + items: + $ref: '#/components/schemas/LabelDescriptor' unit: description: >- The units in which the metric value is reported. It is only @@ -2234,416 +2122,313 @@ components: that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent"). type: string - labels: - items: - $ref: '#/components/schemas/LabelDescriptor' - type: array - description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. - id: MetricDescriptor - ContextRule: - description: >- - A context rule provides information about the context for an individual - API element. - id: ContextRule - properties: - allowedRequestExtensions: - items: - type: string - type: array - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - requested: - description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. - items: - type: string - type: array - provided: - items: - type: string - description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. - type: array - allowedResponseExtensions: - type: array - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - items: - type: string - selector: + valueType: + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: object - Impact: - id: Impact - description: A message to group impacts of updating a policy. - properties: - impactType: - type: string - enum: - - IMPACT_TYPE_UNSPECIFIED - - DEPENDENCY_MISSING_DEPENDENCIES - description: Output only. The type of impact. + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. enumDescriptions: + - Do not use this default value. - >- - Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 - Block 0 - Special/Admin codes Block 1 - Impact Type of - ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of - ANALYSIS_TYPE_RESOURCE_USAGE ... - - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY - readOnly: true - detail: + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + displayName: type: string - description: Output only. User friendly impact detail in a free form message. - readOnly: true - type: object - Logging: - properties: - consumerDestinations: - description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. - type: array - items: - $ref: '#/components/schemas/LoggingDestination' - producerDestinations: - type: array - description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. - items: - $ref: '#/components/schemas/LoggingDestination' - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - type: object - id: Logging - Documentation: - properties: - sectionOverrides: - items: - $ref: '#/components/schemas/Page' description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - type: array - documentationRootUrl: - type: string - description: The URL to the root of documentation. - overview: + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + type: description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. - type: string - pages: - description: The top level pages for the documentation set. - type: array - items: - $ref: '#/components/schemas/Page' - serviceRootUrl: + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" type: string + metricKind: + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. - rules: - type: array - description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/DocumentationRule' - summary: - description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. type: string - id: Documentation - description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. - type: object - SystemParameter: - type: object - id: SystemParameter + metadata: + $ref: '#/components/schemas/MetricDescriptorMetadata' + description: Optional. Metadata which can be used to guide usage of the metric. + id: MetricDescriptor + UsageRule: + description: >- + Usage configuration rules for the service. NOTE: Under development. Use + this rule to configure unregistered calls for the service. Unregistered + calls are calls that do not contain consumer project identity. (Example: + calls that do not contain an API key). By default, API methods do not + allow unregistered calls, and each method call must be identified by a + consumer project identity. Use this rule to allow/disallow unregistered + calls. Example of an API that wants to allow unregistered calls for + entire service. usage: rules: - selector: "*" allow_unregistered_calls: + true Example of a method that wants to allow unregistered calls. usage: + rules: - selector: "google.example.library.v1.LibraryService.CreateBook" + allow_unregistered_calls: true + id: UsageRule properties: - name: - type: string - description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - httpHeader: + selector: description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - type: string - urlQueryParameter: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string + allowUnregisteredCalls: description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. - BatchCreateConsumerOverridesResponse: - id: BatchCreateConsumerOverridesResponse + If true, the selected method allows unregistered calls, e.g. calls + that don't identify any user or application. + type: boolean + skipServiceControl: + type: boolean + description: >- + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + type: object + BatchGetServicesResponse: type: object properties: - overrides: - items: - $ref: '#/components/schemas/QuotaOverride' + services: + description: The requested Service states. type: array - description: The overrides that were created. - description: Response message for BatchCreateConsumerOverrides - LogDescriptor: - description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer + items: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: Response message for the `BatchGetServices` method. + id: BatchGetServicesResponse + GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: + properties: {} + id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata + type: object + description: Metadata for the `UpdateConsumerPolicy` method. + AdminQuotaPolicy: + description: Quota policy created by quota administrator. properties: - name: + unit: + description: >- + The limit unit of the limit to which this policy applies. An example + unit would be: `1/{project}/{region}` Note that `{project}` and + `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. + type: string + dimensions: + description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.' + additionalProperties: + type: string + type: object + policyValue: + format: int64 type: string description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - description: + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). + container: description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. + The cloud resource container at which the quota policy is created. + The format is `{container_type}/{container_number}` type: string - labels: - items: - $ref: '#/components/schemas/LabelDescriptor' - description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - type: array - displayName: + metric: description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` + type: string + name: type: string + description: >- + The resource name of the policy. This name is generated by the + server when the policy is created. Example names would be: + `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` type: object - id: LogDescriptor - SystemParameterRule: + id: AdminQuotaPolicy + PhpSettings: type: object + id: PhpSettings + description: Settings for Php client libraries. properties: - selector: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + ConsumerPolicy: + properties: + updateTime: + description: The last-modified time. + type: string + format: google-datetime + annotations: + type: object description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + Optional. Annotations is an unstructured key-value map stored with a + policy that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. + [AIP-128](https://google.aip.dev/128#annotations) + additionalProperties: + type: string + name: type: string - parameters: - type: array description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. + Output only. The resource name of the policy. We only allow consumer + policy name as `default` for now: + `projects/12345/consumerPolicies/default`, + `folders/12345/consumerPolicies/default`, + `organizations/12345/consumerPolicies/default`. + readOnly: true + enableRules: items: - $ref: '#/components/schemas/SystemParameter' - id: SystemParameterRule + $ref: '#/components/schemas/EnableRule' + type: array + description: Enable rules define usable services and service groups. + etag: + type: string + description: >- + An opaque tag indicating the current version of the policy, used for + concurrency control. description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - DeleteAdminQuotaPolicyMetadata: + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. type: object - properties: {} - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by DeleteAdminQuotaPolicy. - id: DeleteAdminQuotaPolicyMetadata - CustomHttpPattern: - id: CustomHttpPattern - properties: - path: - description: The path matched by this custom verb. - type: string - kind: - type: string - description: The name of this custom HTTP verb. + id: ConsumerPolicy + NodeSettings: type: object - description: A custom pattern is used for defining custom HTTP verb. - Backend: + id: NodeSettings + description: Settings for Node client libraries. properties: - rules: - type: array - description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + SourceInfo: + description: Source information used to create a Service Config + properties: + sourceFiles: + description: All files used during config generation. items: - $ref: '#/components/schemas/BackendRule' + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + id: SourceInfo type: object - id: Backend - description: '`Backend` defines the backend configuration for a service.' - BatchCreateAdminOverridesResponse: + AnalyzeConsumerPolicyMetadata: + type: object + properties: {} + id: AnalyzeConsumerPolicyMetadata + description: Metadata for the `AnalyzeConsumerPolicy` method. + Method: + description: Method represents a method of an API interface. + id: Method type: object - id: BatchCreateAdminOverridesResponse properties: - overrides: + requestStreaming: + description: If true, the request is streamed. + type: boolean + options: type: array + description: Any metadata attached to the method. items: - $ref: '#/components/schemas/QuotaOverride' - description: The overrides that were created. - description: Response message for BatchCreateAdminOverrides - AddEnableRulesMetadata: - properties: {} - description: Metadata for the `AddEnableRules` method. - id: AddEnableRulesMetadata - type: object - SourceInfo: + $ref: '#/components/schemas/Option' + responseTypeUrl: + type: string + description: The URL of the output message type. + requestTypeUrl: + description: A URL of the input message type. + type: string + responseStreaming: + description: If true, the response is streamed. + type: boolean + name: + description: The simple name of this method. + type: string + syntax: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax of this method. + type: string + ListServicesResponse: + id: ListServicesResponse + description: Response message for the `ListServices` method. properties: - sourceFiles: - description: All files used during config generation. + nextPageToken: + description: >- + Token that can be passed to `ListServices` to resume a paginated + query. + type: string + services: type: array + description: The available services for the requested project. items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - id: SourceInfo - description: Source information used to create a Service Config - type: object - EnableRule: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' type: object - id: EnableRule + RemoveEnableRulesResponse: + description: The response message of `RemoveEnableRules` method. properties: - values: - description: >- - The names of the services or service groups that are enabled. - Example: `services/storage.googleapis.com`, `groups/googleServices`, - `groups/allServices`. - type: array - items: - type: string - services: + parent: + type: string description: >- - DEPRECATED: Please use field `values`. Service should have prefix - `services/`. The names of the services that are enabled. Example: - `storage.googleapis.com`. - deprecated: true + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. + removedValues: items: type: string + description: The values removed from the parent consumer policy. type: array - groups: deprecated: true - description: >- - DEPRECATED: Please use field `values`. Service group should have - prefix `groups/`. The names of the service groups that are enabled - (Not Implemented). Example: `groups/googleServices`. - type: array - items: - type: string - enableType: - description: Client and resource project enable type. - enumDescriptions: - - >- - Unspecified enable type, which means enabled as both client and - resource project. - - >- - Enable all clients under the CRM node specified by - `ConsumerPolicy.name` to use the listed services. A client can be - an API key, an OAuth client, or a service account. - - >- - Enable resources in the list services to be created and used under - the CRM node specified by the `ConsumerPolicy.name`. - - >- - Activation made by Service Usage v1 API. This will be how - consumers differentiate between policy changes made by v1 and v2 - clients and understand what is actually possible based on those - different policies. - type: string - enum: - - ENABLE_TYPE_UNSPECIFIED - - CLIENT - - RESOURCE - - V1_COMPATIBLE - description: >- - The consumer policy rule that defines usable services and service - groups. - FieldPolicy: type: object - id: FieldPolicy + id: RemoveEnableRulesResponse + FieldPolicy: properties: resourcePermission: - type: string description: >- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get". + type: string resourceType: type: string description: >- @@ -2659,6 +2444,7 @@ components: in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz". + id: FieldPolicy description: >- Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message @@ -2667,258 +2453,257 @@ components: This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation. - DotnetSettings: - description: Settings for Dotnet client libraries. + type: object + CustomErrorRule: properties: - handwrittenSignatures: - items: - type: string - type: array - description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - renamedServices: - type: object - description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - additionalProperties: - type: string - forcedNamespaceAliases: - type: array - items: - type: string - description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - renamedResources: - type: object - additionalProperties: - type: string + isErrorType: description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - ignoredResources: + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + type: boolean + selector: description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - type: array - items: - type: string - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' + Selects messages to which this rule applies. Refer to selector for + syntax details. + type: string + description: A custom error rule. type: object - id: DotnetSettings - ServiceIdentity: + id: CustomErrorRule + DisableServiceResponse: properties: - uniqueId: - description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount - type: string - email: - type: string - description: >- - The email address of the service account that a service producer - would use to access consumer resources. + service: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The new state of the service after disabling. + description: >- + Response message for the `DisableService` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + id: DisableServiceResponse type: object - id: ServiceIdentity + ImportAdminOverridesMetadata: description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - ListServicesResponse: - description: Response message for the `ListServices` method. + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportAdminOverrides. + id: ImportAdminOverridesMetadata + properties: {} + type: object + BatchEnableServicesResponse: + description: >- + Response message for the `BatchEnableServices` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: BatchEnableServicesResponse + type: object properties: services: + description: The new state of the services after enabling. items: $ref: '#/components/schemas/GoogleApiServiceusageV1Service' type: array - description: The available services for the requested project. - nextPageToken: + failures: + items: + $ref: '#/components/schemas/EnableFailure' description: >- - Token that can be passed to `ListServices` to resume a paginated - query. - type: string - type: object - id: ListServicesResponse - DocumentationRule: - type: object - id: DocumentationRule + If allow_partial_success is true, and one or more services could not + be enabled, this field contains the details about each failure. + type: array + CustomError: + id: CustomError + description: >- + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError properties: - deprecationDescription: - type: string + types: + type: array + items: + type: string description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - disableReplacementWords: - type: string + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + rules: + type: array + items: + $ref: '#/components/schemas/CustomErrorRule' description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. - description: - type: string + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + type: object + MethodSettings: + id: MethodSettings + properties: + longRunning: description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + $ref: '#/components/schemas/LongRunning' selector: type: string description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. - description: A documentation rule provides information about individual API elements. - ListOperationsResponse: - properties: - operations: - items: - $ref: '#/components/schemas/Operation' + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... + autoPopulatedFields: type: array description: >- - A list of operations that matches the specified filter in the - request. - nextPageToken: - type: string - description: The standard List next-page token. - description: The response message for Operations.ListOperations. - id: ListOperationsResponse - type: object - Operation: + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id + items: + type: string type: object - id: Operation + description: Describes the generator configuration for a method. + AuthenticationRule: description: >- - This resource represents a long-running operation that is the result of - a network API call. + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + id: AuthenticationRule + type: object properties: - response: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + requirements: + type: array + items: + $ref: '#/components/schemas/AuthRequirement' + description: Requirements for additional authentication providers. + allowWithoutCredential: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - metadata: + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + type: boolean + selector: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - name: + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string + Monitoring: + properties: + consumerDestinations: + items: + $ref: '#/components/schemas/MonitoringDestination' description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + type: array + producerDestinations: + type: array description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - NodeSettings: - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - description: Settings for Node client libraries. - id: NodeSettings + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + items: + $ref: '#/components/schemas/MonitoringDestination' + id: Monitoring + type: object + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + Enum: + id: Enum type: object - JavaSettings: properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - serviceClassNames: - additionalProperties: - type: string - type: object - description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - libraryPackage: + edition: type: string description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 - id: JavaSettings - description: Settings for Java client libraries. - type: object - EnableFailure: - properties: - serviceId: - description: The service id of a service that could not be enabled. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + enumvalue: + type: array + items: + $ref: '#/components/schemas/EnumValue' + description: Enum value definitions. + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: Protocol buffer options. + name: + description: Enum type name. type: string - errorMessage: + syntax: type: string - description: An error message describing why the service could not be enabled. - description: Provides error messages for the failing services. - id: EnableFailure - type: object - EnableServiceResponse: - type: object - id: EnableServiceResponse - description: >- - Response message for the `EnableService` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - properties: - service: - description: The new state of the service after enabling. - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The source syntax. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + description: Enum type definition. AuthProvider: - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - type: object - id: AuthProvider properties: + issuer: + description: >- + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com + type: string + id: + type: string + description: >- + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". jwtLocations: - items: - $ref: '#/components/schemas/JwtLocation' type: array description: >- Defines the locations to extract the JWT. For now it is only used by @@ -2932,17 +2717,10 @@ components: locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token - id: - description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - type: string - authorizationUrl: - type: string - description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. + items: + $ref: '#/components/schemas/JwtLocation' audiences: + type: string description: >- The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). @@ -2956,7 +2734,11 @@ components: - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com + authorizationUrl: type: string + description: >- + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. jwksUri: type: string description: >- @@ -2968,236 +2750,500 @@ components: of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs - issuer: + type: object + id: AuthProvider + description: >- + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + CreateAdminQuotaPolicyMetadata: + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by CreateAdminQuotaPolicy. + properties: {} + id: CreateAdminQuotaPolicyMetadata + type: object + UpdateConsumerPolicyMetadata: + description: Metadata for the `UpdateConsumerPolicy` method. + type: object + id: UpdateConsumerPolicyMetadata + properties: {} + Quota: + id: Quota + type: object + properties: + limits: + description: List of QuotaLimit definitions for the service. + type: array + items: + $ref: '#/components/schemas/QuotaLimit' + metricRules: + type: array description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - type: string - CustomErrorRule: + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + items: + $ref: '#/components/schemas/MetricRule' + description: >- + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + UpdateAdminQuotaPolicyMetadata: + id: UpdateAdminQuotaPolicyMetadata + properties: {} + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by UpdateAdminQuotaPolicy. + type: object + BackendRule: properties: - selector: + deadline: description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + type: number + format: double + jwtAudience: + description: >- + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. type: string - isErrorType: + protocol: description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. + type: string + overridesByRequestProtocol: + additionalProperties: + $ref: '#/components/schemas/BackendRule' + description: The map between request protocol and the backend address. + type: object + operationDeadline: + description: >- + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + format: double + type: number + disableAuth: type: boolean - id: CustomErrorRule + description: >- + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + minDeadline: + deprecated: true + description: Deprecated, do not use. + type: number + format: double + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + pathTranslation: + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + type: string + address: + type: string + description: >- + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + id: BackendRule + description: A backend rule provides configuration for an individual API element. type: object - description: A custom error rule. - AnalyzeConsumerPolicyMetadata: + Page: type: object - description: Metadata for the `AnalyzeConsumerPolicy` method. - id: AnalyzeConsumerPolicyMetadata - properties: {} - SourceContext: + properties: + content: + description: >- + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. + type: string + name: + description: >- + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. + type: string + subpages: + description: >- + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. + items: + $ref: '#/components/schemas/Page' + type: array + id: Page description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - id: SourceContext + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + CustomHttpPattern: + id: CustomHttpPattern properties: - fileName: + path: + description: The path matched by this custom verb. + type: string + kind: + description: The name of this custom HTTP verb. type: string - description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. + description: A custom pattern is used for defining custom HTTP verb. type: object - GoogleApiServiceusageV1ServiceConfig: - id: GoogleApiServiceusageV1ServiceConfig + EnableRule: + description: >- + The consumer policy rule that defines usable services and service + groups. type: object - description: The configuration of the service. + id: EnableRule properties: - name: - description: >- - The DNS address at which this service is available. An example DNS - address would be: `calendar.googleapis.com`. - type: string - endpoints: + services: description: >- - Configuration for network endpoints. Contains only the names and - aliases of the endpoints. + DEPRECATED: Please use field `values`. Service should have prefix + `services/`. The names of the services that are enabled. Example: + `storage.googleapis.com`. + type: array items: - $ref: '#/components/schemas/Endpoint' + type: string + deprecated: true + groups: + deprecated: true type: array - documentation: + items: + type: string description: >- - Additional API documentation. Contains only the summary and the - documentation URL. - $ref: '#/components/schemas/Documentation' - apis: + DEPRECATED: Please use field `values`. Service group should have + prefix `groups/`. The names of the service groups that are enabled + (Not Implemented). Example: `groups/googleServices`. + values: type: array - items: - $ref: '#/components/schemas/Api' description: >- - A list of API interfaces exported by this service. Contains only the - names, versions, and method names of the interfaces. - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - title: - description: The product title for this service. + The names of the services or service groups that are enabled. + Example: `services/storage.googleapis.com`, `groups/googleServices`, + `groups/allServices`. + items: + type: string + enableType: + enumDescriptions: + - >- + Unspecified enable type, which means enabled as both client and + resource project. + - >- + Enable all clients under the CRM node specified by + `ConsumerPolicy.name` to use the listed services. A client can be + an API key, an OAuth client, or a service account. + - >- + Enable resources in the list services to be created and used under + the CRM node specified by the `ConsumerPolicy.name`. + - >- + Activation made by Service Usage v1 API. This will be how + consumers differentiate between policy changes made by v1 and v2 + clients and understand what is actually possible based on those + different policies. + description: Client and resource project enable type. type: string - monitoring: - $ref: '#/components/schemas/Monitoring' + enum: + - ENABLE_TYPE_UNSPECIFIED + - CLIENT + - RESOURCE + - V1_COMPATIBLE + JavaSettings: + properties: + serviceClassNames: description: >- - Monitoring configuration. This should not include the - 'producer_destinations' field. - usage: - description: Configuration controlling usage of this service. - $ref: '#/components/schemas/Usage' - authentication: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. Contains only the OAuth rules. - monitoredResources: - type: array + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + additionalProperties: + type: string + type: object + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + libraryPackage: + type: string description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 + type: object + description: Settings for Java client libraries. + id: JavaSettings + Backend: + properties: + rules: items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - CancelOperationRequest: + $ref: '#/components/schemas/BackendRule' + description: >- + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + description: '`Backend` defines the backend configuration for a service.' + id: Backend type: object - description: The request message for Operations.CancelOperation. - id: CancelOperationRequest - properties: {} - QuotaOverride: + QuotaLimit: + description: >- + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. type: object + id: QuotaLimit properties: - metric: + maxLimit: type: string + format: int64 description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` - unit: + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + defaultLimit: + description: >- + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + format: int64 type: string + values: description: >- - The limit unit of the limit to which this override applies. An - example unit would be: `1/{project}/{region}` Note that `{project}` - and `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - dimensions: + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. additionalProperties: + format: int64 type: string - description: >- - If this map is nonempty, then this override applies only to specific - values for dimensions defined in the limit unit. For example, an - override on a limit with the unit `1/{project}/{region}` could - contain an entry with the key `region` and the value `us-east-1`; - the override is only applied to quota consumed in that region. This - map has the following restrictions: * Keys that are not defined in - the limit's unit are not valid keys. Any string appearing in - `{brackets}` in the unit (besides `{project}` or `{user}`) is a - defined key. * `project` is not a valid key; the project is already - specified in the parent resource name. * `user` is not a valid key; - the API does not support quota overrides that apply only to a - specific user. * If `region` appears as a key, its value must be a - valid Cloud region. * If `zone` appears as a key, its value must be - a valid Cloud zone. * If any valid key other than `region` or `zone` - appears in the map, then all valid keys other than `region` or - `zone` must also appear in the map. type: object - overrideValue: + description: + description: >- + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + type: string + freeTier: + type: string format: int64 + description: >- + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + metric: + type: string + description: >- + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. + duration: + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + type: string + unit: + description: >- + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + type: string + displayName: + description: >- + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + type: string + name: + description: >- + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. type: string + PythonSettings: + type: object + id: PythonSettings + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + experimentalFeatures: + $ref: '#/components/schemas/ExperimentalFeatures' description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). - name: + Experimental features to be included during client library + generation. + description: Settings for Python client libraries. + ServiceIdentity: + id: ServiceIdentity + type: object + properties: + uniqueId: type: string description: >- - The resource name of the override. This name is generated by the - server when the override is created. Example names would be: - `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` - `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` - The resource name is intended to be opaque and should not be parsed - for its component strings, since its representation could change in - the future. - adminOverrideAncestor: - description: >- - The resource name of the ancestor that requested the override. For - example: `organizations/12345` or `folders/67890`. Used by admin - overrides only. + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + email: type: string - description: A quota override - id: QuotaOverride - Type: - description: A protocol buffer message type. + description: >- + The email address of the service account that a service producer + would use to access consumer resources. + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + Logging: + id: Logging + description: >- + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history type: object properties: - oneofs: - description: The list of types appearing in `oneof` definitions in this type. + producerDestinations: items: - type: string + $ref: '#/components/schemas/LoggingDestination' type: array - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - options: + description: >- + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. + consumerDestinations: items: - $ref: '#/components/schemas/Option' - description: The protocol buffer options. - type: array - edition: + $ref: '#/components/schemas/LoggingDestination' description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - type: string - fields: - description: The list of fields. + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. type: array + MethodPolicy: + description: Defines policies applying to an RPC method. + id: MethodPolicy + properties: + requestPolicies: items: - $ref: '#/components/schemas/Field' - syntax: - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax. - name: + $ref: '#/components/schemas/FieldPolicy' + type: array + description: Policies that are applicable to the request message. + selector: + description: >- + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . type: string - description: The fully qualified message name. - id: Type - MonitoredResourceDescriptor: type: object - id: MonitoredResourceDescriptor + MetricDescriptorMetadata: properties: - description: - description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - type: string - displayName: - type: string - description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. - name: - description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. - type: string launchStage: - description: Optional. The launch stage of the monitored resource definition. + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + deprecated: true enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -3236,222 +3282,52 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. + type: string enum: - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - type: string - labels: - items: - $ref: '#/components/schemas/LabelDescriptor' - description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. - type: array - type: - description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - type: string - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. - CppSettings: - type: object - id: CppSettings - description: Settings for C++ client libraries. - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - Control: - type: object - description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - properties: - environment: - type: string - description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com - methodPolicies: - items: - $ref: '#/components/schemas/MethodPolicy' - type: array - description: Defines policies applying to the API methods of the service. - id: Control - OperationMetadata: - id: OperationMetadata - type: object - description: The operation metadata returned for the batchend services operation. - properties: - resourceNames: - type: array - description: >- - The full name of the resources that this operation is directly - associated with. - items: - type: string - JwtLocation: - description: Specifies a location to extract JWT from an API request. - type: object - id: JwtLocation - properties: - cookie: - description: Specifies cookie name to extract JWT token. - type: string - header: - type: string - description: Specifies HTTP header name to extract JWT token. - valuePrefix: - description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - type: string - query: - type: string - description: Specifies URL query parameter name to extract JWT token. - LongRunning: - type: object - id: LongRunning - description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - properties: - pollDelayMultiplier: - type: number - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - format: float - totalPollTimeout: - type: string - description: 'Total polling timeout. Default value: 5 minutes.' - format: google-duration - maxPollDelay: + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + ingestDelay: format: google-duration description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. type: string - initialPollDelay: + samplePeriod: format: google-duration - type: string description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - RemoveEnableRulesResponse: - id: RemoveEnableRulesResponse - description: The response message of `RemoveEnableRules` method. - type: object - properties: - removedValues: - description: The values removed from the parent consumer policy. - items: - type: string - type: array - deprecated: true - parent: - description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. type: string - Quota: - id: Quota - type: object - properties: - metricRules: - items: - $ref: '#/components/schemas/MetricRule' - description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - type: array - limits: - items: - $ref: '#/components/schemas/QuotaLimit' - description: List of QuotaLimit definitions for the service. - type: array - description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - EnumValue: - type: object - description: Enum value definition. - id: EnumValue - properties: - number: - description: Enum value number. - format: int32 - type: integer - options: - description: Protocol buffer options. + timeSeriesResourceHierarchyLevel: + description: The scope of the timeseries data of the metric. items: - $ref: '#/components/schemas/Option' + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + type: string + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER type: array - name: - type: string - description: Enum value name. - RubySettings: - description: Settings for Ruby client libraries. - id: RubySettings + description: Additional annotations that can be used to guide the usage of a metric. + id: MetricDescriptorMetadata type: object - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. BatchEnableServicesRequest: properties: serviceIds: - items: - type: string type: array description: >- The identifiers of the services to enable on the project. A valid @@ -3460,108 +3336,166 @@ components: enabling the service. A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no state changes will occur. - id: BatchEnableServicesRequest + items: + type: string type: object description: Request message for the `BatchEnableServices` method. - Billing: - type: object + id: BatchEnableServicesRequest + BatchCreateConsumerOverridesResponse: properties: - consumerDestinations: + overrides: type: array items: - $ref: '#/components/schemas/BillingDestination' - description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. - description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count - id: Billing - GoogleApiServiceusageV2alphaEnableRule: - id: GoogleApiServiceusageV2alphaEnableRule + $ref: '#/components/schemas/QuotaOverride' + description: The overrides that were created. + id: BatchCreateConsumerOverridesResponse + description: Response message for BatchCreateConsumerOverrides type: object - description: >- - The consumer policy rule that defines enabled services, groups, and - categories. + AddEnableRulesResponse: properties: - services: - type: array + addedValues: items: type: string + description: The values added to the parent consumer policy. + type: array + parent: + type: string description: >- - The names of the services that are enabled. Example: - `services/storage.googleapis.com`. - Option: + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. + type: object + id: AddEnableRulesResponse + description: The response message of `AddEnableRules` method. + JwtLocation: + type: object properties: - value: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - name: + query: + description: Specifies URL query parameter name to extract JWT token. + type: string + header: + description: Specifies HTTP header name to extract JWT token. + type: string + valuePrefix: type: string description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + cookie: + description: Specifies cookie name to extract JWT token. + type: string + description: Specifies a location to extract JWT from an API request. + id: JwtLocation + EnableServiceResponse: type: object description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - id: Option - ImportAdminQuotaPoliciesResponse: - id: ImportAdminQuotaPoliciesResponse - description: Response message for ImportAdminQuotaPolicies + Response message for the `EnableService` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + properties: + service: + description: The new state of the service after enabling. + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + id: EnableServiceResponse + ImportAdminOverridesResponse: + description: Response message for ImportAdminOverrides + properties: + overrides: + description: The overrides that were created from the imported data. + type: array + items: + $ref: '#/components/schemas/QuotaOverride' + id: ImportAdminOverridesResponse + type: object + ExperimentalFeatures: + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + id: ExperimentalFeatures + type: object + properties: + restAsyncIoEnabled: + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean + GoogleApiServiceusageV2alphaEnableRule: + description: >- + The consumer policy rule that defines enabled services, groups, and + categories. + id: GoogleApiServiceusageV2alphaEnableRule properties: - policies: - description: The policies that were created from the imported data. + services: type: array items: - $ref: '#/components/schemas/AdminQuotaPolicy' + type: string + description: >- + The names of the services that are enabled. Example: + `services/storage.googleapis.com`. type: object GoogleApiService: + id: GoogleApiService + description: >- + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth properties: - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - enums: + customError: + description: Custom error configuration. + $ref: '#/components/schemas/CustomError' + context: + $ref: '#/components/schemas/Context' + description: Context configuration. + endpoints: description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. items: - $ref: '#/components/schemas/Enum' + $ref: '#/components/schemas/Endpoint' type: array + authentication: + description: Auth configuration. + $ref: '#/components/schemas/Authentication' + title: + type: string + description: >- + The product title for this service, it is the name displayed in + Google Cloud Console. + control: + description: Configuration for the service control plane. + $ref: '#/components/schemas/Control' + sourceInfo: + description: >- + Output only. The source information for this configuration if + available. + $ref: '#/components/schemas/SourceInfo' + producerProjectId: + type: string + description: The Google project that owns this service. apis: type: array - items: - $ref: '#/components/schemas/Api' description: >- A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the @@ -3569,161 +3503,233 @@ components: the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - metrics: - type: array items: - $ref: '#/components/schemas/MetricDescriptor' - description: Defines the metrics used by this service. + $ref: '#/components/schemas/Api' + publishing: + description: >- + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + $ref: '#/components/schemas/Publishing' name: - type: string description: >- The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. - systemTypes: + type: string + logging: + description: Logging configuration. + $ref: '#/components/schemas/Logging' + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. + logs: + description: Defines the logs used by this service. + items: + $ref: '#/components/schemas/LogDescriptor' + type: array + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + metrics: type: array items: - $ref: '#/components/schemas/Type' + $ref: '#/components/schemas/MetricDescriptor' + description: Defines the metrics used by this service. + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + monitoredResources: description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - logs: + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. type: array - description: Defines the logs used by this service. items: - $ref: '#/components/schemas/LogDescriptor' - title: - type: string + $ref: '#/components/schemas/MonitoredResourceDescriptor' + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + enums: + type: array + items: + $ref: '#/components/schemas/Enum' description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + types: + items: + $ref: '#/components/schemas/Type' + type: array + description: >- + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 configVersion: + format: uint32 description: >- Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. - format: uint32 type: integer id: - type: string description: >- A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead. - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. + type: string + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' backend: description: API backend configuration. $ref: '#/components/schemas/Backend' - producerProjectId: - type: string - description: The Google project that owns this service. - customError: - description: Custom error configuration. - $ref: '#/components/schemas/CustomError' - sourceInfo: - $ref: '#/components/schemas/SourceInfo' - description: >- - Output only. The source information for this configuration if - available. - types: + systemTypes: description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. type: array items: $ref: '#/components/schemas/Type' - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - endpoints: + billing: + $ref: '#/components/schemas/Billing' + description: Billing configuration. + type: object + ContextRule: + type: object + description: >- + A context rule provides information about the context for an individual + API element. + properties: + selector: description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + allowedResponseExtensions: + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. type: array items: - $ref: '#/components/schemas/Endpoint' - billing: - description: Billing configuration. - $ref: '#/components/schemas/Billing' - monitoredResources: + type: string + provided: + items: + type: string + type: array + description: >- + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. + requested: + description: >- + A list of full type names of requested contexts, only the requested + context will be made available to the backend. + type: array + items: + type: string + allowedRequestExtensions: + items: + type: string + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + type: array + id: ContextRule + ListOperationsResponse: + description: The response message for Operations.ListOperations. + id: ListOperationsResponse + type: object + properties: + nextPageToken: + type: string + description: The standard List next-page token. + operations: items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - type: array - description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - publishing: + $ref: '#/components/schemas/Operation' description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - $ref: '#/components/schemas/Publishing' - control: - $ref: '#/components/schemas/Control' - description: Configuration for the service control plane. + A list of operations that matches the specified filter in the + request. + type: array + Context: description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - type: object - id: GoogleApiService - Usage: - id: Usage - type: object + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. properties: rules: + items: + $ref: '#/components/schemas/ContextRule' description: >- - A list of usage rules that apply to individual API methods. + A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - items: - $ref: '#/components/schemas/UsageRule' type: array - requirements: + id: Context + type: object + CommonLanguageSettings: + description: Required information for every language. + id: CommonLanguageSettings + properties: + destinations: + description: >- + The destination where API teams want this client library to be + published. type: array + items: + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + type: string + referenceDocsUri: + description: >- + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + type: string + deprecated: true + type: object + Usage: + type: object + id: Usage + description: Configuration controlling usage of a service. + properties: + requirements: description: >- Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example @@ -3733,10 +3739,10 @@ components: Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs. + type: array items: type: string producerNotificationChannel: - type: string description: >- The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only @@ -3745,101 +3751,89 @@ components: this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview. - description: Configuration controlling usage of a service. - Empty: - properties: {} - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: Empty - Endpoint: - type: object - id: Endpoint - description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true - properties: - aliases: - description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. + type: string + rules: items: - type: string + $ref: '#/components/schemas/UsageRule' + description: >- + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. type: array - allowCors: + GoogleApiServiceusageV1Service: + id: GoogleApiServiceusageV1Service + properties: + config: + $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - type: boolean + The service configuration of the available service. Some fields may + be filtered out of the configuration in responses to the + `ListServices` method. These fields are present only in responses to + the `GetService` method. name: + description: >- + The resource name of the consumer and service. A valid name would + be: - projects/123/services/serviceusage.googleapis.com type: string - description: The canonical name of this endpoint. - target: + parent: type: string description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". - OAuthRequirements: + The resource name of the consumer. A valid name would be: - + projects/123 + state: + enum: + - STATE_UNSPECIFIED + - DISABLED + - ENABLED + type: string + enumDescriptions: + - >- + The default value, which indicates that the enabled state of the + service is unspecified or not meaningful. Currently, all consumers + other than projects (such as folders and organizations) are always + in this state. + - >- + The service cannot be used by this consumer. It has either been + explicitly disabled, or has never been enabled. + - The service has been explicitly enabled for use by this consumer. + description: Whether or not the service has been enabled for use by the consumer. + type: object + description: A service that is available for use by the consumer. + MonitoringDestination: + type: object + id: MonitoringDestination properties: - canonicalScopes: + metrics: description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + items: + type: string + type: array + monitoredResource: type: string + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. - id: OAuthRequirements + Configuration of a specific monitoring destination (the producer project + or the consumer project). + EnableFailure: + description: Provides error messages for the failing services. + properties: + errorMessage: + type: string + description: An error message describing why the service could not be enabled. + serviceId: + type: string + description: The service id of a service that could not be enabled. + id: EnableFailure type: object parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + name: oauth_token schema: type: string access_token: @@ -3848,21 +3842,18 @@ components: name: access_token schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string callback: description: JSONP in: query @@ -3879,16 +3870,10 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string quotaUser: @@ -3900,6 +3885,21 @@ components: name: quotaUser schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -3915,9 +3915,9 @@ components: name: operations title: Operations methods: - get: + cancel: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' response: mediaType: application/json openAPIDocKey: '200' @@ -3927,19 +3927,19 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: - $ref: '#/paths/~1v1~1operations/get' + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - cancel: + list: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' + $ref: '#/paths/~1v1~1operations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -3954,59 +3954,69 @@ components: name: services title: Services methods: - get: + batch_get: operation: - $ref: '#/paths/~1v1~1{name}/get' + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/get' response: mediaType: application/json openAPIDocKey: '200' - enable: + batch_enable: operation: - $ref: '#/paths/~1v1~1{name}/post' + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/post' response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/get' + $ref: '#/paths/~1v1~1{name}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.services - batch_enable: + enable: operation: - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/post' + $ref: '#/paths/~1v1~1{name}/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/list' + - $ref: '#/components/x-stackQL-resources/services/methods/batch_get' - $ref: '#/components/x-stackQL-resources/services/methods/get' insert: [] update: [] replace: [] delete: [] paths: - /v1/operations/{operationsId}: + /v1/operations/{operationsId}:cancel: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/key' - get: + post: 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. - operationId: serviceusage.operations.get + 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`. + operationId: serviceusage.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4022,13 +4032,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: operationsId required: true schema: type: string + /v1/operations/{operationsId}: + parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client @@ -4058,6 +4070,34 @@ paths: required: true schema: 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. + operationId: serviceusage.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string /v1/operations: parameters: *ref_1 get: @@ -4083,7 +4123,7 @@ paths: $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: query - name: name + name: filter schema: type: string - in: query @@ -4096,85 +4136,59 @@ paths: type: integer format: int32 - in: query - name: filter + name: name schema: type: string - /v1/operations/{operationsId}:cancel: + /v1/{parentType}/{parent}/services: parameters: *ref_1 - post: + get: 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`. - operationId: serviceusage.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' + Returns the service configurations and enabled states for a given list + of services. + operationId: serviceusage.services.batchGet security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/service.management + - https://www.googleapis.com/auth/cloud-platform.read-only Oauth2c: - - https://www.googleapis.com/auth/service.management + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/BatchGetServicesResponse' parameters: - in: path - name: operationsId + name: parentType required: true schema: type: string - /v1/{name}: - parameters: *ref_1 - get: - description: Returns the service configuration and enabled state for a given service. - operationId: serviceusage.services.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - parameters: - in: path - name: name + name: parent required: true schema: type: string + - in: query + name: names + schema: + type: string post: - description: Enable a service so that it can be used with a project. - operationId: serviceusage.services.enable + description: >- + Enable multiple services on a project. The operation is atomic: if + enabling any service fails, then the entire batch fails, and no state + changes occur. To enable a single service, use the `EnableService` + method instead. + operationId: serviceusage.services.batchEnable requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnableServiceRequest' + $ref: '#/components/schemas/BatchEnableServicesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4193,26 +4207,20 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: name + name: parentType required: true schema: type: string - /v1/{parentType}/{parent}/services: + - in: path + name: parent + required: true + schema: + type: string + /v1/{name}: parameters: *ref_1 get: - description: >- - List all services available to the specified project, and the current - state of those services with respect to the project. The list includes - all public services, all services for which the calling user has the - `servicemanagement.services.bind` permission, and all services that have - already been enabled on the project. The list can be filtered to only - include services in a specific state, for example to only include - services enabled on the project. WARNING: If you need to query enabled - services frequently or across an organization, you should use [Cloud - Asset Inventory - API](https://cloud.google.com/asset-inventory/docs/apis), which provides - higher throughput and richer filtering capability. - operationId: serviceusage.services.list + description: Returns the service configuration and enabled state for a given service. + operationId: serviceusage.services.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4228,43 +4236,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListServicesResponse' + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: name required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 post: - description: >- - Enable multiple services on a project. The operation is atomic: if - enabling any service fails, then the entire batch fails, and no state - changes occur. To enable a single service, use the `EnableService` - method instead. - operationId: serviceusage.services.batchEnable + description: Enable a service so that it can be used with a project. + operationId: serviceusage.services.enable requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchEnableServicesRequest' + $ref: '#/components/schemas/EnableServiceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4283,12 +4269,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: name required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml index bcb93859..6b0fc5fe 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml @@ -7,8 +7,8 @@ info: title: Solar API description: Solar API. version: v1 - x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240917' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/maps/documentation/solar servers: @@ -34,664 +34,419 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - BuildingInsights: - properties: - imageryDate: - description: Date that the underlying imagery was acquired. This is approximate. - $ref: '#/components/schemas/Date' - center: - $ref: '#/components/schemas/LatLng' - description: A point near the center of the building. - regionCode: - type: string - description: Region code for the country (or region) this building is in. - administrativeArea: - description: >- - Administrative area 1 (e.g., in the US, the state) that contains - this building. For example, in the US, the abbreviation might be - "MA" or "CA." - type: string - postalCode: - description: Postal code (e.g., US zip code) this building is contained by. - type: string - solarPotential: - $ref: '#/components/schemas/SolarPotential' - description: Solar potential of the building. - statisticalArea: - description: Statistical area (e.g., US census tract) this building is in. - type: string - imageryQuality: - description: >- - The quality of the imagery used to compute the data for this - building. - type: string - enumDescriptions: - - No quality is known. - - >- - Solar data is derived from aerial imagery captured at low-altitude - and processed at 0.1 m/pixel. - - >- - Solar data is derived from enhanced aerial imagery captured at - high-altitude and processed at 0.25 m/pixel. - - >- - Solar data is derived from enhanced satellite imagery processed at - 0.25 m/pixel. - - >- - Solar data is derived from enhanced satellite imagery processed at - 0.25 m/pixel. - enum: - - IMAGERY_QUALITY_UNSPECIFIED - - HIGH - - MEDIUM - - LOW - - BASE - boundingBox: - $ref: '#/components/schemas/LatLngBox' - description: The bounding box of the building. - imageryProcessedDate: - $ref: '#/components/schemas/Date' - description: When processing was completed on this imagery. - name: - type: string - description: The resource name for the building, of the format `building/`. + SolarPanelConfig: type: object - description: >- - Response message for `Solar.FindClosestBuildingInsights`. Information - about the location, dimensions, and solar potential of a building. - id: BuildingInsights - FinancedPurchaseSavings: properties: - savings: - $ref: '#/components/schemas/SavingsOverTime' - description: How much is saved (or not) over the lifetime period. - rebateValue: + panelsCount: + format: int32 description: >- - The value of all tax rebates (including Federal Investment Tax - Credit (ITC)). - $ref: '#/components/schemas/Money' - loanInterestRate: - description: The interest rate on loans assumed in this set of calculations. + Total number of panels. Note that this is redundant to (the sum of) + the corresponding fields in roof_segment_summaries. + type: integer + roofSegmentSummaries: + type: array + items: + $ref: '#/components/schemas/RoofSegmentSummary' + description: >- + Information about the production of each roof segment that is + carrying at least one panel in this layout. + `roof_segment_summaries[i]` describes the i-th roof segment, + including its size, expected production and orientation. + yearlyEnergyDcKwh: format: float type: number - annualLoanPayment: - $ref: '#/components/schemas/Money' - description: Annual loan payments. - type: object + description: >- + How much sunlight energy this layout captures over the course of a + year, in DC kWh, assuming the panels described above. description: >- - Cost and benefit of using a loan to buy a particular configuration of - solar panels with a particular electricity usage. - id: FinancedPurchaseSavings - RoofSegmentSizeAndSunshineStats: + SolarPanelConfig describes a particular placement of solar panels on the + roof. + id: SolarPanelConfig + SavingsOverTime: + id: SavingsOverTime properties: - azimuthDegrees: - format: float - type: number + financiallyViable: + type: boolean description: >- - Compass direction the roof segment is pointing in. 0 = North, 90 = - East, 180 = South. For a "flat" roof segment (`pitch_degrees` very - near 0), azimuth is not well defined, so for consistency, we define - it arbitrarily to be 0 (North). - center: - $ref: '#/components/schemas/LatLng' - description: A point near the center of the roof segment. - boundingBox: - $ref: '#/components/schemas/LatLngBox' - description: The bounding box of the roof segment. - pitchDegrees: - format: float + Indicates whether this scenario is financially viable. Will be false + for scenarios with poor financial viability (e.g., money-losing). + savingsYear1: + $ref: '#/components/schemas/Money' + description: Savings in the first year after panel installation. + savingsYear20: + description: Savings in the first twenty years after panel installation. + $ref: '#/components/schemas/Money' + presentValueOfSavingsYear20: description: >- - Angle of the roof segment relative to the theoretical ground plane. - 0 = parallel to the ground, 90 = perpendicular to the ground. - type: number - planeHeightAtCenterMeters: + Using the assumed discount rate, what is the present value of the + cumulative 20-year savings? + $ref: '#/components/schemas/Money' + savingsLifetime: + description: Savings in the entire panel lifetime. + $ref: '#/components/schemas/Money' + presentValueOfSavingsLifetime: description: >- - The height of the roof segment plane, in meters above sea level, at - the point designated by `center`. Together with the pitch, azimuth, - and center location, this fully defines the roof segment plane. - format: float - type: number - stats: - $ref: '#/components/schemas/SizeAndSunshineStats' - description: Total size and sunlight quantiles for the roof segment. - description: Information about the size and sunniness quantiles of a roof segment. - id: RoofSegmentSizeAndSunshineStats + Using the assumed discount rate, what is the present value of the + cumulative lifetime savings? + $ref: '#/components/schemas/Money' + description: Financial information that's shared between different financing methods. type: object - FinancialAnalysis: + Date: + type: object + id: Date + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp properties: - leasingSavings: - description: Cost and benefit of leasing the solar panels. - $ref: '#/components/schemas/LeasingSavings' - averageKwhPerMonth: - format: float + day: + type: integer description: >- - How much electricity the house uses in an average month, based on - the bill size and the local electricity rates. - type: number - panelConfigIndex: + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. format: int32 + year: description: >- - Index in solar_panel_configs of the optimum solar layout for this - bill size. This can be -1 indicating that there is no layout. In - this case, the remaining submessages will be omitted. + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. type: integer - cashPurchaseSavings: - description: Cost and benefit of buying the solar panels with cash. - $ref: '#/components/schemas/CashPurchaseSavings' - financedPurchaseSavings: - $ref: '#/components/schemas/FinancedPurchaseSavings' + format: int32 + month: + type: integer + format: int32 description: >- - Cost and benefit of buying the solar panels by financing the - purchase. - monthlyBill: - description: The monthly electric bill this analysis assumes. + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + CashPurchaseSavings: + description: >- + Cost and benefit of an outright purchase of a particular configuration + of solar panels with a particular electricity usage. + type: object + properties: + outOfPocketCost: $ref: '#/components/schemas/Money' - financialDetails: - $ref: '#/components/schemas/FinancialDetails' description: >- - Financial information that applies regardless of the financing - method used. - defaultBill: + Initial cost before tax incentives: the amount that must be paid + out-of-pocket. Contrast with `upfront_cost`, which is after tax + incentives. + rebateValue: + $ref: '#/components/schemas/Money' + description: The value of all tax rebates. + savings: + description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/SavingsOverTime' + upfrontCost: description: >- - Whether this is the bill size selected to be the default bill for - the area this building is in. Exactly one `FinancialAnalysis` in - `BuildingSolarPotential` should have `default_bill` set. - type: boolean - description: >- - Analysis of the cost and benefits of the optimum solar layout for a - particular electric bill size. - id: FinancialAnalysis - type: object - DataLayers: + Initial cost after tax incentives: it's the amount that must be paid + during first year. Contrast with `out_of_pocket_cost`, which is + before tax incentives. + $ref: '#/components/schemas/Money' + paybackYears: + type: number + format: float + description: >- + Number of years until payback occurs. A negative value means payback + never occurs within the lifetime period. + id: CashPurchaseSavings + SolarPanel: type: object properties: - dsmUrl: - type: string + segmentIndex: description: >- - The URL for an image of the DSM (Digital Surface Model) of the - region. Values are in meters above EGM96 geoid (i.e., sea level). - Invalid locations (where we don't have data) are stored as -9999. - imageryProcessedDate: - $ref: '#/components/schemas/Date' - description: When processing was completed on this imagery. - maskUrl: - type: string - description: >- - The URL for the building mask image: one bit per pixel saying - whether that pixel is considered to be part of a rooftop or not. - rgbUrl: - type: string - description: The URL for an image of RGB data (aerial photo) of the region. - imageryQuality: + Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` + which corresponds to the roof segment that this panel is placed on. + format: int32 + type: integer + orientation: enumDescriptions: - - No quality is known. - - >- - Solar data is derived from aerial imagery captured at low-altitude - and processed at 0.1 m/pixel. - - >- - Solar data is derived from enhanced aerial imagery captured at - high-altitude and processed at 0.25 m/pixel. + - No panel orientation is known. - >- - Solar data is derived from enhanced satellite imagery processed at - 0.25 m/pixel. + A `LANDSCAPE` panel has its long edge perpendicular to the azimuth + direction of the roof segment that it is placed on. - >- - Solar data is derived from enhanced satellite imagery processed at - 0.25 m/pixel. - description: The quality of the result's imagery. + A `PORTRAIT` panel has its long edge parallel to the azimuth + direction of the roof segment that it is placed on. type: string + description: The orientation of the panel. enum: - - IMAGERY_QUALITY_UNSPECIFIED - - HIGH - - MEDIUM - - LOW - - BASE - annualFluxUrl: - description: >- - The URL for the annual flux map (annual sunlight on roofs) of the - region. Values are kWh/kW/year. This is *unmasked flux*: flux is - computed for every location, not just building rooftops. Invalid - locations are stored as -9999: locations outside our coverage area - will be invalid, and a few locations inside the coverage area, where - we were unable to calculate flux, will also be invalid. - type: string - imageryDate: - $ref: '#/components/schemas/Date' - description: >- - When the source imagery (from which all the other data are derived) - in this region was taken. It is necessarily somewhat approximate, as - the images may have been taken over more than one day. - hourlyShadeUrls: - items: - type: string - description: >- - Twelve URLs for hourly shade, corresponding to January...December, - in order. Each GeoTIFF will contain 24 bands, corresponding to the - 24 hours of the day. Each pixel is a 32 bit integer, corresponding - to the (up to) 31 days of that month; a 1 bit means that the - corresponding location is able to see the sun at that day, of that - hour, of that month. Invalid locations are stored as -9999 (since - this is negative, it has bit 31 set, and no valid value could have - bit 31 set as that would correspond to the 32nd day of the month). - An example may be useful. If you want to know whether a point (at - pixel location (x, y)) saw sun at 4pm on the 22nd of June you would: - 1. fetch the sixth URL in this list (corresponding to June). 1. look - up the 17th channel (corresponding to 4pm). 1. read the 32-bit value - at (x, y). 1. read bit 21 of the value (corresponding to the 22nd of - the month). 1. if that bit is a 1, then that spot saw the sun at 4pm - 22 June. More formally: Given `month` (1-12), `day` (1...month max; - February has 28 days) and `hour` (0-23), the shade/sun for that - month/day/hour at a position `(x, y)` is the bit ``` - (hourly_shade[month - 1])(x, y)[hour] & (1 << (day - 1)) ``` where - `(x, y)` is spatial indexing, `[month - 1]` refers to fetching the - `month - 1`st URL (indexing from zero), `[hour]` is indexing into - the channels, and a final non-zero result means "sunny". There are - no leap days, and DST doesn't exist (all days are 24 hours long; - noon is always "standard time" noon). - type: array - monthlyFluxUrl: - type: string + - SOLAR_PANEL_ORIENTATION_UNSPECIFIED + - LANDSCAPE + - PORTRAIT + center: + $ref: '#/components/schemas/LatLng' + description: The centre of the panel. + yearlyEnergyDcKwh: + type: number + format: float description: >- - The URL for the monthly flux map (sunlight on roofs, broken down by - month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to - by this URL will contain twelve bands, corresponding to - January...December, in order. + How much sunlight energy this layout captures over the course of a + year, in DC kWh. description: >- - Information about the solar potential of a region. The actual data are - contained in a number of GeoTIFF files covering the requested region, - for which this message contains URLs: Each string in the `DataLayers` - message contains a URL from which the corresponding GeoTIFF can be - fetched. These URLs are valid for a few hours after they've been - generated. Most of the GeoTIFF files are at a resolution of 0.1m/pixel, - but the monthly flux file is at 0.5m/pixel, and the hourly shade files - are at 1m/pixel. If a `pixel_size_meters` value was specified in the - `GetDataLayersRequest`, then the minimum resolution in the GeoTIFF files - will be that value. - id: DataLayers - SolarPotential: + SolarPanel describes the position, orientation, and production of a + single solar panel. See the panel_height_meters, panel_width_meters, and + panel_capacity_watts fields in SolarPotential for information on the + parameters of the panel. + id: SolarPanel + FinancialDetails: description: >- - Information about the solar potential of a building. A number of fields - in this are defined in terms of "panels". The fields - panel_capacity_watts, panel_height_meters, and panel_width_meters - describe the parameters of the model of panel used in these - calculations. - id: SolarPotential + Details of a financial analysis. Some of these details are already + stored at higher levels (e.g., out of pocket cost). Total money amounts + are over a lifetime period defined by the panel_lifetime_years field in + SolarPotential. Note: The out of pocket cost of purchasing the panels is + given in the out_of_pocket_cost field in CashPurchaseSavings. type: object + id: FinancialDetails properties: - carbonOffsetFactorKgPerMwh: + percentageExportedToGrid: + format: float description: >- - Equivalent amount of CO2 produced per MWh of grid electricity. This - is a measure of the carbon intensity of grid electricity displaced - by solar electricity. + The percentage (0-100) of solar electricity production we assumed + was exported to the grid, based on the first quarter of production. + This affects the calculations if net metering is not allowed. + type: number + initialAcKwhPerYear: format: float type: number - buildingStats: description: >- - Size and sunlight quantiles for the entire building, including parts - of the roof that were not assigned to some roof segment. Because the - orientations of these parts are not well characterised, the roof - area estimate is unreliable, but the ground area estimate is - reliable. It may be that a more reliable whole building roof area - can be obtained by scaling the roof area from whole_roof_stats by - the ratio of the ground areas of `building_stats` and - `whole_roof_stats`. - $ref: '#/components/schemas/SizeAndSunshineStats' - roofSegmentStats: - items: - $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' - type: array - description: Size and sunlight quantiles for each roof segment. - maxArrayPanelsCount: - type: integer - format: int32 + How many AC kWh we think the solar panels will generate in their + first year. + utilityIncentive: + $ref: '#/components/schemas/Money' description: >- - Size of the maximum array - that is, the maximum number of panels - that can fit on the roof. - panelHeightMeters: - format: float + Amount of money available from utility incentives; this applies if + the user buys (with or without a loan) the panels. + costOfElectricityWithoutSolar: + $ref: '#/components/schemas/Money' description: >- - Height, in meters in portrait orientation, of the panel used in the - calculations. - type: number - wholeRoofStats: - $ref: '#/components/schemas/SizeAndSunshineStats' + Total cost of electricity the user would have paid over the lifetime + period if they didn't install solar. + federalIncentive: + $ref: '#/components/schemas/Money' description: >- - Total size and sunlight quantiles for the part of the roof that was - assigned to some roof segment. Despite the name, this may not - include the entire building. See building_stats. - maxArrayAreaMeters2: - description: Size, in square meters, of the maximum array. + Amount of money available from federal incentives; this applies if + the user buys (with or without a loan) the panels. + lifetimeSrecTotal: + $ref: '#/components/schemas/Money' + description: >- + Amount of money the user will receive from Solar Renewable Energy + Credits over the panel lifetime; this applies if the user buys (with + or without a loan) the panels. + solarPercentage: + description: >- + Percentage (0-100) of the user's power supplied by solar. Valid for + the first year but approximately correct for future years. type: number format: float - solarPanelConfigs: + stateIncentive: + $ref: '#/components/schemas/Money' description: >- - Each SolarPanelConfig describes a different arrangement of solar - panels on the roof. They are in order of increasing number of - panels. The `SolarPanelConfig` with panels_count=N is based on the - first N panels in the `solar_panels` list. This field is only - populated if at least 4 panels can fit on a roof. - type: array - items: - $ref: '#/components/schemas/SolarPanelConfig' - panelCapacityWatts: - format: float - type: number - description: Capacity, in watts, of the panel used in the calculations. - solarPanels: + Amount of money available from state incentives; this applies if the + user buys (with or without a loan) the panels. + remainingLifetimeUtilityBill: + $ref: '#/components/schemas/Money' + description: >- + Utility bill for electricity not produced by solar, for the lifetime + of the panels. + netMeteringAllowed: + description: Whether net metering is allowed. + type: boolean + SizeAndSunshineStats: + id: SizeAndSunshineStats + description: Size and sunniness quantiles of a roof, or part of a roof. + type: object + properties: + sunshineQuantiles: type: array description: >- - Each SolarPanel describes a single solar panel. They are listed in - the order that the panel layout algorithm placed this. This is - usually, though not always, in decreasing order of annual energy - production. + Quantiles of the pointwise sunniness across the area. If there are N + values here, this represents the (N-1)-iles. For example, if there + are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, + max). Values are in annual kWh/kW like max_sunshine_hours_per_year. items: - $ref: '#/components/schemas/SolarPanel' - maxSunshineHoursPerYear: + type: number + format: float + groundAreaMeters2: + description: >- + The ground footprint area covered by the roof or roof segment, in + m^2. + type: number + format: float + areaMeters2: format: float type: number description: >- - Maximum number of sunshine hours received per year, by any point on - the roof. Sunshine hours are a measure of the total amount of - insolation (energy) received per year. 1 sunshine hour = 1 kWh per - kW (where kW refers to kW of capacity under Standard Testing - Conditions). - panelLifetimeYears: - type: integer - description: >- - The expected lifetime, in years, of the solar panels. This is used - in the financial calculations. - format: int32 - panelWidthMeters: - type: number + The area of the roof or roof segment, in m^2. This is the roof area + (accounting for tilt), not the ground footprint area. + LeasingSavings: + properties: + leasesSupported: + type: boolean description: >- - Width, in meters in portrait orientation, of the panel used in the - calculations. - format: float - financialAnalyses: - items: - $ref: '#/components/schemas/FinancialAnalysis' + Whether leases are supported in this juristiction by the financial + calculation engine. If this field is false, then the values in this + message should probably be ignored. This is independent of + `leases_allowed`: in some areas leases are allowed, but under + conditions that aren't handled by the financial models. + annualLeasingCost: + description: Estimated annual leasing cost. + $ref: '#/components/schemas/Money' + leasesAllowed: + type: boolean description: >- - A FinancialAnalysis gives the savings from going solar assuming a - given monthly bill and a given electricity provider. They are in - order of increasing order of monthly bill amount. This field will be - empty for buildings in areas for which the Solar API does not have - enough information to perform financial computations. - type: array - RoofSegmentSummary: - id: RoofSegmentSummary - type: object + Whether leases are allowed in this juristiction (leases are not + allowed in some states). If this field is false, then the values in + this message should probably be ignored. + savings: + $ref: '#/components/schemas/SavingsOverTime' + description: How much is saved (or not) over the lifetime period. + id: LeasingSavings description: >- - Information about a roof segment on the building, with some number of - panels placed on it. + Cost and benefit of leasing a particular configuration of solar panels + with a particular electricity usage. + type: object + RoofSegmentSummary: properties: - pitchDegrees: - description: >- - Angle of the roof segment relative to the theoretical ground plane. - 0 = parallel to the ground, 90 = perpendicular to the ground. - type: number - format: float - segmentIndex: - format: int32 - description: >- - Index in roof_segment_stats of the corresponding - `RoofSegmentSizeAndSunshineStats`. + panelsCount: type: integer + format: int32 + description: The total number of panels on this segment. azimuthDegrees: format: float - type: number description: >- Compass direction the roof segment is pointing in. 0 = North, 90 = East, 180 = South. For a "flat" roof segment (`pitch_degrees` very near 0), azimuth is not well defined, so for consistency, we define it arbitrarily to be 0 (North). - panelsCount: - format: int32 - type: integer - description: The total number of panels on this segment. + type: number yearlyEnergyDcKwh: format: float type: number description: >- How much sunlight energy this part of the layout captures over the course of a year, in DC kWh, assuming the panels described above. - FinancialDetails: - properties: - percentageExportedToGrid: - description: >- - The percentage (0-100) of solar electricity production we assumed - was exported to the grid, based on the first quarter of production. - This affects the calculations if net metering is not allowed. - format: float - type: number - solarPercentage: + segmentIndex: + type: integer + format: int32 description: >- - Percentage (0-100) of the user's power supplied by solar. Valid for - the first year but approximately correct for future years. + Index in roof_segment_stats of the corresponding + `RoofSegmentSizeAndSunshineStats`. + pitchDegrees: format: float type: number - costOfElectricityWithoutSolar: - description: >- - Total cost of electricity the user would have paid over the lifetime - period if they didn't install solar. - $ref: '#/components/schemas/Money' - federalIncentive: - $ref: '#/components/schemas/Money' - description: >- - Amount of money available from federal incentives; this applies if - the user buys (with or without a loan) the panels. - utilityIncentive: - $ref: '#/components/schemas/Money' - description: >- - Amount of money available from utility incentives; this applies if - the user buys (with or without a loan) the panels. - remainingLifetimeUtilityBill: - $ref: '#/components/schemas/Money' - description: >- - Utility bill for electricity not produced by solar, for the lifetime - of the panels. - initialAcKwhPerYear: - type: number - description: >- - How many AC kWh we think the solar panels will generate in their - first year. - format: float - netMeteringAllowed: - description: Whether net metering is allowed. - type: boolean - lifetimeSrecTotal: - description: >- - Amount of money the user will receive from Solar Renewable Energy - Credits over the panel lifetime; this applies if the user buys (with - or without a loan) the panels. - $ref: '#/components/schemas/Money' - stateIncentive: description: >- - Amount of money available from state incentives; this applies if the - user buys (with or without a loan) the panels. - $ref: '#/components/schemas/Money' - description: >- - Details of a financial analysis. Some of these details are already - stored at higher levels (e.g., out of pocket cost). Total money amounts - are over a lifetime period defined by the panel_lifetime_years field in - SolarPotential. Note: The out of pocket cost of purchasing the panels is - given in the out_of_pocket_cost field in CashPurchaseSavings. - id: FinancialDetails - type: object - LeasingSavings: + Angle of the roof segment relative to the theoretical ground plane. + 0 = parallel to the ground, 90 = perpendicular to the ground. type: object + id: RoofSegmentSummary + description: >- + Information about a roof segment on the building, with some number of + panels placed on it. + BuildingInsights: properties: - annualLeasingCost: - $ref: '#/components/schemas/Money' - description: Estimated annual leasing cost. - savings: - $ref: '#/components/schemas/SavingsOverTime' - description: How much is saved (or not) over the lifetime period. - leasesSupported: - type: boolean + postalCode: + type: string + description: Postal code (e.g., US zip code) this building is contained by. + administrativeArea: description: >- - Whether leases are supported in this juristiction by the financial - calculation engine. If this field is false, then the values in this - message should probably be ignored. This is independent of - `leases_allowed`: in some areas leases are allowed, but under - conditions that aren't handled by the financial models. - leasesAllowed: - type: boolean + Administrative area 1 (e.g., in the US, the state) that contains + this building. For example, in the US, the abbreviation might be + "MA" or "CA." + type: string + regionCode: + type: string + description: Region code for the country (or region) this building is in. + boundingBox: + $ref: '#/components/schemas/LatLngBox' + description: The bounding box of the building. + imageryQuality: description: >- - Whether leases are allowed in this juristiction (leases are not - allowed in some states). If this field is false, then the values in - this message should probably be ignored. - description: >- - Cost and benefit of leasing a particular configuration of solar panels - with a particular electricity usage. - id: LeasingSavings - SolarPanel: - description: >- - SolarPanel describes the position, orientation, and production of a - single solar panel. See the panel_height_meters, panel_width_meters, and - panel_capacity_watts fields in SolarPotential for information on the - parameters of the panel. - properties: - orientation: - description: The orientation of the panel. + The quality of the imagery used to compute the data for this + building. + type: string + enum: + - IMAGERY_QUALITY_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + - BASE enumDescriptions: - - No panel orientation is known. + - No quality is known. - >- - A `LANDSCAPE` panel has its long edge perpendicular to the azimuth - direction of the roof segment that it is placed on. + Solar data is derived from aerial imagery captured at low-altitude + and processed at 0.1 m/pixel. - >- - A `PORTRAIT` panel has its long edge parallel to the azimuth - direction of the roof segment that it is placed on. + Solar data is derived from enhanced aerial imagery captured at + high-altitude and processed at 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + statisticalArea: type: string - enum: - - SOLAR_PANEL_ORIENTATION_UNSPECIFIED - - LANDSCAPE - - PORTRAIT - yearlyEnergyDcKwh: - type: number - format: float - description: >- - How much sunlight energy this layout captures over the course of a - year, in DC kWh. - segmentIndex: - format: int32 - description: >- - Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` - which corresponds to the roof segment that this panel is placed on. - type: integer + description: Statistical area (e.g., US census tract) this building is in. center: $ref: '#/components/schemas/LatLng' - description: The centre of the panel. + description: A point near the center of the building. + solarPotential: + $ref: '#/components/schemas/SolarPotential' + description: Solar potential of the building. + imageryDate: + $ref: '#/components/schemas/Date' + description: Date that the underlying imagery was acquired. This is approximate. + name: + type: string + description: The resource name for the building, of the format `building/`. + imageryProcessedDate: + description: When processing was completed on this imagery. + $ref: '#/components/schemas/Date' + description: >- + Response message for `Solar.FindClosestBuildingInsights`. Information + about the location, dimensions, and solar potential of a building. type: object - id: SolarPanel - Date: + id: BuildingInsights + LatLngBox: + id: LatLngBox + description: A bounding box in lat/lng coordinates. properties: - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - format: int32 - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - format: int32 - year: - format: int32 - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - id: Date - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - type: object - SizeAndSunshineStats: - properties: - sunshineQuantiles: - items: - type: number - format: float - description: >- - Quantiles of the pointwise sunniness across the area. If there are N - values here, this represents the (N-1)-iles. For example, if there - are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, - max). Values are in annual kWh/kW like max_sunshine_hours_per_year. - type: array - areaMeters2: - type: number - description: >- - The area of the roof or roof segment, in m^2. This is the roof area - (accounting for tilt), not the ground footprint area. - format: float - groundAreaMeters2: - description: >- - The ground footprint area covered by the roof or roof segment, in - m^2. - type: number - format: float - type: object - id: SizeAndSunshineStats - description: Size and sunniness quantiles of a roof, or part of a roof. - LatLngBox: - properties: - sw: - $ref: '#/components/schemas/LatLng' - description: The southwest corner of the box. ne: + $ref: '#/components/schemas/LatLng' description: The northeast corner of the box. + sw: + description: The southwest corner of the box. $ref: '#/components/schemas/LatLng' - description: A bounding box in lat/lng coordinates. type: object - id: LatLngBox - LatLng: - id: LatLng - properties: - latitude: - format: double - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - type: number - longitude: - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - format: double - type: number - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - type: object - HttpBody: - id: HttpBody + FinancedPurchaseSavings: + id: FinancedPurchaseSavings type: object + description: >- + Cost and benefit of using a loan to buy a particular configuration of + solar panels with a particular electricity usage. properties: - data: - type: string - description: The HTTP request/response body as raw binary. - format: byte - extensions: - type: array - description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - contentType: - type: string + loanInterestRate: + description: The interest rate on loans assumed in this set of calculations. + type: number + format: float + annualLoanPayment: + $ref: '#/components/schemas/Money' + description: Annual loan payments. + savings: + $ref: '#/components/schemas/SavingsOverTime' + description: How much is saved (or not) over the lifetime period. + rebateValue: + $ref: '#/components/schemas/Money' description: >- - The HTTP Content-Type header value specifying the content type of - the body. + The value of all tax rebates (including Federal Investment Tax + Credit (ITC)). + HttpBody: description: >- Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw @@ -711,44 +466,50 @@ components: returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. - SolarPanelConfig: - id: SolarPanelConfig properties: - panelsCount: + contentType: description: >- - Total number of panels. Note that this is redundant to (the sum of) - the corresponding fields in roof_segment_summaries. - type: integer - format: int32 - roofSegmentSummaries: - items: - $ref: '#/components/schemas/RoofSegmentSummary' + The HTTP Content-Type header value specifying the content type of + the body. + type: string + extensions: type: array description: >- - Information about the production of each roof segment that is - carrying at least one panel in this layout. - `roof_segment_summaries[i]` describes the i-th roof segment, - including its size, expected production and orientation. - yearlyEnergyDcKwh: + Application specific response metadata. Must be set in the first + response for streaming APIs. + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + data: + format: byte + type: string + description: The HTTP request/response body as raw binary. + type: object + id: HttpBody + LatLng: + properties: + longitude: + type: number + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + format: double + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + format: double type: number - format: float - description: >- - How much sunlight energy this layout captures over the course of a - year, in DC kWh, assuming the panels described above. - description: >- - SolarPanelConfig describes a particular placement of solar panels on the - roof. type: object + id: LatLng + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. Money: + type: object + id: Money properties: - units: - format: int64 - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string nanos: - format: int32 description: >- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is @@ -757,72 +518,311 @@ components: `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. type: integer + format: int32 currencyCode: description: The three-letter currency code defined in ISO 4217. type: string - type: object - id: Money + units: + format: int64 + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string description: Represents an amount of money with its currency type. - CashPurchaseSavings: - description: >- - Cost and benefit of an outright purchase of a particular configuration - of solar panels with a particular electricity usage. + RoofSegmentSizeAndSunshineStats: + description: Information about the size and sunniness quantiles of a roof segment. type: object - id: CashPurchaseSavings properties: - rebateValue: - $ref: '#/components/schemas/Money' - description: The value of all tax rebates. - upfrontCost: - $ref: '#/components/schemas/Money' + center: + $ref: '#/components/schemas/LatLng' + description: A point near the center of the roof segment. + planeHeightAtCenterMeters: + format: float description: >- - Initial cost after tax incentives: it's the amount that must be paid - during first year. Contrast with `out_of_pocket_cost`, which is - before tax incentives. - paybackYears: + The height of the roof segment plane, in meters above sea level, at + the point designated by `center`. Together with the pitch, azimuth, + and center location, this fully defines the roof segment plane. + type: number + stats: + description: Total size and sunlight quantiles for the roof segment. + $ref: '#/components/schemas/SizeAndSunshineStats' + azimuthDegrees: + type: number + format: float description: >- - Number of years until payback occurs. A negative value means payback - never occurs within the lifetime period. + Compass direction the roof segment is pointing in. 0 = North, 90 = + East, 180 = South. For a "flat" roof segment (`pitch_degrees` very + near 0), azimuth is not well defined, so for consistency, we define + it arbitrarily to be 0 (North). + pitchDegrees: + description: >- + Angle of the roof segment relative to the theoretical ground plane. + 0 = parallel to the ground, 90 = perpendicular to the ground. type: number format: float - savings: - description: How much is saved (or not) over the lifetime period. - $ref: '#/components/schemas/SavingsOverTime' - outOfPocketCost: - $ref: '#/components/schemas/Money' + boundingBox: + description: The bounding box of the roof segment. + $ref: '#/components/schemas/LatLngBox' + id: RoofSegmentSizeAndSunshineStats + DataLayers: + id: DataLayers + description: >- + Information about the solar potential of a region. The actual data are + contained in a number of GeoTIFF files covering the requested region, + for which this message contains URLs: Each string in the `DataLayers` + message contains a URL from which the corresponding GeoTIFF can be + fetched. These URLs are valid for a few hours after they've been + generated. Most of the GeoTIFF files are at a resolution of 0.1m/pixel, + but the monthly flux file is at 0.5m/pixel, and the hourly shade files + are at 1m/pixel. If a `pixel_size_meters` value was specified in the + `GetDataLayersRequest`, then the minimum resolution in the GeoTIFF files + will be that value. + type: object + properties: + imageryQuality: + enumDescriptions: + - No quality is known. + - >- + Solar data is derived from aerial imagery captured at low-altitude + and processed at 0.1 m/pixel. + - >- + Solar data is derived from enhanced aerial imagery captured at + high-altitude and processed at 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + description: The quality of the result's imagery. + type: string + enum: + - IMAGERY_QUALITY_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + - BASE + maskUrl: + type: string description: >- - Initial cost before tax incentives: the amount that must be paid - out-of-pocket. Contrast with `upfront_cost`, which is after tax - incentives. - SavingsOverTime: + The URL for the building mask image: one bit per pixel saying + whether that pixel is considered to be part of a rooftop or not. + imageryDate: + $ref: '#/components/schemas/Date' + description: >- + When the source imagery (from which all the other data are derived) + in this region was taken. It is necessarily somewhat approximate, as + the images may have been taken over more than one day. + dsmUrl: + description: >- + The URL for an image of the DSM (Digital Surface Model) of the + region. Values are in meters above EGM96 geoid (i.e., sea level). + Invalid locations (where we don't have data) are stored as -9999. + type: string + annualFluxUrl: + type: string + description: >- + The URL for the annual flux map (annual sunlight on roofs) of the + region. Values are kWh/kW/year. This is *unmasked flux*: flux is + computed for every location, not just building rooftops. Invalid + locations are stored as -9999: locations outside our coverage area + will be invalid, and a few locations inside the coverage area, where + we were unable to calculate flux, will also be invalid. + monthlyFluxUrl: + description: >- + The URL for the monthly flux map (sunlight on roofs, broken down by + month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to + by this URL will contain twelve bands, corresponding to + January...December, in order. + type: string + rgbUrl: + type: string + description: The URL for an image of RGB data (aerial photo) of the region. + imageryProcessedDate: + $ref: '#/components/schemas/Date' + description: When processing was completed on this imagery. + hourlyShadeUrls: + type: array + description: >- + Twelve URLs for hourly shade, corresponding to January...December, + in order. Each GeoTIFF will contain 24 bands, corresponding to the + 24 hours of the day. Each pixel is a 32 bit integer, corresponding + to the (up to) 31 days of that month; a 1 bit means that the + corresponding location is able to see the sun at that day, of that + hour, of that month. Invalid locations are stored as -9999 (since + this is negative, it has bit 31 set, and no valid value could have + bit 31 set as that would correspond to the 32nd day of the month). + An example may be useful. If you want to know whether a point (at + pixel location (x, y)) saw sun at 4pm on the 22nd of June you would: + 1. fetch the sixth URL in this list (corresponding to June). 1. look + up the 17th channel (corresponding to 4pm). 1. read the 32-bit value + at (x, y). 1. read bit 21 of the value (corresponding to the 22nd of + the month). 1. if that bit is a 1, then that spot saw the sun at 4pm + 22 June. More formally: Given `month` (1-12), `day` (1...month max; + February has 28 days) and `hour` (0-23), the shade/sun for that + month/day/hour at a position `(x, y)` is the bit ``` + (hourly_shade[month - 1])(x, y)[hour] & (1 << (day - 1)) ``` where + `(x, y)` is spatial indexing, `[month - 1]` refers to fetching the + `month - 1`st URL (indexing from zero), `[hour]` is indexing into + the channels, and a final non-zero result means "sunny". There are + no leap days, and DST doesn't exist (all days are 24 hours long; + noon is always "standard time" noon). + items: + type: string + FinancialAnalysis: + description: >- + Analysis of the cost and benefits of the optimum solar layout for a + particular electric bill size. type: object + id: FinancialAnalysis properties: - savingsYear20: - $ref: '#/components/schemas/Money' - description: Savings in the first twenty years after panel installation. - savingsYear1: - $ref: '#/components/schemas/Money' - description: Savings in the first year after panel installation. - presentValueOfSavingsYear20: - $ref: '#/components/schemas/Money' + panelConfigIndex: + format: int32 description: >- - Using the assumed discount rate, what is the present value of the - cumulative 20-year savings? - presentValueOfSavingsLifetime: + Index in solar_panel_configs of the optimum solar layout for this + bill size. This can be -1 indicating that there is no layout. In + this case, the remaining submessages will be omitted. + type: integer + financedPurchaseSavings: + description: >- + Cost and benefit of buying the solar panels by financing the + purchase. + $ref: '#/components/schemas/FinancedPurchaseSavings' + monthlyBill: $ref: '#/components/schemas/Money' + description: The monthly electric bill this analysis assumes. + leasingSavings: + $ref: '#/components/schemas/LeasingSavings' + description: Cost and benefit of leasing the solar panels. + financialDetails: + $ref: '#/components/schemas/FinancialDetails' + description: >- + Financial information that applies regardless of the financing + method used. + cashPurchaseSavings: + description: Cost and benefit of buying the solar panels with cash. + $ref: '#/components/schemas/CashPurchaseSavings' + averageKwhPerMonth: + format: float + type: number + description: >- + How much electricity the house uses in an average month, based on + the bill size and the local electricity rates. + defaultBill: + type: boolean + description: >- + Whether this is the bill size selected to be the default bill for + the area this building is in. Exactly one `FinancialAnalysis` in + `BuildingSolarPotential` should have `default_bill` set. + SolarPotential: + description: >- + Information about the solar potential of a building. A number of fields + in this are defined in terms of "panels". The fields + panel_capacity_watts, panel_height_meters, and panel_width_meters + describe the parameters of the model of panel used in these + calculations. + properties: + maxSunshineHoursPerYear: + description: >- + Maximum number of sunshine hours received per year, by any point on + the roof. Sunshine hours are a measure of the total amount of + insolation (energy) received per year. 1 sunshine hour = 1 kWh per + kW (where kW refers to kW of capacity under Standard Testing + Conditions). + format: float + type: number + wholeRoofStats: + $ref: '#/components/schemas/SizeAndSunshineStats' + description: >- + Total size and sunlight quantiles for the part of the roof that was + assigned to some roof segment. Despite the name, this may not + include the entire building. See building_stats. + maxArrayPanelsCount: + description: >- + Size of the maximum array - that is, the maximum number of panels + that can fit on the roof. + format: int32 + type: integer + panelHeightMeters: + format: float + type: number + description: >- + Height, in meters in portrait orientation, of the panel used in the + calculations. + buildingStats: + description: >- + Size and sunlight quantiles for the entire building, including parts + of the roof that were not assigned to some roof segment. Because the + orientations of these parts are not well characterised, the roof + area estimate is unreliable, but the ground area estimate is + reliable. It may be that a more reliable whole building roof area + can be obtained by scaling the roof area from whole_roof_stats by + the ratio of the ground areas of `building_stats` and + `whole_roof_stats`. + $ref: '#/components/schemas/SizeAndSunshineStats' + solarPanels: + type: array + items: + $ref: '#/components/schemas/SolarPanel' + description: >- + Each SolarPanel describes a single solar panel. They are listed in + the order that the panel layout algorithm placed this. This is + usually, though not always, in decreasing order of annual energy + production. + panelCapacityWatts: + description: Capacity, in watts, of the panel used in the calculations. + format: float + type: number + panelWidthMeters: + format: float + description: >- + Width, in meters in portrait orientation, of the panel used in the + calculations. + type: number + maxArrayAreaMeters2: + format: float + type: number + description: Size, in square meters, of the maximum array. + panelLifetimeYears: + format: int32 + type: integer + description: >- + The expected lifetime, in years, of the solar panels. This is used + in the financial calculations. + financialAnalyses: + type: array + description: >- + A FinancialAnalysis gives the savings from going solar assuming a + given monthly bill and a given electricity provider. They are in + order of increasing order of monthly bill amount. This field will be + empty for buildings in areas for which the Solar API does not have + enough information to perform financial computations. + items: + $ref: '#/components/schemas/FinancialAnalysis' + roofSegmentStats: + type: array + items: + $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' + description: Size and sunlight quantiles for each roof segment. + solarPanelConfigs: + type: array + items: + $ref: '#/components/schemas/SolarPanelConfig' description: >- - Using the assumed discount rate, what is the present value of the - cumulative lifetime savings? - savingsLifetime: - $ref: '#/components/schemas/Money' - description: Savings in the entire panel lifetime. - financiallyViable: + Each SolarPanelConfig describes a different arrangement of solar + panels on the roof. They are in order of increasing number of + panels. The `SolarPanelConfig` with panels_count=N is based on the + first N panels in the `solar_panels` list. This field is only + populated if at least 4 panels can fit on a roof. + carbonOffsetFactorKgPerMwh: description: >- - Indicates whether this scenario is financially viable. Will be false - for scenarios with poor financial viability (e.g., money-losing). - type: boolean - id: SavingsOverTime - description: Financial information that's shared between different financing methods. + Equivalent amount of CO2 produced per MWh of grid electricity. This + is a measure of the carbon intensity of grid electricity displaced + by solar electricity. + format: float + type: number + id: SolarPotential + type: object parameters: upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). @@ -830,36 +830,12 @@ components: name: upload_protocol schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - 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. - in: query - name: key - schema: - type: string - _.xgafv: - description: V1 error format. + access_token: + description: OAuth access token. in: query - name: $.xgafv + name: access_token schema: type: string - enum: - - '1' - - '2' alt: description: Data format for response. in: query @@ -885,25 +861,67 @@ components: name: quotaUser schema: type: string - access_token: - description: OAuth access token. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: access_token + name: uploadType + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + 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. + in: query + name: key + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string + enum: + - '1' + - '2' prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - callback: - description: JSONP + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: callback + name: fields schema: type: string x-stackQL-resources: + data_layers: + id: google.solar.data_layers + name: data_layers + title: Data_layers + methods: + get: + operation: + $ref: '#/paths/~1v1~1dataLayers:get/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/data_layers/methods/get' + insert: [] + update: [] + replace: [] + delete: [] building_insights: id: google.solar.building_insights name: building_insights @@ -939,44 +957,26 @@ components: update: [] replace: [] delete: [] - data_layers: - id: google.solar.data_layers - name: data_layers - title: Data_layers - methods: - get: - operation: - $ref: '#/paths/~1v1~1dataLayers:get/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/data_layers/methods/get' - insert: [] - update: [] - replace: [] - delete: [] paths: - /v1/buildingInsights:findClosest: + /v1/dataLayers:get: parameters: &ref_1 - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' get: description: >- - Locates the closest building to a query point. Returns an error with - code `NOT_FOUND` if there are no buildings within approximately 50m of - the query point. - operationId: solar.buildingInsights.findClosest + Gets solar information for a region surrounding a location. Returns an + error with code `NOT_FOUND` if the location is outside the coverage + area. + operationId: solar.dataLayers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -988,19 +988,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BuildingInsights' + $ref: '#/components/schemas/DataLayers' parameters: - in: query - name: location.latitude + name: exactQualityRequired + schema: + type: boolean + - in: query + name: radiusMeters schema: type: number - format: double + format: float - in: query name: experiments schema: type: string - in: query - name: requiredQuality + name: view schema: type: string - in: query @@ -1008,36 +1012,28 @@ paths: schema: type: number format: double - /v1/geoTiff:get: - parameters: *ref_1 - get: - description: Returns an image by its ID. - operationId: solar.geoTiff.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/HttpBody' - parameters: - in: query - name: id + name: requiredQuality schema: type: string - /v1/dataLayers:get: + - in: query + name: location.latitude + schema: + type: number + format: double + - in: query + name: pixelSizeMeters + schema: + type: number + format: float + /v1/buildingInsights:findClosest: parameters: *ref_1 get: description: >- - Gets solar information for a region surrounding a location. Returns an - error with code `NOT_FOUND` if the location is outside the coverage - area. - operationId: solar.dataLayers.get + Locates the closest building to a query point. Returns an error with + code `NOT_FOUND` if there are no buildings within approximately 50m of + the query point. + operationId: solar.buildingInsights.findClosest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1049,19 +1045,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DataLayers' + $ref: '#/components/schemas/BuildingInsights' parameters: - in: query name: experiments schema: type: string - in: query - name: pixelSizeMeters - schema: - type: number - format: float - - in: query - name: location.latitude + name: location.longitude schema: type: number format: double @@ -1070,20 +1061,29 @@ paths: schema: type: string - in: query - name: exactQualityRequired - schema: - type: boolean - - in: query - name: view - schema: - type: string - - in: query - name: radiusMeters + name: location.latitude schema: type: number - format: float + format: double + /v1/geoTiff:get: + parameters: *ref_1 + get: + description: Returns an image by its ID. + operationId: solar.geoTiff.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: - in: query - name: location.longitude + name: id schema: - type: number - format: double + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml b/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml index 4c5a2747..f690df26 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml @@ -9,8 +9,8 @@ info: Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service. version: v1 - x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240913' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/spanner/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/speech.yaml b/providers/src/googleapis.com/v00.00.00000/services/speech.yaml index 9e99c020..fcc9e46e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/speech.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/speech.yaml @@ -8,7 +8,7 @@ info: description: Converts audio to text by applying powerful neural network models. version: v1 x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/speech-to-text/docs/quickstart-protocol servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml b/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml index 08bd34aa..48df6845 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml @@ -8,7 +8,7 @@ info: description: API for Cloud SQL database instance management version: v1 x-discovery-doc-revision: '20240831' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/cloud-sql/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/storage.yaml b/providers/src/googleapis.com/v00.00.00000/services/storage.yaml index 26bbae0f..307152a7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/storage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/storage.yaml @@ -8,7 +8,7 @@ info: description: Stores and retrieves potentially large, immutable data objects. version: v1 x-discovery-doc-revision: '20240831' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://developers.google.com/storage/docs/json_api/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml b/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml index b6162606..e21464b9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml @@ -10,7 +10,7 @@ info: or between Google Cloud Storage buckets. version: v1 x-discovery-doc-revision: '20240907' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/storage-transfer/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/testing.yaml b/providers/src/googleapis.com/v00.00.00000/services/testing.yaml index 1b76d311..fb48b489 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/testing.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/testing.yaml @@ -9,8 +9,8 @@ info: Allows developers to run automated tests for their mobile applications on Google infrastructure. version: v1 - x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240913' + x-generated-date: '2024-09-19' externalDocs: url: https://firebase.google.com/docs/test-lab/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml b/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml index 281a49ae..e8af2dac 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml @@ -10,7 +10,7 @@ info: models. version: v1 x-discovery-doc-revision: '20240910' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/text-to-speech/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml b/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml index 7d8d1b6f..1fe67218 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml @@ -7,8 +7,8 @@ info: title: Cloud TPU API description: TPU API provides customers with access to Google TPU technology. version: v2 - x-discovery-doc-revision: '20240829' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/tpu/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml b/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml index 976e8e80..ef64441f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml @@ -8,7 +8,7 @@ info: description: '' version: v3 x-discovery-doc-revision: '20240828' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/traffic-director servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml b/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml index f0e04474..07705344 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml @@ -9,8 +9,8 @@ info: This API converts video files into formats suitable for consumer distribution. For more information, see the Transcoder API overview. version: v1 - x-discovery-doc-revision: '20240819' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/transcoder/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/translate.yaml b/providers/src/googleapis.com/v00.00.00000/services/translate.yaml index 267e5fe9..4972421c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/translate.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/translate.yaml @@ -7,8 +7,8 @@ info: title: Cloud Translation API description: Integrates text translation into your website or application. version: v3 - x-discovery-doc-revision: '20240903' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/translate/docs/quickstarts servers: @@ -3146,6 +3146,10 @@ paths: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-translation + Oauth2c: + - https://www.googleapis.com/auth/cloud-translation responses: '200': description: Successful response diff --git a/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml b/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml index 21be03e8..0984361f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml @@ -11,7 +11,7 @@ info: both asynchronous API and streaming API. version: v1 x-discovery-doc-revision: '20240719' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/video-intelligence/docs/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/vision.yaml b/providers/src/googleapis.com/v00.00.00000/services/vision.yaml index 4d6686df..b95330ee 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vision.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vision.yaml @@ -11,7 +11,7 @@ info: explicit content, into applications. version: v1 x-discovery-doc-revision: '20240906' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/vision/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml index 09da924d..dcd681a1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml @@ -9,8 +9,8 @@ info: Use the Migrate to Virtual Machines API to programmatically migrate workloads. version: v1 - x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240912' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/migrate/virtual-machines servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml index 4ab8eaec..1ac36074 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml @@ -10,7 +10,7 @@ info: environments. version: v1 x-discovery-doc-revision: '20240820' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/solutions/vmware-as-a-service servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml b/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml index 15cdac49..e0a37829 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml @@ -8,7 +8,7 @@ info: description: API for managing VPC access connectors. version: v1 x-discovery-doc-revision: '20240905' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/vpc/docs/configure-serverless-vpc-access servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml b/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml index 5d34c4ed..05081fae 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240908' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/web-risk/ servers: @@ -34,105 +34,74 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse + GoogleRpcStatus: + id: GoogleRpcStatus type: object + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - description: The response message for Operations.ListOperations. - GoogleCloudWebriskV1RiceDeltaEncoding: - id: GoogleCloudWebriskV1RiceDeltaEncoding - properties: - firstValue: - format: int64 - type: string - description: >- - The offset of the first entry in the encoded data, or, if only a - single integer was encoded, that single integer's value. If the - field is empty or missing, assume zero. - riceParameter: - description: >- - The Golomb-Rice parameter, which is a number between 2 and 28. This - field is missing (that is, zero) if `num_entries` is zero. + code: type: integer format: int32 - entryCount: - format: int32 - type: integer + description: The status code, which should be an enum value of google.rpc.Code. + message: description: >- - The number of entries that are delta encoded in the encoded data. If - only a single integer was encoded, this will be zero and the single - value will be stored in `first_value`. - encodedData: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - description: The encoded deltas that are encoded using the Golomb-Rice coder. - format: byte - type: object - description: >- - The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes - or compressed removal indices. + details: + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array GoogleProtobufEmpty: properties: {} - type: object id: GoogleProtobufEmpty + type: object description: >- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudWebriskV1SearchUrisResponse: - type: object - properties: - threat: - $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponseThreatUri' - description: >- - The threat list matches. This might be empty if the URI is on no - list. - id: GoogleCloudWebriskV1SearchUrisResponse GoogleCloudWebriskV1Submission: - id: GoogleCloudWebriskV1Submission type: object + id: GoogleCloudWebriskV1Submission properties: uri: - type: string description: >- Required. The URI that is being reported for malicious content to be analyzed. + type: string description: Wraps a URI that might be displaying malicious content. - GoogleCloudWebriskV1SearchHashesResponse: + GoogleCloudWebriskV1RawHashes: properties: - threats: - type: array + prefixSize: description: >- - The full hashes that matched the requested prefixes. The hash will - be populated in the key. - items: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1SearchHashesResponseThreatHash - negativeExpireTime: - format: google-datetime + The number of bytes for each prefix encoded below. This field can be + anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). In + practice this is almost always 4, except in exceptional + circumstances. + type: integer + format: int32 + rawHashes: type: string description: >- - For requested entities that did not match the threat list, how long - to cache the response until. - id: GoogleCloudWebriskV1SearchHashesResponse - type: object - GoogleLongrunningCancelOperationRequest: - type: object - id: GoogleLongrunningCancelOperationRequest - properties: {} - description: The request message for Operations.CancelOperation. - GoogleCloudWebriskV1RawHashes: - id: GoogleCloudWebriskV1RawHashes + The hashes, in binary format, concatenated into one long string. + Hashes are sorted in lexicographic order. For JSON API users, hashes + are base64-encoded. + format: byte description: >- The uncompressed threat entries in hash format. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some @@ -140,41 +109,90 @@ components: Used for sending ThreatEntryAdditons to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression. + id: GoogleCloudWebriskV1RawHashes + type: object + GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: + id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum properties: - rawHashes: - description: >- - The hashes, in binary format, concatenated into one long string. - Hashes are sorted in lexicographic order. For JSON API users, hashes - are base64-encoded. - format: byte + sha256: type: string - prefixSize: - format: int32 - type: integer + format: byte description: >- - The number of bytes for each prefix encoded below. This field can be - anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). In - practice this is almost always 4, except in exceptional - circumstances. + The SHA256 hash of the client state; that is, of the sorted list of + all hashes present in the database. + description: The expected state of a client's local database. type: object - GoogleCloudWebriskV1SearchHashesResponseThreatHash: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + type: object + description: The response message for Operations.ListOperations. properties: - expireTime: + nextPageToken: type: string - format: google-datetime + description: The standard List next-page token. + operations: + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array description: >- - The cache lifetime for the returned match. Clients must not cache - this response past this timestamp to avoid false positives. - hash: - type: string + A list of operations that matches the specified filter in the + request. + GoogleCloudWebriskV1RawIndices: + type: object + properties: + indices: + items: + type: integer + format: int32 + type: array + description: The indices to remove from a lexicographically-sorted local list. + id: GoogleCloudWebriskV1RawIndices + description: A set of raw indices to remove from a local list. + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + properties: + error: description: >- - A 32 byte SHA256 hash. This field is in binary format. For JSON - requests, hashes are base64-encoded. - format: byte - threatTypes: + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - The ThreatList this threat belongs to. This must contain at least - one entry. + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + name: + description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. + type: string + metadata: + description: Contains a `SubmitUriMetadata` object. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + GoogleCloudWebriskV1SearchUrisResponseThreatUri: + type: object + properties: + threatTypes: type: array items: enum: @@ -194,79 +212,22 @@ components: - >- A list of extended coverage social engineering URIs targeting any platform. - type: object - id: GoogleCloudWebriskV1SearchHashesResponseThreatHash - description: Contains threat information on a matching hash. - GoogleCloudWebriskV1RawIndices: - description: A set of raw indices to remove from a local list. - id: GoogleCloudWebriskV1RawIndices - type: object - properties: - indices: - type: array - items: - type: integer - format: int32 - description: The indices to remove from a lexicographically-sorted local list. - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - properties: - details: - type: array - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: + description: The ThreatList this threat belongs to. + expireTime: type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: object + The cache lifetime for the returned match. Clients must not cache + this response past this timestamp to avoid false positives. + format: google-datetime + id: GoogleCloudWebriskV1SearchUrisResponseThreatUri + description: Contains threat information on a matching uri. GoogleCloudWebriskV1ComputeThreatListDiffResponse: properties: - removals: - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' - description: >- - A set of entries to remove from a local threat type's list. This - field may be empty. - newVersionToken: - format: byte - description: >- - The new opaque client version token. This should be retained by the - client and passed into the next call of ComputeThreatListDiff as - 'version_token'. A separate version token should be stored and used - for each threatList. - type: string - checksum: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum - description: >- - The expected SHA256 hash of the client state; that is, of the sorted - list of all hashes present in the database after applying the - provided diff. If the client state doesn't match the expected state, - the client must discard this diff and retry later. - additions: - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' - description: A set of entries to add to a local threat type's list. responseType: + enum: + - RESPONSE_TYPE_UNSPECIFIED + - DIFF + - RESET enumDescriptions: - Unknown. - >- @@ -276,55 +237,48 @@ components: Full updates resets the client's entire local database. This means that either the client had no state, was seriously out-of-date, or the client is believed to be corrupt. - type: string - enum: - - RESPONSE_TYPE_UNSPECIFIED - - DIFF - - RESET description: >- The type of response. This may indicate that an action must be taken by the client when the response is received. - recommendedNextDiff: type: string - format: google-datetime + recommendedNextDiff: description: >- The soonest the client should wait before issuing any diff request. Querying sooner is unlikely to produce a meaningful diff. Waiting longer is acceptable considering the use case. If this field is not set clients may update as soon as they want. - type: object - id: GoogleCloudWebriskV1ComputeThreatListDiffResponse - GoogleCloudWebriskV1ThreatEntryRemovals: - type: object - properties: - riceIndices: - $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' + type: string + format: google-datetime + checksum: + $ref: >- + #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum description: >- - The encoded local, lexicographically-sorted list indices, using a - Golomb-Rice encoding. Used for sending compressed removal indices. - The removal indices (uint32) are sorted in ascending order, then - delta encoded and stored as encoded_data. - rawIndices: - description: The raw removal indices for a local list. - $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' - description: Contains the set of entries to remove from a local database. - id: GoogleCloudWebriskV1ThreatEntryRemovals - GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: - properties: - sha256: + The expected SHA256 hash of the client state; that is, of the sorted + list of all hashes present in the database after applying the + provided diff. If the client state doesn't match the expected state, + the client must discard this diff and retry later. + removals: + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' + description: >- + A set of entries to remove from a local threat type's list. This + field may be empty. + newVersionToken: type: string format: byte description: >- - The SHA256 hash of the client state; that is, of the sorted list of - all hashes present in the database. - id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum - description: The expected state of a client's local database. + The new opaque client version token. This should be retained by the + client and passed into the next call of ComputeThreatListDiff as + 'version_token'. A separate version token should be stored and used + for each threatList. + additions: + description: A set of entries to add to a local threat type's list. + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' + id: GoogleCloudWebriskV1ComputeThreatListDiffResponse type: object GoogleCloudWebriskV1ThreatEntryAdditions: description: >- Contains the set of entries to add to a local database. May contain a combination of compressed and raw data in a single response. - id: GoogleCloudWebriskV1ThreatEntryAdditions type: object properties: riceHashes: @@ -334,68 +288,62 @@ components: Golomb-Rice encoding. The hashes are converted to uint32, sorted in ascending order, then delta encoded and stored as encoded_data. rawHashes: - items: - $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' type: array description: >- The raw SHA256-formatted entries. Repeated to allow returning sets of hashes with different prefix sizes. - GoogleLongrunningOperation: - description: >- - This resource represents a long-running operation that is the result of - a network API call. + items: + $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' + id: GoogleCloudWebriskV1ThreatEntryAdditions + GoogleCloudWebriskV1ThreatEntryRemovals: + id: GoogleCloudWebriskV1ThreatEntryRemovals + description: Contains the set of entries to remove from a local database. + type: object properties: - metadata: - description: Contains a `SubmitUriMetadata` object. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - name: - type: string - description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. - response: + rawIndices: + $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' + description: The raw removal indices for a local list. + riceIndices: + $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - error: + The encoded local, lexicographically-sorted list indices, using a + Golomb-Rice encoding. Used for sending compressed removal indices. + The removal indices (uint32) are sorted in ascending order, then + delta encoded and stored as encoded_data. + GoogleCloudWebriskV1SearchHashesResponse: + type: object + id: GoogleCloudWebriskV1SearchHashesResponse + properties: + negativeExpireTime: description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - done: + For requested entities that did not match the threat list, how long + to cache the response until. + type: string + format: google-datetime + threats: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - id: GoogleLongrunningOperation + The full hashes that matched the requested prefixes. The hash will + be populated in the key. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudWebriskV1SearchHashesResponseThreatHash + GoogleCloudWebriskV1SearchUrisResponse: type: object - GoogleCloudWebriskV1SearchUrisResponseThreatUri: + properties: + threat: + description: >- + The threat list matches. This might be empty if the URI is on no + list. + $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponseThreatUri' + id: GoogleCloudWebriskV1SearchUrisResponse + GoogleCloudWebriskV1SearchHashesResponseThreatHash: type: object - id: GoogleCloudWebriskV1SearchUrisResponseThreatUri - description: Contains threat information on a matching uri. + id: GoogleCloudWebriskV1SearchHashesResponseThreatHash properties: threatTypes: - description: The ThreatList this threat belongs to. type: array items: - enum: - - THREAT_TYPE_UNSPECIFIED - - MALWARE - - SOCIAL_ENGINEERING - - UNWANTED_SOFTWARE - - SOCIAL_ENGINEERING_EXTENDED_COVERAGE type: string enumDescriptions: - >- @@ -407,31 +355,71 @@ components: - >- A list of extended coverage social engineering URIs targeting any platform. + enum: + - THREAT_TYPE_UNSPECIFIED + - MALWARE + - SOCIAL_ENGINEERING + - UNWANTED_SOFTWARE + - SOCIAL_ENGINEERING_EXTENDED_COVERAGE + description: >- + The ThreatList this threat belongs to. This must contain at least + one entry. + hash: + format: byte + description: >- + A 32 byte SHA256 hash. This field is in binary format. For JSON + requests, hashes are base64-encoded. + type: string expireTime: format: google-datetime + description: >- + The cache lifetime for the returned match. Clients must not cache + this response past this timestamp to avoid false positives. + type: string + description: Contains threat information on a matching hash. + GoogleCloudWebriskV1RiceDeltaEncoding: + type: object + id: GoogleCloudWebriskV1RiceDeltaEncoding + description: >- + The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes + or compressed removal indices. + properties: + riceParameter: + description: >- + The Golomb-Rice parameter, which is a number between 2 and 28. This + field is missing (that is, zero) if `num_entries` is zero. + type: integer + format: int32 + firstValue: + format: int64 + description: >- + The offset of the first entry in the encoded data, or, if only a + single integer was encoded, that single integer's value. If the + field is empty or missing, assume zero. type: string + entryCount: description: >- - The cache lifetime for the returned match. Clients must not cache - this response past this timestamp to avoid false positives. + The number of entries that are delta encoded in the encoded data. If + only a single integer was encoded, this will be zero and the single + value will be stored in `first_value`. + type: integer + format: int32 + encodedData: + description: The encoded deltas that are encoded using the Golomb-Rice coder. + type: string + format: byte + GoogleLongrunningCancelOperationRequest: + type: object + id: GoogleLongrunningCancelOperationRequest + properties: {} + description: The request message for Operations.CancelOperation. parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -441,25 +429,22 @@ components: enum: - '1' - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: quotaUser + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string key: @@ -471,18 +456,18 @@ components: name: key schema: type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string alt: description: Data format for response. in: query @@ -493,6 +478,21 @@ components: - json - media - proto + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string x-stackQL-resources: uris: id: google.webrisk.uris @@ -534,6 +534,13 @@ components: name: operations title: Operations methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations delete: operation: $ref: >- @@ -555,13 +562,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -571,14 +571,14 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - hashes: - id: google.webrisk.hashes - name: hashes - title: Hashes + threat_lists: + id: google.webrisk.threat_lists + name: threat_lists + title: Threat_lists methods: - search: + compute_diff: operation: - $ref: '#/paths/~1v1~1hashes:search/get' + $ref: '#/paths/~1v1~1threatLists:computeDiff/get' response: mediaType: application/json openAPIDocKey: '200' @@ -588,14 +588,14 @@ components: update: [] replace: [] delete: [] - threat_lists: - id: google.webrisk.threat_lists - name: threat_lists - title: Threat_lists + hashes: + id: google.webrisk.hashes + name: hashes + title: Hashes methods: - compute_diff: + search: operation: - $ref: '#/paths/~1v1~1threatLists:computeDiff/get' + $ref: '#/paths/~1v1~1hashes:search/get' response: mediaType: application/json openAPIDocKey: '200' @@ -608,17 +608,17 @@ components: paths: /v1/uris:search: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' get: description: >- This method is used to check whether a URI is on a given threatList. @@ -684,6 +684,40 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: webrisk.projects.operations.list + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string /v1/projects/{projectsId}/operations/{operationsId}: parameters: *ref_1 delete: @@ -779,40 +813,54 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/operations: + /v1/threatLists:computeDiff: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: webrisk.projects.operations.list - security: [] + Gets the most recent threat list diffs. These diffs should be applied to + a local database of hashes to keep it up-to-date. If the local database + is empty or excessively out-of-date, a complete snapshot of the database + will be returned. This Method only updates a single ThreatList at a + time. To update multiple ThreatList databases, this method needs to be + called once for each list. + operationId: webrisk.threatLists.computeDiff + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse parameters: - - in: path - name: projectsId - required: true + - in: query + name: constraints.supportedCompressions schema: type: string - in: query - name: filter + name: threatType schema: type: string - in: query - name: pageToken + name: constraints.maxDatabaseEntries schema: - type: string + type: integer + format: int32 - in: query - name: pageSize + name: constraints.maxDiffEntries schema: type: integer format: int32 + - in: query + name: versionToken + schema: + type: string + format: byte /v1/hashes:search: parameters: *ref_1 get: @@ -836,60 +884,12 @@ paths: schema: $ref: '#/components/schemas/GoogleCloudWebriskV1SearchHashesResponse' parameters: - - in: query - name: threatTypes - schema: - type: string - in: query name: hashPrefix schema: type: string format: byte - /v1/threatLists:computeDiff: - parameters: *ref_1 - get: - description: >- - Gets the most recent threat list diffs. These diffs should be applied to - a local database of hashes to keep it up-to-date. If the local database - is empty or excessively out-of-date, a complete snapshot of the database - will be returned. This Method only updates a single ThreatList at a - time. To update multiple ThreatList databases, this method needs to be - called once for each list. - operationId: webrisk.threatLists.computeDiff - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse - parameters: - - in: query - name: constraints.supportedCompressions - schema: - type: string - - in: query - name: threatType - schema: - type: string - - in: query - name: constraints.maxDiffEntries - schema: - type: integer - format: int32 - in: query - name: versionToken + name: threatTypes schema: type: string - format: byte - - in: query - name: constraints.maxDatabaseEntries - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml index a1a6e169..61c66760 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml @@ -7,8 +7,8 @@ info: title: Web Security Scanner API description: Scans your Compute and App Engine apps for common web vulnerabilities. version: v1 - x-discovery-doc-revision: '20240901' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240914' + x-generated-date: '2024-09-19' externalDocs: url: >- https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ @@ -35,7 +35,149 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + Form: + id: Form + description: '! Information about a vulnerability with an HTML.' + type: object + properties: + actionUri: + type: string + description: '! The URI where to send the form when it''s submitted.' + fields: + description: '! The names of form fields related to the vulnerability.' + type: array + items: + type: string + Xxe: + description: Information reported for an XXE. + id: Xxe + properties: + payloadValue: + type: string + description: >- + The XML string that triggered the XXE vulnerability. Non-payload + values might be redacted. + payloadLocation: + type: string + enum: + - LOCATION_UNSPECIFIED + - COMPLETE_REQUEST_BODY + description: Location within the request where the payload was placed. + enumDescriptions: + - Unknown Location. + - The XML payload replaced the complete request body. + type: object + ScanConfig: + properties: + ignoreHttpStatusErrors: + type: boolean + description: >- + Whether to keep scanning even if most requests return HTTP error + codes. + schedule: + $ref: '#/components/schemas/Schedule' + description: The schedule of the ScanConfig. + authentication: + $ref: '#/components/schemas/Authentication' + description: >- + The authentication configuration. If specified, service will use the + authentication configuration during scanning. + exportToSecurityCommandCenter: + enumDescriptions: + - Use default, which is ENABLED. + - Export results of this scan to Security Command Center. + - Do not export results of this scan to Security Command Center. + type: string + description: >- + Controls export of scan configurations and results to Security + Command Center. + enum: + - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED + - ENABLED + - DISABLED + userAgent: + description: The user agent used during scanning. + enumDescriptions: + - The user agent is unknown. Service will default to CHROME_LINUX. + - Chrome on Linux. This is the service default if unspecified. + - Chrome on Android. + - Safari on IPhone. + type: string + enum: + - USER_AGENT_UNSPECIFIED + - CHROME_LINUX + - CHROME_ANDROID + - SAFARI_IPHONE + blacklistPatterns: + type: array + description: >- + The excluded URL patterns as described in + https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls + items: + type: string + maxQps: + description: >- + The maximum QPS during scanning. A valid value ranges from 5 to 20 + inclusively. If the field is unspecified or its value is set 0, + server will default to 15. Other values outside of [5, 20] range + will be rejected with INVALID_ARGUMENT error. + type: integer + format: int32 + name: + description: >- + The resource name of the ScanConfig. The name follows the format of + 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig + IDs are generated by the system. + type: string + displayName: + type: string + description: Required. The user provided display name of the ScanConfig. + managedScan: + type: boolean + description: >- + Whether the scan config is managed by Web Security Scanner, output + only. + staticIpScan: + description: >- + Whether the scan configuration has enabled static IP address scan + feature. If enabled, the scanner will access applications from + static IP addresses. + type: boolean + startingUrls: + type: array + items: + type: string + description: Required. The starting URLs from which the scanner finds site pages. + riskLevel: + enum: + - RISK_LEVEL_UNSPECIFIED + - NORMAL + - LOW + enumDescriptions: + - Use default, which is NORMAL. + - Normal scanning (Recommended) + - Lower impact scanning + description: The risk level selected for the scan + type: string + description: A ScanConfig resource contains the configurations to launch a scan. + type: object + id: ScanConfig + IapCredential: + description: Describes authentication configuration for Identity-Aware-Proxy (IAP). + type: object + properties: + iapTestServiceAccountInfo: + description: >- + Authentication configuration when Web-Security-Scanner service + account is added in Identity-Aware-Proxy (IAP) access policies. + $ref: '#/components/schemas/IapTestServiceAccountInfo' + id: IapCredential Finding: + type: object + id: Finding + description: >- + A Finding resource represents a vulnerability instance identified during + a ScanRun. properties: findingType: type: string @@ -43,6 +185,31 @@ components: Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings + description: + description: Output only. The description of the vulnerability. + type: string + name: + type: string + description: >- + Output only. The resource name of the Finding. The name follows the + format of + 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. + The finding IDs are generated by the system. + frameUrl: + description: >- + Output only. If the vulnerability was originated from nested IFrame, + the immediate parent IFrame is reported. + type: string + body: + type: string + description: >- + Output only. The body of the request that triggered the + vulnerability. + fuzzedUrl: + type: string + description: >- + Output only. The URL produced by the server-side fuzzer and used in + the request that triggered the vulnerability. vulnerableParameters: $ref: '#/components/schemas/VulnerableParameters' description: >- @@ -54,43 +221,59 @@ components: resource causing the vulnerability such as JavaScript sources, image, audio files, etc. $ref: '#/components/schemas/ViolatingResource' - fuzzedUrl: + xss: description: >- - Output only. The URL produced by the server-side fuzzer and used in - the request that triggered the vulnerability. - type: string + Output only. An addon containing information reported for an XSS, if + any. + $ref: '#/components/schemas/Xss' + form: + $ref: '#/components/schemas/Form' + description: >- + Output only. An addon containing information reported for a + vulnerability with an HTML form, if any. + xxe: + readOnly: true + $ref: '#/components/schemas/Xxe' + description: >- + Output only. An addon containing information reported for an XXE, if + any. vulnerableHeaders: $ref: '#/components/schemas/VulnerableHeaders' description: >- Output only. An addon containing information about vulnerable or missing HTTP headers. + finalUrl: + description: >- + Output only. The URL where the browser lands when the vulnerability + is detected. + type: string + outdatedLibrary: + $ref: '#/components/schemas/OutdatedLibrary' + description: >- + Output only. An addon containing information about outdated + libraries. trackingId: + type: string description: >- Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. - type: string httpMethod: description: >- Output only. The http method of the request that triggered the vulnerability, in uppercase. type: string - xxe: - readOnly: true - $ref: '#/components/schemas/Xxe' - description: >- - Output only. An addon containing information reported for an XXE, if - any. - outdatedLibrary: + reproductionUrl: description: >- - Output only. An addon containing information about outdated - libraries. - $ref: '#/components/schemas/OutdatedLibrary' - body: + Output only. The URL containing human-readable payload that user can + leverage to reproduce the vulnerability. type: string - description: >- - Output only. The body of the request that triggered the - vulnerability. severity: + enumDescriptions: + - No severity specified. The default value. + - Critical severity. + - High severity. + - Medium severity. + - Low severity. enum: - SEVERITY_UNSPECIFIED - CRITICAL @@ -98,532 +281,185 @@ components: - MEDIUM - LOW description: Output only. The severity level of the reported vulnerability. - type: string readOnly: true - enumDescriptions: - - No severity specified. The default value. - - Critical severity. - - High severity. - - Medium severity. - - Low severity. - name: - description: >- - Output only. The resource name of the Finding. The name follows the - format of - 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. - The finding IDs are generated by the system. - type: string - form: - description: >- - Output only. An addon containing information reported for a - vulnerability with an HTML form, if any. - $ref: '#/components/schemas/Form' - description: - type: string - description: Output only. The description of the vulnerability. - frameUrl: - description: >- - Output only. If the vulnerability was originated from nested IFrame, - the immediate parent IFrame is reported. - type: string - reproductionUrl: - description: >- - Output only. The URL containing human-readable payload that user can - leverage to reproduce the vulnerability. type: string - finalUrl: - type: string - description: >- - Output only. The URL where the browser lands when the vulnerability - is detected. - xss: - description: >- - Output only. An addon containing information reported for an XSS, if - any. - $ref: '#/components/schemas/Xss' - id: Finding - type: object - description: >- - A Finding resource represents a vulnerability instance identified during - a ScanRun. - ListFindingsResponse: - properties: - nextPageToken: - type: string - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - findings: - type: array - description: The list of Findings returned. - items: - $ref: '#/components/schemas/Finding' - type: object - id: ListFindingsResponse - description: Response for the `ListFindings` method. - ScanRun: + StopScanRunRequest: + description: Request for the `StopScanRun` method. + id: StopScanRunRequest type: object - properties: - startTime: - type: string - format: google-datetime - description: Output only. The time at which the ScanRun started. - warningTraces: - description: >- - Output only. A list of warnings, if such are encountered during this - scan run. - items: - $ref: '#/components/schemas/ScanRunWarningTrace' - type: array - progressPercent: - type: integer - format: int32 - description: >- - Output only. The percentage of total completion ranging from 0 to - 100. If the scan is in queue, the value is 0. If the scan is - running, the value ranges from 0 to 100. If the scan is finished, - the value is 100. - endTime: - description: >- - Output only. The time at which the ScanRun reached termination state - - that the ScanRun is either finished or stopped by user. - format: google-datetime - type: string - errorTrace: - description: >- - Output only. If result_state is an ERROR, this field provides the - primary reason for scan's termination and more details, if such are - available. - $ref: '#/components/schemas/ScanRunErrorTrace' - name: - type: string - description: >- - Output only. The resource name of the ScanRun. The name follows the - format of - 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. - The ScanRun IDs are generated by the system. - urlsTestedCount: - type: string - description: >- - Output only. The number of URLs tested during this ScanRun. If the - scan is in progress, the value represents the number of URLs tested - up to now. The number of URLs tested is usually larger than the - number URLS crawled because typically a crawled URL is tested with - multiple test payloads. - format: int64 - resultState: - enum: - - RESULT_STATE_UNSPECIFIED - - SUCCESS - - ERROR - - KILLED - type: string - description: >- - Output only. The result state of the ScanRun. This field is only - available after the execution state reaches "FINISHED". - enumDescriptions: - - >- - Default value. This value is returned when the ScanRun is not yet - finished. - - The scan finished without errors. - - The scan finished with errors. - - The scan was terminated by user. - urlsCrawledCount: - type: string - format: int64 - description: >- - Output only. The number of URLs crawled during this ScanRun. If the - scan is in progress, the value represents the number of URLs crawled - up to now. - hasVulnerabilities: - description: Output only. Whether the scan run has found any vulnerabilities. - type: boolean - executionState: - description: Output only. The execution state of the ScanRun. - enumDescriptions: - - >- - Represents an invalid state caused by internal server error. This - value should never be returned. - - The scan is waiting in the queue. - - The scan is in progress. - - The scan is either finished or stopped by user. - enum: - - EXECUTION_STATE_UNSPECIFIED - - QUEUED - - SCANNING - - FINISHED - type: string - description: >- - A ScanRun is a output-only resource representing an actual run of the - scan. Next id: 12 - id: ScanRun + properties: {} Authentication: + type: object id: Authentication + description: Scan authentication configuration. properties: customAccount: - $ref: '#/components/schemas/CustomAccount' description: Authentication using a custom account. + $ref: '#/components/schemas/CustomAccount' googleAccount: + description: Authentication using a Google account. $ref: '#/components/schemas/GoogleAccount' deprecated: true - description: Authentication using a Google account. iapCredential: - description: Authentication using Identity-Aware-Proxy (IAP). $ref: '#/components/schemas/IapCredential' - description: Scan authentication configuration. - type: object - ScanConfig: - type: object - description: A ScanConfig resource contains the configurations to launch a scan. - id: ScanConfig - properties: - staticIpScan: - type: boolean - description: >- - Whether the scan configuration has enabled static IP address scan - feature. If enabled, the scanner will access applications from - static IP addresses. - displayName: - type: string - description: Required. The user provided display name of the ScanConfig. - userAgent: - type: string - description: The user agent used during scanning. - enumDescriptions: - - The user agent is unknown. Service will default to CHROME_LINUX. - - Chrome on Linux. This is the service default if unspecified. - - Chrome on Android. - - Safari on IPhone. - enum: - - USER_AGENT_UNSPECIFIED - - CHROME_LINUX - - CHROME_ANDROID - - SAFARI_IPHONE - riskLevel: - enumDescriptions: - - Use default, which is NORMAL. - - Normal scanning (Recommended) - - Lower impact scanning - type: string - enum: - - RISK_LEVEL_UNSPECIFIED - - NORMAL - - LOW - description: The risk level selected for the scan - blacklistPatterns: - description: >- - The excluded URL patterns as described in - https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls - type: array - items: - type: string - exportToSecurityCommandCenter: - type: string - description: >- - Controls export of scan configurations and results to Security - Command Center. - enum: - - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED - - ENABLED - - DISABLED - enumDescriptions: - - Use default, which is ENABLED. - - Export results of this scan to Security Command Center. - - Do not export results of this scan to Security Command Center. - schedule: - description: The schedule of the ScanConfig. - $ref: '#/components/schemas/Schedule' - startingUrls: - description: Required. The starting URLs from which the scanner finds site pages. - items: - type: string - type: array - maxQps: - format: int32 - type: integer - description: >- - The maximum QPS during scanning. A valid value ranges from 5 to 20 - inclusively. If the field is unspecified or its value is set 0, - server will default to 15. Other values outside of [5, 20] range - will be rejected with INVALID_ARGUMENT error. - managedScan: - type: boolean - description: >- - Whether the scan config is managed by Web Security Scanner, output - only. - ignoreHttpStatusErrors: - description: >- - Whether to keep scanning even if most requests return HTTP error - codes. - type: boolean - name: - description: >- - The resource name of the ScanConfig. The name follows the format of - 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig - IDs are generated by the system. - type: string - authentication: - description: >- - The authentication configuration. If specified, service will use the - authentication configuration during scanning. - $ref: '#/components/schemas/Authentication' - IapCredential: - description: Describes authentication configuration for Identity-Aware-Proxy (IAP). - id: IapCredential - type: object - properties: - iapTestServiceAccountInfo: - $ref: '#/components/schemas/IapTestServiceAccountInfo' - description: >- - Authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. - IapTestServiceAccountInfo: - description: >- - Describes authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. - id: IapTestServiceAccountInfo - type: object - properties: - targetAudienceClientId: - description: >- - Required. Describes OAuth2 client id of resources protected by - Identity-Aware-Proxy (IAP). - type: string - StopScanRunRequest: - id: StopScanRunRequest - type: object - description: Request for the `StopScanRun` method. - properties: {} - GoogleAccount: - properties: - password: - type: string - description: >- - Required. Input only. The password of the Google account. The - credential is stored encrypted and not returned in any response nor - included in audit logs. - username: - type: string - description: Required. The user name of the Google account. - description: Describes authentication configuration that uses a Google account. - id: GoogleAccount - deprecated: true - type: object - ScanRunErrorTrace: - type: object + description: Authentication using Identity-Aware-Proxy (IAP). + ScanConfigError: properties: - scanConfigError: - $ref: '#/components/schemas/ScanConfigError' + fieldName: + type: string description: >- - Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this - field has the error message encountered during scan configuration - validation that is performed before each scan run. + Output only. Indicates the full name of the ScanConfig field that + triggers this error, for example "scan_config.max_qps". This field + is provided for troubleshooting purposes only and its actual value + can change in the future. code: - description: Output only. Indicates the error reason code. - enum: - - CODE_UNSPECIFIED - - INTERNAL_ERROR - - SCAN_CONFIG_ISSUE - - AUTHENTICATION_CONFIG_ISSUE - - TIMED_OUT_WHILE_SCANNING - - TOO_MANY_REDIRECTS - - TOO_MANY_HTTP_ERRORS - - STARTING_URLS_CRAWL_HTTP_ERRORS - type: string enumDescriptions: - - Default value is never used. + - There is no error. + - There is no error. - >- - Indicates that the scan run failed due to an internal server - error. + Indicates an internal server error. Please DO NOT USE THIS ERROR + CODE unless the root cause is truly unknown. - >- - Indicates a scan configuration error, usually due to outdated - ScanConfig settings, such as starting_urls or the DNS - configuration. + One of the seed URLs is an App Engine URL but we cannot validate + the scan settings due to an App Engine API backend error. - >- - Indicates an authentication error, usually due to outdated - ScanConfig authentication settings. + One of the seed URLs is an App Engine URL but we cannot access the + App Engine API to validate scan settings. - >- - Indicates a scan operation timeout, usually caused by a very large - site. + One of the seed URLs is an App Engine URL but the Default Host of + the App Engine is not set. + - Google corporate accounts can not be used for scanning. + - The account of the scan creator can not be used for scanning. - >- - Indicates that a scan encountered excessive redirects, either to - authentication or some other page outside of the scan scope. + This scan targets Compute Engine, but we cannot validate scan + settings due to a Compute Engine API backend error. - >- - Indicates that a scan encountered numerous errors from the web - site pages. When available, most_common_http_error_code field - indicates the most common HTTP error code encountered during the - scan. + This scan targets Compute Engine, but we cannot access the Compute + Engine API to validate the scan settings. + - The Custom Login URL does not belong to the current project. + - The Custom Login URL is malformed (can not be parsed). - >- - Indicates that some of the starting web urls returned HTTP errors - during the scan. - mostCommonHttpErrorCode: - format: int32 - type: integer - description: >- - Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field - indicates the most common HTTP error code, if such is available. For - example, if this code is 404, the scan has encountered too many - NOT_FOUND responses. - description: Output only. Defines an error trace message for a ScanRun. - id: ScanRunErrorTrace - ViolatingResource: - type: object - properties: - contentType: - description: The MIME type of this resource. - type: string - resourceUrl: - type: string - description: URL of this violating resource. - id: ViolatingResource - description: >- - Information regarding any resource causing the vulnerability such as - JavaScript sources, image, audio files, etc. - CrawledUrl: - type: object - properties: - url: - description: Output only. The URL that was crawled. - type: string - body: - description: Output only. The body of the request that was used to visit the URL. - type: string - httpMethod: - description: >- - Output only. The http method of the request that was used to visit - the URL, in uppercase. - type: string - description: >- - A CrawledUrl resource represents a URL that was crawled during a - ScanRun. Web Security Scanner Service crawls the web applications, - following all links within the scope of sites, to find the URLs to test - against. - id: CrawledUrl - Schedule: - type: object - properties: - scheduleTime: - format: google-datetime - description: >- - A timestamp indicates when the next run will be scheduled. The value - is refreshed by the server after each run. If unspecified, it will - default to current server time, which means the scan will be - scheduled to start immediately. - type: string - intervalDurationDays: - format: int32 - type: integer - description: Required. The duration of time between executions in days. - id: Schedule - description: Scan schedule configuration. - StartScanRunRequest: - type: object - id: StartScanRunRequest - description: Request for the `StartScanRun` method. - properties: {} - ListScanRunsResponse: - id: ListScanRunsResponse - type: object - description: Response for the `ListScanRuns` method. - properties: - scanRuns: - type: array - description: The list of ScanRuns returned. - items: - $ref: '#/components/schemas/ScanRun' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - ListScanConfigsResponse: - description: Response for the `ListScanConfigs` method. - properties: - scanConfigs: - description: The list of ScanConfigs returned. - items: - $ref: '#/components/schemas/ScanConfig' - type: array - nextPageToken: - type: string - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - id: ListScanConfigsResponse - type: object - ScanRunWarningTrace: - type: object - id: ScanRunWarningTrace - description: >- - Output only. Defines a warning trace message for ScanRun. Warning traces - provide customers with useful information that helps make the scanning - process more effective. - properties: - code: - enumDescriptions: - - Default value is never used. + The Custom Login URL is mapped to a non-routable IP address in + DNS. - >- - Indicates that a scan discovered an unexpectedly low number of - URLs. This is sometimes caused by complex navigation features or - by using a single URL for numerous pages. + The Custom Login URL is mapped to an IP address which is not + reserved for the current project. + - The Custom Login URL has a non-routable IP address. - >- - Indicates that a scan discovered too many URLs to test, or - excessive redundant URLs. + The Custom Login URL has an IP address which is not reserved for + the current project. + - Another scan with the same name (case-sensitive) already exists. + - A field is set to an invalid value. + - There was an error trying to authenticate to the scan target. + - Finding type value is not specified in the list findings request. - >- - Indicates that too many tests have been generated for the scan. - Customer should try reducing the number of starting URLs, - increasing the QPS rate, or narrowing down the scope of the scan - using the excluded patterns. - - Indicates that a scan is blocked by IAP. - - Indicates that no seeds is found for a scan - description: Output only. Indicates the warning code. + Scan targets Compute Engine, yet current project was not + whitelisted for Google Compute Engine Scanning Alpha access. + - User tries to update managed scan + - >- + The supplied filter is malformed. For example, it can not be + parsed, does not have a filter type in expression, or the same + filter type appears more than once. + - The supplied resource name is malformed (can not be parsed). + - The current project is not in an active state. + - A required field is not set. + - >- + Project id, scanconfig id, scanrun id, or finding id are not + consistent with each other in resource name. + - The scan being requested to start is already running. + - The scan that was requested to be stopped is not running. + - One of the seed URLs does not belong to the current project. + - One of the seed URLs is malformed (can not be parsed). + - >- + One of the seed URLs is mapped to a non-routable IP address in + DNS. + - >- + One of the seed URLs is mapped to an IP address which is not + reserved for the current project. + - One of the seed URLs has on-routable IP address. + - >- + One of the seed URLs has an IP address that is not reserved for + the current project. + - >- + The Web Security Scanner service account is not configured under + the project. + - A project has reached the maximum number of scans. + - Resolving the details of the current project fails. + - One or more blacklist patterns were in the wrong format. + - The supplied filter is not supported. + - >- + The supplied finding type is not supported. For example, we do not + provide findings of the given finding type. + - >- + The URL scheme of one or more of the supplied URLs is not + supported. + - CAI is not able to list assets. + description: Output only. Indicates the reason code for a configuration failure. type: string enum: - CODE_UNSPECIFIED - - INSUFFICIENT_CRAWL_RESULTS - - TOO_MANY_CRAWL_RESULTS - - TOO_MANY_FUZZ_TASKS - - BLOCKED_BY_IAP - - NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN - OutdatedLibrary: - id: OutdatedLibrary - properties: - libraryName: - description: The name of the outdated library. - type: string - version: - type: string - description: The version number. - learnMoreUrls: - items: - type: string - description: >- - URLs to learn more information about the vulnerabilities in the - library. - type: array + - OK + - INTERNAL_ERROR + - APPENGINE_API_BACKEND_ERROR + - APPENGINE_API_NOT_ACCESSIBLE + - APPENGINE_DEFAULT_HOST_MISSING + - CANNOT_USE_GOOGLE_COM_ACCOUNT + - CANNOT_USE_OWNER_ACCOUNT + - COMPUTE_API_BACKEND_ERROR + - COMPUTE_API_NOT_ACCESSIBLE + - CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT + - CUSTOM_LOGIN_URL_MALFORMED + - CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS + - CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS + - CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS + - CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS + - DUPLICATE_SCAN_NAME + - INVALID_FIELD_VALUE + - FAILED_TO_AUTHENTICATE_TO_TARGET + - FINDING_TYPE_UNSPECIFIED + - FORBIDDEN_TO_SCAN_COMPUTE + - FORBIDDEN_UPDATE_TO_MANAGED_SCAN + - MALFORMED_FILTER + - MALFORMED_RESOURCE_NAME + - PROJECT_INACTIVE + - REQUIRED_FIELD + - RESOURCE_NAME_INCONSISTENT + - SCAN_ALREADY_RUNNING + - SCAN_NOT_RUNNING + - SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT + - SEED_URL_MALFORMED + - SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS + - SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS + - SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS + - SEED_URL_HAS_UNRESERVED_IP_ADDRESS + - SERVICE_ACCOUNT_NOT_CONFIGURED + - TOO_MANY_SCANS + - UNABLE_TO_RESOLVE_PROJECT_INFO + - UNSUPPORTED_BLACKLIST_PATTERN_FORMAT + - UNSUPPORTED_FILTER + - UNSUPPORTED_FINDING_TYPE + - UNSUPPORTED_URL_SCHEME + - CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND + description: >- + Defines a custom error message used by CreateScanConfig and + UpdateScanConfig APIs when scan configuration validation fails. It is + also reported as part of a ScanRunErrorTrace message if scan validation + fails due to a scan configuration error. type: object - description: Information reported for an outdated library. - VulnerableParameters: - description: Information about vulnerable request parameters. + id: ScanConfigError + StartScanRunRequest: + description: Request for the `StartScanRun` method. + id: StartScanRunRequest type: object - id: VulnerableParameters - properties: - parameterNames: - type: array - items: - type: string - description: The vulnerable parameter names. + properties: {} Xss: - id: Xss - type: object properties: - storedXssSeedingUrl: - description: The reproduction url for the seeding POST request of a Stored XSS. - type: string errorMessage: - type: string description: An error message generated by a javascript breakage. + type: string attackVector: + description: The attack vector of the payload triggering this XSS. + type: string enum: - ATTACK_VECTOR_UNSPECIFIED - LOCAL_STORAGE @@ -641,7 +477,6 @@ components: - STORED_XSS - SAME_ORIGIN - USER_CONTROLLABLE_URL - description: The attack vector of the payload triggering this XSS. enumDescriptions: - Unknown attack vector. - The attack comes from fuzzing the browser's localStorage. @@ -663,14 +498,85 @@ components: - >- The attack payload is received from a third-party host via a URL that is user-controllable - type: string stackTraces: - items: - type: string description: Stack traces leading to the point where the XSS occurred. type: array + items: + type: string + storedXssSeedingUrl: + type: string + description: The reproduction url for the seeding POST request of a Stored XSS. + id: Xss description: Information reported for an XSS. + type: object + ScanRunWarningTrace: + properties: + code: + enumDescriptions: + - Default value is never used. + - >- + Indicates that a scan discovered an unexpectedly low number of + URLs. This is sometimes caused by complex navigation features or + by using a single URL for numerous pages. + - >- + Indicates that a scan discovered too many URLs to test, or + excessive redundant URLs. + - >- + Indicates that too many tests have been generated for the scan. + Customer should try reducing the number of starting URLs, + increasing the QPS rate, or narrowing down the scope of the scan + using the excluded patterns. + - Indicates that a scan is blocked by IAP. + - Indicates that no seeds is found for a scan + enum: + - CODE_UNSPECIFIED + - INSUFFICIENT_CRAWL_RESULTS + - TOO_MANY_CRAWL_RESULTS + - TOO_MANY_FUZZ_TASKS + - BLOCKED_BY_IAP + - NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN + description: Output only. Indicates the warning code. + type: string + type: object + id: ScanRunWarningTrace + description: >- + Output only. Defines a warning trace message for ScanRun. Warning traces + provide customers with useful information that helps make the scanning + process more effective. + ListScanConfigsResponse: + type: object + description: Response for the `ListScanConfigs` method. + properties: + nextPageToken: + type: string + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + scanConfigs: + type: array + description: The list of ScanConfigs returned. + items: + $ref: '#/components/schemas/ScanConfig' + id: ListScanConfigsResponse + CustomAccount: + type: object + id: CustomAccount + properties: + password: + description: >- + Required. Input only. The password of the custom account. The + credential is stored encrypted and not returned in any response nor + included in audit logs. + type: string + username: + description: Required. The user name of the custom account. + type: string + loginUrl: + description: Required. The login form URL of the website. + type: string + description: Describes authentication configuration that uses a custom account. Empty: + type: object properties: {} id: Empty description: >- @@ -678,300 +584,370 @@ components: 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); } + ListFindingsResponse: + id: ListFindingsResponse type: object - CustomAccount: properties: - username: + findings: + items: + $ref: '#/components/schemas/Finding' + description: The list of Findings returned. + type: array + nextPageToken: type: string - description: Required. The user name of the custom account. + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + description: Response for the `ListFindings` method. + CrawledUrl: + id: CrawledUrl + properties: + body: + type: string + description: Output only. The body of the request that was used to visit the URL. + httpMethod: + type: string + description: >- + Output only. The http method of the request that was used to visit + the URL, in uppercase. + url: + description: Output only. The URL that was crawled. + type: string + description: >- + A CrawledUrl resource represents a URL that was crawled during a + ScanRun. Web Security Scanner Service crawls the web applications, + following all links within the scope of sites, to find the URLs to test + against. + type: object + GoogleAccount: + deprecated: true + id: GoogleAccount + description: Describes authentication configuration that uses a Google account. + properties: password: type: string description: >- - Required. Input only. The password of the custom account. The + Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. - loginUrl: - description: Required. The login form URL of the website. + username: + type: string + description: Required. The user name of the Google account. + type: object + VulnerableHeaders: + description: Information about vulnerable or missing HTTP Headers. + properties: + headers: + items: + $ref: '#/components/schemas/Header' + type: array + description: List of vulnerable headers. + missingHeaders: + type: array + description: List of missing headers. + items: + $ref: '#/components/schemas/Header' + id: VulnerableHeaders + type: object + ViolatingResource: + type: object + description: >- + Information regarding any resource causing the vulnerability such as + JavaScript sources, image, audio files, etc. + properties: + resourceUrl: + description: URL of this violating resource. + type: string + contentType: + type: string + description: The MIME type of this resource. + id: ViolatingResource + ListScanRunsResponse: + id: ListScanRunsResponse + properties: + scanRuns: + type: array + items: + $ref: '#/components/schemas/ScanRun' + description: The list of ScanRuns returned. + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + type: object + description: Response for the `ListScanRuns` method. + OutdatedLibrary: + type: object + properties: + learnMoreUrls: + description: >- + URLs to learn more information about the vulnerabilities in the + library. + type: array + items: + type: string + version: + type: string + description: The version number. + libraryName: + description: The name of the outdated library. + type: string + id: OutdatedLibrary + description: Information reported for an outdated library. + Schedule: + type: object + id: Schedule + properties: + intervalDurationDays: + description: Required. The duration of time between executions in days. + format: int32 + type: integer + scheduleTime: + description: >- + A timestamp indicates when the next run will be scheduled. The value + is refreshed by the server after each run. If unspecified, it will + default to current server time, which means the scan will be + scheduled to start immediately. + format: google-datetime type: string - type: object - id: CustomAccount - description: Describes authentication configuration that uses a custom account. - ListCrawledUrlsResponse: + description: Scan schedule configuration. + ListFindingTypeStatsResponse: type: object properties: - crawledUrls: - description: The list of CrawledUrls returned. - type: array + findingTypeStats: items: - $ref: '#/components/schemas/CrawledUrl' - nextPageToken: + $ref: '#/components/schemas/FindingTypeStats' + type: array + description: The list of FindingTypeStats returned. + description: Response for the `ListFindingTypeStats` method. + id: ListFindingTypeStatsResponse + Header: + type: object + description: Describes a HTTP Header. + id: Header + properties: + name: + description: Header name. + type: string + value: + description: Header value. type: string - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - description: Response for the `ListCrawledUrls` method. - id: ListCrawledUrlsResponse FindingTypeStats: type: object - id: FindingTypeStats properties: findingCount: format: int32 description: Output only. The count of findings belonging to this finding type. type: integer findingType: - description: Output only. The finding type associated with the stats. type: string + description: Output only. The finding type associated with the stats. description: >- A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun. - VulnerableHeaders: - description: Information about vulnerable or missing HTTP Headers. + id: FindingTypeStats + ScanRun: + id: ScanRun type: object - id: VulnerableHeaders properties: - missingHeaders: - type: array - description: List of missing headers. - items: - $ref: '#/components/schemas/Header' - headers: + endTime: + description: >- + Output only. The time at which the ScanRun reached termination state + - that the ScanRun is either finished or stopped by user. + type: string + format: google-datetime + hasVulnerabilities: + description: Output only. Whether the scan run has found any vulnerabilities. + type: boolean + warningTraces: + description: >- + Output only. A list of warnings, if such are encountered during this + scan run. items: - $ref: '#/components/schemas/Header' + $ref: '#/components/schemas/ScanRunWarningTrace' type: array - description: List of vulnerable headers. - ScanConfigError: - description: >- - Defines a custom error message used by CreateScanConfig and - UpdateScanConfig APIs when scan configuration validation fails. It is - also reported as part of a ScanRunErrorTrace message if scan validation - fails due to a scan configuration error. - id: ScanConfigError - type: object - properties: - fieldName: + progressPercent: description: >- - Output only. Indicates the full name of the ScanConfig field that - triggers this error, for example "scan_config.max_qps". This field - is provided for troubleshooting purposes only and its actual value - can change in the future. + Output only. The percentage of total completion ranging from 0 to + 100. If the scan is in queue, the value is 0. If the scan is + running, the value ranges from 0 to 100. If the scan is finished, + the value is 100. + format: int32 + type: integer + urlsTestedCount: + format: int64 + description: >- + Output only. The number of URLs tested during this ScanRun. If the + scan is in progress, the value represents the number of URLs tested + up to now. The number of URLs tested is usually larger than the + number URLS crawled because typically a crawled URL is tested with + multiple test payloads. + type: string + executionState: + description: Output only. The execution state of the ScanRun. type: string - code: enumDescriptions: - - There is no error. - - There is no error. - - >- - Indicates an internal server error. Please DO NOT USE THIS ERROR - CODE unless the root cause is truly unknown. - - >- - One of the seed URLs is an App Engine URL but we cannot validate - the scan settings due to an App Engine API backend error. - - >- - One of the seed URLs is an App Engine URL but we cannot access the - App Engine API to validate scan settings. - - >- - One of the seed URLs is an App Engine URL but the Default Host of - the App Engine is not set. - - Google corporate accounts can not be used for scanning. - - The account of the scan creator can not be used for scanning. - - >- - This scan targets Compute Engine, but we cannot validate scan - settings due to a Compute Engine API backend error. - - >- - This scan targets Compute Engine, but we cannot access the Compute - Engine API to validate the scan settings. - - The Custom Login URL does not belong to the current project. - - The Custom Login URL is malformed (can not be parsed). - >- - The Custom Login URL is mapped to a non-routable IP address in - DNS. - - >- - The Custom Login URL is mapped to an IP address which is not - reserved for the current project. - - The Custom Login URL has a non-routable IP address. - - >- - The Custom Login URL has an IP address which is not reserved for - the current project. - - Another scan with the same name (case-sensitive) already exists. - - A field is set to an invalid value. - - There was an error trying to authenticate to the scan target. - - Finding type value is not specified in the list findings request. - - >- - Scan targets Compute Engine, yet current project was not - whitelisted for Google Compute Engine Scanning Alpha access. - - User tries to update managed scan - - >- - The supplied filter is malformed. For example, it can not be - parsed, does not have a filter type in expression, or the same - filter type appears more than once. - - The supplied resource name is malformed (can not be parsed). - - The current project is not in an active state. - - A required field is not set. - - >- - Project id, scanconfig id, scanrun id, or finding id are not - consistent with each other in resource name. - - The scan being requested to start is already running. - - The scan that was requested to be stopped is not running. - - One of the seed URLs does not belong to the current project. - - One of the seed URLs is malformed (can not be parsed). - - >- - One of the seed URLs is mapped to a non-routable IP address in - DNS. - - >- - One of the seed URLs is mapped to an IP address which is not - reserved for the current project. - - One of the seed URLs has on-routable IP address. - - >- - One of the seed URLs has an IP address that is not reserved for - the current project. - - >- - The Web Security Scanner service account is not configured under - the project. - - A project has reached the maximum number of scans. - - Resolving the details of the current project fails. - - One or more blacklist patterns were in the wrong format. - - The supplied filter is not supported. - - >- - The supplied finding type is not supported. For example, we do not - provide findings of the given finding type. - - >- - The URL scheme of one or more of the supplied URLs is not - supported. - - CAI is not able to list assets. + Represents an invalid state caused by internal server error. This + value should never be returned. + - The scan is waiting in the queue. + - The scan is in progress. + - The scan is either finished or stopped by user. enum: - - CODE_UNSPECIFIED - - OK - - INTERNAL_ERROR - - APPENGINE_API_BACKEND_ERROR - - APPENGINE_API_NOT_ACCESSIBLE - - APPENGINE_DEFAULT_HOST_MISSING - - CANNOT_USE_GOOGLE_COM_ACCOUNT - - CANNOT_USE_OWNER_ACCOUNT - - COMPUTE_API_BACKEND_ERROR - - COMPUTE_API_NOT_ACCESSIBLE - - CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT - - CUSTOM_LOGIN_URL_MALFORMED - - CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS - - CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS - - CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS - - CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS - - DUPLICATE_SCAN_NAME - - INVALID_FIELD_VALUE - - FAILED_TO_AUTHENTICATE_TO_TARGET - - FINDING_TYPE_UNSPECIFIED - - FORBIDDEN_TO_SCAN_COMPUTE - - FORBIDDEN_UPDATE_TO_MANAGED_SCAN - - MALFORMED_FILTER - - MALFORMED_RESOURCE_NAME - - PROJECT_INACTIVE - - REQUIRED_FIELD - - RESOURCE_NAME_INCONSISTENT - - SCAN_ALREADY_RUNNING - - SCAN_NOT_RUNNING - - SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT - - SEED_URL_MALFORMED - - SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS - - SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS - - SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS - - SEED_URL_HAS_UNRESERVED_IP_ADDRESS - - SERVICE_ACCOUNT_NOT_CONFIGURED - - TOO_MANY_SCANS - - UNABLE_TO_RESOLVE_PROJECT_INFO - - UNSUPPORTED_BLACKLIST_PATTERN_FORMAT - - UNSUPPORTED_FILTER - - UNSUPPORTED_FINDING_TYPE - - UNSUPPORTED_URL_SCHEME - - CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND + - EXECUTION_STATE_UNSPECIFIED + - QUEUED + - SCANNING + - FINISHED + resultState: + type: string + description: >- + Output only. The result state of the ScanRun. This field is only + available after the execution state reaches "FINISHED". + enum: + - RESULT_STATE_UNSPECIFIED + - SUCCESS + - ERROR + - KILLED + enumDescriptions: + - >- + Default value. This value is returned when the ScanRun is not yet + finished. + - The scan finished without errors. + - The scan finished with errors. + - The scan was terminated by user. + urlsCrawledCount: + type: string + format: int64 + description: >- + Output only. The number of URLs crawled during this ScanRun. If the + scan is in progress, the value represents the number of URLs crawled + up to now. + startTime: + description: Output only. The time at which the ScanRun started. + format: google-datetime type: string - description: Output only. Indicates the reason code for a configuration failure. - Form: + name: + description: >- + Output only. The resource name of the ScanRun. The name follows the + format of + 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + The ScanRun IDs are generated by the system. + type: string + errorTrace: + description: >- + Output only. If result_state is an ERROR, this field provides the + primary reason for scan's termination and more details, if such are + available. + $ref: '#/components/schemas/ScanRunErrorTrace' + description: >- + A ScanRun is a output-only resource representing an actual run of the + scan. Next id: 12 + IapTestServiceAccountInfo: + id: IapTestServiceAccountInfo properties: - fields: - type: array - description: '! The names of form fields related to the vulnerability.' - items: - type: string - actionUri: - description: '! The URI where to send the form when it''s submitted.' + targetAudienceClientId: type: string - description: '! Information about a vulnerability with an HTML.' - id: Form - type: object - Xxe: + description: >- + Required. Describes OAuth2 client id of resources protected by + Identity-Aware-Proxy (IAP). type: object + description: >- + Describes authentication configuration when Web-Security-Scanner service + account is added in Identity-Aware-Proxy (IAP) access policies. + ListCrawledUrlsResponse: properties: - payloadValue: - type: string + crawledUrls: + description: The list of CrawledUrls returned. + items: + $ref: '#/components/schemas/CrawledUrl' + type: array + nextPageToken: description: >- - The XML string that triggered the XXE vulnerability. Non-payload - values might be redacted. - payloadLocation: - enumDescriptions: - - Unknown Location. - - The XML payload replaced the complete request body. - enum: - - LOCATION_UNSPECIFIED - - COMPLETE_REQUEST_BODY - description: Location within the request where the payload was placed. + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - id: Xxe - description: Information reported for an XXE. - ListFindingTypeStatsResponse: - description: Response for the `ListFindingTypeStats` method. - id: ListFindingTypeStatsResponse + type: object + description: Response for the `ListCrawledUrls` method. + id: ListCrawledUrlsResponse + VulnerableParameters: + id: VulnerableParameters + type: object + description: Information about vulnerable request parameters. properties: - findingTypeStats: + parameterNames: + description: The vulnerable parameter names. type: array - description: The list of FindingTypeStats returned. items: - $ref: '#/components/schemas/FindingTypeStats' - type: object - Header: - id: Header + type: string + ScanRunErrorTrace: properties: - name: - type: string - description: Header name. - value: + mostCommonHttpErrorCode: + type: integer + description: >- + Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field + indicates the most common HTTP error code, if such is available. For + example, if this code is 404, the scan has encountered too many + NOT_FOUND responses. + format: int32 + scanConfigError: + $ref: '#/components/schemas/ScanConfigError' + description: >- + Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this + field has the error message encountered during scan configuration + validation that is performed before each scan run. + code: + enum: + - CODE_UNSPECIFIED + - INTERNAL_ERROR + - SCAN_CONFIG_ISSUE + - AUTHENTICATION_CONFIG_ISSUE + - TIMED_OUT_WHILE_SCANNING + - TOO_MANY_REDIRECTS + - TOO_MANY_HTTP_ERRORS + - STARTING_URLS_CRAWL_HTTP_ERRORS + description: Output only. Indicates the error reason code. + enumDescriptions: + - Default value is never used. + - >- + Indicates that the scan run failed due to an internal server + error. + - >- + Indicates a scan configuration error, usually due to outdated + ScanConfig settings, such as starting_urls or the DNS + configuration. + - >- + Indicates an authentication error, usually due to outdated + ScanConfig authentication settings. + - >- + Indicates a scan operation timeout, usually caused by a very large + site. + - >- + Indicates that a scan encountered excessive redirects, either to + authentication or some other page outside of the scan scope. + - >- + Indicates that a scan encountered numerous errors from the web + site pages. When available, most_common_http_error_code field + indicates the most common HTTP error code encountered during the + scan. + - >- + Indicates that some of the starting web urls returned HTTP errors + during the scan. type: string - description: Header value. - description: Describes a HTTP Header. + description: Output only. Defines an error trace message for a ScanRun. + id: ScanRunErrorTrace type: object parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: uploadType + name: prettyPrint schema: - 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. + type: boolean + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: key + name: oauth_token schema: type: string callback: @@ -980,15 +956,6 @@ components: name: callback schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string alt: description: Data format for response. in: query @@ -999,60 +966,58 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: upload_protocol + name: quotaUser schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: prettyPrint + name: uploadType schema: - type: boolean - x-stackQL-resources: - scan_runs: - id: google.websecurityscanner.scan_runs - name: scan_runs - title: Scan_runs - methods: - stop: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}:stop/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.scanRuns - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/scan_runs/methods/get' - - $ref: '#/components/x-stackQL-resources/scan_runs/methods/list' - insert: [] - update: [] - replace: [] - delete: [] + 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. + in: query + name: key + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: findings: id: google.websecurityscanner.findings name: findings @@ -1120,18 +1085,46 @@ components: update: [] replace: [] delete: [] - scan_configs: - id: google.websecurityscanner.scan_configs - name: scan_configs - title: Scan_configs + scan_runs: + id: google.websecurityscanner.scan_runs + name: scan_runs + title: Scan_runs methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.scanRuns + stop: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}:stop/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scan_runs/methods/get' + - $ref: '#/components/x-stackQL-resources/scan_runs/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + scan_configs: + id: google.websecurityscanner.scan_configs + name: scan_configs + title: Scan_configs + methods: patch: operation: $ref: >- @@ -1146,6 +1139,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/get' @@ -1178,27 +1178,22 @@ components: delete: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/delete' paths: - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: parameters: &ref_1 - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - post: - description: Stops a ScanRun. The stopped ScanRun is returned. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.stop - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StopScanRunRequest' + - $ref: '#/components/parameters/_.xgafv' + get: + description: List Findings under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1210,7 +1205,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/ListFindingsResponse' parameters: - in: path name: projectsId @@ -1227,11 +1222,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}: parameters: *ref_1 get: - description: Gets a ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.get + description: Gets a Finding. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1243,7 +1251,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/Finding' parameters: - in: path name: projectsId @@ -1260,13 +1268,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns: + - in: path + name: findingsId + required: true + schema: + type: string + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: parameters: *ref_1 get: - description: >- - Lists ScanRuns under a given ScanConfig, in descending order of ScanRun - stop time. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.list + description: List CrawledUrls under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1278,7 +1289,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListScanRunsResponse' + $ref: '#/components/schemas/ListCrawledUrlsResponse' parameters: - in: path name: projectsId @@ -1290,8 +1301,9 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: scanRunsId + required: true schema: type: string - in: query @@ -1299,11 +1311,15 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: parameters: *ref_1 get: - description: List Findings under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list + description: List all FindingTypeStats under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1315,7 +1331,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingsResponse' + $ref: '#/components/schemas/ListFindingTypeStatsResponse' parameters: - in: path name: projectsId @@ -1332,24 +1348,11 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: parameters: *ref_1 get: - description: Gets a Finding. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.get + description: Gets a ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1361,7 +1364,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Finding' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId @@ -1378,16 +1381,13 @@ paths: required: true schema: type: string - - in: path - name: findingsId - required: true - schema: - type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns: parameters: *ref_1 get: - description: List CrawledUrls under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list + description: >- + Lists ScanRuns under a given ScanConfig, in descending order of ScanRun + stop time. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1399,7 +1399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCrawledUrlsResponse' + $ref: '#/components/schemas/ListScanRunsResponse' parameters: - in: path name: projectsId @@ -1411,11 +1411,6 @@ paths: required: true schema: type: string - - in: path - name: scanRunsId - required: true - schema: - type: string - in: query name: pageToken schema: @@ -1425,11 +1420,16 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop: parameters: *ref_1 - get: - description: List all FindingTypeStats under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list + post: + description: Stops a ScanRun. The stopped ScanRun is returned. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StopScanRunRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1441,7 +1441,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingTypeStatsResponse' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId @@ -1460,9 +1460,16 @@ paths: type: string /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}: parameters: *ref_1 - get: - description: Gets a ScanConfig. - operationId: websecurityscanner.projects.scanConfigs.get + patch: + description: >- + Updates a ScanConfig. This method support partial update of a + ScanConfig. + operationId: websecurityscanner.projects.scanConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScanConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1486,16 +1493,14 @@ paths: required: true schema: type: string - patch: - description: >- - Updates a ScanConfig. This method support partial update of a - ScanConfig. - operationId: websecurityscanner.projects.scanConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ScanConfig' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an existing ScanConfig and its child resources. + operationId: websecurityscanner.projects.scanConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1507,7 +1512,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanConfig' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -1519,14 +1524,9 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes an existing ScanConfig and its child resources. - operationId: websecurityscanner.projects.scanConfigs.delete + get: + description: Gets a ScanConfig. + operationId: websecurityscanner.projects.scanConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1538,7 +1538,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ScanConfig' parameters: - in: path name: projectsId diff --git a/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml b/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml index 084640a9..07e154ee 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml @@ -7,8 +7,8 @@ info: title: Workflow Executions API description: Execute workflows created with Workflows API. version: v1 - x-discovery-doc-revision: '20240827' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240903' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/workflows servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml b/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml index 04f40d07..1f1a477e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml @@ -9,8 +9,8 @@ info: Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API. version: v1 - x-discovery-doc-revision: '20240821' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/workflows servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml index bf15a60b..62b03c0e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml @@ -11,7 +11,7 @@ info: practices and recommendations. version: v1 x-discovery-doc-revision: '20240731' - x-generated-date: '2024-09-13' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/workload-manager/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml b/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml index 0b8709b4..f85772c0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml @@ -9,8 +9,8 @@ info: Allows administrators to create managed developer environments in the cloud. version: v1 - x-discovery-doc-revision: '20240821' - x-generated-date: '2024-09-13' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/workstations servers: @@ -464,15 +464,15 @@ components: format: google-duration maxUsableWorkstations: description: >- - Optional. Maximum number of workstations under this config a user - can have `workstations.workstation.use` permission on. Only enforced - on CreateWorkstation API calls on the user issuing the API request. - Can be overridden by: - granting a user + Optional. Maximum number of workstations under this configuration a + user can have `workstations.workstation.use` permission on. Only + enforced on CreateWorkstation API calls on the user issuing the API + request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` - permission on that workstation. If not specified defaults to 0 which - indicates unlimited. + permission on that workstation. If not specified, defaults to `0`, + which indicates unlimited. type: integer format: int32 host: @@ -554,7 +554,7 @@ components: audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output - logging](http://cloud/workstations/docs/container-output-logging#overview). + logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" From d616104b852f7f46d571461f17269ff9ec9b343f Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 19 Sep 2024 16:18:03 +1000 Subject: [PATCH 2/2] updated google --- .../services/accesscontextmanager.yaml | 2 +- .../services/addressvalidation.yaml | 1744 +- .../services/advisorynotifications.yaml | 558 +- .../v00.00.00000/services/aiplatform.yaml | 60603 ++++++++-------- .../v00.00.00000/services/airquality.yaml | 1384 +- .../v00.00.00000/services/apigee.yaml | 27118 +++---- .../v00.00.00000/services/apikeys.yaml | 710 +- .../services/assuredworkloads.yaml | 2140 +- .../v00.00.00000/services/billingbudgets.yaml | 824 +- .../v00.00.00000/services/cloudbuild.yaml | 4382 +- .../services/cloudcommerceprocurement.yaml | 1022 +- .../v00.00.00000/services/cloudsupport.yaml | 1493 +- .../v00.00.00000/services/compute.yaml | 20 +- .../services/contactcenterinsights.yaml | 9516 +-- .../services/containeranalysis.yaml | 10210 +-- .../services/contentwarehouse.yaml | 9530 +-- .../v00.00.00000/services/dataflow.yaml | 2 +- .../v00.00.00000/services/datalineage.yaml | 1646 +- .../v00.00.00000/services/datapipelines.yaml | 1470 +- .../v00.00.00000/services/dlp.yaml | 17560 ++--- .../v00.00.00000/services/documentai.yaml | 8992 +-- .../services/essentialcontacts.yaml | 702 +- .../v00.00.00000/services/iam.yaml | 680 +- .../v00.00.00000/services/iamv2.yaml | 38 +- .../v00.00.00000/services/iap.yaml | 2 +- .../v00.00.00000/services/integrations.yaml | 19846 ++--- .../v00.00.00000/services/kmsinventory.yaml | 1148 +- .../v00.00.00000/services/language.yaml | 7598 +- .../v00.00.00000/services/libraryagent.yaml | 202 +- .../services/networkconnectivity.yaml | 106 +- .../v00.00.00000/services/orgpolicy.yaml | 1414 +- .../v00.00.00000/services/places.yaml | 3560 +- .../v00.00.00000/services/policyanalyzer.yaml | 172 +- .../services/policysimulator.yaml | 3284 +- .../services/policytroubleshooter.yaml | 980 +- .../v00.00.00000/services/pollen.yaml | 716 +- .../services/prod_tt_sasportal.yaml | 4116 +- .../services/recaptchaenterprise.yaml | 4090 +- .../v00.00.00000/services/recommender.yaml | 2606 +- .../services/resourcesettings.yaml | 558 +- .../v00.00.00000/services/run.yaml | 13 +- .../v00.00.00000/services/sasportal.yaml | 3804 +- .../services/serviceconsumermanagement.yaml | 6656 +- .../services/servicenetworking.yaml | 7914 +- .../v00.00.00000/services/serviceusage.yaml | 6392 +- .../v00.00.00000/services/solar.yaml | 1336 +- .../v00.00.00000/services/vmmigration.yaml | 2 +- .../v00.00.00000/services/webrisk.yaml | 880 +- .../services/websecurityscanner.yaml | 1378 +- 49 files changed, 120531 insertions(+), 120588 deletions(-) diff --git a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml index 38cbd13b..2aeafd34 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml @@ -17,7 +17,7 @@ info: Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters. version: v1 - x-discovery-doc-revision: '20240916' + x-discovery-doc-revision: '20240908' x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/access-context-manager/docs/reference/rest/ diff --git a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml index a945d3ea..fec8544e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml @@ -26,12 +26,12 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform: >- - See, edit, configure, and delete your Google Cloud data and see - the email address for your Google Account. https://www.googleapis.com/auth/maps-platform.addressvalidation: >- Private Service: https://www.googleapis.com/auth/maps-platform.addressvalidation + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -41,156 +41,388 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleMapsAddressvalidationV1ValidateAddressResponse: + GoogleMapsAddressvalidationV1ComponentName: + description: A wrapper for the name of the component. + id: GoogleMapsAddressvalidationV1ComponentName type: object - id: GoogleMapsAddressvalidationV1ValidateAddressResponse - description: The response to an address validation request. properties: - result: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' - description: The result of the address validation. - responseId: + languageCode: type: string description: >- - The UUID that identifies this response. If the address needs to be - re-validated, this UUID *must* accompany the new request. + The BCP-47 language code. This will not be present if the component + name is not associated with a language, such as a street number. + text: + type: string + description: >- + The name text. For example, "5th Avenue" for a street name or "1253" + for a street number. + GoogleTypeLatLng: + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. + properties: + longitude: + type: number + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + format: double + latitude: + format: double + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: number + id: GoogleTypeLatLng + type: object GoogleMapsAddressvalidationV1UspsAddress: - id: GoogleMapsAddressvalidationV1UspsAddress + description: USPS representation of a US address. + type: object properties: city: - description: City name. type: string + description: City name. firm: - description: Firm name. - type: string - firstAddressLine: - description: First address line. type: string - secondAddressLine: + description: Firm name. + state: + description: 2 letter state code. type: string - description: Second address line. - zipCodeExtension: + urbanization: type: string - description: 4-digit postal code extension e.g. 5023. + description: Puerto Rican urbanization name. zipCode: type: string description: Postal code e.g. 10009. - state: - description: 2 letter state code. - type: string cityStateZipAddressLine: + type: string description: City + state + postal code. + secondAddressLine: + description: Second address line. type: string - urbanization: - description: Puerto Rican urbanization name. + zipCodeExtension: + description: 4-digit postal code extension e.g. 5023. type: string - type: object - description: USPS representation of a US address. - GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: - description: The request for sending validation feedback. + firstAddressLine: + type: string + description: First address line. + id: GoogleMapsAddressvalidationV1UspsAddress + GoogleMapsAddressvalidationV1Geocode: + id: GoogleMapsAddressvalidationV1Geocode properties: - conclusion: - enum: - - VALIDATION_CONCLUSION_UNSPECIFIED - - VALIDATED_VERSION_USED - - USER_VERSION_USED - - UNVALIDATED_VERSION_USED - - UNUSED - enumDescriptions: - - >- - This value is unused. If the - `ProvideValidationFeedbackRequest.conclusion` field is set to - `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error - will be returned. - - >- - The version of the address returned by the Address Validation API - was used for the transaction. - - >- - The version of the address provided by the user was used for the - transaction - - >- - A version of the address that was entered after the last - validation attempt but that was not re-validated was used for the - transaction. - - The transaction was abandoned and the address was not used. + bounds: + $ref: '#/components/schemas/GoogleGeoTypeViewport' + description: The bounds of the geocoded place. + location: + $ref: '#/components/schemas/GoogleTypeLatLng' description: >- - Required. The outcome of the sequence of validation attempts. If - this field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an - `INVALID_ARGUMENT` error will be returned. - type: string - responseId: + The geocoded location of the input. Using place IDs is preferred + over using addresses, latitude/longitude coordinates, or plus codes. + Using coordinates when routing or calculating driving directions + will always result in the point being snapped to the road nearest to + those coordinates. This may not be a road that will quickly or + safely lead to the destination and may not be near an access point + to the property. Additionally, when a location is reverse geocoded, + there is no guarantee that the returned address will match the + original. + placeId: + description: >- + The PlaceID of the place this input geocodes to. For more + information about Place IDs see + [here](https://developers.google.com/maps/documentation/places/web-service/place-id). type: string + plusCode: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' + description: The plus code corresponding to the `location`. + placeTypes: description: >- - Required. The ID of the response that this feedback is for. This - should be the response_id from the first response in a series of - address validation attempts. - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest - type: object - GoogleTypePostalAddress: - type: object - properties: - recipients: - type: array + The type(s) of place that the input geocoded to. For example, + `['locality', 'political']`. The full list of types can be found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). items: type: string + type: array + featureSizeMeters: + type: number description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. - organization: - description: Optional. The name of the organization at the address. + The size of the geocoded place, in meters. This is another measure + of the coarseness of the geocoded location, but in physical size + rather than in semantic meaning. + format: float + type: object + description: Contains information about the place the input was geocoded to. + GoogleMapsAddressvalidationV1UspsData: + properties: + standardizedAddress: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' + description: USPS standardized address. + ewsNoMatch: + description: >- + The delivery address is matchable, but the EWS file indicates that + an exact match will be available soon. + type: boolean + pmbDesignator: type: string - revision: + description: PMB (Private Mail Box) unit designator. + dpvNoStatReasonCode: + format: int32 description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. + Indicates the NoStat type. Returns a reason code as int. * `1`: IDA + (Internal Drop Address) – Addresses that do not receive mail + directly from the USPS but are delivered to a drop address that + services them. * `2`: CDS - Addresses that have not yet become + deliverable. For example, a new subdivision where lots and primary + numbers have been determined, but no structure exists yet for + occupancy. * `3`: Collision - Addresses that do not actually DPV + confirm. * `4`: CMZ (College, Military and Other Types) - ZIP + 4 + records USPS has incorporated into the data. * `5`: Regular - + Indicates addresses not receiving delivery and the addresses are not + counted as possible deliveries. * `6`: Secondary Required - The + address requires secondary information. type: integer - format: int32 - languageCode: + dpvFootnote: description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + The footnotes from delivery point validation. Multiple footnotes may + be strung together in the same string. * `AA`: Input address matched + to the ZIP+4 file * `A1`: Input address was not matched to the ZIP+4 + file * `BB`: Matched to DPV (all components) * `CC`: Secondary + number not matched and not required * `C1`: Secondary number not + matched but required * `N1`: High-rise address missing secondary + number * `M1`: Primary number missing * `M3`: Primary number invalid + * `P1`: Input address PO, RR or HC box number missing * `P3`: Input + address PO, RR, or HC Box number invalid * `F1`: Input address + matched to a military address * `G1`: Input address matched to a + general delivery address * `U1`: Input address matched to a unique + ZIP code * `PB`: Input address matched to PBSA record * `RR`: DPV + confirmed address with PMB information * `R1`: DPV confirmed address + without PMB information * `R7`: Carrier Route R777 or R779 record * + `IA`: Informed Address identified * `TA`: Primary number matched by + dropping a trailing alpha type: string - sublocality: + dpvNoSecureLocation: type: string description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - sortingCode: - description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). + Flag indicates door is accessible, but package will not be left due + to security concerns. Returns a single character. * `Y`: The package + will not be left due to security concerns. * `N`: No indication the + package will not be left due to security concerns. + abbreviatedCity: + description: Abbreviated city. type: string - postalCode: + defaultAddress: description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). + Indicator that a default address was found, but more specific + addresses exists. + type: boolean + deliveryPointCheckDigit: type: string - addressLines: - items: - type: string description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for + The delivery point check digit. This number is added to the end of + the delivery_point_barcode for mechanically scanned mail. Adding all + the digits of the delivery_point_barcode, + delivery_point_check_digit, postal code, and ZIP+4 together should + yield a number divisible by 10. + elotFlag: + type: string + description: eLOT Ascending/Descending Flag (A/D). + lacsLinkIndicator: + description: LACSLink indicator. + type: string + postOfficeState: + description: Main post office state. + type: string + fipsCountyCode: + description: FIPS county code. + type: string + pmbNumber: + type: string + description: PMB (Private Mail Box) number; + poBoxOnlyPostalCode: + description: PO Box only postal code. + type: boolean + dpvVacant: + type: string + description: >- + Is this place vacant? Returns a single character. * `Y`: The address + is vacant * `N`: The address is not vacant + dpvNoStat: + description: >- + Is this a no stat address or an active address? No stat addresses + are ones which are not continuously occupied or addresses that the + USPS does not service. Returns a single character. * `Y`: The + address is not active * `N`: The address is active + type: string + errorMessage: + description: >- + Error message for USPS data retrieval. This is populated when USPS + processing is suspended because of the detection of artificially + created addresses. The USPS data fields might not be populated when + this error is present. + type: string + carrierRouteIndicator: + type: string + description: Carrier route rate sort indicator. + cassProcessed: + type: boolean + description: Indicator that the request has been CASS processed. + deliveryPointCode: + type: string + description: 2 digit delivery point code + addressRecordType: + description: >- + Type of the address record that matches the input address. * `F`: + FIRM. This is a match to a Firm Record, which is the finest level of + match available for an address. * `G`: GENERAL DELIVERY. This is a + match to a General Delivery record. * `H`: BUILDING / APARTMENT. + This is a match to a Building or Apartment record. * `P`: POST + OFFICE BOX. This is a match to a Post Office Box. * `R`: RURAL ROUTE + or HIGHWAY CONTRACT: This is a match to either a Rural Route or a + Highway Contract record, both of which may have associated Box + Number ranges. * `S`: STREET RECORD: This is a match to a Street + record containing a valid primary number range. + type: string + dpvEnhancedDeliveryCode: + description: >- + Indicates that more than one DPV return code is valid for the + address. Returns a single character. * `Y`: Address was DPV + confirmed for primary and any secondary numbers. * `N`: Primary and + any secondary number information failed to DPV confirm. * `S`: + Address was DPV confirmed for the primary number only, and the + secondary number information was present but not confirmed, or a + single trailing alpha on a primary number was dropped to make a DPV + match and secondary information required. * `D`: Address was DPV + confirmed for the primary number only, and the secondary number + information was missing. * `R`: Address confirmed but assigned to + phantom route R777 and R779 and USPS delivery is not provided. + type: string + elotNumber: + type: string + description: Enhanced Line of Travel (eLOT) number. + county: + description: County name. + type: string + dpvThrowback: + type: string + description: >- + Indicates that mail is not delivered to the street address. Returns + a single character. * `Y`: The mail is not delivered to the street + address. * `N`: The mail is delivered to the street address. + dpvNonDeliveryDays: + description: >- + Flag indicates mail delivery is not performed every day of the week. + Returns a single character. * `Y`: The mail delivery is not + performed every day of the week. * `N`: No indication the mail + delivery is not performed every day of the week. + type: string + dpvDrop: + description: >- + Flag indicates mail is delivered to a single receptable at a site. + Returns a single character. * `Y`: The mail is delivered to a single + receptable at a site. * `N`: The mail is not delivered to a single + receptable at a site. + type: string + dpvCmra: + type: string + description: >- + Indicates if the address is a CMRA (Commercial Mail Receiving + Agency)--a private business receiving mail for clients. Returns a + single character. * `Y`: The address is a CMRA * `N`: The address is + not a CMRA + dpvPbsa: + description: >- + Indicates the address was matched to PBSA record. Returns a single + character. * `Y`: The address was matched to PBSA record. * `N`: The + address was not matched to PBSA record. + type: string + dpvDoorNotAccessible: + type: string + description: >- + Flag indicates addresses where USPS cannot knock on a door to + deliver mail. Returns a single character. * `Y`: The door is not + accessible. * `N`: No indication the door is not accessible. + postOfficeCity: + type: string + description: Main post office city. + suitelinkFootnote: + description: >- + Footnotes from matching a street or highrise record to suite + information. If business name match is found, the secondary number + is returned. * `A`: SuiteLink record match, business address + improved. * `00`: No match, business address is not improved. + type: string + dpvNonDeliveryDaysValues: + format: int32 + type: integer + description: >- + Integer identifying non-delivery days. It can be interrogated using + bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a + non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – + Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery + day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a + non-delivery day + lacsLinkReturnCode: + description: LACSLink return code. + type: string + carrierRoute: + description: >- + The carrier route code. A four character code consisting of a one + letter prefix and a three digit route designator. Prefixes: * `C`: + Carrier route (or city route) * `R`: Rural route * `H`: Highway + Contract Route * `B`: Post Office Box Section * `G`: General + delivery unit + type: string + dpvConfirmation: + description: >- + The possible values for DPV confirmation. Returns a single character + or returns no value. * `N`: Primary and any secondary number + information failed to DPV confirm. * `D`: Address was DPV confirmed + for the primary number only, and the secondary number information + was missing. * `S`: Address was DPV confirmed for the primary number + only, and the secondary number information was present but not + confirmed. * `Y`: Address was DPV confirmed for primary and any + secondary numbers. * Empty: If the response does not contain a + `dpv_confirmation` value, the address was not submitted for DPV + confirmation. + type: string + type: object + id: GoogleMapsAddressvalidationV1UspsData + description: >- + The USPS data for the address. `uspsData` is not guaranteed to be fully + populated for every US or PR address sent to the Address Validation API. + It's recommended to integrate the backup address fields in the response + if you utilize uspsData as the primary part of the response. + GoogleTypePostalAddress: + id: GoogleTypePostalAddress + type: object + description: >- + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 + properties: + sortingCode: + type: string + description: >- + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). + addressLines: + description: >- + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (e.g. "Austin, TX"), it is important that the line order is + clear. The order of address lines should be "envelope order" for the + country/region of the address. In places where this can vary (e.g. + Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of @@ -203,13 +435,54 @@ components: recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + items: + type: string type: array + revision: + format: int32 + type: integer + description: >- + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. locality: + type: string description: >- Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. + languageCode: + description: >- + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + type: string + sublocality: + type: string + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + regionCode: + description: >- + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + type: string + postalCode: + description: >- + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (e.g. state/zip validation in the U.S.A.). type: string administrativeArea: type: string @@ -221,217 +494,165 @@ components: "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. - regionCode: + organization: type: string + description: Optional. The name of the organization at the address. + recipients: description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. - description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - id: GoogleTypePostalAddress - GoogleMapsAddressvalidationV1PlusCode: - id: GoogleMapsAddressvalidationV1PlusCode - description: >- - Plus code (http://plus.codes) is a location reference with two formats: - global code defining a 14mx14m (1/8000th of a degree) or smaller - rectangle, and compound code, replacing the prefix with a reference - location. + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. + type: array + items: + type: string + GoogleMapsAddressvalidationV1Address: + id: GoogleMapsAddressvalidationV1Address type: object + description: >- + Details of the post-processed address. Post-processing includes + correcting misspelled parts of the address, replacing incorrect parts, + and inferring missing parts. properties: - compoundCode: - type: string + missingComponentTypes: description: >- - Place's compound code, such as "33GV+HQ, Ramberg, Norway", - containing the suffix of the global code and replacing the prefix - with a formatted name of a reference entity. - globalCode: + The types of components that were expected to be present in a + correctly formatted mailing address but were not found in the input + AND could not be inferred. Components of this type are not present + in `formatted_address`, `postal_address`, or `address_components`. + An example might be `['street_number', 'route']` for an input like + "Boulder, Colorado, 80301, USA". The list of possible types can be + found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + items: + type: string + type: array + unconfirmedComponentTypes: description: >- - Place's global (full) code, such as "9FWM33GV+HQ", representing an - 1/8000 by 1/8000 degree area (~14 by 14 meters). - type: string - GoogleGeoTypeViewport: - description: >- - A latitude-longitude viewport, represented as two diagonally opposite - `low` and `high` points. A viewport is considered a closed region, i.e. - it includes its boundary. The latitude bounds must range between -90 to - 90 degrees inclusive, and the longitude bounds must range between -180 - to 180 degrees inclusive. Various cases include: - If `low` = `high`, - the viewport consists of that single point. - If `low.longitude` > - `high.longitude`, the longitude range is inverted (the viewport crosses - the 180 degree longitude line). - If `low.longitude` = -180 degrees and - `high.longitude` = 180 degrees, the viewport includes all longitudes. - - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, - the longitude range is empty. - If `low.latitude` > `high.latitude`, the - latitude range is empty. Both `low` and `high` must be populated, and - the represented box cannot be empty (as specified by the definitions - above). An empty viewport will result in an error. For example, this - viewport fully encloses New York City: { "low": { "latitude": 40.477398, - "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": - -73.70018 } } - type: object - properties: - high: - description: Required. The high point of the viewport. - $ref: '#/components/schemas/GoogleTypeLatLng' - low: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The low point of the viewport. - id: GoogleGeoTypeViewport - GoogleTypeLatLng: - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - type: object - properties: - longitude: - format: double - type: number - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - latitude: - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - type: number - format: double - id: GoogleTypeLatLng - GoogleMapsAddressvalidationV1ValidateAddressRequest: - id: GoogleMapsAddressvalidationV1ValidateAddressRequest - properties: - previousResponseId: + The types of the components that are present in the + `address_components` but could not be confirmed to be correct. This + field is provided for the sake of convenience: its contents are + equivalent to iterating through the `address_components` to find the + types of all the components where the confirmation_level is not + CONFIRMED or the inferred flag is not set to `true`. The list of + possible types can be found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + type: array + items: + type: string + formattedAddress: type: string description: >- - This field must be empty for the first address validation request. - If more requests are necessary to fully validate a single address - (for example if the changes the user makes after the initial - validation need to be re-validated), then each followup request must - populate this field with the response_id from the very first - response in the validation sequence. - enableUspsCass: - description: >- - Enables USPS CASS compatible mode. This affects _only_ the - [google.maps.addressvalidation.v1.ValidationResult.usps_data] field - of [google.maps.addressvalidation.v1.ValidationResult]. Note: for - USPS CASS enabled requests for addresses in Puerto Rico, a - [google.type.PostalAddress.region_code] of the `address` must be - provided as "PR", or an - [google.type.PostalAddress.administrative_area] of the `address` - must be provided as "Puerto Rico" (case-insensitive) or "PR". It's - recommended to use a componentized `address`, or alternatively - specify at least two [google.type.PostalAddress.address_lines] where - the first line contains the street number and name and the second - line contains the city, state, and zip code. - type: boolean - languageOptions: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1LanguageOptions' + The post-processed address, formatted as a single-line address + following the address formatting rules of the region where the + address is located. + addressComponents: + items: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressComponent' description: >- - Optional. Preview: This feature is in Preview (pre-GA). Pre-GA - products and features might have limited support, and changes to - pre-GA products and features might not be compatible with other - pre-GA versions. Pre-GA Offerings are covered by the [Google Maps - Platform Service Specific - Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). - For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). - Enables the Address Validation API to include additional information - in the response. - address: + Unordered list. The individual address components of the formatted + and corrected address, along with validation information. This + provides information on the validation status of the individual + components. Address components are not ordered in a particular way. + Do not make any assumptions on the ordering of the address + components in the list. + type: array + unresolvedTokens: + type: array + items: + type: string description: >- - Required. The address being validated. Unformatted addresses should - be submitted via `address_lines`. The total length of the fields in - this input must not exceed 280 characters. Supported regions can be - found - [here](https://developers.google.com/maps/documentation/address-validation/coverage). - The language_code value in the input address is reserved for future - uses and is ignored today. The validated address result will be - populated based on the preferred language for the given address, as - identified by the system. The Address Validation API ignores the - values in recipients and organization. Any values in those fields - will be discarded and not returned. Please do not set them. + Any tokens in the input that could not be resolved. This might be an + input that was not recognized as a valid part of an address (for + example in an input like "123235253253 Main St, San Francisco, CA, + 94105", the unresolved tokens may look like `["123235253253"]` since + that does not look like a valid street number. + postalAddress: + description: The post-processed address represented as a postal address. $ref: '#/components/schemas/GoogleTypePostalAddress' - sessionToken: - type: string - description: >- - Optional. A string which identifies an Autocomplete session for - billing purposes. Must be a URL and filename safe base64 string with - at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT - error is returned. The session begins when the user makes an - Autocomplete query, and concludes when they select a place and a - call to Place Details or Address Validation is made. Each session - can have multiple Autocomplete queries, followed by one Place - Details or Address Validation request. The credentials used for each - request within a session must belong to the same Google Cloud - Console project. Once a session has concluded, the token is no - longer valid; your app must generate a fresh token for each session. - If the `sessionToken` parameter is omitted, or if you reuse a - session token, the session is charged as if no session token was - provided (each request is billed separately). Note: Address - Validation can only be used in sessions with the Autocomplete (New) - API, not the Autocomplete API. See - https://developers.google.com/maps/documentation/places/web-service/session-pricing - for more details. - description: The request for validating an address. - type: object - GoogleMapsAddressvalidationV1Verdict: - id: GoogleMapsAddressvalidationV1Verdict - description: High level overview of the address validation result and geocode. + GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: + description: >- + The response for validation feedback. The response is empty if the + feedback is sent successfully. + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse type: object + properties: {} + GoogleMapsAddressvalidationV1AddressComponent: + description: Represents an address component, such as a street, city, or state. properties: - addressComplete: + replaced: description: >- - The address is considered complete if there are no unresolved - tokens, no unexpected or missing address components. If unset, - indicates that the value is `false`. See `missing_component_types`, - `unresolved_tokens` or `unexpected` fields for more details. + Indicates the name of the component was replaced with a completely + different one, for example a wrong postal code being replaced with + one that is correct for the address. This is not a cosmetic change, + the input component has been changed to a different one. type: boolean - geocodeGranularity: - description: >- - Information about the granularity of the `geocode`. This can be - understood as the semantic meaning of how coarse or fine the - geocoded location is. This can differ from the - `validation_granularity` above occasionally. For example, our - database might record the existence of an apartment number but do - not have a precise location for the apartment within a big apartment - complex. In that case, the `validation_granularity` will be - `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`. + confirmationLevel: enumDescriptions: - Default value. This value is unused. - - Below-building level result, such as an apartment. - - Building-level result. - - >- - A geocode that approximates the building-level location of the - address. - >- - The address or geocode indicates a block. Only used in regions - which have block-level addressing, such as Japan. + We were able to verify that this component exists and makes sense + in the context of the rest of the address. - >- - The geocode or address is granular to route, such as a street, - road, or highway. + This component could not be confirmed, but it is plausible that it + exists. For example, a street number within a known valid range of + numbers on a street where specific house numbers are not known. - >- - All other granularities, which are bucketed together since they - are not deliverable. - type: string + This component was not confirmed and is likely to be wrong. For + example, a neighborhood that does not fit the rest of the address. + description: >- + Indicates the level of certainty that we have that the component is + correct. enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER - inputGranularity: + - CONFIRMATION_LEVEL_UNSPECIFIED + - CONFIRMED + - UNCONFIRMED_BUT_PLAUSIBLE + - UNCONFIRMED_AND_SUSPICIOUS + type: string + componentType: + description: >- + The type of the address component. See [Table 2: Additional types + returned by the Places + service](https://developers.google.com/places/web-service/supported_types#table2) + for a list of possible types. + type: string + unexpected: + type: boolean + description: >- + Indicates an address component that is not expected to be present in + a postal address for the given region. We have retained it only + because it was part of the input. + componentName: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' + description: The name for this component. + spellCorrected: + type: boolean + description: >- + Indicates a correction to a misspelling in the component name. The + API does not always flag changes from one spelling variant to + another, such as when changing "centre" to "center". It also does + not always flag common misspellings, such as when changing + "Amphitheater Pkwy" to "Amphitheatre Pkwy". + inferred: + type: boolean + description: >- + Indicates that the component was not part of the input, but we + inferred it for the address location and believe it should be + provided for a complete address. + id: GoogleMapsAddressvalidationV1AddressComponent + type: object + GoogleMapsAddressvalidationV1Verdict: + description: High level overview of the address validation result and geocode. + type: object + id: GoogleMapsAddressvalidationV1Verdict + properties: + addressComplete: + description: >- + The address is considered complete if there are no unresolved + tokens, no unexpected or missing address components. If unset, + indicates that the value is `false`. See `missing_component_types`, + `unresolved_tokens` or `unexpected` fields for more details. + type: boolean + validationGranularity: enumDescriptions: - Default value. This value is unused. - Below-building level result, such as an apartment. @@ -448,6 +669,14 @@ components: - >- All other granularities, which are bucketed together since they are not deliverable. + type: string + description: >- + The granularity level that the API can fully **validate** the + address to. For example, an `validation_granularity` of `PREMISE` + indicates all address components at the level of `PREMISE` or more + coarse can be validated. Per address component validation result can + be found in + [google.maps.addressvalidation.v1.Address.address_components]. enum: - GRANULARITY_UNSPECIFIED - SUB_PREMISE @@ -456,31 +685,14 @@ components: - BLOCK - ROUTE - OTHER - description: >- - The granularity of the **input** address. This is the result of - parsing the input address and does not give any validation signals. - For validation signals, refer to `validation_granularity` below. For - example, if the input address includes a specific apartment number, - then the `input_granularity` here will be `SUB_PREMISE`. If we - cannot match the apartment number in the databases or the apartment - number is invalid, the `validation_granularity` will likely be - `PREMISE` or below. - type: string hasUnconfirmedComponents: + type: boolean description: >- At least one address component cannot be categorized or validated, see [google.maps.addressvalidation.v1.Address.address_components] for details. - type: boolean - validationGranularity: + inputGranularity: type: string - description: >- - The granularity level that the API can fully **validate** the - address to. For example, an `validation_granularity` of `PREMISE` - indicates all address components at the level of `PREMISE` or more - coarse can be validated. Per address component validation result can - be found in - [google.maps.addressvalidation.v1.Address.address_components]. enum: - GRANULARITY_UNSPECIFIED - SUB_PREMISE @@ -505,552 +717,340 @@ components: - >- All other granularities, which are bucketed together since they are not deliverable. + description: >- + The granularity of the **input** address. This is the result of + parsing the input address and does not give any validation signals. + For validation signals, refer to `validation_granularity` below. For + example, if the input address includes a specific apartment number, + then the `input_granularity` here will be `SUB_PREMISE`. If we + cannot match the apartment number in the databases or the apartment + number is invalid, the `validation_granularity` will likely be + `PREMISE` or below. hasInferredComponents: - type: boolean description: >- At least one address component was inferred (added) that wasn't in the input, see [google.maps.addressvalidation.v1.Address.address_components] for details. - hasReplacedComponents: - description: >- - At least one address component was replaced, see - [google.maps.addressvalidation.v1.Address.address_components] for - details. - type: boolean - GoogleMapsAddressvalidationV1AddressMetadata: - id: GoogleMapsAddressvalidationV1AddressMetadata - type: object - description: >- - The metadata for the address. `metadata` is not guaranteed to be fully - populated for every address sent to the Address Validation API. - properties: - residential: - description: >- - Indicates that this is the address of a residence. If unset, - indicates that the value is unknown. - type: boolean - poBox: - type: boolean - description: >- - Indicates that the address of a PO box. If unset, indicates that the - value is unknown. - business: - type: boolean - description: >- - Indicates that this is the address of a business. If unset, - indicates that the value is unknown. - GoogleMapsAddressvalidationV1Geocode: - id: GoogleMapsAddressvalidationV1Geocode - description: Contains information about the place the input was geocoded to. - type: object - properties: - bounds: - description: The bounds of the geocoded place. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - placeTypes: - items: - type: string - type: array - description: >- - The type(s) of place that the input geocoded to. For example, - `['locality', 'political']`. The full list of types can be found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - plusCode: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' - description: The plus code corresponding to the `location`. - placeId: - type: string - description: >- - The PlaceID of the place this input geocodes to. For more - information about Place IDs see - [here](https://developers.google.com/maps/documentation/places/web-service/place-id). - location: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: >- - The geocoded location of the input. Using place IDs is preferred - over using addresses, latitude/longitude coordinates, or plus codes. - Using coordinates when routing or calculating driving directions - will always result in the point being snapped to the road nearest to - those coordinates. This may not be a road that will quickly or - safely lead to the destination and may not be near an access point - to the property. Additionally, when a location is reverse geocoded, - there is no guarantee that the returned address will match the - original. - featureSizeMeters: - format: float - type: number - description: >- - The size of the geocoded place, in meters. This is another measure - of the coarseness of the geocoded location, but in physical size - rather than in semantic meaning. - GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse - properties: {} - description: >- - The response for validation feedback. The response is empty if the - feedback is sent successfully. - type: object - GoogleMapsAddressvalidationV1AddressComponent: - properties: - componentName: - description: The name for this component. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' - replaced: - description: >- - Indicates the name of the component was replaced with a completely - different one, for example a wrong postal code being replaced with - one that is correct for the address. This is not a cosmetic change, - the input component has been changed to a different one. - type: boolean - inferred: - type: boolean - description: >- - Indicates that the component was not part of the input, but we - inferred it for the address location and believe it should be - provided for a complete address. - spellCorrected: - description: >- - Indicates a correction to a misspelling in the component name. The - API does not always flag changes from one spelling variant to - another, such as when changing "centre" to "center". It also does - not always flag common misspellings, such as when changing - "Amphitheater Pkwy" to "Amphitheatre Pkwy". - type: boolean - unexpected: type: boolean - description: >- - Indicates an address component that is not expected to be present in - a postal address for the given region. We have retained it only - because it was part of the input. - componentType: - description: >- - The type of the address component. See [Table 2: Additional types - returned by the Places - service](https://developers.google.com/places/web-service/supported_types#table2) - for a list of possible types. + geocodeGranularity: type: string - confirmationLevel: enumDescriptions: - Default value. This value is unused. + - Below-building level result, such as an apartment. + - Building-level result. - >- - We were able to verify that this component exists and makes sense - in the context of the rest of the address. + A geocode that approximates the building-level location of the + address. - >- - This component could not be confirmed, but it is plausible that it - exists. For example, a street number within a known valid range of - numbers on a street where specific house numbers are not known. + The address or geocode indicates a block. Only used in regions + which have block-level addressing, such as Japan. - >- - This component was not confirmed and is likely to be wrong. For - example, a neighborhood that does not fit the rest of the address. - enum: - - CONFIRMATION_LEVEL_UNSPECIFIED - - CONFIRMED - - UNCONFIRMED_BUT_PLAUSIBLE - - UNCONFIRMED_AND_SUSPICIOUS - type: string - description: >- - Indicates the level of certainty that we have that the component is - correct. - description: Represents an address component, such as a street, city, or state. - type: object - id: GoogleMapsAddressvalidationV1AddressComponent - GoogleMapsAddressvalidationV1ComponentName: - id: GoogleMapsAddressvalidationV1ComponentName - properties: - text: - type: string - description: >- - The name text. For example, "5th Avenue" for a street name or "1253" - for a street number. - languageCode: - type: string - description: >- - The BCP-47 language code. This will not be present if the component - name is not associated with a language, such as a street number. - description: A wrapper for the name of the component. - type: object - GoogleMapsAddressvalidationV1ValidationResult: - id: GoogleMapsAddressvalidationV1ValidationResult - type: object - description: The result of validating an address. - properties: - uspsData: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' - description: >- - Extra deliverability flags provided by USPS. Only provided in region - `US` and `PR`. - englishLatinAddress: - description: >- - Preview: This feature is in Preview (pre-GA). Pre-GA products and - features might have limited support, and changes to pre-GA products - and features might not be compatible with other pre-GA versions. - Pre-GA Offerings are covered by the [Google Maps Platform Service - Specific - Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). - For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). The - address translated to English. Translated addresses are not reusable - as API input. The service provides them so that the user can use - their native language to confirm or deny the validation of the - originally-provided address. If part of the address doesn't have an - English translation, the service returns that part in an alternate - language that uses a Latin script. See - [here](https://developers.google.com/maps/documentation/address-validation/convert-addresses-english) - for an explanation of how the alternate language is selected. If - part of the address doesn't have any translations or - transliterations in a language that uses a Latin script, the service - returns that part in the local language associated with the address. - Enable this output by using the - [google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address] - flag. Note: the - [google.maps.addressvalidation.v1.Address.unconfirmed_component_types] - field in the `english_latin_address` and the - [google.maps.addressvalidation.v1.AddressComponent.confirmation_level] - fields in `english_latin_address.address_components` are not - populated. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' - geocode: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' - description: >- - Information about the location and place that the address geocoded - to. - metadata: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressMetadata' - description: >- - Other information relevant to deliverability. `metadata` is not - guaranteed to be fully populated for every address sent to the - Address Validation API. - verdict: - description: Overall verdict flags - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' - address: - description: Information about the address itself as opposed to the geocode. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' - GoogleMapsAddressvalidationV1LanguageOptions: - properties: - returnEnglishLatinAddress: - type: boolean - description: >- - Preview: Return a [google.maps.addressvalidation.v1.Address] in - English. See - [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] - for details. - type: object - description: >- - Preview: This feature is in Preview (pre-GA). Pre-GA products and - features might have limited support, and changes to pre-GA products and - features might not be compatible with other pre-GA versions. Pre-GA - Offerings are covered by the [Google Maps Platform Service Specific - Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). - For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). Enables - the Address Validation API to include additional information in the - response. - id: GoogleMapsAddressvalidationV1LanguageOptions - GoogleMapsAddressvalidationV1UspsData: - id: GoogleMapsAddressvalidationV1UspsData - properties: - ewsNoMatch: - type: boolean - description: >- - The delivery address is matchable, but the EWS file indicates that - an exact match will be available soon. - cassProcessed: - type: boolean - description: Indicator that the request has been CASS processed. - dpvDoorNotAccessible: - description: >- - Flag indicates addresses where USPS cannot knock on a door to - deliver mail. Returns a single character. * `Y`: The door is not - accessible. * `N`: No indication the door is not accessible. - type: string - dpvCmra: - type: string - description: >- - Indicates if the address is a CMRA (Commercial Mail Receiving - Agency)--a private business receiving mail for clients. Returns a - single character. * `Y`: The address is a CMRA * `N`: The address is - not a CMRA - deliveryPointCode: - type: string - description: 2 digit delivery point code - addressRecordType: - description: >- - Type of the address record that matches the input address. * `F`: - FIRM. This is a match to a Firm Record, which is the finest level of - match available for an address. * `G`: GENERAL DELIVERY. This is a - match to a General Delivery record. * `H`: BUILDING / APARTMENT. - This is a match to a Building or Apartment record. * `P`: POST - OFFICE BOX. This is a match to a Post Office Box. * `R`: RURAL ROUTE - or HIGHWAY CONTRACT: This is a match to either a Rural Route or a - Highway Contract record, both of which may have associated Box - Number ranges. * `S`: STREET RECORD: This is a match to a Street - record containing a valid primary number range. - type: string - lacsLinkIndicator: - type: string - description: LACSLink indicator. - dpvNoStatReasonCode: - type: integer - format: int32 - description: >- - Indicates the NoStat type. Returns a reason code as int. * `1`: IDA - (Internal Drop Address) – Addresses that do not receive mail - directly from the USPS but are delivered to a drop address that - services them. * `2`: CDS - Addresses that have not yet become - deliverable. For example, a new subdivision where lots and primary - numbers have been determined, but no structure exists yet for - occupancy. * `3`: Collision - Addresses that do not actually DPV - confirm. * `4`: CMZ (College, Military and Other Types) - ZIP + 4 - records USPS has incorporated into the data. * `5`: Regular - - Indicates addresses not receiving delivery and the addresses are not - counted as possible deliveries. * `6`: Secondary Required - The - address requires secondary information. - dpvFootnote: - description: >- - The footnotes from delivery point validation. Multiple footnotes may - be strung together in the same string. * `AA`: Input address matched - to the ZIP+4 file * `A1`: Input address was not matched to the ZIP+4 - file * `BB`: Matched to DPV (all components) * `CC`: Secondary - number not matched and not required * `C1`: Secondary number not - matched but required * `N1`: High-rise address missing secondary - number * `M1`: Primary number missing * `M3`: Primary number invalid - * `P1`: Input address PO, RR or HC box number missing * `P3`: Input - address PO, RR, or HC Box number invalid * `F1`: Input address - matched to a military address * `G1`: Input address matched to a - general delivery address * `U1`: Input address matched to a unique - ZIP code * `PB`: Input address matched to PBSA record * `RR`: DPV - confirmed address with PMB information * `R1`: DPV confirmed address - without PMB information * `R7`: Carrier Route R777 or R779 record * - `IA`: Informed Address identified * `TA`: Primary number matched by - dropping a trailing alpha - type: string - standardizedAddress: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' - description: USPS standardized address. - dpvEnhancedDeliveryCode: - description: >- - Indicates that more than one DPV return code is valid for the - address. Returns a single character. * `Y`: Address was DPV - confirmed for primary and any secondary numbers. * `N`: Primary and - any secondary number information failed to DPV confirm. * `S`: - Address was DPV confirmed for the primary number only, and the - secondary number information was present but not confirmed, or a - single trailing alpha on a primary number was dropped to make a DPV - match and secondary information required. * `D`: Address was DPV - confirmed for the primary number only, and the secondary number - information was missing. * `R`: Address confirmed but assigned to - phantom route R777 and R779 and USPS delivery is not provided. - type: string - dpvNonDeliveryDays: - type: string + The geocode or address is granular to route, such as a street, + road, or highway. + - >- + All other granularities, which are bucketed together since they + are not deliverable. description: >- - Flag indicates mail delivery is not performed every day of the week. - Returns a single character. * `Y`: The mail delivery is not - performed every day of the week. * `N`: No indication the mail - delivery is not performed every day of the week. - carrierRoute: - type: string + Information about the granularity of the `geocode`. This can be + understood as the semantic meaning of how coarse or fine the + geocoded location is. This can differ from the + `validation_granularity` above occasionally. For example, our + database might record the existence of an apartment number but do + not have a precise location for the apartment within a big apartment + complex. In that case, the `validation_granularity` will be + `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`. + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER + hasReplacedComponents: description: >- - The carrier route code. A four character code consisting of a one - letter prefix and a three digit route designator. Prefixes: * `C`: - Carrier route (or city route) * `R`: Rural route * `H`: Highway - Contract Route * `B`: Post Office Box Section * `G`: General - delivery unit - poBoxOnlyPostalCode: + At least one address component was replaced, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. + type: boolean + GoogleMapsAddressvalidationV1LanguageOptions: + type: object + properties: + returnEnglishLatinAddress: type: boolean - description: PO Box only postal code. - dpvNoSecureLocation: description: >- - Flag indicates door is accessible, but package will not be left due - to security concerns. Returns a single character. * `Y`: The package - will not be left due to security concerns. * `N`: No indication the - package will not be left due to security concerns. - type: string - county: - type: string - description: County name. - suitelinkFootnote: + Preview: Return a [google.maps.addressvalidation.v1.Address] in + English. See + [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] + for details. + id: GoogleMapsAddressvalidationV1LanguageOptions + description: >- + Preview: This feature is in Preview (pre-GA). Pre-GA products and + features might have limited support, and changes to pre-GA products and + features might not be compatible with other pre-GA versions. Pre-GA + Offerings are covered by the [Google Maps Platform Service Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). Enables + the Address Validation API to include additional information in the + response. + GoogleMapsAddressvalidationV1ValidateAddressRequest: + description: The request for validating an address. + properties: + sessionToken: description: >- - Footnotes from matching a street or highrise record to suite - information. If business name match is found, the secondary number - is returned. * `A`: SuiteLink record match, business address - improved. * `00`: No match, business address is not improved. - type: string - elotNumber: + Optional. A string which identifies an Autocomplete session for + billing purposes. Must be a URL and filename safe base64 string with + at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT + error is returned. The session begins when the user makes an + Autocomplete query, and concludes when they select a place and a + call to Place Details or Address Validation is made. Each session + can have multiple Autocomplete queries, followed by one Place + Details or Address Validation request. The credentials used for each + request within a session must belong to the same Google Cloud + Console project. Once a session has concluded, the token is no + longer valid; your app must generate a fresh token for each session. + If the `sessionToken` parameter is omitted, or if you reuse a + session token, the session is charged as if no session token was + provided (each request is billed separately). Note: Address + Validation can only be used in sessions with the Autocomplete (New) + API, not the Autocomplete API. See + https://developers.google.com/maps/documentation/places/web-service/session-pricing + for more details. type: string - description: Enhanced Line of Travel (eLOT) number. - dpvPbsa: + languageOptions: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1LanguageOptions' description: >- - Indicates the address was matched to PBSA record. Returns a single - character. * `Y`: The address was matched to PBSA record. * `N`: The - address was not matched to PBSA record. - type: string - defaultAddress: + Optional. Preview: This feature is in Preview (pre-GA). Pre-GA + products and features might have limited support, and changes to + pre-GA products and features might not be compatible with other + pre-GA versions. Pre-GA Offerings are covered by the [Google Maps + Platform Service Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). + Enables the Address Validation API to include additional information + in the response. + enableUspsCass: description: >- - Indicator that a default address was found, but more specific - addresses exists. + Enables USPS CASS compatible mode. This affects _only_ the + [google.maps.addressvalidation.v1.ValidationResult.usps_data] field + of [google.maps.addressvalidation.v1.ValidationResult]. Note: for + USPS CASS enabled requests for addresses in Puerto Rico, a + [google.type.PostalAddress.region_code] of the `address` must be + provided as "PR", or an + [google.type.PostalAddress.administrative_area] of the `address` + must be provided as "Puerto Rico" (case-insensitive) or "PR". It's + recommended to use a componentized `address`, or alternatively + specify at least two [google.type.PostalAddress.address_lines] where + the first line contains the street number and name and the second + line contains the city, state, and zip code. type: boolean - postOfficeCity: - description: Main post office city. - type: string - dpvThrowback: + address: + $ref: '#/components/schemas/GoogleTypePostalAddress' description: >- - Indicates that mail is not delivered to the street address. Returns - a single character. * `Y`: The mail is not delivered to the street - address. * `N`: The mail is delivered to the street address. - type: string - dpvDrop: + Required. The address being validated. Unformatted addresses should + be submitted via `address_lines`. The total length of the fields in + this input must not exceed 280 characters. Supported regions can be + found + [here](https://developers.google.com/maps/documentation/address-validation/coverage). + The language_code value in the input address is reserved for future + uses and is ignored today. The validated address result will be + populated based on the preferred language for the given address, as + identified by the system. The Address Validation API ignores the + values in recipients and organization. Any values in those fields + will be discarded and not returned. Please do not set them. + previousResponseId: description: >- - Flag indicates mail is delivered to a single receptable at a site. - Returns a single character. * `Y`: The mail is delivered to a single - receptable at a site. * `N`: The mail is not delivered to a single - receptable at a site. - type: string - elotFlag: - description: eLOT Ascending/Descending Flag (A/D). - type: string - errorMessage: + This field must be empty for the first address validation request. + If more requests are necessary to fully validate a single address + (for example if the changes the user makes after the initial + validation need to be re-validated), then each followup request must + populate this field with the response_id from the very first + response in the validation sequence. type: string + id: GoogleMapsAddressvalidationV1ValidateAddressRequest + type: object + GoogleMapsAddressvalidationV1AddressMetadata: + properties: + poBox: + type: boolean description: >- - Error message for USPS data retrieval. This is populated when USPS - processing is suspended because of the detection of artificially - created addresses. The USPS data fields might not be populated when - this error is present. - dpvVacant: + Indicates that the address of a PO box. If unset, indicates that the + value is unknown. + residential: description: >- - Is this place vacant? Returns a single character. * `Y`: The address - is vacant * `N`: The address is not vacant - type: string - dpvNoStat: + Indicates that this is the address of a residence. If unset, + indicates that the value is unknown. + type: boolean + business: + type: boolean description: >- - Is this a no stat address or an active address? No stat addresses - are ones which are not continuously occupied or addresses that the - USPS does not service. Returns a single character. * `Y`: The - address is not active * `N`: The address is active - type: string - lacsLinkReturnCode: - description: LACSLink return code. - type: string - pmbNumber: - description: PMB (Private Mail Box) number; - type: string - fipsCountyCode: - description: FIPS county code. - type: string - deliveryPointCheckDigit: + Indicates that this is the address of a business. If unset, + indicates that the value is unknown. + description: >- + The metadata for the address. `metadata` is not guaranteed to be fully + populated for every address sent to the Address Validation API. + type: object + id: GoogleMapsAddressvalidationV1AddressMetadata + GoogleMapsAddressvalidationV1PlusCode: + type: object + properties: + compoundCode: description: >- - The delivery point check digit. This number is added to the end of - the delivery_point_barcode for mechanically scanned mail. Adding all - the digits of the delivery_point_barcode, - delivery_point_check_digit, postal code, and ZIP+4 together should - yield a number divisible by 10. + Place's compound code, such as "33GV+HQ, Ramberg, Norway", + containing the suffix of the global code and replacing the prefix + with a formatted name of a reference entity. type: string - dpvNonDeliveryDaysValues: - format: int32 - type: integer + globalCode: description: >- - Integer identifying non-delivery days. It can be interrogated using - bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a - non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – - Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery - day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a - non-delivery day - carrierRouteIndicator: - type: string - description: Carrier route rate sort indicator. - abbreviatedCity: - description: Abbreviated city. + Place's global (full) code, such as "9FWM33GV+HQ", representing an + 1/8000 by 1/8000 degree area (~14 by 14 meters). type: string - postOfficeState: + id: GoogleMapsAddressvalidationV1PlusCode + description: >- + Plus code (http://plus.codes) is a location reference with two formats: + global code defining a 14mx14m (1/8000th of a degree) or smaller + rectangle, and compound code, replacing the prefix with a reference + location. + GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest + type: object + description: The request for sending validation feedback. + properties: + responseId: type: string - description: Main post office state. - pmbDesignator: - description: PMB (Private Mail Box) unit designator. + description: >- + Required. The ID of the response that this feedback is for. This + should be the response_id from the first response in a series of + address validation attempts. + conclusion: + enum: + - VALIDATION_CONCLUSION_UNSPECIFIED + - VALIDATED_VERSION_USED + - USER_VERSION_USED + - UNVALIDATED_VERSION_USED + - UNUSED type: string - dpvConfirmation: + description: >- + Required. The outcome of the sequence of validation attempts. If + this field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an + `INVALID_ARGUMENT` error will be returned. + enumDescriptions: + - >- + This value is unused. If the + `ProvideValidationFeedbackRequest.conclusion` field is set to + `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error + will be returned. + - >- + The version of the address returned by the Address Validation API + was used for the transaction. + - >- + The version of the address provided by the user was used for the + transaction + - >- + A version of the address that was entered after the last + validation attempt but that was not re-validated was used for the + transaction. + - The transaction was abandoned and the address was not used. + GoogleMapsAddressvalidationV1ValidateAddressResponse: + description: The response to an address validation request. + id: GoogleMapsAddressvalidationV1ValidateAddressResponse + properties: + responseId: type: string description: >- - The possible values for DPV confirmation. Returns a single character - or returns no value. * `N`: Primary and any secondary number - information failed to DPV confirm. * `D`: Address was DPV confirmed - for the primary number only, and the secondary number information - was missing. * `S`: Address was DPV confirmed for the primary number - only, and the secondary number information was present but not - confirmed. * `Y`: Address was DPV confirmed for primary and any - secondary numbers. * Empty: If the response does not contain a - `dpv_confirmation` value, the address was not submitted for DPV - confirmation. + The UUID that identifies this response. If the address needs to be + re-validated, this UUID *must* accompany the new request. + result: + description: The result of the address validation. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' type: object - description: >- - The USPS data for the address. `uspsData` is not guaranteed to be fully - populated for every US or PR address sent to the Address Validation API. - It's recommended to integrate the backup address fields in the response - if you utilize uspsData as the primary part of the response. - GoogleMapsAddressvalidationV1Address: - id: GoogleMapsAddressvalidationV1Address - description: >- - Details of the post-processed address. Post-processing includes - correcting misspelled parts of the address, replacing incorrect parts, - and inferring missing parts. + GoogleMapsAddressvalidationV1ValidationResult: properties: - unconfirmedComponentTypes: - description: >- - The types of the components that are present in the - `address_components` but could not be confirmed to be correct. This - field is provided for the sake of convenience: its contents are - equivalent to iterating through the `address_components` to find the - types of all the components where the confirmation_level is not - CONFIRMED or the inferred flag is not set to `true`. The list of - possible types can be found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - items: - type: string - type: array - postalAddress: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: The post-processed address represented as a postal address. - unresolvedTokens: - items: - type: string + englishLatinAddress: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' description: >- - Any tokens in the input that could not be resolved. This might be an - input that was not recognized as a valid part of an address (for - example in an input like "123235253253 Main St, San Francisco, CA, - 94105", the unresolved tokens may look like `["123235253253"]` since - that does not look like a valid street number. - type: array - formattedAddress: - type: string + Preview: This feature is in Preview (pre-GA). Pre-GA products and + features might have limited support, and changes to pre-GA products + and features might not be compatible with other pre-GA versions. + Pre-GA Offerings are covered by the [Google Maps Platform Service + Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). The + address translated to English. Translated addresses are not reusable + as API input. The service provides them so that the user can use + their native language to confirm or deny the validation of the + originally-provided address. If part of the address doesn't have an + English translation, the service returns that part in an alternate + language that uses a Latin script. See + [here](https://developers.google.com/maps/documentation/address-validation/convert-addresses-english) + for an explanation of how the alternate language is selected. If + part of the address doesn't have any translations or + transliterations in a language that uses a Latin script, the service + returns that part in the local language associated with the address. + Enable this output by using the + [google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address] + flag. Note: the + [google.maps.addressvalidation.v1.Address.unconfirmed_component_types] + field in the `english_latin_address` and the + [google.maps.addressvalidation.v1.AddressComponent.confirmation_level] + fields in `english_latin_address.address_components` are not + populated. + geocode: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' description: >- - The post-processed address, formatted as a single-line address - following the address formatting rules of the region where the - address is located. - missingComponentTypes: + Information about the location and place that the address geocoded + to. + address: + description: Information about the address itself as opposed to the geocode. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' + uspsData: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' description: >- - The types of components that were expected to be present in a - correctly formatted mailing address but were not found in the input - AND could not be inferred. Components of this type are not present - in `formatted_address`, `postal_address`, or `address_components`. - An example might be `['street_number', 'route']` for an input like - "Boulder, Colorado, 80301, USA". The list of possible types can be - found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - type: array - items: - type: string - addressComponents: + Extra deliverability flags provided by USPS. Only provided in region + `US` and `PR`. + metadata: description: >- - Unordered list. The individual address components of the formatted - and corrected address, along with validation information. This - provides information on the validation status of the individual - components. Address components are not ordered in a particular way. - Do not make any assumptions on the ordering of the address - components in the list. - items: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressComponent' - type: array + Other information relevant to deliverability. `metadata` is not + guaranteed to be fully populated for every address sent to the + Address Validation API. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressMetadata' + verdict: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' + description: Overall verdict flags + type: object + id: GoogleMapsAddressvalidationV1ValidationResult + description: The result of validating an address. + GoogleGeoTypeViewport: + properties: + high: + description: Required. The high point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + low: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: Required. The low point of the viewport. + description: >- + A latitude-longitude viewport, represented as two diagonally opposite + `low` and `high` points. A viewport is considered a closed region, i.e. + it includes its boundary. The latitude bounds must range between -90 to + 90 degrees inclusive, and the longitude bounds must range between -180 + to 180 degrees inclusive. Various cases include: - If `low` = `high`, + the viewport consists of that single point. - If `low.longitude` > + `high.longitude`, the longitude range is inverted (the viewport crosses + the 180 degree longitude line). - If `low.longitude` = -180 degrees and + `high.longitude` = 180 degrees, the viewport includes all longitudes. - + If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, + the longitude range is empty. - If `low.latitude` > `high.latitude`, the + latitude range is empty. Both `low` and `high` must be populated, and + the represented box cannot be empty (as specified by the definitions + above). An empty viewport will result in an error. For example, this + viewport fully encloses New York City: { "low": { "latitude": 40.477398, + "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": + -73.70018 } } + id: GoogleGeoTypeViewport type: object parameters: prettyPrint: @@ -1059,21 +1059,22 @@ components: name: prettyPrint schema: type: boolean - 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. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: key + name: upload_protocol schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + alt: + description: Data format for response. in: query - name: uploadType + name: alt schema: type: string + enum: + - json + - media + - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -1083,34 +1084,18 @@ components: name: quotaUser schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. + callback: + description: JSONP in: query - name: fields + name: callback schema: type: string - alt: - description: Data format for response. + access_token: + description: OAuth access token. in: query - name: alt + name: access_token schema: type: string - enum: - - json - - media - - proto _.xgafv: description: V1 error format. in: query @@ -1120,16 +1105,31 @@ components: enum: - '1' - '2' - callback: - description: JSONP + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: callback + name: fields schema: type: string - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token + schema: + 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. + in: query + name: key + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string x-stackQL-resources: @@ -1160,16 +1160,16 @@ paths: /v1:validateAddress: parameters: &ref_1 - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' post: description: Validates an address. operationId: addressvalidation.validateAddress diff --git a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml index eac15767..49c82ecb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml @@ -34,75 +34,110 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAdvisorynotificationsV1CsvCsvRow: + GoogleCloudAdvisorynotificationsV1ListNotificationsResponse: type: object - description: A representation of a single data row in a CSV file. + description: Response of ListNotifications endpoint. + id: GoogleCloudAdvisorynotificationsV1ListNotificationsResponse properties: - entries: + notifications: + items: + $ref: >- + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + description: List of notifications under a given parent. type: array + nextPageToken: + type: string description: >- - The data entries in a CSV file row, as a string array rather than a - single comma-separated string. - items: - type: string - id: GoogleCloudAdvisorynotificationsV1CsvCsvRow + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + totalSize: + format: int32 + type: integer + description: Estimation of a total number of notifications. + GoogleCloudAdvisorynotificationsV1NotificationSettings: + id: GoogleCloudAdvisorynotificationsV1NotificationSettings + description: Settings for each NotificationType. + type: object + properties: + enabled: + description: Whether the associated NotificationType is enabled. + type: boolean GoogleCloudAdvisorynotificationsV1Settings: + description: Settings for Advisory Notifications. properties: + etag: + type: string + description: >- + Required. Fingerprint for optimistic concurrency returned in Get + requests. Must be provided for Update requests. If the value + provided does not match the value known to the server, ABORTED will + be thrown, and the client should retry the read-modify-write cycle. notificationSettings: + type: object additionalProperties: $ref: >- #/components/schemas/GoogleCloudAdvisorynotificationsV1NotificationSettings - type: object description: >- Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type. - etag: - type: string - description: >- - Required. Fingerprint for optimistic concurrency returned in Get - requests. Must be provided for Update requests. If the value - provided does not match the value known to the server, ABORTED will - be thrown, and the client should retry the read-modify-write cycle. name: description: >- Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. type: string - type: object - description: Settings for Advisory Notifications. id: GoogleCloudAdvisorynotificationsV1Settings - GoogleCloudAdvisorynotificationsV1NotificationSettings: - properties: - enabled: - type: boolean - description: Whether the associated NotificationType is enabled. type: object - description: Settings for each NotificationType. - id: GoogleCloudAdvisorynotificationsV1NotificationSettings GoogleCloudAdvisorynotificationsV1MessageBody: - id: GoogleCloudAdvisorynotificationsV1MessageBody + type: object + description: A message body containing text. properties: text: $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' description: The text content of the message body. + id: GoogleCloudAdvisorynotificationsV1MessageBody + GoogleCloudAdvisorynotificationsV1Text: type: object - description: A message body containing text. + properties: + localizedText: + description: The requested localized copy (if applicable). + type: string + enText: + type: string + description: The English copy. + localizationState: + description: Status of the localization. + type: string + enum: + - LOCALIZATION_STATE_UNSPECIFIED + - LOCALIZATION_STATE_NOT_APPLICABLE + - LOCALIZATION_STATE_PENDING + - LOCALIZATION_STATE_COMPLETED + enumDescriptions: + - Not used. + - >- + Localization is not applicable for requested language. This can + happen when: - The requested language was not supported by + Advisory Notifications at the time of localization (including + notifications created before the localization feature was + launched). - The requested language is English, so only the + English text is returned. + - >- + Localization for requested language is in progress, and not ready + yet. + - Localization for requested language is completed. + id: GoogleCloudAdvisorynotificationsV1Text + description: A text object containing the English text and its localized copies. GoogleCloudAdvisorynotificationsV1Notification: - description: >- - A notification object for notifying customers about security and privacy - issues. type: object properties: + createTime: + format: google-datetime + type: string + readOnly: true + description: Output only. Time the notification was created. notificationType: - enum: - - NOTIFICATION_TYPE_UNSPECIFIED - - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY - - NOTIFICATION_TYPE_SENSITIVE_ACTIONS - - NOTIFICATION_TYPE_SECURITY_MSA - - NOTIFICATION_TYPE_THREAT_HORIZONS - description: Type of notification enumDescriptions: - Default type - Security and privacy advisory notifications @@ -110,18 +145,20 @@ components: - General security MSA - Threat horizons MSA type: string + description: Type of notification + enum: + - NOTIFICATION_TYPE_UNSPECIFIED + - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY + - NOTIFICATION_TYPE_SENSITIVE_ACTIONS + - NOTIFICATION_TYPE_SECURITY_MSA + - NOTIFICATION_TYPE_THREAT_HORIZONS name: - type: string description: >- The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{project}/locations/{location}/notifications/{notification}. - createTime: - description: Output only. Time the notification was created. - readOnly: true type: string - format: google-datetime messages: description: A list of messages in the notification. items: @@ -130,153 +167,137 @@ components: subject: $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Subject' description: The subject line of the notification. + description: >- + A notification object for notifying customers about security and privacy + issues. id: GoogleCloudAdvisorynotificationsV1Notification - GoogleCloudAdvisorynotificationsV1Attachment: - type: object - id: GoogleCloudAdvisorynotificationsV1Attachment - properties: - csv: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' - description: A CSV file attachment. Max size is 10 MB. - displayName: - type: string - description: The title of the attachment. - description: Attachment with specific information about the issue. - GoogleCloudAdvisorynotificationsV1ListNotificationsResponse: - properties: - notifications: - description: List of notifications under a given parent. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification - nextPageToken: - type: string - 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. - totalSize: - format: int32 - description: Estimation of a total number of notifications. - type: integer - description: Response of ListNotifications endpoint. - type: object - id: GoogleCloudAdvisorynotificationsV1ListNotificationsResponse GoogleCloudAdvisorynotificationsV1Subject: + type: object + id: GoogleCloudAdvisorynotificationsV1Subject properties: text: $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' description: The text content. - type: object description: A subject line of a notification. - id: GoogleCloudAdvisorynotificationsV1Subject - GoogleCloudAdvisorynotificationsV1Csv: + GoogleCloudAdvisorynotificationsV1CsvCsvRow: + id: GoogleCloudAdvisorynotificationsV1CsvCsvRow + properties: + entries: + description: >- + The data entries in a CSV file row, as a string array rather than a + single comma-separated string. + items: + type: string + type: array type: object + description: A representation of a single data row in a CSV file. + GoogleCloudAdvisorynotificationsV1Csv: description: >- A representation of a CSV file attachment, as a list of column headers and a list of data rows. + type: object + id: GoogleCloudAdvisorynotificationsV1Csv properties: - headers: - items: - type: string - type: array - description: The list of headers for data columns in a CSV file. dataRows: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' description: >- The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string. + headers: + description: The list of headers for data columns in a CSV file. items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' + type: string type: array - id: GoogleCloudAdvisorynotificationsV1Csv - GoogleCloudAdvisorynotificationsV1Text: - description: A text object containing the English text and its localized copies. - type: object - properties: - localizedText: - type: string - description: The requested localized copy (if applicable). - localizationState: - description: Status of the localization. - enum: - - LOCALIZATION_STATE_UNSPECIFIED - - LOCALIZATION_STATE_NOT_APPLICABLE - - LOCALIZATION_STATE_PENDING - - LOCALIZATION_STATE_COMPLETED - enumDescriptions: - - Not used. - - >- - Localization is not applicable for requested language. This can - happen when: - The requested language was not supported by - Advisory Notifications at the time of localization (including - notifications created before the localization feature was - launched). - The requested language is English, so only the - English text is returned. - - >- - Localization for requested language is in progress, and not ready - yet. - - Localization for requested language is completed. - type: string - enText: - type: string - description: The English copy. - id: GoogleCloudAdvisorynotificationsV1Text GoogleCloudAdvisorynotificationsV1Message: description: A message which contains notification details. type: object - id: GoogleCloudAdvisorynotificationsV1Message properties: + attachments: + description: The attachments to download. + items: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' + type: array localizationTime: - type: string - format: google-datetime description: Time when Message was localized + format: google-datetime + type: string body: - description: The message content. $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' + description: The message content. createTime: - format: google-datetime description: The Message creation timestamp. + format: google-datetime type: string - attachments: - items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' - description: The attachments to download. - type: array + id: GoogleCloudAdvisorynotificationsV1Message + GoogleCloudAdvisorynotificationsV1Attachment: + type: object + properties: + displayName: + type: string + description: The title of the attachment. + csv: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' + description: A CSV file attachment. Max size is 10 MB. + description: Attachment with specific information about the issue. + id: GoogleCloudAdvisorynotificationsV1Attachment parameters: - access_token: - description: OAuth access token. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: access_token + name: uploadType schema: type: string - key: + quotaUser: 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. + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: key + name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + name: oauth_token schema: type: string - quotaUser: + callback: + description: JSONP + in: query + name: callback + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + key: description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + 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. in: query - name: quotaUser + name: key schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string prettyPrint: @@ -285,10 +306,10 @@ components: name: prettyPrint schema: type: boolean - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string alt: @@ -301,100 +322,84 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' x-stackQL-resources: - notifications: - id: google.advisorynotifications.notifications - name: notifications - title: Notifications + settings: + id: google.advisorynotifications.settings + name: settings + title: Settings methods: - get: + update_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications~1{notificationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/patch response: mediaType: application/json openAPIDocKey: '200' - list: + get_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notifications sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/notifications/methods/get' - - $ref: '#/components/x-stackQL-resources/notifications/methods/list' + - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' replace: [] delete: [] - settings: - id: google.advisorynotifications.settings - name: settings - title: Settings + notifications: + id: google.advisorynotifications.notifications + name: notifications + title: Notifications methods: - update_settings: + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notifications~1{notificationsId}/get response: mediaType: application/json openAPIDocKey: '200' - get_settings: + list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notifications/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.notifications sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' + - $ref: '#/components/x-stackQL-resources/notifications/methods/get' + - $ref: '#/components/x-stackQL-resources/notifications/methods/list' insert: [] - update: - - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' + update: [] replace: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/notifications/{notificationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/settings: parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/_.xgafv' - get: - description: Gets a notification. - operationId: advisorynotifications.projects.locations.notifications.get + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + patch: + description: Update notification settings. + operationId: advisorynotifications.organizations.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -407,10 +412,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -419,20 +424,9 @@ paths: required: true schema: type: string - - in: path - name: notificationsId - required: true - schema: - type: string - - in: query - name: languageCode - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notifications: - parameters: *ref_1 get: - description: Lists notifications under a given parent. - operationId: advisorynotifications.projects.locations.notifications.list + description: Get notification settings. + operationId: advisorynotifications.organizations.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -445,10 +439,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -457,33 +451,11 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: languageCode - schema: - type: string - - in: query - name: view - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/settings: + /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: parameters: *ref_1 - patch: - description: Update notification settings. - operationId: advisorynotifications.projects.locations.updateSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' + get: + description: Gets a notification. + operationId: advisorynotifications.organizations.locations.notifications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -496,10 +468,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -508,31 +480,13 @@ paths: required: true schema: type: string - get: - description: Get notification settings. - operationId: advisorynotifications.projects.locations.getSettings - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings - parameters: - in: path - name: projectsId + name: notificationsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: languageCode schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/notifications: @@ -564,10 +518,6 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - in: query name: languageCode schema: @@ -581,11 +531,15 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notifications/{notificationsId}: parameters: *ref_1 get: description: Gets a notification. - operationId: advisorynotifications.organizations.locations.notifications.get + operationId: advisorynotifications.projects.locations.notifications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -601,7 +555,7 @@ paths: #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -619,11 +573,57 @@ paths: name: languageCode schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/settings: + /v1/projects/{projectsId}/locations/{locationsId}/notifications: + parameters: *ref_1 + get: + description: Lists notifications under a given parent. + operationId: advisorynotifications.projects.locations.notifications.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/settings: parameters: *ref_1 patch: description: Update notification settings. - operationId: advisorynotifications.organizations.locations.updateSettings + operationId: advisorynotifications.projects.locations.updateSettings requestBody: content: application/json: @@ -644,7 +644,7 @@ paths: #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -655,7 +655,7 @@ paths: type: string get: description: Get notification settings. - operationId: advisorynotifications.organizations.locations.getSettings + operationId: advisorynotifications.projects.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -671,7 +671,7 @@ paths: #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml index fec578f2..96ce9dfc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml @@ -24,12 +24,12 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform.read-only: >- - View your data across Google Cloud services and see the email - address of your Google Account https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. + https://www.googleapis.com/auth/cloud-platform.read-only: >- + View your data across Google Cloud services and see the email + address of your Google Account Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -39,3702 +39,3809 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAiplatformV1RayMetricSpec: - description: Configuration for the Ray metrics. - id: GoogleCloudAiplatformV1RayMetricSpec - type: object - properties: - disabled: - type: boolean - description: Optional. Flag to disable the Ray metrics collection. - GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable: - type: object + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError: + id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError properties: - bigqueryTablePath: - description: >- - The created BigQuery table to store logs. Customer could do their - own query & analysis. Format: `bq://.model_deployment_monitoring_._` + errorType: + enumDescriptions: + - Default, shall not be used. + - The record is empty. + - Invalid json format. + - Invalid csv format. + - Invalid avro format. + - The embedding id is not valid. + - >- + The size of the dense embedding vectors does not match with the + specified dimension. + - The `namespace` field is missing. + - >- + Generic catch-all error. Only used for validation failure where + the root cause cannot be easily retrieved programmatically. + - There are multiple restricts with the same `namespace` value. + - Numeric restrict has operator specified in datapoint. + - Numeric restrict has multiple values specified. + - Numeric restrict has invalid numeric value specified. + - File is not in UTF_8 format. + - Error parsing sparse dimensions field. + - Token restrict value is invalid. + - Invalid sparse embedding. + - Invalid dense embedding. type: string - logSource: + description: The error type of this record. enum: - - LOG_SOURCE_UNSPECIFIED - - TRAINING - - SERVING - enumDescriptions: - - Unspecified source. - - Logs coming from Training dataset. - - Logs coming from Serving traffic. + - ERROR_TYPE_UNSPECIFIED + - EMPTY_LINE + - INVALID_JSON_SYNTAX + - INVALID_CSV_SYNTAX + - INVALID_AVRO_SYNTAX + - INVALID_EMBEDDING_ID + - EMBEDDING_SIZE_MISMATCH + - NAMESPACE_MISSING + - PARSING_ERROR + - DUPLICATE_NAMESPACE + - OP_IN_DATAPOINT + - MULTIPLE_VALUES + - INVALID_NUMERIC_VALUE + - INVALID_ENCODING + - INVALID_SPARSE_DIMENSIONS + - INVALID_TOKEN_VALUE + - INVALID_SPARSE_EMBEDDING + - INVALID_EMBEDDING + embeddingId: type: string - description: The source of log. - logType: - description: The type of log. + description: Empty if the embedding id is failed to parse. + sourceGcsUri: + description: Cloud Storage URI pointing to the original file in user's bucket. type: string - enumDescriptions: - - Unspecified type. - - Predict logs. - - Explain logs. - enum: - - LOG_TYPE_UNSPECIFIED - - PREDICT - - EXPLAIN - requestResponseLoggingSchemaVersion: - readOnly: true + errorMessage: type: string description: >- - Output only. The schema version of the request/response logging - BigQuery table. Default to v1 if unset. - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable + A human-readable message that is shown to the user to help them fix + the error. Note that this message may change from time to time, your + code should check against error_type as the source of truth. + rawRecord: + type: string + description: The original content of this record. + type: object + GoogleTypeDate: + properties: + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + year: + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + day: + type: integer + format: int32 + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: object description: >- - ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name - as well as some information of the logs stored in this table. - GoogleCloudAiplatformV1ListDatasetsResponse: - id: GoogleCloudAiplatformV1ListDatasetsResponse + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + id: GoogleTypeDate + GoogleCloudAiplatformV1FeatureGroupBigQuery: type: object - description: Response message for DatasetService.ListDatasets. properties: - nextPageToken: - type: string - description: The standard List next-page token. - datasets: + dense: + description: >- + Optional. If set, all feature values will be fetched from a single + row per unique entityId including nulls. If not set, will collapse + all rows for each unique entityId into a singe row with any non-null + values if present, if no non-null values are present will sync null. + ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` + and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` + `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, + 20, null)` is synced to online stores. If dense is not set, `(e1, + 20, 15)` is synced to online stores. + type: boolean + entityIdColumns: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' - description: A list of Datasets that matches the specified filter in the request. + type: string type: array - GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig: - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig - description: The config for scheduling monitoring job. - type: object - properties: - monitorWindow: description: >- - The time window of the prediction data being included in each - prediction dataset. This window specifies how long the data should - be collected from historical model results for each run. If not set, - ModelDeploymentMonitoringScheduleConfig.monitor_interval will be - used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and - the monitor_window is set to be 3600, then data from 2022-01-08 - 13:30:00 to 2022-01-08 14:30:00 will be retrieved and aggregated to - calculate the monitoring statistics. - type: string - format: google-duration - monitorInterval: + Optional. Columns to construct entity_id / row keys. If not provided + defaults to `entity_id`. + staticDataSource: + type: boolean + description: Optional. Set if the data source is not a time-series. + timeSeries: description: >- - Required. The model monitoring job scheduling interval. It will be - rounded up to next full hour. This defines how often the monitoring - jobs are triggered. - type: string - format: google-duration - GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult: + Optional. If the source is a time-series source, this can be set to + control how downstream sources (ex: FeatureView ) will treat + time-series sources. If not set, will treat the source as a + time-series source with `feature_timestamp` as timestamp column and + no scan boundary. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries + bigQuerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + description: >- + Required. Immutable. The BigQuery source URI that points to either a + BigQuery Table or View. + description: Input source type for BigQuery Tables and Views. + id: GoogleCloudAiplatformV1FeatureGroupBigQuery + GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata: + description: The metadata of Datasets that contain Text Prompt data. properties: - score: + hasPromptVariable: + type: boolean + description: Whether the prompt dataset has prompt variable. + stopSequences: + items: + type: string + description: Customized stop sequences. + type: array + temperature: type: number - readOnly: true format: float - description: Output only. Question Answering Correctness score. - confidence: + description: >- + Temperature value used for sampling set when the dataset was saved. + This value is used to tune the degree of randomness. + systemInstructionGcsUri: + description: >- + The Google Cloud Storage URI that stores the system instruction, + starting with gs://. + type: string + systemInstruction: + type: string + description: The content of the prompt dataset system instruction. + groundingConfig: + description: Grounding checking configuration. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + maxOutputTokens: + type: string + format: int64 + description: >- + Value of the maximum number of tokens generated set when the dataset + was saved. + topK: + description: >- + Top K value set when the dataset was saved. This value determines + how many candidates with highest probability from the vocab would be + selected for each decoding step. + format: int64 + type: string + note: + description: User-created prompt note. Note size limit is 2KB. + type: string + candidateCount: + format: int64 + description: Number of candidates. + type: string + text: + type: string + description: The content of the prompt dataset. + promptType: + description: Type of the prompt dataset. + type: string + gcsUri: + description: The Google Cloud Storage URI that stores the prompt data. + type: string + topP: + description: >- + Top P value set when the dataset was saved. Given topK tokens for + decoding, top candidates will be selected until the sum of their + probabilities is topP. format: float - description: Output only. Confidence for question answering correctness score. - readOnly: true type: number - explanation: - readOnly: true - description: Output only. Explanation for question answering correctness score. + id: GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation: + properties: + columnName: type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. type: object - description: Spec for question answering correctness result. - id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult - GoogleCloudAiplatformV1ContainerRegistryDestination: + GoogleCloudAiplatformV1ExplanationParameters: type: object - id: GoogleCloudAiplatformV1ContainerRegistryDestination + id: GoogleCloudAiplatformV1ExplanationParameters + description: Parameters to configure explaining for Model's predictions. properties: - outputUri: - type: string + integratedGradientsAttribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IntegratedGradientsAttribution description: >- - Required. Container Registry URI of a container image. Only Google - Container Registry and Artifact Registry are supported now. Accepted - forms: * Google Container Registry path. For example: - `gcr.io/projectId/imageName:tag`. * Artifact Registry path. For - example: - `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`. If a - tag is not specified, "latest" will be used as the default tag. - description: The Container Registry location for the container image. - GoogleCloudAiplatformV1VertexRagStoreRagResource: - properties: - ragCorpus: - type: string + An attribution method that computes Aumann-Shapley values taking + advantage of the model's fully differentiable structure. Refer to + this paper for more details: https://arxiv.org/abs/1703.01365 + topK: description: >- - Optional. RagCorpora resource name. Format: - `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - ragFileIds: - type: array + If populated, returns attributions for top K indices of outputs + (defaults to 1). Only applies to Models that predicts more than one + outputs (e,g, multi-class Models). When set to -1, returns + explanations for all outputs. + type: integer + format: int32 + outputIndices: + description: >- + If populated, only returns attributions that have output_index + contained in output_indices. It must be an ndarray of integers, with + the same shape of the output it's explaining. If not populated, + returns attributions for top_k indices of outputs. If neither top_k + nor output_indices is populated, returns the argmax index of the + outputs. Only applicable to Models that predict multiple outputs + (e,g, multi-class Models that predict multiple classes). items: - type: string + type: any + type: array + sampledShapleyAttribution: description: >- - Optional. rag_file_id. The files should be in the same rag_corpus - set in rag_corpus field. - id: GoogleCloudAiplatformV1VertexRagStoreRagResource - description: The definition of the Rag resource. - type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame: - properties: - xMin: - type: number - format: float - description: The leftmost coordinate of the bounding box. - timeOffset: + An attribution method that approximates Shapley values for features + that contribute to the label being predicted. A sampling strategy is + used to approximate the value rather than considering all subsets of + features. Refer to this paper for model details: + https://arxiv.org/abs/1306.4265. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SampledShapleyAttribution + xraiAttribution: description: >- - A time (frame) of a video in which the object has been detected. - Expressed as a number of seconds as measured from the start of the - video, with fractions up to a microsecond precision, and with "s" - appended at the end. - type: string - format: google-duration - xMax: - format: float - type: number - description: The rightmost coordinate of the bounding box. - yMax: - type: number - format: float - description: The bottommost coordinate of the bounding box. - yMin: - type: number - description: The topmost coordinate of the bounding box. - format: float - description: >- - The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box, - i.e. the rectangle over the video frame pinpointing the found - AnnotationSpec. The coordinates are relative to the frame size, and the - point 0,0 is in the top left of the frame. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame + An attribution method that redistributes Integrated Gradients + attribution to segmented regions, taking advantage of the model's + fully differentiable structure. Refer to this paper for more + details: https://arxiv.org/abs/1906.02825 XRAI currently performs + better on natural images, like a picture of a house or an animal. If + the images are taken in artificial environments, like a lab or + manufacturing line, or from diagnostic equipment, like x-rays or + quality-control cameras, use Integrated Gradients instead. + $ref: '#/components/schemas/GoogleCloudAiplatformV1XraiAttribution' + examples: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + description: >- + Example-based explanations that returns the nearest neighbors from + the provided dataset. + GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata: + id: GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' type: object - GoogleCloudAiplatformV1RawPredictRequest: - description: Request message for PredictionService.RawPredict. + description: Runtime operation information for ModelService.UpdateExplanationDataset. + GoogleCloudAiplatformV1BatchMigrateResourcesRequest: type: object - id: GoogleCloudAiplatformV1RawPredictRequest properties: - httpBody: - $ref: '#/components/schemas/GoogleApiHttpBody' + migrateResourceRequests: description: >- - The prediction input. Supports HTTP headers and arbitrary data - payload. A DeployedModel may have an upper limit on the number of - instances it supports per request. When this limit it is exceeded - for an AutoML model, the RawPredict method returns an error. When - this limit is exceeded for a custom-trained model, the behavior - varies depending on the model. You can specify the schema for each - instance in the predict_schemata.instance_schema_uri field when you - create a Model. This schema applies when you deploy the `Model` as a - `DeployedModel` to an Endpoint and use the `RawPredict` method. - GoogleCloudAiplatformV1RaySpec: + Required. The request messages specifying the resources to migrate. + They must be in the same location as the destination. Up to 50 + resources can be migrated in one batch. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + type: array + id: GoogleCloudAiplatformV1BatchMigrateResourcesRequest + description: Request message for MigrationService.BatchMigrateResources. + GoogleCloudAiplatformV1DataItem: properties: - headNodeResourcePoolId: + name: type: string - description: >- - Optional. This will be used to indicate which resource pool will - serve as the Ray head node(the first node within that pool). Will - use the machine from the first workerpool as the head node by - default if this field isn't set. - resourcePoolImages: + readOnly: true + description: Output only. The resource name of the DataItem. + updateTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Timestamp when this DataItem was last updated. + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + createTime: + readOnly: true + description: Output only. Timestamp when this DataItem was created. + format: google-datetime + type: string + labels: additionalProperties: type: string type: object description: >- - Optional. Required if image_uri isn't set. A map of resource_pool_id - to prebuild Ray image if user need to use different images for - different head/worker pools. This map needs to cover all the - resource pool ids. Example: { "ray_head_node_pool": "head image" - "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": - "another worker image" } - rayLogsSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RayLogsSpec' - description: Optional. OSS Ray logging configurations. - rayMetricSpec: - description: Optional. Ray metrics configurations. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RayMetricSpec' - imageUri: + Optional. The labels with user-defined metadata to organize your + DataItems. Label keys and values can be no longer than 64 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are + allowed. No more than 64 user labels can be associated with one + DataItem(System labels are excluded). See https://goo.gl/xmQnxf for + more information and examples of labels. System reserved label keys + are prefixed with "aiplatform.googleapis.com/" and are immutable. + payload: + type: any description: >- - Optional. Default image for user to choose a preferred ML framework - (for example, TensorFlow or Pytorch) by choosing from [Vertex - prebuilt - images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). - Either this or the resource_pool_images is required. Use this field - if you need all the resource pools to have the same Ray image. - Otherwise, use the {@code resource_pool_images} field. + Required. The data that the DataItem represents (for example, an + image or a text snippet). The schema of the payload is stored in the + parent Dataset's metadata schema's dataItemSchemaUri field. + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + etag: type: string - id: GoogleCloudAiplatformV1RaySpec + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + id: GoogleCloudAiplatformV1DataItem type: object description: >- - Configuration information for the Ray cluster. For experimental launch, - Ray cluster creation and Persistent cluster creation are 1:1 mapping: We - will provision all the nodes within the Persistent cluster as Ray nodes. - GoogleCloudAiplatformV1InputDataConfig: - description: >- - Specifies Vertex AI owned input data to be used for training, and - possibly evaluating, the Model. + A piece of data in a Dataset. Could be an image, a video, a document or + plain text. + GoogleCloudAiplatformV1ListSavedQueriesResponse: type: object properties: - predefinedSplit: - description: >- - Supported only for tabular Datasets. Split based on a predefined - key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedSplit' - annotationSchemaUri: + nextPageToken: + description: The standard List next-page token. + type: string + savedQueries: description: >- - Applicable only to custom training with Datasets that have DataItems - and Annotations. Cloud Storage URI that points to a YAML file - describing the annotation schema. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that - the chosen schema must be consistent with metadata of the Dataset - specified by dataset_id. Only Annotations that both match this - schema and belong to DataItems not ignored by the split method are - used in respectively training, validation or test role, depending on - the role of the DataItem they are on. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both annotations_filter and annotation_schema_uri. - type: string - stratifiedSplit: - description: >- - Supported only for tabular Datasets. Split based on the distribution - of the specified column. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StratifiedSplit' - fractionSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FractionSplit' - description: Split based on fractions defining the size of each set. - annotationsFilter: - type: string - description: >- - Applicable only to Datasets that have DataItems and Annotations. A - filter on Annotations of the Dataset. Only Annotations that both - match this filter and belong to DataItems not ignored by the split - method are used in respectively training, validation or test role, - depending on the role of the DataItem they are on (for the - auto-assigned that role is decided by Vertex AI). A filter with same - syntax as the one used in ListAnnotations may be used, but note here - it filters across all Annotations of the Dataset, and not just - within a single DataItem. - bigqueryDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: >- - Only applicable to custom training with tabular Dataset with - BigQuery source. The BigQuery project location where the training - data is to be written to. In the given project a new dataset is - created with name `dataset___` where timestamp is in - YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written - into that dataset. In the dataset three tables are created, - `training`, `validation` and `test`. * AIP_DATA_FORMAT = "bigquery". - * AIP_TRAINING_DATA_URI = "bigquery_destination.dataset___.training" - * AIP_VALIDATION_DATA_URI = - "bigquery_destination.dataset___.validation" * AIP_TEST_DATA_URI = - "bigquery_destination.dataset___.test" - timestampSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimestampSplit' - description: >- - Supported only for tabular Datasets. Split based on the timestamp of - the input data pieces. - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: >- - The Cloud Storage location where the training data is to be written - to. In the given directory a new directory is created with name: - `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 - format. All training input data is written into that directory. The - Vertex AI environment variables representing Cloud Storage data URIs - are represented in the Cloud Storage wildcard format to support - sharded data. e.g.: "gs://.../training-*.jsonl" * AIP_DATA_FORMAT = - "jsonl" for non-tabular data, "csv" for tabular data * - AIP_TRAINING_DATA_URI = - "gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}" * - AIP_VALIDATION_DATA_URI = - "gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}" * - AIP_TEST_DATA_URI = - "gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}" - filterSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FilterSplit' - description: Split based on the provided filters for each set. - savedQueryId: - description: >- - Only applicable to Datasets that have SavedQueries. The ID of a - SavedQuery (annotation set) under the Dataset specified by - dataset_id used for filtering Annotations for training. Only - Annotations that are associated with this SavedQuery are used in - respectively training. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both saved_query_id and annotations_filter. Only one of - saved_query_id and annotation_schema_uri should be specified as both - of them represent the same thing: problem type. - type: string - persistMlUseAssignment: - type: boolean - description: Whether to persist the ML use assignment to data item system labels. - datasetId: - type: string - description: >- - Required. The ID of the Dataset in the same Project and Location - which data will be used to train the Model. The Dataset must use - schema compatible with Model being trained, and what is compatible - should be described in the used TrainingPipeline's - training_task_definition. For tabular Datasets, all their data is - exported to training, to pick and choose from. - id: GoogleCloudAiplatformV1InputDataConfig - GoogleCloudAiplatformV1MetadataSchema: - type: object - description: Instance of a general MetadataSchema. - id: GoogleCloudAiplatformV1MetadataSchema + A list of SavedQueries that match the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + id: GoogleCloudAiplatformV1ListSavedQueriesResponse + description: Response message for DatasetService.ListSavedQueries. + GoogleCloudAiplatformV1Dataset: + description: A collection of DataItems and Annotations on them. + id: GoogleCloudAiplatformV1Dataset properties: - description: - type: string - description: Description of the Metadata Schema - schemaType: - enumDescriptions: - - Unspecified type for the MetadataSchema. - - >- - A type indicating that the MetadataSchema will be used by - Artifacts. - - >- - A typee indicating that the MetadataSchema will be used by - Executions. - - >- - A state indicating that the MetadataSchema will be used by - Contexts. - type: string - description: >- - The type of the MetadataSchema. This is a property that identifies - which metadata types will use the MetadataSchema. - enum: - - METADATA_SCHEMA_TYPE_UNSPECIFIED - - ARTIFACT_TYPE - - EXECUTION_TYPE - - CONTEXT_TYPE - schemaVersion: - type: string + dataItemCount: + format: int64 description: >- - The version of the MetadataSchema. The version's format must match - the following regular expression: `^[0-9]+.+.+$`, which would allow - to order/compare different versions. Example: 1.0.0, 1.0.1, etc. - name: + Output only. The number of DataItems in this Dataset. Only apply for + non-structured Dataset. type: string - description: Output only. The resource name of the MetadataSchema. readOnly: true - schema: + displayName: description: >- - Required. The raw YAML string representation of the MetadataSchema. - The combination of [MetadataSchema.version] and the schema name - given by `title` in [MetadataSchema.schema] must be unique within a - MetadataStore. The schema is defined as an OpenAPI 3.0.2 - [MetadataSchema - Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) - type: string - createTime: + Required. The user-defined name of the Dataset. The name can be up + to 128 characters long and can consist of any UTF-8 characters. type: string - readOnly: true + updateTime: format: google-datetime - description: Output only. Timestamp when this MetadataSchema was created. - GoogleCloudAiplatformV1MutateDeployedModelResponse: - type: object - id: GoogleCloudAiplatformV1MutateDeployedModelResponse - properties: - deployedModel: - description: The DeployedModel that's being mutated. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: Response message for EndpointService.MutateDeployedModel. - GoogleCloudAiplatformV1RougeSpec: - type: object - id: GoogleCloudAiplatformV1RougeSpec - properties: - rougeType: type: string + readOnly: true + description: Output only. Timestamp when this Dataset was last updated. + metadataSchemaUri: description: >- - Optional. Supported rouge types are rougen[1-9], rougeL, and - rougeLsum. - splitSummaries: - type: boolean - description: Optional. Whether to split summaries while using rougeLsum. - useStemmer: - description: Optional. Whether to use stemmer to compute rouge score. - type: boolean - description: >- - Spec for rouge score metric - calculates the recall of n-grams in - prediction as compared to reference - returns a score ranging between 0 - and 1. - GoogleCloudAiplatformV1DataLabelingJob: - type: object - properties: - instructionUri: + Required. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Dataset. The schema is + defined as an OpenAPI 3.0.2 Schema Object. The schema files that can + be used here are found in + gs://google-cloud-aiplatform/schema/dataset/metadata/. type: string - description: >- - Required. The Google Cloud Storage location of the instruction pdf. - This pdf is shared with labelers, and provides detailed description - on how to label DataItems in Datasets. encryptionSpec: - description: >- - Customer-managed encryption key spec for a DataLabelingJob. If set, - this DataLabelingJob will be secured by this key. Note: Annotations - created in the DataLabelingJob are associated with the - EncryptionSpec of the Dataset they are exported to. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - createTime: + description: >- + Customer-managed encryption key spec for a Dataset. If set, this + Dataset and all sub-resources of this Dataset will be secured by + this key. + description: + description: The description of the Dataset. + type: string + name: readOnly: true - format: google-datetime + description: Output only. Identifier. The resource name of the Dataset. + type: string + metadata: + type: any + description: Required. Additional information about the Dataset. + modelReference: type: string - description: Output only. Timestamp when this DataLabelingJob was created. - datasets: description: >- - Required. Dataset resource names. Right now we only support labeling - from a single Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}` + Optional. Reference to the public base model last used by the + dataset. Only set for prompt datasets. + savedQueries: + description: >- + All SavedQueries belong to the Dataset will be returned in List/Get + Dataset response. The annotation_specs field will not be populated + except for UI cases which will only use annotation_spec_count. In + CreateDataset request, a SavedQuery is created together if this + field is set, up to one SavedQuery can be set in + CreateDatasetRequest. The SavedQuery should not contain any + AnnotationSpec. + type: array items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + labels: + additionalProperties: type: string - type: array - labelerCount: - type: integer - format: int32 - description: Required. Number of labelers to work on each DataItem. - error: - description: >- - Output only. DataLabelingJob errors. It is only populated when job's - state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - annotationLabels: type: object description: >- - Labels to assign to annotations generated by this DataLabelingJob. + The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - additionalProperties: - type: string - updateTime: + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Dataset (System + labels are excluded). See https://goo.gl/xmQnxf for more information + and examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for each Dataset: * + "aiplatform.googleapis.com/dataset_metadata_schema": output only, + its value is the metadata_schema's title. + createTime: + description: Output only. Timestamp when this Dataset was created. + type: string format: google-datetime readOnly: true + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + etag: description: >- - Output only. Timestamp when this DataLabelingJob was updated most - recently. + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string - inputs: - type: any - description: Required. Input config parameters for the DataLabelingJob. - displayName: + metadataArtifact: type: string description: >- - Required. The user-defined name of the DataLabelingJob. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. Display name of a DataLabelingJob. - name: - description: Output only. Resource name of the DataLabelingJob. + Output only. The resource name of the Artifact that was created in + MetadataStore when creating the Dataset. The Artifact resource name + pattern is + `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. readOnly: true - type: string - currentSpend: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Output only. Estimated cost(in US dollars) that the DataLabelingJob - has incurred to date. + satisfiesPzs: + type: boolean readOnly: true - activeLearningConfig: + description: Output only. Reserved for future use. + type: object + GoogleCloudLocationLocation: + properties: + name: description: >- - Parameters that configure the active learning pipeline. Active - learning will label the data incrementally via several iterations. - For every iteration, it will select a batch of data based on the - sampling strategy. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' - specialistPools: - items: - type: string - type: array - description: The SpecialistPools' resource names associated with this job. - state: + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` type: string - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - readOnly: true - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - description: Output only. The detailed state of the job. - inputsSchemaUri: + displayName: type: string description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing the config for a specific type of DataLabelingJob. The - schema files that can be used here are found in the - https://storage.googleapis.com/google-cloud-aiplatform bucket in the - /schema/datalabelingjob/inputs/ folder. + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". labels: description: >- - The labels with user-defined metadata to organize your - DataLabelingJobs. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for each DataLabelingJob: * - "aiplatform.googleapis.com/schema": output only, its value is the - inputs_schema's title. + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} additionalProperties: type: string type: object - labelingProgress: + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + metadata: + type: object description: >- - Output only. Current labeling job progress percentage scaled in - interval [0, 100], indicating the percentage of DataItems that has - been finished. - readOnly: true + Service-specific metadata. For example the available capacity at the + given location. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: A resource that represents a Google Cloud location. + id: GoogleCloudLocationLocation + GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling: + properties: + cpuUtilizationTarget: format: int32 + description: >- + Optional. A percentage of the cluster's CPU capacity. Can be from + 10% to 80%. When a cluster's CPU utilization exceeds the target that + you have set, Bigtable immediately adds nodes to the cluster. When + CPU utilization is substantially lower than the target, Bigtable + removes nodes. If not set will default to 50%. type: integer - id: GoogleCloudAiplatformV1DataLabelingJob - description: >- - DataLabelingJob is used to trigger a human labeling job on unlabeled - data from the following Dataset: - GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: - id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata - description: Metadata information for NotebookService.AssignNotebookRuntime. + minNodeCount: + description: >- + Required. The minimum number of nodes to scale down to. Must be + greater than or equal to 1. + format: int32 + type: integer + maxNodeCount: + description: >- + Required. The maximum number of nodes to scale up to. Must be + greater than or equal to min_node_count, and less than or equal to + 10 times of 'min_node_count'. + format: int32 + type: integer + type: object + id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling + GoogleCloudAiplatformV1ExportModelOperationMetadata: + description: Details of ModelService.ExportModel operation. + id: GoogleCloudAiplatformV1ExportModelOperationMetadata properties: - progressMessage: - type: string + outputInfo: description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. + Output only. Information further describing the output of this Model + export. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo + readOnly: true genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. + description: The common part of the operation metadata. type: object - GoogleCloudAiplatformV1CreateFeatureRequest: - id: GoogleCloudAiplatformV1CreateFeatureRequest + GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata: type: object + id: >- + GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata + properties: + multiLabel: + type: boolean + description: Whether or not the classification label is multi_label. + GoogleCloudAiplatformV1PointwiseMetricInstance: description: >- - Request message for FeaturestoreService.CreateFeature. Request message - for FeatureRegistryService.CreateFeature. + Pointwise metric instance. Usually one instance corresponds to one row + in an evaluation dataset. properties: - parent: - type: string + jsonInstance: 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}` - featureId: + Instance specified as a json string. String key-value pairs are + expected in the json_instance to render + PointwiseMetricSpec.instance_prompt_template. type: string - 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. - feature: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - description: Required. The Feature to create. - GoogleCloudAiplatformV1HyperparameterTuningJob: - id: GoogleCloudAiplatformV1HyperparameterTuningJob + id: GoogleCloudAiplatformV1PointwiseMetricInstance type: object - description: >- - Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a - Study specification and multiple CustomJobs with identical CustomJob - specification. + GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse: + description: Response message for TensorboardService.WriteTensorboardExperimentData. + type: object + id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + properties: {} + GoogleCloudAiplatformV1ExactMatchResults: + type: object + id: GoogleCloudAiplatformV1ExactMatchResults properties: - name: - type: string + exactMatchMetricValues: + type: array readOnly: true - description: Output only. Resource name of the HyperparameterTuningJob. - endTime: - description: >- - Output only. Time when the HyperparameterTuningJob entered any of - the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - format: google-datetime - type: string - readOnly: true - createTime: - description: Output only. Time when the HyperparameterTuningJob was created. - type: string - format: google-datetime - readOnly: true - parallelTrialCount: - format: int32 - description: Required. The desired number of Trials to run in parallel. - type: integer - encryptionSpec: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchMetricValue' + description: Output only. Exact match metric values. + description: Results for exact match metric. + GoogleCloudAiplatformV1InputDataConfig: + description: >- + Specifies Vertex AI owned input data to be used for training, and + possibly evaluating, the Model. + type: object + id: GoogleCloudAiplatformV1InputDataConfig + properties: + stratifiedSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StratifiedSplit' description: >- - Customer-managed encryption key options for a - HyperparameterTuningJob. If this is set, then all resources created - by the HyperparameterTuningJob will be encrypted with the provided - encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - displayName: + Supported only for tabular Datasets. Split based on the distribution + of the specified column. + fractionSplit: + description: Split based on fractions defining the size of each set. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FractionSplit' + datasetId: + type: string description: >- - Required. The display name of the HyperparameterTuningJob. The name - can be up to 128 characters long and can consist of any UTF-8 - characters. + Required. The ID of the Dataset in the same Project and Location + which data will be used to train the Model. The Dataset must use + schema compatible with Model being trained, and what is compatible + should be described in the used TrainingPipeline's + training_task_definition. For tabular Datasets, all their data is + exported to training, to pick and choose from. + savedQueryId: type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. Only populated when job's state is JOB_STATE_FAILED or - JOB_STATE_CANCELLED. - readOnly: true - trials: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - readOnly: true - type: array - description: Output only. Trials of the HyperparameterTuningJob. - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - startTime: - format: google-datetime + Only applicable to Datasets that have SavedQueries. The ID of a + SavedQuery (annotation set) under the Dataset specified by + dataset_id used for filtering Annotations for training. Only + Annotations that are associated with this SavedQuery are used in + respectively training. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both saved_query_id and annotations_filter. Only one of + saved_query_id and annotation_schema_uri should be specified as both + of them represent the same thing: problem type. + filterSplit: + description: Split based on the provided filters for each set. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FilterSplit' + annotationSchemaUri: description: >- - Output only. Time when the HyperparameterTuningJob for the first - time entered the `JOB_STATE_RUNNING` state. - readOnly: true - type: string - maxTrialCount: - description: Required. The desired total number of Trials. - format: int32 - type: integer - state: - description: Output only. The detailed state of the job. + Applicable only to custom training with Datasets that have DataItems + and Annotations. Cloud Storage URI that points to a YAML file + describing the annotation schema. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that + the chosen schema must be consistent with metadata of the Dataset + specified by dataset_id. Only Annotations that both match this + schema and belong to DataItems not ignored by the split method are + used in respectively training, validation or test role, depending on + the role of the DataItem they are on. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both annotations_filter and annotation_schema_uri. type: string - readOnly: true - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. + persistMlUseAssignment: + description: Whether to persist the ML use assignment to data item system labels. type: boolean - maxFailedTrialCount: - description: >- - The number of failed Trials that need to be seen before failing the - HyperparameterTuningJob. If set to 0, Vertex AI decides how many - Trials must fail before the whole job fails. - type: integer - format: int32 - updateTime: + gcsDestination: description: >- - Output only. Time when the HyperparameterTuningJob was most recently - updated. - format: google-datetime - readOnly: true - type: string - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - description: Required. Study configuration of the HyperparameterTuningJob. - trialJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + The Cloud Storage location where the training data is to be written + to. In the given directory a new directory is created with name: + `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 + format. All training input data is written into that directory. The + Vertex AI environment variables representing Cloud Storage data URIs + are represented in the Cloud Storage wildcard format to support + sharded data. e.g.: "gs://.../training-*.jsonl" * AIP_DATA_FORMAT = + "jsonl" for non-tabular data, "csv" for tabular data * + AIP_TRAINING_DATA_URI = + "gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}" * + AIP_VALIDATION_DATA_URI = + "gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}" * + AIP_TEST_DATA_URI = + "gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}" + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + bigqueryDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' description: >- - Required. The spec of a trial job. The same spec applies to the - CustomJobs created in all the trials. - labels: - additionalProperties: - type: string + Only applicable to custom training with tabular Dataset with + BigQuery source. The BigQuery project location where the training + data is to be written to. In the given project a new dataset is + created with name `dataset___` where timestamp is in + YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written + into that dataset. In the dataset three tables are created, + `training`, `validation` and `test`. * AIP_DATA_FORMAT = "bigquery". + * AIP_TRAINING_DATA_URI = "bigquery_destination.dataset___.training" + * AIP_VALIDATION_DATA_URI = + "bigquery_destination.dataset___.validation" * AIP_TEST_DATA_URI = + "bigquery_destination.dataset___.test" + predefinedSplit: description: >- - The labels with user-defined metadata to organize - HyperparameterTuningJobs. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - type: object - GoogleCloudAiplatformV1FeatureViewSync: - properties: - name: + Supported only for tabular Datasets. Split based on a predefined + key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedSplit' + timestampSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimestampSplit' description: >- - Identifier. Name of the FeatureViewSync. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` - type: string - runTime: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Output only. Time when this FeatureViewSync is finished. - readOnly: true - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - syncSummary: - description: Output only. Summary of the sync job. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncSyncSummary - finalStatus: - description: Output only. Final status of the FeatureViewSync. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - satisfiesPzs: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - createTime: - format: google-datetime - readOnly: true + Supported only for tabular Datasets. Split based on the timestamp of + the input data pieces. + annotationsFilter: type: string description: >- - Output only. Time when this FeatureViewSync is created. Creation of - a FeatureViewSync means that the job is pending / waiting for - sufficient resources but may not have started the actual data - transfer yet. - type: object - description: >- - FeatureViewSync is a representation of sync operation which copies data - from data source to Feature View in Online Store. - id: GoogleCloudAiplatformV1FeatureViewSync - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation: + Applicable only to Datasets that have DataItems and Annotations. A + filter on Annotations of the Dataset. Only Annotations that both + match this filter and belong to DataItems not ignored by the split + method are used in respectively training, validation or test role, + depending on the role of the DataItem they are on (for the + auto-assigned that role is decided by Vertex AI). A filter with same + syntax as the one used in ListAnnotations may be used, but note here + it filters across all Annotations of the Dataset, and not just + within a single DataItem. + CloudAiLargeModelsVisionNamedBoundingBox: + id: CloudAiLargeModelsVisionNamedBoundingBox + properties: + y2: + type: number + format: float + y1: + format: float + type: number + classes: + items: + type: string + type: array + scores: + type: array + items: + format: float + type: number + x1: + type: number + format: float + entities: + items: + type: string + type: array + x2: + format: float + type: number type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation + GoogleCloudAiplatformV1MigrateResourceRequest: + id: GoogleCloudAiplatformV1MigrateResourceRequest description: >- - A TrainingJob that trains and uploads an AutoML Image Segmentation - Model. + Config of migrating one resource from automl.googleapis.com, + datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. properties: - metadata: + migrateAutomlDatasetConfig: + description: >- + Config for migrating Dataset in automl.googleapis.com to Vertex AI's + Dataset. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata - description: The metadata information. - inputs: + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig + migrateDataLabelingDatasetConfig: + description: >- + Config for migrating Dataset in datalabeling.googleapis.com to + Vertex AI's Dataset. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs - description: The input parameters of this TrainingJob. - GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader: - type: object - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader - properties: - featureDescriptors: - type: array + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + migrateMlEngineModelVersionConfig: description: >- - List of Feature metadata corresponding to each piece of - ReadFeatureValuesResponse.EntityView.data. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor - entityType: + Config for migrating Version in ml.googleapis.com to Vertex AI's + Model. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig + migrateAutomlModelConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig description: >- - The resource name of the EntityType from the - ReadFeatureValuesRequest. Value format: - `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. - type: string - description: >- - Response header with metadata for the requested - ReadFeatureValuesRequest.entity_type and Features. - GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec: + Config for migrating Model in automl.googleapis.com to Vertex AI's + Model. type: object - description: Defines the Feature value(s) to import. - id: GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + GoogleCloudAiplatformV1ResourcesConsumed: + id: GoogleCloudAiplatformV1ResourcesConsumed properties: - sourceField: - type: string - description: >- - Source column to get the Feature values from. If not set, uses the - column with the same name as the Feature ID. - id: + replicaHours: description: >- - Required. ID of the Feature to import values of. This Feature must - exist in the target EntityType, or the request will fail. - type: string - GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics - type: object - properties: - rougeLSum: - description: ROUGE-L (Longest Common Subsequence) scoring at summary level. + Output only. The number of replica hours used. Note that many + replicas may run in parallel, and additionally any given work may be + queued for some time. Therefore this value is not strictly related + to wall time. + format: double + readOnly: true type: number - format: float - GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse: + description: Statistics information about resource consumption. + type: object + GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest: + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest + description: Request message for CreateDeploymentResourcePool method. type: object properties: - nextPageToken: + deploymentResourcePool: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' + description: Required. The DeploymentResourcePool to create. + deploymentResourcePoolId: description: >- - A token to retrieve next page of results. Pass to - ListModelEvaluationSlicesRequest.page_token to obtain that page. + Required. The ID to use for the DeploymentResourcePool, which will + become the final component of the DeploymentResourcePool's resource + name. The maximum length is 63 characters, and valid characters are + `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. type: string - modelEvaluationSlices: - description: List of ModelEvaluations in the requested page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' - description: Response message for ModelService.ListModelEvaluationSlices. - id: GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata: + GoogleCloudAiplatformV1PublisherModelDocumentation: type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + id: GoogleCloudAiplatformV1PublisherModelDocumentation properties: - backingCustomJob: + content: + description: Required. Content of this piece of document (in Markdown format). type: string + title: description: >- - The resource name of the CustomJob that has been created to carry - out this custom task. - GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest: - properties: - evaluatedAnnotations: - type: array - description: Required. Evaluated annotations resource to be imported. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotation' - type: object - description: Request message for ModelService.BatchImportEvaluatedAnnotations - id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation: - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. - properties: - columnName: + Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, + JAVA, NODE.JS, etc.. type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + description: A named piece of documentation. + GoogleCloudAiplatformV1FeatureViewSyncConfig: + id: GoogleCloudAiplatformV1FeatureViewSyncConfig type: object - GoogleCloudAiplatformV1SchemaTimeSegment: + description: Configuration for Sync. Only one option is set. properties: - endTimeOffset: + cron: type: string - format: google-duration description: >- - End of the time segment (exclusive), represented as the duration - since the start of the DataItem. - startTimeOffset: + Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch + scheduled runs. To explicitly set a timezone to the cron tab, apply + a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * + * *". + GoogleCloudAiplatformV1CreateFeatureRequest: + description: >- + Request message for FeaturestoreService.CreateFeature. Request message + for FeatureRegistryService.CreateFeature. + id: GoogleCloudAiplatformV1CreateFeatureRequest + properties: + feature: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: Required. The Feature to create. + 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. + type: string + parent: type: string description: >- - Start of the time segment (inclusive), represented as the duration - since the start of the DataItem. - format: google-duration - id: GoogleCloudAiplatformV1SchemaTimeSegment + 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}` type: object - description: >- - A time period inside of a DataItem that has a time dimension (e.g. - video). - GoogleCloudAiplatformV1ContainerSpec: - id: GoogleCloudAiplatformV1ContainerSpec + GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: + id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation + description: Annotation details specific to image object detection. type: object properties: - args: - description: The arguments to be passed when starting the container. - items: - type: string - type: array - command: - type: array - items: - type: string - description: >- - The command to be invoked when the container is started. It - overrides the entrypoint instruction in Dockerfile when provided. - imageUri: + displayName: description: >- - Required. The URI of a container image in the Container Registry - that is to be run on each worker replica. + The display name of the AnnotationSpec that this Annotation pertains + to. + type: string + xMin: + type: number + description: The leftmost coordinate of the bounding box. + format: double + annotationSpecId: type: string - env: description: >- - Environment variables to be passed to the container. Maximum limit - is 100. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' - type: array - description: The spec of a Container. - GoogleCloudAiplatformV1DataItem: - id: GoogleCloudAiplatformV1DataItem + The resource Id of the AnnotationSpec that this Annotation pertains + to. + yMin: + description: The topmost coordinate of the bounding box. + type: number + format: double + xMax: + type: number + description: The rightmost coordinate of the bounding box. + format: double + yMax: + description: The bottommost coordinate of the bounding box. + type: number + format: double + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse + type: object + description: Response message for VizierService.CheckTrialEarlyStoppingState. properties: - createTime: - format: google-datetime - description: Output only. Timestamp when this DataItem was created. - type: string - readOnly: true - labels: - type: object - description: >- - Optional. The labels with user-defined metadata to organize your - DataItems. Label keys and values can be no longer than 64 characters - (Unicode codepoints), can only contain lowercase letters, numeric - characters, underscores and dashes. International characters are - allowed. No more than 64 user labels can be associated with one - DataItem(System labels are excluded). See https://goo.gl/xmQnxf for - more information and examples of labels. System reserved label keys - are prefixed with "aiplatform.googleapis.com/" and are immutable. - additionalProperties: - type: string - payload: - description: >- - Required. The data that the DataItem represents (for example, an - image or a text snippet). The schema of the payload is stored in the - parent Dataset's metadata schema's dataItemSchemaUri field. - type: any - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true + shouldStop: type: boolean - updateTime: - description: Output only. Timestamp when this DataItem was last updated. - format: google-datetime - type: string + description: True if the Trial should stop. + GoogleCloudAiplatformV1ModelEvaluationSliceSlice: + type: object + id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice + description: Definition of a slice. + properties: + sliceSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec + description: Output only. Specification for how the data was sliced. readOnly: true - name: + dimension: type: string + description: >- + Output only. The dimension of the slice. Well-known dimensions are: + * `annotationSpec`: This slice is on the test data that has either + ground truth or prediction with AnnotationSpec.display_name equals + to value. * `slice`: This slice is a user customized slice defined + by its SliceSpec. readOnly: true - description: Output only. The resource name of the DataItem. - etag: + value: type: string - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - satisfiesPzs: readOnly: true - type: boolean - description: Output only. Reserved for future use. + description: Output only. The value of the dimension in this slice. + GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult + description: Prediction output format for Video Action Recognition. type: object - description: >- - A piece of data in a Dataset. Could be an image, a video, a document or - plain text. - GoogleCloudAiplatformV1PairwiseMetricInstance: properties: - jsonInstance: + displayName: type: string + description: The display name of the AnnotationSpec that had been identified. + timeSegmentStart: description: >- - Instance specified as a json string. String key-value pairs are - expected in the json_instance to render - PairwiseMetricSpec.instance_prompt_template. - description: >- - Pairwise metric instance. Usually one instance corresponds to one row in - an evaluation dataset. - id: GoogleCloudAiplatformV1PairwiseMetricInstance - type: object - GoogleCloudAiplatformV1TensorboardRun: - type: object - description: >- - TensorboardRun maps to a specific execution of a training job with a - given set of hyperparameter values, model definition, dataset, etc - properties: - name: + The beginning, inclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. type: string - readOnly: true + format: google-duration + confidence: description: >- - Output only. Name of the TensorboardRun. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - updateTime: - format: google-datetime - readOnly: true - type: string - description: Output only. Timestamp when this TensorboardRun was last updated. - description: + The Model's confidence in correction of this prediction, higher + value means higher confidence. + type: number + format: float + id: type: string - description: Description of this TensorboardRun. - labels: - description: >- - The labels with user-defined metadata to organize your - TensorboardRuns. This field will be used to filter and visualize - Runs in the Tensorboard UI. For example, a Vertex AI training job - can set a label aiplatform.googleapis.com/training_job_id=xxxxx to - all the runs created within that job. An end user can set a label - experiment_id=xxxxx for all the runs produced in a Jupyter notebook. - These runs can be grouped by a label value and visualized together - in the Tensorboard UI. Label keys and values can be no longer than - 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. No more than 64 user labels can be - associated with one TensorboardRun (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - type: object - additionalProperties: - type: string - etag: + description: The resource ID of the AnnotationSpec that had been identified. + timeSegmentEnd: type: string description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - displayName: - description: >- - Required. User provided name of this TensorboardRun. This value must - be unique among all TensorboardRuns belonging to the same parent - TensorboardExperiment. - type: string - createTime: - type: string - format: google-datetime - description: Output only. Timestamp when this TensorboardRun was created. - readOnly: true - id: GoogleCloudAiplatformV1TensorboardRun - GoogleCloudAiplatformV1PythonPackageSpec: + The end, exclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. + format: google-duration + GoogleCloudAiplatformV1GenerateContentResponse: type: object properties: - args: - type: array - items: - type: string - description: Command line arguments to be passed to the Python task. - packageUris: - description: >- - Required. The Google Cloud Storage location of the Python package - files which are the training program and its dependent packages. The - maximum number of package URIs is 100. + usageMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata + description: Usage metadata about the response(s). + candidates: items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Candidate' type: array - env: + description: Output only. Generated candidates. + readOnly: true + promptFeedback: + description: >- + Output only. Content filter results for a prompt sent in the + request. Note: Sent only in the first stream chunk. Only happens + when no candidates were generated due to content violations. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + readOnly: true + id: GoogleCloudAiplatformV1GenerateContentResponse + description: Response message for [PredictionService.GenerateContent]. + GoogleCloudAiplatformV1ListModelEvaluationsResponse: + properties: + modelEvaluations: + description: List of ModelEvaluations in the requested page. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' - description: >- - Environment variables to be passed to the python module. Maximum - limit is 100. - executorImageUri: - type: string - description: >- - Required. The URI of a container image in Artifact Registry that - will run the provided Python package. Vertex AI provides a wide - range of executor images with pre-installed packages to meet users' - various use cases. See the list of [pre-built containers for - training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). - You must use an image from this list. - pythonModule: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + nextPageToken: description: >- - Required. The Python module name to run after installing the - packages. + A token to retrieve next page of results. Pass to + ListModelEvaluationsRequest.page_token to obtain that page. type: string - description: The spec of a Python packaged code. - id: GoogleCloudAiplatformV1PythonPackageSpec - GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult: + id: GoogleCloudAiplatformV1ListModelEvaluationsResponse + type: object + description: Response message for ModelService.ListModelEvaluations. + GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams: properties: - explanation: - description: Output only. Explanation for question answering relevance score. - type: string - readOnly: true - score: - readOnly: true - description: Output only. Question Answering Relevance score. - type: number - format: float - confidence: - readOnly: true + confidenceThreshold: format: float type: number - description: Output only. Confidence for question answering relevance score. - id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult - description: Spec for question answering relevance result. - type: object - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig: + description: >- + When the model predicts category of pixels of the image, it will + only provide predictions for pixels that it is at least this much + confident about. All other pixels will be classified as background. + Default value is 0.5. id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig + GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams type: object + description: Prediction model parameters for Image Segmentation. + GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance: + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance properties: - annotatedDataset: + content: + description: The image bytes or Cloud Storage URI to make the prediction on. + type: string + mimeType: type: string description: >- - Required. Full resource name of data labeling AnnotatedDataset. - Format: - `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/gif - + image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + type: object + description: Prediction input format for Image Object Detection. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation: + properties: + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation + type: object + GoogleCloudAiplatformV1SamplingStrategy: + properties: + randomSampleConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig + description: Random sample config. Will support more sampling strategies later. + type: object + id: GoogleCloudAiplatformV1SamplingStrategy description: >- - Config for migrating AnnotatedDataset in datalabeling.googleapis.com to - Vertex AI's SavedQuery. - GoogleCloudAiplatformV1Event: + Sampling Strategy for logging, can be for both training and prediction + dataset. + GoogleCloudAiplatformV1PublisherModelResourceReference: + description: Reference to a resource. + type: object properties: - labels: - description: >- - The labels with user-defined metadata to annotate Events. Label keys - and values can be no longer than 64 characters (Unicode codepoints), - can only contain lowercase letters, numeric characters, underscores - and dashes. International characters are allowed. No more than 64 - user labels can be associated with one Event (System labels are - excluded). See https://goo.gl/xmQnxf for more information and - examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - type: object - additionalProperties: - type: string - type: - enumDescriptions: - - Unspecified whether input or output of the Execution. - - An input of the Execution. - - An output of the Execution. + resourceName: type: string - description: Required. The type of the Event. - enum: - - TYPE_UNSPECIFIED - - INPUT - - OUTPUT - artifact: - description: Required. The relative resource name of the Artifact in the Event. + description: The resource name of the Google Cloud resource. + useCase: + deprecated: true type: string - execution: - description: >- - Output only. The relative resource name of the Execution in the - Event. - readOnly: true + description: Use case (CUJ) of the resource. + uri: type: string - eventTime: - readOnly: true - description: Output only. Time the Event occurred. + description: The URI of the resource. + description: + description: Description of the resource. + deprecated: true type: string - format: google-datetime - description: >- - An edge describing the relationship between an Artifact and an Execution - in a lineage graph. - type: object - id: GoogleCloudAiplatformV1Event - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation: + id: GoogleCloudAiplatformV1PublisherModelResourceReference + GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies: type: object - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. + description: Statistics and anomalies generated by Model Monitoring. + id: GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies properties: - columnName: + deployedModelId: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation - CloudAiLargeModelsVisionRaiInfoDetectedLabels: + description: Deployed Model ID. + featureStats: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies + description: A list of historical Stats and Anomalies generated for all Features. + objective: + description: Model Monitoring Objective those stats and anomalies belonging to. + enum: + - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED + - RAW_FEATURE_SKEW + - RAW_FEATURE_DRIFT + - FEATURE_ATTRIBUTION_SKEW + - FEATURE_ATTRIBUTION_DRIFT + type: string + enumDescriptions: + - Default value, should not be set. + - >- + Raw feature values' stats to detect skew between + Training-Prediction datasets. + - >- + Raw feature values' stats to detect drift between + Serving-Prediction datasets. + - >- + Feature attribution scores to detect skew between + Training-Prediction datasets. + - >- + Feature attribution scores to detect skew between Prediction + datasets collected within different time windows. + anomalyCount: + type: integer + description: Number of anomalies within all stats. + format: int32 + GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest: + properties: {} + description: Request message for JobService.CancelHyperparameterTuningJob. + id: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest type: object - description: Filters returning list of deteceted labels, scores, and bounding boxes. - id: CloudAiLargeModelsVisionRaiInfoDetectedLabels + GoogleCloudAiplatformV1GroundednessInput: + id: GoogleCloudAiplatformV1GroundednessInput + description: Input for groundedness metric. properties: - raiCategory: - description: The RAI category for the deteceted labels. - type: string - entities: + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInstance' + description: Required. Groundedness instance. + metricSpec: + description: Required. Spec for groundedness metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessSpec' + type: object + GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata: + id: GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: >- + Runtime operation information for + SpecialistPoolService.CreateSpecialistPool. + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics: + properties: + confidenceMetricsEntries: items: $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry type: array - description: The list of detected entities for the rai signal. - GoogleCloudAiplatformV1ListTrialsResponse: + description: >- + Metrics for each confidenceThreshold in + 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 Precision-recall curve + can be derived from it. + description: Metrics for image segmentation evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics type: object - id: GoogleCloudAiplatformV1ListTrialsResponse - description: Response message for VizierService.ListTrials. + GoogleCloudAiplatformV1CancelPipelineJobRequest: + id: GoogleCloudAiplatformV1CancelPipelineJobRequest + properties: {} + type: object + description: Request message for PipelineService.CancelPipelineJob. + GoogleCloudAiplatformV1GroundingChunk: + type: object + properties: + retrievedContext: + description: Grounding chunk from context retrieved by the retrieval tools. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GroundingChunkRetrievedContext + web: + description: Grounding chunk from the web. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunkWeb' + id: GoogleCloudAiplatformV1GroundingChunk + description: Grounding chunk. + GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse: + type: object + description: Response message for ListDeploymentResourcePools method. properties: + deploymentResourcePools: + type: array + description: The DeploymentResourcePools from the specified location. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' nextPageToken: description: >- - Pass this token as the `page_token` field of the request for a - subsequent call. If this field is omitted, there are no subsequent - pages. + 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 - trials: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - type: array - description: The Trials associated with the Study. - GoogleCloudAiplatformV1ListFeaturesResponse: + id: GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + GoogleCloudAiplatformV1FeatureOnlineStore: properties: - nextPageToken: + name: + type: string description: >- - A token, which can be sent as ListFeaturesRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - type: string - features: - description: The Features matching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - type: array - description: >- - Response message for FeaturestoreService.ListFeatures. Response message - for FeatureRegistryService.ListFeatures. - id: GoogleCloudAiplatformV1ListFeaturesResponse - type: object - GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for deleting a MetadataStore. - type: object - description: Details of operations that perform MetadataService.DeleteMetadataStore. - id: GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata - GoogleTypeExpr: - type: object - properties: - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - location: - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - type: string - description: - type: string - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - title: + Identifier. Name of the FeatureOnlineStore. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` + updateTime: + readOnly: true type: string + format: google-datetime description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - id: GoogleTypeExpr - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature: - description: >- - Response message if the request uses the SelectTimeRangeAndFeature - option. - id: >- - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature - properties: - impactedFeatureCount: + Output only. Timestamp when this FeatureOnlineStore was last + updated. + etag: type: string description: >- - The count of the features or columns impacted. This is the same as - the feature count in the request. - format: int64 - onlineStorageModifiedEntityCount: + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + dedicatedServingEndpoint: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint description: >- - The count of modified entities in the online storage. Each entity ID - corresponds to one entity. Within each entity, only the features - specified in the request are deleted. - format: int64 + Optional. The dedicated serving endpoint for this + FeatureOnlineStore, which is different from common Vertex service + endpoint. + state: + enum: + - STATE_UNSPECIFIED + - STABLE + - UPDATING + enumDescriptions: + - Default value. This value is unused. + - >- + State when the featureOnlineStore configuration is not being + updated and the fields reflect the current configuration of the + featureOnlineStore. The featureOnlineStore is usable in this + state. + - >- + The state of the featureOnlineStore configuration when it is being + updated. During an update, the fields reflect either the original + configuration or the updated configuration of the + featureOnlineStore. The featureOnlineStore is still usable in this + state. + description: Output only. State of the featureOnlineStore. + readOnly: true type: string - offlineStorageModifiedEntityRowCount: + encryptionSpec: description: >- - The count of modified entity rows in the offline storage. Each row - corresponds to the combination of an entity ID and a timestamp. One - entity ID can have multiple rows in the offline storage. Within each - row, only the features specified in the request are deleted. - format: int64 - type: string - type: object - GoogleCloudAiplatformV1ListTensorboardRunsResponse: - description: Response message for TensorboardService.ListTensorboardRuns. - type: object - properties: - nextPageToken: - type: string + Optional. Customer-managed encryption key spec for data storage. If + set, online store will be secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + labels: + additionalProperties: + type: string + type: object description: >- - A token, which can be sent as ListTensorboardRunsRequest.page_token - to retrieve the next page. If this field is omitted, there are no - subsequent pages. - tensorboardRuns: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - type: array - description: The TensorboardRuns mathching the request. - id: GoogleCloudAiplatformV1ListTensorboardRunsResponse - GoogleCloudAiplatformV1SummarizationHelpfulnessResult: - description: Spec for summarization helpfulness result. - properties: - score: - readOnly: true - format: float - type: number - description: Output only. Summarization Helpfulness score. - explanation: + Optional. The labels with user-defined metadata to organize your + FeatureOnlineStore. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureOnlineStore(System labels are excluded)." System + reserved label keys are prefixed with "aiplatform.googleapis.com/" + and are immutable. + satisfiesPzi: readOnly: true + type: boolean + description: Output only. Reserved for future use. + createTime: type: string - description: Output only. Explanation for summarization helpfulness score. - confidence: - description: Output only. Confidence for summarization helpfulness score. - type: number - format: float + description: Output only. Timestamp when this FeatureOnlineStore was created. + format: google-datetime readOnly: true - id: GoogleCloudAiplatformV1SummarizationHelpfulnessResult - type: object - GoogleCloudAiplatformV1BleuSpec: - type: object - description: >- - Spec for bleu score metric - calculates the precision of n-grams in the - prediction as compared to reference - returns a score ranging between 0 - to 1. - id: GoogleCloudAiplatformV1BleuSpec - properties: - useEffectiveOrder: - description: Optional. Whether to use_effective_order to compute bleu score. + bigtable: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + description: >- + Contains settings for the Cloud Bigtable instance that will be + created to serve featureValues for all FeatureViews under this + FeatureOnlineStore. + satisfiesPzs: type: boolean - GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse: - description: Response message for ModelService.BatchImportModelEvaluationSlices - type: object - id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse - properties: - importedModelEvaluationSlices: - items: - type: string readOnly: true - type: array - description: Output only. List of imported ModelEvaluationSlice.name. - GoogleCloudAiplatformV1FeatureNoiseSigma: + description: Output only. Reserved for future use. + optimized: + description: >- + Contains settings for the Optimized store that will be created to + serve featureValues for all FeatureViews under this + FeatureOnlineStore. When choose Optimized storage type, need to set + PrivateServiceConnectConfig.enable_private_service_connect to use + private endpoint. Otherwise will use public endpoint by default. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreOptimized + type: object + id: GoogleCloudAiplatformV1FeatureOnlineStore description: >- - Noise sigma by features. Noise sigma represents the standard deviation - of the gaussian kernel that will be used to add noise to interpolated - inputs prior to computing gradients. + Vertex AI Feature Online Store provides a centralized repository for + serving ML features and embedding indexes at low latency. The Feature + Online Store is a top-level container. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics: type: object - id: GoogleCloudAiplatformV1FeatureNoiseSigma properties: - noiseSigma: + videoActionMetrics: type: array - description: >- - Noise sigma per feature. No noise is added to features that are not - set. + description: 'The metric entries for precision window lengths: 1s,2s,3s.' items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature - GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec: + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + evaluatedActionCount: + description: The number of ground truth actions used to create this evaluation. + type: integer + format: int32 + description: Model evaluation metrics for video action recognition. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs: properties: - maxReplicaCount: - format: int64 - type: string + optimizationObjective: description: >- - Optional. max replicas in the node pool, must be ≥ replica_count and - > min_replica_count or will throw error - minReplicaCount: + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. type: string + quantiles: + type: array + description: >- + Quantiles to use for minimize-quantile-loss + `optimization_objective`. Up to 5 quantiles are allowed of values + between 0 and 1, exclusive. Required if the value of + optimization_objective is minimize-quantile-loss. Represents the + percent quantiles to use for that objective. Quantiles must be + unique. + items: + format: double + type: number + hierarchyConfig: + description: >- + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + contextWindow: format: int64 + type: string description: >- - Optional. min replicas in the node pool, must be ≤ replica_count and - < max_replica_count or will throw error. For autoscaling enabled - Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 - to match the OSS Ray - behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). - As for Persistent Resource, the min_replica_count must be > 0, we - added a corresponding validation inside - CreatePersistentResourceRequestValidator.java. - description: The min/max number of replicas allowed if enabling autoscaling - id: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics: - type: object - description: Metrics for classification evaluation results. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics - properties: - auPrc: + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. + exportEvaluatedDataItemsConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig description: >- - The Area Under Precision-Recall Curve metric. Micro-averaged for the - overall evaluation. - type: number - format: float - confidenceMetrics: + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + targetColumn: + description: >- + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + type: string + timeSeriesAttributeColumns: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + type: string description: >- - Metrics for each `confidenceThreshold` in - 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and `positionThreshold` - = INT32_MAX_VALUE. ROC and precision-recall curves, and other - aggregated metrics are derived from them. The confidence metrics - entries may also be supplied for additional values of - `positionThreshold`, but from these no aggregated metrics are - computed. + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. type: array - confusionMatrix: - description: Confusion matrix of the evaluation. + windowConfig: + description: Config containing strategy for generating sliding windows. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - logLoss: - format: float - description: The Log Loss metric. - type: number - auRoc: - format: float + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + availableAtForecastColumns: description: >- - The Area Under Receiver Operating Characteristic curve metric. - Micro-averaged for the overall evaluation. - type: number - GoogleCloudAiplatformV1SuggestTrialsMetadata: - properties: - clientId: + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. + items: + type: string + type: array + validationOptions: + description: >- + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + type: string + forecastHorizon: + format: int64 type: string description: >- - The identifier of the client that is requesting the suggestion. If - multiple SuggestTrialsRequests have the same `client_id`, the - service will return the identical suggested Trial if the Trial is - pending, and provide a new Trial if the last suggested Trial was - completed. - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for suggesting Trials. - description: Details of operations that perform Trials suggestion. - id: GoogleCloudAiplatformV1SuggestTrialsMetadata - type: object - GoogleCloudAiplatformV1NotebookIdleShutdownConfig: - description: >- - The idle shutdown configuration of NotebookRuntimeTemplate, which - contains the idle_timeout as required field. - id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig - properties: - idleTimeout: + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. + weightColumn: description: >- - Required. Duration is accurate to the second. In Notebook, Idle - Timeout is accurate to minute so the range of idle_timeout (second) - is: 10 * 60 ~ 1440 * 60. - format: google-duration - type: string - idleShutdownDisabled: - type: boolean - description: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. - type: object - GoogleCloudAiplatformV1ListPersistentResourcesResponse: - description: Response message for PersistentResourceService.ListPersistentResources - id: GoogleCloudAiplatformV1ListPersistentResourcesResponse - properties: - nextPageToken: + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. This column must be available at forecast. type: string + transformations: + type: array description: >- - A token to retrieve next page of results. Pass to - ListPersistentResourcesRequest.page_token to obtain that page. - persistentResources: + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation + unavailableAtForecastColumns: + description: >- + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. type: array - type: object - GoogleCloudAiplatformV1ModelDataStats: - description: Stats of data used for train or evaluate the Model. - properties: - testAnnotationsCount: - format: int64 + items: + type: string + additionalExperiments: + description: Additional experiment flags for the time series forcasting training. + type: array + items: + type: string + timeColumn: type: string description: >- - Number of Annotations that are used for evaluating this Model. If - the Model is evaluated multiple times, this will be the number of - test Annotations used by the first evaluation. If the Model is not - evaluated, the number is 0. - validationAnnotationsCount: - type: string + The name of the column that identifies time order in the time + series. This column must be available at forecast. + dataGranularity: + description: Expected difference in time granularity between rows in the data. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity + holidayRegions: description: >- - Number of Annotations that are used for validating this Model during - training. - format: int64 - trainingAnnotationsCount: - description: Number of Annotations that are used for training this Model. + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. + items: + type: string + type: array + trainBudgetMilliNodeHours: type: string - format: int64 - validationDataItemsCount: - format: int64 description: >- - Number of DataItems that were used for validating this Model during - training. + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. + format: int64 + timeSeriesIdentifierColumn: type: string - trainingDataItemsCount: + description: The name of the column that identifies the time series. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs + GoogleCloudAiplatformV1PairwiseMetricSpec: + description: Spec for pairwise metric. + properties: + metricPromptTemplate: type: string - description: Number of DataItems that were used for training this Model. + description: Required. Metric prompt template for pairwise metric. + type: object + id: GoogleCloudAiplatformV1PairwiseMetricSpec + GoogleCloudAiplatformV1ActiveLearningConfig: + properties: + maxDataItemPercentage: + format: int32 + type: integer + description: Max percent of total DataItems for human labeling. + trainingConfig: + description: >- + CMLE training config. For every active learning labeling iteration, + system will train a machine learning model on CMLE. The trained + model will be used by data sampling algorithm to select DataItems. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' + maxDataItemCount: format: int64 - testDataItemsCount: + description: Max number of human labeled DataItems. type: string - format: int64 + sampleConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' description: >- - Number of DataItems that were used for evaluating this Model. If the - Model is evaluated multiple times, this will be the number of test - DataItems used by the first evaluation. If the Model is not - evaluated, the number is 0. - type: object - id: GoogleCloudAiplatformV1ModelDataStats - GoogleCloudAiplatformV1IndexEndpoint: + Active learning data sampling config. For every active learning + labeling iteration, it will select a batch of data based on the + sampling strategy. + id: GoogleCloudAiplatformV1ActiveLearningConfig description: >- - Indexes are deployed into it. An IndexEndpoint can have multiple - DeployedIndexes. + 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. + type: object + GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec: + id: GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec + type: object properties: - satisfiesPzs: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - encryptionSpec: + defaultValue: description: >- - Immutable. Customer-managed encryption key spec for an - IndexEndpoint. If set, this IndexEndpoint and all sub-resources of - this IndexEndpoint will be secured by this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - updateTime: + A default value for a `CATEGORICAL` parameter that is assumed to be + a relatively good starting point. Unset value signals that there is + no offered starting point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. type: string - format: google-datetime - readOnly: true - description: >- - Output only. Timestamp when this IndexEndpoint was last updated. - This timestamp is not updated when the endpoint's DeployedIndexes - are updated, e.g. due to updates of the original Indexes they are - the deployments of. - privateServiceConnectConfig: + values: + description: Required. The list of possible categories. + type: array + items: + type: string + description: Value specification for a parameter in `CATEGORICAL` type. + GoogleCloudAiplatformV1StudySpecParameterSpec: + type: object + properties: + discreteValueSpec: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec + description: The value spec for a 'DISCRETE' parameter. + categoricalValueSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec + description: The value spec for a 'CATEGORICAL' parameter. + conditionalParameterSpecs: description: >- - Optional. Configuration for private service connect. network and - private_service_connect_config are mutually exclusive. - displayName: + A conditional parameter node is active if the parameter's value + matches the conditional node's parent_value_condition. If two items + in conditional_parameter_specs have the same name, they must have + disjoint parent_value_condition. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec + type: array + scaleType: + type: string + enum: + - SCALE_TYPE_UNSPECIFIED + - UNIT_LINEAR_SCALE + - UNIT_LOG_SCALE + - UNIT_REVERSE_LOG_SCALE description: >- - Required. The display name of the IndexEndpoint. The name can be up - to 128 characters long and can consist of any UTF-8 characters. + How the parameter should be scaled. Leave unset for `CATEGORICAL` + parameters. + enumDescriptions: + - By default, no scaling is applied. + - Scales the feasible space to (0, 1) linearly. + - >- + Scales the feasible space logarithmically to (0, 1). The entire + feasible space must be strictly positive. + - >- + Scales the feasible space "reverse" logarithmically to (0, 1). The + result is that values close to the top of the feasible space are + spread out more than points near the bottom. The entire feasible + space must be strictly positive. + integerValueSpec: + description: The value spec for an 'INTEGER' parameter. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec + parameterId: type: string - name: - description: Output only. The resource name of the IndexEndpoint. + description: >- + Required. The ID of the parameter. Must not contain whitespaces and + must be unique amongst all ParameterSpecs. + doubleValueSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + description: The value spec for a 'DOUBLE' parameter. + id: GoogleCloudAiplatformV1StudySpecParameterSpec + description: Represents a single parameter to optimize. + GoogleCloudAiplatformV1ToolCallValidMetricValue: + type: object + properties: + score: readOnly: true + type: number + format: float + description: Output only. Tool call valid score. + id: GoogleCloudAiplatformV1ToolCallValidMetricValue + description: Tool call valid metric value for an instance. + GoogleCloudAiplatformV1DoubleArray: + properties: + values: + items: + type: number + format: double + type: array + description: A list of double values. + id: GoogleCloudAiplatformV1DoubleArray + description: A list of double values. + type: object + GoogleIamV1TestIamPermissionsResponse: + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + type: object + id: GoogleIamV1TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable: + properties: + logSource: + enum: + - LOG_SOURCE_UNSPECIFIED + - TRAINING + - SERVING + description: The source of log. + enumDescriptions: + - Unspecified source. + - Logs coming from Training dataset. + - Logs coming from Serving traffic. type: string - createTime: + requestResponseLoggingSchemaVersion: type: string - format: google-datetime - description: Output only. Timestamp when this IndexEndpoint was created. readOnly: true - description: - type: string - description: The description of the IndexEndpoint. - etag: + description: >- + Output only. The schema version of the request/response logging + BigQuery table. Default to v1 if unset. + logType: + description: The type of log. + enumDescriptions: + - Unspecified type. + - Predict logs. + - Explain logs. type: string + enum: + - LOG_TYPE_UNSPECIFIED + - PREDICT + - EXPLAIN + bigqueryTablePath: description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - labels: - additionalProperties: - type: string + The created BigQuery table to store logs. Customer could do their + own query & analysis. Format: `bq://.model_deployment_monitoring_._` + type: string + description: >- + ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name + as well as some information of the logs stored in this table. + type: object + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable + GoogleCloudAiplatformV1SummarizationVerbosityInput: + type: object + description: Input for summarization verbosity metric. + properties: + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInstance + description: Required. Summarization verbosity instance. + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbositySpec + description: Required. Spec for summarization verbosity score metric. + id: GoogleCloudAiplatformV1SummarizationVerbosityInput + GoogleCloudAiplatformV1MigratableResourceAutomlModel: + type: object + properties: + modelDisplayName: + description: The Model's display name in automl.googleapis.com. + type: string + model: description: >- - The labels with user-defined metadata to organize your - IndexEndpoints. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. - type: object - publicEndpointDomainName: + Full resource name of automl Model. Format: + `projects/{project}/locations/{location}/models/{model}`. type: string - readOnly: true + id: GoogleCloudAiplatformV1MigratableResourceAutomlModel + description: Represents one Model in automl.googleapis.com. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics: + description: >- + Model evaluation metrics for video object tracking problems. Evaluates + prediction quality of both labeled bounding boxes and labeled tracks + (i.e. series of bounding boxes sharing same label and instance ID). + properties: + trackMeanMismatchRate: description: >- - Output only. If public_endpoint_enabled is true, this field will be - populated with the domain name to use for this index endpoint. - deployedIndexes: + UNIMPLEMENTED. The single metric for tracking consistency + evaluation: the `meanMismatchRate` averaged over all `trackMetrics`. + type: number + format: float + trackMetrics: + description: >- + UNIMPLEMENTED. The tracks match metrics for each + intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - description: Output only. The indexes deployed in this endpoint. - readOnly: true - satisfiesPzi: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - enablePrivateServiceConnect: - description: >- - Optional. Deprecated: If true, expose the IndexEndpoint via private - service connect. Only one of the fields, network or - enable_private_service_connect, can be set. - deprecated: true - type: boolean - publicEndpointEnabled: - type: boolean + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics + boundingBoxMeanAveragePrecision: + format: float + type: number description: >- - Optional. If true, the deployed index will be accessible through - public endpoint. - network: - type: string + The single metric for bounding boxes evaluation: the + `meanAveragePrecision` averaged over all `boundingBoxMetrics`. + boundingBoxMetrics: description: >- - Optional. The full name of the Google Compute Engine - [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) - to which the IndexEndpoint should be peered. Private services access - must already be configured for the network. If left unspecified, the - Endpoint is not peered with any network. network and - private_service_connect_config are mutually exclusive. - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where {project} is a - project number, as in '12345', and {network} is network name. - id: GoogleCloudAiplatformV1IndexEndpoint - type: object - GoogleCloudAiplatformV1ListTensorboardsResponse: - description: Response message for TensorboardService.ListTensorboards. - id: GoogleCloudAiplatformV1ListTensorboardsResponse - properties: - tensorboards: - description: The Tensorboards mathching the request. + The bounding boxes match metrics for each intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics type: array - nextPageToken: - type: string + evaluatedBoundingBoxCount: + format: int32 description: >- - A token, which can be sent as ListTensorboardsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - type: object - GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource: - description: The Dataform Repository containing the input notebook. - properties: - commitSha: - type: string + UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over + all frames) the ground truth used to create this evaluation had. + type: integer + evaluatedTrackCount: + format: int32 + type: integer description: >- - The commit SHA to read repository with. If unset, the file will be - read at HEAD. - dataformRepositoryResourceName: + UNIMPLEMENTED. The total number of tracks (i.e. as seen across all + frames) the ground truth used to create this evaluation had. + trackMeanAveragePrecision: + type: number description: >- - The resource name of the Dataform Repository. Format: - `projects/{project_id}/locations/{location}/repositories/{repository_id}` - type: string + UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the + `meanAveragePrecision` averaged over all `trackMetrics`. + format: float + trackMeanBoundingBoxIou: + format: float + type: number + description: >- + UNIMPLEMENTED. The single metric for tracks bounding box iou + evaluation: the `meanBoundingBoxIou` averaged over all + `trackMetrics`. + evaluatedFrameCount: + description: >- + UNIMPLEMENTED. The number of video frames used to create this + evaluation. + format: int32 + type: integer type: object - id: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource - GoogleCloudAiplatformV1PscAutomatedEndpoints: - id: GoogleCloudAiplatformV1PscAutomatedEndpoints + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics + GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata: + id: GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata + description: Details of operations that perform batch create Features. properties: - projectId: - type: string - description: Corresponding project_id in pscAutomationConfigs - matchAddress: - type: string - description: Ip Address created by the automated forwarding rule. - network: - type: string - description: Corresponding network in pscAutomationConfigs. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature. + type: object + GoogleCloudAiplatformV1ExportFilterSplit: type: object description: >- - PscAutomatedEndpoints defines the output of the forwarding rule - automatically created by each PscAutomationConfig. - GoogleCloudAiplatformV1SafetyInstance: - description: Spec for safety instance. + Assigns input data to training, validation, and test sets based on the + given filters, data pieces not matched by any filter are ignored. + Currently only supported for Datasets containing DataItems. If any of + the filters in this message are to match nothing, then they can be set + as '-' (the minus sign). Supported only for unstructured Datasets. + id: GoogleCloudAiplatformV1ExportFilterSplit properties: - prediction: - description: Required. Output of the evaluated model. + validationFilter: + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to validate the Model. A filter with same + syntax as the one used in DatasetService.ListDataItems may be used. + If a single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. type: string - id: GoogleCloudAiplatformV1SafetyInstance + trainingFilter: + type: string + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to train the Model. A filter with same syntax + as the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + testFilter: + type: string + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to test the Model. A filter with same syntax as + the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + GoogleCloudAiplatformV1UpdateFeatureOperationMetadata: + description: Details of operations that perform update Feature. + id: GoogleCloudAiplatformV1UpdateFeatureOperationMetadata type: object - GoogleCloudAiplatformV1TensorboardTimeSeries: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature Update. + GoogleCloudAiplatformV1FeatureValue: + id: GoogleCloudAiplatformV1FeatureValue type: object + description: Value for a feature. properties: - pluginData: + stringValue: + description: String feature value. + type: string + stringArrayValue: + description: A list of string type feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StringArray' + boolValue: + type: boolean + description: Bool type feature value. + boolArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BoolArray' + description: A list of bool type feature value. + int64ArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Int64Array' + description: A list of int64 type feature value. + structValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StructValue' + description: A struct type feature value. + doubleArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DoubleArray' + description: A list of double type feature value. + metadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueMetadata' + description: Metadata of feature value. + doubleValue: + type: number + description: Double type feature value. + format: double + int64Value: + description: Int64 feature value. type: string + format: int64 + bytesValue: format: byte - description: Data of the current plugin, with the size limited to 65KB. - etag: type: string - description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - pluginName: + description: Bytes feature value. + GoogleCloudAiplatformV1ModelEvaluation: + id: GoogleCloudAiplatformV1ModelEvaluation + description: >- + A collection of metrics calculated by comparing Model's predictions on + all of the test data against annotations from the test data. + type: object + properties: + annotationSchemaUri: type: string description: >- - Immutable. Name of the plugin this time series pertain to. Such as - Scalar, Tensor, Blob - createTime: - format: google-datetime - description: Output only. Timestamp when this TensorboardTimeSeries was created. - type: string - readOnly: true - description: - type: string - description: Description of this TensorboardTimeSeries. - updateTime: - readOnly: true + Points to a YAML file stored on Google Cloud Storage describing + EvaluatedDataItemView.predictions, + EvaluatedDataItemView.ground_truths, + EvaluatedAnnotation.predictions, and + EvaluatedAnnotation.ground_truths. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + This field is not populated if there are neither + EvaluatedDataItemViews nor EvaluatedAnnotations under this + ModelEvaluation. + dataItemSchemaUri: type: string description: >- - Output only. Timestamp when this TensorboardTimeSeries was last - updated. - format: google-datetime + Points to a YAML file stored on Google Cloud Storage describing + EvaluatedDataItemView.data_item_payload and + EvaluatedAnnotation.data_item_payload. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + This field is not populated if there are neither + EvaluatedDataItemViews nor EvaluatedAnnotations under this + ModelEvaluation. + sliceDimensions: + type: array + items: + type: string + description: >- + All possible dimensions of ModelEvaluationSlices. The dimensions can + be used as the filter of the ModelService.ListModelEvaluationSlices + request, in the form of `slice.dimension = `. + modelExplanation: + description: >- + Aggregated explanation metrics for the Model's prediction output + over the data this ModelEvaluation uses. This field is populated + only if the Model is evaluated with explanations, and only for + AutoML tabular Models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' + metrics: + type: any + description: >- + Evaluation metrics of the Model. The schema of the metrics is stored + in metrics_schema_uri name: - description: Output only. Name of the TensorboardTimeSeries. type: string + description: Output only. The resource name of the ModelEvaluation. readOnly: true + explanationSpecs: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + description: >- + Describes the values of ExplanationSpec that are used for explaining + the predicted values on the evaluated data. metadata: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata description: >- - Output only. Scalar, Tensor, or Blob metadata for this - TensorboardTimeSeries. + The metadata of the ModelEvaluation. For the ModelEvaluation + uploaded from Managed Pipeline, metadata contains a structured value + with keys of "pipeline_job_id", "evaluation_dataset_type", + "evaluation_dataset_path", "row_based_metrics_path". + type: any + createTime: + readOnly: true + type: string + description: Output only. Timestamp when this ModelEvaluation was created. + format: google-datetime displayName: - description: >- - Required. User provided name of this TensorboardTimeSeries. This - value should be unique among all TensorboardTimeSeries resources - belonging to the same TensorboardRun resource (parent resource). + description: The display name of the ModelEvaluation. type: string - valueType: + metricsSchemaUri: type: string - enumDescriptions: - - The value type is unspecified. - - >- - Used for TensorboardTimeSeries that is a list of scalars. E.g. - accuracy of a model over epochs/time. - - >- - Used for TensorboardTimeSeries that is a list of tensors. E.g. - histograms of weights of layer in a model over epoch/time. - - >- - Used for TensorboardTimeSeries that is a list of blob sequences. - E.g. set of sample images with labels over epochs/time. - enum: - - VALUE_TYPE_UNSPECIFIED - - SCALAR - - TENSOR - - BLOB_SEQUENCE - description: Required. Immutable. Type of TensorboardTimeSeries value. - description: TensorboardTimeSeries maps to times series produced in training runs - id: GoogleCloudAiplatformV1TensorboardTimeSeries - GoogleCloudAiplatformV1Attribution: - id: GoogleCloudAiplatformV1Attribution - description: Attribution that explains a particular prediction output. + description: >- + Points to a YAML file stored on Google Cloud Storage describing the + metrics of this ModelEvaluation. The schema is defined as an OpenAPI + 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance: + description: Spec for pairwise summarization quality instance. properties: - outputName: + reference: + description: Optional. Ground truth used to compare against the prediction. type: string - description: >- - Output only. Name of the explain output. Specified as the key in - ExplanationMetadata.outputs. - readOnly: true - outputIndex: - type: array - description: >- - Output only. The index that locates the explained prediction output. - If the prediction output is a scalar value, output_index is not - populated. If the prediction output has multiple dimensions, the - length of the output_index list is the same as the number of - dimensions of the output. The i-th element in output_index is the - element index of the i-th dimension of the output vector. Indices - start from 0. - items: - type: integer - format: int32 - readOnly: true - instanceOutputValue: - format: double - description: >- - Output only. Model predicted output on the corresponding explanation - instance. The field name of the output is determined by the key in - ExplanationMetadata.outputs. If the Model predicted output has - multiple dimensions, this is the value in the output located by - output_index. - type: number - readOnly: true - approximationError: - format: double - description: >- - Output only. Error of feature_attributions caused by approximation - used in the explanation method. Lower value means more precise - attributions. * For Sampled Shapley attribution, increasing - path_count might reduce the error. * For Integrated Gradients - attribution, increasing step_count might reduce the error. * For - XRAI attribution, increasing step_count might reduce the error. See - [this introduction](/vertex-ai/docs/explainable-ai/overview) for - more information. - readOnly: true - type: number - baselineOutputValue: - description: >- - Output only. Model predicted output if the input instance is - constructed from the baselines of all the features defined in - ExplanationMetadata.inputs. The field name of the output is - determined by the key in ExplanationMetadata.outputs. If the Model's - predicted output has multiple dimensions (rank > 1), this is the - value in the output located by output_index. If there are multiple - baselines, their output values are averaged. - readOnly: true - format: double - type: number - featureAttributions: - type: any - readOnly: true - description: >- - Output only. Attributions of each explained feature. Features are - extracted from the prediction instances according to explanation - metadata for inputs. The value is a struct, whose keys are the name - of the feature. The values are how much the feature in the instance - contributed to the predicted result. The format of the value is - determined by the feature's input format: * If the feature is a - scalar value, the attribution value is a floating number. * If the - feature is an array of scalar values, the attribution value is an - array. * If the feature is a struct, the attribution value is a - struct. The keys in the attribution value struct are the same as the - keys in the feature struct. The formats of the values in the - attribution struct are determined by the formats of the values in - the feature struct. The - ExplanationMetadata.feature_attributions_schema_uri field, pointed - to by the ExplanationSpec field of the Endpoint.deployed_models - object, points to the schema file that describes the features and - their attribution values (if it is populated). - outputDisplayName: - description: >- - Output only. The display name of the output identified by - output_index. For example, the predicted class name by a - multi-classification Model. This field is only populated iff the - Model predicts display names as a separate field along with the - explained output. The predicted display name must has the same shape - of the explained output, and can be located using output_index. - readOnly: true + instruction: + description: Required. Summarization prompt for LLM. type: string + prediction: + type: string + description: Required. Output of the candidate model. + context: + description: Required. Text to be summarized. + type: string + baselinePrediction: + type: string + description: Required. Output of the baseline model. + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance type: object - GoogleCloudAiplatformV1FeaturestoreMonitoringConfig: - type: object + GoogleCloudAiplatformV1EvaluateInstancesRequest: + id: GoogleCloudAiplatformV1EvaluateInstancesRequest properties: - snapshotAnalysis: + summarizationVerbosityInput: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis - description: The config for Snapshot Analysis Based Feature Monitoring. - numericalThresholdConfig: + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInput + description: Input for summarization verbosity metric. + pointwiseMetricInput: + description: Input for pointwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInput' + summarizationHelpfulnessInput: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInput + description: Input for summarization helpfulness metric. + questionAnsweringHelpfulnessInput: + description: Input for question answering helpfulness metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput + toolNameMatchInput: + description: Input for tool name match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInput' + pairwiseSummarizationQualityInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInput + description: Input for pairwise summarization quality metric. + toolParameterKvMatchInput: + description: Input for tool parameter key value match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInput + exactMatchInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInput' description: >- - Threshold for numerical features of anomaly detection. This is - shared by all objectives of Featurestore Monitoring for numerical - features (i.e. Features with type (Feature.ValueType) DOUBLE or - INT64). - categoricalThresholdConfig: + Auto metric instances. Instances and metric spec for exact match + metric. + pairwiseMetricInput: + description: Input for pairwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInput' + summarizationQualityInput: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInput + description: Input for summarization quality metric. + pairwiseQuestionAnsweringQualityInput: + description: Input for pairwise question answering quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput + fluencyInput: description: >- - Threshold for categorical features of anomaly detection. This is - shared by all types of Featurestore Monitoring for categorical - features (i.e. Features with type (Feature.ValueType) BOOL or - STRING). - importFeaturesAnalysis: + LLM-based metric instance. General text generation metrics, + applicable to other categories. Input for fluency metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInput' + questionAnsweringQualityInput: + description: Input for question answering quality metric. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis - description: The config for ImportFeatures Analysis Based Feature Monitoring. - description: Configuration of how features in Featurestore are monitored. - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfig - GoogleCloudAiplatformV1ExportDataRequest: - description: Request message for DatasetService.ExportData. + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInput + bleuInput: + description: Instances and metric spec for bleu metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInput' + toolParameterKeyMatchInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInput + description: Input for tool parameter key match metric. + groundednessInput: + description: Input for groundedness metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInput' + toolCallValidInput: + description: Tool call metric instances. Input for tool call valid metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInput' + rougeInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInput' + description: Instances and metric spec for rouge metric. + fulfillmentInput: + description: Input for fulfillment metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInput' + questionAnsweringCorrectnessInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput + description: Input for question answering correctness metric. + coherenceInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInput' + description: Input for coherence metric. + safetyInput: + description: Input for safety metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInput' + questionAnsweringRelevanceInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput + description: Input for question answering relevance metric. + description: Request message for EvaluationService.EvaluateInstances. type: object - id: GoogleCloudAiplatformV1ExportDataRequest - properties: - exportConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataConfig' - description: Required. The desired output location. - GoogleCloudAiplatformV1BatchReadFeatureValuesRequest: + GoogleCloudAiplatformV1ToolNameMatchMetricValue: + id: GoogleCloudAiplatformV1ToolNameMatchMetricValue type: object - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + description: Tool name match metric value for an instance. properties: - startTime: - description: >- - Optional. Excludes Feature values with feature generation timestamp - before this timestamp. If not set, retrieve oldest values kept in - Feature Store. Timestamp, if present, must not have higher than - millisecond precision. + score: + description: Output only. Tool name match score. + readOnly: true + format: float + type: number + GoogleCloudAiplatformV1GroundednessInstance: + properties: + context: type: string - format: google-datetime - bigqueryReadInstances: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: Similar to csv_read_instances, but from BigQuery source. - csvReadInstances: - description: >- - Each read instance consists of exactly one read timestamp and one or - more entity IDs identifying entities of the corresponding - EntityTypes whose Features are requested. Each output instance - contains Feature values of requested entities concatenated together - as of the read time. An example read instance may be `foo_entity_id, - bar_entity_id, 2020-01-01T10:00:00.123Z`. An example output instance - may be `foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, - foo_entity_feature1_value, bar_entity_feature2_value`. Timestamp in - each read instance must be millisecond-aligned. `csv_read_instances` - are read instances stored in a plain-text CSV file. The header - should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The - columns can be in any order. Values in the timestamp column must use - the RFC 3339 format, e.g. `2012-07-30T10:43:17.123Z`. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - entityTypeSpecs: - description: >- - Required. Specifies EntityType grouping Features to read values of - and settings. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec - destination: - description: Required. Specifies output location and format. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' - passThroughFields: description: >- - When not empty, the specified fields in the *_read_instances source - will be joined as-is in the output, in addition to those fields from - the Featurestore Entity. For BigQuery source, the type of the - pass-through values will be automatically inferred. For CSV source, - the pass-through values will be passed as opaque bytes. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField - type: array - description: Request message for FeaturestoreService.BatchReadFeatureValues. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics: + Required. Background information provided in context used to compare + against the prediction. + prediction: + description: Required. Output of the evaluated model. + type: string + id: GoogleCloudAiplatformV1GroundednessInstance + description: Spec for groundedness instance. + type: object + GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse: + id: GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + description: Response message for JobService.ListModelDeploymentMonitoringJobs. properties: - boundingBoxMetrics: - type: array + modelDeploymentMonitoringJobs: description: >- - The bounding boxes match metrics for each intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + A list of ModelDeploymentMonitoringJobs that matches the specified + filter in the request. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - evaluatedBoundingBoxCount: - format: int32 - type: integer - description: >- - The total number of bounding boxes (i.e. summed over all images) the - ground truth used to create this evaluation had. - boundingBoxMeanAveragePrecision: - description: >- - The single metric for bounding boxes evaluation: the - `meanAveragePrecision` averaged over all - `boundingBoxMetricsEntries`. - type: number - format: float - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics - type: object - description: Metrics for image object detection evaluation results. - GoogleCloudAiplatformV1StructValue: - type: object - properties: - values: + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StructFieldValue' - description: A list of field values. - id: GoogleCloudAiplatformV1StructValue - description: Struct (or object) type feature value. - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: + nextPageToken: + type: string + description: The standard List next-page token. type: object - id: >- - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult - description: >- - Represents a partial result in batch migration operation for one - MigrateResourceRequest. + GoogleCloudAiplatformV1TrialParameter: properties: - request: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + value: + readOnly: true description: >- - It's the same as the value in - MigrateResourceRequest.migrate_resource_requests. - model: - description: Migrated model resource name. - type: string - dataset: - description: Migrated dataset resource name. + Output only. The value of the parameter. `number_value` will be set + if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' + or 'DISCRETE'. `string_value` will be set if a parameter defined in + StudySpec is in type 'CATEGORICAL'. + type: any + parameterId: + readOnly: true + description: >- + Output only. The ID of the parameter. The parameter should be + defined in StudySpec's Parameters. type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The error result of the migration request in case of failure. - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats: + id: GoogleCloudAiplatformV1TrialParameter type: object - id: >- - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats + description: A message representing a parameter to be tuned. + GoogleCloudAiplatformV1ReadTensorboardSizeResponse: properties: - validRecordCount: - type: string - format: int64 - description: Number of records in this file that were successfully processed. - invalidRecordCount: - format: int64 - description: Number of records in this file we skipped due to validate errors. - type: string - partialErrors: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError - description: >- - The detail information of the partial failures encountered for those - invalid records that couldn't be parsed. Up to 50 partial errors - will be reported. - sourceGcsUri: - description: Cloud Storage URI pointing to the original file in user's bucket. - type: string - invalidSparseRecordCount: - format: int64 - type: string - description: >- - Number of sparse records in this file we skipped due to validate - errors. - validSparseRecordCount: + storageSizeByte: format: int64 - description: >- - Number of sparse records in this file that were successfully - processed. + description: Payload storage size for the TensorBoard type: string - GoogleCloudAiplatformV1ExportFilterSplit: + type: object + description: Response message for TensorboardService.ReadTensorboardSize. + id: GoogleCloudAiplatformV1ReadTensorboardSizeResponse + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig: + id: >- + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig + type: object + description: The config for Prediction data drift detection. properties: - trainingFilter: - type: string + attributionScoreDriftThresholds: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to train the Model. A filter with same syntax - as the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - validationFilter: - type: string + Key is the feature name and value is the threshold. The threshold + here is against attribution score distance between different time + windows. + type: object + driftThresholds: + type: object description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to validate the Model. A filter with same - syntax as the one used in DatasetService.ListDataItems may be used. - If a single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - testFilter: + Key is the feature name and value is the threshold. If a feature + needs to be monitored for drift, a value threshold must be + configured for that feature. The threshold here is against feature + distribution distance between different time windws. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + defaultDriftThreshold: description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to test the Model. A filter with same syntax as - the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - type: string + Drift anomaly detection threshold used by all features. When the + per-feature thresholds are not set, this field can be used to + specify a threshold for all features. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse: + id: GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse type: object description: >- - Assigns input data to training, validation, and test sets based on the - given filters, data pieces not matched by any filter are ignored. - Currently only supported for Datasets containing DataItems. If any of - the filters in this message are to match nothing, then they can be set - as '-' (the minus sign). Supported only for unstructured Datasets. - id: GoogleCloudAiplatformV1ExportFilterSplit - GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput: - description: Input for question answering correctness metric. - type: object - id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput + Response message for + TensorboardService.BatchReadTensorboardTimeSeriesData. properties: - metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec - description: Required. Spec for question answering correctness score metric. - instance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance - description: Required. Question answering correctness instance. - GoogleCloudAiplatformV1ImportModelEvaluationRequest: + timeSeriesData: + description: The returned time series data. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + type: array + GoogleCloudAiplatformV1DeployModelRequest: type: object - id: GoogleCloudAiplatformV1ImportModelEvaluationRequest properties: - modelEvaluation: - description: Required. Model evaluation resource to be imported. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' - description: Request message for ModelService.ImportModelEvaluation - GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata: - id: GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata - description: Details of operations that perform update Featurestore. + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: >- + Required. The DeployedModel to be created within the Endpoint. Note + that Endpoint.traffic_split must be updated for the DeployedModel to + start receiving traffic, either as part of this call, or via + EndpointService.UpdateEndpoint. + trafficSplit: + description: >- + A map from a DeployedModel's ID to the percentage of this Endpoint's + traffic that should be forwarded to that DeployedModel. If this + field is non-empty, then the Endpoint's traffic_split will be + overwritten with it. To refer to the ID of the just being deployed + Model, a "0" should be used, and the actual ID of the new + DeployedModel will be filled in its place by this method. The + traffic percentage values must add up to 100. If this field is + empty, then the Endpoint's traffic_split is not updated. + type: object + additionalProperties: + format: int32 + type: integer + id: GoogleCloudAiplatformV1DeployModelRequest + description: Request message for EndpointService.DeployModel. + GoogleCloudAiplatformV1ModelBaseModelSource: + type: object properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore. + genieSource: + description: Information about the base model of Genie models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenieSource' + modelGardenSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelGardenSource' + description: Source information of Model Garden models. + description: >- + User input field to specify the base model source. Currently it only + supports specifing the Model Garden models and Genie models. + id: GoogleCloudAiplatformV1ModelBaseModelSource + GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest: + id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest type: object - GoogleCloudAiplatformV1AddExecutionEventsResponse: - properties: {} - id: GoogleCloudAiplatformV1AddExecutionEventsResponse - description: Response message for MetadataService.AddExecutionEvents. + description: >- + Request message for + FeaturestoreOnlineServingService.StreamingFeatureValuesRead. + properties: + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + description: >- + Required. Selector choosing Features of the target EntityType. + Feature IDs will be deduplicated. + entityIds: + items: + type: string + type: array + description: >- + Required. IDs of entities to read Feature values of. The maximum + number of IDs is 100. For example, for a machine learning model + predicting user clicks on a website, an entity ID could be + `user_123`. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation: + properties: + columnName: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Tokenize text to words. Convert each words to a dictionary lookup + index and generate an embedding for each index. Combine the embedding of + all elements into a single embedding using the mean. * Tokenization is + based on unicode script boundaries. * Missing values get their own + lookup index and resulting embedding. * Stop-words receive no special + treatment and are not removed. type: object - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation: - id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation - description: Annotation details specific to image segmentation. + GoogleCloudAiplatformV1DeleteFeatureValuesResponse: + description: Response message for FeaturestoreService.DeleteFeatureValues. + id: GoogleCloudAiplatformV1DeleteFeatureValuesResponse type: object properties: - maskAnnotation: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation - description: >- - Mask based segmentation annotation. Only one mask annotation can - exist for one image. - polylineAnnotation: - description: Polyline annotation. + selectTimeRangeAndFeature: + description: Response for request specifying time range and feature $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation - polygonAnnotation: - description: Polygon annotation. + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature + selectEntity: + description: Response for request specifying the entities to delete $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec: - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics: + description: Model evaluation metrics for text sentiment problems. + type: object properties: - trainTrialJobSpec: + meanAbsoluteError: + type: number + format: float description: >- - Required. The spec of a train trial job. The same spec applies to - all train trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - maxParallelTrialCount: - description: Required. The maximum number of trials to run in parallel. - format: int32 - type: integer - frequency: + Mean absolute error. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + quadraticKappa: + format: float description: >- - Required. Frequency of search trials to start train stage. Top N - [TrainTrialSpec.max_parallel_trial_count] search trials will be - trained for every M [TrainTrialSpec.frequency] trials searched. - format: int32 - type: integer - type: object - description: Represent spec for train trials. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics: - description: Model evaluation metrics for video action recognition. + Quadratic weighted kappa. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + type: number + linearKappa: + description: >- + Linear weighted kappa. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + type: number + format: float + recall: + type: number + format: float + description: Recall. + meanSquaredError: + format: float + type: number + description: >- + Mean squared error. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + precision: + format: float + description: Precision. + type: number + f1Score: + format: float + type: number + description: The harmonic mean of recall and precision. + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: >- + Confusion matrix of the evaluation. Only set for ModelEvaluations, + not for ModelEvaluationSlices. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult: + description: Spec for question answering correctness result. + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult type: object properties: - videoActionMetrics: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics - description: 'The metric entries for precision window lengths: 1s,2s,3s.' - evaluatedActionCount: - format: int32 - type: integer - description: The number of ground truth actions used to create this evaluation. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics - GoogleCloudAiplatformV1AnnotationSpec: - id: GoogleCloudAiplatformV1AnnotationSpec - description: Identifies a concept with which DataItems may be annotated with. + score: + description: Output only. Question Answering Correctness score. + readOnly: true + type: number + format: float + explanation: + description: Output only. Explanation for question answering correctness score. + readOnly: true + type: string + confidence: + format: float + description: Output only. Confidence for question answering correctness score. + readOnly: true + type: number + GoogleCloudAiplatformV1Trial: + description: >- + A message representing a Trial. A Trial contains a unique set of + Parameters that has been or will be evaluated, along with the objective + metrics got by running the Trial. + type: object + id: GoogleCloudAiplatformV1Trial properties: - etag: + id: + type: string + readOnly: true + description: Output only. The identifier of the Trial assigned by the service. + clientId: + type: string description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. + Output only. The identifier of the client that originally requested + this Trial. Each client is identified by a unique client_id. When a + client asks for a suggestion, Vertex AI Vizier will assign it a + Trial. The client should evaluate the Trial, complete it, and report + back to Vertex AI Vizier. If suggestion is asked again by same + client_id before the Trial is completed, the same Trial will be + returned. Multiple clients with different client_ids can ask for + suggestions simultaneously, each of them will get their own Trial. + readOnly: true + name: type: string - createTime: - description: Output only. Timestamp when this AnnotationSpec was created. - format: google-datetime + readOnly: true + description: Output only. Resource name of the Trial assigned by the service. + customJob: type: string + description: >- + Output only. The CustomJob name linked to the Trial. It's set for a + HyperparameterTuningJob's Trial. readOnly: true - updateTime: + finalMeasurement: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + readOnly: true + description: Output only. The final measurement containing the objective value. + startTime: + type: string + description: Output only. Time when the Trial was started. format: google-datetime + readOnly: true + measurements: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + description: >- + Output only. A list of measurements that are strictly + lexicographically ordered by their induced tuples (steps, + elapsed_duration). These are used for early stopping computations. + state: + enum: + - STATE_UNSPECIFIED + - REQUESTED + - ACTIVE + - STOPPING + - SUCCEEDED + - INFEASIBLE + description: Output only. The detailed state of the Trial. type: string - description: Output only. Timestamp when AnnotationSpec was last updated. readOnly: true - displayName: + enumDescriptions: + - The Trial state is unspecified. + - >- + Indicates that a specific Trial has been requested, but it has not + yet been suggested by the service. + - Indicates that the Trial has been suggested. + - Indicates that the Trial should stop according to the service. + - Indicates that the Trial is completed successfully. + - >- + Indicates that the Trial should not be attempted again. The + service will set a Trial to INFEASIBLE when it's done but missing + the final_measurement. + endTime: + description: >- + Output only. Time when the Trial's status changed to `SUCCEEDED` or + `INFEASIBLE`. type: string + readOnly: true + format: google-datetime + webAccessUris: + additionalProperties: + type: string + type: object + readOnly: true description: >- - Required. The user-defined name of the AnnotationSpec. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. - name: - description: Output only. Resource name of the AnnotationSpec. + Output only. URIs for accessing [interactive + shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + (one URI for each training node). Only available if this trial is + part of a HyperparameterTuningJob and the job's + trial_job_spec.enable_web_access field is `true`. The keys are names + of each node used for the trial; for example, `workerpool0-0` for + the primary node, `workerpool1-0` for the first node in the second + worker pool, and `workerpool1-1` for the second node in the second + worker pool. The values are the URIs for each node's interactive + shell. + parameters: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + description: Output only. The parameters of the Trial. readOnly: true + type: array + infeasibleReason: + description: >- + Output only. A human readable string describing why the Trial is + infeasible. This is set only if Trial state is `INFEASIBLE`. type: string + readOnly: true + GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse: + id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse type: object - GoogleCloudAiplatformV1ImportDataOperationMetadata: - id: GoogleCloudAiplatformV1ImportDataOperationMetadata - description: Runtime operation information for DatasetService.ImportData. properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - type: object - GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest: + tensorboardRuns: + description: The created TensorboardRuns. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + description: Response message for TensorboardService.BatchCreateTensorboardRuns. + GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: + id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + description: Configuration for logging request-response to a BigQuery table. properties: - deploymentResourcePool: - description: Required. The DeploymentResourcePool to create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' - deploymentResourcePoolId: - type: string + samplingRate: description: >- - Required. The ID to use for the DeploymentResourcePool, which will - become the final component of the DeploymentResourcePool's resource - name. The maximum length is 63 characters, and valid characters are - `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. - description: Request message for CreateDeploymentResourcePool method. + Percentage of requests to be logged, expressed as a fraction in + range(0,1]. + type: number + format: double + enabled: + description: If logging is enabled or not. + type: boolean + bigqueryDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + description: >- + BigQuery table for logging. If only given a project, a new dataset + will be created with name `logging__` where will be made + BigQuery-dataset-name compatible (e.g. most special characters will + become underscores). If no table name is given, a new table will be + created with name `request_response_logging` type: object - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest - GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: + GoogleCloudAiplatformV1CoherenceResult: + description: Spec for coherence result. type: object - id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata + id: GoogleCloudAiplatformV1CoherenceResult properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - progressMessage: - description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. + confidence: + description: Output only. Confidence for coherence score. + readOnly: true + type: number + format: float + explanation: + description: Output only. Explanation for coherence score. type: string - description: Metadata information for NotebookService.StartNotebookRuntime. - GoogleCloudAiplatformV1ListDataLabelingJobsResponse: + readOnly: true + score: + readOnly: true + type: number + description: Output only. Coherence score. + format: float + GoogleCloudAiplatformV1ListSpecialistPoolsResponse: properties: nextPageToken: type: string description: The standard List next-page token. - dataLabelingJobs: - description: >- - A list of DataLabelingJobs that matches the specified filter in the - request. + specialistPools: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' type: array - description: Response message for JobService.ListDataLabelingJobs. + description: >- + A list of SpecialistPools that matches the specified filter in the + request. + description: Response message for SpecialistPoolService.ListSpecialistPools. + id: GoogleCloudAiplatformV1ListSpecialistPoolsResponse type: object - id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse - GoogleCloudAiplatformV1DoubleArray: - id: GoogleCloudAiplatformV1DoubleArray + GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField: + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField type: object properties: - values: - items: - type: number - format: double - description: A list of double values. - type: array - description: A list of double values. - GoogleCloudAiplatformV1ExportFeatureValuesRequest: + fieldName: + description: >- + Required. The name of the field in the CSV header or the name of the + column in BigQuery table. The naming restriction is the same as + Feature.name. + type: string + description: Describe pass-through fields in read_instance source. + GoogleCloudAiplatformV1ModelOriginalModelInfo: type: object - description: Request message for FeaturestoreService.ExportFeatureValues. + id: GoogleCloudAiplatformV1ModelOriginalModelInfo + description: Contains information about the original Model if this Model is a copy. properties: - settings: - description: Per-Feature export settings. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting - type: array - destination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' - description: Required. Specifies destination location and format. - featureSelector: - description: Required. Selects Features to export values of. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - snapshotExport: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport - description: >- - Exports the latest Feature values of all entities of the EntityType - within a time range. - fullExport: + model: + type: string description: >- - Exports all historical values of all entities of the EntityType - within a time range - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport - id: GoogleCloudAiplatformV1ExportFeatureValuesRequest - GoogleCloudAiplatformV1FetchFeatureValuesResponse: + Output only. The resource name of the Model this Model is a copy of, + including the revision. Format: + `projects/{project}/locations/{location}/models/{model_id}@{version_id}` + readOnly: true + GoogleCloudAiplatformV1Probe: + description: >- + Probe describes a health check to be performed against a container to + determine whether it is alive or ready to receive traffic. properties: - protoStruct: - additionalProperties: - type: any - description: Properties of the object. - type: object - description: Feature values in proto Struct format. - keyValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList - description: Feature values in KeyValue format. - dataKey: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' + exec: + description: ExecAction probes the health of a container by executing a command. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' + timeoutSeconds: + format: int32 description: >- - The data key associated with this response. Will only be populated - for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. + Number of seconds after which the probe times out. Defaults to 1 + second. Minimum value is 1. Must be greater or equal to + period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. + type: integer + periodSeconds: + description: >- + How often (in seconds) to perform the probe. Default to 10 seconds. + Minimum value is 1. Must be less than timeout_seconds. Maps to + Kubernetes probe argument 'periodSeconds'. + type: integer + format: int32 + id: GoogleCloudAiplatformV1Probe type: object - id: GoogleCloudAiplatformV1FetchFeatureValuesResponse - description: Response message for FeatureOnlineStoreService.FetchFeatureValues - GoogleCloudAiplatformV1ToolParameterKeyMatchInput: + GoogleCloudAiplatformV1FeatureViewSyncSyncSummary: + type: object + id: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary properties: - metricSpec: - description: Required. Spec for tool parameter key match metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchSpec - instances: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInstance - type: array - description: Required. Repeated tool parameter key match instances. - description: Input for tool parameter key match metric. - id: GoogleCloudAiplatformV1ToolParameterKeyMatchInput - type: object - GoogleCloudAiplatformV1IndexDatapointRestriction: - properties: - namespace: - description: 'The namespace of this restriction. e.g.: color.' + rowSynced: + description: Output only. Total number of rows synced. type: string - allowList: - items: - type: string - description: 'The attributes to allow in this namespace. e.g.: ''red''' - type: array - denyList: - items: - type: string - type: array - description: 'The attributes to deny in this namespace. e.g.: ''blue''' - type: object - id: GoogleCloudAiplatformV1IndexDatapointRestriction - description: >- - Restriction of a datapoint which describe its attributes(tokens) from - each of several attribute categories(namespaces). - GoogleCloudAiplatformV1NotebookEucConfig: - id: GoogleCloudAiplatformV1NotebookEucConfig - type: object - properties: - bypassActasCheck: + format: int64 readOnly: true - type: boolean - description: >- - Output only. Whether ActAs check is bypassed for service account - attached to the VM. If false, we need ActAs check for the default - Compute Engine Service account. When a Runtime is created, a VM is - allocated using Default Compute Engine Service Account. Any user - requesting to use this Runtime requires Service Account User (ActAs) - permission over this SA. If true, Runtime owner is using EUC and - does not require the above permission as VM no longer use default - Compute Engine SA, but a P4SA. - eucDisabled: - description: >- - Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. - In proto3, the default value of a boolean is false. In this way, by - default EUC will be enabled for NotebookRuntimeTemplate. - type: boolean - description: The euc configuration of NotebookRuntimeTemplate. - GoogleCloudAiplatformV1PrivateServiceConnectConfig: - type: object - id: GoogleCloudAiplatformV1PrivateServiceConnectConfig - properties: - enablePrivateServiceConnect: - description: >- - Required. If true, expose the IndexEndpoint via private service - connect. - type: boolean - serviceAttachment: + systemWatermarkTime: description: >- - Output only. The name of the generated service attachment resource. - This is only populated if the endpoint is deployed with - PrivateServiceConnect. + Lower bound of the system time watermark for the sync job. This is + only set for continuously syncing feature views. + type: string + format: google-datetime + totalSlot: type: string readOnly: true - projectAllowlist: - description: >- - A list of Projects from which the forwarding rule will target the - service attachment. - type: array - items: - type: string - description: Represents configuration for private service connect. - GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata: - id: GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata + format: int64 + description: Output only. BigQuery slot milliseconds consumed for the sync job. description: >- - Runtime operation information for - IndexEndpointService.CreateIndexEndpoint. - type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec: - description: Value specification for a parameter in `DOUBLE` type. + Summary from the Sync job. For continuous syncs, the summary is updated + periodically. For batch syncs, it gets updated on completion of the + sync. + GoogleCloudAiplatformV1FeatureViewBigQuerySource: + id: GoogleCloudAiplatformV1FeatureViewBigQuerySource properties: - maxValue: - format: double - description: Required. Inclusive maximum value of the parameter. - type: number - defaultValue: - format: double + entityIdColumns: + items: + type: string + type: array + description: Required. Columns to construct entity_id / row keys. + uri: description: >- - A default value for a `DOUBLE` parameter that is assumed to be a - relatively good starting point. Unset value signals that there is no - offered starting point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - type: number - minValue: - format: double - type: number - description: Required. Inclusive minimum value of the parameter. - id: GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + Required. The BigQuery view URI that will be materialized on each + sync trigger based on FeatureView.SyncConfig. + type: string type: object - GoogleCloudLocationListLocationsResponse: - id: GoogleCloudLocationListLocationsResponse + GoogleCloudAiplatformV1IndexDatapoint: type: object - description: The response message for Locations.ListLocations. + description: A datapoint of Index. + id: GoogleCloudAiplatformV1IndexDatapoint properties: - nextPageToken: - type: string - description: The standard List next-page token. - locations: + sparseEmbedding: + description: Optional. Feature embedding vector for sparse index. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + numericRestricts: description: >- - A list of locations that matches the specified filter in the - request. + Optional. List of Restrict of the datapoint, used to perform + "restricted searches" where boolean rule are used to filter the + subset of the database eligible for matching. This uses numeric + comparisons. + type: array items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction + featureVector: type: array - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation - type: object - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. - properties: - timeFormat: + items: + type: number + format: float description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) - type: string - columnName: + Required. Feature embedding vector for dense index. An array of + numbers with the length of [NearestNeighborSearchConfig.dimensions]. + crowdingTag: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag + description: >- + Optional. CrowdingTag of the datapoint, the number of neighbors to + return in each crowding can be configured during query. + restricts: + type: array + description: >- + Optional. List of Restrict of the datapoint, used to perform + "restricted searches" where boolean rule are used to filter the + subset of the database eligible for matching. This uses categorical + tokens. See: + https://cloud.google.com/vertex-ai/docs/matching-engine/filtering + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction + datapointId: + description: Required. Unique identifier of the datapoint. type: string - GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance: - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance - description: Prediction input format for Text Extraction. + GoogleCloudAiplatformV1RougeMetricValue: + description: Rouge metric value for an instance. + properties: + score: + format: float + type: number + description: Output only. Rouge score. + readOnly: true + id: GoogleCloudAiplatformV1RougeMetricValue type: object + GoogleCloudAiplatformV1CreatePipelineJobRequest: properties: - mimeType: + pipelineJobId: type: string description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain - content: - type: string - description: The text snippet to make the predictions on. - key: + 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-/`. + parent: type: string description: >- - This field is only used for batch prediction. If a key is provided, - the batch prediction result will by mapped to this key. If omitted, - then the batch prediction result will contain the entire input - instance. Vertex AI will not check if keys in the request are - duplicates, so it is up to the caller to ensure the keys are unique. - GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig: - type: object - properties: - scaling: - description: >- - Online serving scaling configuration. Only one of `fixed_node_count` - and `scaling` can be set. Setting one will reset the other. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling - fixedNodeCount: - format: int32 - type: integer - description: >- - The number of nodes for the online store. The number of nodes - doesn't scale automatically, but you can manually update the number - of nodes. If set to 0, the featurestore will not have an online - store and cannot be used for online serving. - id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig - description: >- - OnlineServingConfig specifies the details for provisioning online - serving resources. - GoogleCloudAiplatformV1ToolCallValidSpec: - id: GoogleCloudAiplatformV1ToolCallValidSpec - properties: {} - type: object - description: Spec for tool call valid metric. - GoogleCloudAiplatformV1Citation: + Required. The resource name of the Location to create the + PipelineJob in. Format: `projects/{project}/locations/{location}` + pipelineJob: + description: Required. The PipelineJob to create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + description: Request message for PipelineService.CreatePipelineJob. + id: GoogleCloudAiplatformV1CreatePipelineJobRequest type: object - description: Source attributions for content. - id: GoogleCloudAiplatformV1Citation - properties: - uri: - type: string - readOnly: true - description: Output only. Url reference of the attribution. - publicationDate: - description: Output only. Publication date of the attribution. - $ref: '#/components/schemas/GoogleTypeDate' - readOnly: true - endIndex: - type: integer - format: int32 - readOnly: true - description: Output only. End index into the content. - startIndex: - format: int32 - readOnly: true - type: integer - description: Output only. Start index into the content. - license: - description: Output only. License of the attribution. - readOnly: true - type: string - title: - readOnly: true - type: string - description: Output only. Title of the attribution. - GoogleCloudAiplatformV1GcsDestination: - id: GoogleCloudAiplatformV1GcsDestination - description: The Google Cloud Storage location where the output is to be written to. + GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView: + description: Entity view with Feature values. type: object properties: - outputUriPrefix: + data: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData + type: array description: >- - Required. Google Cloud Storage URI to output directory. If the uri - doesn't end with '/', a '/' will be automatically appended. The - directory is created if it doesn't exist. + Each piece of data holds the k requested values for one requested + Feature. If no values for the requested Feature exist, the + corresponding cell will be empty. This has the same size and is in + the same order as the features from the header + ReadFeatureValuesResponse.header. + entityId: type: string - GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData: - type: object - description: Per month usage data - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData + description: ID of the requested entity. + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView + GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput: + id: GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + description: The output of a multi-trial Neural Architecture Search (NAS) jobs. properties: - userUsageData: + trainTrials: + description: >- + Output only. List of NasTrials that were started as part of train + stage. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData - description: Usage data for each user in the given month. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + readOnly: true type: array - GoogleCloudAiplatformV1ListOptimalTrialsRequest: - id: GoogleCloudAiplatformV1ListOptimalTrialsRequest - properties: {} - type: object - description: Request message for VizierService.ListOptimalTrials. - GoogleCloudAiplatformV1ExamplesOverride: - description: Overrides for example-based explanations. - properties: - returnEmbeddings: - type: boolean - description: If true, return the embeddings instead of neighbors. - neighborCount: - type: integer - format: int32 - description: The number of neighbors to return. - crowdingCount: - format: int32 - type: integer - description: The number of neighbors to return that have the same crowding tag. - restrictions: + searchTrials: + readOnly: true + description: >- + Output only. List of NasTrials that were started as part of search + stage. type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExamplesRestrictionsNamespace - description: >- - Restrict the resulting nearest neighbors to respect these - constraints. - dataFormat: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + type: object + GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode: + properties: + modelRoutingPreference: enum: - - DATA_FORMAT_UNSPECIFIED - - INSTANCES - - EMBEDDINGS - enumDescriptions: - - Unspecified format. Must not be used. - - Provided data is a set of model inputs. - - Provided data is a set of embeddings. - description: The format of the data being provided with each call. + - UNKNOWN + - PRIORITIZE_QUALITY + - BALANCED + - PRIORITIZE_COST type: string + enumDescriptions: + - Unspecified model routing preference. + - Prefer higher quality over low cost. + - Balanced model routing preference. + - Prefer lower cost over higher quality. + description: The model routing preference. + description: >- + When automated routing is specified, the routing will be determined by + the pretrained routing model and customer provided model routing + preference. type: object - id: GoogleCloudAiplatformV1ExamplesOverride - GoogleCloudAiplatformV1CancelCustomJobRequest: - type: object - properties: {} - description: Request message for JobService.CancelCustomJob. - id: GoogleCloudAiplatformV1CancelCustomJobRequest - GoogleCloudAiplatformV1DirectRawPredictResponse: - type: object + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode + GoogleCloudAiplatformV1IndexDatapointRestriction: + description: >- + Restriction of a datapoint which describe its attributes(tokens) from + each of several attribute categories(namespaces). properties: - output: - description: The prediction output. - format: byte + denyList: + type: array + description: 'The attributes to deny in this namespace. e.g.: ''blue''' + items: + type: string + namespace: + description: 'The namespace of this restriction. e.g.: color.' type: string - description: Response message for PredictionService.DirectRawPredict. - id: GoogleCloudAiplatformV1DirectRawPredictResponse - GoogleCloudAiplatformV1SchemaTextSegment: + allowList: + description: 'The attributes to allow in this namespace. e.g.: ''red''' + items: + type: string + type: array + id: GoogleCloudAiplatformV1IndexDatapointRestriction type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs: properties: - startOffset: + contextWindow: + description: >- + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. + format: int64 type: string - format: uint64 + optimizationObjective: description: >- - Zero-based character index of the first character of the text - segment (counting characters from the beginning of the text). - content: + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. type: string - description: The text content in the segment for output only. - endOffset: + timeSeriesAttributeColumns: + type: array + items: + type: string + description: >- + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. type: string + timeColumn: description: >- - Zero-based character index of the first character past the end of - the text segment (counting character from the beginning of the - text). The character at the end_offset is NOT included in the text - segment. - format: uint64 - id: GoogleCloudAiplatformV1SchemaTextSegment - description: The text segment inside of DataItem. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics: - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. - type: object - properties: - meanAveragePrecision: - format: float - type: number - description: The mean average precision, most often close to `auPrc`. - iouThreshold: - format: float + The name of the column that identifies time order in the time + series. This column must be available at forecast. + type: string + weightColumn: + type: string description: >- - The intersection-over-union threshold value used to compute this - metrics entry. - type: number - confidenceMetrics: + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. This column must be available at forecast. + forecastHorizon: description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. + format: int64 + type: string + transformations: type: array + description: >- + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics - GoogleCloudAiplatformV1ToolNameMatchMetricValue: - id: GoogleCloudAiplatformV1ToolNameMatchMetricValue - description: Tool name match metric value for an instance. - properties: - score: - type: number - format: float - readOnly: true - description: Output only. Tool name match score. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation - description: >- - Treats the column as text array and performs following transformation - functions. * Concatenate all text values in the array into a single text - value using a space (" ") as a delimiter, and then treat the result as a - single text value. Apply the transformations for Text columns. * Empty - arrays treated as an empty text. - properties: - columnName: - type: string - type: object - GoogleCloudAiplatformV1ListTuningJobsResponse: - id: GoogleCloudAiplatformV1ListTuningJobsResponse - type: object - properties: - nextPageToken: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + hierarchyConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig description: >- - A token to retrieve the next page of results. Pass to - ListTuningJobsRequest.page_token to obtain that page. + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + targetColumn: + description: >- + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. type: string - tuningJobs: + unavailableAtForecastColumns: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + type: string + description: >- + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. type: array - description: List of TuningJobs in the requested page. - description: Response message for GenAiTuningService.ListTuningJobs - GoogleCloudAiplatformV1TensorboardTensor: - description: One point viewable on a tensor metric plot. - id: GoogleCloudAiplatformV1TensorboardTensor - type: object - properties: - value: + additionalExperiments: + items: + type: string + description: Additional experiment flags for the time series forcasting training. + type: array + validationOptions: type: string description: >- - Required. Serialized form of - https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto - format: byte - versionNumber: - type: integer - format: int32 - description: Optional. Version number of TensorProto used to serialize value. - GoogleCloudAiplatformV1FeatureViewDataKey: - type: object - id: GoogleCloudAiplatformV1FeatureViewDataKey - description: Lookup key for a feature view. - properties: - key: - type: string - description: String key to use for lookup. - compositeKey: + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + holidayRegions: description: >- - The actual Entity ID will be composed from this struct. This should - match with the way ID is defined in the FeatureView spec. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey - GoogleCloudAiplatformV1PurgeExecutionsResponse: - description: Response message for MetadataService.PurgeExecutions. - type: object - properties: - purgeSample: + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. items: type: string - description: >- - A sample of the Execution names that will be deleted. Only populated - if `force` is set to false. The maximum number of samples is 100 (it - is possible to return fewer). type: array - purgeCount: - type: string - format: int64 + exportEvaluatedDataItemsConfig: description: >- - The number of Executions that this request deleted (or, if `force` - is false, the number of Executions that will be deleted). This can - be an estimate. - id: GoogleCloudAiplatformV1PurgeExecutionsResponse - GoogleCloudAiplatformV1RougeResults: - description: Results for rouge metric. - id: GoogleCloudAiplatformV1RougeResults - properties: - rougeMetricValues: + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + availableAtForecastColumns: + description: >- + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeMetricValue' - readOnly: true + type: string type: array - description: Output only. Rouge metric values. - type: object - GoogleCloudAiplatformV1SummarizationVerbosityInput: - id: GoogleCloudAiplatformV1SummarizationVerbosityInput - properties: - instance: + windowConfig: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInstance - description: Required. Summarization verbosity instance. - metricSpec: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + description: Config containing strategy for generating sliding windows. + dataGranularity: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbositySpec - description: Required. Spec for summarization verbosity score metric. - type: object - description: Input for summarization verbosity metric. - GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata: - properties: - progressMessage: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity + description: Expected difference in time granularity between rows in the data. + quantiles: + type: array description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. + Quantiles to use for minimize-quantile-loss + `optimization_objective`. Up to 5 quantiles are allowed of values + between 0 and 1, exclusive. Required if the value of + optimization_objective is minimize-quantile-loss. Represents the + percent quantiles to use for that objective. Quantiles must be + unique. + items: + format: double + type: number + trainBudgetMilliNodeHours: type: string - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata - description: Metadata information for NotebookService.UpgradeNotebookRuntime. + format: int64 + description: >- + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. type: object - GoogleCloudAiplatformV1Candidate: - description: A response candidate generated from the model. - id: GoogleCloudAiplatformV1Candidate + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec: type: object properties: - safetyRatings: - type: array + trainTrialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' description: >- - Output only. List of ratings for the safety of a response candidate. - There is at most one rating per category. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' - readOnly: true - citationMetadata: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1CitationMetadata' - description: Output only. Source attribution of the generated content. - avgLogprobs: - type: number - readOnly: true - format: double - description: Output only. Average log probability score of the candidate. - index: - readOnly: true - description: Output only. Index of the candidate. + Required. The spec of a train trial job. The same spec applies to + all train trials. + maxParallelTrialCount: + description: Required. The maximum number of trials to run in parallel. format: int32 type: integer - finishMessage: - description: >- - Output only. Describes the reason the mode stopped generating tokens - in more detail. This is only filled when `finish_reason` is set. - readOnly: true - type: string - groundingMetadata: - description: >- - Output only. Metadata specifies sources used to ground generated - content. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' - content: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - readOnly: true - description: Output only. Content parts of the candidate. - finishReason: + frequency: + type: integer + format: int32 description: >- - Output only. The reason why the model stopped generating tokens. If - empty, the model has not stopped generating the tokens. - enumDescriptions: - - The finish reason is unspecified. - - >- - Token generation reached a natural stopping point or a configured - stop sequence. - - Token generation reached the configured maximum output tokens. - - >- - Token generation stopped because the content potentially contains - safety violations. NOTE: When streaming, content is empty if - content filters blocks the output. - - >- - Token generation stopped because the content potentially contains - copyright violations. - - All other reasons that stopped the token generation. - - >- - Token generation stopped because the content contains forbidden - terms. - - >- - Token generation stopped for potentially containing prohibited - content. - - >- - Token generation stopped because the content potentially contains - Sensitive Personally Identifiable Information (SPII). - - The function call generated by the model is invalid. - enum: - - FINISH_REASON_UNSPECIFIED - - STOP - - MAX_TOKENS - - SAFETY - - RECITATION - - OTHER - - BLOCKLIST - - PROHIBITED_CONTENT - - SPII - - MALFORMED_FUNCTION_CALL - type: string - readOnly: true - GoogleCloudAiplatformV1PersistentResource: - description: >- - Represents long-lasting resources that are dedicated to users to runs - custom workloads. A PersistentResource can have multiple node pools and - each node pool can have its own machine spec. + Required. Frequency of search trials to start train stage. Top N + [TrainTrialSpec.max_parallel_trial_count] search trials will be + trained for every M [TrainTrialSpec.frequency] trials searched. + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec + description: Represent spec for train trials. + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange: + properties: + low: + description: Inclusive low value for the range. + format: float + type: number + high: + format: float + type: number + description: Exclusive high value for the range. type: object - id: GoogleCloudAiplatformV1PersistentResource + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + description: A range of values for slice(s). `low` is inclusive, `high` is exclusive. + GoogleCloudAiplatformV1MetadataStoreDataplexConfig: + type: object + id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig properties: - displayName: - type: string - description: >- - Optional. The display name of the PersistentResource. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. - labels: - type: object + enabledPipelinesLineage: + type: boolean description: >- - Optional. The labels with user-defined metadata to organize - PersistentResource. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. - additionalProperties: - type: string - reservedIpRanges: + Optional. Whether or not Data Lineage synchronization is enabled for + Vertex Pipelines. + description: Represents Dataplex integration settings. + GoogleCloudAiplatformV1MergeVersionAliasesRequest: + description: Request message for ModelService.MergeVersionAliases. + properties: + versionAliases: items: type: string type: array description: >- - Optional. A list of names for the reserved IP ranges under the VPC - network that can be used for this persistent resource. If set, we - will deploy the persistent resource within the provided IP ranges. - Otherwise, the persistent resource is deployed to any IP ranges - under the provided VPC network. Example: ['vertex-ai-ip-range']. - satisfiesPzs: - description: Output only. Reserved for future use. - type: boolean - readOnly: true - resourceRuntimeSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntimeSpec' + Required. The set of version aliases to merge. The alias should be + at most 128 characters, and match `a-z{0,126}[a-z-0-9]`. Add the `-` + prefix to an alias means removing that alias from the version. `-` + is NOT counted in the 128 characters. Example: `-golden` means + removing the `golden` alias from the version. There is NO ordering + in aliases, which means 1) The aliases returned from GetModel API + might not have the exactly same order from this MergeVersionAliases + API. 2) Adding and deleting the same alias in the request is not + recommended, and the 2 operations will be cancelled out. + type: object + id: GoogleCloudAiplatformV1MergeVersionAliasesRequest + GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse: + type: object + description: Response message for TensorboardService.ExportTensorboardTimeSeriesData. + properties: + timeSeriesDataPoints: + description: The returned time series data points. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + type: array + nextPageToken: description: >- - Optional. Persistent Resource runtime spec. For example, used for - Ray cluster configuration. - createTime: + 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 - readOnly: true - description: Output only. Time when the PersistentResource was created. - format: google-datetime - error: - readOnly: true - description: >- - Output only. Only populated when persistent resource's state is - `STOPPING` or `ERROR`. - $ref: '#/components/schemas/GoogleRpcStatus' - resourceRuntime: - description: Output only. Runtime information of the Persistent Resource. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntime' - name: - description: Immutable. Resource name of a PersistentResource. + id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + GoogleTypeExpr: + type: object + properties: + title: type: string - encryptionSpec: description: >- - Optional. Customer-managed encryption key spec for a - PersistentResource. If set, this PersistentResource and all - sub-resources of this PersistentResource will be secured by this - key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - updateTime: - format: google-datetime + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + expression: type: string - readOnly: true - description: >- - Output only. Time when the PersistentResource was most recently - updated. - startTime: description: >- - Output only. Time when the PersistentResource for the first time - entered the `RUNNING` state. + Textual representation of an expression in Common Expression + Language syntax. + description: type: string - readOnly: true - format: google-datetime - network: description: >- - Optional. The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to peered - with Vertex AI to host the persistent resources. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - To specify this field, you must have already [configured VPC Network - Peering for Vertex - AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If - this field is left unspecified, the resources aren't peered with any - network. + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + location: type: string - resourcePools: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcePool' - description: Required. The spec of the pools of different resources. + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + id: GoogleTypeExpr + GoogleCloudAiplatformV1SyncFeatureViewRequest: + type: object + description: Request message for FeatureOnlineStoreAdminService.SyncFeatureView. + id: GoogleCloudAiplatformV1SyncFeatureViewRequest + properties: {} + GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig: + description: The configuration for grounding checking. + properties: + sources: type: array - satisfiesPzi: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry + description: The sources for the grounding checking. + disableAttribution: + description: >- + If set, skip finding claim attributions (i.e not generate grounding + citation). type: boolean - readOnly: true - description: Output only. Reserved for future use. - state: + deprecated: true + id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + type: object + GoogleCloudAiplatformV1Presets: + id: GoogleCloudAiplatformV1Presets + type: object + description: Preset configuration for example-based explanations + properties: + modality: + enum: + - MODALITY_UNSPECIFIED + - IMAGE + - TEXT + - TABULAR type: string - description: Output only. The detailed state of a Study. - readOnly: true + enumDescriptions: + - Should not be set. Added as a recommended best practice for enums + - IMAGE modality + - TEXT modality + - TABULAR modality + description: >- + The modality of the uploaded model, which automatically configures + the distance measurement and feature normalization for the + underlying example index and queries. If your model does not + precisely fit one of these types, it is okay to choose the closest + type. + query: enum: - - STATE_UNSPECIFIED - - PROVISIONING - - RUNNING - - STOPPING - - ERROR - - REBOOTING - - UPDATING + - PRECISE + - FAST + description: >- + Preset option controlling parameters for speed-precision trade-off + when querying for examples. If omitted, defaults to `PRECISE`. + type: string enumDescriptions: - - Not set. - - >- - The PROVISIONING state indicates the persistent resources is being - created. - - >- - The RUNNING state indicates the persistent resource is healthy and - fully usable. - - >- - The STOPPING state indicates the persistent resource is being - deleted. - - >- - The ERROR state indicates the persistent resource may be unusable. - Details can be found in the `error` field. - - >- - The REBOOTING state indicates the persistent resource is being - rebooted (PR is not available right now but is expected to be - ready again later). - - >- - The UPDATING state indicates the persistent resource is being - updated. - GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: - id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata + - More precise neighbors as a trade-off against slower response. + - Faster response as a trade-off against less precise neighbors. + GoogleCloudAiplatformV1ToolParameterKeyMatchSpec: + type: object + description: Spec for tool parameter key match metric. + id: GoogleCloudAiplatformV1ToolParameterKeyMatchSpec + properties: {} + CloudAiLargeModelsVisionRaiInfoDetectedLabels: + type: object + description: Filters returning list of deteceted labels, scores, and bounding boxes. + properties: + raiCategory: + description: The RAI category for the deteceted labels. + type: string + entities: + items: + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + description: The list of detected entities for the rai signal. + type: array + id: CloudAiLargeModelsVisionRaiInfoDetectedLabels + GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for creating a MetadataStore. + description: Operation metadata for Featurestore. + description: Details of operations that perform create Featurestore. + id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata type: object - description: Details of operations that perform MetadataService.CreateMetadataStore. - GoogleCloudAiplatformV1ModelEvaluationSlice: + GoogleCloudAiplatformV1MigratableResourceAutomlDataset: + properties: + datasetDisplayName: + type: string + description: The Dataset's display name in automl.googleapis.com. + dataset: + description: >- + Full resource name of automl Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}`. + type: string + id: GoogleCloudAiplatformV1MigratableResourceAutomlDataset + type: object + description: Represents one Dataset in automl.googleapis.com. + GoogleCloudAiplatformV1ExamplesExampleGcsSource: + properties: + gcsSource: + description: The Cloud Storage location for the input instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + dataFormat: + enumDescriptions: + - Format unspecified, used when unset. + - Examples are stored in JSONL files. + enum: + - DATA_FORMAT_UNSPECIFIED + - JSONL + type: string + description: >- + The format in which instances are given, if not specified, assume + it's JSONL format. Currently only JSONL format is supported. + description: The Cloud Storage input instances. + id: GoogleCloudAiplatformV1ExamplesExampleGcsSource + type: object + GoogleCloudAiplatformV1SafetySpec: + properties: + version: + type: integer + format: int32 + description: Optional. Which version to use for evaluation. + type: object + id: GoogleCloudAiplatformV1SafetySpec + description: Spec for safety metric. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics: + type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics + description: Metrics for a single confidence threshold. + properties: + boundingBoxIou: + type: number + description: >- + Bounding box intersection-over-union precision. Measures how well + the bounding boxes overlap between each other (e.g. complete overlap + or just barely above iou_threshold). + format: float + trackingRecall: + type: number + format: float + description: Tracking recall. + mismatchRate: + type: number + description: >- + Mismatch rate, which measures the tracking consistency, i.e. + correctness of instance ID continuity. + format: float + trackingPrecision: + type: number + format: float + description: Tracking precision. + confidenceThreshold: + type: number + description: The confidence threshold value used to compute the metrics. + format: float + GoogleCloudAiplatformV1ResourcePool: type: object + id: GoogleCloudAiplatformV1ResourcePool description: >- - A collection of metrics calculated by comparing Model's predictions on a - slice of the test data against ground truth annotations. + Represents the spec of a group of resources of the same type, for + example machine type, disk, and accelerators, in a PersistentResource. properties: - createTime: - format: google-datetime + replicaCount: type: string + description: >- + Optional. The total number of machines to use for this resource + pool. + format: int64 + diskSpec: + description: Optional. Disk spec for the machine in this node pool. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + usedReplicaCount: + type: string + format: int64 readOnly: true - description: Output only. Timestamp when this ModelEvaluationSlice was created. - modelExplanation: description: >- - Output only. Aggregated explanation metrics for the Model's - prediction output over the data this ModelEvaluation uses. This - field is populated only if the Model is evaluated with explanations, - and only for tabular Models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' + Output only. The number of machines currently in use by training + jobs for this resource pool. Will replace idle_replica_count. + machineSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + description: Required. Immutable. The specification of a single machine. + id: + type: string + description: >- + Immutable. The unique ID in a PersistentResource for referring to + this resource pool. User can specify it if necessary. Otherwise, + it's generated automatically. + autoscalingSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec + description: >- + Optional. Optional spec to configure GKE or Ray-on-Vertex + autoscaling + GoogleCloudAiplatformV1TuningJob: + properties: + state: readOnly: true - metricsSchemaUri: + description: Output only. The detailed state of the job. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + type: string + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + tunedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' + description: >- + Output only. The tuned model resources assiociated with this + TuningJob. readOnly: true + endTime: + readOnly: true + type: string + format: google-datetime description: >- - Output only. Points to a YAML file stored on Google Cloud Storage - describing the metrics of this ModelEvaluationSlice. The schema is - defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + Output only. Time when the TuningJob entered any of the following + JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. + baseModel: + description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". type: string - name: + tuningDataStats: + description: >- + Output only. The tuning data statistics associated with this + TuningJob. readOnly: true - description: Output only. The resource name of the ModelEvaluationSlice. - type: string - slice: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' + createTime: + description: Output only. Time when the TuningJob was created. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSlice + type: string + format: google-datetime + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. The slice of the test data that is used to evaluate the - Model. - metrics: - type: any + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. readOnly: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Output only. Sliced evaluation metrics of the Model. The schema of - the metrics is stored in metrics_schema_uri - id: GoogleCloudAiplatformV1ModelEvaluationSlice - GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec: - description: >- - Configuration for ConvexAutomatedStoppingSpec. When there are enough - completed trials (configured by min_measurement_count), for pending - trials with enough measurements and steps, the policy first computes an - overestimate of the objective value at max_num_steps according to the - slope of the incomplete objective value curve. No prediction can be made - if the curve is completely flat. If the overestimation is worse than the - best objective value of the completed trials, this pending trial will be - early-stopped, but a last measurement will be added to the pending trial - with max_num_steps and predicted objective value from the autoregression - model. - properties: - updateAllStoppedTrials: - type: boolean + Customer-managed encryption key options for a TuningJob. If this is + set, then all resources created by the TuningJob will be encrypted + with the provided encryption key. + startTime: description: >- - ConvexAutomatedStoppingSpec by default only updates the trials that - needs to be early stopped using a newly trained auto-regressive - model. When this flag is set to True, all stopped trials from the - beginning are potentially updated in terms of their - `final_measurement`. Also, note that the training logic of - autoregressive models is different in this case. Enabling this - option has shown better results and this may be the default option - in the future. - minStepCount: + Output only. Time when the TuningJob for the first time entered the + `JOB_STATE_RUNNING` state. + format: google-datetime type: string - format: int64 + readOnly: true + supervisedTuningSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' + description: Tuning Spec for Supervised Fine Tuning. + name: description: >- - Minimum number of steps for a trial to complete. Trials which do not - have a measurement with step_count > min_step_count won't be - considered for early stopping. It's ok to set it to 0, and a trial - can be early stopped at any stage. By default, min_step_count is set - to be one-tenth of the max_step_count. When use_elapsed_duration is - true, this field is set to the minimum elapsed seconds. - learningRateParameterName: + Output only. Identifier. Resource name of a TuningJob. Format: + `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + readOnly: true type: string - description: >- - The hyper-parameter name used in the tuning job that stands for - learning rate. Leave it blank if learning rate is not in a parameter - in tuning. The learning_rate is used to estimate the objective value - of the ongoing trial. - maxStepCount: + description: + description: Optional. The description of the TuningJob. type: string + labels: description: >- - Steps used in predicting the final objective for early stopped - trials. In general, it's set to be the same as the defined steps in - training / tuning. If not defined, it will learn it from the - completed trials. When use_steps is false, this field is set to the - maximum elapsed seconds. - format: int64 - minMeasurementCount: + Optional. The labels with user-defined metadata to organize + TuningJob and generated resources such as Model and Endpoint. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + additionalProperties: + type: string + type: object + updateTime: + description: Output only. Time when the TuningJob was most recently updated. + readOnly: true + format: google-datetime + type: string + experiment: + type: string + description: Output only. The Experiment associated with this TuningJob. + readOnly: true + tunedModelDisplayName: type: string - format: int64 - description: >- - The minimal number of measurements in a Trial. Early-stopping checks - will not trigger if less than min_measurement_count+1 completed - trials or pending trials with less than min_measurement_count - measurements. If not defined, the default value is 5. - useElapsedDuration: description: >- - This bool determines whether or not the rule is applied based on - elapsed_secs or steps. If use_elapsed_duration==false, the early - stopping decision is made according to the predicted objective - values according to the target steps. If use_elapsed_duration==true, - elapsed_secs is used instead of steps. Also, in this case, the - parameters max_num_steps and min_num_steps are overloaded to contain - max_elapsed_seconds and min_elapsed_seconds. - type: boolean - type: object - id: GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec - GoogleCloudAiplatformV1AssignNotebookRuntimeRequest: + Optional. The display name of the TunedModel. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + id: GoogleCloudAiplatformV1TuningJob + description: Represents a TuningJob that runs with Google owned models. type: object - id: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest + CloudAiLargeModelsVisionVideo: properties: - notebookRuntimeTemplate: + uri: type: string - description: >- - Required. The resource name of the NotebookRuntimeTemplate based on - which a NotebookRuntime will be assigned (reuse or create a new - one). - notebookRuntimeId: - description: Optional. User specified ID for the notebook runtime. + description: Path to another storage (typically Google Cloud Storage). + video: + format: byte type: string - notebookRuntime: - description: >- - Required. Provide runtime specific information (e.g. runtime owner, - notebook id) used for NotebookRuntime assignment. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' - description: Request message for NotebookService.AssignNotebookRuntime. - GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata: + description: Raw bytes. + description: Video type: object - id: GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata + id: CloudAiLargeModelsVisionVideo + GoogleCloudAiplatformV1UploadModelOperationMetadata: + type: object + id: GoogleCloudAiplatformV1UploadModelOperationMetadata properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore export Feature values. - description: Details of operations that exports Features values. - GoogleCloudAiplatformV1ListTensorboardExperimentsResponse: - id: GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + description: The common part of the operation metadata. + description: Details of ModelService.UploadModel operation. + GoogleCloudAiplatformV1EncryptionSpec: + description: >- + Represents a customer-managed encryption key spec that can be applied to + a top-level resource. + type: object + id: GoogleCloudAiplatformV1EncryptionSpec properties: - nextPageToken: + kmsKeyName: type: string description: >- - A token, which can be sent as - ListTensorboardExperimentsRequest.page_token to retrieve the next - page. If this field is omitted, there are no subsequent pages. - tensorboardExperiments: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment' - type: array - description: The TensorboardExperiments mathching the request. - type: object - description: Response message for TensorboardService.ListTensorboardExperiments. - GoogleCloudAiplatformV1UndeployModelRequest: - type: object - id: GoogleCloudAiplatformV1UndeployModelRequest - description: Request message for EndpointService.UndeployModel. + Required. The Cloud KMS resource identifier of the customer managed + encryption key used to protect a resource. Has the form: + `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. + The key needs to be in the same region as where the compute resource + is created. + GoogleCloudAiplatformV1PurgeExecutionsRequest: properties: - trafficSplit: - type: object - additionalProperties: - format: int32 - type: integer - description: >- - If this field is provided, then the Endpoint's traffic_split will be - overwritten with it. If last DeployedModel is being undeployed from - the Endpoint, the [Endpoint.traffic_split] will always end up empty - when this call returns. A DeployedModel will be successfully - undeployed only if it doesn't have any traffic assigned to it when - this method executes, or if this field unassigns any traffic to it. - deployedModelId: + filter: description: >- - Required. The ID of the DeployedModel to be undeployed from the - Endpoint. + Required. A required filter matching the Executions to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. type: string - GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult: + force: + type: boolean + description: >- + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Execution names + that would be deleted. type: object + description: Request message for MetadataService.PurgeExecutions. + id: GoogleCloudAiplatformV1PurgeExecutionsRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation: + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. * A boolean value that indicates whether the + value is valid. + properties: + columnName: + type: string id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + type: object + GoogleRpcStatus: properties: - categoryMask: + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: type: string description: >- - A PNG image where each pixel in the mask represents the category in - which the pixel in the original image was predicted to belong to. - The size of this image will be the same as the original image. The - mapping between the AnntoationSpec and the color can be found in - model's metadata. The model will choose the most likely category and - if none of the categories reach the confidence threshold, the pixel - will be marked as background. - confidenceMask: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array description: >- - A one channel image which is encoded as an 8bit lossless PNG. The - size of the image will be the same as the original image. For a - specific pixel, darker color means less confidence in correctness of - the cateogry in the categoryMask for the corresponding pixel. Black - means no confidence and white means complete confidence. - type: string - description: Prediction output format for Image Segmentation. - GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + id: GoogleRpcStatus type: object description: >- - Configuration defining how to transform batch prediction input instances - to the instances that the Model accepts. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudAiplatformV1WriteFeatureValuesPayload: properties: - excludedFields: - items: - type: string - type: array - description: >- - Fields that will be excluded in the prediction instance that is sent - to the Model. Excluded will be attached to the batch prediction - output if key_field is not specified. When excluded_fields is - populated, included_fields must be empty. The input must be JSONL - with objects at each line, BigQuery or TfRecord. - includedFields: - type: array - items: - type: string - description: >- - Fields that will be included in the prediction instance that is sent - to the Model. If instance_type is `array`, the order of field names - in included_fields also determines the order of the values in the - array. When included_fields is populated, excluded_fields must be - empty. The input must be JSONL with objects at each line, BigQuery - or TfRecord. - keyField: + entityId: type: string + description: Required. The ID of the entity. + featureValues: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + type: object description: >- - The name of the field that is considered as a key. The values - identified by the key field is not included in the transformed - instances that is sent to the Model. This is similar to specifying - this name of the field in excluded_fields. In addition, the batch - prediction output will not include the instances. Instead the output - will only include the value of the key field, in a field named `key` - in the output: * For `jsonl` output format, the output will have a - `key` field instead of the `instance` field. * For `csv`/`bigquery` - output format, the output will have have a `key` column instead of - the instance feature columns. The input must be JSONL with objects - at each line, CSV, BigQuery or TfRecord. - instanceType: - description: >- - The format of the instance that the Model accepts. Vertex AI will - convert compatible batch prediction input instance formats to the - specified format. Supported values are: * `object`: Each input is - converted to JSON object format. * For `bigquery`, each row is - converted to an object. * For `jsonl`, each line of the JSONL input - must be an object. * Does not apply to `csv`, `file-list`, - `tf-record`, or `tf-record-gzip`. * `array`: Each input is converted - to JSON array format. * For `bigquery`, each row is converted to an - array. The order of columns is determined by the BigQuery column - order, unless included_fields is populated. included_fields must be - populated for specifying field orders. * For `jsonl`, if each line - of the JSONL input is an object, included_fields must be populated - for specifying field orders. * Does not apply to `csv`, `file-list`, - `tf-record`, or `tf-record-gzip`. If not specified, Vertex AI - converts the batch prediction input as follows: * For `bigquery` and - `csv`, the behavior is the same as `array`. The order of columns is - the same as defined in the file or table, unless included_fields is - populated. * For `jsonl`, the prediction instance format is - determined by each line of the input. * For - `tf-record`/`tf-record-gzip`, each record will be converted to an - object in the format of `{"b64": }`, where `` is the Base64-encoded - string of the content of the record. * For `file-list`, each file in - the list will be converted to an object in the format of `{"b64": - }`, where `` is the Base64-encoded string of the content of the - file. - type: string - id: GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig - GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore. + Required. Feature values to be written, mapping from Feature ID to + value. Up to 100,000 `feature_values` entries may be written across + all payloads. The feature generation time, aligned by days, must be + no older than five years (1825 days) and no later than one year (366 + days) in the future. type: object - id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata - description: Details of operations that perform create Featurestore. - GoogleCloudAiplatformV1NearestNeighborsNeighbor: + id: GoogleCloudAiplatformV1WriteFeatureValuesPayload + description: Contains Feature values to be written for a specific entity. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics: type: object + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics properties: - entityId: - type: string - description: The id of the similar entity. - entityKeyValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse + confidenceMetrics: + type: array description: >- - The attributes of the neighbor, e.g. filters, crowding and metadata - Note that full entities are returned only when "return_full_entity" - is set to true. Otherwise, only the "entity_id" and "distance" - fields are populated. - distance: - description: The distance between the neighbor and the query vector. + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + iouThreshold: type: number - format: double - id: GoogleCloudAiplatformV1NearestNeighborsNeighbor - description: A neighbor of the query vector. - GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput: + format: float + description: >- + The intersection-over-union threshold value used to compute this + metrics entry. + meanAveragePrecision: + type: number + description: The mean average precision, most often close to `auPrc`. + format: float + GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: type: object - description: The output of a multi-trial Neural Architecture Search (NAS) jobs. - id: GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket properties: - trainTrials: - description: >- - Output only. List of NasTrials that were started as part of train - stage. - type: array + left: + type: number + format: double + description: Output only. Left bound of the bucket. readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - searchTrials: - description: >- - Output only. List of NasTrials that were started as part of search - stage. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - type: array + count: + description: Output only. Number of values in the bucket. + type: number readOnly: true - GoogleCloudAiplatformV1ListEntityTypesResponse: - id: GoogleCloudAiplatformV1ListEntityTypesResponse - description: Response message for FeaturestoreService.ListEntityTypes. - properties: - nextPageToken: - type: string - description: >- - A token, which can be sent as ListEntityTypesRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - entityTypes: - type: array - description: The EntityTypes matching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' - type: object - GoogleCloudAiplatformV1ModelEvaluation: + format: double + right: + type: number + readOnly: true + description: Output only. Right bound of the bucket. + format: double description: >- - A collection of metrics calculated by comparing Model's predictions on - all of the test data against annotations from the test data. + Dataset bucket used to create a histogram for the distribution given a + population of values. + GoogleCloudAiplatformV1ExamplesRestrictionsNamespace: + description: Restrictions namespace for example-based explanations overrides. + id: GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + type: object properties: - dataItemSchemaUri: + deny: + items: + type: string + type: array + description: The list of deny tags. + namespaceName: + description: The namespace name. type: string - description: >- - Points to a YAML file stored on Google Cloud Storage describing - EvaluatedDataItemView.data_item_payload and - EvaluatedAnnotation.data_item_payload. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - This field is not populated if there are neither - EvaluatedDataItemViews nor EvaluatedAnnotations under this - ModelEvaluation. - explanationSpecs: + allow: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + type: string type: array - description: >- - Describes the values of ExplanationSpec that are used for explaining - the predicted values on the evaluated data. - metadata: - description: >- - The metadata of the ModelEvaluation. For the ModelEvaluation - uploaded from Managed Pipeline, metadata contains a structured value - with keys of "pipeline_job_id", "evaluation_dataset_type", - "evaluation_dataset_path", "row_based_metrics_path". - type: any - annotationSchemaUri: + description: The list of allowed tags. + GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig: + properties: + monitorInterval: type: string + format: google-duration description: >- - Points to a YAML file stored on Google Cloud Storage describing - EvaluatedDataItemView.predictions, - EvaluatedDataItemView.ground_truths, - EvaluatedAnnotation.predictions, and - EvaluatedAnnotation.ground_truths. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - This field is not populated if there are neither - EvaluatedDataItemViews nor EvaluatedAnnotations under this - ModelEvaluation. - createTime: - readOnly: true - description: Output only. Timestamp when this ModelEvaluation was created. - format: google-datetime - type: string - displayName: - description: The display name of the ModelEvaluation. + Required. The model monitoring job scheduling interval. It will be + rounded up to next full hour. This defines how often the monitoring + jobs are triggered. + monitorWindow: + description: >- + The time window of the prediction data being included in each + prediction dataset. This window specifies how long the data should + be collected from historical model results for each run. If not set, + ModelDeploymentMonitoringScheduleConfig.monitor_interval will be + used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and + the monitor_window is set to be 3600, then data from 2022-01-08 + 13:30:00 to 2022-01-08 14:30:00 will be retrieved and aggregated to + calculate the monitoring statistics. type: string - name: + format: google-duration + description: The config for scheduling monitoring job. + type: object + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + GoogleCloudAiplatformV1DeployIndexRequest: + properties: + deployedIndex: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: Required. The DeployedIndex to be created within the IndexEndpoint. + id: GoogleCloudAiplatformV1DeployIndexRequest + type: object + description: Request message for IndexEndpointService.DeployIndex. + GoogleCloudAiplatformV1ComputeTokensRequest: + type: object + description: Request message for ComputeTokens RPC call. + id: GoogleCloudAiplatformV1ComputeTokensRequest + properties: + model: type: string - readOnly: true - description: Output only. The resource name of the ModelEvaluation. - modelExplanation: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' description: >- - Aggregated explanation metrics for the Model's prediction output - over the data this ModelEvaluation uses. This field is populated - only if the Model is evaluated with explanations, and only for - AutoML tabular Models. - sliceDimensions: + Optional. The name of the publisher model requested to serve the + prediction. Format: + projects/{project}/locations/{location}/publishers/*/models/* + instances: description: >- - All possible dimensions of ModelEvaluationSlices. The dimensions can - be used as the filter of the ModelService.ListModelEvaluationSlices - request, in the form of `slice.dimension = `. + Optional. The instances that are the input to token computing API + call. Schema is identical to the prediction schema of the text + model, even for the non-text models, like chat models, or Codey + models. + type: array + items: + type: any + contents: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' type: array + description: Optional. Input content. + GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig: + id: GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig + type: object + properties: {} + description: Configuration options for using brute force search. + GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult + description: Prediction output format for Tabular Classification. + properties: + classes: items: type: string - metrics: - type: any description: >- - Evaluation metrics of the Model. The schema of the metrics is stored - in metrics_schema_uri - metricsSchemaUri: - type: string + The name of the classes being classified, contains all possible + values of the target column. + type: array + scores: description: >- - Points to a YAML file stored on Google Cloud Storage describing the - metrics of this ModelEvaluation. The schema is defined as an OpenAPI - 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The model's confidence in each class being correct, higher value + means higher confidence. The N-th score corresponds to the N-th + class in classes. + type: array + items: + format: float + type: number type: object - id: GoogleCloudAiplatformV1ModelEvaluation - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec: + GoogleCloudAiplatformV1ExportFeatureValuesRequest: + description: Request message for FeaturestoreService.ExportFeatureValues. + id: GoogleCloudAiplatformV1ExportFeatureValuesRequest type: object - id: GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec properties: - parameterSpec: - description: Required. The spec for a conditional parameter. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' - parentIntValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition + snapshotExport: description: >- - The spec for matching values from a parent parameter of `INTEGER` - type. - parentCategoricalValues: + Exports the latest Feature values of all entities of the EntityType + within a time range. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition - description: >- - The spec for matching values from a parent parameter of - `CATEGORICAL` type. - parentDiscreteValues: - description: >- - The spec for matching values from a parent parameter of `DISCRETE` - type. + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport + fullExport: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition - description: Represents a parameter spec with condition from its parent parameter. - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - partialResults: + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport description: >- - Partial results that reflect the latest migration operation - progress. + Exports all historical values of all entities of the EntityType + within a time range + featureSelector: + description: Required. Selects Features to export values of. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + destination: + description: Required. Specifies destination location and format. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' + settings: type: array + description: Per-Feature export settings. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult - type: object - id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata + #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting + GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: description: >- - Runtime operation information for - MigrationService.BatchMigrateResources. - GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata: - id: GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata - description: Details of operations that perform create PersistentResource. - type: object + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for PersistentResource. - progressMessage: - description: Progress Message for Create LRO - type: string - GoogleCloudAiplatformV1IndexDatapointCrowdingTag: - id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag + audiences: + description: >- + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. + items: + type: string + type: array + allowedIssuers: + type: array + description: >- + A list of allowed JWT issuers. Each entry must be a valid Google + service account, in the following format: + `service-account-name@project-id.iam.gserviceaccount.com` + items: + type: string + id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix: type: object properties: - crowdingAttribute: - type: string + annotationSpecs: description: >- - The attribute value used for crowding. The maximum number of - neighbors to return per crowding attribute value - (per_crowding_attribute_num_neighbors) is configured per-query. This - field is ignored if per_crowding_attribute_num_neighbors is larger - than the total number of neighbors to return for a given query. + AnnotationSpecs used in the confusion matrix. For AutoML Text + Extraction, a special negative AnnotationSpec with empty `id` and + `displayName` of "NULL" will be added as the last element. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + type: array + rows: + description: >- + Rows in the confusion matrix. The number of rows is equal to the + size of `annotationSpecs`. `rowsi` is the number of DataItems that + have ground truth of the `annotationSpecs[i]` and are predicted as + `annotationSpecs[j]` by the Model being evaluated. For Text + Extraction, when `annotationSpecs[i]` is the last element in + `annotationSpecs`, i.e. the special negative AnnotationSpec, `rowsi` + is the number of predicted entities of `annoatationSpec[j]` that are + not labeled as any of the ground truth AnnotationSpec. When + annotationSpecs[j] is the special negative AnnotationSpec, `rowsi` + is the number of entities have ground truth of `annotationSpec[i]` + that are not predicted as an entity by the Model. The value of the + last cell, i.e. `rowi` where i == j and `annotationSpec[i]` is the + special negative AnnotationSpec, is always 0. + items: + type: array + items: + type: any + type: array + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + GoogleCloudAiplatformV1XraiAttribution: description: >- - Crowding tag is a constraint on a neighbor list produced by nearest - neighbor search requiring that no more than some value k' of the k - neighbors returned have the same value of crowding_attribute. - GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest: - id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest - description: Request message for NotebookService.UpgradeNotebookRuntime. - properties: {} - type: object - GoogleCloudAiplatformV1ModelDeploymentMonitoringJob: + An explanation method that redistributes Integrated Gradients + attributions to segmented regions, taking advantage of the model's fully + differentiable structure. Refer to this paper for more details: + https://arxiv.org/abs/1906.02825 Supported only by image Models. + id: GoogleCloudAiplatformV1XraiAttribution + properties: + smoothGradConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' + description: >- + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy + samples in the vicinity of the inputs. Adding noise can help improve + the computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + blurBaselineConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' + description: >- + Config for XRAI with blur baseline. When enabled, a linear path from + the maximally blurred image to the input image is created. Using a + blurred baseline instead of zero (black image) is motivated by the + BlurIG approach explained here: https://arxiv.org/abs/2004.03383 + stepCount: + description: >- + Required. The number of steps for approximating the path integral. A + good value to start is 50 and gradually increase until the sum to + diff property is met within the desired error range. Valid range of + its value is [1, 100], inclusively. + format: int32 + type: integer type: object + GoogleCloudAiplatformV1TunedModel: + description: >- + The Model Registry Model and Online Prediction Endpoint assiociated with + this TuningJob. + id: GoogleCloudAiplatformV1TunedModel properties: - error: + model: description: >- - Output only. Only populated when the job's state is - `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - satisfiesPzi: - description: Output only. Reserved for future use. + Output only. The resource name of the TunedModel. Format: + `projects/{project}/locations/{location}/models/{model}`. readOnly: true - type: boolean - endpoint: type: string + endpoint: description: >- - Required. Endpoint resource name. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}` - enableMonitoringPipelineLogs: - type: boolean - description: >- - If true, the scheduled monitoring pipeline logs are sent to Google - Cloud Logging, including pipeline status and anomalies detected. - Please note the logs incur cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging#pricing). - createTime: - format: google-datetime + Output only. A resource name of an Endpoint. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}`. type: string readOnly: true + type: object + GoogleCloudAiplatformV1TensorboardBlobSequence: + type: object + id: GoogleCloudAiplatformV1TensorboardBlobSequence + properties: + values: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' + description: List of blobs contained within the sequence. + description: >- + One point viewable on a blob metric plot, but mostly just a wrapper + message to work around repeated fields can't be used directly within + `oneof` fields. + GoogleCloudAiplatformV1NotebookIdleShutdownConfig: + id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig + description: >- + The idle shutdown configuration of NotebookRuntimeTemplate, which + contains the idle_timeout as required field. + properties: + idleShutdownDisabled: + type: boolean + description: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. + idleTimeout: + format: google-duration description: >- - Output only. Timestamp when this ModelDeploymentMonitoringJob was - created. - loggingSamplingStrategy: - description: Required. Sample Strategy for logging. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' - scheduleState: - enum: - - MONITORING_SCHEDULE_STATE_UNSPECIFIED - - PENDING - - OFFLINE - - RUNNING - description: >- - Output only. Schedule state when the monitoring job is in Running - state. + Required. Duration is accurate to the second. In Notebook, Idle + Timeout is accurate to minute so the range of idle_timeout (second) + is: 10 * 60 ~ 1440 * 60. type: string + type: object + GoogleCloudAiplatformV1NotebookExecutionJob: + id: GoogleCloudAiplatformV1NotebookExecutionJob + type: object + description: NotebookExecutionJob represents an instance of a notebook execution. + properties: + scheduleResourceName: readOnly: true - enumDescriptions: - - Unspecified state. - - The pipeline is picked up and wait to run. - - The pipeline is offline and will be scheduled for next run. - - The pipeline is running. - modelMonitoringAlertConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfig - description: Alert config for model monitoring. - updateTime: - format: google-datetime + type: string description: >- - Output only. Timestamp when this ModelDeploymentMonitoringJob was - updated most recently. + Output only. The Schedule resource name if this job is triggered by + one. Format: + `projects/{project_id}/locations/{location}/schedules/{schedule_id}` + executionTimeout: + description: >- + Max running time of the execution job in seconds (default 86400s / + 24 hrs). + format: google-duration type: string - readOnly: true - modelDeploymentMonitoringScheduleConfig: - description: Required. Schedule config for running the monitoring job. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig - name: - description: Output only. Resource name of a ModelDeploymentMonitoringJob. + notebookRuntimeTemplateResourceName: + description: The NotebookRuntimeTemplate to source compute configuration from. + type: string + createTime: type: string readOnly: true - statsAnomaliesBaseDirectory: - description: Stats anomalies base folder path. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Output only. Timestamp when this NotebookExecutionJob was created. + format: google-datetime labels: + type: object description: >- - The labels with user-defined metadata to organize your - ModelDeploymentMonitoringJob. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase + The labels with user-defined metadata to organize + NotebookExecutionJobs. Label keys and values can be no longer than + 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - type: object + information and examples of labels. System reserved label keys are + prefixed with "aiplatform.googleapis.com/" and are immutable. additionalProperties: type: string - analysisInstanceSchemaUri: - description: >- - YAML schema file uri describing the format of a single instance that - you want Tensorflow Data Validation (TFDV) to analyze. If this field - is empty, all the feature data types are inferred from - predict_instance_schema_uri, meaning that TFDV will use the data in - the exact format(data type) as prediction request/response. If there - are any data type differences between predict instance and TFDV - instance, this field can be used to override the schema. For models - trained with Vertex AI, this field must be set as all the fields in - predict instance formatted as string. + directNotebookSource: + description: The contents of an input notebook file. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource + name: type: string - modelDeploymentMonitoringObjectiveConfigs: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig + readOnly: true description: >- - Required. The config for monitoring objectives. This is a per - DeployedModel config. Each DeployedModel needs to be configured - separately. - encryptionSpec: + Output only. The resource name of this NotebookExecutionJob. Format: + `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` + displayName: description: >- - Customer-managed encryption key spec for a - ModelDeploymentMonitoringJob. If set, this - ModelDeploymentMonitoringJob and all sub-resources of this - ModelDeploymentMonitoringJob will be secured by this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - latestMonitoringPipelineMetadata: - readOnly: true - description: Output only. Latest triggered monitoring pipeline metadata. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata - state: + The display name of the NotebookExecutionJob. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + type: string + updateTime: + type: string + description: >- + Output only. Timestamp when this NotebookExecutionJob was most + recently updated. + format: google-datetime readOnly: true + serviceAccount: type: string - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED + description: The service account to run the execution as. + status: + readOnly: true description: >- - Output only. The detailed state of the monitoring job. When the job - is still creating, the state will be 'PENDING'. Once the job is - successfully created, the state will be 'RUNNING'. Pause the job, - the state will be 'PAUSED'. Resume the job, the state will return to - 'RUNNING'. + Output only. Populated when the NotebookExecutionJob is completed. + When there is an error during notebook execution, the error details + are populated. + $ref: '#/components/schemas/GoogleRpcStatus' + jobState: enumDescriptions: - The job state is unspecified. - >- @@ -3757,1051 +3864,821 @@ components: - >- The job is partially succeeded, some results may be missing due to errors. - samplePredictInstance: - description: >- - Sample Predict instance, same format as PredictRequest.instances, - this can be set as a replacement of - ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not - set, we will generate predict schema from collected predict - requests. - type: any - displayName: - type: string - description: >- - Required. The user-defined name of the ModelDeploymentMonitoringJob. - The name can be up to 128 characters long and can consist of any - UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. - satisfiesPzs: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - bigqueryTables: readOnly: true + description: Output only. The state of the NotebookExecutionJob. + type: string + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + gcsNotebookSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource description: >- - Output only. The created bigquery tables for the job under customer - project. Customer could do their own query & analysis. There could - be 4 log tables in maximum: 1. Training data logging predict - request/response 2. Serving data logging predict request/response - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable - predictInstanceSchemaUri: + The Cloud Storage url pointing to the ipynb file. Format: + `gs://bucket/notebook_file.ipynb` + executionUser: type: string description: >- - YAML schema file uri describing the format of a single instance, - which are given to format this Endpoint's prediction (and - explanation). If not set, we will generate predict schema from - collected predict requests. - logTtl: + The user email to run the execution as. Only supported by Colab + runtimes. + gcsOutputUri: type: string - format: google-duration description: >- - The TTL of BigQuery tables in user projects which stores logs. A day - is the basic unit of the TTL and we take the ceil of TTL/86400(a - day). e.g. { second: 3600} indicates ttl = 1 day. - nextScheduleTime: + The Cloud Storage location to upload the result to. Format: + `gs://bucket-name` + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Output only. Timestamp when this monitoring pipeline will be - scheduled to run for the next round. - readOnly: true - format: google-datetime + Customer-managed encryption key spec for the notebook execution job. + This field is auto-populated if the + NotebookService.NotebookRuntimeTemplate has an encryption spec. + dataformRepositorySource: + description: >- + The Dataform Repository pointing to a single file notebook + repository. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource + GoogleCloudAiplatformV1ToolCallValidInstance: + properties: + prediction: + type: string + description: Required. Output of the evaluated model. + reference: + description: Required. Ground truth used to compare against the prediction. type: string - description: >- - Represents a job that runs periodically to monitor the deployed models - in an endpoint. It will analyze the logged training & prediction data to - detect any abnormal behaviors. - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob - GoogleCloudAiplatformV1PipelineJobRuntimeConfig: - description: The runtime config of a PipelineJob. - id: GoogleCloudAiplatformV1PipelineJobRuntimeConfig type: object + description: Spec for tool call valid instance. + id: GoogleCloudAiplatformV1ToolCallValidInstance + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig: properties: - gcsOutputDirectory: - type: string - description: >- - Required. A path in a Cloud Storage bucket, which will be treated as - the root output directory of the pipeline. It is used by the system - to generate the paths of output artifacts. The artifact paths are - generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` - under the specified output directory. The service account specified - in this pipeline must have the `storage.objects.get` and - `storage.objects.create` permissions for this bucket. - failurePolicy: + value: + format: double description: >- - Represents the failure policy of a pipeline. Currently, the default - of a pipeline is that the pipeline will continue to run until no - more tasks can be executed, also known as - PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to - PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new - tasks when a task has failed. Any scheduled tasks will continue to - completion. + Specify a threshold value that can trigger the alert. 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. Each feature + must have a non-zero threshold if they need to be monitored. + Otherwise no alert will be triggered for that feature. + type: number + description: The config for Featurestore Monitoring threshold. + type: object + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest: + description: Request message for [NotebookService.CreateNotebookExecutionJob] + id: GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest + type: object + properties: + notebookExecutionJobId: + description: Optional. User specified ID for the NotebookExecutionJob. + type: string + parent: type: string - enumDescriptions: - - Default value, and follows fail slow behavior. - - >- - Indicates that the pipeline should continue to run until all - possible tasks have been scheduled and completed. - - >- - Indicates that the pipeline should stop scheduling new tasks after - a task has failed. - enum: - - PIPELINE_FAILURE_POLICY_UNSPECIFIED - - PIPELINE_FAILURE_POLICY_FAIL_SLOW - - PIPELINE_FAILURE_POLICY_FAIL_FAST - parameterValues: - additionalProperties: - type: any - description: >- - The runtime parameters of the PipelineJob. The parameters will be - passed into PipelineJob.pipeline_spec to replace the placeholders at - runtime. This field is used by pipelines built using - `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines - built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. - type: object - inputArtifacts: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact - description: >- - The runtime artifacts of the PipelineJob. The key will be the input - artifact name and the value would be one of the InputArtifact. - type: object - parameters: description: >- - Deprecated. Use RuntimeConfig.parameter_values instead. The runtime - parameters of the PipelineJob. The parameters will be passed into - PipelineJob.pipeline_spec to replace the placeholders at runtime. - This field is used by pipelines built using - `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as - pipelines built using Kubeflow Pipelines SDK 1.8 or lower. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Value' - deprecated: true - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting: + Required. The resource name of the Location to create the + NotebookExecutionJob. Format: + `projects/{project}/locations/{location}` + notebookExecutionJob: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + description: Required. The NotebookExecutionJob to create. + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput: + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput properties: - metadata: + instance: + description: Required. Pairwise question answering quality instance. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata - description: The metadata information. - inputs: - description: The input parameters of this TrainingJob. + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance + metricSpec: + description: Required. Spec for pairwise question answering quality score metric. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec type: object - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting - GoogleCloudAiplatformV1XraiAttribution: - description: >- - An explanation method that redistributes Integrated Gradients - attributions to segmented regions, taking advantage of the model's fully - differentiable structure. Refer to this paper for more details: - https://arxiv.org/abs/1906.02825 Supported only by image Models. - id: GoogleCloudAiplatformV1XraiAttribution + description: Input for pairwise question answering quality metric. + GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset: type: object + description: Represents one AnnotatedDataset in datalabeling.googleapis.com. + id: >- + GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset properties: - stepCount: - format: int32 - type: integer - description: >- - Required. The number of steps for approximating the path integral. A - good value to start is 50 and gradually increase until the sum to - diff property is met within the desired error range. Valid range of - its value is [1, 100], inclusively. - smoothGradConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' + annotatedDatasetDisplayName: + type: string + description: The AnnotatedDataset's display name in datalabeling.googleapis.com. + annotatedDataset: description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy - samples in the vicinity of the inputs. Adding noise can help improve - the computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf - blurBaselineConfig: + Full resource name of data labeling AnnotatedDataset. Format: + `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + type: string + GoogleCloudAiplatformV1ListMetadataStoresResponse: + type: object + id: GoogleCloudAiplatformV1ListMetadataStoresResponse + properties: + nextPageToken: description: >- - Config for XRAI with blur baseline. When enabled, a linear path from - the maximally blurred image to the input image is created. Using a - blurred baseline instead of zero (black image) is motivated by the - BlurIG approach explained here: https://arxiv.org/abs/2004.03383 - $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' - GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: - description: Runtime operation information for DatasetService.RestoreDatasetVersion. + A token, which can be sent as ListMetadataStoresRequest.page_token + to retrieve the next page. If this field is not populated, there are + no subsequent pages. + type: string + metadataStores: + type: array + description: The MetadataStores found for the Location. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + description: Response message for MetadataService.ListMetadataStores. + GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata: + description: Details of operations that perform update Tensorboard. + type: object + id: GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata properties: genericMetadata: - description: The common part of the operation metadata. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata - type: object - GoogleCloudAiplatformV1UploadModelRequest: - id: GoogleCloudAiplatformV1UploadModelRequest - description: Request message for ModelService.UploadModel. + description: Operation metadata for Tensorboard. + GoogleCloudAiplatformV1SchemaImageClassificationAnnotation: + id: GoogleCloudAiplatformV1SchemaImageClassificationAnnotation + description: Annotation details specific to image classification. type: object properties: - parentModel: + annotationSpecId: description: >- - Optional. The resource name of the model into which to upload the - version. Only specify this field when uploading a new version. + The resource Id of the AnnotationSpec that this Annotation pertains + to. type: string - serviceAccount: + displayName: type: string description: >- - Optional. The user-provided custom service account to use to do the - model upload. If empty, [Vertex AI Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) - will be used to access resources needed to upload the model. This - account must belong to the target project where the model is - uploaded to, i.e., the project specified in the `parent` field of - this request and have necessary read permissions (to Google Cloud - Storage, Artifact Registry, etc.). - model: - description: Required. The Model to create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - modelId: + The display name of the AnnotationSpec that this Annotation pertains + to. + GoogleCloudAiplatformV1ListMetadataSchemasResponse: + id: GoogleCloudAiplatformV1ListMetadataSchemasResponse + properties: + metadataSchemas: + description: The MetadataSchemas found for the MetadataStore. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + nextPageToken: type: string description: >- - Optional. The ID to use for the uploaded Model, which will become - the final component of the model 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. - GoogleCloudAiplatformV1PurgeArtifactsRequest: - description: Request message for MetadataService.PurgeArtifacts. - id: GoogleCloudAiplatformV1PurgeArtifactsRequest + A token, which can be sent as ListMetadataSchemasRequest.page_token + to retrieve the next page. If this field is not populated, there are + no subsequent pages. + description: Response message for MetadataService.ListMetadataSchemas. type: object + GoogleCloudAiplatformV1PairwiseSummarizationQualityInput: properties: - force: - description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Artifact names - that would be deleted. - type: boolean - filter: - type: string - description: >- - Required. A required filter matching the Artifacts to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. - GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail: + metricSpec: + description: Required. Spec for pairwise summarization quality score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec + instance: + description: Required. Pairwise summarization quality instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInput + description: Input for pairwise summarization quality metric. type: object - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail + GoogleCloudAiplatformV1ExportModelRequest: + description: Request message for ModelService.ExportModel. properties: - mainJob: - description: >- - Output only. The name of the CustomJob for the main container - execution. - readOnly: true + outputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportModelRequestOutputConfig + description: Required. The desired output location and configuration. + id: GoogleCloudAiplatformV1ExportModelRequest + type: object + GoogleCloudAiplatformV1IndexDatapointNumericRestriction: + properties: + namespace: + description: 'The namespace of this restriction. e.g.: cost.' type: string - failedMainJobs: - type: array - readOnly: true - description: >- - Output only. The names of the previously failed CustomJob for the - main container executions. The list includes the all attempts in - chronological order. - items: - type: string - preCachingCheckJob: - description: >- - Output only. The name of the CustomJob for the pre-caching-check - container execution. This job will be available if the - PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in - the lifecycle events. + valueInt: + format: int64 + description: Represents 64 bit integer. type: string - readOnly: true - failedPreCachingCheckJobs: - description: >- - Output only. The names of the previously failed CustomJob for the - pre-caching-check container executions. This job will be available - if the PipelineJob.pipeline_spec specifies the `pre_caching_check` - hook in the lifecycle events. The list includes the all attempts in - chronological order. - type: array - items: - type: string - readOnly: true - description: >- - The detail of a container execution. It contains the job names of the - lifecycle of a container execution. - GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams: - properties: - confidenceThreshold: + valueDouble: + format: double + description: Represents 64 bit float. type: number - description: >- - When the model predicts category of pixels of the image, it will - only provide predictions for pixels that it is at least this much - confident about. All other pixels will be classified as background. - Default value is 0.5. + valueFloat: + type: number + description: Represents 32 bit float. format: float - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams - description: Prediction model parameters for Image Segmentation. - type: object - GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource: - properties: - generation: - type: string + op: description: >- - The version of the Cloud Storage object to read. If unset, the - current version of the object is read. See - https://cloud.google.com/storage/docs/metadata#generation-number. - uri: + This MUST be specified for queries and must NOT be specified for + datapoints. type: string - description: >- - The Cloud Storage uri pointing to the ipynb file. Format: - `gs://bucket/notebook_file.ipynb` - description: The Cloud Storage uri for the input notebook. - id: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource + enum: + - OPERATOR_UNSPECIFIED + - LESS + - LESS_EQUAL + - EQUAL + - GREATER_EQUAL + - GREATER + - NOT_EQUAL + enumDescriptions: + - Default value of the enum. + - Datapoints are eligible iff their value is < the query's. + - Datapoints are eligible iff their value is <= the query's. + - Datapoints are eligible iff their value is == the query's. + - Datapoints are eligible iff their value is >= the query's. + - Datapoints are eligible iff their value is > the query's. + - Datapoints are eligible iff their value is != the query's. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs: + description: >- + This field allows restricts to be based on numeric comparisons rather + than categorical tokens. + id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction + GoogleCloudAiplatformV1TensorboardExperiment: properties: - quantiles: - items: - type: number - format: double - description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`. Up to 5 quantiles are allowed of values - between 0 and 1, exclusive. Required if the value of - optimization_objective is minimize-quantile-loss. Represents the - percent quantiles to use for that objective. Quantiles must be - unique. - type: array - exportEvaluatedDataItemsConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - targetColumn: - description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. - type: string - forecastHorizon: - type: string - description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - format: int64 - unavailableAtForecastColumns: - type: array - description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. - items: - type: string - timeColumn: - type: string - description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. - contextWindow: - description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. - type: string - format: int64 - weightColumn: - description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. This column must be available at forecast. - type: string - optimizationObjective: + createTime: + readOnly: true + format: google-datetime + description: Output only. Timestamp when this TensorboardExperiment was created. type: string + labels: description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. - additionalExperiments: - description: Additional experiment flags for the time series forcasting training. - type: array - items: + The labels with user-defined metadata to organize your + TensorboardExperiment. Label keys and values cannot be longer than + 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. No more than 64 user labels can be + associated with one Dataset (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + `aiplatform.googleapis.com/` and are immutable. The following system + labels exist for each Dataset: * + `aiplatform.googleapis.com/dataset_metadata_schema`: output only. + Its value is the metadata_schema's title. + type: object + additionalProperties: type: string - validationOptions: + source: description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue + Immutable. Source of the TensorboardExperiment. Example: a custom + training job. type: string - availableAtForecastColumns: - description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. - type: array - items: - type: string - timeSeriesAttributeColumns: - description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - type: array - items: - type: string - hierarchyConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - dataGranularity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity - description: Expected difference in time granularity between rows in the data. - trainBudgetMilliNodeHours: - format: int64 + updateTime: description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. + Output only. Timestamp when this TensorboardExperiment was last + updated. + readOnly: true + format: google-datetime type: string - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. + description: type: string - transformations: - type: array - description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation - holidayRegions: - items: - type: string - type: array - description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. - windowConfig: - description: Config containing strategy for generating sliding windows. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs - GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: - description: Runtime operation information for DatasetService.CreateDatasetVersion. - id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata - type: object - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1MigrateResourceResponse: - type: object - description: Describes a successfully migrated resource. - properties: - model: + description: Description of this TensorboardExperiment. + displayName: type: string - description: Migrated Model's resource name. - migratableResource: - description: >- - Before migration, the identifier in ml.googleapis.com, - automl.googleapis.com or datalabeling.googleapis.com. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' - dataset: - description: Migrated Dataset's resource name. + description: User provided name of this TensorboardExperiment. + etag: type: string - id: GoogleCloudAiplatformV1MigrateResourceResponse - GoogleCloudAiplatformV1FunctionResponse: - properties: - response: - type: object - additionalProperties: - description: Properties of the object. - type: any description: >- - Required. The function response in JSON object format. Use "output" - key to specify function output and "error" key to specify error - details (if any). If "output" and "error" keys are not specified, - then whole "response" is treated as function output. + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. name: type: string description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name] and [FunctionCall.name]. - id: GoogleCloudAiplatformV1FunctionResponse + Output only. Name of the TensorboardExperiment. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + readOnly: true type: object 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. - GoogleCloudAiplatformV1ExplanationSpec: - description: Specification of Model explanation. - id: GoogleCloudAiplatformV1ExplanationSpec - type: object + A TensorboardExperiment is a group of TensorboardRuns, that are + typically the results of a training job run, in a Tensorboard. + id: GoogleCloudAiplatformV1TensorboardExperiment + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation: properties: metadata: - description: >- - Optional. Metadata describing the Model's input and output for - explanation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationMetadata' - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' - description: >- - Required. Parameters that configure explaining of the Model's - predictions. - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange: - description: A range of values for slice(s). `low` is inclusive, `high` is exclusive. + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs + description: >- + A TrainingJob that trains and uploads an AutoML Image Segmentation + Model. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Convert the category name to a dictionary lookup index and generate an + embedding for each index. + properties: + columnName: + type: string type: object + GoogleCloudAiplatformV1BlurBaselineConfig: properties: - high: - format: float - description: Exclusive high value for the range. - type: number - low: - description: Inclusive low value for the range. + maxBlurSigma: format: float + description: >- + The standard deviation of the blur kernel for the blurred baseline. + The same blurring parameter is used for both the height and the + width dimension. If not set, the method defaults to the zero (i.e. + black for images) baseline. type: number - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange - GoogleCloudAiplatformV1PSCAutomationConfig: type: object + id: GoogleCloudAiplatformV1BlurBaselineConfig description: >- - PSC config that is used to automatically create forwarding rule via - ServiceConnectionMap. - properties: - network: - type: string - description: >- - Required. The full name of the Google Compute Engine - [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where {project} is a - project number, as in '12345', and {network} is network name. - projectId: - description: Required. Project id used to create forwarding rule. - type: string - id: GoogleCloudAiplatformV1PSCAutomationConfig - GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor: - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor - description: Metadata for requested Features. + Config for blur baseline. When enabled, a linear path from the maximally + blurred image to the input image is created. Using a blurred baseline + instead of zero (black image) is motivated by the BlurIG approach + explained here: https://arxiv.org/abs/2004.03383 + GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors: + description: Nearest neighbors for one query. + type: object + id: GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors properties: + neighbors: + description: All its neighbors. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNeighbor id: type: string - description: Feature ID. - type: object - GoogleCloudAiplatformV1TimeSeriesDataPoint: + description: The ID of the query datapoint. + GoogleCloudAiplatformV1SummarizationQualityInstance: type: object - description: A TensorboardTimeSeries data point. + description: Spec for summarization quality instance. + id: GoogleCloudAiplatformV1SummarizationQualityInstance properties: - scalar: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scalar' - description: A scalar value. - wallTime: - format: google-datetime + instruction: + description: Required. Summarization prompt for LLM. type: string - description: >- - Wall clock timestamp when this data point is generated by the end - user. - step: - format: int64 - description: Step index of this data point within the run. + reference: type: string - tensor: - description: A tensor value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTensor' - blobs: - description: A blob sequence value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlobSequence' - id: GoogleCloudAiplatformV1TimeSeriesDataPoint - GoogleCloudAiplatformV1EvaluatedAnnotationExplanation: - properties: - explanation: - description: Explanation attribution response details. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' - explanationType: + description: Optional. Ground truth used to compare against the prediction. + prediction: + description: Required. Output of the evaluated model. + type: string + context: type: string + description: Required. Text to be summarized. + GoogleCloudAiplatformV1SummarizationQualitySpec: + properties: + useReference: description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - id: GoogleCloudAiplatformV1EvaluatedAnnotationExplanation - type: object - description: Explanation result of the prediction produced by the Model. - GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue: - description: Tool parameter key match metric value for an instance. - id: GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue + Optional. Whether to use instance.reference to compute summarization + quality. + type: boolean + version: + format: int32 + description: Optional. Which version to use for evaluation. + type: integer + description: Spec for summarization quality score metric. type: object + id: GoogleCloudAiplatformV1SummarizationQualitySpec + GoogleCloudAiplatformV1FulfillmentResult: + description: Spec for fulfillment result. properties: score: type: number - description: Output only. Tool parameter key match score. + readOnly: true + format: float + description: Output only. Fulfillment score. + confidence: format: float + description: Output only. Confidence for fulfillment score. readOnly: true - GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata: - properties: - multiLabel: - description: Whether or not the classification label is multi_label. - type: boolean + type: number + explanation: + type: string + description: Output only. Explanation for fulfillment score. + readOnly: true + id: GoogleCloudAiplatformV1FulfillmentResult type: object - id: >- - GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata - GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: - properties: - genericMetadata: - description: Operation metadata for FeatureOnlineStore. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata + GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec: + description: >- + The median automated stopping rule stops a pending Trial if the Trial's + best objective_value is strictly below the median 'performance' of all + completed Trials reported up to the Trial's last measurement. Currently, + 'performance' refers to the running average of the objective values + reported by the Trial in each measurement. type: object - description: Details of operations that perform create FeatureOnlineStore. - GoogleCloudAiplatformV1ToolCallValidInstance: - id: GoogleCloudAiplatformV1ToolCallValidInstance + id: GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec properties: - reference: - type: string - description: Required. Ground truth used to compare against the prediction. - prediction: - type: string - description: Required. Output of the evaluated model. - description: Spec for tool call valid instance. + useElapsedDuration: + type: boolean + description: >- + True if median automated stopping rule applies on + Measurement.elapsed_duration. It means that elapsed_duration field + of latest measurement of current Trial is used to compute median + objective value for each completed Trials. + GoogleCloudAiplatformV1GoogleSearchRetrieval: + properties: {} + id: GoogleCloudAiplatformV1GoogleSearchRetrieval + description: Tool to retrieve public web data for grounding, powered by Google. + type: object + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition: + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + description: Represents the spec to match categorical values from parent parameter. type: object - GoogleCloudAiplatformV1PredictRequest: - id: GoogleCloudAiplatformV1PredictRequest properties: - instances: + values: description: >- - Required. The instances that are the input to the prediction call. A - DeployedModel may have an upper limit on the number of instances it - supports per request, and when it is exceeded the prediction call - errors in case of AutoML Models, or, in case of customer created - Models, the behaviour is as documented by that Model. The schema of - any single instance may be specified via Endpoint's DeployedModels' - Model's PredictSchemata's instance_schema_uri. + Required. Matches values of the parent parameter of 'CATEGORICAL' + type. All values must exist in `categorical_value_spec` of parent + parameter. items: - type: any + type: string type: array - parameters: - description: >- - The parameters that govern the prediction. The schema of the - parameters may be specified via Endpoint's DeployedModels' Model's - PredictSchemata's parameters_schema_uri. - type: any - description: Request message for PredictionService.Predict. + GoogleCloudAiplatformV1CreateTensorboardRunRequest: type: object - GoogleCloudAiplatformV1NearestNeighborQuery: + id: GoogleCloudAiplatformV1CreateTensorboardRunRequest properties: - perCrowdingAttributeNeighborCount: + tensorboardRunId: + type: string description: >- - Optional. Crowding is a constraint on a neighbor list produced by - nearest neighbor search requiring that no more than - sper_crowding_attribute_neighbor_count of the k neighbors returned - have the same value of crowding_attribute. It's used for improving - result diversity. - type: integer - format: int32 - embedding: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryEmbedding - description: Optional. The embedding vector that be used for similar search. - neighborCount: - format: int32 - type: integer + 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-/`. + parent: description: >- - Optional. The number of similar entities to be retrieved from - feature view for each query. - parameters: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryParameters - description: Optional. Parameters that can be set to tune query on the fly. - numericFilters: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter - description: Optional. The list of numeric filters. - type: array - entityId: + Required. The resource name of the TensorboardExperiment to create + the TensorboardRun in. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` type: string + tensorboardRun: + description: Required. The TensorboardRun to create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + description: Request message for TensorboardService.CreateTensorboardRun. + GoogleCloudAiplatformV1RayLogsSpec: + properties: + disabled: + type: boolean description: >- - Optional. The entity id whose similar entities should be searched - for. If embedding is set, search will use embedding instead of - entity_id. - stringFilters: - type: array - description: Optional. The list of string filters. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryStringFilter - id: GoogleCloudAiplatformV1NearestNeighborQuery - description: A query to find a number of similar entities. - type: object - GoogleCloudAiplatformV1UndeployModelResponse: - type: object - id: GoogleCloudAiplatformV1UndeployModelResponse - properties: {} - description: Response message for EndpointService.UndeployModel. - GoogleCloudAiplatformV1RemoveContextChildrenResponse: - type: object - properties: {} - id: GoogleCloudAiplatformV1RemoveContextChildrenResponse - description: Response message for MetadataService.RemoveContextChildren. - GoogleCloudAiplatformV1ImportDataConfig: - id: GoogleCloudAiplatformV1ImportDataConfig + Optional. Flag to disable the export of Ray OSS logs to Cloud + Logging. + id: GoogleCloudAiplatformV1RayLogsSpec + description: Configuration for the Ray OSS Logs. type: object - 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. + GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult: properties: - annotationLabels: - type: object - additionalProperties: - type: string + timeSegmentStart: description: >- - Labels that will be applied to newly imported Annotations. If two - Annotations are identical, one of them will be deduped. Two - Annotations are considered identical if their payload, - payload_schema_uri and all of their labels are the same. These - labels will be overridden by Annotation labels specified inside - index file referenced by import_schema_uri, e.g. jsonl file. - importSchemaUri: + The beginning, inclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. Note that + for 'segment-classification' prediction type, this equals the + original 'timeSegmentStart' from the input instance, for other types + it is the start of a shot or a 1 second interval respectively. type: string + format: google-duration + timeSegmentEnd: + format: google-duration description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing the import format. Validation will be done against the - schema. The schema is defined as an [OpenAPI 3.0.2 Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - dataItemLabels: - type: object - additionalProperties: - type: string + The end, exclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. Note that + for 'segment-classification' prediction type, this equals the + original 'timeSegmentEnd' from the input instance, for other types + it is the end of a shot or a 1 second interval respectively. + type: string + type: description: >- - Labels that will be applied to newly imported DataItems. If an - identical DataItem as one being imported already exists in the - Dataset, then these labels will be appended to these of the already - existing one, and if labels with identical key is imported before, - the old label value will be overwritten. If two DataItems are - identical in the same import data operation, the labels will be - combined and if key collision happens in this case, one of the - values will be picked randomly. Two DataItems are considered - identical if their content bytes are identical (e.g. image bytes or - pdf bytes). These labels will be overridden by Annotation labels - specified inside index file referenced by import_schema_uri, e.g. - jsonl file. - gcsSource: - description: The Google Cloud Storage location for the input content. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics: - properties: - meanAbsoluteError: - format: float + The type of the prediction. The requested types can be configured + via parameters. This will be one of - segment-classification - + shot-classification - one-sec-interval-classification + type: string + confidence: description: >- - Mean absolute error. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - type: number - meanSquaredError: + The Model's confidence in correction of this prediction, higher + value means higher confidence. format: float - description: >- - Mean squared error. Only set for ModelEvaluations, not for - ModelEvaluationSlices. type: number - confusionMatrix: + displayName: + description: The display name of the AnnotationSpec that had been identified. + type: string + id: + description: The resource ID of the AnnotationSpec that had been identified. + type: string + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult + description: Prediction output format for Video Classification. + type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig: + properties: + trainingDataset: description: >- - Confusion matrix of the evaluation. Only set for ModelEvaluations, - not for ModelEvaluationSlices. + Training dataset for models. This field has to be set only if + TrainingPredictionSkewDetectionConfig is specified. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - linearKappa: - description: >- - Linear weighted kappa. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - type: number - format: float - recall: - format: float - type: number - description: Recall. - quadraticKappa: - type: number - format: float - description: >- - Quadratic weighted kappa. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - precision: - type: number - format: float - description: Precision. - f1Score: - format: float - type: number - description: The harmonic mean of recall and precision. + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset + explanationConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig + description: The config for integrating with Vertex Explainable AI. + trainingPredictionSkewDetectionConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + description: The config for skew between training data and prediction data. + predictionDriftDetectionConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig + description: The config for drift of prediction data. type: object - description: Model evaluation metrics for text sentiment problems. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics - GoogleCloudAiplatformV1SuggestTrialsResponse: + description: >- + The objective configuration for model monitoring, including the + information needed to detect anomalies for one particular model. + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: + id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata + description: Runtime operation information for DatasetService.RestoreDatasetVersion. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + type: object + GoogleCloudAiplatformV1PairwiseMetricResult: type: object + id: GoogleCloudAiplatformV1PairwiseMetricResult properties: - endTime: - type: string - description: The time at which operation processing completed. - format: google-datetime - trials: - type: array - description: A list of Trials. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - studyState: - description: The state of the Study. + pairwiseChoice: enumDescriptions: - - The study state is unspecified. - - The study is active. - - The study is stopped due to an internal error. - - >- - The study is done when the service exhausts the parameter search - space or max_trial_count is reached. + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined + description: Output only. Pairwise metric choice. enum: - - STATE_UNSPECIFIED - - ACTIVE - - INACTIVE - - COMPLETED - type: string - startTime: + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE type: string - description: The time at which the operation was started. - format: google-datetime - description: Response message for VizierService.SuggestTrials. - id: GoogleCloudAiplatformV1SuggestTrialsResponse - GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: - properties: - mean: - readOnly: true - type: number - description: Output only. The arithmetic mean of the values in the population. - format: double - sum: - format: int64 readOnly: true + explanation: + description: Output only. Explanation for pairwise metric score. type: string - description: Output only. Sum of a given population of values. - min: - format: double - description: Output only. The minimum of the population values. - readOnly: true - type: number - median: - type: number - format: double - readOnly: true - description: Output only. The median of the values in the population. - p5: - format: double - type: number - description: Output only. The 5th percentile of the values in the population. readOnly: true - buckets: - readOnly: true - description: Output only. Defines the histogram bucket. + description: Spec for pairwise metric result. + GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks: + properties: + notebooks: + description: Required. Regional resource references to notebooks. + type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket - type: array - p95: - format: double - description: Output only. The 95th percentile of the values in the population. - type: number - readOnly: true - billableSum: - format: int64 - type: string - readOnly: true - description: Output only. Sum of a given population of values that are billable. - max: - format: double - description: Output only. The maximum of the population values. - readOnly: true - type: number - type: object - description: Dataset distribution for Supervised Tuning. - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - GoogleCloudAiplatformV1FeatureValueMetadata: - id: GoogleCloudAiplatformV1FeatureValueMetadata - properties: - generateTime: - format: google-datetime - description: >- - Feature generation timestamp. Typically, it is provided by user at - feature ingestion time. If not, feature store will use the system - timestamp when the data is ingested into feature store. For - streaming ingestion, the time, aligned by days, must be no older - than five years (1825 days) and no later than one year (366 days) in - the future. - type: string - type: object - description: Metadata of feature value. - GoogleCloudAiplatformV1Blob: - properties: - data: - format: byte - description: Required. Raw bytes. - type: string - mimeType: - description: Required. The IANA standard MIME type of the source data. - type: string - description: >- - Content blob. It's preferred to send as text directly rather than raw - bytes. - id: GoogleCloudAiplatformV1Blob - type: object - GoogleCloudAiplatformV1WriteTensorboardRunDataResponse: + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks + description: Open notebooks. type: object - properties: {} - description: Response message for TensorboardService.WriteTensorboardRunData. - id: GoogleCloudAiplatformV1WriteTensorboardRunDataResponse - GoogleCloudAiplatformV1BoolArray: - id: GoogleCloudAiplatformV1BoolArray - description: A list of boolean values. + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource: type: object properties: - values: + uri: + description: >- + Cloud Storage URI of one or more files. Only CSV files are + supported. The first line of the CSV file is used as the header. If + there are multiple files, the header is the first line of the + lexicographically first file, the other files must either contain + the exact same header or omit the header. items: - type: boolean - description: A list of bool values. + type: string type: array - GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: - description: >- - Dataset bucket used to create a histogram for the distribution given a - population of values. - type: object - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig: properties: - right: - description: Output only. Right bound of the bucket. - type: number - format: double - readOnly: true - left: + desiredMinSafeTrialsFraction: format: double type: number - description: Output only. Left bound of the bucket. - readOnly: true - count: + description: >- + Desired minimum fraction of safe trials (over total number of + trials) that should be targeted by the algorithm at any time during + the study (best effort). This should be between 0.0 and 1.0 and a + value of 0.0 means that there is no minimum and an algorithm + proceeds without targeting any specific fraction. A value of 1.0 + means that the algorithm attempts to only Suggest safe Trials. + safetyThreshold: + description: >- + Safety threshold (boundary value between safe and unsafe). NOTE that + if you leave SafetyMetricConfig unset, a default value of 0 will be + used. format: double type: number - readOnly: true - description: Output only. Number of values in the bucket. - GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig: + id: GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig type: object - id: GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig - properties: - leafNodeEmbeddingCount: - description: >- - Optional. Number of embeddings on each leaf node. The default value - is 1000 if not set. - type: string - format: int64 - description: Configuration options for the tree-AH algorithm. - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis: description: >- - Configuration of the Featurestore's Snapshot Analysis Based Monitoring. - This type of analysis generates statistics for each Feature based on a - snapshot of the latest feature value of each entities every - monitoring_interval. - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis + Used in safe optimization to specify threshold levels and risk + tolerance. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs + type: object properties: - disabled: - type: boolean + baseModelId: + type: string description: >- - The monitoring schedule for snapshot analysis. For EntityType-level - config: unset / disabled = true indicates disabled by default for - Features under it; otherwise by default enable snapshot analysis - monitoring with monitoring_interval for Features under it. - Feature-level config: disabled = true indicates disabled regardless - of the EntityType-level config; unset monitoring_interval indicates - going with EntityType-level config; otherwise run snapshot analysis - monitoring with monitoring_interval regardless of the - EntityType-level config. Explicitly Disable the snapshot analysis - based monitoring. - monitoringIntervalDays: - type: integer + The ID of the `base` model. If it is specified, the new model will + be trained based on the `base` model. Otherwise, the new model will + be trained from scratch. The `base` model must be in the same + Project and Location as the new Model to train, and have the same + modelType. + multiLabel: + type: boolean description: >- - Configuration of the snapshot analysis based monitoring pipeline - running interval. The value indicates number of days. - format: int32 - stalenessDays: - format: int32 - type: integer + If false, a single-label (multi-class) Model will be trained (i.e. + assuming that for each image just up to one annotation may be + applicable). If true, a multi-label Model will be trained (i.e. + assuming that for each image multiple annotations may be + applicable). + budgetMilliNodeHours: + format: int64 + type: string description: >- - Customized export features time window for snapshot analysis. Unit - is one day. Default value is 3 weeks. Minimum value is 1 day. - Maximum value is 4000 days. - type: object - GoogleCloudAiplatformV1SummarizationQualityInstance: - type: object - id: GoogleCloudAiplatformV1SummarizationQualityInstance - description: Spec for summarization quality instance. - properties: - context: + The training budget of creating this model, expressed in milli node + hours i.e. 1,000 value in this field means 1 node hour. The actual + metadata.costMilliNodeHours will be equal or less than this value. + If further model training ceases to provide any improvements, it + will stop without using the full budget and the + metadata.successfulStopReason will be `model-converged`. Note, + node_hour = actual_hour * number_of_nodes_involved. For modelType + `cloud`(default), the budget must be between 8,000 and 800,000 milli + node hours, inclusive. The default value is 192,000 which represents + one day in wall time, considering 8 nodes are used. For model types + `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, + `mobile-tf-high-accuracy-1`, the training budget must be between + 1,000 and 100,000 milli node hours, inclusive. The default value is + 24,000 which represents one day in wall time on a single node that + is used. + modelType: + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - CLOUD_1 + - MOBILE_TF_LOW_LATENCY_1 + - MOBILE_TF_VERSATILE_1 + - MOBILE_TF_HIGH_ACCURACY_1 + - EFFICIENTNET + - MAXVIT + - VIT + - COCA type: string - description: Required. Text to be summarized. - reference: - description: Optional. Ground truth used to compare against the prediction. + enumDescriptions: + - Should not be set. + - >- + A Model best tailored to be used within Google Cloud, and which + cannot be exported. Default. + - >- + A model type best tailored to be used within Google Cloud, which + cannot be exported externally. Compared to the CLOUD model above, + it is expected to have higher prediction accuracy. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device afterwards. + Expected to have low latency, but may have lower prediction + quality than other mobile models. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device with + afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device afterwards. + Expected to have a higher latency, but should also have a higher + prediction quality than other mobile models. + - >- + EfficientNet model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + MaxViT model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + ViT model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + CoCa model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + uptrainBaseModelId: + description: >- + The ID of `base` model for upTraining. If it is specified, the new + model will be upTrained based on the `base` model for upTraining. + Otherwise, the new model will be trained from scratch. The `base` + model for upTraining must be in the same Project and Location as the + new Model to train, and have the same modelType. type: string - prediction: + disableEarlyStopping: + description: >- + Use the entire training budget. This disables the early stopping + feature. When false the early stopping feature is enabled, which + means that AutoML Image Classification might stop training before + the entire training budget has been used. + type: boolean + tunableParameter: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + description: Trainer type for Vision TrainRequest. + GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance: + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance + description: Prediction input format for Text Extraction. + properties: + content: + description: The text snippet to make the predictions on. type: string - description: Required. Output of the evaluated model. - instruction: + mimeType: type: string - description: Required. Summarization prompt for LLM. - GoogleTypeInterval: - properties: - endTime: description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + key: type: string - format: google-datetime - 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. + This field is only used for batch prediction. If a key is provided, + the batch prediction result will by mapped to this key. If omitted, + then the batch prediction result will contain the entire input + instance. Vertex AI will not check if keys in the request are + duplicates, so it is up to the caller to ensure the keys are unique. + GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: + description: Dataset distribution for Supervised Tuning. + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + properties: + p95: + format: double + description: Output only. The 95th percentile of the values in the population. + type: number + readOnly: true + min: + type: number + format: double + description: Output only. The minimum of the population values. + readOnly: true + sum: type: string - format: google-datetime - id: GoogleTypeInterval + description: Output only. Sum of a given population of values. + format: int64 + readOnly: true + billableSum: + description: Output only. Sum of a given population of values that are billable. + readOnly: true + type: string + format: int64 + max: + type: number + format: double + description: Output only. The maximum of the population values. + readOnly: true + median: + type: number + readOnly: true + description: Output only. The median of the values in the population. + format: double + mean: + readOnly: true + type: number + description: Output only. The arithmetic mean of the values in the population. + format: double + p5: + format: double + description: Output only. The 5th percentile of the values in the population. + type: number + readOnly: true + buckets: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + description: Output only. Defines the histogram bucket. + readOnly: true type: object - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance: + GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata: + description: Details of operations that perform update FeatureGroup. type: object - id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance - description: Spec for question answering helpfulness instance. + properties: + genericMetadata: + description: Operation metadata for FeatureGroup. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata + GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance: properties: instruction: type: string @@ -4809,9824 +4686,9036 @@ components: Required. The question asked and other instruction in the inference prompt. context: + type: string description: Optional. Text provided as context to answer the question. + prediction: + description: Required. Output of the evaluated model. type: string reference: - type: string description: Optional. Ground truth used to compare against the prediction. - prediction: type: string - description: Required. Output of the evaluated model. - GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF: - description: Parameters for RRF algorithm that combines search results. - id: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF + description: Spec for question answering relevance instance. type: object + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance + GoogleCloudAiplatformV1Scheduling: + id: GoogleCloudAiplatformV1Scheduling properties: - alpha: - type: number - format: float + restartJobOnWorkerRestart: description: >- - Required. Users can provide an alpha value to give more weight to - dense vs sparse results. For example, if the alpha is 0, we only - return sparse and if the alpha is 1, we only return dense. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - type: object - properties: - columnName: + Restarts the entire CustomJob if a worker gets restarted. This + feature can be used by distributed training jobs that are not + resilient to workers leaving and joining a job. + type: boolean + timeout: + description: The maximum job running time. The default is 7 days. type: string - GoogleCloudAiplatformV1IdMatcher: - type: object - description: Matcher for Features of an EntityType by Feature ID. - id: GoogleCloudAiplatformV1IdMatcher - properties: - ids: + format: google-duration + strategy: + description: Optional. This determines which type of scheduling strategy to use. + enum: + - STRATEGY_UNSPECIFIED + - ON_DEMAND + - LOW_COST + - STANDARD + - SPOT + - FLEX_START + enumDeprecated: + - false + - true + - true + - false + - false + - false + type: string + enumDescriptions: + - Strategy will default to STANDARD. + - Deprecated. Regular on-demand provisioning strategy. + - Deprecated. Low cost by making potential use of spot resources. + - Standard provisioning strategy uses regular on-demand resources. + - Spot provisioning strategy uses spot resources. + - Flex Start strategy uses DWS to queue for resources. + disableRetries: description: >- - Required. The following are accepted as `ids`: * A single-element - list containing only `*`, which selects all Features in the target - EntityType, or * A list containing only Feature IDs, which selects - only Features with those IDs in the target EntityType. - items: - type: string - type: array - GoogleCloudAiplatformV1PairwiseMetricInput: - id: GoogleCloudAiplatformV1PairwiseMetricInput - properties: - instance: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInstance' - description: Required. Pairwise metric instance. - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricSpec' - description: Required. Spec for pairwise metric. + Optional. Indicates if the job should retry for internal errors + after the job starts running. If true, overrides + `Scheduling.restart_job_on_worker_restart` to false. + type: boolean + maxWaitDuration: + type: string + format: google-duration + description: >- + Optional. This is the maximum duration that a job will wait for the + requested resources to be provisioned if the scheduling strategy is + set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait + indefinitely. The default is 24 hours. + description: All parameters related to queuing and scheduling of custom jobs. type: object - description: Input for pairwise metric. - GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest: + GoogleCloudAiplatformV1FeatureViewVertexRagSource: type: object - description: Request message for [NotebookService.CreateNotebookExecutionJob] + id: GoogleCloudAiplatformV1FeatureViewVertexRagSource properties: - notebookExecutionJobId: - description: Optional. User specified ID for the NotebookExecutionJob. + uri: type: string - parent: description: >- - Required. The resource name of the Location to create the - NotebookExecutionJob. Format: - `projects/{project}/locations/{location}` + Required. The BigQuery view/table URI that will be materialized on + each manual sync trigger. The table/view is expected to have the + following columns and types at least: - `corpus_id` (STRING, + NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - + `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, + NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - + `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, + NULLABLE/REQUIRED) + ragCorpusId: + format: int64 + description: Optional. The RAG corpus id corresponding to this FeatureView. type: string - notebookExecutionJob: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' - description: Required. The NotebookExecutionJob to create. - id: GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest - GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata: - description: Runtime operation information for ModelService.UpdateExplanationDataset. + description: A Vertex Rag source for features that need to be synced to Online Store. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting: properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - id: GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata + description: The metadata information. type: object - GoogleCloudAiplatformV1ExportFractionSplit: + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting + GoogleCloudAiplatformV1ToolParameterKeyMatchResults: + id: GoogleCloudAiplatformV1ToolParameterKeyMatchResults + properties: + toolParameterKeyMatchMetricValues: + readOnly: true + description: Output only. Tool parameter key match metric values. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue + type: array type: object + description: Results for tool parameter key match metric. + GoogleCloudAiplatformV1Endpoint: description: >- - Assigns the input data to training, validation, and test sets as per the - given fractions. Any of `training_fraction`, `validation_fraction` and - `test_fraction` may optionally be provided, they must sum to up to 1. If - the provided ones sum to less than 1, the remainder is assigned to sets - as decided by Vertex AI. If none of the fractions are set, by default - roughly 80% of data is used for training, 10% for validation, and 10% - for test. - id: GoogleCloudAiplatformV1ExportFractionSplit - properties: - validationFraction: - type: number - description: >- - The fraction of the input data that is to be used to validate the - Model. - format: double - trainingFraction: - format: double - type: number - description: >- - The fraction of the input data that is to be used to train the - Model. - testFraction: - format: double - type: number - description: >- - The fraction of the input data that is to be used to evaluate the - Model. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics: - description: Metrics for general pairwise text generation evaluation results. + Models are deployed into it, and afterwards Endpoint is called to obtain + predictions and explanations. + id: GoogleCloudAiplatformV1Endpoint properties: - cohensKappa: + etag: + type: string description: >- - A measurement of agreement between the autorater and human raters - that takes the likelihood of random agreement into account. - type: number - format: float - humanPreferenceBaselineModelWinRate: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + enablePrivateServiceConnect: + type: boolean description: >- - Percentage of time humans decided the baseline model had the better - response. - format: float - type: number - baselineModelWinRate: + Deprecated: If true, expose the Endpoint via private service + connect. Only one of the fields, network or + enable_private_service_connect, can be set. + deprecated: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Percentage of time the autorater decided the baseline model had the - better response. - format: float - type: number - falsePositiveCount: - format: int64 + Customer-managed encryption key spec for an Endpoint. If set, this + Endpoint and all sub-resources of this Endpoint will be secured by + this key. + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + network: type: string description: >- - Number of examples where the autorater chose the model, but humans - preferred the baseline model. - humanPreferenceModelWinRate: - type: number - description: Percentage of time humans decided the model had the better response. - format: float - modelWinRate: - format: float + Optional. The full name of the Google Compute Engine + [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) + to which the Endpoint should be peered. Private services access must + already be configured for the network. If left unspecified, the + Endpoint is not peered with any network. Only one of the fields, + network or enable_private_service_connect, can be set. + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where `{project}` is + a project number, as in `12345`, and `{network}` is network name. + privateServiceConnectConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig description: >- - Percentage of time the autorater decided the model had the better - response. - type: number - accuracy: - format: float - type: number - description: Fraction of cases where the autorater agreed with the human raters. - trueNegativeCount: + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + displayName: type: string - format: int64 - description: >- - Number of examples where both the autorater and humans decided that - the model had the worse response. - f1Score: - format: float - description: Harmonic mean of precision and recall. - type: number - truePositiveCount: - format: int64 description: >- - Number of examples where both the autorater and humans decided that - the model had the better response. + Required. The display name of the Endpoint. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + dedicatedEndpointDns: type: string - precision: - type: number - format: float + readOnly: true description: >- - Fraction of cases where the autorater and humans thought the model - had a better response out of all cases where the autorater thought - the model had a better response. True positive divided by all - positive. - falseNegativeCount: + Output only. DNS of the dedicated endpoint. Will only be populated + if dedicated_endpoint_enabled is true. Format: + `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + updateTime: type: string - format: int64 - description: >- - Number of examples where the autorater chose the baseline model, but - humans preferred the model. - recall: - format: float - type: number + readOnly: true + format: google-datetime + description: Output only. Timestamp when this Endpoint was last updated. + description: + type: string + description: The description of the Endpoint. + dedicatedEndpointEnabled: description: >- - Fraction of cases where the autorater and humans thought the model - had a better response out of all cases where the humans thought the - model had a better response. - type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics - GoogleCloudAiplatformV1ResourceRuntimeSpec: - properties: - raySpec: + If true, the endpoint will be exposed through a dedicated DNS + [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + will be isolated from other users' traffic and will have better + performance and reliability. Note: Once you enabled dedicated + endpoint, you won't be able to send request to the shared DNS + {region}-aiplatform.googleapis.com. The limitation will be removed + soon. + type: boolean + createTime: + readOnly: true + description: Output only. Timestamp when this Endpoint was created. + format: google-datetime + type: string + modelDeploymentMonitoringJob: + readOnly: true description: >- - Optional. Ray cluster configuration. Required when creating a - dedicated RayCluster on the PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RaySpec' - serviceAccountSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ServiceAccountSpec' + Output only. Resource name of the Model Monitoring job associated + with this Endpoint if monitoring is enabled by + JobService.CreateModelDeploymentMonitoringJob. Format: + `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + type: string + name: + readOnly: true + type: string + description: Output only. The resource name of the Endpoint. + trafficSplit: + type: object + additionalProperties: + type: integer + format: int32 description: >- - Optional. Configure the use of workload identity on the - PersistentResource - type: object - id: GoogleCloudAiplatformV1ResourceRuntimeSpec - description: >- - Configuration for the runtime on a PersistentResource instance, - including but not limited to: * Service accounts used to run the - workloads. * Whether to make it a dedicated Ray Cluster. - GoogleCloudAiplatformV1ModelExplanation: - id: GoogleCloudAiplatformV1ModelExplanation - type: object - description: Aggregated explanation metrics for a Model over a set of instances. - properties: - meanAttributions: + A map from a DeployedModel's ID to the percentage of this Endpoint's + traffic that should be forwarded to that DeployedModel. If a + DeployedModel's ID is not listed in this map, then it receives no + traffic. The traffic percentage values must add up to 100, or map + must be empty if the Endpoint is to not accept any traffic at a + moment. + deployedModels: type: array - readOnly: true description: >- - Output only. Aggregated attributions explaining the Model's - prediction outputs over the set of instances. The attributions are - grouped by outputs. For Models that predict only one output, such as - regression Models that predict only one score, there is only one - attibution that explains the predicted output. For Models that - predict multiple outputs, such as multiclass Models that predict - multiple classes, each element explains one specific item. - Attribution.output_index can be used to identify which output this - attribution is explaining. The baselineOutputValue, - instanceOutputValue and featureAttributions fields are averaged over - the test data. NOTE: Currently AutoML tabular classification Models - produce only one attribution, which averages attributions over all - the classes it predicts. Attribution.approximation_error is not - populated. + Output only. The models deployed in this Endpoint. To add or remove + DeployedModels use EndpointService.DeployModel and + EndpointService.UndeployModel respectively. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation: - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation - properties: - columnName: - type: string - GoogleCloudAiplatformV1ModelOriginalModelInfo: - id: GoogleCloudAiplatformV1ModelOriginalModelInfo - description: Contains information about the original Model if this Model is a copy. - type: object - properties: - model: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' readOnly: true + predictRequestResponseLoggingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + description: Configures the request-response logging for online prediction. + labels: + type: object + additionalProperties: + type: string description: >- - Output only. The resource name of the Model this Model is a copy of, - including the revision. Format: - `projects/{project}/locations/{location}/models/{model_id}@{version_id}` - GoogleCloudAiplatformV1ProbeExecAction: - id: GoogleCloudAiplatformV1ProbeExecAction - description: ExecAction specifies a command to execute. + The labels with user-defined metadata to organize your Endpoints. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. type: object + GoogleCloudAiplatformV1SpecialistPool: + id: GoogleCloudAiplatformV1SpecialistPool properties: - command: + specialistManagerEmails: items: type: string + description: The email addresses of the managers in the SpecialistPool. type: array - description: >- - Command is the command line to execute inside the container, the - working directory for the command is root ('/') in the container's - filesystem. The command is simply exec'd, it is not run inside a - shell, so traditional shell instructions ('|', etc) won't work. To - use a shell, you need to explicitly call out to that shell. Exit - status of 0 is treated as live/healthy and non-zero is unhealthy. - GoogleCloudAiplatformV1GroundingChunkRetrievedContext: - id: GoogleCloudAiplatformV1GroundingChunkRetrievedContext - type: object - description: Chunk from context retrieved by the retrieval tools. - properties: - title: + displayName: type: string - description: Title of the attribution. - uri: + description: >- + Required. The user-defined name of the SpecialistPool. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. This field should be unique on project-level. + name: type: string - description: URI reference of the attribution. - GoogleCloudAiplatformV1GroundingMetadata: - description: Metadata returned to client when grounding is enabled. - type: object - properties: - searchEntryPoint: - description: Optional. Google search entry for the following-up web searches. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SearchEntryPoint' - webSearchQueries: - description: Optional. Web search queries for the following-up web search. + description: Required. The resource name of the SpecialistPool. + pendingDataLabelingJobs: + readOnly: true items: type: string + description: Output only. The resource name of the pending data labeling jobs. type: array - groundingChunks: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunk' - description: >- - List of supporting references retrieved from specified grounding - source. - groundingSupports: + specialistWorkerEmails: type: array - description: Optional. List of grounding support. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingSupport' - id: GoogleCloudAiplatformV1GroundingMetadata - GoogleCloudAiplatformV1AddExecutionEventsRequest: - description: Request message for MetadataService.AddExecutionEvents. - properties: - events: + description: The email addresses of workers in the SpecialistPool. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' - type: array - description: The Events to create and add. + type: string + specialistManagersCount: + readOnly: true + description: Output only. The number of managers in this SpecialistPool. + type: integer + format: int32 + description: >- + SpecialistPool represents customers' own workforce to work on their data + labeling jobs. It includes a group of specialist managers and workers. + Managers are responsible for managing the workers in this pool as well + as customers' data labeling jobs associated with this pool. Customers + create specialist pool as well as start data labeling jobs on Cloud, + managers and workers handle the jobs using CrowdCompute console. type: object - id: GoogleCloudAiplatformV1AddExecutionEventsRequest - GoogleCloudAiplatformV1AvroSource: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity: type: object - id: GoogleCloudAiplatformV1AvroSource properties: - gcsSource: - description: Required. Google Cloud Storage location. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: The storage details for Avro input content. - GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks: + unit: + description: >- + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" + type: string + quantity: + type: string + description: >- + The number of granularity_units between data points in the training + data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. + For all other values of `granularity_unit`, must be 1. + format: int64 + description: A duration of time expressed in time granularity units. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity: + description: >- + Message to select entity. If an entity id is selected, all the feature + values corresponding to the entity id will be deleted, including the + entityId. + id: GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + type: object properties: - notebooks: - description: Required. Regional resource references to notebooks. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - type: array - id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks - description: Open notebooks. + entityIdSelector: + description: >- + Required. Selectors choosing feature values of which entity id to be + deleted from the EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityIdSelector' + GoogleCloudAiplatformV1SearchNearestEntitiesRequest: + properties: + returnFullEntity: + description: >- + Optional. If set to true, the full entities (including all vector + values and metadata) of the nearest neighbors are returned; + otherwise only entity id of the nearest neighbors will be returned. + Note that returning full entities will significantly increase the + latency and cost of the query. + type: boolean + query: + description: Required. The query. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighborQuery' type: object - GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata: + id: GoogleCloudAiplatformV1SearchNearestEntitiesRequest + description: The request message for FeatureOnlineStoreService.SearchNearestEntities. + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig: properties: - sentimentMax: - description: The maximum sentiment of sentiment Anntoation in this SavedQuery. + value: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue + description: >- + A unique specific value for a given feature. Example: `{ "value": { + "string_value": "12345" } }` + allValues: + description: >- + If all_values is set to true, then all possible labels of the keyed + feature will have another slice computed. Example: + `{"all_values":{"value":true}}` + type: boolean + range: + description: >- + A range of values for a numerical feature. Example: + `{"range":{"low":10000.0,"high":50000.0}}` will capture 12345 and + 23334 in the slice. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + type: object + description: >- + Specification message containing the config for this SliceSpec. When + `kind` is selected as `value` and/or `range`, only a single slice will + be computed. When `all_values` is present, a separate slice will be + computed for each possible label/value for the corresponding key in + `config`. Examples, with feature zip_code with values 12345, 23334, + 88888 and feature country with values "US", "Canada", "Mexico" in the + dataset: Example 1: { "zip_code": { "value": { "float_value": 12345.0 } + } } A single slice for any data with zip_code 12345 in the dataset. + Example 2: { "zip_code": { "range": { "low": 12345, "high": 20000 } } } + A single slice containing data where the zip_codes between 12345 and + 20000 For this example, data with the zip_code of 12345 will be in this + slice. Example 3: { "zip_code": { "range": { "low": 10000, "high": 20000 + } }, "country": { "value": { "string_value": "US" } } } A single slice + containing data where the zip_codes between 10000 and 20000 has the + country "US". For this example, data with the zip_code of 12345 and + country "US" will be in this slice. Example 4: { "country": + {"all_values": { "value": true } } } Three slices are computed, one for + each unique country in the dataset. Example 5: { "country": { + "all_values": { "value": true } }, "zip_code": { "value": { + "float_value": 12345.0 } } } Three slices are computed, one for each + unique country in the dataset where the zip_code is also 12345. For this + example, data with zip_code 12345 and country "US" will be in one slice, + zip_code 12345 and country "Canada" in another slice, and zip_code 12345 + and country "Mexico" in another slice, totaling 3 slices. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + GoogleCloudAiplatformV1FindNeighborsRequestQuery: + description: >- + A query to find a number of the nearest neighbors (most similar vectors) + of a vector. + properties: + datapoint: + description: >- + Required. The datapoint/vector whose nearest neighbors should be + searched for. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + perCrowdingAttributeNeighborCount: + format: int32 + description: >- + Crowding is a constraint on a neighbor list produced by nearest + neighbor search requiring that no more than some value k' of the k + neighbors returned have the same value of crowding_attribute. It's + used for improving result diversity. This field is the maximum + number of matches with the same crowding tag. + type: integer + fractionLeafNodesToSearchOverride: + description: >- + The fraction of the number of leaves to search, set at query time + allows user to tune search performance. This value increase result + in both search accuracy and latency increase. The value should be + between 0.0 and 1.0. If not set or set to 0.0, query uses the + default value specified in + NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search. + format: double + type: number + approximateNeighborCount: + type: integer + description: >- + The number of neighbors to find via approximate search before exact + reordering is performed. If not set, the default value from scam + config is used; if set, this value must be > 0. + format: int32 + neighborCount: + description: >- + The number of nearest neighbors to be retrieved from database for + each query. If not set, will use the default from the service + configuration + (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config). type: integer format: int32 + rrf: + description: Optional. Represents RRF algorithm that combines search results. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF type: object - description: The metadata of SavedQuery contains TextSentiment Annotations. - id: GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata - GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: - id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata - description: Details of operations that perform create FeatureGroup. + id: GoogleCloudAiplatformV1FindNeighborsRequestQuery + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition: + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition + description: Represents the spec to match integer values from parent parameter. + properties: + values: + description: >- + Required. Matches values of the parent parameter of 'INTEGER' type. + All values must lie in `integer_value_spec` of parent parameter. + type: array + items: + format: int64 + type: string type: object + GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata: + id: GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata properties: genericMetadata: + description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig: - properties: - value: - type: number - description: >- - Specify a threshold value that can trigger the alert. 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. Each feature - must have a non-zero threshold if they need to be monitored. - Otherwise no alert will be triggered for that feature. - format: double - description: The config for Featurestore Monitoring threshold. + description: >- + Runtime operation information for + IndexEndpointService.CreateIndexEndpoint. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs: type: object - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig - GoogleCloudAiplatformV1IndexDatapoint: - id: GoogleCloudAiplatformV1IndexDatapoint properties: - crowdingTag: + optimizationObjectiveRecallValue: + format: float + description: >- + Required when optimization_objective is + "maximize-precision-at-recall". Must be between 0 and 1, inclusive. + type: number + exportEvaluatedDataItemsConfig: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig description: >- - Optional. CrowdingTag of the datapoint, the number of neighbors to - return in each crowding can be configured during query. - featureVector: - type: array + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + disableEarlyStopping: + type: boolean description: >- - Required. Feature embedding vector for dense index. An array of - numbers with the length of [NearestNeighborSearchConfig.dimensions]. - items: - type: number - format: float - sparseEmbedding: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding - description: Optional. Feature embedding vector for sparse index. - restricts: + Use the entire training budget. This disables the early stopping + feature. By default, the early stopping feature is enabled, which + means that AutoML Tables might stop training before the entire + training budget has been used. + targetColumn: + description: The column name of the target column that the model is to predict. + type: string + additionalExperiments: + type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction + type: string + description: Additional experiment flags for the Tables training pipeline. + trainBudgetMilliNodeHours: + format: int64 + type: string description: >- - Optional. List of Restrict of the datapoint, used to perform - "restricted searches" where boolean rule are used to filter the - subset of the database eligible for matching. This uses categorical - tokens. See: - https://cloud.google.com/vertex-ai/docs/matching-engine/filtering - type: array - numericRestricts: - type: array + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. + transformations: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation description: >- - Optional. List of Restrict of the datapoint, used to perform - "restricted searches" where boolean rule are used to filter the - subset of the database eligible for matching. This uses numeric - comparisons. - datapointId: - description: Required. Unique identifier of the datapoint. - type: string - description: A datapoint of Index. - type: object - GoogleCloudAiplatformV1ListNasTrialDetailsResponse: - id: GoogleCloudAiplatformV1ListNasTrialDetailsResponse - type: object - description: Response message for JobService.ListNasTrialDetails - properties: - nasTrialDetails: + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' - description: List of top NasTrials in the requested page. - nextPageToken: + predictionType: description: >- - A token to retrieve the next page of results. Pass to - ListNasTrialDetailsRequest.page_token to obtain that page. + The type of prediction the Model is to produce. "classification" - + Predict one out of multiple target values is picked for each row. + "regression" - Predict a value based on its relation to other + values. This type is available only to columns that contain + semantically numeric values, i.e. integers or floating point number, + even if stored as e.g. strings. type: string - GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance: - description: Spec for pairwise summarization quality instance. - properties: - prediction: - description: Required. Output of the candidate model. + weightColumnName: + description: >- + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. type: string - instruction: + optimizationObjectivePrecisionValue: + type: number + format: float + description: >- + Required when optimization_objective is + "maximize-recall-at-precision". Must be between 0 and 1, inclusive. + optimizationObjective: type: string - description: Required. Summarization prompt for LLM. - context: - description: Required. Text to be summarized. - type: string - baselinePrediction: - type: string - description: Required. Output of the baseline model. - reference: - type: string - description: Optional. Ground truth used to compare against the prediction. - id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance - type: object - GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance: - type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance - description: Prediction input format for Image Segmentation. + description: >- + Objective function the model is optimizing towards. The training + process creates a model that maximizes/minimizes the value of the + objective function over the validation set. The supported + optimization objectives depend on the prediction type. If the field + is not set, a default objective function is used. classification + (binary): "maximize-au-roc" (default) - Maximize the area under the + receiver operating characteristic (ROC) curve. "minimize-log-loss" - + Minimize log loss. "maximize-au-prc" - Maximize the area under the + precision-recall curve. "maximize-precision-at-recall" - Maximize + precision for a specified recall value. + "maximize-recall-at-precision" - Maximize recall for a specified + precision value. classification (multi-class): "minimize-log-loss" + (default) - Minimize log loss. regression: "minimize-rmse" (default) + - Minimize root-mean-squared error (RMSE). "minimize-mae" - Minimize + mean-absolute error (MAE). "minimize-rmsle" - Minimize + root-mean-squared log error (RMSLE). + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs + GoogleCloudAiplatformV1PredictResponse: + id: GoogleCloudAiplatformV1PredictResponse properties: - mimeType: - type: string + model: description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/png - content: - description: The image bytes to make the predictions on. + Output only. The resource name of the Model which is deployed as the + DeployedModel that this prediction hits. type: string - GoogleCloudAiplatformV1FeatureViewSyncSyncSummary: - id: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary - properties: - rowSynced: + readOnly: true + modelVersionId: readOnly: true type: string - format: int64 - description: Output only. Total number of rows synced. - systemWatermarkTime: description: >- - Lower bound of the system time watermark for the sync job. This is - only set for continuously syncing feature views. - format: google-datetime - type: string - totalSlot: - type: string - format: int64 - description: Output only. BigQuery slot milliseconds consumed for the sync job. + Output only. The version ID of the Model which is deployed as the + DeployedModel that this prediction hits. + metadata: + description: >- + Output only. Request-level metadata returned by the model. The + metadata type will be dependent upon the model implementation. + type: any readOnly: true - type: object - description: >- - Summary from the Sync job. For continuous syncs, the summary is updated - periodically. For batch syncs, it gets updated on completion of the - sync. - GoogleCloudAiplatformV1ModelMonitoringAlertConfig: - description: The alert config for model monitoring. - properties: - enableLogging: - type: boolean + modelDisplayName: description: >- - Dump the anomalies to Cloud Logging. The anomalies will be put to - json payload encoded from proto - google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. - This can be further sinked to Pub/Sub or any other services - supported by Cloud Logging. - emailAlertConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig - description: Email alert config. - notificationChannels: + Output only. The display name of the Model which is deployed as the + DeployedModel that this prediction hits. + readOnly: true + type: string + predictions: + type: array items: - type: string + type: any description: >- - Resource names of the NotificationChannels to send alert. Must be of - the format `projects//notificationChannels/` - type: array - id: GoogleCloudAiplatformV1ModelMonitoringAlertConfig - type: object - GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput: - type: object - id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput - properties: - metricSpec: - description: Required. Spec for pairwise question answering quality score metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec - instance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance - description: Required. Pairwise question answering quality instance. - description: Input for pairwise question answering quality metric. - GoogleCloudAiplatformV1GenerationConfigRoutingConfig: - id: GoogleCloudAiplatformV1GenerationConfigRoutingConfig - type: object - properties: - manualMode: - description: Manual routing. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode - autoMode: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode - description: Automated routing. - description: The configuration for routing the request to a specific model. - GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: - type: object - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata - description: Runtime operation information for CreateDeploymentResourcePool method. - GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors: - properties: - id: + The predictions that are the output of the predictions call. The + schema of any single prediction may be specified via Endpoint's + DeployedModels' Model's PredictSchemata's prediction_schema_uri. + deployedModelId: type: string - description: The ID of the query datapoint. - neighbors: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNeighbor - type: array - description: All its neighbors. - id: GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors + description: ID of the Endpoint's DeployedModel that served this prediction. + description: Response message for PredictionService.Predict. type: object - description: Nearest neighbors for one query. - GoogleCloudLocationLocation: - description: A resource that represents a Google Cloud location. + GoogleCloudAiplatformV1PublisherModelCallToActionDeploy: + description: >- + Model metadata that is needed for UploadModel or + DeployModel/CreateEndpoint requests. + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy properties: - labels: - additionalProperties: - type: string + largeModelReference: + $ref: '#/components/schemas/GoogleCloudAiplatformV1LargeModelReference' description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - name: + Optional. Large model reference. When this is set, + model_artifact_spec is not needed. + title: type: string + description: Required. The title of the regional resource reference. + artifactUri: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' + Optional. The path to the directory containing the Model artifact + and any of its supporting files. + type: string + modelDisplayName: + description: Optional. Default model display name. + type: string + sharedResources: type: string - metadata: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - displayName: + The resource name of the shared DeploymentResourcePool to deploy on. + Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + automaticResources: + description: >- + A description of resources that to large degree are decided by + Vertex AI, and require only a modest additional configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + dedicatedResources: + description: >- + A description of resources that are dedicated to the DeployedModel, + and that need a higher degree of manual configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + containerSpec: + description: >- + Optional. The specification of the container that is to be used when + deploying this Model in Vertex AI. Not present for Large Models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' + deployTaskName: type: string description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: object - id: GoogleCloudLocationLocation - GoogleCloudAiplatformV1RemoveDatapointsResponse: - properties: {} + Optional. The name of the deploy task (e.g., "text to image + generation"). + publicArtifactUri: + description: >- + Optional. The signed URI for ephemeral Cloud Storage access to model + artifact. + type: string + deployMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata + description: Optional. Metadata information about this deployment config. type: object - description: Response message for IndexService.RemoveDatapoints - id: GoogleCloudAiplatformV1RemoveDatapointsResponse - GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse: - id: GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats: type: object - description: Response message for JobService.ListHyperparameterTuningJobs properties: - hyperparameterTuningJobs: - type: array + validRecordCount: + type: string + description: Number of records in this file that were successfully processed. + format: int64 + validSparseRecordCount: + format: int64 + type: string description: >- - List of HyperparameterTuningJobs in the requested page. - HyperparameterTuningJob.trials of the jobs will be not be returned. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob - nextPageToken: + Number of sparse records in this file that were successfully + processed. + sourceGcsUri: + type: string + description: Cloud Storage URI pointing to the original file in user's bucket. + invalidSparseRecordCount: description: >- - A token to retrieve the next page of results. Pass to - ListHyperparameterTuningJobsRequest.page_token to obtain that page. + Number of sparse records in this file we skipped due to validate + errors. type: string - GoogleCloudAiplatformV1ListModelsResponse: - description: Response message for ModelService.ListModels - type: object - properties: - models: - type: array + format: int64 + partialErrors: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - description: List of Models in the requested page. - nextPageToken: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError description: >- - A token to retrieve next page of results. Pass to - ListModelsRequest.page_token to obtain that page. + The detail information of the partial failures encountered for those + invalid records that couldn't be parsed. Up to 50 partial errors + will be reported. + type: array + invalidRecordCount: + format: int64 type: string - id: GoogleCloudAiplatformV1ListModelsResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation: - type: object + description: Number of records in this file we skipped due to validate errors. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation - properties: - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation - GoogleCloudAiplatformV1TFRecordDestination: - id: GoogleCloudAiplatformV1TFRecordDestination - description: The storage details for TFRecord output content. - properties: - gcsDestination: - description: Required. Google Cloud Storage location. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - type: object - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource: + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats + GoogleCloudAiplatformV1SchemaImageDatasetMetadata: properties: - uri: - description: The URI of a BigQuery table. + dataItemSchemaUri: type: string - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource - type: object - GoogleCloudAiplatformV1SampleConfig: - description: >- - Active learning data sampling config. For every active learning labeling - iteration, it will select a batch of data based on the sampling - strategy. - id: GoogleCloudAiplatformV1SampleConfig - type: object - properties: - followingBatchSamplePercentage: description: >- - The percentage of data needed to be labeled in each following batch - (except the first batch). - format: int32 - type: integer - initialBatchSamplePercentage: - description: The percentage of data needed to be labeled in the first batch. - format: int32 - type: integer - sampleStrategy: + Points to a YAML file stored on Google Cloud Storage describing + payload of the Image DataItems that belong to this Dataset. + gcsBucket: type: string description: >- - Field to choose sampling strategy. Sampling strategy will decide - which data should be selected for human labeling in every batch. - enum: - - SAMPLE_STRATEGY_UNSPECIFIED - - UNCERTAINTY - enumDescriptions: - - Default will be treated as UNCERTAINTY. - - Sample the most uncertain data to label. - GoogleCloudAiplatformV1PurgeContextsMetadata: - description: Details of operations that perform MetadataService.PurgeContexts. + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for purging Contexts. - id: GoogleCloudAiplatformV1PurgeContextsMetadata - GoogleIamV1SetIamPolicyRequest: + id: GoogleCloudAiplatformV1SchemaImageDatasetMetadata + description: The metadata of Datasets that contain Image DataItems. + GoogleCloudAiplatformV1ModelSourceInfo: + id: GoogleCloudAiplatformV1ModelSourceInfo + description: Detail description of the source information of the model. type: object - description: Request message for `SetIamPolicy` method. properties: - policy: + sourceType: + description: Type of the model source. + enum: + - MODEL_SOURCE_TYPE_UNSPECIFIED + - AUTOML + - CUSTOM + - BQML + - MODEL_GARDEN + - GENIE + - CUSTOM_TEXT_EMBEDDING + - MARKETPLACE + type: string + enumDescriptions: + - Should not be used. + - The Model is uploaded by automl training pipeline. + - The Model is uploaded by user or custom training pipeline. + - The Model is registered and sync'ed from BigQuery ML. + - The Model is saved or tuned from Model Garden. + - The Model is saved or tuned from Genie. + - The Model is uploaded by text embedding finetuning pipeline. + - The Model is saved or tuned from Marketplace. + copy: description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/GoogleIamV1Policy' - id: GoogleIamV1SetIamPolicyRequest - GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: - type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureView Update. - id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata - description: Details of operations that perform update FeatureView. - GoogleLongrunningListOperationsResponse: + If this Model is copy of another Model. If true then source_type + pertains to the original. + type: boolean + GoogleCloudAiplatformV1QueryDeployedModelsResponse: properties: + totalDeployedModelCount: + description: The total number of DeployedModels on this DeploymentResourcePool. + type: integer + format: int32 + totalEndpointCount: + description: >- + The total number of Endpoints that have DeployedModels on this + DeploymentResourcePool. + format: int32 + type: integer nextPageToken: type: string - description: The standard List next-page token. - operations: + 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. + deployedModels: + description: DEPRECATED Use deployed_model_refs instead. + type: array items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + deprecated: true + deployedModelRefs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' type: array description: >- - A list of operations that matches the specified filter in the - request. - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - type: object - GoogleCloudAiplatformV1SummarizationVerbositySpec: - description: Spec for summarization verbosity score metric. + References to the DeployedModels that share the specified + deploymentResourcePool. + id: GoogleCloudAiplatformV1QueryDeployedModelsResponse type: object - id: GoogleCloudAiplatformV1SummarizationVerbositySpec - properties: - useReference: - description: >- - Optional. Whether to use instance.reference to compute summarization - verbosity. - type: boolean - version: - format: int32 - description: Optional. Which version to use for evaluation. - type: integer - GoogleCloudAiplatformV1ModelEvaluationSliceSlice: + description: Response message for QueryDeployedModels method. + GoogleCloudAiplatformV1NotebookRuntime: properties: - dimension: - description: >- - Output only. The dimension of the slice. Well-known dimensions are: - * `annotationSpec`: This slice is on the test data that has either - ground truth or prediction with AnnotationSpec.display_name equals - to value. * `slice`: This slice is a user customized slice defined - by its SliceSpec. - readOnly: true - type: string - value: + runtimeUser: type: string - description: Output only. The value of the dimension in this slice. + description: Required. The user email of the NotebookRuntime. + createTime: readOnly: true - sliceSpec: - description: Output only. Specification for how the data was sliced. + type: string + format: google-datetime + description: Output only. Timestamp when this NotebookRuntime was created. + notebookRuntimeTemplateRef: + description: >- + Output only. The pointer to NotebookRuntimeTemplate this + NotebookRuntime is created from. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplateRef readOnly: true + idleShutdownConfig: + description: >- + Output only. The idle shutdown configuration of the notebook + runtime. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec - description: Definition of a slice. - type: object - id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice - GoogleCloudAiplatformV1MigratableResourceAutomlModel: - description: Represents one Model in automl.googleapis.com. - properties: - model: + #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + readOnly: true + description: type: string + description: The description of the NotebookRuntime. + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + displayName: description: >- - Full resource name of automl Model. Format: - `projects/{project}/locations/{location}/models/{model}`. - modelDisplayName: - description: The Model's display name in automl.googleapis.com. + Required. The display name of the NotebookRuntime. The name can be + up to 128 characters long and can consist of any UTF-8 characters. type: string - type: object - id: GoogleCloudAiplatformV1MigratableResourceAutomlModel - GoogleCloudAiplatformV1SearchNearestEntitiesResponse: - type: object - id: GoogleCloudAiplatformV1SearchNearestEntitiesResponse - description: Response message for FeatureOnlineStoreService.SearchNearestEntities - properties: - nearestNeighbors: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighbors' - description: The nearest neighbors of the query entity. - GoogleCloudAiplatformV1CopyModelOperationMetadata: - type: object - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CopyModelOperationMetadata - description: Details of ModelService.CopyModel operation. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs: - type: object - properties: - modelType: + notebookRuntimeType: + type: string + description: Output only. The type of the notebook runtime. enumDescriptions: - - Should not be set. - - >- - A model to be used via prediction calls to uCAIP API. Expected to - have a higher latency, but should also have a higher prediction - quality than other models. - - >- - A model to be used via prediction calls to uCAIP API. Expected to - have a lower latency but relatively lower prediction quality. - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - model and used on a mobile or edge device afterwards. Expected to - have low latency, but may have lower prediction quality than other - mobile models. + Unspecified notebook runtime type, NotebookRuntimeType will + default to USER_DEFINED. + - runtime or template with coustomized configurations from user. + - runtime or template with system defined configurations. + readOnly: true enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD_HIGH_ACCURACY_1 - - CLOUD_LOW_ACCURACY_1 - - MOBILE_TF_LOW_LATENCY_1 - type: string - budgetMilliNodeHours: - format: int64 + - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED + - USER_DEFINED + - ONE_CLICK + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + version: + readOnly: true type: string + description: Output only. The VM os image version of NotebookRuntime. + labels: + type: object + additionalProperties: + type: string description: >- - The training budget of creating this model, expressed in milli node - hours i.e. 1,000 value in this field means 1 node hour. The actual - metadata.costMilliNodeHours will be equal or less than this value. - If further model training ceases to provide any improvements, it - will stop without using the full budget and the - metadata.successfulStopReason will be `model-converged`. Note, - node_hour = actual_hour * number_of_nodes_involved. Or - actual_wall_clock_hours = train_budget_milli_node_hours / - (number_of_nodes_involved * 1000) For modelType - `cloud-high-accuracy-1`(default), the budget must be between 20,000 - and 2,000,000 milli node hours, inclusive. The default value is - 192,000 which represents one day in wall time (1000 milli * 24 hours - * 8 nodes). - baseModelId: - type: string + The labels with user-defined metadata to organize your + NotebookRuntime. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. No more than 64 user labels can be associated with one + NotebookRuntime (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for NotebookRuntime: * + "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output + only, its value is the Compute Engine instance id. * + "aiplatform.googleapis.com/colab_enterprise_entry_service": its + value is either "bigquery" or "vertex"; if absent, it should be + "vertex". This is to describe the entry service, either BigQuery or + Vertex. + encryptionSpec: + readOnly: true description: >- - The ID of the `base` model. If it is specified, the new model will - be trained based on the `base` model. Otherwise, the new model will - be trained from scratch. The `base` model must be in the same - Project and Location as the new Model to train, and have the same - modelType. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs - GoogleCloudAiplatformV1PointwiseMetricInput: - description: Input for pointwise metric. - id: GoogleCloudAiplatformV1PointwiseMetricInput - type: object - properties: - instance: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInstance' - description: Required. Pointwise metric instance. - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricSpec' - description: Required. Spec for pointwise metric. - GoogleCloudAiplatformV1SummarizationVerbosityInstance: - id: GoogleCloudAiplatformV1SummarizationVerbosityInstance - description: Spec for summarization verbosity instance. - type: object - properties: - context: - description: Required. Text to be summarized. - type: string - reference: - description: Optional. Ground truth used to compare against the prediction. - type: string - prediction: + Output only. Customer-managed encryption key spec for the notebook + runtime. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + healthState: + enum: + - HEALTH_STATE_UNSPECIFIED + - HEALTHY + - UNHEALTHY type: string - description: Required. Output of the evaluated model. - instruction: + readOnly: true + enumDescriptions: + - Unspecified health state. + - NotebookRuntime is in healthy state. Applies to ACTIVE state. + - NotebookRuntime is in unhealthy state. Applies to ACTIVE state. + description: Output only. The health state of the NotebookRuntime. + serviceAccount: + description: >- + Output only. The service account that the NotebookRuntime workload + runs as. + readOnly: true type: string - description: Optional. Summarization prompt for LLM. - GoogleCloudAiplatformV1CitationMetadata: - id: GoogleCloudAiplatformV1CitationMetadata - description: A collection of source attributions for a piece of content. - properties: - citations: + runtimeState: + description: Output only. The runtime (instance) state of the NotebookRuntime. readOnly: true + enum: + - RUNTIME_STATE_UNSPECIFIED + - RUNNING + - BEING_STARTED + - BEING_STOPPED + - STOPPED + - BEING_UPGRADED + - ERROR + - INVALID + type: string + enumDescriptions: + - Unspecified runtime state. + - NotebookRuntime is in running state. + - NotebookRuntime is in starting state. + - NotebookRuntime is in stopping state. + - NotebookRuntime is in stopped state. + - >- + NotebookRuntime is in upgrading state. It is in the middle of + upgrading process. + - NotebookRuntime was unable to start/stop properly. + - NotebookRuntime is in invalid state. Cannot be recovered. + networkTags: + description: >- + Optional. The Compute Engine tags to add to runtime (see [Tagging + instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Citation' + type: string type: array - description: Output only. List of citations. - type: object - GoogleCloudAiplatformV1UndeployModelOperationMetadata: - type: object - description: Runtime operation information for EndpointService.UndeployModel. - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1UndeployModelOperationMetadata - GoogleCloudAiplatformV1SchemaTextExtractionAnnotation: - description: Annotation details specific to text extraction. - properties: - annotationSpecId: + isUpgradable: + readOnly: true + description: Output only. Whether NotebookRuntime is upgradable. + type: boolean + expirationTime: + readOnly: true + format: google-datetime description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. + Output only. Timestamp when this NotebookRuntime will be expired: 1. + System Predefined NotebookRuntime: 24 hours after creation. After + expiration, system predifined runtime will be deleted. 2. User + created NotebookRuntime: 6 months after last upgrade. After + expiration, user created runtime will be stopped and allowed for + upgrade. type: string - displayName: + name: + readOnly: true type: string - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - textSegment: - description: The segment of the text content. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTextSegment' - id: GoogleCloudAiplatformV1SchemaTextExtractionAnnotation - type: object - GoogleCloudAiplatformV1GroundingChunkWeb: - properties: - title: + description: Output only. The resource name of the NotebookRuntime. + updateTime: + readOnly: true + format: google-datetime type: string - description: Title of the chunk. - uri: - description: URI reference of the chunk. + description: >- + Output only. Timestamp when this NotebookRuntime was most recently + updated. + proxyUri: + description: Output only. The proxy endpoint used to access the NotebookRuntime. + readOnly: true type: string type: object - description: Chunk from the web. - id: GoogleCloudAiplatformV1GroundingChunkWeb - GoogleIamV1Policy: - type: object + description: >- + A runtime is a virtual machine allocated to a particular user for a + particular Notebook file on temporary basis with lifetime limited to 24 + hours. + id: GoogleCloudAiplatformV1NotebookRuntime + GoogleCloudAiplatformV1BatchDedicatedResources: properties: - etag: - type: string - format: byte - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - bindings: - type: array - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - version: + startingReplicaCount: + type: integer format: int32 description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + 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 + maxReplicaCount: + format: int32 type: integer + description: >- + Immutable. The maximum number of machine replicas the batch + operation may be scaled to. The default value is 10. + machineSpec: + description: Required. Immutable. The specification of a single machine. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - id: GoogleIamV1Policy - CloudAiLargeModelsVisionNamedBoundingBox: - id: CloudAiLargeModelsVisionNamedBoundingBox + A description of resources that are used for performing batch + operations, are dedicated to a Model, and need manual configuration. type: object + id: GoogleCloudAiplatformV1BatchDedicatedResources + GoogleCloudAiplatformV1ExplainRequest: + id: GoogleCloudAiplatformV1ExplainRequest + type: object + description: Request message for PredictionService.Explain. properties: - y1: - type: number - format: float - classes: - type: array - items: - type: string - entities: - items: - type: string - type: array - y2: - type: number - format: float - x2: - type: number - format: float - x1: - format: float - type: number - scores: + parameters: + description: >- + The parameters that govern the prediction. The schema of the + parameters may be specified via Endpoint's DeployedModels' Model's + PredictSchemata's parameters_schema_uri. + type: any + instances: type: array - items: - format: float - type: number - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata: - description: The metadata of Datasets that contain time series data. - properties: - inputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig - timeColumn: description: >- - The column name of the time column that identifies time order in the - time series. - type: string - timeSeriesIdentifierColumn: + Required. The instances that are the input to the explanation call. + A DeployedModel may have an upper limit on the number of instances + it supports per request, and when it is exceeded the explanation + call errors in case of AutoML Models, or, in case of customer + created Models, the behaviour is as documented by that Model. The + schema of any single instance may be specified via Endpoint's + DeployedModels' Model's PredictSchemata's instance_schema_uri. + items: + type: any + deployedModelId: type: string description: >- - The column name of the time series identifier column that identifies - the time series. - type: object - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata - GoogleCloudAiplatformV1ReservationAffinity: - type: object - description: >- - A ReservationAffinity can be used to configure a Vertex AI resource - (e.g., a DeployedModel) to draw its Compute Engine resources from a - Shared Reservation, or exclusively from on-demand capacity. - id: GoogleCloudAiplatformV1ReservationAffinity - properties: - reservationAffinityType: - enum: - - TYPE_UNSPECIFIED - - NO_RESERVATION - - ANY_RESERVATION - - SPECIFIC_RESERVATION - enumDescriptions: - - Default value. This should not be used. - - Do not consume from any reserved capacity, only use on-demand. - - Consume any reservation available, falling back to on-demand. - - >- - Consume from a specific reservation. When chosen, the reservation - must be identified via the `key` and `values` fields. - description: Required. Specifies the reservation affinity type. - type: string - key: + If specified, this ExplainRequest will be served by the chosen + DeployedModel, overriding Endpoint.traffic_split. + explanationSpecOverride: description: >- - Optional. Corresponds to the label key of a reservation resource. To - target a SPECIFIC_RESERVATION by name, use - `compute.googleapis.com/reservation-name` as the key and specify the - name of your reservation as its value. - type: string + If specified, overrides the explanation_spec of the DeployedModel. + Can be used for explaining prediction results with different + configurations, such as: - Explaining top-5 predictions results as + opposed to top-1; - Increasing path count or step count of the + attribution methods to reduce approximate errors; - Using different + baselines for explaining the prediction results. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpecOverride' + GoogleCloudAiplatformV1FeatureValueList: + properties: values: - description: >- - Optional. Corresponds to the label values of a reservation resource. - This must be the full resource name of the reservation. - type: array items: - type: string - GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest: - description: Request message for TensorboardService.BatchCreateTensorboardRuns. - properties: - requests: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + description: A list of feature values. All of them should be the same data type. type: array - description: >- - Required. The request message specifying the TensorboardRuns to - create. A maximum of 1000 TensorboardRuns can be created in a batch. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardRunRequest - id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig: - type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - description: >- - Configuration that defines the hierarchical relationship of time series - and parameters for hierarchical forecasting strategies. + description: Container for list of values. + id: GoogleCloudAiplatformV1FeatureValueList + GoogleCloudAiplatformV1ExportFractionSplit: properties: - groupTemporalTotalWeight: + testFraction: type: number description: >- - The weight of the loss for predictions aggregated over both the - horizon and time series in the same hierarchy group. + The fraction of the input data that is to be used to evaluate the + Model. format: double - groupColumns: - description: >- - A list of time series attribute column names that define the time - series hierarchy. Only one level of hierarchy is supported, ex. - 'region' for a hierarchy of stores or 'department' for a hierarchy - of products. If multiple columns are specified, time series will be - grouped by their combined values, ex. ('blue', 'large') for 'color' - and 'size', up to 5 columns are accepted. If no group columns are - specified, all time series are considered to be part of the same - group. - type: array - items: - type: string - temporalTotalWeight: - description: >- - The weight of the loss for predictions aggregated over the horizon - for a single time series. + trainingFraction: type: number format: double - groupTotalWeight: - format: double description: >- - The weight of the loss for predictions aggregated over time series - in the same group. + The fraction of the input data that is to be used to train the + Model. + validationFraction: type: number - GoogleCloudAiplatformV1StopTrialRequest: - properties: {} - description: Request message for VizierService.StopTrial. - id: GoogleCloudAiplatformV1StopTrialRequest + format: double + description: >- + The fraction of the input data that is to be used to validate the + Model. type: object - GoogleCloudAiplatformV1StudySpecStudyStoppingConfig: + id: GoogleCloudAiplatformV1ExportFractionSplit description: >- - The configuration (stopping conditions) for automated stopping of a - Study. Conditions include trial budgets, time budgets, and convergence - detection. - id: GoogleCloudAiplatformV1StudySpecStudyStoppingConfig + Assigns the input data to training, validation, and test sets as per the + given fractions. Any of `training_fraction`, `validation_fraction` and + `test_fraction` may optionally be provided, they must sum to up to 1. If + the provided ones sum to less than 1, the remainder is assigned to sets + as decided by Vertex AI. If none of the fractions are set, by default + roughly 80% of data is used for training, 10% for validation, and 10% + for test. + GoogleCloudAiplatformV1ResourceRuntimeSpec: + description: >- + Configuration for the runtime on a PersistentResource instance, + including but not limited to: * Service accounts used to run the + workloads. * Whether to make it a dedicated Ray Cluster. + id: GoogleCloudAiplatformV1ResourceRuntimeSpec + type: object properties: - maxNumTrialsNoProgress: + raySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RaySpec' description: >- - If the objective value has not improved for this many consecutive - trials, stop the study. WARNING: Effective only for single-objective - studies. - type: integer - format: int32 - maxNumTrials: - description: If there are more than this many trials, stop the study. - format: int32 - type: integer - maxDurationNoProgress: - type: string + Optional. Ray cluster configuration. Required when creating a + dedicated RayCluster on the PersistentResource. + serviceAccountSpec: description: >- - If the objective value has not improved for this much time, stop the - study. WARNING: Effective only for single-objective studies. - format: google-duration - maximumRuntimeConstraint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' - description: If the specified time or duration has passed, stop the study. - shouldStopAsap: + Optional. Configure the use of workload identity on the + PersistentResource + $ref: '#/components/schemas/GoogleCloudAiplatformV1ServiceAccountSpec' + GoogleCloudAiplatformV1DedicatedResources: + type: object + id: GoogleCloudAiplatformV1DedicatedResources + properties: + machineSpec: description: >- - If true, a Study enters STOPPING_ASAP whenever it would normally - enters STOPPING state. The bottom line is: set to true if you want - to interrupt on-going evaluations of Trials as soon as the study - stopping condition is met. (Please see Study.State documentation for - the source of truth). - type: boolean - minNumTrials: + Required. Immutable. The specification of a single machine used by + the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + autoscalingMetricSpecs: + type: array + description: >- + Immutable. The metric specifications that overrides a resource + utilization metric (CPU utilization, accelerator's duty cycle, and + so on) target value (default to 60 if not set). At most one entry is + allowed per metric. If machine_spec.accelerator_count is above 0, + the autoscaling will be based on both CPU utilization and + accelerator's duty cycle metrics and scale up when either metrics + exceeds its target value while scale down if both metrics are under + their target value. The default target value is 60 for both metrics. + If machine_spec.accelerator_count is 0, the autoscaling will be + based on CPU utilization metric only with default target value 60 if + not explicitly set. For example, in the case of Online Prediction, + if you want to override target CPU utilization to 80, you should set + autoscaling_metric_specs.metric_name to + `aiplatform.googleapis.com/prediction/online/cpu/utilization` and + autoscaling_metric_specs.target to `80`. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoscalingMetricSpec' + maxReplicaCount: + format: int32 type: integer description: >- - If there are fewer than this many COMPLETED trials, do not stop the - study. + Immutable. The maximum number of replicas this DeployedModel 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 the model to that many replicas + is guaranteed (barring service outages). If traffic against the + DeployedModel 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). + minReplicaCount: format: int32 - minimumRuntimeConstraint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' + type: integer description: >- - Each "stopping rule" in this proto specifies an "if" condition. - Before Vizier would generate a new suggestion, it first checks each - specified stopping rule, from top to bottom in this list. Note that - the first few rules (e.g. minimum_runtime_constraint, - min_num_trials) will prevent other stopping rules from being - evaluated until they are met. For example, setting - `min_num_trials=5` and `always_stop_after= 1 hour` means that the - Study will ONLY stop after it has 5 COMPLETED trials, even if more - than an hour has passed since its creation. It follows the first - applicable rule (whose "if" condition is satisfied) to make a - stopping decision. If none of the specified rules are applicable, - then Vizier decides that the study should not stop. If Vizier - decides that the study should stop, the study enters STOPPING state - (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The - automatic study state transition happens precisely as described - above; that is, deleting trials or updating StudyConfig NEVER - automatically moves the study state back to ACTIVE. If you want to - _resume_ a Study that was stopped, 1) change the stopping conditions - if necessary, 2) activate the study, and then 3) ask for - suggestions. If the specified time or duration has not passed, do - not stop the study. - type: object - GoogleCloudAiplatformV1NearestNeighborQueryStringFilter: - id: GoogleCloudAiplatformV1NearestNeighborQueryStringFilter - type: object + Required. Immutable. The minimum number of machine replicas this + DeployedModel will be always deployed on. This value must be greater + than or equal to 1. If traffic against the DeployedModel increases, + it may dynamically be deployed onto more replicas, and as traffic + decreases, some of these extra replicas may be freed. + spot: + description: >- + Optional. If true, schedule the deployment workload on [spot + VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). + type: boolean description: >- - String filter is used to search a subset of the entities by using - boolean rules on string columns. For example: if a query specifies - string filter with 'name = color, allow_tokens = {red, blue}, - deny_tokens = {purple}',' then that query will match entities that are - red or blue, but if those points are also purple, then they will be - excluded even if they are red/blue. Only string filter is supported for - now, numeric filter will be supported in the near future. + A description of resources that are dedicated to a DeployedModel, and + that need a higher degree of manual configuration. + GoogleCloudAiplatformV1ListModelVersionsResponse: properties: - name: + nextPageToken: type: string - description: Required. Column names in BigQuery that used as filters. - denyTokens: - items: - type: string - description: Optional. The denied tokens. - type: array - allowTokens: - description: Optional. The allowed tokens. + description: >- + A token to retrieve the next page of results. Pass to + ListModelVersionsRequest.page_token to obtain that page. + models: items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' type: array - GoogleCloudAiplatformV1ExplanationMetadata: - id: GoogleCloudAiplatformV1ExplanationMetadata - type: object - description: Metadata describing the Model's input and output for explanation. - properties: - inputs: - description: >- - Required. Map from feature names to feature input metadata. Keys are - the name of the features. Values are the specification of the - feature. An empty InputMetadata is valid. It describes a text - feature which has the name specified as the key in - ExplanationMetadata.inputs. The baseline of the empty feature is - chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the - key can be any friendly name of the feature. Once specified, - featureAttributions are keyed by this key (if not grouped with - another feature). For custom images, the key must match with the key - in instance. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadata - type: object - latentSpaceSource: - description: >- - Name of the source to generate embeddings for example based - explanations. - type: string - outputs: - description: >- - Required. Map from output names to output metadata. For Vertex - AI-provided Tensorflow images, keys can be any user defined string - that consists of any UTF-8 characters. For custom images, keys are - the name of the output field in the prediction to be explained. - Currently only one key is allowed. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata - featureAttributionsSchemaUri: - type: string description: >- - Points to a YAML file stored on Google Cloud Storage describing the - format of the feature attributions. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML tabular Models always have this field populated by Vertex AI. - Note: The URI given on output may be different, including the URI - scheme, than the one given on input. The output URI will point to a - location where the user only has a read access. - GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: - description: Response message for FeaturestoreService.BatchReadFeatureValues. - properties: {} - type: object - id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse - GoogleCloudAiplatformV1PipelineJobDetail: - description: The runtime detail of PipelineJob. + List of Model versions in the requested page. In the returned Model + name field, version ID instead of regvision tag will be included. type: object - id: GoogleCloudAiplatformV1PipelineJobDetail + id: GoogleCloudAiplatformV1ListModelVersionsResponse + description: Response message for ModelService.ListModelVersions + GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: + description: Details of operations that perform update FeatureOnlineStore. properties: - pipelineContext: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - description: Output only. The context of the pipeline. - taskDetails: - description: Output only. The runtime details of the tasks under the pipeline. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetail' - readOnly: true - type: array - pipelineRunContext: - description: Output only. The context of the current pipeline run. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - GoogleCloudAiplatformV1FeatureViewVertexRagSource: - id: GoogleCloudAiplatformV1FeatureViewVertexRagSource + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureOnlineStore. + type: object + id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata + GoogleCloudAiplatformV1GcsDestination: properties: - uri: + outputUriPrefix: description: >- - Required. The BigQuery view/table URI that will be materialized on - each manual sync trigger. The table/view is expected to have the - following columns and types at least: - `corpus_id` (STRING, - NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, - NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, - NULLABLE/REQUIRED) - type: string - ragCorpusId: - format: int64 - description: Optional. The RAG corpus id corresponding to this FeatureView. + Required. Google Cloud Storage URI to output directory. If the uri + doesn't end with '/', a '/' will be automatically appended. The + directory is created if it doesn't exist. type: string - description: A Vertex Rag source for features that need to be synced to Online Store. type: object - GoogleCloudAiplatformV1TuningJob: - id: GoogleCloudAiplatformV1TuningJob + description: The Google Cloud Storage location where the output is to be written to. + id: GoogleCloudAiplatformV1GcsDestination + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation: + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation properties: - description: - description: Optional. The description of the TuningJob. - type: string - supervisedTuningSpec: - description: Tuning Spec for Supervised Fine Tuning. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' - tunedModel: - description: >- - Output only. The tuned model resources assiociated with this - TuningJob. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' - updateTime: - readOnly: true - format: google-datetime + columnName: type: string - description: Output only. Time when the TuningJob was most recently updated. - encryptionSpec: + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Convert the category name to a dictionary lookup index and generate an + embedding for each index. + GoogleCloudAiplatformV1ExplainResponse: + properties: + explanations: + type: array description: >- - Customer-managed encryption key options for a TuningJob. If this is - set, then all resources created by the TuningJob will be encrypted - with the provided encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - createTime: - format: google-datetime - description: Output only. Time when the TuningJob was created. - readOnly: true - type: string - experiment: - readOnly: true - description: Output only. The Experiment associated with this TuningJob. + The explanations of the Model's PredictResponse.predictions. It has + the same number of elements as instances to be explained. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + deployedModelId: + description: ID of the Endpoint's DeployedModel that served this explanation. type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' + predictions: + type: array description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. - readOnly: true - labels: + The predictions that are the output of the predictions call. Same as + PredictResponse.predictions. + items: + type: any + description: Response message for PredictionService.Explain. + id: GoogleCloudAiplatformV1ExplainResponse + type: object + GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation: + id: GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation + description: Annotation details specific to video classification. + properties: + timeSegment: description: >- - Optional. The labels with user-defined metadata to organize - TuningJob and generated resources such as Model and Endpoint. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - type: object - additionalProperties: - type: string - startTime: - readOnly: true + This Annotation applies to the time period represented by the + TimeSegment. If it's not set, the Annotation applies to the whole + video. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' + annotationSpecId: type: string - format: google-datetime description: >- - Output only. Time when the TuningJob for the first time entered the - `JOB_STATE_RUNNING` state. - name: - readOnly: true + The resource Id of the AnnotationSpec that this Annotation pertains + to. + displayName: description: >- - Output only. Identifier. Resource name of a TuningJob. Format: - `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + The display name of the AnnotationSpec that this Annotation pertains + to. type: string - tuningDataStats: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' - description: >- - Output only. The tuning data statistics associated with this - TuningJob. - endTime: + type: object + GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig: + description: Config for migrating version in ml.googleapis.com to Vertex AI's Model. + properties: + endpoint: description: >- - Output only. Time when the TuningJob entered any of the following - JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. - type: string - format: google-datetime - readOnly: true - state: - readOnly: true - description: Output only. The detailed state of the job. + Required. The ml.googleapis.com endpoint that this model version + should be migrated from. Example values: * ml.googleapis.com * + us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * + asia-east1-ml.googleapis.com type: string - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - baseModel: - description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". + modelVersion: type: string - tunedModelDisplayName: + description: >- + Required. Full resource name of ml engine model version. Format: + `projects/{project}/models/{model}/versions/{version}`. + modelDisplayName: type: string description: >- - Optional. The display name of the TunedModel. The name can be up to - 128 characters long and can consist of any UTF-8 characters. + Required. Display name of the model in Vertex AI. System will pick a + display name if unspecified. + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig type: object - description: Represents a TuningJob that runs with Google owned models. - GoogleCloudAiplatformV1ListSchedulesResponse: - id: GoogleCloudAiplatformV1ListSchedulesResponse + GoogleCloudAiplatformV1DataItemView: + type: object + id: GoogleCloudAiplatformV1DataItemView + description: A container for a single DataItem and Annotations on it. properties: - nextPageToken: + hasTruncatedAnnotations: + type: boolean description: >- - A token to retrieve the next page of results. Pass to - ListSchedulesRequest.page_token to obtain that page. - type: string - schedules: + True if and only if the Annotations field has been truncated. It + happens if more Annotations for this DataItem met the request's + annotation_filter than are allowed to be returned by + annotations_limit. Note that if Annotations field is not being + returned due to field mask, then this field will not be set to true + no matter how many Annotations are there. + dataItem: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' + description: The DataItem. + annotations: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' - description: List of Schedules in the requested page. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' type: array - type: object - description: Response message for ScheduleService.ListSchedules - GoogleCloudAiplatformV1ToolParameterKVMatchSpec: - properties: - useStrictStringMatch: - description: Optional. Whether to use STRCIT string match on parameter values. - type: boolean - id: GoogleCloudAiplatformV1ToolParameterKVMatchSpec - description: Spec for tool parameter key value match metric. - type: object - GoogleCloudAiplatformV1MigratableResourceAutomlDataset: - type: object - description: Represents one Dataset in automl.googleapis.com. - id: GoogleCloudAiplatformV1MigratableResourceAutomlDataset + description: >- + The Annotations on the DataItem. If too many Annotations should be + returned for the DataItem, this field will be truncated per + annotations_limit in request. If it was, then the + has_truncated_annotations will be set to true. + GoogleCloudAiplatformV1SchemaTextDataItem: + description: Payload of Text DataItem. + id: GoogleCloudAiplatformV1SchemaTextDataItem properties: - datasetDisplayName: - description: The Dataset's display name in automl.googleapis.com. + gcsUri: + readOnly: true type: string - dataset: description: >- - Full resource name of automl Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}`. - type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity: + Output only. Google Cloud Storage URI points to the original text in + user's bucket. The text file is up to 10MB in size. type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + type: object description: A duration of time expressed in time granularity units. properties: quantity: - type: string - format: int64 description: >- The number of granularity_units between data points in the training data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. For all other values of `granularity_unit`, must be 1. + type: string + format: int64 unit: + type: string description: >- The time granularity unit of this time period. The supported units are: * "minute" * "hour" * "day" * "week" * "month" * "year" - type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata + GoogleCloudAiplatformV1ToolParameterKVMatchResults: properties: - evaluatedDataItemsBigqueryUri: - description: BigQuery destination uri for exported evaluated examples. - type: string - trainCostMilliNodeHours: - type: string - format: int64 - description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - description: Model metadata specific to AutoML Tables. - type: object - GoogleCloudAiplatformV1ToolCallValidMetricValue: - description: Tool call valid metric value for an instance. + toolParameterKvMatchMetricValues: + description: Output only. Tool parameter key value match metric values. + type: array + readOnly: true + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue type: object - id: GoogleCloudAiplatformV1ToolCallValidMetricValue + description: Results for tool parameter key value match metric. + id: GoogleCloudAiplatformV1ToolParameterKVMatchResults + GoogleCloudAiplatformV1ToolParameterKeyMatchInput: + description: Input for tool parameter key match metric. properties: - score: - type: number - description: Output only. Tool call valid score. - format: float - readOnly: true - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig: - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + instances: + type: array + description: Required. Repeated tool parameter key match instances. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInstance + metricSpec: + description: Required. Spec for tool parameter key match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchSpec + id: GoogleCloudAiplatformV1ToolParameterKeyMatchInput + type: object + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec: type: object + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec + description: Represent spec for search trials. properties: - skewThresholds: + maxFailedTrialCount: + format: int32 description: >- - Key is the feature name and value is the threshold. If a feature - needs to be monitored for skew, a value threshold must be configured - for that feature. The threshold here is against feature distribution - distance between the training and prediction feature. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - attributionScoreSkewThresholds: + The number of failed trials that need to be seen before failing the + NasJob. If set to 0, Vertex AI decides how many trials must fail + before the whole job fails. + type: integer + maxTrialCount: description: >- - Key is the feature name and value is the threshold. The threshold - here is against attribution score distance between the training and - prediction feature. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - defaultSkewThreshold: + Required. The maximum number of Neural Architecture Search (NAS) + trials to run. + format: int32 + type: integer + searchTrialJobSpec: description: >- - Skew anomaly detection threshold used by all features. When the - per-feature thresholds are not set, this field can be used to - specify a threshold for all features. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - description: >- - The config for Training & Prediction data skew detection. It specifies - the training dataset sources and the skew detection parameters. - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline: - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline - type: object - description: >- - Output from BatchPredictionJob for Model Monitoring baseline dataset, - which can be used to generate baseline attribution scores. - properties: - gcs: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Cloud Storage location for BatchExplain output. - predictionFormat: - description: The storage format of the predictions generated BatchPrediction job. - enumDescriptions: - - Should not be set. - - Predictions are in JSONL files. - - Predictions are in BigQuery. - enum: - - PREDICTION_FORMAT_UNSPECIFIED - - JSONL - - BIGQUERY - type: string - bigquery: - description: BigQuery location for BatchExplain output. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry: - type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + Required. The spec of a search trial job. The same spec applies to + all search trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + maxParallelTrialCount: + description: Required. The maximum number of trials to run in parallel. + type: integer + format: int32 + GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec: + id: GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec properties: - quantile: - description: The quantile for this entry. + values: + type: array + items: + type: number + format: double + description: >- + Required. A list of possible values. The list should be in + increasing order and at least 1e-10 apart. For instance, this + parameter might have possible settings of 1.5, 2.5, and 4.0. This + list should not contain more than 1,000 values. + defaultValue: type: number format: double - observedQuantile: - type: number description: >- - This is a custom metric that calculates the percentage of true - values that were less than the predicted value for that quantile. - Only populated when optimization_objective is minimize-quantile-loss - and each entry corresponds to an entry in quantiles The percent - value can be used to compare with the quantile value, which is the - target value. - format: double - scaledPinballLoss: - format: float - description: The scaled pinball loss of this quantile. - type: number - description: Entry for the Quantiles loss type optimization objective. - GoogleCloudAiplatformV1FluencyInput: - type: object - id: GoogleCloudAiplatformV1FluencyInput - properties: - metricSpec: - description: Required. Spec for fluency score metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencySpec' - instance: - description: Required. Fluency instance. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInstance' - description: Input for fluency metric. - GoogleCloudAiplatformV1DeployedIndex: + A default value for a `DISCRETE` parameter that is assumed to be a + relatively good starting point. Unset value signals that there is no + offered starting point. It automatically rounds to the nearest + feasible discrete point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. + description: Value specification for a parameter in `DISCRETE` type. type: object + GoogleCloudAiplatformV1BigQuerySource: properties: - createTime: - format: google-datetime - readOnly: true - description: Output only. Timestamp when the DeployedIndex was created. - type: string - index: - description: >- - Required. The name of the Index this is the deployment of. We may - refer to this Index as the DeployedIndex's "original" Index. + inputUri: type: string - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' description: >- - Optional. A description of resources that are dedicated to the - DeployedIndex, and that need a higher degree of manual - configuration. The field min_replica_count must be set to a value - strictly greater than 0, or else validation will fail. We don't - provide SLA when min_replica_count=1. If max_replica_count is not - set, the default value is min_replica_count. The max allowed replica - count is 1000. Available machine types for SMALL shard: - e2-standard-2 and all machine types available for MEDIUM and LARGE - shard. Available machine types for MEDIUM shard: e2-standard-16 and - all machine types available for LARGE shard. Available machine types - for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and - n1-standard-32 are still available, but we recommend e2-standard-16 - and e2-highmem-16 for cost efficiency. - reservedIpRanges: - type: array - items: - type: string + Required. BigQuery URI to a table, up to 2000 characters long. + Accepted forms: * BigQuery path. For example: + `bq://projectId.bqDatasetId.bqTableId`. + id: GoogleCloudAiplatformV1BigQuerySource + type: object + description: The BigQuery location for the input content. + GoogleCloudAiplatformV1MutateDeployedIndexResponse: + properties: + deployedIndex: + description: The DeployedIndex that had been updated in the IndexEndpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + id: GoogleCloudAiplatformV1MutateDeployedIndexResponse + type: object + description: Response message for IndexEndpointService.MutateDeployedIndex. + GoogleCloudAiplatformV1ExportFeatureValuesResponse: + type: object + description: Response message for FeaturestoreService.ExportFeatureValues. + id: GoogleCloudAiplatformV1ExportFeatureValuesResponse + properties: {} + GoogleCloudAiplatformV1CompleteTrialRequest: + type: object + properties: + finalMeasurement: description: >- - Optional. A list of reserved ip ranges under the VPC network that - can be used for this DeployedIndex. If set, we will deploy the index - within the provided ip ranges. Otherwise, the index might be - deployed to any ip ranges under the provided VPC network. The value - should be the name of the address - (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) - Example: ['vertex-ai-ip-range']. For more information about subnets - and network IP ranges, please see - https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. - enableAccessLogging: + Optional. If provided, it will be used as the completed Trial's + final_measurement; Otherwise, the service will auto-select a + previously reported measurement as the final-measurement + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + trialInfeasible: type: boolean description: >- - Optional. If true, private endpoint's access logs are sent to Cloud - Logging. These logs are like standard server access logs, containing - information like timestamp and latency for each MatchRequest. Note - that logs may incur a cost, especially if the deployed index - receives a high queries per second rate (QPS). Estimate your costs - before enabling this option. - privateEndpoints: - readOnly: true - description: >- - Output only. Provides paths for users to send requests directly to - the deployed index services running on Cloud via private services - access. This field is populated if network is configured. - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' - displayName: + Optional. True if the Trial cannot be run with the given Parameter, + and final_measurement will be ignored. + infeasibleReason: type: string description: >- - The display name of the DeployedIndex. If not provided upon - creation, the Index's display_name is used. - indexSyncTime: - type: string + Optional. A human readable reason why the trial was infeasible. This + should only be provided if `trial_infeasible` is true. + id: GoogleCloudAiplatformV1CompleteTrialRequest + description: Request message for VizierService.CompleteTrial. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata: + properties: + bestTrialBackingCustomJob: description: >- - Output only. The DeployedIndex may depend on various data on its - original Index. Additionally when certain changes to the original - Index are being done (e.g. when what the Index contains is being - changed) the DeployedIndex may be asynchronously updated in the - background to reflect these changes. If this timestamp's value is at - least the Index.update_time of the original Index, it means that - this DeployedIndex and the original Index are in sync. If this - timestamp is older, then to see which updates this DeployedIndex - already contains (and which it does not), one must list the - operations that are running on the original Index. Only the - successfully completed Operations with update_time equal or before - this sync time are contained in this DeployedIndex. - readOnly: true - format: google-datetime - id: + The resource name of the CustomJob that has been created to run the + best Trial of this HyperparameterTuning task. + type: string + backingHyperparameterTuningJob: type: string description: >- - Required. The user specified ID of the DeployedIndex. The ID can be - up to 128 characters long and must start with a letter and only - contain letters, numbers, and underscores. The ID must be unique - within the project it is created in. - pscAutomationConfigs: - description: >- - Optional. If set for PSC deployed index, PSC connection will be - automatically created after deployment is done and the endpoint - information is populated in - private_endpoints.psc_automated_endpoints. + The resource name of the HyperparameterTuningJob that has been + created to carry out this HyperparameterTuning task. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + type: object + GoogleCloudAiplatformV1ListContextsResponse: + properties: + contexts: type: array + description: The Contexts retrieved from the MetadataStore. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PSCAutomationConfig' - automaticResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - description: >- - Optional. A description of resources that the DeployedIndex uses, - which to large degree are decided by Vertex AI, and optionally - allows only a modest additional configuration. If min_replica_count - is not set, the default value is 2 (we don't provide SLA when - min_replica_count=1). If max_replica_count is not set, the default - value is min_replica_count. The max allowed replica count is 1000. - deploymentGroup: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + nextPageToken: type: string description: >- - Optional. The deployment group can be no longer than 64 characters - (eg: 'test', 'prod'). If not set, we will use the 'default' - deployment group. Creating `deployment_groups` with - `reserved_ip_ranges` is a recommended practice when the peered - network has multiple peering ranges. This creates your deployments - from predictable IP spaces for easier traffic administration. Also, - one deployment_group (except 'default') can only be used with the - same reserved_ip_ranges which means if the deployment_group has been - used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, - e] is disallowed. Note: we only support up to 5 deployment - groups(not including 'default'). - deployedIndexAuthConfig: - description: >- - Optional. If set, the authentication is enabled for the private - endpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' - description: >- - A deployment of an Index. IndexEndpoints contain one or more - DeployedIndexes. - id: GoogleCloudAiplatformV1DeployedIndex - GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance: + A token, which can be sent as ListContextsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. + id: GoogleCloudAiplatformV1ListContextsResponse + description: Response message for MetadataService.ListContexts. type: object - id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance - description: Spec for question answering correctness instance. + GoogleCloudAiplatformV1ListTrainingPipelinesResponse: + id: GoogleCloudAiplatformV1ListTrainingPipelinesResponse + description: Response message for PipelineService.ListTrainingPipelines properties: - instruction: - type: string + nextPageToken: description: >- - Required. The question asked and other instruction in the inference - prompt. - prediction: - type: string - description: Required. Output of the evaluated model. - reference: - type: string - description: Optional. Ground truth used to compare against the prediction. - context: - description: Optional. Text provided as context to answer the question. + A token to retrieve the next page of results. Pass to + ListTrainingPipelinesRequest.page_token to obtain that page. type: string - GoogleCloudAiplatformV1CoherenceResult: + trainingPipelines: + description: List of TrainingPipelines in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + type: array type: object - description: Spec for coherence result. - id: GoogleCloudAiplatformV1CoherenceResult - properties: - explanation: - readOnly: true - description: Output only. Explanation for coherence score. - type: string - confidence: - readOnly: true - type: number - description: Output only. Confidence for coherence score. - format: float - score: - type: number - readOnly: true - description: Output only. Coherence score. - format: float - GoogleCloudAiplatformV1DeployIndexOperationMetadata: - description: Runtime operation information for IndexEndpointService.DeployIndex. + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest: + type: object + description: Request message for VizierService.CheckTrialEarlyStoppingState. + properties: {} + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + GoogleCloudAiplatformV1CancelNasJobRequest: + properties: {} + description: Request message for JobService.CancelNasJob. + type: object + id: GoogleCloudAiplatformV1CancelNasJobRequest + GoogleCloudAiplatformV1UndeployModelOperationMetadata: type: object - id: GoogleCloudAiplatformV1DeployIndexOperationMetadata properties: genericMetadata: description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - deployedIndexId: - description: The unique index id specified by user - type: string - CloudAiLargeModelsVisionRaiInfo: - description: 'Next ID: 6' + description: Runtime operation information for EndpointService.UndeployModel. + id: GoogleCloudAiplatformV1UndeployModelOperationMetadata + GoogleCloudAiplatformV1CopyModelResponse: properties: - detectedLabels: - type: array - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' - description: The list of detected labels for different rai categories. - raiCategories: - items: - type: string - description: List of rai categories' information to return - type: array - scores: + model: description: >- - List of rai scores mapping to the rai categories. Rounded to 1 - decimal place. - type: array - items: - type: number - format: float - modelName: + The name of the copied Model resource. Format: + `projects/{project}/locations/{location}/models/{model}` type: string - description: >- - The model name used to indexing into the RaiFilterConfig map. Would - either be one of imagegeneration@002-006, imagen-3.0-... api - endpoint names, or internal names used for mapping to different - filter configs (genselfie, ai_watermark) than its api endpoint. - blockedEntities: - type: array - description: List of blocked entities from the blocklist if it is detected. - items: - type: string - id: CloudAiLargeModelsVisionRaiInfo + modelVersionId: + description: Output only. The version ID of the model that is copied. + type: string + readOnly: true type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics: + id: GoogleCloudAiplatformV1CopyModelResponse + description: Response message of ModelService.CopyModel operation. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics: type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics properties: - confidenceThreshold: - format: float - type: number - description: The confidence threshold value used to compute the metrics. - f1Score: - format: float - description: The harmonic mean of recall and precision. + bleu: type: number - recall: format: float - type: number - description: Recall under the given confidence threshold. - precision: - description: Precision under the given confidence threshold. + description: >- + BLEU (bilingual evaluation understudy) scores based on sacrebleu + implementation. + rougeLSum: format: float + description: ROUGE-L (Longest Common Subsequence) scoring at summary level. type: number - description: Metrics for a single confidence threshold. - GoogleCloudAiplatformV1Tensorboard: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics + GoogleCloudAiplatformV1FetchFeatureValuesResponse: + type: object + description: Response message for FeatureOnlineStoreService.FetchFeatureValues properties: - satisfiesPzi: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - updateTime: - type: string - description: Output only. Timestamp when this Tensorboard was last updated. - readOnly: true - format: google-datetime - description: - description: Description of this Tensorboard. - type: string - isDefault: - type: boolean + keyValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList + description: Feature values in KeyValue format. + dataKey: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' description: >- - Used to indicate if the TensorBoard instance is the default one. - Each project & region can have at most one default TensorBoard - instance. Creation of a default TensorBoard instance and updating an - existing TensorBoard instance to be default will mark all other - TensorBoard instances (if any) as non default. - etag: - type: string + The data key associated with this response. Will only be populated + for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. + protoStruct: + additionalProperties: + type: any + description: Properties of the object. + description: Feature values in proto Struct format. + type: object + id: GoogleCloudAiplatformV1FetchFeatureValuesResponse + GoogleCloudAiplatformV1ShieldedVmConfig: + properties: + enableSecureBoot: description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - blobStoragePathPrefix: - description: >- - Output only. Consumer project Cloud Storage path prefix used to - store blob data, which can either be a bucket or directory. Does not - end with a '/'. - type: string - readOnly: true - name: - description: >- - Output only. Name of the Tensorboard. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}` - readOnly: true - type: string - labels: - additionalProperties: - type: string - type: object - description: >- - The labels with user-defined metadata to organize your Tensorboards. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Tensorboard - (System labels are excluded). See https://goo.gl/xmQnxf for more - information and examples of labels. System reserved label keys are - prefixed with "aiplatform.googleapis.com/" and are immutable. - runCount: - readOnly: true - format: int32 - description: Output only. The number of Runs stored in this Tensorboard. - type: integer - satisfiesPzs: + Defines whether the instance has [Secure + Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) + enabled. Secure Boot helps ensure that the system only runs + authentic software by verifying the digital signature of all boot + components, and halting the boot process if signature verification + fails. type: boolean - readOnly: true - description: Output only. Reserved for future use. - displayName: - description: Required. User provided name of this Tensorboard. - type: string - createTime: - type: string - format: google-datetime - description: Output only. Timestamp when this Tensorboard was created. - readOnly: true - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Customer-managed encryption key spec for a Tensorboard. If set, this - Tensorboard and all sub-resources of this Tensorboard will be - secured by this key. - id: GoogleCloudAiplatformV1Tensorboard - type: object - description: >- - Tensorboard is a physical database that stores users' training metrics. - A default Tensorboard is provided in each region of a Google Cloud - project. If needed users can also create extra Tensorboards in their - projects. - GoogleCloudAiplatformV1QuestionAnsweringQualityResult: - type: object - description: Spec for question answering quality result. - properties: - confidence: - readOnly: true - format: float - description: Output only. Confidence for question answering quality score. - type: number - explanation: - type: string - readOnly: true - description: Output only. Explanation for question answering quality score. - score: - description: Output only. Question Answering Quality score. - type: number - format: float - readOnly: true - id: GoogleCloudAiplatformV1QuestionAnsweringQualityResult - GoogleCloudAiplatformV1WriteFeatureValuesResponse: description: >- - Response message for - FeaturestoreOnlineServingService.WriteFeatureValues. + A set of Shielded Instance options. See [Images using supported Shielded + VM + features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). type: object - properties: {} - id: GoogleCloudAiplatformV1WriteFeatureValuesResponse - GoogleCloudAiplatformV1FluencySpec: + id: GoogleCloudAiplatformV1ShieldedVmConfig + GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling: properties: - version: + cpuUtilizationTarget: format: int32 type: integer - description: Optional. Which version to use for evaluation. - id: GoogleCloudAiplatformV1FluencySpec - type: object - description: Spec for fluency score metric. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata: - properties: - successfulStopReason: - enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - - >- - Further training of the Model ceased to increase its quality, - since it already has converged. - type: string - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED description: >- - For successful job completions, this is the reason why the job has - finished. - costMilliNodeHours: - type: string + Optional. The cpu utilization that the Autoscaler should be trying + to achieve. This number is on a scale from 0 (no utilization) to 100 + (total utilization), and is limited between 10 and 80. When a + cluster's CPU utilization exceeds the target that you have set, + Bigtable immediately adds nodes to the cluster. When CPU utilization + is substantially lower than the target, Bigtable removes nodes. If + not set or set to 0, default to 50. + minNodeCount: + format: int32 description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. - format: int64 - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics: - description: Metrics for text extraction evaluation results. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics + Required. The minimum number of nodes to scale down to. Must be + greater than or equal to 1. + type: integer + maxNodeCount: + type: integer + description: >- + The maximum number of nodes to scale up to. Must be greater than + min_node_count, and less than or equal to 10 times of + 'min_node_count'. + format: int32 + id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling type: object + description: >- + Online serving scaling configuration. If min_node_count and + max_node_count are set to the same value, the cluster will be configured + with the fixed number of node (no auto-scaling). + GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance: properties: - confusionMatrix: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: >- - Confusion matrix of the evaluation. Only set for Models where number - of AnnotationSpecs is no more than 10. Only set for - ModelEvaluations, not for ModelEvaluationSlices. - confidenceMetrics: - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from them. + contextColumns: + items: + type: string + type: array + attributeColumns: type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics - GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - type: object - description: Metadata information for NotebookService.CreateNotebookRuntimeTemplate. - id: GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata - GoogleCloudAiplatformV1ExportDataOperationMetadata: - description: Runtime operation information for DatasetService.ExportData. - type: object - properties: - gcsOutputDirectory: - description: >- - A Google Cloud Storage directory which path ends with '/'. The - exported data is stored in the directory. - type: string - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1ExportDataOperationMetadata - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix: - properties: - rows: + type: string + horizonWeights: items: - items: - type: any - type: array + type: number + format: float + type: array + attributeWeights: type: array - description: >- - Rows in the confusion matrix. The number of rows is equal to the - size of `annotationSpecs`. `rowsi` is the number of DataItems that - have ground truth of the `annotationSpecs[i]` and are predicted as - `annotationSpecs[j]` by the Model being evaluated. For Text - Extraction, when `annotationSpecs[i]` is the last element in - `annotationSpecs`, i.e. the special negative AnnotationSpec, `rowsi` - is the number of predicted entities of `annoatationSpec[j]` that are - not labeled as any of the ground truth AnnotationSpec. When - annotationSpecs[j] is the special negative AnnotationSpec, `rowsi` - is the number of entities have ground truth of `annotationSpec[i]` - that are not predicted as an entity by the Model. The value of the - last cell, i.e. `rowi` where i == j and `annotationSpec[i]` is the - special negative AnnotationSpec, is always 0. - annotationSpecs: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + type: number + format: float + horizonColumns: + type: array + items: + type: string + contextWeights: + type: array description: >- - AnnotationSpecs used in the confusion matrix. For AutoML Text - Extraction, a special negative AnnotationSpec with empty `id` and - `displayName` of "NULL" will be added as the last element. + TFT feature importance values. Each pair for + {context/horizon/attribute} should have the same shape since the + weight corresponds to the column names. + items: + format: float + type: number + id: GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance + type: object + GoogleCloudAiplatformV1StreamingPredictRequest: + properties: + parameters: + description: The parameters that govern the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + inputs: + description: The prediction input. type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + id: GoogleCloudAiplatformV1StreamingPredictRequest type: object - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - GoogleCloudAiplatformV1FeatureStatsAnomaly: - id: GoogleCloudAiplatformV1FeatureStatsAnomaly + description: >- + Request message for PredictionService.StreamingPredict. The first + message must contain endpoint field and optionally input. The subsequent + messages must contain input. + GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke: + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke type: object properties: - distributionDeviation: - format: double - description: >- - Deviation from the current stats to baseline stats. 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. - type: number - score: - description: >- - Feature importance score, only populated when cross-feature - monitoring is enabled. For now only used to represent feature - attribution score within range [0, 1] for - ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and - ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT. - format: double - type: number - endTime: + gkeYamlConfigs: + type: array + description: Optional. GKE deployment configuration in yaml format. + items: + type: string + description: Configurations for PublisherModel GKE deployment + GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport: + type: object + description: >- + Describes exporting all historical Feature values of all entities of the + EntityType between [start_time, end_time]. + properties: + startTime: format: google-datetime type: string description: >- - The end timestamp of window where stats were generated. For - objectives where time window doesn't make sense (e.g. Featurestore - Snapshot Monitoring), end_time indicates the timestamp of the data - used to generate stats (e.g. timestamp we take snapshots for feature - values). - statsUri: - type: string - description: >- - Path of the stats file for current feature values in Cloud Storage - bucket. Format: gs:////stats. Example: - gs://monitoring_bucket/feature_name/stats. Stats are stored as - binary format with Protobuf message - [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto). - anomalyUri: - description: >- - Path of the anomaly file for current feature values in Cloud Storage - bucket. Format: gs:////anomalies. Example: - gs://monitoring_bucket/feature_name/anomalies. Stats are stored as - binary format with Protobuf message Anoamlies are stored as binary - format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] - (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto). - type: string - anomalyDetectionThreshold: - format: double - type: number - description: >- - This is the threshold used when detecting anomalies. The threshold - can be changed by user, so this one might be different from - ThresholdConfig.value. - startTime: + Excludes Feature values with feature generation timestamp before + this timestamp. If not set, retrieve oldest values kept in Feature + Store. Timestamp, if present, must not have higher than millisecond + precision. + endTime: description: >- - The start timestamp of window where stats were generated. For - objectives where time window doesn't make sense (e.g. Featurestore - Snapshot Monitoring), start_time is only used to indicate the - monitoring intervals, so it always equals to (end_time - - monitoring_interval). + Exports Feature values as of this timestamp. If not set, retrieve + values as of now. Timestamp, if present, must not have higher than + millisecond precision. format: google-datetime type: string - description: >- - Stats and Anomaly generated at specific timestamp for specific Feature. - The start_time and end_time are used to define the time range of the - dataset that current stats belongs to, e.g. prediction traffic is - bucketed into prediction datasets by time window. If the Dataset is not - defined by time window, start_time = end_time. Timestamp of the stats - and anomalies always refers to end_time. Raw stats and anomalies are - stored in stats_uri or anomaly_uri in the tensorflow defined protos. - Field data_stats contains almost identical information with the raw - stats in Vertex AI defined proto, for UI to display. - GoogleCloudAiplatformV1Execution: - id: GoogleCloudAiplatformV1Execution + id: GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport + GoogleCloudAiplatformV1Attribution: type: object properties: - schemaVersion: + outputDisplayName: type: string + readOnly: true description: >- - The version of the schema in `schema_title` to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - state: - type: string - enumDescriptions: - - Unspecified Execution state - - The Execution is new - - The Execution is running - - The Execution has finished running - - The Execution has failed - - The Execution completed through Cache hit. - - The Execution was cancelled. - enum: - - STATE_UNSPECIFIED - - NEW - - RUNNING - - COMPLETE - - FAILED - - CACHED - - CANCELLED + Output only. The display name of the output identified by + output_index. For example, the predicted class name by a + multi-classification Model. This field is only populated iff the + Model predicts display names as a separate field along with the + explained output. The predicted display name must has the same shape + of the explained output, and can be located using output_index. + featureAttributions: description: >- - The state of this Execution. This is a property of the Execution, - and does not imply or capture any ongoing process. This property is - managed by clients (such as Vertex AI Pipelines) and the system does - not prescribe or check the validity of state transitions. - name: - description: Output only. The resource name of the Execution. - type: string + Output only. Attributions of each explained feature. Features are + extracted from the prediction instances according to explanation + metadata for inputs. The value is a struct, whose keys are the name + of the feature. The values are how much the feature in the instance + contributed to the predicted result. The format of the value is + determined by the feature's input format: * If the feature is a + scalar value, the attribution value is a floating number. * If the + feature is an array of scalar values, the attribution value is an + array. * If the feature is a struct, the attribution value is a + struct. The keys in the attribution value struct are the same as the + keys in the feature struct. The formats of the values in the + attribution struct are determined by the formats of the values in + the feature struct. The + ExplanationMetadata.feature_attributions_schema_uri field, pointed + to by the ExplanationSpec field of the Endpoint.deployed_models + object, points to the schema file that describes the features and + their attribution values (if it is populated). + type: any readOnly: true - etag: - description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - type: string - schemaTitle: + outputName: type: string description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - description: - type: string - description: Description of the Execution - createTime: - format: google-datetime + Output only. Name of the explain output. Specified as the key in + ExplanationMetadata.outputs. readOnly: true - description: Output only. Timestamp when this Execution was created. - type: string - updateTime: - type: string + instanceOutputValue: + description: >- + Output only. Model predicted output on the corresponding explanation + instance. The field name of the output is determined by the key in + ExplanationMetadata.outputs. If the Model predicted output has + multiple dimensions, this is the value in the output located by + output_index. + readOnly: true + type: number + format: double + approximationError: readOnly: true - description: Output only. Timestamp when this Execution was last updated. - format: google-datetime - displayName: description: >- - User provided display name of the Execution. May be up to 128 - Unicode characters. - type: string - labels: - type: object + Output only. Error of feature_attributions caused by approximation + used in the explanation method. Lower value means more precise + attributions. * For Sampled Shapley attribution, increasing + path_count might reduce the error. * For Integrated Gradients + attribution, increasing step_count might reduce the error. * For + XRAI attribution, increasing step_count might reduce the error. See + [this introduction](/vertex-ai/docs/explainable-ai/overview) for + more information. + format: double + type: number + outputIndex: + items: + format: int32 + type: integer + type: array + readOnly: true description: >- - The labels with user-defined metadata to organize your Executions. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Execution - (System labels are excluded). - additionalProperties: - type: string - metadata: + Output only. The index that locates the explained prediction output. + If the prediction output is a scalar value, output_index is not + populated. If the prediction output has multiple dimensions, the + length of the output_index list is the same as the number of + dimensions of the output. The i-th element in output_index is the + element index of the i-th dimension of the output vector. Indices + start from 0. + baselineOutputValue: + format: double description: >- - Properties of the Execution. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. - type: object - additionalProperties: - type: any - description: Properties of the object. - description: Instance of a general execution. - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest: - description: >- - Request message for - JobService.SearchModelDeploymentMonitoringStatsAnomalies. + Output only. Model predicted output if the input instance is + constructed from the baselines of all the features defined in + ExplanationMetadata.inputs. The field name of the output is + determined by the key in ExplanationMetadata.outputs. If the Model's + predicted output has multiple dimensions (rank > 1), this is the + value in the output located by output_index. If there are multiple + baselines, their output values are averaged. + readOnly: true + type: number + description: Attribution that explains a particular prediction output. + id: GoogleCloudAiplatformV1Attribution + GoogleCloudAiplatformV1RawPredictRequest: + description: Request message for PredictionService.RawPredict. type: object + id: GoogleCloudAiplatformV1RawPredictRequest properties: - pageSize: - description: The standard list page size. - type: integer - format: int32 - deployedModelId: + httpBody: + $ref: '#/components/schemas/GoogleApiHttpBody' description: >- - Required. The DeployedModel ID of the - [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. - type: string - endTime: - type: string - description: >- - The latest timestamp of stats being generated. If not set, indicates - feching stats till the latest possible one. - format: google-datetime - startTime: + The prediction input. Supports HTTP headers and arbitrary data + payload. A DeployedModel may have an upper limit on the number of + instances it supports per request. When this limit it is exceeded + for an AutoML model, the RawPredict method returns an error. When + this limit is exceeded for a custom-trained model, the behavior + varies depending on the model. You can specify the schema for each + instance in the predict_schemata.instance_schema_uri field when you + create a Model. This schema applies when you deploy the `Model` as a + `DeployedModel` to an Endpoint and use the `RawPredict` method. + GoogleCloudAiplatformV1Tensor: + description: A tensor value type. + id: GoogleCloudAiplatformV1Tensor + type: object + properties: + uint64Val: + items: + format: uint64 + type: string + type: array + description: UINT64 + bytesVal: + items: + type: string + format: byte + type: array + description: STRING + structVal: + description: A map of string to tensor. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + listVal: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: array + description: A list of tensor values. + dtype: + description: The data type of tensor. + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - STRING + - FLOAT + - DOUBLE + - INT8 + - INT16 + - INT32 + - INT64 + - UINT8 + - UINT16 + - UINT32 + - UINT64 + enumDescriptions: + - >- + Not a legal value for DataType. Used to indicate a DataType field + has not been set. + - >- + Data types that all computation devices are expected to be capable + to support. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - format: google-datetime - description: >- - The earliest timestamp of stats being generated. If not set, - indicates fetching stats till the earliest possible one. - featureDisplayName: + int64Val: + type: array + items: + type: string + format: int64 + description: INT64 + tensorVal: + format: byte + description: Serialized raw tensor content. type: string - description: >- - The feature display name. If specified, only return the stats - belonging to this feature. Format: - ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, - example: "user_destination". - objectives: - description: Required. Objectives of the stats to retrieve. + floatVal: + description: FLOAT items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective + type: number + format: float type: array - pageToken: - description: >- - A page token received from a previous - JobService.SearchModelDeploymentMonitoringStatsAnomalies call. - type: string - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest - GoogleProtobufEmpty: - id: GoogleProtobufEmpty - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - GoogleCloudAiplatformV1ExactMatchMetricValue: - description: Exact match metric value for an instance. - type: object - id: GoogleCloudAiplatformV1ExactMatchMetricValue - properties: - score: - type: number - description: Output only. Exact match score. - format: float - readOnly: true - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource: - properties: - uri: + shape: + description: Shape of the tensor. + items: + format: int64 + type: string + type: array + doubleVal: + description: DOUBLE + type: array + items: + format: double + type: number + stringVal: items: type: string + type: array + description: STRING + boolVal: + type: array description: >- - Cloud Storage URI of one or more files. Only CSV files are - supported. The first line of the CSV file is used as the header. If - there are multiple files, the header is the first line of the - lexicographically first file, the other files must either contain - the exact same header or omit the header. + Type specific representations that make it easy to create tensor + protos in all languages. Only the representation corresponding to + "dtype" can be set. The values hold the flattened representation of + the tensor in row major order. BOOL + items: + type: boolean + intVal: + items: + type: integer + format: int32 + description: INT_8 INT_16 INT_32 type: array - type: object - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource - GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest: - id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest + uintVal: + description: UINT8 UINT16 UINT32 + type: array + items: + type: integer + format: uint32 + GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec: + description: >- + Configuration for ConvexAutomatedStoppingSpec. When there are enough + completed trials (configured by min_measurement_count), for pending + trials with enough measurements and steps, the policy first computes an + overestimate of the objective value at max_num_steps according to the + slope of the incomplete objective value curve. No prediction can be made + if the curve is completely flat. If the overestimation is worse than the + best objective value of the completed trials, this pending trial will be + early-stopped, but a last measurement will be added to the pending trial + with max_num_steps and predicted objective value from the autoregression + model. properties: - filter: + maxStepCount: + description: >- + Steps used in predicting the final objective for early stopped + trials. In general, it's set to be the same as the defined steps in + training / tuning. If not defined, it will learn it from the + completed trials. When use_steps is false, this field is set to the + maximum elapsed seconds. + format: int64 type: string + updateAllStoppedTrials: + type: boolean description: >- - Exports the TensorboardTimeSeries' data that match the filter - expression. - pageSize: + ConvexAutomatedStoppingSpec by default only updates the trials that + needs to be early stopped using a newly trained auto-regressive + model. When this flag is set to True, all stopped trials from the + beginning are potentially updated in terms of their + `final_measurement`. Also, note that the training logic of + autoregressive models is different in this case. Enabling this + option has shown better results and this may be the default option + in the future. + minStepCount: + format: int64 + type: string description: >- - The maximum number of data points to return per page. The default - page_size is 1000. Values must be between 1 and 10000. Values above - 10000 are coerced to 10000. - type: integer - format: int32 - orderBy: + Minimum number of steps for a trial to complete. Trials which do not + have a measurement with step_count > min_step_count won't be + considered for early stopping. It's ok to set it to 0, and a trial + can be early stopped at any stage. By default, min_step_count is set + to be one-tenth of the max_step_count. When use_elapsed_duration is + true, this field is set to the minimum elapsed seconds. + learningRateParameterName: description: >- - Field to use to sort the TensorboardTimeSeries' data. By default, - TensorboardTimeSeries' data is returned in a pseudo random order. + The hyper-parameter name used in the tuning job that stands for + learning rate. Leave it blank if learning rate is not in a parameter + in tuning. The learning_rate is used to estimate the objective value + of the ongoing trial. type: string - pageToken: + useElapsedDuration: + type: boolean description: >- - A page token, received from a previous - ExportTensorboardTimeSeriesData call. Provide this to retrieve the - subsequent page. When paginating, all other parameters provided to - ExportTensorboardTimeSeriesData must match the call that provided - the page token. + This bool determines whether or not the rule is applied based on + elapsed_secs or steps. If use_elapsed_duration==false, the early + stopping decision is made according to the predicted objective + values according to the target steps. If use_elapsed_duration==true, + elapsed_secs is used instead of steps. Also, in this case, the + parameters max_num_steps and min_num_steps are overloaded to contain + max_elapsed_seconds and min_elapsed_seconds. + minMeasurementCount: + description: >- + The minimal number of measurements in a Trial. Early-stopping checks + will not trigger if less than min_measurement_count+1 completed + trials or pending trials with less than min_measurement_count + measurements. If not defined, the default value is 5. type: string - description: Request message for TensorboardService.ExportTensorboardTimeSeriesData. + format: int64 + id: GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec type: object - GoogleCloudAiplatformV1ExportModelOperationMetadata: + GoogleCloudAiplatformV1CreateTensorboardOperationMetadata: properties: genericMetadata: - description: The common part of the operation metadata. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - outputInfo: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo - description: >- - Output only. Information further describing the output of this Model - export. - readOnly: true - description: Details of ModelService.ExportModel operation. + description: Operation metadata for Tensorboard. + description: Details of operations that perform create Tensorboard. + type: object + id: GoogleCloudAiplatformV1CreateTensorboardOperationMetadata + GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata: + description: Details of operations that perform update PersistentResource. + id: GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata type: object - id: GoogleCloudAiplatformV1ExportModelOperationMetadata - GoogleCloudAiplatformV1TimeSeriesData: - id: GoogleCloudAiplatformV1TimeSeriesData properties: - valueType: - enumDescriptions: - - The value type is unspecified. - - >- - Used for TensorboardTimeSeries that is a list of scalars. E.g. - accuracy of a model over epochs/time. - - >- - Used for TensorboardTimeSeries that is a list of tensors. E.g. - histograms of weights of layer in a model over epoch/time. - - >- - Used for TensorboardTimeSeries that is a list of blob sequences. - E.g. set of sample images with labels over epochs/time. - description: >- - Required. Immutable. The value type of this time series. All the - values in this time series data must match this value type. - enum: - - VALUE_TYPE_UNSPECIFIED - - SCALAR - - TENSOR - - BLOB_SEQUENCE - type: string - tensorboardTimeSeriesId: + progressMessage: type: string - description: >- - Required. The ID of the TensorboardTimeSeries, which will become the - final component of the TensorboardTimeSeries' resource name - values: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' - type: array - description: Required. Data points in this time series. - description: All the data stored in a TensorboardTimeSeries. - type: object - GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail: + description: Progress Message for Update LRO + genericMetadata: + description: Operation metadata for PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1Explanation: type: object - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail - description: The detailed info for a custom job executor. + id: GoogleCloudAiplatformV1Explanation properties: - failedJobs: + neighbors: + type: array readOnly: true items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Neighbor' + description: >- + Output only. List of the nearest neighbors for example-based + explanations. For models deployed with the examples explanations + feature enabled, the attributions field is empty and instead the + neighbors field is populated. + attributions: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' type: array + readOnly: true description: >- - Output only. The names of the previously failed CustomJob. The list - includes the all attempts in chronological order. - job: + Output only. Feature attributions grouped by predicted outputs. For + Models that predict only one output, such as regression Models that + predict only one score, there is only one attibution that explains + the predicted output. For Models that predict multiple outputs, such + as multiclass Models that predict multiple classes, each element + explains one specific item. Attribution.output_index can be used to + identify which output this attribution is explaining. By default, we + provide Shapley values for the predicted class. However, you can + configure the explanation request to generate Shapley values for any + other classes too. For example, if a model predicts a probability of + `0.4` for approving a loan application, the model's decision is to + reject the application since `p(reject) = 0.6 > p(approve) = 0.4`, + and the default Shapley values would be computed for rejection + decision and not approval, even though the latter might be the + positive class. If users set ExplanationParameters.top_k, the + attributions are sorted by instance_output_value in descending + order. If ExplanationParameters.output_indices is specified, the + attributions are stored by Attribution.output_index in the same + order as they appear in the output_indices. + description: >- + Explanation of a prediction (provided in PredictResponse.predictions) + produced by the Model on a given instance. + GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly: + properties: + featureStatsAnomaly: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + readOnly: true + description: >- + Output only. The stats and anomalies generated at specific + timestamp. + objective: readOnly: true + enum: + - OBJECTIVE_UNSPECIFIED + - IMPORT_FEATURE_ANALYSIS + - SNAPSHOT_ANALYSIS type: string - description: Output only. The name of the CustomJob. - GoogleCloudAiplatformV1DirectPredictRequest: - id: GoogleCloudAiplatformV1DirectPredictRequest - properties: - parameters: - description: The parameters that govern the prediction. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - inputs: - description: The prediction input. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: Request message for PredictionService.DirectPredict. + enumDescriptions: + - If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty. + - Stats are generated by Import Feature Analysis. + - Stats are generated by Snapshot Analysis. + description: Output only. The objective for each stats. type: object - GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: - description: When manual routing is set, the specified model will be used directly. - id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode + description: >- + A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats + requested by user, sorted by FeatureStatsAnomaly.start_time descending. + id: GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + GoogleCloudAiplatformV1WriteFeatureValuesResponse: + description: >- + Response message for + FeaturestoreOnlineServingService.WriteFeatureValues. + id: GoogleCloudAiplatformV1WriteFeatureValuesResponse + type: object + properties: {} + GoogleCloudAiplatformV1Content: properties: - modelName: + role: type: string description: >- - The model name to use. Only the public LLM models are accepted. e.g. - 'gemini-1.5-pro-001'. - type: object - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList: - type: object - id: >- - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList - properties: - features: - description: List of feature names and values. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + Optional. The producer of the content. Must be either 'user' or + 'model'. Useful to set for multi-turn conversations, otherwise can + be left blank or unset. + parts: type: array + description: >- + Required. Ordered `Parts` that constitute a single message. Parts + may have different IANA MIME types. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' + type: object description: >- - Response structure in the format of key (feature name) and (feature) - value pair. - GoogleCloudAiplatformV1FunctionDeclaration: + The base structured datatype containing multi-part content of a message. + A `Content` includes a `role` field designating the producer of the + `Content` and a `parts` field containing multi-part data that contains + the content of the message turn. + id: GoogleCloudAiplatformV1Content + GoogleCloudAiplatformV1Schedule: + description: >- + An instance of a Schedule periodically schedules runs to make API calls + based on user specified time specification and API request type. + id: GoogleCloudAiplatformV1Schedule properties: - parameters: - description: >- - Optional. Describes the parameters to this function in JSON Schema - Object format. Reflects the Open API 3.03 Parameter Object. string - Key: the name of the parameter. Parameter names are case sensitive. - Schema Value: the Schema defining the type used for the parameter. - For function with no parameters, this can be left unset. Parameter - names must start with a letter or an underscore and must only - contain chars a-z, A-Z, 0-9, or underscores with a maximum length of - 64. Example with 1 required and 1 optional parameter: type: OBJECT - properties: param1: type: STRING param2: type: INTEGER required: - - param1 - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - name: + lastPauseTime: type: string + format: google-datetime + readOnly: true description: >- - Required. The name of the function to call. Must start with a letter - or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, - dots and dashes, with a maximum length of 64. - description: + Output only. Timestamp when this Schedule was last paused. Unset if + never paused. + displayName: type: string description: >- - Optional. Description and purpose of the function. Model uses it to - decide how and whether to call the function. - response: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + Required. User provided name of the Schedule. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + nextRunTime: description: >- - Optional. Describes the output from this function in JSON Schema - format. Reflects the Open API 3.03 Response Object. The Schema - defines the type used for the response value of the function. - description: >- - Structured representation of a function declaration as defined by the - [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). - Included in this declaration are the function name and parameters. This - FunctionDeclaration is a representation of a block of code that can be - used as a `Tool` by the model and executed by the client. - type: object - id: GoogleCloudAiplatformV1FunctionDeclaration - GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry: - properties: - inlineContext: + Output only. Timestamp when this Schedule should schedule the next + run. Having a next_run_time in the past means the runs are being + started behind schedule. type: string + readOnly: true + format: google-datetime + lastScheduledRunResponse: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ScheduleRunResponse' description: >- - The grounding text passed inline with the Predict API. It can - support up to 1 million bytes. - enterpriseDatastore: - deprecated: true + Output only. Response of the last scheduled run. This is the + response for starting the scheduled requests and not the execution + of the operations/jobs created by the requests (if applicable). + Unset if no run has been scheduled yet. + allowQueueing: description: >- - The uri of the Vertex AI Search data source. Deprecated. Use - vertex_ai_search_datastore instead. - type: string - vertexAiSearchDatastore: - type: string - description: The uri of the Vertex AI Search data source. - type: - enumDescriptions: - - '' - - Uses Web Search to check the grounding. - - >- - Uses Vertex AI Search to check the grounding. Deprecated. Use - VERTEX_AI_SEARCH instead. - - Uses Vertex AI Search to check the grounding - - Uses inline context to check the grounding. - description: The type of the grounding checking source. - enum: - - UNSPECIFIED - - WEB - - ENTERPRISE - - VERTEX_AI_SEARCH - - INLINE - type: string - enumDeprecated: - - false - - false - - true - - false - - false - id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry - description: Single source entry for the grounding checking. - type: object - GoogleCloudAiplatformV1Retrieval: - properties: - vertexAiSearch: - description: Set to use data source powered by Vertex AI Search. - $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' - disableAttribution: + Optional. Whether new scheduled runs can be queued when + max_concurrent_runs limit is reached. If set to true, new runs will + be queued instead of skipped. Default to false. type: boolean - description: Optional. Deprecated. This option is no longer supported. - deprecated: true - vertexRagStore: - $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexRagStore' + createTime: + readOnly: true + description: Output only. Timestamp when this Schedule was created. + format: google-datetime + type: string + startedRunCount: + readOnly: true + format: int64 + type: string + description: Output only. The number of runs started by this schedule. + lastResumeTime: + format: google-datetime + readOnly: true description: >- - Set to use data source powered by Vertex RAG store. User data is - uploaded via the VertexRagDataService. - id: GoogleCloudAiplatformV1Retrieval - type: object - description: >- - Defines a retrieval tool that model can call to access external - knowledge. - GoogleCloudAiplatformV1SafetySetting: - description: Safety settings. - id: GoogleCloudAiplatformV1SafetySetting - type: object - properties: - method: - 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. + Output only. Timestamp when this Schedule was last resumed. Unset if + never resumed from pause. + type: string + cron: type: string description: >- - Optional. Specify if the threshold is used for probability or - severity score. If not specified, the threshold is used for - probability score. - category: - enumDescriptions: - - The harm category is unspecified. - - The harm category is hate speech. - - The harm category is dangerous content. - - The harm category is harassment. - - The harm category is sexually explicit content. - - The harm category is civic integrity. - description: Required. Harm category. - enum: - - HARM_CATEGORY_UNSPECIFIED - - HARM_CATEGORY_HATE_SPEECH - - HARM_CATEGORY_DANGEROUS_CONTENT - - HARM_CATEGORY_HARASSMENT - - HARM_CATEGORY_SEXUALLY_EXPLICIT - - HARM_CATEGORY_CIVIC_INTEGRITY + Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch + scheduled runs. To explicitly set a timezone to the cron tab, apply + a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * + * *". + endTime: + description: >- + Optional. Timestamp after which no new runs can be scheduled. If + specified, The schedule will be completed when either end_time is + reached or when scheduled_run_count >= max_run_count. If not + specified, new runs will keep getting scheduled until this Schedule + is paused or deleted. Already scheduled runs will be allowed to + complete. Unset if not specified. + format: google-datetime type: string - threshold: - enumDescriptions: - - Unspecified harm block threshold. - - Block low threshold and above (i.e. block more). - - Block medium threshold and above. - - Block only high threshold (i.e. block less). - - Block none. - - Turn off the safety filter. + createNotebookExecutionJobRequest: + description: Request for NotebookService.CreateNotebookExecutionJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest + catchUp: + type: boolean + description: >- + Output only. Whether to backfill missed runs when the schedule is + resumed from PAUSED state. If set to true, all missed runs will be + scheduled. New runs will be scheduled after the backfill is + complete. Default to false. + readOnly: true + maxConcurrentRunCount: + format: int64 + description: >- + Required. Maximum number of runs that can be started concurrently + for this Schedule. This is the limit for starting the scheduled + requests and not the execution of the operations/jobs created by the + requests (if applicable). type: string + state: + enumDescriptions: + - Unspecified. + - >- + The Schedule is active. Runs are being scheduled on the + user-specified timespec. + - >- + The schedule is paused. No new runs will be created until the + schedule is resumed. Already started runs will be allowed to + complete. + - >- + The Schedule is completed. No new runs will be scheduled. Already + started runs will be allowed to complete. Schedules in completed + state cannot be paused or resumed. enum: - - HARM_BLOCK_THRESHOLD_UNSPECIFIED - - BLOCK_LOW_AND_ABOVE - - BLOCK_MEDIUM_AND_ABOVE - - BLOCK_ONLY_HIGH - - BLOCK_NONE - - 'OFF' - description: Required. The harm block threshold. - GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling: - id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling - type: object - properties: - minNodeCount: + - STATE_UNSPECIFIED + - ACTIVE + - PAUSED + - COMPLETED + readOnly: true + type: string + description: Output only. The state of this Schedule. + maxRunCount: + format: int64 description: >- - Required. The minimum number of nodes to scale down to. Must be - greater than or equal to 1. - type: integer - format: int32 - maxNodeCount: + Optional. Maximum run count of the schedule. If specified, The + schedule will be completed when either started_run_count >= + max_run_count or when end_time is reached. If not specified, new + runs will keep getting scheduled until this Schedule is paused or + deleted. Already scheduled runs will be allowed to complete. Unset + if not specified. + type: string + startTime: + type: string description: >- - The maximum number of nodes to scale up to. Must be greater than - min_node_count, and less than or equal to 10 times of - 'min_node_count'. - type: integer - format: int32 - cpuUtilizationTarget: + Optional. Timestamp after which the first run can be scheduled. + Default to Schedule create time if not specified. + format: google-datetime + name: + description: Immutable. The resource name of the Schedule. + type: string + createPipelineJobRequest: description: >- - Optional. The cpu utilization that the Autoscaler should be trying - to achieve. This number is on a scale from 0 (no utilization) to 100 - (total utilization), and is limited between 10 and 80. When a - cluster's CPU utilization exceeds the target that you have set, - Bigtable immediately adds nodes to the cluster. When CPU utilization - is substantially lower than the target, Bigtable removes nodes. If - not set or set to 0, default to 50. - type: integer - format: int32 - description: >- - Online serving scaling configuration. If min_node_count and - max_node_count are set to the same value, the cluster will be configured - with the fixed number of node (no auto-scaling). - GoogleCloudAiplatformV1ExportModelRequest: - properties: - outputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportModelRequestOutputConfig - description: Required. The desired output location and configuration. - type: object - description: Request message for ModelService.ExportModel. - id: GoogleCloudAiplatformV1ExportModelRequest - GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData: + Request for PipelineService.CreatePipelineJob. + CreatePipelineJobRequest.parent field is required (format: + projects/{project}/locations/{location}). + $ref: '#/components/schemas/GoogleCloudAiplatformV1CreatePipelineJobRequest' + updateTime: + readOnly: true + type: string + format: google-datetime + description: Output only. Timestamp when this Schedule was updated. type: object + GoogleCloudAiplatformV1SummarizationHelpfulnessInstance: properties: - username: + instruction: type: string - description: User's username - viewCount: + description: Optional. Summarization prompt for LLM. + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + prediction: + description: Required. Output of the evaluated model. + type: string + context: + description: Required. Text to be summarized. type: string - description: Number of times the user has read data within the Tensorboard. - format: int64 - description: Per user usage data. - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData - GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec: - type: object - description: Spec for question answering relevance metric. - properties: - version: - format: int32 - description: Optional. Which version to use for evaluation. - type: integer - useReference: - type: boolean - description: >- - Optional. Whether to use instance.reference to compute question - answering relevance. - id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask: - properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata - description: The metadata information. - inputs: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: The input parameters of this CustomTask. - description: A TrainingJob that trains a custom code Model. - type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables: - description: A TrainingJob that trains and uploads an AutoML Tables Model. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables type: object - properties: - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs - GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation: - description: Annotation details specific to video classification. + description: Spec for summarization helpfulness instance. + id: GoogleCloudAiplatformV1SummarizationHelpfulnessInstance + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization: type: object + id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization properties: - displayName: - type: string + clipPercentLowerbound: description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - timeSegment: + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. + type: number + format: float + overlayType: + enum: + - OVERLAY_TYPE_UNSPECIFIED + - NONE + - ORIGINAL + - GRAYSCALE + - MASK_BLACK + enumDescriptions: + - Default value. This is the same as NONE. + - No overlay. + - The attributions are shown on top of the original image. + - >- + The attributions are shown on top of grayscaled version of the + original image. + - >- + The attributions are used as a mask to reveal predictive parts of + the image and hide the un-predictive parts. description: >- - This Annotation applies to the time period represented by the - TimeSegment. If it's not set, the Annotation applies to the whole - video. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' - annotationSpecId: + How the original image is displayed in the visualization. Adjusting + the overlay can help increase visual clarity if the original image + makes it difficult to view the visualization. Defaults to NONE. + type: string + polarity: + enumDescriptions: + - Default value. This is the same as POSITIVE. + - >- + Highlights the pixels/outlines that were most influential to the + model's prediction. + - >- + Setting polarity to negative highlights areas that does not lead + to the models's current prediction. + - Shows both positive and negative attributions. type: string description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - id: GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation - GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: - description: Request message for ModelService.UpdateExplanationDataset. - id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest - type: object - properties: - examples: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' - description: The example config containing the location of the dataset. - GoogleCloudAiplatformV1FractionSplit: - properties: - validationFraction: - type: number - format: double + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + clipPercentUpperbound: + format: float description: >- - The fraction of the input data that is to be used to validate the - Model. - trainingFraction: - format: double + Excludes attributions above the specified percentile from the + highlighted areas. Using the clip_percent_upperbound and + clip_percent_lowerbound together can be useful for filtering out + noise and making it easier to see areas of strong attribution. + Defaults to 99.9. type: number + type: description: >- - The fraction of the input data that is to be used to train the - Model. - testFraction: - type: number + Type of the image visualization. Only applicable to Integrated + Gradients attribution. OUTLINES shows regions of attribution, while + PIXELS shows per-pixel attribution. Defaults to OUTLINES. + enum: + - TYPE_UNSPECIFIED + - PIXELS + - OUTLINES + enumDescriptions: + - Should not be used. + - Shows which pixel contributed to the image prediction. + - >- + Shows which region contributed to the image prediction by + outlining the region. + type: string + colorMap: + enumDescriptions: + - Should not be used. + - 'Positive: green. Negative: pink.' + - >- + Viridis color map: A perceptually uniform color mapping which is + easier to see by those with colorblindness and progresses from + yellow to green to blue. Positive: yellow. Negative: blue. + - 'Positive: red. Negative: red.' + - 'Positive: green. Negative: green.' + - 'Positive: green. Negative: red.' + - PiYG palette. description: >- - The fraction of the input data that is to be used to evaluate the - Model. - format: double - description: >- - Assigns the input data to training, validation, and test sets as per the - given fractions. Any of `training_fraction`, `validation_fraction` and - `test_fraction` may optionally be provided, they must sum to up to 1. If - the provided ones sum to less than 1, the remainder is assigned to sets - as decided by Vertex AI. If none of the fractions are set, by default - roughly 80% of data is used for training, 10% for validation, and 10% - for test. - id: GoogleCloudAiplatformV1FractionSplit - type: object - GoogleCloudAiplatformV1SummarizationVerbosityResult: - description: Spec for summarization verbosity result. - id: GoogleCloudAiplatformV1SummarizationVerbosityResult - type: object + The color scheme used for the highlighted areas. Defaults to + PINK_GREEN for Integrated Gradients attribution, which shows + positive attributions in green and negative in pink. Defaults to + VIRIDIS for XRAI attribution, which highlights the most influential + regions in yellow and the least influential in blue. + type: string + enum: + - COLOR_MAP_UNSPECIFIED + - PINK_GREEN + - VIRIDIS + - RED + - GREEN + - RED_GREEN + - PINK_WHITE_GREEN + description: Visualization configurations for image explanation. + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult: properties: - score: + explanation: + type: string + description: Output only. Explanation for question answering quality score. readOnly: true - description: Output only. Summarization Verbosity score. + confidence: + description: Output only. Confidence for question answering quality score. type: number format: float - confidence: readOnly: true - description: Output only. Confidence for summarization verbosity score. - format: float - type: number - explanation: - type: string - description: Output only. Explanation for summarization verbosity score. + pairwiseChoice: + enumDescriptions: + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined readOnly: true - GoogleCloudAiplatformV1MetadataStoreDataplexConfig: + description: Output only. Pairwise question answering prediction choice. + enum: + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE + type: string type: object - id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig + description: Spec for pairwise question answering quality result. + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation: properties: - enabledPipelinesLineage: - type: boolean - description: >- - Optional. Whether or not Data Lineage synchronization is enabled for - Vertex Pipelines. - description: Represents Dataplex integration settings. - GoogleCloudAiplatformV1CancelTrainingPipelineRequest: - properties: {} - type: object - id: GoogleCloudAiplatformV1CancelTrainingPipelineRequest - description: Request message for PipelineService.CancelTrainingPipeline. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata: - description: Model metadata specific to AutoML Forecasting. + columnName: + type: string id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation + type: object + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. + GoogleCloudAiplatformV1ExplanationMetadataInputMetadata: + id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadata + description: >- + Metadata of the input of a feature. Fields other than + InputMetadata.input_baselines are applicable only for Models that are + using Vertex AI-provided images for Tensorflow. type: object properties: - trainCostMilliNodeHours: + encodedTensorName: description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - format: int64 - type: string - evaluatedDataItemsBigqueryUri: - description: BigQuery destination uri for exported evaluated examples. + Encoded tensor is a transformation of the input tensor. Must be + provided if choosing Integrated Gradients attribution or XRAI + attribution and the input tensor is not differentiable. An encoded + tensor is generated if the input tensor is encoded by a lookup + table. type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - properties: - trainerType: - enumDescriptions: - - Default value. - - '' - - '' + denseShapeTensorName: type: string + description: >- + Specifies the shape of the values of the input if the input is a + sparse representation. Refer to Tensorflow documentation for more + details: + https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. + encoding: enum: - - TRAINER_TYPE_UNSPECIFIED - - AUTOML_TRAINER - - MODEL_GARDEN_TRAINER - checkpointName: + - ENCODING_UNSPECIFIED + - IDENTITY + - BAG_OF_FEATURES + - BAG_OF_FEATURES_SPARSE + - INDICATOR + - COMBINED_EMBEDDING + - CONCAT_EMBEDDING type: string + enumDescriptions: + - Default value. This is the same as IDENTITY. + - The tensor represents one feature. + - >- + The tensor represents a bag of features where each index maps to a + feature. InputMetadata.index_feature_mapping must be provided for + this encoding. For example: ``` input = [27, 6.0, 150] + index_feature_mapping = ["age", "height", "weight"] ``` + - >- + The tensor represents a bag of features where each index maps to a + feature. Zero values in the tensor indicates feature being + non-existent. InputMetadata.index_feature_mapping must be provided + for this encoding. For example: ``` input = [2, 0, 5, 0, 1] + index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + - >- + The tensor is a list of binaries representing whether a feature + exists or not (1 indicates existence). + InputMetadata.index_feature_mapping must be provided for this + encoding. For example: ``` input = [1, 0, 1, 0, 1] + index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + - >- + The tensor is encoded into a 1-dimensional array represented by an + encoded tensor. InputMetadata.encoded_tensor_name must be provided + for this encoding. For example: ``` input = ["This", "is", "a", + "test", "."] encoded = [0.1, 0.2, 0.3, 0.4, 0.5] ``` + - >- + Select this encoding when the input tensor is encoded into a + 2-dimensional array represented by an encoded tensor. + InputMetadata.encoded_tensor_name must be provided for this + encoding. The first dimension of the encoded tensor's shape is the + same as the input tensor's shape. For example: ``` input = + ["This", "is", "a", "test", "."] encoded = [[0.1, 0.2, 0.3, 0.4, + 0.5], [0.2, 0.1, 0.4, 0.3, 0.5], [0.5, 0.1, 0.3, 0.5, 0.4], [0.5, + 0.3, 0.1, 0.2, 0.4], [0.4, 0.3, 0.2, 0.5, 0.1]] ``` description: >- - Optional. An unique name of pretrained model checkpoint provided in - model garden, it will be mapped to a GCS location internally. - trainerConfig: - additionalProperties: - type: string - description: Customizable trainer settings, used in the `model_garden_trainer`. - type: object - studySpec: + Defines how the feature is encoded into the input tensor. Defaults + to IDENTITY. + modality: + type: string description: >- - Optioinal. StudySpec of hyperparameter tuning job. Required for - `model_garden_trainer`. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - datasetConfig: - type: object - description: Customizable dataset settings, used in the `model_garden_trainer`. - additionalProperties: - type: string - description: >- - A wrapper class which contains the tunable parameters in an AutoML Image - training job. - type: object - GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries: - type: object - properties: - timestampColumn: + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. + indicesTensorName: type: string description: >- - Optional. Column hosting timestamp values for a time-series source. - Will be used to determine the latest `feature_values` for each - entity. Optional. If not provided, column named `feature_timestamp` - of type `TIMESTAMP` will be used. - id: GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries - GoogleCloudAiplatformV1CsvSource: - type: object - description: The storage details for CSV input content. - properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: Required. Google Cloud Storage location. - id: GoogleCloudAiplatformV1CsvSource - GoogleCloudAiplatformV1IndexStats: - type: object - properties: - sparseVectorsCount: - format: int64 - readOnly: true + Specifies the index of the values of the input tensor. Required when + the input tensor is a sparse representation. Refer to Tensorflow + documentation for more details: + https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. + groupName: + description: >- + Name of the group that the input belongs to. Features with the same + group name will be treated as one feature when computing + attributions. Features grouped together can have different shapes in + value. If provided, there will be one single attribution generated + in Attribution.feature_attributions, keyed by the group name. type: string - description: Output only. The number of sparse vectors in the Index. - vectorsCount: - format: int64 + inputTensorName: type: string - readOnly: true - description: Output only. The number of dense vectors in the Index. - shardsCount: - format: int32 - description: Output only. The number of shards in the Index. - type: integer - readOnly: true - id: GoogleCloudAiplatformV1IndexStats - description: Stats of the Index. - GoogleCloudAiplatformV1EntityIdSelector: - properties: - csvSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - description: Source of Csv - entityIdField: description: >- - Source column that holds entity IDs. If not provided, entity IDs are - extracted from the column named entity_id. - type: string - id: GoogleCloudAiplatformV1EntityIdSelector - type: object - description: Selector for entityId. Getting ids from the given source. - GoogleCloudAiplatformV1FindNeighborsRequest: - description: The request message for MatchService.FindNeighbors. - properties: - queries: + Name of the input tensor for this feature. Required and is only + applicable to Vertex AI-provided images for Tensorflow. + featureValueDomain: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + description: >- + The domain details of the input feature value. Like min/max, + original mean or standard deviation if normalized. + inputBaselines: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQuery + type: any type: array - description: The list of queries. - deployedIndexId: - type: string description: >- - The ID of the DeployedIndex that will serve the request. This - request is sent to a specific IndexEndpoint, as per the - IndexEndpoint.network. That IndexEndpoint also has - IndexEndpoint.deployed_indexes, and each such index has a - DeployedIndex.id field. The value of the field below must equal one - of the DeployedIndex.id fields of the IndexEndpoint that is being - called for this request. - returnFullDatapoint: - type: boolean + Baseline inputs for this feature. If no baseline is specified, + Vertex AI chooses the baseline for this feature. If multiple + baselines are specified, Vertex AI returns the average attributions + across them in Attribution.feature_attributions. For Vertex + AI-provided Tensorflow images (both 1.x and 2.x), the shape of each + baseline must match the shape of the input tensor. If a scalar is + provided, we broadcast to the same shape as the input tensor. For + custom images, the element of the baselines must be in the same + format as the feature's input in the instance[]. The schema of any + single instance may be specified via Endpoint's DeployedModels' + Model's PredictSchemata's instance_schema_uri. + encodedBaselines: + items: + type: any description: >- - If set to true, the full datapoints (including all vector values and - restricts) of the nearest neighbors are returned. Note that - returning full datapoint will significantly increase the latency and - cost of the query. - type: object - id: GoogleCloudAiplatformV1FindNeighborsRequest - GoogleCloudAiplatformV1CustomJob: - properties: - webAccessUris: - readOnly: true - additionalProperties: - type: string + A list of baselines for the encoded tensor. The shape of each + baseline should match the shape of the encoded tensor. If a scalar + is provided, Vertex AI broadcasts to the same shape as the encoded + tensor. + type: array + visualization: + description: Visualization configurations for image explanation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization + indexFeatureMapping: + type: array description: >- - Output only. URIs for accessing [interactive - shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - (one URI for each training node). Only available if - job_spec.enable_web_access is `true`. The keys are names of each - node in the training job; for example, `workerpool0-0` for the - primary node, `workerpool1-0` for the first node in the second - worker pool, and `workerpool1-1` for the second node in the second - worker pool. The values are the URIs for each node's interactive - shell. - type: object - endTime: + A list of feature names for each index in the input tensor. Required + when the input InputMetadata.encoding is BAG_OF_FEATURES, + BAG_OF_FEATURES_SPARSE, INDICATOR. + items: + type: string + GoogleCloudAiplatformV1TimeSeriesData: + description: All the data stored in a TensorboardTimeSeries. + properties: + values: + type: array + description: Required. Data points in this time series. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + tensorboardTimeSeriesId: type: string description: >- - Output only. Time when the CustomJob entered any of the following - states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - readOnly: true - format: google-datetime - state: - readOnly: true - type: string - description: Output only. The detailed state of the job. + Required. The ID of the TensorboardTimeSeries, which will become the + final component of the TensorboardTimeSeries' resource name + valueType: enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED + - VALUE_TYPE_UNSPECIFIED + - SCALAR + - TENSOR + - BLOB_SEQUENCE enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. + - The value type is unspecified. - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. + Used for TensorboardTimeSeries that is a list of scalars. E.g. + accuracy of a model over epochs/time. - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. + Used for TensorboardTimeSeries that is a list of tensors. E.g. + histograms of weights of layer in a model over epoch/time. - >- - The job is partially succeeded, some results may be missing due to - errors. - startTime: + Used for TensorboardTimeSeries that is a list of blob sequences. + E.g. set of sample images with labels over epochs/time. + description: >- + Required. Immutable. The value type of this time series. All the + values in this time series data must match this value type. type: string + type: object + id: GoogleCloudAiplatformV1TimeSeriesData + GoogleCloudAiplatformV1ImportFeatureValuesRequest: + properties: + featureSpecs: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec description: >- - Output only. Time when the CustomJob for the first time entered the - `JOB_STATE_RUNNING` state. - format: google-datetime - readOnly: true - name: + Required. Specifications defining which Feature values to import + from the entity. The request fails if no feature_specs are provided, + and having multiple feature_specs for one Feature is not allowed. + entityIdField: + description: >- + Source column that holds entity IDs. If not provided, entity IDs are + extracted from the column named entity_id. type: string - readOnly: true - description: Output only. Resource name of a CustomJob. - jobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: Required. Job spec. - updateTime: - readOnly: true + featureTime: + description: >- + Single Feature timestamp for all entities being imported. The + timestamp must not have higher than millisecond precision. format: google-datetime - description: Output only. Time when the CustomJob was most recently updated. type: string - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true + featureTimeField: + description: >- + Source column that holds the Feature timestamp for all Feature + values in each entity. + type: string + disableOnlineServing: type: boolean - displayName: description: >- - Required. The display name of the CustomJob. The name can be up to - 128 characters long and can consist of any UTF-8 characters. + If set, data will not be imported for online serving. This is + typically used for backfilling, where Feature generation timestamps + are not in the timestamp range needed for online serving. + workerCount: + format: int32 + type: integer + description: >- + Specifies the number of workers that are used to write data to the + Featurestore. Consider the online serving capacity that you require + to achieve the desired import throughput without interfering with + online serving. The value must be positive, and less than or equal + to 100. If not set, defaults to using 1 worker. The low count + ensures minimal impact on online serving performance. + csvSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + disableIngestionAnalysis: + description: If true, API doesn't start ingestion analysis pipeline. + type: boolean + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + avroSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AvroSource' + id: GoogleCloudAiplatformV1ImportFeatureValuesRequest + description: Request message for FeaturestoreService.ImportFeatureValues. + type: object + GoogleCloudAiplatformV1TrainingPipeline: + type: object + id: GoogleCloudAiplatformV1TrainingPipeline + description: >- + The TrainingPipeline orchestrates tasks associated with training a + Model. It always executes the training task, and optionally may also + export data from Vertex AI's Dataset which becomes the training input, + upload the Model to Vertex AI, and evaluate the Model. + properties: + displayName: + description: Required. The user-defined name of this TrainingPipeline. type: string - satisfiesPzs: + state: + enumDescriptions: + - The pipeline state is unspecified. + - >- + The pipeline has been created or resumed, and processing has not + yet begun. + - The service is preparing to run the pipeline. + - The pipeline is in progress. + - The pipeline completed successfully. + - The pipeline failed. + - >- + The pipeline is being cancelled. From this state, the pipeline may + only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED + or PIPELINE_STATE_CANCELLED. + - The pipeline has been cancelled. + - The pipeline has been stopped, and can be resumed. + type: string + enum: + - PIPELINE_STATE_UNSPECIFIED + - PIPELINE_STATE_QUEUED + - PIPELINE_STATE_PENDING + - PIPELINE_STATE_RUNNING + - PIPELINE_STATE_SUCCEEDED + - PIPELINE_STATE_FAILED + - PIPELINE_STATE_CANCELLING + - PIPELINE_STATE_CANCELLED + - PIPELINE_STATE_PAUSED + description: Output only. The detailed state of the pipeline. readOnly: true - description: Output only. Reserved for future use. - type: boolean labels: - type: object description: >- - The labels with user-defined metadata to organize CustomJobs. Label - keys and values can be no longer than 64 characters (Unicode + The labels with user-defined metadata to organize TrainingPipelines. + Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. + type: object additionalProperties: type: string - error: + modelId: + type: string description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. The ID to use for the uploaded Model, which will become + the final component of the model 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. + updateTime: + description: >- + Output only. Time when the TrainingPipeline was most recently + updated. readOnly: true - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + type: string + format: google-datetime + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Customer-managed encryption key options for a CustomJob. If this is - set, then all resources created by the CustomJob will be encrypted - with the provided encryption key. + Output only. Only populated when the pipeline's state is + `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. + readOnly: true createTime: + description: Output only. Time when the TrainingPipeline was created. + readOnly: true type: string format: google-datetime + trainingTaskMetadata: + description: >- + Output only. The metadata information as specified in the + training_task_definition's `metadata`. This metadata is an auxiliary + runtime and final information about the training task. While the + pipeline is running this information is populated only at a best + effort basis. Only present if the pipeline's + training_task_definition contains `metadata` object. + type: any readOnly: true - description: Output only. Time when the CustomJob was created. - id: GoogleCloudAiplatformV1CustomJob - description: >- - Represents a job that runs custom workloads such as a Docker container - or a Python package. A CustomJob can have multiple worker pools and each - worker pool can have its own machine and input spec. A CustomJob will be - cleaned up once the job enters terminal state (failed or succeeded). - type: object - GoogleCloudAiplatformV1ListEndpointsResponse: - properties: - nextPageToken: - type: string + modelToUpload: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' description: >- - A token to retrieve the next page of results. Pass to - ListEndpointsRequest.page_token to obtain that page. - endpoints: - description: List of Endpoints in the requested page. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' - type: array - id: GoogleCloudAiplatformV1ListEndpointsResponse - type: object - description: Response message for EndpointService.ListEndpoints. - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation: - properties: - annotationSpecId: + Describes the Model that may be uploaded (via + ModelService.UploadModel) by this TrainingPipeline. The + TrainingPipeline's training_task_definition should make clear + whether this Model description should be populated, and if there are + any special requirements regarding how it should be filled. If + nothing is mentioned in the training_task_definition, then it should + be assumed that this field should not be filled and the training + task either uploads the Model without a need of this information, or + that training task does not support uploading a Model as part of the + pipeline. When the Pipeline's state becomes + `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded + into Vertex AI, then the model_to_upload's resource name is + populated. The Model is always uploaded into the Project and + Location in which this pipeline is. + name: type: string + readOnly: true + description: Output only. Resource name of the TrainingPipeline. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - displayName: - type: string + Customer-managed encryption key spec for a TrainingPipeline. If set, + this TrainingPipeline will be secured by this key. Note: Model + trained by this TrainingPipeline is also secured by this key if + model_to_upload is not set separately. + inputDataConfig: description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - vertexes: - description: >- - The vertexes are connected one by one and the last vertex is - connected to the first one to represent a polygon. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' - type: array - id: >- - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation - description: Represents a polygon in image. - type: object - GoogleCloudAiplatformV1FeatureOnlineStoreOptimized: - description: Optimized storage type - properties: {} - type: object - id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized - GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams: - type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams - description: Prediction model parameters for Image Classification. - properties: - confidenceThreshold: - type: number - format: float - description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - maxPredictions: - description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. If this number is very high, the Model may - return fewer predictions. Default value is 10. - type: integer - format: int32 - GoogleCloudAiplatformV1CustomJobSpec: - type: object - properties: - workerPoolSpecs: - description: >- - Required. The spec of the worker pools including machine type and - Docker image. All worker pools except the first one are optional and - can be skipped by providing an empty value. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' - models: - description: >- - Optional. The name of the Model resources for which to generate a - mapping to artifact URIs. Applicable only to some of the - Google-provided custom jobs. 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. - items: - type: string - type: array - tensorboard: - type: string - description: >- - Optional. The name of a Vertex AI Tensorboard resource to which this - CustomJob will upload Tensorboard logs. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}` - reservedIpRanges: - items: - type: string - type: array - description: >- - Optional. A list of names for the reserved ip ranges under the VPC - network that can be used for this job. If set, we will deploy the - job within the provided ip ranges. Otherwise, the job will be - deployed to any ip ranges under the provided VPC network. Example: - ['vertex-ai-ip-range']. - enableWebAccess: - description: >- - Optional. Whether you want Vertex AI to enable [interactive shell - access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - to training containers. If set to `true`, you can access interactive - shells at the URIs given by CustomJob.web_access_uris or - Trial.web_access_uris (within HyperparameterTuningJob.trials). - type: boolean - scheduling: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' - description: Scheduling options for a CustomJob. - experimentRun: + Specifies Vertex AI owned input data that may be used for training + the Model. The TrainingPipeline's training_task_definition should + make clear whether this config is used and if there are any special + requirements on how it should be filled. If nothing about this + config is mentioned in the training_task_definition, then it should + be assumed that the TrainingPipeline does not depend on this + configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1InputDataConfig' + startTime: + format: google-datetime + readOnly: true description: >- - Optional. The Experiment Run associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` + Output only. Time when the TrainingPipeline for the first time + entered the `PIPELINE_STATE_RUNNING` state. type: string - baseOutputDirectory: - description: >- - The Cloud Storage location to store the output of this CustomJob or - HyperparameterTuningJob. For HyperparameterTuningJob, the - baseOutputDirectory of each child CustomJob backing a Trial is set - to a subdirectory of name id under its parent - HyperparameterTuningJob's baseOutputDirectory. The following Vertex - AI environment variables will be passed to containers or python - modules when this field is set: For CustomJob: * AIP_MODEL_DIR = - `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * - AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of - HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * - AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = - `//logs/` - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - enableDashboardAccess: - description: >- - Optional. Whether you want Vertex AI to enable access to the - customized dashboard in training chief container. If set to `true`, - you can access the dashboard at the URIs given by - CustomJob.web_access_uris or Trial.web_access_uris (within - HyperparameterTuningJob.trials). - type: boolean - persistentResourceId: + trainingTaskDefinition: description: >- - Optional. The ID of the PersistentResource in the same Project and - Location which to run If this is specified, the job will be run on - existing machines held by the PersistentResource instead of - on-demand short-live machines. The network and CMEK configs on the - job should be consistent with those on the PersistentResource, - otherwise, the job will be rejected. + Required. A Google Cloud Storage path to the YAML file that defines + the training task which is responsible for producing the model + artifact, and may also include additional auxiliary work. The + definition files that can be used here are found in + gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. type: string - network: + endTime: + format: google-datetime description: >- - Optional. The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to which - the Job should be peered. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - To specify this field, you must have already [configured VPC Network - Peering for Vertex - AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If - this field is left unspecified, the job is not peered with any - network. - type: string - protectedArtifactLocationId: + Output only. Time when the TrainingPipeline entered any of the + following states: `PIPELINE_STATE_SUCCEEDED`, + `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. type: string + readOnly: true + parentModel: description: >- - The ID of the location to store protected artifacts. e.g. - us-central1. Populate only when the location is different than - CustomJob location. List of supported locations: - https://cloud.google.com/vertex-ai/docs/general/locations - serviceAccount: - description: >- - Specifies the service account for workload run-as account. Users - submitting jobs must have act-as permission on this run-as account. - If unspecified, the [Vertex AI Custom Code Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) - for the CustomJob's project is used. - type: string - experiment: + Optional. When specify this field, the `model_to_upload` will not be + uploaded as a new model, instead, it will become a new version of + this `parent_model`. type: string + trainingTaskInputs: description: >- - Optional. The Experiment associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` - description: Represents the spec of a CustomJob. - id: GoogleCloudAiplatformV1CustomJobSpec - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity: + Required. The training task's parameter(s), as specified in the + training_task_definition's `inputs`. + type: any + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation: + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. properties: - unit: - description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" - type: string - quantity: - format: int64 - description: >- - The number of granularity_units between data points in the training - data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. - For all other values of `granularity_unit`, must be 1. + columnName: type: string - description: A duration of time expressed in time granularity units. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation type: object - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity: - id: GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata: + id: GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata properties: - entityIdSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityIdSelector' + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + specialistPool: + type: string description: >- - Required. Selectors choosing feature values of which entity id to be - deleted from the EntityType. + Output only. The name of the SpecialistPool to which the specialists + are being added. Format: + `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` + readOnly: true description: >- - Message to select entity. If an entity id is selected, all the feature - values corresponding to the entity id will be deleted, including the - entityId. + Runtime operation metadata for + SpecialistPoolService.UpdateSpecialistPool. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata: + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig: + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig + type: object + properties: + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + bigquerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource + description: >- + The tables Dataset's data source. The Dataset doesn't store the data + directly, but only pointer(s) to its data. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + type: object properties: - trainCostMilliNodeHours: - format: int64 - type: string + invalidValuesAllowed: + type: boolean description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - evaluatedDataItemsBigqueryUri: - description: BigQuery destination uri for exported evaluated examples. + If invalid values is allowed, the training pipeline will create a + boolean feature that indicated whether the value is valid. + Otherwise, the training pipeline will discard the input row from + trainining data. + columnName: type: string + description: >- + Treats the column as numerical array and performs following + transformation functions. * All transformations for Numerical types + applied to the average of the all elements. * The average of empty + arrays is treated as zero. + GoogleCloudAiplatformV1CountTokensResponse: + id: GoogleCloudAiplatformV1CountTokensResponse type: object - description: Model metadata specific to Seq2Seq Plus Forecasting. - GoogleCloudAiplatformV1ListSpecialistPoolsResponse: + description: Response message for PredictionService.CountTokens. properties: - specialistPools: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + totalBillableCharacters: description: >- - A list of SpecialistPools that matches the specified filter in the + The total number of billable characters counted across all instances + from the request. + format: int32 + type: integer + totalTokens: + format: int32 + description: >- + The total number of tokens counted across all instances from the request. - nextPageToken: - type: string - description: The standard List next-page token. - type: object - id: GoogleCloudAiplatformV1ListSpecialistPoolsResponse - description: Response message for SpecialistPoolService.ListSpecialistPools. - GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest: - type: object - properties: {} - description: Request message for JobService.PauseModelDeploymentMonitoringJob. - id: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest - GoogleCloudAiplatformV1DeployedIndexAuthConfig: - description: Used to set up the auth on the DeployedIndex's private endpoint. - id: GoogleCloudAiplatformV1DeployedIndexAuthConfig - properties: - authProvider: - description: Defines the authentication provider that the DeployedIndex uses. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider - type: object - GoogleCloudAiplatformV1ListMetadataStoresResponse: - description: Response message for MetadataService.ListMetadataStores. + type: integer + GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest: type: object - id: GoogleCloudAiplatformV1ListMetadataStoresResponse + id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest properties: - nextPageToken: + writeRunDataRequests: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest description: >- - A token, which can be sent as ListMetadataStoresRequest.page_token - to retrieve the next page. If this field is not populated, there are - no subsequent pages. - type: string - metadataStores: + Required. Requests containing per-run TensorboardTimeSeries data to + write. type: array - description: The MetadataStores found for the Location. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' - GoogleCloudAiplatformV1TimestampSplit: + description: Request message for TensorboardService.WriteTensorboardExperimentData. + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList: properties: - key: - description: >- - Required. The key is a name of one of the Dataset's data columns. - The values of the key (the values in the column) must be in RFC 3339 - `date-time` format, where `time-offset` = `"Z"` (e.g. - 1985-04-12T23:20:50.52Z). If for a piece of data the key is not - present or has an invalid value, that piece is ignored by the - pipeline. - type: string - testFraction: - description: >- - The fraction of the input data that is to be used to evaluate the - Model. - type: number - format: double - validationFraction: - description: >- - The fraction of the input data that is to be used to validate the - Model. - type: number - format: double - trainingFraction: - type: number - format: double - description: >- - The fraction of the input data that is to be used to train the - Model. + features: + description: List of feature names and values. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + type: array + description: >- + Response structure in the format of key (feature name) and (feature) + value pair. type: object - id: GoogleCloudAiplatformV1TimestampSplit + id: >- + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList + CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: description: >- - Assigns input data to training, validation, and test sets based on a - provided timestamps. The youngest data pieces are assigned to training - set, next to validation set, and the oldest to the test set. Supported - only for tabular Datasets. - GoogleCloudAiplatformV1NetworkSpec: - id: GoogleCloudAiplatformV1NetworkSpec + An integer bounding box of original pixels of the image for the detected + labels. type: object - description: Network spec. properties: - network: - description: >- - The full name of the Google Compute Engine - [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) + x1: + type: integer + format: int32 + description: The X coordinate of the top-left corner, in pixels. + x2: + format: int32 + description: The X coordinate of the bottom-right corner, in pixels. + type: integer + y2: + description: The Y coordinate of the bottom-right corner, in pixels. + type: integer + format: int32 + y1: + description: The Y coordinate of the top-left corner, in pixels. + format: int32 + type: integer + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData: + description: Per user usage data. + properties: + username: + description: User's username type: string - enableInternetAccess: - type: boolean - description: Whether to enable public internet access. Default false. - subnetwork: - description: >- - The name of the subnet that this instance is in. Format: - `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` + viewCount: + format: int64 type: string - GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo: - description: >- - Further describes the output of the ExportModel. Supplements - ExportModelRequest.OutputConfig. + description: Number of times the user has read data within the Tensorboard. + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData type: object + GoogleCloudAiplatformV1ListTensorboardRunsResponse: properties: - imageOutputUri: - readOnly: true - type: string + nextPageToken: description: >- - Output only. If the Model image is being exported to Google - Container Registry or Artifact Registry this is the full path of the - image created. - artifactOutputUri: - readOnly: true + A token, which can be sent as ListTensorboardRunsRequest.page_token + to retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: string + tensorboardRuns: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + description: The TensorboardRuns mathching the request. + id: GoogleCloudAiplatformV1ListTensorboardRunsResponse + description: Response message for TensorboardService.ListTensorboardRuns. + type: object + GoogleCloudAiplatformV1BigQueryDestination: + properties: + outputUri: type: string description: >- - Output only. If the Model artifact is being exported to Google Cloud - Storage this is the full path of the directory created, into which - the Model files are being written to. - id: GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo - GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata: - id: GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata + Required. BigQuery URI to a project or table, up to 2000 characters + long. When only the project is specified, the Dataset and Table is + created. When the full table reference is specified, the Dataset + must exist and table must not exist. Accepted forms: * BigQuery + path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` + or `bq://projectId.bqDatasetId.bqTableId`. type: object + id: GoogleCloudAiplatformV1BigQueryDestination + description: The BigQuery location for the output content. + GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: properties: genericMetadata: - description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Runtime operation information for EndpointService.MutateDeployedModel. + description: Operation metadata for Feature. + description: Details of operations that perform create FeatureGroup. + type: object + id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata GoogleCloudAiplatformV1CountTokensRequest: - id: GoogleCloudAiplatformV1CountTokensRequest + description: Request message for PredictionService.CountTokens. properties: - instances: - type: array + systemInstruction: description: >- - Optional. The instances that are the input to token counting call. - Schema is identical to the prediction schema of the underlying - model. - items: - type: any + Optional. The user provided system instructions for the model. Note: + only text should be used in parts and content in each part will be + in a separate paragraph. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' generationConfig: description: >- Optional. Generation config that the model will use to generate the response. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' - tools: + contents: + description: Optional. Input content. + type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + tools: + type: array description: >- Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. - type: array - systemInstruction: - description: >- - Optional. The user provided system instructions for the model. Note: - only text should be used in parts and content in each part will be - in a separate paragraph. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - contents: - type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: Optional. Input content. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' model: - type: string description: >- Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + type: string + instances: + items: + type: any + type: array + description: >- + Optional. The instances that are the input to token counting call. + Schema is identical to the prediction schema of the underlying + model. + id: GoogleCloudAiplatformV1CountTokensRequest type: object - description: Request message for PredictionService.CountTokens. - GoogleCloudAiplatformV1FeatureSelector: - description: Selector for Features of an EntityType. - type: object - id: GoogleCloudAiplatformV1FeatureSelector - properties: - idMatcher: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IdMatcher' - description: Required. Matches Features based on ID. - GoogleCloudAiplatformV1BatchDedicatedResources: - description: >- - A description of resources that are used for performing batch - operations, are dedicated to a Model, and need manual configuration. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics: properties: - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - description: Required. Immutable. The specification of a single machine. - maxReplicaCount: - format: int32 - type: integer + meanAveragePrecision: + description: The mean average precision. + type: number + format: float + precisionWindowLength: + format: google-duration description: >- - Immutable. The maximum number of machine replicas the batch - operation may be scaled to. The default value is 10. - startingReplicaCount: + This VideoActionMetrics is calculated based on this prediction + window length. If the predicted action's timestamp is inside the + time window whose center is the ground truth action's timestamp with + this specific length, the prediction result is treated as a true + positive. + type: string + confidenceMetrics: + type: array 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 - type: integer - format: int32 - id: GoogleCloudAiplatformV1BatchDedicatedResources + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics + description: The Evaluation metrics given a specific precision_window_length. type: object - GoogleCloudAiplatformV1SearchNearestEntitiesRequest: - description: The request message for FeatureOnlineStoreService.SearchNearestEntities. + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput: properties: - query: - description: Required. The query. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighborQuery' - returnFullEntity: - type: boolean - description: >- - Optional. If set to true, the full entities (including all vector - values and metadata) of the nearest neighbors are returned; - otherwise only entity id of the nearest neighbors will be returned. - Note that returning full entities will significantly increase the - latency and cost of the query. - id: GoogleCloudAiplatformV1SearchNearestEntitiesRequest + instance: + description: Required. Question answering correctness instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance + metricSpec: + description: Required. Spec for question answering correctness score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig: + description: Input for question answering correctness metric. + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs: properties: - explanationBaseline: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline - description: >- - Predictions generated by the BatchPredictionJob using baseline - dataset. - enableFeatureAttributes: - description: >- - If want to analyze the Vertex Explainable AI feature attribute - scores or not. If set to true, Vertex AI will log the feature - attributions from explain response and do the skew/drift detection - for them. + multiLabel: type: boolean + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs type: object - description: >- - The config for integrating with Vertex Explainable AI. Only applicable - if the Model has explanation_spec populated. - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig - GoogleCloudAiplatformV1EntityType: + GoogleCloudAiplatformV1ImportDataRequest: type: object - id: GoogleCloudAiplatformV1EntityType - description: >- - An entity type is a type of object in a system that needs to be modeled - and have stored information about. For example, driver is an entity - type, and driver0 is an instance of an entity type driver. + id: GoogleCloudAiplatformV1ImportDataRequest properties: - satisfiesPzi: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - monitoringConfig: + importConfigs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataConfig' description: >- - Optional. The default monitoring configuration for all Features with - value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under - this EntityType. If this is populated with - [FeaturestoreMonitoringConfig.monitoring_interval] specified, - snapshot analysis monitoring is enabled. Otherwise, snapshot - analysis monitoring is disabled. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfig - labels: - additionalProperties: + Required. The desired input locations. The contents of all input + locations will be imported in one batch. + type: array + description: Request message for DatasetService.ImportData. + GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata: + type: object + id: GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata + description: Details of operations that perform import Feature values. + properties: + importedFeatureValueCount: + type: string + format: int64 + description: Number of Feature values that have been imported by the operation. + blockingOperationIds: + items: type: string - type: object + format: int64 description: >- - Optional. The labels with user-defined metadata to organize your - EntityTypes. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one EntityType (System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - description: - description: Optional. Description of the EntityType. + List of ImportFeatureValues operations running under a single + EntityType that are blocking this operation. + type: array + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore import Feature values. + importedEntityCount: + description: Number of entities that have been imported by the operation. + format: int64 type: string - offlineStorageTtlDays: + sourceUris: + description: The source URI from where Feature values are imported. + items: + type: string + type: array + timestampOutsideRetentionRowsCount: + format: int64 description: >- - Optional. Config for data retention policy in offline storage. TTL - in days for feature values that will be stored in offline storage. - The Feature Store offline storage periodically removes obsolete - feature values older than `offline_storage_ttl_days` since the - feature generation time. If unset (or explicitly set to 0), default - to 4000 days TTL. - type: integer - format: int32 - createTime: - format: google-datetime - description: Output only. Timestamp when this EntityType was created. + The number rows that weren't ingested due to having timestamps + outside the retention boundary. type: string - readOnly: true - etag: + invalidRowCount: type: string description: >- - Optional. Used to perform a consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - satisfiesPzs: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - updateTime: + The number of rows in input source that weren't imported due to + either * Not having any featureValues. * Having a null entityId. * + Having a null timestamp. * Not being parsable (applicable for CSV + sources). + format: int64 + GoogleCloudAiplatformV1FetchFeatureValuesRequest: + type: object + properties: + dataFormat: + enumDescriptions: + - Not set. Will be treated as the KeyValue format. + - Return response data in key-value format. + - Return response data in proto Struct format. description: >- - Output only. Timestamp when this EntityType was most recently - updated. + Optional. Response data format. If not set, + FeatureViewDataFormat.KEY_VALUE will be used. + enum: + - FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED + - KEY_VALUE + - PROTO_STRUCT type: string - readOnly: true - format: google-datetime - name: + dataKey: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' + description: Optional. The request key to fetch feature values for. + id: GoogleCloudAiplatformV1FetchFeatureValuesRequest + description: >- + Request message for FeatureOnlineStoreService.FetchFeatureValues. All + the features under the requested feature view will be returned. + GoogleCloudAiplatformV1NfsMount: + type: object + id: GoogleCloudAiplatformV1NfsMount + description: Represents a mount configuration for Network File System (NFS) to mount. + properties: + mountPoint: 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. + Required. Destination mount path. The NFS will be mounted for the + user under /mnt/nfs/ type: string - GoogleCloudAiplatformV1ListIndexEndpointsResponse: - description: Response message for IndexEndpointService.ListIndexEndpoints. - properties: - nextPageToken: + path: description: >- - A token to retrieve next page of results. Pass to - ListIndexEndpointsRequest.page_token to obtain that page. + Required. Source path exported from NFS server. Has to start with + '/', and combined with the ip address, it indicates the source mount + path in the form of `server:path` type: string - indexEndpoints: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + server: + type: string + description: Required. IP address of the NFS server. + GoogleCloudAiplatformV1DirectPredictResponse: + properties: + outputs: + description: The prediction output. type: array - description: List of IndexEndpoints in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. + id: GoogleCloudAiplatformV1DirectPredictResponse + description: Response message for PredictionService.DirectPredict. type: object - id: GoogleCloudAiplatformV1ListIndexEndpointsResponse - GoogleCloudAiplatformV1DeployModelResponse: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification: + description: >- + A TrainingJob that trains and uploads an AutoML Image Classification + Model. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification type: object properties: - deployedModel: - description: The DeployedModel that had been deployed in the Endpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: Response message for EndpointService.DeployModel. - id: GoogleCloudAiplatformV1DeployModelResponse - GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode: - id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode - type: object - description: >- - When automated routing is specified, the routing will be determined by - the pretrained routing model and customer provided model routing - preference. + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata + description: The metadata information. + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs + description: The input parameters of this TrainingJob. + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation: properties: - modelRoutingPreference: + annotationSpecId: + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. type: string - enumDescriptions: - - Unspecified model routing preference. - - Prefer higher quality over low cost. - - Balanced model routing preference. - - Prefer lower cost over higher quality. - description: The model routing preference. - enum: - - UNKNOWN - - PRIORITIZE_QUALITY - - BALANCED - - PRIORITIZE_COST - GoogleCloudAiplatformV1PipelineTaskExecutorDetail: + displayName: + type: string + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + vertexes: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' + type: array + description: >- + The vertexes are connected one by one and the last vertex is + connected to the first one to represent a polygon. + description: Represents a polygon in image. + id: >- + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation + type: object + GoogleCloudAiplatformV1ResourceRuntime: + id: GoogleCloudAiplatformV1ResourceRuntime type: object properties: - containerDetail: - readOnly: true - description: Output only. The detailed info for a container executor. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail - customJobDetail: + accessUris: + description: >- + Output only. URIs for user to connect to the Cluster. Example: { + "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" + "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } readOnly: true - description: Output only. The detailed info for a custom job executor. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail - description: The runtime detail of a pipeline executor. - GoogleCloudAiplatformV1CreateDatasetOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - description: Runtime operation information for DatasetService.CreateDataset. + type: object + additionalProperties: + type: string + description: Persistent Cluster runtime information as output + GoogleCloudAiplatformV1RemoveContextChildrenResponse: + properties: {} + description: Response message for MetadataService.RemoveContextChildren. type: object - id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata - GoogleCloudAiplatformV1TensorboardExperiment: - description: >- - A TensorboardExperiment is a group of TensorboardRuns, that are - typically the results of a training job run, in a Tensorboard. - id: GoogleCloudAiplatformV1TensorboardExperiment + id: GoogleCloudAiplatformV1RemoveContextChildrenResponse + GoogleCloudAiplatformV1Execution: + type: object + description: Instance of a general execution. properties: - name: + schemaVersion: type: string description: >- - Output only. Name of the TensorboardExperiment. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` - readOnly: true - etag: + The version of the schema in `schema_title` to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + metadata: + additionalProperties: + description: Properties of the object. + type: any description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + Properties of the Execution. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + type: object + createTime: + description: Output only. Timestamp when this Execution was created. type: string + format: google-datetime + readOnly: true labels: + type: object description: >- - The labels with user-defined metadata to organize your - TensorboardExperiment. Label keys and values cannot be longer than - 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. No more than 64 user labels can be - associated with one Dataset (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - `aiplatform.googleapis.com/` and are immutable. The following system - labels exist for each Dataset: * - `aiplatform.googleapis.com/dataset_metadata_schema`: output only. - Its value is the metadata_schema's title. + The labels with user-defined metadata to organize your Executions. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Execution + (System labels are excluded). additionalProperties: type: string - type: object - updateTime: - description: >- - Output only. Timestamp when this TensorboardExperiment was last - updated. + name: readOnly: true type: string + description: Output only. The resource name of the Execution. + updateTime: + readOnly: true format: google-datetime - description: - description: Description of this TensorboardExperiment. type: string + description: Output only. Timestamp when this Execution was last updated. displayName: type: string - description: User provided name of this TensorboardExperiment. - source: + description: >- + User provided display name of the Execution. May be up to 128 + Unicode characters. + description: + description: Description of the Execution type: string + state: + enumDescriptions: + - Unspecified Execution state + - The Execution is new + - The Execution is running + - The Execution has finished running + - The Execution has failed + - The Execution completed through Cache hit. + - The Execution was cancelled. + enum: + - STATE_UNSPECIFIED + - NEW + - RUNNING + - COMPLETE + - FAILED + - CACHED + - CANCELLED description: >- - Immutable. Source of the TensorboardExperiment. Example: a custom - training job. - createTime: - format: google-datetime - readOnly: true + The state of this Execution. This is a property of the Execution, + and does not imply or capture any ongoing process. This property is + managed by clients (such as Vertex AI Pipelines) and the system does + not prescribe or check the validity of state transitions. type: string - description: Output only. Timestamp when this TensorboardExperiment was created. - type: object - GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: - description: Response message for NotebookService.ListNotebookRuntimeTemplates. - type: object - id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse - properties: - notebookRuntimeTemplates: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate - description: List of NotebookRuntimeTemplates in the requested page. - type: array - nextPageToken: + schemaTitle: type: string description: >- - A token to retrieve next page of results. Pass to - ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. - GoogleCloudAiplatformV1CreateTensorboardRunRequest: + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + etag: + type: string + description: >- + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + id: GoogleCloudAiplatformV1Execution + GoogleCloudAiplatformV1SchemaTextExtractionAnnotation: type: object properties: - parent: - type: string + textSegment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTextSegment' + description: The segment of the text content. + displayName: description: >- - Required. The resource name of the TensorboardExperiment to create - the TensorboardRun in. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` - tensorboardRunId: + The display name of the AnnotationSpec that this Annotation pertains + to. + type: string + annotationSpecId: type: string description: >- - 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-/`. - tensorboardRun: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - description: Required. The TensorboardRun to create. - description: Request message for TensorboardService.CreateTensorboardRun. - id: GoogleCloudAiplatformV1CreateTensorboardRunRequest - GoogleCloudAiplatformV1PointwiseMetricResult: - type: object - id: GoogleCloudAiplatformV1PointwiseMetricResult - properties: - score: - format: float - description: Output only. Pointwise metric score. - type: number - readOnly: true - explanation: - description: Output only. Explanation for pointwise metric score. - type: string - readOnly: true - description: Spec for pointwise metric result. - GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata: - id: >- - GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata - type: object + The resource Id of the AnnotationSpec that this Annotation pertains + to. + id: GoogleCloudAiplatformV1SchemaTextExtractionAnnotation + description: Annotation details specific to text extraction. + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec: + description: Spec for pairwise question answering quality score metric. + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec properties: - runTime: - type: string + version: + type: integer + format: int32 + description: Optional. Which version to use for evaluation. + useReference: description: >- - The time that most recent monitoring pipelines that is related to - this run. - format: google-datetime - status: - description: The status of the most recent monitoring pipeline. - $ref: '#/components/schemas/GoogleRpcStatus' - description: All metadata of most recent monitoring pipelines. - GoogleCloudAiplatformV1BatchPredictionJobOutputInfo: + Optional. Whether to use instance.reference to compute question + answering quality. + type: boolean type: object - description: Further describes this job's output. Supplements output_config. - id: GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + GoogleCloudAiplatformV1GroundingSupport: + description: Grounding support. properties: - gcsOutputDirectory: - readOnly: true - description: >- - Output only. The full path of the Cloud Storage directory created, - into which the prediction output is written. - type: string - bigqueryOutputDataset: - readOnly: true + confidenceScores: + type: array + items: + format: float + type: number description: >- - Output only. The path of the BigQuery dataset created, in - `bq://projectId.bqDatasetId` format, into which the prediction - output is written. - type: string - bigqueryOutputTable: - readOnly: true + Confidence score of the support references. Ranges from 0 to 1. 1 is + the most confident. This list must have the same size as the + grounding_chunk_indices. + groundingChunkIndices: + type: array description: >- - Output only. The name of the BigQuery table created, in - `predictions_` format, into which the prediction output is written. - Can be used by UI to generate the BigQuery output path, for example. - type: string - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset: - description: Training Dataset information. - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset + A list of indices (into 'grounding_chunk') specifying the citations + associated with the claim. For instance [1,3,4] means that + grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the + retrieved content attributed to the claim. + items: + format: int32 + type: integer + segment: + description: Segment of the content this support belongs to. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Segment' + type: object + id: GoogleCloudAiplatformV1GroundingSupport + GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance: + description: Prediction input format for Video Action Recognition. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance properties: - bigquerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: >- - The BigQuery table of the unmanaged Dataset used to train this - Model. - dataFormat: + content: type: string description: >- - Data format of the dataset, only applicable if the input is from - Google Cloud Storage. The possible formats are: "tf-record" The - source file is a TFRecord file. "csv" The source file is a CSV file. - "jsonl" The source file is a JSONL file. - targetField: + The Google Cloud Storage location of the video on which to perform + the prediction. + timeSegmentStart: description: >- - The target field name the model is to predict. This field will be - excluded when doing Predict and (or) Explain for the training data. - type: string - dataset: + The beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. type: string - description: The resource name of the Dataset used to train this Model. - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: >- - The Google Cloud Storage uri of the unmanaged Dataset used to train - this Model. - loggingSamplingStrategy: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' - description: >- - Strategy to sample data from Training Dataset. If not set, we - process the whole dataset. - type: object - GoogleCloudAiplatformV1IndexDatapointNumericRestriction: - properties: - op: + timeSegmentEnd: description: >- - This MUST be specified for queries and must NOT be specified for - datapoints. - enumDescriptions: - - Default value of the enum. - - Datapoints are eligible iff their value is < the query's. - - Datapoints are eligible iff their value is <= the query's. - - Datapoints are eligible iff their value is == the query's. - - Datapoints are eligible iff their value is >= the query's. - - Datapoints are eligible iff their value is > the query's. - - Datapoints are eligible iff their value is != the query's. - type: string - enum: - - OPERATOR_UNSPECIFIED - - LESS - - LESS_EQUAL - - EQUAL - - GREATER_EQUAL - - GREATER - - NOT_EQUAL - valueDouble: - format: double - description: Represents 64 bit float. - type: number - valueFloat: - type: number - format: float - description: Represents 32 bit float. - valueInt: + The end, exclusive, of the video's time segment on which to perform + the prediction. Expressed as a number of seconds as measured from + the start of the video, with "s" appended at the end. Fractions are + allowed, up to a microsecond precision, and "inf" or "Infinity" is + allowed, which means the end of the video. type: string - description: Represents 64 bit integer. - format: int64 - namespace: + mimeType: type: string - description: 'The namespace of this restriction. e.g.: cost.' + description: >- + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime type: object - description: >- - This field allows restricts to be based on numeric comparisons rather - than categorical tokens. - id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec: + GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata: properties: - maxParallelTrialCount: - type: integer - format: int32 - description: Required. The maximum number of trials to run in parallel. - maxTrialCount: - description: >- - Required. The maximum number of Neural Architecture Search (NAS) - trials to run. - type: integer - format: int32 - maxFailedTrialCount: + sentimentMax: type: integer + description: The maximum sentiment of sentiment Anntoation in this SavedQuery. format: int32 - description: >- - The number of failed trials that need to be seen before failing the - NasJob. If set to 0, Vertex AI decides how many trials must fail - before the whole job fails. - searchTrialJobSpec: - description: >- - Required. The spec of a search trial job. The same spec applies to - all search trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec - description: Represent spec for search trials. + description: The metadata of SavedQuery contains TextSentiment Annotations. + id: GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata type: object - GoogleCloudAiplatformV1DataItemView: + GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines: + description: Open fine tuning pipelines. properties: - hasTruncatedAnnotations: - type: boolean - description: >- - True if and only if the Annotations field has been truncated. It - happens if more Annotations for this DataItem met the request's - annotation_filter than are allowed to be returned by - annotations_limit. Note that if Annotations field is not being - returned due to field mask, then this field will not be set to true - no matter how many Annotations are there. - dataItem: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' - description: The DataItem. - annotations: + fineTuningPipelines: + description: Required. Regional resource references to fine tuning pipelines. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' - description: >- - The Annotations on the DataItem. If too many Annotations should be - returned for the DataItem, this field will be truncated per - annotations_limit in request. If it was, then the - has_truncated_annotations will be set to true. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines type: object - id: GoogleCloudAiplatformV1DataItemView - description: A container for a single DataItem and Annotations on it. - GoogleCloudAiplatformV1SavedQuery: + GoogleCloudAiplatformV1UndeployModelRequest: + type: object + description: Request message for EndpointService.UndeployModel. + id: GoogleCloudAiplatformV1UndeployModelRequest properties: - name: + deployedModelId: + description: >- + Required. The ID of the DeployedModel to be undeployed from the + Endpoint. type: string + trafficSplit: + additionalProperties: + type: integer + format: int32 + type: object + description: >- + If this field is provided, then the Endpoint's traffic_split will be + overwritten with it. If last DeployedModel is being undeployed from + the Endpoint, the [Endpoint.traffic_split] will always end up empty + when this call returns. A DeployedModel will be successfully + undeployed only if it doesn't have any traffic assigned to it when + this method executes, or if this field unassigns any traffic to it. + GoogleCloudAiplatformV1SummarizationHelpfulnessResult: + properties: + score: readOnly: true - description: Output only. Resource name of the SavedQuery. - createTime: - format: google-datetime + description: Output only. Summarization Helpfulness score. + format: float + type: number + explanation: type: string - description: Output only. Timestamp when this SavedQuery was created. + description: Output only. Explanation for summarization helpfulness score. readOnly: true - annotationFilter: + confidence: + type: number readOnly: true - type: string - description: Output only. Filters on the Annotations in the dataset. - problemType: + description: Output only. Confidence for summarization helpfulness score. + format: float + type: object + id: GoogleCloudAiplatformV1SummarizationHelpfulnessResult + description: Spec for summarization helpfulness result. + GoogleIamV1SetIamPolicyRequest: + description: Request message for `SetIamPolicy` method. + id: GoogleIamV1SetIamPolicyRequest + type: object + properties: + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + GoogleCloudAiplatformV1ToolParameterKVMatchSpec: + type: object + id: GoogleCloudAiplatformV1ToolParameterKVMatchSpec + description: Spec for tool parameter key value match metric. + properties: + useStrictStringMatch: + type: boolean + description: Optional. Whether to use STRCIT string match on parameter values. + GoogleCloudAiplatformV1ExportDataOperationMetadata: + id: GoogleCloudAiplatformV1ExportDataOperationMetadata + type: object + description: Runtime operation information for DatasetService.ExportData. + properties: + gcsOutputDirectory: type: string description: >- - Required. Problem type of the SavedQuery. Allowed values: * - IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL - * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * - TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * - TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * - VIDEO_OBJECT_TRACKING - etag: + A Google Cloud Storage directory which path ends with '/'. The + exported data is stored in the directory. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + GoogleCloudAiplatformV1PurgeArtifactsRequest: + properties: + filter: type: string description: >- - Used to perform a consistent read-modify-write update. If not set, a - blind "overwrite" update happens. - supportAutomlTraining: - type: boolean + Required. A required filter matching the Artifacts to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + force: description: >- - Output only. If the Annotations belonging to the SavedQuery can be - used for AutoML training. - readOnly: true - annotationSpecCount: - format: int32 - readOnly: true - type: integer + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Artifact names + that would be deleted. + type: boolean + type: object + description: Request message for MetadataService.PurgeArtifacts. + id: GoogleCloudAiplatformV1PurgeArtifactsRequest + GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest: + description: Request message for MetadataService.AddContextArtifactsAndExecutions. + properties: + artifacts: + type: array + items: + type: string description: >- - Output only. Number of AnnotationSpecs in the context of the - SavedQuery. - metadata: - description: Some additional information about the SavedQuery. - type: any - displayName: + The resource names of the Artifacts to attribute to the Context. + Format: + `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + executions: description: >- - Required. The user-defined name of the SavedQuery. The name can be - up to 128 characters long and can consist of any UTF-8 characters. - type: string - updateTime: - type: string - readOnly: true - format: google-datetime - description: Output only. Timestamp when SavedQuery was last updated. - id: GoogleCloudAiplatformV1SavedQuery - type: object - description: >- - A SavedQuery is a view of the dataset. It references a subset of - annotations by problem type and filters. - GoogleCloudAiplatformV1ResumeScheduleRequest: + The resource names of the Executions to associate with the Context. + Format: + `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + type: array + items: + type: string + id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest type: object - description: Request message for ScheduleService.ResumeSchedule. + GoogleCloudAiplatformV1ModelMonitoringAlertConfig: properties: - catchUp: - type: boolean + enableLogging: description: >- - Optional. Whether to backfill missed runs when the schedule is - resumed from PAUSED state. If set to true, all missed runs will be - scheduled. New runs will be scheduled after the backfill is - complete. This will also update Schedule.catch_up field. Default to - false. - id: GoogleCloudAiplatformV1ResumeScheduleRequest - GoogleCloudAiplatformV1TrialContext: - properties: - parameters: + Dump the anomalies to Cloud Logging. The anomalies will be put to + json payload encoded from proto + google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. + This can be further sinked to Pub/Sub or any other services + supported by Cloud Logging. + type: boolean + notificationChannels: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + type: string description: >- - If/when a Trial is generated or selected from this Context, its - Parameters will match any parameters specified here. (I.e. if this - context specifies parameter name:'a' int_value:3, then a resulting - Trial will have int_value:3 for its parameter named 'a'.) Note that - we first attempt to match existing REQUESTED Trials with contexts, - and if there are no matches, we generate suggestions in the subspace - defined by the parameters specified here. NOTE: a Context without - any Parameters matches the entire feasible search space. + Resource names of the NotificationChannels to send alert. Must be of + the format `projects//notificationChannels/` type: array - description: - description: >- - A human-readable field which can store a description of this - context. This will become part of the resulting Trial's description - field. - type: string - type: object - id: GoogleCloudAiplatformV1TrialContext - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation: - properties: - columnName: - type: string + emailAlertConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + description: Email alert config. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation + id: GoogleCloudAiplatformV1ModelMonitoringAlertConfig + description: The alert config for model monitoring. + GoogleCloudAiplatformV1StratifiedSplit: description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata: - type: object - description: Details of operations that perform update FeatureGroup. - id: GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata - properties: - genericMetadata: - description: Operation metadata for FeatureGroup. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig: + Assigns input data to the training, validation, and test sets so that + the distribution of values found in the categorical column (as specified + by the `key` field) is mirrored within each split. The fraction values + determine the relative sizes of the splits. For example, if the + specified column has three values, with 50% of the rows having value + "A", 25% value "B", and 25% value "C", and the split fractions are + specified as 80/10/10, then the training set will constitute 80% of the + training data, with about 50% of the training set rows having the value + "A" for the specified column, about 25% having the value "B", and about + 25% having the value "C". Only the top 500 occurring values are used; + any values not in the top 500 values are randomly assigned to a split. + If less than three rows contain a specific value, those rows are + randomly assigned. Supported only for tabular Datasets. properties: - desiredMinSafeTrialsFraction: + testFraction: description: >- - Desired minimum fraction of safe trials (over total number of - trials) that should be targeted by the algorithm at any time during - the study (best effort). This should be between 0.0 and 1.0 and a - value of 0.0 means that there is no minimum and an algorithm - proceeds without targeting any specific fraction. A value of 1.0 - means that the algorithm attempts to only Suggest safe Trials. + The fraction of the input data that is to be used to evaluate the + Model. + type: number + format: double + key: + type: string + description: >- + Required. The key is a name of one of the Dataset's data columns. + The key provided must be for a categorical column. + validationFraction: format: double type: number - safetyThreshold: description: >- - Safety threshold (boundary value between safe and unsafe). NOTE that - if you leave SafetyMetricConfig unset, a default value of 0 will be - used. + The fraction of the input data that is to be used to validate the + Model. + trainingFraction: + description: >- + The fraction of the input data that is to be used to train the + Model. type: number format: double + id: GoogleCloudAiplatformV1StratifiedSplit + type: object + GoogleCloudAiplatformV1Event: + id: GoogleCloudAiplatformV1Event description: >- - Used in safe optimization to specify threshold levels and risk - tolerance. + An edge describing the relationship between an Artifact and an Execution + in a lineage graph. type: object - id: GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig - GoogleCloudAiplatformV1ImportFeatureValuesRequest: properties: - disableOnlineServing: - type: boolean - description: >- - If set, data will not be imported for online serving. This is - typically used for backfilling, where Feature generation timestamps - are not in the timestamp range needed for online serving. - featureTimeField: + eventTime: + readOnly: true + description: Output only. Time the Event occurred. + format: google-datetime type: string + execution: description: >- - Source column that holds the Feature timestamp for all Feature - values in each entity. - avroSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AvroSource' - featureSpecs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + Output only. The relative resource name of the Execution in the + Event. + type: string + readOnly: true + labels: + type: object + additionalProperties: + type: string + description: >- + The labels with user-defined metadata to annotate Events. Label keys + and values can be no longer than 64 characters (Unicode codepoints), + can only contain lowercase letters, numeric characters, underscores + and dashes. International characters are allowed. No more than 64 + user labels can be associated with one Event (System labels are + excluded). See https://goo.gl/xmQnxf for more information and + examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + type: + enumDescriptions: + - Unspecified whether input or output of the Execution. + - An input of the Execution. + - An output of the Execution. + enum: + - TYPE_UNSPECIFIED + - INPUT + - OUTPUT + description: Required. The type of the Event. + type: string + artifact: + description: Required. The relative resource name of the Artifact in the Event. + type: string + GoogleCloudAiplatformV1PrivateServiceConnectConfig: + properties: + serviceAttachment: + type: string + readOnly: true + description: >- + Output only. The name of the generated service attachment resource. + This is only populated if the endpoint is deployed with + PrivateServiceConnect. + projectAllowlist: type: array + items: + type: string description: >- - Required. Specifications defining which Feature values to import - from the entity. The request fails if no feature_specs are provided, - and having multiple feature_specs for one Feature is not allowed. - workerCount: - type: integer - format: int32 + A list of Projects from which the forwarding rule will target the + service attachment. + enablePrivateServiceConnect: description: >- - Specifies the number of workers that are used to write data to the - Featurestore. Consider the online serving capacity that you require - to achieve the desired import throughput without interfering with - online serving. The value must be positive, and less than or equal - to 100. If not set, defaults to using 1 worker. The low count - ensures minimal impact on online serving performance. - disableIngestionAnalysis: + Required. If true, expose the IndexEndpoint via private service + connect. + type: boolean + type: object + id: GoogleCloudAiplatformV1PrivateServiceConnectConfig + description: Represents configuration for private service connect. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig: + description: Configuration for exporting test set predictions to a BigQuery table. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + properties: + overrideExistingTable: type: boolean - description: If true, API doesn't start ingestion analysis pipeline. - csvSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - bigquerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - featureTime: - format: google-datetime description: >- - Single Feature timestamp for all entities being imported. The - timestamp must not have higher than millisecond precision. - type: string - entityIdField: + If true and an export destination is specified, then the contents of + the destination are overwritten. Otherwise, if the export + destination already exists, then the export operation fails. + destinationBigqueryUri: type: string description: >- - Source column that holds entity IDs. If not provided, entity IDs are - extracted from the column named entity_id. - id: GoogleCloudAiplatformV1ImportFeatureValuesRequest - description: Request message for FeaturestoreService.ImportFeatureValues. + URI of desired destination BigQuery table. Expected format: + `bq://{project_id}:{dataset_id}:{table}` If not specified, then + results are exported to the following auto-created BigQuery table: + `{project_id}:export_evaluated_examples_{model_name}_{yyyy_MM_dd'T'HH_mm_ss_SSS'Z'}.evaluated_examples` type: object - GoogleCloudAiplatformV1BatchPredictionJobOutputConfig: - description: >- - Configures the output of BatchPredictionJob. See - Model.supported_output_storage_formats for supported output formats, and - how predictions are expressed via any of them. + GoogleCloudAiplatformV1PipelineJob: properties: - predictionsFormat: - description: >- - Required. The format in which Vertex AI gives the predictions, must - be one of the Model's supported_output_storage_formats. + pipelineSpec: + type: object + additionalProperties: + description: Properties of the object. + type: any + description: The spec of the pipeline. + displayName: type: string - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' description: >- - The Cloud Storage location of the directory where the output is to - be written to. In the given directory a new directory is created. - Its name is `prediction--`, where timestamp is in - YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files - `predictions_0001.`, `predictions_0002.`, ..., `predictions_N.` are - created where `` depends on chosen predictions_format, and N may - equal 0001 and depends on the total number of successfully predicted - instances. If the Model has both instance and prediction schemata - defined then each such file contains predictions as per the - predictions_format. If prediction for any instance failed (partially - or completely), then an additional `errors_0001.`, - `errors_0002.`,..., `errors_N.` files are created (N depends on - total number of failed predictions). These files contain the failed - instances, as per their schema, followed by an additional `error` - field which as value has google.rpc.Status containing only `code` - and `message` fields. - bigqueryDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + The display name of the Pipeline. The name can be up to 128 + characters long and can consist of any UTF-8 characters. + templateMetadata: description: >- - The BigQuery project or dataset location where the output is to be - written to. If project is provided, a new dataset is created with - name `prediction__` where is made BigQuery-dataset-name compatible - (for example, most special characters become underscores), and - timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. - In the dataset two tables will be created, `predictions`, and - `errors`. If the Model has both instance and prediction schemata - defined then the tables have columns as follows: The `predictions` - table contains instances for which the prediction succeeded, it has - columns as per a concatenation of the Model's instance and - prediction schemata. The `errors` table contains rows for which the - prediction has failed, it has instance columns, as per the instance - schema, followed by a single "errors" column, which as values has - google.rpc.Status represented as a STRUCT, and containing only - `code` and `message`. - type: object - id: GoogleCloudAiplatformV1BatchPredictionJobOutputConfig - GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex: - description: Multiple setups to deploy the PublisherModel. - properties: - multiDeployVertex: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy - description: Optional. One click deployment configurations. - type: array - type: object - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs - type: object - properties: - predictionType: + Output only. Pipeline template metadata. Will fill up fields if + PipelineJob.template_uri is from supported template registry. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTemplateMetadata' + readOnly: true + network: description: >- - The type of prediction the Model is to produce. "classification" - - Predict one out of multiple target values is picked for each row. - "regression" - Predict a value based on its relation to other - values. This type is available only to columns that contain - semantically numeric values, i.e. integers or floating point number, - even if stored as e.g. strings. - type: string - targetColumn: - description: The column name of the target column that the model is to predict. + The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to which + the Pipeline Job's workload should be peered. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + Private services access must already be configured for the network. + Pipeline job will apply the network configuration to the Google + Cloud resources being launched, if applied, such as Vertex AI + Training or Dataflow job. If left unspecified, the workload is not + peered with any network. type: string - additionalExperiments: - description: Additional experiment flags for the Tables training pipeline. - items: - type: string - type: array - disableEarlyStopping: + preflightValidations: type: boolean description: >- - Use the entire training budget. This disables the early stopping - feature. By default, the early stopping feature is enabled, which - means that AutoML Tables might stop training before the entire - training budget has been used. - optimizationObjectivePrecisionValue: + Optional. Whether to do component level validations before job + creation. + startTime: + readOnly: true + description: Output only. Pipeline start time. + format: google-datetime + type: string + labels: description: >- - Required when optimization_objective is - "maximize-recall-at-precision". Must be between 0 and 1, inclusive. - format: float - type: number - optimizationObjectiveRecallValue: - format: float + The labels with user-defined metadata to organize PipelineJob. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + Note there is some reserved label key for Vertex AI Pipelines. - + `vertex-ai-pipelines-run-billing-id`, user set value will get + overrided. + type: object + additionalProperties: + type: string + createTime: + readOnly: true + type: string + description: Output only. Pipeline creation time. + format: google-datetime + updateTime: + readOnly: true + format: google-datetime + type: string description: >- - Required when optimization_objective is - "maximize-precision-at-recall". Must be between 0 and 1, inclusive. - type: number - weightColumnName: + Output only. Timestamp when this PipelineJob was most recently + updated. + templateUri: type: string description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. - exportEvaluatedDataItemsConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + A template uri from where the PipelineJob.pipeline_spec, if empty, + will be downloaded. Currently, only uri from Vertex Template + Registry & Gallery is supported. Reference to + https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. + scheduleName: description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - optimizationObjective: + Output only. The schedule resource name. Only returned if the + Pipeline is created by Schedule API. + readOnly: true type: string - description: >- - Objective function the model is optimizing towards. The training - process creates a model that maximizes/minimizes the value of the - objective function over the validation set. The supported - optimization objectives depend on the prediction type. If the field - is not set, a default objective function is used. classification - (binary): "maximize-au-roc" (default) - Maximize the area under the - receiver operating characteristic (ROC) curve. "minimize-log-loss" - - Minimize log loss. "maximize-au-prc" - Maximize the area under the - precision-recall curve. "maximize-precision-at-recall" - Maximize - precision for a specified recall value. - "maximize-recall-at-precision" - Maximize recall for a specified - precision value. classification (multi-class): "minimize-log-loss" - (default) - Minimize log loss. regression: "minimize-rmse" (default) - - Minimize root-mean-squared error (RMSE). "minimize-mae" - Minimize - mean-absolute error (MAE). "minimize-rmsle" - Minimize - root-mean-squared log error (RMSLE). - trainBudgetMilliNodeHours: - format: int64 + name: + readOnly: true type: string + description: Output only. The resource name of the PipelineJob. + error: + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. - transformations: - description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation - type: array - GoogleCloudAiplatformV1AddTrialMeasurementRequest: - description: Request message for VizierService.AddTrialMeasurement. - type: object - id: GoogleCloudAiplatformV1AddTrialMeasurementRequest - properties: - measurement: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - description: Required. The measurement to be added to a Trial. - GoogleCloudAiplatformV1FeatureViewIndexConfig: - description: Configuration for vector indexing. - properties: - distanceMeasureType: + Output only. The error that occurred during pipeline execution. Only + populated when the pipeline's state is FAILED or CANCELLED. + endTime: + format: google-datetime + description: Output only. Pipeline end time. + type: string + readOnly: true + state: + readOnly: true enumDescriptions: - - Should not be set. - - Euclidean (L_2) Distance. + - The pipeline state is unspecified. - >- - Cosine Distance. Defined as 1 - cosine similarity. We strongly - suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of - COSINE distance. Our algorithms have been more optimized for - DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is - mathematically equivalent to COSINE distance and results in the - same ranking. - - Dot Product Distance. Defined as a negative of the dot product. + The pipeline has been created or resumed, and processing has not + yet begun. + - The service is preparing to run the pipeline. + - The pipeline is in progress. + - The pipeline completed successfully. + - The pipeline failed. + - >- + The pipeline is being cancelled. From this state, the pipeline may + only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED + or PIPELINE_STATE_CANCELLED. + - The pipeline has been cancelled. + - The pipeline has been stopped, and can be resumed. + type: string + description: Output only. The detailed state of the job. enum: - - DISTANCE_MEASURE_TYPE_UNSPECIFIED - - SQUARED_L2_DISTANCE - - COSINE_DISTANCE - - DOT_PRODUCT_DISTANCE - description: Optional. The distance measure used in nearest neighbor search. + - PIPELINE_STATE_UNSPECIFIED + - PIPELINE_STATE_QUEUED + - PIPELINE_STATE_PENDING + - PIPELINE_STATE_RUNNING + - PIPELINE_STATE_SUCCEEDED + - PIPELINE_STATE_FAILED + - PIPELINE_STATE_CANCELLING + - PIPELINE_STATE_CANCELLED + - PIPELINE_STATE_PAUSED + jobDetail: + description: >- + Output only. The details of pipeline run. Not available in the list + view. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobDetail' + serviceAccount: type: string - bruteForceConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig description: >- - Optional. Configuration options for using brute force search, which - simply implements the standard linear search in the database for - each query. It is primarily meant for benchmarking and to generate - the ground truth for approximate search. - filterColumns: - items: - type: string + The service account that the pipeline workload runs as. If not + specified, the Compute Engine default service account in the project + will be used. See + https://cloud.google.com/compute/docs/access/service-accounts#default_service_account + Users starting the pipeline must have the + `iam.serviceAccounts.actAs` permission on this service account. + reservedIpRanges: description: >- - Optional. Columns of features that're used to filter vector search - results. + A list of names for the reserved ip ranges under the VPC network + that can be used for this Pipeline Job's workload. If set, we will + deploy the Pipeline Job's workload within the provided ip ranges. + Otherwise, the job will be deployed to any ip ranges under the + provided VPC network. Example: ['vertex-ai-ip-range']. type: array - embeddingDimension: - format: int32 - description: Optional. The number of dimensions of the input embedding. - type: integer - crowdingColumn: - description: >- - Optional. Column of crowding. This column contains crowding - attribute which is a constraint on a neighbor list produced by - FeatureOnlineStoreService.SearchNearestEntities to diversify search - results. If - NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to - K in SearchNearestEntitiesRequest, it's guaranteed that no more than - K entities of the same crowding attribute are returned in the - response. - type: string - embeddingColumn: - type: string - description: >- - Optional. Column of embedding. This column contains the source data - to create index for vector search. embedding_column must be set when - using vector search. - treeAhConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig + items: + type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Optional. Configuration options for the tree-AH algorithm (Shallow - tree + Asymmetric Hashing). Please refer to this paper for more - details: https://arxiv.org/abs/1908.10396 - id: GoogleCloudAiplatformV1FeatureViewIndexConfig + Customer-managed encryption key spec for a pipelineJob. If set, this + PipelineJob and all of its sub-resources will be secured by this + key. + runtimeConfig: + description: Runtime config of the pipeline. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfig' + description: An instance of a machine learning PipelineJob. type: object - CloudAiLargeModelsVisionVideo: + id: GoogleCloudAiplatformV1PipelineJob + GoogleCloudAiplatformV1PointwiseMetricResult: properties: - uri: - type: string - description: Path to another storage (typically Google Cloud Storage). - video: - format: byte + explanation: + readOnly: true type: string - description: Raw bytes. - id: CloudAiLargeModelsVisionVideo + description: Output only. Explanation for pointwise metric score. + score: + format: float + readOnly: true + description: Output only. Pointwise metric score. + type: number + description: Spec for pointwise metric result. type: object - description: Video - GoogleCloudAiplatformV1AddContextChildrenResponse: - properties: {} - id: GoogleCloudAiplatformV1AddContextChildrenResponse - description: Response message for MetadataService.AddContextChildren. + id: GoogleCloudAiplatformV1PointwiseMetricResult + GoogleCloudAiplatformV1CreateDatasetOperationMetadata: + id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata type: object - GoogleCloudAiplatformV1ListTrainingPipelinesResponse: + description: Runtime operation information for DatasetService.CreateDataset. + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: type: object + description: Metadata information for NotebookService.StartNotebookRuntime. + id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata properties: - nextPageToken: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + progressMessage: type: string description: >- - A token to retrieve the next page of results. Pass to - ListTrainingPipelinesRequest.page_token to obtain that page. - trainingPipelines: - description: List of TrainingPipelines in the requested page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' - id: GoogleCloudAiplatformV1ListTrainingPipelinesResponse - description: Response message for PipelineService.ListTrainingPipelines - GoogleCloudAiplatformV1ListModelVersionsResponse: - type: object + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + GoogleCloudAiplatformV1EntityType: properties: - models: - type: array - description: >- - List of Model versions in the requested page. In the returned Model - name field, version ID instead of regvision tag will be included. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - nextPageToken: + name: type: string description: >- - A token to retrieve the next page of results. Pass to - ListModelVersionsRequest.page_token to obtain that page. - id: GoogleCloudAiplatformV1ListModelVersionsResponse - description: Response message for ModelService.ListModelVersions - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs: - properties: - sentimentMax: - format: int32 + 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. + updateTime: + readOnly: true + format: google-datetime description: >- - A sentiment is expressed as an integer ordinal, where higher value - means a more positive sentiment. The range of sentiments that will - be used is between 0 and sentimentMax (inclusive on both ends), and - all the values in the range must be represented in the dataset - before a model can be created. Only the Annotations with this - sentimentMax will be used for training. sentimentMax value must be - between 1 and 10 (inclusive). + Output only. Timestamp when this EntityType was most recently + updated. + type: string + etag: + description: >- + Optional. Used to perform a consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + type: string + offlineStorageTtlDays: + format: int32 type: integer + description: >- + Optional. Config for data retention policy in offline storage. TTL + in days for feature values that will be stored in offline storage. + The Feature Store offline storage periodically removes obsolete + feature values older than `offline_storage_ttl_days` since the + feature generation time. If unset (or explicitly set to 0), default + to 4000 days TTL. + labels: + additionalProperties: + type: string + type: object + description: >- + Optional. The labels with user-defined metadata to organize your + EntityTypes. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one EntityType (System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + satisfiesPzs: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + createTime: + description: Output only. Timestamp when this EntityType was created. + type: string + format: google-datetime + readOnly: true + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + description: + description: Optional. Description of the EntityType. + type: string + monitoringConfig: + description: >- + Optional. The default monitoring configuration for all Features with + value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under + this EntityType. If this is populated with + [FeaturestoreMonitoringConfig.monitoring_interval] specified, + snapshot analysis monitoring is enabled. Otherwise, snapshot + analysis monitoring is disabled. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfig + description: >- + An entity type is a type of object in a system that needs to be modeled + and have stored information about. For example, driver is an entity + type, and driver0 is an instance of an entity type driver. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs - GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset: + id: GoogleCloudAiplatformV1EntityType + GoogleCloudAiplatformV1UpsertDatapointsRequest: properties: - dataset: + updateMask: type: string + format: google-fieldmask description: >- - Full resource name of data labeling Dataset. Format: - `projects/{project}/datasets/{dataset}`. - dataLabelingAnnotatedDatasets: - type: array - description: >- - The migratable AnnotatedDataset in datalabeling.googleapis.com - belongs to the data labeling Dataset. + Optional. Update mask is used to specify the fields to be + overwritten in the datapoints by the update. The fields specified in + the update_mask are relative to each IndexDatapoint inside + datapoints, not the full request. Updatable fields: * Use + `all_restricts` to update both restricts and numeric_restricts. + datapoints: + description: A list of datapoints to be created/updated. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset - datasetDisplayName: - type: string - description: The Dataset's display name in datalabeling.googleapis.com. - description: Represents one Dataset in datalabeling.googleapis.com. - id: GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + type: array + id: GoogleCloudAiplatformV1UpsertDatapointsRequest + description: Request message for IndexService.UpsertDatapoints type: object - CloudAiLargeModelsVisionGenerateVideoResponse: - description: Generate video response. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation type: object + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. properties: - raiMediaFilteredReasons: - description: Returns rai failure reasons if any. - items: - type: string - type: array - generatedSamples: - type: array - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' - description: The generates samples. - raiMediaFilteredCount: - format: int32 - description: Returns if any videos were filtered due to RAI policies. - type: integer - id: CloudAiLargeModelsVisionGenerateVideoResponse - GoogleCloudAiplatformV1FeatureViewBigQuerySource: - id: GoogleCloudAiplatformV1FeatureViewBigQuerySource + columnName: + type: string + GoogleCloudAiplatformV1BoolArray: + description: A list of boolean values. type: object properties: - entityIdColumns: + values: items: - type: string - description: Required. Columns to construct entity_id / row keys. + type: boolean type: array - uri: + description: A list of bool values. + id: GoogleCloudAiplatformV1BoolArray + GoogleCloudAiplatformV1FeatureViewSync: + properties: + createTime: + format: google-datetime + description: >- + Output only. Time when this FeatureViewSync is created. Creation of + a FeatureViewSync means that the job is pending / waiting for + sufficient resources but may not have started the actual data + transfer yet. type: string + readOnly: true + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + syncSummary: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncSyncSummary + readOnly: true + description: Output only. Summary of the sync job. + finalStatus: + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + description: Output only. Final status of the FeatureViewSync. + satisfiesPzi: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + runTime: + description: Output only. Time when this FeatureViewSync is finished. + readOnly: true + $ref: '#/components/schemas/GoogleTypeInterval' + name: description: >- - Required. The BigQuery view URI that will be materialized on each - sync trigger based on FeatureView.SyncConfig. - GoogleCloudAiplatformV1ListArtifactsResponse: - id: GoogleCloudAiplatformV1ListArtifactsResponse + Identifier. Name of the FeatureViewSync. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` + type: string + id: GoogleCloudAiplatformV1FeatureViewSync + type: object + description: >- + FeatureViewSync is a representation of sync operation which copies data + from data source to Feature View in Online Store. + GoogleCloudAiplatformV1DeployedIndexAuthConfig: type: object properties: - nextPageToken: + authProvider: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider + description: Defines the authentication provider that the DeployedIndex uses. + description: Used to set up the auth on the DeployedIndex's private endpoint. + id: GoogleCloudAiplatformV1DeployedIndexAuthConfig + GoogleCloudAiplatformV1EnvVar: + type: object + id: GoogleCloudAiplatformV1EnvVar + properties: + value: type: string description: >- - A token, which can be sent as ListArtifactsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. - artifacts: - description: The Artifacts retrieved from the MetadataStore. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + Required. Variables that reference a $(VAR_NAME) are expanded using + the previous defined environment variables in the container and any + service environment variables. If a variable cannot be resolved, the + reference in the input string will be unchanged. The $(VAR_NAME) + syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + references will never be expanded, regardless of whether the + variable exists or not. + name: + type: string + description: >- + Required. Name of the environment variable. Must be a valid C + identifier. + description: >- + Represents an environment variable present in a Container or Python + Module. + GoogleCloudAiplatformV1AddExecutionEventsRequest: + description: Request message for MetadataService.AddExecutionEvents. + properties: + events: + description: The Events to create and add. type: array - description: Response message for MetadataService.ListArtifacts. - GoogleCloudAiplatformV1GroundednessSpec: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' + id: GoogleCloudAiplatformV1AddExecutionEventsRequest + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs: properties: - version: - description: Optional. Which version to use for evaluation. - format: int32 - type: integer - description: Spec for groundedness metric. - id: GoogleCloudAiplatformV1GroundednessSpec + modelType: + type: string + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which c + annot be exported. Default. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) to a Jetson + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a Coral device + afterwards. + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_JETSON_VERSATILE_1 + - MOBILE_CORAL_VERSATILE_1 + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + GoogleCloudAiplatformV1ListNotebookRuntimesResponse: + id: GoogleCloudAiplatformV1ListNotebookRuntimesResponse type: object - GoogleCloudAiplatformV1DirectPredictResponse: - id: GoogleCloudAiplatformV1DirectPredictResponse properties: - outputs: + notebookRuntimes: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' type: array - description: The prediction output. - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. + description: List of NotebookRuntimes in the requested page. + nextPageToken: + type: string + description: >- + A token to retrieve next page of results. Pass to + ListNotebookRuntimesRequest.page_token to obtain that page. + description: Response message for NotebookService.ListNotebookRuntimes. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics + properties: + rougeLSum: + format: float + type: number + description: ROUGE-L (Longest Common Subsequence) scoring at summary level. type: object - description: Response message for PredictionService.DirectPredict. - GoogleCloudAiplatformV1PublisherModelCallToActionDeploy: - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + GoogleCloudAiplatformV1ImportFeatureValuesResponse: + id: GoogleCloudAiplatformV1ImportFeatureValuesResponse type: object + description: Response message for FeaturestoreService.ImportFeatureValues. properties: - containerSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' - description: >- - Optional. The specification of the container that is to be used when - deploying this Model in Vertex AI. Not present for Large Models. - automaticResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - description: >- - A description of resources that to large degree are decided by - Vertex AI, and require only a modest additional configuration. - title: - description: Required. The title of the regional resource reference. - type: string - artifactUri: + timestampOutsideRetentionRowsCount: description: >- - Optional. The path to the directory containing the Model artifact - and any of its supporting files. + The number rows that weren't ingested due to having feature + timestamps outside the retention boundary. + format: int64 type: string - modelDisplayName: - description: Optional. Default model display name. + importedFeatureValueCount: + description: Number of Feature values that have been imported by the operation. + format: int64 type: string - largeModelReference: + invalidRowCount: + format: int64 description: >- - Optional. Large model reference. When this is set, - model_artifact_spec is not needed. - $ref: '#/components/schemas/GoogleCloudAiplatformV1LargeModelReference' - publicArtifactUri: + The number of rows in input source that weren't imported due to + either * Not having any featureValues. * Having a null entityId. * + Having a null timestamp. * Not being parsable (applicable for CSV + sources). type: string + importedEntityCount: + description: Number of entities that have been imported by the operation. + format: int64 + type: string + GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex: + properties: + multiDeployVertex: + description: Optional. One click deployment configurations. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + type: array + type: object + description: Multiple setups to deploy the PublisherModel. + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex + GoogleCloudAiplatformV1TrialContext: + properties: + description: description: >- - Optional. The signed URI for ephemeral Cloud Storage access to model - artifact. - sharedResources: - description: >- - The resource name of the shared DeploymentResourcePool to deploy on. - Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + A human-readable field which can store a description of this + context. This will become part of the resulting Trial's description + field. type: string - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + parameters: description: >- - A description of resources that are dedicated to the DeployedModel, - and that need a higher degree of manual configuration. - deployMetadata: + If/when a Trial is generated or selected from this Context, its + Parameters will match any parameters specified here. (I.e. if this + context specifies parameter name:'a' int_value:3, then a resulting + Trial will have int_value:3 for its parameter named 'a'.) Note that + we first attempt to match existing REQUESTED Trials with contexts, + and if there are no matches, we generate suggestions in the subspace + defined by the parameters specified here. NOTE: a Context without + any Parameters matches the entire feasible search space. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + type: array + id: GoogleCloudAiplatformV1TrialContext + type: object + GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig: + type: object + description: >- + ModelDeploymentMonitoringObjectiveConfig contains the pair of + deployed_model_id to ModelMonitoringObjectiveConfig. + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig + properties: + objectiveConfig: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata - description: Optional. Metadata information about this deployment config. - deployTaskName: + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig description: >- - Optional. The name of the deploy task (e.g., "text to image - generation"). + The objective config of for the modelmonitoring job of this deployed + model. + deployedModelId: type: string - description: >- - Model metadata that is needed for UploadModel or - DeployModel/CreateEndpoint requests. - GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest: - properties: {} - description: Request message for JobService.ResumeModelDeploymentMonitoringJob. + description: The DeployedModel ID of the objective config. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask: + properties: + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec + description: The input parameters of this HyperparameterTuningTask. + description: A TrainingJob that tunes Hypererparameters of a custom code Model. type: object - id: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest - GoogleCloudAiplatformV1NotebookRuntime: - id: GoogleCloudAiplatformV1NotebookRuntime + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask + GoogleCloudAiplatformV1UndeployIndexResponse: + description: Response message for IndexEndpointService.UndeployIndex. + id: GoogleCloudAiplatformV1UndeployIndexResponse type: object + properties: {} + GoogleCloudAiplatformV1DeployIndexOperationMetadata: + type: object + description: Runtime operation information for IndexEndpointService.DeployIndex. + id: GoogleCloudAiplatformV1DeployIndexOperationMetadata properties: - serviceAccount: - readOnly: true - description: >- - Output only. The service account that the NotebookRuntime workload - runs as. + deployedIndexId: type: string - healthState: + description: The unique index id specified by user + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + GoogleCloudAiplatformV1SchemaVideoDatasetMetadata: + description: The metadata of Datasets that contain Video DataItems. + properties: + gcsBucket: type: string - enumDescriptions: - - Unspecified health state. - - NotebookRuntime is in healthy state. Applies to ACTIVE state. - - NotebookRuntime is in unhealthy state. Applies to ACTIVE state. - readOnly: true - enum: - - HEALTH_STATE_UNSPECIFIED - - HEALTHY - - UNHEALTHY - description: Output only. The health state of the NotebookRuntime. - idleShutdownConfig: description: >- - Output only. The idle shutdown configuration of the notebook - runtime. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig - readOnly: true - displayName: + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. + dataItemSchemaUri: type: string description: >- - Required. The display name of the NotebookRuntime. The name can be - up to 128 characters long and can consist of any UTF-8 characters. - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - description: - description: The description of the NotebookRuntime. - type: string - version: - description: Output only. The VM os image version of NotebookRuntime. - type: string - readOnly: true - isUpgradable: - readOnly: true - description: Output only. Whether NotebookRuntime is upgradable. - type: boolean - notebookRuntimeType: - description: Output only. The type of the notebook runtime. - readOnly: true - enumDescriptions: - - >- - Unspecified notebook runtime type, NotebookRuntimeType will - default to USER_DEFINED. - - runtime or template with coustomized configurations from user. - - runtime or template with system defined configurations. - enum: - - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED - - USER_DEFINED - - ONE_CLICK - type: string - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Output only. Customer-managed encryption key spec for the notebook - runtime. - readOnly: true - notebookRuntimeTemplateRef: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplateRef + Points to a YAML file stored on Google Cloud Storage describing + payload of the Video DataItems that belong to this Dataset. + id: GoogleCloudAiplatformV1SchemaVideoDatasetMetadata + type: object + GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig: + description: >- + Configuration defining how to transform batch prediction input instances + to the instances that the Model accepts. + type: object + properties: + excludedFields: + type: array description: >- - Output only. The pointer to NotebookRuntimeTemplate this - NotebookRuntime is created from. - readOnly: true - expirationTime: - readOnly: true + Fields that will be excluded in the prediction instance that is sent + to the Model. Excluded will be attached to the batch prediction + output if key_field is not specified. When excluded_fields is + populated, included_fields must be empty. The input must be JSONL + with objects at each line, BigQuery or TfRecord. + items: + type: string + instanceType: type: string description: >- - Output only. Timestamp when this NotebookRuntime will be expired: 1. - System Predefined NotebookRuntime: 24 hours after creation. After - expiration, system predifined runtime will be deleted. 2. User - created NotebookRuntime: 6 months after last upgrade. After - expiration, user created runtime will be stopped and allowed for - upgrade. - format: google-datetime - updateTime: + The format of the instance that the Model accepts. Vertex AI will + convert compatible batch prediction input instance formats to the + specified format. Supported values are: * `object`: Each input is + converted to JSON object format. * For `bigquery`, each row is + converted to an object. * For `jsonl`, each line of the JSONL input + must be an object. * Does not apply to `csv`, `file-list`, + `tf-record`, or `tf-record-gzip`. * `array`: Each input is converted + to JSON array format. * For `bigquery`, each row is converted to an + array. The order of columns is determined by the BigQuery column + order, unless included_fields is populated. included_fields must be + populated for specifying field orders. * For `jsonl`, if each line + of the JSONL input is an object, included_fields must be populated + for specifying field orders. * Does not apply to `csv`, `file-list`, + `tf-record`, or `tf-record-gzip`. If not specified, Vertex AI + converts the batch prediction input as follows: * For `bigquery` and + `csv`, the behavior is the same as `array`. The order of columns is + the same as defined in the file or table, unless included_fields is + populated. * For `jsonl`, the prediction instance format is + determined by each line of the input. * For + `tf-record`/`tf-record-gzip`, each record will be converted to an + object in the format of `{"b64": }`, where `` is the Base64-encoded + string of the content of the record. * For `file-list`, each file in + the list will be converted to an object in the format of `{"b64": + }`, where `` is the Base64-encoded string of the content of the + file. + includedFields: + type: array description: >- - Output only. Timestamp when this NotebookRuntime was most recently - updated. - type: string - format: google-datetime - readOnly: true - proxyUri: - type: string - description: Output only. The proxy endpoint used to access the NotebookRuntime. - readOnly: true - runtimeState: - readOnly: true - enumDescriptions: - - Unspecified runtime state. - - NotebookRuntime is in running state. - - NotebookRuntime is in starting state. - - NotebookRuntime is in stopping state. - - NotebookRuntime is in stopped state. - - >- - NotebookRuntime is in upgrading state. It is in the middle of - upgrading process. - - NotebookRuntime was unable to start/stop properly. - - NotebookRuntime is in invalid state. Cannot be recovered. - enum: - - RUNTIME_STATE_UNSPECIFIED - - RUNNING - - BEING_STARTED - - BEING_STOPPED - - STOPPED - - BEING_UPGRADED - - ERROR - - INVALID - description: Output only. The runtime (instance) state of the NotebookRuntime. + Fields that will be included in the prediction instance that is sent + to the Model. If instance_type is `array`, the order of field names + in included_fields also determines the order of the values in the + array. When included_fields is populated, excluded_fields must be + empty. The input must be JSONL with objects at each line, BigQuery + or TfRecord. + items: + type: string + keyField: + description: >- + The name of the field that is considered as a key. The values + identified by the key field is not included in the transformed + instances that is sent to the Model. This is similar to specifying + this name of the field in excluded_fields. In addition, the batch + prediction output will not include the instances. Instead the output + will only include the value of the key field, in a field named `key` + in the output: * For `jsonl` output format, the output will have a + `key` field instead of the `instance` field. * For `csv`/`bigquery` + output format, the output will have have a `key` column instead of + the instance feature columns. The input must be JSONL with objects + at each line, CSV, BigQuery or TfRecord. type: string + id: GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + GoogleLongrunningOperation: + properties: name: - description: Output only. The resource name of the NotebookRuntime. - type: string - readOnly: true - createTime: type: string - readOnly: true - format: google-datetime - description: Output only. Timestamp when this NotebookRuntime was created. - networkTags: description: >- - Optional. The Compute Engine tags to add to runtime (see [Tagging - instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). - type: array - items: - type: string - labels: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - The labels with user-defined metadata to organize your - NotebookRuntime. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. No more than 64 user labels can be associated with one - NotebookRuntime (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for NotebookRuntime: * - "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output - only, its value is the Compute Engine instance id. * - "aiplatform.googleapis.com/colab_enterprise_entry_service": its - value is either "bigquery" or "vertex"; if absent, it should be - "vertex". This is to describe the entry service, either BigQuery or - Vertex. + The error result of the operation in case of failure or + cancellation. + metadata: additionalProperties: - type: string + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. type: object - satisfiesPzs: - readOnly: true + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. type: boolean - description: Output only. Reserved for future use. - runtimeUser: - type: string - description: Required. The user email of the NotebookRuntime. - description: >- - A runtime is a virtual machine allocated to a particular user for a - particular Notebook file on temporary basis with lifetime limited to 24 - hours. - GoogleCloudAiplatformV1ExamplesExampleGcsSource: - id: GoogleCloudAiplatformV1ExamplesExampleGcsSource - description: The Cloud Storage input instances. - type: object - properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: The Cloud Storage location for the input instances. - dataFormat: - type: string - enumDescriptions: - - Format unspecified, used when unset. - - Examples are stored in JSONL files. - enum: - - DATA_FORMAT_UNSPECIFIED - - JSONL + response: description: >- - The format in which instances are given, if not specified, assume - it's JSONL format. Currently only JSONL format is supported. - GoogleCloudAiplatformV1SearchEntryPoint: - id: GoogleCloudAiplatformV1SearchEntryPoint - description: Google search entry point. + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource: properties: - renderedContent: - type: string - description: >- - Optional. Web content snippet that can be embedded in a web page or - an app webview. - sdkBlob: - format: byte + uri: + description: The URI of a BigQuery table. type: string - description: Optional. Base64 encoded JSON representing array of tuple. type: object - GoogleCloudAiplatformV1SafetyInput: - description: Input for safety metric. - properties: - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySpec' - description: Required. Spec for safety metric. - instance: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInstance' - description: Required. Safety instance. - id: GoogleCloudAiplatformV1SafetyInput + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource + GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult: type: object - GoogleCloudAiplatformV1ErrorAnalysisAnnotation: - id: GoogleCloudAiplatformV1ErrorAnalysisAnnotation + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult + description: Prediction output format for Image and Text Classification. properties: - attributedItems: + confidences: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem - description: >- - Attributed items for a given annotation, typically representing - neighbors from the training sets constrained by the query type. + type: number + format: float type: array - outlierThreshold: - type: number description: >- - The threshold used to determine if this annotation is an outlier or - not. - format: double - queryType: - enumDescriptions: - - Unspecified query type for model error analysis. - - Query similar samples across all classes in the dataset. - - Query similar samples from the same class of the input sample. - - Query dissimilar samples from the same class of the input sample. - enum: - - QUERY_TYPE_UNSPECIFIED - - ALL_SIMILAR - - SAME_CLASS_SIMILAR - - SAME_CLASS_DISSIMILAR - type: string - description: The query type used for finding the attributed items. - outlierScore: + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. + ids: + description: The resource IDs of the AnnotationSpecs that had been identified. + type: array + items: + type: string + format: int64 + displayNames: description: >- - The outlier score of this annotated item. Usually defined as the min - of all distances from attributed items. - type: number - format: double - type: object - description: Model error analysis for each annotation. - GoogleCloudAiplatformV1StreamingPredictRequest: - description: >- - Request message for PredictionService.StreamingPredict. The first - message must contain endpoint field and optionally input. The subsequent - messages must contain input. - id: GoogleCloudAiplatformV1StreamingPredictRequest - properties: - inputs: + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The prediction input. - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. - type: object - GoogleCloudAiplatformV1ExportModelResponse: - type: object - properties: {} - description: Response message of ModelService.ExportModel operation. - id: GoogleCloudAiplatformV1ExportModelResponse - GoogleCloudAiplatformV1CsvDestination: + type: string + GoogleCloudAiplatformV1NearestNeighbors: type: object - description: The storage details for CSV output content. - id: GoogleCloudAiplatformV1CsvDestination + id: GoogleCloudAiplatformV1NearestNeighbors + description: Nearest neighbors for one query. properties: - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Required. Google Cloud Storage location. - GoogleCloudAiplatformV1TuningDataStats: - id: GoogleCloudAiplatformV1TuningDataStats + neighbors: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborsNeighbor + type: array + description: All its neighbors. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs properties: - supervisedTuningDataStats: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats - description: The SFT Tuning data stats. + modelType: + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_CORAL_VERSATILE_1 + - MOBILE_CORAL_LOW_LATENCY_1 + - MOBILE_JETSON_VERSATILE_1 + - MOBILE_JETSON_LOW_LATENCY_1 + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which c + annot be exported. Default. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A versatile model that is meant to be exported (see + ModelService.ExportModel) and used on a Google Coral device. + - >- + A model that trades off quality for low latency, to be exported + (see ModelService.ExportModel) and used on a Google Coral device. + - >- + A versatile model that is meant to be exported (see + ModelService.ExportModel) and used on an NVIDIA Jetson device. + - >- + A model that trades off quality for low latency, to be exported + (see ModelService.ExportModel) and used on an NVIDIA Jetson + device. + type: string type: object - description: The tuning data statistic values for TuningJob. - CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: + GoogleCloudAiplatformV1RemoveDatapointsResponse: + description: Response message for IndexService.RemoveDatapoints + id: GoogleCloudAiplatformV1RemoveDatapointsResponse type: object - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - description: >- - An integer bounding box of original pixels of the image for the detected - labels. - properties: - y1: - format: int32 - description: The Y coordinate of the top-left corner, in pixels. - type: integer - x2: - type: integer - description: The X coordinate of the bottom-right corner, in pixels. - format: int32 - y2: - format: int32 - type: integer - description: The Y coordinate of the bottom-right corner, in pixels. - x1: - format: int32 - description: The X coordinate of the top-left corner, in pixels. - type: integer - GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: - id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + properties: {} + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics: type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics properties: - samplingRate: + confidenceThreshold: description: >- - Percentage of requests to be logged, expressed as a fraction in - range(0,1]. + Metrics are computed with an assumption that the Model never returns + predictions with score lower than this value. + format: float type: number - format: double - enabled: - type: boolean - description: If logging is enabled or not. - bigqueryDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: >- - BigQuery table for logging. If only given a project, a new dataset - will be created with name `logging__` where will be made - BigQuery-dataset-name compatible (e.g. most special characters will - become underscores). If no table name is given, a new table will be - created with name `request_response_logging` - description: Configuration for logging request-response to a BigQuery table. - GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata: - id: GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata - description: Details of operations that perform reboot PersistentResource. - properties: - progressMessage: - description: Progress Message for Reboot LRO - type: string - genericMetadata: - description: Operation metadata for PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - type: object - GoogleCloudAiplatformV1ToolParameterKVMatchInstance: - description: Spec for tool parameter key value match instance. - type: object - id: GoogleCloudAiplatformV1ToolParameterKVMatchInstance - properties: - reference: - description: Required. Ground truth used to compare against the prediction. - type: string - prediction: - type: string - description: Required. Output of the evaluated model. - GoogleCloudAiplatformV1SchemaAnnotationSpecColor: - type: object - description: >- - An entry of mapping between color and AnnotationSpec. The mapping is - used in segmentation mask. - id: GoogleCloudAiplatformV1SchemaAnnotationSpecColor + precision: + type: number + description: Precision for the given confidence threshold. + format: float + recall: + description: Recall (True Positive Rate) for the given confidence threshold. + format: float + type: number + f1Score: + format: float + description: The harmonic mean of recall and precision. + type: number + GoogleCloudAiplatformV1FeatureStatsAnomaly: properties: - displayName: - type: string + statsUri: description: >- - The display name of the AnnotationSpec represented by the color in - the segmentation mask. - id: + Path of the stats file for current feature values in Cloud Storage + bucket. Format: gs:////stats. Example: + gs://monitoring_bucket/feature_name/stats. Stats are stored as + binary format with Protobuf message + [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto). + type: string + anomalyUri: description: >- - The ID of the AnnotationSpec represented by the color in the - segmentation mask. + Path of the anomaly file for current feature values in Cloud Storage + bucket. Format: gs:////anomalies. Example: + gs://monitoring_bucket/feature_name/anomalies. Stats are stored as + binary format with Protobuf message Anoamlies are stored as binary + format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] + (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto). type: string - color: - $ref: '#/components/schemas/GoogleTypeColor' - description: The color of the AnnotationSpec in a segmentation mask. - GoogleCloudAiplatformV1UserActionReference: - type: object - properties: - dataLabelingJob: + anomalyDetectionThreshold: + format: double + type: number + description: >- + This is the threshold used when detecting anomalies. The threshold + can be changed by user, so this one might be different from + ThresholdConfig.value. + endTime: type: string + format: google-datetime description: >- - For API calls that start a LabelingJob. Resource name of the - LabelingJob. Format: - `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` - method: - description: >- - The method name of the API RPC call. For example, - "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset" - type: string - operation: + The end timestamp of window where stats were generated. For + objectives where time window doesn't make sense (e.g. Featurestore + Snapshot Monitoring), end_time indicates the timestamp of the data + used to generate stats (e.g. timestamp we take snapshots for feature + values). + distributionDeviation: + format: double description: >- - For API calls that return a long running operation. Resource name of - the long running operation. Format: - `projects/{project}/locations/{location}/operations/{operation}` - type: string - description: >- - References an API call. It contains more information about long running - operation and Jobs that are triggered by the API call. - id: GoogleCloudAiplatformV1UserActionReference - GoogleCloudAiplatformV1TunedModel: - description: >- - The Model Registry Model and Online Prediction Endpoint assiociated with - this TuningJob. - type: object - properties: - model: - readOnly: true + Deviation from the current stats to baseline stats. 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. + type: number + startTime: type: string + format: google-datetime description: >- - Output only. The resource name of the TunedModel. Format: - `projects/{project}/locations/{location}/models/{model}`. - endpoint: - type: string + The start timestamp of window where stats were generated. For + objectives where time window doesn't make sense (e.g. Featurestore + Snapshot Monitoring), start_time is only used to indicate the + monitoring intervals, so it always equals to (end_time - + monitoring_interval). + score: + type: number + format: double description: >- - Output only. A resource name of an Endpoint. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}`. - readOnly: true - id: GoogleCloudAiplatformV1TunedModel - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation: + Feature importance score, only populated when cross-feature + monitoring is enabled. For now only used to represent feature + attribution score within range [0, 1] for + ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and + ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT. + id: GoogleCloudAiplatformV1FeatureStatsAnomaly description: >- - Treats the column as categorical array and performs following - transformation functions. * For each element in the array, convert the - category name to a dictionary lookup index and generate an embedding for - each index. Combine the embedding of all elements into a single - embedding using the mean. * Empty arrays treated as an embedding of - zeroes. - properties: - columnName: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + Stats and Anomaly generated at specific timestamp for specific Feature. + The start_time and end_time are used to define the time range of the + dataset that current stats belongs to, e.g. prediction traffic is + bucketed into prediction datasets by time window. If the Dataset is not + defined by time window, start_time = end_time. Timestamp of the stats + and anomalies always refers to end_time. Raw stats and anomalies are + stored in stats_uri or anomaly_uri in the tensorflow defined protos. + Field data_stats contains almost identical information with the raw + stats in Vertex AI defined proto, for UI to display. type: object - GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance: - description: Prediction input format for Video Object Tracking. + GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries: type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance + id: GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries properties: - content: - description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. + timestampColumn: type: string - timeSegmentEnd: description: >- - The end, exclusive, of the video's time segment on which to perform - the prediction. Expressed as a number of seconds as measured from - the start of the video, with "s" appended at the end. Fractions are - allowed, up to a microsecond precision, and "inf" or "Infinity" is - allowed, which means the end of the video. + Optional. Column hosting timestamp values for a time-series source. + Will be used to determine the latest `feature_values` for each + entity. Optional. If not provided, column named `feature_timestamp` + of type `TIMESTAMP` will be used. + GoogleCloudAiplatformV1SupervisedTuningDataStats: + id: GoogleCloudAiplatformV1SupervisedTuningDataStats + properties: + totalTruncatedExampleCount: + format: int64 type: string - mimeType: description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime + The number of examples in the dataset that have been truncated by + any amount. + totalTuningCharacterCount: + format: int64 + description: Output only. Number of tuning characters in the tuning dataset. type: string - timeSegmentStart: - description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. + readOnly: true + totalBillableTokenCount: + description: Output only. Number of billable tokens in the tuning dataset. type: string - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature: - id: >- - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature - description: >- - Message to select time range and feature. Values of the selected feature - generated within an inclusive time range will be deleted. Using this - option permanently deletes the feature values from the specified feature - IDs within the specified time range. This might include data from the - online storage. If you want to retain any deleted historical data in the - online storage, you must re-ingest it. - type: object - properties: - skipOnlineStorageDelete: - description: >- - If set, data will not be deleted from online storage. When time - range is older than the data in online storage, setting this to be - true will make the deletion have no impact on online serving. - type: boolean - timeRange: - description: >- - Required. Select feature generated within a half-inclusive time - range. The time range is lower inclusive and upper exclusive. - $ref: '#/components/schemas/GoogleTypeInterval' - featureSelector: + format: int64 + readOnly: true + truncatedExampleIndices: + items: + format: int64 + type: string description: >- - Required. Selectors choosing which feature values to be deleted from - the EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - GoogleCloudAiplatformV1SchemaImageClassificationAnnotation: - properties: - annotationSpecId: + A partial sample of the indices (starting from 1) of the truncated + examples. + type: array + tuningStepCount: + description: Output only. Number of tuning steps for this Tuning Job. + format: int64 type: string - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - displayName: + readOnly: true + userMessagePerExampleDistribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + description: Output only. Dataset distributions for the messages per example. + readOnly: true + userDatasetExamples: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + readOnly: true + description: Output only. Sample user messages in the training dataset uri. + tuningDatasetExampleCount: + format: int64 + readOnly: true type: string - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - id: GoogleCloudAiplatformV1SchemaImageClassificationAnnotation - description: Annotation details specific to image classification. + description: Output only. Number of examples in the tuning dataset. + userOutputTokenDistribution: + description: Output only. Dataset distributions for the user output tokens. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + readOnly: true + totalBillableCharacterCount: + description: Output only. Number of billable characters in the tuning dataset. + type: string + deprecated: true + readOnly: true + format: int64 + userInputTokenDistribution: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + description: Output only. Dataset distributions for the user input tokens. + description: Tuning data statistics for Supervised Tuning. type: object - GoogleCloudAiplatformV1SchemaTextSentimentAnnotation: + GoogleCloudAiplatformV1PersistentDiskSpec: + description: Represents the spec of persistent disk options. type: object - id: GoogleCloudAiplatformV1SchemaTextSentimentAnnotation properties: - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. + diskSizeGb: + description: Size in GB of the disk (default is 100GB). type: string - sentimentMax: - format: int32 - description: The sentiment max score for text. - type: integer - sentiment: - format: int32 - type: integer - description: The sentiment score for text. - annotationSpecId: + format: int64 + diskType: type: string description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - description: Annotation details specific to text sentiment. - GoogleCloudAiplatformV1UpdateFeatureOperationMetadata: - type: object - description: Details of operations that perform update Feature. - id: GoogleCloudAiplatformV1UpdateFeatureOperationMetadata - properties: - genericMetadata: - description: Operation metadata for Feature Update. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1StreamRawPredictRequest: + 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) + id: GoogleCloudAiplatformV1PersistentDiskSpec + GoogleCloudAiplatformV1FluencySpec: properties: - httpBody: - description: >- - The prediction input. Supports HTTP headers and arbitrary data - payload. - $ref: '#/components/schemas/GoogleApiHttpBody' + version: + description: Optional. Which version to use for evaluation. + type: integer + format: int32 + description: Spec for fluency score metric. + id: GoogleCloudAiplatformV1FluencySpec type: object - description: Request message for PredictionService.StreamRawPredict. - id: GoogleCloudAiplatformV1StreamRawPredictRequest - GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource: - description: >- - A Feature Registry source for features that need to be synced to Online - Store. + GoogleCloudAiplatformV1MetadataSchema: type: object + description: Instance of a general MetadataSchema. properties: - projectNumber: + schema: + description: >- + Required. The raw YAML string representation of the MetadataSchema. + The combination of [MetadataSchema.version] and the schema name + given by `title` in [MetadataSchema.schema] must be unique within a + MetadataStore. The schema is defined as an OpenAPI 3.0.2 + [MetadataSchema + Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) + type: string + createTime: + description: Output only. Timestamp when this MetadataSchema was created. + format: google-datetime type: string + readOnly: true + schemaVersion: description: >- - Optional. The project number of the parent project of the Feature - Groups. - format: int64 - featureGroups: - description: Required. List of features that need to be synced to Online Store. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup - type: array - id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource - GoogleCloudAiplatformV1TrialParameter: - id: GoogleCloudAiplatformV1TrialParameter - description: A message representing a parameter to be tuned. - properties: - parameterId: + The version of the MetadataSchema. The version's format must match + the following regular expression: `^[0-9]+.+.+$`, which would allow + to order/compare different versions. Example: 1.0.0, 1.0.1, etc. + type: string + schemaType: + enumDescriptions: + - Unspecified type for the MetadataSchema. + - >- + A type indicating that the MetadataSchema will be used by + Artifacts. + - >- + A typee indicating that the MetadataSchema will be used by + Executions. + - >- + A state indicating that the MetadataSchema will be used by + Contexts. + enum: + - METADATA_SCHEMA_TYPE_UNSPECIFIED + - ARTIFACT_TYPE + - EXECUTION_TYPE + - CONTEXT_TYPE type: string description: >- - Output only. The ID of the parameter. The parameter should be - defined in StudySpec's Parameters. - readOnly: true - value: + The type of the MetadataSchema. This is a property that identifies + which metadata types will use the MetadataSchema. + description: + description: Description of the Metadata Schema + type: string + name: readOnly: true - description: >- - Output only. The value of the parameter. `number_value` will be set - if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' - or 'DISCRETE'. `string_value` will be set if a parameter defined in - StudySpec is in type 'CATEGORICAL'. - type: any - type: object - GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata: - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Output only. The resource name of the MetadataSchema. + type: string + id: GoogleCloudAiplatformV1MetadataSchema + GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics: id: >- - GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata + GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics type: object - description: >- - Runtime operation information for - JobService.UpdateModelDeploymentMonitoringJob. - GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec: - description: >- - The median automated stopping rule stops a pending Trial if the Trial's - best objective_value is strictly below the median 'performance' of all - completed Trials reported up to the Trial's last measurement. Currently, - 'performance' refers to the running average of the objective values - reported by the Trial in each measurement. - id: GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec properties: - useElapsedDuration: - type: boolean + exactMatch: + format: float description: >- - True if median automated stopping rule applies on - Measurement.elapsed_duration. It means that elapsed_duration field - of latest measurement of current Trial is used to compute median - objective value for each completed Trials. - type: object - GoogleCloudAiplatformV1SummarizationHelpfulnessInstance: - description: Spec for summarization helpfulness instance. - type: object - id: GoogleCloudAiplatformV1SummarizationHelpfulnessInstance - properties: - reference: - type: string - description: Optional. Ground truth used to compare against the prediction. - instruction: - type: string - description: Optional. Summarization prompt for LLM. - context: - type: string - description: Required. Text to be summarized. - prediction: - type: string - description: Required. Output of the evaluated model. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + The rate at which the input predicted strings exactly match their + references. + type: number + GoogleCloudAiplatformV1ModelContainerSpec: type: object + id: GoogleCloudAiplatformV1ModelContainerSpec properties: - evaluatedDataItemsBigqueryUri: - type: string - description: BigQuery destination uri for exported evaluated examples. - trainCostMilliNodeHours: + imageUri: type: string description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - format: int64 - description: Model metadata specific to TFT Forecasting. - GoogleCloudAiplatformV1LineageSubgraph: - description: >- - A subgraph of the overall lineage graph. Event edges connect Artifact - and Execution nodes. - properties: - executions: - description: The Execution nodes in the subgraph. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - events: - type: array + Required. Immutable. URI of the Docker image to be used as the + custom container for serving predictions. This URI must identify an + image in Artifact Registry or Container Registry. Learn more about + the [container publishing + requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), + including permissions requirements for the Vertex AI Service Agent. + The container image is ingested upon ModelService.UploadModel, + stored internally, and this original path is afterwards not used. To + learn about the requirements for the Docker image itself, see + [Custom container + requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). + You can use the URI to one of Vertex AI's [pre-built container + images for + prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) + in this field. + healthRoute: + description: >- + Immutable. HTTP path on the container to send health checks to. + Vertex AI intermittently sends GET requests to this path on the + container's IP address and port to check that the container is + healthy. Read more about [health + checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). + For example, if you set this field to `/bar`, then Vertex AI + intermittently sends a GET request to the `/bar` path on the port of + your container specified by the first value of this + `ModelContainerSpec`'s ports field. If you don't specify this field, + it defaults to the following value when you deploy this Model to an + Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ + DEPLOYED_MODEL:predict The placeholders in this value are replaced + as follows: * ENDPOINT: The last segment (following `endpoints/`)of + the Endpoint.name][] field of the Endpoint where this Model has been + deployed. (Vertex AI makes this value available to your container + code as the [`AIP_ENDPOINT_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex + AI makes this value available to your container code as the + [`AIP_DEPLOYED_MODEL_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + type: string + env: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' - description: The Event edges between Artifacts and Executions in the subgraph. - artifacts: - description: The Artifact nodes in the subgraph. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + description: >- + Immutable. List of environment variables to set in the container. + After the container starts running, code running in the container + can read these environment variables. Additionally, the command and + args fields can reference these variables. Later entries in this + list can also reference earlier entries. For example, the following + example sets the variable `VAR_2` to have the value `foo bar`: + ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", + "value": "$(VAR_1) bar" } ] ``` If you switch the order of the + variables in the example, then the expansion does not occur. This + field corresponds to the `env` field of the Kubernetes Containers + [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). type: array + ports: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - type: object - id: GoogleCloudAiplatformV1LineageSubgraph - GoogleIamV1Binding: - properties: - members: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' type: array + description: >- + Immutable. List of ports to expose from the container. Vertex AI + sends any prediction requests that it receives to the first port on + this list. Vertex AI also sends [liveness and health + checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) + to this port. If you do not specify this field, it defaults to + following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI + does not use ports other than the first one listed. This field + corresponds to the `ports` field of the Kubernetes Containers [v1 + core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + args: items: type: string + type: array description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - role: + Immutable. Specifies arguments for the command that runs when the + container starts. This overrides the container's + [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). + Specify this field as an array of executable and arguments, similar + to a Docker `CMD`'s "default parameters" form. If you don't specify + this field but do specify the command field, then the command from + the `command` field runs without any additional arguments. See the + [Kubernetes documentation about how the `command` and `args` fields + interact with a container's `ENTRYPOINT` and + `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). + If you don't specify this field and don't specify the `command` + field, then the container's + [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) + and `CMD` determine what runs based on their default behavior. See + the Docker documentation about [how `CMD` and `ENTRYPOINT` + interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). + In this field, you can reference [environment variables set by + Vertex + AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) + and environment variables set in the env field. You cannot reference + environment variables set in the Docker image. In order for + environment variables to be expanded, reference them by using the + following syntax: $( VARIABLE_NAME) Note that this differs from Bash + variable expansion, which does not use parentheses. If a variable + cannot be resolved, the reference in the input string is used + unchanged. To avoid variable expansion, you can escape this syntax + with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to + the `args` field of the Kubernetes Containers [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + command: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). + Immutable. Specifies the command that runs when the container + starts. This overrides the container's + [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). + Specify this field as an array of executable and arguments, similar + to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you + do not specify this field, then the container's `ENTRYPOINT` runs, + in conjunction with the args field or the container's + [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if + either exists. If this field is not specified and the container does + not have an `ENTRYPOINT`, then refer to the Docker documentation + about [how `CMD` and `ENTRYPOINT` + interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). + If you specify this field, then you can also specify the `args` + field to provide additional arguments for this command. However, if + you specify this field, then the container's `CMD` is ignored. See + the [Kubernetes documentation about how the `command` and `args` + fields interact with a container's `ENTRYPOINT` and + `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). + In this field, you can reference [environment variables set by + Vertex + AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) + and environment variables set in the env field. You cannot reference + environment variables set in the Docker image. In order for + environment variables to be expanded, reference them by using the + following syntax: $( VARIABLE_NAME) Note that this differs from Bash + variable expansion, which does not use parentheses. If a variable + cannot be resolved, the reference in the input string is used + unchanged. To avoid variable expansion, you can escape this syntax + with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to + the `command` field of the Kubernetes Containers [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + items: + type: string + type: array + deploymentTimeout: + format: google-duration + description: >- + Immutable. Deployment timeout. Limit for deployment timeout is 2 + hours. type: string - condition: + startupProbe: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + description: Immutable. Specification for Kubernetes startup probe. + healthProbe: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + description: Immutable. Specification for Kubernetes readiness probe. + grpcPorts: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' + type: array description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' - description: Associates `members`, or principals, with a `role`. - type: object - id: GoogleIamV1Binding - GoogleCloudAiplatformV1SummarizationQualitySpec: - id: GoogleCloudAiplatformV1SummarizationQualitySpec - description: Spec for summarization quality score metric. - type: object - properties: - version: - format: int32 - type: integer - description: Optional. Which version to use for evaluation. - useReference: + Immutable. List of ports to expose from the container. Vertex AI + sends gRPC prediction requests that it receives to the first port on + this list. Vertex AI also sends liveness and health checks to this + port. If you do not specify this field, gRPC requests to the + container will be disabled. Vertex AI does not use ports other than + the first one listed. This field corresponds to the `ports` field of + the Kubernetes Containers v1 core API. + sharedMemorySizeMb: description: >- - Optional. Whether to use instance.reference to compute summarization - quality. - type: boolean - GoogleCloudAiplatformV1ExactMatchResults: + Immutable. The amount of the VM memory to reserve as the shared + memory for the model in megabytes. + type: string + format: int64 + predictRoute: + type: string + description: >- + Immutable. HTTP path on the container to send prediction requests + to. Vertex AI forwards requests sent using + projects.locations.endpoints.predict to this path on the container's + IP address and port. Vertex AI then returns the container's response + in the API response. For example, if you set this field to `/foo`, + then when Vertex AI receives a prediction request, it forwards the + request body in a POST request to the `/foo` path on the port of + your container specified by the first value of this + `ModelContainerSpec`'s ports field. If you don't specify this field, + it defaults to the following value when you deploy this Model to an + Endpoint: + /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The + placeholders in this value are replaced as follows: * ENDPOINT: The + last segment (following `endpoints/`)of the Endpoint.name][] field + of the Endpoint where this Model has been deployed. (Vertex AI makes + this value available to your container code as the + [`AIP_ENDPOINT_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex + AI makes this value available to your container code as the + [`AIP_DEPLOYED_MODEL_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + description: >- + Specification of a container for serving predictions. Some fields in + this message correspond to fields in the [Kubernetes Container v1 core + specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation properties: - exactMatchMetricValues: - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchMetricValue' - description: Output only. Exact match metric values. - type: array - description: Results for exact match metric. + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation type: object - id: GoogleCloudAiplatformV1ExactMatchResults - GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint: + GoogleCloudAiplatformV1PointwiseMetricSpec: + id: GoogleCloudAiplatformV1PointwiseMetricSpec properties: - serviceAttachment: + metricPromptTemplate: type: string + description: Required. Metric prompt template for pointwise metric. + description: Spec for pointwise metric. + type: object + GoogleCloudAiplatformV1Measurement: + description: >- + A message representing a Measurement of a Trial. A Measurement contains + the Metrics got by executing a Trial using suggested hyperparameter + values. + id: GoogleCloudAiplatformV1Measurement + properties: + stepCount: readOnly: true description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled and after FeatureViewSync is - created. - publicEndpointDomainName: + Output only. The number of steps the machine learning model has been + trained for. Must be non-negative. + format: int64 type: string - readOnly: true + elapsedDuration: description: >- - Output only. This field will be populated with the domain name to - use for this FeatureOnlineStore - privateServiceConnectConfig: + Output only. Time that the Trial has been running at the point of + this Measurement. + readOnly: true + format: google-duration + type: string + metrics: + readOnly: true description: >- - Optional. Private service connect config. The private service - connection is available only for Optimized storage type, not for - embedding management now. If - PrivateServiceConnectConfig.enable_private_service_connect set to - true, customers will use private service connection to send request. - Otherwise, the connection will set to public endpoint. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig - description: >- - The dedicated serving endpoint for this FeatureOnlineStore. Only need to - set when you choose Optimized storage type. Public endpoint is - provisioned by default. + Output only. A list of metrics got by evaluating the objective + functions using suggested Parameter values. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MeasurementMetric' type: object - id: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint - GoogleCloudAiplatformV1PairwiseSummarizationQualityResult: - id: GoogleCloudAiplatformV1PairwiseSummarizationQualityResult - description: Spec for pairwise summarization quality result. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics: type: object properties: - pairwiseChoice: - enumDescriptions: - - Unspecified prediction choice. - - Baseline prediction wins - - Candidate prediction wins - - Winner cannot be determined - description: Output only. Pairwise summarization prediction choice. - enum: - - PAIRWISE_CHOICE_UNSPECIFIED - - BASELINE - - CANDIDATE - - TIE - readOnly: true - type: string - explanation: - readOnly: true - description: Output only. Explanation for summarization quality score. + truePositiveCount: type: string - confidence: - description: Output only. Confidence for summarization quality score. + format: int64 + description: The number of Model created labels that match a ground truth label. + precision: format: float + description: Precision for the given confidence threshold. type: number - readOnly: true - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics: - properties: - boundingBoxMeanAveragePrecision: + maxPredictions: + type: integer + description: >- + Metrics are computed with an assumption that the Model always + returns at most this many predictions (ordered by their score, + descendingly), but they all still need to meet the + `confidenceThreshold`. + format: int32 + recall: + format: float + type: number + description: Recall (True Positive Rate) for the given confidence threshold. + falsePositiveRate: + format: float + description: False Positive Rate for the given confidence threshold. + type: number + f1ScoreMicro: + type: number + format: float + description: Micro-averaged F1 Score. + confidenceThreshold: format: float description: >- - The single metric for bounding boxes evaluation: the - `meanAveragePrecision` averaged over all `boundingBoxMetrics`. + Metrics are computed with an assumption that the Model never returns + predictions with score lower than this value. type: number - boundingBoxMetrics: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics + falsePositiveCount: + type: string + format: int64 description: >- - The bounding boxes match metrics for each intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - trackMeanAveragePrecision: + The number of Model created labels that do not match a ground truth + label. + confusionMatrix: + description: Confusion matrix of the evaluation for this confidence_threshold. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + falsePositiveRateAt1: + description: >- + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each DataItem. + format: float + type: number + f1ScoreMacro: + description: Macro-averaged F1 Score. type: number format: float + f1Score: description: >- - UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the - `meanAveragePrecision` averaged over all `trackMetrics`. - trackMeanBoundingBoxIou: + The harmonic mean of recall and precision. For summary metrics, it + computes the micro-averaged F1 score. + format: float type: number + recallAt1: format: float description: >- - UNIMPLEMENTED. The single metric for tracks bounding box iou - evaluation: the `meanBoundingBoxIou` averaged over all - `trackMetrics`. - trackMeanMismatchRate: - description: >- - UNIMPLEMENTED. The single metric for tracking consistency - evaluation: the `meanMismatchRate` averaged over all `trackMetrics`. + The Recall (True Positive Rate) when only considering the label that + has the highest prediction score and not below the confidence + threshold for each DataItem. + type: number + precisionAt1: type: number format: float - trackMetrics: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics - description: >- - UNIMPLEMENTED. The tracks match metrics for each - intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - type: array - evaluatedFrameCount: - format: int32 description: >- - UNIMPLEMENTED. The number of video frames used to create this - evaluation. - type: integer - evaluatedBoundingBoxCount: - type: integer - format: int32 + The precision when only considering the label that has the highest + prediction score and not below the confidence threshold for each + DataItem. + falseNegativeCount: + format: int64 + type: string description: >- - UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over - all frames) the ground truth used to create this evaluation had. - evaluatedTrackCount: - format: int32 - type: integer + The number of ground truth labels that are not matched by a Model + created label. + f1ScoreAt1: + type: number + format: float + description: The harmonic mean of recallAt1 and precisionAt1. + trueNegativeCount: + format: int64 description: >- - UNIMPLEMENTED. The total number of tracks (i.e. as seen across all - frames) the ground truth used to create this evaluation had. - type: object - description: >- - Model evaluation metrics for video object tracking problems. Evaluates - prediction quality of both labeled bounding boxes and labeled tracks - (i.e. series of bounding boxes sharing same label and instance ID). + The number of labels that were not created by the Model, but if they + would, they would not match a ground truth label. + type: string id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics - GoogleCloudAiplatformV1CopyModelRequest: + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + GoogleCloudAiplatformV1NotebookEucConfig: + properties: + eucDisabled: + type: boolean + description: >- + Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. + In proto3, the default value of a boolean is false. In this way, by + default EUC will be enabled for NotebookRuntimeTemplate. + bypassActasCheck: + type: boolean + readOnly: true + description: >- + Output only. Whether ActAs check is bypassed for service account + attached to the VM. If false, we need ActAs check for the default + Compute Engine Service account. When a Runtime is created, a VM is + allocated using Default Compute Engine Service Account. Any user + requesting to use this Runtime requires Service Account User (ActAs) + permission over this SA. If true, Runtime owner is using EUC and + does not require the above permission as VM no longer use default + Compute Engine SA, but a P4SA. + id: GoogleCloudAiplatformV1NotebookEucConfig type: object - description: Request message for ModelService.CopyModel. - id: GoogleCloudAiplatformV1CopyModelRequest + description: The euc configuration of NotebookRuntimeTemplate. + GoogleCloudAiplatformV1NasJob: + description: Represents a Neural Architecture Search (NAS) job. properties: - modelId: - type: string + enableRestrictedImageTraining: + deprecated: true description: >- - Optional. Copy source_model into a new Model with this ID. The ID - will become the final component of the model 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. - sourceModel: - type: string + Optional. Enable a separation of Custom model training and + restricted image training for tenant project. + type: boolean + labels: + additionalProperties: + type: string + type: object description: >- - Required. The resource name of the Model to copy. That Model must be - in the same Project. Format: - `projects/{project}/locations/{location}/models/{model}` - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + The labels with user-defined metadata to organize NasJobs. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + nasJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobSpec' + description: Required. The specification of a NasJob. + error: description: >- - Customer-managed encryption key options. If this is set, then the - Model copy will be encrypted with the provided encryption key. - parentModel: - type: string + Output only. Only populated when job's state is JOB_STATE_FAILED or + JOB_STATE_CANCELLED. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + displayName: description: >- - Optional. Specify this field to copy source_model into this existing - Model as a new version. Format: - `projects/{project}/locations/{location}/models/{model}` - GoogleCloudAiplatformV1WriteTensorboardRunDataRequest: - type: object - id: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest - description: Request message for TensorboardService.WriteTensorboardRunData. - properties: - tensorboardRun: + Required. The display name of the NasJob. The name can be up to 128 + characters long and can consist of any UTF-8 characters. type: string + startTime: description: >- - Required. The resource name of the TensorboardRun to write data to. - Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - timeSeriesData: - description: >- - Required. The TensorboardTimeSeries data to write. Values with in a - time series are indexed by their step value. Repeated writes to the - same step will overwrite the existing value for that step. The upper - limit of data points per write request is 5000. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' - type: array - GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource: - description: The content of the input notebook in ipynb format. - type: object - id: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource - properties: - content: + Output only. Time when the NasJob for the first time entered the + `JOB_STATE_RUNNING` state. + format: google-datetime + readOnly: true type: string - description: The base64-encoded contents of the input notebook file. - format: byte - CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: - id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail - description: 'Create API error message for Vertex Pipeline. Next Id: 3.' - type: object - properties: - errorCause: + state: enum: - - ERROR_CAUSE_UNSPECIFIED - - INVALID_PIPELINE_SPEC_FORMAT - - INVALID_PIPELINE_SPEC - - INVALID_DEPLOYMENT_CONFIG - - INVALID_DEPLOYMENT_SPEC - - INVALID_INSTANCE_SCHEMA - - INVALID_CUSTOM_JOB - - INVALID_CONTAINER_SPEC - - INVALID_NOTIFICATION_EMAIL_SETUP - - INVALID_SERVICE_ACCOUNT_SETUP - - INVALID_KMS_SETUP - - INVALID_NETWORK_SETUP - - INVALID_PIPELINE_TASK_SPEC - - INVALID_PIPELINE_TASK_ARTIFACT - - INVALID_IMPORTER_SPEC - - INVALID_RESOLVER_SPEC - - INVALID_RUNTIME_PARAMETERS - - CLOUD_API_NOT_ENABLED - - INVALID_GCS_INPUT_URI - - INVALID_GCS_OUTPUT_URI - - INVALID_COMPONENT_SPEC - - INVALID_DAG_OUTPUTS_SPEC - - INVALID_DAG_SPEC - - INSUFFICIENT_QUOTA - - INTERNAL - description: The error root cause returned by CreatePipelineJob API. - type: string + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED enumDescriptions: - - Should never be used. - - IR Pipeline Spec can not been parsed to yaml or json format. - - A pipeline spec is invalid. - - A deployment config is invalid. - - A deployment spec is invalid. - - An instance schema is invalid. - - A custom job is invalid. - - A container spec is invalid. - - Notification email setup is invalid. - - Service account setup is invalid. - - KMS setup is invalid. - - Network setup is invalid. - - Task spec is invalid. - - Task artifact is invalid. - - Importer spec is invalid. - - Resolver spec is invalid. - - Runtime Parameters are invalid. - - Cloud API not enabled. - - Invalid GCS input uri - - Invalid GCS output uri - - Component spec of pipeline is invalid. - - DagOutputsSpec is invalid. - - DagSpec is invalid. - - Project does not have enough quota. - - An internal error with unknown cause. - publicMessage: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. type: string - description: Public messages contains actionable items for the error cause. - GoogleCloudAiplatformV1ResourcesConsumed: - properties: - replicaHours: - description: >- - Output only. The number of replica hours used. Note that many - replicas may run in parallel, and additionally any given work may be - queued for some time. Therefore this value is not strictly related - to wall time. readOnly: true - type: number - format: double - id: GoogleCloudAiplatformV1ResourcesConsumed - description: Statistics information about resource consumption. - type: object - GoogleCloudAiplatformV1PointwiseMetricInstance: - id: GoogleCloudAiplatformV1PointwiseMetricInstance - description: >- - Pointwise metric instance. Usually one instance corresponds to one row - in an evaluation dataset. - properties: - jsonInstance: - description: >- - Instance specified as a json string. String key-value pairs are - expected in the json_instance to render - PointwiseMetricSpec.instance_prompt_template. - type: string - type: object - GoogleCloudAiplatformV1ToolCallValidResults: - properties: - toolCallValidMetricValues: - type: array - description: Output only. Tool call valid metric values. + description: Output only. The detailed state of the job. + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. readOnly: true - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolCallValidMetricValue - description: Results for tool call valid metric. - type: object - id: GoogleCloudAiplatformV1ToolCallValidResults - GoogleCloudAiplatformV1PipelineTemplateMetadata: - properties: - version: - description: >- - The version_name in artifact registry. Will always be presented in - output if the PipelineJob.template_uri is from supported template - registry. Format is "sha256:abcdef123456...". - type: string - description: >- - Pipeline template metadata if PipelineJob.template_uri is from supported - template registry. Currently, the only supported registry is Artifact - Registry. - type: object - id: GoogleCloudAiplatformV1PipelineTemplateMetadata - GoogleCloudAiplatformV1MetadataStore: - properties: - dataplexConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MetadataStoreDataplexConfig - description: Optional. Dataplex integration settings. updateTime: - description: Output only. Timestamp when this MetadataStore was last updated. - readOnly: true + description: Output only. Time when the NasJob was most recently updated. type: string format: google-datetime - name: - type: string - description: Output only. The resource name of the MetadataStore instance. readOnly: true - createTime: + endTime: + readOnly: true format: google-datetime - description: Output only. Timestamp when this MetadataStore was created. type: string + description: >- + Output only. Time when the NasJob entered any of the following + states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + nasJobOutput: + description: Output only. Output of the NasJob. readOnly: true - state: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MetadataStoreMetadataStoreState - description: Output only. State information of the MetadataStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobOutput' + createTime: + description: Output only. Time when the NasJob was created. + type: string readOnly: true + format: google-datetime encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Customer-managed encryption key spec for a Metadata Store. If set, - this Metadata Store and all sub-resources of this Metadata Store are - secured using this key. - description: + Customer-managed encryption key options for a NasJob. If this is + set, then all resources created by the NasJob will be encrypted with + the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + satisfiesPzi: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + name: + description: Output only. Resource name of the NasJob. type: string - description: Description of the MetadataStore. - type: object - id: GoogleCloudAiplatformV1MetadataStore - description: >- - Instance of a metadata store. Contains a set of metadata that can be - queried. - GoogleCloudAiplatformV1ToolParameterKeyMatchInstance: - description: Spec for tool parameter key match instance. - id: GoogleCloudAiplatformV1ToolParameterKeyMatchInstance + readOnly: true type: object + id: GoogleCloudAiplatformV1NasJob + GoogleCloudAiplatformV1GroundednessSpec: properties: - reference: - type: string - description: Required. Ground truth used to compare against the prediction. - prediction: - type: string - description: Required. Output of the evaluated model. - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig: + version: + type: integer + description: Optional. Which version to use for evaluation. + format: int32 + id: GoogleCloudAiplatformV1GroundednessSpec + description: Spec for groundedness metric. type: object + GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest: + id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + description: Request message for ModelService.BatchImportEvaluatedAnnotations properties: - dataset: - type: string - description: >- - Required. Full resource name of data labeling Dataset. Format: - `projects/{project}/datasets/{dataset}`. - datasetDisplayName: - type: string - description: >- - Optional. Display name of the Dataset in Vertex AI. System will pick - a display name if unspecified. - migrateDataLabelingAnnotatedDatasetConfigs: - type: array - description: >- - Optional. Configs for migrating AnnotatedDataset in - datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified - AnnotatedDatasets have to belong to the datalabeling Dataset. + evaluatedAnnotations: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig - description: >- - Config for migrating Dataset in datalabeling.googleapis.com to Vertex - AI's Dataset. - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig - GoogleCloudAiplatformV1ToolParameterKVMatchInput: - id: GoogleCloudAiplatformV1ToolParameterKVMatchInput - properties: - metricSpec: - description: Required. Spec for tool parameter key value match metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchSpec' - instances: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotation' type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInstance - description: Required. Repeated tool parameter key value match instances. + description: Required. Evaluated annotations resource to be imported. type: object - description: Input for tool parameter key value match metric. - GoogleRpcStatus: + GoogleCloudAiplatformV1ListFeatureViewsResponse: + id: GoogleCloudAiplatformV1ListFeatureViewsResponse + description: Response message for FeatureOnlineStoreAdminService.ListFeatureViews. type: object properties: - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - code: - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation: - id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation - description: The mask based segmentation annotation. - properties: - annotationSpecColors: - description: The mapping between color and AnnotationSpec for this Annotation. + featureViews: + description: The FeatureViews matching the request. type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaAnnotationSpecColor - maskGcsUri: - description: >- - Google Cloud Storage URI that points to the mask image. The image - must be in PNG format. It must have the same size as the DataItem's - image. Each pixel in the image mask represents the AnnotationSpec - which the pixel in the image DataItem belong to. Each color is - mapped to one AnnotationSpec based on annotation_spec_colors. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + nextPageToken: type: string + description: >- + A token, which can be sent as ListFeatureViewsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest: type: object - GoogleCloudAiplatformV1Content: - description: >- - The base structured datatype containing multi-part content of a message. - A `Content` includes a `role` field designating the producer of the - `Content` and a `parts` field containing multi-part data that contains - the content of the message turn. + id: GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest properties: - parts: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' - type: array + tensorboardTimeSeriesId: description: >- - Required. Ordered `Parts` that constitute a single message. Parts - may have different IANA MIME types. - role: + 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}" + type: string + tensorboardTimeSeries: + description: Required. The TensorboardTimeSeries to create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + parent: type: string description: >- - Optional. The producer of the content. Must be either 'user' or - 'model'. Useful to set for multi-turn conversations, otherwise can - be left blank or unset. - type: object - id: GoogleCloudAiplatformV1Content - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation: + Required. The resource name of the TensorboardRun to create the + TensorboardTimeSeries in. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + description: Request message for TensorboardService.CreateTensorboardTimeSeries. + GoogleCloudAiplatformV1PredictSchemata: type: object + id: GoogleCloudAiplatformV1PredictSchemata properties: - columnName: + instanceSchemaUri: + type: string + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the format of a single instance, which are used in + PredictRequest.instances, ExplainRequest.instances and + BatchPredictionJob.input_config. The schema is defined as an OpenAPI + 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. + predictionSchemaUri: + type: string + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the format of a single prediction produced by this Model, + which are returned via PredictResponse.predictions, + ExplainResponse.explanations, and BatchPredictionJob.output_config. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. + parametersSchemaUri: + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the parameters of prediction and explanation via + PredictRequest.parameters, ExplainRequest.parameters and + BatchPredictionJob.model_parameters. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI, if no + parameters are supported, then it is set to an empty string. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. type: string description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. * A boolean value that indicates whether the - value is valid. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest: - properties: {} - description: Request message for VizierService.CheckTrialEarlyStoppingState. + Contains the schemata used in Model's predictions and explanations via + PredictionService.Predict, PredictionService.Explain and + BatchPredictionJob. + GoogleCloudAiplatformV1PurgeExecutionsMetadata: type: object - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest - GoogleCloudAiplatformV1ToolNameMatchResults: - id: GoogleCloudAiplatformV1ToolNameMatchResults - description: Results for tool name match metric. properties: - toolNameMatchMetricValues: - description: Output only. Tool name match metric values. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolNameMatchMetricValue - readOnly: true - type: object - GoogleCloudAiplatformV1DeployedIndexRef: - type: object - id: GoogleCloudAiplatformV1DeployedIndexRef - description: Points to a DeployedIndex. + genericMetadata: + description: Operation metadata for purging Executions. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1PurgeExecutionsMetadata + description: Details of operations that perform MetadataService.PurgeExecutions. + GoogleCloudAiplatformV1FeatureGroup: properties: - indexEndpoint: + bigQuery: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQuery' + description: >- + Indicates that features for this group come from BigQuery + Table/View. By default treats the source as a sparse time series + source. The BigQuery source table or view must have at least one + entity ID column and a column named `feature_timestamp`. + labels: + type: object + additionalProperties: + type: string + description: >- + Optional. The labels with user-defined metadata to organize your + FeatureGroup. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureGroup(System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + etag: + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + type: string + createTime: + description: Output only. Timestamp when this FeatureGroup was created. type: string - description: Immutable. A resource name of the IndexEndpoint. - displayName: - description: Output only. The display name of the DeployedIndex. readOnly: true + format: google-datetime + description: + description: Optional. Description of the FeatureGroup. type: string - deployedIndexId: + name: type: string - description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. - GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest: + description: >- + Identifier. Name of the FeatureGroup. Format: + `projects/{project}/locations/{location}/featureGroups/{featureGroup}` + updateTime: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this FeatureGroup was last updated. + type: string + id: GoogleCloudAiplatformV1FeatureGroup + type: object + description: Vertex AI Feature Group. + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition: + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition + description: Represents the spec to match discrete values from parent parameter. properties: - names: + values: description: >- - Required. The names of the PipelineJobs to delete. A maximum of 32 - PipelineJobs can be deleted in a batch. Format: - `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` + Required. Matches values of the parent parameter of 'DISCRETE' type. + All values must exist in `discrete_value_spec` of parent parameter. + The Epsilon of the value matching is 1e-10. type: array items: - type: string - id: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest + type: number + format: double type: object - description: Request message for PipelineService.BatchDeletePipelineJobs. - GoogleTypeColor: - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... + GoogleCloudAiplatformV1GenerateContentRequest: type: object - id: GoogleTypeColor properties: - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - type: number - alpha: - format: float + generationConfig: + description: Optional. Generation config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' + contents: + type: array description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - type: number - red: - description: The amount of red in the color as a value in the interval [0, 1]. - format: float - type: number - green: - type: number - description: The amount of green in the color as a value in the interval [0, 1]. - format: float - GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact: - id: GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact - type: object + Required. The content of the current conversation with the model. + For single-turn queries, this is a single instance. For multi-turn + queries, this is a repeated field that contains conversation history + + latest request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + safetySettings: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' + description: >- + Optional. Per request settings for blocking unsafe content. Enforced + on GenerateContentResponse.candidates. + toolConfig: + description: >- + Optional. Tool config. This config is shared for all tools provided + in the request. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' + tools: + type: array + description: >- + Optional. A list of `Tools` the model may use to generate the next + response. A `Tool` is a piece of code that enables the system to + interact with external systems to perform an action, or set of + actions, outside of knowledge and scope of the model. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' + systemInstruction: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: >- + Optional. The user provided system instructions for the model. Note: + only text should be used in parts and content in each part will be + in a separate paragraph. + labels: + type: object + 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. + additionalProperties: + type: string + description: Request message for [PredictionService.GenerateContent]. + id: GoogleCloudAiplatformV1GenerateContentRequest + GoogleCloudAiplatformV1ModelEvaluationSlice: properties: - artifactId: + metrics: + type: any + description: >- + Output only. Sliced evaluation metrics of the Model. The schema of + the metrics is stored in metrics_schema_uri + readOnly: true + createTime: + readOnly: true + type: string + description: Output only. Timestamp when this ModelEvaluationSlice was created. + format: google-datetime + metricsSchemaUri: + readOnly: true type: string description: >- - Artifact resource id from MLMD. Which is the last portion of an - artifact resource name: - `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. - The artifact must stay within the same project, location and default - metadatastore as the pipeline. - description: The type of an input artifact. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation: - properties: - columnName: + Output only. Points to a YAML file stored on Google Cloud Storage + describing the metrics of this ModelEvaluationSlice. The schema is + defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + name: + readOnly: true type: string + description: Output only. The resource name of the ModelEvaluationSlice. + modelExplanation: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' + description: >- + Output only. Aggregated explanation metrics for the Model's + prediction output over the data this ModelEvaluation uses. This + field is populated only if the Model is evaluated with explanations, + and only for tabular Models. + slice: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSlice + description: >- + Output only. The slice of the test data that is used to evaluate the + Model. + readOnly: true type: object description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Convert the category name to a dictionary lookup index and generate an - embedding for each index. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation - GoogleCloudAiplatformV1GenieSource: - description: >- - Contains information about the source of the models generated from - Generative AI Studio. + A collection of metrics calculated by comparing Model's predictions on a + slice of the test data against ground truth annotations. + id: GoogleCloudAiplatformV1ModelEvaluationSlice + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance: + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance properties: - baseModelUri: - description: Required. The public base model URI. + baselinePrediction: + description: Required. Output of the baseline model. type: string - id: GoogleCloudAiplatformV1GenieSource + instruction: + type: string + description: Required. Question Answering prompt for LLM. + context: + description: Required. Text to answer the question. + type: string + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + prediction: + type: string + description: Required. Output of the candidate model. type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics: + description: Spec for pairwise question answering quality instance. + GoogleCloudAiplatformV1StopTrialRequest: + description: Request message for VizierService.StopTrial. + id: GoogleCloudAiplatformV1StopTrialRequest type: object - description: Metrics for image segmentation evaluation results. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics + properties: {} + GoogleCloudAiplatformV1SearchMigratableResourcesResponse: + description: Response message for MigrationService.SearchMigratableResources. properties: - confidenceMetricsEntries: + migratableResources: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' description: >- - Metrics for each confidenceThreshold in - 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 Precision-recall curve - can be derived from it. + All migratable resources that can be migrated to the location + specified in the request. type: array - GoogleCloudAiplatformV1WorkerPoolSpec: - id: GoogleCloudAiplatformV1WorkerPoolSpec + nextPageToken: + description: >- + The standard next-page token. The migratable_resources may not fill + page_size in SearchMigratableResourcesRequest even when there are + subsequent pages. + type: string type: object - description: Represents the spec of a worker pool in a job. + id: GoogleCloudAiplatformV1SearchMigratableResourcesResponse + GoogleCloudAiplatformV1DiskSpec: properties: - replicaCount: - description: Optional. The number of worker replicas to use for this worker pool. - format: int64 + bootDiskType: + description: >- + Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" + (Persistent Disk Solid State Drive) or "pd-standard" (Persistent + Disk Hard Disk Drive). type: string - pythonPackageSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' - description: The Python packaged task. - nfsMounts: - type: array - description: Optional. List of NFS mount spec. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - description: Optional. Immutable. The specification of a single machine. - diskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - description: Disk spec. - containerSpec: - description: The custom container task. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' - GoogleCloudAiplatformV1FilterSplit: + bootDiskSizeGb: + type: integer + description: Size in GB of the boot disk (default is 100GB). + format: int32 + description: Represents the spec of disk options. + type: object + id: GoogleCloudAiplatformV1DiskSpec + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue: + description: Single value that supports strings and floats. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue type: object properties: - trainingFilter: + floatValue: + type: number + description: Float type. + format: float + stringValue: + description: String type. + type: string + GoogleCloudAiplatformV1FeatureViewIndexConfig: + id: GoogleCloudAiplatformV1FeatureViewIndexConfig + properties: + treeAhConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to train the Model. A filter with same syntax - as the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. + Optional. Configuration options for the tree-AH algorithm (Shallow + tree + Asymmetric Hashing). Please refer to this paper for more + details: https://arxiv.org/abs/1908.10396 + crowdingColumn: + description: >- + Optional. Column of crowding. This column contains crowding + attribute which is a constraint on a neighbor list produced by + FeatureOnlineStoreService.SearchNearestEntities to diversify search + results. If + NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to + K in SearchNearestEntitiesRequest, it's guaranteed that no more than + K entities of the same crowding attribute are returned in the + response. type: string - validationFilter: + bruteForceConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig + description: >- + Optional. Configuration options for using brute force search, which + simply implements the standard linear search in the database for + each query. It is primarily meant for benchmarking and to generate + the ground truth for approximate search. + distanceMeasureType: + type: string + enumDescriptions: + - Should not be set. + - Euclidean (L_2) Distance. + - >- + Cosine Distance. Defined as 1 - cosine similarity. We strongly + suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of + COSINE distance. Our algorithms have been more optimized for + DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is + mathematically equivalent to COSINE distance and results in the + same ranking. + - Dot Product Distance. Defined as a negative of the dot product. + enum: + - DISTANCE_MEASURE_TYPE_UNSPECIFIED + - SQUARED_L2_DISTANCE + - COSINE_DISTANCE + - DOT_PRODUCT_DISTANCE + description: Optional. The distance measure used in nearest neighbor search. + embeddingDimension: + format: int32 + type: integer + description: Optional. The number of dimensions of the input embedding. + embeddingColumn: type: string description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to validate the Model. A filter with same - syntax as the one used in DatasetService.ListDataItems may be used. - If a single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - testFilter: + Optional. Column of embedding. This column contains the source data + to create index for vector search. embedding_column must be set when + using vector search. + filterColumns: + items: + type: string + type: array description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to test the Model. A filter with same syntax as - the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. + Optional. Columns of features that're used to filter vector search + results. + description: Configuration for vector indexing. + type: object + GoogleCloudAiplatformV1PipelineJobDetail: + id: GoogleCloudAiplatformV1PipelineJobDetail + properties: + pipelineRunContext: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + readOnly: true + description: Output only. The context of the current pipeline run. + taskDetails: + readOnly: true + description: Output only. The runtime details of the tasks under the pipeline. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetail' + pipelineContext: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + description: Output only. The context of the pipeline. + readOnly: true + type: object + description: The runtime detail of PipelineJob. + GoogleCloudAiplatformV1FindNeighborsRequest: + id: GoogleCloudAiplatformV1FindNeighborsRequest + type: object + description: The request message for MatchService.FindNeighbors. + properties: + queries: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQuery + description: The list of queries. + type: array + deployedIndexId: + description: >- + The ID of the DeployedIndex that will serve the request. This + request is sent to a specific IndexEndpoint, as per the + IndexEndpoint.network. That IndexEndpoint also has + IndexEndpoint.deployed_indexes, and each such index has a + DeployedIndex.id field. The value of the field below must equal one + of the DeployedIndex.id fields of the IndexEndpoint that is being + called for this request. type: string - description: >- - Assigns input data to training, validation, and test sets based on the - given filters, data pieces not matched by any filter are ignored. - Currently only supported for Datasets containing DataItems. If any of - the filters in this message are to match nothing, then they can be set - as '-' (the minus sign). Supported only for unstructured Datasets. - id: GoogleCloudAiplatformV1FilterSplit - GoogleCloudAiplatformV1UpsertDatapointsResponse: - id: GoogleCloudAiplatformV1UpsertDatapointsResponse - description: Response message for IndexService.UpsertDatapoints + returnFullDatapoint: + description: >- + If set to true, the full datapoints (including all vector values and + restricts) of the nearest neighbors are returned. Note that + returning full datapoint will significantly increase the latency and + cost of the query. + type: boolean + GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource: + id: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource + properties: + content: + description: The base64-encoded contents of the input notebook file. + type: string + format: byte + description: The content of the input notebook in ipynb format. type: object - properties: {} - GoogleCloudAiplatformV1EnvVar: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig type: object description: >- - Represents an environment variable present in a Container or Python - Module. + Config that contains the strategy used to generate sliding windows in + time series training. A window is a series of rows that comprise the + context up to the time of prediction, and the horizon following. The + corresponding row for each window marks the start of the forecast + horizon. Each window is used as an input example for + training/evaluation. properties: - value: + maxCount: type: string description: >- - Required. Variables that reference a $(VAR_NAME) are expanded using - the previous defined environment variables in the container and any - service environment variables. If a variable cannot be resolved, the - reference in the input string will be unchanged. The $(VAR_NAME) - syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped - references will never be expanded, regardless of whether the - variable exists or not. - name: - description: >- - Required. Name of the environment variable. Must be a valid C - identifier. + Maximum number of windows that should be generated across all time + series. + format: int64 + strideLength: + format: int64 type: string - id: GoogleCloudAiplatformV1EnvVar - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation: - properties: - invalidValuesAllowed: - type: boolean description: >- - If invalid values is allowed, the training pipeline will create a - boolean feature that indicated whether the value is valid. - Otherwise, the training pipeline will discard the input row from - trainining data. - columnName: + Stride length used to generate input examples. Within one time + series, every {$STRIDE_LENGTH} rows will be used to generate a + sliding window. + column: + description: >- + Name of the column that should be used to generate sliding windows. + The column should contain either booleans or string booleans; if the + value of the row is True, generate a sliding window with the horizon + starting at that row. The column will not be used as a feature in + training. type: string - description: >- - Treats the column as numerical array and performs following - transformation functions. * All transformations for Numerical types - applied to the average of the all elements. * The average of empty - arrays is treated as zero. + GoogleCloudAiplatformV1CancelCustomJobRequest: + description: Request message for JobService.CancelCustomJob. + id: GoogleCloudAiplatformV1CancelCustomJobRequest + properties: {} type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation GoogleCloudAiplatformV1FulfillmentInput: + description: Input for fulfillment metric. + id: GoogleCloudAiplatformV1FulfillmentInput properties: - instance: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInstance' - description: Required. Fulfillment instance. metricSpec: $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentSpec' description: Required. Spec for fulfillment score metric. + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInstance' + description: Required. Fulfillment instance. type: object - id: GoogleCloudAiplatformV1FulfillmentInput - description: Input for fulfillment metric. - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition: + GoogleCloudAiplatformV1ListPipelineJobsResponse: + description: Response message for PipelineService.ListPipelineJobs properties: - values: + pipelineJobs: type: array - description: >- - Required. Matches values of the parent parameter of 'CATEGORICAL' - type. All values must exist in `categorical_value_spec` of parent - parameter. + description: List of PipelineJobs in the requested page. items: - type: string - type: object - description: Represents the spec to match categorical values from parent parameter. - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListPipelineJobsRequest.page_token to obtain that page. + id: GoogleCloudAiplatformV1ListPipelineJobsResponse type: object + GoogleCloudAiplatformV1MeasurementMetric: properties: - confidenceThreshold: - format: float - type: number - description: The confidence threshold value used to compute the metrics. - trackingRecall: - format: float - description: Tracking recall. - type: number - trackingPrecision: - format: float - type: number - description: Tracking precision. - mismatchRate: + value: type: number + description: Output only. The value for this metric. + readOnly: true + format: double + metricId: + type: string description: >- - Mismatch rate, which measures the tracking consistency, i.e. - correctness of instance ID continuity. - format: float - boundingBoxIou: - description: >- - Bounding box intersection-over-union precision. Measures how well - the bounding boxes overlap between each other (e.g. complete overlap - or just barely above iou_threshold). - type: number - format: float - description: Metrics for a single confidence threshold. - GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec: + Output only. The ID of the Metric. The Metric should be defined in + StudySpec's Metrics. + readOnly: true type: object - id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec + id: GoogleCloudAiplatformV1MeasurementMetric + description: A message representing a metric in the measurement. + GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest: + type: object + id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest properties: - version: + filter: + type: string + description: >- + Exports the TensorboardTimeSeries' data that match the filter + expression. + pageSize: type: integer + description: >- + The maximum number of data points to return per page. The default + page_size is 1000. Values must be between 1 and 10000. Values above + 10000 are coerced to 10000. format: int32 - description: Optional. Which version to use for evaluation. - useReference: - type: boolean + pageToken: + type: string description: >- - Optional. Whether to use instance.reference to compute question - answering helpfulness. - description: Spec for question answering helpfulness metric. - GoogleCloudAiplatformV1ListFeatureViewsResponse: + A page token, received from a previous + ExportTensorboardTimeSeriesData call. Provide this to retrieve the + subsequent page. When paginating, all other parameters provided to + ExportTensorboardTimeSeriesData must match the call that provided + the page token. + orderBy: + description: >- + Field to use to sort the TensorboardTimeSeries' data. By default, + TensorboardTimeSeries' data is returned in a pseudo random order. + type: string + description: Request message for TensorboardService.ExportTensorboardTimeSeriesData. + GoogleCloudAiplatformV1StudySpec: + description: Represents specification of a Study. type: object + id: GoogleCloudAiplatformV1StudySpec properties: - nextPageToken: - type: string + parameters: + description: Required. The set of parameters to tune. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + decayCurveStoppingSpec: + description: The automated early stopping spec using decay curve rule. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec + observationNoise: + enum: + - OBSERVATION_NOISE_UNSPECIFIED + - LOW + - HIGH description: >- - A token, which can be sent as ListFeatureViewsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - featureViews: - description: The FeatureViews matching the request. + The observation noise level of the study. Currently only supported + by the Vertex AI Vizier service. Not supported by + HyperparameterTuningJob or TrainingPipeline. + type: string + enumDescriptions: + - The default noise level chosen by Vertex AI. + - >- + Vertex AI assumes that the objective function is (nearly) + perfectly reproducible, and will never repeat the same Trial + parameters. + - >- + Vertex AI will estimate the amount of noise in metric evaluations, + it may repeat the same Trial parameters more than once. + measurementSelectionType: + type: string + description: Describe which measurement selection type will be used + enumDescriptions: + - Will be treated as LAST_MEASUREMENT. + - Use the last measurement reported. + - Use the best measurement reported. + enum: + - MEASUREMENT_SELECTION_TYPE_UNSPECIFIED + - LAST_MEASUREMENT + - BEST_MEASUREMENT + medianAutomatedStoppingSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec + description: The automated early stopping spec using median rule. + convexAutomatedStoppingSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec + description: The automated early stopping spec using convex stopping rule. + metrics: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' - id: GoogleCloudAiplatformV1ListFeatureViewsResponse - description: Response message for FeatureOnlineStoreAdminService.ListFeatureViews. - GoogleCloudAiplatformV1SampledShapleyAttribution: - properties: - pathCount: - format: int32 + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpec' + description: Required. Metric specs for the Study. + studyStoppingConfig: description: >- - Required. The number of feature permutations to consider when - approximating the Shapley values. Valid range of its value is [1, - 50], inclusively. - type: integer - id: GoogleCloudAiplatformV1SampledShapleyAttribution + Conditions for automated stopping of a Study. Enable automated + stopping by configuring at least one condition. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecStudyStoppingConfig + algorithm: + type: string + enumDescriptions: + - >- + The default algorithm used by Vertex AI for [hyperparameter + tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview) + and [Vertex AI + Vizier](https://cloud.google.com/vertex-ai/docs/vizier). + - >- + Simple grid search within the feasible space. To use grid search, + all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`. + - Simple random search within the feasible space. + enum: + - ALGORITHM_UNSPECIFIED + - GRID_SEARCH + - RANDOM_SEARCH + description: The search algorithm specified for the Study. + CloudAiLargeModelsVisionImageRAIScores: type: object - description: >- - An attribution method that approximates Shapley values for features that - contribute to the label being predicted. A sampling strategy is used to - approximate the value rather than considering all subsets of features. - GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult - description: Prediction output format for Tabular Classification. + description: RAI scores for generated image returned. + id: CloudAiLargeModelsVisionImageRAIScores + properties: + agileWatermarkDetectionScore: + format: double + type: number + description: Agile watermark score for image. + GoogleCloudAiplatformV1VideoMetadata: + description: Metadata describes the input video content. + id: GoogleCloudAiplatformV1VideoMetadata type: object properties: - scores: + endOffset: + format: google-duration + type: string + description: Optional. The end offset of the video. + startOffset: + type: string + description: Optional. The start offset of the video. + format: google-duration + GoogleCloudAiplatformV1ToolNameMatchResults: + description: Results for tool name match metric. + properties: + toolNameMatchMetricValues: + type: array items: - format: float - type: number - description: >- - The model's confidence in each class being correct, higher value - means higher confidence. The N-th score corresponds to the N-th - class in classes. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolNameMatchMetricValue + description: Output only. Tool name match metric values. + readOnly: true + id: GoogleCloudAiplatformV1ToolNameMatchResults + type: object + GoogleCloudAiplatformV1BatchCreateFeaturesRequest: + description: Request message for FeaturestoreService.BatchCreateFeatures. + type: object + id: GoogleCloudAiplatformV1BatchCreateFeaturesRequest + properties: + requests: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CreateFeatureRequest' type: array - classes: + description: >- + Required. The request message specifying the Features to create. All + Features must be created under the same parent EntityType. The + `parent` field in each child request message can be omitted. If + `parent` is set in a child request, then the value must match the + `parent` value in this request message. + GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest: + description: Request message for PipelineService.BatchDeletePipelineJobs. + properties: + names: items: type: string description: >- - The name of the classes being classified, contains all possible - values of the target column. + Required. The names of the PipelineJobs to delete. A maximum of 32 + PipelineJobs can be deleted in a batch. Format: + `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` type: array - GoogleCloudAiplatformV1CancelTuningJobRequest: + id: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest type: object - description: Request message for GenAiTuningService.CancelTuningJob. - id: GoogleCloudAiplatformV1CancelTuningJobRequest - properties: {} - GoogleCloudAiplatformV1DirectRawPredictRequest: - description: Request message for PredictionService.DirectRawPredict. - id: GoogleCloudAiplatformV1DirectRawPredictRequest + GoogleCloudAiplatformV1SampleConfig: + id: GoogleCloudAiplatformV1SampleConfig + description: >- + Active learning data sampling config. For every active learning labeling + iteration, it will select a batch of data based on the sampling + strategy. properties: - methodName: - type: string + sampleStrategy: + enumDescriptions: + - Default will be treated as UNCERTAINTY. + - Sample the most uncertain data to label. description: >- - Fully qualified name of the API method being invoked to perform - predictions. Format: `/namespace.Service/Method/` Example: - `/tensorflow.serving.PredictionService/Predict` - input: - format: byte - type: string - description: The prediction input. - type: object - CloudAiLargeModelsVisionImage: - id: CloudAiLargeModelsVisionImage - properties: - uri: - type: string - description: Path to another storage (typically Google Cloud Storage). - text: - type: string - description: Text/Expanded text input for imagen. - semanticFilterResponse: - description: Semantic filter info for image. - $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' - image: - type: string - format: byte - description: Raw bytes. - encoding: + Field to choose sampling strategy. Sampling strategy will decide + which data should be selected for human labeling in every batch. type: string - description: Image encoding, encoded as "image/png" or "image/jpg". - imageRaiScores: - $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' - description: RAI scores for generated image. - generationSeed: + enum: + - SAMPLE_STRATEGY_UNSPECIFIED + - UNCERTAINTY + followingBatchSamplePercentage: + description: >- + The percentage of data needed to be labeled in each following batch + (except the first batch). + format: int32 type: integer + initialBatchSamplePercentage: + description: The percentage of data needed to be labeled in the first batch. format: int32 - description: >- - Generation seed for the sampled image. This parameter is exposed to - the user only if one of the following is true: 1. The user specified - per-example seeds in the request. 2. The user doesn't specify the - generation seed in the request. - raiInfo: - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' - description: RAI info for image. + type: integer type: object - description: Image. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs: + GoogleCloudAiplatformV1CreateIndexOperationMetadata: + id: GoogleCloudAiplatformV1CreateIndexOperationMetadata properties: - disableEarlyStopping: - type: boolean - description: >- - Use the entire training budget. This disables the early stopping - feature. When false the early stopping feature is enabled, which - means that AutoML Image Object Detection might stop training before - the entire training budget has been used. - budgetMilliNodeHours: - description: >- - The training budget of creating this model, expressed in milli node - hours i.e. 1,000 value in this field means 1 node hour. The actual - metadata.costMilliNodeHours will be equal or less than this value. - If further model training ceases to provide any improvements, it - will stop without using the full budget and the - metadata.successfulStopReason will be `model-converged`. Note, - node_hour = actual_hour * number_of_nodes_involved. For modelType - `cloud`(default), the budget must be between 20,000 and 900,000 - milli node hours, inclusive. The default value is 216,000 which - represents one day in wall time, considering 9 nodes are used. For - model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, - `mobile-tf-high-accuracy-1` the training budget must be between - 1,000 and 100,000 milli node hours, inclusive. The default value is - 24,000 which represents one day in wall time on a single node that - is used. - format: int64 - type: string - tunableParameter: - description: Trainer type for Vision TrainRequest. + nearestNeighborSearchOperationMetadata: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - uptrainBaseModelId: - type: string + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata description: >- - The ID of `base` model for upTraining. If it is specified, the new - model will be upTrained based on the `base` model for upTraining. - Otherwise, the new model will be trained from scratch. The `base` - model for upTraining must be in the same Project and Location as the - new Model to train, and have the same modelType. - modelType: - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD_HIGH_ACCURACY_1 - - CLOUD_LOW_LATENCY_1 - - CLOUD_1 - - MOBILE_TF_LOW_LATENCY_1 - - MOBILE_TF_VERSATILE_1 - - MOBILE_TF_HIGH_ACCURACY_1 - - CLOUD_STREAMING_1 - - SPINENET - - YOLO - type: string - enumDescriptions: - - Should not be set. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to have a higher latency, but should - also have a higher prediction quality than other cloud models. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to have a low latency, but may have - lower prediction quality than other cloud models. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Compared to the CLOUD_HIGH_ACCURACY_1 and - CLOUD_LOW_LATENCY_1 models above, it is expected to have higher - prediction quality and lower latency. - - >- - A model that, in addition to being available within Google Cloud - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. Expected to have - low latency, but may have lower prediction quality than other - mobile models. - - >- - A model that, in addition to being available within Google Cloud - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. Expected to have - a higher latency, but should also have a higher prediction quality - than other mobile models. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to best support predictions in - streaming with lower latency and lower prediction quality than - other cloud models. - - >- - SpineNet for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - YOLO for Model Garden training with customizable hyperparameters. - Best tailored to be used within Google Cloud, and cannot be - exported externally. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs + The operation metadata with regard to Matching Engine Index + operation. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Runtime operation information for IndexService.CreateIndex. type: object - GoogleCloudAiplatformV1DeployedModel: - description: A deployment of a Model. Endpoints contain one or more DeployedModels. - id: GoogleCloudAiplatformV1DeployedModel + GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata: + id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata + type: object + properties: {} + GoogleCloudAiplatformV1Artifact: type: object + id: GoogleCloudAiplatformV1Artifact + description: Instance of a general artifact. properties: - serviceAccount: - description: >- - The service account that the DeployedModel's container runs as. - Specify the email address of the service account. If this service - account is not specified, the container runs as a service account - that doesn't have access to the resource project. Users deploying - the Model must have the `iam.serviceAccounts.actAs` permission on - this service account. - type: string - model: - description: >- - Required. The resource name of the Model that this is the deployment - of. Note that the Model may be in a different location than the - DeployedModel's Endpoint. The resource name may contain version id - or version alias to specify the version. Example: - `projects/{project}/locations/{location}/models/{model}@2` or - `projects/{project}/locations/{location}/models/{model}@golden` if - no version is specified, the default version will be deployed. - type: string createTime: type: string + description: Output only. Timestamp when this Artifact was created. readOnly: true format: google-datetime - description: Output only. Timestamp when the DeployedModel was created. - privateEndpoints: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' + uri: + type: string description: >- - Output only. Provide paths for users to send predict/explain/health - requests directly to the deployed model services running on Cloud - via private services access. This field is populated if network is - configured. - dedicatedResources: + The uniform resource identifier of the artifact file. May be empty + if there is no actual artifact file. + labels: + additionalProperties: + type: string description: >- - A description of resources that are dedicated to the DeployedModel, - and that need a higher degree of manual configuration. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' - modelVersionId: - description: Output only. The version ID of the model that is deployed. + The labels with user-defined metadata to organize your Artifacts. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Artifact (System + labels are excluded). + type: object + metadata: + type: object + description: >- + Properties of the Artifact. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + additionalProperties: + description: Properties of the object. + type: any + schemaVersion: + description: >- + The version of the schema in schema_name to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. type: string - readOnly: true - id: + schemaTitle: type: string description: >- - Immutable. The ID of the DeployedModel. If not provided upon - deployment, Vertex AI will generate a value for this ID. This value - should be 1-10 characters, and valid characters are `/[0-9]/`. - disableExplanations: - type: boolean - description: >- - If true, deploy the model without explainable feature, regardless - the existence of Model.explanation_spec or explanation_spec. - disableContainerLogging: - description: >- - For custom-trained Models and AutoML Tabular Models, the container - of the DeployedModel instances will send `stderr` and `stdout` - streams to Cloud Logging by default. Please note that the logs incur - cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging/pricing). User can disable - container logging by setting this flag to true. - type: boolean - displayName: - type: string - description: >- - The display name of the DeployedModel. If not provided upon - creation, the Model's display_name is used. - automaticResources: - description: >- - A description of resources that to large degree are decided by - Vertex AI, and require only a modest additional configuration. - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - sharedResources: - type: string - description: >- - The resource name of the shared DeploymentResourcePool to deploy on. - Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - enableAccessLogging: - description: >- - If true, online prediction access logs are sent to Cloud Logging. - These logs are like standard server access logs, containing - information like timestamp and latency for each prediction request. - Note that logs may incur a cost, especially if your project receives - prediction requests at a high queries per second rate (QPS). - Estimate your costs before enabling this option. - type: boolean - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' - description: >- - Explanation configuration for this DeployedModel. When deploying a - Model using EndpointService.DeployModel, this value overrides the - value of Model.explanation_spec. All fields of explanation_spec are - optional in the request. If a field of explanation_spec is not - populated, the value of the same field of Model.explanation_spec is - inherited. If the corresponding Model.explanation_spec is not - populated, all fields of the explanation_spec will be used for the - explanation configuration. - GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec: - type: object - id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec - properties: - useReference: - description: >- - Optional. Whether to use instance.reference to compute question - answering correctness. - type: boolean - version: - description: Optional. Which version to use for evaluation. - type: integer - format: int32 - description: Spec for question answering correctness metric. - GoogleCloudAiplatformV1Schedule: - description: >- - An instance of a Schedule periodically schedules runs to make API calls - based on user specified time specification and API request type. - properties: + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. displayName: - type: string - description: >- - Required. User provided name of the Schedule. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - nextRunTime: - description: >- - Output only. Timestamp when this Schedule should schedule the next - run. Having a next_run_time in the past means the runs are being - started behind schedule. - type: string - format: google-datetime - readOnly: true - createNotebookExecutionJobRequest: - description: Request for NotebookService.CreateNotebookExecutionJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest - maxConcurrentRunCount: - format: int64 - type: string description: >- - Required. Maximum number of runs that can be started concurrently - for this Schedule. This is the limit for starting the scheduled - requests and not the execution of the operations/jobs created by the - requests (if applicable). - createTime: - readOnly: true - format: google-datetime - description: Output only. Timestamp when this Schedule was created. + User provided display name of the Artifact. May be up to 128 Unicode + characters. type: string state: - description: Output only. The state of this Schedule. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - PAUSED - - COMPLETED + description: >- + The state of this Artifact. This is a property of the Artifact, and + does not imply or capture any ongoing process. This property is + managed by clients (such as Vertex AI Pipelines), and the system + does not prescribe or check the validity of state transitions. enumDescriptions: - - Unspecified. - - >- - The Schedule is active. Runs are being scheduled on the - user-specified timespec. + - Unspecified state for the Artifact. - >- - The schedule is paused. No new runs will be created until the - schedule is resumed. Already started runs will be allowed to - complete. + A state used by systems like Vertex AI Pipelines to indicate that + the underlying data item represented by this Artifact is being + created. - >- - The Schedule is completed. No new runs will be scheduled. Already - started runs will be allowed to complete. Schedules in completed - state cannot be paused or resumed. + A state indicating that the Artifact should exist, unless + something external to the system deletes it. + type: string + enum: + - STATE_UNSPECIFIED + - PENDING + - LIVE + name: + description: Output only. The resource name of the Artifact. readOnly: true type: string updateTime: type: string - format: google-datetime readOnly: true - description: Output only. Timestamp when this Schedule was updated. - endTime: format: google-datetime - type: string + description: Output only. Timestamp when this Artifact was last updated. + etag: description: >- - Optional. Timestamp after which no new runs can be scheduled. If - specified, The schedule will be completed when either end_time is - reached or when scheduled_run_count >= max_run_count. If not - specified, new runs will keep getting scheduled until this Schedule - is paused or deleted. Already scheduled runs will be allowed to - complete. Unset if not specified. - maxRunCount: + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + type: string + description: + type: string + description: Description of the Artifact + CloudAiLargeModelsVisionMedia: + properties: + video: + description: Video + $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' + image: + description: Image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' + type: object + description: Media. + id: CloudAiLargeModelsVisionMedia + GoogleCloudAiplatformV1ServiceAccountSpec: + description: >- + Configuration for the use of custom service account to run the + workloads. + type: object + properties: + serviceAccount: description: >- - Optional. Maximum run count of the schedule. If specified, The - schedule will be completed when either started_run_count >= - max_run_count or when end_time is reached. If not specified, new - runs will keep getting scheduled until this Schedule is paused or - deleted. Already scheduled runs will be allowed to complete. Unset - if not specified. - format: int64 + Optional. Required when all below conditions are met * + `enable_custom_service_account` is true; * any runtime is specified + via `ResourceRuntimeSpec` on creation time, for example, Ray The + users must have `iam.serviceAccounts.actAs` permission on this + service account and then the specified runtime containers will run + as it. Do not set this field if you want to submit jobs using custom + service account to this PersistentResource after creation, but only + specify the `service_account` inside the job. type: string - allowQueueing: + enableCustomServiceAccount: description: >- - Optional. Whether new scheduled runs can be queued when - max_concurrent_runs limit is reached. If set to true, new runs will - be queued instead of skipped. Default to false. + Required. If true, custom user-managed service account is enforced + to run any workloads (for example, Vertex Jobs) on the resource. + Otherwise, uses the [Vertex AI Custom Code Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). type: boolean - catchUp: + id: GoogleCloudAiplatformV1ServiceAccountSpec + GoogleCloudAiplatformV1SchemaTextDatasetMetadata: + id: GoogleCloudAiplatformV1SchemaTextDatasetMetadata + description: The metadata of Datasets that contain Text DataItems. + type: object + properties: + dataItemSchemaUri: description: >- - Output only. Whether to backfill missed runs when the schedule is - resumed from PAUSED state. If set to true, all missed runs will be - scheduled. New runs will be scheduled after the backfill is - complete. Default to false. - type: boolean - readOnly: true - startTime: - format: google-datetime + Points to a YAML file stored on Google Cloud Storage describing + payload of the Text DataItems that belong to this Dataset. type: string - description: >- - Optional. Timestamp after which the first run can be scheduled. - Default to Schedule create time if not specified. - lastScheduledRunResponse: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ScheduleRunResponse' - description: >- - Output only. Response of the last scheduled run. This is the - response for starting the scheduled requests and not the execution - of the operations/jobs created by the requests (if applicable). - Unset if no run has been scheduled yet. - cron: + gcsBucket: type: string description: >- - Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch - scheduled runs. To explicitly set a timezone to the cron tab, apply - a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database. For example, - "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * - * *". - createPipelineJobRequest: + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. + GoogleCloudAiplatformV1SuggestTrialsMetadata: + type: object + id: GoogleCloudAiplatformV1SuggestTrialsMetadata + properties: + clientId: description: >- - Request for PipelineService.CreatePipelineJob. - CreatePipelineJobRequest.parent field is required (format: - projects/{project}/locations/{location}). - $ref: '#/components/schemas/GoogleCloudAiplatformV1CreatePipelineJobRequest' - startedRunCount: - description: Output only. The number of runs started by this schedule. - readOnly: true - format: int64 - type: string - name: - description: Immutable. The resource name of the Schedule. + The identifier of the client that is requesting the suggestion. If + multiple SuggestTrialsRequests have the same `client_id`, the + service will return the identical suggested Trial if the Trial is + pending, and provide a new Trial if the last suggested Trial was + completed. type: string - lastResumeTime: - description: >- - Output only. Timestamp when this Schedule was last resumed. Unset if - never resumed from pause. - readOnly: true - format: google-datetime + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for suggesting Trials. + description: Details of operations that perform Trials suggestion. + GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: + id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata + properties: + progressMessage: type: string - lastPauseTime: - readOnly: true description: >- - Output only. Timestamp when this Schedule was last paused. Unset if - never paused. - type: string - format: google-datetime + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Metadata information for NotebookService.AssignNotebookRuntime. type: object - id: GoogleCloudAiplatformV1Schedule - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics: + GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig: + description: Requests are randomly selected. + properties: + sampleRate: + format: double + type: number + description: Sample rate (0, 1] + type: object + id: GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs: type: object id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs properties: - maxPredictions: + sentimentMax: type: integer - format: int32 - description: >- - Metrics are computed with an assumption that the Model always - returns at most this many predictions (ordered by their score, - descendingly), but they all still need to meet the - `confidenceThreshold`. - f1ScoreAt1: - description: The harmonic mean of recallAt1 and precisionAt1. - type: number - format: float - falseNegativeCount: - format: int64 - type: string - description: >- - The number of ground truth labels that are not matched by a Model - created label. - trueNegativeCount: - type: string - format: int64 - description: >- - The number of labels that were not created by the Model, but if they - would, they would not match a ground truth label. - precision: - format: float - type: number - description: Precision for the given confidence threshold. - confidenceThreshold: - description: >- - Metrics are computed with an assumption that the Model never returns - predictions with score lower than this value. - type: number - format: float - truePositiveCount: - type: string - format: int64 - description: The number of Model created labels that match a ground truth label. - f1ScoreMicro: - type: number - format: float - description: Micro-averaged F1 Score. - f1Score: - type: number - description: >- - The harmonic mean of recall and precision. For summary metrics, it - computes the micro-averaged F1 score. - format: float - recallAt1: - description: >- - The Recall (True Positive Rate) when only considering the label that - has the highest prediction score and not below the confidence - threshold for each DataItem. - format: float - type: number - recall: - type: number - description: Recall (True Positive Rate) for the given confidence threshold. - format: float - confusionMatrix: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: Confusion matrix of the evaluation for this confidence_threshold. - f1ScoreMacro: - format: float - type: number - description: Macro-averaged F1 Score. - precisionAt1: - description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - DataItem. - type: number - format: float - falsePositiveCount: - format: int64 - description: >- - The number of Model created labels that do not match a ground truth - label. - type: string - falsePositiveRate: - format: float - type: number - description: False Positive Rate for the given confidence threshold. - falsePositiveRateAt1: - type: number description: >- - The False Positive Rate when only considering the label that has the - highest prediction score and not below the confidence threshold for - each DataItem. - format: float - GoogleCloudAiplatformV1DeployIndexResponse: + A sentiment is expressed as an integer ordinal, where higher value + means a more positive sentiment. The range of sentiments that will + be used is between 0 and sentimentMax (inclusive on both ends), and + all the values in the range must be represented in the dataset + before a model can be created. Only the Annotations with this + sentimentMax will be used for training. sentimentMax value must be + between 1 and 10 (inclusive). + format: int32 + GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata: + id: GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata type: object - description: Response message for IndexEndpointService.DeployIndex. - properties: - deployedIndex: - description: The DeployedIndex that had been deployed in the IndexEndpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - id: GoogleCloudAiplatformV1DeployIndexResponse - GoogleCloudAiplatformV1CoherenceInstance: - description: Spec for coherence instance. + description: Runtime operation information for EndpointService.MutateDeployedModel. properties: - prediction: - description: Required. Output of the evaluated model. - type: string - type: object - id: GoogleCloudAiplatformV1CoherenceInstance - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata: - type: object + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1SchemaImageDataItem: properties: - bestTrialBackingCustomJob: + gcsUri: type: string description: >- - The resource name of the CustomJob that has been created to run the - best Trial of this HyperparameterTuning task. - backingHyperparameterTuningJob: + Required. Google Cloud Storage URI points to the original image in + user's bucket. The image is up to 30MB in size. + mimeType: description: >- - The resource name of the HyperparameterTuningJob that has been - created to carry out this HyperparameterTuning task. + Output only. The mime type of the content of the image. Only the + images in below listed mime types are supported. - image/jpeg - + image/gif - image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + readOnly: true type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata - GoogleCloudAiplatformV1ListNotebookRuntimesResponse: + id: GoogleCloudAiplatformV1SchemaImageDataItem type: object - id: GoogleCloudAiplatformV1ListNotebookRuntimesResponse - description: Response message for NotebookService.ListNotebookRuntimes. + description: Payload of Image DataItem. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec: + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec properties: - nextPageToken: + trialJobSpec: description: >- - A token to retrieve next page of results. Pass to - ListNotebookRuntimesRequest.page_token to obtain that page. - type: string - notebookRuntimes: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' - type: array - description: List of NotebookRuntimes in the requested page. - GoogleCloudAiplatformV1RemoveContextChildrenRequest: + The spec of a trial job. The same spec applies to the CustomJobs + created in all the trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + maxTrialCount: + type: integer + format: int32 + description: The desired total number of Trials. + parallelTrialCount: + description: The desired number of Trials to run in parallel. + type: integer + format: int32 + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + description: Study configuration of the HyperparameterTuningJob. + maxFailedTrialCount: + description: >- + The number of failed Trials that need to be seen before failing the + HyperparameterTuningJob. If set to 0, Vertex AI decides how many + Trials must fail before the whole job fails. + type: integer + format: int32 + GoogleCloudAiplatformV1ExportDataResponse: + description: Response message for DatasetService.ExportData. properties: - childContexts: + dataStats: + description: >- + Only present for custom code training export use case. Records data + stats, i.e., train/validation/test item/annotation counts calculated + during the export operation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' + exportedFiles: + description: >- + All of the files that are exported in this export operation. For + custom code training export, only three (training, validation and + test) Cloud Storage paths in wildcard format are populated (for + example, gs://.../training-*). type: array items: type: string - description: The resource names of the child Contexts. - description: Request message for MetadataService.DeleteContextChildrenRequest. - id: GoogleCloudAiplatformV1RemoveContextChildrenRequest type: object - GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult: - description: Spec for question answering helpfulness result. + id: GoogleCloudAiplatformV1ExportDataResponse + GoogleCloudAiplatformV1ReadIndexDatapointsResponse: type: object - id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult properties: - explanation: - readOnly: true - description: Output only. Explanation for question answering helpfulness score. - type: string - score: - description: Output only. Question Answering Helpfulness score. - readOnly: true - type: number - format: float - confidence: - format: float - type: number - description: Output only. Confidence for question answering helpfulness score. - readOnly: true - GoogleCloudAiplatformV1DatasetVersion: + datapoints: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + description: The result list of datapoints. + type: array + id: GoogleCloudAiplatformV1ReadIndexDatapointsResponse + description: The response message for MatchService.ReadIndexDatapoints. + GoogleCloudAiplatformV1CancelTuningJobRequest: + type: object + properties: {} + id: GoogleCloudAiplatformV1CancelTuningJobRequest + description: Request message for GenAiTuningService.CancelTuningJob. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + type: object properties: - modelReference: - readOnly: true + groupTemporalTotalWeight: + type: number + format: double description: >- - Output only. Reference to the public base model last used by the - dataset version. Only set for prompt dataset versions. + The weight of the loss for predictions aggregated over both the + horizon and time series in the same hierarchy group. + temporalTotalWeight: + description: >- + The weight of the loss for predictions aggregated over the horizon + for a single time series. + type: number + format: double + groupColumns: + items: + type: string + description: >- + A list of time series attribute column names that define the time + series hierarchy. Only one level of hierarchy is supported, ex. + 'region' for a hierarchy of stores or 'department' for a hierarchy + of products. If multiple columns are specified, time series will be + grouped by their combined values, ex. ('blue', 'large') for 'color' + and 'size', up to 5 columns are accepted. If no group columns are + specified, all time series are considered to be part of the same + group. + type: array + groupTotalWeight: + description: >- + The weight of the loss for predictions aggregated over time series + in the same group. + type: number + format: double + description: >- + Configuration that defines the hierarchical relationship of time series + and parameters for hierarchical forecasting strategies. + GoogleCloudAiplatformV1ThresholdConfig: + properties: + value: + description: >- + Specify a threshold value that can trigger the alert. If this + threshold config is for feature distribution distance: 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. Each feature + must have a non-zero threshold if they need to be monitored. + Otherwise no alert will be triggered for that feature. + type: number + format: double + id: GoogleCloudAiplatformV1ThresholdConfig + type: object + description: The config for feature monitoring threshold. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation: + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation + type: object + properties: + timeFormat: type: string - displayName: + description: >- + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + columnName: + type: string + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance: + properties: + reference: + description: Optional. Ground truth used to compare against the prediction. type: string + prediction: + description: Required. Output of the evaluated model. + type: string + context: + description: Optional. Text provided as context to answer the question. + type: string + instruction: description: >- - The user-defined name of the DatasetVersion. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - updateTime: - description: Output only. Timestamp when this DatasetVersion was last updated. - readOnly: true - format: google-datetime + Required. The question asked and other instruction in the inference + prompt. type: string - createTime: + type: object + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance + description: Spec for question answering correctness instance. + GoogleCloudAiplatformV1EvaluatedAnnotation: + properties: + evaluatedDataItemViewId: type: string - format: google-datetime + description: >- + Output only. ID of the EvaluatedDataItemView under the same ancestor + ModelEvaluation. The EvaluatedDataItemView consists of all ground + truths and predictions on data_item_payload. + readOnly: true + type: readOnly: true - description: Output only. Timestamp when this DatasetVersion was created. - bigQueryDatasetName: type: string + enum: + - EVALUATED_ANNOTATION_TYPE_UNSPECIFIED + - TRUE_POSITIVE + - FALSE_POSITIVE + - FALSE_NEGATIVE + description: Output only. Type of the EvaluatedAnnotation. + enumDescriptions: + - Invalid value. + - >- + The EvaluatedAnnotation is a true positive. It has a prediction + created by the Model and a ground truth Annotation which the + prediction matches. + - >- + The EvaluatedAnnotation is false positive. It has a prediction + created by the Model which does not match any ground truth + annotation. + - >- + The EvaluatedAnnotation is false negative. It has a ground truth + annotation which is not matched by any of the model created + predictions. + predictions: + items: + type: any + type: array + description: >- + Output only. The model predicted annotations. For true positive, + there is one and only one prediction, which matches the only one + ground truth annotation in ground_truths. For false positive, there + is one and only one prediction, which doesn't match any ground truth + annotation of the corresponding data_item_view_id. For false + negative, there are zero or more predictions which are similar to + the only ground truth annotation in ground_truths but not enough for + a match. The schema of the prediction is stored in + ModelEvaluation.annotation_schema_uri readOnly: true - description: Output only. Name of the associated BigQuery dataset. - metadata: + errorAnalysisAnnotations: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotation + description: Annotations of model error analysis results. + groundTruths: + type: array + items: + type: any readOnly: true - type: any description: >- - Required. Output only. Additional information about the - DatasetVersion. - name: + Output only. The ground truth Annotations, i.e. the Annotations that + exist in the test data the Model is evaluated on. For true positive, + there is one and only one ground truth annotation, which matches the + only prediction in predictions. For false positive, there are zero + or more ground truth annotations that are similar to the only + prediction in predictions, but not enough for a match. For false + negative, there is one and only one ground truth annotation, which + doesn't match any predictions created by the model. The schema of + the ground truth is stored in ModelEvaluation.annotation_schema_uri + explanations: + description: >- + Explanations of predictions. Each element of the explanations + indicates the explanation for one explanation Method. The + attributions list in the EvaluatedAnnotationExplanation.explanation + object corresponds to the predictions list. For example, the second + element in the attributions list explains the second element in the + predictions list. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + dataItemPayload: + type: any readOnly: true - description: Output only. Identifier. The resource name of the DatasetVersion. - type: string - etag: description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - id: GoogleCloudAiplatformV1DatasetVersion + Output only. The data item payload that the Model predicted this + EvaluatedAnnotation on. type: object - description: Describes the dataset version. - GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse: - id: GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse - description: Response message for JobService.ListModelDeploymentMonitoringJobs. + description: >- + True positive, false positive, or false negative. EvaluatedAnnotation is + only available under ModelEvaluationSlice with slice of `annotationSpec` + dimension. + id: GoogleCloudAiplatformV1EvaluatedAnnotation + GoogleCloudAiplatformV1ListFeaturestoresResponse: type: object + id: GoogleCloudAiplatformV1ListFeaturestoresResponse + description: Response message for FeaturestoreService.ListFeaturestores. properties: nextPageToken: + description: >- + A token, which can be sent as ListFeaturestoresRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. type: string - description: The standard List next-page token. - modelDeploymentMonitoringJobs: + featurestores: type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob - description: >- - A list of ModelDeploymentMonitoringJobs that matches the specified - filter in the request. - GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata: - id: GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + description: The Featurestores matching the request. + GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance: + description: Prediction input format for Text Classification. type: object properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - progressMessage: + mimeType: description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain type: string - description: Metadata information for NotebookService.CreateNotebookExecutionJob. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + content: + type: string + description: The text snippet to make the predictions on. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance + GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams: + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams + description: Prediction model parameters for Image Object Detection. properties: - iouScore: - type: number + maxPredictions: + type: integer + format: int32 description: >- - The intersection-over-union score. The measure of overlap of the - annotation's category mask with ground truth category mask on the - DataItem. - format: float + The Model only returns up to that many top, by confidence score, + predictions per instance. Note that number of returned predictions + is also limited by metadata's predictionsLimit. Default value is 10. confidenceThreshold: format: float - type: number description: >- - Metrics are computed with an assumption that the model never returns - predictions with score lower than this value. - confusionMatrix: - description: Confusion matrix for the given confidence threshold. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - diceScoreCoefficient: - format: float - type: number - description: DSC or the F1 score, The harmonic mean of recall and precision. - precision: - type: number - description: Precision for the given confidence threshold. - format: float - recall: - format: float - description: Recall (True Positive Rate) for the given confidence threshold. + The Model only returns predictions with at least this confidence + score. Default value is 0.0 type: number - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry type: object - GoogleCloudAiplatformV1PipelineTaskDetail: + GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec: properties: - executorDetail: - description: Output only. The detailed execution info. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetail - readOnly: true - state: - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - CANCEL_PENDING - - CANCELLING - - CANCELLED - - FAILED - - SKIPPED - - NOT_TRIGGERED - description: Output only. State of the task. - enumDescriptions: - - Unspecified. - - Specifies pending state for the task. - - Specifies task is being executed. - - Specifies task completed successfully. - - Specifies Task cancel is in pending state. - - Specifies task is being cancelled. - - Specifies task was cancelled. - - Specifies task failed. - - Specifies task was skipped due to cache hit. - - >- - Specifies that the task was not triggered because the task's - trigger policy is not satisfied. The trigger policy is specified - in the `condition` field of PipelineJob.pipeline_spec. - readOnly: true - type: string - outputs: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - description: Output only. The runtime output artifacts of the task. - type: object - readOnly: true - error: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - description: >- - Output only. The error that occurred during task execution. Only - populated when the task's state is FAILED or CANCELLED. - inputs: - description: Output only. The runtime input artifacts of the task. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - readOnly: true - type: object - parentTaskId: - format: int64 - description: >- - Output only. The id of the parent task if the task is within a - component scope. Empty if the task is at the root level. - type: string - readOnly: true - startTime: - format: google-datetime - description: Output only. Task start time. - readOnly: true - type: string - execution: - readOnly: true - description: Output only. The execution metadata of the task. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - endTime: - readOnly: true - description: Output only. Task end time. - format: google-datetime - type: string - taskName: - description: >- - Output only. The user specified name of the task that is defined in - pipeline_spec. - readOnly: true - type: string - taskId: - readOnly: true + maxValue: + description: Required. Inclusive maximum value of the parameter. type: string format: int64 - description: Output only. The system generated ID of the task. - createTime: - type: string - format: google-datetime - readOnly: true - description: Output only. Task create time. - pipelineTaskStatus: - type: array - readOnly: true - description: >- - Output only. A list of task status. This field keeps a record of - task status evolving over time. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus - description: The runtime detail of a task execution. - type: object - id: GoogleCloudAiplatformV1PipelineTaskDetail - GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec: - description: Value specification for a parameter in `INTEGER` type. - type: object - id: GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec - properties: defaultValue: format: int64 + type: string description: >- A default value for an `INTEGER` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline. - type: string - maxValue: - type: string - format: int64 - description: Required. Inclusive maximum value of the parameter. minValue: format: int64 description: Required. Inclusive minimum value of the parameter. type: string - GoogleCloudAiplatformV1ResourceRuntime: - id: GoogleCloudAiplatformV1ResourceRuntime - properties: - accessUris: - type: object - readOnly: true - description: >- - Output only. URIs for user to connect to the Cluster. Example: { - "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" - "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } - additionalProperties: - type: string type: object - description: Persistent Cluster runtime information as output - GoogleCloudAiplatformV1SearchMigratableResourcesResponse: + description: Value specification for a parameter in `INTEGER` type. + id: GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec + GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult: properties: - nextPageToken: - type: string + bboxes: + items: + type: array + items: + type: any description: >- - The standard next-page token. The migratable_resources may not fill - page_size in SearchMigratableResourcesRequest even when there are - subsequent pages. - migratableResources: + Bounding boxes, i.e. the rectangles over the image, that pinpoint + the found AnnotationSpecs. Given in order that matches the IDs. Each + bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and + `yMax`, which represent the extremal coordinates of the box. They + are relative to the image size, and the point 0,0 is in the top left + of the image. + type: array + displayNames: type: array description: >- - All migratable resources that can be migrated to the location - specified in the request. + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' - description: Response message for MigrationService.SearchMigratableResources. - id: GoogleCloudAiplatformV1SearchMigratableResourcesResponse - type: object - GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines: - id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines + type: string + ids: + description: >- + The resource IDs of the AnnotationSpecs that had been identified, + ordered by the confidence score descendingly. + items: + format: int64 + type: string + type: array + confidences: + items: + format: float + type: number + description: >- + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. + type: array type: object - description: Open fine tuning pipelines. + description: Prediction output format for Image Object Detection. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult + GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse: properties: - fineTuningPipelines: - description: Required. Regional resource references to fine tuning pipelines. + blobs: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' type: array - GoogleCloudAiplatformV1ComputeTokensRequest: - id: GoogleCloudAiplatformV1ComputeTokensRequest + description: Blob messages containing blob bytes. + description: Response message for TensorboardService.ReadTensorboardBlobData. + type: object + id: GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse + GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata: + id: GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata type: object properties: - instances: - description: >- - Optional. The instances that are the input to token computing API - call. Schema is identical to the prediction schema of the text - model, even for the non-text models, like chat models, or Codey - models. - type: array - items: - type: any - model: - type: string + indexDisplayNameMapping: description: >- - Optional. The name of the publisher model requested to serve the - prediction. Format: - projects/{project}/locations/{location}/publishers/*/models/* - contents: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: Optional. Input content. + Static mapping between the index and display name. Use this if the + outputs are a deterministic n-dimensional array, e.g. a list of + scores of all the classes in a pre-defined order for a + multi-classification Model. It's not feasible if the outputs are + non-deterministic, e.g. the Model produces top-k classes or sort the + outputs by their values. The shape of the value must be an + n-dimensional array of strings. The number of dimensions must match + that of the outputs to be explained. The + Attribution.output_display_name is populated by locating in the + mapping with Attribution.output_index. + type: any + displayNameMappingKey: + type: string + description: >- + Specify a field name in the prediction to look for the display name. + Use this if the prediction contains the display names for the + outputs. The display names in the prediction must have the same + shape of the outputs, so that it can be located by + Attribution.output_index for a specific output. + outputTensorName: + description: >- + Name of the output tensor. Required and is only applicable to Vertex + AI provided images for Tensorflow. + type: string + description: Metadata of the prediction output to be explained. + GoogleCloudAiplatformV1ListEntityTypesResponse: + id: GoogleCloudAiplatformV1ListEntityTypesResponse + properties: + nextPageToken: + description: >- + A token, which can be sent as ListEntityTypesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: string + entityTypes: type: array - description: Request message for ComputeTokens RPC call. - GoogleCloudAiplatformV1SyncFeatureViewResponse: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + description: The EntityTypes matching the request. + type: object + description: Response message for FeaturestoreService.ListEntityTypes. + GoogleCloudAiplatformV1StudySpecMetricSpec: properties: - featureViewSync: + goal: + enum: + - GOAL_TYPE_UNSPECIFIED + - MAXIMIZE + - MINIMIZE + enumDescriptions: + - Goal Type will default to maximize. + - Maximize the goal metric. + - Minimize the goal metric. + type: string + description: Required. The optimization goal of the metric. + metricId: type: string description: >- - Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` - id: GoogleCloudAiplatformV1SyncFeatureViewResponse - description: Response message for FeatureOnlineStoreAdminService.SyncFeatureView. + Required. The ID of the metric. Must not contain whitespaces and + must be unique amongst all MetricSpecs. + safetyConfig: + description: >- + Used for safe search. In the case, the metric will be a safety + metric. You must provide a separate metric for objective metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig + id: GoogleCloudAiplatformV1StudySpecMetricSpec + description: Represents a metric to optimize. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation: + GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata: + properties: + genericMetadata: + description: Operation metadata for EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation + description: Details of operations that perform create EntityType. + id: GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata + GoogleCloudAiplatformV1FluencyInstance: + id: GoogleCloudAiplatformV1FluencyInstance properties: - columnName: - type: string - timeFormat: - description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + prediction: type: string + description: Required. Output of the evaluated model. + description: Spec for fluency instance. + type: object + GoogleCloudAiplatformV1ToolConfig: + id: GoogleCloudAiplatformV1ToolConfig description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification + Tool config. This config is shared for all tools provided in the + request. type: object properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs - description: The input parameters of this TrainingJob. - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata - description: The metadata information. + functionCallingConfig: + description: Optional. Function calling config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' + GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource: description: >- - A TrainingJob that trains and uploads an AutoML Image Classification - Model. - GoogleCloudAiplatformV1CompleteTrialRequest: - description: Request message for VizierService.CompleteTrial. - properties: - trialInfeasible: - description: >- - Optional. True if the Trial cannot be run with the given Parameter, - and final_measurement will be ignored. - type: boolean - finalMeasurement: - description: >- - Optional. If provided, it will be used as the completed Trial's - final_measurement; Otherwise, the service will auto-select a - previously reported measurement as the final-measurement - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - infeasibleReason: - type: string - description: >- - Optional. A human readable reason why the trial was infeasible. This - should only be provided if `trial_infeasible` is true. - type: object - id: GoogleCloudAiplatformV1CompleteTrialRequest - GoogleCloudAiplatformV1FeatureGroupBigQuery: - id: GoogleCloudAiplatformV1FeatureGroupBigQuery + A Feature Registry source for features that need to be synced to Online + Store. + id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource type: object properties: - timeSeries: + projectNumber: + format: int64 + type: string description: >- - Optional. If the source is a time-series source, this can be set to - control how downstream sources (ex: FeatureView ) will treat - time-series sources. If not set, will treat the source as a - time-series source with `feature_timestamp` as timestamp column and - no scan boundary. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries - staticDataSource: - description: Optional. Set if the data source is not a time-series. - type: boolean - entityIdColumns: + Optional. The project number of the parent project of the Feature + Groups. + featureGroups: + description: Required. List of features that need to be synced to Online Store. type: array - description: >- - Optional. Columns to construct entity_id / row keys. If not provided - defaults to `entity_id`. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup + GoogleCloudAiplatformV1VertexRagStoreRagResource: + properties: + ragFileIds: items: type: string - dense: description: >- - Optional. If set, all feature values will be fetched from a single - row per unique entityId including nulls. If not set, will collapse - all rows for each unique entityId into a singe row with any non-null - values if present, if no non-null values are present will sync null. - ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` - and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` - `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, - 20, null)` is synced to online stores. If dense is not set, `(e1, - 20, 15)` is synced to online stores. - type: boolean - bigQuerySource: + Optional. rag_file_id. The files should be in the same rag_corpus + set in rag_corpus field. + type: array + ragCorpus: + type: string description: >- - Required. Immutable. The BigQuery source URI that points to either a - BigQuery Table or View. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: Input source type for BigQuery Tables and Views. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs: + Optional. RagCorpora resource name. Format: + `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + type: object + id: GoogleCloudAiplatformV1VertexRagStoreRagResource + description: The definition of the Rag resource. + GoogleCloudAiplatformV1TuningDataStats: + id: GoogleCloudAiplatformV1TuningDataStats properties: - modelType: - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_CORAL_VERSATILE_1 - - MOBILE_CORAL_LOW_LATENCY_1 - - MOBILE_JETSON_VERSATILE_1 - - MOBILE_JETSON_LOW_LATENCY_1 - enumDescriptions: - - Should not be set. - - >- - A model best tailored to be used within Google Cloud, and which c - annot be exported. Default. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. - - >- - A versatile model that is meant to be exported (see - ModelService.ExportModel) and used on a Google Coral device. - - >- - A model that trades off quality for low latency, to be exported - (see ModelService.ExportModel) and used on a Google Coral device. - - >- - A versatile model that is meant to be exported (see - ModelService.ExportModel) and used on an NVIDIA Jetson device. - - >- - A model that trades off quality for low latency, to be exported - (see ModelService.ExportModel) and used on an NVIDIA Jetson - device. - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs + supervisedTuningDataStats: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats + description: The SFT Tuning data stats. type: object - GoogleCloudAiplatformV1PersistentDiskSpec: + description: The tuning data statistic values for TuningJob. + GoogleCloudAiplatformV1FeatureViewDataKey: + description: Lookup key for a feature view. properties: - diskSizeGb: - format: int64 - type: string - description: Size in GB of the disk (default is 100GB). - diskType: + compositeKey: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey 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) + The actual Entity ID will be composed from this struct. This should + match with the way ID is defined in the FeatureView spec. + key: + description: String key to use for lookup. type: string - id: GoogleCloudAiplatformV1PersistentDiskSpec + id: GoogleCloudAiplatformV1FeatureViewDataKey type: object - description: Represents the spec of persistent disk options. - GoogleCloudAiplatformV1PredictResponse: - description: Response message for PredictionService.Predict. - id: GoogleCloudAiplatformV1PredictResponse + GoogleCloudAiplatformV1ExplanationMetadata: type: object + description: Metadata describing the Model's input and output for explanation. + id: GoogleCloudAiplatformV1ExplanationMetadata properties: - model: + latentSpaceSource: type: string - readOnly: true - description: >- - Output only. The resource name of the Model which is deployed as the - DeployedModel that this prediction hits. - modelDisplayName: - readOnly: true description: >- - Output only. The display name of the Model which is deployed as the - DeployedModel that this prediction hits. + Name of the source to generate embeddings for example based + explanations. + featureAttributionsSchemaUri: type: string - metadata: - readOnly: true - type: any description: >- - Output only. Request-level metadata returned by the model. The - metadata type will be dependent upon the model implementation. - predictions: - type: array + Points to a YAML file stored on Google Cloud Storage describing the + format of the feature attributions. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML tabular Models always have this field populated by Vertex AI. + Note: The URI given on output may be different, including the URI + scheme, than the one given on input. The output URI will point to a + location where the user only has a read access. + outputs: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata description: >- - The predictions that are the output of the predictions call. The - schema of any single prediction may be specified via Endpoint's - DeployedModels' Model's PredictSchemata's prediction_schema_uri. - items: - type: any - deployedModelId: + Required. Map from output names to output metadata. For Vertex + AI-provided Tensorflow images, keys can be any user defined string + that consists of any UTF-8 characters. For custom images, keys are + the name of the output field in the prediction to be explained. + Currently only one key is allowed. + type: object + inputs: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadata + description: >- + Required. Map from feature names to feature input metadata. Keys are + the name of the features. Values are the specification of the + feature. An empty InputMetadata is valid. It describes a text + feature which has the name specified as the key in + ExplanationMetadata.inputs. The baseline of the empty feature is + chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the + key can be any friendly name of the feature. Once specified, + featureAttributions are keyed by this key (if not grouped with + another feature). For custom images, the key must match with the key + in instance. + type: object + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata: + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata + properties: + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig + timeSeriesIdentifierColumn: type: string - description: ID of the Endpoint's DeployedModel that served this prediction. - modelVersionId: description: >- - Output only. The version ID of the Model which is deployed as the - DeployedModel that this prediction hits. + The column name of the time series identifier column that identifies + the time series. + timeColumn: type: string - readOnly: true - GoogleCloudAiplatformV1ListPipelineJobsResponse: - description: Response message for PipelineService.ListPipelineJobs + description: >- + The column name of the time column that identifies time order in the + time series. + type: object + description: The metadata of Datasets that contain time series data. + GoogleCloudAiplatformV1FindNeighborsResponse: + id: GoogleCloudAiplatformV1FindNeighborsResponse type: object + description: The response message for MatchService.FindNeighbors. properties: - pipelineJobs: - description: List of PipelineJobs in the requested page. + nearestNeighbors: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors type: array - nextPageToken: - type: string - description: >- - A token to retrieve the next page of results. Pass to - ListPipelineJobsRequest.page_token to obtain that page. - id: GoogleCloudAiplatformV1ListPipelineJobsResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + description: The nearest neighbors of the query datapoints. + GoogleCloudAiplatformV1RougeResults: + description: Results for rouge metric. properties: - modelType: - enumDescriptions: - - Should not be set. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Default. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) to a Jetson - device afterwards. - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_JETSON_VERSATILE_1 - type: string + rougeMetricValues: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeMetricValue' + readOnly: true + description: Output only. Rouge metric values. + id: GoogleCloudAiplatformV1RougeResults type: object - GoogleCloudAiplatformV1ImportFeatureValuesResponse: - description: Response message for FeaturestoreService.ImportFeatureValues. + GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource: properties: - importedFeatureValueCount: - type: string - format: int64 - description: Number of Feature values that have been imported by the operation. - invalidRowCount: + uri: type: string description: >- - The number of rows in input source that weren't imported due to - either * Not having any featureValues. * Having a null entityId. * - Having a null timestamp. * Not being parsable (applicable for CSV - sources). - format: int64 - importedEntityCount: - description: Number of entities that have been imported by the operation. + The Cloud Storage uri pointing to the ipynb file. Format: + `gs://bucket/notebook_file.ipynb` + generation: type: string - format: int64 - timestampOutsideRetentionRowsCount: description: >- - The number rows that weren't ingested due to having feature - timestamps outside the retention boundary. - type: string - format: int64 - id: GoogleCloudAiplatformV1ImportFeatureValuesResponse + The version of the Cloud Storage object to read. If unset, the + current version of the object is read. See + https://cloud.google.com/storage/docs/metadata#generation-number. + type: object + description: The Cloud Storage uri for the input notebook. + id: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig: type: object - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse: description: >- - Response message for - JobService.SearchModelDeploymentMonitoringStatsAnomalies. + Config for migrating AnnotatedDataset in datalabeling.googleapis.com to + Vertex AI's SavedQuery. properties: - nextPageToken: + annotatedDataset: type: string description: >- - The page token that can be used by the next - JobService.SearchModelDeploymentMonitoringStatsAnomalies call. - monitoringStats: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies - description: >- - Stats retrieved for requested objectives. There are at most 1000 - ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats - in the response. - type: array + Required. Full resource name of data labeling AnnotatedDataset. + Format: + `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse - type: object - GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata: + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig + GoogleCloudAiplatformV1AutoscalingMetricSpec: + id: GoogleCloudAiplatformV1AutoscalingMetricSpec properties: - candidatesTokenCount: + target: format: int32 - description: Number of tokens in the response(s). type: integer - promptTokenCount: description: >- - Number of tokens in the request. When `cached_content` is set, this - is still the total effective prompt size meaning this includes the - number of tokens in the cached content. - type: integer - format: int32 - totalTokenCount: - type: integer - format: int32 - description: Total token count for prompt and response candidates. - type: object - description: Usage metadata about response(s). - id: GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata - GoogleCloudAiplatformV1StratifiedSplit: - id: GoogleCloudAiplatformV1StratifiedSplit - description: >- - Assigns input data to the training, validation, and test sets so that - the distribution of values found in the categorical column (as specified - by the `key` field) is mirrored within each split. The fraction values - determine the relative sizes of the splits. For example, if the - specified column has three values, with 50% of the rows having value - "A", 25% value "B", and 25% value "C", and the split fractions are - specified as 80/10/10, then the training set will constitute 80% of the - training data, with about 50% of the training set rows having the value - "A" for the specified column, about 25% having the value "B", and about - 25% having the value "C". Only the top 500 occurring values are used; - any values not in the top 500 values are randomly assigned to a split. - If less than three rows contain a specific value, those rows are - randomly assigned. Supported only for tabular Datasets. - properties: - trainingFraction: - type: number + The target resource utilization in percentage (1% - 100%) for the + given metric; once the real usage deviates from the target by a + certain percentage, the machine replicas change. The default value + is 60 (representing 60%) if not provided. + metricName: description: >- - The fraction of the input data that is to be used to train the - Model. - format: double - validationFraction: - type: number - format: double - description: >- - The fraction of the input data that is to be used to validate the - Model. - testFraction: - format: double - type: number - description: >- - The fraction of the input data that is to be used to evaluate the - Model. - key: + Required. The resource metric name. Supported metrics: * For Online + Prediction: * + `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` + * `aiplatform.googleapis.com/prediction/online/cpu/utilization` type: string - description: >- - Required. The key is a name of one of the Dataset's data columns. - The key provided must be for a categorical column. - type: object - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig: - properties: - bigquerySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig description: >- - The tables Dataset's data source. The Dataset doesn't store the data - directly, but only pointer(s) to its data. + The metric specification that defines the target resource utilization + (CPU utilization, accelerator's duty cycle, and so on) for calculating + the desired replica count. type: object - GoogleCloudAiplatformV1FeatureOnlineStore: + GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail: + description: The detailed info for a custom job executor. properties: - name: - type: string + failedJobs: description: >- - Identifier. Name of the FeatureOnlineStore. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` - state: - description: Output only. State of the featureOnlineStore. + Output only. The names of the previously failed CustomJob. The list + includes the all attempts in chronological order. readOnly: true - enumDescriptions: - - Default value. This value is unused. - - >- - State when the featureOnlineStore configuration is not being - updated and the fields reflect the current configuration of the - featureOnlineStore. The featureOnlineStore is usable in this - state. - - >- - The state of the featureOnlineStore configuration when it is being - updated. During an update, the fields reflect either the original - configuration or the updated configuration of the - featureOnlineStore. The featureOnlineStore is still usable in this - state. - enum: - - STATE_UNSPECIFIED - - STABLE - - UPDATING + items: + type: string + type: array + job: type: string - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Optional. Customer-managed encryption key spec for data storage. If - set, online store will be secured by this key. - satisfiesPzs: + description: Output only. The name of the CustomJob. readOnly: true - description: Output only. Reserved for future use. - type: boolean - dedicatedServingEndpoint: - description: >- - Optional. The dedicated serving endpoint for this - FeatureOnlineStore, which is different from common Vertex service - endpoint. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint - bigtable: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + type: object + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource: + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource + type: object + properties: + uri: + type: array description: >- - Contains settings for the Cloud Bigtable instance that will be - created to serve featureValues for all FeatureViews under this - FeatureOnlineStore. - labels: + Cloud Storage URI of one or more files. Only CSV files are + supported. The first line of the CSV file is used as the header. If + there are multiple files, the header is the first line of the + lexicographically first file, the other files must either contain + the exact same header or omit the header. + items: + type: string + GoogleCloudAiplatformV1ImportDataConfig: + properties: + gcsSource: + description: The Google Cloud Storage location for the input content. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + dataItemLabels: type: object - description: >- - Optional. The labels with user-defined metadata to organize your - FeatureOnlineStore. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one FeatureOnlineStore(System labels are excluded)." System - reserved label keys are prefixed with "aiplatform.googleapis.com/" - and are immutable. additionalProperties: type: string - optimized: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreOptimized description: >- - Contains settings for the Optimized store that will be created to - serve featureValues for all FeatureViews under this - FeatureOnlineStore. When choose Optimized storage type, need to set - PrivateServiceConnectConfig.enable_private_service_connect to use - private endpoint. Otherwise will use public endpoint by default. - createTime: - format: google-datetime - type: string - readOnly: true - description: Output only. Timestamp when this FeatureOnlineStore was created. - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean - readOnly: true - updateTime: - readOnly: true - type: string - format: google-datetime + Labels that will be applied to newly imported DataItems. If an + identical DataItem as one being imported already exists in the + Dataset, then these labels will be appended to these of the already + existing one, and if labels with identical key is imported before, + the old label value will be overwritten. If two DataItems are + identical in the same import data operation, the labels will be + combined and if key collision happens in this case, one of the + values will be picked randomly. Two DataItems are considered + identical if their content bytes are identical (e.g. image bytes or + pdf bytes). These labels will be overridden by Annotation labels + specified inside index file referenced by import_schema_uri, e.g. + jsonl file. + importSchemaUri: description: >- - Output only. Timestamp when this FeatureOnlineStore was last - updated. - etag: + Required. Points to a YAML file stored on Google Cloud Storage + describing the import format. Validation will be done against the + schema. The schema is defined as an [OpenAPI 3.0.2 Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). type: string + annotationLabels: + additionalProperties: + type: string + type: object description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - id: GoogleCloudAiplatformV1FeatureOnlineStore - type: object - description: >- - Vertex AI Feature Online Store provides a centralized repository for - serving ML features and embedding indexes at low latency. The Feature - Online Store is a top-level container. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation: - properties: - columnName: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation + Labels that will be applied to newly imported Annotations. If two + Annotations are identical, one of them will be deduped. Two + Annotations are considered identical if their payload, + payload_schema_uri and all of their labels are the same. These + labels will be overridden by Annotation labels specified inside + index file referenced by import_schema_uri, e.g. jsonl file. description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. + 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. type: object - GoogleCloudAiplatformV1PredictSchemata: + id: GoogleCloudAiplatformV1ImportDataConfig + GoogleCloudAiplatformV1ExactMatchMetricValue: type: object - description: >- - Contains the schemata used in Model's predictions and explanations via - PredictionService.Predict, PredictionService.Explain and - BatchPredictionJob. - id: GoogleCloudAiplatformV1PredictSchemata + description: Exact match metric value for an instance. + id: GoogleCloudAiplatformV1ExactMatchMetricValue properties: - parametersSchemaUri: - description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the parameters of prediction and explanation via - PredictRequest.parameters, ExplainRequest.parameters and - BatchPredictionJob.model_parameters. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI, if no - parameters are supported, then it is set to an empty string. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - type: string - predictionSchemaUri: - description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the format of a single prediction produced by this Model, - which are returned via PredictResponse.predictions, - ExplainResponse.explanations, and BatchPredictionJob.output_config. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - type: string - instanceSchemaUri: - type: string - description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the format of a single instance, which are used in - PredictRequest.instances, ExplainRequest.instances and - BatchPredictionJob.input_config. The schema is defined as an OpenAPI - 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - GoogleCloudAiplatformV1BleuInput: + score: + readOnly: true + type: number + format: float + description: Output only. Exact match score. + GoogleCloudAiplatformV1FluencyInput: + type: object + description: Input for fluency metric. + id: GoogleCloudAiplatformV1FluencyInput properties: metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuSpec' - description: Required. Spec for bleu score metric. - instances: - description: Required. Repeated bleu instances. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInstance' - description: Input for bleu metric. - id: GoogleCloudAiplatformV1BleuInput + description: Required. Spec for fluency score metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencySpec' + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInstance' + description: Required. Fluency instance. + GoogleCloudAiplatformV1PairwiseMetricInput: + properties: + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInstance' + description: Required. Pairwise metric instance. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricSpec' + description: Required. Spec for pairwise metric. type: object - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair: + id: GoogleCloudAiplatformV1PairwiseMetricInput + description: Input for pairwise metric. + GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature: properties: name: + description: >- + The name of the input feature for which noise sigma is provided. The + features are defined in explanation metadata inputs. type: string - description: Feature short name. - value: - description: Feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - id: >- - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + sigma: + description: >- + This represents the standard deviation of the Gaussian kernel that + will be used to add noise to the feature prior to computing + gradients. Similar to noise_sigma but represents the noise added to + the current feature. Defaults to 0.1. + format: float + type: number + description: Noise sigma for a single feature. type: object - description: Feature name & value pair. - GoogleCloudAiplatformV1UpdateIndexOperationMetadata: - id: GoogleCloudAiplatformV1UpdateIndexOperationMetadata + id: GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + GoogleCloudAiplatformV1SearchDataItemsResponse: type: object - description: Runtime operation information for IndexService.UpdateIndex. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - nearestNeighborSearchOperationMetadata: + dataItemViews: + description: The DataItemViews read. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItemView' + type: array + nextPageToken: description: >- - The operation metadata with regard to Matching Engine Index - operation. + A token to retrieve next page of results. Pass to + SearchDataItemsRequest.page_token to obtain that page. + type: string + description: Response message for DatasetService.SearchDataItems. + id: GoogleCloudAiplatformV1SearchDataItemsResponse + GoogleCloudAiplatformV1SummarizationQualityInput: + properties: + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SummarizationQualitySpec' + description: Required. Spec for summarization quality score metric. + instance: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata - GoogleCloudAiplatformV1GenerateContentResponse: - description: Response message for [PredictionService.GenerateContent]. + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInstance + description: Required. Summarization quality instance. + description: Input for summarization quality metric. + id: GoogleCloudAiplatformV1SummarizationQualityInput + type: object + GoogleCloudAiplatformV1ListIndexesResponse: + type: object + id: GoogleCloudAiplatformV1ListIndexesResponse + description: Response message for IndexService.ListIndexes. properties: - candidates: - description: Output only. Generated candidates. + nextPageToken: + type: string + description: >- + A token to retrieve next page of results. Pass to + ListIndexesRequest.page_token to obtain that page. + indexes: + description: List of indexes in the requested page. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Candidate' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' type: array + GoogleCloudAiplatformV1MigratableResource: + type: object + properties: + dataLabelingDataset: readOnly: true - promptFeedback: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset + description: Output only. Represents one Dataset in datalabeling.googleapis.com. + mlEngineModelVersion: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion + description: Output only. Represents one Version in ml.googleapis.com. + automlModel: + description: Output only. Represents one Model in automl.googleapis.com. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlModel + readOnly: true + lastMigrateTime: + type: string + format: google-datetime + readOnly: true description: >- - Output only. Content filter results for a prompt sent in the - request. Note: Sent only in the first stream chunk. Only happens - when no candidates were generated due to content violations. + Output only. Timestamp when the last migration attempt on this + MigratableResource started. Will not be set if there's no migration + attempt on this MigratableResource. + lastUpdateTime: readOnly: true - usageMetadata: + description: >- + Output only. Timestamp when this MigratableResource was last + updated. + type: string + format: google-datetime + automlDataset: + description: Output only. Represents one Dataset in automl.googleapis.com. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata - description: Usage metadata about the response(s). - id: GoogleCloudAiplatformV1GenerateContentResponse - type: object - GoogleCloudAiplatformV1ExamplesRestrictionsNamespace: + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlDataset + readOnly: true + description: >- + Represents one resource that exists in automl.googleapis.com, + datalabeling.googleapis.com or ml.googleapis.com. + id: GoogleCloudAiplatformV1MigratableResource + GoogleCloudAiplatformV1IdMatcher: properties: - deny: + ids: items: type: string - description: The list of deny tags. - type: array - namespaceName: - type: string - description: The namespace name. - allow: - description: The list of allowed tags. + description: >- + Required. The following are accepted as `ids`: * A single-element + list containing only `*`, which selects all Features in the target + EntityType, or * A list containing only Feature IDs, which selects + only Features with those IDs in the target EntityType. type: array - items: - type: string - id: GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + description: Matcher for Features of an EntityType by Feature ID. type: object - description: Restrictions namespace for example-based explanations overrides. - GoogleCloudAiplatformV1PurgeExecutionsMetadata: - id: GoogleCloudAiplatformV1PurgeExecutionsMetadata + id: GoogleCloudAiplatformV1IdMatcher + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs: + properties: {} + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest: + id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest type: object + description: Request message for ModelService.BatchImportModelEvaluationSlices properties: - genericMetadata: - description: Operation metadata for purging Executions. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform MetadataService.PurgeExecutions. - GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport: + modelEvaluationSlices: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + description: Required. Model evaluation slice resource to be imported. + GoogleCloudAiplatformV1ListEndpointsResponse: + type: object + id: GoogleCloudAiplatformV1ListEndpointsResponse + description: Response message for EndpointService.ListEndpoints. properties: - snapshotTime: - description: >- - Exports Feature values as of this timestamp. If not set, retrieve - values as of now. Timestamp, if present, must not have higher than - millisecond precision. - format: google-datetime + nextPageToken: type: string - startTime: + description: >- + A token to retrieve the next page of results. Pass to + ListEndpointsRequest.page_token to obtain that page. + endpoints: + type: array + description: List of Endpoints in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + GoogleCloudAiplatformV1ReadFeatureValuesRequest: + properties: + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + description: Required. Selector choosing Features of the target EntityType. + entityId: type: string description: >- - Excludes Feature values with feature generation timestamp before - this timestamp. If not set, retrieve oldest values kept in Feature - Store. Timestamp, if present, must not have higher than millisecond - precision. - format: google-datetime - type: object - description: >- - Describes exporting the latest Feature values of all entities of the - EntityType between [start_time, snapshot_time]. - id: GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization: - id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization + Required. ID for a specific entity. For example, for a machine + learning model predicting user clicks on a website, an entity ID + could be `user_123`. type: object - description: Visualization configurations for image explanation. + description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. + id: GoogleCloudAiplatformV1ReadFeatureValuesRequest + GoogleCloudAiplatformV1ListIndexEndpointsResponse: + description: Response message for IndexEndpointService.ListIndexEndpoints. properties: - clipPercentUpperbound: - format: float - type: number + indexEndpoints: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + description: List of IndexEndpoints in the requested page. + type: array + nextPageToken: description: >- - Excludes attributions above the specified percentile from the - highlighted areas. Using the clip_percent_upperbound and - clip_percent_lowerbound together can be useful for filtering out - noise and making it easier to see areas of strong attribution. - Defaults to 99.9. - colorMap: + A token to retrieve next page of results. Pass to + ListIndexEndpointsRequest.page_token to obtain that page. type: string - enum: - - COLOR_MAP_UNSPECIFIED - - PINK_GREEN - - VIRIDIS - - RED - - GREEN - - RED_GREEN - - PINK_WHITE_GREEN - enumDescriptions: - - Should not be used. - - 'Positive: green. Negative: pink.' - - >- - Viridis color map: A perceptually uniform color mapping which is - easier to see by those with colorblindness and progresses from - yellow to green to blue. Positive: yellow. Negative: blue. - - 'Positive: red. Negative: red.' - - 'Positive: green. Negative: green.' - - 'Positive: green. Negative: red.' - - PiYG palette. - description: >- - The color scheme used for the highlighted areas. Defaults to - PINK_GREEN for Integrated Gradients attribution, which shows - positive attributions in green and negative in pink. Defaults to - VIRIDIS for XRAI attribution, which highlights the most influential - regions in yellow and the least influential in blue. - polarity: - enumDescriptions: - - Default value. This is the same as POSITIVE. - - >- - Highlights the pixels/outlines that were most influential to the - model's prediction. - - >- - Setting polarity to negative highlights areas that does not lead - to the models's current prediction. - - Shows both positive and negative attributions. - description: >- - Whether to only highlight pixels with positive contributions, - negative or both. Defaults to POSITIVE. - enum: - - POLARITY_UNSPECIFIED - - POSITIVE - - NEGATIVE - - BOTH - type: string - overlayType: + id: GoogleCloudAiplatformV1ListIndexEndpointsResponse + type: object + GoogleCloudAiplatformV1ReservationAffinity: + type: object + description: >- + A ReservationAffinity can be used to configure a Vertex AI resource + (e.g., a DeployedModel) to draw its Compute Engine resources from a + Shared Reservation, or exclusively from on-demand capacity. + id: GoogleCloudAiplatformV1ReservationAffinity + properties: + reservationAffinityType: enumDescriptions: - - Default value. This is the same as NONE. - - No overlay. - - The attributions are shown on top of the original image. - - >- - The attributions are shown on top of grayscaled version of the - original image. + - Default value. This should not be used. + - Do not consume from any reserved capacity, only use on-demand. + - Consume any reservation available, falling back to on-demand. - >- - The attributions are used as a mask to reveal predictive parts of - the image and hide the un-predictive parts. + Consume from a specific reservation. When chosen, the reservation + must be identified via the `key` and `values` fields. + description: Required. Specifies the reservation affinity type. enum: - - OVERLAY_TYPE_UNSPECIFIED - - NONE - - ORIGINAL - - GRAYSCALE - - MASK_BLACK + - TYPE_UNSPECIFIED + - NO_RESERVATION + - ANY_RESERVATION + - SPECIFIC_RESERVATION type: string + values: + items: + type: string + type: array description: >- - How the original image is displayed in the visualization. Adjusting - the overlay can help increase visual clarity if the original image - makes it difficult to view the visualization. Defaults to NONE. - clipPercentLowerbound: - type: number + Optional. Corresponds to the label values of a reservation resource. + This must be the full resource name of the reservation. + key: description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. - format: float - type: + Optional. Corresponds to the label key of a reservation resource. To + target a SPECIFIC_RESERVATION by name, use + `compute.googleapis.com/reservation-name` as the key and specify the + name of your reservation as its value. type: string - description: >- - Type of the image visualization. Only applicable to Integrated - Gradients attribution. OUTLINES shows regions of attribution, while - PIXELS shows per-pixel attribution. Defaults to OUTLINES. - enumDescriptions: - - Should not be used. - - Shows which pixel contributed to the image prediction. - - >- - Shows which region contributed to the image prediction by - outlining the region. - enum: - - TYPE_UNSPECIFIED - - PIXELS - - OUTLINES - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError: - id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError + GoogleCloudAiplatformV1PSCAutomationConfig: + id: GoogleCloudAiplatformV1PSCAutomationConfig properties: - sourceGcsUri: + projectId: + description: Required. Project id used to create forwarding rule. type: string - description: Cloud Storage URI pointing to the original file in user's bucket. - errorType: - enumDescriptions: - - Default, shall not be used. - - The record is empty. - - Invalid json format. - - Invalid csv format. - - Invalid avro format. - - The embedding id is not valid. - - >- - The size of the dense embedding vectors does not match with the - specified dimension. - - The `namespace` field is missing. - - >- - Generic catch-all error. Only used for validation failure where - the root cause cannot be easily retrieved programmatically. - - There are multiple restricts with the same `namespace` value. - - Numeric restrict has operator specified in datapoint. - - Numeric restrict has multiple values specified. - - Numeric restrict has invalid numeric value specified. - - File is not in UTF_8 format. - - Error parsing sparse dimensions field. - - Token restrict value is invalid. - - Invalid sparse embedding. - - Invalid dense embedding. - description: The error type of this record. + network: type: string - enum: - - ERROR_TYPE_UNSPECIFIED - - EMPTY_LINE - - INVALID_JSON_SYNTAX - - INVALID_CSV_SYNTAX - - INVALID_AVRO_SYNTAX - - INVALID_EMBEDDING_ID - - EMBEDDING_SIZE_MISMATCH - - NAMESPACE_MISSING - - PARSING_ERROR - - DUPLICATE_NAMESPACE - - OP_IN_DATAPOINT - - MULTIPLE_VALUES - - INVALID_NUMERIC_VALUE - - INVALID_ENCODING - - INVALID_SPARSE_DIMENSIONS - - INVALID_TOKEN_VALUE - - INVALID_SPARSE_EMBEDDING - - INVALID_EMBEDDING - errorMessage: description: >- - A human-readable message that is shown to the user to help them fix - the error. Note that this message may change from time to time, your - code should check against error_type as the source of truth. - type: string - embeddingId: - type: string - description: Empty if the embedding id is failed to parse. - rawRecord: - type: string - description: The original content of this record. - type: object - GoogleCloudAiplatformV1CreateTensorboardOperationMetadata: - id: GoogleCloudAiplatformV1CreateTensorboardOperationMetadata - properties: - genericMetadata: - description: Operation metadata for Tensorboard. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + Required. The full name of the Google Compute Engine + [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where {project} is a + project number, as in '12345', and {network} is network name. type: object - description: Details of operations that perform create Tensorboard. - GoogleCloudAiplatformV1ToolCallValidInput: + description: >- + PSC config that is used to automatically create forwarding rule via + ServiceConnectionMap. + GoogleCloudAiplatformV1BleuInput: + id: GoogleCloudAiplatformV1BleuInput type: object - description: Input for tool call valid metric. - id: GoogleCloudAiplatformV1ToolCallValidInput properties: instances: - type: array + description: Required. Repeated bleu instances. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInstance' - description: Required. Repeated tool call valid instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInstance' + type: array metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidSpec' - description: Required. Spec for tool call valid metric. - GoogleCloudAiplatformV1NearestNeighborQueryParameters: - id: GoogleCloudAiplatformV1NearestNeighborQueryParameters + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuSpec' + description: Required. Spec for bleu score metric. + description: Input for bleu metric. + GoogleCloudAiplatformV1Segment: properties: - leafNodesSearchFraction: - format: double - type: number + endIndex: description: >- - Optional. The fraction of the number of leaves to search, set at - query time allows user to tune search performance. This value - increase result in both search accuracy and latency increase. The - value should be between 0.0 and 1.0. - approximateNeighborCandidates: + Output only. End index in the given Part, measured in bytes. Offset + from the start of the Part, exclusive, starting at zero. format: int32 - description: >- - Optional. The number of neighbors to find via approximate search - before exact reordering is performed; if set, this value must be > - neighbor_count. + readOnly: true type: integer - description: >- - Parameters that can be overrided in each query to tune query latency and - recall. - type: object - GoogleCloudAiplatformV1IndexPrivateEndpoints: - id: GoogleCloudAiplatformV1IndexPrivateEndpoints - properties: - matchGrpcAddress: + text: + description: >- + Output only. The text corresponding to the segment from the + response. readOnly: true type: string - description: Output only. The ip address used to send match gRPC requests. - pscAutomatedEndpoints: - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' + startIndex: + type: integer + format: int32 description: >- - Output only. PscAutomatedEndpoints is populated if private service - connect is enabled if PscAutomatedConfig is set. - serviceAttachment: + Output only. Start index in the given Part, measured in bytes. + Offset from the start of the Part, inclusive, starting at zero. readOnly: true - type: string + partIndex: + readOnly: true + format: int32 description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. + Output only. The index of a Part object within its parent Content + object. + type: integer type: object - description: >- - IndexPrivateEndpoints proto is used to provide paths for users to send - requests via private endpoints (e.g. private service access, private - service connect). To send request via private service access, use - match_grpc_address. To send request via private service connect, use - service_attachment. - GoogleCloudAiplatformV1CancelPipelineJobRequest: + id: GoogleCloudAiplatformV1Segment + description: Segment of the content. + GoogleCloudAiplatformV1MutateDeployedModelRequest: + description: Request message for EndpointService.MutateDeployedModel. + id: GoogleCloudAiplatformV1MutateDeployedModelRequest type: object - properties: {} - id: GoogleCloudAiplatformV1CancelPipelineJobRequest - description: Request message for PipelineService.CancelPipelineJob. - GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion: - id: GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion - description: Represents one model Version in ml.googleapis.com. properties: - endpoint: - type: string + deployedModel: description: >- - The ml.googleapis.com endpoint that this model Version currently - lives in. Example values: * ml.googleapis.com * - us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * - asia-east1-ml.googleapis.com - version: + Required. The DeployedModel to be mutated within the Endpoint. Only + the following fields can be mutated: * `min_replica_count` in either + DedicatedResources or AutomaticResources * `max_replica_count` in + either DedicatedResources or AutomaticResources * + autoscaling_metric_specs * `disable_container_logging` (v1 only) * + `enable_container_logging` (v1beta1 only) + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + updateMask: + format: google-fieldmask description: >- - Full resource name of ml engine model Version. Format: - `projects/{project}/models/{model}/versions/{version}`. + Required. The update mask applies to the resource. See + google.protobuf.FieldMask. type: string - type: object - GoogleCloudAiplatformV1AddContextChildrenRequest: - id: GoogleCloudAiplatformV1AddContextChildrenRequest - properties: - childContexts: - items: - type: string - description: The resource names of the child Contexts. - type: array - description: Request message for MetadataService.AddContextChildren. - type: object - GoogleCloudAiplatformV1ExactMatchInput: + GoogleCloudAiplatformV1ToolNameMatchInput: properties: + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchSpec' + description: Required. Spec for tool name match metric. instances: type: array - description: Required. Repeated exact match instances. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInstance' - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchSpec' - description: Required. Spec for exact match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInstance' + description: Required. Repeated tool name match instances. + id: GoogleCloudAiplatformV1ToolNameMatchInput + description: Input for tool name match metric. type: object - id: GoogleCloudAiplatformV1ExactMatchInput - description: Input for exact match metric. - GoogleCloudAiplatformV1StudyTimeConstraint: - id: GoogleCloudAiplatformV1StudyTimeConstraint + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse: + description: >- + Response message for + JobService.SearchModelDeploymentMonitoringStatsAnomalies. + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse properties: - maxDuration: - type: string - description: Counts the wallclock time passed since the creation of this Study. - format: google-duration - endTime: - description: Compares the wallclock time to this time. Must use UTC timezone. - format: google-datetime + monitoringStats: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies + type: array + description: >- + Stats retrieved for requested objectives. There are at most 1000 + ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats + in the response. + nextPageToken: + description: >- + The page token that can be used by the next + JobService.SearchModelDeploymentMonitoringStatsAnomalies call. type: string type: object - description: Time-based Constraint for Study - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment - type: object - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs - description: The input parameters of this TrainingJob. - description: A TrainingJob that trains and uploads an AutoML Text Sentiment Model. - GoogleCloudAiplatformV1ExactMatchInstance: - description: Spec for exact match instance. - type: object + GoogleCloudAiplatformV1Study: properties: - prediction: + name: + description: >- + Output only. The name of a study. The study's globally unique + identifier. Format: + `projects/{project}/locations/{location}/studies/{study}` type: string - description: Required. Output of the evaluated model. - reference: - description: Required. Ground truth used to compare against the prediction. + readOnly: true + inactiveReason: + readOnly: true + description: >- + Output only. A human readable reason why the Study is inactive. This + should be empty if a study is ACTIVE or COMPLETED. type: string - id: GoogleCloudAiplatformV1ExactMatchInstance - GoogleCloudAiplatformV1CreatePipelineJobRequest: + state: + description: Output only. The detailed state of a Study. + enumDescriptions: + - The study state is unspecified. + - The study is active. + - The study is stopped due to an internal error. + - >- + The study is done when the service exhausts the parameter search + space or max_trial_count is reached. + readOnly: true + type: string + enum: + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + - COMPLETED + studySpec: + description: Required. Configuration of the Study. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + displayName: + type: string + description: Required. Describes the Study, default value is empty string. + createTime: + readOnly: true + description: Output only. Time at which the study was created. + type: string + format: google-datetime + description: A message representing a Study. + id: GoogleCloudAiplatformV1Study type: object - description: Request message for PipelineService.CreatePipelineJob. + GoogleCloudAiplatformV1ResumeScheduleRequest: + type: object + description: Request message for ScheduleService.ResumeSchedule. properties: - parent: + catchUp: description: >- - Required. The resource name of the Location to create the - PipelineJob in. Format: `projects/{project}/locations/{location}` - type: string - pipelineJobId: - type: string + Optional. Whether to backfill missed runs when the schedule is + resumed from PAUSED state. If set to true, all missed runs will be + scheduled. New runs will be scheduled after the backfill is + complete. This will also update Schedule.catch_up field. Default to + false. + type: boolean + id: GoogleCloudAiplatformV1ResumeScheduleRequest + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec: + properties: + version: + type: integer + format: int32 + description: Optional. Which version to use for evaluation. + useReference: + type: boolean description: >- - 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-/`. - pipelineJob: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' - description: Required. The PipelineJob to create. - id: GoogleCloudAiplatformV1CreatePipelineJobRequest - GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse: + Optional. Whether to use instance.reference to compute question + answering correctness. + description: Spec for question answering correctness metric. type: object + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec + GoogleCloudAiplatformV1PairwiseSummarizationQualityResult: properties: - nextPageToken: + pairwiseChoice: type: string - 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. - deploymentResourcePools: - description: The DeploymentResourcePools from the specified location. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' - type: array - description: Response message for ListDeploymentResourcePools method. - id: GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse - GoogleCloudAiplatformV1Neighbor: - properties: - neighborId: + enum: + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE + description: Output only. Pairwise summarization prediction choice. + enumDescriptions: + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined + readOnly: true + confidence: + format: float + description: Output only. Confidence for summarization quality score. readOnly: true - description: Output only. The neighbor id. - type: string - neighborDistance: - format: double - description: Output only. The neighbor distance. type: number + explanation: + type: string readOnly: true - id: GoogleCloudAiplatformV1Neighbor - description: Neighbors for example-based explanations. + description: Output only. Explanation for summarization quality score. + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityResult + description: Spec for pairwise summarization quality result. type: object - GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata: - description: Details of operations that perform update PersistentResource. - id: GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput: + description: Input for question answering helpfulness metric. + properties: + metricSpec: + description: Required. Spec for question answering helpfulness score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance + description: Required. Question answering helpfulness instance. type: object + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput + GoogleCloudAiplatformV1TFRecordDestination: + description: The storage details for TFRecord output content. properties: - progressMessage: - description: Progress Message for Update LRO - type: string - genericMetadata: - description: Operation metadata for PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1BlurBaselineConfig: + gcsDestination: + description: Required. Google Cloud Storage location. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + id: GoogleCloudAiplatformV1TFRecordDestination type: object - id: GoogleCloudAiplatformV1BlurBaselineConfig - description: >- - Config for blur baseline. When enabled, a linear path from the maximally - blurred image to the input image is created. Using a blurred baseline - instead of zero (black image) is motivated by the BlurIG approach - explained here: https://arxiv.org/abs/2004.03383 - properties: - maxBlurSigma: - format: float - description: >- - The standard deviation of the blur kernel for the blurred baseline. - The same blurring parameter is used for both the height and the - width dimension. If not set, the method defaults to the zero (i.e. - black for images) baseline. - type: number - GoogleCloudAiplatformV1DeleteFeatureValuesResponse: - description: Response message for FeaturestoreService.DeleteFeatureValues. + GoogleCloudAiplatformV1UpdateExplanationDatasetResponse: + id: GoogleCloudAiplatformV1UpdateExplanationDatasetResponse + type: object + description: Response message of ModelService.UpdateExplanationDataset operation. + properties: {} + GoogleCloudAiplatformV1ExamplesOverride: + description: Overrides for example-based explanations. + id: GoogleCloudAiplatformV1ExamplesOverride type: object properties: - selectTimeRangeAndFeature: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature - description: Response for request specifying time range and feature - selectEntity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity - description: Response for request specifying the entities to delete - id: GoogleCloudAiplatformV1DeleteFeatureValuesResponse - GoogleCloudAiplatformV1StudySpec: - description: Represents specification of a Study. - properties: - parameters: - description: Required. The set of parameters to tune. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' - type: array - measurementSelectionType: - enum: - - MEASUREMENT_SELECTION_TYPE_UNSPECIFIED - - LAST_MEASUREMENT - - BEST_MEASUREMENT - type: string - enumDescriptions: - - Will be treated as LAST_MEASUREMENT. - - Use the last measurement reported. - - Use the best measurement reported. - description: Describe which measurement selection type will be used - medianAutomatedStoppingSpec: - description: The automated early stopping spec using median rule. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec - algorithm: - enum: - - ALGORITHM_UNSPECIFIED - - GRID_SEARCH - - RANDOM_SEARCH - enumDescriptions: - - >- - The default algorithm used by Vertex AI for [hyperparameter - tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview) - and [Vertex AI - Vizier](https://cloud.google.com/vertex-ai/docs/vizier). - - >- - Simple grid search within the feasible space. To use grid search, - all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`. - - Simple random search within the feasible space. - description: The search algorithm specified for the Study. - type: string - decayCurveStoppingSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec - description: The automated early stopping spec using decay curve rule. - observationNoise: + neighborCount: + type: integer + description: The number of neighbors to return. + format: int32 + dataFormat: enumDescriptions: - - The default noise level chosen by Vertex AI. - - >- - Vertex AI assumes that the objective function is (nearly) - perfectly reproducible, and will never repeat the same Trial - parameters. - - >- - Vertex AI will estimate the amount of noise in metric evaluations, - it may repeat the same Trial parameters more than once. + - Unspecified format. Must not be used. + - Provided data is a set of model inputs. + - Provided data is a set of embeddings. enum: - - OBSERVATION_NOISE_UNSPECIFIED - - LOW - - HIGH + - DATA_FORMAT_UNSPECIFIED + - INSTANCES + - EMBEDDINGS + description: The format of the data being provided with each call. type: string - description: >- - The observation noise level of the study. Currently only supported - by the Vertex AI Vizier service. Not supported by - HyperparameterTuningJob or TrainingPipeline. - convexAutomatedStoppingSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec - description: The automated early stopping spec using convex stopping rule. - metrics: + returnEmbeddings: + description: If true, return the embeddings instead of neighbors. + type: boolean + restrictions: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpec' - type: array - description: Required. Metric specs for the Study. - studyStoppingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExamplesRestrictionsNamespace description: >- - Conditions for automated stopping of a Study. Enable automated - stopping by configuring at least one condition. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecStudyStoppingConfig - id: GoogleCloudAiplatformV1StudySpec - type: object - GoogleCloudAiplatformV1EvaluateInstancesRequest: + Restrict the resulting nearest neighbors to respect these + constraints. + type: array + crowdingCount: + format: int32 + type: integer + description: The number of neighbors to return that have the same crowding tag. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata: type: object - description: Request message for EvaluationService.EvaluateInstances. - id: GoogleCloudAiplatformV1EvaluateInstancesRequest + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata properties: - pairwiseQuestionAnsweringQualityInput: - description: Input for pairwise question answering quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput - exactMatchInput: - description: >- - Auto metric instances. Instances and metric spec for exact match - metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInput' - toolNameMatchInput: - description: Input for tool name match metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInput' - summarizationVerbosityInput: - description: Input for summarization verbosity metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInput - coherenceInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInput' - description: Input for coherence metric. - questionAnsweringQualityInput: - description: Input for question answering quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInput - groundednessInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInput' - description: Input for groundedness metric. - bleuInput: - description: Instances and metric spec for bleu metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInput' - summarizationHelpfulnessInput: - description: Input for summarization helpfulness metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInput - questionAnsweringRelevanceInput: - description: Input for question answering relevance metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput - fulfillmentInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInput' - description: Input for fulfillment metric. - pointwiseMetricInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInput' - description: Input for pointwise metric. - questionAnsweringCorrectnessInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput - description: Input for question answering correctness metric. - toolParameterKvMatchInput: - description: Input for tool parameter key value match metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInput - pairwiseSummarizationQualityInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInput - description: Input for pairwise summarization quality metric. - pairwiseMetricInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInput' - description: Input for pairwise metric. - questionAnsweringHelpfulnessInput: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput - description: Input for question answering helpfulness metric. - fluencyInput: + evaluatedDataItemsBigqueryUri: + description: BigQuery destination uri for exported evaluated examples. + type: string + trainCostMilliNodeHours: + type: string description: >- - LLM-based metric instance. General text generation metrics, - applicable to other categories. Input for fluency metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInput' - summarizationQualityInput: - description: Input for summarization quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInput - toolCallValidInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInput' - description: Tool call metric instances. Input for tool call valid metric. - toolParameterKeyMatchInput: - description: Input for tool parameter key match metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInput - safetyInput: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInput' - description: Input for safety metric. - rougeInput: - description: Instances and metric spec for rouge metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInput' - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec: + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + format: int64 + description: Model metadata specific to AutoML Tables. + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata: type: object + description: Runtime operation metadata with regard to Matching Engine Index. properties: - metric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + dataBytesCount: + type: string + description: The ingested data size in bytes. + format: int64 + contentValidationStats: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats description: >- - Metric specs for the NAS job. Validation for this field is done at - `multi_trial_algorithm_spec` field. - trainTrialSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec + The validation stats of the content (per file) to be inserted or + updated on the Matching Engine Index resource. Populated if + contentsDeltaUri is provided as part of Index.metadata. Please note + that, currently for those files that are broken or has unsupported + file format, we will not have the stats for those files. + id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + GoogleCloudAiplatformV1BatchPredictionJobOutputConfig: + properties: + bigqueryDestination: description: >- - Spec for train trials. Top N - [TrainTrialSpec.max_parallel_trial_count] search trials will be - trained for every M [TrainTrialSpec.frequency] trials searched. - multiTrialAlgorithm: - enumDescriptions: - - Defaults to `REINFORCEMENT_LEARNING`. - - >- - The Reinforcement Learning Algorithm for Multi-trial Neural - Architecture Search (NAS). - - >- - The Grid Search Algorithm for Multi-trial Neural Architecture - Search (NAS). + The BigQuery project or dataset location where the output is to be + written to. If project is provided, a new dataset is created with + name `prediction__` where is made BigQuery-dataset-name compatible + (for example, most special characters become underscores), and + timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. + In the dataset two tables will be created, `predictions`, and + `errors`. If the Model has both instance and prediction schemata + defined then the tables have columns as follows: The `predictions` + table contains instances for which the prediction succeeded, it has + columns as per a concatenation of the Model's instance and + prediction schemata. The `errors` table contains rows for which the + prediction has failed, it has instance columns, as per the instance + schema, followed by a single "errors" column, which as values has + google.rpc.Status represented as a STRUCT, and containing only + `code` and `message`. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + predictionsFormat: + description: >- + Required. The format in which Vertex AI gives the predictions, must + be one of the Model's supported_output_storage_formats. type: string - enum: - - MULTI_TRIAL_ALGORITHM_UNSPECIFIED - - REINFORCEMENT_LEARNING - - GRID_SEARCH + gcsDestination: description: >- - The multi-trial Neural Architecture Search (NAS) algorithm type. - Defaults to `REINFORCEMENT_LEARNING`. - searchTrialSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec - description: Required. Spec for search trials. - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec - description: The spec of multi-trial Neural Architecture Search (NAS). - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity: + The Cloud Storage location of the directory where the output is to + be written to. In the given directory a new directory is created. + Its name is `prediction--`, where timestamp is in + YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files + `predictions_0001.`, `predictions_0002.`, ..., `predictions_N.` are + created where `` depends on chosen predictions_format, and N may + equal 0001 and depends on the total number of successfully predicted + instances. If the Model has both instance and prediction schemata + defined then each such file contains predictions as per the + predictions_format. If prediction for any instance failed (partially + or completely), then an additional `errors_0001.`, + `errors_0002.`,..., `errors_N.` files are created (N depends on + total number of failed predictions). These files contain the failed + instances, as per their schema, followed by an additional `error` + field which as value has google.rpc.Status containing only `code` + and `message` fields. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + type: object + description: >- + Configures the output of BatchPredictionJob. See + Model.supported_output_storage_formats for supported output formats, and + how predictions are expressed via any of them. + id: GoogleCloudAiplatformV1BatchPredictionJobOutputConfig + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature: + description: >- + Response message if the request uses the SelectTimeRangeAndFeature + option. + type: object + id: >- + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature properties: - offlineStorageDeletedEntityRowCount: + offlineStorageModifiedEntityRowCount: format: int64 type: string description: >- - The count of deleted entity rows in the offline storage. Each row + The count of modified entity rows in the offline storage. Each row corresponds to the combination of an entity ID and a timestamp. One - entity ID can have multiple rows in the offline storage. - onlineStorageDeletedEntityCount: + entity ID can have multiple rows in the offline storage. Within each + row, only the features specified in the request are deleted. + impactedFeatureCount: description: >- - The count of deleted entities in the online storage. Each entity ID - corresponds to one entity. + The count of the features or columns impacted. This is the same as + the feature count in the request. type: string format: int64 - id: GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity - description: Response message if the request uses the SelectEntity option. - type: object - GoogleCloudAiplatformV1NasJob: - description: Represents a Neural Architecture Search (NAS) job. - id: GoogleCloudAiplatformV1NasJob - properties: - name: - description: Output only. Resource name of the NasJob. + onlineStorageModifiedEntityCount: type: string - readOnly: true - nasJobSpec: - description: Required. The specification of a NasJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobSpec' - state: - description: Output only. The detailed state of the job. + description: >- + The count of modified entities in the online storage. Each entity ID + corresponds to one entity. Within each entity, only the features + specified in the request are deleted. + format: int64 + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation: + properties: + timeFormat: type: string - readOnly: true - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - endTime: - readOnly: true description: >- - Output only. Time when the NasJob entered any of the following - states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - format: google-datetime + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + columnName: type: string - nasJobOutput: - description: Output only. Output of the NasJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobOutput' - readOnly: true - enableRestrictedImageTraining: + invalidValuesAllowed: description: >- - Optional. Enable a separation of Custom model training and - restricted image training for tenant project. + If invalid values is allowed, the training pipeline will create a + boolean feature that indicated whether the value is valid. + Otherwise, the training pipeline will discard the input row from + trainining data. type: boolean - deprecated: true - createTime: - description: Output only. Time when the NasJob was created. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the * timestamp + as a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. + GoogleCloudAiplatformV1TimeSeriesDataPoint: + type: object + properties: + step: + format: int64 + type: string + description: Step index of this data point within the run. + tensor: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTensor' + description: A tensor value. + scalar: + description: A scalar value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scalar' + blobs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlobSequence' + description: A blob sequence value. + wallTime: format: google-datetime + description: >- + Wall clock timestamp when this data point is generated by the end + user. type: string + description: A TensorboardTimeSeries data point. + id: GoogleCloudAiplatformV1TimeSeriesDataPoint + GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus: + properties: + updateTime: readOnly: true - encryptionSpec: - description: >- - Customer-managed encryption key options for a NasJob. If this is - set, then all resources created by the NasJob will be encrypted with - the provided encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + type: string + description: Output only. Update time of this status. + format: google-datetime error: - readOnly: true - description: >- - Output only. Only populated when job's state is JOB_STATE_FAILED or - JOB_STATE_CANCELLED. $ref: '#/components/schemas/GoogleRpcStatus' - satisfiesPzs: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - updateTime: - description: Output only. Time when the NasJob was most recently updated. - format: google-datetime readOnly: true - type: string - labels: - additionalProperties: - type: string - type: object description: >- - The labels with user-defined metadata to organize NasJobs. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - startTime: + Output only. The error that occurred during the state. May be set + when the state is any of the non-final state + (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is + FAILED, the error here is final and not going to be retried. If the + state is a non-final state, the error indicates a system-error being + retried. + state: + description: Output only. The state of the task. + enumDescriptions: + - Unspecified. + - Specifies pending state for the task. + - Specifies task is being executed. + - Specifies task completed successfully. + - Specifies Task cancel is in pending state. + - Specifies task is being cancelled. + - Specifies task was cancelled. + - Specifies task failed. + - Specifies task was skipped due to cache hit. + - >- + Specifies that the task was not triggered because the task's + trigger policy is not satisfied. The trigger policy is specified + in the `condition` field of PipelineJob.pipeline_spec. + type: string + readOnly: true + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - CANCEL_PENDING + - CANCELLING + - CANCELLED + - FAILED + - SKIPPED + - NOT_TRIGGERED + type: object + description: A single record of the task status. + id: GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus + GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: + properties: + genericMetadata: + description: Operation metadata for creating a MetadataStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Details of operations that perform MetadataService.CreateMetadataStore. + id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata + type: object + GoogleCloudAiplatformV1SchemaVideoDataItem: + description: Payload of Video DataItem. + id: GoogleCloudAiplatformV1SchemaVideoDataItem + properties: + mimeType: readOnly: true type: string description: >- - Output only. Time when the NasJob for the first time entered the - `JOB_STATE_RUNNING` state. - format: google-datetime - displayName: - description: >- - Required. The display name of the NasJob. The name can be up to 128 - characters long and can consist of any UTF-8 characters. + Output only. The mime type of the content of the video. Only the + videos in below listed mime types are supported. Supported + mime_type: - video/mp4 - video/avi - video/quicktime + gcsUri: type: string - satisfiesPzi: - readOnly: true - type: boolean - description: Output only. Reserved for future use. + description: >- + Required. Google Cloud Storage URI points to the original video in + user's bucket. The video is up to 50 GB in size and up to 3 hour in + duration. type: object - GoogleCloudAiplatformV1StructFieldValue: + GoogleCloudAiplatformV1MetadataStoreMetadataStoreState: type: object + description: Represents state information for a MetadataStore. properties: - value: - description: The value for this field. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - name: + diskUtilizationBytes: + format: int64 + description: The disk utilization of the MetadataStore in bytes. type: string - description: Name of the field in the struct feature. - id: GoogleCloudAiplatformV1StructFieldValue - description: One field of a Struct (or object) type feature value. - GoogleCloudAiplatformV1CancelNasJobRequest: - properties: {} + id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics: + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics type: object - description: Request message for JobService.CancelNasJob. - id: GoogleCloudAiplatformV1CancelNasJobRequest - GoogleCloudAiplatformV1ThresholdConfig: - id: GoogleCloudAiplatformV1ThresholdConfig + description: >- + UNIMPLEMENTED. Track matching model metrics for a single track match + threshold and multiple label match confidence thresholds. properties: - value: + meanTrackingAveragePrecision: + description: The mean average precision over all confidence thresholds. + format: float + type: number + iouThreshold: + format: float type: number - format: double description: >- - Specify a threshold value that can trigger the alert. If this - threshold config is for feature distribution distance: 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. Each feature - must have a non-zero threshold if they need to be monitored. - Otherwise no alert will be triggered for that feature. - type: object - description: The config for feature monitoring threshold. - GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult - description: Prediction output format for Video Action Recognition. - type: object + The intersection-over-union threshold value between bounding boxes + across frames used to compute this metric entry. + meanMismatchRate: + format: float + description: The mean mismatch rate over all confidence thresholds. + type: number + confidenceMetrics: + description: >- + Metrics for each label-match `confidenceThreshold` from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics + meanBoundingBoxIou: + format: float + type: number + description: The mean bounding box iou over all confidence thresholds. + GoogleCloudAiplatformV1AssignNotebookRuntimeRequest: + id: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest properties: - displayName: - description: The display name of the AnnotationSpec that had been identified. - type: string - id: - type: string - description: The resource ID of the AnnotationSpec that had been identified. - timeSegmentStart: - format: google-duration + notebookRuntime: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' description: >- - The beginning, inclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. - type: string - timeSegmentEnd: - format: google-duration + Required. Provide runtime specific information (e.g. runtime owner, + notebook id) used for NotebookRuntime assignment. + notebookRuntimeTemplate: description: >- - The end, exclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. + Required. The resource name of the NotebookRuntimeTemplate based on + which a NotebookRuntime will be assigned (reuse or create a new + one). type: string - confidence: - format: float - description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. + notebookRuntimeId: + type: string + description: Optional. User specified ID for the notebook runtime. + description: Request message for NotebookService.AssignNotebookRuntime. + type: object + GoogleCloudAiplatformV1Scalar: + type: object + description: One point viewable on a scalar metric plot. + properties: + value: type: number - GoogleCloudAiplatformV1MutateDeployedIndexResponse: + format: double + description: Value of the point at this step / timestamp. + id: GoogleCloudAiplatformV1Scalar + GoogleCloudAiplatformV1FeatureOnlineStoreOptimized: + properties: {} + description: Optimized storage type + type: object + id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized + GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata: + id: GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata properties: - deployedIndex: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - description: The DeployedIndex that had been updated in the IndexEndpoint. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for PersistentResource. + progressMessage: + type: string + description: Progress Message for Reboot LRO type: object - id: GoogleCloudAiplatformV1MutateDeployedIndexResponse - description: Response message for IndexEndpointService.MutateDeployedIndex. - GoogleCloudAiplatformV1CompletionStats: - description: >- - Success and error statistics of processing multiple entities (for - example, DataItems or structured data rows) in batch. + description: Details of operations that perform reboot PersistentResource. + GoogleCloudAiplatformV1SafetyResult: + id: GoogleCloudAiplatformV1SafetyResult + description: Spec for safety result. type: object - id: GoogleCloudAiplatformV1CompletionStats properties: - failedCount: - description: >- - Output only. The number of entities for which any error was - encountered. - readOnly: true - format: int64 - type: string - successfulCount: + explanation: + description: Output only. Explanation for safety score. readOnly: true - format: int64 - description: >- - Output only. The number of entities that had been processed - successfully. - type: string - successfulForecastPointCount: type: string - description: >- - Output only. The number of the successful forecast points that are - generated by the forecasting model. This is ONLY used by the - forecasting batch prediction. + score: + format: float + description: Output only. Safety score. readOnly: true - format: int64 - incompleteCount: - format: int64 + type: number + confidence: readOnly: true - type: string - description: >- - Output only. In cases when enough errors are encountered a job, - pipeline, or operation may be failed as a whole. Below is the number - of entities for which the processing had not been finished (either - in successful or failed state). Set to -1 if the number is unknown - (for example, the operation failed before the total entity number - could be collected). - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis: - id: >- - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis - type: object + format: float + type: number + description: Output only. Confidence for safety score. + GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse: description: >- - Configuration of the Featurestore's ImportFeature Analysis Based - Monitoring. This type of analysis generates statistics for values of - each Feature imported by every ImportFeatureValues operation. - properties: - state: - type: string - description: >- - Whether to enable / disable / inherite default hebavior for import - features analysis. - enum: - - STATE_UNSPECIFIED - - DEFAULT - - ENABLED - - DISABLED - enumDescriptions: - - Should not be used. - - >- - The default behavior of whether to enable the monitoring. - EntityType-level config: disabled. Feature-level config: inherited - from the configuration of EntityType this Feature belongs to. - - >- - Explicitly enables import features analysis. EntityType-level - config: by default enables import features analysis for all - Features under it. Feature-level config: enables import features - analysis regardless of the EntityType-level config. - - >- - Explicitly disables import features analysis. EntityType-level - config: by default disables import features analysis for all - Features under it. Feature-level config: disables import features - analysis regardless of the EntityType-level config. - anomalyDetectionBaseline: - enum: - - BASELINE_UNSPECIFIED - - LATEST_STATS - - MOST_RECENT_SNAPSHOT_STATS - - PREVIOUS_IMPORT_FEATURES_STATS - type: string - enumDescriptions: - - Should not be used. - - >- - Choose the later one statistics generated by either most recent - snapshot analysis or previous import features analysis. If non of - them exists, skip anomaly detection and only generate a - statistics. - - >- - Use the statistics generated by the most recent snapshot analysis - if exists. - - >- - Use the statistics generated by the previous import features - analysis if exists. - description: >- - The baseline used to do anomaly detection for the statistics - generated by import features analysis. - GoogleCloudAiplatformV1FluencyInstance: - id: GoogleCloudAiplatformV1FluencyInstance - properties: - prediction: - type: string - description: Required. Output of the evaluated model. - description: Spec for fluency instance. + Response message for + FeatureOnlineStoreAdminService.ListFeatureOnlineStores. + id: GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse type: object - GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest: - id: GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest properties: - parent: - type: string + nextPageToken: description: >- - Required. The resource name of the TensorboardRun to create the - TensorboardTimeSeries in. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - tensorboardTimeSeriesId: + A token, which can be sent as + ListFeatureOnlineStoresRequest.page_token to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - description: >- - 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}" - tensorboardTimeSeries: - description: Required. The TensorboardTimeSeries to create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + featureOnlineStores: + type: array + description: The FeatureOnlineStores matching the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata: type: object - description: Request message for TensorboardService.CreateTensorboardTimeSeries. - GoogleCloudAiplatformV1FeatureOnlineStoreBigtable: + id: GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata properties: - autoScaling: - description: Required. Autoscaling config applied to Bigtable Instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore delete Features values. + description: Details of operations that delete Feature values. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs: type: object - id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable - GoogleCloudAiplatformV1NotebookRuntimeTemplate: - id: GoogleCloudAiplatformV1NotebookRuntimeTemplate properties: - description: - description: The description of the NotebookRuntimeTemplate. - type: string - labels: - additionalProperties: - type: string - type: object - description: >- - The labels with user-defined metadata to organize the - NotebookRuntimeTemplates. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - updateTime: - type: string - format: google-datetime + dataGranularity: + description: Expected difference in time granularity between rows in the data. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + enableProbabilisticInference: + type: boolean description: >- - Output only. Timestamp when this NotebookRuntimeTemplate was most - recently updated. - readOnly: true - serviceAccount: + If probabilistic inference is enabled, the model will fit a + distribution that captures the uncertainty of a prediction. At + inference time, the predictive distribution is used to make a point + prediction that minimizes the optimization objective. For example, + the mean of a predictive distribution is the point prediction that + minimizes RMSE loss. If quantiles are specified, then the quantiles + of the distribution are also returned. The optimization objective + cannot be minimize-quantile-loss. + forecastHorizon: description: >- - The service account that the runtime workload runs as. You can use - any service account within the same project, but you must have the - service account user permission to use the instance. If not - specified, the [Compute Engine default service - account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) - is used. + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. type: string - createTime: + format: int64 + windowConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + description: Config containing strategy for generating sliding windows. + holidayRegions: + items: + type: string + type: array + description: >- + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. + timeSeriesIdentifierColumn: type: string + description: The name of the column that identifies the time series. + optimizationObjective: description: >- - Output only. Timestamp when this NotebookRuntimeTemplate was - created. - readOnly: true - format: google-datetime - notebookRuntimeType: - description: Optional. Immutable. The type of the notebook runtime template. - enum: - - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED - - USER_DEFINED - - ONE_CLICK - enumDescriptions: - - >- - Unspecified notebook runtime type, NotebookRuntimeType will - default to USER_DEFINED. - - runtime or template with coustomized configurations from user. - - runtime or template with system defined configurations. + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. type: string - name: + timeColumn: type: string - description: The resource name of the NotebookRuntimeTemplate. - networkSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' - description: Optional. Network spec. - idleShutdownConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig description: >- - The idle shutdown configuration of NotebookRuntimeTemplate. This - config will only be set when idle shutdown is enabled. - isDefault: - type: boolean - description: Output only. The default template to use if not specified. - readOnly: true - displayName: - type: string + The name of the column that identifies time order in the time + series. This column must be available at forecast. + transformations: description: >- - Required. The display name of the NotebookRuntimeTemplate. The name - can be up to 128 characters long and can consist of any UTF-8 - characters. - machineSpec: + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation + type: array + contextWindow: + format: int64 description: >- - Optional. Immutable. The specification of a single machine for the - template. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - etag: + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. type: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - encryptionSpec: - description: Customer-managed encryption key spec for the notebook runtime. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - shieldedVmConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' - description: Optional. Immutable. Runtime Shielded VM spec. - networkTags: - type: array + availableAtForecastColumns: items: type: string + type: array description: >- - Optional. The Compute Engine tags to add to runtime (see [Tagging - instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). - eucConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' - description: EUC configuration of the NotebookRuntimeTemplate. - dataPersistentDiskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. + timeSeriesAttributeColumns: description: >- - Optional. The specification of persistent disk attached to the - runtime as data disk storage. - description: >- - A template that specifies runtime configurations such as machine type, - runtime version, network configurations, etc. Multiple runtimes can be - created from a runtime template. - type: object - GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling: - type: object - properties: - maxNodeCount: - type: integer - format: int32 + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. + type: array + items: + type: string + trainBudgetMilliNodeHours: + format: int64 description: >- - Required. The maximum number of nodes to scale up to. Must be - greater than or equal to min_node_count, and less than or equal to - 10 times of 'min_node_count'. - cpuUtilizationTarget: - type: integer - format: int32 + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. + type: string + targetColumn: description: >- - Optional. A percentage of the cluster's CPU capacity. Can be from - 10% to 80%. When a cluster's CPU utilization exceeds the target that - you have set, Bigtable immediately adds nodes to the cluster. When - CPU utilization is substantially lower than the target, Bigtable - removes nodes. If not set will default to 50%. - minNodeCount: + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + type: string + unavailableAtForecastColumns: + items: + type: string + type: array description: >- - Required. The minimum number of nodes to scale down to. Must be - greater than or equal to 1. - type: integer - format: int32 - id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling - GoogleCloudAiplatformV1Presets: - type: object - properties: - modality: + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. + hierarchyConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig description: >- - The modality of the uploaded model, which automatically configures - the distance measurement and feature normalization for the - underlying example index and queries. If your model does not - precisely fit one of these types, it is okay to choose the closest - type. - enumDescriptions: - - Should not be set. Added as a recommended best practice for enums - - IMAGE modality - - TEXT modality - - TABULAR modality - enum: - - MODALITY_UNSPECIFIED - - IMAGE - - TEXT - - TABULAR - type: string - query: - enum: - - PRECISE - - FAST + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + weightColumn: type: string - enumDescriptions: - - More precise neighbors as a trade-off against slower response. - - Faster response as a trade-off against less precise neighbors. description: >- - Preset option controlling parameters for speed-precision trade-off - when querying for examples. If omitted, defaults to `PRECISE`. - id: GoogleCloudAiplatformV1Presets - description: Preset configuration for example-based explanations - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig: - properties: - attributionScoreDriftThresholds: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. + exportEvaluatedDataItemsConfig: description: >- - Key is the feature name and value is the threshold. The threshold - here is against attribution score distance between different time - windows. - type: object - defaultDriftThreshold: + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + validationOptions: description: >- - Drift anomaly detection threshold used by all features. When the - per-feature thresholds are not set, this field can be used to - specify a threshold for all features. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - driftThresholds: + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + type: string + additionalExperiments: + items: + type: string + description: Additional experiment flags for the time series forcasting training. + type: array + quantiles: + type: array + items: + type: number + format: double description: >- - Key is the feature name and value is the threshold. If a feature - needs to be monitored for drift, a value threshold must be - configured for that feature. The threshold here is against feature - distribution distance between different time windws. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - type: object - type: object - description: The config for Prediction data drift detection. + Quantiles to use for minimize-quantile-loss + `optimization_objective`, or for probabilistic inference. Up to 5 + quantiles are allowed of values between 0 and 1, exclusive. Required + if the value of optimization_objective is minimize-quantile-loss. + Represents the percent quantiles to use for that objective. + Quantiles must be unique. id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation: - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs + GoogleCloudAiplatformV1LookupStudyRequest: properties: - columnName: - type: string - timeFormat: - description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + displayName: + description: Required. The user-defined display name of the Study type: string type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation - GoogleCloudAiplatformV1Endpoint: - description: >- - Models are deployed into it, and afterwards Endpoint is called to obtain - predictions and explanations. + id: GoogleCloudAiplatformV1LookupStudyRequest + description: Request message for VizierService.LookupStudy. + GoogleCloudAiplatformV1FunctionResponse: properties: name: - readOnly: true - type: string - description: Output only. The resource name of the Endpoint. - createTime: - description: Output only. Timestamp when this Endpoint was created. - readOnly: true type: string - format: google-datetime - displayName: description: >- - Required. The display name of the Endpoint. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - type: string - modelDeploymentMonitoringJob: + Required. The name of the function to call. Matches + [FunctionDeclaration.name] and [FunctionCall.name]. + response: + additionalProperties: + description: Properties of the object. + type: any description: >- - Output only. Resource name of the Model Monitoring job associated - with this Endpoint if monitoring is enabled by - JobService.CreateModelDeploymentMonitoringJob. Format: - `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - type: string - readOnly: true - updateTime: - description: Output only. Timestamp when this Endpoint was last updated. - readOnly: true - format: google-datetime - type: string - predictRequestResponseLoggingConfig: - description: Configures the request-response logging for online prediction. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean - readOnly: true - deployedModels: + Required. The function response in JSON object format. Use "output" + key to specify function output and "error" key to specify error + details (if any). If "output" and "error" keys are not specified, + then whole "response" is treated as function output. + type: object + type: object + 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 + GoogleIamV1Binding: + description: Associates `members`, or principals, with a `role`. + id: GoogleIamV1Binding + properties: + members: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - readOnly: true - description: >- - Output only. The models deployed in this Endpoint. To add or remove - DeployedModels use EndpointService.DeployModel and - EndpointService.UndeployModel respectively. - enablePrivateServiceConnect: - type: boolean - deprecated: true - description: >- - Deprecated: If true, expose the Endpoint via private service - connect. Only one of the fields, network or - enable_private_service_connect, can be set. - dedicatedEndpointEnabled: - description: >- - If true, the endpoint will be exposed through a dedicated DNS - [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS - will be isolated from other users' traffic and will have better - performance and reliability. Note: Once you enabled dedicated - endpoint, you won't be able to send request to the shared DNS - {region}-aiplatform.googleapis.com. The limitation will be removed - soon. - type: boolean - trafficSplit: - description: >- - A map from a DeployedModel's ID to the percentage of this Endpoint's - traffic that should be forwarded to that DeployedModel. If a - DeployedModel's ID is not listed in this map, then it receives no - traffic. The traffic percentage values must add up to 100, or map - must be empty if the Endpoint is to not accept any traffic at a - moment. - type: object - additionalProperties: - format: int32 - type: integer - etag: - type: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - satisfiesPzs: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - privateServiceConnectConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + type: string description: >- - Optional. Configuration for private service connect. network and - private_service_connect_config are mutually exclusive. - dedicatedEndpointDns: + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + role: type: string - readOnly: true description: >- - Output only. DNS of the dedicated endpoint. Will only be populated - if dedicated_endpoint_enabled is true. Format: - `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + condition: description: >- - Customer-managed encryption key spec for an Endpoint. If set, this - Endpoint and all sub-resources of this Endpoint will be secured by - this key. - network: + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + type: object + GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec: + id: GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + type: object + properties: + sourceField: description: >- - Optional. The full name of the Google Compute Engine - [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) - to which the Endpoint should be peered. Private services access must - already be configured for the network. If left unspecified, the - Endpoint is not peered with any network. Only one of the fields, - network or enable_private_service_connect, can be set. - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where `{project}` is - a project number, as in `12345`, and `{network}` is network name. + Source column to get the Feature values from. If not set, uses the + column with the same name as the Feature ID. type: string - description: - description: The description of the Endpoint. + id: type: string - labels: - type: object description: >- - The labels with user-defined metadata to organize your Endpoints. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - additionalProperties: - type: string + Required. ID of the Feature to import values of. This Feature must + exist in the target EntityType, or the request will fail. + description: Defines the Feature value(s) to import. + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline: type: object - id: GoogleCloudAiplatformV1Endpoint - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata: properties: - costMilliNodeHours: - type: string - description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. - format: int64 - successfulStopReason: + gcs: + description: Cloud Storage location for BatchExplain output. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + bigquery: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + description: BigQuery location for BatchExplain output. + predictionFormat: enumDescriptions: - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - - >- - Further training of the Model ceased to increase its quality, - since it already has converged. - description: >- - For successful job completions, this is the reason why the job has - finished. - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED + - Predictions are in JSONL files. + - Predictions are in BigQuery. type: string - type: object + description: The storage format of the predictions generated BatchPrediction job. + enum: + - PREDICTION_FORMAT_UNSPECIFIED + - JSONL + - BIGQUERY id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata - GoogleCloudAiplatformV1DeployedModelRef: - description: Points to a DeployedModel. - id: GoogleCloudAiplatformV1DeployedModelRef - properties: - endpoint: - description: Immutable. A resource name of an Endpoint. - type: string - deployedModelId: - type: string - description: Immutable. An ID of a DeployedModel in the above Endpoint. + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline + description: >- + Output from BatchPredictionJob for Model Monitoring baseline dataset, + which can be used to generate baseline attribution scores. + GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse: + description: Response message for ModelService.ListModelEvaluationSlices. + id: GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse type: object - GoogleCloudAiplatformV1PipelineTaskDetailArtifactList: - id: GoogleCloudAiplatformV1PipelineTaskDetailArtifactList properties: - artifacts: - type: array - description: Output only. A list of artifact metadata. + modelEvaluationSlices: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - readOnly: true - type: object - description: A list of artifact metadata. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + description: List of ModelEvaluations in the requested page. + type: array + nextPageToken: + type: string + description: >- + A token to retrieve next page of results. Pass to + ListModelEvaluationSlicesRequest.page_token to obtain that page. + GoogleCloudAiplatformV1BleuSpec: + description: >- + Spec for bleu score metric - calculates the precision of n-grams in the + prediction as compared to reference - returns a score ranging between 0 + to 1. + id: GoogleCloudAiplatformV1BleuSpec type: object properties: - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation - GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation: - type: object - id: GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation + useEffectiveOrder: + type: boolean + description: Optional. Whether to use_effective_order to compute bleu score. + GoogleCloudAiplatformV1GroundingChunkWeb: properties: - annotationSpecId: - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. + uri: + description: URI reference of the chunk. type: string - displayName: + title: type: string - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - timeSegment: - description: >- - This Annotation applies to the time period represented by the - TimeSegment. If it's not set, the Annotation applies to the whole - video. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' - description: Annotation details specific to video action recognition. - GoogleCloudAiplatformV1UnmanagedContainerModel: - description: >- - Contains model information necessary to perform batch prediction without - requiring a full model import. + description: Title of the chunk. + id: GoogleCloudAiplatformV1GroundingChunkWeb + type: object + description: Chunk from the web. + GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest: + description: Request message for NotebookService.UpgradeNotebookRuntime. + id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + type: object + properties: {} + GoogleCloudAiplatformV1CancelTrainingPipelineRequest: + properties: {} + description: Request message for PipelineService.CancelTrainingPipeline. + id: GoogleCloudAiplatformV1CancelTrainingPipelineRequest + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics: type: object properties: - artifactUri: - type: string - description: >- - The path to the directory containing the Model artifact and any of - its supporting files. - predictSchemata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - description: Contains the schemata used in Model's predictions and explanations - containerSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' - description: >- - Input only. The specification of the container that is to be used - when deploying this Model. - id: GoogleCloudAiplatformV1UnmanagedContainerModel - GoogleCloudAiplatformV1GenerateContentRequest: - properties: - labels: - 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. - additionalProperties: - type: string - type: object - systemInstruction: + boundingBoxMeanAveragePrecision: + type: number + format: float description: >- - Optional. The user provided system instructions for the model. Note: - only text should be used in parts and content in each part will be - in a separate paragraph. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - generationConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' - description: Optional. Generation config. - contents: + The single metric for bounding boxes evaluation: the + `meanAveragePrecision` averaged over all + `boundingBoxMetricsEntries`. + boundingBoxMetrics: description: >- - Required. The content of the current conversation with the model. - For single-turn queries, this is a single instance. For multi-turn - queries, this is a repeated field that contains conversation history - + latest request. + The bounding boxes match metrics for each intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - tools: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics + evaluatedBoundingBoxCount: + type: integer + format: int32 description: >- - Optional. A list of `Tools` the model may use to generate the next - response. A `Tool` is a piece of code that enables the system to - interact with external systems to perform an action, or set of - actions, outside of knowledge and scope of the model. + The total number of bounding boxes (i.e. summed over all images) the + ground truth used to create this evaluation had. + description: Metrics for image object detection evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics + GoogleCloudAiplatformV1MutateDeployedModelResponse: + id: GoogleCloudAiplatformV1MutateDeployedModelResponse + description: Response message for EndpointService.MutateDeployedModel. + properties: + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: The DeployedModel that's being mutated. + type: object + GoogleIamV1Policy: + properties: + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' - toolConfig: + $ref: '#/components/schemas/GoogleIamV1Binding' + version: + type: integer description: >- - Optional. Tool config. This config is shared for all tools provided - in the request. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' - safetySettings: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + format: int32 + etag: + format: byte description: >- - Optional. Per request settings for blocking unsafe content. Enforced - on GenerateContentResponse.candidates. - type: array - description: Request message for [PredictionService.GenerateContent]. - type: object - id: GoogleCloudAiplatformV1GenerateContentRequest - GoogleCloudAiplatformV1FunctionCall: + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + type: string description: >- - A predicted [FunctionCall] returned from the model that contains a - string representing the [FunctionDeclaration.name] and a structured JSON - object containing the parameters and their values. - id: GoogleCloudAiplatformV1FunctionCall + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + id: GoogleIamV1Policy + GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource: type: object + description: The Dataform Repository containing the input notebook. properties: - args: + commitSha: + type: string description: >- - Optional. Required. The function parameters and values in JSON - object format. See [FunctionDeclaration.parameters] for parameter - details. - type: object - additionalProperties: - description: Properties of the object. - type: any - name: + The commit SHA to read repository with. If unset, the file will be + read at HEAD. + dataformRepositoryResourceName: type: string description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name]. - GoogleCloudAiplatformV1ExplainRequest: - id: GoogleCloudAiplatformV1ExplainRequest + The resource name of the Dataform Repository. Format: + `projects/{project_id}/locations/{location}/repositories/{repository_id}` + id: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment: properties: - explanationSpecOverride: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpecOverride' - description: >- - If specified, overrides the explanation_spec of the DeployedModel. - Can be used for explaining prediction results with different - configurations, such as: - Explaining top-5 predictions results as - opposed to top-1; - Increasing path count or step count of the - attribution methods to reduce approximate errors; - Using different - baselines for explaining the prediction results. - instances: + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment + type: object + description: A TrainingJob that trains and uploads an AutoML Text Sentiment Model. + GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue: + id: GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue + properties: + score: + readOnly: true + description: Output only. Tool parameter key match score. + format: float + type: number + description: Tool parameter key match metric value for an instance. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity: + type: object + description: A duration of time expressed in time granularity units. + properties: + unit: + type: string description: >- - Required. The instances that are the input to the explanation call. - A DeployedModel may have an upper limit on the number of instances - it supports per request, and when it is exceeded the explanation - call errors in case of AutoML Models, or, in case of customer - created Models, the behaviour is as documented by that Model. The - schema of any single instance may be specified via Endpoint's - DeployedModels' Model's PredictSchemata's instance_schema_uri. - type: array - items: - type: any - parameters: + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" + quantity: description: >- - The parameters that govern the prediction. The schema of the - parameters may be specified via Endpoint's DeployedModels' Model's - PredictSchemata's parameters_schema_uri. - type: any - deployedModelId: + The number of granularity_units between data points in the training + data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. + For all other values of `granularity_unit`, must be 1. + format: int64 type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity + GoogleCloudAiplatformV1FindNeighborsResponseNeighbor: + properties: + distance: + format: double + description: The distance between the neighbor and the dense embedding query. + type: number + sparseDistance: + format: double + description: The distance between the neighbor and the query sparse_embedding. + type: number + datapoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' description: >- - If specified, this ExplainRequest will be served by the chosen - DeployedModel, overriding Endpoint.traffic_split. + The datapoint of the neighbor. Note that full datapoints are + returned only when "return_full_datapoint" is set to true. + Otherwise, only the "datapoint_id" and "crowding_tag" fields are + populated. + id: GoogleCloudAiplatformV1FindNeighborsResponseNeighbor + description: A neighbor of the query vector. type: object - description: Request message for PredictionService.Explain. - GoogleCloudAiplatformV1ListFeatureGroupsResponse: + GoogleCloudAiplatformV1NearestNeighborQueryEmbedding: + type: object + description: The embedding vector. + id: GoogleCloudAiplatformV1NearestNeighborQueryEmbedding properties: - nextPageToken: - type: string - description: >- - A token, which can be sent as ListFeatureGroupsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - featureGroups: + value: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' - description: The FeatureGroups matching the request. + format: float + type: number + description: Optional. Individual value in the embedding. type: array - description: Response message for FeatureRegistryService.ListFeatureGroups. - type: object - id: GoogleCloudAiplatformV1ListFeatureGroupsResponse - GoogleCloudAiplatformV1BatchPredictionJobInputConfig: - description: >- - Configures the input to BatchPredictionJob. See - Model.supported_input_storage_formats for Model's supported input - formats, and how instances should be expressed via any of them. - type: object - id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig + GoogleCloudAiplatformV1PipelineTaskDetail: properties: - gcsSource: - description: The Cloud Storage location for the input instances. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - instancesFormat: + executorDetail: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetail + description: Output only. The detailed execution info. + readOnly: true + inputs: + type: object + readOnly: true + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + description: Output only. The runtime input artifacts of the task. + execution: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + readOnly: true + description: Output only. The execution metadata of the task. + pipelineTaskStatus: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus description: >- - Required. The format in which instances are given, must be one of - the Model's supported_input_storage_formats. + Output only. A list of task status. This field keeps a record of + task status evolving over time. + readOnly: true + taskName: + description: >- + Output only. The user specified name of the task that is defined in + pipeline_spec. type: string - bigquerySource: + readOnly: true + error: + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - The BigQuery location of the input table. The schema of the table - should be in the format described by the given context OpenAPI - Schema, if one is provided. The table may contain additional columns - that are not described by the schema, and they will be ignored. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance: - properties: - baselinePrediction: - description: Required. Output of the baseline model. + Output only. The error that occurred during task execution. Only + populated when the task's state is FAILED or CANCELLED. + createTime: + readOnly: true + description: Output only. Task create time. type: string - instruction: + format: google-datetime + outputs: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + type: object + readOnly: true + description: Output only. The runtime output artifacts of the task. + endTime: type: string - description: Required. Question Answering prompt for LLM. - prediction: + description: Output only. Task end time. + readOnly: true + format: google-datetime + parentTaskId: + format: int64 + readOnly: true type: string - description: Required. Output of the candidate model. - reference: - description: Optional. Ground truth used to compare against the prediction. + description: >- + Output only. The id of the parent task if the task is within a + component scope. Empty if the task is at the root level. + state: + enumDescriptions: + - Unspecified. + - Specifies pending state for the task. + - Specifies task is being executed. + - Specifies task completed successfully. + - Specifies Task cancel is in pending state. + - Specifies task is being cancelled. + - Specifies task was cancelled. + - Specifies task failed. + - Specifies task was skipped due to cache hit. + - >- + Specifies that the task was not triggered because the task's + trigger policy is not satisfied. The trigger policy is specified + in the `condition` field of PipelineJob.pipeline_spec. + description: Output only. State of the task. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - CANCEL_PENDING + - CANCELLING + - CANCELLED + - FAILED + - SKIPPED + - NOT_TRIGGERED type: string - context: - description: Required. Text to answer the question. + readOnly: true + startTime: + format: google-datetime + description: Output only. Task start time. + readOnly: true type: string + taskId: + format: int64 + type: string + description: Output only. The system generated ID of the task. + readOnly: true + id: GoogleCloudAiplatformV1PipelineTaskDetail type: object - description: Spec for pairwise question answering quality instance. - id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance - GoogleCloudAiplatformV1EncryptionSpec: + description: The runtime detail of a task execution. + GoogleCloudAiplatformV1NasTrial: + id: GoogleCloudAiplatformV1NasTrial type: object - id: GoogleCloudAiplatformV1EncryptionSpec + description: Represents a uCAIP NasJob trial. properties: - kmsKeyName: + finalMeasurement: + readOnly: true + description: Output only. The final measurement containing the objective value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + id: + type: string + description: Output only. The identifier of the NasTrial assigned by the service. + readOnly: true + endTime: + readOnly: true type: string + format: google-datetime description: >- - Required. The Cloud KMS resource identifier of the customer managed - encryption key used to protect a resource. Has the form: - `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. - The key needs to be in the same region as where the compute resource - is created. - description: >- - Represents a customer-managed encryption key spec that can be applied to - a top-level resource. - GoogleCloudAiplatformV1Probe: - description: >- - Probe describes a health check to be performed against a container to - determine whether it is alive or ready to receive traffic. - id: GoogleCloudAiplatformV1Probe - type: object + Output only. Time when the NasTrial's status changed to `SUCCEEDED` + or `INFEASIBLE`. + startTime: + readOnly: true + description: Output only. Time when the NasTrial was started. + format: google-datetime + type: string + state: + description: Output only. The detailed state of the NasTrial. + enumDescriptions: + - The NasTrial state is unspecified. + - >- + Indicates that a specific NasTrial has been requested, but it has + not yet been suggested by the service. + - Indicates that the NasTrial has been suggested. + - Indicates that the NasTrial should stop according to the service. + - Indicates that the NasTrial is completed successfully. + - >- + Indicates that the NasTrial should not be attempted again. The + service will set a NasTrial to INFEASIBLE when it's done but + missing the final_measurement. + type: string + enum: + - STATE_UNSPECIFIED + - REQUESTED + - ACTIVE + - STOPPING + - SUCCEEDED + - INFEASIBLE + readOnly: true + GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse: + type: object + id: GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse properties: - exec: - description: ExecAction probes the health of a container by executing a command. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' - periodSeconds: - format: int32 + nextPageToken: description: >- - How often (in seconds) to perform the probe. Default to 10 seconds. - Minimum value is 1. Must be less than timeout_seconds. Maps to - Kubernetes probe argument 'periodSeconds'. - type: integer - timeoutSeconds: - type: integer + A token to retrieve the next page of results. Pass to + ListHyperparameterTuningJobsRequest.page_token to obtain that page. + type: string + hyperparameterTuningJobs: description: >- - Number of seconds after which the probe times out. Defaults to 1 - second. Minimum value is 1. Must be greater or equal to - period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - format: int32 - GoogleCloudAiplatformV1GroundednessInput: + List of HyperparameterTuningJobs in the requested page. + HyperparameterTuningJob.trials of the jobs will be not be returned. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + type: array + description: Response message for JobService.ListHyperparameterTuningJobs + GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest: + type: object + id: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + description: Request message for JobService.PauseModelDeploymentMonitoringJob. + properties: {} + GoogleCloudAiplatformV1SafetySetting: + id: GoogleCloudAiplatformV1SafetySetting properties: - instance: - description: Required. Groundedness instance. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInstance' - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessSpec' - description: Required. Spec for groundedness metric. + category: + description: Required. Harm category. + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + - The harm category is civic integrity. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + - HARM_CATEGORY_CIVIC_INTEGRITY + type: string + threshold: + enum: + - HARM_BLOCK_THRESHOLD_UNSPECIFIED + - BLOCK_LOW_AND_ABOVE + - BLOCK_MEDIUM_AND_ABOVE + - BLOCK_ONLY_HIGH + - BLOCK_NONE + - 'OFF' + description: Required. The harm block threshold. + enumDescriptions: + - Unspecified harm block threshold. + - Block low threshold and above (i.e. block more). + - Block medium threshold and above. + - Block only high threshold (i.e. block less). + - Block none. + - Turn off the safety filter. + type: string + method: + 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. + description: >- + Optional. Specify if the threshold is used for probability or + severity score. If not specified, the threshold is used for + probability score. + enum: + - HARM_BLOCK_METHOD_UNSPECIFIED + - SEVERITY + - PROBABILITY + type: string + description: Safety settings. type: object - description: Input for groundedness metric. - id: GoogleCloudAiplatformV1GroundednessInput - GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec: - description: Spec for pairwise question answering quality score metric. - id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs: type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs properties: - version: - type: integer - format: int32 - description: Optional. Which version to use for evaluation. - useReference: - type: boolean + uptrainBaseModelId: + type: string description: >- - Optional. Whether to use instance.reference to compute question - answering quality. - GoogleCloudAiplatformV1FeatureView: - description: >- - FeatureView is representation of values that the FeatureOnlineStore will - serve based on its syncConfig. - properties: - name: + The ID of `base` model for upTraining. If it is specified, the new + model will be upTrained based on the `base` model for upTraining. + Otherwise, the new model will be trained from scratch. The `base` + model for upTraining must be in the same Project and Location as the + new Model to train, and have the same modelType. + modelType: + type: string + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD_HIGH_ACCURACY_1 + - CLOUD_LOW_LATENCY_1 + - CLOUD_1 + - MOBILE_TF_LOW_LATENCY_1 + - MOBILE_TF_VERSATILE_1 + - MOBILE_TF_HIGH_ACCURACY_1 + - CLOUD_STREAMING_1 + - SPINENET + - YOLO + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to have a higher latency, but should + also have a higher prediction quality than other cloud models. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to have a low latency, but may have + lower prediction quality than other cloud models. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Compared to the CLOUD_HIGH_ACCURACY_1 and + CLOUD_LOW_LATENCY_1 models above, it is expected to have higher + prediction quality and lower latency. + - >- + A model that, in addition to being available within Google Cloud + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. Expected to have + low latency, but may have lower prediction quality than other + mobile models. + - >- + A model that, in addition to being available within Google Cloud + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. Expected to have + a higher latency, but should also have a higher prediction quality + than other mobile models. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to best support predictions in + streaming with lower latency and lower prediction quality than + other cloud models. + - >- + SpineNet for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + YOLO for Model Garden training with customizable hyperparameters. + Best tailored to be used within Google Cloud, and cannot be + exported externally. + budgetMilliNodeHours: + description: >- + The training budget of creating this model, expressed in milli node + hours i.e. 1,000 value in this field means 1 node hour. The actual + metadata.costMilliNodeHours will be equal or less than this value. + If further model training ceases to provide any improvements, it + will stop without using the full budget and the + metadata.successfulStopReason will be `model-converged`. Note, + node_hour = actual_hour * number_of_nodes_involved. For modelType + `cloud`(default), the budget must be between 20,000 and 900,000 + milli node hours, inclusive. The default value is 216,000 which + represents one day in wall time, considering 9 nodes are used. For + model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, + `mobile-tf-high-accuracy-1` the training budget must be between + 1,000 and 100,000 milli node hours, inclusive. The default value is + 24,000 which represents one day in wall time on a single node that + is used. + format: int64 type: string + disableEarlyStopping: description: >- - Identifier. Name of the FeatureView. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` - bigQuerySource: + Use the entire training budget. This disables the early stopping + feature. When false the early stopping feature is enabled, which + means that AutoML Image Object Detection might stop training before + the entire training budget has been used. + type: boolean + tunableParameter: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewBigQuerySource + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + description: Trainer type for Vision TrainRequest. + GoogleCloudAiplatformV1Featurestore: + properties: + onlineStorageTtlDays: + type: integer + format: int32 description: >- - Optional. Configures how data is supposed to be extracted from a - BigQuery source to be loaded onto the FeatureOnlineStore. - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean + Optional. TTL in days for feature values that will be stored in + online serving storage. The Feature Store online storage + periodically removes obsolete feature values older than + `online_storage_ttl_days` since the feature generation time. Note + that `online_storage_ttl_days` should be less than or equal to + `offline_storage_ttl_days` for each EntityType under a featurestore. + If not set, default to 4000 days + updateTime: + description: Output only. Timestamp when this Featurestore was last updated. + format: google-datetime + type: string + readOnly: true + satisfiesPzs: readOnly: true + type: boolean + description: Output only. Reserved for future use. labels: - additionalProperties: - type: string - type: object description: >- Optional. The labels with user-defined metadata to organize your - FeatureViews. Label keys and values can be no longer than 64 + Featurestore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated - with one FeatureOnlineStore(System labels are excluded)." System - reserved label keys are prefixed with "aiplatform.googleapis.com/" - and are immutable. - vertexRagSource: - description: Optional. The Vertex RAG Source that the FeatureView is linked to. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewVertexRagSource - createTime: - format: google-datetime + with one Featurestore(System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + additionalProperties: + type: string + type: object + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Optional. Customer-managed encryption key spec for data storage. If + set, both of the online and offline data storage will be secured by + this key. + etag: type: string - description: Output only. Timestamp when this FeatureView was created. - readOnly: true - satisfiesPzs: - type: boolean + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + satisfiesPzi: description: Output only. Reserved for future use. + type: boolean readOnly: true - featureRegistrySource: - description: >- - Optional. Configures the features from a Feature Registry source - that need to be loaded onto the FeatureOnlineStore. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource - indexConfig: - description: >- - Optional. Configuration for index preparation for vector search. It - contains the required configurations to create an index from source - data, so that approximate nearest neighbor (a.k.a ANN) algorithms - search can be performed during online serving. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfig' - updateTime: - format: google-datetime + state: + enumDescriptions: + - Default value. This value is unused. + - >- + State when the featurestore configuration is not being updated and + the fields reflect the current configuration of the featurestore. + The featurestore is usable in this state. + - >- + The state of the featurestore configuration when it is being + updated. During an update, the fields reflect either the original + configuration or the updated configuration of the featurestore. + For example, `online_serving_config.fixed_node_count` can take + minutes to update. While the update is in progress, the + featurestore is in the UPDATING state, and the value of + `fixed_node_count` can be the original value or the updated value, + depending on the progress of the operation. Until the update + completes, the actual number of nodes can still be the original + value of `fixed_node_count`. The featurestore is still usable in + this state. + description: Output only. State of the featurestore. type: string - description: Output only. Timestamp when this FeatureView was last updated. readOnly: true - etag: + enum: + - STATE_UNSPECIFIED + - STABLE + - UPDATING + name: + readOnly: true description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. + Output only. Name of the Featurestore. Format: + `projects/{project}/locations/{location}/featurestores/{featurestore}` type: string - syncConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncConfig' + onlineServingConfig: description: >- - Configures when data is to be synced/updated for this FeatureView. - At the end of the sync the latest featureValues for each entityId of - this FeatureView are made ready for online serving. + Optional. Config for online storage resources. The field should not + co-exist with the field of `OnlineStoreReplicationConfig`. If both + of it and OnlineStoreReplicationConfig are unset, the feature store + will not have an online store and cannot be used for online serving. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig + createTime: + format: google-datetime + type: string + description: Output only. Timestamp when this Featurestore was created. + readOnly: true + id: GoogleCloudAiplatformV1Featurestore + description: >- + Vertex AI Feature Store provides a centralized repository for + organizing, storing, and serving ML features. The Featurestore is a + top-level container for your features and their values. type: object - id: GoogleCloudAiplatformV1FeatureView - GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport: - id: GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport + GoogleCloudAiplatformV1ExactMatchInput: + properties: + metricSpec: + description: Required. Spec for exact match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchSpec' + instances: + description: Required. Repeated exact match instances. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInstance' + type: array + description: Input for exact match metric. + id: GoogleCloudAiplatformV1ExactMatchInput type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation: + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation properties: - startTime: + timeFormat: description: >- - Excludes Feature values with feature generation timestamp before - this timestamp. If not set, retrieve oldest values kept in Feature - Store. Timestamp, if present, must not have higher than millisecond - precision. + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) type: string - format: google-datetime - endTime: - format: google-datetime + columnName: type: string - description: >- - Exports Feature values as of this timestamp. If not set, retrieve - values as of now. Timestamp, if present, must not have higher than - millisecond precision. - description: >- - Describes exporting all historical Feature values of all entities of the - EntityType between [start_time, end_time]. - GoogleCloudAiplatformV1StudySpecMetricSpec: type: object - description: Represents a metric to optimize. + GoogleCloudAiplatformV1ModelDataStats: + type: object + id: GoogleCloudAiplatformV1ModelDataStats + description: Stats of data used for train or evaluate the Model. properties: - metricId: + validationDataItemsCount: type: string description: >- - Required. The ID of the metric. Must not contain whitespaces and - must be unique amongst all MetricSpecs. - goal: - description: Required. The optimization goal of the metric. + Number of DataItems that were used for validating this Model during + training. + format: int64 + testDataItemsCount: + format: int64 + description: >- + Number of DataItems that were used for evaluating this Model. If the + Model is evaluated multiple times, this will be the number of test + DataItems used by the first evaluation. If the Model is not + evaluated, the number is 0. type: string - enum: - - GOAL_TYPE_UNSPECIFIED - - MAXIMIZE - - MINIMIZE - enumDescriptions: - - Goal Type will default to maximize. - - Maximize the goal metric. - - Minimize the goal metric. - safetyConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig + validationAnnotationsCount: + format: int64 description: >- - Used for safe search. In the case, the metric will be a safety - metric. You must provide a separate metric for objective metric. - id: GoogleCloudAiplatformV1StudySpecMetricSpec - GoogleCloudAiplatformV1UploadModelResponse: - description: Response message of ModelService.UploadModel operation. - id: GoogleCloudAiplatformV1UploadModelResponse - type: object - properties: - modelVersionId: + Number of Annotations that are used for validating this Model during + training. type: string - description: Output only. The version ID of the model that is uploaded. - readOnly: true - model: + testAnnotationsCount: description: >- - The name of the uploaded Model resource. Format: - `projects/{project}/locations/{location}/models/{model}` + Number of Annotations that are used for evaluating this Model. If + the Model is evaluated multiple times, this will be the number of + test Annotations used by the first evaluation. If the Model is not + evaluated, the number is 0. + format: int64 type: string - GoogleCloudAiplatformV1ListStudiesResponse: - properties: - nextPageToken: + trainingDataItemsCount: + format: int64 type: string - description: >- - Passes this token as the `page_token` field of the request for a - subsequent call. If this field is omitted, there are no subsequent - pages. - studies: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' - description: The studies associated with the project. - type: array - description: Response message for VizierService.ListStudies. - id: GoogleCloudAiplatformV1ListStudiesResponse + description: Number of DataItems that were used for training this Model. + trainingAnnotationsCount: + format: int64 + description: Number of Annotations that are used for training this Model. + type: string + GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult: type: object - GoogleCloudAiplatformV1RougeMetricValue: + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult + description: Spec for question answering relevance result. properties: - score: - description: Output only. Rouge score. + confidence: + description: Output only. Confidence for question answering relevance score. readOnly: true + format: float type: number + score: + readOnly: true format: float - id: GoogleCloudAiplatformV1RougeMetricValue - type: object - description: Rouge metric value for an instance. - CloudAiLargeModelsVisionMedia: - properties: - video: - $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' - description: Video - image: - $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' - description: Image. - id: CloudAiLargeModelsVisionMedia - type: object - description: Media. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics: - type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics - properties: - exactMatch: type: number - description: >- - The rate at which the input predicted strings exactly match their - references. - format: float - GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem: - type: object - description: >- - Attributed items for a given annotation, typically representing - neighbors from the training sets constrained by the query type. - id: GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem - properties: - annotationResourceName: - description: >- - The unique ID for each annotation. Used by FE to allocate the - annotation in DB. + description: Output only. Question Answering Relevance score. + explanation: type: string - distance: - description: The distance of this item to the annotation. - type: number - format: double - GoogleCloudAiplatformV1ReadIndexDatapointsRequest: - description: The request message for MatchService.ReadIndexDatapoints. - id: GoogleCloudAiplatformV1ReadIndexDatapointsRequest + readOnly: true + description: Output only. Explanation for question answering relevance score. + GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: + description: Content filter results for a prompt sent in the request. properties: - ids: - type: array - description: IDs of the datapoints to be searched for. - items: - type: string - deployedIndexId: - description: The ID of the DeployedIndex that will serve the request. + blockReasonMessage: + description: Output only. A readable block reason message. type: string - type: object - GoogleCloudAiplatformV1BatchMigrateResourcesResponse: - type: object - id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse - properties: - migrateResourceResponses: - description: Successfully migrated resources. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse - type: array - description: Response message for MigrationService.BatchMigrateResources. - GoogleCloudAiplatformV1BatchCreateFeaturesRequest: - description: Request message for FeaturestoreService.BatchCreateFeatures. - type: object - id: GoogleCloudAiplatformV1BatchCreateFeaturesRequest - properties: - requests: - description: >- - Required. The request message specifying the Features to create. All - Features must be created under the same parent EntityType. The - `parent` field in each child request message can be omitted. If - `parent` is set in a child request, then the value must match the - `parent` value in this request message. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CreateFeatureRequest' - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition: - type: object - description: Represents the spec to match discrete values from parent parameter. - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition - properties: - values: - description: >- - Required. Matches values of the parent parameter of 'DISCRETE' type. - All values must exist in `discrete_value_spec` of parent parameter. - The Epsilon of the value matching is 1e-10. - items: - format: double - type: number - type: array - GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata: - description: Describes metadata for a TensorboardTimeSeries. - properties: - maxStep: - format: int64 - description: >- - Output only. Max step index of all data points within a - TensorboardTimeSeries. readOnly: true - type: string - maxBlobSequenceLength: - type: string + safetyRatings: readOnly: true - format: int64 - description: >- - Output only. The largest blob sequence length (number of blobs) of - all data points in this time series, if its ValueType is - BLOB_SEQUENCE. - maxWallTime: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' + type: array + description: Output only. Safety ratings. + blockReason: + enumDescriptions: + - Unspecified blocked reason. + - Candidates blocked due to safety. + - Candidates blocked due to other reason. + - >- + Candidates blocked due to the terms which are included from the + terminology blocklist. + - Candidates blocked due to prohibited content. + description: Output only. Blocked reason. + enum: + - BLOCKED_REASON_UNSPECIFIED + - SAFETY + - OTHER + - BLOCKLIST + - PROHIBITED_CONTENT type: string - format: google-datetime - description: >- - Output only. Max wall clock timestamp of all data points within a - TensorboardTimeSeries. readOnly: true - id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata type: object - GoogleCloudAiplatformV1Study: - id: GoogleCloudAiplatformV1Study + id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + GoogleCloudAiplatformV1SuggestTrialsResponse: + id: GoogleCloudAiplatformV1SuggestTrialsResponse type: object properties: - createTime: - type: string - readOnly: true - description: Output only. Time at which the study was created. - format: google-datetime - state: - description: Output only. The detailed state of a Study. + trials: + type: array + description: A list of Trials. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + studyState: + enum: + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + - COMPLETED enumDescriptions: - The study state is unspecified. - The study is active. @@ -14634,1291 +13723,1305 @@ components: - >- The study is done when the service exhausts the parameter search space or max_trial_count is reached. - readOnly: true - enum: - - STATE_UNSPECIFIED - - ACTIVE - - INACTIVE - - COMPLETED - type: string - name: type: string - description: >- - Output only. The name of a study. The study's globally unique - identifier. Format: - `projects/{project}/locations/{location}/studies/{study}` - readOnly: true - studySpec: - description: Required. Configuration of the Study. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - inactiveReason: - readOnly: true + description: The state of the Study. + endTime: + format: google-datetime + description: The time at which operation processing completed. type: string - description: >- - Output only. A human readable reason why the Study is inactive. This - should be empty if a study is ACTIVE or COMPLETED. - displayName: + startTime: type: string - description: Required. Describes the Study, default value is empty string. - description: A message representing a Study. - GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse: + format: google-datetime + description: The time at which the operation was started. + description: Response message for VizierService.SuggestTrials. + GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData: + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData + description: Per month usage data + type: object properties: - importedEvaluatedAnnotationsCount: - description: Output only. Number of EvaluatedAnnotations imported. - format: int32 - type: integer - readOnly: true - description: Response message for ModelService.BatchImportEvaluatedAnnotations - id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + userUsageData: + description: Usage data for each user in the given month. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData + GoogleCloudAiplatformV1DirectRawPredictRequest: + description: Request message for PredictionService.DirectRawPredict. type: object - GoogleCloudAiplatformV1RougeInstance: properties: - prediction: - description: Required. Output of the evaluated model. + input: + description: The prediction input. + format: byte type: string - reference: - description: Required. Ground truth used to compare against the prediction. + methodName: type: string - description: Spec for rouge instance. - id: GoogleCloudAiplatformV1RougeInstance - type: object - GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec: - properties: - useElapsedDuration: - type: boolean description: >- - True if Measurement.elapsed_duration is used as the x-axis of each - Trials Decay Curve. Otherwise, Measurement.step_count will be used - as the x-axis. - id: GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec + Fully qualified name of the API method being invoked to perform + predictions. Format: `/namespace.Service/Method/` Example: + `/tensorflow.serving.PredictionService/Predict` + id: GoogleCloudAiplatformV1DirectRawPredictRequest + GoogleCloudAiplatformV1DeployedIndex: + id: GoogleCloudAiplatformV1DeployedIndex description: >- - The decay curve automated stopping rule builds a Gaussian Process - Regressor to predict the final objective value of a Trial based on the - already completed Trials and the intermediate measurements of the - current Trial. Early stopping is requested for the current Trial if - there is very low probability to exceed the optimal value found so far. - type: object - GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput: - type: object - description: Input for question answering relevance metric. - id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput - properties: - instance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance - description: Required. Question answering relevance instance. - metricSpec: - description: Required. Spec for question answering relevance score metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec - GoogleCloudAiplatformV1Port: - id: GoogleCloudAiplatformV1Port + A deployment of an Index. IndexEndpoints contain one or more + DeployedIndexes. type: object - description: Represents a network port in a container. properties: - containerPort: - format: int32 + deploymentGroup: + type: string description: >- - The number of the port to expose on the pod's IP address. Must be a - valid port number, between 1 and 65535 inclusive. - type: integer - GoogleCloudAiplatformV1SummarizationQualityInput: - type: object - description: Input for summarization quality metric. - properties: - instance: - description: Required. Summarization quality instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInstance - metricSpec: - description: Required. Spec for summarization quality score metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SummarizationQualitySpec' - id: GoogleCloudAiplatformV1SummarizationQualityInput - GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance: - properties: - content: + Optional. The deployment group can be no longer than 64 characters + (eg: 'test', 'prod'). If not set, we will use the 'default' + deployment group. Creating `deployment_groups` with + `reserved_ip_ranges` is a recommended practice when the peered + network has multiple peering ranges. This creates your deployments + from predictable IP spaces for easier traffic administration. Also, + one deployment_group (except 'default') can only be used with the + same reserved_ip_ranges which means if the deployment_group has been + used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, + e] is disallowed. Note: we only support up to 5 deployment + groups(not including 'default'). + privateEndpoints: + readOnly: true description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. - type: string - timeSegmentEnd: - type: string + Output only. Provides paths for users to send requests directly to + the deployed index services running on Cloud via private services + access. This field is populated if network is configured. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' + deployedIndexAuthConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' description: >- - The end, exclusive, of the video's time segment on which to perform - the prediction. Expressed as a number of seconds as measured from - the start of the video, with "s" appended at the end. Fractions are - allowed, up to a microsecond precision, and "inf" or "Infinity" is - allowed, which means the end of the video. - timeSegmentStart: + Optional. If set, the authentication is enabled for the private + endpoint. + indexSyncTime: + description: >- + Output only. The DeployedIndex may depend on various data on its + original Index. Additionally when certain changes to the original + Index are being done (e.g. when what the Index contains is being + changed) the DeployedIndex may be asynchronously updated in the + background to reflect these changes. If this timestamp's value is at + least the Index.update_time of the original Index, it means that + this DeployedIndex and the original Index are in sync. If this + timestamp is older, then to see which updates this DeployedIndex + already contains (and which it does not), one must list the + operations that are running on the original Index. Only the + successfully completed Operations with update_time equal or before + this sync time are contained in this DeployedIndex. + readOnly: true type: string + format: google-datetime + enableAccessLogging: + type: boolean description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. - mimeType: + Optional. If true, private endpoint's access logs are sent to Cloud + Logging. These logs are like standard server access logs, containing + information like timestamp and latency for each MatchRequest. Note + that logs may incur a cost, especially if the deployed index + receives a high queries per second rate (QPS). Estimate your costs + before enabling this option. + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime + Optional. A description of resources that are dedicated to the + DeployedIndex, and that need a higher degree of manual + configuration. The field min_replica_count must be set to a value + strictly greater than 0, or else validation will fail. We don't + provide SLA when min_replica_count=1. If max_replica_count is not + set, the default value is min_replica_count. The max allowed replica + count is 1000. Available machine types for SMALL shard: + e2-standard-2 and all machine types available for MEDIUM and LARGE + shard. Available machine types for MEDIUM shard: e2-standard-16 and + all machine types available for LARGE shard. Available machine types + for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and + n1-standard-32 are still available, but we recommend e2-standard-16 + and e2-highmem-16 for cost efficiency. + reservedIpRanges: + type: array + description: >- + Optional. A list of reserved ip ranges under the VPC network that + can be used for this DeployedIndex. If set, we will deploy the index + within the provided ip ranges. Otherwise, the index might be + deployed to any ip ranges under the provided VPC network. The value + should be the name of the address + (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) + Example: ['vertex-ai-ip-range']. For more information about subnets + and network IP ranges, please see + https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. + items: + type: string + displayName: + description: >- + The display name of the DeployedIndex. If not provided upon + creation, the Index's display_name is used. type: string - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance - description: Prediction input format for Video Action Recognition. - type: object - GoogleCloudAiplatformV1MigrateResourceRequest: - type: object - description: >- - Config of migrating one resource from automl.googleapis.com, - datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. - id: GoogleCloudAiplatformV1MigrateResourceRequest - properties: - migrateAutomlDatasetConfig: + pscAutomationConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PSCAutomationConfig' description: >- - Config for migrating Dataset in automl.googleapis.com to Vertex AI's - Dataset. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig - migrateDataLabelingDatasetConfig: + Optional. If set for PSC deployed index, PSC connection will be + automatically created after deployment is done and the endpoint + information is populated in + private_endpoints.psc_automated_endpoints. + id: description: >- - Config for migrating Dataset in datalabeling.googleapis.com to - Vertex AI's Dataset. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig - migrateMlEngineModelVersionConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig + Required. The user specified ID of the DeployedIndex. The ID can be + up to 128 characters long and must start with a letter and only + contain letters, numbers, and underscores. The ID must be unique + within the project it is created in. + type: string + index: description: >- - Config for migrating Version in ml.googleapis.com to Vertex AI's - Model. - migrateAutomlModelConfig: + Required. The name of the Index this is the deployment of. We may + refer to this Index as the DeployedIndex's "original" Index. + type: string + createTime: + type: string + readOnly: true + description: Output only. Timestamp when the DeployedIndex was created. + format: google-datetime + automaticResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' description: >- - Config for migrating Model in automl.googleapis.com to Vertex AI's - Model. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig - GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams: + Optional. A description of resources that the DeployedIndex uses, + which to large degree are decided by Vertex AI, and optionally + allows only a modest additional configuration. If min_replica_count + is not set, the default value is 2 (we don't provide SLA when + min_replica_count=1). If max_replica_count is not set, the default + value is min_replica_count. The max allowed replica count is 1000. + GoogleCloudAiplatformV1ExplanationSpec: + id: GoogleCloudAiplatformV1ExplanationSpec type: object - description: Prediction model parameters for Video Object Tracking. - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams properties: - minBoundingBoxSize: - description: >- - Only bounding boxes with shortest edge at least that long as a - relative value of video frame size are returned. Default value is - 0.0. - type: number - format: float - confidenceThreshold: + metadata: description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - format: float - type: number - maxPredictions: + Optional. Metadata describing the Model's input and output for + explanation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationMetadata' + parameters: description: >- - The model only returns up to that many top, by confidence score, - predictions per frame of the video. If this number is very high, the - Model may return fewer predictions per frame. Default value is 50. - format: int32 - type: integer - GoogleCloudAiplatformV1ListBatchPredictionJobsResponse: - id: GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + Required. Parameters that configure explaining of the Model's + predictions. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' + description: Specification of Model explanation. + GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup: type: object - description: Response message for JobService.ListBatchPredictionJobs + description: >- + Features belonging to a single feature group that will be synced to + Online Store. properties: - nextPageToken: - description: >- - A token to retrieve the next page of results. Pass to - ListBatchPredictionJobsRequest.page_token to obtain that page. - type: string - batchPredictionJobs: - description: List of BatchPredictionJobs in the requested page. + featureIds: type: array + description: Required. Identifiers of features under the feature group. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' - GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance: + type: string + featureGroupId: + description: Required. Identifier of the feature group. + type: string + id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup + GoogleCloudAiplatformV1PairwiseMetricInstance: + id: GoogleCloudAiplatformV1PairwiseMetricInstance + description: >- + Pairwise metric instance. Usually one instance corresponds to one row in + an evaluation dataset. + type: object properties: - mimeType: + jsonInstance: type: string description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/gif - - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon - content: - type: string - description: The image bytes or Cloud Storage URI to make the prediction on. - description: Prediction input format for Image Object Detection. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance - type: object - GoogleCloudAiplatformV1WriteFeatureValuesRequest: - type: object - description: Request message for FeaturestoreOnlineServingService.WriteFeatureValues. - properties: - payloads: - description: >- - Required. The entities to be written. Up to 100,000 feature values - can be written across all `payloads`. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesPayload - id: GoogleCloudAiplatformV1WriteFeatureValuesRequest - CloudAiLargeModelsVisionImageRAIScores: - description: RAI scores for generated image returned. - id: CloudAiLargeModelsVisionImageRAIScores - properties: - agileWatermarkDetectionScore: - description: Agile watermark score for image. - type: number - format: double + Instance specified as a json string. String key-value pairs are + expected in the json_instance to render + PairwiseMetricSpec.instance_prompt_template. + GoogleCloudAiplatformV1MachineSpec: type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation properties: - columnName: + acceleratorCount: + format: int32 + type: integer + description: The number of accelerators to attach to the machine. + tpuTopology: type: string - description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. - type: object - GoogleCloudAiplatformV1SchemaVideoDataItem: - description: Payload of Video DataItem. - properties: - mimeType: - readOnly: true description: >- - Output only. The mime type of the content of the video. Only the - videos in below listed mime types are supported. Supported - mime_type: - video/mp4 - video/avi - video/quicktime + Immutable. The topology of the TPUs. Corresponds to the TPU + topologies available from GKE. (Example: tpu_topology: "2x2x1"). + machineType: type: string - gcsUri: description: >- - Required. Google Cloud Storage URI points to the original video in - user's bucket. The video is up to 50 GB in size and up to 3 hour in - duration. + 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. + acceleratorType: type: string - id: GoogleCloudAiplatformV1SchemaVideoDataItem + enum: + - ACCELERATOR_TYPE_UNSPECIFIED + - NVIDIA_TESLA_K80 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_V100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_L4 + - NVIDIA_H100_80GB + - TPU_V2 + - TPU_V3 + - TPU_V4_POD + - TPU_V5_LITEPOD + description: >- + Immutable. The type of accelerator(s) that may be attached to the + machine as per accelerator_count. + enumDescriptions: + - Unspecified accelerator type, which means no accelerator. + - >- + Deprecated: Nvidia Tesla K80 GPU has reached end of support, see + https://cloud.google.com/compute/docs/eol/k80-eol. + - Nvidia Tesla P100 GPU. + - Nvidia Tesla V100 GPU. + - Nvidia Tesla P4 GPU. + - Nvidia Tesla T4 GPU. + - Nvidia Tesla A100 GPU. + - Nvidia A100 80GB GPU. + - Nvidia L4 GPU. + - Nvidia H100 80Gb GPU. + - TPU v2. + - TPU v3. + - TPU v4. + - TPU v5. + enumDeprecated: + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + reservationAffinity: + description: >- + Optional. Immutable. Configuration controlling how this resource + pool consumes reservation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReservationAffinity' + description: Specification of a single machine. + id: GoogleCloudAiplatformV1MachineSpec + GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput: type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput + description: Input for question answering relevance metric. properties: - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation - timestamp: + instance: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation - categorical: + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance + description: Required. Question answering relevance instance. + metricSpec: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation - type: object - GoogleCloudAiplatformV1CancelBatchPredictionJobRequest: + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec + description: Required. Spec for question answering relevance score metric. + GoogleCloudAiplatformV1ContainerSpec: + description: The spec of a Container. + id: GoogleCloudAiplatformV1ContainerSpec type: object - id: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest - properties: {} - description: Request message for JobService.CancelBatchPredictionJob. - GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult: - description: Prediction output format for Video Classification. properties: - confidence: - type: number - format: float - description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. - displayName: - type: string - description: The display name of the AnnotationSpec that had been identified. - timeSegmentEnd: + command: description: >- - The end, exclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. Note that - for 'segment-classification' prediction type, this equals the - original 'timeSegmentEnd' from the input instance, for other types - it is the end of a shot or a 1 second interval respectively. - format: google-duration - type: string - type: + The command to be invoked when the container is started. It + overrides the entrypoint instruction in Dockerfile when provided. + items: + type: string + type: array + args: + description: The arguments to be passed when starting the container. + type: array + items: + type: string + imageUri: type: string description: >- - The type of the prediction. The requested types can be configured - via parameters. This will be one of - segment-classification - - shot-classification - one-sec-interval-classification - timeSegmentStart: + Required. The URI of a container image in the Container Registry + that is to be run on each worker replica. + env: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + type: array description: >- - The beginning, inclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. Note that - for 'segment-classification' prediction type, this equals the - original 'timeSegmentStart' from the input instance, for other types - it is the start of a shot or a 1 second interval respectively. - format: google-duration + Environment variables to be passed to the container. Maximum limit + is 100. + GoogleCloudAiplatformV1Citation: + properties: + license: type: string - id: - description: The resource ID of the AnnotationSpec that had been identified. + readOnly: true + description: Output only. License of the attribution. + publicationDate: + readOnly: true + $ref: '#/components/schemas/GoogleTypeDate' + description: Output only. Publication date of the attribution. + uri: + readOnly: true + description: Output only. Url reference of the attribution. type: string - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult - type: object - GoogleCloudAiplatformV1ModelGardenSource: - properties: - publicModelName: + startIndex: + description: Output only. Start index into the content. + format: int32 + type: integer + readOnly: true + title: type: string - description: Required. The model garden source model resource name. - id: GoogleCloudAiplatformV1ModelGardenSource + description: Output only. Title of the attribution. + readOnly: true + endIndex: + description: Output only. End index into the content. + format: int32 + readOnly: true + type: integer + id: GoogleCloudAiplatformV1Citation + description: Source attributions for content. type: object + GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig: description: >- - Contains information about the source of the models generated from Model - Garden. - GoogleCloudAiplatformV1SearchDataItemsResponse: - description: Response message for DatasetService.SearchDataItems. + OnlineServingConfig specifies the details for provisioning online + serving resources. properties: - nextPageToken: + fixedNodeCount: description: >- - A token to retrieve next page of results. Pass to - SearchDataItemsRequest.page_token to obtain that page. - type: string - dataItemViews: - type: array - description: The DataItemViews read. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItemView' - id: GoogleCloudAiplatformV1SearchDataItemsResponse + The number of nodes for the online store. The number of nodes + doesn't scale automatically, but you can manually update the number + of nodes. If set to 0, the featurestore will not have an online + store and cannot be used for online serving. + format: int32 + type: integer + scaling: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling + description: >- + Online serving scaling configuration. Only one of `fixed_node_count` + and `scaling` can be set. Setting one will reset the other. + id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig type: object - GoogleCloudAiplatformV1PublisherModelCallToAction: + GoogleCloudAiplatformV1GcsSource: properties: - openGenerationAiStudio: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open in Generation AI Studio. - viewRestApi: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi - description: Optional. To view Rest API docs. - createApplication: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Create application using the PublisherModel. - deployGke: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke - description: Optional. Deploy PublisherModel to Google Kubernetes Engine. - openFineTuningPipelines: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines - description: Optional. Open fine-tuning pipelines of the PublisherModel. - openNotebook: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open notebook of the PublisherModel. - openGenie: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open Genie / Playground. - openEvaluationPipeline: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open evaluation pipeline of the PublisherModel. - multiDeployVertex: + uris: + type: array description: >- - Optional. Multiple setups to deploy the PublisherModel to Vertex - Endpoint. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex - openNotebooks: - description: Optional. Open notebooks of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks - requestAccess: - description: Optional. Request for access. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - deploy: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy - description: Optional. Deploy the PublisherModel to Vertex Endpoint. - openPromptTuningPipeline: - description: Optional. Open prompt-tuning pipeline of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - openFineTuningPipeline: - description: Optional. Open fine-tuning pipeline of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + Required. Google Cloud Storage URI(-s) to the input file(s). May + contain wildcards. For more information on wildcards, see + https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. + items: + type: string type: object - id: GoogleCloudAiplatformV1PublisherModelCallToAction - description: Actions could take on this Publisher Model. - CloudAiLargeModelsVisionSemanticFilterResponse: - id: CloudAiLargeModelsVisionSemanticFilterResponse + id: GoogleCloudAiplatformV1GcsSource + description: The Google Cloud Storage location for the input content. + GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec: type: object properties: - passedSemanticFilter: - type: boolean + defaultValue: + type: number + format: double description: >- - This response is added when semantic filter config is turned on in - EditConfig. It reports if this image is passed semantic filter - response. If passed_semantic_filter is false, the bounding box - information will be populated for user to check what caused the - semantic filter to fail. - namedBoundingBoxes: - type: array - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' + A default value for a `DOUBLE` parameter that is assumed to be a + relatively good starting point. Unset value signals that there is no + offered starting point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. + maxValue: + type: number + format: double + description: Required. Inclusive maximum value of the parameter. + minValue: + type: number + description: Required. Inclusive minimum value of the parameter. + format: double + id: GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + description: Value specification for a parameter in `DOUBLE` type. + CloudAiLargeModelsVisionImage: + description: Image. + type: object + properties: + uri: + type: string + description: Path to another storage (typically Google Cloud Storage). + raiInfo: + description: RAI info for image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' + text: + type: string + description: Text/Expanded text input for imagen. + image: + format: byte + type: string + description: Raw bytes. + generationSeed: + type: integer description: >- - Class labels of the bounding boxes that failed the semantic - filtering. Bounding box coordinates. - GoogleCloudAiplatformV1Feature: - id: GoogleCloudAiplatformV1Feature + Generation seed for the sampled image. This parameter is exposed to + the user only if one of the following is true: 1. The user specified + per-example seeds in the request. 2. The user doesn't specify the + generation seed in the request. + format: int32 + imageRaiScores: + description: RAI scores for generated image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' + encoding: + description: Image encoding, encoded as "image/png" or "image/jpg". + type: string + semanticFilterResponse: + description: Semantic filter info for image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' + id: CloudAiLargeModelsVisionImage + GoogleCloudAiplatformV1SchemaTablesDatasetMetadata: properties: - updateTime: - format: google-datetime + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadata + type: object + description: The metadata of Datasets that contain tables data. + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec: + description: The spec of multi-trial Neural Architecture Search (NAS). + properties: + multiTrialAlgorithm: + enumDescriptions: + - Defaults to `REINFORCEMENT_LEARNING`. + - >- + The Reinforcement Learning Algorithm for Multi-trial Neural + Architecture Search (NAS). + - >- + The Grid Search Algorithm for Multi-trial Neural Architecture + Search (NAS). type: string description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - Timestamp when this EntityType was most recently updated. - readOnly: true - createTime: - format: google-datetime + The multi-trial Neural Architecture Search (NAS) algorithm type. + Defaults to `REINFORCEMENT_LEARNING`. + enum: + - MULTI_TRIAL_ALGORITHM_UNSPECIFIED + - REINFORCEMENT_LEARNING + - GRID_SEARCH + trainTrialSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - Timestamp when this EntityType was created. + Spec for train trials. Top N + [TrainTrialSpec.max_parallel_trial_count] search trials will be + trained for every M [TrainTrialSpec.frequency] trials searched. + searchTrialSpec: + description: Required. Spec for search trials. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec + metric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + description: >- + Metric specs for the NAS job. Validation for this field is done at + `multi_trial_algorithm_spec` field. + type: object + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec + GoogleCloudAiplatformV1Neighbor: + properties: + neighborId: + description: Output only. The neighbor id. readOnly: true type: string - monitoringStatsAnomalies: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + neighborDistance: + description: Output only. The neighbor distance. + format: double readOnly: true + type: number + id: GoogleCloudAiplatformV1Neighbor + description: Neighbors for example-based explanations. + type: object + GoogleCloudAiplatformV1AvroSource: + id: GoogleCloudAiplatformV1AvroSource + properties: + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: Required. Google Cloud Storage location. + type: object + description: The storage details for Avro input content. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation: + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation + properties: + invalidValuesAllowed: + type: boolean description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - The list of historical stats and anomalies with specified - objectives. - type: array - versionColumnName: - type: string - description: >- - Only applicable for Vertex AI Feature Store. The name of the - BigQuery Table/View column hosting data for this version. If no - value is provided, will use feature_id. - labels: - additionalProperties: - type: string - type: object - description: >- - Optional. The labels with user-defined metadata to organize your - Features. Label keys and values can be no longer than 64 characters - (Unicode codepoints), can only contain lowercase letters, numeric - characters, underscores and dashes. International characters are - allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one Feature (System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - etag: - type: string - description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - 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. - type: string - valueType: - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - BOOL_ARRAY - - DOUBLE - - DOUBLE_ARRAY - - INT64 - - INT64_ARRAY - - STRING - - STRING_ARRAY - - BYTES - - STRUCT - enumDescriptions: - - The value type is unspecified. - - Used for Feature that is a boolean. - - Used for Feature that is a list of boolean. - - Used for Feature that is double. - - Used for Feature that is a list of double. - - Used for Feature that is INT64. - - Used for Feature that is a list of INT64. - - Used for Feature that is string. - - Used for Feature that is a list of String. - - Used for Feature that is bytes. - - Used for Feature that is struct. - description: >- - Immutable. Only applicable for Vertex AI Feature Store (Legacy). - Type of Feature value. - type: string - disableMonitoring: - type: boolean - description: >- - Optional. Only applicable for Vertex AI Feature Store (Legacy). If - not set, use the monitoring_config defined for the EntityType this - Feature belongs to. Only Features with type (Feature.ValueType) - BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, - all types of data monitoring are disabled despite the config on - EntityType. - description: - description: Description of the Feature. - type: string - pointOfContact: + If invalid values is allowed, the training pipeline will create a + boolean feature that indicated whether the value is valid. + Otherwise, the training pipeline will discard the input row from + trainining data. + columnName: type: string - description: >- - Entity responsible for maintaining this feature. Can be comma - separated list of email addresses or URIs. - type: object description: >- - Feature Metadata information. For example, color is a feature that - describes an apple. - GoogleCloudAiplatformV1ToolConfig: + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. * A boolean value that indicates whether the + value is valid. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition: + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + description: The input parameters of this TrainingJob. description: >- - Tool config. This config is shared for all tools provided in the - request. + A TrainingJob that trains and uploads an AutoML Video Action Recognition + Model. + GoogleCloudAiplatformV1ListModelsResponse: + description: Response message for ModelService.ListModels properties: - functionCallingConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' - description: Optional. Function calling config. + models: + description: List of Models in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + type: array + nextPageToken: + description: >- + A token to retrieve next page of results. Pass to + ListModelsRequest.page_token to obtain that page. + type: string type: object - id: GoogleCloudAiplatformV1ToolConfig - GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: - description: Content filter results for a prompt sent in the request. - id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + id: GoogleCloudAiplatformV1ListModelsResponse + GoogleCloudAiplatformV1FluencyResult: + type: object + id: GoogleCloudAiplatformV1FluencyResult properties: - blockReasonMessage: - readOnly: true + explanation: + description: Output only. Explanation for fluency score. type: string - description: Output only. A readable block reason message. - safetyRatings: - description: Output only. Safety ratings. - type: array readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' - blockReason: - type: string - enumDescriptions: - - Unspecified blocked reason. - - Candidates blocked due to safety. - - Candidates blocked due to other reason. - - >- - Candidates blocked due to the terms which are included from the - terminology blocklist. - - Candidates blocked due to prohibited content. - enum: - - BLOCKED_REASON_UNSPECIFIED - - SAFETY - - OTHER - - BLOCKLIST - - PROHIBITED_CONTENT - description: Output only. Blocked reason. + confidence: + type: number + readOnly: true + format: float + description: Output only. Confidence for fluency score. + score: + format: float + type: number + description: Output only. Fluency score. readOnly: true + description: Spec for fluency result. + GoogleCloudAiplatformV1CancelBatchPredictionJobRequest: type: object - GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult: - description: Prediction output format for Image and Text Classification. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult + properties: {} + description: Request message for JobService.CancelBatchPredictionJob. + id: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest + GoogleCloudAiplatformV1EntityIdSelector: type: object + description: Selector for entityId. Getting ids from the given source. + id: GoogleCloudAiplatformV1EntityIdSelector properties: - confidences: - description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. - items: - format: float - type: number - type: array - ids: - type: array - items: - type: string - format: int64 - description: The resource IDs of the AnnotationSpecs that had been identified. - displayNames: - items: - type: string + entityIdField: description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. - type: array - GoogleCloudAiplatformV1StreamingPredictResponse: - id: GoogleCloudAiplatformV1StreamingPredictResponse + Source column that holds entity IDs. If not provided, entity IDs are + extracted from the column named entity_id. + type: string + csvSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + description: Source of Csv + GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode properties: - outputs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - type: array - description: The prediction output. - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. + modelName: + description: >- + The model name to use. Only the public LLM models are accepted. e.g. + 'gemini-1.5-pro-001'. + type: string type: object - description: Response message for PredictionService.StreamingPredict. - GoogleCloudAiplatformV1PrivateEndpoints: - description: >- - PrivateEndpoints proto is used to provide paths for users to send - requests privately. To send request via private service access, use - predict_http_uri, explain_http_uri or health_http_uri. To send request - via private service connect, use service_attachment. + description: When manual routing is set, the specified model will be used directly. + GoogleCloudAiplatformV1PauseScheduleRequest: + description: Request message for ScheduleService.PauseSchedule. + id: GoogleCloudAiplatformV1PauseScheduleRequest + properties: {} + type: object + GoogleCloudAiplatformV1FeatureValueDestination: + description: A destination location for Feature values and format. properties: - explainHttpUri: - type: string - description: Output only. Http(s) path to send explain requests. - readOnly: true - healthHttpUri: - type: string - readOnly: true - description: Output only. Http(s) path to send health check requests. - serviceAttachment: - type: string - readOnly: true + tfrecordDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TFRecordDestination' description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. - predictHttpUri: - description: Output only. Http(s) path to send prediction requests. - type: string - readOnly: true + Output in TFRecord format. Below are the mapping from Feature value + type in Featurestore to Feature value type in TFRecord: Value type + in Featurestore | Value type in TFRecord DOUBLE, DOUBLE_ARRAY | + FLOAT_LIST INT64, INT64_ARRAY | INT64_LIST STRING, STRING_ARRAY, + BYTES | BYTES_LIST true -> byte_string("true"), false -> + byte_string("false") BOOL, BOOL_ARRAY (true, false) | BYTES_LIST + bigqueryDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + description: >- + Output in BigQuery format. BigQueryDestination.output_uri in + FeatureValueDestination.bigquery_destination must refer to a table. + csvDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvDestination' + description: >- + Output in CSV format. Array Feature value types are not allowed in + CSV format. + id: GoogleCloudAiplatformV1FeatureValueDestination + type: object + GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: type: object - id: GoogleCloudAiplatformV1PrivateEndpoints - GoogleCloudAiplatformV1SamplingStrategy: - description: >- - Sampling Strategy for logging, can be for both training and prediction - dataset. properties: - randomSampleConfig: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureView Update. + id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata + description: Details of operations that perform update FeatureView. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask: + properties: + inputs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + description: The input parameters of this CustomTask. + metadata: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig - description: Random sample config. Will support more sampling strategies later. - type: object - id: GoogleCloudAiplatformV1SamplingStrategy - GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig: - description: Configuration options for using brute force search. + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + description: The metadata information. + description: A TrainingJob that trains a custom code Model. type: object - properties: {} - id: GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig - GoogleCloudAiplatformV1Value: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask + GoogleCloudAiplatformV1DeployModelResponse: + id: GoogleCloudAiplatformV1DeployModelResponse + description: Response message for EndpointService.DeployModel. type: object - id: GoogleCloudAiplatformV1Value - description: Value is the value of the field. properties: - stringValue: - type: string - description: A string value. - intValue: + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: The DeployedModel that had been deployed in the Endpoint. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation: + properties: + columnName: type: string - description: An integer value. - format: int64 - doubleValue: - description: A double value. - format: double - type: number - GoogleCloudAiplatformV1ActiveLearningConfig: - type: object 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 + Treats the column as categorical array and performs following + transformation functions. * For each element in the array, convert the + category name to a dictionary lookup index and generate an embedding for + each index. Combine the embedding of all elements into a single + embedding using the mean. * Empty arrays treated as an embedding of + zeroes. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + type: object + GoogleCloudAiplatformV1FeaturestoreMonitoringConfig: properties: - maxDataItemCount: - format: int64 - description: Max number of human labeled DataItems. - type: string - maxDataItemPercentage: - description: Max percent of total DataItems for human labeling. - format: int32 - type: integer - sampleConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' + numericalThresholdConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig description: >- - Active learning data sampling config. For every active learning - labeling iteration, it will select a batch of data based on the - sampling strategy. - trainingConfig: + Threshold for numerical features of anomaly detection. This is + shared by all objectives of Featurestore Monitoring for numerical + features (i.e. Features with type (Feature.ValueType) DOUBLE or + INT64). + categoricalThresholdConfig: description: >- - CMLE training config. For every active learning labeling iteration, - system will train a machine learning model on CMLE. The trained - model will be used by data sampling algorithm to select DataItems. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' - GoogleCloudAiplatformV1Index: - id: GoogleCloudAiplatformV1Index + Threshold for categorical features of anomaly detection. This is + shared by all types of Featurestore Monitoring for categorical + features (i.e. Features with type (Feature.ValueType) BOOL or + STRING). + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + snapshotAnalysis: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis + description: The config for Snapshot Analysis Based Feature Monitoring. + importFeaturesAnalysis: + description: The config for ImportFeatures Analysis Based Feature Monitoring. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis + description: Configuration of how features in Featurestore are monitored. + type: object + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfig + GoogleCloudAiplatformV1Schema: type: object - description: >- - A representation of a collection of database items organized in a way - that allows for approximate nearest neighbor (a.k.a ANN) algorithms - search. properties: - metadataSchemaUri: - type: string + default: + type: any + description: Optional. Default value of the data. + enum: description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Index, that is specific - to it. Unset if the Index does not have any additional information. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - Note: The URI given on output will be immutable and probably - different, including the URI scheme, than the one given on input. - The output URI will point to a location where the user only has a - read access. - displayName: + Optional. Possible values of the element of Type.STRING with enum + format. For example we can define an Enum Direction as : + {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + type: array + items: + type: string + propertyOrdering: + items: + type: string + type: array description: >- - Required. The display name of the Index. The name can be up to 128 - characters long and can consist of any UTF-8 characters. + Optional. The order of the properties. Not a standard field in open + api spec. Only used to support the order of the properties. + maximum: + type: number + format: double + description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER + minProperties: + description: Optional. Minimum number of the properties for Type.OBJECT. type: string - etag: + format: int64 + type: + description: Optional. The type of the data. + enumDescriptions: + - Not specified, should not be used. + - OpenAPI string type + - OpenAPI number type + - OpenAPI integer type + - OpenAPI boolean type + - OpenAPI array type + - OpenAPI object type + enum: + - TYPE_UNSPECIFIED + - STRING + - NUMBER + - INTEGER + - BOOLEAN + - ARRAY + - OBJECT type: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - metadata: - type: any - description: >- - An additional information about the Index; the schema of the - metadata can be found in metadata_schema. - satisfiesPzs: - description: Output only. Reserved for future use. + nullable: + description: Optional. Indicates if the value may be null. type: boolean - readOnly: true - labels: + maxItems: + type: string + description: Optional. Maximum number of the elements for Type.ARRAY. + format: int64 + example: description: >- - The labels with user-defined metadata to organize your Indexes. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - type: object - additionalProperties: - type: string - deployedIndexes: + Optional. Example of the object. Will only populated when the object + is the root. + type: any + minLength: description: >- - Output only. The pointers to DeployedIndexes created from this - Index. An Index can be only deleted if all its DeployedIndexes had - been undeployed first. + Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the + Type.STRING + format: int64 + type: string + required: type: array + description: Optional. Required properties of Type.OBJECT. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' - readOnly: true - indexUpdateMethod: - enum: - - INDEX_UPDATE_METHOD_UNSPECIFIED - - BATCH_UPDATE - - STREAM_UPDATE - type: string + type: string + properties: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + type: object + minimum: description: >- - Immutable. The update method to use with this Index. If not set, - BATCH_UPDATE will be used by default. - enumDescriptions: - - Should not be used. - - >- - BatchUpdate: user can call UpdateIndex with files on Cloud Storage - of Datapoints to update. - - >- - StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to - update the Index and the updates will be applied in corresponding - DeployedIndexes in nearly real-time. - updateTime: - format: google-datetime + Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of + the Type.INTEGER and Type.NUMBER + type: number + format: double + maxLength: + type: string + description: Optional. Maximum length of the Type.STRING + format: int64 + title: + type: string + description: Optional. The title of the Schema. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' description: >- - Output only. Timestamp when this Index was most recently updated. - This also includes any update to the contents of the Index. Note - that Operations working on this Index may have their - Operations.metadata.generic_metadata.update_time a little after the - value of this timestamp, yet that does not mean their results are - not already reflected in the Index. Result of any successfully - completed Operation on the Index is reflected in it. + Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of + Type.ARRAY. + minItems: + description: Optional. Minimum number of the elements for Type.ARRAY. + type: string + format: int64 + format: type: string - readOnly: true - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Immutable. Customer-managed encryption key spec for an Index. If - set, this Index and all sub-resources of this Index will be secured - by this key. - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean - readOnly: true - name: - description: Output only. The resource name of the Index. - readOnly: true + Optional. The format of the data. Supported formats: for NUMBER + type: "float", "double" for INTEGER type: "int32", "int64" for + STRING type: "email", "byte", etc + maxProperties: + description: Optional. Maximum number of the properties for Type.OBJECT. + format: int64 type: string - description: + pattern: type: string - description: The description of the Index. - indexStats: - description: Output only. Stats of the index resource. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' - createTime: - format: google-datetime + description: >- + Optional. Pattern of the Type.STRING to restrict a string to a + regular expression. + description: type: string - readOnly: true - description: Output only. Timestamp when this Index was created. - GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest: + description: Optional. The description of the data. + id: GoogleCloudAiplatformV1Schema + description: >- + Schema is used to define the format of input/output data. Represents a + select subset of an [OpenAPI 3.0 schema + object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields + may be added in the future as needed. + GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse: + id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse type: object - id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest - description: Request message for ModelService.BatchImportModelEvaluationSlices properties: - modelEvaluationSlices: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' - type: array - description: Required. Model evaluation slice resource to be imported. - GoogleCloudAiplatformV1ToolNameMatchInput: + importedEvaluatedAnnotationsCount: + description: Output only. Number of EvaluatedAnnotations imported. + type: integer + readOnly: true + format: int32 + description: Response message for ModelService.BatchImportEvaluatedAnnotations + GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance: type: object + description: Prediction input format for Image Classification. properties: - instances: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInstance' - description: Required. Repeated tool name match instances. - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchSpec' - description: Required. Spec for tool name match metric. - id: GoogleCloudAiplatformV1ToolNameMatchInput - description: Input for tool name match metric. - GoogleCloudAiplatformV1TensorboardBlob: - properties: - data: + mimeType: type: string - format: byte description: >- - Optional. The bytes of the blob is not present unless it's returned - by the ReadTensorboardBlobData endpoint. - id: + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/gif - + image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + content: + description: The image bytes or Cloud Storage URI to make the prediction on. type: string - description: >- - Output only. A URI safe key uniquely identifying a blob. Can be used - to locate the blob stored in the Cloud Storage bucket of the - consumer project. - readOnly: true - id: GoogleCloudAiplatformV1TensorboardBlob - description: One blob (e.g, image, graph) viewable on a blob metric plot. - type: object - GoogleCloudAiplatformV1NearestNeighborQueryEmbedding: - description: The embedding vector. - type: object - properties: - value: - description: Optional. Individual value in the embedding. - type: array - items: - format: float - type: number - id: GoogleCloudAiplatformV1NearestNeighborQueryEmbedding - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction: - description: A TrainingJob that trains and uploads an AutoML Text Extraction Model. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification: properties: inputs: - description: The input parameters of this TrainingJob. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs + description: The input parameters of this TrainingJob. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification type: object - GoogleLongrunningOperation: + description: >- + A TrainingJob that trains and uploads an AutoML Text Classification + Model. + GoogleCloudAiplatformV1PurgeArtifactsMetadata: + id: GoogleCloudAiplatformV1PurgeArtifactsMetadata + description: Details of operations that perform MetadataService.PurgeArtifacts. type: object properties: - name: - type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - metadata: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for purging Artifacts. + GoogleCloudAiplatformV1ListOptimalTrialsResponse: type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics properties: - recall: - format: float - description: Recall (True Positive Rate) for the given confidence threshold. - type: number - confidenceThreshold: + optimalTrials: description: >- - Metrics are computed with an assumption that the Model never returns - predictions with score lower than this value. - type: number - format: float - precision: - description: Precision for the given confidence threshold. - format: float - type: number - f1Score: - description: The harmonic mean of recall and precision. - type: number - format: float - GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig: + The pareto-optimal Trials for multiple objective Study or the + optimal trial for single objective Study. The definition of + pareto-optimal can be checked in wiki page. + https://en.wikipedia.org/wiki/Pareto_efficiency + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + id: GoogleCloudAiplatformV1ListOptimalTrialsResponse + description: Response message for VizierService.ListOptimalTrials. + GoogleCloudAiplatformV1WriteFeatureValuesRequest: + description: Request message for FeaturestoreOnlineServingService.WriteFeatureValues. properties: - datasetDisplayName: + payloads: + type: array description: >- - Required. Display name of the Dataset in Vertex AI. System will pick - a display name if unspecified. + Required. The entities to be written. Up to 100,000 feature values + can be written across all `payloads`. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesPayload + type: object + id: GoogleCloudAiplatformV1WriteFeatureValuesRequest + GoogleCloudAiplatformV1QuestionAnsweringQualityInstance: + properties: + context: + description: Required. Text to answer the question. type: string - dataset: - description: >- - Required. Full resource name of automl Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}`. + reference: + description: Optional. Ground truth used to compare against the prediction. type: string - description: >- - Config for migrating Dataset in automl.googleapis.com to Vertex AI's - Dataset. - id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig + instruction: + type: string + description: Required. Question Answering prompt for LLM. + prediction: + description: Required. Output of the evaluated model. + type: string + description: Spec for question answering quality instance. + id: GoogleCloudAiplatformV1QuestionAnsweringQualityInstance type: object - GoogleCloudAiplatformV1TensorboardBlobSequence: - properties: - values: - description: List of blobs contained within the sequence. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' - type: array + GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData: type: object - id: GoogleCloudAiplatformV1TensorboardBlobSequence description: >- - One point viewable on a blob metric plot, but mostly just a wrapper - message to work around repeated fields can't be used directly within - `oneof` fields. - GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse: - description: Response message for [NotebookService.CreateNotebookExecutionJob] + Container to hold value(s), successive in time, for one Feature from the + request. properties: - nextPageToken: + value: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + description: Feature value if a single value is requested. + values: description: >- - A token to retrieve next page of results. Pass to - ListNotebookExecutionJobs.page_token to obtain that page. - type: string - notebookExecutionJobs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' - type: array - description: List of NotebookExecutionJobs in the requested page. - id: GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse - type: object - GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest: - id: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest - description: Request message for JobService.CancelHyperparameterTuningJob. - type: object - properties: {} - GoogleCloudAiplatformV1Artifact: + Feature values list if values, successive in time, are requested. If + the requested number of values is greater than the number of + existing Feature values, nonexistent values are omitted instead of + being returned as empty. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueList' + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData + GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: + description: >- + Feature embedding vector for sparse index. An array of numbers whose + values are located in the specified dimensions. type: object - description: Instance of a general artifact. properties: - metadata: - type: object - description: >- - Properties of the Artifact. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. - additionalProperties: - type: any - description: Properties of the object. - labels: - additionalProperties: + dimensions: + type: array + items: + format: int64 type: string - type: object - description: >- - The labels with user-defined metadata to organize your Artifacts. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Artifact (System - labels are excluded). - displayName: - description: >- - User provided display name of the Artifact. May be up to 128 Unicode - characters. - type: string - etag: - type: string description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - createTime: - format: google-datetime + Required. The list of indexes for the embedding values of the sparse + vector. + values: + description: Required. The list of embedding values of the sparse vector. + type: array + items: + format: float + type: number + id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + GoogleCloudAiplatformV1DatasetVersion: + type: object + description: Describes the dataset version. + properties: + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean readOnly: true - type: string - description: Output only. Timestamp when this Artifact was created. - schemaVersion: + etag: description: >- - The version of the schema in schema_name to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - type: string - uri: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string + modelReference: description: >- - The uniform resource identifier of the artifact file. May be empty - if there is no actual artifact file. - name: + Output only. Reference to the public base model last used by the + dataset version. Only set for prompt dataset versions. type: string readOnly: true - description: Output only. The resource name of the Artifact. - state: - enum: - - STATE_UNSPECIFIED - - PENDING - - LIVE - type: string - enumDescriptions: - - Unspecified state for the Artifact. - - >- - A state used by systems like Vertex AI Pipelines to indicate that - the underlying data item represented by this Artifact is being - created. - - >- - A state indicating that the Artifact should exist, unless - something external to the system deletes it. + metadata: + readOnly: true description: >- - The state of this Artifact. This is a property of the Artifact, and - does not imply or capture any ongoing process. This property is - managed by clients (such as Vertex AI Pipelines), and the system - does not prescribe or check the validity of state transitions. + Required. Output only. Additional information about the + DatasetVersion. + type: any updateTime: + description: Output only. Timestamp when this DatasetVersion was last updated. readOnly: true format: google-datetime - description: Output only. Timestamp when this Artifact was last updated. type: string - description: + bigQueryDatasetName: + description: Output only. Name of the associated BigQuery dataset. + readOnly: true type: string - description: Description of the Artifact - schemaTitle: + displayName: type: string description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - id: GoogleCloudAiplatformV1Artifact - GoogleCloudAiplatformV1ComputeTokensResponse: - id: GoogleCloudAiplatformV1ComputeTokensResponse - type: object - description: Response message for ComputeTokens RPC call. - properties: - tokensInfo: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TokensInfo' - type: array - description: >- - Lists of tokens info from the input. A ComputeTokensRequest could - have multiple instances with a prompt in each instance. We also need - to return lists of tokens info for the request with multiple - instances. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation: - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation - properties: - invalidValuesAllowed: + The user-defined name of the DatasetVersion. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + satisfiesPzi: type: boolean - description: >- - If invalid values is allowed, the training pipeline will create a - boolean feature that indicated whether the value is valid. - Otherwise, the training pipeline will discard the input row from - trainining data. - columnName: + description: Output only. Reserved for future use. + readOnly: true + name: + description: Output only. Identifier. The resource name of the DatasetVersion. type: string - timeFormat: - description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + readOnly: true + createTime: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this DatasetVersion was created. type: string - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the * timestamp - as a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig: + id: GoogleCloudAiplatformV1DatasetVersion + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation type: object properties: - bigquerySource: + repeatedText: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource - gcsSource: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation + repeatedCategorical: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource - description: >- - The time series Dataset's data source. The Dataset doesn't store the - data directly, but only pointer(s) to its data. - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics: - description: The Evaluation metrics given a specific precision_window_length. - properties: - precisionWindowLength: - type: string - format: google-duration - description: >- - This VideoActionMetrics is calculated based on this prediction - window length. If the predicted action's timestamp is inside the - time window whose center is the ground truth action's timestamp with - this specific length, the prediction result is treated as a true - positive. - confidenceMetrics: - type: array - description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics - meanAveragePrecision: - type: number - format: float - description: The mean average precision. - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation + repeatedNumeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation + GoogleCloudAiplatformV1PipelineTaskExecutorDetail: + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail type: object - GoogleCloudAiplatformV1NasTrialDetail: + properties: + containerDetail: + readOnly: true + description: Output only. The detailed info for a container executor. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail + customJobDetail: + readOnly: true + description: Output only. The detailed info for a custom job executor. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail + description: The runtime detail of a pipeline executor. + GoogleCloudAiplatformV1CopyModelRequest: + id: GoogleCloudAiplatformV1CopyModelRequest + description: Request message for ModelService.CopyModel. type: object - id: GoogleCloudAiplatformV1NasTrialDetail properties: - trainTrial: + sourceModel: description: >- - The train NasTrial corresponding to search_trial. Only populated if - search_trial is used for training. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - searchTrial: - description: The requested search NasTrial. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - name: - description: Output only. Resource name of the NasTrialDetail. + Required. The resource name of the Model to copy. That Model must be + in the same Project. Format: + `projects/{project}/locations/{location}/models/{model}` type: string - readOnly: true - parameters: + parentModel: type: string - description: The parameters for the NasJob NasTrial. + description: >- + Optional. Specify this field to copy source_model into this existing + Model as a new version. Format: + `projects/{project}/locations/{location}/models/{model}` + modelId: + type: string + description: >- + Optional. Copy source_model into a new Model with this ID. The ID + will become the final component of the model 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. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key options. If this is set, then the + Model copy will be encrypted with the provided encryption key. + GoogleCloudAiplatformV1IndexDatapointCrowdingTag: description: >- - Represents a NasTrial details along with its parameters. If there is a - corresponding train NasTrial, the train NasTrial is also returned. - GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput: + Crowding tag is a constraint on a neighbor list produced by nearest + neighbor search requiring that no more than some value k' of the k + neighbors returned have the same value of crowding_attribute. + properties: + crowdingAttribute: + description: >- + The attribute value used for crowding. The maximum number of + neighbors to return per crowding attribute value + (per_crowding_attribute_num_neighbors) is configured per-query. This + field is ignored if per_crowding_attribute_num_neighbors is larger + than the total number of neighbors to return for a given query. + type: string + type: object + id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics type: object - id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput properties: - instance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance - description: Required. Question answering helpfulness instance. - metricSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec - description: Required. Spec for question answering helpfulness score metric. - description: Input for question answering helpfulness metric. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef: + weightedAbsolutePercentageError: + type: number + description: >- + Weighted Absolute Percentage Error. Does not use weights, this is + just what the metric is called. Undefined if actual values sum to + zero. Will be very large if actual values sum to a very small + number. + format: float + rootMeanSquaredPercentageError: + type: number + description: >- + Root Mean Square Percentage Error. Square root of MSPE. + Undefined/imaginary when MSPE is negative. + format: float + rootMeanSquaredError: + description: Root Mean Squared Error (RMSE). + format: float + type: number + quantileMetrics: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + type: array + description: The quantile metrics entries for each quantile. + meanAbsoluteError: + format: float + description: Mean Absolute Error (MAE). + type: number + rootMeanSquaredLogError: + format: float + description: >- + Root mean squared log error. Undefined when there are negative + ground truth values or predictions. + type: number + meanAbsolutePercentageError: + type: number + description: >- + Mean absolute percentage error. Infinity when there are zeros in the + ground truth. + format: float + rSquared: + type: number + description: >- + Coefficient of determination as Pearson correlation coefficient. + Undefined when ground truth or predictions are constant or near + constant. + format: float + description: Metrics for forecasting evaluation results. + GoogleCloudAiplatformV1SearchFeaturesResponse: + description: Response message for FeaturestoreService.SearchFeatures. properties: - displayName: + nextPageToken: type: string - description: Display name of the AnnotationSpec. - id: + description: >- + A token, which can be sent as SearchFeaturesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + features: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: >- + The Features matching the request. Fields returned: * `name` * + `description` * `labels` * `create_time` * `update_time` + type: object + id: GoogleCloudAiplatformV1SearchFeaturesResponse + GoogleCloudAiplatformV1PurgeContextsRequest: + description: Request message for MetadataService.PurgeContexts. + id: GoogleCloudAiplatformV1PurgeContextsRequest + properties: + force: + type: boolean + description: >- + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Context names + that would be deleted. + filter: type: string - description: ID of the AnnotationSpec. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + description: >- + Required. A required filter matching the Contexts to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. type: object - GoogleCloudAiplatformV1ToolParameterKeyMatchSpec: - id: GoogleCloudAiplatformV1ToolParameterKeyMatchSpec - properties: {} + GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey: + properties: + parts: + items: + type: string + type: array + description: >- + Parts to construct Entity ID. Should match with the same ID columns + as defined in FeatureView in the same order. + description: ID that is comprised from several parts (columns). type: object - description: Spec for tool parameter key match metric. - GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult + id: GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey + GoogleCloudAiplatformV1ListExecutionsResponse: + properties: + nextPageToken: + type: string + description: >- + A token, which can be sent as ListExecutionsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. + executions: + type: array + description: The Executions retrieved from the MetadataStore. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + id: GoogleCloudAiplatformV1ListExecutionsResponse + description: Response message for MetadataService.ListExecutions. type: object + GoogleCloudAiplatformV1ListStudiesResponse: + id: GoogleCloudAiplatformV1ListStudiesResponse + description: Response message for VizierService.ListStudies. properties: - bboxes: + studies: + type: array + description: The studies associated with the project. items: - items: - type: any - type: array + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + nextPageToken: + type: string description: >- - Bounding boxes, i.e. the rectangles over the image, that pinpoint - the found AnnotationSpecs. Given in order that matches the IDs. Each - bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and - `yMax`, which represent the extremal coordinates of the box. They - are relative to the image size, and the point 0,0 is in the top left - of the image. + Passes this token as the `page_token` field of the request for a + subsequent call. If this field is omitted, there are no subsequent + pages. + type: object + GoogleCloudAiplatformV1FeatureOnlineStoreBigtable: + id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + properties: + autoScaling: + description: Required. Autoscaling config applied to Bigtable Instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling + type: object + GoogleCloudAiplatformV1FulfillmentSpec: + properties: + version: + type: integer + format: int32 + description: Optional. Which version to use for evaluation. + description: Spec for fulfillment metric. + id: GoogleCloudAiplatformV1FulfillmentSpec + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult: + type: object + description: Prediction output format for Text Extraction. + properties: + textSegmentEndOffsets: type: array + description: >- + The end offsets, inclusive, of the text segment in which the + AnnotationSpec has been identified. Expressed as a zero-based number + of characters as measured from the start of the text snippet. + items: + type: string + format: int64 ids: description: >- The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly. + type: array + items: + format: int64 + type: string + confidences: + type: array + items: + format: float + type: number + description: >- + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. + textSegmentStartOffsets: items: format: int64 type: string type: array + description: >- + The start offsets, inclusive, of the text segment in which the + AnnotationSpec has been identified. Expressed as a zero-based number + of characters as measured from the start of the text snippet. displayNames: type: array description: >- @@ -15926,2667 +15029,2371 @@ components: order matches the IDs. items: type: string - confidences: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult + GoogleCloudAiplatformV1WriteTensorboardRunDataRequest: + id: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + description: Request message for TensorboardService.WriteTensorboardRunData. + properties: + timeSeriesData: type: array description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. + Required. The TensorboardTimeSeries data to write. Values with in a + time series are indexed by their step value. Repeated writes to the + same step will overwrite the existing value for that step. The upper + limit of data points per write request is 5000. items: - type: number - format: float - description: Prediction output format for Image Object Detection. - GoogleCloudAiplatformV1SchemaPredictionResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + tensorboardRun: + description: >- + Required. The resource name of the TensorboardRun to write data to. + Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + type: string + type: object + GoogleCloudAiplatformV1CreateEndpointOperationMetadata: + id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata + type: object + description: Runtime operation information for EndpointService.CreateEndpoint. properties: - key: - description: Optional user-provided key from the input instance. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1NotebookRuntimeTemplateRef: + description: Points to a NotebookRuntimeTemplateRef. + id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef + properties: + notebookRuntimeTemplate: type: string - instance: - additionalProperties: - description: Properties of the object. - type: any - description: >- - User's input instance. Struct is used here instead of Any so that - JsonFormat does not append an extra "@type" field when we convert - the proto to JSON. - type: object - error: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictionResultError - description: The error result. Do not set prediction if this is set. - prediction: - description: >- - The prediction result. Value is used here instead of Any so that - JsonFormat does not append an extra "@type" field when we convert - the proto to JSON and so we can represent array of objects. Do not - set error if this is set. - type: any + description: Immutable. A resource name of the NotebookRuntimeTemplate. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata type: object - id: GoogleCloudAiplatformV1SchemaPredictionResult - description: Represents a line of JSONL in the batch prediction output file. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting: properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs - description: The input parameters of this TrainingJob. - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + successfulStopReason: + description: >- + For successful job completions, this is the reason why the job has + finished. + type: string + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED + enumDescriptions: + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. + - >- + Further training of the Model ceased to increase its quality, + since it already has converged. + costMilliNodeHours: + format: int64 + type: string + description: >- + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. + GoogleCloudAiplatformV1ProbeExecAction: type: object - GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse: - description: Response message for TensorboardService.BatchCreateTensorboardRuns. + id: GoogleCloudAiplatformV1ProbeExecAction + description: ExecAction specifies a command to execute. properties: - tensorboardRuns: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - description: The created TensorboardRuns. + command: type: array + description: >- + Command is the command line to execute inside the container, the + working directory for the command is root ('/') in the container's + filesystem. The command is simply exec'd, it is not run inside a + shell, so traditional shell instructions ('|', etc) won't work. To + use a shell, you need to explicitly call out to that shell. Exit + status of 0 is treated as live/healthy and non-zero is unhealthy. + items: + type: string + GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport: type: object - id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse - GoogleCloudAiplatformV1ExportModelRequestOutputConfig: - description: Output configuration for the Model export. + description: >- + Describes exporting the latest Feature values of all entities of the + EntityType between [start_time, snapshot_time]. properties: - exportFormatId: + snapshotTime: description: >- - The ID of the format in which the Model must be exported. Each Model - lists the export formats it supports. If no value is provided here, - then the first from the list of the Model's supported formats is - used by default. + Exports Feature values as of this timestamp. If not set, retrieve + values as of now. Timestamp, if present, must not have higher than + millisecond precision. + type: string + format: google-datetime + startTime: type: string - artifactDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' description: >- - The Cloud Storage location where the Model artifact is to be written - to. Under the directory given as the destination a new one with name - "`model-export--`", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ - ISO-8601 format, will be created. Inside, the Model and any of its - supporting files will be written. This field should only be set when - the `exportableContent` field of the - [Model.supported_export_formats] object contains `ARTIFACT`. - imageDestination: + Excludes Feature values with feature generation timestamp before + this timestamp. If not set, retrieve oldest values kept in Feature + Store. Timestamp, if present, must not have higher than millisecond + precision. + format: google-datetime + id: GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport + GoogleCloudAiplatformV1SupervisedTuningSpec: + properties: + hyperParameters: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ContainerRegistryDestination + #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters + description: Optional. Hyperparameters for SFT. + validationDatasetUri: + type: string description: >- - The Google Container Registry or Artifact Registry uri where the - Model container image will be copied to. This field should only be - set when the `exportableContent` field of the - [Model.supported_export_formats] object contains `IMAGE`. - type: object - id: GoogleCloudAiplatformV1ExportModelRequestOutputConfig - GoogleCloudAiplatformV1ManualBatchTuningParameters: - id: GoogleCloudAiplatformV1ManualBatchTuningParameters - description: Manual batch tuning parameters. - properties: - batchSize: - format: int32 + Optional. Cloud Storage path to file containing validation dataset + for tuning. The dataset must be formatted as a JSONL file. + trainingDatasetUri: description: >- - Immutable. The number of the records (e.g. instances) of the - operation given in each batch to a machine replica. Machine type, - and size of a single record should be considered when setting this - parameter, higher value speeds up the batch operation's execution, - but too high value will result in a whole batch not fitting in a - machine's memory, and the whole operation will fail. The default - value is 64. - type: integer + Required. Cloud Storage path to file containing training dataset for + tuning. The dataset must be formatted as a JSONL file. + type: string type: object - GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata: + description: Tuning Spec for Supervised Tuning for first party models. + id: GoogleCloudAiplatformV1SupervisedTuningSpec + GoogleCloudAiplatformV1ToolNameMatchSpec: + id: GoogleCloudAiplatformV1ToolNameMatchSpec + properties: {} + type: object + description: Spec for tool name match metric. + GoogleCloudAiplatformV1SearchNearestEntitiesResponse: type: object properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - id: GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata - description: >- - Runtime operation information for - SpecialistPoolService.CreateSpecialistPool. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking: - description: >- - A TrainingJob that trains and uploads an AutoML Video ObjectTracking - Model. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking - type: object - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs - description: The input parameters of this TrainingJob. - GoogleCloudAiplatformV1Trial: + nearestNeighbors: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighbors' + description: The nearest neighbors of the query entity. + description: Response message for FeatureOnlineStoreService.SearchNearestEntities + id: GoogleCloudAiplatformV1SearchNearestEntitiesResponse + GoogleCloudAiplatformV1NasTrialDetail: type: object properties: + trainTrial: + description: >- + The train NasTrial corresponding to search_trial. Only populated if + search_trial is used for training. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + searchTrial: + description: The requested search NasTrial. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' name: - description: Output only. Resource name of the Trial assigned by the service. - type: string - readOnly: true - state: type: string - enum: - - STATE_UNSPECIFIED - - REQUESTED - - ACTIVE - - STOPPING - - SUCCEEDED - - INFEASIBLE - enumDescriptions: - - The Trial state is unspecified. - - >- - Indicates that a specific Trial has been requested, but it has not - yet been suggested by the service. - - Indicates that the Trial has been suggested. - - Indicates that the Trial should stop according to the service. - - Indicates that the Trial is completed successfully. - - >- - Indicates that the Trial should not be attempted again. The - service will set a Trial to INFEASIBLE when it's done but missing - the final_measurement. + description: Output only. Resource name of the NasTrialDetail. readOnly: true - description: Output only. The detailed state of the Trial. parameters: - readOnly: true - type: array - description: Output only. The parameters of the Trial. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' - webAccessUris: - description: >- - Output only. URIs for accessing [interactive - shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - (one URI for each training node). Only available if this trial is - part of a HyperparameterTuningJob and the job's - trial_job_spec.enable_web_access field is `true`. The keys are names - of each node used for the trial; for example, `workerpool0-0` for - the primary node, `workerpool1-0` for the first node in the second - worker pool, and `workerpool1-1` for the second node in the second - worker pool. The values are the URIs for each node's interactive - shell. - additionalProperties: - type: string - readOnly: true - type: object - customJob: - description: >- - Output only. The CustomJob name linked to the Trial. It's set for a - HyperparameterTuningJob's Trial. - type: string - readOnly: true - startTime: - readOnly: true - description: Output only. Time when the Trial was started. - format: google-datetime - type: string - infeasibleReason: - description: >- - Output only. A human readable string describing why the Trial is - infeasible. This is set only if Trial state is `INFEASIBLE`. - readOnly: true type: string - endTime: - format: google-datetime - readOnly: true + description: The parameters for the NasJob NasTrial. + description: >- + Represents a NasTrial details along with its parameters. If there is a + corresponding train NasTrial, the train NasTrial is also returned. + id: GoogleCloudAiplatformV1NasTrialDetail + GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion: + type: object + id: GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion + properties: + endpoint: description: >- - Output only. Time when the Trial's status changed to `SUCCEEDED` or - `INFEASIBLE`. + The ml.googleapis.com endpoint that this model Version currently + lives in. Example values: * ml.googleapis.com * + us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * + asia-east1-ml.googleapis.com type: string - finalMeasurement: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - description: Output only. The final measurement containing the objective value. - readOnly: true - measurements: + version: description: >- - Output only. A list of measurements that are strictly - lexicographically ordered by their induced tuples (steps, - elapsed_duration). These are used for early stopping computations. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - readOnly: true - id: - description: Output only. The identifier of the Trial assigned by the service. - readOnly: true - type: string - clientId: + Full resource name of ml engine model Version. Format: + `projects/{project}/models/{model}/versions/{version}`. type: string - readOnly: true - description: >- - Output only. The identifier of the client that originally requested - this Trial. Each client is identified by a unique client_id. When a - client asks for a suggestion, Vertex AI Vizier will assign it a - Trial. The client should evaluate the Trial, complete it, and report - back to Vertex AI Vizier. If suggestion is asked again by same - client_id before the Trial is completed, the same Trial will be - returned. Multiple clients with different client_ids can ask for - suggestions simultaneously, each of them will get their own Trial. - description: >- - A message representing a Trial. A Trial contains a unique set of - Parameters that has been or will be evaluated, along with the objective - metrics got by running the Trial. - id: GoogleCloudAiplatformV1Trial - GoogleCloudAiplatformV1SupervisedHyperParameters: + description: Represents one model Version in ml.googleapis.com. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata: properties: - learningRateMultiplier: - type: number - description: Optional. Multiplier for adjusting the default learning rate. - format: double - adapterSize: - enum: - - ADAPTER_SIZE_UNSPECIFIED - - ADAPTER_SIZE_ONE - - ADAPTER_SIZE_FOUR - - ADAPTER_SIZE_EIGHT - - ADAPTER_SIZE_SIXTEEN - - ADAPTER_SIZE_THIRTY_TWO - description: Optional. Adapter size for tuning. + successfulStopReason: type: string - enumDescriptions: - - Adapter size is unspecified. - - Adapter size 1. - - Adapter size 4. - - Adapter size 8. - - Adapter size 16. - - Adapter size 32. - epochCount: + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED description: >- - Optional. Number of complete passes the model makes over the entire - training dataset during training. + For successful job completions, this is the reason why the job has + finished. + enumDescriptions: + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. + - >- + Further training of the Model ceased to increase its quality, + since it already has converged. + costMilliNodeHours: type: string format: int64 + description: >- + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. type: object - description: Hyperparameters for SFT. - id: GoogleCloudAiplatformV1SupervisedHyperParameters - GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity: + description: Response message if the request uses the SelectEntity option. + id: GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity properties: - objective: + onlineStorageDeletedEntityCount: + format: int64 + description: >- + The count of deleted entities in the online storage. Each entity ID + corresponds to one entity. type: string - enum: - - OBJECTIVE_UNSPECIFIED - - IMPORT_FEATURE_ANALYSIS - - SNAPSHOT_ANALYSIS - enumDescriptions: - - If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty. - - Stats are generated by Import Feature Analysis. - - Stats are generated by Snapshot Analysis. - description: Output only. The objective for each stats. - readOnly: true - featureStatsAnomaly: - readOnly: true + offlineStorageDeletedEntityRowCount: description: >- - Output only. The stats and anomalies generated at specific - timestamp. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - id: GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly - description: >- - A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats - requested by user, sorted by FeatureStatsAnomaly.start_time descending. - type: object - GoogleCloudAiplatformV1Tensor: - description: A tensor value type. - id: GoogleCloudAiplatformV1Tensor + The count of deleted entity rows in the offline storage. Each row + corresponds to the combination of an entity ID and a timestamp. One + entity ID can have multiple rows in the offline storage. + type: string + format: int64 type: object + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig: + description: >- + Config for migrating Dataset in datalabeling.googleapis.com to Vertex + AI's Dataset. properties: - tensorVal: - format: byte - description: Serialized raw tensor content. - type: string - listVal: - description: A list of tensor values. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - floatVal: - description: FLOAT + migrateDataLabelingAnnotatedDatasetConfigs: items: - format: float - type: number + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig type: array - boolVal: description: >- - Type specific representations that make it easy to create tensor - protos in all languages. Only the representation corresponding to - "dtype" can be set. The values hold the flattened representation of - the tensor in row major order. BOOL - items: - type: boolean - type: array - int64Val: - description: INT64 - type: array - items: - type: string - format: int64 - dtype: - enumDescriptions: - - >- - Not a legal value for DataType. Used to indicate a DataType field - has not been set. - - >- - Data types that all computation devices are expected to be capable - to support. - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - description: The data type of tensor. + Optional. Configs for migrating AnnotatedDataset in + datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified + AnnotatedDatasets have to belong to the datalabeling Dataset. + dataset: + type: string + description: >- + Required. Full resource name of data labeling Dataset. Format: + `projects/{project}/datasets/{dataset}`. + datasetDisplayName: + description: >- + Optional. Display name of the Dataset in Vertex AI. System will pick + a display name if unspecified. type: string - enum: - - DATA_TYPE_UNSPECIFIED - - BOOL - - STRING - - FLOAT - - DOUBLE - - INT8 - - INT16 - - INT32 - - INT64 - - UINT8 - - UINT16 - - UINT32 - - UINT64 - stringVal: - type: array - description: STRING - items: - type: string - uintVal: - items: - type: integer - format: uint32 - type: array - description: UINT8 UINT16 UINT32 - intVal: - description: INT_8 INT_16 INT_32 - items: - type: integer - format: int32 - type: array - doubleVal: - description: DOUBLE - items: - format: double - type: number - type: array - structVal: - description: A map of string to tensor. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - type: object - shape: - type: array - description: Shape of the tensor. - items: - format: int64 - type: string - uint64Val: - description: UINT64 - items: - type: string - format: uint64 - type: array - bytesVal: - description: STRING - type: array - items: - format: byte - type: string - GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: type: object - id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + GoogleCloudAiplatformV1ListAnnotationsResponse: properties: - allowedIssuers: - items: - type: string + annotations: type: array description: >- - A list of allowed JWT issuers. Each entry must be a valid Google - service account, in the following format: - `service-account-name@project-id.iam.gserviceaccount.com` - audiences: + A list of Annotations that matches the specified filter in the + request. items: - type: string - description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. - type: array - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' + nextPageToken: + type: string + description: The standard List next-page token. + description: Response message for DatasetService.ListAnnotations. + type: object + id: GoogleCloudAiplatformV1ListAnnotationsResponse + GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: type: object - description: Details of operations that perform create FeatureGroup. properties: genericMetadata: + description: Operation metadata for FeatureView Create. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureGroup. - id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata - GoogleCloudAiplatformV1Annotation: - description: >- - Used to assign specific AnnotationSpec to a particular area of a - DataItem or the whole part of the DataItem. + description: Details of operations that perform create FeatureView. + id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata + GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec: + id: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec + type: object properties: - payloadSchemaUri: - type: string - description: >- - Required. Google Cloud Storage URI points to a YAML file describing - payload. The schema is defined as an [OpenAPI 3.0.2 Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/, note that - the chosen schema must be consistent with the parent Dataset's - metadata. - updateTime: - format: google-datetime - description: Output only. Timestamp when this Annotation was last updated. - readOnly: true - type: string - labels: - additionalProperties: - type: string + maxReplicaCount: description: >- - Optional. The labels with user-defined metadata to organize your - Annotations. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. No more than 64 user labels can be associated with one - Annotation(System labels are excluded). See https://goo.gl/xmQnxf - for more information and examples of labels. System reserved label - keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. Following system labels exist for each Annotation: * - "aiplatform.googleapis.com/annotation_set_name": optional, name of - the UI's annotation set this Annotation belongs to. If not set, the - Annotation is not visible in the UI. * - "aiplatform.googleapis.com/payload_schema": output only, its value - is the payload_schema's title. - type: object - etag: + Optional. max replicas in the node pool, must be ≥ replica_count and + > min_replica_count or will throw error type: string + format: int64 + minReplicaCount: + format: int64 description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - annotationSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UserActionReference' - readOnly: true - description: Output only. The source of the Annotation. - payload: - type: any - description: Required. The schema of the payload can be found in payload_schema. - name: - description: Output only. Resource name of the Annotation. - type: string - readOnly: true - createTime: - description: Output only. Timestamp when this Annotation was created. - readOnly: true - format: google-datetime + Optional. min replicas in the node pool, must be ≤ replica_count and + < max_replica_count or will throw error. For autoscaling enabled + Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 + to match the OSS Ray + behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). + As for Persistent Resource, the min_replica_count must be > 0, we + added a corresponding validation inside + CreatePersistentResourceRequestValidator.java. type: string + description: The min/max number of replicas allowed if enabling autoscaling + GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry: + id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry + description: Single source entry for the grounding checking. type: object - id: GoogleCloudAiplatformV1Annotation - GoogleCloudAiplatformV1ImportDataRequest: - description: Request message for DatasetService.ImportData. - properties: - importConfigs: - description: >- - Required. The desired input locations. The contents of all input - locations will be imported in one batch. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataConfig' - type: object - id: GoogleCloudAiplatformV1ImportDataRequest - GoogleCloudAiplatformV1ExplanationMetadataOverride: - properties: - inputs: - description: >- - Required. Overrides the input metadata of the features. The key is - the name of the feature to be overridden. The keys specified here - must exist in the input metadata to be overridden. If a feature is - not specified here, the corresponding feature's input metadata is - not overridden. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride - type: object - description: >- - The ExplanationMetadata entries that can be overridden at online - explanation time. - type: object - id: GoogleCloudAiplatformV1ExplanationMetadataOverride - GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset: - id: >- - GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset - type: object - description: Represents one AnnotatedDataset in datalabeling.googleapis.com. properties: - annotatedDataset: + inlineContext: type: string description: >- - Full resource name of data labeling AnnotatedDataset. Format: - `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. - annotatedDatasetDisplayName: + The grounding text passed inline with the Predict API. It can + support up to 1 million bytes. + vertexAiSearchDatastore: type: string - description: The AnnotatedDataset's display name in datalabeling.googleapis.com. - GoogleCloudAiplatformV1NasJobSpec: - description: Represents the spec of a NasJob. - properties: - searchSpaceSpec: + description: The uri of the Vertex AI Search data source. + type: + description: The type of the grounding checking source. + enumDeprecated: + - false + - false + - true + - false + - false type: string - description: It defines the search space for Neural Architecture Search (NAS). - multiTrialAlgorithmSpec: - description: The spec of multi-trial algorithms. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec - resumeNasJobId: + enum: + - UNSPECIFIED + - WEB + - ENTERPRISE + - VERTEX_AI_SEARCH + - INLINE + enumDescriptions: + - '' + - Uses Web Search to check the grounding. + - >- + Uses Vertex AI Search to check the grounding. Deprecated. Use + VERTEX_AI_SEARCH instead. + - Uses Vertex AI Search to check the grounding + - Uses inline context to check the grounding. + enterpriseDatastore: type: string description: >- - The ID of the existing NasJob in the same Project and Location which - will be used to resume search. search_space_spec and - nas_algorithm_spec are obtained from previous NasJob hence should - not provide them again for this NasJob. - type: object - id: GoogleCloudAiplatformV1NasJobSpec - GoogleCloudAiplatformV1Scalar: - type: object - description: One point viewable on a scalar metric plot. - id: GoogleCloudAiplatformV1Scalar - properties: - value: - format: double - type: number - description: Value of the point at this step / timestamp. - GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult: + The uri of the Vertex AI Search data source. Deprecated. Use + vertex_ai_search_datastore instead. + deprecated: true + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting properties: - textSegmentStartOffsets: - items: - format: int64 - type: string - type: array - description: >- - The start offsets, inclusive, of the text segment in which the - AnnotationSpec has been identified. Expressed as a zero-based number - of characters as measured from the start of the text snippet. - ids: - type: array - description: >- - The resource IDs of the AnnotationSpecs that had been identified, - ordered by the confidence score descendingly. - items: - format: int64 - type: string - confidences: - type: array - items: - format: float - type: number - description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. - textSegmentEndOffsets: - items: - format: int64 - type: string - type: array - description: >- - The end offsets, inclusive, of the text segment in which the - AnnotationSpec has been identified. Expressed as a zero-based number - of characters as measured from the start of the text snippet. - displayNames: - items: - type: string - description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. - type: array - description: Prediction output format for Text Extraction. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult - type: object - GoogleCloudAiplatformV1SummarizationHelpfulnessSpec: + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + description: The metadata information. + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs + description: The input parameters of this TrainingJob. type: object - id: GoogleCloudAiplatformV1SummarizationHelpfulnessSpec - properties: - version: - description: Optional. Which version to use for evaluation. - format: int32 - type: integer - useReference: - type: boolean - description: >- - Optional. Whether to use instance.reference to compute summarization - helpfulness. - description: Spec for summarization helpfulness score metric. - GoogleCloudAiplatformV1MetadataStoreMetadataStoreState: - id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState - description: Represents state information for a MetadataStore. - properties: - diskUtilizationBytes: - type: string - description: The disk utilization of the MetadataStore in bytes. - format: int64 + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + GoogleCloudAiplatformV1DeployedModel: + description: A deployment of a Model. Endpoints contain one or more DeployedModels. type: object - GoogleCloudAiplatformV1FileData: properties: - fileUri: + displayName: type: string - description: Required. URI. - mimeType: - description: Required. The IANA standard MIME type of the source data. + description: >- + The display name of the DeployedModel. If not provided upon + creation, the Model's display_name is used. + modelVersionId: type: string - type: object - description: URI based data. - id: GoogleCloudAiplatformV1FileData - GoogleCloudAiplatformV1NotebookExecutionJob: - properties: - serviceAccount: - description: The service account to run the execution as. + readOnly: true + description: Output only. The version ID of the model that is deployed. + model: type: string + description: >- + Required. The resource name of the Model that this is the deployment + of. Note that the Model may be in a different location than the + DeployedModel's Endpoint. The resource name may contain version id + or version alias to specify the version. Example: + `projects/{project}/locations/{location}/models/{model}@2` or + `projects/{project}/locations/{location}/models/{model}@golden` if + no version is specified, the default version will be deployed. createTime: - description: Output only. Timestamp when this NotebookExecutionJob was created. - readOnly: true type: string + readOnly: true format: google-datetime - status: + description: Output only. Timestamp when the DeployedModel was created. + disableExplanations: description: >- - Output only. Populated when the NotebookExecutionJob is completed. - When there is an error during notebook execution, the error details - are populated. - $ref: '#/components/schemas/GoogleRpcStatus' + If true, deploy the model without explainable feature, regardless + the existence of Model.explanation_spec or explanation_spec. + type: boolean + privateEndpoints: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' + description: >- + Output only. Provide paths for users to send predict/explain/health + requests directly to the deployed model services running on Cloud + via private services access. This field is populated if network is + configured. readOnly: true - gcsOutputUri: + disableContainerLogging: + type: boolean description: >- - The Cloud Storage location to upload the result to. Format: - `gs://bucket-name` + For custom-trained Models and AutoML Tabular Models, the container + of the DeployedModel instances will send `stderr` and `stdout` + streams to Cloud Logging by default. Please note that the logs incur + cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging/pricing). User can disable + container logging by setting this flag to true. + explanationSpec: + description: >- + Explanation configuration for this DeployedModel. When deploying a + Model using EndpointService.DeployModel, this value overrides the + value of Model.explanation_spec. All fields of explanation_spec are + optional in the request. If a field of explanation_spec is not + populated, the value of the same field of Model.explanation_spec is + inherited. If the corresponding Model.explanation_spec is not + populated, all fields of the explanation_spec will be used for the + explanation configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + automaticResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + description: >- + A description of resources that to large degree are decided by + Vertex AI, and require only a modest additional configuration. + enableAccessLogging: + type: boolean + description: >- + If true, online prediction access logs are sent to Cloud Logging. + These logs are like standard server access logs, containing + information like timestamp and latency for each prediction request. + Note that logs may incur a cost, especially if your project receives + prediction requests at a high queries per second rate (QPS). + Estimate your costs before enabling this option. + sharedResources: type: string - gcsNotebookSource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource description: >- - The Cloud Storage url pointing to the ipynb file. Format: - `gs://bucket/notebook_file.ipynb` - directNotebookSource: - description: The contents of an input notebook file. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource - updateTime: - format: google-datetime + The resource name of the shared DeploymentResourcePool to deploy on. + Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + serviceAccount: + type: string description: >- - Output only. Timestamp when this NotebookExecutionJob was most - recently updated. - readOnly: true + The service account that the DeployedModel's container runs as. + Specify the email address of the service account. If this service + account is not specified, the container runs as a service account + that doesn't have access to the resource project. Users deploying + the Model must have the `iam.serviceAccounts.actAs` permission on + this service account. + id: + description: >- + Immutable. The ID of the DeployedModel. If not provided upon + deployment, Vertex AI will generate a value for this ID. This value + should be 1-10 characters, and valid characters are `/[0-9]/`. type: string - executionTimeout: - format: google-duration + dedicatedResources: description: >- - Max running time of the execution job in seconds (default 86400s / - 24 hrs). + A description of resources that are dedicated to the DeployedModel, + and that need a higher degree of manual configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + id: GoogleCloudAiplatformV1DeployedModel + GoogleCloudAiplatformV1ListBatchPredictionJobsResponse: + id: GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + type: object + description: Response message for JobService.ListBatchPredictionJobs + properties: + batchPredictionJobs: + description: List of BatchPredictionJobs in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + type: array + nextPageToken: type: string - name: - readOnly: true description: >- - Output only. The resource name of this NotebookExecutionJob. Format: - `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` + A token to retrieve the next page of results. Pass to + ListBatchPredictionJobsRequest.page_token to obtain that page. + GoogleCloudAiplatformV1Annotation: + properties: + payloadSchemaUri: type: string - jobState: - description: Output only. The state of the NotebookExecutionJob. - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED + description: >- + Required. Google Cloud Storage URI points to a YAML file describing + payload. The schema is defined as an [OpenAPI 3.0.2 Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/, note that + the chosen schema must be consistent with the parent Dataset's + metadata. + payload: + type: any + description: Required. The schema of the payload can be found in payload_schema. + createTime: readOnly: true - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. type: string - notebookRuntimeTemplateResourceName: + format: google-datetime + description: Output only. Timestamp when this Annotation was created. + annotationSource: + description: Output only. The source of the Annotation. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1UserActionReference' + etag: type: string - description: The NotebookRuntimeTemplate to source compute configuration from. - displayName: description: >- - The display name of the NotebookExecutionJob. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - type: string + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. labels: description: >- - The labels with user-defined metadata to organize - NotebookExecutionJobs. Label keys and values can be no longer than - 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. System reserved label keys are - prefixed with "aiplatform.googleapis.com/" and are immutable. + Optional. The labels with user-defined metadata to organize your + Annotations. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. No more than 64 user labels can be associated with one + Annotation(System labels are excluded). See https://goo.gl/xmQnxf + for more information and examples of labels. System reserved label + keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. Following system labels exist for each Annotation: * + "aiplatform.googleapis.com/annotation_set_name": optional, name of + the UI's annotation set this Annotation belongs to. If not set, the + Annotation is not visible in the UI. * + "aiplatform.googleapis.com/payload_schema": output only, its value + is the payload_schema's title. type: object additionalProperties: type: string - scheduleResourceName: - description: >- - Output only. The Schedule resource name if this job is triggered by - one. Format: - `projects/{project_id}/locations/{location}/schedules/{schedule_id}` + name: + description: Output only. Resource name of the Annotation. + readOnly: true type: string + updateTime: + description: Output only. Timestamp when this Annotation was last updated. readOnly: true - dataformRepositorySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource - description: >- - The Dataform Repository pointing to a single file notebook - repository. - executionUser: - description: >- - The user email to run the execution as. Only supported by Colab - runtimes. type: string - encryptionSpec: - description: >- - Customer-managed encryption key spec for the notebook execution job. - This field is auto-populated if the - NotebookService.NotebookRuntimeTemplate has an encryption spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + format: google-datetime type: object - description: NotebookExecutionJob represents an instance of a notebook execution. - id: GoogleCloudAiplatformV1NotebookExecutionJob - GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter: - id: GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter description: >- - Numeric filter is used to search a subset of the entities by using - boolean rules on numeric columns. For example: Database Point 0: {name: - "a" value_int: 42} {name: "b" value_float: 1.0} Database Point 1: {name: - "a" value_int: 10} {name: "b" value_float: 2.0} Database Point 2: {name: - "a" value_int: -1} {name: "b" value_float: 3.0} Query: {name: "a" - value_int: 12 operator: LESS} // Matches Point 1, 2 {name: "b" - value_float: 2.0 operator: EQUAL} // Matches Point 1 + Used to assign specific AnnotationSpec to a particular area of a + DataItem or the whole part of the DataItem. + id: GoogleCloudAiplatformV1Annotation + GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics type: object + description: Metrics for general pairwise text generation evaluation results. properties: - valueInt: - format: int64 - description: int value type. - type: string - valueDouble: + humanPreferenceModelWinRate: + format: float type: number - description: double value type. - format: double - op: - enum: - - OPERATOR_UNSPECIFIED - - LESS - - LESS_EQUAL - - EQUAL - - GREATER_EQUAL - - GREATER - - NOT_EQUAL + description: Percentage of time humans decided the model had the better response. + precision: + type: number + format: float description: >- - Optional. This MUST be specified for queries and must NOT be - specified for database points. + Fraction of cases where the autorater and humans thought the model + had a better response out of all cases where the autorater thought + the model had a better response. True positive divided by all + positive. + falsePositiveCount: + format: int64 + description: >- + Number of examples where the autorater chose the model, but humans + preferred the baseline model. type: string - enumDescriptions: - - Unspecified operator. - - Entities are eligible if their value is < the query's. - - Entities are eligible if their value is <= the query's. - - Entities are eligible if their value is == the query's. - - Entities are eligible if their value is >= the query's. - - Entities are eligible if their value is > the query's. - - Entities are eligible if their value is != the query's. - name: + trueNegativeCount: type: string - description: Required. Column name in BigQuery that used as filters. - valueFloat: - description: float value type. + format: int64 + description: >- + Number of examples where both the autorater and humans decided that + the model had the worse response. + modelWinRate: + type: number + description: >- + Percentage of time the autorater decided the model had the better + response. + format: float + humanPreferenceBaselineModelWinRate: + description: >- + Percentage of time humans decided the baseline model had the better + response. + type: number format: float + f1Score: type: number - GoogleCloudAiplatformV1ReadTensorboardSizeResponse: - description: Response message for TensorboardService.ReadTensorboardSize. - properties: - storageSizeByte: - description: Payload storage size for the TensorBoard + description: Harmonic mean of precision and recall. + format: float + accuracy: + format: float + description: Fraction of cases where the autorater agreed with the human raters. + type: number + baselineModelWinRate: + format: float + type: number + description: >- + Percentage of time the autorater decided the baseline model had the + better response. + recall: + description: >- + Fraction of cases where the autorater and humans thought the model + had a better response out of all cases where the humans thought the + model had a better response. + type: number + format: float + cohensKappa: + type: number + description: >- + A measurement of agreement between the autorater and human raters + that takes the likelihood of random agreement into account. + format: float + truePositiveCount: + description: >- + Number of examples where both the autorater and humans decided that + the model had the better response. + format: int64 type: string + falseNegativeCount: + description: >- + Number of examples where the autorater chose the baseline model, but + humans preferred the model. format: int64 - id: GoogleCloudAiplatformV1ReadTensorboardSizeResponse - type: object - GoogleCloudAiplatformV1CoherenceSpec: - properties: - version: - type: integer - description: Optional. Which version to use for evaluation. - format: int32 - description: Spec for coherence score metric. - id: GoogleCloudAiplatformV1CoherenceSpec - type: object - GoogleCloudAiplatformV1ReadFeatureValuesResponse: - id: GoogleCloudAiplatformV1ReadFeatureValuesResponse - description: Response message for FeaturestoreOnlineServingService.ReadFeatureValues. - properties: - header: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader - description: Response header. - entityView: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView - description: >- - Entity view with Feature values. This may be the entity in the - Featurestore if values for all Features were requested, or a - projection of the entity in the Featurestore if values for only some - Features were requested. - type: object - GoogleCloudAiplatformV1ReadTensorboardUsageResponse: - properties: - monthlyUsageData: - description: Maps year-month (YYYYMM) string to per month usage data. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData - type: object - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponse - description: Response message for TensorboardService.ReadTensorboardUsage. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation: - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation - properties: - columnName: type: string - description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Tokenize text to words. Convert each words to a dictionary lookup - index and generate an embedding for each index. Combine the embedding of - all elements into a single embedding using the mean. * Tokenization is - based on unicode script boundaries. * Missing values get their own - lookup index and resulting embedding. * Stop-words receive no special - treatment and are not removed. - GoogleCloudAiplatformV1VertexRagStore: - properties: - vectorDistanceThreshold: - type: number - format: double - description: >- - Optional. Only return results with vector distance smaller than the - threshold. - similarityTopK: - type: integer - format: int32 - description: >- - Optional. Number of top k results to return from the selected - corpora. - ragCorpora: - deprecated: true - description: Optional. Deprecated. Please use rag_resources instead. - type: array - items: - type: string - ragResources: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1VertexRagStoreRagResource - description: >- - Optional. The representation of the rag source. It can be used to - specify corpus only or ragfiles. Currently only support one corpus - or multiple files from one corpus. In the future we may open up - multiple corpora support. - type: array - description: Retrieve from Vertex RAG Store for grounding. - id: GoogleCloudAiplatformV1VertexRagStore - type: object - GoogleCloudAiplatformV1CancelDataLabelingJobRequest: - properties: {} - description: Request message for JobService.CancelDataLabelingJob. - id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest - type: object - GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: properties: genericMetadata: + description: Operation metadata for suggesting Trials. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore batch read Features values. - type: object - id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata - description: Details of operations that batch reads Feature values. - GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature: - description: Noise sigma for a single feature. - properties: - name: - description: >- - The name of the input feature for which noise sigma is provided. The - features are defined in explanation metadata inputs. + study: type: string - sigma: - format: float - type: number - description: >- - This represents the standard deviation of the Gaussian kernel that - will be used to add noise to the feature prior to computing - gradients. Similar to noise_sigma but represents the noise added to - the current feature. Defaults to 0.1. - id: GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature - type: object - GoogleCloudAiplatformV1FluencyResult: - properties: - confidence: - description: Output only. Confidence for fluency score. - format: float - type: number - readOnly: true - score: - type: number - format: float - description: Output only. Fluency score. - readOnly: true - explanation: - readOnly: true + description: The name of the Study that the Trial belongs to. + trial: type: string - description: Output only. Explanation for fluency score. - description: Spec for fluency result. - id: GoogleCloudAiplatformV1FluencyResult + description: The Trial name. + type: object + description: >- + This message will be placed in the metadata field of a + google.longrunning.Operation associated with a + CheckTrialEarlyStoppingState request. + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata + GoogleCloudAiplatformV1PscAutomatedEndpoints: + id: GoogleCloudAiplatformV1PscAutomatedEndpoints + description: >- + PscAutomatedEndpoints defines the output of the forwarding rule + automatically created by each PscAutomationConfig. type: object - GoogleCloudAiplatformV1VideoMetadata: - description: Metadata describes the input video content. properties: - endOffset: - format: google-duration - description: Optional. The end offset of the video. + projectId: type: string - startOffset: - format: google-duration + description: Corresponding project_id in pscAutomationConfigs + network: + description: Corresponding network in pscAutomationConfigs. type: string - description: Optional. The start offset of the video. - id: GoogleCloudAiplatformV1VideoMetadata - type: object - GoogleCloudAiplatformV1PurgeContextsResponse: + matchAddress: + type: string + description: Ip Address created by the automated forwarding rule. + GoogleCloudAiplatformV1CustomJobSpec: + description: Represents the spec of a CustomJob. + id: GoogleCloudAiplatformV1CustomJobSpec properties: - purgeCount: - format: int64 + scheduling: + description: Scheduling options for a CustomJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' + persistentResourceId: type: string description: >- - The number of Contexts that this request deleted (or, if `force` is - false, the number of Contexts that will be deleted). This can be an - estimate. - purgeSample: - items: - type: string + Optional. The ID of the PersistentResource in the same Project and + Location which to run If this is specified, the job will be run on + existing machines held by the PersistentResource instead of + on-demand short-live machines. The network and CMEK configs on the + job should be consistent with those on the PersistentResource, + otherwise, the job will be rejected. + baseOutputDirectory: description: >- - A sample of the Context names that will be deleted. Only populated - if `force` is set to false. The maximum number of samples is 100 (it - is possible to return fewer). - type: array - id: GoogleCloudAiplatformV1PurgeContextsResponse - description: Response message for MetadataService.PurgeContexts. - type: object - GoogleCloudAiplatformV1FindNeighborsResponse: - description: The response message for MatchService.FindNeighbors. - type: object - properties: - nearestNeighbors: - description: The nearest neighbors of the query datapoints. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors - id: GoogleCloudAiplatformV1FindNeighborsResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs: - properties: - targetColumn: - type: string + The Cloud Storage location to store the output of this CustomJob or + HyperparameterTuningJob. For HyperparameterTuningJob, the + baseOutputDirectory of each child CustomJob backing a Trial is set + to a subdirectory of name id under its parent + HyperparameterTuningJob's baseOutputDirectory. The following Vertex + AI environment variables will be passed to containers or python + modules when this field is set: For CustomJob: * AIP_MODEL_DIR = + `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * + AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of + HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * + AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = + `//logs/` + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + experimentRun: description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. - contextWindow: + Optional. The Experiment Run associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` + type: string + protectedArtifactLocationId: type: string - format: int64 - description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. - exportEvaluatedDataItemsConfig: description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - enableProbabilisticInference: + The ID of the location to store protected artifacts. e.g. + us-central1. Populate only when the location is different than + CustomJob location. List of supported locations: + https://cloud.google.com/vertex-ai/docs/general/locations + serviceAccount: description: >- - If probabilistic inference is enabled, the model will fit a - distribution that captures the uncertainty of a prediction. At - inference time, the predictive distribution is used to make a point - prediction that minimizes the optimization objective. For example, - the mean of a predictive distribution is the point prediction that - minimizes RMSE loss. If quantiles are specified, then the quantiles - of the distribution are also returned. The optimization objective - cannot be minimize-quantile-loss. - type: boolean - validationOptions: + Specifies the service account for workload run-as account. Users + submitting jobs must have act-as permission on this run-as account. + If unspecified, the [Vertex AI Custom Code Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + for the CustomJob's project is used. type: string + workerPoolSpecs: description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue - quantiles: + Required. The spec of the worker pools including machine type and + Docker image. All worker pools except the first one are optional and + can be skipped by providing an empty value. items: - format: double - type: number - description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`, or for probabilistic inference. Up to 5 - quantiles are allowed of values between 0 and 1, exclusive. Required - if the value of optimization_objective is minimize-quantile-loss. - Represents the percent quantiles to use for that objective. - Quantiles must be unique. + $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' type: array - weightColumn: + enableDashboardAccess: + type: boolean description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. - type: string - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. - type: string - trainBudgetMilliNodeHours: - format: int64 + Optional. Whether you want Vertex AI to enable access to the + customized dashboard in training chief container. If set to `true`, + you can access the dashboard at the URIs given by + CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + network: type: string description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. - unavailableAtForecastColumns: - items: - type: string - description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. - type: array - timeColumn: - type: string + Optional. The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to which + the Job should be peered. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + To specify this field, you must have already [configured VPC Network + Peering for Vertex + AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If + this field is left unspecified, the job is not peered with any + network. + enableWebAccess: + type: boolean description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. - additionalExperiments: - items: - type: string - type: array - description: Additional experiment flags for the time series forcasting training. - optimizationObjective: + Optional. Whether you want Vertex AI to enable [interactive shell + access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + to training containers. If set to `true`, you can access interactive + shells at the URIs given by CustomJob.web_access_uris or + Trial.web_access_uris (within HyperparameterTuningJob.trials). + experiment: type: string description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. - transformations: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation - description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. + Optional. The Experiment associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` + reservedIpRanges: type: array - availableAtForecastColumns: items: type: string - type: array description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. - windowConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - description: Config containing strategy for generating sliding windows. - holidayRegions: + Optional. A list of names for the reserved ip ranges under the VPC + network that can be used for this job. If set, we will deploy the + job within the provided ip ranges. Otherwise, the job will be + deployed to any ip ranges under the provided VPC network. Example: + ['vertex-ai-ip-range']. + tensorboard: + type: string + description: >- + Optional. The name of a Vertex AI Tensorboard resource to which this + CustomJob will upload Tensorboard logs. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + models: type: array description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. + Optional. The name of the Model resources for which to generate a + mapping to artifact URIs. Applicable only to some of the + Google-provided custom jobs. 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. items: type: string - hierarchyConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + type: object + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation: + properties: + annotationSpecId: description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - dataGranularity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity - description: Expected difference in time granularity between rows in the data. - forecastHorizon: + The resource Id of the AnnotationSpec that this Annotation pertains + to. type: string - format: int64 - description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - timeSeriesAttributeColumns: + vertexes: items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' type: array description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs - GoogleCloudAiplatformV1RebootPersistentResourceRequest: - id: GoogleCloudAiplatformV1RebootPersistentResourceRequest - description: Request message for PersistentResourceService.RebootPersistentResource. - type: object - properties: {} - GoogleCloudAiplatformV1ToolNameMatchInstance: - description: Spec for tool name match instance. - id: GoogleCloudAiplatformV1ToolNameMatchInstance - type: object - properties: - reference: - description: Required. Ground truth used to compare against the prediction. - type: string - prediction: - description: Required. Output of the evaluated model. - type: string - GoogleCloudAiplatformV1SchemaTextClassificationAnnotation: - properties: + The vertexes are connected one by one and the last vertex in not + connected to the first one. displayName: - type: string description: >- The display name of the AnnotationSpec that this Annotation pertains to. - annotationSpecId: - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. type: string + description: Represents a polyline in image. + id: >- + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation type: object - description: Annotation details specific to text classification. - id: GoogleCloudAiplatformV1SchemaTextClassificationAnnotation - GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies: - description: Statistics and anomalies generated by Model Monitoring. + GoogleTypeMoney: properties: - featureStats: - description: A list of historical Stats and Anomalies generated for all Features. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies - objective: - enumDescriptions: - - Default value, should not be set. - - >- - Raw feature values' stats to detect skew between - Training-Prediction datasets. - - >- - Raw feature values' stats to detect drift between - Serving-Prediction datasets. - - >- - Feature attribution scores to detect skew between - Training-Prediction datasets. - - >- - Feature attribution scores to detect skew between Prediction - datasets collected within different time windows. - enum: - - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED - - RAW_FEATURE_SKEW - - RAW_FEATURE_DRIFT - - FEATURE_ATTRIBUTION_SKEW - - FEATURE_ATTRIBUTION_DRIFT - description: Model Monitoring Objective those stats and anomalies belonging to. + currencyCode: type: string - deployedModelId: + description: The three-letter currency code defined in ISO 4217. + units: type: string - description: Deployed Model ID. - anomalyCount: - format: int32 + format: int64 + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + nanos: type: integer - description: Number of anomalies within all stats. - id: GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies - type: object - GoogleCloudAiplatformV1LookupStudyRequest: - description: Request message for VizierService.LookupStudy. - id: GoogleCloudAiplatformV1LookupStudyRequest - properties: - displayName: - description: Required. The user-defined display name of the Study - type: string + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + format: int32 + description: Represents an amount of money with its currency type. + id: GoogleTypeMoney type: object - GoogleCloudAiplatformV1ResourcePool: - id: GoogleCloudAiplatformV1ResourcePool + GoogleCloudAiplatformV1Feature: + id: GoogleCloudAiplatformV1Feature type: object - description: >- - Represents the spec of a group of resources of the same type, for - example machine type, disk, and accelerators, in a PersistentResource. properties: - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - description: Required. Immutable. The specification of a single machine. - usedReplicaCount: - format: int64 + versionColumnName: type: string + description: >- + Only applicable for Vertex AI Feature Store. The name of the + BigQuery Table/View column hosting data for this version. If no + value is provided, will use feature_id. + updateTime: readOnly: true + type: string description: >- - Output only. The number of machines currently in use by training - jobs for this resource pool. Will replace idle_replica_count. - diskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - description: Optional. Disk spec for the machine in this node pool. - id: + Output only. Only applicable for Vertex AI Feature Store (Legacy). + Timestamp when this EntityType was most recently updated. + format: google-datetime + disableMonitoring: + type: boolean description: >- - Immutable. The unique ID in a PersistentResource for referring to - this resource pool. User can specify it if necessary. Otherwise, - it's generated automatically. + Optional. Only applicable for Vertex AI Feature Store (Legacy). If + not set, use the monitoring_config defined for the EntityType this + Feature belongs to. Only Features with type (Feature.ValueType) + BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, + all types of data monitoring are disabled despite the config on + EntityType. + createTime: + format: google-datetime + description: >- + Output only. Only applicable for Vertex AI Feature Store (Legacy). + Timestamp when this EntityType was created. type: string - replicaCount: + readOnly: true + description: + description: Description of the Feature. type: string - description: >- - Optional. The total number of machines to use for this resource - pool. - format: int64 - autoscalingSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec - description: >- - Optional. Optional spec to configure GKE or Ray-on-Vertex - autoscaling - GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata: - description: Details of operations that perform update Tensorboard. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Tensorboard. - type: object - id: GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata - GoogleCloudAiplatformV1ListMetadataSchemasResponse: - description: Response message for MetadataService.ListMetadataSchemas. - id: GoogleCloudAiplatformV1ListMetadataSchemasResponse - type: object - properties: - metadataSchemas: - description: The MetadataSchemas found for the MetadataStore. - type: array + monitoringStatsAnomalies: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' - nextPageToken: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly description: >- - A token, which can be sent as ListMetadataSchemasRequest.page_token - to retrieve the next page. If this field is not populated, there are - no subsequent pages. - type: string - GoogleCloudAiplatformV1BigQuerySource: - properties: - inputUri: + Output only. Only applicable for Vertex AI Feature Store (Legacy). + The list of historical stats and anomalies with specified + objectives. + readOnly: true + type: array + name: description: >- - Required. BigQuery URI to a table, up to 2000 characters long. - Accepted forms: * BigQuery path. For example: - `bq://projectId.bqDatasetId.bqTableId`. + 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. type: string - description: The BigQuery location for the input content. - type: object - id: GoogleCloudAiplatformV1BigQuerySource - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue: - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue - description: Single value that supports strings and floats. - properties: - stringValue: - description: String type. + etag: type: string - floatValue: - format: float - type: number - description: Float type. - type: object - GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance: - type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance - description: Prediction input format for Text Sentiment. - properties: - mimeType: description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain - type: string - content: + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + valueType: + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - BOOL_ARRAY + - DOUBLE + - DOUBLE_ARRAY + - INT64 + - INT64_ARRAY + - STRING + - STRING_ARRAY + - BYTES + - STRUCT + enumDescriptions: + - The value type is unspecified. + - Used for Feature that is a boolean. + - Used for Feature that is a list of boolean. + - Used for Feature that is double. + - Used for Feature that is a list of double. + - Used for Feature that is INT64. + - Used for Feature that is a list of INT64. + - Used for Feature that is string. + - Used for Feature that is a list of String. + - Used for Feature that is bytes. + - Used for Feature that is struct. + description: >- + Immutable. Only applicable for Vertex AI Feature Store (Legacy). + Type of Feature value. type: string - description: The text snippet to make the predictions on. - GoogleCloudAiplatformV1TokensInfo: - properties: - tokenIds: - items: - format: int64 - type: string - description: A list of token ids from the input. - type: array - tokens: - description: A list of tokens from the input. - items: + labels: + type: object + additionalProperties: type: string - format: byte - type: array - role: - type: string description: >- - Optional. Optional fields for the role from the corresponding - Content. - id: GoogleCloudAiplatformV1TokensInfo + Optional. The labels with user-defined metadata to organize your + Features. Label keys and values can be no longer than 64 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are + allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one Feature (System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + pointOfContact: + description: >- + Entity responsible for maintaining this feature. Can be comma + separated list of email addresses or URIs. + type: string description: >- - Tokens info with a list of tokens and the corresponding list of token - ids. - type: object - GoogleCloudAiplatformV1SafetyResult: - type: object - description: Spec for safety result. - id: GoogleCloudAiplatformV1SafetyResult + Feature Metadata information. For example, color is a feature that + describes an apple. + GoogleCloudAiplatformV1SchemaPredictionResultError: properties: - score: - readOnly: true - format: float - description: Output only. Safety score. - type: number - explanation: + message: type: string - description: Output only. Explanation for safety score. - readOnly: true - confidence: - type: number - readOnly: true - format: float - description: Output only. Confidence for safety score. - GoogleCloudAiplatformV1SchemaTextDatasetMetadata: + description: Error message with additional details. + status: + type: string + enum: + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS + description: >- + Error status. This will be serialized into the enum name e.g. + "NOT_FOUND". + enumDescriptions: + - 'Not an error; returned on success. HTTP Mapping: 200 OK' + - >- + The operation was cancelled, typically by the caller. HTTP + Mapping: 499 Client Closed Request + - >- + Unknown error. For example, this error may be returned when a + `Status` value received from another address space belongs to an + error space that is not known in this address space. Also errors + raised by APIs that do not return enough error information may be + converted to this error. HTTP Mapping: 500 Internal Server Error + - >- + The client specified an invalid argument. Note that this differs + from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments + that are problematic regardless of the state of the system (e.g., + a malformed file name). HTTP Mapping: 400 Bad Request + - >- + The deadline expired before the operation could complete. For + operations that change the state of the system, this error may be + returned even if the operation has completed successfully. For + example, a successful response from a server could have been + delayed long enough for the deadline to expire. HTTP Mapping: 504 + Gateway Timeout + - >- + Some requested entity (e.g., file or directory) was not found. + Note to server developers: if a request is denied for an entire + class of users, such as gradual feature rollout or undocumented + allowlist, `NOT_FOUND` may be used. If a request is denied for + some users within a class of users, such as user-based access + control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not + Found + - >- + The entity that a client attempted to create (e.g., file or + directory) already exists. HTTP Mapping: 409 Conflict + - >- + The caller does not have permission to execute the specified + operation. `PERMISSION_DENIED` must not be used for rejections + caused by exhausting some resource (use `RESOURCE_EXHAUSTED` + instead for those errors). `PERMISSION_DENIED` must not be used if + the caller can not be identified (use `UNAUTHENTICATED` instead + for those errors). This error code does not imply the request is + valid or the requested entity exists or satisfies other + pre-conditions. HTTP Mapping: 403 Forbidden + - >- + The request does not have valid authentication credentials for the + operation. HTTP Mapping: 401 Unauthorized + - >- + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. HTTP Mapping: 429 + Too Many Requests + - >- + The operation was rejected because the system is not in a state + required for the operation's execution. For example, the directory + to be deleted is non-empty, an rmdir operation is applied to a + non-directory, etc. Service implementors can use the following + guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and + `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just + the failing call. (b) Use `ABORTED` if the client should retry at + a higher level. For example, when a client-specified test-and-set + fails, indicating the client should restart a read-modify-write + sequence. (c) Use `FAILED_PRECONDITION` if the client should not + retry until the system state has been explicitly fixed. For + example, if an "rmdir" fails because the directory is non-empty, + `FAILED_PRECONDITION` should be returned since the client should + not retry unless the files are deleted from the directory. HTTP + Mapping: 400 Bad Request + - >- + The operation was aborted, typically due to a concurrency issue + such as a sequencer check failure or transaction abort. See the + guidelines above for deciding between `FAILED_PRECONDITION`, + `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + - >- + The operation was attempted past the valid range. E.g., seeking or + reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error + indicates a problem that may be fixed if the system state changes. + For example, a 32-bit file system will generate `INVALID_ARGUMENT` + if asked to read at an offset that is not in the range [0,2^32-1], + but it will generate `OUT_OF_RANGE` if asked to read from an + offset past the current file size. There is a fair bit of overlap + between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend + using `OUT_OF_RANGE` (the more specific error) when it applies so + that callers who are iterating through a space can easily look for + an `OUT_OF_RANGE` error to detect when they are done. HTTP + Mapping: 400 Bad Request + - >- + The operation is not implemented or is not supported/enabled in + this service. HTTP Mapping: 501 Not Implemented + - >- + Internal errors. This means that some invariants expected by the + underlying system have been broken. This error code is reserved + for serious errors. HTTP Mapping: 500 Internal Server Error + - >- + The service is currently unavailable. This is most likely a + transient condition, which can be corrected by retrying with a + backoff. Note that it is not always safe to retry non-idempotent + operations. See the guidelines above for deciding between + `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: + 503 Service Unavailable + - >- + Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal + Server Error type: object + id: GoogleCloudAiplatformV1SchemaPredictionResultError + GoogleCloudAiplatformV1HyperparameterTuningJob: properties: - gcsBucket: + displayName: description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. + Required. The display name of the HyperparameterTuningJob. The name + can be up to 128 characters long and can consist of any UTF-8 + characters. type: string - dataItemSchemaUri: + createTime: + description: Output only. Time when the HyperparameterTuningJob was created. + readOnly: true + format: google-datetime + type: string + studySpec: + description: Required. Study configuration of the HyperparameterTuningJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + maxFailedTrialCount: description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Text DataItems that belong to this Dataset. + The number of failed Trials that need to be seen before failing the + HyperparameterTuningJob. If set to 0, Vertex AI decides how many + Trials must fail before the whole job fails. + format: int32 + type: integer + state: + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + description: Output only. The detailed state of the job. type: string - id: GoogleCloudAiplatformV1SchemaTextDatasetMetadata - description: The metadata of Datasets that contain Text DataItems. - GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: - id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureOnlineStore. - type: object - description: Details of operations that perform update FeatureOnlineStore. - GoogleCloudAiplatformV1Segment: - properties: - startIndex: + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. readOnly: true - format: int32 + trialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' description: >- - Output only. Start index in the given Part, measured in bytes. - Offset from the start of the Part, inclusive, starting at zero. + Required. The spec of a trial job. The same spec applies to the + CustomJobs created in all the trials. + maxTrialCount: + format: int32 type: integer - endIndex: + description: Required. The desired total number of Trials. + endTime: description: >- - Output only. End index in the given Part, measured in bytes. Offset - from the start of the Part, exclusive, starting at zero. + Output only. Time when the HyperparameterTuningJob entered any of + the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + format: google-datetime + readOnly: true + type: string + name: readOnly: true - type: integer - format: int32 - text: type: string + description: Output only. Resource name of the HyperparameterTuningJob. + satisfiesPzi: readOnly: true + type: boolean + description: Output only. Reserved for future use. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Output only. The text corresponding to the segment from the - response. - partIndex: - type: integer + Customer-managed encryption key options for a + HyperparameterTuningJob. If this is set, then all resources created + by the HyperparameterTuningJob will be encrypted with the provided + encryption key. + error: description: >- - Output only. The index of a Part object within its parent Content - object. + Output only. Only populated when job's state is JOB_STATE_FAILED or + JOB_STATE_CANCELLED. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + parallelTrialCount: format: int32 + description: Required. The desired number of Trials to run in parallel. + type: integer + startTime: readOnly: true - description: Segment of the content. - id: GoogleCloudAiplatformV1Segment - type: object - GoogleCloudAiplatformV1FeatureViewSyncConfig: - id: GoogleCloudAiplatformV1FeatureViewSyncConfig - type: object - description: Configuration for Sync. Only one option is set. - properties: - cron: + format: google-datetime + type: string description: >- - Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch - scheduled runs. To explicitly set a timezone to the cron tab, apply - a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database. For example, - "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * - * *". - type: string - GoogleCloudAiplatformV1DedicatedResources: - type: object - properties: - maxReplicaCount: - format: int32 - type: integer - description: >- - Immutable. The maximum number of replicas this DeployedModel 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 the model to that many replicas - is guaranteed (barring service outages). If traffic against the - DeployedModel 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). - machineSpec: - description: >- - Required. Immutable. The specification of a single machine used by - the prediction. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - spot: - type: boolean - description: >- - Optional. If true, schedule the deployment workload on [spot - VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). - autoscalingMetricSpecs: + Output only. Time when the HyperparameterTuningJob for the first + time entered the `JOB_STATE_RUNNING` state. + trials: + readOnly: true + description: Output only. Trials of the HyperparameterTuningJob. + type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoscalingMetricSpec' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + updateTime: + readOnly: true description: >- - Immutable. The metric specifications that overrides a resource - utilization metric (CPU utilization, accelerator's duty cycle, and - so on) target value (default to 60 if not set). At most one entry is - allowed per metric. If machine_spec.accelerator_count is above 0, - the autoscaling will be based on both CPU utilization and - accelerator's duty cycle metrics and scale up when either metrics - exceeds its target value while scale down if both metrics are under - their target value. The default target value is 60 for both metrics. - If machine_spec.accelerator_count is 0, the autoscaling will be - based on CPU utilization metric only with default target value 60 if - not explicitly set. For example, in the case of Online Prediction, - if you want to override target CPU utilization to 80, you should set - autoscaling_metric_specs.metric_name to - `aiplatform.googleapis.com/prediction/online/cpu/utilization` and - autoscaling_metric_specs.target to `80`. - type: array - minReplicaCount: - format: int32 - type: integer + Output only. Time when the HyperparameterTuningJob was most recently + updated. + type: string + format: google-datetime + labels: + type: object + additionalProperties: + type: string description: >- - Required. Immutable. The minimum number of machine replicas this - DeployedModel will be always deployed on. This value must be greater - than or equal to 1. If traffic against the DeployedModel increases, - it may dynamically be deployed onto more replicas, and as traffic - decreases, some of these extra replicas may be freed. - description: >- - A description of resources that are dedicated to a DeployedModel, and - that need a higher degree of manual configuration. - id: GoogleCloudAiplatformV1DedicatedResources - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation: + The labels with user-defined metadata to organize + HyperparameterTuningJobs. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. + satisfiesPzs: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + id: GoogleCloudAiplatformV1HyperparameterTuningJob description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation - properties: - columnName: - type: string + Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a + Study specification and multiple CustomJobs with identical CustomJob + specification. + type: object + GoogleCloudAiplatformV1CitationMetadata: type: object - GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse: - id: GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse - description: Response message for TensorboardService.ReadTensorboardTimeSeriesData. properties: - timeSeriesData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' - description: The returned time series data. + citations: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Citation' + description: Output only. List of citations. + type: array + readOnly: true + description: A collection of source attributions for a piece of content. + id: GoogleCloudAiplatformV1CitationMetadata + GoogleCloudAiplatformV1PipelineTaskDetailArtifactList: type: object - GoogleCloudAiplatformV1ExplanationSpecOverride: + id: GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + description: A list of artifact metadata. properties: - examplesOverride: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesOverride' - description: The example-based explanations parameter overrides. - parameters: - description: >- - The parameters to be overridden. Note that the attribution method - cannot be changed. If not specified, no parameter is overridden. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverride + artifacts: + readOnly: true + description: Output only. A list of artifact metadata. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + type: array + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: + id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata + description: >- + Runtime operation information for + MigrationService.BatchMigrateResources. + properties: + partialResults: + type: array description: >- - The metadata to be overridden. If not specified, no metadata is - overridden. - id: GoogleCloudAiplatformV1ExplanationSpecOverride + Partial results that reflect the latest migration operation + progress. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. type: object + GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail: description: >- - The ExplanationSpec entries that can be overridden at online explanation - time. - GoogleCloudAiplatformV1ExactMatchSpec: + The detail of a container execution. It contains the job names of the + lifecycle of a container execution. type: object - description: >- - Spec for exact match metric - returns 1 if prediction and reference - exactly matches, otherwise 0. - id: GoogleCloudAiplatformV1ExactMatchSpec - properties: {} - GoogleCloudAiplatformV1Model: - id: GoogleCloudAiplatformV1Model - description: A trained machine learning Model. properties: - displayName: - type: string - description: >- - Required. The display name of the Model. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - versionUpdateTime: - readOnly: true - format: google-datetime - type: string - description: Output only. Timestamp when this version was most recently updated. - pipelineJob: - type: string + failedPreCachingCheckJobs: description: >- - Optional. This field is populated if the model is produced by a - pipeline job. - deployedModels: - readOnly: true - type: array + Output only. The names of the previously failed CustomJob for the + pre-caching-check container executions. This job will be available + if the PipelineJob.pipeline_spec specifies the `pre_caching_check` + hook in the lifecycle events. The list includes the all attempts in + chronological order. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' - description: >- - Output only. The pointers to DeployedModels created from this Model. - Note that Model could have been deployed to Endpoints in different - Locations. - metadataArtifact: + type: string + type: array readOnly: true + mainJob: description: >- - Output only. The resource name of the Artifact that was created in - MetadataStore when creating the Model. The Artifact resource name - pattern is - `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + Output only. The name of the CustomJob for the main container + execution. + readOnly: true type: string - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Customer-managed encryption key spec for a Model. If set, this Model - and all sub-resources of this Model will be secured by this key. - modelSourceInfo: + preCachingCheckJob: description: >- - Output only. Source of a model. It can either be automl training - pipeline, custom training pipeline, BigQuery ML, or saved and tuned - from Genie or Model Garden. + Output only. The name of the CustomJob for the pre-caching-check + container execution. This job will be available if the + PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in + the lifecycle events. + type: string readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelSourceInfo' - satisfiesPzi: - type: boolean + failedMainJobs: readOnly: true - description: Output only. Reserved for future use. - etag: + type: array description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + Output only. The names of the previously failed CustomJob for the + main container executions. The list includes the all attempts in + chronological order. + items: + type: string + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail + GoogleCloudAiplatformV1ManualBatchTuningParameters: + id: GoogleCloudAiplatformV1ManualBatchTuningParameters + description: Manual batch tuning parameters. + properties: + batchSize: + type: integer + format: int32 description: >- - The default explanation specification for this Model. The Model can - be used for requesting explanation after being deployed if it is - populated. The Model can be used for batch explanation if it is - populated. All fields of the explanation_spec can be overridden by - explanation_spec of DeployModelRequest.deployed_model, or - explanation_spec of BatchPredictionJob. If the default explanation - specification is not set for this Model, this Model can still be - used for requesting explanation by setting explanation_spec of - DeployModelRequest.deployed_model and for batch explanation by - setting explanation_spec of BatchPredictionJob. - versionCreateTime: - description: Output only. Timestamp when this version was created. + Immutable. The number of the records (e.g. instances) of the + operation given in each batch to a machine replica. Machine type, + and size of a single record should be considered when setting this + parameter, higher value speeds up the batch operation's execution, + but too high value will result in a whole batch not fitting in a + machine's memory, and the whole operation will fail. The default + value is 64. + type: object + GoogleCloudAiplatformV1UploadModelResponse: + properties: + modelVersionId: type: string - format: google-datetime - readOnly: true - trainingPipeline: + description: Output only. The version ID of the model that is uploaded. readOnly: true + model: type: string description: >- - Output only. The resource name of the TrainingPipeline that uploaded - this Model, if any. - containerSpec: - 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. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' - artifactUri: + The name of the uploaded Model resource. Format: + `projects/{project}/locations/{location}/models/{model}` + type: object + id: GoogleCloudAiplatformV1UploadModelResponse + description: Response message of ModelService.UploadModel operation. + GoogleCloudAiplatformV1DeployedIndexRef: + type: object + properties: + deployedIndexId: type: string - description: >- - Immutable. The path to the directory containing the Model artifact - and any of its supporting files. Not required for AutoML Models. - description: + description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. + displayName: type: string - description: The description of the Model. - versionDescription: + readOnly: true + description: Output only. The display name of the DeployedIndex. + indexEndpoint: type: string - description: The description of this version. - metadataSchemaUri: - description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Model, that is specific - to it. Unset if the Model does not have any additional information. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI, if no - additional metadata is needed, this field is set to an empty string. - Note: The URI given on output will be immutable and probably - different, including the URI scheme, than the one given on input. - The output URI will point to a location where the user only has a - read access. + description: Immutable. A resource name of the IndexEndpoint. + id: GoogleCloudAiplatformV1DeployedIndexRef + description: Points to a DeployedIndex. + GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest: + id: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + description: Request message for JobService.ResumeModelDeploymentMonitoringJob. + type: object + properties: {} + GoogleCloudAiplatformV1RougeSpec: + type: object + properties: + rougeType: type: string - metadata: description: >- - Immutable. An additional information about the Model; the schema of - the metadata can be found in metadata_schema. Unset if the Model - does not have any additional information. - type: any - versionAliases: + Optional. Supported rouge types are rougen[1-9], rougeL, and + rougeLsum. + splitSummaries: + description: Optional. Whether to split summaries while using rougeLsum. + type: boolean + useStemmer: + description: Optional. Whether to use stemmer to compute rouge score. + type: boolean + description: >- + Spec for rouge score metric - calculates the recall of n-grams in + prediction as compared to reference - returns a score ranging between 0 + and 1. + id: GoogleCloudAiplatformV1RougeSpec + GoogleCloudAiplatformV1ListDatasetVersionsResponse: + type: object + description: Response message for DatasetService.ListDatasetVersions. + properties: + datasetVersions: type: array - items: - type: string - description: >- - User provided version aliases so that a model version can be - referenced via alias (i.e. - `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` - instead of auto-generated version id (i.e. - `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. - The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A - default version alias will be created for the first version of the - model, and there must be exactly one default version alias for a - model. - originalModelInfo: - description: >- - Output only. If this Model is a copy of another Model, this contains - info about the original. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelOriginalModelInfo' - readOnly: true - predictSchemata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - description: >- - The schemata that describe formats of the Model's predictions and - explanations as given and returned via PredictionService.Predict and - PredictionService.Explain. - supportedInputStorageFormats: - readOnly: true description: >- - Output only. The formats this Model supports in - BatchPredictionJob.input_config. If - PredictSchemata.instance_schema_uri exists, the instances should be - given as per that schema. The possible formats are: * `jsonl` The - JSON Lines format, where each instance is a single line. Uses - GcsSource. * `csv` The CSV format, where each instance is a single - comma-separated line. The first line in the file is the header, - containing comma-separated field names. Uses GcsSource. * - `tf-record` The TFRecord format, where each instance is a single - record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` - Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * - `bigquery` Each instance is a single row in BigQuery. Uses - BigQuerySource. * `file-list` Each line of the file is the location - of an instance to process, uses `gcs_source` field of the - InputConfig object. If this Model doesn't support any of these - formats it means it cannot be used with a BatchPredictionJob. - However, if it has supported_deployment_resources_types, it could - serve online predictions by using PredictionService.Predict or - PredictionService.Explain. - type: array + A list of DatasetVersions that matches the specified filter in the + request. items: - type: string - versionId: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + nextPageToken: type: string - readOnly: true + description: The standard List next-page token. + id: GoogleCloudAiplatformV1ListDatasetVersionsResponse + GoogleCloudAiplatformV1ListFeatureGroupsResponse: + properties: + featureGroups: + description: The FeatureGroups matching the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + type: array + nextPageToken: description: >- - Output only. Immutable. The version ID of the model. A new version - is committed when a new model version is uploaded or trained under - an existing model id. It is an auto-incrementing decimal number in - string representation. + A token, which can be sent as ListFeatureGroupsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: string + description: Response message for FeatureRegistryService.ListFeatureGroups. + id: GoogleCloudAiplatformV1ListFeatureGroupsResponse + type: object + GoogleCloudAiplatformV1BatchPredictionJob: + type: object + properties: labels: description: >- - The labels with user-defined metadata to organize your Models. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - type: object + The labels with user-defined metadata to organize + BatchPredictionJobs. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. additionalProperties: type: string - baseModelSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelBaseModelSource' + type: object + generateExplanation: + type: boolean description: >- - Optional. User input field to specify the base model source. - Currently it only supports specifing the Model Garden models and - Genie models. - supportedDeploymentResourcesTypes: - type: array + Generate explanation with the batch prediction results. When set to + `true`, the batch prediction output changes based on the + `predictions_format` field of the BatchPredictionJob.output_config + object: * `bigquery`: output includes a column named `explanation`. + The value is a struct that conforms to the Explanation object. * + `jsonl`: The JSON objects on each line include an additional entry + keyed `explanation`. The value of the entry is a JSON object that + conforms to the Explanation object. * `csv`: Generating explanations + for CSV format is not supported. If this field is set to true, + either the Model.explanation_spec or explanation_spec must be + populated. + updateTime: + format: google-datetime readOnly: true - items: - type: string - enum: - - DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED - - DEDICATED_RESOURCES - - AUTOMATIC_RESOURCES - - SHARED_RESOURCES - enumDescriptions: - - Should not be used. - - >- - Resources that are dedicated to the DeployedModel, and that need - a higher degree of manual configuration. - - >- - Resources that to large degree are decided by Vertex AI, and - require only a modest additional configuration. - - >- - Resources that can be shared by multiple DeployedModels. A - pre-configured DeploymentResourcePool is required. - description: >- - Output only. When this Model is deployed, its prediction resources - are described by the `prediction_resources` field of the - Endpoint.deployed_models object. Because not all Models support all - resource configuration types, the configuration types this Model - supports are listed here. If no configuration types are listed, the - Model cannot be deployed to an Endpoint and does not support online - predictions (PredictionService.Predict or - PredictionService.Explain). Such a Model can serve predictions by - using a BatchPredictionJob, if it has at least one entry each in - supported_input_storage_formats and - supported_output_storage_formats. - dataStats: description: >- - Stats of data used for training or evaluating the Model. Only - populated when the Model is trained by a TrainingPipeline with - data_input_config. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' - updateTime: + Output only. Time when the BatchPredictionJob was most recently + updated. + type: string + state: + description: Output only. The detailed state of the job. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED type: string readOnly: true + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + startTime: + description: >- + Output only. Time when the BatchPredictionJob for the first time + entered the `JOB_STATE_RUNNING` state. format: google-datetime - description: Output only. Timestamp when this Model was most recently updated. - satisfiesPzs: - type: boolean + type: string readOnly: true + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchDedicatedResources' + description: >- + The config of resources used by the Model during the batch + prediction. If the Model supports DEDICATED_RESOURCES this config + may be provided (and the job will use these resources), if the Model + doesn't support AUTOMATIC_RESOURCES, this config must be provided. + satisfiesPzi: description: Output only. Reserved for future use. - supportedExportFormats: + readOnly: true + type: boolean + resourcesConsumed: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcesConsumed' + readOnly: true description: >- - Output only. The formats in which this Model may be exported. If - empty, this Model is not available for export. + Output only. Information about resources that had been consumed by + this job. Provided in real time at best effort basis, as well as a + final value once the job completes. Note: This field currently may + be not populated for batch predictions that use AutoML Models. + createTime: readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExportFormat' - name: - description: The resource name of the Model. + description: Output only. Time when the BatchPredictionJob was created. + format: google-datetime type: string - createTime: + completionStats: + readOnly: true + description: >- + Output only. Statistics on completed and failed prediction + instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompletionStats' + explanationSpec: + description: >- + Explanation configuration for this BatchPredictionJob. Can be + specified only if generate_explanation is set to `true`. This value + overrides the value of Model.explanation_spec. All fields of + explanation_spec are optional in the request. If a field of the + explanation_spec object is not populated, the corresponding field of + the Model.explanation_spec object is inherited. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + error: + readOnly: true + description: >- + Output only. Only populated when the job's state is JOB_STATE_FAILED + or JOB_STATE_CANCELLED. + $ref: '#/components/schemas/GoogleRpcStatus' + inputConfig: + description: >- + Required. Input configuration of the instances on which predictions + are performed. The schema of any single instance may be specified + via the Model's PredictSchemata's instance_schema_uri. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInputConfig + instanceConfig: + description: >- + Configuration for how to convert batch prediction input instances to + the prediction instances that are sent to the Model. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + outputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputConfig + description: >- + Required. The Configuration specifying where output predictions + should be written. The schema of any single prediction may be + specified as a concatenation of Model's PredictSchemata's + instance_schema_uri and prediction_schema_uri. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key options for a BatchPredictionJob. If + this is set, then all resources created by the BatchPredictionJob + will be encrypted with the provided encryption key. + endTime: + description: >- + Output only. Time when the BatchPredictionJob entered any of the + following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. format: google-datetime readOnly: true type: string - description: Output only. Timestamp when this Model was uploaded into Vertex AI. - supportedOutputStorageFormats: + disableContainerLogging: description: >- - Output only. The formats this Model supports in - BatchPredictionJob.output_config. If both - PredictSchemata.instance_schema_uri and - PredictSchemata.prediction_schema_uri exist, the predictions are - returned together with their instances. In other words, the - prediction has the original instance data first, followed by the - actual prediction content (as per the schema). The possible formats - are: * `jsonl` The JSON Lines format, where each prediction is a - single line. Uses GcsDestination. * `csv` The CSV format, where each - prediction is a single comma-separated line. The first line in the - file is the header, containing comma-separated field names. Uses - GcsDestination. * `bigquery` Each prediction is a single row in a - BigQuery table, uses BigQueryDestination . If this Model doesn't - support any of these formats it means it cannot be used with a - BatchPredictionJob. However, if it has - supported_deployment_resources_types, it could serve online - predictions by using PredictionService.Predict or - PredictionService.Explain. - items: - type: string + For custom-trained Models and AutoML Tabular Models, the container + of the DeployedModel instances will send `stderr` and `stdout` + streams to Cloud Logging by default. Please note that the logs incur + cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging/pricing). User can disable + container logging by setting this flag to true. + type: boolean + displayName: + type: string + description: Required. The user-defined name of this BatchPredictionJob. + modelParameters: + type: any + description: >- + The parameters that govern the predictions. The schema of the + parameters may be specified via the Model's PredictSchemata's + parameters_schema_uri. + serviceAccount: + type: string + description: >- + The service account that the DeployedModel's container runs as. If + not specified, a system generated one will be used, which has + minimal permissions and the custom container, if used, may not have + enough permission to access other Google Cloud resources. Users + deploying the Model must have the `iam.serviceAccounts.actAs` + permission on this service account. + partialFailures: type: array readOnly: true - type: object - GoogleCloudAiplatformV1BatchCreateFeaturesResponse: - type: object - id: GoogleCloudAiplatformV1BatchCreateFeaturesResponse - properties: - features: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - description: The Features created. - type: array - description: Response message for FeaturestoreService.BatchCreateFeatures. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation - properties: - columnName: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Partial failures encountered. For example, single files + that can't be read. This field never exceeds 20 entries. Status + details fields contain standard Google Cloud error details. + manualBatchTuningParameters: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ManualBatchTuningParameters + description: >- + Immutable. Parameters configuring the batch behavior. Currently only + applicable when dedicated_resources are used (in other cases Vertex + AI does the tuning itself). + outputInfo: + readOnly: true + description: Output only. Information further describing the output of this job. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + name: + type: string + description: Output only. Resource name of the BatchPredictionJob. + readOnly: true + unmanagedContainerModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UnmanagedContainerModel' + description: >- + Contains model information necessary to perform batch prediction + without requiring uploading to model registry. Exactly one of model + and unmanaged_container_model must be set. + model: + description: >- + The name of the Model resource that produces the predictions via + this job, must share the same ancestor Location. Starting this job + has no impact on any existing deployments of the Model and their + resources. Exactly one of model and unmanaged_container_model must + be set. The model resource name may contain version id or version + alias to specify the version. Example: + `projects/{project}/locations/{location}/models/{model}@2` or + `projects/{project}/locations/{location}/models/{model}@golden` if + no version is specified, the default version will be deployed. The + model resource could also be a publisher model. Example: + `publishers/{publisher}/models/{model}` or + `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` + type: string + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + modelVersionId: + description: >- + Output only. The version ID of the Model that produces the + predictions via this job. + readOnly: true type: string description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. + A job that uses a Model to produce predictions on multiple input + instances. If predictions for significant portion of the instances fail, + the job may finish without attempting predictions for all remaining + instances. + id: GoogleCloudAiplatformV1BatchPredictionJob + GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata: type: object - GoogleCloudAiplatformV1DiskSpec: - id: GoogleCloudAiplatformV1DiskSpec - description: Represents the spec of disk options. + description: >- + Runtime operation information for + IndexEndpointService.MutateDeployedIndex. properties: - bootDiskType: + deployedIndexId: + type: string + description: The unique index id specified by user + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter: + properties: + trainerConfig: + type: object + description: Customizable trainer settings, used in the `model_garden_trainer`. + additionalProperties: + type: string + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' description: >- - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" - (Persistent Disk Solid State Drive) or "pd-standard" (Persistent - Disk Hard Disk Drive). + Optioinal. StudySpec of hyperparameter tuning job. Required for + `model_garden_trainer`. + checkpointName: + description: >- + Optional. An unique name of pretrained model checkpoint provided in + model garden, it will be mapped to a GCS location internally. type: string - bootDiskSizeGb: - format: int32 - type: integer - description: Size in GB of the boot disk (default is 100GB). - type: object - GoogleCloudAiplatformV1ToolParameterKeyMatchResults: - description: Results for tool parameter key match metric. + trainerType: + type: string + enum: + - TRAINER_TYPE_UNSPECIFIED + - AUTOML_TRAINER + - MODEL_GARDEN_TRAINER + enumDescriptions: + - Default value. + - '' + - '' + datasetConfig: + type: object + additionalProperties: + type: string + description: Customizable dataset settings, used in the `model_garden_trainer`. type: object - id: GoogleCloudAiplatformV1ToolParameterKeyMatchResults + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + description: >- + A wrapper class which contains the tunable parameters in an AutoML Image + training job. + GoogleCloudAiplatformV1PythonPackageSpec: + id: GoogleCloudAiplatformV1PythonPackageSpec properties: - toolParameterKeyMatchMetricValues: - description: Output only. Tool parameter key match metric values. + args: type: array - readOnly: true items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue - GoogleCloudAiplatformV1BleuResults: - description: Results for bleu metric. - id: GoogleCloudAiplatformV1BleuResults - type: object - properties: - bleuMetricValues: + type: string + description: Command line arguments to be passed to the Python task. + env: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuMetricValue' - description: Output only. Bleu metric values. - readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + description: >- + Environment variables to be passed to the python module. Maximum + limit is 100. type: array - GoogleCloudAiplatformV1QuestionAnsweringQualityInstance: - type: object - properties: - instruction: - type: string - description: Required. Question Answering prompt for LLM. - reference: - description: Optional. Ground truth used to compare against the prediction. + pythonModule: type: string - context: - description: Required. Text to answer the question. + description: >- + Required. The Python module name to run after installing the + packages. + executorImageUri: type: string - prediction: + description: >- + Required. The URI of a container image in Artifact Registry that + will run the provided Python package. Vertex AI provides a wide + range of executor images with pre-installed packages to meet users' + various use cases. See the list of [pre-built containers for + training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). + You must use an image from this list. + packageUris: + items: + type: string + type: array + description: >- + Required. The Google Cloud Storage location of the Python package + files which are the training program and its dependent packages. The + maximum number of package URIs is 100. + description: The spec of a Python packaged code. + type: object + GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata: + properties: + progressMessage: type: string - description: Required. Output of the evaluated model. - description: Spec for question answering quality instance. - id: GoogleCloudAiplatformV1QuestionAnsweringQualityInstance - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig: - description: >- - Specification message containing the config for this SliceSpec. When - `kind` is selected as `value` and/or `range`, only a single slice will - be computed. When `all_values` is present, a separate slice will be - computed for each possible label/value for the corresponding key in - `config`. Examples, with feature zip_code with values 12345, 23334, - 88888 and feature country with values "US", "Canada", "Mexico" in the - dataset: Example 1: { "zip_code": { "value": { "float_value": 12345.0 } - } } A single slice for any data with zip_code 12345 in the dataset. - Example 2: { "zip_code": { "range": { "low": 12345, "high": 20000 } } } - A single slice containing data where the zip_codes between 12345 and - 20000 For this example, data with the zip_code of 12345 will be in this - slice. Example 3: { "zip_code": { "range": { "low": 10000, "high": 20000 - } }, "country": { "value": { "string_value": "US" } } } A single slice - containing data where the zip_codes between 10000 and 20000 has the - country "US". For this example, data with the zip_code of 12345 and - country "US" will be in this slice. Example 4: { "country": - {"all_values": { "value": true } } } Three slices are computed, one for - each unique country in the dataset. Example 5: { "country": { - "all_values": { "value": true } }, "zip_code": { "value": { - "float_value": 12345.0 } } } Three slices are computed, one for each - unique country in the dataset where the zip_code is also 12345. For this - example, data with zip_code 12345 and country "US" will be in one slice, - zip_code 12345 and country "Canada" in another slice, and zip_code 12345 - and country "Mexico" in another slice, totaling 3 slices. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + description: Progress Message for Create LRO + genericMetadata: + description: Operation metadata for PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Details of operations that perform create PersistentResource. + type: object + id: GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata + GoogleCloudAiplatformV1StructValue: + description: Struct (or object) type feature value. + id: GoogleCloudAiplatformV1StructValue properties: - value: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue + values: + description: A list of field values. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StructFieldValue' + type: array + type: object + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec: + description: Represents a parameter spec with condition from its parent parameter. + properties: + parentCategoricalValues: description: >- - A unique specific value for a given feature. Example: `{ "value": { - "string_value": "12345" } }` - allValues: - type: boolean + The spec for matching values from a parent parameter of + `CATEGORICAL` type. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + parentDiscreteValues: description: >- - If all_values is set to true, then all possible labels of the keyed - feature will have another slice computed. Example: - `{"all_values":{"value":true}}` - range: + The spec for matching values from a parent parameter of `DISCRETE` + type. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition + parameterSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + description: Required. The spec for a conditional parameter. + parentIntValues: description: >- - A range of values for a numerical feature. Example: - `{"range":{"low":10000.0,"high":50000.0}}` will capture 12345 and - 23334 in the slice. + The spec for matching values from a parent parameter of `INTEGER` + type. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition type: object - GoogleCloudAiplatformV1Examples: + id: GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec + GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset: type: object - description: >- - Example-based explainability that returns the nearest neighbors from the - provided dataset. - id: GoogleCloudAiplatformV1Examples + description: Represents one Dataset in datalabeling.googleapis.com. + id: GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset properties: - presets: + dataLabelingAnnotatedDatasets: description: >- - Simplified preset configuration, which automatically sets - configuration values based on the desired query speed-precision - trade-off and modality. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Presets' - nearestNeighborSearchConfig: - type: any + The migratable AnnotatedDataset in datalabeling.googleapis.com + belongs to the data labeling Dataset. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset + type: array + dataset: + type: string description: >- - The full configuration for the generated index, the semantics are - the same as metadata and should match - [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). - exampleGcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesExampleGcsSource' - description: The Cloud Storage input instances. - neighborCount: - format: int32 - description: The number of neighbors to return when querying for examples. - type: integer - GoogleCloudAiplatformV1ExplanationParameters: - description: Parameters to configure explaining for Model's predictions. - id: GoogleCloudAiplatformV1ExplanationParameters - type: object + Full resource name of data labeling Dataset. Format: + `projects/{project}/datasets/{dataset}`. + datasetDisplayName: + description: The Dataset's display name in datalabeling.googleapis.com. + type: string + GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics: properties: - integratedGradientsAttribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IntegratedGradientsAttribution + meanAbsoluteError: + format: float + type: number + description: Mean Absolute Error (MAE). + rSquared: + type: number description: >- - An attribution method that computes Aumann-Shapley values taking - advantage of the model's fully differentiable structure. Refer to - this paper for more details: https://arxiv.org/abs/1703.01365 - sampledShapleyAttribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SampledShapleyAttribution - description: >- - An attribution method that approximates Shapley values for features - that contribute to the label being predicted. A sampling strategy is - used to approximate the value rather than considering all subsets of - features. Refer to this paper for model details: - https://arxiv.org/abs/1306.4265. - outputIndices: - items: - type: any - description: >- - If populated, only returns attributions that have output_index - contained in output_indices. It must be an ndarray of integers, with - the same shape of the output it's explaining. If not populated, - returns attributions for top_k indices of outputs. If neither top_k - nor output_indices is populated, returns the argmax index of the - outputs. Only applicable to Models that predict multiple outputs - (e,g, multi-class Models that predict multiple classes). - type: array - xraiAttribution: - description: >- - An attribution method that redistributes Integrated Gradients - attribution to segmented regions, taking advantage of the model's - fully differentiable structure. Refer to this paper for more - details: https://arxiv.org/abs/1906.02825 XRAI currently performs - better on natural images, like a picture of a house or an animal. If - the images are taken in artificial environments, like a lab or - manufacturing line, or from diagnostic equipment, like x-rays or - quality-control cameras, use Integrated Gradients instead. - $ref: '#/components/schemas/GoogleCloudAiplatformV1XraiAttribution' - examples: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + Coefficient of determination as Pearson correlation coefficient. + Undefined when ground truth or predictions are constant or near + constant. + format: float + rootMeanSquaredError: + description: Root Mean Squared Error (RMSE). + type: number + format: float + meanAbsolutePercentageError: + format: float + type: number description: >- - Example-based explanations that returns the nearest neighbors from - the provided dataset. - topK: + Mean absolute percentage error. Infinity when there are zeros in the + ground truth. + rootMeanSquaredLogError: + type: number + format: float description: >- - If populated, returns attributions for top K indices of outputs - (defaults to 1). Only applies to Models that predicts more than one - outputs (e,g, multi-class Models). When set to -1, returns - explanations for all outputs. - format: int32 - type: integer - GoogleCloudAiplatformV1Measurement: + Root mean squared log error. Undefined when there are negative + ground truth values or predictions. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics + type: object + description: Metrics for regression evaluation results. + GoogleCloudAiplatformV1RougeInstance: + description: Spec for rouge instance. + type: object properties: - stepCount: + prediction: type: string - description: >- - Output only. The number of steps the machine learning model has been - trained for. Must be non-negative. - readOnly: true - format: int64 - metrics: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MeasurementMetric' - type: array - description: >- - Output only. A list of metrics got by evaluating the objective - functions using suggested Parameter values. - readOnly: true - elapsedDuration: - readOnly: true + description: Required. Output of the evaluated model. + reference: type: string - description: >- - Output only. Time that the Trial has been running at the point of - this Measurement. - format: google-duration - id: GoogleCloudAiplatformV1Measurement - description: >- - A message representing a Measurement of a Trial. A Measurement contains - the Metrics got by executing a Trial using suggested hyperparameter - values. - type: object - GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: + description: Required. Ground truth used to compare against the prediction. + id: GoogleCloudAiplatformV1RougeInstance + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics: properties: - xMax: + auPrc: type: number - description: The rightmost coordinate of the bounding box. - format: double - displayName: + format: float description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - yMin: + The Area Under Precision-Recall Curve metric. Micro-averaged for the + overall evaluation. + auRoc: type: number - description: The topmost coordinate of the bounding box. - format: double - annotationSpecId: - type: string + format: float description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - yMax: - type: number - description: The bottommost coordinate of the bounding box. - format: double - xMin: + The Area Under Receiver Operating Characteristic curve metric. + Micro-averaged for the overall evaluation. + confidenceMetrics: + description: >- + Metrics for each `confidenceThreshold` in + 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and `positionThreshold` + = INT32_MAX_VALUE. ROC and precision-recall curves, and other + aggregated metrics are derived from them. The confidence metrics + entries may also be supplied for additional values of + `positionThreshold`, but from these no aggregated metrics are + computed. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + logLoss: type: number - description: The leftmost coordinate of the bounding box. - format: double - id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation - description: Annotation details specific to image object detection. + format: float + description: The Log Loss metric. + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: Confusion matrix of the evaluation. + description: Metrics for classification evaluation results. type: object - GoogleCloudAiplatformV1GroundingChunk: - id: GoogleCloudAiplatformV1GroundingChunk - description: Grounding chunk. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics + GoogleCloudAiplatformV1BatchCreateFeaturesResponse: properties: - retrievedContext: - description: Grounding chunk from context retrieved by the retrieval tools. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GroundingChunkRetrievedContext - web: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunkWeb' - description: Grounding chunk from the web. + features: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: The Features created. type: object - GoogleCloudAiplatformV1BleuMetricValue: + description: Response message for FeaturestoreService.BatchCreateFeatures. + id: GoogleCloudAiplatformV1BatchCreateFeaturesResponse + GoogleCloudAiplatformV1WorkerPoolSpec: + description: Represents the spec of a worker pool in a job. properties: - score: - description: Output only. Bleu score. - type: number - format: float - readOnly: true - description: Bleu metric value for an instance. - id: GoogleCloudAiplatformV1BleuMetricValue + pythonPackageSpec: + description: The Python packaged task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' + diskSpec: + description: Disk spec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + machineSpec: + description: Optional. Immutable. The specification of a single machine. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + containerSpec: + description: The custom container task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' + nfsMounts: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' + description: Optional. List of NFS mount spec. + replicaCount: + type: string + description: Optional. The number of worker replicas to use for this worker pool. + format: int64 type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask: + id: GoogleCloudAiplatformV1WorkerPoolSpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation: type: object properties: - metadata: - description: The metadata information. + text: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata - inputs: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation + categorical: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec - description: The input parameters of this HyperparameterTuningTask. + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask - description: A TrainingJob that tunes Hypererparameters of a custom code Model. - GoogleCloudAiplatformV1Featurestore: - description: >- - Vertex AI Feature Store provides a centralized repository for - organizing, storing, and serving ML features. The Featurestore is a - top-level container for your features and their values. - id: GoogleCloudAiplatformV1Featurestore + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig: + type: object properties: - labels: - additionalProperties: + userEmails: + description: The email addresses to send the alert. + type: array + items: type: string + description: The config for email alert. + id: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + GoogleCloudAiplatformV1PredefinedSplit: + type: object + id: GoogleCloudAiplatformV1PredefinedSplit + description: >- + Assigns input data to training, validation, and test sets based on the + value of a provided key. Supported only for tabular Datasets. + properties: + key: description: >- - Optional. The labels with user-defined metadata to organize your - Featurestore. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one Featurestore(System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - type: object - onlineServingConfig: - description: >- - Optional. Config for online storage resources. The field should not - co-exist with the field of `OnlineStoreReplicationConfig`. If both - of it and OnlineStoreReplicationConfig are unset, the feature store - will not have an online store and cannot be used for online serving. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig - onlineStorageTtlDays: - format: int32 - description: >- - Optional. TTL in days for feature values that will be stored in - online serving storage. The Feature Store online storage - periodically removes obsolete feature values older than - `online_storage_ttl_days` since the feature generation time. Note - that `online_storage_ttl_days` should be less than or equal to - `offline_storage_ttl_days` for each EntityType under a featurestore. - If not set, default to 4000 days - type: integer - updateTime: - type: string - description: Output only. Timestamp when this Featurestore was last updated. - format: google-datetime - readOnly: true - satisfiesPzi: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - etag: + Required. The key is a name of one of the Dataset's data columns. + The value of the key (either the label's value or value in the + column) must be one of {`training`, `validation`, `test`}, and it + defines to which set the given piece of data is assigned. If for a + piece of data the key is not present or has an invalid value, that + piece is ignored by the pipeline. type: string + GoogleCloudAiplatformV1VertexAISearch: + description: >- + Retrieve from Vertex AI Search datastore for grounding. See + https://cloud.google.com/products/agent-builder + id: GoogleCloudAiplatformV1VertexAISearch + type: object + properties: + datastore: description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - encryptionSpec: - description: >- - Optional. Customer-managed encryption key spec for data storage. If - set, both of the online and offline data storage will be secured by - this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - STABLE - - UPDATING - description: Output only. State of the featurestore. - enumDescriptions: - - Default value. This value is unused. - - >- - State when the featurestore configuration is not being updated and - the fields reflect the current configuration of the featurestore. - The featurestore is usable in this state. - - >- - The state of the featurestore configuration when it is being - updated. During an update, the fields reflect either the original - configuration or the updated configuration of the featurestore. - For example, `online_serving_config.fixed_node_count` can take - minutes to update. While the update is in progress, the - featurestore is in the UPDATING state, and the value of - `fixed_node_count` can be the original value or the updated value, - depending on the progress of the operation. Until the update - completes, the actual number of nodes can still be the original - value of `fixed_node_count`. The featurestore is still usable in - this state. - type: string - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - createTime: - readOnly: true + Required. Fully-qualified Vertex AI Search data store resource ID. + Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` type: string - description: Output only. Timestamp when this Featurestore was created. - format: google-datetime - name: + GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata: + description: All metadata of most recent monitoring pipelines. + properties: + runTime: description: >- - Output only. Name of the Featurestore. Format: - `projects/{project}/locations/{location}/featurestores/{featurestore}` + The time that most recent monitoring pipelines that is related to + this run. + format: google-datetime type: string - readOnly: true + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the most recent monitoring pipeline. + id: >- + GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata type: object - GoogleCloudAiplatformV1FeatureGroup: - id: GoogleCloudAiplatformV1FeatureGroup + GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse: + id: GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse type: object properties: - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. Timestamp when this FeatureGroup was created. - updateTime: - description: Output only. Timestamp when this FeatureGroup was last updated. + tensorboardTimeSeries: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + description: The TensorboardTimeSeries mathching the request. + nextPageToken: type: string - readOnly: true - format: google-datetime - bigQuery: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQuery' - description: >- - Indicates that features for this group come from BigQuery - Table/View. By default treats the source as a sparse time series - source. The BigQuery source table or view must have at least one - entity ID column and a column named `feature_timestamp`. - name: description: >- - Identifier. Name of the FeatureGroup. Format: - `projects/{project}/locations/{location}/featureGroups/{featureGroup}` + A token, which can be sent as + ListTensorboardTimeSeriesRequest.page_token to retrieve the next + page. If this field is omitted, there are no subsequent pages. + description: Response message for TensorboardService.ListTensorboardTimeSeries. + GoogleCloudAiplatformV1ExportDataConfig: + type: object + id: GoogleCloudAiplatformV1ExportDataConfig + description: >- + Describes what part of the Dataset is to be exported, the destination of + the export and how to export. + properties: + fractionSplit: + description: Split based on fractions defining the size of each set. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFractionSplit' + annotationSchemaUri: type: string - description: - description: Optional. Description of the FeatureGroup. + description: >- + The Cloud Storage URI that points to a YAML file describing the + annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/, note that + the chosen schema must be consistent with metadata of the Dataset + specified by dataset_id. Only used for custom training data export + use cases. Only applicable to Datasets that have DataItems and + Annotations. Only Annotations that both match this schema and belong + to DataItems not ignored by the split method are used in + respectively training, validation or test role, depending on the + role of the DataItem they are on. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both annotations_filter and annotation_schema_uri. + savedQueryId: type: string - etag: + description: >- + The ID of a SavedQuery (annotation set) under the Dataset specified + by dataset_id used for filtering Annotations for training. Only used + for custom training data export use cases. Only applicable to + Datasets that have SavedQueries. Only Annotations that are + associated with this SavedQuery are used in respectively training. + When used in conjunction with annotations_filter, the Annotations + used for training are filtered by both saved_query_id and + annotations_filter. Only one of saved_query_id and + annotation_schema_uri should be specified as both of them represent + the same thing: problem type. + annotationsFilter: type: string description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - labels: + An expression for filtering what part of the Dataset is to be + exported. Only Annotations that match this filter will be exported. + The filter syntax is the same as in ListAnnotations. + filterSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFilterSplit' + description: Split based on the provided filters for each set. + gcsDestination: description: >- - Optional. The labels with user-defined metadata to organize your - FeatureGroup. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one FeatureGroup(System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - additionalProperties: - type: string - type: object - description: Vertex AI Feature Group. - GoogleCloudAiplatformV1CountTokensResponse: - id: GoogleCloudAiplatformV1CountTokensResponse - description: Response message for PredictionService.CountTokens. + The Google Cloud Storage location where the output is to be written + to. In the given directory a new directory will be created with + name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ + ISO-8601 format. All export output will be written into that + directory. Inside that directory, annotations with the same schema + will be grouped into sub directories which are named with the + corresponding annotations' schema title. Inside these sub + directories, a schema.yaml will be created to describe the output + format. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + exportUse: + enum: + - EXPORT_USE_UNSPECIFIED + - CUSTOM_CODE_TRAINING + enumDescriptions: + - Regular user export. + - Export for custom code training. + description: Indicates the usage of the exported files. + type: string + GoogleCloudAiplatformV1ExportModelRequestOutputConfig: type: object properties: - totalBillableCharacters: + exportFormatId: description: >- - The total number of billable characters counted across all instances - from the request. - format: int32 - type: integer - totalTokens: + The ID of the format in which the Model must be exported. Each Model + lists the export formats it supports. If no value is provided here, + then the first from the list of the Model's supported formats is + used by default. + type: string + imageDestination: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ContainerRegistryDestination description: >- - The total number of tokens counted across all instances from the - request. - type: integer - format: int32 - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics: - description: Metrics for forecasting evaluation results. + The Google Container Registry or Artifact Registry uri where the + Model container image will be copied to. This field should only be + set when the `exportableContent` field of the + [Model.supported_export_formats] object contains `IMAGE`. + artifactDestination: + description: >- + The Cloud Storage location where the Model artifact is to be written + to. Under the directory given as the destination a new one with name + "`model-export--`", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ + ISO-8601 format, will be created. Inside, the Model and any of its + supporting files will be written. This field should only be set when + the `exportableContent` field of the + [Model.supported_export_formats] object contains `ARTIFACT`. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Output configuration for the Model export. + id: GoogleCloudAiplatformV1ExportModelRequestOutputConfig + GoogleCloudAiplatformV1SearchEntryPoint: + id: GoogleCloudAiplatformV1SearchEntryPoint + description: Google search entry point. + properties: + sdkBlob: + format: byte + description: Optional. Base64 encoded JSON representing array of tuple. + type: string + renderedContent: + type: string + description: >- + Optional. Web content snippet that can be embedded in a web page or + an app webview. type: object + GoogleCloudAiplatformV1IndexPrivateEndpoints: properties: - meanAbsoluteError: - description: Mean Absolute Error (MAE). - type: number - format: float - weightedAbsolutePercentageError: - format: float + matchGrpcAddress: + readOnly: true + type: string + description: Output only. The ip address used to send match gRPC requests. + pscAutomatedEndpoints: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' description: >- - Weighted Absolute Percentage Error. Does not use weights, this is - just what the metric is called. Undefined if actual values sum to - zero. Will be very large if actual values sum to a very small - number. - type: number - rootMeanSquaredError: - type: number - format: float - description: Root Mean Squared Error (RMSE). - rootMeanSquaredPercentageError: - format: float - type: number + Output only. PscAutomatedEndpoints is populated if private service + connect is enabled if PscAutomatedConfig is set. + serviceAttachment: + type: string + readOnly: true description: >- - Root Mean Square Percentage Error. Square root of MSPE. - Undefined/imaginary when MSPE is negative. - rSquared: - format: float - type: number + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. + type: object + id: GoogleCloudAiplatformV1IndexPrivateEndpoints + description: >- + IndexPrivateEndpoints proto is used to provide paths for users to send + requests via private endpoints (e.g. private service access, private + service connect). To send request via private service access, use + match_grpc_address. To send request via private service connect, use + service_attachment. + GoogleCloudAiplatformV1VertexRagStore: + type: object + properties: + similarityTopK: + type: integer + format: int32 description: >- - Coefficient of determination as Pearson correlation coefficient. - Undefined when ground truth or predictions are constant or near - constant. - quantileMetrics: + Optional. Number of top k results to return from the selected + corpora. + ragResources: + description: >- + Optional. The representation of the rag source. It can be used to + specify corpus only or ragfiles. Currently only support one corpus + or multiple files from one corpus. In the future we may open up + multiple corpora support. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry - description: The quantile metrics entries for each quantile. + #/components/schemas/GoogleCloudAiplatformV1VertexRagStoreRagResource type: array - meanAbsolutePercentageError: - description: >- - Mean absolute percentage error. Infinity when there are zeros in the - ground truth. - format: float + vectorDistanceThreshold: type: number - rootMeanSquaredLogError: description: >- - Root mean squared log error. Undefined when there are negative - ground truth values or predictions. - format: float - type: number - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics - GoogleCloudAiplatformV1BigQueryDestination: - description: The BigQuery location for the output content. + Optional. Only return results with vector distance smaller than the + threshold. + format: double + ragCorpora: + deprecated: true + description: Optional. Deprecated. Please use rag_resources instead. + items: + type: string + type: array + id: GoogleCloudAiplatformV1VertexRagStore + description: Retrieve from Vertex RAG Store for grounding. + GoogleCloudAiplatformV1FunctionCallingConfig: type: object - id: GoogleCloudAiplatformV1BigQueryDestination + description: Function calling config. properties: - outputUri: + allowedFunctionNames: description: >- - Required. BigQuery URI to a project or table, up to 2000 characters - long. When only the project is specified, the Dataset and Table is - created. When the full table reference is specified, the Dataset - must exist and table must not exist. Accepted forms: * BigQuery - path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` - or `bq://projectId.bqDatasetId.bqTableId`. + Optional. Function names to call. Only set when the Mode is ANY. + Function names should match [FunctionDeclaration.name]. With mode + set to ANY, model will predict a function call from the set of + function names provided. + type: array + items: + type: string + mode: + enum: + - MODE_UNSPECIFIED + - AUTO + - ANY + - NONE type: string - GoogleCloudAiplatformV1SchemaVideoDatasetMetadata: + description: Optional. Function calling mode. + enumDescriptions: + - Unspecified function calling mode. This value should not be used. + - >- + Default model behavior, model decides to predict either function + calls or natural language response. + - >- + Model is constrained to always predicting function calls only. If + "allowed_function_names" are set, the predicted function calls + will be limited to any one of "allowed_function_names", else the + predicted function calls will be any one of the provided + "function_declarations". + - >- + Model will not predict any function calls. Model behavior is same + as when not passing any function declarations. + id: GoogleCloudAiplatformV1FunctionCallingConfig + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective: type: object - id: GoogleCloudAiplatformV1SchemaVideoDatasetMetadata + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective + description: Stats requested for specific objective. properties: - dataItemSchemaUri: + topFeatureCount: description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Video DataItems that belong to this Dataset. + If set, all attribution scores between + SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time and + SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time are + fetched, and page token doesn't take effect in this case. Only used + to retrieve attribution score for the top Features which has the + highest attribution score in the latest monitoring run. + format: int32 + type: integer + type: + enumDescriptions: + - Default value, should not be set. + - >- + Raw feature values' stats to detect skew between + Training-Prediction datasets. + - >- + Raw feature values' stats to detect drift between + Serving-Prediction datasets. + - >- + Feature attribution scores to detect skew between + Training-Prediction datasets. + - >- + Feature attribution scores to detect skew between Prediction + datasets collected within different time windows. type: string - gcsBucket: + enum: + - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED + - RAW_FEATURE_SKEW + - RAW_FEATURE_DRIFT + - FEATURE_ATTRIBUTION_SKEW + - FEATURE_ATTRIBUTION_DRIFT + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + properties: + id: + description: ID of the AnnotationSpec. type: string - description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. - description: The metadata of Datasets that contain Video DataItems. - GoogleCloudAiplatformV1SafetyRating: + displayName: + type: string + description: Display name of the AnnotationSpec. + type: object + GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata: + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata + description: >- + Metadata information about the deployment for managing deployment + config. type: object - description: Safety rating corresponding to the generated content. - id: GoogleCloudAiplatformV1SafetyRating properties: - probabilityScore: - description: Output only. Harm probability score. - type: number - format: float - readOnly: true - severity: - readOnly: true - type: string - enumDescriptions: - - Harm severity unspecified. - - Negligible level of harm severity. - - Low level of harm severity. - - Medium level of harm severity. - - High level of harm severity. - enum: - - HARM_SEVERITY_UNSPECIFIED - - HARM_SEVERITY_NEGLIGIBLE - - HARM_SEVERITY_LOW - - HARM_SEVERITY_MEDIUM - - HARM_SEVERITY_HIGH - description: Output only. Harm severity levels in the content. - probability: - enumDescriptions: - - Harm probability unspecified. - - Negligible level of harm. - - Low level of harm. - - Medium level of harm. - - High level of harm. - readOnly: true + sampleRequest: + description: Optional. Sample request for deployed endpoint. type: string - description: Output only. Harm probability levels in the content. - enum: - - HARM_PROBABILITY_UNSPECIFIED - - NEGLIGIBLE - - LOW - - MEDIUM - - HIGH - severityScore: - description: Output only. Harm severity score. - type: number - readOnly: true - format: float - blocked: - readOnly: true - type: boolean + labels: description: >- - Output only. Indicates whether the content was filtered out because - of this rating. - category: - type: string - enumDescriptions: - - The harm category is unspecified. - - The harm category is hate speech. - - The harm category is dangerous content. - - The harm category is harassment. - - The harm category is sexually explicit content. - - The harm category is civic integrity. - enum: - - HARM_CATEGORY_UNSPECIFIED - - HARM_CATEGORY_HATE_SPEECH - - HARM_CATEGORY_DANGEROUS_CONTENT - - HARM_CATEGORY_HARASSMENT - - HARM_CATEGORY_SEXUALLY_EXPLICIT - - HARM_CATEGORY_CIVIC_INTEGRITY - readOnly: true - description: Output only. Harm category. - GoogleCloudAiplatformV1SearchFeaturesResponse: + Optional. Labels for the deployment. For managing deployment config + like verifying, source of deployment config, etc. + type: object + additionalProperties: + type: string + GoogleCloudAiplatformV1ListTensorboardsResponse: properties: + tensorboards: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + type: array + description: The Tensorboards mathching the request. nextPageToken: type: string description: >- - A token, which can be sent as SearchFeaturesRequest.page_token to + A token, which can be sent as ListTensorboardsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. - features: - description: >- - The Features matching the request. Fields returned: * `name` * - `description` * `labels` * `create_time` * `update_time` - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - type: array - type: object - id: GoogleCloudAiplatformV1SearchFeaturesResponse - description: Response message for FeaturestoreService.SearchFeatures. - GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore delete Features values. - id: GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata - description: Details of operations that delete Feature values. + description: Response message for TensorboardService.ListTensorboards. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation: + id: GoogleCloudAiplatformV1ListTensorboardsResponse + GoogleCloudAiplatformV1UndeployIndexRequest: + description: Request message for IndexEndpointService.UndeployIndex. properties: - columnName: - type: string - invalidValuesAllowed: + deployedIndexId: description: >- - If invalid values is allowed, the training pipeline will create a - boolean feature that indicated whether the value is valid. - Otherwise, the training pipeline will discard the input row from - trainining data. - type: boolean - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. * A boolean value that indicates whether the - value is valid. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation + Required. The ID of the DeployedIndex to be undeployed from the + IndexEndpoint. + type: string type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec + id: GoogleCloudAiplatformV1UndeployIndexRequest + GoogleCloudAiplatformV1GenericOperationMetadata: + description: Generic Metadata shared by all operations. + id: GoogleCloudAiplatformV1GenericOperationMetadata properties: - parallelTrialCount: - type: integer - description: The desired number of Trials to run in parallel. - format: int32 - maxTrialCount: - format: int32 - description: The desired total number of Trials. - type: integer - studySpec: - description: Study configuration of the HyperparameterTuningJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - maxFailedTrialCount: - format: int32 - type: integer - description: >- - The number of failed Trials that need to be seen before failing the - HyperparameterTuningJob. If set to 0, Vertex AI decides how many - Trials must fail before the whole job fails. - trialJobSpec: + updateTime: + format: google-datetime description: >- - The spec of a trial job. The same spec applies to the CustomJobs - created in all the trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - type: object - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: - description: >- - This message will be placed in the metadata field of a - google.longrunning.Operation associated with a - CheckTrialEarlyStoppingState request. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for suggesting Trials. - trial: + Output only. Time when the operation was updated for the last time. + If the operation has finished (successfully or not), this is the + finish time. type: string - description: The Trial name. - study: + readOnly: true + createTime: + readOnly: true type: string - description: The name of the Study that the Trial belongs to. - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata - type: object - GoogleCloudAiplatformV1StartNotebookRuntimeRequest: - properties: {} - id: GoogleCloudAiplatformV1StartNotebookRuntimeRequest - description: Request message for NotebookService.StartNotebookRuntime. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata: + format: google-datetime + description: Output only. Time when the operation was created. + partialFailures: + readOnly: true + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + description: >- + Output only. Partial failures encountered. E.g. single files that + couldn't be read. This field should never exceed 20 entries. Status + details field will contain standard Google Cloud error details. type: object + GoogleCloudAiplatformV1ListDataItemsResponse: properties: - costMilliNodeHours: - description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. - type: string - format: int64 - successfulStopReason: + nextPageToken: type: string - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED - enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - - >- - Further training of the Model ceased to increase its quality, - since it already has converged. + description: The standard List next-page token. + dataItems: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' description: >- - For successful job completions, this is the reason why the job has - finished. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata + A list of DataItems that matches the specified filter in the + request. + type: object + description: Response message for DatasetService.ListDataItems. + id: GoogleCloudAiplatformV1ListDataItemsResponse GoogleCloudAiplatformV1Tool: id: GoogleCloudAiplatformV1Tool + type: object description: >- Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - type: object properties: + retrieval: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' + description: >- + Optional. Retrieval tool type. System will always execute the + provided retrieval tool(s) to get external knowledge to answer the + prompt. Retrieval results are presented to the model for generation. functionDeclarations: + type: array items: $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionDeclaration' description: >- @@ -18597,2002 +17404,3579 @@ components: for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. - type: array - retrieval: - description: >- - Optional. Retrieval tool type. System will always execute the - provided retrieval tool(s) to get external knowledge to answer the - prompt. Retrieval results are presented to the model for generation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' googleSearchRetrieval: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' description: >- Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' - GoogleCloudAiplatformV1ReadFeatureValuesRequest: - properties: - featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - description: Required. Selector choosing Features of the target EntityType. - entityId: - description: >- - Required. ID for a specific entity. For example, for a machine - learning model predicting user clicks on a website, an entity ID - could be `user_123`. - type: string - type: object - description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. - id: GoogleCloudAiplatformV1ReadFeatureValuesRequest - GoogleCloudAiplatformV1FetchFeatureValuesRequest: - description: >- - Request message for FeatureOnlineStoreService.FetchFeatureValues. All - the features under the requested feature view will be returned. - id: GoogleCloudAiplatformV1FetchFeatureValuesRequest + GoogleCloudAiplatformV1SummarizationHelpfulnessSpec: type: object + description: Spec for summarization helpfulness score metric. + id: GoogleCloudAiplatformV1SummarizationHelpfulnessSpec properties: - dataKey: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' - description: Optional. The request key to fetch feature values for. - dataFormat: + version: + description: Optional. Which version to use for evaluation. + type: integer + format: int32 + useReference: + type: boolean description: >- - Optional. Response data format. If not set, - FeatureViewDataFormat.KEY_VALUE will be used. - type: string - enum: - - FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED - - KEY_VALUE - - PROTO_STRUCT - enumDescriptions: - - Not set. Will be treated as the KeyValue format. - - Return response data in key-value format. - - Return response data in proto Struct format. - GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult: - description: Prediction output format for Tabular Regression. + Optional. Whether to use instance.reference to compute summarization + helpfulness. + GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance: + description: Prediction input format for Video Object Tracking. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance + properties: + timeSegmentStart: + type: string + description: >- + The beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. + mimeType: + type: string + description: >- + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime + timeSegmentEnd: + description: >- + The end, exclusive, of the video's time segment on which to perform + the prediction. Expressed as a number of seconds as measured from + the start of the video, with "s" appended at the end. Fractions are + allowed, up to a microsecond precision, and "inf" or "Infinity" is + allowed, which means the end of the video. + type: string + content: + type: string + description: >- + The Google Cloud Storage location of the video on which to perform + the prediction. type: object + GoogleCloudAiplatformV1Tensorboard: properties: - lowerBound: - description: The lower bound of the prediction interval. - type: number - format: float - quantilePredictions: + blobStoragePathPrefix: + type: string + description: >- + Output only. Consumer project Cloud Storage path prefix used to + store blob data, which can either be a bucket or directory. Does not + end with a '/'. + readOnly: true + runCount: + format: int32 + description: Output only. The number of Runs stored in this Tensorboard. + readOnly: true + type: integer + satisfiesPzi: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + name: + type: string + description: >- + Output only. Name of the Tensorboard. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + readOnly: true + etag: + description: >- + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + type: string + updateTime: + description: Output only. Timestamp when this Tensorboard was last updated. + type: string + format: google-datetime + readOnly: true + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + displayName: + type: string + description: Required. User provided name of this Tensorboard. + labels: + description: >- + The labels with user-defined metadata to organize your Tensorboards. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Tensorboard + (System labels are excluded). See https://goo.gl/xmQnxf for more + information and examples of labels. System reserved label keys are + prefixed with "aiplatform.googleapis.com/" and are immutable. + additionalProperties: + type: string + type: object + description: + description: Description of this Tensorboard. + type: string + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. Timestamp when this Tensorboard was created. + isDefault: + type: boolean + description: >- + Used to indicate if the TensorBoard instance is the default one. + Each project & region can have at most one default TensorBoard + instance. Creation of a default TensorBoard instance and updating an + existing TensorBoard instance to be default will mark all other + TensorBoard instances (if any) as non default. + encryptionSpec: + description: >- + Customer-managed encryption key spec for a Tensorboard. If set, this + Tensorboard and all sub-resources of this Tensorboard will be + secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + type: object + id: GoogleCloudAiplatformV1Tensorboard + description: >- + Tensorboard is a physical database that stores users' training metrics. + A default Tensorboard is provided in each region of a Google Cloud + project. If needed users can also create extra Tensorboards in their + projects. + GoogleCloudAiplatformV1FunctionDeclaration: + properties: + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: >- + Optional. Describes the parameters to this function in JSON Schema + Object format. Reflects the Open API 3.03 Parameter Object. string + Key: the name of the parameter. Parameter names are case sensitive. + Schema Value: the Schema defining the type used for the parameter. + For function with no parameters, this can be left unset. Parameter + names must start with a letter or an underscore and must only + contain chars a-z, A-Z, 0-9, or underscores with a maximum length of + 64. Example with 1 required and 1 optional parameter: type: OBJECT + properties: param1: type: STRING param2: type: INTEGER required: - + param1 + name: + description: >- + Required. The name of the function to call. Must start with a letter + or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, + dots and dashes, with a maximum length of 64. + type: string + description: + type: string + description: >- + Optional. Description and purpose of the function. Model uses it to + decide how and whether to call the function. + response: + description: >- + Optional. Describes the output from this function in JSON Schema + format. Reflects the Open API 3.03 Response Object. The Schema + defines the type used for the response value of the function. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + type: object + id: GoogleCloudAiplatformV1FunctionDeclaration + description: >- + Structured representation of a function declaration as defined by the + [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). + Included in this declaration are the function name and parameters. This + FunctionDeclaration is a representation of a block of code that can be + used as a `Tool` by the model and executed by the client. + GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse: + properties: + importedModelEvaluationSlices: type: array - description: Quantile predictions, in 1-1 correspondence with quantile_values. - items: - type: number - format: float - quantileValues: - description: Quantile values. items: - format: float - type: number - type: array - value: - description: The regression value. - format: float - type: number - upperBound: - type: number - description: The upper bound of the prediction interval. - format: float - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult - GoogleCloudAiplatformV1MigratableResource: - id: GoogleCloudAiplatformV1MigratableResource - description: >- - Represents one resource that exists in automl.googleapis.com, - datalabeling.googleapis.com or ml.googleapis.com. + type: string + description: Output only. List of imported ModelEvaluationSlice.name. + readOnly: true + id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse + type: object + description: Response message for ModelService.BatchImportModelEvaluationSlices + GoogleCloudAiplatformV1IndexEndpoint: + id: GoogleCloudAiplatformV1IndexEndpoint type: object properties: - automlDataset: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlDataset - description: Output only. Represents one Dataset in automl.googleapis.com. + satisfiesPzi: + description: Output only. Reserved for future use. readOnly: true - lastMigrateTime: - type: string + type: boolean + encryptionSpec: description: >- - Output only. Timestamp when the last migration attempt on this - MigratableResource started. Will not be set if there's no migration - attempt on this MigratableResource. - readOnly: true + Immutable. Customer-managed encryption key spec for an + IndexEndpoint. If set, this IndexEndpoint and all sub-resources of + this IndexEndpoint will be secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + publicEndpointEnabled: + description: >- + Optional. If true, the deployed index will be accessible through + public endpoint. + type: boolean + updateTime: format: google-datetime - lastUpdateTime: + type: string + readOnly: true + description: >- + Output only. Timestamp when this IndexEndpoint was last updated. + This timestamp is not updated when the endpoint's DeployedIndexes + are updated, e.g. due to updates of the original Indexes they are + the deployments of. + createTime: + description: Output only. Timestamp when this IndexEndpoint was created. readOnly: true format: google-datetime + type: string + network: description: >- - Output only. Timestamp when this MigratableResource was last - updated. + Optional. The full name of the Google Compute Engine + [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + to which the IndexEndpoint should be peered. Private services access + must already be configured for the network. If left unspecified, the + Endpoint is not peered with any network. network and + private_service_connect_config are mutually exclusive. + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where {project} is a + project number, as in '12345', and {network} is network name. type: string - mlEngineModelVersion: + privateServiceConnectConfig: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion - description: Output only. Represents one Version in ml.googleapis.com. + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + description: >- + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + labels: + additionalProperties: + type: string + type: object + description: >- + The labels with user-defined metadata to organize your + IndexEndpoints. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean readOnly: true - dataLabelingDataset: - description: Output only. Represents one Dataset in datalabeling.googleapis.com. + displayName: + description: >- + Required. The display name of the IndexEndpoint. The name can be up + to 128 characters long and can consist of any UTF-8 characters. + type: string + description: + type: string + description: The description of the IndexEndpoint. + name: + description: Output only. The resource name of the IndexEndpoint. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset - automlModel: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlModel - description: Output only. Represents one Model in automl.googleapis.com. + type: string + publicEndpointDomainName: + description: >- + Output only. If public_endpoint_enabled is true, this field will be + populated with the domain name to use for this index endpoint. + type: string readOnly: true - GoogleCloudAiplatformV1QuestionAnsweringQualitySpec: - properties: - useReference: + etag: + type: string description: >- - Optional. Whether to use instance.reference to compute question - answering quality. + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + deployedIndexes: + description: Output only. The indexes deployed in this endpoint. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + type: array + readOnly: true + enablePrivateServiceConnect: + deprecated: true + description: >- + Optional. Deprecated: If true, expose the IndexEndpoint via private + service connect. Only one of the fields, network or + enable_private_service_connect, can be set. type: boolean - version: - description: Optional. Which version to use for evaluation. - format: int32 - type: integer - description: Spec for question answering quality score metric. + description: >- + Indexes are deployed into it. An IndexEndpoint can have multiple + DeployedIndexes. + GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Runtime operation information for CreateDeploymentResourcePool method. type: object - id: GoogleCloudAiplatformV1QuestionAnsweringQualitySpec - GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec: + GoogleCloudAiplatformV1NearestNeighborsNeighbor: + type: object + description: A neighbor of the query vector. + id: GoogleCloudAiplatformV1NearestNeighborsNeighbor properties: - values: - items: - type: number - format: double - type: array + entityKeyValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse description: >- - Required. A list of possible values. The list should be in - increasing order and at least 1e-10 apart. For instance, this - parameter might have possible settings of 1.5, 2.5, and 4.0. This - list should not contain more than 1,000 values. - defaultValue: + The attributes of the neighbor, e.g. filters, crowding and metadata + Note that full entities are returned only when "return_full_entity" + is set to true. Otherwise, only the "entity_id" and "distance" + fields are populated. + distance: format: double + description: The distance between the neighbor and the query vector. type: number - description: >- - A default value for a `DISCRETE` parameter that is assumed to be a - relatively good starting point. Unset value signals that there is no - offered starting point. It automatically rounds to the nearest - feasible discrete point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - id: GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec - description: Value specification for a parameter in `DISCRETE` type. + entityId: + description: The id of the similar entity. + type: string + GoogleCloudAiplatformV1AddExecutionEventsResponse: + description: Response message for MetadataService.AddExecutionEvents. + id: GoogleCloudAiplatformV1AddExecutionEventsResponse type: object - GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult: + properties: {} + GoogleCloudAiplatformV1FeatureValueMetadata: type: object + id: GoogleCloudAiplatformV1FeatureValueMetadata + description: Metadata of feature value. properties: - tftFeatureImportance: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance - description: Only use these if TFt is enabled. - value: - description: The regression value. - type: number - format: float - quantilePredictions: - description: Quantile predictions, in 1-1 correspondence with quantile_values. - type: array - items: - format: float - type: number - quantileValues: - type: array - items: - format: float - type: number - description: Quantile values. - description: Prediction output format for Time Series Forecasting. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult - GoogleCloudAiplatformV1SchemaPredictionResultError: - id: GoogleCloudAiplatformV1SchemaPredictionResultError + generateTime: + format: google-datetime + type: string + description: >- + Feature generation timestamp. Typically, it is provided by user at + feature ingestion time. If not, feature store will use the system + timestamp when the data is ingested into feature store. For + streaming ingestion, the time, aligned by days, must be no older + than five years (1825 days) and no later than one year (366 days) in + the future. + GoogleCloudAiplatformV1DeployedModelRef: + type: object properties: - message: + endpoint: type: string - description: Error message with additional details. - status: + description: Immutable. A resource name of an Endpoint. + deployedModelId: + description: Immutable. An ID of a DeployedModel in the above Endpoint. + type: string + description: Points to a DeployedModel. + id: GoogleCloudAiplatformV1DeployedModelRef + GoogleCloudAiplatformV1CoherenceSpec: + properties: + version: + description: Optional. Which version to use for evaluation. + format: int32 + type: integer + type: object + description: Spec for coherence score metric. + id: GoogleCloudAiplatformV1CoherenceSpec + GoogleProtobufEmpty: + type: object + id: GoogleProtobufEmpty + properties: {} + 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); } + GoogleCloudAiplatformV1SchemaTextSegment: + type: object + id: GoogleCloudAiplatformV1SchemaTextSegment + description: The text segment inside of DataItem. + properties: + startOffset: description: >- - Error status. This will be serialized into the enum name e.g. - "NOT_FOUND". + Zero-based character index of the first character of the text + segment (counting characters from the beginning of the text). + type: string + format: uint64 + content: + type: string + description: The text content in the segment for output only. + endOffset: + description: >- + Zero-based character index of the first character past the end of + the text segment (counting character from the beginning of the + text). The character at the end_offset is NOT included in the text + segment. + format: uint64 + type: string + GoogleCloudAiplatformV1PublisherModel: + id: GoogleCloudAiplatformV1PublisherModel + properties: + publisherModelTemplate: + description: >- + Optional. Output only. Immutable. Used to indicate this model has a + publisher model and provide the template of the publisher model + resource name. + type: string + readOnly: true + launchStage: + description: Optional. Indicates the launch stage of the model. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - EXPERIMENTAL + - PRIVATE_PREVIEW + - PUBLIC_PREVIEW + - GA + type: string enumDescriptions: - - 'Not an error; returned on success. HTTP Mapping: 200 OK' - - >- - The operation was cancelled, typically by the caller. HTTP - Mapping: 499 Client Closed Request + - The model launch stage is unspecified. - >- - Unknown error. For example, this error may be returned when a - `Status` value received from another address space belongs to an - error space that is not known in this address space. Also errors - raised by APIs that do not return enough error information may be - converted to this error. HTTP Mapping: 500 Internal Server Error + Used to indicate the PublisherModel is at Experimental launch + stage, available to a small set of customers. - >- - The client specified an invalid argument. Note that this differs - from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments - that are problematic regardless of the state of the system (e.g., - a malformed file name). HTTP Mapping: 400 Bad Request + Used to indicate the PublisherModel is at Private Preview launch + stage, only available to a small set of customers, although a + larger set of customers than an Experimental launch. Previews are + the first launch stage used to get feedback from customers. - >- - The deadline expired before the operation could complete. For - operations that change the state of the system, this error may be - returned even if the operation has completed successfully. For - example, a successful response from a server could have been - delayed long enough for the deadline to expire. HTTP Mapping: 504 - Gateway Timeout + Used to indicate the PublisherModel is at Public Preview launch + stage, available to all customers, although not supported for + production workloads. - >- - Some requested entity (e.g., file or directory) was not found. - Note to server developers: if a request is denied for an entire - class of users, such as gradual feature rollout or undocumented - allowlist, `NOT_FOUND` may be used. If a request is denied for - some users within a class of users, such as user-based access - control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not - Found - - >- - The entity that a client attempted to create (e.g., file or - directory) already exists. HTTP Mapping: 409 Conflict - - >- - The caller does not have permission to execute the specified - operation. `PERMISSION_DENIED` must not be used for rejections - caused by exhausting some resource (use `RESOURCE_EXHAUSTED` - instead for those errors). `PERMISSION_DENIED` must not be used if - the caller can not be identified (use `UNAUTHENTICATED` instead - for those errors). This error code does not imply the request is - valid or the requested entity exists or satisfies other - pre-conditions. HTTP Mapping: 403 Forbidden - - >- - The request does not have valid authentication credentials for the - operation. HTTP Mapping: 401 Unauthorized - - >- - Some resource has been exhausted, perhaps a per-user quota, or - perhaps the entire file system is out of space. HTTP Mapping: 429 - Too Many Requests - - >- - The operation was rejected because the system is not in a state - required for the operation's execution. For example, the directory - to be deleted is non-empty, an rmdir operation is applied to a - non-directory, etc. Service implementors can use the following - guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and - `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just - the failing call. (b) Use `ABORTED` if the client should retry at - a higher level. For example, when a client-specified test-and-set - fails, indicating the client should restart a read-modify-write - sequence. (c) Use `FAILED_PRECONDITION` if the client should not - retry until the system state has been explicitly fixed. For - example, if an "rmdir" fails because the directory is non-empty, - `FAILED_PRECONDITION` should be returned since the client should - not retry unless the files are deleted from the directory. HTTP - Mapping: 400 Bad Request - - >- - The operation was aborted, typically due to a concurrency issue - such as a sequencer check failure or transaction abort. See the - guidelines above for deciding between `FAILED_PRECONDITION`, - `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict - - >- - The operation was attempted past the valid range. E.g., seeking or - reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error - indicates a problem that may be fixed if the system state changes. - For example, a 32-bit file system will generate `INVALID_ARGUMENT` - if asked to read at an offset that is not in the range [0,2^32-1], - but it will generate `OUT_OF_RANGE` if asked to read from an - offset past the current file size. There is a fair bit of overlap - between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend - using `OUT_OF_RANGE` (the more specific error) when it applies so - that callers who are iterating through a space can easily look for - an `OUT_OF_RANGE` error to detect when they are done. HTTP - Mapping: 400 Bad Request - - >- - The operation is not implemented or is not supported/enabled in - this service. HTTP Mapping: 501 Not Implemented - - >- - Internal errors. This means that some invariants expected by the - underlying system have been broken. This error code is reserved - for serious errors. HTTP Mapping: 500 Internal Server Error - - >- - The service is currently unavailable. This is most likely a - transient condition, which can be corrected by retrying with a - backoff. Note that it is not always safe to retry non-idempotent - operations. See the guidelines above for deciding between - `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: - 503 Service Unavailable - - >- - Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal - Server Error + Used to indicate the PublisherModel is at GA launch stage, + available to all customers and ready for production workload. + versionState: + description: Optional. Indicates the state of the model version. enum: - - OK - - CANCELLED - - UNKNOWN - - INVALID_ARGUMENT - - DEADLINE_EXCEEDED - - NOT_FOUND - - ALREADY_EXISTS - - PERMISSION_DENIED - - UNAUTHENTICATED - - RESOURCE_EXHAUSTED - - FAILED_PRECONDITION - - ABORTED - - OUT_OF_RANGE - - UNIMPLEMENTED - - INTERNAL - - UNAVAILABLE - - DATA_LOSS + - VERSION_STATE_UNSPECIFIED + - VERSION_STATE_STABLE + - VERSION_STATE_UNSTABLE type: string - type: object - GoogleCloudAiplatformV1ExplanationMetadataInputMetadata: - id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadata - properties: - featureValueDomain: - description: >- - The domain details of the input feature value. Like min/max, - original mean or standard deviation if normalized. + enumDescriptions: + - The version state is unspecified. + - Used to indicate the version is stable. + - Used to indicate the version is unstable. + name: + type: string + readOnly: true + description: Output only. The resource name of the PublisherModel. + supportedActions: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain - encodedBaselines: + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToAction + description: Optional. Supported call-to-action options. + predictSchemata: description: >- - A list of baselines for the encoded tensor. The shape of each - baseline should match the shape of the encoded tensor. If a scalar - is provided, Vertex AI broadcasts to the same shape as the encoded - tensor. + Optional. The schemata that describes formats of the + PublisherModel's predictions and explanations as given and returned + via PredictionService.Predict. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + frameworks: type: array items: - type: any - denseShapeTensorName: - description: >- - Specifies the shape of the values of the input if the input is a - sparse representation. Refer to Tensorflow documentation for more - details: - https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. - type: string - indicesTensorName: - type: string - description: >- - Specifies the index of the values of the input tensor. Required when - the input tensor is a sparse representation. Refer to Tensorflow - documentation for more details: - https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. - encoding: + type: string + description: Optional. Additional information about the model's Frameworks. + openSourceCategory: + enum: + - OPEN_SOURCE_CATEGORY_UNSPECIFIED + - PROPRIETARY + - GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT + - THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT + - GOOGLE_OWNED_OSS + - THIRD_PARTY_OWNED_OSS enumDescriptions: - - Default value. This is the same as IDENTITY. - - The tensor represents one feature. - - >- - The tensor represents a bag of features where each index maps to a - feature. InputMetadata.index_feature_mapping must be provided for - this encoding. For example: ``` input = [27, 6.0, 150] - index_feature_mapping = ["age", "height", "weight"] ``` + - The open source category is unspecified, which should not be used. + - Used to indicate the PublisherModel is not open sourced. - >- - The tensor represents a bag of features where each index maps to a - feature. Zero values in the tensor indicates feature being - non-existent. InputMetadata.index_feature_mapping must be provided - for this encoding. For example: ``` input = [2, 0, 5, 0, 1] - index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + Used to indicate the PublisherModel is a Google-owned open source + model w/ Google checkpoint. - >- - The tensor is a list of binaries representing whether a feature - exists or not (1 indicates existence). - InputMetadata.index_feature_mapping must be provided for this - encoding. For example: ``` input = [1, 0, 1, 0, 1] - index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + Used to indicate the PublisherModel is a 3p-owned open source + model w/ Google checkpoint. - >- - The tensor is encoded into a 1-dimensional array represented by an - encoded tensor. InputMetadata.encoded_tensor_name must be provided - for this encoding. For example: ``` input = ["This", "is", "a", - "test", "."] encoded = [0.1, 0.2, 0.3, 0.4, 0.5] ``` + Used to indicate the PublisherModel is a Google-owned pure open + source model. - >- - Select this encoding when the input tensor is encoded into a - 2-dimensional array represented by an encoded tensor. - InputMetadata.encoded_tensor_name must be provided for this - encoding. The first dimension of the encoded tensor's shape is the - same as the input tensor's shape. For example: ``` input = - ["This", "is", "a", "test", "."] encoded = [[0.1, 0.2, 0.3, 0.4, - 0.5], [0.2, 0.1, 0.4, 0.3, 0.5], [0.5, 0.1, 0.3, 0.5, 0.4], [0.5, - 0.3, 0.1, 0.2, 0.4], [0.4, 0.3, 0.2, 0.5, 0.1]] ``` - enum: - - ENCODING_UNSPECIFIED - - IDENTITY - - BAG_OF_FEATURES - - BAG_OF_FEATURES_SPARSE - - INDICATOR - - COMBINED_EMBEDDING - - CONCAT_EMBEDDING + Used to indicate the PublisherModel is a 3p-owned pure open source + model. + description: Required. Indicates the open source category of the publisher model. + type: string + versionId: description: >- - Defines how the feature is encoded into the input tensor. Defaults - to IDENTITY. + Output only. Immutable. The version ID of the PublisherModel. A new + version is committed when a new model version is uploaded under an + existing model id. It is an auto-incrementing decimal number in + string representation. + type: string + readOnly: true + description: A Model Garden Publisher Model. + type: object + GoogleCloudAiplatformV1SyncFeatureViewResponse: + properties: + featureViewSync: type: string - indexFeatureMapping: description: >- - A list of feature names for each index in the input tensor. Required - when the input InputMetadata.encoding is BAG_OF_FEATURES, - BAG_OF_FEATURES_SPARSE, INDICATOR. - type: array - items: - type: string - inputBaselines: + Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` + description: Response message for FeatureOnlineStoreAdminService.SyncFeatureView. + type: object + id: GoogleCloudAiplatformV1SyncFeatureViewResponse + GoogleCloudAiplatformV1RougeInput: + description: Input for rouge metric. + properties: + instances: items: - type: any + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInstance' type: array + description: Required. Repeated rouge instances. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeSpec' + description: Required. Spec for rouge score metric. + id: GoogleCloudAiplatformV1RougeInput + type: object + GoogleCloudAiplatformV1SavedQuery: + id: GoogleCloudAiplatformV1SavedQuery + type: object + properties: + createTime: + format: google-datetime + description: Output only. Timestamp when this SavedQuery was created. + readOnly: true + type: string + etag: + type: string description: >- - Baseline inputs for this feature. If no baseline is specified, - Vertex AI chooses the baseline for this feature. If multiple - baselines are specified, Vertex AI returns the average attributions - across them in Attribution.feature_attributions. For Vertex - AI-provided Tensorflow images (both 1.x and 2.x), the shape of each - baseline must match the shape of the input tensor. If a scalar is - provided, we broadcast to the same shape as the input tensor. For - custom images, the element of the baselines must be in the same - format as the feature's input in the instance[]. The schema of any - single instance may be specified via Endpoint's DeployedModels' - Model's PredictSchemata's instance_schema_uri. - inputTensorName: - description: >- - Name of the input tensor for this feature. Required and is only - applicable to Vertex AI-provided images for Tensorflow. + Used to perform a consistent read-modify-write update. If not set, a + blind "overwrite" update happens. + metadata: + type: any + description: Some additional information about the SavedQuery. + problemType: type: string - visualization: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization - description: Visualization configurations for image explanation. - modality: + description: >- + Required. Problem type of the SavedQuery. Allowed values: * + IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL + * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * + TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * + TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * + VIDEO_OBJECT_TRACKING + displayName: type: string description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. - groupName: + Required. The user-defined name of the SavedQuery. The name can be + up to 128 characters long and can consist of any UTF-8 characters. + name: + readOnly: true + description: Output only. Resource name of the SavedQuery. + type: string + supportAutomlTraining: description: >- - Name of the group that the input belongs to. Features with the same - group name will be treated as one feature when computing - attributions. Features grouped together can have different shapes in - value. If provided, there will be one single attribution generated - in Attribution.feature_attributions, keyed by the group name. + Output only. If the Annotations belonging to the SavedQuery can be + used for AutoML training. + readOnly: true + type: boolean + annotationFilter: type: string - encodedTensorName: + readOnly: true + description: Output only. Filters on the Annotations in the dataset. + annotationSpecCount: + format: int32 description: >- - Encoded tensor is a transformation of the input tensor. Must be - provided if choosing Integrated Gradients attribution or XRAI - attribution and the input tensor is not differentiable. An encoded - tensor is generated if the input tensor is encoded by a lookup - table. + Output only. Number of AnnotationSpecs in the context of the + SavedQuery. + readOnly: true + type: integer + updateTime: + readOnly: true + description: Output only. Timestamp when SavedQuery was last updated. + format: google-datetime type: string description: >- - Metadata of the input of a feature. Fields other than - InputMetadata.input_baselines are applicable only for Models that are - using Vertex AI-provided images for Tensorflow. + A SavedQuery is a view of the dataset. It references a subset of + annotations by problem type and filters. + GoogleCloudAiplatformV1ToolParameterKVMatchInput: + properties: + metricSpec: + description: Required. Spec for tool parameter key value match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchSpec' + instances: + type: array + description: Required. Repeated tool parameter key value match instances. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInstance type: object - GoogleCloudAiplatformV1DeployModelOperationMetadata: - description: Runtime operation information for EndpointService.DeployModel. + description: Input for tool parameter key value match metric. + id: GoogleCloudAiplatformV1ToolParameterKVMatchInput + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata: + properties: + backingCustomJob: + type: string + description: >- + The resource name of the CustomJob that has been created to carry + out this custom task. type: object - id: GoogleCloudAiplatformV1DeployModelOperationMetadata + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + GoogleCloudAiplatformV1EvaluateInstancesResponse: + id: GoogleCloudAiplatformV1EvaluateInstancesResponse properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata: - description: Details of operations that perform create EntityType. + toolParameterKeyMatchResults: + description: Results for tool parameter key match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchResults + pairwiseSummarizationQualityResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityResult + description: Result for pairwise summarization quality metric. + toolParameterKvMatchResults: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchResults + description: Results for tool parameter key value match metric. + bleuResults: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuResults' + description: Results for bleu metric. + pairwiseQuestionAnsweringQualityResult: + description: Result for pairwise question answering quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult + rougeResults: + description: Results for rouge metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeResults' + questionAnsweringCorrectnessResult: + description: Result for question answering correctness metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult + fluencyResult: + description: >- + LLM-based metric evaluation result. General text generation metrics, + applicable to other categories. Result for fluency metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyResult' + summarizationHelpfulnessResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessResult + description: Result for summarization helpfulness metric. + pointwiseMetricResult: + description: Generic metrics. Result for pointwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricResult' + coherenceResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceResult' + description: Result for coherence metric. + fulfillmentResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentResult' + description: Result for fulfillment metric. + pairwiseMetricResult: + description: Result for pairwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricResult' + questionAnsweringHelpfulnessResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult + description: Result for question answering helpfulness metric. + exactMatchResults: + description: Auto metric evaluation results. Results for exact match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchResults' + toolCallValidResults: + description: Tool call metrics. Results for tool call valid metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidResults' + summarizationVerbosityResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityResult + description: Result for summarization verbosity metric. + questionAnsweringRelevanceResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult + description: Result for question answering relevance metric. + groundednessResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessResult' + description: Result for groundedness metric. + summarizationQualityResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityResult + description: Summarization only metrics. Result for summarization quality metric. + safetyResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyResult' + description: Result for safety metric. + toolNameMatchResults: + description: Results for tool name match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchResults' + questionAnsweringQualityResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityResult + description: >- + Question answering only metrics. Result for question answering + quality metric. + description: Response message for EvaluationService.EvaluateInstances. + type: object + GoogleCloudAiplatformV1UpdateIndexOperationMetadata: + id: GoogleCloudAiplatformV1UpdateIndexOperationMetadata type: object - id: GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata properties: + nearestNeighborSearchOperationMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + description: >- + The operation metadata with regard to Matching Engine Index + operation. genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for EntityType. - GoogleCloudAiplatformV1ModelContainerSpec: + description: The operation generic information. + description: Runtime operation information for IndexService.UpdateIndex. + CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: + type: object properties: - healthRoute: + publicMessage: + description: Public messages contains actionable items for the error cause. + type: string + errorCause: + enum: + - ERROR_CAUSE_UNSPECIFIED + - INVALID_PIPELINE_SPEC_FORMAT + - INVALID_PIPELINE_SPEC + - INVALID_DEPLOYMENT_CONFIG + - INVALID_DEPLOYMENT_SPEC + - INVALID_INSTANCE_SCHEMA + - INVALID_CUSTOM_JOB + - INVALID_CONTAINER_SPEC + - INVALID_NOTIFICATION_EMAIL_SETUP + - INVALID_SERVICE_ACCOUNT_SETUP + - INVALID_KMS_SETUP + - INVALID_NETWORK_SETUP + - INVALID_PIPELINE_TASK_SPEC + - INVALID_PIPELINE_TASK_ARTIFACT + - INVALID_IMPORTER_SPEC + - INVALID_RESOLVER_SPEC + - INVALID_RUNTIME_PARAMETERS + - CLOUD_API_NOT_ENABLED + - INVALID_GCS_INPUT_URI + - INVALID_GCS_OUTPUT_URI + - INVALID_COMPONENT_SPEC + - INVALID_DAG_OUTPUTS_SPEC + - INVALID_DAG_SPEC + - INSUFFICIENT_QUOTA + - INTERNAL + description: The error root cause returned by CreatePipelineJob API. + enumDescriptions: + - Should never be used. + - IR Pipeline Spec can not been parsed to yaml or json format. + - A pipeline spec is invalid. + - A deployment config is invalid. + - A deployment spec is invalid. + - An instance schema is invalid. + - A custom job is invalid. + - A container spec is invalid. + - Notification email setup is invalid. + - Service account setup is invalid. + - KMS setup is invalid. + - Network setup is invalid. + - Task spec is invalid. + - Task artifact is invalid. + - Importer spec is invalid. + - Resolver spec is invalid. + - Runtime Parameters are invalid. + - Cloud API not enabled. + - Invalid GCS input uri + - Invalid GCS output uri + - Component spec of pipeline is invalid. + - DagOutputsSpec is invalid. + - DagSpec is invalid. + - Project does not have enough quota. + - An internal error with unknown cause. + type: string + id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail + description: 'Create API error message for Vertex Pipeline. Next Id: 3.' + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics: + description: Metrics for a single confidence threshold. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + type: object + properties: + f1Score: + format: float + description: The harmonic mean of recall and precision. + type: number + confidenceThreshold: + type: number + description: The confidence threshold value used to compute the metrics. + format: float + precision: + format: float + description: Precision under the given confidence threshold. + type: number + recall: + type: number + description: Recall under the given confidence threshold. + format: float + GoogleCloudAiplatformV1SchemaAnnotationSpecColor: + properties: + id: + type: string + description: >- + The ID of the AnnotationSpec represented by the color in the + segmentation mask. + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: The color of the AnnotationSpec in a segmentation mask. + displayName: + description: >- + The display name of the AnnotationSpec represented by the color in + the segmentation mask. + type: string + description: >- + An entry of mapping between color and AnnotationSpec. The mapping is + used in segmentation mask. + type: object + id: GoogleCloudAiplatformV1SchemaAnnotationSpecColor + GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: + description: Response message for FeaturestoreService.BatchReadFeatureValues. + properties: {} + id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse + type: object + GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences: + description: >- + The regional resource name or the URI. Key is region, e.g., us-central1, + europe-west2, global, etc.. + type: object + id: >- + GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + properties: + resourceUseCase: + type: string + description: Optional. Use case (CUJ) of the resource. + title: + type: string + description: 'Required. ' + resourceTitle: + description: Optional. Title of the resource. + type: string + resourceDescription: + type: string + description: Optional. Description of the resource. + references: + type: object + description: Required. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelResourceReference + GoogleCloudAiplatformV1SuggestTrialsRequest: + type: object + id: GoogleCloudAiplatformV1SuggestTrialsRequest + description: Request message for VizierService.SuggestTrials. + properties: + clientId: + type: string + description: >- + Required. The identifier of the client that is requesting the + suggestion. If multiple SuggestTrialsRequests have the same + `client_id`, the service will return the identical suggested Trial + if the Trial is pending, and provide a new Trial if the last + suggested Trial was completed. + suggestionCount: + description: Required. The number of suggestions requested. It must be positive. + type: integer + format: int32 + contexts: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialContext' + description: >- + Optional. This allows you to specify the "context" for a Trial; a + context is a slice (a subspace) of the search space. Typical uses + for contexts: 1) You are using Vizier to tune a server for best + performance, but there's a strong weekly cycle. The context + specifies the day-of-week. This allows Tuesday to generalize from + Wednesday without assuming that everything is identical. 2) Imagine + you're optimizing some medical treatment for people. As they walk in + the door, you know certain facts about them (e.g. sex, weight, + height, blood-pressure). Put that information in the context, and + Vizier will adapt its suggestions to the patient. 3) You want to do + a fair A/B test efficiently. Specify the "A" and "B" conditions as + contexts, and Vizier will generalize between "A" and "B" conditions. + If they are similar, this will allow Vizier to converge to the + optimum faster than if "A" and "B" were separate Studies. NOTE: You + can also enter contexts as REQUESTED Trials, e.g. via the + CreateTrial() RPC; that's the asynchronous option where you don't + need a close association between contexts and suggestions. NOTE: All + the Parameters you set in a context MUST be defined in the Study. + NOTE: You must supply 0 or $suggestion_count contexts. If you don't + supply any contexts, Vizier will make suggestions from the full + search space specified in the StudySpec; if you supply a full set of + context, each suggestion will match the corresponding context. NOTE: + A Context with no features set matches anything, and allows + suggestions from the full search space. NOTE: Contexts MUST lie + within the search space specified in the StudySpec. It's an error if + they don't. NOTE: Contexts preferentially match ACTIVE then + REQUESTED trials before new suggestions are generated. NOTE: + Generation of suggestions involves a match between a Context and + (optionally) a REQUESTED trial; if that match is not fully + specified, a suggestion will be geneated in the merged subspace. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification: + description: >- + A TrainingJob that trains and uploads an AutoML Video Classification + Model. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + description: The input parameters of this TrainingJob. + type: object + GoogleCloudAiplatformV1DirectPredictRequest: + properties: + inputs: + type: array + description: The prediction input. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. + description: Request message for PredictionService.DirectPredict. + id: GoogleCloudAiplatformV1DirectPredictRequest + type: object + GoogleCloudAiplatformV1TensorboardBlob: + description: One blob (e.g, image, graph) viewable on a blob metric plot. + properties: + id: + description: >- + Output only. A URI safe key uniquely identifying a blob. Can be used + to locate the blob stored in the Cloud Storage bucket of the + consumer project. + type: string + readOnly: true + data: + type: string + description: >- + Optional. The bytes of the blob is not present unless it's returned + by the ReadTensorboardBlobData endpoint. + format: byte + id: GoogleCloudAiplatformV1TensorboardBlob + type: object + GoogleCloudAiplatformV1SummarizationVerbosityInstance: + description: Spec for summarization verbosity instance. + id: GoogleCloudAiplatformV1SummarizationVerbosityInstance + type: object + properties: + context: + description: Required. Text to be summarized. + type: string + instruction: + type: string + description: Optional. Summarization prompt for LLM. + prediction: + description: Required. Output of the evaluated model. + type: string + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest: + description: Request message for PipelineService.BatchCancelPipelineJobs. + id: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest + properties: + names: + description: >- + Required. The names of the PipelineJobs to cancel. A maximum of 32 + PipelineJobs can be cancelled in a batch. Format: + `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` + items: + type: string + type: array + type: object + GoogleCloudAiplatformV1GenerationConfig: + description: Generation config. + id: GoogleCloudAiplatformV1GenerationConfig + type: object + properties: + topK: + type: number + format: float + description: Optional. If specified, top-k sampling will be used. + seed: + type: integer + format: int32 + description: Optional. Seed. + topP: + description: Optional. If specified, nucleus sampling will be used. + type: number + format: float + routingConfig: + description: Optional. Routing configuration. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfig + responseSchema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: >- + Optional. The `Schema` object allows the definition of input and + output data types. These types can be objects, but also primitives + and arrays. Represents a select subset of an [OpenAPI 3.0 schema + object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a + compatible response_mime_type must also be set. Compatible + mimetypes: `application/json`: Schema for JSON response. + frequencyPenalty: + description: Optional. Frequency penalties. + type: number + format: float + responseMimeType: + type: string + description: >- + Optional. Output response mimetype of the generated candidate text. + Supported mimetype: - `text/plain`: (default) Text output. - + `application/json`: JSON response in the candidates. The model needs + to be prompted to output the appropriate response type, otherwise + the behavior is undefined. This is a preview feature. + stopSequences: + type: array + items: + type: string + description: Optional. Stop sequences. + candidateCount: + description: Optional. Number of candidates to generate. + format: int32 + type: integer + presencePenalty: + format: float + type: number + description: Optional. Positive penalties. + maxOutputTokens: + format: int32 + type: integer + description: >- + Optional. The maximum number of output tokens to generate per + message. + temperature: + description: Optional. Controls the randomness of predictions. + type: number + format: float + GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation: + type: object + description: Annotation details specific to video object tracking. + properties: + yMin: + description: The topmost coordinate of the bounding box. + format: double + type: number + xMin: + format: double + type: number + description: The leftmost coordinate of the bounding box. + xMax: + format: double + description: The rightmost coordinate of the bounding box. + type: number + timeOffset: + type: string + description: >- + A time (frame) of a video to which this annotation pertains. + Represented as the duration since the video's start. + format: google-duration + displayName: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + type: string + instanceId: + description: >- + The instance of the object, expressed as a positive integer. Used to + track the same object across different frames. + format: int64 + type: string + yMax: + description: The bottommost coordinate of the bounding box. + format: double + type: number + annotationSpecId: + type: string + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + id: GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation + CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: + properties: + iouScore: + description: >- + The intersection ratio between the detection bounding box and the + mask. + type: number + format: float + description: + description: Description of the label + type: string + mid: + description: MID of the label + type: string + boundingBox: + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + description: Bounding box of the label + score: + type: number + format: float + description: Confidence score of the label + type: object + description: The properties for a detected entity from the rai signal. + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata: + id: GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata + type: object + description: Metadata information for NotebookService.CreateNotebookRuntimeTemplate. + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1SchemaTextClassificationAnnotation: + properties: + annotationSpecId: + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + type: string + displayName: + type: string + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + description: Annotation details specific to text classification. + type: object + id: GoogleCloudAiplatformV1SchemaTextClassificationAnnotation + GoogleCloudAiplatformV1MetadataStore: + type: object + properties: + dataplexConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MetadataStoreDataplexConfig + description: Optional. Dataplex integration settings. + name: + readOnly: true + description: Output only. The resource name of the MetadataStore instance. + type: string + encryptionSpec: + description: >- + Customer-managed encryption key spec for a Metadata Store. If set, + this Metadata Store and all sub-resources of this Metadata Store are + secured using this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + updateTime: + type: string + format: google-datetime + description: Output only. Timestamp when this MetadataStore was last updated. + readOnly: true + state: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + description: Output only. State information of the MetadataStore. + createTime: + description: Output only. Timestamp when this MetadataStore was created. + readOnly: true + type: string + format: google-datetime + description: + description: Description of the MetadataStore. + type: string + id: GoogleCloudAiplatformV1MetadataStore + description: >- + Instance of a metadata store. Contains a set of metadata that can be + queried. + GoogleCloudAiplatformV1UnmanagedContainerModel: + properties: + artifactUri: + description: >- + The path to the directory containing the Model artifact and any of + its supporting files. + type: string + containerSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' + description: >- + Input only. The specification of the container that is to be used + when deploying this Model. + predictSchemata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + description: Contains the schemata used in Model's predictions and explanations + description: >- + Contains model information necessary to perform batch prediction without + requiring a full model import. + type: object + id: GoogleCloudAiplatformV1UnmanagedContainerModel + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation: + properties: + maskGcsUri: + description: >- + Google Cloud Storage URI that points to the mask image. The image + must be in PNG format. It must have the same size as the DataItem's + image. Each pixel in the image mask represents the AnnotationSpec + which the pixel in the image DataItem belong to. Each color is + mapped to one AnnotationSpec based on annotation_spec_colors. + type: string + annotationSpecColors: + description: The mapping between color and AnnotationSpec for this Annotation. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaAnnotationSpecColor + type: array + id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation + type: object + description: The mask based segmentation annotation. + GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: + description: Request message for ModelService.UpdateExplanationDataset. + id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest + properties: + examples: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + description: The example config containing the location of the dataset. + type: object + GoogleCloudAiplatformV1ListSchedulesResponse: + description: Response message for ScheduleService.ListSchedules + properties: + schedules: + type: array + description: List of Schedules in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListSchedulesRequest.page_token to obtain that page. + type: string + id: GoogleCloudAiplatformV1ListSchedulesResponse + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection: + description: >- + A TrainingJob that trains and uploads an AutoML Image Object Detection + Model. + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs + description: The input parameters of this TrainingJob. + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata + description: The metadata information + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection + GoogleCloudAiplatformV1FractionSplit: + type: object + description: >- + Assigns the input data to training, validation, and test sets as per the + given fractions. Any of `training_fraction`, `validation_fraction` and + `test_fraction` may optionally be provided, they must sum to up to 1. If + the provided ones sum to less than 1, the remainder is assigned to sets + as decided by Vertex AI. If none of the fractions are set, by default + roughly 80% of data is used for training, 10% for validation, and 10% + for test. + properties: + trainingFraction: + type: number + description: >- + The fraction of the input data that is to be used to train the + Model. + format: double + validationFraction: + type: number + description: >- + The fraction of the input data that is to be used to validate the + Model. + format: double + testFraction: + type: number + description: >- + The fraction of the input data that is to be used to evaluate the + Model. + format: double + id: GoogleCloudAiplatformV1FractionSplit + GoogleCloudAiplatformV1UpsertDatapointsResponse: + properties: {} + description: Response message for IndexService.UpsertDatapoints + id: GoogleCloudAiplatformV1UpsertDatapointsResponse + type: object + GoogleCloudAiplatformV1SummarizationHelpfulnessInput: + description: Input for summarization helpfulness metric. + properties: + metricSpec: + description: Required. Spec for summarization helpfulness score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessSpec + instance: + description: Required. Summarization helpfulness instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInstance + type: object + id: GoogleCloudAiplatformV1SummarizationHelpfulnessInput + GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult: + type: object + properties: + quantileValues: + description: Quantile values. + type: array + items: + format: float + type: number + quantilePredictions: + description: Quantile predictions, in 1-1 correspondence with quantile_values. + type: array + items: + format: float + type: number + upperBound: + type: number + format: float + description: The upper bound of the prediction interval. + lowerBound: + description: The lower bound of the prediction interval. + type: number + format: float + value: + format: float + description: The regression value. + type: number + description: Prediction output format for Tabular Regression. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult + GoogleCloudAiplatformV1SearchMigratableResourcesRequest: + properties: + filter: + description: >- + A filter for your search. You can use the following types of + filters: * Resource type filters. The following strings filter for a + specific type of MigratableResource: * `ml_engine_model_version:*` * + `automl_model:*` * `automl_dataset:*` * `data_labeling_dataset:*` * + "Migrated or not" filters. The following strings filter for + resources that either have or have not already been migrated: * + `last_migrate_time:*` filters for migrated resources. * `NOT + last_migrate_time:*` filters for not yet migrated resources. + type: string + pageToken: + type: string + description: The standard page token. + pageSize: + format: int32 + description: The standard page size. The default and maximum value is 100. + type: integer + description: Request message for MigrationService.SearchMigratableResources. + type: object + id: GoogleCloudAiplatformV1SearchMigratableResourcesRequest + GoogleCloudAiplatformV1CustomJob: + description: >- + Represents a job that runs custom workloads such as a Docker container + or a Python package. A CustomJob can have multiple worker pools and each + worker pool can have its own machine and input spec. A CustomJob will be + cleaned up once the job enters terminal state (failed or succeeded). + type: object + properties: + startTime: + description: >- + Output only. Time when the CustomJob for the first time entered the + `JOB_STATE_RUNNING` state. + type: string + readOnly: true + format: google-datetime + error: + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + description: >- + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + endTime: + description: >- + Output only. Time when the CustomJob entered any of the following + states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + readOnly: true + format: google-datetime + type: string + createTime: + type: string + format: google-datetime + description: Output only. Time when the CustomJob was created. + readOnly: true + name: + type: string + readOnly: true + description: Output only. Resource name of a CustomJob. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + displayName: + type: string + description: >- + Required. The display name of the CustomJob. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + labels: + type: object + description: >- + The labels with user-defined metadata to organize CustomJobs. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + additionalProperties: + type: string + jobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + description: Required. Job spec. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key options for a CustomJob. If this is + set, then all resources created by the CustomJob will be encrypted + with the provided encryption key. + updateTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Time when the CustomJob was most recently updated. + state: + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + readOnly: true + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + type: string + description: Output only. The detailed state of the job. + webAccessUris: + additionalProperties: + type: string + readOnly: true + type: object + description: >- + Output only. URIs for accessing [interactive + shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + (one URI for each training node). Only available if + job_spec.enable_web_access is `true`. The keys are names of each + node in the training job; for example, `workerpool0-0` for the + primary node, `workerpool1-0` for the first node in the second + worker pool, and `workerpool1-1` for the second node in the second + worker pool. The values are the URIs for each node's interactive + shell. + id: GoogleCloudAiplatformV1CustomJob + GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + id: GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata + description: Runtime operation information for UpdateDeploymentResourcePool method. + type: object + GoogleCloudAiplatformV1SupervisedHyperParameters: + description: Hyperparameters for SFT. + properties: + adapterSize: + enum: + - ADAPTER_SIZE_UNSPECIFIED + - ADAPTER_SIZE_ONE + - ADAPTER_SIZE_FOUR + - ADAPTER_SIZE_EIGHT + - ADAPTER_SIZE_SIXTEEN + - ADAPTER_SIZE_THIRTY_TWO + description: Optional. Adapter size for tuning. + enumDescriptions: + - Adapter size is unspecified. + - Adapter size 1. + - Adapter size 4. + - Adapter size 8. + - Adapter size 16. + - Adapter size 32. + type: string + learningRateMultiplier: + type: number + description: Optional. Multiplier for adjusting the default learning rate. + format: double + epochCount: + description: >- + Optional. Number of complete passes the model makes over the entire + training dataset during training. + format: int64 + type: string + id: GoogleCloudAiplatformV1SupervisedHyperParameters + type: object + GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest: + type: object + id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest + description: Request message for TensorboardService.BatchCreateTensorboardTimeSeries. + properties: + requests: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest + description: >- + Required. The request message specifying the TensorboardTimeSeries + to create. A maximum of 1000 TensorboardTimeSeries can be created in + a batch. + GoogleCloudAiplatformV1IntegratedGradientsAttribution: + description: >- + An attribution method that computes the Aumann-Shapley value taking + advantage of the model's fully differentiable structure. Refer to this + paper for more details: https://arxiv.org/abs/1703.01365 + type: object + id: GoogleCloudAiplatformV1IntegratedGradientsAttribution + properties: + blurBaselineConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' + description: >- + Config for IG with blur baseline. When enabled, a linear path from + the maximally blurred image to the input image is created. Using a + blurred baseline instead of zero (black image) is motivated by the + BlurIG approach explained here: https://arxiv.org/abs/2004.03383 + smoothGradConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' + description: >- + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy + samples in the vicinity of the inputs. Adding noise can help improve + the computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + stepCount: + description: >- + Required. The number of steps for approximating the path integral. A + good value to start is 50 and gradually increase until the sum to + diff property is within the desired error range. Valid range of its + value is [1, 100], inclusively. + format: int32 + type: integer + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking: + description: >- + A TrainingJob that trains and uploads an AutoML Video ObjectTracking + Model. + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs + description: The input parameters of this TrainingJob. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking + type: object + GoogleCloudAiplatformV1ListTensorboardExperimentsResponse: + properties: + nextPageToken: + description: >- + A token, which can be sent as + ListTensorboardExperimentsRequest.page_token to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + tensorboardExperiments: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment' + type: array + description: The TensorboardExperiments mathching the request. + description: Response message for TensorboardService.ListTensorboardExperiments. + type: object + id: GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + GoogleCloudAiplatformV1ToolParameterKeyMatchInstance: + type: object + id: GoogleCloudAiplatformV1ToolParameterKeyMatchInstance + properties: + prediction: + description: Required. Output of the evaluated model. + type: string + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + description: Spec for tool parameter key match instance. + GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo: + type: object + properties: + imageOutputUri: + type: string + readOnly: true + description: >- + Output only. If the Model image is being exported to Google + Container Registry or Artifact Registry this is the full path of the + image created. + artifactOutputUri: + description: >- + Output only. If the Model artifact is being exported to Google Cloud + Storage this is the full path of the directory created, into which + the Model files are being written to. + readOnly: true + type: string + id: GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo + description: >- + Further describes the output of the ExportModel. Supplements + ExportModelRequest.OutputConfig. + GoogleCloudAiplatformV1ContainerRegistryDestination: + properties: + outputUri: + type: string + description: >- + Required. Container Registry URI of a container image. Only Google + Container Registry and Artifact Registry are supported now. Accepted + forms: * Google Container Registry path. For example: + `gcr.io/projectId/imageName:tag`. * Artifact Registry path. For + example: + `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`. If a + tag is not specified, "latest" will be used as the default tag. + description: The Container Registry location for the container image. + type: object + id: GoogleCloudAiplatformV1ContainerRegistryDestination + GoogleCloudAiplatformV1SummarizationVerbosityResult: + type: object + id: GoogleCloudAiplatformV1SummarizationVerbosityResult + properties: + score: + type: number + description: Output only. Summarization Verbosity score. + readOnly: true + format: float + explanation: + description: Output only. Explanation for summarization verbosity score. + type: string + readOnly: true + confidence: + readOnly: true + format: float + description: Output only. Confidence for summarization verbosity score. + type: number + description: Spec for summarization verbosity result. + GoogleCloudAiplatformV1StructFieldValue: + type: object + id: GoogleCloudAiplatformV1StructFieldValue + properties: + name: + type: string + description: Name of the field in the struct feature. + value: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + description: The value for this field. + description: One field of a Struct (or object) type feature value. + GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse: + id: GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + properties: + timeSeriesData: + description: The returned time series data. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + type: object + description: Response message for TensorboardService.ReadTensorboardTimeSeriesData. + GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: + description: Details of operations that perform create FeatureOnlineStore. + properties: + genericMetadata: + description: Operation metadata for FeatureOnlineStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata + type: object + GoogleCloudAiplatformV1ToolParameterKVMatchInstance: + description: Spec for tool parameter key value match instance. + properties: + prediction: + type: string + description: Required. Output of the evaluated model. + reference: + description: Required. Ground truth used to compare against the prediction. + type: string + type: object + id: GoogleCloudAiplatformV1ToolParameterKVMatchInstance + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: + id: >- + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + properties: + model: + description: Migrated model resource name. + type: string + dataset: + description: Migrated dataset resource name. + type: string + request: + description: >- + It's the same as the value in + MigrateResourceRequest.migrate_resource_requests. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + error: + description: The error result of the migration request in case of failure. + $ref: '#/components/schemas/GoogleRpcStatus' + type: object + description: >- + Represents a partial result in batch migration operation for one + MigrateResourceRequest. + GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams: + type: object + description: Prediction model parameters for Video Classification. + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams + properties: + shotClassification: + description: >- + Set to true to request shot-level classification. Vertex AI + determines the boundaries for each camera shot in the entire time + segment of the video that user specified in the input instance. + Vertex AI then returns labels and their confidence scores for each + detected shot, along with the start and end time of the shot. + WARNING: Model evaluation is not done for this classification type, + the quality of it depends on the training data, but there are no + metrics provided to describe that quality. Default value is false + type: boolean + oneSecIntervalClassification: + type: boolean + description: >- + Set to true to request classification for a video at one-second + intervals. Vertex AI returns labels and their confidence scores for + each second of the entire time segment of the video that user + specified in the input WARNING: Model evaluation is not done for + this classification type, the quality of it depends on the training + data, but there are no metrics provided to describe that quality. + Default value is false + confidenceThreshold: + description: >- + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + type: number + format: float + segmentClassification: + type: boolean + description: >- + Set to true to request segment-level classification. Vertex AI + returns labels and their confidence scores for the entire time + segment of the video that user specified in the input instance. + Default value is true + maxPredictions: + type: integer + format: int32 + description: >- + The Model only returns up to that many top, by confidence score, + predictions per instance. If this number is very high, the Model may + return fewer predictions. Default value is 10,000. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation: + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation + type: object + properties: + columnName: + type: string + GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec: + properties: + explanationSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + description: Explanation spec details. + explanationType: + description: >- + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + type: string + id: GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + type: object + GoogleCloudAiplatformV1PurgeExecutionsResponse: + type: object + properties: + purgeCount: + format: int64 + type: string + description: >- + The number of Executions that this request deleted (or, if `force` + is false, the number of Executions that will be deleted). This can + be an estimate. + purgeSample: + items: + type: string + type: array + description: >- + A sample of the Execution names that will be deleted. Only populated + if `force` is set to false. The maximum number of samples is 100 (it + is possible to return fewer). + id: GoogleCloudAiplatformV1PurgeExecutionsResponse + description: Response message for MetadataService.PurgeExecutions. + GoogleCloudAiplatformV1NearestNeighborQueryStringFilter: + type: object + description: >- + String filter is used to search a subset of the entities by using + boolean rules on string columns. For example: if a query specifies + string filter with 'name = color, allow_tokens = {red, blue}, + deny_tokens = {purple}',' then that query will match entities that are + red or blue, but if those points are also purple, then they will be + excluded even if they are red/blue. Only string filter is supported for + now, numeric filter will be supported in the near future. + properties: + name: + description: Required. Column names in BigQuery that used as filters. + type: string + allowTokens: + type: array + items: + type: string + description: Optional. The allowed tokens. + denyTokens: + description: Optional. The denied tokens. + items: + type: string + type: array + id: GoogleCloudAiplatformV1NearestNeighborQueryStringFilter + GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse: + type: object + properties: + notebookExecutionJobs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + description: List of NotebookExecutionJobs in the requested page. + nextPageToken: + type: string + description: >- + A token to retrieve next page of results. Pass to + ListNotebookExecutionJobs.page_token to obtain that page. + description: Response message for [NotebookService.CreateNotebookExecutionJob] + id: GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse + GoogleCloudAiplatformV1PublisherModelCallToAction: + type: object + description: Actions could take on this Publisher Model. + properties: + viewRestApi: + description: Optional. To view Rest API docs. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi + openEvaluationPipeline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open evaluation pipeline of the PublisherModel. + requestAccess: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Request for access. + openGenie: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open Genie / Playground. + openGenerationAiStudio: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open in Generation AI Studio. + openFineTuningPipelines: + description: Optional. Open fine-tuning pipelines of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines + openPromptTuningPipeline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open prompt-tuning pipeline of the PublisherModel. + openNotebook: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open notebook of the PublisherModel. + multiDeployVertex: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex + description: >- + Optional. Multiple setups to deploy the PublisherModel to Vertex + Endpoint. + openFineTuningPipeline: + description: Optional. Open fine-tuning pipeline of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + deploy: + description: Optional. Deploy the PublisherModel to Vertex Endpoint. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + openNotebooks: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks + description: Optional. Open notebooks of the PublisherModel. + createApplication: + description: Optional. Create application using the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + deployGke: + description: Optional. Deploy PublisherModel to Google Kubernetes Engine. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke + id: GoogleCloudAiplatformV1PublisherModelCallToAction + GoogleCloudAiplatformV1UploadModelRequest: + type: object + properties: + parentModel: + type: string + description: >- + Optional. The resource name of the model into which to upload the + version. Only specify this field when uploading a new version. + model: + description: Required. The Model to create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + modelId: + description: >- + Optional. The ID to use for the uploaded Model, which will become + the final component of the model 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. + type: string + serviceAccount: + type: string + description: >- + Optional. The user-provided custom service account to use to do the + model upload. If empty, [Vertex AI Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + will be used to access resources needed to upload the model. This + account must belong to the target project where the model is + uploaded to, i.e., the project specified in the `parent` field of + this request and have necessary read permissions (to Google Cloud + Storage, Artifact Registry, etc.). + id: GoogleCloudAiplatformV1UploadModelRequest + description: Request message for ModelService.UploadModel. + GoogleCloudAiplatformV1ScheduleRunResponse: + id: GoogleCloudAiplatformV1ScheduleRunResponse + description: Status of a scheduled run. + properties: + runResponse: + description: The response of the scheduled run. + type: string + scheduledRunTime: + type: string + description: The scheduled run time based on the user-specified schedule. + format: google-datetime + type: object + GoogleCloudAiplatformV1EvaluatedAnnotationExplanation: + description: Explanation result of the prediction produced by the Model. + properties: + explanation: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + description: Explanation attribution response details. + explanationType: + type: string + description: >- + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + type: object + id: GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata: + type: object + properties: + trainCostMilliNodeHours: + description: >- + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + format: int64 + type: string + evaluatedDataItemsBigqueryUri: + type: string + description: BigQuery destination uri for exported evaluated examples. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata + description: Model metadata specific to AutoML Forecasting. + GoogleCloudAiplatformV1AddContextChildrenRequest: + type: object + id: GoogleCloudAiplatformV1AddContextChildrenRequest + description: Request message for MetadataService.AddContextChildren. + properties: + childContexts: + description: The resource names of the child Contexts. + items: + type: string + type: array + GoogleCloudAiplatformV1PurgeContextsMetadata: + type: object + description: Details of operations that perform MetadataService.PurgeContexts. + id: GoogleCloudAiplatformV1PurgeContextsMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for purging Contexts. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata: + properties: + costMilliNodeHours: + type: string + format: int64 + description: >- + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. + successfulStopReason: + type: string + enumDescriptions: + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. + - >- + Further training of the Model ceased to increase its quality, + since it already has converged. + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED + description: >- + For successful job completions, this is the reason why the job has + finished. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec: + properties: + goal: + description: Required. The optimization goal of the metric. + type: string + enumDescriptions: + - Goal Type will default to maximize. + - Maximize the goal metric. + - Minimize the goal metric. + enum: + - GOAL_TYPE_UNSPECIFIED + - MAXIMIZE + - MINIMIZE + metricId: + description: Required. The ID of the metric. Must not contain whitespaces. + type: string + description: Represents a metric to optimize. + type: object + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + GoogleCloudAiplatformV1ReadIndexDatapointsRequest: + id: GoogleCloudAiplatformV1ReadIndexDatapointsRequest + properties: + ids: + type: array + items: + type: string + description: IDs of the datapoints to be searched for. + deployedIndexId: + type: string + description: The ID of the DeployedIndex that will serve the request. + type: object + description: The request message for MatchService.ReadIndexDatapoints. + GoogleCloudAiplatformV1FeatureView: + description: >- + FeatureView is representation of values that the FeatureOnlineStore will + serve based on its syncConfig. + properties: + bigQuerySource: + description: >- + Optional. Configures how data is supposed to be extracted from a + BigQuery source to be loaded onto the FeatureOnlineStore. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewBigQuerySource + indexConfig: + description: >- + Optional. Configuration for index preparation for vector search. It + contains the required configurations to create an index from source + data, so that approximate nearest neighbor (a.k.a ANN) algorithms + search can be performed during online serving. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfig' + name: + type: string + description: >- + Identifier. Name of the FeatureView. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + etag: + type: string + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + vertexRagSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewVertexRagSource + description: Optional. The Vertex RAG Source that the FeatureView is linked to. + labels: + additionalProperties: + type: string + description: >- + Optional. The labels with user-defined metadata to organize your + FeatureViews. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureOnlineStore(System labels are excluded)." System + reserved label keys are prefixed with "aiplatform.googleapis.com/" + and are immutable. + type: object + updateTime: + description: Output only. Timestamp when this FeatureView was last updated. + readOnly: true + type: string + format: google-datetime + satisfiesPzs: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + featureRegistrySource: + description: >- + Optional. Configures the features from a Feature Registry source + that need to be loaded onto the FeatureOnlineStore. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource + syncConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncConfig' + description: >- + Configures when data is to be synced/updated for this FeatureView. + At the end of the sync the latest featureValues for each entityId of + this FeatureView are made ready for online serving. + createTime: + type: string + description: Output only. Timestamp when this FeatureView was created. + format: google-datetime + readOnly: true + id: GoogleCloudAiplatformV1FeatureView + type: object + GoogleCloudAiplatformV1ExportDataRequest: + properties: + exportConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataConfig' + description: Required. The desired output location. + id: GoogleCloudAiplatformV1ExportDataRequest + description: Request message for DatasetService.ExportData. + type: object + GoogleCloudAiplatformV1ToolCallValidInput: + properties: + instances: + type: array + description: Required. Repeated tool call valid instances. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInstance' + metricSpec: + description: Required. Spec for tool call valid metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidSpec' + id: GoogleCloudAiplatformV1ToolCallValidInput + description: Input for tool call valid metric. + type: object + GoogleCloudAiplatformV1CoherenceInput: + properties: + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceSpec' + description: Required. Spec for coherence score metric. + instance: + description: Required. Coherence instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInstance' + id: GoogleCloudAiplatformV1CoherenceInput + type: object + description: Input for coherence metric. + GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride: + description: The input metadata entries to be overridden. + id: GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + properties: + inputBaselines: + items: + type: any + description: >- + Baseline inputs for this feature. This overrides the + `input_baseline` field of the ExplanationMetadata.InputMetadata + object of the corresponding feature's input metadata. If it's not + specified, the original baselines are not overridden. + type: array + type: object + GoogleCloudAiplatformV1SchemaTimeSegment: + description: >- + A time period inside of a DataItem that has a time dimension (e.g. + video). + properties: + startTimeOffset: + description: >- + Start of the time segment (inclusive), represented as the duration + since the start of the DataItem. + format: google-duration + type: string + endTimeOffset: + description: >- + End of the time segment (exclusive), represented as the duration + since the start of the DataItem. + format: google-duration + type: string + type: object + id: GoogleCloudAiplatformV1SchemaTimeSegment + GoogleCloudAiplatformV1Model: + description: A trained machine learning Model. + type: object + properties: + pipelineJob: + description: >- + Optional. This field is populated if the model is produced by a + pipeline job. + type: string + explanationSpec: + description: >- + The default explanation specification for this Model. The Model can + be used for requesting explanation after being deployed if it is + populated. The Model can be used for batch explanation if it is + populated. All fields of the explanation_spec can be overridden by + explanation_spec of DeployModelRequest.deployed_model, or + explanation_spec of BatchPredictionJob. If the default explanation + specification is not set for this Model, this Model can still be + used for requesting explanation by setting explanation_spec of + DeployModelRequest.deployed_model and for batch explanation by + setting explanation_spec of BatchPredictionJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + supportedOutputStorageFormats: + items: + type: string + readOnly: true + description: >- + Output only. The formats this Model supports in + BatchPredictionJob.output_config. If both + PredictSchemata.instance_schema_uri and + PredictSchemata.prediction_schema_uri exist, the predictions are + returned together with their instances. In other words, the + prediction has the original instance data first, followed by the + actual prediction content (as per the schema). The possible formats + are: * `jsonl` The JSON Lines format, where each prediction is a + single line. Uses GcsDestination. * `csv` The CSV format, where each + prediction is a single comma-separated line. The first line in the + file is the header, containing comma-separated field names. Uses + GcsDestination. * `bigquery` Each prediction is a single row in a + BigQuery table, uses BigQueryDestination . If this Model doesn't + support any of these formats it means it cannot be used with a + BatchPredictionJob. However, if it has + supported_deployment_resources_types, it could serve online + predictions by using PredictionService.Predict or + PredictionService.Explain. + type: array + name: + type: string + description: The resource name of the Model. + versionDescription: + description: The description of this version. + type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key spec for a Model. If set, this Model + and all sub-resources of this Model will be secured by this key. + originalModelInfo: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelOriginalModelInfo' + readOnly: true + description: >- + Output only. If this Model is a copy of another Model, this contains + info about the original. + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + supportedInputStorageFormats: + items: + type: string + description: >- + Output only. The formats this Model supports in + BatchPredictionJob.input_config. If + PredictSchemata.instance_schema_uri exists, the instances should be + given as per that schema. The possible formats are: * `jsonl` The + JSON Lines format, where each instance is a single line. Uses + GcsSource. * `csv` The CSV format, where each instance is a single + comma-separated line. The first line in the file is the header, + containing comma-separated field names. Uses GcsSource. * + `tf-record` The TFRecord format, where each instance is a single + record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` + Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * + `bigquery` Each instance is a single row in BigQuery. Uses + BigQuerySource. * `file-list` Each line of the file is the location + of an instance to process, uses `gcs_source` field of the + InputConfig object. If this Model doesn't support any of these + formats it means it cannot be used with a BatchPredictionJob. + However, if it has supported_deployment_resources_types, it could + serve online predictions by using PredictionService.Predict or + PredictionService.Explain. + readOnly: true + type: array + artifactUri: + description: >- + Immutable. The path to the directory containing the Model artifact + and any of its supporting files. Not required for AutoML Models. + type: string + metadataArtifact: + type: string + description: >- + Output only. The resource name of the Artifact that was created in + MetadataStore when creating the Model. The Artifact resource name + pattern is + `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + readOnly: true + predictSchemata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + description: >- + The schemata that describe formats of the Model's predictions and + explanations as given and returned via PredictionService.Predict and + PredictionService.Explain. + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. Timestamp when this Model was uploaded into Vertex AI. + etag: + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + type: string + containerSpec: + $ref: '#/components/schemas/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. + baseModelSource: + description: >- + Optional. User input field to specify the base model source. + Currently it only supports specifing the Model Garden models and + Genie models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelBaseModelSource' + labels: + description: >- + The labels with user-defined metadata to organize your Models. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object + additionalProperties: + type: string + versionUpdateTime: + format: google-datetime + type: string + readOnly: true + description: Output only. Timestamp when this version was most recently updated. + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + deployedModels: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' + type: array + readOnly: true + description: >- + Output only. The pointers to DeployedModels created from this Model. + Note that Model could have been deployed to Endpoints in different + Locations. + dataStats: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' + description: >- + Stats of data used for training or evaluating the Model. Only + populated when the Model is trained by a TrainingPipeline with + data_input_config. + description: + type: string + description: The description of the Model. + versionAliases: + items: + type: string + description: >- + User provided version aliases so that a model version can be + referenced via alias (i.e. + `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` + instead of auto-generated version id (i.e. + `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. + The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A + default version alias will be created for the first version of the + model, and there must be exactly one default version alias for a + model. + type: array + metadataSchemaUri: + type: string + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Model, that is specific + to it. Unset if the Model does not have any additional information. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI, if no + additional metadata is needed, this field is set to an empty string. + Note: The URI given on output will be immutable and probably + different, including the URI scheme, than the one given on input. + The output URI will point to a location where the user only has a + read access. + metadata: + type: any + description: >- + Immutable. An additional information about the Model; the schema of + the metadata can be found in metadata_schema. Unset if the Model + does not have any additional information. + supportedDeploymentResourcesTypes: + type: array + description: >- + Output only. When this Model is deployed, its prediction resources + are described by the `prediction_resources` field of the + Endpoint.deployed_models object. Because not all Models support all + resource configuration types, the configuration types this Model + supports are listed here. If no configuration types are listed, the + Model cannot be deployed to an Endpoint and does not support online + predictions (PredictionService.Predict or + PredictionService.Explain). Such a Model can serve predictions by + using a BatchPredictionJob, if it has at least one entry each in + supported_input_storage_formats and + supported_output_storage_formats. + readOnly: true + items: + enumDescriptions: + - Should not be used. + - >- + Resources that are dedicated to the DeployedModel, and that need + a higher degree of manual configuration. + - >- + Resources that to large degree are decided by Vertex AI, and + require only a modest additional configuration. + - >- + Resources that can be shared by multiple DeployedModels. A + pre-configured DeploymentResourcePool is required. + enum: + - DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED + - DEDICATED_RESOURCES + - AUTOMATIC_RESOURCES + - SHARED_RESOURCES + type: string + displayName: description: >- - Immutable. HTTP path on the container to send health checks to. - Vertex AI intermittently sends GET requests to this path on the - container's IP address and port to check that the container is - healthy. Read more about [health - checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). - For example, if you set this field to `/bar`, then Vertex AI - intermittently sends a GET request to the `/bar` path on the port of - your container specified by the first value of this - `ModelContainerSpec`'s ports field. If you don't specify this field, - it defaults to the following value when you deploy this Model to an - Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ - DEPLOYED_MODEL:predict The placeholders in this value are replaced - as follows: * ENDPOINT: The last segment (following `endpoints/`)of - the Endpoint.name][] field of the Endpoint where this Model has been - deployed. (Vertex AI makes this value available to your container - code as the [`AIP_ENDPOINT_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex - AI makes this value available to your container code as the - [`AIP_DEPLOYED_MODEL_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + Required. The display name of the Model. The name can be up to 128 + characters long and can consist of any UTF-8 characters. type: string - ports: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' + versionCreateTime: + type: string + format: google-datetime + description: Output only. Timestamp when this version was created. + readOnly: true + versionId: + readOnly: true description: >- - Immutable. List of ports to expose from the container. Vertex AI - sends any prediction requests that it receives to the first port on - this list. Vertex AI also sends [liveness and health - checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) - to this port. If you do not specify this field, it defaults to - following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI - does not use ports other than the first one listed. This field - corresponds to the `ports` field of the Kubernetes Containers [v1 - core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - type: array - sharedMemorySizeMb: + Output only. Immutable. The version ID of the model. A new version + is committed when a new model version is uploaded or trained under + an existing model id. It is an auto-incrementing decimal number in + string representation. type: string + supportedExportFormats: description: >- - Immutable. The amount of the VM memory to reserve as the shared - memory for the model in megabytes. - format: int64 - env: + Output only. The formats in which this Model may be exported. If + empty, this Model is not available for export. type: array + readOnly: true items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' - description: >- - Immutable. List of environment variables to set in the container. - After the container starts running, code running in the container - can read these environment variables. Additionally, the command and - args fields can reference these variables. Later entries in this - list can also reference earlier entries. For example, the following - example sets the variable `VAR_2` to have the value `foo bar`: - ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", - "value": "$(VAR_1) bar" } ] ``` If you switch the order of the - variables in the example, then the expansion does not occur. This - field corresponds to the `env` field of the Kubernetes Containers - [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - imageUri: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExportFormat' + updateTime: + type: string + format: google-datetime + description: Output only. Timestamp when this Model was most recently updated. + readOnly: true + trainingPipeline: type: string description: >- - Required. Immutable. URI of the Docker image to be used as the - custom container for serving predictions. This URI must identify an - image in Artifact Registry or Container Registry. Learn more about - the [container publishing - requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), - including permissions requirements for the Vertex AI Service Agent. - The container image is ingested upon ModelService.UploadModel, - stored internally, and this original path is afterwards not used. To - learn about the requirements for the Docker image itself, see - [Custom container - requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). - You can use the URI to one of Vertex AI's [pre-built container - images for - prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) - in this field. - args: - type: array - items: - type: string + Output only. The resource name of the TrainingPipeline that uploaded + this Model, if any. + readOnly: true + modelSourceInfo: + readOnly: true description: >- - Immutable. Specifies arguments for the command that runs when the - container starts. This overrides the container's - [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). - Specify this field as an array of executable and arguments, similar - to a Docker `CMD`'s "default parameters" form. If you don't specify - this field but do specify the command field, then the command from - the `command` field runs without any additional arguments. See the - [Kubernetes documentation about how the `command` and `args` fields - interact with a container's `ENTRYPOINT` and - `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). - If you don't specify this field and don't specify the `command` - field, then the container's - [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) - and `CMD` determine what runs based on their default behavior. See - the Docker documentation about [how `CMD` and `ENTRYPOINT` - interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). - In this field, you can reference [environment variables set by - Vertex - AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - and environment variables set in the env field. You cannot reference - environment variables set in the Docker image. In order for - environment variables to be expanded, reference them by using the - following syntax: $( VARIABLE_NAME) Note that this differs from Bash - variable expansion, which does not use parentheses. If a variable - cannot be resolved, the reference in the input string is used - unchanged. To avoid variable expansion, you can escape this syntax - with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to - the `args` field of the Kubernetes Containers [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - grpcPorts: + Output only. Source of a model. It can either be automl training + pipeline, custom training pipeline, BigQuery ML, or saved and tuned + from Genie or Model Garden. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelSourceInfo' + id: GoogleCloudAiplatformV1Model + GoogleCloudAiplatformV1ListCustomJobsResponse: + id: GoogleCloudAiplatformV1ListCustomJobsResponse + description: Response message for JobService.ListCustomJobs + properties: + customJobs: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' - description: >- - Immutable. List of ports to expose from the container. Vertex AI - sends gRPC prediction requests that it receives to the first port on - this list. Vertex AI also sends liveness and health checks to this - port. If you do not specify this field, gRPC requests to the - container will be disabled. Vertex AI does not use ports other than - the first one listed. This field corresponds to the `ports` field of - the Kubernetes Containers v1 core API. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + description: List of CustomJobs in the requested page. type: array - deploymentTimeout: - format: google-duration + nextPageToken: description: >- - Immutable. Deployment timeout. Limit for deployment timeout is 2 - hours. + A token to retrieve the next page of results. Pass to + ListCustomJobsRequest.page_token to obtain that page. type: string - predictRoute: + type: object + GoogleCloudAiplatformV1TrainingConfig: + id: GoogleCloudAiplatformV1TrainingConfig + description: >- + CMLE training config. For every active learning labeling iteration, + system will train a machine learning model on CMLE. The trained model + will be used by data sampling algorithm to select DataItems. + properties: + timeoutTrainingMilliHours: description: >- - Immutable. HTTP path on the container to send prediction requests - to. Vertex AI forwards requests sent using - projects.locations.endpoints.predict to this path on the container's - IP address and port. Vertex AI then returns the container's response - in the API response. For example, if you set this field to `/foo`, - then when Vertex AI receives a prediction request, it forwards the - request body in a POST request to the `/foo` path on the port of - your container specified by the first value of this - `ModelContainerSpec`'s ports field. If you don't specify this field, - it defaults to the following value when you deploy this Model to an - Endpoint: - /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The - placeholders in this value are replaced as follows: * ENDPOINT: The - last segment (following `endpoints/`)of the Endpoint.name][] field - of the Endpoint where this Model has been deployed. (Vertex AI makes - this value available to your container code as the - [`AIP_ENDPOINT_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex - AI makes this value available to your container code as the - [`AIP_DEPLOYED_MODEL_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + The timeout hours for the CMLE training job, expressed in milli + hours i.e. 1,000 value in this field means 1 hour. type: string - command: - type: array - description: >- - Immutable. Specifies the command that runs when the container - starts. This overrides the container's - [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). - Specify this field as an array of executable and arguments, similar - to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you - do not specify this field, then the container's `ENTRYPOINT` runs, - in conjunction with the args field or the container's - [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if - either exists. If this field is not specified and the container does - not have an `ENTRYPOINT`, then refer to the Docker documentation - about [how `CMD` and `ENTRYPOINT` - interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). - If you specify this field, then you can also specify the `args` - field to provide additional arguments for this command. However, if - you specify this field, then the container's `CMD` is ignored. See - the [Kubernetes documentation about how the `command` and `args` - fields interact with a container's `ENTRYPOINT` and - `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). - In this field, you can reference [environment variables set by - Vertex - AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - and environment variables set in the env field. You cannot reference - environment variables set in the Docker image. In order for - environment variables to be expanded, reference them by using the - following syntax: $( VARIABLE_NAME) Note that this differs from Bash - variable expansion, which does not use parentheses. If a variable - cannot be resolved, the reference in the input string is used - unchanged. To avoid variable expansion, you can escape this syntax - with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to - the `command` field of the Kubernetes Containers [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - items: - type: string - healthProbe: - description: Immutable. Specification for Kubernetes readiness probe. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' - startupProbe: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' - description: Immutable. Specification for Kubernetes startup probe. + format: int64 type: object - id: GoogleCloudAiplatformV1ModelContainerSpec - description: >- - Specification of a container for serving predictions. Some fields in - this message correspond to fields in the [Kubernetes Container v1 core - specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata: - id: GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata + GoogleCloudAiplatformV1FeatureSelector: + id: GoogleCloudAiplatformV1FeatureSelector type: object properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Runtime operation information for UpdateDeploymentResourcePool method. - GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance: - description: Spec for question answering relevance instance. - type: object + idMatcher: + description: Required. Matches Features based on ID. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IdMatcher' + description: Selector for Features of an EntityType. + GoogleCloudAiplatformV1SchemaPredictionResult: properties: - prediction: - type: string - description: Required. Output of the evaluated model. - instruction: + key: + description: Optional user-provided key from the input instance. type: string + error: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictionResultError + description: The error result. Do not set prediction if this is set. + prediction: description: >- - Required. The question asked and other instruction in the inference - prompt. - reference: - description: Optional. Ground truth used to compare against the prediction. - type: string - context: - description: Optional. Text provided as context to answer the question. - type: string - id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource: - properties: - uri: - type: array - items: - type: string + The prediction result. Value is used here instead of Any so that + JsonFormat does not append an extra "@type" field when we convert + the proto to JSON and so we can represent array of objects. Do not + set error if this is set. + type: any + instance: + additionalProperties: + type: any + description: Properties of the object. + type: object description: >- - Cloud Storage URI of one or more files. Only CSV files are - supported. The first line of the CSV file is used as the header. If - there are multiple files, the header is the first line of the - lexicographically first file, the other files must either contain - the exact same header or omit the header. - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource + User's input instance. Struct is used here instead of Any so that + JsonFormat does not append an extra "@type" field when we convert + the proto to JSON. + description: Represents a line of JSONL in the batch prediction output file. type: object - CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: + id: GoogleCloudAiplatformV1SchemaPredictionResult + GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance: properties: - mid: - description: MID of the label - type: string - description: + mimeType: type: string - description: Description of the label - iouScore: - format: float - type: number description: >- - The intersection ratio between the detection bounding box and the - mask. - score: - type: number - format: float - description: Confidence score of the label - boundingBox: - $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - description: Bounding box of the label - description: The properties for a detected entity from the rai signal. - type: object - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity - GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest: - id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/png + content: + description: The image bytes to make the predictions on. + type: string + description: Prediction input format for Image Segmentation. type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance + GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig: properties: - entityIds: - items: - type: string + modelDisplayName: description: >- - Required. IDs of entities to read Feature values of. The maximum - number of IDs is 100. For example, for a machine learning model - predicting user clicks on a website, an entity ID could be - `user_123`. - type: array - featureSelector: + Optional. Display name of the model in Vertex AI. System will pick a + display name if unspecified. + type: string + model: description: >- - Required. Selector choosing Features of the target EntityType. - Feature IDs will be deduplicated. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + Required. Full resource name of automl Model. Format: + `projects/{project}/locations/{location}/models/{model}`. + type: string + type: object + id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig description: >- - Request message for - FeaturestoreOnlineServingService.StreamingFeatureValuesRead. - GoogleCloudAiplatformV1StudySpecParameterSpec: + Config for migrating Model in automl.googleapis.com to Vertex AI's + Model. + GoogleCloudAiplatformV1ComputeTokensResponse: + id: GoogleCloudAiplatformV1ComputeTokensResponse + type: object properties: - scaleType: - enumDescriptions: - - By default, no scaling is applied. - - Scales the feasible space to (0, 1) linearly. - - >- - Scales the feasible space logarithmically to (0, 1). The entire - feasible space must be strictly positive. - - >- - Scales the feasible space "reverse" logarithmically to (0, 1). The - result is that values close to the top of the feasible space are - spread out more than points near the bottom. The entire feasible - space must be strictly positive. - description: >- - How the parameter should be scaled. Leave unset for `CATEGORICAL` - parameters. - type: string - enum: - - SCALE_TYPE_UNSPECIFIED - - UNIT_LINEAR_SCALE - - UNIT_LOG_SCALE - - UNIT_REVERSE_LOG_SCALE - categoricalValueSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec - description: The value spec for a 'CATEGORICAL' parameter. - integerValueSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec - description: The value spec for an 'INTEGER' parameter. - discreteValueSpec: - description: The value spec for a 'DISCRETE' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec - doubleValueSpec: - description: The value spec for a 'DOUBLE' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec - conditionalParameterSpecs: - description: >- - A conditional parameter node is active if the parameter's value - matches the conditional node's parent_value_condition. If two items - in conditional_parameter_specs have the same name, they must have - disjoint parent_value_condition. + tokensInfo: type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec - parameterId: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1TokensInfo' description: >- - Required. The ID of the parameter. Must not contain whitespaces and - must be unique amongst all ParameterSpecs. - type: object - id: GoogleCloudAiplatformV1StudySpecParameterSpec - description: Represents a single parameter to optimize. - GoogleCloudAiplatformV1BatchPredictionJob: + Lists of tokens info from the input. A ComputeTokensRequest could + have multiple instances with a prompt in each instance. We also need + to return lists of tokens info for the request with multiple + instances. + description: Response message for ComputeTokens RPC call. + GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec: description: >- - A job that uses a Model to produce predictions on multiple input - instances. If predictions for significant portion of the instances fail, - the job may finish without attempting predictions for all remaining - instances. + The decay curve automated stopping rule builds a Gaussian Process + Regressor to predict the final objective value of a Trial based on the + already completed Trials and the intermediate measurements of the + current Trial. Early stopping is requested for the current Trial if + there is very low probability to exceed the optimal value found so far. + id: GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec properties: - inputConfig: + useElapsedDuration: + type: boolean description: >- - Required. Input configuration of the instances on which predictions - are performed. The schema of any single instance may be specified - via the Model's PredictSchemata's instance_schema_uri. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInputConfig - createTime: - readOnly: true - description: Output only. Time when the BatchPredictionJob was created. - format: google-datetime + True if Measurement.elapsed_duration is used as the x-axis of each + Trials Decay Curve. Otherwise, Measurement.step_count will be used + as the x-axis. + type: object + GoogleCloudAiplatformV1RayMetricSpec: + description: Configuration for the Ray metrics. + properties: + disabled: + description: Optional. Flag to disable the Ray metrics collection. + type: boolean + type: object + id: GoogleCloudAiplatformV1RayMetricSpec + GoogleCloudAiplatformV1PersistentResource: + type: object + properties: + state: + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - RUNNING + - STOPPING + - ERROR + - REBOOTING + - UPDATING + description: Output only. The detailed state of a Study. + enumDescriptions: + - Not set. + - >- + The PROVISIONING state indicates the persistent resources is being + created. + - >- + The RUNNING state indicates the persistent resource is healthy and + fully usable. + - >- + The STOPPING state indicates the persistent resource is being + deleted. + - >- + The ERROR state indicates the persistent resource may be unusable. + Details can be found in the `error` field. + - >- + The REBOOTING state indicates the persistent resource is being + rebooted (PR is not available right now but is expected to be + ready again later). + - >- + The UPDATING state indicates the persistent resource is being + updated. type: string - name: readOnly: true - description: Output only. Resource name of the BatchPredictionJob. - type: string - endTime: - type: string - format: google-datetime + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Optional. Customer-managed encryption key spec for a + PersistentResource. If set, this PersistentResource and all + sub-resources of this PersistentResource will be secured by this + key. + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. Time when the BatchPredictionJob entered any of the - following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. + Output only. Only populated when persistent resource's state is + `STOPPING` or `ERROR`. readOnly: true - outputInfo: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + satisfiesPzi: readOnly: true - description: Output only. Information further describing the output of this job. - displayName: - description: Required. The user-defined name of this BatchPredictionJob. - type: string - resourcesConsumed: + description: Output only. Reserved for future use. + type: boolean + createTime: readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcesConsumed' - description: >- - Output only. Information about resources that had been consumed by - this job. Provided in real time at best effort basis, as well as a - final value once the job completes. Note: This field currently may - be not populated for batch predictions that use AutoML Models. - updateTime: + description: Output only. Time when the PersistentResource was created. type: string - readOnly: true - description: >- - Output only. Time when the BatchPredictionJob was most recently - updated. format: google-datetime - instanceConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig - description: >- - Configuration for how to convert batch prediction input instances to - the prediction instances that are sent to the Model. - partialFailures: - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - description: >- - Output only. Partial failures encountered. For example, single files - that can't be read. This field never exceeds 20 entries. Status - details fields contain standard Google Cloud error details. labels: description: >- - The labels with user-defined metadata to organize - BatchPredictionJobs. Label keys and values can be no longer than 64 + Optional. The labels with user-defined metadata to organize + PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - type: object additionalProperties: type: string - manualBatchTuningParameters: + type: object + startTime: description: >- - Immutable. Parameters configuring the batch behavior. Currently only - applicable when dedicated_resources are used (in other cases Vertex - AI does the tuning itself). - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ManualBatchTuningParameters - satisfiesPzs: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - modelVersionId: + Output only. Time when the PersistentResource for the first time + entered the `RUNNING` state. + type: string readOnly: true + format: google-datetime + resourceRuntimeSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntimeSpec' description: >- - Output only. The version ID of the Model that produces the - predictions via this job. + Optional. Persistent Resource runtime spec. For example, used for + Ray cluster configuration. + name: type: string - disableContainerLogging: - type: boolean + description: Immutable. Resource name of a PersistentResource. + reservedIpRanges: description: >- - For custom-trained Models and AutoML Tabular Models, the container - of the DeployedModel instances will send `stderr` and `stdout` - streams to Cloud Logging by default. Please note that the logs incur - cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging/pricing). User can disable - container logging by setting this flag to true. - unmanagedContainerModel: + Optional. A list of names for the reserved IP ranges under the VPC + network that can be used for this persistent resource. If set, we + will deploy the persistent resource within the provided IP ranges. + Otherwise, the persistent resource is deployed to any IP ranges + under the provided VPC network. Example: ['vertex-ai-ip-range']. + type: array + items: + type: string + network: description: >- - Contains model information necessary to perform batch prediction - without requiring uploading to model registry. Exactly one of model - and unmanaged_container_model must be set. - $ref: '#/components/schemas/GoogleCloudAiplatformV1UnmanagedContainerModel' - completionStats: + Optional. The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to peered + with Vertex AI to host the persistent resources. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + To specify this field, you must have already [configured VPC Network + Peering for Vertex + AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If + this field is left unspecified, the resources aren't peered with any + network. + type: string + resourcePools: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcePool' + description: Required. The spec of the pools of different resources. + displayName: + type: string description: >- - Output only. Statistics on completed and failed prediction - instances. + Optional. The display name of the PersistentResource. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. + resourceRuntime: readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1CompletionStats' - modelParameters: - description: >- - The parameters that govern the predictions. The schema of the - parameters may be specified via the Model's PredictSchemata's - parameters_schema_uri. - type: any - encryptionSpec: - description: >- - Customer-managed encryption key options for a BatchPredictionJob. If - this is set, then all resources created by the BatchPredictionJob - will be encrypted with the provided encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - startTime: - description: >- - Output only. Time when the BatchPredictionJob for the first time - entered the `JOB_STATE_RUNNING` state. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntime' + description: Output only. Runtime information of the Persistent Resource. + updateTime: format: google-datetime + description: >- + Output only. Time when the PersistentResource was most recently + updated. type: string readOnly: true - dedicatedResources: + id: GoogleCloudAiplatformV1PersistentResource + description: >- + Represents long-lasting resources that are dedicated to users to runs + custom workloads. A PersistentResource can have multiple node pools and + each node pool can have its own machine spec. + GoogleCloudAiplatformV1ListTuningJobsResponse: + description: Response message for GenAiTuningService.ListTuningJobs + id: GoogleCloudAiplatformV1ListTuningJobsResponse + properties: + nextPageToken: + type: string description: >- - The config of resources used by the Model during the batch - prediction. If the Model supports DEDICATED_RESOURCES this config - may be provided (and the job will use these resources), if the Model - doesn't support AUTOMATIC_RESOURCES, this config must be provided. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchDedicatedResources' - outputConfig: + A token to retrieve the next page of results. Pass to + ListTuningJobsRequest.page_token to obtain that page. + tuningJobs: + description: List of TuningJobs in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + type: array + type: object + GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata: + description: Usage metadata about response(s). + id: GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata + type: object + properties: + totalTokenCount: + format: int32 + description: Total token count for prompt and response candidates. + type: integer + promptTokenCount: + format: int32 + type: integer description: >- - Required. The Configuration specifying where output predictions - should be written. The schema of any single prediction may be - specified as a concatenation of Model's PredictSchemata's - instance_schema_uri and prediction_schema_uri. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputConfig - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + Number of tokens in the request. When `cached_content` is set, this + is still the total effective prompt size meaning this includes the + number of tokens in the cached content. + candidatesTokenCount: + type: integer + description: Number of tokens in the response(s). + format: int32 + GoogleCloudAiplatformV1BatchReadFeatureValuesRequest: + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + type: object + properties: + passThroughFields: description: >- - Explanation configuration for this BatchPredictionJob. Can be - specified only if generate_explanation is set to `true`. This value - overrides the value of Model.explanation_spec. All fields of - explanation_spec are optional in the request. If a field of the - explanation_spec object is not populated, the corresponding field of - the Model.explanation_spec object is inherited. - serviceAccount: + When not empty, the specified fields in the *_read_instances source + will be joined as-is in the output, in addition to those fields from + the Featurestore Entity. For BigQuery source, the type of the + pass-through values will be automatically inferred. For CSV source, + the pass-through values will be passed as opaque bytes. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + entityTypeSpecs: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec + description: >- + Required. Specifies EntityType grouping Features to read values of + and settings. + bigqueryReadInstances: + description: Similar to csv_read_instances, but from BigQuery source. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + destination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' + description: Required. Specifies output location and format. + startTime: type: string + format: google-datetime description: >- - The service account that the DeployedModel's container runs as. If - not specified, a system generated one will be used, which has - minimal permissions and the custom container, if used, may not have - enough permission to access other Google Cloud resources. Users - deploying the Model must have the `iam.serviceAccounts.actAs` - permission on this service account. - satisfiesPzi: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - model: + Optional. Excludes Feature values with feature generation timestamp + before this timestamp. If not set, retrieve oldest values kept in + Feature Store. Timestamp, if present, must not have higher than + millisecond precision. + csvReadInstances: description: >- - The name of the Model resource that produces the predictions via - this job, must share the same ancestor Location. Starting this job - has no impact on any existing deployments of the Model and their - resources. Exactly one of model and unmanaged_container_model must - be set. The model resource name may contain version id or version - alias to specify the version. Example: - `projects/{project}/locations/{location}/models/{model}@2` or - `projects/{project}/locations/{location}/models/{model}@golden` if - no version is specified, the default version will be deployed. The - model resource could also be a publisher model. Example: - `publishers/{publisher}/models/{model}` or - `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` - type: string - state: - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - description: Output only. The detailed state of the job. - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - readOnly: true - type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' + Each read instance consists of exactly one read timestamp and one or + more entity IDs identifying entities of the corresponding + EntityTypes whose Features are requested. Each output instance + contains Feature values of requested entities concatenated together + as of the read time. An example read instance may be `foo_entity_id, + bar_entity_id, 2020-01-01T10:00:00.123Z`. An example output instance + may be `foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, + foo_entity_feature1_value, bar_entity_feature2_value`. Timestamp in + each read instance must be millisecond-aligned. `csv_read_instances` + are read instances stored in a plain-text CSV file. The header + should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The + columns can be in any order. Values in the timestamp column must use + the RFC 3339 format, e.g. `2012-07-30T10:43:17.123Z`. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + description: Request message for FeaturestoreService.BatchReadFeatureValues. + GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec: + properties: + featureSelector: description: >- - Output only. Only populated when the job's state is JOB_STATE_FAILED - or JOB_STATE_CANCELLED. - readOnly: true - generateExplanation: + Required. Selectors choosing which Feature values to read from the + EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + entityTypeId: description: >- - Generate explanation with the batch prediction results. When set to - `true`, the batch prediction output changes based on the - `predictions_format` field of the BatchPredictionJob.output_config - object: * `bigquery`: output includes a column named `explanation`. - The value is a struct that conforms to the Explanation object. * - `jsonl`: The JSON objects on each line include an additional entry - keyed `explanation`. The value of the entry is a JSON object that - conforms to the Explanation object. * `csv`: Generating explanations - for CSV format is not supported. If this field is set to true, - either the Model.explanation_spec or explanation_spec must be - populated. - type: boolean + Required. ID of the EntityType to select Features. The EntityType id + is the entity_type_id specified during EntityType creation. + type: string + settings: + description: Per-Feature settings for the batch read. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec type: object - id: GoogleCloudAiplatformV1BatchPredictionJob - GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata: + description: >- + Selects Features of an EntityType to read values of and specifies read + settings. + GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: + id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureGroup. type: object - id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata - properties: {} - GoogleCloudAiplatformV1PublisherModel: + description: Details of operations that perform create FeatureGroup. + GoogleCloudAiplatformV1ModelGardenSource: + description: >- + Contains information about the source of the models generated from Model + Garden. + type: object + id: GoogleCloudAiplatformV1ModelGardenSource properties: - launchStage: - type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - EXPERIMENTAL - - PRIVATE_PREVIEW - - PUBLIC_PREVIEW - - GA - description: Optional. Indicates the launch stage of the model. - enumDescriptions: - - The model launch stage is unspecified. - - >- - Used to indicate the PublisherModel is at Experimental launch - stage, available to a small set of customers. - - >- - Used to indicate the PublisherModel is at Private Preview launch - stage, only available to a small set of customers, although a - larger set of customers than an Experimental launch. Previews are - the first launch stage used to get feedback from customers. - - >- - Used to indicate the PublisherModel is at Public Preview launch - stage, available to all customers, although not supported for - production workloads. - - >- - Used to indicate the PublisherModel is at GA launch stage, - available to all customers and ready for production workload. - versionId: - description: >- - Output only. Immutable. The version ID of the PublisherModel. A new - version is committed when a new model version is uploaded under an - existing model id. It is an auto-incrementing decimal number in - string representation. - type: string - readOnly: true - openSourceCategory: - enum: - - OPEN_SOURCE_CATEGORY_UNSPECIFIED - - PROPRIETARY - - GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT - - THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT - - GOOGLE_OWNED_OSS - - THIRD_PARTY_OWNED_OSS - enumDescriptions: - - The open source category is unspecified, which should not be used. - - Used to indicate the PublisherModel is not open sourced. - - >- - Used to indicate the PublisherModel is a Google-owned open source - model w/ Google checkpoint. - - >- - Used to indicate the PublisherModel is a 3p-owned open source - model w/ Google checkpoint. - - >- - Used to indicate the PublisherModel is a Google-owned pure open - source model. - - >- - Used to indicate the PublisherModel is a 3p-owned pure open source - model. + publicModelName: type: string - description: Required. Indicates the open source category of the publisher model. - name: - readOnly: true - description: Output only. The resource name of the PublisherModel. + description: Required. The model garden source model resource name. + GoogleCloudAiplatformV1SchemaTextSentimentAnnotation: + description: Annotation details specific to text sentiment. + id: GoogleCloudAiplatformV1SchemaTextSentimentAnnotation + properties: + sentimentMax: + format: int32 + type: integer + description: The sentiment max score for text. + annotationSpecId: type: string - publisherModelTemplate: description: >- - Optional. Output only. Immutable. Used to indicate this model has a - publisher model and provide the template of the publisher model - resource name. - readOnly: true + The resource Id of the AnnotationSpec that this Annotation pertains + to. + sentiment: + type: integer + description: The sentiment score for text. + format: int32 + displayName: type: string - predictSchemata: description: >- - Optional. The schemata that describes formats of the - PublisherModel's predictions and explanations as given and returned - via PredictionService.Predict. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - frameworks: - type: array - description: Optional. Additional information about the model's Frameworks. + The display name of the AnnotationSpec that this Annotation pertains + to. + type: object + GoogleCloudAiplatformV1ListDataLabelingJobsResponse: + id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse + properties: + dataLabelingJobs: + description: >- + A list of DataLabelingJobs that matches the specified filter in the + request. items: - type: string - supportedActions: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToAction - description: Optional. Supported call-to-action options. - versionState: - enumDescriptions: - - The version state is unspecified. - - Used to indicate the version is stable. - - Used to indicate the version is unstable. - description: Optional. Indicates the state of the model version. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + type: array + nextPageToken: + type: string + description: The standard List next-page token. + description: Response message for JobService.ListDataLabelingJobs. + type: object + GoogleCloudAiplatformV1ListPersistentResourcesResponse: + type: object + properties: + persistentResources: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + type: array + nextPageToken: + description: >- + A token to retrieve next page of results. Pass to + ListPersistentResourcesRequest.page_token to obtain that page. type: string - enum: - - VERSION_STATE_UNSPECIFIED - - VERSION_STATE_STABLE - - VERSION_STATE_UNSTABLE - id: GoogleCloudAiplatformV1PublisherModel - description: A Model Garden Publisher Model. + id: GoogleCloudAiplatformV1ListPersistentResourcesResponse + description: Response message for PersistentResourceService.ListPersistentResources + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig: + properties: + bigquerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource type: object - GoogleCloudAiplatformV1Part: description: >- - A datatype containing media that is part of a multi-part `Content` - message. A `Part` consists of data which has an associated datatype. A - `Part` can only contain one of the accepted types in `Part.data`. A - `Part` must have a fixed IANA MIME type identifying the type and subtype - of the media if `inline_data` or `file_data` field is filled with raw - bytes. + The time series Dataset's data source. The Dataset doesn't store the + data directly, but only pointer(s) to its data. + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig + GoogleCloudAiplatformV1SafetyInput: + properties: + metricSpec: + description: Required. Spec for safety metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySpec' + instance: + description: Required. Safety instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInstance' + description: Input for safety metric. + id: GoogleCloudAiplatformV1SafetyInput type: object - id: GoogleCloudAiplatformV1Part + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec: + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec properties: - fileData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' - description: Optional. URI based data. - functionCall: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCall' + configs: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig description: >- - Optional. A predicted [FunctionCall] returned from the model that - contains a string representing the [FunctionDeclaration.name] with - the parameters and their values. - text: - description: Optional. Text part (can be code). + Mapping configuration for this SliceSpec. The key is the name of the + feature. By default, the key will be prefixed by "instance" as a + dictionary prefix for Vertex Batch Predictions output format. + type: object + description: Specification for how the data should be sliced. + GoogleCloudAiplatformV1FulfillmentInstance: + description: Spec for fulfillment instance. + type: object + id: GoogleCloudAiplatformV1FulfillmentInstance + properties: + instruction: type: string - functionResponse: + description: Required. Inference instruction prompt to compare prediction with. + prediction: + type: string + description: Required. Output of the evaluated model. + GoogleCloudAiplatformV1ImportDataResponse: + id: GoogleCloudAiplatformV1ImportDataResponse + description: Response message for DatasetService.ImportData. + type: object + properties: {} + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry: + type: object + description: Entry for the Quantiles loss type optimization objective. + properties: + scaledPinballLoss: + description: The scaled pinball loss of this quantile. + format: float + type: number + observedQuantile: + type: number description: >- - Optional. The result output of a [FunctionCall] that contains a - string representing the [FunctionDeclaration.name] and a structured - JSON object containing any output from the function call. It is used - as context to the model. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' - videoMetadata: + This is a custom metric that calculates the percentage of true + values that were less than the predicted value for that quantile. + Only populated when optimization_objective is minimize-quantile-loss + and each entry corresponds to an entry in quantiles The percent + value can be used to compare with the quantile value, which is the + target value. + format: double + quantile: + description: The quantile for this entry. + type: number + format: double + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + GoogleCloudAiplatformV1AddTrialMeasurementRequest: + properties: + measurement: + description: Required. The measurement to be added to a Trial. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + id: GoogleCloudAiplatformV1AddTrialMeasurementRequest + type: object + description: Request message for VizierService.AddTrialMeasurement. + GoogleCloudAiplatformV1ReadFeatureValuesResponse: + properties: + entityView: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView description: >- - Optional. Video metadata. The metadata should only be specified - while the video data is presented in inline_data or file_data. - $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' - inlineData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' - description: Optional. Inlined bytes data. - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition: + Entity view with Feature values. This may be the entity in the + Featurestore if values for all Features were requested, or a + projection of the entity in the Featurestore if values for only some + Features were requested. + header: + description: Response header. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader + id: GoogleCloudAiplatformV1ReadFeatureValuesResponse type: object + description: Response message for FeaturestoreOnlineServingService.ReadFeatureValues. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics: properties: - values: - items: - type: string - format: int64 + f1Score: + type: number + format: float + description: Output only. The harmonic mean of recall and precision. + recall: + type: number + description: Output only. Recall for the given confidence threshold. + format: float + confidenceThreshold: + type: number description: >- - Required. Matches values of the parent parameter of 'INTEGER' type. - All values must lie in `integer_value_spec` of parent parameter. - type: array - description: Represents the spec to match integer values from parent parameter. + Output only. The confidence threshold value used to compute the + metrics. + format: float + precision: + type: number + format: float + description: Output only. Precision for the given confidence threshold. + type: object + description: Metrics for a single confidence threshold. id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition - GoogleCloudAiplatformV1AutoscalingMetricSpec: + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics + GoogleCloudAiplatformV1AutomaticResources: description: >- - The metric specification that defines the target resource utilization - (CPU utilization, accelerator's duty cycle, and so on) for calculating - the desired replica count. - id: GoogleCloudAiplatformV1AutoscalingMetricSpec + 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. type: object + id: GoogleCloudAiplatformV1AutomaticResources properties: - target: + minReplicaCount: + type: integer + description: >- + Immutable. The minimum number of replicas this DeployedModel will be + always deployed on. If traffic against it increases, it may + dynamically be deployed onto more replicas up to max_replica_count, + and as traffic decreases, some of these extra replicas may be freed. + If the requested value is too large, the deployment will error. format: int32 + maxReplicaCount: description: >- - The target resource utilization in percentage (1% - 100%) for the - given metric; once the real usage deviates from the target by a - certain percentage, the machine replicas change. The default value - is 60 (representing 60%) if not provided. + Immutable. The maximum number of replicas this DeployedModel 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 the model to that many replicas + is guaranteed (barring service outages). If traffic against the + DeployedModel 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. type: integer - metricName: - type: string - description: >- - Required. The resource metric name. Supported metrics: * For Online - Prediction: * - `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` - * `aiplatform.googleapis.com/prediction/online/cpu/utilization` - GoogleCloudAiplatformV1ListFeatureViewSyncsResponse: - id: GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + format: int32 + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation: type: object properties: - nextPageToken: + columnName: + type: string + timeFormat: description: >- - A token, which can be sent as ListFeatureViewSyncsRequest.page_token - to retrieve the next page. If this field is omitted, there are no - subsequent pages. + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) type: string - featureViewSyncs: - type: array - description: The FeatureViewSyncs matching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation description: >- - Response message for - FeatureOnlineStoreAdminService.ListFeatureViewSyncs. - GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec: - description: Value specification for a parameter in `CATEGORICAL` type. - id: GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec: + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec properties: - defaultValue: + useReference: + type: boolean description: >- - A default value for a `CATEGORICAL` parameter that is assumed to be - a relatively good starting point. Unset value signals that there is - no offered starting point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - type: string - values: - type: array - items: - type: string - description: Required. The list of possible categories. + Optional. Whether to use instance.reference to compute question + answering helpfulness. + version: + description: Optional. Which version to use for evaluation. + format: int32 + type: integer + description: Spec for question answering helpfulness metric. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + GoogleCloudAiplatformV1SampledShapleyAttribution: properties: - maxCount: - format: int64 - type: string - description: >- - Maximum number of windows that should be generated across all time - series. - column: - description: >- - Name of the column that should be used to generate sliding windows. - The column should contain either booleans or string booleans; if the - value of the row is True, generate a sliding window with the horizon - starting at that row. The column will not be used as a feature in - training. - type: string - strideLength: - type: string + pathCount: description: >- - Stride length used to generate input examples. Within one time - series, every {$STRIDE_LENGTH} rows will be used to generate a - sliding window. - format: int64 + Required. The number of feature permutations to consider when + approximating the Shapley values. Valid range of its value is [1, + 50], inclusively. + type: integer + format: int32 + type: object description: >- - Config that contains the strategy used to generate sliding windows in - time series training. A window is a series of rows that comprise the - context up to the time of prediction, and the horizon following. The - corresponding row for each window marks the start of the forecast - horizon. Each window is used as an input example for - training/evaluation. + An attribution method that approximates Shapley values for features that + contribute to the label being predicted. A sampling strategy is used to + approximate the value rather than considering all subsets of features. + id: GoogleCloudAiplatformV1SampledShapleyAttribution + GoogleCloudAiplatformV1QuestionAnsweringQualityResult: + id: GoogleCloudAiplatformV1QuestionAnsweringQualityResult type: object - GoogleCloudAiplatformV1PublisherModelDocumentation: properties: - title: - description: >- - Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, - JAVA, NODE.JS, etc.. + score: + format: float + readOnly: true + type: number + description: Output only. Question Answering Quality score. + explanation: type: string - content: - description: Required. Content of this piece of document (in Markdown format). + readOnly: true + description: Output only. Explanation for question answering quality score. + confidence: + format: float + description: Output only. Confidence for question answering quality score. + type: number + readOnly: true + description: Spec for question answering quality result. + GoogleCloudAiplatformV1PipelineTemplateMetadata: + description: >- + Pipeline template metadata if PipelineJob.template_uri is from supported + template registry. Currently, the only supported registry is Artifact + Registry. + properties: + version: type: string - id: GoogleCloudAiplatformV1PublisherModelDocumentation + description: >- + The version_name in artifact registry. Will always be presented in + output if the PipelineJob.template_uri is from supported template + registry. Format is "sha256:abcdef123456...". type: object - description: A named piece of documentation. - GoogleCloudAiplatformV1GenericOperationMetadata: - id: GoogleCloudAiplatformV1GenericOperationMetadata - description: Generic Metadata shared by all operations. + id: GoogleCloudAiplatformV1PipelineTemplateMetadata + GoogleCloudAiplatformV1BatchPredictionJobInputConfig: + id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig type: object + description: >- + Configures the input to BatchPredictionJob. See + Model.supported_input_storage_formats for Model's supported input + formats, and how instances should be expressed via any of them. properties: - createTime: - format: google-datetime - description: Output only. Time when the operation was created. - readOnly: true + instancesFormat: type: string - partialFailures: - readOnly: true description: >- - Output only. Partial failures encountered. E.g. single files that - couldn't be read. This field should never exceed 20 entries. Status - details field will contain standard Google Cloud error details. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - updateTime: - format: google-datetime - type: string - readOnly: true + Required. The format in which instances are given, must be one of + the Model's supported_input_storage_formats. + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: The Cloud Storage location for the input instances. + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' description: >- - Output only. Time when the operation was updated for the last time. - If the operation has finished (successfully or not), this is the - finish time. - GoogleCloudAiplatformV1NasJobOutput: + The BigQuery location of the input table. The schema of the table + should be in the format described by the given context OpenAPI + Schema, if one is provided. The table may contain additional columns + that are not described by the schema, and they will be ignored. + GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint: properties: - multiTrialJobOutput: + publicEndpointDomainName: readOnly: true description: >- - Output only. The output of this multi-trial Neural Architecture - Search (NAS) job. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput - description: Represents a uCAIP NasJob output. - id: GoogleCloudAiplatformV1NasJobOutput - type: object - GoogleCloudAiplatformV1ModelExportFormat: - properties: - exportableContents: + Output only. This field will be populated with the domain name to + use for this FeatureOnlineStore + type: string + serviceAttachment: readOnly: true - description: Output only. The content of this Model that may be exported. - items: - enum: - - EXPORTABLE_CONTENT_UNSPECIFIED - - ARTIFACT - - IMAGE - enumDescriptions: - - Should not be used. - - >- - Model artifact and any of its supported files. Will be exported - to the location specified by the `artifactDestination` field of - the ExportModelRequest.output_config object. - - >- - The container image that is to be used when deploying this - Model. Will be exported to the location specified by the - `imageDestination` field of the ExportModelRequest.output_config - object. - type: string - type: array - id: description: >- - Output only. The ID of the export format. The possible format IDs - are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * - `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be - used in the browser and in Node.js using JavaScript. * `core-ml` - Used for iOS mobile devices. * `custom-trained` A Model that was - uploaded or trained by custom code. - readOnly: true + Output only. The name of the service attachment resource. Populated + if private service connect is enabled and after FeatureViewSync is + created. type: string + privateServiceConnectConfig: + description: >- + Optional. Private service connect config. The private service + connection is available only for Optimized storage type, not for + embedding management now. If + PrivateServiceConnectConfig.enable_private_service_connect set to + true, customers will use private service connection to send request. + Otherwise, the connection will set to public endpoint. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig description: >- - Represents export format supported by the Model. All formats export to - Google Cloud Storage. + The dedicated serving endpoint for this FeatureOnlineStore. Only need to + set when you choose Optimized storage type. Public endpoint is + provisioned by default. type: object - id: GoogleCloudAiplatformV1ModelExportFormat - GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata: - description: >- - Metadata information about the deployment for managing deployment - config. + id: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint + GoogleCloudAiplatformV1WriteTensorboardRunDataResponse: + description: Response message for TensorboardService.WriteTensorboardRunData. + id: GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + properties: {} type: object + GoogleCloudAiplatformV1Part: properties: - sampleRequest: - description: Optional. Sample request for deployed endpoint. - type: string - labels: + fileData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' + description: Optional. URI based data. + functionCall: description: >- - Optional. Labels for the deployment. For managing deployment config - like verifying, source of deployment config, etc. - additionalProperties: - type: string - type: object - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata - GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse: - id: GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse - description: Response message for TensorboardService.ListTensorboardTimeSeries. - type: object - properties: - tensorboardTimeSeries: - description: The TensorboardTimeSeries mathching the request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - nextPageToken: - type: string + Optional. A predicted [FunctionCall] returned from the model that + contains a string representing the [FunctionDeclaration.name] with + the parameters and their values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCall' + videoMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' description: >- - A token, which can be sent as - ListTensorboardTimeSeriesRequest.page_token to retrieve the next - page. If this field is omitted, there are no subsequent pages. - GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig: - properties: - modelVersion: + Optional. Video metadata. The metadata should only be specified + while the video data is presented in inline_data or file_data. + text: type: string + description: Optional. Text part (can be code). + inlineData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' + description: Optional. Inlined bytes data. + functionResponse: description: >- - Required. Full resource name of ml engine model version. Format: - `projects/{project}/models/{model}/versions/{version}`. - modelDisplayName: + Optional. The result output of a [FunctionCall] that contains a + string representing the [FunctionDeclaration.name] and a structured + JSON object containing any output from the function call. It is used + as context to the model. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' + type: object + description: >- + A datatype containing media that is part of a multi-part `Content` + message. A `Part` consists of data which has an associated datatype. A + `Part` can only contain one of the accepted types in `Part.data`. A + `Part` must have a fixed IANA MIME type identifying the type and subtype + of the media if `inline_data` or `file_data` field is filled with raw + bytes. + id: GoogleCloudAiplatformV1Part + GoogleCloudAiplatformV1FileData: + properties: + mimeType: + description: Required. The IANA standard MIME type of the source data. type: string - description: >- - Required. Display name of the model in Vertex AI. System will pick a - display name if unspecified. - endpoint: - description: >- - Required. The ml.googleapis.com endpoint that this model version - should be migrated from. Example values: * ml.googleapis.com * - us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * - asia-east1-ml.googleapis.com + fileUri: type: string - description: Config for migrating version in ml.googleapis.com to Vertex AI's Model. - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig + description: Required. URI. + id: GoogleCloudAiplatformV1FileData type: object - GoogleCloudAiplatformV1Dataset: + description: URI based data. + GoogleCloudAiplatformV1AnnotationSpec: + description: Identifies a concept with which DataItems may be annotated with. properties: - dataItemCount: + etag: + type: string description: >- - Output only. The number of DataItems in this Dataset. Only apply for - non-structured Dataset. - format: int64 + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + createTime: readOnly: true + description: Output only. Timestamp when this AnnotationSpec was created. type: string - labels: - type: object - additionalProperties: - type: string - description: >- - The labels with user-defined metadata to organize your Datasets. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Dataset (System - labels are excluded). See https://goo.gl/xmQnxf for more information - and examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for each Dataset: * - "aiplatform.googleapis.com/dataset_metadata_schema": output only, - its value is the metadata_schema's title. - encryptionSpec: + format: google-datetime + displayName: description: >- - Customer-managed encryption key spec for a Dataset. If set, this - Dataset and all sub-resources of this Dataset will be secured by - this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Required. The user-defined name of the AnnotationSpec. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. + type: string updateTime: format: google-datetime + description: Output only. Timestamp when AnnotationSpec was last updated. readOnly: true type: string - description: Output only. Timestamp when this Dataset was last updated. - etag: - type: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - metadataSchemaUri: - description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Dataset. The schema is - defined as an OpenAPI 3.0.2 Schema Object. The schema files that can - be used here are found in - gs://google-cloud-aiplatform/schema/dataset/metadata/. - type: string - description: - description: The description of the Dataset. + name: + description: Output only. Resource name of the AnnotationSpec. + readOnly: true type: string - displayName: + id: GoogleCloudAiplatformV1AnnotationSpec + type: object + GoogleCloudAiplatformV1PrivateEndpoints: + id: GoogleCloudAiplatformV1PrivateEndpoints + type: object + description: >- + PrivateEndpoints proto is used to provide paths for users to send + requests privately. To send request via private service access, use + predict_http_uri, explain_http_uri or health_http_uri. To send request + via private service connect, use service_attachment. + properties: + serviceAttachment: type: string description: >- - Required. The user-defined name of the Dataset. The name can be up - to 128 characters long and can consist of any UTF-8 characters. - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. readOnly: true - metadata: - description: Required. Additional information about the Dataset. - type: any - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. + predictHttpUri: readOnly: true - name: + description: Output only. Http(s) path to send prediction requests. type: string - readOnly: true - description: Output only. Identifier. The resource name of the Dataset. - savedQueries: - type: array - description: >- - All SavedQueries belong to the Dataset will be returned in List/Get - Dataset response. The annotation_specs field will not be populated - except for UI cases which will only use annotation_spec_count. In - CreateDataset request, a SavedQuery is created together if this - field is set, up to one SavedQuery can be set in - CreateDatasetRequest. The SavedQuery should not contain any - AnnotationSpec. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' - metadataArtifact: + healthHttpUri: + description: Output only. Http(s) path to send health check requests. type: string - description: >- - Output only. The resource name of the Artifact that was created in - MetadataStore when creating the Dataset. The Artifact resource name - pattern is - `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. readOnly: true - modelReference: - type: string - description: >- - Optional. Reference to the public base model last used by the - dataset. Only set for prompt datasets. - createTime: + explainHttpUri: + description: Output only. Http(s) path to send explain requests. type: string readOnly: true - description: Output only. Timestamp when this Dataset was created. - format: google-datetime - id: GoogleCloudAiplatformV1Dataset - type: object - description: A collection of DataItems and Annotations on them. - GoogleCloudAiplatformV1EvaluateInstancesResponse: - type: object - properties: - questionAnsweringRelevanceResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult - description: Result for question answering relevance metric. - fluencyResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyResult' - description: >- - LLM-based metric evaluation result. General text generation metrics, - applicable to other categories. Result for fluency metric. - pointwiseMetricResult: - description: Generic metrics. Result for pointwise metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricResult' - bleuResults: - description: Results for bleu metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuResults' - rougeResults: - description: Results for rouge metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeResults' - summarizationHelpfulnessResult: - description: Result for summarization helpfulness metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessResult - toolNameMatchResults: - description: Results for tool name match metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchResults' - summarizationVerbosityResult: - description: Result for summarization verbosity metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityResult - groundednessResult: - description: Result for groundedness metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessResult' - summarizationQualityResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityResult - description: Summarization only metrics. Result for summarization quality metric. - questionAnsweringCorrectnessResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult - description: Result for question answering correctness metric. - questionAnsweringHelpfulnessResult: - description: Result for question answering helpfulness metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult - exactMatchResults: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchResults' - description: Auto metric evaluation results. Results for exact match metric. - safetyResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyResult' - description: Result for safety metric. - toolCallValidResults: - description: Tool call metrics. Results for tool call valid metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidResults' - pairwiseMetricResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricResult' - description: Result for pairwise metric. - toolParameterKeyMatchResults: - description: Results for tool parameter key match metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchResults - questionAnsweringQualityResult: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityResult - description: >- - Question answering only metrics. Result for question answering - quality metric. - pairwiseSummarizationQualityResult: - description: Result for pairwise summarization quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityResult - pairwiseQuestionAnsweringQualityResult: - description: Result for pairwise question answering quality metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult - coherenceResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceResult' - description: Result for coherence metric. - toolParameterKvMatchResults: - description: Results for tool parameter key value match metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchResults - fulfillmentResult: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentResult' - description: Result for fulfillment metric. - id: GoogleCloudAiplatformV1EvaluateInstancesResponse - description: Response message for EvaluationService.EvaluateInstances. - GoogleCloudAiplatformV1DeleteFeatureValuesRequest: - description: Request message for FeaturestoreService.DeleteFeatureValues. - properties: - selectEntity: - description: Select feature values to be deleted by specifying entities. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity - selectTimeRangeAndFeature: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature - description: >- - Select feature values to be deleted by specifying time range and - features. - type: object - id: GoogleCloudAiplatformV1DeleteFeatureValuesRequest - GoogleCloudAiplatformV1ListDatasetVersionsResponse: - id: GoogleCloudAiplatformV1ListDatasetVersionsResponse - description: Response message for DatasetService.ListDatasetVersions. - type: object + GoogleCloudAiplatformV1ListFeatureViewSyncsResponse: + description: >- + Response message for + FeatureOnlineStoreAdminService.ListFeatureViewSyncs. properties: + featureViewSyncs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + description: The FeatureViewSyncs matching the request. nextPageToken: - description: The standard List next-page token. type: string - datasetVersions: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' - type: array description: >- - A list of DatasetVersions that matches the specified filter in the - request. - GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest: + A token, which can be sent as ListFeatureViewSyncsRequest.page_token + to retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: object + id: GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig: + id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig type: object - properties: - writeRunDataRequests: - description: >- - Required. Requests containing per-run TensorboardTimeSeries data to - write. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest - type: array - id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest - description: Request message for TensorboardService.WriteTensorboardExperimentData. - GoogleCloudAiplatformV1ServiceAccountSpec: description: >- - Configuration for the use of custom service account to run the - workloads. + Config for migrating Dataset in automl.googleapis.com to Vertex AI's + Dataset. properties: - serviceAccount: + dataset: description: >- - Optional. Required when all below conditions are met * - `enable_custom_service_account` is true; * any runtime is specified - via `ResourceRuntimeSpec` on creation time, for example, Ray The - users must have `iam.serviceAccounts.actAs` permission on this - service account and then the specified runtime containers will run - as it. Do not set this field if you want to submit jobs using custom - service account to this PersistentResource after creation, but only - specify the `service_account` inside the job. + Required. Full resource name of automl Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}`. + type: string + datasetDisplayName: type: string - enableCustomServiceAccount: description: >- - Required. If true, custom user-managed service account is enforced - to run any workloads (for example, Vertex Jobs) on the resource. - Otherwise, uses the [Vertex AI Custom Code Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - type: boolean - type: object - id: GoogleCloudAiplatformV1ServiceAccountSpec - GoogleCloudAiplatformV1SuggestTrialsRequest: + Required. Display name of the Dataset in Vertex AI. System will pick + a display name if unspecified. + GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams: + description: Prediction model parameters for Video Action Recognition. + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams properties: - clientId: - type: string + maxPredictions: description: >- - Required. The identifier of the client that is requesting the - suggestion. If multiple SuggestTrialsRequests have the same - `client_id`, the service will return the identical suggested Trial - if the Trial is pending, and provide a new Trial if the last - suggested Trial was completed. - suggestionCount: + The model only returns up to that many top, by confidence score, + predictions per frame of the video. If this number is very high, the + Model may return fewer predictions per frame. Default value is 50. format: int32 - description: Required. The number of suggestions requested. It must be positive. type: integer - contexts: + confidenceThreshold: + type: number description: >- - Optional. This allows you to specify the "context" for a Trial; a - context is a slice (a subspace) of the search space. Typical uses - for contexts: 1) You are using Vizier to tune a server for best - performance, but there's a strong weekly cycle. The context - specifies the day-of-week. This allows Tuesday to generalize from - Wednesday without assuming that everything is identical. 2) Imagine - you're optimizing some medical treatment for people. As they walk in - the door, you know certain facts about them (e.g. sex, weight, - height, blood-pressure). Put that information in the context, and - Vizier will adapt its suggestions to the patient. 3) You want to do - a fair A/B test efficiently. Specify the "A" and "B" conditions as - contexts, and Vizier will generalize between "A" and "B" conditions. - If they are similar, this will allow Vizier to converge to the - optimum faster than if "A" and "B" were separate Studies. NOTE: You - can also enter contexts as REQUESTED Trials, e.g. via the - CreateTrial() RPC; that's the asynchronous option where you don't - need a close association between contexts and suggestions. NOTE: All - the Parameters you set in a context MUST be defined in the Study. - NOTE: You must supply 0 or $suggestion_count contexts. If you don't - supply any contexts, Vizier will make suggestions from the full - search space specified in the StudySpec; if you supply a full set of - context, each suggestion will match the corresponding context. NOTE: - A Context with no features set matches anything, and allows - suggestions from the full search space. NOTE: Contexts MUST lie - within the search space specified in the StudySpec. It's an error if - they don't. NOTE: Contexts preferentially match ACTIVE then - REQUESTED trials before new suggestions are generated. NOTE: - Generation of suggestions involves a match between a Context and - (optionally) a REQUESTED trial; if that match is not fully - specified, a suggestion will be geneated in the merged subspace. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialContext' - type: array - id: GoogleCloudAiplatformV1SuggestTrialsRequest + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + format: float type: object - description: Request message for VizierService.SuggestTrials. - GoogleCloudAiplatformV1FulfillmentResult: + GoogleCloudAiplatformV1CreateFeatureOperationMetadata: + description: Details of operations that perform create Feature. type: object - description: Spec for fulfillment result. properties: - confidence: - format: float - description: Output only. Confidence for fulfillment score. - type: number - readOnly: true - explanation: - type: string - readOnly: true - description: Output only. Explanation for fulfillment score. - score: - readOnly: true - description: Output only. Fulfillment score. - type: number - format: float - id: GoogleCloudAiplatformV1FulfillmentResult - GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue: - description: Tool parameter key value match metric value for an instance. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature. + id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata + GoogleCloudAiplatformV1ImportModelEvaluationRequest: + id: GoogleCloudAiplatformV1ImportModelEvaluationRequest type: object - id: GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue + description: Request message for ModelService.ImportModelEvaluation properties: - score: - type: number - format: float - readOnly: true - description: Output only. Tool parameter key value match score. - GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse: - description: Response message for TensorboardService.ExportTensorboardTimeSeriesData. - id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse - type: object + modelEvaluation: + description: Required. Model evaluation resource to be imported. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + GoogleLongrunningListOperationsResponse: + description: The response message for Operations.ListOperations. + id: GoogleLongrunningListOperationsResponse properties: nextPageToken: type: string - 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. - timeSeriesDataPoints: + description: The standard List next-page token. + operations: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' - description: The returned time series data points. - GoogleCloudAiplatformV1CreateEndpointOperationMetadata: - description: Runtime operation information for EndpointService.CreateEndpoint. - id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: >- + A list of operations that matches the specified filter in the + request. type: object - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata: + GoogleCloudAiplatformV1StartNotebookRuntimeRequest: + description: Request message for NotebookService.StartNotebookRuntime. type: object - properties: - genericMetadata: - description: Operation metadata for Feature. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata - description: Details of operations that perform batch create Features. - GoogleCloudAiplatformV1SchemaTextDataItem: + id: GoogleCloudAiplatformV1StartNotebookRuntimeRequest + properties: {} + GoogleCloudAiplatformV1StreamRawPredictRequest: type: object - description: Payload of Text DataItem. + id: GoogleCloudAiplatformV1StreamRawPredictRequest + description: Request message for PredictionService.StreamRawPredict. properties: - gcsUri: - type: string + httpBody: + $ref: '#/components/schemas/GoogleApiHttpBody' description: >- - Output only. Google Cloud Storage URI points to the original text in - user's bucket. The text file is up to 10MB in size. - readOnly: true - id: GoogleCloudAiplatformV1SchemaTextDataItem - GoogleCloudAiplatformV1Schema: + The prediction input. Supports HTTP headers and arbitrary data + payload. + GoogleCloudAiplatformV1ExplanationSpecOverride: + type: object + description: >- + The ExplanationSpec entries that can be overridden at online explanation + time. + id: GoogleCloudAiplatformV1ExplanationSpecOverride properties: - default: - type: any - description: Optional. Default value of the data. - enum: + examplesOverride: + description: The example-based explanations parameter overrides. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesOverride' + parameters: description: >- - Optional. Possible values of the element of Type.STRING with enum - format. For example we can define an Enum Direction as : - {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - type: array - items: - type: string - minimum: + The parameters to be overridden. Note that the attribution method + cannot be changed. If not specified, no parameter is overridden. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' + metadata: + description: >- + The metadata to be overridden. If not specified, no metadata is + overridden. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverride + GoogleCloudAiplatformV1FilterSplit: + id: GoogleCloudAiplatformV1FilterSplit + properties: + trainingFilter: description: >- - Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of - the Type.INTEGER and Type.NUMBER - type: number - format: double - maxItems: - description: Optional. Maximum number of the elements for Type.ARRAY. - format: int64 + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to train the Model. A filter with same syntax + as the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. type: string - minLength: + validationFilter: description: >- - Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the - Type.STRING + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to validate the Model. A filter with same + syntax as the one used in DatasetService.ListDataItems may be used. + If a single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. type: string - format: int64 - propertyOrdering: + testFilter: + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to test the Model. A filter with same syntax as + the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + type: string + type: object + description: >- + Assigns input data to training, validation, and test sets based on the + given filters, data pieces not matched by any filter are ignored. + Currently only supported for Datasets containing DataItems. If any of + the filters in this message are to match nothing, then they can be set + as '-' (the minus sign). Supported only for unstructured Datasets. + GoogleCloudAiplatformV1TokensInfo: + type: object + properties: + tokens: + description: A list of tokens from the input. items: + format: byte type: string type: array + role: description: >- - Optional. The order of the properties. Not a standard field in open - api spec. Only used to support the order of the properties. - required: - description: Optional. Required properties of Type.OBJECT. + Optional. Optional fields for the role from the corresponding + Content. + type: string + tokenIds: + description: A list of token ids from the input. items: type: string + format: int64 type: array - title: - description: Optional. The title of the Schema. - type: string - example: - type: any - description: >- - Optional. Example of the object. Will only populated when the object - is the root. - type: - enumDescriptions: - - Not specified, should not be used. - - OpenAPI string type - - OpenAPI number type - - OpenAPI integer type - - OpenAPI boolean type - - OpenAPI array type - - OpenAPI object type - description: Optional. The type of the data. - type: string - enum: - - TYPE_UNSPECIFIED - - STRING - - NUMBER - - INTEGER - - BOOLEAN - - ARRAY - - OBJECT - maxProperties: - description: Optional. Maximum number of the properties for Type.OBJECT. - format: int64 - type: string - nullable: - type: boolean - description: Optional. Indicates if the value may be null. - minItems: - type: string - format: int64 - description: Optional. Minimum number of the elements for Type.ARRAY. - pattern: + id: GoogleCloudAiplatformV1TokensInfo + description: >- + Tokens info with a list of tokens and the corresponding list of token + ids. + GoogleCloudAiplatformV1NasJobOutput: + id: GoogleCloudAiplatformV1NasJobOutput + properties: + multiTrialJobOutput: description: >- - Optional. Pattern of the Type.STRING to restrict a string to a - regular expression. - type: string - maxLength: - description: Optional. Maximum length of the Type.STRING - type: string - format: int64 - description: - description: Optional. The description of the data. - type: string - properties: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - type: object - description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - format: + Output only. The output of this multi-trial Neural Architecture + Search (NAS) job. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + readOnly: true + description: Represents a uCAIP NasJob output. + type: object + GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata: + type: object + id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata + properties: + progressMessage: type: string description: >- - Optional. The format of the data. Supported formats: for NUMBER - type: "float", "double" for INTEGER type: "int32", "int64" for - STRING type: "email", "byte", etc - minProperties: - format: int64 + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Metadata information for NotebookService.UpgradeNotebookRuntime. + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult: + description: Spec for question answering helpfulness result. + properties: + explanation: + readOnly: true type: string - description: Optional. Minimum number of the properties for Type.OBJECT. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - description: >- - Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of - Type.ARRAY. - maximum: - format: double - description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER + description: Output only. Explanation for question answering helpfulness score. + score: + readOnly: true + format: float + type: number + description: Output only. Question Answering Helpfulness score. + confidence: + readOnly: true + format: float + description: Output only. Confidence for question answering helpfulness score. type: number - id: GoogleCloudAiplatformV1Schema - description: >- - Schema is used to define the format of input/output data. Represents a - select subset of an [OpenAPI 3.0 schema - object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields - may be added in the future as needed. type: object + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult type: object - description: Prediction output format for Video Object Tracking. properties: - id: - description: The resource ID of the AnnotationSpec that had been identified. - type: string - displayName: - description: The display name of the AnnotationSpec that had been identified. - type: string - timeSegmentEnd: - type: string + timeSegmentStart: format: google-duration + type: string description: >- - The end, inclusive, of the video's time segment in which the object - instance has been detected. Expressed as a number of seconds as - measured from the start of the video, with fractions up to a + The beginning, inclusive, of the video's time segment in which the + object instance has been detected. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a microsecond precision, and with "s" appended at the end. frames: + type: array items: $ref: >- #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame @@ -20600,630 +20984,683 @@ components: All of the frames of the video in which a single object instance has been detected. The bounding boxes in the frames identify the same object. - type: array - timeSegmentStart: - type: string + timeSegmentEnd: format: google-duration + type: string description: >- - The beginning, inclusive, of the video's time segment in which the - object instance has been detected. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a + The end, inclusive, of the video's time segment in which the object + instance has been detected. Expressed as a number of seconds as + measured from the start of the video, with fractions up to a microsecond precision, and with "s" appended at the end. + displayName: + description: The display name of the AnnotationSpec that had been identified. + type: string confidence: + format: float description: >- The Model's confidence in correction of this prediction, higher value means higher confidence. type: number - format: float - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs: + id: + type: string + description: The resource ID of the AnnotationSpec that had been identified. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult + description: Prediction output format for Video Object Tracking. + GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse: + properties: {} + type: object + id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + description: Response message for MetadataService.AddContextArtifactsAndExecutions. + GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor: + description: Metadata for requested Features. + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor type: object properties: - optimizationObjective: - type: string - description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. - timeColumn: + id: type: string + description: Feature ID. + GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest: + id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest + type: object + properties: + requests: + type: array description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. - transformations: + Required. The request message specifying the TensorboardRuns to + create. A maximum of 1000 TensorboardRuns can be created in a batch. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardRunRequest + description: Request message for TensorboardService.BatchCreateTensorboardRuns. + GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata: + description: Details of operations that perform MetadataService.DeleteMetadataStore. + type: object + id: GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for deleting a MetadataStore. + GoogleCloudAiplatformV1StreamingPredictResponse: + id: GoogleCloudAiplatformV1StreamingPredictResponse + type: object + description: Response message for PredictionService.StreamingPredict. + properties: + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. + outputs: + description: The prediction output. type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi: + id: GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi + description: Rest API docs. + properties: + documentations: + description: Required. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation - description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - weightColumn: - description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. This column must be available at forecast. - type: string - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. - type: string - targetColumn: - description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. + #/components/schemas/GoogleCloudAiplatformV1PublisherModelDocumentation + type: array + title: type: string - validationOptions: + description: Required. The title of the view rest API. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + type: object + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + properties: + columnName: type: string + GoogleCloudAiplatformV1SmoothGradConfig: + id: GoogleCloudAiplatformV1SmoothGradConfig + description: >- + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy samples + in the vicinity of the inputs. Adding noise can help improve the + computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + type: object + properties: + featureNoiseSigma: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigma' description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue - quantiles: - items: - format: double - type: number - type: array - description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`. Up to 5 quantiles are allowed of values - between 0 and 1, exclusive. Required if the value of - optimization_objective is minimize-quantile-loss. Represents the - percent quantiles to use for that objective. Quantiles must be - unique. - hierarchyConfig: - description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - windowConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - description: Config containing strategy for generating sliding windows. - forecastHorizon: + This is similar to noise_sigma, but provides additional flexibility. + A separate noise sigma can be provided for each feature, which is + useful if their distributions are different. No noise is added to + features that are not set. If this field is unset, noise_sigma will + be used for all features. + noisySampleCount: + format: int32 + type: integer description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - type: string - format: int64 - unavailableAtForecastColumns: - type: array - items: - type: string + The number of gradient samples to use for approximation. The higher + this number, the more accurate the gradient is, but the runtime + complexity increases by this factor as well. Valid range of its + value is [1, 50]. Defaults to 3. + noiseSigma: + type: number description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. - exportEvaluatedDataItemsConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + This is a single float value and will be used to add noise to all + the features. Use this field when all features are normalized to + have the same distribution: scale to range [0, 1], [-1, 1] or + z-scoring, where features are normalized to have 0-mean and + 1-variance. Learn more about + [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). + For best results the recommended value is about 10% - 20% of the + standard deviation of the input feature. Refer to section 3.2 of the + SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to + 0.1. If the distribution is different per feature, set + feature_noise_sigma instead for each feature. + format: float + GoogleCloudAiplatformV1PredictRequest: + properties: + parameters: + type: any description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - additionalExperiments: + The parameters that govern the prediction. The schema of the + parameters may be specified via Endpoint's DeployedModels' Model's + PredictSchemata's parameters_schema_uri. + instances: items: - type: string - type: array - description: Additional experiment flags for the time series forcasting training. - trainBudgetMilliNodeHours: - description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. - type: string - format: int64 - holidayRegions: - description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. + type: any type: array - items: - type: string - contextWindow: description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. + Required. The instances that are the input to the prediction call. A + DeployedModel may have an upper limit on the number of instances it + supports per request, and when it is exceeded the prediction call + errors in case of AutoML Models, or, in case of customer created + Models, the behaviour is as documented by that Model. The schema of + any single instance may be specified via Endpoint's DeployedModels' + Model's PredictSchemata's instance_schema_uri. + description: Request message for PredictionService.Predict. + id: GoogleCloudAiplatformV1PredictRequest + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation: + properties: + columnName: type: string - format: int64 - dataGranularity: - description: Expected difference in time granularity between rows in the data. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity - availableAtForecastColumns: - description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. - type: array - items: - type: string - timeSeriesAttributeColumns: - type: array - items: - type: string + type: object + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation + GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec: + properties: + useReference: + type: boolean description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest: - id: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest - description: Request message for PipelineService.BatchCancelPipelineJobs. + Optional. Whether to use instance.reference to compute pairwise + summarization quality. + version: + type: integer + format: int32 + description: Optional. Which version to use for evaluation. + id: GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec + type: object + description: Spec for pairwise summarization quality score metric. + GoogleCloudAiplatformV1ListOptimalTrialsRequest: + description: Request message for VizierService.ListOptimalTrials. + id: GoogleCloudAiplatformV1ListOptimalTrialsRequest + properties: {} type: object + GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata: properties: - names: - type: array - description: >- - Required. The names of the PipelineJobs to cancel. A maximum of 32 - PipelineJobs can be cancelled in a batch. Format: - `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` - items: - type: string - GoogleCloudAiplatformV1IntegratedGradientsAttribution: - id: GoogleCloudAiplatformV1IntegratedGradientsAttribution + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore export Feature values. + id: GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata + type: object + description: Details of operations that exports Features values. + GoogleCloudAiplatformV1StudySpecStudyStoppingConfig: description: >- - An attribution method that computes the Aumann-Shapley value taking - advantage of the model's fully differentiable structure. Refer to this - paper for more details: https://arxiv.org/abs/1703.01365 + The configuration (stopping conditions) for automated stopping of a + Study. Conditions include trial budgets, time budgets, and convergence + detection. properties: - stepCount: - description: >- - Required. The number of steps for approximating the path integral. A - good value to start is 50 and gradually increase until the sum to - diff property is within the desired error range. Valid range of its - value is [1, 100], inclusively. + maxNumTrials: format: int32 + description: If there are more than this many trials, stop the study. type: integer - blurBaselineConfig: + maxNumTrialsNoProgress: + format: int32 description: >- - Config for IG with blur baseline. When enabled, a linear path from - the maximally blurred image to the input image is created. Using a - blurred baseline instead of zero (black image) is motivated by the - BlurIG approach explained here: https://arxiv.org/abs/2004.03383 - $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' - smoothGradConfig: + If the objective value has not improved for this many consecutive + trials, stop the study. WARNING: Effective only for single-objective + studies. + type: integer + shouldStopAsap: + type: boolean description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy - samples in the vicinity of the inputs. Adding noise can help improve - the computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf - $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' + If true, a Study enters STOPPING_ASAP whenever it would normally + enters STOPPING state. The bottom line is: set to true if you want + to interrupt on-going evaluations of Trials as soon as the study + stopping condition is met. (Please see Study.State documentation for + the source of truth). + maximumRuntimeConstraint: + description: If the specified time or duration has passed, stop the study. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' + minimumRuntimeConstraint: + description: >- + Each "stopping rule" in this proto specifies an "if" condition. + Before Vizier would generate a new suggestion, it first checks each + specified stopping rule, from top to bottom in this list. Note that + the first few rules (e.g. minimum_runtime_constraint, + min_num_trials) will prevent other stopping rules from being + evaluated until they are met. For example, setting + `min_num_trials=5` and `always_stop_after= 1 hour` means that the + Study will ONLY stop after it has 5 COMPLETED trials, even if more + than an hour has passed since its creation. It follows the first + applicable rule (whose "if" condition is satisfied) to make a + stopping decision. If none of the specified rules are applicable, + then Vizier decides that the study should not stop. If Vizier + decides that the study should stop, the study enters STOPPING state + (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The + automatic study state transition happens precisely as described + above; that is, deleting trials or updating StudyConfig NEVER + automatically moves the study state back to ACTIVE. If you want to + _resume_ a Study that was stopped, 1) change the stopping conditions + if necessary, 2) activate the study, and then 3) ask for + suggestions. If the specified time or duration has not passed, do + not stop the study. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' + minNumTrials: + type: integer + format: int32 + description: >- + If there are fewer than this many COMPLETED trials, do not stop the + study. + maxDurationNoProgress: + type: string + description: >- + If the objective value has not improved for this much time, stop the + study. WARNING: Effective only for single-objective studies. + format: google-duration + id: GoogleCloudAiplatformV1StudySpecStudyStoppingConfig type: object - GoogleCloudAiplatformV1SchemaImageDataItem: + GoogleCloudAiplatformV1UndeployModelResponse: + description: Response message for EndpointService.UndeployModel. + properties: {} + id: GoogleCloudAiplatformV1UndeployModelResponse + type: object + GoogleCloudAiplatformV1NasJobSpec: + description: Represents the spec of a NasJob. + id: GoogleCloudAiplatformV1NasJobSpec type: object properties: - gcsUri: + multiTrialAlgorithmSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec + description: The spec of multi-trial algorithms. + resumeNasJobId: description: >- - Required. Google Cloud Storage URI points to the original image in - user's bucket. The image is up to 30MB in size. + The ID of the existing NasJob in the same Project and Location which + will be used to resume search. search_space_spec and + nas_algorithm_spec are obtained from previous NasJob hence should + not provide them again for this NasJob. type: string - mimeType: - readOnly: true - description: >- - Output only. The mime type of the content of the image. Only the - images in below listed mime types are supported. - image/jpeg - - image/gif - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon + searchSpaceSpec: type: string - description: Payload of Image DataItem. - id: GoogleCloudAiplatformV1SchemaImageDataItem - GoogleCloudAiplatformV1Int64Array: - description: A list of int64 values. - id: GoogleCloudAiplatformV1Int64Array - type: object - properties: - values: - items: - type: string - format: int64 - type: array - description: A list of int64 values. - GoogleCloudAiplatformV1SafetySpec: - description: Spec for safety metric. + description: It defines the search space for Neural Architecture Search (NAS). + GoogleCloudAiplatformV1AddContextChildrenResponse: + properties: {} type: object - id: GoogleCloudAiplatformV1SafetySpec + id: GoogleCloudAiplatformV1AddContextChildrenResponse + description: Response message for MetadataService.AddContextChildren. + GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem: properties: - version: - type: integer - description: Optional. Which version to use for evaluation. - format: int32 - GoogleCloudAiplatformV1ExportDataConfig: + annotationResourceName: + description: >- + The unique ID for each annotation. Used by FE to allocate the + annotation in DB. + type: string + distance: + format: double + description: The distance of this item to the annotation. + type: number + id: GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem description: >- - Describes what part of the Dataset is to be exported, the destination of - the export and how to export. + Attributed items for a given annotation, typically representing + neighbors from the training sets constrained by the query type. type: object - id: GoogleCloudAiplatformV1ExportDataConfig + GoogleApiHttpBody: + id: GoogleApiHttpBody + type: object + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. properties: - exportUse: - enumDescriptions: - - Regular user export. - - Export for custom code training. - enum: - - EXPORT_USE_UNSPECIFIED - - CUSTOM_CODE_TRAINING + data: type: string - description: Indicates the usage of the exported files. - filterSplit: - description: Split based on the provided filters for each set. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFilterSplit' - annotationsFilter: + format: byte + description: The HTTP request/response body as raw binary. + extensions: + type: array description: >- - An expression for filtering what part of the Dataset is to be - exported. Only Annotations that match this filter will be exported. - The filter syntax is the same as in ListAnnotations. - type: string - fractionSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFractionSplit' - description: Split based on fractions defining the size of each set. - savedQueryId: + Application specific response metadata. Must be set in the first + response for streaming APIs. + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + contentType: description: >- - The ID of a SavedQuery (annotation set) under the Dataset specified - by dataset_id used for filtering Annotations for training. Only used - for custom training data export use cases. Only applicable to - Datasets that have SavedQueries. Only Annotations that are - associated with this SavedQuery are used in respectively training. - When used in conjunction with annotations_filter, the Annotations - used for training are filtered by both saved_query_id and - annotations_filter. Only one of saved_query_id and - annotation_schema_uri should be specified as both of them represent - the same thing: problem type. + The HTTP Content-Type header value specifying the content type of + the body. type: string - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature: + properties: + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' description: >- - The Google Cloud Storage location where the output is to be written - to. In the given directory a new directory will be created with - name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ - ISO-8601 format. All export output will be written into that - directory. Inside that directory, annotations with the same schema - will be grouped into sub directories which are named with the - corresponding annotations' schema title. Inside these sub - directories, a schema.yaml will be created to describe the output - format. - annotationSchemaUri: - type: string + Required. Select feature generated within a half-inclusive time + range. The time range is lower inclusive and upper exclusive. + skipOnlineStorageDelete: + type: boolean description: >- - The Cloud Storage URI that points to a YAML file describing the - annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/, note that - the chosen schema must be consistent with metadata of the Dataset - specified by dataset_id. Only used for custom training data export - use cases. Only applicable to Datasets that have DataItems and - Annotations. Only Annotations that both match this schema and belong - to DataItems not ignored by the split method are used in - respectively training, validation or test role, depending on the - role of the DataItem they are on. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both annotations_filter and annotation_schema_uri. - GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse: - id: GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse - description: >- - Response message for - FeatureOnlineStoreAdminService.ListFeatureOnlineStores. - properties: - nextPageToken: + If set, data will not be deleted from online storage. When time + range is older than the data in online storage, setting this to be + true will make the deletion have no impact on online serving. + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' description: >- - A token, which can be sent as - ListFeatureOnlineStoresRequest.page_token to retrieve the next page. - If this field is omitted, there are no subsequent pages. - type: string - featureOnlineStores: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' - description: The FeatureOnlineStores matching the request. - type: object - GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse: - properties: {} - description: Response message for MetadataService.AddContextArtifactsAndExecutions. - id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + Required. Selectors choosing which feature values to be deleted from + the EntityType. + description: >- + Message to select time range and feature. Values of the selected feature + generated within an inclusive time range will be deleted. Using this + option permanently deletes the feature values from the specified feature + IDs within the specified time range. This might include data from the + online storage. If you want to retain any deleted historical data in the + online storage, you must re-ingest it. type: object - GoogleCloudAiplatformV1FeatureValueList: + id: >- + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature + GoogleCloudAiplatformV1ModelExportFormat: type: object - description: Container for list of values. - id: GoogleCloudAiplatformV1FeatureValueList + description: >- + Represents export format supported by the Model. All formats export to + Google Cloud Storage. + id: GoogleCloudAiplatformV1ModelExportFormat properties: - values: - description: A list of feature values. All of them should be the same data type. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + exportableContents: type: array - GoogleCloudAiplatformV1FeatureValue: - id: GoogleCloudAiplatformV1FeatureValue - description: Value for a feature. + items: + enumDescriptions: + - Should not be used. + - >- + Model artifact and any of its supported files. Will be exported + to the location specified by the `artifactDestination` field of + the ExportModelRequest.output_config object. + - >- + The container image that is to be used when deploying this + Model. Will be exported to the location specified by the + `imageDestination` field of the ExportModelRequest.output_config + object. + enum: + - EXPORTABLE_CONTENT_UNSPECIFIED + - ARTIFACT + - IMAGE + type: string + readOnly: true + description: Output only. The content of this Model that may be exported. + id: + description: >- + Output only. The ID of the export format. The possible format IDs + are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` + Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * + `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be + used in the browser and in Node.js using JavaScript. * `core-ml` + Used for iOS mobile devices. * `custom-trained` A Model that was + uploaded or trained by custom code. + type: string + readOnly: true + GoogleCloudAiplatformV1SafetyInstance: type: object properties: - stringValue: - type: string - description: String feature value. - doubleArrayValue: - description: A list of double type feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DoubleArray' - stringArrayValue: - description: A list of string type feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StringArray' - int64ArrayValue: - description: A list of int64 type feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Int64Array' - int64Value: - type: string - description: Int64 feature value. - format: int64 - doubleValue: - type: number - format: double - description: Double type feature value. - metadata: - description: Metadata of feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueMetadata' - boolArrayValue: - description: A list of bool type feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BoolArray' - structValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StructValue' - description: A struct type feature value. - boolValue: - description: Bool type feature value. - type: boolean - bytesValue: - description: Bytes feature value. + prediction: type: string - format: byte - GoogleCloudAiplatformV1FindNeighborsRequestQuery: + description: Required. Output of the evaluated model. + description: Spec for safety instance. + id: GoogleCloudAiplatformV1SafetyInstance + GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata: + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' description: >- - A query to find a number of the nearest neighbors (most similar vectors) - of a vector. + Runtime operation information for + JobService.UpdateModelDeploymentMonitoringJob. type: object + id: >- + GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata + GoogleCloudAiplatformV1TensorboardTensor: properties: - fractionLeafNodesToSearchOverride: - type: number - description: >- - The fraction of the number of leaves to search, set at query time - allows user to tune search performance. This value increase result - in both search accuracy and latency increase. The value should be - between 0.0 and 1.0. If not set or set to 0.0, query uses the - default value specified in - NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search. - format: double - neighborCount: - format: int32 - type: integer - description: >- - The number of nearest neighbors to be retrieved from database for - each query. If not set, will use the default from the service - configuration - (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config). - approximateNeighborCount: - format: int32 - type: integer + value: + format: byte description: >- - The number of neighbors to find via approximate search before exact - reordering is performed. If not set, the default value from scam - config is used; if set, this value must be > 0. - perCrowdingAttributeNeighborCount: + Required. Serialized form of + https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto + type: string + versionNumber: type: integer + description: Optional. Version number of TensorProto used to serialize value. format: int32 - description: >- - Crowding is a constraint on a neighbor list produced by nearest - neighbor search requiring that no more than some value k' of the k - neighbors returned have the same value of crowding_attribute. It's - used for improving result diversity. This field is the maximum - number of matches with the same crowding tag. - datapoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - description: >- - Required. The datapoint/vector whose nearest neighbors should be - searched for. - rrf: - description: Optional. Represents RRF algorithm that combines search results. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF - id: GoogleCloudAiplatformV1FindNeighborsRequestQuery - GoogleCloudAiplatformV1ScheduleRunResponse: - description: Status of a scheduled run. + id: GoogleCloudAiplatformV1TensorboardTensor + type: object + description: One point viewable on a tensor metric plot. + GoogleCloudAiplatformV1GroundingChunkRetrievedContext: properties: - runResponse: - description: The response of the scheduled run. + title: + description: Title of the attribution. type: string - scheduledRunTime: + uri: type: string - format: google-datetime - description: The scheduled run time based on the user-specified schedule. + description: URI reference of the attribution. + id: GoogleCloudAiplatformV1GroundingChunkRetrievedContext + description: Chunk from context retrieved by the retrieval tools. + type: object + GoogleTypeColor: + type: object + properties: + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + type: number + red: + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + type: number + alpha: + type: number + format: float + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + green: + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + id: GoogleTypeColor + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult: type: object - id: GoogleCloudAiplatformV1ScheduleRunResponse - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation: properties: - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - annotationSpecId: - type: string - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - vertexes: - description: >- - The vertexes are connected one by one and the last vertex in not - connected to the first one. + quantileValues: + type: array + description: Quantile values. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' + format: float + type: number + tftFeatureImportance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance + description: Only use these if TFt is enabled. + value: + format: float + description: The regression value. + type: number + quantilePredictions: + items: + type: number + format: float + description: Quantile predictions, in 1-1 correspondence with quantile_values. type: array - description: Represents a polyline in image. id: >- - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult + description: Prediction output format for Time Series Forecasting. + GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse: + description: >- + Response message for + TensorboardService.BatchCreateTensorboardTimeSeries. + id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse type: object - GoogleCloudAiplatformV1ListAnnotationsResponse: - description: Response message for DatasetService.ListAnnotations. properties: - annotations: + tensorboardTimeSeries: type: array - description: >- - A list of Annotations that matches the specified filter in the - request. + description: The created TensorboardTimeSeries. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' - nextPageToken: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata: + properties: + evaluatedDataItemsBigqueryUri: + description: BigQuery destination uri for exported evaluated examples. type: string - description: The standard List next-page token. - id: GoogleCloudAiplatformV1ListAnnotationsResponse + trainCostMilliNodeHours: + description: >- + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + type: string + format: int64 + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata + description: Model metadata specific to Seq2Seq Plus Forecasting. + GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult + description: Prediction output format for Text Sentiment type: object - GoogleCloudAiplatformV1GenerationConfig: properties: - responseMimeType: + sentiment: + type: integer + format: int32 description: >- - Optional. Output response mimetype of the generated candidate text. - Supported mimetype: - `text/plain`: (default) Text output. - - `application/json`: JSON response in the candidates. The model needs - to be prompted to output the appropriate response type, otherwise - the behavior is undefined. This is a preview feature. - type: string - routingConfig: - description: Optional. Routing configuration. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfig - frequencyPenalty: - format: float - description: Optional. Frequency penalties. - type: number - stopSequences: + The integer sentiment labels between 0 (inclusive) and sentimentMax + label (inclusive), while 0 maps to the least positive sentiment and + sentimentMax maps to the most positive one. The higher the score is, + the more positive the sentiment in the text snippet is. Note: + sentimentMax is an integer value between 1 (inclusive) and 10 + (inclusive). + GoogleCloudAiplatformV1StringArray: + id: GoogleCloudAiplatformV1StringArray + description: A list of string values. + type: object + properties: + values: + description: A list of string values. items: type: string - description: Optional. Stop sequences. type: array - responseSchema: - description: >- - Optional. The `Schema` object allows the definition of input and - output data types. These types can be objects, but also primitives - and arrays. Represents a select subset of an [OpenAPI 3.0 schema - object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a - compatible response_mime_type must also be set. Compatible - mimetypes: `application/json`: Schema for JSON response. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - presencePenalty: - format: float - type: number - description: Optional. Positive penalties. - maxOutputTokens: - description: >- - Optional. The maximum number of output tokens to generate per - message. - format: int32 - type: integer - temperature: - description: Optional. Controls the randomness of predictions. - format: float - type: number - topK: - description: Optional. If specified, top-k sampling will be used. - format: float - type: number - seed: - description: Optional. Seed. - format: int32 - type: integer - candidateCount: - type: integer - format: int32 - description: Optional. Number of candidates to generate. - topP: - type: number - description: Optional. If specified, nucleus sampling will be used. - format: float - id: GoogleCloudAiplatformV1GenerationConfig - description: Generation config. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs: - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs - properties: {} - GoogleCloudAiplatformV1FulfillmentSpec: + GoogleCloudAiplatformV1Int64Array: properties: - version: - description: Optional. Which version to use for evaluation. - format: int32 - type: integer - id: GoogleCloudAiplatformV1FulfillmentSpec + values: + description: A list of int64 values. + items: + format: int64 + type: string + type: array + description: A list of int64 values. + id: GoogleCloudAiplatformV1Int64Array type: object - description: Spec for fulfillment metric. - GoogleTypeDate: + GoogleCloudAiplatformV1LineageSubgraph: type: object - id: GoogleTypeDate - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp properties: - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - format: int32 - day: - type: integer - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 - year: - format: int32 - type: integer - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. + executions: + description: The Execution nodes in the subgraph. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + events: + type: array + description: The Event edges between Artifacts and Executions in the subgraph. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' + artifacts: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + type: array + description: The Artifact nodes in the subgraph. + id: GoogleCloudAiplatformV1LineageSubgraph + description: >- + A subgraph of the overall lineage graph. Event edges connect Artifact + and Execution nodes. GoogleCloudAiplatformV1DeploymentResourcePool: properties: - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzs: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + name: + type: string description: >- - Required. The underlying DedicatedResources that the - DeploymentResourcePool uses. + Immutable. The resource name of the DeploymentResourcePool. Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` serviceAccount: + type: string description: >- The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this @@ -21231,7 +21668,6 @@ components: account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account. - type: string disableContainerLogging: type: boolean description: >- @@ -21242,11 +21678,6 @@ components: which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. - name: - type: string - description: >- - Immutable. The resource name of the DeploymentResourcePool. Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` encryptionSpec: description: >- Customer-managed encryption key spec for a DeploymentResourcePool. @@ -21254,788 +21685,762 @@ components: Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - satisfiesPzi: - description: Output only. Reserved for future use. - type: boolean - readOnly: true + dedicatedResources: + description: >- + Required. The underlying DedicatedResources that the + DeploymentResourcePool uses. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' createTime: type: string - format: google-datetime - readOnly: true description: Output only. Timestamp when this DeploymentResourcePool was created. - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. + format: google-datetime readOnly: true type: object - id: GoogleCloudAiplatformV1DeploymentResourcePool description: >- A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources. - GoogleCloudAiplatformV1UpdateExplanationDatasetResponse: - id: GoogleCloudAiplatformV1UpdateExplanationDatasetResponse - properties: {} - description: Response message of ModelService.UpdateExplanationDataset operation. - type: object - GoogleCloudAiplatformV1TrainingPipeline: + id: GoogleCloudAiplatformV1DeploymentResourcePool + GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams: + description: Prediction model parameters for Image Classification. + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams type: object - description: >- - The TrainingPipeline orchestrates tasks associated with training a - Model. It always executes the training task, and optionally may also - export data from Vertex AI's Dataset which becomes the training input, - upload the Model to Vertex AI, and evaluate the Model. - id: GoogleCloudAiplatformV1TrainingPipeline properties: - startTime: - type: string - description: >- - Output only. Time when the TrainingPipeline for the first time - entered the `PIPELINE_STATE_RUNNING` state. - format: google-datetime - readOnly: true - modelId: - type: string + confidenceThreshold: + format: float description: >- - Optional. The ID to use for the uploaded Model, which will become - the final component of the model 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. - trainingTaskMetadata: - type: any - readOnly: true + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + type: number + maxPredictions: + format: int32 + type: integer description: >- - Output only. The metadata information as specified in the - training_task_definition's `metadata`. This metadata is an auxiliary - runtime and final information about the training task. While the - pipeline is running this information is populated only at a best - effort basis. Only present if the pipeline's - training_task_definition contains `metadata` object. - state: + The Model only returns up to that many top, by confidence score, + predictions per instance. If this number is very high, the Model may + return fewer predictions. Default value is 10. + GoogleCloudAiplatformV1CsvSource: + description: The storage details for CSV input content. + type: object + id: GoogleCloudAiplatformV1CsvSource + properties: + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: Required. Google Cloud Storage location. + GoogleCloudAiplatformV1DirectRawPredictResponse: + id: GoogleCloudAiplatformV1DirectRawPredictResponse + type: object + description: Response message for PredictionService.DirectRawPredict. + properties: + output: + format: byte + description: The prediction output. type: string - readOnly: true - description: Output only. The detailed state of the pipeline. - enum: - - PIPELINE_STATE_UNSPECIFIED - - PIPELINE_STATE_QUEUED - - PIPELINE_STATE_PENDING - - PIPELINE_STATE_RUNNING - - PIPELINE_STATE_SUCCEEDED - - PIPELINE_STATE_FAILED - - PIPELINE_STATE_CANCELLING - - PIPELINE_STATE_CANCELLED - - PIPELINE_STATE_PAUSED + GoogleCloudAiplatformV1PipelineJobRuntimeConfig: + type: object + id: GoogleCloudAiplatformV1PipelineJobRuntimeConfig + properties: + failurePolicy: + description: >- + Represents the failure policy of a pipeline. Currently, the default + of a pipeline is that the pipeline will continue to run until no + more tasks can be executed, also known as + PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to + PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new + tasks when a task has failed. Any scheduled tasks will continue to + completion. enumDescriptions: - - The pipeline state is unspecified. + - Default value, and follows fail slow behavior. - >- - The pipeline has been created or resumed, and processing has not - yet begun. - - The service is preparing to run the pipeline. - - The pipeline is in progress. - - The pipeline completed successfully. - - The pipeline failed. + Indicates that the pipeline should continue to run until all + possible tasks have been scheduled and completed. - >- - The pipeline is being cancelled. From this state, the pipeline may - only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED - or PIPELINE_STATE_CANCELLED. - - The pipeline has been cancelled. - - The pipeline has been stopped, and can be resumed. - displayName: - description: Required. The user-defined name of this TrainingPipeline. + Indicates that the pipeline should stop scheduling new tasks after + a task has failed. type: string - trainingTaskInputs: - description: >- - Required. The training task's parameter(s), as specified in the - training_task_definition's `inputs`. - type: any - endTime: + enum: + - PIPELINE_FAILURE_POLICY_UNSPECIFIED + - PIPELINE_FAILURE_POLICY_FAIL_SLOW + - PIPELINE_FAILURE_POLICY_FAIL_FAST + inputArtifacts: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact description: >- - Output only. Time when the TrainingPipeline entered any of the - following states: `PIPELINE_STATE_SUCCEEDED`, - `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. - readOnly: true - type: string - format: google-datetime - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + The runtime artifacts of the PipelineJob. The key will be the input + artifact name and the value would be one of the InputArtifact. + parameters: + deprecated: true description: >- - Customer-managed encryption key spec for a TrainingPipeline. If set, - this TrainingPipeline will be secured by this key. Note: Model - trained by this TrainingPipeline is also secured by this key if - model_to_upload is not set separately. - labels: + Deprecated. Use RuntimeConfig.parameter_values instead. The runtime + parameters of the PipelineJob. The parameters will be passed into + PipelineJob.pipeline_spec to replace the placeholders at runtime. + This field is used by pipelines built using + `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as + pipelines built using Kubeflow Pipelines SDK 1.8 or lower. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Value' type: object + parameterValues: additionalProperties: - type: string + type: any description: >- - The labels with user-defined metadata to organize TrainingPipelines. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - name: - description: Output only. Resource name of the TrainingPipeline. + The runtime parameters of the PipelineJob. The parameters will be + passed into PipelineJob.pipeline_spec to replace the placeholders at + runtime. This field is used by pipelines built using + `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines + built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. + type: object + gcsOutputDirectory: + description: >- + Required. A path in a Cloud Storage bucket, which will be treated as + the root output directory of the pipeline. It is used by the system + to generate the paths of output artifacts. The artifact paths are + generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` + under the specified output directory. The service account specified + in this pipeline must have the `storage.objects.get` and + `storage.objects.create` permissions for this bucket. + type: string + description: The runtime config of a PipelineJob. + GoogleCloudAiplatformV1ModelExplanation: + type: object + description: Aggregated explanation metrics for a Model over a set of instances. + properties: + meanAttributions: + description: >- + Output only. Aggregated attributions explaining the Model's + prediction outputs over the set of instances. The attributions are + grouped by outputs. For Models that predict only one output, such as + regression Models that predict only one score, there is only one + attibution that explains the predicted output. For Models that + predict multiple outputs, such as multiclass Models that predict + multiple classes, each element explains one specific item. + Attribution.output_index can be used to identify which output this + attribution is explaining. The baselineOutputValue, + instanceOutputValue and featureAttributions fields are averaged over + the test data. NOTE: Currently AutoML tabular classification Models + produce only one attribution, which averages attributions over all + the classes it predicts. Attribution.approximation_error is not + populated. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' + type: array readOnly: true + id: GoogleCloudAiplatformV1ModelExplanation + GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: + id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse + type: object + properties: + notebookRuntimeTemplates: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + description: List of NotebookRuntimeTemplates in the requested page. + type: array + nextPageToken: type: string - inputDataConfig: - description: >- - Specifies Vertex AI owned input data that may be used for training - the Model. The TrainingPipeline's training_task_definition should - make clear whether this config is used and if there are any special - requirements on how it should be filled. If nothing about this - config is mentioned in the training_task_definition, then it should - be assumed that the TrainingPipeline does not depend on this - configuration. - $ref: '#/components/schemas/GoogleCloudAiplatformV1InputDataConfig' - parentModel: description: >- - Optional. When specify this field, the `model_to_upload` will not be - uploaded as a new model, instead, it will become a new version of - this `parent_model`. + A token to retrieve next page of results. Pass to + ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. + description: Response message for NotebookService.ListNotebookRuntimeTemplates. + GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies: + description: Historical Stats (and Anomalies) for a specific Feature. + type: object + properties: + featureDisplayName: type: string - error: + description: Display Name of the Feature. + predictionStats: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + type: array description: >- - Output only. Only populated when the pipeline's state is - `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - modelToUpload: + A list of historical stats generated by different time window's + Prediction Dataset. + threshold: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + description: Threshold for anomaly detection. + trainingStats: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + description: Stats calculated for the Training Dataset. + id: >- + GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies + GoogleCloudAiplatformV1RemoveDatapointsRequest: + id: GoogleCloudAiplatformV1RemoveDatapointsRequest + type: object + properties: + datapointIds: + description: A list of datapoint ids to be deleted. + items: + type: string + type: array + description: Request message for IndexService.RemoveDatapoints + GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata: + description: Describes metadata for a TensorboardTimeSeries. + id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata + properties: + maxStep: description: >- - Describes the Model that may be uploaded (via - ModelService.UploadModel) by this TrainingPipeline. The - TrainingPipeline's training_task_definition should make clear - whether this Model description should be populated, and if there are - any special requirements regarding how it should be filled. If - nothing is mentioned in the training_task_definition, then it should - be assumed that this field should not be filled and the training - task either uploads the Model without a need of this information, or - that training task does not support uploading a Model as part of the - pipeline. When the Pipeline's state becomes - `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded - into Vertex AI, then the model_to_upload's resource name is - populated. The Model is always uploaded into the Project and - Location in which this pipeline is. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - trainingTaskDefinition: + Output only. Max step index of all data points within a + TensorboardTimeSeries. + format: int64 + readOnly: true + type: string + maxWallTime: type: string description: >- - Required. A Google Cloud Storage path to the YAML file that defines - the training task which is responsible for producing the model - artifact, and may also include additional auxiliary work. The - definition files that can be used here are found in - gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - createTime: + Output only. Max wall clock timestamp of all data points within a + TensorboardTimeSeries. format: google-datetime readOnly: true - description: Output only. Time when the TrainingPipeline was created. - type: string - updateTime: + maxBlobSequenceLength: readOnly: true + format: int64 + description: >- + Output only. The largest blob sequence length (number of blobs) of + all data points in this time series, if its ValueType is + BLOB_SEQUENCE. type: string + type: object + GoogleCloudLocationListLocationsResponse: + properties: + locations: description: >- - Output only. Time when the TrainingPipeline was most recently - updated. - format: google-datetime - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + nextPageToken: + type: string + description: The standard List next-page token. type: object + description: The response message for Locations.ListLocations. + id: GoogleCloudLocationListLocationsResponse + GoogleCloudAiplatformV1SchemaVertex: + id: GoogleCloudAiplatformV1SchemaVertex description: >- - A TrainingJob that trains and uploads an AutoML Video Classification - Model. + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. properties: - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs - GoogleCloudAiplatformV1ListIndexesResponse: + x: + format: double + description: X coordinate. + type: number + 'y': + format: double + type: number + description: Y coordinate. type: object - description: Response message for IndexService.ListIndexes. + GoogleCloudAiplatformV1SummarizationVerbositySpec: + properties: + version: + format: int32 + description: Optional. Which version to use for evaluation. + type: integer + useReference: + description: >- + Optional. Whether to use instance.reference to compute summarization + verbosity. + type: boolean + type: object + description: Spec for summarization verbosity score metric. + id: GoogleCloudAiplatformV1SummarizationVerbositySpec + GoogleCloudAiplatformV1ListArtifactsResponse: properties: + artifacts: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + description: The Artifacts retrieved from the MetadataStore. + type: array nextPageToken: type: string description: >- - A token to retrieve next page of results. Pass to - ListIndexesRequest.page_token to obtain that page. - indexes: - type: array - description: List of indexes in the requested page. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' - id: GoogleCloudAiplatformV1ListIndexesResponse - GoogleCloudAiplatformV1SpecialistPool: - id: GoogleCloudAiplatformV1SpecialistPool + A token, which can be sent as ListArtifactsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. + id: GoogleCloudAiplatformV1ListArtifactsResponse + description: Response message for MetadataService.ListArtifacts. + type: object + GoogleCloudAiplatformV1ExportModelResponse: + type: object + properties: {} + description: Response message of ModelService.ExportModel operation. + id: GoogleCloudAiplatformV1ExportModelResponse + CloudAiLargeModelsVisionSemanticFilterResponse: type: object + id: CloudAiLargeModelsVisionSemanticFilterResponse properties: - pendingDataLabelingJobs: + namedBoundingBoxes: items: - type: string - readOnly: true - description: Output only. The resource name of the pending data labeling jobs. + $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' type: array - name: - type: string - description: Required. The resource name of the SpecialistPool. - specialistManagersCount: + description: >- + Class labels of the bounding boxes that failed the semantic + filtering. Bounding box coordinates. + passedSemanticFilter: + type: boolean + description: >- + This response is added when semantic filter config is turned on in + EditConfig. It reports if this image is passed semantic filter + response. If passed_semantic_filter is false, the bounding box + information will be populated for user to check what caused the + semantic filter to fail. + GoogleCloudAiplatformV1Examples: + description: >- + Example-based explainability that returns the nearest neighbors from the + provided dataset. + properties: + nearestNeighborSearchConfig: + type: any + description: >- + The full configuration for the generated index, the semantics are + the same as metadata and should match + [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). + neighborCount: type: integer format: int32 - readOnly: true - description: Output only. The number of managers in this SpecialistPool. - specialistWorkerEmails: - type: array - description: The email addresses of workers in the SpecialistPool. - items: - type: string - specialistManagerEmails: - items: - type: string - type: array - description: The email addresses of the managers in the SpecialistPool. - displayName: + description: The number of neighbors to return when querying for examples. + exampleGcsSource: + description: The Cloud Storage input instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesExampleGcsSource' + presets: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Presets' description: >- - Required. The user-defined name of the SpecialistPool. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. This field should be unique on project-level. - type: string + Simplified preset configuration, which automatically sets + configuration values based on the desired query speed-precision + trade-off and modality. + type: object + id: GoogleCloudAiplatformV1Examples + GoogleCloudAiplatformV1ExactMatchSpec: + type: object + id: GoogleCloudAiplatformV1ExactMatchSpec description: >- - SpecialistPool represents customers' own workforce to work on their data - labeling jobs. It includes a group of specialist managers and workers. - Managers are responsible for managing the workers in this pool as well - as customers' data labeling jobs associated with this pool. Customers - create specialist pool as well as start data labeling jobs on Cloud, - managers and workers handle the jobs using CrowdCompute console. - GoogleCloudAiplatformV1SyncFeatureViewRequest: - id: GoogleCloudAiplatformV1SyncFeatureViewRequest + Spec for exact match metric - returns 1 if prediction and reference + exactly matches, otherwise 0. properties: {} - description: Request message for FeatureOnlineStoreAdminService.SyncFeatureView. - type: object - GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences: + GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader: description: >- - The regional resource name or the URI. Key is region, e.g., us-central1, - europe-west2, global, etc.. + Response header with metadata for the requested + ReadFeatureValuesRequest.entity_type and Features. + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader properties: - resourceDescription: + entityType: type: string - description: Optional. Description of the resource. - references: - description: Required. + description: >- + The resource name of the EntityType from the + ReadFeatureValuesRequest. Value format: + `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + featureDescriptors: + type: array + description: >- + List of Feature metadata corresponding to each piece of + ReadFeatureValuesResponse.EntityView.data. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor + type: object + GoogleCloudAiplatformV1ReadTensorboardUsageResponse: + type: object + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponse + description: Response message for TensorboardService.ReadTensorboardUsage. + properties: + monthlyUsageData: type: object additionalProperties: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelResourceReference - resourceTitle: - description: Optional. Title of the resource. - type: string - title: - description: 'Required. ' - type: string - resourceUseCase: - type: string - description: Optional. Use case (CUJ) of the resource. + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData + description: Maps year-month (YYYYMM) string to per month usage data. + CloudAiLargeModelsVisionRaiInfo: + description: 'Next ID: 6' type: object - id: >- - GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig: properties: - userEmails: + blockedEntities: type: array - description: The email addresses to send the alert. + description: List of blocked entities from the blocklist if it is detected. items: type: string - id: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig - type: object - description: The config for email alert. - GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance: - id: GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance - type: object - properties: - contextWeights: - items: - format: float - type: number - type: array + modelName: description: >- - TFT feature importance values. Each pair for - {context/horizon/attribute} should have the same shape since the - weight corresponds to the column names. - horizonWeights: + The model name used to indexing into the RaiFilterConfig map. Would + either be one of imagegeneration@002-006, imagen-3.0-... api + endpoint names, or internal names used for mapping to different + filter configs (genselfie, ai_watermark) than its api endpoint. + type: string + scores: + description: >- + List of rai scores mapping to the rai categories. Rounded to 1 + decimal place. items: type: number format: float type: array - attributeColumns: - items: - type: string - type: array - horizonColumns: - type: array + raiCategories: items: type: string - contextColumns: type: array + description: List of rai categories' information to return + detectedLabels: items: - type: string - attributeWeights: - items: - type: number - format: float + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' type: array - GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField: - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField - description: Describe pass-through fields in read_instance source. - type: object - properties: - fieldName: - type: string - description: >- - Required. The name of the field in the CSV header or the name of the - column in BigQuery table. The naming restriction is the same as - Feature.name. - GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride: - description: The input metadata entries to be overridden. - type: object - id: GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + description: The list of detected labels for different rai categories. + id: CloudAiLargeModelsVisionRaiInfo + GoogleCloudAiplatformV1BatchPredictionJobOutputInfo: properties: - inputBaselines: - type: array - items: - type: any + bigqueryOutputTable: + readOnly: true description: >- - Baseline inputs for this feature. This overrides the - `input_baseline` field of the ExplanationMetadata.InputMetadata - object of the corresponding feature's input metadata. If it's not - specified, the original baselines are not overridden. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics: - properties: - bleu: - type: number + Output only. The name of the BigQuery table created, in + `predictions_` format, into which the prediction output is written. + Can be used by UI to generate the BigQuery output path, for example. + type: string + bigqueryOutputDataset: description: >- - BLEU (bilingual evaluation understudy) scores based on sacrebleu - implementation. - format: float - rougeLSum: - description: ROUGE-L (Longest Common Subsequence) scoring at summary level. - type: number - format: float - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics - type: object - GoogleCloudAiplatformV1MeasurementMetric: - type: object - properties: - value: - format: double - type: number - description: Output only. The value for this metric. + Output only. The path of the BigQuery dataset created, in + `bq://projectId.bqDatasetId` format, into which the prediction + output is written. readOnly: true - metricId: type: string + gcsOutputDirectory: readOnly: true description: >- - Output only. The ID of the Metric. The Metric should be defined in - StudySpec's Metrics. - id: GoogleCloudAiplatformV1MeasurementMetric - description: A message representing a metric in the measurement. - GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata: - id: GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata + Output only. The full path of the Cloud Storage directory created, + into which the prediction output is written. + type: string + id: GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + description: Further describes this job's output. Supplements output_config. type: object - description: Details of operations that perform import Feature values. + GoogleCloudAiplatformV1BleuResults: properties: - importedFeatureValueCount: - type: string - format: int64 - description: Number of Feature values that have been imported by the operation. - blockingOperationIds: - items: - format: int64 - type: string - description: >- - List of ImportFeatureValues operations running under a single - EntityType that are blocking this operation. - type: array - invalidRowCount: - format: int64 - type: string - description: >- - The number of rows in input source that weren't imported due to - either * Not having any featureValues. * Having a null entityId. * - Having a null timestamp. * Not being parsable (applicable for CSV - sources). - timestampOutsideRetentionRowsCount: - description: >- - The number rows that weren't ingested due to having timestamps - outside the retention boundary. - format: int64 - type: string - importedEntityCount: - format: int64 - type: string - description: Number of entities that have been imported by the operation. - sourceUris: - description: The source URI from where Feature values are imported. + bleuMetricValues: + readOnly: true items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuMetricValue' type: array + description: Output only. Bleu metric values. + id: GoogleCloudAiplatformV1BleuResults + type: object + description: Results for bleu metric. + GoogleCloudAiplatformV1ImportDataOperationMetadata: + description: Runtime operation information for DatasetService.ImportData. + type: object + properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore import Feature values. - GoogleCloudAiplatformV1TrainingConfig: + description: The common part of the operation metadata. + id: GoogleCloudAiplatformV1ImportDataOperationMetadata + GoogleCloudAiplatformV1ExplanationMetadataOverride: + id: GoogleCloudAiplatformV1ExplanationMetadataOverride + type: object properties: - timeoutTrainingMilliHours: - type: string + inputs: + type: object description: >- - The timeout hours for the CMLE training job, expressed in milli - hours i.e. 1,000 value in this field means 1 hour. - format: int64 - description: >- - CMLE training config. For every active learning labeling iteration, - system will train a machine learning model on CMLE. The trained model - will be used by data sampling algorithm to select DataItems. - id: GoogleCloudAiplatformV1TrainingConfig - type: object - GoogleCloudAiplatformV1ListFeaturestoresResponse: - description: Response message for FeaturestoreService.ListFeaturestores. + Required. Overrides the input metadata of the features. The key is + the name of the feature to be overridden. The keys specified here + must exist in the input metadata to be overridden. If a feature is + not specified here, the corresponding feature's input metadata is + not overridden. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + description: >- + The ExplanationMetadata entries that can be overridden at online + explanation time. + GoogleCloudAiplatformV1FeatureNoiseSigma: properties: - nextPageToken: + noiseSigma: description: >- - A token, which can be sent as ListFeaturestoresRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - type: string - featurestores: - description: The Featurestores matching the request. + Noise sigma per feature. No noise is added to features that are not + set. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' - type: object - id: GoogleCloudAiplatformV1ListFeaturestoresResponse - GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature description: >- - Feature embedding vector for sparse index. An array of numbers whose - values are located in the specified dimensions. + Noise sigma by features. Noise sigma represents the standard deviation + of the gaussian kernel that will be used to add noise to interpolated + inputs prior to computing gradients. type: object - properties: - values: - type: array - description: Required. The list of embedding values of the sparse vector. - items: - type: number - format: float - dimensions: - items: - format: int64 - type: string - description: >- - Required. The list of indexes for the embedding values of the sparse - vector. - type: array - id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding - GoogleCloudAiplatformV1SchemaTablesDatasetMetadata: - properties: - inputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadata + id: GoogleCloudAiplatformV1FeatureNoiseSigma + GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: type: object - description: The metadata of Datasets that contain tables data. - GoogleCloudAiplatformV1UndeployIndexOperationMetadata: + description: Details of operations that batch reads Feature values. + id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata properties: genericMetadata: - description: The operation generic information. + description: Operation metadata for Featurestore batch read Features values. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1NearestNeighborQuery: + description: A query to find a number of similar entities. + id: GoogleCloudAiplatformV1NearestNeighborQuery type: object - description: Runtime operation information for IndexEndpointService.UndeployIndex. - id: GoogleCloudAiplatformV1UndeployIndexOperationMetadata - GoogleCloudAiplatformV1SchemaImageDatasetMetadata: - type: object - description: The metadata of Datasets that contain Image DataItems. - id: GoogleCloudAiplatformV1SchemaImageDatasetMetadata properties: - dataItemSchemaUri: + embedding: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryEmbedding + description: Optional. The embedding vector that be used for similar search. + neighborCount: + format: int32 + type: integer description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Image DataItems that belong to this Dataset. - type: string - gcsBucket: + Optional. The number of similar entities to be retrieved from + feature view for each query. + parameters: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryParameters + description: Optional. Parameters that can be set to tune query on the fly. + perCrowdingAttributeNeighborCount: + type: integer + format: int32 description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. + Optional. Crowding is a constraint on a neighbor list produced by + nearest neighbor search requiring that no more than + sper_crowding_attribute_neighbor_count of the k neighbors returned + have the same value of crowding_attribute. It's used for improving + result diversity. + stringFilters: + description: Optional. The list of string filters. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryStringFilter + type: array + entityId: type: string - GoogleCloudAiplatformV1PurgeExecutionsRequest: - description: Request message for MetadataService.PurgeExecutions. + description: >- + Optional. The entity id whose similar entities should be searched + for. If embedding is set, search will use embedding instead of + entity_id. + numericFilters: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter + description: Optional. The list of numeric filters. + GoogleCloudAiplatformV1TensorboardRun: properties: - force: - type: boolean + createTime: + format: google-datetime + description: Output only. Timestamp when this TensorboardRun was created. + type: string + readOnly: true + updateTime: + format: google-datetime + type: string + description: Output only. Timestamp when this TensorboardRun was last updated. + readOnly: true + description: + description: Description of this TensorboardRun. + type: string + labels: + additionalProperties: + type: string description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Execution names - that would be deleted. - filter: + The labels with user-defined metadata to organize your + TensorboardRuns. This field will be used to filter and visualize + Runs in the Tensorboard UI. For example, a Vertex AI training job + can set a label aiplatform.googleapis.com/training_job_id=xxxxx to + all the runs created within that job. An end user can set a label + experiment_id=xxxxx for all the runs produced in a Jupyter notebook. + These runs can be grouped by a label value and visualized together + in the Tensorboard UI. Label keys and values can be no longer than + 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. No more than 64 user labels can be + associated with one TensorboardRun (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + type: object + name: description: >- - Required. A required filter matching the Executions to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + Output only. Name of the TensorboardRun. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` type: string - id: GoogleCloudAiplatformV1PurgeExecutionsRequest - type: object - GoogleApiHttpBody: - type: object - properties: - extensions: + readOnly: true + etag: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - type: array - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - data: - format: byte + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. type: string - description: The HTTP request/response body as raw binary. - contentType: + displayName: type: string description: >- - The HTTP Content-Type header value specifying the content type of - the body. - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - id: GoogleApiHttpBody - GoogleCloudAiplatformV1DeleteOperationMetadata: - type: object - description: Details of operations that perform deletes of any entities. - id: GoogleCloudAiplatformV1DeleteOperationMetadata - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams: + Required. User provided name of this TensorboardRun. This value must + be unique among all TensorboardRuns belonging to the same parent + TensorboardExperiment. type: object - description: Prediction model parameters for Video Classification. + id: GoogleCloudAiplatformV1TensorboardRun + description: >- + TensorboardRun maps to a specific execution of a training job with a + given set of hyperparameter values, model definition, dataset, etc + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig: id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig properties: - segmentClassification: - type: boolean - description: >- - Set to true to request segment-level classification. Vertex AI - returns labels and their confidence scores for the entire time - segment of the video that user specified in the input instance. - Default value is true - shotClassification: - type: boolean - description: >- - Set to true to request shot-level classification. Vertex AI - determines the boundaries for each camera shot in the entire time - segment of the video that user specified in the input instance. - Vertex AI then returns labels and their confidence scores for each - detected shot, along with the start and end time of the shot. - WARNING: Model evaluation is not done for this classification type, - the quality of it depends on the training data, but there are no - metrics provided to describe that quality. Default value is false - oneSecIntervalClassification: - type: boolean + attributionScoreSkewThresholds: description: >- - Set to true to request classification for a video at one-second - intervals. Vertex AI returns labels and their confidence scores for - each second of the entire time segment of the video that user - specified in the input WARNING: Model evaluation is not done for - this classification type, the quality of it depends on the training - data, but there are no metrics provided to describe that quality. - Default value is false - maxPredictions: - type: integer + Key is the feature name and value is the threshold. The threshold + here is against attribution score distance between the training and + prediction feature. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + skewThresholds: description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. If this number is very high, the Model may - return fewer predictions. Default value is 10,000. - format: int32 - confidenceThreshold: - type: number - format: float + Key is the feature name and value is the threshold. If a feature + needs to be monitored for skew, a value threshold must be configured + for that feature. The threshold here is against feature distribution + distance between the training and prediction feature. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + type: object + defaultSkewThreshold: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - GoogleCloudAiplatformV1MachineSpec: - id: GoogleCloudAiplatformV1MachineSpec + Skew anomaly detection threshold used by all features. When the + per-feature thresholds are not set, this field can be used to + specify a threshold for all features. + description: >- + The config for Training & Prediction data skew detection. It specifies + the training dataset sources and the skew detection parameters. + type: object + GoogleCloudAiplatformV1PurgeContextsResponse: type: object - description: Specification of a single machine. properties: - acceleratorCount: - description: The number of accelerators to attach to the machine. - format: int32 - type: integer - 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. - type: string - reservationAffinity: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ReservationAffinity' + purgeSample: + type: array + items: + type: string description: >- - Optional. Immutable. Configuration controlling how this resource - pool consumes reservation. - tpuTopology: + A sample of the Context names that will be deleted. Only populated + if `force` is set to false. The maximum number of samples is 100 (it + is possible to return fewer). + purgeCount: + format: int64 description: >- - Immutable. The topology of the TPUs. Corresponds to the TPU - topologies available from GKE. (Example: tpu_topology: "2x2x1"). + The number of Contexts that this request deleted (or, if `force` is + false, the number of Contexts that will be deleted). This can be an + estimate. type: string - acceleratorType: - enumDescriptions: - - Unspecified accelerator type, which means no accelerator. - - >- - Deprecated: Nvidia Tesla K80 GPU has reached end of support, see - https://cloud.google.com/compute/docs/eol/k80-eol. - - Nvidia Tesla P100 GPU. - - Nvidia Tesla V100 GPU. - - Nvidia Tesla P4 GPU. - - Nvidia Tesla T4 GPU. - - Nvidia Tesla A100 GPU. - - Nvidia A100 80GB GPU. - - Nvidia L4 GPU. - - Nvidia H100 80Gb GPU. - - TPU v2. - - TPU v3. - - TPU v4. - - TPU v5. + description: Response message for MetadataService.PurgeContexts. + id: GoogleCloudAiplatformV1PurgeContextsResponse + GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: + description: Runtime operation information for DatasetService.CreateDatasetVersion. + type: object + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata + GoogleCloudAiplatformV1ListDatasetsResponse: + description: Response message for DatasetService.ListDatasets. + id: GoogleCloudAiplatformV1ListDatasetsResponse + type: object + properties: + nextPageToken: + description: The standard List next-page token. type: string - description: >- - Immutable. The type of accelerator(s) that may be attached to the - machine as per accelerator_count. - enum: - - ACCELERATOR_TYPE_UNSPECIFIED - - NVIDIA_TESLA_K80 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_V100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_L4 - - NVIDIA_H100_80GB - - TPU_V2 - - TPU_V3 - - TPU_V4_POD - - TPU_V5_LITEPOD - enumDeprecated: - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult + datasets: + type: array + description: A list of Datasets that matches the specified filter in the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + GoogleCloudAiplatformV1QuestionAnsweringQualitySpec: + id: GoogleCloudAiplatformV1QuestionAnsweringQualitySpec + type: object properties: - sentiment: - description: >- - The integer sentiment labels between 0 (inclusive) and sentimentMax - label (inclusive), while 0 maps to the least positive sentiment and - sentimentMax maps to the most positive one. The higher the score is, - the more positive the sentiment in the text snippet is. Note: - sentimentMax is an integer value between 1 (inclusive) and 10 - (inclusive). + version: format: int32 type: integer + description: Optional. Which version to use for evaluation. + useReference: + type: boolean + description: >- + Optional. Whether to use instance.reference to compute question + answering quality. + description: Spec for question answering quality score metric. + GoogleCloudAiplatformV1QuestionAnsweringQualityInput: + properties: + instance: + description: Required. Question answering quality instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInstance + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualitySpec + description: Required. Spec for question answering quality score metric. + description: Input for question answering quality metric. + id: GoogleCloudAiplatformV1QuestionAnsweringQualityInput type: object - description: Prediction output format for Text Sentiment - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation: - type: object - description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Convert the category name to a dictionary lookup index and generate an - embedding for each index. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation properties: columnName: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation - GoogleCloudAiplatformV1FunctionCallingConfig: + description: >- + Treats the column as text array and performs following transformation + functions. * Concatenate all text values in the array into a single text + value using a space (" ") as a delimiter, and then treat the result as a + single text value. Apply the transformations for Text columns. * Empty + arrays treated as an empty text. + type: object + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource: properties: - allowedFunctionNames: + uri: + type: string description: >- - Optional. Function names to call. Only set when the Mode is ANY. - Function names should match [FunctionDeclaration.name]. With mode - set to ANY, model will predict a function call from the set of - function names provided. - type: array - items: - type: string - mode: + The URI of a BigQuery table. e.g. + bq://projectId.bqDatasetId.bqTableId + type: object + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame: + properties: + timeOffset: + format: google-duration type: string - description: Optional. Function calling mode. - enumDescriptions: - - Unspecified function calling mode. This value should not be used. - - >- - Default model behavior, model decides to predict either function - calls or natural language response. - - >- - Model is constrained to always predicting function calls only. If - "allowed_function_names" are set, the predicted function calls - will be limited to any one of "allowed_function_names", else the - predicted function calls will be any one of the provided - "function_declarations". - - >- - Model will not predict any function calls. Model behavior is same - as when not passing any function declarations. - enum: - - MODE_UNSPECIFIED - - AUTO - - ANY - - NONE - description: Function calling config. + description: >- + A time (frame) of a video in which the object has been detected. + Expressed as a number of seconds as measured from the start of the + video, with fractions up to a microsecond precision, and with "s" + appended at the end. + yMax: + description: The bottommost coordinate of the bounding box. + type: number + format: float + xMax: + type: number + format: float + description: The rightmost coordinate of the bounding box. + xMin: + description: The leftmost coordinate of the bounding box. + type: number + format: float + yMin: + format: float + type: number + description: The topmost coordinate of the bounding box. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame type: object - id: GoogleCloudAiplatformV1FunctionCallingConfig - GoogleCloudAiplatformV1NearestNeighbors: - description: Nearest neighbors for one query. + description: >- + The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box, + i.e. the rectangle over the video frame pinpointing the found + AnnotationSpec. The coordinates are relative to the frame size, and the + point 0,0 is in the top left of the frame. + GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata: type: object properties: - neighbors: - description: All its neighbors. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborsNeighbor - type: array - id: GoogleCloudAiplatformV1NearestNeighbors + genericMetadata: + description: Operation metadata for Featurestore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Details of operations that perform update Featurestore. + id: GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata GoogleCloudAiplatformV1DestinationFeatureSetting: - type: object properties: featureId: type: string @@ -22046,2480 +22451,2032 @@ components: Specify the field name in the export destination. If not specified, Feature ID is used. id: GoogleCloudAiplatformV1DestinationFeatureSetting - GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec: - description: >- - Selects Features of an EntityType to read values of and specifies read - settings. + type: object + GoogleCloudAiplatformV1BatchMigrateResourcesResponse: properties: - entityTypeId: - description: >- - Required. ID of the EntityType to select Features. The EntityType id - is the entity_type_id specified during EntityType creation. - type: string - settings: + migrateResourceResponses: type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting - description: Per-Feature settings for the batch read. - featureSelector: - description: >- - Required. Selectors choosing which Feature values to read from the - EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse + description: Successfully migrated resources. + description: Response message for MigrationService.BatchMigrateResources. type: object - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec - GoogleCloudAiplatformV1PurgeArtifactsResponse: - description: Response message for MetadataService.PurgeArtifacts. - id: GoogleCloudAiplatformV1PurgeArtifactsResponse + id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse + GoogleCloudAiplatformV1ListTrialsResponse: + id: GoogleCloudAiplatformV1ListTrialsResponse properties: - purgeSample: - description: >- - A sample of the Artifact names that will be deleted. Only populated - if `force` is set to false. The maximum number of samples is 100 (it - is possible to return fewer). + trials: items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' type: array - purgeCount: + description: The Trials associated with the Study. + nextPageToken: type: string description: >- - The number of Artifacts that this request deleted (or, if `force` is - false, the number of Artifacts that will be deleted). This can be an - estimate. - format: int64 - type: object - GoogleCloudAiplatformV1QuestionAnsweringQualityInput: - id: GoogleCloudAiplatformV1QuestionAnsweringQualityInput - properties: - metricSpec: - description: Required. Spec for question answering quality score metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualitySpec - instance: - description: Required. Question answering quality instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInstance - description: Input for question answering quality metric. + Pass this token as the `page_token` field of the request for a + subsequent call. If this field is omitted, there are no subsequent + pages. type: object - GoogleCloudAiplatformV1VertexAISearch: + description: Response message for VizierService.ListTrials. + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance: + description: Spec for question answering helpfulness instance. + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance type: object - description: >- - Retrieve from Vertex AI Search datastore for grounding. See - https://cloud.google.com/products/agent-builder properties: - datastore: - description: >- - Required. Fully-qualified Vertex AI Search data store resource ID. - Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + reference: + description: Optional. Ground truth used to compare against the prediction. type: string - id: GoogleCloudAiplatformV1VertexAISearch - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification: - type: object - properties: - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification - description: >- - A TrainingJob that trains and uploads an AutoML Text Classification - Model. - GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData: - properties: - values: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueList' - description: >- - Feature values list if values, successive in time, are requested. If - the requested number of values is greater than the number of - existing Feature values, nonexistent values are omitted instead of - being returned as empty. - value: - description: Feature value if a single value is requested. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: >- - Container to hold value(s), successive in time, for one Feature from the - request. - type: object - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData - GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata: - description: Metadata of the prediction output to be explained. - properties: - displayNameMappingKey: - description: >- - Specify a field name in the prediction to look for the display name. - Use this if the prediction contains the display names for the - outputs. The display names in the prediction must have the same - shape of the outputs, so that it can be located by - Attribution.output_index for a specific output. + prediction: type: string - outputTensorName: + description: Required. Output of the evaluated model. + context: + description: Optional. Text provided as context to answer the question. + type: string + instruction: type: string description: >- - Name of the output tensor. Required and is only applicable to Vertex - AI provided images for Tensorflow. - indexDisplayNameMapping: - description: >- - Static mapping between the index and display name. Use this if the - outputs are a deterministic n-dimensional array, e.g. a list of - scores of all the classes in a pre-defined order for a - multi-classification Model. It's not feasible if the outputs are - non-deterministic, e.g. the Model produces top-k classes or sort the - outputs by their values. The shape of the value must be an - n-dimensional array of strings. The number of dimensions must match - that of the outputs to be explained. The - Attribution.output_display_name is populated by locating in the - mapping with Attribution.output_index. - type: any + Required. The question asked and other instruction in the inference + prompt. + GoogleCloudAiplatformV1CoherenceInstance: + id: GoogleCloudAiplatformV1CoherenceInstance + description: Spec for coherence instance. type: object - id: GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata - GoogleCloudAiplatformV1ListOptimalTrialsResponse: - id: GoogleCloudAiplatformV1ListOptimalTrialsResponse - description: Response message for VizierService.ListOptimalTrials. + properties: + prediction: + description: Required. Output of the evaluated model. + type: string + GoogleCloudAiplatformV1ListNasJobsResponse: + id: GoogleCloudAiplatformV1ListNasJobsResponse + description: Response message for JobService.ListNasJobs type: object properties: - optimalTrials: + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListNasJobsRequest.page_token to obtain that page. + nasJobs: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' description: >- - The pareto-optimal Trials for multiple objective Study or the - optimal trial for single objective Study. The definition of - pareto-optimal can be checked in wiki page. - https://en.wikipedia.org/wiki/Pareto_efficiency + List of NasJobs in the requested page. NasJob.nas_job_output of the + jobs will not be returned. type: array - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs + GoogleCloudAiplatformV1Retrieval: type: object + id: GoogleCloudAiplatformV1Retrieval + description: >- + Defines a retrieval tool that model can call to access external + knowledge. properties: - multiLabel: + vertexRagStore: + description: >- + Set to use data source powered by Vertex RAG store. User data is + uploaded via the VertexRagDataService. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexRagStore' + vertexAiSearch: + description: Set to use data source powered by Vertex AI Search. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' + disableAttribution: type: boolean - GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig: - description: >- - Config for migrating Model in automl.googleapis.com to Vertex AI's - Model. + deprecated: true + description: Optional. Deprecated. This option is no longer supported. + GoogleCloudAiplatformV1DeleteFeatureValuesRequest: + description: Request message for FeaturestoreService.DeleteFeatureValues. type: object properties: - model: - type: string - description: >- - Required. Full resource name of automl Model. Format: - `projects/{project}/locations/{location}/models/{model}`. - modelDisplayName: + selectEntity: + description: Select feature values to be deleted by specifying entities. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + selectTimeRangeAndFeature: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature description: >- - Optional. Display name of the model in Vertex AI. System will pick a - display name if unspecified. - type: string - id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig - GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus: + Select feature values to be deleted by specifying time range and + features. + id: GoogleCloudAiplatformV1DeleteFeatureValuesRequest + GoogleCloudAiplatformV1SummarizationQualityResult: + description: Spec for summarization quality result. type: object - description: A single record of the task status. properties: - error: + score: + type: number + format: float readOnly: true - description: >- - Output only. The error that occurred during the state. May be set - when the state is any of the non-final state - (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is - FAILED, the error here is final and not going to be retried. If the - state is a non-final state, the error indicates a system-error being - retried. - $ref: '#/components/schemas/GoogleRpcStatus' - state: + description: Output only. Summarization Quality score. + confidence: + type: number readOnly: true - enumDescriptions: - - Unspecified. - - Specifies pending state for the task. - - Specifies task is being executed. - - Specifies task completed successfully. - - Specifies Task cancel is in pending state. - - Specifies task is being cancelled. - - Specifies task was cancelled. - - Specifies task failed. - - Specifies task was skipped due to cache hit. - - >- - Specifies that the task was not triggered because the task's - trigger policy is not satisfied. The trigger policy is specified - in the `condition` field of PipelineJob.pipeline_spec. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - CANCEL_PENDING - - CANCELLING - - CANCELLED - - FAILED - - SKIPPED - - NOT_TRIGGERED + format: float + description: Output only. Confidence for summarization quality score. + explanation: + description: Output only. Explanation for summarization quality score. type: string - description: Output only. The state of the task. - updateTime: readOnly: true - type: string - format: google-datetime - description: Output only. Update time of this status. - id: GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig: + id: GoogleCloudAiplatformV1SummarizationQualityResult + GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig: properties: - overrideExistingTable: - type: boolean - description: >- - If true and an export destination is specified, then the contents of - the destination are overwritten. Otherwise, if the export - destination already exists, then the export operation fails. - destinationBigqueryUri: + leafNodeEmbeddingCount: + format: int64 description: >- - URI of desired destination BigQuery table. Expected format: - `bq://{project_id}:{dataset_id}:{table}` If not specified, then - results are exported to the following auto-created BigQuery table: - `{project_id}:export_evaluated_examples_{model_name}_{yyyy_MM_dd'T'HH_mm_ss_SSS'Z'}.evaluated_examples` - type: string - type: object - description: Configuration for exporting test set predictions to a BigQuery table. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - GoogleCloudAiplatformV1BleuInstance: - description: Spec for bleu instance. - id: GoogleCloudAiplatformV1BleuInstance - type: object - properties: - prediction: - description: Required. Output of the evaluated model. - type: string - reference: - type: string - description: Required. Ground truth used to compare against the prediction. - GoogleCloudAiplatformV1RemoveDatapointsRequest: - description: Request message for IndexService.RemoveDatapoints - type: object - properties: - datapointIds: - description: A list of datapoint ids to be deleted. - items: - type: string - type: array - id: GoogleCloudAiplatformV1RemoveDatapointsRequest - GoogleCloudAiplatformV1RougeInput: - id: GoogleCloudAiplatformV1RougeInput - description: Input for rouge metric. - properties: - instances: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInstance' - type: array - description: Required. Repeated rouge instances. - metricSpec: - description: Required. Spec for rouge score metric. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeSpec' - type: object - GoogleCloudAiplatformV1LargeModelReference: - properties: - name: + Optional. Number of embeddings on each leaf node. The default value + is 1000 if not set. type: string - description: >- - Required. The unique name of the large Foundation or pre-built - model. Like "chat-bison", "text-bison". Or model name with version - ID, like "chat-bison@001", "text-bison@005", etc. - description: Contains information about the Large Model. - id: GoogleCloudAiplatformV1LargeModelReference + description: Configuration options for the tree-AH algorithm. + id: GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig type: object - GoogleCloudAiplatformV1NfsMount: - description: Represents a mount configuration for Network File System (NFS) to mount. + GoogleCloudAiplatformV1Value: + id: GoogleCloudAiplatformV1Value properties: - path: - type: string - description: >- - Required. Source path exported from NFS server. Has to start with - '/', and combined with the ip address, it indicates the source mount - path in the form of `server:path` - server: - description: Required. IP address of the NFS server. - type: string - mountPoint: - description: >- - Required. Destination mount path. The NFS will be mounted for the - user under /mnt/nfs/ + intValue: type: string - type: object - id: GoogleCloudAiplatformV1NfsMount - GoogleCloudAiplatformV1GoogleSearchRetrieval: - id: GoogleCloudAiplatformV1GoogleSearchRetrieval - description: Tool to retrieve public web data for grounding, powered by Google. - type: object - properties: {} - GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse: - properties: - blobs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' - description: Blob messages containing blob bytes. - type: array - id: GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse - description: Response message for TensorboardService.ReadTensorboardBlobData. - type: object - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata: - id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata - properties: - dataBytesCount: - description: The ingested data size in bytes. format: int64 + description: An integer value. + doubleValue: + description: A double value. + type: number + format: double + stringValue: type: string - contentValidationStats: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats - description: >- - The validation stats of the content (per file) to be inserted or - updated on the Matching Engine Index resource. Populated if - contentsDeltaUri is provided as part of Index.metadata. Please note - that, currently for those files that are broken or has unsupported - file format, we will not have the stats for those files. - type: array + description: A string value. type: object - description: Runtime operation metadata with regard to Matching Engine Index. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics: - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics + description: Value is the value of the field. + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain: + description: >- + Domain details of the input feature value. Provides numeric information + about the feature, such as its range (min, max). If the feature has been + pre-processed, for example with z-scoring, then it provides information + about how to recover the original feature. For example, if the input + feature is an image and it has been pre-processed to obtain 0-mean and + stddev = 1 values, then original_mean, and original_stddev refer to the + mean and stddev of the original feature (e.g. image tensor) from which + input feature (with mean = 0 and stddev = 1) was obtained. type: object properties: - meanTrackingAveragePrecision: - description: The mean average precision over all confidence thresholds. + minValue: format: float type: number - meanMismatchRate: + description: The minimum permissible value for this feature. + originalStddev: format: float - description: The mean mismatch rate over all confidence thresholds. type: number - iouThreshold: description: >- - The intersection-over-union threshold value between bounding boxes - across frames used to compute this metric entry. - format: float - type: number - confidenceMetrics: + If this input feature has been normalized to a standard deviation of + 1.0, the original_stddev specifies the standard deviation of the + domain prior to normalization. + originalMean: description: >- - Metrics for each label-match `confidenceThreshold` from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics - meanBoundingBoxIou: - format: float - description: The mean bounding box iou over all confidence thresholds. + If this input feature has been normalized to a mean value of 0, the + original_mean specifies the mean value of the domain prior to + normalization. type: number - description: >- - UNIMPLEMENTED. Track matching model metrics for a single track match - threshold and multiple label match confidence thresholds. - GoogleCloudAiplatformV1MutateDeployedModelRequest: - type: object - description: Request message for EndpointService.MutateDeployedModel. - id: GoogleCloudAiplatformV1MutateDeployedModelRequest - properties: - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: >- - Required. The DeployedModel to be mutated within the Endpoint. Only - the following fields can be mutated: * `min_replica_count` in either - DedicatedResources or AutomaticResources * `max_replica_count` in - either DedicatedResources or AutomaticResources * - autoscaling_metric_specs * `disable_container_logging` (v1 only) * - `enable_container_logging` (v1beta1 only) - updateMask: - format: google-fieldmask - description: >- - Required. The update mask applies to the resource. See - google.protobuf.FieldMask. - type: string - GoogleCloudAiplatformV1FeatureValueDestination: - type: object - id: GoogleCloudAiplatformV1FeatureValueDestination - properties: - tfrecordDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TFRecordDestination' - description: >- - Output in TFRecord format. Below are the mapping from Feature value - type in Featurestore to Feature value type in TFRecord: Value type - in Featurestore | Value type in TFRecord DOUBLE, DOUBLE_ARRAY | - FLOAT_LIST INT64, INT64_ARRAY | INT64_LIST STRING, STRING_ARRAY, - BYTES | BYTES_LIST true -> byte_string("true"), false -> - byte_string("false") BOOL, BOOL_ARRAY (true, false) | BYTES_LIST - bigqueryDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: >- - Output in BigQuery format. BigQueryDestination.output_uri in - FeatureValueDestination.bigquery_destination must refer to a table. - csvDestination: - description: >- - Output in CSV format. Array Feature value types are not allowed in - CSV format. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvDestination' - description: A destination location for Feature values and format. - GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView: - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView - description: Entity view with Feature values. + format: float + maxValue: + type: number + description: The maximum permissible value for this feature. + format: float + id: >- + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics: properties: - data: + confidenceMetrics: type: array - description: >- - Each piece of data holds the k requested values for one requested - Feature. If no values for the requested Feature exist, the - corresponding cell will be empty. This has the same size and is in - the same order as the features from the header - ReadFeatureValuesResponse.header. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData - entityId: - description: ID of the requested entity. - type: string - type: object - GoogleCloudAiplatformV1Scheduling: - properties: - maxWaitDuration: - format: google-duration - description: >- - Optional. This is the maximum duration that a job will wait for the - requested resources to be provisioned if the scheduling strategy is - set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait - indefinitely. The default is 24 hours. - type: string - timeout: - format: google-duration - description: The maximum job running time. The default is 7 days. - type: string - strategy: - description: Optional. This determines which type of scheduling strategy to use. - enumDeprecated: - - false - - true - - true - - false - - false - - false - type: string - enumDescriptions: - - Strategy will default to STANDARD. - - Deprecated. Regular on-demand provisioning strategy. - - Deprecated. Low cost by making potential use of spot resources. - - Standard provisioning strategy uses regular on-demand resources. - - Spot provisioning strategy uses spot resources. - - Flex Start strategy uses DWS to queue for resources. - enum: - - STRATEGY_UNSPECIFIED - - ON_DEMAND - - LOW_COST - - STANDARD - - SPOT - - FLEX_START - restartJobOnWorkerRestart: + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics description: >- - Restarts the entire CustomJob if a worker gets restarted. This - feature can be used by distributed training jobs that are not - resilient to workers leaving and joining a job. - type: boolean - disableRetries: - type: boolean + Metrics that have confidence thresholds. Precision-recall curve can + be derived from them. + confusionMatrix: description: >- - Optional. Indicates if the job should retry for internal errors - after the job starts running. If true, overrides - `Scheduling.restart_job_on_worker_restart` to false. - id: GoogleCloudAiplatformV1Scheduling + Confusion matrix of the evaluation. Only set for Models where number + of AnnotationSpecs is no more than 10. Only set for + ModelEvaluations, not for ModelEvaluationSlices. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix type: object - description: All parameters related to queuing and scheduling of custom jobs. - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec: - description: Specification for how the data should be sliced. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec - properties: - configs: - type: object - description: >- - Mapping configuration for this SliceSpec. The key is the name of the - feature. By default, the key will be prefixed by "instance" as a - dictionary prefix for Vertex Batch Predictions output format. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + description: Metrics for text extraction evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation: type: object - GoogleCloudAiplatformV1CopyModelResponse: properties: - model: - type: string - description: >- - The name of the copied Model resource. Format: - `projects/{project}/locations/{location}/models/{model}` - modelVersionId: + columnName: type: string - description: Output only. The version ID of the model that is copied. - readOnly: true - description: Response message of ModelService.CopyModel operation. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + GoogleCloudAiplatformV1CsvDestination: + description: The storage details for CSV output content. type: object - id: GoogleCloudAiplatformV1CopyModelResponse - GoogleCloudAiplatformV1PipelineJob: - id: GoogleCloudAiplatformV1PipelineJob + id: GoogleCloudAiplatformV1CsvDestination properties: - jobDetail: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobDetail' - readOnly: true - description: >- - Output only. The details of pipeline run. Not available in the list - view. - endTime: - description: Output only. Pipeline end time. + gcsDestination: + description: Required. Google Cloud Storage location. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + GoogleCloudAiplatformV1ModelDeploymentMonitoringJob: + type: object + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + properties: + logTtl: + format: google-duration type: string - readOnly: true - format: google-datetime - serviceAccount: description: >- - The service account that the pipeline workload runs as. If not - specified, the Compute Engine default service account in the project - will be used. See - https://cloud.google.com/compute/docs/access/service-accounts#default_service_account - Users starting the pipeline must have the - `iam.serviceAccounts.actAs` permission on this service account. - type: string + The TTL of BigQuery tables in user projects which stores logs. A day + is the basic unit of the TTL and we take the ceil of TTL/86400(a + day). e.g. { second: 3600} indicates ttl = 1 day. createTime: - type: string - readOnly: true - description: Output only. Pipeline creation time. + description: >- + Output only. Timestamp when this ModelDeploymentMonitoringJob was + created. format: google-datetime - state: - enum: - - PIPELINE_STATE_UNSPECIFIED - - PIPELINE_STATE_QUEUED - - PIPELINE_STATE_PENDING - - PIPELINE_STATE_RUNNING - - PIPELINE_STATE_SUCCEEDED - - PIPELINE_STATE_FAILED - - PIPELINE_STATE_CANCELLING - - PIPELINE_STATE_CANCELLED - - PIPELINE_STATE_PAUSED - description: Output only. The detailed state of the job. - enumDescriptions: - - The pipeline state is unspecified. - - >- - The pipeline has been created or resumed, and processing has not - yet begun. - - The service is preparing to run the pipeline. - - The pipeline is in progress. - - The pipeline completed successfully. - - The pipeline failed. - - >- - The pipeline is being cancelled. From this state, the pipeline may - only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED - or PIPELINE_STATE_CANCELLED. - - The pipeline has been cancelled. - - The pipeline has been stopped, and can be resumed. - type: string - readOnly: true - templateMetadata: readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTemplateMetadata' - description: >- - Output only. Pipeline template metadata. Will fill up fields if - PipelineJob.template_uri is from supported template registry. - name: - description: Output only. The resource name of the PipelineJob. type: string - readOnly: true - preflightValidations: - description: >- - Optional. Whether to do component level validations before job - creation. + statsAnomaliesBaseDirectory: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Stats anomalies base folder path. + enableMonitoringPipelineLogs: type: boolean - error: description: >- - Output only. The error that occurred during pipeline execution. Only - populated when the pipeline's state is FAILED or CANCELLED. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - runtimeConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfig' - description: Runtime config of the pipeline. - startTime: - format: google-datetime + If true, the scheduled monitoring pipeline logs are sent to Google + Cloud Logging, including pipeline status and anomalies detected. + Please note the logs incur cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging#pricing). + latestMonitoringPipelineMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata readOnly: true - description: Output only. Pipeline start time. - type: string - pipelineSpec: - additionalProperties: - description: Properties of the object. - type: any - type: object - description: The spec of the pipeline. - templateUri: - description: >- - A template uri from where the PipelineJob.pipeline_spec, if empty, - will be downloaded. Currently, only uri from Vertex Template - Registry & Gallery is supported. Reference to - https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. - type: string - network: - description: >- - The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to which - the Pipeline Job's workload should be peered. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - Private services access must already be configured for the network. - Pipeline job will apply the network configuration to the Google - Cloud resources being launched, if applied, such as Vertex AI - Training or Dataflow job. If left unspecified, the workload is not - peered with any network. - type: string - displayName: - description: >- - The display name of the Pipeline. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - type: string + description: Output only. Latest triggered monitoring pipeline metadata. labels: - additionalProperties: - type: string - type: object description: >- - The labels with user-defined metadata to organize PipelineJob. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - Note there is some reserved label key for Vertex AI Pipelines. - - `vertex-ai-pipelines-run-billing-id`, user set value will get - overrided. - reservedIpRanges: - description: >- - A list of names for the reserved ip ranges under the VPC network - that can be used for this Pipeline Job's workload. If set, we will - deploy the Pipeline Job's workload within the provided ip ranges. - Otherwise, the job will be deployed to any ip ranges under the - provided VPC network. Example: ['vertex-ai-ip-range']. - type: array - items: + The labels with user-defined metadata to organize your + ModelDeploymentMonitoringJob. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. + type: object + additionalProperties: type: string - scheduleName: - type: string - description: >- - Output only. The schedule resource name. Only returned if the - Pipeline is created by Schedule API. - readOnly: true + modelDeploymentMonitoringScheduleConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + description: Required. Schedule config for running the monitoring job. encryptionSpec: $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Customer-managed encryption key spec for a pipelineJob. If set, this - PipelineJob and all of its sub-resources will be secured by this - key. - updateTime: + Customer-managed encryption key spec for a + ModelDeploymentMonitoringJob. If set, this + ModelDeploymentMonitoringJob and all sub-resources of this + ModelDeploymentMonitoringJob will be secured by this key. + predictInstanceSchemaUri: type: string description: >- - Output only. Timestamp when this PipelineJob was most recently - updated. + YAML schema file uri describing the format of a single instance, + which are given to format this Endpoint's prediction (and + explanation). If not set, we will generate predict schema from + collected predict requests. + scheduleState: readOnly: true - format: google-datetime - type: object - description: An instance of a machine learning PipelineJob. - GoogleCloudAiplatformV1ExportDataResponse: - id: GoogleCloudAiplatformV1ExportDataResponse - properties: - dataStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' - description: >- - Only present for custom code training export use case. Records data - stats, i.e., train/validation/test item/annotation counts calculated - during the export operation. - exportedFiles: - description: >- - All of the files that are exported in this export operation. For - custom code training export, only three (training, validation and - test) Cloud Storage paths in wildcard format are populated (for - example, gs://.../training-*). - items: - type: string - type: array - description: Response message for DatasetService.ExportData. - type: object - GoogleCloudAiplatformV1PointwiseMetricSpec: - type: object - description: Spec for pointwise metric. - properties: - metricPromptTemplate: + enum: + - MONITORING_SCHEDULE_STATE_UNSPECIFIED + - PENDING + - OFFLINE + - RUNNING type: string - description: Required. Metric prompt template for pointwise metric. - id: GoogleCloudAiplatformV1PointwiseMetricSpec - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity: - type: object - properties: - unit: + enumDescriptions: + - Unspecified state. + - The pipeline is picked up and wait to run. + - The pipeline is offline and will be scheduled for next run. + - The pipeline is running. + description: >- + Output only. Schedule state when the monitoring job is in Running + state. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + analysisInstanceSchemaUri: type: string description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" - quantity: - format: int64 + YAML schema file uri describing the format of a single instance that + you want Tensorflow Data Validation (TFDV) to analyze. If this field + is empty, all the feature data types are inferred from + predict_instance_schema_uri, meaning that TFDV will use the data in + the exact format(data type) as prediction request/response. If there + are any data type differences between predict instance and TFDV + instance, this field can be used to override the schema. For models + trained with Vertex AI, this field must be set as all the fields in + predict instance formatted as string. + modelDeploymentMonitoringObjectiveConfigs: + type: array description: >- - The number of granularity_units between data points in the training - data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. - For all other values of `granularity_unit`, must be 1. - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity - description: A duration of time expressed in time granularity units. - GoogleCloudAiplatformV1PredefinedSplit: - properties: - key: + Required. The config for monitoring objectives. This is a per + DeployedModel config. Each DeployedModel needs to be configured + separately. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig + samplePredictInstance: + type: any description: >- - Required. The key is a name of one of the Dataset's data columns. - The value of the key (either the label's value or value in the - column) must be one of {`training`, `validation`, `test`}, and it - defines to which set the given piece of data is assigned. If for a - piece of data the key is not present or has an invalid value, that - piece is ignored by the pipeline. - type: string - type: object - description: >- - Assigns input data to training, validation, and test sets based on the - value of a provided key. Supported only for tabular Datasets. - id: GoogleCloudAiplatformV1PredefinedSplit - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs - properties: - modelType: - type: string + Sample Predict instance, same format as PredictRequest.instances, + this can be set as a replacement of + ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not + set, we will generate predict schema from collected predict + requests. + state: enumDescriptions: - - Should not be set. + - The job state is unspecified. - >- - A model best tailored to be used within Google Cloud, and which c - annot be exported. Default. + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) to a Jetson - device afterwards. + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a Coral device - afterwards. + The job is partially succeeded, some results may be missing due to + errors. + description: >- + Output only. The detailed state of the monitoring job. When the job + is still creating, the state will be 'PENDING'. Once the job is + successfully created, the state will be 'RUNNING'. Pause the job, + the state will be 'PAUSED'. Resume the job, the state will return to + 'RUNNING'. + readOnly: true + type: string enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_JETSON_VERSATILE_1 - - MOBILE_CORAL_VERSATILE_1 - type: object - GoogleCloudAiplatformV1UpsertDatapointsRequest: - properties: - updateMask: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + loggingSamplingStrategy: + description: Required. Sample Strategy for logging. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' + displayName: + type: string description: >- - Optional. Update mask is used to specify the fields to be - overwritten in the datapoints by the update. The fields specified in - the update_mask are relative to each IndexDatapoint inside - datapoints, not the full request. Updatable fields: * Use - `all_restricts` to update both restricts and numeric_restricts. + Required. The user-defined name of the ModelDeploymentMonitoringJob. + The name can be up to 128 characters long and can consist of any + UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. + name: + description: Output only. Resource name of a ModelDeploymentMonitoringJob. + readOnly: true + type: string + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + endpoint: + type: string + description: >- + Required. Endpoint resource name. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}` + error: + description: >- + Output only. Only populated when the job's state is + `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + nextScheduleTime: + description: >- + Output only. Timestamp when this monitoring pipeline will be + scheduled to run for the next round. + format: google-datetime + readOnly: true type: string - format: google-fieldmask - datapoints: - type: array - description: A list of datapoints to be created/updated. + modelMonitoringAlertConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfig + description: Alert config for model monitoring. + bigqueryTables: + readOnly: true items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - description: Request message for IndexService.UpsertDatapoints - id: GoogleCloudAiplatformV1UpsertDatapointsRequest - type: object - GoogleIamV1TestIamPermissionsResponse: - id: GoogleIamV1TestIamPermissionsResponse - properties: - permissions: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable type: array - items: - type: string description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. + Output only. The created bigquery tables for the job under customer + project. Customer could do their own query & analysis. There could + be 4 log tables in maximum: 1. Training data logging predict + request/response 2. Serving data logging predict request/response + updateTime: + type: string + readOnly: true + format: google-datetime + description: >- + Output only. Timestamp when this ModelDeploymentMonitoringJob was + updated most recently. + description: >- + Represents a job that runs periodically to monitor the deployed models + in an endpoint. It will analyze the logged training & prediction data to + detect any abnormal behaviors. + GoogleCloudAiplatformV1CopyModelOperationMetadata: type: object - description: Response message for `TestIamPermissions` method. - GoogleCloudAiplatformV1SummarizationQualityResult: - description: Spec for summarization quality result. + description: Details of ModelService.CopyModel operation. + id: GoogleCloudAiplatformV1CopyModelOperationMetadata + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF: + id: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF type: object - id: GoogleCloudAiplatformV1SummarizationQualityResult + description: Parameters for RRF algorithm that combines search results. properties: - explanation: - type: string - readOnly: true - description: Output only. Explanation for summarization quality score. - score: - type: number - readOnly: true + alpha: + description: >- + Required. Users can provide an alpha value to give more weight to + dense vs sparse results. For example, if the alpha is 0, we only + return sparse and if the alpha is 1, we only return dense. format: float - description: Output only. Summarization Quality score. - confidence: type: number - description: Output only. Confidence for summarization quality score. - readOnly: true - format: float - GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction: properties: - deployedIndexId: - type: string - description: The unique index id specified by user - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + description: The input parameters of this TrainingJob. type: object - id: GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata - description: >- - Runtime operation information for - IndexEndpointService.MutateDeployedIndex. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction + description: A TrainingJob that trains and uploads an AutoML Text Extraction Model. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation: description: >- Training pipeline will perform following transformation functions. * The text as is--no change to case, punctuation, spelling, tense, and so on. * Convert the category name to a dictionary lookup index and generate an embedding for each index. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation + type: object properties: columnName: type: string - type: object - GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult: - description: Spec for pairwise question answering quality result. - type: object - id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs properties: - confidence: - description: Output only. Confidence for question answering quality score. - format: float - type: number - readOnly: true - explanation: - description: Output only. Explanation for question answering quality score. + budgetMilliNodeHours: + description: >- + The training budget of creating this model, expressed in milli node + hours i.e. 1,000 value in this field means 1 node hour. The actual + metadata.costMilliNodeHours will be equal or less than this value. + If further model training ceases to provide any improvements, it + will stop without using the full budget and the + metadata.successfulStopReason will be `model-converged`. Note, + node_hour = actual_hour * number_of_nodes_involved. Or + actual_wall_clock_hours = train_budget_milli_node_hours / + (number_of_nodes_involved * 1000) For modelType + `cloud-high-accuracy-1`(default), the budget must be between 20,000 + and 2,000,000 milli node hours, inclusive. The default value is + 192,000 which represents one day in wall time (1000 milli * 24 hours + * 8 nodes). + format: int64 type: string - readOnly: true - pairwiseChoice: - enumDescriptions: - - Unspecified prediction choice. - - Baseline prediction wins - - Candidate prediction wins - - Winner cannot be determined + modelType: enum: - - PAIRWISE_CHOICE_UNSPECIFIED - - BASELINE - - CANDIDATE - - TIE - readOnly: true - description: Output only. Pairwise question answering prediction choice. + - MODEL_TYPE_UNSPECIFIED + - CLOUD_HIGH_ACCURACY_1 + - CLOUD_LOW_ACCURACY_1 + - MOBILE_TF_LOW_LATENCY_1 + enumDescriptions: + - Should not be set. + - >- + A model to be used via prediction calls to uCAIP API. Expected to + have a higher latency, but should also have a higher prediction + quality than other models. + - >- + A model to be used via prediction calls to uCAIP API. Expected to + have a lower latency but relatively lower prediction quality. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + model and used on a mobile or edge device afterwards. Expected to + have low latency, but may have lower prediction quality than other + mobile models. type: string - GoogleCloudAiplatformV1ListDataItemsResponse: - type: object - description: Response message for DatasetService.ListDataItems. - properties: - dataItems: + baseModelId: description: >- - A list of DataItems that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' - nextPageToken: + The ID of the `base` model. If it is specified, the new model will + be trained based on the `base` model. Otherwise, the new model will + be trained from scratch. The `base` model must be in the same + Project and Location as the new Model to train, and have the same + modelType. type: string - description: The standard List next-page token. - id: GoogleCloudAiplatformV1ListDataItemsResponse - GoogleCloudAiplatformV1ShieldedVmConfig: - description: >- - A set of Shielded Instance options. See [Images using supported Shielded - VM - features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). - type: object - properties: - enableSecureBoot: - description: >- - Defines whether the instance has [Secure - Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) - enabled. Secure Boot helps ensure that the system only runs - authentic software by verifying the digital signature of all boot - components, and halting the boot process if signature verification - fails. - type: boolean - id: GoogleCloudAiplatformV1ShieldedVmConfig - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection: - properties: - metadata: - description: The metadata information - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection - description: >- - A TrainingJob that trains and uploads an AutoML Image Object Detection - Model. type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics: + GoogleCloudAiplatformV1DeployModelOperationMetadata: properties: - recall: - type: number - description: Output only. Recall for the given confidence threshold. - format: float - f1Score: - format: float - type: number - description: Output only. The harmonic mean of recall and precision. - precision: - description: Output only. Precision for the given confidence threshold. - type: number - format: float - confidenceThreshold: - type: number - description: >- - Output only. The confidence threshold value used to compute the - metrics. - format: float - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics - description: Metrics for a single confidence threshold. - type: object - GoogleCloudAiplatformV1UndeployIndexResponse: - id: GoogleCloudAiplatformV1UndeployIndexResponse - type: object - description: Response message for IndexEndpointService.UndeployIndex. - properties: {} - GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1DeployModelOperationMetadata + description: Runtime operation information for EndpointService.DeployModel. type: object - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke - description: Configurations for PublisherModel GKE deployment + GoogleCloudAiplatformV1DataLabelingJob: + description: >- + DataLabelingJob is used to trigger a human labeling job on unlabeled + data from the following Dataset: properties: - gkeYamlConfigs: + datasets: type: array - description: Optional. GKE deployment configuration in yaml format. + description: >- + Required. Dataset resource names. Right now we only support labeling + from a single Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}` items: type: string - GoogleCloudAiplatformV1PurgeContextsRequest: - id: GoogleCloudAiplatformV1PurgeContextsRequest - type: object - description: Request message for MetadataService.PurgeContexts. - properties: - filter: - type: string + labelerCount: + description: Required. Number of labelers to work on each DataItem. + format: int32 + type: integer + instructionUri: description: >- - Required. A required filter matching the Contexts to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. - force: + Required. The Google Cloud Storage location of the instruction pdf. + This pdf is shared with labelers, and provides detailed description + on how to label DataItems in Datasets. + type: string + activeLearningConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Context names - that would be deleted. - type: boolean - GoogleCloudAiplatformV1NasTrial: - id: GoogleCloudAiplatformV1NasTrial - type: object - properties: - endTime: - readOnly: true + Parameters that configure the active learning pipeline. Active + learning will label the data incrementally via several iterations. + For every iteration, it will select a batch of data based on the + sampling strategy. + inputsSchemaUri: type: string description: >- - Output only. Time when the NasTrial's status changed to `SUCCEEDED` - or `INFEASIBLE`. - format: google-datetime - id: + Required. Points to a YAML file stored on Google Cloud Storage + describing the config for a specific type of DataLabelingJob. The + schema files that can be used here are found in the + https://storage.googleapis.com/google-cloud-aiplatform bucket in the + /schema/datalabelingjob/inputs/ folder. + inputs: + description: Required. Input config parameters for the DataLabelingJob. + type: any + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key spec for a DataLabelingJob. If set, + this DataLabelingJob will be secured by this key. Note: Annotations + created in the DataLabelingJob are associated with the + EncryptionSpec of the Dataset they are exported to. + annotationLabels: + type: object + description: >- + Labels to assign to annotations generated by this DataLabelingJob. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + additionalProperties: + type: string + name: type: string - description: Output only. The identifier of the NasTrial assigned by the service. + description: Output only. Resource name of the DataLabelingJob. readOnly: true - startTime: + currentSpend: readOnly: true + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + Output only. Estimated cost(in US dollars) that the DataLabelingJob + has incurred to date. + displayName: type: string - description: Output only. Time when the NasTrial was started. + description: >- + Required. The user-defined name of the DataLabelingJob. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. Display name of a DataLabelingJob. + updateTime: format: google-datetime - finalMeasurement: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - description: Output only. The final measurement containing the objective value. + description: >- + Output only. Timestamp when this DataLabelingJob was updated most + recently. + type: string readOnly: true state: + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + description: Output only. The detailed state of the job. type: string readOnly: true - enum: - - STATE_UNSPECIFIED - - REQUESTED - - ACTIVE - - STOPPING - - SUCCEEDED - - INFEASIBLE - description: Output only. The detailed state of the NasTrial. enumDescriptions: - - The NasTrial state is unspecified. + - The job state is unspecified. - >- - Indicates that a specific NasTrial has been requested, but it has - not yet been suggested by the service. - - Indicates that the NasTrial has been suggested. - - Indicates that the NasTrial should stop according to the service. - - Indicates that the NasTrial is completed successfully. + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. - >- - Indicates that the NasTrial should not be attempted again. The - service will set a NasTrial to INFEASIBLE when it's done but - missing the final_measurement. - description: Represents a uCAIP NasJob trial. - GoogleCloudAiplatformV1GroundingSupport: - description: Grounding support. - properties: - segment: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Segment' - description: Segment of the content this support belongs to. - groundingChunkIndices: - description: >- - A list of indices (into 'grounding_chunk') specifying the citations - associated with the claim. For instance [1,3,4] means that - grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the - retrieved content attributed to the claim. - type: array - items: - format: int32 - type: integer - confidenceScores: + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + labels: + type: object description: >- - Confidence score of the support references. Ranges from 0 to 1. 1 is - the most confident. This list must have the same size as the - grounding_chunk_indices. - type: array - items: - format: float - type: number - id: GoogleCloudAiplatformV1GroundingSupport - type: object - GoogleCloudAiplatformV1ModelBaseModelSource: - properties: - genieSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenieSource' - description: Information about the base model of Genie models. - modelGardenSource: - description: Source information of Model Garden models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelGardenSource' - description: >- - User input field to specify the base model source. Currently it only - supports specifing the Model Garden models and Genie models. - type: object - id: GoogleCloudAiplatformV1ModelBaseModelSource - GoogleCloudAiplatformV1SchemaVertex: - type: object - properties: - x: - description: X coordinate. - type: number - format: double - 'y': - type: number - description: Y coordinate. - format: double - description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - id: GoogleCloudAiplatformV1SchemaVertex - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource: - type: object - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource - properties: - uri: + The labels with user-defined metadata to organize your + DataLabelingJobs. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for each DataLabelingJob: * + "aiplatform.googleapis.com/schema": output only, its value is the + inputs_schema's title. + additionalProperties: + type: string + createTime: + description: Output only. Timestamp when this DataLabelingJob was created. type: string - description: >- - The URI of a BigQuery table. e.g. - bq://projectId.bqDatasetId.bqTableId - GoogleCloudAiplatformV1PurgeArtifactsMetadata: - id: GoogleCloudAiplatformV1PurgeArtifactsMetadata - properties: - genericMetadata: - description: Operation metadata for purging Artifacts. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform MetadataService.PurgeArtifacts. - type: object - GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig: - properties: - sampleRate: - type: number - description: Sample rate (0, 1] - format: double - type: object - id: GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig - description: Requests are randomly selected. - GoogleCloudAiplatformV1ListModelEvaluationsResponse: - type: object - description: Response message for ModelService.ListModelEvaluations. - id: GoogleCloudAiplatformV1ListModelEvaluationsResponse - properties: - modelEvaluations: - description: List of ModelEvaluations in the requested page. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + readOnly: true + format: google-datetime + specialistPools: type: array - nextPageToken: - type: string + description: The SpecialistPools' resource names associated with this job. + items: + type: string + error: + readOnly: true description: >- - A token to retrieve next page of results. Pass to - ListModelEvaluationsRequest.page_token to obtain that page. - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective: - properties: - type: - type: string - enumDescriptions: - - Default value, should not be set. - - >- - Raw feature values' stats to detect skew between - Training-Prediction datasets. - - >- - Raw feature values' stats to detect drift between - Serving-Prediction datasets. - - >- - Feature attribution scores to detect skew between - Training-Prediction datasets. - - >- - Feature attribution scores to detect skew between Prediction - datasets collected within different time windows. - enum: - - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED - - RAW_FEATURE_SKEW - - RAW_FEATURE_DRIFT - - FEATURE_ATTRIBUTION_SKEW - - FEATURE_ATTRIBUTION_DRIFT - topFeatureCount: - type: integer + Output only. DataLabelingJob errors. It is only populated when job's + state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' + labelingProgress: format: int32 description: >- - If set, all attribution scores between - SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time and - SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time are - fetched, and page token doesn't take effect in this case. Only used - to retrieve attribution score for the top Features which has the - highest attribution score in the latest monitoring run. - type: object - description: Stats requested for specific objective. - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective - GoogleCloudAiplatformV1PairwiseMetricSpec: - description: Spec for pairwise metric. - properties: - metricPromptTemplate: - type: string - description: Required. Metric prompt template for pairwise metric. - id: GoogleCloudAiplatformV1PairwiseMetricSpec - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation: + Output only. Current labeling job progress percentage scaled in + interval [0, 100], indicating the percentage of DataItems that has + been finished. + type: integer + readOnly: true type: object + id: GoogleCloudAiplatformV1DataLabelingJob + GoogleCloudAiplatformV1PurgeArtifactsResponse: properties: - columnName: + purgeCount: + description: >- + The number of Artifacts that this request deleted (or, if `force` is + false, the number of Artifacts that will be deleted). This can be an + estimate. + format: int64 type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup: - id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup - description: >- - Features belonging to a single feature group that will be synced to - Online Store. - properties: - featureIds: - description: Required. Identifiers of features under the feature group. + purgeSample: type: array items: type: string - featureGroupId: - description: Required. Identifier of the feature group. - type: string - type: object - GoogleCloudAiplatformV1PublisherModelResourceReference: - properties: - resourceName: - type: string - description: The resource name of the Google Cloud resource. - useCase: - description: Use case (CUJ) of the resource. - deprecated: true - type: string - uri: - description: The URI of the resource. - type: string - description: - description: Description of the resource. - type: string - deprecated: true - description: Reference to a resource. - id: GoogleCloudAiplatformV1PublisherModelResourceReference + description: >- + A sample of the Artifact names that will be deleted. Only populated + if `force` is set to false. The maximum number of samples is 100 (it + is possible to return fewer). type: object - GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams: - description: Prediction model parameters for Video Action Recognition. - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams + description: Response message for MetadataService.PurgeArtifacts. + id: GoogleCloudAiplatformV1PurgeArtifactsResponse + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset: type: object + description: Training Dataset information. + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset properties: - maxPredictions: - format: int32 - type: integer + dataset: + description: The resource name of the Dataset used to train this Model. + type: string + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' description: >- - The model only returns up to that many top, by confidence score, - predictions per frame of the video. If this number is very high, the - Model may return fewer predictions per frame. Default value is 50. - confidenceThreshold: + The BigQuery table of the unmanaged Dataset used to train this + Model. + loggingSamplingStrategy: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - type: number - format: float - GoogleCloudAiplatformV1SupervisedTuningDataStats: - description: Tuning data statistics for Supervised Tuning. + Strategy to sample data from Training Dataset. If not set, we + process the whole dataset. + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: >- + The Google Cloud Storage uri of the unmanaged Dataset used to train + this Model. + targetField: + description: >- + The target field name the model is to predict. This field will be + excluded when doing Predict and (or) Explain for the training data. + type: string + dataFormat: + description: >- + Data format of the dataset, only applicable if the input is from + Google Cloud Storage. The possible formats are: "tf-record" The + source file is a TFRecord file. "csv" The source file is a CSV file. + "jsonl" The source file is a JSONL file. + type: string + GoogleTypeInterval: + id: GoogleTypeInterval type: object - id: GoogleCloudAiplatformV1SupervisedTuningDataStats + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. properties: - totalTruncatedExampleCount: - format: int64 + endTime: type: string description: >- - The number of examples in the dataset that have been truncated by - any amount. - userInputTokenDistribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - readOnly: true - description: Output only. Dataset distributions for the user input tokens. - totalBillableCharacterCount: - description: Output only. Number of billable characters in the tuning dataset. - format: int64 - type: string - deprecated: true - readOnly: true - tuningDatasetExampleCount: - readOnly: true - description: Output only. Number of examples in the tuning dataset. - format: int64 + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + format: google-datetime + 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. type: string - totalBillableTokenCount: - description: Output only. Number of billable tokens in the tuning dataset. + format: google-datetime + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata: + properties: + evaluatedDataItemsBigqueryUri: + description: BigQuery destination uri for exported evaluated examples. type: string - readOnly: true - format: int64 - userOutputTokenDistribution: - description: Output only. Dataset distributions for the user output tokens. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - truncatedExampleIndices: + trainCostMilliNodeHours: description: >- - A partial sample of the indices (starting from 1) of the truncated - examples. - items: - type: string - format: int64 - type: array - userMessagePerExampleDistribution: - description: Output only. Dataset distributions for the messages per example. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - totalTuningCharacterCount: - type: string + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. format: int64 - readOnly: true - description: Output only. Number of tuning characters in the tuning dataset. - tuningStepCount: - description: Output only. Number of tuning steps for this Tuning Job. - readOnly: true type: string - format: int64 - userDatasetExamples: - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - type: array - description: Output only. Sample user messages in the training dataset uri. - GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig: type: object + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + description: Model metadata specific to TFT Forecasting. + GoogleCloudAiplatformV1DeployIndexResponse: + type: object + description: Response message for IndexEndpointService.DeployIndex. properties: - disableAttribution: - type: boolean - description: >- - If set, skip finding claim attributions (i.e not generate grounding - citation). - deprecated: true - sources: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry - type: array - description: The sources for the grounding checking. - description: The configuration for grounding checking. - id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig - GoogleCloudAiplatformV1GroundednessInstance: + deployedIndex: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: The DeployedIndex that had been deployed in the IndexEndpoint. + id: GoogleCloudAiplatformV1DeployIndexResponse + GoogleCloudAiplatformV1ToolCallValidSpec: + id: GoogleCloudAiplatformV1ToolCallValidSpec + properties: {} + type: object + description: Spec for tool call valid metric. + GoogleCloudAiplatformV1StudyTimeConstraint: + type: object properties: - context: + maxDuration: + description: Counts the wallclock time passed since the creation of this Study. + format: google-duration type: string - description: >- - Required. Background information provided in context used to compare - against the prediction. - prediction: + endTime: + description: Compares the wallclock time to this time. Must use UTC timezone. + format: google-datetime type: string - description: Required. Output of the evaluated model. + description: Time-based Constraint for Study + id: GoogleCloudAiplatformV1StudyTimeConstraint + GoogleCloudAiplatformV1RebootPersistentResourceRequest: type: object - id: GoogleCloudAiplatformV1GroundednessInstance - description: Spec for groundedness instance. - GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey: - description: ID that is comprised from several parts (columns). + id: GoogleCloudAiplatformV1RebootPersistentResourceRequest + properties: {} + description: Request message for PersistentResourceService.RebootPersistentResource. + GoogleCloudAiplatformV1ErrorAnalysisAnnotation: properties: - parts: - description: >- - Parts to construct Entity ID. Should match with the same ID columns - as defined in FeatureView in the same order. + attributedItems: type: array - items: - type: string - id: GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs: - properties: - disableEarlyStopping: description: >- - Use the entire training budget. This disables the early stopping - feature. When false the early stopping feature is enabled, which - means that AutoML Image Classification might stop training before - the entire training budget has been used. - type: boolean - baseModelId: - type: string + Attributed items for a given annotation, typically representing + neighbors from the training sets constrained by the query type. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem + outlierScore: + format: double description: >- - The ID of the `base` model. If it is specified, the new model will - be trained based on the `base` model. Otherwise, the new model will - be trained from scratch. The `base` model must be in the same - Project and Location as the new Model to train, and have the same - modelType. - tunableParameter: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - description: Trainer type for Vision TrainRequest. - budgetMilliNodeHours: + The outlier score of this annotated item. Usually defined as the min + of all distances from attributed items. + type: number + queryType: + enumDescriptions: + - Unspecified query type for model error analysis. + - Query similar samples across all classes in the dataset. + - Query similar samples from the same class of the input sample. + - Query dissimilar samples from the same class of the input sample. type: string - format: int64 - description: >- - The training budget of creating this model, expressed in milli node - hours i.e. 1,000 value in this field means 1 node hour. The actual - metadata.costMilliNodeHours will be equal or less than this value. - If further model training ceases to provide any improvements, it - will stop without using the full budget and the - metadata.successfulStopReason will be `model-converged`. Note, - node_hour = actual_hour * number_of_nodes_involved. For modelType - `cloud`(default), the budget must be between 8,000 and 800,000 milli - node hours, inclusive. The default value is 192,000 which represents - one day in wall time, considering 8 nodes are used. For model types - `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, - `mobile-tf-high-accuracy-1`, the training budget must be between - 1,000 and 100,000 milli node hours, inclusive. The default value is - 24,000 which represents one day in wall time on a single node that - is used. - multiLabel: - description: >- - If false, a single-label (multi-class) Model will be trained (i.e. - assuming that for each image just up to one annotation may be - applicable). If true, a multi-label Model will be trained (i.e. - assuming that for each image multiple annotations may be - applicable). - type: boolean - modelType: + description: The query type used for finding the attributed items. enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - CLOUD_1 - - MOBILE_TF_LOW_LATENCY_1 - - MOBILE_TF_VERSATILE_1 - - MOBILE_TF_HIGH_ACCURACY_1 - - EFFICIENTNET - - MAXVIT - - VIT - - COCA - type: string - enumDescriptions: - - Should not be set. - - >- - A Model best tailored to be used within Google Cloud, and which - cannot be exported. Default. - - >- - A model type best tailored to be used within Google Cloud, which - cannot be exported externally. Compared to the CLOUD model above, - it is expected to have higher prediction accuracy. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device afterwards. - Expected to have low latency, but may have lower prediction - quality than other mobile models. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device with - afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device afterwards. - Expected to have a higher latency, but should also have a higher - prediction quality than other mobile models. - - >- - EfficientNet model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - MaxViT model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - ViT model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - CoCa model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - uptrainBaseModelId: + - QUERY_TYPE_UNSPECIFIED + - ALL_SIMILAR + - SAME_CLASS_SIMILAR + - SAME_CLASS_DISSIMILAR + outlierThreshold: + format: double description: >- - The ID of `base` model for upTraining. If it is specified, the new - model will be upTrained based on the `base` model for upTraining. - Otherwise, the new model will be trained from scratch. The `base` - model for upTraining must be in the same Project and Location as the - new Model to train, and have the same modelType. - type: string + The threshold used to determine if this annotation is an outlier or + not. + type: number + description: Model error analysis for each annotation. + id: GoogleCloudAiplatformV1ErrorAnalysisAnnotation type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs - GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig: - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig + GoogleCloudAiplatformV1CompletionStats: + description: >- + Success and error statistics of processing multiple entities (for + example, DataItems or structured data rows) in batch. properties: - deployedModelId: + successfulForecastPointCount: + format: int64 + readOnly: true type: string - description: The DeployedModel ID of the objective config. - objectiveConfig: description: >- - The objective config of for the modelmonitoring job of this deployed - model. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig - description: >- - ModelDeploymentMonitoringObjectiveConfig contains the pair of - deployed_model_id to ModelMonitoringObjectiveConfig. - type: object - GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata: - id: GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata - type: object - description: The metadata of Datasets that contain Text Prompt data. - properties: - systemInstruction: + Output only. The number of the successful forecast points that are + generated by the forecasting model. This is ONLY used by the + forecasting batch prediction. + failedCount: + description: >- + Output only. The number of entities for which any error was + encountered. + format: int64 + readOnly: true type: string - description: The content of the prompt dataset system instruction. - hasPromptVariable: - description: Whether the prompt dataset has prompt variable. - type: boolean - candidateCount: + successfulCount: type: string - description: Number of candidates. + description: >- + Output only. The number of entities that had been processed + successfully. format: int64 - gcsUri: + readOnly: true + incompleteCount: + format: int64 + description: >- + Output only. In cases when enough errors are encountered a job, + pipeline, or operation may be failed as a whole. Below is the number + of entities for which the processing had not been finished (either + in successful or failed state). Set to -1 if the number is unknown + (for example, the operation failed before the total entity number + could be collected). type: string - description: The Google Cloud Storage URI that stores the prompt data. - note: - description: User-created prompt note. Note size limit is 2KB. + readOnly: true + type: object + id: GoogleCloudAiplatformV1CompletionStats + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation: + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation + properties: + columnName: type: string - topK: - format: int64 - description: >- - Top K value set when the dataset was saved. This value determines - how many candidates with highest probability from the vocab would be - selected for each decoding step. + type: object + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair: + id: >- + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + properties: + name: type: string - topP: + description: Feature short name. + value: + description: Feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + type: object + description: Feature name & value pair. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + properties: + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: Confusion matrix for the given confidence threshold. + iouScore: format: float - description: >- - Top P value set when the dataset was saved. Given topK tokens for - decoding, top candidates will be selected until the sum of their - probabilities is topP. type: number - promptType: - type: string - description: Type of the prompt dataset. - systemInstructionGcsUri: - type: string - description: >- - The Google Cloud Storage URI that stores the system instruction, - starting with gs://. - maxOutputTokens: - type: string description: >- - Value of the maximum number of tokens generated set when the dataset - was saved. - format: int64 - temperature: + The intersection-over-union score. The measure of overlap of the + annotation's category mask with ground truth category mask on the + DataItem. + precision: + type: number + description: Precision for the given confidence threshold. + format: float + recall: + description: Recall (True Positive Rate) for the given confidence threshold. + format: float + type: number + confidenceThreshold: + type: number description: >- - Temperature value used for sampling set when the dataset was saved. - This value is used to tune the degree of randomness. + Metrics are computed with an assumption that the model never returns + predictions with score lower than this value. + format: float + diceScoreCoefficient: format: float + description: DSC or the F1 score, The harmonic mean of recall and precision. type: number - stopSequences: - description: Customized stop sequences. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry + type: object + GoogleCloudAiplatformV1ToolNameMatchInstance: + id: GoogleCloudAiplatformV1ToolNameMatchInstance + type: object + description: Spec for tool name match instance. + properties: + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + prediction: + description: Required. Output of the evaluated model. + type: string + GoogleCloudAiplatformV1Context: + id: GoogleCloudAiplatformV1Context + properties: + parentContexts: + description: >- + Output only. A list of resource names of Contexts that are parents + of this Context. A Context may have at most 10 parent_contexts. items: type: string type: array - text: + readOnly: true + schemaVersion: type: string - description: The content of the prompt dataset. - groundingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig - description: Grounding checking configuration. - GoogleCloudAiplatformV1EvaluatedAnnotation: - id: GoogleCloudAiplatformV1EvaluatedAnnotation - type: object - description: >- - True positive, false positive, or false negative. EvaluatedAnnotation is - only available under ModelEvaluationSlice with slice of `annotationSpec` - dimension. - properties: - errorAnalysisAnnotations: - type: array - description: Annotations of model error analysis results. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotation - evaluatedDataItemViewId: description: >- - Output only. ID of the EvaluatedDataItemView under the same ancestor - ModelEvaluation. The EvaluatedDataItemView consists of all ground - truths and predictions on data_item_payload. - readOnly: true + The version of the schema in schema_name to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + etag: + description: >- + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. type: string - predictions: - type: array - items: - type: any + schemaTitle: description: >- - Output only. The model predicted annotations. For true positive, - there is one and only one prediction, which matches the only one - ground truth annotation in ground_truths. For false positive, there - is one and only one prediction, which doesn't match any ground truth - annotation of the corresponding data_item_view_id. For false - negative, there are zero or more predictions which are similar to - the only ground truth annotation in ground_truths but not enough for - a match. The schema of the prediction is stored in - ModelEvaluation.annotation_schema_uri - readOnly: true - type: - readOnly: true - enumDescriptions: - - Invalid value. - - >- - The EvaluatedAnnotation is a true positive. It has a prediction - created by the Model and a ground truth Annotation which the - prediction matches. - - >- - The EvaluatedAnnotation is false positive. It has a prediction - created by the Model which does not match any ground truth - annotation. - - >- - The EvaluatedAnnotation is false negative. It has a ground truth - annotation which is not matched by any of the model created - predictions. - enum: - - EVALUATED_ANNOTATION_TYPE_UNSPECIFIED - - TRUE_POSITIVE - - FALSE_POSITIVE - - FALSE_NEGATIVE - description: Output only. Type of the EvaluatedAnnotation. + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. type: string - dataItemPayload: + description: + description: Description of the Context + type: string + updateTime: + description: Output only. Timestamp when this Context was last updated. + type: string + format: google-datetime readOnly: true - type: any + name: + type: string + description: Immutable. The resource name of the Context. + labels: + additionalProperties: + type: string + type: object description: >- - Output only. The data item payload that the Model predicted this - EvaluatedAnnotation on. - explanations: + The labels with user-defined metadata to organize your Contexts. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Context (System + labels are excluded). + displayName: description: >- - Explanations of predictions. Each element of the explanations - indicates the explanation for one explanation Method. The - attributions list in the EvaluatedAnnotationExplanation.explanation - object corresponds to the predictions list. For example, the second - element in the attributions list explains the second element in the - predictions list. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotationExplanation - type: array - groundTruths: - readOnly: true - type: array - items: + User provided display name of the Context. May be up to 128 Unicode + characters. + type: string + metadata: + type: object + additionalProperties: + description: Properties of the object. type: any description: >- - Output only. The ground truth Annotations, i.e. the Annotations that - exist in the test data the Model is evaluated on. For true positive, - there is one and only one ground truth annotation, which matches the - only prediction in predictions. For false positive, there are zero - or more ground truth annotations that are similar to the only - prediction in predictions, but not enough for a match. For false - negative, there is one and only one ground truth annotation, which - doesn't match any predictions created by the model. The schema of - the ground truth is stored in ModelEvaluation.annotation_schema_uri - GoogleCloudAiplatformV1MergeVersionAliasesRequest: + Properties of the Context. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + createTime: + format: google-datetime + type: string + readOnly: true + description: Output only. Timestamp when this Context was created. + type: object + description: Instance of a general context. + GoogleCloudAiplatformV1GroundingMetadata: type: object + id: GoogleCloudAiplatformV1GroundingMetadata properties: - versionAliases: + webSearchQueries: type: array - description: >- - Required. The set of version aliases to merge. The alias should be - at most 128 characters, and match `a-z{0,126}[a-z-0-9]`. Add the `-` - prefix to an alias means removing that alias from the version. `-` - is NOT counted in the 128 characters. Example: `-golden` means - removing the `golden` alias from the version. There is NO ordering - in aliases, which means 1) The aliases returned from GetModel API - might not have the exactly same order from this MergeVersionAliases - API. 2) Adding and deleting the same alias in the request is not - recommended, and the 2 operations will be cancelled out. items: type: string - description: Request message for ModelService.MergeVersionAliases. - id: GoogleCloudAiplatformV1MergeVersionAliasesRequest - GoogleCloudAiplatformV1NotebookRuntimeTemplateRef: - type: object - properties: - notebookRuntimeTemplate: - type: string - description: Immutable. A resource name of the NotebookRuntimeTemplate. - id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef - description: Points to a NotebookRuntimeTemplateRef. - GoogleCloudAiplatformV1ListCustomJobsResponse: - id: GoogleCloudAiplatformV1ListCustomJobsResponse - type: object - properties: - customJobs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' - description: List of CustomJobs in the requested page. + description: Optional. Web search queries for the following-up web search. + searchEntryPoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SearchEntryPoint' + description: Optional. Google search entry for the following-up web searches. + groundingSupports: type: array - nextPageToken: - description: >- - A token to retrieve the next page of results. Pass to - ListCustomJobsRequest.page_token to obtain that page. - type: string - description: Response message for JobService.ListCustomJobs - GoogleCloudAiplatformV1ExplainResponse: - id: GoogleCloudAiplatformV1ExplainResponse - properties: - deployedModelId: - type: string - description: ID of the Endpoint's DeployedModel that served this explanation. - predictions: items: - type: any + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingSupport' + description: Optional. List of grounding support. + groundingChunks: type: array description: >- - The predictions that are the output of the predictions call. Same as - PredictResponse.predictions. - explanations: - description: >- - The explanations of the Model's PredictResponse.predictions. It has - the same number of elements as instances to be explained. - type: array + List of supporting references retrieved from specified grounding + source. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' - description: Response message for PredictionService.Explain. - type: object - GoogleCloudAiplatformV1DeployModelRequest: - properties: - deployedModel: - description: >- - Required. The DeployedModel to be created within the Endpoint. Note - that Endpoint.traffic_split must be updated for the DeployedModel to - start receiving traffic, either as part of this call, or via - EndpointService.UpdateEndpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - trafficSplit: - type: object - description: >- - A map from a DeployedModel's ID to the percentage of this Endpoint's - traffic that should be forwarded to that DeployedModel. If this - field is non-empty, then the Endpoint's traffic_split will be - overwritten with it. To refer to the ID of the just being deployed - Model, a "0" should be used, and the actual ID of the new - DeployedModel will be filled in its place by this method. The - traffic percentage values must add up to 100. If this field is - empty, then the Endpoint's traffic_split is not updated. - additionalProperties: - format: int32 - type: integer - id: GoogleCloudAiplatformV1DeployModelRequest - description: Request message for EndpointService.DeployModel. - type: object - GoogleCloudAiplatformV1CoherenceInput: - type: object - properties: - instance: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInstance' - description: Required. Coherence instance. - metricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceSpec' - description: Required. Spec for coherence score metric. - id: GoogleCloudAiplatformV1CoherenceInput - description: Input for coherence metric. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunk' + description: Metadata returned to client when grounding is enabled. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables: + description: A TrainingJob that trains and uploads an AutoML Tables Model. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables type: object properties: - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation - repeatedNumeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation - repeatedCategorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation - repeatedText: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation - auto: + metadata: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation - timestamp: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata + description: The metadata information. + inputs: + description: The input parameters of this TrainingJob. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation - GoogleCloudAiplatformV1SummarizationHelpfulnessInput: - description: Input for summarization helpfulness metric. - id: GoogleCloudAiplatformV1SummarizationHelpfulnessInput + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting: properties: - instance: + metadata: + description: The metadata information. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInstance - description: Required. Summarization helpfulness instance. - metricSpec: - description: Required. Spec for summarization helpfulness score metric. + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata + inputs: + description: The input parameters of this TrainingJob. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessSpec + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs type: object - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: - properties: - shouldStop: - type: boolean - description: True if the Trial should stop. - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + GoogleCloudAiplatformV1Blob: type: object - description: Response message for VizierService.CheckTrialEarlyStoppingState. - GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse: - properties: - timeSeriesData: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' - description: The returned time series data. - type: array description: >- - Response message for - TensorboardService.BatchReadTensorboardTimeSeriesData. - id: GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse - type: object - GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance: - description: Prediction input format for Text Classification. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance + Content blob. It's preferred to send as text directly rather than raw + bytes. + id: GoogleCloudAiplatformV1Blob properties: - mimeType: + data: type: string - description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain - content: + description: Required. Raw bytes. + format: byte + mimeType: type: string - description: The text snippet to make the predictions on. - type: object - GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse: - properties: {} - id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse - description: Response message for TensorboardService.WriteTensorboardExperimentData. - type: object - GoogleCloudAiplatformV1CreateIndexOperationMetadata: - description: Runtime operation information for IndexService.CreateIndex. - properties: - nearestNeighborSearchOperationMetadata: - description: >- - The operation metadata with regard to Matching Engine Index - operation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - type: object - id: GoogleCloudAiplatformV1CreateIndexOperationMetadata - GoogleCloudAiplatformV1PairwiseSummarizationQualityInput: - properties: - metricSpec: - description: Required. Spec for pairwise summarization quality score metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec - instance: - description: Required. Pairwise summarization quality instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance + description: Required. The IANA standard MIME type of the source data. + GoogleCloudAiplatformV1NearestNeighborQueryParameters: type: object - description: Input for pairwise summarization quality metric. - id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInput - GoogleCloudAiplatformV1ModelSourceInfo: - description: Detail description of the source information of the model. - id: GoogleCloudAiplatformV1ModelSourceInfo + id: GoogleCloudAiplatformV1NearestNeighborQueryParameters properties: - sourceType: - enumDescriptions: - - Should not be used. - - The Model is uploaded by automl training pipeline. - - The Model is uploaded by user or custom training pipeline. - - The Model is registered and sync'ed from BigQuery ML. - - The Model is saved or tuned from Model Garden. - - The Model is saved or tuned from Genie. - - The Model is uploaded by text embedding finetuning pipeline. - - The Model is saved or tuned from Marketplace. - enum: - - MODEL_SOURCE_TYPE_UNSPECIFIED - - AUTOML - - CUSTOM - - BQML - - MODEL_GARDEN - - GENIE - - CUSTOM_TEXT_EMBEDDING - - MARKETPLACE - type: string - description: Type of the model source. - copy: - type: boolean + approximateNeighborCandidates: + type: integer description: >- - If this Model is copy of another Model. If true then source_type - pertains to the original. - type: object - GoogleCloudAiplatformV1ToolNameMatchSpec: - description: Spec for tool name match metric. - type: object - properties: {} - id: GoogleCloudAiplatformV1ToolNameMatchSpec - GoogleCloudAiplatformV1UndeployIndexRequest: - properties: - deployedIndexId: + Optional. The number of neighbors to find via approximate search + before exact reordering is performed; if set, this value must be > + neighbor_count. + format: int32 + leafNodesSearchFraction: + format: double description: >- - Required. The ID of the DeployedIndex to be undeployed from the - IndexEndpoint. - type: string - description: Request message for IndexEndpointService.UndeployIndex. + Optional. The fraction of the number of leaves to search, set at + query time allows user to tune search performance. This value + increase result in both search accuracy and latency increase. The + value should be between 0.0 and 1.0. + type: number + description: >- + Parameters that can be overrided in each query to tune query latency and + recall. + GoogleCloudAiplatformV1NetworkSpec: type: object - id: GoogleCloudAiplatformV1UndeployIndexRequest - GoogleCloudAiplatformV1SupervisedTuningSpec: - description: Tuning Spec for Supervised Tuning for first party models. + id: GoogleCloudAiplatformV1NetworkSpec + description: Network spec. properties: - validationDatasetUri: - description: >- - Optional. Cloud Storage path to file containing validation dataset - for tuning. The dataset must be formatted as a JSONL file. + enableInternetAccess: + type: boolean + description: Whether to enable public internet access. Default false. + subnetwork: type: string - hyperParameters: - description: Optional. Hyperparameters for SFT. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters - trainingDatasetUri: description: >- - Required. Cloud Storage path to file containing training dataset for - tuning. The dataset must be formatted as a JSONL file. + The name of the subnet that this instance is in. Format: + `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` + network: + description: >- + The full name of the Google Compute Engine + [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) type: string - type: object - id: GoogleCloudAiplatformV1SupervisedTuningSpec - GoogleCloudAiplatformV1GcsSource: - type: object - id: GoogleCloudAiplatformV1GcsSource - description: The Google Cloud Storage location for the input content. + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation: properties: - uris: - type: array + polylineAnnotation: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + description: Polyline annotation. + polygonAnnotation: + description: Polygon annotation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation + maskAnnotation: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation description: >- - Required. Google Cloud Storage URI(-s) to the input file(s). May - contain wildcards. For more information on wildcards, see - https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. - items: - type: string - GoogleCloudAiplatformV1ReadIndexDatapointsResponse: - id: GoogleCloudAiplatformV1ReadIndexDatapointsResponse - properties: - datapoints: - description: The result list of datapoints. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - type: array - description: The response message for MatchService.ReadIndexDatapoints. + Mask based segmentation annotation. Only one mask annotation can + exist for one image. + description: Annotation details specific to image segmentation. + id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation type: object - GoogleCloudAiplatformV1Context: + GoogleCloudAiplatformV1Index: type: object - description: Instance of a general context. properties: - description: - type: string - description: Description of the Context - name: - type: string - description: Immutable. The resource name of the Context. - etag: - description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - type: string - displayName: + metadataSchemaUri: description: >- - User provided display name of the Context. May be up to 128 Unicode - characters. - type: string - schemaTitle: + Immutable. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Index, that is specific + to it. Unset if the Index does not have any additional information. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + Note: The URI given on output will be immutable and probably + different, including the URI scheme, than the one given on input. + The output URI will point to a location where the user only has a + read access. type: string + indexStats: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' + description: Output only. Stats of the index resource. + indexUpdateMethod: + enum: + - INDEX_UPDATE_METHOD_UNSPECIFIED + - BATCH_UPDATE + - STREAM_UPDATE description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - schemaVersion: + Immutable. The update method to use with this Index. If not set, + BATCH_UPDATE will be used by default. + enumDescriptions: + - Should not be used. + - >- + BatchUpdate: user can call UpdateIndex with files on Cloud Storage + of Datapoints to update. + - >- + StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to + update the Index and the updates will be applied in corresponding + DeployedIndexes in nearly real-time. type: string - description: >- - The version of the schema in schema_name to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. labels: - description: >- - The labels with user-defined metadata to organize your Contexts. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Context (System - labels are excluded). additionalProperties: type: string type: object - parentContexts: - items: - type: string description: >- - Output only. A list of resource names of Contexts that are parents - of this Context. A Context may have at most 10 parent_contexts. - readOnly: true - type: array - updateTime: - format: google-datetime + The labels with user-defined metadata to organize your Indexes. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + createTime: + description: Output only. Timestamp when this Index was created. readOnly: true - description: Output only. Timestamp when this Context was last updated. type: string - createTime: - description: Output only. Timestamp when this Context was created. format: google-datetime + satisfiesPzi: readOnly: true - type: string - metadata: - type: object + type: boolean + description: Output only. Reserved for future use. + etag: description: >- - Properties of the Context. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. - additionalProperties: - description: Properties of the object. - type: any - id: GoogleCloudAiplatformV1Context - GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation: - id: GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation - type: object - properties: - instanceId: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string - format: int64 + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - The instance of the object, expressed as a positive integer. Used to - track the same object across different frames. - xMin: - type: number - format: double - description: The leftmost coordinate of the bounding box. - yMax: - format: double - type: number - description: The bottommost coordinate of the bounding box. - yMin: - type: number - description: The topmost coordinate of the bounding box. - format: double - timeOffset: - format: google-duration + Immutable. Customer-managed encryption key spec for an Index. If + set, this Index and all sub-resources of this Index will be secured + by this key. + updateTime: + format: google-datetime description: >- - A time (frame) of a video to which this annotation pertains. - Represented as the duration since the video's start. + Output only. Timestamp when this Index was most recently updated. + This also includes any update to the contents of the Index. Note + that Operations working on this Index may have their + Operations.metadata.generic_metadata.update_time a little after the + value of this timestamp, yet that does not mean their results are + not already reflected in the Index. Result of any successfully + completed Operation on the Index is reflected in it. + readOnly: true type: string + deployedIndexes: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' + type: array + description: >- + Output only. The pointers to DeployedIndexes created from this + Index. An Index can be only deleted if all its DeployedIndexes had + been undeployed first. + readOnly: true displayName: type: string description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - annotationSpecId: + Required. The display name of the Index. The name can be up to 128 + characters long and can consist of any UTF-8 characters. + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + description: type: string + description: The description of the Index. + metadata: description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - xMax: - description: The rightmost coordinate of the bounding box. - format: double - type: number - description: Annotation details specific to video object tracking. - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec: - properties: - metricId: - type: string - description: Required. The ID of the metric. Must not contain whitespaces. - goal: + An additional information about the Index; the schema of the + metadata can be found in metadata_schema. + type: any + name: + readOnly: true + description: Output only. The resource name of the Index. type: string - description: Required. The optimization goal of the metric. - enumDescriptions: - - Goal Type will default to maximize. - - Maximize the goal metric. - - Minimize the goal metric. - enum: - - GOAL_TYPE_UNSPECIFIED - - MAXIMIZE - - MINIMIZE - description: Represents a metric to optimize. - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + id: GoogleCloudAiplatformV1Index + description: >- + A representation of a collection of database items organized in a way + that allows for approximate nearest neighbor (a.k.a ANN) algorithms + search. + GoogleCloudAiplatformV1BleuInstance: type: object - GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: - description: Details of operations that perform create FeatureView. - id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata + description: Spec for bleu instance. + id: GoogleCloudAiplatformV1BleuInstance properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureView Create. + prediction: + type: string + description: Required. Output of the evaluated model. + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + GoogleCloudAiplatformV1Port: type: object - GoogleCloudAiplatformV1AutomaticResources: + id: GoogleCloudAiplatformV1Port + description: Represents a network port in a container. properties: - maxReplicaCount: - format: int32 - description: >- - Immutable. The maximum number of replicas this DeployedModel 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 the model to that many replicas - is guaranteed (barring service outages). If traffic against the - DeployedModel 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. + containerPort: type: integer - minReplicaCount: format: int32 - type: integer description: >- - Immutable. The minimum number of replicas this DeployedModel will be - always deployed on. If traffic against it increases, it may - dynamically be deployed onto more replicas up to max_replica_count, - and as traffic decreases, some of these extra replicas may be freed. - If the requested value is too large, the deployment will error. - id: GoogleCloudAiplatformV1AutomaticResources + The number of the port to expose on the pod's IP address. Must be a + valid port number, between 1 and 65535 inclusive. + GoogleCloudAiplatformV1MigrateResourceResponse: type: object - 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. - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig: - description: >- - The objective configuration for model monitoring, including the - information needed to detect anomalies for one particular model. - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + id: GoogleCloudAiplatformV1MigrateResourceResponse + description: Describes a successfully migrated resource. properties: - trainingPredictionSkewDetectionConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig - description: The config for skew between training data and prediction data. - trainingDataset: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset + model: + type: string + description: Migrated Model's resource name. + migratableResource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' description: >- - Training dataset for models. This field has to be set only if - TrainingPredictionSkewDetectionConfig is specified. - predictionDriftDetectionConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig - description: The config for drift of prediction data. - explanationConfig: - description: The config for integrating with Vertex Explainable AI. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig - type: object - GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec: - id: GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec + Before migration, the identifier in ml.googleapis.com, + automl.googleapis.com or datalabeling.googleapis.com. + dataset: + type: string + description: Migrated Dataset's resource name. + GoogleCloudAiplatformV1NotebookRuntimeTemplate: type: object - properties: - useReference: - description: >- - Optional. Whether to use instance.reference to compute pairwise - summarization quality. - type: boolean - version: - description: Optional. Which version to use for evaluation. - type: integer - format: int32 - description: Spec for pairwise summarization quality score metric. - GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse: description: >- - Response message for - TensorboardService.BatchCreateTensorboardTimeSeries. - properties: - tensorboardTimeSeries: - type: array - description: The created TensorboardTimeSeries. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse - type: object - GoogleCloudAiplatformV1BatchMigrateResourcesRequest: + A template that specifies runtime configurations such as machine type, + runtime version, network configurations, etc. Multiple runtimes can be + created from a runtime template. properties: - migrateResourceRequests: + serviceAccount: + type: string + description: >- + The service account that the runtime workload runs as. You can use + any service account within the same project, but you must have the + service account user permission to use the instance. If not + specified, the [Compute Engine default service + account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) + is used. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: Customer-managed encryption key spec for the notebook runtime. + name: + description: The resource name of the NotebookRuntimeTemplate. + type: string + dataPersistentDiskSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' + description: >- + Optional. The specification of persistent disk attached to the + runtime as data disk storage. + labels: + type: object + additionalProperties: + type: string + description: >- + The labels with user-defined metadata to organize the + NotebookRuntimeTemplates. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. + shieldedVmConfig: + description: Optional. Immutable. Runtime Shielded VM spec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' + displayName: + description: >- + Required. The display name of the NotebookRuntimeTemplate. The name + can be up to 128 characters long and can consist of any UTF-8 + characters. + type: string + networkTags: type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' description: >- - Required. The request messages specifying the resources to migrate. - They must be in the same location as the destination. Up to 50 - resources can be migrated in one batch. - id: GoogleCloudAiplatformV1BatchMigrateResourcesRequest - type: object - description: Request message for MigrationService.BatchMigrateResources. - GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest: - properties: - requests: + Optional. The Compute Engine tags to add to runtime (see [Tagging + instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest + type: string + machineSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' description: >- - Required. The request message specifying the TensorboardTimeSeries - to create. A maximum of 1000 TensorboardTimeSeries can be created in - a batch. - type: array - description: Request message for TensorboardService.BatchCreateTensorboardTimeSeries. - id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest - type: object - GoogleCloudAiplatformV1ImportDataResponse: - properties: {} - description: Response message for DatasetService.ImportData. + Optional. Immutable. The specification of a single machine for the + template. + description: + description: The description of the NotebookRuntimeTemplate. + type: string + networkSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' + description: Optional. Network spec. + updateTime: + description: >- + Output only. Timestamp when this NotebookRuntimeTemplate was most + recently updated. + type: string + format: google-datetime + readOnly: true + idleShutdownConfig: + description: >- + The idle shutdown configuration of NotebookRuntimeTemplate. This + config will only be set when idle shutdown is enabled. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + notebookRuntimeType: + enumDescriptions: + - >- + Unspecified notebook runtime type, NotebookRuntimeType will + default to USER_DEFINED. + - runtime or template with coustomized configurations from user. + - runtime or template with system defined configurations. + enum: + - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED + - USER_DEFINED + - ONE_CLICK + type: string + description: Optional. Immutable. The type of the notebook runtime template. + isDefault: + description: Output only. The default template to use if not specified. + readOnly: true + type: boolean + etag: + type: string + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + eucConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' + description: EUC configuration of the NotebookRuntimeTemplate. + createTime: + type: string + description: >- + Output only. Timestamp when this NotebookRuntimeTemplate was + created. + readOnly: true + format: google-datetime + id: GoogleCloudAiplatformV1NotebookRuntimeTemplate + GoogleCloudAiplatformV1BleuMetricValue: type: object - id: GoogleCloudAiplatformV1ImportDataResponse - GoogleCloudAiplatformV1RayLogsSpec: + description: Bleu metric value for an instance. + id: GoogleCloudAiplatformV1BleuMetricValue + properties: + score: + description: Output only. Bleu score. + type: number + format: float + readOnly: true + GoogleCloudAiplatformV1ListNasTrialDetailsResponse: + id: GoogleCloudAiplatformV1ListNasTrialDetailsResponse + description: Response message for JobService.ListNasTrialDetails type: object properties: - disabled: + nasTrialDetails: + type: array + description: List of top NasTrials in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + nextPageToken: + type: string description: >- - Optional. Flag to disable the export of Ray OSS logs to Cloud - Logging. - type: boolean - description: Configuration for the Ray OSS Logs. - id: GoogleCloudAiplatformV1RayLogsSpec - GoogleCloudAiplatformV1ToolParameterKVMatchResults: - id: GoogleCloudAiplatformV1ToolParameterKVMatchResults + A token to retrieve the next page of results. Pass to + ListNasTrialDetailsRequest.page_token to obtain that page. + GoogleCloudAiplatformV1IndexStats: + description: Stats of the Index. + id: GoogleCloudAiplatformV1IndexStats properties: - toolParameterKvMatchMetricValues: - description: Output only. Tool parameter key value match metric values. + sparseVectorsCount: + type: string readOnly: true - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue - type: array + description: Output only. The number of sparse vectors in the Index. + format: int64 + shardsCount: + description: Output only. The number of shards in the Index. + format: int32 + readOnly: true + type: integer + vectorsCount: + format: int64 + description: Output only. The number of dense vectors in the Index. + readOnly: true + type: string type: object - description: Results for tool parameter key value match metric. - GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest: - description: Request message for MetadataService.AddContextArtifactsAndExecutions. - id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest + GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams: + description: Prediction model parameters for Video Object Tracking. + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams properties: - artifacts: - items: - type: string - type: array + confidenceThreshold: + type: number + format: float description: >- - The resource names of the Artifacts to attribute to the Context. - Format: - `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` - executions: + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + maxPredictions: + format: int32 + type: integer + description: >- + The model only returns up to that many top, by confidence score, + predictions per frame of the video. If this number is very high, the + Model may return fewer predictions per frame. Default value is 50. + minBoundingBoxSize: + description: >- + Only bounding boxes with shortest edge at least that long as a + relative value of video frame size are returned. Default value is + 0.0. + type: number + format: float + type: object + GoogleCloudAiplatformV1RemoveContextChildrenRequest: + type: object + id: GoogleCloudAiplatformV1RemoveContextChildrenRequest + properties: + childContexts: + description: The resource names of the child Contexts. items: type: string - description: >- - The resource names of the Executions to associate with the Context. - Format: - `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` type: array + description: Request message for MetadataService.DeleteContextChildrenRequest. + GoogleCloudAiplatformV1GroundednessResult: type: object - GoogleCloudAiplatformV1CreateFeatureOperationMetadata: + description: Spec for groundedness result. + id: GoogleCloudAiplatformV1GroundednessResult + properties: + confidence: + description: Output only. Confidence for groundedness score. + type: number + readOnly: true + format: float + score: + readOnly: true + format: float + type: number + description: Output only. Groundedness score. + explanation: + description: Output only. Explanation for groundedness score. + type: string + readOnly: true + GoogleCloudAiplatformV1DeleteOperationMetadata: type: object - description: Details of operations that perform create Feature. + description: Details of operations that perform deletes of any entities. + id: GoogleCloudAiplatformV1DeleteOperationMetadata properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. - id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata - GoogleCloudAiplatformV1ListSavedQueriesResponse: - id: GoogleCloudAiplatformV1ListSavedQueriesResponse - description: Response message for DatasetService.ListSavedQueries. - type: object + description: The common part of the operation metadata. + GoogleCloudAiplatformV1TimestampSplit: + id: GoogleCloudAiplatformV1TimestampSplit properties: - savedQueries: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + trainingFraction: + type: number + format: double description: >- - A list of SavedQueries that match the specified filter in the - request. - nextPageToken: + The fraction of the input data that is to be used to train the + Model. + key: + description: >- + Required. The key is a name of one of the Dataset's data columns. + The values of the key (the values in the column) must be in RFC 3339 + `date-time` format, where `time-offset` = `"Z"` (e.g. + 1985-04-12T23:20:50.52Z). If for a piece of data the key is not + present or has an invalid value, that piece is ignored by the + pipeline. type: string - description: The standard List next-page token. - GoogleCloudAiplatformV1SmoothGradConfig: - id: GoogleCloudAiplatformV1SmoothGradConfig + validationFraction: + description: >- + The fraction of the input data that is to be used to validate the + Model. + format: double + type: number + testFraction: + type: number + description: >- + The fraction of the input data that is to be used to evaluate the + Model. + format: double type: object + description: >- + Assigns input data to training, validation, and test sets based on a + provided timestamps. The youngest data pieces are assigned to training + set, next to validation set, and the oldest to the test set. Supported + only for tabular Datasets. + GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance: properties: - noiseSigma: - type: number - format: float + mimeType: + type: string description: >- - This is a single float value and will be used to add noise to all - the features. Use this field when all features are normalized to - have the same distribution: scale to range [0, 1], [-1, 1] or - z-scoring, where features are normalized to have 0-mean and - 1-variance. Learn more about - [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). - For best results the recommended value is about 10% - 20% of the - standard deviation of the input feature. Refer to section 3.2 of the - SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to - 0.1. If the distribution is different per feature, set - feature_noise_sigma instead for each feature. - featureNoiseSigma: + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + content: + description: The text snippet to make the predictions on. + type: string + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance + description: Prediction input format for Text Sentiment. + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis: + type: object + properties: + anomalyDetectionBaseline: + enumDescriptions: + - Should not be used. + - >- + Choose the later one statistics generated by either most recent + snapshot analysis or previous import features analysis. If non of + them exists, skip anomaly detection and only generate a + statistics. + - >- + Use the statistics generated by the most recent snapshot analysis + if exists. + - >- + Use the statistics generated by the previous import features + analysis if exists. description: >- - This is similar to noise_sigma, but provides additional flexibility. - A separate noise sigma can be provided for each feature, which is - useful if their distributions are different. No noise is added to - features that are not set. If this field is unset, noise_sigma will - be used for all features. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigma' - noisySampleCount: - format: int32 + The baseline used to do anomaly detection for the statistics + generated by import features analysis. + enum: + - BASELINE_UNSPECIFIED + - LATEST_STATS + - MOST_RECENT_SNAPSHOT_STATS + - PREVIOUS_IMPORT_FEATURES_STATS + type: string + state: + enumDescriptions: + - Should not be used. + - >- + The default behavior of whether to enable the monitoring. + EntityType-level config: disabled. Feature-level config: inherited + from the configuration of EntityType this Feature belongs to. + - >- + Explicitly enables import features analysis. EntityType-level + config: by default enables import features analysis for all + Features under it. Feature-level config: enables import features + analysis regardless of the EntityType-level config. + - >- + Explicitly disables import features analysis. EntityType-level + config: by default disables import features analysis for all + Features under it. Feature-level config: disables import features + analysis regardless of the EntityType-level config. + type: string + enum: + - STATE_UNSPECIFIED + - DEFAULT + - ENABLED + - DISABLED description: >- - The number of gradient samples to use for approximation. The higher - this number, the more accurate the gradient is, but the runtime - complexity increases by this factor as well. Valid range of its - value is [1, 50]. Defaults to 3. - type: integer + Whether to enable / disable / inherite default hebavior for import + features analysis. + id: >- + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy samples - in the vicinity of the inputs. Adding noise can help improve the - computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf - GoogleCloudAiplatformV1FindNeighborsResponseNeighbor: - description: A neighbor of the query vector. + Configuration of the Featurestore's ImportFeature Analysis Based + Monitoring. This type of analysis generates statistics for values of + each Feature imported by every ImportFeatureValues operation. + GoogleCloudAiplatformV1CancelDataLabelingJobRequest: + id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest + description: Request message for JobService.CancelDataLabelingJob. + properties: {} + type: object + GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue: + description: Tool parameter key value match metric value for an instance. properties: - datapoint: - description: >- - The datapoint of the neighbor. Note that full datapoints are - returned only when "return_full_datapoint" is set to true. - Otherwise, only the "datapoint_id" and "crowding_tag" fields are - populated. - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - distance: - type: number - description: The distance between the neighbor and the dense embedding query. - format: double - sparseDistance: - description: The distance between the neighbor and the query sparse_embedding. - format: double + score: + format: float + readOnly: true type: number + description: Output only. Tool parameter key value match score. type: object - id: GoogleCloudAiplatformV1FindNeighborsResponseNeighbor - GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata: - id: GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata + id: GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue + GoogleCloudAiplatformV1FunctionCall: + id: GoogleCloudAiplatformV1FunctionCall description: >- - Runtime operation metadata for - SpecialistPoolService.UpdateSpecialistPool. + A predicted [FunctionCall] returned from the model that contains a + string representing the [FunctionDeclaration.name] and a structured JSON + object containing the parameters and their values. type: object properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - specialistPool: + args: + additionalProperties: + description: Properties of the object. + type: any description: >- - Output only. The name of the SpecialistPool to which the specialists - are being added. Format: - `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` - readOnly: true + Optional. Required. The function parameters and values in JSON + object format. See [FunctionDeclaration.parameters] for parameter + details. + type: object + name: type: string - GoogleCloudAiplatformV1StringArray: - description: A list of string values. + description: >- + Required. The name of the function to call. Matches + [FunctionDeclaration.name]. + GoogleCloudAiplatformV1GenerationConfigRoutingConfig: + type: object + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfig + description: The configuration for routing the request to a specific model. properties: - values: - description: A list of string values. - items: - type: string - type: array + manualMode: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode + description: Manual routing. + autoMode: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode + description: Automated routing. + GoogleCloudAiplatformV1Candidate: type: object - id: GoogleCloudAiplatformV1StringArray - GoogleCloudAiplatformV1PairwiseMetricResult: - id: GoogleCloudAiplatformV1PairwiseMetricResult - description: Spec for pairwise metric result. + id: GoogleCloudAiplatformV1Candidate + description: A response candidate generated from the model. properties: - explanation: + content: + description: Output only. Content parts of the candidate. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + safetyRatings: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' + description: >- + Output only. List of ratings for the safety of a response candidate. + There is at most one rating per category. readOnly: true + finishMessage: type: string - description: Output only. Explanation for pairwise metric score. - pairwiseChoice: readOnly: true - description: Output only. Pairwise metric choice. + description: >- + Output only. Describes the reason the mode stopped generating tokens + in more detail. This is only filled when `finish_reason` is set. + index: + type: integer + readOnly: true + description: Output only. Index of the candidate. + format: int32 + citationMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CitationMetadata' + readOnly: true + description: Output only. Source attribution of the generated content. + avgLogprobs: + description: Output only. Average log probability score of the candidate. + type: number + format: double + readOnly: true + finishReason: + enumDescriptions: + - The finish reason is unspecified. + - >- + Token generation reached a natural stopping point or a configured + stop sequence. + - Token generation reached the configured maximum output tokens. + - >- + Token generation stopped because the content potentially contains + safety violations. NOTE: When streaming, content is empty if + content filters blocks the output. + - >- + Token generation stopped because the content potentially contains + copyright violations. + - All other reasons that stopped the token generation. + - >- + Token generation stopped because the content contains forbidden + terms. + - >- + Token generation stopped for potentially containing prohibited + content. + - >- + Token generation stopped because the content potentially contains + Sensitive Personally Identifiable Information (SPII). + - The function call generated by the model is invalid. enum: - - PAIRWISE_CHOICE_UNSPECIFIED - - BASELINE - - CANDIDATE - - TIE + - FINISH_REASON_UNSPECIFIED + - STOP + - MAX_TOKENS + - SAFETY + - RECITATION + - OTHER + - BLOCKLIST + - PROHIBITED_CONTENT + - SPII + - MALFORMED_FUNCTION_CALL + description: >- + Output only. The reason why the model stopped generating tokens. If + empty, the model has not stopped generating the tokens. + type: string + readOnly: true + groundingMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' + description: >- + Output only. Metadata specifies sources used to ground generated + content. + readOnly: true + GoogleCloudAiplatformV1SafetyRating: + properties: + blocked: + type: boolean + description: >- + Output only. Indicates whether the content was filtered out because + of this rating. + readOnly: true + probability: + description: Output only. Harm probability levels in the content. + enum: + - HARM_PROBABILITY_UNSPECIFIED + - NEGLIGIBLE + - LOW + - MEDIUM + - HIGH + readOnly: true + type: string enumDescriptions: - - Unspecified prediction choice. - - Baseline prediction wins - - Candidate prediction wins - - Winner cannot be determined + - Harm probability unspecified. + - Negligible level of harm. + - Low level of harm. + - Medium level of harm. + - High level of harm. + probabilityScore: + description: Output only. Harm probability score. + format: float + type: number + readOnly: true + category: + readOnly: true type: string + description: Output only. Harm category. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + - HARM_CATEGORY_CIVIC_INTEGRITY + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + - The harm category is civic integrity. + severity: + readOnly: true + enumDescriptions: + - Harm severity unspecified. + - Negligible level of harm severity. + - Low level of harm severity. + - Medium level of harm severity. + - High level of harm severity. + enum: + - HARM_SEVERITY_UNSPECIFIED + - HARM_SEVERITY_NEGLIGIBLE + - HARM_SEVERITY_LOW + - HARM_SEVERITY_MEDIUM + - HARM_SEVERITY_HIGH + description: Output only. Harm severity levels in the content. + type: string + severityScore: + readOnly: true + format: float + type: number + description: Output only. Harm severity score. + id: GoogleCloudAiplatformV1SafetyRating type: object - GoogleCloudAiplatformV1DeployIndexRequest: - type: object + description: Safety rating corresponding to the generated content. + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig: properties: - deployedIndex: - description: Required. The DeployedIndex to be created within the IndexEndpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - description: Request message for IndexEndpointService.DeployIndex. - id: GoogleCloudAiplatformV1DeployIndexRequest - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition: + explanationBaseline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline + description: >- + Predictions generated by the BatchPredictionJob using baseline + dataset. + enableFeatureAttributes: + type: boolean + description: >- + If want to analyze the Vertex Explainable AI feature attribute + scores or not. If set to true, Vertex AI will log the feature + attributions from explain response and do the skew/drift detection + for them. description: >- - A TrainingJob that trains and uploads an AutoML Video Action Recognition - Model. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition + The config for integrating with Vertex Explainable AI. Only applicable + if the Model has explanation_spec populated. type: object + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig + GoogleCloudAiplatformV1UserActionReference: properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs - description: The input parameters of this TrainingJob. - GoogleCloudAiplatformV1Explanation: + method: + description: >- + The method name of the API RPC call. For example, + "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset" + type: string + dataLabelingJob: + type: string + description: >- + For API calls that start a LabelingJob. Resource name of the + LabelingJob. Format: + `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + operation: + type: string + description: >- + For API calls that return a long running operation. Resource name of + the long running operation. Format: + `projects/{project}/locations/{location}/operations/{operation}` description: >- - Explanation of a prediction (provided in PredictResponse.predictions) - produced by the Model on a given instance. + References an API call. It contains more information about long running + operation and Jobs that are triggered by the API call. type: object - id: GoogleCloudAiplatformV1Explanation + id: GoogleCloudAiplatformV1UserActionReference + GoogleCloudAiplatformV1TensorboardTimeSeries: + description: TensorboardTimeSeries maps to times series produced in training runs properties: - attributions: + metadata: readOnly: true description: >- - Output only. Feature attributions grouped by predicted outputs. For - Models that predict only one output, such as regression Models that - predict only one score, there is only one attibution that explains - the predicted output. For Models that predict multiple outputs, such - as multiclass Models that predict multiple classes, each element - explains one specific item. Attribution.output_index can be used to - identify which output this attribution is explaining. By default, we - provide Shapley values for the predicted class. However, you can - configure the explanation request to generate Shapley values for any - other classes too. For example, if a model predicts a probability of - `0.4` for approving a loan application, the model's decision is to - reject the application since `p(reject) = 0.6 > p(approve) = 0.4`, - and the default Shapley values would be computed for rejection - decision and not approval, even though the latter might be the - positive class. If users set ExplanationParameters.top_k, the - attributions are sorted by instance_output_value in descending - order. If ExplanationParameters.output_indices is specified, the - attributions are stored by Attribution.output_index in the same - order as they appear in the output_indices. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' - neighbors: - type: array + Output only. Scalar, Tensor, or Blob metadata for this + TensorboardTimeSeries. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata + description: + description: Description of this TensorboardTimeSeries. + type: string + pluginData: + description: Data of the current plugin, with the size limited to 65KB. + type: string + format: byte + name: readOnly: true + description: Output only. Name of the TensorboardTimeSeries. + type: string + valueType: + type: string + enumDescriptions: + - The value type is unspecified. + - >- + Used for TensorboardTimeSeries that is a list of scalars. E.g. + accuracy of a model over epochs/time. + - >- + Used for TensorboardTimeSeries that is a list of tensors. E.g. + histograms of weights of layer in a model over epoch/time. + - >- + Used for TensorboardTimeSeries that is a list of blob sequences. + E.g. set of sample images with labels over epochs/time. + enum: + - VALUE_TYPE_UNSPECIFIED + - SCALAR + - TENSOR + - BLOB_SEQUENCE + description: Required. Immutable. Type of TensorboardTimeSeries value. + etag: + type: string description: >- - Output only. List of the nearest neighbors for example-based - explanations. For models deployed with the examples explanations - feature enabled, the attributions field is empty and instead the - neighbors field is populated. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Neighbor' - GoogleTypeMoney: - description: Represents an amount of money with its currency type. - type: object - properties: - currencyCode: + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + displayName: + description: >- + Required. User provided name of this TensorboardTimeSeries. This + value should be unique among all TensorboardTimeSeries resources + belonging to the same TensorboardRun resource (parent resource). + type: string + pluginName: type: string - description: The three-letter currency code defined in ISO 4217. - nanos: - type: integer description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - format: int32 - units: + Immutable. Name of the plugin this time series pertain to. Such as + Scalar, Tensor, Blob + updateTime: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + Output only. Timestamp when this TensorboardTimeSeries was last + updated. + format: google-datetime + readOnly: true type: string - format: int64 - id: GoogleTypeMoney - GoogleCloudAiplatformV1WriteFeatureValuesPayload: - description: Contains Feature values to be written for a specific entity. + createTime: + type: string + readOnly: true + description: Output only. Timestamp when this TensorboardTimeSeries was created. + format: google-datetime + type: object + id: GoogleCloudAiplatformV1TensorboardTimeSeries + GoogleCloudAiplatformV1GenieSource: + id: GoogleCloudAiplatformV1GenieSource + description: >- + Contains information about the source of the models generated from + Generative AI Studio. properties: - entityId: - description: Required. The ID of the entity. + baseModelUri: type: string - featureValues: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: >- - Required. Feature values to be written, mapping from Feature ID to - value. Up to 100,000 `feature_values` entries may be written across - all payloads. The feature generation time, aligned by days, must be - no older than five years (1825 days) and no later than one year (366 - days) in the future. - type: object - id: GoogleCloudAiplatformV1WriteFeatureValuesPayload + description: Required. The public base model URI. type: object - GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance: + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis: + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis properties: - timeSegmentStart: + disabled: + type: boolean description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. - type: string - content: - type: string + The monitoring schedule for snapshot analysis. For EntityType-level + config: unset / disabled = true indicates disabled by default for + Features under it; otherwise by default enable snapshot analysis + monitoring with monitoring_interval for Features under it. + Feature-level config: disabled = true indicates disabled regardless + of the EntityType-level config; unset monitoring_interval indicates + going with EntityType-level config; otherwise run snapshot analysis + monitoring with monitoring_interval regardless of the + EntityType-level config. Explicitly Disable the snapshot analysis + based monitoring. + monitoringIntervalDays: + format: int32 description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. + Configuration of the snapshot analysis based monitoring pipeline + running interval. The value indicates number of days. + type: integer + stalenessDays: + format: int32 + type: integer + description: >- + Customized export features time window for snapshot analysis. Unit + is one day. Default value is 3 weeks. Minimum value is 1 day. + Maximum value is 4000 days. + description: >- + Configuration of the Featurestore's Snapshot Analysis Based Monitoring. + This type of analysis generates statistics for each Feature based on a + snapshot of the latest feature value of each entities every + monitoring_interval. + type: object + GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance: + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance + description: Prediction input format for Video Classification. + type: object + properties: timeSegmentEnd: description: >- The end, exclusive, of the video's time segment on which to perform @@ -24528,333 +24485,376 @@ components: allowed, up to a microsecond precision, and "inf" or "Infinity" is allowed, which means the end of the video. type: string - mimeType: + content: type: string + description: >- + The Google Cloud Storage location of the video on which to perform + the prediction. + mimeType: description: >- The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance - description: Prediction input format for Video Classification. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting: + type: string + timeSegmentStart: + type: string + description: >- + The beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. + GoogleCloudAiplatformV1RaySpec: properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata - description: The metadata information. - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + imageUri: + type: string + description: >- + Optional. Default image for user to choose a preferred ML framework + (for example, TensorFlow or Pytorch) by choosing from [Vertex + prebuilt + images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). + Either this or the resource_pool_images is required. Use this field + if you need all the resource pools to have the same Ray image. + Otherwise, use the {@code resource_pool_images} field. + rayMetricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RayMetricSpec' + description: Optional. Ray metrics configurations. + resourcePoolImages: + additionalProperties: + type: string + description: >- + Optional. Required if image_uri isn't set. A map of resource_pool_id + to prebuild Ray image if user need to use different images for + different head/worker pools. This map needs to cover all the + resource pool ids. Example: { "ray_head_node_pool": "head image" + "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": + "another worker image" } + type: object + headNodeResourcePoolId: + description: >- + Optional. This will be used to indicate which resource pool will + serve as the Ray head node(the first node within that pool). Will + use the machine from the first workerpool as the head node by + default if this field isn't set. + type: string + rayLogsSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RayLogsSpec' + description: Optional. OSS Ray logging configurations. + id: GoogleCloudAiplatformV1RaySpec type: object - GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi: + description: >- + Configuration information for the Ray cluster. For experimental launch, + Ray cluster creation and Persistent cluster creation are 1:1 mapping: We + will provision all the nodes within the Persistent cluster as Ray nodes. + GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata: type: object + description: Metadata information for NotebookService.CreateNotebookExecutionJob. + id: GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata properties: - title: - description: Required. The title of the view rest API. + progressMessage: + description: >- + A human-readable message that shows the intermediate progress + details of NotebookRuntime. type: string - documentations: - description: Required. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelDocumentation - id: GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi - description: Rest API docs. - GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance: - description: Prediction input format for Image Classification. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs: type: object id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance - properties: - mimeType: - description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/gif - - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon - type: string - content: - description: The image bytes or Cloud Storage URI to make the prediction on. - type: string - GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec: - id: GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs properties: - explanationType: + modelType: + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_JETSON_VERSATILE_1 + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Default. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) to a Jetson + device afterwards. type: string - description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' - description: Explanation spec details. + GoogleCloudAiplatformV1PointwiseMetricInput: type: object - GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies: - id: >- - GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies - description: Historical Stats (and Anomalies) for a specific Feature. + description: Input for pointwise metric. + properties: + metricSpec: + description: Required. Spec for pointwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricSpec' + instance: + description: Required. Pointwise metric instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInstance' + id: GoogleCloudAiplatformV1PointwiseMetricInput + CloudAiLargeModelsVisionGenerateVideoResponse: + properties: + raiMediaFilteredReasons: + items: + type: string + description: Returns rai failure reasons if any. + type: array + raiMediaFilteredCount: + type: integer + format: int32 + description: Returns if any videos were filtered due to RAI policies. + generatedSamples: + type: array + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' + description: The generates samples. type: object + id: CloudAiLargeModelsVisionGenerateVideoResponse + description: Generate video response. + GoogleCloudAiplatformV1ListFeaturesResponse: + description: >- + Response message for FeaturestoreService.ListFeatures. Response message + for FeatureRegistryService.ListFeatures. + id: GoogleCloudAiplatformV1ListFeaturesResponse properties: - threshold: - description: Threshold for anomaly detection. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - featureDisplayName: - description: Display Name of the Feature. - type: string - trainingStats: - description: Stats calculated for the Training Dataset. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - predictionStats: + nextPageToken: description: >- - A list of historical stats generated by different time window's - Prediction Dataset. + A token, which can be sent as ListFeaturesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: string + features: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: The Features matching the request. type: array - GoogleCloudAiplatformV1ListExecutionsResponse: type: object - description: Response message for MetadataService.ListExecutions. + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest: properties: - executions: + objectives: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective type: array - description: The Executions retrieved from the MetadataStore. - nextPageToken: + description: Required. Objectives of the stats to retrieve. + startTime: + description: >- + The earliest timestamp of stats being generated. If not set, + indicates fetching stats till the earliest possible one. + format: google-datetime + type: string + featureDisplayName: type: string description: >- - A token, which can be sent as ListExecutionsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. - id: GoogleCloudAiplatformV1ListExecutionsResponse - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain: + The feature display name. If specified, only return the stats + belonging to this feature. Format: + ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, + example: "user_destination". + pageSize: + type: integer + format: int32 + description: The standard list page size. + pageToken: + type: string + description: >- + A page token received from a previous + JobService.SearchModelDeploymentMonitoringStatsAnomalies call. + deployedModelId: + type: string + description: >- + Required. The DeployedModel ID of the + [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. + endTime: + format: google-datetime + description: >- + The latest timestamp of stats being generated. If not set, indicates + feching stats till the latest possible one. + type: string type: object description: >- - Domain details of the input feature value. Provides numeric information - about the feature, such as its range (min, max). If the feature has been - pre-processed, for example with z-scoring, then it provides information - about how to recover the original feature. For example, if the input - feature is an image and it has been pre-processed to obtain 0-mean and - stddev = 1 values, then original_mean, and original_stddev refer to the - mean and stddev of the original feature (e.g. image tensor) from which - input feature (with mean = 0 and stddev = 1) was obtained. + Request message for + JobService.SearchModelDeploymentMonitoringStatsAnomalies. id: >- - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain - properties: - maxValue: - description: The maximum permissible value for this feature. - type: number - format: float - minValue: - type: number - format: float - description: The minimum permissible value for this feature. - originalStddev: - type: number - description: >- - If this input feature has been normalized to a standard deviation of - 1.0, the original_stddev specifies the standard deviation of the - domain prior to normalization. - format: float - originalMean: - type: number - description: >- - If this input feature has been normalized to a mean value of 0, the - original_mean specifies the mean value of the domain prior to - normalization. - format: float - GoogleCloudAiplatformV1GroundednessResult: + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest + GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter: + description: >- + Numeric filter is used to search a subset of the entities by using + boolean rules on numeric columns. For example: Database Point 0: {name: + "a" value_int: 42} {name: "b" value_float: 1.0} Database Point 1: {name: + "a" value_int: 10} {name: "b" value_float: 2.0} Database Point 2: {name: + "a" value_int: -1} {name: "b" value_float: 3.0} Query: {name: "a" + value_int: 12 operator: LESS} // Matches Point 1, 2 {name: "b" + value_float: 2.0 operator: EQUAL} // Matches Point 1 + id: GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter type: object properties: - confidence: - readOnly: true + valueInt: + format: int64 + description: int value type. + type: string + valueDouble: + description: double value type. + format: double type: number + valueFloat: + description: float value type. format: float - description: Output only. Confidence for groundedness score. - score: - format: float - readOnly: true - description: Output only. Groundedness score. type: number - explanation: - description: Output only. Explanation for groundedness score. - readOnly: true + op: + enumDescriptions: + - Unspecified operator. + - Entities are eligible if their value is < the query's. + - Entities are eligible if their value is <= the query's. + - Entities are eligible if their value is == the query's. + - Entities are eligible if their value is >= the query's. + - Entities are eligible if their value is > the query's. + - Entities are eligible if their value is != the query's. + enum: + - OPERATOR_UNSPECIFIED + - LESS + - LESS_EQUAL + - EQUAL + - GREATER_EQUAL + - GREATER + - NOT_EQUAL + description: >- + Optional. This MUST be specified for queries and must NOT be + specified for database points. type: string - id: GoogleCloudAiplatformV1GroundednessResult - description: Spec for groundedness result. - GoogleCloudAiplatformV1SearchMigratableResourcesRequest: - id: GoogleCloudAiplatformV1SearchMigratableResourcesRequest + name: + description: Required. Column name in BigQuery that used as filters. + type: string + GoogleCloudAiplatformV1ExactMatchInstance: + id: GoogleCloudAiplatformV1ExactMatchInstance + description: Spec for exact match instance. type: object properties: - pageToken: + prediction: + description: Required. Output of the evaluated model. type: string - description: The standard page token. - pageSize: + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec: + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec + properties: + useReference: + description: >- + Optional. Whether to use instance.reference to compute question + answering relevance. + type: boolean + version: type: integer - description: The standard page size. The default and maximum value is 100. format: int32 - filter: - description: >- - A filter for your search. You can use the following types of - filters: * Resource type filters. The following strings filter for a - specific type of MigratableResource: * `ml_engine_model_version:*` * - `automl_model:*` * `automl_dataset:*` * `data_labeling_dataset:*` * - "Migrated or not" filters. The following strings filter for - resources that either have or have not already been migrated: * - `last_migrate_time:*` filters for migrated resources. * `NOT - last_migrate_time:*` filters for not yet migrated resources. - type: string - description: Request message for MigrationService.SearchMigratableResources. - GoogleCloudAiplatformV1PauseScheduleRequest: + description: Optional. Which version to use for evaluation. type: object - properties: {} - description: Request message for ScheduleService.PauseSchedule. - id: GoogleCloudAiplatformV1PauseScheduleRequest - GoogleCloudAiplatformV1ListContextsResponse: + description: Spec for question answering relevance metric. + GoogleCloudAiplatformV1UndeployIndexOperationMetadata: + id: GoogleCloudAiplatformV1UndeployIndexOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + type: object + description: Runtime operation information for IndexEndpointService.UndeployIndex. + GoogleCloudAiplatformV1ToolCallValidResults: + id: GoogleCloudAiplatformV1ToolCallValidResults + description: Results for tool call valid metric. type: object - description: Response message for MetadataService.ListContexts. properties: - nextPageToken: - type: string - description: >- - A token, which can be sent as ListContextsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. - contexts: - description: The Contexts retrieved from the MetadataStore. + toolCallValidMetricValues: type: array + readOnly: true + description: Output only. Tool call valid metric values. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - id: GoogleCloudAiplatformV1ListContextsResponse - GoogleCloudAiplatformV1QueryDeployedModelsResponse: - type: object - description: Response message for QueryDeployedModels method. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolCallValidMetricValue + GoogleCloudAiplatformV1LargeModelReference: + id: GoogleCloudAiplatformV1LargeModelReference properties: - totalEndpointCount: - format: int32 - description: >- - The total number of Endpoints that have DeployedModels on this - DeploymentResourcePool. - type: integer - deployedModelRefs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' - description: >- - References to the DeployedModels that share the specified - deploymentResourcePool. - type: array - nextPageToken: + name: type: string 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. - deployedModels: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: DEPRECATED Use deployed_model_refs instead. - deprecated: true - totalDeployedModelCount: - type: integer - format: int32 - description: The total number of DeployedModels on this DeploymentResourcePool. - id: GoogleCloudAiplatformV1QueryDeployedModelsResponse - GoogleCloudAiplatformV1FulfillmentInstance: - description: Spec for fulfillment instance. + Required. The unique name of the large Foundation or pre-built + model. Like "chat-bison", "text-bison". Or model name with version + ID, like "chat-bison@001", "text-bison@005", etc. + description: Contains information about the Large Model. + type: object + GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact: + id: GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact + description: The type of an input artifact. type: object properties: - instruction: - description: Required. Inference instruction prompt to compare prediction with. - type: string - prediction: - description: Required. Output of the evaluated model. + artifactId: + description: >- + Artifact resource id from MLMD. Which is the last portion of an + artifact resource name: + `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. + The artifact must stay within the same project, location and default + metadatastore as the pipeline. type: string - id: GoogleCloudAiplatformV1FulfillmentInstance - GoogleCloudAiplatformV1ExportFeatureValuesResponse: - description: Response message for FeaturestoreService.ExportFeatureValues. - id: GoogleCloudAiplatformV1ExportFeatureValuesResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation: type: object - properties: {} - GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics properties: - rSquared: - description: >- - Coefficient of determination as Pearson correlation coefficient. - Undefined when ground truth or predictions are constant or near - constant. - type: number - format: float - rootMeanSquaredLogError: - format: float - type: number - description: >- - Root mean squared log error. Undefined when there are negative - ground truth values or predictions. - rootMeanSquaredError: - type: number - description: Root Mean Squared Error (RMSE). - format: float - meanAbsolutePercentageError: - description: >- - Mean absolute percentage error. Infinity when there are zeros in the - ground truth. - format: float - type: number - meanAbsoluteError: - format: float - type: number - description: Mean Absolute Error (MAE). - description: Metrics for regression evaluation results. + columnName: + type: string + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult + description: Prediction output format for Image Segmentation. type: object - GoogleCloudAiplatformV1ListNasJobsResponse: - id: GoogleCloudAiplatformV1ListNasJobsResponse properties: - nextPageToken: + categoryMask: type: string description: >- - A token to retrieve the next page of results. Pass to - ListNasJobsRequest.page_token to obtain that page. - nasJobs: + A PNG image where each pixel in the mask represents the category in + which the pixel in the original image was predicted to belong to. + The size of this image will be the same as the original image. The + mapping between the AnntoationSpec and the color can be found in + model's metadata. The model will choose the most likely category and + if none of the categories reach the confidence threshold, the pixel + will be marked as background. + confidenceMask: + type: string description: >- - List of NasJobs in the requested page. NasJob.nas_job_output of the - jobs will not be returned. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' - description: Response message for JobService.ListNasJobs - type: object - GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams: - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams - type: object + A one channel image which is encoded as an 8bit lossless PNG. The + size of the image will be the same as the original image. For a + specific pixel, darker color means less confidence in correctness of + the cateogry in the categoryMask for the corresponding pixel. Black + means no confidence and white means complete confidence. + GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation: properties: - maxPredictions: + annotationSpecId: + type: string description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. Note that number of returned predictions - is also limited by metadata's predictionsLimit. Default value is 10. - type: integer - format: int32 - confidenceThreshold: + The resource Id of the AnnotationSpec that this Annotation pertains + to. + timeSegment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - format: float - type: number - description: Prediction model parameters for Image Object Detection. - GoogleCloudAiplatformV1UploadModelOperationMetadata: - id: GoogleCloudAiplatformV1UploadModelOperationMetadata + This Annotation applies to the time period represented by the + TimeSegment. If it's not set, the Annotation applies to the whole + video. + displayName: + type: string + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + description: Annotation details specific to video action recognition. type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - description: Details of ModelService.UploadModel operation. + id: GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation parameters: upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). @@ -24862,12 +24862,18 @@ components: name: upload_protocol schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: fields + name: oauth_token schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -24877,12 +24883,12 @@ components: name: key schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: prettyPrint + name: fields schema: - type: boolean + type: string alt: description: Data format for response. in: query @@ -24893,264 +24899,102 @@ components: - json - media - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: - type: string - x-stackQL-resources: - models: - id: google.aiplatform.models - name: models - title: Models - methods: - count_tokens: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:countTokens/post - response: - mediaType: application/json - openAPIDocKey: '200' - stream_generate_content: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamGenerateContent/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - generate_content: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:generateContent/post - response: - mediaType: application/json - openAPIDocKey: '200' - compute_tokens: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:computeTokens/post - response: - mediaType: application/json - openAPIDocKey: '200' - predict: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predict/post - response: - mediaType: application/json - openAPIDocKey: '200' - server_streaming_predict: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:serverStreamingPredict/post - response: - mediaType: application/json - openAPIDocKey: '200' - raw_predict: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:rawPredict/post - response: - mediaType: application/json - openAPIDocKey: '200' - stream_raw_predict: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamRawPredict/post - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.models - merge_version_aliases: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:mergeVersionAliases/post - response: - mediaType: application/json - openAPIDocKey: '200' - upload: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:upload/post - response: - mediaType: application/json - openAPIDocKey: '200' - export: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:export/post - response: - mediaType: application/json - openAPIDocKey: '200' - copy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:copy/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/models/methods/get' - - $ref: '#/components/x-stackQL-resources/models/methods/list' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/models/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/models/methods/delete' - locations: - id: google.aiplatform.locations - name: locations - title: Locations - methods: - evaluate_instances: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:evaluateInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.locations - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/locations/methods/get' - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - insert: [] - update: [] - replace: [] - delete: [] + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: datasets: id: google.aiplatform.datasets name: datasets title: Datasets methods: - create: + list: operation: - $ref: '#/paths/~1v1~1datasets/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.datasets + create: operation: - $ref: '#/paths/~1v1~1datasets/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.datasets - get: + delete: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}/patch' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}/delete' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/get response: mediaType: application/json openAPIDocKey: '200' - import: + search_data_items: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:searchDataItems/get response: mediaType: application/json openAPIDocKey: '200' - export: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:import/post response: mediaType: application/json openAPIDocKey: '200' - search_data_items: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:searchDataItems/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:export/post response: mediaType: application/json openAPIDocKey: '200' @@ -25170,44 +25014,46 @@ components: name: dataset_versions title: Dataset_versions methods: - delete: + get: operation: $ref: >- - #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - restore: + create: operation: $ref: >- - #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}:restore/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.datasetVersions - create: + restore: operation: - $ref: '#/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}:restore/get response: mediaType: application/json openAPIDocKey: '200' @@ -25222,165 +25068,164 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/delete' - operations: - id: google.aiplatform.operations - name: operations - title: Operations + models: + id: google.aiplatform.models + name: models + title: Models methods: - cancel: + stream_generate_content: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamGenerateContent/post + response: + mediaType: application/json + openAPIDocKey: '200' + generate_content: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:generateContent/post response: mediaType: application/json openAPIDocKey: '200' - wait: + count_tokens: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:countTokens/post + response: + mediaType: application/json + openAPIDocKey: '200' + compute_tokens: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}:wait/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:computeTokens/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + merge_version_aliases: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:mergeVersionAliases/post + response: + mediaType: application/json + openAPIDocKey: '200' + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:export/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] - replace: [] + objectKey: $.models delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - annotation_specs: - id: google.aiplatform.annotation_specs - name: annotation_specs - title: Annotation_specs - methods: - get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1annotationSpecs~1{annotationSpecsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/annotation_specs/methods/get' - insert: [] - update: [] - replace: [] - delete: [] - annotations: - id: google.aiplatform.annotations - name: annotations - title: Annotations - methods: - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems~1{dataItemsId}~1annotations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.annotations - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/annotations/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - data_items: - id: google.aiplatform.data_items - name: data_items - title: Data_items - methods: - list: + copy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:copy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataItems - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/data_items/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - saved_queries: - id: google.aiplatform.saved_queries - name: saved_queries - title: Saved_queries - methods: - delete: + stream_raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries~1{savedQueriesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamRawPredict/post response: mediaType: application/json openAPIDocKey: '200' - list: + predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predict/post + response: + mediaType: application/json + openAPIDocKey: '200' + server_streaming_predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:serverStreamingPredict/post + response: + mediaType: application/json + openAPIDocKey: '200' + raw_predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:rawPredict/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.savedQueries sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' + - $ref: '#/components/x-stackQL-resources/models/methods/get' + - $ref: '#/components/x-stackQL-resources/models/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/models/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' + - $ref: '#/components/x-stackQL-resources/models/methods/delete' endpoints: id: google.aiplatform.endpoints name: endpoints title: Endpoints methods: - generate_content: + stream_generate_content: operation: - $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:generateContent/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamGenerateContent/post response: mediaType: application/json openAPIDocKey: '200' - predict: + count_tokens: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:countTokens/post response: mediaType: application/json openAPIDocKey: '200' - create: + compute_tokens: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:computeTokens/post + response: + mediaType: application/json + openAPIDocKey: '200' + generate_content: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:generateContent/post response: mediaType: application/json openAPIDocKey: '200' @@ -25392,23 +25237,24 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.endpoints - count_tokens: + create: operation: - $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:countTokens/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/post response: mediaType: application/json openAPIDocKey: '200' - raw_predict: + server_streaming_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:rawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:serverStreamingPredict/post response: mediaType: application/json openAPIDocKey: '200' - delete: + direct_raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directRawPredict/post response: mediaType: application/json openAPIDocKey: '200' @@ -25419,31 +25265,31 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/delete response: mediaType: application/json openAPIDocKey: '200' - server_streaming_predict: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:serverStreamingPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/get response: mediaType: application/json openAPIDocKey: '200' - undeploy_model: + stream_raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:undeployModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamRawPredict/post response: mediaType: application/json openAPIDocKey: '200' - deploy_model: + raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:deployModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:rawPredict/post response: mediaType: application/json openAPIDocKey: '200' @@ -25454,17 +25300,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - mutate_deployed_model: + predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:mutateDeployedModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post response: mediaType: application/json openAPIDocKey: '200' - stream_raw_predict: + deploy_model: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:deployModel/post response: mediaType: application/json openAPIDocKey: '200' @@ -25475,22 +25321,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - compute_tokens: - operation: - $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:computeTokens/post' - response: - mediaType: application/json - openAPIDocKey: '200' - stream_generate_content: + mutate_deployed_model: operation: - $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:streamGenerateContent/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:mutateDeployedModel/post response: mediaType: application/json openAPIDocKey: '200' - direct_raw_predict: + undeploy_model: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:undeployModel/post response: mediaType: application/json openAPIDocKey: '200' @@ -25505,285 +25346,327 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' - schedules: - id: google.aiplatform.schedules - name: schedules - title: Schedules + slices: + id: google.aiplatform.slices + name: slices + title: Slices methods: - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.modelEvaluationSlices + batch_import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}:batchImport/post response: mediaType: application/json openAPIDocKey: '200' - pause: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/slices/methods/get' + - $ref: '#/components/x-stackQL-resources/slices/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.aiplatform.operations + name: operations + title: Operations + methods: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:pause/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + wait: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}~1operations~1{operationsId}:wait/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.schedules - resume: + objectKey: $.operations + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:resume/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/schedules/methods/get' - - $ref: '#/components/x-stackQL-resources/schedules/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/schedules/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/schedules/methods/patch' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' - specialist_pools: - id: google.aiplatform.specialist_pools - name: specialist_pools - title: Specialist_pools + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + evaluations: + id: google.aiplatform.evaluations + name: evaluations + title: Evaluations methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.modelEvaluations + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations:import/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.specialistPools - create: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' + - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + models_version: + id: google.aiplatform.models_version + name: models_version + title: Models_version + methods: + delete_version: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:deleteVersion/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/get' - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/patch' + select: [] + insert: [] + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/delete' - notebook_execution_jobs: - id: google.aiplatform.notebook_execution_jobs - name: notebook_execution_jobs - title: Notebook_execution_jobs + - $ref: >- + #/components/x-stackQL-resources/models_version/methods/delete_version + models_iam_policies: + id: google.aiplatform.models_iam_policies + name: models_iam_policies + title: Models_iam_policies methods: - get: + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - delete: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - create: + objectKey: $.bindings + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/models_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/models_iam_policies/methods/set_iam_policy + delete: [] + models_versions: + id: google.aiplatform.models_versions + name: models_versions + title: Models_versions + methods: + list_versions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listVersions/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notebookExecutionJobs + objectKey: $.models sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/notebook_execution_jobs/methods/get - - $ref: >- - #/components/x-stackQL-resources/notebook_execution_jobs/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/notebook_execution_jobs/methods/create + #/components/x-stackQL-resources/models_versions/methods/list_versions + insert: [] update: [] replace: [] - delete: + delete: [] + models_explanation_dataset: + id: google.aiplatform.models_explanation_dataset + name: models_explanation_dataset + title: Models_explanation_dataset + methods: + update_explanation_dataset: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/notebook_execution_jobs/methods/delete - feature_groups: - id: google.aiplatform.feature_groups - name: feature_groups - title: Feature_groups + #/components/x-stackQL-resources/models_explanation_dataset/methods/update_explanation_dataset + replace: [] + delete: [] + persistent_resources: + id: google.aiplatform.persistent_resources + name: persistent_resources + title: Persistent_resources methods: - create: + reboot: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}:reboot/post response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureGroups get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' - operations_wait: - id: google.aiplatform.operations_wait - name: operations_wait - title: Operations_wait - methods: - list_wait: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1operations~1{operationsId}:wait/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations + objectKey: $.persistentResources sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' - insert: [] - update: [] + - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/get' + - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/patch replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/delete features: id: google.aiplatform.features name: features title: Features methods: - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features~1{featuresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/patch response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features~1{featuresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features~1{featuresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.features - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.features batch_create: operation: $ref: >- @@ -25796,522 +25679,670 @@ components: - $ref: '#/components/x-stackQL-resources/features/methods/get' - $ref: '#/components/x-stackQL-resources/features/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/features/methods/batch_create' - $ref: '#/components/x-stackQL-resources/features/methods/create' + - $ref: '#/components/x-stackQL-resources/features/methods/batch_create' update: - $ref: '#/components/x-stackQL-resources/features/methods/patch' replace: [] delete: - $ref: '#/components/x-stackQL-resources/features/methods/delete' - model_deployment_monitoring_jobs: - id: google.aiplatform.model_deployment_monitoring_jobs - name: model_deployment_monitoring_jobs - title: Model_deployment_monitoring_jobs + entity_types_iam_policies: + id: google.aiplatform.entity_types_iam_policies + name: entity_types_iam_policies + title: Entity_types_iam_policies methods: - get: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entity_types_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entity_types_iam_policies/methods/set_iam_policy + delete: [] + entity_types: + id: google.aiplatform.entity_types + name: entity_types + title: Entity_types + methods: patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - pause: + import_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:pause/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:importFeatureValues/post + response: + mediaType: application/json + openAPIDocKey: '200' + export_feature_values: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:exportFeatureValues/post + response: + mediaType: application/json + openAPIDocKey: '200' + streaming_read_feature_values: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:streamingReadFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelDeploymentMonitoringJobs + objectKey: $.entityTypes create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/post response: mediaType: application/json openAPIDocKey: '200' - resume: + read_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:resume/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:readFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - search_model_deployment_monitoring_stats_anomalies: + write_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:writeFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/get - - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/list + - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' + - $ref: '#/components/x-stackQL-resources/entity_types/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/create + - $ref: '#/components/x-stackQL-resources/entity_types/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/patch + - $ref: '#/components/x-stackQL-resources/entity_types/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/entity_types/methods/delete' + entity_types_feature_values: + id: google.aiplatform.entity_types_feature_values + name: entity_types_feature_values + title: Entity_types_feature_values + methods: + delete_feature_values: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/delete - feature_views_iam_policies: - id: google.aiplatform.feature_views_iam_policies - name: feature_views_iam_policies - title: Feature_views_iam_policies + #/components/x-stackQL-resources/entity_types_feature_values/methods/delete_feature_values + featurestores: + id: google.aiplatform.featurestores + name: featurestores + title: Featurestores methods: - get_iam_policy: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/get response: mediaType: application/json openAPIDocKey: '200' - set_iam_policy: + objectKey: $.featurestores + search_features: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores:searchFeatures/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/feature_views_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/feature_views_iam_policies/methods/set_iam_policy - delete: [] - feature_views: - id: google.aiplatform.feature_views - name: feature_views - title: Feature_views - methods: delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/get response: mediaType: application/json openAPIDocKey: '200' - search_nearest_entities: + batch_read_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:searchNearestEntities/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:batchReadFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - create: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/get' + - $ref: '#/components/x-stackQL-resources/featurestores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/delete' + featurestores_iam_policies: + id: google.aiplatform.featurestores_iam_policies + name: featurestores_iam_policies + title: Featurestores_iam_policies + methods: + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - list: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureViews - sync: + objectKey: $.bindings + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:sync/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_views/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/delete' - feature_views_feature_values: - id: google.aiplatform.feature_views_feature_values - name: feature_views_feature_values - title: Feature_views_feature_values + - $ref: >- + #/components/x-stackQL-resources/featurestores_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/featurestores_iam_policies/methods/set_iam_policy + delete: [] + annotation_specs: + id: google.aiplatform.annotation_specs + name: annotation_specs + title: Annotation_specs methods: - fetch_feature_values: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1annotationSpecs~1{annotationSpecsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/feature_views_feature_values/methods/fetch_feature_values + - $ref: '#/components/x-stackQL-resources/annotation_specs/methods/get' insert: [] update: [] replace: [] delete: [] - feature_view_syncs: - id: google.aiplatform.feature_view_syncs - name: feature_view_syncs - title: Feature_view_syncs + data_items: + id: google.aiplatform.data_items + name: data_items + title: Data_items methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureViewSyncs - get: + objectKey: $.dataItems + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/data_items/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + annotations: + id: google.aiplatform.annotations + name: annotations + title: Annotations + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs~1{featureViewSyncsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems~1{dataItemsId}~1annotations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.annotations sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/list' + - $ref: '#/components/x-stackQL-resources/annotations/methods/list' insert: [] update: [] replace: [] delete: [] - feature_online_stores: - id: google.aiplatform.feature_online_stores - name: feature_online_stores - title: Feature_online_stores + saved_queries: + id: google.aiplatform.saved_queries + name: saved_queries + title: Saved_queries methods: - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.savedQueries + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries~1{savedQueriesId}/delete response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' + insert: [] + update: [] + replace: [] delete: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' + tuning_jobs: + id: google.aiplatform.tuning_jobs + name: tuning_jobs + title: Tuning_jobs + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}/get response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureOnlineStores + objectKey: $.tuningJobs create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/post + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_online_stores/methods/get' - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/list + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/create - update: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/patch + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/create' + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/delete - feature_online_stores_iam_policies: - id: google.aiplatform.feature_online_stores_iam_policies - name: feature_online_stores_iam_policies - title: Feature_online_stores_iam_policies + delete: [] + feature_view_syncs: + id: google.aiplatform.feature_view_syncs + name: feature_view_syncs + title: Feature_view_syncs methods: - get_iam_policy: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs~1{featureViewSyncsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs/get response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + objectKey: $.featureViewSyncs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations_wait: + id: google.aiplatform.operations_wait + name: operations_wait + title: Operations_wait + methods: + list_wait: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}~1operations~1{operationsId}:wait/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/get_iam_policy + - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/set_iam_policy + replace: [] delete: [] - batch_prediction_jobs: - id: google.aiplatform.batch_prediction_jobs - name: batch_prediction_jobs - title: Batch_prediction_jobs + feature_views_iam_policies: + id: google.aiplatform.feature_views_iam_policies + name: feature_views_iam_policies + title: Feature_views_iam_policies methods: - cancel: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.bindings + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_views_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/feature_views_iam_policies/methods/set_iam_policy + delete: [] + feature_views: + id: google.aiplatform.feature_views + name: feature_views + title: Feature_views + methods: delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.batchPredictionJobs - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/batch_prediction_jobs/methods/get' - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/delete - entity_types: - id: google.aiplatform.entity_types - name: entity_types - title: Entity_types - methods: - import_feature_values: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:importFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/get response: mediaType: application/json openAPIDocKey: '200' - streaming_read_feature_values: + objectKey: $.featureViews + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:streamingReadFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/post response: mediaType: application/json openAPIDocKey: '200' - list: + search_nearest_entities: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:searchNearestEntities/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.entityTypes - create: + sync: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:sync/post response: mediaType: application/json openAPIDocKey: '200' - export_feature_values: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/delete' + feature_views_feature_values: + id: google.aiplatform.feature_views_feature_values + name: feature_views_feature_values + title: Feature_views_feature_values + methods: + fetch_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:exportFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_views_feature_values/methods/fetch_feature_values + insert: [] + update: [] + replace: [] + delete: [] + feature_online_stores: + id: google.aiplatform.feature_online_stores + name: feature_online_stores + title: Feature_online_stores + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.featureOnlineStores + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/post response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/patch response: mediaType: application/json openAPIDocKey: '200' - read_feature_values: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:readFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/get response: mediaType: application/json openAPIDocKey: '200' - write_feature_values: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:writeFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' - - $ref: '#/components/x-stackQL-resources/entity_types/methods/list' + - $ref: '#/components/x-stackQL-resources/feature_online_stores/methods/get' + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/list insert: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/create' + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/create update: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/delete' - entity_types_iam_policies: - id: google.aiplatform.entity_types_iam_policies - name: entity_types_iam_policies - title: Entity_types_iam_policies + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/delete + feature_online_stores_iam_policies: + id: google.aiplatform.feature_online_stores_iam_policies + name: feature_online_stores_iam_policies + title: Feature_online_stores_iam_policies methods: - get_iam_policy: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.bindings set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entity_types_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/entity_types_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/set_iam_policy delete: [] - entity_types_feature_values: - id: google.aiplatform.entity_types_feature_values - name: entity_types_feature_values - title: Entity_types_feature_values + migratable_resources: + id: google.aiplatform.migratable_resources + name: migratable_resources + title: Migratable_resources methods: - delete_feature_values: + batch_migrate: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:batchMigrate/post + response: + mediaType: application/json + openAPIDocKey: '200' + search: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:search/post response: mediaType: application/json openAPIDocKey: '200' @@ -26320,742 +26351,674 @@ components: insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/entity_types_feature_values/methods/delete_feature_values - featurestores: - id: google.aiplatform.featurestores - name: featurestores - title: Featurestores + delete: [] + pipeline_jobs: + id: google.aiplatform.pipeline_jobs + name: pipeline_jobs + title: Pipeline_jobs methods: - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/post response: mediaType: application/json openAPIDocKey: '200' - batch_read_feature_values: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:batchReadFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.pipelineJobs + batch_cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchCancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featurestores - create: + batch_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchDelete/post response: mediaType: application/json openAPIDocKey: '200' - search_features: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores:searchFeatures/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/get' - - $ref: '#/components/x-stackQL-resources/featurestores/methods/list' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/patch' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/delete' - featurestores_iam_policies: - id: google.aiplatform.featurestores_iam_policies - name: featurestores_iam_policies - title: Featurestores_iam_policies + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/pipeline_jobs/methods/batch_delete + model_deployment_monitoring_jobs: + id: google.aiplatform.model_deployment_monitoring_jobs + name: model_deployment_monitoring_jobs + title: Model_deployment_monitoring_jobs methods: - get_iam_policy: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/patch response: mediaType: application/json openAPIDocKey: '200' - set_iam_policy: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/featurestores_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/featurestores_iam_policies/methods/set_iam_policy - delete: [] - trials_trial_measurement: - id: google.aiplatform.trials_trial_measurement - name: trials_trial_measurement - title: Trials_trial_measurement - methods: - add_trial_measurement: + pause: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:pause/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/trials_trial_measurement/methods/add_trial_measurement - update: [] - replace: [] - delete: [] - trials: - id: google.aiplatform.trials - name: trials - title: Trials - methods: - complete: + resume: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:complete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:resume/post response: mediaType: application/json openAPIDocKey: '200' - suggest: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:suggest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.trials - create: + objectKey: $.modelDeploymentMonitoringJobs + search_model_deployment_monitoring_stats_anomalies: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies/post response: mediaType: application/json openAPIDocKey: '200' - stop: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/get + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/delete + nas_jobs: + id: google.aiplatform.nas_jobs + name: nas_jobs + title: Nas_jobs + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:stop/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/get response: mediaType: application/json openAPIDocKey: '200' - check_trial_early_stopping_state: + objectKey: $.nasJobs + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:checkTrialEarlyStoppingState/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/post + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/trials/methods/get' - - $ref: '#/components/x-stackQL-resources/trials/methods/list' + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/trials/methods/create' + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/create' update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/trials/methods/delete' - trials_optimal_trials: - id: google.aiplatform.trials_optimal_trials - name: trials_optimal_trials - title: Trials_optimal_trials + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/delete' + nas_trial_details: + id: google.aiplatform.nas_trial_details + name: nas_trial_details + title: Nas_trial_details methods: - list_optimal_trials: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:listOptimalTrials/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.nasTrialDetails + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails~1{nasTrialDetailsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/trials_optimal_trials/methods/list_optimal_trials + - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/get' + - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/list' insert: [] update: [] replace: [] delete: [] - studies: - id: google.aiplatform.studies - name: studies - title: Studies + custom_jobs: + id: google.aiplatform.custom_jobs + name: custom_jobs + title: Custom_jobs methods: - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.customJobs + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.studies - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - lookup: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies:lookup/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/studies/methods/get' - - $ref: '#/components/x-stackQL-resources/studies/methods/list' + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/studies/methods/create' + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/create' update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/studies/methods/delete' - tensorboards: - id: google.aiplatform.tensorboards - name: tensorboards - title: Tensorboards + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/delete' + schedules: + id: google.aiplatform.schedules + name: schedules + title: Schedules methods: - read_size: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readSize/get - response: - mediaType: application/json - openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboards - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/get response: mediaType: application/json openAPIDocKey: '200' - read_usage: + objectKey: $.schedules + resume: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readUsage/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:resume/post response: mediaType: application/json openAPIDocKey: '200' - batch_read: + pause: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:batchRead/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:pause/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/get' - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/list' + - $ref: '#/components/x-stackQL-resources/schedules/methods/get' + - $ref: '#/components/x-stackQL-resources/schedules/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/create' + - $ref: '#/components/x-stackQL-resources/schedules/methods/create' update: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/patch' + - $ref: '#/components/x-stackQL-resources/schedules/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/delete' - time_series: - id: google.aiplatform.time_series - name: time_series - title: Time_series + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' + specialist_pools: + id: google.aiplatform.specialist_pools + name: specialist_pools + title: Specialist_pools methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.tensorboardTimeSeries - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/post - response: - mediaType: application/json - openAPIDocKey: '200' - read_blob_data: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:readBlobData/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - read: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:read/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/get response: mediaType: application/json openAPIDocKey: '200' - export_tensorboard_time_series: + objectKey: $.specialistPools + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:exportTensorboardTimeSeries/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/time_series/methods/get' - - $ref: '#/components/x-stackQL-resources/time_series/methods/list' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/time_series/methods/create' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/create' update: - - $ref: '#/components/x-stackQL-resources/time_series/methods/patch' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/time_series/methods/delete' - runs: - id: google.aiplatform.runs - name: runs - title: Runs + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/delete' + deployment_resource_pools: + id: google.aiplatform.deployment_resource_pools + name: deployment_resource_pools + title: Deployment_resource_pools methods: - write: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}:write/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - batch_create: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/post response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.deploymentResourcePools + query_deployed_models: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}:queryDeployedModels/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboardRuns sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/runs/methods/get' - - $ref: '#/components/x-stackQL-resources/runs/methods/list' + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/get + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/query_deployed_models + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/list insert: - - $ref: '#/components/x-stackQL-resources/runs/methods/batch_create' - - $ref: '#/components/x-stackQL-resources/runs/methods/create' + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/create update: - - $ref: '#/components/x-stackQL-resources/runs/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/runs/methods/delete' - experiments: - id: google.aiplatform.experiments - name: experiments - title: Experiments + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/delete + data_labeling_jobs: + id: google.aiplatform.data_labeling_jobs + name: data_labeling_jobs + title: Data_labeling_jobs methods: - write: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:write/post - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.dataLabelingJobs + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/post response: mediaType: application/json openAPIDocKey: '200' - batch_create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboardExperiments sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/experiments/methods/get' - - $ref: '#/components/x-stackQL-resources/experiments/methods/list' + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/experiments/methods/batch_create' - - $ref: '#/components/x-stackQL-resources/experiments/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/experiments/methods/patch' + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/experiments/methods/delete' - tuning_jobs: - id: google.aiplatform.tuning_jobs - name: tuning_jobs - title: Tuning_jobs + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/delete' + batch_prediction_jobs: + id: google.aiplatform.batch_prediction_jobs + name: batch_prediction_jobs + title: Batch_prediction_jobs methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - cancel: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.batchPredictionJobs + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tuningJobs sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/batch_prediction_jobs/methods/get' + - $ref: >- + #/components/x-stackQL-resources/batch_prediction_jobs/methods/list insert: - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/create' + - $ref: >- + #/components/x-stackQL-resources/batch_prediction_jobs/methods/create update: [] replace: [] - delete: [] - notebook_runtimes: - id: google.aiplatform.notebook_runtimes - name: notebook_runtimes - title: Notebook_runtimes + delete: + - $ref: >- + #/components/x-stackQL-resources/batch_prediction_jobs/methods/delete + notebook_execution_jobs: + id: google.aiplatform.notebook_execution_jobs + name: notebook_execution_jobs + title: Notebook_execution_jobs methods: - assign: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes:assign/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - start: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:start/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - upgrade: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:upgrade/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.notebookRuntimes - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.notebookExecutionJobs sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/get' - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/list' - insert: [] + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/get + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/create update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/delete' - persistent_resources: - id: google.aiplatform.persistent_resources - name: persistent_resources - title: Persistent_resources + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/delete + hyperparameter_tuning_jobs: + id: google.aiplatform.hyperparameter_tuning_jobs + name: hyperparameter_tuning_jobs + title: Hyperparameter_tuning_jobs methods: - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - reboot: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}:reboot/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.hyperparameterTuningJobs create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/post response: mediaType: application/json openAPIDocKey: '200' - list: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.persistentResources sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/get' - - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/list' - insert: - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/create - update: + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/get - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/patch - replace: [] - delete: + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/list + insert: - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/delete - migratable_resources: - id: google.aiplatform.migratable_resources - name: migratable_resources - title: Migratable_resources - methods: - batch_migrate: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:batchMigrate/post - response: - mediaType: application/json - openAPIDocKey: '200' - search: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:search/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/create update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/delete notebook_runtime_templates_iam_policies: id: google.aiplatform.notebook_runtime_templates_iam_policies name: notebook_runtime_templates_iam_policies @@ -27068,21 +27031,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - get_iam_policy: + objectKey: $.bindings + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings sqlVerbs: select: - $ref: >- @@ -27098,39 +27061,39 @@ components: name: notebook_runtime_templates title: Notebook_runtime_templates methods: - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notebookRuntimeTemplates - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.notebookRuntimeTemplates + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/post response: mediaType: application/json openAPIDocKey: '200' @@ -27150,391 +27113,501 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/notebook_runtime_templates/methods/delete - index_endpoints: - id: google.aiplatform.index_endpoints - name: index_endpoints - title: Index_endpoints + tensorboards: + id: google.aiplatform.tensorboards + name: tensorboards + title: Tensorboards methods: - undeploy_index: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:undeployIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/post response: mediaType: application/json openAPIDocKey: '200' - deploy_index: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:deployIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tensorboards + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + read_usage: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readUsage/get response: mediaType: application/json openAPIDocKey: '200' - read_index_datapoints: + read_size: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:readIndexDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readSize/get response: mediaType: application/json openAPIDocKey: '200' - mutate_deployed_index: + batch_read: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:mutateDeployedIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:batchRead/get response: mediaType: application/json openAPIDocKey: '200' - find_neighbors: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/get' + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/delete' + runs: + id: google.aiplatform.runs + name: runs + title: Runs + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:findNeighbors/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.tensorboardRuns create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/post response: mediaType: application/json openAPIDocKey: '200' - list: + batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + write: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}:write/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.indexEndpoints sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/get' - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/list' + - $ref: '#/components/x-stackQL-resources/runs/methods/get' + - $ref: '#/components/x-stackQL-resources/runs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/create' + - $ref: '#/components/x-stackQL-resources/runs/methods/create' + - $ref: '#/components/x-stackQL-resources/runs/methods/batch_create' update: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/patch' + - $ref: '#/components/x-stackQL-resources/runs/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/delete' - data_labeling_jobs: - id: google.aiplatform.data_labeling_jobs - name: data_labeling_jobs - title: Data_labeling_jobs + - $ref: '#/components/x-stackQL-resources/runs/methods/delete' + time_series: + id: google.aiplatform.time_series + name: time_series + title: Time_series methods: + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/get response: mediaType: application/json openAPIDocKey: '200' - cancel: + read_blob_data: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:readBlobData/get response: mediaType: application/json openAPIDocKey: '200' - list: + export_tensorboard_time_series: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:exportTensorboardTimeSeries/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataLabelingJobs create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tensorboardTimeSeries + read: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:read/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/time_series/methods/get' + - $ref: '#/components/x-stackQL-resources/time_series/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/time_series/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/time_series/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/delete' - custom_jobs: - id: google.aiplatform.custom_jobs - name: custom_jobs - title: Custom_jobs + - $ref: '#/components/x-stackQL-resources/time_series/methods/delete' + experiments: + id: google.aiplatform.experiments + name: experiments + title: Experiments methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tensorboardExperiments create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/post response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customJobs get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + write: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:write/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/experiments/methods/get' + - $ref: '#/components/x-stackQL-resources/experiments/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/experiments/methods/batch_create' + - $ref: '#/components/x-stackQL-resources/experiments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/experiments/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/delete' - training_pipelines: - id: google.aiplatform.training_pipelines - name: training_pipelines - title: Training_pipelines + - $ref: '#/components/x-stackQL-resources/experiments/methods/delete' + trials: + id: google.aiplatform.trials + name: trials + title: Trials methods: + complete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:complete/post + response: + mediaType: application/json + openAPIDocKey: '200' + check_trial_early_stopping_state: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:checkTrialEarlyStoppingState/post + response: + mediaType: application/json + openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.trainingPipelines + objectKey: $.trials get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/delete response: mediaType: application/json openAPIDocKey: '200' - cancel: + suggest: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:suggest/post + response: + mediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:stop/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/trials/methods/get' + - $ref: '#/components/x-stackQL-resources/trials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/trials/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/trials/methods/delete' + trials_optimal_trials: + id: google.aiplatform.trials_optimal_trials + name: trials_optimal_trials + title: Trials_optimal_trials + methods: + list_optimal_trials: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:listOptimalTrials/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/trials_optimal_trials/methods/list_optimal_trials + insert: [] + update: [] + replace: [] + delete: [] + trials_trial_measurement: + id: google.aiplatform.trials_trial_measurement + name: trials_trial_measurement + title: Trials_trial_measurement + methods: + add_trial_measurement: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/get' - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/list' + select: [] insert: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/create' + - $ref: >- + #/components/x-stackQL-resources/trials_trial_measurement/methods/add_trial_measurement update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/delete' - deployment_resource_pools: - id: google.aiplatform.deployment_resource_pools - name: deployment_resource_pools - title: Deployment_resource_pools + delete: [] + studies: + id: google.aiplatform.studies + name: studies + title: Studies methods: - list: + lookup: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies:lookup/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deploymentResourcePools create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/post response: mediaType: application/json openAPIDocKey: '200' - query_deployed_models: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}:queryDeployedModels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.studies delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/query_deployed_models - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/get - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/list + - $ref: '#/components/x-stackQL-resources/studies/methods/get' + - $ref: '#/components/x-stackQL-resources/studies/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/create - update: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/patch + - $ref: '#/components/x-stackQL-resources/studies/methods/create' + update: [] replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/delete - indexes: - id: google.aiplatform.indexes - name: indexes - title: Indexes + - $ref: '#/components/x-stackQL-resources/studies/methods/delete' + feature_groups: + id: google.aiplatform.feature_groups + name: feature_groups + title: Feature_groups methods: - upsert_datapoints: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:upsertDatapoints/post - response: - mediaType: application/json - openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.indexes + objectKey: $.featureGroups create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/indexes/methods/get' - - $ref: '#/components/x-stackQL-resources/indexes/methods/list' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/indexes/methods/create' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' update: - - $ref: '#/components/x-stackQL-resources/indexes/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' - indexes_datapoints: - id: google.aiplatform.indexes_datapoints - name: indexes_datapoints - title: Indexes_datapoints - methods: - remove_datapoints: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/indexes_datapoints/methods/remove_datapoints + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' metadata_stores: id: google.aiplatform.metadata_stores name: metadata_stores @@ -27579,94 +27652,26 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/delete' - artifacts: - id: google.aiplatform.artifacts - name: artifacts - title: Artifacts - methods: - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - purge: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts:purge/post - response: - mediaType: application/json - openAPIDocKey: '200' - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.artifacts - query_artifact_lineage_subgraph: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}:queryArtifactLineageSubgraph/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/get' - - $ref: >- - #/components/x-stackQL-resources/artifacts/methods/query_artifact_lineage_subgraph - - $ref: '#/components/x-stackQL-resources/artifacts/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' metadata_schemas: id: google.aiplatform.metadata_schemas name: metadata_schemas title: Metadata_schemas methods: - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.metadataSchemas + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.metadataSchemas get: operation: $ref: >- @@ -27688,31 +27693,31 @@ components: name: contexts title: Contexts methods: - query_context_lineage_subgraph: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:queryContextLineageSubgraph/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + query_context_lineage_subgraph: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:queryContextLineageSubgraph/get response: mediaType: application/json openAPIDocKey: '200' @@ -27740,9 +27745,9 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/contexts/methods/get' - $ref: >- #/components/x-stackQL-resources/contexts/methods/query_context_lineage_subgraph - - $ref: '#/components/x-stackQL-resources/contexts/methods/get' - $ref: '#/components/x-stackQL-resources/contexts/methods/list' insert: - $ref: '#/components/x-stackQL-resources/contexts/methods/create' @@ -27776,17 +27781,17 @@ components: name: contexts_context_children title: Contexts_context_children methods: - remove_context_children: + add_context_children: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:removeContextChildren/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post response: mediaType: application/json openAPIDocKey: '200' - add_context_children: + remove_context_children: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:removeContextChildren/post response: mediaType: application/json openAPIDocKey: '200' @@ -27800,18 +27805,39 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/contexts_context_children/methods/remove_context_children + executions_execution_events: + id: google.aiplatform.executions_execution_events + name: executions_execution_events + title: Executions_execution_events + methods: + add_execution_events: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:addExecutionEvents/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/executions_execution_events/methods/add_execution_events + update: [] + replace: [] + delete: [] executions: id: google.aiplatform.executions name: executions title: Executions methods: - query_execution_inputs_and_outputs: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.executions create: operation: $ref: >- @@ -27819,14 +27845,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions patch: operation: $ref: >- @@ -27834,32 +27859,32 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions:purge/post response: mediaType: application/json openAPIDocKey: '200' - purge: + query_execution_inputs_and_outputs: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/executions/methods/get' - $ref: >- #/components/x-stackQL-resources/executions/methods/query_execution_inputs_and_outputs - - $ref: '#/components/x-stackQL-resources/executions/methods/get' - $ref: '#/components/x-stackQL-resources/executions/methods/list' insert: - $ref: '#/components/x-stackQL-resources/executions/methods/create' @@ -27868,259 +27893,250 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/executions/methods/delete' - executions_execution_events: - id: google.aiplatform.executions_execution_events - name: executions_execution_events - title: Executions_execution_events + artifacts: + id: google.aiplatform.artifacts + name: artifacts + title: Artifacts methods: - add_execution_events: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:addExecutionEvents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/executions_execution_events/methods/add_execution_events - update: [] - replace: [] - delete: [] - pipeline_jobs: - id: google.aiplatform.pipeline_jobs - name: pipeline_jobs - title: Pipeline_jobs - methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - cancel: + purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts:purge/post response: mediaType: application/json openAPIDocKey: '200' - batch_cancel: + query_artifact_lineage_subgraph: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchCancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}:queryArtifactLineageSubgraph/get response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.pipelineJobs + objectKey: $.artifacts create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/post - response: - mediaType: application/json - openAPIDocKey: '200' - batch_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchDelete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/artifacts/methods/get' + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/query_artifact_lineage_subgraph + - $ref: '#/components/x-stackQL-resources/artifacts/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/artifacts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/artifacts/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' - - $ref: >- - #/components/x-stackQL-resources/pipeline_jobs/methods/batch_delete - nas_jobs: - id: google.aiplatform.nas_jobs - name: nas_jobs - title: Nas_jobs + - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' + notebook_runtimes: + id: google.aiplatform.notebook_runtimes + name: notebook_runtimes + title: Notebook_runtimes methods: - cancel: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.notebookRuntimes get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + assign: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes:assign/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nasJobs - create: + upgrade: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:upgrade/post + response: + mediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:start/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/create' + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/get' + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/list' + insert: [] update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/delete' - nas_trial_details: - id: google.aiplatform.nas_trial_details - name: nas_trial_details - title: Nas_trial_details + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/delete' + training_pipelines: + id: google.aiplatform.training_pipelines + name: training_pipelines + title: Training_pipelines methods: - list: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nasTrialDetails get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails~1{nasTrialDetailsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.trainingPipelines sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/get' - - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/list' - insert: [] + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/get' + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/create' update: [] replace: [] - delete: [] - models_iam_policies: - id: google.aiplatform.models_iam_policies - name: models_iam_policies - title: Models_iam_policies + delete: + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/delete' + indexes: + id: google.aiplatform.indexes + name: indexes + title: Indexes methods: - get_iam_policy: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/patch response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/models_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/models_iam_policies/methods/set_iam_policy - delete: [] - models_versions: - id: google.aiplatform.models_versions - name: models_versions - title: Models_versions - methods: - list_versions: + upsert_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listVersions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:upsertDatapoints/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.models - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/models_versions/methods/list_versions - insert: [] - update: [] - replace: [] - delete: [] - models_explanation_dataset: - id: google.aiplatform.models_explanation_dataset - name: models_explanation_dataset - title: Models_explanation_dataset - methods: - update_explanation_dataset: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.indexes + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/indexes/methods/get' + - $ref: '#/components/x-stackQL-resources/indexes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/indexes/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/models_explanation_dataset/methods/update_explanation_dataset + - $ref: '#/components/x-stackQL-resources/indexes/methods/patch' replace: [] - delete: [] - models_version: - id: google.aiplatform.models_version - name: models_version - title: Models_version + delete: + - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' + indexes_datapoints: + id: google.aiplatform.indexes_datapoints + name: indexes_datapoints + title: Indexes_datapoints methods: - delete_version: + remove_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:deleteVersion/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post response: mediaType: application/json openAPIDocKey: '200' @@ -28131,520 +28147,144 @@ components: replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/models_version/methods/delete_version - slices: - id: google.aiplatform.slices - name: slices - title: Slices + #/components/x-stackQL-resources/indexes_datapoints/methods/remove_datapoints + index_endpoints: + id: google.aiplatform.index_endpoints + name: index_endpoints + title: Index_endpoints methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.modelEvaluationSlices - batch_import: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}:batchImport/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/slices/methods/get' - - $ref: '#/components/x-stackQL-resources/slices/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - evaluations: - id: google.aiplatform.evaluations - name: evaluations - title: Evaluations - methods: - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/patch response: mediaType: application/json openAPIDocKey: '200' - import: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.indexEndpoints + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelEvaluations - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' - - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - hyperparameter_tuning_jobs: - id: google.aiplatform.hyperparameter_tuning_jobs - name: hyperparameter_tuning_jobs - title: Hyperparameter_tuning_jobs - methods: - get: + find_neighbors: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:findNeighbors/post response: mediaType: application/json openAPIDocKey: '200' - delete: + read_index_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:readIndexDatapoints/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + deploy_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:deployIndex/post response: mediaType: application/json openAPIDocKey: '200' - list: + undeploy_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:undeployIndex/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.hyperparameterTuningJobs - create: + mutate_deployed_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:mutateDeployedIndex/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/get - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/list + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/create - update: [] + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/patch' replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/delete -paths: - /v1/publishers/{publishersId}/models/{modelsId}:countTokens: - parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - post: - description: Perform a token counting. - operationId: aiplatform.publishers.models.countTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse - parameters: - - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.publishers.models.streamGenerateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse - parameters: - - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/publishers/{publishersId}/models/{modelsId}: - parameters: *ref_1 - get: - description: Gets a Model Garden publisher model. - operationId: aiplatform.publishers.models.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PublisherModel' - parameters: - - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: query - name: huggingFaceToken - schema: - type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: view - schema: - type: string - - in: query - name: isHuggingFaceModel - schema: - type: boolean - /v1/publishers/{publishersId}/models/{modelsId}:generateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs. - operationId: aiplatform.publishers.models.generateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse - parameters: - - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/publishers/{publishersId}/models/{modelsId}:computeTokens: - parameters: *ref_1 - post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.publishers.models.computeTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse - parameters: - - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances: - parameters: *ref_1 - post: - description: Evaluates instances based on a given metric. - operationId: aiplatform.projects.locations.evaluateInstances - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_1 - get: - description: Gets information about a location. - operationId: aiplatform.projects.locations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations: - parameters: *ref_1 - get: - description: Lists information about the supported locations for this service. - operationId: aiplatform.projects.locations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets: - parameters: *ref_1 - post: - description: Creates a Dataset. - operationId: aiplatform.projects.locations.datasets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - get: - description: Lists Datasets in a Location. - operationId: aiplatform.projects.locations.datasets.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: - parameters: *ref_1 + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/delete' + locations: + id: google.aiplatform.locations + name: locations + title: Locations + methods: + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + evaluate_instances: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:evaluateInstances/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1/datasets: + parameters: &ref_1 + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' get: - description: Gets a Dataset. - operationId: aiplatform.projects.locations.datasets.get + description: Lists Datasets in a Location. + operationId: aiplatform.datasets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28656,21 +28296,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: datasetsId - required: true + - in: query + name: parent schema: type: string - in: query @@ -28678,9 +28312,22 @@ paths: schema: type: string format: google-fieldmask - patch: - description: Updates a Dataset. - operationId: aiplatform.projects.locations.datasets.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a Dataset. + operationId: aiplatform.datasets.create requestBody: content: application/json: @@ -28697,31 +28344,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - in: query - name: updateMask + name: parent schema: type: string - format: google-fieldmask + /v1/datasets/{datasetsId}: + parameters: *ref_1 delete: description: Deletes a Dataset. - operationId: aiplatform.projects.locations.datasets.delete + operationId: aiplatform.datasets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28735,31 +28368,19 @@ paths: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: - parameters: *ref_1 - post: - description: Imports data into a Dataset. - operationId: aiplatform.projects.locations.datasets.import + patch: + description: Updates a Dataset. + operationId: aiplatform.datasets.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28771,33 +28392,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: datasetsId required: true schema: type: string - - in: path - name: datasetsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: - parameters: *ref_1 - post: - description: Exports data from a Dataset. - operationId: aiplatform.projects.locations.datasets.export - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' + format: google-fieldmask + get: + description: Gets a Dataset. + operationId: aiplatform.datasets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28809,28 +28418,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: datasetsId required: true schema: type: string - - in: path - name: datasetsId - required: true + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: + format: google-fieldmask + /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: parameters: *ref_1 get: - description: Searches DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.searchDataItems + description: Gets a Dataset version. + operationId: aiplatform.datasets.datasetVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28842,84 +28446,26 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: datasetsId required: true schema: type: string - in: path - name: datasetsId + name: datasetVersionsId required: true schema: type: string - in: query - name: orderBy - schema: - type: string - - in: query - name: orderByAnnotation.orderBy - schema: - type: string - - in: query - name: dataItemFilter - schema: - type: string - - in: query - name: annotationsLimit - schema: - type: integer - format: int32 - - in: query - name: annotationFilters - schema: - type: string - - in: query - name: orderByDataItem - schema: - type: string - - in: query - name: savedQuery - schema: - type: string - - in: query - name: fieldMask + name: readMask schema: type: string format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: annotationsFilter - schema: - type: string - - in: query - name: dataLabelingJob - schema: - type: string - - in: query - name: orderByAnnotation.savedQuery - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: - parameters: *ref_1 delete: description: Deletes a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.delete + operationId: aiplatform.datasets.datasetVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28933,52 +28479,6 @@ paths: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: datasetVersionsId - required: true - schema: - type: string - get: - description: Gets a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path name: datasetsId required: true @@ -28989,14 +28489,9 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask patch: description: Updates a DatasetVersion. - operationId: aiplatform.projects.locations.datasets.datasetVersions.patch + operationId: aiplatform.datasets.datasetVersions.patch requestBody: content: application/json: @@ -29015,16 +28510,6 @@ paths: schema: $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path name: datasetsId required: true @@ -29040,11 +28525,16 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + /v1/datasets/{datasetsId}/datasetVersions: parameters: *ref_1 - get: - description: Restores a dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.restore + post: + description: Create a version from a Dataset. + operationId: aiplatform.datasets.datasetVersions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29058,31 +28548,14 @@ paths: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path name: datasetsId required: true schema: type: string - - in: path - name: datasetVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: - parameters: *ref_1 get: description: Lists DatasetVersions in a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.list + operationId: aiplatform.datasets.datasetVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29097,51 +28570,38 @@ paths: $ref: >- #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path name: datasetsId required: true schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query name: readMask schema: type: string format: google-fieldmask - in: query - name: filter + name: pageToken schema: type: string - in: query - name: orderBy + name: pageSize schema: - type: string - post: - description: Create a version from a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + type: integer + format: int32 + /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + parameters: *ref_1 + get: + description: Restores a dataset version. + operationId: aiplatform.datasets.datasetVersions.restore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29156,137 +28616,103 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: datasetsId required: true schema: type: string - in: path - name: datasetsId + name: datasetVersionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: + /v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.publishers.models.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: + /v1/publishers/{publishersId}/models/{modelsId}:generateContent: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.wait + description: Generate content with multimodal inputs. + operationId: aiplatform.publishers.models.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: + /v1/publishers/{publishersId}/models/{modelsId}:countTokens: parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.get + post: + description: Perform a token counting. + operationId: aiplatform.publishers.models.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29298,40 +28724,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.delete + /v1/publishers/{publishersId}/models/{modelsId}:computeTokens: + parameters: *ref_1 + post: + description: Return a list of tokens based on the input text. + operationId: aiplatform.publishers.models.computeTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29343,40 +28758,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: + /v1/publishers/{publishersId}/models/{modelsId}: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list + description: Gets a Model Garden publisher model. + operationId: aiplatform.publishers.models.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29388,92 +28787,78 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PublisherModel' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: publishersId required: true schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: path - name: annotationSpecsId - required: true + - in: query + name: view schema: type: string - in: query - name: filter + name: languageCode schema: type: string - in: query - name: pageSize + name: isHuggingFaceModel schema: - type: integer - format: int32 + type: boolean - in: query - name: pageToken + name: huggingFaceToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: + /v1/endpoints/{endpointsId}:streamGenerateContent: parameters: *ref_1 - get: - description: Gets an AnnotationSpec. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.get + post: + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.endpoints.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: endpointsId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: + /v1/endpoints/{endpointsId}:countTokens: parameters: *ref_1 - get: - description: >- - Lists Annotations belongs to a dataitem This RPC is only available in - InternalDatasetService. It is only used for exporting conversation data - to CCAI Insights. - operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list + post: + description: Perform a token counting. + operationId: aiplatform.endpoints.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29486,60 +28871,23 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: endpointsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: + /v1/endpoints/{endpointsId}:computeTokens: parameters: *ref_1 - 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`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete + post: + description: Return a list of tokens based on the input text. + operationId: aiplatform.endpoints.computeTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29551,103 +28899,53 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - required: true - schema: - type: string - - in: path - name: annotationsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: 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. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.get + /v1/endpoints/{endpointsId}:generateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs. + operationId: aiplatform.endpoints.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - required: true - schema: - type: string - - in: path - name: annotationsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: parameters: *ref_1 - post: - 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. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait + get: + description: Gets a ModelEvaluationSlice. + operationId: aiplatform.projects.locations.models.evaluations.slices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29659,7 +28957,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice parameters: - in: path name: projectsId @@ -29672,38 +28971,25 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: modelsId required: true schema: type: string - in: path - name: annotationsId + name: evaluationsId required: true schema: type: string - in: path - name: operationsId + name: slicesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.list + description: Lists ModelEvaluationSlices in a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.slices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29715,7 +29001,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse parameters: - in: path name: projectsId @@ -29728,24 +29015,15 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: modelsId required: true schema: type: string - in: path - name: annotationsId + name: evaluationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: @@ -29755,21 +29033,26 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: parameters: *ref_1 post: - 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`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel + description: Imports a list of externally generated EvaluatedAnnotations. + operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29781,7 +29064,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse parameters: - in: path name: projectsId @@ -29794,39 +29078,29 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: modelsId required: true schema: type: string - in: path - name: annotationsId + name: evaluationsId required: true schema: type: string - in: path - name: operationsId + name: slicesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: parameters: *ref_1 - post: + delete: 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`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.cancel + 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`. + operationId: aiplatform.projects.locations.models.evaluations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29851,12 +29125,12 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - in: path - name: dataItemsId + name: evaluationsId required: true schema: type: string @@ -29865,15 +29139,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}: - parameters: *ref_1 - delete: + get: 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`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.delete + 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. + operationId: aiplatform.projects.locations.models.evaluations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29885,7 +29156,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29898,12 +29169,12 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - in: path - name: dataItemsId + name: evaluationsId required: true schema: type: string @@ -29912,12 +29183,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.get + 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. + operationId: aiplatform.projects.locations.models.evaluations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29942,12 +29221,12 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - in: path - name: dataItemsId + name: evaluationsId required: true schema: type: string @@ -29956,13 +29235,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.list + operationId: aiplatform.projects.locations.models.evaluations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29987,21 +29271,21 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - in: path - name: dataItemsId + name: evaluationsId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -30009,20 +29293,20 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.wait + 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`. + operationId: aiplatform.projects.locations.models.evaluations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30034,7 +29318,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30047,12 +29331,12 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - in: path - name: dataItemsId + name: evaluationsId required: true schema: type: string @@ -30061,16 +29345,49 @@ paths: required: true schema: type: string - - in: query - name: timeout + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: + parameters: *ref_1 + get: + description: Gets a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + - in: path + name: evaluationsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: parameters: *ref_1 get: - description: Lists DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.dataItems.list + description: Lists ModelEvaluations in a Model. + operationId: aiplatform.projects.locations.models.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30083,7 +29400,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse parameters: - in: path name: projectsId @@ -30096,39 +29413,39 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query - name: orderBy + name: pageToken schema: type: string - in: query - name: filter + name: pageSize schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.operations.list + post: + description: Imports an externally generated ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30140,7 +29457,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' parameters: - in: path name: projectsId @@ -30153,24 +29470,11 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -30183,7 +29487,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.datasets.operations.cancel + operationId: aiplatform.projects.locations.models.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30208,7 +29512,7 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string @@ -30217,14 +29521,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.datasets.operations.get + operationId: aiplatform.projects.locations.models.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30249,7 +29553,7 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string @@ -30264,7 +29568,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.datasets.operations.delete + operationId: aiplatform.projects.locations.models.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30289,7 +29593,7 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string @@ -30298,20 +29602,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.datasets.operations.wait + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.models.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30323,7 +29620,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -30336,28 +29633,37 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: timeout + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get + 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. + operationId: aiplatform.projects.locations.models.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30382,27 +29688,31 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - in: path - name: savedQueriesId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string - 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`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: + parameters: *ref_1 + post: + description: Merges a set of aliases for a Model version. + operationId: aiplatform.projects.locations.models.mergeVersionAliases + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MergeVersionAliasesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30414,7 +29724,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -30427,34 +29737,20 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/models:upload: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.wait + description: Uploads a Model artifact into Vertex AI. + operationId: aiplatform.projects.locations.models.upload + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30478,33 +29774,19 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.list + 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. + operationId: aiplatform.projects.locations.models.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30516,7 +29798,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30529,42 +29811,18 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId + name: modelsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: parameters: *ref_1 - post: + delete: 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`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.cancel + 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. + operationId: aiplatform.projects.locations.models.deleteVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30576,7 +29834,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30589,25 +29847,15 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: + /v1/projects/{projectsId}/locations/{locationsId}/models: parameters: *ref_1 - delete: - description: Deletes a SavedQuery. - operationId: aiplatform.projects.locations.datasets.savedQueries.delete + get: + description: Lists Models in a Location. + operationId: aiplatform.projects.locations.models.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30619,7 +29867,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' parameters: - in: path name: projectsId @@ -30631,21 +29879,35 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: savedQueriesId - required: true + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: + format: google-fieldmask + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: parameters: *ref_1 - get: - description: Lists SavedQueries in a Dataset. - operationId: aiplatform.projects.locations.datasets.savedQueries.list + delete: + description: >- + Deletes a Model. A model cannot be deleted if any Endpoint resource has + a DeployedModel based on the model in its deployed_models field. + operationId: aiplatform.projects.locations.models.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30657,8 +29919,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30671,60 +29932,25 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.publishers.models.streamGenerateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + get: + description: Gets a Model. + operationId: aiplatform.projects.locations.models.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -30736,42 +29962,31 @@ paths: required: true schema: type: string - - in: path - name: publishersId - required: true - schema: - type: string - in: path name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: - parameters: *ref_1 - post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.publishers.models.predict + patch: + description: Updates a Model. + operationId: aiplatform.projects.locations.models.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -30784,43 +29999,40 @@ paths: schema: type: string - in: path - name: publishersId + name: modelsId required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: parameters: *ref_1 post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.publishers.models.generateContent + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.models.setIamPolicy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -30832,26 +30044,18 @@ paths: required: true schema: type: string - - in: path - name: publishersId - required: true - schema: - type: string - in: path name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: parameters: *ref_1 post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.projects.locations.publishers.models.computeTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.models.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30863,8 +30067,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -30876,26 +30079,21 @@ paths: required: true schema: type: string - - in: path - name: publishersId - required: true - schema: - type: string - in: path name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: parameters: *ref_1 - post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.publishers.models.countTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + get: + description: Lists versions of the specified model. + operationId: aiplatform.projects.locations.models.listVersions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30908,7 +30106,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse parameters: - in: path name: projectsId @@ -30921,45 +30119,55 @@ paths: schema: type: string - in: path - name: publishersId + name: modelsId required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: parameters: *ref_1 post: - description: >- - Perform a server-side streaming online prediction request for Vertex LLM - streaming. - operationId: aiplatform.projects.locations.publishers.models.serverStreamingPredict + description: Incrementally update the dataset used for an examples model. + operationId: aiplatform.projects.locations.models.updateExplanationDataset requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest + #/components/schemas/GoogleCloudAiplatformV1UpdateExplanationDatasetRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30971,47 +30179,33 @@ paths: required: true schema: type: string - - in: path - name: publishersId - required: true - schema: - type: string - in: path name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.publishers.models.rawPredict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + 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. + operationId: aiplatform.projects.locations.models.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -31024,42 +30218,41 @@ paths: schema: type: string - in: path - name: publishersId + name: modelsId required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: + /v1/projects/{projectsId}/locations/{locationsId}/models:copy: parameters: *ref_1 post: - description: Perform a streaming online prediction with an arbitrary HTTP payload. - operationId: aiplatform.projects.locations.publishers.models.streamRawPredict + description: >- + 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. + operationId: aiplatform.projects.locations.models.copy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31071,17 +30264,7 @@ paths: required: true schema: type: string - - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -31094,7 +30277,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.endpoints.operations.cancel + operationId: aiplatform.projects.locations.persistentResources.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31119,7 +30302,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string @@ -31128,14 +30311,15 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: parameters: *ref_1 - get: + delete: 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. - operationId: aiplatform.projects.locations.endpoints.operations.get + 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`. + operationId: aiplatform.projects.locations.persistentResources.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31147,7 +30331,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -31160,7 +30344,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string @@ -31169,13 +30353,12 @@ paths: required: true schema: type: string - delete: + get: 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`. - operationId: aiplatform.projects.locations.endpoints.operations.delete + 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. + operationId: aiplatform.projects.locations.persistentResources.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31187,7 +30370,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31200,7 +30383,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string @@ -31209,7 +30392,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -31222,7 +30405,7 @@ paths: 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. - operationId: aiplatform.projects.locations.endpoints.operations.wait + operationId: aiplatform.projects.locations.persistentResources.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31247,7 +30430,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string @@ -31261,13 +30444,13 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.endpoints.operations.list + operationId: aiplatform.projects.locations.persistentResources.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31292,14 +30475,10 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: @@ -31309,34 +30488,33 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: parameters: *ref_1 post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.endpoints.generateContent + description: Reboots a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.reboot requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31349,36 +30527,68 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: parameters: *ref_1 - post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.endpoints.predict + patch: + description: Updates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.get + security: - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/cloud-platform Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/cloud-platform responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' parameters: - in: path name: projectsId @@ -31391,20 +30601,51 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints: + delete: + description: Deletes a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: parameters: *ref_1 post: - description: Creates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.create + description: Creates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31429,12 +30670,12 @@ paths: schema: type: string - in: query - name: endpointId + name: persistentResourceId schema: type: string get: - description: Lists Endpoints in a Location. - operationId: aiplatform.projects.locations.endpoints.list + description: Lists PersistentResources in a Location. + operationId: aiplatform.projects.locations.persistentResources.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31447,7 +30688,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse + #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse parameters: - in: path name: projectsId @@ -31464,33 +30705,20 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: parameters: *ref_1 - post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.endpoints.countTokens + patch: + description: Updates the parameters of a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31502,8 +30730,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -31516,41 +30743,40 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: - parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.endpoints.rawPredict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31563,15 +30789,23 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: - parameters: *ref_1 - delete: - description: Deletes an Endpoint. - operationId: aiplatform.projects.locations.endpoints.delete + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + get: + description: Gets details of a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31583,7 +30817,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -31596,18 +30830,30 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - patch: - description: Updates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.patch + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: + parameters: *ref_1 + post: + description: Creates a new Feature in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31619,7 +30865,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31632,18 +30878,22 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId required: true schema: type: string - in: query - name: updateMask + name: featureId schema: type: string - format: google-fieldmask get: - description: Gets an Endpoint. - operationId: aiplatform.projects.locations.endpoints.get + description: Lists Features in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31655,7 +30905,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -31668,40 +30919,66 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: parameters: *ref_1 post: - description: >- - Perform a server-side streaming online prediction request for Vertex LLM - streaming. - operationId: aiplatform.projects.locations.endpoints.serverStreamingPredict + description: Creates a batch of Features in a given EntityType. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest + #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31714,22 +30991,30 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Undeploys a Model from an Endpoint, removing a DeployedModel from it, - and freeing all resources it's using. - operationId: aiplatform.projects.locations.endpoints.undeployModel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployModelRequest' + 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`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31741,7 +31026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -31754,20 +31039,40 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Deploys a Model into this Endpoint, creating a DeployedModel within it. - operationId: aiplatform.projects.locations.endpoints.deployModel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployModelRequest' + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31792,40 +31097,50 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: parameters: *ref_1 - post: + get: description: >- - 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. - operationId: aiplatform.projects.locations.endpoints.explain - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -31838,25 +31153,42 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Updates an existing deployed model. Updatable fields include - `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, - `disable_container_logging` (v1 only), and `enable_container_logging` - (v1beta1 only). - operationId: aiplatform.projects.locations.endpoints.mutateDeployedModel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MutateDeployedModelRequest + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31881,82 +31213,45 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: - parameters: *ref_1 - post: - description: Perform a streaming online prediction with an arbitrary HTTP payload. - operationId: aiplatform.projects.locations.endpoints.streamRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' - parameters: - in: path - name: projectsId + name: entityTypesId required: true schema: type: string - in: path - name: locationsId + name: featuresId required: true schema: type: string - in: path - name: endpointsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: - parameters: *ref_1 - post: + delete: description: >- - Perform an unary online prediction request to a gRPC model server for - Vertex first-party products and frameworks. - operationId: aiplatform.projects.locations.endpoints.directPredict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' + 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`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectPredictResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -31969,77 +31264,51 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens: - parameters: *ref_1 - post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.projects.locations.endpoints.computeTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse - parameters: - in: path - name: projectsId + name: entityTypesId required: true schema: type: string - in: path - name: locationsId + name: featuresId required: true schema: type: string - in: path - name: endpointsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.endpoints.streamGenerateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + 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. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32052,40 +31321,44 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations: parameters: *ref_1 - post: + get: description: >- - Perform an unary online prediction request to a gRPC model server for - custom containers. - operationId: aiplatform.projects.locations.endpoints.directRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -32098,25 +31371,36 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: parameters: *ref_1 - patch: + get: description: >- - 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. - operationId: aiplatform.projects.locations.schedules.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + 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. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32128,7 +31412,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32141,18 +31425,28 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask delete: - description: Deletes a Schedule. - operationId: aiplatform.projects.locations.schedules.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`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32164,7 +31458,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32177,13 +31471,35 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - get: - description: Gets a Schedule. - operationId: aiplatform.projects.locations.schedules.get + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32195,7 +31511,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32208,23 +31524,27 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.schedules.pause - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PauseScheduleRequest' + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32236,7 +31556,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -32249,20 +31569,30 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: parameters: *ref_1 - post: - description: Creates a Schedule. - operationId: aiplatform.projects.locations.schedules.create + patch: + description: Updates the parameters of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32274,7 +31604,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' parameters: - in: path name: projectsId @@ -32286,9 +31616,24 @@ paths: required: true schema: type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Lists Schedules in a Location. - operationId: aiplatform.projects.locations.schedules.list + description: Gets details of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32300,8 +31645,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' parameters: - in: path name: projectsId @@ -32313,40 +31657,21 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: featurestoresId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: entityTypesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: - parameters: *ref_1 - post: + delete: description: >- - 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.catchUp is set up true, - all missed runs will be scheduled for backfill first. - operationId: aiplatform.projects.locations.schedules.resume - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest + Deletes a single EntityType. The EntityType must not have any Features + or `force` must be set to true for the request to succeed. + operationId: aiplatform.projects.locations.featurestores.entityTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32358,7 +31683,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32371,24 +31696,30 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.schedules.operations.wait + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32400,7 +31731,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -32413,34 +31744,45 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - in: query - name: timeout + name: permissions schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.schedules.operations.cancel + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32452,7 +31794,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32465,24 +31807,27 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: parameters: *ref_1 - 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`. - operationId: aiplatform.projects.locations.schedules.operations.delete + post: + description: Exports Feature values from all the entities of a target EntityType. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32494,7 +31839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32507,21 +31852,29 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.schedules.operations.get + Reads Feature values for multiple entities. Depending on their size, + data for different entities may be broken up across multiple responses. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32533,7 +31886,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse parameters: - in: path name: projectsId @@ -32546,22 +31900,20 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.schedules.operations.list + description: Lists EntityTypes in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32573,7 +31925,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse parameters: - in: path name: projectsId @@ -32586,28 +31939,40 @@ paths: schema: type: string - in: path - name: schedulesId + name: featurestoresId required: true schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: filter schema: type: string - in: query - name: pageSize + name: readMask schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: - parameters: *ref_1 - get: - description: Gets a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.get + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new EntityType in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32619,7 +31984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32632,13 +31997,29 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: featurestoresId required: true schema: type: string - delete: - description: Deletes a SpecialistPool as well as all Specialists in the pool. - operationId: aiplatform.projects.locations.specialistPools.delete + - in: query + name: entityTypeId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: + parameters: *ref_1 + post: + description: >- + Reads Feature values of a specific entity of an EntityType. For reading + feature values of multiple entities of an EntityType, please use + StreamingReadFeatureValues. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32650,7 +32031,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse parameters: - in: path name: projectsId @@ -32663,22 +32045,35 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: featurestoresId required: true schema: type: string - - in: query - name: force + - in: path + name: entityTypesId + required: true schema: - type: boolean - patch: - description: Updates a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.patch + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: + parameters: *ref_1 + post: + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32703,20 +32098,28 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: featurestoresId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: entityTypesId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: parameters: *ref_1 - get: - description: Lists SpecialistPools in a Location. - operationId: aiplatform.projects.locations.specialistPools.list + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32728,8 +32131,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -32741,28 +32143,32 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: featurestoresId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + - in: path + name: entityTypesId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: + parameters: *ref_1 post: - description: Creates a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.create + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32774,7 +32180,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse parameters: - in: path name: projectsId @@ -32786,7 +32193,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -32799,7 +32216,7 @@ paths: 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. - operationId: aiplatform.projects.locations.specialistPools.operations.wait + operationId: aiplatform.projects.locations.featurestores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32824,7 +32241,7 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: featurestoresId required: true schema: type: string @@ -32838,20 +32255,14 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: parameters: *ref_1 - post: + get: 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`. - operationId: aiplatform.projects.locations.specialistPools.operations.cancel + 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. + operationId: aiplatform.projects.locations.featurestores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32863,7 +32274,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32876,7 +32287,7 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: featurestoresId required: true schema: type: string @@ -32885,15 +32296,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: - parameters: *ref_1 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`. - operationId: aiplatform.projects.locations.specialistPools.operations.delete + operationId: aiplatform.projects.locations.featurestores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32918,7 +32327,7 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: featurestoresId required: true schema: type: string @@ -32927,12 +32336,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.specialistPools.operations.get + 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`. + operationId: aiplatform.projects.locations.featurestores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32944,7 +32361,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32957,7 +32374,7 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: featurestoresId required: true schema: type: string @@ -32966,13 +32383,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.specialistPools.operations.list + operationId: aiplatform.projects.locations.featurestores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32997,7 +32414,7 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: featurestoresId required: true schema: type: string @@ -33005,22 +32422,55 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores: parameters: *ref_1 + post: + description: Creates a new Featurestore in a given project and location. + operationId: aiplatform.projects.locations.featurestores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: featurestoreId + schema: + type: string get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.operations.list + description: Lists Featurestores in a given project and location. + operationId: aiplatform.projects.locations.featurestores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33032,7 +32482,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse parameters: - in: path name: projectsId @@ -33044,6 +32495,19 @@ paths: required: true schema: type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string - in: query name: filter schema: @@ -33053,19 +32517,55 @@ paths: schema: type: integer format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: + parameters: *ref_1 + get: + description: Searches Features matching a query in a given project. + operationId: aiplatform.projects.locations.featurestores.searchFeatures + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: query + schema: + type: string - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: parameters: *ref_1 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`. - operationId: aiplatform.projects.locations.operations.delete + Deletes a single Featurestore. The Featurestore must not contain any + EntityTypes or `force` must be set to true for the request to succeed. + operationId: aiplatform.projects.locations.featurestores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33077,7 +32577,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33090,16 +32590,22 @@ paths: schema: type: string - in: path - name: operationsId + name: featurestoresId required: true schema: 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. - operationId: aiplatform.projects.locations.operations.get + - in: query + name: force + schema: + type: boolean + patch: + description: Updates the parameters of a single Featurestore. + operationId: aiplatform.projects.locations.featurestores.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33124,24 +32630,18 @@ paths: schema: type: string - in: path - name: operationsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.operations.wait + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets details of a single Featurestore. + operationId: aiplatform.projects.locations.featurestores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33153,7 +32653,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' parameters: - in: path name: projectsId @@ -33166,29 +32666,26 @@ paths: schema: type: string - in: path - name: operationsId + name: featurestoresId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.operations.cancel + 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. + operationId: aiplatform.projects.locations.featurestores.batchReadFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33200,7 +32697,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33213,24 +32710,23 @@ paths: schema: type: string - in: path - name: operationsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.cancel + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featurestores.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33242,7 +32738,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -33255,29 +32751,17 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.wait + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featurestores.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33289,7 +32773,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -33302,28 +32786,25 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: featurestoresId required: true schema: type: string - in: query - name: timeout + name: options.requestedPolicyVersion schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.get + 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. + operationId: aiplatform.projects.locations.featurestores.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33335,7 +32816,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -33348,34 +32829,42 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: featurestoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: permissions schema: type: string - 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`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.projects.locations.endpoints.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -33388,22 +32877,15 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.list + description: Lists Endpoints in a Location. + operationId: aiplatform.projects.locations.endpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33415,7 +32897,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse parameters: - in: path name: projectsId @@ -33427,29 +32910,36 @@ paths: required: true schema: type: string - - in: path - name: notebookExecutionJobsId - required: true + - in: query + name: orderBy schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query name: pageToken schema: type: string - in: query - name: filter + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}: - parameters: *ref_1 - get: - description: Gets a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.get + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33461,8 +32951,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33474,30 +32963,40 @@ paths: required: true schema: type: string - - in: path - name: notebookExecutionJobsId - required: true - schema: - type: string - in: query - name: view + name: endpointId schema: type: string - delete: - description: Deletes a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.delete + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: + parameters: *ref_1 + post: + description: >- + Perform a server-side streaming online prediction request for Vertex LLM + streaming. + operationId: aiplatform.projects.locations.endpoints.serverStreamingPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -33510,20 +33009,20 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens: parameters: *ref_1 post: - description: Creates a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.create + description: Return a list of tokens based on the input text. + operationId: aiplatform.projects.locations.endpoints.computeTokens requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33535,7 +33034,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -33547,18 +33047,33 @@ paths: required: true schema: type: string - - in: query - name: notebookExecutionJobId + - in: path + name: endpointsId + required: true schema: type: string - get: - description: Lists NotebookExecutionJobs in a Location. - operationId: aiplatform.projects.locations.notebookExecutionJobs.list + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: + parameters: *ref_1 + post: + description: >- + Perform an unary online prediction request to a gRPC model server for + custom containers. + operationId: aiplatform.projects.locations.endpoints.directRawPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -33566,7 +33081,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse parameters: - in: path name: projectsId @@ -33578,37 +33093,21 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: endpointsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: parameters: *ref_1 post: - description: Creates a new FeatureGroup in a given project and location. - operationId: aiplatform.projects.locations.featureGroups.create + description: Perform a token counting. + operationId: aiplatform.projects.locations.endpoints.countTokens requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33620,7 +33119,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -33632,18 +33132,31 @@ paths: required: true schema: type: string - - in: query - name: featureGroupId + - in: path + name: endpointsId + required: true schema: type: string - get: - description: Lists FeatureGroups in a given project and location. - operationId: aiplatform.projects.locations.featureGroups.list + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs. + operationId: aiplatform.projects.locations.endpoints.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -33651,7 +33164,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -33663,28 +33176,21 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: endpointsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: parameters: *ref_1 - get: - description: Gets details of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.get + patch: + description: Updates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33696,7 +33202,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -33709,18 +33215,18 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: endpointsId required: true schema: type: string - patch: - description: Updates the parameters of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an Endpoint. + operationId: aiplatform.projects.locations.endpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33745,18 +33251,13 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: endpointsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.delete + get: + description: Gets an Endpoint. + operationId: aiplatform.projects.locations.endpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33768,7 +33269,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -33781,35 +33282,37 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: endpointsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: parameters: *ref_1 - 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`. - operationId: aiplatform.projects.locations.featureGroups.features.operations.delete + post: + description: Perform a streaming online prediction with an arbitrary HTTP payload. + operationId: aiplatform.projects.locations.endpoints.streamRawPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -33822,38 +33325,41 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.featureGroups.features.operations.get + 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. + operationId: aiplatform.projects.locations.endpoints.rawPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -33866,39 +33372,40 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait + 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. + operationId: aiplatform.projects.locations.endpoints.explain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' parameters: - in: path name: projectsId @@ -33911,57 +33418,36 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: + parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.featureGroups.features.operations.wait + description: Perform an online prediction. + operationId: aiplatform.projects.locations.endpoints.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -33974,42 +33460,77 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: + parameters: *ref_1 + post: + description: Deploys a Model into this Endpoint, creating a DeployedModel within it. + operationId: aiplatform.projects.locations.endpoints.deployModel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployModelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: featuresId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: endpointsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: parameters: *ref_1 - delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.delete + post: + description: >- + Perform an unary online prediction request to a gRPC model server for + Vertex first-party products and frameworks. + operationId: aiplatform.projects.locations.endpoints.directPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectPredictResponse parameters: - in: path name: projectsId @@ -34022,18 +33543,25 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: endpointsId required: true schema: type: string - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.get + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: + parameters: *ref_1 + post: + description: >- + Updates an existing deployed model. Updatable fields include + `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, + `disable_container_logging` (v1 only), and `enable_container_logging` + (v1beta1 only). + operationId: aiplatform.projects.locations.endpoints.mutateDeployedModel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MutateDeployedModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34045,7 +33573,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34058,23 +33586,22 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: endpointsId required: true schema: type: string - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.patch + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: + parameters: *ref_1 + post: + description: >- + Undeploys a Model from an Endpoint, removing a DeployedModel from it, + and freeing all resources it's using. + operationId: aiplatform.projects.locations.endpoints.undeployModel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34099,25 +33626,19 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: endpointsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: parameters: *ref_1 - get: - description: Lists Features in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.list + 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`. + operationId: aiplatform.projects.locations.endpoints.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34129,8 +33650,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -34143,45 +33663,21 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: endpointsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: latestStatsCount - schema: - type: integer - format: int32 - post: - description: Creates a new Feature in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + 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. + operationId: aiplatform.projects.locations.endpoints.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34206,22 +33702,29 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: endpointsId required: true schema: type: string - - in: query - name: featureId + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.featureGroups.operations.get + 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. + operationId: aiplatform.projects.locations.endpoints.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34246,7 +33749,7 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: endpointsId required: true schema: type: string @@ -34255,13 +33758,25 @@ paths: required: true schema: type: string - delete: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: 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`. - operationId: aiplatform.projects.locations.featureGroups.operations.delete + 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`. + operationId: aiplatform.projects.locations.endpoints.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34286,7 +33801,7 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: endpointsId required: true schema: type: string @@ -34295,13 +33810,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.operations.listWait + operationId: aiplatform.projects.locations.endpoints.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34326,21 +33841,16 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -34348,18 +33858,11 @@ paths: schema: type: integer format: int32 - post: - 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. - operationId: aiplatform.projects.locations.featureGroups.operations.wait + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: + parameters: *ref_1 + get: + description: Searches DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.searchDataItems security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34371,7 +33874,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse parameters: - in: path name: projectsId @@ -34384,25 +33888,70 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: fieldMask schema: type: string + format: google-fieldmask - in: query - name: timeout + name: savedQuery schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: + - in: query + name: dataItemFilter + schema: + type: string + - in: query + name: dataLabelingJob + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderByAnnotation.savedQuery + schema: + type: string + - in: query + name: annotationsLimit + schema: + type: integer + format: int32 + - in: query + name: orderByDataItem + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderByAnnotation.orderBy + schema: + type: string + - in: query + name: annotationFilters + schema: + type: string + - in: query + name: annotationsFilter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: parameters: *ref_1 get: - description: Gets a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get + description: Gets a Dataset. + operationId: aiplatform.projects.locations.datasets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34414,8 +33963,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: projectsId @@ -34428,19 +33976,18 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId required: true schema: type: string - patch: - description: Updates a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Dataset. + operationId: aiplatform.projects.locations.datasets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34465,18 +34012,18 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete + patch: + description: Updates a Dataset. + operationId: aiplatform.projects.locations.datasets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34488,7 +34035,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: projectsId @@ -34501,24 +34048,25 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets: parameters: *ref_1 post: - description: >- - Pauses a ModelDeploymentMonitoringJob. If the job is running, the server - makes a best effort to cancel the job. Will mark - ModelDeploymentMonitoringJob.state to 'PAUSED'. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause + description: Creates a Dataset. + operationId: aiplatform.projects.locations.datasets.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34530,7 +34078,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34542,16 +34090,9 @@ paths: required: true schema: type: string - - in: path - name: modelDeploymentMonitoringJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: - parameters: *ref_1 get: - description: Lists ModelDeploymentMonitoringJobs in a Location. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list + description: Lists Datasets in a Location. + operationId: aiplatform.projects.locations.datasets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34564,7 +34105,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse parameters: - in: path name: projectsId @@ -34577,11 +34118,16 @@ paths: schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: filter + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken schema: type: string - in: query @@ -34590,59 +34136,19 @@ paths: type: integer format: int32 - in: query - name: readMask - schema: - type: string - format: google-fieldmask - post: - description: >- - Creates a ModelDeploymentMonitoringJob. It will run periodically on a - configured interval. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: parameters: *ref_1 post: - description: >- - Resumes a paused ModelDeploymentMonitoringJob. It will start to run from - next scheduled time. A deleted ModelDeploymentMonitoringJob can't be - resumed. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume + description: Imports data into a Dataset. + operationId: aiplatform.projects.locations.datasets.import requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34654,7 +34160,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34667,24 +34173,20 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: parameters: *ref_1 post: - description: >- - Searches Model Monitoring Statistics generated within a given time - window. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies + description: Exports data from a Dataset. + operationId: aiplatform.projects.locations.datasets.export requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34696,8 +34198,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34710,19 +34211,24 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: + post: 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. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get + 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. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34747,7 +34253,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId + required: true + schema: + type: string + - in: path + name: annotationSpecsId required: true schema: type: string @@ -34756,14 +34267,25 @@ paths: required: true schema: type: string - delete: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: 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`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete + 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`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34788,7 +34310,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId + required: true + schema: + type: string + - in: path + name: annotationSpecsId required: true schema: type: string @@ -34797,14 +34324,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34829,7 +34355,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId + required: true + schema: + type: string + - in: path + name: annotationSpecsId required: true schema: type: string @@ -34846,21 +34377,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: parameters: *ref_1 - post: + delete: 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`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel + 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`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34885,7 +34410,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId + required: true + schema: + type: string + - in: path + name: annotationSpecsId required: true schema: type: string @@ -34894,21 +34424,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: + get: 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. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait + 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. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34933,27 +34454,25 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: annotationSpecsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: operationsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.listWait + description: Gets an AnnotationSpec. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34965,7 +34484,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' parameters: - in: path name: projectsId @@ -34978,40 +34497,25 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: annotationSpecsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + name: readMask schema: type: string - post: - 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. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: + parameters: *ref_1 + get: + description: Lists DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.dataItems.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35023,7 +34527,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse parameters: - in: path name: projectsId @@ -35036,29 +34541,40 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: timeout + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}: parameters: *ref_1 - delete: + get: 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`. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.delete + 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. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35070,7 +34586,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35083,7 +34599,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId + required: true + schema: + type: string + - in: path + name: dataItemsId required: true schema: type: string @@ -35092,12 +34613,13 @@ paths: required: true schema: type: string - get: + delete: 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. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.get + 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`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35109,7 +34631,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35122,7 +34644,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId + required: true + schema: + type: string + - in: path + name: dataItemsId required: true schema: type: string @@ -35131,14 +34658,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: parameters: *ref_1 - post: + get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35150,7 +34676,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35163,25 +34689,42 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: parameters: *ref_1 - delete: - description: Deletes a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete + post: + 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`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35193,7 +34736,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35206,23 +34749,34 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - patch: - description: Updates the parameters of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35247,23 +34801,33 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: + parameters: *ref_1 get: - description: Gets details of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35275,7 +34839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35288,76 +34852,48 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: - parameters: *ref_1 - post: - description: Fetch feature values under a FeatureView. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse - parameters: - in: path - name: projectsId + name: annotationsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: featureOnlineStoresId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: featureViewsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait: parameters: *ref_1 post: 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. + 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. operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest + aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35369,8 +34905,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35383,64 +34918,39 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: - parameters: *ref_1 - post: - description: Creates a new FeatureView in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: dataItemsId required: true schema: type: string - in: path - name: locationsId + name: annotationsId required: true schema: type: string - in: path - name: featureOnlineStoresId + name: operationsId required: true schema: type: string - in: query - name: featureViewId + name: timeout schema: type: string - - in: query - name: runSyncImmediately - schema: - type: boolean + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Lists FeatureViews in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list + 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. + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35452,8 +34962,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35466,38 +34975,33 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: dataItemsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: annotationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions: - parameters: *ref_1 - post: + delete: 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. + 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`. operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions + aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35509,7 +35013,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35522,30 +35026,40 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - - in: query - name: permissions + - in: path + name: annotationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Triggers on-demand sync for the FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest + 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`. + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35557,8 +35071,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35571,29 +35084,33 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId + required: true + schema: + type: string + - in: path + name: annotationsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + Lists Annotations belongs to a dataitem This RPC is only available in + InternalDatasetService. It is only used for exporting conversation data + to CCAI Insights. + operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35605,7 +35122,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse parameters: - in: path name: projectsId @@ -35618,21 +35136,42 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: dataItemsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: parameters: *ref_1 get: - description: Lists FeatureViewSyncs in a given FeatureView. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list + description: Lists SavedQueries in a Dataset. + operationId: aiplatform.projects.locations.datasets.savedQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35645,7 +35184,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse parameters: - in: path name: projectsId @@ -35658,38 +35197,37 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: path - name: featureViewsId - required: true + - in: query + name: filter schema: type: string - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query - name: orderBy + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: filter + name: orderBy schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: parameters: *ref_1 - get: - description: Gets details of a single FeatureViewSync. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get + delete: + description: Deletes a SavedQuery. + operationId: aiplatform.projects.locations.datasets.savedQueries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35701,7 +35239,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35714,29 +35252,22 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: datasetsId required: true schema: type: string - in: path - name: featureViewSyncsId + name: savedQueriesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: parameters: *ref_1 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. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35748,7 +35279,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35761,28 +35292,36 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: savedQueriesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - delete: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: + parameters: *ref_1 + get: 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`. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete + 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. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35794,7 +35333,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35807,12 +35346,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: savedQueriesId required: true schema: type: string @@ -35821,14 +35360,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: - parameters: *ref_1 - get: + delete: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait + 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`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35840,7 +35378,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35853,12 +35391,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: savedQueriesId required: true schema: type: string @@ -35867,19 +35405,8 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -35891,8 +35418,7 @@ paths: 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. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35917,12 +35443,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: path - name: featureViewsId + name: savedQueriesId required: true schema: type: string @@ -35936,16 +35462,20 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: parameters: *ref_1 - patch: - description: Updates the parameters of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + post: + 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`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35957,7 +35487,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35970,51 +35500,34 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets details of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' - parameters: - - in: path - name: projectsId + name: datasetsId required: true schema: type: string - in: path - name: locationsId + name: savedQueriesId required: true schema: type: string - in: path - name: featureOnlineStoresId + name: operationsId required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not - contain any FeatureViews. - operationId: aiplatform.projects.locations.featureOnlineStores.delete + 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`. + operationId: aiplatform.projects.locations.datasets.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36026,7 +35539,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -36039,19 +35552,29 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: query - name: force + - in: path + name: operationsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: Lists FeatureOnlineStores in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.list + post: + 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. + operationId: aiplatform.projects.locations.datasets.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36063,8 +35586,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36076,65 +35598,28 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new FeatureOnlineStore in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: datasetsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - in: query - name: featureOnlineStoreId + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: parameters: *ref_1 - post: + get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featureOnlineStores.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36146,7 +35631,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -36159,28 +35644,31 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featureOnlineStores.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + 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. + operationId: aiplatform.projects.locations.datasets.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36192,7 +35680,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36205,20 +35693,22 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions: - parameters: *ref_1 - post: + - in: path + name: operationsId + required: true + schema: + type: string + delete: 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. - operationId: aiplatform.projects.locations.featureOnlineStores.testIamPermissions + 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`. + operationId: aiplatform.projects.locations.datasets.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36230,7 +35720,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -36243,33 +35733,25 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: query - name: permissions + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.batchPredictionJobs.cancel + description: Create a version from a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36281,7 +35763,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36294,15 +35776,13 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: - parameters: *ref_1 get: - description: Gets a BatchPredictionJob - operationId: aiplatform.projects.locations.batchPredictionJobs.get + description: Lists DatasetVersions in a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36314,7 +35794,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse parameters: - in: path name: projectsId @@ -36327,48 +35808,37 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: datasetsId required: true schema: type: string - delete: - description: >- - Deletes a BatchPredictionJob. Can only be called on jobs that already - finished. - operationId: aiplatform.projects.locations.batchPredictionJobs.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: locationsId - required: true + format: google-fieldmask + - in: query + name: filter schema: type: string - - in: path - name: batchPredictionJobsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: parameters: *ref_1 get: - description: Lists BatchPredictionJobs in a Location. - operationId: aiplatform.projects.locations.batchPredictionJobs.list + description: Gets a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36380,8 +35850,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -36393,34 +35862,24 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: datasetsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: datasetVersionsId + required: true schema: type: string - in: query - name: pageSize + name: readMask schema: - type: integer - format: int32 - post: - description: >- - Creates a BatchPredictionJob. A BatchPredictionJob once created will - right away be attempted to start. - operationId: aiplatform.projects.locations.batchPredictionJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + type: string + format: google-fieldmask + delete: + description: Deletes a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36432,7 +35891,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36444,21 +35903,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId + required: true + schema: + type: string + patch: + description: Updates a DatasetVersion. + operationId: aiplatform.projects.locations.datasets.datasetVersions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36470,7 +35932,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -36483,40 +35945,25 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: datasetVersionsId required: true schema: type: string - in: query - name: timeout + name: updateMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: parameters: *ref_1 - 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`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete + get: + description: Restores a dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.restore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36528,7 +35975,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36541,32 +35988,22 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: datasetVersionsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: + parameters: *ref_1 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36578,7 +36015,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -36591,33 +36028,31 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tuningJobsId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: featuresId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.list + 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. + operationId: aiplatform.projects.locations.tuningJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36629,7 +36064,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36642,34 +36077,16 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tuningJobsId required: true schema: type: string - in: path - name: featuresId + name: operationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -36682,8 +36099,7 @@ paths: 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`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel + operationId: aiplatform.projects.locations.tuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36708,17 +36124,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: tuningJobsId required: true schema: type: string @@ -36727,16 +36133,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: parameters: *ref_1 - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + get: + description: Gets a TuningJob. + operationId: aiplatform.projects.locations.tuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36748,7 +36149,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' parameters: - in: path name: projectsId @@ -36761,28 +36162,15 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: tuningJobsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: + parameters: *ref_1 get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get + description: Lists TuningJobs in a Location. + operationId: aiplatform.projects.locations.tuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36794,7 +36182,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse parameters: - in: path name: projectsId @@ -36806,24 +36195,29 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true + - in: query + name: filter schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: featuresId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.delete + post: + description: >- + Creates a TuningJob. A created TuningJob right away will be attempted to + be run. + operationId: aiplatform.projects.locations.tuningJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36835,7 +36229,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' parameters: - in: path name: projectsId @@ -36847,33 +36241,59 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: + parameters: *ref_1 + post: + description: >- + Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. + 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 + TuningJob is not deleted; instead it becomes a job with a + TuningJob.error value with a google.rpc.Status.code of 1, corresponding + to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.tuningJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelTuningJobRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: - in: path - name: featurestoresId + name: projectsId required: true schema: type: string - in: path - name: entityTypesId + name: locationsId required: true schema: type: string - in: path - name: featuresId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: parameters: *ref_1 - post: - description: Creates a batch of Features in a given EntityType. + get: + description: Gets details of a single FeatureViewSync. operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36885,7 +36305,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' parameters: - in: path name: projectsId @@ -36898,20 +36318,26 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: + - in: path + name: featureViewSyncsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: parameters: *ref_1 get: - description: Lists Features in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list + description: Lists FeatureViewSyncs in a given FeatureView. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36924,7 +36350,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse parameters: - in: path name: projectsId @@ -36937,12 +36363,12 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string @@ -36955,11 +36381,6 @@ paths: name: pageToken schema: type: string - - in: query - name: latestStatsCount - schema: - type: integer - format: int32 - in: query name: orderBy schema: @@ -36968,19 +36389,15 @@ paths: name: filter schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - post: - description: Creates a new Feature in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37005,34 +36422,28 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - - in: query - name: featureId + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: + delete: 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`. + 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`. operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.operations.cancel + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37057,12 +36468,12 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string @@ -37071,8 +36482,65 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -37084,7 +36552,8 @@ paths: 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. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.wait + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37109,12 +36578,12 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string @@ -37128,13 +36597,66 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.list + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37146,7 +36668,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -37159,36 +36681,26 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.get + 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. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37200,7 +36712,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -37213,28 +36725,24 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: permissions schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}: + parameters: *ref_1 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`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.operations.delete + description: Deletes a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37246,7 +36754,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37259,46 +36767,18 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: - parameters: *ref_1 - post: - 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest + get: + description: Gets details of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37310,7 +36790,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' parameters: - in: path name: projectsId @@ -37323,29 +36803,23 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: - parameters: *ref_1 - post: - description: >- - Reads Feature values for multiple entities. Depending on their size, - data for different entities may be broken up across multiple responses. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues + patch: + description: Updates the parameters of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37357,8 +36831,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37371,20 +36844,25 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: parameters: *ref_1 get: - description: Lists EntityTypes in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.list + description: Lists FeatureViews in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37397,7 +36875,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse parameters: - in: path name: projectsId @@ -37410,40 +36888,35 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: orderBy + schema: + type: string - in: query name: pageToken schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask post: - description: Creates a new EntityType in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.create + description: Creates a new FeatureView in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37468,21 +36941,33 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: query - name: entityTypeId + name: runSyncImmediately + schema: + type: boolean + - in: query + name: featureViewId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy + 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. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37494,7 +36979,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse parameters: - in: path name: projectsId @@ -37507,40 +36993,27 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: parameters: *ref_1 post: - 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. + description: Fetch feature values under a FeatureView. operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues + aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37552,7 +37025,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse parameters: - in: path name: projectsId @@ -37565,27 +37039,26 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: parameters: *ref_1 post: - description: Exports Feature values from all the entities of a target EntityType. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues + description: Triggers on-demand sync for the FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37597,7 +37070,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse parameters: - in: path name: projectsId @@ -37610,26 +37084,29 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: parameters: *ref_1 post: 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions + 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. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37641,7 +37118,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37654,24 +37131,25 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - in: query - name: permissions + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: - parameters: *ref_1 + format: google-duration get: - description: Gets details of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37683,7 +37161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -37696,23 +37174,37 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - patch: - description: Updates the parameters of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: + parameters: *ref_1 + 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`. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37724,7 +37216,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37737,25 +37229,21 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: + get: description: >- - Deletes a single EntityType. The EntityType must not have any Features - or `force` must be set to true for the request to succeed. - operationId: aiplatform.projects.locations.featurestores.entityTypes.delete + 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. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37780,34 +37268,20 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: parameters: *ref_1 - post: - description: >- - Reads Feature values of a specific entity of an EntityType. For reading - feature values of multiple entities of an EntityType, please use - StreamingReadFeatureValues. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest + get: + description: Lists FeatureOnlineStores in a given project and location. + operationId: aiplatform.projects.locations.featureOnlineStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37820,7 +37294,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse parameters: - in: path name: projectsId @@ -37832,29 +37306,31 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: - parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy + description: Creates a new FeatureOnlineStore in a given project and location. + operationId: aiplatform.projects.locations.featureOnlineStores.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37866,7 +37342,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37878,32 +37354,20 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true + - in: query + name: featureOnlineStoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: parameters: *ref_1 - post: - 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues + patch: + description: Updates the parameters of a single FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37915,8 +37379,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37929,24 +37392,18 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: - parameters: *ref_1 - 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`. - operationId: aiplatform.projects.locations.featurestores.operations.delete + format: google-fieldmask + get: + description: Gets details of a single FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37958,7 +37415,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' parameters: - in: path name: projectsId @@ -37971,21 +37428,15 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: operationsId + name: featureOnlineStoresId required: true schema: type: string - get: + delete: 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. - operationId: aiplatform.projects.locations.featurestores.operations.get + Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not + contain any FeatureViews. + operationId: aiplatform.projects.locations.featureOnlineStores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38010,29 +37461,24 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.featurestores.operations.cancel + 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. + operationId: aiplatform.projects.locations.featureOnlineStores.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38044,7 +37490,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -38057,22 +37503,21 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.operations.list + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featureOnlineStores.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38084,7 +37529,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -38097,37 +37542,28 @@ paths: schema: type: string - in: path - name: featurestoresId + name: featureOnlineStoresId required: true schema: type: string - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.featurestores.operations.wait + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featureOnlineStores.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38139,7 +37575,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -38152,30 +37588,23 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: operationsId + name: featureOnlineStoresId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: parameters: *ref_1 - patch: - description: Updates the parameters of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.patch + post: + description: >- + Batch migrates resources from ml.googleapis.com, automl.googleapis.com, + and datalabeling.googleapis.com to Vertex AI. + operationId: aiplatform.projects.locations.migratableResources.batchMigrate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38199,21 +37628,52 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: + parameters: *ref_1 + post: + description: >- + 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. + operationId: aiplatform.projects.locations.migratableResources.search + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse + parameters: - in: path - name: featurestoresId + name: projectsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: locationsId + required: true schema: type: string - format: google-fieldmask - delete: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes a single Featurestore. The Featurestore must not contain any - EntityTypes or `force` must be set to true for the request to succeed. - operationId: aiplatform.projects.locations.featurestores.delete + 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. + operationId: aiplatform.projects.locations.migratableResources.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38238,17 +37698,22 @@ paths: schema: type: string - in: path - name: featurestoresId + name: migratableResourcesId required: true schema: type: string - - in: query - name: force + - in: path + name: operationsId + required: true schema: - type: boolean - get: - description: Gets details of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.get + type: string + 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`. + operationId: aiplatform.projects.locations.migratableResources.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38260,7 +37725,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38273,26 +37738,29 @@ paths: schema: type: string - in: path - name: featurestoresId + name: migratableResourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.featurestores.batchReadFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + 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`. + operationId: aiplatform.projects.locations.migratableResources.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38304,7 +37772,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38317,17 +37785,29 @@ paths: schema: type: string - in: path - name: featurestoresId + name: migratableResourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featurestores.getIamPolicy + 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. + operationId: aiplatform.projects.locations.migratableResources.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38339,7 +37819,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38352,20 +37832,27 @@ paths: schema: type: string - in: path - name: featurestoresId + name: migratableResourcesId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: timeout schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: parameters: *ref_1 get: - description: Lists Featurestores in a given project and location. - operationId: aiplatform.projects.locations.featurestores.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.migratableResources.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38377,8 +37864,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -38390,36 +37876,38 @@ paths: required: true schema: type: string - - in: query - name: orderBy + - in: path + name: migratableResourcesId + required: true schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Creates a new Featurestore in a given project and location. - operationId: aiplatform.projects.locations.featurestores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + 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. + operationId: aiplatform.projects.locations.pipelineJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38443,20 +37931,29 @@ paths: required: true schema: type: string + - in: path + name: pipelineJobsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string - in: query - name: featurestoreId + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.featurestores.testIamPermissions + 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. + operationId: aiplatform.projects.locations.pipelineJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38468,7 +37965,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38481,27 +37978,22 @@ paths: schema: type: string - in: path - name: featurestoresId + name: pipelineJobsId required: true schema: type: string - - in: query - name: permissions + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: - parameters: *ref_1 - post: + delete: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featurestores.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + 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`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38513,7 +38005,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38526,15 +38018,22 @@ paths: schema: type: string - in: path - name: featurestoresId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: parameters: *ref_1 get: - description: Searches Features matching a query in a given project. - operationId: aiplatform.projects.locations.featurestores.searchFeatures + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38546,8 +38045,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -38559,12 +38057,13 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: pipelineJobsId + required: true schema: type: string - in: query - name: query + name: filter schema: type: string - in: query @@ -38572,19 +38071,24 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Adds a measurement of the objective metrics to a Trial. This measurement - is assumed to have been taken before the Trial is complete. - operationId: aiplatform.projects.locations.studies.trials.addTrialMeasurement - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddTrialMeasurementRequest + 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`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38596,7 +38100,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38609,25 +38113,20 @@ paths: schema: type: string - in: path - name: studiesId + name: pipelineJobsId required: true schema: type: string - in: path - name: trialsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: parameters: *ref_1 - post: - description: Marks a Trial as complete. - operationId: aiplatform.projects.locations.studies.trials.complete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' + get: + description: Gets a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38639,7 +38138,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' parameters: - in: path name: projectsId @@ -38652,29 +38151,13 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: - parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.studies.trials.suggest - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SuggestTrialsRequest' + delete: + description: Deletes a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38699,24 +38182,20 @@ paths: schema: type: string - in: path - name: studiesId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: parameters: *ref_1 post: - description: >- - 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 - operationId: aiplatform.projects.locations.studies.trials.listOptimalTrials + description: Creates a PipelineJob. A PipelineJob will run immediately when created. + operationId: aiplatform.projects.locations.pipelineJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38728,8 +38207,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' parameters: - in: path name: projectsId @@ -38741,16 +38219,13 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: pipelineJobId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: - parameters: *ref_1 get: - description: Lists the Trials associated with a Study. - operationId: aiplatform.projects.locations.studies.trials.list + description: Lists PipelineJobs in a Location. + operationId: aiplatform.projects.locations.pipelineJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38762,7 +38237,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse parameters: - in: path name: projectsId @@ -38774,9 +38250,13 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken schema: type: string - in: query @@ -38785,17 +38265,30 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter + schema: + type: string + - in: query + name: orderBy schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: + parameters: *ref_1 post: - description: Adds a user provided Trial to a Study. - operationId: aiplatform.projects.locations.studies.trials.create + description: >- + 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. + operationId: aiplatform.projects.locations.pipelineJobs.batchCancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38807,7 +38300,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38819,21 +38312,20 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: parameters: *ref_1 post: - description: Stops a Trial. - operationId: aiplatform.projects.locations.studies.trials.stop + description: >- + 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. + operationId: aiplatform.projects.locations.pipelineJobs.batchDelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38845,7 +38337,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38857,31 +38349,26 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: parameters: *ref_1 post: description: >- - Checks whether a Trial should stop or not. Returns a long-running - operation. When the operation is successful, it will contain a - CheckTrialEarlyStoppingStateResponse. - operationId: >- - aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState + 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`. + operationId: aiplatform.projects.locations.pipelineJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38893,7 +38380,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38906,20 +38393,15 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: parameters: *ref_1 - delete: - description: Deletes a Trial. - operationId: aiplatform.projects.locations.studies.trials.delete + get: + description: Gets a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38931,7 +38413,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob parameters: - in: path name: projectsId @@ -38944,18 +38427,19 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - get: - description: Gets a Trial. - operationId: aiplatform.projects.locations.studies.trials.get + patch: + description: Updates a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38967,7 +38451,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38980,29 +38464,18 @@ paths: schema: type: string - in: path - name: studiesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.studies.trials.operations.wait + format: google-fieldmask + delete: + description: Deletes a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39027,39 +38500,24 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.studies.trials.operations.cancel + Pauses a ModelDeploymentMonitoringJob. If the job is running, the server + makes a best effort to cancel the job. Will mark + ModelDeploymentMonitoringJob.state to 'PAUSED'. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39084,28 +38542,24 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.studies.trials.operations.get + Resumes a paused ModelDeploymentMonitoringJob. It will start to run from + next scheduled time. A deleted ModelDeploymentMonitoringJob can't be + resumed. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39117,7 +38571,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39130,27 +38584,50 @@ paths: schema: type: string - in: path - name: studiesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: + parameters: *ref_1 + post: + description: >- + Creates a ModelDeploymentMonitoringJob. It will run periodically on a + configured interval. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + parameters: - in: path - name: trialsId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.studies.trials.operations.delete + get: + description: Lists ModelDeploymentMonitoringJobs in a Location. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39162,7 +38639,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse parameters: - in: path name: projectsId @@ -39174,28 +38652,38 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.trials.operations.list + Searches Model Monitoring Statistics generated within a given time + window. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39207,7 +38695,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse parameters: - in: path name: projectsId @@ -39220,36 +38709,19 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.studies.operations.get + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39274,7 +38746,7 @@ paths: schema: type: string - in: path - name: studiesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -39289,7 +38761,8 @@ paths: 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`. - operationId: aiplatform.projects.locations.studies.operations.delete + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39314,7 +38787,7 @@ paths: schema: type: string - in: path - name: studiesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -39323,20 +38796,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: parameters: *ref_1 - post: + get: 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`. - operationId: aiplatform.projects.locations.studies.operations.cancel + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39348,7 +38815,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -39361,16 +38828,24 @@ paths: schema: type: string - in: path - name: studiesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -39383,7 +38858,8 @@ paths: 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. - operationId: aiplatform.projects.locations.studies.operations.wait + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39408,7 +38884,7 @@ paths: schema: type: string - in: path - name: studiesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -39422,13 +38898,21 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.operations.list + 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`. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39440,7 +38924,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39453,28 +38937,20 @@ paths: schema: type: string - in: path - name: studiesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: parameters: *ref_1 get: - description: Gets a Study by name. - operationId: aiplatform.projects.locations.studies.get + description: Lists NasJobs in a Location. + operationId: aiplatform.projects.locations.nasJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39486,7 +38962,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse parameters: - in: path name: projectsId @@ -39498,14 +38975,32 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a Study. - operationId: aiplatform.projects.locations.studies.delete + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a NasJob + operationId: aiplatform.projects.locations.nasJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39517,7 +39012,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -39529,16 +39024,24 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: parameters: *ref_1 - get: - description: Lists all the studies in a region for an associated project. - operationId: aiplatform.projects.locations.studies.list + post: + description: >- + 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`. + operationId: aiplatform.projects.locations.nasJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39550,8 +39053,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39563,25 +39065,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: nasJobsId + required: true schema: type: string - post: - description: >- - Creates a Study. A resource name will be generated after creation of the - Study. - operationId: aiplatform.projects.locations.studies.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: + parameters: *ref_1 + delete: + description: Deletes a NasJob. + operationId: aiplatform.projects.locations.nasJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39593,7 +39086,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39605,30 +39098,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: - parameters: *ref_1 - post: - description: >- - Looks a study up using the user-defined display_name field instead of - the fully qualified resource name. - operationId: aiplatform.projects.locations.studies.lookup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LookupStudyRequest' + - in: path + name: nasJobsId + required: true + schema: + type: string + get: + description: Gets a NasJob + operationId: aiplatform.projects.locations.nasJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -39640,11 +39133,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: + - in: path + name: nasJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: parameters: *ref_1 get: - description: Returns the storage size for a given TensorBoard instance. - operationId: aiplatform.projects.locations.tensorboards.readSize + description: List top NasTrialDetails of a NasJob. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39657,7 +39155,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse + #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse parameters: - in: path name: projectsId @@ -39670,20 +39168,24 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: nasJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: parameters: *ref_1 - post: - description: Creates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + get: + description: Gets a NasTrialDetail. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39695,7 +39197,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' parameters: - in: path name: projectsId @@ -39707,26 +39209,35 @@ paths: required: true schema: type: string + - in: path + name: nasJobsId + required: true + schema: + type: string + - in: path + name: nasTrialDetailsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 get: - description: Lists Tensorboards in a Location. - operationId: aiplatform.projects.locations.tensorboards.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -39742,29 +39253,29 @@ paths: name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: filter schema: type: string - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask + name: pageSize schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 - delete: - description: Deletes a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.delete + post: + 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`. + operationId: aiplatform.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39776,7 +39287,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39789,18 +39300,24 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: operationsId required: true schema: type: string - patch: - description: Updates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: aiplatform.projects.locations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39825,34 +39342,35 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.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. + operationId: aiplatform.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39865,15 +39383,17 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: - parameters: *ref_1 - get: - description: Returns a list of monthly active users for a given TensorBoard instance. - operationId: aiplatform.projects.locations.tensorboards.readUsage + 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`. + operationId: aiplatform.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39885,8 +39405,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39899,20 +39418,24 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - 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. - operationId: aiplatform.projects.locations.tensorboards.batchRead + 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`. + operationId: aiplatform.projects.locations.customJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39924,8 +39447,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39938,37 +39460,34 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: customJobsId required: true schema: type: string - - in: query - name: timeSeries + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: parameters: *ref_1 get: - description: Lists TensorboardTimeSeries in a Location. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.customJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -39981,22 +39500,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: customJobsId required: true schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query @@ -40008,25 +39517,14 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - post: - description: Creates a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: aiplatform.projects.locations.customJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40038,8 +39536,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40052,50 +39549,34 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: customJobsId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - - in: query - name: tensorboardTimeSeriesId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: - parameters: *ref_1 - get: + delete: description: >- - 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData + 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`. + operationId: aiplatform.projects.locations.customJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40108,41 +39589,29 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: customJobsId required: true schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: type: string - - in: query - name: blobIds - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: parameters: *ref_1 - patch: - description: Updates a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + post: + 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. + operationId: aiplatform.projects.locations.customJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40154,8 +39623,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40168,51 +39636,44 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: customJobsId required: true schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask - get: - description: Gets a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/customJobs: + parameters: *ref_1 + post: + description: >- + Creates a CustomJob. A created CustomJob right away will be attempted to + be run. + operationId: aiplatform.projects.locations.customJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -40224,30 +39685,9 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId - required: true - schema: - type: string - delete: - description: Deletes a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete + get: + description: Lists CustomJobs in a Location. + operationId: aiplatform.projects.locations.customJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40259,7 +39699,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse parameters: - in: path name: projectsId @@ -40271,54 +39712,55 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: runsId - required: true + format: google-fieldmask + - in: query + name: pageToken schema: type: string - - in: path - name: timeSeriesId - required: true + - in: query + name: pageSize schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: parameters: *ref_1 - get: + post: description: >- - 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read + 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`. + operationId: aiplatform.projects.locations.customJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelCustomJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40331,48 +39773,46 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: customJobsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: + parameters: *ref_1 + get: + description: Gets a CustomJob. + operationId: aiplatform.projects.locations.customJobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + parameters: - in: path - name: experimentsId + name: projectsId required: true schema: type: string - in: path - name: runsId + name: locationsId required: true schema: type: string - in: path - name: timeSeriesId + name: customJobsId required: true schema: type: string - - in: query - name: maxDataPoints - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: - parameters: *ref_1 - post: - description: >- - Exports a TensorboardTimeSeries' data. Data is returned in paginated - responses. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest + delete: + description: Deletes a CustomJob. + operationId: aiplatform.projects.locations.customJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40384,8 +39824,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40398,40 +39837,56 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: customJobsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: + parameters: *ref_1 + delete: + description: Deletes a Schedule. + operationId: aiplatform.projects.locations.schedules.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: experimentsId + name: projectsId required: true schema: type: string - in: path - name: runsId + name: locationsId required: true schema: type: string - in: path - name: timeSeriesId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: + patch: 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait + 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. + operationId: aiplatform.projects.locations.schedules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40443,7 +39898,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -40456,43 +39911,56 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: schedulesId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask + get: + description: Gets a Schedule. + operationId: aiplatform.projects.locations.schedules.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + parameters: - in: path - name: runsId + name: projectsId required: true schema: type: string - in: path - name: timeSeriesId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: schedulesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/schedules: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list + post: + description: Creates a Schedule. + operationId: aiplatform.projects.locations.schedules.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40504,7 +39972,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -40516,24 +39984,35 @@ paths: required: true schema: type: string + get: + description: Lists Schedules in a Location. + operationId: aiplatform.projects.locations.schedules.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse + parameters: - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: projectsId required: true schema: type: string - in: path - name: runsId + name: locationsId required: true schema: type: string - - in: path - name: timeSeriesId - required: true + - in: query + name: filter schema: type: string - in: query @@ -40546,24 +40025,26 @@ paths: type: integer format: int32 - in: query - name: filter + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: parameters: *ref_1 post: 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`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel + 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.catchUp is set up true, + all missed runs will be scheduled for backfill first. + operationId: aiplatform.projects.locations.schedules.resume + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40588,39 +40069,59 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: schedulesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: + parameters: *ref_1 + post: + description: >- + 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. + operationId: aiplatform.projects.locations.schedules.pause + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PauseScheduleRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: - in: path - name: runsId + name: projectsId required: true schema: type: string - in: path - name: timeSeriesId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get + operationId: aiplatform.projects.locations.schedules.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40645,22 +40146,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: schedulesId required: true schema: type: string @@ -40675,8 +40161,7 @@ paths: 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`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete + operationId: aiplatform.projects.locations.schedules.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40701,22 +40186,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: schedulesId required: true schema: type: string @@ -40725,14 +40195,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.list + 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. + operationId: aiplatform.projects.locations.schedules.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40744,7 +40220,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40757,42 +40233,27 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: schedulesId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: timeout schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: parameters: *ref_1 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.schedules.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40804,7 +40265,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -40817,33 +40278,37 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: schedulesId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: runsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: operationsId - required: true + type: integer + format: int32 + - in: query + name: filter schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: 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`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete + 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`. + operationId: aiplatform.projects.locations.schedules.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40868,17 +40333,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: schedulesId required: true schema: type: string @@ -40887,21 +40342,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: 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`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel + 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. + operationId: aiplatform.projects.locations.specialistPools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40913,7 +40361,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40926,17 +40374,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: specialistPoolsId required: true schema: type: string @@ -40945,21 +40383,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: + delete: 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. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait + 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`. + operationId: aiplatform.projects.locations.specialistPools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40971,7 +40401,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40984,17 +40414,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: specialistPoolsId required: true schema: type: string @@ -41003,24 +40423,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: parameters: *ref_1 - post: + get: description: >- - Write time series data points into multiple TensorboardTimeSeries under - a TensorboardRun. If any data fail to be ingested, an error is returned. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.write - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.specialistPools.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41032,8 +40441,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -41046,30 +40454,37 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: specialistPoolsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: runsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: parameters: *ref_1 - patch: - description: Updates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + post: + 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. + operationId: aiplatform.projects.locations.specialistPools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41081,7 +40496,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41094,28 +40509,34 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: specialistPoolsId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask - delete: - description: Deletes a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.specialistPools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41127,7 +40548,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41140,39 +40561,32 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: specialistPoolsId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - get: - description: Gets a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.get + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: + parameters: *ref_1 + delete: + description: Deletes a SpecialistPool as well as all Specialists in the pool. + operationId: aiplatform.projects.locations.specialistPools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41185,31 +40599,17 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: specialistPoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: - parameters: *ref_1 - post: - description: Batch create TensorboardRuns. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest + - in: query + name: force + schema: + type: boolean + get: + description: Gets a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41221,8 +40621,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' parameters: - in: path name: projectsId @@ -41235,25 +40634,18 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: specialistPoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: - parameters: *ref_1 - post: - description: Creates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create + patch: + description: Updates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41265,7 +40657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41278,31 +40670,25 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: specialistPoolsId required: true schema: type: string - in: query - name: tensorboardRunId + name: updateMask schema: type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: + parameters: *ref_1 get: - description: Lists TensorboardRuns in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list + description: Lists SpecialistPools in a Location. + operationId: aiplatform.projects.locations.specialistPools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -41310,7 +40696,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse + #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse parameters: - in: path name: projectsId @@ -41322,14 +40708,8 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -41337,37 +40717,19 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - in: query name: readMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: - parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.cancel + description: Creates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41379,7 +40741,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41391,29 +40753,15 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: parameters: *ref_1 - get: + delete: 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. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get + 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`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41425,7 +40773,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41438,12 +40786,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -41452,13 +40795,12 @@ paths: required: true schema: type: string - delete: + get: 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`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete + 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. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41470,7 +40812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41483,12 +40825,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -41497,13 +40834,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.list + 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`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41515,7 +40859,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41528,29 +40872,16 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: deploymentResourcePoolsId required: true schema: type: string - in: path - name: experimentsId + name: operationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -41563,7 +40894,7 @@ paths: 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. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.wait + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41588,12 +40919,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -41607,20 +40933,13 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: parameters: *ref_1 - post: + get: description: >- - Write time series data points of multiple TensorboardTimeSeries in - multiple TensorboardRun's. If any data fail to be ingested, an error is - returned. - operationId: aiplatform.projects.locations.tensorboards.experiments.write - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41632,8 +40951,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -41646,26 +40964,28 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: deploymentResourcePoolsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: parameters: *ref_1 - patch: - description: Updates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + delete: + description: Delete a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41677,8 +40997,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41691,40 +41010,31 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: deploymentResourcePoolsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.get + patch: + description: Update a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41737,18 +41047,18 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: deploymentResourcePoolsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: updateMask schema: type: string - delete: - description: Deletes a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.delete + format: google-fieldmask + get: + description: Get a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41760,7 +41070,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool parameters: - in: path name: projectsId @@ -41773,28 +41084,21 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: deploymentResourcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: parameters: *ref_1 post: - description: >- - Batch create TensorboardTimeSeries that belong to a - TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate + description: Create a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest + #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41806,8 +41110,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41819,27 +41122,50 @@ paths: required: true schema: type: string + get: + description: List DeploymentResourcePools in a location. + operationId: aiplatform.projects.locations.deploymentResourcePools.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + parameters: - in: path - name: tensorboardsId + name: projectsId required: true schema: type: string - in: path - name: experimentsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: parameters: *ref_1 - post: - description: Creates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + get: + description: >- + List DeployedModels that have been deployed on this + DeploymentResourcePool. + operationId: >- + aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41852,7 +41178,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse parameters: - in: path name: projectsId @@ -41865,34 +41191,40 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: deploymentResourcePoolsId required: true schema: type: string - in: query - name: tensorboardExperimentId + name: pageToken schema: type: string - get: - description: Lists TensorboardExperiments in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.list + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: + parameters: *ref_1 + 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`. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41905,40 +41237,21 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: dataLabelingJobsId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: - parameters: *ref_1 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. - operationId: aiplatform.projects.locations.tensorboards.operations.get + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41963,7 +41276,7 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: dataLabelingJobsId required: true schema: type: string @@ -41972,13 +41285,13 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: + parameters: *ref_1 + get: 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`. - operationId: aiplatform.projects.locations.tensorboards.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41990,7 +41303,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -42003,16 +41316,24 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: dataLabelingJobsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -42025,7 +41346,7 @@ paths: 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. - operationId: aiplatform.projects.locations.tensorboards.operations.wait + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42050,7 +41371,59 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: dataLabelingJobsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataLabelingJobsId required: true schema: type: string @@ -42059,18 +41432,11 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.operations.list + description: Lists DataLabelingJobs in a Location. + operationId: aiplatform.projects.locations.dataLabelingJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42082,7 +41448,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse parameters: - in: path name: projectsId @@ -42094,9 +41461,8 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -42105,27 +41471,26 @@ paths: type: integer format: int32 - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query - name: pageToken + name: orderBy + schema: + type: string + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: - parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.tensorboards.operations.cancel + description: Creates a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42137,7 +41502,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -42149,24 +41514,11 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.tuningJobs.operations.get + description: Gets a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42178,7 +41530,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -42191,22 +41543,13 @@ paths: schema: type: string - in: path - name: tuningJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tuningJobs.operations.list + delete: + description: Deletes a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42218,7 +41561,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42231,37 +41574,21 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: dataLabelingJobsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.tuningJobs.operations.cancel + description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. + operationId: aiplatform.projects.locations.dataLabelingJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42286,20 +41613,15 @@ paths: schema: type: string - in: path - name: tuningJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: parameters: *ref_1 get: - description: Gets a TuningJob. - operationId: aiplatform.projects.locations.tuningJobs.get + description: Gets a BatchPredictionJob + operationId: aiplatform.projects.locations.batchPredictionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42311,7 +41633,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -42324,29 +41646,15 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: batchPredictionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: - parameters: *ref_1 - post: + delete: description: >- - Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. - 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 - TuningJob is not deleted; instead it becomes a job with a - TuningJob.error value with a google.rpc.Status.code of 1, corresponding - to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.tuningJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelTuningJobRequest + Deletes a BatchPredictionJob. Can only be called on jobs that already + finished. + operationId: aiplatform.projects.locations.batchPredictionJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42358,7 +41666,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42371,22 +41679,22 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: batchPredictionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: parameters: *ref_1 post: description: >- - Creates a TuningJob. A created TuningJob right away will be attempted to - be run. - operationId: aiplatform.projects.locations.tuningJobs.create + Creates a BatchPredictionJob. A BatchPredictionJob once created will + right away be attempted to start. + operationId: aiplatform.projects.locations.batchPredictionJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42398,7 +41706,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -42411,8 +41719,8 @@ paths: schema: type: string get: - description: Lists TuningJobs in a Location. - operationId: aiplatform.projects.locations.tuningJobs.list + description: Lists BatchPredictionJobs in a Location. + operationId: aiplatform.projects.locations.batchPredictionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42425,7 +41733,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse parameters: - in: path name: projectsId @@ -42437,6 +41745,10 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: @@ -42447,23 +41759,29 @@ paths: schema: type: string - in: query - name: pageToken + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.notebookRuntimes.assign + 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. + operationId: aiplatform.projects.locations.batchPredictionJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest + #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42475,7 +41793,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42487,17 +41805,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: + - in: path + name: batchPredictionJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}: parameters: *ref_1 - post: - description: Starts a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.start - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest + delete: + description: Deletes a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42522,21 +41839,56 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: notebookExecutionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: + get: + description: Gets a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookExecutionJobsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs: parameters: *ref_1 post: - description: Upgrades a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.upgrade + description: Creates a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42560,16 +41912,13 @@ paths: required: true schema: type: string - - in: path - name: notebookRuntimesId - required: true + - in: query + name: notebookExecutionJobId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: - parameters: *ref_1 get: - description: Lists NotebookRuntimes in a Location. - operationId: aiplatform.projects.locations.notebookRuntimes.list + description: Lists NotebookExecutionJobs in a Location. + operationId: aiplatform.projects.locations.notebookExecutionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42582,7 +41931,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse + #/components/schemas/GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse parameters: - in: path name: projectsId @@ -42595,10 +41944,13 @@ paths: schema: type: string - in: query - name: readMask + name: view + schema: + type: string + - in: query + name: orderBy schema: type: string - format: google-fieldmask - in: query name: pageSize schema: @@ -42608,19 +41960,24 @@ paths: name: pageToken schema: type: string - - in: query - name: orderBy - schema: - type: string - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 - delete: - description: Deletes a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.delete + post: + 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`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42632,7 +41989,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42645,13 +42002,22 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: notebookExecutionJobsId required: true schema: type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations: + parameters: *ref_1 get: - description: Gets a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42663,7 +42029,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -42676,19 +42042,71 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: notebookExecutionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}: parameters: *ref_1 + 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. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookExecutionJobsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string 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`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.delete + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42713,7 +42131,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: notebookExecutionJobsId required: true schema: type: string @@ -42722,12 +42140,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.get + 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. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42752,7 +42178,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: notebookExecutionJobsId required: true schema: type: string @@ -42761,13 +42187,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.list + 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`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42779,7 +42217,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42792,37 +42230,63 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: hyperparameterTuningJobsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - - in: query - name: pageSize + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true schema: - type: integer - format: int32 - - in: query - name: filter + type: string + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.wait + - in: path + name: hyperparameterTuningJobsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42834,7 +42298,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42847,7 +42311,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -42856,25 +42320,20 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.cancel + 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. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42886,7 +42345,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42899,7 +42358,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -42908,13 +42367,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.persistentResources.operations.list + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42939,12 +42403,12 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: hyperparameterTuningJobsId required: true schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -42953,18 +42417,14 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: parameters: *ref_1 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`. - operationId: aiplatform.projects.locations.persistentResources.operations.delete + description: Deletes a HyperparameterTuningJob. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42976,7 +42436,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42989,21 +42449,13 @@ paths: schema: type: string - in: path - name: persistentResourcesId - required: true - schema: - type: string - - in: path - name: operationsId + name: hyperparameterTuningJobsId required: true schema: 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. - operationId: aiplatform.projects.locations.persistentResources.operations.get + description: Gets a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43015,7 +42467,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -43028,29 +42481,15 @@ paths: schema: type: string - in: path - name: persistentResourcesId - required: true - schema: - type: string - - in: path - name: operationsId + name: hyperparameterTuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.persistentResources.operations.wait + get: + description: Lists HyperparameterTuningJobs in a Location. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43062,7 +42501,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse parameters: - in: path name: projectsId @@ -43074,35 +42514,33 @@ paths: required: true schema: type: string - - in: path - name: persistentResourcesId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask schema: type: string + format: google-fieldmask - in: query - name: timeout + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: - parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.persistentResources.operations.cancel + description: Creates a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43114,7 +42552,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -43126,26 +42565,68 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: - in: path - name: persistentResourcesId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: + - in: path + name: hyperparameterTuningJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: parameters: *ref_1 - patch: - description: Updates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.patch + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43157,7 +42638,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -43170,18 +42651,15 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: notebookRuntimeTemplatesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.delete + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: + parameters: *ref_1 + get: + description: Gets a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43193,7 +42671,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate parameters: - in: path name: projectsId @@ -43206,13 +42685,13 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: notebookRuntimeTemplatesId required: true schema: type: string - get: - description: Gets a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.get + delete: + description: Deletes a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43224,7 +42703,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43237,21 +42716,19 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: - parameters: *ref_1 - post: - description: Reboots a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.reboot + patch: + description: Updates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43263,7 +42740,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate parameters: - in: path name: projectsId @@ -43276,20 +42754,22 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: parameters: *ref_1 post: - description: Creates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43301,7 +42781,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -43313,13 +42793,27 @@ paths: required: true schema: type: string - - in: query - name: persistentResourceId + - in: path + name: notebookRuntimeTemplatesId + required: true schema: type: string - get: - description: Lists PersistentResources in a Location. - operationId: aiplatform.projects.locations.persistentResources.list + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: + parameters: *ref_1 + post: + 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. + operationId: >- + aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43331,8 +42825,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -43344,22 +42837,20 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: notebookRuntimeTemplatesId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.migratableResources.operations.list + description: Lists NotebookRuntimeTemplates in a Location. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43371,7 +42862,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse parameters: - in: path name: projectsId @@ -43383,38 +42875,37 @@ paths: required: true schema: type: string - - in: path - name: migratableResourcesId - required: true + - in: query + name: filter schema: type: string - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query name: pageToken schema: type: string + - in: query + name: orderBy + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: - parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.migratableResources.operations.cancel + description: Creates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43426,7 +42917,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43438,24 +42929,18 @@ paths: required: true schema: type: string - - in: path - name: migratableResourcesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: notebookRuntimeTemplateId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.migratableResources.operations.get + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43480,7 +42965,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -43495,7 +42980,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.migratableResources.operations.delete + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43520,7 +43005,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -43529,7 +43014,55 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookRuntimeTemplatesId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -43542,7 +43075,7 @@ paths: 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. - operationId: aiplatform.projects.locations.migratableResources.operations.wait + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43567,7 +43100,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -43581,31 +43114,106 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Batch migrates resources from ml.googleapis.com, automl.googleapis.com, - and datalabeling.googleapis.com to Vertex AI. - operationId: aiplatform.projects.locations.migratableResources.batchMigrate + 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`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookRuntimeTemplatesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: + parameters: *ref_1 + post: + description: Creates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + get: + description: Lists Tensorboards in a Location. + operationId: aiplatform.projects.locations.tensorboards.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse parameters: - in: path name: projectsId @@ -43617,20 +43225,38 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.migratableResources.search + patch: + description: Updates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43642,8 +43268,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43655,19 +43280,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43679,7 +43304,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43692,28 +43317,29 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: - parameters: *ref_1 get: - description: Lists NotebookRuntimeTemplates in a Location. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list + description: Gets a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' parameters: - in: path name: projectsId @@ -43725,37 +43351,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy + - in: path + name: tensorboardsId + required: true schema: type: string - post: - description: Creates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: + parameters: *ref_1 + get: + description: Returns a list of monthly active users for a given TensorBoard instance. + operationId: aiplatform.projects.locations.tensorboards.readUsage security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43767,7 +43372,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse parameters: - in: path name: projectsId @@ -43779,15 +43385,16 @@ paths: required: true schema: type: string - - in: query - name: notebookRuntimeTemplateId + - in: path + name: tensorboardsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: parameters: *ref_1 get: - description: Gets a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get + description: Returns the storage size for a given TensorBoard instance. + operationId: aiplatform.projects.locations.tensorboards.readSize security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43800,7 +43407,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse parameters: - in: path name: projectsId @@ -43813,19 +43420,20 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId required: true schema: type: string - patch: - description: Updates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: + parameters: *ref_1 + get: + description: >- + 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. + operationId: aiplatform.projects.locations.tensorboards.batchRead security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43838,7 +43446,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -43851,18 +43459,22 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId required: true schema: type: string - in: query - name: updateMask + name: timeSeries schema: type: string - format: google-fieldmask - delete: - description: Deletes a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: aiplatform.projects.locations.tensorboards.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43887,21 +43499,22 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: - parameters: *ref_1 - post: + - in: path + name: operationsId + required: true + schema: + type: string + delete: 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. - operationId: >- - aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions + 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`. + operationId: aiplatform.projects.locations.tensorboards.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43913,7 +43526,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43926,21 +43539,29 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId required: true schema: type: string - - in: query - name: permissions + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy + 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`. + operationId: aiplatform.projects.locations.tensorboards.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43952,7 +43573,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43965,16 +43586,16 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -43987,7 +43608,7 @@ paths: 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. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait + operationId: aiplatform.projects.locations.tensorboards.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44012,7 +43633,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId required: true schema: type: string @@ -44026,14 +43647,62 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tensorboards.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.get + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44058,7 +43727,12 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -44073,7 +43747,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44098,7 +43772,12 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -44107,13 +43786,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.list + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44138,24 +43817,29 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: experimentsId + required: true schema: type: string - in: query name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -44168,7 +43852,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44193,7 +43877,12 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -44202,18 +43891,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from - it, and freeing all resources it's using. - operationId: aiplatform.projects.locations.indexEndpoints.undeployIndex - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' + 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. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44238,22 +43929,98 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: parameters: *ref_1 + get: + description: Lists TensorboardRuns in a Location. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string post: - description: >- - Deploys an Index into this IndexEndpoint, creating a DeployedIndex - within it. Only non-empty Indexes can be deployed. - operationId: aiplatform.projects.locations.indexEndpoints.deployIndex + description: Creates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployIndexRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44265,7 +44032,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -44278,15 +44045,30 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: + - in: path + name: experimentsId + required: true + schema: + type: string + - in: query + name: tensorboardRunId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: parameters: *ref_1 - delete: - description: Deletes an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.delete + post: + description: Batch create TensorboardRuns. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44298,7 +44080,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse parameters: - in: path name: projectsId @@ -44311,49 +44094,70 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: + parameters: *ref_1 get: - description: Gets an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.get + description: Gets a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path - name: projectsId + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId required: true schema: type: string - in: path - name: locationsId + name: experimentsId required: true schema: type: string - in: path - name: indexEndpointsId + name: runsId required: true schema: type: string patch: - description: Updates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.patch + description: Updates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44365,7 +44169,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -44378,7 +44182,17 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string @@ -44387,19 +44201,9 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: - parameters: *ref_1 - post: - description: >- - Reads the datapoints/vectors of the given IDs. A maximum of 1000 - datapoints can be retrieved in a batch. - operationId: aiplatform.projects.locations.indexEndpoints.readIndexDatapoints - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsRequest + delete: + description: Deletes a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44411,8 +44215,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44425,20 +44228,33 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: parameters: *ref_1 post: - description: Update an existing DeployedIndex under an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex + description: >- + Write time series data points into multiple TensorboardTimeSeries under + a TensorboardRun. If any data fail to be ingested, an error is returned. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.write requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44450,7 +44266,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse parameters: - in: path name: projectsId @@ -44463,20 +44280,30 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Finds the nearest neighbors of each vector within the request. - operationId: aiplatform.projects.locations.indexEndpoints.findNeighbors - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequest' + 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`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44488,8 +44315,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -44502,20 +44328,37 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: - parameters: *ref_1 - post: - description: Creates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44539,9 +44382,46 @@ paths: required: true schema: type: string - get: - description: Lists IndexEndpoints in a Location. - operationId: aiplatform.projects.locations.indexEndpoints.list + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44553,8 +44433,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44566,31 +44445,44 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: tensorboardsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: experimentsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageToken + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - in: query - name: pageSize + name: timeout schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.list + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44615,32 +44507,53 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - - in: query - name: filter + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true schema: type: string - in: query name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: parameters: *ref_1 - delete: + post: 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`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.delete + 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`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44665,7 +44578,22 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId required: true schema: type: string @@ -44674,12 +44602,18 @@ paths: required: true schema: 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. - operationId: aiplatform.projects.locations.indexEndpoints.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: + parameters: *ref_1 + patch: + description: Updates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44691,7 +44625,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -44704,29 +44639,34 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.cancel + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44738,7 +44678,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44751,41 +44691,46 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.indexEndpoints.operations.wait + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + get: + description: Gets a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -44798,37 +44743,51 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: runsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: + - in: path + name: timeSeriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: parameters: *ref_1 - delete: - description: Deletes a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.delete + get: + description: >- + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse parameters: - in: path name: projectsId @@ -44841,13 +44800,43 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: tensorboardsId required: true schema: type: string - get: - description: Gets a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.get + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: blobIds + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: + parameters: *ref_1 + post: + description: >- + Exports a TensorboardTimeSeries' data. Data is returned in paginated + responses. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44859,7 +44848,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -44872,21 +44862,37 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: parameters: *ref_1 post: - description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. - operationId: aiplatform.projects.locations.dataLabelingJobs.cancel + description: Creates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44898,7 +44904,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -44911,20 +44918,37 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: - parameters: *ref_1 + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: query + name: tensorboardTimeSeriesId + schema: + type: string get: - description: Lists DataLabelingJobs in a Location. - operationId: aiplatform.projects.locations.dataLabelingJobs.list + description: Lists TensorboardTimeSeries in a Location. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -44932,7 +44956,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -44944,20 +44968,35 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true schema: type: string - format: google-fieldmask - in: query - name: orderBy + name: readMask schema: type: string + format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: orderBy + schema: + type: string - in: query name: pageToken schema: @@ -44966,26 +45005,34 @@ paths: name: filter schema: type: string - post: - description: Creates a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: + parameters: *ref_1 + get: + description: >- + 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. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -44997,7 +45044,36 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: maxDataPoints + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -45010,7 +45086,8 @@ paths: 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. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.wait + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45035,69 +45112,31 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: tensorboardsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: dataLabelingJobsId + name: operationsId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: timeout schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -45110,7 +45149,8 @@ paths: 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`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.cancel + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45135,7 +45175,17 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string @@ -45144,14 +45194,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45163,7 +45213,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -45176,56 +45226,34 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - in: path - name: projectsId + name: runsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: dataLabelingJobsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: parameters: *ref_1 delete: description: >- @@ -45233,7 +45261,8 @@ paths: 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`. - operationId: aiplatform.projects.locations.customJobs.operations.delete + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45258,7 +45287,17 @@ paths: schema: type: string - in: path - name: customJobsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string @@ -45272,7 +45311,8 @@ paths: 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. - operationId: aiplatform.projects.locations.customJobs.operations.get + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45297,54 +45337,17 @@ paths: schema: type: string - in: path - name: customJobsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.customJobs.operations.cancel - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId + name: tensorboardsId required: true schema: type: string - in: path - name: locationsId + name: experimentsId required: true schema: type: string - in: path - name: customJobsId + name: runsId required: true schema: type: string @@ -45353,25 +45356,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.customJobs.operations.list + description: Lists TensorboardExperiments in a Location. + operationId: aiplatform.projects.locations.tensorboards.experiments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse parameters: - in: path name: projectsId @@ -45384,16 +45390,21 @@ paths: schema: type: string - in: path - name: customJobsId + name: tensorboardsId required: true schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query - name: filter + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken schema: type: string - in: query @@ -45401,20 +45412,19 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: - parameters: *ref_1 + - in: query + name: orderBy + schema: + type: string post: - 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. - operationId: aiplatform.projects.locations.customJobs.operations.wait + description: Creates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45426,7 +45436,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -45439,32 +45450,19 @@ paths: schema: type: string - in: path - name: customJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: tensorboardsId required: true schema: type: string - in: query - name: timeout + name: tensorboardExperimentId schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/customJobs: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: parameters: *ref_1 - post: - description: >- - Creates a CustomJob. A created CustomJob right away will be attempted to - be run. - operationId: aiplatform.projects.locations.customJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + delete: + description: Deletes a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45476,7 +45474,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45488,9 +45486,25 @@ paths: required: true schema: type: string - get: - description: Lists CustomJobs in a Location. - operationId: aiplatform.projects.locations.customJobs.list + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + patch: + description: Updates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45503,7 +45517,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -45515,41 +45529,41 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: tensorboardsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: experimentsId + required: true schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: - parameters: *ref_1 + format: google-fieldmask get: - description: Gets a CustomJob. - operationId: aiplatform.projects.locations.customJobs.get + description: Gets a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -45562,96 +45576,28 @@ paths: schema: type: string - in: path - name: customJobsId - required: true - schema: - type: string - delete: - description: Deletes a CustomJob. - operationId: aiplatform.projects.locations.customJobs.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: tensorboardsId required: true schema: type: string - in: path - name: customJobsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: parameters: *ref_1 post: description: >- - 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`. - operationId: aiplatform.projects.locations.customJobs.cancel + Batch create TensorboardTimeSeries that belong to a + TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelCustomJobRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: customJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: - parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.trainingPipelines.operations.get + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45663,7 +45609,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -45676,22 +45623,29 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: + parameters: *ref_1 + post: 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`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.delete + Write time series data points of multiple TensorboardTimeSeries in + multiple TensorboardRun's. If any data fail to be ingested, an error is + returned. + operationId: aiplatform.projects.locations.tensorboards.experiments.write + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45703,7 +45657,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse parameters: - in: path name: projectsId @@ -45716,29 +45671,25 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.trainingPipelines.operations.wait + description: Marks a Trial as complete. + operationId: aiplatform.projects.locations.studies.trials.complete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45750,7 +45701,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -45763,34 +45714,30 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: studiesId required: true schema: type: string - in: path - name: operationsId + name: trialsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.cancel + Checks whether a Trial should stop or not. Returns a long-running + operation. When the operation is successful, it will contain a + CheckTrialEarlyStoppingStateResponse. + operationId: >- + aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45802,7 +45749,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45815,22 +45762,29 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: studiesId required: true schema: type: string - in: path - name: operationsId + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.list + 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 + operationId: aiplatform.projects.locations.studies.trials.listOptimalTrials + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45842,7 +45796,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse parameters: - in: path name: projectsId @@ -45855,35 +45810,20 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: studiesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: parameters: *ref_1 post: - description: >- - Creates a TrainingPipeline. A created TrainingPipeline right away will - be attempted to be run. - operationId: aiplatform.projects.locations.trainingPipelines.create + description: Adds a user provided Trial to a Study. + operationId: aiplatform.projects.locations.studies.trials.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45895,7 +45835,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -45907,9 +45847,14 @@ paths: required: true schema: type: string + - in: path + name: studiesId + required: true + schema: + type: string get: - description: Lists TrainingPipelines in a Location. - operationId: aiplatform.projects.locations.trainingPipelines.list + description: Lists the Trials associated with a Study. + operationId: aiplatform.projects.locations.studies.trials.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45921,8 +45866,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' parameters: - in: path name: projectsId @@ -45934,29 +45878,25 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: studiesId + required: true schema: type: string - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: pageSize schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: parameters: *ref_1 get: - description: Gets a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.get + description: Gets a Trial. + operationId: aiplatform.projects.locations.studies.trials.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45968,7 +45908,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -45981,13 +45921,18 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: studiesId + required: true + schema: + type: string + - in: path + name: trialsId required: true schema: type: string delete: - description: Deletes a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.delete + description: Deletes a Trial. + operationId: aiplatform.projects.locations.studies.trials.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45999,7 +45944,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -46012,66 +45957,29 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: + - in: path + name: trialsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: parameters: *ref_1 post: description: >- - 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`. - operationId: aiplatform.projects.locations.trainingPipelines.cancel + 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. + operationId: aiplatform.projects.locations.studies.trials.suggest requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: trainingPipelinesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: - parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.get + $ref: '#/components/schemas/GoogleCloudAiplatformV1SuggestTrialsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46096,22 +46004,20 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId - required: true - schema: - type: string - - in: path - name: operationsId + name: studiesId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: + parameters: *ref_1 + post: + description: Stops a Trial. + operationId: aiplatform.projects.locations.studies.trials.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46123,7 +46029,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -46136,29 +46042,28 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: studiesId required: true schema: type: string - in: path - name: operationsId + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: parameters: *ref_1 post: 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. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.wait + Adds a measurement of the objective metrics to a Trial. This measurement + is assumed to have been taken before the Trial is complete. + operationId: aiplatform.projects.locations.studies.trials.addTrialMeasurement + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddTrialMeasurementRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46170,7 +46075,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -46183,21 +46088,16 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: studiesId required: true schema: type: string - in: path - name: operationsId + name: trialsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -46210,7 +46110,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.cancel + operationId: aiplatform.projects.locations.studies.trials.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46235,7 +46135,12 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: studiesId + required: true + schema: + type: string + - in: path + name: trialsId required: true schema: type: string @@ -46244,13 +46149,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.list + 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. + operationId: aiplatform.projects.locations.studies.trials.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46262,7 +46168,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46275,28 +46181,27 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: studiesId required: true schema: type: string - - in: query - name: filter + - in: path + name: trialsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: - parameters: *ref_1 - get: - description: List DeploymentResourcePools in a location. - operationId: aiplatform.projects.locations.deploymentResourcePools.list + 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`. + operationId: aiplatform.projects.locations.studies.trials.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46308,8 +46213,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -46321,55 +46225,28 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: studiesId + required: true schema: type: string - post: - description: Create a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: trialsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: parameters: *ref_1 get: description: >- - List DeployedModels that have been deployed on this - DeploymentResourcePool. - operationId: >- - aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.studies.trials.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46381,8 +46258,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -46395,24 +46271,42 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: studiesId + required: true + schema: + type: string + - in: path + name: trialsId required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: parameters: *ref_1 - delete: - description: Delete a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.delete + post: + 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. + operationId: aiplatform.projects.locations.studies.trials.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46437,95 +46331,33 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId - required: true - schema: - type: string - patch: - description: Update a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId + name: studiesId required: true schema: type: string - in: path - name: locationsId + name: trialsId required: true schema: type: string - in: path - name: deploymentResourcePoolsId + name: operationsId required: true schema: type: string - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Get a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: deploymentResourcePoolsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: - parameters: *ref_1 - post: - description: Add/update Datapoints into an Index. - operationId: aiplatform.projects.locations.indexes.upsertDatapoints - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: aiplatform.projects.locations.studies.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46537,8 +46369,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46551,20 +46382,22 @@ paths: schema: type: string - in: path - name: indexesId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: - parameters: *ref_1 - patch: - description: Updates an Index. - operationId: aiplatform.projects.locations.indexes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: aiplatform.projects.locations.studies.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46576,7 +46409,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -46589,20 +46422,29 @@ paths: schema: type: string - in: path - name: indexesId + name: studiesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - delete: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Deletes an Index. An Index can only be deleted when all its - DeployedIndexes had been undeployed. - operationId: aiplatform.projects.locations.indexes.delete + 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`. + operationId: aiplatform.projects.locations.studies.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46614,7 +46456,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -46627,13 +46469,29 @@ paths: schema: type: string - in: path - name: indexesId + name: studiesId required: true schema: type: string - get: - description: Gets an Index. - operationId: aiplatform.projects.locations.indexes.get + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: aiplatform.projects.locations.studies.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46645,7 +46503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46658,15 +46516,27 @@ paths: schema: type: string - in: path - name: indexesId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: parameters: *ref_1 get: - description: Lists Indexes in a Location. - operationId: aiplatform.projects.locations.indexes.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.studies.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46678,8 +46548,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -46691,16 +46560,11 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + - in: path + name: studiesId + required: true schema: type: string - format: google-fieldmask - in: query name: pageToken schema: @@ -46709,14 +46573,23 @@ paths: name: filter schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: + parameters: *ref_1 post: - description: Creates an Index. - operationId: aiplatform.projects.locations.indexes.create + description: >- + Looks a study up using the user-defined display_name field instead of + the fully qualified resource name. + operationId: aiplatform.projects.locations.studies.lookup requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LookupStudyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46728,7 +46601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -46740,17 +46613,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: + /v1/projects/{projectsId}/locations/{locationsId}/studies: parameters: *ref_1 post: - description: Remove Datapoints from an Index. - operationId: aiplatform.projects.locations.indexes.removeDatapoints + description: >- + Creates a Study. A resource name will be generated after creation of the + Study. + operationId: aiplatform.projects.locations.studies.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46762,8 +46636,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -46775,18 +46648,9 @@ paths: required: true schema: type: string - - in: path - name: indexesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: - parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexes.operations.list + description: Lists all the studies in a region for an associated project. + operationId: aiplatform.projects.locations.studies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46798,7 +46662,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse parameters: - in: path name: projectsId @@ -46810,33 +46675,20 @@ paths: required: true schema: type: string - - in: path - name: indexesId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: parameters: *ref_1 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`. - operationId: aiplatform.projects.locations.indexes.operations.delete + description: Deletes a Study. + operationId: aiplatform.projects.locations.studies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46861,21 +46713,13 @@ paths: schema: type: string - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId + name: studiesId required: true schema: 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. - operationId: aiplatform.projects.locations.indexes.operations.get + description: Gets a Study by name. + operationId: aiplatform.projects.locations.studies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46887,7 +46731,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -46900,29 +46744,17 @@ paths: schema: type: string - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: parameters: *ref_1 - post: + get: 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`. - operationId: aiplatform.projects.locations.indexes.operations.cancel + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46934,7 +46766,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -46947,7 +46779,7 @@ paths: schema: type: string - in: path - name: indexesId + name: featureGroupsId required: true schema: type: string @@ -46956,8 +46788,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: - parameters: *ref_1 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -46969,7 +46812,7 @@ paths: 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. - operationId: aiplatform.projects.locations.indexes.operations.wait + operationId: aiplatform.projects.locations.featureGroups.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46994,7 +46837,7 @@ paths: schema: type: string - in: path - name: indexesId + name: featureGroupsId required: true schema: type: string @@ -47008,11 +46851,15 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: parameters: *ref_1 - get: - description: Lists MetadataStores for a Location. - operationId: aiplatform.projects.locations.metadataStores.list + 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`. + operationId: aiplatform.projects.locations.featureGroups.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47024,8 +46871,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47037,23 +46883,22 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: featureGroupsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 - post: - description: Initializes a MetadataStore, including allocation of resources. - operationId: aiplatform.projects.locations.metadataStores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + 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. + operationId: aiplatform.projects.locations.featureGroups.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47077,15 +46922,21 @@ paths: required: true schema: type: string - - in: query - name: metadataStoreId + - in: path + name: featureGroupsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: parameters: *ref_1 get: - description: Retrieves a specific MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.get + description: Lists Features in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47097,7 +46948,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -47110,61 +46962,45 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - delete: - description: >- - Deletes a single MetadataStore and all its child resources (Artifacts, - Executions, and Contexts). - operationId: aiplatform.projects.locations.metadataStores.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: readMask schema: type: string + format: google-fieldmask - in: query - name: force + name: filter schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: - parameters: *ref_1 + type: string + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - 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`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.cancel + description: Creates a new Feature in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47176,7 +47012,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47189,28 +47025,19 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: featureGroupsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: featureId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.get + delete: + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47235,27 +47062,23 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: featureGroupsId required: true schema: type: string - in: path - name: operationsId + name: featuresId required: true schema: type: string - 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`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.delete + patch: + description: Updates the parameters of a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47267,7 +47090,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47280,27 +47103,23 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: - parameters: *ref_1 + format: google-fieldmask get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.list + description: Gets details of a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47312,7 +47131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -47325,42 +47144,24 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: parameters: *ref_1 - post: + delete: 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. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.wait + 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`. + operationId: aiplatform.projects.locations.featureGroups.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47372,7 +47173,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47385,12 +47186,12 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string @@ -47399,16 +47200,12 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: - parameters: *ref_1 - delete: - description: Deletes an Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.delete + 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. + operationId: aiplatform.projects.locations.featureGroups.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47433,27 +47230,27 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string - - in: query - name: etag + - in: path + name: operationsId + required: true schema: type: string - patch: - description: Updates a stored Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47465,7 +47262,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -47478,27 +47275,45 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: allowMissing + name: pageToken schema: - type: boolean + type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - format: google-fieldmask - get: - description: Retrieves a specific Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.get + post: + 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. + operationId: aiplatform.projects.locations.featureGroups.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47510,7 +47325,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47523,26 +47338,35 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: parameters: *ref_1 - post: - description: Purges Artifacts. - operationId: aiplatform.projects.locations.metadataStores.artifacts.purge + patch: + description: Updates the parameters of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47567,20 +47391,18 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: - parameters: *ref_1 - post: - description: Creates an Artifact associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47592,7 +47414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47605,17 +47427,17 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: query - name: artifactId + name: force schema: - type: string + type: boolean get: - description: Lists Artifacts in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.list + description: Gets details of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47627,8 +47449,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' parameters: - in: path name: projectsId @@ -47641,35 +47462,15 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: parameters: *ref_1 get: - description: >- - Retrieves lineage of an Artifact represented through Artifacts and - Executions connected by Event edges and returned as a LineageSubgraph. - operationId: >- - aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph + description: Lists FeatureGroups in a given project and location. + operationId: aiplatform.projects.locations.featureGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47681,7 +47482,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse parameters: - in: path name: projectsId @@ -47693,35 +47495,31 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId - required: true + - in: query + name: filter schema: type: string - in: query - name: filter + name: orderBy schema: type: string - in: query - name: maxHops + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string post: - description: Creates a MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create + description: Creates a new FeatureGroup in a given project and location. + operationId: aiplatform.projects.locations.featureGroups.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47733,7 +47531,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47745,18 +47543,20 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - in: query - name: metadataSchemaId + name: featureGroupId schema: type: string - get: - description: Lists MetadataSchemas. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: + parameters: *ref_1 + post: + description: Perform a token counting. + operationId: aiplatform.projects.locations.publishers.models.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47769,7 +47569,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -47782,40 +47582,42 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: publishersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: modelsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: parameters: *ref_1 - get: - description: Retrieves a specific MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get + post: + description: Perform a streaming online prediction with an arbitrary HTTP payload. + operationId: aiplatform.projects.locations.publishers.models.streamRawPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -47828,35 +47630,41 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: publishersId required: true schema: type: string - in: path - name: metadataSchemasId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.metadataStores.operations.get + post: + description: Perform an online prediction. + operationId: aiplatform.projects.locations.publishers.models.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -47869,34 +47677,45 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: + parameters: *ref_1 + post: 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`. - operationId: aiplatform.projects.locations.metadataStores.operations.delete + Perform a server-side streaming online prediction request for Vertex LLM + streaming. + operationId: aiplatform.projects.locations.publishers.models.serverStreamingPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -47909,41 +47728,43 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: parameters: *ref_1 post: - 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. - operationId: aiplatform.projects.locations.metadataStores.operations.wait + description: Generate content with multimodal inputs. + operationId: aiplatform.projects.locations.publishers.models.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -47956,27 +47777,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.operations.list + post: + description: Return a list of tokens based on the input text. + operationId: aiplatform.projects.locations.publishers.models.computeTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47988,7 +47807,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -48001,49 +47821,46 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: publishersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: modelsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: parameters: *ref_1 post: 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`. - operationId: aiplatform.projects.locations.metadataStores.operations.cancel + 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. + operationId: aiplatform.projects.locations.publishers.models.rawPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -48056,41 +47873,43 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.cancel + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.projects.locations.publishers.models.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -48103,27 +47922,20 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.list + description: Lists MetadataStores for a Location. + operationId: aiplatform.projects.locations.metadataStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48135,7 +47947,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse parameters: - in: path name: projectsId @@ -48147,37 +47960,23 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: - parameters: *ref_1 - 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. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.get + post: + description: Initializes a MetadataStore, including allocation of resources. + operationId: aiplatform.projects.locations.metadataStores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48199,30 +47998,17 @@ paths: - in: path name: locationsId required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - 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`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.delete + schema: + type: string + - in: query + name: metadataStoreId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: + parameters: *ref_1 + get: + description: Retrieves a specific MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48234,7 +48020,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' parameters: - in: path name: projectsId @@ -48251,30 +48037,11 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: + delete: 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. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.wait + Deletes a single MetadataStore and all its child resources (Artifacts, + Executions, and Contexts). + operationId: aiplatform.projects.locations.metadataStores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48303,29 +48070,15 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - in: query - name: timeout + name: force schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: parameters: *ref_1 get: - description: >- - Retrieves Artifacts and Executions within the specified Context, - connected by Event edges and returned as a LineageSubgraph. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph + description: Lists MetadataSchemas. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48337,7 +48090,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse parameters: - in: path name: projectsId @@ -48354,26 +48108,27 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: - parameters: *ref_1 post: - description: >- - 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. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions + description: Creates a MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48385,8 +48140,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -48403,16 +48157,15 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true + - in: query + name: metadataSchemaId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: parameters: *ref_1 get: - description: Retrieves a specific Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.get + description: Retrieves a specific MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48424,7 +48177,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -48442,10 +48195,12 @@ paths: schema: type: string - in: path - name: contextsId + name: metadataSchemasId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: + parameters: *ref_1 delete: description: Deletes a stored Context. operationId: aiplatform.projects.locations.metadataStores.contexts.delete @@ -48540,21 +48295,50 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: + get: + description: Retrieves a specific Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: parameters: *ref_1 - post: + get: description: >- - 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. + Retrieves Artifacts and Executions within the specified Context, + connected by Event edges and returned as a LineageSubgraph. operationId: >- - aiplatform.projects.locations.metadataStores.contexts.removeContextChildren - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest + aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48566,8 +48350,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -48623,16 +48406,12 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - in: query name: filter schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - in: query @@ -48640,6 +48419,10 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string post: description: Creates a Context associated with a MetadataStore. operationId: aiplatform.projects.locations.metadataStores.contexts.create @@ -48718,6 +48501,55 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: parameters: *ref_1 post: @@ -48768,15 +48600,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: parameters: *ref_1 - get: + post: description: >- - Obtains the set of input and output Artifacts for this Execution, in the - form of LineageSubgraph that also contains the Execution and connecting - Events. + 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. operationId: >- - aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs + aiplatform.projects.locations.metadataStores.contexts.removeContextChildren + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48788,7 +48626,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse parameters: - in: path name: projectsId @@ -48806,20 +48645,24 @@ paths: schema: type: string - in: path - name: executionsId + name: contextsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Creates an Execution associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + 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. + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48831,7 +48674,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48848,13 +48691,29 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string - in: query - name: executionId + name: timeout schema: type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Lists Executions in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.list + 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. + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48866,8 +48725,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48884,13 +48742,99 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: contextsId + required: true schema: - type: integer - format: int32 - - in: query - name: orderBy + type: string + - in: path + name: operationsId + required: true + schema: + type: string + 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`. + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId + required: true schema: type: string - in: query @@ -48901,16 +48845,25 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: parameters: *ref_1 - patch: - description: Updates a stored Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + post: + 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`. + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48922,7 +48875,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -48940,22 +48893,30 @@ paths: schema: type: string - in: path - name: executionsId + name: contextsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean - get: - description: Retrieves a specific Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.get + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48967,7 +48928,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -48989,9 +48950,21 @@ paths: required: true schema: type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: + parameters: *ref_1 delete: - description: Deletes an Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.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`. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49003,7 +48976,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -49025,21 +48998,17 @@ paths: required: true schema: type: string - - in: query - name: etag + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: - parameters: *ref_1 - post: - description: Purges Executions. - operationId: aiplatform.projects.locations.metadataStores.executions.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest + 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. + operationId: aiplatform.projects.locations.metadataStores.executions.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49068,22 +49037,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: + - in: path + name: executionsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: parameters: *ref_1 - post: + get: description: >- - 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. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.addExecutionEvents - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.executions.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49095,8 +49065,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -49118,6 +49087,19 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: parameters: *ref_1 post: @@ -49175,14 +49157,22 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: parameters: *ref_1 - get: + post: 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. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.get + 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. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.addExecutionEvents + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49194,7 +49184,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse parameters: - in: path name: projectsId @@ -49216,19 +49207,11 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - 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`. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: + parameters: *ref_1 + get: + description: Lists Executions in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49240,7 +49223,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse parameters: - in: path name: projectsId @@ -49257,31 +49241,31 @@ paths: required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: - parameters: *ref_1 post: - 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`. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.operations.cancel + description: Creates an Execution associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49293,7 +49277,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -49310,23 +49294,15 @@ paths: required: true schema: type: string - - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: executionId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.list + description: Retrieves a specific Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49338,7 +49314,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -49360,33 +49336,14 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.cancel + patch: + description: Updates a stored Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49398,7 +49355,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -49411,24 +49368,27 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: - parameters: *ref_1 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean 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`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.delete + description: Deletes an Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49440,7 +49400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49453,21 +49413,30 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: 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. - operationId: aiplatform.projects.locations.pipelineJobs.operations.get + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: + parameters: *ref_1 + post: + description: Purges Executions. + operationId: aiplatform.projects.locations.metadataStores.executions.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49492,22 +49461,19 @@ paths: schema: type: string - in: path - name: pipelineJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.list + Obtains the set of input and output Artifacts for this Execution, in the + form of LineageSubgraph that also contains the Execution and connecting + Events. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49519,7 +49485,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -49532,37 +49498,25 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: executionsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: parameters: *ref_1 - post: - 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. - operationId: aiplatform.projects.locations.pipelineJobs.operations.wait + patch: + description: Updates a stored Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49574,7 +49528,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -49587,25 +49541,27 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: artifactsId required: true schema: type: string - in: query - name: timeout + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: - parameters: *ref_1 + format: google-fieldmask get: - description: Gets a PipelineJob. - operationId: aiplatform.projects.locations.pipelineJobs.get + description: Retrieves a specific Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49617,7 +49573,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -49630,13 +49586,18 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string delete: - description: Deletes a PipelineJob. - operationId: aiplatform.projects.locations.pipelineJobs.delete + description: Deletes an Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49661,30 +49622,30 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: + - in: path + name: artifactsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: parameters: *ref_1 post: - description: >- - 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`. - operationId: aiplatform.projects.locations.pipelineJobs.cancel + description: Purges Artifacts. + operationId: aiplatform.projects.locations.metadataStores.artifacts.purge requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest + #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49696,7 +49657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49709,27 +49670,18 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: parameters: *ref_1 - post: + get: description: >- - 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. - operationId: aiplatform.projects.locations.pipelineJobs.batchCancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest + Retrieves lineage of an Artifact represented through Artifacts and + Executions connected by Event edges and returned as a LineageSubgraph. + operationId: >- + aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49741,7 +49693,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -49753,11 +49705,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId + required: true + schema: + type: string + - in: query + name: maxHops + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: parameters: *ref_1 get: - description: Lists PipelineJobs in a Location. - operationId: aiplatform.projects.locations.pipelineJobs.list + description: Lists Artifacts in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49770,7 +49741,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse parameters: - in: path name: projectsId @@ -49782,10 +49753,19 @@ paths: required: true schema: type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string - in: query name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: orderBy schema: @@ -49795,23 +49775,14 @@ paths: schema: type: integer format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string post: - description: Creates a PipelineJob. A PipelineJob will run immediately when created. - operationId: aiplatform.projects.locations.pipelineJobs.create + description: Creates an Artifact associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49823,7 +49794,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -49835,24 +49806,29 @@ paths: required: true schema: type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string - in: query - name: pipelineJobId + name: artifactId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - 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. - operationId: aiplatform.projects.locations.pipelineJobs.batchDelete - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest + 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. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49876,73 +49852,45 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: - parameters: *ref_1 - post: - description: >- - 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`. - operationId: aiplatform.projects.locations.nasJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - in: path - name: projectsId + name: metadataStoresId required: true schema: type: string - in: path - name: locationsId + name: artifactsId required: true schema: type: string - in: path - name: nasJobsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: parameters: *ref_1 get: - description: Gets a NasJob - operationId: aiplatform.projects.locations.nasJobs.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -49950,18 +49898,42 @@ paths: schema: type: string - in: path - name: locationsId + name: locationsId + required: true + schema: + type: string + - in: path + name: metadataStoresId required: true schema: type: string - in: path - name: nasJobsId + name: artifactsId required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}: + parameters: *ref_1 delete: - description: Deletes a NasJob. - operationId: aiplatform.projects.locations.nasJobs.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`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49973,7 +49945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -49986,15 +49958,26 @@ paths: schema: type: string - in: path - name: nasJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: - parameters: *ref_1 get: - description: Lists NasJobs in a Location. - operationId: aiplatform.projects.locations.nasJobs.list + 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. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50006,8 +49989,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50019,32 +50001,35 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: metadataStoresId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: artifactsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Creates a NasJob - operationId: aiplatform.projects.locations.nasJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + 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`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50056,7 +50041,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50068,11 +50053,35 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: List top NasTrialDetails of a NasJob. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list + post: + 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. + operationId: aiplatform.projects.locations.metadataStores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50084,8 +50093,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50098,24 +50106,29 @@ paths: schema: type: string - in: path - name: nasJobsId + name: metadataStoresId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: parameters: *ref_1 - get: - description: Gets a NasTrialDetail. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.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`. + operationId: aiplatform.projects.locations.metadataStores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50127,7 +50140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50140,25 +50153,21 @@ paths: schema: type: string - in: path - name: nasJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: nasTrialDetailsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: - parameters: *ref_1 - patch: - description: Updates a Model. - operationId: aiplatform.projects.locations.models.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + 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. + operationId: aiplatform.projects.locations.metadataStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50170,7 +50179,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50183,20 +50192,22 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - delete: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: + parameters: *ref_1 + get: description: >- - Deletes a Model. A model cannot be deleted if any Endpoint resource has - a DeployedModel based on the model in its deployed_models field. - operationId: aiplatform.projects.locations.models.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50208,7 +50219,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -50221,13 +50232,37 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - get: - description: Gets a Model. - operationId: aiplatform.projects.locations.models.get + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.metadataStores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50239,7 +50274,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50252,15 +50287,20 @@ paths: schema: type: string - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: parameters: *ref_1 get: - description: Lists Models in a Location. - operationId: aiplatform.projects.locations.models.list + description: Lists NotebookRuntimes in a Location. + operationId: aiplatform.projects.locations.notebookRuntimes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50272,7 +50312,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse parameters: - in: path name: projectsId @@ -50285,17 +50326,11 @@ paths: schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -50303,20 +50338,20 @@ paths: schema: type: string - in: query - name: pageToken + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: parameters: *ref_1 - post: - description: Merges a set of aliases for a Model version. - operationId: aiplatform.projects.locations.models.mergeVersionAliases - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MergeVersionAliasesRequest + get: + description: Gets a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50328,7 +50363,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' parameters: - in: path name: projectsId @@ -50341,17 +50376,13 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: - parameters: *ref_1 - post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.models.getIamPolicy + delete: + description: Deletes a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50363,7 +50394,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50376,28 +50407,24 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimesId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.models.setIamPolicy + Assigns a NotebookRuntime to a user for a particular Notebook file. This + method will either returns an existing assignment or generates a new + one. + operationId: aiplatform.projects.locations.notebookRuntimes.assign requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50409,7 +50436,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50421,21 +50448,17 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:upload: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: parameters: *ref_1 post: - description: Uploads a Model artifact into Vertex AI. - operationId: aiplatform.projects.locations.models.upload + description: Upgrades a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.upgrade requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50459,19 +50482,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: + - in: path + name: notebookRuntimesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: parameters: *ref_1 post: - description: >- - 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. - operationId: aiplatform.projects.locations.models.export + description: Starts a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.start requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportModelRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50496,15 +50522,17 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations: parameters: *ref_1 get: - description: Lists versions of the specified model. - operationId: aiplatform.projects.locations.models.listVersions + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50516,8 +50544,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -50530,16 +50557,16 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimesId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query - name: orderBy + name: filter schema: type: string - in: query @@ -50547,26 +50574,20 @@ paths: schema: type: integer format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Incrementally update the dataset used for an examples model. - operationId: aiplatform.projects.locations.models.updateExplanationDataset - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpdateExplanationDatasetRequest + 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`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50578,7 +50599,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50591,20 +50612,23 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}: parameters: *ref_1 - post: + get: 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. - operationId: aiplatform.projects.locations.models.testIamPermissions + 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. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50616,7 +50640,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50629,22 +50653,22 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimesId required: true schema: type: string - - in: query - name: permissions + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: - parameters: *ref_1 delete: description: >- - 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. - operationId: aiplatform.projects.locations.models.deleteVersion + 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`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50656,7 +50680,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50669,49 +50693,16 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:copy: - parameters: *ref_1 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.models.copy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId + name: notebookRuntimesId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -50724,7 +50715,7 @@ paths: 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. - operationId: aiplatform.projects.locations.models.evaluations.operations.wait + operationId: aiplatform.projects.locations.notebookRuntimes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50749,12 +50740,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: notebookRuntimesId required: true schema: type: string @@ -50763,25 +50749,19 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.models.evaluations.operations.cancel + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: + parameters: *ref_1 + 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. + operationId: aiplatform.projects.locations.trainingPipelines.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50793,7 +50773,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50806,12 +50786,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: trainingPipelinesId required: true schema: type: string @@ -50820,15 +50795,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: - parameters: *ref_1 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`. - operationId: aiplatform.projects.locations.models.evaluations.operations.delete + operationId: aiplatform.projects.locations.trainingPipelines.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50853,12 +50826,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: trainingPipelinesId required: true schema: type: string @@ -50867,12 +50835,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: 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. - operationId: aiplatform.projects.locations.models.evaluations.operations.get + 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`. + operationId: aiplatform.projects.locations.trainingPipelines.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50884,7 +50860,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50897,12 +50873,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: trainingPipelinesId required: true schema: type: string @@ -50911,13 +50882,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.evaluations.operations.list + 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. + operationId: aiplatform.projects.locations.trainingPipelines.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50929,7 +50907,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50942,33 +50920,27 @@ paths: schema: type: string - in: path - name: modelsId + name: trainingPipelinesId required: true schema: type: string - in: path - name: evaluationsId + name: operationsId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: timeout schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: parameters: *ref_1 get: - description: Lists ModelEvaluationSlices in a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.slices.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.trainingPipelines.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50980,8 +50952,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -50994,24 +50965,10 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: trainingPipelinesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - in: query name: pageSize schema: @@ -51021,17 +50978,30 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: parameters: *ref_1 post: - description: Imports a list of externally generated EvaluatedAnnotations. - operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport + description: >- + 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`. + operationId: aiplatform.projects.locations.trainingPipelines.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51043,8 +51013,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -51057,25 +51026,15 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: path - name: slicesId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: parameters: *ref_1 get: - description: Gets a ModelEvaluationSlice. - operationId: aiplatform.projects.locations.models.evaluations.slices.get + description: Gets a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51087,8 +51046,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' parameters: - in: path name: projectsId @@ -51101,25 +51059,13 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: path - name: slicesId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: - parameters: *ref_1 - get: - description: Gets a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.get + delete: + description: Deletes a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51131,7 +51077,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -51144,26 +51090,22 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: parameters: *ref_1 post: - description: Imports an externally generated ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.import + description: >- + Creates a TrainingPipeline. A created TrainingPipeline right away will + be attempted to be run. + operationId: aiplatform.projects.locations.trainingPipelines.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51175,7 +51117,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' parameters: - in: path name: projectsId @@ -51187,16 +51129,9 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: - parameters: *ref_1 get: - description: Lists ModelEvaluations in a Model. - operationId: aiplatform.projects.locations.models.evaluations.list + description: Lists TrainingPipelines in a Location. + operationId: aiplatform.projects.locations.trainingPipelines.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51209,7 +51144,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse + #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse parameters: - in: path name: projectsId @@ -51221,30 +51156,25 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -51257,7 +51187,7 @@ paths: 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. - operationId: aiplatform.projects.locations.models.operations.wait + operationId: aiplatform.projects.locations.indexes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51282,7 +51212,7 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string @@ -51296,14 +51226,14 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: aiplatform.projects.locations.models.operations.get + operationId: aiplatform.projects.locations.indexes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51328,7 +51258,7 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string @@ -51343,7 +51273,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.models.operations.delete + operationId: aiplatform.projects.locations.indexes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51368,7 +51298,7 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string @@ -51377,13 +51307,60 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: aiplatform.projects.locations.indexes.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: indexesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.operations.list + operationId: aiplatform.projects.locations.indexes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51408,10 +51385,14 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: @@ -51421,24 +51402,11 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: parameters: *ref_1 - post: - 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`. - operationId: aiplatform.projects.locations.models.operations.cancel + get: + description: Gets an Index. + operationId: aiplatform.projects.locations.indexes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51450,7 +51418,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' parameters: - in: path name: projectsId @@ -51463,20 +51431,56 @@ paths: schema: type: string - in: path - name: modelsId + name: indexesId + required: true + schema: + type: string + patch: + description: Updates an Index. + operationId: aiplatform.projects.locations.indexes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: - parameters: *ref_1 - get: - description: Gets a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get + - in: path + name: indexesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes an Index. An Index can only be deleted when all its + DeployedIndexes had been undeployed. + operationId: aiplatform.projects.locations.indexes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51488,8 +51492,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -51502,13 +51505,21 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: indexesId required: true schema: type: string - delete: - description: Deletes a HyperparameterTuningJob. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: + parameters: *ref_1 + post: + description: Add/update Datapoints into an Index. + operationId: aiplatform.projects.locations.indexes.upsertDatapoints + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51520,7 +51531,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse parameters: - in: path name: projectsId @@ -51533,31 +51545,21 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: parameters: *ref_1 post: - 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`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.cancel + description: Remove Datapoints from an Index. + operationId: aiplatform.projects.locations.indexes.removeDatapoints requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51569,7 +51571,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse parameters: - in: path name: projectsId @@ -51582,15 +51585,102 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: + /v1/projects/{projectsId}/locations/{locationsId}/indexes: parameters: *ref_1 get: - description: Lists HyperparameterTuningJobs in a Location. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list + description: Lists Indexes in a Location. + operationId: aiplatform.projects.locations.indexes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates an Index. + operationId: aiplatform.projects.locations.indexes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + 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. + operationId: aiplatform.projects.locations.indexEndpoints.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51602,8 +51692,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -51615,33 +51704,30 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: indexEndpointsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + name: timeout schema: type: string - format: google-fieldmask - post: - description: Creates a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: + parameters: *ref_1 + 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`. + operationId: aiplatform.projects.locations.indexEndpoints.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51653,8 +51739,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -51666,20 +51751,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: + - in: path + name: indexEndpointsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + get: 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. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait + 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. + operationId: aiplatform.projects.locations.indexEndpoints.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51704,7 +51791,7 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: indexEndpointsId required: true schema: type: string @@ -51713,18 +51800,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.list + operationId: aiplatform.projects.locations.indexEndpoints.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51749,7 +51831,7 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: indexEndpointsId required: true schema: type: string @@ -51766,7 +51848,7 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -51779,7 +51861,7 @@ paths: 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`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel + operationId: aiplatform.projects.locations.indexEndpoints.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51804,7 +51886,7 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: indexEndpointsId required: true schema: type: string @@ -51813,15 +51895,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: parameters: *ref_1 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`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete + description: Deletes an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51833,7 +51911,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -51846,21 +51924,13 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: indexEndpointsId required: true schema: 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. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.get + description: Gets an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51872,7 +51942,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path name: projectsId @@ -51885,25 +51955,18 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: indexEndpointsId required: true schema: type: string - /v1/endpoints/{endpointsId}:computeTokens: - parameters: *ref_1 - post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.endpoints.computeTokens + patch: + description: Updates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51915,34 +51978,38 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path - name: endpointsId + name: projectsId required: true schema: type: string - /v1/endpoints/{endpointsId}:generateContent: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: indexEndpointsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: parameters: *ref_1 - post: - description: Generate content with multimodal inputs. - operationId: aiplatform.endpoints.generateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + get: + description: Lists IndexEndpoints in a Location. + operationId: aiplatform.projects.locations.indexEndpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -51950,23 +52017,44 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse parameters: - in: path - name: endpointsId + name: projectsId required: true schema: type: string - /v1/endpoints/{endpointsId}:countTokens: - parameters: *ref_1 + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask post: - description: Perform a token counting. - operationId: aiplatform.endpoints.countTokens + description: Creates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51978,34 +52066,33 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: endpointsId + name: projectsId required: true schema: type: string - /v1/endpoints/{endpointsId}:streamGenerateContent: + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: parameters: *ref_1 post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.endpoints.streamGenerateContent + description: Finds the nearest neighbors of each vector within the request. + operationId: aiplatform.projects.locations.indexEndpoints.findNeighbors requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -52013,49 +52100,36 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse parameters: - in: path - name: endpointsId + name: projectsId required: true schema: type: string - /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: - parameters: *ref_1 - delete: - description: Deletes a Dataset version. - operationId: aiplatform.datasets.datasetVersions.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: datasetsId + name: locationsId required: true schema: type: string - in: path - name: datasetVersionsId + name: indexEndpointsId required: true schema: type: string - patch: - description: Updates a DatasetVersion. - operationId: aiplatform.datasets.datasetVersions.patch + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: + parameters: *ref_1 + post: + description: >- + Reads the datapoints/vectors of the given IDs. A maximum of 1000 + datapoints can be retrieved in a batch. + operationId: aiplatform.projects.locations.indexEndpoints.readIndexDatapoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52067,26 +52141,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsResponse parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: datasetVersionsId + name: locationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: indexEndpointsId + required: true schema: type: string - format: google-fieldmask - get: - description: Gets a Dataset version. - operationId: aiplatform.datasets.datasetVersions.get + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: + parameters: *ref_1 + post: + description: >- + Deploys an Index into this IndexEndpoint, creating a DeployedIndex + within it. Only non-empty Indexes can be deployed. + operationId: aiplatform.projects.locations.indexEndpoints.deployIndex + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployIndexRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52098,28 +52182,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: datasetVersionsId + name: locationsId required: true schema: type: string - - in: query - name: readMask + - in: path + name: indexEndpointsId + required: true schema: type: string - format: google-fieldmask - /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: parameters: *ref_1 - get: - description: Restores a dataset version. - operationId: aiplatform.datasets.datasetVersions.restore + post: + description: >- + Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from + it, and freeing all resources it's using. + operationId: aiplatform.projects.locations.indexEndpoints.undeployIndex + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52134,69 +52225,30 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: datasetVersionsId + name: locationsId required: true schema: type: string - /v1/datasets/{datasetsId}/datasetVersions: - parameters: *ref_1 - get: - description: Lists DatasetVersions in a Dataset. - operationId: aiplatform.datasets.datasetVersions.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse - parameters: - in: path - name: datasetsId + name: indexEndpointsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: + parameters: *ref_1 post: - description: Create a version from a Dataset. - operationId: aiplatform.datasets.datasetVersions.create + description: Update an existing DeployedIndex under an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52211,46 +52263,25 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - /v1/datasets/{datasetsId}: - parameters: *ref_1 - patch: - description: Updates a Dataset. - operationId: aiplatform.datasets.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' - parameters: - in: path - name: datasetsId + name: locationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: indexEndpointsId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 get: - description: Gets a Dataset. - operationId: aiplatform.datasets.get + description: Gets information about a location. + operationId: aiplatform.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52262,21 +52293,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleCloudLocationLocation' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - - in: query - name: readMask + - in: path + name: locationsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a Dataset. - operationId: aiplatform.datasets.delete + /v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances: + parameters: *ref_1 + post: + description: Evaluates instances based on a given metric. + operationId: aiplatform.projects.locations.evaluateInstances + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52288,18 +52327,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesResponse parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - /v1/datasets: + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations: parameters: *ref_1 get: - description: Lists Datasets in a Location. - operationId: aiplatform.datasets.list + description: Lists information about the supported locations for this service. + operationId: aiplatform.projects.locations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52311,28 +52356,19 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' parameters: - - in: query - name: filter - schema: - type: string - - in: query - name: parent - schema: - type: string - - in: query - name: readMask + - in: path + name: projectsId + required: true schema: type: string - format: google-fieldmask - in: query name: pageToken schema: type: string - in: query - name: orderBy + name: filter schema: type: string - in: query @@ -52340,28 +52376,3 @@ paths: schema: type: integer format: int32 - post: - description: Creates a Dataset. - operationId: aiplatform.datasets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: query - name: parent - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml b/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml index 94e30513..a536e6e9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml @@ -34,11 +34,278 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - LookupHistoryResponse: + AirQualityIndex: + description: >- + The basic object for representing different air quality metrics. When + brought together, these metrics provide a snapshot about the current air + quality conditions. There are multiple indexes in the world serving + different purposes and groups interested in measuring different aspects + of air quality. + id: AirQualityIndex + type: object properties: - nextPageToken: - description: Optional. The token to retrieve the next page. + displayName: + description: >- + A human readable representation of the index name. Example: "AQI + (US)" + type: string + color: + description: The color used to represent the AQI numeric score. + $ref: '#/components/schemas/Color' + dominantPollutant: + type: string + description: 'The chemical symbol of the dominant pollutant. For example: "CO".' + code: + type: string + description: >- + The index's code. This field represents the index for programming + purposes by using snake case instead of spaces. Examples: "uaqi", + "fra_atmo". + aqi: + format: int32 + description: ' The index''s numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.' + type: integer + aqiDisplay: + description: >- + Textual representation of the index numeric score, that may include + prefix or suffix symbols, which usually represents the worst index + score. Example: >100 or 10+. Note: This field should be used when + you want to display the index score. For non-numeric indexes, this + field is empty. + type: string + category: + description: >- + Textual classification of the index numeric score interpretation. + For example: "Excellent air quality". + type: string + AdditionalInfo: + id: AdditionalInfo + properties: + effects: + type: string + description: Text representing the pollutant's main health effects. + sources: + description: Text representing the pollutant's main emission sources. + type: string + description: The emission sources and health effects of a given pollutant. + type: object + Color: + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + id: Color + type: object + properties: + alpha: + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + red: + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + type: number + green: + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + Interval: + type: object + properties: + endTime: + format: google-datetime + description: >- + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + type: string + startTime: + type: string + 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 + id: Interval + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + HealthRecommendations: + description: >- + Health recommendations for different population groups in a free text + format. The recommendations are derived from their associated air + quality conditions. + id: HealthRecommendations + properties: + children: + description: Younger populations including children, toddlers, and babies. + type: string + elderly: + description: Retirees and people older than the general population. + type: string + athletes: + type: string + description: Sports and other strenuous outdoor activities. + pregnantWomen: + type: string + description: Women at all stages of pregnancy. + heartDiseasePopulation: + description: Heart and circulatory system diseases. + type: string + generalPopulation: + description: No specific sensitivities. + type: string + lungDiseasePopulation: + type: string + description: Respiratory related problems and asthma suffers. + type: object + Concentration: + properties: + value: + format: float + type: number + description: Value of the pollutant concentration. + units: + description: Units for measuring this pollutant concentration. + type: string + enum: + - UNIT_UNSPECIFIED + - PARTS_PER_BILLION + - MICROGRAMS_PER_CUBIC_METER + enumDescriptions: + - Unspecified concentration unit. + - The ppb (parts per billion) concentration unit. + - The "µg/m^3" (micrograms per cubic meter) concentration unit. + id: Concentration + description: The concentration of a given pollutant in the air. + type: object + CustomLocalAqi: + type: object + description: >- + Expresses a 'country/region to AQI' relationship. Pairs a country/region + with a desired AQI so that air quality data that is required for that + country/region will be displayed according to the chosen AQI. + id: CustomLocalAqi + properties: + aqi: + type: string + description: >- + The AQI to associate the country/region with. Value should be a + [valid index](/maps/documentation/air-quality/laqis) code. + regionCode: + type: string + description: >- + The country/region requiring the custom AQI. Value should be + provided using [ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. + HttpBody: + properties: + contentType: type: string + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + extensions: + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + data: + format: byte + type: string + description: The HTTP request/response body as raw binary. + type: object + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + id: HttpBody + LookupForecastResponse: + id: LookupForecastResponse + description: The response object of the air quality forecast API. + properties: regionCode: description: >- Optional. The ISO_3166-1 alpha-2 code of the country/region @@ -46,53 +313,97 @@ components: might be omitted from the response if the location provided in the request resides in a disputed territory. type: string - hoursInfo: - type: array + nextPageToken: + description: Optional. The token to retrieve the next page. + type: string + hourlyForecasts: description: >- Optional. Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of - history there will be 48 elements of hourly info. + forecast there will be 48 elements of hourly forecasts. + type: array items: - $ref: '#/components/schemas/HourInfo' + $ref: '#/components/schemas/HourlyForecast' type: object - id: LookupHistoryResponse - LookupHistoryRequest: + HourInfo: + type: object + id: HourInfo + description: >- + Contains the air quality information for each hour in the requested + range. For example, if the request is for 48 hours of history there will + be 48 elements of hourly info. properties: dateTime: - type: string format: google-datetime + type: string description: >- - A timestamp for which to return historical data. The timestamp is - rounded to the previous exact hour. Note: this will return hourly - data for the requested timestamp only (i.e. a single hourly info - element). For example, a request sent where the dateTime parameter - is set to 2023-01-03T11:05:49Z will be rounded down to - 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC "Zulu" format, with - nanosecond resolution and up to nine fractional digits. Examples: - "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". - uaqiColorPalette: - enum: - - COLOR_PALETTE_UNSPECIFIED - - RED_GREEN - - INDIGO_PERSIAN_DARK - - INDIGO_PERSIAN_LIGHT + A rounded down timestamp indicating the time the data refers to in + RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine + fractional digits. For example: "2014-10-02T15:00:00Z". + healthRecommendations: + $ref: '#/components/schemas/HealthRecommendations' description: >- - Optional. Determines the color palette used for data provided by the - 'Universal Air Quality Index' (UAQI). This color palette is relevant - just for UAQI, other AQIs have a predetermined color palette that - can't be controlled. - type: string + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + pollutants: + items: + $ref: '#/components/schemas/Pollutant' + type: array + description: >- + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + indexes: + type: array + description: >- + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + universalAqi boolean is set to true. - Local AQI. Will be returned + if the LOCAL_AQI extra computation is specified. + items: + $ref: '#/components/schemas/AirQualityIndex' + LookupCurrentConditionsRequest: + id: LookupCurrentConditionsRequest + type: object + description: The request definition of the air quality current conditions. + properties: + location: + $ref: '#/components/schemas/LatLng' + description: >- + Required. The longitude and latitude from which the API looks for + air quality current conditions data. + customLocalAqis: + description: >- + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. + type: array + items: + $ref: '#/components/schemas/CustomLocalAqi' + uaqiColorPalette: enumDescriptions: - The default value. Ignored if passed as a parameter. - Determines whether to use a red/green palette. - Determines whether to use a indigo/persian palette (dark theme). - Determines whether to use a indigo/persian palette (light theme). - hours: description: >- - Number from 1 to 720 that indicates the hours range for the request. - For example: A value of 48 will yield data from the last 48 hours. - format: int32 - type: integer + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + type: string languageCode: type: string description: >- @@ -100,39 +411,26 @@ components: If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard. Default value is en. - location: - description: >- - Required. The latitude and longitude for which the API looks for air - quality history data. - $ref: '#/components/schemas/LatLng' - customLocalAqis: - type: array - items: - $ref: '#/components/schemas/CustomLocalAqi' - description: >- - Optional. Expresses a 'country/region to AQI' relationship. Pairs a - country/region with a desired AQI so that air quality data that is - required for that country/region will be displayed according to the - chosen AQI. This parameter can be used to specify a non-default AQI - for a given country, for example, to get the US EPA index for Canada - rather than the default index for Canada. - period: - $ref: '#/components/schemas/Interval' - description: >- - Indicates the start and end period for which to get the historical - data. The timestamp is rounded to the previous exact hour. - pageSize: - type: integer + universalAqi: + type: boolean description: >- - Optional. The maximum number of hourly info records to return per - page. The default is 72 and the max value is 168 (7 days of data). - format: int32 + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response. Default value is true. extraComputations: + type: array description: >- Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response. items: + type: string + enum: + - EXTRA_COMPUTATION_UNSPECIFIED + - LOCAL_AQI + - HEALTH_RECOMMENDATIONS + - POLLUTANT_ADDITIONAL_INFO + - DOMINANT_POLLUTANT_CONCENTRATION + - POLLUTANT_CONCENTRATION enumDescriptions: - >- The default value. The server ignores it if it is passed as a @@ -169,67 +467,16 @@ components: global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available. - type: string - enum: - - EXTRA_COMPUTATION_UNSPECIFIED - - LOCAL_AQI - - HEALTH_RECOMMENDATIONS - - POLLUTANT_ADDITIONAL_INFO - - DOMINANT_POLLUTANT_CONCENTRATION - - POLLUTANT_CONCENTRATION - type: array - universalAqi: - description: >- - Optional. If set to true, the Universal AQI will be included in the - 'indexes' field of the response. Default value is true. - type: boolean - pageToken: - type: string - description: >- - Optional. A page token received from a previous history call. It is - used to retrieve the subsequent page. Note that when providing a - value for this parameter all other parameters provided must match - the call that provided the page token (the previous call). - type: object - description: The request object of the air quality history API. - id: LookupHistoryRequest LookupCurrentConditionsResponse: - id: LookupCurrentConditionsResponse type: object properties: - dateTime: - description: >- - A rounded down timestamp in RFC3339 UTC "Zulu" format, with - nanosecond resolution and up to nine fractional digits. For example: - "2014-10-02T15:00:00Z". - format: google-datetime - type: string - pollutants: - items: - $ref: '#/components/schemas/Pollutant' - description: >- - A list of pollutants affecting the location specified in the - request. Note: This field will be returned only for requests that - specified one or more of the following extra computations: - POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, - POLLUTANT_CONCENTRATION. - type: array - indexes: - description: >- - Based on the request parameters, this list will include (up to) two - air quality indexes: - Universal AQI. Will be returned if the - universalAqi boolean is set to true. - Local AQI. Will be returned - if the LOCAL_AQI extra computation is specified. - items: - $ref: '#/components/schemas/AirQualityIndex' - type: array healthRecommendations: + $ref: '#/components/schemas/HealthRecommendations' description: >- Health advice and recommended actions related to the reported air quality conditions. Recommendations are tailored differently for populations at risk, groups with greater sensitivities to pollutants, and the general population. - $ref: '#/components/schemas/HealthRecommendations' regionCode: description: >- The ISO_3166-1 alpha-2 code of the country/region corresponding to @@ -237,183 +484,49 @@ components: from the response if the location provided in the request resides in a disputed territory. type: string - LatLng: - id: LatLng - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - properties: - longitude: - format: double - type: number - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - latitude: - type: number - format: double - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - type: object - Concentration: - type: object - properties: - value: - type: number - format: float - description: Value of the pollutant concentration. - units: - enumDescriptions: - - Unspecified concentration unit. - - The ppb (parts per billion) concentration unit. - - The "µg/m^3" (micrograms per cubic meter) concentration unit. - enum: - - UNIT_UNSPECIFIED - - PARTS_PER_BILLION - - MICROGRAMS_PER_CUBIC_METER - description: Units for measuring this pollutant concentration. - type: string - description: The concentration of a given pollutant in the air. - id: Concentration - HourInfo: - id: HourInfo - type: object - description: >- - Contains the air quality information for each hour in the requested - range. For example, if the request is for 48 hours of history there will - be 48 elements of hourly info. - properties: pollutants: - items: - $ref: '#/components/schemas/Pollutant' description: >- A list of pollutants affecting the location specified in the request. Note: This field will be returned only for requests that specified one or more of the following extra computations: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. - type: array - indexes: - items: - $ref: '#/components/schemas/AirQualityIndex' - description: >- - Based on the request parameters, this list will include (up to) two - air quality indexes: - Universal AQI. Will be returned if the - universalAqi boolean is set to true. - Local AQI. Will be returned - if the LOCAL_AQI extra computation is specified. - type: array - healthRecommendations: - description: >- - Health advice and recommended actions related to the reported air - quality conditions. Recommendations are tailored differently for - populations at risk, groups with greater sensitivities to - pollutants, and the general population. - $ref: '#/components/schemas/HealthRecommendations' - dateTime: - format: google-datetime - description: >- - A rounded down timestamp indicating the time the data refers to in - RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine - fractional digits. For example: "2014-10-02T15:00:00Z". - type: string - LookupForecastResponse: - id: LookupForecastResponse - type: object - description: The response object of the air quality forecast API. - properties: - regionCode: - description: >- - Optional. The ISO_3166-1 alpha-2 code of the country/region - corresponding to the location provided in the request. This field - might be omitted from the response if the location provided in the - request resides in a disputed territory. - type: string - hourlyForecasts: - type: array - items: - $ref: '#/components/schemas/HourlyForecast' - description: >- - Optional. Contains the air quality information for each hour in the - requested range. For example, if the request is for 48 hours of - forecast there will be 48 elements of hourly forecasts. - nextPageToken: - type: string - description: Optional. The token to retrieve the next page. - HealthRecommendations: - type: object - properties: - children: - description: Younger populations including children, toddlers, and babies. - type: string - pregnantWomen: - description: Women at all stages of pregnancy. - type: string - lungDiseasePopulation: - type: string - description: Respiratory related problems and asthma suffers. - elderly: - description: Retirees and people older than the general population. - type: string - heartDiseasePopulation: - description: Heart and circulatory system diseases. - type: string - athletes: - type: string - description: Sports and other strenuous outdoor activities. - generalPopulation: - type: string - description: No specific sensitivities. - description: >- - Health recommendations for different population groups in a free text - format. The recommendations are derived from their associated air - quality conditions. - id: HealthRecommendations - HourlyForecast: - description: >- - Contains the air quality information for each hour in the requested - range. For example, if the request is for 48 hours of forecast there - will be 48 elements of hourly forecasts. - type: object - properties: - dateTime: - type: string - format: google-datetime - description: >- - A rounded down timestamp indicating the time (hour) the data refers - to in RFC3339 UTC "Zulu" format. For example: - "2014-10-02T15:00:00Z". - pollutants: items: - $ref: '#/components/schemas/Pollutant' - description: >- - A list of pollutants affecting the location specified in the - request. Note: This field will be returned only for requests that - specified one or more of the following extra computations: - POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, - POLLUTANT_CONCENTRATION. + $ref: '#/components/schemas/Pollutant' type: array - indexes: + dateTime: + type: string + format: google-datetime description: >- - Based on the request parameters, this list will include (up to) two - air quality indexes: - Universal AQI. Will be returned if the - `universal_aqi` boolean is set to true. - Local AQI. Will be - returned if the LOCAL_AQI extra computation is specified. + A rounded down timestamp in RFC3339 UTC "Zulu" format, with + nanosecond resolution and up to nine fractional digits. For example: + "2014-10-02T15:00:00Z". + indexes: type: array items: $ref: '#/components/schemas/AirQualityIndex' - healthRecommendations: description: >- - Health advice and recommended actions related to the reported air - quality conditions. Recommendations are tailored differently for - populations at risk, groups with greater sensitivities to - pollutants, and the general population. - $ref: '#/components/schemas/HealthRecommendations' - id: HourlyForecast + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + universalAqi boolean is set to true. - Local AQI. Will be returned + if the LOCAL_AQI extra computation is specified. + id: LookupCurrentConditionsResponse Pollutant: - id: Pollutant + type: object + description: Data regarding an air quality pollutant. properties: + code: + type: string + description: >- + The pollutant's code name (for example, "so2"). For a list of + supported pollutant codes, see [Reported + pollutants](/maps/documentation/air-quality/pollutants#reported_pollutants). additionalInfo: $ref: '#/components/schemas/AdditionalInfo' description: Additional information about the pollutant. + displayName: + type: string + description: 'The pollutant''s display name. For example: "NOx".' fullName: type: string description: >- @@ -421,140 +534,110 @@ components: name. Example: "Sulfur Dioxide". For more information about the IUPAC names table, see https://iupac.org/what-we-do/periodic-table-of-elements/. - code: - description: >- - The pollutant's code name (for example, "so2"). For a list of - supported pollutant codes, see [Reported - pollutants](/maps/documentation/air-quality/pollutants#reported_pollutants). - type: string concentration: description: >- The pollutant's concentration level measured by one of the standard air pollutation measure units. $ref: '#/components/schemas/Concentration' - displayName: - description: 'The pollutant''s display name. For example: "NOx".' - type: string - type: object - description: Data regarding an air quality pollutant. - AirQualityIndex: - type: object + id: Pollutant + HourlyForecast: + id: HourlyForecast properties: - category: + dateTime: + format: google-datetime description: >- - Textual classification of the index numeric score interpretation. - For example: "Excellent air quality". + A rounded down timestamp indicating the time (hour) the data refers + to in RFC3339 UTC "Zulu" format. For example: + "2014-10-02T15:00:00Z". type: string - aqi: - description: ' The index''s numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.' - type: integer - format: int32 - color: - $ref: '#/components/schemas/Color' - description: The color used to represent the AQI numeric score. - displayName: + healthRecommendations: + $ref: '#/components/schemas/HealthRecommendations' description: >- - A human readable representation of the index name. Example: "AQI - (US)" - type: string - dominantPollutant: - description: 'The chemical symbol of the dominant pollutant. For example: "CO".' - type: string - code: + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + pollutants: description: >- - The index's code. This field represents the index for programming - purposes by using snake case instead of spaces. Examples: "uaqi", - "fra_atmo". - type: string - aqiDisplay: - type: string + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + type: array + items: + $ref: '#/components/schemas/Pollutant' + indexes: + type: array + items: + $ref: '#/components/schemas/AirQualityIndex' description: >- - Textual representation of the index numeric score, that may include - prefix or suffix symbols, which usually represents the worst index - score. Example: >100 or 10+. Note: This field should be used when - you want to display the index score. For non-numeric indexes, this - field is empty. - id: AirQualityIndex + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + `universal_aqi` boolean is set to true. - Local AQI. Will be + returned if the LOCAL_AQI extra computation is specified. description: >- - The basic object for representing different air quality metrics. When - brought together, these metrics provide a snapshot about the current air - quality conditions. There are multiple indexes in the world serving - different purposes and groups interested in measuring different aspects - of air quality. - AdditionalInfo: - properties: - effects: - description: Text representing the pollutant's main health effects. - type: string - sources: - description: Text representing the pollutant's main emission sources. - type: string - description: The emission sources and health effects of a given pollutant. - id: AdditionalInfo - type: object - Interval: + Contains the air quality information for each hour in the requested + range. For example, if the request is for 48 hours of forecast there + will be 48 elements of hourly forecasts. type: object - id: Interval - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. + LookupForecastRequest: + description: The request object of the air quality forecast API. + id: LookupForecastRequest properties: - endTime: - type: string - description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. - format: google-datetime - startTime: - type: string + period: + $ref: '#/components/schemas/Interval' 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 - LookupCurrentConditionsRequest: - type: object - id: LookupCurrentConditionsRequest - properties: + Indicates the start and end period for which to get the forecast + data. The timestamp is rounded to the previous exact hour. uaqiColorPalette: - enum: - - COLOR_PALETTE_UNSPECIFIED - - RED_GREEN - - INDIGO_PERSIAN_DARK - - INDIGO_PERSIAN_LIGHT enumDescriptions: - The default value. Ignored if passed as a parameter. - Determines whether to use a red/green palette. - Determines whether to use a indigo/persian palette (dark theme). - Determines whether to use a indigo/persian palette (light theme). + type: string description: >- Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled. - type: string - universalAqi: - type: boolean - description: >- - Optional. If set to true, the Universal AQI will be included in the - 'indexes' field of the response. Default value is true. + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT languageCode: type: string description: >- Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the - closest match. Allowed values rely on the IETF standard. Default - value is en. - location: + closest match. Allowed values rely on the IETF standard (default = + 'en'). + pageToken: description: >- - Required. The longitude and latitude from which the API looks for - air quality current conditions data. + Optional. A page token received from a previous forecast call. It is + used to retrieve the subsequent page. + type: string + location: $ref: '#/components/schemas/LatLng' + description: >- + Required. The latitude and longitude for which the API looks for air + quality data. + customLocalAqis: + description: >- + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. + items: + $ref: '#/components/schemas/CustomLocalAqi' + type: array extraComputations: + type: array items: - type: string enum: - EXTRA_COMPUTATION_UNSPECIFIED - LOCAL_AQI @@ -598,31 +681,108 @@ components: global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available. + type: string description: >- Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response. + dateTime: + description: >- + A timestamp for which to return the data for a specific point in + time. The timestamp is rounded to the previous exact hour. Note: + this will return hourly data for the requested timestamp only (i.e. + a single hourly info element). For example, a request sent where the + date_time parameter is set to 2023-01-03T11:05:49Z will be rounded + down to 2023-01-03T11:00:00Z. + format: google-datetime + type: string + pageSize: + type: integer + description: >- + Optional. The maximum number of hourly info records to return per + page (default = 24). + format: int32 + universalAqi: + type: boolean + description: >- + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response (default = true). + type: object + LatLng: + properties: + longitude: + type: number + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + format: double + latitude: + format: double + type: number + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. + id: LatLng + type: object + LookupHistoryResponse: + properties: + nextPageToken: + description: Optional. The token to retrieve the next page. + type: string + regionCode: + description: >- + Optional. The ISO_3166-1 alpha-2 code of the country/region + corresponding to the location provided in the request. This field + might be omitted from the response if the location provided in the + request resides in a disputed territory. + type: string + hoursInfo: type: array - customLocalAqis: - description: >- - Optional. Expresses a 'country/region to AQI' relationship. Pairs a - country/region with a desired AQI so that air quality data that is - required for that country/region will be displayed according to the - chosen AQI. This parameter can be used to specify a non-default AQI - for a given country, for example, to get the US EPA index for Canada - rather than the default index for Canada. items: - $ref: '#/components/schemas/CustomLocalAqi' - type: array - description: The request definition of the air quality current conditions. - LookupForecastRequest: + $ref: '#/components/schemas/HourInfo' + description: >- + Optional. Contains the air quality information for each hour in the + requested range. For example, if the request is for 48 hours of + history there will be 48 elements of hourly info. type: object - id: LookupForecastRequest - description: The request object of the air quality forecast API. + id: LookupHistoryResponse + LookupHistoryRequest: + id: LookupHistoryRequest properties: + pageToken: + description: >- + Optional. A page token received from a previous history call. It is + used to retrieve the subsequent page. Note that when providing a + value for this parameter all other parameters provided must match + the call that provided the page token (the previous call). + type: string + dateTime: + format: google-datetime + description: >- + A timestamp for which to return historical data. The timestamp is + rounded to the previous exact hour. Note: this will return hourly + data for the requested timestamp only (i.e. a single hourly info + element). For example, a request sent where the dateTime parameter + is set to 2023-01-03T11:05:49Z will be rounded down to + 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC "Zulu" format, with + nanosecond resolution and up to nine fractional digits. Examples: + "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". + type: string + hours: + type: integer + format: int32 + description: >- + Number from 1 to 720 that indicates the hours range for the request. + For example: A value of 48 will yield data from the last 48 hours. + languageCode: + type: string + description: >- + Optional. Allows the client to choose the language for the response. + If data cannot be provided for that language the API uses the + closest match. Allowed values rely on the IETF standard. Default + value is en. customLocalAqis: - items: - $ref: '#/components/schemas/CustomLocalAqi' description: >- Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is @@ -631,54 +791,32 @@ components: for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada. type: array - languageCode: - type: string - description: >- - Optional. Allows the client to choose the language for the response. - If data cannot be provided for that language the API uses the - closest match. Allowed values rely on the IETF standard (default = - 'en'). + items: + $ref: '#/components/schemas/CustomLocalAqi' pageSize: - format: int32 - type: integer description: >- Optional. The maximum number of hourly info records to return per - page (default = 24). + page. The default is 72 and the max value is 168 (7 days of data). + format: int32 + type: integer location: - description: >- - Required. The latitude and longitude for which the API looks for air - quality data. $ref: '#/components/schemas/LatLng' - uaqiColorPalette: - description: >- - Optional. Determines the color palette used for data provided by the - 'Universal Air Quality Index' (UAQI). This color palette is relevant - just for UAQI, other AQIs have a predetermined color palette that - can't be controlled. - enumDescriptions: - - The default value. Ignored if passed as a parameter. - - Determines whether to use a red/green palette. - - Determines whether to use a indigo/persian palette (dark theme). - - Determines whether to use a indigo/persian palette (light theme). - enum: - - COLOR_PALETTE_UNSPECIFIED - - RED_GREEN - - INDIGO_PERSIAN_DARK - - INDIGO_PERSIAN_LIGHT - type: string - period: - $ref: '#/components/schemas/Interval' - description: >- - Indicates the start and end period for which to get the forecast - data. The timestamp is rounded to the previous exact hour. - universalAqi: description: >- - Optional. If set to true, the Universal AQI will be included in the - 'indexes' field of the response (default = true). - type: boolean + Required. The latitude and longitude for which the API looks for air + quality history data. extraComputations: + description: >- + Optional. Additional features that can be optionally enabled. + Specifying extra computations will result in the relevant elements + and fields to be returned in the response. items: - type: string + enum: + - EXTRA_COMPUTATION_UNSPECIFIED + - LOCAL_AQI + - HEALTH_RECOMMENDATIONS + - POLLUTANT_ADDITIONAL_INFO + - DOMINANT_POLLUTANT_CONCENTRATION + - POLLUTANT_CONCENTRATION enumDescriptions: - >- The default value. The server ignores it if it is passed as a @@ -715,192 +853,42 @@ components: global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available. - enum: - - EXTRA_COMPUTATION_UNSPECIFIED - - LOCAL_AQI - - HEALTH_RECOMMENDATIONS - - POLLUTANT_ADDITIONAL_INFO - - DOMINANT_POLLUTANT_CONCENTRATION - - POLLUTANT_CONCENTRATION - description: >- - Optional. Additional features that can be optionally enabled. - Specifying extra computations will result in the relevant elements - and fields to be returned in the response. + type: string type: array - pageToken: - type: string - description: >- - Optional. A page token received from a previous forecast call. It is - used to retrieve the subsequent page. - dateTime: - format: google-datetime - description: >- - A timestamp for which to return the data for a specific point in - time. The timestamp is rounded to the previous exact hour. Note: - this will return hourly data for the requested timestamp only (i.e. - a single hourly info element). For example, a request sent where the - date_time parameter is set to 2023-01-03T11:05:49Z will be rounded - down to 2023-01-03T11:00:00Z. - type: string - CustomLocalAqi: - type: object - id: CustomLocalAqi - properties: - aqi: - description: >- - The AQI to associate the country/region with. Value should be a - [valid index](/maps/documentation/air-quality/laqis) code. - type: string - regionCode: - type: string - description: >- - The country/region requiring the custom AQI. Value should be - provided using [ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. - description: >- - Expresses a 'country/region to AQI' relationship. Pairs a country/region - with a desired AQI so that air quality data that is required for that - country/region will be displayed according to the chosen AQI. - Color: - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... - id: Color - properties: - alpha: - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - format: float - type: number - green: - type: number - format: float - description: The amount of green in the color as a value in the interval [0, 1]. - red: - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - type: number - type: object - HttpBody: - id: HttpBody - properties: - contentType: + universalAqi: + type: boolean description: >- - The HTTP Content-Type header value specifying the content type of - the body. - type: string - extensions: + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response. Default value is true. + period: + $ref: '#/components/schemas/Interval' description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - type: array - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - data: + Indicates the start and end period for which to get the historical + data. The timestamp is rounded to the previous exact hour. + uaqiColorPalette: + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + enumDescriptions: + - The default value. Ignored if passed as a parameter. + - Determines whether to use a red/green palette. + - Determines whether to use a indigo/persian palette (dark theme). + - Determines whether to use a indigo/persian palette (light theme). + description: >- + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. type: string - description: The HTTP request/response body as raw binary. - format: byte - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. type: object + description: The request object of the air quality history API. parameters: - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: key + name: uploadType schema: type: string access_token: @@ -909,25 +897,29 @@ components: name: access_token schema: type: string - _.xgafv: - description: V1 error format. + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' + - json + - media + - proto callback: description: JSONP in: query name: callback schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + 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. in: query - name: uploadType + name: key schema: type: string fields: @@ -936,43 +928,51 @@ components: name: fields schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: upload_protocol + name: quotaUser schema: type: string - alt: - description: Data format for response. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: alt + name: prettyPrint + schema: + type: boolean + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string - enum: - - json - - media - - proto oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + _.xgafv: + description: V1 error format. in: query - name: prettyPrint + name: $.xgafv schema: - type: boolean + type: string + enum: + - '1' + - '2' x-stackQL-resources: - forecast: - id: google.airquality.forecast - name: forecast - title: Forecast + history: + id: google.airquality.history + name: history + title: History methods: lookup: operation: - $ref: '#/paths/~1v1~1forecast:lookup/post' + $ref: '#/paths/~1v1~1history:lookup/post' response: mediaType: application/json openAPIDocKey: '200' @@ -982,15 +982,14 @@ components: update: [] replace: [] delete: [] - heatmap_tiles: - id: google.airquality.heatmap_tiles - name: heatmap_tiles - title: Heatmap_tiles + current_conditions: + id: google.airquality.current_conditions + name: current_conditions + title: Current_conditions methods: - lookup_heatmap_tile: + lookup: operation: - $ref: >- - #/paths/~1v1~1mapTypes~1{mapType}~1heatmapTiles~1{zoom}~1{x}~1{y}/get + $ref: '#/paths/~1v1~1currentConditions:lookup/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1000,14 +999,15 @@ components: update: [] replace: [] delete: [] - current_conditions: - id: google.airquality.current_conditions - name: current_conditions - title: Current_conditions + heatmap_tiles: + id: google.airquality.heatmap_tiles + name: heatmap_tiles + title: Heatmap_tiles methods: - lookup: + lookup_heatmap_tile: operation: - $ref: '#/paths/~1v1~1currentConditions:lookup/post' + $ref: >- + #/paths/~1v1~1mapTypes~1{mapType}~1heatmapTiles~1{zoom}~1{x}~1{y}/get response: mediaType: application/json openAPIDocKey: '200' @@ -1017,14 +1017,14 @@ components: update: [] replace: [] delete: [] - history: - id: google.airquality.history - name: history - title: History + forecast: + id: google.airquality.forecast + name: forecast + title: Forecast methods: lookup: operation: - $ref: '#/paths/~1v1~1history:lookup/post' + $ref: '#/paths/~1v1~1forecast:lookup/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1035,29 +1035,29 @@ components: replace: [] delete: [] paths: - /v1/forecast:lookup: + /v1/history:lookup: parameters: &ref_1 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' post: description: >- - Returns air quality forecast for a specific location for a given time + Returns air quality history for a specific location for a given time range. - operationId: airquality.forecast.lookup + operationId: airquality.history.lookup requestBody: content: application/json: schema: - $ref: '#/components/schemas/LookupForecastRequest' + $ref: '#/components/schemas/LookupHistoryRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1069,7 +1069,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LookupForecastResponse' + $ref: '#/components/schemas/LookupHistoryResponse' + parameters: [] + /v1/currentConditions:lookup: + parameters: *ref_1 + post: + description: >- + The Current Conditions endpoint provides hourly air quality information + in more than 100 countries, up to a 500 x 500 meters resolution. + Includes over 70 local indexes and global air quality index and + categories. + operationId: airquality.currentConditions.lookup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LookupCurrentConditionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LookupCurrentConditionsResponse' parameters: [] /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: parameters: *ref_1 @@ -1109,45 +1136,18 @@ paths: required: true schema: type: string - /v1/currentConditions:lookup: - parameters: *ref_1 - post: - description: >- - The Current Conditions endpoint provides hourly air quality information - in more than 100 countries, up to a 500 x 500 meters resolution. - Includes over 70 local indexes and global air quality index and - categories. - operationId: airquality.currentConditions.lookup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LookupCurrentConditionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/LookupCurrentConditionsResponse' - parameters: [] - /v1/history:lookup: + /v1/forecast:lookup: parameters: *ref_1 post: description: >- - Returns air quality history for a specific location for a given time + Returns air quality forecast for a specific location for a given time range. - operationId: airquality.history.lookup + operationId: airquality.forecast.lookup requestBody: content: application/json: schema: - $ref: '#/components/schemas/LookupHistoryRequest' + $ref: '#/components/schemas/LookupForecastRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1159,5 +1159,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LookupHistoryResponse' + $ref: '#/components/schemas/LookupForecastResponse' parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml index f86372de..8f1c2ce8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml @@ -39,551 +39,278 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudApigeeV1Properties: - id: GoogleCloudApigeeV1Properties + GoogleCloudApigeeV1ProfileConfigThreat: + properties: {} + id: GoogleCloudApigeeV1ProfileConfigThreat + type: object + description: >- + By default, following policies will be included: - XMLThreatProtection - + JSONThreatProtection + GoogleCloudApigeeV1ListAsyncQueriesResponse: + id: GoogleCloudApigeeV1ListAsyncQueriesResponse + description: The response for ListAsyncQueries. properties: - property: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + queries: type: array - description: List of all properties in the object + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + description: The asynchronous queries belong to requested resource name. + type: object + GoogleCloudApigeeV1AccessSet: description: >- - Message for compatibility with legacy Edge specification for Java - Properties object in JSON. + Set action. For example, "Set" : { "name" : "target.name", "success" : + true, "value" : "default" } type: object - GoogleCloudApigeeV1IngressConfig: - id: GoogleCloudApigeeV1IngressConfig + id: GoogleCloudApigeeV1AccessSet properties: - revisionCreateTime: - format: google-datetime - description: Time at which the IngressConfig revision was created. - type: string - environmentGroups: - description: List of environment groups in the organization. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' - type: array - revisionId: - format: int64 + value: type: string - description: >- - Revision id that defines the ordering on IngressConfig resources. - The higher the revision, the more recently the configuration was - deployed. name: type: string - description: >- - Name of the resource in the following format: - `organizations/{org}/deployedIngressConfig`. - uid: - type: string - description: >- - A unique id for the ingress config that will only change if the - organization is deleted and recreated. - type: object - GoogleCloudApigeeV1SecurityActionsConfig: + success: + type: boolean + GoogleCloudApigeeV1RuntimeConfig: properties: - updateTime: - description: Output only. The update time for configuration. + traceBucket: type: string - format: google-datetime + description: Cloud Storage bucket used for uploading Trace records. + analyticsBucket: + type: string + description: Cloud Storage bucket used for uploading Analytics records. + tenantProjectId: readOnly: true - enabled: - type: boolean description: >- - The flag that controls whether this feature is enabled. This is - `unset` by default. When this flag is `false`, even if individual - rules are enabled, no SecurityActions will be enforced. + Output only. Tenant project ID associated with the Apigee + organization. The tenant project is used to host Google-managed + resources that are dedicated to this Apigee organization. Clients + have limited access to resources within the tenant project used to + support Apigee runtime instances. Access to the tenant project is + managed using SetSyncAuthorization. It can be empty if the tenant + project hasn't been created yet. + type: string name: - description: >- - This is a singleton resource, the name will always be set by - SecurityActions and any user input will be ignored. The name is - always: - `organizations/{org}/environments/{env}/security_actions_config` type: string + description: >- + Name of the resource in the following format: + `organizations/{org}/runtimeConfig`. description: >- - SecurityActionsConfig reflects the current state of the SecurityActions - feature. This is a singleton resource: https://google.aip.dev/156 - id: GoogleCloudApigeeV1SecurityActionsConfig + Runtime configuration for the organization. Response for + GetRuntimeConfig. type: object - GoogleCloudApigeeV1ProvisionOrganizationRequest: + id: GoogleCloudApigeeV1RuntimeConfig + GoogleCloudApigeeV1GraphQLOperationGroup: properties: - disableVpcPeering: - type: boolean - description: >- - Optional. Flag that specifies whether the VPC Peering through - Private Google Access should be disabled between the consumer - network and Apigee. Required if an authorizedNetwork on the consumer - project is not provided, in which case the flag should be set to - true. The value must be set before the creation of any Apigee - runtime instance and can be updated only when there are no runtime - instances. **Note:** Apigee will be deprecating the vpc peering - model that requires you to provide 'authorizedNetwork', by making - the non-peering model as the default way of provisioning Apigee - organization in future. So, this will be a temporary flag to enable - the transition. Not supported for Apigee hybrid. - authorizedNetwork: - type: string - description: >- - Compute Engine network used for Service Networking to be peered with - Apigee runtime instances. See [Getting started with the Service - Networking - API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). - Apigee also supports shared VPC (that is, the host network project - is not the same as the one that is peering with Apigee). See [Shared - VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use - a shared VPC network, use the following format: - `projects/{host-project-id}/{region}/networks/{network-name}`. For - example: `projects/my-sharedvpc-host/global/networks/mynetwork` - analyticsRegion: + operationConfigType: type: string description: >- - Primary Cloud Platform region for analytics data storage. For valid - values, see [Create an - organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). - Defaults to `us-west1`. - runtimeLocation: - type: string + Flag that specifies whether the configuration is for Apigee API + proxy or a remote service. Valid values include `proxy` or + `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API + proxies are associated with the API product. Set to `remoteservice` + when non-Apigee proxies like Istio-Envoy are associated with the API + product. + operationConfigs: description: >- - Cloud Platform location for the runtime instance. Defaults to zone - `us-west1-a`. If a region is provided, `EVAL` organizations will use - the region for automatically selecting a zone for the runtime - instance. - type: object - id: GoogleCloudApigeeV1ProvisionOrganizationRequest - description: Request for ProvisionOrganization. - GoogleCloudApigeeV1TestDatastoreResponse: - description: The response for TestDatastore - properties: - error: - type: string - readOnly: true - description: Output only. Error message of test connection failure - state: - type: string - readOnly: true - description: Output only. It could be `completed` or `failed` - type: object - id: GoogleCloudApigeeV1TestDatastoreResponse - GoogleCloudApigeeV1Point: - properties: - id: - description: Name of a step in the transaction. - type: string - results: + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. type: array - description: List of results extracted from a given debug point. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Result' - type: object + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' description: >- - Point is a group of information collected by runtime plane at critical - points of the message flow of the processed API request. This is a list - of supported point IDs, categorized to three major buckets. For each - category, debug points that we are currently supporting are listed - below: - Flow status debug points: StateChange FlowInfo Condition - Execution DebugMask Error - Flow control debug points: FlowCallout - Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: - ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition - Oauth2ServicePoint RaiseFault NodeJS The detail information of the given - debug point is stored in a list of results. - id: GoogleCloudApigeeV1Point - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + List of graphQL operation configuration details associated with Apigee + API proxies or remote services. Remote services are non-Apigee proxies, + such as Istio-Envoy. type: object - description: The format of the assessment recommendation. + id: GoogleCloudApigeeV1GraphQLOperationGroup + GoogleCloudApigeeV1SharedFlow: + id: GoogleCloudApigeeV1SharedFlow properties: - link: - description: The link for the recommendation. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - description: + latestRevisionId: + description: The id of the most recently created revision for this shared flow. type: string - description: The description of the recommendation. - GoogleCloudApigeeV1ListEnvironmentGroupsResponse: - id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse - type: object - description: Response for ListEnvironmentGroups. - properties: - nextPageToken: + name: + description: The ID of the shared flow. type: string - description: >- - Page token that you can include in a ListEnvironmentGroups request - to retrieve the next page. If omitted, no subsequent pages exist. - environmentGroups: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' - type: array - description: EnvironmentGroups in the specified organization. - GoogleCloudApigeeV1ListEnvironmentResourcesResponse: - id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse - properties: - resourceFile: + metaData: + description: Metadata describing the shared flow. + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + revision: + description: A list of revisions of this shared flow. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' - description: List of resources files. - description: Response for ListEnvironmentResources + type: string type: object - GoogleCloudApigeeV1SecurityActionConditionConfig: - id: GoogleCloudApigeeV1SecurityActionConditionConfig + description: The metadata describing a shared flow + GoogleCloudApigeeV1ProfileConfig: type: object - description: >- - The following are a list of conditions. A valid SecurityAction must - contain at least one condition. Within a condition, each element is - ORed. Across conditions elements are ANDed. For example if a - SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and - bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: - enforce the action if the incoming request has ((ip_address_ranges = - "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR - bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges - and bot_reasons cannot be ANDed. properties: - apiKeys: - type: array - items: - type: string - description: Optional. A list of API keys. Limit 1000 per action. - developers: + categories: + description: List of categories of profile config. type: array items: - type: string - description: Optional. A list of developers. Limit 1000 per action. - botReasons: - type: array - description: >- - Optional. A list of Bot Reasons. Current options: Flooder, Brute - Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, - TorListRule, Advanced Anomaly Detection, Advanced API Scraper, - Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public - Cloud Azure, and Public Cloud Google. - items: - type: string - apiProducts: - description: Optional. A list of API Products. Limit 1000 per action. - type: array - items: - type: string - asns: - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' + description: >- + ProfileConfig defines a set of categories and policies which will be + used to compute security score. + id: GoogleCloudApigeeV1ProfileConfig + GoogleLongrunningOperation: + properties: + response: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - Optional. A list of ASN numbers to act on, e.g. 23. - https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses - int64 instead of uint32 because of - https://linter.aip.dev/141/forbidden-types. - items: - format: int64 - type: string - httpMethods: - items: - type: string + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + done: + type: boolean description: >- - Optional. Act only on particular HTTP methods. E.g. A read-only API - can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, - POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH. - type: array - ipAddressRanges: + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + error: description: >- - Optional. A list of IP addresses. This could be either IPv4 or IPv6. - Limited to 100 per action. - type: array - items: - type: string - accessTokens: - type: array - items: - type: string - description: Optional. A list of access_tokens. Limit 1000 per action. - regionCodes: - items: - type: string + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - Optional. A list of countries/region codes to act on, e.g. US. This - follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - type: array - userAgents: - type: array - items: - type: string + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + name: description: >- - Optional. A list of user agents to deny. We look for exact matches. - Limit 50 per action. - developerApps: - type: array - items: - type: string - description: Optional. A list of developer apps. Limit 1000 per action. - GoogleCloudApigeeV1DebugSessionTransaction: - id: GoogleCloudApigeeV1DebugSessionTransaction + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string description: >- - A transaction contains all of the debug information of the entire - message flow of an API call processed by the runtime plane. The - information is collected and recorded at critical points of the message - flow in the runtime apiproxy. - properties: - point: - description: >- - List of debug data collected by runtime plane at various defined - points in the flow. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Point' - completed: - type: boolean - description: Flag indicating whether a transaction is completed or not - type: object - GoogleCloudApigeeV1ProfileConfigAbuse: - id: GoogleCloudApigeeV1ProfileConfigAbuse + This resource represents a long-running operation that is the result of + a network API call. type: object - description: >- - Checks for abuse, which includes any requests sent to the API for - purposes other than what it is intended for, such as high volumes of - requests, data scraping, and abuse related to authorization. - properties: {} - GoogleCloudApigeeV1ListRatePlansResponse: - id: GoogleCloudApigeeV1ListRatePlansResponse + id: GoogleLongrunningOperation + GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: + id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest type: object + description: Request for UpdateAppGroupAppKey properties: - ratePlans: + apiProducts: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + type: string type: array - description: List of rate plans in an organization. - nextStartKey: description: >- - Value that can be sent as `startKey` to retrieve the next page of - content. If this field is omitted, there are no subsequent pages. + The list of API products that will be associated with the + credential. This list will be appended to the existing list of + associated API Products for this App Key. Duplicates will be + ignored. + appGroupAppKey: + description: >- + The new AppGroupKey to be amended. Note that the status can be + updated only via action. + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + action: type: string - description: Response for ListRatePlans. - GoogleCloudApigeeV1SecurityProfileScoringConfig: + description: >- + Approve or revoke the consumer key by setting this value to + `approve` or `revoke` respectively. The `Content-Type` header, if + set, must be set to `application/octet-stream`, with empty body. + GoogleCloudApigeeV1ScoreComponentRecommendationAction: + description: Action to improve security score. + type: object properties: + actionContext: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + description: Action context for the action. description: - description: Description of the config. - type: string - scorePath: + description: Description of the action. type: string - description: Path of the component config used for scoring. - title: + id: GoogleCloudApigeeV1ScoreComponentRecommendationAction + GoogleIamV1SetIamPolicyRequest: + properties: + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + updateMask: + description: >- + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + format: google-fieldmask type: string - description: Title of the config. + id: GoogleIamV1SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. type: object - description: Security configurations to manage scoring. - id: GoogleCloudApigeeV1SecurityProfileScoringConfig - GoogleCloudApigeeV1DeveloperAppKey: + GoogleCloudApigeeV1RevenueShareRange: + type: object + id: GoogleCloudApigeeV1RevenueShareRange properties: - attributes: - description: List of attributes associated with the credential. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - status: - type: string - description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - scopes: - type: array - items: - type: string + end: description: >- - Scopes to apply to the app. The specified scope names must already - be defined for the API product that you associate with the app. - expiresAt: + Ending value of the range. Set to 0 or `null` for the last range of + values. format: int64 type: string - description: Time the developer app expires in milliseconds since epoch. - consumerKey: - description: Consumer key. - type: string - expiresInSeconds: + start: format: int64 description: >- - Input only. Expiration time, in seconds, for the consumer key. If - not set or left to the default value of `-1`, the API key never - expires. The expiration time can't be updated after it is set. + Starting value of the range. Set to 0 or `null` for the initial + range of values. type: string - apiProducts: - items: - type: any + sharePercentage: + format: double description: >- - List of API products for which the credential can be used. **Note**: - Do not specify the list of API products when creating a consumer key - and secret for a developer app. Instead, use the - UpdateDeveloperAppKey API to make the association after the consumer - key and secret are created. - type: array - issuedAt: - type: string - format: int64 - description: Time the developer app was created in milliseconds since epoch. - consumerSecret: - type: string - description: Secret key. - type: object - id: GoogleCloudApigeeV1DeveloperAppKey - GoogleCloudApigeeV1TargetServerConfig: - id: GoogleCloudApigeeV1TargetServerConfig - type: object - properties: - tlsInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' - description: TLS settings for the target server. - enabled: - description: >- - Whether the target server is enabled. An empty/omitted value for - this field should be interpreted as true. - type: boolean - name: - type: string - description: >- - Target server revision name in the following format: - `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` - port: - type: integer - description: Port number for the target server. - format: int32 - protocol: - description: The protocol used by this target server. - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - enumDescriptions: - - UNSPECIFIED defaults to HTTP for backwards compatibility. - - The TargetServer uses HTTP. - - The TargetSever uses HTTP2. - - The TargetServer uses GRPC. - - >- - GRPC TargetServer to be used in ExternalCallout Policy. Prefer to - use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once - EXTERNAL _CALLOUT generally available. - - The TargetServer is to be used in the ExternalCallout Policy - type: string - host: - description: Host name of the target server. - type: string - GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: + Percentage of the revenue to be shared with the developer. For + example, to share 21 percent of the total revenue with the + developer, set this value to 21. Specify a decimal number with a + maximum of two digits following the decimal point. + type: number + description: >- + API call volume range and the percentage of revenue to share with the + developer when the total number of API calls is within the range. + GoogleCloudApigeeV1ApiDoc: type: object properties: - pageToken: - type: string - description: >- - Page token stands for a specific collection of time series - sequences. - pageSize: - type: integer - format: int32 - description: >- - Page size represents the number of time series sequences, one per - unique set of dimensions and their values. - metrics: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - description: Required. List of metrics and their aggregations. - windowSize: - enum: - - WINDOW_SIZE_UNSPECIFIED - - MINUTE - - HOUR - - DAY - - MONTH - type: string - enumDescriptions: - - Unspecified window size. Default is 1 hour. - - 1 Minute window - - 1 Hour window - - 1 Day window - - 1 Month window - description: Time buckets to group the stats by. - timestampOrder: - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. + apiProductName: type: string - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING - description: >- - Order the sequences in increasing or decreasing order of timestamps. - Default is descending order of timestamps (latest first). - dimensions: - description: >- - List of dimension names to group the aggregations by. If no - dimensions are passed, a single trend line representing the - requested metric aggregations grouped by environment is returned. - items: - type: string - type: array - filter: description: >- - Filter further on specific dimension values. Follows the same - grammar as custom report's filter expressions. Example, apiproxy eq - 'foobar'. - https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters + Required. Immutable. The `name` field of the associated [API + product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). + A portal may have only one catalog item associated with a given API + product. + graphqlSchema: type: string - timeRange: - description: Required. Time range for the stats. - $ref: '#/components/schemas/GoogleTypeInterval' - id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest - description: >- - QueryTimeSeriesStatsRequest represents a query that returns a collection - of time series sequences grouped by their values. - GoogleCloudApigeeV1ApiDoc: - description: >- - `ApiDoc` represents an API catalog item. Catalog items are used in two - ways in a portal: - Users can browse and interact with a visual - representation of the API documentation - The `api_product_name` field - provides a link to a backing [API product] - (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). - Through this link, portal users can create and manage developer apps - linked to one or more API products. - type: object - properties: - published: - type: boolean description: >- - Optional. Denotes whether the catalog item is published to the - portal or is in a draft state. When the parent portal is enrolled in - the [audience management - feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), - the visibility can be set to public on creation by setting the - anonAllowed flag to true or further managed in the management UI - (see [Manage the visibility of an API in your - portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) - before it can be visible to any users. If not enrolled in the - audience management feature, the visibility is managed by the - `anonAllowed` flag. - categoryIds: - items: - type: string - type: array - description: >- - Optional. The IDs of the API categories to which this catalog item - belongs. - title: - description: >- - Required. The user-facing name of the catalog item. `title` must be - a non-empty string with a max length of 255 characters. - type: string + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + deprecated: true modified: + format: int64 + readOnly: true description: >- Output only. Time the catalog item was last modified in milliseconds since epoch. - readOnly: true - format: int64 - type: string - description: type: string - description: >- - Optional. Description of the catalog item. Max length is 10,000 - characters. anonAllowed: type: boolean description: >- @@ -599,48 +326,57 @@ components: Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI. - siteId: - description: Output only. The ID of the parent portal. - readOnly: true - type: string - requireCallbackUrl: - type: boolean - description: >- - Optional. Whether a callback URL is required when this catalog - item's API product is enabled in a developer app. When true, a - portal user will be required to input a URL when managing the app - (this is typically used for the app's OAuth flow). - graphqlSchema: - type: string - description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - deprecated: true id: - readOnly: true + type: string description: Output only. The ID of the catalog item. format: int64 + readOnly: true + description: + description: >- + Optional. Description of the catalog item. Max length is 10,000 + characters. type: string - graphqlSchemaDisplayName: + edgeAPIProductName: + description: >- + Optional. Immutable. DEPRECATED: use the `apiProductName` field + instead type: string + published: description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - deprecated: true + Optional. Denotes whether the catalog item is published to the + portal or is in a draft state. When the parent portal is enrolled in + the [audience management + feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), + the visibility can be set to public on creation by setting the + anonAllowed flag to true or further managed in the management UI + (see [Manage the visibility of an API in your + portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) + before it can be visible to any users. If not enrolled in the + audience management feature, the visibility is managed by the + `anonAllowed` flag. + type: boolean visibility: description: 'Optional. DEPRECATED: use the `published` field instead' type: boolean - edgeAPIProductName: + title: type: string description: >- - Optional. Immutable. DEPRECATED: use the `apiProductName` field - instead - graphqlEndpointUrl: - deprecated: true - type: string + Required. The user-facing name of the catalog item. `title` must be + a non-empty string with a max length of 255 characters. + requireCallbackUrl: + type: boolean description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods + Optional. Whether a callback URL is required when this catalog + item's API product is enabled in a developer app. When true, a + portal user will be required to input a URL when managing the app + (this is typically used for the app's OAuth flow). + categoryIds: + description: >- + Optional. The IDs of the API categories to which this catalog item + belongs. + items: + type: string + type: array imageUrl: type: string description: >- @@ -655,2411 +391,2552 @@ components: [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters. - apiProductName: + siteId: + readOnly: true type: string - description: >- - Required. Immutable. The `name` field of the associated [API - product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). - A portal may have only one catalog item associated with a given API - product. + description: Output only. The ID of the parent portal. specId: - deprecated: true + type: string description: 'Optional. DEPRECATED: DO NOT USE' + deprecated: true + graphqlSchemaDisplayName: + type: string + deprecated: true + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + graphqlEndpointUrl: + deprecated: true + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods type: string id: GoogleCloudApigeeV1ApiDoc - GoogleCloudApigeeV1SecurityAssessmentResultResource: + description: >- + `ApiDoc` represents an API catalog item. Catalog items are used in two + ways in a portal: - Users can browse and interact with a visual + representation of the API documentation - The `api_product_name` field + provides a link to a backing [API product] + (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). + Through this link, portal users can create and manage developer apps + linked to one or more API products. + GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: properties: - type: - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. - type: string - description: Required. Type of this resource. - resourceRevisionId: - type: string + environmentGroupAttachments: + description: EnvironmentGroupAttachments for the specified environment group. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' + nextPageToken: description: >- - The revision id for the resource. In case of Apigee, this is proxy - revision id. - name: + Page token that you can include in a ListEnvironmentGroupAttachments + request to retrieve the next page. If omitted, no subsequent pages + exist. type: string - description: Required. Name of this resource. - description: Resource for which we are computing security assessment. - id: GoogleCloudApigeeV1SecurityAssessmentResultResource + description: Response for ListEnvironmentGroupAttachments. + id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse type: object - GoogleCloudApigeeV1SecurityProfileEnvironment: - id: GoogleCloudApigeeV1SecurityProfileEnvironment + GoogleCloudApigeeV1SetAddonsRequest: type: object + id: GoogleCloudApigeeV1SetAddonsRequest properties: - attachTime: - readOnly: true - type: string + addonsConfig: + description: Required. Add-on configurations. + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + description: Request for SetAddons. + GoogleIamV1TestIamPermissionsResponse: + properties: + permissions: + type: array + items: + type: string description: >- - Output only. Time at which environment was attached to the security - profile. - format: google-datetime - environment: - readOnly: true - type: string - description: Output only. Name of the environment. - description: >- - Environment information of attached environments. Scoring an environment - is enabled only if it is attached to a security profile. - GoogleCloudApigeeV1Datastore: + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: object + id: GoogleIamV1TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + GoogleCloudApigeeV1GrpcOperationGroup: + type: object + id: GoogleCloudApigeeV1GrpcOperationGroup description: >- - The data store defines the connection to export data repository (Cloud - Storage, BigQuery), including the credentials used to access the data - repository. - id: GoogleCloudApigeeV1Datastore + List of gRPC operation configuration details associated with Apigee API + proxies. properties: - org: - type: string - description: Output only. Organization that the datastore belongs to - readOnly: true - lastUpdateTime: - description: >- - Output only. Datastore last update time, in milliseconds since the - epoch of 1970-01-01T00:00:00Z - format: int64 - readOnly: true - type: string - createTime: - readOnly: true + operationConfigs: description: >- - Output only. Datastore create time, in milliseconds since the epoch - of 1970-01-01T00:00:00Z - type: string - format: int64 - displayName: - description: Required. Display name in UI - type: string - datastoreConfig: - description: Datastore Configurations. - $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' - self: - readOnly: true + Required. List of operation configurations for either Apigee API + proxies that are associated with this API product. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' + GoogleCloudApigeeV1GetSyncAuthorizationRequest: + description: Request for GetSyncAuthorization. + id: GoogleCloudApigeeV1GetSyncAuthorizationRequest + type: object + properties: {} + GoogleCloudApigeeV1OperationMetadataProgress: + properties: + description: + description: Description of the operation's progress. type: string - description: >- - Output only. Resource link of Datastore. Example: - `/organizations/{org}/analytics/datastores/{uuid}` - targetType: + details: + additionalProperties: + type: any + description: Properties of the object. + description: The additional details of the progress. + type: object + state: + description: State of the operation. + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED type: string - description: Destination storage type. Supported types `gcs` or `bigquery`. + enumDescriptions: + - '' + - '' + - '' + - '' + percentDone: + description: The percentage of the operation progress. + type: integer + format: int32 + id: GoogleCloudApigeeV1OperationMetadataProgress type: object - GoogleCloudApigeeV1Developer: + description: Information about operation progress. + GoogleCloudApigeeV1Point: type: object properties: - createdAt: - description: >- - Output only. Time at which the developer was created in milliseconds - since epoch. - format: int64 - type: string - readOnly: true - lastModifiedAt: + results: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Result' + type: array + description: List of results extracted from a given debug point. + id: type: string + description: Name of a step in the transaction. + description: >- + Point is a group of information collected by runtime plane at critical + points of the message flow of the processed API request. This is a list + of supported point IDs, categorized to three major buckets. For each + category, debug points that we are currently supporting are listed + below: - Flow status debug points: StateChange FlowInfo Condition + Execution DebugMask Error - Flow control debug points: FlowCallout + Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: + ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition + Oauth2ServicePoint RaiseFault NodeJS The detail information of the given + debug point is stored in a list of results. + id: GoogleCloudApigeeV1Point + GoogleCloudApigeeV1DeveloperBalanceWallet: + type: object + description: Wallet used to manage an account balance for a particular currency. + properties: + balance: + description: >- + Current remaining balance of the developer for a particular + currency. + $ref: '#/components/schemas/GoogleTypeMoney' + lastCreditTime: format: int64 description: >- - Output only. Time at which the developer was last modified in - milliseconds since epoch. + Output only. Time at which the developer last added credit to the + account in milliseconds since epoch. readOnly: true - email: - description: >- - Required. Email address of the developer. This value is used to - uniquely identify the developer in Apigee hybrid. Note that the - email address has to be in lowercase only. type: string - firstName: - type: string - description: Required. First name of the developer. - attributes: - description: >- - Optional. Developer attributes (name/value pairs). The custom - attribute limit is 18. + id: GoogleCloudApigeeV1DeveloperBalanceWallet + GoogleCloudApigeeV1OptimizedStatsNode: + properties: + data: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - lastName: + type: any + id: GoogleCloudApigeeV1OptimizedStatsNode + type: object + description: >- + Encapsulates a data node as represented below: ``` { "identifier": { + "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": + "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` + { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` + Depending on whether a dimension is present in the query or not the data + node type can be a simple metric value or dimension identifier with list + of metrics. + GoogleCloudApigeeV1MonetizationConfig: + id: GoogleCloudApigeeV1MonetizationConfig + description: Configuration for the Monetization add-on. + type: object + properties: + enabled: + type: boolean + description: Flag that specifies whether the Monetization add-on is enabled. + GoogleCloudApigeeV1MetricAggregation: + properties: + order: + enum: + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING + description: >- + Ordering for this aggregation in the result. For time series this is + ignored since the ordering of points depends only on the timestamp, + not the values. type: string - description: Required. Last name of the developer. - userName: - description: Required. User name of the developer. Not used by Apigee hybrid. + enumDescriptions: + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. + name: type: string - status: + description: Name of the metric + aggregation: type: string - description: >- - Output only. Status of the developer. Valid values are `active` and - `inactive`. - readOnly: true - organizationName: - readOnly: true - description: >- - Output only. Name of the Apigee organization in which the developer - resides. + enum: + - AGGREGATION_FUNCTION_UNSPECIFIED + - AVG + - SUM + - MIN + - MAX + - COUNT_DISTINCT + enumDescriptions: + - Unspecified Aggregation function. + - Average. + - Summation. + - Min. + - Max. + - Count distinct + description: Aggregation function associated with the metric. + type: object + id: GoogleCloudApigeeV1MetricAggregation + description: The optionally aggregated metric to query with its ordering. + GoogleCloudApigeeV1ReportInstanceStatusRequest: + id: GoogleCloudApigeeV1ReportInstanceStatusRequest + description: Request for ReportInstanceStatus. + type: object + properties: + instanceUid: type: string - developerId: + description: >- + A unique ID for the instance which is guaranteed to be unique in + case the user installs multiple hybrid runtimes with the same + instance ID. + reportTime: + description: >- + The time the report was generated in the runtime. Used to prevent an + old status from overwriting a newer one. An instance should space + out it's status reports so that clock skew does not play a factor. + format: google-datetime type: string + resources: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' + type: array + description: Status for config resources + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: + type: object + properties: + resources: + type: array description: >- - ID of the developer. **Note**: IDs are generated internally by - Apigee and are not guaranteed to stay the same over time. - companies: - description: List of companies associated with the developer. + Required. The array of resources. For Apigee, the proxies are + resources. + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + description: An array of resource messages. + GoogleCloudApigeeV1AppGroupAppKey: + id: GoogleCloudApigeeV1AppGroupAppKey + description: >- + AppGroupAppKey contains all the information associated with the + credentials. + properties: + scopes: type: array items: type: string - appFamily: - description: Developer app family. + description: >- + Scopes to apply to the app. The specified scope names must already + be defined for the API product that you associate with the app. + expiresInSeconds: type: string - accessType: - description: Access type. + description: >- + Immutable. Expiration time, in seconds, for the consumer key. If not + set or left to the default value of `-1`, the API key never expires. + The expiration time can't be updated after it is set. + format: int64 + expiresAt: type: string - apps: + readOnly: true + format: int64 + description: >- + Output only. Time the AppGroup app expires in milliseconds since + epoch. + consumerSecret: + type: string + description: Secret key. + consumerKey: + description: Immutable. Consumer key. + type: string + attributes: type: array items: - type: string - description: List of apps associated with the developer. - id: GoogleCloudApigeeV1Developer - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: - description: The response for GetAsyncQueryResultUrl - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse - type: object - properties: - urls: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: List of attributes associated with the credential. + status: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. + type: string + apiProducts: + readOnly: true items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - description: The list of Signed URLs generated by the CreateAsyncQuery request + $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' + description: >- + Output only. List of API products and its status for which the + credential can be used. **Note**: Use + UpdateAppGroupAppKeyApiProductRequest API to make the association + after the consumer key and secret are created. type: array - GoogleCloudApigeeV1QueryMetadata: + issuedAt: + description: >- + Output only. Time the AppGroup app was created in milliseconds since + epoch. + type: string + format: int64 + readOnly: true + type: object + GoogleCloudApigeeV1ConfigVersion: + description: >- + Version of the API proxy configuration schema. Currently, only 4.0 is + supported. + id: GoogleCloudApigeeV1ConfigVersion type: object - id: GoogleCloudApigeeV1QueryMetadata properties: - endTimestamp: - description: End timestamp of the query range. + majorVersion: + description: Major version of the API proxy configuration schema. + type: integer + format: int32 + minorVersion: + format: int32 + type: integer + description: Minor version of the API proxy configuration schema. + GoogleCloudApigeeV1ApiDocResponse: + description: The catalog item resource wrapped with response status, error_code, etc. + properties: + requestId: type: string - timeUnit: - description: Query GroupBy time unit. + description: Unique ID of the request. + data: + description: The catalog item resource. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + status: + description: Status of the operation. type: string - startTimestamp: + message: + description: Description of the operation. type: string - description: Start timestamp of the query range. - dimensions: - description: Dimensions of the AsyncQuery. + errorCode: + type: string + description: Unique error code for the request, if any. + type: object + id: GoogleCloudApigeeV1ApiDocResponse + GoogleCloudApigeeV1KeystoreConfig: + properties: + aliases: + description: Aliases in the keystore. items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' type: array - outputFormat: + name: type: string - description: Output format. - metrics: - type: array - items: - type: string description: >- - Metrics of the AsyncQuery. Example: - ["name:message_count,func:sum,alias:sum_message_count"] - GoogleCloudApigeeV1DocumentationFile: + Resource name in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` + id: GoogleCloudApigeeV1KeystoreConfig type: object - description: Documentation file contents for a catalog item. + GoogleCloudApigeeV1KeyValueEntry: properties: - contents: - format: byte - description: Required. The file contents. The max size is 4 MB. + name: type: string - displayName: + description: >- + Resource URI that can be used to identify the scope of the key value + map entries. + value: type: string description: >- - Required. A display name for the file, shown in the management UI. - Max length is 255 characters. - id: GoogleCloudApigeeV1DocumentationFile - GoogleCloudApigeeV1ListExportsResponse: + Required. Data or payload that is being retrieved and associated + with the unique key. + type: object + id: GoogleCloudApigeeV1KeyValueEntry + description: >- + Key value map pair where the value represents the data associated with + the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and + higher. + GoogleRpcPreconditionFailure: properties: - exports: + violations: + description: Describes all precondition violations. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' type: array - description: Details of the export jobs. - id: GoogleCloudApigeeV1ListExportsResponse - description: The response for ListExports + description: >- + Describes what preconditions have failed. For example, if an RPC failed + because it required the Terms of Service to be acknowledged, it could + list the terms of service violation in the PreconditionFailure message. + id: GoogleRpcPreconditionFailure type: object - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse + GoogleCloudApigeeV1Datastore: properties: - operations: - type: array - description: >- - A list of operations that matches the specified filter in the - request. - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - nextPageToken: - description: The standard List next-page token. + datastoreConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' + description: Datastore Configurations. + displayName: + description: Required. Display name in UI type: string - description: The response message for Operations.ListOperations. - type: object - GoogleCloudApigeeV1OperationConfig: - id: GoogleCloudApigeeV1OperationConfig - properties: - apiSource: - description: >- - Required. Name of the API proxy or remote service with which the - resources, methods, and quota are associated. + org: type: string - attributes: - description: Custom attributes associated with the operation. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' - description: >- - Quota parameters to be enforced for the resources, methods, and API - source combination. If none are specified, quota enforcement will - not be done. - operations: - type: array + readOnly: true + description: Output only. Organization that the datastore belongs to + lastUpdateTime: + type: string + readOnly: true description: >- - List of resource/method pairs for the API proxy or remote service to - which quota will applied. **Note**: Currently, you can specify only - a single resource/method pair. The call will fail if more than one - resource/method pair is provided. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' - type: object - description: >- - Binds the resources in an API proxy or remote service with the allowed - REST methods and associated quota enforcement. - GoogleCloudApigeeV1DeveloperMonetizationConfig: - description: Monetization configuration for the developer. - id: GoogleCloudApigeeV1DeveloperMonetizationConfig - type: object - properties: - billingType: - description: Billing type. + Output only. Datastore last update time, in milliseconds since the + epoch of 1970-01-01T00:00:00Z + format: int64 + self: type: string - enum: - - BILLING_TYPE_UNSPECIFIED - - PREPAID - - POSTPAID - enumDescriptions: - - The default/unset value. - - >- - Developer pays in advance for the use of APIs and the charged - amount is deducted from their account balance. - - >- - Developer does not maintain an account balance. The API provider - bills the developer for API usage. - GoogleCloudApigeeV1RuntimeTraceSamplingConfig: - properties: - samplingRate: - type: number - format: float description: >- - Field sampling rate. This value is only applicable when using the - PROBABILITY sampler. The supported values are > 0 and <= 0.5. - sampler: + Output only. Resource link of Datastore. Example: + `/organizations/{org}/analytics/datastores/{uuid}` + readOnly: true + createTime: + readOnly: true + description: >- + Output only. Datastore create time, in milliseconds since the epoch + of 1970-01-01T00:00:00Z + format: int64 + type: string + targetType: + description: Destination storage type. Supported types `gcs` or `bigquery`. type: string - enumDescriptions: - - Sampler unspecified. - - >- - OFF means distributed trace is disabled, or the sampling - probability is 0. - - >- - PROBABILITY means traces are captured on a probability that - defined by sampling_rate. The sampling rate is limited to 0 to 0.5 - when this is set. - enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY - description: Sampler of distributed tracing. OFF is the default value. type: object - id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig description: >- - NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of - distributed tracing. Only the fields that are defined in the distributed - trace configuration can be overridden using the distribute trace - configuration override APIs. - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: + The data store defines the connection to export data repository (Cloud + Storage, BigQuery), including the credentials used to access the data + repository. + id: GoogleCloudApigeeV1Datastore + GoogleCloudApigeeV1SecurityAction: properties: - weight: + state: enum: - - WEIGHT_UNSPECIFIED - - MINOR - - MODERATE - - MAJOR - description: The weight of the assessment which was set in the profile. - type: string - enumDescriptions: - - The weight is unspecified. - - The weight is minor. - - The weight is moderate. - - The weight is major. - displayName: - description: The display name of the assessment. + - STATE_UNSPECIFIED + - ENABLED + - DISABLED type: string - recommendations: - description: The recommended steps of the assessment. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - type: array - verdict: enumDescriptions: - - The verdict is unspecified. - - The assessment has passed. - - The assessment has failed. - enum: - - VERDICT_UNSPECIFIED - - PASS - - FAIL - description: Verdict indicates the assessment result. - type: string - scoreImpact: - format: int32 + - >- + The default value. This only exists for forward compatibility. A + create request with this value will be rejected. + - >- + An ENABLED SecurityAction is actively enforced if the + `expiration_time` is in the future. + - A disabled SecurityAction is never enforced. description: >- - Score impact indicates the impact on the overall score if the - assessment were to pass. - type: integer - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation - description: The message format of a recommendation from the assessment. - type: object - GoogleCloudApigeeV1ResourceFile: - properties: - type: - type: string - description: Resource file type. {{ resource_file_type }} + Required. Only an ENABLED SecurityAction is enforced. An ENABLED + SecurityAction past its expiration time will not be enforced. + conditionConfig: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig + description: >- + Required. A valid SecurityAction must contain at least one + condition. + allow: + description: Allow a request through if it matches this SecurityAction. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' name: - description: ID of the resource file. - type: string - type: object - id: GoogleCloudApigeeV1ResourceFile - description: Metadata about a resource file. - GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: - description: Request for ExpireDeveloperSubscription. - properties: {} - type: object - id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest - GoogleTypeInterval: - type: object - properties: - endTime: - format: google-datetime description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. + Immutable. This field is ignored during creation as per AIP-133. + Please set the `security_action_id` field in the + CreateSecurityActionRequest when creating a new SecurityAction. + Format: + organizations/{org}/environments/{env}/securityActions/{security_action} + type: string + description: type: string - 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. + Optional. An optional user provided description of the + SecurityAction. + deny: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' + description: Deny a request through if it matches this SecurityAction. + createTime: + description: Output only. The create time for this SecurityAction. + readOnly: true format: google-datetime type: string - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - id: GoogleTypeInterval - GoogleRpcPreconditionFailureViolation: - properties: - description: - description: >- - A description of how the precondition failed. Developers can use - this description to understand how to fix the failure. For example: - "Terms of service not accepted". + ttl: type: string - subject: + description: Input only. The TTL for this SecurityAction. + format: google-duration + updateTime: + readOnly: true type: string description: >- - The subject, relative to the type, that failed. For example, - "google.com/cloud" relative to the "TOS" type would indicate which - terms of service is being referenced. - type: - description: >- - The type of PreconditionFailure. We recommend using a - service-specific enum type to define the supported precondition - violation subjects. For example, "TOS" for "Terms of Service - violation". + Output only. The update time for this SecurityAction. This reflects + when this SecurityAction changed states. + format: google-datetime + flag: + description: Flag a request through if it matches this SecurityAction. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' + expireTime: + description: The expiration for this SecurityAction. + format: google-datetime type: string + apiProxies: + description: >- + Optional. If unset, this would apply to all proxies in the + environment. If set, this action is enforced only if at least one + proxy in the repeated list is deployed at the time of enforcement. + If set, several restrictions are enforced on SecurityActions. There + can be at most 100 enabled actions with proxies set in an env. + Several other restrictions apply on conditions and are detailed + later. + items: + type: string + type: array + description: >- + A SecurityAction is rule that can be enforced at an environment level. + The result is one of: - A denied API call - An explicitly allowed API + call - A flagged API call (HTTP headers added before the target receives + it) At least one condition is required to create a SecurityAction. + id: GoogleCloudApigeeV1SecurityAction + type: object + GoogleCloudApigeeV1DebugMask: type: object - description: A message type used to describe a single precondition failure. - id: GoogleRpcPreconditionFailureViolation - GoogleCloudApigeeV1ConfigVersion: properties: - minorVersion: - description: Minor version of the API proxy configuration schema. - type: integer - format: int32 - majorVersion: - format: int32 - type: integer - description: Major version of the API proxy configuration schema. - id: GoogleCloudApigeeV1ConfigVersion - description: >- - Version of the API proxy configuration schema. Currently, only 4.0 is - supported. - type: object - GoogleCloudApigeeV1StatsHostStats: - properties: - dimensions: - description: List of metrics grouped under dimensions. + name: + type: string + description: Name of the debug mask. + variables: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - metrics: + type: string + description: List of variables that should be masked from the debug output. + requestJSONPaths: + items: + type: string + description: >- + List of JSON paths that specify the JSON elements to be filtered + from JSON request message payloads. + type: array + requestXPaths: type: array + description: >- + List of XPaths that specify the XML elements to be filtered from XML + request message payloads. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + type: string + faultXPaths: description: >- - In the final response, only one of the following fields will be - present based on the dimensions provided. If no dimensions are - provided, then only the top-level metrics are provided. If - dimensions are included, then there will be a top-level dimensions - field under hostnames which will contain metrics values and the - dimension name. Example: ``` "hosts": [ { "dimensions": [ { - "metrics": [ { "name": "sum(message_count)", "values": [ - "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" - } ]``` OR ```"hosts": [ { "metrics": [ { "name": - "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": - "example.com" } ]``` List of metric values. - name: - type: string - description: Hostname used in query. - id: GoogleCloudApigeeV1StatsHostStats - type: object - description: >- - Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { - "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": - "example.com" } ]``` - GoogleCloudApigeeV1GenerateDownloadUrlResponse: - type: object - id: GoogleCloudApigeeV1GenerateDownloadUrlResponse - description: Response for GenerateDownloadUrl method. - properties: - downloadUri: + List of XPaths that specify the XML elements to be filtered from XML + payloads in error flows. + items: + type: string + type: array + namespaces: + description: Map of namespaces to URIs. + type: object + additionalProperties: + type: string + responseXPaths: description: >- - The Google Cloud Storage signed URL that can be used to download the - Archive zip file. - type: string - GoogleCloudApigeeV1ScoreComponentRecommendation: - description: Recommendation based on security concerns and score. + List of XPaths that specify the XML elements to be filtered from XML + response message payloads. + items: + type: string + type: array + responseJSONPaths: + items: + type: string + type: array + description: >- + List of JSON paths that specify the JSON elements to be filtered + from JSON response message payloads. + faultJSONPaths: + description: >- + List of JSON paths that specify the JSON elements to be filtered + from JSON payloads in error flows. + type: array + items: + type: string + id: GoogleCloudApigeeV1DebugMask + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: properties: - impact: + scoreImpact: format: int32 - description: >- - Potential impact of this recommendation on the overall score. This - denotes how important this recommendation is to improve the score. type: integer - actions: - type: array + description: >- + Score impact indicates the impact on the overall score if the + assessment were to pass. + displayName: + type: string + description: The display name of the assessment. + recommendations: items: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction - description: Actions for the recommendation to improve the security score. - description: + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + description: The recommended steps of the assessment. + type: array + weight: + description: The weight of the assessment which was set in the profile. + enumDescriptions: + - The weight is unspecified. + - The weight is minor. + - The weight is moderate. + - The weight is major. type: string - description: Description of the recommendation. - title: - description: Title represents recommendation title. + enum: + - WEIGHT_UNSPECIFIED + - MINOR + - MODERATE + - MAJOR + verdict: + enum: + - VERDICT_UNSPECIFIED + - PASS + - FAIL + description: Verdict indicates the assessment result. type: string + enumDescriptions: + - The verdict is unspecified. + - The assessment has passed. + - The assessment has failed. + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation type: object - id: GoogleCloudApigeeV1ScoreComponentRecommendation - GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: + description: The message format of a recommendation from the assessment. + GoogleCloudApigeeV1TraceConfigOverride: properties: - shouldSequenceRollout: - description: >- - Set to `true` if using sequenced rollout would make this routing - change safer. **Note**: This does not necessarily imply that - automated sequenced rollout mode is supported for the operation. - type: boolean - toDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - description: >- - Base path/deployment that may start receiving that traffic. May be - null if no deployment is able to receive the traffic. - fromDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - description: Base path/deployment that may stop receiving some traffic. - environmentGroup: + apiProxy: type: string - description: Name of the environment group affected by this routing change. - description: - description: Human-readable description of this routing change. + description: >- + ID of the API proxy that will have its trace configuration + overridden. + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + description: Trace configuration to override. + name: type: string - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + description: >- + ID of the trace configuration override specified as a + system-generated UUID. + description: A representation of a configuration override. + id: GoogleCloudApigeeV1TraceConfigOverride type: object - description: >- - Describes a potential routing change that may occur as a result of some - deployment operation. - GoogleCloudApigeeV1GraphQLOperationConfig: + GoogleCloudApigeeV1SecurityActionFlag: properties: - apiSource: - description: >- - Required. Name of the API proxy endpoint or remote service with - which the GraphQL operation and quota are associated. - type: string - attributes: - description: Custom attributes associated with the operation. + headers: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - operations: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' description: >- - Required. List of GraphQL name/operation type pairs for the proxy or - remote service to which quota will be applied. If only operation - types are specified, the quota will be applied to all GraphQL - requests irrespective of the GraphQL name. **Note**: Currently, you - can specify only a single GraphQLOperation. Specifying more than one - will cause the operation to fail. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' + Optional. A list of HTTP headers to be sent to the target in case of + a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least + one is mandatory. type: array - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' - description: >- - Quota parameters to be enforced for the resources, methods, and API - source combination. If none are specified, quota enforcement will - not be done. - type: object - id: GoogleCloudApigeeV1GraphQLOperationConfig - description: >- - Binds the resources in a proxy or remote service with the GraphQL - operation and its associated quota enforcement. - GoogleTypeMoney: + description: The message that should be set in the case of a Flag action. type: object - description: Represents an amount of money with its currency type. + id: GoogleCloudApigeeV1SecurityActionFlag + GoogleCloudApigeeV1ListApiDocsResponse: properties: - currencyCode: - description: The three-letter currency code defined in ISO 4217. + status: type: string - units: + description: Status of the operation. + nextPageToken: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + 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 - format: int64 - nanos: - type: integer - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - format: int32 - id: GoogleTypeMoney - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: - description: Message for include_all option. - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - properties: {} - type: object - GoogleIamV1AuditLogConfig: - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - properties: - exemptedMembers: - items: - type: string - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. + requestId: + type: string + description: Unique ID of the request. + data: type: array - logType: - description: The log type that this config enables. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + description: The catalog item resources. + errorCode: + description: Unique error code for the request, if any. type: string - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' + message: + description: Description of the operation. + type: string + id: GoogleCloudApigeeV1ListApiDocsResponse + type: object + GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: + id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation type: object - id: GoogleIamV1AuditLogConfig - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: properties: - environment: - description: >- - Destination environment. This will be empty if the route is not yet - reported. + name: type: string - envgroup: + description: Immutable. Name of the environment that the profile is attached to. + securityProfileRevisionId: + format: int64 + deprecated: true type: string - description: Environment group where this route is installed. - basepath: + description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' + attachTime: + format: google-datetime + description: >- + Output only. The time when environment was attached to the security + profile. type: string - description: Base path in the routing table. - percentage: - type: integer - format: int32 - description: Percentage of ingress replicas reporting this route. + readOnly: true + description: Represents a SecurityProfileEnvironmentAssociation resource. + GoogleCloudApigeeV1AccessLoggingConfig: type: object - description: Route deployed in the ingress routing table. - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute - GoogleCloudApigeeV1GraphQLOperationGroup: - id: GoogleCloudApigeeV1GraphQLOperationGroup description: >- - List of graphQL operation configuration details associated with Apigee - API proxies or remote services. Remote services are non-Apigee proxies, - such as Istio-Envoy. + Access logging configuration enables customers to ship the access logs + from the tenant projects to their own project's cloud logging. The + feature is at the instance level ad disabled by default. It can be + enabled during CreateInstance or UpdateInstance. properties: - operationConfigs: - description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' - type: array - operationConfigType: + filter: description: >- - Flag that specifies whether the configuration is for Apigee API - proxy or a remote service. Valid values include `proxy` or - `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API - proxies are associated with the API product. Set to `remoteservice` - when non-Apigee proxies like Istio-Envoy are associated with the API - product. + Optional. Ship the access log entries that match the status_code + defined in the filter. The status_code is the only + expected/supported filter field. (Ex: status_code) The filter will + parse it to the Common Expression Language semantics for expression + evaluation to build the filter condition. (Ex: "filter": status_code + >= 200 && status_code < 300 ) type: string - type: object - GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: - description: Tuple representing a base path and the deployment containing it. + enabled: + type: boolean + description: >- + Optional. Boolean flag that specifies whether the customer access + log feature is enabled. + id: GoogleCloudApigeeV1AccessLoggingConfig + GoogleCloudApigeeV1DeploymentGroupConfig: + description: >- + DeploymentGroupConfig represents a deployment group that should be + present in a particular environment. properties: - apiProxy: - description: Name of the deployed API proxy revision containing the base path. - type: string - environment: + uid: type: string - description: Name of the environment in which the proxy is deployed. - revision: + description: >- + Unique ID. The ID will only change if the deployment group is + deleted and recreated. + deploymentGroupType: type: string - description: Name of the deployed API proxy revision containing the base path. - basepath: + enum: + - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + enumDescriptions: + - Unspecified type + - Standard type + - Extensible Type + description: >- + Type of the deployment group, which will be either Standard or + Extensible. + revisionId: + format: int64 type: string - description: Base path receiving traffic. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - type: object - GoogleCloudApigeeV1ListAppGroupAppsResponse: - description: Response for ListAppGroupApps - id: GoogleCloudApigeeV1ListAppGroupAppsResponse - properties: - appGroupApps: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' - description: List of AppGroup apps and their credentials. - type: array - nextPageToken: + description: >- + Revision number which can be used by the runtime to detect if the + deployment group has changed between two versions. + name: type: string description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + Name of the deployment group in the following format: + `organizations/{org}/environments/{env}/deploymentGroups/{group}`. + id: GoogleCloudApigeeV1DeploymentGroupConfig type: object - GoogleCloudApigeeV1FlowHookConfig: + GoogleCloudApigeeV1SecurityActionDeny: + description: Message that should be set in case of a Deny Action. + id: GoogleCloudApigeeV1SecurityActionDeny properties: - continueOnError: - type: boolean - description: >- - Flag that specifies whether the flow should abort after an error in - the flow hook. Defaults to `true` (continue on error). - sharedFlowName: - description: >- - Name of the shared flow to invoke in the following format: - `organizations/{org}/sharedflows/{sharedflow}` - type: string - name: - description: >- - Name of the flow hook in the following format: - `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid - `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, - `PreTargetFlowHook`, and `PostTargetFlowHook` - type: string - id: GoogleCloudApigeeV1FlowHookConfig + responseCode: + type: integer + description: Optional. The HTTP response code if the Action = DENY. + format: int32 type: object - GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: + GoogleCloudApigeeV1DeveloperBalance: + id: GoogleCloudApigeeV1DeveloperBalance properties: - adjustment: - $ref: '#/components/schemas/GoogleTypeMoney' + wallets: description: >- - * A positive value of `adjustment` means that that the API provider - wants to adjust the balance for an under-charged developer i.e. the - balance of the developer will decrease. * A negative value of - `adjustment` means that that the API provider wants to adjust the - balance for an over-charged developer i.e. the balance of the - developer will increase. - description: Request for AdjustDeveloperBalance. - id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest - type: object - GoogleCloudApigeeV1DeleteCustomReportResponse: - id: GoogleCloudApigeeV1DeleteCustomReportResponse + Output only. List of all wallets. Each individual wallet stores the + account balance for a particular currency. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' + readOnly: true type: object + description: Account balance for the developer. + GoogleCloudApigeeV1ListEnvironmentResourcesResponse: + id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse properties: - message: - description: The response contains only a message field. - type: string - GoogleCloudApigeeV1SecurityReportResultMetadata: + resourceFile: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + description: List of resources files. + type: array + type: object + description: Response for ListEnvironmentResources + GoogleCloudApigeeV1UpdateError: + id: GoogleCloudApigeeV1UpdateError properties: - expires: + type: description: >- - Output only. Expire_time is set to 7 days after report creation. - Query result will be unaccessable after this time. Example: - "2021-05-04T13:38:52-07:00" - readOnly: true + A string that uniquely identifies the type of error. This provides a + more reliable means to deduplicate errors across revisions and + instances. type: string - self: - description: >- - Self link of the query results. Example: - `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - or following format if query is running at host level: - `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + code: type: string - id: GoogleCloudApigeeV1SecurityReportResultMetadata - description: Contains informations about the security report results. - type: object - GoogleCloudApigeeV1ActivateNatAddressRequest: - type: object - properties: {} - description: Request for ActivateNatAddressRequest. Activate the nat address request. - id: GoogleCloudApigeeV1ActivateNatAddressRequest - GoogleCloudApigeeV1Export: - type: object - id: GoogleCloudApigeeV1Export - description: Details of an export job. - properties: - created: - readOnly: true - description: Output only. Time the export job was created. - type: string - description: - description: Description of the export job. + description: Status code. + enumDescriptions: + - 'Not an error; returned on success. HTTP Mapping: 200 OK' + - >- + The operation was cancelled, typically by the caller. HTTP + Mapping: 499 Client Closed Request + - >- + Unknown error. For example, this error may be returned when a + `Status` value received from another address space belongs to an + error space that is not known in this address space. Also errors + raised by APIs that do not return enough error information may be + converted to this error. HTTP Mapping: 500 Internal Server Error + - >- + The client specified an invalid argument. Note that this differs + from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments + that are problematic regardless of the state of the system (e.g., + a malformed file name). HTTP Mapping: 400 Bad Request + - >- + The deadline expired before the operation could complete. For + operations that change the state of the system, this error may be + returned even if the operation has completed successfully. For + example, a successful response from a server could have been + delayed long enough for the deadline to expire. HTTP Mapping: 504 + Gateway Timeout + - >- + Some requested entity (e.g., file or directory) was not found. + Note to server developers: if a request is denied for an entire + class of users, such as gradual feature rollout or undocumented + allowlist, `NOT_FOUND` may be used. If a request is denied for + some users within a class of users, such as user-based access + control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not + Found + - >- + The entity that a client attempted to create (e.g., file or + directory) already exists. HTTP Mapping: 409 Conflict + - >- + The caller does not have permission to execute the specified + operation. `PERMISSION_DENIED` must not be used for rejections + caused by exhausting some resource (use `RESOURCE_EXHAUSTED` + instead for those errors). `PERMISSION_DENIED` must not be used if + the caller can not be identified (use `UNAUTHENTICATED` instead + for those errors). This error code does not imply the request is + valid or the requested entity exists or satisfies other + pre-conditions. HTTP Mapping: 403 Forbidden + - >- + The request does not have valid authentication credentials for the + operation. HTTP Mapping: 401 Unauthorized + - >- + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. HTTP Mapping: 429 + Too Many Requests + - >- + The operation was rejected because the system is not in a state + required for the operation's execution. For example, the directory + to be deleted is non-empty, an rmdir operation is applied to a + non-directory, etc. Service implementors can use the following + guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and + `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just + the failing call. (b) Use `ABORTED` if the client should retry at + a higher level. For example, when a client-specified test-and-set + fails, indicating the client should restart a read-modify-write + sequence. (c) Use `FAILED_PRECONDITION` if the client should not + retry until the system state has been explicitly fixed. For + example, if an "rmdir" fails because the directory is non-empty, + `FAILED_PRECONDITION` should be returned since the client should + not retry unless the files are deleted from the directory. HTTP + Mapping: 400 Bad Request + - >- + The operation was aborted, typically due to a concurrency issue + such as a sequencer check failure or transaction abort. See the + guidelines above for deciding between `FAILED_PRECONDITION`, + `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + - >- + The operation was attempted past the valid range. E.g., seeking or + reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error + indicates a problem that may be fixed if the system state changes. + For example, a 32-bit file system will generate `INVALID_ARGUMENT` + if asked to read at an offset that is not in the range [0,2^32-1], + but it will generate `OUT_OF_RANGE` if asked to read from an + offset past the current file size. There is a fair bit of overlap + between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend + using `OUT_OF_RANGE` (the more specific error) when it applies so + that callers who are iterating through a space can easily look for + an `OUT_OF_RANGE` error to detect when they are done. HTTP + Mapping: 400 Bad Request + - >- + The operation is not implemented or is not supported/enabled in + this service. HTTP Mapping: 501 Not Implemented + - >- + Internal errors. This means that some invariants expected by the + underlying system have been broken. This error code is reserved + for serious errors. HTTP Mapping: 500 Internal Server Error + - >- + The service is currently unavailable. This is most likely a + transient condition, which can be corrected by retrying with a + backoff. Note that it is not always safe to retry non-idempotent + operations. See the guidelines above for deciding between + `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: + 503 Service Unavailable + - >- + Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal + Server Error + enum: + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS + message: + description: User-friendly error message. type: string - state: + resource: description: >- - Output only. Status of the export job. Valid values include - `enqueued`, `running`, `completed`, and `failed`. + The sub resource specific to this error (e.g. a proxy deployed + within the EnvironmentConfig). If empty the error refers to the top + level resource. type: string - readOnly: true - executionTime: + description: Details on why a resource update failed in the runtime. + type: object + GoogleCloudApigeeV1ProfileConfigCategory: + id: GoogleCloudApigeeV1ProfileConfigCategory + properties: + abuse: description: >- - Output only. Execution time for this export job. If the job is still - in progress, it will be set to the amount of time that has elapsed - since`created`, in seconds. Else, it will set to (`updated` - - `created`), in seconds. - readOnly: true + Checks for abuse, which includes any requests sent to the API for + purposes other than what it is intended for, such as high volumes of + requests, data scraping, and abuse related to authorization. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' + threat: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' + description: Checks to see if you have a threat protection policy in place. + mediation: + description: Checks to see if you have a mediation policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' + mtls: + description: Checks to see if you have configured mTLS for the target server. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' + cors: + description: Checks to see if you have CORS policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' + authorization: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' + description: Checks to see if you have an authorization policy in place. + type: object + description: >- + Advanced API Security provides security profile that scores the + following categories. + GoogleCloudApigeeV1DatastoreConfig: + type: object + properties: + path: + description: Path of Cloud Storage bucket Required for `gcs` target_type. type: string - self: - description: >- - Output only. Self link of the export job. A URI that can be used to - retrieve the status of an export job. Example: - `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + projectId: type: string - readOnly: true - name: + description: Required. GCP project in which the datastore exists + bucketName: type: string - description: Display name of the export job. - datastoreName: - description: >- - Name of the datastore that is the destination of the export job - [datastore] + description: Name of the Cloud Storage bucket. Required for `gcs` target_type. + datasetName: + description: BigQuery dataset name Required for `bigquery` target_type. type: string - error: - description: Output only. Error is set when export fails + tablePrefix: type: string + description: Prefix of BigQuery table Required for `bigquery` target_type. + id: GoogleCloudApigeeV1DatastoreConfig + description: Configuration detail for datastore + GoogleCloudApigeeV1OrganizationProjectMapping: + type: object + properties: + location: readOnly: true - updated: + description: >- + Output only. The Google Cloud region where control plane data is + located. For more information, see + https://cloud.google.com/about/locations/. type: string - readOnly: true - description: Output only. Time the export job was last updated. - GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: - properties: - conflictingDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - description: Existing base path/deployment causing the conflict. - description: - description: Human-readable description of this conflict. + organization: type: string - environmentGroup: - description: Name of the environment group in which this conflict exists. + description: Name of the Apigee organization. + projectId: type: string - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - description: >- - Describes a routing conflict that may cause a deployment not to receive - traffic at some base path. - type: object - GoogleCloudApigeeV1RateRange: - id: GoogleCloudApigeeV1RateRange + description: Google Cloud project associated with the Apigee organization + projectIds: + items: + type: string + type: array + deprecated: true + description: >- + DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a + single project. + id: GoogleCloudApigeeV1OrganizationProjectMapping + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: type: object - description: >- - API call volume range and the fees charged when the total number of API - calls is within the range. + description: The format for a link in the recommendation. + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink properties: - start: + text: + description: 'The text of the url. (ie: "Learn more")' type: string - description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. - format: int64 - fee: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Fee to charge when total number of API calls falls within this - range. - end: + uri: + type: string + description: The link itself. + GoogleCloudApigeeV1Subscription: + id: GoogleCloudApigeeV1Subscription + properties: + name: type: string - format: int64 description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: - description: Request for UpdateAppGroupAppKey - id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + Full name of the Pub/Sub subcription. Use the following structure in + your request: `subscription "projects/foo/subscription/bar"` + description: Pub/Sub subscription of an environment. + type: object + GoogleCloudApigeeV1Score: + id: GoogleCloudApigeeV1Score + type: object + description: Represents Security Score. + properties: + component: + description: Component containing score, recommendations and actions. + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: Start and end time for the score. + subcomponents: + description: List of all the drilldown score components. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + GoogleCloudApigeeV1Credential: properties: + expiresAt: + format: int64 + description: Time the credential will expire in milliseconds since epoch. + type: string + consumerSecret: + description: Secret key. + type: string apiProducts: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + description: List of API products this credential can be used for. + scopes: items: type: string - description: >- - The list of API products that will be associated with the - credential. This list will be appended to the existing list of - associated API Products for this App Key. Duplicates will be - ignored. type: array - appGroupAppKey: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' - description: >- - The new AppGroupKey to be amended. Note that the status can be - updated only via action. - action: description: >- - Approve or revoke the consumer key by setting this value to - `approve` or `revoke` respectively. The `Content-Type` header, if - set, must be set to `application/octet-stream`, with empty body. - type: string - type: object - GoogleCloudApigeeV1AppGroup: - properties: - createdAt: + List of scopes to apply to the app. Specified scopes must already + exist on the API product that you associate with the app. + issuedAt: + description: Time the credential was issued in milliseconds since epoch. type: string format: int64 - readOnly: true - description: Output only. Created time as milliseconds since epoch. - organization: - description: Immutable. the org the app group is created + consumerKey: + description: Consumer key. type: string - channelId: + attributes: + description: List of attributes associated with this credential. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + status: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. type: string - description: channel identifier identifies the owner maintaing this grouping. - lastModifiedAt: + id: GoogleCloudApigeeV1Credential + type: object + GoogleCloudApigeeV1ResourceConfig: + id: GoogleCloudApigeeV1ResourceConfig + type: object + properties: + location: + description: Location of the resource as a URI. type: string - format: int64 - description: Output only. Modified time as milliseconds since epoch. - readOnly: true name: type: string description: >- - Immutable. Name of the AppGroup. Characters you can use in the name - are restricted to: A-Z0-9._\-$ %. - displayName: + Resource name in the following format: + `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` + Only environment-scoped resource files are supported. + GoogleCloudApigeeV1IngressConfig: + id: GoogleCloudApigeeV1IngressConfig + properties: + environmentGroups: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + description: List of environment groups in the organization. + name: type: string - description: app group name displayed in the UI - status: + description: >- + Name of the resource in the following format: + `organizations/{org}/deployedIngressConfig`. + uid: type: string description: >- - Valid values are `active` or `inactive`. Note that the status of the - AppGroup should be updated via UpdateAppGroupRequest by setting the - action as `active` or `inactive`. - channelUri: - description: A reference to the associated storefront/marketplace. + A unique id for the ingress config that will only change if the + organization is deleted and recreated. + revisionCreateTime: + description: Time at which the IngressConfig revision was created. type: string - appGroupId: + format: google-datetime + revisionId: type: string - description: Output only. Internal identifier that cannot be edited - readOnly: true - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: A list of attributes - type: array - id: GoogleCloudApigeeV1AppGroup + description: >- + Revision id that defines the ordering on IngressConfig resources. + The higher the revision, the more recently the configuration was + deployed. + format: int64 type: object + GoogleCloudApigeeV1RuntimeApiSecurityConfig: + properties: + enabled: + type: boolean + description: If the API Security is enabled or not. + id: GoogleCloudApigeeV1RuntimeApiSecurityConfig + type: object + description: Runtime configuration for the API Security add-on. + GoogleCloudApigeeV1Quota: + id: GoogleCloudApigeeV1Quota description: >- - AppGroup contains the request/response fields representing the logical - grouping of apps. Note that appgroup_id, create_time and update_time - cannot be changed by the user, and gets updated by the system. The name - and the organization once provided cannot be edited subsequently. - GoogleCloudApigeeV1APIProductAssociation: - description: >- - APIProductAssociation has the API product and its administrative state - association. + Quota contains the essential parameters needed that can be applied on + the resources, methods, API source combination associated with this API + product. While Quota is optional, setting it prevents requests from + exceeding the provisioned parameters. type: object - id: GoogleCloudApigeeV1APIProductAssociation properties: - status: - type: string + timeUnit: description: >- - The API product credential associated status. Valid values are - `approved` or `revoked`. - apiproduct: + Time unit defined for the `interval`. Valid values include `minute`, + `hour`, `day`, or `month`. If `limit` and `interval` are valid, the + default value is `hour`; otherwise, the default is null. type: string - description: API product to be associated with the credential. - GoogleCloudApigeeV1ListArchiveDeploymentsResponse: - id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse - description: Response for ListArchiveDeployments method. - type: object - properties: - nextPageToken: + interval: type: string description: >- - Page token that you can include in a ListArchiveDeployments request - to retrieve the next page. If omitted, no subsequent pages exist. - archiveDeployments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' - type: array - description: Archive Deployments in the specified environment. - GoogleCloudApigeeV1OASDocumentation: - description: OpenAPI Specification documentation for a catalog item. - properties: - format: - enum: - - FORMAT_UNSPECIFIED - - YAML - - JSON - enumDescriptions: - - The format is not available. - - YAML format. - - JSON format. + Required. Time interval over which the number of request messages is + calculated. + limit: type: string - description: Output only. The format of the input specification file contents. - readOnly: true - spec: description: >- - Required. The documentation file contents for the OpenAPI - Specification. JSON and YAML file formats are supported. - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - id: GoogleCloudApigeeV1OASDocumentation + Required. Upper limit allowed for the time interval and time unit + specified. Requests exceeding this limit will be rejected. + GoogleCloudApigeeV1DisableSecurityActionRequest: + id: GoogleCloudApigeeV1DisableSecurityActionRequest + properties: {} + description: Message to disable an enabled SecurityAction. type: object - GoogleCloudApigeeV1ListAppGroupsResponse: + GoogleCloudApigeeV1ListInstanceAttachmentsResponse: type: object - id: GoogleCloudApigeeV1ListAppGroupsResponse - description: >- - ListAppGroupsResponse contains the 0 or more AppGroups, along with the - optional page token and the total count of apps. + id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse properties: - totalSize: - type: integer - description: Total count of AppGroups. - format: int32 + attachments: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + description: Attachments for the instance. nextPageToken: description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + Page token that you can include in a ListInstanceAttachments request + to retrieve the next page of content. If omitted, no subsequent + pages exist. type: string - appGroups: - description: List of AppGroups. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' - type: array - GoogleCloudApigeeV1SecurityActionDeny: - properties: - responseCode: - format: int32 - type: integer - description: Optional. The HTTP response code if the Action = DENY. + description: Response for ListInstanceAttachments. + GoogleCloudApigeeV1ApiSecurityRuntimeConfig: + id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig type: object - description: Message that should be set in case of a Deny Action. - id: GoogleCloudApigeeV1SecurityActionDeny - GoogleCloudApigeeV1RuntimeConfig: properties: name: description: >- - Name of the resource in the following format: - `organizations/{org}/runtimeConfig`. - type: string - tenantProjectId: - description: >- - Output only. Tenant project ID associated with the Apigee - organization. The tenant project is used to host Google-managed - resources that are dedicated to this Apigee organization. Clients - have limited access to resources within the tenant project used to - support Apigee runtime instances. Access to the tenant project is - managed using SetSyncAuthorization. It can be empty if the tenant - project hasn't been created yet. - type: string - readOnly: true - analyticsBucket: + Name of the environment API Security Runtime configuration resource. + Format: + `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` type: string - description: Cloud Storage bucket used for uploading Analytics records. - traceBucket: + updateTime: + format: google-datetime type: string - description: Cloud Storage bucket used for uploading Trace records. - type: object - id: GoogleCloudApigeeV1RuntimeConfig - description: >- - Runtime configuration for the organization. Response for - GetRuntimeConfig. - GoogleCloudApigeeV1InstanceDeploymentStatus: - properties: - deployedRoutes: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + description: Time that the API Security Runtime configuration was updated. + location: type: array - description: >- - Current routes deployed in the ingress routing table. A route which - is missing will appear in `missing_routes`. - deployedRevisions: + description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision - description: Revisions currently deployed in MPs. - type: array - instance: - description: ID of the instance reporting the status. - type: string - type: object - id: GoogleCloudApigeeV1InstanceDeploymentStatus - description: The status of a deployment as reported by a single instance. - GoogleCloudApigeeV1RuntimeTraceConfig: - type: object - id: GoogleCloudApigeeV1RuntimeTraceConfig - properties: - name: - type: string - description: >- - Name of the trace config in the following format: - `organizations/{org}/environment/{env}/traceConfig` - revisionCreateTime: - type: string - format: google-datetime - description: The timestamp that the revision was created or updated. - samplingConfig: - description: Trace configuration for all API proxies in an environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - exporter: + type: string + uid: description: >- - Exporter that is used to view the distributed trace captured using - OpenCensus. An exporter sends traces to any backend that is capable - of consuming them. Recorded spans can be exported by registered - exporters. - enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE - type: string - enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter - endpoint: + Unique ID for the API Security Runtime configuration. The ID will + only change if the environment is deleted and recreated. type: string - description: Endpoint of the exporter. - overrides: - description: List of trace configuration overrides for spicific API proxies. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' - type: array revisionId: description: >- - Revision number which can be used by the runtime to detect if the - trace config has changed between two versions. + Revision ID of the API Security Runtime configuration. The higher + the value, the more recently the configuration was deployed. type: string + format: int64 description: >- - NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed - trace in an environment. - GoogleCloudApigeeV1GenerateDownloadUrlRequest: + Response for + GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. + GoogleCloudApigeeV1PodStatus: + id: GoogleCloudApigeeV1PodStatus type: object - description: Request for GenerateDownloadUrl method. - properties: {} - id: GoogleCloudApigeeV1GenerateDownloadUrlRequest - GoogleCloudApigeeV1SyncAuthorization: - id: GoogleCloudApigeeV1SyncAuthorization properties: - etag: + deploymentStatus: type: string - format: byte - description: >- - Entity tag (ETag) used for optimistic concurrency control as a way - to help prevent simultaneous updates from overwriting each other. - For example, when you call - [getSyncAuthorization](organizations/getSyncAuthorization) an ETag - is returned in the response. Pass that ETag when calling the - [setSyncAuthorization](organizations/setSyncAuthorization) to ensure - that you are updating the correct version. If you don't pass the - ETag in the call to `setSyncAuthorization`, then the existing - authorization is overwritten indiscriminately. **Note**: We strongly - recommend that you use the ETag in the read-modify-write cycle to - avoid race conditions. - identities: - type: array description: >- - Required. Array of service accounts to grant access to control plane - resources, each specified using the following format: - `serviceAccount:` service-account-name. The service-account-name is - formatted like an email address. For example: - `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` - You might specify multiple service accounts, for example, if you - have multiple environments and wish to assign a unique service - account to each one. The service accounts must have **Apigee - Synchronizer Manager** role. See also [Create service - accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). - items: - type: string - type: object - GoogleCloudApigeeV1CommonNameConfig: - type: object - properties: - name: + Status of the deployment. Valid values include: - `deployed`: + Successful. - `error` : Failed. - `pending` : Pod has not yet + reported on the deployment. + deploymentTime: + format: int64 type: string - matchWildCards: - type: boolean - id: GoogleCloudApigeeV1CommonNameConfig - GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: - id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation - description: Represents a SecurityProfileEnvironmentAssociation resource. - properties: - name: + description: Time the proxy was deployed in milliseconds since epoch. + statusCodeDetails: type: string - description: Immutable. Name of the environment that the profile is attached to. - attachTime: + description: Human-readable message associated with the status code. + appVersion: type: string + description: Version of the application running in the pod. + podStatus: description: >- - Output only. The time when environment was attached to the security - profile. - readOnly: true - format: google-datetime - securityProfileRevisionId: - description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' - deprecated: true + Overall status of the pod (not this specific deployment). Valid + values include: - `active`: Up to date. - `stale` : Recently out of + date. Pods that have not reported status in a long time are excluded + from the output. + type: string + podStatusTime: format: int64 + description: Time the pod status was reported in milliseconds since epoch. type: string + statusCode: + description: Code associated with the deployment status. + type: string + deploymentStatusTime: + description: Time the deployment status was reported in milliseconds since epoch. + format: int64 + type: string + podName: + description: Name of the pod which is reporting the status. + type: string + GoogleCloudApigeeV1OptimizedStats: + properties: + Response: + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' + description: >- + Wraps the `stats` response for JavaScript Optimized Scenario with a + response key. For example: ```{ "Response": { "TimeUnit": [], + "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table + used: edge.api.aaxgroup001.agg_api", "PG + Host:ruappg08-ro.production.apigeeks.net", "query served + by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": + false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" + ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": + "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": + "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` type: object - GoogleIamV1TestIamPermissionsRequest: - type: object + id: GoogleCloudApigeeV1OptimizedStats + GoogleCloudApigeeV1ListAppGroupAppsResponse: + description: Response for ListAppGroupApps properties: - permissions: - type: array - items: - type: string + nextPageToken: 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). - description: Request message for `TestIamPermissions` method. - id: GoogleIamV1TestIamPermissionsRequest - GoogleCloudApigeeV1ReportInstanceStatusResponse: - id: GoogleCloudApigeeV1ReportInstanceStatusResponse - properties: {} - description: Placeholder for future enhancements to status reporting protocol + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + appGroupApps: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + type: array + description: List of AppGroup apps and their credentials. type: object - GoogleCloudApigeeV1DebugSession: + id: GoogleCloudApigeeV1ListAppGroupAppsResponse + GoogleCloudApigeeV1DeveloperSubscription: + description: Structure of a DeveloperSubscription. properties: - filter: + createdAt: + format: int64 type: string description: >- - Optional. A conditional statement which is evaluated against the - request message to determine if it should be traced. Syntax matches - that of on API Proxy bundle flow Condition. - tracesize: - description: >- - Optional. The maximum number of bytes captured from the response - payload. Min = 0, Max = 5120, Default = 5120. - type: integer - format: int32 - name: - type: string - description: A unique ID for this DebugSession. - createTime: + Output only. Time when the API product subscription was created in + milliseconds since epoch. + readOnly: true + lastModifiedAt: readOnly: true - description: >- - Output only. The first transaction creation timestamp, recorded by - UAP. - type: string - format: google-datetime - timeout: - type: string format: int64 description: >- - Optional. The time in seconds after which this DebugSession should - end. This value will override the value in query param, if both are - provided. - count: - format: int32 + Output only. Time when the API product subscription was last + modified in milliseconds since epoch. + type: string + endTime: description: >- - Optional. The number of request to be traced. Min = 1, Max = 15, - Default = 10. - type: integer - validity: - format: int32 - type: integer + Time when the API product subscription ends in milliseconds since + epoch. + format: int64 + type: string + startTime: description: >- - Optional. The length of time, in seconds, that this debug session is - valid, starting from when it's received in the control plane. Min = - 1, Max = 15, Default = 10. - id: GoogleCloudApigeeV1DebugSession - type: object - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: - properties: - text: + Time when the API product subscription starts in milliseconds since + epoch. + format: int64 type: string - description: 'The text of the url. (ie: "Learn more")' - uri: + name: + readOnly: true type: string - description: The link itself. - type: object - description: The format for a link in the recommendation. - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - GoogleCloudApigeeV1SecurityActionAllow: - description: >- - Message that should be set in case of an Allow Action. This does not - have any fields. - properties: {} + description: Output only. Name of the API product subscription. + apiproduct: + type: string + description: >- + Name of the API product for which the developer is purchasing a + subscription. type: object - id: GoogleCloudApigeeV1SecurityActionAllow - GoogleCloudApigeeV1AccessSet: + id: GoogleCloudApigeeV1DeveloperSubscription + GoogleCloudApigeeV1RoutingRule: type: object - id: GoogleCloudApigeeV1AccessSet + id: GoogleCloudApigeeV1RoutingRule properties: - success: - type: boolean - value: + receiver: type: string - name: + description: >- + The resource name of the proxy revision that is receiving this + basepath in the following format: + `organizations/{org}/apis/{api}/revisions/{rev}`. This field is + omitted from the IngressConfig unless the GetDeployedIngressConfig + API is called with view=FULL. + basepath: type: string - description: >- - Set action. For example, "Set" : { "name" : "target.name", "success" : - true, "value" : "default" } - GoogleCloudApigeeV1RuntimeAddonsConfig: - id: GoogleCloudApigeeV1RuntimeAddonsConfig - type: object - properties: - revisionId: - description: Revision number used by the runtime to detect config changes. + description: >- + URI path prefix used to route to the specified environment. May + contain one or more wildcards. For example, path segments consisting + of a single `*` character will match any string. + deploymentGroup: + description: >- + Name of a deployment group in an environment bound to the + environment group in the following format: + `organizations/{org}/environment/{env}/deploymentGroups/{group}` + Only one of environment or deployment_group will be set. type: string - name: + otherTargets: + type: array + items: + type: string description: >- - Name of the addons config in the format: - `organizations/{org}/environments/{env}/addonsConfig` + Conflicting targets, which will be resource names specifying either + deployment groups or environments. + envGroupRevision: + format: int64 type: string - uid: + description: >- + The env group config revision_id when this rule was added or last + updated. This value is set when the rule is created and will only + update if the the environment_id changes. It is used to determine if + the runtime is up to date with respect to this rule. This field is + omitted from the IngressConfig unless the GetDeployedIngressConfig + API is called with view=FULL. + environment: + description: >- + Name of an environment bound to the environment group in the + following format: `organizations/{org}/environments/{env}`. Only one + of environment or deployment_group will be set. + type: string + updateTime: type: string + format: google-datetime description: >- - UID is to detect if config is recreated after deletion. The add-on - config will only be deleted when the environment itself gets - deleted, thus it will always be the same as the UID of - EnvironmentConfig. - apiSecurityConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' - description: Runtime configuration for API Security add-on. - analyticsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' - description: Runtime configuration for Analytics add-on. - description: >- - RuntimeAddonsConfig defines the runtime configurations for add-ons in an - environment. - GoogleCloudApigeeV1CustomReport: - id: GoogleCloudApigeeV1CustomReport + The unix timestamp when this rule was updated. This is updated + whenever env_group_revision is updated. This field is omitted from + the IngressConfig unless the GetDeployedIngressConfig API is called + with view=FULL. + GoogleCloudApigeeV1EndpointAttachment: type: object + description: >- + Apigee endpoint attachment. For more information, see [Southbound + networking patterns] + (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). + id: GoogleCloudApigeeV1EndpointAttachment properties: - environment: - description: Output only. Environment name - type: string + state: readOnly: true - properties: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' - description: This field contains report properties such as ui metadata etc. - type: array - lastModifiedAt: - format: int64 + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING type: string - readOnly: true description: >- - Output only. Modified time of this entity as milliseconds since - epoch. json key: lastModifiedAt - sortOrder: + Output only. State of the endpoint attachment. Values other than + `ACTIVE` mean the resource is not ready to use. + connectionState: + readOnly: true description: >- - Legacy field: not used much. Contains the sort order for the sort - columns - type: string - chartType: - description: This field contains the chart type for the report + Output only. State of the endpoint attachment connection to the + service attachment. + enum: + - CONNECTION_STATE_UNSPECIFIED + - UNAVAILABLE + - PENDING + - ACCEPTED + - REJECTED + - CLOSED + - FROZEN + - NEEDS_ATTENTION type: string + enumDescriptions: + - The connection state has not been set. + - >- + The connection state is unavailable at this time, possibly because + the endpoint attachment is currently being provisioned. + - The connection is pending acceptance by the PSC producer. + - The connection has been accepted by the PSC producer. + - The connection has been rejected by the PSC producer. + - >- + The connection has been closed by the PSC producer and will not + serve traffic going forward. + - >- + The connection has been frozen by the PSC producer and will not + serve traffic. + - >- + The connection has been accepted by the PSC producer, but it is + not ready to serve the traffic due to producer side issues. name: + description: >- + Name of the endpoint attachment. Use the following structure in your + request: + `organizations/{org}/endpointAttachments/{endpoint_attachment}` type: string + host: + readOnly: true description: >- - Required. Unique identifier for the report T his is a legacy field - used to encode custom report unique id - timeUnit: - description: This field contains the time unit of aggregation for the report + Output only. Host that can be used in either the HTTP target + endpoint directly or as the host in target server. type: string - filter: - description: This field contains the filter expression + location: + description: Required. Location of the endpoint attachment. type: string - fromTime: - description: 'Legacy field: not used. Contains the from time for the report' + serviceAttachment: type: string - tags: - type: array + description: 'Format: projects/*/regions/*/serviceAttachments/*' + GoogleCloudApigeeV1GraphQLOperationConfig: + properties: + quota: description: >- - Legacy field: not used. This field contains a list of tags - associated with custom report + Quota parameters to be enforced for the resources, methods, and API + source combination. If none are specified, quota enforcement will + not be done. + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + attributes: items: - type: string - comments: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: Custom attributes associated with the operation. type: array + apiSource: description: >- - Legacy field: not used. This field contains a list of comments - associated with custom report - items: - type: string - offset: - type: string - description: 'Legacy field: not used. This field contains the offset for the data' - limit: - description: >- - Legacy field: not used This field contains the limit for the result - retrieved + Required. Name of the API proxy endpoint or remote service with + which the GraphQL operation and quota are associated. type: string - topk: + operations: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' + type: array description: >- - Legacy field: not used. This field contains the top k parameter - value for restricting the result - type: string - lastViewedAt: - readOnly: true + Required. List of GraphQL name/operation type pairs for the proxy or + remote service to which quota will be applied. If only operation + types are specified, the quota will be applied to all GraphQL + requests irrespective of the GraphQL name. **Note**: Currently, you + can specify only a single GraphQLOperation. Specifying more than one + will cause the operation to fail. + description: >- + Binds the resources in a proxy or remote service with the GraphQL + operation and its associated quota enforcement. + id: GoogleCloudApigeeV1GraphQLOperationConfig + type: object + GoogleCloudApigeeV1GenerateUploadUrlResponse: + type: object + id: GoogleCloudApigeeV1GenerateUploadUrlResponse + description: Response for GenerateUploadUrl method. + properties: + uploadUri: description: >- - Output only. Last viewed time of this entity as milliseconds since - epoch - format: int64 - type: string - toTime: + The Google Cloud Storage signed URL that can be used to upload a new + Archive zip file. type: string - description: 'Legacy field: not used. Contains the end time for the report' - sortByCols: - items: - type: string - type: array - description: 'Legacy field: not used much. Contains the list of sort by columns' - organization: + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: + type: object + description: Route deployed in the ingress routing table. + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + properties: + envgroup: + description: Environment group where this route is installed. type: string - description: Output only. Organization name - readOnly: true - metrics: - type: array - description: Required. This contains the list of metrics - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' - displayName: + percentage: + type: integer + description: Percentage of ingress replicas reporting this route. + format: int32 + environment: type: string - description: This is the display name for the report - createdAt: - format: int64 + description: >- + Destination environment. This will be empty if the route is not yet + reported. + basepath: + description: Base path in the routing table. type: string - readOnly: true - description: 'Output only. Unix time when the app was created json key: createdAt' - dimensions: - items: - type: string - description: This contains the list of dimensions for the report - type: array - GoogleCloudApigeeV1ListApiCategoriesResponse: - description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' - type: object + GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: + description: Tuple representing a base path and the deployment containing it. properties: - errorCode: - description: Unique error code for the request, if any. + apiProxy: type: string - requestId: - description: Unique ID of the request. + description: Name of the deployed API proxy revision containing the base path. + environment: type: string - status: + description: Name of the environment in which the proxy is deployed. + revision: + description: Name of the deployed API proxy revision containing the base path. type: string - description: Status of the operation. - data: - description: The API category resources. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - message: + basepath: type: string - description: Description of the operation. - id: GoogleCloudApigeeV1ListApiCategoriesResponse - GoogleCloudApigeeV1OrganizationProjectMapping: - id: GoogleCloudApigeeV1OrganizationProjectMapping + description: Base path receiving traffic. + type: object + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + GoogleCloudApigeeV1AnalyticsConfig: + id: GoogleCloudApigeeV1AnalyticsConfig properties: - location: + updateTime: + description: Output only. The latest update time. type: string - description: >- - Output only. The Google Cloud region where control plane data is - located. For more information, see - https://cloud.google.com/about/locations/. readOnly: true - organization: + format: google-datetime + enabled: + description: Whether the Analytics add-on is enabled. + type: boolean + expireTimeMillis: + description: >- + Output only. Time at which the Analytics add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. type: string - description: Name of the Apigee organization. - projectId: + format: int64 + readOnly: true + state: + enumDescriptions: + - Default value. + - Add-on is in progress of enabling. + - Add-on is fully enabled and ready to use. + - Add-on is in progress of disabling. + - Add-on is fully disabled. + description: Output only. The state of the Analytics add-on. + enum: + - ADDON_STATE_UNSPECIFIED + - ENABLING + - ENABLED + - DISABLING + - DISABLED + readOnly: true type: string - description: Google Cloud project associated with the Apigee organization - projectIds: - description: >- - DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a - single project. - items: - type: string - type: array - deprecated: true + description: Configuration for the Analytics add-on. type: object - GoogleCloudApigeeV1SchemaSchemaElement: + GoogleProtobufEmpty: + 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: GoogleProtobufEmpty + properties: {} type: object - id: GoogleCloudApigeeV1SchemaSchemaElement - description: Message type for the schema element + GoogleCloudApigeeV1ListTraceConfigOverridesResponse: properties: - properties: + traceConfigOverrides: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + description: List all trace configuration overrides in an environment. + type: array + nextPageToken: description: >- - Properties for the schema field. For example: { "createTime": - "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' - name: + Token value that can be passed as `page_token` to retrieve the next + page of content. type: string - description: Name of the field. - GoogleCloudApigeeV1ProfileConfigCategory: - description: >- - Advanced API Security provides security profile that scores the - following categories. - id: GoogleCloudApigeeV1ProfileConfigCategory type: object + description: Response for ListTraceConfigOverrides. + id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse + GoogleCloudApigeeV1ListExportsResponse: + id: GoogleCloudApigeeV1ListExportsResponse properties: - authorization: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' - description: Checks to see if you have an authorization policy in place. - cors: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' - description: Checks to see if you have CORS policy in place. - mediation: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' - description: Checks to see if you have a mediation policy in place. - mtls: - description: Checks to see if you have configured mTLS for the target server. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' - threat: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' - description: Checks to see if you have a threat protection policy in place. - abuse: - description: >- - Checks for abuse, which includes any requests sent to the API for - purposes other than what it is intended for, such as high volumes of - requests, data scraping, and abuse related to authorization. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' - GoogleCloudApigeeV1DisableSecurityActionRequest: - properties: {} - type: object - id: GoogleCloudApigeeV1DisableSecurityActionRequest - description: Message to disable an enabled SecurityAction. - GoogleCloudApigeeV1ApiCategoryResponse: - id: GoogleCloudApigeeV1ApiCategoryResponse + exports: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + description: Details of the export jobs. + type: array type: object - description: The API category resource wrapped with response status, error_code, etc. + description: The response for ListExports + GoogleCloudApigeeV1Session: + id: GoogleCloudApigeeV1Session properties: - data: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - description: The API category resource. - message: - type: string - description: Description of the operation. - errorCode: - description: Unique error code for the request, if any. + id: type: string - status: - description: Status of the operation. + description: The debug session ID. + timestampMs: + description: >- + The first transaction creation timestamp in millisecond, recorded by + UAP. type: string - requestId: - type: string - description: Unique ID of the request. - GoogleCloudApigeeV1NodeConfig: - description: >- - NodeConfig for setting the min/max number of nodes associated with the - environment. - id: GoogleCloudApigeeV1NodeConfig + format: int64 + type: object + description: Session carries the debug session id and its creation time. + GoogleCloudApigeeV1SecurityReport: + id: GoogleCloudApigeeV1SecurityReport type: object + description: >- + SecurityReport saves all the information about the created security + report. properties: - maxNodeCount: - description: >- - Optional. The maximum total number of gateway nodes that the is - reserved for all instances that has the specified environment. If - not specified, the default is determined by the recommended maximum - number of nodes for that gateway. - type: string - format: int64 - minNodeCount: - format: int64 - description: >- - Optional. The minimum total number of gateway nodes that the is - reserved for all instances that has the specified environment. If - not specified, the default is determined by the recommended minimum - number of nodes for that gateway. + updated: + description: Output only. Last updated timestamp for the query. + readOnly: true type: string - currentAggregateNodeCount: + state: type: string - readOnly: true description: >- - Output only. The current total number of gateway nodes that each - environment currently has across all instances. - format: int64 - GoogleCloudApigeeV1DeveloperBalanceWallet: - description: Wallet used to manage an account balance for a particular currency. - id: GoogleCloudApigeeV1DeveloperBalanceWallet - properties: - lastCreditTime: + Query state could be "enqueued", "running", "completed", "expired" + and "failed". + resultRows: format: int64 - readOnly: true + description: ResultRows is available only after the query is completed. type: string + queryParams: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' description: >- - Output only. Time at which the developer last added credit to the - account in milliseconds since epoch. - balance: - description: >- - Current remaining balance of the developer for a particular - currency. - $ref: '#/components/schemas/GoogleTypeMoney' - type: object - GoogleCloudApigeeV1Quota: - description: >- - Quota contains the essential parameters needed that can be applied on - the resources, methods, API source combination associated with this API - product. While Quota is optional, setting it prevents requests from - exceeding the provisioned parameters. - type: object - properties: - timeUnit: + Contains information like metrics, dimenstions etc of the Security + Report. + envgroupHostname: + type: string + description: Hostname is available only when query is executed at host level. + self: type: string description: >- - Time unit defined for the `interval`. Valid values include `minute`, - `hour`, `day`, or `month`. If `limit` and `interval` are valid, the - default value is `hour`; otherwise, the default is null. - limit: - description: >- - Required. Upper limit allowed for the time interval and time unit - specified. Requests exceeding this limit will be rejected. + Self link of the query. Example: + `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + or following format if query is running at host level: + `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + displayName: + description: Display Name specified by the user. type: string - interval: + reportDefinitionId: type: string - description: >- - Required. Time interval over which the number of request messages is - calculated. - id: GoogleCloudApigeeV1Quota - GoogleCloudApigeeV1AsyncQueryResultView: - type: object - properties: - rows: - type: array - description: >- - Rows of query result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - items: - type: any - code: - description: Error code when there is a failure. - type: integer - format: int32 - metadata: - description: >- - Metadata contains information like metrics, dimenstions etc of the - AsyncQuery. - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' + description: Report Definition ID. error: - description: Error message when there is a failure. + description: Error is set when query fails. type: string - state: + resultFileSize: type: string - description: State of retrieving ResultView. - id: GoogleCloudApigeeV1AsyncQueryResultView - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: - properties: - assessmentTime: - format: google-datetime - description: The time of the assessment api call. + description: ResultFileSize is available only after the query is completed. + executionTime: type: string - nextPageToken: - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is blank, there are no subsequent pages. + description: ExecutionTime is available only after the query is completed. + created: + description: Creation time of the query. type: string - securityAssessmentResults: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' - type: array - description: Default sort order is by resource name in alphabetic order. - type: object - description: Response for BatchComputeSecurityAssessmentResults. - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse - GoogleCloudApigeeV1ListApiDocsResponse: - type: object + result: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' + description: Result is available only after the query is completed. + GoogleCloudApigeeV1GraphQLOperation: + id: GoogleCloudApigeeV1GraphQLOperation + description: >- + Represents the pairing of GraphQL operation types and the GraphQL + operation name. properties: - message: - type: string - description: Description of the operation. - errorCode: - description: Unique error code for the request, if any. - type: string - requestId: + operation: type: string - description: Unique ID of the request. - 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 - data: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - description: The catalog item resources. + GraphQL operation name. The name and operation type will be used to + apply quotas. If no name is specified, the quota will be applied to + all GraphQL operations irrespective of their operation names in the + payload. + operationTypes: type: array - status: - description: Status of the operation. - type: string - id: GoogleCloudApigeeV1ListApiDocsResponse - GoogleCloudApigeeV1KeystoreConfig: - id: GoogleCloudApigeeV1KeystoreConfig - properties: - aliases: - description: Aliases in the keystore. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' - type: array - name: + type: string description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` - type: string + Required. GraphQL operation types. Valid values include `query` or + `mutation`. **Note**: Apigee does not currently support + `subscription` types. type: object - GoogleCloudApigeeV1ListSecurityProfilesResponse: - description: Response for ListSecurityProfiles. + GoogleCloudApigeeV1GenerateUploadUrlRequest: + description: Request for GenerateUploadUrl method. + type: object + id: GoogleCloudApigeeV1GenerateUploadUrlRequest + properties: {} + GoogleCloudApigeeV1Access: type: object - id: GoogleCloudApigeeV1ListSecurityProfilesResponse properties: - securityProfiles: + Remove: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' + Get: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' + Set: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' + id: GoogleCloudApigeeV1Access + GoogleCloudApigeeV1ReportInstanceStatusResponse: + id: GoogleCloudApigeeV1ReportInstanceStatusResponse + type: object + description: Placeholder for future enhancements to status reporting protocol + properties: {} + GoogleCloudApigeeV1StatsEnvironmentStats: + id: GoogleCloudApigeeV1StatsEnvironmentStats + description: >- + Encapsulates the environment wrapper: ``` "environments": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], + "name": "prod" } ]``` + type: object + properties: + dimensions: + description: List of metrics grouped under dimensions. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' type: array + metrics: description: >- - List of security profiles in the organization. The profiles may be - attached or unattached to any environment. This will return latest - revision of each profile. + In the final response, only one of the following fields will be + present based on the dimensions provided. If no dimensions are + provided, then only top-level metrics is provided. If dimensions are + included, then there will be a top-level dimensions field under + environments which will contain metrics values and the dimension + name. Example: ``` "environments": [ { "dimensions": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], + "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": + [ { "metrics": [ { "name": "sum(message_count)", "values": [ + "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' - nextPageToken: - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + type: array + name: type: string - GoogleCloudApigeeV1TraceConfigOverride: - description: A representation of a configuration override. - type: object + description: Name of the environment. + GoogleCloudApigeeV1AccessGet: properties: - apiProxy: + value: type: string - description: >- - ID of the API proxy that will have its trace configuration - overridden. - samplingConfig: - description: Trace configuration to override. - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' name: - description: >- - ID of the trace configuration override specified as a - system-generated UUID. type: string - id: GoogleCloudApigeeV1TraceConfigOverride - GoogleCloudApigeeV1KeyValueMap: + id: GoogleCloudApigeeV1AccessGet + description: >- + Get action. For example, "Get" : { "name" : "target.name", "value" : + "default" } type: object + GoogleCloudApigeeV1Deployment: + id: GoogleCloudApigeeV1Deployment properties: - encrypted: - type: boolean + revision: + type: string + description: API proxy revision. + state: + enum: + - RUNTIME_STATE_UNSPECIFIED + - READY + - PROGRESSING + - ERROR + type: string + enumDescriptions: + - This value should never be returned. + - Runtime has loaded the deployment. + - Deployment is not fully ready in the runtime. + - >- + Encountered an error with the deployment that requires + intervention. description: >- - Required. Flag that specifies whether entry values will be - encrypted. This field is retained for backward compatibility and the - value of encrypted will always be `true`. Apigee X and hybrid do not - support unencrypted key value maps. - name: + Current state of the deployment. **Note**: This field is displayed + only when viewing deployment status. + routeConflicts: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + description: >- + Conflicts in the desired state routing configuration. The presence + of conflicts does not cause the state to be `ERROR`, but it will + mean that some of the deployment's base paths are not routed to its + environment. If the conflicts change, the state will transition to + `PROGRESSING` until the latest configuration is rolled out to all + instances. **Note**: This field is displayed only when viewing + deployment status. + type: array + proxyDeploymentType: + readOnly: true + enum: + - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + description: >- + Output only. The type of the deployment (standard or extensible) + Deployed proxy revision will be marked as extensible in following 2 + cases. 1. The deployed proxy revision uses extensible policies. 2. + If a environment supports flowhooks and flow hook is configured. type: string - description: Required. ID of the key value map. - id: GoogleCloudApigeeV1KeyValueMap - description: Collection of key/value string pairs. - GoogleCloudApigeeV1SetAddonEnablementRequest: - properties: - apiSecurityEnabled: - type: boolean - description: If the API Security should be enabled in the environment. - analyticsEnabled: - type: boolean - description: If the Analytics should be enabled in the environment. - id: GoogleCloudApigeeV1SetAddonEnablementRequest - type: object - description: Request for SetAddonEnablement. - GoogleCloudApigeeV1ListNatAddressesResponse: - properties: - natAddresses: + enumDescriptions: + - >- + Default value till public preview. After public preview this value + should not be returned. + - >- + Deployment will be of type Standard if only Standard proxies are + used + - >- + Proxy will be of type Extensible if deployments uses one or more + Extensible proxies + environment: + description: Environment. + type: string + deployStartTime: + description: >- + Time the API proxy was marked `deployed` in the control plane in + millisconds since epoch. + format: int64 + type: string + instances: + description: >- + Status reported by each runtime instance. **Note**: This field is + displayed only when viewing deployment status. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' type: array - description: List of NAT Addresses for the instance. - nextPageToken: + serviceAccount: + type: string description: >- - Page token that you can include in a ListNatAddresses request to - retrieve the next page of content. If omitted, no subsequent pages - exist. + The full resource name of Cloud IAM Service Account that this + deployment is using, eg, `projects/-/serviceAccounts/{email}`. + pods: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1PodStatus' + type: array + description: >- + Status reported by runtime pods. **Note**: **This field is + deprecated**. Runtime versions 1.3 and above report instance level + status rather than pod status. + apiProxy: type: string - description: Response for ListNatAddresses. - id: GoogleCloudApigeeV1ListNatAddressesResponse + description: API proxy. + errors: + description: >- + Errors reported for this deployment. Populated only when state == + ERROR. **Note**: This field is displayed only when viewing + deployment status. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: object + GoogleCloudApigeeV1SecurityProfileEnvironment: type: object - GoogleCloudApigeeV1OperationMetadataProgress: properties: - percentDone: - type: integer - description: The percentage of the operation progress. - format: int32 - details: - additionalProperties: - description: Properties of the object. - type: any - type: object - description: The additional details of the progress. - description: + environment: + description: Output only. Name of the environment. type: string - description: Description of the operation's progress. - state: - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED - description: State of the operation. + readOnly: true + attachTime: type: string - id: GoogleCloudApigeeV1OperationMetadataProgress + description: >- + Output only. Time at which environment was attached to the security + profile. + format: google-datetime + readOnly: true + description: >- + Environment information of attached environments. Scoring an environment + is enabled only if it is attached to a security profile. + id: GoogleCloudApigeeV1SecurityProfileEnvironment + GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: + properties: + scorePath: + type: string + description: >- + Optional. Return scores for this component. Example: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + description: >- + Filter scores by component path. Used custom filter instead of AIP-160 + as the use cases are highly constrained and predictable. + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter type: object - description: Information about operation progress. - GoogleCloudApigeeV1SecurityActionHttpHeader: + GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange type: object - description: An HTTP header. + description: >- + Describes a potential routing change that may occur as a result of some + deployment operation. properties: - value: + shouldSequenceRollout: + type: boolean + description: >- + Set to `true` if using sequenced rollout would make this routing + change safer. **Note**: This does not necessarily imply that + automated sequenced rollout mode is supported for the operation. + environmentGroup: + description: Name of the environment group affected by this routing change. type: string - description: The header value to be sent to the target. - name: - description: The header name to be sent to the target. + fromDeployment: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: Base path/deployment that may stop receiving some traffic. + description: + description: Human-readable description of this routing change. type: string - id: GoogleCloudApigeeV1SecurityActionHttpHeader - GoogleCloudApigeeV1IntegrationConfig: + toDeployment: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: >- + Base path/deployment that may start receiving that traffic. May be + null if no deployment is able to receive the traffic. + GoogleCloudApigeeV1ListDatastoresResponse: type: object - description: Configuration for the Integration add-on. - id: GoogleCloudApigeeV1IntegrationConfig + id: GoogleCloudApigeeV1ListDatastoresResponse + description: The response for ListDatastores properties: - enabled: - type: boolean - description: Flag that specifies whether the Integration add-on is enabled. - GoogleCloudApigeeV1DateRange: - id: GoogleCloudApigeeV1DateRange - description: Date range of the data to export. + datastores: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + type: array + description: A list of datastores + GoogleCloudApigeeV1AppGroup: + description: >- + AppGroup contains the request/response fields representing the logical + grouping of apps. Note that appgroup_id, create_time and update_time + cannot be changed by the user, and gets updated by the system. The name + and the organization once provided cannot be edited subsequently. properties: - end: + name: + description: >- + Immutable. Name of the AppGroup. Characters you can use in the name + are restricted to: A-Z0-9._\-$ %. + type: string + displayName: + description: app group name displayed in the UI + type: string + status: type: string description: >- - Required. End date (exclusive) of the data to export in the format - `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- - which will not be in the output. - start: - description: >- - Required. Start date of the data to export in the format - `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start - date. - type: string - type: object - GoogleCloudApigeeV1PodStatus: - id: GoogleCloudApigeeV1PodStatus - properties: - statusCode: + Valid values are `active` or `inactive`. Note that the status of the + AppGroup should be updated via UpdateAppGroupRequest by setting the + action as `active` or `inactive`. + appGroupId: type: string - description: Code associated with the deployment status. - appVersion: - description: Version of the application running in the pod. + description: Output only. Internal identifier that cannot be edited + readOnly: true + createdAt: + readOnly: true type: string - deploymentStatusTime: format: int64 + description: Output only. Created time as milliseconds since epoch. + lastModifiedAt: type: string - description: Time the deployment status was reported in milliseconds since epoch. - podStatusTime: format: int64 - description: Time the pod status was reported in milliseconds since epoch. + description: Output only. Modified time as milliseconds since epoch. + readOnly: true + channelUri: + description: A reference to the associated storefront/marketplace. type: string - podName: + channelId: + description: channel identifier identifies the owner maintaing this grouping. type: string - description: Name of the pod which is reporting the status. - statusCodeDetails: - description: Human-readable message associated with the status code. + organization: type: string - deploymentStatus: + description: Immutable. the org the app group is created + attributes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: A list of attributes + id: GoogleCloudApigeeV1AppGroup + type: object + GoogleCloudApigeeV1SchemaSchemaProperty: + type: object + id: GoogleCloudApigeeV1SchemaSchemaProperty + properties: + type: + description: Data type of the field. + type: string + createTime: type: string description: >- - Status of the deployment. Valid values include: - `deployed`: - Successful. - `error` : Failed. - `pending` : Pod has not yet - reported on the deployment. - podStatus: + Time the field was created in RFC3339 string form. For example: + `2016-02-26T10:23:09.592Z`. + custom: description: >- - Overall status of the pod (not this specific deployment). Valid - values include: - `active`: Up to date. - `stale` : Recently out of - date. Pods that have not reported status in a long time are excluded - from the output. - type: string - deploymentTime: + Flag that specifies whether the field is standard in the dataset or + a custom field created by the customer. `true` indicates that it is + a custom field. type: string - description: Time the proxy was deployed in milliseconds since epoch. - format: int64 - type: object - GoogleCloudApigeeV1SetAddonsRequest: - id: GoogleCloudApigeeV1SetAddonsRequest - description: Request for SetAddons. + description: Properties for the schema field. + GoogleCloudApigeeV1DateRange: + id: GoogleCloudApigeeV1DateRange properties: - addonsConfig: - description: Required. Add-on configurations. - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + end: + description: >- + Required. End date (exclusive) of the data to export in the format + `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- + which will not be in the output. + type: string + start: + type: string + description: >- + Required. Start date of the data to export in the format + `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start + date. + description: Date range of the data to export. type: object - GoogleIamV1AuditConfig: - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. + GoogleCloudApigeeV1TraceConfig: type: object - id: GoogleIamV1AuditConfig + id: GoogleCloudApigeeV1TraceConfig properties: - service: + exporter: + enum: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE + description: >- + Required. Exporter that is used to view the distributed trace + captured using OpenCensus. An exporter sends traces to any backend + that is capable of consuming them. Recorded spans can be exported by + registered exporters. + enumDescriptions: + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter + type: string + endpoint: type: string + description: Required. Endpoint of the exporter. + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - GoogleCloudApigeeV1ListSecurityActionsResponse: + Distributed trace configuration for all API proxies in an + environment. You can also override the configuration for a specific + API proxy using the distributed trace configuration overrides API. description: >- - Contains a list of SecurityActions in response to a - ListSecurityActionRequest. - id: GoogleCloudApigeeV1ListSecurityActionsResponse + TraceConfig defines the configurations in an environment of distributed + trace. + GoogleCloudApigeeV1ListKeyValueEntriesResponse: + description: >- + The request structure for listing key value map keys and its + corresponding values. properties: + keyValueEntries: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + description: One or more key value map keys and values. + type: array nextPageToken: - type: string description: >- - A token, which can be sent as `page_token` to retrieve the next + Token that can be sent as `next_page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - securityActions: - description: The SecurityActions for the specified environment. + type: string + type: object + id: GoogleCloudApigeeV1ListKeyValueEntriesResponse + GoogleCloudApigeeV1CertInfo: + type: object + properties: + version: + description: X.509 version. + type: integer + format: int32 + validFrom: + type: string + format: int64 + description: X.509 `notBefore` validity period in milliseconds since epoch. + issuer: + description: X.509 issuer. + type: string + isValid: + type: string + description: >- + Flag that specifies whether the certificate is valid. Flag is set to + `Yes` if the certificate is valid, `No` if expired, or `Not yet` if + not yet valid. + publicKey: + description: Public key component of the X.509 subject public key info. + type: string + subjectAlternativeNames: type: array + description: X.509 subject alternative names (SANs) extension. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' - type: object - GoogleIamV1Policy: - id: GoogleIamV1Policy + type: string + sigAlgName: + type: string + description: X.509 signatureAlgorithm. + serialNumber: + type: string + description: X.509 serial number. + expiryDate: + type: string + format: int64 + description: X.509 `notAfter` validity period in milliseconds since epoch. + subject: + description: X.509 subject. + type: string + basicConstraints: + description: X.509 basic constraints extension. + type: string + description: X.509 certificate as defined in RFC 5280. + id: GoogleCloudApigeeV1CertInfo + GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: + description: Response for ListSecurityProfileRevisions. type: object + id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse properties: - bindings: + securityProfiles: type: array items: - $ref: '#/components/schemas/GoogleIamV1Binding' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - auditConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. - type: array - version: - format: int32 - type: integer + List of security profile revisions. The revisions may be attached or + unattached to any environment. + nextPageToken: + type: string description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - type: string - format: byte - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - GoogleCloudApigeeV1DeploymentChangeReport: - id: GoogleCloudApigeeV1DeploymentChangeReport - type: object - description: >- - Response for GenerateDeployChangeReport and - GenerateUndeployChangeReport. This report contains any validation - failures that would cause the deployment to be rejected, as well changes - and conflicts in routing that may occur due to the new deployment. The - existence of a routing warning does not necessarily imply that the - deployment request is bad, if the desired state of the deployment - request is to effect a routing change. The primary purposes of the - routing messages are: 1) To inform users of routing changes that may - have an effect on traffic currently being routed to other existing - deployments. 2) To warn users if some base path in the proxy will not - receive traffic due to an existing deployment having already claimed - that base path. The presence of routing conflicts/changes will not cause - non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + GoogleCloudApigeeV1QueryTabularStatsRequest: properties: - routingConflicts: - description: All base path conflicts detected for a deployment request. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - validationErrors: - $ref: '#/components/schemas/GoogleRpcPreconditionFailure' + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: Time range for the stats. + pageToken: + description: Identifies a sequence of rows. + type: string + filter: + type: string description: >- - Validation errors that would cause the deployment change request to - be rejected. - routingChanges: - description: All routing changes that may result from a deployment request. + Filter further on specific dimension values. Follows the same + grammar as custom report's filter expressions. Example, apiproxy eq + 'foobar'. + https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters + metrics: type: array + description: Required. List of metrics and their aggregations. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange - GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: - id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' + dimensions: + items: + type: string + description: Required. List of dimension names to group the aggregations by. + type: array + pageSize: + format: int32 + description: Page size represents the number of rows. + type: integer + id: GoogleCloudApigeeV1QueryTabularStatsRequest + type: object + description: >- + Request payload representing the query to be run for fetching security + statistics as rows. + GoogleCloudApigeeV1InstanceAttachment: + id: GoogleCloudApigeeV1InstanceAttachment + description: >- + InstanceAttachment represents the installation of an environment onto an + instance. type: object - description: Action context are all the relevant details for the action. - properties: - documentationLink: - description: Documentation link for the action. - type: string - GoogleCloudApigeeV1SecurityAction: properties: - ttl: - type: string - format: google-duration - description: Input only. The TTL for this SecurityAction. - conditionConfig: - description: >- - Required. A valid SecurityAction must contain at least one - condition. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig - updateTime: - format: google-datetime - description: >- - Output only. The update time for this SecurityAction. This reflects - when this SecurityAction changed states. + name: type: string + description: Output only. ID of the attachment. readOnly: true - createTime: + environment: + description: ID of the attached environment. type: string + createdAt: readOnly: true - description: Output only. The create time for this SecurityAction. - format: google-datetime - deny: - description: Deny a request through if it matches this SecurityAction. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' - allow: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' - description: Allow a request through if it matches this SecurityAction. - state: - description: >- - Required. Only an ENABLED SecurityAction is enforced. An ENABLED - SecurityAction past its expiration time will not be enforced. - enum: - - STATE_UNSPECIFIED - - ENABLED - - DISABLED - type: string - enumDescriptions: - - >- - The default value. This only exists for forward compatibility. A - create request with this value will be rejected. - - >- - An ENABLED SecurityAction is actively enforced if the - `expiration_time` is in the future. - - A disabled SecurityAction is never enforced. - expireTime: - description: The expiration for this SecurityAction. type: string - format: google-datetime - description: description: >- - Optional. An optional user provided description of the - SecurityAction. - type: string + Output only. Time the attachment was created in milliseconds since + epoch. + format: int64 + GoogleCloudApigeeV1SetAddonEnablementRequest: + id: GoogleCloudApigeeV1SetAddonEnablementRequest + type: object + description: Request for SetAddonEnablement. + properties: + apiSecurityEnabled: + type: boolean + description: If the API Security should be enabled in the environment. + analyticsEnabled: + description: If the Analytics should be enabled in the environment. + type: boolean + GoogleCloudApigeeV1StatsHostStats: + id: GoogleCloudApigeeV1StatsHostStats + properties: + dimensions: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' + type: array + description: List of metrics grouped under dimensions. name: type: string - description: >- - Immutable. This field is ignored during creation as per AIP-133. - Please set the `security_action_id` field in the - CreateSecurityActionRequest when creating a new SecurityAction. - Format: - organizations/{org}/environments/{env}/securityActions/{security_action} - flag: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' - description: Flag a request through if it matches this SecurityAction. - apiProxies: + description: Hostname used in query. + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' type: array description: >- - Optional. If unset, this would apply to all proxies in the - environment. If set, this action is enforced only if at least one - proxy in the repeated list is deployed at the time of enforcement. - If set, several restrictions are enforced on SecurityActions. There - can be at most 100 enabled actions with proxies set in an env. - Several other restrictions apply on conditions and are detailed - later. - items: - type: string + In the final response, only one of the following fields will be + present based on the dimensions provided. If no dimensions are + provided, then only the top-level metrics are provided. If + dimensions are included, then there will be a top-level dimensions + field under hostnames which will contain metrics values and the + dimension name. Example: ``` "hosts": [ { "dimensions": [ { + "metrics": [ { "name": "sum(message_count)", "values": [ + "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" + } ]``` OR ```"hosts": [ { "metrics": [ { "name": + "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": + "example.com" } ]``` List of metric values. description: >- - A SecurityAction is rule that can be enforced at an environment level. - The result is one of: - A denied API call - An explicitly allowed API - call - A flagged API call (HTTP headers added before the target receives - it) At least one condition is required to create a SecurityAction. + Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { + "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": + "example.com" } ]``` type: object - id: GoogleCloudApigeeV1SecurityAction - GoogleCloudApigeeV1EndpointAttachment: + GoogleCloudApigeeV1ListAppsResponse: + type: object + id: GoogleCloudApigeeV1ListAppsResponse properties: - location: - description: Required. Location of the endpoint attachment. - type: string - host: - type: string - readOnly: true + nextPageToken: description: >- - Output only. Host that can be used in either the HTTP target - endpoint directly or as the host in target server. - serviceAttachment: + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: 'Format: projects/*/regions/*/serviceAttachments/*' - name: + app: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1App' + type: array + totalSize: + description: Total count of Apps. + format: int32 + type: integer + GoogleCloudApigeeV1ScoreComponent: + properties: + dataCaptureTime: + format: google-datetime description: >- - Name of the endpoint attachment. Use the following structure in your - request: - `organizations/{org}/endpointAttachments/{endpoint_attachment}` + Time in the requested time period when data was last captured to + compute the score. type: string - state: - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. + scorePath: description: >- - Output only. State of the endpoint attachment. Values other than - `ACTIVE` mean the resource is not ready to use. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - readOnly: true + Path of the component. Example: + /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy type: string - connectionState: + recommendations: + description: List of recommendations to improve API security. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation + score: + type: integer + format: int32 + description: Score for the component. + drilldownPaths: + items: + type: string + type: array + description: List of paths for next components. + calculateTime: + description: Time when score was calculated. + format: google-datetime type: string - description: >- - Output only. State of the endpoint attachment connection to the - service attachment. - enum: - - CONNECTION_STATE_UNSPECIFIED - - UNAVAILABLE - - PENDING - - ACCEPTED - - REJECTED - - CLOSED - - FROZEN - - NEEDS_ATTENTION - readOnly: true - enumDescriptions: - - The connection state has not been set. - - >- - The connection state is unavailable at this time, possibly because - the endpoint attachment is currently being provisioned. - - The connection is pending acceptance by the PSC producer. - - The connection has been accepted by the PSC producer. - - The connection has been rejected by the PSC producer. - - >- - The connection has been closed by the PSC producer and will not - serve traffic going forward. - - >- - The connection has been frozen by the PSC producer and will not - serve traffic. - - >- - The connection has been accepted by the PSC producer, but it is - not ready to serve the traffic due to producer side issues. - description: >- - Apigee endpoint attachment. For more information, see [Southbound - networking patterns] - (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). type: object - id: GoogleCloudApigeeV1EndpointAttachment - GoogleCloudApigeeV1RevenueShareRange: + description: Component is an individual security element that is scored. + id: GoogleCloudApigeeV1ScoreComponent + GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence properties: - sharePercentage: - format: double - description: >- - Percentage of the revenue to be shared with the developer. For - example, to share 21 percent of the total revenue with the - developer, set this value to 21. Specify a decimal number with a - maximum of two digits following the decimal point. - type: number - end: - format: int64 - type: string - description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - start: - format: int64 - type: string + points: + items: + type: array + items: + type: any + description: List of points. First value of each inner list is a timestamp. + type: array + dimensions: + type: object + additionalProperties: + type: string description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. - id: GoogleCloudApigeeV1RevenueShareRange - description: >- - API call volume range and the percentage of revenue to share with the - developer when the total number of API calls is within the range. + Map of dimensions and their values that uniquely identifies a time + series sequence. type: object - GoogleCloudApigeeV1CanaryEvaluation: + description: A sequence of time series. + GoogleApiHttpBody: + id: GoogleApiHttpBody properties: - state: - readOnly: true - description: Output only. The current state of the canary evaluation. - enum: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED - type: string - enumDescriptions: - - No state has been specified. - - The canary evaluation is still in progress. - - The canary evaluation has finished. - control: - description: Required. The stable version that is serving requests. - type: string - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. Create time of the canary evaluation. - treatment: - type: string - description: Required. The newer version that is serving requests. - endTime: - type: string - format: google-datetime - description: Required. End time for the evaluation's analysis. - name: - description: Output only. Name of the canary evalution. - readOnly: true - type: string - metricLabels: + contentType: description: >- - Required. Labels used to filter the metrics used for a canary - evaluation. - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' - startTime: - format: google-datetime + The HTTP Content-Type header value specifying the content type of + the body. type: string - description: Required. Start time for the canary evaluation's analysis. - verdict: - enum: - - VERDICT_UNSPECIFIED - - NONE - - FAIL - - PASS - enumDescriptions: - - Verdict is not available yet. - - No verdict reached. - - Evaluation is not good. - - Evaluation is good. + data: + description: The HTTP request/response body as raw binary. type: string + format: byte + extensions: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - Output only. The resulting verdict of the canary evaluations: NONE, - PASS, or FAIL. - readOnly: true + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array type: object - id: GoogleCloudApigeeV1CanaryEvaluation description: >- - CanaryEvaluation represents the canary analysis between two versions of - the runtime that is serving requests. - GoogleCloudApigeeV1ApiProduct: + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + GoogleCloudApigeeV1ProfileConfigCORS: + properties: {} type: object + description: Checks to see if you have CORS policy in place. + id: GoogleCloudApigeeV1ProfileConfigCORS + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest properties: - description: - type: string - description: >- - Description of the API product. Include key information about the - API product that is not captured by other fields. - quotaTimeUnit: + pageSize: + format: int32 + type: integer description: >- - Time unit defined for the `quotaInterval`. Valid values include - `minute`, `hour`, `day`, or `month`. + Optional. The maximum number of results to return. The service may + return fewer than this value. If unspecified, at most 50 results + will be returned. + profile: + type: string + description: Required. Name of the profile that is used for computation. + include: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + description: Include only these resources. + pageToken: type: string - graphqlOperationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' description: >- - Configuration used to group Apigee proxies or remote services with - graphQL operation name, graphQL operation type and quotas. This - grouping allows us to precisely set quota for a particular - combination of graphQL name and operation type for a particular - proxy request. If graphQL name is not set, this would imply quota - will be applied on all graphQL requests matching the operation type. - quotaCounterScope: + Optional. A page token, received from a previous + `BatchComputeSecurityAssessmentResults` call. Provide this to + retrieve the subsequent page. + includeAllResources: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + description: Include all resources under the scope. + scope: description: >- - Scope of the quota decides how the quota counter gets applied and - evaluate for quota violation. If the Scope is set as PROXY, then all - the operations defined for the APIproduct that are associated with - the same proxy will share the same quota counter set at the - APIproduct level, making it a global counter at a proxy level. If - the Scope is set as OPERATION, then each operations get the counter - set at the API product dedicated, making it a local counter. Note - that, the QuotaCounterScope applies only when an operation does not - have dedicated quota set for itself. - enum: - - QUOTA_COUNTER_SCOPE_UNSPECIFIED - - PROXY - - OPERATION + Required. Scope of the resources for the computation. For Apigee, + the environment is the scope of the resources. type: string + type: object + description: Request for BatchComputeSecurityAssessmentResults. + GoogleIamV1AuditLogConfig: + properties: + logType: enumDescriptions: - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), the limits set at product level will be - used as a local counter for quota evaluation by all the - operations, independent of proxy association. - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), set at product level will be used as a - global counter for quota evaluation by all the operations - associated with a particular proxy. - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), the limits set at product level will be - used as a local counter for quota evaluation by all the - operations, independent of proxy association. This behavior mimics - the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED. - quotaInterval: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + type: string + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + description: The log type that this config enables. + exemptedMembers: + items: + type: string + type: array description: >- - Time interval over which the number of request messages is - calculated. + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: object + id: GoogleIamV1AuditLogConfig + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + GoogleCloudApigeeV1EndpointChainingRule: + type: object + properties: + proxyIds: + type: array + items: + type: string + description: List of proxy ids which may be found in the given deployment group. + deploymentGroup: type: string - operationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' description: >- - Configuration used to group Apigee proxies or remote services with - resources, method types, and quotas. The resource refers to the - resource URI (excluding the base path). With this grouping, the API - product creator is able to fine-tune and give precise control over - which REST methods have access to specific resources and how many - calls can be made (using the `quota` setting). **Note:** The - `api_resources` setting cannot be specified for both the API product - and operation group; otherwise the call will fail. + The deployment group to target for cross-shard chaining calls to + these proxies. + id: GoogleCloudApigeeV1EndpointChainingRule + description: >- + EndpointChainingRule specifies the proxies contained in a particular + deployment group, so that other deployment groups can find them in + chaining calls. + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + properties: + link: + description: The link for the recommendation. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink + description: + description: The description of the recommendation. + type: string + type: object + description: The format of the assessment recommendation. + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: + description: Resource for which we are computing security assessment. + properties: + name: + type: string + description: Required. Name of this resource. + type: + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. + type: string + enum: + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY + description: Required. Type of this resource. + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + type: object + EdgeConfigstoreBundleBadBundle: + description: Describes why a bundle is invalid. Intended for use in error details. + type: object + id: EdgeConfigstoreBundleBadBundle + properties: + violations: + type: array + items: + $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' + description: Describes all precondition violations. + GoogleCloudApigeeV1SecurityReportResultMetadata: + properties: + self: + type: string + description: >- + Self link of the query results. Example: + `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + or following format if query is running at host level: + `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + expires: + description: >- + Output only. Expire_time is set to 7 days after report creation. + Query result will be unaccessable after this time. Example: + "2021-05-04T13:38:52-07:00" + readOnly: true + type: string + description: Contains informations about the security report results. + id: GoogleCloudApigeeV1SecurityReportResultMetadata + type: object + GoogleCloudApigeeV1ServiceIssuersMapping: + properties: + service: + description: String indicating the Apigee service name. + type: string + emailIds: + items: + type: string + type: array + description: List of trusted issuer email ids. + type: object + id: GoogleCloudApigeeV1ServiceIssuersMapping + GoogleCloudApigeeV1ApiProduct: + type: object + properties: quota: + type: string description: >- Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours. + lastModifiedAt: + format: int64 + description: >- + Response only. Modified time of this environment as milliseconds + since epoch. type: string + environments: + type: array + items: + type: string + description: >- + Comma-separated list of environment names to which the API product + is bound. Requests to environments that are not listed are rejected. + By specifying one or more environments, you can bind the resources + listed in the API product to a specific environment, preventing + developers from accessing those resources through API proxies + deployed in another environment. This setting is used, for example, + to prevent resources associated with API proxies in `prod` from + being accessed by API proxies deployed in `test`. + scopes: + items: + type: string + description: >- + Comma-separated list of OAuth scopes that are validated at runtime. + Apigee validates that the scopes in any access token presented match + the scopes defined in the OAuth policy associated with the API + product. + type: array attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: >- Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a @@ -3072,8 +2949,21 @@ components: products marked as `private` do not appear on the portal, but can be accessed by external developers. type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + quotaTimeUnit: + description: >- + Time unit defined for the `quotaInterval`. Valid values include + `minute`, `hour`, `day`, or `month`. + type: string + quotaInterval: + type: string + description: >- + Time interval over which the number of request messages is + calculated. + description: + description: >- + Description of the API product. Include key information about the + API product that is not captured by other fields. + type: string grpcOperationGroup: description: >- Optional. Configuration used to group Apigee proxies with gRPC @@ -3083,33 +2973,38 @@ components: applied to all gRPC methods implemented by that proxy for that particular gRPC service. $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationGroup' - name: - type: string - description: >- - Internal name of the API product. Characters you can use in the name - are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name - cannot be edited when updating the API product. - apiResources: + operationGroup: description: >- - Comma-separated list of API resources to be bundled in the API - product. By default, the resource paths are mapped from the - `proxy.pathsuffix` variable. The proxy path suffix is defined as the - URI fragment following the ProxyEndpoint base path. For example, if - the `apiResources` element is defined to be `/forecastrss` and the - base path defined for the API proxy is `/weather`, then only - requests to `/weather/forecastrss` are permitted by the API product. - You can select a specific path, or you can select all subpaths with - the following wildcard: - `/**`: Indicates that all sub-URIs are - included. - `/*` : Indicates that only URIs one level down are - included. By default, / supports the same resources as /** as well - as the base path defined by the API proxy. For example, if the base - path of the API proxy is `/v1/weatherapikey`, then the API product - supports requests to `/v1/weatherapikey` and to any sub-URIs, such - as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, - and so on. For more information, see Managing API products. - type: array - items: - type: string + Configuration used to group Apigee proxies or remote services with + resources, method types, and quotas. The resource refers to the + resource URI (excluding the base path). With this grouping, the API + product creator is able to fine-tune and give precise control over + which REST methods have access to specific resources and how many + calls can be made (using the `quota` setting). **Note:** The + `api_resources` setting cannot be specified for both the API product + and operation group; otherwise the call will fail. + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' + createdAt: + description: >- + Response only. Creation time of this environment as milliseconds + since epoch. + format: int64 + type: string + graphqlOperationGroup: + description: >- + Configuration used to group Apigee proxies or remote services with + graphQL operation name, graphQL operation type and quotas. This + grouping allows us to precisely set quota for a particular + combination of graphQL name and operation type for a particular + proxy request. If graphQL name is not set, this would imply quota + will be applied on all graphQL requests matching the operation type. + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' + name: + type: string + description: >- + Internal name of the API product. Characters you can use in the name + are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name + cannot be edited when updating the API product. approvalType: type: string description: >- @@ -3121,36 +3016,27 @@ components: state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. - environments: + apiResources: + type: array items: type: string - type: array - description: >- - Comma-separated list of environment names to which the API product - is bound. Requests to environments that are not listed are rejected. - By specifying one or more environments, you can bind the resources - listed in the API product to a specific environment, preventing - developers from accessing those resources through API proxies - deployed in another environment. This setting is used, for example, - to prevent resources associated with API proxies in `prod` from - being accessed by API proxies deployed in `test`. - createdAt: - format: int64 - description: >- - Response only. Creation time of this environment as milliseconds - since epoch. - type: string - displayName: - type: string description: >- - Name displayed in the UI or developer portal to developers - registering for API access. - lastModifiedAt: - format: int64 - description: >- - Response only. Modified time of this environment as milliseconds - since epoch. - type: string + Comma-separated list of API resources to be bundled in the API + product. By default, the resource paths are mapped from the + `proxy.pathsuffix` variable. The proxy path suffix is defined as the + URI fragment following the ProxyEndpoint base path. For example, if + the `apiResources` element is defined to be `/forecastrss` and the + base path defined for the API proxy is `/weather`, then only + requests to `/weather/forecastrss` are permitted by the API product. + You can select a specific path, or you can select all subpaths with + the following wildcard: - `/**`: Indicates that all sub-URIs are + included. - `/*` : Indicates that only URIs one level down are + included. By default, / supports the same resources as /** as well + as the base path defined by the API proxy. For example, if the base + path of the API proxy is `/v1/weatherapikey`, then the API product + supports requests to `/v1/weatherapikey` and to any sub-URIs, such + as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, + and so on. For more information, see Managing API products. proxies: description: >- Comma-separated list of API proxy names to which this API product is @@ -3160,5585 +3046,5705 @@ components: requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation. - type: array items: type: string - scopes: type: array + quotaCounterScope: + enumDescriptions: + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), the limits set at product level will be + used as a local counter for quota evaluation by all the + operations, independent of proxy association. + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), set at product level will be used as a + global counter for quota evaluation by all the operations + associated with a particular proxy. + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), the limits set at product level will be + used as a local counter for quota evaluation by all the + operations, independent of proxy association. This behavior mimics + the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED. + enum: + - QUOTA_COUNTER_SCOPE_UNSPECIFIED + - PROXY + - OPERATION + type: string description: >- - Comma-separated list of OAuth scopes that are validated at runtime. - Apigee validates that the scopes in any access token presented match - the scopes defined in the OAuth policy associated with the API - product. - items: - type: string - id: GoogleCloudApigeeV1ApiProduct - GoogleCloudApigeeV1ApiSecurityConfig: - description: Configurations of the API Security add-on. - properties: - expiresAt: + Scope of the quota decides how the quota counter gets applied and + evaluate for quota violation. If the Scope is set as PROXY, then all + the operations defined for the APIproduct that are associated with + the same proxy will share the same quota counter set at the + APIproduct level, making it a global counter at a proxy level. If + the Scope is set as OPERATION, then each operations get the counter + set at the API product dedicated, making it a local counter. Note + that, the QuotaCounterScope applies only when an operation does not + have dedicated quota set for itself. + displayName: type: string description: >- - Output only. Time at which the API Security add-on expires in in - milliseconds since epoch. If unspecified, the add-on will never - expire. - format: int64 - readOnly: true - enabled: - type: boolean - description: Flag that specifies whether the API security add-on is enabled. - type: object - id: GoogleCloudApigeeV1ApiSecurityConfig - GoogleTypeExpr: + Name displayed in the UI or developer portal to developers + registering for API access. + id: GoogleCloudApigeeV1ApiProduct + GoogleCloudApigeeV1EnvironmentGroup: description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - id: GoogleTypeExpr + EnvironmentGroup configuration. An environment group is used to group + one or more Apigee environments under a single host name. + id: GoogleCloudApigeeV1EnvironmentGroup + type: object properties: - title: + lastModifiedAt: type: string description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - expression: + Output only. The time at which the environment group was last + updated as milliseconds since epoch. + readOnly: true + format: int64 + name: + description: ID of the environment group. type: string + hostnames: + type: array + items: + type: string + description: Required. Host names for this environment group. + createdAt: + format: int64 description: >- - Textual representation of an expression in Common Expression - Language syntax. - description: + Output only. The time at which the environment group was created as + milliseconds since epoch. type: string + readOnly: true + state: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - location: - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. + Output only. State of the environment group. Values other than + ACTIVE means the resource is not ready to use. type: string - type: object - GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + readOnly: true + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + GoogleCloudApigeeV1Organization: type: object properties: - nextStartKey: + subscriptionType: type: string + readOnly: true description: >- - Value that can be sent as `startKey` to retrieve the next page of - content. If this field is omitted, there are no subsequent pages. - developerSubscriptions: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' - type: array - description: List of all subscriptions. - description: Response for ListDeveloperSubscriptions. - id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse - GoogleCloudApigeeV1OptimizedStatsNode: - description: >- - Encapsulates a data node as represented below: ``` { "identifier": { - "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": - "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` - { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` - Depending on whether a dimension is present in the query or not the data - node type can be a simple metric value or dimension identifier with list - of metrics. - type: object - properties: - data: - type: array - items: - type: any - id: GoogleCloudApigeeV1OptimizedStatsNode - GoogleCloudApigeeV1QueryTabularStatsResponse: - properties: - columns: - type: array - items: - type: string - description: >- - Column names corresponding to the same order as the inner values in - the stats field. - nextPageToken: - description: Next page token. - type: string - values: - description: Resultant rows from the executed query. - items: - type: array - items: - type: any - type: array - description: >- - Encapsulates two kinds of stats that are results of the dimensions and - aggregations requested. - Tabular rows. - Time series data. Example of - tabular rows, Represents security stats results as a row of flat values. - type: object - id: GoogleCloudApigeeV1QueryTabularStatsResponse - GoogleCloudApigeeV1ListInstancesResponse: - description: Response for ListInstances. - id: GoogleCloudApigeeV1ListInstancesResponse - properties: - nextPageToken: - type: string - description: >- - Page token that you can include in a ListInstance request to - retrieve the next page of content. If omitted, no subsequent pages - exist. - instances: - description: Instances in the specified organization. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' - type: array - type: object - GoogleCloudApigeeV1AccessLoggingConfig: - type: object - description: >- - Access logging configuration enables customers to ship the access logs - from the tenant projects to their own project's cloud logging. The - feature is at the instance level ad disabled by default. It can be - enabled during CreateInstance or UpdateInstance. - id: GoogleCloudApigeeV1AccessLoggingConfig - properties: - enabled: - description: >- - Optional. Boolean flag that specifies whether the customer access - log feature is enabled. - type: boolean - filter: - description: >- - Optional. Ship the access log entries that match the status_code - defined in the filter. The status_code is the only - expected/supported filter field. (Ex: status_code) The filter will - parse it to the Common Expression Language semantics for expression - evaluation to build the filter condition. (Ex: "filter": status_code - >= 200 && status_code < 300 ) - type: string - GoogleCloudApigeeV1DeveloperApp: - type: object - id: GoogleCloudApigeeV1DeveloperApp - properties: - apiProducts: - description: List of API products associated with the developer app. - items: - type: string - type: array - createdAt: - description: >- - Output only. Time the developer app was created in milliseconds - since epoch. - format: int64 + Output only. DEPRECATED: This will eventually be replaced by + BillingType. Subscription type of the Apigee organization. Valid + values include trial (free, limited, and for evaluation purposes + only) or paid (full subscription has been purchased). See [Apigee + pricing](https://cloud.google.com/apigee/pricing/). + enumDescriptions: + - Subscription type not specified. + - Full subscription to Apigee has been purchased. + - >- + Subscription to Apigee is free, limited, and used for evaluation + purposes only. + deprecated: true + enum: + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAID + - TRIAL + name: readOnly: true type: string - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - description: List of attributes for the developer app. - credentials: - description: >- - Output only. Set of credentials for the developer app consisting of - the consumer key/secret pairs associated with the API products. - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - type: array - appId: + description: Output only. Name of the Apigee organization. + customerName: + description: Not used by Apigee. type: string - description: ID of the developer app. - appFamily: + type: type: string - description: Developer app family. + enum: + - TYPE_UNSPECIFIED + - TYPE_TRIAL + - TYPE_PAID + - TYPE_INTERNAL + description: Not used by Apigee. + enumDescriptions: + - Subscription type not specified. + - >- + Subscription to Apigee is free, limited, and used for evaluation + purposes only. + - >- + Full subscription to Apigee has been purchased. See [Apigee + pricing](https://cloud.google.com/apigee/pricing/). + - For internal users only. lastModifiedAt: + description: >- + Output only. Time that the Apigee organization was last modified in + milliseconds since epoch. + type: string readOnly: true format: int64 + apiConsumerDataLocation: description: >- - Output only. Time the developer app was modified in milliseconds - since epoch. + This field is needed only for customers using non-default data + residency regions. Apigee stores some control plane data only in + single region. This field determines which single region Apigee + should use. For example: "us-west1" when control plane is in US or + "europe-west2" when control plane is in EU. type: string - callbackUrl: + disableVpcPeering: + type: boolean + description: >- + Optional. Flag that specifies whether the VPC Peering through + Private Google Access should be disabled between the consumer + network and Apigee. Valid only when RuntimeType is set to CLOUD. + Required if an authorizedNetwork on the consumer project is not + provided, in which case the flag should be set to true. The value + must be set before the creation of any Apigee runtime instance and + can be updated only when there are no runtime instances. **Note:** + Apigee will be deprecating the vpc peering model that requires you + to provide 'authorizedNetwork', by making the non-peering model as + the default way of provisioning Apigee organization in future. So, + this will be a temporary flag to enable the transition. Not + supported for Apigee hybrid. + description: type: string + description: Description of the Apigee organization. + displayName: description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to developer apps. - developerId: + Display name for the Apigee organization. Unused, but reserved for + future use. type: string - description: ID of the developer. - keyExpiresIn: + analyticsRegion: type: string description: >- - Expiration time, in milliseconds, for the consumer key that is - generated for the developer app. If not set or left to the default - value of `-1`, the API key never expires. The expiration time can't - be updated after it is set. - format: int64 - scopes: + Required. DEPRECATED: This field will eventually be deprecated and + replaced with a differently-named field. Primary Google Cloud region + for analytics data storage. For valid values, see [Create an Apigee + organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + deprecated: true + properties: + description: Properties defined in the Apigee organization profile. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + attributes: + description: Not used by Apigee. + type: array items: type: string - type: array + runtimeType: + enumDescriptions: + - Runtime type not specified. + - Google-managed Apigee runtime. + - User-managed Apigee hybrid runtime. + enum: + - RUNTIME_TYPE_UNSPECIFIED + - CLOUD + - HYBRID description: >- - Scopes to apply to the developer app. The specified scopes must - already exist for the API product that you associate with the - developer app. - name: + Required. Runtime type of the Apigee organization based on the + Apigee subscription purchased. type: string - description: Name of the developer app. - status: - description: >- - Status of the credential. Valid values include `approved` or - `revoked`. + apigeeProjectId: type: string - GoogleCloudApigeeV1DataCollector: - type: object - properties: - name: + readOnly: true + description: >- + Output only. Apigee Project ID associated with the organization. Use + this project to allowlist Apigee in the Service Attachment when + using private service connect with Apigee. + apiConsumerDataEncryptionKeyName: + description: >- + Cloud KMS key name used for encrypting API consumer data. If not + specified or [BillingType](#BillingType) is `EVALUATION`, a + Google-Managed encryption key will be used. Format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*` type: string - description: ID of the data collector. Must begin with `dc_`. - type: + subscriptionPlan: enumDescriptions: - - For future compatibility. - - For integer values. - - For float values. - - For string values. - - For boolean values. - - For datetime values. - type: string + - Subscription plan not specified. + - Traditional subscription plan. + - >- + New subscription plan that provides standard proxy and scaled + proxy implementation. + readOnly: true enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME - description: Immutable. The type of data this data collector will collect. - lastModifiedAt: + - SUBSCRIPTION_PLAN_UNSPECIFIED + - SUBSCRIPTION_2021 + - SUBSCRIPTION_2024 type: string - readOnly: true description: >- - Output only. The time at which the Data Collector was last updated - in milliseconds since the epoch. - format: int64 - description: - description: A description of the data collector. - type: string - createdAt: - format: int64 - description: >- - Output only. The time at which the data collector was created in - milliseconds since the epoch. + Output only. Subscription plan that the customer has purchased. + Output only. + projectId: type: string readOnly: true - description: Data collector configuration. - id: GoogleCloudApigeeV1DataCollector - GoogleCloudApigeeV1GrpcOperationGroup: - type: object - properties: - operationConfigs: + description: Output only. Project ID associated with the Apigee organization. + authorizedNetwork: + type: string description: >- - Required. List of operation configurations for either Apigee API - proxies that are associated with this API product. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' - type: array - id: GoogleCloudApigeeV1GrpcOperationGroup - description: >- - List of gRPC operation configuration details associated with Apigee API - proxies. - GoogleCloudApigeeV1StatsEnvironmentStats: - properties: - name: - description: Name of the environment. + Compute Engine network used for Service Networking to be peered with + Apigee runtime instances. See [Getting started with the Service + Networking + API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). + Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The + value must be set before the creation of a runtime instance and can + be updated only when there are no runtime instances. For example: + `default`. Apigee also supports shared VPC (that is, the host + network project is not the same as the one that is peering with + Apigee). See [Shared VPC + overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a + shared VPC network, use the following format: + `projects/{host-project-id}/{region}/networks/{network-name}`. For + example: `projects/my-sharedvpc-host/global/networks/mynetwork` + **Note:** Not supported for Apigee hybrid. + addonsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + description: Addon configurations of the Apigee organization. + controlPlaneEncryptionKeyName: type: string - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - type: array description: >- - In the final response, only one of the following fields will be - present based on the dimensions provided. If no dimensions are - provided, then only top-level metrics is provided. If dimensions are - included, then there will be a top-level dimensions field under - environments which will contain metrics values and the dimension - name. Example: ``` "environments": [ { "dimensions": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], - "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": - [ { "metrics": [ { "name": "sum(message_count)", "values": [ - "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values. - dimensions: - description: List of metrics grouped under dimensions. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - type: object - id: GoogleCloudApigeeV1StatsEnvironmentStats - description: >- - Encapsulates the environment wrapper: ``` "environments": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], - "name": "prod" } ]``` - GoogleCloudApigeeV1TlsInfoConfig: - type: object - id: GoogleCloudApigeeV1TlsInfoConfig - properties: - protocols: - items: - type: string - description: List of TLS protocols that are granted access. - type: array - enabled: + Cloud KMS key name used for encrypting control plane data that is + stored in a multi region. Only used for the data residency region + "US" or "EU". If not specified or [BillingType](#BillingType) is + `EVALUATION`, a Google-Managed encryption key will be used. Format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*` + caCertificate: + type: string description: >- - Flag that specifies whether one-way TLS is enabled. Set to `true` to - enable one-way TLS. - type: boolean - enforce: - type: boolean - description: Flag that enforces TLS settings - commonName: - description: Common name to validate the target server against. - $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' - ciphers: + Output only. Base64-encoded public certificate for the root CA of + the Apigee organization. Valid only when [RuntimeType](#RuntimeType) + is `CLOUD`. + readOnly: true + format: byte + environments: + description: Output only. List of environments in the Apigee organization. + readOnly: true type: array - description: List of ciphers that are granted access. items: type: string - ignoreValidationErrors: + portalDisabled: type: boolean - description: >- - Flag that specifies whether to ignore TLS certificate validation - errors. Set to `true` to ignore errors. - keyAlias: + description: Configuration for the Portals settings. + billingType: type: string + enum: + - BILLING_TYPE_UNSPECIFIED + - SUBSCRIPTION + - EVALUATION + - PAYG description: >- - Name of the alias used for client-side authentication in the - following format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` - clientAuthEnabled: + Billing type of the Apigee organization. See [Apigee + pricing](https://cloud.google.com/apigee/pricing). + enumDescriptions: + - Billing type not specified. + - A pre-paid subscription to Apigee. + - Free and limited access to Apigee for evaluation purposes only. + - Access to Apigee using a Pay-As-You-Go plan. + state: + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + type: string + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING description: >- - Flag that specifies whether client-side authentication is enabled - for the target server. Enables two-way TLS. - type: boolean - trustStore: + Output only. State of the organization. Values other than ACTIVE + means the resource is not ready to use. + readOnly: true + expiresAt: + readOnly: true description: >- - Name of the keystore or keystore reference containing trusted - certificates for the server in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` or - `organizations/{org}/environments/{env}/references/{reference}` + Output only. Time that the Apigee organization is scheduled for + deletion. + format: int64 type: string - keyAliasReference: - description: Reference name and alias pair to use for client-side authentication. - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' - GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse - properties: - values: - description: Results of the query returned as a JSON array. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - type: array - columns: - items: - type: string + createdAt: + format: int64 + type: string + readOnly: true description: >- - Column names corresponding to the same order as the inner values in - the stats field. - type: array - nextPageToken: + Output only. Time that the Apigee organization was created in + milliseconds since epoch. + runtimeDatabaseEncryptionKeyName: type: string - description: Next page token. - type: object - description: >- - Represents security stats result as a collection of time series - sequences. - GoogleCloudApigeeV1ListOfDevelopersResponse: - id: GoogleCloudApigeeV1ListOfDevelopersResponse - properties: - developer: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' - description: List of developers. - type: object - GoogleCloudApigeeV1ApiProductRef: + description: >- + Cloud KMS key name used for encrypting the data that is stored and + replicated across runtime instances. Update is not allowed after the + organization is created. If not specified or + [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption + key will be used. For example: + "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** + Not supported for Apigee hybrid. + id: GoogleCloudApigeeV1Organization + GoogleCloudApigeeV1DataCollectorConfig: properties: - apiproduct: - type: string - description: Name of the API product. - status: - description: Status of the API product. Valid values are `approved` or `revoked`. + type: type: string - type: object - id: GoogleCloudApigeeV1ApiProductRef - GoogleCloudApigeeV1AccessGet: - properties: + description: Data type accepted by the data collector. + enumDescriptions: + - For future compatibility. + - For integer values. + - For float values. + - For string values. + - For boolean values. + - For datetime values. + enum: + - TYPE_UNSPECIFIED + - INTEGER + - FLOAT + - STRING + - BOOLEAN + - DATETIME name: + description: >- + Name of the data collector in the following format: + `organizations/{org}/datacollectors/{datacollector}` type: string - value: - type: string - id: GoogleCloudApigeeV1AccessGet - description: >- - Get action. For example, "Get" : { "name" : "target.name", "value" : - "default" } - type: object - GoogleCloudApigeeV1ServiceIssuersMapping: - id: GoogleCloudApigeeV1ServiceIssuersMapping type: object + id: GoogleCloudApigeeV1DataCollectorConfig + description: Data collector and its configuration. + GoogleCloudApigeeV1SecurityActionConditionConfig: properties: - service: - type: string - description: String indicating the Apigee service name. - emailIds: - type: array + apiKeys: items: type: string - description: List of trusted issuer email ids. - GoogleCloudApigeeV1ListCustomReportsResponse: - type: object - description: This message encapsulates a list of custom report definitions - id: GoogleCloudApigeeV1ListCustomReportsResponse - properties: - qualifier: + description: Optional. A list of API keys. Limit 1000 per action. + type: array + httpMethods: + type: array + description: >- + Optional. Act only on particular HTTP methods. E.g. A read-only API + can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, + POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + type: string + developers: + description: Optional. A list of developers. Limit 1000 per action. + items: + type: string + type: array + apiProducts: + description: Optional. A list of API Products. Limit 1000 per action. type: array - GoogleCloudApigeeV1OptimizedStatsResponse: - type: object - id: GoogleCloudApigeeV1OptimizedStatsResponse - description: Encapsulates a response format for JavaScript Optimized Scenario. - properties: - TimeUnit: items: - format: int64 type: string - description: >- - List of time unit values. Time unit refers to an epoch timestamp - value. + ipAddressRanges: type: array - resultTruncated: - type: boolean description: >- - Boolean flag that indicates whether the results were truncated based - on the limit parameter. - stats: - description: '`stats` results.' - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - description: Metadata information about the query executed. - GoogleCloudApigeeV1ArchiveDeployment: - id: GoogleCloudApigeeV1ArchiveDeployment - properties: - operation: + Optional. A list of IP addresses. This could be either IPv4 or IPv6. + Limited to 100 per action. + items: + type: string + botReasons: + type: array description: >- - Output only. A reference to the LRO that created this Archive - Deployment in the following format: - `organizations/{org}/operations/{id}` - type: string - readOnly: true - updatedAt: - readOnly: true - format: int64 - type: string + Optional. A list of Bot Reasons. Current options: Flooder, Brute + Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, + TorListRule, Advanced Anomaly Detection, Advanced API Scraper, + Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public + Cloud Azure, and Public Cloud Google. + items: + type: string + asns: + items: + format: int64 + type: string description: >- - Output only. The time at which the Archive Deployment was updated in - milliseconds since the epoch. - labels: + Optional. A list of ASN numbers to act on, e.g. 23. + https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses + int64 instead of uint32 because of + https://linter.aip.dev/141/forbidden-types. + type: array + developerApps: + items: + type: string + type: array + description: Optional. A list of developer apps. Limit 1000 per action. + regionCodes: + type: array description: >- - User-supplied key-value pairs used to organize ArchiveDeployments. - Label keys must be between 1 and 63 characters long, have a UTF-8 - encoding of maximum 128 bytes, and must conform to the following - PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be - between 1 and 63 characters long, have a UTF-8 encoding of maximum - 128 bytes, and must conform to the following PCRE regular - expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can - be associated with a given store. - type: object - additionalProperties: + Optional. A list of countries/region codes to act on, e.g. US. This + follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. + items: type: string - createdAt: - format: int64 + accessTokens: + type: array + description: Optional. A list of access_tokens. Limit 1000 per action. + items: + type: string + userAgents: description: >- - Output only. The time at which the Archive Deployment was created in - milliseconds since the epoch. - readOnly: true + Optional. A list of user agents to deny. We look for exact matches. + Limit 50 per action. + items: + type: string + type: array + id: GoogleCloudApigeeV1SecurityActionConditionConfig + description: >- + The following are a list of conditions. A valid SecurityAction must + contain at least one condition. Within a condition, each element is + ORed. Across conditions elements are ANDed. For example if a + SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and + bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: + enforce the action if the incoming request has ((ip_address_ranges = + "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR + bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges + and bot_reasons cannot be ANDed. + type: object + GoogleCloudApigeeV1Operation: + properties: + resource: type: string - name: description: >- - Name of the Archive Deployment in the following format: - `organizations/{org}/environments/{env}/archiveDeployments/{id}`. - type: string - gcsUri: - type: string + Required. REST resource path associated with the API proxy or remote + service. + methods: description: >- - Input only. The Google Cloud Storage signed URL returned from - GenerateUploadUrl and used to upload the Archive zip file. - description: Archive Deployment information. - type: object - GoogleCloudApigeeV1AccessRemove: + methods refers to the REST verbs as in + https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none + specified, all verb types are allowed. + items: + type: string + type: array + id: GoogleCloudApigeeV1Operation type: object - properties: - name: - type: string - success: - type: boolean - id: GoogleCloudApigeeV1AccessRemove description: >- - Remove action. For example, "Remove" : { "name" : "target.name", - "success" : true } - GoogleCloudApigeeV1SecurityReportQuery: - description: Body structure when user makes a request to create a security report. + Represents the pairing of REST resource path and the actions (verbs) + allowed on the resource path. + GoogleCloudApigeeV1Result: properties: - groupByTimeUnit: - type: string - description: >- - Time unit used to group the result set. Valid values include: - second, minute, hour, day, week, or month. If a query includes - groupByTimeUnit, then the result is an aggregation based on the - specified time unit and the resultant timestamp does not include - milliseconds precision. If a query omits groupByTimeUnit, then the - resultant timestamp includes milliseconds precision. - limit: - format: int32 - description: Maximum number of rows that can be returned in the result. - type: integer - reportDefinitionId: - description: Report Definition ID. + properties: + description: Name value pairs used for DebugInfo ActionResult. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + reasonPhrase: + description: HTTP response phrase type: string - envgroupHostname: - description: >- - Hostname needs to be specified if query intends to run at host - level. This field is only allowed when query is submitted by - CreateHostSecurityReport where analytics data will be grouped by - organization and hostname. + verb: + description: HTTP method verb type: string - displayName: - description: Security Report display name which users can specify. + content: type: string - metrics: - type: array - description: A list of Metrics. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' - dimensions: + description: >- + Error message content. for example, "content" : + "{\"fault\":{\"faultstring\":\"API timed + out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" + headers: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + A list of HTTP headers. for example, '"headers" : [ { "name" : + "Content-Length", "value" : "83" }, { "name" : "Content-Type", + "value" : "application/json" } ]' type: array - csvDelimiter: - type: string - description: >- - Delimiter used in the CSV file, if `outputFormat` is set to `csv`. - Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - timeRange: + ActionResult: description: >- - Required. Time range for the query. Can use the following predefined - strings to specify the time range: `last60minutes` `last24hours` - `last7days` Or, specify the timeRange as a structure describing - start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": - "2018-08-01T00:18:00Z" } - type: any - filter: + Type of the action result. Can be one of the five: DebugInfo, + RequestMessage, ResponseMessage, ErrorMessage, VariableAccess type: string + timestamp: description: >- - Boolean expression that can be used to filter data. Filter - expressions can be combined using AND/OR terms and should be fully - parenthesized to avoid ambiguity. See Analytics metrics, dimensions, - and filters reference - https://docs.apigee.com/api-platform/analytics/analytics-reference - for more information on the fields available to filter on. For more - information on the tokens that you use to build filter expressions, - see Filter expression syntax. - https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax - mimeType: + Timestamp of when the result is recorded. Its format is dd-mm-yy + hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` type: string + accessList: description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. - type: object - id: GoogleCloudApigeeV1SecurityReportQuery - GoogleCloudApigeeV1RuntimeAnalyticsConfig: - id: GoogleCloudApigeeV1RuntimeAnalyticsConfig - description: Runtime configuration for the Analytics add-on. + A list of variable access actions agaist the api proxy. Supported + values: Get, Set, Remove. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Access' + uRI: + description: >- + The relative path of the api proxy. for example, `"uRI" : + "/iloveapis"` + type: string + statusCode: + type: string + description: HTTP response code + description: >- + Result is short for "action result", could be different types identified + by "action_result" field. Supported types: 1. DebugInfo : generic debug + info collected by runtime recorded as a list of properties. For example, + the contents could be virtual host info, state change result, or + execution metadata. Required fields : properties, timestamp 2. + RequestMessage: information of a http request. Contains headers, request + URI and http methods type.Required fields : headers, uri, verb 3. + ResponseMessage: information of a http response. Contains headers, + reason phrase and http status code. Required fields : headers, + reasonPhrase, statusCode 4. ErrorMessage: information of a http error + message. Contains detail error message, reason phrase and status code. + Required fields : content, headers, reasonPhrase, statusCode 5. + VariableAccess: a list of variable access actions, can be Get, Set and + Remove. Required fields : accessList type: object + id: GoogleCloudApigeeV1Result + GoogleCloudApigeeV1ListNatAddressesResponse: + type: object + description: Response for ListNatAddresses. properties: - billingPipelineEnabled: - type: boolean - description: If Runtime should send billing data to AX or not. - enabled: - type: boolean - description: If the Analytics is enabled or not. - GoogleCloudApigeeV1ListDataCollectorsResponse: - properties: - dataCollectors: + natAddresses: type: array - description: Data collectors in the specified organization. + description: List of NAT Addresses for the instance. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' nextPageToken: - type: string description: >- - Page token that you can include in a ListDataCollectors request to - retrieve the next page. If omitted, no subsequent pages exist. - description: Response for ListDataCollectors. - type: object - id: GoogleCloudApigeeV1ListDataCollectorsResponse - GoogleCloudApigeeV1ResourceConfig: - id: GoogleCloudApigeeV1ResourceConfig + Page token that you can include in a ListNatAddresses request to + retrieve the next page of content. If omitted, no subsequent pages + exist. + type: string + id: GoogleCloudApigeeV1ListNatAddressesResponse + GoogleCloudApigeeV1ApiProductRef: type: object properties: - location: - description: Location of the resource as a URI. + status: + description: Status of the API product. Valid values are `approved` or `revoked`. type: string - name: + apiproduct: type: string - description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` - Only environment-scoped resource files are supported. - GoogleCloudApigeeV1AliasRevisionConfig: - id: GoogleCloudApigeeV1AliasRevisionConfig + description: Name of the API product. + id: GoogleCloudApigeeV1ApiProductRef + GoogleCloudApigeeV1Reference: properties: - location: + description: type: string - description: Location of the alias file. For example, a Google Cloud Storage URI. + description: Optional. A human-readable description of this reference. name: type: string description: >- - Name of the alias revision included in the keystore in the following - format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}` - type: - enumDescriptions: - - Alias type is not specified. - - Certificate. - - Key/certificate pair. - type: string - enum: - - ALIAS_TYPE_UNSPECIFIED - - CERT - - KEY_CERT - type: object - GoogleCloudApigeeV1Schema: - description: Response for Schema call - properties: - meta: - items: - type: string + Required. The resource id of this reference. Values must match the + regular expression [\w\s\-.]+. + resourceType: description: >- - Additional metadata associated with schema. This is a legacy field - and usually consists of an empty array of strings. - type: array - dimensions: - type: array - description: List of schema fields grouped as dimensions. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' - type: array + The type of resource referred to by this reference. Valid values are + 'KeyStore' or 'TrustStore'. + type: string + refers: + type: string description: >- - List of schema fields grouped as dimensions that can be used with an - aggregate function such as `sum`, `avg`, `min`, and `max`. - id: GoogleCloudApigeeV1Schema - type: object - GoogleCloudApigeeV1MonetizationConfig: + Required. The id of the resource to which this reference refers. + Must be the id of a resource that exists in the parent environment + and is of the given resource_type. type: object - properties: - enabled: - description: Flag that specifies whether the Monetization add-on is enabled. - type: boolean - id: GoogleCloudApigeeV1MonetizationConfig - description: Configuration for the Monetization add-on. - GoogleCloudApigeeV1SecurityAssessmentResult: + id: GoogleCloudApigeeV1Reference + description: >- + A Reference configuration. References must refer to a keystore that also + exists in the parent environment. + GoogleCloudApigeeV1CreditDeveloperBalanceRequest: type: object - id: GoogleCloudApigeeV1SecurityAssessmentResult - description: The security assessment result for one resource. + id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest + description: Request for CreditDeveloperBalance. properties: - createTime: + transactionAmount: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - The time of the assessment of this resource. This could lag behind - `assessment_time` due to caching within the backend. - format: google-datetime + The amount of money to be credited. The wallet corresponding to the + currency specified within `transaction_amount` will be updated. For + example, if you specified `currency_code` within + `transaction_amount` as "USD", then the amount would be added to the + wallet which has the "USD" currency or if no such wallet exists, a + new wallet will be created with the "USD" currency. + transactionId: type: string - scoringResult: - description: The result of the assessment. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - resource: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource - description: The assessed resource. - error: - description: The error status if scoring fails. - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudApigeeV1Metric: - type: object - id: GoogleCloudApigeeV1Metric - properties: - values: description: >- - List of metric values. Possible value formats include: - `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": - 1232434354} ]` - items: - type: any - type: array - name: - type: string - description: Metric name. - description: >- - Encapsulates the metric data point. For example: ```{ "name": - "sum(message_count)", "values" : [ { "timestamp": 1549004400000, - "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] - }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }``` - GoogleCloudApigeeV1Access: - properties: - Remove: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' - Get: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' - Set: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' - id: GoogleCloudApigeeV1Access - type: object - GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: + Each transaction_id uniquely identifies a credit balance request. If + multiple requests are received with the same transaction_id, only + one of them will be considered. + GoogleCloudApigeeV1Environment: + id: GoogleCloudApigeeV1Environment properties: - points: - type: array - items: - items: - type: any - type: array - description: List of points. First value of each inner list is a timestamp. - dimensions: - type: object + createdAt: description: >- - Map of dimensions and their values that uniquely identifies a time - series sequence. - additionalProperties: - type: string - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - type: object - description: A sequence of time series. - GoogleCloudApigeeV1App: - properties: - developerId: + Output only. Creation time of this environment as milliseconds since + epoch. + format: int64 type: string - description: ID of the developer. - credentials: - type: array readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - description: >- - Output only. Set of credentials for the app. Credentials are API - key/secret pairs associated with API products. - createdAt: - type: string - description: Output only. Unix time when the app was created. - format: int64 + state: + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. readOnly: true - lastModifiedAt: type: string - readOnly: true - description: Output only. Last modified time as milliseconds since epoch. - format: int64 - name: - description: Name of the app. + description: >- + Output only. State of the environment. Values other than ACTIVE + means the resource is not ready to use. + nodeConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' + description: Optional. NodeConfig of the environment. + displayName: + description: Optional. Display name for this environment. type: string - scopes: - items: - type: string - type: array + description: + description: Optional. Description of the environment. + type: string + properties: description: >- - Scopes to apply to the app. The specified scope names must already - exist on the API product that you associate with the app. - appId: - description: ID of the app. + Optional. Key-value pairs that may be used for customizing the + environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + hasAttachedFlowHooks: + type: boolean + apiProxyType: + description: >- + Optional. API Proxy type supported by the environment. The type can + be set when creating the Environment and cannot be changed. + enumDescriptions: + - API proxy type not specified. + - >- + Programmable API Proxies enable you to develop APIs with highly + flexible behavior using bundled policy configuration and one or + more programming languages to describe complex sequential and/or + conditional flows of logic. + - >- + Configurable API Proxies enable you to develop efficient APIs + using simple configuration while complex execution control flow + logic is handled by Apigee. This type only works with the ARCHIVE + deployment type and cannot be combined with the PROXY deployment + type. type: string - status: - description: Status of the credential. + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + name: type: string - callbackUrl: + description: >- + Required. Name of the environment. Values must match the regular + expression `^[.\\p{Alnum}-_]{1,255}$` + deploymentType: + enumDescriptions: + - Deployment type not specified. + - >- + Proxy deployment enables you to develop and deploy API proxies + using Apigee on Google Cloud. This cannot currently be combined + with the CONFIGURABLE API proxy type. + - >- + Archive deployment enables you to develop API proxies locally then + deploy an archive of your API proxy configuration to an + environment in Apigee on Google Cloud. You will be prevented from + performing a [subset of + actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) + within the environment. type: string + enum: + - DEPLOYMENT_TYPE_UNSPECIFIED + - PROXY + - ARCHIVE description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to apps. - developerEmail: - description: Email of the developer. + Optional. Deployment type supported by the environment. The + deployment type can be set when creating the environment and cannot + be changed. When you enable archive deployment, you will be + **prevented from performing** a [subset of + actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) + within the environment, including: * Managing the deployment of API + proxy or shared flow revisions * Creating, updating, or deleting + resource files * Creating, updating, or deleting target servers + forwardProxyUri: + description: >- + Optional. URI of the forward proxy to be applied to the runtime + instances in this environment. Must be in the format of + {scheme}://{hostname}:{port}. Note that the scheme must be one of + "http" or "https", and the port must be supplied. To remove a + forward proxy setting, update the field to an empty value. Note: At + this time, PUT operations to add forwardProxyUri to an existing + environment fail if the environment has nodeConfig set up. To + successfully add the forwardProxyUri setting in this case, include + the NodeConfig details with the request. type: string - companyName: + lastModifiedAt: + format: int64 + readOnly: true + description: >- + Output only. Last modification time of this environment as + milliseconds since epoch. + type: string + type: + enumDescriptions: + - Environment type not specified. + - >- + This is the default type. Base environment has limited capacity + and capabilities and are usually used when you are getting started + with Apigee or while experimenting. Refer to Apigee's public + documentation for more details. + - >- + Intermediate environment supports API management features and + higher capacity than Base environment. Refer to Apigee's public + documentation for more details. + - >- + Comprehensive environment supports advanced capabilites and even + higher capacity than Intermediate environment. Refer to Apigee's + public documentation for more details. + type: string + enum: + - ENVIRONMENT_TYPE_UNSPECIFIED + - BASE + - INTERMEDIATE + - COMPREHENSIVE + description: Optional. EnvironmentType selected for the environment. + type: object + GoogleCloudApigeeV1DeveloperAppKey: + id: GoogleCloudApigeeV1DeveloperAppKey + properties: + consumerKey: + description: Consumer key. type: string - description: Name of the company that owns the app. - attributes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes. apiProducts: - description: List of API products associated with the app. + description: >- + List of API products for which the credential can be used. **Note**: + Do not specify the list of API products when creating a consumer key + and secret for a developer app. Instead, use the + UpdateDeveloperAppKey API to make the association after the consumer + key and secret are created. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + type: any type: array - appGroup: + consumerSecret: + description: Secret key. type: string - description: Name of the AppGroup - keyExpiresIn: + issuedAt: type: string - description: >- - Duration, in milliseconds, of the consumer key that will be - generated for the app. The default value, -1, indicates an infinite - validity period. Once set, the expiration can't be updated. json - key: keyExpiresIn format: int64 - id: GoogleCloudApigeeV1App - type: object - GoogleCloudApigeeV1TlsInfo: - description: TLS configuration information for virtual hosts and TargetServers. - properties: - clientAuthEnabled: - description: Optional. Enables two-way TLS. - type: boolean - ignoreValidationErrors: - type: boolean + description: Time the developer app was created in milliseconds since epoch. + scopes: description: >- - If true, Edge ignores TLS certificate errors. Valid when configuring - TLS for target servers and target endpoints, and when configuring - virtual hosts that use 2-way TLS. When used with a target - endpoint/target server, if the backend system uses SNI and returns a - cert with a subject Distinguished Name (DN) that does not match the - hostname, there is no way to ignore the error and the connection - fails. - keyStore: + Scopes to apply to the app. The specified scope names must already + be defined for the API product that you associate with the app. + type: array + items: + type: string + status: type: string description: >- - Required if `client_auth_enabled` is true. The resource ID of the - keystore. - keyAlias: + Status of the credential. Valid values include `approved` or + `revoked`. + expiresAt: + type: string + description: Time the developer app expires in milliseconds since epoch. + format: int64 + attributes: + type: array + description: List of attributes associated with the credential. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + expiresInSeconds: + format: int64 description: >- - Required if `client_auth_enabled` is true. The resource ID for the - alias containing the private key and cert. + Input only. Expiration time, in seconds, for the consumer key. If + not set or left to the default value of `-1`, the API key never + expires. The expiration time can't be updated after it is set. type: string - protocols: - description: The TLS versioins to be used. + type: object + GoogleCloudApigeeV1ListDataCollectorsResponse: + properties: + nextPageToken: + description: >- + Page token that you can include in a ListDataCollectors request to + retrieve the next page. If omitted, no subsequent pages exist. + type: string + dataCollectors: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' type: array - enforce: - description: TLS is strictly enforced. + description: Data collectors in the specified organization. + description: Response for ListDataCollectors. + type: object + id: GoogleCloudApigeeV1ListDataCollectorsResponse + GoogleCloudApigeeV1CommonNameConfig: + id: GoogleCloudApigeeV1CommonNameConfig + type: object + properties: + matchWildCards: type: boolean - trustStore: - description: The resource ID of the truststore. + name: type: string - enabled: + GoogleIamV1Binding: + description: Associates `members`, or principals, with a `role`. + type: object + properties: + condition: description: >- - Required. Enables TLS. If false, neither one-way nor two-way TLS - will be enabled. - type: boolean - ciphers: + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + members: type: array + items: + type: string description: >- - The SSL/TLS cipher suites to be used. For programmable proxies, it - must be one of the cipher suite names listed in: - http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. - For configurable proxies, it must follow the configuration specified - in: - https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. - This setting has no effect for configurable proxies when negotiating - TLS 1.3. - items: - type: string - commonName: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' - description: The TLS Common Name of the certificate. + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + role: + type: string + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + id: GoogleIamV1Binding + GoogleCloudApigeeV1GraphqlDocumentation: type: object - id: GoogleCloudApigeeV1TlsInfo - GoogleCloudApigeeV1DimensionMetric: - description: Encapsulates a metric grouped by dimension. - id: GoogleCloudApigeeV1DimensionMetric + description: GraphQL documentation for a catalog item. + properties: + endpointUri: + description: >- + Required. The GraphQL endpoint URI to be queried by API consumers. + Max length is 2,083 characters. + type: string + schema: + description: Required. The documentation file contents for the GraphQL schema. + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' + id: GoogleCloudApigeeV1GraphqlDocumentation + GoogleCloudApigeeV1SyncAuthorization: + id: GoogleCloudApigeeV1SyncAuthorization type: object properties: - individualNames: - type: array - description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. + etag: + description: >- + Entity tag (ETag) used for optimistic concurrency control as a way + to help prevent simultaneous updates from overwriting each other. + For example, when you call + [getSyncAuthorization](organizations/getSyncAuthorization) an ETag + is returned in the response. Pass that ETag when calling the + [setSyncAuthorization](organizations/setSyncAuthorization) to ensure + that you are updating the correct version. If you don't pass the + ETag in the call to `setSyncAuthorization`, then the existing + authorization is overwritten indiscriminately. **Note**: We strongly + recommend that you use the ETag in the read-modify-write cycle to + avoid race conditions. + type: string + format: byte + identities: items: type: string - metrics: type: array - description: List of metrics. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - name: - type: string - deprecated: true description: >- - Comma joined dimension names. E.g. "dim1_name,dim2_name". - Deprecated. If name already has comma before join, we may get wrong - splits. Please use individual_names. - GoogleCloudApigeeV1ListDeploymentsResponse: + Required. Array of service accounts to grant access to control plane + resources, each specified using the following format: + `serviceAccount:` service-account-name. The service-account-name is + formatted like an email address. For example: + `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` + You might specify multiple service accounts, for example, if you + have multiple environments and wish to assign a unique service + account to each one. The service accounts must have **Apigee + Synchronizer Manager** role. See also [Create service + accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). + GoogleCloudApigeeV1ListSecurityProfilesResponse: properties: - deployments: - description: List of deployments. + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + securityProfiles: type: array + description: >- + List of security profiles in the organization. The profiles may be + attached or unattached to any environment. This will return latest + revision of each profile. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' - id: GoogleCloudApigeeV1ListDeploymentsResponse - type: object - GoogleCloudApigeeV1Query: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' type: object - id: GoogleCloudApigeeV1Query + id: GoogleCloudApigeeV1ListSecurityProfilesResponse + description: Response for ListSecurityProfiles. + GoogleCloudApigeeV1ListDebugSessionsResponse: properties: - metrics: + sessions: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' - type: array - description: A list of Metrics. - groupByTimeUnit: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Session' description: >- - Time unit used to group the result set. Valid values include: - second, minute, hour, day, week, or month. If a query includes - groupByTimeUnit, then the result is an aggregation based on the - specified time unit and the resultant timestamp does not include - milliseconds precision. If a query omits groupByTimeUnit, then the - resultant timestamp includes milliseconds precision. - dimensions: + Session info that includes debug session ID and the first + transaction creation timestamp. type: array - items: - type: string - description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions - outputFormat: - description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. - type: string - timeRange: - type: any - description: >- - Required. Time range for the query. Can use the following predefined - strings to specify the time range: `last60minutes` `last24hours` - `last7days` Or, specify the timeRange as a structure describing - start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": - "2018-08-01T00:18:00Z" } - csvDelimiter: - type: string - description: >- - Delimiter used in the CSV file, if `outputFormat` is set to `csv`. - Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - name: - type: string - description: Asynchronous Query Name. - filter: + nextPageToken: type: string description: >- - Boolean expression that can be used to filter data. Filter - expressions can be combined using AND/OR terms and should be fully - parenthesized to avoid ambiguity. See Analytics metrics, dimensions, - and filters reference - https://docs.apigee.com/api-platform/analytics/analytics-reference - for more information on the fields available to filter on. For more - information on the tokens that you use to build filter expressions, - see Filter expression syntax. - https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax - reportDefinitionId: - type: string - description: Asynchronous Report ID. - limit: - type: integer - description: Maximum number of rows that can be returned in the result. - format: int32 - envgroupHostname: + Page token that you can include in a ListDebugSessionsRequest to + retrieve the next page. If omitted, no subsequent pages exist. + type: object + id: GoogleCloudApigeeV1ListDebugSessionsResponse + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + nextPageToken: type: string + description: The standard List next-page token. + operations: description: >- - Hostname needs to be specified if query intends to run at host - level. This field is only allowed when query is submitted by - CreateHostAsyncQuery where analytics data will be grouped by - organization and hostname. - GoogleCloudApigeeV1EndpointChainingRule: + A list of operations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array + GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: + type: object properties: - deploymentGroup: + nextPageToken: description: >- - The deployment group to target for cross-shard chaining calls to - these proxies. + A page token, received from a previous `ComputeScore` call. Provide + this to retrieve the subsequent page. type: string - proxyIds: + scores: + description: List of scores. One score per day. type: array items: - type: string - description: List of proxy ids which may be found in the given deployment group. + $ref: '#/components/schemas/GoogleCloudApigeeV1Score' + id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + description: Response for ComputeEnvironmentScores. + GoogleCloudApigeeV1AliasRevisionConfig: + id: GoogleCloudApigeeV1AliasRevisionConfig type: object - description: >- - EndpointChainingRule specifies the proxies contained in a particular - deployment group, so that other deployment groups can find them in - chaining calls. - id: GoogleCloudApigeeV1EndpointChainingRule - GoogleCloudApigeeV1Result: - description: >- - Result is short for "action result", could be different types identified - by "action_result" field. Supported types: 1. DebugInfo : generic debug - info collected by runtime recorded as a list of properties. For example, - the contents could be virtual host info, state change result, or - execution metadata. Required fields : properties, timestamp 2. - RequestMessage: information of a http request. Contains headers, request - URI and http methods type.Required fields : headers, uri, verb 3. - ResponseMessage: information of a http response. Contains headers, - reason phrase and http status code. Required fields : headers, - reasonPhrase, statusCode 4. ErrorMessage: information of a http error - message. Contains detail error message, reason phrase and status code. - Required fields : content, headers, reasonPhrase, statusCode 5. - VariableAccess: a list of variable access actions, can be Get, Set and - Remove. Required fields : accessList - id: GoogleCloudApigeeV1Result properties: - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Name value pairs used for DebugInfo ActionResult. - uRI: + name: description: >- - The relative path of the api proxy. for example, `"uRI" : - "/iloveapis"` + Name of the alias revision included in the keystore in the following + format: + `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}` type: string - statusCode: - description: HTTP response code + location: type: string - verb: + description: Location of the alias file. For example, a Google Cloud Storage URI. + type: + enumDescriptions: + - Alias type is not specified. + - Certificate. + - Key/certificate pair. type: string - description: HTTP method verb - ActionResult: + enum: + - ALIAS_TYPE_UNSPECIFIED + - CERT + - KEY_CERT + GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: + properties: + pageToken: type: string description: >- - Type of the action result. Can be one of the five: DebugInfo, - RequestMessage, ResponseMessage, ErrorMessage, VariableAccess - timestamp: + Page token stands for a specific collection of time series + sequences. + timestampOrder: type: string + enum: + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING description: >- - Timestamp of when the result is recorded. Its format is dd-mm-yy - hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` - content: + Order the sequences in increasing or decreasing order of timestamps. + Default is descending order of timestamps (latest first). + enumDescriptions: + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. + windowSize: + enumDescriptions: + - Unspecified window size. Default is 1 hour. + - 1 Minute window + - 1 Hour window + - 1 Day window + - 1 Month window + description: Time buckets to group the stats by. + enum: + - WINDOW_SIZE_UNSPECIFIED + - MINUTE + - HOUR + - DAY + - MONTH + type: string + filter: type: string description: >- - Error message content. for example, "content" : - "{\"fault\":{\"faultstring\":\"API timed - out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" - accessList: + Filter further on specific dimension values. Follows the same + grammar as custom report's filter expressions. Example, apiproxy eq + 'foobar'. + https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: Required. Time range for the stats. + dimensions: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Access' + type: string description: >- - A list of variable access actions agaist the api proxy. Supported - values: Get, Set, Remove. + List of dimension names to group the aggregations by. If no + dimensions are passed, a single trend line representing the + requested metric aggregations grouped by environment is returned. type: array - reasonPhrase: - type: string - description: HTTP response phrase - headers: + pageSize: + type: integer + format: int32 description: >- - A list of HTTP headers. for example, '"headers" : [ { "name" : - "Content-Length", "value" : "83" }, { "name" : "Content-Type", - "value" : "application/json" } ]' - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + Page size represents the number of time series sequences, one per + unique set of dimensions and their values. + metrics: type: array + description: Required. List of metrics and their aggregations. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' + description: >- + QueryTimeSeriesStatsRequest represents a query that returns a collection + of time series sequences grouped by their values. + id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest type: object - GoogleCloudApigeeV1DeveloperSubscription: - type: object + GoogleCloudApigeeV1AsyncQuery: properties: - apiproduct: - type: string + queryParams: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' description: >- - Name of the API product for which the developer is purchasing a - subscription. - startTime: - format: int64 + Contains information like metrics, dimenstions etc of the + AsyncQuery. + state: + type: string + description: Query state could be "enqueued", "running", "completed", "failed". + self: type: string description: >- - Time when the API product subscription starts in milliseconds since - epoch. - lastModifiedAt: - readOnly: true - description: >- - Output only. Time when the API product subscription was last - modified in milliseconds since epoch. + Self link of the query. Example: + `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + or following format if query is running at host level: + `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + name: type: string - format: int64 - endTime: + description: Asynchronous Query Name. + executionTime: type: string - format: int64 - description: >- - Time when the API product subscription ends in milliseconds since - epoch. - createdAt: - description: >- - Output only. Time when the API product subscription was created in - milliseconds since epoch. - format: int64 - readOnly: true + description: ExecutionTime is available only after the query is completed. + result: + description: Result is available only after the query is completed. + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' + reportDefinitionId: + description: Asynchronous Report ID. type: string - name: - description: Output only. Name of the API product subscription. + envgroupHostname: + description: Hostname is available only when query is executed at host level. type: string - readOnly: true - id: GoogleCloudApigeeV1DeveloperSubscription - description: Structure of a DeveloperSubscription. - GoogleCloudApigeeV1DeleteResponse: - properties: - status: - description: Status of the operation. + error: type: string - message: - description: Description of the operation. + description: Error is set when query fails. + updated: type: string - errorCode: + description: Last updated timestamp for the query. + resultRows: + format: int64 type: string - description: Unique error code for the request, if any. - gcpResource: - description: Google Cloud name of deleted resource. + description: ResultRows is available only after the query is completed. + resultFileSize: type: string - requestId: + description: ResultFileSize is available only after the query is completed. + created: type: string - description: Unique ID of the request. - description: Response for certain delete operations. + description: Creation time of the query. type: object - id: GoogleCloudApigeeV1DeleteResponse - GoogleCloudApigeeV1ProfileConfigAuthorization: + id: GoogleCloudApigeeV1AsyncQuery + GoogleCloudApigeeV1TestDatastoreResponse: + properties: + state: + description: Output only. It could be `completed` or `failed` + readOnly: true + type: string + error: + description: Output only. Error message of test connection failure + readOnly: true + type: string + description: The response for TestDatastore type: object - properties: {} - description: >- - By default, following policies will be included: - JWS - JWT - OAuth - - BasicAuth - APIKey - id: GoogleCloudApigeeV1ProfileConfigAuthorization - GoogleCloudApigeeV1ProfileConfigThreat: + id: GoogleCloudApigeeV1TestDatastoreResponse + GoogleCloudApigeeV1Attribute: + description: Key-value pair to store extra metadata. type: object - id: GoogleCloudApigeeV1ProfileConfigThreat - description: >- - By default, following policies will be included: - XMLThreatProtection - - JSONThreatProtection - properties: {} - GoogleLongrunningOperation: - id: GoogleLongrunningOperation - description: >- - This resource represents a long-running operation that is the result of - a network API call. + id: GoogleCloudApigeeV1Attribute properties: - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - type: object - GoogleCloudApigeeV1SecurityReportQueryMetric: - id: GoogleCloudApigeeV1SecurityReportQueryMetric - properties: - operator: - description: One of `+`, `-`, `/`, `%`, `*`. - type: string - alias: - type: string - description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. name: type: string - description: Required. Metric name. + description: API key of the attribute. value: + description: Value of the attribute. type: string - description: Operand value should be provided when operator is set. - aggregationFunction: + GoogleCloudApigeeV1ApiSecurityConfig: + properties: + enabled: + description: Flag that specifies whether the API security add-on is enabled. + type: boolean + expiresAt: + readOnly: true + description: >- + Output only. Time at which the API Security add-on expires in in + milliseconds since epoch. If unspecified, the add-on will never + expire. + format: int64 type: string - description: 'Aggregation function: avg, min, max, or sum.' - description: Metric of the Query - type: object - GoogleCloudApigeeV1ReportInstanceStatusRequest: - description: Request for ReportInstanceStatus. - id: GoogleCloudApigeeV1ReportInstanceStatusRequest + description: Configurations of the API Security add-on. + id: GoogleCloudApigeeV1ApiSecurityConfig type: object + GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: properties: - resources: + filters: + description: >- + Optional. Filters are used to filter scored components. Return all + the components if no filter is mentioned. Example: [{ "scorePath": + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + }, { "scorePath": + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", + }] This will return components with path: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + OR + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target" type: array - description: Status for config resources items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' - instanceUid: - type: string + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + pageToken: description: >- - A unique ID for the instance which is guaranteed to be unique in - case the user installs multiple hybrid runtimes with the same - instance ID. - reportTime: + Optional. A token that can be sent as `page_token` to retrieve the + next page. If this field is omitted, there are no subsequent pages. type: string + pageSize: + type: integer + format: int32 description: >- - The time the report was generated in the runtime. Used to prevent an - old status from overwriting a newer one. An instance should space - out it's status reports so that clock skew does not play a factor. - format: google-datetime - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: - description: Revisions deployed in the MPs. - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + Optional. The maximum number of subcomponents to be returned in a + single page. The service may return fewer than this value. If + unspecified, at most 100 subcomponents will be returned in a single + page. + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: >- + Required. Time range for score calculation. At most 14 days of + scores will be returned, and both the start and end dates must be + within the last 90 days. + description: Request for ComputeEnvironmentScores. type: object + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + GoogleCloudApigeeV1SharedFlowRevision: properties: - percentage: - format: int32 - description: Percentage of MP replicas reporting this revision. - type: integer - revision: - type: string - description: API proxy revision reported as deployed. - GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: - id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse - properties: - environmentGroupAttachments: - description: EnvironmentGroupAttachments for the specified environment group. + sharedFlows: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' - type: array - nextPageToken: - type: string + type: string description: >- - Page token that you can include in a ListEnvironmentGroupAttachments - request to retrieve the next page. If omitted, no subsequent pages - exist. - type: object - description: Response for ListEnvironmentGroupAttachments. - GoogleCloudApigeeV1GenerateUploadUrlRequest: - description: Request for GenerateUploadUrl method. - type: object - id: GoogleCloudApigeeV1GenerateUploadUrlRequest - properties: {} - GoogleCloudApigeeV1ApiCategory: - properties: + A list of the shared flow names included in this shared flow + revision. + type: array name: type: string - description: Name of the category. - id: - type: string - description: ID of the category (a UUID). - updateTime: - type: string + description: The resource ID of the parent shared flow. + createdAt: format: int64 - description: Time the category was last modified in milliseconds since epoch. - siteId: - description: Name of the portal. + description: >- + Time at which this shared flow revision was created, in milliseconds + since epoch. type: string - type: object - id: GoogleCloudApigeeV1ApiCategory - description: >- - `ApiCategory` represents an API category. [Catalog - items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) - can be tagged with API categories; users viewing the API catalog in the - portal will have the option to browse the catalog by category. - GoogleCloudApigeeV1DeploymentGroupConfig: - type: object - description: >- - DeploymentGroupConfig represents a deployment group that should be - present in a particular environment. - properties: - revisionId: + revision: + type: string + description: The resource ID of this revision. + resourceFiles: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + description: The resource files included in this shared flow revision. + resources: + type: array description: >- - Revision number which can be used by the runtime to detect if the - deployment group has changed between two versions. + A list of the resources included in this shared flow revision + formatted as "{type}://{name}". + items: + type: string + configurationVersion: + description: >- + The version of the configuration schema to which this shared flow + conforms. The only supported value currently is majorVersion 4 and + minorVersion 0. This setting may be used in the future to enable + evolution of the shared flow format. + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' + contextInfo: + type: string + description: A textual description of the shared flow revision. + lastModifiedAt: type: string format: int64 - name: description: >- - Name of the deployment group in the following format: - `organizations/{org}/environments/{env}/deploymentGroups/{group}`. + Time at which this shared flow revision was most recently modified, + in milliseconds since epoch. + policies: + type: array + description: A list of policy names included in this shared flow revision. + items: + type: string + type: type: string - uid: - description: >- - Unique ID. The ID will only change if the deployment group is - deleted and recreated. + description: The string "Application" + description: type: string - deploymentGroupType: - description: >- - Type of the deployment group, which will be either Standard or - Extensible. - enumDescriptions: - - Unspecified type - - Standard type - - Extensible Type - enum: - - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE + description: Description of the shared flow revision. + entityMetaDataAsProperties: + description: A Key-Value map of metadata about this shared flow revision. + type: object + additionalProperties: + type: string + displayName: + description: The human readable name of this shared flow. type: string - id: GoogleCloudApigeeV1DeploymentGroupConfig - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse - description: Response for BatchUpdateSecurityIncident. + description: The metadata describing a shared flow revision. + id: GoogleCloudApigeeV1SharedFlowRevision type: object + GoogleCloudApigeeV1TraceSamplingConfig: + description: >- + TraceSamplingConfig represents the detail settings of distributed + tracing. Only the fields that are defined in the distributed trace + configuration can be overridden using the distribute trace configuration + override APIs. properties: - securityIncidents: - readOnly: true - description: Output only. Updated security incidents - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - type: array - GoogleCloudApigeeV1ListAsyncQueriesResponse: - id: GoogleCloudApigeeV1ListAsyncQueriesResponse - description: The response for ListAsyncQueries. - type: object - properties: - queries: - type: array - description: The asynchronous queries belong to requested resource name. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' - GoogleProtobufEmpty: - 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); } + sampler: + enumDescriptions: + - Sampler unspecified. + - >- + OFF means distributed trace is disabled, or the sampling + probability is 0. + - >- + PROBABILITY means traces are captured on a probability that + defined by sampling_rate. The sampling rate is limited to 0 to 0.5 + when this is set. + description: Sampler of distributed tracing. OFF is the default value. + enum: + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY + type: string + samplingRate: + format: float + type: number + description: >- + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + id: GoogleCloudApigeeV1TraceSamplingConfig type: object - id: GoogleProtobufEmpty - properties: {} - GoogleRpcStatus: + GoogleCloudApigeeV1ApiDocDocumentationResponse: type: object properties: message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + readOnly: true type: string - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - code: - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - GoogleCloudApigeeV1CanaryEvaluationMetricLabels: - description: Labels that can be used to filter Apigee metrics. - type: object - properties: - location: + description: Output only. Description of the operation. + requestId: type: string - description: Required. The location associated with the metrics. - env: - description: The environment ID associated with the metrics. + readOnly: true + description: Output only. Unique ID of the request. + status: type: string - instance_id: - description: >- - Required. The instance ID associated with the metrics. In Apigee - Hybrid, the value is configured during installation. + readOnly: true + description: Output only. Status of the operation. + errorCode: type: string - id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels - GoogleCloudApigeeV1EnableSecurityActionRequest: - type: object - properties: {} - description: Message to enable a disabled SecurityAction. - id: GoogleCloudApigeeV1EnableSecurityActionRequest - GoogleCloudApigeeV1DeploymentConfig: - id: GoogleCloudApigeeV1DeploymentConfig + description: Output only. Unique error code for the request, if any. + readOnly: true + data: + description: Output only. The documentation resource. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + readOnly: true + description: >- + The catalog item documentation wrapped with response status, error_code, + etc. + id: GoogleCloudApigeeV1ApiDocDocumentationResponse + GoogleIamV1TestIamPermissionsRequest: + description: Request message for `TestIamPermissions` method. + id: GoogleIamV1TestIamPermissionsRequest type: object properties: - proxyUid: - description: Unique ID of the API proxy revision. - type: string - serviceAccount: - type: string - description: >- - The service account identity associated with this deployment. If - non-empty, will be in the following format: - `projects/-/serviceAccounts/{account_email}` - basePath: - type: string - description: Base path where the application will be hosted. Defaults to "/". - uid: - description: >- - Unique ID. The ID will only change if the deployment is deleted and - recreated. - type: string - endpoints: - description: >- - A mapping from basepaths to proxy endpoint names in this proxy. Not - populated for shared flows. - additionalProperties: - type: string - type: object - name: - type: string - description: >- - Name of the API or shared flow revision to be deployed in the - following format: `organizations/{org}/apis/{api}/revisions/{rev}` - or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` - deploymentGroups: - description: >- - The list of deployment groups in which this proxy should be - deployed. Not currently populated for shared flows. - items: - type: string + permissions: type: array - attributes: - additionalProperties: + items: type: string - type: object - description: Additional key-value metadata for the deployment. - location: - type: string - description: Location of the API proxy bundle as a URI. - description: 'NEXT ID: 11' - GoogleCloudApigeeV1ListSecurityReportsResponse: - properties: - nextPageToken: - type: string description: >- - If the number of security reports exceeded the page size requested, - the token can be used to fetch the next page in a subsequent call. - If the response is the last page and there are no more reports to - return this field is left empty. - securityReports: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' - type: array - description: The security reports belong to requested resource name. - type: object - id: GoogleCloudApigeeV1ListSecurityReportsResponse - description: The response for SecurityReports. - GoogleCloudApigeeV1ReferenceConfig: + 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). + GoogleCloudApigeeV1AccessRemove: + description: >- + Remove action. For example, "Remove" : { "name" : "target.name", + "success" : true } + id: GoogleCloudApigeeV1AccessRemove properties: - resourceName: - description: >- - Name of the referenced resource in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` Only - references to keystore resources are supported. - type: string + success: + type: boolean name: type: string - description: >- - Name of the reference in the following format: - `organizations/{org}/environments/{env}/references/{reference}` - id: GoogleCloudApigeeV1ReferenceConfig type: object - GoogleCloudApigeeV1GenerateUploadUrlResponse: - id: GoogleCloudApigeeV1GenerateUploadUrlResponse + GoogleCloudApigeeV1ListCustomReportsResponse: properties: - uploadUri: - description: >- - The Google Cloud Storage signed URL that can be used to upload a new - Archive zip file. - type: string + qualifier: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' type: object - description: Response for GenerateUploadUrl method. - GoogleCloudApigeeV1SchemaSchemaProperty: - description: Properties for the schema field. + description: This message encapsulates a list of custom report definitions + id: GoogleCloudApigeeV1ListCustomReportsResponse + GoogleCloudApigeeV1ConnectorsPlatformConfig: + description: Configuration for the Connectors Platform add-on. + id: GoogleCloudApigeeV1ConnectorsPlatformConfig properties: - createTime: + enabled: + type: boolean description: >- - Time the field was created in RFC3339 string form. For example: - `2016-02-26T10:23:09.592Z`. - type: string - type: - description: Data type of the field. - type: string - custom: + Flag that specifies whether the Connectors Platform add-on is + enabled. + expiresAt: + readOnly: true + format: int64 description: >- - Flag that specifies whether the field is standard in the dataset or - a custom field created by the customer. `true` indicates that it is - a custom field. + Output only. Time at which the Connectors Platform add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. type: string type: object - id: GoogleCloudApigeeV1SchemaSchemaProperty - GoogleCloudApigeeV1Environment: + GoogleCloudApigeeV1Instance: + description: Apigee runtime instance. type: object + id: GoogleCloudApigeeV1Instance properties: + location: + type: string + description: Required. Compute Engine location where the instance resides. createdAt: + format: int64 description: >- - Output only. Creation time of this environment as milliseconds since + Output only. Time the instance was created in milliseconds since epoch. type: string readOnly: true - format: int64 - state: + consumerAcceptList: + type: array + items: + type: string + description: >- + Optional. Customer accept list represents the list of projects + (id/number) on customer side that can privately connect to the + service attachment. It is an optional field which the customers can + provide during the instance creation. By default, the customer + project associated with the Apigee organization will be included to + the list. + ipRange: + description: >- + Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 + used to create the Apigee instance. Providing CIDR ranges is + optional. You can provide just /22 or /28 or both (or neither). + Ranges you provide should be freely available as part of a larger + named range you have allocated to the Service Networking peering. If + this parameter is not provided, Apigee automatically requests an + available /22 and /28 CIDR block from Service Networking. Use the + /22 CIDR block for configuring your firewall needs to allow traffic + from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or + `a.b.c.d/22,e.f.g.h/28` + type: string + name: + description: >- + Required. Resource ID of the instance. Values must match the regular + expression `^a-z{0,30}[a-z\d]$`. type: string + serviceAttachment: + type: string + description: >- + Output only. Resource name of the service attachment created for the + instance in the format: `projects/*/regions/*/serviceAttachments/*` + Apigee customers can privately forward traffic to this service + attachment using the PSC endpoints. readOnly: true + accessLoggingConfig: + description: >- + Optional. Access logging configuration enables the access logging + feature at the instance. Apigee customers can enable access logging + to ship the access logs to their own project's cloud logging. + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessLoggingConfig' + state: enumDescriptions: - Resource is in an unspecified state. - Resource is being created. - Resource is provisioned and ready to use. - The resource is being deleted. - The resource is being updated. - description: >- - Output only. State of the environment. Values other than ACTIVE - means the resource is not ready to use. enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - UPDATING - nodeConfig: - description: Optional. NodeConfig of the environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' - apiProxyType: + type: string + readOnly: true description: >- - Optional. API Proxy type supported by the environment. The type can - be set when creating the Environment and cannot be changed. + Output only. State of the instance. Values other than `ACTIVE` means + the resource is not ready to use. + runtimeVersion: + description: >- + Output only. Version of the runtime system running in the instance. + The runtime system is the set of components that serve the API Proxy + traffic in your Environments. + readOnly: true type: string - enumDescriptions: - - API proxy type not specified. - - >- - Programmable API Proxies enable you to develop APIs with highly - flexible behavior using bundled policy configuration and one or - more programming languages to describe complex sequential and/or - conditional flows of logic. - - >- - Configurable API Proxies enable you to develop efficient APIs - using simple configuration while complex execution control flow - logic is handled by Apigee. This type only works with the ARCHIVE - deployment type and cannot be combined with the PROXY deployment - type. - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE - deploymentType: - enum: - - DEPLOYMENT_TYPE_UNSPECIFIED - - PROXY - - ARCHIVE + host: type: string description: >- - Optional. Deployment type supported by the environment. The - deployment type can be set when creating the environment and cannot - be changed. When you enable archive deployment, you will be - **prevented from performing** a [subset of - actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) - within the environment, including: * Managing the deployment of API - proxy or shared flow revisions * Creating, updating, or deleting - resource files * Creating, updating, or deleting target servers - enumDescriptions: - - Deployment type not specified. - - >- - Proxy deployment enables you to develop and deploy API proxies - using Apigee on Google Cloud. This cannot currently be combined - with the CONFIGURABLE API proxy type. - - >- - Archive deployment enables you to develop API proxies locally then - deploy an archive of your API proxy configuration to an - environment in Apigee on Google Cloud. You will be prevented from - performing a [subset of - actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) - within the environment. - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: >- - Optional. Key-value pairs that may be used for customizing the - environment. - forwardProxyUri: + Output only. Internal hostname or IP address of the Apigee endpoint + used by clients to connect to the service. + readOnly: true + diskEncryptionKeyName: + type: string description: >- - Optional. URI of the forward proxy to be applied to the runtime - instances in this environment. Must be in the format of - {scheme}://{hostname}:{port}. Note that the scheme must be one of - "http" or "https", and the port must be supplied. To remove a - forward proxy setting, update the field to an empty value. Note: At - this time, PUT operations to add forwardProxyUri to an existing - environment fail if the environment has nodeConfig set up. To - successfully add the forwardProxyUri setting in this case, include - the NodeConfig details with the request. + Customer Managed Encryption Key (CMEK) used for disk and volume + encryption. If not specified, a Google-Managed encryption key will + be used. Use the following format: + `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` + description: + description: Optional. Description of the instance. type: string - type: - enumDescriptions: - - Environment type not specified. - - >- - This is the default type. Base environment has limited capacity - and capabilities and are usually used when you are getting started - with Apigee or while experimenting. Refer to Apigee's public - documentation for more details. - - >- - Intermediate environment supports API management features and - higher capacity than Base environment. Refer to Apigee's public - documentation for more details. - - >- - Comprehensive environment supports advanced capabilites and even - higher capacity than Intermediate environment. Refer to Apigee's - public documentation for more details. - enum: - - ENVIRONMENT_TYPE_UNSPECIFIED - - BASE - - INTERMEDIATE - - COMPREHENSIVE - description: Optional. EnvironmentType selected for the environment. + port: + readOnly: true type: string - hasAttachedFlowHooks: - type: boolean + description: Output only. Port number of the exposed Apigee endpoint. lastModifiedAt: format: int64 - type: string description: >- - Output only. Last modification time of this environment as - milliseconds since epoch. + Output only. Time the instance was last modified in milliseconds + since epoch. readOnly: true - description: - description: Optional. Description of the environment. type: string - displayName: - description: Optional. Display name for this environment. + peeringCidrRange: + deprecated: true + enumDescriptions: + - Range not specified. + - '`/16` CIDR range.' + - '`/17` CIDR range.' + - '`/18` CIDR range.' + - '`/19` CIDR range.' + - '`/20` CIDR range.' + - '`/22` CIDR range. Supported for evaluation only.' + - '`/23` CIDR range. Supported for evaluation only.' + enum: + - CIDR_RANGE_UNSPECIFIED + - SLASH_16 + - SLASH_17 + - SLASH_18 + - SLASH_19 + - SLASH_20 + - SLASH_22 + - SLASH_23 type: string - name: description: >- - Required. Name of the environment. Values must match the regular - expression `^[.\\p{Alnum}-_]{1,255}$` + Optional. Size of the CIDR block range that will be reserved by the + instance. PAID organizations support `SLASH_16` to `SLASH_20` and + defaults to `SLASH_16`. Evaluation organizations support only + `SLASH_23`. + displayName: + description: Optional. Display name for the instance. type: string - id: GoogleCloudApigeeV1Environment - GoogleCloudApigeeV1SharedFlowRevision: - id: GoogleCloudApigeeV1SharedFlowRevision - type: object - description: The metadata describing a shared flow revision. + GoogleCloudApigeeV1ListOfDevelopersResponse: properties: - sharedFlows: - type: array + developer: + description: List of developers. items: - type: string - description: >- - A list of the shared flow names included in this shared flow - revision. - entityMetaDataAsProperties: - type: object - description: A Key-Value map of metadata about this shared flow revision. - additionalProperties: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + type: array + id: GoogleCloudApigeeV1ListOfDevelopersResponse + type: object + GoogleCloudApigeeV1TargetServerConfig: + type: object + properties: + protocol: + enum: + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + type: string + description: The protocol used by this target server. + enumDescriptions: + - UNSPECIFIED defaults to HTTP for backwards compatibility. + - The TargetServer uses HTTP. + - The TargetSever uses HTTP2. + - The TargetServer uses GRPC. + - >- + GRPC TargetServer to be used in ExternalCallout Policy. Prefer to + use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once + EXTERNAL _CALLOUT generally available. + - The TargetServer is to be used in the ExternalCallout Policy + tlsInfo: + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' + description: TLS settings for the target server. name: type: string - description: The resource ID of the parent shared flow. - createdAt: description: >- - Time at which this shared flow revision was created, in milliseconds - since epoch. + Target server revision name in the following format: + `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` + host: + description: Host name of the target server. type: string - format: int64 - resourceFiles: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - description: The resource files included in this shared flow revision. - resources: - items: - type: string - type: array + enabled: + type: boolean description: >- - A list of the resources included in this shared flow revision - formatted as "{type}://{name}". - description: + Whether the target server is enabled. An empty/omitted value for + this field should be interpreted as true. + port: + description: Port number for the target server. + format: int32 + type: integer + id: GoogleCloudApigeeV1TargetServerConfig + GoogleCloudApigeeV1KeyAliasReference: + properties: + aliasId: type: string - description: Description of the shared flow revision. - configurationVersion: + description: Alias ID. Must exist in the keystore referred to by the reference. + reference: description: >- - The version of the configuration schema to which this shared flow - conforms. The only supported value currently is majorVersion 4 and - minorVersion 0. This setting may be used in the future to enable - evolution of the shared flow format. - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' - revision: + Reference name in the following format: + `organizations/{org}/environments/{env}/references/{reference}` type: string - description: The resource ID of this revision. - policies: + id: GoogleCloudApigeeV1KeyAliasReference + type: object + GoogleCloudApigeeV1DimensionMetric: + properties: + name: + type: string + description: >- + Comma joined dimension names. E.g. "dim1_name,dim2_name". + Deprecated. If name already has comma before join, we may get wrong + splits. Please use individual_names. + deprecated: true + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + description: List of metrics. + type: array + individualNames: items: type: string + description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. type: array - description: A list of policy names included in this shared flow revision. - displayName: - description: The human readable name of this shared flow. + type: object + description: Encapsulates a metric grouped by dimension. + id: GoogleCloudApigeeV1DimensionMetric + GoogleCloudApigeeV1CanaryEvaluationMetricLabels: + properties: + env: + description: The environment ID associated with the metrics. type: string - contextInfo: + location: type: string - description: A textual description of the shared flow revision. - lastModifiedAt: + description: Required. The location associated with the metrics. + instance_id: type: string description: >- - Time at which this shared flow revision was most recently modified, - in milliseconds since epoch. - format: int64 - type: - description: The string "Application" - type: string - GoogleCloudApigeeV1Organization: + Required. The instance ID associated with the metrics. In Apigee + Hybrid, the value is configured during installation. + id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels + description: Labels that can be used to filter Apigee metrics. type: object + GoogleCloudApigeeV1UpdateSecurityIncidentRequest: properties: - createdAt: + securityIncident: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' description: >- - Output only. Time that the Apigee organization was created in - milliseconds since epoch. - readOnly: true - format: int64 + Required. The security incident to update. Must contain all existing + populated fields of the current incident. + updateMask: type: string - runtimeDatabaseEncryptionKeyName: description: >- - Cloud KMS key name used for encrypting the data that is stored and - replicated across runtime instances. Update is not allowed after the - organization is created. If not specified or - [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption - key will be used. For example: - "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** - Not supported for Apigee hybrid. - type: string - addonsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - description: Addon configurations of the Apigee organization. - caCertificate: - readOnly: true + Required. The list of fields to update. Allowed fields are: + LINT.IfChange(allowed_update_fields_comment) - observability + LINT.ThenChange() + format: google-fieldmask + description: Request for UpdateSecurityIncident. + type: object + id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest + GoogleCloudApigeeV1ListSecurityReportsResponse: + properties: + nextPageToken: type: string description: >- - Output only. Base64-encoded public certificate for the root CA of - the Apigee organization. Valid only when [RuntimeType](#RuntimeType) - is `CLOUD`. - format: byte - apiConsumerDataLocation: - description: >- - This field is needed only for customers using non-default data - residency regions. Apigee stores some control plane data only in - single region. This field determines which single region Apigee - should use. For example: "us-west1" when control plane is in US or - "europe-west2" when control plane is in EU. + If the number of security reports exceeded the page size requested, + the token can be used to fetch the next page in a subsequent call. + If the response is the last page and there are no more reports to + return this field is left empty. + securityReports: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + description: The security reports belong to requested resource name. + id: GoogleCloudApigeeV1ListSecurityReportsResponse + description: The response for SecurityReports. + type: object + GoogleCloudApigeeV1ProfileConfigMediation: + properties: {} + id: GoogleCloudApigeeV1ProfileConfigMediation + type: object + description: >- + By default, following policies will be included: - OASValidation - + SOAPMessageValidation + GoogleCloudApigeeV1EnvironmentGroupAttachment: + properties: + environment: + description: Required. ID of the attached environment. type: string - portalDisabled: - type: boolean - description: Configuration for the Portals settings. - lastModifiedAt: + name: + type: string + description: ID of the environment group attachment. + environmentGroupId: + description: Output only. ID of the environment group. readOnly: true type: string + createdAt: description: >- - Output only. Time that the Apigee organization was last modified in - milliseconds since epoch. - format: int64 - expiresAt: + Output only. The time at which the environment group attachment was + created as milliseconds since epoch. type: string format: int64 - description: >- - Output only. Time that the Apigee organization is scheduled for - deletion. readOnly: true - analyticsRegion: - type: string + description: >- + EnvironmentGroupAttachment is a resource which defines an attachment of + an environment to an environment group. + type: object + id: GoogleCloudApigeeV1EnvironmentGroupAttachment + GoogleCloudApigeeV1ListArchiveDeploymentsResponse: + id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse + description: Response for ListArchiveDeployments method. + properties: + archiveDeployments: + description: Archive Deployments in the specified environment. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + type: array + nextPageToken: description: >- - Required. DEPRECATED: This field will eventually be deprecated and - replaced with a differently-named field. Primary Google Cloud region - for analytics data storage. For valid values, see [Create an Apigee - organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). - deprecated: true - projectId: - description: Output only. Project ID associated with the Apigee organization. + Page token that you can include in a ListArchiveDeployments request + to retrieve the next page. If omitted, no subsequent pages exist. type: string - readOnly: true - apiConsumerDataEncryptionKeyName: + type: object + GoogleCloudApigeeV1RuntimeTraceSamplingConfig: + type: object + description: >- + NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of + distributed tracing. Only the fields that are defined in the distributed + trace configuration can be overridden using the distribute trace + configuration override APIs. + properties: + samplingRate: + type: number description: >- - Cloud KMS key name used for encrypting API consumer data. If not - specified or [BillingType](#BillingType) is `EVALUATION`, a - Google-Managed encryption key will be used. Format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*` - type: string - billingType: - enumDescriptions: - - Billing type not specified. - - A pre-paid subscription to Apigee. - - Free and limited access to Apigee for evaluation purposes only. - - Access to Apigee using a Pay-As-You-Go plan. + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + format: float + sampler: enum: - - BILLING_TYPE_UNSPECIFIED - - SUBSCRIPTION - - EVALUATION - - PAYG + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY + description: Sampler of distributed tracing. OFF is the default value. + enumDescriptions: + - Sampler unspecified. + - >- + OFF means distributed trace is disabled, or the sampling + probability is 0. + - >- + PROBABILITY means traces are captured on a probability that + defined by sampling_rate. The sampling rate is limited to 0 to 0.5 + when this is set. + type: string + id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig + GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: + id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + type: object + properties: + developerSubscriptions: + description: List of all subscriptions. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + type: array + nextStartKey: type: string description: >- - Billing type of the Apigee organization. See [Apigee - pricing](https://cloud.google.com/apigee/pricing). - disableVpcPeering: - type: boolean - description: >- - Optional. Flag that specifies whether the VPC Peering through - Private Google Access should be disabled between the consumer - network and Apigee. Valid only when RuntimeType is set to CLOUD. - Required if an authorizedNetwork on the consumer project is not - provided, in which case the flag should be set to true. The value - must be set before the creation of any Apigee runtime instance and - can be updated only when there are no runtime instances. **Note:** - Apigee will be deprecating the vpc peering model that requires you - to provide 'authorizedNetwork', by making the non-peering model as - the default way of provisioning Apigee organization in future. So, - this will be a temporary flag to enable the transition. Not - supported for Apigee hybrid. - properties: - description: Properties defined in the Apigee organization profile. - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - attributes: + Value that can be sent as `startKey` to retrieve the next page of + content. If this field is omitted, there are no subsequent pages. + description: Response for ListDeveloperSubscriptions. + GoogleCloudApigeeV1RuntimeAnalyticsConfig: + id: GoogleCloudApigeeV1RuntimeAnalyticsConfig + description: Runtime configuration for the Analytics add-on. + type: object + properties: + billingPipelineEnabled: + description: If Runtime should send billing data to AX or not. + type: boolean + enabled: + description: If the Analytics is enabled or not. + type: boolean + GoogleCloudApigeeV1FlowHookConfig: + id: GoogleCloudApigeeV1FlowHookConfig + type: object + properties: + name: + type: string + description: >- + Name of the flow hook in the following format: + `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid + `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, + `PreTargetFlowHook`, and `PostTargetFlowHook` + sharedFlowName: + description: >- + Name of the shared flow to invoke in the following format: + `organizations/{org}/sharedflows/{sharedflow}` + type: string + continueOnError: + description: >- + Flag that specifies whether the flow should abort after an error in + the flow hook. Defaults to `true` (continue on error). + type: boolean + GoogleCloudApigeeV1ListApiProxiesResponse: + properties: + proxies: items: - type: string - description: Not used by Apigee. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' type: array - apigeeProjectId: - readOnly: true - description: >- - Output only. Apigee Project ID associated with the organization. Use - this project to allowlist Apigee in the Service Attachment when - using private service connect with Apigee. + type: object + id: GoogleCloudApigeeV1ListApiProxiesResponse + GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: + id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + description: Action context are all the relevant details for the action. + properties: + documentationLink: type: string - runtimeType: - enum: - - RUNTIME_TYPE_UNSPECIFIED - - CLOUD - - HYBRID - enumDescriptions: - - Runtime type not specified. - - Google-managed Apigee runtime. - - User-managed Apigee hybrid runtime. + description: Documentation link for the action. + type: object + GoogleCloudApigeeV1ProvisionOrganizationRequest: + properties: + runtimeLocation: type: string description: >- - Required. Runtime type of the Apigee organization based on the - Apigee subscription purchased. + Cloud Platform location for the runtime instance. Defaults to zone + `us-west1-a`. If a region is provided, `EVAL` organizations will use + the region for automatically selecting a zone for the runtime + instance. authorizedNetwork: + type: string description: >- Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). - Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The - value must be set before the creation of a runtime instance and can - be updated only when there are no runtime instances. For example: - `default`. Apigee also supports shared VPC (that is, the host - network project is not the same as the one that is peering with - Apigee). See [Shared VPC - overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a - shared VPC network, use the following format: + Apigee also supports shared VPC (that is, the host network project + is not the same as the one that is peering with Apigee). See [Shared + VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use + a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` - **Note:** Not supported for Apigee hybrid. + analyticsRegion: + description: >- + Primary Cloud Platform region for analytics data storage. For valid + values, see [Create an + organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). + Defaults to `us-west1`. + type: string + disableVpcPeering: + description: >- + Optional. Flag that specifies whether the VPC Peering through + Private Google Access should be disabled between the consumer + network and Apigee. Required if an authorizedNetwork on the consumer + project is not provided, in which case the flag should be set to + true. The value must be set before the creation of any Apigee + runtime instance and can be updated only when there are no runtime + instances. **Note:** Apigee will be deprecating the vpc peering + model that requires you to provide 'authorizedNetwork', by making + the non-peering model as the default way of provisioning Apigee + organization in future. So, this will be a temporary flag to enable + the transition. Not supported for Apigee hybrid. + type: boolean + description: Request for ProvisionOrganization. + id: GoogleCloudApigeeV1ProvisionOrganizationRequest + type: object + GoogleCloudApigeeV1OperationMetadata: + type: object + description: Metadata describing an Operation. + properties: + state: + enumDescriptions: + - '' + - '' + - '' + - '' type: string - type: - description: Not used by Apigee. enum: - - TYPE_UNSPECIFIED - - TYPE_TRIAL - - TYPE_PAID - - TYPE_INTERNAL + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED + targetResourceName: type: string + description: Name of the resource for which the operation is operating on. + operationType: enumDescriptions: - - Subscription type not specified. - - >- - Subscription to Apigee is free, limited, and used for evaluation - purposes only. - - >- - Full subscription to Apigee has been purchased. See [Apigee - pricing](https://cloud.google.com/apigee/pricing/). - - For internal users only. - environments: - type: array + - '' + - '' + - '' + - '' + enum: + - OPERATION_TYPE_UNSPECIFIED + - INSERT + - DELETE + - UPDATE + type: string + warnings: items: type: string + description: Warnings encountered while executing the operation. + type: array + progress: + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' + description: Progress of the operation. + id: GoogleCloudApigeeV1OperationMetadata + GoogleCloudApigeeV1ListSharedFlowsResponse: + properties: + sharedFlows: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + type: array + type: object + id: GoogleCloudApigeeV1ListSharedFlowsResponse + GoogleCloudApigeeV1CanaryEvaluation: + properties: + createTime: + type: string readOnly: true - description: Output only. List of environments in the Apigee organization. - subscriptionPlan: - enumDescriptions: - - Subscription plan not specified. - - Traditional subscription plan. - - >- - New subscription plan that provides standard proxy and scaled - proxy implementation. + description: Output only. Create time of the canary evaluation. + format: google-datetime + control: type: string + description: Required. The stable version that is serving requests. + endTime: + format: google-datetime + description: Required. End time for the evaluation's analysis. + type: string + metricLabels: + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' description: >- - Output only. Subscription plan that the customer has purchased. - Output only. + Required. Labels used to filter the metrics used for a canary + evaluation. + startTime: + format: google-datetime + description: Required. Start time for the canary evaluation's analysis. + type: string + verdict: + type: string + description: >- + Output only. The resulting verdict of the canary evaluations: NONE, + PASS, or FAIL. readOnly: true + enumDescriptions: + - Verdict is not available yet. + - No verdict reached. + - Evaluation is not good. + - Evaluation is good. enum: - - SUBSCRIPTION_PLAN_UNSPECIFIED - - SUBSCRIPTION_2021 - - SUBSCRIPTION_2024 + - VERDICT_UNSPECIFIED + - NONE + - FAIL + - PASS + treatment: + description: Required. The newer version that is serving requests. + type: string + name: + readOnly: true + description: Output only. Name of the canary evalution. + type: string state: - description: >- - Output only. State of the organization. Values other than ACTIVE - means the resource is not ready to use. + readOnly: true + description: Output only. The current state of the canary evaluation. type: string enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. + - No state has been specified. + - The canary evaluation is still in progress. + - The canary evaluation has finished. enum: - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - readOnly: true - displayName: - type: string - description: >- - Display name for the Apigee organization. Unused, but reserved for - future use. - customerName: - description: Not used by Apigee. - type: string - description: - description: Description of the Apigee organization. - type: string - controlPlaneEncryptionKeyName: - type: string - description: >- - Cloud KMS key name used for encrypting control plane data that is - stored in a multi region. Only used for the data residency region - "US" or "EU". If not specified or [BillingType](#BillingType) is - `EVALUATION`, a Google-Managed encryption key will be used. Format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*` - name: - description: Output only. Name of the Apigee organization. - type: string - readOnly: true - subscriptionType: - type: string - enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAID - - TRIAL - readOnly: true - deprecated: true - enumDescriptions: - - Subscription type not specified. - - Full subscription to Apigee has been purchased. - - >- - Subscription to Apigee is free, limited, and used for evaluation - purposes only. - description: >- - Output only. DEPRECATED: This will eventually be replaced by - BillingType. Subscription type of the Apigee organization. Valid - values include trial (free, limited, and for evaluation purposes - only) or paid (full subscription has been purchased). See [Apigee - pricing](https://cloud.google.com/apigee/pricing/). - id: GoogleCloudApigeeV1Organization - GoogleCloudApigeeV1Attribute: + - RUNNING + - SUCCEEDED + description: >- + CanaryEvaluation represents the canary analysis between two versions of + the runtime that is serving requests. + id: GoogleCloudApigeeV1CanaryEvaluation + type: object + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: + description: Revisions deployed in the MPs. properties: - name: - type: string - description: API key of the attribute. - value: - description: Value of the attribute. + revision: type: string - description: Key-value pair to store extra metadata. + description: API proxy revision reported as deployed. + percentage: + description: Percentage of MP replicas reporting this revision. + type: integer + format: int32 type: object - id: GoogleCloudApigeeV1Attribute - GoogleCloudApigeeV1ListDatastoresResponse: - description: The response for ListDatastores - id: GoogleCloudApigeeV1ListDatastoresResponse - properties: - datastores: - description: A list of datastores - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: type: object - GoogleCloudApigeeV1ScoreComponent: properties: - calculateTime: - type: string - description: Time when score was calculated. - format: google-datetime - dataCaptureTime: + dataUpdateTime: type: string description: >- - Time in the requested time period when data was last captured to - compute the score. + The time when resource data was last fetched for this resource. This + time may be different than when the resource was actually updated + due to lag in data collection. format: google-datetime + assessmentRecommendations: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + type: object + description: >- + The recommendations of the assessment. The key is the "name" of the + assessment (not display_name), and the value are the + recommendations. + failedAssessmentPerWeight: + additionalProperties: + type: integer + format: int32 + description: >- + The number of failed assessments grouped by its weight. Keys are one + of the following: "MAJOR", "MODERATE", "MINOR". + type: object + severity: + enumDescriptions: + - Severity is not defined. + - Severity is low. + - Severity is medium. + - Severity is high. + - Severity is minimal + enum: + - SEVERITY_UNSPECIFIED + - LOW + - MEDIUM + - HIGH + - MINIMAL + description: The severity of the assessment. + type: string score: - description: Score for the component. format: int32 + description: The security score of the assessment. type: integer - recommendations: - type: array - description: List of recommendations to improve API security. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation - scorePath: - type: string - description: >- - Path of the component. Example: - /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy - drilldownPaths: + id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + description: The result of the assessment. + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: + description: Response for BatchUpdateSecurityIncident. + properties: + securityIncidents: type: array + description: Output only. Updated security incidents + readOnly: true items: - type: string - description: List of paths for next components. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' type: object - id: GoogleCloudApigeeV1ScoreComponent - description: Component is an individual security element that is scored. - GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + GoogleCloudApigeeV1Developer: + id: GoogleCloudApigeeV1Developer properties: - scores: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Score' - description: List of scores. One score per day. + companies: type: array - nextPageToken: - description: >- - A page token, received from a previous `ComputeScore` call. Provide - this to retrieve the subsequent page. - type: string - description: Response for ComputeEnvironmentScores. - type: object - id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse - GoogleCloudApigeeV1ListInstanceAttachmentsResponse: - description: Response for ListInstanceAttachments. - type: object - id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse - properties: - attachments: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' - description: Attachments for the instance. - type: array - nextPageToken: + type: string + description: List of companies associated with the developer. + status: type: string description: >- - Page token that you can include in a ListInstanceAttachments request - to retrieve the next page of content. If omitted, no subsequent - pages exist. - GoogleCloudApigeeV1RuntimeApiSecurityConfig: - type: object - description: Runtime configuration for the API Security add-on. - id: GoogleCloudApigeeV1RuntimeApiSecurityConfig - properties: - enabled: - type: boolean - description: If the API Security is enabled or not. - GoogleCloudApigeeV1EnvironmentGroupConfig: - properties: - hostnames: - description: Host names for the environment group. - type: array + Output only. Status of the developer. Valid values are `active` and + `inactive`. + readOnly: true + developerId: + description: >- + ID of the developer. **Note**: IDs are generated internally by + Apigee and are not guaranteed to stay the same over time. + type: string + apps: items: type: string - endpointChainingRules: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' - description: A list of proxies in each deployment group for proxy chaining calls. - type: array - routingRules: type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' - description: >- - Ordered list of routing rules defining how traffic to this - environment group's hostnames should be routed to different - environments. - revisionId: + description: List of apps associated with the developer. + createdAt: description: >- - Revision id that defines the ordering of the EnvironmentGroupConfig - resource. The higher the revision, the more recently the - configuration was deployed. + Output only. Time at which the developer was created in milliseconds + since epoch. + readOnly: true format: int64 type: string - name: + email: type: string description: >- - Name of the environment group in the following format: - `organizations/{org}/envgroups/{envgroup}`. - location: - description: >- - When this message appears in the top-level IngressConfig, this field - will be populated in lieu of the inlined routing_rules and hostnames - fields. Some URL for downloading the full EnvironmentGroupConfig for - this group. + Required. Email address of the developer. This value is used to + uniquely identify the developer in Apigee hybrid. Note that the + email address has to be in lowercase only. + appFamily: type: string - uid: - description: >- - A unique id for the environment group config that will only change - if the environment group is deleted and recreated. + description: Developer app family. + firstName: + description: Required. First name of the developer. type: string - id: GoogleCloudApigeeV1EnvironmentGroupConfig - description: >- - EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup - and its associated routing rules. - type: object - GoogleCloudApigeeV1ListDeveloperAppsResponse: - id: GoogleCloudApigeeV1ListDeveloperAppsResponse - properties: - app: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' - description: List of developer apps and their credentials. + userName: + description: Required. User name of the developer. Not used by Apigee hybrid. + type: string + organizationName: + type: string + description: >- + Output only. Name of the Apigee organization in which the developer + resides. + readOnly: true + attributes: + description: >- + Optional. Developer attributes (name/value pairs). The custom + attribute limit is 18. type: array - type: object - GoogleCloudApigeeV1GraphQLOperation: - id: GoogleCloudApigeeV1GraphQLOperation - description: >- - Represents the pairing of GraphQL operation types and the GraphQL - operation name. - type: object - properties: - operationTypes: items: - type: string - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + lastModifiedAt: description: >- - Required. GraphQL operation types. Valid values include `query` or - `mutation`. **Note**: Apigee does not currently support - `subscription` types. - operation: + Output only. Time at which the developer was last modified in + milliseconds since epoch. + type: string + format: int64 + readOnly: true + accessType: + type: string + description: Access type. + lastName: + description: Required. Last name of the developer. type: string - description: >- - GraphQL operation name. The name and operation type will be used to - apply quotas. If no name is specified, the quota will be applied to - all GraphQL operations irrespective of their operation names in the - payload. - GoogleCloudApigeeV1DatastoreConfig: - id: GoogleCloudApigeeV1DatastoreConfig type: object - description: Configuration detail for datastore + GoogleCloudApigeeV1SecurityReportQuery: properties: - path: - description: Path of Cloud Storage bucket Required for `gcs` target_type. + envgroupHostname: type: string - bucketName: - description: Name of the Cloud Storage bucket. Required for `gcs` target_type. + description: >- + Hostname needs to be specified if query intends to run at host + level. This field is only allowed when query is submitted by + CreateHostSecurityReport where analytics data will be grouped by + organization and hostname. + displayName: type: string - tablePrefix: + description: Security Report display name which users can specify. + groupByTimeUnit: type: string - description: Prefix of BigQuery table Required for `bigquery` target_type. - projectId: + description: >- + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. + limit: + description: Maximum number of rows that can be returned in the result. + type: integer + format: int32 + timeRange: + type: any + description: >- + Required. Time range for the query. Can use the following predefined + strings to specify the time range: `last60minutes` `last24hours` + `last7days` Or, specify the timeRange as a structure describing + start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": + "2018-08-01T00:18:00Z" } + reportDefinitionId: + description: Report Definition ID. type: string - description: Required. GCP project in which the datastore exists - datasetName: + filter: + description: >- + Boolean expression that can be used to filter data. Filter + expressions can be combined using AND/OR terms and should be fully + parenthesized to avoid ambiguity. See Analytics metrics, dimensions, + and filters reference + https://docs.apigee.com/api-platform/analytics/analytics-reference + for more information on the fields available to filter on. For more + information on the tokens that you use to build filter expressions, + see Filter expression syntax. + https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax type: string - description: BigQuery dataset name Required for `bigquery` target_type. - GoogleCloudApigeeV1ListKeyValueEntriesResponse: - id: GoogleCloudApigeeV1ListKeyValueEntriesResponse - properties: - nextPageToken: + csvDelimiter: description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). type: string - keyValueEntries: - description: One or more key value map keys and values. + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' + type: array + description: A list of Metrics. + dimensions: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + type: string + description: >- + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + mimeType: + type: string + description: >- + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. + description: Body structure when user makes a request to create a security report. + id: GoogleCloudApigeeV1SecurityReportQuery type: object - description: >- - The request structure for listing key value map keys and its - corresponding values. - GoogleCloudApigeeV1ApiProxyRevision: + GoogleCloudApigeeV1CustomReportMetric: properties: name: - description: Name of the API proxy. type: string - targetEndpoints: + description: name of the metric + function: + type: string + description: aggregate function + description: >- + This encapsulates a metric property of the form sum(message_count) where + name is message_count and function is sum + id: GoogleCloudApigeeV1CustomReportMetric + type: object + GoogleCloudApigeeV1AsyncQueryResult: + type: object + properties: + expires: + description: Query result will be unaccessable after this time. + type: string + self: + type: string description: >- - List of TargetEndpoints in the `/targets` directory of the API - proxy. Typically, this element is included only when the API proxy - was created using the Edge UI. This is a 'manifest' setting designed - to provide visibility into the contents of the API proxy. - type: array - items: - type: string - targetServers: + Self link of the query results. Example: + `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + or following format if query is running at host level: + `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + id: GoogleCloudApigeeV1AsyncQueryResult + GoogleCloudApigeeV1NodeConfig: + properties: + minNodeCount: description: >- - List of TargetServers referenced in any TargetEndpoint in the API - proxy. Typically, you will see this element only when the API proxy - was created using the Edge UI. This is a 'manifest' setting designed - to provide visibility into the contents of the API proxy. - items: - type: string - type: array - contextInfo: + Optional. The minimum total number of gateway nodes that the is + reserved for all instances that has the specified environment. If + not specified, the default is determined by the recommended minimum + number of nodes for that gateway. type: string - description: Revision number, app name, and organization for the API proxy. - type: + format: int64 + currentAggregateNodeCount: + format: int64 description: >- - Type. Set to `Application`. Maintained for compatibility with the - Apigee Edge API. + Output only. The current total number of gateway nodes that each + environment currently has across all instances. + readOnly: true type: string - resources: - items: - type: string - type: array + maxNodeCount: description: >- - List of the resources included in the API proxy revision formatted - as "{type}://{name}". - archive: + Optional. The maximum total number of gateway nodes that the is + reserved for all instances that has the specified environment. If + not specified, the default is determined by the recommended maximum + number of nodes for that gateway. + type: string + format: int64 + type: object + description: >- + NodeConfig for setting the min/max number of nodes associated with the + environment. + id: GoogleCloudApigeeV1NodeConfig + GoogleCloudApigeeV1KeyValueMap: + description: Collection of key/value string pairs. + type: object + id: GoogleCloudApigeeV1KeyValueMap + properties: + encrypted: + type: boolean description: >- - Output only. The archive that generated this proxy revision. This - field is only present on proxy revisions that were generated by an - archive. Proxies generated by archives cannot be updated, deleted, - or deployed to other environments. Format: - `organizations/*/environments/*/archiveDeployments/*` + Required. Flag that specifies whether entry values will be + encrypted. This field is retained for backward compatibility and the + value of encrypted will always be `true`. Apigee X and hybrid do not + support unencrypted key value maps. + name: type: string - readOnly: true - sharedFlows: - items: - type: string + description: Required. ID of the key value map. + GoogleCloudApigeeV1Properties: + id: GoogleCloudApigeeV1Properties + properties: + property: + description: List of all properties in the object type: array - description: List of the shared flows included in the API proxy revision. - proxyEndpoints: items: - type: string - type: array - description: >- - List of ProxyEndpoints in the `/proxies` directory of the API proxy. - Typically, this element is included only when the API proxy was - created using the Edge UI. This is a 'manifest' setting designed to - provide visibility into the contents of the API proxy. - revision: - description: API proxy revision. - type: string - entityMetaDataAsProperties: - description: Metadata describing the API proxy revision as a key-value map. - type: object - additionalProperties: - type: string - configurationVersion: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' - description: >- - Version of the API proxy configuration schema to which the API proxy - conforms. Currently, the only supported value is 4.0 - (`majorVersion.minorVersion`). This setting may be used in the - future to track the evolution of the API proxy format. - targets: - description: List of the targets included in the API proxy revision. - items: - type: string - type: array - basepaths: - description: Base URL of the API proxy. + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + description: >- + Message for compatibility with legacy Edge specification for Java + Properties object in JSON. + type: object + GoogleCloudApigeeV1SecurityActionHttpHeader: + properties: + value: + type: string + description: The header value to be sent to the target. + name: + type: string + description: The header name to be sent to the target. + id: GoogleCloudApigeeV1SecurityActionHttpHeader + type: object + description: An HTTP header. + GoogleCloudApigeeV1SecurityProfile: + type: object + id: GoogleCloudApigeeV1SecurityProfile + description: Represents a SecurityProfile resource. + properties: + scoringConfigs: + description: List of profile scoring configs in this revision. items: - type: string + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig type: array - lastModifiedAt: + profileConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' + description: >- + Required. Customized profile configuration that computes the + security score. + displayName: + type: string + description: 'DEPRECATED: DO NOT USE Display name of the security profile.' + deprecated: true + revisionPublishTime: + readOnly: true + type: string + description: >- + Output only. DEPRECATED: DO NOT USE The time when revision was + published. Once published, the security profile revision cannot be + updated further and can be attached to environments. + deprecated: true + format: google-datetime + minScore: + format: int32 + description: >- + Output only. Minimum security score that can be generated by this + profile. + readOnly: true + type: integer + revisionId: + readOnly: true format: int64 + type: string + description: Output only. Revision ID of the security profile. + name: type: string description: >- - Time that the API proxy revision was last modified in milliseconds - since epoch. - policies: + Immutable. Name of the security profile resource. Format: + organizations/{org}/securityProfiles/{profile} + description: + type: string + description: Description of the security profile. + maxScore: + format: int32 + description: >- + Output only. Maximum security score that can be generated by this + profile. + readOnly: true + type: integer + environments: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' + description: List of environments attached to security profile. + type: array + revisionCreateTime: + description: Output only. The time when revision was created. + readOnly: true + type: string + format: google-datetime + revisionUpdateTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The time when revision was updated. + GoogleCloudApigeeV1DeveloperMonetizationConfig: + properties: + billingType: + description: Billing type. + type: string + enumDescriptions: + - The default/unset value. + - >- + Developer pays in advance for the use of APIs and the charged + amount is deducted from their account balance. + - >- + Developer does not maintain an account balance. The API provider + bills the developer for API usage. + enum: + - BILLING_TYPE_UNSPECIFIED + - PREPAID + - POSTPAID + type: object + description: Monetization configuration for the developer. + id: GoogleCloudApigeeV1DeveloperMonetizationConfig + GoogleCloudApigeeV1ResourceFiles: + id: GoogleCloudApigeeV1ResourceFiles + description: List of resource files. + type: object + properties: + resourceFile: type: array + description: List of resource files. items: - type: string - description: List of policy names included in the API proxy revision.. - integrationEndpoints: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + GoogleCloudApigeeV1App: + type: object + id: GoogleCloudApigeeV1App + properties: + credentials: + type: array + readOnly: true description: >- - List of IntegrationEndpoints in the '/integration-endpoints' - directory of the API proxy. This is a 'manifest' setting designed to - provide visibility into the contents of the API proxy. + Output only. Set of credentials for the app. Credentials are API + key/secret pairs associated with API products. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + apiProducts: type: array + description: List of API products associated with the app. items: - type: string - displayName: - description: Human-readable name of the API proxy. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + name: + description: Name of the app. type: string - description: + appId: type: string - description: Description of the API proxy revision. - resourceFiles: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - description: List of resource files included in the API proxy revision. - hasExtensiblePolicy: - readOnly: true - type: boolean + description: ID of the app. + keyExpiresIn: + format: int64 description: >- - Output only. This field will be marked as true if revision contains - any policies marked as extensible. - teams: + Duration, in milliseconds, of the consumer key that will be + generated for the app. The default value, -1, indicates an infinite + validity period. Once set, the expiration can't be updated. json + key: keyExpiresIn + type: string + developerEmail: + type: string + description: Email of the developer. + appGroup: + description: Name of the AppGroup + type: string + companyName: + type: string + description: Name of the company that owns the app. + status: + type: string + description: Status of the credential. + attributes: + description: List of attributes. type: array items: - type: string - description: List of the teams included in the API proxy revision. - proxies: - items: - type: string - description: List of proxy names included in the API proxy revision. + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + lastModifiedAt: + description: Output only. Last modified time as milliseconds since epoch. + readOnly: true + type: string + format: int64 + developerId: + type: string + description: ID of the developer. + scopes: type: array - spec: description: >- - OpenAPI Specification that is associated with the API proxy. The - value is set to a URL or to a path in the specification store. - type: string + Scopes to apply to the app. The specified scope names must already + exist on the API product that you associate with the app. + items: + type: string createdAt: + type: string format: int64 + readOnly: true + description: Output only. Unix time when the app was created. + callbackUrl: type: string description: >- - Time that the API proxy revision was created in milliseconds since - epoch. - id: GoogleCloudApigeeV1ApiProxyRevision - description: API proxy revision. - type: object - GoogleCloudApigeeV1UpdateError: - id: GoogleCloudApigeeV1UpdateError - type: object + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to apps. + GoogleCloudApigeeV1DeploymentChangeReport: properties: - resource: - description: >- - The sub resource specific to this error (e.g. a proxy deployed - within the EnvironmentConfig). If empty the error refers to the top - level resource. - type: string - message: - description: User-friendly error message. - type: string - type: - type: string + validationErrors: + $ref: '#/components/schemas/GoogleRpcPreconditionFailure' description: >- - A string that uniquely identifies the type of error. This provides a - more reliable means to deduplicate errors across revisions and - instances. - code: - enumDescriptions: - - 'Not an error; returned on success. HTTP Mapping: 200 OK' - - >- - The operation was cancelled, typically by the caller. HTTP - Mapping: 499 Client Closed Request - - >- - Unknown error. For example, this error may be returned when a - `Status` value received from another address space belongs to an - error space that is not known in this address space. Also errors - raised by APIs that do not return enough error information may be - converted to this error. HTTP Mapping: 500 Internal Server Error - - >- - The client specified an invalid argument. Note that this differs - from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments - that are problematic regardless of the state of the system (e.g., - a malformed file name). HTTP Mapping: 400 Bad Request - - >- - The deadline expired before the operation could complete. For - operations that change the state of the system, this error may be - returned even if the operation has completed successfully. For - example, a successful response from a server could have been - delayed long enough for the deadline to expire. HTTP Mapping: 504 - Gateway Timeout - - >- - Some requested entity (e.g., file or directory) was not found. - Note to server developers: if a request is denied for an entire - class of users, such as gradual feature rollout or undocumented - allowlist, `NOT_FOUND` may be used. If a request is denied for - some users within a class of users, such as user-based access - control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not - Found - - >- - The entity that a client attempted to create (e.g., file or - directory) already exists. HTTP Mapping: 409 Conflict - - >- - The caller does not have permission to execute the specified - operation. `PERMISSION_DENIED` must not be used for rejections - caused by exhausting some resource (use `RESOURCE_EXHAUSTED` - instead for those errors). `PERMISSION_DENIED` must not be used if - the caller can not be identified (use `UNAUTHENTICATED` instead - for those errors). This error code does not imply the request is - valid or the requested entity exists or satisfies other - pre-conditions. HTTP Mapping: 403 Forbidden - - >- - The request does not have valid authentication credentials for the - operation. HTTP Mapping: 401 Unauthorized - - >- - Some resource has been exhausted, perhaps a per-user quota, or - perhaps the entire file system is out of space. HTTP Mapping: 429 - Too Many Requests - - >- - The operation was rejected because the system is not in a state - required for the operation's execution. For example, the directory - to be deleted is non-empty, an rmdir operation is applied to a - non-directory, etc. Service implementors can use the following - guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and - `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just - the failing call. (b) Use `ABORTED` if the client should retry at - a higher level. For example, when a client-specified test-and-set - fails, indicating the client should restart a read-modify-write - sequence. (c) Use `FAILED_PRECONDITION` if the client should not - retry until the system state has been explicitly fixed. For - example, if an "rmdir" fails because the directory is non-empty, - `FAILED_PRECONDITION` should be returned since the client should - not retry unless the files are deleted from the directory. HTTP - Mapping: 400 Bad Request - - >- - The operation was aborted, typically due to a concurrency issue - such as a sequencer check failure or transaction abort. See the - guidelines above for deciding between `FAILED_PRECONDITION`, - `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict - - >- - The operation was attempted past the valid range. E.g., seeking or - reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error - indicates a problem that may be fixed if the system state changes. - For example, a 32-bit file system will generate `INVALID_ARGUMENT` - if asked to read at an offset that is not in the range [0,2^32-1], - but it will generate `OUT_OF_RANGE` if asked to read from an - offset past the current file size. There is a fair bit of overlap - between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend - using `OUT_OF_RANGE` (the more specific error) when it applies so - that callers who are iterating through a space can easily look for - an `OUT_OF_RANGE` error to detect when they are done. HTTP - Mapping: 400 Bad Request - - >- - The operation is not implemented or is not supported/enabled in - this service. HTTP Mapping: 501 Not Implemented - - >- - Internal errors. This means that some invariants expected by the - underlying system have been broken. This error code is reserved - for serious errors. HTTP Mapping: 500 Internal Server Error - - >- - The service is currently unavailable. This is most likely a - transient condition, which can be corrected by retrying with a - backoff. Note that it is not always safe to retry non-idempotent - operations. See the guidelines above for deciding between - `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: - 503 Service Unavailable - - >- - Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal - Server Error - type: string - description: Status code. - enum: - - OK - - CANCELLED - - UNKNOWN - - INVALID_ARGUMENT - - DEADLINE_EXCEEDED - - NOT_FOUND - - ALREADY_EXISTS - - PERMISSION_DENIED - - UNAUTHENTICATED - - RESOURCE_EXHAUSTED - - FAILED_PRECONDITION - - ABORTED - - OUT_OF_RANGE - - UNIMPLEMENTED - - INTERNAL - - UNAVAILABLE - - DATA_LOSS - description: Details on why a resource update failed in the runtime. - GoogleCloudApigeeV1ListHybridIssuersResponse: - properties: - issuers: + Validation errors that would cause the deployment change request to + be rejected. + routingChanges: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + type: array + description: All routing changes that may result from a deployment request. + routingConflicts: + description: All base path conflicts detected for a deployment request. type: array - description: Lists of hybrid services and its trusted issuer email ids. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict type: object - id: GoogleCloudApigeeV1ListHybridIssuersResponse - GoogleCloudApigeeV1RuntimeTraceConfigOverride: + id: GoogleCloudApigeeV1DeploymentChangeReport description: >- - NEXT ID: 7 Trace configuration override for a specific API proxy in an - environment. + Response for GenerateDeployChangeReport and + GenerateUndeployChangeReport. This report contains any validation + failures that would cause the deployment to be rejected, as well changes + and conflicts in routing that may occur due to the new deployment. The + existence of a routing warning does not necessarily imply that the + deployment request is bad, if the desired state of the deployment + request is to effect a routing change. The primary purposes of the + routing messages are: 1) To inform users of routing changes that may + have an effect on traffic currently being routed to other existing + deployments. 2) To warn users if some base path in the proxy will not + receive traffic due to an existing deployment having already claimed + that base path. The presence of routing conflicts/changes will not cause + non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected. + GoogleCloudApigeeV1SchemaSchemaElement: + id: GoogleCloudApigeeV1SchemaSchemaElement + type: object properties: - revisionId: + name: + description: Name of the field. + type: string + properties: description: >- - Revision number which can be used by the runtime to detect if the - trace config override has changed between two versions. + Properties for the schema field. For example: { "createTime": + "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' + description: Message type for the schema element + GoogleCloudApigeeV1DeleteCustomReportResponse: + type: object + properties: + message: type: string - apiProxy: + description: The response contains only a message field. + id: GoogleCloudApigeeV1DeleteCustomReportResponse + GoogleCloudApigeeV1RuntimeAddonsConfig: + type: object + id: GoogleCloudApigeeV1RuntimeAddonsConfig + properties: + revisionId: type: string + description: Revision number used by the runtime to detect config changes. + analyticsConfig: + description: Runtime configuration for Analytics add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' + name: description: >- - Name of the API proxy that will have its trace configuration - overridden following format: `organizations/{org}/apis/{api}` + Name of the addons config in the format: + `organizations/{org}/environments/{env}/addonsConfig` + type: string uid: type: string description: >- - Unique ID for the configuration override. The ID will only change if - the override is deleted and recreated. Corresponds to name's - "override" field. - name: + UID is to detect if config is recreated after deletion. The add-on + config will only be deleted when the environment itself gets + deleted, thus it will always be the same as the UID of + EnvironmentConfig. + apiSecurityConfig: + description: Runtime configuration for API Security add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' + description: >- + RuntimeAddonsConfig defines the runtime configurations for add-ons in an + environment. + GoogleCloudApigeeV1RateRange: + id: GoogleCloudApigeeV1RateRange + properties: + fee: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Name of the trace config override in the following format: - `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` + Fee to charge when total number of API calls falls within this + range. + end: + description: >- + Ending value of the range. Set to 0 or `null` for the last range of + values. type: string - revisionCreateTime: + format: int64 + start: + format: int64 type: string - description: The timestamp that the revision was created or updated. - format: google-datetime - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' description: >- - Trace configuration override for a specific API proxy in an - environment. - id: GoogleCloudApigeeV1RuntimeTraceConfigOverride - type: object - GoogleCloudApigeeV1ListSharedFlowsResponse: - id: GoogleCloudApigeeV1ListSharedFlowsResponse + Starting value of the range. Set to 0 or `null` for the initial + range of values. + description: >- + API call volume range and the fees charged when the total number of API + calls is within the range. type: object + GoogleCloudApigeeV1DebugSessionTransaction: + description: >- + A transaction contains all of the debug information of the entire + message flow of an API call processed by the runtime plane. The + information is collected and recorded at critical points of the message + flow in the runtime apiproxy. properties: - sharedFlows: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + point: + description: >- + List of debug data collected by runtime plane at various defined + points in the flow. type: array - GoogleCloudApigeeV1CertInfo: - id: GoogleCloudApigeeV1CertInfo + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Point' + completed: + type: boolean + description: Flag indicating whether a transaction is completed or not + id: GoogleCloudApigeeV1DebugSessionTransaction type: object - properties: - isValid: - type: string - description: >- - Flag that specifies whether the certificate is valid. Flag is set to - `Yes` if the certificate is valid, `No` if expired, or `Not yet` if - not yet valid. - sigAlgName: - description: X.509 signatureAlgorithm. - type: string - version: - type: integer + GoogleCloudApigeeV1TargetServer: + description: >- + TargetServer configuration. TargetServers are used to decouple a proxy + TargetEndpoint HTTPTargetConnections from concrete URLs for backend + services. + type: object + properties: + isEnabled: + type: boolean + description: >- + Optional. Enabling/disabling a TargetServer is useful when + TargetServers are used in load balancing configurations, and one or + more TargetServers need to taken out of rotation periodically. + Defaults to true. + port: format: int32 - description: X.509 version. - subject: - description: X.509 subject. - type: string - subjectAlternativeNames: - items: - type: string - type: array - description: X.509 subject alternative names (SANs) extension. - validFrom: - description: X.509 `notBefore` validity period in milliseconds since epoch. - type: string - format: int64 - issuer: - description: X.509 issuer. - type: string - basicConstraints: - description: X.509 basic constraints extension. - type: string - publicKey: + description: >- + Required. The port number this target connects to on the given host. + Value must be between 1 and 65535, inclusive. + type: integer + description: type: string - description: Public key component of the X.509 subject public key info. - expiryDate: + description: Optional. A human-readable description of this TargetServer. + sSLInfo: + description: >- + Optional. Specifies TLS configuration info for this TargetServer. + The JSON name is `sSLInfo` for legacy/backwards compatibility + reasons -- Edge originally supported SSL, and the name is still used + for TLS configuration. + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' + host: + description: >- + Required. The host name this target connects to. Value must be a + valid hostname as described by RFC-1123. type: string - description: X.509 `notAfter` validity period in milliseconds since epoch. - format: int64 - serialNumber: - description: X.509 serial number. + protocol: type: string - description: X.509 certificate as defined in RFC 5280. - GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest - description: Request for ComputeEnvironmentScores. - properties: - pageToken: - description: >- - Optional. A token that can be sent as `page_token` to retrieve the - next page. If this field is omitted, there are no subsequent pages. + enum: + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + description: Immutable. The protocol used by this TargetServer. + enumDescriptions: + - UNSPECIFIED defaults to HTTP for backwards compatibility. + - The TargetServer uses HTTP. + - The TargetSever uses HTTP2. + - The TargetServer uses GRPC. + - >- + GRPC TargetServer to be used in ExternalCallout Policy. Prefer to + use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once + EXTERNAL _CALLOUT generally available. + - The TargetServer is to be used in the ExternalCallout Policy + name: type: string - pageSize: description: >- - Optional. The maximum number of subcomponents to be returned in a - single page. The service may return fewer than this value. If - unspecified, at most 100 subcomponents will be returned in a single - page. - type: integer - format: int32 - filters: - description: >- - Optional. Filters are used to filter scored components. Return all - the components if no filter is mentioned. Example: [{ "scorePath": - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - }, { "scorePath": - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", - }] This will return components with path: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - OR - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target" + Required. The resource id of this target server. Values must match + the regular expression + id: GoogleCloudApigeeV1TargetServer + GoogleCloudApigeeV1InstanceDeploymentStatus: + description: The status of a deployment as reported by a single instance. + id: GoogleCloudApigeeV1InstanceDeploymentStatus + type: object + properties: + deployedRevisions: + description: Revisions currently deployed in MPs. + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision type: array + deployedRoutes: items: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute description: >- - Required. Time range for score calculation. At most 14 days of - scores will be returned, and both the start and end dates must be - within the last 90 days. + Current routes deployed in the ingress routing table. A route which + is missing will appear in `missing_routes`. + type: array + instance: + type: string + description: ID of the instance reporting the status. + GoogleCloudApigeeV1ApiDocDocumentation: type: object - GoogleCloudApigeeV1SecurityActionFlag: + description: The documentation for a catalog item. + id: GoogleCloudApigeeV1ApiDocDocumentation + properties: + graphqlDocumentation: + description: Optional. GraphQL documentation. + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' + oasDocumentation: + description: Optional. OpenAPI Specification documentation. + $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' + GoogleCloudApigeeV1GrpcOperationConfig: + id: GoogleCloudApigeeV1GrpcOperationConfig type: object - id: GoogleCloudApigeeV1SecurityActionFlag - description: The message that should be set in the case of a Flag action. properties: - headers: + apiSource: description: >- - Optional. A list of HTTP headers to be sent to the target in case of - a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least - one is mandatory. + Required. Name of the API proxy with which the gRPC operation and + quota are associated. + type: string + methods: + description: >- + List of unqualified gRPC method names for the proxy to which quota + will be applied. If this field is empty, the Quota will apply to all + operations on the gRPC service defined on the proxy. Example: Given + a proxy that is configured to serve com.petstore.PetService, the + methods com.petstore.PetService.ListPets and + com.petstore.PetService.GetPet would be specified here as simply + ["ListPets", "GetPet"]. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' - GoogleCloudApigeeV1ExportRequest: - description: Request body for [CreateExportRequest] - type: object - properties: - datastoreName: + type: string + service: type: string - description: Required. Name of the preconfigured datastore. - outputFormat: description: >- - Optional. Output format of the export. Valid values include: `csv` - or `json`. Defaults to `json`. Note: Configure the delimiter for CSV - output using the `csvDelimiter` property. - type: string - dateRange: - description: Required. Date range of the data to export. - $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' - description: - description: Optional. Description of the export job. - type: string - csvDelimiter: + Required. gRPC Service name associated to be associated with the API + proxy, on which quota rules can be applied upon. + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' description: >- - Optional. Delimiter used in the CSV file, if `outputFormat` is set - to `csv`. Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - type: string - name: - type: string - description: Required. Display name of the export job. - id: GoogleCloudApigeeV1ExportRequest - GoogleCloudApigeeV1DataCollectorConfig: + Quota parameters to be enforced for the methods and API source + combination. If none are specified, quota enforcement will not be + done. + attributes: + description: Custom attributes associated with the operation. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + description: >- + Binds the resources in a proxy or remote service with the gRPC operation + and its associated quota enforcement. + GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: + properties: {} + type: object + id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + description: Request for ExpireDeveloperSubscription. + GoogleCloudApigeeV1Property: properties: - type: - enumDescriptions: - - For future compatibility. - - For integer values. - - For float values. - - For string values. - - For boolean values. - - For datetime values. - description: Data type accepted by the data collector. - enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME - type: string name: - description: >- - Name of the data collector in the following format: - `organizations/{org}/datacollectors/{datacollector}` + description: The property key type: string - id: GoogleCloudApigeeV1DataCollectorConfig - description: Data collector and its configuration. + value: + type: string + description: The property value + id: GoogleCloudApigeeV1Property type: object - GoogleCloudApigeeV1ApiSecurityRuntimeConfig: + description: A single property entry in the Properties message. + GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: + description: Request for AdjustDeveloperBalance. type: object - description: >- - Response for - GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. + id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest properties: - revisionId: - format: int64 - description: >- - Revision ID of the API Security Runtime configuration. The higher - the value, the more recently the configuration was deployed. - type: string - name: + adjustment: description: >- - Name of the environment API Security Runtime configuration resource. - Format: - `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` - type: string - updateTime: - description: Time that the API Security Runtime configuration was updated. - format: google-datetime - type: string - uid: + * A positive value of `adjustment` means that that the API provider + wants to adjust the balance for an under-charged developer i.e. the + balance of the developer will decrease. * A negative value of + `adjustment` means that that the API provider wants to adjust the + balance for an over-charged developer i.e. the balance of the + developer will increase. + $ref: '#/components/schemas/GoogleTypeMoney' + GoogleCloudApigeeV1Schema: + type: object + properties: + dimensions: + type: array + description: List of schema fields grouped as dimensions. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + meta: description: >- - Unique ID for the API Security Runtime configuration. The ID will - only change if the environment is deleted and recreated. - type: string - location: - description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. + Additional metadata associated with schema. This is a legacy field + and usually consists of an empty array of strings. + type: array items: type: string + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + description: >- + List of schema fields grouped as dimensions that can be used with an + aggregate function such as `sum`, `avg`, `min`, and `max`. type: array - id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig - GoogleCloudApigeeV1Session: - type: object - id: GoogleCloudApigeeV1Session - description: Session carries the debug session id and its creation time. + id: GoogleCloudApigeeV1Schema + description: Response for Schema call + GoogleCloudApigeeV1SecurityIncident: + id: GoogleCloudApigeeV1SecurityIncident properties: - timestampMs: + riskLevel: + enum: + - RISK_LEVEL_UNSPECIFIED + - LOW + - MODERATE + - SEVERE + readOnly: true + enumDescriptions: + - Risk Level Unspecified. + - Risk level of the incident is low. + - Risk level of the incident is moderate. + - Risk level of the incident is severe. type: string - description: >- - The first transaction creation timestamp in millisecond, recorded by - UAP. + description: Output only. Risk level of the incident. + trafficCount: format: int64 - id: type: string - description: The debug session ID. - GoogleCloudApigeeV1CreditDeveloperBalanceRequest: - description: Request for CreditDeveloperBalance. - properties: - transactionId: + description: Total traffic detected as part of the incident. + displayName: + description: Optional. Display name of the security incident. type: string + lastDetectedTime: description: >- - Each transaction_id uniquely identifies a credit balance request. If - multiple requests are received with the same transaction_id, only - one of them will be considered. - transactionAmount: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - The amount of money to be credited. The wallet corresponding to the - currency specified within `transaction_amount` will be updated. For - example, if you specified `currency_code` within - `transaction_amount` as "USD", then the amount would be added to the - wallet which has the "USD" currency or if no such wallet exists, a - new wallet will be created with the "USD" currency. - id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest - type: object - EdgeConfigstoreBundleBadBundleViolation: - properties: - filename: + Output only. The time when events associated with the incident were + last detected. + format: google-datetime + readOnly: true type: string + detectionTypes: + type: array + items: + type: string description: >- - The filename (including relative path from the bundle root) in which - the error occurred. - description: - description: A description of why the bundle is invalid and how to fix it. - type: string - description: A message type used to describe a single bundle validation error. - id: EdgeConfigstoreBundleBadBundleViolation - type: object - GoogleCloudApigeeV1InstanceAttachment: - description: >- - InstanceAttachment represents the installation of an environment onto an - instance. - id: GoogleCloudApigeeV1InstanceAttachment - type: object - properties: + Output only. Detection types which are part of the incident. + Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly + Detection. + readOnly: true name: type: string - readOnly: true - description: Output only. ID of the attachment. - createdAt: description: >- - Output only. Time the attachment was created in milliseconds since - epoch. + Immutable. Name of the security incident resource. Format: + organizations/{org}/environments/{environment}/securityIncidents/{incident} + Example: + organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 + lastObservabilityChangeTime: type: string - format: int64 + description: >- + Output only. The time when the incident observability was last + changed. + format: google-datetime readOnly: true - environment: - description: ID of the attached environment. + firstDetectedTime: + format: google-datetime type: string - GoogleCloudApigeeV1ConnectorsPlatformConfig: - properties: - expiresAt: + description: >- + Output only. The time when events associated with the incident were + first detected. readOnly: true - format: int64 + observability: + enum: + - OBSERVABILITY_UNSPECIFIED + - ACTIVE + - ARCHIVED + description: Optional. Indicates if the user archived this incident. + enumDescriptions: + - The incident observability is unspecified. + - >- + The incident is currently active. Can change to this status from + archived. + - >- + The incident is currently archived and was archived by the + customer. type: string - description: >- - Output only. Time at which the Connectors Platform add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. - enabled: - description: >- - Flag that specifies whether the Connectors Platform add-on is - enabled. - type: boolean type: object - id: GoogleCloudApigeeV1ConnectorsPlatformConfig - description: Configuration for the Connectors Platform add-on. - GoogleCloudApigeeV1RatePlan: + description: Represents an SecurityIncident resource. + GoogleCloudApigeeV1DeleteResponse: + type: object properties: - endTime: - description: >- - Time when the rate plan will expire in milliseconds since epoch. Set - to 0 or `null` to indicate that the rate plan should never expire. - type: string - format: int64 - displayName: - description: Display name of the rate plan. + message: type: string - fixedFeeFrequency: - format: int32 - type: integer - description: Frequency at which the fixed fee is charged. - name: - description: Output only. Name of the rate plan. - readOnly: true + description: Description of the operation. + status: + description: Status of the operation. type: string - description: - description: Description of the rate plan. + errorCode: + description: Unique error code for the request, if any. type: string - currencyCode: - description: >- - Currency to be used for billing. Consists of a three-letter code as - defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) - standard. + requestId: type: string - createdAt: + description: Unique ID of the request. + gcpResource: type: string - readOnly: true + description: Google Cloud name of deleted resource. + id: GoogleCloudApigeeV1DeleteResponse + description: Response for certain delete operations. + GoogleCloudApigeeV1TlsInfoConfig: + properties: + clientAuthEnabled: description: >- - Output only. Time that the rate plan was created in milliseconds - since epoch. - format: int64 - fixedRecurringFee: + Flag that specifies whether client-side authentication is enabled + for the target server. Enables two-way TLS. + type: boolean + ignoreValidationErrors: description: >- - Fixed amount that is charged at a defined interval and billed in - advance of use of the API product. The fee will be prorated for the - first billing period. - $ref: '#/components/schemas/GoogleTypeMoney' - consumptionPricingRates: + Flag that specifies whether to ignore TLS certificate validation + errors. Set to `true` to ignore errors. + type: boolean + ciphers: + items: + type: string type: array + description: List of ciphers that are granted access. + trustStore: + type: string description: >- - API call volume ranges and the fees charged when the total number of - API calls is within a given range. The method used to calculate the - final fee depends on the selected pricing model. For example, if the - pricing model is `STAIRSTEP` and the ranges are defined as follows: - ``` { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": - 200, "fee": 100 }, } ``` Then the following fees would be charged - based on the total number of API calls (assuming the currency - selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 - calls cost $100 The number of API calls cannot exceed 200. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' - state: + Name of the keystore or keystore reference containing trusted + certificates for the server in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` or + `organizations/{org}/environments/{env}/references/{reference}` + keyAlias: + description: >- + Name of the alias used for client-side authentication in the + following format: + `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` type: string - description: Current state of the rate plan (draft or published). - enumDescriptions: - - State of the rate plan is not specified. - - Rate plan is in draft mode and only visible to API providers. - - >- - Rate plan is published and will become visible to developers for - the configured duration (between `startTime` and `endTime`). - enum: - - STATE_UNSPECIFIED - - DRAFT - - PUBLISHED - revenueShareRates: + protocols: + description: List of TLS protocols that are granted access. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' - description: Details of the revenue sharing model. - lastModifiedAt: - readOnly: true + type: string + enabled: + type: boolean description: >- - Output only. Time the rate plan was last modified in milliseconds - since epoch. - type: string - format: int64 - paymentFundingModel: + Flag that specifies whether one-way TLS is enabled. Set to `true` to + enable one-way TLS. + keyAliasReference: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' + description: Reference name and alias pair to use for client-side authentication. + enforce: + type: boolean + description: Flag that enforces TLS settings + commonName: + description: Common name to validate the target server against. + $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' + type: object + id: GoogleCloudApigeeV1TlsInfoConfig + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + id: GoogleRpcStatus + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + details: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - DEPRECATED: This field is no longer supported and will eventually be - removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, - use the `billingType` field inside `DeveloperMonetizationConfig` - resource. Flag that specifies the billing account type, prepaid or - postpaid. - enum: - - PAYMENT_FUNDING_MODEL_UNSPECIFIED - - PREPAID - - POSTPAID + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - enumDescriptions: - - Billing account type not specified. - - >- - Prepaid billing account type. Developer pays in advance for the - use of your API products. Funds are deducted from their prepaid - account balance. **Note**: Not supported by Apigee at this time. - - >- - Postpaid billing account type. Developer is billed through an - invoice after using your API products. - deprecated: true - startTime: - format: int64 + GoogleTypeExpr: + properties: + location: + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string - description: Time when the rate plan becomes active in milliseconds since epoch. - consumptionPricingType: - description: Pricing model used for consumption-based charges. + title: type: string - enumDescriptions: - - Pricing model not specified. This is the default. - - Fixed rate charged for each API call. - - >- - Variable rate charged for each API call based on price tiers. - Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 - per call * 201-300 calls cost $1 per call * Total price for 50 - calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x - $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + - 50 x $1 = $400. **Note**: Not supported by Apigee at this time. - - '**Note**: Not supported by Apigee at this time.' - - '**Note**: Not supported by Apigee at this time.' - enum: - - CONSUMPTION_PRICING_TYPE_UNSPECIFIED - - FIXED_PER_UNIT - - BANDED - - TIERED - - STAIRSTEP - revenueShareType: - description: Method used to calculate the revenue that is shared with developers. + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + expression: type: string - enum: - - REVENUE_SHARE_TYPE_UNSPECIFIED - - FIXED - - VOLUME_BANDED - enumDescriptions: - - Revenue share type is not specified. - - >- - Fixed percentage of the total revenue will be shared. The - percentage to be shared can be configured by the API provider. - - >- - Amount of revenue shared depends on the number of API calls. The - API call volume ranges and the revenue share percentage for each - volume can be configured by the API provider. **Note**: Not - supported by Apigee at this time. - billingPeriod: - enum: - - BILLING_PERIOD_UNSPECIFIED - - WEEKLY - - MONTHLY - enumDescriptions: - - Billing period not specified. - - >- - Weekly billing period. **Note**: Not supported by Apigee at this - time. - - Monthly billing period. + description: >- + Textual representation of an expression in Common Expression + Language syntax. + description: type: string - description: Frequency at which the customer will be billed. - setupFee: - description: Initial, one-time fee paid when purchasing the API product. - $ref: '#/components/schemas/GoogleTypeMoney' - apiproduct: + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + id: GoogleTypeExpr + type: object + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + GoogleCloudApigeeV1AdvancedApiOpsConfig: + properties: + enabled: + description: Flag that specifies whether the Advanced API Ops add-on is enabled. + type: boolean + type: object + description: Configuration for the Advanced API Ops add-on. + id: GoogleCloudApigeeV1AdvancedApiOpsConfig + GoogleCloudApigeeV1GenerateDownloadUrlResponse: + description: Response for GenerateDownloadUrl method. + id: GoogleCloudApigeeV1GenerateDownloadUrlResponse + properties: + downloadUri: type: string - description: Name of the API product that the rate plan is associated with. - description: Rate plan details. - id: GoogleCloudApigeeV1RatePlan + description: >- + The Google Cloud Storage signed URL that can be used to download the + Archive zip file. type: object - GoogleIamV1Binding: + GoogleCloudApigeeV1ResourceStatus: + properties: + resource: + description: >- + The resource name. Currently only two resources are supported: + EnvironmentGroup - organizations/{org}/envgroups/{envgroup} + EnvironmentConfig - + organizations/{org}/environments/{environment}/deployedConfig + type: string + revisions: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' + description: Revisions of the resource currently deployed in the instance. + type: array + uid: + type: string + description: >- + The uid of the resource. In the unexpected case that the instance + has multiple uids for the same name, they should be reported under + separate ResourceStatuses. + totalReplicas: + format: int32 + type: integer + description: The total number of replicas that should have this resource. + description: The status of a resource loaded in the runtime. + id: GoogleCloudApigeeV1ResourceStatus type: object + GoogleCloudApigeeV1OperationGroup: properties: - members: + operationConfigs: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. type: array - items: - type: string - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). + operationConfigType: type: string - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. - GoogleCloudApigeeV1TraceSamplingConfig: - description: >- - TraceSamplingConfig represents the detail settings of distributed - tracing. Only the fields that are defined in the distributed trace - configuration can be overridden using the distribute trace configuration - override APIs. - properties: - samplingRate: - format: float description: >- - Field sampling rate. This value is only applicable when using the - PROBABILITY sampler. The supported values are > 0 and <= 0.5. - type: number - sampler: - enumDescriptions: - - Sampler unspecified. - - >- - OFF means distributed trace is disabled, or the sampling - probability is 0. - - >- - PROBABILITY means traces are captured on a probability that - defined by sampling_rate. The sampling rate is limited to 0 to 0.5 - when this is set. - description: Sampler of distributed tracing. OFF is the default value. - type: string - enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY - type: object - id: GoogleCloudApigeeV1TraceSamplingConfig - GoogleCloudApigeeV1Metadata: + Flag that specifes whether the configuration is for Apigee API proxy + or a remote service. Valid values include `proxy` or + `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API + proxies are associated with the API product. Set to `remoteservice` + when non-Apigee proxies like Istio-Envoy are associated with the API + product. type: object + id: GoogleCloudApigeeV1OperationGroup + description: >- + List of operation configuration details associated with Apigee API + proxies or remote services. Remote services are non-Apigee proxies, such + as Istio-Envoy. + GoogleCloudApigeeV1EnvironmentConfig: + id: GoogleCloudApigeeV1EnvironmentConfig properties: - notices: - type: array - items: - type: string - description: >- - List of additional information such as data source, if result was - truncated. For example: ``` "notices": [ "Source:Postgres", "PG - Host:uappg0rw.e2e.apigeeks.net", "query served - by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: - edge.api.uapgroup2.agg_api" ]``` - errors: + deploymentGroups: + description: List of deployment groups in the environment. type: array - description: List of error messages as strings. items: - type: string - description: Encapsulates additional information about query execution. - id: GoogleCloudApigeeV1Metadata - GoogleCloudApigeeV1QueryMetric: - type: object - properties: - alias: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' + uid: description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. - value: - type: string - description: Operand value should be provided when operator is set. - name: - description: Required. Metric name. - type: string - function: - description: 'Aggregation function: avg, min, max, or sum.' + Unique ID for the environment configuration. The ID will only change + if the environment is deleted and recreated. type: string - operator: + provider: type: string - description: One of `+`, `-`, `/`, `%`, `*`. - id: GoogleCloudApigeeV1QueryMetric - description: >- - More info about Metric: - https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: - properties: - resources: + description: >- + Used by the Control plane to add context information to help detect + the source of the document during diagnostics and debugging. + addonsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' + description: The latest runtime configurations for add-ons. + deployments: + type: array items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' + description: List of deployments in the environment. + resources: type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' + description: List of resource versions in the environment. + targets: description: >- - Required. The array of resources. For Apigee, the proxies are - resources. - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray - type: object - description: An array of resource messages. - GoogleCloudApigeeV1TraceConfig: - type: object - properties: - exporter: + List of target servers in the environment. Disabled target servers + are not displayed. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' + type: array + resourceReferences: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' + description: List of resource references in the environment. + type: array + revisionId: + format: int64 description: >- - Required. Exporter that is used to view the distributed trace - captured using OpenCensus. An exporter sends traces to any backend - that is capable of consuming them. Recorded spans can be exported by - registered exporters. + Revision ID of the environment configuration. The higher the value, + the more recently the configuration was deployed. type: string - enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE - enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + envScopedRevisionId: description: >- - Distributed trace configuration for all API proxies in an - environment. You can also override the configuration for a specific - API proxy using the distributed trace configuration overrides API. - endpoint: - type: string - description: Required. Endpoint of the exporter. - id: GoogleCloudApigeeV1TraceConfig - description: >- - TraceConfig defines the configurations in an environment of distributed - trace. - GoogleCloudApigeeV1Credential: - properties: - consumerKey: - description: Consumer key. - type: string - issuedAt: - format: int64 - type: string - description: Time the credential was issued in milliseconds since epoch. - expiresAt: - description: Time the credential will expire in milliseconds since epoch. + Revision ID for environment-scoped resources (e.g. target servers, + keystores) in this config. This ID will increment any time a + resource not scoped to a deployment group changes. format: int64 type: string - attributes: - description: List of attributes associated with this credential. + dataCollectors: + description: List of data collectors used by the deployments in the environment. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - scopes: - items: - type: string - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' + gatewayConfigLocation: description: >- - List of scopes to apply to the app. Specified scopes must already - exist on the API product that you associate with the app. - apiProducts: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' - description: List of API products this credential can be used for. - type: array - consumerSecret: - description: Secret key. - type: string - status: + The location for the gateway config blob as a URI, e.g. a Cloud + Storage URI. This is only used by Envoy-based gateways. type: string - description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - id: GoogleCloudApigeeV1Credential - type: object - GoogleCloudApigeeV1RoutingRule: - properties: - envGroupRevision: - description: >- - The env group config revision_id when this rule was added or last - updated. This value is set when the rule is created and will only - update if the the environment_id changes. It is used to determine if - the runtime is up to date with respect to this rule. This field is - omitted from the IngressConfig unless the GetDeployedIngressConfig - API is called with view=FULL. - format: int64 + debugMask: + description: Debug mask that applies to all deployments in the environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + keystores: + description: List of keystores in the environment. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' + pubsubTopic: type: string - environment: + description: Name of the PubSub topic for the environment. + arcConfigLocation: type: string description: >- - Name of an environment bound to the environment group in the - following format: `organizations/{org}/environments/{env}`. Only one - of environment or deployment_group will be set. - receiver: + The location for the config blob of API Runtime Control, aka Envoy + Adapter, for op-based authentication as a URI, e.g. a Cloud Storage + URI. This is only used by Envoy-based gateways. + name: description: >- - The resource name of the proxy revision that is receiving this - basepath in the following format: - `organizations/{org}/apis/{api}/revisions/{rev}`. This field is - omitted from the IngressConfig unless the GetDeployedIngressConfig - API is called with view=FULL. + Name of the environment configuration in the following format: + `organizations/{org}/environments/{env}/configs/{config}` type: string - deploymentGroup: - description: >- - Name of a deployment group in an environment bound to the - environment group in the following format: - `organizations/{org}/environment/{env}/deploymentGroups/{group}` - Only one of environment or deployment_group will be set. + sequenceNumber: + description: 'DEPRECATED: Use revision_id.' + format: int64 type: string - otherTargets: - items: + featureFlags: + additionalProperties: type: string + description: Feature flags inherited from the organization and environment. + type: object + flowhooks: type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' + description: List of flow hooks in the environment. + traceConfig: description: >- - Conflicting targets, which will be resource names specifying either - deployment groups or environments. - basepath: + Trace configurations. Contains config for the environment and config + overrides for specific API proxies. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' + forwardProxyUri: type: string description: >- - URI path prefix used to route to the specified environment. May - contain one or more wildcards. For example, path segments consisting - of a single `*` character will match any string. - updateTime: + The forward proxy's url to be used by the runtime. When set, runtime + will send requests to the target via the given forward proxy. This + is only used by programmable gateways. + createTime: format: google-datetime - description: >- - The unix timestamp when this rule was updated. This is updated - whenever env_group_revision is updated. This field is omitted from - the IngressConfig unless the GetDeployedIngressConfig API is called - with view=FULL. type: string + description: Time that the environment configuration was created. type: object - id: GoogleCloudApigeeV1RoutingRule - GoogleCloudApigeeV1ReportProperty: - type: object - id: GoogleCloudApigeeV1ReportProperty - properties: - property: - description: name of the property - type: string - value: - description: property values - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - GoogleCloudApigeeV1ListApiProxiesResponse: + GoogleCloudApigeeV1ResourceFile: type: object - id: GoogleCloudApigeeV1ListApiProxiesResponse - properties: - proxies: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' - type: array - GoogleCloudApigeeV1Subscription: properties: name: type: string - description: >- - Full name of the Pub/Sub subcription. Use the following structure in - your request: `subscription "projects/foo/subscription/bar"` - type: object - id: GoogleCloudApigeeV1Subscription - description: Pub/Sub subscription of an environment. - GoogleCloudApigeeV1Score: - type: object - id: GoogleCloudApigeeV1Score - description: Represents Security Score. - properties: - subcomponents: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - description: List of all the drilldown score components. - type: array - timeRange: - description: Start and end time for the score. - $ref: '#/components/schemas/GoogleTypeInterval' - component: - description: Component containing score, recommendations and actions. - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - GoogleCloudApigeeV1Property: - description: A single property entry in the Properties message. - id: GoogleCloudApigeeV1Property + description: ID of the resource file. + type: + type: string + description: Resource file type. {{ resource_file_type }} + description: Metadata about a resource file. + id: GoogleCloudApigeeV1ResourceFile + GoogleCloudApigeeV1ApiCategoryResponse: + id: GoogleCloudApigeeV1ApiCategoryResponse type: object + description: The API category resource wrapped with response status, error_code, etc. properties: - name: - description: The property key + errorCode: + description: Unique error code for the request, if any. type: string - value: - description: The property value + data: + description: The API category resource. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + status: + description: Status of the operation. type: string - GoogleCloudApigeeV1SecurityReport: - description: >- - SecurityReport saves all the information about the created security - report. + requestId: + type: string + description: Unique ID of the request. + message: + type: string + description: Description of the operation. + GoogleCloudApigeeV1DeveloperApp: + type: object + id: GoogleCloudApigeeV1DeveloperApp properties: - envgroupHostname: - description: Hostname is available only when query is executed at host level. + appId: type: string - queryParams: + description: ID of the developer app. + lastModifiedAt: + readOnly: true description: >- - Contains information like metrics, dimenstions etc of the Security - Report. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' - resultRows: + Output only. Time the developer app was modified in milliseconds + since epoch. type: string - description: ResultRows is available only after the query is completed. format: int64 - displayName: - description: Display Name specified by the user. + credentials: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + type: array + description: >- + Output only. Set of credentials for the developer app consisting of + the consumer key/secret pairs associated with the API products. + readOnly: true + developerId: + description: ID of the developer. type: string - state: + attributes: + description: List of attributes for the developer app. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + name: + type: string + description: Name of the developer app. + status: type: string description: >- - Query state could be "enqueued", "running", "completed", "expired" - and "failed". - error: - description: Error is set when query fails. + Status of the credential. Valid values include `approved` or + `revoked`. + apiProducts: + items: + type: string + type: array + description: List of API products associated with the developer app. + appFamily: type: string - reportDefinitionId: - description: Report Definition ID. + description: Developer app family. + callbackUrl: type: string - self: description: >- - Self link of the query. Example: - `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - or following format if query is running at host level: - `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - type: string - result: - description: Result is available only after the query is completed. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' - resultFileSize: - description: ResultFileSize is available only after the query is completed. + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to developer apps. + keyExpiresIn: + description: >- + Expiration time, in milliseconds, for the consumer key that is + generated for the developer app. If not set or left to the default + value of `-1`, the API key never expires. The expiration time can't + be updated after it is set. + format: int64 type: string - updated: - description: Output only. Last updated timestamp for the query. + createdAt: + format: int64 + description: >- + Output only. Time the developer app was created in milliseconds + since epoch. readOnly: true type: string - created: - description: Creation time of the query. - type: string - executionTime: + scopes: + items: + type: string + type: array + description: >- + Scopes to apply to the developer app. The specified scopes must + already exist for the API product that you associate with the + developer app. + GoogleCloudApigeeV1ListRatePlansResponse: + description: Response for ListRatePlans. + properties: + nextStartKey: type: string - description: ExecutionTime is available only after the query is completed. - id: GoogleCloudApigeeV1SecurityReport + description: >- + Value that can be sent as `startKey` to retrieve the next page of + content. If this field is omitted, there are no subsequent pages. + ratePlans: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + description: List of rate plans in an organization. + type: object + id: GoogleCloudApigeeV1ListRatePlansResponse + GoogleCloudApigeeV1ExportRequest: + description: Request body for [CreateExportRequest] + type: object + properties: + description: + description: Optional. Description of the export job. + type: string + csvDelimiter: + type: string + description: >- + Optional. Delimiter used in the CSV file, if `outputFormat` is set + to `csv`. Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + outputFormat: + description: >- + Optional. Output format of the export. Valid values include: `csv` + or `json`. Defaults to `json`. Note: Configure the delimiter for CSV + output using the `csvDelimiter` property. + type: string + datastoreName: + description: Required. Name of the preconfigured datastore. + type: string + name: + type: string + description: Required. Display name of the export job. + dateRange: + $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' + description: Required. Date range of the data to export. + id: GoogleCloudApigeeV1ExportRequest + GoogleCloudApigeeV1ReferenceConfig: + type: object + id: GoogleCloudApigeeV1ReferenceConfig + properties: + name: + description: >- + Name of the reference in the following format: + `organizations/{org}/environments/{env}/references/{reference}` + type: string + resourceName: + description: >- + Name of the referenced resource in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` Only + references to keystore resources are supported. + type: string + GoogleCloudApigeeV1OperationConfig: type: object + id: GoogleCloudApigeeV1OperationConfig + properties: + apiSource: + description: >- + Required. Name of the API proxy or remote service with which the + resources, methods, and quota are associated. + type: string + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + description: >- + Quota parameters to be enforced for the resources, methods, and API + source combination. If none are specified, quota enforcement will + not be done. + operations: + description: >- + List of resource/method pairs for the API proxy or remote service to + which quota will applied. **Note**: Currently, you can specify only + a single resource/method pair. The call will fail if more than one + resource/method pair is provided. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' + type: array + attributes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: Custom attributes associated with the operation. + description: >- + Binds the resources in an API proxy or remote service with the allowed + REST methods and associated quota enforcement. GoogleCloudApigeeV1Alias: - id: GoogleCloudApigeeV1Alias + type: object + description: Reference to a certificate or key/certificate pair. properties: + alias: + type: string + description: >- + Resource ID for this alias. Values must match the regular expression + `[^/]{1,255}`. certsInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' description: Chain of certificates under this alias. + $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' type: - type: string enum: - ALIAS_TYPE_UNSPECIFIED - CERT - KEY_CERT + description: Type of alias. enumDescriptions: - Alias type is not specified. - Certificate. - Key/certificate pair. - description: Type of alias. - alias: type: string - description: >- - Resource ID for this alias. Values must match the regular expression - `[^/]{1,255}`. - type: object - description: Reference to a certificate or key/certificate pair. - GoogleCloudApigeeV1AdvancedApiOpsConfig: + id: GoogleCloudApigeeV1Alias + GoogleCloudApigeeV1ActivateNatAddressRequest: type: object - description: Configuration for the Advanced API Ops add-on. - id: GoogleCloudApigeeV1AdvancedApiOpsConfig + id: GoogleCloudApigeeV1ActivateNatAddressRequest + description: Request for ActivateNatAddressRequest. Activate the nat address request. + properties: {} + GoogleCloudApigeeV1IntegrationConfig: properties: enabled: + description: Flag that specifies whether the Integration add-on is enabled. type: boolean - description: Flag that specifies whether the Advanced API Ops add-on is enabled. - GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: - description: The result of the assessment. + description: Configuration for the Integration add-on. + id: GoogleCloudApigeeV1IntegrationConfig + type: object + GoogleCloudApigeeV1TlsInfo: + id: GoogleCloudApigeeV1TlsInfo + description: TLS configuration information for virtual hosts and TargetServers. type: object properties: - severity: - enum: - - SEVERITY_UNSPECIFIED - - LOW - - MEDIUM - - HIGH - - MINIMAL - enumDescriptions: - - Severity is not defined. - - Severity is low. - - Severity is medium. - - Severity is high. - - Severity is minimal - description: The severity of the assessment. + trustStore: type: string - dataUpdateTime: - description: >- - The time when resource data was last fetched for this resource. This - time may be different than when the resource was actually updated - due to lag in data collection. - format: google-datetime + description: The resource ID of the truststore. + commonName: + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' + description: The TLS Common Name of the certificate. + keyAlias: type: string - failedAssessmentPerWeight: - additionalProperties: - format: int32 - type: integer description: >- - The number of failed assessments grouped by its weight. Keys are one - of the following: "MAJOR", "MODERATE", "MINOR". - type: object - score: - format: int32 - type: integer - description: The security score of the assessment. - assessmentRecommendations: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation - type: object + Required if `client_auth_enabled` is true. The resource ID for the + alias containing the private key and cert. + ignoreValidationErrors: description: >- - The recommendations of the assessment. The key is the "name" of the - assessment (not display_name), and the value are the - recommendations. - id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - GoogleCloudApigeeV1ListSecurityIncidentsResponse: - type: object - description: Response for ListSecurityIncidents. - properties: - securityIncidents: + If true, Edge ignores TLS certificate errors. Valid when configuring + TLS for target servers and target endpoints, and when configuring + virtual hosts that use 2-way TLS. When used with a target + endpoint/target server, if the backend system uses SNI and returns a + cert with a subject Distinguished Name (DN) that does not match the + hostname, there is no way to ignore the error and the connection + fails. + type: boolean + ciphers: type: array + description: >- + The SSL/TLS cipher suites to be used. For programmable proxies, it + must be one of the cipher suite names listed in: + http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. + For configurable proxies, it must follow the configuration specified + in: + https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. + This setting has no effect for configurable proxies when negotiating + TLS 1.3. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - description: List of security incidents in the organization - nextPageToken: + type: string + protocols: + items: + type: string + description: The TLS versioins to be used. + type: array + enforce: + description: TLS is strictly enforced. + type: boolean + clientAuthEnabled: + description: Optional. Enables two-way TLS. + type: boolean + enabled: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. + Required. Enables TLS. If false, neither one-way nor two-way TLS + will be enabled. + type: boolean + keyStore: type: string - id: GoogleCloudApigeeV1ListSecurityIncidentsResponse - GoogleApiHttpBody: - properties: - extensions: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - type: array + Required if `client_auth_enabled` is true. The resource ID of the + keystore. + GoogleCloudApigeeV1ReportProperty: + type: object + properties: + value: items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - contentType: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + description: property values + property: + description: name of the property type: string - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - data: - description: The HTTP request/response body as raw binary. - type: string - format: byte - id: GoogleApiHttpBody - type: object - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - GoogleCloudApigeeV1ListApiProductsResponse: + id: GoogleCloudApigeeV1ReportProperty + GoogleCloudApigeeV1Certificate: type: object - id: GoogleCloudApigeeV1ListApiProductsResponse properties: - apiProduct: - description: Lists all API product names defined for an organization. + certInfo: type: array + description: Chain of certificates under this name. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' - GoogleCloudApigeeV1ResourceStatus: + $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' + id: GoogleCloudApigeeV1Certificate + GoogleCloudApigeeV1QueryMetadata: + type: object properties: - resource: + outputFormat: + type: string + description: Output format. + endTimestamp: + type: string + description: End timestamp of the query range. + startTimestamp: type: string + description: Start timestamp of the query range. + metrics: + type: array + items: + type: string description: >- - The resource name. Currently only two resources are supported: - EnvironmentGroup - organizations/{org}/envgroups/{envgroup} - EnvironmentConfig - - organizations/{org}/environments/{environment}/deployedConfig - revisions: + Metrics of the AsyncQuery. Example: + ["name:message_count,func:sum,alias:sum_message_count"] + dimensions: + type: array + description: Dimensions of the AsyncQuery. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' + type: string + timeUnit: + description: Query GroupBy time unit. + type: string + id: GoogleCloudApigeeV1QueryMetadata + GoogleCloudApigeeV1ListDeveloperAppsResponse: + type: object + properties: + app: + description: List of developer apps and their credentials. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' type: array - description: Revisions of the resource currently deployed in the instance. - uid: + id: GoogleCloudApigeeV1ListDeveloperAppsResponse + GoogleCloudApigeeV1SecurityReportQueryMetric: + id: GoogleCloudApigeeV1SecurityReportQueryMetric + type: object + properties: + alias: + type: string description: >- - The uid of the resource. In the unexpected case that the instance - has multiple uids for the same name, they should be reported under - separate ResourceStatuses. + Alias for the metric. Alias will be used to replace metric name in + query results. + name: + description: Required. Metric name. type: string - totalReplicas: - description: The total number of replicas that should have this resource. - format: int32 - type: integer + aggregationFunction: + description: 'Aggregation function: avg, min, max, or sum.' + type: string + value: + type: string + description: Operand value should be provided when operator is set. + operator: + description: One of `+`, `-`, `/`, `%`, `*`. + type: string + description: Metric of the Query + GoogleTypeInterval: + id: GoogleTypeInterval + properties: + endTime: + format: google-datetime + type: string + description: >- + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + 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 + type: string + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. type: object - description: The status of a resource loaded in the runtime. - id: GoogleCloudApigeeV1ResourceStatus + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: + properties: {} + description: Message for include_all option. + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + type: object + GoogleIamV1AuditConfig: + properties: + auditLogConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + description: The configuration for logging of each type of permission. + service: + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + type: string + type: object + description: >- + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + id: GoogleIamV1AuditConfig GoogleCloudApigeeV1Stats: - description: Encapsulates a `stats` response. + id: GoogleCloudApigeeV1Stats properties: - environments: - description: List of query results on the environment level. + hosts: + description: List of query results grouped by host. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' metaData: $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' description: Metadata information. - hosts: - type: array + environments: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' - description: List of query results grouped by host. - id: GoogleCloudApigeeV1Stats - type: object - GoogleCloudApigeeV1ProfileConfigCORS: - properties: {} + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' + type: array + description: List of query results on the environment level. + description: Encapsulates a `stats` response. type: object - id: GoogleCloudApigeeV1ProfileConfigCORS - description: Checks to see if you have CORS policy in place. - GoogleCloudApigeeV1ListAppsResponse: + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: + description: The response for GetAsyncQueryResultUrl type: object - id: GoogleCloudApigeeV1ListAppsResponse + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse properties: - app: - type: array + urls: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' - totalSize: - type: integer - description: Total count of Apps. - format: int32 - nextPageToken: - type: string - description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - GoogleCloudApigeeV1DeveloperBalance: - properties: - wallets: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + description: The list of Signed URLs generated by the CreateAsyncQuery request type: array - description: >- - Output only. List of all wallets. Each individual wallet stores the - account balance for a particular currency. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' - readOnly: true - type: object - id: GoogleCloudApigeeV1DeveloperBalance - description: Account balance for the developer. GoogleCloudApigeeV1Keystore: id: GoogleCloudApigeeV1Keystore + description: Datastore for Certificates and Aliases. + type: object properties: - aliases: - items: - type: string - description: Output only. Aliases in this keystore. - type: array - readOnly: true name: + type: string description: >- Required. Resource ID for this keystore. Values must match the regular expression `[\w[:space:].-]{1,255}`. - type: string - description: Datastore for Certificates and Aliases. - type: object - GoogleCloudApigeeV1EnvironmentGroup: - type: object - id: GoogleCloudApigeeV1EnvironmentGroup - description: >- - EnvironmentGroup configuration. An environment group is used to group - one or more Apigee environments under a single host name. + aliases: + description: Output only. Aliases in this keystore. + readOnly: true + items: + type: string + type: array + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: + description: A Signed URL and the relevant metadata associated with it. properties: - state: + md5: + description: The MD5 Hash of the JSON data type: string - description: >- - Output only. State of the environment group. Values other than - ACTIVE means the resource is not ready to use. - readOnly: true - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - name: - description: ID of the environment group. - type: string - createdAt: - description: >- - Output only. The time at which the environment group was created as - milliseconds since epoch. + sizeBytes: type: string + description: The size of the returned file in bytes format: int64 - readOnly: true - lastModifiedAt: - format: int64 - readOnly: true - description: >- - Output only. The time at which the environment group was last - updated as milliseconds since epoch. + uri: type: string - hostnames: + description: >- + The signed URL of the JSON data. Will be of the form + `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= + GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount + .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 + 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 + 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 + 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc + c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 + 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a + 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 + a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 + 2ea7abedc098d2eb14a7` + type: object + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + GoogleCloudApigeeV1AddonsConfig: + properties: + advancedApiOpsConfig: + description: Configuration for the Advanced API Ops add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' + connectorsPlatformConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' + description: Configuration for the Connectors Platform add-on. + apiSecurityConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' + description: Configuration for the API Security add-on. + monetizationConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' + description: Configuration for the Monetization add-on. + integrationConfig: + description: Configuration for the Integration add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' + analyticsConfig: + description: >- + Configuration for the Analytics add-on. Only used in + organizations.environments.addonsConfig. + $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' + id: GoogleCloudApigeeV1AddonsConfig + description: Add-on configurations for the Apigee organization. + type: object + GoogleCloudApigeeV1RevisionStatus: + properties: + errors: type: array - description: Required. Host names for this environment group. items: - type: string - GoogleCloudApigeeV1QueryTabularStatsRequest: + $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' + description: Errors reported when attempting to load this revision. + replicas: + description: The number of replicas that have successfully loaded this revision. + type: integer + format: int32 + jsonSpec: + type: string + description: >- + The json content of the resource revision. Large specs should be + sent individually via the spec field to avoid hitting request size + limits. + revisionId: + type: string + description: The revision of the resource. + description: The status of a specific resource revision. + id: GoogleCloudApigeeV1RevisionStatus + type: object + GoogleCloudApigeeV1RuntimeTraceConfig: + description: >- + NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed + trace in an environment. type: object + id: GoogleCloudApigeeV1RuntimeTraceConfig properties: - pageToken: + revisionId: type: string - description: Identifies a sequence of rows. - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Time range for the stats. - filter: description: >- - Filter further on specific dimension values. Follows the same - grammar as custom report's filter expressions. Example, apiproxy eq - 'foobar'. - https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters + Revision number which can be used by the runtime to detect if the + trace config has changed between two versions. + exporter: type: string - pageSize: - format: int32 - description: Page size represents the number of rows. - type: integer - metrics: - description: Required. List of metrics and their aggregations. + description: >- + Exporter that is used to view the distributed trace captured using + OpenCensus. An exporter sends traces to any backend that is capable + of consuming them. Recorded spans can be exported by registered + exporters. + enumDescriptions: + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter + enum: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE + name: + type: string + description: >- + Name of the trace config in the following format: + `organizations/{org}/environment/{env}/traceConfig` + endpoint: + description: Endpoint of the exporter. + type: string + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + description: Trace configuration for all API proxies in an environment. + overrides: type: array + description: List of trace configuration overrides for spicific API proxies. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - dimensions: - description: Required. List of dimension names to group the aggregations by. - items: - type: string - type: array - id: GoogleCloudApigeeV1QueryTabularStatsRequest - description: >- - Request payload representing the query to be run for fetching security - statistics as rows. - GoogleCloudApigeeV1TargetServer: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' + revisionCreateTime: + description: The timestamp that the revision was created or updated. + format: google-datetime + type: string + GoogleCloudApigeeV1RuntimeTraceConfigOverride: + id: GoogleCloudApigeeV1RuntimeTraceConfigOverride type: object - description: >- - TargetServer configuration. TargetServers are used to decouple a proxy - TargetEndpoint HTTPTargetConnections from concrete URLs for backend - services. properties: - description: - description: Optional. A human-readable description of this TargetServer. - type: string - sSLInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' + apiProxy: description: >- - Optional. Specifies TLS configuration info for this TargetServer. - The JSON name is `sSLInfo` for legacy/backwards compatibility - reasons -- Edge originally supported SSL, and the name is still used - for TLS configuration. - host: + Name of the API proxy that will have its trace configuration + overridden following format: `organizations/{org}/apis/{api}` + type: string + revisionId: type: string description: >- - Required. The host name this target connects to. Value must be a - valid hostname as described by RFC-1123. - isEnabled: - type: boolean + Revision number which can be used by the runtime to detect if the + trace config override has changed between two versions. + uid: + type: string description: >- - Optional. Enabling/disabling a TargetServer is useful when - TargetServers are used in load balancing configurations, and one or - more TargetServers need to taken out of rotation periodically. - Defaults to true. - port: - format: int32 + Unique ID for the configuration override. The ID will only change if + the override is deleted and recreated. Corresponds to name's + "override" field. + revisionCreateTime: + type: string + description: The timestamp that the revision was created or updated. + format: google-datetime + samplingConfig: description: >- - Required. The port number this target connects to on the given host. - Value must be between 1 and 65535, inclusive. - type: integer + Trace configuration override for a specific API proxy in an + environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' name: - type: string description: >- - Required. The resource id of this target server. Values must match - the regular expression - protocol: - description: Immutable. The protocol used by this TargetServer. - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - enumDescriptions: - - UNSPECIFIED defaults to HTTP for backwards compatibility. - - The TargetServer uses HTTP. - - The TargetSever uses HTTP2. - - The TargetServer uses GRPC. - - >- - GRPC TargetServer to be used in ExternalCallout Policy. Prefer to - use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once - EXTERNAL _CALLOUT generally available. - - The TargetServer is to be used in the ExternalCallout Policy + Name of the trace config override in the following format: + `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` type: string - id: GoogleCloudApigeeV1TargetServer - GoogleCloudApigeeV1SecuritySettings: - id: GoogleCloudApigeeV1SecuritySettings description: >- - SecuritySettings reflects the current state of the SecuritySettings - feature. + NEXT ID: 7 Trace configuration override for a specific API proxy in an + environment. + GoogleCloudApigeeV1ListInstancesResponse: + description: Response for ListInstances. + type: object properties: - name: - type: string - description: >- - Identifier. Full resource name is always - `organizations/{org}/securitySettings`. - mlRetrainingFeedbackEnabled: - type: boolean + nextPageToken: description: >- - Optional. If true the user consents to the use of ML models for - Abuse detection. + Page token that you can include in a ListInstance request to + retrieve the next page of content. If omitted, no subsequent pages + exist. + type: string + instances: + description: Instances in the specified organization. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + id: GoogleCloudApigeeV1ListInstancesResponse + GoogleCloudApigeeV1ListOrganizationsResponse: + properties: + organizations: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' + description: List of Apigee organizations and associated Google Cloud projects. + type: array + id: GoogleCloudApigeeV1ListOrganizationsResponse type: object - GoogleCloudApigeeV1OptimizedStats: + GoogleCloudApigeeV1EnvironmentGroupConfig: + description: >- + EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup + and its associated routing rules. type: object properties: - Response: + uid: description: >- - Wraps the `stats` response for JavaScript Optimized Scenario with a - response key. For example: ```{ "Response": { "TimeUnit": [], - "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table - used: edge.api.aaxgroup001.agg_api", "PG - Host:ruappg08-ro.production.apigeeks.net", "query served - by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": - false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" - ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": - "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": - "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' - id: GoogleCloudApigeeV1OptimizedStats - GoogleCloudApigeeV1OperationMetadata: - type: object - id: GoogleCloudApigeeV1OperationMetadata - properties: - targetResourceName: + A unique id for the environment group config that will only change + if the environment group is deleted and recreated. type: string - description: Name of the resource for which the operation is operating on. - operationType: - enum: - - OPERATION_TYPE_UNSPECIFIED - - INSERT - - DELETE - - UPDATE - enumDescriptions: - - '' - - '' - - '' - - '' + revisionId: + format: int64 + description: >- + Revision id that defines the ordering of the EnvironmentGroupConfig + resource. The higher the revision, the more recently the + configuration was deployed. type: string - warnings: + hostnames: + description: Host names for the environment group. + type: array items: type: string - description: Warnings encountered while executing the operation. + routingRules: + description: >- + Ordered list of routing rules defining how traffic to this + environment group's hostnames should be routed to different + environments. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' type: array - progress: - description: Progress of the operation. - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' - state: - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED - enumDescriptions: - - '' - - '' - - '' - - '' - type: string - description: Metadata describing an Operation. - GoogleCloudApigeeV1ScoreComponentRecommendationAction: - id: GoogleCloudApigeeV1ScoreComponentRecommendationAction - type: object - properties: - actionContext: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext - description: Action context for the action. - description: - description: Description of the action. + endpointChainingRules: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' + description: A list of proxies in each deployment group for proxy chaining calls. + name: type: string - description: Action to improve security score. - GoogleCloudApigeeV1TlsInfoCommonName: - id: GoogleCloudApigeeV1TlsInfoCommonName - properties: - wildcardMatch: - type: boolean description: >- - Indicates whether the cert should be matched against as a wildcard - cert. - value: + Name of the environment group in the following format: + `organizations/{org}/envgroups/{envgroup}`. + location: type: string - description: The TLS Common Name string of the certificate. - type: object - GoogleCloudApigeeV1AnalyticsConfig: - description: Configuration for the Analytics add-on. - id: GoogleCloudApigeeV1AnalyticsConfig - type: object + description: >- + When this message appears in the top-level IngressConfig, this field + will be populated in lieu of the inlined routing_rules and hostnames + fields. Some URL for downloading the full EnvironmentGroupConfig for + this group. + id: GoogleCloudApigeeV1EnvironmentGroupConfig + GoogleCloudApigeeV1CustomReport: + id: GoogleCloudApigeeV1CustomReport properties: - expireTimeMillis: - format: int64 - type: string + dimensions: + description: This contains the list of dimensions for the report + type: array + items: + type: string + environment: readOnly: true - description: >- - Output only. Time at which the Analytics add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. - state: - enum: - - ADDON_STATE_UNSPECIFIED - - ENABLING - - ENABLED - - DISABLING - - DISABLED + description: Output only. Environment name type: string - readOnly: true - description: Output only. The state of the Analytics add-on. - enumDescriptions: - - Default value. - - Add-on is in progress of enabling. - - Add-on is fully enabled and ready to use. - - Add-on is in progress of disabling. - - Add-on is fully disabled. - updateTime: + displayName: + type: string + description: This is the display name for the report + organization: readOnly: true type: string - format: google-datetime - description: Output only. The latest update time. - enabled: - description: Whether the Analytics add-on is enabled. - type: boolean - GoogleCloudApigeeV1ResourceFiles: - id: GoogleCloudApigeeV1ResourceFiles - type: object - description: List of resource files. - properties: - resourceFile: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' - description: List of resource files. - type: array - GoogleCloudApigeeV1SecurityReportResultView: - description: The response for security report result view APIs. - type: object - properties: - error: - description: Error message when there is a failure. + description: Output only. Organization name + sortOrder: type: string - rows: description: >- - Rows of security report result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - type: array - items: - type: any - state: + Legacy field: not used much. Contains the sort order for the sort + columns + filter: + description: This field contains the filter expression type: string - description: State of retrieving ResultView. - metadata: - description: >- - Metadata contains information like metrics, dimenstions etc of the - security report. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' - code: - type: integer - description: Error code when there is a failure. - format: int32 - id: GoogleCloudApigeeV1SecurityReportResultView - GoogleCloudApigeeV1SecurityReportMetadata: - description: Metadata for the security report. - properties: - timeUnit: + chartType: type: string - description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' + description: This field contains the chart type for the report metrics: items: - type: string - description: >- - Metrics of the SecurityReport. Example: - ["name:bot_count,func:sum,alias:sum_bot_count"] + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' type: array - mimeType: - description: MIME type / Output format. + description: Required. This contains the list of metrics + timeUnit: type: string - dimensions: + description: This field contains the time unit of aggregation for the report + name: + description: >- + Required. Unique identifier for the report T his is a legacy field + used to encode custom report unique id + type: string + toTime: + type: string + description: 'Legacy field: not used. Contains the end time for the report' + sortByCols: + description: 'Legacy field: not used much. Contains the list of sort by columns' items: type: string type: array - description: Dimensions of the SecurityReport. - startTimestamp: - description: Start timestamp of the query range. + properties: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' + description: This field contains report properties such as ui metadata etc. + offset: type: string - format: google-datetime - endTimestamp: - description: End timestamp of the query range. + description: 'Legacy field: not used. This field contains the offset for the data' + createdAt: + description: 'Output only. Unix time when the app was created json key: createdAt' type: string - format: google-datetime - type: object - id: GoogleCloudApigeeV1SecurityReportMetadata - GoogleCloudApigeeV1FlowHook: - type: object - id: GoogleCloudApigeeV1FlowHook - properties: - description: - type: string - description: Description of the flow hook. - flowHookPoint: - description: >- - Output only. Where in the API call flow the flow hook is invoked. - Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, - `PreTargetFlowHook`, or `PostTargetFlowHook`. + format: int64 readOnly: true - type: string - sharedFlow: - type: string + tags: + type: array + items: + type: string description: >- - Shared flow attached to this flow hook, or empty if there is none - attached. - continueOnError: + Legacy field: not used. This field contains a list of tags + associated with custom report + topk: description: >- - Optional. Flag that specifies whether execution should continue if - the flow hook throws an exception. Set to `true` to continue - execution. Set to `false` to stop execution if the flow hook throws - an exception. Defaults to `true`. - type: boolean - GoogleCloudApigeeV1Instance: - id: GoogleCloudApigeeV1Instance - type: object - description: Apigee runtime instance. - properties: - port: + Legacy field: not used. This field contains the top k parameter + value for restricting the result type: string - description: Output only. Port number of the exposed Apigee endpoint. - readOnly: true - serviceAttachment: - description: >- - Output only. Resource name of the service attachment created for the - instance in the format: `projects/*/regions/*/serviceAttachments/*` - Apigee customers can privately forward traffic to this service - attachment using the PSC endpoints. + lastModifiedAt: type: string + description: >- + Output only. Modified time of this entity as milliseconds since + epoch. json key: lastModifiedAt + format: int64 readOnly: true - displayName: - description: Optional. Display name for the instance. + fromTime: + description: 'Legacy field: not used. Contains the from time for the report' type: string - accessLoggingConfig: + comments: description: >- - Optional. Access logging configuration enables the access logging - feature at the instance. Apigee customers can enable access logging - to ship the access logs to their own project's cloud logging. - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessLoggingConfig' - description: - description: Optional. Description of the instance. + Legacy field: not used. This field contains a list of comments + associated with custom report + items: + type: string + type: array + limit: type: string - diskEncryptionKeyName: description: >- - Customer Managed Encryption Key (CMEK) used for disk and volume - encryption. If not specified, a Google-Managed encryption key will - be used. Use the following format: - `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` - type: string - state: - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING + Legacy field: not used This field contains the limit for the result + retrieved + lastViewedAt: + format: int64 description: >- - Output only. State of the instance. Values other than `ACTIVE` means - the resource is not ready to use. - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. + Output only. Last viewed time of this entity as milliseconds since + epoch readOnly: true type: string - runtimeVersion: + type: object + GoogleCloudApigeeV1Metric: + properties: + values: description: >- - Output only. Version of the runtime system running in the instance. - The runtime system is the set of components that serve the API Proxy - traffic in your Environments. - readOnly: true + List of metric values. Possible value formats include: + `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": + 1232434354} ]` + items: + type: any + type: array + name: + description: Metric name. type: string + description: >- + Encapsulates the metric data point. For example: ```{ "name": + "sum(message_count)", "values" : [ { "timestamp": 1549004400000, + "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] + }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }``` + type: object + id: GoogleCloudApigeeV1Metric + GoogleCloudApigeeV1ArchiveDeployment: + description: Archive Deployment information. + id: GoogleCloudApigeeV1ArchiveDeployment + type: object + properties: createdAt: type: string readOnly: true format: int64 description: >- - Output only. Time the instance was created in milliseconds since - epoch. - host: - description: >- - Output only. Internal hostname or IP address of the Apigee endpoint - used by clients to connect to the service. + Output only. The time at which the Archive Deployment was created in + milliseconds since the epoch. + name: type: string - readOnly: true - peeringCidrRange: - deprecated: true - enum: - - CIDR_RANGE_UNSPECIFIED - - SLASH_16 - - SLASH_17 - - SLASH_18 - - SLASH_19 - - SLASH_20 - - SLASH_22 - - SLASH_23 - enumDescriptions: - - Range not specified. - - '`/16` CIDR range.' - - '`/17` CIDR range.' - - '`/18` CIDR range.' - - '`/19` CIDR range.' - - '`/20` CIDR range.' - - '`/22` CIDR range. Supported for evaluation only.' - - '`/23` CIDR range. Supported for evaluation only.' description: >- - Optional. Size of the CIDR block range that will be reserved by the - instance. PAID organizations support `SLASH_16` to `SLASH_20` and - defaults to `SLASH_16`. Evaluation organizations support only - `SLASH_23`. - type: string - consumerAcceptList: + Name of the Archive Deployment in the following format: + `organizations/{org}/environments/{env}/archiveDeployments/{id}`. + operation: description: >- - Optional. Customer accept list represents the list of projects - (id/number) on customer side that can privately connect to the - service attachment. It is an optional field which the customers can - provide during the instance creation. By default, the customer - project associated with the Apigee organization will be included to - the list. - type: array - items: - type: string - name: + Output only. A reference to the LRO that created this Archive + Deployment in the following format: + `organizations/{org}/operations/{id}` + readOnly: true type: string + gcsUri: description: >- - Required. Resource ID of the instance. Values must match the regular - expression `^a-z{0,30}[a-z\d]$`. - location: - description: Required. Compute Engine location where the instance resides. + Input only. The Google Cloud Storage signed URL returned from + GenerateUploadUrl and used to upload the Archive zip file. type: string - ipRange: + updatedAt: + readOnly: true type: string + format: int64 description: >- - Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 - used to create the Apigee instance. Providing CIDR ranges is - optional. You can provide just /22 or /28 or both (or neither). - Ranges you provide should be freely available as part of a larger - named range you have allocated to the Service Networking peering. If - this parameter is not provided, Apigee automatically requests an - available /22 and /28 CIDR block from Service Networking. Use the - /22 CIDR block for configuring your firewall needs to allow traffic - from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or - `a.b.c.d/22,e.f.g.h/28` - lastModifiedAt: - type: string + Output only. The time at which the Archive Deployment was updated in + milliseconds since the epoch. + labels: + additionalProperties: + type: string description: >- - Output only. Time the instance was last modified in milliseconds - since epoch. - format: int64 - readOnly: true - GoogleCloudApigeeV1SharedFlow: - description: The metadata describing a shared flow - id: GoogleCloudApigeeV1SharedFlow + User-supplied key-value pairs used to organize ArchiveDeployments. + Label keys must be between 1 and 63 characters long, have a UTF-8 + encoding of maximum 128 bytes, and must conform to the following + PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be + between 1 and 63 characters long, have a UTF-8 encoding of maximum + 128 bytes, and must conform to the following PCRE regular + expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can + be associated with a given store. + type: object + GoogleCloudApigeeV1OptimizedStatsResponse: + description: Encapsulates a response format for JavaScript Optimized Scenario. type: object + id: GoogleCloudApigeeV1OptimizedStatsResponse properties: - revision: + TimeUnit: items: type: string - description: A list of revisions of this shared flow. + format: int64 type: array - latestRevisionId: - type: string - description: The id of the most recently created revision for this shared flow. + description: >- + List of time unit values. Time unit refers to an epoch timestamp + value. + resultTruncated: + description: >- + Boolean flag that indicates whether the results were truncated based + on the limit parameter. + type: boolean metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - description: Metadata describing the shared flow. - name: - description: The ID of the shared flow. - type: string - GoogleCloudApigeeV1AppGroupAppKey: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + description: Metadata information about the query executed. + stats: + description: '`stats` results.' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' + GoogleCloudApigeeV1NatAddress: + type: object properties: - consumerSecret: + state: + enum: + - STATE_UNSPECIFIED + - CREATING + - RESERVED + - ACTIVE + - DELETING type: string - description: Secret key. - attributes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes associated with the credential. - issuedAt: + description: Output only. State of the nat address. + readOnly: true + enumDescriptions: + - The resource is in an unspecified state. + - The NAT address is being created. + - The NAT address is reserved but not yet used for Internet egress. + - The NAT address is active and used for Internet egress. + - The NAT address is being deleted. + name: type: string - description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. - format: int64 + description: Required. Resource ID of the NAT address. + ipAddress: + description: Output only. The static IPV4 address. readOnly: true - scopes: + type: string + id: GoogleCloudApigeeV1NatAddress + description: >- + Apigee NAT(network address translation) address. A NAT address is a + static external IP address used for Internet egress traffic. + GoogleCloudApigeeV1GenerateDownloadUrlRequest: + properties: {} + type: object + id: GoogleCloudApigeeV1GenerateDownloadUrlRequest + description: Request for GenerateDownloadUrl method. + GoogleCloudApigeeV1FlowHook: + id: GoogleCloudApigeeV1FlowHook + type: object + properties: + description: + description: Description of the flow hook. + type: string + flowHookPoint: + type: string + readOnly: true + description: >- + Output only. Where in the API call flow the flow hook is invoked. + Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, + `PreTargetFlowHook`, or `PostTargetFlowHook`. + continueOnError: + description: >- + Optional. Flag that specifies whether execution should continue if + the flow hook throws an exception. Set to `true` to continue + execution. Set to `false` to stop execution if the flow hook throws + an exception. Defaults to `true`. + type: boolean + sharedFlow: + type: string + description: >- + Shared flow attached to this flow hook, or empty if there is none + attached. + EdgeConfigstoreBundleBadBundleViolation: + type: object + properties: + description: + description: A description of why the bundle is invalid and how to fix it. + type: string + filename: + description: >- + The filename (including relative path from the bundle root) in which + the error occurred. + type: string + id: EdgeConfigstoreBundleBadBundleViolation + description: A message type used to describe a single bundle validation error. + GoogleCloudApigeeV1SecurityReportMetadata: + properties: + startTimestamp: + description: Start timestamp of the query range. + format: google-datetime + type: string + endTimestamp: + description: End timestamp of the query range. + format: google-datetime + type: string + dimensions: items: type: string - description: >- - Scopes to apply to the app. The specified scope names must already - be defined for the API product that you associate with the app. type: array - expiresAt: - readOnly: true + description: Dimensions of the SecurityReport. + timeUnit: + type: string + description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' + mimeType: + type: string + description: MIME type / Output format. + metrics: + type: array description: >- - Output only. Time the AppGroup app expires in milliseconds since + Metrics of the SecurityReport. Example: + ["name:bot_count,func:sum,alias:sum_bot_count"] + items: + type: string + type: object + id: GoogleCloudApigeeV1SecurityReportMetadata + description: Metadata for the security report. + GoogleCloudApigeeV1EntityMetadata: + id: GoogleCloudApigeeV1EntityMetadata + description: Metadata common to many entities in this API. + properties: + createdAt: + description: >- + Time at which the API proxy was created, in milliseconds since epoch. format: int64 type: string - apiProducts: - readOnly: true + lastModifiedAt: + type: string description: >- - Output only. List of API products and its status for which the - credential can be used. **Note**: Use - UpdateAppGroupAppKeyApiProductRequest API to make the association - after the consumer key and secret are created. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' - status: + Time at which the API proxy was most recently modified, in + milliseconds since epoch. + format: int64 + subType: type: string + description: The type of entity described + type: object + GoogleCloudApigeeV1SecuritySettings: + id: GoogleCloudApigeeV1SecuritySettings + type: object + properties: + name: description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - consumerKey: - description: Immutable. Consumer key. + Identifier. Full resource name is always + `organizations/{org}/securitySettings`. type: string - expiresInSeconds: - format: int64 + mlRetrainingFeedbackEnabled: + description: >- + Optional. If true the user consents to the use of ML models for + Abuse detection. + type: boolean + description: >- + SecuritySettings reflects the current state of the SecuritySettings + feature. + GoogleCloudApigeeV1TlsInfoCommonName: + properties: + value: type: string + description: The TLS Common Name string of the certificate. + wildcardMatch: description: >- - Immutable. Expiration time, in seconds, for the consumer key. If not - set or left to the default value of `-1`, the API key never expires. - The expiration time can't be updated after it is set. - id: GoogleCloudApigeeV1AppGroupAppKey + Indicates whether the cert should be matched against as a wildcard + cert. + type: boolean + id: GoogleCloudApigeeV1TlsInfoCommonName type: object + GoogleCloudApigeeV1QueryTabularStatsResponse: + id: GoogleCloudApigeeV1QueryTabularStatsResponse description: >- - AppGroupAppKey contains all the information associated with the - credentials. - GoogleCloudApigeeV1GetSyncAuthorizationRequest: - properties: {} - id: GoogleCloudApigeeV1GetSyncAuthorizationRequest + Encapsulates two kinds of stats that are results of the dimensions and + aggregations requested. - Tabular rows. - Time series data. Example of + tabular rows, Represents security stats results as a row of flat values. + properties: + values: + type: array + description: Resultant rows from the executed query. + items: + type: array + items: + type: any + columns: + items: + type: string + type: array + description: >- + Column names corresponding to the same order as the inner values in + the stats field. + nextPageToken: + type: string + description: Next page token. type: object - description: Request for GetSyncAuthorization. - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: - description: Request for BatchUpdateSecurityIncident. + GoogleCloudApigeeV1ListDeploymentsResponse: type: object - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest properties: - requests: + deployments: items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' type: array - description: >- - Optional. Required. The request message specifying the resources to - update. A maximum of 1000 can be modified in a batch. - GoogleCloudApigeeV1ProfileConfigMTLS: - description: Checks to see if you have configured mTLS for the target server. + description: List of deployments. + id: GoogleCloudApigeeV1ListDeploymentsResponse + GoogleCloudApigeeV1ProfileConfigAuthorization: properties: {} + description: >- + By default, following policies will be included: - JWS - JWT - OAuth - + BasicAuth - APIKey + id: GoogleCloudApigeeV1ProfileConfigAuthorization + type: object + GoogleCloudApigeeV1Attributes: + properties: + attribute: + description: List of attributes. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + id: GoogleCloudApigeeV1Attributes type: object + GoogleCloudApigeeV1ProfileConfigMTLS: id: GoogleCloudApigeeV1ProfileConfigMTLS - GoogleCloudApigeeV1SecurityIncident: + description: Checks to see if you have configured mTLS for the target server. type: object + properties: {} + GoogleRpcPreconditionFailureViolation: + id: GoogleRpcPreconditionFailureViolation + description: A message type used to describe a single precondition failure. properties: - displayName: + subject: type: string - description: Optional. Display name of the security incident. - trafficCount: + description: >- + The subject, relative to the type, that failed. For example, + "google.com/cloud" relative to the "TOS" type would indicate which + terms of service is being referenced. + description: + description: >- + A description of how the precondition failed. Developers can use + this description to understand how to fix the failure. For example: + "Terms of service not accepted". + type: string + type: type: string - format: int64 - description: Total traffic detected as part of the incident. - name: description: >- - Immutable. Name of the security incident resource. Format: - organizations/{org}/environments/{environment}/securityIncidents/{incident} - Example: - organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 - type: string - lastObservabilityChangeTime: + The type of PreconditionFailure. We recommend using a + service-specific enum type to define the supported precondition + violation subjects. For example, "TOS" for "Terms of Service + violation". + type: object + GoogleIamV1Policy: + id: GoogleIamV1Policy + properties: + auditConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + description: Specifies cloud audit logging configuration for this policy. + etag: type: string - readOnly: true - format: google-datetime description: >- - Output only. The time when the incident observability was last - changed. - riskLevel: - enumDescriptions: - - Risk Level Unspecified. - - Risk level of the incident is low. - - Risk level of the incident is moderate. - - Risk level of the incident is severe. - enum: - - RISK_LEVEL_UNSPECIFIED - - LOW - - MODERATE - - SEVERE + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + format: byte + version: + format: int32 + type: integer + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + bindings: + type: array + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + GoogleCloudApigeeV1ListSecurityIncidentsResponse: + properties: + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - description: Output only. Risk level of the incident. - readOnly: true - detectionTypes: + securityIncidents: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + description: List of security incidents in the organization type: array - readOnly: true + type: object + description: Response for ListSecurityIncidents. + id: GoogleCloudApigeeV1ListSecurityIncidentsResponse + GoogleCloudApigeeV1ListApiCategoriesResponse: + type: object + id: GoogleCloudApigeeV1ListApiCategoriesResponse + properties: + data: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + description: The API category resources. + requestId: + type: string + description: Unique ID of the request. + message: + type: string + description: Description of the operation. + errorCode: + type: string + description: Unique error code for the request, if any. + status: + type: string + description: Status of the operation. + description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' + GoogleCloudApigeeV1DebugSession: + id: GoogleCloudApigeeV1DebugSession + type: object + properties: + timeout: description: >- - Output only. Detection types which are part of the incident. - Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly - Detection. - observability: - enumDescriptions: - - The incident observability is unspecified. - - >- - The incident is currently active. Can change to this status from - archived. - - >- - The incident is currently archived and was archived by the - customer. - enum: - - OBSERVABILITY_UNSPECIFIED - - ACTIVE - - ARCHIVED + Optional. The time in seconds after which this DebugSession should + end. This value will override the value in query param, if both are + provided. + format: int64 type: string - description: Optional. Indicates if the user archived this incident. - lastDetectedTime: + validity: description: >- - Output only. The time when events associated with the incident were - last detected. - readOnly: true + Optional. The length of time, in seconds, that this debug session is + valid, starting from when it's received in the control plane. Min = + 1, Max = 15, Default = 10. + format: int32 + type: integer + name: type: string - format: google-datetime - firstDetectedTime: - readOnly: true - format: google-datetime + description: A unique ID for this DebugSession. + count: + format: int32 + type: integer description: >- - Output only. The time when events associated with the incident were - first detected. + Optional. The number of request to be traced. Min = 1, Max = 15, + Default = 10. + filter: + description: >- + Optional. A conditional statement which is evaluated against the + request message to determine if it should be traced. Syntax matches + that of on API Proxy bundle flow Condition. type: string - id: GoogleCloudApigeeV1SecurityIncident - description: Represents an SecurityIncident resource. - GoogleCloudApigeeV1AddonsConfig: - properties: - apiSecurityConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' - description: Configuration for the API Security add-on. - integrationConfig: - description: Configuration for the Integration add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' - analyticsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' + tracesize: + format: int32 + type: integer description: >- - Configuration for the Analytics add-on. Only used in - organizations.environments.addonsConfig. - advancedApiOpsConfig: - description: Configuration for the Advanced API Ops add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' - connectorsPlatformConfig: - description: Configuration for the Connectors Platform add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' - monetizationConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' - description: Configuration for the Monetization add-on. - id: GoogleCloudApigeeV1AddonsConfig - description: Add-on configurations for the Apigee organization. - type: object - GoogleCloudApigeeV1Deployment: + Optional. The maximum number of bytes captured from the response + payload. Min = 0, Max = 5120, Default = 5120. + createTime: + description: >- + Output only. The first transaction creation timestamp, recorded by + UAP. + type: string + readOnly: true + format: google-datetime + GoogleCloudApigeeV1DocumentationFile: properties: - environment: - description: Environment. + displayName: + description: >- + Required. A display name for the file, shown in the management UI. + Max length is 255 characters. type: string - pods: + contents: + type: string + description: Required. The file contents. The max size is 4 MB. + format: byte + description: Documentation file contents for a catalog item. + id: GoogleCloudApigeeV1DocumentationFile + type: object + GoogleCloudApigeeV1ProfileConfigAbuse: + id: GoogleCloudApigeeV1ProfileConfigAbuse + type: object + description: >- + Checks for abuse, which includes any requests sent to the API for + purposes other than what it is intended for, such as high volumes of + requests, data scraping, and abuse related to authorization. + properties: {} + GoogleCloudApigeeV1ListHybridIssuersResponse: + properties: + issuers: type: array + description: Lists of hybrid services and its trusted issuer email ids. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1PodStatus' - description: >- - Status reported by runtime pods. **Note**: **This field is - deprecated**. Runtime versions 1.3 and above report instance level - status rather than pod status. - state: - enumDescriptions: - - This value should never be returned. - - Runtime has loaded the deployment. - - Deployment is not fully ready in the runtime. - - >- - Encountered an error with the deployment that requires - intervention. - enum: - - RUNTIME_STATE_UNSPECIFIED - - READY - - PROGRESSING - - ERROR + $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' + type: object + id: GoogleCloudApigeeV1ListHybridIssuersResponse + GoogleCloudApigeeV1SecurityAssessmentResultResource: + type: object + properties: + resourceRevisionId: description: >- - Current state of the deployment. **Note**: This field is displayed - only when viewing deployment status. + The revision id for the resource. In case of Apigee, this is proxy + revision id. type: string - routeConflicts: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - description: >- - Conflicts in the desired state routing configuration. The presence - of conflicts does not cause the state to be `ERROR`, but it will - mean that some of the deployment's base paths are not routed to its - environment. If the conflicts change, the state will transition to - `PROGRESSING` until the latest configuration is rolled out to all - instances. **Note**: This field is displayed only when viewing - deployment status. - type: array - proxyDeploymentType: - enumDescriptions: - - >- - Default value till public preview. After public preview this value - should not be returned. - - >- - Deployment will be of type Standard if only Standard proxies are - used - - >- - Proxy will be of type Extensible if deployments uses one or more - Extensible proxies - readOnly: true - description: >- - Output only. The type of the deployment (standard or extensible) - Deployed proxy revision will be marked as extensible in following 2 - cases. 1. The deployed proxy revision uses extensible policies. 2. - If a environment supports flowhooks and flow hook is configured. + name: + description: Required. Name of this resource. type: string + type: enum: - - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE - apiProxy: - description: API proxy. - type: string - revision: - description: API proxy revision. + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. type: string - instances: + description: Required. Type of this resource. + id: GoogleCloudApigeeV1SecurityAssessmentResultResource + description: Resource for which we are computing security assessment. + GoogleCloudApigeeV1DeploymentConfig: + description: 'NEXT ID: 11' + properties: + deploymentGroups: + description: >- + The list of deployment groups in which this proxy should be + deployed. Not currently populated for shared flows. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' + type: string + serviceAccount: + type: string description: >- - Status reported by each runtime instance. **Note**: This field is - displayed only when viewing deployment status. - errors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array + The service account identity associated with this deployment. If + non-empty, will be in the following format: + `projects/-/serviceAccounts/{account_email}` + proxyUid: + description: Unique ID of the API proxy revision. + type: string + endpoints: + additionalProperties: + type: string + type: object description: >- - Errors reported for this deployment. Populated only when state == - ERROR. **Note**: This field is displayed only when viewing - deployment status. - deployStartTime: + A mapping from basepaths to proxy endpoint names in this proxy. Not + populated for shared flows. + basePath: type: string + description: Base path where the application will be hosted. Defaults to "/". + name: description: >- - Time the API proxy was marked `deployed` in the control plane in - millisconds since epoch. - format: int64 - serviceAccount: + Name of the API or shared flow revision to be deployed in the + following format: `organizations/{org}/apis/{api}/revisions/{rev}` + or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` + type: string + uid: description: >- - The full resource name of Cloud IAM Service Account that this - deployment is using, eg, `projects/-/serviceAccounts/{email}`. + Unique ID. The ID will only change if the deployment is deleted and + recreated. type: string + location: + description: Location of the API proxy bundle as a URI. + type: string + attributes: + additionalProperties: + type: string + description: Additional key-value metadata for the deployment. + type: object + id: GoogleCloudApigeeV1DeploymentConfig + type: object + GoogleCloudApigeeV1OASDocumentation: + id: GoogleCloudApigeeV1OASDocumentation type: object - id: GoogleCloudApigeeV1Deployment - GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: properties: - scorePath: + format: + enum: + - FORMAT_UNSPECIFIED + - YAML + - JSON + enumDescriptions: + - The format is not available. + - YAML format. + - JSON format. type: string + description: Output only. The format of the input specification file contents. + readOnly: true + spec: description: >- - Optional. Return scores for this component. Example: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - description: >- - Filter scores by component path. Used custom filter instead of AIP-160 - as the use cases are highly constrained and predictable. - type: object - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter - GoogleCloudApigeeV1AsyncQueryResult: + Required. The documentation file contents for the OpenAPI + Specification. JSON and YAML file formats are supported. + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' + description: OpenAPI Specification documentation for a catalog item. + GoogleCloudApigeeV1SecurityAssessmentResult: + description: The security assessment result for one resource. + id: GoogleCloudApigeeV1SecurityAssessmentResult properties: - self: - description: >- - Self link of the query results. Example: - `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - or following format if query is running at host level: - `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - type: string - expires: + scoringResult: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + description: The result of the assessment. + error: + description: The error status if scoring fails. + $ref: '#/components/schemas/GoogleRpcStatus' + createTime: + format: google-datetime type: string - description: Query result will be unaccessable after this time. - type: object - id: GoogleCloudApigeeV1AsyncQueryResult - EdgeConfigstoreBundleBadBundle: + description: >- + The time of the assessment of this resource. This could lag behind + `assessment_time` due to caching within the backend. + resource: + description: The assessed resource. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource type: object - description: Describes why a bundle is invalid. Intended for use in error details. - properties: - violations: - type: array - description: Describes all precondition violations. - items: - $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' - id: EdgeConfigstoreBundleBadBundle - GoogleCloudApigeeV1EntityMetadata: + GoogleCloudApigeeV1SecurityActionsConfig: + id: GoogleCloudApigeeV1SecurityActionsConfig type: object - description: Metadata common to many entities in this API. + description: >- + SecurityActionsConfig reflects the current state of the SecurityActions + feature. This is a singleton resource: https://google.aip.dev/156 properties: - lastModifiedAt: - format: int64 - type: string + enabled: + type: boolean description: >- - Time at which the API proxy was most recently modified, in - milliseconds since epoch. - subType: - description: The type of entity described + The flag that controls whether this feature is enabled. This is + `unset` by default. When this flag is `false`, even if individual + rules are enabled, no SecurityActions will be enforced. + updateTime: + format: google-datetime type: string - createdAt: - format: int64 + description: Output only. The update time for configuration. + readOnly: true + name: type: string description: >- - Time at which the API proxy was created, in milliseconds since - epoch. - id: GoogleCloudApigeeV1EntityMetadata - GoogleIamV1TestIamPermissionsResponse: - properties: - permissions: - type: array - items: - type: string - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - description: Response message for `TestIamPermissions` method. - type: object - id: GoogleIamV1TestIamPermissionsResponse - GoogleCloudApigeeV1MetricAggregation: - id: GoogleCloudApigeeV1MetricAggregation + This is a singleton resource, the name will always be set by + SecurityActions and any user input will be ignored. The name is + always: + `organizations/{org}/environments/{env}/security_actions_config` + GoogleCloudApigeeV1SecurityProfileScoringConfig: type: object + description: Security configurations to manage scoring. + id: GoogleCloudApigeeV1SecurityProfileScoringConfig properties: - order: - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. - description: >- - Ordering for this aggregation in the result. For time series this is - ignored since the ordering of points depends only on the timestamp, - not the values. - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING + description: type: string - aggregation: - enum: - - AGGREGATION_FUNCTION_UNSPECIFIED - - AVG - - SUM - - MIN - - MAX - - COUNT_DISTINCT - enumDescriptions: - - Unspecified Aggregation function. - - Average. - - Summation. - - Min. - - Max. - - Count distinct + description: Description of the config. + title: type: string - description: Aggregation function associated with the metric. - name: + description: Title of the config. + scorePath: type: string - description: Name of the metric - description: The optionally aggregated metric to query with its ordering. - GoogleCloudApigeeV1ApiDocDocumentation: - id: GoogleCloudApigeeV1ApiDocDocumentation - properties: - graphqlDocumentation: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' - description: Optional. GraphQL documentation. - oasDocumentation: - $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' - description: Optional. OpenAPI Specification documentation. - description: The documentation for a catalog item. - type: object - GoogleCloudApigeeV1NatAddress: - type: object - id: GoogleCloudApigeeV1NatAddress + description: Path of the component config used for scoring. + GoogleCloudApigeeV1ApiCategory: description: >- - Apigee NAT(network address translation) address. A NAT address is a - static external IP address used for Internet egress traffic. + `ApiCategory` represents an API category. [Catalog + items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) + can be tagged with API categories; users viewing the API catalog in the + portal will have the option to browse the catalog by category. properties: + updateTime: + description: Time the category was last modified in milliseconds since epoch. + format: int64 + type: string name: - description: Required. Resource ID of the NAT address. type: string - ipAddress: - readOnly: true + description: Name of the category. + siteId: type: string - description: Output only. The static IPV4 address. - state: + description: Name of the portal. + id: + description: ID of the category (a UUID). type: string - readOnly: true - description: Output only. State of the nat address. - enumDescriptions: - - The resource is in an unspecified state. - - The NAT address is being created. - - The NAT address is reserved but not yet used for Internet egress. - - The NAT address is active and used for Internet egress. - - The NAT address is being deleted. - enum: - - STATE_UNSPECIFIED - - CREATING - - RESERVED - - ACTIVE - - DELETING - GoogleCloudApigeeV1Reference: - id: GoogleCloudApigeeV1Reference + id: GoogleCloudApigeeV1ApiCategory + type: object + GoogleCloudApigeeV1AsyncQueryResultView: type: object properties: - description: - description: Optional. A human-readable description of this reference. + state: + description: State of retrieving ResultView. type: string - name: + metadata: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' description: >- - Required. The resource id of this reference. Values must match the - regular expression [\w\s\-.]+. + Metadata contains information like metrics, dimenstions etc of the + AsyncQuery. + error: + description: Error message when there is a failure. type: string - refers: + rows: + type: array description: >- - Required. The id of the resource to which this reference refers. - Must be the id of a resource that exists in the parent environment - and is of the given resource_type. - type: string - resourceType: + Rows of query result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} + items: + type: any + code: + format: int32 + type: integer + description: Error code when there is a failure. + id: GoogleCloudApigeeV1AsyncQueryResultView + GoogleCloudApigeeV1APIProductAssociation: + type: object + id: GoogleCloudApigeeV1APIProductAssociation + properties: + status: type: string description: >- - The type of resource referred to by this reference. Valid values are - 'KeyStore' or 'TrustStore'. + The API product credential associated status. Valid values are + `approved` or `revoked`. + apiproduct: + type: string + description: API product to be associated with the credential. description: >- - A Reference configuration. References must refer to a keystore that also - exists in the parent environment. - GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: + APIProductAssociation has the API product and its administrative state + association. + GoogleCloudApigeeV1SecurityActionAllow: + properties: {} + id: GoogleCloudApigeeV1SecurityActionAllow + type: object + description: >- + Message that should be set in case of an Allow Action. This does not + have any fields. + GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: + description: >- + Describes a routing conflict that may cause a deployment not to receive + traffic at some base path. + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + properties: + description: + description: Human-readable description of this conflict. + type: string + environmentGroup: + description: Name of the environment group in which this conflict exists. + type: string + conflictingDeployment: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: Existing base path/deployment causing the conflict. + type: object + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: + type: object properties: nextPageToken: type: string description: >- A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - securityProfiles: + If this field is blank, there are no subsequent pages. + securityAssessmentResults: type: array - description: >- - List of security profile revisions. The revisions may be attached or - unattached to any environment. + description: Default sort order is by resource name in alphabetic order. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' - description: Response for ListSecurityProfileRevisions. - type: object - id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' + assessmentTime: + type: string + format: google-datetime + description: The time of the assessment api call. + description: Response for BatchComputeSecurityAssessmentResults. + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + GoogleCloudApigeeV1ScoreComponentRecommendation: + id: GoogleCloudApigeeV1ScoreComponentRecommendation type: object properties: - name: + impact: + format: int32 + description: >- + Potential impact of this recommendation on the overall score. This + denotes how important this recommendation is to improve the score. + type: integer + title: type: string - description: Required. Name of this resource. - type: - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY + description: Title represents recommendation title. + description: + description: Description of the recommendation. type: string - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. - description: Required. Type of this resource. - description: Resource for which we are computing security assessment. - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource - GoogleCloudApigeeV1EnvironmentConfig: + actions: + description: Actions for the recommendation to improve the security score. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction + description: Recommendation based on security concerns and score. + GoogleCloudApigeeV1ListEnvironmentGroupsResponse: + id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse + description: Response for ListEnvironmentGroups. properties: - envScopedRevisionId: + nextPageToken: description: >- - Revision ID for environment-scoped resources (e.g. target servers, - keystores) in this config. This ID will increment any time a - resource not scoped to a deployment group changes. + Page token that you can include in a ListEnvironmentGroups request + to retrieve the next page. If omitted, no subsequent pages exist. type: string - format: int64 - resourceReferences: - description: List of resource references in the environment. - type: array + environmentGroups: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' - provider: - description: >- - Used by the Control plane to add context information to help detect - the source of the document during diagnostics and debugging. - type: string - targets: - description: >- - List of target servers in the environment. Disabled target servers - are not displayed. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' type: array - name: - type: string - description: >- - Name of the environment configuration in the following format: - `organizations/{org}/environments/{env}/configs/{config}` - createTime: - type: string - format: google-datetime - description: Time that the environment configuration was created. - addonsConfig: - description: The latest runtime configurations for add-ons. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' - forwardProxyUri: + description: EnvironmentGroups in the specified organization. + type: object + GoogleCloudApigeeV1ApiProxy: + type: object + description: Metadata describing the API proxy + properties: + readOnly: + readOnly: true + type: boolean description: >- - The forward proxy's url to be used by the runtime. When set, runtime - will send requests to the target via the given forward proxy. This - is only used by programmable gateways. - type: string - deploymentGroups: - description: List of deployment groups in the environment. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' - deployments: - description: List of deployments in the environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' - type: array - featureFlags: + Output only. Whether this proxy is read-only. A read-only proxy + cannot have new revisions created through calls to + CreateApiProxyRevision. A proxy is read-only if it was generated by + an archive. + metaData: + description: Output only. Metadata describing the API proxy. + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + readOnly: true + labels: + type: object additionalProperties: type: string - type: object - description: Feature flags inherited from the organization and environment. - resources: - description: List of resource versions in the environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' - type: array - arcConfigLocation: - type: string - description: >- - The location for the config blob of API Runtime Control, aka Envoy - Adapter, for op-based authentication as a URI, e.g. a Cloud Storage - URI. This is only used by Envoy-based gateways. - gatewayConfigLocation: + description: User labels applied to this API Proxy. + latestRevisionId: description: >- - The location for the gateway config blob as a URI, e.g. a Cloud - Storage URI. This is only used by Envoy-based gateways. + Output only. The id of the most recently created revision for this + api proxy. type: string - revisionId: - format: int64 + readOnly: true + apiProxyType: + enumDescriptions: + - API proxy type not specified. + - >- + Programmable API Proxies enable you to develop APIs with highly + flexible behavior using bundled policy configuration and one or + more programming languages to describe complex sequential and/or + conditional flows of logic. + - >- + Configurable API Proxies enable you to develop efficient APIs + using simple configuration while complex execution control flow + logic is handled by Apigee. This type only works with the ARCHIVE + deployment type and cannot be combined with the PROXY deployment + type. + readOnly: true type: string - description: >- - Revision ID of the environment configuration. The higher the value, - the more recently the configuration was deployed. - sequenceNumber: - description: 'DEPRECATED: Use revision_id.' - format: int64 + description: Output only. The type of the API proxy. + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + revision: + readOnly: true + items: + type: string + type: array + description: Output only. List of revisions defined for the API proxy. + name: + readOnly: true type: string - keystores: + description: Output only. Name of the API proxy. + id: GoogleCloudApigeeV1ApiProxy + GoogleCloudApigeeV1Metadata: + description: Encapsulates additional information about query execution. + type: object + id: GoogleCloudApigeeV1Metadata + properties: + notices: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' - description: List of keystores in the environment. - debugMask: - description: Debug mask that applies to all deployments in the environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' - traceConfig: + type: string description: >- - Trace configurations. Contains config for the environment and config - overrides for specific API proxies. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' - dataCollectors: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' - description: List of data collectors used by the deployments in the environment. - type: array - flowhooks: + List of additional information such as data source, if result was + truncated. For example: ``` "notices": [ "Source:Postgres", "PG + Host:uappg0rw.e2e.apigeeks.net", "query served + by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: + edge.api.uapgroup2.agg_api" ]``` + errors: + description: List of error messages as strings. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' + type: string type: array - description: List of flow hooks in the environment. - pubsubTopic: + GoogleCloudApigeeV1SecurityReportResultView: + type: object + description: The response for security report result view APIs. + properties: + code: + type: integer + format: int32 + description: Error code when there is a failure. + error: + description: Error message when there is a failure. type: string - description: Name of the PubSub topic for the environment. - uid: + metadata: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + description: >- + Metadata contains information like metrics, dimenstions etc of the + security report. + state: type: string + description: State of retrieving ResultView. + rows: + type: array + items: + type: any description: >- - Unique ID for the environment configuration. The ID will only change - if the environment is deleted and recreated. - id: GoogleCloudApigeeV1EnvironmentConfig + Rows of security report result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} + id: GoogleCloudApigeeV1SecurityReportResultView + GoogleCloudApigeeV1EnableSecurityActionRequest: type: object - GoogleCloudApigeeV1Operation: + id: GoogleCloudApigeeV1EnableSecurityActionRequest + properties: {} + description: Message to enable a disabled SecurityAction. + GoogleCloudApigeeV1ListAppGroupsResponse: description: >- - Represents the pairing of REST resource path and the actions (verbs) - allowed on the resource path. + ListAppGroupsResponse contains the 0 or more AppGroups, along with the + optional page token and the total count of apps. + id: GoogleCloudApigeeV1ListAppGroupsResponse + type: object properties: - methods: - description: >- - methods refers to the REST verbs as in - https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none - specified, all verb types are allowed. - items: - type: string + appGroups: type: array - resource: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + description: List of AppGroups. + nextPageToken: description: >- - Required. REST resource path associated with the API proxy or remote - service. + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - id: GoogleCloudApigeeV1Operation - type: object - GoogleCloudApigeeV1SecurityProfile: - type: object + totalSize: + description: Total count of AppGroups. + type: integer + format: int32 + GoogleTypeMoney: + id: GoogleTypeMoney properties: - revisionId: + units: type: string - description: Output only. Revision ID of the security profile. - readOnly: true + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. format: int64 - minScore: - readOnly: true + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + nanos: + format: int32 type: integer description: >- - Output only. Minimum security score that can be generated by this - profile. - format: int32 - displayName: + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: object + description: Represents an amount of money with its currency type. + GoogleCloudApigeeV1ListEndpointAttachmentsResponse: + description: Response for ListEndpointAttachments method. + id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse + type: object + properties: + nextPageToken: + description: >- + Page token that you can include in an `ListEndpointAttachments` + request to retrieve the next page. If omitted, no subsequent pages + exist. type: string - deprecated: true - description: 'DEPRECATED: DO NOT USE Display name of the security profile.' - scoringConfigs: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig - description: List of profile scoring configs in this revision. - environments: + endpointAttachments: + description: Endpoint attachments in the specified organization. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' - description: List of environments attached to security profile. + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' type: array - revisionUpdateTime: - type: string - description: Output only. The time when revision was updated. - readOnly: true - format: google-datetime - name: - type: string - description: >- - Immutable. Name of the security profile resource. Format: - organizations/{org}/securityProfiles/{profile} - profileConfig: - description: >- - Required. Customized profile configuration that computes the - security score. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' - revisionPublishTime: - type: string - deprecated: true - format: google-datetime - description: >- - Output only. DEPRECATED: DO NOT USE The time when revision was - published. Once published, the security profile revision cannot be - updated further and can be attached to environments. - readOnly: true - maxScore: - readOnly: true - description: >- - Output only. Maximum security score that can be generated by this - profile. - type: integer - format: int32 - revisionCreateTime: - type: string - format: google-datetime - readOnly: true - description: Output only. The time when revision was created. - description: - description: Description of the security profile. - type: string - id: GoogleCloudApigeeV1SecurityProfile - description: Represents a SecurityProfile resource. - GoogleIamV1SetIamPolicyRequest: + GoogleCloudApigeeV1AppGroupApp: + id: GoogleCloudApigeeV1AppGroupApp properties: - updateMask: - format: google-fieldmask - description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` + callbackUrl: type: string - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - id: GoogleIamV1SetIamPolicyRequest - type: object - description: Request message for `SetIamPolicy` method. - GoogleCloudApigeeV1CustomReportMetric: - id: GoogleCloudApigeeV1CustomReportMetric - type: object - description: >- - This encapsulates a metric property of the form sum(message_count) where - name is message_count and function is sum - properties: - function: - type: string - description: aggregate function - name: + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to AppGroup apps. + appId: type: string - description: name of the metric - GoogleCloudApigeeV1DebugMask: - id: GoogleCloudApigeeV1DebugMask - type: object - properties: - variables: + description: Immutable. ID of the AppGroup app. + apiProducts: type: array items: type: string - description: List of variables that should be masked from the debug output. - faultJSONPaths: + description: List of API products associated with the AppGroup app. + scopes: items: type: string - type: array description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON payloads in error flows. - requestJSONPaths: + Scopes to apply to the AppGroup app. The specified scopes must + already exist for the API product that you associate with the + AppGroup app. type: array + keyExpiresIn: + format: int64 + type: string description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON request message payloads. - items: - type: string + Immutable. Expiration time, in seconds, for the consumer key that is + generated for the AppGroup app. If not set or left to the default + value of `-1`, the API key never expires. The expiration time can't + be updated after it is set. + status: + description: Status of the App. Valid values include `approved` or `revoked`. + type: string + appGroup: + description: >- + Immutable. Name of the parent AppGroup whose resource name format is + of syntax (organizations/*/appgroups/*). + type: string + lastModifiedAt: + readOnly: true + format: int64 + type: string + description: >- + Output only. Time the AppGroup app was modified in milliseconds + since epoch. + createdAt: + format: int64 + description: >- + Output only. Time the AppGroup app was created in milliseconds since + epoch. + type: string + readOnly: true name: - description: Name of the debug mask. type: string - namespaces: - type: object - additionalProperties: - type: string - description: Map of namespaces to URIs. - faultXPaths: description: >- - List of XPaths that specify the XML elements to be filtered from XML - payloads in error flows. - type: array + Immutable. Name of the AppGroup app whose resource name format is of + syntax (organizations/*/appgroups/*/apps/*). + attributes: + description: List of attributes for the AppGroup app. items: - type: string - responseXPaths: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' type: array - description: >- - List of XPaths that specify the XML elements to be filtered from XML - response message payloads. - items: - type: string - responseJSONPaths: - description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON response message payloads. + credentials: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' type: array - requestXPaths: + readOnly: true description: >- - List of XPaths that specify the XML elements to be filtered from XML - request message payloads. + Output only. Set of credentials for the AppGroup app consisting of + the consumer key/secret pairs associated with the API products. + description: >- + Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], + [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and + [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] + type: object + GoogleCloudApigeeV1ListSecurityActionsResponse: + id: GoogleCloudApigeeV1ListSecurityActionsResponse + type: object + properties: + securityActions: type: array items: - type: string - GoogleCloudApigeeV1ListDebugSessionsResponse: - id: GoogleCloudApigeeV1ListDebugSessionsResponse - properties: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + description: The SecurityActions for the specified environment. nextPageToken: - type: string - description: >- - Page token that you can include in a ListDebugSessionsRequest to - retrieve the next page. If omitted, no subsequent pages exist. - sessions: description: >- - Session info that includes debug session ID and the first - transaction creation timestamp. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Session' - type: array - type: object - GoogleCloudApigeeV1UpdateSecurityIncidentRequest: - id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest - type: object + 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 + description: >- + Contains a list of SecurityActions in response to a + ListSecurityActionRequest. + GoogleCloudApigeeV1Export: + id: GoogleCloudApigeeV1Export properties: - updateMask: + description: + type: string + description: Description of the export job. + state: description: >- - Required. The list of fields to update. Allowed fields are: - LINT.IfChange(allowed_update_fields_comment) - observability - LINT.ThenChange() + Output only. Status of the export job. Valid values include + `enqueued`, `running`, `completed`, and `failed`. + readOnly: true type: string - format: google-fieldmask - securityIncident: + created: + readOnly: true + type: string + description: Output only. Time the export job was created. + name: + type: string + description: Display name of the export job. + datastoreName: description: >- - Required. The security incident to update. Must contain all existing - populated fields of the current incident. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - description: Request for UpdateSecurityIncident. - GoogleCloudApigeeV1ProfileConfig: - description: >- - ProfileConfig defines a set of categories and policies which will be - used to compute security score. - id: GoogleCloudApigeeV1ProfileConfig - properties: - categories: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' - type: array - description: List of categories of profile config. - type: object - GoogleCloudApigeeV1ListEndpointAttachmentsResponse: - properties: - nextPageToken: + Name of the datastore that is the destination of the export job + [datastore] type: string + executionTime: description: >- - Page token that you can include in an `ListEndpointAttachments` - request to retrieve the next page. If omitted, no subsequent pages - exist. - endpointAttachments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' - type: array - description: Endpoint attachments in the specified organization. - description: Response for ListEndpointAttachments method. - type: object - id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse - GoogleCloudApigeeV1ApiProxy: - type: object - id: GoogleCloudApigeeV1ApiProxy - description: Metadata describing the API proxy - properties: - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - readOnly: true - description: Output only. Metadata describing the API proxy. - revision: - description: Output only. List of revisions defined for the API proxy. + Output only. Execution time for this export job. If the job is still + in progress, it will be set to the amount of time that has elapsed + since`created`, in seconds. Else, it will set to (`updated` - + `created`), in seconds. readOnly: true - items: - type: string - type: array - name: - description: Output only. Name of the API proxy. type: string + error: readOnly: true - labels: - description: User labels applied to this API Proxy. - type: object - additionalProperties: - type: string - readOnly: - type: boolean - description: >- - Output only. Whether this proxy is read-only. A read-only proxy - cannot have new revisions created through calls to - CreateApiProxyRevision. A proxy is read-only if it was generated by - an archive. - readOnly: true - apiProxyType: - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE + type: string + description: Output only. Error is set when export fails + updated: + description: Output only. Time the export job was last updated. readOnly: true - description: Output only. The type of the API proxy. - enumDescriptions: - - API proxy type not specified. - - >- - Programmable API Proxies enable you to develop APIs with highly - flexible behavior using bundled policy configuration and one or - more programming languages to describe complex sequential and/or - conditional flows of logic. - - >- - Configurable API Proxies enable you to develop efficient APIs - using simple configuration while complex execution control flow - logic is handled by Apigee. This type only works with the ARCHIVE - deployment type and cannot be combined with the PROXY deployment - type. type: string - latestRevisionId: + self: type: string readOnly: true description: >- - Output only. The id of the most recently created revision for this - api proxy. - GoogleCloudApigeeV1Attributes: + Output only. Self link of the export job. A URI that can be used to + retrieve the status of an export job. Example: + `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` type: object + description: Details of an export job. + GoogleCloudApigeeV1ListApiProductsResponse: properties: - attribute: + apiProduct: + description: Lists all API product names defined for an organization. type: array - description: List of attributes. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - id: GoogleCloudApigeeV1Attributes - GoogleCloudApigeeV1ProfileConfigMediation: - description: >- - By default, following policies will be included: - OASValidation - - SOAPMessageValidation - id: GoogleCloudApigeeV1ProfileConfigMediation - type: object - properties: {} - GoogleRpcPreconditionFailure: - description: >- - Describes what preconditions have failed. For example, if an RPC failed - because it required the Terms of Service to be acknowledged, it could - list the terms of service violation in the PreconditionFailure message. - id: GoogleRpcPreconditionFailure - properties: - violations: items: - $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' - description: Describes all precondition violations. - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + id: GoogleCloudApigeeV1ListApiProductsResponse type: object - GoogleCloudApigeeV1GrpcOperationConfig: - description: >- - Binds the resources in a proxy or remote service with the gRPC operation - and its associated quota enforcement. + GoogleCloudApigeeV1RatePlan: + description: Rate plan details. + id: GoogleCloudApigeeV1RatePlan properties: - attributes: - description: Custom attributes associated with the operation. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - apiSource: + fixedFeeFrequency: + type: integer + description: Frequency at which the fixed fee is charged. + format: int32 + name: + description: Output only. Name of the rate plan. + readOnly: true type: string - description: >- - Required. Name of the API proxy with which the gRPC operation and - quota are associated. - methods: - items: - type: string - type: array - description: >- - List of unqualified gRPC method names for the proxy to which quota - will be applied. If this field is empty, the Quota will apply to all - operations on the gRPC service defined on the proxy. Example: Given - a proxy that is configured to serve com.petstore.PetService, the - methods com.petstore.PetService.ListPets and - com.petstore.PetService.GetPet would be specified here as simply - ["ListPets", "GetPet"]. - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' - description: >- - Quota parameters to be enforced for the methods and API source - combination. If none are specified, quota enforcement will not be - done. - service: + description: + description: Description of the rate plan. type: string - description: >- - Required. gRPC Service name associated to be associated with the API - proxy, on which quota rules can be applied upon. - id: GoogleCloudApigeeV1GrpcOperationConfig - type: object - GoogleCloudApigeeV1ListOrganizationsResponse: - id: GoogleCloudApigeeV1ListOrganizationsResponse - type: object - properties: - organizations: + consumptionPricingRates: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' - description: List of Apigee organizations and associated Google Cloud projects. + $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' + description: >- + API call volume ranges and the fees charged when the total number of + API calls is within a given range. The method used to calculate the + final fee depends on the selected pricing model. For example, if the + pricing model is `STAIRSTEP` and the ranges are defined as follows: + ``` { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": + 200, "fee": 100 }, } ``` Then the following fees would be charged + based on the total number of API calls (assuming the currency + selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 + calls cost $100 The number of API calls cannot exceed 200. type: array - GoogleCloudApigeeV1AsyncQuery: - type: object - properties: - updated: + revenueShareType: + description: Method used to calculate the revenue that is shared with developers. type: string - description: Last updated timestamp for the query. - resultRows: + enumDescriptions: + - Revenue share type is not specified. + - >- + Fixed percentage of the total revenue will be shared. The + percentage to be shared can be configured by the API provider. + - >- + Amount of revenue shared depends on the number of API calls. The + API call volume ranges and the revenue share percentage for each + volume can be configured by the API provider. **Note**: Not + supported by Apigee at this time. + enum: + - REVENUE_SHARE_TYPE_UNSPECIFIED + - FIXED + - VOLUME_BANDED + apiproduct: type: string - description: ResultRows is available only after the query is completed. - format: int64 - reportDefinitionId: + description: Name of the API product that the rate plan is associated with. + state: + description: Current state of the rate plan (draft or published). type: string - description: Asynchronous Report ID. - envgroupHostname: + enumDescriptions: + - State of the rate plan is not specified. + - Rate plan is in draft mode and only visible to API providers. + - >- + Rate plan is published and will become visible to developers for + the configured duration (between `startTime` and `endTime`). + enum: + - STATE_UNSPECIFIED + - DRAFT + - PUBLISHED + consumptionPricingType: + enum: + - CONSUMPTION_PRICING_TYPE_UNSPECIFIED + - FIXED_PER_UNIT + - BANDED + - TIERED + - STAIRSTEP + enumDescriptions: + - Pricing model not specified. This is the default. + - Fixed rate charged for each API call. + - >- + Variable rate charged for each API call based on price tiers. + Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 + per call * 201-300 calls cost $1 per call * Total price for 50 + calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x + $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + + 50 x $1 = $400. **Note**: Not supported by Apigee at this time. + - '**Note**: Not supported by Apigee at this time.' + - '**Note**: Not supported by Apigee at this time.' type: string - description: Hostname is available only when query is executed at host level. - created: - description: Creation time of the query. + description: Pricing model used for consumption-based charges. + billingPeriod: + enumDescriptions: + - Billing period not specified. + - >- + Weekly billing period. **Note**: Not supported by Apigee at this + time. + - Monthly billing period. type: string - name: - type: string - description: Asynchronous Query Name. - resultFileSize: - type: string - description: ResultFileSize is available only after the query is completed. - self: + description: Frequency at which the customer will be billed. + enum: + - BILLING_PERIOD_UNSPECIFIED + - WEEKLY + - MONTHLY + revenueShareRates: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' + type: array + description: Details of the revenue sharing model. + startTime: + format: int64 type: string + description: Time when the rate plan becomes active in milliseconds since epoch. + currencyCode: description: >- - Self link of the query. Example: - `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - or following format if query is running at host level: - `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - executionTime: - description: ExecutionTime is available only after the query is completed. + Currency to be used for billing. Consists of a three-letter code as + defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) + standard. type: string - queryParams: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' + paymentFundingModel: + deprecated: true description: >- - Contains information like metrics, dimenstions etc of the - AsyncQuery. - error: - type: string - description: Error is set when query fails. - state: - type: string - description: Query state could be "enqueued", "running", "completed", "failed". - result: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' - description: Result is available only after the query is completed. - id: GoogleCloudApigeeV1AsyncQuery - GoogleCloudApigeeV1ApiDocResponse: - description: The catalog item resource wrapped with response status, error_code, etc. - properties: - requestId: - description: Unique ID of the request. - type: string - errorCode: - type: string - description: Unique error code for the request, if any. - status: - type: string - description: Status of the operation. - message: + DEPRECATED: This field is no longer supported and will eventually be + removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, + use the `billingType` field inside `DeveloperMonetizationConfig` + resource. Flag that specifies the billing account type, prepaid or + postpaid. type: string - description: Description of the operation. - data: - description: The catalog item resource. - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - type: object - id: GoogleCloudApigeeV1ApiDocResponse - GoogleCloudApigeeV1KeyValueEntry: - description: >- - Key value map pair where the value represents the data associated with - the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and - higher. - properties: - value: - description: >- - Required. Data or payload that is being retrieved and associated - with the unique key. + enumDescriptions: + - Billing account type not specified. + - >- + Prepaid billing account type. Developer pays in advance for the + use of your API products. Funds are deducted from their prepaid + account balance. **Note**: Not supported by Apigee at this time. + - >- + Postpaid billing account type. Developer is billed through an + invoice after using your API products. + enum: + - PAYMENT_FUNDING_MODEL_UNSPECIFIED + - PREPAID + - POSTPAID + endTime: + format: int64 type: string - name: description: >- - Resource URI that can be used to identify the scope of the key value - map entries. - type: string - type: object - id: GoogleCloudApigeeV1KeyValueEntry - GoogleCloudApigeeV1GraphqlDocumentation: - id: GoogleCloudApigeeV1GraphqlDocumentation - type: object - properties: - schema: - description: Required. The documentation file contents for the GraphQL schema. - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - endpointUri: + Time when the rate plan will expire in milliseconds since epoch. Set + to 0 or `null` to indicate that the rate plan should never expire. + setupFee: + $ref: '#/components/schemas/GoogleTypeMoney' + description: Initial, one-time fee paid when purchasing the API product. + lastModifiedAt: description: >- - Required. The GraphQL endpoint URI to be queried by API consumers. - Max length is 2,083 characters. - type: string - description: GraphQL documentation for a catalog item. - GoogleCloudApigeeV1ApiDocDocumentationResponse: - type: object - properties: - data: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' - readOnly: true - description: Output only. The documentation resource. - status: - readOnly: true - description: Output only. Status of the operation. - type: string - message: - readOnly: true - type: string - description: Output only. Description of the operation. - requestId: - type: string + Output only. Time the rate plan was last modified in milliseconds + since epoch. + format: int64 readOnly: true - description: Output only. Unique ID of the request. - errorCode: - description: Output only. Unique error code for the request, if any. type: string - readOnly: true - id: GoogleCloudApigeeV1ApiDocDocumentationResponse - description: >- - The catalog item documentation wrapped with response status, error_code, - etc. - GoogleCloudApigeeV1KeyAliasReference: - id: GoogleCloudApigeeV1KeyAliasReference - properties: - reference: + fixedRecurringFee: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Reference name in the following format: - `organizations/{org}/environments/{env}/references/{reference}` - type: string - aliasId: - description: Alias ID. Must exist in the keystore referred to by the reference. - type: string - type: object - GoogleCloudApigeeV1EnvironmentGroupAttachment: - description: >- - EnvironmentGroupAttachment is a resource which defines an attachment of - an environment to an environment group. - properties: + Fixed amount that is charged at a defined interval and billed in + advance of use of the API product. The fee will be prorated for the + first billing period. createdAt: - format: int64 description: >- - Output only. The time at which the environment group attachment was - created as milliseconds since epoch. - readOnly: true - type: string - environment: - description: Required. ID of the attached environment. - type: string - environmentGroupId: + Output only. Time that the rate plan was created in milliseconds + since epoch. type: string readOnly: true - description: Output only. ID of the environment group. - name: + format: int64 + displayName: type: string - description: ID of the environment group attachment. - id: GoogleCloudApigeeV1EnvironmentGroupAttachment + description: Display name of the rate plan. + type: object + GoogleCloudApigeeV1Query: + id: GoogleCloudApigeeV1Query type: object - GoogleCloudApigeeV1ListTraceConfigOverridesResponse: - id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse - description: Response for ListTraceConfigOverrides. properties: - traceConfigOverrides: + name: + type: string + description: Asynchronous Query Name. + metrics: + description: A list of Metrics. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' - description: List all trace configuration overrides in an environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' type: array - nextPageToken: + filter: description: >- - Token value that can be passed as `page_token` to retrieve the next - page of content. + Boolean expression that can be used to filter data. Filter + expressions can be combined using AND/OR terms and should be fully + parenthesized to avoid ambiguity. See Analytics metrics, dimensions, + and filters reference + https://docs.apigee.com/api-platform/analytics/analytics-reference + for more information on the fields available to filter on. For more + information on the tokens that you use to build filter expressions, + see Filter expression syntax. + https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax type: string - type: object - GoogleCloudApigeeV1AppGroupApp: - id: GoogleCloudApigeeV1AppGroupApp - type: object - properties: - attributes: - description: List of attributes for the AppGroup app. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - createdAt: + envgroupHostname: type: string - readOnly: true - format: int64 description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. - callbackUrl: + Hostname needs to be specified if query intends to run at host + level. This field is only allowed when query is submitted by + CreateHostAsyncQuery where analytics data will be grouped by + organization and hostname. + timeRange: + type: any + description: >- + Required. Time range for the query. Can use the following predefined + strings to specify the time range: `last60minutes` `last24hours` + `last7days` Or, specify the timeRange as a structure describing + start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": + "2018-08-01T00:18:00Z" } + limit: + description: Maximum number of rows that can be returned in the result. + type: integer + format: int32 + csvDelimiter: type: string description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to AppGroup apps. - apiProducts: - description: List of API products associated with the AppGroup app. + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + reportDefinitionId: + description: Asynchronous Report ID. + type: string + dimensions: + description: >- + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + type: array items: type: string - type: array - scopes: - type: array + outputFormat: + type: string description: >- - Scopes to apply to the AppGroup app. The specified scopes must - already exist for the API product that you associate with the - AppGroup app. + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. + groupByTimeUnit: + type: string + description: >- + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. + GoogleCloudApigeeV1ApiProxyRevision: + description: API proxy revision. + properties: + type: + type: string + description: >- + Type. Set to `Application`. Maintained for compatibility with the + Apigee Edge API. + integrationEndpoints: + description: >- + List of IntegrationEndpoints in the '/integration-endpoints' + directory of the API proxy. This is a 'manifest' setting designed to + provide visibility into the contents of the API proxy. + type: array items: type: string - appGroup: + hasExtensiblePolicy: + readOnly: true description: >- - Immutable. Name of the parent AppGroup whose resource name format is - of syntax (organizations/*/appgroups/*). + Output only. This field will be marked as true if revision contains + any policies marked as extensible. + type: boolean + revision: type: string - status: + description: API proxy revision. + sharedFlows: + description: List of the shared flows included in the API proxy revision. + type: array + items: + type: string + displayName: type: string - description: Status of the App. Valid values include `approved` or `revoked`. - keyExpiresIn: + description: Human-readable name of the API proxy. + createdAt: description: >- - Immutable. Expiration time, in seconds, for the consumer key that is - generated for the AppGroup app. If not set or left to the default - value of `-1`, the API key never expires. The expiration time can't - be updated after it is set. + Time that the API proxy revision was created in milliseconds since + epoch. type: string format: int64 + description: + type: string + description: Description of the API proxy revision. + targetEndpoints: + items: + type: string + type: array + description: >- + List of TargetEndpoints in the `/targets` directory of the API + proxy. Typically, this element is included only when the API proxy + was created using the Edge UI. This is a 'manifest' setting designed + to provide visibility into the contents of the API proxy. + policies: + items: + type: string + description: List of policy names included in the API proxy revision.. + type: array + resources: + type: array + description: >- + List of the resources included in the API proxy revision formatted + as "{type}://{name}". + items: + type: string + resourceFiles: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + description: List of resource files included in the API proxy revision. + spec: + description: >- + OpenAPI Specification that is associated with the API proxy. The + value is set to a URL or to a path in the specification store. + type: string lastModifiedAt: - readOnly: true description: >- - Output only. Time the AppGroup app was modified in milliseconds + Time that the API proxy revision was last modified in milliseconds since epoch. type: string format: int64 - appId: - description: Immutable. ID of the AppGroup app. - type: string + entityMetaDataAsProperties: + description: Metadata describing the API proxy revision as a key-value map. + type: object + additionalProperties: + type: string name: - description: >- - Immutable. Name of the AppGroup app whose resource name format is of - syntax (organizations/*/appgroups/*/apps/*). type: string - credentials: + description: Name of the API proxy. + targets: + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + type: string + description: List of the targets included in the API proxy revision. + targetServers: description: >- - Output only. Set of credentials for the AppGroup app consisting of - the consumer key/secret pairs associated with the API products. - readOnly: true + List of TargetServers referenced in any TargetEndpoint in the API + proxy. Typically, you will see this element only when the API proxy + was created using the Edge UI. This is a 'manifest' setting designed + to provide visibility into the contents of the API proxy. type: array - description: >- - Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], - [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and - [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] - GoogleCloudApigeeV1Certificate: - type: object - id: GoogleCloudApigeeV1Certificate - properties: - certInfo: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' - type: array - description: Chain of certificates under this name. - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: - type: object - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest - description: Request for BatchComputeSecurityAssessmentResults. - properties: - includeAllResources: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - description: Include all resources under the scope. - profile: - type: string - description: Required. Name of the profile that is used for computation. - pageToken: - type: string - description: >- - Optional. A page token, received from a previous - `BatchComputeSecurityAssessmentResults` call. Provide this to - retrieve the subsequent page. - scope: + type: string + contextInfo: type: string + description: Revision number, app name, and organization for the API proxy. + configurationVersion: + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' description: >- - Required. Scope of the resources for the computation. For Apigee, - the environment is the scope of the resources. - pageSize: - type: integer - description: >- - Optional. The maximum number of results to return. The service may - return fewer than this value. If unspecified, at most 50 results - will be returned. - format: int32 - include: - description: Include only these resources. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray - GoogleCloudApigeeV1OperationGroup: - properties: - operationConfigs: + Version of the API proxy configuration schema to which the API proxy + conforms. Currently, the only supported value is 4.0 + (`majorVersion.minorVersion`). This setting may be used in the + future to track the evolution of the API proxy format. + proxyEndpoints: + items: + type: string description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. + List of ProxyEndpoints in the `/proxies` directory of the API proxy. + Typically, this element is included only when the API proxy was + created using the Edge UI. This is a 'manifest' setting designed to + provide visibility into the contents of the API proxy. + type: array + basepaths: + description: Base URL of the API proxy. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' - operationConfigType: - description: >- - Flag that specifes whether the configuration is for Apigee API proxy - or a remote service. Valid values include `proxy` or - `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API - proxies are associated with the API product. Set to `remoteservice` - when non-Apigee proxies like Istio-Envoy are associated with the API - product. + type: string + proxies: + type: array + items: + type: string + description: List of proxy names included in the API proxy revision. + teams: + type: array + items: + type: string + description: List of the teams included in the API proxy revision. + archive: type: string + description: >- + Output only. The archive that generated this proxy revision. This + field is only present on proxy revisions that were generated by an + archive. Proxies generated by archives cannot be updated, deleted, + or deployed to other environments. Format: + `organizations/*/environments/*/archiveDeployments/*` + readOnly: true + id: GoogleCloudApigeeV1ApiProxyRevision type: object - id: GoogleCloudApigeeV1OperationGroup - description: >- - List of operation configuration details associated with Apigee API - proxies or remote services. Remote services are non-Apigee proxies, such - as Istio-Envoy. - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: - description: A Signed URL and the relevant metadata associated with it. + GoogleCloudApigeeV1DataCollector: + description: Data collector configuration. type: object properties: - md5: - description: The MD5 Hash of the JSON data - type: string - uri: - type: string + createdAt: description: >- - The signed URL of the JSON data. Will be of the form - `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= - GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount - .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 - 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 - 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 - 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc - c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 - 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a - 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 - a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 - 2ea7abedc098d2eb14a7` - sizeBytes: - description: The size of the returned file in bytes + Output only. The time at which the data collector was created in + milliseconds since the epoch. + readOnly: true type: string format: int64 - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - GoogleCloudApigeeV1RevisionStatus: - type: object - description: The status of a specific resource revision. - id: GoogleCloudApigeeV1RevisionStatus - properties: - revisionId: - description: The revision of the resource. - type: string - replicas: - format: int32 - description: The number of replicas that have successfully loaded this revision. - type: integer - jsonSpec: + type: + description: Immutable. The type of data this data collector will collect. + type: string + enumDescriptions: + - For future compatibility. + - For integer values. + - For float values. + - For string values. + - For boolean values. + - For datetime values. + enum: + - TYPE_UNSPECIFIED + - INTEGER + - FLOAT + - STRING + - BOOLEAN + - DATETIME + description: type: string + description: A description of the data collector. + lastModifiedAt: + readOnly: true + format: int64 description: >- - The json content of the resource revision. Large specs should be - sent individually via the spec field to avoid hitting request size - limits. - errors: + Output only. The time at which the Data Collector was last updated + in milliseconds since the epoch. + type: string + name: + type: string + description: ID of the data collector. Must begin with `dc_`. + id: GoogleCloudApigeeV1DataCollector + GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: + properties: + nextPageToken: + type: string + description: Next page token. + values: + description: Results of the query returned as a JSON array. + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence type: array + columns: + description: >- + Column names corresponding to the same order as the inner values in + the stats field. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' - description: Errors reported when attempting to load this revision. + type: string + type: array + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + description: >- + Represents security stats result as a collection of time series + sequences. + type: object + GoogleCloudApigeeV1QueryMetric: + type: object + description: >- + More info about Metric: + https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics + id: GoogleCloudApigeeV1QueryMetric + properties: + function: + description: 'Aggregation function: avg, min, max, or sum.' + type: string + name: + description: Required. Metric name. + type: string + value: + description: Operand value should be provided when operator is set. + type: string + operator: + type: string + description: One of `+`, `-`, `/`, `%`, `*`. + alias: + type: string + description: >- + Alias for the metric. Alias will be used to replace metric name in + query results. + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: + type: object + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + properties: + requests: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest + description: >- + Optional. Required. The request message specifying the resources to + update. A maximum of 1000 can be modified in a batch. + description: Request for BatchUpdateSecurityIncident. parameters: - callback: - description: JSONP + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: callback + name: fields schema: 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. + _.xgafv: + description: V1 error format. in: query - name: key + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string quotaUser: @@ -8750,16 +8756,26 @@ components: name: quotaUser schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + alt: + description: Data format for response. in: query - name: oauth_token + name: alt schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + enum: + - json + - media + - proto + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string prettyPrint: @@ -8768,306 +8784,227 @@ components: name: prettyPrint schema: type: boolean - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - access_token: - description: OAuth access token. + 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. in: query - name: access_token + name: key schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: upload_protocol + name: oauth_token schema: type: string - alt: - description: Data format for response. + callback: + description: JSONP in: query - name: alt + name: callback schema: type: string - enum: - - json - - media - - proto x-stackQL-resources: - issuers: - id: google.apigee.issuers - name: issuers - title: Issuers + projects: + id: google.apigee.projects + name: projects + title: Projects methods: - hybrid_issuers_list: + projects_provision_organization: operation: - $ref: '#/paths/~1v1~1hybrid~1issuers/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}:provisionOrganization/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list + select: [] insert: [] update: [] replace: [] delete: [] - reports: - id: google.apigee.reports - name: reports - title: Reports + apiproducts: + id: google.apigee.apiproducts + name: apiproducts + title: Apiproducts methods: - organizations_reports_delete: + organizations_appgroups_apps_keys_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_get: + organizations_developers_apps_keys_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_update: + organizations_apiproducts_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_list: + organizations_apiproducts_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_create: + organizations_apiproducts_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_attributes: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_get + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_list + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list insert: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_create + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_update + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update delete: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_delete - deployments: - id: google.apigee.deployments - name: deployments - title: Deployments + #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete + apiproducts_app_group_app_key_api_product: + id: google.apigee.apiproducts_app_group_app_key_api_product + name: apiproducts_app_group_app_key_api_product + title: Apiproducts_app_group_app_key_api_product methods: - organizations_apis_revisions_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_deployments_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_apis_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateUndeployChangeReport/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_deploy_change_report: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_sharedflows_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sharedflows_revisions_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sharedflows_deployments_list: + organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_deployments_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_deployments_list + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/apiproducts_app_group_app_key_api_product/methods/organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product replace: [] delete: [] - revisions: - id: google.apigee.revisions - name: revisions - title: Revisions + keys: + id: google.apigee.keys + name: keys + title: Keys methods: - organizations_apis_revisions_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_revisions_get: + organizations_appgroups_apps_keys_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deploy: + organizations_appgroups_apps_keys_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_undeploy: + organizations_appgroups_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_undeploy: + organizations_developers_apps_keys_replace_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_deploy: + organizations_developers_apps_keys_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_get: + organizations_developers_apps_keys_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_delete: + organizations_developers_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get - insert: [] + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get + insert: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_replace_developer_app_key delete: - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_delete + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_delete - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete - revisions_api_proxy_revision: - id: google.apigee.revisions_api_proxy_revision - name: revisions_api_proxy_revision - title: Revisions_api_proxy_revision + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete + keys_app_group_app_key: + id: google.apigee.keys_app_group_app_key + name: keys_app_group_app_key + title: Keys_app_group_app_key methods: - organizations_apis_revisions_update_api_proxy_revision: + organizations_appgroups_apps_keys_update_app_group_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post response: mediaType: application/json openAPIDocKey: '200' @@ -9076,404 +9013,457 @@ components: insert: [] update: - $ref: >- - #/components/x-stackQL-resources/revisions_api_proxy_revision/methods/organizations_apis_revisions_update_api_proxy_revision + #/components/x-stackQL-resources/keys_app_group_app_key/methods/organizations_appgroups_apps_keys_update_app_group_app_key replace: [] delete: [] - entries: - id: google.apigee.entries - name: entries - title: Entries + apps: + id: google.apigee.apps + name: apps + title: Apps methods: - organizations_apis_keyvaluemaps_entries_create: + organizations_appgroups_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_list: + organizations_appgroups_apps_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_apis_keyvaluemaps_entries_get: + organizations_appgroups_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_delete: + organizations_appgroups_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_update: + objectKey: $.appGroupApps + organizations_appgroups_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_update: + organizations_developers_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_delete: + organizations_developers_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_get: + organizations_developers_apps_generate_key_pair_or_update_developer_app_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_list: + organizations_developers_apps_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_environments_keyvaluemaps_entries_create: + organizations_developers_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_delete: + organizations_developers_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_update: + organizations_developers_apps_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_get: + organizations_apps_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_create: + organizations_apps_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.keyValueEntries + objectKey: $.app sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_list + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_get + #/components/x-stackQL-resources/apps/methods/organizations_apps_get - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_list + #/components/x-stackQL-resources/apps/methods/organizations_apps_list insert: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_create - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_create + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_update - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_update + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_update - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_update + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_update delete: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_delete - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_delete - keyvaluemaps: - id: google.apigee.keyvaluemaps - name: keyvaluemaps - title: Keyvaluemaps + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete + appgroups: + id: google.apigee.appgroups + name: appgroups + title: Appgroups methods: - organizations_apis_keyvaluemaps_delete: + organizations_appgroups_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_create: + objectKey: $.appGroups + organizations_appgroups_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_delete: + organizations_appgroups_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_create: + organizations_appgroups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_delete: + organizations_appgroups_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_keyvaluemaps_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list + insert: - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete + replace: - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update + delete: - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete - apis: - id: google.apigee.apis - name: apis - title: Apis + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete + host_stats: + id: google.apigee.host_stats + name: host_stats + title: Host_stats methods: - organizations_apis_patch: + organizations_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get + insert: [] + update: [] + replace: [] + delete: [] + canaryevaluations: + id: google.apigee.canaryevaluations + name: canaryevaluations + title: Canaryevaluations + methods: + organizations_instances_canaryevaluations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_get: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations~1{canaryevaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_list: + organizations_instances_canaryevaluations_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_get - - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_list + #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_get insert: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_create - update: - - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_patch + #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_create + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_delete - host_security_reports: - id: google.apigee.host_security_reports - name: host_security_reports - title: Host_security_reports + delete: [] + attachments: + id: google.apigee.attachments + name: attachments + title: Attachments methods: - organizations_host_security_reports_get: + organizations_instances_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_host_security_reports_create: + organizations_instances_attachments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_host_security_reports_list: + objectKey: $.attachments + organizations_instances_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list - insert: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create - update: [] - replace: [] - delete: [] - host_security_reports_result_view: - id: google.apigee.host_security_reports_result_view - name: host_security_reports_result_view - title: Host_security_reports_result_view - methods: - organizations_host_security_reports_get_result_view: + organizations_instances_attachments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view - insert: [] - update: [] - replace: [] - delete: [] - host_security_reports_result: - id: google.apigee.host_security_reports_result - name: host_security_reports_result - title: Host_security_reports_result - methods: - organizations_host_security_reports_get_result: + organizations_envgroups_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result - insert: [] - update: [] - replace: [] - delete: [] - developers_monetization_config: - id: google.apigee.developers_monetization_config - name: developers_monetization_config - title: Developers_monetization_config - methods: - organizations_developers_update_monetization_config: + organizations_envgroups_attachments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_get_monetization_config: + organizations_envgroups_attachments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.environmentGroupAttachments + organizations_envgroups_attachments_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config - insert: [] - update: [] - replace: + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get - $ref: >- - #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_update_monetization_config - delete: [] - developers: - id: google.apigee.developers - name: developers - title: Developers + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list + insert: + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete + nat_addresses: + id: google.apigee.nat_addresses + name: nat_addresses + title: Nat_addresses methods: - organizations_developers_create: + organizations_instances_nat_addresses_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_list: + organizations_instances_nat_addresses_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_update: + organizations_instances_nat_addresses_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_nat_addresses_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.natAddresses + organizations_instances_nat_addresses_activate: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}:activate/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_get + - $ref: >- + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_list + insert: + - $ref: >- + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_delete + instances: + id: google.apigee.instances + name: instances + title: Instances + methods: + organizations_instances_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instances + organizations_instances_report_status: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_get + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_list + insert: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_create + update: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_delete + developers: + id: google.apigee.developers + name: developers + title: Developers + methods: + organizations_developers_set_developer_status: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post response: mediaType: application/json openAPIDocKey: '200' @@ -9491,10 +9481,22 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_set_developer_status: + organizations_developers_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' response: mediaType: application/json openAPIDocKey: '200' @@ -9521,6 +9523,35 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/developers/methods/organizations_developers_delete + developers_monetization_config: + id: google.apigee.developers_monetization_config + name: developers_monetization_config + title: Developers_monetization_config + methods: + organizations_developers_update_monetization_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_get_monetization_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_update_monetization_config + delete: [] attributes: id: google.apigee.attributes name: attributes @@ -9533,17 +9564,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_delete: + organizations_developers_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_get: + organizations_developers_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -9575,17 +9606,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_delete: + organizations_apiproducts_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_get: + organizations_apiproducts_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -9653,1276 +9684,1268 @@ components: #/components/x-stackQL-resources/attributes_developer_attribute/methods/organizations_developers_attributes_update_developer_attribute replace: [] delete: [] - apps: - id: google.apigee.apps - name: apps - title: Apps + subscriptions: + id: google.apigee.subscriptions + name: subscriptions + title: Subscriptions methods: - organizations_developers_apps_attributes: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_apps_update: + organizations_developers_subscriptions_expire: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_get: + organizations_developers_subscriptions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_delete: + organizations_developers_subscriptions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_generate_key_pair_or_update_developer_app_status: + organizations_developers_subscriptions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create + update: [] + replace: [] + delete: [] + balance: + id: google.apigee.balance + name: balance + title: Balance + methods: + organizations_developers_balance_adjust: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_list: + organizations_developers_balance_credit: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_delete: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + keys_developer_app_key: + id: google.apigee.keys_developer_app_key + name: keys_developer_app_key + title: Keys_developer_app_key + methods: + organizations_developers_apps_keys_update_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_update: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/keys_developer_app_key/methods/organizations_developers_apps_keys_update_developer_app_key + replace: [] + delete: [] + create: + id: google.apigee.create + name: create + title: Create + methods: + organizations_developers_apps_keys_create_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_get: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create + update: [] + replace: [] + delete: [] + apiproducts_developer_app_key_api_product: + id: google.apigee.apiproducts_developer_app_key_api_product + name: apiproducts_developer_app_key_api_product + title: Apiproducts_developer_app_key_api_product + methods: + organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_list: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/apiproducts_developer_app_key_api_product/methods/organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product + replace: [] + delete: [] + attributes_developer_app_attribute: + id: google.apigee.attributes_developer_app_attribute + name: attributes_developer_app_attribute + title: Attributes_developer_app_attribute + methods: + organizations_developers_apps_attributes_update_developer_app_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.appGroupApps - organizations_appgroups_apps_create: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/attributes_developer_app_attribute/methods/organizations_developers_apps_attributes_update_developer_app_attribute + replace: [] + delete: [] + host_security_reports: + id: google.apigee.host_security_reports + name: host_security_reports + title: Host_security_reports + methods: + organizations_host_security_reports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apps_list: + objectKey: $.securityReports + organizations_host_security_reports_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.app - organizations_apps_get: + organizations_host_security_reports_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_get + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_list + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list insert: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_update - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_update - delete: - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete - attributes_developer_app_attribute: - id: google.apigee.attributes_developer_app_attribute - name: attributes_developer_app_attribute - title: Attributes_developer_app_attribute + replace: [] + delete: [] + host_security_reports_result_view: + id: google.apigee.host_security_reports_result_view + name: host_security_reports_result_view + title: Host_security_reports_result_view methods: - organizations_developers_apps_attributes_update_developer_app_attribute: + organizations_host_security_reports_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: + select: - $ref: >- - #/components/x-stackQL-resources/attributes_developer_app_attribute/methods/organizations_developers_apps_attributes_update_developer_app_attribute + #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view + insert: [] + update: [] replace: [] delete: [] - apiproducts_developer_app_key_api_product: - id: google.apigee.apiproducts_developer_app_key_api_product - name: apiproducts_developer_app_key_api_product - title: Apiproducts_developer_app_key_api_product + host_security_reports_result: + id: google.apigee.host_security_reports_result + name: host_security_reports_result + title: Host_security_reports_result methods: - organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: + organizations_host_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: + select: - $ref: >- - #/components/x-stackQL-resources/apiproducts_developer_app_key_api_product/methods/organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product + #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result + insert: [] + update: [] replace: [] delete: [] - apiproducts: - id: google.apigee.apiproducts - name: apiproducts - title: Apiproducts + endpoint_attachments: + id: google.apigee.endpoint_attachments + name: endpoint_attachments + title: Endpoint_attachments methods: - organizations_developers_apps_keys_apiproducts_delete: + organizations_endpoint_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_apiproducts_delete: + organizations_endpoint_attachments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_create: + objectKey: $.endpointAttachments + organizations_endpoint_attachments_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_list: + organizations_endpoint_attachments_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_get + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_list + insert: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete + security_profiles: + id: google.apigee.security_profiles + name: security_profiles + title: Security_profiles + methods: + organizations_security_profiles_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_update: + organizations_security_profiles_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_delete: + objectKey: $.securityProfiles + organizations_security_profiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes: + organizations_security_profiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_security_profiles_patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_get - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_list insert: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create - update: [] - replace: + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_create + update: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete - create: - id: google.apigee.create - name: create - title: Create - methods: - organizations_developers_apps_keys_create_create: + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_delete + security_profiles_revisions: + id: google.apigee.security_profiles_revisions + name: security_profiles_revisions + title: Security_profiles_revisions + methods: + organizations_security_profiles_list_revisions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}:listRevisions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.securityProfiles sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create + #/components/x-stackQL-resources/security_profiles_revisions/methods/organizations_security_profiles_list_revisions + insert: [] update: [] replace: [] delete: [] - keys: - id: google.apigee.keys - name: keys - title: Keys + environments: + id: google.apigee.environments + name: environments + title: Environments methods: - organizations_developers_apps_keys_create: + organizations_security_profiles_environments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_replace_developer_app_key: + organizations_security_profiles_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_delete: + organizations_security_profiles_environments_compute_environment_scores: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_get: + organizations_environments_subscribe: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_create: + organizations_environments_modify_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_get: + organizations_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_delete: + organizations_environments_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_unsubscribe: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get + #/components/x-stackQL-resources/environments/methods/organizations_environments_get insert: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create + #/components/x-stackQL-resources/environments/methods/organizations_environments_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_replace_developer_app_key + #/components/x-stackQL-resources/environments/methods/organizations_environments_update delete: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_delete - keys_developer_app_key: - id: google.apigee.keys_developer_app_key - name: keys_developer_app_key - title: Keys_developer_app_key + #/components/x-stackQL-resources/environments/methods/organizations_environments_delete + reports: + id: google.apigee.reports + name: reports + title: Reports methods: - organizations_developers_apps_keys_update_developer_app_key: + organizations_reports_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/keys_developer_app_key/methods/organizations_developers_apps_keys_update_developer_app_key - replace: [] - delete: [] - subscriptions: - id: google.apigee.subscriptions - name: subscriptions - title: Subscriptions - methods: - organizations_developers_subscriptions_get: + organizations_reports_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_create: + organizations_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_list: + organizations_reports_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_expire: + organizations_reports_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get + #/components/x-stackQL-resources/reports/methods/organizations_reports_get - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list + #/components/x-stackQL-resources/reports/methods/organizations_reports_list insert: - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create + #/components/x-stackQL-resources/reports/methods/organizations_reports_create update: [] - replace: [] - delete: [] - balance: - id: google.apigee.balance - name: balance - title: Balance + replace: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_update + delete: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_delete + deployments: + id: google.apigee.deployments + name: deployments + title: Deployments methods: - organizations_developers_balance_adjust: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_balance_credit: + organizations_sharedflows_revisions_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - canaryevaluations: - id: google.apigee.canaryevaluations - name: canaryevaluations - title: Canaryevaluations - methods: - organizations_instances_canaryevaluations_get: + organizations_sharedflows_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations~1{canaryevaluationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_canaryevaluations_create: + organizations_apis_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_get - insert: - - $ref: >- - #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_create - update: [] - replace: [] - delete: [] - nat_addresses: - id: google.apigee.nat_addresses - name: nat_addresses - title: Nat_addresses - methods: - organizations_instances_nat_addresses_create: + organizations_apis_revisions_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_list: + organizations_environments_deployments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.natAddresses - organizations_instances_nat_addresses_get: + organizations_environments_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_delete: + organizations_environments_apis_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_activate: + organizations_environments_apis_revisions_deployments_generate_deploy_change_report: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}:activate/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_get - - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_list - insert: - - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_delete - attachments: - id: google.apigee.attachments - name: attachments - title: Attachments - methods: - organizations_instances_attachments_create: + organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateUndeployChangeReport/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_list: + organizations_environments_sharedflows_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.attachments - organizations_instances_attachments_get: + organizations_deployments_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete - response: - mediaType: application/json + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_deployments_list + insert: [] + update: [] + replace: [] + delete: [] + revisions_shared_flow_revision: + id: google.apigee.revisions_shared_flow_revision + name: revisions_shared_flow_revision + title: Revisions_shared_flow_revision + methods: + organizations_sharedflows_revisions_update_shared_flow_revision: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post + response: + mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_delete: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_shared_flow_revision/methods/organizations_sharedflows_revisions_update_shared_flow_revision + replace: [] + delete: [] + revisions: + id: google.apigee.revisions + name: revisions + title: Revisions + methods: + organizations_sharedflows_revisions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_get: + organizations_sharedflows_revisions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_create: + organizations_apis_revisions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_list: + organizations_apis_revisions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.environmentGroupAttachments - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list - insert: - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete - instances: - id: google.apigee.instances - name: instances - title: Instances - methods: - organizations_instances_patch: + organizations_environments_apis_revisions_undeploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_get: + organizations_environments_apis_revisions_deploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_delete: + organizations_environments_sharedflows_revisions_deploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_create: + organizations_environments_sharedflows_revisions_undeploy: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_delete + sharedflows: + id: google.apigee.sharedflows + name: sharedflows + title: Sharedflows + methods: + organizations_sharedflows_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.instances - organizations_instances_report_status: + organizations_sharedflows_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sharedflows_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sharedflows_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_get + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_get - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_list + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_list insert: - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_create - update: - - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_patch + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_delete - security_assessment_results: - id: google.apigee.security_assessment_results - name: security_assessment_results - title: Security_assessment_results + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete + optimized_host_stats: + id: google.apigee.optimized_host_stats + name: optimized_host_stats + title: Optimized_host_stats methods: - organizations_security_assessment_results_batch_compute: + organizations_optimized_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post + #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/optimized_host_stats/methods/organizations_optimized_host_stats_get insert: [] update: [] replace: [] delete: [] - overrides: - id: google.apigee.overrides - name: overrides - title: Overrides + datacollectors: + id: google.apigee.datacollectors + name: datacollectors + title: Datacollectors methods: - organizations_environments_trace_config_overrides_create: + organizations_datacollectors_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_list: + organizations_datacollectors_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.traceConfigOverrides - organizations_environments_trace_config_overrides_get: + organizations_datacollectors_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_delete: + organizations_datacollectors_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_patch: + objectKey: $.dataCollectors + organizations_datacollectors_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list insert: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create update: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_patch + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete - resourcefiles: - id: google.apigee.resourcefiles - name: resourcefiles - title: Resourcefiles + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete + host_queries_result: + id: google.apigee.host_queries_result + name: host_queries_result + title: Host_queries_result methods: - organizations_environments_resourcefiles_list: + organizations_host_queries_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result + insert: [] + update: [] + replace: [] + delete: [] + host_queries: + id: google.apigee.host_queries + name: host_queries + title: Host_queries + methods: + organizations_host_queries_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_update: + organizations_host_queries_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/put + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_get: + organizations_host_queries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_resourcefiles_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_get + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list insert: - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_create + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_update - delete: - - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_delete - resourcefiles_environment_resources: - id: google.apigee.resourcefiles_environment_resources - name: resourcefiles_environment_resources - title: Resourcefiles_environment_resources + replace: [] + delete: [] + host_queries_result_view: + id: google.apigee.host_queries_result_view + name: host_queries_result_view + title: Host_queries_result_view methods: - organizations_environments_resourcefiles_list_environment_resources: + organizations_host_queries_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/resourcefiles_environment_resources/methods/organizations_environments_resourcefiles_list_environment_resources + #/components/x-stackQL-resources/host_queries_result_view/methods/organizations_host_queries_get_result_view insert: [] update: [] replace: [] delete: [] - admin_schemav2: - id: google.apigee.admin_schemav2 - name: admin_schemav2 - title: Admin_schemav2 + apidocs_documentation: + id: google.apigee.apidocs_documentation + name: apidocs_documentation + title: Apidocs_documentation methods: - organizations_environments_analytics_admin_get_schemav2: + organizations_sites_apidocs_get_documentation: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sites_apidocs_update_documentation: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_update_documentation replace: [] delete: [] - exports: - id: google.apigee.exports - name: exports - title: Exports + apidocs: + id: google.apigee.apidocs + name: apidocs + title: Apidocs methods: - organizations_environments_analytics_exports_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_analytics_exports_create: + organizations_sites_apidocs_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_analytics_exports_get: + objectKey: $.data + organizations_sites_apidocs_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get - - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list - insert: - - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create - update: [] - replace: [] - delete: [] - deployments_iam_policies: - id: google.apigee.deployments_iam_policies - name: deployments_iam_policies - title: Deployments_iam_policies - methods: - organizations_environments_deployments_set_iam_policy: + organizations_sites_apidocs_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:setIamPolicy/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_deployments_test_iam_permissions: + organizations_sites_apidocs_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:testIamPermissions/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_deployments_get_iam_policy: + organizations_sites_apidocs_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:getIamPolicy/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_get_iam_policy - insert: [] + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_set_iam_policy - delete: [] - optimized_stats: - id: google.apigee.optimized_stats - name: optimized_stats - title: Optimized_stats + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update + delete: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete + apicategories: + id: google.apigee.apicategories + name: apicategories + title: Apicategories methods: - organizations_environments_optimized_stats_get: + organizations_sites_apicategories_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1optimizedStats~1{optimizedStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/optimized_stats/methods/organizations_environments_optimized_stats_get - insert: [] - update: [] - replace: [] - delete: [] - keystores: - id: google.apigee.keystores - name: keystores - title: Keystores - methods: - organizations_environments_keystores_delete: + organizations_sites_apicategories_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_get: + organizations_sites_apicategories_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_create: + organizations_sites_apicategories_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sites_apicategories_patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get + - $ref: >- + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list insert: - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create - update: [] + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create + update: + - $ref: >- + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete - aliases: - id: google.apigee.aliases - name: aliases - title: Aliases + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete + entries: + id: google.apigee.entries + name: entries + title: Entries methods: - organizations_environments_keystores_aliases_create: + organizations_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_get: + organizations_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_update: + organizations_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_delete: + organizations_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_csr: + objectKey: $.keyValueEntries + organizations_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get - insert: - - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update - delete: - - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete - aliases_certificate: - id: google.apigee.aliases_certificate - name: aliases_certificate - title: Aliases_certificate - methods: - organizations_environments_keystores_aliases_get_certificate: + organizations_apis_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate - insert: [] - update: [] - replace: [] - delete: [] - security_reports_result: - id: google.apigee.security_reports_result - name: security_reports_result - title: Security_reports_result - methods: - organizations_environments_security_reports_get_result: + objectKey: $.keyValueEntries + organizations_apis_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result - insert: [] - update: [] - replace: [] - delete: [] - security_reports: - id: google.apigee.security_reports - name: security_reports - title: Security_reports - methods: - organizations_environments_security_reports_create: + organizations_apis_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_reports_list: + organizations_apis_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports - organizations_environments_security_reports_get: + organizations_apis_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get - - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list - insert: - - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create - update: [] - replace: [] - delete: [] - security_reports_result_view: - id: google.apigee.security_reports_result_view - name: security_reports_result_view - title: Security_reports_result_view - methods: - organizations_environments_security_reports_get_result_view: + organizations_environments_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view - insert: [] - update: [] - replace: [] - delete: [] - queries: - id: google.apigee.queries - name: queries - title: Queries - methods: - organizations_environments_queries_list: + organizations_environments_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_create: + organizations_environments_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_get: + organizations_environments_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' + organizations_environments_keyvaluemaps_entries_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.keyValueEntries sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_get + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_list + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_list + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_list insert: - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_create + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_create + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_create + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create update: [] - replace: [] - delete: [] - queries_result: - id: google.apigee.queries_result - name: queries_result - title: Queries_result + replace: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_update + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_update + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_update + delete: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_delete + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_delete + keyvaluemaps: + id: google.apigee.keyvaluemaps + name: keyvaluemaps + title: Keyvaluemaps methods: - organizations_environments_queries_get_result: + organizations_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result - insert: [] - update: [] - replace: [] - delete: [] - queries_resulturl: - id: google.apigee.queries_resulturl - name: queries_resulturl - title: Queries_resulturl - methods: - organizations_environments_queries_get_resulturl: + organizations_keyvaluemaps_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1resulturl/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/queries_resulturl/methods/organizations_environments_queries_get_resulturl - insert: [] - update: [] - replace: [] - delete: [] - data: - id: google.apigee.data - name: data - title: Data - methods: - organizations_environments_apis_revisions_debugsessions_data_get: + organizations_apis_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data~1{dataId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get - insert: [] - update: [] - replace: [] - delete: [] - debugsessions: - id: google.apigee.debugsessions - name: debugsessions - title: Debugsessions - methods: - organizations_environments_apis_revisions_debugsessions_create: + organizations_apis_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_debugsessions_list: + organizations_environments_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sessions - organizations_environments_apis_revisions_debugsessions_get: + organizations_environments_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: + select: [] + insert: - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list - insert: + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create update: [] replace: [] - delete: [] - debugsessions_data: - id: google.apigee.debugsessions_data - name: debugsessions_data - title: Debugsessions_data + delete: + - $ref: >- + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete + - $ref: >- + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete + - $ref: >- + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete + security_assessment_results: + id: google.apigee.security_assessment_results + name: security_assessment_results + title: Security_assessment_results methods: - organizations_environments_apis_revisions_debugsessions_delete_data: + organizations_security_assessment_results_batch_compute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post response: mediaType: application/json openAPIDocKey: '200' @@ -10931,397 +10954,385 @@ components: insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/debugsessions_data/methods/organizations_environments_apis_revisions_debugsessions_delete_data - revisions_deployments: - id: google.apigee.revisions_deployments - name: revisions_deployments - title: Revisions_deployments + delete: [] + revisions_api_proxy_revision: + id: google.apigee.revisions_api_proxy_revision + name: revisions_api_proxy_revision + title: Revisions_api_proxy_revision methods: - organizations_environments_apis_revisions_get_deployments: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_get_deployments: + organizations_apis_revisions_update_api_proxy_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_apis_revisions_get_deployments - - $ref: >- - #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_sharedflows_revisions_get_deployments + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_api_proxy_revision/methods/organizations_apis_revisions_update_api_proxy_revision replace: [] delete: [] - archive_deployments: - id: google.apigee.archive_deployments - name: archive_deployments - title: Archive_deployments - methods: - organizations_environments_archive_deployments_generate_download_url: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_archive_deployments_generate_upload_url: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments:generateUploadUrl/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_archive_deployments_delete: + apis: + id: google.apigee.apis + name: apis + title: Apis + methods: + organizations_apis_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_patch: + organizations_apis_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/patch + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_get: + organizations_apis_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_create: + organizations_apis_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_list: + organizations_apis_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.archiveDeployments sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get + #/components/x-stackQL-resources/apis/methods/organizations_apis_get - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list + #/components/x-stackQL-resources/apis/methods/organizations_apis_list insert: - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create + #/components/x-stackQL-resources/apis/methods/organizations_apis_create update: - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_patch + #/components/x-stackQL-resources/apis/methods/organizations_apis_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete - targetservers: - id: google.apigee.targetservers - name: targetservers - title: Targetservers + #/components/x-stackQL-resources/apis/methods/organizations_apis_delete + operations: + id: google.apigee.operations + name: operations + title: Operations methods: - organizations_environments_targetservers_get: + organizations_operations_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_delete: + objectKey: $.operations + organizations_operations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_update: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_operations_list + insert: [] + update: [] + replace: [] + delete: [] + attributes_api_product_attribute: + id: google.apigee.attributes_api_product_attribute + name: attributes_api_product_attribute + title: Attributes_api_product_attribute + methods: + organizations_apiproducts_attributes_update_api_product_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_create: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/attributes_api_product_attribute/methods/organizations_apiproducts_attributes_update_api_product_attribute + replace: [] + delete: [] + rateplans: + id: google.apigee.rateplans + name: rateplans + title: Rateplans + methods: + organizations_apiproducts_rateplans_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_get - insert: - - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update - delete: - - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete - references: - id: google.apigee.references - name: references - title: References - methods: - organizations_environments_references_update: + organizations_apiproducts_rateplans_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_delete: + organizations_apiproducts_rateplans_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_get: + organizations_apiproducts_rateplans_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_create: + organizations_apiproducts_rateplans_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_get + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get + - $ref: >- + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list insert: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_create + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_update + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update delete: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete - addons_config: - id: google.apigee.addons_config - name: addons_config - title: Addons_config - methods: - organizations_environments_addons_config_set_addon_enablement: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - security_incidents: - id: google.apigee.security_incidents - name: security_incidents - title: Security_incidents + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete + environments_iam_policies: + id: google.apigee.environments_iam_policies + name: environments_iam_policies + title: Environments_iam_policies methods: - organizations_environments_security_incidents_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_security_incidents_patch: + organizations_environments_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_incidents_batch_update: + organizations_environments_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_incidents_list: + organizations_environments_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityIncidents + objectKey: $.bindings sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get - - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_batch_update - replace: [] + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_set_iam_policy delete: [] - security_stats: - id: google.apigee.security_stats - name: security_stats - title: Security_stats + environments_trace_config: + id: google.apigee.environments_trace_config + name: environments_trace_config + title: Environments_trace_config methods: - organizations_environments_security_stats_query_time_series_stats: + organizations_environments_update_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_stats_query_tabular_stats: + organizations_environments_get_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_update_trace_config replace: [] delete: [] - stats: - id: google.apigee.stats - name: stats - title: Stats + environments_deployed_config: + id: google.apigee.environments_deployed_config + name: environments_deployed_config + title: Environments_deployed_config methods: - organizations_environments_stats_get: + organizations_environments_get_deployed_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1stats~1{statsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get + #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config insert: [] update: [] replace: [] delete: [] - security_actions: - id: google.apigee.security_actions - name: security_actions - title: Security_actions + environments_debugmask: + id: google.apigee.environments_debugmask + name: environments_debugmask + title: Environments_debugmask methods: - organizations_environments_security_actions_create: + organizations_environments_update_debugmask: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_list: + organizations_environments_get_debugmask: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityActions - organizations_environments_security_actions_enable: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_update_debugmask + replace: [] + delete: [] + environments_environment: + id: google.apigee.environments_environment + name: environments_environment + title: Environments_environment + methods: + organizations_environments_update_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_get: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_environment/methods/organizations_environments_update_environment + replace: [] + delete: [] + environments_security_actions_config: + id: google.apigee.environments_security_actions_config + name: environments_security_actions_config + title: Environments_security_actions_config + methods: + organizations_environments_get_security_actions_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_disable: + organizations_environments_update_security_actions_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get - - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list - insert: + #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_get_security_actions_config + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create - update: [] + #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_update_security_actions_config replace: [] delete: [] - flowhooks: - id: google.apigee.flowhooks - name: flowhooks - title: Flowhooks + environments_api_security_runtime_config: + id: google.apigee.environments_api_security_runtime_config + name: environments_api_security_runtime_config + title: Environments_api_security_runtime_config methods: - organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: + organizations_environments_get_api_security_runtime_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_flowhooks_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config + insert: [] + update: [] + replace: [] + delete: [] + environments_addons_config: + id: google.apigee.environments_addons_config + name: environments_addons_config + title: Environments_addons_config + methods: + organizations_environments_get_addons_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get + #/components/x-stackQL-resources/environments_addons_config/methods/organizations_environments_get_addons_config insert: [] update: [] replace: [] @@ -11346,1249 +11357,1285 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete - environments_iam_policies: - id: google.apigee.environments_iam_policies - name: environments_iam_policies - title: Environments_iam_policies + flowhooks: + id: google.apigee.flowhooks + name: flowhooks + title: Flowhooks methods: - organizations_environments_set_iam_policy: + organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get_iam_policy: + organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - organizations_environments_test_iam_permissions: + organizations_environments_flowhooks_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy + #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get insert: [] update: [] - replace: + replace: [] + delete: [] + stats: + id: google.apigee.stats + name: stats + title: Stats + methods: + organizations_environments_stats_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1stats~1{statsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_set_iam_policy + #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get + insert: [] + update: [] + replace: [] delete: [] - environments: - id: google.apigee.environments - name: environments - title: Environments + deployments_iam_policies: + id: google.apigee.deployments_iam_policies + name: deployments_iam_policies + title: Deployments_iam_policies methods: - organizations_environments_create: + organizations_environments_deployments_set_iam_policy: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_delete: + organizations_environments_deployments_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update: + organizations_environments_deployments_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get: + objectKey: $.bindings + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_set_iam_policy + delete: [] + data: + id: google.apigee.data + name: data + title: Data + methods: + organizations_environments_apis_revisions_debugsessions_data_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data~1{dataId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_modify_environment: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get + insert: [] + update: [] + replace: [] + delete: [] + debugsessions_data: + id: google.apigee.debugsessions_data + name: debugsessions_data + title: Debugsessions_data + methods: + organizations_environments_apis_revisions_debugsessions_delete_data: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_unsubscribe: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/debugsessions_data/methods/organizations_environments_apis_revisions_debugsessions_delete_data + debugsessions: + id: google.apigee.debugsessions + name: debugsessions + title: Debugsessions + methods: + organizations_environments_apis_revisions_debugsessions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_subscribe: + objectKey: $.sessions + organizations_environments_apis_revisions_debugsessions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_compute_environment_scores: + organizations_environments_apis_revisions_debugsessions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create + update: [] + replace: [] + delete: [] + revisions_deployments: + id: google.apigee.revisions_deployments + name: revisions_deployments + title: Revisions_deployments + methods: + organizations_environments_apis_revisions_get_deployments: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_create: + organizations_environments_sharedflows_revisions_get_deployments: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_get - insert: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create + #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_apis_revisions_get_deployments - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_create + #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_sharedflows_revisions_get_deployments + insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_update - delete: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_delete - environments_security_actions_config: - id: google.apigee.environments_security_actions_config - name: environments_security_actions_config - title: Environments_security_actions_config + replace: [] + delete: [] + archive_deployments: + id: google.apigee.archive_deployments + name: archive_deployments + title: Archive_deployments methods: - organizations_environments_update_security_actions_config: + organizations_environments_archive_deployments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get_security_actions_config: + organizations_environments_archive_deployments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_archive_deployments_patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_archive_deployments_generate_download_url: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_archive_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.archiveDeployments + organizations_environments_archive_deployments_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_archive_deployments_generate_upload_url: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments:generateUploadUrl/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_get_security_actions_config - insert: [] + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get + - $ref: >- + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list + insert: + - $ref: >- + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create update: - $ref: >- - #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_update_security_actions_config + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_patch replace: [] - delete: [] - environments_deployed_config: - id: google.apigee.environments_deployed_config - name: environments_deployed_config - title: Environments_deployed_config + delete: + - $ref: >- + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete + references: + id: google.apigee.references + name: references + title: References methods: - organizations_environments_get_deployed_config: + organizations_environments_references_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config - insert: [] - update: [] - replace: [] - delete: [] - environments_addons_config: - id: google.apigee.environments_addons_config - name: environments_addons_config - title: Environments_addons_config - methods: - organizations_environments_get_addons_config: + organizations_environments_references_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_references_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_references_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_addons_config/methods/organizations_environments_get_addons_config - insert: [] + #/components/x-stackQL-resources/references/methods/organizations_environments_references_get + insert: + - $ref: >- + #/components/x-stackQL-resources/references/methods/organizations_environments_references_create update: [] - replace: [] - delete: [] - environments_environment: - id: google.apigee.environments_environment - name: environments_environment - title: Environments_environment + replace: + - $ref: >- + #/components/x-stackQL-resources/references/methods/organizations_environments_references_update + delete: + - $ref: >- + #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete + security_reports: + id: google.apigee.security_reports + name: security_reports + title: Security_reports methods: - organizations_environments_update_environment: + organizations_environments_security_reports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/environments_environment/methods/organizations_environments_update_environment - replace: [] - delete: [] - environments_debugmask: - id: google.apigee.environments_debugmask - name: environments_debugmask - title: Environments_debugmask - methods: - organizations_environments_get_debugmask: + objectKey: $.securityReports + organizations_environments_security_reports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update_debugmask: + organizations_environments_security_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask - insert: [] - update: + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get - $ref: >- - #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_update_debugmask + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create + update: [] replace: [] delete: [] - environments_api_security_runtime_config: - id: google.apigee.environments_api_security_runtime_config - name: environments_api_security_runtime_config - title: Environments_api_security_runtime_config + security_reports_result_view: + id: google.apigee.security_reports_result_view + name: security_reports_result_view + title: Security_reports_result_view methods: - organizations_environments_get_api_security_runtime_config: + organizations_environments_security_reports_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config + #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view insert: [] update: [] replace: [] delete: [] - environments_trace_config: - id: google.apigee.environments_trace_config - name: environments_trace_config - title: Environments_trace_config + security_reports_result: + id: google.apigee.security_reports_result + name: security_reports_result + title: Security_reports_result methods: - organizations_environments_update_trace_config: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_get_trace_config: + organizations_environments_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config + #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_update_trace_config + update: [] replace: [] delete: [] - endpoint_attachments: - id: google.apigee.endpoint_attachments - name: endpoint_attachments - title: Endpoint_attachments + security_incidents: + id: google.apigee.security_incidents + name: security_incidents + title: Security_incidents methods: - organizations_endpoint_attachments_delete: + organizations_environments_security_incidents_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_get: + organizations_environments_security_incidents_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_create: + organizations_environments_security_incidents_batch_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_list: + organizations_environments_security_incidents_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.endpointAttachments + objectKey: $.securityIncidents sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_get + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_list - insert: + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_create - update: [] - replace: [] - delete: + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete - datacollectors: - id: google.apigee.datacollectors - name: datacollectors - title: Datacollectors + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_batch_update + replace: [] + delete: [] + keystores: + id: google.apigee.keystores + name: keystores + title: Keystores methods: - organizations_datacollectors_patch: + organizations_environments_keystores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_get: + organizations_environments_keystores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_delete: + organizations_environments_keystores_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get + insert: + - $ref: >- + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete + aliases: + id: google.apigee.aliases + name: aliases + title: Aliases + methods: + organizations_environments_keystores_aliases_csr: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataCollectors - organizations_datacollectors_create: + organizations_environments_keystores_aliases_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_keystores_aliases_update: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_keystores_aliases_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_keystores_aliases_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get - - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get insert: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create - update: + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch - replace: [] + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update delete: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete - operations: - id: google.apigee.operations - name: operations - title: Operations + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete + aliases_certificate: + id: google.apigee.aliases_certificate + name: aliases_certificate + title: Aliases_certificate methods: - organizations_operations_list: + organizations_environments_keystores_aliases_get_certificate: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - organizations_operations_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate + insert: [] + update: [] + replace: [] + delete: [] + addons_config: + id: google.apigee.addons_config + name: addons_config + title: Addons_config + methods: + organizations_environments_addons_config_set_addon_enablement: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_list + select: [] insert: [] update: [] replace: [] delete: [] - apidocs: - id: google.apigee.apidocs - name: apidocs - title: Apidocs + resourcefiles: + id: google.apigee.resourcefiles + name: resourcefiles + title: Resourcefiles methods: - organizations_sites_apidocs_delete: + organizations_environments_resourcefiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_update: + organizations_environments_resourcefiles_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_get: + organizations_environments_resourcefiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_list: + organizations_environments_resourcefiles_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.data - organizations_sites_apidocs_create: + organizations_environments_resourcefiles_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_get - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list insert: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_update delete: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete - apidocs_documentation: - id: google.apigee.apidocs_documentation - name: apidocs_documentation - title: Apidocs_documentation + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_delete + resourcefiles_environment_resources: + id: google.apigee.resourcefiles_environment_resources + name: resourcefiles_environment_resources + title: Resourcefiles_environment_resources methods: - organizations_sites_apidocs_get_documentation: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sites_apidocs_update_documentation: + organizations_environments_resourcefiles_list_environment_resources: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation + #/components/x-stackQL-resources/resourcefiles_environment_resources/methods/organizations_environments_resourcefiles_list_environment_resources insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_update_documentation + update: [] replace: [] delete: [] - apicategories: - id: google.apigee.apicategories - name: apicategories - title: Apicategories + security_actions: + id: google.apigee.security_actions + name: security_actions + title: Security_actions methods: - organizations_sites_apicategories_get: + organizations_environments_security_actions_enable: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_delete: + organizations_environments_security_actions_disable: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_patch: + organizations_environments_security_actions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_create: + organizations_environments_security_actions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_list: + objectKey: $.securityActions + organizations_environments_security_actions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list insert: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create - update: - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_patch + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete - envgroups: - id: google.apigee.envgroups - name: envgroups - title: Envgroups + delete: [] + security_stats: + id: google.apigee.security_stats + name: security_stats + title: Security_stats methods: - organizations_envgroups_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_envgroups_patch: + organizations_environments_security_stats_query_tabular_stats: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_get: + organizations_environments_security_stats_query_time_series_stats: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + targetservers: + id: google.apigee.targetservers + name: targetservers + title: Targetservers + methods: + organizations_environments_targetservers_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.environmentGroups - organizations_envgroups_create: + organizations_environments_targetservers_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_targetservers_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_targetservers_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get - - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_get insert: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create - update: + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch - replace: [] + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update delete: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete - envgroups_deployed_ingress_config: - id: google.apigee.envgroups_deployed_ingress_config - name: envgroups_deployed_ingress_config - title: Envgroups_deployed_ingress_config + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete + queries_resulturl: + id: google.apigee.queries_resulturl + name: queries_resulturl + title: Queries_resulturl methods: - organizations_envgroups_get_deployed_ingress_config: + organizations_environments_queries_get_resulturl: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1resulturl/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config + #/components/x-stackQL-resources/queries_resulturl/methods/organizations_environments_queries_get_resulturl insert: [] update: [] replace: [] delete: [] - keys_app_group_app_key: - id: google.apigee.keys_app_group_app_key - name: keys_app_group_app_key - title: Keys_app_group_app_key + queries: + id: google.apigee.queries + name: queries + title: Queries methods: - organizations_appgroups_apps_keys_update_app_group_app_key: + organizations_environments_queries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_queries_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_queries_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: + select: - $ref: >- - #/components/x-stackQL-resources/keys_app_group_app_key/methods/organizations_appgroups_apps_keys_update_app_group_app_key + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_get + - $ref: >- + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_list + insert: + - $ref: >- + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_create + update: [] replace: [] delete: [] - apiproducts_app_group_app_key_api_product: - id: google.apigee.apiproducts_app_group_app_key_api_product - name: apiproducts_app_group_app_key_api_product - title: Apiproducts_app_group_app_key_api_product + queries_result: + id: google.apigee.queries_result + name: queries_result + title: Queries_result methods: - organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: + organizations_environments_queries_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: + select: - $ref: >- - #/components/x-stackQL-resources/apiproducts_app_group_app_key_api_product/methods/organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product + #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result + insert: [] + update: [] replace: [] delete: [] - appgroups: - id: google.apigee.appgroups - name: appgroups - title: Appgroups + exports: + id: google.apigee.exports + name: exports + title: Exports methods: - organizations_appgroups_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.appGroups - organizations_appgroups_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_appgroups_update: + organizations_environments_analytics_exports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_delete: + organizations_environments_analytics_exports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_get: + organizations_environments_analytics_exports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list insert: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update - delete: - - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete - attributes_api_product_attribute: - id: google.apigee.attributes_api_product_attribute - name: attributes_api_product_attribute - title: Attributes_api_product_attribute + replace: [] + delete: [] + admin_schemav2: + id: google.apigee.admin_schemav2 + name: admin_schemav2 + title: Admin_schemav2 methods: - organizations_apiproducts_attributes_update_api_product_attribute: + organizations_environments_analytics_admin_get_schemav2: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 insert: [] - update: + update: [] + replace: [] + delete: [] + optimized_stats: + id: google.apigee.optimized_stats + name: optimized_stats + title: Optimized_stats + methods: + organizations_environments_optimized_stats_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1optimizedStats~1{optimizedStatsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/attributes_api_product_attribute/methods/organizations_apiproducts_attributes_update_api_product_attribute + #/components/x-stackQL-resources/optimized_stats/methods/organizations_environments_optimized_stats_get + insert: [] + update: [] replace: [] delete: [] - rateplans: - id: google.apigee.rateplans - name: rateplans - title: Rateplans + overrides: + id: google.apigee.overrides + name: overrides + title: Overrides methods: - organizations_apiproducts_rateplans_update: + organizations_environments_trace_config_overrides_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_get: + organizations_environments_trace_config_overrides_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_delete: + organizations_environments_trace_config_overrides_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_create: + organizations_environments_trace_config_overrides_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_list: + objectKey: $.traceConfigOverrides + organizations_environments_trace_config_overrides_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list insert: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create - update: [] - replace: + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create + update: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete - security_profiles: - id: google.apigee.security_profiles - name: security_profiles - title: Security_profiles - methods: - organizations_security_profiles_delete: - operation: + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete + datastores: + id: google.apigee.datastores + name: datastores + title: Datastores + methods: + organizations_analytics_datastores_get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_patch: + organizations_analytics_datastores_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_get: + organizations_analytics_datastores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_list: + organizations_analytics_datastores_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityProfiles - organizations_security_profiles_create: + organizations_analytics_datastores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_analytics_datastores_test: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_get + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_get - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_list + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_list insert: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_create - update: + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_patch - replace: [] + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_update delete: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_delete - security_profiles_revisions: - id: google.apigee.security_profiles_revisions - name: security_profiles_revisions - title: Security_profiles_revisions + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_delete + envgroups: + id: google.apigee.envgroups + name: envgroups + title: Envgroups methods: - organizations_security_profiles_list_revisions: + organizations_envgroups_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}:listRevisions/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityProfiles - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_profiles_revisions/methods/organizations_security_profiles_list_revisions - insert: [] - update: [] - replace: [] - delete: [] - host_stats: - id: google.apigee.host_stats - name: host_stats - title: Host_stats - methods: - organizations_host_stats_get: + objectKey: $.environmentGroups + organizations_envgroups_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get - insert: [] - update: [] - replace: [] - delete: [] - host_queries: - id: google.apigee.host_queries - name: host_queries - title: Host_queries - methods: - organizations_host_queries_list: + organizations_envgroups_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_create: + organizations_envgroups_patch: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_get: + organizations_envgroups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list insert: - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create - update: [] + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create + update: + - $ref: >- + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch replace: [] - delete: [] - host_queries_result_view: - id: google.apigee.host_queries_result_view - name: host_queries_result_view - title: Host_queries_result_view + delete: + - $ref: >- + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete + envgroups_deployed_ingress_config: + id: google.apigee.envgroups_deployed_ingress_config + name: envgroups_deployed_ingress_config + title: Envgroups_deployed_ingress_config methods: - organizations_host_queries_get_result_view: + organizations_envgroups_get_deployed_ingress_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries_result_view/methods/organizations_host_queries_get_result_view + #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config insert: [] update: [] replace: [] delete: [] - host_queries_result: - id: google.apigee.host_queries_result - name: host_queries_result - title: Host_queries_result + project_mapping: + id: google.apigee.project_mapping + name: project_mapping + title: Project_mapping methods: - organizations_host_queries_get_result: + organizations_get_project_mapping: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}:getProjectMapping/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result + #/components/x-stackQL-resources/project_mapping/methods/organizations_get_project_mapping insert: [] update: [] replace: [] delete: [] - optimized_host_stats: - id: google.apigee.optimized_host_stats - name: optimized_host_stats - title: Optimized_host_stats + security_settings: + id: google.apigee.security_settings + name: security_settings + title: Security_settings methods: - organizations_optimized_host_stats_get: + organizations_update_security_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/optimized_host_stats/methods/organizations_optimized_host_stats_get - insert: [] - update: [] - replace: [] - delete: [] - revisions_shared_flow_revision: - id: google.apigee.revisions_shared_flow_revision - name: revisions_shared_flow_revision - title: Revisions_shared_flow_revision - methods: - organizations_sharedflows_revisions_update_shared_flow_revision: + organizations_get_security_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings insert: [] update: - $ref: >- - #/components/x-stackQL-resources/revisions_shared_flow_revision/methods/organizations_sharedflows_revisions_update_shared_flow_revision + #/components/x-stackQL-resources/security_settings/methods/organizations_update_security_settings replace: [] delete: [] - sharedflows: - id: google.apigee.sharedflows - name: sharedflows - title: Sharedflows + organizations: + id: google.apigee.organizations + name: organizations + title: Organizations methods: - organizations_sharedflows_list: + organizations_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_create: + organizations_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_get: + organizations_update: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/put' response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_delete: + organizations_create: + operation: + $ref: '#/paths/~1v1~1organizations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_list: + operation: + $ref: '#/paths/~1v1~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_set_addons: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}:setAddons/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_set_sync_authorization: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_get + #/components/x-stackQL-resources/organizations/methods/organizations_get - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_list + #/components/x-stackQL-resources/organizations/methods/organizations_list insert: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create + #/components/x-stackQL-resources/organizations/methods/organizations_create update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/organizations_update delete: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete - datastores: - id: google.apigee.datastores - name: datastores - title: Datastores + #/components/x-stackQL-resources/organizations/methods/organizations_delete + sync_authorization: + id: google.apigee.sync_authorization + name: sync_authorization + title: Sync_authorization methods: - organizations_analytics_datastores_list: + organizations_get_sync_authorization: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_analytics_datastores_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_analytics_datastores_test: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_analytics_datastores_update: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/put - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_analytics_datastores_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_analytics_datastores_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_get - - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_list - insert: - - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_update - delete: - - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_delete - project_mapping: - id: google.apigee.project_mapping - name: project_mapping - title: Project_mapping - methods: - organizations_get_project_mapping: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getProjectMapping/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/project_mapping/methods/organizations_get_project_mapping + #/components/x-stackQL-resources/sync_authorization/methods/organizations_get_sync_authorization insert: [] update: [] replace: [] delete: [] - sync_authorization: - id: google.apigee.sync_authorization - name: sync_authorization - title: Sync_authorization + deployed_ingress_config: + id: google.apigee.deployed_ingress_config + name: deployed_ingress_config + title: Deployed_ingress_config methods: - organizations_get_sync_authorization: + organizations_get_deployed_ingress_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post + #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sync_authorization/methods/organizations_get_sync_authorization + #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config insert: [] update: [] replace: [] delete: [] - organizations: - id: google.apigee.organizations - name: organizations - title: Organizations - methods: - organizations_list: - operation: - $ref: '#/paths/~1v1~1organizations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_create: - operation: - $ref: '#/paths/~1v1~1organizations/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_set_sync_authorization: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_set_addons: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}:setAddons/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_update: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_get: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_delete: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_get - - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_list - insert: - - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_update - delete: - - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_delete runtime_config: id: google.apigee.runtime_config name: runtime_config @@ -12608,380 +12655,50 @@ components: update: [] replace: [] delete: [] - security_settings: - id: google.apigee.security_settings - name: security_settings - title: Security_settings - methods: - organizations_get_security_settings: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_update_security_settings: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/organizations_update_security_settings - replace: [] - delete: [] - deployed_ingress_config: - id: google.apigee.deployed_ingress_config - name: deployed_ingress_config - title: Deployed_ingress_config + issuers: + id: google.apigee.issuers + name: issuers + title: Issuers methods: - organizations_get_deployed_ingress_config: + hybrid_issuers_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get + $ref: '#/paths/~1v1~1hybrid~1issuers/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config - insert: [] - update: [] - replace: [] - delete: [] - projects: - id: google.apigee.projects - name: projects - title: Projects - methods: - projects_provision_organization: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}:provisionOrganization/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] + #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list insert: [] update: [] replace: [] delete: [] -paths: - /v1/hybrid/issuers: - parameters: &ref_1 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - get: - description: >- - Lists hybrid services and its trusted issuers service account ids. This - api is authenticated and unauthorized(allow all the users) and used by - runtime authn-authz service to query control plane's issuer service - account ids. - operationId: apigee.hybrid.issuers.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse - parameters: [] - /v1/organizations/{organizationsId}/reports/{reportsId}: - parameters: *ref_1 - delete: - description: Deletes an existing custom report definition - operationId: apigee.organizations.reports.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: reportsId - required: true - schema: - type: string - get: - description: Retrieve a custom report definition. - operationId: apigee.organizations.reports.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: reportsId - required: true - schema: - type: string - put: - description: Update an existing custom report definition - operationId: apigee.organizations.reports.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: reportsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/reports: - parameters: *ref_1 - get: - description: Return a list of Custom Reports - operationId: apigee.organizations.reports.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: expand - schema: - type: boolean - post: - description: >- - Creates a Custom Report for an Organization. A Custom Report provides - Apigee Customers to create custom dashboards in addition to the standard - dashboards which are provided. The Custom Report in its simplest form - contains specifications about metrics, dimensions and filters. It is - important to note that the custom report by itself does not provide an - executable entity. The Edge UI converts the custom report definition - into an analytics query and displays the result in a chart. - operationId: apigee.organizations.reports.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: - parameters: *ref_1 - get: - description: Lists all deployments of an API proxy revision. - operationId: apigee.organizations.apis.revisions.deployments.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: - parameters: *ref_1 - delete: - description: >- - Deletes an API proxy revision and all policies, resources, endpoints, - and revisions associated with it. The API proxy revision must be - undeployed before you can delete it. - operationId: apigee.organizations.apis.revisions.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - get: - description: >- - Gets an API proxy revision. To download the API proxy configuration - bundle for the specified revision as a zip file, set the `format` query - parameter to `bundle`. If you are using curl, specify `-o filename.zip` - to save the output to a file; otherwise, it displays to `stdout`. Then, - develop the API proxy configuration locally and upload the updated API - proxy configuration revision, as described in - [updateApiProxyRevision](updateApiProxyRevision). - operationId: apigee.organizations.apis.revisions.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: query - name: format - schema: - type: string +paths: + /v1/projects/{projectsId}:provisionOrganization: + parameters: &ref_1 + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' post: description: >- - Updates an existing API proxy revision by uploading the API proxy - configuration bundle as a zip file from your local machine. You can - update only API proxy revisions that have never been deployed. After - deployment, an API proxy revision becomes immutable, even if it is - undeployed. Set the `Content-Type` header to either - `multipart/form-data` or `application/octet-stream`. - operationId: apigee.organizations.apis.revisions.updateApiProxyRevision + Provisions a new Apigee organization with a functioning runtime. This is + the standard way to create trial organizations for a free Apigee trial. + operationId: apigee.projects.provisionOrganization requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ProvisionOrganizationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12993,32 +12710,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: projectsId required: true schema: type: string - - in: query - name: validate - schema: - type: boolean - /v1/organizations/{organizationsId}/apis/{apisId}/deployments: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: parameters: *ref_1 - get: - description: Lists all deployments of an API proxy. - operationId: apigee.organizations.apis.deployments.list + delete: + description: >- + Removes an API product from an app's consumer key. After the API product + is removed, the app cannot access the API resources defined in that API + product. **Note**: The consumer key is not removed, only its association + with the API product. + operationId: apigee.organizations.appgroups.apps.keys.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13030,8 +12737,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -13039,57 +12745,35 @@ paths: schema: type: string - in: path - name: apisId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: - parameters: *ref_1 - post: - description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' - parameters: - in: path - name: organizationsId + name: appsId required: true schema: type: string - in: path - name: apisId + name: keysId required: true schema: type: string - in: path - name: keyvaluemapsId + name: apiproductsId required: true schema: type: string - get: + post: description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.list + Approves or revokes the consumer key for an API product. After a + consumer key is approved, the app can use it to access APIs. A consumer + key that is revoked or pending cannot be used to access an API. Any + access tokens associated with a revoked consumer key will remain active. + However, Apigee checks the status of the consumer key and if set to + `revoked` will not allow access to the API. + operationId: >- + apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13101,8 +12785,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13110,73 +12793,37 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: appgroupsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: - parameters: *ref_1 - get: - description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' - parameters: - in: path - name: organizationsId + name: appsId required: true schema: type: string - in: path - name: apisId + name: keysId required: true schema: type: string - in: path - name: keyvaluemapsId + name: apiproductsId required: true schema: type: string - - in: path - name: entriesId - required: true + - in: query + name: action schema: type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: + parameters: *ref_1 delete: description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.delete + Deletes an app's consumer key and removes all API products associated + with the app. After the consumer key is deleted, it cannot be used to + access any APIs. + operationId: apigee.organizations.appgroups.apps.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13188,7 +12835,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -13196,30 +12843,25 @@ paths: schema: type: string - in: path - name: apisId + name: appgroupsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: appsId required: true schema: type: string - in: path - name: entriesId + name: keysId required: true schema: type: string - put: + get: description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.apis.keyvaluemaps.entries.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + Gets details for a consumer key for a AppGroup app, including the key + and secret value, associated API products, and other information. + operationId: apigee.organizations.appgroups.apps.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13231,7 +12873,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -13239,25 +12881,36 @@ paths: schema: type: string - in: path - name: apisId + name: appgroupsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: appsId required: true schema: type: string - in: path - name: entriesId + name: keysId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_1 - delete: - description: Deletes a key value map from an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.delete + post: + description: >- + Adds an API product to an AppGroupAppKey, enabling the app that holds + the key to access the API resources bundled in the API product. In + addition, you can add attributes to the AppGroupAppKey. This API + replaces the existing attributes with those specified in the request. + Include or exclude any existing attributes that you want to retain or + delete, respectively. You can use the same key to access all API + products associated with the app. + operationId: apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13269,7 +12922,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -13277,58 +12930,42 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: - parameters: *ref_1 - post: - description: Creates a key value map in an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' - parameters: - in: path - name: organizationsId + name: appsId required: true schema: type: string - in: path - name: apisId + name: keysId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: parameters: *ref_1 - patch: - description: Updates an existing API proxy. - operationId: apigee.organizations.apis.patch + post: + description: >- + Creates a custom consumer key and secret for a AppGroup app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the ProductizeAppGroupAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteAppGroupAppKey API. + operationId: apigee.organizations.appgroups.apps.keys.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13340,7 +12977,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -13348,21 +12985,24 @@ paths: schema: type: string - in: path - name: apisId + name: appgroupsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: appsId + required: true schema: type: string - format: google-fieldmask + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: + parameters: *ref_1 delete: description: >- - Deletes an API proxy and all associated endpoints, policies, resources, - and revisions. The API proxy must be undeployed before you can delete - it. - operationId: apigee.organizations.apis.delete + Deletes an AppGroup app. **Note**: The delete operation is asynchronous. + The AppGroup app is deleted immediately, but its associated resources, + such as app keys or access tokens, may take anywhere from a few seconds + to a few minutes to be deleted. + operationId: apigee.organizations.appgroups.apps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13374,7 +13014,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -13382,13 +13022,18 @@ paths: schema: type: string - in: path - name: apisId + name: appgroupsId + required: true + schema: + type: string + - in: path + name: appsId required: true schema: type: string get: - description: Gets an API proxy including a list of existing revisions. - operationId: apigee.organizations.apis.get + description: Returns the details for an AppGroup app. + operationId: apigee.organizations.appgroups.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13400,7 +13045,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -13408,35 +13053,32 @@ paths: schema: type: string - in: path - name: apisId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis: - parameters: *ref_1 - post: + - in: path + name: appsId + required: true + schema: + type: string + put: description: >- - Creates an API proxy. The API proxy created will not be accessible at - runtime until it is deployed to an environment. Create a new API proxy - by setting the `name` query parameter to the name of the API proxy. - Import an API proxy configuration bundle stored in zip format on your - local machine to your organization by doing the following: * Set the - `name` query parameter to the name of the API proxy. * Set the `action` - query parameter to `import`. * Set the `Content-Type` header to - `multipart/form-data`. * Pass as a file the name of API proxy - configuration bundle stored in zip format on your local machine using - the `file` form field. **Note**: To validate the API proxy configuration - bundle only without importing it, set the `action` query parameter to - `validate`. When importing an API proxy configuration bundle, if the API - proxy does not exist, it will be created. If the API proxy exists, then - a new revision is created. Invalid API proxy configurations are - rejected, and a list of validation errors is returned to the client. - operationId: apigee.organizations.apis.create + Updates the details for an AppGroup app. In addition, you can add an API + product to an AppGroup app and automatically generate an API key for the + app to use when calling APIs in the API product. If you want to use an + existing API key for the API product, add the API product to the API key + using the UpdateAppGroupAppKey API. Using this API, you cannot update + the app name, as it is the primary key used to identify the app and + cannot be changed. This API replaces the existing attributes with those + specified in the request. Include or exclude any existing attributes + that you want to retain or delete, respectively. + operationId: apigee.organizations.appgroups.apps.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13448,95 +13090,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: action - schema: - type: string - - in: query - name: name - schema: - type: string - - in: query - name: validate - schema: - type: boolean - get: - description: >- - Lists the names of all API proxies in an organization. The names - returned correspond to the names defined in the configuration files for - each API proxy. - operationId: apigee.organizations.apis.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' - parameters: - in: path - name: organizationsId + name: appgroupsId required: true schema: type: string - - in: query - name: includeMetaData - schema: - type: boolean - - in: query - name: includeRevisions - schema: - type: boolean - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: - parameters: *ref_1 - get: - description: >- - Get status of a query submitted at host level. If the query is still in - progress, the `state` is set to "running" After the query has completed - successfully, `state` is set to "completed" - operationId: apigee.organizations.hostSecurityReports.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' - parameters: - in: path - name: organizationsId + name: appsId required: true schema: type: string - - in: path - name: hostSecurityReportsId - required: true + - in: query + name: action schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: parameters: *ref_1 get: description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.hostSecurityReports.getResultView + Lists all apps created by an AppGroup in an Apigee organization. + Optionally, you can request an expanded view of the AppGroup apps. Lists + all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are + returned in the response if PageSize is not specified, or if the + PageSize is greater than 1000. + operationId: apigee.organizations.appgroups.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13549,7 +13133,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse parameters: - in: path name: organizationsId @@ -13557,24 +13141,32 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- - Submit a query at host level to be processed in the background. If the - submission of the query succeeds, the API returns a 201 status and an ID - that refer to the query. In addition to the HTTP status 201, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.hostSecurityReports.create + Creates an app and associates it with an AppGroup. This API associates + the AppGroup app with the specified API product and auto-generates an + API key for the app to use in calls to API proxies inside that API + product. The `name` is the unique ID of the app that you can use in API + calls. + operationId: apigee.organizations.appgroups.apps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13586,16 +13178,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: appgroupsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/appgroups: + parameters: *ref_1 get: - description: Return a list of Security Reports at host level. - operationId: apigee.organizations.hostSecurityReports.list + description: >- + Lists all AppGroups in an organization. A maximum of 1000 AppGroups are + returned in the response if PageSize is not specified, or if the + PageSize is greater than 1000. + operationId: apigee.organizations.appgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13607,57 +13209,37 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: pageToken schema: type: string - in: query - name: status - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: from - schema: - type: string - - in: query - name: submittedBy + name: filter schema: type: string - in: query - name: envgroupHostname - schema: - type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: - parameters: *ref_1 - get: + name: pageSize + schema: + type: integer + format: int32 + post: description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.hostSecurityReports.getResult + Creates an AppGroup. Once created, user can register apps under the + AppGroup to obtain secret key and password. At creation time, the + AppGroup's state is set as `active`. + operationId: apigee.organizations.appgroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13669,29 +13251,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: hostSecurityReportsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: parameters: *ref_1 put: - description: Updates the monetization configuration for the developer. - operationId: apigee.organizations.developers.updateMonetizationConfig + description: >- + Updates an AppGroup. This API replaces the existing AppGroup details + with those specified in the request. Include or exclude any existing + details that you want to retain or delete, respectively. Note that the + state of the AppGroup should be updated using `action`, and not via + AppGroup. + operationId: apigee.organizations.appgroups.update requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13703,8 +13284,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -13712,13 +13292,19 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string + - in: query + name: action + schema: + type: string get: - description: Gets the monetization configuration for the developer. - operationId: apigee.organizations.developers.getMonetizationConfig + description: >- + Returns the AppGroup details for the provided AppGroup name in the + request URI. + operationId: apigee.organizations.appgroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13730,8 +13316,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -13739,23 +13324,19 @@ paths: schema: type: string - in: path - name: developersId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers: - parameters: *ref_1 - post: + delete: description: >- - Creates a developer. Once created, the developer can register an app and - obtain an API key. At creation time, a developer is set as `active`. To - change the developer status, use the SetDeveloperStatus API. - operationId: apigee.organizations.developers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + Deletes an AppGroup. All app and API keys associations with the AppGroup + are also removed. **Warning**: This API will permanently delete the + AppGroup and related artifacts. **Note**: The delete operation is + asynchronous. The AppGroup app is deleted immediately, but its + associated resources, such as apps and API keys, may take anywhere from + a few seconds to a few minutes to be deleted. + operationId: apigee.organizations.appgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13767,22 +13348,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: appgroupsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: + parameters: *ref_1 get: description: >- - Lists all developers in an organization by email address. By default, - the response does not include company developers. Set the - `includeCompany` query parameter to `true` to include company - developers. **Note**: A maximum of 1000 developers are returned in the - response. You paginate the list of developers returned using the - `startKey` and `count` query parameters. - operationId: apigee.organizations.developers.list + Retrieve metrics grouped by dimensions in host level. The types of + metrics you can retrieve include traffic, message counts, API call + latency, response size, and cache hits and counts. Dimensions let you + view metrics in meaningful groups. You can optionally pass dimensions as + path parameters to the `stats` API. If dimensions are not specified, the + metrics are computed on the entire set of data for the given time range. + operationId: apigee.organizations.hostStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13794,121 +13382,79 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: hostStatsId + required: true + schema: + type: string - in: query - name: includeCompany + name: timeRange schema: - type: boolean + type: string - in: query - name: startKey + name: tzo schema: type: string - in: query - name: app + name: select schema: type: string - in: query - name: expand + name: topk + schema: + type: string + - in: query + name: tsAscending schema: type: boolean - in: query - name: count + name: offset schema: type: string - format: int64 - in: query - name: ids + name: limit schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}: - parameters: *ref_1 - put: - description: >- - Updates a developer. This API replaces the existing developer details - with those specified in the request. Include or exclude any existing - details that you want to retain or delete, respectively. The custom - attribute limit is 18. **Note**: OAuth access tokens and Key Management - Service (KMS) entities (apps, developers, and API products) are cached - for 180 seconds (current default). Any custom attributes associated with - these entities are cached for at least 180 seconds after the entity is - accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 - policy won't be able to expire an access token in less than 180 seconds. - operationId: apigee.organizations.developers.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' - parameters: - - in: path - name: organizationsId - required: true + - in: query + name: sortby schema: type: string - - in: path - name: developersId - required: true + - in: query + name: accuracy schema: type: string - delete: - description: >- - Deletes a developer. All apps and API keys associated with the developer - are also removed. **Warning**: This API will permanently delete the - developer and related artifacts. To avoid permanently deleting - developers and their artifacts, set the developer status to `inactive` - using the SetDeveloperStatus API. **Note**: The delete operation is - asynchronous. The developer app is deleted immediately, but its - associated resources, such as apps and API keys, may take anywhere from - a few seconds to a few minutes to be deleted. - operationId: apigee.organizations.developers.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' - parameters: - - in: path - name: organizationsId - required: true + - in: query + name: envgroupHostname schema: type: string - - in: path - name: developersId - required: true + - in: query + name: sort + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: timeUnit schema: type: string + - in: query + name: realtime + schema: + type: boolean + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: + parameters: *ref_1 get: - description: >- - Returns the developer details, including the developer's name, email - address, apps, and other information. **Note**: The response includes - only the first 100 developer apps. - operationId: apigee.organizations.developers.get + description: Gets a CanaryEvaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13920,7 +13466,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' parameters: - in: path name: organizationsId @@ -13928,26 +13474,25 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string - - in: query - name: action + - in: path + name: canaryevaluationsId + required: true schema: type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: + parameters: *ref_1 post: - description: >- - Sets the status of a developer. A developer is `active` by default. If - you set a developer's status to `inactive`, the API keys assigned to the - developer apps are no longer valid even though the API keys are set to - `approved`. Inactive developers can still sign in to the developer - portal and create apps; however, any new API keys generated during app - creation won't work. To set the status of a developer, set the `action` - query parameter to `active` or `inactive`, and the `Content-Type` header - to `application/octet-stream`. If successful, the API call returns the - following HTTP status code: `204 No Content` - operationId: apigee.organizations.developers.setDeveloperStatus + description: Creates a new canary evaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13959,7 +13504,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -13967,34 +13512,22 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string - - in: query - name: action - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes: + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: parameters: *ref_1 post: description: >- - Updates developer attributes. This API replaces the existing attributes - with those specified in the request. Add new attributes, and include or - exclude any existing attributes that you want to retain or remove, - respectively. The custom attribute limit is 18. **Note**: OAuth access - tokens and Key Management Service (KMS) entities (apps, developers, and - API products) are cached for 180 seconds (default). Any custom - attributes associated with these entities are cached for at least 180 - seconds after the entity is accessed at runtime. Therefore, an - `ExpiresIn` element on the OAuthV2 policy won't be able to expire an - access token in less than 180 seconds. - operationId: apigee.organizations.developers.attributes + Creates a new attachment of an environment to an instance. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14006,7 +13539,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -14014,13 +13547,15 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string get: - description: Returns a list of all developer attributes. - operationId: apigee.organizations.developers.attributes.list + description: >- + Lists all attachments to an instance. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14032,7 +13567,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse parameters: - in: path name: organizationsId @@ -14040,15 +13576,24 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: parameters: *ref_1 - get: - description: Gets the account balance for the developer. - operationId: apigee.organizations.developers.getBalance + delete: + description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14060,7 +13605,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -14068,26 +13613,18 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: - parameters: *ref_1 - post: - description: >- - Updates a developer attribute. **Note**: OAuth access tokens and Key - Management Service (KMS) entities (apps, developers, and API products) - are cached for 180 seconds (default). Any custom attributes associated - with these entities are cached for at least 180 seconds after the entity - is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 - policy won't be able to expire an access token in less than 180 seconds. - operationId: apigee.organizations.developers.attributes.updateDeveloperAttribute - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + - in: path + name: attachmentsId + required: true + schema: + type: string + get: + description: Gets an attachment. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14099,7 +13636,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' parameters: - in: path name: organizationsId @@ -14107,18 +13644,22 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string - in: path - name: attributesId + name: attachmentsId required: true schema: type: string - delete: - description: Deletes a developer attribute. - operationId: apigee.organizations.developers.attributes.delete + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: + parameters: *ref_1 + get: + description: >- + Gets the details of a NAT address. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14130,7 +13671,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' parameters: - in: path name: organizationsId @@ -14138,18 +13679,21 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string - in: path - name: attributesId + name: natAddressesId required: true schema: type: string - get: - description: Returns the value of the specified developer attribute. - operationId: apigee.organizations.developers.attributes.get + delete: + description: >- + Deletes the NAT address. Connections that are actively using the address + are drained before it is removed. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14161,7 +13705,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -14169,20 +13713,31 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string - in: path - name: attributesId + name: natAddressesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: parameters: *ref_1 - get: - description: Returns a list of all developer app attributes. - operationId: apigee.organizations.developers.apps.attributes.list + post: + description: >- + Creates a NAT address. The address is created in the RESERVED state and + a static external IP address will be provisioned. At this time, the + instance will not use this IP address for Internet egress traffic. The + address can be activated for use once any required firewall IP + whitelisting has been completed. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14194,7 +13749,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -14202,25 +13757,61 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId + required: true + schema: + type: string + get: + description: >- + Lists the NAT addresses for an Apigee instance. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.natAddresses.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse + parameters: + - in: path + name: organizationsId required: true schema: type: string - in: path - name: appsId + name: instancesId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: + parameters: *ref_1 post: description: >- - Updates attributes for a developer app. This API replaces the current - attributes with those specified in the request. - operationId: apigee.organizations.developers.apps.attributes + Activates the NAT address. The Apigee instance can now use this for + Internet egress traffic. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.natAddresses.activate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14232,7 +13823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -14240,33 +13831,28 @@ paths: schema: type: string - in: path - name: developersId + name: instancesId required: true schema: type: string - in: path - name: appsId + name: natAddressesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: + /v1/organizations/{organizationsId}/instances: parameters: *ref_1 post: description: >- - Updates a developer app attribute. **Note**: OAuth access tokens and Key - Management Service (KMS) entities (apps, developers, and API products) - are cached for 180 seconds (current default). Any custom attributes - associated with these entities are cached for at least 180 seconds after - the entity is accessed at runtime. Therefore, an `ExpiresIn` element on - the OAuthV2 policy won't be able to expire an access token in less than - 180 seconds. - operationId: >- - apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute + Creates an Apigee runtime instance. The instance is accessible from the + authorized network configured on the organization. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14278,31 +13864,56 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Lists all Apigee runtime instances for the organization. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' + parameters: - in: path - name: developersId + name: organizationsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: pageSize schema: - type: string - get: - description: Returns a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.get + type: integer + format: int32 + /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: + parameters: *ref_1 + post: + description: Reports the latest status for a runtime instance. + operationId: apigee.organizations.instances.reportStatus + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14314,7 +13925,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse parameters: - in: path name: organizationsId @@ -14322,23 +13934,23 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: attributesId + name: instancesId required: true schema: type: string - delete: - description: Deletes a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.delete + /v1/organizations/{organizationsId}/instances/{instancesId}: + parameters: *ref_1 + patch: + description: >- + Updates an Apigee runtime instance. You can update the fields described + in NodeConfig. No other fields will be updated. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14350,7 +13962,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -14358,32 +13970,21 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: instancesId required: true schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: - parameters: *ref_1 - post: + format: google-fieldmask + delete: description: >- - Approves or revokes the consumer key for an API product. After a - consumer key is approved, the app can use it to access APIs. A consumer - key that is revoked or pending cannot be used to access an API. Any - access tokens associated with a revoked consumer key will remain active. - However, Apigee checks the status of the consumer key and if set to - `revoked` will not allow access to the API. - operationId: >- - apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct + Deletes an Apigee runtime instance. The instance stops serving requests + and the runtime data is deleted. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14395,7 +13996,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -14403,36 +14004,15 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: path - name: apiproductsId + name: instancesId required: true schema: type: string - - in: query - name: action - schema: - type: string - delete: + get: description: >- - Removes an API product from an app's consumer key. After the API product - is removed, the app cannot access the API resources defined in that API - product. **Note**: The consumer key is not removed, only its association - with the API product. - operationId: apigee.organizations.developers.apps.keys.apiproducts.delete + Gets the details for an Apigee runtime instance. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14444,7 +14024,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' parameters: - in: path name: organizationsId @@ -14452,49 +14032,24 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: path - name: apiproductsId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: + /v1/organizations/{organizationsId}/developers/{developersId}: parameters: *ref_1 post: description: >- - Creates a custom consumer key and secret for a developer app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the UpdateDeveloperAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteDeveloperAppKey API. **Note**: All keys start out with - status=approved, even if status=revoked is passed when the key is - created. To revoke a key, use the UpdateDeveloperAppKey API. - operationId: apigee.organizations.developers.apps.keys.create.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + Sets the status of a developer. A developer is `active` by default. If + you set a developer's status to `inactive`, the API keys assigned to the + developer apps are no longer valid even though the API keys are set to + `approved`. Inactive developers can still sign in to the developer + portal and create apps; however, any new API keys generated during app + creation won't work. To set the status of a developer, set the `action` + query parameter to `active` or `inactive`, and the `Content-Type` header + to `application/octet-stream`. If successful, the API call returns the + following HTTP status code: `204 No Content` + operationId: apigee.organizations.developers.setDeveloperStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14506,7 +14061,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14518,35 +14073,21 @@ paths: required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: action schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: - parameters: *ref_1 - post: + delete: description: >- - Creates a custom consumer key and secret for a developer app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the UpdateDeveloperAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteDeveloperAppKey API. **Note**: All keys start out with - status=approved, even if status=revoked is passed when the key is - created. To revoke a key, use the UpdateDeveloperAppKey API. - operationId: apigee.organizations.developers.apps.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + Deletes a developer. All apps and API keys associated with the developer + are also removed. **Warning**: This API will permanently delete the + developer and related artifacts. To avoid permanently deleting + developers and their artifacts, set the developer status to `inactive` + using the SetDeveloperStatus API. **Note**: The delete operation is + asynchronous. The developer app is deleted immediately, but its + associated resources, such as apps and API keys, may take anywhere from + a few seconds to a few minutes to be deleted. + operationId: apigee.organizations.developers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14558,7 +14099,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -14570,27 +14111,12 @@ paths: required: true schema: type: string - - in: path - name: appsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: - parameters: *ref_1 - put: + get: description: >- - Updates the scope of an app. This API replaces the existing scopes with - those specified in the request. Include or exclude any existing scopes - that you want to retain or delete, respectively. The specified scopes - must already be defined for the API products associated with the app. - This API sets the `scopes` element under the `apiProducts` element in - the attributes of the app. - operationId: apigee.organizations.developers.apps.keys.replaceDeveloperAppKey - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + Returns the developer details, including the developer's name, email + address, apps, and other information. **Note**: The response includes + only the first 100 developer apps. + operationId: apigee.organizations.developers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14602,7 +14128,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -14614,26 +14140,27 @@ paths: required: true schema: type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId - required: true + - in: query + name: action schema: type: string - delete: + put: description: >- - Deletes an app's consumer key and removes all API products associated - with the app. After the consumer key is deleted, it cannot be used to - access any APIs. **Note**: After you delete a consumer key, you may want - to: 1. Create a new consumer key and secret for the developer app using - the CreateDeveloperAppKey API, and subsequently add an API product to - the key using the UpdateDeveloperAppKey API. 2. Delete the developer - app, if it is no longer required. - operationId: apigee.organizations.developers.apps.keys.delete + Updates a developer. This API replaces the existing developer details + with those specified in the request. Include or exclude any existing + details that you want to retain or delete, respectively. The custom + attribute limit is 18. **Note**: OAuth access tokens and Key Management + Service (KMS) entities (apps, developers, and API products) are cached + for 180 seconds (current default). Any custom attributes associated with + these entities are cached for at least 180 seconds after the entity is + accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 + policy won't be able to expire an access token in less than 180 seconds. + operationId: apigee.organizations.developers.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14645,7 +14172,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -14657,31 +14184,17 @@ paths: required: true schema: type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId - required: true - schema: - type: string - post: - description: >- - Adds an API product to a developer app key, enabling the app that holds - the key to access the API resources bundled in the API product. In - addition, you can add attributes to a developer app key. This API - replaces the existing attributes with those specified in the request. - Include or exclude any existing attributes that you want to retain or - delete, respectively. You can use the same key to access all API - products associated with the app. - operationId: apigee.organizations.developers.apps.keys.updateDeveloperAppKey + /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: + parameters: *ref_1 + put: + description: Updates the monetization configuration for the developer. + operationId: apigee.organizations.developers.updateMonetizationConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14693,7 +14206,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig parameters: - in: path name: organizationsId @@ -14705,25 +14219,44 @@ paths: required: true schema: type: string + get: + description: Gets the monetization configuration for the developer. + operationId: apigee.organizations.developers.getMonetizationConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + parameters: - in: path - name: appsId + name: organizationsId required: true schema: type: string - in: path - name: keysId + name: developersId required: true schema: type: string - - in: query - name: action - schema: - type: string + /v1/organizations/{organizationsId}/developers: + parameters: *ref_1 get: description: >- - Gets details for a consumer key for a developer app, including the key - and secret value, associated API products, and other information. - operationId: apigee.organizations.developers.apps.keys.get + Lists all developers in an organization by email address. By default, + the response does not include company developers. Set the + `includeCompany` query parameter to `true` to include company + developers. **Note**: A maximum of 1000 developers are returned in the + response. You paginate the list of developers returned using the + `startKey` and `count` query parameters. + operationId: apigee.organizations.developers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14735,48 +14268,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true + - in: query + name: app schema: type: string - - in: path - name: appsId - required: true + - in: query + name: startKey schema: type: string - - in: path - name: keysId - required: true + - in: query + name: includeCompany + schema: + type: boolean + - in: query + name: count schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: - parameters: *ref_1 - put: + format: int64 + - in: query + name: ids + schema: + type: string + - in: query + name: expand + schema: + type: boolean + post: description: >- - Updates the details for a developer app. In addition, you can add an API - product to a developer app and automatically generate an API key for the - app to use when calling APIs in the API product. If you want to use an - existing API key for the API product, add the API product to the API key - using the UpdateDeveloperAppKey API. Using this API, you cannot update - the following: * App name as it is the primary key used to identify the - app and cannot be changed. * Scopes associated with the app. Instead, - use the ReplaceDeveloperAppKey API. This API replaces the existing - attributes with those specified in the request. Include or exclude any - existing attributes that you want to retain or delete, respectively. - operationId: apigee.organizations.developers.apps.update + Creates a developer. Once created, the developer can register an app and + obtain an API key. At creation time, a developer is set as `active`. To + change the developer status, use the SetDeveloperStatus API. + operationId: apigee.organizations.developers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14788,26 +14323,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - get: - description: Returns the details for a developer app. - operationId: apigee.organizations.developers.apps.get + /v1/organizations/{organizationsId}/developers/{developersId}/attributes: + parameters: *ref_1 + post: + description: >- + Updates developer attributes. This API replaces the existing attributes + with those specified in the request. Add new attributes, and include or + exclude any existing attributes that you want to retain or remove, + respectively. The custom attribute limit is 18. **Note**: OAuth access + tokens and Key Management Service (KMS) entities (apps, developers, and + API products) are cached for 180 seconds (default). Any custom + attributes associated with these entities are cached for at least 180 + seconds after the entity is accessed at runtime. Therefore, an + `ExpiresIn` element on the OAuthV2 policy won't be able to expire an + access token in less than 180 seconds. + operationId: apigee.organizations.developers.attributes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14819,7 +14361,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -14831,26 +14373,9 @@ paths: required: true schema: type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: query - name: query - schema: - type: string - - in: query - name: entity - schema: - type: string - delete: - description: >- - Deletes a developer app. **Note**: The delete operation is asynchronous. - The developer app is deleted immediately, but its associated resources, - such as app keys or access tokens, may take anywhere from a few seconds - to a few minutes to be deleted. - operationId: apigee.organizations.developers.apps.delete + get: + description: Returns a list of all developer attributes. + operationId: apigee.organizations.developers.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14862,7 +14387,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -14874,45 +14399,11 @@ paths: required: true schema: type: string - - in: path - name: appsId - required: true - schema: - type: string - post: - description: >- - Manages access to a developer app by enabling you to: * Approve or - revoke a developer app * Generate a new consumer key and secret for a - developer app To approve or revoke a developer app, set the `action` - query parameter to `approve` or `revoke`, respectively, and the - `Content-Type` header to `application/octet-stream`. If a developer app - is revoked, none of its API keys are valid for API calls even though the - keys are still approved. If successful, the API call returns the - following HTTP status code: `204 No Content` To generate a new consumer - key and secret for a developer app, pass the new key/secret details. - Rather than replace an existing key, this API generates a new key. In - this case, multiple key pairs may be associated with a single developer - app. Each key pair has an independent status (`approve` or `revoke`) and - expiration time. Any approved, non-expired key can be used in an API - call. For example, if you're using API key rotation, you can generate - new keys with expiration times that overlap keys that are going to - expire. You might also generate a new consumer key/secret if the - security of the original key/secret is compromised. The `keyExpiresIn` - property defines the expiration time for the API key in milliseconds. If - you don't set this property or set it to `-1`, the API key never - expires. **Notes**: * When generating a new key/secret, this API - replaces the existing attributes, notes, and callback URLs with those - specified in the request. Include or exclude any existing information - that you want to retain or delete, respectively. * To migrate existing - consumer keys and secrets to hybrid from another system, see the - CreateDeveloperAppKey API. - operationId: >- - apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + /v1/organizations/{organizationsId}/developers/{developersId}/balance: + parameters: *ref_1 + get: + description: Gets the account balance for the developer. + operationId: apigee.organizations.developers.getBalance security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14924,7 +14415,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -14936,31 +14427,22 @@ paths: required: true schema: type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: query - name: action - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps: + /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: parameters: *ref_1 post: description: >- - Creates an app associated with a developer. This API associates the - developer app with the specified API product and auto-generates an API - key for the app to use in calls to API proxies inside that API product. - The `name` is the unique ID of the app that you can use in API calls. - The `DisplayName` (set as an attribute) appears in the UI. If you don't - set the `DisplayName` attribute, the `name` appears in the UI. - operationId: apigee.organizations.developers.apps.create + Updates a developer attribute. **Note**: OAuth access tokens and Key + Management Service (KMS) entities (apps, developers, and API products) + are cached for 180 seconds (default). Any custom attributes associated + with these entities are cached for at least 180 seconds after the entity + is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 + policy won't be able to expire an access token in less than 180 seconds. + operationId: apigee.organizations.developers.attributes.updateDeveloperAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14972,7 +14454,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -14984,14 +14466,14 @@ paths: required: true schema: type: string + - in: path + name: attributesId + required: true + schema: + type: string get: - description: >- - Lists all apps created by a developer in an Apigee organization. - Optionally, you can request an expanded view of the developer apps. A - maximum of 100 developer apps are returned per API call. You can - paginate the list of deveoper apps returned using the `startKey` and - `count` query parameters. - operationId: apigee.organizations.developers.apps.list + description: Returns the value of the specified developer attribute. + operationId: apigee.organizations.developers.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15003,8 +14485,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -15016,28 +14497,14 @@ paths: required: true schema: type: string - - in: query - name: count - schema: - type: string - format: int64 - - in: query - name: startKey + - in: path + name: attributesId + required: true schema: type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: shallowExpand - schema: - type: boolean - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: - parameters: *ref_1 - get: - description: Gets details for an API product subscription. - operationId: apigee.organizations.developers.subscriptions.get + delete: + description: Deletes a developer attribute. + operationId: apigee.organizations.developers.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15049,7 +14516,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -15062,20 +14529,21 @@ paths: schema: type: string - in: path - name: subscriptionsId + name: attributesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: parameters: *ref_1 post: - description: 'Creates a subscription to an API product. ' - operationId: apigee.organizations.developers.subscriptions.create + description: Expires an API product subscription immediately. + operationId: apigee.organizations.developers.subscriptions.expire requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15099,6 +14567,13 @@ paths: required: true schema: type: string + - in: path + name: subscriptionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + parameters: *ref_1 get: description: Lists all API product subscriptions for a developer. operationId: apigee.organizations.developers.subscriptions.list @@ -15126,26 +14601,51 @@ paths: required: true schema: type: string + - in: query + name: startKey + schema: + type: string - in: query name: count schema: type: integer format: int32 - - in: query - name: startKey - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: - parameters: *ref_1 post: - description: Expires an API product subscription immediately. - operationId: apigee.organizations.developers.subscriptions.expire + description: 'Creates a subscription to an API product. ' + operationId: apigee.organizations.developers.subscriptions.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: developersId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: + parameters: *ref_1 + get: + description: Gets details for an API product subscription. + operationId: apigee.organizations.developers.subscriptions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15244,11 +14744,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: + /v1/organizations/{organizationsId}/developers/{developersId}/apps: parameters: *ref_1 get: - description: Gets a CanaryEvaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.get + description: >- + Lists all apps created by a developer in an Apigee organization. + Optionally, you can request an expanded view of the developer apps. A + maximum of 100 developer apps are returned per API call. You can + paginate the list of deveoper apps returned using the `startKey` and + `count` query parameters. + operationId: apigee.organizations.developers.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15260,7 +14765,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse parameters: - in: path name: organizationsId @@ -15268,25 +14774,41 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - - in: path - name: canaryevaluationsId - required: true + - in: query + name: startKey schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: - parameters: *ref_1 + - in: query + name: expand + schema: + type: boolean + - in: query + name: count + schema: + type: string + format: int64 + - in: query + name: shallowExpand + schema: + type: boolean post: - description: Creates a new canary evaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.create + description: >- + Creates an app associated with a developer. This API associates the + developer app with the specified API product and auto-generates an API + key for the app to use in calls to API proxies inside that API product. + The `name` is the unique ID of the app that you can use in API calls. + The `DisplayName` (set as an attribute) appears in the UI. If you don't + set the `DisplayName` attribute, the `name` appears in the UI. + operationId: apigee.organizations.developers.apps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15298,7 +14820,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -15306,26 +14828,46 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: parameters: *ref_1 post: description: >- - Creates a NAT address. The address is created in the RESERVED state and - a static external IP address will be provisioned. At this time, the - instance will not use this IP address for Internet egress traffic. The - address can be activated for use once any required firewall IP - whitelisting has been completed. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.create + Manages access to a developer app by enabling you to: * Approve or + revoke a developer app * Generate a new consumer key and secret for a + developer app To approve or revoke a developer app, set the `action` + query parameter to `approve` or `revoke`, respectively, and the + `Content-Type` header to `application/octet-stream`. If a developer app + is revoked, none of its API keys are valid for API calls even though the + keys are still approved. If successful, the API call returns the + following HTTP status code: `204 No Content` To generate a new consumer + key and secret for a developer app, pass the new key/secret details. + Rather than replace an existing key, this API generates a new key. In + this case, multiple key pairs may be associated with a single developer + app. Each key pair has an independent status (`approve` or `revoke`) and + expiration time. Any approved, non-expired key can be used in an API + call. For example, if you're using API key rotation, you can generate + new keys with expiration times that overlap keys that are going to + expire. You might also generate a new consumer key/secret if the + security of the original key/secret is compromised. The `keyExpiresIn` + property defines the expiration time for the API key in milliseconds. If + you don't set this property or set it to `-1`, the API key never + expires. **Notes**: * When generating a new key/secret, this API + replaces the existing attributes, notes, and callback URLs with those + specified in the request. Include or exclude any existing information + that you want to retain or delete, respectively. * To migrate existing + consumer keys and secrets to hybrid from another system, see the + CreateDeveloperAppKey API. + operationId: >- + apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15337,7 +14879,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -15345,55 +14887,22 @@ paths: schema: type: string - in: path - name: instancesId - required: true - schema: - type: string - get: - description: >- - Lists the NAT addresses for an Apigee instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.natAddresses.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse - parameters: - - in: path - name: organizationsId + name: developersId required: true schema: type: string - in: path - name: instancesId + name: appsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: action schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: - parameters: *ref_1 get: - description: >- - Gets the details of a NAT address. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.get + description: Returns the details for a developer app. + operationId: apigee.organizations.developers.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15405,7 +14914,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -15413,21 +14922,41 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId required: true schema: type: string - - in: path - name: natAddressesId - required: true + - in: query + name: entity schema: type: string - delete: + - in: query + name: query + schema: + type: string + put: description: >- - Deletes the NAT address. Connections that are actively using the address - are drained before it is removed. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.delete + Updates the details for a developer app. In addition, you can add an API + product to a developer app and automatically generate an API key for the + app to use when calling APIs in the API product. If you want to use an + existing API key for the API product, add the API product to the API key + using the UpdateDeveloperAppKey API. Using this API, you cannot update + the following: * App name as it is the primary key used to identify the + app and cannot be changed. * Scopes associated with the app. Instead, + use the ReplaceDeveloperAppKey API. This API replaces the existing + attributes with those specified in the request. Include or exclude any + existing attributes that you want to retain or delete, respectively. + operationId: apigee.organizations.developers.apps.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15439,7 +14968,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -15447,28 +14976,22 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - in: path - name: natAddressesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: - parameters: *ref_1 - post: + delete: description: >- - Activates the NAT address. The Apigee instance can now use this for - Internet egress traffic. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.natAddresses.activate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest + Deletes a developer app. **Note**: The delete operation is asynchronous. + The developer app is deleted immediately, but its associated resources, + such as app keys or access tokens, may take anywhere from a few seconds + to a few minutes to be deleted. + operationId: apigee.organizations.developers.apps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15480,7 +15003,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -15488,27 +15011,27 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - in: path - name: natAddressesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: parameters: *ref_1 post: description: >- - Creates a new attachment of an environment to an instance. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.create + Updates attributes for a developer app. This API replaces the current + attributes with those specified in the request. + operationId: apigee.organizations.developers.apps.attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15520,7 +15043,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -15528,15 +15051,18 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId required: true schema: type: string get: - description: >- - Lists all attachments to an instance. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.attachments.list + description: Returns a list of all developer app attributes. + operationId: apigee.organizations.developers.apps.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15548,8 +15074,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -15557,24 +15082,31 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: appsId + required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: parameters: *ref_1 - get: - description: Gets an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.get + put: + description: >- + Updates the scope of an app. This API replaces the existing scopes with + those specified in the request. Include or exclude any existing scopes + that you want to retain or delete, respectively. The specified scopes + must already be defined for the API products associated with the app. + This API sets the `scopes` element under the `apiProducts` element in + the attributes of the app. + operationId: apigee.organizations.developers.apps.keys.replaceDeveloperAppKey + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15586,7 +15118,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -15594,18 +15126,30 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - in: path - name: attachmentsId + name: appsId + required: true + schema: + type: string + - in: path + name: keysId required: true schema: type: string delete: - description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.delete + description: >- + Deletes an app's consumer key and removes all API products associated + with the app. After the consumer key is deleted, it cannot be used to + access any APIs. **Note**: After you delete a consumer key, you may want + to: 1. Create a new consumer key and secret for the developer app using + the CreateDeveloperAppKey API, and subsequently add an API product to + the key using the UpdateDeveloperAppKey API. 2. Delete the developer + app, if it is no longer required. + operationId: apigee.organizations.developers.apps.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15617,7 +15161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -15625,28 +15169,35 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - in: path - name: attachmentsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}: - parameters: *ref_1 - patch: + - in: path + name: keysId + required: true + schema: + type: string + post: description: >- - Updates an Apigee runtime instance. You can update the fields described - in NodeConfig. No other fields will be updated. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.patch + Adds an API product to a developer app key, enabling the app that holds + the key to access the API resources bundled in the API product. In + addition, you can add attributes to a developer app key. This API + replaces the existing attributes with those specified in the request. + Include or exclude any existing attributes that you want to retain or + delete, respectively. You can use the same key to access all API + products associated with the app. + operationId: apigee.organizations.developers.apps.keys.updateDeveloperAppKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15658,7 +15209,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -15666,20 +15217,29 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId required: true schema: type: string - in: query - name: updateMask + name: action schema: type: string - format: google-fieldmask get: description: >- - Gets the details for an Apigee runtime instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.get + Gets details for a consumer key for a developer app, including the key + and secret value, associated API products, and other information. + operationId: apigee.organizations.developers.apps.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15691,7 +15251,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -15699,16 +15259,44 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - delete: + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: + parameters: *ref_1 + post: description: >- - Deletes an Apigee runtime instance. The instance stops serving requests - and the runtime data is deleted. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.delete + Creates a custom consumer key and secret for a developer app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateDeveloperAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteDeveloperAppKey API. **Note**: All keys start out with + status=approved, even if status=revoked is passed when the key is + created. To revoke a key, use the UpdateDeveloperAppKey API. + operationId: apigee.organizations.developers.apps.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15720,7 +15308,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -15728,23 +15316,39 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/instances: + - in: path + name: appsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: parameters: *ref_1 post: description: >- - Creates an Apigee runtime instance. The instance is accessible from the - authorized network configured on the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.create + Creates a custom consumer key and secret for a developer app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateDeveloperAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteDeveloperAppKey API. **Note**: All keys start out with + status=approved, even if status=revoked is passed when the key is + created. To revoke a key, use the UpdateDeveloperAppKey API. + operationId: apigee.organizations.developers.apps.keys.create.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15756,18 +15360,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId required: true schema: type: string - get: + - in: path + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + parameters: *ref_1 + post: description: >- - Lists all Apigee runtime instances for the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.list + Approves or revokes the consumer key for an API product. After a + consumer key is approved, the app can use it to access APIs. A consumer + key that is revoked or pending cannot be used to access an API. Any + access tokens associated with a revoked consumer key will remain active. + However, Apigee checks the status of the consumer key and if set to + `revoked` will not allow access to the API. + operationId: >- + apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15779,33 +15400,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + required: true schema: type: string - in: query - name: pageSize + name: action schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: - parameters: *ref_1 - post: - description: Reports the latest status for a runtime instance. - operationId: apigee.organizations.instances.reportStatus - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest + type: string + delete: + description: >- + Removes an API product from an app's consumer key. After the API product + is removed, the app cannot access the API resources defined in that API + product. **Note**: The consumer key is not removed, only its association + with the API product. + operationId: apigee.organizations.developers.apps.keys.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15817,8 +15449,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -15826,54 +15457,43 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: - parameters: *ref_1 - post: - description: Compute RAV2 security scores for a set of resources. - operationId: apigee.organizations.securityAssessmentResults.batchCompute - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse - parameters: - in: path - name: organizationsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: parameters: *ref_1 post: description: >- - Creates a trace configuration override. The response contains a - system-generated UUID, that can be used to view, update, or delete the - configuration override. Use the List API to view the existing trace - configuration overrides. - operationId: apigee.organizations.environments.traceConfig.overrides.create + Updates a developer app attribute. **Note**: OAuth access tokens and Key + Management Service (KMS) entities (apps, developers, and API products) + are cached for 180 seconds (current default). Any custom attributes + associated with these entities are cached for at least 180 seconds after + the entity is accessed at runtime. Therefore, an `ExpiresIn` element on + the OAuthV2 policy won't be able to expire an access token in less than + 180 seconds. + operationId: >- + apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15885,7 +15505,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -15893,15 +15513,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: attributesId required: true schema: type: string get: - description: >- - Lists all of the distributed trace configuration overrides in an - environment. - operationId: apigee.organizations.environments.traceConfig.overrides.list + description: Returns a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15913,8 +15541,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -15922,24 +15549,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: appsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: attributesId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: - parameters: *ref_1 - get: - description: Gets a trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.get + delete: + description: Deletes a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15951,7 +15577,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -15959,18 +15585,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: overridesId + name: appsId required: true schema: type: string - delete: - description: Deletes a distributed trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.delete + - in: path + name: attributesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/hostSecurityReports: + parameters: *ref_1 + get: + description: Return a list of Security Reports at host level. + operationId: apigee.organizations.hostSecurityReports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15982,35 +15615,59 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: to schema: type: string - - in: path - name: overridesId - required: true + - in: query + name: status schema: type: string - patch: - description: >- - Updates a distributed trace configuration override. Note that the - repeated fields have replace semantics when included in the field mask - and that they will be overwritten by the value of the fields in the - request body. - operationId: apigee.organizations.environments.traceConfig.overrides.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: dataset + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + - in: query + name: submittedBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: from + schema: + type: string + post: + description: >- + Submit a query at host level to be processed in the background. If the + submission of the query succeeds, the API returns a 201 status and an ID + that refer to the query. In addition to the HTTP status 201, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.hostSecurityReports.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16022,36 +15679,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: overridesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: parameters: *ref_1 get: description: >- - Lists all resource files, optionally filtering by type. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.list + Get status of a query submitted at host level. If the query is still in + progress, the `state` is set to "running" After the query has completed + successfully, `state` is set to "completed" + operationId: apigee.organizations.hostSecurityReports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16063,8 +15705,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -16072,26 +15713,17 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostSecurityReportsId required: true schema: type: string - - in: query - name: type - schema: - type: string - post: + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: + parameters: *ref_1 + get: description: >- - Creates a resource file. Specify the `Content-Type` as - `application/octet-stream` or `multipart/form-data`. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + After the query is completed, use this API to view the query result when + result size is small. + operationId: apigee.organizations.hostSecurityReports.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16103,7 +15735,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -16111,26 +15744,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostSecurityReportsId required: true schema: type: string - - in: query - name: name - schema: - type: string - - in: query - name: type - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: parameters: *ref_1 get: description: >- - Lists all resource files, optionally filtering by type. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.listEnvironmentResources + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.hostSecurityReports.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16142,8 +15769,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -16151,29 +15777,22 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: type + name: hostSecurityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: + /v1/organizations/{organizationsId}/endpointAttachments: parameters: *ref_1 - put: + post: description: >- - Updates a resource file. Specify the `Content-Type` as - `application/octet-stream` or `multipart/form-data`. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.update + Creates an endpoint attachment. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.endpointAttachments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16185,34 +15804,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: type - required: true - schema: - type: string - - in: path - name: name - required: true + - in: query + name: endpointAttachmentId schema: type: string get: - description: >- - Gets the contents of a resource file. For more information about - resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.get + description: Lists the endpoint attachments in an organization. + operationId: apigee.organizations.endpointAttachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16224,34 +15829,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: type - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: name - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: >- - Deletes a resource file. For more information about resource files, see - [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.delete + /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: + parameters: *ref_1 + get: + description: Gets the endpoint attachment. + operationId: apigee.organizations.endpointAttachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16263,7 +15862,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' parameters: - in: path name: organizationsId @@ -16271,29 +15870,46 @@ paths: schema: type: string - in: path - name: environmentsId + name: endpointAttachmentsId required: true schema: type: string + delete: + description: Deletes an endpoint attachment. + operationId: apigee.organizations.endpointAttachments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: type + name: organizationsId required: true schema: type: string - in: path - name: name + name: endpointAttachmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: + /v1/organizations/{organizationsId}/securityProfiles: parameters: *ref_1 - get: - description: >- - Gets a list of metrics and dimensions that can be used to create - analytics queries and reports. Each schema element contains the name of - the field, its associated type, and a flag indicating whether it is a - standard or custom field. - operationId: apigee.organizations.environments.analytics.admin.getSchemav2 + post: + description: CreateSecurityProfile create a new custom security profile. + operationId: apigee.organizations.securityProfiles.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16305,33 +15921,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - in: query - name: type + name: securityProfileId schema: type: string - - in: query - name: disableCache - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: - parameters: *ref_1 get: description: >- - Lists the details and status of all analytics export jobs belonging to - the parent organization and environment. - operationId: apigee.organizations.environments.analytics.exports.list + ListSecurityProfiles lists all the security profiles associated with the + org including attached and unattached profiles. + operationId: apigee.organizations.securityProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16343,30 +15948,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: pageToken schema: type: string - post: - description: >- - Submit a data export job to be processed in the background. If the - request is successful, the API returns a 201 status, a URI that can be - used to retrieve the status of the export job, and the `state` value of - "enqueued". - operationId: apigee.organizations.environments.analytics.exports.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: + parameters: *ref_1 + get: + description: >- + ListSecurityProfileRevisions lists all the revisions of the security + profile. + operationId: apigee.organizations.securityProfiles.listRevisions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16378,7 +15983,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse parameters: - in: path name: organizationsId @@ -16386,19 +15992,27 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: parameters: *ref_1 get: description: >- - Gets the details and status of an analytics export job. If the export - job is still in progress, its `state` is set to "running". After the - export job has completed successfully, its `state` is set to - "completed". If the export job fails, its `state` is set to `failed`. - operationId: apigee.organizations.environments.analytics.exports.get + GetSecurityProfile gets the specified security profile. Returns + NOT_FOUND if security profile is not present for the specified + organization. + operationId: apigee.organizations.securityProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16410,7 +16024,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId @@ -16418,31 +16032,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: exportsId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the IAM policy on a deployment, if the policy already exists it - will be replaced. For more information, see [Manage users, roles, and - permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.deployments.setIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.deployments.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + delete: + description: DeleteSecurityProfile delete a profile with all its revisions. + operationId: apigee.organizations.securityProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16454,7 +16050,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -16462,29 +16058,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Tests the permissions of a user on a deployment, and returns a subset of - permissions that the user has on the deployment. If the deployment does - not exist, an empty permission set is returned (a NOT_FOUND error is not - returned). - operationId: apigee.organizations.environments.deployments.testIamPermissions + patch: + description: UpdateSecurityProfile update the metadata of security profile. + operationId: apigee.organizations.securityProfiles.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16496,7 +16081,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId @@ -16504,22 +16089,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}: + format: google-fieldmask + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: parameters: *ref_1 - get: + post: description: >- - Gets a particular deployment of Api proxy or a shared flow in an - environment - operationId: apigee.organizations.environments.deployments.get + CreateSecurityProfileEnvironmentAssociation creates profile environment + association i.e. attaches environment to security profile. + operationId: apigee.organizations.securityProfiles.environments.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16531,7 +16122,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation parameters: - in: path name: organizationsId @@ -16539,20 +16131,17 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: parameters: *ref_1 - get: - description: Lists all deployments of API proxies or shared flows in an environment. - operationId: apigee.organizations.environments.deployments.list + delete: + description: >- + DeleteSecurityProfileEnvironmentAssociation removes profile environment + association i.e. detaches environment from security profile. + operationId: apigee.organizations.securityProfiles.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16564,8 +16153,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -16573,24 +16161,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - - in: query - name: sharedFlows + - in: path + name: environmentsId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy: + type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: parameters: *ref_1 - get: + post: description: >- - Gets the IAM policy on a deployment. For more information, see [Manage - users, roles, and permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.deployments.getIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.deployments.getIamPolicy + ComputeEnvironmentScores calculates scores for requested time range for + the specified security profile and environment. + operationId: >- + apigee.organizations.securityProfiles.environments.computeEnvironmentScores + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16602,7 +16195,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse parameters: - in: path name: organizationsId @@ -16610,25 +16204,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - in: path - name: deploymentsId + name: environmentsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: + /v1/organizations/{organizationsId}/reports: parameters: *ref_1 get: - description: Similar to GetStats except that the response is less verbose. - operationId: apigee.organizations.environments.optimizedStats.get + description: Return a list of Custom Reports + operationId: apigee.organizations.reports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16640,88 +16229,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: optimizedStatsId - required: true - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: sonar - schema: - type: boolean - - in: query - name: tzo - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: limit - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: filter - schema: - type: string - in: query - name: tsAscending + name: expand schema: type: boolean - - in: query - name: offset - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: accuracy - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: - parameters: *ref_1 - delete: - description: Deletes a keystore or truststore. - operationId: apigee.organizations.environments.keystores.delete + post: + description: >- + Creates a Custom Report for an Organization. A Custom Report provides + Apigee Customers to create custom dashboards in addition to the standard + dashboards which are provided. The Custom Report in its simplest form + contains specifications about metrics, dimensions and filters. It is + important to note that the custom report by itself does not provide an + executable entity. The Edge UI converts the custom report definition + into an analytics query and displays the result in a chart. + operationId: apigee.organizations.reports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16733,26 +16267,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId required: true schema: type: string + /v1/organizations/{organizationsId}/reports/{reportsId}: + parameters: *ref_1 + get: + description: Retrieve a custom report definition. + operationId: apigee.organizations.reports.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + parameters: - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - in: path - name: keystoresId + name: reportsId required: true schema: type: string - get: - description: Gets a keystore or truststore. - operationId: apigee.organizations.environments.keystores.get + delete: + description: Deletes an existing custom report definition + operationId: apigee.organizations.reports.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16764,7 +16316,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse parameters: - in: path name: organizationsId @@ -16772,30 +16325,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: reportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: - parameters: *ref_1 - post: - description: >- - Creates a keystore or truststore. - Keystore: Contains certificates and - their associated keys. - Truststore: Contains trusted certificates used - to validate a server's certificate. These certificates are typically - self-signed certificates or certificates that are not signed by a - trusted CA. - operationId: apigee.organizations.environments.keystores.create + put: + description: Update an existing custom report definition + operationId: apigee.organizations.reports.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16807,7 +16348,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId @@ -16815,36 +16356,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: reportsId required: true schema: type: string - - in: query - name: name - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: parameters: *ref_1 - post: - description: >- - Creates an alias from a key/certificate pair. The structure of the - request is controlled by the `format` query parameter: - `keycertfile` - - Separate PEM-encoded key and certificate files are uploaded. Set - `Content-Type: multipart/form-data` and include the `keyFile`, - `certFile`, and `password` (if keys are encrypted) fields in the request - body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A - PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, - provide the file in the `file` field, and include the `password` field - if the file is encrypted in the request body. - `selfsignedcert` - A new - private key and certificate are generated. Set `Content-Type: - application/json` and include CertificateGenerationSpec in the request - body. - operationId: apigee.organizations.environments.keystores.aliases.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + get: + description: Lists all deployments of a shared flow revision. + operationId: apigee.organizations.sharedflows.revisions.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16856,7 +16376,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -16864,40 +16385,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - in: path - name: keystoresId + name: revisionsId required: true schema: type: string - - in: query - name: format - schema: - type: string - - in: query - name: _password - schema: - type: string - - in: query - name: alias - schema: - type: string - - in: query - name: ignoreNewlineValidation - schema: - type: boolean - - in: query - name: ignoreExpiryValidation - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: parameters: *ref_1 - get: - description: Gets an alias. - operationId: apigee.organizations.environments.keystores.aliases.get + post: + description: >- + Updates a shared flow revision. This operation is only allowed on + revisions which have never been deployed. After deployment a revision + becomes immutable, even if it becomes undeployed. The payload is a + ZIP-formatted shared flow. Content type must be either + multipart/form-data or application/octet-stream. + operationId: apigee.organizations.sharedflows.revisions.updateSharedFlowRevision + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16909,7 +16420,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -16917,28 +16428,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - in: path - name: keystoresId + name: revisionsId required: true schema: type: string - - in: path - name: aliasesId - required: true + - in: query + name: validate schema: - type: string - put: - description: Updates the certificate in an alias. - operationId: apigee.organizations.environments.keystores.aliases.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + type: boolean + delete: + description: >- + Deletes a shared flow and all associated policies, resources, and + revisions. You must undeploy the shared flow before deleting it. + operationId: apigee.organizations.sharedflows.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16950,7 +16457,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -16958,31 +16465,25 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: sharedflowsId required: true schema: type: string - in: path - name: aliasesId + name: revisionsId required: true schema: type: string - - in: query - name: ignoreNewlineValidation - schema: - type: boolean - - in: query - name: ignoreExpiryValidation - schema: - type: boolean - delete: - description: Deletes an alias. - operationId: apigee.organizations.environments.keystores.aliases.delete + get: + description: >- + Gets a revision of a shared flow. To download the shared flow + configuration bundle for the specified revision as a zip file, set the + `format` query parameter to `bundle`. If you are using curl, specify `-o + filename.zip` to save the output to a file; otherwise, it displays to + `stdout`. Then, develop the shared flow configuration locally and upload + the updated sharedFlow configuration revision, as described in + [updateSharedFlowRevision](updateSharedFlowRevision). + operationId: apigee.organizations.sharedflows.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16994,7 +16495,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -17002,25 +16503,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - in: path - name: keystoresId + name: revisionsId required: true schema: type: string - - in: path - name: aliasesId - required: true + - in: query + name: format schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: parameters: *ref_1 get: - description: Gets the certificate from an alias in PEM-encoded form. - operationId: apigee.organizations.environments.keystores.aliases.getCertificate + description: Lists all deployments of a shared flow. + operationId: apigee.organizations.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17032,7 +16532,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -17040,27 +16541,54 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string + /v1/organizations/{organizationsId}/sharedflows: + parameters: *ref_1 + post: + description: >- + Uploads a ZIP-formatted shared flow configuration bundle to an + organization. If the shared flow already exists, this creates a new + revision of it. If the shared flow does not exist, this creates it. Once + imported, the shared flow revision must be deployed before it can be + accessed at runtime. The size limit of a shared flow bundle is 15 MB. + operationId: apigee.organizations.sharedflows.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + parameters: - in: path - name: keystoresId + name: organizationsId required: true schema: type: string - - in: path - name: aliasesId - required: true + - in: query + name: action + schema: + type: string + - in: query + name: name schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr: - parameters: *ref_1 get: - description: >- - Generates a PKCS #10 Certificate Signing Request for the private key in - an alias. - operationId: apigee.organizations.environments.keystores.aliases.csr + description: Lists all shared flows in the organization. + operationId: apigee.organizations.sharedflows.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17072,38 +16600,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId - required: true + - in: query + name: includeRevisions schema: - type: string - - in: path - name: aliasesId - required: true + type: boolean + - in: query + name: includeMetaData schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: + type: boolean + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: parameters: *ref_1 - get: + delete: description: >- - After the query is completed, use this API to retrieve the results as - file. If the request succeeds, and there is a non-zero result set, the - result is downloaded to the client as a zipped JSON file. The name of - the downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.environments.securityReports.getResult + Deletes a shared flow and all it's revisions. The shared flow must be + undeployed before you can delete it. + operationId: apigee.organizations.sharedflows.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17115,7 +16634,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId @@ -17123,29 +16642,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityReportsId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: - parameters: *ref_1 - post: - description: >- - Submit a report request to be processed in the background. If the - submission succeeds, the API returns a 200 status and an ID that refer - to the report request. In addition to the HTTP status 200, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.environments.securityReports.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + get: + description: Gets a shared flow by name, including a list of its revisions. + operationId: apigee.organizations.sharedflows.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17157,7 +16660,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId @@ -17165,13 +16668,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string + /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: + parameters: *ref_1 get: - description: Return a list of Security Reports - operationId: apigee.organizations.environments.securityReports.list + description: Similar to GetHostStats except that the response is less verbose. + operationId: apigee.organizations.optimizedHostStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17183,8 +16688,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId @@ -17192,47 +16696,76 @@ paths: schema: type: string - in: path - name: environmentsId + name: optimizedHostStatsId required: true schema: type: string - in: query - name: from + name: tsAscending + schema: + type: boolean + - in: query + name: accuracy schema: type: string - in: query - name: pageSize + name: offset schema: - type: integer - format: int32 + type: string - in: query - name: dataset + name: topk schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query - name: status + name: timeUnit schema: type: string - in: query - name: submittedBy + name: tzo schema: type: string - in: query - name: to + name: envgroupHostname schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: + - in: query + name: timeRange + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: sortby + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: select + schema: + type: string + /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: parameters: *ref_1 - get: - description: >- - Get security report status If the query is still in progress, the - `state` is set to "running" After the query has completed successfully, - `state` is set to "completed" - operationId: apigee.organizations.environments.securityReports.get + patch: + description: Updates a data collector. + operationId: apigee.organizations.datacollectors.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17244,7 +16777,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -17252,22 +16785,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: datacollectorsId required: true schema: type: string - - in: path - name: securityReportsId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: - parameters: *ref_1 + format: google-fieldmask get: - description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.environments.securityReports.getResultView + description: Gets a data collector. + operationId: apigee.organizations.datacollectors.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17279,8 +16808,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -17288,20 +16816,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityReportsId + name: datacollectorsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: - parameters: *ref_1 - get: - description: Return a list of Asynchronous Queries - operationId: apigee.organizations.environments.queries.list + delete: + description: Deletes a data collector. + operationId: apigee.organizations.datacollectors.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17313,8 +16834,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17322,46 +16842,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: datacollectorsId required: true schema: type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: status - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: from - schema: - type: string - - in: query - name: inclQueriesWithoutReport - schema: - type: string - post: - description: >- - Submit a query to be processed in the background. If the submission of - the query succeeds, the API returns a 201 status and an ID that refer to - the query. In addition to the HTTP status 201, the `state` of "enqueued" - means that the request succeeded. - operationId: apigee.organizations.environments.queries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Query' + /v1/organizations/{organizationsId}/datacollectors: + parameters: *ref_1 + get: + description: Lists all data collectors. + operationId: apigee.organizations.datacollectors.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17373,28 +16862,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: - parameters: *ref_1 - get: - description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.environments.queries.getResult + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new data collector. + operationId: apigee.organizations.datacollectors.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17406,31 +16898,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: queriesId - required: true + - in: query + name: dataCollectorId schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: parameters: *ref_1 get: description: >- After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is - sent to the client as a list of urls to JSON files. - operationId: apigee.organizations.environments.queries.getResulturl + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.hostQueries.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17442,8 +16930,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -17451,23 +16938,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: queriesId + name: hostQueriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: + /v1/organizations/{organizationsId}/hostQueries: parameters: *ref_1 get: - description: >- - Get query status If the query is still in progress, the `state` is set - to "running" After the query has completed successfully, `state` is set - to "completed" - operationId: apigee.organizations.environments.queries.get + description: Return a list of Asynchronous Queries at host level. + operationId: apigee.organizations.hostQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17479,28 +16958,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: dataset schema: type: string - - in: path - name: queriesId - required: true + - in: query + name: submittedBy schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_1 - delete: - description: Deletes a key value map from an environment. - operationId: apigee.organizations.environments.keyvaluemaps.delete + - in: query + name: from + schema: + type: string + - in: query + name: to + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + - in: query + name: inclQueriesWithoutReport + schema: + type: string + post: + description: >- + Submit a query at host level to be processed in the background. If the + submission of the query succeeds, the API returns a 201 status and an ID + that refer to the query. In addition to the HTTP status 201, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.hostQueries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17512,33 +17017,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: parameters: *ref_1 - post: - description: Creates a key value map in an environment. - operationId: apigee.organizations.environments.keyvaluemaps.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + get: + description: '' + operationId: apigee.organizations.hostQueries.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17550,7 +17040,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' parameters: - in: path name: organizationsId @@ -17558,22 +17048,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostQueriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: parameters: *ref_1 - put: + get: description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.environments.keyvaluemaps.entries.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + Get status of a query submitted at host level. If the query is still in + progress, the `state` is set to "running" After the query has completed + successfully, `state` is set to "completed" + operationId: apigee.organizations.hostQueries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17585,7 +17071,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -17593,28 +17079,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: hostQueriesId required: true schema: type: string - delete: - description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.delete + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: + parameters: *ref_1 + get: + description: Gets the documentation for the specified catalog item. + operationId: apigee.organizations.sites.apidocs.getDocumentation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17626,7 +17099,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -17634,26 +17108,25 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: sitesId required: true schema: type: string - in: path - name: entriesId + name: apidocsId required: true schema: type: string - get: + patch: description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.get + Updates the documentation for the specified catalog item. Note that the + documentation file contents will not be populated in the return message. + operationId: apigee.organizations.sites.apidocs.updateDocumentation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17665,7 +17138,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -17673,28 +17147,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: sitesId required: true schema: type: string - in: path - name: entriesId + name: apidocsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: parameters: *ref_1 get: - description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.list + description: Returns the catalog items associated with a portal. + operationId: apigee.organizations.sites.apidocs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17706,8 +17172,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' parameters: - in: path name: organizationsId @@ -17715,13 +17180,12 @@ paths: schema: type: string - in: path - name: environmentsId + name: sitesId required: true schema: type: string - - in: path - name: keyvaluemapsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -17729,21 +17193,14 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string post: - description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.create + description: Creates a new catalog item. + operationId: apigee.organizations.sites.apidocs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17755,7 +17212,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -17763,20 +17220,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: - parameters: *ref_1 - get: - description: Lists all deployments of an API proxy in an environment. - operationId: apigee.organizations.environments.apis.deployments.list + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: + parameters: *ref_1 + put: + description: Updates a catalog item. + operationId: apigee.organizations.sites.apidocs.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17788,8 +17245,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -17797,20 +17253,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: sitesId required: true schema: type: string - in: path - name: apisId + name: apidocsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: - parameters: *ref_1 - get: - description: Gets the debug data from a transaction. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get + delete: + description: Deletes a catalog item. + operationId: apigee.organizations.sites.apidocs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17822,8 +17276,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -17831,40 +17284,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId + name: sitesId required: true schema: type: string - in: path - name: dataId + name: apidocsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: - parameters: *ref_1 - post: - description: Creates a debug session for a deployed API Proxy revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + get: + description: Gets a catalog item. + operationId: apigee.organizations.sites.apidocs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17876,7 +17307,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -17884,30 +17315,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId + name: sitesId required: true schema: type: string - in: path - name: revisionsId + name: apidocsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: int64 + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: + parameters: *ref_1 get: - description: >- - Lists debug sessions that are currently active in the given API Proxy - revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.list + description: Returns the API categories associated with a portal. + operationId: apigee.organizations.sites.apicategories.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17920,7 +17341,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse + #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse parameters: - in: path name: organizationsId @@ -17928,38 +17349,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: sitesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: - parameters: *ref_1 - delete: - description: >- - Deletes the data from a debug session. This does not cancel the debug - session or prevent further data from being collected if the session is - still active in runtime pods. - operationId: >- - apigee.organizations.environments.apis.revisions.debugsessions.deleteData + post: + description: Creates a new API category. + operationId: apigee.organizations.sites.apicategories.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17971,7 +17372,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -17979,30 +17380,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}: + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: parameters: *ref_1 get: - description: Retrieves a debug session. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.get + description: Gets an API category. + operationId: apigee.organizations.sites.apicategories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18014,7 +17400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -18022,43 +17408,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: sitesId required: true schema: type: string - in: path - name: debugsessionsId + name: apicategoriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: - parameters: *ref_1 - post: - description: >- - Generates a report for a dry run analysis of an UndeployApiProxy request - without committing the undeploy. In addition to the standard validations - performed when removing deployments, additional analysis will be done to - detect possible traffic routing changes that would result from this - deployment being removed. Any potential routing conflicts or unsafe - changes will be reported in the response. This routing analysis is not - performed for a non-dry-run UndeployApiProxy request. For a request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.undeploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: >- - apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport + delete: + description: Deletes an API category. + operationId: apigee.organizations.sites.apicategories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18070,7 +17431,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -18078,39 +17439,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId + name: sitesId required: true schema: type: string - in: path - name: revisionsId + name: apicategoriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: - parameters: *ref_1 - post: - description: >- - Generates a report for a dry run analysis of a DeployApiProxy request - without committing the deployment. In addition to the standard - validations performed when adding deployments, additional analysis will - be done to detect possible traffic routing changes that would result - from this deployment being created. Any potential routing conflicts or - unsafe changes will be reported in the response. This routing analysis - is not performed for a non-dry-run DeployApiProxy request. For a request - path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.deploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: >- - apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport + patch: + description: Updates an API category. + operationId: apigee.organizations.sites.apicategories.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18122,7 +17467,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -18130,41 +17475,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId + name: sitesId required: true schema: type: string - in: path - name: revisionsId + name: apicategoriesId required: true schema: type: string - - in: query - name: override - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + /v1/organizations/{organizationsId}/apps/{appsId}: parameters: *ref_1 - post: - description: >- - Deploys a revision of an API proxy. If another revision of the same API - proxy revision is currently deployed, set the `override` parameter to - `true` to have this revision replace the currently deployed revision. - You cannot invoke an API proxy until it has been deployed to an - environment. After you deploy an API proxy revision, you cannot edit it. - To edit the API proxy, you must create and deploy a new revision. For a - request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.deploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: apigee.organizations.environments.apis.revisions.deploy + get: + description: Gets the app profile for the specified app ID. + operationId: apigee.organizations.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18176,7 +17500,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1App' parameters: - in: path name: organizationsId @@ -18184,41 +17508,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: appsId required: true schema: type: string - - in: query - name: override - schema: - type: boolean - - in: query - name: serviceAccount - schema: - type: string - - in: query - name: sequencedRollout - schema: - type: boolean - delete: + /v1/organizations/{organizationsId}/apps: + parameters: *ref_1 + get: description: >- - Undeploys an API proxy revision from an environment. For a request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.undeploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: apigee.organizations.environments.apis.revisions.undeploy + Lists IDs of apps within an organization that have the specified app + status (approved or revoked) or are of the specified app type (developer + or company). + operationId: apigee.organizations.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18230,37 +17531,71 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: ids schema: type: string - - in: path - name: apisId - required: true + - in: query + name: includeCred + schema: + type: boolean + - in: query + name: apiProduct schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: rows schema: type: string + format: int64 - in: query - name: sequencedRollout + name: keyStatus + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: apptype + schema: + type: string + - in: query + name: startKey + schema: + type: string + - in: query + name: expand schema: type: boolean + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + parameters: *ref_1 get: description: >- - Gets the deployment of an API proxy revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.apis.revisions.getDeployments + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18272,7 +17607,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -18280,35 +17615,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId + name: keyvaluemapsId required: true schema: type: string - in: path - name: revisionsId + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: - parameters: *ref_1 - post: + delete: description: >- - Generates a signed URL for downloading the original zip file used to - create an Archive Deployment. The URL is only valid for a limited period - and should be used within minutes after generation. Each call returns a - new upload URL. - operationId: apigee.organizations.environments.archiveDeployments.generateDownloadUrl - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlRequest + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18320,8 +17643,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -18329,37 +17651,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: keyvaluemapsId required: true schema: type: string - in: path - name: archiveDeploymentsId + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: - parameters: *ref_1 - post: + put: description: >- - Generates a signed URL for uploading an Archive zip file to Google Cloud - Storage. Once the upload is complete, the signed URL should be passed to - CreateArchiveDeployment. When uploading to the generated signed URL, - please follow these restrictions: * Source file type should be a zip - file. * Source file size should not exceed 1GB limit. * No credentials - should be attached - the signed URLs provide access to the target bucket - using internal service identity; if credentials were attached, the - identity from the credentials would be used, but that identity does not - have permissions to upload files to the URL. When making a HTTP PUT - request, these two headers need to be specified: * `content-type: - application/zip` * `x-goog-content-length-range: 0,1073741824` And this - header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` - operationId: apigee.organizations.environments.archiveDeployments.generateUploadUrl + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.keyvaluemaps.entries.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18371,8 +17681,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -18380,15 +17689,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: + - in: path + name: entriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_1 - delete: - description: Deletes an archive deployment. - operationId: apigee.organizations.environments.archiveDeployments.delete + get: + description: >- + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18400,7 +17717,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -18408,25 +17726,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: keyvaluemapsId required: true schema: type: string - - in: path - name: archiveDeploymentsId - required: true + - in: query + name: pageToken schema: type: string - patch: + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: description: >- - Updates an existing ArchiveDeployment. Labels can modified but most of - the other fields are not modifiable. - operationId: apigee.organizations.environments.archiveDeployments.patch + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.keyvaluemaps.entries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18438,7 +17761,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -18446,23 +17769,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: archiveDeploymentsId + name: keyvaluemapsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets the specified ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.get + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 + delete: + description: Deletes a key value map from an organization. + operationId: apigee.organizations.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18474,7 +17789,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -18482,25 +17797,49 @@ paths: schema: type: string - in: path - name: environmentsId + name: keyvaluemapsId required: true schema: type: string + /v1/organizations/{organizationsId}/keyvaluemaps: + parameters: *ref_1 + post: + description: Creates a key value map in an organization. + operationId: apigee.organizations.keyvaluemaps.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + parameters: - in: path - name: archiveDeploymentsId + name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: + /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: parameters: *ref_1 post: - description: Creates a new ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.create + description: Compute RAV2 security scores for a set of resources. + operationId: apigee.organizations.securityAssessmentResults.batchCompute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18512,21 +17851,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string + /v1/organizations/{organizationsId}/apis/{apisId}/deployments: + parameters: *ref_1 get: - description: Lists the ArchiveDeployments in the specified Environment. - operationId: apigee.organizations.environments.archiveDeployments.list + description: Lists all deployments of an API proxy. + operationId: apigee.organizations.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18539,7 +17876,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -18547,28 +17884,26 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: parameters: *ref_1 - get: - description: Gets a TargetServer resource. - operationId: apigee.organizations.environments.targetservers.get + post: + description: >- + Updates an existing API proxy revision by uploading the API proxy + configuration bundle as a zip file from your local machine. You can + update only API proxy revisions that have never been deployed. After + deployment, an API proxy revision becomes immutable, even if it is + undeployed. Set the `Content-Type` header to either + `multipart/form-data` or `application/octet-stream`. + operationId: apigee.organizations.apis.revisions.updateApiProxyRevision + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18580,7 +17915,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId @@ -18588,20 +17923,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: targetserversId + name: revisionsId required: true schema: type: string + - in: query + name: validate + schema: + type: boolean delete: description: >- - Deletes a TargetServer from an environment. Returns the deleted - TargetServer resource. - operationId: apigee.organizations.environments.targetservers.delete + Deletes an API proxy revision and all policies, resources, endpoints, + and revisions associated with it. The API proxy revision must be + undeployed before you can delete it. + operationId: apigee.organizations.apis.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18613,7 +17953,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId @@ -18621,26 +17961,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: targetserversId + name: revisionsId required: true schema: type: string - put: + get: description: >- - Updates an existing TargetServer. Note that this operation has PUT - semantics; it will replace the entirety of the existing TargetServer - with the resource in the request body. - operationId: apigee.organizations.environments.targetservers.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + Gets an API proxy revision. To download the API proxy configuration + bundle for the specified revision as a zip file, set the `format` query + parameter to `bundle`. If you are using curl, specify `-o filename.zip` + to save the output to a file; otherwise, it displays to `stdout`. Then, + develop the API proxy configuration locally and upload the updated API + proxy configuration revision, as described in + [updateApiProxyRevision](updateApiProxyRevision). + operationId: apigee.organizations.apis.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18652,7 +17991,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -18660,25 +17999,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: targetserversId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: + - in: query + name: format + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: parameters: *ref_1 - post: - description: Creates a TargetServer in the specified environment. - operationId: apigee.organizations.environments.targetservers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + get: + description: Lists all deployments of an API proxy revision. + operationId: apigee.organizations.apis.revisions.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18690,7 +18028,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -18698,27 +18037,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - - in: query - name: name + - in: path + name: revisionsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: parameters: *ref_1 - put: - description: >- - Updates an existing Reference. Note that this operation has PUT - semantics; it will replace the entirety of the existing Reference with - the resource in the request body. - operationId: apigee.organizations.environments.references.update + post: + description: Creates a key value map in an API proxy. + operationId: apigee.organizations.apis.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18730,7 +18067,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -18738,20 +18075,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: referencesId + name: apisId required: true schema: type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 delete: - description: >- - Deletes a Reference from an environment. Returns the deleted Reference - resource. - operationId: apigee.organizations.environments.references.delete + description: Deletes a key value map from an API proxy. + operationId: apigee.organizations.apis.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18763,7 +18095,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -18771,18 +18103,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: referencesId + name: keyvaluemapsId required: true schema: type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: + parameters: *ref_1 get: - description: Gets a Reference resource. - operationId: apigee.organizations.environments.references.get + description: >- + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18794,7 +18131,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -18802,25 +18140,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: referencesId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Creates a Reference in the specified environment. - operationId: apigee.organizations.environments.references.create + description: >- + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18832,7 +18180,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -18840,21 +18188,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_1 - post: - description: Updates an add-on enablement status of an environment. - operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SetAddonEnablementRequest + delete: + description: >- + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18866,7 +18218,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -18874,18 +18226,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: - parameters: *ref_1 - get: + put: description: >- - GetSecurityIncident gets the specified security incident. Returns - NOT_FOUND if security incident is not present for the specified - organization and environment. - operationId: apigee.organizations.environments.securityIncidents.get + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.apis.keyvaluemaps.entries.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18897,7 +18261,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -18905,23 +18269,26 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: securityIncidentsId + name: keyvaluemapsId required: true schema: type: string - patch: - description: UpdateSecurityIncidents updates an existing security incident. - operationId: apigee.organizations.environments.securityIncidents.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + - in: path + name: entriesId + required: true + schema: + type: string + get: + description: >- + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18933,7 +18300,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -18941,33 +18308,45 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: securityIncidentsId + name: keyvaluemapsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: entriesId + required: true schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: + /v1/organizations/{organizationsId}/apis: parameters: *ref_1 post: description: >- - BatchUpdateSecurityIncident updates multiple existing security - incidents. - operationId: apigee.organizations.environments.securityIncidents.batchUpdate + Creates an API proxy. The API proxy created will not be accessible at + runtime until it is deployed to an environment. Create a new API proxy + by setting the `name` query parameter to the name of the API proxy. + Import an API proxy configuration bundle stored in zip format on your + local machine to your organization by doing the following: * Set the + `name` query parameter to the name of the API proxy. * Set the `action` + query parameter to `import`. * Set the `Content-Type` header to + `multipart/form-data`. * Pass as a file the name of API proxy + configuration bundle stored in zip format on your local machine using + the `file` form field. **Note**: To validate the API proxy configuration + bundle only without importing it, set the `action` query parameter to + `validate`. When importing an API proxy configuration bundle, if the API + proxy does not exist, it will be created. If the API proxy exists, then + a new revision is created. Invalid API proxy configurations are + rejected, and a list of validation errors is returned to the client. + operationId: apigee.organizations.apis.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18979,26 +18358,31 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: name + schema: + type: string + - in: query + name: validate + schema: + type: boolean + - in: query + name: action schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: - parameters: *ref_1 get: description: >- - ListSecurityIncidents lists all the security incident associated with - the environment. - operationId: apigee.organizations.environments.securityIncidents.list + Lists the names of all API proxies in an organization. The names + returned correspond to the names defined in the configuration files for + each API proxy. + operationId: apigee.organizations.apis.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19010,43 +18394,31 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - in: query - name: filter + name: includeMetaData schema: - type: string + type: boolean - in: query - name: pageSize + name: includeRevisions schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: + type: boolean + /v1/organizations/{organizationsId}/apis/{apisId}: parameters: *ref_1 - post: - description: Retrieve security statistics as a collection of time series. - operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats + patch: + description: Updates an existing API proxy. + operationId: apigee.organizations.apis.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19058,8 +18430,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -19067,20 +18438,21 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: - parameters: *ref_1 - post: - description: Retrieve security statistics as tabular rows. - operationId: apigee.organizations.environments.securityStats.queryTabularStats - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes an API proxy and all associated endpoints, policies, resources, + and revisions. The API proxy must be undeployed before you can delete + it. + operationId: apigee.organizations.apis.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19092,8 +18464,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -19101,21 +18472,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: - parameters: *ref_1 get: - description: >- - Retrieve metrics grouped by dimensions. The types of metrics you can - retrieve include traffic, message counts, API call latency, response - size, and cache hits and counts. Dimensions let you view metrics in - meaningful groups. You can optionally pass dimensions as path parameters - to the `stats` API. If dimensions are not specified, the metrics are - computed on the entire set of data for the given time range. - operationId: apigee.organizations.environments.stats.get + description: Gets an API proxy including a list of existing revisions. + operationId: apigee.organizations.apis.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19127,7 +18490,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -19135,85 +18498,56 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string + /v1/organizations/{organizationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: apigee.organizations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: - in: path - name: statsId + name: organizationsId required: true schema: type: string - in: query - name: topk - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: sonar - schema: - type: boolean - - in: query - name: tzo - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: offset + name: pageToken schema: type: string - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: timeRange + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: select + name: filter schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: + /v1/organizations/{organizationsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: CreateSecurityAction creates a SecurityAction. - operationId: apigee.organizations.environments.securityActions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + 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. + operationId: apigee.organizations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19225,7 +18559,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -19233,19 +18567,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: operationsId required: true schema: type: string - - in: query - name: securityActionId - schema: - type: string + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: + parameters: *ref_1 get: description: >- - Returns a list of SecurityActions. This returns both enabled and - disabled actions. - operationId: apigee.organizations.environments.securityActions.list + Gets configuration details for an API product. The API product name + required in the request URL is the internal name of the product, not the + display name. While they may be the same, it depends on whether the API + product was created via the UI or the API. View the list of API products + to verify the internal name. + operationId: apigee.organizations.apiproducts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19257,8 +18592,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -19266,38 +18600,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: - parameters: *ref_1 - post: + put: description: >- - Enable a SecurityAction. The `state` of the SecurityAction after - enabling is `ENABLED`. `EnableSecurityAction` can be called on - SecurityActions in the state `DISABLED`; SecurityActions in a different - state (including `ENABLED) return an error. - operationId: apigee.organizations.environments.securityActions.enable + Updates an existing API product. You must include all required values, + whether or not you are updating them, as well as any optional values + that you are updating. The API product name required in the request URL + is the internal name of the product, not the display name. While they + may be the same, it depends on whether the API product was created via + UI or API. View the list of API products to identify their internal + names. + operationId: apigee.organizations.apiproducts.update requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnableSecurityActionRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19309,7 +18630,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -19317,20 +18638,72 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId + required: true + schema: + type: string + delete: + description: >- + Deletes an API product from an organization. Deleting an API product + causes app requests to the resource URIs defined in the API product to + fail. Ensure that you create a new API product to serve existing apps, + unless your intention is to disable access to the resources defined in + the API product. The API product name required in the request URL is the + internal name of the product, not the display name. While they may be + the same, it depends on whether the API product was created via the UI + or the API. View the list of API products to verify the internal name. + operationId: apigee.organizations.apiproducts.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + parameters: + - in: path + name: organizationsId required: true schema: type: string - in: path - name: securityActionsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: + /v1/organizations/{organizationsId}/apiproducts: parameters: *ref_1 - get: - description: Get a SecurityAction by name. - operationId: apigee.organizations.environments.securityActions.get + post: + description: >- + Creates an API product in an organization. You create API products after + you have proxied backend services using API proxies. An API product is a + collection of API resources combined with quota settings and metadata + that you can use to deliver customized and productized API bundles to + your developer community. This metadata can include: - Scope - + Environments - API proxies - Extensible profile API products enable you + repackage APIs on the fly, without having to do any additional coding or + configuration. Apigee recommends that you start with a simple API + product including only required elements. You then provision credentials + to apps to enable them to start testing your APIs. After you have + authentication and authorization working against a simple API product, + you can iterate to create finer-grained API products, defining different + sets of API resources for each API product. **WARNING:** - If you don't + specify an API proxy in the request body, *any* app associated with the + product can make calls to *any* API in your entire organization. - If + you don't specify an environment in the request body, the product allows + access to all environments. For more information, see What is an API + product? + operationId: apigee.organizations.apiproducts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19342,38 +18715,81 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Lists all API product names for an organization. Filter the list by + passing an `attributename` and `attibutevalue`. The maximum number of + API products returned is 1000. You can paginate the list of API products + returned using the `startKey` and `count` query parameters. + operationId: apigee.organizations.apiproducts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse + parameters: - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - - in: path - name: securityActionsId - required: true + - in: query + name: expand + schema: + type: boolean + - in: query + name: attributename schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: + - in: query + name: startKey + schema: + type: string + - in: query + name: attributevalue + schema: + type: string + - in: query + name: count + schema: + type: string + format: int64 + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: parameters: *ref_1 post: description: >- - Disable a SecurityAction. The `state` of the SecurityAction after - disabling is `DISABLED`. `DisableSecurityAction` can be called on - SecurityActions in the state `ENABLED`; SecurityActions in a different - state (including `DISABLED`) return an error. - operationId: apigee.organizations.environments.securityActions.disable + Updates or creates API product attributes. This API **replaces** the + current list of attributes with the attributes specified in the request + body. In this way, you can update existing attributes, add new + attributes, or delete existing attributes by omitting them from the + request body. **Note**: OAuth access tokens and Key Management Service + (KMS) entities (apps, developers, and API products) are cached for 180 + seconds (current default). Any custom attributes associated with + entities also get cached for at least 180 seconds after entity is + accessed during runtime. In this case, the `ExpiresIn` element on the + OAuthV2 policy won't be able to expire an access token in less than 180 + seconds. + operationId: apigee.organizations.apiproducts.attributes requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19385,7 +18801,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -19393,20 +18809,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityActionsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: - parameters: *ref_1 get: - description: Lists all deployments of a shared flow in an environment. - operationId: apigee.organizations.environments.sharedflows.deployments.list + description: Lists all API product attributes. + operationId: apigee.organizations.apiproducts.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19418,8 +18827,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -19427,22 +18835,27 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: parameters: *ref_1 - get: + post: description: >- - Gets the deployment of a shared flow revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.sharedflows.revisions.getDeployments + Updates the value of an API product attribute. **Note**: OAuth access + tokens and Key Management Service (KMS) entities (apps, developers, and + API products) are cached for 180 seconds (current default). Any custom + attributes associated with entities also get cached for at least 180 + seconds after entity is accessed during runtime. In this case, the + `ExpiresIn` element on the OAuthV2 policy won't be able to expire an + access token in less than 180 seconds. + operationId: apigee.organizations.apiproducts.attributes.updateApiProductAttribute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19454,7 +18867,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -19462,29 +18875,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - in: path - name: revisionsId + name: attributesId required: true schema: type: string - delete: - description: >- - Undeploys a shared flow revision from an environment. For a request path - `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.sharedflowrevisions.undeploy` on the resource - `organizations/{org}/sharedflows/{sf}/revisions/{rev}` - operationId: apigee.organizations.environments.sharedflows.revisions.undeploy + get: + description: Gets the value of an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19496,7 +18898,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -19504,33 +18906,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - in: path - name: revisionsId + name: attributesId required: true schema: type: string - post: - description: >- - Deploys a revision of a shared flow. If another revision of the same - shared flow is currently deployed, set the `override` parameter to - `true` to have this revision replace the currently deployed revision. - You cannot use a shared flow until it has been deployed to an - environment. For a request path - `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.sharedflowrevisions.deploy` on the resource - `organizations/{org}/sharedflows/{sf}/revisions/{rev}` - operationId: apigee.organizations.environments.sharedflows.revisions.deploy + delete: + description: Deletes an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19542,7 +18929,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -19550,38 +18937,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - in: path - name: revisionsId + name: attributesId required: true schema: type: string - - in: query - name: override - schema: - type: boolean - - in: query - name: serviceAccount - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: parameters: *ref_1 - put: - description: Attaches a shared flow to a flow hook. - operationId: apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + delete: + description: Deletes a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19593,7 +18962,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -19601,18 +18970,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: flowhooksId + name: rateplansId required: true schema: type: string - delete: - description: Detaches a shared flow from a flow hook. - operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook + get: + description: Gets the details of a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19624,7 +18993,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -19632,21 +19001,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: flowhooksId + name: rateplansId required: true schema: type: string - get: - description: >- - Returns the name of the shared flow attached to the specified flow hook. - If there's no shared flow attached to the flow hook, the API does not - return an error; it simply does not return a name in the response. - operationId: apigee.organizations.environments.flowhooks.get + put: + description: Updates an existing rate plan. + operationId: apigee.organizations.apiproducts.rateplans.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19658,7 +19029,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -19666,20 +19037,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: flowhooksId + name: rateplansId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: parameters: *ref_1 - delete: - description: Deletes a cache. - operationId: apigee.organizations.environments.caches.delete + get: + description: Lists all the rate plans for an API product. + operationId: apigee.organizations.apiproducts.rateplans.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19691,7 +19062,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' parameters: - in: path name: organizationsId @@ -19699,31 +19070,49 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - - in: path - name: cachesId - required: true + - in: query + name: startKey + schema: + type: string + - in: query + name: count + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: expand + schema: + type: boolean + - in: query + name: state schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: - parameters: *ref_1 post: description: >- - Sets the IAM policy on an environment, if the policy already exists it - will be replaced. For more information, see [Manage users, roles, and - permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.environments.setIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.setIamPolicy + Create a rate plan that is associated with an API product in an + organization. Using rate plans, API product owners can monetize their + API products by configuring one or more of the following: - Billing + frequency - Initial setup fees for using an API product - Payment + funding model (postpaid only) - Fixed recurring or consumption-based + charges for using an API product - Revenue sharing with developer + partners An API product can have multiple rate plans associated with it + but *only one* rate plan can be active at any point of time. **Note: + From the developer's perspective, they purchase API products not rate + plans. + operationId: apigee.organizations.apiproducts.rateplans.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19735,7 +19124,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -19743,20 +19132,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments: + /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: parameters: *ref_1 post: - description: Creates an environment in an organization. - operationId: apigee.organizations.environments.create + description: >- + Tests the permissions of a user on an environment, and returns a subset + of permissions that the user has on the environment. If the environment + does not exist, an empty permission set is returned (a NOT_FOUND error + is not returned). + operationId: apigee.organizations.environments.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19768,30 +19161,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: name + - in: path + name: environmentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: parameters: *ref_1 patch: description: >- - UpdateSecurityActionConfig updates the current SecurityActions - configuration. This method is used to enable/disable the feature at the - environment level. - operationId: apigee.organizations.environments.updateSecurityActionsConfig + Updates the trace configurations in an environment. Note that the + repeated fields have replace semantics when included in the field mask + and that they will be overwritten by the value of the fields in the + request body. + operationId: apigee.organizations.environments.updateTraceConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19803,7 +19198,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId @@ -19821,10 +19216,8 @@ paths: type: string format: google-fieldmask get: - description: >- - GetSecurityActionConfig returns the current SecurityActions - configuration. - operationId: apigee.organizations.environments.getSecurityActionsConfig + description: Get distributed trace configuration in an environment. + operationId: apigee.organizations.environments.getTraceConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19836,7 +19229,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId @@ -19876,11 +19269,51 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: - parameters: *ref_1 + /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: + parameters: *ref_1 + patch: + description: Updates the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.updateDebugmask + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: query + name: replaceRepeatedFields + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Gets the add-ons config of an environment. - operationId: apigee.organizations.environments.getAddonsConfig + description: Gets the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.getDebugmask security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19892,7 +19325,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' parameters: - in: path name: organizationsId @@ -19904,15 +19337,14 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: parameters: *ref_1 - delete: + post: description: >- - Deletes an environment from an organization. **Warning: You must delete - all key value maps and key value entries before you delete an - environment.** Otherwise, if you re-create the environment the key value - map entry operations will encounter encryption/decryption discrepancies. - operationId: apigee.organizations.environments.delete + Creates a subscription for the environment's Pub/Sub topic. The server + will assign a random name for this subscription. The "name" and + "push_config" must *not* be specified. + operationId: apigee.organizations.environments.subscribe security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19924,7 +19356,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' parameters: - in: path name: organizationsId @@ -19936,7 +19368,9 @@ paths: required: true schema: type: string - put: + /v1/organizations/{organizationsId}/environments/{environmentsId}: + parameters: *ref_1 + post: description: >- Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. @@ -19944,7 +19378,7 @@ paths: get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment. - operationId: apigee.organizations.environments.update + operationId: apigee.organizations.environments.updateEnvironment requestBody: content: application/json: @@ -19973,9 +19407,16 @@ paths: required: true schema: type: string - get: - description: Gets environment details. - operationId: apigee.organizations.environments.get + patch: + description: >- + Updates properties for an Apigee environment with patch semantics using + a field mask. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.environments.modifyEnvironment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19987,7 +19428,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -19999,16 +19440,18 @@ paths: required: true schema: type: string - patch: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: description: >- - Updates properties for an Apigee environment with patch semantics using - a field mask. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.environments.modifyEnvironment - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + Deletes an environment from an organization. **Warning: You must delete + all key value maps and key value entries before you delete an + environment.** Otherwise, if you re-create the environment the key value + map entry operations will encounter encryption/decryption discrepancies. + operationId: apigee.organizations.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20032,12 +19475,7 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - post: + put: description: >- Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. @@ -20045,7 +19483,7 @@ paths: get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment. - operationId: apigee.organizations.environments.updateEnvironment + operationId: apigee.organizations.environments.update requestBody: content: application/json: @@ -20074,16 +19512,9 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: - parameters: *ref_1 - post: - description: Deletes a subscription for the environment's Pub/Sub topic. - operationId: apigee.organizations.environments.unsubscribe - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + get: + description: Gets environment details. + operationId: apigee.organizations.environments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20095,7 +19526,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -20107,11 +19538,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: parameters: *ref_1 get: - description: Gets the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.getDebugmask + description: >- + GetSecurityActionConfig returns the current SecurityActions + configuration. + operationId: apigee.organizations.environments.getSecurityActionsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20123,7 +19556,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -20136,13 +19569,16 @@ paths: schema: type: string patch: - description: Updates the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.updateDebugmask + description: >- + UpdateSecurityActionConfig updates the current SecurityActions + configuration. This method is used to enable/disable the feature at the + environment level. + operationId: apigee.organizations.environments.updateSecurityActionsConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20154,7 +19590,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -20171,18 +19607,16 @@ paths: schema: type: string format: google-fieldmask - - in: query - name: replaceRepeatedFields - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: + /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: parameters: *ref_1 - get: - description: >- - Gets the API Security runtime configuration for an environment. This - named ApiSecurityRuntimeConfig to prevent conflicts with - ApiSecurityConfig from addon config. - operationId: apigee.organizations.environments.getApiSecurityRuntimeConfig + post: + description: Deletes a subscription for the environment's Pub/Sub topic. + operationId: apigee.organizations.environments.unsubscribe + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20194,8 +19628,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -20207,51 +19640,22 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: + /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: parameters: *ref_1 - patch: + post: description: >- - Updates the trace configurations in an environment. Note that the - repeated fields have replace semantics when included in the field mask - and that they will be overwritten by the value of the fields in the - request body. - operationId: apigee.organizations.environments.updateTraceConfig + Sets the IAM policy on an environment, if the policy already exists it + will be replaced. For more information, see [Manage users, roles, and + permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.environments.setIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Get distributed trace configuration in an environment. - operationId: apigee.organizations.environments.getTraceConfig + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20263,7 +19667,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -20275,14 +19679,14 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: parameters: *ref_1 - post: + get: description: >- - Creates a subscription for the environment's Pub/Sub topic. The server - will assign a random name for this subscription. The "name" and - "push_config" must *not* be specified. - operationId: apigee.organizations.environments.subscribe + Gets the API Security runtime configuration for an environment. This + named ApiSecurityRuntimeConfig to prevent conflicts with + ApiSecurityConfig from addon config. + operationId: apigee.organizations.environments.getApiSecurityRuntimeConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20294,7 +19698,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig parameters: - in: path name: organizationsId @@ -20344,48 +19749,16 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: + /v1/organizations/{organizationsId}/environments: parameters: *ref_1 post: - description: >- - Tests the permissions of a user on an environment, and returns a subset - of permissions that the user has on the environment. If the environment - does not exist, an empty permission set is returned (a NOT_FOUND error - is not returned). - operationId: apigee.organizations.environments.testIamPermissions + description: Creates an environment in an organization. + operationId: apigee.organizations.environments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: environmentsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: - parameters: *ref_1 - delete: - description: Deletes an endpoint attachment. - operationId: apigee.organizations.endpointAttachments.delete + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20404,14 +19777,15 @@ paths: required: true schema: type: string - - in: path - name: endpointAttachmentsId - required: true + - in: query + name: name schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: + parameters: *ref_1 get: - description: Gets the endpoint attachment. - operationId: apigee.organizations.endpointAttachments.get + description: Gets the add-ons config of an environment. + operationId: apigee.organizations.environments.getAddonsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20423,7 +19797,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' parameters: - in: path name: organizationsId @@ -20431,22 +19805,15 @@ paths: schema: type: string - in: path - name: endpointAttachmentsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/endpointAttachments: + /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: parameters: *ref_1 - post: - description: >- - Creates an endpoint attachment. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.endpointAttachments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + delete: + description: Deletes a cache. + operationId: apigee.organizations.environments.caches.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20458,20 +19825,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: endpointAttachmentId + - in: path + name: environmentsId + required: true schema: type: string - get: - description: Lists the endpoint attachments in an organization. - operationId: apigee.organizations.endpointAttachments.list + - in: path + name: cachesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: + parameters: *ref_1 + delete: + description: Detaches a shared flow from a flow hook. + operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20483,33 +19858,31 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: environmentsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: flowhooksId + required: true schema: type: string - /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: - parameters: *ref_1 - patch: - description: Updates a data collector. - operationId: apigee.organizations.datacollectors.patch + put: + description: Attaches a shared flow to a flow hook. + operationId: apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20521,7 +19894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -20529,18 +19902,21 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: flowhooksId + required: true schema: type: string - format: google-fieldmask get: - description: Gets a data collector. - operationId: apigee.organizations.datacollectors.get + description: >- + Returns the name of the shared flow attached to the specified flow hook. + If there's no shared flow attached to the flow hook, the API does not + return an error; it simply does not return a name in the response. + operationId: apigee.organizations.environments.flowhooks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20552,7 +19928,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -20560,13 +19936,26 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - delete: - description: Deletes a data collector. - operationId: apigee.organizations.datacollectors.delete + - in: path + name: flowhooksId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: + parameters: *ref_1 + get: + description: >- + Retrieve metrics grouped by dimensions. The types of metrics you can + retrieve include traffic, message counts, API call latency, response + size, and cache hits and counts. Dimensions let you view metrics in + meaningful groups. You can optionally pass dimensions as path parameters + to the `stats` API. If dimensions are not specified, the metrics are + computed on the entire set of data for the given time range. + operationId: apigee.organizations.environments.stats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20578,7 +19967,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId @@ -20586,51 +19975,82 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/datacollectors: - parameters: *ref_1 - get: - description: Lists all data collectors. - operationId: apigee.organizations.datacollectors.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse - parameters: - in: path - name: organizationsId + name: statsId required: true schema: type: string - in: query - name: pageToken + name: sonar + schema: + type: boolean + - in: query + name: aggTable schema: type: string - in: query - name: pageSize + name: sort schema: - type: integer - format: int32 - post: - description: Creates a new data collector. - operationId: apigee.organizations.datacollectors.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: sortby + schema: + type: string + - in: query + name: select + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: topk + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: >- + Gets a particular deployment of Api proxy or a shared flow in an + environment + operationId: apigee.organizations.environments.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20642,24 +20062,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: dataCollectorId + - in: path + name: environmentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/operations: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: apigee.organizations.operations.list + description: Lists all deployments of API proxies or shared flows in an environment. + operationId: apigee.organizations.environments.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20671,34 +20095,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - in: query - name: filter + name: sharedFlows schema: - type: string - /v1/organizations/{organizationsId}/operations/{operationsId}: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy: parameters: *ref_1 - get: + post: 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. - operationId: apigee.organizations.operations.get + Sets the IAM policy on a deployment, if the policy already exists it + will be replaced. For more information, see [Manage users, roles, and + permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.deployments.setIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.deployments.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20710,7 +20139,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -20718,15 +20147,29 @@ paths: schema: type: string - in: path - name: operationsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions: parameters: *ref_1 - delete: - description: Deletes a catalog item. - operationId: apigee.organizations.sites.apidocs.delete + post: + description: >- + Tests the permissions of a user on a deployment, and returns a subset of + permissions that the user has on the deployment. If the deployment does + not exist, an empty permission set is returned (a NOT_FOUND error is not + returned). + operationId: apigee.organizations.environments.deployments.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20738,7 +20181,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId @@ -20746,23 +20189,25 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apidocsId + name: deploymentsId required: true schema: type: string - put: - description: Updates a catalog item. - operationId: apigee.organizations.sites.apidocs.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the IAM policy on a deployment. For more information, see [Manage + users, roles, and permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.deployments.getIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.deployments.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20774,7 +20219,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -20782,18 +20227,25 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apidocsId + name: deploymentsId required: true schema: type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: + parameters: *ref_1 get: - description: Gets a catalog item. - operationId: apigee.organizations.sites.apidocs.get + description: Lists all deployments of an API proxy in an environment. + operationId: apigee.organizations.environments.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20805,7 +20257,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -20813,20 +20266,20 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apidocsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: parameters: *ref_1 get: - description: Returns the catalog items associated with a portal. - operationId: apigee.organizations.sites.apidocs.list + description: Gets the debug data from a transaction. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20838,7 +20291,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction parameters: - in: path name: organizationsId @@ -20846,27 +20300,39 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: apisId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: revisionsId + required: true schema: - type: integer - format: int32 - post: - description: Creates a new catalog item. - operationId: apigee.organizations.sites.apidocs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + type: string + - in: path + name: debugsessionsId + required: true + schema: + type: string + - in: path + name: dataId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: + parameters: *ref_1 + delete: + description: >- + Deletes the data from a debug session. This does not cancel the debug + session or prevent further data from being collected if the session is + still active in runtime pods. + operationId: >- + apigee.organizations.environments.apis.revisions.debugsessions.deleteData security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20878,7 +20344,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -20886,15 +20352,32 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: path + name: debugsessionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: parameters: *ref_1 get: - description: Gets the documentation for the specified catalog item. - operationId: apigee.organizations.sites.apidocs.getDocumentation + description: >- + Lists debug sessions that are currently active in the given API Proxy + revision. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20907,7 +20390,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse parameters: - in: path name: organizationsId @@ -20915,25 +20398,37 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apidocsId + name: apisId required: true schema: type: string - patch: - description: >- - Updates the documentation for the specified catalog item. Note that the - documentation file contents will not be populated in the return message. - operationId: apigee.organizations.sites.apidocs.updateDocumentation + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a debug session for a deployed API Proxy revision. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20945,8 +20440,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId @@ -20954,20 +20448,30 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apidocsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: int64 + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}: parameters: *ref_1 get: - description: Gets an API category. - operationId: apigee.organizations.sites.apicategories.get + description: Retrieves a debug session. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20979,7 +20483,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId @@ -20987,54 +20491,44 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apicategoriesId + name: environmentsId required: true schema: type: string - delete: - description: Deletes an API category. - operationId: apigee.organizations.sites.apicategories.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' - parameters: - in: path - name: organizationsId + name: apisId required: true schema: type: string - in: path - name: sitesId + name: revisionsId required: true schema: type: string - in: path - name: apicategoriesId + name: debugsessionsId required: true schema: type: string - patch: - description: Updates an API category. - operationId: apigee.organizations.sites.apicategories.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: + parameters: *ref_1 + post: + description: >- + Generates a report for a dry run analysis of a DeployApiProxy request + without committing the deployment. In addition to the standard + validations performed when adding deployments, additional analysis will + be done to detect possible traffic routing changes that would result + from this deployment being created. Any potential routing conflicts or + unsafe changes will be reported in the response. This routing analysis + is not performed for a non-dry-run DeployApiProxy request. For a request + path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.deploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: >- + apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21046,7 +20540,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId @@ -21054,25 +20548,42 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apicategoriesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: override + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: parameters: *ref_1 post: - description: Creates a new API category. - operationId: apigee.organizations.sites.apicategories.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + description: >- + Generates a report for a dry run analysis of an UndeployApiProxy request + without committing the undeploy. In addition to the standard validations + performed when removing deployments, additional analysis will be done to + detect possible traffic routing changes that would result from this + deployment being removed. Any potential routing conflicts or unsafe + changes will be reported in the response. This routing analysis is not + performed for a non-dry-run UndeployApiProxy request. For a request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.undeploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: >- + apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21084,7 +20595,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId @@ -21092,42 +20603,31 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - get: - description: Returns the API categories associated with a portal. - operationId: apigee.organizations.sites.apicategories.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse - parameters: - in: path - name: organizationsId + name: apisId required: true schema: type: string - in: path - name: sitesId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: parameters: *ref_1 delete: - description: Deletes an environment group. - operationId: apigee.organizations.envgroups.delete + description: >- + Undeploys an API proxy revision from an environment. For a request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.undeploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: apigee.organizations.environments.apis.revisions.undeploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21139,7 +20639,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -21147,18 +20647,29 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - patch: - description: Updates an environment group. - operationId: apigee.organizations.envgroups.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: sequencedRollout + schema: + type: boolean + get: + description: >- + Gets the deployment of an API proxy revision and actual state reported + by runtime pods. + operationId: apigee.organizations.environments.apis.revisions.getDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21170,7 +20681,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -21178,18 +20689,35 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: apisId + required: true schema: type: string - format: google-fieldmask - get: - description: Gets an environment group. - operationId: apigee.organizations.envgroups.get + - in: path + name: revisionsId + required: true + schema: + type: string + post: + description: >- + Deploys a revision of an API proxy. If another revision of the same API + proxy revision is currently deployed, set the `override` parameter to + `true` to have this revision replace the currently deployed revision. + You cannot invoke an API proxy until it has been deployed to an + environment. After you deploy an API proxy revision, you cannot edit it. + To edit the API proxy, you must create and deploy a new revision. For a + request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.deploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: apigee.organizations.environments.apis.revisions.deploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21201,7 +20729,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -21209,15 +20737,37 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: override + schema: + type: boolean + - in: query + name: sequencedRollout + schema: + type: boolean + - in: query + name: serviceAccount + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: parameters: *ref_1 get: - description: Gets the deployed ingress configuration for an environment group. - operationId: apigee.organizations.envgroups.getDeployedIngressConfig + description: Gets the specified ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21229,7 +20779,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId @@ -21237,19 +20787,18 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: view + - in: path + name: archiveDeploymentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups: - parameters: *ref_1 - get: - description: Lists all environment groups. - operationId: apigee.organizations.envgroups.list + delete: + description: Deletes an archive deployment. + operationId: apigee.organizations.environments.archiveDeployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21261,31 +20810,33 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: archiveDeploymentsId + required: true schema: - type: integer - format: int32 - post: - description: Creates a new environment group. - operationId: apigee.organizations.envgroups.create + type: string + patch: + description: >- + Updates an existing ArchiveDeployment. Labels can modified but most of + the other fields are not modifiable. + operationId: apigee.organizations.environments.archiveDeployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21297,22 +20848,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: archiveDeploymentsId + required: true + schema: + type: string - in: query - name: name + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: parameters: *ref_1 - delete: - description: Deletes an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.delete + post: + description: >- + Generates a signed URL for downloading the original zip file used to + create an Archive Deployment. The URL is only valid for a limited period + and should be used within minutes after generation. Each call returns a + new upload URL. + operationId: apigee.organizations.environments.archiveDeployments.generateDownloadUrl + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21324,7 +20896,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse parameters: - in: path name: organizationsId @@ -21332,18 +20905,20 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - in: path - name: attachmentsId + name: archiveDeploymentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: + parameters: *ref_1 get: - description: Gets an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.get + description: Lists the ArchiveDeployments in the specified Environment. + operationId: apigee.organizations.environments.archiveDeployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21356,7 +20931,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse parameters: - in: path name: organizationsId @@ -21364,26 +20939,31 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - - in: path - name: attachmentsId - required: true + - in: query + name: filter schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Creates a new attachment of an environment to an environment group. - operationId: apigee.organizations.envgroups.attachments.create + description: Creates a new ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21403,13 +20983,32 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - get: - description: Lists all attachments of an environment group. - operationId: apigee.organizations.envgroups.attachments.list + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: + parameters: *ref_1 + post: + description: >- + Generates a signed URL for uploading an Archive zip file to Google Cloud + Storage. Once the upload is complete, the signed URL should be passed to + CreateArchiveDeployment. When uploading to the generated signed URL, + please follow these restrictions: * Source file type should be a zip + file. * Source file size should not exceed 1GB limit. * No credentials + should be attached - the signed URLs provide access to the target bucket + using internal service identity; if credentials were attached, the + identity from the credentials would be used, but that identity does not + have permissions to upload files to the URL. When making a HTTP PUT + request, these two headers need to be specified: * `content-type: + application/zip` * `x-goog-content-length-range: 0,1073741824` And this + header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` + operationId: apigee.organizations.environments.archiveDeployments.generateUploadUrl + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21422,7 +21021,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse parameters: - in: path name: organizationsId @@ -21430,41 +21029,20 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: + /v1/organizations/{organizationsId}/environments/{environmentsId}/references: parameters: *ref_1 post: - description: >- - Creates a custom consumer key and secret for a AppGroup app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the ProductizeAppGroupAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteAppGroupAppKey API. - operationId: apigee.organizations.appgroups.apps.keys.create + description: Creates a Reference in the specified environment. + operationId: apigee.organizations.environments.references.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21476,7 +21054,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -21484,22 +21062,23 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: parameters: *ref_1 - get: + put: description: >- - Gets details for a consumer key for a AppGroup app, including the key - and secret value, associated API products, and other information. - operationId: apigee.organizations.appgroups.apps.keys.get + Updates an existing Reference. Note that this operation has PUT + semantics; it will replace the entirety of the existing Reference with + the resource in the request body. + operationId: apigee.organizations.environments.references.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21511,7 +21090,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -21519,26 +21098,20 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: referencesId required: true schema: type: string delete: description: >- - Deletes an app's consumer key and removes all API products associated - with the app. After the consumer key is deleted, it cannot be used to - access any APIs. - operationId: apigee.organizations.appgroups.apps.keys.delete + Deletes a Reference from an environment. Returns the deleted Reference + resource. + operationId: apigee.organizations.environments.references.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21550,7 +21123,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -21558,36 +21131,18 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: referencesId required: true schema: type: string - post: - description: >- - Adds an API product to an AppGroupAppKey, enabling the app that holds - the key to access the API resources bundled in the API product. In - addition, you can add attributes to the AppGroupAppKey. This API - replaces the existing attributes with those specified in the request. - Include or exclude any existing attributes that you want to retain or - delete, respectively. You can use the same key to access all API - products associated with the app. - operationId: apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + get: + description: Gets a Reference resource. + operationId: apigee.organizations.environments.references.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21599,7 +21154,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -21607,29 +21162,20 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: referencesId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: parameters: *ref_1 - delete: - description: >- - Removes an API product from an app's consumer key. After the API product - is removed, the app cannot access the API resources defined in that API - product. **Note**: The consumer key is not removed, only its association - with the API product. - operationId: apigee.organizations.appgroups.apps.keys.apiproducts.delete + get: + description: Return a list of Security Reports + operationId: apigee.organizations.environments.securityReports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21641,7 +21187,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse parameters: - in: path name: organizationsId @@ -21649,35 +21196,82 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: from + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: dataset schema: type: string + - in: query + name: to + schema: + type: string + - in: query + name: submittedBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Submit a report request to be processed in the background. If the + submission succeeds, the API returns a 200 status and an ID that refer + to the report request. In addition to the HTTP status 200, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.environments.securityReports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + parameters: - in: path - name: keysId + name: organizationsId required: true schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: + parameters: *ref_1 + get: description: >- - Approves or revokes the consumer key for an API product. After a - consumer key is approved, the app can use it to access APIs. A consumer - key that is revoked or pending cannot be used to access an API. Any - access tokens associated with a revoked consumer key will remain active. - However, Apigee checks the status of the consumer key and if set to - `revoked` will not allow access to the API. - operationId: >- - apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct + Get security report status If the query is still in progress, the + `state` is set to "running" After the query has completed successfully, + `state` is set to "completed" + operationId: apigee.organizations.environments.securityReports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21689,7 +21283,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -21697,38 +21291,22 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId + name: environmentsId required: true schema: type: string - in: path - name: apiproductsId + name: securityReportsId required: true schema: type: string - - in: query - name: action - schema: - type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: parameters: *ref_1 - delete: + get: description: >- - Deletes an AppGroup app. **Note**: The delete operation is asynchronous. - The AppGroup app is deleted immediately, but its associated resources, - such as app keys or access tokens, may take anywhere from a few seconds - to a few minutes to be deleted. - operationId: apigee.organizations.appgroups.apps.delete + After the query is completed, use this API to view the query result when + result size is small. + operationId: apigee.organizations.environments.securityReports.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21740,7 +21318,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -21748,32 +21327,25 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: securityReportsId required: true schema: type: string - put: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: + parameters: *ref_1 + get: description: >- - Updates the details for an AppGroup app. In addition, you can add an API - product to an AppGroup app and automatically generate an API key for the - app to use when calling APIs in the API product. If you want to use an - existing API key for the API product, add the API product to the API key - using the UpdateAppGroupAppKey API. Using this API, you cannot update - the app name, as it is the primary key used to identify the app and - cannot be changed. This API replaces the existing attributes with those - specified in the request. Include or exclude any existing attributes - that you want to retain or delete, respectively. - operationId: apigee.organizations.appgroups.apps.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + After the query is completed, use this API to retrieve the results as + file. If the request succeeds, and there is a non-zero result set, the + result is downloaded to the client as a zipped JSON file. The name of + the downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.environments.securityReports.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21785,7 +21357,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -21793,22 +21365,25 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: securityReportsId required: true schema: type: string - - in: query - name: action - schema: - type: string - get: - description: Returns the details for an AppGroup app. - operationId: apigee.organizations.appgroups.apps.get + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: + parameters: *ref_1 + patch: + description: UpdateSecurityIncidents updates an existing security incident. + operationId: apigee.organizations.environments.securityIncidents.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21820,7 +21395,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId @@ -21828,25 +21403,26 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: securityIncidentsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: - parameters: *ref_1 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: description: >- - Lists all apps created by an AppGroup in an Apigee organization. - Optionally, you can request an expanded view of the AppGroup apps. Lists - all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are - returned in the response if PageSize is not specified, or if the - PageSize is greater than 1000. - operationId: apigee.organizations.appgroups.apps.list + GetSecurityIncident gets the specified security incident. Returns + NOT_FOUND if security incident is not present for the specified + organization and environment. + operationId: apigee.organizations.environments.securityIncidents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21858,8 +21434,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId @@ -21867,32 +21442,28 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: securityIncidentsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: + parameters: *ref_1 post: description: >- - Creates an app and associates it with an AppGroup. This API associates - the AppGroup app with the specified API product and auto-generates an - API key for the app to use in calls to API proxies inside that API - product. The `name` is the unique ID of the app that you can use in API - calls. - operationId: apigee.organizations.appgroups.apps.create + BatchUpdateSecurityIncident updates multiple existing security + incidents. + operationId: apigee.organizations.environments.securityIncidents.batchUpdate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21904,7 +21475,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -21912,18 +21484,17 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: parameters: *ref_1 get: description: >- - Lists all AppGroups in an organization. A maximum of 1000 AppGroups are - returned in the response if PageSize is not specified, or if the - PageSize is greater than 1000. - operationId: apigee.organizations.appgroups.list + ListSecurityIncidents lists all the security incident associated with + the environment. + operationId: apigee.organizations.environments.securityIncidents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21935,13 +21506,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: query name: filter schema: @@ -21955,17 +21532,21 @@ paths: name: pageToken schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: + parameters: *ref_1 post: description: >- - Creates an AppGroup. Once created, user can register apps under the - AppGroup to obtain secret key and password. At creation time, the - AppGroup's state is set as `active`. - operationId: apigee.organizations.appgroups.create + Creates a keystore or truststore. - Keystore: Contains certificates and + their associated keys. - Truststore: Contains trusted certificates used + to validate a server's certificate. These certificates are typically + self-signed certificates or certificates that are not signed by a + trusted CA. + operationId: apigee.organizations.environments.keystores.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21977,28 +21558,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: query + name: name + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: parameters: *ref_1 - put: - description: >- - Updates an AppGroup. This API replaces the existing AppGroup details - with those specified in the request. Include or exclude any existing - details that you want to retain or delete, respectively. Note that the - state of the AppGroup should be updated using `action`, and not via - AppGroup. - operationId: apigee.organizations.appgroups.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + delete: + description: Deletes a keystore or truststore. + operationId: apigee.organizations.environments.keystores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22010,7 +21590,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -22018,23 +21598,18 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: action + - in: path + name: keystoresId + required: true schema: type: string - delete: - description: >- - Deletes an AppGroup. All app and API keys associations with the AppGroup - are also removed. **Warning**: This API will permanently delete the - AppGroup and related artifacts. **Note**: The delete operation is - asynchronous. The AppGroup app is deleted immediately, but its - associated resources, such as apps and API keys, may take anywhere from - a few seconds to a few minutes to be deleted. - operationId: apigee.organizations.appgroups.delete + get: + description: Gets a keystore or truststore. + operationId: apigee.organizations.environments.keystores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22046,23 +21621,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path - name: organizationsId + name: organizationsId + required: true + schema: + type: string + - in: path + name: environmentsId required: true schema: type: string - in: path - name: appgroupsId + name: keystoresId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr: + parameters: *ref_1 get: description: >- - Returns the AppGroup details for the provided AppGroup name in the - request URI. - operationId: apigee.organizations.appgroups.get + Generates a PKCS #10 Certificate Signing Request for the private key in + an alias. + operationId: apigee.organizations.environments.keystores.aliases.csr security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22074,7 +21656,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -22082,38 +21664,42 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts: + - in: path + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: parameters: *ref_1 post: description: >- - Creates an API product in an organization. You create API products after - you have proxied backend services using API proxies. An API product is a - collection of API resources combined with quota settings and metadata - that you can use to deliver customized and productized API bundles to - your developer community. This metadata can include: - Scope - - Environments - API proxies - Extensible profile API products enable you - repackage APIs on the fly, without having to do any additional coding or - configuration. Apigee recommends that you start with a simple API - product including only required elements. You then provision credentials - to apps to enable them to start testing your APIs. After you have - authentication and authorization working against a simple API product, - you can iterate to create finer-grained API products, defining different - sets of API resources for each API product. **WARNING:** - If you don't - specify an API proxy in the request body, *any* app associated with the - product can make calls to *any* API in your entire organization. - If - you don't specify an environment in the request body, the product allows - access to all environments. For more information, see What is an API - product? - operationId: apigee.organizations.apiproducts.create + Creates an alias from a key/certificate pair. The structure of the + request is controlled by the `format` query parameter: - `keycertfile` - + Separate PEM-encoded key and certificate files are uploaded. Set + `Content-Type: multipart/form-data` and include the `keyFile`, + `certFile`, and `password` (if keys are encrypted) fields in the request + body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A + PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, + provide the file in the `file` field, and include the `password` field + if the file is encrypted in the request body. - `selfsignedcert` - A new + private key and certificate are generated. Set `Content-Type: + application/json` and include CertificateGenerationSpec in the request + body. + operationId: apigee.organizations.environments.keystores.aliases.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22125,20 +21711,53 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId required: true schema: type: string - get: - description: >- - Lists all API product names for an organization. Filter the list by - passing an `attributename` and `attibutevalue`. The maximum number of - API products returned is 1000. You can paginate the list of API products - returned using the `startKey` and `count` query parameters. - operationId: apigee.organizations.apiproducts.list + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: keystoresId + required: true + schema: + type: string + - in: query + name: _password + schema: + type: string + - in: query + name: ignoreExpiryValidation + schema: + type: boolean + - in: query + name: alias + schema: + type: string + - in: query + name: ignoreNewlineValidation + schema: + type: boolean + - in: query + name: format + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: + parameters: *ref_1 + put: + description: Updates the certificate in an alias. + operationId: apigee.organizations.environments.keystores.aliases.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22150,45 +21769,39 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: startKey + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: attributevalue + - in: path + name: keystoresId + required: true schema: type: string - - in: query - name: expand + - in: path + name: aliasesId + required: true schema: - type: boolean + type: string - in: query - name: count + name: ignoreNewlineValidation schema: - type: string - format: int64 + type: boolean - in: query - name: attributename + name: ignoreExpiryValidation schema: - type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: - parameters: *ref_1 - get: - description: >- - Gets configuration details for an API product. The API product name - required in the request URL is the internal name of the product, not the - display name. While they may be the same, it depends on whether the API - product was created via the UI or the API. View the list of API products - to verify the internal name. - operationId: apigee.organizations.apiproducts.get + type: boolean + delete: + description: Deletes an alias. + operationId: apigee.organizations.environments.keystores.aliases.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22200,7 +21813,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -22208,25 +21821,23 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - put: - description: >- - Updates an existing API product. You must include all required values, - whether or not you are updating them, as well as any optional values - that you are updating. The API product name required in the request URL - is the internal name of the product, not the display name. While they - may be the same, it depends on whether the API product was created via - UI or API. View the list of API products to identify their internal - names. - operationId: apigee.organizations.apiproducts.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + - in: path + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId + required: true + schema: + type: string + get: + description: Gets an alias. + operationId: apigee.organizations.environments.keystores.aliases.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22238,7 +21849,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -22246,21 +21857,25 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - delete: - description: >- - Deletes an API product from an organization. Deleting an API product - causes app requests to the resource URIs defined in the API product to - fail. Ensure that you create a new API product to serve existing apps, - unless your intention is to disable access to the resources defined in - the API product. The API product name required in the request URL is the - internal name of the product, not the display name. While they may be - the same, it depends on whether the API product was created via the UI - or the API. View the list of API products to verify the internal name. - operationId: apigee.organizations.apiproducts.delete + - in: path + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: + parameters: *ref_1 + get: + description: Gets the certificate from an alias in PEM-encoded form. + operationId: apigee.organizations.environments.keystores.aliases.getCertificate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22272,7 +21887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -22280,31 +21895,31 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: + - in: path + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: parameters: *ref_1 post: - description: >- - Updates or creates API product attributes. This API **replaces** the - current list of attributes with the attributes specified in the request - body. In this way, you can update existing attributes, add new - attributes, or delete existing attributes by omitting them from the - request body. **Note**: OAuth access tokens and Key Management Service - (KMS) entities (apps, developers, and API products) are cached for 180 - seconds (current default). Any custom attributes associated with - entities also get cached for at least 180 seconds after entity is - accessed during runtime. In this case, the `ExpiresIn` element on the - OAuthV2 policy won't be able to expire an access token in less than 180 - seconds. - operationId: apigee.organizations.apiproducts.attributes + description: Updates an add-on enablement status of an environment. + operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SetAddonEnablementRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22316,7 +21931,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -22324,13 +21939,18 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: + parameters: *ref_1 get: - description: Lists all API product attributes. - operationId: apigee.organizations.apiproducts.attributes.list + description: >- + Gets the contents of a resource file. For more information about + resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22342,7 +21962,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -22350,15 +21970,32 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: - parameters: *ref_1 - delete: - description: Deletes an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.delete + - in: path + name: type + required: true + schema: + type: string + - in: path + name: name + required: true + schema: + type: string + put: + description: >- + Updates a resource file. Specify the `Content-Type` as + `application/octet-stream` or `multipart/form-data`. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22370,7 +22007,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -22378,30 +22015,26 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: type required: true schema: type: string - post: + - in: path + name: name + required: true + schema: + type: string + delete: description: >- - Updates the value of an API product attribute. **Note**: OAuth access - tokens and Key Management Service (KMS) entities (apps, developers, and - API products) are cached for 180 seconds (current default). Any custom - attributes associated with entities also get cached for at least 180 - seconds after entity is accessed during runtime. In this case, the - `ExpiresIn` element on the OAuthV2 policy won't be able to expire an - access token in less than 180 seconds. - operationId: apigee.organizations.apiproducts.attributes.updateApiProductAttribute - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + Deletes a resource file. For more information about resource files, see + [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22413,7 +22046,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -22421,18 +22054,28 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: type + required: true + schema: + type: string + - in: path + name: name required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: + parameters: *ref_1 get: - description: Gets the value of an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.get + description: >- + Lists all resource files, optionally filtering by type. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22444,7 +22087,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -22452,25 +22096,26 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: type schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: - parameters: *ref_1 - put: - description: Updates an existing rate plan. - operationId: apigee.organizations.apiproducts.rateplans.update + post: + description: >- + Creates a resource file. Specify the `Content-Type` as + `application/octet-stream` or `multipart/form-data`. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22482,7 +22127,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -22490,18 +22135,26 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - - in: path - name: rateplansId - required: true + - in: query + name: name + schema: + type: string + - in: query + name: type schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: + parameters: *ref_1 get: - description: Gets the details of a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.get + description: >- + Lists all resource files, optionally filtering by type. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.listEnvironmentResources security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22513,7 +22166,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -22521,18 +22175,30 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: rateplansId + name: type required: true schema: type: string - delete: - description: Deletes a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: + parameters: *ref_1 + post: + description: >- + Enable a SecurityAction. The `state` of the SecurityAction after + enabling is `ENABLED`. `EnableSecurityAction` can be called on + SecurityActions in the state `DISABLED`; SecurityActions in a different + state (including `ENABLED) return an error. + operationId: apigee.organizations.environments.securityActions.enable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22544,7 +22210,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -22552,35 +22218,30 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: rateplansId + name: securityActionsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: parameters: *ref_1 post: description: >- - Create a rate plan that is associated with an API product in an - organization. Using rate plans, API product owners can monetize their - API products by configuring one or more of the following: - Billing - frequency - Initial setup fees for using an API product - Payment - funding model (postpaid only) - Fixed recurring or consumption-based - charges for using an API product - Revenue sharing with developer - partners An API product can have multiple rate plans associated with it - but *only one* rate plan can be active at any point of time. **Note: - From the developer's perspective, they purchase API products not rate - plans. - operationId: apigee.organizations.apiproducts.rateplans.create + Disable a SecurityAction. The `state` of the SecurityAction after + disabling is `DISABLED`. `DisableSecurityAction` can be called on + SecurityActions in the state `ENABLED`; SecurityActions in a different + state (including `DISABLED`) return an error. + operationId: apigee.organizations.environments.securityActions.disable requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22592,7 +22253,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -22600,13 +22261,25 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - get: - description: Lists all the rate plans for an API product. - operationId: apigee.organizations.apiproducts.rateplans.list + - in: path + name: securityActionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: + parameters: *ref_1 + post: + description: CreateSecurityAction creates a SecurityAction. + operationId: apigee.organizations.environments.securityActions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22618,7 +22291,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -22626,45 +22299,19 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: query - name: expand - schema: - type: boolean - - in: query - name: count - schema: - type: integer - format: int32 - - in: query - name: state - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: startKey + name: securityActionId schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: - parameters: *ref_1 - post: + get: description: >- - ComputeEnvironmentScores calculates scores for requested time range for - the specified security profile and environment. - operationId: >- - apigee.organizations.securityProfiles.environments.computeEnvironmentScores - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + Returns a list of SecurityActions. This returns both enabled and + disabled actions. + operationId: apigee.organizations.environments.securityActions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22677,7 +22324,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse parameters: - in: path name: organizationsId @@ -22685,22 +22332,28 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: parameters: *ref_1 - delete: - description: >- - DeleteSecurityProfileEnvironmentAssociation removes profile environment - association i.e. detaches environment from security profile. - operationId: apigee.organizations.securityProfiles.environments.delete + get: + description: Get a SecurityAction by name. + operationId: apigee.organizations.environments.securityActions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22712,7 +22365,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -22720,28 +22373,25 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - in: path - name: environmentsId + name: securityActionsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: parameters: *ref_1 post: - description: >- - CreateSecurityProfileEnvironmentAssociation creates profile environment - association i.e. attaches environment to security profile. - operationId: apigee.organizations.securityProfiles.environments.create + description: Creates a key value map in an environment. + operationId: apigee.organizations.environments.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22753,8 +22403,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -22762,15 +22411,15 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: parameters: *ref_1 delete: - description: DeleteSecurityProfile delete a profile with all its revisions. - operationId: apigee.organizations.securityProfiles.delete + description: Deletes a key value map from an environment. + operationId: apigee.organizations.environments.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22782,7 +22431,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -22790,18 +22439,27 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - patch: - description: UpdateSecurityProfile update the metadata of security profile. - operationId: apigee.organizations.securityProfiles.patch + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + parameters: *ref_1 + put: + description: >- + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.environments.keyvaluemaps.entries.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22813,7 +22471,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -22821,21 +22479,28 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: keyvaluemapsId + required: true schema: type: string - format: google-fieldmask - get: + - in: path + name: entriesId + required: true + schema: + type: string + delete: description: >- - GetSecurityProfile gets the specified security profile. Returns - NOT_FOUND if security profile is not present for the specified - organization. - operationId: apigee.organizations.securityProfiles.get + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22847,7 +22512,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -22855,17 +22520,26 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles: - parameters: *ref_1 get: description: >- - ListSecurityProfiles lists all the security profiles associated with the - org including attached and unattached profiles. - operationId: apigee.organizations.securityProfiles.list + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22877,60 +22551,41 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: CreateSecurityProfile create a new custom security profile. - operationId: apigee.organizations.securityProfiles.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' - parameters: - in: path - name: organizationsId + name: keyvaluemapsId required: true schema: type: string - - in: query - name: securityProfileId + - in: path + name: entriesId + required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_1 - get: + post: description: >- - ListSecurityProfileRevisions lists all the revisions of the security - profile. - operationId: apigee.organizations.securityProfiles.listRevisions + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22942,8 +22597,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -22951,30 +22605,21 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: keyvaluemapsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: - parameters: *ref_1 get: description: >- - Retrieve metrics grouped by dimensions in host level. The types of - metrics you can retrieve include traffic, message counts, API call - latency, response size, and cache hits and counts. Dimensions let you - view metrics in meaningful groups. You can optionally pass dimensions as - path parameters to the `stats` API. If dimensions are not specified, the - metrics are computed on the entire set of data for the given time range. - operationId: apigee.organizations.hostStats.get + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22986,7 +22631,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -22994,71 +22640,34 @@ paths: schema: type: string - in: path - name: hostStatsId + name: environmentsId required: true schema: type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: sort - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: tzo - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: timeRange - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: offset + - in: path + name: keyvaluemapsId + required: true schema: type: string - in: query - name: sortby + name: pageToken schema: type: string - in: query - name: envgroupHostname + name: pageSize schema: - type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: parameters: *ref_1 - delete: - description: Deletes a key value map from an organization. - operationId: apigee.organizations.keyvaluemaps.delete + post: + description: Retrieve security statistics as tabular rows. + operationId: apigee.organizations.environments.securityStats.queryTabularStats + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23070,7 +22679,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse parameters: - in: path name: organizationsId @@ -23078,20 +22688,21 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: parameters: *ref_1 post: - description: Creates a key value map in an organization. - operationId: apigee.organizations.keyvaluemaps.create + description: Retrieve security statistics as a collection of time series. + operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23103,23 +22714,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + - in: path + name: environmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: parameters: *ref_1 - delete: + post: description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.keyvaluemaps.entries.delete + Deploys a revision of a shared flow. If another revision of the same + shared flow is currently deployed, set the `override` parameter to + `true` to have this revision replace the currently deployed revision. + You cannot use a shared flow until it has been deployed to an + environment. For a request path + `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.sharedflowrevisions.deploy` on the resource + `organizations/{org}/sharedflows/{sf}/revisions/{rev}` + operationId: apigee.organizations.environments.sharedflows.revisions.deploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23131,7 +22753,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -23139,25 +22761,37 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string - put: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: serviceAccount + schema: + type: string + - in: query + name: override + schema: + type: boolean + delete: description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.keyvaluemaps.entries.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + Undeploys a shared flow revision from an environment. For a request path + `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.sharedflowrevisions.undeploy` on the resource + `organizations/{org}/sharedflows/{sf}/revisions/{rev}` + operationId: apigee.organizations.environments.sharedflows.revisions.undeploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23169,7 +22803,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -23177,21 +22811,25 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: sharedflowsId + required: true + schema: + type: string + - in: path + name: revisionsId required: true schema: type: string get: description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.keyvaluemaps.entries.get + Gets the deployment of a shared flow revision and actual state reported + by runtime pods. + operationId: apigee.organizations.environments.sharedflows.revisions.getDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23203,7 +22841,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -23211,28 +22849,25 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: parameters: *ref_1 - post: - description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.keyvaluemaps.entries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + get: + description: Lists all deployments of a shared flow in an environment. + operationId: apigee.organizations.environments.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23244,7 +22879,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -23252,16 +22888,20 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string + - in: path + name: sharedflowsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: + parameters: *ref_1 get: - description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.keyvaluemaps.entries.list + description: Gets a TargetServer resource. + operationId: apigee.organizations.environments.targetservers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23273,8 +22913,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -23282,24 +22921,26 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: targetserversId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/hostQueries: - parameters: *ref_1 - get: - description: Return a list of Asynchronous Queries at host level. - operationId: apigee.organizations.hostQueries.list + put: + description: >- + Updates an existing TargetServer. Note that this operation has PUT + semantics; it will replace the entirety of the existing TargetServer + with the resource in the request body. + operationId: apigee.organizations.environments.targetservers.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23311,54 +22952,28 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: status - schema: - type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: inclQueriesWithoutReport - schema: - type: string - - in: query - name: envgroupHostname + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: from + - in: path + name: targetserversId + required: true schema: type: string - post: + delete: description: >- - Submit a query at host level to be processed in the background. If the - submission of the query succeeds, the API returns a 201 status and an ID - that refer to the query. In addition to the HTTP status 201, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.hostQueries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Query' + Deletes a TargetServer from an environment. Returns the deleted + TargetServer resource. + operationId: apigee.organizations.environments.targetservers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23370,18 +22985,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path - name: organizationsId + name: organizationsId + required: true + schema: + type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: targetserversId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: parameters: *ref_1 - get: - description: '' - operationId: apigee.organizations.hostQueries.getResultView + post: + description: Creates a TargetServer in the specified environment. + operationId: apigee.organizations.environments.targetservers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23393,7 +23023,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -23401,20 +23031,22 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: + - in: query + name: name + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: parameters: *ref_1 get: description: >- After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.hostQueries.getResult + sent to the client as a list of urls to JSON files. + operationId: apigee.organizations.environments.queries.getResulturl security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23426,7 +23058,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse parameters: - in: path name: organizationsId @@ -23434,18 +23067,29 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: + - in: path + name: queriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: parameters: *ref_1 - get: + post: description: >- - Get status of a query submitted at host level. If the query is still in - progress, the `state` is set to "running" After the query has completed - successfully, `state` is set to "completed" - operationId: apigee.organizations.hostQueries.get + Submit a query to be processed in the background. If the submission of + the query succeeds, the API returns a 201 status and an ID that refer to + the query. In addition to the HTTP status 201, the `state` of "enqueued" + means that the request succeeded. + operationId: apigee.organizations.environments.queries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23465,15 +23109,13 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: - parameters: *ref_1 get: - description: Similar to GetHostStats except that the response is less verbose. - operationId: apigee.organizations.optimizedHostStats.get + description: Return a list of Asynchronous Queries + operationId: apigee.organizations.environments.queries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23485,7 +23127,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId @@ -23493,71 +23136,117 @@ paths: schema: type: string - in: path - name: optimizedHostStatsId + name: environmentsId required: true schema: type: string - in: query - name: sort + name: dataset schema: type: string - in: query - name: accuracy + name: to schema: type: string - in: query - name: sortby + name: inclQueriesWithoutReport schema: type: string - in: query - name: timeRange + name: from schema: type: string - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: tzo + name: submittedBy schema: type: string - in: query - name: topk + name: status schema: type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: select + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: + parameters: *ref_1 + get: + description: >- + Get query status If the query is still in progress, the `state` is set + to "running" After the query has completed successfully, `state` is set + to "completed" + operationId: apigee.organizations.environments.queries.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: offset + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: envgroupHostname + - in: path + name: queriesId + required: true schema: type: string - - in: query - name: filter + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: + parameters: *ref_1 + get: + description: >- + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.environments.queries.getResult + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: limit + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: timeUnit + - in: path + name: queriesId + required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: parameters: *ref_1 get: - description: Lists all deployments of a shared flow revision. - operationId: apigee.organizations.sharedflows.revisions.deployments.list + description: >- + Gets the details and status of an analytics export job. If the export + job is still in progress, its `state` is set to "running". After the + export job has completed successfully, its `state` is set to + "completed". If the export job fails, its `state` is set to `failed`. + operationId: apigee.organizations.environments.analytics.exports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23569,8 +23258,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -23578,30 +23266,29 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - in: path - name: revisionsId + name: exportsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: parameters: *ref_1 post: description: >- - Updates a shared flow revision. This operation is only allowed on - revisions which have never been deployed. After deployment a revision - becomes immutable, even if it becomes undeployed. The payload is a - ZIP-formatted shared flow. Content type must be either - multipart/form-data or application/octet-stream. - operationId: apigee.organizations.sharedflows.revisions.updateSharedFlowRevision + Submit a data export job to be processed in the background. If the + request is successful, the API returns a 201 status, a URI that can be + used to retrieve the status of the export job, and the `state` value of + "enqueued". + operationId: apigee.organizations.environments.analytics.exports.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23613,7 +23300,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -23621,29 +23308,47 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string + get: + description: >- + Lists the details and status of all analytics export jobs belonging to + the parent organization and environment. + operationId: apigee.organizations.environments.analytics.exports.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' + parameters: - in: path - name: revisionsId + name: organizationsId required: true schema: type: string - - in: query - name: validate + - in: path + name: environmentsId + required: true schema: - type: boolean + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: + parameters: *ref_1 get: description: >- - Gets a revision of a shared flow. To download the shared flow - configuration bundle for the specified revision as a zip file, set the - `format` query parameter to `bundle`. If you are using curl, specify `-o - filename.zip` to save the output to a file; otherwise, it displays to - `stdout`. Then, develop the shared flow configuration locally and upload - the updated sharedFlow configuration revision, as described in - [updateSharedFlowRevision](updateSharedFlowRevision). - operationId: apigee.organizations.sharedflows.revisions.get + Gets a list of metrics and dimensions that can be used to create + analytics queries and reports. Each schema element contains the name of + the field, its associated type, and a flag indicating whether it is a + standard or custom field. + operationId: apigee.organizations.environments.analytics.admin.getSchemav2 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23655,7 +23360,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' parameters: - in: path name: organizationsId @@ -23663,24 +23368,23 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: type schema: type: string - in: query - name: format + name: disableCache schema: - type: string - delete: - description: >- - Deletes a shared flow and all associated policies, resources, and - revisions. You must undeploy the shared flow before deleting it. - operationId: apigee.organizations.sharedflows.revisions.delete + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: + parameters: *ref_1 + get: + description: Similar to GetStats except that the response is less verbose. + operationId: apigee.organizations.environments.optimizedStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23692,7 +23396,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId @@ -23700,20 +23404,80 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - in: path - name: revisionsId + name: optimizedStatsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: + - in: query + name: select + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: timeUnit + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: sortby + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: sonar + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: aggTable + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: timeRange + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: parameters: *ref_1 get: - description: Lists all deployments of a shared flow. - operationId: apigee.organizations.sharedflows.deployments.list + description: Gets a trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23725,8 +23489,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -23734,15 +23497,18 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows: - parameters: *ref_1 - get: - description: Lists all shared flows in the organization. - operationId: apigee.organizations.sharedflows.list + - in: path + name: overridesId + required: true + schema: + type: string + delete: + description: Deletes a distributed trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23754,35 +23520,35 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: includeMetaData + - in: path + name: environmentsId + required: true schema: - type: boolean - - in: query - name: includeRevisions + type: string + - in: path + name: overridesId + required: true schema: - type: boolean - post: + type: string + patch: description: >- - Uploads a ZIP-formatted shared flow configuration bundle to an - organization. If the shared flow already exists, this creates a new - revision of it. If the shared flow does not exist, this creates it. Once - imported, the shared flow revision must be deployed before it can be - accessed at runtime. The size limit of a shared flow bundle is 15 MB. - operationId: apigee.organizations.sharedflows.create + Updates a distributed trace configuration override. Note that the + repeated fields have replace semantics when included in the field mask + and that they will be overwritten by the value of the fields in the + request body. + operationId: apigee.organizations.environments.traceConfig.overrides.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23794,26 +23560,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: name + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: overridesId + required: true schema: type: string - in: query - name: action + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: parameters: *ref_1 get: - description: Gets a shared flow by name, including a list of its revisions. - operationId: apigee.organizations.sharedflows.get + description: >- + Lists all of the distributed trace configuration overrides in an + environment. + operationId: apigee.organizations.environments.traceConfig.overrides.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23825,7 +23600,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse parameters: - in: path name: organizationsId @@ -23833,15 +23609,31 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - delete: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: description: >- - Deletes a shared flow and all it's revisions. The shared flow must be - undeployed before you can delete it. - operationId: apigee.organizations.sharedflows.delete + Creates a trace configuration override. The response contains a + system-generated UUID, that can be used to view, update, or delete the + configuration override. Use the List API to view the existing trace + configuration overrides. + operationId: apigee.organizations.environments.traceConfig.overrides.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23853,7 +23645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -23861,7 +23653,7 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string @@ -23893,14 +23685,11 @@ paths: name: sharedFlows schema: type: boolean - /v1/organizations/{organizationsId}/apps: + /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: parameters: *ref_1 get: - description: >- - Lists IDs of apps within an organization that have the specified app - status (approved or revoked) or are of the specified app type (developer - or company). - operationId: apigee.organizations.apps.list + description: Get a Datastore + operationId: apigee.organizations.analytics.datastores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23912,68 +23701,52 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: ids - schema: - type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: status - schema: - type: string - - in: query - name: rows - schema: - type: string - format: int64 - - in: query - name: apptype - schema: - type: string - - in: query - name: includeCred - schema: - type: boolean - - in: query - name: filter - schema: - type: string - - in: query - name: keyStatus - schema: - type: string - - in: query - name: pageToken + - in: path + name: datastoresId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: startKey + put: + description: Update a Datastore + operationId: apigee.organizations.analytics.datastores.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: apiProduct + - in: path + name: datastoresId + required: true schema: type: string - /v1/organizations/{organizationsId}/apps/{appsId}: - parameters: *ref_1 - get: - description: Gets the app profile for the specified app ID. - operationId: apigee.organizations.apps.get + delete: + description: Delete a Datastore from an org. + operationId: apigee.organizations.analytics.datastores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23985,7 +23758,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -23993,7 +23766,7 @@ paths: schema: type: string - in: path - name: appsId + name: datastoresId required: true schema: type: string @@ -24081,16 +23854,11 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: parameters: *ref_1 - put: - description: Update a Datastore - operationId: apigee.organizations.analytics.datastores.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + delete: + description: Deletes an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24102,7 +23870,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -24110,13 +23878,18 @@ paths: schema: type: string - in: path - name: datastoresId + name: envgroupsId + required: true + schema: + type: string + - in: path + name: attachmentsId required: true schema: type: string get: - description: Get a Datastore - operationId: apigee.organizations.analytics.datastores.get + description: Gets an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24128,7 +23901,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment parameters: - in: path name: organizationsId @@ -24136,13 +23910,20 @@ paths: schema: type: string - in: path - name: datastoresId + name: envgroupsId required: true schema: type: string - delete: - description: Delete a Datastore from an org. - operationId: apigee.organizations.analytics.datastores.delete + - in: path + name: attachmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: + parameters: *ref_1 + get: + description: Lists all attachments of an environment group. + operationId: apigee.organizations.envgroups.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24154,7 +23935,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse parameters: - in: path name: organizationsId @@ -24162,15 +23944,56 @@ paths: schema: type: string - in: path - name: datastoresId + name: envgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}:getProjectMapping: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new attachment of an environment to an environment group. + operationId: apigee.organizations.envgroups.attachments.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: envgroupsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/envgroups: parameters: *ref_1 get: - description: Gets the project ID and region for an Apigee organization. - operationId: apigee.organizations.getProjectMapping + description: Lists all environment groups. + operationId: apigee.organizations.envgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24183,33 +24006,30 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:getSyncAuthorization: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: >- - Lists the service accounts with the permissions required to allow the - Synchronizer to download environment data from the control plane. An - ETag is returned in the response to `getSyncAuthorization`. Pass that - ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure - that you are updating the correct version. If you don't pass the ETag in - the call to `setSyncAuthorization`, then the existing authorization is - overwritten indiscriminately. For more information, see [Configure the - Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). - **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.getSyncAuthorization + description: Creates a new environment group. + operationId: apigee.organizations.envgroups.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24221,21 +24041,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations: + - in: query + name: name + schema: + type: string + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: parameters: *ref_1 - get: - description: >- - Lists the Apigee organizations and associated Google Cloud projects that - you have permission to access. See [Understanding - organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). - operationId: apigee.organizations.list + delete: + description: Deletes an environment group. + operationId: apigee.organizations.envgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24247,19 +24068,26 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse - parameters: [] - post: - description: >- - Creates an Apigee organization. See [Create an Apigee - organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). - operationId: apigee.organizations.create + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: envgroupsId + required: true + schema: + type: string + patch: + description: Updates an environment group. + operationId: apigee.organizations.envgroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24273,31 +24101,84 @@ paths: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: envgroupsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets an environment group. + operationId: apigee.organizations.envgroups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: envgroupsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: + parameters: *ref_1 + get: + description: Gets the deployed ingress configuration for an environment group. + operationId: apigee.organizations.envgroups.getDeployedIngressConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: envgroupsId + required: true + schema: + type: string - in: query - name: parent + name: view schema: type: string - /v1/organizations/{organizationsId}:setSyncAuthorization: + /v1/organizations/{organizationsId}:getProjectMapping: parameters: *ref_1 - post: - description: >- - Sets the permissions required to allow the Synchronizer to download - environment data from the control plane. You must call this API to - enable proper functioning of hybrid. Pass the ETag when calling - `setSyncAuthorization` to ensure that you are updating the correct - version. To get an ETag, call - [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag - in the call to `setSyncAuthorization`, then the existing authorization - is overwritten indiscriminately. For more information, see [Configure - the - Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). - **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.setSyncAuthorization - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + get: + description: Gets the project ID and region for an Apigee organization. + operationId: apigee.organizations.getProjectMapping security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24309,25 +24190,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:setAddons: + /v1/organizations/{organizationsId}/securitySettings: parameters: *ref_1 - post: + patch: description: >- - Configures the add-ons for the Apigee organization. The existing add-on - configuration will be fully replaced. - operationId: apigee.organizations.setAddons + UpdateSecuritySettings updates the current security settings for API + Security. + operationId: apigee.organizations.updateSecuritySettings requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24339,25 +24221,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}: - parameters: *ref_1 - put: - description: >- - Updates the properties for an Apigee organization. No other fields in - the organization profile will be updated. - operationId: apigee.organizations.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: GetSecuritySettings gets the security settings for API Security. + operationId: apigee.organizations.getSecuritySettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24369,13 +24247,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' parameters: - in: path name: organizationsId required: true schema: type: string + /v1/organizations/{organizationsId}: + parameters: *ref_1 get: description: >- Gets the profile for an Apigee organization. See [Understanding @@ -24434,11 +24314,16 @@ paths: name: retention schema: type: string - /v1/organizations/{organizationsId}/runtimeConfig: - parameters: *ref_1 - get: - description: Get runtime config for an organization. - operationId: apigee.organizations.getRuntimeConfig + put: + description: >- + Updates the properties for an Apigee organization. No other fields in + the organization profile will be updated. + operationId: apigee.organizations.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24450,18 +24335,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/securitySettings: + /v1/organizations: parameters: *ref_1 + post: + description: >- + Creates an Apigee organization. See [Create an Apigee + organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + operationId: apigee.organizations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: query + name: parent + schema: + type: string get: - description: GetSecuritySettings gets the security settings for API Security. - operationId: apigee.organizations.getSecuritySettings + description: >- + Lists the Apigee organizations and associated Google Cloud projects that + you have permission to access. See [Understanding + organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). + operationId: apigee.organizations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24473,23 +24388,59 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse + parameters: [] + /v1/organizations/{organizationsId}:setAddons: + parameters: *ref_1 + post: + description: >- + Configures the add-ons for the Apigee organization. The existing add-on + configuration will be fully replaced. + operationId: apigee.organizations.setAddons + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - patch: + /v1/organizations/{organizationsId}:getSyncAuthorization: + parameters: *ref_1 + post: description: >- - UpdateSecuritySettings updates the current security settings for API - Security. - operationId: apigee.organizations.updateSecuritySettings + Lists the service accounts with the permissions required to allow the + Synchronizer to download environment data from the control plane. An + ETag is returned in the response to `getSyncAuthorization`. Pass that + ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure + that you are updating the correct version. If you don't pass the ETag in + the call to `setSyncAuthorization`, then the existing authorization is + overwritten indiscriminately. For more information, see [Configure the + Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). + **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.getSyncAuthorization requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24501,18 +24452,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask /v1/organizations/{organizationsId}/deployedIngressConfig: parameters: *ref_1 get: @@ -24540,19 +24486,50 @@ paths: name: view schema: type: string - /v1/projects/{projectsId}:provisionOrganization: + /v1/organizations/{organizationsId}/runtimeConfig: + parameters: *ref_1 + get: + description: Get runtime config for an organization. + operationId: apigee.organizations.getRuntimeConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}:setSyncAuthorization: parameters: *ref_1 post: description: >- - Provisions a new Apigee organization with a functioning runtime. This is - the standard way to create trial organizations for a free Apigee trial. - operationId: apigee.projects.provisionOrganization + Sets the permissions required to allow the Synchronizer to download + environment data from the control plane. You must call this API to + enable proper functioning of hybrid. Pass the ETag when calling + `setSyncAuthorization` to ensure that you are updating the correct + version. To get an ETag, call + [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag + in the call to `setSyncAuthorization`, then the existing authorization + is overwritten indiscriminately. For more information, see [Configure + the + Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). + **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.setSyncAuthorization requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ProvisionOrganizationRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24564,10 +24541,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string + /v1/hybrid/issuers: + parameters: *ref_1 + get: + description: >- + Lists hybrid services and its trusted issuers service account ids. This + api is authenticated and unauthorized(allow all the users) and used by + runtime authn-authz service to query control plane's issuer service + account ids. + operationId: apigee.hybrid.issuers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse + parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml b/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml index 2dcabd4b..3d5007ba 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml @@ -39,115 +39,159 @@ components: schemas: V2UndeleteKeyRequest: properties: {} + description: Request message for `UndeleteKey` method. type: object id: V2UndeleteKeyRequest - description: Request message for `UndeleteKey` method. - V2LookupKeyResponse: + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - description: Response message for `LookupKey` method. - id: V2LookupKeyResponse properties: - parent: - type: string + details: + type: array + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - The project that owns the key with the value specified in the - request. - name: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: type: string description: >- - The resource name of the API key. If the API key has been purged, - resource name is empty. - V2ListKeysResponse: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + V2GetKeyStringResponse: type: object - id: V2ListKeysResponse + id: V2GetKeyStringResponse + description: Response message for `GetKeyString` method. properties: - keys: - items: - $ref: '#/components/schemas/V2Key' - description: A list of API keys. - type: array - nextPageToken: - description: The pagination token for the next page of results. + keyString: type: string - description: Response message for `ListKeys` method. + description: An encrypted and signed value of the key. V2Key: - type: object - description: The representation of a key managed by the API Keys API. - id: V2Key properties: restrictions: description: Key restrictions. $ref: '#/components/schemas/V2Restrictions' - uid: - description: Output only. Unique id in UUID4 format. - readOnly: true + deleteTime: type: string - keyString: - description: >- - Output only. An encrypted and signed value held by this key. This - field can be accessed only through the `GetKeyString` method. readOnly: true - type: string - name: + format: google-datetime description: >- - Output only. 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`. - readOnly: true + Output only. A timestamp when this key was deleted. If the resource + is not deleted, this must be empty. + createTime: type: string + readOnly: true + description: >- + Output only. A timestamp identifying the time this key was + originally created. + format: google-datetime displayName: + type: string description: >- Human-readable display name of this key that you can modify. The maximum length is 63 characters. - type: string - etag: - type: string - readOnly: true - description: >- - Output only. A checksum computed by the server based on the current - value of the Key resource. This may be sent on update and delete - requests to ensure the client has an up-to-date value before - proceeding. See https://google.aip.dev/154. updateTime: - type: string - readOnly: true - format: google-datetime description: >- Output only. A timestamp identifying the time this key was last updated. - createTime: format: google-datetime - description: >- - Output only. A timestamp identifying the time this key was - originally created. - readOnly: true type: string + readOnly: true annotations: - type: object description: >- Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. + type: object additionalProperties: type: string - deleteTime: - format: google-datetime + name: description: >- - Output only. A timestamp when this key was deleted. If the resource - is not deleted, this must be empty. + Output only. 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`. + readOnly: true + type: string + uid: type: string readOnly: true - V2GetKeyStringResponse: - id: V2GetKeyStringResponse - description: Response message for `GetKeyString` method. - properties: + description: Output only. Unique id in UUID4 format. keyString: - description: An encrypted and signed value of the key. + type: string + readOnly: true + description: >- + Output only. An encrypted and signed value held by this key. This + field can be accessed only through the `GetKeyString` method. + etag: + description: >- + Output only. A checksum computed by the server based on the current + value of the Key resource. This may be sent on update and delete + requests to ensure the client has an up-to-date value before + proceeding. See https://google.aip.dev/154. + readOnly: true type: string type: object + id: V2Key + description: The representation of a key managed by the API Keys API. + V2ListKeysResponse: + properties: + nextPageToken: + type: string + description: The pagination token for the next page of results. + keys: + items: + $ref: '#/components/schemas/V2Key' + description: A list of API keys. + type: array + id: V2ListKeysResponse + type: object + description: Response message for `ListKeys` method. + V2AndroidKeyRestrictions: + type: object + properties: + allowedApplications: + description: >- + A list of Android applications that are allowed to make API calls + with this key. + type: array + items: + $ref: '#/components/schemas/V2AndroidApplication' + description: The Android apps that are allowed to use the key. + id: V2AndroidKeyRestrictions + V2LookupKeyResponse: + description: Response message for `LookupKey` method. + properties: + parent: + description: >- + The project that owns the key with the value specified in the + request. + type: string + name: + type: string + description: >- + The resource name of the API key. If the API key has been purged, + resource name is empty. + id: V2LookupKeyResponse + type: object V2AndroidApplication: properties: sha1Fingerprint: @@ -161,26 +205,49 @@ components: packageName: type: string description: The package name of the application. - id: V2AndroidApplication + type: object description: Identifier of an Android application for key use. + id: V2AndroidApplication + V2ServerKeyRestrictions: + description: The IP addresses of callers that are allowed to use the key. + id: V2ServerKeyRestrictions type: object - V2AndroidKeyRestrictions: - id: V2AndroidKeyRestrictions properties: - allowedApplications: + allowedIps: type: array items: - $ref: '#/components/schemas/V2AndroidApplication' + type: string description: >- - A list of Android applications that are allowed to make API calls + A list of the caller IP addresses that are allowed to make API calls with this key. - description: The Android apps that are allowed to use the key. + V2BrowserKeyRestrictions: + id: V2BrowserKeyRestrictions + description: The HTTP referrers (websites) that are allowed to use the key. + properties: + allowedReferrers: + description: >- + A list of regular expressions for the referrer URLs that are allowed + to make API calls with this key. + items: + type: string + type: array type: object V2Restrictions: - type: object id: V2Restrictions description: Describes the restrictions on the key. properties: + serverKeyRestrictions: + $ref: '#/components/schemas/V2ServerKeyRestrictions' + description: The IP addresses of callers that are allowed to use the key. + browserKeyRestrictions: + description: The HTTP referrers (websites) that are allowed to use the key. + $ref: '#/components/schemas/V2BrowserKeyRestrictions' + androidKeyRestrictions: + $ref: '#/components/schemas/V2AndroidKeyRestrictions' + description: The Android apps that are allowed to use the key. + iosKeyRestrictions: + $ref: '#/components/schemas/V2IosKeyRestrictions' + description: The iOS apps that are allowed to use the key. apiTargets: type: array description: >- @@ -190,67 +257,22 @@ components: allowed. items: $ref: '#/components/schemas/V2ApiTarget' - androidKeyRestrictions: - $ref: '#/components/schemas/V2AndroidKeyRestrictions' - description: The Android apps that are allowed to use the key. - iosKeyRestrictions: - description: The iOS apps that are allowed to use the key. - $ref: '#/components/schemas/V2IosKeyRestrictions' - browserKeyRestrictions: - description: The HTTP referrers (websites) that are allowed to use the key. - $ref: '#/components/schemas/V2BrowserKeyRestrictions' - serverKeyRestrictions: - $ref: '#/components/schemas/V2ServerKeyRestrictions' - description: The IP addresses of callers that are allowed to use the key. - V2ApiTarget: + type: object + V2IosKeyRestrictions: + id: V2IosKeyRestrictions type: object properties: - methods: + allowedBundleIds: + type: array items: type: string - type: array description: >- - Optional. List of one or more methods that can be called. If empty, - all methods for the service are allowed. A wildcard (*) can be used - as the last symbol. Valid examples: - `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` - `TranslateText` `Get*` `translate.googleapis.com.Get*` - service: - type: string - description: >- - The service for this restriction. It should be the canonical service - name, for example: `translate.googleapis.com`. You can use [`gcloud - services - list`](https://cloud.google.com/sdk/gcloud/reference/services/list) - to get a list of services that are enabled in the project. - description: >- - A restriction for a specific service and optionally one or multiple - specific methods. Both fields are case insensitive. - id: V2ApiTarget + A list of bundle IDs that are allowed when making API calls with + this key. + description: The iOS apps that are allowed to use the key. Operation: + id: Operation properties: - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object name: description: >- The server-assigned name, which is only unique within the same @@ -259,6 +281,7 @@ components: `operations/{unique_id}`. type: string response: + type: object additionalProperties: description: Properties of the object. Contains field @type with type URL. type: any @@ -271,103 +294,70 @@ components: where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + $ref: '#/components/schemas/Status' + description: >- + The error result of the operation in case of failure or + cancellation. + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any type: object - type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. description: >- This resource represents a long-running operation that is the result of a network API call. - id: Operation - Status: - type: object - id: Status - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - V2ServerKeyRestrictions: - description: The IP addresses of callers that are allowed to use the key. type: object + V2ApiTarget: properties: - allowedIps: - description: >- - A list of the caller IP addresses that are allowed to make API calls - with this key. - type: array + methods: items: type: string - id: V2ServerKeyRestrictions - V2BrowserKeyRestrictions: - type: object - properties: - allowedReferrers: description: >- - A list of regular expressions for the referrer URLs that are allowed - to make API calls with this key. - items: - type: string + Optional. List of one or more methods that can be called. If empty, + all methods for the service are allowed. A wildcard (*) can be used + as the last symbol. Valid examples: + `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` + `TranslateText` `Get*` `translate.googleapis.com.Get*` type: array - id: V2BrowserKeyRestrictions - description: The HTTP referrers (websites) that are allowed to use the key. - V2IosKeyRestrictions: - description: The iOS apps that are allowed to use the key. - properties: - allowedBundleIds: + service: description: >- - A list of bundle IDs that are allowed when making API calls with - this key. - items: - type: string - type: array + The service for this restriction. It should be the canonical service + name, for example: `translate.googleapis.com`. You can use [`gcloud + services + list`](https://cloud.google.com/sdk/gcloud/reference/services/list) + to get a list of services that are enabled in the project. + type: string + description: >- + A restriction for a specific service and optionally one or multiple + specific methods. Both fields are case insensitive. + id: V2ApiTarget type: object - id: V2IosKeyRestrictions parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - alt: - description: Data format for response. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: alt + name: fields schema: type: string - enum: - - json - - media - - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -377,6 +367,16 @@ components: name: quotaUser schema: type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto key: description: >- API key. Your API key identifies your project and provides you with API @@ -386,12 +386,24 @@ components: name: key schema: type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query @@ -407,18 +419,6 @@ components: enum: - '1' - '2' - callback: - description: JSONP - in: query - name: callback - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query @@ -431,52 +431,52 @@ components: name: keys title: Keys methods: - get: + lookup_key: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/get + $ref: '#/paths/~1v2~1keys:lookupKey/get' response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/get response: mediaType: application/json openAPIDocKey: '200' - create: + objectKey: $.keys + undelete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}:undelete/post response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keys - undelete: + delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}:undelete/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - lookup_key: + patch: operation: - $ref: '#/paths/~1v2~1keys:lookupKey/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -491,64 +491,65 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/keys/methods/delete' - keys_key_string: - id: google.apikeys.keys_key_string - name: keys_key_string - title: Keys_key_string + operations: + id: google.apikeys.operations + name: operations + title: Operations methods: - get_key_string: + get: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}~1keyString/get + $ref: '#/paths/~1v2~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/keys_key_string/methods/get_key_string + - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] replace: [] delete: [] - operations: - id: google.apikeys.operations - name: operations - title: Operations + keys_key_string: + id: google.apikeys.keys_key_string + name: keys_key_string + title: Keys_key_string methods: - get: + get_key_string: operation: - $ref: '#/paths/~1v2~1operations~1{operationsId}/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}~1keyString/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: >- + #/components/x-stackQL-resources/keys_key_string/methods/get_key_string insert: [] update: [] replace: [] delete: [] paths: - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: + /v2/keys:lookupKey: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' get: description: >- - Gets the metadata for an API key. The key string of the API key isn't - included in the response. NOTE: Key is a global resource; hence the only - supported value for location is `global`. - operationId: apikeys.projects.locations.keys.get + Find the parent project and resource name of the API key that matches + the key string in the request. If the API key has been purged, resource + name will not be set. The service account must have the + `apikeys.keys.lookup` permission on the parent project. + operationId: apikeys.keys.lookupKey security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -564,35 +565,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/V2Key' + $ref: '#/components/schemas/V2LookupKeyResponse' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: keysId - required: true + - in: query + name: keyString schema: type: string - delete: + /v2/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes an API key. Deleted key can be retrieved within 30 days of - deletion. Afterward, key will be purged from the project. NOTE: Key is a - global resource; hence the only supported value for location is - `global`. - operationId: apikeys.projects.locations.keys.delete + 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. + operationId: apikeys.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -602,47 +597,33 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: keysId + name: operationsId required: true schema: type: string - - in: query - name: etag - schema: - type: string - patch: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: + parameters: *ref_1 + get: description: >- - Patches the modifiable fields of an API key. The key string of the API - key isn't included in the response. NOTE: Key is a global resource; - hence the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2Key' + Get the key string for an API key. NOTE: Key is a global resource; hence + the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.getKeyString security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/V2GetKeyStringResponse' parameters: - in: path name: projectsId @@ -659,11 +640,6 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/keys: parameters: *ref_1 post: @@ -749,29 +725,31 @@ paths: name: showDeleted schema: type: boolean - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: parameters: *ref_1 - get: + post: description: >- - Get the key string for an API key. NOTE: Key is a global resource; hence - the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.getKeyString + Undeletes an API key which was deleted within 30 days. NOTE: Key is a + global resource; hence the only supported value for location is + `global`. + operationId: apikeys.projects.locations.keys.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2UndeleteKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/V2GetKeyStringResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -788,31 +766,30 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: parameters: *ref_1 - post: + get: description: >- - Undeletes an API key which was deleted within 30 days. NOTE: Key is a - global resource; hence the only supported value for location is - `global`. - operationId: apikeys.projects.locations.keys.undelete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2UndeleteKeyRequest' + Gets the metadata for an API key. The key string of the API key isn't + included in the response. NOTE: Key is a global resource; hence the only + supported value for location is `global`. + operationId: apikeys.projects.locations.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/V2Key' parameters: - in: path name: projectsId @@ -829,23 +806,18 @@ paths: required: true schema: type: string - /v2/operations/{operationsId}: - parameters: *ref_1 - get: + delete: 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. - operationId: apikeys.operations.get + Deletes an API key. Deleted key can be retrieved within 30 days of + deletion. Afterward, key will be purged from the project. NOTE: Key is a + global resource; hence the only supported value for location is + `global`. + operationId: apikeys.projects.locations.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -855,37 +827,65 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: projectsId required: true schema: type: string - /v2/keys:lookupKey: - parameters: *ref_1 - get: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + patch: description: >- - Find the parent project and resource name of the API key that matches - the key string in the request. If the API key has been purged, resource - name will not be set. The service account must have the - `apikeys.keys.lookup` permission on the parent project. - operationId: apikeys.keys.lookupKey + Patches the modifiable fields of an API key. The key string of the API + key isn't included in the response. NOTE: Key is a global resource; + hence the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/V2LookupKeyResponse' + $ref: '#/components/schemas/Operation' parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string - in: query - name: keyString + name: updateMask schema: type: string + format: google-fieldmask diff --git a/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml b/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml index 7b55745c..45316bff 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml @@ -34,70 +34,61 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: - description: >- - Response containing the analysis results for the hypothetical resource - move. - id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse + GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: + description: Represents move analysis results for an asset. + id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis properties: - nextPageToken: - description: The next page token. Is empty if the last page is reached. - type: string - assetMoveAnalyses: - description: List of analysis results for each asset in scope. + analysisGroups: + description: List of eligible analyses performed for the asset. + type: array items: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis - type: array + #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + asset: + type: string + description: >- + The full resource name of the asset being analyzed. Example: + //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 + assetType: + type: string + description: >- + Type of the asset being analyzed. Possible values will be among the + ones listed + [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). type: object - GoogleRpcStatus: + GoogleCloudAssuredworkloadsV1MoveImpact: + properties: + detail: + type: string + description: Explanation of the impact. + description: Represents the impact of moving the asset to the target. type: object - id: GoogleRpcStatus + id: GoogleCloudAssuredworkloadsV1MoveImpact + GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: + description: Response of ListWorkloads endpoint. + id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse properties: - message: + nextPageToken: type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - details: + description: The next page token. Return empty if reached the last page. + workloads: + description: List of Workloads under a given parent. items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' type: array - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + type: object GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: properties: - ekmProvisioningErrorMapping: - description: Detailed error message if Ekm provisioning fails - type: string - enum: - - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED - - INVALID_SERVICE_ACCOUNT - - MISSING_METRICS_SCOPE_ADMIN_PERMISSION - - MISSING_EKM_CONNECTION_ADMIN_PERMISSION - enumDescriptions: - - Error is unspecified. - - Service account is used is invalid. - - Iam permission monitoring.MetricsScopeAdmin wasn't applied. - - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. ekmProvisioningErrorDomain: + description: Indicates Ekm provisioning error if any. + enum: + - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED + - UNSPECIFIED_ERROR + - GOOGLE_SERVER_ERROR + - EXTERNAL_USER_ERROR + - EXTERNAL_PARTNER_ERROR + - TIMEOUT_ERROR + type: string enumDescriptions: - No error domain - Error but domain is unspecified. @@ -107,247 +98,184 @@ components: resource. - Error occurred within the partner's provisioning cluster. - Resource wasn't provisioned in the required 7 day time period - enum: - - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED - - UNSPECIFIED_ERROR - - GOOGLE_SERVER_ERROR - - EXTERNAL_USER_ERROR - - EXTERNAL_PARTNER_ERROR - - TIMEOUT_ERROR - type: string - description: Indicates Ekm provisioning error if any. ekmProvisioningState: enum: - EKM_PROVISIONING_STATE_UNSPECIFIED - EKM_PROVISIONING_STATE_PENDING - EKM_PROVISIONING_STATE_FAILED - EKM_PROVISIONING_STATE_COMPLETED - type: string description: Indicates Ekm enrollment Provisioning of a given workload. + type: string enumDescriptions: - Default State for Ekm Provisioning - Pending State for Ekm Provisioning - Failed State for Ekm Provisioning - Completed State for Ekm Provisioning - type: object + ekmProvisioningErrorMapping: + description: Detailed error message if Ekm provisioning fails + enumDescriptions: + - Error is unspecified. + - Service account is used is invalid. + - Iam permission monitoring.MetricsScopeAdmin wasn't applied. + - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. + enum: + - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED + - INVALID_SERVICE_ACCOUNT + - MISSING_METRICS_SCOPE_ADMIN_PERMISSION + - MISSING_EKM_CONNECTION_ADMIN_PERMISSION + type: string id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse description: External key management systems(EKM) Provisioning response - GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: + type: object + GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata: + description: Operation metadata to give request details of CreateWorkload. properties: displayName: - description: >- - User-assigned resource display name. If not empty it will be used to - create a resource with the specified name. type: string - resourceId: + description: Optional. The display name of the workload. + createTime: + description: Optional. Time when the operation was created. + format: google-datetime type: string + complianceRegime: description: >- - Resource identifier. For a project this represents project_id. If - the project is already taken, the workload creation will fail. For - KeyRing, this represents the keyring_id. For a folder, don't set - this value as folder_id is assigned by Google. - resourceType: - enumDescriptions: - - Unknown resource type. - - >- - Deprecated. Existing workloads will continue to support this, but - new CreateWorkloadRequests should not specify this as an input - value. - - Consumer Folder. - - Consumer project containing encryption keys. - - Keyring resource that hosts encryption keys. + Optional. Compliance controls that should be applied to the + resources managed by the workload. type: string enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING - enumDeprecated: - - false - - true - - false - - false - - false - description: >- - Indicates the type of resource. This field should be specified to - correspond the id to the right project type (CONSUMER_PROJECT or - ENCRYPTION_KEYS_PROJECT) + - COMPLIANCE_REGIME_UNSPECIFIED + - IL4 + - CJIS + - FEDRAMP_HIGH + - FEDRAMP_MODERATE + - US_REGIONAL_ACCESS + - HIPAA + - HITRUST + - EU_REGIONS_AND_SUPPORT + - CA_REGIONS_AND_SUPPORT + - ITAR + - AU_REGIONS_AND_US_SUPPORT + - ASSURED_WORKLOADS_FOR_PARTNERS + - ISR_REGIONS + - ISR_REGIONS_AND_SUPPORT + - CA_PROTECTED_B + - IL5 + - IL2 + - JP_REGIONS_AND_SUPPORT + - KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS + - REGIONAL_CONTROLS + - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS + - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT + enumDescriptions: + - Unknown compliance regime. + - Information protection as per DoD IL4 requirements. + - Criminal Justice Information Services (CJIS) Security policies. + - FedRAMP High data protection controls + - FedRAMP Moderate data protection controls + - Assured Workloads For US Regions data protection controls + - Health Insurance Portability and Accountability Act controls + - Health Information Trust Alliance controls + - Assured Workloads For EU Regions and Support controls + - Assured Workloads For Canada Regions and Support controls + - International Traffic in Arms Regulations + - Assured Workloads for Australia Regions and Support controls + - Assured Workloads for Partners; + - Assured Workloads for Israel Regions + - Assured Workloads for Israel Regions + - Assured Workloads for Canada Protected B regime + - Information protection as per DoD IL5 requirements. + - Information protection as per DoD IL2 requirements. + - Assured Workloads for Japan Regions + - Assured Workloads Sovereign Controls KSA + - Assured Workloads for Regional Controls + - Healthcare and Life Science Controls + - Healthcare and Life Science Controls with US Support + parent: + type: string + description: Optional. The parent of the workload. + id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata type: object - id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings - description: Represent the custom settings for the resources to be created. - GoogleCloudAssuredworkloadsV1ListViolationsResponse: - description: Response of ListViolations endpoint. - id: GoogleCloudAssuredworkloadsV1ListViolationsResponse + GoogleCloudAssuredworkloadsV1Violation: + id: GoogleCloudAssuredworkloadsV1Violation type: object + description: Workload monitoring Violation. properties: - nextPageToken: - description: The next page token. Returns empty if reached the last page. - type: string - violations: - description: List of Violations under a Workload. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' - GoogleCloudAssuredworkloadsV1ViolationExceptionContext: - properties: - comment: + remediation: + description: Output only. Compliance violation remediation + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation + parentProjectNumber: description: >- - Business justification provided towards the acknowledgement of the - violation. - type: string - acknowledgementTime: + Optional. Output only. Parent project number where resource is + present. Empty for org-policy violations. + readOnly: true type: string - description: Timestamp when the violation was acknowledged. - format: google-datetime - userName: + resourceName: type: string description: >- - Name of the user (or service account) who acknowledged the - violation. - description: Violation exception detail. - type: object - id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext - GoogleLongrunningListOperationsResponse: - type: object - properties: - operations: - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + Optional. Output only. Name of the resource like + //storage.googleapis.com/myprojectxyz-testbucket. Empty for + org-policy violations. + readOnly: true + resourceType: + type: string + readOnly: true description: >- - A list of operations that matches the specified filter in the - request. - type: array - nextPageToken: - description: The standard List next-page token. + Optional. Output only. Type of the resource like + compute.googleapis.com/Disk, etc. Empty for org-policy violations. + associatedOrgPolicyViolationId: + readOnly: true type: string - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: - type: object - properties: {} - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse - description: Response for restricting the list of allowed resources. - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: - type: object - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - properties: - consoleInstructions: - description: Remediation instructions to resolve violation via cloud console - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - gcloudInstructions: - description: Remediation instructions to resolve violation via gcloud cli - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - description: Instructions to remediate violation - GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: - properties: - serviceAccessApprover: - type: boolean - description: Optional. Allow partner to view access approval logs. - assuredWorkloadsMonitoring: - description: Optional. Allow partner to view violation alerts. - type: boolean - dataLogsViewer: description: >- - Allow the partner to view inspectability logs and monitoring + Optional. Output only. Violation Id of the org-policy violation due + to which the resource violation is caused. Empty for org-policy violations. - type: boolean - accessTransparencyLogsSupportCaseViewer: - type: boolean - description: Optional. Allow partner to view support case details for an AXT log - description: >- - Permissions granted to the AW Partner SA account for the customer - workload - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - GoogleCloudAssuredworkloadsV1Violation: - properties: - category: - type: string + description: description: >- - Output only. Category under which this violation is mapped. e.g. - Location, Service Usage, Access, Encryption, etc. + Output only. Description for the Violation. e.g. OrgPolicy + gcp.resourceLocations has non compliant value. readOnly: true + type: string name: description: >- Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} - readOnly: true - type: string - nonCompliantOrgPolicy: type: string - description: >- - Output only. Immutable. Name of the OrgPolicy which was modified - with non-compliant change and resulted this violation. Format: - projects/{project_number}/policies/{constraint_name} - folders/{folder_id}/policies/{constraint_name} - organizations/{organization_id}/policies/{constraint_name} readOnly: true beginTime: type: string - readOnly: true - description: Output only. Time of the event which triggered the Violation. format: google-datetime - updateTime: - description: Output only. The last time when the Violation record was updated. - format: google-datetime - readOnly: true - type: string - resourceName: - type: string - description: >- - Optional. Output only. Name of the resource like - //storage.googleapis.com/myprojectxyz-testbucket. Empty for - org-policy violations. - readOnly: true - exceptionAuditLogLink: - type: string - description: >- - Output only. Immutable. Audit Log link to find business - justification provided for violation exception. Format: - https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} - readOnly: true - remediation: + description: Output only. Time of the event which triggered the Violation. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation - description: Output only. Compliance violation remediation acknowledgementTime: - format: google-datetime - type: string description: >- Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. - description: - description: >- - Output only. Description for the Violation. e.g. OrgPolicy - gcp.resourceLocations has non compliant value. + format: google-datetime type: string + auditLogLink: + description: >- + Output only. Immutable. Audit Log Link for violated resource Format: + https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} readOnly: true - violationType: - enumDescriptions: - - Unspecified type. - - Org Policy Violation. - - Resource Violation. - enum: - - VIOLATION_TYPE_UNSPECIFIED - - ORG_POLICY - - RESOURCE - description: Output only. Type of the violation type: string + acknowledged: + description: A boolean that indicates if the violation is acknowledged + type: boolean + nonCompliantOrgPolicy: readOnly: true - resolveTime: - type: string description: >- - Output only. Time of the event which fixed the Violation. If the - violation is ACTIVE this will be empty. - format: google-datetime - readOnly: true + Output only. Immutable. Name of the OrgPolicy which was modified + with non-compliant change and resulted this violation. Format: + projects/{project_number}/policies/{constraint_name} + folders/{folder_id}/policies/{constraint_name} + organizations/{organization_id}/policies/{constraint_name} + type: string state: + type: string readOnly: true enumDescriptions: - Unspecified state. @@ -355,12 +283,25 @@ components: - Violation is Unresolved - Violation is Exception description: Output only. State of the violation - type: string enum: - STATE_UNSPECIFIED - RESOLVED - UNRESOLVED - EXCEPTION + resolveTime: + description: >- + Output only. Time of the event which fixed the Violation. If the + violation is ACTIVE this will be empty. + readOnly: true + format: google-datetime + type: string + orgPolicyConstraint: + type: string + readOnly: true + description: >- + Output only. Immutable. The org-policy-constraint that was + incorrectly changed, which resulted in this violation. + deprecated: true exceptionContexts: type: array readOnly: true @@ -370,267 +311,101 @@ components: items: $ref: >- #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext - acknowledged: - description: A boolean that indicates if the violation is acknowledged - type: boolean - resourceType: - readOnly: true - description: >- - Optional. Output only. Type of the resource like - compute.googleapis.com/Disk, etc. Empty for org-policy violations. - type: string - orgPolicyConstraint: + updateTime: type: string + description: Output only. The last time when the Violation record was updated. + format: google-datetime readOnly: true - deprecated: true - description: >- - Output only. Immutable. The org-policy-constraint that was - incorrectly changed, which resulted in this violation. - auditLogLink: + violationType: + readOnly: true + description: Output only. Type of the violation type: string + enumDescriptions: + - Unspecified type. + - Org Policy Violation. + - Resource Violation. + enum: + - VIOLATION_TYPE_UNSPECIFIED + - ORG_POLICY + - RESOURCE + category: readOnly: true - description: >- - Output only. Immutable. Audit Log Link for violated resource Format: - https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} - associatedOrgPolicyViolationId: type: string description: >- - Optional. Output only. Violation Id of the org-policy violation due - to which the resource violation is caused. Empty for org-policy - violations. - readOnly: true - parentProjectNumber: + Output only. Category under which this violation is mapped. e.g. + Location, Service Usage, Access, Encryption, etc. + exceptionAuditLogLink: type: string readOnly: true description: >- - Optional. Output only. Parent project number where resource is - present. Empty for org-policy violations. - id: GoogleCloudAssuredworkloadsV1Violation - type: object - description: Workload monitoring Violation. - GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: + Output only. Immutable. Audit Log link to find business + justification provided for violation exception. Format: + https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: + description: Remediation instructions to resolve violation via gcloud cli properties: - setupErrors: + additionalLinks: type: array - description: Indicates SAA enrollment setup error if any. items: - enumDescriptions: - - Unspecified. - - >- - Invalid states for all customers, to be redirected to AA UI for - additional details. - - Returned when there is not an EKM key configured. - - >- - Returned when there are no enrolled services or the customer is - enrolled in CAA only for a subset of services. - - >- - Returned when exception was encountered during evaluation of - other criteria. type: string - enum: - - SETUP_ERROR_UNSPECIFIED - - ERROR_INVALID_BASE_SETUP - - ERROR_MISSING_EXTERNAL_SIGNING_KEY - - ERROR_NOT_ALL_SERVICES_ENROLLED - - ERROR_SETUP_CHECK_FAILED - setupStatus: - enumDescriptions: - - Unspecified. - - SAA enrollment pending. - - SAA enrollment comopleted. - description: Indicates SAA enrollment status of a given workload. - enum: - - SETUP_STATE_UNSPECIFIED - - STATUS_PENDING - - STATUS_COMPLETE - type: string - type: object - description: Signed Access Approvals (SAA) enrollment response. - id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse - GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata: - properties: - complianceRegime: - type: string - description: >- - Optional. Compliance controls that should be applied to the - resources managed by the workload. - enumDescriptions: - - Unknown compliance regime. - - Information protection as per DoD IL4 requirements. - - Criminal Justice Information Services (CJIS) Security policies. - - FedRAMP High data protection controls - - FedRAMP Moderate data protection controls - - Assured Workloads For US Regions data protection controls - - Health Insurance Portability and Accountability Act controls - - Health Information Trust Alliance controls - - Assured Workloads For EU Regions and Support controls - - Assured Workloads For Canada Regions and Support controls - - International Traffic in Arms Regulations - - Assured Workloads for Australia Regions and Support controls - - Assured Workloads for Partners; - - Assured Workloads for Israel Regions - - Assured Workloads for Israel Regions - - Assured Workloads for Canada Protected B regime - - Information protection as per DoD IL5 requirements. - - Information protection as per DoD IL2 requirements. - - Assured Workloads for Japan Regions - - Assured Workloads Sovereign Controls KSA - - Assured Workloads for Regional Controls - - Healthcare and Life Science Controls - - Healthcare and Life Science Controls with US Support - enum: - - COMPLIANCE_REGIME_UNSPECIFIED - - IL4 - - CJIS - - FEDRAMP_HIGH - - FEDRAMP_MODERATE - - US_REGIONAL_ACCESS - - HIPAA - - HITRUST - - EU_REGIONS_AND_SUPPORT - - CA_REGIONS_AND_SUPPORT - - ITAR - - AU_REGIONS_AND_US_SUPPORT - - ASSURED_WORKLOADS_FOR_PARTNERS - - ISR_REGIONS - - ISR_REGIONS_AND_SUPPORT - - CA_PROTECTED_B - - IL5 - - IL2 - - JP_REGIONS_AND_SUPPORT - - KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS - - REGIONAL_CONTROLS - - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS - - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT - displayName: - type: string - description: Optional. The display name of the workload. - createTime: - description: Optional. Time when the operation was created. - format: google-datetime - type: string - parent: - type: string - description: Optional. The parent of the workload. - type: object - id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata - description: Operation metadata to give request details of CreateWorkload. - GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: + description: Additional urls for more information about steps + steps: + items: + type: string + description: Steps to resolve violation via gcloud cli + type: array + gcloudCommands: + items: + type: string + description: Gcloud command to resolve violation + type: array type: object - description: Request for acknowledging the violation - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse properties: - comment: + operations: + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - Required. Business justification explaining the need for violation - acknowledgement - type: string - acknowledgeType: - description: Optional. Acknowledge type of specified violation. - enumDescriptions: - - Acknowledge type unspecified. - - Acknowledge only the specific violation. - - >- - Acknowledge specified orgPolicy violation and also associated - resource violations. - enum: - - ACKNOWLEDGE_TYPE_UNSPECIFIED - - SINGLE_VIOLATION - - EXISTING_CHILD_RESOURCE_VIOLATIONS - type: string - nonCompliantOrgPolicy: - deprecated: true + A list of operations that matches the specified filter in the + request. + nextPageToken: + description: The standard List next-page token. type: string - description: >- - Optional. This field is deprecated and will be removed in future - version of the API. Name of the OrgPolicy which was modified with - non-compliant change and resulted in this violation. Format: - projects/{project_number}/policies/{constraint_name} - folders/{folder_id}/policies/{constraint_name} - organizations/{organization_id}/policies/{constraint_name} - GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: - description: Response for violation acknowledgement - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse - properties: {} + description: The response message for Operations.ListOperations. type: object - GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: - description: Response for EnableResourceMonitoring endpoint. - id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse - properties: {} + GoogleCloudAssuredworkloadsV1ListViolationsResponse: + properties: + nextPageToken: + description: The next page token. Returns empty if reached the last page. + type: string + violations: + description: List of Violations under a Workload. + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + type: array + description: Response of ListViolations endpoint. + id: GoogleCloudAssuredworkloadsV1ListViolationsResponse type: object - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions type: object properties: - restrictionType: - enumDescriptions: - - Unknown restriction type. - - >- - Allow the use all of all gcp products, irrespective of the - compliance posture. This effectively removes - gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder. - - >- - Based on Workload's compliance regime, allowed list changes. See - - https://cloud.google.com/assured-workloads/docs/supported-products - for the list of supported resources. - - >- - Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of - compliant resources to the existing list of compliant resources. - Effective org-policy of the Folder is considered to ensure there - is no disruption to the existing customer workflows. - description: >- - Required. The type of restriction for using gcp products in the - Workload environment. - enum: - - RESTRICTION_TYPE_UNSPECIFIED - - ALLOW_ALL_GCP_RESOURCES - - ALLOW_COMPLIANT_RESOURCES - - APPEND_COMPLIANT_RESOURCES - type: string - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest - description: >- - Request for restricting list of available resources in Workload - environment. + consoleInstructions: + description: Remediation instructions to resolve violation via cloud console + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole + gcloudInstructions: + description: Remediation instructions to resolve violation via gcloud cli + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + description: Instructions to remediate violation GoogleCloudAssuredworkloadsV1Workload: - id: GoogleCloudAssuredworkloadsV1Workload properties: - partner: - enumDescriptions: - - '' - - Enum representing S3NS (Thales) partner. - - Enum representing T_SYSTEM (TSI) partner. - - Enum representing SIA_MINSAIT (Indra) partner. - - Enum representing PSN (TIM) partner. - - Enum representing CNTXT (Kingdom of Saudi Arabia) partner. - - >- - Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering - without EKM. - enum: - - PARTNER_UNSPECIFIED - - LOCAL_CONTROLS_BY_S3NS - - SOVEREIGN_CONTROLS_BY_T_SYSTEMS - - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT - - SOVEREIGN_CONTROLS_BY_PSN - - SOVEREIGN_CONTROLS_BY_CNTXT - - SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM - description: Optional. Partner regime associated with this workload. - type: string - partnerPermissions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - description: >- - Optional. Permissions granted to the AW Partner SA account for the - customer workload - createTime: - readOnly: true - type: string - description: Output only. Immutable. The Workload creation timestamp. - format: google-datetime - labels: - type: object - description: Optional. Labels applied to the workload. - additionalProperties: - type: string resources: + type: array items: $ref: >- #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceInfo @@ -640,33 +415,6 @@ components: projects already exist, the workload creation will fail. Always read only. readOnly: true - type: array - kmsSettings: - deprecated: true - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings - description: >- - Input only. Settings used to create a CMEK crypto key. When set, a - project with a KMS CMEK key is provisioned. This field is deprecated - as of Feb 28, 2022. In order to create a Keyring, callers should - specify, ENCRYPTION_KEYS_PROJECT or KEYRING in - ResourceSettings.resource_type field. - ekmProvisioningResponse: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse - description: >- - Output only. Represents the Ekm Provisioning State of the given - workload. - readOnly: true - resourceSettings: - type: array - description: >- - Input only. Resource properties that are used to customize workload - resources. These properties (such as custom project id) will be used - to create workload resources if possible. This field is optional. - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings billingAccount: type: string description: >- @@ -677,69 +425,68 @@ components: change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. - resourceMonitoringEnabled: - type: boolean - readOnly: true + partnerPermissions: description: >- - Output only. Indicates whether resource monitoring is enabled for - workload or not. It is true when Resource feed is subscribed to AWM - topic and AWM Service Agent Role is binded to AW Service Account for - resource Assured workload. - saaEnrollmentResponse: - readOnly: true + Optional. Permissions granted to the AW Partner SA account for the + customer workload + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + violationNotificationsEnabled: description: >- - Output only. Represents the SAA enrollment response of the given + Optional. Indicates whether the e-mail notification for a violation + is enabled for a workload. This value will be by default True, and + if not present will be considered as true. This should only be + updated via updateWorkload call. Any Changes to this field during + the createWorkload call will not be honored. This will always be + true while creating the workload. + type: boolean + partnerServicesBillingAccount: + description: >- + Optional. Billing account necessary for purchasing services from + Sovereign Partners. This field is required for creating + SIA/PSN/CNTXT partner workloads. The caller should have + 'billing.resourceAssociations.create' IAM permission on this + billing-account. The format of this string is + billingAccounts/AAAAAA-BBBBBB-CCCCCC + type: string + kajEnrollmentState: + enum: + - KAJ_ENROLLMENT_STATE_UNSPECIFIED + - KAJ_ENROLLMENT_STATE_PENDING + - KAJ_ENROLLMENT_STATE_COMPLETE + type: string + readOnly: true + description: >- + Output only. Represents the KAJ enrollment state of the given + workload. + enumDescriptions: + - Default State for KAJ Enrollment. + - Pending State for KAJ Enrollment. + - Complete State for KAJ Enrollment. + saaEnrollmentResponse: + description: >- + Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page. + readOnly: true $ref: >- #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse - compliantButDisallowedServices: - items: - type: string - readOnly: true - type: array - description: >- - Output only. Urls for services which are compliant for this Assured - Workload, but which are currently disallowed by the - ResourceUsageRestriction org policy. Invoke RestrictAllowedResources - endpoint to allow your project developers to use these services in - their environment. - displayName: + kmsSettings: + deprecated: true description: >- - Required. The user-assigned display name of the Workload. When - present it must be between 4 to 30 characters. Allowed characters - are: lowercase and uppercase letters, numbers, hyphen, and spaces. - Example: My Workload - type: string + Input only. Settings used to create a CMEK crypto key. When set, a + project with a KMS CMEK key is provisioned. This field is deprecated + as of Feb 28, 2022. In order to create a Keyring, callers should + specify, ENCRYPTION_KEYS_PROJECT or KEYRING in + ResourceSettings.resource_type field. + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings complianceRegime: + type: string description: >- Required. Immutable. Compliance Regime associated with this workload. - enumDescriptions: - - Unknown compliance regime. - - Information protection as per DoD IL4 requirements. - - Criminal Justice Information Services (CJIS) Security policies. - - FedRAMP High data protection controls - - FedRAMP Moderate data protection controls - - Assured Workloads For US Regions data protection controls - - Health Insurance Portability and Accountability Act controls - - Health Information Trust Alliance controls - - Assured Workloads For EU Regions and Support controls - - Assured Workloads For Canada Regions and Support controls - - International Traffic in Arms Regulations - - Assured Workloads for Australia Regions and Support controls - - Assured Workloads for Partners; - - Assured Workloads for Israel Regions - - Assured Workloads for Israel Regions - - Assured Workloads for Canada Protected B regime - - Information protection as per DoD IL5 requirements. - - Information protection as per DoD IL2 requirements. - - Assured Workloads for Japan Regions - - Assured Workloads Sovereign Controls KSA - - Assured Workloads for Regional Controls - - Healthcare and Life Science Controls - - Healthcare and Life Science Controls with US Support enum: - COMPLIANCE_REGIME_UNSPECIFIED - IL4 @@ -764,134 +511,511 @@ components: - REGIONAL_CONTROLS - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT - type: string - enableSovereignControls: - description: >- - Optional. Indicates the sovereignty status of the given workload. - Currently meant to be used by Europe/Canada customers. - type: boolean - kajEnrollmentState: enumDescriptions: - - Default State for KAJ Enrollment. - - Pending State for KAJ Enrollment. - - Complete State for KAJ Enrollment. - readOnly: true - enum: - - KAJ_ENROLLMENT_STATE_UNSPECIFIED - - KAJ_ENROLLMENT_STATE_PENDING - - KAJ_ENROLLMENT_STATE_COMPLETE - description: >- - Output only. Represents the KAJ enrollment state of the given - workload. - type: string + - Unknown compliance regime. + - Information protection as per DoD IL4 requirements. + - Criminal Justice Information Services (CJIS) Security policies. + - FedRAMP High data protection controls + - FedRAMP Moderate data protection controls + - Assured Workloads For US Regions data protection controls + - Health Insurance Portability and Accountability Act controls + - Health Information Trust Alliance controls + - Assured Workloads For EU Regions and Support controls + - Assured Workloads For Canada Regions and Support controls + - International Traffic in Arms Regulations + - Assured Workloads for Australia Regions and Support controls + - Assured Workloads for Partners; + - Assured Workloads for Israel Regions + - Assured Workloads for Israel Regions + - Assured Workloads for Canada Protected B regime + - Information protection as per DoD IL5 requirements. + - Information protection as per DoD IL2 requirements. + - Assured Workloads for Japan Regions + - Assured Workloads Sovereign Controls KSA + - Assured Workloads for Regional Controls + - Healthcare and Life Science Controls + - Healthcare and Life Science Controls with US Support etag: type: string description: >- Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. - complianceStatus: + ekmProvisioningResponse: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse readOnly: true - description: Output only. Count of active Violations in the Workload. - violationNotificationsEnabled: description: >- - Optional. Indicates whether the e-mail notification for a violation - is enabled for a workload. This value will be by default True, and - if not present will be considered as true. This should only be - updated via updateWorkload call. Any Changes to this field during - the createWorkload call will not be honored. This will always be - true while creating the workload. - type: boolean + Output only. Represents the Ekm Provisioning State of the given + workload. provisionedResourcesParent: + type: string description: >- Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} + displayName: type: string - name: + description: >- + Required. The user-assigned display name of the Workload. When + present it must be between 4 to 30 characters. Allowed characters + are: lowercase and uppercase letters, numbers, hyphen, and spaces. + Example: My Workload + enableSovereignControls: + type: boolean + description: >- + Optional. Indicates the sovereignty status of the given workload. + Currently meant to be used by Europe/Canada customers. + labels: + description: Optional. Labels applied to the workload. + type: object + additionalProperties: + type: string + complianceStatus: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus + readOnly: true + description: Output only. Count of active Violations in the Workload. + resourceMonitoringEnabled: + readOnly: true + description: >- + Output only. Indicates whether resource monitoring is enabled for + workload or not. It is true when Resource feed is subscribed to AWM + topic and AWM Service Agent Role is binded to AW Service Account for + resource Assured workload. + type: boolean + partner: type: string + enumDescriptions: + - '' + - Enum representing S3NS (Thales) partner. + - Enum representing T_SYSTEM (TSI) partner. + - Enum representing SIA_MINSAIT (Indra) partner. + - Enum representing PSN (TIM) partner. + - Enum representing CNTXT (Kingdom of Saudi Arabia) partner. + - >- + Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering + without EKM. + enum: + - PARTNER_UNSPECIFIED + - LOCAL_CONTROLS_BY_S3NS + - SOVEREIGN_CONTROLS_BY_T_SYSTEMS + - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT + - SOVEREIGN_CONTROLS_BY_PSN + - SOVEREIGN_CONTROLS_BY_CNTXT + - SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM + description: Optional. Partner regime associated with this workload. + name: description: >- Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. - partnerServicesBillingAccount: type: string + resourceSettings: + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + type: array description: >- - Optional. Billing account necessary for purchasing services from - Sovereign Partners. This field is required for creating - SIA/PSN/CNTXT partner workloads. The caller should have - 'billing.resourceAssociations.create' IAM permission on this - billing-account. The format of this string is - billingAccounts/AAAAAA-BBBBBB-CCCCCC + Input only. Resource properties that are used to customize workload + resources. These properties (such as custom project id) will be used + to create workload resources if possible. This field is optional. + compliantButDisallowedServices: + description: >- + Output only. Urls for services which are compliant for this Assured + Workload, but which are currently disallowed by the + ResourceUsageRestriction org policy. Invoke RestrictAllowedResources + endpoint to allow your project developers to use these services in + their environment. + items: + type: string + type: array + readOnly: true + createTime: + description: Output only. Immutable. The Workload creation timestamp. + type: string + readOnly: true + format: google-datetime + id: GoogleCloudAssuredworkloadsV1Workload description: >- A Workload object for managing highly regulated workloads of cloud customers. type: object - GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: - id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - type: object + GoogleCloudAssuredworkloadsV1ViolationRemediation: description: >- - Represents a logical group of checks performed for an asset. If - successful, the group contains the analysis result, otherwise it - contains an error with the failure reason. - properties: - analysisResult: - description: Result of a successful analysis. - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' - displayName: - type: string - description: Name of the analysis group. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Error details for a failed analysis. - GoogleCloudAssuredworkloadsV1MoveAnalysisResult: - id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult - description: Represents the successful move analysis results for a group. + Represents remediation guidance to resolve compliance violation for + AssuredWorkload properties: - blockers: - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' + compliantValues: description: >- - List of blockers. If not resolved, these will result in compliance - violations in the target. - type: array - warnings: + Values that can resolve the violation For example: for list org + policy violations, this will either be the list of allowed or denied + values + type: array + items: + type: string + remediationType: + enum: + - REMEDIATION_TYPE_UNSPECIFIED + - REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION + - REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION + - REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION + - REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION + - REMEDIATION_RESOURCE_VIOLATION + - REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES + description: >- + Output only. Reemediation type based on the type of org policy + values violated + type: string + enumDescriptions: + - Unspecified remediation type + - Remediation type for boolean org policy + - >- + Remediation type for list org policy which have allowed values in + the monitoring rule + - >- + Remediation type for list org policy which have denied values in + the monitoring rule + - Remediation type for gcp.restrictCmekCryptoKeyProjects + - Remediation type for resource violation. + - >- + Remediation type for resource violation due to + gcp.restrictNonCmekServices + readOnly: true + instructions: + description: Required. Remediation instructions to resolve violations + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions + type: object + id: GoogleCloudAssuredworkloadsV1ViolationRemediation + GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: + id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + type: object + description: Represent the custom settings for the resources to be created. + properties: + displayName: + description: >- + User-assigned resource display name. If not empty it will be used to + create a resource with the specified name. + type: string + resourceId: + description: >- + Resource identifier. For a project this represents project_id. If + the project is already taken, the workload creation will fail. For + KeyRing, this represents the keyring_id. For a folder, don't set + this value as folder_id is assigned by Google. + type: string + resourceType: + description: >- + Indicates the type of resource. This field should be specified to + correspond the id to the right project type (CONSUMER_PROJECT or + ENCRYPTION_KEYS_PROJECT) + type: string + enumDescriptions: + - Unknown resource type. + - >- + Deprecated. Existing workloads will continue to support this, but + new CreateWorkloadRequests should not specify this as an input + value. + - Consumer Folder. + - Consumer project containing encryption keys. + - Keyring resource that hosts encryption keys. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - CONSUMER_PROJECT + - CONSUMER_FOLDER + - ENCRYPTION_KEYS_PROJECT + - KEYRING + enumDeprecated: + - false + - true + - false + - false + - false + GoogleCloudAssuredworkloadsV1MoveAnalysisResult: + id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult + type: object + description: Represents the successful move analysis results for a group. + properties: + blockers: + description: >- + List of blockers. If not resolved, these will result in compliance + violations in the target. items: $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' type: array + warnings: + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' description: >- List of warnings. These are risks that may or may not result in compliance violations. + type: array + GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: type: object - GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: + description: Represent the resources that are children of this Workload. + id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo properties: - asset: + resourceId: + description: Resource identifier. For a project this represents project_number. + type: string + format: int64 + resourceType: + enum: + - RESOURCE_TYPE_UNSPECIFIED + - CONSUMER_PROJECT + - CONSUMER_FOLDER + - ENCRYPTION_KEYS_PROJECT + - KEYRING + enumDeprecated: + - false + - true + - false + - false + - false + enumDescriptions: + - Unknown resource type. + - >- + Deprecated. Existing workloads will continue to support this, but + new CreateWorkloadRequests should not specify this as an input + value. + - Consumer Folder. + - Consumer project containing encryption keys. + - Keyring resource that hosts encryption keys. + type: string + description: Indicates the type of resource. + GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: + properties: + rotationPeriod: description: >- - The full resource name of the asset being analyzed. Example: - //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 + Required. Input only. Immutable. [next_rotation_time] will be + advanced by this period when the Key Management Service + automatically rotates a key. Must be at least 24 hours and at most + 876,000 hours. + format: google-duration type: string - assetType: + nextRotationTime: + type: string + format: google-datetime description: >- - Type of the asset being analyzed. Possible values will be among the - ones listed - [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). + Required. Input only. Immutable. The time at which the Key + Management Service will automatically create a new version of the + crypto key and mark it as the primary. + id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + description: Settings specific to the Key Management Service. + deprecated: true + type: object + GoogleRpcStatus: + type: object + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + properties: + code: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - analysisGroups: + details: items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - description: List of eligible analyses performed for the asset. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + id: GoogleRpcStatus + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: + properties: + additionalLinks: + type: array + items: + type: string + description: Additional urls for more information about steps + consoleUris: + items: + type: string + description: Link to console page where violations can be resolved type: array + steps: + items: + type: string + type: array + description: Steps to resolve violation via cloud console + description: Remediation instructions to resolve violation via cloud console type: object - description: Represents move analysis results for an asset. - id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole + GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: + description: Response for EnableResourceMonitoring endpoint. + properties: {} + id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse + type: object + GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: + description: Signed Access Approvals (SAA) enrollment response. + properties: + setupStatus: + enum: + - SETUP_STATE_UNSPECIFIED + - STATUS_PENDING + - STATUS_COMPLETE + description: Indicates SAA enrollment status of a given workload. + type: string + enumDescriptions: + - Unspecified. + - SAA enrollment pending. + - SAA enrollment comopleted. + setupErrors: + items: + type: string + enumDescriptions: + - Unspecified. + - >- + Invalid states for all customers, to be redirected to AA UI for + additional details. + - Returned when there is not an EKM key configured. + - >- + Returned when there are no enrolled services or the customer is + enrolled in CAA only for a subset of services. + - >- + Returned when exception was encountered during evaluation of + other criteria. + enum: + - SETUP_ERROR_UNSPECIFIED + - ERROR_INVALID_BASE_SETUP + - ERROR_MISSING_EXTERNAL_SIGNING_KEY + - ERROR_NOT_ALL_SERVICES_ENROLLED + - ERROR_SETUP_CHECK_FAILED + type: array + description: Indicates SAA enrollment setup error if any. + type: object + id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + GoogleCloudAssuredworkloadsV1ViolationExceptionContext: + description: Violation exception detail. + type: object + id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext + properties: + comment: + type: string + description: >- + Business justification provided towards the acknowledgement of the + violation. + acknowledgementTime: + type: string + description: Timestamp when the violation was acknowledged. + format: google-datetime + userName: + description: >- + Name of the user (or service account) who acknowledged the + violation. + type: string + GoogleLongrunningOperation: + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + done: + type: boolean + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: + description: Represents the Compliance Status of this workload + type: object + properties: + acknowledgedResourceViolationCount: + type: integer + format: int32 + description: Number of current resource violations which are not acknowledged. + acknowledgedViolationCount: + format: int32 + type: integer + description: Number of current orgPolicy violations which are acknowledged. + activeViolationCount: + format: int32 + type: integer + description: Number of current orgPolicy violations which are not acknowledged. + activeResourceViolationCount: + format: int32 + description: Number of current resource violations which are acknowledged. + type: integer + id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus + GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: + type: object + id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + properties: + analysisResult: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' + description: Result of a successful analysis. + displayName: + type: string + description: Name of the analysis group. + error: + description: Error details for a failed analysis. + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Represents a logical group of checks performed for an asset. If + successful, the group contains the analysis result, otherwise it + contains an error with the failure reason. GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: description: Request for updating permission settings for a partner workload. - id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest - type: object properties: + etag: + description: >- + Optional. The etag of the workload. If this is provided, it must + match the server's etag. + type: string updateMask: type: string description: >- @@ -902,285 +1026,149 @@ components: $ref: >- #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions description: Required. The partner permissions to be updated. - etag: - description: >- - Optional. The etag of the workload. If this is provided, it must - match the server's etag. - type: string - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: - properties: - additionalLinks: - type: array - items: - type: string - description: Additional urls for more information about steps - steps: - type: array - description: Steps to resolve violation via gcloud cli - items: - type: string - gcloudCommands: - description: Gcloud command to resolve violation - type: array - items: - type: string - description: Remediation instructions to resolve violation via gcloud cli type: object - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: + id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: + type: object + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse + description: Response for violation acknowledgement + properties: {} + GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest + description: Request for acknowledging the violation type: object properties: - additionalLinks: - type: array - items: - type: string - description: Additional urls for more information about steps - steps: - items: - type: string - type: array - description: Steps to resolve violation via cloud console - consoleUris: - items: - type: string - type: array - description: Link to console page where violations can be resolved - description: Remediation instructions to resolve violation via cloud console - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - GoogleCloudAssuredworkloadsV1ViolationRemediation: - properties: - instructions: - description: Required. Remediation instructions to resolve violations - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - compliantValues: + comment: description: >- - Values that can resolve the violation For example: for list org - policy violations, this will either be the list of allowed or denied - values - items: - type: string - type: array - remediationType: + Required. Business justification explaining the need for violation + acknowledgement + type: string + acknowledgeType: + description: Optional. Acknowledge type of specified violation. enumDescriptions: - - Unspecified remediation type - - Remediation type for boolean org policy - - >- - Remediation type for list org policy which have allowed values in - the monitoring rule - - >- - Remediation type for list org policy which have denied values in - the monitoring rule - - Remediation type for gcp.restrictCmekCryptoKeyProjects - - Remediation type for resource violation. + - Acknowledge type unspecified. + - Acknowledge only the specific violation. - >- - Remediation type for resource violation due to - gcp.restrictNonCmekServices - readOnly: true + Acknowledge specified orgPolicy violation and also associated + resource violations. + enum: + - ACKNOWLEDGE_TYPE_UNSPECIFIED + - SINGLE_VIOLATION + - EXISTING_CHILD_RESOURCE_VIOLATIONS type: string + nonCompliantOrgPolicy: + deprecated: true description: >- - Output only. Reemediation type based on the type of org policy - values violated - enum: - - REMEDIATION_TYPE_UNSPECIFIED - - REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION - - REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION - - REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION - - REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION - - REMEDIATION_RESOURCE_VIOLATION - - REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES - id: GoogleCloudAssuredworkloadsV1ViolationRemediation - type: object - description: >- - Represents remediation guidance to resolve compliance violation for - AssuredWorkload - GoogleCloudAssuredworkloadsV1MoveImpact: - properties: - detail: - description: Explanation of the impact. + Optional. This field is deprecated and will be removed in future + version of the API. Name of the OrgPolicy which was modified with + non-compliant change and resulted in this violation. Format: + projects/{project_number}/policies/{constraint_name} + folders/{folder_id}/policies/{constraint_name} + organizations/{organization_id}/policies/{constraint_name} type: string - id: GoogleCloudAssuredworkloadsV1MoveImpact - type: object - description: Represents the impact of moving the asset to the target. - GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: type: object - id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo - description: Represent the resources that are children of this Workload. properties: - resourceType: - description: Indicates the type of resource. + restrictionType: + enum: + - RESTRICTION_TYPE_UNSPECIFIED + - ALLOW_ALL_GCP_RESOURCES + - ALLOW_COMPLIANT_RESOURCES + - APPEND_COMPLIANT_RESOURCES type: string + description: >- + Required. The type of restriction for using gcp products in the + Workload environment. enumDescriptions: - - Unknown resource type. + - Unknown restriction type. - >- - Deprecated. Existing workloads will continue to support this, but - new CreateWorkloadRequests should not specify this as an input - value. - - Consumer Folder. - - Consumer project containing encryption keys. - - Keyring resource that hosts encryption keys. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING - enumDeprecated: - - false - - true - - false - - false - - false - resourceId: - format: int64 - type: string - description: Resource identifier. For a project this represents project_number. - GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: - description: Represents the Compliance Status of this workload - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - properties: - activeViolationCount: - description: Number of current orgPolicy violations which are not acknowledged. - format: int32 - type: integer - acknowledgedViolationCount: - type: integer - description: Number of current orgPolicy violations which are acknowledged. - format: int32 - acknowledgedResourceViolationCount: - description: Number of current resource violations which are not acknowledged. - type: integer - format: int32 - activeResourceViolationCount: - type: integer - format: int32 - description: Number of current resource violations which are acknowledged. + Allow the use all of all gcp products, irrespective of the + compliance posture. This effectively removes + gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder. + - >- + Based on Workload's compliance regime, allowed list changes. See - + https://cloud.google.com/assured-workloads/docs/supported-products + for the list of supported resources. + - >- + Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of + compliant resources to the existing list of compliant resources. + Effective org-policy of the Folder is considered to ensure there + is no disruption to the existing customer workflows. + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + description: >- + Request for restricting list of available resources in Workload + environment. GoogleProtobufEmpty: - type: object description: >- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} id: GoogleProtobufEmpty - GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: - type: object - id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse - description: Response of ListWorkloads endpoint. - properties: - workloads: - type: array - description: List of Workloads under a given parent. - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' - nextPageToken: - description: The next page token. Return empty if reached the last page. - type: string - GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: type: object - id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings - deprecated: true - properties: - rotationPeriod: - description: >- - Required. Input only. Immutable. [next_rotation_time] will be - advanced by this period when the Key Management Service - automatically rotates a key. Must be at least 24 hours and at most - 876,000 hours. - format: google-duration - type: string - nextRotationTime: - type: string - description: >- - Required. Input only. Immutable. The time at which the Key - Management Service will automatically create a new version of the - crypto key and mark it as the primary. - format: google-datetime - description: Settings specific to the Key Management Service. - GoogleLongrunningOperation: - id: GoogleLongrunningOperation + properties: {} + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: + properties: {} + type: object + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + description: Response for restricting the list of allowed resources. + GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: + id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions description: >- - This resource represents a long-running operation that is the result of - a network API call. + Permissions granted to the AW Partner SA account for the customer + workload type: object properties: - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - done: + accessTransparencyLogsSupportCaseViewer: + type: boolean + description: Optional. Allow partner to view support case details for an AXT log + dataLogsViewer: + type: boolean description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. + Allow the partner to view inspectability logs and monitoring + violations. + serviceAccessApprover: + description: Optional. Allow partner to view access approval logs. type: boolean - name: + assuredWorkloadsMonitoring: + type: boolean + description: Optional. Allow partner to view violation alerts. + GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: + id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse + properties: + assetMoveAnalyses: + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis + description: List of analysis results for each asset in scope. + type: array + nextPageToken: type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - quotaUser: + description: The next page token. Is empty if the last page is reached. description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + Response containing the analysis results for the hypothetical resource + move. + type: object + parameters: + _.xgafv: + description: V1 error format. in: query - name: quotaUser + name: $.xgafv schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: fields + name: oauth_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: uploadType + name: upload_protocol schema: type: string callback: @@ -1195,12 +1183,28 @@ components: name: prettyPrint schema: type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt schema: type: string + enum: + - json + - media + - proto key: description: >- API key. Your API key identifies your project and provides you with API @@ -1210,53 +1214,49 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' - alt: - description: Data format for response. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: alt + name: uploadType schema: type: string - enum: - - json - - media - - proto x-stackQL-resources: violations: id: google.assuredworkloads.violations name: violations title: Violations methods: - acknowledge: + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}:acknowledge/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + acknowledge: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}:acknowledge/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.violations - get: + list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.violations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/violations/methods/get' @@ -1270,20 +1270,21 @@ components: name: workloads title: Workloads methods: - patch: + create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.workloads delete: operation: $ref: >- @@ -1291,32 +1292,31 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.workloads - restrict_allowed_resources: + mutate_partner_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:restrictAllowedResources/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:mutatePartnerPermissions/patch response: mediaType: application/json openAPIDocKey: '200' - enable_resource_monitoring: + restrict_allowed_resources: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableResourceMonitoring/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:restrictAllowedResources/post response: mediaType: application/json openAPIDocKey: '200' @@ -1327,10 +1327,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - mutate_partner_permissions: + enable_resource_monitoring: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:mutatePartnerPermissions/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableResourceMonitoring/post response: mediaType: application/json openAPIDocKey: '200' @@ -1350,21 +1350,21 @@ components: name: operations title: Operations methods: - list: + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - get: + list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -1374,19 +1374,57 @@ components: replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: parameters: &ref_1 + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' + get: + description: Retrieves Assured Workload Violation based on ID. + operationId: assuredworkloads.organizations.locations.workloads.violations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadsId + required: true + schema: + type: string + - in: path + name: violationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge: + parameters: *ref_1 post: description: >- Acknowledges an existing violation. By acknowledging a violation, users @@ -1474,10 +1512,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: interval.endTime schema: @@ -1497,52 +1531,15 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: - parameters: *ref_1 - get: - description: Retrieves Assured Workload Violation based on ID. - operationId: assuredworkloads.organizations.locations.workloads.violations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: workloadsId - required: true - schema: - type: string - - in: path - name: violationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads: parameters: *ref_1 - patch: - description: >- - Updates an existing workload. Currently allows updating of workload - display_name and labels. For force updates don't set etag field in the - Workload. Only one update operation per workload can be in progress. - operationId: assuredworkloads.organizations.locations.workloads.patch + post: + description: Creates Assured Workload. + operationId: assuredworkloads.organizations.locations.workloads.create requestBody: content: application/json: @@ -1559,7 +1556,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -1571,19 +1568,13 @@ paths: required: true schema: type: string - - in: path - name: workloadsId - required: true - schema: - type: string - in: query - name: updateMask + name: externalId schema: type: string - format: google-fieldmask get: - description: Gets Assured Workload associated with a CRM Node - operationId: assuredworkloads.organizations.locations.workloads.get + description: Lists Assured Workloads under a CRM Node. + operationId: assuredworkloads.organizations.locations.workloads.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1595,7 +1586,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ListWorkloadsResponse parameters: - in: path name: organizationsId @@ -1607,11 +1599,21 @@ paths: required: true schema: type: string - - in: path - name: workloadsId - required: true + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}: + parameters: *ref_1 delete: description: >- Deletes the workload. Make sure that workload's direct children are @@ -1653,11 +1655,12 @@ paths: name: etag schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads: - parameters: *ref_1 - post: - description: Creates Assured Workload. - operationId: assuredworkloads.organizations.locations.workloads.create + patch: + description: >- + Updates an existing workload. Currently allows updating of workload + display_name and labels. For force updates don't set etag field in the + Workload. Only one update operation per workload can be in progress. + operationId: assuredworkloads.organizations.locations.workloads.patch requestBody: content: application/json: @@ -1674,7 +1677,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1686,13 +1689,19 @@ paths: required: true schema: type: string + - in: path + name: workloadsId + required: true + schema: + type: string - in: query - name: externalId + name: updateMask schema: type: string + format: google-fieldmask get: - description: Lists Assured Workloads under a CRM Node. - operationId: assuredworkloads.organizations.locations.workloads.list + description: Gets Assured Workload associated with a CRM Node + operationId: assuredworkloads.organizations.locations.workloads.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1704,8 +1713,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1717,37 +1725,26 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: workloadsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: parameters: *ref_1 - post: + patch: description: >- - Restrict the list of resources allowed in the Workload environment. The - current list of allowed products can be found at - https://cloud.google.com/assured-workloads/docs/supported-products In - addition to assuredworkloads.workload.update permission, the user should - also have orgpolicy.policy.set permission on the folder resource to use - this functionality. + Update the permissions settings for an existing partner workload. For + force updates don't set etag field in the Workload. Only one update + operation per workload can be in progress. operationId: >- - assuredworkloads.organizations.locations.workloads.restrictAllowedResources + assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + #/components/schemas/GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1759,8 +1756,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1777,12 +1773,24 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: parameters: *ref_1 post: - description: Enable resource violation monitoring for a workload. + description: >- + Restrict the list of resources allowed in the Workload environment. The + current list of allowed products can be found at + https://cloud.google.com/assured-workloads/docs/supported-products In + addition to assuredworkloads.workload.update permission, the user should + also have orgpolicy.policy.set permission on the folder resource to use + this functionality. operationId: >- - assuredworkloads.organizations.locations.workloads.enableResourceMonitoring + assuredworkloads.organizations.locations.workloads.restrictAllowedResources + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1795,7 +1803,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse + #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse parameters: - in: path name: organizationsId @@ -1854,33 +1862,24 @@ paths: schema: type: string - in: query - name: project + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - in: query - name: pageSize + name: project schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring: parameters: *ref_1 - patch: - description: >- - Update the permissions settings for an existing partner workload. For - force updates don't set etag field in the Workload. Only one update - operation per workload can be in progress. + post: + description: Enable resource violation monitoring for a workload. operationId: >- - assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + assuredworkloads.organizations.locations.workloads.enableResourceMonitoring security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1892,7 +1891,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse parameters: - in: path name: organizationsId @@ -1909,13 +1909,14 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations: + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: assuredworkloads.organizations.locations.operations.list + 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. + operationId: assuredworkloads.organizations.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1927,7 +1928,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -1939,27 +1940,18 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/operations: parameters: *ref_1 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. - operationId: assuredworkloads.organizations.locations.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: assuredworkloads.organizations.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1971,7 +1963,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: organizationsId @@ -1983,8 +1975,16 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml index 29e5f159..54ca64ac 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml @@ -24,10 +24,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/cloud-billing: View and manage your Google Cloud Platform billing accounts https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. + https://www.googleapis.com/auth/cloud-billing: View and manage your Google Cloud Platform billing accounts Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -37,66 +37,8 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleTypeMoney: - properties: - nanos: - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - format: int32 - type: integer - units: - type: string - format: int64 - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - id: GoogleTypeMoney - type: object - description: Represents an amount of money with its currency type. - GoogleTypeDate: - id: GoogleTypeDate - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - type: object - properties: - year: - format: int32 - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 - type: integer - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - type: integer GoogleCloudBillingBudgetsV1LastPeriodAmount: properties: {} - type: object id: GoogleCloudBillingBudgetsV1LastPeriodAmount description: >- Describes a budget amount targeted to the last Filter.calendar_period @@ -104,60 +46,23 @@ components: calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. - GoogleCloudBillingBudgetsV1BudgetAmount: - id: GoogleCloudBillingBudgetsV1BudgetAmount - description: The budgeted amount for each usage period. type: object + GoogleCloudBillingBudgetsV1CustomPeriod: + id: GoogleCloudBillingBudgetsV1CustomPeriod + type: object + description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). properties: - lastPeriodAmount: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' - description: >- - Use the last period's actual spend as the budget for the present - period. LastPeriodAmount can only be set when the budget's time - period is a Filter.calendar_period. It cannot be set in combination - with Filter.custom_period. - specifiedAmount: + endDate: description: >- - A specified amount to use as the budget. `currency_code` is - optional. If specified when creating a budget, it must match the - currency of the billing account. If specified when updating a - budget, it must match the currency_code of the existing budget. The - `currency_code` is provided on output. - $ref: '#/components/schemas/GoogleTypeMoney' + Optional. The end date of the time period. Budgets with elapsed end + date won't be processed. If unset, specifies to track all usage + incurred since the start_date. + $ref: '#/components/schemas/GoogleTypeDate' + startDate: + $ref: '#/components/schemas/GoogleTypeDate' + description: Required. The start date must be after January 1, 2017. GoogleCloudBillingBudgetsV1NotificationsRule: properties: - enableProjectLevelRecipients: - type: boolean - description: >- - Optional. When set to true, and when the budget has a single project - configured, notifications will be sent to project level recipients - of that project. This field will be ignored if the budget has - multiple or no project configured. Currently, project level - recipients are the users with `Owner` role on a cloud project. - monitoringNotificationChannels: - description: >- - Optional. Email targets to send notifications to when a threshold is - exceeded. This is in addition to the `DefaultIamRecipients` who - receive alert emails based on their billing account IAM role. The - value is the full REST resource name of a Cloud Monitoring email - notification channel with the form - `projects/{project_id}/notificationChannels/{channel_id}`. A maximum - of 5 email notifications are allowed. To customize budget alert - email recipients with monitoring notification channels, you _must - create the monitoring notification channels before you link them to - a budget_. For guidance on setting up notification channels to use - with budgets, see [Customize budget alert email - recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). - For Cloud Billing budget alerts, you _must use email notification - channels_. The other types of notification channels are _not_ - supported, such as Slack, SMS, or PagerDuty. If you want to [send - budget notifications to - Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), - use a pubsubTopic and configure [programmatic - notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). - items: - type: string - type: array schemaVersion: description: >- Optional. Required when NotificationsRule.pubsub_topic is set. The @@ -166,14 +71,16 @@ components: represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. type: string - disableDefaultIamRecipients: - type: boolean + enableProjectLevelRecipients: description: >- - Optional. When set to true, disables default notifications sent when - a threshold is exceeded. Default notifications are sent to those - with Billing Account Administrator and Billing Account User IAM - roles for the target account. + Optional. When set to true, and when the budget has a single project + configured, notifications will be sent to project level recipients + of that project. This field will be ignored if the budget has + multiple or no project configured. Currently, project level + recipients are the users with `Owner` role on a cloud project. + type: boolean pubsubTopic: + type: string description: >- Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form @@ -196,70 +103,121 @@ components: PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - type: string - id: GoogleCloudBillingBudgetsV1NotificationsRule - type: object + disableDefaultIamRecipients: + type: boolean + description: >- + Optional. When set to true, disables default notifications sent when + a threshold is exceeded. Default notifications are sent to those + with Billing Account Administrator and Billing Account User IAM + roles for the target account. + monitoringNotificationChannels: + items: + type: string + type: array + description: >- + Optional. Email targets to send notifications to when a threshold is + exceeded. This is in addition to the `DefaultIamRecipients` who + receive alert emails based on their billing account IAM role. The + value is the full REST resource name of a Cloud Monitoring email + notification channel with the form + `projects/{project_id}/notificationChannels/{channel_id}`. A maximum + of 5 email notifications are allowed. To customize budget alert + email recipients with monitoring notification channels, you _must + create the monitoring notification channels before you link them to + a budget_. For guidance on setting up notification channels to use + with budgets, see [Customize budget alert email + recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). + For Cloud Billing budget alerts, you _must use email notification + channels_. The other types of notification channels are _not_ + supported, such as Slack, SMS, or PagerDuty. If you want to [send + budget notifications to + Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), + use a pubsubTopic and configure [programmatic + notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). description: >- NotificationsRule defines notifications that are sent based on budget spend and thresholds. - GoogleCloudBillingBudgetsV1ListBudgetsResponse: - description: Response for ListBudgets - id: GoogleCloudBillingBudgetsV1ListBudgetsResponse + id: GoogleCloudBillingBudgetsV1NotificationsRule + type: object + GoogleCloudBillingBudgetsV1Budget: + id: GoogleCloudBillingBudgetsV1Budget + description: >- + A budget is a plan that describes what you expect to spend on Cloud + projects, plus the rules to execute as spend is tracked against that + plan, (for example, send an alert when 90% of the target spend is met). + The budget time period is configurable, with options such as month + (default), quarter, year, or custom time period. properties: - budgets: + amount: + description: Required. Budgeted amount. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1BudgetAmount' + etag: + description: >- + Optional. Etag to validate that the object is unchanged for a + read-modify-write operation. An empty etag causes an update to + overwrite other changes. + type: string + budgetFilter: + description: >- + Optional. Filters that define which resources are used to compute + the actual spend against the budget amount, such as projects, + services, and the budget's time period, as well as other filters. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Filter' + notificationsRule: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' + description: >- + Optional. Rules to apply to notifications sent based on budget spend + and thresholds. + thresholdRules: items: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' - description: List of the budgets owned by the requested billing account. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1ThresholdRule' + description: >- + Optional. Rules that trigger alerts (notifications of thresholds + being crossed) when spend exceeds the specified percentages of the + budget. Optional for `pubsubTopic` notifications. Required if using + email notifications. type: array - nextPageToken: + displayName: + description: >- + User data for display name in UI. The name must be less than or + equal to 60 characters. + type: string + ownershipScope: type: string + enum: + - OWNERSHIP_SCOPE_UNSPECIFIED + - ALL_USERS + - BILLING_ACCOUNT + enumDescriptions: + - Unspecified ownership scope, same as ALL_USERS. + - >- + Both billing account-level users and project-level users have full + access to the budget, if the users have the required IAM + permissions. + - >- + Only billing account-level users have full access to the budget. + Project-level users have read-only access, even if they have the + required IAM permissions. + name: + readOnly: true description: >- - If not empty, indicates that there may be more budgets that match - the request; this value should be passed in a new - `ListBudgetsRequest`. + Output only. Resource name of the budget. The resource name implies + the scope of a budget. Values are of the form + `billingAccounts/{billingAccountId}/budgets/{budgetId}`. + type: string type: object GoogleCloudBillingBudgetsV1Filter: - type: object - id: GoogleCloudBillingBudgetsV1Filter properties: - customPeriod: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' + projects: + items: + type: string description: >- - Optional. Specifies to track usage from any start date (required) to - any end date (optional). This time period is static, it does not - recur. - creditTypesTreatment: - enumDescriptions: - - '' - - >- - All types of credit are subtracted from the gross cost to - determine the spend for threshold calculations. - - >- - All types of credit are added to the net cost to determine the - spend for threshold calculations. - - >- - [Credit - types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) - specified in the credit_types field are subtracted from the gross - cost to determine the spend for threshold calculations. - type: string - description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - enum: - - CREDIT_TYPES_TREATMENT_UNSPECIFIED - - INCLUDE_ALL_CREDITS - - EXCLUDE_ALL_CREDITS - - INCLUDE_SPECIFIED_CREDITS - subaccounts: - items: - type: string + Optional. A set of projects of the form `projects/{project}`, + specifying that usage from only this set of projects should be + included in the budget. If omitted, the report includes all usage + for the billing account, regardless of which project the usage + occurred on. type: array - description: >- - Optional. A set of subaccounts of the form - `billingAccounts/{account_id}`, specifying that usage from only this - set of subaccounts should be included in the budget. If a subaccount - is set to the name of the parent account, usage from the parent - account is included. If the field is omitted, the report includes - usage from the parent account and all subaccounts, if they exist. services: items: type: string @@ -271,29 +229,25 @@ components: Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api. type: array - creditTypes: - type: array - description: >- - Optional. If Filter.credit_types_treatment is - INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be - subtracted from gross cost to determine the spend for threshold - calculations. See [a list of acceptable credit type - values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). - If Filter.credit_types_treatment is **not** - INCLUDE_SPECIFIED_CREDITS, this field must be empty. + resourceAncestors: items: type: string - projects: description: >- - Optional. A set of projects of the form `projects/{project}`, - specifying that usage from only this set of projects should be - included in the budget. If omitted, the report includes all usage - for the billing account, regardless of which project the usage - occurred on. + Optional. A set of folder and organization names of the form + `folders/{folderId}` or `organizations/{organizationId}`, specifying + that usage from only this set of folders and organizations should be + included in the budget. If omitted, the budget includes all usage + that the billing account pays for. If the folder or organization + contains projects that are paid for by a different Cloud Billing + account, the budget *doesn't* apply to those projects. type: array - items: - type: string calendarPeriod: + enum: + - CALENDAR_PERIOD_UNSPECIFIED + - MONTH + - QUARTER + - YEAR + type: string enumDescriptions: - >- Calendar period is unset. This is the default if the budget is for @@ -312,12 +266,17 @@ components: month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. - type: string - enum: - - CALENDAR_PERIOD_UNSPECIFIED - - MONTH - - QUARTER - - YEAR + subaccounts: + type: array + description: >- + Optional. A set of subaccounts of the form + `billingAccounts/{account_id}`, specifying that usage from only this + set of subaccounts should be included in the budget. If a subaccount + is set to the name of the parent account, usage from the parent + account is included. If the field is omitted, the report includes + usage from the parent account and all subaccounts, if they exist. + items: + type: string labels: description: >- Optional. A single label and value pair specifying that usage from @@ -328,111 +287,160 @@ components: entry are not allowed._ type: object additionalProperties: - type: array items: type: any - resourceAncestors: + type: array + customPeriod: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' + description: >- + Optional. Specifies to track usage from any start date (required) to + any end date (optional). This time period is static, it does not + recur. + creditTypes: + type: array items: type: string - type: array description: >- - Optional. A set of folder and organization names of the form - `folders/{folderId}` or `organizations/{organizationId}`, specifying - that usage from only this set of folders and organizations should be - included in the budget. If omitted, the budget includes all usage - that the billing account pays for. If the folder or organization - contains projects that are paid for by a different Cloud Billing - account, the budget *doesn't* apply to those projects. - description: A filter for a budget, limiting the scope of the cost to calculate. - GoogleCloudBillingBudgetsV1Budget: - properties: - etag: - type: string - description: >- - Optional. Etag to validate that the object is unchanged for a - read-modify-write operation. An empty etag causes an update to - overwrite other changes. - name: - readOnly: true - description: >- - Output only. Resource name of the budget. The resource name implies - the scope of a budget. Values are of the form - `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - type: string - ownershipScope: - type: string + Optional. If Filter.credit_types_treatment is + INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be + subtracted from gross cost to determine the spend for threshold + calculations. See [a list of acceptable credit type + values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + If Filter.credit_types_treatment is **not** + INCLUDE_SPECIFIED_CREDITS, this field must be empty. + creditTypesTreatment: enum: - - OWNERSHIP_SCOPE_UNSPECIFIED - - ALL_USERS - - BILLING_ACCOUNT + - CREDIT_TYPES_TREATMENT_UNSPECIFIED + - INCLUDE_ALL_CREDITS + - EXCLUDE_ALL_CREDITS + - INCLUDE_SPECIFIED_CREDITS + description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. + type: string enumDescriptions: - - Unspecified ownership scope, same as ALL_USERS. + - '' - >- - Both billing account-level users and project-level users have full - access to the budget, if the users have the required IAM - permissions. + All types of credit are subtracted from the gross cost to + determine the spend for threshold calculations. - >- - Only billing account-level users have full access to the budget. - Project-level users have read-only access, even if they have the - required IAM permissions. - budgetFilter: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Filter' - description: >- - Optional. Filters that define which resources are used to compute - the actual spend against the budget amount, such as projects, - services, and the budget's time period, as well as other filters. - amount: - description: Required. Budgeted amount. - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1BudgetAmount' - notificationsRule: - description: >- - Optional. Rules to apply to notifications sent based on budget spend - and thresholds. - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' - displayName: + All types of credit are added to the net cost to determine the + spend for threshold calculations. + - >- + [Credit + types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) + specified in the credit_types field are subtracted from the gross + cost to determine the spend for threshold calculations. + id: GoogleCloudBillingBudgetsV1Filter + type: object + description: A filter for a budget, limiting the scope of the cost to calculate. + GoogleCloudBillingBudgetsV1ListBudgetsResponse: + properties: + nextPageToken: description: >- - User data for display name in UI. The name must be less than or - equal to 60 characters. + If not empty, indicates that there may be more budgets that match + the request; this value should be passed in a new + `ListBudgetsRequest`. type: string - thresholdRules: - description: >- - Optional. Rules that trigger alerts (notifications of thresholds - being crossed) when spend exceeds the specified percentages of the - budget. Optional for `pubsubTopic` notifications. Required if using - email notifications. + budgets: + description: List of the budgets owned by the requested billing account. items: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1ThresholdRule' + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' type: array - id: GoogleCloudBillingBudgetsV1Budget + description: Response for ListBudgets type: object + id: GoogleCloudBillingBudgetsV1ListBudgetsResponse + GoogleTypeDate: + properties: + year: + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + day: + format: int32 + type: integer + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. description: >- - A budget is a plan that describes what you expect to spend on Cloud - projects, plus the rules to execute as spend is tracked against that - plan, (for example, send an alert when 90% of the target spend is met). - The budget time period is configurable, with options such as month - (default), quarter, year, or custom time period. - GoogleCloudBillingBudgetsV1ThresholdRule: + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + id: GoogleTypeDate + GoogleProtobufEmpty: description: >- - ThresholdRule contains the definition of a threshold. Threshold rules - define the triggering events used to generate a budget notification - email. When a threshold is crossed (spend exceeds the specified - percentages of the budget), budget alert emails are sent to the email - recipients you specify in the [NotificationsRule](#notificationsrule). - Threshold rules also affect the fields included in the [JSON data - object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) - sent to a Pub/Sub topic. Threshold rules are _required_ if using email - notifications. Threshold rules are _optional_ if only setting a - [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want - your JSON data object to include data about the thresholds you set. For - more information, see [set budget threshold rules and - actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). - id: GoogleCloudBillingBudgetsV1ThresholdRule + 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: GoogleProtobufEmpty + type: object + properties: {} + GoogleTypeMoney: + type: object + properties: + nanos: + type: integer + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + format: int32 + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + units: + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + format: int64 + type: string + description: Represents an amount of money with its currency type. + id: GoogleTypeMoney + GoogleCloudBillingBudgetsV1BudgetAmount: + type: object + properties: + specifiedAmount: + description: >- + A specified amount to use as the budget. `currency_code` is + optional. If specified when creating a budget, it must match the + currency of the billing account. If specified when updating a + budget, it must match the currency_code of the existing budget. The + `currency_code` is provided on output. + $ref: '#/components/schemas/GoogleTypeMoney' + lastPeriodAmount: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' + description: >- + Use the last period's actual spend as the budget for the present + period. LastPeriodAmount can only be set when the budget's time + period is a Filter.calendar_period. It cannot be set in combination + with Filter.custom_period. + id: GoogleCloudBillingBudgetsV1BudgetAmount + description: The budgeted amount for each usage period. + GoogleCloudBillingBudgetsV1ThresholdRule: properties: thresholdPercent: + type: number description: >- Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. - type: number format: double spendBasis: enum: @@ -445,49 +453,37 @@ components: Use current spend as the basis for comparison against the threshold. - >- - Use forecasted spend for the period as the basis for comparison - against the threshold. FORECASTED_SPEND can only be set when the - budget's time period is a Filter.calendar_period. It cannot be set - in combination with Filter.custom_period. - description: >- - Optional. The type of basis used to determine if spend has passed - the threshold. Behavior defaults to CURRENT_SPEND if not set. - type: string - type: object - GoogleCloudBillingBudgetsV1CustomPeriod: - description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). - type: object - properties: - endDate: + Use forecasted spend for the period as the basis for comparison + against the threshold. FORECASTED_SPEND can only be set when the + budget's time period is a Filter.calendar_period. It cannot be set + in combination with Filter.custom_period. + type: string description: >- - Optional. The end date of the time period. Budgets with elapsed end - date won't be processed. If unset, specifies to track all usage - incurred since the start_date. - $ref: '#/components/schemas/GoogleTypeDate' - startDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: Required. The start date must be after January 1, 2017. - id: GoogleCloudBillingBudgetsV1CustomPeriod - GoogleProtobufEmpty: - type: object - properties: {} + Optional. The type of basis used to determine if spend has passed + the threshold. Behavior defaults to CURRENT_SPEND if not set. 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: GoogleProtobufEmpty + ThresholdRule contains the definition of a threshold. Threshold rules + define the triggering events used to generate a budget notification + email. When a threshold is crossed (spend exceeds the specified + percentages of the budget), budget alert emails are sent to the email + recipients you specify in the [NotificationsRule](#notificationsrule). + Threshold rules also affect the fields included in the [JSON data + object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) + sent to a Pub/Sub topic. Threshold rules are _required_ if using email + notifications. Threshold rules are _optional_ if only setting a + [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want + your JSON data object to include data about the thresholds you set. For + more information, see [set budget threshold rules and + actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). + id: GoogleCloudBillingBudgetsV1ThresholdRule + type: object parameters: - alt: - description: Data format for response. + callback: + description: JSONP in: query - name: alt + name: callback schema: type: string - enum: - - json - - media - - proto _.xgafv: description: V1 error format. in: query @@ -497,27 +493,6 @@ components: enum: - '1' - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string oauth_token: description: OAuth 2.0 token for the current user. in: query @@ -530,18 +505,12 @@ components: name: uploadType schema: type: string - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -551,10 +520,41 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: access_token + name: prettyPrint + schema: + type: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser schema: type: string x-stackQL-resources: @@ -563,17 +563,16 @@ components: name: budgets title: Budgets methods: - get: + list: operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get + $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/get' response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.budgets + create: operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/delete + $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/post' response: mediaType: application/json openAPIDocKey: '200' @@ -584,16 +583,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: - $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/get' + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.budgets - create: + get: operation: - $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/post' + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -609,26 +609,26 @@ components: delete: - $ref: '#/components/x-stackQL-resources/budgets/methods/delete' paths: - /v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}: + /v1/billingAccounts/{billingAccountsId}/budgets: parameters: &ref_1 - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' get: description: >- - Returns a budget. WARNING: There are some fields exposed on the Google - Cloud Console that aren't available on this API. When reading from the - API, you will not see these fields in the return value, though they may - have been set in the Cloud Console. - operationId: billingbudgets.billingAccounts.budgets.get + Returns a list of budgets for a billing account. WARNING: There are some + fields exposed on the Google Cloud Console that aren't available on this + API. When reading from the API, you will not see these fields in the + return value, though they may have been set in the Cloud Console. + operationId: billingbudgets.billingAccounts.budgets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -644,21 +644,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + $ref: >- + #/components/schemas/GoogleCloudBillingBudgetsV1ListBudgetsResponse parameters: - in: path name: billingAccountsId required: true schema: type: string - - in: path - name: budgetsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a budget. Returns successfully if already deleted. - operationId: billingbudgets.billingAccounts.budgets.delete + - in: query + name: scope + schema: + type: string + post: + description: >- + Creates a new budget. See [Quotas and + limits](https://cloud.google.com/billing/quotas) for more information on + the limits of the number of budgets you can create. + operationId: billingbudgets.billingAccounts.budgets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -674,18 +691,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' parameters: - in: path name: billingAccountsId required: true schema: type: string - - in: path - name: budgetsId - required: true - schema: - type: string + /v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}: + parameters: *ref_1 patch: description: >- Updates a budget and returns the updated budget. WARNING: There are some @@ -730,15 +744,9 @@ paths: schema: type: string format: google-fieldmask - /v1/billingAccounts/{billingAccountsId}/budgets: - parameters: *ref_1 - get: - description: >- - Returns a list of budgets for a billing account. WARNING: There are some - fields exposed on the Google Cloud Console that aren't available on this - API. When reading from the API, you will not see these fields in the - return value, though they may have been set in the Cloud Console. - operationId: billingbudgets.billingAccounts.budgets.list + delete: + description: Deletes a budget. Returns successfully if already deleted. + operationId: billingbudgets.billingAccounts.budgets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -754,38 +762,25 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudBillingBudgetsV1ListBudgetsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: billingAccountsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: scope - schema: - type: string - - in: query - name: pageToken + - in: path + name: budgetsId + required: true schema: type: string - post: + get: description: >- - Creates a new budget. See [Quotas and - limits](https://cloud.google.com/billing/quotas) for more information on - the limits of the number of budgets you can create. - operationId: billingbudgets.billingAccounts.budgets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + Returns a budget. WARNING: There are some fields exposed on the Google + Cloud Console that aren't available on this API. When reading from the + API, you will not see these fields in the return value, though they may + have been set in the Cloud Console. + operationId: billingbudgets.billingAccounts.budgets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -808,3 +803,8 @@ paths: required: true schema: type: string + - in: path + name: budgetsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml index 38ca8fcb..a2e20f00 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml @@ -34,1641 +34,1566 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SecretVolumeSource: + OAuthCredential: type: object - description: Secret Volume Source. + description: >- + Represents an OAuth token of the account that authorized the Connection, + and associated metadata. + id: OAuthCredential properties: - secretVersion: - type: string + oauthTokenSecretVersion: description: >- - Optional. Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* - secretName: + Optional. A SecretManager resource containing the OAuth token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. type: string - description: Name of the secret referenced by the WorkspaceBinding. - id: SecretVolumeSource - Worker: - id: Worker - properties: - machineType: - description: Optional. Machine type of a worker, default is "e2-standard-2". + username: + description: Output only. The username associated to this token. type: string - description: Configuration for the worker. - type: object - PipelineTask: + readOnly: true + HttpBody: + id: HttpBody properties: - params: - items: - $ref: '#/components/schemas/Param' - type: array - description: Params is a list of parameter names and values. - timeout: + contentType: description: >- - Time after which the TaskRun times out. Defaults to 1 hour. - Specified TaskRun timeout should be less than 24h. - format: google-duration - type: string - name: + The HTTP Content-Type header value specifying the content type of + the body. type: string - description: Name of the task. - runAfter: - type: array - description: >- - RunAfter is the list of PipelineTask names that should be executed - before this Task executes. (Used to force a specific ordering in - graph execution.) - items: - type: string - workspaces: - items: - $ref: '#/components/schemas/WorkspacePipelineTaskBinding' + extensions: description: >- - Workspaces maps workspaces from the pipeline spec to the workspaces - declared in the Task. - type: array - whenExpressions: - description: Conditions that need to be true for the task to run. + Application specific response metadata. Must be set in the first + response for streaming APIs. type: array items: - $ref: '#/components/schemas/WhenExpression' - taskSpec: - $ref: '#/components/schemas/EmbeddedTask' - description: Spec to instantiate this TaskRun. - taskRef: - description: Reference to a specific instance of a task. - $ref: '#/components/schemas/TaskRef' - retries: - format: int32 - description: >- - Retries represents how many times this task should be retried in - case of task failure. - type: integer + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + data: + type: string + description: The HTTP request/response body as raw binary. + format: byte + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. type: object - id: PipelineTask - description: PipelineTask defines a task in a Pipeline. - CancelOperationRequest: - properties: {} - description: The request message for Operations.CancelOperation. - id: CancelOperationRequest + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. type: object - OperationMetadata: + properties: + 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). + type: array + items: + type: string + FetchReadWriteTokenResponse: + description: Message for responding to get read/write token. type: object - id: OperationMetadata properties: - statusDetail: - readOnly: true - type: string - description: Output only. Human-readable status of the operation, if any. - verb: - description: Output only. Name of the verb executed by the operation. - type: string - readOnly: true - endTime: - readOnly: true - description: Output only. The time the operation finished running. - type: string - format: google-datetime - createTime: - description: Output only. The time the operation was created. + expirationTime: + description: Expiration timestamp. Can be empty if unknown or non-expiring. type: string format: google-datetime - readOnly: true - apiVersion: - readOnly: true - description: Output only. API version used to start the operation. + token: + description: The token content. type: string - cancelRequested: + id: FetchReadWriteTokenResponse + ChildStatusReference: + properties: + whenExpressions: + type: array description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - type: boolean - readOnly: true - target: + WhenExpressions is the list of checks guarding the execution of the + PipelineTask + items: + $ref: '#/components/schemas/WhenExpression' + pipelineTaskName: description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true + PipelineTaskName is the name of the PipelineTask this is + referencing. type: string - description: Represents the metadata of the long-running operation. - Param: + name: + description: Name is the name of the TaskRun or Run this is referencing. + type: string + type: + type: string + enum: + - TYPE_UNSPECIFIED + - TASK_RUN + readOnly: true + description: Output only. Type of the child reference. + enumDescriptions: + - Default enum type; should not be used. + - TaskRun. + id: ChildStatusReference + type: object + description: >- + ChildStatusReference is used to point to the statuses of individual + TaskRuns and Runs within this PipelineRun. + WorkspaceBinding: + id: WorkspaceBinding properties: - value: - $ref: '#/components/schemas/ParamValue' - description: Value of the parameter. name: type: string - description: Name of the parameter. + description: Name of the workspace. + subPath: + type: string + description: >- + Optional. SubPath is optionally a directory on the volume which + should be used for this binding (i.e. the volume will be mounted at + this sub directory). +optional + secret: + $ref: '#/components/schemas/SecretVolumeSource' + description: Secret Volume Source. type: object - id: Param description: >- - Param defined with name and value. PipelineRef can be used to refer to a - specific instance of a Pipeline. - GoogleDevtoolsCloudbuildV2OperationMetadata: + WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used + to refer to a specific instance of a Pipeline. + FetchReadTokenRequest: + description: Message for fetching SCM read token. + properties: {} type: object - description: Represents the metadata of the long-running operation. - id: GoogleDevtoolsCloudbuildV2OperationMetadata + id: FetchReadTokenRequest + BitbucketDataCenterConfig: + type: object + id: BitbucketDataCenterConfig + description: Configuration for connections to Bitbucket Data Center. properties: - target: + serviceDirectoryConfig: description: >- - Output only. Server-defined resource path for the target of the - operation. + Optional. Configuration for using Service Directory to privately + connect to a Bitbucket Data Center. This should only be set if the + Bitbucket Data Center is hosted on-premises and not reachable by + public internet. If this field is left empty, calls to the Bitbucket + Data Center will be made over the public internet. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + readAuthorizerCredential: + $ref: '#/components/schemas/UserCredential' + description: Required. A http access token with the `REPO_READ` access. + hostUri: + description: >- + Required. The URI of the Bitbucket Data Center instance or cluster + this connection is for. type: string - readOnly: true - apiVersion: - readOnly: true + webhookSecretSecretVersion: type: string - description: Output only. API version used to start the operation. - requestedCancellation: - readOnly: true - type: boolean description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - endTime: - format: google-datetime - readOnly: true - description: Output only. The time the operation finished running. - type: string - statusMessage: + Required. Immutable. SecretManager resource containing the webhook + secret used to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. + authorizerCredential: + description: Required. A http access token with the `REPO_ADMIN` scope access. + $ref: '#/components/schemas/UserCredential' + serverVersion: readOnly: true - description: Output only. Human-readable status of the operation, if any. - type: string - verb: - description: Output only. Name of the verb executed by the operation. type: string - readOnly: true - createTime: - readOnly: true + description: >- + Output only. Version of the Bitbucket Data Center running on the + `host_uri`. + sslCa: + description: >- + Optional. SSL certificate to use for requests to the Bitbucket Data + Center. type: string - format: google-datetime - description: Output only. The time the operation was created. - ExecAction: - id: ExecAction - description: ExecAction describes a "run in container" action. - type: object + ResultValue: + description: ResultValue holds different types of data for a single result. properties: - command: - type: array + arrayVal: items: type: string - description: >- - Optional. Command is the command line to execute inside the - container, the working directory for the command is root ('/') in - the container's filesystem. The command is simply exec'd, it is not - run inside a shell, so traditional shell instructions ('|', etc) - won't work. To use a shell, you need to explicitly call out to that - shell. Exit status of 0 is treated as live/healthy and non-zero is - unhealthy. +optional - AuditConfig: - type: object - id: AuditConfig - properties: - auditLogConfigs: + description: Value of the result if type is array. type: array - description: The configuration for logging of each type of permission. - items: - $ref: '#/components/schemas/AuditLogConfig' - service: - description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. + stringVal: type: string - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - Connection: - description: >- - A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data - Center, Bitbucket Cloud or GitLab. - id: Connection - properties: - gitlabConfig: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' - description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. - githubConfig: - $ref: '#/components/schemas/GitHubConfig' - description: Configuration for connections to github.com. - bitbucketCloudConfig: - description: Configuration for connections to Bitbucket Cloud. - $ref: '#/components/schemas/BitbucketCloudConfig' - annotations: - description: Optional. Allows clients to store small amounts of arbitrary data. + description: Value of the result if type is string. + objectVal: type: object + description: Value of the result if type is object. additionalProperties: type: string - installationState: - readOnly: true - $ref: '#/components/schemas/InstallationState' - description: Output only. Installation state of the Connection. - createTime: - readOnly: true - format: google-datetime - type: string - description: >- - Output only. Server assigned timestamp for when the connection was - created. - githubEnterpriseConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - description: Configuration for connections to an instance of GitHub Enterprise. - etag: - description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. - type: string - disabled: - description: >- - Optional. If disabled is set to true, functionality is disabled for - this connection. Repository based API methods and webhooks - processing for repositories in this connection will be disabled. - type: boolean - updateTime: - description: >- - Output only. Server assigned timestamp for when the connection was - updated. - readOnly: true + type: + description: Output only. The type of data that the result holds. type: string - format: google-datetime - reconciling: readOnly: true - type: boolean - description: >- - Output only. Set to true when the connection is being set up or - updated in the background. - bitbucketDataCenterConfig: - description: Configuration for connections to Bitbucket Data Center. - $ref: '#/components/schemas/BitbucketDataCenterConfig' - name: - description: >- - Immutable. The resource name of the connection, in the format - `projects/{project}/locations/{location}/connections/{connection_id}`. - type: string - type: object - EmbeddedTask: + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + id: ResultValue type: object - id: EmbeddedTask - description: EmbeddedTask defines a Task that is embedded in a Pipeline. - properties: - taskSpec: - description: Spec to instantiate this TaskRun. - $ref: '#/components/schemas/TaskSpec' - annotations: - type: object - additionalProperties: - type: string - description: User annotations. See https://google.aip.dev/128#annotations - WorkspacePipelineTaskBinding: - description: >- - WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to - the workspaces declared in the Task. - id: WorkspacePipelineTaskBinding + ParamSpec: properties: name: type: string - description: Name of the workspace as declared by the task. - workspace: - description: Name of the workspace declared by the pipeline. - type: string - subPath: - type: string - description: >- - Optional. SubPath is optionally a directory on the volume which - should be used for this binding (i.e. the volume will be mounted at - this sub directory). +optional - type: object - GoogleDevtoolsCloudbuildV2Condition: - properties: - severity: - type: string + description: Name of the ParamSpec + default: + $ref: '#/components/schemas/ParamValue' + description: The default value a parameter takes if no input value is supplied + type: enumDescriptions: - Default enum type; should not be used. - - Severity is warning. - - Severity is informational only. - description: Severity with which to treat failures of this type of condition. - enum: - - SEVERITY_UNSPECIFIED - - WARNING - - INFO - lastTransitionTime: - description: >- - LastTransitionTime is the last time the condition transitioned from - one status to another. - type: string - format: google-datetime - message: - description: A human readable message indicating details about the transition. - type: string - reason: + - Default + - Array type. + - Object type. type: string - description: The reason for the condition's last transition. - status: - description: Status of the condition. enum: - - UNKNOWN - - 'TRUE' - - 'FALSE' - type: string - enumDescriptions: - - Default enum type indicating execution is still ongoing. - - Success - - Failure - type: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + description: Type of ParamSpec + description: + description: Description of the ParamSpec type: string - description: Type of condition. + description: >- + ParamSpec defines parameters needed beyond typed inputs (such as + resources). Parameter values are provided by users as inputs on a + TaskRun or PipelineRun. type: object - description: Conditions defines a readiness condition for a Knative resource. - id: GoogleDevtoolsCloudbuildV2Condition - InstallationState: + id: ParamSpec + Worker: type: object - id: InstallationState - description: >- - Describes stage and necessary actions to be taken by the user to - complete the installation. Used for GitHub and GitHub Enterprise based - connections. + id: Worker + description: Configuration for the worker. properties: - actionUri: + machineType: + description: Optional. Machine type of a worker, default is "e2-standard-2". + type: string + TaskRef: + properties: + params: + type: array + items: + $ref: '#/components/schemas/Param' description: >- - Output only. Link to follow for next action. Empty string if the - installation is already complete. - readOnly: true + Params contains the parameters used to identify the referenced + Tekton resource. Example entries might include "repo" or "path" but + the set of params ultimately depends on the chosen resolver. + name: + description: Optional. Name of the task. type: string - stage: - readOnly: true + resolver: enumDescriptions: - - No stage specified. + - Default enum type; should not be used. - >- - Only for GitHub Enterprise. An App creation has been requested. - The user needs to confirm the creation in their GitHub enterprise - host. - - User needs to authorize the GitHub (or Enterprise) App via OAuth. + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. - >- - User needs to follow the link to install the GitHub (or - Enterprise) App. - - Installation process has been completed. - type: string - description: Output only. Current step of the installation process. - enum: - - STAGE_UNSPECIFIED - - PENDING_CREATE_APP - - PENDING_USER_OAUTH - - PENDING_INSTALL_APP - - COMPLETE - message: - type: string + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. description: >- - Output only. Message of what the user should do next to continue the - installation. Empty string if the installation is already complete. - readOnly: true - TaskResult: - description: TaskResult is used to describe the results of a task. - properties: - type: - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - type: string - description: The type of data that the result holds. + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - name: - type: string - description: Name of the result. - description: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT type: string - description: Description of the result. - value: - description: >- - Optional. Optionally used to initialize a Task's result with a - Step's result. - $ref: '#/components/schemas/ParamValue' - properties: - description: >- - When type is OBJECT, this map holds the names of fields inside that - object along with the type of data each field holds. - additionalProperties: - $ref: '#/components/schemas/PropertySpec' - type: object - type: object - id: TaskResult - WorkspaceBinding: + id: TaskRef type: object description: >- - WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used - to refer to a specific instance of a Pipeline. - id: WorkspaceBinding + TaskRef can be used to refer to a specific instance of a task. + PipelineRef can be used to refer to a specific instance of a Pipeline. + StepTemplate: + description: >- + StepTemplate can be used as the basis for all step containers within the + Task, so that the steps inherit settings on the base container. properties: - secret: - description: Secret Volume Source. - $ref: '#/components/schemas/SecretVolumeSource' - name: - type: string - description: Name of the workspace. - subPath: - type: string + volumeMounts: + items: + $ref: '#/components/schemas/VolumeMount' + type: array + description: Optional. Pod volumes to mount into the container's filesystem. + env: + items: + $ref: '#/components/schemas/EnvVar' description: >- - Optional. SubPath is optionally a directory on the volume which - should be used for this binding (i.e. the volume will be mounted at - this sub directory). +optional - EmptyDirVolumeSource: + Optional. List of environment variables to set in the Step. Cannot + be updated. + type: array + id: StepTemplate type: object - description: Represents an empty Volume source. - properties: {} - id: EmptyDirVolumeSource - ListLocationsResponse: + BatchCreateRepositoriesResponse: + description: Message for response of creating repositories in batch. type: object - id: ListLocationsResponse - description: The response message for Locations.ListLocations. + id: BatchCreateRepositoriesResponse properties: - nextPageToken: - type: string - description: The standard List next-page token. - locations: + repositories: + items: + $ref: '#/components/schemas/Repository' type: array + description: Repository resources created. + PipelineTask: + properties: + workspaces: description: >- - A list of locations that matches the specified filter in the - request. + Workspaces maps workspaces from the pipeline spec to the workspaces + declared in the Task. items: - $ref: '#/components/schemas/Location' - Location: - properties: + $ref: '#/components/schemas/WorkspacePipelineTaskBinding' + type: array name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - displayName: + description: Name of the task. + runAfter: description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - labels: - type: object - additionalProperties: + RunAfter is the list of PipelineTask names that should be executed + before this Task executes. (Used to force a specific ordering in + graph execution.) + items: type: string - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - locationId: + type: array + whenExpressions: + items: + $ref: '#/components/schemas/WhenExpression' + description: Conditions that need to be true for the task to run. + type: array + taskRef: + description: Reference to a specific instance of a task. + $ref: '#/components/schemas/TaskRef' + timeout: type: string - description: 'The canonical id for this location. For example: `"us-east1"`.' - description: A resource that represents a Google Cloud location. + description: >- + Time after which the TaskRun times out. Defaults to 1 hour. + Specified TaskRun timeout should be less than 24h. + format: google-duration + params: + items: + $ref: '#/components/schemas/Param' + type: array + description: Params is a list of parameter names and values. + taskSpec: + description: Spec to instantiate this TaskRun. + $ref: '#/components/schemas/EmbeddedTask' + retries: + format: int32 + description: >- + Retries represents how many times this task should be retried in + case of task failure. + type: integer + description: PipelineTask defines a task in a Pipeline. type: object - id: Location - GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: + id: PipelineTask + BitbucketCloudConfig: + id: BitbucketCloudConfig + type: object + description: Configuration for connections to Bitbucket Cloud. properties: webhookSecretSecretVersion: type: string description: >- - Optional. SecretManager resource containing the webhook secret of - the GitHub App, formatted as `projects/*/secrets/*/versions/*`. - serverVersion: - type: string - readOnly: true - description: Output only. GitHub Enterprise version installed at the host_uri. - sslCa: - description: Optional. SSL certificate to use for requests to GitHub Enterprise. + Required. SecretManager resource containing the webhook secret used + to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. + workspace: type: string - serviceDirectoryConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig description: >- - Optional. Configuration for using Service Directory to privately - connect to a GitHub Enterprise server. This should only be set if - the GitHub Enterprise server is hosted on-premises and not reachable - by public internet. If this field is left empty, calls to the GitHub - Enterprise server will be made over the public internet. - appId: - description: Optional. Id of the GitHub App created from the manifest. - type: string - format: int64 - appSlug: - type: string - description: Optional. The URL-friendly name of the GitHub App. - hostUri: + Required. The Bitbucket Cloud Workspace ID to be connected to Google + Cloud Platform. + readAuthorizerCredential: + $ref: '#/components/schemas/UserCredential' description: >- - Required. The URI of the GitHub Enterprise host this connection is - for. - type: string - apiKey: - description: Required. API Key used for authentication of webhook events. - type: string - privateKeySecretVersion: - type: string + Required. An access token with the `repository` access. It can be + either a workspace, project or repository access token. It's + recommended to use a system account to generate the credentials. + authorizerCredential: description: >- - Optional. SecretManager resource containing the private key of the - GitHub App, formatted as `projects/*/secrets/*/versions/*`. - appInstallationId: - type: string - description: Optional. ID of the installation of the GitHub App. - format: int64 - id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - description: Configuration for connections to an instance of GitHub Enterprise. - type: object - PropertySpec: + Required. An access token with the `webhook`, `repository`, + `repository:admin` and `pullrequest` scope access. It can be either + a workspace, project or repository access token. It's recommended to + use a system account to generate these credentials. + $ref: '#/components/schemas/UserCredential' + Provenance: + description: Provenance configuration. properties: - type: - enum: - - TYPE_UNSPECIFIED - - STRING - description: A type for the object. + enabled: type: string + enum: + - ENABLED_UNSPECIFIED + - REQUIRED + - OPTIMISTIC + - DISABLED + description: Optional. Provenance push mode. enumDescriptions: - - Default enum type; should not be used. - - Default - type: object - id: PropertySpec - description: PropertySpec holds information about a property in an object. - FetchReadTokenRequest: - id: FetchReadTokenRequest - type: object - properties: {} - description: Message for fetching SCM read token. - TimeoutFields: - id: TimeoutFields - properties: - finally: - description: Finally sets the maximum allowed duration of this pipeline's finally - type: string - format: google-duration - tasks: - format: google-duration + - Default to disabled (before AA regionalization), optimistic after + - Provenance failures would fail the run + - >- + GCB will attempt to push to artifact analaysis and build state + would not be impacted by the push failures. + - Disable the provenance push entirely. + storage: type: string - description: Tasks sets the maximum allowed duration of this pipeline's tasks - pipeline: - description: >- - Pipeline sets the maximum allowed duration for execution of the - entire pipeline. The sum of individual timeouts for tasks and - finally must not exceed this value. - format: google-duration + description: Optional. Where provenance is stored. + enum: + - STORAGE_UNSPECIFIED + - PREFER_ARTIFACT_PROJECT + - ARTIFACT_PROJECT_ONLY + - BUILD_PROJECT_ONLY + enumDescriptions: + - Default PREFER_ARTIFACT_PROJECT. + - >- + GCB will attempt to push provenance to the artifact project. If it + is not available, fallback to build project. + - Only push to artifact project. + - Only push to build project. + region: type: string + enum: + - REGION_UNSPECIFIED + - GLOBAL + enumDescriptions: + - >- + The PipelineRun/TaskRun/Workflow will be rejected. Update this + comment to push to the same region as the run in Artifact Analysis + when it's regionalized. + - Push provenance to Artifact Analysis in global region. + description: Optional. Provenance region. type: object - description: >- - TimeoutFields allows granular specification of pipeline, task, and - finally timeouts - FetchGitRefsResponse: - type: object - id: FetchGitRefsResponse - description: Response for fetching git refs - properties: - refNames: - items: - type: string - type: array - description: Name of the refs fetched. - nextPageToken: - type: string - description: A token identifying a page of results the server should return. - PipelineWorkspaceDeclaration: + id: Provenance + Connection: type: object - id: PipelineWorkspaceDeclaration properties: - description: - type: string - description: >- - Description is a human readable string describing how the workspace - will be used in the Pipeline. - name: - description: Name is the name of a workspace to be provided by a PipelineRun. - type: string - optional: + githubEnterpriseConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + description: Configuration for connections to an instance of GitHub Enterprise. + updateTime: description: >- - Optional marks a Workspace as not being required in PipelineRuns. By - default this field is false and so declared workspaces are required. - type: boolean - description: >- - Workspaces declares a set of named workspaces that are expected to be - provided by a PipelineRun. - Repository: - type: object - id: Repository - description: A repository associated to a parent connection. - properties: - webhookId: - description: Output only. External ID of the webhook created for the repository. + Output only. Server assigned timestamp for when the connection was + updated. + format: google-datetime readOnly: true type: string + bitbucketDataCenterConfig: + $ref: '#/components/schemas/BitbucketDataCenterConfig' + description: Configuration for connections to Bitbucket Data Center. + bitbucketCloudConfig: + $ref: '#/components/schemas/BitbucketCloudConfig' + description: Configuration for connections to Bitbucket Cloud. annotations: type: object description: Optional. Allows clients to store small amounts of arbitrary data. additionalProperties: type: string - updateTime: - description: >- - Output only. Server assigned timestamp for when the connection was - updated. - format: google-datetime - readOnly: true - type: string - remoteUri: - type: string - description: Required. Git Clone HTTPS URI. etag: - type: string description: >- This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + type: string + githubConfig: + description: Configuration for connections to github.com. + $ref: '#/components/schemas/GitHubConfig' + disabled: + description: >- + Optional. If disabled is set to true, functionality is disabled for + this connection. Repository based API methods and webhooks + processing for repositories in this connection will be disabled. + type: boolean + installationState: + description: Output only. Installation state of the Connection. + readOnly: true + $ref: '#/components/schemas/InstallationState' name: description: >- - Immutable. Resource name of the repository, in the format - `projects/*/locations/*/connections/*/repositories/*`. + Immutable. The resource name of the connection, in the format + `projects/{project}/locations/{location}/connections/{connection_id}`. type: string + reconciling: + type: boolean + description: >- + Output only. Set to true when the connection is being set up or + updated in the background. + readOnly: true createTime: - format: google-datetime + type: string description: >- Output only. Server assigned timestamp for when the connection was created. - type: string readOnly: true - AuditLogConfig: - type: object + format: google-datetime + gitlabConfig: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' + description: >- + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - id: AuditLogConfig + A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data + Center, Bitbucket Cloud or GitLab. + id: Connection + Operation: + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + id: Operation properties: - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - items: - type: string - type: array - logType: - description: The log type that this config enables. - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ + name: type: string - ChildStatusReference: - properties: - whenExpressions: - items: - $ref: '#/components/schemas/WhenExpression' description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask - type: array - pipelineTaskName: - type: string + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + done: description: >- - PipelineTaskName is the name of the PipelineTask this is - referencing. - type: - description: Output only. Type of the child reference. - enumDescriptions: - - Default enum type; should not be used. - - TaskRun. - type: string - enum: - - TYPE_UNSPECIFIED - - TASK_RUN - readOnly: true - name: - type: string - description: Name is the name of the TaskRun or Run this is referencing. - description: >- - ChildStatusReference is used to point to the statuses of individual - TaskRuns and Runs within this PipelineRun. - id: ChildStatusReference - type: object - BatchCreateRepositoriesRequest: - id: BatchCreateRepositoriesRequest - properties: - requests: - type: array + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - Required. The request messages specifying the repositories to - create. - items: - $ref: '#/components/schemas/CreateRepositoryRequest' - description: Message for creating repositoritories in batch. + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + metadata: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + error: + $ref: '#/components/schemas/Status' + description: >- + The error result of the operation in case of failure or + cancellation. + GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: + id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig type: object - ListRepositoriesResponse: - description: Message for response to listing Repositories. properties: - nextPageToken: - description: A token identifying a page of results the server should return. + hostUri: type: string - repositories: - type: array - description: The list of Repositories. - items: - $ref: '#/components/schemas/Repository' - id: ListRepositoriesResponse - type: object - TestIamPermissionsRequest: - id: TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. - type: object - properties: - permissions: - type: array - items: - type: string 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). - Provenance: - properties: - storage: + Required. The URI of the GitHub Enterprise host this connection is + for. + appId: + description: Optional. Id of the GitHub App created from the manifest. type: string - description: Optional. Where provenance is stored. - enumDescriptions: - - Default PREFER_ARTIFACT_PROJECT. - - >- - GCB will attempt to push provenance to the artifact project. If it - is not available, fallback to build project. - - Only push to artifact project. - - Only push to build project. - enum: - - STORAGE_UNSPECIFIED - - PREFER_ARTIFACT_PROJECT - - ARTIFACT_PROJECT_ONLY - - BUILD_PROJECT_ONLY - enabled: - enumDescriptions: - - Default to disabled (before AA regionalization), optimistic after - - Provenance failures would fail the run - - >- - GCB will attempt to push to artifact analaysis and build state - would not be impacted by the push failures. - - Disable the provenance push entirely. - enum: - - ENABLED_UNSPECIFIED - - REQUIRED - - OPTIMISTIC - - DISABLED - description: Optional. Provenance push mode. + format: int64 + privateKeySecretVersion: type: string - region: + description: >- + Optional. SecretManager resource containing the private key of the + GitHub App, formatted as `projects/*/secrets/*/versions/*`. + webhookSecretSecretVersion: + description: >- + Optional. SecretManager resource containing the webhook secret of + the GitHub App, formatted as `projects/*/secrets/*/versions/*`. type: string - enum: - - REGION_UNSPECIFIED - - GLOBAL - enumDescriptions: - - >- - The PipelineRun/TaskRun/Workflow will be rejected. Update this - comment to push to the same region as the run in Artifact Analysis - when it's regionalized. - - Push provenance to Artifact Analysis in global region. - description: Optional. Provenance region. - id: Provenance - type: object - description: Provenance configuration. - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - type: object + appInstallationId: + type: string + description: Optional. ID of the installation of the GitHub App. + format: int64 + appSlug: + description: Optional. The URL-friendly name of the GitHub App. + type: string + serverVersion: + readOnly: true + type: string + description: Output only. GitHub Enterprise version installed at the host_uri. + apiKey: + description: Required. API Key used for authentication of webhook events. + type: string + serviceDirectoryConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + description: >- + Optional. Configuration for using Service Directory to privately + connect to a GitHub Enterprise server. This should only be set if + the GitHub Enterprise server is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the GitHub + Enterprise server will be made over the public internet. + sslCa: + type: string + description: Optional. SSL certificate to use for requests to GitHub Enterprise. + description: Configuration for connections to an instance of GitHub Enterprise. + SecretVolumeSource: + description: Secret Volume Source. properties: - permissions: - items: - type: string + secretVersion: description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - TaskSpec: - description: TaskSpec contains the Spec to instantiate a TaskRun. + Optional. Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* + type: string + secretName: + type: string + description: Name of the secret referenced by the WorkspaceBinding. + id: SecretVolumeSource type: object - id: TaskSpec + Capabilities: + id: Capabilities + type: object + description: >- + Capabilities adds and removes POSIX capabilities from running + containers. properties: - steps: - description: Steps of the task. - items: - $ref: '#/components/schemas/Step' - type: array - workspaces: + add: items: - $ref: '#/components/schemas/WorkspaceDeclaration' - description: The volumes that this Task requires. + type: string + description: Optional. Added capabilities +optional type: array - volumes: + drop: type: array - description: A collection of volumes that are available to mount into steps. + description: Optional. Removed capabilities +optional items: - $ref: '#/components/schemas/VolumeSource' - description: - description: Description of the task. + type: string + PipelineRef: + description: PipelineRef can be used to refer to a specific instance of a Pipeline. + id: PipelineRef + type: object + properties: + name: type: string - stepTemplate: + description: Optional. Name of the Pipeline. + resolver: description: >- - Optional. StepTemplate can be used as the basis for all step - containers within the Task, so that the steps inherit settings on - the base container. - $ref: '#/components/schemas/StepTemplate' + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. + type: string + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT params: - items: - $ref: '#/components/schemas/ParamSpec' - description: List of parameters. - type: array - managedSidecars: description: >- - Sidecars that run alongside the Task’s step containers that should - be added to this Task. - items: - type: string - enum: - - MANAGED_SIDECAR_UNSPECIFIED - - PRIVILEGED_DOCKER_DAEMON - enumDescriptions: - - Default enum type; should not be used. - - Sidecar for a privileged docker daemon. - type: array - results: - description: Values that this Task can output. - items: - $ref: '#/components/schemas/TaskResult' - type: array - sidecars: - description: Sidecars that run alongside the Task's step containers. + Params contains the parameters used to identify the referenced + Tekton resource. Example entries might include "repo" or "path" but + the set of params ultimately depends on the chosen resolver. items: - $ref: '#/components/schemas/Sidecar' + $ref: '#/components/schemas/Param' type: array - BatchCreateRepositoriesResponse: - description: Message for response of creating repositories in batch. + AuditConfig: + id: AuditConfig + description: >- + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + type: object properties: - repositories: - items: - $ref: '#/components/schemas/Repository' + auditLogConfigs: + description: The configuration for logging of each type of permission. type: array - description: Repository resources created. + items: + $ref: '#/components/schemas/AuditLogConfig' + service: + type: string + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + Location: + description: A resource that represents a Google Cloud location. type: object - id: BatchCreateRepositoriesResponse - ParamSpec: properties: - name: + displayName: type: string - description: Name of the ParamSpec - type: - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type. - - Object type. - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + name: type: string - description: Type of ParamSpec - description: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' type: string - description: Description of the ParamSpec - default: - description: The default value a parameter takes if no input value is supplied - $ref: '#/components/schemas/ParamValue' + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + labels: + type: object + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + additionalProperties: + type: string + id: Location + WorkspacePipelineTaskBinding: + id: WorkspacePipelineTaskBinding description: >- - ParamSpec defines parameters needed beyond typed inputs (such as - resources). Parameter values are provided by users as inputs on a - TaskRun or PipelineRun. - type: object - id: ParamSpec - RunWorkflowCustomOperationMetadata: + WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to + the workspaces declared in the Task. type: object properties: - requestedCancellation: - description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - readOnly: true - type: boolean - target: - readOnly: true - description: >- - Output only. Server-defined resource path for the target of the - operation. - type: string - pipelineRunId: - description: Output only. ID of the pipeline run created by RunWorkflow. - type: string - readOnly: true - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The time the operation was created. - apiVersion: - readOnly: true - description: Output only. API version used to start the operation. + workspace: type: string - endTime: + description: Name of the workspace declared by the pipeline. + subPath: type: string - format: google-datetime - description: Output only. The time the operation finished running. - readOnly: true - verb: + description: >- + Optional. SubPath is optionally a directory on the volume which + should be used for this binding (i.e. the volume will be mounted at + this sub directory). +optional + name: type: string - readOnly: true - description: Output only. Name of the verb executed by the operation. - id: RunWorkflowCustomOperationMetadata - description: >- - Represents the custom metadata of the RunWorkflow long-running - operation. - HttpBody: - type: object - id: HttpBody + description: Name of the workspace as declared by the task. + StepRef: + description: A reference to a remote Step, i.e. a StepAction. properties: - extensions: - type: array - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - contentType: + name: + description: Optional. Name of the step. type: string - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - data: - description: The HTTP request/response body as raw binary. - format: byte + resolver: + description: Optional. Type of the resolver. + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. type: string - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - ListConnectionsResponse: + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT + params: + items: + $ref: '#/components/schemas/Param' + type: array + description: Optional. Parameters used to control the resolution. + id: StepRef + type: object + ListRepositoriesResponse: + type: object properties: nextPageToken: - description: A token identifying a page of results the server should return. type: string - connections: + description: A token identifying a page of results the server should return. + repositories: + description: The list of Repositories. items: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/Repository' type: array - description: The list of Connections. + id: ListRepositoriesResponse + description: Message for response to listing Repositories. + EmbeddedTask: + description: EmbeddedTask defines a Task that is embedded in a Pipeline. + id: EmbeddedTask type: object - id: ListConnectionsResponse - description: Message for response to listing Connections. - PipelineSpec: properties: - generatedYaml: + taskSpec: + $ref: '#/components/schemas/TaskSpec' + description: Spec to instantiate this TaskRun. + annotations: + description: User annotations. See https://google.aip.dev/128#annotations + type: object + additionalProperties: + type: string + Param: + id: Param + properties: + value: + description: Value of the parameter. + $ref: '#/components/schemas/ParamValue' + name: + type: string + description: Name of the parameter. + description: >- + Param defined with name and value. PipelineRef can be used to refer to a + specific instance of a Pipeline. + type: object + PipelineRun: + type: object + properties: + pipelineRunStatus: + enum: + - PIPELINE_RUN_STATUS_UNSPECIFIED + - PIPELINE_RUN_CANCELLED + enumDescriptions: + - Default enum type; should not be used. + - Cancelled status. + type: string + description: Pipelinerun status the user can provide. Used for cancellation. + serviceAccount: + deprecated: true type: string description: >- - Output only. auto-generated yaml that is output only for display - purpose for workflows using pipeline_spec, used by UI/gcloud cli for - Workflows. + Service account used in the Pipeline. Deprecated; please use + security.service_account instead. + pipelineSpecYaml: + description: >- + Output only. Inline pipelineSpec yaml string, used by workflow run + requests. + readOnly: true + type: string + completionTime: + description: Output only. Time the pipeline completed. + readOnly: true + type: string + format: google-datetime + pipelineRef: + $ref: '#/components/schemas/PipelineRef' + description: PipelineRef refer to a specific instance of a Pipeline. + workflow: + type: string + description: Output only. The Workflow used to create this PipelineRun. + readOnly: true + conditions: readOnly: true - tasks: - items: - $ref: '#/components/schemas/PipelineTask' - description: List of Tasks that execute when this Pipeline is run. type: array - finallyTasks: + description: >- + Output only. Kubernetes Conditions convention for PipelineRun status + and error. items: - $ref: '#/components/schemas/PipelineTask' + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' + gcbParams: + additionalProperties: + type: string + readOnly: true + description: Output only. GCB default params. + type: object + provenance: + description: Optional. Provenance configuration. + $ref: '#/components/schemas/Provenance' + etag: + description: Needed for declarative-friendly resources. + type: string + createTime: description: >- - List of Tasks that execute just before leaving the Pipeline i.e. - either after all Tasks are finished executing successfully or after - a failure which would result in ending the Pipeline. - type: array - workspaces: - type: array + Output only. Time at which the request to create the `PipelineRun` + was received. + type: string + readOnly: true + format: google-datetime + record: + readOnly: true + type: string description: >- - Workspaces declares a set of named workspaces that are expected to - be provided by a PipelineRun. - items: - $ref: '#/components/schemas/PipelineWorkspaceDeclaration' + Output only. The `Record` of this `PipelineRun`. Format: + `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` + name: + type: string + description: >- + Output only. The `PipelineRun` name with format + `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` + readOnly: true + worker: + $ref: '#/components/schemas/Worker' + description: Optional. Worker configuration. results: type: array - readOnly: true items: - $ref: '#/components/schemas/PipelineResult' + $ref: '#/components/schemas/PipelineRunResult' + readOnly: true description: >- Optional. Output only. List of results written out by the pipeline's containers + timeouts: + description: >- + Time after which the Pipeline times out. Currently three keys are + accepted in the map pipeline, tasks and finally with + Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally + $ref: '#/components/schemas/TimeoutFields' + resolvedPipelineSpec: + description: Output only. The exact PipelineSpec used to instantiate the run. + readOnly: true + $ref: '#/components/schemas/PipelineSpec' params: - items: - $ref: '#/components/schemas/ParamSpec' - description: List of parameters. + description: Params is a list of parameter names and values. type: array - type: object - description: PipelineSpec defines the desired state of Pipeline. - id: PipelineSpec - EnvVar: - properties: - name: - description: Name of the environment variable. - type: string - value: + items: + $ref: '#/components/schemas/Param' + updateTime: + format: google-datetime + readOnly: true + description: >- + Output only. Time at which the request to update the `PipelineRun` + was received. type: string - description: Value of the environment variable. - type: object - description: Environment variable. - id: EnvVar - GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: - properties: - service: + skippedTasks: + readOnly: true + type: array + items: + $ref: '#/components/schemas/SkippedTask' description: >- - Required. The Service Directory service name. Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. + Output only. List of tasks that were skipped due to when expressions + evaluating to false. + uid: type: string - description: >- - ServiceDirectoryConfig represents Service Directory configuration for a - connection. - type: object - id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - WhenExpression: - description: Conditions that need to be true for the task to run. - id: WhenExpression - type: object - properties: - expressionOperator: - enum: - - EXPRESSION_OPERATOR_UNSPECIFIED - - IN - - NOT_IN - enumDescriptions: - - Default enum type; should not be used. - - Input is in values. - - Input is not in values. - description: Operator that represents an Input's relationship to the values + readOnly: true + description: Output only. A unique identifier for the `PipelineRun`. + annotations: + additionalProperties: + type: string + description: User annotations. See https://google.aip.dev/128#annotations + type: object + startTime: type: string - values: + format: google-datetime + description: Output only. Time the pipeline is actually started. + readOnly: true + security: + $ref: '#/components/schemas/Security' + description: Optional. Security configuration. + workerPool: + type: string + description: Output only. The WorkerPool used to run this PipelineRun. + readOnly: true + workspaces: + items: + $ref: '#/components/schemas/WorkspaceBinding' description: >- - Values is an array of strings, which is compared against the input, - for guard checking. + Workspaces is a list of WorkspaceBindings from volumes to + workspaces. + type: array + childReferences: items: - type: string + $ref: '#/components/schemas/ChildStatusReference' type: array - input: + description: >- + Output only. List of TaskRun and Run names and PipelineTask names + for children of this PipelineRun. + readOnly: true + finallyStartTime: type: string description: >- - Input is the string for guard checking which can be a static input - or an output from a parent Task. - BitbucketDataCenterConfig: - description: Configuration for connections to Bitbucket Data Center. + Output only. FinallyStartTime is when all non-finally tasks have + been completed and only finally tasks are being executed. +optional + readOnly: true + format: google-datetime + pipelineSpec: + description: PipelineSpec defines the desired state of Pipeline. + $ref: '#/components/schemas/PipelineSpec' + id: PipelineRun + description: Message describing PipelineRun object + OperationMetadata: properties: - serviceDirectoryConfig: - description: >- - Optional. Configuration for using Service Directory to privately - connect to a Bitbucket Data Center. This should only be set if the - Bitbucket Data Center is hosted on-premises and not reachable by - public internet. If this field is left empty, calls to the Bitbucket - Data Center will be made over the public internet. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - authorizerCredential: - description: Required. A http access token with the `REPO_ADMIN` scope access. - $ref: '#/components/schemas/UserCredential' - sslCa: + createTime: + description: Output only. The time the operation was created. + format: google-datetime + type: string + readOnly: true + cancelRequested: description: >- - Optional. SSL certificate to use for requests to the Bitbucket Data - Center. + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + verb: + readOnly: true + description: Output only. Name of the verb executed by the operation. type: string - readAuthorizerCredential: - description: Required. A http access token with the `REPO_READ` access. - $ref: '#/components/schemas/UserCredential' - hostUri: + statusDetail: type: string + readOnly: true + description: Output only. Human-readable status of the operation, if any. + target: + readOnly: true description: >- - Required. The URI of the Bitbucket Data Center instance or cluster - this connection is for. - webhookSecretSecretVersion: - description: >- - Required. Immutable. SecretManager resource containing the webhook - secret used to verify webhook events, formatted as - `projects/*/secrets/*/versions/*`. + Output only. Server-defined resource path for the target of the + operation. type: string - serverVersion: + apiVersion: + readOnly: true + type: string + description: Output only. API version used to start the operation. + endTime: + readOnly: true + format: google-datetime type: string - readOnly: true - description: >- - Output only. Version of the Bitbucket Data Center running on the - `host_uri`. - id: BitbucketDataCenterConfig + description: Output only. The time the operation finished running. + id: OperationMetadata + description: Represents the metadata of the long-running operation. type: object - PipelineRef: - id: PipelineRef + PipelineRunResult: + id: PipelineRunResult + description: PipelineRunResult used to describe the results of a pipeline type: object properties: - resolver: - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. + value: + description: Output only. Value of the result. + readOnly: true + $ref: '#/components/schemas/ResultValue' + name: + readOnly: true + type: string + description: Output only. Name of the TaskRun + Security: + id: Security + type: object + properties: + privilegeMode: + type: string + description: Optional. Privilege mode. + deprecated: true enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT + - PRIVILEGE_MODE_UNSPECIFIED + - PRIVILEGED + - UNPRIVILEGED + enumDescriptions: + - Default to PRIVILEGED. + - Privileged mode. + - Unprivileged mode. + serviceAccount: + description: IAM service account whose credentials will be used at runtime. type: string - description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. - name: + description: Security configuration. + FetchLinkableRepositoriesResponse: + type: object + description: Response message for FetchLinkableRepositories. + id: FetchLinkableRepositoriesResponse + properties: + nextPageToken: + description: A token identifying a page of results the server should return. type: string - description: Optional. Name of the Pipeline. - params: + repositories: + type: array + items: + $ref: '#/components/schemas/Repository' + description: repositories ready to be created. + Status: + properties: + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: type: array description: >- - Params contains the parameters used to identify the referenced - Tekton resource. Example entries might include "repo" or "path" but - the set of params ultimately depends on the chosen resolver. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. items: - $ref: '#/components/schemas/Param' - description: PipelineRef can be used to refer to a specific instance of a Pipeline. - TaskRef: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + id: Status description: >- - TaskRef can be used to refer to a specific instance of a task. - PipelineRef can be used to refer to a specific instance of a Pipeline. - id: TaskRef + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + SetIamPolicyRequest: + description: Request message for `SetIamPolicy` method. + id: SetIamPolicyRequest type: object properties: - resolver: - description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT + updateMask: type: string - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. - params: - items: - $ref: '#/components/schemas/Param' - type: array description: >- - Params contains the parameters used to identify the referenced - Tekton resource. Example entries might include "repo" or "path" but - the set of params ultimately depends on the chosen resolver. - name: - description: Optional. Name of the task. - type: string + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + format: google-fieldmask + policy: + $ref: '#/components/schemas/Policy' + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. Probe: - id: Probe - description: >- - Probe describes a health check to be performed against a container to - determine whether it is alive or ready to receive traffic. - type: object properties: exec: $ref: '#/components/schemas/ExecAction' description: Optional. Exec specifies the action to take. +optional periodSeconds: - format: int32 description: >- Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional type: integer - SecurityContext: + format: int32 + id: Probe + type: object + description: >- + Probe describes a health check to be performed against a container to + determine whether it is alive or ready to receive traffic. + TaskSpec: properties: - runAsGroup: - format: int64 + steps: + items: + $ref: '#/components/schemas/Step' + description: Steps of the task. + type: array + description: + description: Description of the task. + type: string + workspaces: + description: The volumes that this Task requires. + type: array + items: + $ref: '#/components/schemas/WorkspaceDeclaration' + sidecars: + type: array + items: + $ref: '#/components/schemas/Sidecar' + description: Sidecars that run alongside the Task's step containers. + managedSidecars: + description: >- + Sidecars that run alongside the Task’s step containers that should + be added to this Task. + type: array + items: + enum: + - MANAGED_SIDECAR_UNSPECIFIED + - PRIVILEGED_DOCKER_DAEMON + type: string + enumDescriptions: + - Default enum type; should not be used. + - Sidecar for a privileged docker daemon. + volumes: + type: array + items: + $ref: '#/components/schemas/VolumeSource' + description: A collection of volumes that are available to mount into steps. + params: + type: array + description: List of parameters. + items: + $ref: '#/components/schemas/ParamSpec' + stepTemplate: + $ref: '#/components/schemas/StepTemplate' + description: >- + Optional. StepTemplate can be used as the basis for all step + containers within the Task, so that the steps inherit settings on + the base container. + results: + description: Values that this Task can output. + items: + $ref: '#/components/schemas/TaskResult' + type: array + type: object + description: TaskSpec contains the Spec to instantiate a TaskRun. + id: TaskSpec + InstallationState: + description: >- + Describes stage and necessary actions to be taken by the user to + complete the installation. Used for GitHub and GitHub Enterprise based + connections. + properties: + stage: + enum: + - STAGE_UNSPECIFIED + - PENDING_CREATE_APP + - PENDING_USER_OAUTH + - PENDING_INSTALL_APP + - COMPLETE + description: Output only. Current step of the installation process. + readOnly: true type: string + enumDescriptions: + - No stage specified. + - >- + Only for GitHub Enterprise. An App creation has been requested. + The user needs to confirm the creation in their GitHub enterprise + host. + - User needs to authorize the GitHub (or Enterprise) App via OAuth. + - >- + User needs to follow the link to install the GitHub (or + Enterprise) App. + - Installation process has been completed. + actionUri: + readOnly: true description: >- - Optional. The GID to run the entrypoint of the container process. - Uses runtime default if unset. May also be set in - PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes - precedence. Note that this field cannot be set when spec.os.name is - windows. +optional - runAsUser: + Output only. Link to follow for next action. Empty string if the + installation is already complete. type: string - format: int64 - description: >- - Optional. The UID to run the entrypoint of the container process. - Defaults to user specified in image metadata if unspecified. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext takes - precedence. Note that this field cannot be set when spec.os.name is - windows. +optional - capabilities: - description: >- - Optional. Adds and removes POSIX capabilities from running - containers. - $ref: '#/components/schemas/Capabilities' - runAsNonRoot: - type: boolean - description: >- - Optional. Indicates that the container must run as a non-root user. - If true, the Kubelet will validate the image at runtime to ensure - that it does not run as UID 0 (root) and fail to start the container - if it does. If unset or false, no such validation will be performed. - May also be set in PodSecurityContext. If set in both - SecurityContext and PodSecurityContext, the value specified in - SecurityContext takes precedence. +optional - allowPrivilegeEscalation: + message: description: >- - Optional. AllowPrivilegeEscalation controls whether a process can - gain more privileges than its parent process. This bool directly - controls if the no_new_privs flag will be set on the container - process. AllowPrivilegeEscalation is true always when the container - is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field - cannot be set when spec.os.name is windows. +optional - type: boolean - privileged: - type: boolean - description: Run container in privileged mode. - id: SecurityContext + Output only. Message of what the user should do next to continue the + installation. Empty string if the installation is already complete. + type: string + readOnly: true type: object - description: Security options the container should be run with. - FetchReadWriteTokenResponse: + id: InstallationState + PipelineWorkspaceDeclaration: + id: PipelineWorkspaceDeclaration type: object - id: FetchReadWriteTokenResponse properties: - expirationTime: - format: google-datetime - description: Expiration timestamp. Can be empty if unknown or non-expiring. - type: string - token: - description: The token content. + name: + description: Name is the name of a workspace to be provided by a PipelineRun. type: string - description: Message for responding to get read/write token. - WorkspaceDeclaration: - type: object - properties: description: - type: string - description: Description is a human readable description of this volume. - mountPath: description: >- - MountPath overrides the directory that the volume will be made - available at. - type: string - name: - description: Name is the name by which you can bind the volume at runtime. + Description is a human readable string describing how the workspace + will be used in the Pipeline. type: string optional: - type: boolean description: >- - Optional. Optional marks a Workspace as not being required in - TaskRuns. By default this field is false and so declared workspaces - are required. - readOnly: + Optional marks a Workspace as not being required in PipelineRuns. By + default this field is false and so declared workspaces are required. type: boolean - description: ReadOnly dictates whether a mounted volume is writable. - id: WorkspaceDeclaration - description: WorkspaceDeclaration is a declaration of a volume that a Task requires. - PipelineRun: - description: Message describing PipelineRun object + description: >- + Workspaces declares a set of named workspaces that are expected to be + provided by a PipelineRun. + AuditLogConfig: + type: object + id: AuditLogConfig properties: - annotations: - description: User annotations. See https://google.aip.dev/128#annotations - additionalProperties: - type: string - type: object - childReferences: - items: - $ref: '#/components/schemas/ChildStatusReference' + exemptedMembers: type: array description: >- - Output only. List of TaskRun and Run names and PipelineTask names - for children of this PipelineRun. - readOnly: true - pipelineSpecYaml: - description: >- - Output only. Inline pipelineSpec yaml string, used by workflow run - requests. - readOnly: true - type: string - startTime: - type: string - readOnly: true - description: Output only. Time the pipeline is actually started. - format: google-datetime - conditions: + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' - description: >- - Output only. Kubernetes Conditions convention for PipelineRun status - and error. + type: string + logType: + description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + ListConnectionsResponse: + properties: + connections: type: array - readOnly: true - etag: + items: + $ref: '#/components/schemas/Connection' + description: The list of Connections. + nextPageToken: type: string - description: Needed for declarative-friendly resources. - pipelineRef: - description: PipelineRef refer to a specific instance of a Pipeline. - $ref: '#/components/schemas/PipelineRef' - serviceAccount: + description: A token identifying a page of results the server should return. + description: Message for response to listing Connections. + type: object + id: ListConnectionsResponse + GitHubConfig: + description: Configuration for connections to github.com. + properties: + appInstallationId: + description: Optional. GitHub App installation id. + format: int64 type: string + authorizerCredential: description: >- - Service account used in the Pipeline. Deprecated; please use - security.service_account instead. - deprecated: true - workflow: - readOnly: true + Optional. OAuth credential of the account that authorized the Cloud + Build GitHub App. It is recommended to use a robot account instead + of a human user account. The OAuth token must be tied to the Cloud + Build GitHub App. + $ref: '#/components/schemas/OAuthCredential' + type: object + id: GitHubConfig + GoogleDevtoolsCloudbuildV2Condition: + id: GoogleDevtoolsCloudbuildV2Condition + description: Conditions defines a readiness condition for a Knative resource. + type: object + properties: + status: + description: Status of the condition. + enum: + - UNKNOWN + - 'TRUE' + - 'FALSE' + enumDescriptions: + - Default enum type indicating execution is still ongoing. + - Success + - Failure type: string - description: Output only. The Workflow used to create this PipelineRun. - pipelineSpec: - description: PipelineSpec defines the desired state of Pipeline. - $ref: '#/components/schemas/PipelineSpec' - record: + type: type: string - description: >- - Output only. The `Record` of this `PipelineRun`. Format: - `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` - readOnly: true - worker: - $ref: '#/components/schemas/Worker' - description: Optional. Worker configuration. - skippedTasks: - description: >- - Output only. List of tasks that were skipped due to when expressions - evaluating to false. - type: array - readOnly: true - items: - $ref: '#/components/schemas/SkippedTask' - timeouts: - description: >- - Time after which the Pipeline times out. Currently three keys are - accepted in the map pipeline, tasks and finally with - Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally - $ref: '#/components/schemas/TimeoutFields' - uid: - readOnly: true - description: Output only. A unique identifier for the `PipelineRun`. + description: Type of condition. + severity: + enumDescriptions: + - Default enum type; should not be used. + - Severity is warning. + - Severity is informational only. type: string - createTime: - readOnly: true + enum: + - SEVERITY_UNSPECIFIED + - WARNING + - INFO + description: Severity with which to treat failures of this type of condition. + reason: type: string - description: >- - Output only. Time at which the request to create the `PipelineRun` - was received. - format: google-datetime - completionTime: + description: The reason for the condition's last transition. + message: type: string - description: Output only. Time the pipeline completed. + description: A human readable message indicating details about the transition. + lastTransitionTime: + description: >- + LastTransitionTime is the last time the condition transitioned from + one status to another. format: google-datetime - readOnly: true - pipelineRunStatus: - description: Pipelinerun status the user can provide. Used for cancellation. - type: string - enum: - - PIPELINE_RUN_STATUS_UNSPECIFIED - - PIPELINE_RUN_CANCELLED - enumDescriptions: - - Default enum type; should not be used. - - Cancelled status. - workerPool: type: string - description: Output only. The WorkerPool used to run this PipelineRun. + SkippedTask: + description: >- + SkippedTask is used to describe the Tasks that were skipped due to their + When Expressions evaluating to False. + type: object + id: SkippedTask + properties: + reason: + description: Output only. Reason is the cause of the PipelineTask being skipped. readOnly: true - security: - description: Optional. Security configuration. - $ref: '#/components/schemas/Security' - params: - items: - $ref: '#/components/schemas/Param' - type: array - description: Params is a list of parameter names and values. - updateTime: type: string - readOnly: true - format: google-datetime - description: >- - Output only. Time at which the request to update the `PipelineRun` - was received. name: + type: string + description: Name is the Pipeline Task name + whenExpressions: + type: array description: >- - Output only. The `PipelineRun` name with format - `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` - readOnly: true + WhenExpressions is the list of checks guarding the execution of the + PipelineTask + items: + $ref: '#/components/schemas/WhenExpression' + SecurityContext: + description: Security options the container should be run with. + id: SecurityContext + properties: + runAsGroup: type: string - finallyStartTime: - readOnly: true + description: >- + Optional. The GID to run the entrypoint of the container process. + Uses runtime default if unset. May also be set in + PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes + precedence. Note that this field cannot be set when spec.os.name is + windows. +optional + format: int64 + runAsUser: type: string - format: google-datetime + format: int64 description: >- - Output only. FinallyStartTime is when all non-finally tasks have - been completed and only finally tasks are being executed. +optional - workspaces: + Optional. The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. May + also be set in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext takes + precedence. Note that this field cannot be set when spec.os.name is + windows. +optional + runAsNonRoot: + type: boolean description: >- - Workspaces is a list of WorkspaceBindings from volumes to - workspaces. - type: array - items: - $ref: '#/components/schemas/WorkspaceBinding' - gcbParams: - type: object - description: Output only. GCB default params. - readOnly: true - additionalProperties: - type: string - results: + Optional. Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure + that it does not run as UID 0 (root) and fail to start the container + if it does. If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both + SecurityContext and PodSecurityContext, the value specified in + SecurityContext takes precedence. +optional + privileged: + type: boolean + description: Run container in privileged mode. + capabilities: + $ref: '#/components/schemas/Capabilities' description: >- - Optional. Output only. List of results written out by the pipeline's - containers - type: array - items: - $ref: '#/components/schemas/PipelineRunResult' - readOnly: true - resolvedPipelineSpec: - readOnly: true - description: Output only. The exact PipelineSpec used to instantiate the run. - $ref: '#/components/schemas/PipelineSpec' - provenance: - description: Optional. Provenance configuration. - $ref: '#/components/schemas/Provenance' - type: object - id: PipelineRun - Empty: - properties: {} - 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); } + Optional. Adds and removes POSIX capabilities from running + containers. + allowPrivilegeEscalation: + type: boolean + description: >- + Optional. AllowPrivilegeEscalation controls whether a process can + gain more privileges than its parent process. This bool directly + controls if the no_new_privs flag will be set on the container + process. AllowPrivilegeEscalation is true always when the container + is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field + cannot be set when spec.os.name is windows. +optional type: object - id: Empty - ParamValue: - description: Parameter value. + GoogleDevtoolsCloudbuildV2GitLabConfig: properties: - type: - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - description: Type of parameter. + authorizerCredential: + description: >- + Required. A GitLab personal access token with the `api` scope + access. + $ref: '#/components/schemas/UserCredential' + serverVersion: + description: >- + Output only. Version of the GitLab Enterprise server running on the + `host_uri`. type: string - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - arrayVal: - items: - type: string - description: Value of the parameter if type is array. - type: array - stringVal: - description: Value of the parameter if type is string. + readOnly: true + webhookSecretSecretVersion: + description: >- + Required. Immutable. SecretManager resource containing the webhook + secret of a GitLab Enterprise project, formatted as + `projects/*/secrets/*/versions/*`. type: string - objectVal: - description: Optional. Value of the parameter if type is object. - type: object - additionalProperties: - type: string - type: object - id: ParamValue - FetchReadWriteTokenRequest: - description: Message for fetching SCM read/write token. + sslCa: + type: string + description: Optional. SSL certificate to use for requests to GitLab Enterprise. + readAuthorizerCredential: + $ref: '#/components/schemas/UserCredential' + description: >- + Required. A GitLab personal access token with the minimum `read_api` + scope access. + hostUri: + description: >- + Optional. The URI of the GitLab Enterprise host this connection is + for. If not specified, the default value is https://gitlab.com. + type: string + serviceDirectoryConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + description: >- + Optional. Configuration for using Service Directory to privately + connect to a GitLab Enterprise server. This should only be set if + the GitLab Enterprise server is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the GitLab + Enterprise server will be made over the public internet. type: object - id: FetchReadWriteTokenRequest - properties: {} - VolumeSource: + id: GoogleDevtoolsCloudbuildV2GitLabConfig + description: >- + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. + GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: properties: - emptyDir: - description: A temporary directory that shares a pod's lifetime. - $ref: '#/components/schemas/EmptyDirVolumeSource' - name: + service: type: string description: >- - Name of the Volume. Must be a DNS_LABEL and unique within the pod. - More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - description: Volumes available to mount. + Required. The Service Directory service name. Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. + description: >- + ServiceDirectoryConfig represents Service Directory configuration for a + connection. type: object - id: VolumeSource - Operation: - id: Operation + id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + UserCredential: + id: UserCredential type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. properties: - error: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - metadata: + userTokenSecretVersion: + type: string description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - name: + Required. A SecretManager resource containing the user token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. + username: + readOnly: true + description: Output only. The username associated to this token. type: string + description: >- + Represents a personal access token that authorized the Connection, and + associated metadata. + CreateRepositoryRequest: + description: Message for creating a Repository. + properties: + repositoryId: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + Required. The ID to use for the repository, which will become the + final component of the repository's resource name. This ID should be + unique in the connection. Allows alphanumeric characters and any of + -._~%!$&'()*+,;=@. + type: string + repository: + $ref: '#/components/schemas/Repository' + description: Required. The repository to create. + parent: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object + Required. The connection to contain the repository. If the request + is part of a BatchCreateRepositoriesRequest, this field should be + empty or match the parent specified there. + type: string + type: object + id: CreateRepositoryRequest Binding: + type: object + description: Associates `members`, or principals, with a `role`. + id: Binding properties: role: type: string @@ -1680,7 +1605,6 @@ components: For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). condition: - $ref: '#/components/schemas/Expr' description: >- The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current @@ -1690,10 +1614,9 @@ components: in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' members: type: array - items: - type: string description: >- Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A @@ -1753,318 +1676,323 @@ components: `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - id: Binding + items: + type: string + WorkspaceDeclaration: type: object - description: Associates `members`, or principals, with a `role`. - PipelineRunResult: - id: PipelineRunResult - description: PipelineRunResult used to describe the results of a pipeline + id: WorkspaceDeclaration + description: WorkspaceDeclaration is a declaration of a volume that a Task requires. properties: name: - description: Output only. Name of the TaskRun - type: string - readOnly: true - value: - readOnly: true - $ref: '#/components/schemas/ResultValue' - description: Output only. Value of the result. - type: object - GoogleDevtoolsCloudbuildV2GitLabConfig: - properties: - hostUri: - description: >- - Optional. The URI of the GitLab Enterprise host this connection is - for. If not specified, the default value is https://gitlab.com. + description: Name is the name by which you can bind the volume at runtime. type: string - authorizerCredential: - $ref: '#/components/schemas/UserCredential' + optional: + type: boolean description: >- - Required. A GitLab personal access token with the `api` scope - access. - sslCa: - type: string - description: Optional. SSL certificate to use for requests to GitLab Enterprise. - webhookSecretSecretVersion: + Optional. Optional marks a Workspace as not being required in + TaskRuns. By default this field is false and so declared workspaces + are required. + readOnly: + description: ReadOnly dictates whether a mounted volume is writable. + type: boolean + description: type: string + description: Description is a human readable description of this volume. + mountPath: description: >- - Required. Immutable. SecretManager resource containing the webhook - secret of a GitLab Enterprise project, formatted as - `projects/*/secrets/*/versions/*`. - serviceDirectoryConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - description: >- - Optional. Configuration for using Service Directory to privately - connect to a GitLab Enterprise server. This should only be set if - the GitLab Enterprise server is hosted on-premises and not reachable - by public internet. If this field is left empty, calls to the GitLab - Enterprise server will be made over the public internet. - serverVersion: - description: >- - Output only. Version of the GitLab Enterprise server running on the - `host_uri`. - readOnly: true + MountPath overrides the directory that the volume will be made + available at. type: string - readAuthorizerCredential: - description: >- - Required. A GitLab personal access token with the minimum `read_api` - scope access. - $ref: '#/components/schemas/UserCredential' + FetchReadWriteTokenRequest: type: object - description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. - id: GoogleDevtoolsCloudbuildV2GitLabConfig - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + description: Message for fetching SCM read/write token. + id: FetchReadWriteTokenRequest + properties: {} + WhenExpression: + id: WhenExpression type: object properties: - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - type: string - format: byte - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - items: - $ref: '#/components/schemas/Binding' + values: type: array - version: - type: integer - format: int32 description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. + Values is an array of strings, which is compared against the input, + for guard checking. items: - $ref: '#/components/schemas/AuditConfig' - type: array - SetIamPolicyRequest: - description: Request message for `SetIamPolicy` method. - id: SetIamPolicyRequest - properties: - policy: + type: string + input: description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - updateMask: + Input is the string for guard checking which can be a static input + or an output from a parent Task. + type: string + expressionOperator: + enumDescriptions: + - Default enum type; should not be used. + - Input is in values. + - Input is not in values. + type: string + description: Operator that represents an Input's relationship to the values + enum: + - EXPRESSION_OPERATOR_UNSPECIFIED + - IN + - NOT_IN + description: Conditions that need to be true for the task to run. + VolumeSource: + properties: + emptyDir: + description: A temporary directory that shares a pod's lifetime. + $ref: '#/components/schemas/EmptyDirVolumeSource' + name: type: string - format: google-fieldmask description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` + Name of the Volume. Must be a DNS_LABEL and unique within the pod. + More info: + https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: object - GitHubConfig: - id: GitHubConfig - description: Configuration for connections to github.com. + id: VolumeSource + description: Volumes available to mount. + EnvVar: + description: Environment variable. type: object properties: - appInstallationId: + name: + description: Name of the environment variable. type: string - description: Optional. GitHub App installation id. - format: int64 - authorizerCredential: - $ref: '#/components/schemas/OAuthCredential' + value: + description: Value of the environment variable. + type: string + id: EnvVar + EmptyDirVolumeSource: + type: object + description: Represents an empty Volume source. + properties: {} + id: EmptyDirVolumeSource + GoogleDevtoolsCloudbuildV2OperationMetadata: + id: GoogleDevtoolsCloudbuildV2OperationMetadata + properties: + requestedCancellation: + readOnly: true description: >- - Optional. OAuth credential of the account that authorized the Cloud - Build GitHub App. It is recommended to use a robot account instead - of a human user account. The OAuth token must be tied to the Cloud - Build GitHub App. - StepRef: - description: A reference to a remote Step, i.e. a StepAction. - id: StepRef + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + type: boolean + statusMessage: + description: Output only. Human-readable status of the operation, if any. + type: string + readOnly: true + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + readOnly: true + description: Output only. Name of the verb executed by the operation. + type: string + createTime: + description: Output only. The time the operation was created. + type: string + readOnly: true + format: google-datetime + endTime: + readOnly: true + description: Output only. The time the operation finished running. + format: google-datetime + type: string + apiVersion: + description: Output only. API version used to start the operation. + type: string + readOnly: true type: object + description: Represents the metadata of the long-running operation. + FetchReadTokenResponse: properties: - name: - description: Optional. Name of the step. + expirationTime: + format: google-datetime type: string - params: - type: array - description: Optional. Parameters used to control the resolution. - items: - $ref: '#/components/schemas/Param' - resolver: - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT - description: Optional. Type of the resolver. - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. + description: Expiration timestamp. Can be empty if unknown or non-expiring. + token: type: string - SkippedTask: + description: The token content. + description: Message for responding to get read token. + type: object + id: FetchReadTokenResponse + Empty: description: >- - SkippedTask is used to describe the Tasks that were skipped due to their - When Expressions evaluating to False. + 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); } type: object - id: SkippedTask + properties: {} + id: Empty + TestIamPermissionsResponse: properties: - name: - type: string - description: Name is the Pipeline Task name - whenExpressions: + permissions: description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask - type: array + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. items: - $ref: '#/components/schemas/WhenExpression' - reason: - description: Output only. Reason is the cause of the PipelineTask being skipped. + type: string + type: array + id: TestIamPermissionsResponse + type: object + description: Response message for `TestIamPermissions` method. + RunWorkflowCustomOperationMetadata: + id: RunWorkflowCustomOperationMetadata + type: object + description: >- + Represents the custom metadata of the RunWorkflow long-running + operation. + properties: + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true type: string + requestedCancellation: + type: boolean readOnly: true - StepTemplate: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + createTime: + readOnly: true + description: Output only. The time the operation was created. + type: string + format: google-datetime + target: + type: string + readOnly: true + description: >- + Output only. Server-defined resource path for the target of the + operation. + endTime: + type: string + readOnly: true + description: Output only. The time the operation finished running. + format: google-datetime + pipelineRunId: + description: Output only. ID of the pipeline run created by RunWorkflow. + readOnly: true + type: string + apiVersion: + readOnly: true + description: Output only. API version used to start the operation. + type: string + CancelOperationRequest: + id: CancelOperationRequest + type: object + description: The request message for Operations.CancelOperation. + properties: {} + Sidecar: + id: Sidecar type: object - id: StepTemplate properties: - volumeMounts: - items: - $ref: '#/components/schemas/VolumeMount' + command: + description: Entrypoint array. type: array - description: Optional. Pod volumes to mount into the container's filesystem. - env: + items: + type: string + readinessProbe: + $ref: '#/components/schemas/Probe' description: >- - Optional. List of environment variables to set in the Step. Cannot - be updated. + Optional. Periodic probe of Sidecar service readiness. Container + will be removed from service endpoints if the probe fails. Cannot be + updated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +optional + env: + description: List of environment variables to set in the container. items: $ref: '#/components/schemas/EnvVar' type: array - description: >- - StepTemplate can be used as the basis for all step containers within the - Task, so that the steps inherit settings on the base container. - FetchReadTokenResponse: - id: FetchReadTokenResponse - properties: - token: - description: The token content. + args: + items: + type: string + description: Arguments to the entrypoint. + type: array + image: + description: Docker image name. type: string - expirationTime: + workingDir: type: string - format: google-datetime - description: Expiration timestamp. Can be empty if unknown or non-expiring. - description: Message for responding to get read token. - type: object - VolumeMount: - type: object + description: Container's working directory. + securityContext: + $ref: '#/components/schemas/SecurityContext' + description: Optional. Security options the container should be run with. + volumeMounts: + type: array + description: Pod volumes to mount into the container's filesystem. + items: + $ref: '#/components/schemas/VolumeMount' + script: + description: The contents of an executable file to execute. + type: string + name: + type: string + description: Name of the Sidecar. + description: Sidecars run alongside the Task's step containers. + Repository: + description: A repository associated to a parent connection. + id: Repository properties: - subPathExpr: + updateTime: + format: google-datetime description: >- - Expanded path within the volume from which the container's volume - should be mounted. Behaves similarly to SubPath but environment - variable references $(VAR_NAME) are expanded using the container's - environment. Defaults to "" (volume's root). + Output only. Server assigned timestamp for when the connection was + updated. type: string + readOnly: true name: - type: string - description: Name of the volume. - mountPath: description: >- - Path within the container at which the volume should be mounted. - Must not contain ':'. + Immutable. Resource name of the repository, in the format + `projects/*/locations/*/connections/*/repositories/*`. type: string - readOnly: - type: boolean + annotations: + additionalProperties: + type: string + description: Optional. Allows clients to store small amounts of arbitrary data. + type: object + etag: description: >- - Mounted read-only if true, read-write otherwise (false or - unspecified). - subPath: + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. + type: string + webhookId: + readOnly: true type: string + description: Output only. External ID of the webhook created for the repository. + createTime: description: >- - Path within the volume from which the container's volume should be - mounted. Defaults to "" (volume's root). - description: Pod volumes to mount into the container's filesystem. - id: VolumeMount - ResultValue: + Output only. Server assigned timestamp for when the connection was + created. + type: string + readOnly: true + format: google-datetime + remoteUri: + type: string + description: Required. Git Clone HTTPS URI. + type: object + TaskResult: type: object properties: + name: + description: Name of the result. + type: string + properties: + additionalProperties: + $ref: '#/components/schemas/PropertySpec' + type: object + description: >- + When type is OBJECT, this map holds the names of fields inside that + object along with the type of data each field holds. type: - description: Output only. The type of data that the result holds. + description: The type of data that the result holds. type: string enum: - TYPE_UNSPECIFIED @@ -2076,224 +2004,225 @@ components: - Default - Array type - Object type - readOnly: true - objectVal: - type: object - description: Value of the result if type is object. - additionalProperties: - type: string - stringVal: + value: + description: >- + Optional. Optionally used to initialize a Task's result with a + Step's result. + $ref: '#/components/schemas/ParamValue' + description: + description: Description of the result. type: string - description: Value of the result if type is string. - arrayVal: + id: TaskResult + description: TaskResult is used to describe the results of a task. + PipelineSpec: + id: PipelineSpec + description: PipelineSpec defines the desired state of Pipeline. + type: object + properties: + params: type: array - description: Value of the result if type is array. + description: List of parameters. items: - type: string - description: ResultValue holds different types of data for a single result. - id: ResultValue - FetchLinkableRepositoriesResponse: - properties: - nextPageToken: - type: string - description: A token identifying a page of results the server should return. - repositories: + $ref: '#/components/schemas/ParamSpec' + tasks: items: - $ref: '#/components/schemas/Repository' - description: repositories ready to be created. + $ref: '#/components/schemas/PipelineTask' + description: List of Tasks that execute when this Pipeline is run. type: array - type: object - description: Response message for FetchLinkableRepositories. - id: FetchLinkableRepositoriesResponse - Security: - id: Security - properties: - privilegeMode: - type: string - description: Optional. Privilege mode. - enumDescriptions: - - Default to PRIVILEGED. - - Privileged mode. - - Unprivileged mode. - enum: - - PRIVILEGE_MODE_UNSPECIFIED - - PRIVILEGED - - UNPRIVILEGED - deprecated: true - serviceAccount: - description: IAM service account whose credentials will be used at runtime. - type: string - type: object - description: Security configuration. - PipelineResult: - type: object - properties: - name: + results: readOnly: true - description: Output only. Name of the result. + description: >- + Optional. Output only. List of results written out by the pipeline's + containers + type: array + items: + $ref: '#/components/schemas/PipelineResult' + workspaces: + type: array + items: + $ref: '#/components/schemas/PipelineWorkspaceDeclaration' + description: >- + Workspaces declares a set of named workspaces that are expected to + be provided by a PipelineRun. + finallyTasks: + items: + $ref: '#/components/schemas/PipelineTask' + description: >- + List of Tasks that execute just before leaving the Pipeline i.e. + either after all Tasks are finished executing successfully or after + a failure which would result in ending the Pipeline. + type: array + generatedYaml: type: string - value: - $ref: '#/components/schemas/ResultValue' - description: Output only. Value of the result. - readOnly: true - description: + description: >- + Output only. auto-generated yaml that is output only for display + purpose for workflows using pipeline_spec, used by UI/gcloud cli for + Workflows. readOnly: true - description: Output only. Description of the result. - type: string + ExecAction: + description: ExecAction describes a "run in container" action. + properties: + command: + items: + type: string + description: >- + Optional. Command is the command line to execute inside the + container, the working directory for the command is root ('/') in + the container's filesystem. The command is simply exec'd, it is not + run inside a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly call out to that + shell. Exit status of 0 is treated as live/healthy and non-zero is + unhealthy. +optional + type: array + type: object + id: ExecAction + ParamValue: + properties: + objectVal: + additionalProperties: + type: string + type: object + description: Optional. Value of the parameter if type is object. type: - type: string enum: - TYPE_UNSPECIFIED - STRING - ARRAY - OBJECT - description: Output only. The type of data that the result holds. - readOnly: true + type: string + description: Type of parameter. enumDescriptions: - Default enum type; should not be used. - Default - Array type - Object type - description: A value produced by a Pipeline. - id: PipelineResult - Sidecar: - type: object - description: Sidecars run alongside the Task's step containers. - id: Sidecar - properties: - securityContext: - description: Optional. Security options the container should be run with. - $ref: '#/components/schemas/SecurityContext' - command: + stringVal: + description: Value of the parameter if type is string. + type: string + arrayVal: type: array - description: Entrypoint array. items: type: string - workingDir: + description: Value of the parameter if type is array. + type: object + id: ParamValue + description: Parameter value. + TimeoutFields: + properties: + finally: type: string - description: Container's working directory. - volumeMounts: - description: Pod volumes to mount into the container's filesystem. - items: - $ref: '#/components/schemas/VolumeMount' - type: array - image: + format: google-duration + description: Finally sets the maximum allowed duration of this pipeline's finally + tasks: + description: Tasks sets the maximum allowed duration of this pipeline's tasks + format: google-duration type: string - description: Docker image name. - script: - description: The contents of an executable file to execute. + pipeline: + format: google-duration + description: >- + Pipeline sets the maximum allowed duration for execution of the + entire pipeline. The sum of individual timeouts for tasks and + finally must not exceed this value. type: string - env: - type: array - items: - $ref: '#/components/schemas/EnvVar' - description: List of environment variables to set in the container. - args: - type: array - items: - type: string - description: Arguments to the entrypoint. + type: object + id: TimeoutFields + description: >- + TimeoutFields allows granular specification of pipeline, task, and + finally timeouts + VolumeMount: + id: VolumeMount + type: object + properties: name: type: string - description: Name of the Sidecar. - readinessProbe: - $ref: '#/components/schemas/Probe' - description: >- - Optional. Periodic probe of Sidecar service readiness. Container - will be removed from service endpoints if the probe fails. Cannot be - updated. More info: - https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - +optional - CreateRepositoryRequest: - description: Message for creating a Repository. - properties: - repositoryId: + description: Name of the volume. + mountPath: type: string description: >- - Required. The ID to use for the repository, which will become the - final component of the repository's resource name. This ID should be - unique in the connection. Allows alphanumeric characters and any of - -._~%!$&'()*+,;=@. - repository: - $ref: '#/components/schemas/Repository' - description: Required. The repository to create. - parent: + Path within the container at which the volume should be mounted. + Must not contain ':'. + subPathExpr: + description: >- + Expanded path within the volume from which the container's volume + should be mounted. Behaves similarly to SubPath but environment + variable references $(VAR_NAME) are expanded using the container's + environment. Defaults to "" (volume's root). type: string + readOnly: + type: boolean description: >- - Required. The connection to contain the repository. If the request - is part of a BatchCreateRepositoriesRequest, this field should be - empty or match the parent specified there. + Mounted read-only if true, read-write otherwise (false or + unspecified). + subPath: + description: >- + Path within the volume from which the container's volume should be + mounted. Defaults to "" (volume's root). + type: string + description: Pod volumes to mount into the container's filesystem. + PipelineResult: + id: PipelineResult + description: A value produced by a Pipeline. type: object - id: CreateRepositoryRequest - OAuthCredential: properties: - oauthTokenSecretVersion: - description: >- - Optional. A SecretManager resource containing the OAuth token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. + name: + readOnly: true type: string - username: - description: Output only. The username associated to this token. + description: Output only. Name of the result. + value: + readOnly: true + $ref: '#/components/schemas/ResultValue' + description: Output only. Value of the result. + description: + type: string + readOnly: true + description: Output only. Description of the result. + type: + description: Output only. The type of data that the result holds. readOnly: true type: string - type: object - description: >- - Represents an OAuth token of the account that authorized the Connection, - and associated metadata. - id: OAuthCredential - UserCredential: + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + ListLocationsResponse: properties: - userTokenSecretVersion: + nextPageToken: type: string + description: The standard List next-page token. + locations: + items: + $ref: '#/components/schemas/Location' description: >- - Required. A SecretManager resource containing the user token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. - username: - readOnly: true - description: Output only. The username associated to this token. - type: string - description: >- - Represents a personal access token that authorized the Connection, and - associated metadata. - id: UserCredential + A list of locations that matches the specified filter in the + request. + type: array + description: The response message for Locations.ListLocations. type: object + id: ListLocationsResponse Step: - type: object - id: Step + description: >- + Step embeds the Container type, which allows it to include fields not + provided by Container. properties: - env: - items: - $ref: '#/components/schemas/EnvVar' - description: List of environment variables to set in the container. - type: array + name: + description: Name of the container specified as a DNS_LABEL. + type: string command: - type: array - description: Entrypoint array. - items: - type: string - securityContext: - description: >- - Optional. SecurityContext defines the security options the Step - should be run with. If set, the fields of SecurityContext override - the equivalent fields of PodSecurityContext. More info: - https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - +optional - $ref: '#/components/schemas/SecurityContext' - ref: - $ref: '#/components/schemas/StepRef' - description: Optional. Optional reference to a remote StepAction. - args: - description: Arguments to the entrypoint. items: type: string type: array + description: Entrypoint array. onError: - type: string - description: >- - Optional. OnError defines the exiting behavior on error can be set - to [ continue | stopAndFail ] + enum: + - ON_ERROR_TYPE_UNSPECIFIED + - STOP_AND_FAIL + - CONTINUE enumDescriptions: - Default enum type; should not be used. - >- @@ -2302,39 +2231,56 @@ components: - >- Continue indicates continue executing the rest of the steps/tasks irrespective of the exit code - enum: - - ON_ERROR_TYPE_UNSPECIFIED - - STOP_AND_FAIL - - CONTINUE + type: string + description: >- + Optional. OnError defines the exiting behavior on error can be set + to [ continue | stopAndFail ] script: type: string description: The contents of an executable file to execute. - timeout: - description: Time after which the Step times out. Defaults to never. + workingDir: + description: Container's working directory. type: string - format: google-duration volumeMounts: + type: array + description: Pod volumes to mount into the container's filesystem. items: $ref: '#/components/schemas/VolumeMount' - description: Pod volumes to mount into the container's filesystem. - type: array - image: - type: string - description: Docker image name. - workingDir: + timeout: + format: google-duration + description: Time after which the Step times out. Defaults to never. type: string - description: Container's working directory. params: description: Optional. Optional parameters passed to the StepAction. type: array items: $ref: '#/components/schemas/Param' - name: + securityContext: + $ref: '#/components/schemas/SecurityContext' + description: >- + Optional. SecurityContext defines the security options the Step + should be run with. If set, the fields of SecurityContext override + the equivalent fields of PodSecurityContext. More info: + https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + +optional + ref: + description: Optional. Optional reference to a remote StepAction. + $ref: '#/components/schemas/StepRef' + args: + items: + type: string + description: Arguments to the entrypoint. + type: array + image: type: string - description: Name of the container specified as a DNS_LABEL. - description: >- - Step embeds the Container type, which allows it to include fields not - provided by Container. + description: Docker image name. + env: + description: List of environment variables to set in the container. + items: + $ref: '#/components/schemas/EnvVar' + type: array + id: Step + type: object Expr: type: object description: >- @@ -2353,128 +2299,182 @@ components: timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - id: Expr - properties: - description: - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string - title: - type: string - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - location: - type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - Capabilities: - description: >- - Capabilities adds and removes POSIX capabilities from running - containers. - type: object - id: Capabilities - properties: - drop: - description: Optional. Removed capabilities +optional - items: - type: string - type: array - add: - items: - type: string - type: array - description: Optional. Added capabilities +optional - BitbucketCloudConfig: - type: object - description: Configuration for connections to Bitbucket Cloud. - properties: - readAuthorizerCredential: - description: >- - Required. An access token with the `repository` access. It can be - either a workspace, project or repository access token. It's - recommended to use a system account to generate the credentials. - $ref: '#/components/schemas/UserCredential' - webhookSecretSecretVersion: + evaluates it. See the service documentation for additional information. + id: Expr + properties: + location: type: string description: >- - Required. SecretManager resource containing the webhook secret used - to verify webhook events, formatted as - `projects/*/secrets/*/versions/*`. - authorizerCredential: - $ref: '#/components/schemas/UserCredential' + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + expression: + type: string description: >- - Required. An access token with the `webhook`, `repository`, - `repository:admin` and `pullrequest` scope access. It can be either - a workspace, project or repository access token. It's recommended to - use a system account to generate these credentials. - workspace: + Textual representation of an expression in Common Expression + Language syntax. + title: + type: string description: >- - Required. The Bitbucket Cloud Workspace ID to be connected to Google - Cloud Platform. + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + description: type: string - id: BitbucketCloudConfig - Status: + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + PropertySpec: type: object + id: PropertySpec + description: PropertySpec holds information about a property in an object. properties: - message: + type: type: string + enum: + - TYPE_UNSPECIFIED + - STRING + description: A type for the object. + enumDescriptions: + - Default enum type; should not be used. + - Default + BatchCreateRepositoriesRequest: + description: Message for creating repositoritories in batch. + type: object + properties: + requests: + type: array description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: + Required. The request messages specifying the repositories to + create. items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + $ref: '#/components/schemas/CreateRepositoryRequest' + id: BatchCreateRepositoriesRequest + Policy: + properties: + bindings: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + items: + $ref: '#/components/schemas/Binding' type: array - code: + version: type: integer + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). format: int32 - description: The status code, which should be an enum value of google.rpc.Code. + auditConfigs: + type: array + description: Specifies cloud audit logging configuration for this policy. + items: + $ref: '#/components/schemas/AuditConfig' + etag: + description: >- + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + type: string + format: byte + type: object + id: Policy description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: Status + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + FetchGitRefsResponse: + id: FetchGitRefsResponse + type: object + properties: + refNames: + items: + type: string + type: array + description: Name of the refs fetched. + nextPageToken: + type: string + description: A token identifying a page of results the server should return. + description: Response for fetching git refs parameters: - _.xgafv: - description: V1 error format. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - callback: - description: JSONP + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: callback + name: fields schema: type: string access_token: @@ -2483,6 +2483,24 @@ components: name: access_token schema: type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean alt: description: Data format for response. in: query @@ -2493,33 +2511,12 @@ components: - json - media - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -2529,37 +2526,32 @@ components: name: key schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + _.xgafv: + description: V1 error format. in: query - name: prettyPrint + name: $.xgafv schema: - type: boolean + type: string + enum: + - '1' + - '2' x-stackQL-resources: connections: id: google.cloudbuild.connections name: connections title: Connections methods: - projects_locations_connections_list: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_create: + projects_locations_connections_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_patch: + projects_locations_connections_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -2570,17 +2562,25 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_delete: + projects_locations_connections_process_webhook: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:processWebhook/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_process_webhook: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:processWebhook/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + projects_locations_connections_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post response: mediaType: application/json openAPIDocKey: '200' @@ -2605,28 +2605,28 @@ components: name: connections_iam_policies title: Connections_iam_policies methods: - projects_locations_connections_test_iam_permissions: + projects_locations_connections_get_iam_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:testIamPermissions/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_set_iam_policy: + objectKey: $.bindings + projects_locations_connections_test_iam_permissions: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_get_iam_policy: + projects_locations_connections_set_iam_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:getIamPolicy/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings sqlVerbs: select: - $ref: >- @@ -2676,20 +2676,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_access_read_write_token: + projects_locations_connections_repositories_batch_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadWriteToken/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_batch_create: + projects_locations_connections_repositories_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.repositories projects_locations_connections_repositories_create: operation: $ref: >- @@ -2697,18 +2698,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_list: + projects_locations_connections_repositories_access_read_token: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadToken/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.repositories - projects_locations_connections_repositories_access_read_token: + projects_locations_connections_repositories_access_read_write_token: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadToken/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadWriteToken/post response: mediaType: application/json openAPIDocKey: '200' @@ -2780,19 +2780,19 @@ components: name: locations title: Locations methods: - projects_locations_get: + projects_locations_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_list: + objectKey: $.locations + projects_locations_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations sqlVerbs: select: - $ref: >- @@ -2804,22 +2804,27 @@ components: replace: [] delete: [] paths: - /v2/projects/{projectsId}/locations/{locationsId}/connections: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: parameters: &ref_1 - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - get: - description: Lists Connections in a given project and location. - operationId: cloudbuild.projects.locations.connections.list + - $ref: '#/components/parameters/_.xgafv' + patch: + description: Updates a single connection. + operationId: cloudbuild.projects.locations.connections.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2831,7 +2836,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -2843,23 +2848,27 @@ paths: required: true schema: type: string + - in: path + name: connectionsId + required: true + schema: + type: string - in: query - name: pageToken + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: pageSize + name: etag schema: - type: integer - format: int32 - post: - description: Creates a Connection. - operationId: cloudbuild.projects.locations.connections.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + type: string + - in: query + name: allowMissing + schema: + type: boolean + delete: + description: Deletes a single connection. + operationId: cloudbuild.projects.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2883,25 +2892,22 @@ paths: required: true schema: type: string + - in: path + name: connectionsId + required: true + schema: + type: string - in: query - name: connectionId + name: etag schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: - parameters: *ref_1 - post: - 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. - operationId: cloudbuild.projects.locations.connections.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Gets details of a single connection. + operationId: cloudbuild.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2913,7 +2919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Connection' parameters: - in: path name: projectsId @@ -2930,16 +2936,13 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: parameters: *ref_1 - patch: - description: Updates a single connection. - operationId: cloudbuild.projects.locations.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: cloudbuild.projects.locations.connections.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2951,7 +2954,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -2969,21 +2972,25 @@ paths: schema: type: string - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: etag + name: options.requestedPolicyVersion schema: - type: string - get: - description: Gets details of a single connection. - operationId: cloudbuild.projects.locations.connections.get + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: + parameters: *ref_1 + post: + 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. + operationId: cloudbuild.projects.locations.connections.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2995,7 +3002,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -3012,21 +3019,24 @@ paths: required: true schema: type: string - delete: - description: Deletes a single connection. - operationId: cloudbuild.projects.locations.connections.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform + /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: + parameters: *ref_1 + post: + description: ProcessWebhook is called by the external SCM for notifying of events. + operationId: cloudbuild.projects.locations.connections.processWebhook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + security: [] responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -3038,26 +3048,15 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - - in: query - name: validateOnly - schema: - type: boolean - in: query - name: etag + name: webhookKey schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableRepositories: + /v2/projects/{projectsId}/locations/{locationsId}/connections: parameters: *ref_1 get: - description: >- - FetchLinkableRepositories get repositories from SCM that are accessible - and could be added to the connection. - operationId: cloudbuild.projects.locations.connections.fetchLinkableRepositories + description: Lists Connections in a given project and location. + operationId: cloudbuild.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3069,7 +3068,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchLinkableRepositoriesResponse' + $ref: '#/components/schemas/ListConnectionsResponse' parameters: - in: path name: projectsId @@ -3081,11 +3080,6 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -3095,24 +3089,26 @@ paths: name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: - parameters: *ref_1 post: - description: ProcessWebhook is called by the external SCM for notifying of events. - operationId: cloudbuild.projects.locations.connections.processWebhook + description: Creates a Connection. + operationId: cloudbuild.projects.locations.connections.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpBody' - security: [] + $ref: '#/components/schemas/Connection' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3125,22 +3121,16 @@ paths: schema: type: string - in: query - name: webhookKey + name: connectionId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableRepositories: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: cloudbuild.projects.locations.connections.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + FetchLinkableRepositories get repositories from SCM that are accessible + and could be added to the connection. + operationId: cloudbuild.projects.locations.connections.fetchLinkableRepositories security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3152,7 +3142,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/FetchLinkableRepositoriesResponse' parameters: - in: path name: projectsId @@ -3169,13 +3159,28 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: parameters: *ref_1 - get: + post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: cloudbuild.projects.locations.connections.getIamPolicy + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: cloudbuild.projects.locations.connections.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3204,11 +3209,6 @@ paths: required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}: parameters: *ref_1 get: @@ -3283,19 +3283,24 @@ paths: required: true schema: type: string - - in: query - name: etag - schema: - type: string - in: query name: validateOnly schema: type: boolean - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: + - in: query + name: etag + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: parameters: *ref_1 - get: - description: Fetch the list of branches or tags for a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs + post: + description: Creates multiple repositories inside a connection. + operationId: cloudbuild.projects.locations.connections.repositories.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateRepositoriesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3307,7 +3312,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchGitRefsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3324,35 +3329,11 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - - in: query - name: refType - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: parameters: *ref_1 - post: - description: Fetches read/write token of a given repository. - operationId: >- - cloudbuild.projects.locations.connections.repositories.accessReadWriteToken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FetchReadWriteTokenRequest' + get: + description: Lists Repositories in a given connection. + operationId: cloudbuild.projects.locations.connections.repositories.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3364,7 +3345,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadWriteTokenResponse' + $ref: '#/components/schemas/ListRepositoriesResponse' parameters: - in: path name: projectsId @@ -3381,21 +3362,27 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true + - in: query + name: filter schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Creates multiple repositories inside a connection. - operationId: cloudbuild.projects.locations.connections.repositories.batchCreate + description: Creates a Repository. + operationId: cloudbuild.projects.locations.connections.repositories.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateRepositoriesRequest' + $ref: '#/components/schemas/Repository' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3424,16 +3411,20 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: + - in: query + name: repositoryId + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: parameters: *ref_1 post: - description: Creates a Repository. - operationId: cloudbuild.projects.locations.connections.repositories.create + description: Fetches read token of a given repository. + operationId: cloudbuild.projects.locations.connections.repositories.accessReadToken requestBody: content: application/json: schema: - $ref: '#/components/schemas/Repository' + $ref: '#/components/schemas/FetchReadTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3445,7 +3436,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchReadTokenResponse' parameters: - in: path name: projectsId @@ -3462,13 +3453,22 @@ paths: required: true schema: type: string - - in: query - name: repositoryId + - in: path + name: repositoriesId + required: true schema: type: string - get: - description: Lists Repositories in a given connection. - operationId: cloudbuild.projects.locations.connections.repositories.list + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: + parameters: *ref_1 + post: + description: Fetches read/write token of a given repository. + operationId: >- + cloudbuild.projects.locations.connections.repositories.accessReadWriteToken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FetchReadWriteTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3480,7 +3480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListRepositoriesResponse' + $ref: '#/components/schemas/FetchReadWriteTokenResponse' parameters: - in: path name: projectsId @@ -3497,29 +3497,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: repositoriesId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: parameters: *ref_1 - post: - description: Fetches read token of a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.accessReadToken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FetchReadTokenRequest' + get: + description: Fetch the list of branches or tags for a given repository. + operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3531,7 +3518,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadTokenResponse' + $ref: '#/components/schemas/FetchGitRefsResponse' parameters: - in: path name: projectsId @@ -3553,6 +3540,19 @@ paths: required: true schema: type: string + - in: query + name: refType + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: @@ -3636,11 +3636,11 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}: + /v2/projects/{projectsId}/locations: parameters: *ref_1 get: - description: Gets information about a location. - operationId: cloudbuild.projects.locations.get + description: Lists information about the supported locations for this service. + operationId: cloudbuild.projects.locations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3652,23 +3652,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/ListLocationsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: filter schema: type: string - /v2/projects/{projectsId}/locations: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: - description: Lists information about the supported locations for this service. - operationId: cloudbuild.projects.locations.list + description: Gets information about a location. + operationId: cloudbuild.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3680,23 +3688,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListLocationsResponse' + $ref: '#/components/schemas/Location' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml index ae878742..d3b6336a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml @@ -34,39 +34,174 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ListAccountsResponse: - description: Response message for [PartnerProcurementService.ListAccounts[]. + ListEntitlementsResponse: + description: Response message for PartnerProcurementService.ListEntitlements. + id: ListEntitlementsResponse properties: + entitlements: + description: The list of entitlements in this response. + items: + $ref: '#/components/schemas/Entitlement' + type: array nextPageToken: description: The token for fetching the next page. type: string - accounts: - type: array - description: The list of accounts in this response. + type: object + SuspendEntitlementRequest: + type: object + id: SuspendEntitlementRequest + properties: + reason: + type: string + description: >- + A free-form reason string, explaining the reason for suspension + request. + description: >- + Request message for ParterProcurementService.SuspendEntitlement. This is + not yet supported. + Account: + description: >- + Represents an account that was established by the customer on the + service provider's system. + type: object + properties: + createTime: + type: string + description: Output only. The creation timestamp. + format: google-datetime + updateTime: + format: google-datetime + type: string + description: Output only. The last update timestamp. + inputProperties: + type: object + description: >- + Output only. The custom properties that were collected from the user + to create this account. + additionalProperties: + description: Properties of the object. + type: any + deprecated: true + approvals: + description: >- + Output only. The approvals for this account. These approvals are + used to track actions that are permitted or have been completed by a + customer within the context of the provider. This might include a + sign up flow or a provisioning step, for example, that the provider + can admit to having happened. items: - $ref: '#/components/schemas/Account' - id: ListAccountsResponse + $ref: '#/components/schemas/Approval' + type: array + provider: + type: string + description: >- + Output only. The identifier of the service provider that this + account was created against. Each service provider is assigned a + unique provider value when they onboard with Cloud Commerce + platform. + state: + type: string + enum: + - ACCOUNT_STATE_UNSPECIFIED + - ACCOUNT_ACTIVATION_REQUESTED + - ACCOUNT_ACTIVE + description: >- + Output only. The state of the account. This is used to decide + whether the customer is in good standing with the provider and is + able to make purchases. An account might not be able to make a + purchase if the billing account is suspended, for example. + enumDescriptions: + - >- + Default state of the account. It's only set to this value when the + account is first created and has not been initialized. + - >- + The customer has requested the creation of the account resource, + and the provider notification message is dispatched. This state + has been deprecated, as accounts now immediately transition to + AccountState.ACCOUNT_ACTIVE. + - >- + The account is active and ready for use. The next possible states + are: - Account getting deleted: After the user invokes delete from + another API. + name: + description: >- + Output only. The resource name of the account. Account names have + the form `accounts/{account_id}`. + type: string + id: Account + ResetAccountRequest: + description: Request message for PartnerProcurementService.ResetAccount. + id: ResetAccountRequest type: object - Entitlement: - id: Entitlement + properties: {} + ApproveEntitlementRequest: type: object - description: Represents a procured product of a customer. + description: Request message for [PartnerProcurementService.ApproveEntitlement[]. + id: ApproveEntitlementRequest properties: - product: + properties: + description: >- + Set of properties that should be associated with the entitlement. + Optional. + type: object + additionalProperties: + type: string deprecated: true + entitlementMigrated: + type: string description: >- - Output only. The identifier of the entity that was purchased. This - may actually represent a product, quote, or offer. We strongly - recommend that you use the following more explicit fields: - productExternalName, quoteExternalName, or offer. + Optional. The resource name of the entitlement that was migrated, + with the format + `providers/{provider_id}/entitlements/{entitlement_id}`. Should only + be sent when resources have been migrated from entitlement_migrated + to the new entitlement. Optional. + ApproveAccountRequest: + description: Request message for PartnerProcurementService.ApproveAccount. + properties: + approvalName: + description: >- + The name of the approval being approved. If absent and there is only + one approval possible, that approval will be granted. If absent and + there are many approvals possible, the request will fail with a 400 + Bad Request. Optional. type: string - orderId: + reason: + description: >- + Free form text string explaining the approval reason. Optional. Max + allowed length: 256 bytes. Longer strings will be truncated. + type: string + properties: + type: object + additionalProperties: + type: string + description: >- + Set of properties that should be associated with the account. + Optional. + type: object + id: ApproveAccountRequest + Entitlement: + type: object + id: Entitlement + description: Represents a procured product of a customer. + properties: + provider: + type: string + description: >- + Output only. The identifier of the service provider that this + entitlement was created against. Each service provider is assigned a + unique provider value when they onboard with Cloud Commerce + platform. + productExternalName: readOnly: true + type: string + description: Output only. The identifier of the product that was procured. + newPendingPlan: description: >- - Output only. The order ID of this entitlement, without any `orders/` - resource name prefix. + Output only. The identifier of the pending new plan. Required if the + product has plans and the entitlement has a pending plan change. type: string newPendingOfferDuration: + readOnly: true type: string description: >- Output only. The duration of the new offer, in ISO 8601 duration @@ -74,39 +209,9 @@ components: active yet, only for pending offer changes. If the offer was created with a specified end date instead of a duration, this field is empty. - readOnly: true - subscriptionEndTime: - description: >- - Output only. End time for the subscription corresponding to this - entitlement. - format: google-datetime - type: string - readOnly: true - cancellationReason: - description: >- - Output only. The reason the entitlement was cancelled. If this - entitlement wasn't cancelled, this field is empty. Possible values - include "unknown", "expired", "user-cancelled", "account-closed", - "billing-disabled" (if the customer has manually disabled billing to - their resources), "user-aborted", and "migrated" (if the entitlement - has migrated across products). Values of this field are subject to - change, and we recommend that you don't build your technical - integration to rely on these fields. - readOnly: true - type: string - messageToUser: - type: string - description: >- - Provider-supplied message that is displayed to the end user. - Currently this is used to communicate progress and ETA for - provisioning. This field can be updated only when a user is waiting - for an action from the provider, i.e. entitlement state is - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This - field is cleared automatically when the entitlement state changes. offer: - readOnly: true type: string + readOnly: true description: >- Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: @@ -117,8 +222,46 @@ components: the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + createTime: + type: string + description: Output only. The creation timestamp. + format: google-datetime + quoteExternalName: + type: string + readOnly: true + description: >- + Output only. The identifier of the quote that was used to procure. + Empty if the order is not purchased using a quote. + consumers: + description: Output only. The resources using this entitlement, if applicable. + items: + $ref: '#/components/schemas/Consumer' + type: array + newOfferEndTime: + type: string + format: google-datetime + description: >- + Output only. The end time of the new offer. If the offer was created + with a term instead of a specified end date, this field is empty. + This field is populated even if the entitlement isn't active yet. If + there's no upcoming offer, the field is be empty. + readOnly: true + name: + type: string + description: >- + Output only. The resource name of the entitlement. Entitlement names + have the form + `providers/{provider_id}/entitlements/{entitlement_id}`. + subscriptionEndTime: + description: >- + Output only. End time for the subscription corresponding to this + entitlement. + readOnly: true + type: string + format: google-datetime state: type: string + description: Output only. The state of the entitlement. enumDescriptions: - >- Default state of the entitlement. It's only set to this value when @@ -181,7 +324,6 @@ components: violation of terms-of-service of the provider etc.). As such, any remediating action needs to be taken externally, before the entitlement can be activated. This is not yet supported. - description: Output only. The state of the entitlement. enum: - ENTITLEMENT_STATE_UNSPECIFIED - ENTITLEMENT_ACTIVATION_REQUESTED @@ -191,60 +333,92 @@ components: - ENTITLEMENT_PENDING_PLAN_CHANGE - ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL - ENTITLEMENT_SUSPENDED - createTime: - description: Output only. The creation timestamp. + usageReportingId: + description: >- + Output only. The consumerId to use when reporting usage through the + Service Control API. See the consumerId field at [Reporting + Metrics](https://cloud.google.com/service-control/reporting-metrics) + for more details. This field is present only if the product has + usage-based billing configured. type: string - format: google-datetime updateTime: - type: string - format: google-datetime description: Output only. The last update timestamp. - consumers: - items: - $ref: '#/components/schemas/Consumer' - type: array - description: Output only. The resources using this entitlement, if applicable. - newOfferEndTime: - description: >- - Output only. The end time of the new offer. If the offer was created - with a term instead of a specified end date, this field is empty. - This field is populated even if the entitlement isn't active yet. If - there's no upcoming offer, the field is be empty. format: google-datetime + type: string + cancellationReason: readOnly: true type: string - name: + description: >- + Output only. The reason the entitlement was cancelled. If this + entitlement wasn't cancelled, this field is empty. Possible values + include "unknown", "expired", "user-cancelled", "account-closed", + "billing-disabled" (if the customer has manually disabled billing to + their resources), "user-aborted", and "migrated" (if the entitlement + has migrated across products). Values of this field are subject to + change, and we recommend that you don't build your technical + integration to rely on these fields. + offerDuration: type: string + readOnly: true description: >- - Output only. The resource name of the entitlement. Entitlement names - have the form - `providers/{provider_id}/entitlements/{entitlement_id}`. - newPendingPlan: + Output only. The offer duration of the current offer in ISO 8601 + duration format. Field is empty if entitlement was not made using an + offer. If the offer was created with a specified end date instead of + a duration, this field is empty. + product: description: >- - Output only. The identifier of the pending new plan. Required if the - product has plans and the entitlement has a pending plan change. + Output only. The identifier of the entity that was purchased. This + may actually represent a product, quote, or offer. We strongly + recommend that you use the following more explicit fields: + productExternalName, quoteExternalName, or offer. + deprecated: true type: string - quoteExternalName: + inputProperties: + deprecated: true + type: object description: >- - Output only. The identifier of the quote that was used to procure. - Empty if the order is not purchased using a quote. + Output only. The custom properties that were collected from the user + to create this entitlement. + additionalProperties: + type: any + description: Properties of the object. + account: + description: >- + Output only. The resource name of the account that this entitlement + is based on, if any. + type: string + entitlementBenefitIds: + description: >- + Output only. The entitlement benefit IDs associated with the + purchase. readOnly: true + items: + type: string + type: array + messageToUser: + description: >- + Provider-supplied message that is displayed to the end user. + Currently this is used to communicate progress and ETA for + provisioning. This field can be updated only when a user is waiting + for an action from the provider, i.e. entitlement state is + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This + field is cleared automatically when the entitlement state changes. type: string - usageReportingId: + orderId: type: string description: >- - Output only. The consumerId to use when reporting usage through the - Service Control API. See the consumerId field at [Reporting - Metrics](https://cloud.google.com/service-control/reporting-metrics) - for more details. This field is present only if the product has - usage-based billing configured. - provider: - type: string + Output only. The order ID of this entitlement, without any `orders/` + resource name prefix. + readOnly: true + newOfferStartTime: description: >- - Output only. The identifier of the service provider that this - entitlement was created against. Each service provider is assigned a - unique provider value when they onboard with Cloud Commerce - platform. + Output only. The timestamp when the new offer becomes effective. + This field is populated even if the entitlement isn't active yet. If + there's no upcoming offer, the field is empty. + type: string + readOnly: true + format: google-datetime plan: description: >- Output only. The identifier of the plan that was procured. Required @@ -253,41 +427,13 @@ components: offerEndTime: readOnly: true type: string + format: google-datetime description: >- Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer. - format: google-datetime - offerDuration: - readOnly: true - description: >- - Output only. The offer duration of the current offer in ISO 8601 - duration format. Field is empty if entitlement was not made using an - offer. If the offer was created with a specified end date instead of - a duration, this field is empty. - type: string - newOfferStartTime: - format: google-datetime - type: string - readOnly: true - description: >- - Output only. The timestamp when the new offer becomes effective. - This field is populated even if the entitlement isn't active yet. If - there's no upcoming offer, the field is empty. - inputProperties: - additionalProperties: - description: Properties of the object. - type: any - type: object - deprecated: true - description: >- - Output only. The custom properties that were collected from the user - to create this entitlement. - productExternalName: - description: Output only. The identifier of the product that was procured. - readOnly: true - type: string newPendingOffer: + readOnly: true type: string description: >- Output only. The name of the offer the entitlement is switching to @@ -301,285 +447,130 @@ components: the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. - readOnly: true - entitlementBenefitIds: - type: array - readOnly: true - items: - type: string - description: >- - Output only. The entitlement benefit IDs associated with the - purchase. - account: - type: string - description: >- - Output only. The resource name of the account that this entitlement - is based on, if any. - Consumer: - type: object - description: A resource using (consuming) this entitlement. + Approval: + id: Approval + description: An approval for some action on an account. properties: - project: - description: A project name with format `projects/`. + name: + description: Output only. The name of the approval. type: string - id: Consumer - Empty: - properties: {} - 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 + state: + enumDescriptions: + - Sentinel value; do not use. + - >- + The approval is pending response from the provider. The approval + state can transition to Account.Approval.State.APPROVED or + Account.Approval.State.REJECTED. + - The approval has been granted by the provider. + - >- + The approval has been rejected by the provider. A provider may + choose to approve a previously rejected approval, so is it + possible to transition to Account.Approval.State.APPROVED. + enum: + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + type: string + description: Output only. The state of the approval. + reason: + description: Output only. An explanation for the state of the approval. + type: string + updateTime: + type: string + description: Optional. The last update timestamp of the approval. + format: google-datetime type: object ApproveEntitlementPlanChangeRequest: properties: pendingPlanName: - description: Required. Name of the pending plan that's being approved. type: string + description: Required. Name of the pending plan that's being approved. type: object id: ApproveEntitlementPlanChangeRequest description: >- Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[]. - RejectAccountRequest: - description: Request message for PartnerProcurementService.RejectAccount. - properties: - reason: - type: string - description: >- - Free form text string explaining the rejection reason. Max allowed - length: 256 bytes. Longer strings will be truncated. - approvalName: - type: string - description: >- - The name of the approval being rejected. If absent and there is only - one approval possible, that approval will be rejected. If absent and - there are many approvals possible, the request will fail with a 400 - Bad Request. Optional. - type: object - id: RejectAccountRequest - ListEntitlementsResponse: - properties: - entitlements: - description: The list of entitlements in this response. - type: array - items: - $ref: '#/components/schemas/Entitlement' - nextPageToken: - type: string - description: The token for fetching the next page. - description: Response message for PartnerProcurementService.ListEntitlements. - id: ListEntitlementsResponse - type: object - ResetAccountRequest: - properties: {} - description: Request message for PartnerProcurementService.ResetAccount. - id: ResetAccountRequest - type: object RejectEntitlementPlanChangeRequest: properties: pendingPlanName: - description: Required. Name of the pending plan that is being rejected. type: string + description: Required. Name of the pending plan that is being rejected. reason: type: string description: >- Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. + type: object + id: RejectEntitlementPlanChangeRequest description: >- Request message for PartnerProcurementService.RejectEntitlementPlanChange. - id: RejectEntitlementPlanChangeRequest - type: object - ApproveAccountRequest: - description: Request message for PartnerProcurementService.ApproveAccount. - type: object - id: ApproveAccountRequest + RejectAccountRequest: + id: RejectAccountRequest properties: - reason: - description: >- - Free form text string explaining the approval reason. Optional. Max - allowed length: 256 bytes. Longer strings will be truncated. - type: string approvalName: type: string description: >- - The name of the approval being approved. If absent and there is only - one approval possible, that approval will be granted. If absent and + The name of the approval being rejected. If absent and there is only + one approval possible, that approval will be rejected. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional. - properties: + reason: description: >- - Set of properties that should be associated with the account. - Optional. - type: object - additionalProperties: - type: string - ApproveEntitlementRequest: + Free form text string explaining the rejection reason. Max allowed + length: 256 bytes. Longer strings will be truncated. + type: string + description: Request message for PartnerProcurementService.RejectAccount. + 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); } + type: object + properties: {} + id: Empty + ListAccountsResponse: + id: ListAccountsResponse properties: - properties: - type: object - deprecated: true - additionalProperties: - type: string - description: >- - Set of properties that should be associated with the entitlement. - Optional. - entitlementMigrated: + nextPageToken: + description: The token for fetching the next page. type: string - description: >- - Optional. The resource name of the entitlement that was migrated, - with the format - `providers/{provider_id}/entitlements/{entitlement_id}`. Should only - be sent when resources have been migrated from entitlement_migrated - to the new entitlement. Optional. - id: ApproveEntitlementRequest - description: Request message for [PartnerProcurementService.ApproveEntitlement[]. + accounts: + description: The list of accounts in this response. + items: + $ref: '#/components/schemas/Account' + type: array type: object + description: Response message for [PartnerProcurementService.ListAccounts[]. RejectEntitlementRequest: - type: object properties: reason: type: string description: >- Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. - id: RejectEntitlementRequest description: Request message for PartnerProcurementService.RejectEntitlement. - SuspendEntitlementRequest: - id: SuspendEntitlementRequest + id: RejectEntitlementRequest type: object - description: >- - Request message for ParterProcurementService.SuspendEntitlement. This is - not yet supported. - properties: - reason: - description: >- - A free-form reason string, explaining the reason for suspension - request. - type: string - Account: - properties: - inputProperties: - description: >- - Output only. The custom properties that were collected from the user - to create this account. - type: object - additionalProperties: - description: Properties of the object. - type: any - deprecated: true - createTime: - type: string - format: google-datetime - description: Output only. The creation timestamp. - state: - enum: - - ACCOUNT_STATE_UNSPECIFIED - - ACCOUNT_ACTIVATION_REQUESTED - - ACCOUNT_ACTIVE - type: string - description: >- - Output only. The state of the account. This is used to decide - whether the customer is in good standing with the provider and is - able to make purchases. An account might not be able to make a - purchase if the billing account is suspended, for example. - enumDescriptions: - - >- - Default state of the account. It's only set to this value when the - account is first created and has not been initialized. - - >- - The customer has requested the creation of the account resource, - and the provider notification message is dispatched. This state - has been deprecated, as accounts now immediately transition to - AccountState.ACCOUNT_ACTIVE. - - >- - The account is active and ready for use. The next possible states - are: - Account getting deleted: After the user invokes delete from - another API. - updateTime: - format: google-datetime - type: string - description: Output only. The last update timestamp. - provider: - description: >- - Output only. The identifier of the service provider that this - account was created against. Each service provider is assigned a - unique provider value when they onboard with Cloud Commerce - platform. - type: string - name: - description: >- - Output only. The resource name of the account. Account names have - the form `accounts/{account_id}`. - type: string - approvals: - items: - $ref: '#/components/schemas/Approval' - description: >- - Output only. The approvals for this account. These approvals are - used to track actions that are permitted or have been completed by a - customer within the context of the provider. This might include a - sign up flow or a provisioning step, for example, that the provider - can admit to having happened. - type: array + Consumer: type: object - id: Account - description: >- - Represents an account that was established by the customer on the - service provider's system. - Approval: - description: An approval for some action on an account. properties: - updateTime: - type: string - description: Optional. The last update timestamp of the approval. - format: google-datetime - reason: - type: string - description: Output only. An explanation for the state of the approval. - name: - type: string - description: Output only. The name of the approval. - state: - description: Output only. The state of the approval. - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - enumDescriptions: - - Sentinel value; do not use. - - >- - The approval is pending response from the provider. The approval - state can transition to Account.Approval.State.APPROVED or - Account.Approval.State.REJECTED. - - The approval has been granted by the provider. - - >- - The approval has been rejected by the provider. A provider may - choose to approve a previously rejected approval, so is it - possible to transition to Account.Approval.State.APPROVED. + project: + description: A project name with format `projects/`. type: string - id: Approval - type: object + id: Consumer + description: A resource using (consuming) this entitlement. parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: upload_protocol + name: quotaUser schema: type: string fields: @@ -588,12 +579,6 @@ components: name: fields schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -603,6 +588,12 @@ components: enum: - '1' - '2' + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -612,6 +603,18 @@ components: name: key schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean alt: description: Data format for response. in: query @@ -622,68 +625,77 @@ components: - json - media - proto - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: quotaUser + name: oauth_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean + type: string x-stackQL-resources: - entitlements: - id: google.cloudcommerceprocurement.entitlements - name: entitlements - title: Entitlements + accounts: + id: google.cloudcommerceprocurement.accounts + name: accounts + title: Accounts methods: - approve: + list: operation: - $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post + $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts/get' response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.accounts + reject: operation: - $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reject/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.entitlements - reject: + approve: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:approve/post response: mediaType: application/json openAPIDocKey: '200' - suspend: + reset: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:suspend/post + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reset/post response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/get + $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}/get' response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accounts/methods/get' + - $ref: '#/components/x-stackQL-resources/accounts/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + entitlements: + id: google.cloudcommerceprocurement.entitlements + name: entitlements + title: Entitlements + methods: patch: operation: $ref: >- @@ -691,10 +703,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - approve_plan_change: + get: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -705,88 +717,67 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/entitlements/methods/get' - - $ref: '#/components/x-stackQL-resources/entitlements/methods/list' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/entitlements/methods/patch' - replace: [] - delete: [] - accounts: - id: google.cloudcommerceprocurement.accounts - name: accounts - title: Accounts - methods: - reset: + suspend: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reset/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:suspend/post response: mediaType: application/json openAPIDocKey: '200' - get: + approve_plan_change: operation: - $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}/get' + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts/get' + $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.accounts + objectKey: $.entitlements approve: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:approve/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post response: mediaType: application/json openAPIDocKey: '200' reject: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reject/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/accounts/methods/get' - - $ref: '#/components/x-stackQL-resources/accounts/methods/list' + - $ref: '#/components/x-stackQL-resources/entitlements/methods/get' + - $ref: '#/components/x-stackQL-resources/entitlements/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/patch' replace: [] delete: [] paths: - /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: + /v1/providers/{providersId}/accounts: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/prettyPrint' - post: - description: >- - Approves an entitlement that is in the - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is - invoked by the provider to approve the creation of the entitlement - resource. - operationId: cloudcommerceprocurement.providers.entitlements.approve - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApproveEntitlementRequest' + get: + description: Lists Accounts that the provider has access to. + operationId: cloudcommerceprocurement.providers.accounts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -798,23 +789,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListAccountsResponse' parameters: - in: path name: providersId required: true schema: type: string - - in: path - name: entitlementsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/providers/{providersId}/entitlements: + /v1/providers/{providersId}/accounts/{accountsId}:reject: parameters: *ref_1 - get: - description: Lists Entitlements for which the provider has read access. - operationId: cloudcommerceprocurement.providers.entitlements.list + post: + description: Rejects an approval on an Account. + operationId: cloudcommerceprocurement.providers.accounts.reject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -826,40 +826,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListEntitlementsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: accountsId + required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: + /v1/providers/{providersId}/accounts/{accountsId}:approve: parameters: *ref_1 post: - description: >- - Rejects an entitlement that is in the - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is - invoked by the provider to reject the creation of the entitlement - resource. - operationId: cloudcommerceprocurement.providers.entitlements.reject + description: Grants an approval on an Account. + operationId: cloudcommerceprocurement.providers.accounts.approve requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectEntitlementRequest' + $ref: '#/components/schemas/ApproveAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -879,20 +867,22 @@ paths: schema: type: string - in: path - name: entitlementsId + name: accountsId required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:suspend: + /v1/providers/{providersId}/accounts/{accountsId}:reset: parameters: *ref_1 post: - description: Requests suspension of an active Entitlement. This is not yet supported. - operationId: cloudcommerceprocurement.providers.entitlements.suspend + description: >- + Resets an Account and cancels all associated Entitlements. Partner can + only reset accounts they own rather than customer accounts. + operationId: cloudcommerceprocurement.providers.accounts.reset requestBody: content: application/json: schema: - $ref: '#/components/schemas/SuspendEntitlementRequest' + $ref: '#/components/schemas/ResetAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -912,15 +902,15 @@ paths: schema: type: string - in: path - name: entitlementsId + name: accountsId required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}: + /v1/providers/{providersId}/accounts/{accountsId}: parameters: *ref_1 get: - description: Gets a requested Entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.get + description: Gets a requested Account resource. + operationId: cloudcommerceprocurement.providers.accounts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -932,7 +922,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/Account' parameters: - in: path name: providersId @@ -940,10 +930,12 @@ paths: schema: type: string - in: path - name: entitlementsId + name: accountsId required: true schema: type: string + /v1/providers/{providersId}/entitlements/{entitlementsId}: + parameters: *ref_1 patch: description: Updates an existing Entitlement. operationId: cloudcommerceprocurement.providers.entitlements.patch @@ -980,20 +972,9 @@ paths: schema: type: string format: google-fieldmask - /v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange: - parameters: *ref_1 - post: - description: >- - Approves an entitlement plan change that is in the - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This - method is invoked by the provider to approve the plan change on the - entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.approvePlanChange - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApproveEntitlementPlanChangeRequest' + get: + description: Gets a requested Entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1005,7 +986,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Entitlement' parameters: - in: path name: providersId @@ -1054,18 +1035,16 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:reset: + /v1/providers/{providersId}/entitlements/{entitlementsId}:suspend: parameters: *ref_1 post: - description: >- - Resets an Account and cancels all associated Entitlements. Partner can - only reset accounts they own rather than customer accounts. - operationId: cloudcommerceprocurement.providers.accounts.reset + description: Requests suspension of an active Entitlement. This is not yet supported. + operationId: cloudcommerceprocurement.providers.entitlements.suspend requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResetAccountRequest' + $ref: '#/components/schemas/SuspendEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1085,15 +1064,24 @@ paths: schema: type: string - in: path - name: accountsId + name: entitlementsId required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}: + /v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange: parameters: *ref_1 - get: - description: Gets a requested Account resource. - operationId: cloudcommerceprocurement.providers.accounts.get + post: + description: >- + Approves an entitlement plan change that is in the + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This + method is invoked by the provider to approve the plan change on the + entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.approvePlanChange + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApproveEntitlementPlanChangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1105,7 +1093,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Account' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -1113,15 +1101,15 @@ paths: schema: type: string - in: path - name: accountsId + name: entitlementsId required: true schema: type: string - /v1/providers/{providersId}/accounts: + /v1/providers/{providersId}/entitlements: parameters: *ref_1 get: - description: Lists Accounts that the provider has access to. - operationId: cloudcommerceprocurement.providers.accounts.list + description: Lists Entitlements for which the provider has read access. + operationId: cloudcommerceprocurement.providers.entitlements.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1133,13 +1121,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAccountsResponse' + $ref: '#/components/schemas/ListEntitlementsResponse' parameters: - in: path name: providersId required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -1149,16 +1141,20 @@ paths: name: pageToken schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:approve: + /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: parameters: *ref_1 post: - description: Grants an approval on an Account. - operationId: cloudcommerceprocurement.providers.accounts.approve + description: >- + Approves an entitlement that is in the + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is + invoked by the provider to approve the creation of the entitlement + resource. + operationId: cloudcommerceprocurement.providers.entitlements.approve requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApproveAccountRequest' + $ref: '#/components/schemas/ApproveEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1178,20 +1174,24 @@ paths: schema: type: string - in: path - name: accountsId + name: entitlementsId required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:reject: + /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: parameters: *ref_1 post: - description: Rejects an approval on an Account. - operationId: cloudcommerceprocurement.providers.accounts.reject + description: >- + Rejects an entitlement that is in the + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is + invoked by the provider to reject the creation of the entitlement + resource. + operationId: cloudcommerceprocurement.providers.entitlements.reject requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectAccountRequest' + $ref: '#/components/schemas/RejectEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1211,7 +1211,7 @@ paths: schema: type: string - in: path - name: accountsId + name: entitlementsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml index b660544e..06cf921f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml @@ -36,306 +36,249 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SearchCasesResponse: - id: SearchCasesResponse + ListAttachmentsResponse: + id: ListAttachmentsResponse + type: object + description: The response message for the ListAttachments endpoint. properties: - cases: - items: - $ref: '#/components/schemas/Case' + attachments: type: array - description: >- - The list of cases associated with the parent after any filters have - been applied. + description: The list of attachments associated with a case. + items: + $ref: '#/components/schemas/Attachment' nextPageToken: description: >- A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.search` requests. If - unspecified, there are no more results to retrieve. + `page_token` field of subsequent `cases.attachments.list` requests. + If unspecified, there are no more results to retrieve. type: string - description: The response message for the SearchCases endpoint. + Media: + id: Media type: object - DiffUploadResponse: - description: '# gdata.* are outside protos with mising documentation' properties: - originalObject: + hashVerified: description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - objectVersion: + type: boolean + diffVersionResponse: + $ref: '#/components/schemas/DiffVersionResponse' + description: '# gdata.* are outside protos with mising documentation' + length: + format: int64 + description: '# gdata.* are outside protos with mising documentation' + type: string + path: type: string description: '# gdata.* are outside protos with mising documentation' - id: DiffUploadResponse - type: object - DiffUploadRequest: - description: '# gdata.* are outside protos with mising documentation' - type: object - properties: - objectVersion: + bigstoreObjectRef: + format: byte + description: '# gdata.* are outside protos with mising documentation' type: string + deprecated: true + compositeMedia: + type: array description: '# gdata.* are outside protos with mising documentation' - objectInfo: + items: + $ref: '#/components/schemas/CompositeMedia' + contentType: + type: string description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - checksumsInfo: + filename: description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - id: DiffUploadRequest - DownloadParameters: - type: object - description: '# gdata.* are outside protos with mising documentation' - properties: - ignoreRange: - type: boolean + type: string + token: + type: string description: '# gdata.* are outside protos with mising documentation' - allowGzipCompression: + diffUploadRequest: + $ref: '#/components/schemas/DiffUploadRequest' description: '# gdata.* are outside protos with mising documentation' - type: boolean - id: DownloadParameters - WorkflowOperationMetadata: - description: Metadata about the operation. Used to lookup the current status. - id: WorkflowOperationMetadata - properties: - workflowOperationType: - enum: - - UNKNOWN_OPERATION_TYPE - - WORKFLOWS_V1 - - WORKFLOWS_V2 + algorithm: + description: '# gdata.* are outside protos with mising documentation' + deprecated: true type: string - description: Which version of the workflow service this operation came from. - enumDescriptions: - - Unknown version. - - Version 1. - - Version 2. - operationAction: + hash: + type: string + description: '# gdata.* are outside protos with mising documentation' + deprecated: true + referenceType: enumDescriptions: - - Operation action is not specified. - - Operation pertains to the creation of a new support account. - - Operation pertains to the updating of an existing support account. - - >- - Operation pertains to the purchasing of a support plan that may - either create or update a support account. + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' type: string + description: '# gdata.* are outside protos with mising documentation' enum: - - OPERATION_ACTION_UNSPECIFIED - - CREATE_SUPPORT_ACCOUNT - - UPDATE_SUPPORT_ACCOUNT - - PURCHASE_SUPPORT_ACCOUNT - description: The type of action the operation is classified as. - namespace: + - PATH + - BLOB_REF + - INLINE + - GET_MEDIA + - COMPOSITE_MEDIA + - BIGSTORE_REF + - DIFF_VERSION_RESPONSE + - DIFF_CHECKSUMS_RESPONSE + - DIFF_DOWNLOAD_RESPONSE + - DIFF_UPLOAD_REQUEST + - DIFF_UPLOAD_RESPONSE + - COSMO_BINARY_REFERENCE + - ARBITRARY_BYTES + isPotentialRetry: + type: boolean + description: '# gdata.* are outside protos with mising documentation' + contentTypeInfo: + $ref: '#/components/schemas/ContentTypeInfo' + description: '# gdata.* are outside protos with mising documentation' + blobstore2Info: + $ref: '#/components/schemas/Blobstore2Info' + description: '# gdata.* are outside protos with mising documentation' + downloadParameters: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DownloadParameters' + diffChecksumsResponse: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DiffChecksumsResponse' + blobRef: + deprecated: true + description: '# gdata.* are outside protos with mising documentation' + format: byte type: string - description: >- - The namespace that the job was scheduled in. Must be included in the - workflow metadata so the workflow status can be retrieved. - type: object - SearchCaseClassificationsResponse: - properties: - nextPageToken: + cosmoBinaryReference: + description: '# gdata.* are outside protos with mising documentation' + format: byte type: string - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `caseClassifications.list` - requests. If unspecified, there are no more results to retrieve. - caseClassifications: - items: - $ref: '#/components/schemas/CaseClassification' - description: The classifications retrieved. - type: array - description: The response message for SearchCaseClassifications endpoint. - id: SearchCaseClassificationsResponse - type: object - Attachment: - properties: - mimeType: - readOnly: true + crc32cHash: + format: uint32 + type: integer + description: '# gdata.* are outside protos with mising documentation' + objectId: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/ObjectId' + sha256Hash: type: string - description: Output only. The MIME type of the attachment (e.g. text/plain). + format: byte + description: '# gdata.* are outside protos with mising documentation' + diffUploadResponse: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DiffUploadResponse' + timestamp: + format: uint64 + type: string + description: '# gdata.* are outside protos with mising documentation' + sha1Hash: + format: byte + description: '# gdata.* are outside protos with mising documentation' + type: string + mediaId: + type: string + format: byte + description: '# gdata.* are outside protos with mising documentation' + diffDownloadResponse: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DiffDownloadResponse' + md5Hash: + description: '# gdata.* are outside protos with mising documentation' + type: string + format: byte + inline: + format: byte + description: '# gdata.* are outside protos with mising documentation' + type: string + description: '# gdata.* are outside protos with mising documentation' + Comment: + properties: name: + description: Output only. Identifier. The resource name of the comment. readOnly: true - description: Output only. The resource name of the attachment. type: string - sizeBytes: - format: int64 - readOnly: true + plainTextBody: type: string - description: Output only. The size of the attachment in bytes. - creator: + deprecated: true readOnly: true description: >- - Output only. The user who uploaded the attachment. Note, the name - and email will be obfuscated if the attachment was uploaded by - Google support. - $ref: '#/components/schemas/Actor' + Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` + field. This field is only present for legacy reasons. + body: + type: string + description: The full comment body. Maximum of 12800 characters. createTime: - description: Output only. The time at which the attachment was created. format: google-datetime readOnly: true type: string - filename: - type: string - description: The filename of the attachment (e.g. `"graph.jpg"`). + description: Output only. The time when the comment was created. + creator: + readOnly: true + description: >- + Output only. The user or Google Support agent who created the + comment. + $ref: '#/components/schemas/Actor' description: >- - An Attachment contains metadata about a file that was uploaded to a case - - it is NOT a file itself. That being said, the name of an Attachment - object can be used to download its accompanying file through the - `media.download` endpoint. While attachments can be uploaded in the - console at the same time as a comment, they're associated on a "case" - level, not a "comment" level. + A comment associated with a support case. Case comments are the primary + way for Google Support to communicate with a user who has opened a case. + When a user responds to Google Support, the user's responses also appear + as comments. + id: Comment type: object - id: Attachment - Case: - id: Case - description: >- - A Case is an object that contains the details of a support case. It - contains fields for the time it was created, its priority, its - classification, and more. Cases can also have comments and attachments - that get added over time. A case is parented by a Google Cloud - organization or project. Organizations are identified by a number, so - the name of a case parented by an organization would look like this: ``` - organizations/123/cases/456 ``` Projects have two unique identifiers, an - ID and a number, and they look like this: ``` projects/abc/cases/456 ``` - ``` projects/123/cases/456 ``` You can use either of them when calling - the API. To learn more about project identifiers, see - [AIP-2510](https://google.aip.dev/cloud/2510). + CreateAttachmentRequest: + type: object + description: The request message for the CreateAttachment endpoint. properties: - languageCode: - type: string - description: >- - The language the user has requested to receive support in. This - should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, - `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported - language is specified, this field defaults to English (en). Language - selection during case creation may affect your available support - options. For a list of supported languages and their support working - hours, see: - https://cloud.google.com/support/docs/language-working-hours - testCase: - type: boolean - description: >- - Whether this case was created for internal API testing and should - not be acted on by the support team. - updateTime: - description: Output only. The time this case was last updated. - format: google-datetime - type: string - readOnly: true - description: - type: string - description: A broad description of the issue. - timeZone: - description: >- - The timezone of the user who created the support case. It should be - in a format IANA recognizes: https://www.iana.org/time-zones. There - is no additional validation done by the API. - type: string - creator: + attachment: + $ref: '#/components/schemas/Attachment' + description: Required. The attachment to be created. + id: CreateAttachmentRequest + ListCasesResponse: + properties: + cases: + type: array description: >- - The user who created the case. Note: The name and email will be - obfuscated if the case was created by Google Support. - $ref: '#/components/schemas/Actor' - escalated: - type: boolean - description: Whether the case is currently escalated. - name: - type: string - description: The resource name for the case. - subscriberEmailAddresses: + The list of cases associated with the parent after any filters have + been applied. items: - type: string - description: The email addresses to receive updates on this case. - type: array - priority: - description: The priority of this case. - type: string - enum: - - PRIORITY_UNSPECIFIED - - P0 - - P1 - - P2 - - P3 - - P4 - enumDescriptions: - - Priority is undefined or has not been set yet. - - Extreme impact on a production service. Service is hard down. - - >- - Critical impact on a production service. Service is currently - unusable. - - >- - Severe impact on a production service. Service is usable but - greatly impaired. - - >- - Medium impact on a production service. Service is available, but - moderately impaired. - - >- - General questions or minor issues. Production service is fully - available. - displayName: - type: string - description: The short summary of the issue reported in this case. - classification: - description: The issue classification applicable to this case. - $ref: '#/components/schemas/CaseClassification' - state: - enum: - - STATE_UNSPECIFIED - - NEW - - IN_PROGRESS_GOOGLE_SUPPORT - - ACTION_REQUIRED - - SOLUTION_PROVIDED - - CLOSED - type: string - readOnly: true - enumDescriptions: - - Case is in an unknown state. - - >- - The case has been created but no one is assigned to work on it - yet. - - The case is currently being handled by Google support. - - Google is waiting for a response. - - A solution has been offered for the case, but it isn't yet closed. - - The case has been resolved. - description: Output only. The current status of the support case. - createTime: - readOnly: true - type: string - format: google-datetime - description: Output only. The time this case was created. - contactEmail: - type: string + $ref: '#/components/schemas/Case' + nextPageToken: description: >- - A user-supplied email address to send case update notifications for. - This should only be used in BYOID flows, where we cannot infer the - user's email address directly from their EUCs. + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.list` requests. If + unspecified, there are no more results to retrieve. + type: string + description: The response message for the ListCases endpoint. + type: object + id: ListCasesResponse + DiffDownloadResponse: type: object + id: DiffDownloadResponse + description: '# gdata.* are outside protos with mising documentation' + properties: + objectLocation: + $ref: '#/components/schemas/CompositeMedia' + description: '# gdata.* are outside protos with mising documentation' CompositeMedia: + type: object id: CompositeMedia description: '# gdata.* are outside protos with mising documentation' properties: - cosmoBinaryReference: - type: string - format: byte + objectId: description: '# gdata.* are outside protos with mising documentation' - length: - type: string - format: int64 + $ref: '#/components/schemas/ObjectId' + md5Hash: description: '# gdata.* are outside protos with mising documentation' + type: string + format: byte path: type: string description: '# gdata.* are outside protos with mising documentation' - inline: - description: '# gdata.* are outside protos with mising documentation' - type: string - format: byte - crc32cHash: - type: integer - format: uint32 + blobstore2Info: + $ref: '#/components/schemas/Blobstore2Info' description: '# gdata.* are outside protos with mising documentation' referenceType: - description: '# gdata.* are outside protos with mising documentation' - enum: - - PATH - - BLOB_REF - - INLINE - - BIGSTORE_REF - - COSMO_BINARY_REFERENCE type: string enumDescriptions: - '# gdata.* are outside protos with mising documentation' @@ -343,316 +286,400 @@ components: - '# gdata.* are outside protos with mising documentation' - '# gdata.* are outside protos with mising documentation' - '# gdata.* are outside protos with mising documentation' - blobRef: - deprecated: true + description: '# gdata.* are outside protos with mising documentation' + enum: + - PATH + - BLOB_REF + - INLINE + - BIGSTORE_REF + - COSMO_BINARY_REFERENCE + sha1Hash: format: byte type: string description: '# gdata.* are outside protos with mising documentation' - sha1Hash: + cosmoBinaryReference: type: string - description: '# gdata.* are outside protos with mising documentation' format: byte - objectId: - $ref: '#/components/schemas/ObjectId' description: '# gdata.* are outside protos with mising documentation' - blobstore2Info: - $ref: '#/components/schemas/Blobstore2Info' + blobRef: + format: byte description: '# gdata.* are outside protos with mising documentation' - md5Hash: + deprecated: true type: string + length: description: '# gdata.* are outside protos with mising documentation' + type: string + format: int64 + inline: + type: string format: byte - type: object - CaseClassification: - description: >- - A Case Classification represents the topic that a case is about. It's - very important to use accurate classifications, because they're used to - route your cases to specialists who can help you. A classification - always has an ID that is its unique identifier. A valid ID is required - when creating a case. - id: CaseClassification + description: '# gdata.* are outside protos with mising documentation' + crc32cHash: + format: uint32 + type: integer + description: '# gdata.* are outside protos with mising documentation' + DiffVersionResponse: + description: '# gdata.* are outside protos with mising documentation' + id: DiffVersionResponse type: object properties: - displayName: - description: >- - A display name for the classification. The display name is not - static and can change. To uniquely and consistently identify - classifications, use the `CaseClassification.id` field. + objectSizeBytes: type: string - id: + description: '# gdata.* are outside protos with mising documentation' + format: int64 + objectVersion: type: string - description: >- - The unique ID for a classification. Must be specified for case - creation. To retrieve valid classification IDs for case creation, - use `caseClassifications.search`. Classification IDs returned by - `caseClassifications.search` are guaranteed to be valid for at least - 6 months. If a given classification is deactiveated, it will - immediately stop being returned. After 6 months, `case.create` - requests using the classification ID will fail. - Blobstore2Info: - id: Blobstore2Info + description: '# gdata.* are outside protos with mising documentation' + EscalateCaseRequest: + properties: + escalation: + $ref: '#/components/schemas/Escalation' + description: The escalation information to be sent with the escalation request. + description: The request message for the EscalateCase endpoint. + id: EscalateCaseRequest + type: object + ContentTypeInfo: + description: '# gdata.* are outside protos with mising documentation' type: object + id: ContentTypeInfo properties: - blobGeneration: - format: int64 + fromUrlPath: type: string description: '# gdata.* are outside protos with mising documentation' - blobId: + fromBytes: description: '# gdata.* are outside protos with mising documentation' type: string - downloadReadHandle: - description: '# gdata.* are outside protos with mising documentation' - format: byte + fromHeader: type: string - readToken: + description: '# gdata.* are outside protos with mising documentation' + fromFileName: type: string description: '# gdata.* are outside protos with mising documentation' - uploadMetadataContainer: + bestGuess: type: string description: '# gdata.* are outside protos with mising documentation' - format: byte - description: '# gdata.* are outside protos with mising documentation' - Comment: + CloseCaseRequest: + type: object + id: CloseCaseRequest + properties: {} + description: The request message for the CloseCase endpoint. + SearchCasesResponse: + properties: + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.search` requests. If + unspecified, there are no more results to retrieve. + cases: + items: + $ref: '#/components/schemas/Case' + type: array + description: >- + The list of cases associated with the parent after any filters have + been applied. + description: The response message for the SearchCases endpoint. + type: object + id: SearchCasesResponse + Attachment: description: >- - A comment associated with a support case. Case comments are the primary - way for Google Support to communicate with a user who has opened a case. - When a user responds to Google Support, the user's responses also appear - as comments. - id: Comment + An Attachment contains metadata about a file that was uploaded to a case + - it is NOT a file itself. That being said, the name of an Attachment + object can be used to download its accompanying file through the + `media.download` endpoint. While attachments can be uploaded in the + console at the same time as a comment, they're associated on a "case" + level, not a "comment" level. + id: Attachment properties: - plainTextBody: - deprecated: true + sizeBytes: + format: int64 readOnly: true type: string - description: >- - Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` - field. This field is only present for legacy reasons. - createTime: - description: Output only. The time when the comment was created. - format: google-datetime + description: Output only. The size of the attachment in bytes. + mimeType: + type: string + readOnly: true + description: Output only. The MIME type of the attachment (e.g. text/plain). + name: readOnly: true type: string - body: - description: The full comment body. Maximum of 12800 characters. + description: Output only. The resource name of the attachment. + filename: + description: The filename of the attachment (e.g. `"graph.jpg"`). type: string creator: readOnly: true $ref: '#/components/schemas/Actor' description: >- - Output only. The user or Google Support agent who created the - comment. - name: - type: string + Output only. The user who uploaded the attachment. Note, the name + and email will be obfuscated if the attachment was uploaded by + Google support. + createTime: readOnly: true - description: Output only. Identifier. The resource name of the comment. + type: string + description: Output only. The time at which the attachment was created. + format: google-datetime + type: object + ObjectId: type: object - Media: description: '# gdata.* are outside protos with mising documentation' - id: Media properties: - token: - description: '# gdata.* are outside protos with mising documentation' + bucketName: type: string - blobRef: description: '# gdata.* are outside protos with mising documentation' + generation: type: string - deprecated: true - format: byte - length: format: int64 description: '# gdata.* are outside protos with mising documentation' + objectName: type: string - mediaId: description: '# gdata.* are outside protos with mising documentation' - format: byte + id: ObjectId + Case: + description: >- + A Case is an object that contains the details of a support case. It + contains fields for the time it was created, its priority, its + classification, and more. Cases can also have comments and attachments + that get added over time. A case is parented by a Google Cloud + organization or project. Organizations are identified by a number, so + the name of a case parented by an organization would look like this: ``` + organizations/123/cases/456 ``` Projects have two unique identifiers, an + ID and a number, and they look like this: ``` projects/abc/cases/456 ``` + ``` projects/123/cases/456 ``` You can use either of them when calling + the API. To learn more about project identifiers, see + [AIP-2510](https://google.aip.dev/cloud/2510). + id: Case + properties: + languageCode: + description: >- + The language the user has requested to receive support in. This + should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, + `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported + language is specified, this field defaults to English (en). Language + selection during case creation may affect your available support + options. For a list of supported languages and their support working + hours, see: + https://cloud.google.com/support/docs/language-working-hours type: string - contentTypeInfo: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/ContentTypeInfo' - bigstoreObjectRef: + classification: + description: The issue classification applicable to this case. + $ref: '#/components/schemas/CaseClassification' + contactEmail: type: string - description: '# gdata.* are outside protos with mising documentation' - deprecated: true - format: byte - downloadParameters: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DownloadParameters' - diffDownloadResponse: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffDownloadResponse' - diffUploadRequest: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffUploadRequest' - algorithm: - description: '# gdata.* are outside protos with mising documentation' + description: >- + A user-supplied email address to send case update notifications for. + This should only be used in BYOID flows, where we cannot infer the + user's email address directly from their EUCs. + escalated: + description: Whether the case is currently escalated. + type: boolean + description: + description: A broad description of the issue. + type: string + updateTime: + type: string + description: Output only. The time this case was last updated. + readOnly: true + format: google-datetime + priority: + type: string + enumDescriptions: + - Priority is undefined or has not been set yet. + - Extreme impact on a production service. Service is hard down. + - >- + Critical impact on a production service. Service is currently + unusable. + - >- + Severe impact on a production service. Service is usable but + greatly impaired. + - >- + Medium impact on a production service. Service is available, but + moderately impaired. + - >- + General questions or minor issues. Production service is fully + available. + enum: + - PRIORITY_UNSPECIFIED + - P0 + - P1 + - P2 + - P3 + - P4 + description: The priority of this case. + name: + description: The resource name for the case. type: string - deprecated: true - hashVerified: - type: boolean - description: '# gdata.* are outside protos with mising documentation' - crc32cHash: - description: '# gdata.* are outside protos with mising documentation' - type: integer - format: uint32 - objectId: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/ObjectId' - isPotentialRetry: + testCase: + description: >- + Whether this case was created for internal API testing and should + not be acted on by the support team. type: boolean - description: '# gdata.* are outside protos with mising documentation' - inline: - description: '# gdata.* are outside protos with mising documentation' + timeZone: type: string - format: byte - referenceType: - description: '# gdata.* are outside protos with mising documentation' + description: >- + The timezone of the user who created the support case. It should be + in a format IANA recognizes: https://www.iana.org/time-zones. There + is no additional validation done by the API. + state: + readOnly: true type: string - enum: - - PATH - - BLOB_REF - - INLINE - - GET_MEDIA - - COMPOSITE_MEDIA - - BIGSTORE_REF - - DIFF_VERSION_RESPONSE - - DIFF_CHECKSUMS_RESPONSE - - DIFF_DOWNLOAD_RESPONSE - - DIFF_UPLOAD_REQUEST - - DIFF_UPLOAD_RESPONSE - - COSMO_BINARY_REFERENCE - - ARBITRARY_BYTES + description: Output only. The current status of the support case. enumDescriptions: - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - diffUploadResponse: - $ref: '#/components/schemas/DiffUploadResponse' - description: '# gdata.* are outside protos with mising documentation' - compositeMedia: - items: - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' + - Case is in an unknown state. + - >- + The case has been created but no one is assigned to work on it + yet. + - The case is currently being handled by Google support. + - Google is waiting for a response. + - A solution has been offered for the case, but it isn't yet closed. + - The case has been resolved. + enum: + - STATE_UNSPECIFIED + - NEW + - IN_PROGRESS_GOOGLE_SUPPORT + - ACTION_REQUIRED + - SOLUTION_PROVIDED + - CLOSED + createTime: + readOnly: true + description: Output only. The time this case was created. + type: string + format: google-datetime + creator: + description: >- + The user who created the case. Note: The name and email will be + obfuscated if the case was created by Google Support. + $ref: '#/components/schemas/Actor' + subscriberEmailAddresses: + description: The email addresses to receive updates on this case. type: array - cosmoBinaryReference: - description: '# gdata.* are outside protos with mising documentation' - format: byte + items: + type: string + displayName: + description: The short summary of the issue reported in this case. type: string - path: + type: object + DiffUploadResponse: + properties: + originalObject: + $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' - type: string - hash: - type: string + objectVersion: description: '# gdata.* are outside protos with mising documentation' - deprecated: true - md5Hash: - format: byte type: string + type: object + id: DiffUploadResponse + description: '# gdata.* are outside protos with mising documentation' + DiffUploadRequest: + type: object + properties: + checksumsInfo: description: '# gdata.* are outside protos with mising documentation' - diffChecksumsResponse: - $ref: '#/components/schemas/DiffChecksumsResponse' - description: '# gdata.* are outside protos with mising documentation' - sha256Hash: - description: '# gdata.* are outside protos with mising documentation' - type: string - format: byte - diffVersionResponse: - $ref: '#/components/schemas/DiffVersionResponse' + $ref: '#/components/schemas/CompositeMedia' + objectVersion: description: '# gdata.* are outside protos with mising documentation' - sha1Hash: type: string + objectInfo: + $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' - format: byte - blobstore2Info: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/Blobstore2Info' - filename: + description: '# gdata.* are outside protos with mising documentation' + id: DiffUploadRequest + SearchCaseClassificationsResponse: + description: The response message for SearchCaseClassifications endpoint. + type: object + id: SearchCaseClassificationsResponse + properties: + caseClassifications: + items: + $ref: '#/components/schemas/CaseClassification' + type: array + description: The classifications retrieved. + nextPageToken: type: string + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `caseClassifications.list` + requests. If unspecified, there are no more results to retrieve. + DownloadParameters: + id: DownloadParameters + properties: + ignoreRange: + type: boolean description: '# gdata.* are outside protos with mising documentation' - contentType: - description: '# gdata.* are outside protos with mising documentation' - type: string - timestamp: - type: string + allowGzipCompression: + type: boolean description: '# gdata.* are outside protos with mising documentation' - format: uint64 type: object + description: '# gdata.* are outside protos with mising documentation' DiffChecksumsResponse: + description: '# gdata.* are outside protos with mising documentation' properties: - chunkSizeBytes: - description: '# gdata.* are outside protos with mising documentation' - format: int64 + objectVersion: type: string + description: '# gdata.* are outside protos with mising documentation' checksumsLocation: + description: '# gdata.* are outside protos with mising documentation' $ref: '#/components/schemas/CompositeMedia' + chunkSizeBytes: + format: int64 description: '# gdata.* are outside protos with mising documentation' - objectSizeBytes: type: string + objectSizeBytes: description: '# gdata.* are outside protos with mising documentation' + type: string format: int64 objectLocation: $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' - objectVersion: - type: string - description: '# gdata.* are outside protos with mising documentation' type: object id: DiffChecksumsResponse - description: '# gdata.* are outside protos with mising documentation' - ListAttachmentsResponse: + WorkflowOperationMetadata: properties: - attachments: - description: The list of attachments associated with a case. - type: array - items: - $ref: '#/components/schemas/Attachment' - nextPageToken: + workflowOperationType: + enum: + - UNKNOWN_OPERATION_TYPE + - WORKFLOWS_V1 + - WORKFLOWS_V2 + description: Which version of the workflow service this operation came from. + type: string + enumDescriptions: + - Unknown version. + - Version 1. + - Version 2. + namespace: description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.attachments.list` requests. - If unspecified, there are no more results to retrieve. + The namespace that the job was scheduled in. Must be included in the + workflow metadata so the workflow status can be retrieved. type: string - type: object - id: ListAttachmentsResponse - description: The response message for the ListAttachments endpoint. - ListCasesResponse: - description: The response message for the ListCases endpoint. - properties: - nextPageToken: + operationAction: type: string - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.list` requests. If - unspecified, there are no more results to retrieve. - cases: - items: - $ref: '#/components/schemas/Case' - type: array - description: >- - The list of cases associated with the parent after any filters have - been applied. - id: ListCasesResponse - type: object - Actor: - id: Actor - description: >- - An Actor represents an entity that performed an action. For example, an - actor could be a user who posted a comment on a support case, a user who - uploaded an attachment, or a service account that created a support - case. + enumDescriptions: + - Operation action is not specified. + - Operation pertains to the creation of a new support account. + - Operation pertains to the updating of an existing support account. + - >- + Operation pertains to the purchasing of a support plan that may + either create or update a support account. + enum: + - OPERATION_ACTION_UNSPECIFIED + - CREATE_SUPPORT_ACCOUNT + - UPDATE_SUPPORT_ACCOUNT + - PURCHASE_SUPPORT_ACCOUNT + description: The type of action the operation is classified as. + id: WorkflowOperationMetadata + description: Metadata about the operation. Used to lookup the current status. + type: object + Actor: type: object properties: + displayName: + type: string + description: >- + The name to display for the actor. If not provided, it is inferred + from credentials supplied during case creation. When an email is + provided, a display name must also be provided. This will be + obfuscated if the user is a Google Support agent. email: - deprecated: true description: >- The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is @@ -660,43 +687,71 @@ components: Support agent, this is obfuscated. This field is deprecated. Use **username** field instead. type: string + deprecated: true + googleSupport: + type: boolean + readOnly: true + description: Output only. Whether the actor is a Google support actor. username: + readOnly: true description: >- Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set. - readOnly: true type: string - googleSupport: - type: boolean - description: Output only. Whether the actor is a Google support actor. - readOnly: true + description: >- + An Actor represents an entity that performed an action. For example, an + actor could be a user who posted a comment on a support case, a user who + uploaded an attachment, or a service account that created a support + case. + id: Actor + CaseClassification: + properties: + id: + description: >- + The unique ID for a classification. Must be specified for case + creation. To retrieve valid classification IDs for case creation, + use `caseClassifications.search`. Classification IDs returned by + `caseClassifications.search` are guaranteed to be valid for at least + 6 months. If a given classification is deactiveated, it will + immediately stop being returned. After 6 months, `case.create` + requests using the classification ID will fail. + type: string displayName: type: string description: >- - The name to display for the actor. If not provided, it is inferred - from credentials supplied during case creation. When an email is - provided, a display name must also be provided. This will be - obfuscated if the user is a Google Support agent. + A display name for the classification. The display name is not + static and can change. To uniquely and consistently identify + classifications, use the `CaseClassification.id` field. + type: object + description: >- + A Case Classification represents the topic that a case is about. It's + very important to use accurate classifications, because they're used to + route your cases to specialists who can help you. A classification + always has an ID that is its unique identifier. A valid ID is required + when creating a case. + id: CaseClassification ListCommentsResponse: type: object properties: + comments: + description: List of the comments associated with the case. + items: + $ref: '#/components/schemas/Comment' + type: array nextPageToken: - type: string description: >- A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.comments.list` requests. If unspecified, there are no more results to retrieve. - comments: - items: - $ref: '#/components/schemas/Comment' - description: List of the comments associated with the case. - type: array + type: string id: ListCommentsResponse description: The response message for the ListComments endpoint. Escalation: + description: An escalation of a support case. + type: object properties: justification: type: string @@ -705,13 +760,7 @@ components: above. Provides additional context on why the case is being escalated. reason: - enum: - - REASON_UNSPECIFIED - - RESOLUTION_TIME - - TECHNICAL_EXPERTISE - - BUSINESS_IMPACT description: Required. The reason why the Case is being escalated. - type: string enumDescriptions: - >- The escalation reason is in an unknown state or has not been @@ -721,128 +770,86 @@ components: The support agent does not have the expertise required to successfully resolve the issue. - The issue is having a significant business impact. - description: An escalation of a support case. - id: Escalation - type: object - DiffVersionResponse: - properties: - objectSizeBytes: - format: int64 - description: '# gdata.* are outside protos with mising documentation' - type: string - objectVersion: - description: '# gdata.* are outside protos with mising documentation' type: string - id: DiffVersionResponse - description: '# gdata.* are outside protos with mising documentation' + enum: + - REASON_UNSPECIFIED + - RESOLUTION_TIME + - TECHNICAL_EXPERTISE + - BUSINESS_IMPACT + id: Escalation + Blobstore2Info: type: object - DiffDownloadResponse: description: '# gdata.* are outside protos with mising documentation' properties: - objectLocation: - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - id: DiffDownloadResponse - type: object - CloseCaseRequest: - type: object - id: CloseCaseRequest - description: The request message for the CloseCase endpoint. - properties: {} - EscalateCaseRequest: - properties: - escalation: - $ref: '#/components/schemas/Escalation' - description: The escalation information to be sent with the escalation request. - id: EscalateCaseRequest - type: object - description: The request message for the EscalateCase endpoint. - ContentTypeInfo: - properties: - fromUrlPath: - description: '# gdata.* are outside protos with mising documentation' - type: string - fromHeader: + readToken: description: '# gdata.* are outside protos with mising documentation' type: string - fromFileName: - type: string + downloadReadHandle: + format: byte description: '# gdata.* are outside protos with mising documentation' - bestGuess: type: string - description: '# gdata.* are outside protos with mising documentation' - fromBytes: + uploadMetadataContainer: + format: byte type: string description: '# gdata.* are outside protos with mising documentation' - id: ContentTypeInfo - description: '# gdata.* are outside protos with mising documentation' - type: object - CreateAttachmentRequest: - properties: - attachment: - description: Required. The attachment to be created. - $ref: '#/components/schemas/Attachment' - id: CreateAttachmentRequest - description: The request message for the CreateAttachment endpoint. - type: object - ObjectId: - description: '# gdata.* are outside protos with mising documentation' - type: object - properties: - bucketName: + blobId: type: string description: '# gdata.* are outside protos with mising documentation' - objectName: - description: '# gdata.* are outside protos with mising documentation' + blobGeneration: type: string - generation: format: int64 - type: string description: '# gdata.* are outside protos with mising documentation' - id: ObjectId + id: Blobstore2Info parameters: - callback: - description: JSONP + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv schema: 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. + enum: + - '1' + - '2' + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: key + name: uploadType schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string - _.xgafv: - description: V1 error format. + callback: + description: JSONP in: query - name: $.xgafv + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string - enum: - - '1' - - '2' upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + alt: + description: Data format for response. in: query - name: fields + name: alt schema: type: string + enum: + - json + - media + - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -852,26 +859,19 @@ components: name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - alt: - description: Data format for response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: alt + name: oauth_token schema: type: string - enum: - - json - - media - - proto - access_token: - description: OAuth access token. + 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. in: query - name: access_token + name: key schema: type: string prettyPrint: @@ -934,33 +934,59 @@ components: response: mediaType: application/json openAPIDocKey: '200' - close: + escalate: operation: $ref: '#/paths/~1v2~1{name}/post' response: mediaType: application/json openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cases + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cases/methods/list' + - $ref: '#/components/x-stackQL-resources/cases/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/cases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cases/methods/patch' + replace: [] + delete: [] + comments: + id: google.cloudsupport.comments + name: comments + title: Comments + methods: list: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/get' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.cases + objectKey: $.comments create: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/post' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/cases/methods/list' - - $ref: '#/components/x-stackQL-resources/cases/methods/get' + - $ref: '#/components/x-stackQL-resources/comments/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/cases/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/cases/methods/patch' + - $ref: '#/components/x-stackQL-resources/comments/methods/create' + update: [] replace: [] delete: [] case_classifications: @@ -980,45 +1006,19 @@ components: update: [] replace: [] delete: [] - comments: - id: google.cloudsupport.comments - name: comments - title: Comments - methods: - create: - operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.comments - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/comments/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/comments/methods/create' - update: [] - replace: [] - delete: [] paths: /v2/{parentType}/{parent}/attachments: parameters: &ref_1 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' post: description: >- @@ -1106,15 +1106,15 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string /v2/{name}: parameters: *ref_1 get: @@ -1194,23 +1194,30 @@ paths: format: google-fieldmask post: description: >- - Close a case. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43595344" curl \ --request POST \ - --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: + Escalate a case, starting the Google Cloud Support escalation management + process. This operation is only available for some support services. Go + to https://cloud.google.com/support and look for 'Technical support + escalations' in the feature list to find out which ones let you do that. + EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" + curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth + print-access-token)" \ --header "Content-Type: application/json" \ + --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": + "This is a test escalation." } }' \ + "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.cases().close( - name="projects/some-project/cases/43595344" ) print(request.execute()) - ``` - operationId: cloudsupport.cases.close + ) request = supportApiService.cases().escalate( + name="projects/some-project/cases/43595344", body={ "escalation": { + "reason": "BUSINESS_IMPACT", "justification": "This is a test + escalation.", }, }, ) print(request.execute()) ``` + operationId: cloudsupport.cases.escalate requestBody: content: application/json: schema: - $ref: '#/components/schemas/CloseCaseRequest' + $ref: '#/components/schemas/EscalateCaseRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1229,27 +1236,22 @@ paths: required: true schema: type: string - /v2/caseClassifications:search: + /v2/{parentType}/{parent}/comments: parameters: *ref_1 get: description: >- - Retrieve valid classifications to use when creating a support case. - Classifications are hierarchical. Each classification is a string - containing all levels of the hierarchy separated by `" > "`. For - example, `"Technical Issue > Compute > Compute Engine"`. Classification - IDs returned by this endpoint are valid for at least six months. When a - classification is deactivated, this endpoint immediately stops returning - it. After six months, `case.create` requests using the classification - will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: - Bearer $(gcloud auth print-access-token)" \ - 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' - ``` Python: ```python import googleapiclient.discovery supportApiService - = googleapiclient.discovery.build( serviceName="cloudsupport", - version="v2", - discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", - ) request = supportApiService.caseClassifications().search( - query='display_name:"*Compute Engine*"' ) print(request.execute()) ``` - operationId: cloudsupport.caseClassifications.search + List all the comments associated with a case. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43595344" curl \ --header + "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: + ```python import googleapiclient.discovery api_version = "v2" + supportApiService = googleapiclient.discovery.build( + serviceName="cloudsupport", version=api_version, + discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", + ) request = ( supportApiService.cases() .comments() + .list(parent="projects/some-project/cases/43595344") ) + print(request.execute()) ``` + operationId: cloudsupport.cases.comments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1261,14 +1263,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchCaseClassificationsResponse' + $ref: '#/components/schemas/ListCommentsResponse' parameters: - - in: query - name: query + - in: path + name: parentType + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: parent + required: true schema: type: string - in: query @@ -1276,25 +1280,32 @@ paths: schema: type: integer format: int32 - /v2/{parentType}/{parent}/cases: - parameters: *ref_1 - get: + - in: query + name: pageToken + schema: + type: string + post: description: >- - Retrieve all cases under a parent, but not its children. For example, - listing cases under an organization only returns the cases that are - directly parented by that organization. To retrieve cases under an - organization and its projects, use `cases.search`. EXAMPLES: cURL: - ```shell parent="projects/some-project" curl \ --header "Authorization: - Bearer $(gcloud auth print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: + Add a new comment to a case. The comment must have the following fields + set: `body`. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43591344" curl \ --request POST \ + --header "Authorization: Bearer $(gcloud auth print-access-token)" \ + --header 'Content-Type: application/json' \ --data '{ "body": "This is a + test comment." }' \ + "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = - supportApiService.cases().list(parent="projects/some-project") - print(request.execute()) ``` - operationId: cloudsupport.cases.list + ) request = ( supportApiService.cases() .comments() .create( + parent="projects/some-project/cases/43595344", body={"body": "This is a + test comment."}, ) ) print(request.execute()) ``` + operationId: cloudsupport.cases.comments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1306,7 +1317,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCasesResponse' + $ref: '#/components/schemas/Comment' parameters: - in: path name: parentType @@ -1318,19 +1329,8 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string + /v2/{parentType}/{parent}/cases: + parameters: *ref_1 post: description: >- Create a new case and associate it with a parent. It must have the @@ -1385,30 +1385,23 @@ paths: required: true schema: type: string - /v2/{parentType}/{parent}/comments: - parameters: *ref_1 - post: + get: description: >- - Add a new comment to a case. The comment must have the following fields - set: `body`. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43591344" curl \ --request POST \ - --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - --header 'Content-Type: application/json' \ --data '{ "body": "This is a - test comment." }' \ - "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: + Retrieve all cases under a parent, but not its children. For example, + listing cases under an organization only returns the cases that are + directly parented by that organization. To retrieve cases under an + organization and its projects, use `cases.search`. EXAMPLES: cURL: + ```shell parent="projects/some-project" curl \ --header "Authorization: + Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = ( supportApiService.cases() .comments() .create( - parent="projects/some-project/cases/43595344", body={"body": "This is a - test comment."}, ) ) print(request.execute()) ``` - operationId: cloudsupport.cases.comments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Comment' + ) request = + supportApiService.cases().list(parent="projects/some-project") + print(request.execute()) ``` + operationId: cloudsupport.cases.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1420,7 +1413,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Comment' + $ref: '#/components/schemas/ListCasesResponse' parameters: - in: path name: parentType @@ -1432,20 +1425,40 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/caseClassifications:search: + parameters: *ref_1 get: description: >- - List all the comments associated with a case. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43595344" curl \ --header - "Authorization: Bearer $(gcloud auth print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: - ```python import googleapiclient.discovery api_version = "v2" - supportApiService = googleapiclient.discovery.build( - serviceName="cloudsupport", version=api_version, - discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = ( supportApiService.cases() .comments() - .list(parent="projects/some-project/cases/43595344") ) - print(request.execute()) ``` - operationId: cloudsupport.cases.comments.list + Retrieve valid classifications to use when creating a support case. + Classifications are hierarchical. Each classification is a string + containing all levels of the hierarchy separated by `" > "`. For + example, `"Technical Issue > Compute > Compute Engine"`. Classification + IDs returned by this endpoint are valid for at least six months. When a + classification is deactivated, this endpoint immediately stops returning + it. After six months, `case.create` requests using the classification + will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: + Bearer $(gcloud auth print-access-token)" \ + 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' + ``` Python: ```python import googleapiclient.discovery supportApiService + = googleapiclient.discovery.build( serviceName="cloudsupport", + version="v2", + discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", + ) request = supportApiService.caseClassifications().search( + query='display_name:"*Compute Engine*"' ) print(request.execute()) ``` + operationId: cloudsupport.caseClassifications.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1457,24 +1470,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCommentsResponse' + $ref: '#/components/schemas/SearchCaseClassificationsResponse' parameters: - - in: path - name: parentType - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: parent - required: true + type: integer + format: int32 + - in: query + name: query schema: type: string - in: query name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/compute.yaml b/providers/src/googleapis.com/v00.00.00000/services/compute.yaml index d677f32a..a2e449ac 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/compute.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/compute.yaml @@ -7,7 +7,7 @@ info: title: Compute Engine API description: 'Creates and runs virtual machines on Google Cloud Platform. ' version: v1 - x-discovery-doc-revision: '20240917' + x-discovery-doc-revision: '20240903' x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/compute/ @@ -9904,12 +9904,10 @@ components: - No type specified. Do not use this value. - AMD Secure Encrypted Virtualization. - AMD Secure Encrypted Virtualization - Secure Nested Paging. - - Intel Trust Domain eXtension. enum: - CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED - SEV - SEV_SNP - - TDX AdvancedMachineFeatures: id: AdvancedMachineFeatures description: >- @@ -30147,12 +30145,12 @@ components: requestedFeatures: description: >- Optional. List of features requested for this Interconnect - connection, which can take one of the following values: - IF_MACSEC - If specified then the connection is created on MACsec capable - hardware ports. If not specified, the default value is false, which - allocates non-MACsec capable ports first if available. This - parameter can be provided only with Interconnect INSERT. It isn't - valid for Interconnect PATCH. + connection, which can take one of the following values: - MACSEC If + specified then the connection is created on MACsec capable hardware + ports. If not specified, the default value is false, which allocates + non-MACsec capable ports first if available. This parameter can be + provided only with Interconnect INSERT. It isn't valid for + Interconnect PATCH. type: array items: type: string @@ -30163,8 +30161,8 @@ components: availableFeatures: description: >- [Output only] List of features available for this Interconnect - connection, which can take one of the following values: - IF_MACSEC - If present then the Interconnect connection is provisioned on MACsec + connection, which can take one of the following values: - MACSEC If + present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. diff --git a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml index e7d4525b..c498dec7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml @@ -34,1140 +34,952 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: + GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: + id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + type: object + description: The result of an analysis. properties: - queryRecord: + callAnalysisMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + description: Call-specific metadata created by the analysis. + endTime: + description: The time at which the analysis ended. type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1PhraseMatchRule: + properties: + negated: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - source: + Specifies whether the phrase must be missing from the transcript + segment or present in the transcript segment. + type: boolean + config: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + Provides additional information about the rule that specifies how to + apply the rule. + query: type: string - uri: + description: Required. The phrase to be matched. + type: object + id: GoogleCloudContactcenterinsightsV1PhraseMatchRule + description: The data for a phrase match rule. + GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: + properties: + summarizationModel: + enumDescriptions: + - Unspecified summarization model. + - The CCAI baseline model. + - The CCAI baseline model, V2.0. type: string - description: Article URI. - metadata: - type: object - additionalProperties: - type: string + enum: + - SUMMARIZATION_MODEL_UNSPECIFIED + - BASELINE_MODEL + - BASELINE_MODEL_V2_0 + description: Default summarization model to be used. + conversationProfile: description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. - title: - description: Article title. + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} type: string - confidenceScore: - description: >- - The system's confidence score that this article is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - format: float - type: number - description: Agent Assist Article Suggestion data. - id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + type: object + description: Configuration for summarization. + GoogleCloudContactcenterinsightsV1UploadConversationRequest: + description: Request to upload a conversation. type: object - GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: properties: - issue: + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + description: >- + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + parent: type: string + description: Required. The parent resource of the conversation. + redactionConfig: description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - labeledConversationsCount: + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + conversationId: + description: >- + Optional. A unique ID for the new conversation. This ID will become + the final component of the conversation's resource name. If no ID is + specified, a server-generated ID will be used. This value should be + 4-64 characters and must match the regular expression + `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` type: string - description: Number of conversations attached to the issue at this point in time. - format: int64 - displayName: + conversation: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' + description: Required. The conversation resource to create. + id: GoogleCloudContactcenterinsightsV1UploadConversationRequest + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: + properties: + createTime: type: string - description: Display name of the issue. - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + readOnly: true + description: Output only. The time the operation was created. + format: google-datetime + endTime: + format: google-datetime + type: string + readOnly: true + description: Output only. The time the operation finished running. + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest + description: The original request for deployment. + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata type: object - description: Aggregated statistics about an issue. - GoogleCloudContactcenterinsightsV1ExactMatchConfig: - id: GoogleCloudContactcenterinsightsV1ExactMatchConfig + description: Metadata for deploying an issue model. + GoogleCloudContactcenterinsightsV1UploadConversationMetadata: + id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata type: object + description: The metadata for an `UploadConversation` operation. properties: - caseSensitive: - description: Whether to consider case sensitivity when performing an exact match. - type: boolean - description: Exact match configuration. - GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: - id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + readOnly: true + description: Output only. The original request. + appliedRedactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + description: >- + Output only. The redaction config applied to the uploaded + conversation. + readOnly: true + endTime: + description: Output only. The time the operation finished running. + type: string + format: google-datetime + readOnly: true + createTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time the operation was created. + analysisOperation: + readOnly: true + type: string + description: >- + Output only. The operation name for a successfully created analysis + operation, if any. + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + type: object properties: - suggestion: + name: + description: Required. The issue model to export. type: string - description: The content of the suggestion. - confidenceScore: + gcsDestination: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + description: Google Cloud Storage URI to export the issue model to. + description: Request to export an issue model. + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: + properties: + textSections: + type: object + additionalProperties: + type: string description: >- - The system's confidence score that this suggestion is a good match - for this conversation, ranging from 0.0 (completely uncertain) to - 1.0 (completely certain). + The summarization content that is divided into sections. The key is + the section's name and the value is the section's content. There is + no specific format for the key or value. + metadata: + additionalProperties: + type: string + description: >- + A map that contains metadata about the summarization and the + document from which it originates. + type: object + conversationModel: + description: >- + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} + type: string + confidence: type: number - format: double - queryRecord: + description: The confidence score of the summarization. + format: float + answerRecord: description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - metadata: - type: object - additionalProperties: - type: string - description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - description: Agent Assist Smart Compose suggestion data. + text: + type: string + description: The summarization content that is concatenated into one string. + id: >- + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. type: object - GoogleProtobufEmpty: - properties: {} - id: GoogleProtobufEmpty - 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); } + GoogleCloudContactcenterinsightsV1DialogflowInteractionData: type: object - GoogleCloudContactcenterinsightsV1ListAnalysesResponse: + description: Dialogflow interaction data. + id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData properties: - analyses: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' - description: The analyses that match the request. - nextPageToken: + confidence: + format: float + type: number 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. + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + dialogflowIntentId: type: string - id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse - description: The response to list analyses. - type: object - GoogleCloudContactcenterinsightsV1HoldData: + description: >- + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} + GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: type: object - description: The data for a hold annotation. - properties: {} - id: GoogleCloudContactcenterinsightsV1HoldData - GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: - id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource properties: - phraseMatchers: - description: The phrase matchers that match the request. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher - type: array - nextPageToken: + audioUri: 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 - description: The response of listing phrase matchers. - type: object - GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: - type: object - properties: - inspectTemplate: + Cloud Storage URI that points to a file that contains the + conversation audio. type: string + dialogflowConversation: + readOnly: true description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` - deidentifyTemplate: - description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` + Output only. The name of the Dialogflow conversation that this + conversation resource is derived from. Format: + projects/{project}/locations/{location}/conversations/{conversation} type: string - id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - description: >- - DLP resources used for redaction while ingesting conversations. DLP - settings are applied to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversation coming from CCAI Platform. They are not applied to - conversations ingested from the `CreateConversation` endpoint or the - Dialogflow / Agent Assist runtime integrations. When using Dialogflow / - Agent Assist runtime integrations, redaction should be performed in - Dialogflow / Agent Assist. - GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: - type: object - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource - description: Configuration for Cloud Storage bucket sources. + description: A Dialogflow source of conversation data. + GoogleCloudContactcenterinsightsV1alpha1Conversation: + description: The conversation resource. properties: - bucketUri: - type: string - description: Required. The Cloud Storage bucket containing source objects. - metadataBucketUri: - description: >- - Optional. The Cloud Storage path to the conversation metadata. Note - that: [1] Metadata files are expected to be in JSON format. [2] - Metadata and source files (transcripts or audio) must be in separate - buckets. [3] A source file and its corresponding metadata file must - share the same name to be properly ingested, E.g. - `gs://bucket/audio/conversation1.mp3` and - `gs://bucket/metadata/conversation1.json`. + latestAnalysis: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis + description: Output only. The conversation's latest analysis, if one exists. + medium: type: string - customMetadataKeys: description: >- - Optional. Custom keys to extract as conversation labels from - metadata files in `metadata_bucket_uri`. Keys not included in this - field will be ignored. Note that there is a limit of 20 labels per - conversation. - type: array - items: - type: string - bucketObjectType: - description: Optional. Specifies the type of the objects in `bucket_uri`. - type: string + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. enumDescriptions: - - The object type is unspecified and will default to `TRANSCRIPT`. - - The object is a transcript. - - The object is an audio file. - enum: - - BUCKET_OBJECT_TYPE_UNSPECIFIED - - TRANSCRIPT - - AUDIO - GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: - type: object - properties: - medium: - deprecated: true - type: string + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. enum: - MEDIUM_UNSPECIFIED - PHONE_CALL - CHAT - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: >- - Medium of conversations used in training data. This field is being - deprecated. To specify the medium to be used in training a new issue - model, set the `medium` field on `filter`. - filter: - description: >- - A filter to reduce the conversations used for training the model to - a specific subset. - type: string - trainingConversationsCount: - type: string - format: int64 - description: Output only. Number of conversations used in training. Output only. - readOnly: true - description: Configs for the input data used to create the issue model. - id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: - description: The response to undeploy an issue model. - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse - properties: {} - type: object - GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: - properties: {} - description: Response for an export insights operation. - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse - type: object - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: - properties: - request: - description: The original import request. + qualityMetadata: + description: Conversation metadata related to quality management. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - endTime: - type: string - format: google-datetime - description: The time the operation finished running. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata createTime: - description: The time the operation was created. + description: Output only. The time at which the conversation was created. + readOnly: true type: string format: google-datetime - type: object - description: Metadata used for import issue model. - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata - GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata - type: object - properties: - createTime: + startTime: + description: The time at which the conversation started. format: google-datetime - description: Output only. The time the operation was created. - readOnly: true type: string - endTime: - format: google-datetime + duration: + description: Output only. The duration of the conversation. type: string - description: Output only. The time the operation finished running. readOnly: true - conversation: + format: google-duration + name: type: string - readOnly: true description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - annotatorSelector: - readOnly: true - description: Output only. The annotator selector used for the analysis (if any). + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} + dataSource: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: Metadata for a create analysis operation. - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse - type: object - description: The response for a bulk delete conversations operation. - GoogleCloudContactcenterinsightsV1Settings: - type: object - description: >- - The CCAI Insights project wide settings. Use these settings to configure - the behavior of Insights. View these settings with - [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) - and change the settings with - [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). - id: GoogleCloudContactcenterinsightsV1Settings - properties: - createTime: - type: string - description: Output only. The time at which the settings was created. - format: google-datetime - readOnly: true - updateTime: - format: google-datetime - description: Output only. The time at which the settings were last updated. - type: string + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + description: The source of the audio and transcription for the conversation. + transcript: + description: Output only. The conversation transcript. readOnly: true - conversationTtl: - description: >- - The default TTL for newly-created conversations. If a conversation - has a specified expiration, that value will be used instead. - Changing this value will not change the expiration of existing - conversations. Conversations with no expire time persist until they - are deleted. - format: google-duration - type: string - analysisConfig: - description: Default analysis settings. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig - speechConfig: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript + runtimeAnnotations: + type: array description: >- - Optional. Default Speech-to-Text resources to use while ingesting - audio files. Optional, CCAI Insights will create a default if not - provided. This applies to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversations coming from CCAI Platform. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - name: + Output only. The annotations that were generated during the customer + and agent interaction. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + readOnly: true + agentId: description: >- - Immutable. The resource name of the settings resource. Format: - projects/{project}/locations/{location}/settings + An opaque, user-specified string representing the human agent who + handled the conversation. type: string - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - description: >- - Default DLP redaction resources to be applied while ingesting - conversations. This applies to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversations coming from CCAI Platform. - languageCode: + labels: description: >- - A language code to be applied to each transcript segment unless the - segment already specifies a language code. Language code defaults to - "en-US" if it is neither specified on the segment nor here. - type: string - pubsubNotificationSettings: + A map for the user to specify any custom fields. A maximum of 20 + labels per conversation is allowed, with a maximum of 256 characters + per entry. additionalProperties: type: string + type: object + updateTime: description: >- - A map that maps a notification trigger to a Pub/Sub topic. Each time - a specified trigger occurs, Insights will notify the corresponding - Pub/Sub topic. Keys are notification triggers. Supported keys are: * - "all-triggers": Notify each time any of the supported triggers - occurs. * "create-analysis": Notify each time an analysis is - created. * "create-conversation": Notify each time a conversation is - created. * "export-insights-data": Notify each time an export is - complete. * "ingest-conversations": Notify each time an - IngestConversations LRO is complete. * "update-conversation": Notify - each time a conversation is updated via UpdateConversation. * - "upload-conversation": Notify when an UploadConversation LRO is - complete. Values are Pub/Sub topics. The format of each Pub/Sub - topic is: projects/{project}/topics/{topic} - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: - properties: - bigQueryDestination: + Output only. The most recent time at which the conversation was + updated. + readOnly: true + type: string + format: google-datetime + callMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination - description: Specified if sink is a BigQuery table. - writeDisposition: - enumDescriptions: - - Write disposition is not specified. Defaults to WRITE_TRUNCATE. - - >- - If the table already exists, BigQuery will overwrite the table - data and use the schema from the load. - - >- - If the table already exists, BigQuery will append data to the - table. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + description: Call-specific metadata. + metadataJson: type: string - enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - description: Options for what to do if the destination table already exists. - filter: description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. + Input only. JSON Metadata encoded as a string. This field is + primarily used by Insights integrations with various telphony + systems and must be in one of Insights' supported formats. + dialogflowIntents: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent + type: object + description: >- + Output only. All the matched Dialogflow intents in the call. The key + corresponds to a Dialogflow intent, format: + projects/{project}/agent/{agent}/intents/{intent} + readOnly: true + expireTime: type: string - kmsKey: description: >- - A fully qualified KMS key name for BigQuery tables protected by - CMEK. Format: - projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. + format: google-datetime + ttl: + format: google-duration type: string - parent: + description: >- + Input only. The TTL for this resource. If specified, then this TTL + will be used to calculate the expire time. + obfuscatedUserId: + description: Obfuscated user ID which the customer sent to us. type: string - description: Required. The parent resource to export data from. - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest + turnCount: + description: Output only. The number of turns in the conversation. + type: integer + readOnly: true + format: int32 + languageCode: + type: string + description: A user-specified language code for the conversation. + latestSummary: + readOnly: true + description: Output only. Latest summary of the conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + id: GoogleCloudContactcenterinsightsV1alpha1Conversation type: object - description: The request to export insights. - GoogleCloudContactcenterinsightsV1CalculateStatsResponse: - description: The response for calculating conversation statistics. - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse + GoogleCloudContactcenterinsightsV1ArticleSuggestionData: + id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData type: object properties: - conversationCount: - format: int32 - type: integer - description: The total number of conversations. - conversationCountTimeSeries: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries - description: >- - A time series representing the count of conversations created over - time that match that requested filter criteria. - smartHighlighterMatches: - additionalProperties: - format: int32 - type: integer - type: object - description: >- - A map associating each smart highlighter display name with its - respective number of matches in the set of conversations. - issueMatchesStats: + source: + type: string description: >- - A map associating each issue resource name with its respective - number of matches in the set of conversations. Key has the format: - `projects//locations//issueModels//issues/` - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - type: object - issueMatches: - deprecated: true + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + metadata: type: object - description: >- - A map associating each issue resource name with its respective - number of matches in the set of conversations. Key has the format: - `projects//locations//issueModels//issues/` Deprecated, use - `issue_matches_stats` field instead. - additionalProperties: - type: integer - format: int32 - customHighlighterMatches: additionalProperties: - type: integer - format: int32 + type: string description: >- - A map associating each custom highlighter resource name with its - respective number of matches in the set of conversations. - type: object - averageTurnCount: - description: The average number of turns per conversation. - format: int32 - type: integer - averageDuration: + Map that contains metadata about the Article Suggestion and the + document that it originates from. + uri: + description: Article URI. type: string - format: google-duration + title: + description: Article title. + type: string + queryRecord: description: >- - The average duration of all conversations. The average is calculated - using only conversations that have a time duration. - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - type: object - properties: - nextPageToken: - description: The standard List next-page token. + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - operations: + confidenceScore: + format: float description: >- - A list of operations that matches the specified filter in the - request. - type: array + The system's confidence score that this article is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + description: Agent Assist Article Suggestion data. + GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: + properties: + issueModels: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource - description: A Dialogflow source of conversation data. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + type: array + description: The issue models that match the request. type: object + description: The response of listing issue models. + id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: properties: - audioUri: - type: string - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - dialogflowConversation: + displayName: type: string - readOnly: true - description: >- - Output only. The name of the Dialogflow conversation that this - conversation resource is derived from. Format: - projects/{project}/locations/{location}/conversations/{conversation} - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata: - properties: - createTime: - readOnly: true - format: google-datetime - description: Output only. The time the operation was created. + description: Display name of the issue. + issue: type: string - request: - description: Output only. The original request for initialization. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest - partialErrors: description: >- - Partial errors during initialising operation that might cause the - operation output to be incomplete. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - endTime: - readOnly: true - format: google-datetime - description: Output only. The time the operation finished running. + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + labeledConversationsCount: + format: int64 + description: Number of conversations attached to the issue at this point in time. type: string - description: Metadata for initializing a location-level encryption specification. - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + description: Aggregated statistics about an issue. type: object - GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: - description: Request to import an issue model. + GoogleCloudContactcenterinsightsV1ConversationCallMetadata: + properties: + agentChannel: + type: integer + format: int32 + description: The audio channel that contains the agent. + customerChannel: + format: int32 + type: integer + description: The audio channel that contains the customer. + id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata + description: Call-specific metadata. + type: object + GoogleCloudContactcenterinsightsV1Intent: type: object properties: - gcsSource: - description: Google Cloud Storage source message. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - createNewModel: - type: boolean - description: >- - Optional. If set to true, will create an issue model from the - imported file with randomly generated IDs for the issue model and - corresponding issues. Otherwise, replaces an existing model with the - same ID as the file. - parent: + id: type: string - description: Required. The parent resource of the issue model. - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - GoogleCloudContactcenterinsightsV1PhraseMatcher: - description: The phrase matcher resource. - id: GoogleCloudContactcenterinsightsV1PhraseMatcher + description: The unique identifier of the intent. + displayName: + description: The human-readable name of the intent. + type: string + id: GoogleCloudContactcenterinsightsV1Intent + description: >- + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. + GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: + id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + type: object properties: - updateTime: + annotationEndBoundary: description: >- - Output only. The most recent time at which the phrase matcher was - updated. - readOnly: true - format: google-datetime - type: string - roleMatch: - type: string - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + silenceData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData + description: Data specifying silence. + annotationStartBoundary: description: >- - The role whose utterances the phrase matcher should be matched - against. If the role is ROLE_UNSPECIFIED it will be matched against - any utterances in the transcript. - type: - type: string - enumDescriptions: - - Unspecified. - - Must meet all phrase match rule groups or there is no match. - - If any of the phrase match rule groups are met, there is a match. - description: Required. The type of this phrase matcher. - enum: - - PHRASE_MATCHER_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - displayName: + The boundary in the conversation where the annotation starts, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + holdData: + description: Data specifying a hold. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData + intentMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData + description: Data specifying an intent match. + sentimentData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Data specifying sentiment. + interruptionData: + description: Data specifying an interruption. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData + issueMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData + description: Data specifying an issue match. + entityMentionData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + description: Data specifying an entity mention. + phraseMatchData: + description: Data specifying a phrase match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + channelTag: + description: >- + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. + format: int32 + type: integer + description: A piece of metadata that applies to a window of a call. + GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: + description: Agent Assist frequently-asked-question answer data. + properties: + answer: + description: The piece of text from the `source` knowledge base document. type: string - description: The human-readable name of the phrase matcher. - name: + queryRecord: type: string description: >- - The resource name of the phrase matcher. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - revisionCreateTime: + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + confidenceScore: + type: number + description: >- + The system's confidence score that this answer is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + format: float + question: type: string - format: google-datetime - readOnly: true + description: The corresponding FAQ question. + metadata: description: >- - Output only. The timestamp of when the revision was created. It is - also the create time when a new matcher is added. - revisionId: + Map that contains metadata about the FAQ answer and the document + that it originates from. + type: object + additionalProperties: + type: string + source: description: >- - Output only. Immutable. The revision ID of the phrase matcher. A new - revision is committed whenever the matcher is changed, except when - it is activated or deactivated. A server generated random ID will be - used. Example: - locations/global/phraseMatchers/my-first-matcher@1234567 - readOnly: true + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. type: string - versionTag: - description: >- - The customized version tag to use for the phrase matcher. If not - specified, it will default to `revision_id`. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: + type: object + properties: + objectUri: + description: 'Required. Format: `gs:///`' type: string - phraseMatchRuleGroups: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup - type: array - description: A list of phase match rule groups that are included in this matcher. - activationUpdateTime: - readOnly: true + description: Google Cloud Storage Object URI to save the issue model to. + id: >- + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata + description: The metadata for a bulk delete conversations operation. + properties: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + description: The original request for bulk delete. + createTime: + description: The time the operation was created. type: string format: google-datetime + endTime: + format: google-datetime + description: The time the operation finished running. + type: string + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - Output only. The most recent time at which the activation status was - updated. - active: - type: boolean - description: Applies the phrase matcher only when it is active. - type: object - GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: + Partial errors during bulk delete conversations operation that might + cause the operation output to be incomplete. + GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: properties: - endTime: - description: Output only. The time the operation finished running. + trainingConversationsCount: + format: int64 + description: Output only. Number of conversations used in training. Output only. readOnly: true type: string - format: google-datetime - annotatorSelector: - readOnly: true - description: Output only. The annotator selector used for the analysis (if any). - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - createTime: - readOnly: true - format: google-datetime + medium: + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. type: string - description: Output only. The time the operation was created. - conversation: + deprecated: true + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + description: >- + Medium of conversations used in training data. This field is being + deprecated. To specify the medium to be used in training a new issue + model, set the `medium` field on `filter`. + filter: type: string description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - readOnly: true - description: Metadata for a create analysis operation. + A filter to reduce the conversations used for training the model to + a specific subset. + description: Configs for the input data used to create the issue model. type: object - id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata - GoogleCloudContactcenterinsightsV1AnnotatorSelector: + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + GoogleCloudContactcenterinsightsV1FaqAnswerData: + id: GoogleCloudContactcenterinsightsV1FaqAnswerData properties: - phraseMatchers: + source: + type: string description: >- - The list of phrase matchers to run. If not provided, all active - phrase matchers will be used. If inactive phrase matchers are - provided, they will not be used. Phrase matchers will be run only if - run_phrase_matcher_annotator is set to true. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - type: array - items: - type: string - runSentimentAnnotator: - type: boolean - description: Whether to run the sentiment annotator. - summarizationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - description: Configuration for the summarization annotator. - runInterruptionAnnotator: - description: Whether to run the interruption annotator. - type: boolean - issueModels: - items: + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. + confidenceScore: + format: float + type: number + description: >- + The system's confidence score that this answer is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + metadata: + additionalProperties: type: string description: >- - The issue model to run. If not provided, the most recently deployed - topic model will be used. The provided issue model will only be used - for inference if the issue model is deployed and if - run_issue_model_annotator is set to true. If more than one issue - model is provided, only the first provided issue model will be used - for inference. - type: array - runIssueModelAnnotator: + Map that contains metadata about the FAQ answer and the document + that it originates from. + type: object + queryRecord: + type: string description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - type: boolean - runPhraseMatcherAnnotator: - type: boolean - description: Whether to run the active phrase matcher annotator(s). - runEntityAnnotator: - type: boolean - description: Whether to run the entity annotator. - runSummarizationAnnotator: - type: boolean - description: Whether to run the summarization annotator. - runSilenceAnnotator: - description: Whether to run the silence annotator. - type: boolean - runIntentAnnotator: - description: Whether to run the intent annotator. - type: boolean - description: Selector of all available annotators and phrase matchers to run. - id: GoogleCloudContactcenterinsightsV1AnnotatorSelector + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + question: + description: The corresponding FAQ question. + type: string + answer: + type: string + description: The piece of text from the `source` knowledge base document. type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModel: - description: The issue model resource. - id: GoogleCloudContactcenterinsightsV1alpha1IssueModel + description: Agent Assist frequently-asked-question answer data. + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: type: object + description: The request to analyze conversations in bulk. properties: - name: - type: string + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - displayName: - type: string - description: The representative name for the issue model. - trainingStats: + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + analysisPercentage: description: >- - Output only. Immutable. The issue model's label statistics on its - training data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats - readOnly: true - modelType: - enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 - description: Type of the model. + Required. Percentage of selected conversation to analyze, between + [0, 100]. + type: number + format: float + filter: + description: >- + Required. Filter used to select the subset of conversations to + analyze. type: string - enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - state: + parent: type: string - description: Output only. State of the model. + description: Required. The parent resource to create analyses in. + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse: + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse + description: The response to initialize a location-level encryption specification. + properties: {} + type: object + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: + properties: + completedAnalysesCount: + format: int32 + type: integer + description: >- + The number of requested analyses that have completed successfully so + far. + totalRequestedAnalysesCount: + description: >- + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. + format: int32 + type: integer + partialErrors: readOnly: true - enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING - enumDescriptions: - - Unspecified. - - Model is not deployed but is ready to deploy. - - Model is being deployed. - - >- - Model is deployed and is ready to be used. A model can only be - used in analysis if it's in this state. - - Model is being undeployed. - - Model is being deleted. - inputDataConfig: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. + type: array + failedAnalysesCount: + description: The number of requested analyses that have failed so far. + format: int32 + type: integer + request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - description: Configs for the input data that used to create the issue model. + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + description: The original request for bulk analyze. createTime: - readOnly: true type: string - description: Output only. The time at which this issue model was created. format: google-datetime - issueCount: - type: string - format: int64 - readOnly: true - description: Output only. Number of issues in this issue model. - updateTime: - readOnly: true + description: The time the operation was created. + endTime: format: google-datetime + type: string + description: The time the operation finished running. + type: object + description: The metadata for a bulk analyze conversations operation. + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata + GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + properties: + dialogflowParticipantName: description: >- - Output only. The most recent time at which the issue model was - updated. + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} type: string - languageCode: + role: + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + description: The role of the participant. type: string - description: Language of the model. - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: - properties: - parent: + obfuscatedExternalUserId: + description: Obfuscated user ID from Dialogflow. + type: string + userId: + type: string + description: A user-specified ID representing the participant. + dialogflowParticipant: + deprecated: true type: string - description: Required. The parent resource of the issue model. - gcsSource: - description: Google Cloud Storage source message. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - createNewModel: description: >- - Optional. If set to true, will create an issue model from the - imported file with randomly generated IDs for the issue model and - corresponding issues. Otherwise, replaces an existing model with the - same ID as the file. - type: boolean + Deprecated. Use `dialogflow_participant_name` instead. The name of + the Dialogflow participant. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + description: The call participant speaking for a given utterance. + type: object + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse + description: The response for a bulk delete conversations operation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: + id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig type: object - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - description: Request to import an issue model. - GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: properties: - displayName: + speechRecognizer: type: string - description: The human-readable name of the intent. - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. - type: object - GoogleRpcStatus: + description: >- + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + Speech-to-Text configuration. Speech-to-Text settings are applied to + conversations ingested from the `UploadConversation` and + `IngestConversations` endpoints, including conversation coming from CCAI + Platform. They are not applied to conversations ingested from the + `CreateConversation` endpoint. + GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: + properties: + appliedRedactionConfig: + description: >- + Output only. The redaction config applied to the uploaded + conversation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest + readOnly: true + description: Output only. The original request. + createTime: + type: string + description: Output only. The time the operation was created. + readOnly: true + format: google-datetime + analysisOperation: + readOnly: true + description: >- + Output only. The operation name for a successfully created analysis + operation, if any. + type: string + endTime: + readOnly: true + description: Output only. The time the operation finished running. + type: string + format: google-datetime + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata + description: The metadata for an `UploadConversation` operation. + type: object + GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: + properties: {} + description: The response to deploy an issue model. + type: object + id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: type: object properties: - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + customMetadataKeys: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Optional. Custom keys to extract as conversation labels from + metadata files in `metadata_bucket_uri`. Keys not included in this + field will be ignored. Note that there is a limit of 20 labels per + conversation. type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: + items: + type: string + metadataBucketUri: + type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Optional. The Cloud Storage path to the conversation metadata. Note + that: [1] Metadata files are expected to be in JSON format. [2] + Metadata and source files (transcripts or audio) must be in separate + buckets. [3] A source file and its corresponding metadata file must + share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. + bucketUri: type: string - id: GoogleRpcStatus - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: - description: Conversation summarization suggestion data. + description: Required. The Cloud Storage bucket containing source objects. + bucketObjectType: + type: string + description: Optional. Specifies the type of the objects in `bucket_uri`. + enumDescriptions: + - The object type is unspecified and will default to `TRANSCRIPT`. + - The object is a transcript. + - The object is an audio file. + enum: + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO id: >- - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + description: Configuration for Cloud Storage bucket sources. + GoogleCloudContactcenterinsightsV1alpha1HoldData: + type: object + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1HoldData + description: The data for a hold annotation. + GoogleCloudContactcenterinsightsV1PhraseMatcher: + type: object properties: - text: - description: The summarization content that is concatenated into one string. + phraseMatchRuleGroups: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + description: A list of phase match rule groups that are included in this matcher. + name: type: string - conversationModel: description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} + The resource name of the phrase matcher. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + active: + description: Applies the phrase matcher only when it is active. + type: boolean + displayName: + description: The human-readable name of the phrase matcher. + type: string + type: + description: Required. The type of this phrase matcher. + type: string + enum: + - PHRASE_MATCHER_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + enumDescriptions: + - Unspecified. + - Must meet all phrase match rule groups or there is no match. + - If any of the phrase match rule groups are met, there is a match. + revisionCreateTime: + format: google-datetime + readOnly: true type: string - answerRecord: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} + Output only. The timestamp of when the revision was created. It is + also the create time when a new matcher is added. + updateTime: + format: google-datetime + readOnly: true type: string - confidence: - format: float - type: number - description: The confidence score of the summarization. - metadata: - additionalProperties: - type: string description: >- - A map that contains metadata about the summarization and the - document from which it originates. - type: object - textSections: - type: object - additionalProperties: - type: string + Output only. The most recent time at which the phrase matcher was + updated. + revisionId: + readOnly: true + type: string description: >- - The summarization content that is divided into sections. The key is - the section's name and the value is the section's content. There is - no specific format for the key or value. - type: object - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: - description: Configuration for summarization. - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - type: object - properties: - conversationProfile: + Output only. Immutable. The revision ID of the phrase matcher. A new + revision is committed whenever the matcher is changed, except when + it is activated or deactivated. A server generated random ID will be + used. Example: + locations/global/phraseMatchers/my-first-matcher@1234567 + versionTag: description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + The customized version tag to use for the phrase matcher. If not + specified, it will default to `revision_id`. type: string - summarizationModel: + activationUpdateTime: + readOnly: true + format: google-datetime + description: >- + Output only. The most recent time at which the activation status was + updated. type: string + roleMatch: enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - description: Default summarization model to be used. - GoogleCloudContactcenterinsightsV1SentimentData: - type: object - id: GoogleCloudContactcenterinsightsV1SentimentData - properties: - score: - type: number - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - format: float - magnitude: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + type: string description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. - format: float - type: number - description: The data for a sentiment annotation. - GoogleCloudContactcenterinsightsV1IngestConversationsRequest: + The role whose utterances the phrase matcher should be matched + against. If the role is ROLE_UNSPECIFIED it will be matched against + any utterances in the transcript. + id: GoogleCloudContactcenterinsightsV1PhraseMatcher + description: The phrase matcher resource. + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: type: object - description: The request to ingest conversations. + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse + description: The response to undeploy an issue model. + properties: {} + GoogleCloudContactcenterinsightsV1HoldData: + properties: {} + type: object + id: GoogleCloudContactcenterinsightsV1HoldData + description: The data for a hold annotation. + GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: properties: - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - parent: + deidentifyTemplate: type: string - description: Required. The parent resource for new conversations. - transcriptObjectConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for when `source` contains conversation transcripts. - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource - description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - conversationConfig: - description: Configuration that applies to all conversations. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - sampleSize: - format: int32 - description: >- - Optional. If set, this fields indicates the number of objects to - ingest from the Cloud Storage bucket. If empty, the entire bucket - will be ingested. Unless they are first deleted, conversations - produced through sampling won't be ingested by subsequent ingest - requests. - type: integer - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: - description: The response to deploy an issue model. - properties: {} - type: object - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: - properties: - word: - type: string - description: The word itself. Includes punctuation marks that surround the word. - confidence: - description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - word. A default value of 0.0 indicates that the value is unset. - type: number - format: float - endOffset: - type: string - format: google-duration - description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. - startOffset: - type: string - description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. - format: google-duration - description: Word-level info for words in a transcript. - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo - type: object - GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: - type: object - description: Request to upload a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest - properties: - redactionConfig: - description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - speechConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. - conversation: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation - description: Required. The conversation resource to create. - conversationId: - type: string - description: >- - Optional. A unique ID for the new conversation. This ID will become - the final component of the conversation's resource name. If no ID is - specified, a server-generated ID will be used. This value should be - 4-64 characters and must match the regular expression - `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` - parent: - description: Required. The parent resource of the conversation. - type: string - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig - type: object - description: Configuration that applies to all conversations. - properties: - agentChannel: - type: integer - format: int32 - description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - agentId: description: >- - Optional. An opaque, user-specified string representing a human - agent who handled all conversations in the import. Note that this - will be overridden if per-conversation metadata is provided through - the `metadata_bucket_uri`. - type: string - customerChannel: - format: int32 - type: integer + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` + inspectTemplate: description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - GoogleCloudContactcenterinsightsV1alpha1Entity: - type: object - description: >- - The data for an entity annotation. Represents a phrase in the - conversation that is a known entity, such as a person, an organization, - or location. - properties: - type: - description: The entity type. - enumDescriptions: - - Unspecified. - - Person. - - Location. - - Organization. - - Event. - - Artwork. - - Consumer product. - - Other types of entities. - - >- - Phone number. The metadata lists the phone number (formatted - according to local convention), plus whichever additional elements - appear in the text: * `number` - The actual number, broken down - into sections according to local convention. * `national_prefix` - - Country code, if detected. * `area_code` - Region or area code, if - detected. * `extension` - Phone extension (to be dialed after - connection), if detected. - - >- - Address. The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - Street number. * `locality` - City or town. * - `street_name` - Street/route name, if detected. * `postal_code` - - Postal code, if detected. * `country` - Country, if detected. * - `broad_region` - Administrative area, such as the state, if - detected. * `narrow_region` - Smaller administrative area, such as - county, if detected. * `sublocality` - Used in Asian addresses to - demark a district within a city, if detected. - - >- - Date. The metadata identifies the components of the date: * `year` - - Four digit year, if detected. * `month` - Two digit month - number, if detected. * `day` - Two digit day number, if detected. - - Number. The metadata is the number itself. - - Price. The metadata identifies the `value` and `currency`. - enum: - - TYPE_UNSPECIFIED - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - type: string - displayName: + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` type: string - description: The representative name for the entity. - salience: - type: number - format: float - description: >- - The salience score associated with the entity in the [0, 1.0] range. - The salience score for an entity provides information about the - importance or centrality of that entity to the entire document text. - Scores closer to 0 are less salient, while scores closer to 1.0 are - highly salient. - metadata: - type: object - additionalProperties: - type: string - description: >- - Metadata associated with the entity. For most entity types, the - metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph - MID (`mid`), if they are available. For the metadata associated with - other entity types, see the Type table below. - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: >- - The aggregate sentiment expressed for this entity in the - conversation. - id: GoogleCloudContactcenterinsightsV1alpha1Entity - GoogleCloudContactcenterinsightsV1RedactionConfig: description: >- DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the @@ -1177,3013 +989,2697 @@ components: Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. - id: GoogleCloudContactcenterinsightsV1RedactionConfig + id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig type: object + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: + description: A segment of a full transcript. properties: - inspectTemplate: + sentiment: + description: The sentiment for this transcript segment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + channelTag: description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` + For conversations derived from multi-channel audio, this is the + channel number corresponding to the audio from that channel. For + audioChannelCount = N, its output values can range from '1' to 'N'. + A channel tag of 0 indicates that the audio is mono. + type: integer + format: int32 + dialogflowSegmentMetadata: + description: CCAI metadata relating to the current transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + text: type: string - deidentifyTemplate: + description: The text of this segment. + segmentParticipant: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant + description: The participant of this segment. + languageCode: + description: >- + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". type: string + words: description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` - GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: - type: object - description: The response of listing issue models. - id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse - properties: - issueModels: + A list of the word-specific information for each word in the + segment. type: array - description: The issue models that match the request. - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - GoogleCloudContactcenterinsightsV1FaqAnswerData: - type: object - id: GoogleCloudContactcenterinsightsV1FaqAnswerData - description: Agent Assist frequently-asked-question answer data. - properties: - source: - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - type: string - answer: - type: string - description: The piece of text from the `source` knowledge base document. - confidenceScore: - description: >- - The system's confidence score that this answer is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - type: number - format: float - question: - description: The corresponding FAQ question. - type: string - metadata: - additionalProperties: - type: string - type: object - description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - queryRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: - properties: - createTime: - type: string - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true - endTime: - format: google-datetime - type: string - readOnly: true - description: Output only. The time the operation finished running. - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - description: The original request for creation. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata - description: Metadata for creating an issue model. - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - type: object - properties: - agentInfo: items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - type: array - description: Information about agents involved in the call. - menuPath: - type: string - description: >- - An arbitrary string value specifying the menu path the customer - took. - customerSatisfactionRating: - format: int32 - type: integer - description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - waitDuration: - description: The amount of time the customer waited to connect with an agent. - format: google-duration - type: string - description: Conversation metadata related to quality management. - GoogleCloudContactcenterinsightsV1UploadConversationRequest: - properties: - parent: - type: string - description: Required. The parent resource of the conversation. - conversationId: - type: string - description: >- - Optional. A unique ID for the new conversation. This ID will become - the final component of the conversation's resource name. If no ID is - specified, a server-generated ID will be used. This value should be - 4-64 characters and must match the regular expression - `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. - conversation: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' - description: Required. The conversation resource to create. - id: GoogleCloudContactcenterinsightsV1UploadConversationRequest - type: object - description: Request to upload a conversation. - GoogleCloudContactcenterinsightsV1AnalysisResult: - properties: - endTime: - description: The time at which the analysis ended. - type: string - format: google-datetime - callAnalysisMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata - description: Call-specific metadata created by the analysis. - type: object - description: The result of an analysis. - id: GoogleCloudContactcenterinsightsV1AnalysisResult - GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: - id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - properties: - issue: - description: Resource name of the assigned issue. - type: string - displayName: - description: >- - Immutable. Display name of the assigned issue. This field is set at - time of analyis and immutable since then. - type: string - score: - type: number - format: double - description: >- - Score indicating the likelihood of the issue assignment. currently - bounded on [0,1]. - type: object - description: Information about the issue. - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - description: The request to analyze conversations in bulk. - properties: - analysisPercentage: - description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + confidence: format: float type: number - parent: - type: string - description: Required. The parent resource to create analyses in. - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - filter: - type: string description: >- - Required. Filter used to select the subset of conversations to - analyze. - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse - type: object - description: Response from export issue model - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: - properties: - objectUri: - description: 'Required. Format: `gs:///`' - type: string - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - description: Google Cloud Storage Object URI to get the issue model file from. - type: object - GoogleCloudContactcenterinsightsV1ConversationParticipant: - id: GoogleCloudContactcenterinsightsV1ConversationParticipant - description: The call participant speaking for a given utterance. - properties: - obfuscatedExternalUserId: - type: string - description: Obfuscated user ID from Dialogflow. - dialogflowParticipantName: - description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - type: string - userId: - type: string - description: A user-specified ID representing the participant. - role: - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - description: The role of the participant. - type: string - dialogflowParticipant: - deprecated: true + A confidence estimate between 0.0 and 1.0 of the fidelity of this + segment. A default value of 0.0 indicates that the value is unset. + messageTime: + format: google-datetime type: string - description: >- - Deprecated. Use `dialogflow_participant_name` instead. The name of - the Dialogflow participant. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + description: The time that the message occurred, if provided. type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: - description: Metadata used for export issue model. - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: + description: Metadata for deleting an issue model. + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata type: object properties: createTime: + readOnly: true type: string - description: The time the operation was created. format: google-datetime + description: Output only. The time the operation was created. + request: + description: The original request for deletion. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest endTime: - description: The time the operation finished running. format: google-datetime + readOnly: true + description: Output only. The time the operation finished running. type: string - request: - description: The original export request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest - GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: + GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: + description: Response from import issue model + properties: {} + id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse + type: object + GoogleCloudContactcenterinsightsV1alpha1InterruptionData: + properties: {} + description: The data for an interruption annotation. + id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData type: object + GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: properties: - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - runtimeIntegrationAnalysisPercentage: - type: number - description: >- - Percentage of conversations created using Dialogflow runtime - integration to analyze automatically, between [0, 100]. - format: double - uploadConversationAnalysisPercentage: - description: >- - Percentage of conversations created using the UploadConversation - endpoint to analyze automatically, between [0, 100]. - format: double - type: number - description: Default configuration when creating Analyses in Insights. - id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: - description: Response for an export insights operation. - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse - type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats - properties: - analyzedConversationsCount: - description: >- - Number of conversations the issue model has analyzed at this point - in time. - format: int64 - type: string - issueStats: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats - description: Statistics on each issue. Key is the issue's resource name. - type: object - unclassifiedConversationsCount: - format: int64 - description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. - type: string - description: Aggregated statistics about an issue model. - GoogleCloudContactcenterinsightsV1SmartReplyData: - properties: - reply: - type: string - description: The content of the reply. - metadata: - additionalProperties: - type: string - description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. - type: object - queryRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string - confidenceScore: - type: number - description: >- - The system's confidence score that this reply is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - format: double - description: Agent Assist Smart Reply data. - type: object - id: GoogleCloudContactcenterinsightsV1SmartReplyData - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: - description: Configuration for processing transcript objects. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - properties: - medium: - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - type: string - description: Required. The medium transcript objects represent. - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest - description: Request to export an issue model. - type: object - properties: - gcsDestination: - description: Google Cloud Storage URI to export the issue model to. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination name: - type: string description: Required. The issue model to export. - GoogleCloudContactcenterinsightsV1DialogflowSource: - type: object - description: A Dialogflow source of conversation data. - properties: - audioUri: - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - type: string - dialogflowConversation: - readOnly: true - type: string - description: >- - Output only. The name of the Dialogflow conversation that this - conversation resource is derived from. Format: - projects/{project}/locations/{location}/conversations/{conversation} - id: GoogleCloudContactcenterinsightsV1DialogflowSource - GoogleCloudContactcenterinsightsV1PhraseMatchRule: - type: object - description: The data for a phrase match rule. - properties: - negated: - type: boolean - description: >- - Specifies whether the phrase must be missing from the transcript - segment or present in the transcript segment. - query: - description: Required. The phrase to be matched. - type: string - config: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig - description: >- - Provides additional information about the rule that specifies how to - apply the rule. - id: GoogleCloudContactcenterinsightsV1PhraseMatchRule - GoogleCloudContactcenterinsightsV1alpha1InterruptionData: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData - description: The data for an interruption annotation. - properties: {} - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: - type: object - properties: - annotatorSelector: - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - parent: - type: string - description: Required. The parent resource to create analyses in. - filter: - type: string - description: >- - Required. Filter used to select the subset of conversations to - analyze. - analysisPercentage: - type: number - description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. - format: float - description: The request to analyze conversations in bulk. - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: - description: The metadata for a bulk analyze conversations operation. - type: object - properties: - endTime: - type: string - description: The time the operation finished running. - format: google-datetime - failedAnalysesCount: - description: The number of requested analyses that have failed so far. - format: int32 - type: integer - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - type: array - description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. - request: - description: The original request for bulk analyze. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - totalRequestedAnalysesCount: - format: int32 - description: >- - Total number of analyses requested. Computed by the number of - conversations returned by `filter` multiplied by - `analysis_percentage` in the request. - type: integer - completedAnalysesCount: - format: int32 - type: integer - description: >- - The number of requested analyses that have completed successfully so - far. - createTime: - description: The time the operation was created. - type: string - format: google-datetime - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata - GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: - description: Configs for the input data used to create the issue model. - properties: - filter: - description: >- - A filter to reduce the conversations used for training the model to - a specific subset. - type: string - medium: - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - type: string - description: >- - Medium of conversations used in training data. This field is being - deprecated. To specify the medium to be used in training a new issue - model, set the `medium` field on `filter`. - deprecated: true - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - trainingConversationsCount: - description: Output only. Number of conversations used in training. Output only. - readOnly: true - format: int64 - type: string - type: object - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: - properties: - runSentimentAnnotator: - description: Whether to run the sentiment annotator. - type: boolean - issueModels: - description: >- - The issue model to run. If not provided, the most recently deployed - topic model will be used. The provided issue model will only be used - for inference if the issue model is deployed and if - run_issue_model_annotator is set to true. If more than one issue - model is provided, only the first provided issue model will be used - for inference. - type: array - items: - type: string - runInterruptionAnnotator: - description: Whether to run the interruption annotator. - type: boolean - runSummarizationAnnotator: - description: Whether to run the summarization annotator. - type: boolean - phraseMatchers: - description: >- - The list of phrase matchers to run. If not provided, all active - phrase matchers will be used. If inactive phrase matchers are - provided, they will not be used. Phrase matchers will be run only if - run_phrase_matcher_annotator is set to true. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - items: - type: string - type: array - summarizationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - description: Configuration for the summarization annotator. - runIntentAnnotator: - description: Whether to run the intent annotator. - type: boolean - runEntityAnnotator: - type: boolean - description: Whether to run the entity annotator. - runPhraseMatcherAnnotator: - type: boolean - description: Whether to run the active phrase matcher annotator(s). - runSilenceAnnotator: - type: boolean - description: Whether to run the silence annotator. - runIssueModelAnnotator: - type: boolean - description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: Selector of all available annotators and phrase matchers to run. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - description: Configuration for Cloud Storage bucket sources. - type: object - properties: - bucketUri: - type: string - description: Required. The Cloud Storage bucket containing source objects. - customMetadataKeys: - description: >- - Optional. Custom keys to extract as conversation labels from - metadata files in `metadata_bucket_uri`. Keys not included in this - field will be ignored. Note that there is a limit of 20 labels per - conversation. - items: - type: string - type: array - metadataBucketUri: - type: string - description: >- - Optional. The Cloud Storage path to the conversation metadata. Note - that: [1] Metadata files are expected to be in JSON format. [2] - Metadata and source files (transcripts or audio) must be in separate - buckets. [3] A source file and its corresponding metadata file must - share the same name to be properly ingested, E.g. - `gs://bucket/audio/conversation1.mp3` and - `gs://bucket/metadata/conversation1.json`. - bucketObjectType: - type: string - enumDescriptions: - - The object type is unspecified and will default to `TRANSCRIPT`. - - The object is a transcript. - - The object is an audio file. - enum: - - BUCKET_OBJECT_TYPE_UNSPECIFIED - - TRANSCRIPT - - AUDIO - description: Optional. Specifies the type of the objects in `bucket_uri`. - GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: - type: object - properties: - dialogflowParticipant: - type: string - description: >- - Deprecated. Use `dialogflow_participant_name` instead. The name of - the Dialogflow participant. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - deprecated: true - obfuscatedExternalUserId: - description: Obfuscated user ID from Dialogflow. - type: string - dialogflowParticipantName: - type: string - description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - role: - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - type: string - description: The role of the participant. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - userId: - type: string - description: A user-specified ID representing the participant. - description: The call participant speaking for a given utterance. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest - properties: - filter: - description: Filter used to select the subset of conversations to delete. - type: string - force: - type: boolean - description: >- - If set to true, all of this conversation's analyses will also be - deleted. Otherwise, the request will only succeed if the - conversation has no analyses. - parent: - type: string - description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} - maxDeleteCount: - description: Maximum number of conversations to delete. - format: int32 - type: integer - description: The request to delete conversations in bulk. - type: object - GoogleCloudContactcenterinsightsV1ConversationDataSource: - type: object - id: GoogleCloudContactcenterinsightsV1ConversationDataSource - description: The conversation source, which is a combination of transcript and audio. - properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' - description: A Cloud Storage location specification for the audio and transcript. - dialogflowSource: - description: The source when the conversation comes from Dialogflow. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: - description: The response for a bulk analyze conversations operation. - properties: - successfulAnalysisCount: - description: Count of successful analyses. - type: integer - format: int32 - failedAnalysisCount: - type: integer - format: int32 - description: Count of failed analyses. - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: - type: object - description: Google Cloud Storage Object URI to save the issue model to. - properties: - objectUri: - type: string - description: 'Required. Format: `gs:///`' - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: - type: object - description: Issue Modeling result on a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - properties: - issueModel: - description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - type: string - issues: - description: All the matched issues. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - type: array - GoogleCloudContactcenterinsightsV1InterruptionData: - type: object - properties: {} - description: The data for an interruption annotation. - id: GoogleCloudContactcenterinsightsV1InterruptionData - GoogleCloudContactcenterinsightsV1Entity: - type: object - properties: - sentiment: - description: >- - The aggregate sentiment expressed for this entity in the - conversation. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - type: - description: The entity type. - type: string - enumDescriptions: - - Unspecified. - - Person. - - Location. - - Organization. - - Event. - - Artwork. - - Consumer product. - - Other types of entities. - - >- - Phone number. The metadata lists the phone number (formatted - according to local convention), plus whichever additional elements - appear in the text: * `number` - The actual number, broken down - into sections according to local convention. * `national_prefix` - - Country code, if detected. * `area_code` - Region or area code, if - detected. * `extension` - Phone extension (to be dialed after - connection), if detected. - - >- - Address. The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - Street number. * `locality` - City or town. * - `street_name` - Street/route name, if detected. * `postal_code` - - Postal code, if detected. * `country` - Country, if detected. * - `broad_region` - Administrative area, such as the state, if - detected. * `narrow_region` - Smaller administrative area, such as - county, if detected. * `sublocality` - Used in Asian addresses to - demark a district within a city, if detected. - - >- - Date. The metadata identifies the components of the date: * `year` - - Four digit year, if detected. * `month` - Two digit month - number, if detected. * `day` - Two digit day number, if detected. - - Number. The metadata is the number itself. - - Price. The metadata identifies the `value` and `currency`. - enum: - - TYPE_UNSPECIFIED - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - displayName: - description: The representative name for the entity. - type: string - salience: - type: number - format: float - description: >- - The salience score associated with the entity in the [0, 1.0] range. - The salience score for an entity provides information about the - importance or centrality of that entity to the entire document text. - Scores closer to 0 are less salient, while scores closer to 1.0 are - highly salient. - metadata: - description: >- - Metadata associated with the entity. For most entity types, the - metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph - MID (`mid`), if they are available. For the metadata associated with - other entity types, see the Type table below. - type: object - additionalProperties: - type: string - description: >- - The data for an entity annotation. Represents a phrase in the - conversation that is a known entity, such as a person, an organization, - or location. - id: GoogleCloudContactcenterinsightsV1Entity - GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - description: The conversation source, which is a combination of transcript and audio. - properties: - dialogflowSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource - description: The source when the conversation comes from Dialogflow. - gcsSource: - description: A Cloud Storage location specification for the audio and transcript. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource - type: object - GoogleCloudContactcenterinsightsV1alpha1SentimentData: - id: GoogleCloudContactcenterinsightsV1alpha1SentimentData - properties: - magnitude: - format: float - description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. - type: number - score: - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - format: float - type: number - description: The data for a sentiment annotation. + type: string + gcsDestination: + description: Google Cloud Storage URI to export the issue model to. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest type: object - GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: + description: Request to export an issue model. + GoogleCloudContactcenterinsightsV1IssueMatchData: + id: GoogleCloudContactcenterinsightsV1IssueMatchData + type: object + description: The data for an issue match annotation. properties: - startBoundary: + issueAssignment: + description: Information about the issue's assignment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: + properties: + sampleSize: + type: integer + format: int32 description: >- - The boundary in the conversation where the annotation starts, - inclusive. - conversationSummarizationSuggestion: + Optional. If set, this fields indicates the number of objects to + ingest from the Cloud Storage bucket. If empty, the entire bucket + will be ingested. Unless they are first deleted, conversations + produced through sampling won't be ingested by subsequent ingest + requests. + redactionConfig: + description: >- + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - description: Conversation summarization suggestion data. - annotationId: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + speechConfig: description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + parent: type: string - smartReply: + description: Required. The parent resource for new conversations. + transcriptObjectConfig: + description: Configuration for when `source` contains conversation transcripts. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData - description: Agent Assist Smart Reply data. - userInput: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig + gcsSource: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput - description: Explicit input used for generating the answer - faqAnswer: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + description: >- + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + conversationConfig: + description: Configuration that applies to all conversations. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - description: Agent Assist FAQ answer data. - createTime: - description: The time at which this annotation was created. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig + description: The request to ingest conversations. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: + type: object + properties: + objectUri: type: string - format: google-datetime - endBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + description: 'Required. Format: `gs:///`' + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource + description: Google Cloud Storage Object URI to get the issue model file from. + GoogleCloudContactcenterinsightsV1IssueAssignment: + id: GoogleCloudContactcenterinsightsV1IssueAssignment + description: Information about the issue. + properties: + score: description: >- - The boundary in the conversation where the annotation ends, - inclusive. - answerFeedback: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback - description: The feedback that the customer has about the answer in `data`. - smartComposeSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. - dialogflowInteraction: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData - description: Dialogflow interaction data. - articleSuggestion: - description: Agent Assist Article Suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + Score indicating the likelihood of the issue assignment. currently + bounded on [0,1]. + format: double + type: number + displayName: + type: string + description: >- + Immutable. Display name of the assigned issue. This field is set at + time of analyis and immutable since then. + issue: + description: Resource name of the assigned issue. + type: string type: object - id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + properties: + team: + description: A user-specified string representing the agent's team. + type: string + agentId: + description: A user-specified string representing the agent. + type: string + dispositionCode: + description: >- + A user-provided string indicating the outcome of the agent's segment + of the call. + type: string + displayName: + description: The agent's name. + type: string + description: Information about an agent involved in the conversation. + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: + type: object + properties: {} + description: Response from export issue model + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: + description: The response for a bulk analyze conversations operation. + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse + type: object + properties: + failedAnalysisCount: + type: integer + format: int32 + description: Count of failed analyses. + successfulAnalysisCount: + description: Count of successful analyses. + format: int32 + type: integer + GoogleCloudContactcenterinsightsV1InterruptionData: + properties: {} + description: The data for an interruption annotation. + type: object + id: GoogleCloudContactcenterinsightsV1InterruptionData + GoogleCloudContactcenterinsightsV1alpha1Intent: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1Intent + properties: + displayName: + description: The human-readable name of the intent. + type: string + id: + type: string + description: The unique identifier of the intent. description: >- - An annotation that was generated during the customer and agent - interaction. - GoogleCloudContactcenterinsightsV1SpeechConfig: + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. + GoogleCloudContactcenterinsightsV1alpha1IntentMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData description: >- - Speech-to-Text configuration. Speech-to-Text settings are applied to - conversations ingested from the `UploadConversation` and - `IngestConversations` endpoints, including conversation coming from CCAI - Platform. They are not applied to conversations ingested from the - `CreateConversation` endpoint. + The data for an intent match. Represents an intent match for a text + segment in the conversation. A text segment can be part of a sentence, a + complete sentence, or an utterance with multiple sentences. type: object properties: - speechRecognizer: + intentUniqueId: + type: string description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + The id of the matched intent. Can be used to retrieve the + corresponding intent information. + GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: + type: object + description: The request to deploy an issue model. + properties: + name: + description: Required. The issue model to deploy. type: string - id: GoogleCloudContactcenterinsightsV1SpeechConfig - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse: - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse - properties: {} + id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: + description: Aggregated statistics about an issue. type: object - description: The response to initialize a location-level encryption specification. - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata: - description: Metadata for initializing a location-level encryption specification. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats properties: - endTime: - readOnly: true - format: google-datetime - description: Output only. The time the operation finished running. + displayName: type: string - request: - description: Output only. The original request for initialization. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest - readOnly: true - createTime: + description: Display name of the issue. + labeledConversationsCount: type: string - format: google-datetime - readOnly: true - description: Output only. The time the operation was created. - partialErrors: + description: Number of conversations attached to the issue at this point in time. + format: int64 + issue: + type: string + description: >- + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: + description: A message representing a rule in the phrase matcher. + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + properties: + phraseMatchRules: items: - $ref: '#/components/schemas/GoogleRpcStatus' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule type: array - description: >- - Partial errors during initialising operation that might cause the - operation output to be incomplete. - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata + description: A list of phrase match rules that are included in this group. + type: + description: Required. The type of this phrase match rule group. + enumDescriptions: + - Unspecified. + - Must meet all phrase match rules or there is no match. + - If any of the phrase match rules are met, there is a match. + enum: + - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + type: string type: object - GoogleCloudContactcenterinsightsV1alpha1Intent: - description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. - id: GoogleCloudContactcenterinsightsV1alpha1Intent + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: + description: Call-specific metadata created during analysis. type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata properties: - id: - type: string - description: The unique identifier of the intent. - displayName: - type: string - description: The human-readable name of the intent. - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: - properties: - partialErrors: + annotations: + description: A list of call annotations that apply to this call. + type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + intents: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent + description: All the matched intents in the call. + type: object + entities: + description: All the entities in the call. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity + type: object + sentiments: type: array - description: >- - Partial errors during export operation that might cause the - operation output to be incomplete. - endTime: - type: string - format: google-datetime - description: Output only. The time the operation finished running. - readOnly: true - request: + description: Overall conversation-level sentiment for each channel of the call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment + phraseMatchers: + description: All the matched phrase matchers in the call. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + silence: + description: Overall conversation-level silence during the call. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest - description: The original request for export. - createTime: - format: google-datetime - readOnly: true - type: string - description: Output only. The time the operation was created. - description: Metadata for an export insights operation. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + issueModelResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + description: Overall conversation-level issue modeling result. + GoogleCloudContactcenterinsightsV1RedactionConfig: + description: >- + DLP resources used for redaction while ingesting conversations. DLP + settings are applied to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversation coming from CCAI Platform. They are not applied to + conversations ingested from the `CreateConversation` endpoint or the + Dialogflow / Agent Assist runtime integrations. When using Dialogflow / + Agent Assist runtime integrations, redaction should be performed in + Dialogflow / Agent Assist. + id: GoogleCloudContactcenterinsightsV1RedactionConfig type: object properties: - processedObjectCount: - type: integer - readOnly: true - description: >- - Output only. The number of objects processed during the ingest - operation. - format: int32 - duplicatesSkippedCount: - readOnly: true - format: int32 - description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. - type: integer - failedIngestCount: + deidentifyTemplate: description: >- - Output only. The number of objects which were unable to be ingested - due to errors. The errors are populated in the partial_errors field. - type: integer - format: int32 - readOnly: true - successfulIngestCount: - type: integer - readOnly: true - format: int32 + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` + type: string + inspectTemplate: + type: string description: >- - Output only. The number of new conversations added during this - ingest operation. - description: Statistics for IngestConversations operation. - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: - description: The metadata for a bulk analyze conversations operation. - type: object - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` + GoogleCloudContactcenterinsightsV1alpha1IssueModel: properties: - endTime: - format: google-datetime - description: The time the operation finished running. + name: type: string - totalRequestedAnalysesCount: - format: int32 description: >- - Total number of analyses requested. Computed by the number of - conversations returned by `filter` multiplied by - `analysis_percentage` in the request. - type: integer - failedAnalysesCount: - format: int32 - description: The number of requested analyses that have failed so far. - type: integer - createTime: - description: The time the operation was created. - format: google-datetime + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + updateTime: type: string - completedAnalysesCount: + readOnly: true description: >- - The number of requested analyses that have completed successfully so - far. - type: integer - format: int32 - request: + Output only. The most recent time at which the issue model was + updated. + format: google-datetime + trainingStats: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - description: The original request for bulk analyze. - partialErrors: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats readOnly: true - items: - $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. - type: array - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: - description: Metadata for deploying an issue model. - properties: + Output only. Immutable. The issue model's label statistics on its + training data. createTime: - type: string format: google-datetime - description: Output only. The time the operation was created. readOnly: true - endTime: + description: Output only. The time at which this issue model was created. type: string - format: google-datetime - description: Output only. The time the operation finished running. - readOnly: true - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - description: The original request for deployment. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata - GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - properties: - name: + languageCode: type: string - description: Required. The name of the issue model to delete. - type: object - description: The request to delete an issue model. - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - properties: - smartReplyAllowlistCovered: - description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - type: boolean - type: object - description: Metadata from Dialogflow relating to the current transcript segment. - GoogleCloudContactcenterinsightsV1alpha1Analysis: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1Analysis - properties: - createTime: - description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. + description: Language of the model. + state: + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + enumDescriptions: + - Unspecified. + - Model is not deployed but is ready to deploy. + - Model is being deployed. + - >- + Model is deployed and is ready to be used. A model can only be + used in analysis if it's in this state. + - Model is being undeployed. + - Model is being deleted. readOnly: true type: string - format: google-datetime - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - analysisResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult - description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. + description: Output only. State of the model. + issueCount: readOnly: true - name: - description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} type: string - requestTime: + description: Output only. Number of issues in this issue model. + format: int64 + inputDataConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + description: Configs for the input data that used to create the issue model. + displayName: + type: string + description: The representative name for the issue model. + modelType: + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 + description: Type of the model. type: string - format: google-datetime - readOnly: true - description: Output only. The time at which the analysis was requested. - description: The analysis resource. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: + description: The issue model resource. type: object + id: GoogleCloudContactcenterinsightsV1alpha1IssueModel + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: + description: Conversation metadata related to quality management. properties: - duplicatesSkippedCount: - readOnly: true - description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. + waitDuration: + type: string + format: google-duration + description: The amount of time the customer waited to connect with an agent. + agentInfo: + type: array + description: Information about agents involved in the call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + customerSatisfactionRating: type: integer format: int32 - successfulIngestCount: - description: >- - Output only. The number of new conversations added during this - ingest operation. - readOnly: true - format: int32 - type: integer - processedObjectCount: description: >- - Output only. The number of objects processed during the ingest - operation. - readOnly: true - format: int32 - type: integer - failedIngestCount: - readOnly: true - type: integer + An arbitrary integer value indicating the customer's satisfaction + rating. + menuPath: + type: string description: >- - Output only. The number of objects which were unable to be ingested - due to errors. The errors are populated in the partial_errors field. - format: int32 - description: Statistics for IngestConversations operation. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats - GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: + An arbitrary string value specifying the menu path the customer + took. type: object - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest - description: Request to export an issue model. - properties: - name: - type: string - description: Required. The issue model to export. - gcsDestination: - description: Google Cloud Storage URI to export the issue model to. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - GoogleCloudContactcenterinsightsV1alpha1HoldData: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata + GoogleCloudContactcenterinsightsV1SmartReplyData: type: object - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1HoldData - description: The data for a hold annotation. - GoogleCloudContactcenterinsightsV1alpha1Conversation: + id: GoogleCloudContactcenterinsightsV1SmartReplyData properties: - expireTime: - type: string - format: google-datetime + metadata: + additionalProperties: + type: string description: >- - The time at which this conversation should expire. After this time, - the conversation data and any associated analyses will be deleted. - startTime: - format: google-datetime + Map that contains metadata about the Smart Reply and the document + from which it originates. + type: object + reply: + description: The content of the reply. type: string - description: The time at which the conversation started. - name: + confidenceScore: + format: double + type: number description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} + The system's confidence score that this reply is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - dataSource: - description: The source of the audio and transcription for the conversation. + description: Agent Assist Smart Reply data. + GoogleCloudContactcenterinsightsV1IngestConversationsRequest: + type: object + description: The request to ingest conversations. + properties: + redactionConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - obfuscatedUserId: + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + description: >- + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. + parent: + description: Required. The parent resource for new conversations. type: string - description: Obfuscated user ID which the customer sent to us. - turnCount: - readOnly: true + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource + description: >- + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + description: >- + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. + sampleSize: type: integer - description: Output only. The number of turns in the conversation. + description: >- + Optional. If set, this fields indicates the number of objects to + ingest from the Cloud Storage bucket. If empty, the entire bucket + will be ingested. Unless they are first deleted, conversations + produced through sampling won't be ingested by subsequent ingest + requests. format: int32 - callMetadata: + conversationConfig: + description: Configuration that applies to all conversations. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - description: Call-specific metadata. - createTime: - description: Output only. The time at which the conversation was created. - type: string - readOnly: true - format: google-datetime - dialogflowIntents: - readOnly: true - type: object - description: >- - Output only. All the matched Dialogflow intents in the call. The key - corresponds to a Dialogflow intent, format: - projects/{project}/agent/{agent}/intents/{intent} - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent - labels: + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig + transcriptObjectConfig: + description: Configuration for when `source` contains conversation transcripts. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: + properties: + confidence: + description: The confidence score of the summarization. + format: float + type: number + metadata: description: >- - A map for the user to specify any custom fields. A maximum of 20 - labels per conversation is allowed, with a maximum of 256 characters - per entry. + A map that contains metadata about the summarization and the + document from which it originates. type: object additionalProperties: type: string - transcript: - readOnly: true - description: Output only. The conversation transcript. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript - languageCode: - type: string - description: A user-specified language code for the conversation. - agentId: - type: string - description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. - runtimeAnnotations: - readOnly: true - type: array + textSections: + additionalProperties: + type: string description: >- - Output only. The annotations that were generated during the customer - and agent interaction. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation - duration: - readOnly: true - format: google-duration + The summarization content that is divided into sections. The key is + the section's name and the value is the section's content. There is + no specific format for the key or value. + type: object + conversationModel: type: string - description: Output only. The duration of the conversation. - latestAnalysis: - description: Output only. The conversation's latest analysis, if one exists. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis - readOnly: true - metadataJson: description: >- - Input only. JSON Metadata encoded as a string. This field is - primarily used by Insights integrations with various telphony - systems and must be in one of Insights' supported formats. + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} + text: + description: The summarization content that is concatenated into one string. type: string - updateTime: + answerRecord: + type: string + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: + type: object + properties: + customMetadataKeys: + items: + type: string + type: array description: >- - Output only. The most recent time at which the conversation was - updated. + Optional. Custom keys to extract as conversation labels from + metadata files in `metadata_bucket_uri`. Keys not included in this + field will be ignored. Note that there is a limit of 20 labels per + conversation. + metadataBucketUri: + description: >- + Optional. The Cloud Storage path to the conversation metadata. Note + that: [1] Metadata files are expected to be in JSON format. [2] + Metadata and source files (transcripts or audio) must be in separate + buckets. [3] A source file and its corresponding metadata file must + share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. type: string - readOnly: true - format: google-datetime - ttl: + bucketObjectType: + enumDescriptions: + - The object type is unspecified and will default to `TRANSCRIPT`. + - The object is a transcript. + - The object is an audio file. type: string - description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. - format: google-duration - latestSummary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - description: Output only. Latest summary of the conversation. - readOnly: true - qualityMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - description: Conversation metadata related to quality management. - medium: - description: >- - Immutable. The conversation medium, if unspecified will default to - PHONE_CALL. enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO + description: Optional. Specifies the type of the objects in `bucket_uri`. + bucketUri: + description: Required. The Cloud Storage bucket containing source objects. type: string + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource + description: Configuration for Cloud Storage bucket sources. + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: + properties: {} + description: Response from import issue model + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse type: object - id: GoogleCloudContactcenterinsightsV1alpha1Conversation - description: The conversation resource. - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest: - description: The request to initialize a location-level encryption specification. + GoogleCloudContactcenterinsightsV1DialogflowIntent: type: object - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest properties: - encryptionSpec: - description: >- - Required. The encryption spec used for CMEK encryption. It is - required that the kms key is in the same region as the endpoint. The - same key will be used for all provisioned resources, if encryption - is available. If the kms_key_name is left empty, no encryption will - be enforced. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec - GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: + displayName: + type: string + description: The human-readable name of the intent. + id: GoogleCloudContactcenterinsightsV1DialogflowIntent + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: type: object properties: - endTime: + endOffset: + description: >- + Time offset of the end of this word relative to the beginning of the + total conversation. type: string - description: Output only. The time the operation finished running. + format: google-duration + startOffset: + type: string + format: google-duration + description: >- + Time offset of the start of this word relative to the beginning of + the total conversation. + confidence: + format: float + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + word. A default value of 0.0 indicates that the value is unset. + type: number + word: + type: string + description: The word itself. Includes punctuation marks that surround the word. + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + description: Word-level info for words in a transcript. + GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: + description: Metadata for an export insights operation. + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata + properties: + createTime: readOnly: true + type: string format: google-datetime - request: - description: Output only. The original request for ingest. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + description: Output only. The time the operation was created. partialErrors: items: $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. Partial errors during ingest operation that might cause - the operation output to be incomplete. - readOnly: true + Partial errors during export operation that might cause the + operation output to be incomplete. type: array - createTime: - type: string - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true - ingestConversationsStats: - description: Output only. Statistics for IngestConversations operation. + request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats - readOnly: true - description: The metadata for an IngestConversations operation. - id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata - GoogleCloudContactcenterinsightsV1View: - properties: - value: - type: string - description: String with specific view properties, must be non-empty. - name: - type: string - description: >- - Immutable. The resource name of the view. Format: - projects/{project}/locations/{location}/views/{view} - updateTime: - description: Output only. The most recent time at which the view was updated. - format: google-datetime - readOnly: true - type: string - displayName: - description: The human-readable display name of the view. - type: string - createTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + description: The original request for export. + endTime: type: string format: google-datetime - description: Output only. The time at which this view was created. readOnly: true - id: GoogleCloudContactcenterinsightsV1View + description: Output only. The time the operation finished running. type: object - description: The View resource. - GoogleCloudContactcenterinsightsV1IssueModelLabelStats: - description: Aggregated statistics about an issue model. - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence type: object properties: - analyzedConversationsCount: - type: string - description: >- - Number of conversations the issue model has analyzed at this point - in time. - format: int64 - issueStats: - description: Statistics on each issue. Key is the issue's resource name. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - type: object - unclassifiedConversationsCount: + silencePercentage: + type: number + format: float + description: Percentage of the total conversation spent in silence. + silenceDuration: + format: google-duration + description: Amount of time calculated to be in silence. + type: string + description: Conversation-level silence data. + GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput: + description: Explicit input used for generating the answer + properties: + querySource: + enum: + - QUERY_SOURCE_UNSPECIFIED + - AGENT_QUERY + - SUGGESTED_QUERY + enumDescriptions: + - Unknown query source. + - The query is from agents. + - >- + The query is a query from previous suggestions, e.g. from a + preceding SuggestKnowledgeAssist response. + type: string + description: Query source for the answer. + query: + type: string + description: >- + Query text. Article Search uses this to store the input query used + to generate the search results. + generatorName: + description: >- + The resource name of associated generator. Format: + `projects//locations//generators/` type: string - format: int64 - description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. - GoogleCloudContactcenterinsightsV1CallAnnotation: - id: GoogleCloudContactcenterinsightsV1CallAnnotation - properties: - sentimentData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: Data specifying sentiment. - silenceData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' - description: Data specifying silence. - issueMatchData: - description: Data specifying an issue match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData - annotationEndBoundary: - description: >- - The boundary in the conversation where the annotation ends, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - annotationStartBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - description: >- - The boundary in the conversation where the annotation starts, - inclusive. - channelTag: - description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. - format: int32 - type: integer - phraseMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - description: Data specifying a phrase match. - intentMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData - description: Data specifying an intent match. - entityMentionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData - description: Data specifying an entity mention. - interruptionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData - description: Data specifying an interruption. - holdData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' - description: Data specifying a hold. - description: A piece of metadata that applies to a window of a call. - type: object - GoogleCloudContactcenterinsightsV1ListIssuesResponse: - properties: - issues: - type: array - description: The issues that match the request. - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' - id: GoogleCloudContactcenterinsightsV1ListIssuesResponse - description: The response of listing issues. type: object - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + GoogleCloudContactcenterinsightsV1EncryptionSpec: properties: - issueModel: - description: Required. The issue model to create. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel - parent: + kmsKey: type: string - description: Required. The parent resource of the issue model. + description: >- + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + name: + type: string + description: >- + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + id: GoogleCloudContactcenterinsightsV1EncryptionSpec type: object - description: The request to create an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats - description: Aggregated statistics about an issue. + GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: type: object + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo properties: - displayName: + agentId: type: string - description: Display name of the issue. - issue: - description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + description: A user-specified string representing the agent. + displayName: type: string - labeledConversationsCount: - description: Number of conversations attached to the issue at this point in time. + description: The agent's name. + team: type: string - format: int64 - GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: - properties: - speechRecognizer: + description: A user-specified string representing the agent's team. + dispositionCode: type: string description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` - description: >- - Speech-to-Text configuration. Speech-to-Text settings are applied to - conversations ingested from the `UploadConversation` and - `IngestConversations` endpoints, including conversation coming from CCAI - Platform. They are not applied to conversations ingested from the - `CreateConversation` endpoint. - id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + A user-provided string indicating the outcome of the agent's segment + of the call. + description: Information about an agent involved in the conversation. + GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: + properties: {} type: object - GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: + description: Response for an export insights operation. + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + description: >- + An annotation that was generated during the customer and agent + interaction. properties: - clicked: - description: Indicates whether an answer or item was clicked by the human agent. - type: boolean - displayed: - type: boolean + smartReply: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData + description: Agent Assist Smart Reply data. + articleSuggestion: + description: Agent Assist Article Suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + createTime: + description: The time at which this annotation was created. + format: google-datetime + type: string + annotationId: description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. - correctnessLevel: - enum: - - CORRECTNESS_LEVEL_UNSPECIFIED - - NOT_CORRECT - - PARTIALLY_CORRECT - - FULLY_CORRECT - enumDescriptions: - - Correctness level unspecified. - - Answer is totally wrong. - - Answer is partially correct. - - Answer is fully correct. + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} type: string - description: The correctness level of an answer. + endBoundary: + description: >- + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + dialogflowInteraction: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + description: Dialogflow interaction data. + answerFeedback: + description: The feedback that the customer has about the answer in `data`. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + userInput: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer + smartComposeSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + description: Agent Assist Smart Compose suggestion data. + startBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + description: >- + The boundary in the conversation where the annotation starts, + inclusive. + conversationSummarizationSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + faqAnswer: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + description: Agent Assist FAQ answer data. type: object - id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback - description: >- - The feedback that the customer has about a certain answer in the - conversation. - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: + GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData properties: - name: - type: string - description: Required. The name of the issue model to delete. - description: The request to delete an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + issueAssignment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + description: Information about the issue's assignment. type: object - GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: - properties: {} - id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse + description: The data for an issue match annotation. + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata type: object - description: Response from export issue model - GoogleCloudContactcenterinsightsV1Issue: properties: - displayDescription: - type: string - description: Representative description of the issue. - sampleUtterances: - type: array - readOnly: true - description: >- - Output only. Resource names of the sample representative utterances - that match to this issue. - items: - type: string - name: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + description: The original import request. + endTime: + format: google-datetime + description: The time the operation finished running. type: string - description: >- - Immutable. The resource name of the issue. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} createTime: - description: Output only. The time at which this issue was created. - readOnly: true - type: string format: google-datetime - displayName: + description: The time the operation was created. type: string - description: The representative name for the issue. - updateTime: - format: google-datetime + description: Metadata used for import issue model. + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + properties: + issueModel: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel + description: Required. The issue model to create. + parent: + description: Required. The parent resource of the issue model. type: string - description: Output only. The most recent time that this issue was updated. - readOnly: true - id: GoogleCloudContactcenterinsightsV1Issue type: object - description: The issue resource. - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: - description: The request to undeploy an issue model. + description: The request to create an issue model. + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment type: object properties: - name: - description: Required. The issue model to undeploy. - type: string - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest - GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: + sentimentData: + description: Data specifying sentiment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + channelTag: + description: The channel of the audio that the data applies to. + type: integer + format: int32 + description: One channel of conversation-level sentiment data. + GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: type: object + description: Metadata for creating an issue model. + id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata properties: - partialErrors: - type: array - description: >- - Partial errors during export operation that might cause the - operation output to be incomplete. - items: - $ref: '#/components/schemas/GoogleRpcStatus' endTime: format: google-datetime - readOnly: true - type: string description: Output only. The time the operation finished running. - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest - description: The original request for export. - createTime: - description: Output only. The time the operation was created. type: string readOnly: true - format: google-datetime - description: Metadata for an export insights operation. - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: - type: object - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for processing transcript objects. - properties: - medium: + createTime: + readOnly: true type: string - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: Required. The medium transcript objects represent. - GoogleCloudContactcenterinsightsV1ConversationTranscript: - type: object + format: google-datetime + description: Output only. The time the operation was created. + request: + description: The original request for creation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: properties: - transcriptSegments: + gcsSource: + description: Google Cloud Storage source message. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource + createNewModel: + type: boolean description: >- - A list of sequential transcript segments that comprise the - conversation. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment - type: array - id: GoogleCloudContactcenterinsightsV1ConversationTranscript - description: A message representing the transcript of a conversation. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: - description: The response to an IngestConversations operation. - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse - properties: {} - type: object - GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: - description: The request to undeploy an issue model. - properties: - name: + Optional. If set to true, will create an issue model from the + imported file with randomly generated IDs for the issue model and + corresponding issues. Otherwise, replaces an existing model with the + same ID as the file. + parent: + description: Required. The parent resource of the issue model. type: string - description: Required. The issue model to undeploy. - type: object - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest - GoogleCloudContactcenterinsightsV1IngestConversationsResponse: - id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse + description: Request to import an issue model. + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest type: object - properties: {} - description: The response to an IngestConversations operation. - GoogleCloudContactcenterinsightsV1EncryptionSpec: - id: GoogleCloudContactcenterinsightsV1EncryptionSpec + GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: + id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary type: object description: >- - A customer-managed encryption key specification that can be applied to - all created resources (e.g. Conversation). + A point in a conversation that marks the start or the end of an + annotation. properties: - name: + wordIndex: + format: int32 description: >- - Immutable. The resource name of the encryption key specification - resource. Format: - projects/{project}/locations/{location}/encryptionSpec - type: string - kmsKey: - type: string + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + type: integer + transcriptIndex: description: >- - Required. The name of customer-managed encryption key that is used - to secure a resource and its sub-resources. If empty, the resource - is secured by the default Google encryption key. Only the key in the - same location as this resource is allowed to be used for encryption. - Format: - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` - GoogleCloudContactcenterinsightsV1IssueMatchData: + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest: type: object + description: The request to initialize a location-level encryption specification. properties: - issueAssignment: + encryptionSpec: + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - description: Information about the issue's assignment. - description: The data for an issue match annotation. - id: GoogleCloudContactcenterinsightsV1IssueMatchData - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest + GoogleCloudContactcenterinsightsV1ConversationDataSource: + description: The conversation source, which is a combination of transcript and audio. + id: GoogleCloudContactcenterinsightsV1ConversationDataSource type: object properties: - createTime: - description: The time the operation was created. + dialogflowSource: + description: The source when the conversation comes from Dialogflow. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource + gcsSource: + description: A Cloud Storage location specification for the audio and transcript. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + properties: + text: type: string + description: The text of this segment. + messageTime: format: google-datetime - endTime: type: string - description: The time the operation finished running. - format: google-datetime - request: - description: The original request for bulk delete. + description: The time that the message occurred, if provided. + sentiment: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: The sentiment for this transcript segment. + languageCode: + type: string + description: >- + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". + channelTag: + description: >- + For conversations derived from multi-channel audio, this is the + channel number corresponding to the audio from that channel. For + audioChannelCount = N, its output values can range from '1' to 'N'. + A channel tag of 0 indicates that the audio is mono. + format: int32 + type: integer + words: type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo description: >- - Partial errors during bulk delete conversations operation that might - cause the operation output to be incomplete. - description: The metadata for a bulk delete conversations operation. - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: + A list of the word-specific information for each word in the + segment. + dialogflowSegmentMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + description: CCAI metadata relating to the current transcript segment. + segmentParticipant: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + description: The participant of this segment. + confidence: + format: float + type: number + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + segment. A default value of 0.0 indicates that the value is unset. + description: A segment of a full transcript. + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse + properties: {} + description: Response for an export insights operation. + type: object + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: properties: - request: + gcsSource: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest - description: The original request for deletion. - createTime: - readOnly: true - type: string - description: Output only. The time the operation was created. - format: google-datetime - endTime: - format: google-datetime - description: Output only. The time the operation finished running. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + description: Google Cloud Storage source message. + parent: type: string - readOnly: true - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata + description: Required. The parent resource of the issue model. + createNewModel: + description: >- + Optional. If set to true, will create an issue model from the + imported file with randomly generated IDs for the issue model and + corresponding issues. Otherwise, replaces an existing model with the + same ID as the file. + type: boolean + description: Request to import an issue model. type: object - description: Metadata for deleting an issue model. - GoogleCloudContactcenterinsightsV1PhraseMatchData: - description: >- - The data for a matched phrase matcher. Represents information - identifying a phrase matcher for a given match. - id: GoogleCloudContactcenterinsightsV1PhraseMatchData + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: properties: - displayName: - type: string - description: The human-readable name of the phrase matcher. - phraseMatcher: - description: The unique identifier (the resource name) of the phrase matcher. + name: type: string + description: Required. The issue model to undeploy. type: object - GoogleCloudContactcenterinsightsV1Analysis: - description: The analysis resource. - id: GoogleCloudContactcenterinsightsV1Analysis + description: The request to undeploy an issue model. + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + GoogleCloudContactcenterinsightsV1Settings: type: object properties: createTime: - readOnly: true - type: string - description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. - format: google-datetime - requestTime: - description: Output only. The time at which the analysis was requested. + description: Output only. The time at which the settings was created. format: google-datetime readOnly: true type: string name: - description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} type: string - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - analysisResult: + Immutable. The resource name of the settings resource. Format: + projects/{project}/locations/{location}/settings + analysisConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult + #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + description: Default analysis settings. + languageCode: + type: string description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. - readOnly: true - GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata - description: Metadata for deploying an issue model. - properties: - request: - description: The original request for deployment. + A language code to be applied to each transcript segment unless the + segment already specifies a language code. Language code defaults to + "en-US" if it is neither specified on the segment nor here. + redactionConfig: + description: >- + Default DLP redaction resources to be applied while ingesting + conversations. This applies to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversations coming from CCAI Platform. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest - endTime: - format: google-datetime - description: Output only. The time the operation finished running. - readOnly: true + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + description: >- + Optional. Default Speech-to-Text resources to use while ingesting + audio files. Optional, CCAI Insights will create a default if not + provided. This applies to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversations coming from CCAI Platform. + updateTime: + description: Output only. The time at which the settings were last updated. type: string - createTime: - description: Output only. The time the operation was created. format: google-datetime - type: string readOnly: true - type: object - GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput: + conversationTtl: + type: string + format: google-duration + description: >- + The default TTL for newly-created conversations. If a conversation + has a specified expiration, that value will be used instead. + Changing this value will not change the expiration of existing + conversations. Conversations with no expire time persist until they + are deleted. + pubsubNotificationSettings: + type: object + additionalProperties: + type: string + description: >- + A map that maps a notification trigger to a Pub/Sub topic. Each time + a specified trigger occurs, Insights will notify the corresponding + Pub/Sub topic. Keys are notification triggers. Supported keys are: * + "all-triggers": Notify each time any of the supported triggers + occurs. * "create-analysis": Notify each time an analysis is + created. * "create-conversation": Notify each time a conversation is + created. * "export-insights-data": Notify each time an export is + complete. * "ingest-conversations": Notify each time an + IngestConversations LRO is complete. * "update-conversation": Notify + each time a conversation is updated via UpdateConversation. * + "upload-conversation": Notify when an UploadConversation LRO is + complete. Values are Pub/Sub topics. The format of each Pub/Sub + topic is: projects/{project}/topics/{topic} + id: GoogleCloudContactcenterinsightsV1Settings + description: >- + The CCAI Insights project wide settings. Use these settings to configure + the behavior of Insights. View these settings with + [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) + and change the settings with + [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). + GoogleCloudContactcenterinsightsV1PhraseMatchData: type: object properties: - query: - description: >- - Query text. Article Search uses this to store the input query used - to generate the search results. - type: string - querySource: - enum: - - QUERY_SOURCE_UNSPECIFIED - - AGENT_QUERY - - SUGGESTED_QUERY - description: Query source for the answer. - enumDescriptions: - - Unknown query source. - - The query is from agents. - - >- - The query is a query from previous suggestions, e.g. from a - preceding SuggestKnowledgeAssist response. + phraseMatcher: + description: The unique identifier (the resource name) of the phrase matcher. type: string - generatorName: + displayName: + description: The human-readable name of the phrase matcher. type: string - description: >- - The resource name of associated generator. Format: - `projects//locations//generators/` - description: Explicit input used for generating the answer - id: GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse - description: The response for a bulk analyze conversations operation. + id: GoogleCloudContactcenterinsightsV1PhraseMatchData + description: >- + The data for a matched phrase matcher. Represents information + identifying a phrase matcher for a given match. + GoogleCloudContactcenterinsightsV1CallAnnotation: + description: A piece of metadata that applies to a window of a call. properties: - failedAnalysisCount: - format: int32 - type: integer - description: Count of failed analyses. - successfulAnalysisCount: + silenceData: + description: Data specifying silence. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' + entityMentionData: + description: Data specifying an entity mention. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData + channelTag: + description: >- + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. type: integer - description: Count of successful analyses. format: int32 + interruptionData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData + description: Data specifying an interruption. + phraseMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + description: Data specifying a phrase match. + annotationEndBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + description: >- + The boundary in the conversation where the annotation ends, + inclusive. + annotationStartBoundary: + description: >- + The boundary in the conversation where the annotation starts, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + issueMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData + description: Data specifying an issue match. + holdData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' + description: Data specifying a hold. + intentMatchData: + description: Data specifying an intent match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData + sentimentData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + description: Data specifying sentiment. type: object - GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: - properties: {} - description: Response from import issue model + id: GoogleCloudContactcenterinsightsV1CallAnnotation + GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: type: object - id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse - GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: - description: Metadata for creating an issue model. - id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - description: The original request for creation. createTime: - description: Output only. The time the operation was created. - readOnly: true - type: string + description: The time the operation was created. format: google-datetime + type: string endTime: - readOnly: true format: google-datetime - description: Output only. The time the operation finished running. + description: The time the operation finished running. type: string + request: + description: The original import request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + description: Metadata used for import issue model. + id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + description: Statistics for IngestConversations operation. type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: - description: A segment of a full transcript. + properties: + processedObjectCount: + format: int32 + description: >- + Output only. The number of objects processed during the ingest + operation. + readOnly: true + type: integer + successfulIngestCount: + description: >- + Output only. The number of new conversations added during this + ingest operation. + readOnly: true + format: int32 + type: integer + failedIngestCount: + readOnly: true + format: int32 + type: integer + description: >- + Output only. The number of objects which were unable to be ingested + due to errors. The errors are populated in the partial_errors field. + duplicatesSkippedCount: + type: integer + format: int32 + readOnly: true + description: >- + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + GoogleCloudContactcenterinsightsV1GcsSource: + description: A Cloud Storage source of conversation data. type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + id: GoogleCloudContactcenterinsightsV1GcsSource properties: - confidence: - type: number + transcriptUri: description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - segment. A default value of 0.0 indicates that the value is unset. - format: float - messageTime: - description: The time that the message occurred, if provided. - format: google-datetime + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. type: string - languageCode: - description: >- - The language code of this segment as a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". + audioUri: type: string - dialogflowSegmentMetadata: - description: CCAI metadata relating to the current transcript segment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - segmentParticipant: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant - description: The participant of this segment. - channelTag: - format: int32 description: >- - For conversations derived from multi-channel audio, this is the - channel number corresponding to the audio from that channel. For - audioChannelCount = N, its output values can range from '1' to 'N'. - A channel tag of 0 indicates that the audio is mono. - type: integer - text: + Cloud Storage URI that points to a file that contains the + conversation audio. + GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: + properties: + nextPageToken: type: string - description: The text of this segment. - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: The sentiment for this transcript segment. - words: - type: array description: >- - A list of the word-specific information for each word in the - segment. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + phraseMatchers: + type: array + description: The phrase matchers that match the request. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + description: The response of listing phrase matchers. + id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + type: object + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: + description: A BigQuery Table Reference. type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination properties: - segmentParticipant: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant - description: The participant of this segment. - text: - description: The text of this segment. + projectId: + description: >- + A project ID or number. If specified, then export will attempt to + write data to this project instead of the resource project. + Otherwise, the resource project will be used. type: string - messageTime: - description: The time that the message occurred, if provided. + dataset: type: string - format: google-datetime - channelTag: - format: int32 - type: integer description: >- - For conversations derived from multi-channel audio, this is the - channel number corresponding to the audio from that channel. For - audioChannelCount = N, its output values can range from '1' to 'N'. - A channel tag of 0 indicates that the audio is mono. - dialogflowSegmentMetadata: - description: CCAI metadata relating to the current transcript segment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - sentiment: - description: The sentiment for this transcript segment. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - words: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo - type: array + Required. The name of the BigQuery dataset that the snapshot result + should be exported to. If this dataset does not exist, the export + call returns an INVALID_ARGUMENT error. + table: + type: string description: >- - A list of the word-specific information for each word in the - segment. - confidence: + The BigQuery table name to which the insights data should be + written. If this table does not exist, the export call returns an + INVALID_ARGUMENT error. + GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: + description: Default configuration when creating Analyses in Insights. + type: object + id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + properties: + annotatorSelector: description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - segment. A default value of 0.0 indicates that the value is unset. + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + uploadConversationAnalysisPercentage: + description: >- + Percentage of conversations created using the UploadConversation + endpoint to analyze automatically, between [0, 100]. type: number - format: float - languageCode: - type: string + format: double + runtimeIntegrationAnalysisPercentage: description: >- - The language code of this segment as a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment - description: A segment of a full transcript. - GoogleCloudContactcenterinsightsV1AnswerFeedback: - type: object - id: GoogleCloudContactcenterinsightsV1AnswerFeedback + Percentage of conversations created using Dialogflow runtime + integration to analyze automatically, between [0, 100]. + type: number + format: double + GoogleLongrunningOperation: description: >- - The feedback that the customer has about a certain answer in the - conversation. + This resource represents a long-running operation that is the result of + a network API call. properties: - correctnessLevel: - enum: - - CORRECTNESS_LEVEL_UNSPECIFIED - - NOT_CORRECT - - PARTIALLY_CORRECT - - FULLY_CORRECT - enumDescriptions: - - Correctness level unspecified. - - Answer is totally wrong. - - Answer is partially correct. - - Answer is fully correct. - description: The correctness level of an answer. + name: type: string - clicked: - description: Indicates whether an answer or item was clicked by the human agent. - type: boolean - displayed: description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. type: boolean - GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo - type: object - properties: - team: - type: string - description: A user-specified string representing the agent's team. - displayName: - type: string - description: The agent's name. - agentId: - description: A user-specified string representing the agent. - type: string - dispositionCode: + response: + type: object description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. - type: string - description: Information about an agent involved in the conversation. - GoogleCloudContactcenterinsightsV1SilenceData: - properties: {} + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + id: GoogleLongrunningOperation type: object - id: GoogleCloudContactcenterinsightsV1SilenceData - description: The data for a silence annotation. - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: - id: >- - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval - description: A single interval in a time series. + GoogleCloudContactcenterinsightsV1IssueModelResult: properties: - startTime: - format: google-datetime + issues: + description: All the matched issues. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + type: array + issueModel: + description: >- + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} type: string - description: The start time of this interval. - conversationCount: - description: The number of conversations created in this interval. - format: int32 - type: integer type: object - GoogleCloudContactcenterinsightsV1ConversationCallMetadata: - id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata + description: Issue Modeling result on a conversation. + id: GoogleCloudContactcenterinsightsV1IssueModelResult + GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: properties: - customerChannel: - type: integer - format: int32 - description: The audio channel that contains the customer. - agentChannel: - format: int32 - type: integer - description: The audio channel that contains the agent. + name: + description: Required. The name of the issue model to delete. + type: string + description: The request to delete an issue model. type: object - description: Call-specific metadata. - GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest + GoogleCloudContactcenterinsightsV1ListConversationsResponse: + id: GoogleCloudContactcenterinsightsV1ListConversationsResponse type: object - description: The metadata for an `UploadConversation` operation. + description: The response of listing conversations. properties: - analysisOperation: - readOnly: true - description: >- - Output only. The operation name for a successfully created analysis - operation, if any. - type: string - createTime: + nextPageToken: type: string - readOnly: true - description: Output only. The time the operation was created. - format: google-datetime - appliedRedactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig description: >- - Output only. The redaction config applied to the uploaded - conversation. - readOnly: true - request: - description: Output only. The original request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest - readOnly: true - endTime: - description: Output only. The time the operation finished running. - format: google-datetime - type: string - readOnly: true - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata - GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: + A token which can be sent as `page_token` to retrieve the next page. + If this field is set, it means there is another page available. If + it is not set, it means no other pages are available. + conversations: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + description: The conversations that match the request. + GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + description: The conversation source, which is a combination of transcript and audio. type: object - id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata - description: Metadata used for import issue model. properties: - request: + dialogflowSource: + description: The source when the conversation comes from Dialogflow. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - description: The original import request. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + gcsSource: + description: A Cloud Storage location specification for the audio and transcript. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource + GoogleCloudContactcenterinsightsV1AnalysisResult: + description: The result of an analysis. + id: GoogleCloudContactcenterinsightsV1AnalysisResult + type: object + properties: endTime: - type: string - description: The time the operation finished running. - format: google-datetime - createTime: format: google-datetime type: string - description: The time the operation was created. - GoogleCloudContactcenterinsightsV1IntentMatchData: + description: The time at which the analysis ended. + callAnalysisMetadata: + description: Call-specific metadata created by the analysis. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + GoogleCloudContactcenterinsightsV1RuntimeAnnotation: description: >- - The data for an intent match. Represents an intent match for a text - segment in the conversation. A text segment can be part of a sentence, a - complete sentence, or an utterance with multiple sentences. + An annotation that was generated during the customer and agent + interaction. type: object + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation properties: - intentUniqueId: - type: string + smartComposeSuggestion: + description: Agent Assist Smart Compose suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + faqAnswer: + description: Agent Assist FAQ answer data. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' + dialogflowInteraction: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData + description: Dialogflow interaction data. + conversationSummarizationSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + articleSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData + description: Agent Assist Article Suggestion data. + endBoundary: description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. - id: GoogleCloudContactcenterinsightsV1IntentMatchData - GoogleCloudContactcenterinsightsV1UploadConversationMetadata: - id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata - properties: + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + annotationId: + description: >- + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + type: string createTime: format: google-datetime type: string - readOnly: true - description: Output only. The time the operation was created. - analysisOperation: - description: >- - Output only. The operation name for a successfully created analysis - operation, if any. - type: string - readOnly: true - appliedRedactionConfig: - description: >- - Output only. The redaction config applied to the uploaded - conversation. - readOnly: true + description: The time at which this annotation was created. + smartReply: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - endTime: - description: Output only. The time the operation finished running. - readOnly: true - type: string - format: google-datetime - request: - description: Output only. The original request. + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData + description: Agent Assist Smart Reply data. + startBoundary: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest - readOnly: true - description: The metadata for an `UploadConversation` operation. - type: object - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse: - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse - properties: {} - description: The response to initialize a location-level encryption specification. - type: object - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest: - description: The request to initialize a location-level encryption specification. - type: object - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest - properties: - encryptionSpec: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary description: >- - Required. The encryption spec used for CMEK encryption. It is - required that the kms key is in the same region as the endpoint. The - same key will be used for all provisioned resources, if encryption - is available. If the kms_key_name is left empty, no encryption will - be enforced. + The boundary in the conversation where the annotation starts, + inclusive. + answerFeedback: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec - GoogleCloudContactcenterinsightsV1alpha1SilenceData: - id: GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: The data for a silence annotation. - properties: {} - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback + description: The feedback that the customer has about the answer in `data`. + userInput: + description: Explicit input used for generating the answer + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + GoogleCloudContactcenterinsightsV1SentimentData: properties: - confidence: + score: format: float + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + type: number + magnitude: type: number + format: float description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - word. A default value of 0.0 indicates that the value is unset. - startOffset: + A non-negative number from 0 to infinity which represents the + abolute magnitude of sentiment regardless of score. + description: The data for a sentiment annotation. + id: GoogleCloudContactcenterinsightsV1SentimentData + type: object + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + properties: + name: + description: Required. The issue model to undeploy. + type: string + type: object + description: The request to undeploy an issue model. + GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: + id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + description: Agent Assist Article Suggestion data. + properties: + source: type: string - format: google-duration description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. - word: - description: The word itself. Includes punctuation marks that surround the word. + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + queryRecord: type: string - endOffset: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + title: + description: Article title. type: string - format: google-duration + uri: + description: Article URI. + type: string + metadata: + type: object description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo - description: Word-level info for words in a transcript. + Map that contains metadata about the Article Suggestion and the + document that it originates from. + additionalProperties: + type: string + confidenceScore: + format: float + type: number + description: >- + The system's confidence score that this article is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). type: object - GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput: + GoogleCloudContactcenterinsightsV1DialogflowSource: type: object + description: A Dialogflow source of conversation data. properties: - query: + audioUri: type: string description: >- - Query text. Article Search uses this to store the input query used - to generate the search results. - generatorName: - type: string + Cloud Storage URI that points to a file that contains the + conversation audio. + dialogflowConversation: description: >- - The resource name of associated generator. Format: - `projects//locations//generators/` - querySource: - enum: - - QUERY_SOURCE_UNSPECIFIED - - AGENT_QUERY - - SUGGESTED_QUERY - description: Query source for the answer. - enumDescriptions: - - Unknown query source. - - The query is from agents. - - >- - The query is a query from previous suggestions, e.g. from a - preceding SuggestKnowledgeAssist response. + Output only. The name of the Dialogflow conversation that this + conversation resource is derived from. Format: + projects/{project}/locations/{location}/conversations/{conversation} + readOnly: true type: string - description: Explicit input used for generating the answer - id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + id: GoogleCloudContactcenterinsightsV1DialogflowSource + GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec: properties: - silencePercentage: - description: Percentage of the total conversation spent in silence. - format: float - type: number - silenceDuration: - description: Amount of time calculated to be in silence. - format: google-duration + name: + description: >- + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec + type: string + kmsKey: + description: >- + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` type: string type: object - description: Conversation-level silence data. - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: - type: object - description: The response to undeploy an issue model. - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + id: GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + GoogleCloudContactcenterinsightsV1ConversationTranscript: type: object - description: Conversation summarization suggestion data. + id: GoogleCloudContactcenterinsightsV1ConversationTranscript properties: - textSections: - additionalProperties: - type: string - type: object + transcriptSegments: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment description: >- - The summarization content that is divided into sections. The key is - the section's name and the value is the section's content. There is - no specific format for the key or value. + A list of sequential transcript segments that comprise the + conversation. + description: A message representing the transcript of a conversation. + GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: + description: >- + The data for a matched phrase matcher. Represents information + identifying a phrase matcher for a given match. + id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + type: object + properties: + displayName: + type: string + description: The human-readable name of the phrase matcher. + phraseMatcher: + description: The unique identifier (the resource name) of the phrase matcher. + type: string + GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: + properties: metadata: description: >- - A map that contains metadata about the summarization and the - document from which it originates. - type: object + Map that contains metadata about the Smart Reply and the document + from which it originates. additionalProperties: type: string - conversationModel: - type: string + type: object + confidenceScore: + type: number + format: double description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} - answerRecord: + The system's confidence score that this reply is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + queryRecord: + type: string description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} + reply: type: string - confidence: - format: float - type: number - description: The confidence score of the summarization. - text: - description: The summarization content that is concatenated into one string. - type: string - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: + description: The content of the reply. + type: object + description: Agent Assist Smart Reply data. + id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData + GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata + type: object + description: Metadata for deploying an issue model. properties: endTime: - description: The time at which the analysis ended. + readOnly: true type: string + description: Output only. The time the operation finished running. format: google-datetime - callAnalysisMetadata: + request: + description: The original request for deployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata - description: Call-specific metadata created by the analysis. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult - description: The result of an analysis. - GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: - id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + createTime: + type: string + readOnly: true + description: Output only. The time the operation was created. + format: google-datetime + GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: properties: - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Sentiment expressed for this mention of the entity. - entityUniqueId: + conversationId: type: string description: >- - The key of this entity in conversation entities. Can be used to - retrieve the exact `Entity` this mention is attached to. - type: + Optional. A unique ID for the new conversation. This ID will become + the final component of the conversation's resource name. If no ID is + specified, a server-generated ID will be used. This value should be + 4-64 characters and must match the regular expression + `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` + parent: type: string - enumDescriptions: - - Unspecified. - - Proper noun. - - Common noun (or noun compound). - enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON - description: The type of the entity mention. + description: Required. The parent resource of the conversation. + speechConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + description: >- + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + conversation: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation + description: Required. The conversation resource to create. + redactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + description: >- + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest + type: object + description: Request to upload a conversation. + GoogleCloudContactcenterinsightsV1alpha1SentimentData: + properties: + magnitude: + format: float + type: number + description: >- + A non-negative number from 0 to infinity which represents the + abolute magnitude of sentiment regardless of score. + score: + format: float + type: number + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + type: object + description: The data for a sentiment annotation. + id: GoogleCloudContactcenterinsightsV1alpha1SentimentData + GoogleCloudContactcenterinsightsV1IngestConversationsResponse: type: object + description: The response to an IngestConversations operation. + properties: {} + id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse + GoogleProtobufEmpty: + id: GoogleProtobufEmpty description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: + 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); } + properties: {} + type: object + GoogleCloudContactcenterinsightsV1IntentMatchData: + id: GoogleCloudContactcenterinsightsV1IntentMatchData + description: >- + The data for an intent match. Represents an intent match for a text + segment in the conversation. A text segment can be part of a sentence, a + complete sentence, or an utterance with multiple sentences. + properties: + intentUniqueId: + type: string + description: >- + The id of the matched intent. Can be used to retrieve the + corresponding intent information. + type: object + GoogleCloudContactcenterinsightsV1ListIssuesResponse: + description: The response of listing issues. + id: GoogleCloudContactcenterinsightsV1ListIssuesResponse type: object - description: A message representing the transcript of a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript properties: - transcriptSegments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + issues: type: array - description: >- - A list of sequential transcript segments that comprise the - conversation. - GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + description: The issues that match the request. + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse: type: object - description: Metadata used for export issue model. + properties: {} + description: The response to initialize a location-level encryption specification. + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse + GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: properties: + conversation: + readOnly: true + description: >- + Output only. The Conversation that this Analysis Operation belongs + to. + type: string endTime: - format: google-datetime + description: Output only. The time the operation finished running. type: string - description: The time the operation finished running. + readOnly: true + format: google-datetime createTime: - description: The time the operation was created. + description: Output only. The time the operation was created. + readOnly: true type: string format: google-datetime - request: - description: The original export request. + annotatorSelector: + description: Output only. The annotator selector used for the analysis (if any). + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination - description: A BigQuery Table Reference. + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + description: Metadata for a create analysis operation. type: object + id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata + GoogleCloudContactcenterinsightsV1alpha1GcsSource: properties: - projectId: + transcriptUri: description: >- - A project ID or number. If specified, then export will attempt to - write data to this project instead of the resource project. - Otherwise, the resource project will be used. - type: string - table: + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. type: string + audioUri: description: >- - The BigQuery table name to which the insights data should be - written. If this table does not exist, the export call returns an - INVALID_ARGUMENT error. - dataset: - description: >- - Required. The name of the BigQuery dataset that the snapshot result - should be exported to. If this dataset does not exist, the export - call returns an INVALID_ARGUMENT error. + Cloud Storage URI that points to a file that contains the + conversation audio. type: string - GoogleCloudContactcenterinsightsV1IssueModelResult: + description: A Cloud Storage source of conversation data. + id: GoogleCloudContactcenterinsightsV1alpha1GcsSource + type: object + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput: + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer + type: object properties: - issues: - description: All the matched issues. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - issueModel: + query: type: string description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - id: GoogleCloudContactcenterinsightsV1IssueModelResult + Query text. Article Search uses this to store the input query used + to generate the search results. + querySource: + description: Query source for the answer. + enumDescriptions: + - Unknown query source. + - The query is from agents. + - >- + The query is a query from previous suggestions, e.g. from a + preceding SuggestKnowledgeAssist response. + type: string + enum: + - QUERY_SOURCE_UNSPECIFIED + - AGENT_QUERY + - SUGGESTED_QUERY + generatorName: + description: >- + The resource name of associated generator. Format: + `projects//locations//generators/` + type: string + GoogleCloudContactcenterinsightsV1ExactMatchConfig: + description: Exact match configuration. + id: GoogleCloudContactcenterinsightsV1ExactMatchConfig + properties: + caseSensitive: + description: Whether to consider case sensitivity when performing an exact match. + type: boolean type: object - description: Issue Modeling result on a conversation. - GoogleCloudContactcenterinsightsV1ListConversationsResponse: + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: properties: - conversations: - description: The conversations that match the request. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation - type: array - nextPageToken: + agentChannel: + format: int32 + type: integer description: >- - A token which can be sent as `page_token` to retrieve the next page. - If this field is set, it means there is another page available. If - it is not set, it means no other pages are available. + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + customerChannel: + type: integer + format: int32 + description: >- + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + agentId: + description: >- + Optional. An opaque, user-specified string representing a human + agent who handled all conversations in the import. Note that this + will be overridden if per-conversation metadata is provided through + the `metadata_bucket_uri`. type: string + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig type: object - description: The response of listing conversations. - id: GoogleCloudContactcenterinsightsV1ListConversationsResponse - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + description: Configuration that applies to all conversations. + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: properties: - smartReplyAllowlistCovered: + duplicatesSkippedCount: + type: integer + format: int32 + readOnly: true description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - type: boolean - type: object + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + processedObjectCount: + type: integer + description: >- + Output only. The number of objects processed during the ingest + operation. + readOnly: true + format: int32 + failedIngestCount: + description: >- + Output only. The number of objects which were unable to be ingested + due to errors. The errors are populated in the partial_errors field. + format: int32 + type: integer + readOnly: true + successfulIngestCount: + type: integer + description: >- + Output only. The number of new conversations added during this + ingest operation. + readOnly: true + format: int32 id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - description: Metadata from Dialogflow relating to the current transcript segment. - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: - description: Metadata for undeploying an issue model. + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + description: Statistics for IngestConversations operation. + type: object + GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: properties: + partialErrors: + description: >- + Output only. Partial errors during ingest operation that might cause + the operation output to be incomplete. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + readOnly: true + endTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The time the operation finished running. + createTime: + readOnly: true + format: google-datetime + description: Output only. The time the operation was created. + type: string + ingestConversationsStats: + description: Output only. Statistics for IngestConversations operation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats request: - description: The original request for undeployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest - endTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + readOnly: true + description: Output only. The original request for ingest. + id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata + type: object + description: The metadata for an IngestConversations operation. + GoogleCloudContactcenterinsightsV1View: + description: The View resource. + id: GoogleCloudContactcenterinsightsV1View + type: object + properties: + updateTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The most recent time at which the view was updated. + name: + description: >- + Immutable. The resource name of the view. Format: + projects/{project}/locations/{location}/views/{view} + type: string + displayName: + type: string + description: The human-readable display name of the view. + createTime: + type: string + readOnly: true + description: Output only. The time at which this view was created. + format: google-datetime + value: + type: string + description: String with specific view properties, must be non-empty. + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: + description: The response for a bulk delete conversations operation. + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse + type: object + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata: + properties: + createTime: + description: Output only. The time the operation was created. readOnly: true + format: google-datetime type: string + endTime: format: google-datetime - description: Output only. The time the operation finished running. - createTime: type: string - description: Output only. The time the operation was created. + description: Output only. The time the operation finished running. + readOnly: true + partialErrors: + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Partial errors during initialising operation that might cause the + operation output to be incomplete. + request: + description: Output only. The original request for initialization. readOnly: true - format: google-datetime - type: object - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - properties: - sentimentData: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Data specifying sentiment. - channelTag: - format: int32 - type: integer - description: The channel of the audio that the data applies to. - description: One channel of conversation-level sentiment data. - type: object - GoogleCloudContactcenterinsightsV1Intent: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest type: object - properties: - id: - type: string - description: The unique identifier of the intent. - displayName: - description: The human-readable name of the intent. - type: string - id: GoogleCloudContactcenterinsightsV1Intent + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. + GoogleCloudContactcenterinsightsV1SpeechConfig: description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. - GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: - description: Google Cloud Storage Object URI to get the issue model file from. + Speech-to-Text configuration. Speech-to-Text settings are applied to + conversations ingested from the `UploadConversation` and + `IngestConversations` endpoints, including conversation coming from CCAI + Platform. They are not applied to conversations ingested from the + `CreateConversation` endpoint. + id: GoogleCloudContactcenterinsightsV1SpeechConfig type: object - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource properties: - objectUri: - description: 'Required. Format: `gs:///`' + speechRecognizer: + description: >- + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` type: string - GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: - description: Metadata for undeploying an issue model. - type: object - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata + GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest - description: The original request for undeployment. - endTime: + medium: + deprecated: true + description: >- + Medium of conversations used in training data. This field is being + deprecated. To specify the medium to be used in training a new issue + model, set the `medium` field on `filter`. type: string + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + trainingConversationsCount: + format: int64 readOnly: true - format: google-datetime - description: Output only. The time the operation finished running. - createTime: - description: Output only. The time the operation was created. - readOnly: true + description: Output only. Number of conversations used in training. Output only. type: string - format: google-datetime - GoogleCloudContactcenterinsightsV1alpha1GcsSource: - properties: - transcriptUri: - description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. + filter: type: string - audioUri: description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - type: string - id: GoogleCloudContactcenterinsightsV1alpha1GcsSource - description: A Cloud Storage source of conversation data. - type: object - GoogleCloudContactcenterinsightsV1GcsSource: + A filter to reduce the conversations used for training the model to + a specific subset. + description: Configs for the input data used to create the issue model. + id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig type: object - id: GoogleCloudContactcenterinsightsV1GcsSource - description: A Cloud Storage source of conversation data. + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: properties: - audioUri: - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. + name: + description: Required. The name of the issue model to delete. type: string - transcriptUri: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + description: The request to delete an issue model. + GoogleCloudContactcenterinsightsV1AnswerFeedback: + id: GoogleCloudContactcenterinsightsV1AnswerFeedback + properties: + correctnessLevel: type: string + enum: + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT + enumDescriptions: + - Correctness level unspecified. + - Answer is totally wrong. + - Answer is partially correct. + - Answer is fully correct. + description: The correctness level of an answer. + clicked: + type: boolean + description: Indicates whether an answer or item was clicked by the human agent. + displayed: description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: - description: The response for a bulk delete conversations operation. - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse - properties: {} + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. + type: boolean type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: + description: >- + The feedback that the customer has about a certain answer in the + conversation. + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: + description: The response for a bulk analyze conversations operation. + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse type: object properties: - agentChannel: - format: int32 - type: integer - description: The audio channel that contains the agent. - customerChannel: + failedAnalysisCount: + description: Count of failed analyses. type: integer - description: The audio channel that contains the customer. format: int32 - description: Call-specific metadata. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: - id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata - properties: - annotations: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation - description: A list of call annotations that apply to this call. - type: array - issueModelResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult - description: Overall conversation-level issue modeling result. - entities: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' - description: All the entities in the call. - intents: - type: object - description: All the matched intents in the call. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' - sentiments: - description: Overall conversation-level sentiment for each channel of the call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment - type: array - silence: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence - description: Overall conversation-level silence during the call. - phraseMatchers: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - description: All the matched phrase matchers in the call. - type: object - description: Call-specific metadata created during analysis. - type: object - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - properties: - conversationConfig: - description: Configuration that applies to all conversations. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig - sampleSize: + successfulAnalysisCount: type: integer - description: >- - Optional. If set, this fields indicates the number of objects to - ingest from the Cloud Storage bucket. If empty, the entire bucket - will be ingested. Unless they are first deleted, conversations - produced through sampling won't be ingested by subsequent ingest - requests. format: int32 - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - transcriptObjectConfig: - description: Configuration for when `source` contains conversation transcripts. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - speechConfig: + description: Count of successful analyses. + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + properties: + parent: + type: string + description: Required. The parent resource to create analyses in. + annotatorSelector: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - parent: - description: Required. The parent resource for new conversations. + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + analysisPercentage: + description: >- + Required. Percentage of selected conversation to analyze, between + [0, 100]. + format: float + type: number + filter: type: string - redactionConfig: description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + Required. Filter used to select the subset of conversations to + analyze. + description: The request to analyze conversations in bulk. type: object - description: The request to ingest conversations. - GoogleCloudContactcenterinsightsV1DialogflowInteractionData: + GoogleCloudContactcenterinsightsV1ConversationLevelSilence: + description: Conversation-level silence data. properties: - confidence: - description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). + silenceDuration: + type: string + description: Amount of time calculated to be in silence. + format: google-duration + silencePercentage: type: number format: float - dialogflowIntentId: - description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} - type: string - description: Dialogflow interaction data. - id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData + description: Percentage of the total conversation spent in silence. type: object - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: + id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: + description: The request to delete conversations in bulk. + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest properties: - points: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval - type: array + force: description: >- - An ordered list of intervals from earliest to latest, where each - interval represents the number of conversations that transpired - during the time window. - intervalDuration: + If set to true, all of this conversation's analyses will also be + deleted. Otherwise, the request will only succeed if the + conversation has no analyses. + type: boolean + parent: type: string - format: google-duration - description: The duration of each interval. + description: >- + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} + filter: + type: string + description: Filter used to select the subset of conversations to delete. + maxDeleteCount: + format: int32 + description: Maximum number of conversations to delete. + type: integer type: object - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries - description: A time series representing conversations over time. - GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: + GoogleCloudContactcenterinsightsV1Entity: + id: GoogleCloudContactcenterinsightsV1Entity type: object - description: Agent Assist Smart Reply data. - id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData properties: - confidenceScore: + sentiment: description: >- - The system's confidence score that this reply is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - type: number - format: double - queryRecord: + The aggregate sentiment expressed for this entity in the + conversation. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + type: + enumDescriptions: + - Unspecified. + - Person. + - Location. + - Organization. + - Event. + - Artwork. + - Consumer product. + - Other types of entities. + - >- + Phone number. The metadata lists the phone number (formatted + according to local convention), plus whichever additional elements + appear in the text: * `number` - The actual number, broken down + into sections according to local convention. * `national_prefix` - + Country code, if detected. * `area_code` - Region or area code, if + detected. * `extension` - Phone extension (to be dialed after + connection), if detected. + - >- + Address. The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - Street number. * `locality` - City or town. * + `street_name` - Street/route name, if detected. * `postal_code` - + Postal code, if detected. * `country` - Country, if detected. * + `broad_region` - Administrative area, such as the state, if + detected. * `narrow_region` - Smaller administrative area, such as + county, if detected. * `sublocality` - Used in Asian addresses to + demark a district within a city, if detected. + - >- + Date. The metadata identifies the components of the date: * `year` + - Four digit year, if detected. * `month` - Two digit month + number, if detected. * `day` - Two digit day number, if detected. + - Number. The metadata is the number itself. + - Price. The metadata identifies the `value` and `currency`. + enum: + - TYPE_UNSPECIFIED + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + description: The entity type. type: string + salience: + type: number description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} + The salience score associated with the entity in the [0, 1.0] range. + The salience score for an entity provides information about the + importance or centrality of that entity to the entire document text. + Scores closer to 0 are less salient, while scores closer to 1.0 are + highly salient. + format: float metadata: type: object + description: >- + Metadata associated with the entity. For most entity types, the + metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph + MID (`mid`), if they are available. For the metadata associated with + other entity types, see the Type table below. additionalProperties: type: string + displayName: + type: string + description: The representative name for the entity. + description: >- + The data for an entity annotation. Represents a phrase in the + conversation that is a known entity, such as a person, an organization, + or location. + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata + description: Metadata for creating an issue model. + properties: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + description: The original request for creation. + endTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The time the operation finished running. + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. The time the operation was created. + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + description: Metadata from Dialogflow relating to the current transcript segment. + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + properties: + smartReplyAllowlistCovered: + type: boolean description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. - reply: - description: The content of the reply. + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: + properties: + startOffset: + description: >- + Time offset of the start of this word relative to the beginning of + the total conversation. type: string - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: + format: google-duration + endOffset: + description: >- + Time offset of the end of this word relative to the beginning of the + total conversation. + type: string + format: google-duration + confidence: + type: number + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + word. A default value of 0.0 indicates that the value is unset. + format: float + word: + description: The word itself. Includes punctuation marks that surround the word. + type: string + description: Word-level info for words in a transcript. + type: object id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest type: object properties: - displayName: + parent: type: string - description: The agent's name. - agentId: - description: A user-specified string representing the agent. + description: Required. The parent resource to export data from. + bigQueryDestination: + description: Specified if sink is a BigQuery table. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + filter: type: string - team: + description: >- + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. + kmsKey: type: string - description: A user-specified string representing the agent's team. - dispositionCode: description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + writeDisposition: + enumDescriptions: + - Write disposition is not specified. Defaults to WRITE_TRUNCATE. + - >- + If the table already exists, BigQuery will overwrite the table + data and use the schema from the load. + - >- + If the table already exists, BigQuery will append data to the + table. + description: Options for what to do if the destination table already exists. + enum: + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND type: string - description: Information about an agent involved in the conversation. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: + description: The request to export insights. + GoogleCloudContactcenterinsightsV1alpha1Analysis: + type: object + description: The analysis resource. + id: GoogleCloudContactcenterinsightsV1alpha1Analysis properties: - partialErrors: - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - description: >- - Output only. Partial errors during ingest operation that might cause - the operation output to be incomplete. createTime: type: string - description: Output only. The time the operation was created. format: google-datetime readOnly: true - endTime: + description: >- + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + name: + description: >- + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} type: string - description: Output only. The time the operation finished running. - format: google-datetime - readOnly: true - ingestConversationsStats: + analysisResult: + description: >- + Output only. The result of the analysis, which is populated when the + analysis finishes. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult readOnly: true - description: Output only. Statistics for IngestConversations operation. - request: - description: Output only. The original request for ingest. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + requestTime: + format: google-datetime + type: string + description: Output only. The time at which the analysis was requested. readOnly: true + GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: type: object - description: The metadata for an IngestConversations operation. - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata - GoogleCloudContactcenterinsightsV1ArticleSuggestionData: - type: object + description: Agent Assist Smart Compose suggestion data. properties: - uri: - description: Article URI. + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string metadata: type: object + description: >- + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. additionalProperties: type: string - description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. - title: - type: string - description: Article title. - source: + suggestion: type: string + description: The content of the suggestion. + confidenceScore: + format: double description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + The system's confidence score that this suggestion is a good match + for this conversation, ranging from 0.0 (completely uncertain) to + 1.0 (completely certain). + type: number + id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: + properties: + suggestion: + description: The content of the suggestion. + type: string queryRecord: + type: string description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string + metadata: + type: object + description: >- + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. + additionalProperties: + type: string confidenceScore: - format: float type: number + format: double description: >- - The system's confidence score that this article is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - GoogleCloudContactcenterinsightsV1ConversationLevelSilence: - properties: - silenceDuration: - description: Amount of time calculated to be in silence. - format: google-duration - type: string - silencePercentage: - format: float - type: number - description: Percentage of the total conversation spent in silence. - id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence + The system's confidence score that this suggestion is a good match + for this conversation, ranging from 0.0 (completely uncertain) to + 1.0 (completely certain). + description: Agent Assist Smart Compose suggestion data. type: object - description: Conversation-level silence data. - GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: - description: Response of querying an issue model's statistics. - id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: properties: - currentStats: + force: + type: boolean description: >- - The latest label statistics for the queried issue model. Includes - results on both training data and data labeled after deployment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats - type: object - GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: - properties: - displayName: - description: The human-readable name of the phrase matcher. + If set to true, all of this conversation's analyses will also be + deleted. Otherwise, the request will only succeed if the + conversation has no analyses. + maxDeleteCount: + description: Maximum number of conversations to delete. + format: int32 + type: integer + filter: + description: Filter used to select the subset of conversations to delete. type: string - phraseMatcher: + parent: type: string - description: The unique identifier (the resource name) of the phrase matcher. - description: >- - The data for a matched phrase matcher. Represents information - identifying a phrase matcher for a given match. + description: >- + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} type: object - id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - GoogleCloudContactcenterinsightsV1IssueModel: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + description: The request to delete conversations in bulk. + GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: + description: >- + The feedback that the customer has about a certain answer in the + conversation. properties: - updateTime: - readOnly: true - format: google-datetime + clicked: + type: boolean + description: Indicates whether an answer or item was clicked by the human agent. + correctnessLevel: + enum: + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT type: string + description: The correctness level of an answer. + enumDescriptions: + - Correctness level unspecified. + - Answer is totally wrong. + - Answer is partially correct. + - Answer is fully correct. + displayed: + type: boolean description: >- - Output only. The most recent time at which the issue model was - updated. - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The time at which this issue model was created. - name: + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: + description: A BigQuery Table Reference. + id: >- + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination + type: object + properties: + table: description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - type: string - modelType: + The BigQuery table name to which the insights data should be + written. If this table does not exist, the export call returns an + INVALID_ARGUMENT error. type: string - description: Type of the model. - enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 - enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - inputDataConfig: - description: Configs for the input data that used to create the issue model. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - issueCount: - description: Output only. Number of issues in this issue model. - format: int64 + projectId: type: string - readOnly: true - languageCode: - description: Language of the model. + description: >- + A project ID or number. If specified, then export will attempt to + write data to this project instead of the resource project. + Otherwise, the resource project will be used. + dataset: type: string - trainingStats: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats - readOnly: true description: >- - Output only. Immutable. The issue model's label statistics on its - training data. + Required. The name of the BigQuery dataset that the snapshot result + should be exported to. If this dataset does not exist, the export + call returns an INVALID_ARGUMENT error. + GoogleCloudContactcenterinsightsV1alpha1Entity: + description: >- + The data for an entity annotation. Represents a phrase in the + conversation that is a known entity, such as a person, an organization, + or location. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1Entity + properties: + salience: + type: number + format: float + description: >- + The salience score associated with the entity in the [0, 1.0] range. + The salience score for an entity provides information about the + importance or centrality of that entity to the entire document text. + Scores closer to 0 are less salient, while scores closer to 1.0 are + highly salient. + metadata: + type: object + additionalProperties: + type: string + description: >- + Metadata associated with the entity. For most entity types, the + metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph + MID (`mid`), if they are available. For the metadata associated with + other entity types, see the Type table below. displayName: - description: The representative name for the issue model. - type: string - state: - readOnly: true + description: The representative name for the entity. type: string - description: Output only. State of the model. + sentiment: + description: >- + The aggregate sentiment expressed for this entity in the + conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + type: enumDescriptions: - Unspecified. - - Model is not deployed but is ready to deploy. - - Model is being deployed. + - Person. + - Location. + - Organization. + - Event. + - Artwork. + - Consumer product. + - Other types of entities. - >- - Model is deployed and is ready to be used. A model can only be - used in analysis if it's in this state. - - Model is being undeployed. - - Model is being deleted. + Phone number. The metadata lists the phone number (formatted + according to local convention), plus whichever additional elements + appear in the text: * `number` - The actual number, broken down + into sections according to local convention. * `national_prefix` - + Country code, if detected. * `area_code` - Region or area code, if + detected. * `extension` - Phone extension (to be dialed after + connection), if detected. + - >- + Address. The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - Street number. * `locality` - City or town. * + `street_name` - Street/route name, if detected. * `postal_code` - + Postal code, if detected. * `country` - Country, if detected. * + `broad_region` - Administrative area, such as the state, if + detected. * `narrow_region` - Smaller administrative area, such as + county, if detected. * `sublocality` - Used in Asian addresses to + demark a district within a city, if detected. + - >- + Date. The metadata identifies the components of the date: * `year` + - Four digit year, if detected. * `month` - Two digit month + number, if detected. * `day` - Two digit day number, if detected. + - Number. The metadata is the number itself. + - Price. The metadata identifies the `value` and `currency`. enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING - id: GoogleCloudContactcenterinsightsV1IssueModel - description: The issue model resource. - type: object - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: + - TYPE_UNSPECIFIED + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + type: string + description: The entity type. + GoogleCloudContactcenterinsightsV1AnnotationBoundary: + id: GoogleCloudContactcenterinsightsV1AnnotationBoundary + properties: + wordIndex: + format: int32 + description: >- + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + type: integer + transcriptIndex: + description: >- + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. + format: int32 + type: integer + description: >- + A point in a conversation that marks the start or the end of an + annotation. type: object + GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: description: Call-specific metadata created during analysis. - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + type: object properties: sentiments: - type: array - description: Overall conversation-level sentiment for each channel of the call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - phraseMatchers: - description: All the matched phrase matchers in the call. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - intents: - description: All the matched intents in the call. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent - annotations: - description: A list of call annotations that apply to this call. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + description: Overall conversation-level sentiment for each channel of the call. type: array silence: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence description: Overall conversation-level silence during the call. + intents: + description: All the matched intents in the call. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' + entities: + description: All the entities in the call. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' + type: object issueModelResult: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult description: Overall conversation-level issue modeling result. - entities: - description: All the entities in the call. + phraseMatchers: additionalProperties: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData type: object - GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: - description: Google Cloud Storage Object URI to save the issue model to. - properties: - objectUri: - description: 'Required. Format: `gs:///`' - type: string - type: object - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: - description: Configuration that applies to all conversations. + description: All the matched phrase matchers in the call. + annotations: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation + description: A list of call annotations that apply to this call. + type: array + id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: + description: The metadata for an IngestConversations operation. properties: - agentId: + createTime: + description: Output only. The time the operation was created. type: string + format: google-datetime + readOnly: true + partialErrors: + readOnly: true + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - Optional. An opaque, user-specified string representing a human - agent who handled all conversations in the import. Note that this - will be overridden if per-conversation metadata is provided through - the `metadata_bucket_uri`. - customerChannel: - format: int32 - description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - type: integer - agentChannel: - format: int32 - description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - type: integer + Output only. Partial errors during ingest operation that might cause + the operation output to be incomplete. + ingestConversationsStats: + readOnly: true + description: Output only. Statistics for IngestConversations operation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + request: + readOnly: true + description: Output only. The original request for ingest. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + endTime: + description: Output only. The time the operation finished running. + type: string + format: google-datetime + readOnly: true + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata + type: object + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + description: Metadata from Dialogflow relating to the current transcript segment. type: object id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig - GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata properties: - confidenceScore: + smartReplyAllowlistCovered: description: >- - The system's confidence score that this suggestion is a good match - for this conversation, ranging from 0.0 (completely uncertain) to - 1.0 (completely certain). + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + type: boolean + GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + properties: + confidence: + format: float type: number - format: double - queryRecord: - type: string description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - suggestion: - description: The content of the suggestion. + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + dialogflowIntentId: type: string - metadata: description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - type: object - additionalProperties: - type: string - type: object - description: Agent Assist Smart Compose suggestion data. - id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} + description: Dialogflow interaction data. GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest properties: - parent: + bigQueryDestination: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination + description: Specified if sink is a BigQuery table. + filter: type: string - description: Required. The parent resource to export data from. - kmsKey: description: >- - A fully qualified KMS key name for BigQuery tables protected by - CMEK. Format: - projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. + parent: + description: Required. The parent resource to export data from. type: string writeDisposition: - description: Options for what to do if the destination table already exists. enumDescriptions: - Write disposition is not specified. Defaults to WRITE_TRUNCATE. - >- @@ -4192,742 +3688,1249 @@ components: - >- If the table already exists, BigQuery will append data to the table. + description: Options for what to do if the destination table already exists. enum: - WRITE_DISPOSITION_UNSPECIFIED - WRITE_TRUNCATE - WRITE_APPEND type: string - bigQueryDestination: + kmsKey: + type: string + description: >- + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + description: The request to export insights. + type: object + GoogleCloudContactcenterinsightsV1Conversation: + description: The conversation resource. + id: GoogleCloudContactcenterinsightsV1Conversation + type: object + properties: + latestSummary: + description: Output only. Latest summary of the conversation. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - description: Specified if sink is a BigQuery table. - filter: + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + readOnly: true + dialogflowIntents: + description: >- + Output only. All the matched Dialogflow intents in the call. The key + corresponds to a Dialogflow intent, format: + projects/{project}/agent/{agent}/intents/{intent} + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent + readOnly: true + agentId: + description: >- + An opaque, user-specified string representing the human agent who + handled the conversation. type: string + name: description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} + type: string + expireTime: + description: >- + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. + type: string + format: google-datetime + languageCode: + description: A user-specified language code for the conversation. + type: string + ttl: + description: >- + Input only. The TTL for this resource. If specified, then this TTL + will be used to calculate the expire time. + format: google-duration + type: string + obfuscatedUserId: + description: Obfuscated user ID which the customer sent to us. + type: string + createTime: + format: google-datetime + description: Output only. The time at which the conversation was created. + type: string + readOnly: true + transcript: + readOnly: true + description: Output only. The conversation transcript. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript + metadataJson: + type: string + description: >- + Input only. JSON Metadata encoded as a string. This field is + primarily used by Insights integrations with various telphony + systems and must be in one of Insights' supported formats. + medium: + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + type: string + description: >- + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. + callMetadata: + description: Call-specific metadata. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata + runtimeAnnotations: + type: array + description: >- + Output only. The annotations that were generated during the customer + and agent interaction. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation + readOnly: true + startTime: + format: google-datetime + type: string + description: The time at which the conversation started. + qualityMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + description: Conversation metadata related to quality management. + updateTime: + format: google-datetime + description: >- + Output only. The most recent time at which the conversation was + updated. + readOnly: true + type: string + turnCount: + description: Output only. The number of turns in the conversation. + type: integer + readOnly: true + format: int32 + labels: + additionalProperties: + type: string + description: >- + A map for the user to specify any custom fields. A maximum of 20 + labels per conversation is allowed, with a maximum of 256 characters + per entry. + type: object + dataSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource + description: The source of the audio and transcription for the conversation. + duration: + format: google-duration + type: string + description: Output only. The duration of the conversation. + readOnly: true + latestAnalysis: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + readOnly: true + description: Output only. The conversation's latest analysis, if one exists. + GoogleCloudContactcenterinsightsV1ListAnalysesResponse: type: object - description: The request to export insights. - GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: + id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse + description: The response to list analyses. + properties: + nextPageToken: + type: string + 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. + analyses: + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + type: array + description: The analyses that match the request. + GoogleCloudContactcenterinsightsV1Issue: + description: The issue resource. + properties: + name: + type: string + description: >- + Immutable. The resource name of the issue. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + sampleUtterances: + readOnly: true + items: + type: string + type: array + description: >- + Output only. Resource names of the sample representative utterances + that match to this issue. + updateTime: + description: Output only. The most recent time that this issue was updated. + format: google-datetime + type: string + readOnly: true + displayDescription: + type: string + description: Representative description of the issue. + displayName: + description: The representative name for the issue. + type: string + createTime: + readOnly: true + description: Output only. The time at which this issue was created. + type: string + format: google-datetime type: object - id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - description: Configuration for summarization. + id: GoogleCloudContactcenterinsightsV1Issue + GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata + description: Metadata for a create analysis operation. properties: - summarizationModel: + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + description: Output only. The annotator selector used for the analysis (if any). + readOnly: true + endTime: + readOnly: true + type: string + description: Output only. The time the operation finished running. + format: google-datetime + createTime: + description: Output only. The time the operation was created. + type: string + readOnly: true + format: google-datetime + conversation: + description: >- + Output only. The Conversation that this Analysis Operation belongs + to. + type: string + readOnly: true + type: object + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + description: Aggregated statistics about an issue model. + properties: + unclassifiedConversationsCount: + description: >- + Number of analyzed conversations for which no issue was applicable + at this point in time. + format: int64 + type: string + issueStats: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + type: object + description: Statistics on each issue. Key is the issue's resource name. + analyzedConversationsCount: + format: int64 type: string - enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - description: Default summarization model to be used. - conversationProfile: description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - type: string + Number of conversations the issue model has analyzed at this point + in time. + GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: + id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + type: object + description: One channel of conversation-level sentiment data. + properties: + channelTag: + type: integer + description: The channel of the audio that the data applies to. + format: int32 + sentimentData: + description: Data specifying sentiment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: + type: object + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig properties: exactMatchConfig: - description: The configuration for the exact match rule. $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + description: The configuration for the exact match rule. description: Configuration information of a phrase match rule. + GoogleCloudContactcenterinsightsV1AnnotatorSelector: type: object - GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec: - description: >- - A customer-managed encryption key specification that can be applied to - all created resources (e.g. Conversation). - id: GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec - type: object + id: GoogleCloudContactcenterinsightsV1AnnotatorSelector + description: Selector of all available annotators and phrase matchers to run. properties: - kmsKey: + runSummarizationAnnotator: + type: boolean + description: Whether to run the summarization annotator. + runSentimentAnnotator: + type: boolean + description: Whether to run the sentiment annotator. + issueModels: description: >- - Required. The name of customer-managed encryption key that is used - to secure a resource and its sub-resources. If empty, the resource - is secured by the default Google encryption key. Only the key in the - same location as this resource is allowed to be used for encryption. - Format: - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` - type: string - name: + The issue model to run. If not provided, the most recently deployed + topic model will be used. The provided issue model will only be used + for inference if the issue model is deployed and if + run_issue_model_annotator is set to true. If more than one issue + model is provided, only the first provided issue model will be used + for inference. + items: + type: string + type: array + runIntentAnnotator: + type: boolean + description: Whether to run the intent annotator. + runEntityAnnotator: + description: Whether to run the entity annotator. + type: boolean + runPhraseMatcherAnnotator: + type: boolean + description: Whether to run the active phrase matcher annotator(s). + runInterruptionAnnotator: + type: boolean + description: Whether to run the interruption annotator. + runSilenceAnnotator: + description: Whether to run the silence annotator. + type: boolean + runIssueModelAnnotator: + type: boolean description: >- - Immutable. The resource name of the encryption key specification - resource. Format: - projects/{project}/locations/{location}/encryptionSpec - type: string - GoogleCloudContactcenterinsightsV1IssueAssignment: - description: Information about the issue. + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + summarizationConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + description: Configuration for the summarization annotator. + phraseMatchers: + items: + type: string + type: array + description: >- + The list of phrase matchers to run. If not provided, all active + phrase matchers will be used. If inactive phrase matchers are + provided, they will not be used. Phrase matchers will be run only if + run_phrase_matcher_annotator is set to true. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: type: object - id: GoogleCloudContactcenterinsightsV1IssueAssignment + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. properties: displayName: - description: >- - Immutable. Display name of the assigned issue. This field is set at - time of analyis and immutable since then. + description: The human-readable name of the intent. + type: string + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: + properties: + medium: + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + type: string + description: Required. The medium transcript objects represent. + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for processing transcript objects. + GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + description: Information about the issue. + properties: + issue: type: string + description: Resource name of the assigned issue. score: - type: number - format: double description: >- Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. - issue: - description: Resource name of the assigned issue. + format: double + type: number + displayName: + description: >- + Immutable. Display name of the assigned issue. This field is set at + time of analyis and immutable since then. type: string - GoogleCloudContactcenterinsightsV1alpha1IntentMatchData: + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata properties: - intentUniqueId: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + description: The original request for undeployment. + endTime: type: string - description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. - id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - description: >- - The data for an intent match. Represents an intent match for a text - segment in the conversation. A text segment can be part of a sentence, a - complete sentence, or an utterance with multiple sentences. + format: google-datetime + readOnly: true + description: Output only. The time the operation finished running. + createTime: + readOnly: true + description: Output only. The time the operation was created. + format: google-datetime + type: string + description: Metadata for undeploying an issue model. + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource type: object - GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: + properties: + objectUri: + type: string + description: 'Required. Format: `gs:///`' + description: Google Cloud Storage Object URI to get the issue model file from. + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: + properties: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + description: The original request for deletion. + createTime: + readOnly: true + description: Output only. The time the operation was created. + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + type: string + format: google-datetime + readOnly: true + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata + type: object + description: Metadata for deleting an issue model. + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: + id: >- + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval type: object properties: - confidenceScore: - format: float - type: number - description: >- - The system's confidence score that this answer is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - source: - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. + startTime: + format: google-datetime + description: The start time of this interval. type: string - metadata: - description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - type: object - additionalProperties: - type: string - answer: + conversationCount: + description: The number of conversations created in this interval. + format: int32 + type: integer + description: A single interval in a time series. + GoogleCloudContactcenterinsightsV1ListViewsResponse: + properties: + nextPageToken: type: string - description: The piece of text from the `source` knowledge base document. - queryRecord: + 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. + views: + type: array + description: The views that match the request. + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + type: object + description: The response of listing views. + id: GoogleCloudContactcenterinsightsV1ListViewsResponse + GoogleCloudContactcenterinsightsV1IssueModelLabelStats: + description: Aggregated statistics about an issue model. + properties: + analyzedConversationsCount: + description: >- + Number of conversations the issue model has analyzed at this point + in time. type: string + format: int64 + unclassifiedConversationsCount: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - question: + Number of analyzed conversations for which no issue was applicable + at this point in time. + format: int64 type: string - description: The corresponding FAQ question. - description: Agent Assist frequently-asked-question answer data. - id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: + issueStats: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + type: object + description: Statistics on each issue. Key is the issue's resource name. type: object - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata - description: Metadata for deleting an issue model. + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats + GoogleCloudContactcenterinsightsV1IssueModel: + type: object + description: The issue model resource. properties: - endTime: - format: google-datetime + languageCode: + description: Language of the model. type: string - description: Output only. The time the operation finished running. + displayName: + type: string + description: The representative name for the issue model. + issueCount: readOnly: true - request: - description: The original request for deletion. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest + format: int64 + description: Output only. Number of issues in this issue model. + type: string createTime: - description: Output only. The time the operation was created. + type: string + description: Output only. The time at which this issue model was created. readOnly: true format: google-datetime - type: string - GoogleCloudContactcenterinsightsV1RuntimeAnnotation: - properties: - articleSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - smartReply: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData - description: Agent Assist Smart Reply data. - smartComposeSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. - endBoundary: + inputDataConfig: + description: Configs for the input data that used to create the issue model. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + name: + type: string description: >- - The boundary in the conversation where the annotation ends, - inclusive. - annotationId: + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + updateTime: + description: >- + Output only. The most recent time at which the issue model was + updated. type: string + format: google-datetime + readOnly: true + trainingStats: description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - dialogflowInteraction: - description: Dialogflow interaction data. + Output only. Immutable. The issue model's label statistics on its + training data. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData - createTime: - format: google-datetime + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + readOnly: true + modelType: + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + description: Type of the model. + type: string + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 + state: + description: Output only. State of the model. + type: string + enumDescriptions: + - Unspecified. + - Model is not deployed but is ready to deploy. + - Model is being deployed. + - >- + Model is deployed and is ready to be used. A model can only be + used in analysis if it's in this state. + - Model is being undeployed. + - Model is being deleted. + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + readOnly: true + id: GoogleCloudContactcenterinsightsV1IssueModel + GoogleCloudContactcenterinsightsV1ConversationParticipant: + type: object + description: The call participant speaking for a given utterance. + properties: + obfuscatedExternalUserId: + description: Obfuscated user ID from Dialogflow. + type: string + dialogflowParticipant: type: string - description: The time at which this annotation was created. - userInput: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput - description: Explicit input used for generating the answer - faqAnswer: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' - description: Agent Assist FAQ answer data. - startBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary description: >- - The boundary in the conversation where the annotation starts, - inclusive. - conversationSummarizationSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - description: Conversation summarization suggestion data. - answerFeedback: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback - description: The feedback that the customer has about the answer in `data`. - id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation + Deprecated. Use `dialogflow_participant_name` instead. The name of + the Dialogflow participant. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + deprecated: true + userId: + type: string + description: A user-specified ID representing the participant. + role: + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + type: string + description: The role of the participant. + dialogflowParticipantName: + type: string + description: >- + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + id: GoogleCloudContactcenterinsightsV1ConversationParticipant + GoogleCloudContactcenterinsightsV1SilenceData: type: object - description: >- - An annotation that was generated during the customer and agent - interaction. + id: GoogleCloudContactcenterinsightsV1SilenceData + properties: {} + description: The data for a silence annotation. GoogleCloudContactcenterinsightsV1EntityMentionData: - type: object + id: GoogleCloudContactcenterinsightsV1EntityMentionData description: >- The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. - id: GoogleCloudContactcenterinsightsV1EntityMentionData + type: object properties: + entityUniqueId: + type: string + description: >- + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. type: - description: The type of the entity mention. enumDescriptions: - Unspecified. - Proper noun. - Common noun (or noun compound). + description: The type of the entity mention. type: string enum: - MENTION_TYPE_UNSPECIFIED - PROPER - COMMON sentiment: - description: Sentiment expressed for this mention of the entity. $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - entityUniqueId: - type: string - description: >- - The key of this entity in conversation entities. Can be used to - retrieve the exact `Entity` this mention is attached to. - GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - properties: - parent: - description: Required. The parent resource of the issue model. - type: string - issueModel: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - description: Required. The issue model to create. - description: The request to create an issue model. - type: object - GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: - type: object - properties: - name: - type: string - description: Required. The issue model to deploy. - description: The request to deploy an issue model. - id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: - description: The request to delete conversations in bulk. + description: Sentiment expressed for this mention of the entity. + GoogleCloudContactcenterinsightsV1alpha1SilenceData: + description: The data for a silence annotation. + id: GoogleCloudContactcenterinsightsV1alpha1SilenceData + properties: {} type: object - properties: - maxDeleteCount: - description: Maximum number of conversations to delete. - format: int32 - type: integer - force: - type: boolean - description: >- - If set to true, all of this conversation's analyses will also be - deleted. Otherwise, the request will only succeed if the - conversation has no analyses. - parent: - description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} - type: string - filter: - type: string - description: Filter used to select the subset of conversations to delete. - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata - description: The metadata for a bulk delete conversations operation. - properties: - createTime: - type: string - description: The time the operation was created. - format: google-datetime + description: The metadata for a bulk delete conversations operation. + properties: partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete. type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' + endTime: + type: string + description: The time the operation finished running. + format: google-datetime + createTime: + type: string + format: google-datetime + description: The time the operation was created. request: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest description: The original request for bulk delete. + type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: + description: Call-specific metadata. + properties: + agentChannel: + description: The audio channel that contains the agent. + type: integer + format: int32 + customerChannel: + description: The audio channel that contains the customer. + type: integer + format: int32 + id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + type: object + GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse + type: object + properties: {} + description: Response from export issue model + GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: + properties: + createTime: + description: The time the operation was created. + type: string + format: google-datetime endTime: type: string - description: The time the operation finished running. format: google-datetime + description: The time the operation finished running. + request: + description: The original export request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest type: object - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: - description: Response from import issue model - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse - type: object - GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: + description: Metadata used for export issue model. + id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest: + properties: + encryptionSpec: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. type: object - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup - description: A message representing a rule in the phrase matcher. + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + description: The request to initialize a location-level encryption specification. + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: properties: - phraseMatchRules: - description: A list of phrase match rules that are included in this group. + points: + type: array + description: >- + An ordered list of intervals from earliest to latest, where each + interval represents the number of conversations that transpired + during the time window. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule - type: array - type: + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + intervalDuration: + format: google-duration type: string - description: Required. The type of this phrase match rule group. - enum: - - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - enumDescriptions: - - Unspecified. - - Must meet all phrase match rules or there is no match. - - If any of the phrase match rules are met, there is a match. - GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: - properties: {} - description: The response to deploy an issue model. + description: The duration of each interval. + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries + description: A time series representing conversations over time. type: object - id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse - GoogleCloudContactcenterinsightsV1DialogflowIntent: - id: GoogleCloudContactcenterinsightsV1DialogflowIntent - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. + GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: + description: Metadata for undeploying an issue model. + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata properties: - displayName: - description: The human-readable name of the intent. + createTime: + description: Output only. The time the operation was created. + format: google-datetime type: string + readOnly: true + request: + description: The original request for undeployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + endTime: + type: string + format: google-datetime + readOnly: true + description: Output only. The time the operation finished running. type: object - GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: - description: >- - A point in a conversation that marks the start or the end of an - annotation. - id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: + id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + properties: + runPhraseMatcherAnnotator: + description: Whether to run the active phrase matcher annotator(s). + type: boolean + issueModels: + items: + type: string + description: >- + The issue model to run. If not provided, the most recently deployed + topic model will be used. The provided issue model will only be used + for inference if the issue model is deployed and if + run_issue_model_annotator is set to true. If more than one issue + model is provided, only the first provided issue model will be used + for inference. + type: array + runSummarizationAnnotator: + type: boolean + description: Whether to run the summarization annotator. + runSilenceAnnotator: + description: Whether to run the silence annotator. + type: boolean + runIntentAnnotator: + type: boolean + description: Whether to run the intent annotator. + runInterruptionAnnotator: + description: Whether to run the interruption annotator. + type: boolean + phraseMatchers: + items: + type: string + description: >- + The list of phrase matchers to run. If not provided, all active + phrase matchers will be used. If inactive phrase matchers are + provided, they will not be used. Phrase matchers will be run only if + run_phrase_matcher_annotator is set to true. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + type: array + runSentimentAnnotator: + description: Whether to run the sentiment annotator. + type: boolean + summarizationConfig: + description: Configuration for the summarization annotator. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + runIssueModelAnnotator: + type: boolean + description: >- + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + runEntityAnnotator: + type: boolean + description: Whether to run the entity annotator. + type: object + description: Selector of all available annotators and phrase matchers to run. + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata type: object properties: - transcriptIndex: - format: int32 + createTime: + description: The time the operation was created. + type: string + format: google-datetime + request: + description: The original export request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + endTime: + description: The time the operation finished running. + format: google-datetime + type: string + description: Metadata used for export issue model. + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: + properties: + agentChannel: description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. type: integer - wordIndex: + format: int32 + agentId: description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. - type: integer + Optional. An opaque, user-specified string representing a human + agent who handled all conversations in the import. Note that this + will be overridden if per-conversation metadata is provided through + the `metadata_bucket_uri`. + type: string + customerChannel: + description: >- + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. format: int32 - GoogleCloudContactcenterinsightsV1Conversation: + type: integer + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig + type: object + description: Configuration that applies to all conversations. + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata + type: object properties: - ttl: + endTime: type: string - format: google-duration - description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. - startTime: + description: The time the operation finished running. format: google-datetime - type: string - description: The time at which the conversation started. - turnCount: + failedAnalysesCount: + type: integer + description: The number of requested analyses that have failed so far. + format: int32 + completedAnalysesCount: + format: int32 + description: >- + The number of requested analyses that have completed successfully so + far. + type: integer + request: + description: The original request for bulk analyze. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + partialErrors: + description: >- + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. + type: array readOnly: true - type: integer - format: int32 - description: Output only. The number of turns in the conversation. + items: + $ref: '#/components/schemas/GoogleRpcStatus' createTime: - description: Output only. The time at which the conversation was created. + description: The time the operation was created. type: string - readOnly: true format: google-datetime - callMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata - description: Call-specific metadata. - duration: - format: google-duration - description: Output only. The duration of the conversation. + totalRequestedAnalysesCount: + format: int32 + description: >- + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. + type: integer + description: The metadata for a bulk analyze conversations operation. + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata: + type: object + description: Metadata for initializing a location-level encryption specification. + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata + properties: + request: readOnly: true - type: string - obfuscatedUserId: - description: Obfuscated user ID which the customer sent to us. - type: string - qualityMetadata: - description: Conversation metadata related to quality management. + description: Output only. The original request for initialization. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - latestAnalysis: - description: Output only. The conversation's latest analysis, if one exists. - readOnly: true - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' - agentId: + #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + createTime: + description: Output only. The time the operation was created. type: string - description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. - dialogflowIntents: + format: google-datetime readOnly: true + partialErrors: description: >- - Output only. All the matched Dialogflow intents in the call. The key - corresponds to a Dialogflow intent, format: - projects/{project}/agent/{agent}/intents/{intent} - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent - type: object - expireTime: - description: >- - The time at which this conversation should expire. After this time, - the conversation data and any associated analyses will be deleted. + Partial errors during initialising operation that might cause the + operation output to be incomplete. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + endTime: type: string format: google-datetime - latestSummary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - description: Output only. Latest summary of the conversation. readOnly: true - metadataJson: + description: Output only. The time the operation finished running. + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: + type: object + properties: + summarizationModel: + enum: + - SUMMARIZATION_MODEL_UNSPECIFIED + - BASELINE_MODEL + - BASELINE_MODEL_V2_0 + enumDescriptions: + - Unspecified summarization model. + - The CCAI baseline model. + - The CCAI baseline model, V2.0. + description: Default summarization model to be used. type: string + conversationProfile: description: >- - Input only. JSON Metadata encoded as a string. This field is - primarily used by Insights integrations with various telphony - systems and must be in one of Insights' supported formats. - name: + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} type: string + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + description: Configuration for summarization. + GoogleCloudContactcenterinsightsV1Analysis: + properties: + analysisResult: description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} - medium: - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - description: >- - Immutable. The conversation medium, if unspecified will default to - PHONE_CALL. - type: string - transcript: + Output only. The result of the analysis, which is populated when the + analysis finishes. readOnly: true - description: Output only. The conversation transcript. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript - dataSource: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource - description: The source of the audio and transcription for the conversation. - runtimeAnnotations: - description: >- - Output only. The annotations that were generated during the customer - and agent interaction. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation - type: array - readOnly: true - languageCode: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult + name: type: string - description: A user-specified language code for the conversation. - labels: - additionalProperties: - type: string - description: >- - A map for the user to specify any custom fields. A maximum of 20 - labels per conversation is allowed, with a maximum of 256 characters - per entry. - type: object - updateTime: description: >- - Output only. The most recent time at which the conversation was - updated. + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} + createTime: format: google-datetime + readOnly: true + description: >- + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. type: string + requestTime: readOnly: true + description: Output only. The time at which the analysis was requested. + format: google-datetime + type: string + annotatorSelector: + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector type: object - description: The conversation resource. - id: GoogleCloudContactcenterinsightsV1Conversation - GoogleLongrunningOperation: - description: >- - This resource represents a long-running operation that is the result of - a network API call. + description: The analysis resource. + id: GoogleCloudContactcenterinsightsV1Analysis + GoogleLongrunningListOperationsResponse: properties: - metadata: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - name: + nextPageToken: type: string + description: The standard List next-page token. + operations: + type: array description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - response: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. + A list of operations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: The response message for Operations.ListOperations. + id: GoogleLongrunningListOperationsResponse type: object - id: GoogleLongrunningOperation - GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: + GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: + id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData type: object - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData - description: Dialogflow interaction data. + description: >- + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. properties: - confidence: - type: number - format: float - description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). - dialogflowIntentId: + entityUniqueId: + type: string description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. + sentiment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Sentiment expressed for this mention of the entity. + type: + enumDescriptions: + - Unspecified. + - Proper noun. + - Common noun (or noun compound). + description: The type of the entity mention. type: string - GoogleCloudContactcenterinsightsV1ListViewsResponse: - id: GoogleCloudContactcenterinsightsV1ListViewsResponse - description: The response of listing views. - type: object + enum: + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: properties: - nextPageToken: + issueModel: type: string 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. - views: + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + issues: items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment type: array - description: The views that match the request. + description: All the matched issues. + description: Issue Modeling result on a conversation. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: + properties: + transcriptSegments: + description: >- + A list of sequential transcript segments that comprise the + conversation. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript + description: A message representing the transcript of a conversation. + type: object + GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: + description: The request to create an issue model. + properties: + parent: + type: string + description: Required. The parent resource of the issue model. + issueModel: + description: Required. The issue model to create. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + type: object + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse + description: The response to deploy an issue model. + type: object GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: properties: name: type: string description: Required. The issue model to deploy. - type: object - description: The request to deploy an issue model. id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: type: object - id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment - description: One channel of conversation-level sentiment data. + description: The request to deploy an issue model. + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - sentimentData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: Data specifying sentiment. - channelTag: - type: integer + details: + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: format: int32 - description: The channel of the audio that the data applies to. - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: - id: >- - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - type: object - properties: - dataset: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + message: description: >- - Required. The name of the BigQuery dataset that the snapshot result - should be exported to. If this dataset does not exist, the export - call returns an INVALID_ARGUMENT error. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - table: + id: GoogleRpcStatus + type: object + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse + properties: {} + type: object + description: The response to an IngestConversations operation. + GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: + properties: + agentInfo: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + description: Information about agents involved in the call. + waitDuration: + description: The amount of time the customer waited to connect with an agent. + format: google-duration type: string + menuPath: description: >- - The BigQuery table name to which the insights data should be - written. If this table does not exist, the export call returns an - INVALID_ARGUMENT error. - projectId: + An arbitrary string value specifying the menu path the customer + took. type: string + customerSatisfactionRating: description: >- - A project ID or number. If specified, then export will attempt to - write data to this project instead of the resource project. - Otherwise, the resource project will be used. - description: A BigQuery Table Reference. - GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: - id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation - properties: - channelTag: - description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. + An arbitrary integer value indicating the customer's satisfaction + rating. type: integer format: int32 - intentMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - description: Data specifying an intent match. - interruptionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData - description: Data specifying an interruption. - annotationEndBoundary: - description: >- - The boundary in the conversation where the annotation ends, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - silenceData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: Data specifying silence. - phraseMatchData: - description: Data specifying a phrase match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - annotationStartBoundary: - description: >- - The boundary in the conversation where the annotation starts, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - holdData: - description: Data specifying a hold. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData - issueMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - description: Data specifying an issue match. - sentimentData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Data specifying sentiment. - entityMentionData: - description: Data specifying an entity mention. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + description: Conversation metadata related to quality management. + type: object + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: type: object - description: A piece of metadata that applies to a window of a call. - GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: - id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData properties: - issueAssignment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - description: Information about the issue's assignment. - description: The data for an issue match annotation. + objectUri: + description: 'Required. Format: `gs:///`' + type: string + description: Google Cloud Storage Object URI to save the issue model to. + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: type: object - GoogleCloudContactcenterinsightsV1AnnotationBoundary: - id: GoogleCloudContactcenterinsightsV1AnnotationBoundary + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse + properties: {} + description: The response to undeploy an issue model. + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata + description: Metadata for an export insights operation. type: object - description: >- - A point in a conversation that marks the start or the end of an - annotation. properties: - transcriptIndex: - format: int32 + request: + description: The original request for export. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest + endTime: + type: string + format: google-datetime + description: Output only. The time the operation finished running. + readOnly: true + createTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time the operation was created. + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Partial errors during export operation that might cause the + operation output to be incomplete. + type: array + GoogleCloudContactcenterinsightsV1CalculateStatsResponse: + description: The response for calculating conversation statistics. + properties: + conversationCountTimeSeries: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries + description: >- + A time series representing the count of conversations created over + time that match that requested filter criteria. + issueMatches: + deprecated: true description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. + A map associating each issue resource name with its respective + number of matches in the set of conversations. Key has the format: + `projects//locations//issueModels//issues/` Deprecated, use + `issue_matches_stats` field instead. + additionalProperties: + type: integer + format: int32 + type: object + smartHighlighterMatches: + description: >- + A map associating each smart highlighter display name with its + respective number of matches in the set of conversations. + additionalProperties: + format: int32 + type: integer + type: object + conversationCount: type: integer - wordIndex: format: int32 + description: The total number of conversations. + issueMatchesStats: description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. - type: integer - GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: - properties: - agentInfo: - description: Information about agents involved in the call. - type: array - items: + A map associating each issue resource name with its respective + number of matches in the set of conversations. Key has the format: + `projects//locations//issueModels//issues/` + additionalProperties: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo - customerSatisfactionRating: + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + type: object + averageTurnCount: + description: The average number of turns per conversation. type: integer format: int32 - description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - menuPath: - description: >- - An arbitrary string value specifying the menu path the customer - took. - type: string - waitDuration: + averageDuration: type: string + description: >- + The average duration of all conversations. The average is calculated + using only conversations that have a time duration. format: google-duration - description: The amount of time the customer waited to connect with an agent. - description: Conversation metadata related to quality management. - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + customHighlighterMatches: + type: object + additionalProperties: + format: int32 + type: integer + description: >- + A map associating each custom highlighter resource name with its + respective number of matches in the set of conversations. + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse + type: object + GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: + description: Response of querying an issue model's statistics. + id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + type: object + properties: + currentStats: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + description: >- + The latest label statistics for the queried issue model. Includes + results on both training data and data labeled after deployment. + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: type: object + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + properties: + medium: + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + description: Required. The medium transcript objects represent. + type: string + description: Configuration for processing transcript objects. parameters: - access_token: - description: OAuth access token. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: access_token + name: quotaUser schema: type: string _.xgafv: @@ -4951,22 +4954,16 @@ components: name: prettyPrint schema: type: boolean - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token schema: 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. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: key + name: oauth_token schema: type: string uploadType: @@ -4975,20 +4972,19 @@ components: name: uploadType schema: type: string - alt: - description: Data format for response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: alt + name: upload_protocol schema: type: string - enum: - - json - - media - - proto - oauth_token: - description: OAuth 2.0 token for the current user. + 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. in: query - name: oauth_token + name: key schema: type: string callback: @@ -4997,148 +4993,213 @@ components: name: callback schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + alt: + description: Data format for response. in: query - name: upload_protocol + name: alt schema: type: string + enum: + - json + - media + - proto x-stackQL-resources: - insightsdata: - id: google.contactcenterinsights.insightsdata - name: insightsdata - title: Insightsdata + analyses: + id: google.contactcenterinsights.analyses + name: analyses + title: Analyses methods: - export: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsdata:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.analyses + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/analyses/methods/get' + - $ref: '#/components/x-stackQL-resources/analyses/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/analyses/methods/create' update: [] replace: [] - delete: [] - views: - id: google.contactcenterinsights.views - name: views - title: Views + delete: + - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' + conversations: + id: google.contactcenterinsights.conversations + name: conversations + title: Conversations methods: - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.views - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/patch response: mediaType: application/json openAPIDocKey: '200' - get: + calculate_stats: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:calculateStats/get response: mediaType: application/json openAPIDocKey: '200' - delete: + bulk_analyze: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post + response: + mediaType: application/json + openAPIDocKey: '200' + ingest: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.conversations + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkDelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/views/methods/get' - - $ref: '#/components/x-stackQL-resources/views/methods/list' + - $ref: '#/components/x-stackQL-resources/conversations/methods/get' + - $ref: '#/components/x-stackQL-resources/conversations/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/views/methods/create' + - $ref: '#/components/x-stackQL-resources/conversations/methods/create' update: - - $ref: '#/components/x-stackQL-resources/views/methods/patch' + - $ref: '#/components/x-stackQL-resources/conversations/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/views/methods/delete' - phrase_matchers: - id: google.contactcenterinsights.phrase_matchers - name: phrase_matchers - title: Phrase_matchers + - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' + - $ref: '#/components/x-stackQL-resources/conversations/methods/bulk_delete' + views: + id: google.contactcenterinsights.views + name: views + title: Views methods: - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.phraseMatchers - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.views sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' + - $ref: '#/components/x-stackQL-resources/views/methods/get' + - $ref: '#/components/x-stackQL-resources/views/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' + - $ref: '#/components/x-stackQL-resources/views/methods/create' update: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/patch' + - $ref: '#/components/x-stackQL-resources/views/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' + - $ref: '#/components/x-stackQL-resources/views/methods/delete' operations: id: google.contactcenterinsights.operations name: operations title: Operations methods: - list: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations get: operation: $ref: >- @@ -5146,13 +5207,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - cancel: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -5161,267 +5223,205 @@ components: update: [] replace: [] delete: [] - issue_models: - id: google.contactcenterinsights.issue_models - name: issue_models - title: Issue_models + phrase_matchers: + id: google.contactcenterinsights.phrase_matchers + name: phrase_matchers + title: Phrase_matchers methods: - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/patch response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.phraseMatchers create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post - response: - mediaType: application/json - openAPIDocKey: '200' - export: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post - response: - mediaType: application/json - openAPIDocKey: '200' - deploy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post - response: - mediaType: application/json - openAPIDocKey: '200' - import: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post - response: - mediaType: application/json - openAPIDocKey: '200' - calculate_issue_model_stats: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:calculateIssueModelStats/get - response: - mediaType: application/json - openAPIDocKey: '200' - undeploy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/get' - - $ref: '#/components/x-stackQL-resources/issue_models/methods/list' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/create' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' update: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/patch' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/delete' - issues: - id: google.contactcenterinsights.issues - name: issues - title: Issues + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' + insightsdata: + id: google.contactcenterinsights.insightsdata + name: insightsdata + title: Insightsdata methods: - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - list: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsdata:export/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/issues/methods/get' - - $ref: '#/components/x-stackQL-resources/issues/methods/list' + select: [] insert: [] - update: - - $ref: '#/components/x-stackQL-resources/issues/methods/patch' + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/issues/methods/delete' - analyses: - id: google.contactcenterinsights.analyses - name: analyses - title: Analyses + delete: [] + issue_models: + id: google.contactcenterinsights.issue_models + name: issue_models + title: Issue_models methods: - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get response: mediaType: application/json openAPIDocKey: '200' - create: + undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.analyses - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/analyses/methods/get' - - $ref: '#/components/x-stackQL-resources/analyses/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/analyses/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' - conversations: - id: google.contactcenterinsights.conversations - name: conversations - title: Conversations - methods: - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' - upload: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post response: mediaType: application/json openAPIDocKey: '200' - bulk_analyze: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post response: mediaType: application/json openAPIDocKey: '200' - bulk_delete: + calculate_issue_model_stats: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkDelete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:calculateIssueModelStats/get response: mediaType: application/json openAPIDocKey: '200' - ingest: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/get' + - $ref: '#/components/x-stackQL-resources/issue_models/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/delete' + issues: + id: google.contactcenterinsights.issues + name: issues + title: Issues + methods: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete response: mediaType: application/json openAPIDocKey: '200' - calculate_stats: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:calculateStats/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.conversations - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/conversations/methods/get' - - $ref: '#/components/x-stackQL-resources/conversations/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/conversations/methods/create' + - $ref: '#/components/x-stackQL-resources/issues/methods/get' + - $ref: '#/components/x-stackQL-resources/issues/methods/list' + insert: [] update: - - $ref: '#/components/x-stackQL-resources/conversations/methods/patch' + - $ref: '#/components/x-stackQL-resources/issues/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' - - $ref: '#/components/x-stackQL-resources/conversations/methods/bulk_delete' + - $ref: '#/components/x-stackQL-resources/issues/methods/delete' encryption_spec: id: google.contactcenterinsights.encryption_spec name: encryption_spec @@ -5477,28 +5477,22 @@ components: replace: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: parameters: &ref_1 - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/upload_protocol' - post: - description: Export insights data to a destination defined in the request body. - operationId: contactcenterinsights.projects.locations.insightsdata.export - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' + get: + description: Lists analyses. + operationId: contactcenterinsights.projects.locations.conversations.analyses.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5510,7 +5504,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse parameters: - in: path name: projectsId @@ -5522,33 +5517,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/views: - parameters: *ref_1 - get: - description: Lists views. - operationId: contactcenterinsights.projects.locations.views.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse - parameters: - in: path - name: projectsId + name: conversationsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -5557,17 +5532,19 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string post: - description: Creates a view. - operationId: contactcenterinsights.projects.locations.views.create + description: >- + Creates an analysis. The long running operation is done when the + analysis has completed. + operationId: contactcenterinsights.projects.locations.conversations.analyses.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5579,7 +5556,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5591,16 +5568,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: + - in: path + name: conversationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: parameters: *ref_1 - patch: - description: Updates a view. - operationId: contactcenterinsights.projects.locations.views.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + delete: + description: Deletes an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5612,7 +5589,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5625,18 +5602,18 @@ paths: schema: type: string - in: path - name: viewsId + name: conversationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: analysesId + required: true schema: type: string - format: google-fieldmask get: - description: Gets a view. - operationId: contactcenterinsights.projects.locations.views.get + description: Gets an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5648,7 +5625,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis parameters: - in: path name: projectsId @@ -5661,13 +5639,20 @@ paths: schema: type: string - in: path - name: viewsId + name: conversationsId required: true schema: type: string - delete: - description: Deletes a view. - operationId: contactcenterinsights.projects.locations.views.delete + - in: path + name: analysesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: + parameters: *ref_1 + get: + description: Gets a conversation. + operationId: contactcenterinsights.projects.locations.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5679,7 +5664,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -5692,21 +5678,17 @@ paths: schema: type: string - in: path - name: viewsId + name: conversationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers: - parameters: *ref_1 - post: - description: Creates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + - in: query + name: view + schema: + type: string + delete: + description: Deletes a conversation. + operationId: contactcenterinsights.projects.locations.conversations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5718,8 +5700,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5731,9 +5712,24 @@ paths: required: true schema: type: string - get: - description: Lists phrase matchers. - operationId: contactcenterinsights.projects.locations.phraseMatchers.list + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + patch: + description: Updates a conversation. + operationId: contactcenterinsights.projects.locations.conversations.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5746,7 +5742,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -5758,30 +5754,21 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: conversationsId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats: parameters: *ref_1 - patch: - description: Updates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + get: + description: Gets conversation statistics. + operationId: contactcenterinsights.projects.locations.conversations.calculateStats security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5794,7 +5781,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse parameters: - in: path name: projectsId @@ -5806,19 +5793,21 @@ paths: required: true schema: type: string - - in: path - name: phraseMatchersId - required: true - schema: - type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - delete: - description: Deletes a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.delete + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: + parameters: *ref_1 + post: + description: Analyzes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5830,7 +5819,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5842,14 +5831,19 @@ paths: required: true schema: type: string - - in: path - name: phraseMatchersId - required: true - schema: - type: string - get: - description: Gets a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.get + /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: + parameters: *ref_1 + post: + description: >- + Imports conversations and processes them according to the user's + configuration. + operationId: contactcenterinsights.projects.locations.conversations.ingest + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5861,8 +5855,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5874,18 +5867,11 @@ paths: required: true schema: type: string - - in: path - name: phraseMatchersId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/conversations: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: contactcenterinsights.projects.locations.operations.list + description: Lists conversations. + operationId: contactcenterinsights.projects.locations.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5897,7 +5883,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse parameters: - in: path name: projectsId @@ -5909,6 +5896,14 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string - in: query name: pageSize schema: @@ -5919,17 +5914,20 @@ paths: schema: type: string - in: query - name: filter + name: view schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 - get: + post: 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. - operationId: contactcenterinsights.projects.locations.operations.get + Creates a conversation. Does not support audio transcription or DLP + redaction. Use `conversations.upload` instead. + operationId: contactcenterinsights.projects.locations.conversations.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5941,7 +5939,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -5953,25 +5952,21 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: conversationId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete: parameters: *ref_1 post: - 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`. - operationId: contactcenterinsights.projects.locations.operations.cancel + description: Deletes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5983,7 +5978,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5995,16 +5990,20 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: + /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: parameters: *ref_1 - get: - description: Gets an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.get + post: + description: >- + Create a long-running conversation upload operation. This method differs + from `CreateConversation` by allowing audio transcription and optional + DLP redaction. + operationId: contactcenterinsights.projects.locations.conversations.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6016,8 +6015,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6029,20 +6027,11 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true - schema: - type: string - patch: - description: Updates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: + parameters: *ref_1 + delete: + description: Deletes a view. + operationId: contactcenterinsights.projects.locations.views.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6054,8 +6043,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6068,18 +6056,18 @@ paths: schema: type: string - in: path - name: issueModelsId + name: viewsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.delete + patch: + description: Updates a view. + operationId: contactcenterinsights.projects.locations.views.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6091,7 +6079,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -6104,15 +6092,18 @@ paths: schema: type: string - in: path - name: issueModelsId + name: viewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels: - parameters: *ref_1 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Lists issue models. - operationId: contactcenterinsights.projects.locations.issueModels.list + description: Gets a view. + operationId: contactcenterinsights.projects.locations.views.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6124,8 +6115,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -6137,49 +6127,21 @@ paths: required: true schema: type: string - post: - description: Creates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: viewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: + /v1/projects/{projectsId}/locations/{locationsId}/views: parameters: *ref_1 post: - description: Exports an issue model to the provided destination. - operationId: contactcenterinsights.projects.locations.issueModels.export + description: Creates a view. + operationId: contactcenterinsights.projects.locations.views.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6191,7 +6153,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -6203,24 +6165,9 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: - parameters: *ref_1 - post: - description: >- - Deploys an issue model. Returns an error if a model is already deployed. - An issue model can only be used in analysis after it has been deployed. - operationId: contactcenterinsights.projects.locations.issueModels.deploy - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + get: + description: Lists views. + operationId: contactcenterinsights.projects.locations.views.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6232,7 +6179,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse parameters: - in: path name: projectsId @@ -6244,22 +6192,29 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Imports an issue model from a Cloud Storage bucket. - operationId: contactcenterinsights.projects.locations.issueModels.import - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + 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`. + operationId: contactcenterinsights.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6271,7 +6226,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6283,12 +6238,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets an issue model's statistics. - operationId: >- - contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats + 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. + operationId: contactcenterinsights.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6300,8 +6262,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6314,23 +6275,17 @@ paths: schema: type: string - in: path - name: issueModelsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: + /v1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_1 - post: + get: description: >- - Undeploys an issue model. An issue model can not be used in analysis - after it has been undeployed. - operationId: contactcenterinsights.projects.locations.issueModels.undeploy - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: contactcenterinsights.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6342,7 +6297,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -6354,16 +6309,24 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: parameters: *ref_1 delete: - description: Deletes an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.delete + description: Deletes a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6388,18 +6351,13 @@ paths: schema: type: string - in: path - name: issueModelsId - required: true - schema: - type: string - - in: path - name: issuesId + name: phraseMatchersId required: true schema: type: string get: - description: Gets an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.get + description: Gets a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6411,7 +6369,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -6424,23 +6383,19 @@ paths: schema: type: string - in: path - name: issueModelsId - required: true - schema: - type: string - - in: path - name: issuesId + name: phraseMatchersId required: true schema: type: string patch: - description: Updates an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.patch + description: Updates a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6452,7 +6407,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -6465,12 +6421,7 @@ paths: schema: type: string - in: path - name: issueModelsId - required: true - schema: - type: string - - in: path - name: issuesId + name: phraseMatchersId required: true schema: type: string @@ -6479,11 +6430,11 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers: parameters: *ref_1 get: - description: Lists issues. - operationId: contactcenterinsights.projects.locations.issueModels.issues.list + description: Lists phrase matchers. + operationId: contactcenterinsights.projects.locations.phraseMatchers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6496,7 +6447,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse parameters: - in: path name: projectsId @@ -6508,16 +6459,28 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: - parameters: *ref_1 - delete: - description: Deletes an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.delete + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6529,7 +6492,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -6541,19 +6505,17 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: analysesId - required: true - schema: - type: string - get: - description: Gets an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.get + /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: + parameters: *ref_1 + post: + description: Export insights data to a destination defined in the request body. + operationId: contactcenterinsights.projects.locations.insightsdata.export + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6565,8 +6527,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6578,28 +6539,17 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: analysesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels: parameters: *ref_1 post: - description: >- - Creates an analysis. The long running operation is done when the - analysis has completed. - operationId: contactcenterinsights.projects.locations.conversations.analyses.create + description: Creates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6623,14 +6573,9 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string get: - description: Lists analyses. - operationId: contactcenterinsights.projects.locations.conversations.analyses.list + description: Lists issue models. + operationId: contactcenterinsights.projects.locations.issueModels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6643,7 +6588,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse parameters: - in: path name: projectsId @@ -6655,29 +6600,52 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: + parameters: *ref_1 + post: + description: >- + Undeploys an issue model. An issue model can not be used in analysis + after it has been undeployed. + operationId: contactcenterinsights.projects.locations.issueModels.undeploy + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: conversationsId + name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: issueModelsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: parameters: *ref_1 - get: - description: Gets a conversation. - operationId: contactcenterinsights.projects.locations.conversations.get + delete: + description: Deletes an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6689,8 +6657,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6703,23 +6670,19 @@ paths: schema: type: string - in: path - name: conversationsId + name: issueModelsId required: true schema: type: string - - in: query - name: view - schema: - type: string patch: - description: Updates a conversation. - operationId: contactcenterinsights.projects.locations.conversations.patch + description: Updates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6732,7 +6695,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel parameters: - in: path name: projectsId @@ -6745,7 +6708,7 @@ paths: schema: type: string - in: path - name: conversationsId + name: issueModelsId required: true schema: type: string @@ -6754,9 +6717,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a conversation. - operationId: contactcenterinsights.projects.locations.conversations.delete + get: + description: Gets an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6768,7 +6731,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel parameters: - in: path name: projectsId @@ -6781,28 +6745,23 @@ paths: schema: type: string - in: path - name: conversationsId + name: issueModelsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: parameters: *ref_1 post: description: >- - Create a long-running conversation upload operation. This method differs - from `CreateConversation` by allowing audio transcription and optional - DLP redaction. - operationId: contactcenterinsights.projects.locations.conversations.upload + Deploys an issue model. Returns an error if a model is already deployed. + An issue model can only be used in analysis after it has been deployed. + operationId: contactcenterinsights.projects.locations.issueModels.deploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6826,17 +6785,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: parameters: *ref_1 post: - description: Analyzes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze + description: Imports an issue model from a Cloud Storage bucket. + operationId: contactcenterinsights.projects.locations.issueModels.import requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6860,17 +6824,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: parameters: *ref_1 post: - description: Deletes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkDelete + description: Exports an issue model to the provided destination. + operationId: contactcenterinsights.projects.locations.issueModels.export requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6894,19 +6858,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: parameters: *ref_1 - post: - description: >- - Imports conversations and processes them according to the user's - configuration. - operationId: contactcenterinsights.projects.locations.conversations.ingest - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + get: + description: Gets an issue model's statistics. + operationId: >- + contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6918,7 +6880,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse parameters: - in: path name: projectsId @@ -6930,11 +6893,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats: + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: parameters: *ref_1 - get: - description: Gets conversation statistics. - operationId: contactcenterinsights.projects.locations.conversations.calculateStats + delete: + description: Deletes an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6946,8 +6914,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6959,15 +6926,24 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: issueModelsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations: - parameters: *ref_1 - get: - description: Lists conversations. - operationId: contactcenterinsights.projects.locations.conversations.list + - in: path + name: issuesId + required: true + schema: + type: string + patch: + description: Updates an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6979,8 +6955,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' parameters: - in: path name: projectsId @@ -6992,38 +6967,62 @@ paths: required: true schema: type: string - - in: query - name: orderBy + - in: path + name: issueModelsId + required: true schema: type: string - - in: query - name: view + - in: path + name: issuesId + required: true schema: type: string - in: query - name: filter + name: updateMask schema: type: string - - in: query - name: pageSize + format: google-fieldmask + get: + description: Gets an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + parameters: + - in: path + name: projectsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: locationsId + required: true schema: type: string - post: - description: >- - Creates a conversation. Does not support audio transcription or DLP - redaction. Use `conversations.upload` instead. - operationId: contactcenterinsights.projects.locations.conversations.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + - in: path + name: issueModelsId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: + parameters: *ref_1 + get: + description: Lists issues. + operationId: contactcenterinsights.projects.locations.issueModels.issues.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7036,7 +7035,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse parameters: - in: path name: projectsId @@ -7048,8 +7047,9 @@ paths: required: true schema: type: string - - in: query - name: conversationId + - in: path + name: issueModelsId + required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize: @@ -7091,11 +7091,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec: + /v1/projects/{projectsId}/locations/{locationsId}/settings: parameters: *ref_1 - get: - description: Gets location-level encryption key specification. - operationId: contactcenterinsights.projects.locations.getEncryptionSpec + patch: + description: Updates project-level settings. + operationId: contactcenterinsights.projects.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Settings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7108,7 +7113,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + #/components/schemas/GoogleCloudContactcenterinsightsV1Settings parameters: - in: path name: projectsId @@ -7120,16 +7125,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/settings: - parameters: *ref_1 - patch: - description: Updates project-level settings. - operationId: contactcenterinsights.projects.locations.updateSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Settings' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets project-level settings. + operationId: contactcenterinsights.projects.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7154,14 +7157,11 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec: + parameters: *ref_1 get: - description: Gets project-level settings. - operationId: contactcenterinsights.projects.locations.getSettings + description: Gets location-level encryption key specification. + operationId: contactcenterinsights.projects.locations.getEncryptionSpec security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7174,7 +7174,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Settings + #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec parameters: - in: path name: projectsId diff --git a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml index dcd54f8f..ce5485f5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml @@ -12,7 +12,7 @@ info: is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts. version: v1 - x-discovery-doc-revision: '20240916' + x-discovery-doc-revision: '20240830' x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/container-analysis/api/reference/rest/ @@ -39,375 +39,391 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + ProjectRepoId: properties: - version: - description: >- - Maven `version` value used when uploading the artifact to Artifact - Registry. - type: string - groupId: - type: string - description: >- - Maven `groupId` value used when uploading the artifact to Artifact - Registry. - artifactId: - description: >- - Maven `artifactId` value used when uploading the artifact to - Artifact Registry. - type: string - repository: + repoName: type: string - description: >- - Artifact Registry repository, in the form - "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the - workspace specified by path will be uploaded to Artifact Registry - with this location as a prefix. - path: - description: >- - Path to an artifact in the build's workspace to be uploaded to - Artifact Registry. This can be either an absolute path, e.g. - /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path - from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + description: The name of the repo. Leave empty for the default repo. + projectId: type: string - type: object + description: The ID of the project. description: >- - A Maven artifact to upload to Artifact Registry upon successful - completion of all build steps. - GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: + Selects a repo using a Google Cloud Platform project ID (e.g., + winged-cargo-31) and a repo name within that project. + id: ProjectRepoId type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder + AnalysisCompleted: + id: AnalysisCompleted properties: - id: - type: string - description: >- - Identifies the entity that executed the recipe, which is trusted to have - correctly performed the operation and populated this provenance. - ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: + analysisType: + type: array + items: + type: string type: object description: >- - Location of the source in a 2nd-gen Google Cloud Build repository - resource. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + Indicates which analysis completed successfully. Multiple types of + analysis can be performed on a single resource. + Completeness: + id: Completeness + description: >- + Indicates that the builder claims certain fields in this message to be + complete. properties: - revision: + arguments: description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. + If true, the builder claims that recipe.arguments is complete, + meaning that all external inputs are properly captured in the + recipe. + type: boolean + environment: + description: >- + If true, the builder claims that recipe.environment is claimed to be + complete. + type: boolean + materials: + type: boolean + description: >- + If true, the builder claims that materials are complete, usually + through some controls to prevent network access. Sometimes called + "hermetic". + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: + description: Location of the source in any accessible Git repository. + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + properties: + revision: type: string + description: >- + Optional. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git + fetch` to fetch the revision from the Git repository; therefore make + sure that the string you provide for `revision` is parsable by the + command. For information on string values accepted by `git fetch`, + see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For + information on `git fetch`, see https://git-scm.com/docs/git-fetch. dir: + type: string description: >- Optional. Directory, relative to the source root, in which to run - the build. - type: string - repository: + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. + url: description: >- - Required. Name of the Google Cloud Build repository, formatted as - `projects/*/locations/*/connections/*/repositories/*`. + Required. Location of the Git repo to build. This will be used as a + `git remote`, see https://git-scm.com/docs/git-remote. type: string - NonCompliantFile: + SBOMReferenceNote: properties: - reason: - type: string - description: Explains why a file is non compliant for a CIS check. - displayCommand: - description: Command to display the non-compliant files. + version: + description: >- + The version of the format that the SBOM takes. E.g. if the format is + spdx, the version may be 2.3. type: string - path: + format: + description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... type: string - description: Empty if `display_command` is set. - id: NonCompliantFile type: object - description: >- - Details about files that caused a compliance check to fail. - display_command is a single command that can be used to display a list - of non compliant files. When there is no such command, we can also - iterate a list of non compliant file using 'path'. - ImageNote: + description: The note representing an SBOM reference. + id: SBOMReferenceNote + RelatedUrl: type: object - id: ImageNote - description: >- - Basis describes the base image portion (Note) of the DockerImage - relationship. Linked occurrences are derived from this or an equivalent - image via: FROM Or an equivalent reference, e.g., a tag of the - resource_url. + description: Metadata for any related URL information. properties: - fingerprint: - $ref: '#/components/schemas/Fingerprint' - description: Required. Immutable. The fingerprint of the base image. - resourceUrl: + label: type: string - description: >- - Required. Immutable. The resource_url for the resource representing - the basis of associated occurrence images. - GrafeasV1FileLocation: + description: Label to describe usage of the URL. + url: + description: Specific URL associated with the resource. + type: string + id: RelatedUrl + ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: type: object - id: GrafeasV1FileLocation - description: Indicates the location at which a package was found. + description: Location of the source in a Google Cloud Source Repository. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource properties: - filePath: + dir: + description: >- + Optional. Directory, relative to the source root, in which to run + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. type: string + tagName: description: >- - For jars that are contained inside .war files, this filepath can - indicate the path to war file combined with the path to jar file. - BuildDefinition: - properties: - externalParameters: - additionalProperties: - description: Properties of the object. - type: any - type: object - buildType: + Regex matching tags to build. The syntax of the regular expressions + accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax type: string - internalParameters: - additionalProperties: - description: Properties of the object. - type: any + repoName: + type: string + description: Required. Name of the Cloud Source Repository. + invertRegex: + description: >- + Optional. Only trigger a build if the revision regex does NOT match + the revision regex. + type: boolean + substitutions: type: object - resolvedDependencies: - type: array - items: - $ref: '#/components/schemas/ResourceDescriptor' - id: BuildDefinition - type: object - SbomReferenceIntotoPayload: - properties: - predicate: description: >- - Additional parameters of the Predicate. Includes the actual data - about the SBOM. - $ref: '#/components/schemas/SbomReferenceIntotoPredicate' - subject: + Optional. Substitutions to use in a triggered build. Should only be + used with RunBuildTrigger + additionalProperties: + type: string + projectId: + type: string description: >- - Set of software artifacts that the attestation applies to. Each - element represents a single software artifact. - items: - $ref: '#/components/schemas/Subject' - type: array - predicateType: - description: URI identifying the type of the Predicate. + Optional. ID of the project that owns the Cloud Source Repository. + If omitted, the project ID requesting the build is assumed. + commitSha: type: string - _type: - description: Identifier for the schema of the Statement. + description: Explicit commit SHA to build. + branchName: + type: string + description: >- + Regex matching branches to build. The syntax of the regular + expressions accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax + BuilderConfig: + properties: + id: type: string - description: >- - The actual payload that contains the SBOM Reference data. The payload - follows the intoto statement specification. See - https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md - for more details. type: object - id: SbomReferenceIntotoPayload - Fingerprint: + id: BuilderConfig + ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: properties: - v1Name: + envMap: + type: object description: >- - Required. The layer ID of the final layer in the Docker image's v1 - representation. - type: string - v2Blob: - type: array - items: - type: string - description: Required. The ordered list of v2 blobs that represent a given image. - v2Name: - description: >- - Output only. The name of the image's v2 blobs computed via: [bottom] - := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the - name of the final blob is kept. + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. + additionalProperties: + format: byte + type: string + kmsKeyName: type: string - description: A set of properties that uniquely identify a given Docker image. - id: Fingerprint - type: object - Empty: + description: >- + Resource name of Cloud KMS crypto key to decrypt the encrypted + value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* type: object - id: 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); } - properties: {} - BatchCreateNotesResponse: - id: BatchCreateNotesResponse - properties: - notes: - description: The notes that were created. - items: - $ref: '#/components/schemas/Note' - type: array - type: object - description: Response for creating notes in batch. - SlsaProvenanceZeroTwo: - id: SlsaProvenanceZeroTwo - description: See full explanation of fields at slsa.dev/provenance/v0.2. - properties: - invocation: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' - materials: - items: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' - type: array - builder: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' - buildType: - type: string - metadata: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' - buildConfig: - additionalProperties: - type: any - description: Properties of the object. - type: object - type: object - DiscoveryOccurrence: - description: Provides information about the analysis status of a discovered resource. + Pairs a set of secret environment variables mapped to encrypted values + with the Cloud KMS key to use to decrypt the value. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: properties: - lastScanTime: - type: string - description: The last time this resource was scanned. - format: google-datetime - analysisCompleted: - $ref: '#/components/schemas/AnalysisCompleted' - archiveTime: - readOnly: true - format: google-datetime + version: description: >- - Output only. The time occurrences related to this discovery - occurrence were archived. + Maven `version` value used when uploading the artifact to Artifact + Registry. type: string - sbomStatus: - $ref: '#/components/schemas/SBOMStatus' - description: The status of an SBOM generation. - analysisStatusError: + repository: description: >- - When an error is encountered this will contain a LocalizedMessage - under details to show to the user. The LocalizedMessage is output - only and populated by the API. - $ref: '#/components/schemas/Status' - continuousAnalysis: - description: Whether the resource is continuously analyzed. + Artifact Registry repository, in the form + "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the + workspace specified by path will be uploaded to Artifact Registry + with this location as a prefix. type: string - enum: - - CONTINUOUS_ANALYSIS_UNSPECIFIED - - ACTIVE - - INACTIVE - enumDescriptions: - - Unknown. - - The resource is continuously analyzed. - - The resource is ignored for continuous analysis. - cpe: + artifactId: type: string - description: The CPE of the resource being scanned. - analysisStatus: - description: The status of discovery for the resource. - enum: - - ANALYSIS_STATUS_UNSPECIFIED - - PENDING - - SCANNING - - FINISHED_SUCCESS - - COMPLETE - - FINISHED_FAILED - - FINISHED_UNSUPPORTED + description: >- + Maven `artifactId` value used when uploading the artifact to + Artifact Registry. + path: type: string - enumDescriptions: - - Unknown. - - Resource is known but no action has been taken yet. - - Resource is being analyzed. - - Analysis has finished successfully. - - Analysis has completed. - - >- - Analysis has finished unsuccessfully, the analysis itself is in a - bad state. - - The resource is known not to be supported. - analysisError: - items: - $ref: '#/components/schemas/Status' description: >- - Indicates any errors encountered during analysis of a resource. - There could be 0 or more of these errors. - type: array + Path to an artifact in the build's workspace to be uploaded to + Artifact Registry. This can be either an absolute path, e.g. + /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path + from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + groupId: + type: string + description: >- + Maven `groupId` value used when uploading the artifact to Artifact + Registry. + description: >- + A Maven artifact to upload to Artifact Registry upon successful + completion of all build steps. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact type: object - id: DiscoveryOccurrence - ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + WindowsDetail: type: object properties: - gitRepositoryLink: + description: + description: The description of this vulnerability. type: string - description: >- - Required. The Developer Connect Git repository link, formatted as - `projects/*/locations/*/connections/*/gitRepositoryLink/*`. - dir: + cpeUri: type: string description: >- - Required. Directory, relative to the source root, in which to run - the build. - revision: + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. + name: + description: Required. The name of this vulnerability. + type: string + fixingKbs: + items: + $ref: '#/components/schemas/KnowledgeBase' description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. + Required. The names of the KBs which have hotfixes to mitigate this + vulnerability. Note that there may be multiple hotfixes (and thus + multiple KBs) that mitigate a given vulnerability. Currently any + listed KBs presence is considered a fix. + type: array + id: WindowsDetail + CloudRepoSourceContext: + id: CloudRepoSourceContext + properties: + revisionId: + description: A revision ID. type: string - description: This config defines the location of a source through Developer Connect. - GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: - type: object + repoId: + description: The ID of the repo. + $ref: '#/components/schemas/RepoId' + aliasContext: + description: An alias, which may be a branch or tag. + $ref: '#/components/schemas/AliasContext' description: >- - Metadata for all operations used and required for all operations that - created by Container Analysis Providers + A CloudRepoSourceContext denotes a particular revision in a Google Cloud + Source Repo. + type: object + EnvelopeSignature: + type: object properties: - endTime: - description: >- - Output only. The time that this operation was marked completed or - failed. + keyid: type: string - format: google-datetime - createTime: - description: Output only. The time this operation was created. - format: google-datetime + sig: + format: byte type: string - id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata - ListNotesResponse: - description: Response for listing notes. - type: object - id: ListNotesResponse + id: EnvelopeSignature + ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: properties: - notes: - items: - $ref: '#/components/schemas/Note' + fileHash: + description: Collection of file hashes. type: array - description: The notes requested. - nextPageToken: - description: >- - The next pagination token in the list response. It should be used as - `page_token` for the following request. An empty value means no more - results. - type: string - PackageNote: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + type: object + description: >- + Container message for hashes of byte content of files, used in + SourceProvenance messages to verify integrity of source input to the + build. + TestIamPermissionsRequest: + description: Request message for `TestIamPermissions` method. + id: TestIamPermissionsRequest type: object - description: PackageNote represents a particular package version. properties: - packageType: - type: string - description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - distribution: + permissions: items: - $ref: '#/components/schemas/Distribution' - description: Deprecated. The various channels by which a package is distributed. - type: array - digest: + type: string description: >- - Hash value, typically a file digest, that allows unique - identification a specific package. + 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). + type: array + InTotoStatement: + type: object + id: InTotoStatement + description: >- + Spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement The + serialized InTotoStatement will be stored as Envelope.payload. + Envelope.payloadType is always "application/vnd.in-toto+json". + properties: + predicateType: + type: string + description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' + slsaProvenanceZeroTwo: + $ref: '#/components/schemas/SlsaProvenanceZeroTwo' + _type: + description: Always `https://in-toto.io/Statement/v0.1`. + type: string + subject: + type: array items: - $ref: '#/components/schemas/Digest' + $ref: '#/components/schemas/Subject' + provenance: + $ref: '#/components/schemas/InTotoProvenance' + slsaProvenance: + $ref: '#/components/schemas/SlsaProvenance' + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: + type: object + description: A fatal problem encountered during the execution of the build. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + properties: + detail: + type: string + description: Explains the failure issue in more detail using hard-coded text. + type: + enumDescriptions: + - Type unspecified + - Unable to push the image to the repository. + - Final image not found. + - Unauthorized push of the final image. + - Backend logging failures. Should retry. + - A build step has failed. + - The source fetching has failed. + description: The name of the failure. + enum: + - FAILURE_TYPE_UNSPECIFIED + - PUSH_FAILED + - PUSH_IMAGE_NOT_FOUND + - PUSH_NOT_AUTHORIZED + - LOGGING_FAILURE + - USER_BUILD_STEP + - FETCH_SOURCE_FAILED + type: string + Fingerprint: + description: A set of properties that uniquely identify a given Docker image. + properties: + v2Blob: + items: + type: string + description: Required. The ordered list of v2 blobs that represent a given image. type: array - architecture: + v2Name: type: string description: >- - The CPU architecture for which packages in this distribution channel - were built. Architecture will be blank for language packages. + Output only. The name of the image's v2 blobs computed via: [bottom] + := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the + name of the final blob is kept. + v1Name: + type: string + description: >- + Required. The layer ID of the final layer in the Docker image's v1 + representation. + id: Fingerprint + type: object + Distribution: + type: object + description: >- + This represents a particular channel of distribution for a given + package. E.g., Debian's jessie-backports dpkg mirror. + properties: + description: + description: The distribution channel-specific description of this package. + type: string + maintainer: + description: A freeform string denoting the maintainer of this package. + type: string + latestVersion: + description: >- + The latest available version of this package in this distribution + channel. + $ref: '#/components/schemas/Version' + cpeUri: + description: >- + Required. The cpe_uri in [CPE + format](https://cpe.mitre.org/specification/) denoting the package + manager version distributing a package. + type: string + architecture: enum: - ARCHITECTURE_UNSPECIFIED - X86 @@ -416,659 +432,392 @@ components: - Unknown architecture. - X86 architecture. - X64 architecture. - name: - type: string - description: Required. Immutable. The name of the package. - license: - $ref: '#/components/schemas/License' - description: Licenses that have been declared by the authors of the package. - cpeUri: description: >- - The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) - denoting the package manager version distributing a package. The - cpe_uri will be blank for language packages. - type: string - description: - description: The description of this package. + The CPU architecture for which packages in this distribution channel + were built. type: string url: type: string - description: The homepage for this package. - maintainer: - description: A freeform text denoting the maintainer of this package. + description: The distribution channel-specific homepage for this package. + id: Distribution + NonCompliantFile: + properties: + reason: + description: Explains why a file is non compliant for a CIS check. type: string - version: - $ref: '#/components/schemas/Version' - description: The version of the package. - id: PackageNote - Recipe: - id: Recipe + path: + type: string + description: Empty if `display_command` is set. + displayCommand: + description: Command to display the non-compliant files. + type: string + id: NonCompliantFile type: object description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. + Details about files that caused a compliance check to fail. + display_command is a single command that can be used to display a list + of non compliant files. When there is no such command, we can also + iterate a list of non compliant file using 'path'. + WindowsUpdate: properties: - definedInMaterial: + description: type: string - description: >- - Index in materials containing the recipe steps that are not implied - by recipe.type. For example, if the recipe type were "make", then - this would point to the source containing the Makefile, not the make - program itself. Set to -1 if the recipe doesn't come from a - material, as zero is default unset value for int64. - format: int64 - environment: + description: The localized description of the update. + categories: items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + $ref: '#/components/schemas/Category' + description: The list of categories to which the update belongs. type: array - description: >- - Any other builder-controlled inputs necessary for correctly - evaluating the recipe. Usually only needed for reproducing the build - but not evaluated as part of policy. Since the environment field can - greatly vary in structure, depending on the builder and recipe type, - this is of form "Any". - type: - description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. + title: type: string - arguments: + description: The localized title of the update. + identity: + $ref: '#/components/schemas/Identity' + description: Required - The unique identifier for the update. + supportUrl: + type: string + description: The hyperlink to the support information for the update. + lastPublishedTimestamp: + type: string + format: google-datetime + description: The last published timestamp of the update. + kbArticleIds: description: >- - Collection of all external inputs that influenced the build on top - of recipe.definedInMaterial and recipe.entryPoint. For example, if - the recipe type were "make", then this might be the flags passed to - make aside from the target, which is captured in recipe.entryPoint. - Since the arguments field can greatly vary in structure, depending - on the builder and recipe type, this is of form "Any". - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + The Microsoft Knowledge Base article IDs that are associated with + the update. type: array - entryPoint: - description: >- - String identifying the entry point into the build. This is often a - path to a configuration file and/or a target label within that file. - The syntax and meaning are defined by recipe.type. For example, if - the recipe type were "make", then this would reference the directory - in which to run make as well as which target to use. - type: string - ComplianceVersion: + items: + type: string description: >- - Describes the CIS benchmark version that is applicable to a given OS and - os version. - id: ComplianceVersion + Windows Update represents the metadata about the update for the Windows + operating system. The fields in this message come from the Windows + Update API documented at + https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. + type: object + id: WindowsUpdate + GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: properties: - benchmarkDocument: - type: string - description: >- - The name of the document that defines this benchmark, e.g. "CIS - Container-Optimized OS". - version: + endTime: + format: google-datetime description: >- - The version of the benchmark. This is set to the version of the - OS-specific CIS document the benchmark is defined in. + Output only. The time that this operation was marked completed or + failed. type: string - cpeUri: - description: >- - The CPE URI (https://cpe.mitre.org/specification/) this benchmark is - applicable to. + createTime: type: string + format: google-datetime + description: Output only. The time this operation was created. type: object - Volume: + description: >- + Metadata for all operations used and required for all operations that + created by Container Analysis Providers + id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: type: object + description: >- + Location of the source manifest in Cloud Storage. This feature is in + Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest properties: - path: + generation: + format: int64 description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. + Cloud Storage generation for the object. If the generation is + omitted, the latest generation will be used. type: string - name: + bucket: + description: >- + Required. Cloud Storage bucket containing the source manifest (see + [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). type: string + object: description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. - description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. Next ID: 3 - id: Volume - SBOMStatus: + Required. Cloud Storage object containing the source manifest. This + object must be a JSON file. + type: string + SlsaBuilder: + id: SlsaBuilder type: object properties: - sbomState: - enumDescriptions: - - Default unknown state. - - SBOM scanning is pending. - - SBOM scanning has completed. - enum: - - SBOM_STATE_UNSPECIFIED - - PENDING - - COMPLETE - description: The progress of the SBOM generation. + id: type: string - error: + ComplianceOccurrence: + id: ComplianceOccurrence + type: object + description: >- + An indication that the compliance checks in the associated + ComplianceNote were not satisfied for particular resources or a + specified reason. + properties: + version: + description: The OS and config version the benchmark was run on. + $ref: '#/components/schemas/ComplianceVersion' + nonComplianceReason: type: string - description: >- - If there was an error generating an SBOM, this will indicate what - that error was. - id: SBOMStatus - description: The status of an SBOM generation. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + nonCompliantFiles: + type: array + items: + $ref: '#/components/schemas/NonCompliantFile' + GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder + properties: + id: + type: string + type: object description: >- - Details about how a build should be executed on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. + Identifies the entity that executed the recipe, which is trusted to have + correctly performed the operation and populated this provenance. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object properties: - name: + details: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array description: >- - The `WorkerPool` resource to execute the build on. You must have - `cloudbuild.workerpools.use` on the project hosting the WorkerPool. - Format - projects/{project}/locations/{location}/workerPools/{workerPoolId} + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string + code: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + SbomReferenceIntotoPredicate: type: object - UpgradeDistribution: - type: object - id: UpgradeDistribution properties: - cpeUri: + digest: + additionalProperties: + type: string + description: A map of algorithm to digest of the contents of the SBOM. + type: object + referrerId: type: string - description: >- - Required - The specific operating system this metadata applies to. - See https://cpe.mitre.org/specification/. - severity: + description: The person or system referring this predicate to the consumer. + mimeType: type: string - description: The severity as specified by the upstream operating system. - cve: + description: The mime type of the SBOM. + location: + type: string + description: The location of the SBOM. + description: A predicate which describes the SBOM being referenced. + id: SbomReferenceIntotoPredicate + ComplianceNote: + type: object + id: ComplianceNote + properties: + rationale: + type: string + description: A rationale for the existence of this compliance check. + version: items: - type: string + $ref: '#/components/schemas/ComplianceVersion' + description: The OS and config versions the benchmark applies to. type: array - description: The cve tied to this Upgrade. - classification: - description: >- - The operating system classification of this Upgrade, as specified by - the upstream operating system upgrade feed. For Windows the - classification is one of the category_ids listed at - https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) + description: + description: A description about this compliance check. type: string - description: >- - The Upgrade Distribution represents metadata about the Upgrade for each - operating system (CPE). Some distributions have additional metadata - around updates, classifying them into various categories and severities. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions - description: Optional arguments to enable specific features of builds. + scanInstructions: + type: string + format: byte + description: Serialized scan instructions with a predefined format. + remediation: + description: A description of remediation steps if the compliance check fails. + type: string + impact: + type: string + title: + description: The title that identifies this compliance check. + type: string + cisBenchmark: + $ref: '#/components/schemas/CisBenchmark' + GetIamPolicyRequest: properties: - secretEnv: - type: array + options: description: >- - A list of global environment variables, which are encrypted using a - Cloud Key Management Service crypto key. These values must be - specified in the build's `Secret`. These variables will be available - to all build steps in this build. - items: - type: string - substitutionOption: + OPTIONAL: A `GetPolicyOptions` object for specifying options to + `GetIamPolicy`. + $ref: '#/components/schemas/GetPolicyOptions' + description: Request message for `GetIamPolicy` method. + id: GetIamPolicyRequest + type: object + Layer: + type: object + id: Layer + description: Layer holds metadata specific to a layer of a Docker image. + properties: + arguments: + description: The recovered arguments to the Dockerfile directive. + type: string + directive: description: >- - Option to specify behavior when there is an error in the - substitution checks. NOTE: this is always set to ALLOW_LOOSE for - triggered builds and cannot be overridden in the build configuration - file. + Required. The recovered Dockerfile directive used to construct this + layer. See https://docs.docker.com/engine/reference/builder/ for + more information. + type: string + CisBenchmark: + properties: + profileLevel: + format: int32 + type: integer + severity: enum: - - MUST_MATCH - - ALLOW_LOOSE + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL enumDescriptions: - - >- - Fails the build if error in substitutions checks, like missing a - substitution in the template or in the map. - - Do not fail the build if error in substitutions checks. + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. type: string - automapSubstitutions: - type: boolean - description: >- - Option to include built-in and custom substitutions as env variables - for all build steps. - diskSizeGb: - format: int64 + id: CisBenchmark + type: object + description: A compliance check that is a CIS benchmark. + Detail: + type: object + description: >- + A detail for a distro and package affected by this vulnerability and its + associated fix (if one is available). + properties: + affectedPackage: + description: Required. The package this vulnerability affects. type: string + fixedVersion: description: >- - Requested disk size for the VM that runs the build. Note that this - is *NOT* "disk free"; some of the space will be used by the - operating system and build utilities. Also note that this is the - minimum disk size that will be allocated for the build -- the build - may run with a larger disk than requested. At present, the maximum - disk size is 4000GB; builds that request more than the maximum are - rejected with an error. - workerPool: - deprecated: true - type: string - description: This field deprecated; please use `pool.name` instead. - machineType: - enumDeprecated: - - false - - true - - true - - false - - false - - false - description: Compute Engine machine type on which to run the build. - enumDescriptions: - - Standard machine type. - - Highcpu machine with 8 CPUs. - - Highcpu machine with 32 CPUs. - - Highcpu e2 machine with 8 CPUs. - - Highcpu e2 machine with 32 CPUs. - - E2 machine with 1 CPU. - enum: - - UNSPECIFIED - - N1_HIGHCPU_8 - - N1_HIGHCPU_32 - - E2_HIGHCPU_8 - - E2_HIGHCPU_32 - - E2_MEDIUM - type: string - logging: - enumDeprecated: - - false - - false - - false - - true - - false - - false + The distro recommended version to update to that contains a fix for + this vulnerability. Setting this to VersionKind.MAXIMUM means no + such version is yet available. + $ref: '#/components/schemas/Version' + affectedVersionEnd: description: >- - Option to specify the logging mode, which determines if and where - build logs are stored. + The version number at the end of an interval in which this + vulnerability exists. A vulnerability can affect a package between + version numbers that are disjoint sets of intervals (example: + [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will + be represented in its own Detail. If a specific affected version is + provided by a vulnerability database, affected_version_start and + affected_version_end will be the same in that Detail. + $ref: '#/components/schemas/Version' + fixedPackage: type: string - enumDescriptions: - - >- - The service determines the logging mode. The default is `LEGACY`. - Do not rely on the default logging behavior as it may change in - the future. - - Build logs are stored in Cloud Logging and Cloud Storage. - - Build logs are stored in Cloud Storage. - - This option is the same as CLOUD_LOGGING_ONLY. - - >- - Build logs are stored in Cloud Logging. Selecting this option will - not allow [logs - streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log). - - Turn off all logging. No build logs will be captured. - enum: - - LOGGING_UNSPECIFIED - - LEGACY - - GCS_ONLY - - STACKDRIVER_ONLY - - CLOUD_LOGGING_ONLY - - NONE - dynamicSubstitutions: description: >- - Option to specify whether or not to apply bash style string - operations to the substitutions. NOTE: this is always enabled for - triggered builds and cannot be overridden in the build configuration - file. + The distro recommended package to update to that contains a fix for + this vulnerability. It is possible for this to be different from the + affected_package. + isObsolete: + description: >- + Whether this detail is obsolete. Occurrences are expected not to + point to obsolete details. type: boolean - logStreamingOption: - enum: - - STREAM_DEFAULT - - STREAM_ON - - STREAM_OFF - enumDescriptions: - - Service may automatically determine build log streaming behavior. - - Build logs should be streamed to Cloud Storage. - - >- - Build logs should not be streamed to Cloud Storage; they will be - written when the build is completed. - description: Option to define build log streaming behavior to Cloud Storage. + source: + description: The source from which the information in this Detail was obtained. + type: string + packageType: type: string - env: description: >- - A list of global environment variable definitions that will exist - for all build steps in this build. If a variable is defined in both - globally and in a build step, the variable will use the build step - value. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - type: array - items: - type: string - sourceProvenanceHash: - items: - enum: - - NONE - - SHA256 - - MD5 - - SHA512 - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. - type: string - type: array - description: Requested hash for SourceProvenance. - requestedVerifyOption: + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + affectedCpeUri: type: string - description: Requested verifiability options. - enumDescriptions: - - Not a verifiable build (the default). - - Build must be verified. - enum: - - NOT_VERIFIED - - VERIFIED - pool: description: >- - Optional. Specification for execution on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption - defaultLogsBucketBehavior: - enumDescriptions: - - Unspecified. - - >- - Bucket is located in user-owned project in the same region as the - build. The builder service account must have access to create and - write to Cloud Storage buckets in the build project. + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. + severityName: type: string - description: Optional. Option to specify how default logs buckets are setup. - enum: - - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED - - REGIONAL_USER_OWNED_BUCKET - volumes: + description: The distro assigned severity of this vulnerability. + description: + description: A vendor-specific description of this vulnerability. + type: string + affectedVersionStart: + $ref: '#/components/schemas/Version' description: >- - Global list of volumes to mount for ALL build steps Each volume is - created as an empty volume prior to starting the build process. Upon - completion of the build, volumes and their contents are discarded. - Global volume names and paths cannot conflict with the volumes - defined a build step. Using a global volume in a build with only one - step is not valid as it is indicative of a build request with an - incorrect configuration. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - type: array - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: - description: HttpConfig is a configuration for HTTP related git operations. - type: object - properties: - proxySecretVersionName: + The version number at the start of an interval in which this + vulnerability exists. A vulnerability can affect a package between + version numbers that are disjoint sets of intervals (example: + [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will + be represented in its own Detail. If a specific affected version is + provided by a vulnerability database, affected_version_start and + affected_version_end will be the same in that Detail. + vendor: type: string + description: The name of the vendor of the product. + sourceUpdateTime: + format: google-datetime description: >- - SecretVersion resource of the HTTP proxy URL. The Service Account - used in the build (either the default Service Account or - user-specified Service Account) should have - `secretmanager.versions.access` permissions on this secret. The - proxy URL should be in format `protocol://@]proxyhost[:port]`. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - FixableTotalByDigest: - properties: - totalCount: - description: The total number of vulnerabilities associated with this resource. + The time this information was last changed at the source. This is an + upstream timestamp from the underlying information source - e.g. + Ubuntu security tracker. type: string - format: int64 - resourceUri: + fixedCpeUri: type: string - description: The affected resource. - fixableCount: - format: int64 + description: >- + The distro recommended [CPE + URI](https://cpe.mitre.org/specification/) to update to that + contains a fix for this vulnerability. It is possible for this to be + different from the affected_cpe_uri. + id: Detail + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: + description: Location of the source in an archive file in Cloud Storage. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + properties: + object: + description: >- + Required. Cloud Storage object containing the source. This object + must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) + containing source to build. type: string - description: The number of fixable vulnerabilities associated with this resource. - severity: + sourceFetcher: description: >- - The severity for this count. SEVERITY_UNSPECIFIED indicates total - across all severities. + Optional. Option to specify the tool to fetch the source file for + the build. type: string enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + - SOURCE_FETCHER_UNSPECIFIED + - GSUTIL + - GCS_FETCHER enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - id: FixableTotalByDigest - type: object - description: Per resource and severity counts of fixable and total vulnerabilities. - GerritSourceContext: - properties: - revisionId: - type: string - description: A revision (commit) ID. - gerritProject: - type: string - description: >- - The full project name within the host. Projects may be nested, so - "project/subproject" is a valid project name. The "repo name" is the - hostURI/project. - hostUri: - description: The URI of a running Gerrit instance. - type: string - aliasContext: - description: An alias, which may be a branch or tag. - $ref: '#/components/schemas/AliasContext' - description: A SourceContext referring to a Gerrit project. - type: object - id: GerritSourceContext - TestIamPermissionsResponse: - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string - type: object - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - TimeSpan: - properties: - startTime: - format: google-datetime - description: Start of time span. - type: string - endTime: - format: google-datetime - type: string - description: End of time span. - id: TimeSpan - type: object - description: 'Start and end times for a build execution phase. Next ID: 3' - BatchCreateOccurrencesResponse: - id: BatchCreateOccurrencesResponse - type: object - description: Response for creating occurrences in batch. - properties: - occurrences: - items: - $ref: '#/components/schemas/Occurrence' - type: array - description: The occurrences that were created. - BatchCreateNotesRequest: - id: BatchCreateNotesRequest - properties: - notes: - type: object - additionalProperties: - $ref: '#/components/schemas/Note' - description: Required. The notes to create. Max allowed length is 1000. - type: object - description: Request to create notes in batch. - ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: - description: Secrets and secret environment variables. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - type: object - properties: - inline: - description: >- - Secrets encrypted with KMS key and the associated secret environment - variable. - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret - secretManager: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret + - Unspecified defaults to GSUTIL. + - Use the "gsutil" tool to download the source file. + - Use the Cloud Storage Fetcher tool to download the source file. + generation: description: >- - Secrets in Secret Manager and associated secret environment - variable. - type: array - Envelope: - properties: - signatures: - type: array - items: - $ref: '#/components/schemas/EnvelopeSignature' - payload: - format: byte - type: string - payloadType: + Optional. Cloud Storage generation for the object. If the generation + is omitted, the latest generation will be used. type: string - id: Envelope - type: object - description: >- - MUST match - https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. - An authenticated message of arbitrary type. - GetPolicyOptions: - properties: - requestedPolicyVersion: - format: int32 - type: integer - 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). - description: Encapsulates settings provided to GetIamPolicy. - type: object - id: GetPolicyOptions - AttestationOccurrence: - description: >- - Occurrence that represents a single "attestation". The authenticity of - an attestation can be verified using the attached signature. If the - verifier trusts the public key of the signer, then verifying the - signature is sufficient to establish trust. In this circumstance, the - authority to which this attestation is attached is primarily useful for - lookup (how to find this attestation if you already know the authority - and artifact to be verified) and intent (for which authority this - attestation was intended to sign. - type: object - id: AttestationOccurrence - properties: - jwts: - items: - $ref: '#/components/schemas/Jwt' - type: array - description: >- - One or more JWTs encoding a self-contained attestation. Each JWT - encodes the payload that it verifies within the JWT itself. Verifier - implementation SHOULD ignore the `serialized_payload` field when - verifying these JWTs. If only JWTs are present on this - AttestationOccurrence, then the `serialized_payload` SHOULD be left - empty. Each JWT SHOULD encode a claim specific to the `resource_uri` - of this Occurrence, but this is not validated by Grafeas metadata - API implementations. The JWT itself is opaque to Grafeas. - signatures: - description: >- - One or more signatures over `serialized_payload`. Verifier - implementations should consider this attestation message verified if - at least one `signature` verifies `serialized_payload`. See - `Signature` in common.proto for more details on signature structure - and verification. - type: array - items: - $ref: '#/components/schemas/Signature' - serializedPayload: - description: >- - Required. The serialized payload that is verified by one or more - `signatures`. + format: int64 + bucket: type: string - format: byte - AnalysisCompleted: - id: AnalysisCompleted - properties: - analysisType: - type: array - items: - type: string - description: >- - Indicates which analysis completed successfully. Multiple types of - analysis can be performed on a single resource. - type: object - WindowsUpdate: - properties: - identity: - description: Required - The unique identifier for the update. - $ref: '#/components/schemas/Identity' - kbArticleIds: - type: array - items: - type: string description: >- - The Microsoft Knowledge Base article IDs that are associated with - the update. - title: - description: The localized title of the update. - type: string - description: - type: string - description: The localized description of the update. - supportUrl: - description: The hyperlink to the support information for the update. - type: string - categories: - items: - $ref: '#/components/schemas/Category' - description: The list of categories to which the update belongs. - type: array - lastPublishedTimestamp: - description: The last published timestamp of the update. - format: google-datetime - type: string + Cloud Storage bucket containing the source (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). type: object - description: >- - Windows Update represents the metadata about the update for the Windows - operating system. The fields in this message come from the Windows - Update API documented at - https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. - id: WindowsUpdate SlsaCompleteness: - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - id: SlsaCompleteness type: object properties: - environment: - description: >- - If true, the builder claims that recipe.environment is claimed to be - complete. - type: boolean arguments: type: boolean description: >- @@ -1081,46 +830,206 @@ components: If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". - Hint: - properties: - humanReadableName: - type: string + environment: + type: boolean description: >- - Required. The human readable name of this attestation authority, for - example "qa". - type: object - id: Hint + If true, the builder claims that recipe.environment is claimed to be + complete. description: >- - This submessage provides human-readable hints about the purpose of the - authority. Because the name of a note acts as its resource reference, it - is important to disambiguate the canonical name of the Note (which might - be a UUID for security purposes) from "readable" names more suitable for - debug output. Note that these hints should not be used to look up - authorities in security sensitive contexts, such as when looking up - attestations to verify. - SlsaRecipe: - id: SlsaRecipe - type: object + Indicates that the builder claims certain fields in this message to be + complete. + id: SlsaCompleteness + ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: properties: type: type: string - description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. - arguments: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + description: The type of hash that was performed. + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Use a sha512 hash. + enum: + - NONE + - SHA256 + - MD5 + - SHA512 + value: + format: byte + description: The hash value. + type: string + description: Container message for hash values. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + type: object + ListNoteOccurrencesResponse: + id: ListNoteOccurrencesResponse + description: Response for listing occurrences for a note. + properties: + nextPageToken: + type: string + description: Token to provide to skip to a particular spot in the list. + occurrences: + items: + $ref: '#/components/schemas/Occurrence' + description: The occurrences attached to the specified note. + type: array + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1Source: + properties: + developerConnectConfig: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + description: If provided, get the source from this Developer Connect config. + connectedRepository: + description: >- + Optional. If provided, get the source from this 2nd-gen Google Cloud + Build repository resource. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + gitSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + description: If provided, get the source from this Git repository. + repoSource: + description: >- + If provided, get the source from this location in a Cloud Source + Repository. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + storageSourceManifest: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + description: >- + If provided, get the source from this manifest in Cloud Storage. + This feature is in Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + storageSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + description: If provided, get the source from this location in Cloud Storage. + type: object + description: Location of the source in a supported storage service. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source + Occurrence: + properties: + noteName: + type: string + description: >- + Required. Immutable. The analysis note associated with this + occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + This field can be used as a filter in list requests. + kind: + enumDescriptions: + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + description: >- + Output only. This explicitly denotes which of the occurrence details + are specified. This field can be used as a filter in list requests. + type: string + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE + sbomReference: + $ref: '#/components/schemas/SBOMReferenceOccurrence' + description: Describes a specific SBOM reference occurrences. + discovery: + $ref: '#/components/schemas/DiscoveryOccurrence' + description: Describes when a resource was discovered. + attestation: + $ref: '#/components/schemas/AttestationOccurrence' + description: Describes an attestation of an artifact. + dsseAttestation: + description: Describes an attestation of an artifact using dsse. + $ref: '#/components/schemas/DSSEAttestationOccurrence' + vulnerability: + $ref: '#/components/schemas/VulnerabilityOccurrence' + description: Describes a security vulnerability. + image: + $ref: '#/components/schemas/ImageOccurrence' + description: >- + Describes how this resource derives from the basis in the associated + note. + envelope: + description: https://github.com/secure-systems-lab/dsse + $ref: '#/components/schemas/Envelope' + name: + description: >- + Output only. The name of the occurrence in the form of + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + type: string + createTime: + format: google-datetime + description: Output only. The time this occurrence was created. + type: string + compliance: + $ref: '#/components/schemas/ComplianceOccurrence' + description: Describes a compliance violation on a linked resource. + upgrade: + $ref: '#/components/schemas/UpgradeOccurrence' + description: Describes an available package upgrade on the linked resource. + package: + $ref: '#/components/schemas/PackageOccurrence' + description: Describes the installation of a package on the linked resource. + deployment: + $ref: '#/components/schemas/DeploymentOccurrence' + description: Describes the deployment of an artifact on a runtime. + updateTime: + type: string + description: Output only. The time this occurrence was last updated. + format: google-datetime + build: + description: Describes a verifiable build. + $ref: '#/components/schemas/BuildOccurrence' + resourceUri: + description: >- + Required. Immutable. A URI that represents the resource for which + the occurrence applies. For example, + `https://gcr.io/project/image@sha256:123abc` for a Docker image. + type: string + remediation: + description: A description of actions that can be taken to remedy the note. + type: string + description: An instance of an analysis type that has been found on a resource. + id: Occurrence + type: object + SlsaRecipe: + properties: + arguments: description: >- Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any definedInMaterial: - format: int64 description: >- Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then @@ -1128,1012 +1037,962 @@ components: program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. type: string + format: int64 + environment: + type: object + description: >- + Any other builder-controlled inputs necessary for correctly + evaluating the recipe. Usually only needed for reproducing the build + but not evaluated as part of policy. Depending on the recipe Type, + the structure may be different. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: + type: string + description: >- + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. entryPoint: + type: string description: >- String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. - type: string - environment: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Any other builder-controlled inputs necessary for correctly - evaluating the recipe. Usually only needed for reproducing the build - but not evaluated as part of policy. Depending on the recipe Type, - the structure may be different. - type: object description: >- Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. - Subject: - id: Subject + id: SlsaRecipe + type: object + GrafeasV1FileLocation: properties: - name: - type: string - digest: - type: object + filePath: description: >- - `"": ""` Algorithms can be e.g. sha256, sha512 See - https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet - additionalProperties: - type: string - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: - description: >- - Location of the source manifest in Cloud Storage. This feature is in - Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + For jars that are contained inside .war files, this filepath can + indicate the path to war file combined with the path to jar file. + type: string + id: GrafeasV1FileLocation type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + description: Indicates the location at which a package was found. + KnowledgeBase: + id: KnowledgeBase properties: - object: + url: description: >- - Required. Cloud Storage object containing the source manifest. This - object must be a JSON file. + A link to the KB in the [Windows update catalog] + (https://www.catalog.update.microsoft.com/). type: string - generation: - format: int64 - description: >- - Cloud Storage generation for the object. If the generation is - omitted, the latest generation will be used. + name: type: string - bucket: - description: >- - Required. Cloud Storage bucket containing the source manifest (see - [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - type: string - EnvelopeSignature: - id: EnvelopeSignature + description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). type: object + BuildDefinition: properties: - sig: - type: string - format: byte - keyid: + buildType: type: string - InTotoProvenance: - type: object - properties: - materials: + externalParameters: + additionalProperties: + description: Properties of the object. + type: any + type: object + resolvedDependencies: items: - type: string - description: >- - The collection of artifacts that influenced the build including - sources, dependencies, build tools, base images, and so on. This is - considered to be incomplete unless metadata.completeness.materials - is true. Unset or null is equivalent to empty. + $ref: '#/components/schemas/ResourceDescriptor' type: array - metadata: - $ref: '#/components/schemas/Metadata' + internalParameters: + type: object + additionalProperties: + type: any + description: Properties of the object. + id: BuildDefinition + type: object + InTotoProvenance: + properties: builderConfig: - description: required $ref: '#/components/schemas/BuilderConfig' + description: required recipe: - $ref: '#/components/schemas/Recipe' description: >- Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required + $ref: '#/components/schemas/Recipe' + metadata: + $ref: '#/components/schemas/Metadata' + materials: + description: >- + The collection of artifacts that influenced the build including + sources, dependencies, build tools, base images, and so on. This is + considered to be incomplete unless metadata.completeness.materials + is true. Unset or null is equivalent to empty. + items: + type: string + type: array id: InTotoProvenance - Publisher: - description: Publisher contains information about the publisher of this Note. - id: Publisher type: object + DiscoveryNote: + description: >- + A note that indicates a type of analysis a provider would perform. This + note exists in a provider's project. A `Discovery` occurrence is created + in a consumer's project at the start of analysis. properties: - issuingAuthority: + analysisKind: + enumDescriptions: + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE description: >- - Provides information about the authority of the issuing party to - release the document, in particular, the party's constituency and - responsibilities or other obligations. - type: string - name: - description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' - type: string - publisherNamespace: + Required. Immutable. The kind of analysis that is handled by this + discovery. type: string - description: >- - The context or namespace. Contains a URL which is under control of - the issuing party and can be used as a globally unique identifier - for that issuing party. Example: https://csaf.io - DeploymentOccurrence: - description: The period during which some deployable was active in a runtime. + type: object + id: DiscoveryNote + BuildMetadata: properties: - address: - description: Address of the runtime element hosting this deployment. - type: string - platform: - enumDescriptions: - - Unknown. - - Google Container Engine. - - 'Google App Engine: Flexible Environment.' - - Custom user-defined platform. - enum: - - PLATFORM_UNSPECIFIED - - GKE - - FLEX - - CUSTOM - description: Platform hosting this deployment. + finishedOn: type: string - undeployTime: + format: google-datetime + startedOn: format: google-datetime type: string - description: End of the lifetime of this deployment. - config: + invocationId: type: string - description: Configuration used to create this deployment. - resourceUri: - description: >- - Output only. Resource URI for the artifact being deployed taken from - the deployable field with the same name. - items: - type: string - type: array - deployTime: - description: Required. Beginning of the lifetime of this deployment. + id: BuildMetadata + type: object + TimeSpan: + properties: + endTime: type: string + description: End of time span. + format: google-datetime + startTime: format: google-datetime - userEmail: type: string - description: Identity of the user that triggered this deployment. + description: Start of time span. + id: TimeSpan + description: 'Start and end times for a build execution phase. Next ID: 3' type: object - id: DeploymentOccurrence - SlsaMetadata: + License: type: object - id: SlsaMetadata - description: Other properties of the build. properties: - buildFinishedOn: - description: The timestamp of when the build completed. + comments: + type: string + description: Comments + expression: type: string - format: google-datetime - completeness: description: >- - Indicates that the builder claims certain fields in this message to - be complete. - $ref: '#/components/schemas/SlsaCompleteness' - reproducible: + Often a single license can be used to represent the licensing terms. + Sometimes it is necessary to include a choice of one or more + licenses or some combination of license identifiers. Examples: + "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later + WITH Bison-exception-2.2". + description: License information. + id: License + VexAssessment: + properties: + impacts: + type: array description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. - type: boolean - buildStartedOn: - format: google-datetime + Contains information about the impact of this vulnerability, this + will change with time. + items: + type: string + relatedUris: + type: array + description: >- + Holds a list of references associated with this vulnerability item + and assessment. + items: + $ref: '#/components/schemas/RelatedUrl' + remediations: + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. + type: array + items: + $ref: '#/components/schemas/Remediation' + noteName: + description: >- + The VulnerabilityAssessment note from which this VexAssessment was + generated. This will be of the form: + `projects/[PROJECT_ID]/notes/[NOTE_ID]`. type: string - description: The timestamp of when the build started. - buildInvocationId: + justification: + $ref: '#/components/schemas/Justification' description: >- - Identifies the particular build invocation, which can be useful for - finding associated logs or other ad-hoc analysis. The value SHOULD - be globally unique, per in-toto Provenance spec. + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + vulnerabilityId: + description: >- + The vulnerability identifier for this Assessment. Will hold one of + common identifiers e.g. CVE, GHSA etc. type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo - description: A fatal problem encountered during the execution of the build. - properties: - detail: + cve: + description: >- + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. type: string - description: Explains the failure issue in more detail using hard-coded text. - type: + deprecated: true + state: type: string + description: Provides the state of this Vulnerability assessment. enum: - - FAILURE_TYPE_UNSPECIFIED - - PUSH_FAILED - - PUSH_IMAGE_NOT_FOUND - - PUSH_NOT_AUTHORIZED - - LOGGING_FAILURE - - USER_BUILD_STEP - - FETCH_SOURCE_FAILED - description: The name of the failure. + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION enumDescriptions: - - Type unspecified - - Unable to push the image to the repository. - - Final image not found. - - Unauthorized push of the final image. - - Backend logging failures. Should retry. - - A build step has failed. - - The source fetching has failed. + - No state is specified. + - This product is known to be affected by this vulnerability. + - This product is known to be not affected by this vulnerability. + - This product contains a fix for this vulnerability. + - >- + It is not known yet whether these versions are or are not affected + by the vulnerability. However, it is still under investigation. type: object - SlsaBuilder: - properties: - id: - type: string - id: SlsaBuilder + id: VexAssessment + description: >- + VexAssessment provides all publisher provided Vex information that is + related to this vulnerability. + BuildProvenance: type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: + description: >- + Provenance of a build. Contains all information needed to verify the + full details about the build from source to completion. + id: BuildProvenance properties: - kmsKeyName: + createTime: + format: google-datetime type: string - description: Cloud KMS key name to use to decrypt these envs. - secretEnv: - description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. - type: object + description: Time at which the build was created. + projectId: + type: string + description: ID of the project. + commands: + items: + $ref: '#/components/schemas/Command' + type: array + description: Commands requested by the build. + buildOptions: additionalProperties: type: string - format: byte - description: >- - Pairs a set of secret environment variables containing encrypted values - with the Cloud KMS key to use to decrypt the value. Note: Use - `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with - `secret`. For instructions see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secret - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: - properties: - approvalRequired: - type: boolean - description: >- - Whether or not approval is needed. If this is set on a build, it - will become pending when created, and will need to be explicitly - approved to start. - description: ApprovalConfig describes configuration for manual approval of a build. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - type: object - GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: - properties: - configSource: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' - parameters: - additionalProperties: - description: Properties of the object. - type: any - type: object - environment: - additionalProperties: - description: Properties of the object. - type: any type: object - description: Identifies the event that kicked off the build. - id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation - type: object - VulnerabilityAssessmentNote: - type: object - properties: - shortDescription: - description: A one sentence description of this Vex. + description: >- + Special options applied to this build. This is a catch-all field + where build providers can enter any desired additional details. + builtArtifacts: + type: array + description: Output of the build. + items: + $ref: '#/components/schemas/Artifact' + id: type: string - publisher: - $ref: '#/components/schemas/Publisher' - description: Publisher details of this Note. - longDescription: - description: A detailed description of this Vex. + description: Required. Unique identifier of the build. + startTime: type: string - languageCode: + description: Time at which execution of the build was started. + format: google-datetime + endTime: + format: google-datetime + description: Time at which execution of the build was finished. + type: string + creator: description: >- - Identifies the language used by this document, corresponding to IETF - BCP 47 / RFC 5646. + E-mail address of the user who initiated this build. Note that this + was the user's e-mail address at the time the build was initiated; + this address may not represent the same end-user for all time. type: string - title: - description: The title of the note. E.g. `Vex-Debian-11.4` + logsUri: + description: URI where any logs for this provenance were written. type: string - product: - description: The product affected by this vex. - $ref: '#/components/schemas/Product' - assessment: - description: Represents a vulnerability assessment for the product. - $ref: '#/components/schemas/Assessment' - description: >- - A single VulnerabilityAssessmentNote represents one particular product's - vulnerability assessment for one CVE. - id: VulnerabilityAssessmentNote - ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - type: object - properties: - fileHash: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash - description: Collection of file hashes. - type: array - description: >- - Container message for hashes of byte content of files, used in - SourceProvenance messages to verify integrity of source input to the - build. - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - properties: - packagePath: + builderVersion: type: string - description: Path to the package.json. e.g. workspace/path/to/package - repository: + description: Version string of the builder at the time this build was executed. + triggerId: type: string description: >- - Artifact Registry repository, in the form - "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in - the workspace specified by path will be zipped and uploaded to - Artifact Registry with this location as a prefix. - type: object - description: >- - Npm package to upload to Artifact Registry upon successful completion of - all build steps. - ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: + Trigger identifier if the build was triggered automatically; empty + if not. + sourceProvenance: + $ref: '#/components/schemas/Source' + description: Details of the Source input to the build. + ComplianceVersion: properties: - name: + cpeUri: + type: string description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. + The CPE URI (https://cpe.mitre.org/specification/) this benchmark is + applicable to. + benchmarkDocument: type: string - path: description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. + The name of the document that defines this benchmark, e.g. "CIS + Container-Optimized OS". + version: type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - type: object + description: >- + The version of the benchmark. This is set to the version of the + OS-specific CIS document the benchmark is defined in. description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. - ListOccurrencesResponse: - id: ListOccurrencesResponse - description: Response for listing occurrences. + Describes the CIS benchmark version that is applicable to a given OS and + os version. type: object + id: ComplianceVersion + AliasContext: + type: object + description: An alias to a repo revision. + id: AliasContext properties: - occurrences: - items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences requested. - type: array - nextPageToken: + kind: + enum: + - KIND_UNSPECIFIED + - FIXED + - MOVABLE + - OTHER + enumDescriptions: + - Unknown. + - Git tag. + - Git branch. + - >- + Used to specify non-standard aliases. For example, if a Git repo + has a ref named "refs/foo/bar". type: string - description: >- - The next pagination token in the list response. It should be used as - `page_token` for the following request. An empty value means no more - results. - CisBenchmark: - id: CisBenchmark + description: The alias kind. + name: + type: string + description: The alias name. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: + description: Optional arguments to enable specific features of builds. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions type: object - description: A compliance check that is a CIS benchmark. properties: - severity: + requestedVerifyOption: type: string + description: Requested verifiability options. enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + - Not a verifiable build (the default). + - Build must be verified. enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - profileLevel: - type: integer - format: int32 - BuildMetadata: - id: BuildMetadata - type: object - properties: - startedOn: - format: google-datetime - type: string - invocationId: - type: string - finishedOn: - type: string - format: google-datetime - Metadata: - id: Metadata - properties: - buildInvocationId: - type: string - description: >- - Identifies the particular build invocation, which can be useful for - finding associated logs or other ad-hoc analysis. The value SHOULD - be globally unique, per in-toto Provenance spec. - buildStartedOn: - description: The timestamp of when the build started. - type: string - format: google-datetime - buildFinishedOn: - description: The timestamp of when the build completed. - format: google-datetime + - NOT_VERIFIED + - VERIFIED + diskSizeGb: type: string - reproducible: description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. + Requested disk size for the VM that runs the build. Note that this + is *NOT* "disk free"; some of the space will be used by the + operating system and build utilities. Also note that this is the + minimum disk size that will be allocated for the build -- the build + may run with a larger disk than requested. At present, the maximum + disk size is 4000GB; builds that request more than the maximum are + rejected with an error. + format: int64 + dynamicSubstitutions: type: boolean - completeness: - $ref: '#/components/schemas/Completeness' description: >- - Indicates that the builder claims certain fields in this message to - be complete. - description: Other properties of the build. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - type: object - description: >- - ApprovalResult describes the decision and associated metadata of a - manual approval of a build. - properties: - approvalTime: - readOnly: true - description: Output only. The time when the approval decision was made. - format: google-datetime - type: string - decision: - type: string + Option to specify whether or not to apply bash style string + operations to the substitutions. NOTE: this is always enabled for + triggered builds and cannot be overridden in the build configuration + file. + pool: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + description: >- + Optional. Specification for execution on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. + secretEnv: + description: >- + A list of global environment variables, which are encrypted using a + Cloud Key Management Service crypto key. These values must be + specified in the build's `Secret`. These variables will be available + to all build steps in this build. + type: array + items: + type: string + machineType: enumDescriptions: - - Default enum type. This should not be used. - - Build is approved. - - Build is rejected. + - Standard machine type. + - Highcpu machine with 8 CPUs. + - Highcpu machine with 32 CPUs. + - Highcpu e2 machine with 8 CPUs. + - Highcpu e2 machine with 32 CPUs. + - E2 machine with 1 CPU. + description: Compute Engine machine type on which to run the build. + enumDeprecated: + - false + - true + - true + - false + - false + - false enum: - - DECISION_UNSPECIFIED - - APPROVED - - REJECTED - description: Required. The decision of this manual approval. - comment: + - UNSPECIFIED + - N1_HIGHCPU_8 + - N1_HIGHCPU_32 + - E2_HIGHCPU_8 + - E2_HIGHCPU_32 + - E2_MEDIUM type: string - description: Optional. An optional comment for this manual approval result. - url: + defaultLogsBucketBehavior: + description: Optional. Option to specify how default logs buckets are setup. + enum: + - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED + - REGIONAL_USER_OWNED_BUCKET type: string - description: >- - Optional. An optional URL tied to this manual approval result. This - field is essentially the same as comment, except that it will be - rendered by the UI differently. An example use case is a link to an - external job that approved this Build. - approverAccount: + enumDescriptions: + - Unspecified. + - >- + Bucket is located in user-owned project in the same region as the + build. The builder service account must have access to create and + write to Cloud Storage buckets in the build project. + logStreamingOption: + description: Option to define build log streaming behavior to Cloud Storage. + enumDescriptions: + - Service may automatically determine build log streaming behavior. + - Build logs should be streamed to Cloud Storage. + - >- + Build logs should not be streamed to Cloud Storage; they will be + written when the build is completed. + enum: + - STREAM_DEFAULT + - STREAM_ON + - STREAM_OFF type: string - description: >- - Output only. Email of the user that called the ApproveBuild API to - approve or reject a build at the time that the API was called. - readOnly: true - Command: - description: Command describes a step performed as part of the build pipeline. - type: object - properties: - dir: + workerPool: + description: This field deprecated; please use `pool.name` instead. + deprecated: true type: string - description: >- - Working directory (relative to project source root) used when - running this command. env: - items: - type: string type: array - description: Environment variables set before running this command. - waitFor: items: type: string - description: The ID(s) of the command(s) that this command depends on. - type: array - name: description: >- - Required. Name of the command, as presented on the command line, or - if the command is packaged as a Docker container, as presented to - `docker pull`. - type: string - args: - description: Command-line arguments used when executing this command. + A list of global environment variable definitions that will exist + for all build steps in this build. If a variable is defined in both + globally and in a build step, the variable will use the build step + value. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + sourceProvenanceHash: items: + enum: + - NONE + - SHA256 + - MD5 + - SHA512 + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Use a sha512 hash. type: string type: array - id: - description: >- - Optional unique identifier for this command, used in wait_for to - reference this command as a dependency. - type: string - id: Command - GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: - type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - properties: - materials: - type: boolean - environment: - type: boolean - parameters: + description: Requested hash for SourceProvenance. + automapSubstitutions: type: boolean - UpgradeOccurrence: - description: >- - An Upgrade Occurrence represents that a specific resource_url could - install a specific upgrade. This presence is supplied via local sources - (i.e. it is present in the mirror and the running system has noticed its - availability). For Windows, both distribution and windows_update contain - information for the Windows update. - id: UpgradeOccurrence - type: object - properties: - distribution: - $ref: '#/components/schemas/UpgradeDistribution' - description: >- - Metadata about the upgrade for available for the specific operating - system for the resource_url. This allows efficient filtering, as - well as making it easier to use the occurrence. - package: - description: Required for non-Windows OS. The package this Upgrade is for. - type: string - windowsUpdate: description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - $ref: '#/components/schemas/WindowsUpdate' - parsedVersion: + Option to include built-in and custom substitutions as env variables + for all build steps. + substitutionOption: description: >- - Required for non-Windows OS. The version of the package in a machine - + human readable form. - $ref: '#/components/schemas/Version' - CVSSv3: - id: CVSSv3 - properties: - baseScore: - description: The base score is a function of the base metric scores. - type: number - format: float - privilegesRequired: - type: string + Option to specify behavior when there is an error in the + substitution checks. NOTE: this is always set to ALLOW_LOOSE for + triggered builds and cannot be overridden in the build configuration + file. enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH - confidentialityImpact: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - userInteraction: + - >- + Fails the build if error in substitutions checks, like missing a + substitution in the template or in the map. + - Do not fail the build if error in substitutions checks. enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - enumDescriptions: - - '' - - '' - - '' + - MUST_MATCH + - ALLOW_LOOSE type: string - exploitabilityScore: - format: float - type: number - scope: + logging: + enumDeprecated: + - false + - false + - false + - true + - false + - false enumDescriptions: - - '' - - '' - - '' + - >- + The service determines the logging mode. The default is `LEGACY`. + Do not rely on the default logging behavior as it may change in + the future. + - Build logs are stored in Cloud Logging and Cloud Storage. + - Build logs are stored in Cloud Storage. + - This option is the same as CLOUD_LOGGING_ONLY. + - >- + Build logs are stored in Cloud Logging. Selecting this option will + not allow [logs + streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log). + - Turn off all logging. No build logs will be captured. type: string + description: >- + Option to specify the logging mode, which determines if and where + build logs are stored. enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED - availabilityImpact: + - LOGGING_UNSPECIFIED + - LEGACY + - GCS_ONLY + - STACKDRIVER_ONLY + - CLOUD_LOGGING_ONLY + - NONE + volumes: + description: >- + Global list of volumes to mount for ALL build steps Each volume is + created as an empty volume prior to starting the build process. Upon + completion of the build, volumes and their contents are discarded. + Global volume names and paths cannot conflict with the volumes + defined a build step. Using a global volume in a build with only one + step is not valid as it is indicative of a build request with an + incorrect configuration. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + Publisher: + properties: + name: type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - attackVector: + description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' + publisherNamespace: description: >- - Base Metrics Represents the intrinsic characteristics of a - vulnerability that are constant over time and across user - environments. - enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL + The context or namespace. Contains a URL which is under control of + the issuing party and can be used as a globally unique identifier + for that issuing party. Example: https://csaf.io type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - impactScore: - format: float - type: number - integrityImpact: + issuingAuthority: + description: >- + Provides information about the authority of the issuing party to + release the document, in particular, the party's constituency and + responsibilities or other obligations. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - attackComplexity: - enumDescriptions: - - '' - - '' - - '' - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH + description: Publisher contains information about the publisher of this Note. + id: Publisher + type: object + GerritSourceContext: + properties: + aliasContext: + description: An alias, which may be a branch or tag. + $ref: '#/components/schemas/AliasContext' + gerritProject: + type: string + description: >- + The full project name within the host. Projects may be nested, so + "project/subproject" is a valid project name. The "repo name" is the + hostURI/project. + revisionId: + description: A revision (commit) ID. + type: string + hostUri: + description: The URI of a running Gerrit instance. type: string + description: A SourceContext referring to a Gerrit project. type: object - description: >- - Common Vulnerability Scoring System version 3. For details, see - https://www.first.org/cvss/specification-document - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + id: GerritSourceContext + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep + description: A step in the build pipeline. properties: - etag: + volumes: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + type: array description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon + completion of the build, volumes and their contents are discarded. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + secretEnv: + type: array + description: >- + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. + items: + type: string + id: type: string - format: byte - bindings: + description: >- + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. + env: type: array items: - $ref: '#/components/schemas/Binding' + type: string description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - version: - description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - format: int32 - Category: - description: The category to which the update belongs. - type: object - id: Category - properties: - name: - type: string - description: The localized name of the category. - categoryId: - description: The identifier of the category. - type: string - BuildProvenance: - type: object - description: >- - Provenance of a build. Contains all information needed to verify the - full details about the build from source to completion. - id: BuildProvenance - properties: - logsUri: - description: URI where any logs for this provenance were written. + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + script: type: string - creator: description: >- - E-mail address of the user who initiated this build. Note that this - was the user's e-mail address at the time the build was initiated; - this address may not represent the same end-user for all time. - type: string - sourceProvenance: - $ref: '#/components/schemas/Source' - description: Details of the Source input to the build. - startTime: - type: string - description: Time at which execution of the build was started. - format: google-datetime - endTime: - description: Time at which execution of the build was finished. - type: string - format: google-datetime - projectId: + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. + status: + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + enumDescriptions: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. + readOnly: true type: string - description: ID of the project. - builderVersion: - description: Version string of the builder at the time this build was executed. + description: >- + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. + waitFor: + items: + type: string + description: >- + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. + type: array + entrypoint: type: string - id: + description: >- + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. + timeout: type: string - description: Required. Unique identifier of the build. - createTime: - format: google-datetime - description: Time at which the build was created. + format: google-duration + description: >- + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. + automapSubstitutions: + type: boolean + description: >- + Option to include built-in and custom substitutions as env variables + for this build step. This option will override the global option in + BuildOption. + allowFailure: + type: boolean + description: >- + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. + timing: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true + description: >- + Output only. Stores timing information for executing this build + step. + name: type: string - buildOptions: - type: object - additionalProperties: - type: string description: >- - Special options applied to this build. This is a catch-all field - where build providers can enter any desired additional details. - triggerId: + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. + dir: + description: >- + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. type: string + exitCode: + format: int32 + readOnly: true + description: Output only. Return code from running the step. + type: integer + args: description: >- - Trigger identifier if the build was triggered automatically; empty - if not. - builtArtifacts: - description: Output of the build. - type: array + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. items: - $ref: '#/components/schemas/Artifact' - commands: + type: string type: array - description: Commands requested by the build. + pullTiming: + description: >- + Output only. Stores timing information for pulling this build step's + builder image only. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + allowExitCodes: items: - $ref: '#/components/schemas/Command' - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval + type: integer + format: int32 + type: array + description: >- + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. + GitSourceContext: description: >- - BuildApproval describes a build's approval configuration, state, and - result. + A GitSourceContext denotes a particular revision in a third party Git + repository (e.g., GitHub). + type: object properties: - config: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - readOnly: true - description: Output only. Configuration for manual approval of this build. - state: - description: Output only. The state of this build's approval. - readOnly: true - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - - CANCELLED - enumDescriptions: - - Default enum type. This should not be used. - - Build approval is pending. - - Build approval has been approved. - - Build approval has been rejected. - - Build was cancelled while it was still pending approval. + revisionId: + description: Git commit hash. type: string - result: - description: Output only. Result of manual approval for this Build. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - SBOMReferenceOccurrence: - id: SBOMReferenceOccurrence + url: + type: string + description: Git repository URL. + id: GitSourceContext + Location: type: object properties: - payload: - $ref: '#/components/schemas/SbomReferenceIntotoPayload' - description: The actual payload that contains the SBOM reference data. - payloadType: + version: + $ref: '#/components/schemas/Version' + description: Deprecated. The version installed at this location. + path: + type: string description: >- - The kind of payload that SbomReferenceIntotoPayload takes. Since - it's in the intoto format, this value is expected to be - 'application/vnd.in-toto+json'. + The path from which we gathered that this package/version is + installed. + cpeUri: type: string - signatures: - items: - $ref: '#/components/schemas/EnvelopeSignature' - description: The signatures over the payload. - type: array + description: >- + Deprecated. The CPE URI in [CPE + format](https://cpe.mitre.org/specification/) + id: Location description: >- - The occurrence representing an SBOM reference as applied to a specific - resource. The occurrence follows the DSSE specification. See - https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for - more details. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: + An occurrence of a particular package installation found within a + system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. + Identity: + id: Identity + properties: + updateId: + type: string + description: The revision independent identifier of the update. + revision: + description: The revision number of the update. + type: integer + format: int32 + description: The unique identifier of the update. type: object - description: A non-fatal problem encountered during the execution of the build. + FixableTotalByDigest: properties: - text: - description: Explanation of the warning generated. + fixableCount: + type: string + description: The number of fixable vulnerabilities associated with this resource. + format: int64 + resourceUri: + type: string + description: The affected resource. + totalCount: + format: int64 + type: string + description: The total number of vulnerabilities associated with this resource. + severity: type: string - priority: enumDescriptions: - - Should not be used. - - e.g. deprecation warnings and alternative feature highlights. - - e.g. automated detection of possible issues with the build. - - e.g. alerts that a feature used in the build is pending removal - description: The priority for this warning. + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + description: >- + The severity for this count. SEVERITY_UNSPECIFIED indicates total + across all severities. enum: - - PRIORITY_UNSPECIFIED - - INFO - - WARNING - - ALERT - type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning - DSSEHint: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + id: FixableTotalByDigest + type: object + description: Per resource and severity counts of fixable and total vulnerabilities. + GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: type: object description: >- - This submessage provides human-readable hints about the purpose of the - authority. Because the name of a note acts as its resource reference, it - is important to disambiguate the canonical name of the Note (which might - be a UUID for security purposes) from "readable" names more suitable for - debug output. Note that these hints should not be used to look up - authorities in security sensitive contexts, such as when looking up - attestations to verify. - id: DSSEHint + The collection of artifacts that influenced the build including sources, + dependencies, build tools, base images, and so on. + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial properties: - humanReadableName: + digest: + type: object + additionalProperties: + type: string + uri: type: string - description: >- - Required. The human readable name of this attestation authority, for - example "cloudbuild-prod". - ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash - type: object + Category: + description: The category to which the update belongs. + id: Category properties: - value: + categoryId: + description: The identifier of the category. type: string - format: byte - description: The hash value. - type: - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. + name: type: string - description: The type of hash that was performed. - enum: - - NONE - - SHA256 - - MD5 - - SHA512 - description: Container message for hash values. - ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: + description: The localized name of the category. + type: object + RunDetails: + type: object + properties: + builder: + $ref: '#/components/schemas/ProvenanceBuilder' + metadata: + $ref: '#/components/schemas/BuildMetadata' + byproducts: + items: + $ref: '#/components/schemas/ResourceDescriptor' + type: array + id: RunDetails + SlsaProvenanceZeroTwo: + id: SlsaProvenanceZeroTwo + properties: + metadata: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' + buildConfig: + additionalProperties: + type: any + description: Properties of the object. + type: object + invocation: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' + materials: + type: array + items: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' + builder: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' + buildType: + type: string + description: See full explanation of fields at slsa.dev/provenance/v0.2. + type: object + Assessment: + type: object + id: Assessment description: >- - Artifacts produced by a build that should be uploaded upon successful - completion of all build steps. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts + Assessment provides all information that is related to a single + vulnerability for this product. properties: - pythonPackages: + cve: description: >- - A list of Python packages to be uploaded to Artifact Registry upon - successful completion of all build steps. The build service account - credentials will be used to perform the upload. If any objects fail - to be pushed, the build is marked FAILURE. - type: array + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. + deprecated: true + type: string + relatedUris: items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage - objects: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + $ref: '#/components/schemas/RelatedUrl' description: >- - A list of objects to be uploaded to Cloud Storage upon successful - completion of all build steps. Files in the workspace matching - specified paths globs will be uploaded to the specified Cloud - Storage location using the builder service account's credentials. - The location and generation of the uploaded objects will be stored - in the Build resource's results field. If any objects fail to be - pushed, the build is marked FAILURE. - images: + Holds a list of references associated with this vulnerability item + and assessment. These uris have additional information about the + vulnerability and the assessment itself. E.g. Link to a document + which details how this assessment concluded the state of this + vulnerability. + type: array + longDescription: + description: A detailed description of this Vex. + type: string + remediations: + items: + $ref: '#/components/schemas/Remediation' description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images will be pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the Build resource's results field. If any of the images - fail to be pushed, the build is marked FAILURE. + Specifies details on how to handle (and presumably, fix) a + vulnerability. type: array + impacts: items: type: string - npmPackages: - type: array description: >- - A list of npm packages to be uploaded to Artifact Registry upon - successful completion of all build steps. Npm packages in the - specified paths will be uploaded to the specified Artifact Registry - repository using the builder service account's credentials. If any - packages fail to be pushed, the build is marked FAILURE. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - mavenArtifacts: + Contains information about the impact of this vulnerability, this + will change with time. type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + justification: description: >- - A list of Maven artifacts to be uploaded to Artifact Registry upon - successful completion of all build steps. Artifacts in the workspace - matching specified paths globs will be uploaded to the specified - Artifact Registry repository using the builder service account's - credentials. If any artifacts fail to be pushed, the build is marked - FAILURE. - type: object - VexAssessment: - description: >- - VexAssessment provides all publisher provided Vex information that is - related to this vulnerability. - id: VexAssessment - properties: - state: + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + $ref: '#/components/schemas/Justification' + shortDescription: type: string + description: A one sentence description of this Vex. + state: + enum: + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION enumDescriptions: - No state is specified. - This product is known to be affected by this vulnerability. @@ -2142,267 +2001,40 @@ components: - >- It is not known yet whether these versions are or are not affected by the vulnerability. However, it is still under investigation. - enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION + type: string description: Provides the state of this Vulnerability assessment. vulnerabilityId: + type: string description: >- The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc. - type: string - justification: - $ref: '#/components/schemas/Justification' - description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - impacts: - type: array - items: - type: string - description: >- - Contains information about the impact of this vulnerability, this - will change with time. - cve: - deprecated: true - description: >- - Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) - tracking number for the vulnerability. Deprecated: Use - vulnerability_id instead to denote CVEs. - type: string - relatedUris: - type: array - items: - $ref: '#/components/schemas/RelatedUrl' - description: >- - Holds a list of references associated with this vulnerability item - and assessment. - noteName: - description: >- - The VulnerabilityAssessment note from which this VexAssessment was - generated. This will be of the form: - `projects/[PROJECT_ID]/notes/[NOTE_ID]`. - type: string - remediations: - type: array - items: - $ref: '#/components/schemas/Remediation' - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - type: object - DeploymentNote: - id: DeploymentNote - description: An artifact that can be deployed in some runtime. - properties: - resourceUri: - items: - type: string - type: array - description: Required. Resource URI for the artifact being deployed. - type: object BatchCreateOccurrencesRequest: type: object - description: Request to create occurrences in batch. id: BatchCreateOccurrencesRequest + description: Request to create occurrences in batch. properties: occurrences: type: array description: Required. The occurrences to create. Max allowed length is 1000. items: $ref: '#/components/schemas/Occurrence' - BuildOccurrence: - id: BuildOccurrence - properties: - intotoStatement: - $ref: '#/components/schemas/InTotoStatement' - description: >- - In-toto Statement representation as defined in spec. The - intoto_statement can contain any type of provenance. The serialized - payload of the statement can be stored and signed in the - Occurrence's envelope. - inTotoSlsaProvenanceV1: - $ref: '#/components/schemas/InTotoSlsaProvenanceV1' - description: >- - In-Toto Slsa Provenance V1 represents a slsa provenance meeting the - slsa spec, wrapped in an in-toto statement. This allows for direct - jsonification of a to-spec in-toto slsa statement with a to-spec - slsa provenance. - provenance: - $ref: '#/components/schemas/BuildProvenance' - description: The actual provenance for the build. - provenanceBytes: - description: >- - Serialized JSON representation of the provenance, used in generating - the build signature in the corresponding build note. After verifying - the signature, `provenance_bytes` can be unmarshalled and compared - to the provenance to confirm that it is unchanged. A base64-encoded - string representation of the provenance bytes is used for the - signature in order to interoperate with openssl which expects this - format for signature verification. The serialized form is captured - both to avoid ambiguity in how the provenance is marshalled to json - as well to prevent incompatibilities with future changes. - type: string - intotoProvenance: - $ref: '#/components/schemas/InTotoProvenance' - description: >- - Deprecated. See InTotoStatement for the replacement. In-toto - Provenance representation as defined in spec. - description: Details of a build occurrence. - type: object - Location: - properties: - path: - description: >- - The path from which we gathered that this package/version is - installed. - type: string - cpeUri: - type: string - description: >- - Deprecated. The CPE URI in [CPE - format](https://cpe.mitre.org/specification/) - version: - $ref: '#/components/schemas/Version' - description: Deprecated. The version installed at this location. - description: >- - An occurrence of a particular package installation found within a - system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. - type: object - id: Location - Note: - description: A type of analysis that can be done for a resource. - properties: - shortDescription: - description: A one sentence description of this note. - type: string - updateTime: - description: >- - Output only. The time this note was last updated. This field can be - used as a filter in list requests. - format: google-datetime - type: string - discovery: - $ref: '#/components/schemas/DiscoveryNote' - description: A note describing the initial analysis of a resource. - sbomReference: - $ref: '#/components/schemas/SBOMReferenceNote' - description: A note describing an SBOM reference. - deployment: - $ref: '#/components/schemas/DeploymentNote' - description: A note describing something that can be deployed. - relatedUrl: - type: array - items: - $ref: '#/components/schemas/RelatedUrl' - description: URLs associated with this note. - dsseAttestation: - description: A note describing a dsse attestation note. - $ref: '#/components/schemas/DSSEAttestationNote' - relatedNoteNames: - description: Other notes related to this note. - type: array - items: - type: string - createTime: - format: google-datetime - type: string - description: >- - Output only. The time this note was created. This field can be used - as a filter in list requests. - compliance: - description: A note describing a compliance check. - $ref: '#/components/schemas/ComplianceNote' - package: - description: A note describing a package hosted by various package managers. - $ref: '#/components/schemas/PackageNote' - longDescription: - description: A detailed description of this note. - type: string - vulnerability: - $ref: '#/components/schemas/VulnerabilityNote' - description: A note describing a package vulnerability. - build: - description: A note describing build provenance for a verifiable build. - $ref: '#/components/schemas/BuildNote' - upgrade: - $ref: '#/components/schemas/UpgradeNote' - description: A note describing available package upgrades. - image: - $ref: '#/components/schemas/ImageNote' - description: A note describing a base image. - kind: - description: >- - Output only. The type of analysis. This field can be used as a - filter in list requests. - enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. - - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE - type: string - vulnerabilityAssessment: - description: A note describing a vulnerability assessment. - $ref: '#/components/schemas/VulnerabilityAssessmentNote' - expirationTime: - type: string - description: Time of expiration for this note. Empty if note does not expire. - format: google-datetime - attestation: - $ref: '#/components/schemas/AttestationNote' - description: A note describing an attestation role. - name: - description: >- - Output only. The name of the note in the form of - `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - type: string - type: object - id: Note Source: description: Source describes the location of the source used for the build. properties: additionalContexts: + items: + $ref: '#/components/schemas/SourceContext' description: >- If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. type: array - items: - $ref: '#/components/schemas/SourceContext' - context: - $ref: '#/components/schemas/SourceContext' + artifactStorageSourceUri: description: >- - If provided, the source code used for the build came from this + If provided, the input binary artifacts for the build came from this location. + type: string fileHashes: additionalProperties: $ref: '#/components/schemas/FileHashes' @@ -2414,340 +2046,440 @@ components: the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. - artifactStorageSourceUri: + context: + $ref: '#/components/schemas/SourceContext' description: >- - If provided, the input binary artifacts for the build came from this + If provided, the source code used for the build came from this location. - type: string - type: object id: Source - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects - properties: - paths: - description: Path globs used to match files in the build's workspace. - type: array - items: - type: string - timing: - description: >- - Output only. Stores timing information for pushing all artifact - objects. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - location: - description: >- - Cloud Storage bucket and optional object path, in the form - "gs://bucket/path/to/somewhere/". (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Files in the workspace matching any path pattern will be uploaded to - Cloud Storage with this location as a prefix. - type: string - description: >- - Files in the workspace to upload to Cloud Storage upon successful - completion of all build steps. - ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: + Material: properties: - resolvedRepoSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - description: >- - A copy of the build's `source.repo_source`, if exists, with any - revisions resolved. - resolvedGitSource: - description: >- - Output only. A copy of the build's `source.git_source`, if exists, - with any revisions resolved. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - fileHashes: - description: >- - Output only. Hash(es) of the build source, which can be used to - verify that the original source integrity was maintained in the - build. Note that `FileHashes` will only be populated if - `BuildOptions` has requested a `SourceProvenanceHash`. The keys to - this map are file paths used as build source and the values contain - the hash values for those files. If the build source came in a - single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` - will be for the single path to that file. - readOnly: true + digest: type: object additionalProperties: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - resolvedStorageSourceManifest: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest - description: >- - A copy of the build's `source.storage_source_manifest`, if exists, - with any revisions resolved. This feature is in Preview. - resolvedStorageSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - description: >- - A copy of the build's `source.storage_source`, if exists, with any - generations resolved. - resolvedConnectedRepository: - description: >- - Output only. A copy of the build's `source.connected_repository`, if - exists, with any revisions resolved. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance - description: >- - Provenance of the source. Ways to find the original source, or verify - that some source was used for this build. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: - type: object - description: An image built by the pipeline. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - properties: - pushTiming: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - description: >- - Output only. Stores timing information for pushing the specified - image. - digest: - type: string - description: Docker Registry 2.0 digest. - name: - type: string - description: >- - Name used to push the container image to Google Container Registry, - as presented to `docker push`. - ExportSBOMResponse: - type: object - id: ExportSBOMResponse - description: The response from a call to ExportSBOM. - properties: - discoveryOccurrence: - description: >- - The name of the discovery occurrence in the form - "projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to - track the progress of the SBOM export. + type: string + uri: type: string - BuildStep: + id: Material type: object - description: 'A step in the build pipeline. Next ID: 21' - id: BuildStep + DeploymentNote: properties: - waitFor: - description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. + resourceUri: type: array + description: Required. Resource URI for the artifact being deployed. items: type: string - name: + id: DeploymentNote + description: An artifact that can be deployed in some runtime. + type: object + CVSS: + properties: + attackComplexity: + enumDescriptions: + - '' + - '' + - '' + - '' type: string - description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. - script: - description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH + - ATTACK_COMPLEXITY_MEDIUM + exploitabilityScore: + type: number + format: float + impactScore: + format: float + type: number + availabilityImpact: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' type: string - volumes: + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + baseScore: + description: The base score is a function of the base metric scores. + format: float + type: number + attackVector: + enum: + - ATTACK_VECTOR_UNSPECIFIED + - ATTACK_VECTOR_NETWORK + - ATTACK_VECTOR_ADJACENT + - ATTACK_VECTOR_LOCAL + - ATTACK_VECTOR_PHYSICAL description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - items: - $ref: '#/components/schemas/Volume' - type: array - timeout: + Base Metrics Represents the intrinsic characteristics of a + vulnerability that are constant over time and across user + environments. type: string - description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. - format: google-duration - entrypoint: - description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + scope: + enumDescriptions: + - '' + - '' + - '' + enum: + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED + type: string + integrityImpact: type: string - timing: - description: >- - Output only. Stores timing information for executing this build - step. - $ref: '#/components/schemas/TimeSpan' - allowFailure: - type: boolean - description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - exitCode: - description: Output only. Return code from running the step. - format: int32 - type: integer - status: enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build has been received and is being queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. + - '' + - '' + - '' + - '' + - '' + - '' enum: - - STATUS_UNKNOWN - - PENDING - - QUEUING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + confidentialityImpact: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE type: string - description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. - id: - description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. + privilegesRequired: + enum: + - PRIVILEGES_REQUIRED_UNSPECIFIED + - PRIVILEGES_REQUIRED_NONE + - PRIVILEGES_REQUIRED_LOW + - PRIVILEGES_REQUIRED_HIGH type: string + enumDescriptions: + - '' + - '' + - '' + - '' + authentication: + enum: + - AUTHENTICATION_UNSPECIFIED + - AUTHENTICATION_MULTIPLE + - AUTHENTICATION_SINGLE + - AUTHENTICATION_NONE + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + userInteraction: + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED + id: CVSS + description: >- + Common Vulnerability Scoring System. For details, see + https://www.first.org/cvss/specification-document This is a message we + will try to use for storing various versions of CVSS rather than making + a separate proto for storing a specific version. + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: + properties: + versionName: + type: string + description: >- + Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* env: - items: - type: string description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - type: array - allowExitCodes: - items: - format: int32 - type: integer + Environment variable name to associate with the secret. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. + type: string + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret + type: object + description: >- + Pairs a secret environment variable with a SecretVersion in Secret + Manager. + Volume: + type: object + properties: + path: + type: string description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. - type: array - secretEnv: + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. + name: + type: string description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - items: - type: string - type: array - pullTiming: - $ref: '#/components/schemas/TimeSpan' + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. + description: >- + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. Next ID: 3 + id: Volume + Version: + properties: + inclusive: + type: boolean description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - dir: + Whether this version is specifying part of an inclusive range. + Grafeas does not have the capability to specify version ranges; + instead we have fields that specify start version and end versions. + At times this is insufficient - we also need to specify whether the + version is included in the range or is excluded from the range. This + boolean is expected to be set to true when the version is included + in a range. + revision: + type: string + description: The iteration of the package build from the above version. + fullName: description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. + Human readable version string. This string is of the form :- and is + only set when kind is NORMAL. type: string - args: - type: array - items: - type: string + epoch: + type: integer + description: Used to correct mistakes in the version numbering scheme. + format: int32 + name: description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. - automapSubstitutions: - type: boolean + Required only when version kind is NORMAL. The main part of the + version name. + type: string + kind: description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - BuildNote: + Required. Distinguishes between sentinel MIN/MAX versions and normal + versions. + enum: + - VERSION_KIND_UNSPECIFIED + - NORMAL + - MINIMUM + - MAXIMUM + enumDescriptions: + - Unknown. + - A standard package version. + - A special version representing negative infinity. + - A special version representing positive infinity. + type: string + id: Version + description: Version contains structured information about the version of a package. + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + type: object + description: ApprovalConfig describes configuration for manual approval of a build. properties: - builderVersion: + approvalRequired: description: >- - Required. Immutable. Version of the builder which produced this - build. - type: string - id: BuildNote + Whether or not approval is needed. If this is set on a build, it + will become pending when created, and will need to be explicitly + approved to start. + type: boolean + Command: type: object - description: >- - Note holding the version of the provider's builder and the signature of - the provenance message in the build details occurrence. - Artifact: properties: - id: + dir: + type: string description: >- - Artifact ID, if any; for container images, this will be a URL by - digest like `gcr.io/projectID/imagename@sha256:123456`. + Working directory (relative to project source root) used when + running this command. + id: type: string - names: - items: - type: string - type: array description: >- - Related artifact names. This may be the path to a binary or jar - file, or in the case of a container build, the name used to push the - container image to Google Container Registry, as presented to - `docker push`. Note that a single Artifact ID can have multiple - names, for example if two tags are applied to one image. - checksum: + Optional unique identifier for this command, used in wait_for to + reference this command as a dependency. + env: + description: Environment variables set before running this command. + type: array + items: + type: string + args: + description: Command-line arguments used when executing this command. + type: array + items: + type: string + waitFor: + description: The ID(s) of the command(s) that this command depends on. + type: array + items: + type: string + name: + description: >- + Required. Name of the command, as presented on the command line, or + if the command is packaged as a Docker container, as presented to + `docker pull`. + type: string + description: Command describes a step performed as part of the build pipeline. + id: Command + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: + type: object + properties: + proxySecretVersionName: + description: >- + SecretVersion resource of the HTTP proxy URL. The Service Account + used in the build (either the default Service Account or + user-specified Service Account) should have + `secretmanager.versions.access` permissions on this secret. The + proxy URL should be in format `protocol://@]proxyhost[:port]`. + type: string + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + description: HttpConfig is a configuration for HTTP related git operations. + PackageIssue: + properties: + fileLocation: + description: The location at which this package was found. + type: array + items: + $ref: '#/components/schemas/GrafeasV1FileLocation' + affectedCpeUri: + description: >- + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was found in. + type: string + packageType: + description: The type of package (e.g. OS, MAVEN, GO). type: string + fixedVersion: + $ref: '#/components/schemas/Version' description: >- - Hash or checksum value of a binary, or Docker Registry 2.0 digest of - a container. - description: Artifact describes a build product. + Required. The version of the package this vulnerability was fixed + in. Setting this to VersionKind.MAXIMUM means no fix is yet + available. + fixAvailable: + description: Output only. Whether a fix is available for this package. + type: boolean + fixedCpeUri: + type: string + description: >- + The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was fixed in. It is possible for this to be different + from the affected_cpe_uri. + effectiveSeverity: + type: string + description: >- + Output only. The distro or language system assigned severity for + this vulnerability when that is available and note provider assigned + severity when it is not available. + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + readOnly: true + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + affectedPackage: + description: Required. The package this vulnerability was found in. + type: string + affectedVersion: + description: >- + Required. The version of the package that is installed on the + resource affected by this vulnerability. + $ref: '#/components/schemas/Version' + fixedPackage: + type: string + description: >- + The package this vulnerability was fixed in. It is possible for this + to be different from the affected_package. type: object - id: Artifact - DiscoveryNote: + id: PackageIssue description: >- - A note that indicates a type of analysis a provider would perform. This - note exists in a provider's project. A `Discovery` occurrence is created - in a consumer's project at the start of analysis. - type: object - id: DiscoveryNote + A detail for a distro and package this vulnerability occurrence was + found in and its associated fix (if one is available). + Note: + description: A type of analysis that can be done for a resource. + id: Note properties: - analysisKind: + image: + $ref: '#/components/schemas/ImageNote' + description: A note describing a base image. + relatedNoteNames: + description: Other notes related to this note. + type: array + items: + type: string + updateTime: + description: >- + Output only. The time this note was last updated. This field can be + used as a filter in list requests. + format: google-datetime + type: string + deployment: + description: A note describing something that can be deployed. + $ref: '#/components/schemas/DeploymentNote' + name: + description: >- + Output only. The name of the note in the form of + `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + type: string + dsseAttestation: + description: A note describing a dsse attestation note. + $ref: '#/components/schemas/DSSEAttestationNote' + build: + description: A note describing build provenance for a verifiable build. + $ref: '#/components/schemas/BuildNote' + createTime: + type: string + format: google-datetime + description: >- + Output only. The time this note was created. This field can be used + as a filter in list requests. + expirationTime: + format: google-datetime + description: Time of expiration for this note. Empty if note does not expire. + type: string + sbomReference: + description: A note describing an SBOM reference. + $ref: '#/components/schemas/SBOMReferenceNote' + package: + $ref: '#/components/schemas/PackageNote' + description: A note describing a package hosted by various package managers. + discovery: + description: A note describing the initial analysis of a resource. + $ref: '#/components/schemas/DiscoveryNote' + kind: + type: string enumDescriptions: - Default value. This value is unused. - The note and occurrence represent a package vulnerability. @@ -2764,10 +2496,6 @@ components: - This represents a DSSE attestation Note - This represents a Vulnerability Assessment. - This represents an SBOM Reference. - type: string - description: >- - Required. Immutable. The kind of analysis that is handled by this - discovery. enum: - NOTE_KIND_UNSPECIFIED - VULNERABILITY @@ -2782,314 +2510,273 @@ components: - DSSE_ATTESTATION - VULNERABILITY_ASSESSMENT - SBOM_REFERENCE - CloudStorageLocation: - properties: {} - id: CloudStorageLocation - type: object - description: >- - Empty placeholder to denote that this is a Google Cloud Storage export - request. - GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: - properties: - buildInvocationId: - type: string - buildStartedOn: - format: google-datetime + description: >- + Output only. The type of analysis. This field can be used as a + filter in list requests. + vulnerability: + $ref: '#/components/schemas/VulnerabilityNote' + description: A note describing a package vulnerability. + compliance: + description: A note describing a compliance check. + $ref: '#/components/schemas/ComplianceNote' + longDescription: type: string - buildFinishedOn: - format: google-datetime + description: A detailed description of this note. + upgrade: + description: A note describing available package upgrades. + $ref: '#/components/schemas/UpgradeNote' + vulnerabilityAssessment: + description: A note describing a vulnerability assessment. + $ref: '#/components/schemas/VulnerabilityAssessmentNote' + shortDescription: + description: A one sentence description of this note. type: string - completeness: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' - reproducible: - type: boolean - description: Other properties of the build. - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata + attestation: + $ref: '#/components/schemas/AttestationNote' + description: A note describing an attestation role. + relatedUrl: + type: array + description: URLs associated with this note. + items: + $ref: '#/components/schemas/RelatedUrl' type: object - RelatedUrl: + DSSEAttestationNote: type: object - description: Metadata for any related URL information. properties: - url: - type: string - description: Specific URL associated with the resource. - label: - description: Label to describe usage of the URL. + hint: + description: DSSEHint hints at the purpose of the attestation authority. + $ref: '#/components/schemas/DSSEHint' + id: DSSEAttestationNote + RepoId: + id: RepoId + properties: + uid: type: string - id: RelatedUrl - Status: + description: A server-assigned, globally unique identifier. + projectRepoId: + $ref: '#/components/schemas/ProjectRepoId' + description: A combination of a project ID and a repo name. type: object - id: Status - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + description: A unique identifier for a Cloud Repo. + ContaineranalysisGoogleDevtoolsCloudbuildV1Results: properties: - details: + artifactTiming: + description: Time to push all non-container artifacts to Cloud Storage. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + mavenArtifacts: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + description: >- + Maven artifacts uploaded to Artifact Registry at the end of the + build. type: array + artifactManifest: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Path to the artifact manifest for non-container artifacts uploaded + to Cloud Storage. Only populated when artifacts are uploaded to + Cloud Storage. + type: string + buildStepOutputs: + description: >- + List of build step outputs, produced by builder images, in the order + corresponding to build step indices. [Cloud + Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) + can produce this output by writing to `$BUILDER_OUTPUT/output`. Only + the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` + variable is read-only and can't be substituted. items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - message: + format: byte + type: string + type: array + numArtifacts: + description: >- + Number of non-container artifacts uploaded to Cloud Storage. Only + populated when artifacts are uploaded to Cloud Storage. + format: int64 type: string + buildStepImages: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - TestIamPermissionsRequest: - properties: - permissions: + List of build step digests, in the order corresponding to build step + indices. type: array items: type: string + pythonPackages: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage + type: array 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). + Python artifacts uploaded to Artifact Registry at the end of the + build. + npmPackages: + type: array + description: Npm packages uploaded to Artifact Registry at the end of the build. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + images: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage + type: array + description: Container images that were built as a part of the build. type: object - description: Request message for `TestIamPermissions` method. - id: TestIamPermissionsRequest - AttestationNote: + description: Artifacts created by the build pipeline. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results + CloudStorageLocation: description: >- - Note kind that represents a logical attestation "role" or "authority". - For example, an organization might have one `Authority` for "QA" and one - for "build". This note is intended to act strictly as a grouping - mechanism for the attached occurrences (Attestations). This grouping - mechanism also provides a security boundary, since IAM ACLs gate the - ability for a principle to attach an occurrence to a given note. It also - provides a single point of lookup to find all attached attestation - occurrences, even if they don't all live in the same project. + Empty placeholder to denote that this is a Google Cloud Storage export + request. + id: CloudStorageLocation type: object + properties: {} + GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: properties: - hint: - $ref: '#/components/schemas/Hint' - description: Hint hints at the purpose of the attestation authority. - id: AttestationNote - License: + parameters: + type: boolean + environment: + type: boolean + materials: + type: boolean + description: >- + Indicates that the builder claims certain fields in this message to be + complete. + id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: + description: >- + Pairs a set of secret environment variables containing encrypted values + with the Cloud KMS key to use to decrypt the value. Note: Use + `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with + `secret`. For instructions see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. properties: - expression: - description: >- - Often a single license can be used to represent the licensing terms. - Sometimes it is necessary to include a choice of one or more - licenses or some combination of license identifiers. Examples: - "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later - WITH Bison-exception-2.2". - type: string - comments: - description: Comments + kmsKeyName: type: string - description: License information. - id: License - KnowledgeBase: - id: KnowledgeBase + description: Cloud KMS key name to use to decrypt these envs. + secretEnv: + description: >- + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. + type: object + additionalProperties: + format: byte + type: string + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secret type: object + Metadata: properties: - url: + buildStartedOn: + description: The timestamp of when the build started. + format: google-datetime + type: string + reproducible: + type: boolean description: >- - A link to the KB in the [Windows update catalog] - (https://www.catalog.update.microsoft.com/). + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. + buildInvocationId: type: string - name: + description: >- + Identifies the particular build invocation, which can be useful for + finding associated logs or other ad-hoc analysis. The value SHOULD + be globally unique, per in-toto Provenance spec. + completeness: + $ref: '#/components/schemas/Completeness' + description: >- + Indicates that the builder claims certain fields in this message to + be complete. + buildFinishedOn: + format: google-datetime type: string - description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). - AliasContext: - description: An alias to a repo revision. + description: The timestamp of when the build completed. + description: Other properties of the build. + id: Metadata type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage properties: - kind: - enumDescriptions: - - Unknown. - - Git tag. - - Git branch. - - >- - Used to specify non-standard aliases. For example, if a Git repo - has a ref named "refs/foo/bar". - description: The alias kind. - enum: - - KIND_UNSPECIFIED - - FIXED - - MOVABLE - - OTHER - type: string - name: - description: The alias name. - type: string - id: AliasContext - Product: - id: Product - properties: - id: - type: string + paths: + items: + type: string + type: array description: >- - Token that identifies a product so that it can be referred to from - other parts in the document. There is no predefined format as long - as it uniquely identifies a group in the context of the current - document. - name: - description: Name of the product. - type: string - genericUri: + Path globs used to match files in the build's workspace. For Python/ + Twine, this is usually `dist/*`, and sometimes additionally an + `.asc` file. + repository: type: string description: >- - Contains a URI which is vendor-specific. Example: The artifact - repository URL of an image. - description: >- - Product contains information about a product and how to uniquely - identify it. + Artifact Registry repository, in the form + "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the + workspace matching any path pattern will be uploaded to Artifact + Registry with this location as a prefix. type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1Source: + description: >- + Python package to upload to Artifact Registry upon successful completion + of all build steps. A package can encapsulate multiple objects to be + uploaded to a single repository. + SbomReferenceIntotoPayload: type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source - description: Location of the source in a supported storage service. + id: SbomReferenceIntotoPayload + description: >- + The actual payload that contains the SBOM Reference data. The payload + follows the intoto statement specification. See + https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md + for more details. properties: - developerConnectConfig: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig - description: If provided, get the source from this Developer Connect config. - storageSourceManifest: + subject: + items: + $ref: '#/components/schemas/Subject' description: >- - If provided, get the source from this manifest in Cloud Storage. - This feature is in Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest - storageSource: - description: If provided, get the source from this location in Cloud Storage. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - connectedRepository: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository - description: >- - Optional. If provided, get the source from this 2nd-gen Google Cloud - Build repository resource. - repoSource: - description: >- - If provided, get the source from this location in a Cloud Source - Repository. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - gitSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - description: If provided, get the source from this Git repository. - SbomReferenceIntotoPredicate: - properties: - location: - type: string - description: The location of the SBOM. - digest: - type: object - description: A map of algorithm to digest of the contents of the SBOM. - additionalProperties: - type: string - referrerId: + Set of software artifacts that the attestation applies to. Each + element represents a single software artifact. + type: array + _type: + description: Identifier for the schema of the Statement. type: string - description: The person or system referring this predicate to the consumer. - mimeType: + predicateType: + description: URI identifying the type of the Predicate. type: string - description: The mime type of the SBOM. + predicate: + $ref: '#/components/schemas/SbomReferenceIntotoPredicate' + description: >- + Additional parameters of the Predicate. Includes the actual data + about the SBOM. + BatchCreateNotesRequest: + description: Request to create notes in batch. + id: BatchCreateNotesRequest type: object - description: A predicate which describes the SBOM being referenced. - id: SbomReferenceIntotoPredicate - ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: properties: - invertRegex: - type: boolean - description: >- - Optional. Only trigger a build if the revision regex does NOT match - the revision regex. - branchName: - description: >- - Regex matching branches to build. The syntax of the regular - expressions accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - type: string - projectId: - description: >- - Optional. ID of the project that owns the Cloud Source Repository. - If omitted, the project ID requesting the build is assumed. - type: string - commitSha: - type: string - description: Explicit commit SHA to build. - substitutions: - type: object - description: >- - Optional. Substitutions to use in a triggered build. Should only be - used with RunBuildTrigger + notes: + description: Required. The notes to create. Max allowed length is 1000. additionalProperties: - type: string - dir: - description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. - type: string - tagName: - type: string - description: >- - Regex matching tags to build. The syntax of the regular expressions - accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - repoName: - type: string - description: Required. Name of the Cloud Source Repository. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - description: Location of the source in a Google Cloud Source Repository. - InTotoStatement: + $ref: '#/components/schemas/Note' + type: object + CVSSv3: description: >- - Spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement The - serialized InTotoStatement will be stored as Envelope.payload. - Envelope.payloadType is always "application/vnd.in-toto+json". - id: InTotoStatement + Common Vulnerability Scoring System version 3. For details, see + https://www.first.org/cvss/specification-document properties: - subject: - items: - $ref: '#/components/schemas/Subject' - type: array - provenance: - $ref: '#/components/schemas/InTotoProvenance' - slsaProvenance: - $ref: '#/components/schemas/SlsaProvenance' - slsaProvenanceZeroTwo: - $ref: '#/components/schemas/SlsaProvenanceZeroTwo' - predicateType: - type: string - description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' - _type: - description: Always `https://in-toto.io/Statement/v0.1`. + attackComplexity: + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH type: string - type: object - CVSS: - description: >- - Common Vulnerability Scoring System. For details, see - https://www.first.org/cvss/specification-document This is a message we - will try to use for storing various versions of CVSS rather than making - a separate proto for storing a specific version. - properties: - baseScore: - description: The base score is a function of the base metric scores. - type: number + enumDescriptions: + - '' + - '' + - '' + exploitabilityScore: format: float + type: number integrityImpact: type: string enum: @@ -3097,41 +2784,27 @@ components: - IMPACT_HIGH - IMPACT_LOW - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE enumDescriptions: - '' - '' - '' - '' - - '' - - '' availabilityImpact: enumDescriptions: - '' - '' - '' - '' - - '' - - '' - type: string enum: - IMPACT_UNSPECIFIED - IMPACT_HIGH - IMPACT_LOW - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - scope: - enumDescriptions: - - '' - - '' - - '' - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED type: string + baseScore: + format: float + description: The base score is a function of the base metric scores. + type: number attackVector: enumDescriptions: - '' @@ -3150,31 +2823,6 @@ components: vulnerability that are constant over time and across user environments. type: string - userInteraction: - enumDescriptions: - - '' - - '' - - '' - enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - type: string - attackComplexity: - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH - - ATTACK_COMPLEXITY_MEDIUM - enumDescriptions: - - '' - - '' - - '' - - '' - type: string - impactScore: - type: number - format: float privilegesRequired: enum: - PRIVILEGES_REQUIRED_UNSPECIFIED @@ -3187,254 +2835,163 @@ components: - '' - '' type: string - authentication: + impactScore: + format: float + type: number + scope: enumDescriptions: - '' - '' - '' - - '' enum: - - AUTHENTICATION_UNSPECIFIED - - AUTHENTICATION_MULTIPLE - - AUTHENTICATION_SINGLE - - AUTHENTICATION_NONE + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED type: string - exploitabilityScore: - format: float - type: number - confidentialityImpact: + userInteraction: + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED enumDescriptions: - '' - '' - '' - - '' - - '' - - '' type: string + confidentialityImpact: enum: - IMPACT_UNSPECIFIED - IMPACT_HIGH - IMPACT_LOW - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - id: CVSS + enumDescriptions: + - '' + - '' + - '' + - '' + type: string + id: CVSSv3 type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1Build: + BatchCreateNotesResponse: + id: BatchCreateNotesResponse + properties: + notes: + description: The notes that were created. + type: array + items: + $ref: '#/components/schemas/Note' + description: Response for creating notes in batch. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build + ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: + description: Secrets and secret environment variables. properties: - options: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions - description: Special options for this build. - queueTtl: - type: string - format: google-duration - description: >- - TTL in queue for this build. If provided and the build is enqueued - longer than this value, the build will expire and the build status - will be `EXPIRED`. The TTL starts ticking from create_time. - finishTime: - type: string - description: >- - Output only. Time at which execution of the build was finished. The - difference between finish_time and start_time is the duration of the - build's execution. - format: google-datetime - readOnly: true - timeout: - format: google-duration - type: string + secretManager: description: >- - Amount of time that this build should be allowed to run, to second - granularity. If this amount of time elapses, work on the build will - cease and the build status will be `TIMEOUT`. `timeout` starts - ticking from `startTime`. Default time is 60 minutes. - logUrl: - readOnly: true - description: Output only. URL to logs for this build in Google Cloud Console. - type: string - source: - description: Optional. The location of the source files to build. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source - results: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results - description: Output only. Results of the build. - sourceProvenance: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance - description: Output only. A permanent fixed identifier for source. - readOnly: true - tags: - items: - type: string + Secrets in Secret Manager and associated secret environment + variable. type: array - description: Tags for annotation of a `Build`. These are not docker tags. - id: - description: Output only. Unique identifier of the build. - type: string - readOnly: true - createTime: - format: google-datetime - readOnly: true - type: string - description: >- - Output only. Time at which the request to create the build was - received. - statusDetail: - type: string - readOnly: true - description: Output only. Customer-readable message about the current status. - availableSecrets: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - description: Secrets and secret environment variables. - images: items: - type: string - type: array - description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images are pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the `Build` resource's results field. If any of the images - fail to be pushed, the build status is marked `FAILURE`. - logsBucket: - type: string - description: >- - Cloud Storage bucket where logs should be written (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Logs file names will be of the format - `${logs_bucket}/log-${build_id}.txt`. - projectId: - readOnly: true - type: string - description: Output only. ID of the project. - buildTriggerId: - type: string + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret + inline: description: >- - Output only. The ID of the `BuildTrigger` that triggered this build, - if it was triggered automatically. - readOnly: true - secrets: + Secrets encrypted with KMS key and the associated secret environment + variable. items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret type: array + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + type: object + Binding: + description: Associates `members`, or principals, with a `role`. + properties: + condition: description: >- - Secrets to decrypt using Cloud Key Management Service. Note: Secret - Manager is the recommended technique for managing sensitive data - with Cloud Build. Use `available_secrets` to configure builds to - access secrets from Secret Manager. For instructions, see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets - timing: + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + role: description: >- - Output only. Stores timing information for phases of the build. - Valid keys are: * BUILD: time to execute all build steps. * PUSH: - time to push all artifacts including docker images and non docker - artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time - to set up build. If the build does not specify source or images, - these keys will not be included. - readOnly: true - type: object - additionalProperties: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - gitConfig: - description: Optional. Configuration for git operations. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - status: - enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED - type: string - readOnly: true - description: Output only. Status of the build. - steps: - type: array - description: Required. The operations to be performed on the workspace. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - substitutions: - additionalProperties: - type: string - type: object - description: Substitutions data for `Build` resource. - startTime: - readOnly: true - description: Output only. Time at which execution of the build was started. - type: string - format: google-datetime - serviceAccount: + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string + members: description: >- - IAM service account whose credentials will be used at build runtime. - Must be of the format - `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be - email address or uniqueId of the service account. - failureInfo: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo - description: >- - Output only. Contains information about the build when - status=FAILURE. - warnings: - description: >- - Output only. Non-fatal problems encountered during the execution of - the build. - readOnly: true - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. type: array - artifacts: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - description: >- - Artifacts produced by the build that should be uploaded upon - successful completion of all build steps. - approval: - readOnly: true - description: >- - Output only. Describes this build's approval configuration, status, - and result. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - name: - type: string - description: >- - Output only. The 'Build' name with format: - `projects/{project}/locations/{location}/builds/{build}`, where - {build} is a unique identifier generated by the service. - readOnly: true + items: + type: string + type: object + id: Binding + ContaineranalysisGoogleDevtoolsCloudbuildV1Build: description: >- A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the @@ -3449,1271 +3006,1599 @@ components: $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. - Remediation: - id: Remediation type: object - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. properties: - remediationUri: - $ref: '#/components/schemas/RelatedUrl' - description: Contains the URL where to obtain the remediation. - remediationType: - enumDescriptions: - - No remediation type specified. - - A MITIGATION is available. - - No fix is planned. - - Not available. - - A vendor fix is available. - - A workaround is available. - type: string - description: The type of remediation that can be applied. - enum: - - REMEDIATION_TYPE_UNSPECIFIED - - MITIGATION - - NO_FIX_PLANNED - - NONE_AVAILABLE - - VENDOR_FIX - - WORKAROUND - details: + name: + readOnly: true description: >- - Contains a comprehensive human-readable discussion of the - remediation. - type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: - description: Start and end times for a build execution phase. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - properties: - startTime: - format: google-datetime - type: string - description: Start of time span. - endTime: + Output only. The 'Build' name with format: + `projects/{project}/locations/{location}/builds/{build}`, where + {build} is a unique identifier generated by the service. type: string - description: End of time span. - format: google-datetime - GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: - id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource - properties: - digest: + timing: type: object additionalProperties: - type: string - entryPoint: - type: string - uri: - type: string - type: object - description: >- - Describes where the config file that kicked off the build came from. - This is effectively a pointer to the source where buildConfig came from. - ExportSBOMRequest: - description: >- - The request to generate and export SBOM. Target must be specified for - the request. - id: ExportSBOMRequest - properties: - cloudStorageLocation: - description: >- - Empty placeholder to denote that this is a Google Cloud Storage - export request. - $ref: '#/components/schemas/CloudStorageLocation' - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact - description: A Maven artifact uploaded using the MavenArtifact directive. - properties: - uri: - type: string - description: URI of the uploaded artifact. - pushTiming: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan description: >- - Output only. Stores timing information for pushing the specified - artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + Output only. Stores timing information for phases of the build. + Valid keys are: * BUILD: time to execute all build steps. * PUSH: + time to push all artifacts including docker images and non docker + artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time + to set up build. If the build does not specify source or images, + these keys will not be included. readOnly: true - fileHashes: + artifacts: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the Maven Artifact. - ProjectRepoId: - description: >- - Selects a repo using a Google Cloud Platform project ID (e.g., - winged-cargo-31) and a repo name within that project. - properties: - projectId: - description: The ID of the project. - type: string - repoName: - type: string - description: The name of the repo. Leave empty for the default repo. - id: ProjectRepoId - type: object - ImageOccurrence: - id: ImageOccurrence - properties: - baseResourceUrl: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts description: >- - Output only. This contains the base image URL for the derived image - occurrence. - type: string - layerInfo: + Artifacts produced by the build that should be uploaded upon + successful completion of all build steps. + options: + description: Special options for this build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + tags: items: - $ref: '#/components/schemas/Layer' + type: string type: array + description: Tags for annotation of a `Build`. These are not docker tags. + availableSecrets: + description: Secrets and secret environment variables. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + secrets: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret description: >- - This contains layer-specific metadata, if populated it has length - "distance" and is ordered with [distance] being the layer - immediately following the base image and [1] being the final layer. - fingerprint: - description: Required. The fingerprint of the derived image. - $ref: '#/components/schemas/Fingerprint' - distance: + Secrets to decrypt using Cloud Key Management Service. Note: Secret + Manager is the recommended technique for managing sensitive data + with Cloud Build. Use `available_secrets` to configure builds to + access secrets from Secret Manager. For instructions, see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets + type: array + images: + items: + type: string + type: array description: >- - Output only. The number of layers by which this image differs from - the associated image basis. - format: int32 - type: integer - type: object - description: >- - Details of the derived image portion of the DockerImage relationship. - This image would be produced from a Dockerfile with FROM . - WindowsDetail: - properties: - name: - description: Required. The name of this vulnerability. + A list of images to be pushed upon the successful completion of all + build steps. The images are pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the `Build` resource's results field. If any of the images + fail to be pushed, the build status is marked `FAILURE`. + steps: + description: Required. The operations to be performed on the workspace. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep + projectId: + description: Output only. ID of the project. + readOnly: true type: string - description: + approval: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval + description: >- + Output only. Describes this build's approval configuration, status, + and result. + readOnly: true + createTime: + readOnly: true type: string - description: The description of this vulnerability. - cpeUri: description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. + Output only. Time at which the request to create the build was + received. + format: google-datetime + gitConfig: + description: Optional. Configuration for git operations. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + source: + description: Optional. The location of the source files to build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source + logUrl: + description: Output only. URL to logs for this build in Google Cloud Console. + readOnly: true type: string - fixingKbs: + substitutions: + type: object + additionalProperties: + type: string + description: Substitutions data for `Build` resource. + warnings: items: - $ref: '#/components/schemas/KnowledgeBase' + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + readOnly: true description: >- - Required. The names of the KBs which have hotfixes to mitigate this - vulnerability. Note that there may be multiple hotfixes (and thus - multiple KBs) that mitigate a given vulnerability. Currently any - listed KBs presence is considered a fix. + Output only. Non-fatal problems encountered during the execution of + the build. type: array - id: WindowsDetail - type: object - Material: - id: Material - type: object - properties: - digest: - additionalProperties: - type: string - type: object - uri: + startTime: + readOnly: true type: string - SlsaProvenanceV1: - type: object - properties: - buildDefinition: - $ref: '#/components/schemas/BuildDefinition' - runDetails: - $ref: '#/components/schemas/RunDetails' - description: >- - Keep in sync with schema at - https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto - Builder renamed to ProvenanceBuilder because of Java conflicts. - id: SlsaProvenanceV1 - PackageIssue: - description: >- - A detail for a distro and package this vulnerability occurrence was - found in and its associated fix (if one is available). - id: PackageIssue - type: object - properties: - effectiveSeverity: + format: google-datetime + description: Output only. Time at which execution of the build was started. + buildTriggerId: description: >- - Output only. The distro or language system assigned severity for - this vulnerability when that is available and note provider assigned - severity when it is not available. + Output only. The ID of the `BuildTrigger` that triggered this build, + if it was triggered automatically. + readOnly: true type: string + timeout: + description: >- + Amount of time that this build should be allowed to run, to second + granularity. If this amount of time elapses, work on the build will + cease and the build status will be `TIMEOUT`. `timeout` starts + ticking from `startTime`. Default time is 60 minutes. + type: string + format: google-duration + serviceAccount: + type: string + description: >- + IAM service account whose credentials will be used at build runtime. + Must be of the format + `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be + email address or uniqueId of the service account. + statusDetail: + type: string + description: Output only. Customer-readable message about the current status. + readOnly: true + status: enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED readOnly: true + description: Output only. Status of the build. enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - affectedCpeUri: - description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was found in. + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. type: string - fixAvailable: - type: boolean - description: Output only. Whether a fix is available for this package. - fixedVersion: - $ref: '#/components/schemas/Version' - description: >- - Required. The version of the package this vulnerability was fixed - in. Setting this to VersionKind.MAXIMUM means no fix is yet - available. - fileLocation: - items: - $ref: '#/components/schemas/GrafeasV1FileLocation' - type: array - description: The location at which this package was found. - affectedVersion: + sourceProvenance: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + description: Output only. A permanent fixed identifier for source. + readOnly: true + results: + readOnly: true + description: Output only. Results of the build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results + logsBucket: description: >- - Required. The version of the package that is installed on the - resource affected by this vulnerability. - $ref: '#/components/schemas/Version' - packageType: + Cloud Storage bucket where logs should be written (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Logs file names will be of the format + `${logs_bucket}/log-${build_id}.txt`. type: string - description: The type of package (e.g. OS, MAVEN, GO). - fixedCpeUri: + queueTtl: + format: google-duration description: >- - The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was fixed in. It is possible for this to be different - from the affected_cpe_uri. - type: string - affectedPackage: + TTL in queue for this build. If provided and the build is enqueued + longer than this value, the build will expire and the build status + will be `EXPIRED`. The TTL starts ticking from create_time. type: string - description: Required. The package this vulnerability was found in. - fixedPackage: + id: + description: Output only. Unique identifier of the build. + readOnly: true type: string + failureInfo: description: >- - The package this vulnerability was fixed in. It is possible for this - to be different from the affected_package. - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: - description: >- - Python package to upload to Artifact Registry upon successful completion - of all build steps. A package can encapsulate multiple objects to be - uploaded to a single repository. - type: object - properties: - paths: - items: - type: string - description: >- - Path globs used to match files in the build's workspace. For Python/ - Twine, this is usually `dist/*`, and sometimes additionally an - `.asc` file. - type: array - repository: + Output only. Contains information about the build when + status=FAILURE. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + finishTime: + format: google-datetime + readOnly: true type: string description: >- - Artifact Registry repository, in the form - "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the - workspace matching any path pattern will be uploaded to Artifact - Registry with this location as a prefix. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + Output only. Time at which execution of the build was finished. The + difference between finish_time and start_time is the duration of the + build's execution. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build SourceContext: properties: - gerrit: - $ref: '#/components/schemas/GerritSourceContext' - description: A SourceContext referring to a Gerrit project. - git: - description: >- - A SourceContext referring to any third party Git repo (e.g., - GitHub). - $ref: '#/components/schemas/GitSourceContext' + labels: + description: Labels with user defined metadata. + additionalProperties: + type: string + type: object cloudRepo: $ref: '#/components/schemas/CloudRepoSourceContext' description: >- A SourceContext referring to a revision in a Google Cloud Source Repo. - labels: - type: object - additionalProperties: - type: string - description: Labels with user defined metadata. + git: + $ref: '#/components/schemas/GitSourceContext' + description: >- + A SourceContext referring to any third party Git repo (e.g., + GitHub). + gerrit: + $ref: '#/components/schemas/GerritSourceContext' + description: A SourceContext referring to a Gerrit project. + type: object description: >- A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. id: SourceContext - type: object - RunDetails: - properties: - builder: - $ref: '#/components/schemas/ProvenanceBuilder' - metadata: - $ref: '#/components/schemas/BuildMetadata' - byproducts: - items: - $ref: '#/components/schemas/ResourceDescriptor' - type: array - type: object - id: RunDetails - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: - type: object - description: A step in the build pipeline. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep + DiscoveryOccurrence: properties: - status: + continuousAnalysis: + type: string enum: - - STATUS_UNKNOWN + - CONTINUOUS_ANALYSIS_UNSPECIFIED + - ACTIVE + - INACTIVE + enumDescriptions: + - Unknown. + - The resource is continuously analyzed. + - The resource is ignored for continuous analysis. + description: Whether the resource is continuously analyzed. + analysisStatus: + enum: + - ANALYSIS_STATUS_UNSPECIFIED - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED + - SCANNING + - FINISHED_SUCCESS + - COMPLETE + - FINISHED_FAILED + - FINISHED_UNSUPPORTED enumDescriptions: - - Status of the build is unknown. + - Unknown. + - Resource is known but no action has been taken yet. + - Resource is being analyzed. + - Analysis has finished successfully. + - Analysis has completed. - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. - description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. - readOnly: true + Analysis has finished unsuccessfully, the analysis itself is in a + bad state. + - The resource is known not to be supported. type: string - timeout: + description: The status of discovery for the resource. + analysisStatusError: description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. + When an error is encountered this will contain a LocalizedMessage + under details to show to the user. The LocalizedMessage is output + only and populated by the API. + $ref: '#/components/schemas/Status' + sbomStatus: + description: The status of an SBOM generation. + $ref: '#/components/schemas/SBOMStatus' + archiveTime: type: string - format: google-duration - allowExitCodes: - type: array - items: - format: int32 - type: integer + format: google-datetime description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. - timing: + Output only. The time occurrences related to this discovery + occurrence were archived. readOnly: true - description: >- - Output only. Stores timing information for executing this build - step. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - script: + lastScanTime: type: string + format: google-datetime + description: The last time this resource was scanned. + analysisError: + type: array description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. - id: + Indicates any errors encountered during analysis of a resource. + There could be 0 or more of these errors. + items: + $ref: '#/components/schemas/Status' + analysisCompleted: + $ref: '#/components/schemas/AnalysisCompleted' + cpe: type: string + description: The CPE of the resource being scanned. + id: DiscoveryOccurrence + description: Provides information about the analysis status of a discovered resource. + type: object + PackageNote: + description: PackageNote represents a particular package version. + id: PackageNote + type: object + properties: + cpeUri: description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. + The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) + denoting the package manager version distributing a package. The + cpe_uri will be blank for language packages. + type: string + description: + type: string + description: The description of this package. name: + description: Required. Immutable. The name of the package. + type: string + digest: + type: array description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. + Hash value, typically a file digest, that allows unique + identification a specific package. + items: + $ref: '#/components/schemas/Digest' + url: type: string - waitFor: + description: The homepage for this package. + distribution: type: array + description: Deprecated. The various channels by which a package is distributed. items: - type: string + $ref: '#/components/schemas/Distribution' + version: + $ref: '#/components/schemas/Version' + description: The version of the package. + architecture: description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. - dir: + The CPU architecture for which packages in this distribution channel + were built. Architecture will be blank for language packages. + enumDescriptions: + - Unknown architecture. + - X86 architecture. + - X64 architecture. + type: string + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + license: + description: Licenses that have been declared by the authors of the package. + $ref: '#/components/schemas/License' + maintainer: + type: string + description: A freeform text denoting the maintainer of this package. + packageType: + type: string description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + properties: + location: type: string - allowFailure: - type: boolean description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - entrypoint: + Cloud Storage bucket and optional object path, in the form + "gs://bucket/path/to/somewhere/". (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Files in the workspace matching any path pattern will be uploaded to + Cloud Storage with this location as a prefix. + paths: + description: Path globs used to match files in the build's workspace. + type: array + items: + type: string + timing: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. + Output only. Stores timing information for pushing all artifact + objects. + type: object + description: >- + Files in the workspace to upload to Cloud Storage upon successful + completion of all build steps. + Hint: + type: object + id: Hint + properties: + humanReadableName: type: string - volumes: + description: >- + Required. The human readable name of this attestation authority, for + example "qa". + description: >- + This submessage provides human-readable hints about the purpose of the + authority. Because the name of a note acts as its resource reference, it + is important to disambiguate the canonical name of the Note (which might + be a UUID for security purposes) from "readable" names more suitable for + debug output. Note that these hints should not be used to look up + authorities in security sensitive contexts, such as when looking up + attestations to verify. + ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts + properties: + npmPackages: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage + type: array + description: >- + A list of npm packages to be uploaded to Artifact Registry upon + successful completion of all build steps. Npm packages in the + specified paths will be uploaded to the specified Artifact Registry + repository using the builder service account's credentials. If any + packages fail to be pushed, the build is marked FAILURE. + objects: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + description: >- + A list of objects to be uploaded to Cloud Storage upon successful + completion of all build steps. Files in the workspace matching + specified paths globs will be uploaded to the specified Cloud + Storage location using the builder service account's credentials. + The location and generation of the uploaded objects will be stored + in the Build resource's results field. If any objects fail to be + pushed, the build is marked FAILURE. + mavenArtifacts: items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - type: array - description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - secretEnv: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - items: - type: string + A list of Maven artifacts to be uploaded to Artifact Registry upon + successful completion of all build steps. Artifacts in the workspace + matching specified paths globs will be uploaded to the specified + Artifact Registry repository using the builder service account's + credentials. If any artifacts fail to be pushed, the build is marked + FAILURE. type: array - pullTiming: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - readOnly: true - args: + images: description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. + A list of images to be pushed upon the successful completion of all + build steps. The images will be pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the Build resource's results field. If any of the images + fail to be pushed, the build is marked FAILURE. items: type: string type: array - exitCode: - readOnly: true - type: integer - format: int32 - description: Output only. Return code from running the step. - automapSubstitutions: + pythonPackages: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - type: boolean - env: + A list of Python packages to be uploaded to Artifact Registry upon + successful completion of all build steps. The build service account + credentials will be used to perform the upload. If any objects fail + to be pushed, the build is marked FAILURE. type: array - description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - items: - type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: + type: object + description: >- + Artifacts produced by a build that should be uploaded upon successful + completion of all build steps. + ImageNote: + description: >- + Basis describes the base image portion (Note) of the DockerImage + relationship. Linked occurrences are derived from this or an equivalent + image via: FROM Or an equivalent reference, e.g., a tag of the + resource_url. + id: ImageNote + type: object properties: - uri: + fingerprint: + description: Required. Immutable. The fingerprint of the base image. + $ref: '#/components/schemas/Fingerprint' + resourceUrl: type: string - description: URI of the uploaded artifact. - fileHashes: - description: Hash types and values of the Python Artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - pushTiming: - readOnly: true description: >- - Output only. Stores timing information for pushing the specified - artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage + Required. Immutable. The resource_url for the resource representing + the basis of associated occurrence images. + Hash: + properties: + value: + type: string + description: Required. The hash value. + format: byte + type: + description: Required. The type of hash that was performed, e.g. "SHA-256". + type: string + id: Hash + type: object + description: Container message for hash values. + GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: type: object - description: Artifact uploaded using the PythonPackage directive. - GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: properties: + entryPoint: + type: string + uri: + type: string digest: type: object additionalProperties: type: string + description: >- + Describes where the config file that kicked off the build came from. + This is effectively a pointer to the source where buildConfig came from. + id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource + ResourceDescriptor: + id: ResourceDescriptor + type: object + properties: uri: type: string + downloadLocation: + type: string + content: + format: byte + type: string + mediaType: + type: string + name: + type: string + digest: + additionalProperties: + type: string + type: object + annotations: + additionalProperties: + type: any + type: object + Remediation: + type: object + id: Remediation + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. + properties: + remediationUri: + description: Contains the URL where to obtain the remediation. + $ref: '#/components/schemas/RelatedUrl' + remediationType: + enum: + - REMEDIATION_TYPE_UNSPECIFIED + - MITIGATION + - NO_FIX_PLANNED + - NONE_AVAILABLE + - VENDOR_FIX + - WORKAROUND + enumDescriptions: + - No remediation type specified. + - A MITIGATION is available. + - No fix is planned. + - Not available. + - A vendor fix is available. + - A workaround is available. + description: The type of remediation that can be applied. + type: string + details: + description: >- + Contains a comprehensive human-readable discussion of the + remediation. + type: string + SlsaProvenanceV1: + id: SlsaProvenanceV1 + description: >- + Keep in sync with schema at + https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto + Builder renamed to ProvenanceBuilder because of Java conflicts. + properties: + runDetails: + $ref: '#/components/schemas/RunDetails' + buildDefinition: + $ref: '#/components/schemas/BuildDefinition' + type: object + VulnerabilityNote: + id: VulnerabilityNote + description: A security vulnerability that can be found in resources. + properties: + severity: + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + type: string + description: The note provider assigned severity of this vulnerability. + cvssV2: + description: The full description of the v2 CVSS for this vulnerability. + $ref: '#/components/schemas/CVSS' + windowsDetails: + type: array + items: + $ref: '#/components/schemas/WindowsDetail' + description: >- + Windows details get their own format because the information format + and model don't match a normal detail. Specifically Windows updates + are done as patches, thus Windows vulnerabilities really are a + missing package, rather than a package being at an incorrect + version. + sourceUpdateTime: + description: >- + The time this information was last changed at the source. This is an + upstream timestamp from the underlying information source - e.g. + Ubuntu security tracker. + format: google-datetime + type: string + cvssScore: + type: number + description: >- + The CVSS score of this vulnerability. CVSS score is on a scale of 0 + - 10 where 0 indicates low severity and 10 indicates high severity. + format: float + details: + items: + $ref: '#/components/schemas/Detail' + type: array + description: >- + Details of all known distros and packages affected by this + vulnerability. + cvssVersion: + enumDescriptions: + - '' + - '' + - '' + description: CVSS version used to populate cvss_score and severity. + type: string + enum: + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 + cvssV3: + $ref: '#/components/schemas/CVSSv3' + description: The full description of the CVSSv3 for this vulnerability. type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial - description: >- - The collection of artifacts that influenced the build including sources, - dependencies, build tools, base images, and so on. - Distribution: - id: Distribution + PackageOccurrence: + id: PackageOccurrence + description: Details on how a particular software package was installed on a system. type: object - description: >- - This represents a particular channel of distribution for a given - package. E.g., Debian's jessie-backports dpkg mirror. properties: - cpeUri: + architecture: type: string description: >- - Required. The cpe_uri in [CPE - format](https://cpe.mitre.org/specification/) denoting the package - manager version distributing a package. - latestVersion: - description: >- - The latest available version of this package in this distribution - channel. - $ref: '#/components/schemas/Version' - maintainer: - description: A freeform string denoting the maintainer of this package. - type: string - description: - description: The distribution channel-specific description of this package. - type: string - url: - description: The distribution channel-specific homepage for this package. - type: string - architecture: + Output only. The CPU architecture for which packages in this + distribution channel were built. Architecture will be blank for + language packages. enumDescriptions: - Unknown architecture. - X86 architecture. - X64 architecture. - type: string - description: >- - The CPU architecture for which packages in this distribution channel - were built. enum: - ARCHITECTURE_UNSPECIFIED - X86 - X64 - ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - type: object - properties: - revision: - type: string + readOnly: true + packageType: description: >- - Optional. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git - fetch` to fetch the revision from the Git repository; therefore make - sure that the string you provide for `revision` is parsable by the - command. For information on string values accepted by `git fetch`, - see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For - information on `git fetch`, see https://git-scm.com/docs/git-fetch. - url: + Output only. The type of package; whether native or non native + (e.g., ruby gems, node.js packages, etc.). + readOnly: true + type: string + license: + description: Licenses that have been declared by the authors of the package. + $ref: '#/components/schemas/License' + name: + readOnly: true type: string + description: Required. Output only. The name of the installed package. + cpeUri: + readOnly: true description: >- - Required. Location of the Git repo to build. This will be used as a - `git remote`, see https://git-scm.com/docs/git-remote. - dir: + Output only. The cpe_uri in [CPE + format](https://cpe.mitre.org/specification/) denoting the package + manager version distributing a package. The cpe_uri will be blank + for language packages. type: string + version: + $ref: '#/components/schemas/Version' + description: Output only. The version of the package. + readOnly: true + location: description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. - description: Location of the source in any accessible Git repository. - Signature: + All of the places within the filesystem versions of this package + have been found. + type: array + items: + $ref: '#/components/schemas/Location' + Expr: + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + id: Expr type: object properties: - publicKeyId: + title: description: >- - The identifier for the public key that verifies this signature. * - The `public_key_id` is required. * The `public_key_id` SHOULD be an - RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD - be an immutable reference, such as a cryptographic digest. Examples - of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * - "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See - https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for - more details on this scheme. RFC6920 digest-named - SubjectPublicKeyInfo (digest of the DER serialization): * - "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * - "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. type: string - signature: - format: byte + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. type: string + location: description: >- - The content of the signature, an opaque bytestring. The payload that - this signature verifies MUST be unambiguously provided with the - Signature during verification. A wrapper message might provide the - payload explicitly. Alternatively, a message might have a canonical - serialization that can always be unambiguously computed to derive - the payload. - id: Signature + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + type: string + description: + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: + properties: + http: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + description: Configuration for HTTP related git operations. + description: GitConfig is a configuration for git operations. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + type: object + UpgradeNote: description: >- - Verifiers (e.g. Kritis implementations) MUST verify signatures with - respect to the trust anchors defined in policy (e.g. a Kritis policy). - Typically this means that the verifier has been configured with a map - from `public_key_id` to public key material (and any required - parameters, e.g. signing algorithm). In particular, verification - implementations MUST NOT treat the signature `public_key_id` as anything - more than a key lookup hint. The `public_key_id` DOES NOT validate or - authenticate a public key; it only provides a mechanism for quickly - selecting a public key ALREADY CONFIGURED on the verifier through a - trusted channel. Verification implementations MUST reject signatures in - any of the following circumstances: * The `public_key_id` is not - recognized by the verifier. * The public key that `public_key_id` refers - to does not verify the signature with respect to the payload. The - `signature` contents SHOULD NOT be "attached" (where the payload is - included with the serialized `signature` bytes). Verifiers MUST ignore - any "attached" payload and only verify signatures with respect to - explicitly provided payload (e.g. a `payload` field on the proto message - that holds this Signature, or the canonical serialization of the proto - message that holds this signature). - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: + An Upgrade Note represents a potential upgrade of a package to a given + version. For each package version combination (i.e. bash 4.0, bash 4.1, + bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update + field represents the information related to the update. + id: UpgradeNote type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - description: Location of the source in an archive file in Cloud Storage. properties: - generation: - format: int64 + windowsUpdate: + $ref: '#/components/schemas/WindowsUpdate' description: >- - Optional. Cloud Storage generation for the object. If the generation - is omitted, the latest generation will be used. + Required for Windows OS. Represents the metadata about the Windows + update. + package: type: string - object: + description: Required for non-Windows OS. The package this Upgrade is for. + version: + $ref: '#/components/schemas/Version' description: >- - Required. Cloud Storage object containing the source. This object - must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) - containing source to build. + Required for non-Windows OS. The version of the package in machine + + human readable form. + distributions: + type: array + items: + $ref: '#/components/schemas/UpgradeDistribution' + description: Metadata about the upgrade for each specific operating system. + InTotoSlsaProvenanceV1: + id: InTotoSlsaProvenanceV1 + type: object + properties: + subject: + type: array + items: + $ref: '#/components/schemas/Subject' + predicate: + $ref: '#/components/schemas/SlsaProvenanceV1' + _type: + description: >- + InToto spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement type: string - sourceFetcher: - enum: - - SOURCE_FETCHER_UNSPECIFIED - - GSUTIL - - GCS_FETCHER + predicateType: type: string + BuildStep: + description: 'A step in the build pipeline. Next ID: 21' + id: BuildStep + properties: + secretEnv: + type: array + items: + type: string description: >- - Optional. Option to specify the tool to fetch the source file for - the build. - enumDescriptions: - - Unspecified defaults to GSUTIL. - - Use the "gsutil" tool to download the source file. - - Use the Cloud Storage Fetcher tool to download the source file. - bucket: + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. + volumes: + items: + $ref: '#/components/schemas/Volume' + type: array + description: >- + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon + completion of the build, volumes and their contents are discarded. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + id: + description: >- + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. type: string + script: description: >- - Cloud Storage bucket containing the source (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - VulnerabilityOccurrencesSummary: - properties: - counts: + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. + type: string + allowExitCodes: description: >- - A listing by resource of the number of fixable and total - vulnerabilities. + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. items: - $ref: '#/components/schemas/FixableTotalByDigest' + format: int32 + type: integer type: array - type: object - description: >- - A summary of how many vulnerability occurrences there are per resource - and severity type. - id: VulnerabilityOccurrencesSummary - VulnerabilityOccurrence: - type: object - description: An occurrence of a severity vulnerability on a resource. - id: VulnerabilityOccurrence - properties: - shortDescription: - type: string - description: Output only. A one sentence description of this vulnerability. - cvssv3: - description: The cvss v3 score for the vulnerability. - $ref: '#/components/schemas/CVSS' - longDescription: - type: string - description: Output only. A detailed description of this vulnerability. - effectiveSeverity: - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - type: string - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + timing: + $ref: '#/components/schemas/TimeSpan' description: >- - The distro assigned severity for this vulnerability when it is - available, otherwise this is the note provider assigned severity. - When there are multiple PackageIssues for this vulnerability, they - can have different effective severities because some might be - provided by the distro while others are provided by the language - ecosystem for a language pack. For this reason, it is advised to use - the effective severity on the PackageIssue level. In the case where - multiple PackageIssues have differing effective severities, this - field should be the highest severity for any of the PackageIssues. - severity: - type: string - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + Output only. Stores timing information for executing this build + step. + allowFailure: + type: boolean description: >- - Output only. The note provider assigned severity of this - vulnerability. - vexAssessment: - $ref: '#/components/schemas/VexAssessment' - type: - type: string + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. + exitCode: + description: Output only. Return code from running the step. + type: integer + format: int32 + pullTiming: + $ref: '#/components/schemas/TimeSpan' description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - packageIssue: + Output only. Stores timing information for pulling this build step's + builder image only. + args: description: >- - Required. The set of affected locations and their fixes (if - available) within the associated resource. + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. + type: array items: - $ref: '#/components/schemas/PackageIssue' + type: string + dir: + type: string + description: >- + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. + env: type: array - cvssScore: description: >- - Output only. The CVSS score of this vulnerability. CVSS score is on - a scale of 0 - 10 where 0 indicates low severity and 10 indicates - high severity. - format: float - type: number - extraDetails: - type: string - description: Occurrence-specific extra details about the vulnerability. - cvssV2: - description: The cvss v2 score for the vulnerability. - $ref: '#/components/schemas/CVSS' - fixAvailable: + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + items: + type: string + automapSubstitutions: description: >- - Output only. Whether at least one of the affected packages has a fix - available. + Option to include built-in and custom substitutions as env variables + for this build step. This option will override the global option in + BuildOption. type: boolean - cvssVersion: - enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 + name: + type: string + description: >- + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. + entrypoint: + description: >- + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. type: string + status: enumDescriptions: - - '' - - '' - - '' - description: Output only. CVSS version used to populate cvss_score and severity. - relatedUrls: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build has been received and is being queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. + description: >- + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. + type: string + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + waitFor: + description: >- + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. type: array - description: Output only. URLs related to this vulnerability. items: - $ref: '#/components/schemas/RelatedUrl' - ComplianceOccurrence: + type: string + timeout: + type: string + description: >- + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. + format: google-duration type: object - id: ComplianceOccurrence + Digest: + id: Digest + type: object + properties: + algo: + type: string + description: '`SHA1`, `SHA512` etc.' + digestBytes: + type: string + format: byte + description: Value of the digest. + description: Digest information. + SBOMReferenceOccurrence: + description: >- + The occurrence representing an SBOM reference as applied to a specific + resource. The occurrence follows the DSSE specification. See + https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for + more details. properties: - nonCompliantFiles: + signatures: + description: The signatures over the payload. items: - $ref: '#/components/schemas/NonCompliantFile' + $ref: '#/components/schemas/EnvelopeSignature' type: array - version: - description: The OS and config version the benchmark was run on. - $ref: '#/components/schemas/ComplianceVersion' - nonComplianceReason: + payloadType: type: string - description: >- - An indication that the compliance checks in the associated - ComplianceNote were not satisfied for particular resources or a - specified reason. - CloudRepoSourceContext: - description: >- - A CloudRepoSourceContext denotes a particular revision in a Google Cloud - Source Repo. - id: CloudRepoSourceContext + description: >- + The kind of payload that SbomReferenceIntotoPayload takes. Since + it's in the intoto format, this value is expected to be + 'application/vnd.in-toto+json'. + payload: + $ref: '#/components/schemas/SbomReferenceIntotoPayload' + description: The actual payload that contains the SBOM reference data. + id: SBOMReferenceOccurrence type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig properties: - revisionId: - type: string - description: A revision ID. - aliasContext: - description: An alias, which may be a branch or tag. - $ref: '#/components/schemas/AliasContext' - repoId: - description: The ID of the repo. - $ref: '#/components/schemas/RepoId' - Detail: - properties: - severityName: - description: The distro assigned severity of this vulnerability. - type: string - source: - description: The source from which the information in this Detail was obtained. - type: string - description: + dir: type: string - description: A vendor-specific description of this vulnerability. - fixedVersion: description: >- - The distro recommended version to update to that contains a fix for - this vulnerability. Setting this to VersionKind.MAXIMUM means no - such version is yet available. - $ref: '#/components/schemas/Version' - sourceUpdateTime: - format: google-datetime + Required. Directory, relative to the source root, in which to run + the build. + revision: type: string description: >- - The time this information was last changed at the source. This is an - upstream timestamp from the underlying information source - e.g. - Ubuntu security tracker. - affectedPackage: - description: Required. The package this vulnerability affects. + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. + gitRepositoryLink: type: string - affectedCpeUri: description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. - type: string - isObsolete: + Required. The Developer Connect Git repository link, formatted as + `projects/*/locations/*/connections/*/gitRepositoryLink/*`. + description: This config defines the location of a source through Developer Connect. + type: object + Policy: + id: Policy + type: object + properties: + version: + format: int32 + type: integer description: >- - Whether this detail is obsolete. Occurrences are expected not to - point to obsolete details. - type: boolean - packageType: + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + bindings: description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - type: string - fixedCpeUri: + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + etag: description: >- - The distro recommended [CPE - URI](https://cpe.mitre.org/specification/) to update to that - contains a fix for this vulnerability. It is possible for this to be - different from the affected_cpe_uri. + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + type: string + format: byte + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + ExportSBOMResponse: + type: object + id: ExportSBOMResponse + properties: + discoveryOccurrence: type: string - affectedVersionStart: - $ref: '#/components/schemas/Version' description: >- - The version number at the start of an interval in which this - vulnerability exists. A vulnerability can affect a package between - version numbers that are disjoint sets of intervals (example: - [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will - be represented in its own Detail. If a specific affected version is - provided by a vulnerability database, affected_version_start and - affected_version_end will be the same in that Detail. - fixedPackage: + The name of the discovery occurrence in the form + "projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to + track the progress of the SBOM export. + description: The response from a call to ExportSBOM. + ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: + description: >- + Provenance of the source. Ways to find the original source, or verify + that some source was used for this build. + properties: + fileHashes: description: >- - The distro recommended package to update to that contains a fix for - this vulnerability. It is possible for this to be different from the - affected_package. + Output only. Hash(es) of the build source, which can be used to + verify that the original source integrity was maintained in the + build. Note that `FileHashes` will only be populated if + `BuildOptions` has requested a `SourceProvenanceHash`. The keys to + this map are file paths used as build source and the values contain + the hash values for those files. If the build source came in a + single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` + will be for the single path to that file. + type: object + additionalProperties: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + readOnly: true + resolvedConnectedRepository: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + readOnly: true + description: >- + Output only. A copy of the build's `source.connected_repository`, if + exists, with any revisions resolved. + resolvedStorageSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + description: >- + A copy of the build's `source.storage_source`, if exists, with any + generations resolved. + resolvedGitSource: + readOnly: true + description: >- + Output only. A copy of the build's `source.git_source`, if exists, + with any revisions resolved. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + resolvedRepoSource: + description: >- + A copy of the build's `source.repo_source`, if exists, with any + revisions resolved. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + resolvedStorageSourceManifest: + description: >- + A copy of the build's `source.storage_source_manifest`, if exists, + with any revisions resolved. This feature is in Preview. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + type: object + GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: + properties: + parameters: + type: object + additionalProperties: + description: Properties of the object. + type: any + configSource: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' + environment: + type: object + additionalProperties: + type: any + description: Properties of the object. + id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation + type: object + description: Identifies the event that kicked off the build. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: + description: A non-fatal problem encountered during the execution of the build. + type: object + properties: + priority: + enum: + - PRIORITY_UNSPECIFIED + - INFO + - WARNING + - ALERT + description: The priority for this warning. type: string - vendor: - description: The name of the vendor of the product. + enumDescriptions: + - Should not be used. + - e.g. deprecation warnings and alternative feature highlights. + - e.g. automated detection of possible issues with the build. + - e.g. alerts that a feature used in the build is pending removal + text: + description: Explanation of the warning generated. type: string - affectedVersionEnd: - $ref: '#/components/schemas/Version' - description: >- - The version number at the end of an interval in which this - vulnerability exists. A vulnerability can affect a package between - version numbers that are disjoint sets of intervals (example: - [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will - be represented in its own Detail. If a specific affected version is - provided by a vulnerability database, affected_version_start and - affected_version_end will be the same in that Detail. - id: Detail - description: >- - A detail for a distro and package affected by this vulnerability and its - associated fix (if one is available). + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + TestIamPermissionsResponse: + id: TestIamPermissionsResponse type: object - DSSEAttestationOccurrence: + description: Response message for `TestIamPermissions` method. properties: - envelope: + permissions: + items: + type: string description: >- - If doing something security critical, make sure to verify the - signatures in this metadata. - $ref: '#/components/schemas/Envelope' - statement: - $ref: '#/components/schemas/InTotoStatement' - type: object - description: >- - Deprecated. Prefer to use a regular Occurrence, and populate the - Envelope at the top level of the Occurrence. - id: DSSEAttestationOccurrence - ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + Subject: + id: Subject properties: - envMap: - description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. + digest: type: object additionalProperties: - format: byte type: string - kmsKeyName: - type: string description: >- - Resource name of Cloud KMS crypto key to decrypt the encrypted - value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* + `"": ""` Algorithms can be e.g. sha256, sha512 See + https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet + name: + type: string + type: object + Empty: + id: Empty type: object description: >- - Pairs a set of secret environment variables mapped to encrypted values - with the Cloud KMS key to use to decrypt the value. - Identity: - description: The unique identifier of the update. + 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); } + properties: {} + GetPolicyOptions: type: object + description: Encapsulates settings provided to GetIamPolicy. + id: GetPolicyOptions properties: - revision: - description: The revision number of the update. - format: int32 + 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). type: integer - updateId: - type: string - description: The revision independent identifier of the update. - id: Identity - Binding: - type: object + format: int32 + BuildOccurrence: properties: - role: + inTotoSlsaProvenanceV1: + $ref: '#/components/schemas/InTotoSlsaProvenanceV1' description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - condition: + In-Toto Slsa Provenance V1 represents a slsa provenance meeting the + slsa spec, wrapped in an in-toto statement. This allows for direct + jsonification of a to-spec in-toto slsa statement with a to-spec + slsa provenance. + intotoProvenance: + $ref: '#/components/schemas/InTotoProvenance' description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - members: + Deprecated. See InTotoStatement for the replacement. In-toto + Provenance representation as defined in spec. + provenance: + $ref: '#/components/schemas/BuildProvenance' + description: The actual provenance for the build. + intotoStatement: description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - items: - type: string - type: array - description: Associates `members`, or principals, with a `role`. - id: Binding - Jwt: - id: Jwt - type: object - properties: - compactJwt: + In-toto Statement representation as defined in spec. The + intoto_statement can contain any type of provenance. The serialized + payload of the statement can be stored and signed in the + Occurrence's envelope. + $ref: '#/components/schemas/InTotoStatement' + provenanceBytes: type: string description: >- - The compact encoding of a JWS, which is always three base64 encoded - strings joined by periods. For details, see: - https://tools.ietf.org/html/rfc7515.html#section-3.1 - RepoId: - id: RepoId + Serialized JSON representation of the provenance, used in generating + the build signature in the corresponding build note. After verifying + the signature, `provenance_bytes` can be unmarshalled and compared + to the provenance to confirm that it is unchanged. A base64-encoded + string representation of the provenance bytes is used for the + signature in order to interoperate with openssl which expects this + format for signature verification. The serialized form is captured + both to avoid ambiguity in how the provenance is marshalled to json + as well to prevent incompatibilities with future changes. + id: BuildOccurrence + description: Details of a build occurrence. type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: + description: >- + BuildApproval describes a build's approval configuration, state, and + result. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval properties: - uid: + result: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult + description: Output only. Result of manual approval for this Build. + readOnly: true + config: + readOnly: true + description: Output only. Configuration for manual approval of this build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + state: + enum: + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + - CANCELLED type: string - description: A server-assigned, globally unique identifier. - projectRepoId: - description: A combination of a project ID and a repo name. - $ref: '#/components/schemas/ProjectRepoId' - description: A unique identifier for a Cloud Repo. - FileHashes: + description: Output only. The state of this build's approval. + readOnly: true + enumDescriptions: + - Default enum type. This should not be used. + - Build approval is pending. + - Build approval has been approved. + - Build approval has been rejected. + - Build was cancelled while it was still pending approval. type: object + AttestationNote: + id: AttestationNote description: >- - Container message for hashes of byte content of files, used in source - messages to verify integrity of source input to the build. - id: FileHashes + Note kind that represents a logical attestation "role" or "authority". + For example, an organization might have one `Authority` for "QA" and one + for "build". This note is intended to act strictly as a grouping + mechanism for the attached occurrences (Attestations). This grouping + mechanism also provides a security boundary, since IAM ACLs gate the + ability for a principle to attach an occurrence to a given note. It also + provides a single point of lookup to find all attached attestation + occurrences, even if they don't all live in the same project. properties: - fileHash: - items: - $ref: '#/components/schemas/Hash' - type: array - description: Required. Collection of file hashes. - GetIamPolicyRequest: + hint: + description: Hint hints at the purpose of the attestation authority. + $ref: '#/components/schemas/Hint' + type: object + ExportSBOMRequest: + id: ExportSBOMRequest type: object - description: Request message for `GetIamPolicy` method. - id: GetIamPolicyRequest properties: - options: + cloudStorageLocation: + $ref: '#/components/schemas/CloudStorageLocation' description: >- - OPTIONAL: A `GetPolicyOptions` object for specifying options to - `GetIamPolicy`. - $ref: '#/components/schemas/GetPolicyOptions' - InTotoSlsaProvenanceV1: + Empty placeholder to denote that this is a Google Cloud Storage + export request. + description: >- + The request to generate and export SBOM. Target must be specified for + the request. + ImageOccurrence: + id: ImageOccurrence + description: >- + Details of the derived image portion of the DockerImage relationship. + This image would be produced from a Dockerfile with FROM . type: object - id: InTotoSlsaProvenanceV1 properties: - subject: - type: array - items: - $ref: '#/components/schemas/Subject' - predicateType: - type: string - _type: + baseResourceUrl: type: string description: >- - InToto spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement - predicate: - $ref: '#/components/schemas/SlsaProvenanceV1' - SlsaProvenance: - id: SlsaProvenance - properties: - materials: - type: array - items: - $ref: '#/components/schemas/Material' + Output only. This contains the base image URL for the derived image + occurrence. + fingerprint: + $ref: '#/components/schemas/Fingerprint' + description: Required. The fingerprint of the derived image. + layerInfo: description: >- - The collection of artifacts that influenced the build including - sources, dependencies, build tools, base images, and so on. This is - considered to be incomplete unless metadata.completeness.materials - is true. Unset or null is equivalent to empty. - metadata: - $ref: '#/components/schemas/SlsaMetadata' - recipe: + This contains layer-specific metadata, if populated it has length + "distance" and is ordered with [distance] being the layer + immediately following the base image and [1] being the final layer. + items: + $ref: '#/components/schemas/Layer' + type: array + distance: + format: int32 description: >- - Identifies the configuration used for the build. When combined with - materials, this SHOULD fully describe the build, such that - re-running this recipe results in bit-for-bit identical output (if - the build is reproducible). required - $ref: '#/components/schemas/SlsaRecipe' - builder: - $ref: '#/components/schemas/SlsaBuilder' - description: required - type: object - Expr: + Output only. The number of layers by which this image differs from + the associated image basis. + type: integer + Product: properties: - location: + genericUri: type: string description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - title: + Contains a URI which is vendor-specific. Example: The artifact + repository URL of an image. + name: + description: Name of the product. type: string - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. + id: type: string - description: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string + Token that identifies a product so that it can be referred to from + other parts in the document. There is no predefined format as long + as it uniquely identifies a group in the context of the current + document. + id: Product type: object description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - id: Expr - GitSourceContext: + Product contains information about a product and how to uniquely + identify it. + Envelope: + type: object description: >- - A GitSourceContext denotes a particular revision in a third party Git - repository (e.g., GitHub). + MUST match + https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. + An authenticated message of arbitrary type. + id: Envelope properties: - url: - description: Git repository URL. + payloadType: type: string - revisionId: - description: Git commit hash. + signatures: + items: + $ref: '#/components/schemas/EnvelopeSignature' + type: array + payload: + format: byte type: string - id: GitSourceContext + Recipe: type: object - ResourceDescriptor: + description: >- + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. properties: - digest: - type: object - additionalProperties: - type: string - name: - type: string - uri: - type: string - mediaType: + environment: + description: >- + Any other builder-controlled inputs necessary for correctly + evaluating the recipe. Usually only needed for reproducing the build + but not evaluated as part of policy. Since the environment field can + greatly vary in structure, depending on the builder and recipe type, + this is of form "Any". + type: array + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: + description: >- + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. type: string - downloadLocation: + arguments: + description: >- + Collection of all external inputs that influenced the build on top + of recipe.definedInMaterial and recipe.entryPoint. For example, if + the recipe type were "make", then this might be the flags passed to + make aside from the target, which is captured in recipe.entryPoint. + Since the arguments field can greatly vary in structure, depending + on the builder and recipe type, this is of form "Any". + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array + definedInMaterial: + description: >- + Index in materials containing the recipe steps that are not implied + by recipe.type. For example, if the recipe type were "make", then + this would point to the source containing the Makefile, not the make + program itself. Set to -1 if the recipe doesn't come from a + material, as zero is default unset value for int64. type: string - content: - format: byte + format: int64 + entryPoint: + description: >- + String identifying the entry point into the build. This is often a + path to a configuration file and/or a target label within that file. + The syntax and meaning are defined by recipe.type. For example, if + the recipe type were "make", then this would reference the directory + in which to run make as well as which target to use. type: string - annotations: - type: object - additionalProperties: - type: any - id: ResourceDescriptor - type: object - Layer: - id: Layer + id: Recipe + UpgradeDistribution: + id: UpgradeDistribution properties: - directive: + cpeUri: description: >- - Required. The recovered Dockerfile directive used to construct this - layer. See https://docs.docker.com/engine/reference/builder/ for - more information. + Required - The specific operating system this metadata applies to. + See https://cpe.mitre.org/specification/. type: string - arguments: - description: The recovered arguments to the Dockerfile directive. + classification: type: string - description: Layer holds metadata specific to a layer of a Docker image. + description: >- + The operating system classification of this Upgrade, as specified by + the upstream operating system upgrade feed. For Windows the + classification is one of the category_ids listed at + https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) + severity: + description: The severity as specified by the upstream operating system. + type: string + cve: + description: The cve tied to this Upgrade. + items: + type: string + type: array type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + description: >- + The Upgrade Distribution represents metadata about the Upgrade for each + operating system (CPE). Some distributions have additional metadata + around updates, classifying them into various categories and severities. + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: type: object + description: >- + An npm package uploaded to Artifact Registry using the NpmPackage + directive. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage properties: - http: + pushTiming: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - description: Configuration for HTTP related git operations. - description: GitConfig is a configuration for git operations. - Digest: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: >- + Output only. Stores timing information for pushing the specified + artifact. + readOnly: true + fileHashes: + description: Hash types and values of the npm package. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + uri: + description: URI of the uploaded npm package. + type: string + Artifact: + id: Artifact properties: - digestBytes: - description: Value of the digest. - format: byte + checksum: type: string - algo: + description: >- + Hash or checksum value of a binary, or Docker Registry 2.0 digest of + a container. + id: type: string - description: '`SHA1`, `SHA512` etc.' - id: Digest + description: >- + Artifact ID, if any; for container images, this will be a URL by + digest like `gcr.io/projectID/imagename@sha256:123456`. + names: + items: + type: string + description: >- + Related artifact names. This may be the path to a binary or jar + file, or in the case of a container build, the name used to push the + container image to Google Container Registry, as presented to + `docker push`. Note that a single Artifact ID can have multiple + names, for example if two tags are applied to one image. + type: array type: object - description: Digest information. - Hash: + description: Artifact describes a build product. + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: + description: Artifact uploaded using the PythonPackage directive. properties: - value: - type: string - description: Required. The hash value. - format: byte - type: - description: Required. The type of hash that was performed, e.g. "SHA-256". + fileHashes: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + description: Hash types and values of the Python Artifact. + uri: type: string - description: Container message for hash values. + description: URI of the uploaded artifact. + pushTiming: + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: >- + Output only. Stores timing information for pushing the specified + artifact. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage type: object - id: Hash Justification: id: Justification type: object properties: - details: - type: string - description: Additional details on why this justification was chosen. justificationType: - enum: - - JUSTIFICATION_TYPE_UNSPECIFIED - - COMPONENT_NOT_PRESENT - - VULNERABLE_CODE_NOT_PRESENT - - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH - - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY - - INLINE_MITIGATIONS_ALREADY_EXIST - description: The justification type for this vulnerability. + type: string enumDescriptions: - JUSTIFICATION_TYPE_UNSPECIFIED. - The vulnerable component is not present in the product. @@ -4734,607 +4619,722 @@ components: cannot be subverted by the attacker and cannot be configured or disabled by the user. These mitigations completely prevent exploitation based on known attack vectors. + description: The justification type for this vulnerability. + enum: + - JUSTIFICATION_TYPE_UNSPECIFIED + - COMPONENT_NOT_PRESENT + - VULNERABLE_CODE_NOT_PRESENT + - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH + - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY + - INLINE_MITIGATIONS_ALREADY_EXIST + details: type: string + description: Additional details on why this justification was chosen. description: >- Justification provides the justification when the state of the assessment if NOT_AFFECTED. - BuilderConfig: - properties: - id: - type: string - id: BuilderConfig - type: object - Version: + VulnerabilityOccurrence: + id: VulnerabilityOccurrence type: object + description: An occurrence of a severity vulnerability on a resource. properties: - revision: - type: string - description: The iteration of the package build from the above version. - epoch: - format: int32 - type: integer - description: Used to correct mistakes in the version numbering scheme. - fullName: + cvssVersion: type: string - description: >- - Human readable version string. This string is of the form :- and is - only set when kind is NORMAL. - kind: - description: >- - Required. Distinguishes between sentinel MIN/MAX versions and normal - versions. + enum: + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 + enumDescriptions: + - '' + - '' + - '' + description: Output only. CVSS version used to populate cvss_score and severity. + severity: enumDescriptions: - Unknown. - - A standard package version. - - A special version representing negative infinity. - - A special version representing positive infinity. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + description: >- + Output only. The note provider assigned severity of this + vulnerability. type: string enum: - - VERSION_KIND_UNSPECIFIED - - NORMAL - - MINIMUM - - MAXIMUM - inclusive: - type: boolean - description: >- - Whether this version is specifying part of an inclusive range. - Grafeas does not have the capability to specify version ranges; - instead we have fields that specify start version and end versions. - At times this is insufficient - we also need to specify whether the - version is included in the range or is excluded from the range. This - boolean is expected to be set to true when the version is included - in a range. - name: - description: >- - Required only when version kind is NORMAL. The main part of the - version name. + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + shortDescription: type: string - id: Version - description: Version contains structured information about the version of a package. - ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: - type: object - description: >- - Pairs a secret environment variable with a SecretVersion in Secret - Manager. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret - properties: - env: + description: Output only. A one sentence description of this vulnerability. + relatedUrls: + description: Output only. URLs related to this vulnerability. + type: array + items: + $ref: '#/components/schemas/RelatedUrl' + vexAssessment: + $ref: '#/components/schemas/VexAssessment' + type: + description: >- + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). type: string + packageIssue: + type: array + items: + $ref: '#/components/schemas/PackageIssue' description: >- - Environment variable name to associate with the secret. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. - versionName: + Required. The set of affected locations and their fixes (if + available) within the associated resource. + extraDetails: type: string + description: Occurrence-specific extra details about the vulnerability. + cvssV2: + description: The cvss v2 score for the vulnerability. + $ref: '#/components/schemas/CVSS' + effectiveSeverity: + type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. description: >- - Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: - type: object - properties: - uri: - description: URI of the uploaded npm package. + The distro assigned severity for this vulnerability when it is + available, otherwise this is the note provider assigned severity. + When there are multiple PackageIssues for this vulnerability, they + can have different effective severities because some might be + provided by the distro while others are provided by the language + ecosystem for a language pack. For this reason, it is advised to use + the effective severity on the PackageIssue level. In the case where + multiple PackageIssues have differing effective severities, this + field should be the highest severity for any of the PackageIssues. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + longDescription: + description: Output only. A detailed description of this vulnerability. type: string - pushTiming: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + cvssv3: + $ref: '#/components/schemas/CVSS' + description: The cvss v3 score for the vulnerability. + fixAvailable: + type: boolean description: >- - Output only. Stores timing information for pushing the specified - artifact. - fileHashes: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the npm package. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage - description: >- - An npm package uploaded to Artifact Registry using the NpmPackage - directive. - SetIamPolicyRequest: - type: object - description: Request message for `SetIamPolicy` method. - id: SetIamPolicyRequest - properties: - policy: - $ref: '#/components/schemas/Policy' + Output only. Whether at least one of the affected packages has a fix + available. + cvssScore: + format: float description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - ProvenanceBuilder: - id: ProvenanceBuilder + Output only. The CVSS score of this vulnerability. CVSS score is on + a scale of 0 - 10 where 0 indicates low severity and 10 indicates + high severity. + type: number + BatchCreateOccurrencesResponse: + id: BatchCreateOccurrencesResponse type: object properties: - builderDependencies: + occurrences: items: - $ref: '#/components/schemas/ResourceDescriptor' + $ref: '#/components/schemas/Occurrence' + description: The occurrences that were created. type: array - version: - additionalProperties: - type: string - type: object - id: - type: string - UpgradeNote: - description: >- - An Upgrade Note represents a potential upgrade of a package to a given - version. For each package version combination (i.e. bash 4.0, bash 4.1, - bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update - field represents the information related to the update. + description: Response for creating occurrences in batch. + Signature: properties: - distributions: - items: - $ref: '#/components/schemas/UpgradeDistribution' - type: array - description: Metadata about the upgrade for each specific operating system. - package: - type: string - description: Required for non-Windows OS. The package this Upgrade is for. - version: - $ref: '#/components/schemas/Version' - description: >- - Required for non-Windows OS. The version of the package in machine + - human readable form. - windowsUpdate: - $ref: '#/components/schemas/WindowsUpdate' + publicKeyId: description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - id: UpgradeNote - type: object - SBOMReferenceNote: - type: object - properties: - format: + The identifier for the public key that verifies this signature. * + The `public_key_id` is required. * The `public_key_id` SHOULD be an + RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD + be an immutable reference, such as a cryptographic digest. Examples + of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * + "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See + https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for + more details on this scheme. RFC6920 digest-named + SubjectPublicKeyInfo (digest of the DER serialization): * + "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * + "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" type: string - description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... - version: + signature: + format: byte description: >- - The version of the format that the SBOM takes. E.g. if the format is - spdx, the version may be 2.3. + The content of the signature, an opaque bytestring. The payload that + this signature verifies MUST be unambiguously provided with the + Signature during verification. A wrapper message might provide the + payload explicitly. Alternatively, a message might have a canonical + serialization that can always be unambiguously computed to derive + the payload. type: string - description: The note representing an SBOM reference. - id: SBOMReferenceNote - PackageOccurrence: + id: Signature + type: object + description: >- + Verifiers (e.g. Kritis implementations) MUST verify signatures with + respect to the trust anchors defined in policy (e.g. a Kritis policy). + Typically this means that the verifier has been configured with a map + from `public_key_id` to public key material (and any required + parameters, e.g. signing algorithm). In particular, verification + implementations MUST NOT treat the signature `public_key_id` as anything + more than a key lookup hint. The `public_key_id` DOES NOT validate or + authenticate a public key; it only provides a mechanism for quickly + selecting a public key ALREADY CONFIGURED on the verifier through a + trusted channel. Verification implementations MUST reject signatures in + any of the following circumstances: * The `public_key_id` is not + recognized by the verifier. * The public key that `public_key_id` refers + to does not verify the signature with respect to the payload. The + `signature` contents SHOULD NOT be "attached" (where the payload is + included with the serialized `signature` bytes). Verifiers MUST ignore + any "attached" payload and only verify signatures with respect to + explicitly provided payload (e.g. a `payload` field on the proto message + that holds this Signature, or the canonical serialization of the proto + message that holds this signature). + ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: properties: - architecture: - enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 - readOnly: true - description: >- - Output only. The CPU architecture for which packages in this - distribution channel were built. Architecture will be blank for - language packages. + path: type: string + description: >- + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. name: - description: Required. Output only. The name of the installed package. type: string - readOnly: true - location: description: >- - All of the places within the filesystem versions of this package - have been found. + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. + description: >- + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + type: object + SlsaProvenance: + type: object + properties: + builder: + $ref: '#/components/schemas/SlsaBuilder' + description: required + materials: type: array + description: >- + The collection of artifacts that influenced the build including + sources, dependencies, build tools, base images, and so on. This is + considered to be incomplete unless metadata.completeness.materials + is true. Unset or null is equivalent to empty. items: - $ref: '#/components/schemas/Location' - version: - readOnly: true - $ref: '#/components/schemas/Version' - description: Output only. The version of the package. - license: - $ref: '#/components/schemas/License' - description: Licenses that have been declared by the authors of the package. - cpeUri: - type: string - readOnly: true + $ref: '#/components/schemas/Material' + recipe: description: >- - Output only. The cpe_uri in [CPE - format](https://cpe.mitre.org/specification/) denoting the package - manager version distributing a package. The cpe_uri will be blank - for language packages. - packageType: + Identifies the configuration used for the build. When combined with + materials, this SHOULD fully describe the build, such that + re-running this recipe results in bit-for-bit identical output (if + the build is reproducible). required + $ref: '#/components/schemas/SlsaRecipe' + metadata: + $ref: '#/components/schemas/SlsaMetadata' + id: SlsaProvenance + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage + description: >- + Npm package to upload to Artifact Registry upon successful completion of + all build steps. + properties: + packagePath: + description: Path to the package.json. e.g. workspace/path/to/package + type: string + repository: type: string - readOnly: true description: >- - Output only. The type of package; whether native or non native - (e.g., ruby gems, node.js packages, etc.). - id: PackageOccurrence - description: Details on how a particular software package was installed on a system. - type: object - ComplianceNote: + Artifact Registry repository, in the form + "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in + the workspace specified by path will be zipped and uploaded to + Artifact Registry with this location as a prefix. type: object - id: ComplianceNote + DeploymentOccurrence: properties: - version: - items: - $ref: '#/components/schemas/ComplianceVersion' - description: The OS and config versions the benchmark applies to. - type: array - title: + undeployTime: type: string - description: The title that identifies this compliance check. - rationale: + description: End of the lifetime of this deployment. + format: google-datetime + config: type: string - description: A rationale for the existence of this compliance check. - remediation: - description: A description of remediation steps if the compliance check fails. + description: Configuration used to create this deployment. + address: type: string - scanInstructions: + description: Address of the runtime element hosting this deployment. + userEmail: + description: Identity of the user that triggered this deployment. type: string - format: byte - description: Serialized scan instructions with a predefined format. - description: - description: A description about this compliance check. + platform: + enum: + - PLATFORM_UNSPECIFIED + - GKE + - FLEX + - CUSTOM type: string - impact: + enumDescriptions: + - Unknown. + - Google Container Engine. + - 'Google App Engine: Flexible Environment.' + - Custom user-defined platform. + description: Platform hosting this deployment. + resourceUri: + description: >- + Output only. Resource URI for the artifact being deployed taken from + the deployable field with the same name. + type: array + items: + type: string + deployTime: + description: Required. Beginning of the lifetime of this deployment. + format: google-datetime type: string - cisBenchmark: - $ref: '#/components/schemas/CisBenchmark' - Occurrence: + type: object + description: The period during which some deployable was active in a runtime. + id: DeploymentOccurrence + ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: properties: - vulnerability: - $ref: '#/components/schemas/VulnerabilityOccurrence' - description: Describes a security vulnerability. - envelope: - $ref: '#/components/schemas/Envelope' - description: https://github.com/secure-systems-lab/dsse - createTime: - description: Output only. The time this occurrence was created. + endTime: format: google-datetime + description: End of time span. type: string - sbomReference: - description: Describes a specific SBOM reference occurrences. - $ref: '#/components/schemas/SBOMReferenceOccurrence' - dsseAttestation: - $ref: '#/components/schemas/DSSEAttestationOccurrence' - description: Describes an attestation of an artifact using dsse. - image: - $ref: '#/components/schemas/ImageOccurrence' + startTime: + type: string + description: Start of time span. + format: google-datetime + type: object + description: Start and end times for a build execution phase. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + SlsaMetadata: + id: SlsaMetadata + properties: + completeness: description: >- - Describes how this resource derives from the basis in the associated - note. - remediation: + Indicates that the builder claims certain fields in this message to + be complete. + $ref: '#/components/schemas/SlsaCompleteness' + reproducible: + description: >- + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. + type: boolean + buildFinishedOn: + type: string + description: The timestamp of when the build completed. + format: google-datetime + buildStartedOn: + format: google-datetime + type: string + description: The timestamp of when the build started. + buildInvocationId: type: string - description: A description of actions that can be taken to remedy the note. - noteName: description: >- - Required. Immutable. The analysis note associated with this - occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - This field can be used as a filter in list requests. + Identifies the particular build invocation, which can be useful for + finding associated logs or other ad-hoc analysis. The value SHOULD + be globally unique, per in-toto Provenance spec. + description: Other properties of the build. + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: + description: An image built by the pipeline. + type: object + properties: + digest: type: string - build: - $ref: '#/components/schemas/BuildOccurrence' - description: Describes a verifiable build. + description: Docker Registry 2.0 digest. name: description: >- - Output only. The name of the occurrence in the form of - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + Name used to push the container image to Google Container Registry, + as presented to `docker push`. type: string - discovery: - description: Describes when a resource was discovered. - $ref: '#/components/schemas/DiscoveryOccurrence' - resourceUri: + pushTiming: + readOnly: true + description: >- + Output only. Stores timing information for pushing the specified + image. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage + Jwt: + properties: + compactJwt: type: string description: >- - Required. Immutable. A URI that represents the resource for which - the occurrence applies. For example, - `https://gcr.io/project/image@sha256:123abc` for a Docker image. - upgrade: - description: Describes an available package upgrade on the linked resource. - $ref: '#/components/schemas/UpgradeOccurrence' + The compact encoding of a JWS, which is always three base64 encoded + strings joined by periods. For details, see: + https://tools.ietf.org/html/rfc7515.html#section-3.1 + id: Jwt + type: object + DSSEAttestationOccurrence: + id: DSSEAttestationOccurrence + description: >- + Deprecated. Prefer to use a regular Occurrence, and populate the + Envelope at the top level of the Occurrence. + type: object + properties: + statement: + $ref: '#/components/schemas/InTotoStatement' + envelope: + $ref: '#/components/schemas/Envelope' + description: >- + If doing something security critical, make sure to verify the + signatures in this metadata. + FileHashes: + description: >- + Container message for hashes of byte content of files, used in source + messages to verify integrity of source input to the build. + properties: + fileHash: + type: array + items: + $ref: '#/components/schemas/Hash' + description: Required. Collection of file hashes. + id: FileHashes + type: object + UpgradeOccurrence: + type: object + description: >- + An Upgrade Occurrence represents that a specific resource_url could + install a specific upgrade. This presence is supplied via local sources + (i.e. it is present in the mirror and the running system has noticed its + availability). For Windows, both distribution and windows_update contain + information for the Windows update. + id: UpgradeOccurrence + properties: package: - $ref: '#/components/schemas/PackageOccurrence' - description: Describes the installation of a package on the linked resource. - attestation: - $ref: '#/components/schemas/AttestationOccurrence' - description: Describes an attestation of an artifact. - deployment: - description: Describes the deployment of an artifact on a runtime. - $ref: '#/components/schemas/DeploymentOccurrence' - compliance: - $ref: '#/components/schemas/ComplianceOccurrence' - description: Describes a compliance violation on a linked resource. - kind: + description: Required for non-Windows OS. The package this Upgrade is for. type: string - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE + windowsUpdate: + $ref: '#/components/schemas/WindowsUpdate' description: >- - Output only. This explicitly denotes which of the occurrence details - are specified. This field can be used as a filter in list requests. - enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. - - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. - updateTime: + Required for Windows OS. Represents the metadata about the Windows + update. + parsedVersion: + $ref: '#/components/schemas/Version' + description: >- + Required for non-Windows OS. The version of the package in a machine + + human readable form. + distribution: + $ref: '#/components/schemas/UpgradeDistribution' + description: >- + Metadata about the upgrade for available for the specific operating + system for the resource_url. This allows efficient filtering, as + well as making it easier to use the occurrence. + ProvenanceBuilder: + type: object + id: ProvenanceBuilder + properties: + builderDependencies: + items: + $ref: '#/components/schemas/ResourceDescriptor' + type: array + version: + additionalProperties: + type: string + type: object + id: type: string - format: google-datetime - description: Output only. The time this occurrence was last updated. - description: An instance of an analysis type that has been found on a resource. - id: Occurrence + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: type: object - Completeness: + properties: + uri: + type: string + description: URI of the uploaded artifact. + fileHashes: + description: Hash types and values of the Maven Artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + pushTiming: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true + description: >- + Output only. Stores timing information for pushing the specified + artifact. + description: A Maven artifact uploaded using the MavenArtifact directive. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + AttestationOccurrence: description: >- - Indicates that the builder claims certain fields in this message to be - complete. - id: Completeness + Occurrence that represents a single "attestation". The authenticity of + an attestation can be verified using the attached signature. If the + verifier trusts the public key of the signer, then verifying the + signature is sufficient to establish trust. In this circumstance, the + authority to which this attestation is attached is primarily useful for + lookup (how to find this attestation if you already know the authority + and artifact to be verified) and intent (for which authority this + attestation was intended to sign. + type: object + id: AttestationOccurrence properties: - arguments: + serializedPayload: + type: string + format: byte description: >- - If true, the builder claims that recipe.arguments is complete, - meaning that all external inputs are properly captured in the - recipe. - type: boolean - environment: - type: boolean + Required. The serialized payload that is verified by one or more + `signatures`. + jwts: description: >- - If true, the builder claims that recipe.environment is claimed to be - complete. - materials: + One or more JWTs encoding a self-contained attestation. Each JWT + encodes the payload that it verifies within the JWT itself. Verifier + implementation SHOULD ignore the `serialized_payload` field when + verifying these JWTs. If only JWTs are present on this + AttestationOccurrence, then the `serialized_payload` SHOULD be left + empty. Each JWT SHOULD encode a claim specific to the `resource_uri` + of this Occurrence, but this is not validated by Grafeas metadata + API implementations. The JWT itself is opaque to Grafeas. + items: + $ref: '#/components/schemas/Jwt' + type: array + signatures: + items: + $ref: '#/components/schemas/Signature' + type: array description: >- - If true, the builder claims that materials are complete, usually - through some controls to prevent network access. Sometimes called - "hermetic". - type: boolean + One or more signatures over `serialized_payload`. Verifier + implementations should consider this attestation message verified if + at least one `signature` verifies `serialized_payload`. See + `Signature` in common.proto for more details on signature structure + and verification. + ListNotesResponse: type: object - DSSEAttestationNote: properties: - hint: - description: DSSEHint hints at the purpose of the attestation authority. - $ref: '#/components/schemas/DSSEHint' - type: object - id: DSSEAttestationNote - Assessment: - id: Assessment + nextPageToken: + description: >- + The next pagination token in the list response. It should be used as + `page_token` for the following request. An empty value means no more + results. + type: string + notes: + description: The notes requested. + items: + $ref: '#/components/schemas/Note' + type: array + description: Response for listing notes. + id: ListNotesResponse + VulnerabilityOccurrencesSummary: + id: VulnerabilityOccurrencesSummary + properties: + counts: + description: >- + A listing by resource of the number of fixable and total + vulnerabilities. + items: + $ref: '#/components/schemas/FixableTotalByDigest' + type: array + description: >- + A summary of how many vulnerability occurrences there are per resource + and severity type. type: object + BuildNote: + properties: + builderVersion: + type: string + description: >- + Required. Immutable. Version of the builder which produced this + build. description: >- - Assessment provides all information that is related to a single - vulnerability for this product. + Note holding the version of the provider's builder and the signature of + the provenance message in the build details occurrence. + type: object + id: BuildNote + ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + type: object properties: - relatedUris: + revision: description: >- - Holds a list of references associated with this vulnerability item - and assessment. These uris have additional information about the - vulnerability and the assessment itself. E.g. Link to a document - which details how this assessment concluded the state of this - vulnerability. - type: array - items: - $ref: '#/components/schemas/RelatedUrl' - shortDescription: - description: A one sentence description of this Vex. + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. type: string - longDescription: + repository: type: string - description: A detailed description of this Vex. - impacts: description: >- - Contains information about the impact of this vulnerability, this - will change with time. - items: - type: string - type: array - cve: + Required. Name of the Google Cloud Build repository, formatted as + `projects/*/locations/*/connections/*/repositories/*`. + dir: type: string - deprecated: true - description: >- - Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) - tracking number for the vulnerability. Deprecated: Use - vulnerability_id instead to denote CVEs. - vulnerabilityId: description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. + Optional. Directory, relative to the source root, in which to run + the build. + description: >- + Location of the source in a 2nd-gen Google Cloud Build repository + resource. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: + type: object + properties: + name: type: string - remediations: - type: array - items: - $ref: '#/components/schemas/Remediation' description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - state: - description: Provides the state of this Vulnerability assessment. + The `WorkerPool` resource to execute the build on. You must have + `cloudbuild.workerpools.use` on the project hosting the WorkerPool. + Format + projects/{project}/locations/{location}/workerPools/{workerPoolId} + description: >- + Details about how a build should be executed on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + SBOMStatus: + id: SBOMStatus + type: object + description: The status of an SBOM generation. + properties: + sbomState: type: string enumDescriptions: - - No state is specified. - - This product is known to be affected by this vulnerability. - - This product is known to be not affected by this vulnerability. - - This product contains a fix for this vulnerability. - - >- - It is not known yet whether these versions are or are not affected - by the vulnerability. However, it is still under investigation. + - Default unknown state. + - SBOM scanning is pending. + - SBOM scanning has completed. + description: The progress of the SBOM generation. enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION - justification: + - SBOM_STATE_UNSPECIFIED + - PENDING + - COMPLETE + error: + type: string description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - $ref: '#/components/schemas/Justification' - ListNoteOccurrencesResponse: + If there was an error generating an SBOM, this will indicate what + that error was. + VulnerabilityAssessmentNote: + description: >- + A single VulnerabilityAssessmentNote represents one particular product's + vulnerability assessment for one CVE. properties: - occurrences: - items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences attached to the specified note. - type: array - nextPageToken: - description: Token to provide to skip to a particular spot in the list. + assessment: + description: Represents a vulnerability assessment for the product. + $ref: '#/components/schemas/Assessment' + shortDescription: + description: A one sentence description of this Vex. + type: string + publisher: + description: Publisher details of this Note. + $ref: '#/components/schemas/Publisher' + languageCode: + description: >- + Identifies the language used by this document, corresponding to IETF + BCP 47 / RFC 5646. type: string + title: + description: The title of the note. E.g. `Vex-Debian-11.4` + type: string + product: + description: The product affected by this vex. + $ref: '#/components/schemas/Product' + longDescription: + type: string + description: A detailed description of this Vex. + id: VulnerabilityAssessmentNote type: object - description: Response for listing occurrences for a note. - id: ListNoteOccurrencesResponse - ContaineranalysisGoogleDevtoolsCloudbuildV1Results: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results - description: Artifacts created by the build pipeline. + DSSEHint: + description: >- + This submessage provides human-readable hints about the purpose of the + authority. Because the name of a note acts as its resource reference, it + is important to disambiguate the canonical name of the Note (which might + be a UUID for security purposes) from "readable" names more suitable for + debug output. Note that these hints should not be used to look up + authorities in security sensitive contexts, such as when looking up + attestations to verify. properties: - pythonPackages: - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage + humanReadableName: description: >- - Python artifacts uploaded to Artifact Registry at the end of the - build. - artifactTiming: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: Time to push all non-container artifacts to Cloud Storage. - images: - description: Container images that were built as a part of the build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - type: array - artifactManifest: + Required. The human readable name of this attestation authority, for + example "cloudbuild-prod". type: string - description: >- - Path to the artifact manifest for non-container artifacts uploaded - to Cloud Storage. Only populated when artifacts are uploaded to - Cloud Storage. - mavenArtifacts: - type: array - description: >- - Maven artifacts uploaded to Artifact Registry at the end of the - build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact - numArtifacts: - format: int64 - description: >- - Number of non-container artifacts uploaded to Cloud Storage. Only - populated when artifacts are uploaded to Cloud Storage. + id: DSSEHint + type: object + ListOccurrencesResponse: + id: ListOccurrencesResponse + description: Response for listing occurrences. + type: object + properties: + nextPageToken: type: string - buildStepImages: - items: - type: string - description: >- - List of build step digests, in the order corresponding to build step - indices. - type: array - buildStepOutputs: - items: - format: byte - type: string description: >- - List of build step outputs, produced by builder images, in the order - corresponding to build step indices. [Cloud - Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) - can produce this output by writing to `$BUILDER_OUTPUT/output`. Only - the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` - variable is read-only and can't be substituted. - type: array - npmPackages: - description: Npm packages uploaded to Artifact Registry at the end of the build. + The next pagination token in the list response. It should be used as + `page_token` for the following request. An empty value means no more + results. + occurrences: items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + $ref: '#/components/schemas/Occurrence' type: array + description: The occurrences requested. + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: type: object - VulnerabilityNote: - type: object - id: VulnerabilityNote properties: - cvssV2: - $ref: '#/components/schemas/CVSS' - description: The full description of the v2 CVSS for this vulnerability. - cvssScore: - description: >- - The CVSS score of this vulnerability. CVSS score is on a scale of 0 - - 10 where 0 indicates low severity and 10 indicates high severity. - format: float - type: number - sourceUpdateTime: - format: google-datetime + url: description: >- - The time this information was last changed at the source. This is an - upstream timestamp from the underlying information source - e.g. - Ubuntu security tracker. + Optional. An optional URL tied to this manual approval result. This + field is essentially the same as comment, except that it will be + rendered by the UI differently. An example use case is a link to an + external job that approved this Build. + type: string + approverAccount: type: string - cvssV3: - $ref: '#/components/schemas/CVSSv3' - description: The full description of the CVSSv3 for this vulnerability. - windowsDetails: - items: - $ref: '#/components/schemas/WindowsDetail' - type: array - description: >- - Windows details get their own format because the information format - and model don't match a normal detail. Specifically Windows updates - are done as patches, thus Windows vulnerabilities really are a - missing package, rather than a package being at an incorrect - version. - details: - items: - $ref: '#/components/schemas/Detail' - type: array description: >- - Details of all known distros and packages affected by this - vulnerability. - cvssVersion: + Output only. Email of the user that called the ApproveBuild API to + approve or reject a build at the time that the API was called. + readOnly: true + decision: enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 - description: CVSS version used to populate cvss_score and severity. - enumDescriptions: - - '' - - '' - - '' + - DECISION_UNSPECIFIED + - APPROVED + - REJECTED type: string - severity: + description: Required. The decision of this manual approval. enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - description: The note provider assigned severity of this vulnerability. + - Default enum type. This should not be used. + - Build is approved. + - Build is rejected. + approvalTime: + description: Output only. The time when the approval decision was made. + format: google-datetime + readOnly: true type: string - description: A security vulnerability that can be found in resources. + comment: + type: string + description: Optional. An optional comment for this manual approval result. + description: >- + ApprovalResult describes the decision and associated metadata of a + manual approval of a build. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult + GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: + type: object + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata + properties: + buildInvocationId: + type: string + reproducible: + type: boolean + completeness: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' + buildFinishedOn: + type: string + format: google-datetime + buildStartedOn: + format: google-datetime + type: string + description: Other properties of the build. + SetIamPolicyRequest: + type: object + properties: + policy: + $ref: '#/components/schemas/Policy' + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. parameters: quotaUser: description: >- @@ -5345,10 +5345,16 @@ components: name: quotaUser schema: type: string - callback: - description: JSONP + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: callback + name: prettyPrint + schema: + type: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string _.xgafv: @@ -5360,16 +5366,19 @@ components: enum: - '1' - '2' - access_token: - description: OAuth access token. + 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. in: query - name: access_token + name: key schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string oauth_token: @@ -5378,6 +5387,18 @@ components: name: oauth_token schema: type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string alt: description: Data format for response. in: query @@ -5388,578 +5409,495 @@ components: - json - media - proto - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - 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. - in: query - name: key - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string x-stackQL-resources: - occurrences: - id: google.containeranalysis.occurrences - name: occurrences - title: Occurrences + resources: + id: google.containeranalysis.resources + name: resources + title: Resources methods: - projects_occurrences_list: + projects_locations_resources_export_sbom: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1resources~1{resourcesId}:exportSBOM/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.occurrences - projects_occurrences_create: + projects_resources_export_sbom: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1resources~1{resourcesId}:exportSBOM/post response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_patch: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + notes: + id: google.containeranalysis.notes + name: notes + title: Notes + methods: + projects_locations_notes_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/get response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_delete: + objectKey: $.notes + projects_locations_notes_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/post response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get: + projects_locations_notes_batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_batch_create: + projects_locations_notes_patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences:batchCreate/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_notes_occurrences_list: + projects_locations_notes_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}~1occurrences/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.occurrences - projects_locations_notes_occurrences_list: + projects_locations_notes_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.occurrences - projects_locations_occurrences_patch: + projects_notes_get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/patch + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_get: + projects_notes_delete: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_delete: + projects_notes_patch: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/delete + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_create: + projects_notes_list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_list: + objectKey: $.notes + projects_notes_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.occurrences - projects_locations_occurrences_batch_create: + projects_notes_batch_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:batchCreate/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes:batchCreate/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_notes_occurrences_list - - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_get - - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_get - - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_notes_occurrences_list - - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_list + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_get - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_list + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_list + - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_get' + - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_list' insert: - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_create + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_create - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_batch_create + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_batch_create - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_create + #/components/x-stackQL-resources/notes/methods/projects_notes_create - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_batch_create + #/components/x-stackQL-resources/notes/methods/projects_notes_batch_create update: - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_patch + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_patch - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_patch + #/components/x-stackQL-resources/notes/methods/projects_notes_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_delete + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_delete - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_delete - occurrences_vulnerability_summary: - id: google.containeranalysis.occurrences_vulnerability_summary - name: occurrences_vulnerability_summary - title: Occurrences_vulnerability_summary + #/components/x-stackQL-resources/notes/methods/projects_notes_delete + notes_iam_policies: + id: google.containeranalysis.notes_iam_policies + name: notes_iam_policies + title: Notes_iam_policies methods: - projects_occurrences_get_vulnerability_summary: + projects_locations_notes_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_get_vulnerability_summary: + objectKey: $.bindings + projects_locations_notes_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary - - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary - insert: [] - update: [] - replace: [] - delete: [] - occurrences_iam_policies: - id: google.containeranalysis.occurrences_iam_policies - name: occurrences_iam_policies - title: Occurrences_iam_policies - methods: - projects_occurrences_set_iam_policy: + projects_locations_notes_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get_iam_policy: + projects_notes_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_occurrences_test_iam_permissions: + projects_notes_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_get_iam_policy: + projects_notes_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_occurrences_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_occurrences_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_get_iam_policy + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_get_iam_policy - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_get_iam_policy + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_set_iam_policy + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_set_iam_policy - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_set_iam_policy + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_set_iam_policy delete: [] - occurrences_notes: - id: google.containeranalysis.occurrences_notes - name: occurrences_notes - title: Occurrences_notes + occurrences: + id: google.containeranalysis.occurrences + name: occurrences + title: Occurrences methods: - projects_occurrences_get_notes: + projects_locations_notes_occurrences_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}~1notes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_get_notes: + objectKey: $.occurrences + projects_locations_occurrences_batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}~1notes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/occurrences_notes/methods/projects_locations_occurrences_get_notes - - $ref: >- - #/components/x-stackQL-resources/occurrences_notes/methods/projects_occurrences_get_notes - insert: [] - update: [] - replace: [] - delete: [] - notes: - id: google.containeranalysis.notes - name: notes - title: Notes - methods: - projects_notes_get: + projects_locations_occurrences_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/post response: mediaType: application/json openAPIDocKey: '200' - projects_notes_patch: + projects_locations_occurrences_list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/get response: mediaType: application/json openAPIDocKey: '200' - projects_notes_delete: + objectKey: $.occurrences + projects_locations_occurrences_patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/delete' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_notes_list: + projects_locations_occurrences_get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notes - projects_notes_create: + projects_locations_occurrences_delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_notes_batch_create: + projects_occurrences_batch_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes:batchCreate/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences:batchCreate/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_list: + projects_occurrences_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notes - projects_locations_notes_create: + projects_occurrences_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/post + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_get: + projects_occurrences_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_patch: + projects_occurrences_list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/patch + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_delete: + objectKey: $.occurrences + projects_occurrences_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/delete + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_batch_create: + projects_notes_occurrences_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}~1occurrences/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.occurrences sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_get - - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_get' + #/components/x-stackQL-resources/occurrences/methods/projects_locations_notes_occurrences_list - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_list - - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_list' + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_get + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_list + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_get + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_notes_occurrences_list + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_list insert: - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_create + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_batch_create - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_batch_create + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_create - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_create + #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_batch_create - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_batch_create + #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_create update: - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_patch + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_patch - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_patch + #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_delete + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_delete - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_delete - notes_iam_policies: - id: google.containeranalysis.notes_iam_policies - name: notes_iam_policies - title: Notes_iam_policies + #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_delete + occurrences_vulnerability_summary: + id: google.containeranalysis.occurrences_vulnerability_summary + name: occurrences_vulnerability_summary + title: Occurrences_vulnerability_summary methods: - projects_notes_get_iam_policy: + projects_locations_occurrences_get_vulnerability_summary: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_notes_set_iam_policy: + projects_occurrences_get_vulnerability_summary: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get response: mediaType: application/json openAPIDocKey: '200' - projects_notes_test_iam_permissions: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary + - $ref: >- + #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary + insert: [] + update: [] + replace: [] + delete: [] + occurrences_iam_policies: + id: google.containeranalysis.occurrences_iam_policies + name: occurrences_iam_policies + title: Occurrences_iam_policies + methods: + projects_locations_occurrences_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_get_iam_policy: + projects_locations_occurrences_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_notes_set_iam_policy: + projects_locations_occurrences_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_test_iam_permissions: + projects_occurrences_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_occurrences_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_occurrences_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_get_iam_policy + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_get_iam_policy - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_get_iam_policy + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_set_iam_policy + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_set_iam_policy - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_set_iam_policy + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_set_iam_policy delete: [] - resources: - id: google.containeranalysis.resources - name: resources - title: Resources + occurrences_notes: + id: google.containeranalysis.occurrences_notes + name: occurrences_notes + title: Occurrences_notes methods: - projects_locations_resources_export_sbom: + projects_locations_occurrences_get_notes: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1resources~1{resourcesId}:exportSBOM/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}~1notes/get response: mediaType: application/json openAPIDocKey: '200' - projects_resources_export_sbom: + projects_occurrences_get_notes: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1resources~1{resourcesId}:exportSBOM/post + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}~1notes/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/occurrences_notes/methods/projects_locations_occurrences_get_notes + - $ref: >- + #/components/x-stackQL-resources/occurrences_notes/methods/projects_occurrences_get_notes insert: [] update: [] replace: [] delete: [] paths: - /v1/projects/{projectsId}/occurrences: + /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: parameters: &ref_1 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - get: - description: Lists occurrences for the specified project. - operationId: containeranalysis.projects.occurrences.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOccurrencesResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new occurrence. - operationId: containeranalysis.projects.occurrences.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Occurrence' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Occurrence' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}: - parameters: *ref_1 - patch: - description: Updates the specified occurrence. - operationId: containeranalysis.projects.occurrences.patch + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' + post: + description: Generates an SBOM for the given resource. + operationId: containeranalysis.projects.locations.resources.exportSBOM requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/ExportSBOMRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5971,7 +5909,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/ExportSBOMResponse' parameters: - in: path name: projectsId @@ -5979,21 +5917,20 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: resourcesId + required: true schema: type: string - format: google-fieldmask - delete: - description: >- - Deletes the specified occurrence. For example, use this method to delete - an occurrence when the occurrence is no longer applicable for the given - resource. - operationId: containeranalysis.projects.occurrences.delete + /v1/projects/{projectsId}/locations/{locationsId}/notes: + parameters: *ref_1 + get: + description: Lists notes for the specified project. + operationId: containeranalysis.projects.locations.notes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6005,7 +5942,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListNotesResponse' parameters: - in: path name: projectsId @@ -6013,13 +5950,31 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.occurrences.get + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new note. + operationId: containeranalysis.projects.locations.notes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6031,7 +5986,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6039,20 +5994,30 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences:batchCreate: + - in: query + name: noteId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy: parameters: *ref_1 post: - description: Creates new occurrences in batch. - operationId: containeranalysis.projects.occurrences.batchCreate + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.notes.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesRequest' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6064,18 +6029,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate: parameters: *ref_1 - get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.occurrences.getVulnerabilitySummary + post: + description: Creates new notes in batch. + operationId: containeranalysis.projects.locations.notes.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateNotesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6087,18 +6067,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/BatchCreateNotesResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy: parameters: *ref_1 post: description: >- @@ -6108,7 +6089,7 @@ paths: is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.setIamPolicy + operationId: containeranalysis.projects.locations.notes.setIamPolicy requestBody: content: application/json: @@ -6133,17 +6114,25 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}/notes: + - in: path + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: parameters: *ref_1 - get: - description: >- - Gets the note attached to the specified occurrence. Consumer projects - can use this method to get a note that belongs to a provider project. - operationId: containeranalysis.projects.occurrences.getNotes + patch: + description: Updates the specified note. + operationId: containeranalysis.projects.locations.notes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6163,26 +6152,23 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: - parameters: *ref_1 - post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.getIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + - in: path + name: notesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets the specified note. + operationId: containeranalysis.projects.locations.notes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6194,7 +6180,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6202,25 +6188,18 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + - in: path + name: notesId + required: true + schema: + type: string + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.locations.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6232,7 +6211,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6240,18 +6219,30 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}/occurrences: + - in: path + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions: parameters: *ref_1 - get: + post: description: >- - Lists occurrences referencing the specified note. Provider projects can - use this method to get all occurrences across consumer projects - referencing the specified note. - operationId: containeranalysis.projects.notes.occurrences.list + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.notes.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6263,7 +6254,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNoteOccurrencesResponse' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -6271,28 +6262,23 @@ paths: schema: type: string - in: path - name: notesId + name: locationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: notesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/notes/{notesId}: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: parameters: *ref_1 get: - description: Gets the specified note. - operationId: containeranalysis.projects.notes.get + description: >- + Lists occurrences referencing the specified note. Provider projects can + use this method to get all occurrences across consumer projects + referencing the specified note. + operationId: containeranalysis.projects.locations.notes.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6304,26 +6290,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/ListNoteOccurrencesResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: notesId required: true schema: type: string - patch: - description: Updates the specified note. - operationId: containeranalysis.projects.notes.patch + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate: + parameters: *ref_1 + post: + description: Creates new occurrences in batch. + operationId: containeranalysis.projects.locations.occurrences.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/BatchCreateOccurrencesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6335,7 +6341,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/BatchCreateOccurrencesResponse' parameters: - in: path name: projectsId @@ -6343,18 +6349,20 @@ paths: schema: type: string - in: path - name: notesId + name: locationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes the specified note. - operationId: containeranalysis.projects.notes.delete + /v1/projects/{projectsId}/locations/{locationsId}/occurrences: + parameters: *ref_1 + post: + description: Creates a new occurrence. + operationId: containeranalysis.projects.locations.occurrences.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6366,7 +6374,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6374,26 +6382,13 @@ paths: schema: type: string - in: path - name: notesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: - parameters: *ref_1 - post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.notes.getIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + get: + description: Lists occurrences for the specified project. + operationId: containeranalysis.projects.locations.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6405,7 +6400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListOccurrencesResponse' parameters: - in: path name: projectsId @@ -6413,15 +6408,28 @@ paths: schema: type: string - in: path - name: notesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/notes: + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: parameters: *ref_1 get: - description: Lists notes for the specified project. - operationId: containeranalysis.projects.notes.list + description: Gets a summary of the number and severity of occurrences. + operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6433,34 +6441,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNotesResponse' + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - in: query - name: pageToken + name: filter schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy: + parameters: *ref_1 post: - description: Creates a new note. - operationId: containeranalysis.projects.notes.create + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6472,27 +6484,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: noteId + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/notes:batchCreate: + - in: path + name: occurrencesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: parameters: *ref_1 - post: - description: Creates new notes in batch. - operationId: containeranalysis.projects.notes.batchCreate + patch: + description: Updates the specified occurrence. + operationId: containeranalysis.projects.locations.occurrences.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesRequest' + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6504,29 +6522,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesResponse' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.notes.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: occurrencesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets the specified occurrence. + operationId: containeranalysis.projects.locations.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6538,7 +6558,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6546,25 +6566,21 @@ paths: schema: type: string - in: path - name: notesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:testIamPermissions: - parameters: *ref_1 - post: + - in: path + name: occurrencesId + required: true + schema: + type: string + delete: description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.notes.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + Deletes the specified occurrence. For example, use this method to delete + an occurrence when the occurrence is no longer applicable for the given + resource. + operationId: containeranalysis.projects.locations.occurrences.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6576,7 +6592,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6584,15 +6600,22 @@ paths: schema: type: string - in: path - name: notesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes: + - in: path + name: occurrencesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: parameters: *ref_1 get: - description: Lists notes for the specified project. - operationId: containeranalysis.projects.locations.notes.list + description: >- + Gets the note attached to the specified occurrence. Consumer projects + can use this method to get a note that belongs to a provider project. + operationId: containeranalysis.projects.locations.occurrences.getNotes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6604,7 +6627,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNotesResponse' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6616,27 +6639,27 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: occurrencesId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy: + parameters: *ref_1 post: - description: Creates a new note. - operationId: containeranalysis.projects.locations.notes.create + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6648,7 +6671,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6660,15 +6683,26 @@ paths: required: true schema: type: string - - in: query - name: noteId + - in: path + name: occurrencesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions: parameters: *ref_1 - get: - description: Gets the specified note. - operationId: containeranalysis.projects.locations.notes.get + post: + description: >- + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6680,7 +6714,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -6693,18 +6727,20 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - patch: - description: Updates the specified note. - operationId: containeranalysis.projects.locations.notes.patch + /v1/projects/{projectsId}/occurrences:batchCreate: + parameters: *ref_1 + post: + description: Creates new occurrences in batch. + operationId: containeranalysis.projects.occurrences.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/BatchCreateOccurrencesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6716,31 +6752,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/BatchCreateOccurrencesResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: notesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/occurrences/{occurrencesId}: + parameters: *ref_1 delete: - description: Deletes the specified note. - operationId: containeranalysis.projects.locations.notes.delete + description: >- + Deletes the specified occurrence. For example, use this method to delete + an occurrence when the occurrence is no longer applicable for the given + resource. + operationId: containeranalysis.projects.occurrences.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6760,31 +6786,18 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy: - parameters: *ref_1 - post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.getIamPolicy + patch: + description: Updates the specified occurrence. + operationId: containeranalysis.projects.occurrences.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6796,7 +6809,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6804,31 +6817,18 @@ paths: schema: type: string - in: path - name: locationsId + name: occurrencesId required: true schema: type: string - - in: path - name: notesId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + format: google-fieldmask + get: + description: Gets the specified occurrence. + operationId: containeranalysis.projects.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6840,7 +6840,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6848,30 +6848,53 @@ paths: schema: type: string - in: path - name: locationsId + name: occurrencesId required: true schema: type: string + /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: + parameters: *ref_1 + get: + description: Gets a summary of the number and severity of occurrences. + operationId: containeranalysis.projects.occurrences.getVulnerabilitySummary + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + parameters: - in: path - name: notesId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: parameters: *ref_1 post: description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.testIamPermissions + operationId: containeranalysis.projects.occurrences.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6883,7 +6906,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6891,25 +6914,26 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate: + /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: parameters: *ref_1 post: - description: Creates new notes in batch. - operationId: containeranalysis.projects.locations.notes.batchCreate + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.occurrences.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesRequest' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6921,7 +6945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6929,18 +6953,17 @@ paths: schema: type: string - in: path - name: locationsId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: + /v1/projects/{projectsId}/occurrences/{occurrencesId}/notes: parameters: *ref_1 get: description: >- - Lists occurrences referencing the specified note. Provider projects can - use this method to get all occurrences across consumer projects - referencing the specified note. - operationId: containeranalysis.projects.locations.notes.occurrences.list + Gets the note attached to the specified occurrence. Consumer projects + can use this method to get a note that belongs to a provider project. + operationId: containeranalysis.projects.occurrences.getNotes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6952,7 +6975,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNoteOccurrencesResponse' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6960,38 +6983,25 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: notesId + name: occurrencesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: + /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: parameters: *ref_1 - patch: - description: Updates the specified occurrence. - operationId: containeranalysis.projects.locations.occurrences.patch + post: + description: >- + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.occurrences.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7003,31 +7013,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path name: occurrencesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/occurrences: + parameters: *ref_1 get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.locations.occurrences.get + description: Lists occurrences for the specified project. + operationId: containeranalysis.projects.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7039,29 +7041,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/ListOccurrencesResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: occurrencesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - delete: - description: >- - Deletes the specified occurrence. For example, use this method to delete - an occurrence when the occurrence is no longer applicable for the given - resource. - operationId: containeranalysis.projects.locations.occurrences.delete + post: + description: Creates a new occurrence. + operationId: containeranalysis.projects.occurrences.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7073,30 +7080,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: occurrencesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: + /v1/projects/{projectsId}/notes/{notesId}: parameters: *ref_1 get: - description: >- - Gets the note attached to the specified occurrence. Consumer projects - can use this method to get a note that belongs to a provider project. - operationId: containeranalysis.projects.locations.occurrences.getNotes + description: Gets the specified note. + operationId: containeranalysis.projects.notes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7116,31 +7111,13 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy: - parameters: *ref_1 - post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.getIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7152,7 +7129,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -7160,25 +7137,18 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences: - parameters: *ref_1 - post: - description: Creates a new occurrence. - operationId: containeranalysis.projects.locations.occurrences.create + patch: + description: Updates the specified note. + operationId: containeranalysis.projects.notes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7190,7 +7160,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -7198,13 +7168,20 @@ paths: schema: type: string - in: path - name: locationsId + name: notesId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/notes: + parameters: *ref_1 get: - description: Lists occurrences for the specified project. - operationId: containeranalysis.projects.locations.occurrences.list + description: Lists notes for the specified project. + operationId: containeranalysis.projects.notes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7216,16 +7193,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOccurrencesResponse' + $ref: '#/components/schemas/ListNotesResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -7233,30 +7209,18 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy: - parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.setIamPolicy + description: Creates a new note. + operationId: containeranalysis.projects.notes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7268,28 +7232,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: occurrencesId - required: true + - in: query + name: noteId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: + /v1/projects/{projectsId}/notes/{notesId}:setIamPolicy: parameters: *ref_1 - get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary + post: + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.notes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7301,7 +7270,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -7309,15 +7278,11 @@ paths: schema: type: string - in: path - name: locationsId + name: notesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions: + /v1/projects/{projectsId}/notes/{notesId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -7326,7 +7291,7 @@ paths: `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.testIamPermissions + operationId: containeranalysis.projects.notes.testIamPermissions requestBody: content: application/json: @@ -7351,25 +7316,54 @@ paths: schema: type: string - in: path - name: locationsId + name: notesId required: true schema: type: string + /v1/projects/{projectsId}/notes:batchCreate: + parameters: *ref_1 + post: + description: Creates new notes in batch. + operationId: containeranalysis.projects.notes.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateNotesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateNotesResponse' + parameters: - in: path - name: occurrencesId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate: + /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: parameters: *ref_1 post: - description: Creates new occurrences in batch. - operationId: containeranalysis.projects.locations.occurrences.batchCreate + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.notes.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesRequest' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7381,7 +7375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -7389,20 +7383,18 @@ paths: schema: type: string - in: path - name: locationsId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: + /v1/projects/{projectsId}/notes/{notesId}/occurrences: parameters: *ref_1 - post: - description: Generates an SBOM for the given resource. - operationId: containeranalysis.projects.locations.resources.exportSBOM - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExportSBOMRequest' + get: + description: >- + Lists occurrences referencing the specified note. Provider projects can + use this method to get all occurrences across consumer projects + referencing the specified note. + operationId: containeranalysis.projects.notes.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7414,7 +7406,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMResponse' + $ref: '#/components/schemas/ListNoteOccurrencesResponse' parameters: - in: path name: projectsId @@ -7422,13 +7414,21 @@ paths: schema: type: string - in: path - name: locationsId + name: notesId required: true schema: type: string - - in: path - name: resourcesId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string /v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM: diff --git a/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml b/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml index baaa4630..b8bf7ed9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml @@ -34,3075 +34,3226 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDocumentaiV1DocumentChunkedDocument: - id: GoogleCloudDocumentaiV1DocumentChunkedDocument - type: object - description: Represents the chunks that the document is divided into. - properties: - chunks: - description: List of chunks. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - type: array - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores - properties: - qualityScore: - description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - format: float - type: number - detectedDefects: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - description: A list of detected defects. - type: array + GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: + id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata type: object - description: Image quality scores for the page image. - GoogleCloudContentwarehouseV1Value: + properties: {} + description: Metadata object for CreateDocument request (currently empty). + GoogleCloudContentwarehouseV1HistogramQuery: properties: - floatValue: - description: Represents a float value. - type: number - format: float - booleanValue: - type: boolean - description: Represents a boolean value. - enumValue: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' - description: Represents an enum value. - timestampValue: - description: Represents a timestamp value. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - datetimeValue: - description: Represents a datetime value. - $ref: '#/components/schemas/GoogleTypeDateTime' - stringValue: + histogramQuery: type: string - description: Represents a string value. - intValue: - format: int32 - type: integer - description: Represents a integer value. - description: >- - `Value` represents a dynamically typed value which can be either be a - float, a integer, a string, or a datetime value. A producer of value is - expected to set one of these variants. Absence of any variant indicates - an error. - id: GoogleCloudContentwarehouseV1Value - type: object - GoogleCloudContentwarehouseV1RuleEngineOutput: - id: GoogleCloudContentwarehouseV1RuleEngineOutput - properties: - ruleEvaluatorOutput: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput description: >- - Output from Rule Evaluator containing matched, unmatched and invalid - rules. - actionExecutorOutput: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput + An expression specifies a histogram request against matching + documents for searches. See SearchDocumentsRequest.histogram_queries + for details about syntax. + requirePreciseResultSize: description: >- - Output from Action Executor containing rule and corresponding - actions execution result. - documentName: - type: string + Controls if the histogram query requires the return of a precise + count. Enable this flag may adversely impact performance. Defaults + to true. + type: boolean + filters: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter description: >- - Name of the document against which the rules and actions were - evaluated. + Optional. Filter the result of histogram query by the property + names. It only works with histogram query + count('FilterableProperties'). It is an optional. It will perform + histogram on all the property names for all the document schemas. + Setting this field will have a better performance. + id: GoogleCloudContentwarehouseV1HistogramQuery + description: The histogram request. type: object - description: >- - Records the output of Rule Engine including rule evaluation and actions - result. - CloudAiPlatformTenantresourceInfraSpannerConfig: + GoogleTypePostalAddress: properties: - spannerNamespace: - type: string - kmsKeyReference: - type: string + revision: + type: integer description: >- - Input [Optional]. The KMS key name or the KMS grant name used for - CMEK encryption. Only set this field when provisioning new Infra - Spanner databases. For existing Infra Spanner databases, this field - will be ignored because CMEK re-encryption is not supported. For - example, projects//locations//keyRings//cryptoKeys/ - spannerUniverse: - type: string + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + format: int32 + regionCode: description: >- - Input [Required]. Every database in Spanner can be identified by the - following path name: /span//: - sdlBundlePath: + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. type: string - description: Input [Required]. The file path to the spanner SDL bundle. - createDatabaseOptions: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + administrativeArea: description: >- - Input [Optional]. The options to create a spanner database. Note: - give the right options to ensure the right KMS key access audit - logging and AxT logging in expected logging category. - spannerLocalNamePrefix: + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. Specifically, for + Spain this is the province and not the autonomous community (e.g. + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. E.g. in Switzerland this + should be left unpopulated. type: string - spannerBorgServiceAccount: + organization: type: string - description: >- - Input [Optional]. The spanner borg service account for delegating - the kms key to. For example, - spanner-infra-cmek-nonprod@system.gserviceaccount.com, for the - nonprod universe. - id: CloudAiPlatformTenantresourceInfraSpannerConfig - type: object - description: 'The configuration for a spanner database provisioning. Next ID: 8' - GoogleCloudContentwarehouseV1Property: - properties: - textValues: - description: String/text property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' - name: + description: Optional. The name of the organization at the address. + locality: type: string description: >- - Required. Must match the name of a PropertyDefinition in the - DocumentSchema. - dateTimeValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' - description: >- - Date time property values. It is not supported by CMEK compliant - deployment. - integerValues: - description: Integer property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' - enumValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' - description: Enum property values. - propertyValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' - description: Nested structured data property values. - floatValues: - description: Float property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' - mapProperty: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' - description: Map property values. - timestampValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' - description: >- - Timestamp property values. It is not supported by CMEK compliant - deployment. - id: GoogleCloudContentwarehouseV1Property - description: Property of a document. - type: object - GoogleCloudContentwarehouseV1ActionOutput: - properties: - outputMessage: - type: string - description: Action execution output message. - actionState: - enum: - - UNKNOWN - - ACTION_SUCCEEDED - - ACTION_FAILED - - ACTION_TIMED_OUT - - ACTION_PENDING - enumDescriptions: - - The unknown state. - - State indicating action executed successfully. - - State indicating action failed. - - State indicating action timed out. - - State indicating action is pending. - description: State of an action. - type: string - actionId: - type: string - description: ID of the action. - id: GoogleCloudContentwarehouseV1ActionOutput - type: object - description: Represents the result of executing an action. - GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: - description: >- - The configuration of processing documents in Document Warehouse with - DocAi processors pipeline. - type: object - properties: - exportFolderPath: + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. + sortingCode: type: string description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. - processorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - description: The CDW processor information. - processorResultsFolderPath: - description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). + sublocality: type: string - documents: + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + addressLines: items: type: string type: array description: >- - The list of all the resource names of the documents to be processed. - Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline - GoogleCloudContentwarehouseV1FloatArray: - type: object - id: GoogleCloudContentwarehouseV1FloatArray - properties: - values: - items: - type: number - format: float - type: array - description: List of float values. - description: Float values. - GoogleCloudDocumentaiV1Vertex: - id: GoogleCloudDocumentaiV1Vertex - properties: - x: - format: int32 - type: integer - description: X coordinate. - 'y': - format: int32 - description: Y coordinate (starts from the top of the image). - type: integer - type: object - description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. - GoogleCloudContentwarehouseV1TimestampArray: - description: Timestamp values. - type: object - id: GoogleCloudContentwarehouseV1TimestampArray - properties: - values: - description: List of timestamp values. + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (e.g. "Austin, TX"), it is important that the line order is + clear. The order of address lines should be "envelope order" for the + country/region of the address. In places where this can vary (e.g. + Japan), address_language is used to make it explicit (e.g. "ja" for + large-to-small ordering and "ja-Latn" or "en" for small-to-large). + This way, the most specific line of an address can be selected based + on the language. The minimum permitted structural representation of + an address consists of a region_code with all remaining information + placed in the address_lines. It would be possible to format such an + address very approximately without geocoding, but no semantic + reasoning could be made about any of the address components until it + was at least partially resolved. Creating an address only containing + a region_code and address_lines, and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). + recipients: + description: >- + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - GoogleCloudDocumentaiV1DocumentShardInfo: - description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. - type: object - id: GoogleCloudDocumentaiV1DocumentShardInfo - properties: - shardIndex: - format: int64 - description: The 0-based index of this shard. + type: string + languageCode: type: string - textOffset: description: >- - The index of the first character in Document.text in the overall - document global text. - format: int64 - type: string - shardCount: - description: Total number of shards. - format: int64 - type: string - GoogleCloudContentwarehouseV1TimestampValue: - id: GoogleCloudContentwarehouseV1TimestampValue - type: object - properties: - textValue: + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + postalCode: description: >- - The string must represent a valid instant in UTC and is parsed using - java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. - "2013-09-29T18:46:19Z" - type: string - timestampValue: - format: google-datetime + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (e.g. state/zip validation in the U.S.A.). type: string - description: Timestamp value - description: Timestamp value type. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: - properties: - blocks: - type: array - description: >- - A table cell is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - colSpan: - type: integer - format: int32 - description: How many columns this cell spans. - rowSpan: - description: How many rows this cell spans. - format: int32 - type: integer - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - description: Represents a cell in a table row. + id: GoogleTypePostalAddress type: object - GoogleCloudContentwarehouseV1CreateDocumentResponse: - id: GoogleCloudContentwarehouseV1CreateDocumentResponse + description: >- + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 + GoogleCloudContentwarehouseV1EnumTypeOptions: + id: GoogleCloudContentwarehouseV1EnumTypeOptions properties: - longRunningOperations: - description: post-processing LROs - type: array + possibleValues: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - ruleEngineOutput: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' - description: >- - Output from Rule Engine recording the rule evaluator and action - executor's output. Refer format in: - google/cloud/contentwarehouse/v1/rule_engine.proto - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Document created after executing create request. - metadata: + type: string + type: array + description: Required. List of possible enum values. + validationCheckDisabled: + type: boolean description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - type: object - description: Response message for DocumentService.CreateDocument. - GoogleCloudContentwarehouseV1MapProperty: + Make sure the Enum property value provided in the document is in the + possile value list during document creation. The validation check + runs by default. + description: Configurations for an enum/categorical property. type: object - id: GoogleCloudContentwarehouseV1MapProperty - description: >- - Map property value. Represents a structured entries of key value pairs, - consisting of field names which map to dynamically typed values. - properties: - fields: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' - description: Unordered map of dynamically typed values. - type: object - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - description: Human Review information of the document. - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + GoogleCloudContentwarehouseV1DateTimeTypeOptions: + id: GoogleCloudContentwarehouseV1DateTimeTypeOptions + description: Configurations for a date time property. + properties: {} type: object + GoogleCloudDocumentaiV1DocumentPageLayout: properties: - state: - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - type: string - stateMessage: + boundingPoly: + description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + orientation: + enumDescriptions: + - Unspecified orientation. + - Orientation is aligned with page up. + - >- + Orientation is aligned with page right. Turn the head 90 degrees + clockwise from upright to read. + - >- + Orientation is aligned with page down. Turn the head 180 degrees + from upright to read. + - >- + Orientation is aligned with page left. Turn the head 90 degrees + counterclockwise from upright to read. type: string + description: Detected orientation for the Layout. + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + confidence: description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - GoogleCloudContentwarehouseV1UpdateDocumentMetadata: - description: Metadata object for UpdateDocument request (currently empty). + Confidence of the current Layout within context of the object this + layout is for. e.g. confidence can be for a single token, a table, a + visual element, etc. depending on context. Range `[0, 1]`. + format: float + type: number type: object - id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata - properties: {} - CloudAiPlatformTenantresourceTenantProjectResource: + id: GoogleCloudDocumentaiV1DocumentPageLayout + description: Visual element describing a layout unit on a page. + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + description: Parsed and normalized entity value. + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue properties: - iamPolicyBindings: - type: array - items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' + datetimeValue: + $ref: '#/components/schemas/GoogleTypeDateTime' description: >- - The dynamic IAM bindings that are granted under the tenant project. - Note: this should only add new bindings to the project if they don't - exist and the existing bindings won't be affected. - gcsBuckets: - type: array - description: The GCS buckets that are provisioned under the tenant project. - items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' - tenantProjectNumber: - format: int64 + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + text: + description: >- + Optional. An optional field to store a normalized string. For some + entity types, one of respective `structured_value` fields may also + be populated. Also not all the types of `structured_value` will be + normalized. For example, some processors may not generate `float` or + `integer` normalized text by default. Below are sample formats + mapped to structured values. - Money/Currency type (`money_value`) + is in the ISO 4217 text format. - Date type (`date_value`) is in the + ISO 8601 text format. - Datetime type (`datetime_value`) is in the + ISO 8601 text format. type: string - description: Output only. The tenant project number that has been created. - cloudSqlInstances: + moneyValue: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - The CloudSQL instances that are provisioned under the tenant - project. + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + booleanValue: + type: boolean + description: >- + Boolean value. Can be used for entities with binary values, or for + checkboxes. + dateValue: + description: >- + Date value. Includes year, month, day. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + $ref: '#/components/schemas/GoogleTypeDate' + integerValue: + description: Integer value. + format: int32 + type: integer + floatValue: + format: float + description: Float value. + type: number + addressValue: + $ref: '#/components/schemas/GoogleTypePostalAddress' + description: >- + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + type: object + GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: + description: The status of processing a document. + properties: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status processing the document. + documentId: + type: string + description: Document identifier of an existing document. + type: object + id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: + type: object + properties: + pageEnd: + format: int32 + description: Page where chunk ends in the document. + type: integer + pageStart: + type: integer + format: int32 + description: Page where chunk starts in the document. + description: Represents where the chunk starts and ends in the document. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + GoogleTypeDateTime: + description: >- + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. + id: GoogleTypeDateTime + properties: + day: + format: int32 + description: >- + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + type: integer + hours: + type: integer + description: >- + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. + format: int32 + month: + type: integer + description: >- + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + format: int32 + timeZone: + $ref: '#/components/schemas/GoogleTypeTimeZone' + description: Time zone. + year: + format: int32 + description: >- + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. + type: integer + utcOffset: + format: google-duration + description: >- + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. + type: string + minutes: + type: integer + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + format: int32 + nanos: + format: int32 + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + type: integer + seconds: + format: int32 + description: >- + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. + type: integer + type: object + GoogleCloudContentwarehouseV1DocumentSchema: + properties: + propertyDefinitions: type: array + description: Document details. items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig - tenantProjectId: + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + documentIsFolder: + type: boolean + description: >- + Document Type, true refers the document is a folder, otherwise it is + a typical document. + description: + type: string + description: Schema description. + displayName: type: string - description: Output only. The tenant project ID that has been created. - tenantProjectConfig: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectConfig - description: The configurations of a tenant project. - infraSpannerConfigs: - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig - type: array description: >- - The Infra Spanner databases that are provisioned under the tenant - project. Note: this is an experimental feature. - tenantServiceAccounts: + Required. Name of the schema given by the user. Must be unique per + project. + name: + description: >- + The resource name of the document schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + The name is ignored when creating a document schema. + type: string + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. The time when the document schema is created. + updateTime: + readOnly: true + format: google-datetime + description: Output only. The time when the document schema is last updated. + type: string + id: GoogleCloudContentwarehouseV1DocumentSchema + type: object + description: A document schema used to define document structure. + GoogleCloudDocumentaiV1DocumentTextAnchor: + properties: + textSegments: items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment type: array + description: The text segments from the Document.text. + content: description: >- - The service account identities (or enabled API service's P4SA) that - are expclicitly created under the tenant project (before JIT - provisioning during enabled API services). - tag: + Contains the content of the text span so that users do not have to + look it up in the text_segments. It is always populated for + formFields. type: string - description: >- - Input/Output [Required]. The tag that uniquely identifies a tenant - project within a tenancy unit. Note: for the same tenant project - tag, all tenant manager operations should be idempotent. - id: CloudAiPlatformTenantresourceTenantProjectResource + description: Text reference indexing into the Document.text. + id: GoogleCloudDocumentaiV1DocumentTextAnchor type: object - description: 'The tenant project and tenant resources. Next ID: 10' - GoogleCloudContentwarehouseV1AccessControlAction: - description: >- - Represents the action responsible for access control list management - operations. - id: GoogleCloudContentwarehouseV1AccessControlAction + CloudAiPlatformTenantresourceIamPolicyBinding: type: object properties: - operationType: - description: Identifies the type of operation. + resourceType: + description: >- + Input/Output [Required]. Specifies the type of resource that will be + accessed by members. type: string - enum: - - UNKNOWN - - ADD_POLICY_BINDING - - REMOVE_POLICY_BINDING - - REPLACE_POLICY_BINDING enumDescriptions: - - The unknown operation type. - - Adds newly given policy bindings in the existing bindings list. + - '' - >- - Removes newly given policy bindings from the existing bindings - list. + The value of resource field is the ID or number of a project. + Format is - >- - Replaces existing policy bindings with the given policy binding - list - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: >- - Represents the new policy from which bindings are added, removed or - replaced based on the type of the operation. the policy is limited - to a few 10s of KB. - GoogleCloudContentwarehouseV1MergeFieldsOptions: - type: object - description: Options for merging updated fields. - properties: - replaceRepeatedFields: - description: >- - When merging repeated fields, the default behavior is to append - entries from the source repeated field to the destination repeated - field. If you instead want to keep only the entries from the source - repeated field, set this flag to true. If you want to replace a - repeated field within a message field on the destination message, - you must set both replace_repeated_fields and replace_message_fields - to true, otherwise the repeated fields will be appended. - type: boolean - replaceMessageFields: - type: boolean + The value of resource field is the resource name of a service + account. Format is projects//serviceAccounts/ + - >- + The value of resource field is the name of a GCS bucket (not its + resource name). Format is . + - >- + The value of resource field is the resource name of a service + consumer. Format is services//consumers/ + - >- + The value of the resource field is the AR Image Uri which + identifies an AR REPO. Allowed formats are: /// ///: ///@ + enum: + - RESOURCE_TYPE_UNSPECIFIED + - PROJECT + - SERVICE_ACCOUNT + - GCS_BUCKET + - SERVICE_CONSUMER + - AR_REPO + members: + items: + type: string + type: array description: >- - When merging message fields, the default behavior is to merge the - content of two message fields together. If you instead want to use - the field from the source message to replace the corresponding field - in the destination message, set this flag to true. When this flag is - set, specified submessage fields that are missing in source will be - cleared in destination. - id: GoogleCloudContentwarehouseV1MergeFieldsOptions - GoogleTypeColor: - id: GoogleTypeColor - type: object + Input/Output [Required]. The member service accounts with the roles + above. Note: placeholders are same as the resource above. + resource: + description: >- + Input/Output [Required]. The resource name that will be accessed by + members, which also depends on resource_type. Note: placeholders are + supported in resource names. For example, ${tpn} will be used when + the tenant project number is not ready. + type: string + role: + description: Input/Output [Required]. The role for members below. + type: string + id: CloudAiPlatformTenantresourceIamPolicyBinding description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... + The dynamic IAM bindings to be granted after tenant projects are + created. + GoogleCloudContentwarehouseV1FloatArray: + description: Float values. + id: GoogleCloudContentwarehouseV1FloatArray properties: - green: - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - format: float - red: - description: The amount of red in the color as a value in the interval [0, 1]. - format: float - type: number - alpha: - format: float - type: number + values: + type: array + items: + format: float + type: number + description: List of float values. + type: object + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + description: Detected language for a structural component. + type: object + properties: + languageCode: description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - blue: - format: float - description: The amount of blue in the color as a value in the interval [0, 1]. + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. + type: string + confidence: type: number - GoogleCloudContentwarehouseV1RunPipelineMetadata: - description: Metadata message of RunPipeline method. + description: Confidence of detected language. Range `[0, 1]`. + format: float + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleApiServiceconsumermanagementV1PolicyBinding: + id: GoogleApiServiceconsumermanagementV1PolicyBinding + type: object properties: - individualDocumentStatuses: - type: array - description: The list of response details of each document. + members: + description: >- + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - exportToCdwPipelineMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata - description: The pipeline metadata for Export-to-CDW pipeline. - userInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: User unique identification and groups information. - totalFileCount: - description: Number of files that were processed by the pipeline. - format: int32 - type: integer - processWithDocAiPipelineMetadata: - description: The pipeline metadata for Process-with-DocAi pipeline. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata - gcsIngestPipelineMetadata: - description: The pipeline metadata for GcsIngest pipeline. + type: string + type: array + role: + type: string + description: >- + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. + description: Translates to IAM Policy bindings (without auditing at this level) + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + properties: + pageSpan: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata - failedFileCount: - type: integer - format: int32 - description: Number of files that have failed at some point in the pipeline. + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the footer. + text: + type: string + description: Footer in text format. + description: Represents the page footer associated with the chunk. type: object - id: GoogleCloudContentwarehouseV1RunPipelineMetadata - GoogleCloudContentwarehouseV1PropertyFilter: - id: GoogleCloudContentwarehouseV1PropertyFilter + GoogleCloudContentwarehouseV1ProcessorInfo: type: object + id: GoogleCloudContentwarehouseV1ProcessorInfo properties: - documentSchemaName: + processorName: + type: string description: >- - The Document schema name Document.document_schema_name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + The processor resource name. Format is + `projects/{project}/locations/{location}/processors/{processor}`, or + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + documentType: type: string - condition: + description: The processor will process the documents with this document type. + schemaName: description: >- - The filter condition. The syntax for this expression is a subset of - SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, - `>=`, and `~~` where the left of the operator is a property name and - the right of the operator is a number or a quoted string. You must - escape backslash (\\) and quote (\") characters. `~~` is the LIKE - operator. The right of the operator must be a string. The only - supported property data type for LIKE is text_values. It provides - semantic search functionality by parsing, stemming and doing - synonyms expansion against the input query. It matches if the - property contains semantic similar content to the query. It is not - regex matching or wildcard matching. For example, "property.company - ~~ \"google\"" will match records whose property `property.compnay` - have values like "Google Inc.", "Google LLC" or "Google Company". - Supported functions are `LOWER([property_name])` to perform a case - insensitive match and `EMPTY([property_name])` to filter on the - existence of a key. Boolean expressions (AND/OR/NOT) are supported - up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) - AND E"), a maximum of 100 comparisons or functions are allowed in - the expression. The expression must be < 6000 bytes in length. Only - properties that are marked filterable are allowed - (PropertyDefinition.is_filterable). Property names do not need to be - prefixed by the document schema id (as is the case with histograms), - however property names will need to be prefixed by its parent - hierarchy, if any. For example: top_property_name.sub_property_name. - Sample Query: `(LOWER(driving_license)="class \"a\"" OR - EMPTY(driving_license)) AND driving_years > 10` CMEK compliant - deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and - `>=`. * Boolean expressions: AND and OR. + The Document schema resource name. All documents processed by this + processor will use this schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. type: string - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - properties: - service: - description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - type: string - auditLogConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - description: The configuration for logging of each type of permission. - type: object - GoogleCloudDocumentaiV1DocumentProvenanceParent: - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - type: object - id: GoogleCloudDocumentaiV1DocumentProvenanceParent - properties: - id: - deprecated: true - description: The id of the parent provenance. - format: int32 - type: integer - index: - format: int32 - type: integer - description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. - revision: - description: The index of the index into current revision's parent_ids list. - type: integer - format: int32 - GoogleProtobufEmpty: - id: GoogleProtobufEmpty - 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); } + description: The DocAI processor information. + GoogleCloudContentwarehouseV1TimestampArray: type: object - properties: {} - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: properties: - pageEnd: - format: int32 - type: integer - description: Page where block ends in the document. - pageStart: - type: integer - description: Page where block starts in the document. - format: int32 - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + values: + description: List of timestamp values. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + type: array + description: Timestamp values. + id: GoogleCloudContentwarehouseV1TimestampArray + GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: + id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline type: object - description: Represents where the block starts and ends in the document. - GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: - description: Response message for DocumentLinkService.ListLinkedSources. - id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse properties: - nextPageToken: + processorResultsFolderPath: type: string 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. - documentLinks: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - description: Source document-links. - type: object - GoogleCloudContentwarehouseV1EnumArray: - type: object - description: Enum values. - id: GoogleCloudContentwarehouseV1EnumArray - properties: - values: + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. + documents: + description: >- + The list of all the resource names of the documents to be processed. + Format: + projects/{project_number}/locations/{location}/documents/{document_id}. items: type: string - description: List of enum values. type: array - CloudAiPlatformTenantresourceGcsBucketConfig: - properties: - bucketName: + processorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The CDW processor information. + exportFolderPath: type: string description: >- - Input/Output [Optional]. The name of a GCS bucket with max length of - 63 chars. If not set, a random UUID will be generated as bucket - name. - kmsKeyReference: + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. + description: >- + The configuration of processing documents in Document Warehouse with + DocAi processors pipeline. + GoogleTypeExpr: + type: object + id: GoogleTypeExpr + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + properties: + location: type: string description: >- - Input/Output [Optional]. The KMS key name or the KMS grant name used - for CMEK encryption. Only set this field when provisioning new GCS - bucket. For existing GCS bucket, this field will be ignored because - CMEK re-encryption is not supported. - admins: - type: array - items: - type: string - entityName: + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + expression: description: >- - Input/Output [Optional]. Only needed for per-entity tenant GCP - resources. During Deprovision API, the on-demand deletion will only - cover the tenant GCP resources with the specified entity name. + Textual representation of an expression in Common Expression + Language syntax. type: string - viewers: - description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. + title: + type: string + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + description: + type: string + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + description: Represents a list type block. + properties: + listEntries: + description: List entries that constitute a list block. items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry type: array - ttlDays: - type: integer + type: description: >- - Input/Output [Optional]. Only needed when the content in bucket need - to be garbage collected within some amount of days. - format: int32 - description: The identity to configure a GCS bucket. - id: CloudAiPlatformTenantresourceGcsBucketConfig + Type of the list_entries (if exist). Available options are `ordered` + and `unordered`. + type: string type: object - GoogleCloudContentwarehouseV1TimeFilter: + GoogleCloudDocumentaiV1DocumentPageDimension: type: object - description: Filter on create timestamp or update timestamp of documents. - id: GoogleCloudContentwarehouseV1TimeFilter + id: GoogleCloudDocumentaiV1DocumentPageDimension properties: - timeField: - enumDescriptions: - - Default value. - - Earliest document create time. - - Latest document update time. - - Time when document becomes mutable again. - description: >- - Specifies which time field to filter documents on. Defaults to - TimeField.UPLOAD_TIME. + unit: type: string - enum: - - TIME_FIELD_UNSPECIFIED - - CREATE_TIME - - UPDATE_TIME - - DISPOSITION_TIME - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: - properties: - cells: - description: A table row is a list of table cells. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - description: Represents a row in a table. - CloudAiPlatformTenantresourceTenantResource: + description: Dimension unit. + height: + type: number + format: float + description: Page height. + width: + type: number + description: Page width. + format: float + description: Dimension for the page. + GoogleRpcStatus: type: object - description: A collection of tenant resources. - id: CloudAiPlatformTenantresourceTenantResource properties: - tenantProjectResources: + details: description: >- - A list of tenant projects and tenant resources to provision or - deprovision. - type: array - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource - p4ServiceAccounts: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - description: A list of P4 service accounts (go/p4sa) to provision or deprovision. items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity - GoogleTypePostalAddress: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + code: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - id: GoogleTypePostalAddress + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus + GoogleCloudContentwarehouseV1Value: + description: >- + `Value` represents a dynamically typed value which can be either be a + float, a integer, a string, or a datetime value. A producer of value is + expected to set one of these variants. Absence of any variant indicates + an error. type: object + id: GoogleCloudContentwarehouseV1Value properties: - sublocality: - description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. + stringValue: + description: Represents a string value. type: string - recipients: - items: - type: string - type: array - description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. - revision: + timestampValue: + description: Represents a timestamp value. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + floatValue: + description: Represents a float value. + type: number + format: float + intValue: + format: int32 type: integer + description: Represents a integer value. + datetimeValue: + description: Represents a datetime value. + $ref: '#/components/schemas/GoogleTypeDateTime' + booleanValue: + description: Represents a boolean value. + type: boolean + enumValue: + description: Represents an enum value. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' + GoogleCloudContentwarehouseV1MergeFieldsOptions: + description: Options for merging updated fields. + type: object + properties: + replaceRepeatedFields: description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - format: int32 - sortingCode: + When merging repeated fields, the default behavior is to append + entries from the source repeated field to the destination repeated + field. If you instead want to keep only the entries from the source + repeated field, set this flag to true. If you want to replace a + repeated field within a message field on the destination message, + you must set both replace_repeated_fields and replace_message_fields + to true, otherwise the repeated fields will be appended. + type: boolean + replaceMessageFields: description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). - type: string - organization: + When merging message fields, the default behavior is to merge the + content of two message fields together. If you instead want to use + the field from the source message to replace the corresponding field + in the destination message, set this flag to true. When this flag is + set, specified submessage fields that are missing in source will be + cleared in destination. + type: boolean + id: GoogleCloudContentwarehouseV1MergeFieldsOptions + GoogleCloudContentwarehouseV1DeleteDocumentRequest: + id: GoogleCloudContentwarehouseV1DeleteDocumentRequest + properties: + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + description: Request message for DocumentService.DeleteDocument. + type: object + GoogleCloudContentwarehouseV1DocumentLink: + description: A document-link between source and target document. + properties: + updateTime: + readOnly: true + description: Output only. The time when the documentLink is last updated. + format: google-datetime type: string - description: Optional. The name of the organization at the address. - postalCode: + name: type: string description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). - addressLines: + Name of this document-link. It is required that the parent derived + form the name to be consistent with the source document reference. + Otherwise an exception will be thrown. Format: + projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. + createTime: + format: google-datetime + type: string + description: Output only. The time when the documentLink is created. + readOnly: true + state: + type: string + enum: + - STATE_UNSPECIFIED + - ACTIVE + - SOFT_DELETED + enumDescriptions: + - Unknown state of documentlink. + - The documentlink has both source and target documents detected. + - >- + Target document is deleted, and mark the documentlink as + soft-deleted. description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). - type: array - items: - type: string - administrativeArea: + The state of the documentlink. If target node has been deleted, the + link is marked as invalid. Removing a source node will result in + removal of all associated links. + description: + description: Description of this document-link. type: string + targetDocumentReference: + description: Document references of the target document. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + sourceDocumentReference: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + description: Document references of the source document. + id: GoogleCloudContentwarehouseV1DocumentLink + type: object + CloudAiPlatformTenantresourceInfraSpannerConfig: + description: 'The configuration for a spanner database provisioning. Next ID: 8' + type: object + id: CloudAiPlatformTenantresourceInfraSpannerConfig + properties: + kmsKeyReference: description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. - locality: + Input [Optional]. The KMS key name or the KMS grant name used for + CMEK encryption. Only set this field when provisioning new Infra + Spanner databases. For existing Infra Spanner databases, this field + will be ignored because CMEK re-encryption is not supported. For + example, projects//locations//keyRings//cryptoKeys/ + type: string + sdlBundlePath: + type: string + description: Input [Required]. The file path to the spanner SDL bundle. + createDatabaseOptions: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. + Input [Optional]. The options to create a spanner database. Note: + give the right options to ensure the right KMS key access audit + logging and AxT logging in expected logging category. + spannerUniverse: type: string - regionCode: description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. + Input [Required]. Every database in Spanner can be identified by the + following path name: /span//: + spannerNamespace: type: string - languageCode: + spannerLocalNamePrefix: type: string + spannerBorgServiceAccount: description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - GoogleCloudContentwarehouseV1PublishAction: - properties: - messages: - type: array - items: - type: string - description: Messages to be published. - topicId: + Input [Optional]. The spanner borg service account for delegating + the kms key to. For example, + spanner-infra-cmek-nonprod@system.gserviceaccount.com, for the + nonprod universe. type: string - description: >- - The topic id in the Pub/Sub service for which messages will be - published to. + GoogleCloudContentwarehouseV1ListSynonymSetsResponse: type: object - id: GoogleCloudContentwarehouseV1PublishAction - description: >- - Represents the action responsible for publishing messages to a Pub/Sub - topic. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: properties: - textBlock: - description: Block consisting of text content. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - tableBlock: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - description: Block consisting of table content/structure. - listBlock: - description: Block consisting of list content/structure. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - blockId: + synonymSets: + description: The synonymSets from the specified parent. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + type: array + nextPageToken: type: string - description: ID of the block. - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - description: Page span of the block. - id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - description: >- - Represents a block. A block could be one of the various types (text, - table, list) supported. - type: object - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: - properties: - confidence: - format: float - type: number - description: Confidence of detected language. Range `[0, 1]`. - languageCode: description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. - type: string - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + A page token, received from a previous `ListSynonymSets` call. + Provide this to retrieve the subsequent page. + description: Response message for SynonymSetService.ListSynonymSets. + id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse + GoogleCloudDocumentaiV1DocumentPageBlock: type: object - description: Detected language for a structural component. - GoogleCloudContentwarehouseV1EnumTypeOptions: - description: Configurations for an enum/categorical property. + description: >- + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. + id: GoogleCloudDocumentaiV1DocumentPageBlock properties: - possibleValues: - description: Required. List of possible enum values. + detectedLanguages: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array - validationCheckDisabled: - type: boolean - description: >- - Make sure the Enum property value provided in the document is in the - possile value list during document creation. The validation check - runs by default. - id: GoogleCloudContentwarehouseV1EnumTypeOptions - type: object - GoogleCloudDocumentaiV1DocumentTextChange: - id: GoogleCloudDocumentaiV1DocumentTextChange - description: This message is used for text changes aka. OCR corrections. - properties: + description: A list of detected languages together with confidence. provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' description: The history of this annotation. deprecated: true + layout: + description: Layout for Block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: + properties: + documentSchemas: + description: >- + This filter specifies the exact document schema(s) + Document.document_schema_name to run histogram query against. It is + optional. It will perform histogram for property names for all the + document schemas if it is not set. At most 10 document schema names + are allowed. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + type: string type: array - changedText: - type: string - description: The text that replaces the text identified in the `text_anchor`. - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + propertyNames: description: >- - Provenance of the correction. Text anchor indexing into the - Document.text. There can only be a single `TextAnchor.text_segments` - element. If the start and end index of the text segment are the - same, the text change is inserted before that index. - type: object - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - type: object - properties: - type: - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - type: string - description: Detected break type. - description: Detected break at the end of a Token. - GoogleCloudDocumentaiV1DocumentTextAnchor: - type: object - properties: - textSegments: + It is optional. It will perform histogram for all the property names + if it is not set. The properties need to be defined with the + is_filterable flag set to true and the name of the property should + be in the format: "schemaId.propertyName". The property needs to be + defined in the schema. Example: the schema id is abc. Then the name + of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE". items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + type: string type: array - description: The text segments from the Document.text. - content: + yAxis: + enum: + - HISTOGRAM_YAXIS_DOCUMENT + - HISTOGRAM_YAXIS_PROPERTY + enumDescriptions: + - Count the documents per property name. + - Count the properties per property name. description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. + By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is + not set. type: string - description: Text reference indexing into the Document.text. - id: GoogleCloudDocumentaiV1DocumentTextAnchor - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: - description: A detected barcode. - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - type: object - properties: - layout: - description: Layout for DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - barcode: - description: Detailed barcode information of the DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - GoogleCloudDocumentaiV1DocumentEntityRelation: - id: GoogleCloudDocumentaiV1DocumentEntityRelation type: object - description: Relationship between Entities. + id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter + CloudAiPlatformTenantresourceGcsBucketConfig: properties: - subjectId: + entityName: + description: >- + Input/Output [Optional]. Only needed for per-entity tenant GCP + resources. During Deprovision API, the on-demand deletion will only + cover the tenant GCP resources with the specified entity name. type: string - description: Subject entity id. - relation: + ttlDays: + description: >- + Input/Output [Optional]. Only needed when the content in bucket need + to be garbage collected within some amount of days. + format: int32 + type: integer + kmsKeyReference: type: string - description: Relationship description. - objectId: + description: >- + Input/Output [Optional]. The KMS key name or the KMS grant name used + for CMEK encryption. Only set this field when provisioning new GCS + bucket. For existing GCS bucket, this field will be ignored because + CMEK re-encryption is not supported. + bucketName: type: string - description: Object entity id. - GoogleCloudContentwarehouseV1FileTypeFilter: - id: GoogleCloudContentwarehouseV1FileTypeFilter + description: >- + Input/Output [Optional]. The name of a GCS bucket with max length of + 63 chars. If not set, a random UUID will be generated as bucket + name. + admins: + type: array + items: + type: string + viewers: + items: + type: string + description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. + type: array type: object - description: Filter for the specific types of documents returned. + description: The identity to configure a GCS bucket. + id: CloudAiPlatformTenantresourceGcsBucketConfig + GoogleCloudContentwarehouseV1SearchDocumentsRequest: properties: - fileType: - enumDescriptions: - - Default document type. If set, disables the filter. - - Returns all document types, including folders. - - Returns only folders. - - Returns only non-folder documents. - - Returns only root folders + pageToken: type: string - enum: - - FILE_TYPE_UNSPECIFIED - - ALL - - FOLDER - - DOCUMENT - - ROOT_FOLDER - description: The type of files to return. - GoogleCloudContentwarehouseV1SetAclResponse: - id: GoogleCloudContentwarehouseV1SetAclResponse - type: object - description: Response message for DocumentService.SetAcl. - properties: - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: The policy will be attached to a resource (e.g. projecct, document). - metadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- - Additional information for the API invocation, such as the request - tracking id. - GoogleCloudDocumentaiV1DocumentPageToken: - properties: - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Text style attributes. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this annotation. - detectedBreak: - description: Detected break at the end of a Token. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - id: GoogleCloudDocumentaiV1DocumentPageToken - type: object - description: A detected token. - GoogleCloudDocumentaiV1DocumentPageSymbol: - properties: - detectedLanguages: - description: A list of detected languages together with confidence. + The token specifying the current offset within search results. See + SearchDocumentsResponse.next_page_token for an explanation of how to + obtain the next set of query results. + offset: + description: >- + An integer that specifies the current offset (that is, starting + result location, amongst the documents deemed by the API as + relevant) in search results. This field is only considered if + page_token is unset. The maximum allowed value is 5000. Otherwise an + error is thrown. For example, 0 means to return results starting + from the first matching document, and 10 means to return from the + 11th document. This can be used for pagination, (for example, + pageSize = 10 and offset = 10 means to return from the second page). + format: int32 + type: integer + totalResultSize: + type: string + enum: + - TOTAL_RESULT_SIZE_UNSPECIFIED + - ESTIMATED_SIZE + - ACTUAL_SIZE + description: >- + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. + enumDescriptions: + - Total number calculation will be skipped. + - >- + Estimate total number. The total result size will be accurated up + to 10,000. This option will add cost and latency to your request. + - It may adversely impact performance. The limit is 1000,000. + documentQuery: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' + description: Query used to search against documents (keyword, filters, etc.). + pageSize: + type: integer + format: int32 + description: >- + A limit on the number of documents returned in the search results. + Increasing this value above the default value of 10 can increase + search response time. The value can be between 1 and 100. + histogramQueries: + description: >- + An expression specifying a histogram request against matching + documents. Expression syntax is an aggregation function call with + histogram facets and other options. The following aggregation + functions are supported: * `count(string_histogram_facet)`: Count + the number of matching entities for each distinct attribute value. + Data types: * Histogram facet (aka filterable properties): Facet + names with format .. Facets will have the format + of: `a-zA-Z`. If the facet is a child facet, then the parent + hierarchy needs to be specified separated by dots in the prefix + after the schema id. Thus, the format for a multi- level facet is: + .. . Example: + schema123.root_parent_facet.middle_facet.child_facet * + DocumentSchemaId: (with no schema id prefix) to get histograms for + each document type (returns the schema id path, e.g. + projects/12345/locations/us-west/documentSchemas/abc123). Example + expression: * Document type counts: count('DocumentSchemaId') * For + schema id, abc123, get the counts for MORTGAGE_TYPE: + count('abc123.MORTGAGE_TYPE') type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - layout: - description: Layout for Symbol. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - id: GoogleCloudDocumentaiV1DocumentPageSymbol - description: A detected symbol. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' + orderBy: + description: >- + The criteria determining how search results are sorted. For + non-empty query, default is `"relevance desc"`. For empty query, + default is `"upload_date desc"`. Supported options are: * + `"relevance desc"`: By relevance descending, as determined by the + API algorithms. * `"upload_date desc"`: By upload date descending. * + `"upload_date"`: By upload date ascending. * `"update_date desc"`: + By last updated date descending. * `"update_date"`: By last updated + date ascending. * `"retrieval_importance desc"`: By retrieval + importance of properties descending. This feature is still under + development, please do not use unless otherwise instructed to do so. + type: string + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the end user, used to enforce + access control and improve the search quality of the service. + requireTotalSize: + description: >- + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. Enabling this flag may adversely + impact performance. Hint: If this is used with pagination, set this + flag on the initial query but set this to false on subsequent page + calls (keep the total count locally). Defaults to false. + type: boolean + qaSizeLimit: + type: integer + format: int32 + description: >- + Experimental, do not use. The limit on the number of documents + returned for the question-answering feature. To enable the + question-answering feature, set [DocumentQuery].is_nl_query to true. type: object - CloudAiPlatformTenantresourceCloudSqlInstanceConfig: + id: GoogleCloudContentwarehouseV1SearchDocumentsRequest + description: Request message for DocumentService.SearchDocuments. + GoogleCloudContentwarehouseV1Rule: + id: GoogleCloudContentwarehouseV1Rule type: object - id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig - description: >- - The identity to configure a CloudSQL instance provisioned via SLM - Terraform. + description: Represents the rule for a content warehouse trigger. properties: - kmsKeyReference: + description: + type: string + description: Short description of the rule and its context. + ruleId: + type: string description: >- - Input [Optional]. The KMS key name or the KMS grant name used for - CMEK encryption. Only set this field when provisioning new CloudSQL - instances. For existing CloudSQL instances, this field will be - ignored because CMEK re-encryption is not supported. + ID of the rule. It has to be unique across all the examples. This is + managed internally. + triggerType: + enum: + - UNKNOWN + - ON_CREATE + - ON_UPDATE + - ON_CREATE_LINK + - ON_DELETE_LINK + description: Identifies the trigger type for running the policy. + enumDescriptions: + - Trigger for unknown action. + - Trigger for create document action. + - Trigger for update document action. + - Trigger for create link action. + - Trigger for delete link action. type: string - cloudSqlInstanceName: + condition: description: >- - Input/Output [Optional]. The CloudSQL instance name within SLM - instance. If not set, a random UUIC will be generated as instance - name. + Represents the conditional expression to be evaluated. Expression + should evaluate to a boolean result. When the condition is true + actions are executed. Example: user_role = "hsbc_role_1" AND + doc.salary > 20000 type: string - mdbRolesForCorpAccess: + actions: items: - type: string + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' type: array - description: Input [Optional]. MDB roles for corp access to CloudSQL instance. - slmInstanceType: - type: string - description: Input [Required]. The SLM instance type to provision CloudSQL. - cloudSqlInstanceConnectionName: - description: Output only. The CloudSQL instance connection name. - type: string - slmInstanceName: - description: Output only. The SLM instance's full resource name. - type: string - slmInstanceTemplate: - type: string - description: Input [Required]. The SLM instance template to provision CloudSQL. - GoogleCloudContentwarehouseV1DocumentSchema: + description: List of actions that are executed when the rule is satisfied. + GoogleCloudContentwarehouseV1QAResultHighlight: + type: object + properties: + startIndex: + description: Start index of the highlight. + type: integer + format: int32 + endIndex: + type: integer + format: int32 + description: End index of the highlight, exclusive. + description: >- + A text span in the search text snippet that represents a highlighted + section (answer context, highly relevant sentence, etc.). + id: GoogleCloudContentwarehouseV1QAResultHighlight + GoogleCloudContentwarehouseV1DocumentReference: + id: GoogleCloudContentwarehouseV1DocumentReference type: object properties: - updateTime: - type: string - description: Output only. The time when the document schema is last updated. - format: google-datetime - readOnly: true - propertyDefinitions: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition - description: Document details. - type: array createTime: - description: Output only. The time when the document schema is created. - type: string - format: google-datetime readOnly: true + description: Output only. The time when the document is created. + format: google-datetime + type: string + documentIsLegalHoldFolder: + type: boolean + description: Document is a folder with legal hold. + documentIsRetentionFolder: + description: Document is a folder with retention policy. + type: boolean documentIsFolder: type: boolean - description: >- - Document Type, true refers the document is a folder, otherwise it is - a typical document. - name: - description: >- - The resource name of the document schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - The name is ignored when creating a document schema. - type: string - description: + description: The document type of the document being referenced. + documentName: type: string - description: Schema description. - displayName: + description: Required. Name of the referenced document. + updateTime: + readOnly: true + format: google-datetime type: string + description: Output only. The time when the document is last updated. + snippet: description: >- - Required. Name of the schema given by the user. Must be unique per - project. - description: A document schema used to define document structure. - id: GoogleCloudContentwarehouseV1DocumentSchema - GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: - properties: {} - description: Metadata object for UpdateDocument request (currently empty). - type: object - id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata - GoogleCloudContentwarehouseV1ActionExecutorOutput: - id: GoogleCloudContentwarehouseV1ActionExecutorOutput - properties: - ruleActionsPairs: - type: array - description: List of rule and corresponding actions result. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' - type: object - description: Represents the output of the Action Executor. - GoogleCloudContentwarehouseV1ListRuleSetsResponse: - description: Response message for RuleSetService.ListRuleSets. - properties: - nextPageToken: + Stores the subset of the referenced document's content. This is + useful to allow user peek the information of the referenced + document. type: string + displayName: 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. - ruleSets: - description: The rule sets from the specified parent. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - id: GoogleCloudContentwarehouseV1ListRuleSetsResponse + display_name of the referenced document; this name does not need to + be consistent to the display_name in the Document proto, depending + on the ACL constraint. + type: string + deleteTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The time when the document is deleted. + description: References to the documents. + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + description: A detected barcode. type: object - GoogleCloudContentwarehouseV1QAResult: + properties: + barcode: + description: Detailed barcode information of the DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for DetectedBarcode. + GoogleCloudContentwarehouseV1DateTimeArray: type: object - description: Additional result info for the question-answering feature. + description: DateTime values. + id: GoogleCloudContentwarehouseV1DateTimeArray properties: - highlights: + values: items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight - description: Highlighted sections in the snippet. + $ref: '#/components/schemas/GoogleTypeDateTime' type: array + description: >- + List of datetime values. Both OffsetDateTime and ZonedDateTime are + supported. + GoogleCloudContentwarehouseV1QAResult: + properties: confidenceScore: + type: number description: >- The calibrated confidence score for this document, in the range [0., 1.]. This represents the confidence level for whether the returned document and snippet answers the user's query. format: float - type: number - id: GoogleCloudContentwarehouseV1QAResult - GoogleCloudContentwarehouseV1HistogramQueryResult: + highlights: + description: Highlighted sections in the snippet. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight + type: array type: object - id: GoogleCloudContentwarehouseV1HistogramQueryResult - description: Histogram result that matches HistogramQuery specified in searches. + description: Additional result info for the question-answering feature. + id: GoogleCloudContentwarehouseV1QAResult + GoogleCloudContentwarehouseV1UpdateRuleSetRequest: + id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest properties: - histogram: - additionalProperties: - format: int64 - type: string - description: >- - A map from the values of the facet associated with distinct values - to the number of matching entries with corresponding value. The key - format is: * (for string histogram) string values stored in the - field. - type: object - histogramQuery: - type: string - description: Requested histogram expression. - GoogleCloudDocumentaiV1DocumentStyleFontSize: - id: GoogleCloudDocumentaiV1DocumentStyleFontSize + ruleSet: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + description: Required. The rule set to update. type: object + description: Request message for RuleSetService.UpdateRuleSet. + GoogleCloudContentwarehouseV1LockDocumentRequest: + id: GoogleCloudContentwarehouseV1LockDocumentRequest + description: Request message for DocumentService.LockDocument. properties: - unit: + lockingUser: + description: The user information who locks the document. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + collectionId: + description: The collection the document connects to. type: string - description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - size: - description: Font size for the text. - type: number - format: float - description: Font size with unit. - GoogleCloudContentwarehouseV1TextArray: type: object + GoogleCloudDocumentaiV1DocumentPageVisualElement: + id: GoogleCloudDocumentaiV1DocumentPageVisualElement properties: - values: - type: array - items: - type: string - description: List of text values. - id: GoogleCloudContentwarehouseV1TextArray - description: String/text values. - GoogleCloudContentwarehouseV1DateTimeArray: - description: DateTime values. - id: GoogleCloudContentwarehouseV1DateTimeArray - properties: - values: + detectedLanguages: type: array - description: >- - List of datetime values. Both OffsetDateTime and ZonedDateTime are - supported. items: - $ref: '#/components/schemas/GoogleTypeDateTime' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for VisualElement. + type: + description: Type of the VisualElement. + type: string type: object - GoogleCloudDocumentaiV1DocumentStyle: + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + GoogleCloudContentwarehouseV1ResponseMetadata: + id: GoogleCloudContentwarehouseV1ResponseMetadata + description: >- + Additional information returned to client, such as debugging + information. properties: - fontSize: - description: Font size. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' - textAnchor: - description: Text anchor indexing into the Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - textDecoration: - type: string + requestId: description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - fontFamily: + A unique id associated with this call. This id is logged for + tracking purpose. type: string - description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - fontWeight: + type: object + GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + properties: + startIndex: type: string - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - textStyle: - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. + format: int64 + description: TextSegment start UTF-8 char index in the Document.text. + endIndex: + description: TextSegment half open end UTF-8 char index in the Document.text. type: string - color: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text color. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. - type: object - id: GoogleCloudDocumentaiV1DocumentStyle - GoogleCloudContentwarehouseV1IntegerTypeOptions: - id: GoogleCloudContentwarehouseV1IntegerTypeOptions + format: int64 type: object - description: Configurations for an integer property. - properties: {} - GoogleCloudContentwarehouseV1UpdateDocumentResponse: - description: Response message for DocumentService.UpdateDocument. + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + description: >- + A text segment in the Document.text. The indices may be out of bounds + which indicate that the text extends into another document shard for + large sharded documents. See ShardInfo.text_offset + GoogleCloudContentwarehouseV1RuleEvaluatorOutput: type: object + description: Represents the output of the Rule Evaluator. properties: - ruleEngineOutput: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + invalidRules: + type: array description: >- - Output from Rule Engine recording the rule evaluator and action - executor's output. Refer format in: - google/cloud/contentwarehouse/v1/rule_engine.proto - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Updated document after executing update request. - metadata: + A subset of triggered rules that failed the validation check(s) + after parsing. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' + matchedRules: description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - id: GoogleCloudContentwarehouseV1UpdateDocumentResponse - GoogleCloudContentwarehouseV1PropertyArray: - properties: - properties: - description: List of property values. + A subset of triggered rules that are evaluated true for a given + request. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' type: array + triggeredRules: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - description: Property values. - type: object - id: GoogleCloudContentwarehouseV1PropertyArray - GoogleCloudContentwarehouseV1DataUpdateAction: - properties: - entries: - type: object + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' description: >- - Map of (K, V) -> (valid name of the field, new value of the field) - E.g., ("age", "60") entry triggers update of field age with a value - of 60. If the field is not present then new entry is added. During - update action execution, value strings will be casted to appropriate - types. - additionalProperties: - type: string - id: GoogleCloudContentwarehouseV1DataUpdateAction - description: Represents the action responsible for properties update operations. - type: object - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + List of rules fetched from database for the given request trigger + type. + type: array + id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: type: object - description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset + description: Image quality scores for the page image. + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores properties: - endIndex: - description: TextSegment half open end UTF-8 char index in the Document.text. - format: int64 - type: string - startIndex: - format: int64 - description: TextSegment start UTF-8 char index in the Document.text. - type: string - id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - GoogleCloudDocumentaiV1DocumentPageLine: + detectedDefects: + type: array + description: A list of detected defects. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + qualityScore: + format: float + description: >- + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + type: number + GoogleIamV1AuditLogConfig: type: object - id: GoogleCloudDocumentaiV1DocumentPageLine + id: GoogleIamV1AuditLogConfig description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. properties: - provenance: - description: The history of this annotation. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - layout: - description: Layout for Line. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: - description: A list of detected languages together with confidence. + exemptedMembers: type: array + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - GoogleTypeMoney: - description: Represents an amount of money with its currency type. - properties: - units: + type: string + logType: + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + description: The log type that this config enables. type: string - format: int64 - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - nanos: - format: int32 - type: integer - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - currencyCode: - description: The three-letter currency code defined in ISO 4217. + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + GoogleCloudContentwarehouseV1InvalidRule: + properties: + error: type: string - id: GoogleTypeMoney + description: Validation error on a parsed expression. + rule: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + description: Triggered rule. + id: GoogleCloudContentwarehouseV1InvalidRule + description: A triggered rule that failed the validation check(s) after parsing. type: object GoogleCloudDocumentaiV1DocumentPageFormField: id: GoogleCloudDocumentaiV1DocumentPageFormField - description: A form field detected on the page. type: object properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - valueType: - type: string - description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` - correctedValueText: - type: string - description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. correctedKeyText: + type: string description: >- Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. - type: string + provenance: + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' fieldName: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' description: >- Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. - fieldValue: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the FormField value. valueDetectedLanguages: type: array description: A list of detected languages for value together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + valueType: + description: >- + If the value is non-textual, this field represents the type. Current + valid values are: - blank (this indicates the `field_value` is + normal text) - `unfilled_checkbox` - `filled_checkbox` + type: string + fieldValue: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the FormField value. nameDetectedLanguages: - description: A list of detected languages for name together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages for name together with confidence. type: array - GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: - properties: - 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. + correctedValueText: type: string - documentSchemas: - type: array - description: The document schemas from the specified parent. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - description: Response message for DocumentSchemaService.ListDocumentSchemas. - id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + description: >- + Created for Labeling UI to export value text. If corrections were + made to the text identified by the `field_value.text_anchor`, this + field will contain the correction. + description: A form field detected on the page. + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + description: Detected break at the end of a Token. type: object - GoogleCloudDocumentaiV1DocumentPageDimension: properties: - width: - type: number - description: Page width. - format: float - height: - type: number - description: Page height. - format: float - unit: - description: Dimension unit. + type: + enumDescriptions: + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. type: string + enum: + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN + description: Detected break type. + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: + description: The metadata message for Process-with-DocAi pipeline. + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + properties: + documents: + items: + type: string + type: array + description: >- + The input list of all the resource names of the documents to be + processed. + processorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The DocAI processor to process the documents with. type: object - id: GoogleCloudDocumentaiV1DocumentPageDimension - description: Dimension for the page. - GoogleCloudContentwarehouseV1InitializeProjectResponse: - description: Response message for projectService.InitializeProject + GoogleTypeTimeZone: type: object - id: GoogleCloudContentwarehouseV1InitializeProjectResponse + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). properties: - state: - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - RUNNING + version: + description: Optional. IANA Time Zone Database version number, e.g. "2019a". type: string - description: The state of the project initialization process. - enumDescriptions: - - Clients should never see this. - - Finished project initialization without error. - - Finished project initialization with an error. - - Client canceled the LRO. - - Ask the customer to check the operation for results. - message: + id: + description: IANA Time Zone Database time zone, e.g. "America/New_York". type: string - description: The message of the project initialization process. - GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: + id: GoogleTypeTimeZone + GoogleCloudContentwarehouseV1CreateDocumentResponse: + type: object + id: GoogleCloudContentwarehouseV1CreateDocumentResponse properties: - yAxis: - type: string - enumDescriptions: - - Count the documents per property name. - - Count the properties per property name. + document: + description: Document created after executing create request. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- - By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is - not set. - enum: - - HISTOGRAM_YAXIS_DOCUMENT - - HISTOGRAM_YAXIS_PROPERTY - propertyNames: - items: - type: string - type: array - description: >- - It is optional. It will perform histogram for all the property names - if it is not set. The properties need to be defined with the - is_filterable flag set to true and the name of the property should - be in the format: "schemaId.propertyName". The property needs to be - defined in the schema. Example: the schema id is abc. Then the name - of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE". - documentSchemas: + Additional information for the API invocation, such as the request + tracking id. + longRunningOperations: type: array items: - type: string + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: post-processing LROs + ruleEngineOutput: description: >- - This filter specifies the exact document schema(s) - Document.document_schema_name to run histogram query against. It is - optional. It will perform histogram for property names for all the - document schemas if it is not set. At most 10 document schema names - are allowed. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - type: object - id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - GoogleCloudContentwarehouseV1UpdateRuleSetRequest: - type: object - properties: - ruleSet: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - description: Required. The rule set to update. - id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest - description: Request message for RuleSetService.UpdateRuleSet. - GoogleCloudContentwarehouseV1AddToFolderAction: - description: Represents the action responsible for adding document under a folder. + Output from Rule Engine recording the rule evaluator and action + executor's output. Refer format in: + google/cloud/contentwarehouse/v1/rule_engine.proto + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + description: Response message for DocumentService.CreateDocument. + GoogleCloudContentwarehouseV1CustomWeightsMetadata: + id: GoogleCloudContentwarehouseV1CustomWeightsMetadata + description: To support the custom weighting across document schemas. type: object properties: - folders: + weightedSchemaProperties: description: >- - Names of the folder under which new document is to be added. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - items: - type: string + List of schema and property name. Allows a maximum of 10 schemas to + be specified for relevance boosting. type: array - id: GoogleCloudContentwarehouseV1AddToFolderAction - GoogleCloudContentwarehouseV1PropertyDefinition: - description: Defines the metadata for a schema property. - id: GoogleCloudContentwarehouseV1PropertyDefinition + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty + GoogleCloudContentwarehouseV1GetDocumentRequest: properties: - isRequired: - type: boolean + requestMetadata: description: >- - Whether the property is mandatory. Default is 'false', i.e. - populating property value can be skipped. If 'true' then user must - populate the value for this property. - isFilterable: + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + type: object + description: Request message for DocumentService.GetDocument. + id: GoogleCloudContentwarehouseV1GetDocumentRequest + GoogleCloudContentwarehouseV1FetchAclRequest: + id: GoogleCloudContentwarehouseV1FetchAclRequest + description: Request message for DocumentService.FetchAcl + properties: + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - Whether the property can be filtered. If this is a sub-property, all - the parent properties must be marked filterable. + The meta information collected about the end user, used to enforce + access control for the service. + projectOwner: type: boolean - timestampTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions - description: >- - Timestamp property. It is not supported by CMEK compliant - deployment. - dateTimeTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions description: >- - Date time property. It is not supported by CMEK compliant - deployment. - isMetadata: + For Get Project ACL only. Authorization check for end user will be + ignored when project_owner=true. + type: object + GoogleCloudContentwarehouseV1FetchAclResponse: + properties: + metadata: description: >- - Whether the property is user supplied metadata. This out-of-the box - placeholder setting can be used to tag derived properties. Its value - and interpretation logic should be implemented by API user. - type: boolean - displayName: - type: string - description: The display-name for the property, used for front-end. - name: - type: string + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: The IAM policy. + id: GoogleCloudContentwarehouseV1FetchAclResponse + description: Response message for DocumentService.FetchAcl. + type: object + GoogleCloudContentwarehouseV1ListRuleSetsResponse: + properties: + nextPageToken: description: >- - Required. The name of the metadata property. Must be unique within a - document schema and is case insensitive. Names must be non-blank, - start with a letter, and can contain alphanumeric characters and: /, - :, -, _, and . - propertyTypeOptions: - description: Nested structured data property. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions - floatTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' - description: Float property. - retrievalImportance: + 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 - enumDescriptions: - - No importance specified. Default medium importance. - - Highest importance. - - Higher importance. - - High importance. - - Medium importance. - - Low importance (negative). - - Lowest importance (negative). - enum: - - RETRIEVAL_IMPORTANCE_UNSPECIFIED - - HIGHEST - - HIGHER - - HIGH - - MEDIUM - - LOW - - LOWEST - description: The retrieval importance of the property during search. - integerTypeOptions: - description: Integer property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' - textTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' - description: Text/string property. - isRepeatable: - description: Whether the property can have multiple values. - type: boolean - enumTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' - description: Enum/categorical property. - schemaSources: + ruleSets: + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + description: The rule sets from the specified parent. + type: object + description: Response message for RuleSetService.ListRuleSets. + id: GoogleCloudContentwarehouseV1ListRuleSetsResponse + GoogleCloudContentwarehouseV1PropertyTypeOptions: + properties: + propertyDefinitions: + description: Required. List of property definitions. items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource - description: >- - The mapping information between this property to another schema - source. + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition type: array - mapTypeOptions: - description: Map property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' - isSearchable: - type: boolean - description: Indicates that the property should be included in a global search. + description: Configurations for a nested structured data property. type: object - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. + id: GoogleCloudContentwarehouseV1PropertyTypeOptions + GoogleCloudContentwarehouseV1HistogramQueryResult: type: object properties: - role: - type: string + histogram: + type: object + additionalProperties: + format: int64 + type: string description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - members: + A map from the values of the facet associated with distinct values + to the number of matching entries with corresponding value. The key + format is: * (for string histogram) string values stored in the + field. + histogramQuery: + type: string + description: Requested histogram expression. + id: GoogleCloudContentwarehouseV1HistogramQueryResult + description: Histogram result that matches HistogramQuery specified in searches. + GoogleCloudDocumentaiV1DocumentDocumentLayout: + properties: + blocks: type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + description: List of blocks in the document. + description: >- + Represents the parsed layout of a document as a collection of blocks + that the document is divided into. + id: GoogleCloudDocumentaiV1DocumentDocumentLayout + type: object + GoogleCloudContentwarehouseV1SynonymSetSynonym: + type: object + id: GoogleCloudContentwarehouseV1SynonymSetSynonym + properties: + words: + description: 'For example: sale, invoice, bill, order' items: type: string - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - id: GoogleIamV1Binding - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + type: array + description: >- + Represents a list of words given by the customer All these words are + synonyms of each other. + GoogleCloudDocumentaiV1BoundingPoly: + type: object properties: - headerRows: - description: Header rows at the top of the table. + normalizedVertices: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + description: The bounding polygon normalized vertices. + type: array + vertices: type: array + description: The bounding polygon vertices. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - caption: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + id: GoogleCloudDocumentaiV1BoundingPoly + description: A bounding polygon for the detected image annotation. + GoogleCloudContentwarehouseV1ProjectStatus: + properties: + accessControlMode: type: string - description: Table caption/title. - bodyRows: + enum: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI + enumDescriptions: + - This value is required by protobuf best practices + - 'Universal Access: No document level access control.' + - Document level access control with customer own Identity Service. + - Document level access control using Google Cloud Identity. + description: Access control mode. + documentCreatorDefaultRole: + type: string + description: The default role for the person who create a document. + location: + description: The location of the queried project. + type: string + state: + description: State of the project. + type: string + enum: + - PROJECT_STATE_UNSPECIFIED + - PROJECT_STATE_PENDING + - PROJECT_STATE_COMPLETED + - PROJECT_STATE_FAILED + - PROJECT_STATE_DELETING + - PROJECT_STATE_DELETING_FAILED + - PROJECT_STATE_DELETED + - PROJECT_STATE_NOT_FOUND + enumDescriptions: + - Default status, required by protobuf best practices. + - The project is in the middle of a provision process. + - All dependencies have been provisioned. + - A provision process was previously initiated, but failed. + - The project is in the middle of a deletion process. + - A deleting process was initiated, but failed. + - The project is deleted. + - The project is not found. + qaEnabled: + type: boolean + description: If the qa is enabled on this project. + databaseType: + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + description: Database type. + type: string + enumDeprecated: + - false + - false + - true + id: GoogleCloudContentwarehouseV1ProjectStatus + type: object + description: >- + Status of a project, including the project state, dbType, aclMode and + etc. + GoogleCloudDocumentaiV1DocumentPageParagraph: + properties: + provenance: + description: The history of this annotation. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + detectedLanguages: type: array - description: Body rows containing main table content. + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - description: Represents a table type block. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Paragraph. type: object - CloudAiPlatformTenantresourceTenantProjectConfig: - description: The identity to configure a tenant project. + id: GoogleCloudDocumentaiV1DocumentPageParagraph + description: A collection of lines that a human would perceive as a paragraph. + GoogleCloudDocumentaiV1DocumentPageAnchor: + id: GoogleCloudDocumentaiV1DocumentPageAnchor properties: - folder: - type: string - description: >- - Input/Output [Required]. The folder that holds tenant projects and - folder-level permissions will be automatically granted to all tenant - projects under the folder. Note: the valid folder format is - `folders/{folder_number}`. - services: - type: array - items: - type: string - description: >- - Input/Output [Required]. The API services that are enabled on the - tenant project during creation. - billingConfig: - description: >- - Input/Output [Required]. The billing account properties to create - the tenant project. - $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig - policyBindings: - type: array - description: >- - Input/Output [Required]. The policy bindings that are applied to the - tenant project during creation. At least one binding must have the - role `roles/owner` with either `user` or `group` type. + pageRefs: + description: One or more references to visual page elements items: $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding - type: object - id: CloudAiPlatformTenantresourceTenantProjectConfig - GoogleCloudDocumentaiV1NormalizedVertex: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + type: array type: object description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - properties: - 'y': - format: float - type: number - description: Y coordinate (starts from the top of the image). - x: - description: X coordinate. - type: number - format: float - id: GoogleCloudDocumentaiV1NormalizedVertex - GoogleCloudContentwarehouseV1UpdateOptions: - description: Options for Update operations. + Referencing the visual context of the entity in the Document.pages. Page + anchors can be cross-page, consist of multiple bounding polygons and + optionally reference specific layout element types. + GoogleCloudContentwarehouseV1AddToFolderAction: type: object + id: GoogleCloudContentwarehouseV1AddToFolderAction properties: - updateMask: + folders: + items: + type: string + type: array description: >- - Field mask for merging Document fields. For the `FieldMask` - definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + Names of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + description: Represents the action responsible for adding document under a folder. + GoogleCloudContentwarehouseV1RemoveFromFolderAction: + id: GoogleCloudContentwarehouseV1RemoveFromFolderAction + properties: + condition: + description: Condition of the action to be executed. type: string - format: google-fieldmask - updateType: - description: Type for update. - enumDescriptions: - - Defaults to full replace behavior, ie. FULL_REPLACE. - - >- - Fully replace all the fields (including previously linked raw - document). Any field masks will be ignored. - - Merge the fields into the existing entities. - - Inserts the properties by names. - - Replace the properties by names. - - Delete the properties by names. - - >- - For each of the property, replaces the property if the it exists, - otherwise inserts a new property. And for the rest of the fields, - merge them based on update mask and merge fields options. + folder: type: string - enum: - - UPDATE_TYPE_UNSPECIFIED - - UPDATE_TYPE_REPLACE - - UPDATE_TYPE_MERGE - - UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES - - UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES - - UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES - - UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES - mergeFieldsOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' - description: Options for merging. - id: GoogleCloudContentwarehouseV1UpdateOptions - GoogleCloudContentwarehouseV1GcsIngestPipeline: - type: object - properties: - processorType: - type: string - description: >- - The Doc AI processor type name. Only used when the format of - ingested files is Doc AI Document proto format. - skipIngestedDocuments: - description: >- - The flag whether to skip ingested documents. If it is set to true, - documents in Cloud Storage contains key "status" with value - "status=ingested" in custom metadata will be skipped to ingest. - type: boolean - pipelineConfig: - description: >- - Optional. The config for the Cloud Storage Ingestion pipeline. It - provides additional customization options to run the pipeline and - can be skipped if it is not applicable. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig - inputPath: - description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. - type: string - schemaName: - description: >- - The Document Warehouse schema resource name. All documents processed - by this pipeline will use this schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - type: string - id: GoogleCloudContentwarehouseV1GcsIngestPipeline - description: The configuration of the Cloud Storage Ingestion pipeline. - GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: - properties: - nextPageToken: - type: string - 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. - documentLinks: - description: Target document-links. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - type: array - description: Response message for DocumentLinkService.ListLinkedTargets. - type: object - id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse - GoogleCloudContentwarehouseV1DeleteDocumentAction: - properties: - enableHardDelete: - type: boolean description: >- - Boolean field to select between hard vs soft delete options. Set - 'true' for 'hard delete' and 'false' for 'soft delete'. - type: object - description: Represents the action responsible for deleting the document. - id: GoogleCloudContentwarehouseV1DeleteDocumentAction - GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: - properties: - state: - description: The state of the project initialization process. - enumDescriptions: - - Clients should never see this. - - Finished project initialization without error. - - Finished project initialization with an error. - - Client canceled the LRO. - - Ask the customer to check the operation for results. - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - RUNNING - type: string - message: - type: string - description: The message of the project initialization process. - description: Response message for projectService.InitializeProject - id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse - type: object - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + Name of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + description: >- + Represents the action responsible for remove a document from a specific + folder. type: object - properties: - text: - description: Header in text format. - type: string - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the header. - description: Represents the page header associated with the chunk. - GoogleCloudDocumentaiV1DocumentPageParagraph: - description: A collection of lines that a human would perceive as a paragraph. + GoogleCloudDocumentaiV1DocumentPageLine: type: object - id: GoogleCloudDocumentaiV1DocumentPageParagraph + id: GoogleCloudDocumentaiV1DocumentPageLine properties: detectedLanguages: - type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array description: A list of detected languages together with confidence. + layout: + description: Layout for Line. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' provenance: + deprecated: true description: The history of this annotation. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - layout: - description: Layout for Paragraph. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - GoogleCloudContentwarehouseV1GetDocumentRequest: + description: >- + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. + GoogleTypeInterval: properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + startTime: description: >- - The meta information collected about the end user, used to enforce - access control for the service. - description: Request message for DocumentService.GetDocument. - id: GoogleCloudContentwarehouseV1GetDocumentRequest + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. + type: string + format: google-datetime + endTime: + format: google-datetime + description: >- + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + type: string + id: GoogleTypeInterval + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. type: object - GoogleCloudContentwarehouseV1UserInfo: + GoogleCloudDocumentaiV1DocumentPageTableTableRow: type: object + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: A row of table cells. properties: - groupIds: - description: >- - The unique group identifications which the user is belong to. The - format is "group:yyyy@example.com"; + cells: type: array + description: Cells that make up this row. items: - type: string - id: - type: string - description: >- - A unique user identification string, as determined by the client. - The maximum number of allowed characters is 255. Allowed characters - include numbers 0 to 9, uppercase and lowercase letters, and - restricted special symbols (:, @, +, -, _, ~) The format is - "user:xxxx@example.com"; - id: GoogleCloudContentwarehouseV1UserInfo - description: The user information. - GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: - description: Document entry with metadata inside SearchDocumentsResponse + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + CloudAiPlatformTenantresourceTenantProjectConfig: + description: The identity to configure a tenant project. type: object - id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument properties: - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: >- - Document that matches the specified SearchDocumentsRequest. This - document only contains indexed metadata information. - searchTextSnippet: + folder: description: >- - Contains snippets of text from the document full raw text that most - closely match a search query's keywords, if available. All HTML tags - in the original fields are stripped when returned in this field, and - matching query keywords are enclosed in HTML bold tags. If the - question-answering feature is enabled, this field will instead - contain a snippet that answers the user's natural-language query. No - HTML bold tags will be present, and highlights in the answer snippet - can be found in QAResult.highlights. + Input/Output [Required]. The folder that holds tenant projects and + folder-level permissions will be automatically granted to all tenant + projects under the folder. Note: the valid folder format is + `folders/{folder_number}`. type: string - qaResult: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' + policyBindings: + items: + $ref: >- + #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding description: >- - Experimental. Additional result info if the question-answering - feature is enabled. - matchedTokenPageIndices: + Input/Output [Required]. The policy bindings that are applied to the + tenant project during creation. At least one binding must have the + role `roles/owner` with either `user` or `group` type. + type: array + billingConfig: + description: >- + Input/Output [Required]. The billing account properties to create + the tenant project. + $ref: >- + #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig + services: + type: array items: type: string - format: int64 - type: array description: >- - Return the 1-based page indices where those pages have one or more - matched tokens. - GoogleCloudContentwarehouseV1MapTypeOptions: + Input/Output [Required]. The API services that are enabled on the + tenant project during creation. + id: CloudAiPlatformTenantresourceTenantProjectConfig + GoogleCloudContentwarehouseV1ActionExecutorOutput: + properties: + ruleActionsPairs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' + description: List of rule and corresponding actions result. + description: Represents the output of the Action Executor. + id: GoogleCloudContentwarehouseV1ActionExecutorOutput type: object - properties: {} - id: GoogleCloudContentwarehouseV1MapTypeOptions - description: Configurations for a Map property. - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + GoogleCloudDocumentaiV1DocumentStyle: + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. + type: object + id: GoogleCloudDocumentaiV1DocumentStyle properties: - layoutId: - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - deprecated: true - type: string - page: + fontWeight: + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. type: string + textStyle: description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - format: int64 - confidence: + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. + type: string + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + fontSize: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' + description: Font size. + textDecoration: + type: string description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - type: number - format: float - layoutType: + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text color. + fontFamily: type: string description: >- - Optional. The type of the layout element that is being referenced if - any. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text background color. + GoogleCloudContentwarehouseV1RuleEngineOutput: + properties: + documentName: + type: string description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + Name of the document against which the rules and actions were + evaluated. + ruleEvaluatorOutput: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput + description: >- + Output from Rule Evaluator containing matched, unmatched and invalid + rules. + actionExecutorOutput: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput + description: >- + Output from Action Executor containing rule and corresponding + actions execution result. type: object - description: Represents a weak reference to a page element within a document. - GoogleTypeDateTime: + id: GoogleCloudContentwarehouseV1RuleEngineOutput + description: >- + Records the output of Rule Engine including rule evaluation and actions + result. + GoogleCloudDocumentaiV1DocumentRevision: type: object - id: GoogleTypeDateTime + description: Contains past or forward revisions of this document. properties: - seconds: - format: int32 + parent: + type: array description: >- - Optional. Seconds of minutes of the time. Must normally be from 0 to - 59, defaults to 0. An API may allow the value 60 if it allows - leap-seconds. - type: integer - utcOffset: + The revisions that this revision is based on. This can include one + or more parent (when documents are merged.) This field represents + the index into the `revisions` field. + deprecated: true + items: + format: int32 + type: integer + humanReview: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + description: Human Review information of this revision. + id: type: string - format: google-duration description: >- - UTC offset. Must be whole seconds, between -18 hours and +18 hours. - For example, a UTC offset of -4:00 would be represented as { - seconds: -14400 }. - nanos: + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. + createTime: + type: string description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. + The time that the revision was created, internally generated by doc + proto storage at the time of create. + format: google-datetime + processor: + description: >- + If the annotation was made by processor identify the processor by + its resource name. + type: string + parentIds: + description: >- + The revisions that this revision is based on. Must include all the + ids that have anything to do with this revision - eg. there are + `provenance.parent.revision` fields that index into this field. + items: + type: string + type: array + agent: + description: >- + If the change was made by a person specify the name or id of that + person. + type: string + id: GoogleCloudDocumentaiV1DocumentRevision + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + description: Represents where the block starts and ends in the document. + properties: + pageStart: type: integer format: int32 - timeZone: - $ref: '#/components/schemas/GoogleTypeTimeZone' - description: Time zone. - day: + description: Page where block starts in the document. + pageEnd: type: integer + description: Page where block ends in the document. format: int32 + type: object + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + type: object + properties: + state: + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. + type: string + stateMessage: + type: string description: >- - Optional. Day of month. Must be from 1 to 31 and valid for the year - and month, or 0 if specifying a datetime without a day. - hours: - format: int32 - description: >- - Optional. Hours of day in 24 hour format. Should be from 0 to 23, - defaults to 0 (midnight). An API may choose to allow the value - "24:00:00" for scenarios like business closing time. - type: integer - month: + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. + description: Human Review information of the document. + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + GoogleCloudDocumentaiV1DocumentProvenanceParent: + type: object + id: GoogleCloudDocumentaiV1DocumentProvenanceParent + properties: + revision: + description: The index of the index into current revision's parent_ids list. type: integer - description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. format: int32 - year: - type: integer - description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. + id: format: int32 - minutes: + type: integer + deprecated: true + description: The id of the parent provenance. + index: description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. type: integer format: int32 description: >- - Represents civil time (or occasionally physical time). This type can - represent a civil time in one of a few possible ways: * When utc_offset - is set and time_zone is unset: a civil time on a calendar day with a - particular offset from UTC. * When time_zone is set and utc_offset is - unset: a civil time on a calendar day in a particular time zone. * When - neither time_zone nor utc_offset is set: a civil time on a calendar day - in local time. The date is relative to the Proleptic Gregorian Calendar. - If year, month, or day are 0, the DateTime is considered not to have a - specific year, month, or day respectively. This type may also be used to - represent a physical time if all the date and time fields are set and - either case of the `time_offset` oneof is set. Consider using - `Timestamp` message for physical time instead. If your use case also - would like to store the user's timezone, that can be done in another - field. This type is more flexible than some applications may want. Make - sure to document and validate your application's limitations. - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. + GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: + id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + description: Response message for DocumentLinkService.ListLinkedSources. properties: - inputPath: + pageToken: + description: >- + A page token, received from a previous `ListLinkedSources` call. + Provide this to retrieve the subsequent page. When paginating, all + other parameters provided to `ListLinkedSources` must match the call + that provided the page token. type: string - description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the document creator, used to + enforce access control for the service. + pageSize: + format: int32 + type: integer + description: >- + The maximum number of document-links to return. The service may + return fewer than this value. If unspecified, at most 50 + document-links will be returned. The maximum value is 1000; values + above 1000 will be coerced to 1000. + type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: type: object - description: The metadata message for GcsIngest pipeline. - GoogleCloudContentwarehouseV1RuleActionsPair: properties: - actionOutputs: - type: array - description: Outputs of executing the actions associated with the above rule. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' - rule: - description: Represents the rule. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - type: object - id: GoogleCloudContentwarehouseV1RuleActionsPair - description: Represents a rule and outputs of associated actions. - GoogleCloudContentwarehouseV1WeightedSchemaProperty: - id: GoogleCloudContentwarehouseV1WeightedSchemaProperty - description: Specifies the schema property name. - properties: - propertyNames: - description: The property definition names in the schema. - items: - type: string - type: array - documentSchemaName: - description: The document schema name. + pageSpan: + description: Page span of the block. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + tableBlock: + description: Block consisting of table content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + listBlock: + description: Block consisting of list content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + blockId: + description: ID of the block. type: string - type: object - GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: - id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + textBlock: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + description: Block consisting of text content. + id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + description: >- + Represents a block. A block could be one of the various types (text, + table, list) supported. + GoogleCloudContentwarehouseV1PropertyDefinition: properties: - inputPath: + mapTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' + description: Map property. + isSearchable: + description: Indicates that the property should be included in a global search. + type: boolean + isRequired: description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. - type: string - splitClassifyProcessorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + Whether the property is mandatory. Default is 'false', i.e. + populating property value can be skipped. If 'true' then user must + populate the value for this property. + type: boolean + isRepeatable: + description: Whether the property can have multiple values. + type: boolean + isMetadata: + type: boolean description: >- - The split and classify processor information. The split and classify - result will be used to find a matched extract processor. - processorResultsFolderPath: + Whether the property is user supplied metadata. This out-of-the box + placeholder setting can be used to tag derived properties. Its value + and interpretation logic should be implemented by API user. + dateTimeTypeOptions: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - type: string - skipIngestedDocuments: - type: boolean + Date time property. It is not supported by CMEK compliant + deployment. + name: description: >- - The flag whether to skip ingested documents. If it is set to true, - documents in Cloud Storage contains key "status" with value - "status=ingested" in custom metadata will be skipped to ingest. - pipelineConfig: + Required. The name of the metadata property. Must be unique within a + document schema and is case insensitive. Names must be non-blank, + start with a letter, and can contain alphanumeric characters and: /, + :, -, _, and . + type: string + displayName: + description: The display-name for the property, used for front-end. + type: string + timestampTypeOptions: description: >- - Optional. The config for the Cloud Storage Ingestion with DocAI - Processors pipeline. It provides additional customization options to - run the pipeline and can be skipped if it is not applicable. + Timestamp property. It is not supported by CMEK compliant + deployment. $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig - extractProcessorInfos: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions + floatTypeOptions: + description: Float property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' + retrievalImportance: + enum: + - RETRIEVAL_IMPORTANCE_UNSPECIFIED + - HIGHEST + - HIGHER + - HIGH + - MEDIUM + - LOW + - LOWEST + description: The retrieval importance of the property during search. + type: string + enumDescriptions: + - No importance specified. Default medium importance. + - Highest importance. + - Higher importance. + - High importance. + - Medium importance. + - Low importance (negative). + - Lowest importance (negative). + integerTypeOptions: + description: Integer property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' + textTypeOptions: + description: Text/string property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' + propertyTypeOptions: + description: Nested structured data property. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions + schemaSources: description: >- - The extract processors information. One matched extract processor - will be used to process documents based on the classify processor - result. If no classify processor is specified, the first extract - processor will be used. + The mapping information between this property to another schema + source. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource type: array - description: >- - The configuration of the Cloud Storage Ingestion with DocAI Processors - pipeline. + enumTypeOptions: + description: Enum/categorical property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' + isFilterable: + type: boolean + description: >- + Whether the property can be filtered. If this is a sub-property, all + the parent properties must be marked filterable. + id: GoogleCloudContentwarehouseV1PropertyDefinition + description: Defines the metadata for a schema property. type: object - GoogleLongrunningOperation: + GoogleCloudContentwarehouseV1Document: + description: Defines the structure for content warehouse document proto. + id: GoogleCloudContentwarehouseV1Document type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation properties: - metadata: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + referenceId: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - name: + The reference ID set by customers. Must be unique per project and + location. type: string + title: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - error: - $ref: '#/components/schemas/GoogleRpcStatus' + Title that describes the document. This can be the top heading or + text that describes the document. + type: string + updater: + type: string + description: The user who lastly updates the document. + creator: + type: string + description: The user who creates the document. + rawDocumentFileType: + type: string + enum: + - RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED + - RAW_DOCUMENT_FILE_TYPE_PDF + - RAW_DOCUMENT_FILE_TYPE_DOCX + - RAW_DOCUMENT_FILE_TYPE_XLSX + - RAW_DOCUMENT_FILE_TYPE_PPTX + - RAW_DOCUMENT_FILE_TYPE_TEXT + - RAW_DOCUMENT_FILE_TYPE_TIFF + enumDescriptions: + - No raw document specified or it is non-parsable + - Adobe PDF format + - Microsoft Word format + - Microsoft Excel format + - Microsoft Powerpoint format + - UTF-8 encoded text format + - TIFF or TIF image file format description: >- - The error result of the operation in case of failure or - cancellation. - done: + This is used when DocAI was not used to load the document and + parsing/ extracting is needed for the inline_raw_document. For + example, if inline_raw_document is the byte representation of a PDF + file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. + inlineRawDocument: + type: string + description: Raw document content. + format: byte + legalHold: type: boolean + description: Output only. Indicates if the document has a legal hold on it. + readOnly: true + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The time when the document is created. + contentCategory: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: + Indicates the category (image, audio, video etc.) of the original + content. + enumDescriptions: + - No category is specified. + - Content is of image type. + - Content is of audio type. + - Content is of video type. + type: string + enum: + - CONTENT_CATEGORY_UNSPECIFIED + - CONTENT_CATEGORY_IMAGE + - CONTENT_CATEGORY_AUDIO + - CONTENT_CATEGORY_VIDEO + cloudAiDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: Document AI format to save the structured content, including OCR. + displayName: + type: string description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleApiServiceconsumermanagementV1PolicyBinding: - description: Translates to IAM Policy bindings (without auditing at this level) - id: GoogleApiServiceconsumermanagementV1PolicyBinding + Required. Display name of the document given by the user. This name + will be displayed in the UI. Customer can populate this field with + the name of the document. This differs from the 'title' field as + 'title' is optional and stores the top heading in the document. + name: + type: string + description: >- + The resource name of the document. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + The name is ignored when creating a document. + textExtractionDisabled: + type: boolean + description: If true, text extraction will not be performed. + deprecated: true + properties: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' + type: array + description: List of values that are user supplied metadata. + textExtractionEnabled: + description: If true, text extraction will be performed. + type: boolean + plainText: + type: string + description: Other document format, such as PPTX, XLXS + updateTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time when the document is last updated. + rawDocumentPath: + description: Raw document file in Cloud Storage path. + type: string + displayUri: + description: Uri to display the document, for example, in the UI. + type: string + dispositionTime: + readOnly: true + format: google-datetime + description: >- + Output only. If linked to a Collection with RetentionPolicy, the + date when the document becomes mutable. + type: string + documentSchemaName: + type: string + description: >- + The Document schema name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + GoogleCloudContentwarehouseV1FloatTypeOptions: + id: GoogleCloudContentwarehouseV1FloatTypeOptions type: object + properties: {} + description: Configurations for a float property. + CloudAiPlatformTenantresourceTenantProjectResource: + description: 'The tenant project and tenant resources. Next ID: 10' properties: - members: + tenantProjectConfig: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectConfig + description: The configurations of a tenant project. + gcsBuckets: + items: + $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' + description: The GCS buckets that are provisioned under the tenant project. + type: array + tenantProjectNumber: + format: int64 + description: Output only. The tenant project number that has been created. + type: string + iamPolicyBindings: + items: + $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' description: >- - Uses the same format as in IAM policy. `member` must include both a - prefix and ID. For example, `user:{emailId}`, - `serviceAccount:{emailId}`, `group:{emailId}`. + The dynamic IAM bindings that are granted under the tenant project. + Note: this should only add new bindings to the project if they don't + exist and the existing bindings won't be affected. type: array + infraSpannerConfigs: + type: array + description: >- + The Infra Spanner databases that are provisioned under the tenant + project. Note: this is an experimental feature. items: - type: string - role: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig + tag: + type: string description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. + Input/Output [Required]. The tag that uniquely identifies a tenant + project within a tenancy unit. Note: for the same tenant project + tag, all tenant manager operations should be idempotent. + tenantProjectId: type: string - GoogleCloudContentwarehouseV1RequestMetadata: - id: GoogleCloudContentwarehouseV1RequestMetadata - description: Meta information is used to improve the performance of the service. + description: Output only. The tenant project ID that has been created. + cloudSqlInstances: + type: array + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig + description: >- + The CloudSQL instances that are provisioned under the tenant + project. + tenantServiceAccounts: + description: >- + The service account identities (or enabled API service's P4SA) that + are expclicitly created under the tenant project (before JIT + provisioning during enabled API services). + type: array + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity type: object + id: CloudAiPlatformTenantresourceTenantProjectResource + GoogleCloudContentwarehouseV1IntegerTypeOptions: + description: Configurations for an integer property. + type: object + properties: {} + id: GoogleCloudContentwarehouseV1IntegerTypeOptions + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: properties: - userInfo: - description: Provides user unique identification and groups information. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - description: A row of table cells. - properties: - cells: + sourceBlockIds: + description: Unused. + items: + type: string type: array - description: Cells that make up this row. + pageFooters: + type: array + description: Page footers associated with the chunk. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + content: + description: Text content of the chunk. + type: string + chunkId: + type: string + description: ID of the chunk. + pageHeaders: + description: Page headers associated with the chunk. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + type: array + pageSpan: + description: Page span of the chunk. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + description: Represents a chunk. type: object - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow - GoogleCloudContentwarehouseV1RemoveFromFolderAction: + GoogleCloudDocumentaiV1NormalizedVertex: properties: - condition: + 'y': + format: float + type: number + description: Y coordinate (starts from the top of the image). + x: + description: X coordinate. + format: float + type: number + description: >- + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. + type: object + id: GoogleCloudDocumentaiV1NormalizedVertex + GoogleCloudContentwarehouseV1WeightedSchemaProperty: + type: object + description: Specifies the schema property name. + properties: + documentSchemaName: + description: The document schema name. type: string - description: Condition of the action to be executed. - folder: + propertyNames: + description: The property definition names in the schema. + items: + type: string + type: array + id: GoogleCloudContentwarehouseV1WeightedSchemaProperty + GoogleCloudContentwarehouseV1ExportToCdwPipeline: + id: GoogleCloudContentwarehouseV1ExportToCdwPipeline + properties: + documents: + items: + type: string description: >- - Name of the folder under which new document is to be added. Format: + The list of all the resource names of the documents to be processed. + Format: projects/{project_number}/locations/{location}/documents/{document_id}. + type: array + docAiDataset: + type: string + description: >- + Optional. The CDW dataset resource name. This field is optional. If + not set, the documents will be exported to Cloud Storage only. + Format: + projects/{project}/locations/{location}/processors/{processor}/dataset + trainingSplitRatio: + type: number + description: >- + Ratio of training dataset split. When importing into Document AI + Workbench, documents will be automatically split into training and + test split category with the specified ratio. This field is required + if doc_ai_dataset is set. + format: float + exportFolderPath: + description: >- + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. type: string - description: >- - Represents the action responsible for remove a document from a specific - folder. type: object - id: GoogleCloudContentwarehouseV1RemoveFromFolderAction - GoogleCloudDocumentaiV1DocumentPageMatrix: + description: >- + The configuration of exporting documents from the Document Warehouse to + CDW pipeline. + GoogleCloudContentwarehouseV1Action: + description: Represents the action triggered by Rule Engine when the rule is true. type: object properties: - data: + actionId: + description: ID of the action. Managed internally. type: string - format: byte - description: The matrix data. - type: - type: integer - description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - format: int32 - rows: - format: int32 - type: integer - description: Number of rows in the matrix. - cols: - description: Number of columns in the matrix. - type: integer - format: int32 - description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. - id: GoogleCloudDocumentaiV1DocumentPageMatrix - GoogleCloudContentwarehouseV1SearchDocumentsRequest: - id: GoogleCloudContentwarehouseV1SearchDocumentsRequest + publishToPubSub: + description: Action publish to Pub/Sub operation. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' + accessControl: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction + description: Action triggering access control operations. + deleteDocumentAction: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction + description: Action deleting the document. + removeFromFolderAction: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction + description: Action removing a document from a folder. + dataValidation: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction + description: Action triggering data validation operations. + dataUpdate: + description: Action triggering data update operations. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' + addToFolder: + description: Action triggering create document link operation. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' + id: GoogleCloudContentwarehouseV1Action + CloudAiPlatformTenantresourceTenantResource: + id: CloudAiPlatformTenantresourceTenantResource + description: A collection of tenant resources. + properties: + tenantProjectResources: + type: array + description: >- + A list of tenant projects and tenant resources to provision or + deprovision. + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource + p4ServiceAccounts: + type: array + description: A list of P4 service accounts (go/p4sa) to provision or deprovision. + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity type: object + GoogleCloudDocumentaiV1DocumentProvenance: properties: - qaSizeLimit: + id: description: >- - Experimental, do not use. The limit on the number of documents - returned for the question-answering feature. To enable the - question-answering feature, set [DocumentQuery].is_nl_query to true. + The Id of this operation. Needs to be unique within the scope of the + revision. format: int32 type: integer - totalResultSize: - enumDescriptions: - - Total number calculation will be skipped. - - >- - Estimate total number. The total result size will be accurated up - to 10,000. This option will add cost and latency to your request. - - It may adversely impact performance. The limit is 1000,000. - enum: - - TOTAL_RESULT_SIZE_UNSPECIFIED - - ESTIMATED_SIZE - - ACTUAL_SIZE - type: string - description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. - orderBy: - type: string - description: >- - The criteria determining how search results are sorted. For - non-empty query, default is `"relevance desc"`. For empty query, - default is `"upload_date desc"`. Supported options are: * - `"relevance desc"`: By relevance descending, as determined by the - API algorithms. * `"upload_date desc"`: By upload date descending. * - `"upload_date"`: By upload date ascending. * `"update_date desc"`: - By last updated date descending. * `"update_date"`: By last updated - date ascending. * `"retrieval_importance desc"`: By retrieval - importance of properties descending. This feature is still under - development, please do not use unless otherwise instructed to do so. - pageToken: - type: string - description: >- - The token specifying the current offset within search results. See - SearchDocumentsResponse.next_page_token for an explanation of how to - obtain the next set of query results. - pageSize: + deprecated: true + revision: type: integer - description: >- - A limit on the number of documents returned in the search results. - Increasing this value above the default value of 10 can increase - search response time. The value can be between 1 and 100. + deprecated: true + description: The index of the revision that produced this element. format: int32 - requestMetadata: - description: >- - The meta information collected about the end user, used to enforce - access control and improve the search quality of the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - histogramQueries: + parents: type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' - description: >- - An expression specifying a histogram request against matching - documents. Expression syntax is an aggregation function call with - histogram facets and other options. The following aggregation - functions are supported: * `count(string_histogram_facet)`: Count - the number of matching entities for each distinct attribute value. - Data types: * Histogram facet (aka filterable properties): Facet - names with format .. Facets will have the format - of: `a-zA-Z`. If the facet is a child facet, then the parent - hierarchy needs to be specified separated by dots in the prefix - after the schema id. Thus, the format for a multi- level facet is: - .. . Example: - schema123.root_parent_facet.middle_facet.child_facet * - DocumentSchemaId: (with no schema id prefix) to get histograms for - each document type (returns the schema id path, e.g. - projects/12345/locations/us-west/documentSchemas/abc123). Example - expression: * Document type counts: count('DocumentSchemaId') * For - schema id, abc123, get the counts for MORTGAGE_TYPE: - count('abc123.MORTGAGE_TYPE') - requireTotalSize: - type: boolean - description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. Enabling this flag may adversely - impact performance. Hint: If this is used with pagination, set this - flag on the initial query but set this to false on subsequent page - calls (keep the total count locally). Defaults to false. - offset: - type: integer - description: >- - An integer that specifies the current offset (that is, starting - result location, amongst the documents deemed by the API as - relevant) in search results. This field is only considered if - page_token is unset. The maximum allowed value is 5000. Otherwise an - error is thrown. For example, 0 means to return results starting - from the first matching document, and 10 means to return from the - 11th document. This can be used for pagination, (for example, - pageSize = 10 and offset = 10 means to return from the second page). - format: int32 - documentQuery: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' - description: Query used to search against documents (keyword, filters, etc.). - description: Request message for DocumentService.SearchDocuments. - GoogleCloudContentwarehouseV1DeleteDocumentRequest: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + description: References to the original elements that are replaced. + type: + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED + description: The type of provenance operation. + type: string + enumDescriptions: + - >- + Operation type unspecified. If no operation is specified a + provenance entry is simply used to match against a `parent`. + - Add an element. + - Remove an element identified by `parent`. + - >- + Updates any fields within the given provenance scope of the + message. It overwrites the fields rather than replacing them. Use + this when you want to update a field value of an entity without + also updating all the child properties. + - Currently unused. Replace an element identified by `parent`. + - >- + Deprecated. Request human review for the element identified by + `parent`. + - >- + Deprecated. Element is reviewed and approved at human review, + confidence will be set to 1.0. + - Deprecated. Element is skipped in the validation process. + type: object + id: GoogleCloudDocumentaiV1DocumentProvenance + description: >- + Structure to identify provenance relationships between annotations in + different revisions. + GoogleCloudContentwarehouseV1UserInfo: + id: GoogleCloudContentwarehouseV1UserInfo + description: The user information. type: object properties: - requestMetadata: + groupIds: + items: + type: string description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - id: GoogleCloudContentwarehouseV1DeleteDocumentRequest - description: Request message for DocumentService.DeleteDocument. - GoogleCloudContentwarehouseV1DocumentLink: + The unique group identifications which the user is belong to. The + format is "group:yyyy@example.com"; + type: array + id: + description: >- + A unique user identification string, as determined by the client. + The maximum number of allowed characters is 255. Allowed characters + include numbers 0 to 9, uppercase and lowercase letters, and + restricted special symbols (:, @, +, -, _, ~) The format is + "user:xxxx@example.com"; + type: string + GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: properties: - description: + processorType: + description: The Doc AI processor type name. type: string - description: Description of this document-link. name: + type: string + description: The schema name in the source. + type: object + id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + description: The schema source information. + CloudAiPlatformTenantresourceServiceAccountIdentity: + properties: + serviceAccountEmail: + type: string + description: Output only. The service account email that has been created. + tag: type: string description: >- - Name of this document-link. It is required that the parent derived - form the name to be consistent with the source document reference. - Otherwise an exception will be thrown. Format: - projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. - targetDocumentReference: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - description: Document references of the target document. - updateTime: - readOnly: true - description: Output only. The time when the documentLink is last updated. - format: google-datetime + Input/Output [Optional]. The tag that configures the service + account, as defined in + google3/configs/production/cdpush/acl-zanzibar-cloud-prod/activation_grants/activation_grants.gcl. + Note: The default P4 service account has the empty tag. + description: The identity to configure a service account. + id: CloudAiPlatformTenantresourceServiceAccountIdentity + type: object + GoogleCloudContentwarehouseV1TimeFilter: + id: GoogleCloudContentwarehouseV1TimeFilter + description: Filter on create timestamp or update timestamp of documents. + properties: + timeField: type: string - state: + description: >- + Specifies which time field to filter documents on. Defaults to + TimeField.UPLOAD_TIME. enumDescriptions: - - Unknown state of documentlink. - - The documentlink has both source and target documents detected. - - >- - Target document is deleted, and mark the documentlink as - soft-deleted. + - Default value. + - Earliest document create time. + - Latest document update time. + - Time when document becomes mutable again. enum: - - STATE_UNSPECIFIED - - ACTIVE - - SOFT_DELETED - type: string - description: >- - The state of the documentlink. If target node has been deleted, the - link is marked as invalid. Removing a source node will result in - removal of all associated links. - sourceDocumentReference: - description: Document references of the source document. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - createTime: - description: Output only. The time when the documentLink is created. - type: string - format: google-datetime - readOnly: true - description: A document-link between source and target document. - id: GoogleCloudContentwarehouseV1DocumentLink + - TIME_FIELD_UNSPECIFIED + - CREATE_TIME + - UPDATE_TIME + - DISPOSITION_TIME + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' type: object - GoogleCloudContentwarehouseV1DataValidationAction: - description: Represents the action responsible for data validation operations. + GoogleCloudDocumentaiV1DocumentPageTableTableCell: type: object properties: - conditions: - type: object - description: >- - Map of (K, V) -> (field, string condition to be evaluated on the - field) E.g., ("age", "age > 18 && age < 60") entry triggers - validation of field age with the given condition. Map entries will - be ANDed during validation. - additionalProperties: - type: string - id: GoogleCloudContentwarehouseV1DataValidationAction - GoogleCloudDocumentaiV1DocumentPageVisualElement: - properties: + colSpan: + description: How many columns this cell spans. + format: int32 + type: integer detectedLanguages: items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array description: A list of detected languages together with confidence. - type: - type: string - description: Type of the VisualElement. + type: array + rowSpan: + description: How many rows this cell spans. + format: int32 + type: integer layout: - description: Layout for VisualElement. + description: Layout for TableCell. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - id: GoogleCloudDocumentaiV1DocumentPageVisualElement + description: A cell representation inside the table. + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + GoogleIamV1Policy: + id: GoogleIamV1Policy description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - type: object - GoogleTypeExpr: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). type: object - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - id: GoogleTypeExpr properties: - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - location: + etag: + format: byte type: string description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - title: - type: string + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + bindings: + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + type: array description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - description: - type: string + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + auditConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + description: Specifies cloud audit logging configuration for this policy. + version: + format: int32 description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - GoogleCloudDocumentaiV1DocumentEntity: + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: type: object properties: - mentionText: + layoutType: + type: string + description: >- + Optional. The type of the layout element that is being referenced if + any. + enumDescriptions: + - Layout Unspecified. + - References a Page.blocks element. + - References a Page.paragraphs element. + - References a Page.lines element. + - References a Page.tokens element. + - References a Page.visual_elements element. + - Refrrences a Page.tables element. + - References a Page.form_fields element. + enum: + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD + page: + description: >- + Required. Index into the Document.pages element, for example using + `Document.pages` to locate the related page element. This field is + skipped when its value is the default `0`. See + https://developers.google.com/protocol-buffers/docs/proto3#json. + format: int64 + type: string + layoutId: + deprecated: true + description: Optional. Deprecated. Use PageRef.bounding_poly instead. type: string - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. confidence: format: float - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. type: number - id: - type: string description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - type: - description: Required. Entity type from a schema e.g. `Address`. + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + boundingPoly: + description: >- + Optional. Identifies the bounding polygon of a layout element on the + page. If `layout_type` is set, the bounding polygon must be exactly + the same to the layout element it's referring to. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + description: Represents a weak reference to a page element within a document. + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + GoogleCloudContentwarehouseV1RuleSet: + description: Represents a set of rules from a single customer. + id: GoogleCloudContentwarehouseV1RuleSet + type: object + properties: + source: + type: string + description: Source of the rules i.e., customer name. + description: + description: Short description of the rule-set. + type: string + name: type: string - properties: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. + The resource name of the rule set. Managed internally. Format: + projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. + The name is ignored when creating a rule set. + rules: + description: List of rules given by the customer. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' type: array - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - mentionId: - description: Optional. Deprecated. Use `id` field instead. + GoogleApiServiceconsumermanagementV1BillingConfig: + type: object + id: GoogleApiServiceconsumermanagementV1BillingConfig + description: Describes the billing configuration for a new tenant project. + properties: + billingAccount: type: string - provenance: - description: Optional. The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - redacted: - type: boolean - description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - normalizedValue: description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. - id: GoogleCloudDocumentaiV1DocumentEntity - GoogleCloudDocumentaiV1DocumentPage: - id: GoogleCloudDocumentaiV1DocumentPage + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. + GoogleCloudDocumentaiV1Document: properties: - provenance: - description: The history of this page. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - paragraphs: + revisions: + description: Placeholder. Revision history of this document. type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - pageNumber: - format: int32 - type: integer - description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - detectedBarcodes: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - type: array - description: A list of detected barcodes. - dimension: - description: Physical dimension of the page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - visualElements: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + pages: type: array - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - tokens: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + description: Visual page layout for the Document. + entityRelations: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - type: array - description: A list of visually detected tokens on the page. - symbols: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' type: array - description: A list of visually detected symbols on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the page. - image: + description: Placeholder. Relationship among Document.entities. + content: description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' - transforms: + Optional. Inline document content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary + representation, whereas JSON representations use base64. + format: byte + type: string + shardInfo: description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' - type: array - blocks: + Information about the sharding if this document is sharded part of a + larger document. If the document is not sharded, this message is not + specified. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' + chunkedDocument: + description: Document chunked based on chunking config. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' + entities: description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. type: array - formFields: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - description: A list of visually detected form fields on the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + text: + type: string + description: Optional. UTF-8 encoded text in reading order from the document. + textStyles: + description: Styles for the Document.text. type: array - detectedLanguages: + deprecated: true items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - imageQualityScores: - description: Image quality scores. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - lines: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + mimeType: + type: string description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' - tables: + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + documentLayout: + description: Parsed layout of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' + uri: + description: >- + Optional. Currently supports Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. + For more information, refer to [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris). + type: string + textChanges: type: array - description: A list of visually detected tables on the page. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - type: object - description: A page in a Document. - GoogleCloudContentwarehouseV1UpdateDocumentRequest: - description: Request message for DocumentService.UpdateDocument. - id: GoogleCloudContentwarehouseV1UpdateDocumentRequest - properties: - document: - description: Required. The document to update. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - cloudAiDocumentOption: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption - description: >- - Request Option for processing Cloud AI Document in Document - Warehouse. This field offers limited support for mapping entities - from Cloud AI Document to Warehouse Document. Please consult with - product team before using this field and other available options. - updateOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' - description: Options for the update operation. - requestMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - type: object - GoogleCloudContentwarehouseV1TextTypeOptions: - type: object - id: GoogleCloudContentwarehouseV1TextTypeOptions - description: Configurations for a text property. - properties: {} - GoogleCloudContentwarehouseV1ExportToCdwPipeline: - id: GoogleCloudContentwarehouseV1ExportToCdwPipeline + Placeholder. A list of text corrections made to Document.text. This + is usually used for annotating corrections to OCR mistakes. Text + changes for a given revision may not overlap with each other. + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + id: GoogleCloudDocumentaiV1Document + description: >- + Document represents the canonical document resource in Document AI. It + is an interchange format that provides insights into documents and + allows for collaboration between users and Document AI to iterate and + optimize for quality. type: object + GoogleCloudContentwarehouseV1PropertyFilter: + id: GoogleCloudContentwarehouseV1PropertyFilter properties: - exportFolderPath: - type: string + condition: description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. - documents: - type: array - description: >- - The list of all the resource names of the documents to be processed. - Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - items: - type: string - trainingSplitRatio: - format: float - description: >- - Ratio of training dataset split. When importing into Document AI - Workbench, documents will be automatically split into training and - test split category with the specified ratio. This field is required - if doc_ai_dataset is set. - type: number - docAiDataset: + The filter condition. The syntax for this expression is a subset of + SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, + `>=`, and `~~` where the left of the operator is a property name and + the right of the operator is a number or a quoted string. You must + escape backslash (\\) and quote (\") characters. `~~` is the LIKE + operator. The right of the operator must be a string. The only + supported property data type for LIKE is text_values. It provides + semantic search functionality by parsing, stemming and doing + synonyms expansion against the input query. It matches if the + property contains semantic similar content to the query. It is not + regex matching or wildcard matching. For example, "property.company + ~~ \"google\"" will match records whose property `property.compnay` + have values like "Google Inc.", "Google LLC" or "Google Company". + Supported functions are `LOWER([property_name])` to perform a case + insensitive match and `EMPTY([property_name])` to filter on the + existence of a key. Boolean expressions (AND/OR/NOT) are supported + up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) + AND E"), a maximum of 100 comparisons or functions are allowed in + the expression. The expression must be < 6000 bytes in length. Only + properties that are marked filterable are allowed + (PropertyDefinition.is_filterable). Property names do not need to be + prefixed by the document schema id (as is the case with histograms), + however property names will need to be prefixed by its parent + hierarchy, if any. For example: top_property_name.sub_property_name. + Sample Query: `(LOWER(driving_license)="class \"a\"" OR + EMPTY(driving_license)) AND driving_years > 10` CMEK compliant + deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and + `>=`. * Boolean expressions: AND and OR. type: string + documentSchemaName: description: >- - Optional. The CDW dataset resource name. This field is optional. If - not set, the documents will be exported to Cloud Storage only. - Format: - projects/{project}/locations/{location}/processors/{processor}/dataset - description: >- - The configuration of exporting documents from the Document Warehouse to - CDW pipeline. - GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: - properties: {} - description: Metadata object for CreateDocument request (currently empty). - id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata + The Document schema name Document.document_schema_name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + type: string type: object - GoogleCloudContentwarehouseV1RuleEvaluatorOutput: + GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: properties: - triggeredRules: - type: array + pipelineConfig: description: >- - List of rules fetched from database for the given request trigger - type. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - invalidRules: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' + Optional. The config for the Cloud Storage Ingestion with DocAI + Processors pipeline. It provides additional customization options to + run the pipeline and can be skipped if it is not applicable. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig + processorResultsFolderPath: + type: string description: >- - A subset of triggered rules that failed the validation check(s) - after parsing. - matchedRules: - type: array + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. + extractProcessorInfos: description: >- - A subset of triggered rules that are evaluated true for a given - request. + The extract processors information. One matched extract processor + will be used to process documents based on the classify processor + result. If no classify processor is specified, the first extract + processor will be used. + type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput - description: Represents the output of the Rule Evaluator. - type: object - GoogleApiServiceconsumermanagementV1BillingConfig: - type: object - id: GoogleApiServiceconsumermanagementV1BillingConfig - properties: - billingAccount: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + inputPath: type: string description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. - description: Describes the billing configuration for a new tenant project. - GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: - type: object - properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. + skipIngestedDocuments: + type: boolean description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest - description: Request message for DocumentLinkService.ListLinkedTargets. - GoogleCloudContentwarehouseV1ListSynonymSetsResponse: + The flag whether to skip ingested documents. If it is set to true, + documents in Cloud Storage contains key "status" with value + "status=ingested" in custom metadata will be skipped to ingest. + splitClassifyProcessorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: >- + The split and classify processor information. The split and classify + result will be used to find a matched extract processor. + id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + description: >- + The configuration of the Cloud Storage Ingestion with DocAI Processors + pipeline. type: object - description: Response message for SynonymSetService.ListSynonymSets. + GoogleIamV1AuditConfig: properties: - synonymSets: + service: + type: string + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + auditLogConfigs: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + description: The configuration for logging of each type of permission. type: array - description: The synonymSets from the specified parent. - nextPageToken: - description: >- - A page token, received from a previous `ListSynonymSets` call. - Provide this to retrieve the subsequent page. - type: string - id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: + id: GoogleIamV1AuditConfig + description: >- + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + GoogleCloudContentwarehouseV1SynonymSet: properties: - blocks: + synonyms: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - description: >- - A list entry is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. + #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym + description: List of Synonyms for the context. type: array - description: Represents an entry in the list. - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: - properties: - documents: - items: - type: string + context: + type: string description: >- - The input list of all the resource names of the documents to be - processed. - type: array - processorInfo: - description: The DocAI processor to process the documents with. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - description: The metadata message for Process-with-DocAi pipeline. - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata - type: object - GoogleCloudContentwarehouseV1FetchAclResponse: + This is a freeform field. Example contexts can be "sales," + "engineering," "real estate," "accounting," etc. The context can be + supplied during search requests. + name: + description: >- + The resource name of the SynonymSet This is mandatory for + google.api.resource. Format: + projects/{project_number}/locations/{location}/synonymSets/{context}. + type: string type: object - description: Response message for DocumentService.FetchAcl. - id: GoogleCloudContentwarehouseV1FetchAclResponse + description: >- + Represents a list of synonyms for a given context. For example a context + "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: + money, credit, finance, payment Synonym 3: shipping, freight, transport + Each SynonymSets should be disjoint + id: GoogleCloudContentwarehouseV1SynonymSet + GoogleCloudDocumentaiV1DocumentEntityRelation: + id: GoogleCloudDocumentaiV1DocumentEntityRelation + description: Relationship between Entities. properties: - metadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - description: >- - Additional information for the API invocation, such as the request - tracking id. - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: The IAM policy. - GoogleCloudContentwarehouseV1CreateDocumentMetadata: + objectId: + type: string + description: Object entity id. + relation: + type: string + description: Relationship description. + subjectId: + type: string + description: Subject entity id. type: object - id: GoogleCloudContentwarehouseV1CreateDocumentMetadata - description: Metadata object for CreateDocument request (currently empty). + GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: properties: {} - GoogleCloudContentwarehouseV1SearchDocumentsResponse: - id: GoogleCloudContentwarehouseV1SearchDocumentsResponse - description: Response message for DocumentService.SearchDocuments. type: object + id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata + description: Metadata object for UpdateDocument request (currently empty). + GoogleCloudContentwarehouseV1DataValidationAction: properties: - nextPageToken: - description: >- - The token that specifies the starting position of the next page of - results. This field is empty if there are no more results. + conditions: + additionalProperties: + type: string + type: object + description: >- + Map of (K, V) -> (field, string condition to be evaluated on the + field) E.g., ("age", "age > 18 && age < 60") entry triggers + validation of field age with the given condition. Map entries will + be ANDed during validation. + description: Represents the action responsible for data validation operations. + id: GoogleCloudContentwarehouseV1DataValidationAction + type: object + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + description: The metadata message for Export-to-CDW pipeline. + type: object + properties: + outputPath: type: string - questionAnswer: - description: Experimental. Question answer from the query against the document. + description: The output Cloud Storage folder in this pipeline. + docAiDataset: type: string - histogramQueryResults: + description: The output CDW dataset resource name. + documents: + description: >- + The input list of all the resource names of the documents to be + exported. items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult + type: string + type: array + GoogleCloudContentwarehouseV1CreateDocumentRequest: + description: Request message for DocumentService.CreateDocument. + id: GoogleCloudContentwarehouseV1CreateDocumentRequest + properties: + cloudAiDocumentOption: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption + description: >- + Request Option for processing Cloud AI Document in Document + Warehouse. This field offers limited support for mapping entities + from Cloud AI Document to Warehouse Document. Please consult with + product team before using this field and other available options. + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: >- + Default document policy during creation. This refers to an Identity + and Access (IAM) policy, which specifies access controls for the + Document. Conditions defined in the policy will be ignored. + createMask: + type: string + format: google-fieldmask + description: >- + Field mask for creating Document fields. If mask path is empty, it + means all fields are masked. For the `FieldMask` definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Required. The document to create. + type: object + GoogleTypeColor: + properties: + green: + type: number + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + red: + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + type: number + alpha: + format: float + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + blue: + type: number + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + type: object + id: GoogleTypeColor + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + GoogleCloudContentwarehouseV1SearchDocumentsResponse: + properties: + histogramQueryResults: description: >- The histogram results that match with the specified SearchDocumentsRequest.histogram_queries. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult type: array + nextPageToken: + description: >- + The token that specifies the starting position of the next page of + results. This field is empty if there are no more results. + type: string metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- Additional information for the API invocation, such as the request tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + questionAnswer: + type: string + description: Experimental. Question answer from the query against the document. matchingDocuments: items: $ref: >- @@ -3121,2020 +3272,1847 @@ components: `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI would handle this condition by displaying "of many", for example: "Displaying 10 of many". - GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: - id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + description: Response message for DocumentService.SearchDocuments. + type: object + id: GoogleCloudContentwarehouseV1SearchDocumentsResponse + GoogleCloudContentwarehouseV1RunPipelineMetadata: properties: - pageToken: - type: string - description: >- - A page token, received from a previous `ListLinkedSources` call. - Provide this to retrieve the subsequent page. When paginating, all - other parameters provided to `ListLinkedSources` must match the call - that provided the page token. - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - pageSize: + gcsIngestPipelineMetadata: + description: The pipeline metadata for GcsIngest pipeline. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + individualDocumentStatuses: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + description: The list of response details of each document. + type: array + totalFileCount: type: integer format: int32 - description: >- - The maximum number of document-links to return. The service may - return fewer than this value. If unspecified, at most 50 - document-links will be returned. The maximum value is 1000; values - above 1000 will be coerced to 1000. - description: Response message for DocumentLinkService.ListLinkedSources. + description: Number of files that were processed by the pipeline. + userInfo: + description: User unique identification and groups information. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + exportToCdwPipelineMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + description: The pipeline metadata for Export-to-CDW pipeline. + processWithDocAiPipelineMetadata: + description: The pipeline metadata for Process-with-DocAi pipeline. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + failedFileCount: + description: Number of files that have failed at some point in the pipeline. + format: int32 + type: integer + type: object + description: Metadata message of RunPipeline method. + id: GoogleCloudContentwarehouseV1RunPipelineMetadata + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: type: object - CloudAiPlatformTenantresourceIamPolicyBinding: - description: >- - The dynamic IAM bindings to be granted after tenant projects are - created. properties: - role: - description: Input/Output [Required]. The role for members below. - type: string - resourceType: + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the header. + text: type: string - enum: - - RESOURCE_TYPE_UNSPECIFIED - - PROJECT - - SERVICE_ACCOUNT - - GCS_BUCKET - - SERVICE_CONSUMER - - AR_REPO + description: Header in text format. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + description: Represents the page header associated with the chunk. + GoogleCloudDocumentaiV1DocumentTextChange: + description: This message is used for text changes aka. OCR corrections. + type: object + properties: + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' description: >- - Input/Output [Required]. Specifies the type of resource that will be - accessed by members. - enumDescriptions: - - '' - - >- - The value of resource field is the ID or number of a project. - Format is - - >- - The value of resource field is the resource name of a service - account. Format is projects//serviceAccounts/ - - >- - The value of resource field is the name of a GCS bucket (not its - resource name). Format is . - - >- - The value of resource field is the resource name of a service - consumer. Format is services//consumers/ - - >- - The value of the resource field is the AR Image Uri which - identifies an AR REPO. Allowed formats are: /// ///: ///@ - resource: + Provenance of the correction. Text anchor indexing into the + Document.text. There can only be a single `TextAnchor.text_segments` + element. If the start and end index of the text segment are the + same, the text change is inserted before that index. + changedText: + description: The text that replaces the text identified in the `text_anchor`. type: string - description: >- - Input/Output [Required]. The resource name that will be accessed by - members, which also depends on resource_type. Note: placeholders are - supported in resource names. For example, ${tpn} will be used when - the tenant project number is not ready. - members: - description: >- - Input/Output [Required]. The member service accounts with the roles - above. Note: placeholders are same as the resource above. + provenance: + type: array + description: The history of this annotation. + deprecated: true items: - type: string + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + id: GoogleCloudDocumentaiV1DocumentTextChange + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + description: Represents a table type block. + properties: + bodyRows: + description: Body rows containing main table content. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow type: array + headerRows: + type: array + description: Header rows at the top of the table. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + caption: + description: Table caption/title. + type: string + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock type: object - id: CloudAiPlatformTenantresourceIamPolicyBinding - GoogleCloudContentwarehouseV1IntegerArray: + GoogleCloudContentwarehouseV1TextArray: type: object - id: GoogleCloudContentwarehouseV1IntegerArray - description: Integer values. properties: values: + description: List of text values. items: - type: integer - format: int32 - description: List of integer values. + type: string type: array - GoogleCloudContentwarehouseV1HistogramQuery: + description: String/text values. + id: GoogleCloudContentwarehouseV1TextArray + GoogleCloudDocumentaiV1DocumentChunkedDocument: + description: Represents the chunks that the document is divided into. properties: - requirePreciseResultSize: + chunks: + type: array + description: List of chunks. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + type: object + id: GoogleCloudDocumentaiV1DocumentChunkedDocument + GoogleCloudContentwarehouseV1EnumArray: + type: object + id: GoogleCloudContentwarehouseV1EnumArray + description: Enum values. + properties: + values: + type: array + items: + type: string + description: List of enum values. + GoogleCloudDocumentaiV1Vertex: + id: GoogleCloudDocumentaiV1Vertex + type: object + properties: + 'y': + type: integer + description: Y coordinate (starts from the top of the image). + format: int32 + x: + description: X coordinate. + format: int32 + type: integer + description: >- + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. + GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: + type: object + description: Response message for projectService.InitializeProject + id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse + properties: + state: + enumDescriptions: + - Clients should never see this. + - Finished project initialization without error. + - Finished project initialization with an error. + - Client canceled the LRO. + - Ask the customer to check the operation for results. + type: string + description: The state of the project initialization process. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING + message: + description: The message of the project initialization process. + type: string + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + description: Font and other text style attributes. + properties: + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + strikeout: description: >- - Controls if the histogram query requires the return of a precise - count. Enable this flag may adversely impact performance. Defaults - to true. + Whether the text is strikethrough. This feature is not supported + yet. type: boolean - histogramQuery: + fontSize: + format: int32 + type: integer + description: Font size in points (`1` point is `¹⁄₇₂` inches). + underlined: + type: boolean + description: Whether the text is underlined. + handwritten: + type: boolean + description: Whether the text is handwritten. + letterSpacing: + type: number + description: Letter spacing in points. + format: double + bold: + type: boolean + description: >- + Whether the text is bold (equivalent to font_weight is at least + `700`). + fontType: + description: Name or style of the font. type: string + fontWeight: + format: int32 description: >- - An expression specifies a histogram request against matching - documents for searches. See SearchDocumentsRequest.histogram_queries - for details about syntax. - filters: + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + type: integer + smallcaps: + type: boolean description: >- - Optional. Filter the result of histogram query by the property - names. It only works with histogram query - count('FilterableProperties'). It is an optional. It will perform - histogram on all the property names for all the document schemas. - Setting this field will have a better performance. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - description: The histogram request. + Whether the text is in small caps. This feature is not supported + yet. + subscript: + type: boolean + description: Whether the text is a subscript. This feature is not supported yet. + pixelFontSize: + format: double + type: number + description: >- + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + italic: + description: Whether the text is italic. + type: boolean + superscript: + type: boolean + description: >- + Whether the text is a superscript. This feature is not supported + yet. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. type: object - id: GoogleCloudContentwarehouseV1HistogramQuery - GoogleCloudContentwarehouseV1FetchAclRequest: + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: + type: object + description: Request message for DocumentSchemaService.UpdateDocumentSchema. properties: - projectOwner: + documentSchema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + description: Required. The document schema to update with. + id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + GoogleCloudContentwarehouseV1DeleteDocumentAction: + properties: + enableHardDelete: description: >- - For Get Project ACL only. Authorization check for end user will be - ignored when project_owner=true. + Boolean field to select between hard vs soft delete options. Set + 'true' for 'hard delete' and 'false' for 'soft delete'. type: boolean + description: Represents the action responsible for deleting the document. + type: object + id: GoogleCloudContentwarehouseV1DeleteDocumentAction + GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: + type: object + properties: requestMetadata: description: >- - The meta information collected about the end user, used to enforce - access control for the service. + The meta information collected about the document creator, used to + enforce access control for the service. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - id: GoogleCloudContentwarehouseV1FetchAclRequest + id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest + description: Request message for DocumentLinkService.DeleteDocumentLink. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: + description: Represents a text type block. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock type: object - description: Request message for DocumentService.FetchAcl - GoogleCloudContentwarehouseV1DocumentReference: - description: References to the documents. - id: GoogleCloudContentwarehouseV1DocumentReference properties: - documentIsRetentionFolder: - description: Document is a folder with retention policy. - type: boolean - documentIsFolder: - type: boolean - description: The document type of the document being referenced. - documentName: - description: Required. Name of the referenced document. + text: type: string - displayName: + description: Text content stored in the block. + type: type: string description: >- - display_name of the referenced document; this name does not need to - be consistent to the display_name in the Document proto, depending - on the ACL constraint. - deleteTime: - type: string - description: Output only. The time when the document is deleted. - format: google-datetime - readOnly: true - updateTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The time when the document is last updated. - documentIsLegalHoldFolder: - type: boolean - description: Document is a folder with legal hold. - createTime: - type: string - description: Output only. The time when the document is created. - readOnly: true - format: google-datetime - snippet: - description: >- - Stores the subset of the referenced document's content. This is - useful to allow user peek the information of the referenced - document. - type: string - type: object - GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: - id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - description: The status of processing a document. - type: object - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - documentId: - description: Document identifier of an existing document. - type: string - GoogleCloudContentwarehouseV1CustomWeightsMetadata: - properties: - weightedSchemaProperties: + Type of the text in the block. Available options are: `paragraph`, + `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + `heading-5`, `header`, `footer`. + blocks: description: >- - List of schema and property name. Allows a maximum of 10 schemas to - be specified for relevance boosting. + A text block could further have child blocks. Repeated blocks + support further hierarchies and nested blocks. items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty - type: array - id: GoogleCloudContentwarehouseV1CustomWeightsMetadata - type: object - description: To support the custom weighting across document schemas. - GoogleCloudContentwarehouseV1TimestampTypeOptions: - type: object - description: Configurations for a timestamp property. - properties: {} - id: GoogleCloudContentwarehouseV1TimestampTypeOptions - GoogleIamV1AuditLogConfig: - type: object - id: GoogleIamV1AuditLogConfig - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - properties: - logType: - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - description: The log type that this config enables. - type: string - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - items: - type: string - type: array - GoogleCloudDocumentaiV1DocumentPageTableTableCell: - properties: - detectedLanguages: - description: A list of detected languages together with confidence. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - rowSpan: - type: integer - description: How many rows this cell spans. - format: int32 - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for TableCell. - colSpan: - format: int32 - type: integer - description: How many columns this cell spans. - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell - description: A cell representation inside the table. + GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: + description: Request message for DocumentLinkService.ListLinkedTargets. type: object - GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: properties: requestMetadata: description: >- The meta information collected about the document creator, used to enforce access control for the service. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: Request message for DocumentLinkService.DeleteDocumentLink. - type: object - id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest - GoogleCloudContentwarehouseV1Action: - type: object - properties: - deleteDocumentAction: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction - description: Action deleting the document. - dataValidation: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction - description: Action triggering data validation operations. - actionId: - description: ID of the action. Managed internally. - type: string - accessControl: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction - description: Action triggering access control operations. - addToFolder: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' - description: Action triggering create document link operation. - publishToPubSub: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' - description: Action publish to Pub/Sub operation. - dataUpdate: - description: Action triggering data update operations. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' - removeFromFolderAction: - description: Action removing a document from a folder. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction - id: GoogleCloudContentwarehouseV1Action - description: Represents the action triggered by Rule Engine when the rule is true. - GoogleCloudContentwarehouseV1ProcessorInfo: - description: The DocAI processor information. + id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest + GoogleCloudDocumentaiV1DocumentPageMatrix: properties: - schemaName: - type: string - description: >- - The Document schema resource name. All documents processed by this - processor will use this schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - processorName: - type: string + type: + type: integer + format: int32 description: >- - The processor resource name. Format is - `projects/{project}/locations/{location}/processors/{processor}`, or - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - documentType: + This encodes information about what data type the matrix uses. For + example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of + OpenCV primitive data types, please refer to + https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + data: type: string - description: The processor will process the documents with this document type. - id: GoogleCloudContentwarehouseV1ProcessorInfo + format: byte + description: The matrix data. + rows: + type: integer + description: Number of rows in the matrix. + format: int32 + cols: + description: Number of columns in the matrix. + format: int32 + type: integer type: object - GoogleTypeInterval: - id: GoogleTypeInterval + id: GoogleCloudDocumentaiV1DocumentPageMatrix description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. + GoogleTypeMoney: type: object + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. properties: - startTime: + nanos: + format: int32 + type: integer 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 + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + currencyCode: type: string - endTime: + description: The three-letter currency code defined in ISO 4217. + units: + format: int64 description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. - format: google-datetime + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - GoogleCloudDocumentaiV1DocumentRevision: - id: GoogleCloudDocumentaiV1DocumentRevision + GoogleCloudContentwarehouseV1UpdateDocumentRequest: + description: Request message for DocumentService.UpdateDocument. type: object - description: Contains past or forward revisions of this document. properties: - agent: - type: string - description: >- - If the change was made by a person specify the name or id of that - person. - processor: - description: >- - If the annotation was made by processor identify the processor by - its resource name. - type: string - id: + cloudAiDocumentOption: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - type: string - parentIds: + Request Option for processing Cloud AI Document in Document + Warehouse. This field offers limited support for mapping entities + from Cloud AI Document to Warehouse Document. Please consult with + product team before using this field and other available options. + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. - items: - type: string - type: array - createTime: - format: google-datetime - type: string - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - parent: - deprecated: true + The meta information collected about the end user, used to enforce + access control for the service. + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Required. The document to update. + updateOptions: + description: Options for the update operation. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' + id: GoogleCloudContentwarehouseV1UpdateDocumentRequest + GoogleCloudContentwarehouseV1RuleActionsPair: + type: object + id: GoogleCloudContentwarehouseV1RuleActionsPair + properties: + actionOutputs: + description: Outputs of executing the actions associated with the above rule. type: array items: - format: int32 - type: integer - description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - humanReview: - description: Human Review information of this revision. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Represents where the chunk starts and ends in the document. - properties: - pageStart: - format: int32 - type: integer - description: Page where chunk starts in the document. - pageEnd: - description: Page where chunk ends in the document. - type: integer - format: int32 + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' + rule: + description: Represents the rule. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + description: Represents a rule and outputs of associated actions. + GoogleCloudContentwarehouseV1IngestPipelineConfig: + id: GoogleCloudContentwarehouseV1IngestPipelineConfig + description: The ingestion pipeline config. type: object - GoogleCloudContentwarehouseV1DocumentQuery: properties: - fileTypeFilter: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' - description: >- - This filter specifies the types of files to return: ALL, FOLDER, or - FILE. If FOLDER or FILE is specified, then only either folders or - files will be returned, respectively. If ALL is specified, both - folders and files will be returned. If no value is specified, ALL - files will be returned. - customWeightsMetadata: - description: >- - To support the custom weighting across document schemas, customers - need to provide the properties to be used to boost the ranking in - the search request. For a search query with CustomWeightsMetadata - specified, only the RetrievalImportance for the properties in the - CustomWeightsMetadata will be honored. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata - propertyFilter: + documentAclPolicy: description: >- - This filter specifies a structured syntax to match against the - PropertyDefinition.is_filterable marked as `true`. The relationship - between the PropertyFilters is OR. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' - documentCreatorFilter: + The document level acl policy config. This refers to an Identity and + Access (IAM) policy, which specifies access controls for all + documents ingested by the pipeline. The role and members under the + policy needs to be specified. The following roles are supported for + document level acl control: * roles/contentwarehouse.documentAdmin * + roles/contentwarehouse.documentEditor * + roles/contentwarehouse.documentViewer The following members are + supported for document level acl control: * + user:user-email@example.com * group:group-email@example.com Note + that for documents searched with LLM, only single level user or + group acl check is supported. + $ref: '#/components/schemas/GoogleIamV1Policy' + folder: + type: string description: >- - The exact creator(s) of the documents to search against. If a value - isn't specified, documents within the search results are associated - with any creator. If multiple values are specified, documents within - the search results may be associated with any of the specified - creators. - items: - type: string - type: array - queryContext: + Optional. The name of the folder to which all ingested documents + will be linked during ingestion process. Format is + `projects/{project}/locations/{location}/documents/{folder_id}` + enableDocumentTextExtraction: + type: boolean description: >- - For custom synonyms. Customers provide the synonyms based on - context. One customer can provide multiple set of synonyms based on - different context. The search query will be expanded based on the - custom synonyms of the query context set. By default, no custom - synonyms wll be applied if no query context is provided. It is not - supported for CMEK compliant deployment. - items: - type: string - type: array - folderNameFilter: + The document text extraction enabled flag. If the flag is set to + true, DWH will perform text extraction on the raw document. + cloudFunction: type: string description: >- - Search all the documents under this specified folder. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - query: + The Cloud Function resource name. The Cloud Function needs to live + inside consumer project and is accessible to Document AI Warehouse + P4SA. Only Cloud Functions V2 is supported. Cloud function execution + should complete within 5 minutes or this file ingestion may fail due + to timeout. Format: + `https://{region}-{project_id}.cloudfunctions.net/{cloud_function}` + The following keys are available the request json payload. * + display_name * properties * plain_text * reference_id * + document_schema_name * raw_document_path * raw_document_file_type + The following keys from the cloud function json response payload + will be ingested to the Document AI Warehouse as part of Document + proto content and/or related information. The original values will + be overridden if any key is present in the response. * display_name + * properties * plain_text * document_acl_policy * folder + GoogleCloudDocumentaiV1DocumentEntity: + type: object + description: >- + An entity that could be a phrase in the text or a property that belongs + to the document. It is a known entity type, such as a person, an + organization, or location. + properties: + type: type: string + description: Required. Entity type from a schema e.g. `Address`. + normalizedValue: description: >- - The query string that matches against the full text of the document - and the searchable properties. The query partially supports [Google - AIP style syntax](https://google.aip.dev/160). Specifically, the - query supports literals, logical operators, negation operators, - comparison operators, and functions. Literals: A bare literal value - (examples: "42", "Hugo") is a value to be matched against. It - searches over the full text of the document and the searchable - properties. Logical operators: "AND", "and", "OR", and "or" are - binary logical operators (example: "engineer OR developer"). - Negation operators: "NOT" and "!" are negation operators (example: - "NOT software"). Comparison operators: support the binary comparison - operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. - Also support like operator `~~` for string. It provides semantic - search functionality by parsing, stemming and doing synonyms - expansion against the input query. To specify a property in the - query, the left hand side expression in the comparison must be the - property ID including the parent. The right hand side must be - literals. For example: "\"projects/123/locations/us\".property_a < - 1" matches results whose "property_a" is less than 1 in project 123 - and us location. The literals and comparison expression can be - connected in a single query (example: "software engineer - \"projects/123/locations/us\".salary > 100"). Functions: supported - functions are `LOWER([property_name])` to perform a case insensitive - match and `EMPTY([property_name])` to filter on the existence of a - key. Support nested expressions connected using parenthesis and - logical operators. The default logical operators is `AND` if there - is no operators between expressions. The query can be used with - other filters e.g. `time_filters` and `folder_name_filter`. They are - connected with `AND` operator under the hood. The maximum number of - allowed characters is 255. - documentNameFilter: + Optional. Normalized entity value. Absent if the extracted value + could not be converted or the type (e.g. address) is not supported + for certain parsers. This field is also only populated for certain + supported document types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + properties: type: array + description: >- + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. items: - type: string + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + id: description: >- - Search the documents in the list. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - documentSchemaNames: - type: array + Optional. Canonical id. This will be a unique value in the entity + list for this document. + type: string + confidence: + type: number + format: float + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + redacted: + type: boolean description: >- - This filter specifies the exact document schema - Document.document_schema_name of the documents to search against. If - a value isn't specified, documents within the search results are - associated with any schema. If multiple values are specified, - documents within the search results may be associated with any of - the specified schemas. At most 20 document schema names are allowed. - items: - type: string - customPropertyFilter: + Optional. Whether the entity will be redacted for de-identification + purposes. + mentionText: + description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. type: string + mentionId: + type: string + description: Optional. Deprecated. Use `id` field instead. + pageAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' description: >- - This filter specifies a structured syntax to match against the - [PropertyDefinition].is_filterable marked as `true`. The syntax for - this expression is a subset of SQL syntax. Supported operators are: - `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator - is a property name and the right of the operator is a number or a - quoted string. You must escape backslash (\\) and quote (\") - characters. Supported functions are `LOWER([property_name])` to - perform a case insensitive match and `EMPTY([property_name])` to - filter on the existence of a key. Boolean expressions (AND/OR/NOT) - are supported up to 3 levels of nesting (for example, "((A AND B AND - C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are - allowed in the expression. The expression must be < 6000 bytes in - length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR - EMPTY(driving_license)) AND driving_years > 10` - deprecated: true - timeFilters: + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + textAnchor: + description: >- + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: Optional. The history of this annotation. + id: GoogleCloudDocumentaiV1DocumentEntity + GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: + properties: + documentLinks: type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + description: Source document-links. + nextPageToken: description: >- - Documents created/updated within a range specified by this filter - are searched against. - isNlQuery: - description: >- - Experimental, do not use. If the query is a natural language - question. False by default. If true, then the question-answering - feature will be used instead of search, and `result_count` in - SearchDocumentsRequest must be set. In addition, all other input - fields related to search (pagination, histograms, etc.) will be - ignored. - type: boolean - type: object - id: GoogleCloudContentwarehouseV1DocumentQuery - GoogleCloudContentwarehouseV1SynonymSetSynonym: - properties: - words: - description: 'For example: sale, invoice, bill, order' - items: - type: string - type: array + 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 + id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse type: object - id: GoogleCloudContentwarehouseV1SynonymSetSynonym - description: >- - Represents a list of words given by the customer All these words are - synonyms of each other. + description: Response message for DocumentLinkService.ListLinkedSources. GoogleCloudContentwarehouseV1EnumValue: - id: GoogleCloudContentwarehouseV1EnumValue - type: object - description: Represents the string value of the enum field. properties: value: + type: string description: >- String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions. - type: string - GoogleCloudContentwarehouseV1FloatTypeOptions: - description: Configurations for a float property. + description: Represents the string value of the enum field. + id: GoogleCloudContentwarehouseV1EnumValue type: object - id: GoogleCloudContentwarehouseV1FloatTypeOptions - properties: {} - GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: + GoogleCloudContentwarehouseV1TimestampValue: + description: Timestamp value type. properties: - name: - description: The schema name in the source. + textValue: + description: >- + The string must represent a valid instant in UTC and is parsed using + java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. + "2013-09-29T18:46:19Z" type: string - processorType: + timestampValue: type: string - description: The Doc AI processor type name. - description: The schema source information. - id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + description: Timestamp value + format: google-datetime type: object - GoogleCloudContentwarehouseV1PropertyTypeOptions: - id: GoogleCloudContentwarehouseV1PropertyTypeOptions - properties: - propertyDefinitions: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition - description: Required. List of property definitions. - description: Configurations for a nested structured data property. + id: GoogleCloudContentwarehouseV1TimestampValue + GoogleCloudContentwarehouseV1PublishAction: + id: GoogleCloudContentwarehouseV1PublishAction type: object - GoogleCloudContentwarehouseV1CreateDocumentRequest: properties: - cloudAiDocumentOption: - description: >- - Request Option for processing Cloud AI Document in Document - Warehouse. This field offers limited support for mapping entities - from Cloud AI Document to Warehouse Document. Please consult with - product team before using this field and other available options. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - policy: - description: >- - Default document policy during creation. This refers to an Identity - and Access (IAM) policy, which specifies access controls for the - Document. Conditions defined in the policy will be ignored. - $ref: '#/components/schemas/GoogleIamV1Policy' - document: - description: Required. The document to create. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - createMask: - description: >- - Field mask for creating Document fields. If mask path is empty, it - means all fields are masked. For the `FieldMask` definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. - format: google-fieldmask + messages: + items: + type: string + type: array + description: Messages to be published. + topicId: type: string - id: GoogleCloudContentwarehouseV1CreateDocumentRequest + description: >- + The topic id in the Pub/Sub service for which messages will be + published to. + description: >- + Represents the action responsible for publishing messages to a Pub/Sub + topic. + GoogleCloudContentwarehouseV1CreateDocumentMetadata: + properties: {} + description: Metadata object for CreateDocument request (currently empty). + id: GoogleCloudContentwarehouseV1CreateDocumentMetadata type: object - description: Request message for DocumentService.CreateDocument. - GoogleCloudContentwarehouseV1SetAclRequest: - id: GoogleCloudContentwarehouseV1SetAclRequest + GoogleCloudContentwarehouseV1RequestMetadata: + description: Meta information is used to improve the performance of the service. type: object - description: Request message for DocumentService.SetAcl. properties: - projectOwner: - type: boolean - description: >- - For Set Project ACL only. Authorization check for end user will be - ignored when project_owner=true. - policy: - description: >- - Required. REQUIRED: The complete policy to be applied to the - `resource`. The size of the policy is limited to a few 10s of KB. - This refers to an Identity and Access (IAM) policy, which specifies - access controls for the Document. You can set ACL with condition for - projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, - and `>=` where the left of the operator is `DocumentSchemaId` or - property name and the right of the operator is a number or a quoted - string. You must escape backslash (\\) and quote (\") characters. - Boolean expressions (AND/OR) are supported up to 3 levels of nesting - (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 - comparisons are allowed in the expression. The expression must be < - 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some - schema id\" OR SchemaId.floatPropertyName >= 10"` - $ref: '#/components/schemas/GoogleIamV1Policy' - requestMetadata: - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - GoogleCloudDocumentaiV1DocumentPageImage: + userInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: Provides user unique identification and groups information. + id: GoogleCloudContentwarehouseV1RequestMetadata + GoogleCloudContentwarehouseV1TimestampTypeOptions: + properties: {} + type: object + id: GoogleCloudContentwarehouseV1TimestampTypeOptions + description: Configurations for a timestamp property. + GoogleCloudContentwarehouseV1UpdateDocumentResponse: + id: GoogleCloudContentwarehouseV1UpdateDocumentResponse properties: - mimeType: - type: string + document: + description: Updated document after executing update request. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + ruleEngineOutput: description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - width: - type: integer - format: int32 - description: Width of the image in pixels. - height: - format: int32 - description: Height of the image in pixels. - type: integer - content: - description: Raw byte content of the image. - type: string - format: byte - id: GoogleCloudDocumentaiV1DocumentPageImage - type: object - description: Rendered image contents for this page. - GoogleCloudDocumentaiV1DocumentProvenance: - description: >- - Structure to identify provenance relationships between annotations in - different revisions. - id: GoogleCloudDocumentaiV1DocumentProvenance + Output from Rule Engine recording the rule evaluator and action + executor's output. Refer format in: + google/cloud/contentwarehouse/v1/rule_engine.proto + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + metadata: + description: >- + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + description: Response message for DocumentService.UpdateDocument. type: object + GoogleCloudDocumentaiV1DocumentPage: properties: - revision: - type: integer + imageQualityScores: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + description: Image quality scores. + tables: + description: A list of visually detected tables on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' deprecated: true - description: The index of the revision that produced this element. + description: The history of this page. + image: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + description: >- + Rendered image for this page. This image is preprocessed to remove + any skew, rotation, and distortions such that the annotation + bounding boxes can be upright and axis-aligned. + formFields: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + description: A list of visually detected form fields on the page. + type: array + pageNumber: + type: integer format: int32 - parents: - description: References to the original elements that are replaced. + description: >- + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. + detectedBarcodes: type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent - id: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + description: A list of detected barcodes. + tokens: + type: array + description: A list of visually detected tokens on the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + symbols: + description: A list of visually detected symbols on the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' + type: array + lines: description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - format: int32 - type: integer - deprecated: true - type: - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - type: string - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. - description: The type of provenance operation. - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: - type: object - properties: - confidence: - description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - type: number - format: float - type: - type: string + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' + type: array + transforms: description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` - description: Image Quality Defects - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - GoogleCloudContentwarehouseV1ProjectStatus: - type: object - id: GoogleCloudContentwarehouseV1ProjectStatus - description: >- - Status of a project, including the project state, dbType, aclMode and - etc. - properties: - accessControlMode: - enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - type: string - description: Access control mode. - enumDescriptions: - - This value is required by protobuf best practices - - 'Universal Access: No document level access control.' - - Document level access control with customer own Identity Service. - - Document level access control using Google Cloud Identity. - location: - description: The location of the queried project. - type: string - state: - description: State of the project. - enum: - - PROJECT_STATE_UNSPECIFIED - - PROJECT_STATE_PENDING - - PROJECT_STATE_COMPLETED - - PROJECT_STATE_FAILED - - PROJECT_STATE_DELETING - - PROJECT_STATE_DELETING_FAILED - - PROJECT_STATE_DELETED - - PROJECT_STATE_NOT_FOUND - enumDescriptions: - - Default status, required by protobuf best practices. - - The project is in the middle of a provision process. - - All dependencies have been provisioned. - - A provision process was previously initiated, but failed. - - The project is in the middle of a deletion process. - - A deleting process was initiated, but failed. - - The project is deleted. - - The project is not found. - type: string - databaseType: - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - description: Database type. - type: string - enumDeprecated: - - false - - false - - true - documentCreatorDefaultRole: - type: string - description: The default role for the person who create a document. - qaEnabled: - type: boolean - description: If the qa is enabled on this project. - GoogleCloudDocumentaiV1Barcode: - properties: - valueFormat: + Transformation matrices that were applied to the original document + image to produce Page.image. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + type: array + visualElements: description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - type: string - format: - type: string + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + paragraphs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. - rawValue: + A list of visually detected text paragraphs on the page. A + collection of lines that a human would perceive as a paragraph. + dimension: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + description: Physical dimension of the page. + layout: + description: Layout for the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + blocks: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + type: array description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - type: string - type: object - description: Encodes the detailed information of a barcode. - id: GoogleCloudDocumentaiV1Barcode - GoogleTypeTimeZone: - id: GoogleTypeTimeZone - properties: - version: - description: Optional. IANA Time Zone Database version number, e.g. "2019a". - type: string - id: - type: string - description: IANA Time Zone Database time zone, e.g. "America/New_York". - type: object - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - GoogleCloudDocumentaiV1DocumentPageLayout: - id: GoogleCloudDocumentaiV1DocumentPageLayout + A list of visually detected text blocks on the page. A block has a + set of lines (collected into paragraphs) that have a common + line-spacing and orientation. + description: A page in a Document. type: object + id: GoogleCloudDocumentaiV1DocumentPage + GoogleIamV1Binding: properties: - boundingPoly: - description: The bounding polygon for the Layout. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - orientation: - type: string - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - enumDescriptions: - - Unspecified orientation. - - Orientation is aligned with page up. - - >- - Orientation is aligned with page right. Turn the head 90 degrees - clockwise from upright to read. - - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. - - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - description: Detected orientation for the Layout. - confidence: + members: + items: + type: string + type: array description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. - format: float - type: number - description: Visual element describing a layout unit on a page. - CloudAiPlatformTenantresourceServiceAccountIdentity: - description: The identity to configure a service account. - properties: - serviceAccountEmail: - description: Output only. The service account email that has been created. - type: string - tag: + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + role: type: string description: >- - Input/Output [Optional]. The tag that configures the service - account, as defined in - google3/configs/production/cdpush/acl-zanzibar-cloud-prod/activation_grants/activation_grants.gcl. - Note: The default P4 service account has the empty tag. + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + condition: + $ref: '#/components/schemas/GoogleTypeExpr' + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. type: object - id: CloudAiPlatformTenantresourceServiceAccountIdentity - GoogleCloudContentwarehouseV1LockDocumentRequest: - id: GoogleCloudContentwarehouseV1LockDocumentRequest - description: Request message for DocumentService.LockDocument. + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: properties: - lockingUser: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: The user information who locks the document. - collectionId: + type: + description: >- + Name of the defect type. Supported values are: - + `quality/defect_blurry` - `quality/defect_noisy` - + `quality/defect_dark` - `quality/defect_faint` - + `quality/defect_text_too_small` - `quality/defect_document_cutoff` - + `quality/defect_text_cutoff` - `quality/defect_glare` type: string - description: The collection the document connects to. + confidence: + format: float + type: number + description: >- + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + description: Image Quality Defects + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect type: object - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: - description: Represents a text type block. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + description: Represents a cell in a table row. type: object properties: + colSpan: + format: int32 + description: How many columns this cell spans. + type: integer + rowSpan: + type: integer + format: int32 + description: How many rows this cell spans. blocks: - type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock description: >- - A text block could further have child blocks. Repeated blocks - support further hierarchies and nested blocks. - type: - type: string - description: >- - Type of the text in the block. Available options are: `paragraph`, - `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, - `heading-5`, `header`, `footer`. - text: - type: string - description: Text content stored in the block. - GoogleCloudContentwarehouseV1InvalidRule: - properties: - rule: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: Triggered rule. - error: - type: string - description: Validation error on a parsed expression. - type: object - id: GoogleCloudContentwarehouseV1InvalidRule - description: A triggered rule that failed the validation check(s) after parsing. - GoogleCloudContentwarehouseV1ResponseMetadata: - properties: - requestId: - type: string - description: >- - A unique id associated with this call. This id is logged for - tracking purpose. - type: object - id: GoogleCloudContentwarehouseV1ResponseMetadata - description: >- - Additional information returned to client, such as debugging - information. - GoogleCloudDocumentaiV1DocumentPageAnchor: + A table cell is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + type: array + GoogleCloudContentwarehouseV1PropertyArray: type: object - description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. + id: GoogleCloudContentwarehouseV1PropertyArray + description: Property values. properties: - pageRefs: - type: array + properties: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - description: One or more references to visual page elements - id: GoogleCloudDocumentaiV1DocumentPageAnchor - GoogleRpcStatus: - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' + type: array + description: List of property values. + GoogleCloudDocumentaiV1Barcode: + description: Encodes the detailed information of a barcode. properties: - message: + rawValue: + type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + format: + description: >- + Format of a barcode. The supported formats are: - `CODE_128`: Code + 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - + `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - + `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - + `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E + type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - + `DATABAR`: GS1 DataBar code type. + type: string + valueFormat: type: string - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - GoogleCloudContentwarehouseV1CloudAIDocumentOption: - description: Request Option for processing Cloud AI Document in CW Document. + Value format describes the format of the value that a barcode + encodes. The supported formats are: - `CONTACT_INFO`: Contact + information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - + `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - + `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi + information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar + event. - `DRIVER_LICENSE`: Driver's license. type: object - properties: - customizedEntitiesPropertiesConversions: - additionalProperties: - type: string - type: object - description: If set, only selected entities will be converted to properties. - enableEntitiesConversions: - type: boolean - description: Whether to convert all the entities to properties. - id: GoogleCloudContentwarehouseV1CloudAIDocumentOption - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + id: GoogleCloudDocumentaiV1Barcode + GoogleCloudContentwarehouseV1ActionOutput: type: object - description: Font and other text style attributes. - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo properties: - bold: - type: boolean - description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - strikeout: - type: boolean - description: >- - Whether the text is strikethrough. This feature is not supported - yet. - fontSize: - format: int32 - type: integer - description: Font size in points (`1` point is `¹⁄₇₂` inches). - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - letterSpacing: - type: number - format: double - description: Letter spacing in points. - pixelFontSize: - description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - type: number - format: double - superscript: - description: >- - Whether the text is a superscript. This feature is not supported - yet. - type: boolean - subscript: - type: boolean - description: Whether the text is a subscript. This feature is not supported yet. - italic: - description: Whether the text is italic. - type: boolean - fontWeight: - format: int32 - type: integer - description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - underlined: - type: boolean - description: Whether the text is underlined. - handwritten: - type: boolean - description: Whether the text is handwritten. - smallcaps: - type: boolean - description: >- - Whether the text is in small caps. This feature is not supported - yet. - fontType: + actionState: + enum: + - UNKNOWN + - ACTION_SUCCEEDED + - ACTION_FAILED + - ACTION_TIMED_OUT + - ACTION_PENDING + type: string + description: State of an action. + enumDescriptions: + - The unknown state. + - State indicating action executed successfully. + - State indicating action failed. + - State indicating action timed out. + - State indicating action is pending. + actionId: + description: ID of the action. type: string - description: Name or style of the font. - GoogleCloudContentwarehouseV1Document: - description: Defines the structure for content warehouse document proto. + outputMessage: + description: Action execution output message. + type: string + id: GoogleCloudContentwarehouseV1ActionOutput + description: Represents the result of executing an action. + GoogleCloudContentwarehouseV1IntegerArray: + type: object + id: GoogleCloudContentwarehouseV1IntegerArray + description: Integer values. + properties: + values: + items: + format: int32 + type: integer + description: List of integer values. + type: array + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: type: object + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + description: Represents an entry in the list. properties: - dispositionTime: - readOnly: true - type: string + blocks: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + type: array description: >- - Output only. If linked to a Collection with RetentionPolicy, the - date when the document becomes mutable. - format: google-datetime - inlineRawDocument: - format: byte - type: string - description: Raw document content. - documentSchemaName: - type: string + A list entry is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: + type: object + description: Request message for DocumentLinkService.CreateDocumentLink. + properties: + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - The Document schema name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - plainText: - type: string - description: Other document format, such as PPTX, XLXS - textExtractionEnabled: - description: If true, text extraction will be performed. - type: boolean - properties: + The meta information collected about the document creator, used to + enforce access control for the service. + documentLink: + description: >- + Required. Document links associated with the source documents + (source_document_id). + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + GoogleCloudDocumentaiV1DocumentPageTable: + description: A table representation similar to HTML table structure. + properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Table. + detectedLanguages: + description: A list of detected languages together with confidence. + type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - description: List of values that are user supplied metadata. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + headerRows: type: array - updater: - type: string - description: The user who lastly updates the document. - legalHold: - type: boolean - readOnly: true - description: Output only. Indicates if the document has a legal hold on it. - referenceId: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: Header rows of the table. + bodyRows: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: Body rows of the table. + type: array + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this table. + id: GoogleCloudDocumentaiV1DocumentPageTable + type: object + GoogleCloudContentwarehouseV1InitializeProjectResponse: + id: GoogleCloudContentwarehouseV1InitializeProjectResponse + description: Response message for projectService.InitializeProject + type: object + properties: + state: + enumDescriptions: + - Clients should never see this. + - Finished project initialization without error. + - Finished project initialization with an error. + - Client canceled the LRO. + - Ask the customer to check the operation for results. type: string - description: >- - The reference ID set by customers. Must be unique per project and - location. - displayUri: + description: The state of the project initialization process. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING + message: type: string - description: Uri to display the document, for example, in the UI. - rawDocumentPath: - description: Raw document file in Cloud Storage path. + description: The message of the project initialization process. + GoogleCloudContentwarehouseV1InitializeProjectRequest: + type: object + id: GoogleCloudContentwarehouseV1InitializeProjectRequest + description: Request message for projectService.InitializeProject + properties: + documentCreatorDefaultRole: + description: Optional. The default role for the person who create a document. + enum: + - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED + - DOCUMENT_ADMIN + - DOCUMENT_EDITOR + - DOCUMENT_VIEWER type: string - name: + enumDescriptions: + - Unspecified, will be default to document admin role. + - >- + Document Admin, same as + contentwarehouse.googleapis.com/documentAdmin. + - >- + Document Editor, same as + contentwarehouse.googleapis.com/documentEditor. + - >- + Document Viewer, same as + contentwarehouse.googleapis.com/documentViewer. + databaseType: + enumDeprecated: + - false + - false + - true + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES type: string - description: >- - The resource name of the document. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - The name is ignored when creating a document. - title: + description: Required. The type of database used to store customer data + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + enableCalUserEmailLogging: + type: boolean + description: Optional. Whether to enable CAL user email logging. + kmsKey: type: string description: >- - Title that describes the document. This can be the top heading or - text that describes the document. - rawDocumentFileType: + Optional. The KMS key used for CMEK encryption. It is required that + the kms key is in the same region as the endpoint. The same key will + be used for all provisioned resources, if encryption is available. + If the kms_key is left empty, no encryption will be enforced. + accessControlMode: enumDescriptions: - - No raw document specified or it is non-parsable - - Adobe PDF format - - Microsoft Word format - - Microsoft Excel format - - Microsoft Powerpoint format - - UTF-8 encoded text format - - TIFF or TIF image file format - description: >- - This is used when DocAI was not used to load the document and - parsing/ extracting is needed for the inline_raw_document. For - example, if inline_raw_document is the byte representation of a PDF - file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. - type: string + - This value is required by protobuf best practices + - 'Universal Access: No document level access control.' + - Document level access control with customer own Identity Service. + - Document level access control using Google Cloud Identity. enum: - - RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED - - RAW_DOCUMENT_FILE_TYPE_PDF - - RAW_DOCUMENT_FILE_TYPE_DOCX - - RAW_DOCUMENT_FILE_TYPE_XLSX - - RAW_DOCUMENT_FILE_TYPE_PPTX - - RAW_DOCUMENT_FILE_TYPE_TEXT - - RAW_DOCUMENT_FILE_TYPE_TIFF - contentCategory: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI type: string + description: Required. The access control mode for accessing the customer data + GoogleCloudDocumentaiV1DocumentStyleFontSize: + properties: + unit: description: >- - Indicates the category (image, audio, video etc.) of the original - content. - enum: - - CONTENT_CATEGORY_UNSPECIFIED - - CONTENT_CATEGORY_IMAGE - - CONTENT_CATEGORY_AUDIO - - CONTENT_CATEGORY_VIDEO - enumDescriptions: - - No category is specified. - - Content is of image type. - - Content is of audio type. - - Content is of video type. - cloudAiDocument: - description: Document AI format to save the structured content, including OCR. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - createTime: - type: string - description: Output only. The time when the document is created. - readOnly: true - format: google-datetime - displayName: + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). type: string + size: + description: Font size for the text. + format: float + type: number + id: GoogleCloudDocumentaiV1DocumentStyleFontSize + description: Font size with unit. + type: object + GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: + id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + description: Response message for DocumentSchemaService.ListDocumentSchemas. + properties: + documentSchemas: + description: The document schemas from the specified parent. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + type: array + nextPageToken: description: >- - Required. Display name of the document given by the user. This name - will be displayed in the UI. Customer can populate this field with - the name of the document. This differs from the 'title' field as - 'title' is optional and stores the top heading in the document. - updateTime: - type: string - description: Output only. The time when the document is last updated. - format: google-datetime - readOnly: true - textExtractionDisabled: - description: If true, text extraction will not be performed. - deprecated: true - type: boolean - creator: - description: The user who creates the document. + 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 - id: GoogleCloudContentwarehouseV1Document - GoogleCloudContentwarehouseV1QAResultHighlight: - id: GoogleCloudContentwarehouseV1QAResultHighlight + type: object + GoogleCloudDocumentaiV1DocumentPageToken: type: object properties: - startIndex: - description: Start index of the highlight. - type: integer - format: int32 - endIndex: - format: int32 - description: End index of the highlight, exclusive. - type: integer + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Token. + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + detectedBreak: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. + styleInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Text style attributes. + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + id: GoogleCloudDocumentaiV1DocumentPageToken + description: A detected token. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Represents a row in a table. + properties: + cells: + description: A table row is a list of table cells. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + type: array + type: object + GoogleCloudContentwarehouseV1MapProperty: + id: GoogleCloudContentwarehouseV1MapProperty + type: object description: >- - A text span in the search text snippet that represents a highlighted - section (answer context, highly relevant sentence, etc.). - CloudAiPlatformTenantresourceTenantServiceAccountIdentity: + Map property value. Represents a structured entries of key value pairs, + consisting of field names which map to dynamically typed values. + properties: + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' + description: Unordered map of dynamically typed values. + GoogleLongrunningOperation: type: object description: >- - The identity of service accounts that have been explicitly created under - tenant projects. - id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation properties: - serviceName: + done: description: >- - Input/Output [Required]. The service that the service account - belongs to. (e.g. cloudbuild.googleapis.com for GCB service - accounts) - type: string - serviceAccountEmail: - description: Output only. The email address of the generated service account. + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + metadata: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + name: type: string - GoogleCloudContentwarehouseV1RuleSet: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + GoogleCloudContentwarehouseV1DocumentQuery: properties: - rules: + folderNameFilter: + type: string + description: >- + Search all the documents under this specified folder. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + propertyFilter: + description: >- + This filter specifies a structured syntax to match against the + PropertyDefinition.is_filterable marked as `true`. The relationship + between the PropertyFilters is OR. + type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: List of rules given by the customer. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' + isNlQuery: + type: boolean + description: >- + Experimental, do not use. If the query is a natural language + question. False by default. If true, then the question-answering + feature will be used instead of search, and `result_count` in + SearchDocumentsRequest must be set. In addition, all other input + fields related to search (pagination, histograms, etc.) will be + ignored. + documentNameFilter: type: array - source: - type: string - description: Source of the rules i.e., customer name. - name: + items: + type: string description: >- - The resource name of the rule set. Managed internally. Format: - projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. - The name is ignored when creating a rule set. - type: string - description: - type: string - description: Short description of the rule-set. - type: object - id: GoogleCloudContentwarehouseV1RuleSet - description: Represents a set of rules from a single customer. - GoogleCloudContentwarehouseV1IngestPipelineConfig: - id: GoogleCloudContentwarehouseV1IngestPipelineConfig - properties: - cloudFunction: - type: string + Search the documents in the list. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + customWeightsMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata description: >- - The Cloud Function resource name. The Cloud Function needs to live - inside consumer project and is accessible to Document AI Warehouse - P4SA. Only Cloud Functions V2 is supported. Cloud function execution - should complete within 5 minutes or this file ingestion may fail due - to timeout. Format: - `https://{region}-{project_id}.cloudfunctions.net/{cloud_function}` - The following keys are available the request json payload. * - display_name * properties * plain_text * reference_id * - document_schema_name * raw_document_path * raw_document_file_type - The following keys from the cloud function json response payload - will be ingested to the Document AI Warehouse as part of Document - proto content and/or related information. The original values will - be overridden if any key is present in the response. * display_name - * properties * plain_text * document_acl_policy * folder - documentAclPolicy: - $ref: '#/components/schemas/GoogleIamV1Policy' + To support the custom weighting across document schemas, customers + need to provide the properties to be used to boost the ranking in + the search request. For a search query with CustomWeightsMetadata + specified, only the RetrievalImportance for the properties in the + CustomWeightsMetadata will be honored. + documentCreatorFilter: description: >- - The document level acl policy config. This refers to an Identity and - Access (IAM) policy, which specifies access controls for all - documents ingested by the pipeline. The role and members under the - policy needs to be specified. The following roles are supported for - document level acl control: * roles/contentwarehouse.documentAdmin * - roles/contentwarehouse.documentEditor * - roles/contentwarehouse.documentViewer The following members are - supported for document level acl control: * - user:user-email@example.com * group:group-email@example.com Note - that for documents searched with LLM, only single level user or - group acl check is supported. - enableDocumentTextExtraction: + The exact creator(s) of the documents to search against. If a value + isn't specified, documents within the search results are associated + with any creator. If multiple values are specified, documents within + the search results may be associated with any of the specified + creators. + items: + type: string + type: array + customPropertyFilter: + type: string + deprecated: true + description: >- + This filter specifies a structured syntax to match against the + [PropertyDefinition].is_filterable marked as `true`. The syntax for + this expression is a subset of SQL syntax. Supported operators are: + `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator + is a property name and the right of the operator is a number or a + quoted string. You must escape backslash (\\) and quote (\") + characters. Supported functions are `LOWER([property_name])` to + perform a case insensitive match and `EMPTY([property_name])` to + filter on the existence of a key. Boolean expressions (AND/OR/NOT) + are supported up to 3 levels of nesting (for example, "((A AND B AND + C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are + allowed in the expression. The expression must be < 6000 bytes in + length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR + EMPTY(driving_license)) AND driving_years > 10` + fileTypeFilter: description: >- - The document text extraction enabled flag. If the flag is set to - true, DWH will perform text extraction on the raw document. - type: boolean - folder: - type: string + This filter specifies the types of files to return: ALL, FOLDER, or + FILE. If FOLDER or FILE is specified, then only either folders or + files will be returned, respectively. If ALL is specified, both + folders and files will be returned. If no value is specified, ALL + files will be returned. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' + queryContext: description: >- - Optional. The name of the folder to which all ingested documents - will be linked during ingestion process. Format is - `projects/{project}/locations/{location}/documents/{folder_id}` - type: object - description: The ingestion pipeline config. - GoogleCloudDocumentaiV1DocumentDocumentLayout: - type: object - description: >- - Represents the parsed layout of a document as a collection of blocks - that the document is divided into. - properties: - blocks: - type: array - description: List of blocks in the document. + For custom synonyms. Customers provide the synonyms based on + context. One customer can provide multiple set of synonyms based on + different context. The search query will be expanded based on the + custom synonyms of the query context set. By default, no custom + synonyms wll be applied if no query context is provided. It is not + supported for CMEK compliant deployment. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - id: GoogleCloudDocumentaiV1DocumentDocumentLayout - GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: - description: Request message for DocumentSchemaService.UpdateDocumentSchema. - id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest - properties: - documentSchema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - description: Required. The document schema to update with. - type: object - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: - description: Represents a chunk. - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - properties: - pageFooters: + type: string type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - description: Page footers associated with the chunk. - sourceBlockIds: - description: Unused. + documentSchemaNames: items: type: string type: array - pageHeaders: - description: Page headers associated with the chunk. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - content: - description: Text content of the chunk. - type: string - chunkId: - type: string - description: ID of the chunk. - pageSpan: - description: Page span of the chunk. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - type: object - GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: - properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - documentLink: + This filter specifies the exact document schema + Document.document_schema_name of the documents to search against. If + a value isn't specified, documents within the search results are + associated with any schema. If multiple values are specified, + documents within the search results may be associated with any of + the specified schemas. At most 20 document schema names are allowed. + timeFilters: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' + type: array description: >- - Required. Document links associated with the source documents - (source_document_id). - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - type: object - id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest - description: Request message for DocumentLinkService.CreateDocumentLink. - GoogleCloudContentwarehouseV1InitializeProjectRequest: - id: GoogleCloudContentwarehouseV1InitializeProjectRequest - description: Request message for projectService.InitializeProject - properties: - documentCreatorDefaultRole: - enum: - - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED - - DOCUMENT_ADMIN - - DOCUMENT_EDITOR - - DOCUMENT_VIEWER - enumDescriptions: - - Unspecified, will be default to document admin role. - - >- - Document Admin, same as - contentwarehouse.googleapis.com/documentAdmin. - - >- - Document Editor, same as - contentwarehouse.googleapis.com/documentEditor. - - >- - Document Viewer, same as - contentwarehouse.googleapis.com/documentViewer. - description: Optional. The default role for the person who create a document. - type: string - databaseType: - type: string - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - enumDeprecated: - - false - - false - - true - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - description: Required. The type of database used to store customer data - kmsKey: + Documents created/updated within a range specified by this filter + are searched against. + query: type: string description: >- - Optional. The KMS key used for CMEK encryption. It is required that - the kms key is in the same region as the endpoint. The same key will - be used for all provisioned resources, if encryption is available. - If the kms_key is left empty, no encryption will be enforced. - accessControlMode: - description: Required. The access control mode for accessing the customer data - type: string - enumDescriptions: - - This value is required by protobuf best practices - - 'Universal Access: No document level access control.' - - Document level access control with customer own Identity Service. - - Document level access control using Google Cloud Identity. - enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - enableCalUserEmailLogging: - type: boolean - description: Optional. Whether to enable CAL user email logging. + The query string that matches against the full text of the document + and the searchable properties. The query partially supports [Google + AIP style syntax](https://google.aip.dev/160). Specifically, the + query supports literals, logical operators, negation operators, + comparison operators, and functions. Literals: A bare literal value + (examples: "42", "Hugo") is a value to be matched against. It + searches over the full text of the document and the searchable + properties. Logical operators: "AND", "and", "OR", and "or" are + binary logical operators (example: "engineer OR developer"). + Negation operators: "NOT" and "!" are negation operators (example: + "NOT software"). Comparison operators: support the binary comparison + operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. + Also support like operator `~~` for string. It provides semantic + search functionality by parsing, stemming and doing synonyms + expansion against the input query. To specify a property in the + query, the left hand side expression in the comparison must be the + property ID including the parent. The right hand side must be + literals. For example: "\"projects/123/locations/us\".property_a < + 1" matches results whose "property_a" is less than 1 in project 123 + and us location. The literals and comparison expression can be + connected in a single query (example: "software engineer + \"projects/123/locations/us\".salary > 100"). Functions: supported + functions are `LOWER([property_name])` to perform a case insensitive + match and `EMPTY([property_name])` to filter on the existence of a + key. Support nested expressions connected using parenthesis and + logical operators. The default logical operators is `AND` if there + is no operators between expressions. The query can be used with + other filters e.g. `time_filters` and `folder_name_filter`. They are + connected with `AND` operator under the hood. The maximum number of + allowed characters is 255. type: object - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: + id: GoogleCloudContentwarehouseV1DocumentQuery + GoogleCloudContentwarehouseV1MapTypeOptions: + description: Configurations for a Map property. type: object - description: The metadata message for Export-to-CDW pipeline. - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + properties: {} + id: GoogleCloudContentwarehouseV1MapTypeOptions + GoogleCloudContentwarehouseV1GcsIngestPipeline: properties: - docAiDataset: - description: The output CDW dataset resource name. - type: string - outputPath: - description: The output Cloud Storage folder in this pipeline. - type: string - documents: + processorType: description: >- - The input list of all the resource names of the documents to be - exported. - type: array - items: - type: string - GoogleTypeDate: - id: GoogleTypeDate - properties: - month: - format: int32 - type: integer + The Doc AI processor type name. Only used when the format of + ingested files is Doc AI Document proto format. + type: string + skipIngestedDocuments: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - day: - type: integer + The flag whether to skip ingested documents. If it is set to true, + documents in Cloud Storage contains key "status" with value + "status=ingested" in custom metadata will be skipped to ingest. + type: boolean + inputPath: + type: string description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 - year: - format: int32 - type: integer + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. + pipelineConfig: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + Optional. The config for the Cloud Storage Ingestion pipeline. It + provides additional customization options to run the pipeline and + can be skipped if it is not applicable. + schemaName: + type: string + description: >- + The Document Warehouse schema resource name. All documents processed + by this pipeline will use this schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + id: GoogleCloudContentwarehouseV1GcsIngestPipeline + description: The configuration of the Cloud Storage Ingestion pipeline. type: object - GoogleCloudDocumentaiV1BoundingPoly: - description: A bounding polygon for the detected image annotation. + GoogleCloudDocumentaiV1DocumentPageSymbol: type: object + description: A detected symbol. properties: - normalizedVertices: + detectedLanguages: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' - description: The bounding polygon normalized vertices. - type: array - vertices: - description: The bounding polygon vertices. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - id: GoogleCloudDocumentaiV1BoundingPoly - CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: - description: >- - The options to create a spanner database. KMS key access audit logging - and AxT logging will be associated with the given resource name, - resource type and service name. Please ensure to give right options to - enable correct audit logging and AxT logging. + description: A list of detected languages together with confidence. + layout: + description: Layout for Symbol. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + id: GoogleCloudDocumentaiV1DocumentPageSymbol + GoogleCloudContentwarehouseV1UpdateDocumentMetadata: + properties: {} + type: object + description: Metadata object for UpdateDocument request (currently empty). + id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata + GoogleCloudContentwarehouseV1SetAclRequest: + description: Request message for DocumentService.SetAcl. type: object properties: - cmekServiceName: + projectOwner: description: >- - The service name for the CMEK encryption. For example, - contentwarehouse.googleapis.com - type: string + For Set Project ACL only. Authorization check for end user will be + ignored when project_owner=true. + type: boolean + requestMetadata: + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + policy: + description: >- + Required. REQUIRED: The complete policy to be applied to the + `resource`. The size of the policy is limited to a few 10s of KB. + This refers to an Identity and Access (IAM) policy, which specifies + access controls for the Document. You can set ACL with condition for + projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, + and `>=` where the left of the operator is `DocumentSchemaId` or + property name and the right of the operator is a number or a quoted + string. You must escape backslash (\\) and quote (\") characters. + Boolean expressions (AND/OR) are supported up to 3 levels of nesting + (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 + comparisons are allowed in the expression. The expression must be < + 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some + schema id\" OR SchemaId.floatPropertyName >= 10"` + $ref: '#/components/schemas/GoogleIamV1Policy' + id: GoogleCloudContentwarehouseV1SetAclRequest + CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: + type: object + properties: cmekCloudResourceType: + type: string description: >- The cloud resource type for the CMEK encryption. For example, contentwarehouse.googleapis.com/Location + cmekServiceName: + description: >- + The service name for the CMEK encryption. For example, + contentwarehouse.googleapis.com type: string cmekCloudResourceName: type: string description: >- The cloud resource name for the CMEK encryption. For example, projects//locations/ - id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions - GoogleCloudContentwarehouseV1SynonymSet: description: >- - Represents a list of synonyms for a given context. For example a context - "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: - money, credit, finance, payment Synonym 3: shipping, freight, transport - Each SynonymSets should be disjoint - id: GoogleCloudContentwarehouseV1SynonymSet + The options to create a spanner database. KMS key access audit logging + and AxT logging will be associated with the given resource name, + resource type and service name. Please ensure to give right options to + enable correct audit logging and AxT logging. + id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + GoogleCloudContentwarehouseV1DataUpdateAction: type: object + description: Represents the action responsible for properties update operations. properties: - context: - type: string - description: >- - This is a freeform field. Example contexts can be "sales," - "engineering," "real estate," "accounting," etc. The context can be - supplied during search requests. - synonyms: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym - type: array - description: List of Synonyms for the context. - name: + entries: + type: object description: >- - The resource name of the SynonymSet This is mandatory for - google.api.resource. Format: - projects/{project_number}/locations/{location}/synonymSets/{context}. - type: string - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + Map of (K, V) -> (valid name of the field, new value of the field) + E.g., ("age", "60") entry triggers update of field age with a value + of 60. If the field is not present then new entry is added. During + update action execution, value strings will be casted to appropriate + types. + additionalProperties: + type: string + id: GoogleCloudContentwarehouseV1DataUpdateAction + GoogleCloudContentwarehouseV1TextTypeOptions: + properties: {} + id: GoogleCloudContentwarehouseV1TextTypeOptions + description: Configurations for a text property. type: object + GoogleCloudContentwarehouseV1Property: + description: Property of a document. properties: - listEntries: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry - description: List entries that constitute a list block. - type: + textValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' + description: String/text property values. + enumValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' + description: Enum property values. + propertyValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' + description: Nested structured data property values. + timestampValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' + description: >- + Timestamp property values. It is not supported by CMEK compliant + deployment. + floatValues: + description: Float property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' + mapProperty: + description: Map property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' + integerValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' + description: Integer property values. + dateTimeValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' + description: >- + Date time property values. It is not supported by CMEK compliant + deployment. + name: type: string description: >- - Type of the list_entries (if exist). Available options are `ordered` - and `unordered`. - description: Represents a list type block. - GoogleCloudDocumentaiV1DocumentPageBlock: - id: GoogleCloudDocumentaiV1DocumentPageBlock - description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. + Required. Must match the name of a PropertyDefinition in the + DocumentSchema. type: object - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Block. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this annotation. - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - properties: - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the footer. - text: - type: string - description: Footer in text format. + id: GoogleCloudContentwarehouseV1Property + GoogleCloudContentwarehouseV1CloudAIDocumentOption: + description: Request Option for processing Cloud AI Document in CW Document. + id: GoogleCloudContentwarehouseV1CloudAIDocumentOption type: object - description: Represents the page footer associated with the chunk. - GoogleCloudContentwarehouseV1Rule: properties: - description: - type: string - description: Short description of the rule and its context. - condition: - description: >- - Represents the conditional expression to be evaluated. Expression - should evaluate to a boolean result. When the condition is true - actions are executed. Example: user_role = "hsbc_role_1" AND - doc.salary > 20000 - type: string - ruleId: - type: string - description: >- - ID of the rule. It has to be unique across all the examples. This is - managed internally. - triggerType: - enumDescriptions: - - Trigger for unknown action. - - Trigger for create document action. - - Trigger for update document action. - - Trigger for create link action. - - Trigger for delete link action. + customizedEntitiesPropertiesConversions: + additionalProperties: + type: string + type: object + description: If set, only selected entities will be converted to properties. + enableEntitiesConversions: + type: boolean + description: Whether to convert all the entities to properties. + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + description: The metadata message for GcsIngest pipeline. + properties: + inputPath: type: string - description: Identifies the trigger type for running the policy. - enum: - - UNKNOWN - - ON_CREATE - - ON_UPDATE - - ON_CREATE_LINK - - ON_DELETE_LINK - actions: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' - type: array - description: List of actions that are executed when the rule is satisfied. + description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' type: object - id: GoogleCloudContentwarehouseV1Rule - description: Represents the rule for a content warehouse trigger. - GoogleCloudDocumentaiV1DocumentPageTable: - id: GoogleCloudDocumentaiV1DocumentPageTable + GoogleCloudDocumentaiV1DocumentPageImage: type: object - description: A table representation similar to HTML table structure. properties: - headerRows: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - description: Header rows of the table. - type: array - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this table. - layout: - description: Layout for Table. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - bodyRows: - description: Body rows of the table. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - detectedLanguages: - type: array - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + content: + type: string + format: byte + description: Raw byte content of the image. + width: + description: Width of the image in pixels. + format: int32 + type: integer + mimeType: + type: string + description: >- + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + height: + description: Height of the image in pixels. + format: int32 + type: integer + description: Rendered image contents for this page. + id: GoogleCloudDocumentaiV1DocumentPageImage GoogleCloudContentwarehouseV1RunPipelineRequest: + type: object + id: GoogleCloudContentwarehouseV1RunPipelineRequest properties: + gcsIngestPipeline: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' + description: Cloud Storage ingestion pipeline. exportCdwPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline description: >- Export docuemnts from Document Warehouse to CDW for training purpose. - processWithDocAiPipeline: - description: >- - Use a DocAI processor to process documents in Document Warehouse, - and re-ingest the updated results into Document Warehouse. $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline - gcsIngestPipeline: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' - description: Cloud Storage ingestion pipeline. + #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- The meta information collected about the end user, used to enforce access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' gcsIngestWithDocAiProcessorsPipeline: $ref: >- #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline description: >- Use DocAI processors to process documents in Cloud Storage and ingest them to Document Warehouse. + processWithDocAiPipeline: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + description: >- + Use a DocAI processor to process documents in Document Warehouse, + and re-ingest the updated results into Document Warehouse. description: Request message for DocumentService.RunPipeline. - type: object - id: GoogleCloudContentwarehouseV1RunPipelineRequest - GoogleIamV1Policy: - id: GoogleIamV1Policy + GoogleCloudContentwarehouseV1UpdateOptions: + description: Options for Update operations. + id: GoogleCloudContentwarehouseV1UpdateOptions properties: - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - bindings: - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - version: + updateMask: description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - format: int32 - etag: + Field mask for merging Document fields. For the `FieldMask` + definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + format: google-fieldmask + type: string + mergeFieldsOptions: + description: Options for merging. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' + updateType: + description: Type for update. + enum: + - UPDATE_TYPE_UNSPECIFIED + - UPDATE_TYPE_REPLACE + - UPDATE_TYPE_MERGE + - UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES + - UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES + - UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES + - UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES type: string + enumDescriptions: + - Defaults to full replace behavior, ie. FULL_REPLACE. + - >- + Fully replace all the fields (including previously linked raw + document). Any field masks will be ignored. + - Merge the fields into the existing entities. + - Inserts the properties by names. + - Replace the properties by names. + - Delete the properties by names. + - >- + For each of the property, replaces the property if the it exists, + otherwise inserts a new property. And for the rest of the fields, + merge them based on update mask and merge fields options. + type: object + CloudAiPlatformTenantresourceTenantServiceAccountIdentity: + properties: + serviceName: description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - format: byte - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + Input/Output [Required]. The service that the service account + belongs to. (e.g. cloudbuild.googleapis.com for GCB service + accounts) + type: string + serviceAccountEmail: + type: string + description: Output only. The email address of the generated service account. type: object - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity + description: >- + The identity of service accounts that have been explicitly created under + tenant projects. + GoogleCloudContentwarehouseV1FileTypeFilter: properties: - text: + fileType: type: string + enum: + - FILE_TYPE_UNSPECIFIED + - ALL + - FOLDER + - DOCUMENT + - ROOT_FOLDER + enumDescriptions: + - Default document type. If set, disables the filter. + - Returns all document types, including folders. + - Returns only folders. + - Returns only non-folder documents. + - Returns only root folders + description: The type of files to return. + id: GoogleCloudContentwarehouseV1FileTypeFilter + description: Filter for the specific types of documents returned. + type: object + GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: + id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument + type: object + description: Document entry with metadata inside SearchDocumentsResponse + properties: + qaResult: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - addressValue: - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' - description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - floatValue: - type: number - format: float - description: Float value. - booleanValue: - type: boolean + Experimental. Additional result info if the question-answering + feature is enabled. + matchedTokenPageIndices: description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' + Return the 1-based page indices where those pages have one or more + matched tokens. + items: + format: int64 + type: string + type: array + document: description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - integerValue: - type: integer - description: Integer value. - format: int32 - moneyValue: + Document that matches the specified SearchDocumentsRequest. This + document only contains indexed metadata information. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + searchTextSnippet: + type: string description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - $ref: '#/components/schemas/GoogleTypeMoney' + Contains snippets of text from the document full raw text that most + closely match a search query's keywords, if available. All HTML tags + in the original fields are stripped when returned in this field, and + matching query keywords are enclosed in HTML bold tags. If the + question-answering feature is enabled, this field will instead + contain a snippet that answers the user's natural-language query. No + HTML bold tags will be present, and highlights in the answer snippet + can be found in QAResult.highlights. + GoogleProtobufEmpty: + 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: GoogleProtobufEmpty type: object - description: Parsed and normalized entity value. - GoogleCloudDocumentaiV1Document: + properties: {} + CloudAiPlatformTenantresourceCloudSqlInstanceConfig: description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. - id: GoogleCloudDocumentaiV1Document + The identity to configure a CloudSQL instance provisioned via SLM + Terraform. + type: object properties: - entityRelations: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' - type: array - description: Placeholder. Relationship among Document.entities. - documentLayout: - description: Parsed layout of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' - uri: + cloudSqlInstanceName: type: string description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - content: - format: byte - description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. + Input/Output [Optional]. The CloudSQL instance name within SLM + instance. If not set, a random UUIC will be generated as instance + name. + cloudSqlInstanceConnectionName: type: string - textStyles: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - type: array - deprecated: true - description: Styles for the Document.text. - text: - description: Optional. UTF-8 encoded text in reading order from the document. + description: Output only. The CloudSQL instance connection name. + slmInstanceType: + type: string + description: Input [Required]. The SLM instance type to provision CloudSQL. + kmsKeyReference: type: string - revisions: - type: array - description: Placeholder. Revision history of this document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' - textChanges: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. + Input [Optional]. The KMS key name or the KMS grant name used for + CMEK encryption. Only set this field when provisioning new CloudSQL + instances. For existing CloudSQL instances, this field will be + ignored because CMEK re-encryption is not supported. + slmInstanceName: + type: string + description: Output only. The SLM instance's full resource name. + mdbRolesForCorpAccess: type: array - pages: + description: Input [Optional]. MDB roles for corp access to CloudSQL instance. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - description: Visual page layout for the Document. - type: array - entities: + type: string + slmInstanceTemplate: + type: string + description: Input [Required]. The SLM instance template to provision CloudSQL. + id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig + GoogleCloudDocumentaiV1DocumentShardInfo: + type: object + id: GoogleCloudDocumentaiV1DocumentShardInfo + properties: + shardIndex: + description: The 0-based index of this shard. + type: string + format: int64 + shardCount: + description: Total number of shards. + format: int64 + type: string + textOffset: + format: int64 + description: >- + The index of the first character in Document.text in the overall + document global text. + type: string + description: >- + For a large document, sharding may be performed to produce several + document shards. Each document shard contains this field to detail which + shard it is. + GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: + id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + type: object + properties: + nextPageToken: + type: string + 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. + documentLinks: + description: Target document-links. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' type: array + description: Response message for DocumentLinkService.ListLinkedTargets. + GoogleCloudContentwarehouseV1AccessControlAction: + id: GoogleCloudContentwarehouseV1AccessControlAction + properties: + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - chunkedDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' - description: Document chunked based on chunking config. - error: - description: Any error that occurred while processing this document. - $ref: '#/components/schemas/GoogleRpcStatus' - mimeType: - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + Represents the new policy from which bindings are added, removed or + replaced based on the type of the operation. the policy is limited + to a few 10s of KB. + operationType: + description: Identifies the type of operation. type: string - shardInfo: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' + enum: + - UNKNOWN + - ADD_POLICY_BINDING + - REMOVE_POLICY_BINDING + - REPLACE_POLICY_BINDING + enumDescriptions: + - The unknown operation type. + - Adds newly given policy bindings in the existing bindings list. + - >- + Removes newly given policy bindings from the existing bindings + list. + - >- + Replaces existing policy bindings with the given policy binding + list + description: >- + Represents the action responsible for access control list management + operations. + type: object + GoogleCloudContentwarehouseV1SetAclResponse: + id: GoogleCloudContentwarehouseV1SetAclResponse + type: object + properties: + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: The policy will be attached to a resource (e.g. projecct, document). + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + description: >- + Additional information for the API invocation, such as the request + tracking id. + description: Response message for DocumentService.SetAcl. + GoogleTypeDate: + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + id: GoogleTypeDate + properties: + year: + format: int32 + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + month: + format: int32 + type: integer description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - type: object - GoogleCloudContentwarehouseV1DateTimeTypeOptions: - id: GoogleCloudContentwarehouseV1DateTimeTypeOptions - properties: {} - description: Configurations for a date time property. - type: object + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. parameters: - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto callback: description: JSONP in: query name: callback schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string key: @@ -5146,21 +5124,43 @@ components: name: key schema: type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - _.xgafv: - description: V1 error format. + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' + - json + - media + - proto + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string x-stackQL-resources: projects: id: google.contentwarehouse.projects @@ -5197,74 +5197,66 @@ components: update: [] replace: [] delete: [] - document_schemas: - id: google.contentwarehouse.document_schemas - name: document_schemas - title: Document_schemas + locations: + id: google.contentwarehouse.locations + name: locations + title: Locations methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: + run_pipeline: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:runPipeline/post response: mediaType: application/json openAPIDocKey: '200' - create: + initialize: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:initialize/post response: mediaType: application/json openAPIDocKey: '200' - list: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + status: + id: google.contentwarehouse.status + name: status + title: Status + methods: + get_status: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:getStatus/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.documentSchemas sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/get' - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/patch' + - $ref: '#/components/x-stackQL-resources/status/methods/get_status' + insert: [] + update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' + delete: [] rule_sets: id: google.contentwarehouse.rule_sets name: rule_sets title: Rule_sets methods: - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -5275,21 +5267,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.ruleSets + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.ruleSets sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/rule_sets/methods/get' @@ -5320,15 +5312,81 @@ components: update: [] replace: [] delete: [] + document_schemas: + id: google.contentwarehouse.document_schemas + name: document_schemas + title: Document_schemas + methods: + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.documentSchemas + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' synonym_sets: id: google.contentwarehouse.synonym_sets name: synonym_sets title: Synonym_sets methods: - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -5340,61 +5398,74 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.synonymSets - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' + document_links: + id: google.contentwarehouse.document_links + name: document_links + title: Document_links + methods: delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/get' - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/list' + select: [] insert: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' + - $ref: '#/components/x-stackQL-resources/document_links/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' + - $ref: '#/components/x-stackQL-resources/document_links/methods/delete' reference_id: id: google.contentwarehouse.reference_id name: reference_id title: Reference_id methods: - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:get/post response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:get/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:delete/post response: mediaType: application/json openAPIDocKey: '200' @@ -5407,42 +5478,15 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/reference_id/methods/delete' - document_links: - id: google.contentwarehouse.document_links - name: document_links - title: Document_links - methods: - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/document_links/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/document_links/methods/delete' documents: id: google.contentwarehouse.documents name: documents title: Documents methods: - lock: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:lock/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -5453,52 +5497,52 @@ components: response: mediaType: application/json openAPIDocKey: '200' - set_acl: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:setAcl/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - delete: + linked_targets: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedTargets/post response: mediaType: application/json openAPIDocKey: '200' - create: + linked_sources: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedSources/post response: mediaType: application/json openAPIDocKey: '200' - linked_sources: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedSources/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post response: mediaType: application/json openAPIDocKey: '200' - linked_targets: + lock: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedTargets/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:lock/post response: mediaType: application/json openAPIDocKey: '200' - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents/post response: mediaType: application/json openAPIDocKey: '200' - get: + set_acl: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:setAcl/post response: mediaType: application/json openAPIDocKey: '200' @@ -5531,64 +5575,20 @@ components: update: [] replace: [] delete: [] - locations: - id: google.contentwarehouse.locations - name: locations - title: Locations - methods: - initialize: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:initialize/post - response: - mediaType: application/json - openAPIDocKey: '200' - run_pipeline: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:runPipeline/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - status: - id: google.contentwarehouse.status - name: status - title: Status - methods: - get_status: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:getStatus/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/status/methods/get_status' - insert: [] - update: [] - replace: [] - delete: [] paths: /v1/projects/{projectsId}:setAcl: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' post: description: >- Sets the access control policy for a resource. Replaces any existing @@ -5651,91 +5651,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: + /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: parameters: *ref_1 - get: - description: >- - Gets a document schema. Returns NOT_FOUND if the document schema does - not exist. - operationId: contentwarehouse.projects.locations.documentSchemas.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: documentSchemasId - required: true - schema: - type: string - delete: - description: >- - Deletes a document schema. Returns NOT_FOUND if the document schema does - not exist. Returns BAD_REQUEST if the document schema has documents - depending on it. - operationId: contentwarehouse.projects.locations.documentSchemas.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: documentSchemasId - required: true - schema: - type: string - patch: - description: >- - Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the - Document Schema is non-empty and does not equal the existing name. - Supports only appending new properties, adding new ENUM possible values, - and updating the EnumTypeOptions.validation_check_disabled flag for ENUM - possible values. Updating existing properties will result into - INVALID_ARGUMENT. - operationId: contentwarehouse.projects.locations.documentSchemas.patch + post: + description: Run a predefined pipeline. + operationId: contentwarehouse.projects.locations.runPipeline requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5747,8 +5673,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5760,21 +5685,11 @@ paths: required: true schema: type: string - - in: path - name: documentSchemasId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: + /v1/projects/{projectsId}/locations/{locationsId}:getStatus: parameters: *ref_1 - post: - description: Creates a document schema. - operationId: contentwarehouse.projects.locations.documentSchemas.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + get: + description: Get the project status. + operationId: contentwarehouse.projects.locations.getStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5787,7 +5702,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus parameters: - in: path name: projectsId @@ -5797,11 +5712,21 @@ paths: - in: path name: locationsId required: true - schema: - type: string - get: - description: Lists document schemas. - operationId: contentwarehouse.projects.locations.documentSchemas.list + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:initialize: + parameters: *ref_1 + post: + description: >- + Provisions resources for given tenant project. Returns a long running + operation. + operationId: contentwarehouse.projects.locations.initialize + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1InitializeProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5813,8 +5738,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5826,20 +5750,11 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}: parameters: *ref_1 - delete: - description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.delete + get: + description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. + operationId: contentwarehouse.projects.locations.ruleSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5851,7 +5766,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -5868,9 +5783,9 @@ paths: required: true schema: type: string - get: - description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.get + delete: + description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.ruleSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5882,7 +5797,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5940,14 +5855,9 @@ paths: type: string /v1/projects/{projectsId}/locations/{locationsId}/ruleSets: parameters: *ref_1 - post: - description: Creates a ruleset. - operationId: contentwarehouse.projects.locations.ruleSets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + get: + description: Lists rulesets. + operationId: contentwarehouse.projects.locations.ruleSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5959,7 +5869,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListRuleSetsResponse parameters: - in: path name: projectsId @@ -5971,9 +5882,23 @@ paths: required: true schema: type: string - get: - description: Lists rulesets. - operationId: contentwarehouse.projects.locations.ruleSets.list + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a ruleset. + operationId: contentwarehouse.projects.locations.ruleSets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5985,8 +5910,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListRuleSetsResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -5998,15 +5922,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 get: @@ -6043,18 +5958,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: parameters: *ref_1 - post: + patch: description: >- - Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS - exception if a synonymset already exists for the context. - operationId: contentwarehouse.projects.locations.synonymSets.create + Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the + Document Schema is non-empty and does not equal the existing name. + Supports only appending new properties, adding new ENUM possible values, + and updating the EnumTypeOptions.validation_check_disabled flag for ENUM + possible values. Updating existing properties will result into + INVALID_ARGUMENT. + operationId: contentwarehouse.projects.locations.documentSchemas.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6066,7 +5986,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -6078,9 +5999,17 @@ paths: required: true schema: type: string - get: - description: Returns all SynonymSets (for all contexts) for the specified location. - operationId: contentwarehouse.projects.locations.synonymSets.list + - in: path + name: documentSchemasId + required: true + schema: + type: string + delete: + description: >- + Deletes a document schema. Returns NOT_FOUND if the document schema does + not exist. Returns BAD_REQUEST if the document schema has documents + depending on it. + operationId: contentwarehouse.projects.locations.documentSchemas.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6092,8 +6021,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6105,27 +6033,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: documentSchemasId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: - parameters: *ref_1 - patch: + get: description: >- - Remove the existing SynonymSet for the context and replaces it with a - new one. Throws a NOT_FOUND exception if the SynonymSet is not found. - operationId: contentwarehouse.projects.locations.synonymSets.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + Gets a document schema. Returns NOT_FOUND if the document schema does + not exist. + operationId: contentwarehouse.projects.locations.documentSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6137,7 +6054,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -6150,15 +6068,15 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: documentSchemasId required: true schema: type: string - delete: - description: >- - Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception - if the SynonymSet is not found. - operationId: contentwarehouse.projects.locations.synonymSets.delete + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: + parameters: *ref_1 + get: + description: Lists document schemas. + operationId: contentwarehouse.projects.locations.documentSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6170,7 +6088,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse parameters: - in: path name: projectsId @@ -6182,16 +6101,23 @@ paths: required: true schema: type: string - - in: path - name: synonymSetsId - required: true + - in: query + name: pageToken schema: type: string - get: - description: >- - Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception - if the Synonymset does not exist - operationId: contentwarehouse.projects.locations.synonymSets.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a document schema. + operationId: contentwarehouse.projects.locations.documentSchemas.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6203,7 +6129,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -6215,22 +6142,18 @@ paths: required: true schema: type: string - - in: path - name: synonymSetsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: parameters: *ref_1 - post: - description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.delete + patch: + description: >- + Remove the existing SynonymSet for the context and replaces it with a + new one. Throws a NOT_FOUND exception if the SynonymSet is not found. + operationId: contentwarehouse.projects.locations.synonymSets.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6242,7 +6165,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6255,23 +6178,48 @@ paths: schema: type: string - in: path - name: referenceIdId + name: synonymSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: - parameters: *ref_1 - patch: + get: description: >- - Updates a document. Returns INVALID_ARGUMENT if the name of the document - is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.documents.referenceId.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest + Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception + if the Synonymset does not exist + operationId: contentwarehouse.projects.locations.synonymSets.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: synonymSetsId + required: true + schema: + type: string + delete: + description: >- + Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception + if the SynonymSet is not found. + operationId: contentwarehouse.projects.locations.synonymSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6283,8 +6231,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6297,21 +6244,15 @@ paths: schema: type: string - in: path - name: referenceIdId + name: synonymSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: parameters: *ref_1 - post: - description: Gets a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.get - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest + get: + description: Returns all SynonymSets (for all contexts) for the specified location. + operationId: contentwarehouse.projects.locations.synonymSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6323,7 +6264,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse parameters: - in: path name: projectsId @@ -6335,22 +6277,25 @@ paths: required: true schema: type: string - - in: path - name: referenceIdId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Create a link between a source document and a target document. - operationId: contentwarehouse.projects.locations.documents.documentLinks.create + description: >- + Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS + exception if a synonymset already exists for the context. + operationId: contentwarehouse.projects.locations.synonymSets.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6362,7 +6307,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6374,11 +6319,6 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete: parameters: *ref_1 post: @@ -6423,17 +6363,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: parameters: *ref_1 post: - description: Lock the document so the document cannot be updated by other users. - operationId: contentwarehouse.projects.locations.documents.lock + description: Create a link between a source document and a target document. + operationId: contentwarehouse.projects.locations.documents.documentLinks.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6445,7 +6385,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' parameters: - in: path name: projectsId @@ -6462,19 +6402,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents:search: + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: parameters: *ref_1 - post: + patch: description: >- - Searches for documents using provided SearchDocumentsRequest. This call - only returns documents that the caller has permission to search against. - operationId: contentwarehouse.projects.locations.documents.search + Updates a document. Returns INVALID_ARGUMENT if the name of the document + is non-empty and does not equal the existing name. + operationId: contentwarehouse.projects.locations.documents.referenceId.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6487,7 +6427,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse parameters: - in: path name: projectsId @@ -6499,18 +6439,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: + - in: path + name: referenceIdId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: parameters: *ref_1 post: - description: >- - Sets the access control policy for a resource. Replaces any existing - policy. - operationId: contentwarehouse.projects.locations.documents.setAcl + description: Gets a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.referenceId.get requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6522,8 +6466,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -6536,15 +6479,15 @@ paths: schema: type: string - in: path - name: documentsId + name: referenceIdId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: parameters: *ref_1 post: description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.delete + operationId: contentwarehouse.projects.locations.documents.referenceId.delete requestBody: content: application/json: @@ -6575,24 +6518,23 @@ paths: schema: type: string - in: path - name: documentsId + name: referenceIdId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: parameters: *ref_1 - post: + patch: description: >- - Gets the access control policy for a resource. Returns NOT_FOUND error - if the resource does not exist. Returns an empty policy if the resource - exists but does not have a policy set. - operationId: contentwarehouse.projects.locations.documents.fetchAcl + Updates a document. Returns INVALID_ARGUMENT if the name of the document + is non-empty and does not equal the existing name. + operationId: contentwarehouse.projects.locations.documents.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6605,7 +6547,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse parameters: - in: path name: projectsId @@ -6622,17 +6564,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents: + /v1/projects/{projectsId}/locations/{locationsId}/documents:search: parameters: *ref_1 post: - description: Creates a document. - operationId: contentwarehouse.projects.locations.documents.create + description: >- + Searches for documents using provided SearchDocumentsRequest. This call + only returns documents that the caller has permission to search against. + operationId: contentwarehouse.projects.locations.documents.search requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6645,7 +6589,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentResponse + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse parameters: - in: path name: projectsId @@ -6657,17 +6601,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: parameters: *ref_1 post: - description: Return all source document-links from the document. - operationId: contentwarehouse.projects.locations.documents.linkedSources + description: Deletes a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.delete requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6679,8 +6623,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6737,19 +6680,60 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: parameters: *ref_1 - patch: + post: + description: Return all source document-links from the document. + operationId: contentwarehouse.projects.locations.documents.linkedSources + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: + parameters: *ref_1 + post: description: >- - Updates a document. Returns INVALID_ARGUMENT if the name of the document - is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.documents.patch + Gets the access control policy for a resource. Returns NOT_FOUND error + if the resource does not exist. Returns an empty policy if the resource + exists but does not have a policy set. + operationId: contentwarehouse.projects.locations.documents.fetchAcl requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6762,7 +6746,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse parameters: - in: path name: projectsId @@ -6818,19 +6802,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:initialize: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: parameters: *ref_1 post: - description: >- - Provisions resources for given tenant project. Returns a long running - operation. - operationId: contentwarehouse.projects.locations.initialize + description: Lock the document so the document cannot be updated by other users. + operationId: contentwarehouse.projects.locations.documents.lock requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1InitializeProjectRequest + #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6842,7 +6824,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -6854,11 +6836,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:getStatus: + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents: parameters: *ref_1 - get: - description: Get the project status. - operationId: contentwarehouse.projects.locations.getStatus + post: + description: Creates a document. + operationId: contentwarehouse.projects.locations.documents.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6871,7 +6864,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentResponse parameters: - in: path name: projectsId @@ -6883,17 +6876,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: parameters: *ref_1 post: - description: Run a predefined pipeline. - operationId: contentwarehouse.projects.locations.runPipeline + description: >- + Sets the access control policy for a resource. Replaces any existing + policy. + operationId: contentwarehouse.projects.locations.documents.setAcl requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6905,7 +6899,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse parameters: - in: path name: projectsId @@ -6917,3 +6912,8 @@ paths: required: true schema: type: string + - in: path + name: documentsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml index ab6940f5..15e9cda5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml @@ -7,7 +7,7 @@ info: title: Dataflow API description: Manages Google Cloud Dataflow projects on Google Cloud Platform. version: v1b3 - x-discovery-doc-revision: '20240909' + x-discovery-doc-revision: '20240916' x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/dataflow diff --git a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml index 1f27b878..1f41eaa8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml @@ -34,82 +34,51 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDatacatalogLineageV1OperationMetadata: - id: GoogleCloudDatacatalogLineageV1OperationMetadata - type: object + GoogleCloudDatacatalogLineageV1SearchLinksRequest: properties: - operationType: - description: Output only. The type of the operation being performed. - type: string - enum: - - TYPE_UNSPECIFIED - - DELETE - - CREATE - readOnly: true - enumDescriptions: - - Unused. - - The resource deletion operation. - - The resource creation operation. - state: - readOnly: true - type: string - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - description: Output only. The current operation state. - enumDescriptions: - - Unused. - - The operation has been created but is not yet started. - - The operation is underway. - - The operation completed successfully. - - The operation is no longer running and did not succeed. - createTime: - type: string + pageToken: description: >- - Output only. The timestamp of the operation submission to the - server. - readOnly: true - format: google-datetime - resourceUuid: - readOnly: true + Optional. The page token received from a previous + `SearchLinksRequest` call. Use it to get the next page. When + requesting subsequent pages of a response, remember that all + parameters must match the values you provided in the original + request. type: string - description: Output only. The UUID of the resource being operated on. - resource: - readOnly: true + target: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' description: >- - Output only. The [relative name] - (https://cloud.google.com//apis/design/resource_names#relative_resource_name) - of the resource being operated on. - type: string - endTime: - format: google-datetime - type: string - readOnly: true + Optional. Send asset information in the **target** field to retrieve + all links that lead from upstream assets to the specified asset. + pageSize: description: >- - Output only. The timestamp of the operation termination, regardless - of its success. This field is unset if the operation is still - ongoing. - description: Metadata describing the operation. - GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: + Optional. The maximum number of links to return in a single page of + the response. A page may contain fewer links than this value. If + unspecified, at most 10 links are returned. Maximum value is 100; + values greater than 100 are reduced to 100. + type: integer + format: int32 + source: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + description: >- + Optional. Send asset information in the **source** field to retrieve + all links that lead from the specified asset to downstream assets. + description: Request message for SearchLinks. + id: GoogleCloudDatacatalogLineageV1SearchLinksRequest type: object - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse - description: Response message for BatchSearchLinkProcesses. + GoogleCloudDatacatalogLineageV1EntityReference: + type: object + id: GoogleCloudDatacatalogLineageV1EntityReference properties: - nextPageToken: - type: string + fullyQualifiedName: description: >- - The token to specify as `page_token` in the subsequent call to get - the next page. Omitted if there are no more pages in the response. - processLinks: - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' - type: array - description: An array of processes associated with the specified links. + Required. [Fully Qualified Name + (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) + of the entity. + type: string + description: The soft reference to everything you can attach a lineage event to. GoogleCloudDatacatalogLineageV1SearchLinksResponse: description: Response message for SearchLinks. + type: object id: GoogleCloudDatacatalogLineageV1SearchLinksResponse properties: nextPageToken: @@ -118,296 +87,225 @@ components: the next page. Omitted if there are no more pages in the response. type: string links: - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Link' + type: array description: >- The list of links for a given asset. Can be empty if the asset has no relations of requested type (source or target). - type: array - type: object - GoogleCloudDatacatalogLineageV1Origin: - id: GoogleCloudDatacatalogLineageV1Origin + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Link' + GoogleCloudDatacatalogLineageV1Run: + id: GoogleCloudDatacatalogLineageV1Run + description: >- + A lineage run represents an execution of a process that creates lineage + events. type: object - description: Origin of a process. properties: - name: + displayName: type: string description: >- - If the source_type isn't CUSTOM, the value of this field should be a - GCP resource name of the system, which reports lineage. The project - and location parts of the resource name must match the project and - location of the lineage resource being created. Examples: - - `{source_type: COMPOSER, name: - "projects/foo/locations/us/environments/bar"}` - `{source_type: - BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: - CUSTOM, name: "myCustomIntegration"}` - sourceType: + Optional. A human-readable name you can set to display in a user + interface. Must be not longer than 1024 characters and only contain + UTF-8 letters or numbers, spaces or characters like `_-:&.` + startTime: + description: Required. The timestamp of the start of the run. + format: google-datetime + type: string + name: description: >- - Type of the source. Use of a source_type other than `CUSTOM` for - process creation or updating is highly discouraged, and may be - restricted in the future without notice. - enum: - - SOURCE_TYPE_UNSPECIFIED - - CUSTOM - - BIGQUERY - - DATA_FUSION - - COMPOSER - - LOOKER_STUDIO - - DATAPROC - - VERTEX_AI + Immutable. The resource name of the run. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. + Can be specified or auto-assigned. {run} must be not longer than 200 + characters and only contain characters in a set: `a-zA-Z0-9_-:.` type: string + attributes: + description: >- + Optional. The attributes of the run. Should only be used for the + purpose of non-semantic management (classifying, describing or + labeling the run). Up to 100 attributes are allowed. + additionalProperties: + type: any + type: object + state: enumDescriptions: - - Source is Unspecified - - A custom source - - BigQuery - - Data Fusion - - Composer - - Looker Studio - - Dataproc - - Vertex AI + - >- + The state is unknown. The true state may be any of the below or a + different state that is not supported here explicitly. + - The run is still executing. + - The run completed. + - The run failed. + - The run aborted. + description: Required. The state of the run. + type: string + enum: + - UNKNOWN + - STARTED + - COMPLETED + - FAILED + - ABORTED + endTime: + type: string + format: google-datetime + description: Optional. The timestamp of the end of the run. GoogleCloudDatacatalogLineageV1ListLineageEventsResponse: + id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse properties: nextPageToken: - type: string description: >- The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages. + type: string lineageEvents: - description: Lineage events from the specified project and location. items: $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' + description: Lineage events from the specified project and location. type: array type: object - id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse description: Response message for ListLineageEvents. - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - type: object + GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: properties: - message: + process: type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - details: - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + Created process name. Format: + `projects/{project}/locations/{location}/processes/{process}`. + lineageEvents: type: array description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - GoogleCloudDatacatalogLineageV1ProcessLinkInfo: - id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo - properties: - link: - type: string + Created lineage event names. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. + items: + type: string + run: description: >- - The name of the link in the format of - `projects/{project}/locations/{location}/links/{link}`. - endTime: - description: The end of the last event establishing this link-process tuple. - format: google-datetime - type: string - startTime: - format: google-datetime + Created run name. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. type: string - description: The start of the first event establishing this link-process tuple. - description: Link details. + id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + description: Response message for ProcessOpenLineageRunEvent. type: object - GoogleLongrunningListOperationsResponse: + GoogleCloudDatacatalogLineageV1Origin: + description: Origin of a process. + id: GoogleCloudDatacatalogLineageV1Origin type: object - description: The response message for Operations.ListOperations. - id: GoogleLongrunningListOperationsResponse properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest: - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest - type: object - properties: - pageToken: - description: >- - The page token received from a previous `BatchSearchLinkProcesses` - call. Use it to get the next page. When requesting subsequent pages - of a response, remember that all parameters must match the values - you provided in the original request. + sourceType: type: string - pageSize: - type: integer - description: >- - The maximum number of processes to return in a single page of the - response. A page may contain fewer results than this value. - format: int32 - links: - description: >- - Required. An array of links to check for their associated - LineageProcesses. The maximum number of items in this array is 100. - If the request contains more than 100 links, it returns the - `INVALID_ARGUMENT` error. Format: - `projects/{project}/locations/{location}/links/{link}`. - type: array - items: - type: string - description: Request message for BatchSearchLinkProcesses. - GoogleLongrunningOperation: - type: object - properties: - done: - type: boolean + enum: + - SOURCE_TYPE_UNSPECIFIED + - CUSTOM + - BIGQUERY + - DATA_FUSION + - COMPOSER + - LOOKER_STUDIO + - DATAPROC + - VERTEX_AI description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. + Type of the source. Use of a source_type other than `CUSTOM` for + process creation or updating is highly discouraged, and may be + restricted in the future without notice. + enumDescriptions: + - Source is Unspecified + - A custom source + - BigQuery + - Data Fusion + - Composer + - Looker Studio + - Dataproc + - Vertex AI name: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation - GoogleCloudDatacatalogLineageV1EntityReference: - properties: - fullyQualifiedName: - description: >- - Required. [Fully Qualified Name - (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) - of the entity. + If the source_type isn't CUSTOM, the value of this field should be a + GCP resource name of the system, which reports lineage. The project + and location parts of the resource name must match the project and + location of the lineage resource being created. Examples: - + `{source_type: COMPOSER, name: + "projects/foo/locations/us/environments/bar"}` - `{source_type: + BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: + CUSTOM, name: "myCustomIntegration"}` type: string - description: The soft reference to everything you can attach a lineage event to. - type: object - id: GoogleCloudDatacatalogLineageV1EntityReference - GoogleCloudDatacatalogLineageV1LineageEvent: + GoogleCloudDatacatalogLineageV1ProcessLinkInfo: type: object - description: >- - A lineage event represents an operation on assets. Within the operation, - the data flows from the source to the target defined in the links field. + description: Link details. properties: - endTime: - description: >- - Optional. The end of the transformation which resulted in this - lineage event. For streaming scenarios, it should be the end of the - period from which the lineage is being reported. + startTime: + description: The start of the first event establishing this link-process tuple. type: string format: google-datetime - startTime: + endTime: format: google-datetime + type: string + description: The end of the last event establishing this link-process tuple. + link: type: string description: >- - Required. The beginning of the transformation which resulted in this - lineage event. For streaming scenarios, it should be the beginning - of the period from which the lineage is being reported. - name: - description: >- - Immutable. The resource name of the lineage event. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. - Can be specified or auto-assigned. {lineage_event} must be not - longer than 200 characters and only contain characters in a set: - `a-zA-Z0-9_-:.` + The name of the link in the format of + `projects/{project}/locations/{location}/links/{link}`. + id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo + GoogleRpcStatus: + id: GoogleRpcStatus + properties: + message: type: string - links: description: >- - Optional. List of source-target pairs. Can't contain more than 100 - tuples. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: array - id: GoogleCloudDatacatalogLineageV1LineageEvent - GoogleCloudDatacatalogLineageV1Link: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + type: object description: >- - Links represent the data flow between **source** (upstream) and - **target** (downstream) assets in transformation pipelines. Links are - created when LineageEvents record data transformation between related - assets. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudDatacatalogLineageV1ProcessLinks: + description: Links associated with a specific process. + type: object properties: - target: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: The pointer to the entity that is the **target** of this link. - source: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: The pointer to the entity that is the **source** of this link. - startTime: - description: The start of the first event establishing this link. - type: string - format: google-datetime - name: - type: string - readOnly: true + links: + type: array description: >- - Output only. Immutable. The name of the link. Format: - `projects/{project}/locations/{location}/links/{link}`. - endTime: + An array containing link details objects of the links provided in + the original request. A single process can result in creating + multiple links. If any of the links you provide in the request are + created by the same process, they all are included in this array. + items: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo + process: type: string - format: google-datetime - description: The end of the last event establishing this link. - id: GoogleCloudDatacatalogLineageV1Link + description: >- + The process name in the format of + `projects/{project}/locations/{location}/processes/{process}`. + id: GoogleCloudDatacatalogLineageV1ProcessLinks + GoogleProtobufEmpty: + properties: {} + 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: GoogleProtobufEmpty type: object GoogleCloudDatacatalogLineageV1Process: description: A process is the definition of a data transformation operation. type: object properties: - origin: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Origin' - description: >- - Optional. The origin of this process and its runs and lineage - events. name: description: >- Immutable. The resource name of the lineage process. Format: @@ -424,194 +322,302 @@ components: labeling the process). Up to 100 attributes are allowed. type: object displayName: - type: string description: >- Optional. A human-readable name you can set to display in a user interface. Must be not longer than 200 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.` + type: string + origin: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Origin' + description: >- + Optional. The origin of this process and its runs and lineage + events. id: GoogleCloudDatacatalogLineageV1Process - GoogleLongrunningCancelOperationRequest: - type: object - id: GoogleLongrunningCancelOperationRequest - properties: {} - description: The request message for Operations.CancelOperation. - GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: + GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse properties: - run: + processLinks: + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' + type: array + description: An array of processes associated with the specified links. + nextPageToken: description: >- - Created run name. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. + The token to specify as `page_token` in the subsequent call to get + the next page. Omitted if there are no more pages in the response. type: string - process: + description: Response message for BatchSearchLinkProcesses. + type: object + GoogleLongrunningListOperationsResponse: + description: The response message for Operations.ListOperations. + properties: + nextPageToken: type: string + description: The standard List next-page token. + operations: description: >- - Created process name. Format: - `projects/{project}/locations/{location}/processes/{process}`. - lineageEvents: + A list of operations that matches the specified filter in the + request. items: - type: string + $ref: '#/components/schemas/GoogleLongrunningOperation' type: array - description: >- - Created lineage event names. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. - type: object - id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse - description: Response message for ProcessOpenLineageRunEvent. - GoogleCloudDatacatalogLineageV1ListRunsResponse: - description: Response message for ListRuns. + id: GoogleLongrunningListOperationsResponse type: object + GoogleCloudDatacatalogLineageV1ListProcessesResponse: + id: GoogleCloudDatacatalogLineageV1ListProcessesResponse properties: nextPageToken: - type: string description: >- The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages. - runs: - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' - description: The runs from the specified project and location. + type: string + processes: + description: The processes from the specified project and location. type: array - id: GoogleCloudDatacatalogLineageV1ListRunsResponse + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + description: Response message for ListProcesses. + type: object GoogleCloudDatacatalogLineageV1EventLink: + type: object properties: target: - description: Required. Reference to the target entity $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + description: Required. Reference to the target entity source: $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' description: Required. Reference to the source entity - type: object description: A lineage between source and target entities. id: GoogleCloudDatacatalogLineageV1EventLink - GoogleCloudDatacatalogLineageV1ListProcessesResponse: - description: Response message for ListProcesses. - type: object - id: GoogleCloudDatacatalogLineageV1ListProcessesResponse + GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest: properties: - processes: - type: array + pageSize: + type: integer + format: int32 + description: >- + The maximum number of processes to return in a single page of the + response. A page may contain fewer results than this value. + links: items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - description: The processes from the specified project and location. - nextPageToken: + type: string + type: array description: >- - The token to specify as `page_token` in the next call to get the - next page. If this field is omitted, there are no subsequent pages. + Required. An array of links to check for their associated + LineageProcesses. The maximum number of items in this array is 100. + If the request contains more than 100 links, it returns the + `INVALID_ARGUMENT` error. Format: + `projects/{project}/locations/{location}/links/{link}`. + pageToken: type: string - GoogleCloudDatacatalogLineageV1Run: - id: GoogleCloudDatacatalogLineageV1Run - properties: - attributes: - additionalProperties: - type: any description: >- - Optional. The attributes of the run. Should only be used for the - purpose of non-semantic management (classifying, describing or - labeling the run). Up to 100 attributes are allowed. - type: object + The page token received from a previous `BatchSearchLinkProcesses` + call. Use it to get the next page. When requesting subsequent pages + of a response, remember that all parameters must match the values + you provided in the original request. + type: object + description: Request message for BatchSearchLinkProcesses. + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + GoogleLongrunningCancelOperationRequest: + type: object + id: GoogleLongrunningCancelOperationRequest + description: The request message for Operations.CancelOperation. + properties: {} + GoogleCloudDatacatalogLineageV1Link: + type: object + id: GoogleCloudDatacatalogLineageV1Link + description: >- + Links represent the data flow between **source** (upstream) and + **target** (downstream) assets in transformation pipelines. Links are + created when LineageEvents record data transformation between related + assets. + properties: name: + readOnly: true type: string description: >- - Immutable. The resource name of the run. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. - Can be specified or auto-assigned. {run} must be not longer than 200 - characters and only contain characters in a set: `a-zA-Z0-9_-:.` - displayName: + Output only. Immutable. The name of the link. Format: + `projects/{project}/locations/{location}/links/{link}`. + startTime: + type: string + description: The start of the first event establishing this link. + format: google-datetime + source: + description: The pointer to the entity that is the **source** of this link. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + target: + description: The pointer to the entity that is the **target** of this link. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + endTime: + format: google-datetime + type: string + description: The end of the last event establishing this link. + GoogleCloudDatacatalogLineageV1LineageEvent: + id: GoogleCloudDatacatalogLineageV1LineageEvent + description: >- + A lineage event represents an operation on assets. Within the operation, + the data flows from the source to the target defined in the links field. + type: object + properties: + startTime: type: string description: >- - Optional. A human-readable name you can set to display in a user - interface. Must be not longer than 1024 characters and only contain - UTF-8 letters or numbers, spaces or characters like `_-:&.` + Required. The beginning of the transformation which resulted in this + lineage event. For streaming scenarios, it should be the beginning + of the period from which the lineage is being reported. + format: google-datetime + name: + description: >- + Immutable. The resource name of the lineage event. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. + Can be specified or auto-assigned. {lineage_event} must be not + longer than 200 characters and only contain characters in a set: + `a-zA-Z0-9_-:.` + type: string endTime: + format: google-datetime + type: string + description: >- + Optional. The end of the transformation which resulted in this + lineage event. For streaming scenarios, it should be the end of the + period from which the lineage is being reported. + links: + description: >- + Optional. List of source-target pairs. Can't contain more than 100 + tuples. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' + GoogleCloudDatacatalogLineageV1OperationMetadata: + properties: + operationType: + description: Output only. The type of the operation being performed. + enum: + - TYPE_UNSPECIFIED + - DELETE + - CREATE + readOnly: true + type: string + enumDescriptions: + - Unused. + - The resource deletion operation. + - The resource creation operation. + resource: + readOnly: true type: string + description: >- + Output only. The [relative name] + (https://cloud.google.com//apis/design/resource_names#relative_resource_name) + of the resource being operated on. + endTime: format: google-datetime - description: Optional. The timestamp of the end of the run. + description: >- + Output only. The timestamp of the operation termination, regardless + of its success. This field is unset if the operation is still + ongoing. + readOnly: true + type: string state: + description: Output only. The current operation state. + enumDescriptions: + - Unused. + - The operation has been created but is not yet started. + - The operation is underway. + - The operation completed successfully. + - The operation is no longer running and did not succeed. + readOnly: true enum: - - UNKNOWN - - STARTED - - COMPLETED + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED - FAILED - - ABORTED - description: Required. The state of the run. type: string - enumDescriptions: - - >- - The state is unknown. The true state may be any of the below or a - different state that is not supported here explicitly. - - The run is still executing. - - The run completed. - - The run failed. - - The run aborted. - startTime: + createTime: type: string - description: Required. The timestamp of the start of the run. + readOnly: true format: google-datetime - type: object - description: >- - A lineage run represents an execution of a process that creates lineage - events. - GoogleCloudDatacatalogLineageV1SearchLinksRequest: - type: object - description: Request message for SearchLinks. - id: GoogleCloudDatacatalogLineageV1SearchLinksRequest - properties: - target: description: >- - Optional. Send asset information in the **target** field to retrieve - all links that lead from upstream assets to the specified asset. - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - pageSize: - type: integer - description: >- - Optional. The maximum number of links to return in a single page of - the response. A page may contain fewer links than this value. If - unspecified, at most 10 links are returned. Maximum value is 100; - values greater than 100 are reduced to 100. - format: int32 - pageToken: - description: >- - Optional. The page token received from a previous - `SearchLinksRequest` call. Use it to get the next page. When - requesting subsequent pages of a response, remember that all - parameters must match the values you provided in the original - request. + Output only. The timestamp of the operation submission to the + server. + resourceUuid: type: string - source: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: >- - Optional. Send asset information in the **source** field to retrieve - all links that lead from the specified asset to downstream assets. - GoogleProtobufEmpty: - id: GoogleProtobufEmpty + readOnly: true + description: Output only. The UUID of the resource being operated on. type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - GoogleCloudDatacatalogLineageV1ProcessLinks: + description: Metadata describing the operation. + id: GoogleCloudDatacatalogLineageV1OperationMetadata + GoogleCloudDatacatalogLineageV1ListRunsResponse: properties: - links: + nextPageToken: + type: string description: >- - An array containing link details objects of the links provided in - the original request. A single process can result in creating - multiple links. If any of the links you provide in the request are - created by the same process, they all are included in this array. - items: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo + The token to specify as `page_token` in the next call to get the + next page. If this field is omitted, there are no subsequent pages. + runs: type: array - process: + description: The runs from the specified project and location. + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + type: object + description: Response message for ListRuns. + id: GoogleCloudDatacatalogLineageV1ListRunsResponse + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + properties: + name: type: string description: >- - The process name in the format of - `projects/{project}/locations/{location}/processes/{process}`. - id: GoogleCloudDatacatalogLineageV1ProcessLinks + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + metadata: + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + response: + type: object + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + done: + type: boolean + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + description: >- + This resource represents a long-running operation that is the result of + a network API call. type: object - description: Links associated with a specific process. parameters: + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean _.xgafv: description: V1 error format. in: query @@ -624,7 +630,22 @@ components: oauth_token: description: OAuth 2.0 token for the current user. in: query - name: oauth_token + name: oauth_token + schema: + 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. + in: query + name: key + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string alt: @@ -637,10 +658,13 @@ components: - json - media - proto - fields: - description: Selector specifying which fields to include in a partial response. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: fields + name: quotaUser schema: type: string uploadType: @@ -649,12 +673,6 @@ components: name: uploadType schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string access_token: description: OAuth access token. in: query @@ -667,40 +685,65 @@ components: name: callback schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - 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. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: key + name: fields schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean x-stackQL-resources: + operations: + id: google.datalineage.operations + name: operations + title: Operations + methods: + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' processes: id: google.datalineage.processes name: processes title: Processes methods: - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -711,10 +754,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -763,21 +806,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.lineageEvents + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.lineageEvents sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/lineage_events/methods/get' @@ -793,39 +836,39 @@ components: name: runs title: Runs methods: - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.runs + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runs - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -840,143 +883,59 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/runs/methods/delete' - operations: - id: google.datalineage.operations - name: operations - title: Operations - methods: - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' locations: id: google.datalineage.locations name: locations title: Locations methods: - batch_search_link_processes: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post - response: - mediaType: application/json - openAPIDocKey: '200' - process_open_lineage_run_event: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post - response: - mediaType: application/json - openAPIDocKey: '200' - search_links: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchLinks/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] -paths: - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: - parameters: &ref_1 - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - patch: - description: Updates a process. - operationId: datalineage.projects.locations.processes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: processesId - required: true - schema: - type: string - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + process_open_lineage_run_event: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post + response: + mediaType: application/json + openAPIDocKey: '200' + search_links: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchLinks/post + response: + mediaType: application/json + openAPIDocKey: '200' + batch_search_link_processes: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: &ref_1 + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' delete: - description: Deletes the process with the specified name. - operationId: datalineage.projects.locations.processes.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`. + operationId: datalineage.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -988,7 +947,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1001,17 +960,16 @@ paths: schema: type: string - in: path - name: processesId + name: operationsId required: true schema: type: string - - in: query - name: allowMissing - schema: - type: boolean get: - description: Gets the details of the specified process. - operationId: datalineage.projects.locations.processes.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. + operationId: datalineage.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1023,7 +981,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1036,20 +994,29 @@ paths: schema: type: string - in: path - name: processesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Creates a new process. - operationId: datalineage.projects.locations.processes.create + 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`. + operationId: datalineage.projects.locations.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1061,7 +1028,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1073,15 +1040,18 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: operationsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 get: description: >- - List processes in the given project and location. List order is - descending by insertion time. - operationId: datalineage.projects.locations.processes.list + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: datalineage.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1093,8 +1063,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListProcessesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -1115,11 +1084,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: parameters: *ref_1 - delete: - description: Deletes the lineage event with the specified name. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.delete + get: + description: Gets the details of the specified process. + operationId: datalineage.projects.locations.processes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1131,7 +1104,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1148,23 +1121,9 @@ paths: required: true schema: type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: lineageEventsId - required: true - schema: - type: string - - in: query - name: allowMissing - schema: - type: boolean - get: - description: Gets details of a specified lineage event. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.get + delete: + description: Deletes the process with the specified name. + operationId: datalineage.projects.locations.processes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1176,8 +1135,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1194,26 +1152,18 @@ paths: required: true schema: type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: lineageEventsId - required: true + - in: query + name: allowMissing schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents: - parameters: *ref_1 - post: - description: Creates a new lineage event. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.create + type: boolean + patch: + description: Updates a process. + operationId: datalineage.projects.locations.processes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1225,8 +1175,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1243,20 +1192,25 @@ paths: required: true schema: type: string - - in: path - name: runsId - required: true + - in: query + name: allowMissing schema: - type: string + type: boolean - in: query - name: requestId + name: updateMask schema: type: string - get: - description: >- - Lists lineage events in the given project and location. The list order - is not defined. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.list + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/processes: + parameters: *ref_1 + post: + description: Creates a new process. + operationId: datalineage.projects.locations.processes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1268,8 +1222,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListLineageEventsResponse + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1281,35 +1234,15 @@ paths: required: true schema: type: string - - in: path - name: processesId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}: - parameters: *ref_1 - patch: - description: Updates a run. - operationId: datalineage.projects.locations.processes.runs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + get: + description: >- + List processes in the given project and location. List order is + descending by insertion time. + operationId: datalineage.projects.locations.processes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1321,7 +1254,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ListProcessesResponse parameters: - in: path name: projectsId @@ -1333,28 +1267,20 @@ paths: required: true schema: type: string - - in: path - name: processesId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - in: query - name: allowMissing + name: pageSize schema: - type: boolean - get: - description: Gets the details of the specified run. - operationId: datalineage.projects.locations.processes.runs.get + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}: + parameters: *ref_1 + delete: + description: Deletes the lineage event with the specified name. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1366,7 +1292,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1388,9 +1314,18 @@ paths: required: true schema: type: string - delete: - description: Deletes the run with the specified name. - operationId: datalineage.projects.locations.processes.runs.delete + - in: path + name: lineageEventsId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + get: + description: Gets details of a specified lineage event. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1402,7 +1337,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent parameters: - in: path name: projectsId @@ -1424,17 +1360,18 @@ paths: required: true schema: type: string - - in: query - name: allowMissing + - in: path + name: lineageEventsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents: parameters: *ref_1 get: description: >- - Lists runs in the given project and location. List order is descending - by `start_time`. - operationId: datalineage.projects.locations.processes.runs.list + Lists lineage events in the given project and location. The list order + is not defined. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1447,7 +1384,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListRunsResponse + #/components/schemas/GoogleCloudDatacatalogLineageV1ListLineageEventsResponse parameters: - in: path name: projectsId @@ -1464,8 +1401,9 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: runsId + required: true schema: type: string - in: query @@ -1473,14 +1411,18 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Creates a new run. - operationId: datalineage.projects.locations.processes.runs.create + description: Creates a new lineage event. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1492,7 +1434,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent parameters: - in: path name: projectsId @@ -1509,19 +1452,25 @@ paths: required: true schema: type: string + - in: path + name: runsId + required: true + schema: + type: string - in: query name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs: parameters: *ref_1 - 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`. - operationId: datalineage.projects.locations.operations.delete + post: + description: Creates a new run. + operationId: datalineage.projects.locations.processes.runs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1533,7 +1482,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' parameters: - in: path name: projectsId @@ -1546,16 +1495,19 @@ paths: schema: type: string - in: path - name: operationsId + name: processesId required: true schema: type: string + - in: query + name: requestId + schema: + 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. - operationId: datalineage.projects.locations.operations.get + Lists runs in the given project and location. List order is descending + by `start_time`. + operationId: datalineage.projects.locations.processes.runs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1567,7 +1519,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ListRunsResponse parameters: - in: path name: projectsId @@ -1580,17 +1533,29 @@ paths: schema: type: string - in: path - name: operationsId + name: processesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: datalineage.projects.locations.operations.list + patch: + description: Updates a run. + operationId: datalineage.projects.locations.processes.runs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1602,7 +1567,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' parameters: - in: path name: projectsId @@ -1614,38 +1579,28 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: processesId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: runsId + required: true schema: type: string - in: query - name: filter + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - 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`. - operationId: datalineage.projects.locations.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + format: google-fieldmask + get: + description: Gets the details of the specified run. + operationId: datalineage.projects.locations.processes.runs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1657,7 +1612,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' parameters: - in: path name: projectsId @@ -1670,30 +1625,18 @@ paths: schema: type: string - in: path - name: operationsId + name: processesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: - parameters: *ref_1 - post: - description: >- - Retrieve information about LineageProcesses associated with specific - links. LineageProcesses are transformation pipelines that result in data - flowing from **source** to **target** assets. Links between assets - represent this operation. If you have specific link names, you can use - this method to verify which LineageProcesses contribute to creating - those links. See the SearchLinks method for more information on how to - retrieve link name. You can retrieve the LineageProcess information in - every project where you have the `datalineage.events.get` permission. - The project provided in the URL is used for Billing and Quota. - operationId: datalineage.projects.locations.batchSearchLinkProcesses - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + - in: path + name: runsId + required: true + schema: + type: string + delete: + description: Deletes the run with the specified name. + operationId: datalineage.projects.locations.processes.runs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1705,8 +1648,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1718,6 +1660,20 @@ paths: required: true schema: type: string + - in: path + name: processesId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: parameters: *ref_1 post: @@ -1796,3 +1752,47 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: + parameters: *ref_1 + post: + description: >- + Retrieve information about LineageProcesses associated with specific + links. LineageProcesses are transformation pipelines that result in data + flowing from **source** to **target** assets. Links between assets + represent this operation. If you have specific link names, you can use + this method to verify which LineageProcesses contribute to creating + those links. See the SearchLinks method for more information on how to + retrieve link name. You can retrieve the LineageProcess information in + every project where you have the `datalineage.events.get` permission. + The project provided in the URL is used for Billing and Quota. + operationId: datalineage.projects.locations.batchSearchLinkProcesses + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml b/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml index 515f8bf7..df0ba7c0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml @@ -36,272 +36,313 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + GoogleCloudDatapipelinesV1ListJobsResponse: + type: object + properties: + 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 + jobs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' + description: >- + Results that were accessible to the caller. Results are always in + descending order of job creation date. + id: GoogleCloudDatapipelinesV1ListJobsResponse + description: Response message for ListJobs GoogleCloudDatapipelinesV1LaunchTemplateParameters: properties: + update: + type: boolean + description: >- + If set, replace the existing pipeline with the name specified by + jobName with this pipeline, preserving state. + environment: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' + description: The runtime environment for the job. parameters: description: The runtime parameters to pass to the job. - type: object additionalProperties: type: string + type: object jobName: description: Required. The job name to use for the created job. type: string - update: - description: >- - If set, replace the existing pipeline with the name specified by - jobName with this pipeline, preserving state. - type: boolean transformNameMapping: - type: object description: >- Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Only applicable when updating a pipeline. additionalProperties: type: string - environment: - description: The runtime environment for the job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' - description: Parameters to provide to the template being launched. - id: GoogleCloudDatapipelinesV1LaunchTemplateParameters + type: object type: object - GoogleCloudDatapipelinesV1RunPipelineResponse: - id: GoogleCloudDatapipelinesV1RunPipelineResponse - properties: - job: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' - description: Job that was created as part of RunPipeline operation. + id: GoogleCloudDatapipelinesV1LaunchTemplateParameters + description: Parameters to provide to the template being launched. + GoogleRpcStatus: type: object - description: Response message for RunPipeline - GoogleCloudDatapipelinesV1Pipeline: + id: GoogleRpcStatus description: >- - The main pipeline entity and all the necessary metadata for launching - and managing linked jobs. - type: object + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - pipelineSources: + message: + type: string description: >- - Immutable. The sources of the pipeline (for example, Dataplex). The - keys and values are set by the corresponding sources during pipeline - creation. - additionalProperties: - type: string - type: object - workload: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' - description: Workload information for creating new jobs. - displayName: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: description: >- - Required. The display name of the pipeline. It can contain only - letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores - (_). - type: string - jobCount: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + code: format: int32 - description: Output only. Number of jobs. + description: The status code, which should be an enum value of google.rpc.Code. type: integer - readOnly: true - type: - enum: - - PIPELINE_TYPE_UNSPECIFIED - - PIPELINE_TYPE_BATCH - - PIPELINE_TYPE_STREAMING + GoogleProtobufEmpty: + type: object + properties: {} + 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: GoogleProtobufEmpty + GoogleCloudDatapipelinesV1RuntimeEnvironment: + properties: + workerZone: + description: >- + The Compute Engine zone + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1-a". Mutually + exclusive with worker_region. If neither worker_region nor + worker_zone is specified, a zone in the control plane's region is + chosen based on available capacity. If both `worker_zone` and `zone` + are set, `worker_zone` takes precedence. type: string + maxWorkers: description: >- - Required. The type of the pipeline. This field affects the - scheduling of the pipeline and the type of metrics to show for the - pipeline. - enumDescriptions: - - The pipeline type isn't specified. - - >- - A batch pipeline. It runs jobs on a specific schedule, and each - job will automatically terminate once execution is finished. - - >- - A streaming pipeline. The underlying job is continuously running - until it is manually terminated by the user. This type of pipeline - doesn't have a schedule to run on, and the linked job gets created - when the pipeline is created. - scheduleInfo: + The maximum number of Compute Engine instances to be made available + to your pipeline during execution, from 1 to 1000. + type: integer + format: int32 + enableStreamingEngine: + description: Whether to enable Streaming Engine for the job. + type: boolean + machineType: description: >- - Internal scheduling information for a pipeline. If this information - is provided, periodic jobs will be created per the schedule. If not, - users are responsible for creating jobs externally. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' - lastUpdateTime: - format: google-datetime - readOnly: true + The machine type to use for the job. Defaults to the value from the + template if not specified. + type: string + additionalExperiments: + description: Additional experiment flags for the job. + items: + type: string + type: array + zone: + type: string description: >- - Output only. Immutable. The timestamp when the pipeline was last - modified. Set by the Data Pipelines service. + The Compute Engine [availability + zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) + for launching worker instances to run your pipeline. In the future, + worker_zone will take precedence. + bypassTempDirValidation: + description: >- + Whether to bypass the safety checks for the job's temporary + directory. Use with caution. + type: boolean + kmsKeyName: type: string - state: + description: >- + Name for the Cloud KMS key for the job. The key format is: + projects//locations//keyRings//cryptoKeys/ + additionalUserLabels: + type: object + additionalProperties: + type: string + description: >- + Additional user labels to be specified for the job. Keys and values + should follow the restrictions specified in the [labeling + restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) + page. An object containing a list of key/value pairs. Example: { + "name": "wrench", "mass": "1kg", "count": "3" }. + ipConfiguration: enumDescriptions: - - The pipeline state isn't specified. - - >- - The pipeline is getting started or resumed. When finished, the - pipeline state will be 'PIPELINE_STATE_ACTIVE'. - - The pipeline is actively running. - - >- - The pipeline is in the process of stopping. When finished, the - pipeline state will be 'PIPELINE_STATE_ARCHIVED'. - - >- - The pipeline has been stopped. This is a terminal state and cannot - be undone. - - >- - The pipeline is paused. This is a non-terminal state. When the - pipeline is paused, it will hold processing jobs, but can be - resumed later. For a batch pipeline, this means pausing the - scheduler job. For a streaming pipeline, creating a job snapshot - to resume from will give the same effect. + - The configuration is unknown, or unspecified. + - Workers should have public IP addresses. + - Workers should have private IP addresses. + type: string + description: Configuration for VM IPs. enum: - - STATE_UNSPECIFIED - - STATE_RESUMING - - STATE_ACTIVE - - STATE_STOPPING - - STATE_ARCHIVED - - STATE_PAUSED + - WORKER_IP_UNSPECIFIED + - WORKER_IP_PUBLIC + - WORKER_IP_PRIVATE + tempLocation: + type: string description: >- - Required. The state of the pipeline. When the pipeline is created, - the state is set to 'PIPELINE_STATE_ACTIVE' by default. State - changes can be requested by setting the state to stopping, paused, - or resuming. State cannot be changed through UpdatePipeline - requests. + The Cloud Storage path to use for temporary files. Must be a valid + Cloud Storage URL, beginning with `gs://`. + numWorkers: + format: int32 + description: The initial number of Compute Engine instances for the job. + type: integer + serviceAccountEmail: type: string - schedulerServiceAccountEmail: + description: The email address of the service account to run the job as. + network: description: >- - Optional. A service account email to be used with the Cloud - Scheduler job. If not specified, the default compute engine service - account will be used. + Network to which VMs will be assigned. If empty or unspecified, the + service will use the network "default". type: string - createTime: + subnetwork: description: >- - Output only. Immutable. The timestamp when the pipeline was - initially created. Set by the Data Pipelines service. - readOnly: true + Subnetwork to which VMs will be assigned, if desired. You can + specify a subnetwork using either a complete URL or an abbreviated + path. Expected to be of the form + "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" + or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is + located in a Shared VPC network, you must use the complete URL. type: string - format: google-datetime - name: + workerRegion: description: >- - The pipeline name. For example: - `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * - `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), - hyphens (-), colons (:), and periods (.). For more information, see - [Identifying - projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). - * `LOCATION_ID` is the canonical ID for the pipeline's location. The - list of available locations can be obtained by calling - `google.cloud.location.Locations.ListLocations`. Note that the Data - Pipelines service is not available in all regions. It depends on - Cloud Scheduler, an App Engine application, so it's only available - in [App Engine - regions](https://cloud.google.com/about/locations#region). * - `PIPELINE_ID` is the ID of the pipeline. Must be unique for the - selected project and location. + The Compute Engine region + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1". Mutually + exclusive with worker_zone. If neither worker_region nor worker_zone + is specified, default to the control plane's region. type: string - id: GoogleCloudDatapipelinesV1Pipeline - GoogleCloudDatapipelinesV1DataflowJobDetails: - id: GoogleCloudDatapipelinesV1DataflowJobDetails + type: object + id: GoogleCloudDatapipelinesV1RuntimeEnvironment + description: The environment values to set at runtime. + GoogleCloudDatapipelinesV1RunPipelineResponse: + id: GoogleCloudDatapipelinesV1RunPipelineResponse + description: Response message for RunPipeline + type: object properties: - resourceInfo: - description: >- - Cached version of all the metrics of interest for the job. This - value gets stored here when the job is terminated. As long as the - job is running, this field is populated from the Dataflow API. - type: object - additionalProperties: - format: double - type: number - sdkVersion: - description: Output only. The SDK version used to run the job. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' - currentWorkers: - readOnly: true - format: int32 - description: >- - Output only. The current number of workers used to run the jobs. - Only set to a value if the job is still running. - type: integer + job: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' + description: Job that was created as part of RunPipeline operation. + GoogleCloudDatapipelinesV1RunPipelineRequest: + id: GoogleCloudDatapipelinesV1RunPipelineRequest + properties: {} + type: object + description: Request message for RunPipeline + GoogleCloudDatapipelinesV1Job: type: object + id: GoogleCloudDatapipelinesV1Job description: >- - Pipeline job details specific to the Dataflow API. This is encapsulated - here to allow for more executors to store their specific details - separately. - GoogleCloudDatapipelinesV1SdkVersion: + Definition of the job information maintained by the pipeline. Fields in + this entity are retrieved from the executor API (e.g. Dataflow API). properties: - versionDisplayName: - type: string - description: A readable string describing the version of the SDK. - sdkSupportStatus: + endTime: + readOnly: true + description: >- + Output only. The time of job termination. This is absent if the job + is still running. + format: google-datetime type: string - description: The support status for this SDK version. - enum: - - UNKNOWN - - SUPPORTED - - STALE - - DEPRECATED - - UNSUPPORTED + status: + description: >- + Status capturing any error code or message related to job creation + or execution. + $ref: '#/components/schemas/GoogleRpcStatus' + state: enumDescriptions: - - Dataflow is unaware of this version. - - This is a known version of an SDK, and is supported. - - A newer version of the SDK exists, and an update is recommended. - - >- - This version of the SDK is deprecated and will eventually be - unsupported. - - >- - Support for this SDK version has ended and it should no longer be - used. - version: - description: The version of the SDK used to run the job. + - The job state isn't specified. + - The job is waiting to start execution. + - The job is executing. + - The job has finished execution successfully. + - The job has finished execution with a failure. + - The job has been terminated upon user request. + description: The current state of the job. + enum: + - STATE_UNSPECIFIED + - STATE_PENDING + - STATE_RUNNING + - STATE_DONE + - STATE_FAILED + - STATE_CANCELLED type: string - description: The version of the SDK used to run the job. + dataflowJobDetails: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' + description: All the details that are specific to a Dataflow job. + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. The time of job creation. + name: + type: string + description: Required. The fully qualified resource name for the job. + id: + readOnly: true + description: Output only. The internal ID for the job. + type: string + GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: type: object - id: GoogleCloudDatapipelinesV1SdkVersion + description: A request to launch a Dataflow job from a Flex Template. + properties: + validateOnly: + description: >- + If true, the request is validated but not actually executed. + Defaults to false. + type: boolean + launchParameter: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + description: Required. Parameter to launch a job from a Flex Template. + projectId: + description: >- + Required. The ID of the Cloud Platform project that the job belongs + to. + type: string + location: + description: >- + Required. The [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) + to which to direct the request. For example, `us-central1`, + `us-west1`. + type: string + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest GoogleCloudDatapipelinesV1ScheduleSpec: id: GoogleCloudDatapipelinesV1ScheduleSpec description: Details of the schedule the pipeline runs on. - type: object properties: - nextJobTime: - readOnly: true - description: Output only. When the next Scheduler job is going to run. + timeZone: + description: >- + Timezone ID. This matches the timezone IDs used by the Cloud + Scheduler API. If empty, UTC time is assumed. type: string - format: google-datetime schedule: description: >- Unix-cron format of the schedule. This information is retrieved from the linked Cloud Scheduler. type: string - timeZone: + nextJobTime: + readOnly: true type: string - description: >- - Timezone ID. This matches the timezone IDs used by the Cloud - Scheduler API. If empty, UTC time is assumed. + description: Output only. When the next Scheduler job is going to run. + format: google-datetime + type: object GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: + description: The environment values to be set at runtime for a Flex Template. id: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment properties: - machineType: - description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. - type: string - numWorkers: - format: int32 - type: integer - description: The initial number of Compute Engine instances for the job. - flexrsGoal: - type: string - enum: - - FLEXRS_UNSPECIFIED - - FLEXRS_SPEED_OPTIMIZED - - FLEXRS_COST_OPTIMIZED - enumDescriptions: - - Run in the default mode. - - Optimize for lower execution time. - - Optimize for lower cost. - description: >- - Set FlexRS goal for the job. - https://cloud.google.com/dataflow/docs/guides/flexrs enableStreamingEngine: type: boolean description: Whether to enable Streaming Engine for the job. @@ -314,60 +355,27 @@ components: or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. type: string - maxWorkers: - description: >- - The maximum number of Compute Engine instances to be made available - to your pipeline during execution, from 1 to 1000. - type: integer - format: int32 - workerRegion: - description: >- - The Compute Engine region - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1". Mutually - exclusive with worker_zone. If neither worker_region nor worker_zone - is specified, defaults to the control plane region. - type: string - ipConfiguration: - enumDescriptions: - - The configuration is unknown, or unspecified. - - Workers should have public IP addresses. - - Workers should have private IP addresses. - description: Configuration for VM IPs. - enum: - - WORKER_IP_UNSPECIFIED - - WORKER_IP_PUBLIC - - WORKER_IP_PRIVATE - type: string - kmsKeyName: - type: string - description: >- - Name for the Cloud KMS key for the job. Key format is: - projects//locations//keyRings//cryptoKeys/ - workerZone: - description: >- - The Compute Engine zone - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1-a". Mutually - exclusive with worker_region. If neither worker_region nor - worker_zone is specified, a zone in the control plane region is - chosen based on available capacity. If both `worker_zone` and `zone` - are set, `worker_zone` takes precedence. + serviceAccountEmail: + description: The email address of the service account to run the job as. type: string - additionalExperiments: - description: Additional experiment flags for the job. - type: array - items: - type: string + numWorkers: + format: int32 + type: integer + description: The initial number of Compute Engine instances for the job. tempLocation: type: string description: >- The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. - serviceAccountEmail: - description: The email address of the service account to run the job as. + zone: type: string + description: >- + The Compute Engine [availability + zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) + for launching worker instances to run your pipeline. In the future, + worker_zone will take precedence. additionalUserLabels: + type: object additionalProperties: type: string description: >- @@ -376,272 +384,353 @@ components: restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). An object containing a list of key/value pairs. Example: `{ "name": "wrench", "mass": "1kg", "count": "3" }`. - type: object - zone: - type: string - description: >- - The Compute Engine [availability - zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - for launching worker instances to run your pipeline. In the future, - worker_zone will take precedence. network: - type: string description: >- Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". - description: The environment values to be set at runtime for a Flex Template. - type: object - GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: - description: Launch Flex Template parameter. - type: object - properties: - jobName: type: string + maxWorkers: + type: integer description: >- - Required. The job name to use for the created job. For an update job - request, the job name should be the same as the existing running - job. - containerSpecGcsPath: + The maximum number of Compute Engine instances to be made available + to your pipeline during execution, from 1 to 1000. + format: int32 + kmsKeyName: + description: >- + Name for the Cloud KMS key for the job. Key format is: + projects//locations//keyRings//cryptoKeys/ type: string + flexrsGoal: description: >- - Cloud Storage path to a file with a JSON-serialized ContainerSpec as - content. - parameters: - description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' - additionalProperties: - type: string - type: object - environment: - description: The runtime environment for the Flex Template job. - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment - update: + Set FlexRS goal for the job. + https://cloud.google.com/dataflow/docs/guides/flexrs + type: string + enum: + - FLEXRS_UNSPECIFIED + - FLEXRS_SPEED_OPTIMIZED + - FLEXRS_COST_OPTIMIZED + enumDescriptions: + - Run in the default mode. + - Optimize for lower execution time. + - Optimize for lower cost. + machineType: description: >- - Set this to true if you are sending a request to update a running - streaming job. When set, the job name should be the same as the - running job. - type: boolean - launchOptions: - type: object + The machine type to use for the job. Defaults to the value from the + template if not specified. + type: string + workerZone: + type: string description: >- - Launch options for this Flex Template job. This is a common set of - options across languages and templates. This should not be used to - pass job parameters. - additionalProperties: - type: string - transformNameMappings: + The Compute Engine zone + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1-a". Mutually + exclusive with worker_region. If neither worker_region nor + worker_zone is specified, a zone in the control plane region is + chosen based on available capacity. If both `worker_zone` and `zone` + are set, `worker_zone` takes precedence. + workerRegion: + type: string description: >- - Use this to pass transform name mappings for streaming update jobs. - Example: `{"oldTransformName":"newTransformName",...}` - type: object - additionalProperties: + The Compute Engine region + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1". Mutually + exclusive with worker_zone. If neither worker_region nor worker_zone + is specified, defaults to the control plane region. + additionalExperiments: + items: type: string - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + description: Additional experiment flags for the job. + type: array + ipConfiguration: + type: string + enumDescriptions: + - The configuration is unknown, or unspecified. + - Workers should have public IP addresses. + - Workers should have private IP addresses. + description: Configuration for VM IPs. + enum: + - WORKER_IP_UNSPECIFIED + - WORKER_IP_PUBLIC + - WORKER_IP_PRIVATE + type: object GoogleCloudDatapipelinesV1ListPipelinesResponse: + type: object + id: GoogleCloudDatapipelinesV1ListPipelinesResponse properties: - nextPageToken: - type: string - 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. pipelines: - items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' description: >- Results that matched the filter criteria and were accessible to the caller. Results are always in descending order of pipeline creation date. + items: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' type: array - type: object - id: GoogleCloudDatapipelinesV1ListPipelinesResponse + nextPageToken: + type: string + 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. description: Response message for ListPipelines. - GoogleCloudDatapipelinesV1LaunchTemplateRequest: - description: A request to launch a template. - id: GoogleCloudDatapipelinesV1LaunchTemplateRequest + GoogleCloudDatapipelinesV1Pipeline: + type: object + id: GoogleCloudDatapipelinesV1Pipeline properties: - validateOnly: - type: boolean - description: >- - If true, the request is validated but not actually executed. - Defaults to false. - gcsPath: + displayName: description: >- - A Cloud Storage path to the template from which to create the job. - Must be a valid Cloud Storage URL, beginning with 'gs://'. + Required. The display name of the pipeline. It can contain only + letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores + (_). type: string - launchParameters: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters - description: >- - The parameters of the template to launch. This should be part of the - body of the POST request. - projectId: + name: type: string description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - location: + The pipeline name. For example: + `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * + `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + hyphens (-), colons (:), and periods (.). For more information, see + [Identifying + projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). + * `LOCATION_ID` is the canonical ID for the pipeline's location. The + list of available locations can be obtained by calling + `google.cloud.location.Locations.ListLocations`. Note that the Data + Pipelines service is not available in all regions. It depends on + Cloud Scheduler, an App Engine application, so it's only available + in [App Engine + regions](https://cloud.google.com/about/locations#region). * + `PIPELINE_ID` is the ID of the pipeline. Must be unique for the + selected project and location. + jobCount: + type: integer + format: int32 + description: Output only. Number of jobs. + readOnly: true + type: + enum: + - PIPELINE_TYPE_UNSPECIFIED + - PIPELINE_TYPE_BATCH + - PIPELINE_TYPE_STREAMING + enumDescriptions: + - The pipeline type isn't specified. + - >- + A batch pipeline. It runs jobs on a specific schedule, and each + job will automatically terminate once execution is finished. + - >- + A streaming pipeline. The underlying job is continuously running + until it is manually terminated by the user. This type of pipeline + doesn't have a schedule to run on, and the linked job gets created + when the pipeline is created. description: >- - The [regional endpoint] - (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. + Required. The type of the pipeline. This field affects the + scheduling of the pipeline and the type of metrics to show for the + pipeline. type: string - type: object - GoogleProtobufEmpty: - properties: {} - type: object - id: GoogleProtobufEmpty - 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); } - GoogleCloudDatapipelinesV1RuntimeEnvironment: - id: GoogleCloudDatapipelinesV1RuntimeEnvironment - type: object - description: The environment values to set at runtime. - properties: - network: + pipelineSources: + type: object + additionalProperties: + type: string description: >- - Network to which VMs will be assigned. If empty or unspecified, the - service will use the network "default". - type: string - serviceAccountEmail: - type: string - description: The email address of the service account to run the job as. - workerRegion: + Immutable. The sources of the pipeline (for example, Dataplex). The + keys and values are set by the corresponding sources during pipeline + creation. + scheduleInfo: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' description: >- - The Compute Engine region - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1". Mutually - exclusive with worker_zone. If neither worker_region nor worker_zone - is specified, default to the control plane's region. + Internal scheduling information for a pipeline. If this information + is provided, periodic jobs will be created per the schedule. If not, + users are responsible for creating jobs externally. + workload: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' + description: Workload information for creating new jobs. + state: type: string - enableStreamingEngine: - type: boolean - description: Whether to enable Streaming Engine for the job. - workerZone: description: >- - The Compute Engine zone - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1-a". Mutually - exclusive with worker_region. If neither worker_region nor - worker_zone is specified, a zone in the control plane's region is - chosen based on available capacity. If both `worker_zone` and `zone` - are set, `worker_zone` takes precedence. - type: string - tempLocation: + Required. The state of the pipeline. When the pipeline is created, + the state is set to 'PIPELINE_STATE_ACTIVE' by default. State + changes can be requested by setting the state to stopping, paused, + or resuming. State cannot be changed through UpdatePipeline + requests. + enum: + - STATE_UNSPECIFIED + - STATE_RESUMING + - STATE_ACTIVE + - STATE_STOPPING + - STATE_ARCHIVED + - STATE_PAUSED + enumDescriptions: + - The pipeline state isn't specified. + - >- + The pipeline is getting started or resumed. When finished, the + pipeline state will be 'PIPELINE_STATE_ACTIVE'. + - The pipeline is actively running. + - >- + The pipeline is in the process of stopping. When finished, the + pipeline state will be 'PIPELINE_STATE_ARCHIVED'. + - >- + The pipeline has been stopped. This is a terminal state and cannot + be undone. + - >- + The pipeline is paused. This is a non-terminal state. When the + pipeline is paused, it will hold processing jobs, but can be + resumed later. For a batch pipeline, this means pausing the + scheduler job. For a streaming pipeline, creating a job snapshot + to resume from will give the same effect. + lastUpdateTime: description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. + Output only. Immutable. The timestamp when the pipeline was last + modified. Set by the Data Pipelines service. + readOnly: true + format: google-datetime + type: string + createTime: type: string - bypassTempDirValidation: - type: boolean description: >- - Whether to bypass the safety checks for the job's temporary - directory. Use with caution. - machineType: + Output only. Immutable. The timestamp when the pipeline was + initially created. Set by the Data Pipelines service. + readOnly: true + format: google-datetime + schedulerServiceAccountEmail: + description: >- + Optional. A service account email to be used with the Cloud + Scheduler job. If not specified, the default compute engine service + account will be used. type: string + description: >- + The main pipeline entity and all the necessary metadata for launching + and managing linked jobs. + GoogleCloudDatapipelinesV1DataflowJobDetails: + properties: + resourceInfo: + type: object description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. - additionalExperiments: - description: Additional experiment flags for the job. - type: array - items: - type: string - numWorkers: - description: The initial number of Compute Engine instances for the job. - type: integer + Cached version of all the metrics of interest for the job. This + value gets stored here when the job is terminated. As long as the + job is running, this field is populated from the Dataflow API. + additionalProperties: + type: number + format: double + currentWorkers: format: int32 - zone: - type: string + readOnly: true + type: integer description: >- - The Compute Engine [availability - zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - for launching worker instances to run your pipeline. In the future, - worker_zone will take precedence. - additionalUserLabels: + Output only. The current number of workers used to run the jobs. + Only set to a value if the job is still running. + sdkVersion: + readOnly: true + description: Output only. The SDK version used to run the job. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' + id: GoogleCloudDatapipelinesV1DataflowJobDetails + description: >- + Pipeline job details specific to the Dataflow API. This is encapsulated + here to allow for more executors to store their specific details + separately. + type: object + GoogleCloudDatapipelinesV1SdkVersion: + id: GoogleCloudDatapipelinesV1SdkVersion + type: object + properties: + sdkSupportStatus: + type: string + description: The support status for this SDK version. + enumDescriptions: + - Dataflow is unaware of this version. + - This is a known version of an SDK, and is supported. + - A newer version of the SDK exists, and an update is recommended. + - >- + This version of the SDK is deprecated and will eventually be + unsupported. + - >- + Support for this SDK version has ended and it should no longer be + used. + enum: + - UNKNOWN + - SUPPORTED + - STALE + - DEPRECATED + - UNSUPPORTED + version: + type: string + description: The version of the SDK used to run the job. + versionDisplayName: + description: A readable string describing the version of the SDK. + type: string + description: The version of the SDK used to run the job. + GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: + properties: + update: + type: boolean description: >- - Additional user labels to be specified for the job. Keys and values - should follow the restrictions specified in the [labeling - restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) - page. An object containing a list of key/value pairs. Example: { - "name": "wrench", "mass": "1kg", "count": "3" }. + Set this to true if you are sending a request to update a running + streaming job. When set, the job name should be the same as the + running job. + transformNameMappings: + additionalProperties: + type: string type: object + description: >- + Use this to pass transform name mappings for streaming update jobs. + Example: `{"oldTransformName":"newTransformName",...}` + parameters: + description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' additionalProperties: type: string - subnetwork: + type: object + environment: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + description: The runtime environment for the Flex Template job. + containerSpecGcsPath: description: >- - Subnetwork to which VMs will be assigned, if desired. You can - specify a subnetwork using either a complete URL or an abbreviated - path. Expected to be of the form - "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" - or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is - located in a Shared VPC network, you must use the complete URL. - type: string - ipConfiguration: - enumDescriptions: - - The configuration is unknown, or unspecified. - - Workers should have public IP addresses. - - Workers should have private IP addresses. - description: Configuration for VM IPs. - enum: - - WORKER_IP_UNSPECIFIED - - WORKER_IP_PUBLIC - - WORKER_IP_PRIVATE + Cloud Storage path to a file with a JSON-serialized ContainerSpec as + content. type: string - kmsKeyName: + launchOptions: description: >- - Name for the Cloud KMS key for the job. The key format is: - projects//locations//keyRings//cryptoKeys/ + Launch options for this Flex Template job. This is a common set of + options across languages and templates. This should not be used to + pass job parameters. + type: object + additionalProperties: + type: string + jobName: type: string - maxWorkers: - type: integer - format: int32 description: >- - The maximum number of Compute Engine instances to be made available - to your pipeline during execution, from 1 to 1000. + Required. The job name to use for the created job. For an update job + request, the job name should be the same as the existing running + job. + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + type: object + description: Launch Flex Template parameter. GoogleCloudDatapipelinesV1Workload: type: object + id: GoogleCloudDatapipelinesV1Workload description: Workload details for creating the pipeline jobs. properties: + dataflowLaunchTemplateRequest: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' + description: >- + Template information and additional parameters needed to launch a + Dataflow job using the standard launch API. dataflowFlexTemplateRequest: $ref: >- #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest description: >- Template information and additional parameters needed to launch a Dataflow job using the flex launch API. - dataflowLaunchTemplateRequest: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' - description: >- - Template information and additional parameters needed to launch a - Dataflow job using the standard launch API. - id: GoogleCloudDatapipelinesV1Workload - GoogleCloudDatapipelinesV1ListJobsResponse: + GoogleCloudDatapipelinesV1LaunchTemplateRequest: type: object - id: GoogleCloudDatapipelinesV1ListJobsResponse - description: Response message for ListJobs + description: A request to launch a template. properties: - jobs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' - description: >- - Results that were accessible to the caller. Results are always in - descending order of job creation date. - nextPageToken: + gcsPath: 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. + A Cloud Storage path to the template from which to create the job. + Must be a valid Cloud Storage URL, beginning with 'gs://'. type: string - GoogleCloudDatapipelinesV1StopPipelineRequest: - description: Request message for StopPipeline. - properties: {} - id: GoogleCloudDatapipelinesV1StopPipelineRequest - type: object - GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: - properties: + validateOnly: + type: boolean + description: >- + If true, the request is validated but not actually executed. + Defaults to false. projectId: type: string description: >- @@ -650,115 +739,42 @@ components: location: type: string description: >- - Required. The [regional endpoint] + The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. For example, `us-central1`, - `us-west1`. - launchParameter: - description: Required. Parameter to launch a job from a Flex Template. + to which to direct the request. + launchParameters: $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - validateOnly: - type: boolean - description: >- - If true, the request is validated but not actually executed. - Defaults to false. - type: object - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest - description: A request to launch a Dataflow job from a Flex Template. - GoogleCloudDatapipelinesV1Job: - description: >- - Definition of the job information maintained by the pipeline. Fields in - this entity are retrieved from the executor API (e.g. Dataflow API). - properties: - dataflowJobDetails: - description: All the details that are specific to a Dataflow job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' - endTime: - format: google-datetime - description: >- - Output only. The time of job termination. This is absent if the job - is still running. - type: string - readOnly: true - name: - type: string - description: Required. The fully qualified resource name for the job. - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The time of job creation. - id: - description: Output only. The internal ID for the job. - type: string - readOnly: true - state: - enum: - - STATE_UNSPECIFIED - - STATE_PENDING - - STATE_RUNNING - - STATE_DONE - - STATE_FAILED - - STATE_CANCELLED - type: string - description: The current state of the job. - enumDescriptions: - - The job state isn't specified. - - The job is waiting to start execution. - - The job is executing. - - The job has finished execution successfully. - - The job has finished execution with a failure. - - The job has been terminated upon user request. - status: + #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters description: >- - Status capturing any error code or message related to job creation - or execution. - $ref: '#/components/schemas/GoogleRpcStatus' - type: object - id: GoogleCloudDatapipelinesV1Job - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + The parameters of the template to launch. This should be part of the + body of the POST request. + id: GoogleCloudDatapipelinesV1LaunchTemplateRequest + GoogleCloudDatapipelinesV1StopPipelineRequest: type: object - id: GoogleRpcStatus - properties: - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - GoogleCloudDatapipelinesV1RunPipelineRequest: + id: GoogleCloudDatapipelinesV1StopPipelineRequest properties: {} - description: Request message for RunPipeline - id: GoogleCloudDatapipelinesV1RunPipelineRequest - type: object + description: Request message for StopPipeline. parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: uploadType + name: prettyPrint + schema: + type: boolean + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string upload_protocol: @@ -773,31 +789,21 @@ components: name: callback schema: type: string - alt: - description: Data format for response. + 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. in: query - name: alt + name: key schema: type: string - enum: - - json - - media - - proto - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - _.xgafv: - description: V1 error format. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: $.xgafv + name: uploadType schema: type: string - enum: - - '1' - - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -807,19 +813,19 @@ components: name: quotaUser schema: 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. + _.xgafv: + description: V1 error format. in: query - name: key + name: $.xgafv schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: fields + name: oauth_token schema: type: string access_token: @@ -828,65 +834,79 @@ components: name: access_token schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string x-stackQL-resources: + jobs: + id: google.datapipelines.jobs + name: jobs + title: Jobs + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}~1jobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + insert: [] + update: [] + replace: [] + delete: [] pipelines: id: google.datapipelines.pipelines name: pipelines title: Pipelines methods: - get: + run: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:run/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.pipelines + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/post response: mediaType: application/json openAPIDocKey: '200' - stop: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.pipelines - run: + stop: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:run/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post response: mediaType: application/json openAPIDocKey: '200' @@ -901,46 +921,25 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete' - jobs: - id: google.datapipelines.jobs - name: jobs - title: Jobs - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}~1jobs/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - insert: [] - update: [] - replace: [] - delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' get: description: >- - Looks up a single pipeline. Returns a "NOT_FOUND" error if no such - pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have - permission to access it. - operationId: datapipelines.projects.locations.pipelines.get + Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the + caller doesn't have permission to access it. + operationId: datapipelines.projects.locations.pipelines.jobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -952,7 +951,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1ListJobsResponse parameters: - in: path name: projectsId @@ -969,11 +969,32 @@ paths: required: true schema: type: string - delete: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run: + parameters: *ref_1 + post: description: >- - Deletes a pipeline. If a scheduler job is attached to the pipeline, it - will be deleted. - operationId: datapipelines.projects.locations.pipelines.delete + Creates a job for the specified pipeline directly. You can use this + method when the internal scheduler is not configured and you want to + trigger the job directly or through an external system. Returns a + "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" + error if the user doesn't have permission to access the pipeline or run + jobs for the pipeline. + operationId: datapipelines.projects.locations.pipelines.run + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -985,7 +1006,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineResponse parameters: - in: path name: projectsId @@ -1002,18 +1024,13 @@ paths: required: true schema: type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines: + parameters: *ref_1 + get: description: >- - Updates a pipeline. If successful, the updated Pipeline is returned. - Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline - does not return successfully, you can retry the UpdatePipeline request - until you receive a successful response. - operationId: datapipelines.projects.locations.pipelines.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have + permission to access it. + operationId: datapipelines.projects.locations.pipelines.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1025,7 +1042,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1ListPipelinesResponse parameters: - in: path name: projectsId @@ -1037,30 +1055,31 @@ paths: required: true schema: type: string - - in: path - name: pipelinesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: - parameters: *ref_1 post: description: >- - Freezes pipeline execution permanently. If there's a corresponding - scheduler entry, it's deleted, and the pipeline state is changed to - "ARCHIVED". However, pipeline metadata is retained. - operationId: datapipelines.projects.locations.pipelines.stop + Creates a pipeline. For a batch pipeline, you can pass scheduler + information. Data Pipelines uses the scheduler information to create an + internal scheduler that runs jobs periodically. If the internal + scheduler is not configured, you can use RunPipeline to run jobs. + operationId: datapipelines.projects.locations.pipelines.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1StopPipelineRequest + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1084,25 +1103,13 @@ paths: required: true schema: type: string - - in: path - name: pipelinesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}: parameters: *ref_1 - post: + delete: description: >- - Creates a pipeline. For a batch pipeline, you can pass scheduler - information. Data Pipelines uses the scheduler information to create an - internal scheduler that runs jobs periodically. If the internal - scheduler is not configured, you can use RunPipeline to run jobs. - operationId: datapipelines.projects.locations.pipelines.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + Deletes a pipeline. If a scheduler job is attached to the pipeline, it + will be deleted. + operationId: datapipelines.projects.locations.pipelines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1114,7 +1121,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1126,11 +1133,23 @@ paths: required: true schema: type: string - get: + - in: path + name: pipelinesId + required: true + schema: + type: string + patch: description: >- - Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have - permission to access it. - operationId: datapipelines.projects.locations.pipelines.list + Updates a pipeline. If successful, the updated Pipeline is returned. + Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline + does not return successfully, you can retry the UpdatePipeline request + until you receive a successful response. + operationId: datapipelines.projects.locations.pipelines.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1142,8 +1161,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1ListPipelinesResponse + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1155,36 +1173,22 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: pipelinesId + required: true schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run: - parameters: *ref_1 - post: + format: google-fieldmask + get: description: >- - Creates a job for the specified pipeline directly. You can use this - method when the internal scheduler is not configured and you want to - trigger the job directly or through an external system. Returns a - "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" - error if the user doesn't have permission to access the pipeline or run - jobs for the pipeline. - operationId: datapipelines.projects.locations.pipelines.run - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineRequest + Looks up a single pipeline. Returns a "NOT_FOUND" error if no such + pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have + permission to access it. + operationId: datapipelines.projects.locations.pipelines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1196,8 +1200,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineResponse + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1214,13 +1217,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: parameters: *ref_1 - get: + post: description: >- - Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the - caller doesn't have permission to access it. - operationId: datapipelines.projects.locations.pipelines.jobs.list + Freezes pipeline execution permanently. If there's a corresponding + scheduler entry, it's deleted, and the pipeline state is changed to + "ARCHIVED". However, pipeline metadata is retained. + operationId: datapipelines.projects.locations.pipelines.stop + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1StopPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1232,8 +1242,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1ListJobsResponse + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1250,12 +1259,3 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml index aa13af61..254400dd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml @@ -37,941 +37,917 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GooglePrivacyDlpV2InspectJobConfig: - description: Controls what and how to inspect for findings. - properties: - actions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' - description: Actions to execute at the completion of the job. - type: array - storageConfig: - description: The data to scan. - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: How and what to scan for. - inspectTemplateName: - type: string - description: >- - If provided, will be used as the default for all values in - InspectConfig. `inspect_config` will be merged into the values - persisted as part of the template. + GooglePrivacyDlpV2LeaveUntransformed: + properties: {} + description: >- + Skips the data without modifying it if the requested transformation + would cause an error. For example, if a `DateShift` transformation were + applied an an IP address, this mode would leave the IP address unchanged + in the response. type: object - id: GooglePrivacyDlpV2InspectJobConfig - GooglePrivacyDlpV2KAnonymityEquivalenceClass: - id: GooglePrivacyDlpV2KAnonymityEquivalenceClass - properties: - quasiIdsValues: - description: >- - Set of values defining the equivalence class. One value per - quasi-identifier column in the original KAnonymity metric message. - The order is always the same as the original request. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - equivalenceClassSize: - type: string - format: int64 - description: >- - Size of the equivalence class, for example number of rows with the - above set of values. - description: The set of columns' values that share the same ldiversity value + id: GooglePrivacyDlpV2LeaveUntransformed + GooglePrivacyDlpV2DataProfilePubSubCondition: + description: A condition for determining whether a Pub/Sub should be triggered. type: object - GooglePrivacyDlpV2LDiversityHistogramBucket: + id: GooglePrivacyDlpV2DataProfilePubSubCondition + properties: + expressions: + description: An expression. + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' + GooglePrivacyDlpV2SaveFindings: + properties: + outputConfig: + description: Location to store findings outside of DLP. + $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' + id: GooglePrivacyDlpV2SaveFindings + description: >- + If set, the detailed findings will be persisted to the specified + OutputStorageConfig. Only a single instance of this action can be + specified. Compatible with: Inspect, Risk type: object - id: GooglePrivacyDlpV2LDiversityHistogramBucket - description: Histogram of l-diversity equivalence class sensitive value frequencies. + GooglePrivacyDlpV2Finding: + description: Represents a piece of potentially sensitive content. properties: - sensitiveValueFrequencyUpperBound: + quote: + type: string description: >- - Upper bound on the sensitive value frequencies of the equivalence - classes in this bucket. - format: int64 + The content that was found. Even if the content is not textual, it + may be converted to a textual representation here. Provided if + `include_quote` is true and the finding is less than or equal to + 4096 bytes long. If the finding exceeds 4096 bytes in length, the + quote may be omitted. + name: type: string - sensitiveValueFrequencyLowerBound: + description: >- + Resource name in format + projects/{project}/locations/{location}/findings/{finding} Populated + only when viewing persisted findings. + findingId: type: string + description: The unique finding id. + infoType: description: >- - Lower bound on the sensitive value frequencies of the equivalence - classes in this bucket. - format: int64 - bucketValues: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' + The type of content that might have been found. Provided if + `excluded_types` is false. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + quoteInfo: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. - bucketValueCount: + Contains data parsed from quotes. Only populated if include_quote + was set to true and a supported infoType was requested. Currently + supported infoTypes: DATE, DATE_OF_BIRTH and TIME. + labels: + description: >- + The labels associated with this `Finding`. Label keys must be + between 1 and 63 characters long and must conform to the following + regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must + be between 0 and 63 characters long and must conform to the regular + expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels + can be associated with a given finding. Examples: * `"environment" : + "production"` * `"pipeline" : "etl"` + type: object + additionalProperties: + type: string + jobCreateTime: + description: Time the job started that produced this finding. type: string - description: Total number of distinct equivalence classes in this bucket. - format: int64 - bucketSize: - description: Total number of equivalence classes in this bucket. - format: int64 + format: google-datetime + likelihood: + description: Confidence of how likely it is that the `info_type` is correct. type: string - GooglePrivacyDlpV2Condition: - type: object - id: GooglePrivacyDlpV2Condition - properties: - value: - description: Value to compare against. [Mandatory, except for `EXISTS` tests.] - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - operator: enum: - - RELATIONAL_OPERATOR_UNSPECIFIED - - EQUAL_TO - - NOT_EQUAL_TO - - GREATER_THAN - - LESS_THAN - - GREATER_THAN_OR_EQUALS - - LESS_THAN_OR_EQUALS - - EXISTS - description: >- - Required. Operator used to compare the field or infoType to the - value. - type: string + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY enumDescriptions: - - Unused - - Equal. Attempts to match even with incompatible types. - - Not equal to. Attempts to match even with incompatible types. - - Greater than. - - Less than. - - Greater than or equals. - - Less than or equals. - - Exists - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Required. Field within the record this condition is evaluated - against. - description: >- - The field type of `value` and `field` do not need to match to be - considered equal, but not all comparisons are possible. EQUAL_TO and - NOT_EQUAL_TO attempt to compare even with incompatible types, but all - other comparisons are invalid with incompatible types. A `value` of - type: - `string` can be compared against all other types - `boolean` can - only be compared against other booleans - `integer` can be compared - against doubles or a string if the string value can be parsed as an - integer. - `double` can be compared against integers or a string if the - string can be parsed as a double. - `Timestamp` can be compared against - strings in RFC 3339 date string format. - `TimeOfDay` can be compared - against timestamps and strings in the format of 'HH:mm:ss'. If we fail - to compare do to type mismatch, a warning will be given and the - condition will evaluate to false. - GooglePrivacyDlpV2Bucket: - type: object - id: GooglePrivacyDlpV2Bucket - properties: - min: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: >- - Lower bound of the range, inclusive. Type should be the same as max - if used. - max: - description: Upper bound of the range, exclusive; type must match min. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - replacementValue: - description: Required. Replacement value for this bucket. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Bucket is represented as a range, along with replacement values. - GooglePrivacyDlpV2SecretsDiscoveryTarget: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + triggerName: + description: Job trigger name, if applicable, for this finding. + type: string + resourceName: + type: string + description: The job that stored the finding. + jobName: + type: string + description: The job that stored the finding. + location: + $ref: '#/components/schemas/GooglePrivacyDlpV2Location' + description: Where the content was found. + createTime: + type: string + format: google-datetime + description: Timestamp when finding was detected. + id: GooglePrivacyDlpV2Finding type: object - id: GooglePrivacyDlpV2SecretsDiscoveryTarget - properties: {} - description: >- - Discovery target for credentials and secrets in cloud resource metadata. - This target does not include any filtering or frequency controls. Cloud - DLP will scan cloud resource metadata for secrets daily. No inspect - template should be included in the discovery config for a security - benchmarks scan. Instead, the built-in list of secrets and credentials - infoTypes will be used (see - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). - Credentials and secrets discovered will be reported as vulnerabilities - to Security Command Center. - GooglePrivacyDlpV2DeltaPresenceEstimationConfig: - description: >- - δ-presence metric, used to estimate how likely it is for an attacker to - figure out that one given individual appears in a de-identified dataset. - Similarly to the k-map metric, we cannot compute δ-presence exactly - without knowing the attack dataset, so we use a statistical model - instead. + GooglePrivacyDlpV2CharacterMaskConfig: type: object - id: GooglePrivacyDlpV2DeltaPresenceEstimationConfig properties: - quasiIds: - type: array - description: >- - Required. Fields considered to be quasi-identifiers. No two fields - can have the same tag. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiId' - regionCode: + numberToMask: description: >- - ISO 3166-1 alpha-2 region code to use in the statistical modeling. - Set if no column is tagged with a region-specific InfoType (like - US_ZIP_5) or a region code. - type: string - auxiliaryTables: + Number of characters to mask. If not set, all matching chars will be + masked. Skipped characters do not count towards this tally. If + `number_to_mask` is negative, this denotes inverse masking. Cloud + DLP masks all but a number of characters. For example, suppose you + have the following values: - `masking_character` is `*` - + `number_to_mask` is `-4` - `reverse_order` is `false` - + `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` + The resulting de-identified string is `****-****-****-3456`. Cloud + DLP masks all but the last four characters. If `reverse_order` is + `true`, all but the first four characters are masked as + `1234-****-****-****`. + format: int32 + type: integer + reverseOrder: + type: boolean description: >- - Several auxiliary tables can be used in the analysis. Each - custom_tag used to tag a quasi-identifiers field must appear in - exactly one field of one auxiliary table. + Mask characters in reverse order. For example, if + `masking_character` is `0`, `number_to_mask` is `14`, and + `reverse_order` is `false`, then the input string + `1234-5678-9012-3456` is masked as `00000000000000-3456`. If + `masking_character` is `*`, `number_to_mask` is `3`, and + `reverse_order` is `true`, then the string `12345` is masked as + `12***`. + charactersToIgnore: + description: >- + When masking a string, items in this list will be skipped when + replacing characters. For example, if the input string is + `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 + characters with `*`, Cloud DLP returns `***-**5-5555`. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StatisticalTable' + $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' type: array - GooglePrivacyDlpV2AllOtherBigQueryTables: - properties: {} - type: object - id: GooglePrivacyDlpV2AllOtherBigQueryTables + maskingCharacter: + description: >- + Character to use to mask the sensitive values—for example, `*` for + an alphabetic string such as a name, or `0` for a numeric string + such as ZIP code or credit card number. This string must have a + length of 1. If not supplied, this value defaults to `*` for + strings, and `0` for digits. + type: string description: >- - Catch-all for all other tables not specified by other filters. Should - always be last, except for single-table configurations, which will only - have a TableReference target. - GooglePrivacyDlpV2PrivacyMetric: - description: Privacy metric to compute for reidentification risk analysis. + Partially mask a string by replacing a given number of characters with a + fixed character. Masking can start from the beginning or end of the + string. This can be used on data of any type (numbers, longs, and so on) + and when de-identifying structured data we'll attempt to preserve the + original data's type. (This allows you to take a long like 123 and + modify it to a string like **3. + id: GooglePrivacyDlpV2CharacterMaskConfig + GooglePrivacyDlpV2VersionDescription: + description: Details about each available version for an infotype. + id: GooglePrivacyDlpV2VersionDescription + type: object properties: - kAnonymityConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' - description: K-anonymity - deltaPresenceEstimationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' - description: delta-presence - kMapEstimationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' - description: k-map - numericalStatsConfig: - description: Numerical stats - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' - categoricalStatsConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' - description: Categorical stats - lDiversityConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' - description: l-diversity + description: + description: Description of the version. + type: string + version: + type: string + description: Name of the version + GooglePrivacyDlpV2Color: + description: Represents a color in the RGB color space. + id: GooglePrivacyDlpV2Color type: object - id: GooglePrivacyDlpV2PrivacyMetric - GooglePrivacyDlpV2FixedSizeBucketingConfig: - id: GooglePrivacyDlpV2FixedSizeBucketingConfig - description: >- - Buckets values based on fixed size ranges. The Bucketing transformation - can provide all of this functionality, but requires more configuration. - This message is provided as a convenience to the user for simple - bucketing strategies. The transformed value will be a hyphenated string - of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and - upper_bound = 20, all values that are within this bucket will be - replaced with "10-20". This can be used on data of type: double, long. - If the bound Value type differs from the type of data being transformed, - we will first attempt converting the type of the data to be transformed - to match the type of the bound before comparing. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing - to learn more. properties: - lowerBound: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: >- - Required. Lower bound value of buckets. All values less than - `lower_bound` are grouped together into a single bucket; for example - if `lower_bound` = 10, then all values less than 10 are replaced - with the value "-10". - bucketSize: - description: >- - Required. Size of each bucket (except for minimum and maximum - buckets). So if `lower_bound` = 10, `upper_bound` = 89, and - `bucket_size` = 10, then the following buckets would be used: -10, - 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. - Precision up to 2 decimals works. - format: double + blue: + format: float + description: The amount of blue in the color as a value in the interval [0, 1]. type: number - upperBound: - description: >- - Required. Upper bound value of buckets. All values greater than - upper_bound are grouped together into a single bucket; for example - if `upper_bound` = 89, then all values greater than 89 are replaced - with the value "89+". - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - type: object - GooglePrivacyDlpV2ImageTransformation: - type: object - id: GooglePrivacyDlpV2ImageTransformation + red: + type: number + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + green: + type: number + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + GooglePrivacyDlpV2QuoteInfo: properties: - allInfoTypes: - description: >- - Apply transformation to all findings not specified in other - ImageTransformation's selected_info_types. Only one instance is - allowed within the ImageTransformations message. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' - selectedInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' - description: Apply transformation to the selected info_types. - redactionColor: - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' - description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - allText: - description: >- - Apply transformation to all text that doesn't match an infoType. - Only one instance is allowed within the ImageTransformations - message. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' - description: Configuration for determining how redaction of images should occur. - GooglePrivacyDlpV2CloudSqlDiscoveryTarget: + dateTime: + $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' + description: The date time indicated by the quote. + description: Message for infoType-dependent details parsed from quote. + id: GooglePrivacyDlpV2QuoteInfo type: object - id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget + GooglePrivacyDlpV2ReplaceDictionaryConfig: + description: >- + Replace each input value with a value randomly selected from the + dictionary. properties: - filter: - description: >- - Required. The tables the discovery cadence applies to. The first - target with a matching filter will be the one to apply to a table. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlFilter' - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Disable profiling for database resources that match this filter. - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' - description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - generationCadence: + wordList: + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' description: >- - How often and when to update profiles. New tables that match both - the filter and conditions are scanned as quickly as possible - depending on system capacity. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence - description: Target used to match against for discovery with Cloud SQL tables. - GooglePrivacyDlpV2ValueFrequency: + A list of words to select from for random replacement. The + [limits](https://cloud.google.com/sensitive-data-protection/limits) + page contains details about the size limits of dictionaries. + id: GooglePrivacyDlpV2ReplaceDictionaryConfig type: object + GooglePrivacyDlpV2InspectionRule: properties: - count: - format: int64 - type: string - description: How many times the value is contained in the field. - value: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: A value contained in the field in question. - id: GooglePrivacyDlpV2ValueFrequency - description: A value of a field, including its frequency. - GooglePrivacyDlpV2DocumentLocation: - properties: - fileOffset: - type: string - format: int64 - description: >- - Offset of the line, from the beginning of the file, where the - finding is located. - description: Location of a finding within a document. + hotwordRule: + description: Hotword-based detection rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + exclusionRule: + $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' + description: Exclusion rule. type: object - id: GooglePrivacyDlpV2DocumentLocation - GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: + id: GooglePrivacyDlpV2InspectionRule + description: >- + A single inspection rule to be applied to infoTypes, specified in + `InspectionRuleSet`. + GooglePrivacyDlpV2DiscoveryCloudStorageFilter: type: object - id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest - description: Request message for UpdateStoredInfoType. properties: - updateMask: - type: string - description: Mask to control which fields get updated. - format: google-fieldmask - config: + collection: + description: Optional. A specific set of buckets for this filter to apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreCollection' + cloudStorageResourceReference: description: >- - Updated configuration for the storedInfoType. If not provided, a new - version of the storedInfoType will be created with the existing - configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - GooglePrivacyDlpV2InfoTypeLikelihood: - description: >- - Configuration for setting a minimum likelihood per infotype. Used to - customize the minimum likelihood level for specific infotypes in the - request. For example, use this if you want to lower the precision for - PERSON_NAME without lowering the precision for the other infotypes in - the request. + Optional. The bucket to scan. Targets including this can only + include one target (the target with this bucket). This enables + profiling the contents of a single bucket, while the other options + allow for easy profiling of many bucets within a project or an + organization. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageResourceReference' + others: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' + description: >- + Optional. Catch-all. This should always be the last target in the + list because anything above it will apply first. Should only appear + once in a configuration. If none is specified, a default one will be + added automatically. + description: >- + Determines which buckets will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID and bucket name. + id: GooglePrivacyDlpV2DiscoveryCloudStorageFilter + GooglePrivacyDlpV2DiscoveryCloudSqlConditions: properties: - minLikelihood: - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. + types: + items: + enum: + - DATABASE_RESOURCE_TYPE_UNSPECIFIED + - DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES + - DATABASE_RESOURCE_TYPE_TABLE + type: string + enumDescriptions: + - Unused. + - >- + Includes database resource types that become supported at a + later time. + - Tables. + type: array description: >- - Only returns findings equal to or above this threshold. This field - is required or else the configuration fails. - type: string - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + Data profiles will only be generated for the database resource types + specified in this field. If not specified, defaults to + [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + databaseEngines: + type: array + items: + enum: + - DATABASE_ENGINE_UNSPECIFIED + - ALL_SUPPORTED_DATABASE_ENGINES + - MYSQL + - POSTGRES + enumDescriptions: + - Unused. + - Include all supported database engines. + - MySQL database. + - PostgreSQL database. + type: string description: >- - Type of information the likelihood threshold applies to. Only one - likelihood per info_type should be provided. If InfoTypeLikelihood - does not have an info_type, the configuration fails. - type: object - id: GooglePrivacyDlpV2InfoTypeLikelihood - GooglePrivacyDlpV2FieldId: - properties: - name: - type: string - description: Name describing the field. - type: object - id: GooglePrivacyDlpV2FieldId - description: General identifier of a data field in a storage service. - GooglePrivacyDlpV2DataProfileConfigSnapshot: + Optional. Database engines that should be profiled. Optional. + Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + description: >- + Requirements that must be true before a table is profiled for the first + time. + id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions type: object - id: GooglePrivacyDlpV2DataProfileConfigSnapshot + GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: + description: >- + How often existing tables should have their profiles refreshed. New + tables are scanned as quickly as possible depending on system capacity. properties: - dataProfileJob: - deprecated: true + refreshFrequency: description: >- - A copy of the configuration used to generate this profile. This is - deprecated, and the DiscoveryConfig field is preferred moving - forward. DataProfileJobConfig will still be written here for - Discovery in BigQuery for backwards compatibility, but will not be - updated with new fields, while DiscoveryConfig will. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' - inspectTemplateModifiedTime: + Data changes (non-schema changes) in Cloud SQL tables can't trigger + reprofiling. If you set this field, profiles are refreshed at this + frequency regardless of whether the underlying tables have changed. + Defaults to never. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. type: string - format: google-datetime - description: Timestamp when the template was modified - inspectConfig: + inspectTemplateModifiedCadence: description: >- - A copy of the inspection config used to generate this profile. This - is a copy of the inspect_template specified in - `DataProfileJobConfig`. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: A copy of the configuration used to generate this profile. - inspectTemplateName: - type: string - description: Name of the inspection template used to generate this profile - description: Snapshot of the configurations used to generate the profile. - GooglePrivacyDlpV2ProfileStatus: + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + schemaModifiedCadence: + description: When to reprofile if the schema has changed. + $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' + type: object + id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + GoogleTypeTimeOfDay: + description: >- + Represents a time of day. The date and time zone are either not + significant or are specified elsewhere. An API may choose to allow leap + seconds. Related types are google.type.Date and + `google.protobuf.Timestamp`. type: object - id: GooglePrivacyDlpV2ProfileStatus - description: Success or errors for the profile generation. properties: - status: + hours: + format: int32 description: >- - Profiling status code and optional message. The `status.code` value - is 0 (default value) for OK. - $ref: '#/components/schemas/GoogleRpcStatus' - timestamp: - format: google-datetime - type: string - description: Time when the profile generation status was updated - GooglePrivacyDlpV2PublishSummaryToCscc: + Hours of day in 24 hour format. Should be from 0 to 23. An API may + choose to allow the value "24:00:00" for scenarios like business + closing time. + type: integer + minutes: + type: integer + description: Minutes of hour of day. Must be from 0 to 59. + format: int32 + seconds: + format: int32 + description: >- + Seconds of minutes of the time. Must normally be from 0 to 59. An + API may allow the value 60 if it allows leap-seconds. + type: integer + nanos: + description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + format: int32 + type: integer + id: GoogleTypeTimeOfDay + GooglePrivacyDlpV2Expressions: type: object - description: >- - Publish the result summary of a DlpJob to [Security Command - Center](https://cloud.google.com/security-command-center). This action - is available for only projects that belong to an organization. This - action publishes the count of finding instances and their infoTypes. The - summary of findings are persisted in Security Command Center and are - governed by [service-specific policies for Security Command - Center](https://cloud.google.com/terms/service-terms). Only a single - instance of this action can be specified. Compatible with: Inspect - id: GooglePrivacyDlpV2PublishSummaryToCscc - properties: {} - GooglePrivacyDlpV2CreateStoredInfoTypeRequest: properties: - locationId: + conditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' + description: Conditions to apply to the expression. + logicalOperator: type: string - description: Deprecated. This field has no effect. - config: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - description: Required. Configuration of the storedInfoType to create. - storedInfoTypeId: description: >- - The storedInfoType ID can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: string + The operator to apply to the result of conditions. Default and + currently only supported value is `AND`. + enumDescriptions: + - Unused + - Conditional AND + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - AND + description: An expression, consisting of an operator and conditions. + id: GooglePrivacyDlpV2Expressions + GooglePrivacyDlpV2InfoTypeCategory: type: object - description: Request message for CreateStoredInfoType. - id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest - GooglePrivacyDlpV2CharsToIgnore: - id: GooglePrivacyDlpV2CharsToIgnore description: >- - Characters to skip when doing deidentification of a value. These will be - left alone and skipped. - type: object + Classification of infoTypes to organize them according to geographic + location, industry, and data type. + id: GooglePrivacyDlpV2InfoTypeCategory properties: - charactersToSkip: - type: string - description: Characters to not transform when masking. - commonCharactersToIgnore: - type: string - enum: - - COMMON_CHARS_TO_IGNORE_UNSPECIFIED - - NUMERIC - - ALPHA_UPPER_CASE - - ALPHA_LOWER_CASE - - PUNCTUATION - - WHITESPACE + locationCategory: enumDescriptions: - - Unused. - - 0-9 - - A-Z - - a-z - - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ - - Whitespace character, one of [ \t\n\x0B\f\r] - description: >- - Common characters to not transform when masking. Useful to avoid - removing punctuation. - GoogleProtobufEmpty: - properties: {} - 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: GoogleProtobufEmpty - type: object - GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: - properties: - maxProbability: - format: double - type: number - description: Always greater than or equal to min_probability. - minProbability: - description: Between 0 and 1. - format: double - type: number - bucketValueCount: + - Unused location + - >- + The infoType is not issued by or tied to a specific region, but is + used almost everywhere. + - The infoType is typically used in Argentina. + - The infoType is typically used in Armenia. + - The infoType is typically used in Australia. + - The infoType is typically used in Azerbaijan. + - The infoType is typically used in Belarus. + - The infoType is typically used in Belgium. + - The infoType is typically used in Brazil. + - The infoType is typically used in Canada. + - The infoType is typically used in Chile. + - The infoType is typically used in China. + - The infoType is typically used in Colombia. + - The infoType is typically used in Croatia. + - The infoType is typically used in Denmark. + - The infoType is typically used in France. + - The infoType is typically used in Finland. + - The infoType is typically used in Germany. + - The infoType is typically used in Hong Kong. + - The infoType is typically used in India. + - The infoType is typically used in Indonesia. + - The infoType is typically used in Ireland. + - The infoType is typically used in Israel. + - The infoType is typically used in Italy. + - The infoType is typically used in Japan. + - The infoType is typically used in Kazakhstan. + - The infoType is typically used in Korea. + - The infoType is typically used in Mexico. + - The infoType is typically used in the Netherlands. + - The infoType is typically used in New Zealand. + - The infoType is typically used in Norway. + - The infoType is typically used in Paraguay. + - The infoType is typically used in Peru. + - The infoType is typically used in Poland. + - The infoType is typically used in Portugal. + - The infoType is typically used in Russia. + - The infoType is typically used in Singapore. + - The infoType is typically used in South Africa. + - The infoType is typically used in Spain. + - The infoType is typically used in Sweden. + - The infoType is typically used in Switzerland. + - The infoType is typically used in Taiwan. + - The infoType is typically used in Thailand. + - The infoType is typically used in Turkey. + - The infoType is typically used in Ukraine. + - The infoType is typically used in the United Kingdom. + - The infoType is typically used in the United States. + - The infoType is typically used in Uruguay. + - The infoType is typically used in Uzbekistan. + - The infoType is typically used in Venezuela. + - The infoType is typically used in Google internally. description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - format: int64 + The region or country that issued the ID or document represented by + the infoType. + enum: + - LOCATION_UNSPECIFIED + - GLOBAL + - ARGENTINA + - ARMENIA + - AUSTRALIA + - AZERBAIJAN + - BELARUS + - BELGIUM + - BRAZIL + - CANADA + - CHILE + - CHINA + - COLOMBIA + - CROATIA + - DENMARK + - FRANCE + - FINLAND + - GERMANY + - HONG_KONG + - INDIA + - INDONESIA + - IRELAND + - ISRAEL + - ITALY + - JAPAN + - KAZAKHSTAN + - KOREA + - MEXICO + - THE_NETHERLANDS + - NEW_ZEALAND + - NORWAY + - PARAGUAY + - PERU + - POLAND + - PORTUGAL + - RUSSIA + - SINGAPORE + - SOUTH_AFRICA + - SPAIN + - SWEDEN + - SWITZERLAND + - TAIWAN + - THAILAND + - TURKEY + - UKRAINE + - UNITED_KINGDOM + - UNITED_STATES + - URUGUAY + - UZBEKISTAN + - VENEZUELA + - INTERNAL type: string - bucketSize: + typeCategory: type: string - format: int64 - description: Number of records within these probability bounds. - bucketValues: + enum: + - TYPE_UNSPECIFIED + - PII + - SPII + - DEMOGRAPHIC + - CREDENTIAL + - GOVERNMENT_ID + - DOCUMENT + - CONTEXTUAL_INFORMATION + enumDescriptions: + - Unused type + - >- + Personally identifiable information, for example, a name or phone + number + - >- + Personally identifiable information that is especially sensitive, + for example, a passport number. + - >- + Attributes that can partially identify someone, especially in + combination with other attributes, like age, height, and gender. + - Confidential or secret information, for example, a password. + - An identification document issued by a government. + - A document, for example, a resume or source code. + - >- + Information that is not sensitive on its own, but provides details + about the circumstances surrounding an entity or an event. + description: The class of identifiers where this infoType belongs + industryCategory: + enumDescriptions: + - Unused industry + - The infoType is typically used in the finance industry. + - The infoType is typically used in the health industry. + - The infoType is typically used in the telecommunications industry. + enum: + - INDUSTRY_UNSPECIFIED + - FINANCE + - HEALTH + - TELECOMMUNICATIONS description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues - type: array - description: >- - A DeltaPresenceEstimationHistogramBucket message with the following - values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means - that there are 42 records for which δ is in [0.1, 0.2). An important - particular case is when min_probability = max_probability = 1: then, - every individual who shares this quasi-identifier combination is in the - dataset. - id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket - type: object - GooglePrivacyDlpV2ImageRedactionConfig: + The group of relevant businesses where this infoType is commonly + used + type: string + GooglePrivacyDlpV2OrgConfig: type: object - description: Configuration for determining how redaction of images should occur. properties: - redactionColor: - description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - Only one per info_type should be provided per request. If not - specified, and redact_all_text is false, the DLP API will redact all - text that it matches against all info_types that are found, but not - specified in another ImageRedactionConfig. - redactAllText: - type: boolean + projectId: + type: string description: >- - If true, all text found in the image, regardless whether it matches - an info_type, is redacted. Only one should be provided. - id: GooglePrivacyDlpV2ImageRedactionConfig - GooglePrivacyDlpV2InfoTypeSummary: - properties: - estimatedPrevalence: - type: integer - format: int32 - deprecated: true - description: Not populated for predicted infotypes. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The infoType. - id: GooglePrivacyDlpV2InfoTypeSummary - description: The infoType details for this column. - type: object - GooglePrivacyDlpV2StoredInfoTypeVersion: - id: GooglePrivacyDlpV2StoredInfoTypeVersion + The project that will run the scan. The DLP service account that + exists within this project must have access to all resources that + are profiled, and the Cloud DLP API must be enabled. + location: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' + description: 'The data to scan: folder, org, or project' + id: GooglePrivacyDlpV2OrgConfig + description: >- + Project and scan location information. Only set when the parent is an + org. + GooglePrivacyDlpV2DateTime: type: object + description: Message for a date time object. e.g. 2018-01-01, 5th August. properties: - stats: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' - description: Statistics about this storedInfoType version. - config: - description: StoredInfoType configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - state: - enum: - - STORED_INFO_TYPE_STATE_UNSPECIFIED - - PENDING - - READY - - FAILED - - INVALID + dayOfWeek: type: string - enumDescriptions: - - Unused - - StoredInfoType version is being created. - - StoredInfoType version is ready for use. - - >- - StoredInfoType creation failed. All relevant error messages are - returned in the `StoredInfoTypeVersion` message. - - >- - StoredInfoType is no longer valid because artifacts stored in - user-controlled storage were modified. To fix an invalid - StoredInfoType, use the `UpdateStoredInfoType` method to create a - new version. - description: >- - Stored info type version state. Read-only, updated by the system - during dictionary creation. - errors: + description: Day of week + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + timeZone: + $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' + description: Time zone + time: + description: Time of day + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + date: + $ref: '#/components/schemas/GoogleTypeDate' description: >- - Errors that occurred when creating this storedInfoType version, or - anomalies detected in the storedInfoType data that render it - unusable. Only the five most recent errors will be displayed, with - the most recent error appearing first. For example, some of the data - for stored custom dictionaries is put in the user's Cloud Storage - bucket, and if this data is modified or deleted by the user or - another system, the dictionary becomes invalid. If any errors occur, - fix the problem indicated by the error message and use the - UpdateStoredInfoType API method to create another version of the - storedInfoType to continue using it, reusing the same `config` if it - was not the source of the error. + One or more of the following must be set. Must be a valid date or + time value. + id: GooglePrivacyDlpV2DateTime + GooglePrivacyDlpV2ListJobTriggersResponse: + properties: + jobTriggers: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - createTime: - format: google-datetime - description: >- - Create timestamp of the version. Read-only, determined by the system - when the version is created. - type: string - description: >- - Version of a StoredInfoType, including the configuration used to build - it, create timestamp, and current state. - GooglePrivacyDlpV2AllInfoTypes: - type: object - description: Apply transformation to all findings. - properties: {} - id: GooglePrivacyDlpV2AllInfoTypes - GooglePrivacyDlpV2DataSourceType: - properties: - dataSource: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. + nextPageToken: type: string description: >- - Output only. An identifying string to the type of resource being - profiled. Current values: * google/bigquery/table * google/project * - google/sql/table * google/gcs/bucket - readOnly: true + If the next page is available then this value is the next page token + to be used in the following ListJobTriggers request. + description: Response message for ListJobTriggers. type: object - description: Message used to identify the type of resource being profiled. - id: GooglePrivacyDlpV2DataSourceType - GooglePrivacyDlpV2FileClusterSummary: + id: GooglePrivacyDlpV2ListJobTriggersResponse + GooglePrivacyDlpV2Deidentify: + id: GooglePrivacyDlpV2Deidentify properties: - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: >- - The data risk level of this cluster. RISK_LOW if nothing has been - scanned. - fileExtensionsSeen: - description: >- - A sample of file types seen in this cluster. Empty if no files were - seen. File extensions can be derived from the file name or the file - content. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' - fileStoreInfoTypeSummaries: - description: InfoTypes detected in this cluster. + fileTypesToTransform: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' - noFilesExist: - type: boolean - description: >- - True if no files exist in this cluster. If the bucket had more files - than could be listed, this will be false even if no files for this - cluster were seen and file_extensions_seen is empty. - sensitivityScore: - description: >- - The sensitivity score of this cluster. The score will be - SENSITIVITY_LOW if nothing has been scanned. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - errors: + enumDescriptions: + - Includes all files. + - >- + Includes all file extensions not covered by another entry. + Binary scanning attempts to convert the content of the file to + utf_8 to scan the file. If you wish to avoid this fall back, + specify one or more of the other file types in your storage + scan. + - >- + Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, + cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, + go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, + mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, + rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, + xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, + md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, + xsd, yml, yaml. + - >- + Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting + bytes_limit_per_file or bytes_limit_per_file_percent has no + effect on image files. Image inspection is restricted to the + `global`, `us`, `asia`, and `europe` regions. + - >- + Microsoft Word files larger than 30 MB will be scanned as binary + files. Included file extensions: docx, dotx, docm, dotm. Setting + `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no + effect on Word files. + - >- + PDF files larger than 30 MB will be scanned as binary files. + Included file extensions: pdf. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PDF files. + - 'Included file extensions: avro' + - 'Included file extensions: csv' + - 'Included file extensions: tsv' + - >- + Microsoft PowerPoint files larger than 30 MB will be scanned as + binary files. Included file extensions: pptx, pptm, potx, potm, + pot. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PowerPoint + files. + - >- + Microsoft Excel files larger than 30 MB will be scanned as + binary files. Included file extensions: xlsx, xlsm, xltx, xltm. + Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` + has no effect on Excel files. + enum: + - FILE_TYPE_UNSPECIFIED + - BINARY_FILE + - TEXT_FILE + - IMAGE + - WORD + - PDF + - AVRO + - CSV + - TSV + - POWERPOINT + - EXCEL + type: string description: >- - A list of errors detected while scanning this cluster. The list is - truncated to 10 per cluster. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - fileExtensionsScanned: - type: array + List of user-specified file type groups to transform. If specified, + only the files with these file types will be transformed. If empty, + all supported files will be transformed. Supported types may be + automatically added over time. If a file type is set in this field + that isn't supported by the Deidentify action then the job will fail + and will not be successfully created/started. Currently the only + file types supported are: IMAGES, TEXT_FILES, CSV, TSV. + transformationDetailsStorageConfig: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig description: >- - A sample of file types scanned in this cluster. Empty if no files - were scanned. File extensions can be derived from the file name or - the file content. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' - fileClusterType: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterType' - description: The file cluster type. - description: The file cluster summary. - type: object - id: GooglePrivacyDlpV2FileClusterSummary - GooglePrivacyDlpV2RedactImageResponse: - properties: - inspectResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + Config for storing transformation details. This is separate from the + de-identified content, and contains metadata about the successful + transformations and/or failures that occurred while de-identifying. + This needs to be set in order for users to access information about + the status of each transformation (see TransformationDetails message + for more information about what is noted). + transformationConfig: description: >- - The findings. Populated when include_findings in the request is - true. - redactedImage: + User specified deidentify templates and configs for structured, + unstructured, and image files. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' + cloudStorageOutput: type: string - description: The redacted image. The type will be the same as the original image. - format: byte - extractedText: description: >- - If an image was being inspected and the InspectConfig's - include_quote was set to true, then this field will include all - text, if any, that was found in the image. - type: string - description: Results of redacting an image. - id: GooglePrivacyDlpV2RedactImageResponse + Required. User settable Cloud Storage bucket and folders to store + de-identified files. This field must be set for Cloud Storage + deidentification. The output Cloud Storage bucket must be different + from the input bucket. De-identified files will overwrite files in + the output path. Form of: gs://bucket/folder/ or gs://bucket + description: >- + Create a de-identified copy of the requested table or files. A + TransformationDetail will be created for each transformation. If any + rows in BigQuery are skipped during de-identification (transformation + errors or row size exceeds BigQuery insert API limits) they are placed + in the failure output table. If the original row exceeds the BigQuery + insert API limit it will be truncated when written to the failure output + table. The failure output table can be set in the + action.deidentify.output.big_query_output.deidentified_failure_output_table + field, if no table is set, a table will be automatically created in the + same project and dataset as the original table. Compatible with: Inspect type: object - GooglePrivacyDlpV2Schedule: + GooglePrivacyDlpV2ImageTransformation: + description: Configuration for determining how redaction of images should occur. properties: - recurrencePeriodDuration: - type: string + allInfoTypes: description: >- - With this option a job is started on a regular periodic basis. For - example: every day (86400 seconds). A scheduled start time will be - skipped if the previous execution has not ended when its scheduled - time occurs. This value must be set to a time duration greater than - or equal to 1 day and can be no longer than 60 days. - format: google-duration - description: Schedule for inspect job triggers. - id: GooglePrivacyDlpV2Schedule + Apply transformation to all findings not specified in other + ImageTransformation's selected_info_types. Only one instance is + allowed within the ImageTransformations message. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' + selectedInfoTypes: + description: Apply transformation to the selected info_types. + $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' + allText: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' + description: >- + Apply transformation to all text that doesn't match an infoType. + Only one instance is allowed within the ImageTransformations + message. + redactionColor: + description: >- + The color to use when redacting content from an image. If not + specified, the default is black. + $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + id: GooglePrivacyDlpV2ImageTransformation type: object GooglePrivacyDlpV2ContentItem: + id: GooglePrivacyDlpV2ContentItem + description: Type of content to inspect. properties: + byteItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + description: Content data to inspect or redact. Replaces `type` and `data`. + value: + description: String data to inspect or redact. + type: string table: - $ref: '#/components/schemas/GooglePrivacyDlpV2Table' description: >- Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. - byteItem: - description: Content data to inspect or redact. Replaces `type` and `data`. - $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' - value: - type: string - description: String data to inspect or redact. - id: GooglePrivacyDlpV2ContentItem - description: Type of content to inspect. - type: object - GooglePrivacyDlpV2BoundingBox: - id: GooglePrivacyDlpV2BoundingBox + $ref: '#/components/schemas/GooglePrivacyDlpV2Table' type: object - description: Bounding box encompassing detected text within an image. + GooglePrivacyDlpV2OrConditions: + id: GooglePrivacyDlpV2OrConditions + description: >- + There is an OR relationship between these attributes. They are used to + determine if a table should be scanned or not in Discovery. properties: - height: - description: Height of the bounding box in pixels. - format: int32 - type: integer - width: - type: integer - format: int32 - description: Width of the bounding box in pixels. - top: - format: int32 - description: Top coordinate of the bounding box. (0,0) is upper left. - type: integer - left: + minRowCount: format: int32 - description: Left coordinate of the bounding box. (0,0) is upper left. + description: >- + Minimum number of rows that should be present before Cloud DLP + profiles a table type: integer - GooglePrivacyDlpV2UnwrappedCryptoKey: - properties: - key: - format: byte - description: Required. A 128/192/256 bit key. + minAge: + format: google-duration + description: >- + Minimum age a table must have before Cloud DLP can profile it. Value + must be 1 hour or greater. type: string - id: GooglePrivacyDlpV2UnwrappedCryptoKey - description: >- - Using raw keys is prone to security risks due to accidentally leaking - the key. Choose another type of key if possible. type: object - GooglePrivacyDlpV2InfoTypeDescription: - description: InfoType description. + GooglePrivacyDlpV2Regex: + description: Message defining a custom regular expression. + type: object properties: - categories: - type: array - description: The category of the infoType. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The default sensitivity of the infoType. - supportedBy: + groupIndexes: items: - enum: - - ENUM_TYPE_UNSPECIFIED - - INSPECT - - RISK_ANALYSIS - enumDescriptions: - - Unused. - - Supported by the inspect operations. - - Supported by the risk analysis operations. - type: string + format: int32 + type: integer type: array - description: Which parts of the API supports this InfoType. - description: - type: string description: >- - Description of the infotype. Translated when language is provided in - the request. - versions: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' - description: A list of available versions for the infotype. - name: - description: Internal name of the infoType. - type: string - displayName: - type: string - description: Human readable form of the infoType name. - type: object - id: GooglePrivacyDlpV2InfoTypeDescription - GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: - properties: {} - id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog - type: object - description: >- - Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag - templates are applied to the resource that Cloud DLP scanned. Data - Catalog tag templates are stored in the same project and region where - the BigQuery table exists. For Cloud DLP to create and apply the tag - template, the Cloud DLP service agent must have the - `roles/datacatalog.tagTemplateOwner` permission on the project. The tag - template contains fields summarizing the results of the DlpJob. Any - field values previously written by another DlpJob are deleted. InfoType - naming patterns are strictly enforced when using this feature. Findings - are persisted in Data Catalog storage and are governed by - service-specific policies for Data Catalog. For more information, see - [Service Specific Terms](https://cloud.google.com/terms/service-terms). - Only a single instance of this action can be specified. This action is - allowed only if all resources being scanned are BigQuery tables. - Compatible with: Inspect - GooglePrivacyDlpV2QuoteInfo: - properties: - dateTime: - description: The date time indicated by the quote. - $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' - description: Message for infoType-dependent details parsed from quote. - id: GooglePrivacyDlpV2QuoteInfo - type: object - GooglePrivacyDlpV2ExclusionRule: - properties: - matchingType: + The index of the submatch to extract as findings. When not + specified, the entire match is returned. No more than 3 may be + included. + pattern: type: string - enum: - - MATCHING_TYPE_UNSPECIFIED - - MATCHING_TYPE_FULL_MATCH - - MATCHING_TYPE_PARTIAL_MATCH - - MATCHING_TYPE_INVERSE_MATCH - description: How the rule is applied, see MatchingType documentation for details. - enumDescriptions: - - Invalid. - - >- - Full match. - Dictionary: join of Dictionary results matched - complete finding quote - Regex: all regex matches fill a finding - quote start to end - Exclude info type: completely inside - affecting info types findings - - >- - Partial match. - Dictionary: at least one of the tokens in the - finding matches - Regex: substring of the finding matches - - Exclude info type: intersects with affecting info types findings - - >- - Inverse match. - Dictionary: no tokens in the finding match the - dictionary - Regex: finding doesn't match the regex - Exclude info - type: no intersection with affecting info types findings - excludeByHotword: description: >- - Drop if the hotword rule is contained in the proximate context. For - tabular data, the context includes the column name. - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' - regex: - description: Regular expression which defines the rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - excludeInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' - description: Set of infoTypes for which findings would affect this rule. - dictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - description: Dictionary which defines the rule. - id: GooglePrivacyDlpV2ExclusionRule - description: >- - The rule that specifies conditions when findings of infoTypes specified - in `InspectionRuleSet` are removed from results. - type: object - GooglePrivacyDlpV2CreateConnectionRequest: - properties: - connection: - description: Required. The connection resource. - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + Pattern defining the regular expression. Its syntax + (https://github.com/google/re2/wiki/Syntax) can be found under the + google/re2 repository on GitHub. + id: GooglePrivacyDlpV2Regex + GooglePrivacyDlpV2DatabaseResourceReference: type: object - description: Request message for CreateConnection. - id: GooglePrivacyDlpV2CreateConnectionRequest - GooglePrivacyDlpV2StoredType: - description: A reference to a StoredInfoType to use with scanning. + id: GooglePrivacyDlpV2DatabaseResourceReference properties: - createTime: - format: google-datetime + instance: description: >- - Timestamp indicating when the version of the `StoredInfoType` used - for inspection was created. Output-only field, populated by the - system. + Required. The instance where this resource is located. For example: + Cloud SQL instance ID. type: string - name: + projectId: description: >- - Resource name of the requested `StoredInfoType`, for example - `organizations/433245324/storedInfoTypes/432452342` or - `projects/project-id/storedInfoTypes/432452342`. + Required. If within a project-level config, then this must match the + config's project ID. type: string - type: object - id: GooglePrivacyDlpV2StoredType - GooglePrivacyDlpV2UpdateJobTriggerRequest: - properties: - updateMask: - format: google-fieldmask + database: type: string - description: Mask to control which fields get updated. - jobTrigger: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - description: New JobTrigger value. - id: GooglePrivacyDlpV2UpdateJobTriggerRequest - type: object - description: Request message for UpdateJobTrigger. - GooglePrivacyDlpV2DataProfileJobConfig: + description: Required. Name of a database within the instance. + databaseResource: + description: >- + Required. Name of a database resource, for example, a table within + the database. + type: string + description: Identifies a single database resource, like a table within a database. + GooglePrivacyDlpV2TimespanConfig: type: object + id: GooglePrivacyDlpV2TimespanConfig properties: + startTime: + description: >- + Exclude files, tables, or rows older than this value. If not set, no + lower time limit is applied. + format: google-datetime + type: string + timestampField: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + Specification of the field containing the timestamp of scanned + items. Used for data sources like Datastore and BigQuery. **For + BigQuery** If this value is not specified and the table was modified + between the given start and end times, the entire table will be + scanned. If this value is specified, then rows are filtered based on + the given start and end times. Rows with a `NULL` value in the + provided BigQuery column are skipped. Valid data types of the + provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and + `DATETIME`. If your BigQuery table is [partitioned at ingestion + time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), + you can use any of the following pseudo-columns as your timestamp + field. When used with Cloud DLP, these pseudo-column names are case + sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - + `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, + then entities are filtered based on the given start and end times. + If an entity does not contain the provided timestamp property or + contains empty or invalid values, then it is included. Valid data + types of the provided timestamp property are: `TIMESTAMP`. See the + [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) + related to this operation. + endTime: + type: string + description: >- + Exclude files, tables, or rows newer than this value. If not set, no + upper time limit is applied. + format: google-datetime + enableAutoPopulationOfTimespanConfig: + description: >- + When the job is started by a JobTrigger we will automatically figure + out a valid start_time to avoid scanning files that have not been + modified since the last time the JobTrigger executed. This will be + based on the time of the execution of the last run of the JobTrigger + or the timespan end_time used in the last run of the JobTrigger. + **For BigQuery** Inspect jobs triggered by automatic population will + scan data that is at least three hours old when the job starts. This + is because streaming buffer rows are not read during inspection and + reading up to the current timestamp will result in skipped rows. See + the [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) + related to this operation. + type: boolean + description: >- + Configuration of the timespan of the items to include in scanning. + Currently only supported when inspecting Cloud Storage and BigQuery. + GooglePrivacyDlpV2Proximity: + id: GooglePrivacyDlpV2Proximity + properties: + windowBefore: + type: integer + description: >- + Number of characters before the finding to consider. For tabular + data, if you want to modify the likelihood of an entire column of + findngs, set this to 1. For more information, see [Hotword example: + Set the match likelihood of a table column] + (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + format: int32 + windowAfter: + type: integer + description: Number of characters after the finding to consider. + format: int32 + type: object + description: >- + Message for specifying a window around a finding to apply a detection + rule. + GooglePrivacyDlpV2DataProfileJobConfig: + properties: + dataProfileActions: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + type: array + description: Actions to execute at the completion of the job. + location: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' + description: The data to scan. + projectId: + description: >- + The project that will run the scan. The DLP service account that + exists within this project must have access to all resources that + are profiled, and the Cloud DLP API must be enabled. + type: string inspectTemplates: type: array items: @@ -989,198 +965,318 @@ components: data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. - projectId: - type: string - description: >- - The project that will run the scan. The DLP service account that - exists within this project must have access to all resources that - are profiled, and the Cloud DLP API must be enabled. - location: - description: The data to scan. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' - dataProfileActions: - description: Actions to execute at the completion of the job. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - type: array + type: object + id: GooglePrivacyDlpV2DataProfileJobConfig description: >- Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). - id: GooglePrivacyDlpV2DataProfileJobConfig - GooglePrivacyDlpV2DeidentifyTemplate: - type: object + GooglePrivacyDlpV2AuxiliaryTable: description: >- - DeidentifyTemplates contains instructions on how to de-identify content. - See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. - id: GooglePrivacyDlpV2DeidentifyTemplate + An auxiliary table contains statistical information on the relative + frequency of different quasi-identifiers values. It has one or several + quasi-identifiers columns, and one column that indicates the relative + frequency of each quasi-identifier tuple. If a tuple is present in the + data but not in the auxiliary table, the corresponding relative + frequency is assumed to be zero (and thus, the tuple is highly + reidentifiable). properties: - deidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - description: The core content of the template. - name: + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Required. Auxiliary table location. + relativeFrequency: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + Required. The relative frequency column must contain a + floating-point number between 0 and 1 (inclusive). Null values are + assumed to be zero. + quasiIds: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' + type: array + description: Required. Quasi-identifier columns. + type: object + id: GooglePrivacyDlpV2AuxiliaryTable + GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: + id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + description: Request message for UpdateDiscoveryConfig. + properties: + updateMask: type: string - readOnly: true + format: google-fieldmask + description: Mask to control which fields get updated. + discoveryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: Required. New DiscoveryConfig value. + type: object + GooglePrivacyDlpV2KAnonymityHistogramBucket: + id: GooglePrivacyDlpV2KAnonymityHistogramBucket + properties: + bucketValues: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` - createTime: - format: google-datetime + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. + equivalenceClassSizeLowerBound: + description: Lower bound on the size of the equivalence classes in this bucket. type: string - readOnly: true - description: Output only. The creation timestamp of an inspectTemplate. - displayName: + format: int64 + bucketValueCount: + description: Total number of distinct equivalence classes in this bucket. + format: int64 type: string - description: Display name (max 256 chars). - description: - description: Short description (max 256 chars). + bucketSize: + format: int64 + description: Total number of equivalence classes in this bucket. type: string - updateTime: - format: google-datetime - readOnly: true + equivalenceClassSizeUpperBound: type: string - description: Output only. The last update timestamp of an inspectTemplate. - GooglePrivacyDlpV2Proximity: - description: >- - Message for specifying a window around a finding to apply a detection - rule. - properties: - windowAfter: - type: integer - description: Number of characters after the finding to consider. - format: int32 - windowBefore: - type: integer - description: >- - Number of characters before the finding to consider. For tabular - data, if you want to modify the likelihood of an entire column of - findngs, set this to 1. For more information, see [Hotword example: - Set the match likelihood of a table column] - (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - format: int32 + format: int64 + description: Upper bound on the size of the equivalence classes in this bucket. + description: Histogram of k-anonymity equivalence classes. type: object - id: GooglePrivacyDlpV2Proximity - GooglePrivacyDlpV2KMapEstimationQuasiIdValues: - description: A tuple of values for the quasi-identifier columns. + GooglePrivacyDlpV2KAnonymityEquivalenceClass: type: object - id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues + description: The set of columns' values that share the same ldiversity value properties: - estimatedAnonymity: - description: The estimated anonymity for these quasi-identifier values. - type: string - format: int64 quasiIdsValues: - description: The quasi-identifier values. items: $ref: '#/components/schemas/GooglePrivacyDlpV2Value' type: array - GooglePrivacyDlpV2QuasiId: - id: GooglePrivacyDlpV2QuasiId - description: A column with a semantic tag attached. - type: object - properties: - customTag: + description: >- + Set of values defining the equivalence class. One value per + quasi-identifier column in the original KAnonymity metric message. + The order is always the same as the original request. + equivalenceClassSize: + format: int64 type: string description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Required. Identifies the column. - infoType: + Size of the equivalence class, for example number of rows with the + above set of values. + id: GooglePrivacyDlpV2KAnonymityEquivalenceClass + GooglePrivacyDlpV2DeltaPresenceEstimationConfig: + properties: + auxiliaryTables: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StatisticalTable' + type: array description: >- - A column can be tagged with a InfoType to use the relevant public - dataset as a statistical model of population, if available. We - currently support US ZIP codes, region codes, ages and genders. To - programmatically obtain the list of supported InfoTypes, use - ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - inferred: - $ref: '#/components/schemas/GoogleProtobufEmpty' + Several auxiliary tables can be used in the analysis. Each + custom_tag used to tag a quasi-identifiers field must appear in + exactly one field of one auxiliary table. + quasiIds: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiId' description: >- - If no semantic tag is indicated, we infer the statistical model from - the distribution of values in the input data - GooglePrivacyDlpV2LargeCustomDictionaryConfig: + Required. Fields considered to be quasi-identifiers. No two fields + can have the same tag. + regionCode: + type: string + description: >- + ISO 3166-1 alpha-2 region code to use in the statistical modeling. + Set if no column is tagged with a region-specific InfoType (like + US_ZIP_5) or a region code. + type: object + description: >- + δ-presence metric, used to estimate how likely it is for an attacker to + figure out that one given individual appears in a de-identified dataset. + Similarly to the k-map metric, we cannot compute δ-presence exactly + without knowing the attack dataset, so we use a statistical model + instead. + id: GooglePrivacyDlpV2DeltaPresenceEstimationConfig + GooglePrivacyDlpV2ListStoredInfoTypesResponse: properties: - cloudStorageFileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' + nextPageToken: description: >- - Set of files containing newline-delimited lists of dictionary - phrases. - outputPath: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' + If the next page is available then the next page token to be used in + the following ListStoredInfoTypes request. + type: string + storedInfoTypes: description: >- - Location to store dictionary artifacts in Cloud Storage. These files - will only be accessible by project owners and the DLP API. If any of - these artifacts are modified, the dictionary is considered invalid - and can no longer be used. - bigQueryField: + List of storedInfoTypes, up to page_size in + ListStoredInfoTypesRequest. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + type: object + id: GooglePrivacyDlpV2ListStoredInfoTypesResponse + description: Response message for ListStoredInfoTypes. + GooglePrivacyDlpV2CloudSqlDiscoveryTarget: + type: object + properties: + conditions: description: >- - Field in a BigQuery table where each cell represents a dictionary - phrase. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' + In addition to matching the filter, these conditions must be true + before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' + generationCadence: + description: >- + How often and when to update profiles. New tables that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + filter: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlFilter' + description: >- + Required. The tables the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a table. + disabled: + description: Disable profiling for database resources that match this filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget + description: Target used to match against for discovery with Cloud SQL tables. + GooglePrivacyDlpV2RedactConfig: + properties: {} type: object - id: GooglePrivacyDlpV2LargeCustomDictionaryConfig + id: GooglePrivacyDlpV2RedactConfig description: >- - Configuration for a custom dictionary created from a data source of any - size up to the maximum size defined in the - [limits](https://cloud.google.com/sensitive-data-protection/limits) - page. The artifacts of dictionary creation are stored in the specified - Cloud Storage location. Consider using `CustomInfoType.Dictionary` for - smaller dictionaries that satisfy the size requirements. - GooglePrivacyDlpV2RecordKey: - description: Message for a unique key indicating a record that contains a finding. - id: GooglePrivacyDlpV2RecordKey + Redact a given value. For example, if used with an + `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone + number is 206-555-0123', the output would be 'My phone number is '. + GooglePrivacyDlpV2KMapEstimationConfig: + id: GooglePrivacyDlpV2KMapEstimationConfig type: object + description: >- + Reidentifiability metric. This corresponds to a risk model similar to + what is called "journalist risk" in the literature, except the attack + dataset is statistically modeled instead of being perfectly known. This + can be done using publicly available data (like the US Census), or using + a custom statistical model (indicated as one or several BigQuery + tables), or by extrapolating from the distribution of values in the + input dataset. properties: - datastoreKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' - description: BigQuery key - idValues: + quasiIds: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' type: array + description: >- + Required. Fields considered to be quasi-identifiers. No two columns + can have the same tag. + regionCode: + type: string + description: >- + ISO 3166-1 alpha-2 region code to use in the statistical modeling. + Set if no column is tagged with a region-specific InfoType (like + US_ZIP_5) or a region code. + auxiliaryTables: + description: >- + Several auxiliary tables can be used in the analysis. Each + custom_tag used to tag a quasi-identifiers column must appear in + exactly one column of one auxiliary table. items: - type: string + $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' + type: array + GooglePrivacyDlpV2InspectResult: + id: GooglePrivacyDlpV2InspectResult + description: All the findings for a single scanned item. + type: object + properties: + findingsTruncated: description: >- - Values of identifying columns in the given row. Order of values - matches the order of `identifying_fields` specified in the scanning - request. - bigQueryKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' - description: Datastore key - GooglePrivacyDlpV2Deidentify: + If true, then this item might have more findings than were returned, + and the findings returned are an arbitrary subset of all findings. + The findings list might be truncated because the input items were + too large, or because the server reached the maximum amount of + resources allowed for a single API call. For best results, divide + the input into smaller batches. + type: boolean + findings: + type: array + description: List of findings for an item. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' + GooglePrivacyDlpV2ExcludeInfoTypes: + id: GooglePrivacyDlpV2ExcludeInfoTypes + type: object + description: List of excluded infoTypes. properties: - cloudStorageOutput: - type: string + infoTypes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + type: array description: >- - Required. User settable Cloud Storage bucket and folders to store - de-identified files. This field must be set for Cloud Storage - deidentification. The output Cloud Storage bucket must be different - from the input bucket. De-identified files will overwrite files in - the output path. Form of: gs://bucket/folder/ or gs://bucket - transformationConfig: + InfoType list in ExclusionRule rule drops a finding when it overlaps + or contained within with a finding of an infoType from this list. + For example, for `InspectionRuleSet.info_types` containing + "PHONE_NUMBER"` and `exclusion_rule` containing + `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone + number findings are dropped if they overlap with EMAIL_ADDRESS + finding. That leads to "555-222-2222@example.org" to generate only a + single finding, namely email address. + GooglePrivacyDlpV2ListColumnDataProfilesResponse: + properties: + nextPageToken: + description: The next page token. + type: string + columnDataProfiles: + type: array + description: List of data profiles. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + id: GooglePrivacyDlpV2ListColumnDataProfilesResponse + description: List of profiles generated for a given organization or project. + type: object + GooglePrivacyDlpV2DataSourceType: + properties: + dataSource: + readOnly: true + type: string description: >- - User specified deidentify templates and configs for structured, - unstructured, and image files. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' - transformationDetailsStorageConfig: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig + Output only. An identifying string to the type of resource being + profiled. Current values: * google/bigquery/table * google/project * + google/sql/table * google/gcs/bucket + id: GooglePrivacyDlpV2DataSourceType + description: Message used to identify the type of resource being profiled. + type: object + GooglePrivacyDlpV2EntityId: + type: object + description: >- + An entity in a dataset is a field or set of fields that correspond to a + single person. For example, in medical records the `EntityId` might be a + patient identifier, or for financial records it might be an account + identifier. This message is used when generalizations or analysis must + take into account that multiple rows correspond to the same entity. + id: GooglePrivacyDlpV2EntityId + properties: + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Composite key indicating which field contains the entity identifier. + GooglePrivacyDlpV2DatabaseResourceCollection: + description: >- + Match database resources using regex filters. Examples of database + resources are tables, views, and stored procedures. + type: object + id: GooglePrivacyDlpV2DatabaseResourceCollection + properties: + includeRegexes: description: >- - Config for storing transformation details. This is separate from the - de-identified content, and contains metadata about the successful - transformations and/or failures that occurred while de-identifying. - This needs to be set in order for users to access information about - the status of each transformation (see TransformationDetails message - for more information about what is noted). - fileTypesToTransform: + A collection of regular expressions to match a database resource + against. + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' + GooglePrivacyDlpV2CloudStorageOptions: + type: object + properties: + fileTypes: + type: array items: + enum: + - FILE_TYPE_UNSPECIFIED + - BINARY_FILE + - TEXT_FILE + - IMAGE + - WORD + - PDF + - AVRO + - CSV + - TSV + - POWERPOINT + - EXCEL enumDescriptions: - Includes all files. - >- @@ -1226,220 +1322,156 @@ components: binary files. Included file extensions: xlsx, xlsm, xltx, xltm. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on Excel files. - enum: - - FILE_TYPE_UNSPECIFIED - - BINARY_FILE - - TEXT_FILE - - IMAGE - - WORD - - PDF - - AVRO - - CSV - - TSV - - POWERPOINT - - EXCEL type: string description: >- - List of user-specified file type groups to transform. If specified, - only the files with these file types will be transformed. If empty, - all supported files will be transformed. Supported types may be - automatically added over time. If a file type is set in this field - that isn't supported by the Deidentify action then the job will fail - and will not be successfully created/started. Currently the only - file types supported are: IMAGES, TEXT_FILES, CSV, TSV. - type: array - type: object - description: >- - Create a de-identified copy of the requested table or files. A - TransformationDetail will be created for each transformation. If any - rows in BigQuery are skipped during de-identification (transformation - errors or row size exceeds BigQuery insert API limits) they are placed - in the failure output table. If the original row exceeds the BigQuery - insert API limit it will be truncated when written to the failure output - table. The failure output table can be set in the - action.deidentify.output.big_query_output.deidentified_failure_output_table - field, if no table is set, a table will be automatically created in the - same project and dataset as the original table. Compatible with: Inspect - id: GooglePrivacyDlpV2Deidentify - GooglePrivacyDlpV2InspectContentRequest: - type: object - description: Request to search for potentially sensitive info in a ContentItem. - properties: - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The item to inspect. - inspectTemplateName: - description: >- - Template to use. Any configuration directly specified in - inspect_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - type: string - locationId: - description: Deprecated. This field has no effect. + List of file type groups to include in the scan. If empty, all files + are scanned and available data format processors are applied. In + addition, the binary content of the selected files is always scanned + as well. Images are scanned only as binary if the specified region + does not support image inspection and no file_types were specified. + Image inspection is restricted to 'global', 'us', 'asia', and + 'europe'. + bytesLimitPerFile: type: string - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' description: >- - Configuration for the inspector. What specified here will override - the template referenced by the inspect_template_name argument. - id: GooglePrivacyDlpV2InspectContentRequest - GooglePrivacyDlpV2BigQueryTable: - description: >- - Message defining the location of a BigQuery table. A table is uniquely - identified by its project_id, dataset_id, and table_name. Within a query - a table is often referenced with a string in the format of: `:.` or - `..`. - id: GooglePrivacyDlpV2BigQueryTable - properties: - tableId: + Max number of bytes to scan from a file. If a scanned file's size is + bigger than this value then the rest of the bytes are omitted. Only + one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can + be specified. This field can't be set if de-identification is + requested. For certain file types, setting this field has no effect. + For more information, see [Limits on bytes scanned per + file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + format: int64 + filesLimitPercent: + description: >- + Limits the number of files to scan to this percentage of the input + FileSet. Number of files scanned is rounded down. Must be between 0 + and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. + type: integer + format: int32 + bytesLimitPerFilePercent: + format: int32 + type: integer + description: >- + Max percentage of bytes to scan from a file. The rest are omitted. + The number of bytes scanned is rounded down. Must be between 0 and + 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only + one of bytes_limit_per_file and bytes_limit_per_file_percent can be + specified. This field can't be set if de-identification is + requested. For certain file types, setting this field has no effect. + For more information, see [Limits on bytes scanned per + file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + fileSet: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' + description: The set of one or more files to scan. + sampleMethod: type: string - description: Name of the table. - datasetId: - description: Dataset ID of the table. + enumDescriptions: + - No sampling. + - Scan from the top (default). + - >- + For each file larger than bytes_limit_per_file, randomly pick the + offset to start scanning. The scanned bytes are contiguous. + enum: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START + description: How to sample the data. + description: Options defining a file or a set of files within a Cloud Storage bucket. + id: GooglePrivacyDlpV2CloudStorageOptions + GooglePrivacyDlpV2CloudStorageRegex: + id: GooglePrivacyDlpV2CloudStorageRegex + properties: + projectIdRegex: + description: Optional. For organizations, if unset, will match all projects. type: string - projectId: + bucketNameRegex: type: string description: >- - The Google Cloud Platform project ID of the project containing the - table. If omitted, project ID is inferred from the API call. - type: object - GooglePrivacyDlpV2StorageMetadataLabel: + Optional. Regex to test the bucket name against. If empty, all + buckets match. Example: "marketing2021" or "(marketing)\d{4}" will + both match the bucket gs://marketing2021 description: >- - Storage metadata label to indicate which metadata entry contains - findings. + A pattern to match against one or more file stores. At least one pattern + must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + type: object + GooglePrivacyDlpV2UnwrappedCryptoKey: type: object + id: GooglePrivacyDlpV2UnwrappedCryptoKey + description: >- + Using raw keys is prone to security risks due to accidentally leaking + the key. Choose another type of key if possible. properties: key: - description: Label name. + description: Required. A 128/192/256 bit key. type: string - id: GooglePrivacyDlpV2StorageMetadataLabel - GooglePrivacyDlpV2CreateInspectTemplateRequest: + format: byte + GooglePrivacyDlpV2CustomInfoType: properties: - locationId: - description: Deprecated. This field has no effect. + exclusionType: type: string - inspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - description: Required. The InspectTemplate to create. - templateId: description: >- - The template id can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: string - id: GooglePrivacyDlpV2CreateInspectTemplateRequest - description: Request message for CreateInspectTemplate. - type: object - GooglePrivacyDlpV2StoredInfoTypeConfig: - id: GooglePrivacyDlpV2StoredInfoTypeConfig - description: >- - Configuration for stored infoTypes. All fields and subfield are provided - by the user. For more information, see - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. - type: object - properties: - description: - type: string - description: Description of the StoredInfoType (max 256 characters). + If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a + finding to be returned. It still can be used for rules matching. + enumDescriptions: + - >- + A finding of this custom info type will not be excluded from + results. + - >- + A finding of this custom info type will be excluded from final + results, but can still affect rule execution. + enum: + - EXCLUSION_TYPE_UNSPECIFIED + - EXCLUSION_TYPE_EXCLUDE + storedType: + description: >- + Load an existing `StoredInfoType` resource for use in + `InspectDataSource`. Not currently supported in `InspectContent`. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' + sensitivityScore: + description: >- + Sensitivity for this CustomInfoType. If this CustomInfoType extends + an existing InfoType, the sensitivity here will take precedence over + that of the original InfoType. If unset for a CustomInfoType, it + will default to HIGH. This only applies to data profiling. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + surrogateType: + description: >- + Message for detecting output from deidentification transformations + that support reversing. + $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + CustomInfoType can either be a new infoType, or an extension of + built-in infoType, when the name matches one of existing infoTypes + and that infoType is specified in `InspectContent.info_types` field. + Specifying the latter adds findings to the one detected by the + system. If built-in info type is not specified in + `InspectContent.info_types` list then the name is treated as a + custom info type. regex: $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Store regular expression-based StoredInfoType. - displayName: - type: string - description: Display name of the StoredInfoType (max 256 characters). - largeCustomDictionary: + description: Regular expression based CustomInfoType. + detectionRules: description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' + Set of detection rules to apply to all findings of this + CustomInfoType. Rules are applied in order that they are specified. + Not supported for the `surrogate_type` CustomInfoType. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' dictionary: - description: Store dictionary-based CustomInfoType. + description: A list of phrases to detect as a CustomInfoType. $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - GooglePrivacyDlpV2DiscoveryCloudStorageConditions: - properties: - includedBucketAttributes: + likelihood: description: >- - Required. Only objects with the specified attributes will be - scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. - type: array - items: - enumDescriptions: - - Unused. - - Scan buckets regardless of the attribute. - - >- - Buckets with autoclass disabled - (https://cloud.google.com/storage/docs/autoclass). Only one of - AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. - - >- - Buckets with autoclass enabled - (https://cloud.google.com/storage/docs/autoclass). Only one of - AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning - Autoclass-enabled buckets can affect object storage classes. - type: string - enum: - - CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED - - ALL_SUPPORTED_BUCKETS - - AUTOCLASS_DISABLED - - AUTOCLASS_ENABLED - includedObjectAttributes: - description: >- - Required. Only objects with the specified attributes will be - scanned. If an object has one of the specified attributes but is - inside an excluded bucket, it will not be scanned. Defaults to - [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no - objects match the included_object_attributes. - items: - enumDescriptions: - - Unused. - - Scan objects regardless of the attribute. - - Scan objects with the standard storage class. - - >- - Scan objects with the nearline storage class. This will incur - retrieval fees. - - >- - Scan objects with the coldline storage class. This will incur - retrieval fees. - - >- - Scan objects with the archive storage class. This will incur - retrieval fees. - - Scan objects with the regional storage class. - - Scan objects with the multi-regional storage class. - - >- - Scan objects with the dual-regional storage class. This will - incur retrieval fees. - enum: - - CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED - - ALL_SUPPORTED_OBJECTS - - STANDARD - - NEARLINE - - COLDLINE - - ARCHIVE - - REGIONAL - - MULTI_REGIONAL - - DURABLE_REDUCED_AVAILABILITY - type: string - type: array - type: object - description: >- - Requirements that must be true before a Cloud Storage bucket or object - is scanned in discovery for the first time. There is an AND relationship - between the top-level attributes. - id: GooglePrivacyDlpV2DiscoveryCloudStorageConditions - GooglePrivacyDlpV2Finding: - description: Represents a piece of potentially sensitive content. - properties: - findingId: + Likelihood to return for this CustomInfoType. This base value can be + altered by a detection rule if the finding meets the criteria + specified by the rule. Defaults to `VERY_LIKELY` if not specified. type: string - description: The unique finding id. - infoType: - description: >- - The type of content that might have been found. Provided if - `excluded_types` is false. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - likelihood: enum: - LIKELIHOOD_UNSPECIFIED - VERY_UNLIKELY @@ -1447,8 +1479,6 @@ components: - POSSIBLE - LIKELY - VERY_LIKELY - type: string - description: Confidence of how likely it is that the `info_type` is correct. enumDescriptions: - Default value; same as POSSIBLE. - Highest chance of a false positive. @@ -1456,1100 +1486,927 @@ components: - Some matching signals. The default value. - Low chance of a false positive. - Confidence level is high. Lowest chance of a false positive. - location: - description: Where the content was found. - $ref: '#/components/schemas/GooglePrivacyDlpV2Location' - jobCreateTime: - description: Time the job started that produced this finding. - type: string - format: google-datetime - jobName: - type: string - description: The job that stored the finding. - quoteInfo: - description: >- - Contains data parsed from quotes. Only populated if include_quote - was set to true and a supported infoType was requested. Currently - supported infoTypes: DATE, DATE_OF_BIRTH and TIME. - $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' - name: + id: GooglePrivacyDlpV2CustomInfoType + type: object + description: >- + Custom information type provided by the user. Used to find + domain-specific sensitive information configurable to the data in + question. + GooglePrivacyDlpV2LDiversityEquivalenceClass: + description: The set of columns' values that share the same ldiversity value. + properties: + quasiIdsValues: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: >- - Resource name in format - projects/{project}/locations/{location}/findings/{finding} Populated - only when viewing persisted findings. + Quasi-identifier values defining the k-anonymity equivalence class. + The order is always the same as the original request. + type: array + equivalenceClassSize: + description: Size of the k-anonymity equivalence class. type: string - triggerName: - description: Job trigger name, if applicable, for this finding. + format: int64 + numDistinctSensitiveValues: type: string - createTime: + description: Number of distinct sensitive values in this equivalence class. + format: int64 + topSensitiveValues: + description: Estimated frequencies of top sensitive values. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + type: array + type: object + id: GooglePrivacyDlpV2LDiversityEquivalenceClass + GooglePrivacyDlpV2BoundingBox: + properties: + top: + format: int32 + description: Top coordinate of the bounding box. (0,0) is upper left. + type: integer + left: + description: Left coordinate of the bounding box. (0,0) is upper left. + type: integer + format: int32 + height: + type: integer + description: Height of the bounding box in pixels. + format: int32 + width: + format: int32 + type: integer + description: Width of the bounding box in pixels. + id: GooglePrivacyDlpV2BoundingBox + type: object + description: Bounding box encompassing detected text within an image. + GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: + description: >- + A DeltaPresenceEstimationHistogramBucket message with the following + values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means + that there are 42 records for which δ is in [0.1, 0.2). An important + particular case is when min_probability = max_probability = 1: then, + every individual who shares this quasi-identifier combination is in the + dataset. + type: object + properties: + maxProbability: + type: number + description: Always greater than or equal to min_probability. + format: double + bucketSize: + format: int64 type: string - description: Timestamp when finding was detected. - format: google-datetime - resourceName: - description: The job that stored the finding. + description: Number of records within these probability bounds. + bucketValueCount: + description: >- + Total number of distinct quasi-identifier tuple values in this + bucket. + format: int64 type: string - labels: - type: object - additionalProperties: - type: string + minProbability: + format: double + description: Between 0 and 1. + type: number + bucketValues: + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues description: >- - The labels associated with this `Finding`. Label keys must be - between 1 and 63 characters long and must conform to the following - regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must - be between 0 and 63 characters long and must conform to the regular - expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels - can be associated with a given finding. Examples: * `"environment" : - "production"` * `"pipeline" : "etl"` - quote: + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. + type: array + id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + GooglePrivacyDlpV2CloudStoragePath: + type: object + description: Message representing a single file or path in Cloud Storage. + id: GooglePrivacyDlpV2CloudStoragePath + properties: + path: type: string description: >- - The content that was found. Even if the content is not textual, it - may be converted to a textual representation here. Provided if - `include_quote` is true and the finding is less than or equal to - 4096 bytes long. If the finding exceeds 4096 bytes in length, the - quote may be omitted. + A URL representing a file or path (no wildcards) in Cloud Storage. + Example: `gs://[BUCKET_NAME]/dictionary.txt` + GooglePrivacyDlpV2InspectDataSourceDetails: type: object - id: GooglePrivacyDlpV2Finding - GooglePrivacyDlpV2DiscoveryConfig: + description: The results of an inspect DataSource job. + properties: + requestedOptions: + description: The configuration used for this job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' + result: + description: A summary of the outcome of this inspection job. + $ref: '#/components/schemas/GooglePrivacyDlpV2Result' + id: GooglePrivacyDlpV2InspectDataSourceDetails + GooglePrivacyDlpV2RecordKey: + description: Message for a unique key indicating a record that contains a finding. type: object - description: >- - Configuration for discovery to scan resources for profile generation. - Only one discovery configuration may exist per organization, folder, or - project. The generated data profiles are retained according to the [data - retention policy] - (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). - id: GooglePrivacyDlpV2DiscoveryConfig + properties: + idValues: + description: >- + Values of identifying columns in the given row. Order of values + matches the order of `identifying_fields` specified in the scanning + request. + type: array + items: + type: string + bigQueryKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' + description: Datastore key + datastoreKey: + description: BigQuery key + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' + id: GooglePrivacyDlpV2RecordKey + GooglePrivacyDlpV2InspectTemplate: properties: updateTime: readOnly: true - type: string - description: Output only. The last update timestamp of a DiscoveryConfig. format: google-datetime - targets: + description: Output only. The last update timestamp of an inspectTemplate. + type: string + inspectConfig: description: >- - Target to match against for determining what to scan and how - frequently. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' - type: array + The core content of the template. Configuration of the scanning + process. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + displayName: + description: Display name (max 256 chars). + type: string name: description: >- - Unique resource name for the DiscoveryConfig, assigned by the - service when the DiscoveryConfig is created, for example - `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + Output only. The template name. The template will have one of the + following formats: + `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR + `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; + readOnly: true type: string - orgConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' - description: Only set when the parent is an org. - status: - description: Required. A status for this configuration. + description: type: string - enum: - - STATUS_UNSPECIFIED - - RUNNING - - PAUSED - enumDescriptions: - - Unused - - The discovery config is currently active. - - The discovery config is paused temporarily. + description: Short description (max 256 chars). createTime: - format: google-datetime - description: Output only. The creation timestamp of a DiscoveryConfig. - type: string - readOnly: true - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - readOnly: true - description: >- - Output only. A stream of errors encountered when the config was - activated. Repeated errors may result in the config automatically - being paused. Output only field. Will return the last 100 errors. - Whenever the config is modified this list will be cleared. - type: array - actions: - description: Actions to execute at the completion of scanning. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - lastRunTime: - format: google-datetime readOnly: true - description: >- - Output only. The timestamp of the last time this config was - executed. - type: string - displayName: + description: Output only. The creation timestamp of an inspectTemplate. type: string - description: Display name (max 100 chars) - inspectTemplates: - items: - type: string - description: >- - Detection logic for profile generation. Not all template features - are used by Discovery. FindingLimits, include_quote and - exclude_info_types have no impact on Discovery. Multiple templates - may be provided if there is data in multiple regions. At most one - template must be specified per-region (including "global"). Each - region is scanned using the applicable template. If no - region-specific template is specified, but a "global" template is - specified, it will be copied to that region and used instead. If no - global or region-specific template is provided for a region with - data, that region's data will not be scanned. For more information, - see - https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. - type: array - GooglePrivacyDlpV2LDiversityConfig: - id: GooglePrivacyDlpV2LDiversityConfig - description: l-diversity metric, used for analysis of reidentification risk. + format: google-datetime + description: >- + The inspectTemplate contains a configuration (set of types of sensitive + data to be detected) to be used anywhere you otherwise would normally + specify InspectConfig. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates + to learn more. + id: GooglePrivacyDlpV2InspectTemplate type: object - properties: - quasiIds: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Set of quasi-identifiers indicating how equivalence classes are - defined for the l-diversity computation. When multiple fields are - specified, they are considered a single composite key. - type: array - sensitiveAttribute: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Sensitive field for computing the l-value. - GooglePrivacyDlpV2ExcludeByHotword: - id: GooglePrivacyDlpV2ExcludeByHotword + GooglePrivacyDlpV2Result: type: object + id: GooglePrivacyDlpV2Result properties: - proximity: - $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' + processedBytes: + type: string + format: int64 + description: Total size in bytes that were processed. + numRowsProcessed: description: >- - Range of characters within which the entire hotword must reside. The - total length of the window cannot exceed 1000 characters. The - windowBefore property in proximity should be set to 1 if the hotword - needs to be included in a column header. - hotwordRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression pattern defining what qualifies as a hotword. - description: >- - The rule to exclude findings based on a hotword. For record inspection - of tables, column names are considered hotwords. An example of this is - to exclude a finding if it belongs to a BigQuery column that matches a - specific pattern. - GooglePrivacyDlpV2CloudStorageFileSet: - id: GooglePrivacyDlpV2CloudStorageFileSet - type: object - properties: - url: + Number of rows scanned after sampling and time filtering (applicable + for row based stores such as BigQuery). type: string + format: int64 + hybridStats: + description: Statistics related to the processing of hybrid inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' + infoTypeStats: + type: array description: >- - The url, in the format `gs:///`. Trailing wildcard in the path is - allowed. - description: Message representing a set of files in Cloud Storage. - GooglePrivacyDlpV2DatabaseResourceRegex: + Statistics of how many instances of each info type were found during + inspect job. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' + totalEstimatedBytes: + type: string + description: Estimate of the number of bytes to process. + format: int64 + description: >- + All result fields mentioned below are updated while the job is + processing. + GooglePrivacyDlpV2ImageRedactionConfig: type: object properties: - instanceRegex: + redactAllText: + type: boolean description: >- - Regex to test the instance name against. If empty, all instances - match. - type: string - projectIdRegex: + If true, all text found in the image, regardless whether it matches + an info_type, is redacted. Only one should be provided. + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - For organizations, if unset, will match all projects. Has no effect - for configurations created within a project. - type: string - databaseRegex: + Only one per info_type should be provided per request. If not + specified, and redact_all_text is false, the DLP API will redact all + text that it matches against all info_types that are found, but not + specified in another ImageRedactionConfig. + redactionColor: description: >- - Regex to test the database name against. If empty, all databases - match. + The color to use when redacting content from an image. If not + specified, the default is black. + $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + description: Configuration for determining how redaction of images should occur. + id: GooglePrivacyDlpV2ImageRedactionConfig + GooglePrivacyDlpV2DataProfileConfigSnapshot: + type: object + id: GooglePrivacyDlpV2DataProfileConfigSnapshot + properties: + inspectTemplateModifiedTime: + format: google-datetime + description: Timestamp when the template was modified type: string - databaseResourceNameRegex: + inspectTemplateName: type: string + description: Name of the inspection template used to generate this profile + dataProfileJob: + deprecated: true description: >- - Regex to test the database resource's name against. An example of a - database resource name is a table's name. Other database resource - names like view names could be included in the future. If empty, all - database resources match. - description: >- - A pattern to match against one or more database resources. At least one - pattern must be specified. Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - id: GooglePrivacyDlpV2DatabaseResourceRegex - GooglePrivacyDlpV2QuasiIdentifierField: - description: >- - A quasi-identifier column has a custom_tag, used to know which column in - the data corresponds to which column in the statistical model. - properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Identifies the column. - customTag: - type: string + A copy of the configuration used to generate this profile. This is + deprecated, and the DiscoveryConfig field is preferred moving + forward. DataProfileJobConfig will still be written here for + Discovery in BigQuery for backwards compatibility, but will not be + updated with new fields, while DiscoveryConfig will. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' + discoveryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: A copy of the configuration used to generate this profile. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). + A copy of the inspection config used to generate this profile. This + is a copy of the inspect_template specified in + `DataProfileJobConfig`. + description: Snapshot of the configurations used to generate the profile. + GooglePrivacyDlpV2AllText: + id: GooglePrivacyDlpV2AllText + description: Apply to all text. + properties: {} type: object - id: GooglePrivacyDlpV2QuasiIdentifierField - GooglePrivacyDlpV2RecordLocation: + GooglePrivacyDlpV2ListFileStoreDataProfilesResponse: + description: >- + List of file store data profiles generated for a given organization or + project. type: object - id: GooglePrivacyDlpV2RecordLocation - description: Location of a finding within a row or record. - properties: - recordKey: - description: Key of the finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' - fieldId: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Field id of the field containing the finding. - tableLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' - description: Location within a `ContentItem.Table`. - GooglePrivacyDlpV2ListDlpJobsResponse: - description: The response message for listing DLP jobs. properties: nextPageToken: - description: The standard List next-page token. + description: The next page token. type: string - jobs: + fileStoreDataProfiles: type: array - description: A list of DlpJobs that matches the specified filter in the request. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' - id: GooglePrivacyDlpV2ListDlpJobsResponse - type: object - GooglePrivacyDlpV2LDiversityEquivalenceClass: - type: object - properties: - quasiIdsValues: + description: List of data profiles. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: >- - Quasi-identifier values defining the k-anonymity equivalence class. - The order is always the same as the original request. - type: array - topSensitiveValues: - type: array - description: Estimated frequencies of top sensitive values. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' - equivalenceClassSize: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + id: GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + GooglePrivacyDlpV2CategoricalStatsHistogramBucket: + id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket + properties: + valueFrequencyUpperBound: + type: string + description: Upper bound on the value frequency of the values in this bucket. format: int64 - description: Size of the k-anonymity equivalence class. + bucketValueCount: type: string - numDistinctSensitiveValues: + description: Total number of distinct values in this bucket. format: int64 - description: Number of distinct sensitive values in this equivalence class. + bucketSize: type: string - id: GooglePrivacyDlpV2LDiversityEquivalenceClass - description: The set of columns' values that share the same ldiversity value. - GooglePrivacyDlpV2LDiversityResult: - id: GooglePrivacyDlpV2LDiversityResult - type: object - properties: - sensitiveValueFrequencyHistogramBuckets: + description: Total number of values in this bucket. + format: int64 + bucketValues: description: >- - Histogram of l-diversity equivalence class sensitive value - frequencies. - type: array + Sample of value frequencies in this bucket. The total number of + values returned per bucket is capped at 20. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' - description: Result of the l-diversity computation. - GooglePrivacyDlpV2DataProfilePubSubMessage: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + type: array + valueFrequencyLowerBound: + description: Lower bound on the value frequency of the values in this bucket. + type: string + format: int64 + description: Histogram of value frequencies in the column. + type: object + GooglePrivacyDlpV2PublishToSecurityCommandCenter: + properties: {} + type: object + id: GooglePrivacyDlpV2PublishToSecurityCommandCenter description: >- - Pub/Sub topic message for a DataProfileAction.PubSubNotification event. - To receive a message of protocol buffer schema type, convert the message - data to an object of this proto class. + If set, a summary finding will be created/updated in SCC for each + profile. + GooglePrivacyDlpV2BigQueryDiscoveryTarget: + description: Target used to match against for discovery with BigQuery tables + type: object properties: - event: - description: The event that caused the Pub/Sub message to be sent. - enum: - - EVENT_TYPE_UNSPECIFIED - - NEW_PROFILE - - CHANGED_PROFILE - - SCORE_INCREASED - - ERROR_CHANGED - enumDescriptions: - - Unused. - - New profile (not a re-profile). - - >- - One of the following profile metrics changed: Data risk score, - Sensitivity score, Resource visibility, Encryption type, Predicted - infoTypes, Other infoTypes - - Table data risk score or sensitivity score increased. - - A user (non-internal) error occurred. - type: string - fileStoreProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + filter: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' description: >- - If `DetailLevel` is `FILE_STORE_PROFILE` this will be fully - populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only - `name` and `file_store_path` will be populated. - profile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + Required. The tables the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a table. + disabled: + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + description: Tables that match this filter will not have profiles created. + cadence: description: >- - If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. - Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and - `full_resource` will be populated. - type: object - id: GooglePrivacyDlpV2DataProfilePubSubMessage - GooglePrivacyDlpV2SecretManagerCredential: - properties: - username: - type: string - description: Required. The username. - passwordSecretVersionName: + How often and when to update profiles. New tables that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryGenerationCadence' + conditions: description: >- - Required. The name of the Secret Manager resource that stores the - password, in the form - `projects/project-id/secrets/secret-name/versions/version`. - type: string + In addition to matching the filter, these conditions must be true + before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' + id: GooglePrivacyDlpV2BigQueryDiscoveryTarget + GooglePrivacyDlpV2InfoTypeLikelihood: + id: GooglePrivacyDlpV2InfoTypeLikelihood description: >- - A credential consisting of a username and password, where the password - is stored in a Secret Manager resource. Note: Secret Manager [charges - apply](https://cloud.google.com/secret-manager/pricing). - type: object - id: GooglePrivacyDlpV2SecretManagerCredential - GooglePrivacyDlpV2DlpJob: - description: Combines all of the information about a DLP job. + Configuration for setting a minimum likelihood per infotype. Used to + customize the minimum likelihood level for specific infotypes in the + request. For example, use this if you want to lower the precision for + PERSON_NAME without lowering the precision for the other infotypes in + the request. type: object properties: - lastModified: - type: string - description: Time when the job was last modified by the system. - format: google-datetime - riskDetails: - description: Results from analyzing risk of a data source. - $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' - inspectDetails: - description: Results from inspecting a data source. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' - name: - type: string - description: The server-assigned name. - jobTriggerName: - type: string + minLikelihood: + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. description: >- - If created by a job trigger, the resource name of the trigger that - instantiated the job. - createTime: - format: google-datetime - type: string - description: Time when the job was created. - errors: - description: A stream of errors encountered running the job. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - startTime: - format: google-datetime - description: Time when the job started. - type: string - endTime: + Only returns findings equal to or above this threshold. This field + is required or else the configuration fails. + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY type: string - format: google-datetime - description: Time when the job finished. - actionDetails: + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + Type of information the likelihood threshold applies to. Only one + likelihood per info_type should be provided. If InfoTypeLikelihood + does not have an info_type, the configuration fails. + GooglePrivacyDlpV2CategoricalStatsResult: + properties: + valueFrequencyHistogramBuckets: + description: Histogram of value frequencies in the column. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' - description: Events that should occur after the job has completed. - type: - type: string - enumDescriptions: - - Defaults to INSPECT_JOB. - - The job inspected Google Cloud for sensitive data. - - The job executed a Risk Analysis computation. - description: The type of job. - enum: - - DLP_JOB_TYPE_UNSPECIFIED - - INSPECT_JOB - - RISK_ANALYSIS_JOB - state: - enum: - - JOB_STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - - CANCELED - - FAILED - - ACTIVE - enumDescriptions: - - Unused. - - The job has not yet started. - - >- - The job is currently running. Once a job has finished it will - transition to FAILED or DONE. - - The job is no longer running. - - The job was canceled before it could be completed. - - The job had an error and did not complete. - - >- - The job is currently accepting findings via hybridInspect. A - hybrid job in ACTIVE state may continue to have findings added to - it through the calling of hybridInspect. After the job has - finished no more calls to hybridInspect may be made. ACTIVE jobs - can transition to DONE. - description: State of a job. - type: string - id: GooglePrivacyDlpV2DlpJob - GooglePrivacyDlpV2TimespanConfig: - id: GooglePrivacyDlpV2TimespanConfig - description: >- - Configuration of the timespan of the items to include in scanning. - Currently only supported when inspecting Cloud Storage and BigQuery. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket type: object + description: Result of the categorical stats computation. + id: GooglePrivacyDlpV2CategoricalStatsResult + GooglePrivacyDlpV2RequestedRiskAnalysisOptions: properties: - enableAutoPopulationOfTimespanConfig: - type: boolean - description: >- - When the job is started by a JobTrigger we will automatically figure - out a valid start_time to avoid scanning files that have not been - modified since the last time the JobTrigger executed. This will be - based on the time of the execution of the last run of the JobTrigger - or the timespan end_time used in the last run of the JobTrigger. - **For BigQuery** Inspect jobs triggered by automatic population will - scan data that is at least three hours old when the job starts. This - is because streaming buffer rows are not read during inspection and - reading up to the current timestamp will result in skipped rows. See - the [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) - related to this operation. - timestampField: - description: >- - Specification of the field containing the timestamp of scanned - items. Used for data sources like Datastore and BigQuery. **For - BigQuery** If this value is not specified and the table was modified - between the given start and end times, the entire table will be - scanned. If this value is specified, then rows are filtered based on - the given start and end times. Rows with a `NULL` value in the - provided BigQuery column are skipped. Valid data types of the - provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and - `DATETIME`. If your BigQuery table is [partitioned at ingestion - time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), - you can use any of the following pseudo-columns as your timestamp - field. When used with Cloud DLP, these pseudo-column names are case - sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, - then entities are filtered based on the given start and end times. - If an entity does not contain the provided timestamp property or - contains empty or invalid values, then it is included. Valid data - types of the provided timestamp property are: `TIMESTAMP`. See the - [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) - related to this operation. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - endTime: + jobConfig: + description: The job config for the risk job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + description: Risk analysis options. + type: object + id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions + GooglePrivacyDlpV2DiscoveryCloudStorageConditions: + description: >- + Requirements that must be true before a Cloud Storage bucket or object + is scanned in discovery for the first time. There is an AND relationship + between the top-level attributes. + properties: + includedBucketAttributes: + items: + enumDescriptions: + - Unused. + - Scan buckets regardless of the attribute. + - >- + Buckets with autoclass disabled + (https://cloud.google.com/storage/docs/autoclass). Only one of + AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. + - >- + Buckets with autoclass enabled + (https://cloud.google.com/storage/docs/autoclass). Only one of + AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning + Autoclass-enabled buckets can affect object storage classes. + enum: + - CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED + - ALL_SUPPORTED_BUCKETS + - AUTOCLASS_DISABLED + - AUTOCLASS_ENABLED + type: string description: >- - Exclude files, tables, or rows newer than this value. If not set, no - upper time limit is applied. - format: google-datetime - type: string - startTime: - format: google-datetime - type: string + Required. Only objects with the specified attributes will be + scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. + type: array + includedObjectAttributes: + items: + type: string + enum: + - CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED + - ALL_SUPPORTED_OBJECTS + - STANDARD + - NEARLINE + - COLDLINE + - ARCHIVE + - REGIONAL + - MULTI_REGIONAL + - DURABLE_REDUCED_AVAILABILITY + enumDescriptions: + - Unused. + - Scan objects regardless of the attribute. + - Scan objects with the standard storage class. + - >- + Scan objects with the nearline storage class. This will incur + retrieval fees. + - >- + Scan objects with the coldline storage class. This will incur + retrieval fees. + - >- + Scan objects with the archive storage class. This will incur + retrieval fees. + - Scan objects with the regional storage class. + - Scan objects with the multi-regional storage class. + - >- + Scan objects with the dual-regional storage class. This will + incur retrieval fees. description: >- - Exclude files, tables, or rows older than this value. If not set, no - lower time limit is applied. - GooglePrivacyDlpV2CreateJobTriggerRequest: + Required. Only objects with the specified attributes will be + scanned. If an object has one of the specified attributes but is + inside an excluded bucket, it will not be scanned. Defaults to + [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no + objects match the included_object_attributes. + type: array + id: GooglePrivacyDlpV2DiscoveryCloudStorageConditions type: object - description: Request message for CreateJobTrigger. + GooglePrivacyDlpV2DatabaseResourceRegex: properties: - jobTrigger: - description: Required. The JobTrigger to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - locationId: + databaseRegex: type: string - description: Deprecated. This field has no effect. - triggerId: description: >- - The trigger id can contain uppercase and lowercase letters, numbers, - and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: string - id: GooglePrivacyDlpV2CreateJobTriggerRequest - GooglePrivacyDlpV2CharacterMaskConfig: - id: GooglePrivacyDlpV2CharacterMaskConfig - properties: - maskingCharacter: + Regex to test the database name against. If empty, all databases + match. + instanceRegex: type: string description: >- - Character to use to mask the sensitive values—for example, `*` for - an alphabetic string such as a name, or `0` for a numeric string - such as ZIP code or credit card number. This string must have a - length of 1. If not supplied, this value defaults to `*` for - strings, and `0` for digits. - numberToMask: - description: >- - Number of characters to mask. If not set, all matching chars will be - masked. Skipped characters do not count towards this tally. If - `number_to_mask` is negative, this denotes inverse masking. Cloud - DLP masks all but a number of characters. For example, suppose you - have the following values: - `masking_character` is `*` - - `number_to_mask` is `-4` - `reverse_order` is `false` - - `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` - The resulting de-identified string is `****-****-****-3456`. Cloud - DLP masks all but the last four characters. If `reverse_order` is - `true`, all but the first four characters are masked as - `1234-****-****-****`. - type: integer - format: int32 - charactersToIgnore: + Regex to test the instance name against. If empty, all instances + match. + projectIdRegex: description: >- - When masking a string, items in this list will be skipped when - replacing characters. For example, if the input string is - `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 - characters with `*`, Cloud DLP returns `***-**5-5555`. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' - reverseOrder: - type: boolean + For organizations, if unset, will match all projects. Has no effect + for configurations created within a project. + type: string + databaseResourceNameRegex: + type: string description: >- - Mask characters in reverse order. For example, if - `masking_character` is `0`, `number_to_mask` is `14`, and - `reverse_order` is `false`, then the input string - `1234-5678-9012-3456` is masked as `00000000000000-3456`. If - `masking_character` is `*`, `number_to_mask` is `3`, and - `reverse_order` is `true`, then the string `12345` is masked as - `12***`. - type: object + Regex to test the database resource's name against. An example of a + database resource name is a table's name. Other database resource + names like view names could be included in the future. If empty, all + database resources match. description: >- - Partially mask a string by replacing a given number of characters with a - fixed character. Masking can start from the beginning or end of the - string. This can be used on data of any type (numbers, longs, and so on) - and when de-identifying structured data we'll attempt to preserve the - original data's type. (This allows you to take a long like 123 and - modify it to a string like **3. - GooglePrivacyDlpV2DiscoveryStartingLocation: + A pattern to match against one or more database resources. At least one + pattern must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + id: GooglePrivacyDlpV2DatabaseResourceRegex type: object - id: GooglePrivacyDlpV2DiscoveryStartingLocation + GooglePrivacyDlpV2TagValue: + description: A value of a tag. properties: - folderId: - description: The ID of the folder within an organization to be scanned. - type: string - format: int64 - organizationId: - description: The ID of an organization to scan. + namespacedValue: + description: >- + The namespaced name for the tag value to attach to resources. Must + be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, + for example, "123456/environment/prod". type: string - format: int64 - description: >- - The location to begin a discovery scan. Denotes an organization ID or - folder ID within an organization. - GooglePrivacyDlpV2CryptoDeterministicConfig: - id: GooglePrivacyDlpV2CryptoDeterministicConfig + id: GooglePrivacyDlpV2TagValue + type: object + GooglePrivacyDlpV2StoredInfoType: type: object description: >- - Pseudonymization method that generates deterministic encryption for the - given input. Outputs a base64 encoded representation of the encrypted - output. Uses AES-SIV based on the RFC - https://tools.ietf.org/html/rfc5297. + StoredInfoType resource message that contains information about the + current version and any pending updates. + id: GooglePrivacyDlpV2StoredInfoType properties: - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + name: + type: string + description: Resource name. + currentVersion: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + description: Current version of the stored info type. + pendingVersions: + type: array description: >- - The key used by the encryption function. For deterministic - encryption using AES-SIV, the provided key is internally expanded to - 64 bytes prior to use. - context: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + Pending versions of the stored info type. Empty if no versions are + pending. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + GooglePrivacyDlpV2CloudStorageResourceReference: + id: GooglePrivacyDlpV2CloudStorageResourceReference + type: object + properties: + projectId: description: >- - A context may be used for higher security and maintaining - referential integrity such that the same identifier in two different - contexts will be given a distinct surrogate. The context is appended - to plaintext value being encrypted. On decryption the provided - context is validated against the value used during encryption. If a - context was provided during encryption, same context must be - provided during decryption as well. If the context is not set, - plaintext would be used as is for encryption. If the context is set - but: 1. there is no record present when transforming a given value - or 2. the field is not present when transforming a given value, - plaintext would be used as is for encryption. Note that case (1) is - expected when an `InfoTypeTransformation` is applied to both - structured and unstructured `ContentItem`s. - surrogateInfoType: - description: >- - The custom info type to annotate the surrogate with. This annotation - will be applied to the surrogate by prefixing it with the name of - the custom info type followed by the number of characters comprising - the surrogate. The following scheme defines the format: {info type - name}({surrogate character count}):{surrogate} For example, if the - name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate - is 'abc', the full replacement value will be: - 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate - when inspecting content using the custom info type 'Surrogate'. This - facilitates reversal of the surrogate when it occurs in free text. - Note: For record transformations where the entire cell in a table is - being transformed, surrogates are not mandatory. Surrogates are used - to denote the location of the token and are necessary for - re-identification in free form text. In order for inspection to work - properly, the name of this info type must not occur naturally - anywhere in your data; otherwise, inspection may either - reverse a - surrogate that does not correspond to an actual identifier - be - unable to parse the surrogate and result in an error Therefore, - choose your custom info type name carefully after considering what - your data looks like. One way to select a name that has a high - chance of yielding reliable detection is to include one or more - unicode characters that are highly improbable to exist in your data. - For example, assuming your data is entered from a regular ASCII - keyboard, the symbol with the hex code point 29DD might be used like - so: ⧝MY_TOKEN_TYPE. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - GooglePrivacyDlpV2DiscoveryCloudStorageFilter: - id: GooglePrivacyDlpV2DiscoveryCloudStorageFilter + Required. If within a project-level config, then this must match the + config's project id. + type: string + bucketName: + description: Required. The bucket to scan. + type: string + description: Identifies a single Cloud Storage bucket. + GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: + id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails + description: Result of a risk analysis operation request. + properties: + requestedPrivacyMetric: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + description: Privacy metric to compute. + numericalStatsResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' + description: Numerical stats result + categoricalStatsResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' + description: Categorical stats result + lDiversityResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' + description: L-divesity result + requestedOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' + description: The configuration used for this job. + kMapEstimationResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' + description: K-map result + kAnonymityResult: + description: K-anonymity result + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' + requestedSourceTable: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Input dataset to compute metrics over. + deltaPresenceEstimationResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' + description: Delta-presence result type: object + GooglePrivacyDlpV2CloudStorageDiscoveryTarget: + description: Target used to match against for discovery with Cloud Storage buckets. properties: - others: + generationCadence: description: >- - Optional. Catch-all. This should always be the last target in the - list because anything above it will apply first. Should only appear - once in a configuration. If none is specified, a default one will be - added automatically. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' - collection: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreCollection' - description: Optional. A specific set of buckets for this filter to apply to. - cloudStorageResourceReference: + Optional. How often and when to update profiles. New buckets that + match both the filter and conditions are scanned as quickly as + possible depending on system capacity. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence + conditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryFileStoreConditions' description: >- - Optional. The bucket to scan. Targets including this can only - include one target (the target with this bucket). This enables - profiling the contents of a single bucket, while the other options - allow for easy profiling of many bucets within a project or an - organization. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageResourceReference' - description: >- - Determines which buckets will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID and bucket name. - GooglePrivacyDlpV2ListDiscoveryConfigsResponse: - description: Response message for ListDiscoveryConfigs. - id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse + Optional. In addition to matching the filter, these conditions must + be true before a profile is generated. + disabled: + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + description: Optional. Disable profiling for buckets that match this filter. + filter: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageFilter' + description: >- + Required. The buckets the generation_cadence applies to. The first + target with a matching filter will be the one to apply to a bucket. + type: object + id: GooglePrivacyDlpV2CloudStorageDiscoveryTarget + GooglePrivacyDlpV2ColumnDataProfile: + id: GooglePrivacyDlpV2ColumnDataProfile type: object properties: - discoveryConfigs: - description: List of configs, up to page_size in ListDiscoveryConfigsRequest. - type: array + profileLastGenerated: + type: string + description: The last time the profile was generated. + format: google-datetime + tableFullResource: + description: The resource name of the resource this column is within. + type: string + otherMatches: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - nextPageToken: - description: >- - If the next page is available then this value is the next page token - to be used in the following ListDiscoveryConfigs request. + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + type: array + description: Other types found within this column. List will be unordered. + name: + type: string + description: The name of the profile. + state: + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + description: State of a profile. type: string - GooglePrivacyDlpV2CloudStorageOptions: - properties: - sampleMethod: enumDescriptions: - - No sampling. - - Scan from the top (default). + - Unused. - >- - For each file larger than bytes_limit_per_file, randomly pick the - offset to start scanning. The scanned bytes are contiguous. + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + estimatedNullPercentage: + enumDescriptions: + - Unused. + - Very few null entries. + - Some null entries. + - A few null entries. + - A lot of null entries. + type: string enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START + - NULL_PERCENTAGE_LEVEL_UNSPECIFIED + - NULL_PERCENTAGE_VERY_LOW + - NULL_PERCENTAGE_LOW + - NULL_PERCENTAGE_MEDIUM + - NULL_PERCENTAGE_HIGH + description: Approximate percentage of entries being null in the column. + policyState: + enumDescriptions: + - No policy tags. + - Column has policy tag applied. + enum: + - COLUMN_POLICY_STATE_UNSPECIFIED + - COLUMN_POLICY_TAGGED type: string - description: How to sample the data. - bytesLimitPerFile: - format: int64 + description: Indicates if a policy tag has been applied to the column. + profileStatus: description: >- - Max number of bytes to scan from a file. If a scanned file's size is - bigger than this value then the rest of the bytes are omitted. Only - one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can - be specified. This field can't be set if de-identification is - requested. For certain file types, setting this field has no effect. - For more information, see [Limits on bytes scanned per - file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + column: + type: string + description: The name of the column. + tableId: + description: The BigQuery table ID. + type: string + columnType: + enumDescriptions: + - Invalid type. + - Encoded as a string in decimal format. + - Encoded as a boolean "false" or "true". + - Encoded as a number, or string "NaN", "Infinity" or "-Infinity". + - Encoded as a string value. + - Encoded as a base64 string per RFC 4648, section 4. + - >- + Encoded as an RFC 3339 timestamp with mandatory "Z" time zone + string: 1985-04-12T23:20:50.52Z + - 'Encoded as RFC 3339 full-date format string: 1985-04-12' + - 'Encoded as RFC 3339 partial-time format string: 23:20:50.52' + - >- + Encoded as RFC 3339 full-date "T" partial-time: + 1985-04-12T23:20:50.52 + - Encoded as WKT + - Encoded as a decimal string. + - Container of ordered fields, each with a type and field name. + - Decimal type. + - Json type. + - Interval type. + - '`Range` type.' + - '`Range` type.' + - '`Range` type.' + type: string + description: The data type of a given column. + enum: + - COLUMN_DATA_TYPE_UNSPECIFIED + - TYPE_INT64 + - TYPE_BOOL + - TYPE_FLOAT64 + - TYPE_STRING + - TYPE_BYTES + - TYPE_TIMESTAMP + - TYPE_DATE + - TYPE_TIME + - TYPE_DATETIME + - TYPE_GEOGRAPHY + - TYPE_NUMERIC + - TYPE_RECORD + - TYPE_BIGNUMERIC + - TYPE_JSON + - TYPE_INTERVAL + - TYPE_RANGE_DATE + - TYPE_RANGE_DATETIME + - TYPE_RANGE_TIMESTAMP + dataRiskLevel: + description: The data risk level for this column. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + datasetId: + description: The BigQuery dataset ID. + type: string + estimatedUniquenessScore: + enum: + - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED + - UNIQUENESS_SCORE_LOW + - UNIQUENESS_SCORE_MEDIUM + - UNIQUENESS_SCORE_HIGH + enumDescriptions: + - >- + Some columns do not have estimated uniqueness. Possible reasons + include having too few values. + - >- + Low uniqueness, possibly a boolean, enum or similiarly typed + column. + - Medium uniqueness. + - >- + High uniqueness, possibly a column of free text or unique + identifiers. + description: Approximate uniqueness of the column. + type: string + datasetLocation: type: string - bytesLimitPerFilePercent: - type: integer - description: >- - Max percentage of bytes to scan from a file. The rest are omitted. - The number of bytes scanned is rounded down. Must be between 0 and - 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only - one of bytes_limit_per_file and bytes_limit_per_file_percent can be - specified. This field can't be set if de-identification is - requested. For certain file types, setting this field has no effect. - For more information, see [Limits on bytes scanned per - file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - format: int32 - filesLimitPercent: - type: integer - description: >- - Limits the number of files to scan to this percentage of the input - FileSet. Number of files scanned is rounded down. Must be between 0 - and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. - format: int32 - fileTypes: - description: >- - List of file type groups to include in the scan. If empty, all files - are scanned and available data format processors are applied. In - addition, the binary content of the selected files is always scanned - as well. Images are scanned only as binary if the specified region - does not support image inspection and no file_types were specified. - Image inspection is restricted to 'global', 'us', 'asia', and - 'europe'. - type: array - items: - enumDescriptions: - - Includes all files. - - >- - Includes all file extensions not covered by another entry. - Binary scanning attempts to convert the content of the file to - utf_8 to scan the file. If you wish to avoid this fall back, - specify one or more of the other file types in your storage - scan. - - >- - Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, - cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, - go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, - mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, - rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, - xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, - md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, - xsd, yml, yaml. - - >- - Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting - bytes_limit_per_file or bytes_limit_per_file_percent has no - effect on image files. Image inspection is restricted to the - `global`, `us`, `asia`, and `europe` regions. - - >- - Microsoft Word files larger than 30 MB will be scanned as binary - files. Included file extensions: docx, dotx, docm, dotm. Setting - `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no - effect on Word files. - - >- - PDF files larger than 30 MB will be scanned as binary files. - Included file extensions: pdf. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PDF files. - - 'Included file extensions: avro' - - 'Included file extensions: csv' - - 'Included file extensions: tsv' - - >- - Microsoft PowerPoint files larger than 30 MB will be scanned as - binary files. Included file extensions: pptx, pptm, potx, potm, - pot. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PowerPoint - files. - - >- - Microsoft Excel files larger than 30 MB will be scanned as - binary files. Included file extensions: xlsx, xlsm, xltx, xltm. - Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` - has no effect on Excel files. - enum: - - FILE_TYPE_UNSPECIFIED - - BINARY_FILE - - TEXT_FILE - - IMAGE - - WORD - - PDF - - AVRO - - CSV - - TSV - - POWERPOINT - - EXCEL - type: string - fileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' - description: The set of one or more files to scan. - id: GooglePrivacyDlpV2CloudStorageOptions - description: Options defining a file or a set of files within a Cloud Storage bucket. - type: object - GooglePrivacyDlpV2DataProfileBigQueryRowSchema: - type: object - id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema - properties: - fileStoreProfile: - description: File store data profile column. - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' - columnProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - description: Column data profile column - tableProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - description: Table data profile column - description: >- - The schema of data to be saved to the BigQuery table when the - `DataProfileAction` is enabled. - GooglePrivacyDlpV2RequestedOptions: - id: GooglePrivacyDlpV2RequestedOptions - description: Snapshot of the inspection configuration. - type: object - properties: - snapshotInspectTemplate: description: >- - If run with an InspectTemplate, a snapshot of its state at the time - of this run. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - jobConfig: - description: Inspect config. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - GooglePrivacyDlpV2HybridOptions: - id: GooglePrivacyDlpV2HybridOptions + The BigQuery location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + locations. + columnInfoType: + description: >- + If it's been determined this column can be identified as a single + type, this will be set. Otherwise the column either has + unidentifiable content or mixed types. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + tableDataProfile: + type: string + description: The resource name of the table data profile. + datasetProjectId: + type: string + description: The Google Cloud project ID that owns the profiled resource. + sensitivityScore: + description: The sensitivity of this column. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + freeTextScore: + type: number + format: double + description: >- + The likelihood that this column contains free-form text. A value + close to 1 may indicate the column is likely to contain free-form or + natural language text. Range in 0-1. + description: The profile for a scanned column within a table. + GooglePrivacyDlpV2StorageMetadataLabel: + id: GooglePrivacyDlpV2StorageMetadataLabel type: object description: >- - Configuration to control jobs where the content being inspected is - outside of Google Cloud Platform. + Storage metadata label to indicate which metadata entry contains + findings. properties: - labels: - description: >- - To organize findings, these labels will be added to each finding. - Label keys must be between 1 and 63 characters long and must conform - to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. - Label values must be between 0 and 63 characters long and must - conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. - No more than 10 labels can be associated with a given finding. - Examples: * `"environment" : "production"` * `"pipeline" : "etl"` - type: object - additionalProperties: - type: string - tableOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' - description: >- - If the container is a table, additional information to make findings - meaningful such as the columns that are primary keys. - requiredFindingLabelKeys: - items: - type: string - type: array - description: >- - These are labels that each inspection request must include within - their 'finding_labels' map. Request may contain others, but any - missing one of these will be rejected. Label keys must be between 1 - and 63 characters long and must conform to the following regular - expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can - be required. - description: + key: + description: Label name. type: string - description: >- - A short description of where the data is coming from. Will be stored - once in the job. 256 max length. - GooglePrivacyDlpV2ExcludeInfoTypes: - description: List of excluded infoTypes. - id: GooglePrivacyDlpV2ExcludeInfoTypes + GooglePrivacyDlpV2InfoTypeTransformation: + description: >- + A transformation to apply to text that is identified as a specific + info_type. properties: + primitiveTransformation: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + description: Required. Primitive transformation to apply to the infoType. infoTypes: type: array - description: >- - InfoType list in ExclusionRule rule drops a finding when it overlaps - or contained within with a finding of an infoType from this list. - For example, for `InspectionRuleSet.info_types` containing - "PHONE_NUMBER"` and `exclusion_rule` containing - `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone - number findings are dropped if they overlap with EMAIL_ADDRESS - finding. That leads to "555-222-2222@example.org" to generate only a - single finding, namely email address. items: $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + InfoTypes to apply the transformation to. An empty list will cause + this transformation to apply to all findings that correspond to + infoTypes that were requested in `InspectConfig`. type: object - GooglePrivacyDlpV2SummaryResult: + id: GooglePrivacyDlpV2InfoTypeTransformation + GooglePrivacyDlpV2ActivateJobTriggerRequest: + description: Request message for ActivateJobTrigger. + properties: {} + type: object + id: GooglePrivacyDlpV2ActivateJobTriggerRequest + GooglePrivacyDlpV2FileStoreCollection: + id: GooglePrivacyDlpV2FileStoreCollection properties: - count: - format: int64 - description: Number of transformations counted by this result. - type: string - details: + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegexes' description: >- - A place for warnings or errors to show up if a transformation didn't - work as expected. - type: string - code: - enum: - - TRANSFORMATION_RESULT_CODE_UNSPECIFIED - - SUCCESS - - ERROR - description: Outcome of the transformation. - type: string - enumDescriptions: - - Unused - - Transformation completed without an error. - - Transformation had an error. - id: GooglePrivacyDlpV2SummaryResult + Optional. A collection of regular expressions to match a file store + against. type: object - description: >- - A collection that informs the user the number of times a particular - `TransformationResultCode` and error details occurred. - GooglePrivacyDlpV2DataProfileLocation: - id: GooglePrivacyDlpV2DataProfileLocation + description: Match file stores (e.g. buckets) using regex filters. + GooglePrivacyDlpV2TableReference: + id: GooglePrivacyDlpV2TableReference properties: - organizationId: - format: int64 - description: The ID of an organization to scan. + datasetId: + description: Dataset ID of the table. type: string - folderId: - description: The ID of the folder within an organization to scan. - format: int64 + tableId: + description: Name of the table. type: string - description: The data that will be profiled. - type: object - GooglePrivacyDlpV2RequestedRiskAnalysisOptions: - type: object - properties: - jobConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - description: The job config for the risk job. - description: Risk analysis options. - id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions - GooglePrivacyDlpV2Dictionary: - properties: - wordList: - description: List of words or phrases to search for. - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' - cloudStoragePath: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' - description: >- - Newline-delimited file of words in Cloud Storage. Only a single file - is accepted. type: object description: >- - Custom information type based on a dictionary of words or phrases. This - can be used to match sensitive information specific to the data, such as - a list of employee IDs or job titles. Dictionary words are - case-insensitive and all characters other than letters and digits in the - unicode [Basic Multilingual - Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) - will be replaced with whitespace when scanning for matches, so the - dictionary phrase "Sam Johnson" will match all three phrases "sam - johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the - characters surrounding any match must be of a different type than the - adjacent characters within the word, so letters must be next to - non-letters and digits next to non-digits. For example, the dictionary - word "jen" will match the first three letters of the text "jen123" but - will return no matches for "jennifer". Dictionary words containing a - large number of characters that are not letters or digits may result in - unexpected findings because such characters are treated as whitespace. - The [limits](https://cloud.google.com/sensitive-data-protection/limits) - page contains details about the size limits of dictionaries. For - dictionaries that do not fit within these constraints, consider using - `LargeCustomDictionaryConfig` in the `StoredInfoType` API. - id: GooglePrivacyDlpV2Dictionary - GooglePrivacyDlpV2TransformationDetailsStorageConfig: - properties: - table: - description: >- - The BigQuery table in which to store the output. This may be an - existing table or in a new table in an existing dataset. If table_id - is not set a new one will be generated for you with the following - format: - dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. - Pacific time zone will be used for generating the date details. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - type: object - id: GooglePrivacyDlpV2TransformationDetailsStorageConfig - description: Config for storing transformation details. - GooglePrivacyDlpV2AllText: - description: Apply to all text. - type: object - id: GooglePrivacyDlpV2AllText - properties: {} - GooglePrivacyDlpV2InfoTypeStats: - id: GooglePrivacyDlpV2InfoTypeStats - type: object - description: Statistics regarding a specific InfoType. + Message defining the location of a BigQuery table with the projectId + inferred from the parent project. + GooglePrivacyDlpV2QuasiId: properties: - count: - description: Number of findings for this infoType. - format: int64 + customTag: type: string + description: >- + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column (below). + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Required. Identifies the column. infoType: - description: The type of finding this stat is for. $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - GooglePrivacyDlpV2DateShiftConfig: - properties: - context: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Points to the field that contains the context, for example, an - entity id. If set, must also set cryptoKey. If set, shift will be - consistent for the given context. - cryptoKey: - description: >- - Causes the shift to be computed based on this key and the context. - This results in the same shift for the same context and crypto_key. - If set, must also set context. Can only be applied to table items. - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - upperBoundDays: - format: int32 - type: integer description: >- - Required. Range of shift in days. Actual shift will be selected at - random within this range (inclusive ends). Negative means shift to - earlier in time. Must not be more than 365250 days (1000 years) each - direction. For example, 3 means shift date to at most 3 days into - the future. - lowerBoundDays: + A column can be tagged with a InfoType to use the relevant public + dataset as a statistical model of population, if available. We + currently support US ZIP codes, region codes, ages and genders. To + programmatically obtain the list of supported InfoTypes, use + ListInfoTypes with the supported_by=RISK_ANALYSIS filter. + inferred: + $ref: '#/components/schemas/GoogleProtobufEmpty' description: >- - Required. For example, -5 means shift date to at most 5 days back in - the past. - type: integer - format: int32 + If no semantic tag is indicated, we infer the statistical model from + the distribution of values in the input data type: object + id: GooglePrivacyDlpV2QuasiId + description: A column with a semantic tag attached. + GooglePrivacyDlpV2InspectionRuleSet: + id: GooglePrivacyDlpV2InspectionRuleSet + type: object + properties: + rules: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' + type: array + description: >- + Set of rules to be applied to infoTypes. The rules are applied in + order. + infoTypes: + type: array + description: List of infoTypes this rule set is applied to. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - Shifts dates by random number of days, with option to be consistent for - the same context. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting - to learn more. - id: GooglePrivacyDlpV2DateShiftConfig - GooglePrivacyDlpV2RedactConfig: - id: GooglePrivacyDlpV2RedactConfig - properties: {} - description: >- - Redact a given value. For example, if used with an - `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone - number is 206-555-0123', the output would be 'My phone number is '. + Rule set for modifying a set of infoTypes to alter behavior under + certain circumstances, depending on the specific details of the rules + within the set. + GooglePrivacyDlpV2InfoTypeDescription: type: object - GooglePrivacyDlpV2Error: + id: GooglePrivacyDlpV2InfoTypeDescription + description: InfoType description. properties: - extraInfo: - enumDescriptions: - - Unused. - - Image scan is not available in the region. - - File store cluster is not supported for profile generation. - enum: - - ERROR_INFO_UNSPECIFIED - - IMAGE_SCAN_UNAVAILABLE_IN_REGION - - FILE_STORE_CLUSTER_UNSUPPORTED + name: + description: Internal name of the infoType. type: string - description: Additional information about the error. - timestamps: + categories: + description: The category of the infoType. type: array items: - format: google-datetime - type: string + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' + versions: + description: A list of available versions for the infotype. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' + type: array + description: description: >- - The times the error occurred. List includes the oldest timestamp and - the last 9 timestamps. - details: - description: Detailed error codes and messages. - $ref: '#/components/schemas/GoogleRpcStatus' - id: GooglePrivacyDlpV2Error - description: >- - Details information about an error encountered during job execution or - the results of an unsuccessful activation of the JobTrigger. - type: object + Description of the infotype. Translated when language is provided in + the request. + type: string + supportedBy: + items: + enum: + - ENUM_TYPE_UNSPECIFIED + - INSPECT + - RISK_ANALYSIS + type: string + enumDescriptions: + - Unused. + - Supported by the inspect operations. + - Supported by the risk analysis operations. + description: Which parts of the API supports this InfoType. + type: array + displayName: + type: string + description: Human readable form of the infoType name. + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: The default sensitivity of the infoType. GooglePrivacyDlpV2ContentLocation: + type: object + id: GooglePrivacyDlpV2ContentLocation description: >- Precise location of the finding within a document, record, image, or metadata container. - id: GooglePrivacyDlpV2ContentLocation - type: object properties: - imageLocation: - description: Location within an image's pixels. - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' - recordLocation: - description: Location within a row or record of a database table. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' - metadataLocation: - description: Location within the metadata for inspected content. - $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' - containerVersion: - description: >- - Finding container version, if available ("generation" for Cloud - Storage). + documentLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' + description: Location data for document files. + containerTimestamp: + format: google-datetime + description: >- + Finding container modification timestamp, if applicable. For Cloud + Storage, this field contains the last file modification timestamp. + For a BigQuery table, this field contains the last_modified_time + property. For Datastore, this field isn't populated. type: string containerName: + type: string description: >- Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common @@ -2558,1817 +2415,1631 @@ components: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document). + recordLocation: + description: Location within a row or record of a database table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' + containerVersion: type: string - containerTimestamp: - type: string - format: google-datetime description: >- - Finding container modification timestamp, if applicable. For Cloud - Storage, this field contains the last file modification timestamp. - For a BigQuery table, this field contains the last_modified_time - property. For Datastore, this field isn't populated. - documentLocation: - description: Location data for document files. - $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' - GooglePrivacyDlpV2ListInspectTemplatesResponse: + Finding container version, if available ("generation" for Cloud + Storage). + metadataLocation: + description: Location within the metadata for inspected content. + $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' + imageLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' + description: Location within an image's pixels. + GooglePrivacyDlpV2BigQueryField: + properties: + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Source table of the field. + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Designated field in the BigQuery table. + id: GooglePrivacyDlpV2BigQueryField + description: Message defining a field of a BigQuery table. + type: object + GooglePrivacyDlpV2RecordCondition: + id: GooglePrivacyDlpV2RecordCondition + properties: + expressions: + $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' + description: An expression. type: object + description: >- + A condition for determining whether a transformation should be applied + to a field. + GooglePrivacyDlpV2DiscoveryBigQueryFilter: properties: - inspectTemplates: + otherTables: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' description: >- - List of inspectTemplates, up to page_size in - ListInspectTemplatesRequest. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - nextPageToken: - type: string + Catch-all. This should always be the last filter in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. + tableReference: description: >- - If the next page is available then the next page token to be used in - the following ListInspectTemplates request. - description: Response message for ListInspectTemplates. - id: GooglePrivacyDlpV2ListInspectTemplatesResponse - GooglePrivacyDlpV2Table: + The table to scan. Discovery configurations including this can only + include one DiscoveryTarget (the DiscoveryTarget with this + TableReference). + $ref: '#/components/schemas/GooglePrivacyDlpV2TableReference' + tables: + description: >- + A specific set of tables for this filter to apply to. A table + collection must be specified in only one filter per config. If a + table id or dataset is empty, Cloud DLP assumes all tables in that + collection must be profiled. Must specify a project ID. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableCollection' description: >- - Structured content to inspect. Up to 50,000 `Value`s per request - allowed. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table - to learn more. - id: GooglePrivacyDlpV2Table + Determines what tables will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID, dataset ID, and table ID. + id: GooglePrivacyDlpV2DiscoveryBigQueryFilter type: object + GooglePrivacyDlpV2Row: + id: GooglePrivacyDlpV2Row properties: - headers: - type: array - description: Headers of the table. + values: + description: Individual cells. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - rows: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' type: array - description: Rows of the table. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Row' - GooglePrivacyDlpV2UpdateConnectionRequest: - id: GooglePrivacyDlpV2UpdateConnectionRequest + description: Values of the row. type: object - description: Request message for UpdateConnection. + GooglePrivacyDlpV2ListConnectionsResponse: properties: - updateMask: - format: google-fieldmask - description: Optional. Mask to control which fields get updated. + nextPageToken: type: string - connection: - description: Required. The connection with new values for the relevant fields. - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - GooglePrivacyDlpV2SurrogateType: - id: GooglePrivacyDlpV2SurrogateType + description: >- + Token to retrieve the next page of results. An empty value means + there are no more results. + connections: + type: array + description: List of connections. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' type: object - description: >- - Message for detecting output from deidentification transformations such - as - [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). - These types of transformations are those that perform pseudonymization, - thereby producing a "surrogate" as output. This should be used in - conjunction with a field on the transformation such as - `surrogate_info_type`. This CustomInfoType does not support the use of - `detection_rules`. - properties: {} - GooglePrivacyDlpV2DeltaPresenceEstimationResult: + id: GooglePrivacyDlpV2ListConnectionsResponse + description: Response message for ListConnections. + GooglePrivacyDlpV2FieldTransformation: + id: GooglePrivacyDlpV2FieldTransformation + description: The transformation to apply to the field. properties: - deltaPresenceEstimationHistogram: + infoTypeTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' description: >- - The intervals [min_probability, max_probability) do not overlap. If - a value doesn't correspond to any such interval, the associated - frequency is zero. For example, the following records: - {min_probability: 0, max_probability: 0.1, frequency: 17} - {min_probability: 0.2, max_probability: 0.3, frequency: 42} - {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean - that there are no record with an estimated probability in [0.1, 0.2) - nor larger or equal to 0.4. - type: array + Treat the contents of the field as free text, and selectively + transform content that matches an `InfoType`. + condition: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + description: >- + Only apply the transformation if the condition evaluates to true for + the given `RecordCondition`. The conditions are allowed to reference + fields that are not used in the actual transformation. Example Use + Cases: - Apply a different bucket transformation to an age column if + the zip code column for the same record is within a specific range. + - Redact a field if the date of birth field is greater than 85. + primitiveTransformation: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + description: Apply the transformation to the entire field. + fields: items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket - id: GooglePrivacyDlpV2DeltaPresenceEstimationResult + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + Required. Input field(s) to apply the transformation to. When you + have columns that reference their position within a list, omit the + index from the FieldId. FieldId name matching ignores the index. For + example, instead of "contact.nums[0].type", use "contact.nums.type". + type: array type: object + GooglePrivacyDlpV2StatisticalTable: + id: GooglePrivacyDlpV2StatisticalTable description: >- - Result of the δ-presence computation. Note that these results are an - estimation, not exact values. - GooglePrivacyDlpV2DeidentifyContentResponse: - id: GooglePrivacyDlpV2DeidentifyContentResponse - type: object - properties: - item: - description: The de-identified item. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - overview: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' - description: An overview of the changes that were made on the `item`. - description: Results of de-identifying a ContentItem. - GooglePrivacyDlpV2Regex: - id: GooglePrivacyDlpV2Regex + An auxiliary table containing statistical information on the relative + frequency of different quasi-identifiers values. It has one or several + quasi-identifiers columns, and one column that indicates the relative + frequency of each quasi-identifier tuple. If a tuple is present in the + data but not in the auxiliary table, the corresponding relative + frequency is assumed to be zero (and thus, the tuple is highly + reidentifiable). type: object properties: - pattern: - type: string - description: >- - Pattern defining the regular expression. Its syntax - (https://github.com/google/re2/wiki/Syntax) can be found under the - google/re2 repository on GitHub. - groupIndexes: + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Required. Auxiliary table location. + relativeFrequency: description: >- - The index of the submatch to extract as findings. When not - specified, the entire match is returned. No more than 3 may be - included. + Required. The relative frequency column must contain a + floating-point number between 0 and 1 (inclusive). Null values are + assumed to be zero. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + quasiIds: type: array + description: Required. Quasi-identifier columns. items: - format: int32 - type: integer - description: Message defining a custom regular expression. - GooglePrivacyDlpV2Manual: - description: >- - Job trigger option for hybrid jobs. Jobs must be manually created and - finished. - properties: {} + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' + GooglePrivacyDlpV2SecretsDiscoveryTarget: type: object - id: GooglePrivacyDlpV2Manual - GooglePrivacyDlpV2ReidentifyContentRequest: + id: GooglePrivacyDlpV2SecretsDiscoveryTarget + properties: {} + description: >- + Discovery target for credentials and secrets in cloud resource metadata. + This target does not include any filtering or frequency controls. Cloud + DLP will scan cloud resource metadata for secrets daily. No inspect + template should be included in the discovery config for a security + benchmarks scan. Instead, the built-in list of secrets and credentials + infoTypes will be used (see + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). + Credentials and secrets discovered will be reported as vulnerabilities + to Security Command Center. + GooglePrivacyDlpV2ImageLocation: + description: Location of the finding within an image. type: object - id: GooglePrivacyDlpV2ReidentifyContentRequest + id: GooglePrivacyDlpV2ImageLocation properties: - inspectTemplateName: - description: >- - Template to use. Any configuration directly specified in - `inspect_config` will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - type: string - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: Configuration for the inspector. - locationId: - description: Deprecated. This field has no effect. - type: string - item: - description: The item to re-identify. Will be treated as text. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - reidentifyTemplateName: - type: string - description: >- - Template to use. References an instance of `DeidentifyTemplate`. Any - configuration directly specified in `reidentify_config` or - `inspect_config` will override those set in the template. The - `DeidentifyTemplate` used must include only reversible - transformations. Singular fields that are set in this request will - replace their corresponding fields in the template. Repeated fields - are appended. Singular sub-messages and groups are recursively - merged. - reidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + boundingBoxes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' + type: array description: >- - Configuration for the re-identification of the content item. This - field shares the same proto message type that is used for - de-identification, however its usage here is for the reversal of the - previous de-identification. Re-identification is performed by - examining the transformations used to de-identify the items and - executing the reverse. This requires that only reversible - transformations be provided here. The reversible transformations - are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` - description: Request to re-identify an item. - GooglePrivacyDlpV2TransientCryptoKey: - description: >- - Use this to have a random data crypto key generated. It will be - discarded after the request finishes. + Bounding boxes locating the pixels within the image containing the + finding. + GooglePrivacyDlpV2CreateDiscoveryConfigRequest: properties: - name: + configId: description: >- - Required. Name of the key. This is an arbitrary string used to - differentiate different keys. A unique key is generated per name: - two separate `TransientCryptoKey` protos share the same generated - key if their names are the same. When the data crypto key is - generated, this name is not used in any way (repeating the api call - will result in a different key being generated). + The config ID can contain uppercase and lowercase letters, numbers, + and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - id: GooglePrivacyDlpV2TransientCryptoKey - type: object - GooglePrivacyDlpV2PrimitiveTransformation: + discoveryConfig: + description: Required. The DiscoveryConfig to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: Request message for CreateDiscoveryConfig. type: object - description: A rule for transforming a value. - properties: - cryptoDeterministicConfig: - description: Deterministic Crypto - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' - dateShiftConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' - description: Date Shift - fixedSizeBucketingConfig: - description: Fixed size bucketing - $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' - characterMaskConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' - description: Mask - replaceConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' - description: Replace with a specified value. - redactConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' - description: Redact - bucketingConfig: - description: Bucketing - $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' - cryptoReplaceFfxFpeConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' - description: Ffx-Fpe - replaceDictionaryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' - description: >- - Replace with a value randomly drawn (with replacement) from a - dictionary. - cryptoHashConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' - description: Crypto - replaceWithInfoTypeConfig: - description: Replace with infotype - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' - timePartConfig: - description: Time extraction - $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' - id: GooglePrivacyDlpV2PrimitiveTransformation - GooglePrivacyDlpV2SaveFindings: + id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest + GooglePrivacyDlpV2CreateConnectionRequest: type: object - description: >- - If set, the detailed findings will be persisted to the specified - OutputStorageConfig. Only a single instance of this action can be - specified. Compatible with: Inspect, Risk - id: GooglePrivacyDlpV2SaveFindings + description: Request message for CreateConnection. properties: - outputConfig: - description: Location to store findings outside of DLP. - $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' - GooglePrivacyDlpV2HybridInspectStatistics: + connection: + description: Required. The connection resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + id: GooglePrivacyDlpV2CreateConnectionRequest + GooglePrivacyDlpV2ListDlpJobsResponse: type: object - id: GooglePrivacyDlpV2HybridInspectStatistics - description: Statistics related to processing hybrid inspect requests. + description: The response message for listing DLP jobs. + id: GooglePrivacyDlpV2ListDlpJobsResponse properties: - processedCount: - type: string - description: The number of hybrid inspection requests processed within this job. - format: int64 - pendingCount: - type: string - description: >- - The number of hybrid requests currently being processed. Only - populated when called via method `getDlpJob`. A burst of traffic may - cause hybrid inspect requests to be enqueued. Processing will take - place as quickly as possible, but resource limitations may impact - how long a request is enqueued for. - format: int64 - abortedCount: - description: >- - The number of hybrid inspection requests aborted because the job ran - out of quota or was ended before they could be processed. + nextPageToken: type: string - format: int64 - GooglePrivacyDlpV2InspectConfig: - description: >- - Configuration description of the scanning process. When used with - redactContent only info_types and min_likelihood are currently used. - id: GooglePrivacyDlpV2InspectConfig - properties: - ruleSet: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' + description: The standard List next-page token. + jobs: type: array - description: >- - Set of rules to apply to the findings for this InspectConfig. - Exclusion rules, contained in the set are executed in the end, other - rules are executed in the order they are specified for each info - type. - contentOptions: + description: A list of DlpJobs that matches the specified filter in the request. items: - type: string - enum: - - CONTENT_UNSPECIFIED - - CONTENT_TEXT - - CONTENT_IMAGE - enumDescriptions: - - Includes entire content of a file or a data stream. - - Text content within the data, excluding any metadata. - - Images found in the data. - type: array - description: Deprecated and unused. - minLikelihoodPerInfoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + GooglePrivacyDlpV2KAnonymityResult: + id: GooglePrivacyDlpV2KAnonymityResult + type: object + properties: + equivalenceClassHistogramBuckets: type: array - description: >- - Minimum likelihood per infotype. For each infotype, a user can - specify a minimum likelihood. The system only returns a finding if - its likelihood is above this threshold. If this field is not set, - the system uses the InspectConfig min_likelihood. + description: Histogram of k-anonymity equivalence classes. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' - customInfoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' + description: Result of the k-anonymity computation. + GooglePrivacyDlpV2Bucket: + id: GooglePrivacyDlpV2Bucket + properties: + max: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Upper bound of the range, exclusive; type must match min. + min: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: >- - CustomInfoTypes provided by the user. See - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes - to learn more. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' - infoTypes: + Lower bound of the range, inclusive. Type should be the same as max + if used. + replacementValue: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Required. Replacement value for this bucket. + description: Bucket is represented as a range, along with replacement values. + type: object + GooglePrivacyDlpV2LargeCustomDictionaryConfig: + description: >- + Configuration for a custom dictionary created from a data source of any + size up to the maximum size defined in the + [limits](https://cloud.google.com/sensitive-data-protection/limits) + page. The artifacts of dictionary creation are stored in the specified + Cloud Storage location. Consider using `CustomInfoType.Dictionary` for + smaller dictionaries that satisfy the size requirements. + type: object + id: GooglePrivacyDlpV2LargeCustomDictionaryConfig + properties: + outputPath: description: >- - Restricts what info_types to look for. The values must correspond to - InfoType values returned by ListInfoTypes or listed at - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. - When no InfoTypes or CustomInfoTypes are specified in a request, the - system may automatically choose a default list of detectors to run, - which may change over time. If you need precise control and - predictability as to what detectors are run you should specify - specific InfoTypes listed in the reference, otherwise a default list - will be used, which may change over time. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - type: array - minLikelihood: + Location to store dictionary artifacts in Cloud Storage. These files + will only be accessible by project owners and the DLP API. If any of + these artifacts are modified, the dictionary is considered invalid + and can no longer be used. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' + cloudStorageFileSet: description: >- - Only returns findings equal to or above this threshold. The default - is POSSIBLE. In general, the highest likelihood setting yields the - fewest findings in results and the lowest chance of a false - positive. For more information, see [Match - likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - type: string - includeQuote: - type: boolean - description: >- - When true, a contextual quote from the data that triggered a finding - is included in the response; see Finding.quote. This is not used for - data profiling. - limits: - $ref: '#/components/schemas/GooglePrivacyDlpV2FindingLimits' - description: >- - Configuration to control the number of findings returned. This is - not used for data profiling. When redacting sensitive data from - images, finding limits don't apply. They can cause unexpected or - inconsistent results, where only some data is redacted. Don't - include finding limits in RedactImage requests. Otherwise, Cloud DLP - returns an error. When set within an InspectJobConfig, the specified - maximum values aren't hard limits. If an inspection job reaches - these limits, the job ends gradually, not abruptly. Therefore, the - actual number of findings that Cloud DLP returns can be multiple - times higher than these maximum values. - excludeInfoTypes: + Set of files containing newline-delimited lists of dictionary + phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' + bigQueryField: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' description: >- - When true, excludes type information of the findings. This is not - used for data profiling. - type: boolean + Field in a BigQuery table where each cell represents a dictionary + phrase. + GooglePrivacyDlpV2StoredInfoTypeVersion: type: object - GooglePrivacyDlpV2FileSet: properties: - url: + config: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + description: StoredInfoType configuration. + state: + enumDescriptions: + - Unused + - StoredInfoType version is being created. + - StoredInfoType version is ready for use. + - >- + StoredInfoType creation failed. All relevant error messages are + returned in the `StoredInfoTypeVersion` message. + - >- + StoredInfoType is no longer valid because artifacts stored in + user-controlled storage were modified. To fix an invalid + StoredInfoType, use the `UpdateStoredInfoType` method to create a + new version. + enum: + - STORED_INFO_TYPE_STATE_UNSPECIFIED + - PENDING + - READY + - FAILED + - INVALID description: >- - The Cloud Storage url of the file(s) to scan, in the format - `gs:///`. Trailing wildcard in the path is allowed. If the url ends - in a trailing slash, the bucket or directory represented by the url - will be scanned non-recursively (content in sub-directories will not - be scanned). This means that `gs://mybucket/` is equivalent to - `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to - `gs://mybucket/directory/*`. Exactly one of `url` or - `regex_file_set` must be set. + Stored info type version state. Read-only, updated by the system + during dictionary creation. type: string - regexFileSet: + stats: + description: Statistics about this storedInfoType version. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' + createTime: description: >- - The regex-filtered set of files to scan. Exactly one of `url` or - `regex_file_set` must be set. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegexFileSet' - description: Set of files to scan. + Create timestamp of the version. Read-only, determined by the system + when the version is created. + type: string + format: google-datetime + errors: + description: >- + Errors that occurred when creating this storedInfoType version, or + anomalies detected in the storedInfoType data that render it + unusable. Only the five most recent errors will be displayed, with + the most recent error appearing first. For example, some of the data + for stored custom dictionaries is put in the user's Cloud Storage + bucket, and if this data is modified or deleted by the user or + another system, the dictionary becomes invalid. If any errors occur, + fix the problem indicated by the error message and use the + UpdateStoredInfoType API method to create another version of the + storedInfoType to continue using it, reusing the same `config` if it + was not the source of the error. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + type: array + description: >- + Version of a StoredInfoType, including the configuration used to build + it, create timestamp, and current state. + id: GooglePrivacyDlpV2StoredInfoTypeVersion + GooglePrivacyDlpV2AllOtherBigQueryTables: type: object - id: GooglePrivacyDlpV2FileSet - GooglePrivacyDlpV2CustomInfoType: - id: GooglePrivacyDlpV2CustomInfoType + properties: {} + id: GooglePrivacyDlpV2AllOtherBigQueryTables description: >- - Custom information type provided by the user. Used to find - domain-specific sensitive information configurable to the data in - question. + Catch-all for all other tables not specified by other filters. Should + always be last, except for single-table configurations, which will only + have a TableReference target. + GooglePrivacyDlpV2SensitivityScore: + id: GooglePrivacyDlpV2SensitivityScore + type: object + description: >- + Score is calculated from of all elements in the data profile. A higher + level means the data is more sensitive. properties: - storedType: - description: >- - Load an existing `StoredInfoType` resource for use in - `InspectDataSource`. Not currently supported in `InspectContent`. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: >- - Sensitivity for this CustomInfoType. If this CustomInfoType extends - an existing InfoType, the sensitivity here will take precedence over - that of the original InfoType. If unset for a CustomInfoType, it - will default to HIGH. This only applies to data profiling. - surrogateType: - $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' - description: >- - Message for detecting output from deidentification transformations - that support reversing. - infoType: - description: >- - CustomInfoType can either be a new infoType, or an extension of - built-in infoType, when the name matches one of existing infoTypes - and that infoType is specified in `InspectContent.info_types` field. - Specifying the latter adds findings to the one detected by the - system. If built-in info type is not specified in - `InspectContent.info_types` list then the name is treated as a - custom info type. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - likelihood: - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - description: >- - Likelihood to return for this CustomInfoType. This base value can be - altered by a detection rule if the finding meets the criteria - specified by the rule. Defaults to `VERY_LIKELY` if not specified. - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - type: string - detectionRules: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' - description: >- - Set of detection rules to apply to all findings of this - CustomInfoType. Rules are applied in order that they are specified. - Not supported for the `surrogate_type` CustomInfoType. - exclusionType: - type: string + score: enumDescriptions: + - Unused. - >- - A finding of this custom info type will not be excluded from - results. + No sensitive information detected. The resource isn't publicly + accessible. + - Unable to determine sensitivity. - >- - A finding of this custom info type will be excluded from final - results, but can still affect rule execution. + Medium risk. Contains personally identifiable information (PII), + potentially sensitive data, or fields with free-text data that are + at a higher risk of having intermittent sensitive data. Consider + limiting access. + - >- + High risk. Sensitive personally identifiable information (SPII) + can be present. Exfiltration of data can lead to user data loss. + Re-identification of users might be possible. Consider limiting + usage and or removing SPII. enum: - - EXCLUSION_TYPE_UNSPECIFIED - - EXCLUSION_TYPE_EXCLUDE - description: >- - If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a - finding to be returned. It still can be used for rules matching. - dictionary: - description: A list of phrases to detect as a CustomInfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - regex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression based CustomInfoType. - type: object + - SENSITIVITY_SCORE_UNSPECIFIED + - SENSITIVITY_LOW + - SENSITIVITY_UNKNOWN + - SENSITIVITY_MODERATE + - SENSITIVITY_HIGH + description: The sensitivity score applied to the resource. + type: string GooglePrivacyDlpV2DeidentifyDataSourceStats: - type: object - id: GooglePrivacyDlpV2DeidentifyDataSourceStats properties: - transformationErrorCount: - description: Number of errors encountered while trying to apply transformations. + transformationCount: format: int64 + description: Number of successfully applied transformations. type: string transformedBytes: description: Total size in bytes that were transformed in some way. type: string format: int64 - transformationCount: - description: Number of successfully applied transformations. - type: string + transformationErrorCount: format: int64 + description: Number of errors encountered while trying to apply transformations. + type: string + id: GooglePrivacyDlpV2DeidentifyDataSourceStats + type: object description: Summary of what was modified during a transformation. - GooglePrivacyDlpV2DiscoveryCloudSqlConditions: - id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions + GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: + description: A tuple of values for the quasi-identifier columns. + type: object properties: - databaseEngines: - type: array + estimatedProbability: + format: double description: >- - Optional. Database engines that should be profiled. Optional. - Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. - items: - enum: - - DATABASE_ENGINE_UNSPECIFIED - - ALL_SUPPORTED_DATABASE_ENGINES - - MYSQL - - POSTGRES - type: string - enumDescriptions: - - Unused. - - Include all supported database engines. - - MySQL database. - - PostgreSQL database. - types: - description: >- - Data profiles will only be generated for the database resource types - specified in this field. If not specified, defaults to - [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + The estimated probability that a given individual sharing these + quasi-identifier values is in the dataset. This value, typically + called δ, is the ratio between the number of records in the dataset + with these quasi-identifier values, and the total number of + individuals (inside *and* outside the dataset) with these + quasi-identifier values. For example, if there are 15 individuals in + the dataset who share the same quasi-identifier values, and an + estimated 100 people in the entire population with these values, + then δ is 0.15. + type: number + quasiIdsValues: items: - enumDescriptions: - - Unused. - - >- - Includes database resource types that become supported at a - later time. - - Tables. - enum: - - DATABASE_RESOURCE_TYPE_UNSPECIFIED - - DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES - - DATABASE_RESOURCE_TYPE_TABLE - type: string + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' type: array - description: >- - Requirements that must be true before a table is profiled for the first - time. - type: object - GooglePrivacyDlpV2PubSubCondition: - id: GooglePrivacyDlpV2PubSubCondition - description: A condition consisting of a value. + description: The quasi-identifier values. + id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + GooglePrivacyDlpV2HybridInspectDlpJobRequest: properties: - minimumRiskScore: - description: The minimum data risk score that triggers the condition. - enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH - type: string - enumDescriptions: - - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. - minimumSensitivityScore: - enumDescriptions: - - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. - enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH - description: The minimum sensitivity level that triggers the condition. - type: string + hybridItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + description: The item to inspect. type: object - GooglePrivacyDlpV2ImageLocation: - id: GooglePrivacyDlpV2ImageLocation + id: GooglePrivacyDlpV2HybridInspectDlpJobRequest + description: Request to search for potentially sensitive info in a custom location. + GooglePrivacyDlpV2BigQueryKey: properties: - boundingBoxes: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' + rowNumber: description: >- - Bounding boxes locating the pixels within the image containing the - finding. - description: Location of the finding within an image. + Row number inferred at the time the table was scanned. This value is + nondeterministic, cannot be queried, and may be null for inspection + jobs. To locate findings within a table, specify + `inspect_job.storage_config.big_query_options.identifying_fields` in + `CreateDlpJobRequest`. + format: int64 + type: string + tableReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Complete BigQuery table reference. + description: Row key for identifying a record in BigQuery table. type: object - GooglePrivacyDlpV2SearchConnectionsResponse: + id: GooglePrivacyDlpV2BigQueryKey + GooglePrivacyDlpV2PathElement: type: object - description: Response message for SearchConnections. properties: - connections: + id: description: >- - List of connections that match the search query. Note that only a - subset of the fields will be populated, and only "name" is - guaranteed to be set. For full details of a Connection, call - GetConnection with the name. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - nextPageToken: + The auto-allocated ID of the entity. Never equal to zero. Values + less than zero are discouraged and may not be supported in the + future. + format: int64 + type: string + name: type: string description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. - id: GooglePrivacyDlpV2SearchConnectionsResponse - GooglePrivacyDlpV2DataRiskLevel: - id: GooglePrivacyDlpV2DataRiskLevel - description: >- - Score is a summary of all elements in the data profile. A higher number - means more risk. - type: object - properties: - score: + The name of the entity. A name matching regex `__.*__` is + reserved/read-only. A name must not be more than 1500 bytes when + UTF-8 encoded. Cannot be `""`. + kind: type: string - enum: - - RISK_SCORE_UNSPECIFIED - - RISK_LOW - - RISK_UNKNOWN - - RISK_MODERATE - - RISK_HIGH - enumDescriptions: - - Unused. - - >- - Low risk - Lower indication of sensitive data that appears to have - additional access restrictions in place or no indication of - sensitive data found. - - Unable to determine risk. - - >- - Medium risk - Sensitive data may be present but additional access - or fine grain access restrictions appear to be present. Consider - limiting access even further or transform data to mask. - - >- - High risk – SPII may be present. Access controls may include - public ACLs. Exfiltration of data may lead to user data loss. - Re-identification of users may be possible. Consider limiting - usage and or removing SPII. - description: The score applied to the resource. - GooglePrivacyDlpV2DetectionRule: - type: object + description: >- + The kind of the entity. A kind matching regex `__.*__` is + reserved/read-only. A kind must not contain more than 1500 bytes + when UTF-8 encoded. Cannot be `""`. + id: GooglePrivacyDlpV2PathElement description: >- - Deprecated; use `InspectionRuleSet` instead. Rule for modifying a - `CustomInfoType` to alter behavior under certain circumstances, - depending on the specific details of the rule. Not supported for the - `surrogate_type` custom infoType. - id: GooglePrivacyDlpV2DetectionRule - properties: - hotwordRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - description: Hotword-based detection rule. - GooglePrivacyDlpV2HybridFindingDetails: - id: GooglePrivacyDlpV2HybridFindingDetails - type: object + A (kind, ID/name) pair used to construct a key path. If either name or + ID is set, the element is complete. If neither is set, the element is + incomplete. + GooglePrivacyDlpV2TableDataProfile: properties: - fileOffset: - description: >- - Offset in bytes of the line, from the beginning of the file, where - the finding is located. Populate if the item being scanned is only - part of a bigger item, such as a shard of a file and you want to - track the absolute position of the finding. + projectDataProfile: + type: string + description: The resource name of the project data profile for this table. + tableSizeBytes: + description: The size of the table when the profile was generated. type: string format: int64 - labels: - additionalProperties: - type: string - description: >- - Labels to represent user provided metadata about the data being - inspected. If configured by the job, some key values may be - required. The labels associated with `Finding`'s produced by hybrid - inspection. Label keys must be between 1 and 63 characters long and - must conform to the following regular expression: - `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 - characters long and must conform to the regular expression - `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be - associated with a given finding. Examples: * `"environment" : - "production"` * `"pipeline" : "etl"` + resourceLabels: type: object - containerDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' description: >- - Details about the container where the content being inspected is - from. - tableOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + The labels applied to the resource at the time the profile was + generated. + additionalProperties: + type: string + name: + type: string + description: The name of the profile. + datasetId: + description: If the resource is BigQuery, the dataset ID. + type: string + datasetLocation: + type: string description: >- - If the container is a table, additional information to make findings - meaningful such as the columns that are primary keys. If not known - ahead of time, can also be set within each inspect hybrid call and - the two will be merged. Note that identifying_fields will only be - stored to BigQuery, and only if the BigQuery action has been - included. - rowOffset: + If supported, the location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + locations. + rowCount: format: int64 description: >- - Offset of the row for tables. Populate if the row(s) being scanned - are part of a bigger dataset and you want to keep track of their - absolute position. + Number of rows in the table when the profile was generated. This + will not be populated for BigLake tables. type: string - description: Populate to associate additional data with each finding. - GooglePrivacyDlpV2FieldTransformation: - description: The transformation to apply to the field. - properties: - primitiveTransformation: - description: Apply the transformation to the entire field. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - fields: - description: >- - Required. Input field(s) to apply the transformation to. When you - have columns that reference their position within a list, omit the - index from the FieldId. FieldId name matching ignores the index. For - example, instead of "contact.nums[0].type", use "contact.nums.type". - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - infoTypeTransformations: + configSnapshot: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + description: The snapshot of the configurations used to generate the profile. + profileStatus: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' description: >- - Treat the contents of the field as free text, and selectively - transform content that matches an `InfoType`. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - condition: + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + expirationTime: + format: google-datetime + type: string + description: Optional. The time when this table expires. + state: + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + description: State of a profile. + type: string + fullResource: description: >- - Only apply the transformation if the condition evaluates to true for - the given `RecordCondition`. The conditions are allowed to reference - fields that are not used in the actual transformation. Example Use - Cases: - Apply a different bucket transformation to an age column if - the zip code column for the same record is within a specific range. - - Redact a field if the date of birth field is greater than 85. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' - id: GooglePrivacyDlpV2FieldTransformation - type: object - GooglePrivacyDlpV2DatabaseResourceRegexes: - type: object - description: >- - A collection of regular expressions to determine what database resources - to match against. - properties: - patterns: + The resource name of the resource profiled. + https://cloud.google.com/apis/design/resource_names#full_resource_name + type: string + failedColumnCount: + format: int64 + description: The number of columns skipped in the table because of an error. + type: string + profileLastGenerated: + type: string + format: google-datetime + description: The last time the profile was generated. + encryptionStatus: + type: string + enumDescriptions: + - Unused. + - Google manages server-side encryption keys on your behalf. + - Customer provides the key. + description: How the table is encrypted. + enum: + - ENCRYPTION_STATUS_UNSPECIFIED + - ENCRYPTION_GOOGLE_MANAGED + - ENCRYPTION_CUSTOMER_MANAGED + createTime: + description: The time at which the table was created. + format: google-datetime + type: string + otherInfoTypes: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + description: Other infoTypes found in this table's data. type: array - description: >- - A group of regular expression patterns to match against one or more - database resources. Maximum of 100 entries. The sum of all regular - expression's length can't exceed 10 KiB. - id: GooglePrivacyDlpV2DatabaseResourceRegexes - GooglePrivacyDlpV2TableOptions: + resourceVisibility: + description: How broadly a resource has been shared. + enum: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + enumDescriptions: + - Unused. + - Visible to any user. + - >- + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. + type: string + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: The data risk level of this table. + dataSourceType: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + description: The resource type that was profiled. + datasetProjectId: + type: string + description: The Google Cloud project ID that owns the resource. + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: The sensitivity score of this table. + lastModifiedTime: + description: The time when this table was last modified + type: string + format: google-datetime + predictedInfoTypes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + description: The infoTypes predicted from this table's data. + type: array + tableId: + type: string + description: If the resource is BigQuery, the BigQuery table ID. + scannedColumnCount: + description: The number of columns profiled in the table. + format: int64 + type: string + id: GooglePrivacyDlpV2TableDataProfile type: object + description: The profile for a scanned table. + GooglePrivacyDlpV2NumericalStatsResult: + id: GooglePrivacyDlpV2NumericalStatsResult properties: - identifyingFields: + quantileValues: description: >- - The columns that are the primary keys for table objects included in - ContentItem. A copy of this cell's value will stored alongside - alongside each finding so that the finding can be traced to the - specific row it came from. No more than 3 may be provided. - type: array + List of 99 values that partition the set of field values into 100 + equal sized buckets. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - id: GooglePrivacyDlpV2TableOptions - description: Instructions regarding the table content being inspected. - GooglePrivacyDlpV2DiscoveryFileStoreConditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + type: array + minValue: + description: Minimum value appearing in the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + maxValue: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Maximum value appearing in the column. + description: Result of the numerical stats computation. + type: object + GooglePrivacyDlpV2PartitionId: + description: >- + Datastore partition ID. A partition ID identifies a grouping of + entities. The grouping is always by project and namespace, however the + namespace ID may be empty. A partition ID contains several dimensions: + project ID and namespace ID. + id: GooglePrivacyDlpV2PartitionId properties: - createdAfter: - format: google-datetime + namespaceId: + description: If not empty, the ID of the namespace to which the entities belong. type: string - description: >- - Optional. File store must have been created after this date. Used to - avoid backfilling. - minAge: - description: >- - Optional. Minimum age a file store must have. If set, the value must - be 1 hour or greater. + projectId: + description: The ID of the project to which the entities belong. type: string - format: google-duration - cloudStorageConditions: - description: Optional. Cloud Storage conditions. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageConditions - description: >- - Requirements that must be true before a file store is scanned in - discovery for the first time. There is an AND relationship between the - top-level attributes. type: object - id: GooglePrivacyDlpV2DiscoveryFileStoreConditions - GooglePrivacyDlpV2PathElement: + GooglePrivacyDlpV2DiscoveryTarget: properties: - id: + cloudSqlTarget: description: >- - The auto-allocated ID of the entity. Never equal to zero. Values - less than zero are discouraged and may not be supported in the - future. - format: int64 - type: string - kind: + Cloud SQL target for Discovery. The first target to match a table + will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' + secretsTarget: description: >- - The kind of the entity. A kind matching regex `__.*__` is - reserved/read-only. A kind must not contain more than 1500 bytes - when UTF-8 encoded. Cannot be `""`. - type: string - name: - type: string + Discovery target that looks for credentials and secrets stored in + cloud resource metadata and reports them as vulnerabilities to + Security Command Center. Only one target of this type is allowed. + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' + bigQueryTarget: description: >- - The name of the entity. A name matching regex `__.*__` is - reserved/read-only. A name must not be more than 1500 bytes when - UTF-8 encoded. Cannot be `""`. + BigQuery target for Discovery. The first target to match a table + will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' + cloudStorageTarget: + description: >- + Cloud Storage target for Discovery. The first target to match a + table will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageDiscoveryTarget' + type: object + id: GooglePrivacyDlpV2DiscoveryTarget + description: Target used to match against for Discovery. + GooglePrivacyDlpV2BigQueryRegexes: description: >- - A (kind, ID/name) pair used to construct a key path. If either name or - ID is set, the element is complete. If neither is set, the element is - incomplete. - id: GooglePrivacyDlpV2PathElement + A collection of regular expressions to determine what tables to match + against. + properties: + patterns: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' + type: array + description: >- + A single BigQuery regular expression pattern to match against one or + more tables, datasets, or projects that contain BigQuery tables. type: object - GooglePrivacyDlpV2DeidentifyContentRequest: + id: GooglePrivacyDlpV2BigQueryRegexes + GooglePrivacyDlpV2PubSubCondition: type: object - description: Request to de-identify a ContentItem. + id: GooglePrivacyDlpV2PubSubCondition properties: - inspectTemplateName: - description: >- - Template to use. Any configuration directly specified in - inspect_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - type: string - locationId: + minimumSensitivityScore: type: string - description: Deprecated. This field has no effect. - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: >- - Configuration for the inspector. Items specified here will override - the template referenced by the inspect_template_name argument. - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: >- - The item to de-identify. Will be treated as text. This value must be - of type Table if your deidentify_config is a RecordTransformations - object. - deidentifyTemplateName: + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + description: The minimum sensitivity level that triggers the condition. + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH + minimumRiskScore: + description: The minimum data risk score that triggers the condition. type: string - description: >- - Template to use. Any configuration directly specified in - deidentify_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - deidentifyConfig: - description: >- - Configuration for the de-identification of the content item. Items - specified here will override the template referenced by the - deidentify_template_name argument. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - id: GooglePrivacyDlpV2DeidentifyContentRequest - GooglePrivacyDlpV2InfoTypeLimit: + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH + description: A condition consisting of a value. + GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: + description: >- + Replaces an identifier with a surrogate using Format Preserving + Encryption (FPE) with the FFX mode of operation; however when used in + the `ReidentifyContent` API method, it serves the opposite function by + reversing the surrogate back into the original identifier. The + identifier must be encoded as ASCII. For a given crypto key and context, + the same identifier will be replaced with the same surrogate. + Identifiers must be at least two characters long. In the case that the + identifier is the empty string, it will be skipped. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + to learn more. Note: We recommend using CryptoDeterministicConfig for + all use cases which do not require preserving the input alphabet space + and size, plus warrant referential integrity. + type: object properties: - infoType: + customAlphabet: description: >- - Type of information the findings limit applies to. Only one limit - per info_type should be provided. If InfoTypeLimit does not have an - info_type, the DLP API applies the limit against all info_types that - are found but not specified in another InfoTypeLimit. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - maxFindings: + This is supported by mapping these to the alphanumeric characters + that the FFX mode natively supports. This happens before/after + encryption/decryption. Each character listed must appear only once. + Number of characters must be in the range [2, 95]. This must be + encoded as ASCII. The order of characters does not matter. The full + list of allowed characters is: + ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` + type: string + commonAlphabet: + description: Common alphabets. + enumDescriptions: + - Unused. + - '`[0-9]` (radix of 10)' + - '`[0-9A-F]` (radix of 16)' + - '`[0-9A-Z]` (radix of 36)' + - '`[0-9A-Za-z]` (radix of 62)' + type: string + enum: + - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED + - NUMERIC + - HEXADECIMAL + - UPPER_CASE_ALPHA_NUMERIC + - ALPHA_NUMERIC + context: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + The 'tweak', a context may be used for higher security since the + same identifier in two different contexts won't be given the same + surrogate. If the context is not set, a default tweak will be used. + If the context is set but: 1. there is no record present when + transforming a given value or 1. the field is not present when + transforming a given value, a default tweak will be used. Note that + case (1) is expected when an `InfoTypeTransformation` is applied to + both structured and unstructured `ContentItem`s. Currently, the + referenced field may be of value type integer or string. The tweak + is constructed as a sequence of bytes in big endian byte order such + that: - a 64 bit integer is encoded followed by a single byte of + value 1 - a string is encoded in UTF-8 format followed by a single + byte of value 2 + radix: format: int32 + description: The native way to select the alphabet. Must be in the range [2, 95]. type: integer - description: Max findings limit for the given infoType. - id: GooglePrivacyDlpV2InfoTypeLimit + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + description: Required. The key used by the encryption algorithm. + surrogateInfoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + The custom infoType to annotate the surrogate with. This annotation + will be applied to the surrogate by prefixing it with the name of + the custom infoType followed by the number of characters comprising + the surrogate. The following scheme defines the format: + info_type_name(surrogate_character_count):surrogate For example, if + the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the + surrogate is 'abc', the full replacement value will be: + 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate + when inspecting content using the custom infoType + [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). + This facilitates reversal of the surrogate when it occurs in free + text. In order for inspection to work properly, the name of this + infoType must not occur naturally anywhere in your data; otherwise, + inspection may find a surrogate that does not correspond to an + actual identifier. Therefore, choose your custom infoType name + carefully after considering what your data looks like. One way to + select a name that has a high chance of yielding reliable detection + is to include one or more unicode characters that are highly + improbable to exist in your data. For example, assuming your data is + entered from a regular ASCII keyboard, the symbol with the hex code + point 29DD might be used like so: ⧝MY_TOKEN_TYPE + id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig + GooglePrivacyDlpV2FileExtensionInfo: + id: GooglePrivacyDlpV2FileExtensionInfo + properties: + fileExtension: + type: string + description: The file extension if set. (aka .pdf, .jpg, .txt) + description: Information regarding the discovered file extension. type: object + GooglePrivacyDlpV2CharsToIgnore: description: >- - Max findings configuration per infoType, per content item or long - running DlpJob. - GooglePrivacyDlpV2CategoricalStatsHistogramBucket: - type: object + Characters to skip when doing deidentification of a value. These will be + left alone and skipped. + id: GooglePrivacyDlpV2CharsToIgnore properties: - valueFrequencyLowerBound: - format: int64 - description: Lower bound on the value frequency of the values in this bucket. + commonCharactersToIgnore: + description: >- + Common characters to not transform when masking. Useful to avoid + removing punctuation. type: string - bucketValueCount: - description: Total number of distinct values in this bucket. + enumDescriptions: + - Unused. + - 0-9 + - A-Z + - a-z + - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ + - Whitespace character, one of [ \t\n\x0B\f\r] + enum: + - COMMON_CHARS_TO_IGNORE_UNSPECIFIED + - NUMERIC + - ALPHA_UPPER_CASE + - ALPHA_LOWER_CASE + - PUNCTUATION + - WHITESPACE + charactersToSkip: + description: Characters to not transform when masking. type: string - format: int64 - bucketSize: - format: int64 + type: object + GooglePrivacyDlpV2Connection: + properties: + cloudSql: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' + description: Connect to a Cloud SQL instance. + state: + description: Required. The connection's state in its lifecycle. type: string - description: Total number of values in this bucket. - bucketValues: + enumDescriptions: + - Unused + - >- + DLP automatically created this connection during an initial scan, + and it is awaiting full configuration by a user. + - A configured connection that has not encountered any errors. + - >- + A configured connection that encountered errors during its last + use. It will not be used again until it is set to AVAILABLE. If + the resolution requires external action, then the client must send + a request to set the status to AVAILABLE when the connection is + ready for use. If the resolution doesn't require external action, + then any changes to the connection properties will automatically + mark it as AVAILABLE. + enum: + - CONNECTION_STATE_UNSPECIFIED + - MISSING_CREDENTIALS + - AVAILABLE + - ERROR + name: + description: >- + Output only. Name of the connection: + `projects/{project}/locations/{location}/connections/{name}`. + type: string + readOnly: true + errors: type: array + description: >- + Output only. Set if status == ERROR, to provide additional details. + Will store the last 10 errors sorted with the most recent first. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + readOnly: true + id: GooglePrivacyDlpV2Connection + description: >- + A data connection to allow DLP to profile data in locations that require + additional configuration. + type: object + GooglePrivacyDlpV2DatastoreKey: + description: Record key for a finding in Cloud Datastore. + properties: + entityKey: + description: Datastore entity key. + $ref: '#/components/schemas/GooglePrivacyDlpV2Key' + type: object + id: GooglePrivacyDlpV2DatastoreKey + GooglePrivacyDlpV2StoredInfoTypeStats: + type: object + id: GooglePrivacyDlpV2StoredInfoTypeStats + description: Statistics for a StoredInfoType. + properties: + largeCustomDictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' description: >- - Sample of value frequencies in this bucket. The total number of - values returned per bucket is capped at 20. - valueFrequencyUpperBound: - format: int64 - description: Upper bound on the value frequency of the values in this bucket. - type: string - id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket - description: Histogram of value frequencies in the column. - GooglePrivacyDlpV2Value: + StoredInfoType where findings are defined by a dictionary of + phrases. + GooglePrivacyDlpV2HybridFindingDetails: properties: - stringValue: - type: string - description: string - dayOfWeekValue: + rowOffset: type: string - enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - description: day of week - timestampValue: - format: google-datetime - description: timestamp - type: string - timeValue: - description: time of day - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' - description: date - booleanValue: - description: boolean - type: boolean - integerValue: + format: int64 + description: >- + Offset of the row for tables. Populate if the row(s) being scanned + are part of a bigger dataset and you want to keep track of their + absolute position. + containerDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' + description: >- + Details about the container where the content being inspected is + from. + labels: + additionalProperties: + type: string + type: object + description: >- + Labels to represent user provided metadata about the data being + inspected. If configured by the job, some key values may be + required. The labels associated with `Finding`'s produced by hybrid + inspection. Label keys must be between 1 and 63 characters long and + must conform to the following regular expression: + `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 + characters long and must conform to the regular expression + `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be + associated with a given finding. Examples: * `"environment" : + "production"` * `"pipeline" : "etl"` + fileOffset: type: string + description: >- + Offset in bytes of the line, from the beginning of the file, where + the finding is located. Populate if the item being scanned is only + part of a bigger item, such as a shard of a file and you want to + track the absolute position of the finding. format: int64 - description: integer - floatValue: - format: double - type: number - description: float - id: GooglePrivacyDlpV2Value + tableOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + description: >- + If the container is a table, additional information to make findings + meaningful such as the columns that are primary keys. If not known + ahead of time, can also be set within each inspect hybrid call and + the two will be merged. Note that identifying_fields will only be + stored to BigQuery, and only if the BigQuery action has been + included. + description: Populate to associate additional data with each finding. type: object + id: GooglePrivacyDlpV2HybridFindingDetails + GooglePrivacyDlpV2TransformationErrorHandling: description: >- - Set of primitive values supported by the system. Note that for the - purposes of inspection or transformation, the number of bytes considered - to comprise a 'Value' is based on its representation as a UTF-8 encoded - string. For example, if 'integer_value' is set to 123456789, the number - of bytes would be counted as 9, even though an int64 only holds up to 8 - bytes of data. - GooglePrivacyDlpV2DateTime: - id: GooglePrivacyDlpV2DateTime + How to handle transformation errors during de-identification. A + transformation error occurs when the requested transformation is + incompatible with the data. For example, trying to de-identify an IP + address using a `DateShift` transformation would result in a + transformation error, since date info cannot be extracted from an IP + address. Information about any incompatible transformations, and how + they were handled, is returned in the response as part of the + `TransformationOverviews`. + type: object properties: - dayOfWeek: - description: Day of week - enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - type: string - enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - timeZone: - $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' - description: Time zone - time: - description: Time of day - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - date: - description: >- - One or more of the following must be set. Must be a valid date or - time value. - $ref: '#/components/schemas/GoogleTypeDate' + leaveUntransformed: + $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' + description: Ignore errors + throwError: + description: Throw an error + $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' + id: GooglePrivacyDlpV2TransformationErrorHandling + GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: type: object - description: Message for a date time object. e.g. 2018-01-01, 5th August. - GooglePrivacyDlpV2InfoType: + properties: {} + description: >- + Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag + templates are applied to the resource that Cloud DLP scanned. Data + Catalog tag templates are stored in the same project and region where + the BigQuery table exists. For Cloud DLP to create and apply the tag + template, the Cloud DLP service agent must have the + `roles/datacatalog.tagTemplateOwner` permission on the project. The tag + template contains fields summarizing the results of the DlpJob. Any + field values previously written by another DlpJob are deleted. InfoType + naming patterns are strictly enforced when using this feature. Findings + are persisted in Data Catalog storage and are governed by + service-specific policies for Data Catalog. For more information, see + [Service Specific Terms](https://cloud.google.com/terms/service-terms). + Only a single instance of this action can be specified. This action is + allowed only if all resources being scanned are BigQuery tables. + Compatible with: Inspect + id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + GooglePrivacyDlpV2ListTableDataProfilesResponse: type: object - description: Type of information detected by the API. + description: List of profiles generated for a given organization or project. + id: GooglePrivacyDlpV2ListTableDataProfilesResponse properties: - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: >- - Optional custom sensitivity for this InfoType. This only applies to - data profiling. - name: - type: string - description: >- - Name of the information type. Either a name of your choosing when - creating a CustomInfoType, or one of the names listed at - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference - when specifying a built-in type. When sending Cloud DLP results to - Data Catalog, infoType names should conform to the pattern - `[A-Za-z0-9$_-]{1,64}`. - version: - description: Optional version name for this InfoType. + tableDataProfiles: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + description: List of data profiles. + nextPageToken: + description: The next page token. type: string - id: GooglePrivacyDlpV2InfoType - GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: - type: object - description: Request message for CreateDeidentifyTemplate. - id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + GooglePrivacyDlpV2ProjectDataProfile: + id: GooglePrivacyDlpV2ProjectDataProfile properties: - locationId: - description: Deprecated. This field has no effect. + tableDataProfileCount: type: string - templateId: - description: >- - The template id can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. + format: int64 + description: The number of table data profiles generated for this project. + profileLastGenerated: type: string - deidentifyTemplate: - description: Required. The DeidentifyTemplate to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - GooglePrivacyDlpV2TableReference: - type: object - id: GooglePrivacyDlpV2TableReference - properties: - datasetId: - description: Dataset ID of the table. + format: google-datetime + description: The last time the profile was generated. + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: The data risk level of this project. + fileStoreDataProfileCount: type: string - tableId: - description: Name of the table. + format: int64 + description: The number of file store data profiles generated for this project. + profileStatus: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + description: Success or error status of the last attempt to profile the project. + name: + description: The resource name of the profile. type: string + sensitivityScore: + description: The sensitivity score of this project. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + projectId: + description: Project ID or account that was profiled. + type: string + type: object description: >- - Message defining the location of a BigQuery table with the projectId - inferred from the parent project. - GooglePrivacyDlpV2DiscoveryCloudSqlFilter: - description: >- - Determines what tables will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID, location, instance, database, and - database resource name. + An aggregated profile for this project, based on the resources profiled + within it. + GooglePrivacyDlpV2Trigger: type: object + description: What event needs to occur for a new job to be started. + id: GooglePrivacyDlpV2Trigger properties: - collection: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' - description: A specific set of database resources for this filter to apply to. - databaseResourceReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' + manual: + $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' description: >- - The database resource to scan. Targets including this can only - include one target (the target with this database resource - reference). - others: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherDatabaseResources' - description: >- - Catch-all. This should always be the last target in the list because - anything above it will apply first. Should only appear once in a - configuration. If none is specified, a default one will be added - automatically. - id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter - GooglePrivacyDlpV2CategoricalStatsConfig: - description: >- - Compute numerical stats over an individual column, including number of - distinct values and value count distribution. - type: object + For use with hybrid jobs. Jobs must be manually created and + finished. + schedule: + description: Create a job on a repeating basis based on the elapse of time. + $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' + GooglePrivacyDlpV2HotwordRule: + id: GooglePrivacyDlpV2HotwordRule properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + proximity: + $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' description: >- - Field to compute categorical stats on. All column types are - supported except for arrays and structs. However, it may be more - informative to use NumericalStats when the field type is supported, - depending on the data. - id: GooglePrivacyDlpV2CategoricalStatsConfig - GooglePrivacyDlpV2ActivateJobTriggerRequest: - description: Request message for ActivateJobTrigger. - properties: {} + Range of characters within which the entire hotword must reside. The + total length of the window cannot exceed 1000 characters. The + finding itself will be included in the window, so that hotwords can + be used to match substrings of the finding itself. Suppose you want + Cloud DLP to promote the likelihood of the phone number regex + "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area + code of a company's office. In this case, use the hotword regex + "\(xxx\)", where "xxx" is the area code in question. For tabular + data, if you want to modify the likelihood of an entire column of + findngs, see [Hotword example: Set the match likelihood of a table + column] + (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + likelihoodAdjustment: + $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' + description: Likelihood adjustment to apply to all matching findings. + hotwordRegex: + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + description: Regular expression pattern defining what qualifies as a hotword. type: object - id: GooglePrivacyDlpV2ActivateJobTriggerRequest - GooglePrivacyDlpV2HybridContentItem: description: >- - An individual hybrid item to inspect. Will be stored temporarily during - processing. - properties: - findingDetails: - description: Supplementary information that will be added to each finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' - item: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - id: GooglePrivacyDlpV2HybridContentItem + The rule that adjusts the likelihood of findings within a certain + proximity of hotwords. + GooglePrivacyDlpV2OtherInfoTypeSummary: + description: Infotype details for other infoTypes found within a column. type: object - GooglePrivacyDlpV2FileStoreInfoTypeSummary: - description: Information regarding the discovered InfoType. properties: infoType: $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The InfoType seen. - type: object - id: GooglePrivacyDlpV2FileStoreInfoTypeSummary - GooglePrivacyDlpV2ListConnectionsResponse: + description: The other infoType. + estimatedPrevalence: + type: integer + description: >- + Approximate percentage of non-null rows that contained data detected + by this infotype. + format: int32 + excludedFromAnalysis: + type: boolean + description: >- + Whether this infoType was excluded from sensitivity and risk + analysis due to factors such as low prevalence (subject to change). + id: GooglePrivacyDlpV2OtherInfoTypeSummary + GooglePrivacyDlpV2AllInfoTypes: type: object - description: Response message for ListConnections. - id: GooglePrivacyDlpV2ListConnectionsResponse + description: Apply transformation to all findings. + id: GooglePrivacyDlpV2AllInfoTypes + properties: {} + GooglePrivacyDlpV2ReidentifyContentRequest: properties: - nextPageToken: + inspectConfig: + description: Configuration for the inspector. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: The item to re-identify. Will be treated as text. + reidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + description: >- + Configuration for the re-identification of the content item. This + field shares the same proto message type that is used for + de-identification, however its usage here is for the reversal of the + previous de-identification. Re-identification is performed by + examining the transformations used to de-identify the items and + executing the reverse. This requires that only reversible + transformations be provided here. The reversible transformations + are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` + locationId: + description: Deprecated. This field has no effect. + type: string + inspectTemplateName: type: string description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. - connections: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: List of connections. - type: array - GooglePrivacyDlpV2ReplaceDictionaryConfig: + Template to use. Any configuration directly specified in + `inspect_config` will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + reidentifyTemplateName: + description: >- + Template to use. References an instance of `DeidentifyTemplate`. Any + configuration directly specified in `reidentify_config` or + `inspect_config` will override those set in the template. The + `DeidentifyTemplate` used must include only reversible + transformations. Singular fields that are set in this request will + replace their corresponding fields in the template. Repeated fields + are appended. Singular sub-messages and groups are recursively + merged. + type: string + description: Request to re-identify an item. + id: GooglePrivacyDlpV2ReidentifyContentRequest + type: object + GooglePrivacyDlpV2Value: type: object - id: GooglePrivacyDlpV2ReplaceDictionaryConfig properties: - wordList: - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' - description: >- - A list of words to select from for random replacement. The - [limits](https://cloud.google.com/sensitive-data-protection/limits) - page contains details about the size limits of dictionaries. + integerValue: + description: integer + type: string + format: int64 + dayOfWeekValue: + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + type: string + description: day of week + floatValue: + type: number + description: float + format: double + stringValue: + type: string + description: string + timestampValue: + format: google-datetime + description: timestamp + type: string + dateValue: + $ref: '#/components/schemas/GoogleTypeDate' + description: date + booleanValue: + type: boolean + description: boolean + timeValue: + description: time of day + $ref: '#/components/schemas/GoogleTypeTimeOfDay' description: >- - Replace each input value with a value randomly selected from the - dictionary. - GooglePrivacyDlpV2Key: + Set of primitive values supported by the system. Note that for the + purposes of inspection or transformation, the number of bytes considered + to comprise a 'Value' is based on its representation as a UTF-8 encoded + string. For example, if 'integer_value' is set to 123456789, the number + of bytes would be counted as 9, even though an int64 only holds up to 8 + bytes of data. + id: GooglePrivacyDlpV2Value + GooglePrivacyDlpV2DataProfileLocation: + id: GooglePrivacyDlpV2DataProfileLocation properties: - path: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' - type: array - description: >- - The entity path. An entity path consists of one or more elements - composed of a kind and a string or numerical identifier, which - identify entities. The first element identifies a _root entity_, the - second element identifies a _child_ of the root entity, the third - element identifies a child of the second entity, and so forth. The - entities identified by all prefixes of the path are called the - element's _ancestors_. A path can never be empty, and a path can - have at most 100 elements. - partitionId: - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' - description: >- - Entities are partitioned into subsets, currently identified by a - project ID and namespace ID. Queries are scoped to a single - partition. - description: >- - A unique identifier for a Datastore entity. If a key's partition ID or - any of its path kinds or names are reserved/read-only, the key is - reserved/read-only. A reserved/read-only key is forbidden in certain - documented contexts. + folderId: + type: string + format: int64 + description: The ID of the folder within an organization to scan. + organizationId: + description: The ID of an organization to scan. + format: int64 + type: string + description: The data that will be profiled. type: object - id: GooglePrivacyDlpV2Key - GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: - description: Result of a risk analysis operation request. - id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails + GooglePrivacyDlpV2DeidentifyContentRequest: + description: Request to de-identify a ContentItem. type: object + id: GooglePrivacyDlpV2DeidentifyContentRequest properties: - requestedPrivacyMetric: - description: Privacy metric to compute. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - categoricalStatsResult: - description: Categorical stats result - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' - deltaPresenceEstimationResult: - description: Delta-presence result - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' - lDiversityResult: - description: L-divesity result - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' - requestedSourceTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Input dataset to compute metrics over. - numericalStatsResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' - description: Numerical stats result - kMapEstimationResult: - description: K-map result - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' - requestedOptions: - description: The configuration used for this job. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' - kAnonymityResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' - description: K-anonymity result - GooglePrivacyDlpV2HybridInspectJobTriggerRequest: - description: Request to search for potentially sensitive info in a custom location. - type: object - properties: - hybridItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - description: The item to inspect. - id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest - GooglePrivacyDlpV2FindingLimits: - description: >- - Configuration to control the number of findings returned for inspection. - This is not used for de-identification or data profiling. When redacting - sensitive data from images, finding limits don't apply. They can cause - unexpected or inconsistent results, where only some data is redacted. - Don't include finding limits in RedactImage requests. Otherwise, Cloud - DLP returns an error. - type: object - properties: - maxFindingsPerItem: - format: int32 - type: integer + locationId: + type: string + description: Deprecated. This field has no effect. + deidentifyConfig: description: >- - Max number of findings that are returned for each item scanned. When - set within an InspectContentRequest, this field is ignored. This - value isn't a hard limit. If the number of findings for an item - reaches this limit, the inspection of that item ends gradually, not - abruptly. Therefore, the actual number of findings that Cloud DLP - returns for the item can be multiple times higher than this value. - maxFindingsPerInfoType: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' - description: Configuration of findings limit given for specified infoTypes. - maxFindingsPerRequest: - type: integer - format: int32 + Configuration for the de-identification of the content item. Items + specified here will override the template referenced by the + deidentify_template_name argument. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + inspectTemplateName: description: >- - Max number of findings that are returned per request or job. If you - set this field in an InspectContentRequest, the resulting maximum - value is the value that you set or 3,000, whichever is lower. This - value isn't a hard limit. If an inspection reaches this limit, the - inspection ends gradually, not abruptly. Therefore, the actual - number of findings that Cloud DLP returns can be multiple times - higher than this value. - id: GooglePrivacyDlpV2FindingLimits - GooglePrivacyDlpV2ThrowError: - description: Throw an error and fail the request when a transformation error occurs. - type: object - properties: {} - id: GooglePrivacyDlpV2ThrowError - GooglePrivacyDlpV2EntityId: - type: object - properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Composite key indicating which field contains the entity identifier. - id: GooglePrivacyDlpV2EntityId - description: >- - An entity in a dataset is a field or set of fields that correspond to a - single person. For example, in medical records the `EntityId` might be a - patient identifier, or for financial records it might be an account - identifier. This message is used when generalizations or analysis must - take into account that multiple rows correspond to the same entity. - GooglePrivacyDlpV2BigQueryRegexes: - description: >- - A collection of regular expressions to determine what tables to match - against. - id: GooglePrivacyDlpV2BigQueryRegexes - type: object - properties: - patterns: + Template to use. Any configuration directly specified in + inspect_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + type: string + deidentifyTemplateName: description: >- - A single BigQuery regular expression pattern to match against one or - more tables, datasets, or projects that contain BigQuery tables. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' - GooglePrivacyDlpV2CryptoHashConfig: - type: object - properties: - cryptoKey: - description: The key used by the hash function. - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - id: GooglePrivacyDlpV2CryptoHashConfig - description: >- - Pseudonymization method that generates surrogates via cryptographic - hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. - Outputs a base64 encoded representation of the hashed output (for - example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only - string and integer values can be hashed. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization - to learn more. - GooglePrivacyDlpV2StorageConfig: - description: Shared message indicating Cloud storage type. - type: object - properties: - timespanConfig: - description: Configuration of the timespan of the items to include in scanning. - $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' - bigQueryOptions: - description: BigQuery options. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' - hybridOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' - description: Hybrid inspection options. - cloudStorageOptions: - description: Cloud Storage options. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' - datastoreOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' - description: Google Cloud Datastore options. - id: GooglePrivacyDlpV2StorageConfig - GooglePrivacyDlpV2RecordTransformations: - description: >- - A type of transformation that is applied over structured data such as a - table. - id: GooglePrivacyDlpV2RecordTransformations + Template to use. Any configuration directly specified in + deidentify_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + type: string + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: >- + The item to de-identify. Will be treated as text. This value must be + of type Table if your deidentify_config is a RecordTransformations + object. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: >- + Configuration for the inspector. Items specified here will override + the template referenced by the inspect_template_name argument. + GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: type: object + description: The cadence at which to update data profiles when a schema is modified. properties: - fieldTransformations: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' - description: Transform the record by applying various field transformations. - recordSuppressions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + types: description: >- - Configuration defining which records get suppressed entirely. - Records that match any suppression rule are omitted from the output. + The type of events to consider when deciding if the table's schema + has been modified and should have the profile updated. Defaults to + NEW_COLUMNS. type: array - GooglePrivacyDlpV2DiscoveryGenerationCadence: - id: GooglePrivacyDlpV2DiscoveryGenerationCadence - properties: - tableModifiedCadence: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' - description: Governs when to update data profiles when a table is modified. - refreshFrequency: + items: + enum: + - SCHEMA_MODIFICATION_UNSPECIFIED + - SCHEMA_NEW_COLUMNS + - SCHEMA_REMOVED_COLUMNS + type: string + enumDescriptions: + - Unused + - >- + Profiles should be regenerated when new columns are added to the + table. Default. + - >- + Profiles should be regenerated when columns are removed from the + table. + frequency: enumDescriptions: - Unspecified. - After the data profile is created, it will never be updated. - The data profile can be updated up to once every 24 hours. - The data profile can be updated up to once every 30 days. Default. description: >- - Frequency at which profiles should be updated, regardless of whether - the underlying resource has changed. Defaults to never. + How frequently profiles may be updated when schemas are modified. + Defaults to monthly. + type: string enum: - UPDATE_FREQUENCY_UNSPECIFIED - UPDATE_FREQUENCY_NEVER - UPDATE_FREQUENCY_DAILY - UPDATE_FREQUENCY_MONTHLY - type: string - schemaModifiedCadence: - description: Governs when to update data profiles when a schema is modified. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - inspectTemplateModifiedCadence: - description: >- - Governs when to update data profiles when the inspection rules - defined by the `InspectTemplate` change. If not set, changing the - template will not cause a data profile to update. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - description: >- - What must take place for a profile to be updated and how frequently it - should occur. New tables are scanned as quickly as possible depending on - system capacity. - type: object - GooglePrivacyDlpV2BigQueryOptions: + id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + GooglePrivacyDlpV2FileStoreDataProfile: type: object - description: Options defining BigQuery table and row identifiers. + id: GooglePrivacyDlpV2FileStoreDataProfile properties: - identifyingFields: - description: >- - Table fields that may uniquely identify a row within the table. When - `actions.saveFindings.outputConfig.table` is specified, the values - of columns specified here are available in the output table under - `location.content_locations.record_location.record_key.id_values`. - Nested fields such as `person.birthdate.year` are allowed. + fileClusterSummaries: + description: FileClusterSummary per each cluster. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Complete BigQuery table reference. - includedFields: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Limit scanning only to these fields. When inspecting a table, we - recommend that you inspect all columns. Otherwise, findings might be - affected because hints from excluded columns will not be used. - type: array - rowsLimit: - format: int64 - type: string - description: >- - Max number of rows to scan. If the table has more rows than this - value, the rest of the rows are omitted. If not set, or if set to 0, - all rows will be scanned. Only one of rows_limit and - rows_limit_percent can be specified. Cannot be used in conjunction - with TimespanConfig. - sampleMethod: - enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START - enumDescriptions: - - No sampling. - - >- - Scan groups of rows in the order BigQuery provides (default). - Multiple groups of rows may be scanned in parallel, so results may - not appear in the same order the rows are read. - - Randomly pick groups of rows to scan. - description: How to sample the data. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterSummary' + fileStorePath: + description: 'The file store path. * Cloud Storage: `gs://{bucket}`' type: string - excludedFields: - description: >- - References to fields excluded from scanning. This allows you to skip - inspection of entire columns which you know have no findings. When - inspecting a table, we recommend that you inspect all columns. - Otherwise, findings might be affected because hints from excluded - columns will not be used. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - rowsLimitPercent: - description: >- - Max percentage of rows to scan. The rest are omitted. The number of - rows scanned is rounded down. Must be between 0 and 100, - inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one - of rows_limit and rows_limit_percent can be specified. Cannot be - used in conjunction with TimespanConfig. Caution: A [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) - is causing the `rowsLimitPercent` field to behave unexpectedly. We - recommend using `rowsLimit` instead. - format: int32 - type: integer - id: GooglePrivacyDlpV2BigQueryOptions - GooglePrivacyDlpV2TagCondition: - type: object - properties: - tag: - description: The tag value to attach to resources. - $ref: '#/components/schemas/GooglePrivacyDlpV2TagValue' - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: >- - Conditions attaching the tag to a resource on its profile having - this sensitivity score. - id: GooglePrivacyDlpV2TagCondition - description: >- - The tag to attach to profiles matching the condition. At most one - `TagCondition` can be specified per sensitivity level. - GooglePrivacyDlpV2DatastoreOptions: - description: Options defining a data set within Google Cloud Datastore. - properties: - kind: - description: The kind to process. - $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' - partitionId: - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' - description: >- - A partition ID identifies a grouping of entities. The grouping is - always by project and namespace, however the namespace ID may be - empty. - id: GooglePrivacyDlpV2DatastoreOptions - type: object - GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: - properties: {} - type: object - id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig - description: Replace each matching finding with the name of the info_type. - GooglePrivacyDlpV2CloudStorageRegex: - description: >- - A pattern to match against one or more file stores. At least one pattern - must be specified. Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - id: GooglePrivacyDlpV2CloudStorageRegex - properties: - projectIdRegex: + configSnapshot: + description: The snapshot of the configurations used to generate the profile. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + name: + description: The name of the profile. type: string - description: Optional. For organizations, if unset, will match all projects. - bucketNameRegex: + createTime: + description: The time the file store was first created. + format: google-datetime type: string - description: >- - Optional. Regex to test the bucket name against. If empty, all - buckets match. Example: "marketing2021" or "(marketing)\d{4}" will - both match the bucket gs://marketing2021 - type: object - GooglePrivacyDlpV2TransformationDetails: - properties: - transformation: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' - type: array - description: >- - Description of transformation. This would only contain more than one - element if there were multiple matching transformations and which - one to apply was ambiguous. Not set for states that contain no - transformation, currently only state that contains no transformation - is TransformationResultStateType.METADATA_UNRETRIEVABLE. - transformationLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' - description: >- - The precise location of the transformed content in the original - container. - resourceName: - description: The name of the job that completed the transformation. + locationType: type: string - containerName: description: >- - The top level name of the container where the transformation is - located (this will be the source file name or table name). + The location type of the bucket (region, dual-region, multi-region, + etc). If dual-region, expect data_storage_locations to be populated. + sensitivityScore: + description: The sensitivity score of this resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + projectId: type: string - statusDetails: + description: The Google Cloud project ID that owns the resource. + fullResource: description: >- - Status of the transformation, if transformation was not successful, - this will specify what caused it to fail, otherwise it will show - that the transformation was successful. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' - transformedBytes: - format: int64 + The resource name of the resource profiled. + https://cloud.google.com/apis/design/resource_names#full_resource_name + type: string + fileStoreInfoTypeSummaries: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' + description: InfoTypes detected in this file store. + profileStatus: description: >- - The number of bytes that were transformed. If transformation was - unsuccessful or did not take place because there was no content to - transform, this will be zero. + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + dataRiskLevel: + description: The data risk level of this resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + lastModifiedTime: + description: The time the file store was last modified. type: string - type: object - description: >- - Details about a single transformation. This object contains a - description of the transformation, information about whether the - transformation was successfully applied, and the precise location where - the transformation occurred. These details are stored in a - user-specified BigQuery table. - id: GooglePrivacyDlpV2TransformationDetails - GooglePrivacyDlpV2WordList: - properties: - words: + format: google-datetime + dataStorageLocations: + type: array description: >- - Words or phrases defining the dictionary. The dictionary must - contain at least one phrase and every phrase must contain at least 2 - characters that are letters or digits. [required] + For resources that have multiple storage locations, these are those + regions. For Cloud Storage this is the list of regions chosen for + dual-region storage. `file_store_location` will normally be the + corresponding multi-region for the list of individual locations. The + first region is always picked as the processing and storage location + for the data profile. items: type: string - type: array - id: GooglePrivacyDlpV2WordList - type: object - description: Message defining a list of words or phrases to search for in the data. - GooglePrivacyDlpV2DatabaseResourceReference: - type: object - description: Identifies a single database resource, like a table within a database. - id: GooglePrivacyDlpV2DatabaseResourceReference - properties: - instance: + fileStoreLocation: description: >- - Required. The instance where this resource is located. For example: - Cloud SQL instance ID. + The location of the file store. * Cloud Storage: + https://cloud.google.com/storage/docs/locations#available-locations type: string - database: - description: Required. Name of a database within the instance. + profileLastGenerated: + format: google-datetime type: string - databaseResource: + description: The last time the profile was generated. + dataSourceType: + description: The resource type that was profiled. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + resourceVisibility: + enum: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + enumDescriptions: + - Unused. + - Visible to any user. + - >- + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. + description: How broadly a resource has been shared. type: string + resourceLabels: description: >- - Required. Name of a database resource, for example, a table within - the database. - projectId: + The labels applied to the resource at the time the profile was + generated. + type: object + additionalProperties: + type: string + state: type: string + description: State of a profile. + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + resourceAttributes: + additionalProperties: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: >- - Required. If within a project-level config, then this must match the - config's project ID. - GooglePrivacyDlpV2CancelDlpJobRequest: - type: object - id: GooglePrivacyDlpV2CancelDlpJobRequest - description: The request message for canceling a DLP job. - properties: {} - GooglePrivacyDlpV2OrConditions: - id: GooglePrivacyDlpV2OrConditions - type: object - description: >- - There is an OR relationship between these attributes. They are used to - determine if a table should be scanned or not in Discovery. - properties: - minAge: + Attributes of the resource being profiled. Currently used + attributes: * customer_managed_encryption: boolean - true: the + resource is encrypted with a customer-managed key. - false: the + resource is encrypted with a provider-managed key. + type: object + projectDataProfile: type: string + description: The resource name of the project data profile for this file store. + fileStoreIsEmpty: + description: The file store does not have any files. + type: boolean + description: 'The profile for a file store. * Cloud Storage: maps 1:1 with a bucket.' + GooglePrivacyDlpV2DateShiftConfig: + properties: + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' description: >- - Minimum age a table must have before Cloud DLP can profile it. Value - must be 1 hour or greater. - format: google-duration - minRowCount: + Causes the shift to be computed based on this key and the context. + This results in the same shift for the same context and crypto_key. + If set, must also set context. Can only be applied to table items. + context: description: >- - Minimum number of rows that should be present before Cloud DLP - profiles a table + Points to the field that contains the context, for example, an + entity id. If set, must also set cryptoKey. If set, shift will be + consistent for the given context. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + upperBoundDays: + type: integer format: int32 + description: >- + Required. Range of shift in days. Actual shift will be selected at + random within this range (inclusive ends). Negative means shift to + earlier in time. Must not be more than 365250 days (1000 years) each + direction. For example, 3 means shift date to at most 3 days into + the future. + lowerBoundDays: + description: >- + Required. For example, -5 means shift date to at most 5 days back in + the past. type: integer - GooglePrivacyDlpV2CloudStoragePath: - id: GooglePrivacyDlpV2CloudStoragePath + format: int32 + description: >- + Shifts dates by random number of days, with option to be consistent for + the same context. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting + to learn more. + id: GooglePrivacyDlpV2DateShiftConfig type: object - properties: - path: - type: string - description: >- - A URL representing a file or path (no wildcards) in Cloud Storage. - Example: `gs://[BUCKET_NAME]/dictionary.txt` - description: Message representing a single file or path in Cloud Storage. - GooglePrivacyDlpV2SelectedInfoTypes: + GooglePrivacyDlpV2InspectContentRequest: + id: GooglePrivacyDlpV2InspectContentRequest type: object - id: GooglePrivacyDlpV2SelectedInfoTypes - description: Apply transformation to the selected info_types. - properties: - infoTypes: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - Required. InfoTypes to apply the transformation to. Required. - Provided InfoType must be unique within the ImageTransformations - message. - type: array - GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: properties: - commonAlphabet: + locationId: + description: Deprecated. This field has no effect. type: string - enum: - - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED - - NUMERIC - - HEXADECIMAL - - UPPER_CASE_ALPHA_NUMERIC - - ALPHA_NUMERIC - description: Common alphabets. - enumDescriptions: - - Unused. - - '`[0-9]` (radix of 10)' - - '`[0-9A-F]` (radix of 16)' - - '`[0-9A-Z]` (radix of 36)' - - '`[0-9A-Za-z]` (radix of 62)' - customAlphabet: + item: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + inspectConfig: description: >- - This is supported by mapping these to the alphanumeric characters - that the FFX mode natively supports. This happens before/after - encryption/decryption. Each character listed must appear only once. - Number of characters must be in the range [2, 95]. This must be - encoded as ASCII. The order of characters does not matter. The full - list of allowed characters is: - ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` + Configuration for the inspector. What specified here will override + the template referenced by the inspect_template_name argument. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + inspectTemplateName: type: string - surrogateInfoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - The custom infoType to annotate the surrogate with. This annotation - will be applied to the surrogate by prefixing it with the name of - the custom infoType followed by the number of characters comprising - the surrogate. The following scheme defines the format: - info_type_name(surrogate_character_count):surrogate For example, if - the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the - surrogate is 'abc', the full replacement value will be: - 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate - when inspecting content using the custom infoType - [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). - This facilitates reversal of the surrogate when it occurs in free - text. In order for inspection to work properly, the name of this - infoType must not occur naturally anywhere in your data; otherwise, - inspection may find a surrogate that does not correspond to an - actual identifier. Therefore, choose your custom infoType name - carefully after considering what your data looks like. One way to - select a name that has a high chance of yielding reliable detection - is to include one or more unicode characters that are highly - improbable to exist in your data. For example, assuming your data is - entered from a regular ASCII keyboard, the symbol with the hex code - point 29DD might be used like so: ⧝MY_TOKEN_TYPE - radix: - format: int32 - type: integer - description: The native way to select the alphabet. Must be in the range [2, 95]. - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - description: Required. The key used by the encryption algorithm. - context: description: >- - The 'tweak', a context may be used for higher security since the - same identifier in two different contexts won't be given the same - surrogate. If the context is not set, a default tweak will be used. - If the context is set but: 1. there is no record present when - transforming a given value or 1. the field is not present when - transforming a given value, a default tweak will be used. Note that - case (1) is expected when an `InfoTypeTransformation` is applied to - both structured and unstructured `ContentItem`s. Currently, the - referenced field may be of value type integer or string. The tweak - is constructed as a sequence of bytes in big endian byte order such - that: - a 64 bit integer is encoded followed by a single byte of - value 1 - a string is encoded in UTF-8 format followed by a single - byte of value 2 - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - type: object - id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig - description: >- - Replaces an identifier with a surrogate using Format Preserving - Encryption (FPE) with the FFX mode of operation; however when used in - the `ReidentifyContent` API method, it serves the opposite function by - reversing the surrogate back into the original identifier. The - identifier must be encoded as ASCII. For a given crypto key and context, - the same identifier will be replaced with the same surrogate. - Identifiers must be at least two characters long. In the case that the - identifier is the empty string, it will be skipped. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization - to learn more. Note: We recommend using CryptoDeterministicConfig for - all use cases which do not require preserving the input alphabet space - and size, plus warrant referential integrity. - GooglePrivacyDlpV2Range: + Template to use. Any configuration directly specified in + inspect_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + description: Request to search for potentially sensitive info in a ContentItem. + GooglePrivacyDlpV2CreateInspectTemplateRequest: properties: - start: - description: Index of the first character of the range (inclusive). + inspectTemplate: + description: Required. The InspectTemplate to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + templateId: + description: >- + The template id can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - format: int64 - end: - description: Index of the last character of the range (exclusive). - format: int64 + locationId: type: string - description: Generic half-open interval [start, end) - id: GooglePrivacyDlpV2Range + description: Deprecated. This field has no effect. type: object - GooglePrivacyDlpV2FileStoreRegexes: - id: GooglePrivacyDlpV2FileStoreRegexes - description: >- - A collection of regular expressions to determine what file store to - match against. + id: GooglePrivacyDlpV2CreateInspectTemplateRequest + description: Request message for CreateInspectTemplate. + GooglePrivacyDlpV2TransformationDetails: + id: GooglePrivacyDlpV2TransformationDetails type: object properties: - patterns: + transformation: description: >- - Required. The group of regular expression patterns to match against - one or more file stores. Maximum of 100 entries. The sum of all - regular expression's length can't exceed 10 KiB. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegex' + Description of transformation. This would only contain more than one + element if there were multiple matching transformations and which + one to apply was ambiguous. Not set for states that contain no + transformation, currently only state that contains no transformation + is TransformationResultStateType.METADATA_UNRETRIEVABLE. type: array - GooglePrivacyDlpV2ListStoredInfoTypesResponse: - id: GooglePrivacyDlpV2ListStoredInfoTypesResponse - description: Response message for ListStoredInfoTypes. - type: object - properties: - nextPageToken: - description: >- - If the next page is available then the next page token to be used in - the following ListStoredInfoTypes request. - type: string - storedInfoTypes: - description: >- - List of storedInfoTypes, up to page_size in - ListStoredInfoTypesRequest. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' - type: array - GooglePrivacyDlpV2Container: - properties: - updateTime: - format: google-datetime + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' + statusDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' description: >- - Findings container modification timestamp, if applicable. For Cloud - Storage, this field contains the last file modification timestamp. - For a BigQuery table, this field contains the last_modified_time - property. For Datastore, this field isn't populated. + Status of the transformation, if transformation was not successful, + this will specify what caused it to fail, otherwise it will show + that the transformation was successful. + transformedBytes: + format: int64 type: string - version: description: >- - Findings container version, if available ("generation" for Cloud - Storage). - type: string - rootPath: - description: >- - The root of the container. Examples: - For BigQuery table - `project_id:dataset_id.table_id`, the root is `dataset_id` - For - Cloud Storage file `gs://bucket/folder/filename.txt`, the root is - `gs://bucket` + The number of bytes that were transformed. If transformation was + unsuccessful or did not take place because there was no content to + transform, this will be zero. + resourceName: + description: The name of the job that completed the transformation. type: string - projectId: - description: >- - Project where the finding was found. Can be different from the - project that owns the finding. + containerName: type: string - relativePath: description: >- - The rest of the path after the root. Examples: - For BigQuery table - `project_id:dataset_id.table_id`, the relative path is `table_id` - - For Cloud Storage file `gs://bucket/folder/filename.txt`, the - relative path is `folder/filename.txt` + The top level name of the container where the transformation is + located (this will be the source file name or table name). + transformationLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' + description: >- + The precise location of the transformed content in the original + container. + description: >- + Details about a single transformation. This object contains a + description of the transformation, information about whether the + transformation was successfully applied, and the precise location where + the transformation occurred. These details are stored in a + user-specified BigQuery table. + GooglePrivacyDlpV2BigQueryRegex: + type: object + description: >- + A pattern to match against one or more tables, datasets, or projects + that contain BigQuery tables. At least one pattern must be specified. + Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + properties: + tableIdRegex: type: string - type: + description: If unset, this property matches all tables. + datasetIdRegex: type: string - description: Container type, for example BigQuery or Cloud Storage. - fullPath: + description: If unset, this property matches all datasets. + projectIdRegex: type: string description: >- - A string representation of the full container name. Examples: - - BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: - 'gs://Bucket/folders/filename.txt' - type: object - id: GooglePrivacyDlpV2Container + For organizations, if unset, will match all projects. Has no effect + for data profile configurations created within a project. + id: GooglePrivacyDlpV2BigQueryRegex + GooglePrivacyDlpV2KmsWrappedCryptoKey: description: >- - Represents a container that may contain DLP findings. Examples of a - container include a file, table, or database record. - GooglePrivacyDlpV2FileStoreRegex: - id: GooglePrivacyDlpV2FileStoreRegex - description: A pattern to match against one or more file stores. + Include to use an existing data crypto key wrapped by KMS. The wrapped + key must be a 128-, 192-, or 256-bit key. Authorization requires the + following IAM permissions when sending a request to perform a crypto + transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more + information, see [Creating a wrapped key] + (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). + Note: When you use Cloud KMS for cryptographic operations, [charges + apply](https://cloud.google.com/kms/pricing). properties: - cloudStorageRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegex' - description: Optional. Regex for Cloud Storage. + cryptoKeyName: + type: string + description: >- + Required. The resource name of the KMS CryptoKey to use for + unwrapping. + wrappedKey: + type: string + description: Required. The wrapped data crypto key. + format: byte + type: object + id: GooglePrivacyDlpV2KmsWrappedCryptoKey + GooglePrivacyDlpV2PrimitiveTransformation: + properties: + fixedSizeBucketingConfig: + description: Fixed size bucketing + $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' + dateShiftConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' + description: Date Shift + redactConfig: + description: Redact + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' + cryptoDeterministicConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' + description: Deterministic Crypto + replaceDictionaryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' + description: >- + Replace with a value randomly drawn (with replacement) from a + dictionary. + characterMaskConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' + description: Mask + cryptoHashConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' + description: Crypto + bucketingConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' + description: Bucketing + replaceConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' + description: Replace with a specified value. + cryptoReplaceFfxFpeConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' + description: Ffx-Fpe + timePartConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' + description: Time extraction + replaceWithInfoTypeConfig: + description: Replace with infotype + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' type: object + id: GooglePrivacyDlpV2PrimitiveTransformation + description: A rule for transforming a value. GooglePrivacyDlpV2Action: type: object - description: >- - A task to execute on the completion of a job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-actions - to learn more. + id: GooglePrivacyDlpV2Action properties: - publishSummaryToCscc: - description: Publish summary to Cloud Security Command Center (Alpha). - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' - publishToStackdriver: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' - description: Enable Stackdriver metric dlp.googleapis.com/finding_count. + pubSub: + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' + description: Publish a notification to a Pub/Sub topic. jobNotificationEmails: $ref: '#/components/schemas/GooglePrivacyDlpV2JobNotificationEmails' description: >- @@ -4382,1816 +4053,1772 @@ components: $ref: >- #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog description: Publish findings to Cloud Datahub. - pubSub: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' - description: Publish a notification to a Pub/Sub topic. + publishToStackdriver: + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' + description: Enable Stackdriver metric dlp.googleapis.com/finding_count. + publishSummaryToCscc: + description: Publish summary to Cloud Security Command Center (Alpha). + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' saveFindings: description: Save resulting findings in a provided location. $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' - id: GooglePrivacyDlpV2Action - GooglePrivacyDlpV2Result: - id: GooglePrivacyDlpV2Result + description: >- + A task to execute on the completion of a job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-actions + to learn more. + GooglePrivacyDlpV2StorageConfig: + description: Shared message indicating Cloud storage type. + id: GooglePrivacyDlpV2StorageConfig + type: object properties: - hybridStats: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' - description: Statistics related to the processing of hybrid inspect. - numRowsProcessed: + cloudStorageOptions: + description: Cloud Storage options. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' + hybridOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' + description: Hybrid inspection options. + datastoreOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' + description: Google Cloud Datastore options. + bigQueryOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' + description: BigQuery options. + timespanConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' + description: Configuration of the timespan of the items to include in scanning. + GooglePrivacyDlpV2Conditions: + type: object + properties: + conditions: + description: A collection of conditions. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' + id: GooglePrivacyDlpV2Conditions + description: A collection of conditions. + GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: + id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + type: object + description: Response message for ListDeidentifyTemplates. + properties: + nextPageToken: description: >- - Number of rows scanned after sampling and time filtering (applicable - for row based stores such as BigQuery). + If the next page is available then the next page token to be used in + the following ListDeidentifyTemplates request. type: string - format: int64 - infoTypeStats: + deidentifyTemplates: description: >- - Statistics of how many instances of each info type were found during - inspect job. + List of deidentify templates, up to page_size in + ListDeidentifyTemplatesRequest. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' - processedBytes: - format: int64 - description: Total size in bytes that were processed. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + GooglePrivacyDlpV2StoredType: + type: object + description: A reference to a StoredInfoType to use with scanning. + id: GooglePrivacyDlpV2StoredType + properties: + createTime: type: string - totalEstimatedBytes: - description: Estimate of the number of bytes to process. + format: google-datetime + description: >- + Timestamp indicating when the version of the `StoredInfoType` used + for inspection was created. Output-only field, populated by the + system. + name: + description: >- + Resource name of the requested `StoredInfoType`, for example + `organizations/433245324/storedInfoTypes/432452342` or + `projects/project-id/storedInfoTypes/432452342`. type: string - format: int64 - description: >- - All result fields mentioned below are updated while the job is - processing. + GooglePrivacyDlpV2Container: + id: GooglePrivacyDlpV2Container type: object - GooglePrivacyDlpV2OrgConfig: - description: >- - Project and scan location information. Only set when the parent is an - org. properties: - location: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' - description: 'The data to scan: folder, org, or project' - projectId: + rootPath: + type: string description: >- - The project that will run the scan. The DLP service account that - exists within this project must have access to all resources that - are profiled, and the Cloud DLP API must be enabled. + The root of the container. Examples: - For BigQuery table + `project_id:dataset_id.table_id`, the root is `dataset_id` - For + Cloud Storage file `gs://bucket/folder/filename.txt`, the root is + `gs://bucket` + projectId: type: string - id: GooglePrivacyDlpV2OrgConfig - type: object - GoogleTypeTimeOfDay: - id: GoogleTypeTimeOfDay - description: >- - Represents a time of day. The date and time zone are either not - significant or are specified elsewhere. An API may choose to allow leap - seconds. Related types are google.type.Date and - `google.protobuf.Timestamp`. - type: object - properties: - hours: description: >- - Hours of day in 24 hour format. Should be from 0 to 23. An API may - choose to allow the value "24:00:00" for scenarios like business - closing time. - type: integer - format: int32 - seconds: + Project where the finding was found. Can be different from the + project that owns the finding. + updateTime: + type: string + format: google-datetime description: >- - Seconds of minutes of the time. Must normally be from 0 to 59. An - API may allow the value 60 if it allows leap-seconds. - format: int32 - type: integer - nanos: - type: integer - description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - format: int32 - minutes: - type: integer - format: int32 - description: Minutes of hour of day. Must be from 0 to 59. - GooglePrivacyDlpV2KmsWrappedCryptoKey: - type: object - id: GooglePrivacyDlpV2KmsWrappedCryptoKey - properties: - wrappedKey: - description: Required. The wrapped data crypto key. - format: byte + Findings container modification timestamp, if applicable. For Cloud + Storage, this field contains the last file modification timestamp. + For a BigQuery table, this field contains the last_modified_time + property. For Datastore, this field isn't populated. + relativePath: type: string - cryptoKeyName: description: >- - Required. The resource name of the KMS CryptoKey to use for - unwrapping. + The rest of the path after the root. Examples: - For BigQuery table + `project_id:dataset_id.table_id`, the relative path is `table_id` - + For Cloud Storage file `gs://bucket/folder/filename.txt`, the + relative path is `folder/filename.txt` + fullPath: + description: >- + A string representation of the full container name. Examples: - + BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: + 'gs://Bucket/folders/filename.txt' type: string - description: >- - Include to use an existing data crypto key wrapped by KMS. The wrapped - key must be a 128-, 192-, or 256-bit key. Authorization requires the - following IAM permissions when sending a request to perform a crypto - transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more - information, see [Creating a wrapped key] - (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). - Note: When you use Cloud KMS for cryptographic operations, [charges - apply](https://cloud.google.com/kms/pricing). - GooglePrivacyDlpV2UpdateInspectTemplateRequest: - type: object - description: Request message for UpdateInspectTemplate. - properties: - updateMask: - description: Mask to control which fields get updated. + type: + description: Container type, for example BigQuery or Cloud Storage. + type: string + version: type: string - format: google-fieldmask - inspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - description: New InspectTemplate value. - id: GooglePrivacyDlpV2UpdateInspectTemplateRequest - GooglePrivacyDlpV2TagResources: - properties: - lowerDataRiskToLow: - type: boolean - description: >- - Whether applying a tag to a resource should lower the risk of the - profile for that resource. For example, in conjunction with an [IAM - deny policy](https://cloud.google.com/iam/docs/deny-overview), you - can deny all principals a permission if a tag value is present, - mitigating the risk of the resource. This also lowers the data risk - of resources at the lower levels of the resource hierarchy. For - example, reducing the data risk of a table data profile also reduces - the data risk of the constituent column data profiles. - profileGenerationsToTag: - items: - type: string - enumDescriptions: - - Unused. - - The profile is the first profile for the resource. - - The profile is an update to a previous profile. - enum: - - PROFILE_GENERATION_UNSPECIFIED - - PROFILE_GENERATION_NEW - - PROFILE_GENERATION_UPDATE - type: array description: >- - The profile generations for which the tag should be attached to - resources. If you attach a tag to only new profiles, then if the - sensitivity score of a profile subsequently changes, its tag doesn't - change. By default, this field includes only new profiles. To - include both new and updated profiles for tagging, this field should - explicitly include both `PROFILE_GENERATION_NEW` and - `PROFILE_GENERATION_UPDATE`. - tagConditions: - type: array - description: The tags to associate with different conditions. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TagCondition' - id: GooglePrivacyDlpV2TagResources - type: object + Findings container version, if available ("generation" for Cloud + Storage). description: >- - If set, attaches the [tags] - (https://cloud.google.com/resource-manager/docs/tags/tags-overview) - provided to profiled resources. Tags support [access - control](https://cloud.google.com/iam/docs/tags-access-control). You can - conditionally grant or deny access to a resource based on whether the - resource has a specific tag. - GooglePrivacyDlpV2Row: + Represents a container that may contain DLP findings. Examples of a + container include a file, table, or database record. + GooglePrivacyDlpV2Table: + id: GooglePrivacyDlpV2Table + description: >- + Structured content to inspect. Up to 50,000 `Value`s per request + allowed. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table + to learn more. properties: - values: + headers: + description: Headers of the table. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + type: array + rows: + description: Rows of the table. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Row' type: array - description: Individual cells. - id: GooglePrivacyDlpV2Row - description: Values of the row. type: object - GooglePrivacyDlpV2CloudStorageResourceReference: + GooglePrivacyDlpV2NumericalStatsConfig: + properties: + field: + description: >- + Field to compute numerical stats on. Supported types are integer, + float, date, datetime, timestamp, time. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + Compute numerical stats over an individual column, including min, max, + and quantiles. + id: GooglePrivacyDlpV2NumericalStatsConfig type: object - description: Identifies a single Cloud Storage bucket. + GooglePrivacyDlpV2BigQueryTable: + description: >- + Message defining the location of a BigQuery table. A table is uniquely + identified by its project_id, dataset_id, and table_name. Within a query + a table is often referenced with a string in the format of: `:.` or + `..`. + id: GooglePrivacyDlpV2BigQueryTable properties: - bucketName: - type: string - description: Required. The bucket to scan. projectId: type: string description: >- - Required. If within a project-level config, then this must match the - config's project id. - id: GooglePrivacyDlpV2CloudStorageResourceReference - GooglePrivacyDlpV2HybridInspectDlpJobRequest: - properties: - hybridItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - description: The item to inspect. + The Google Cloud Platform project ID of the project containing the + table. If omitted, project ID is inferred from the API call. + datasetId: + description: Dataset ID of the table. + type: string + tableId: + description: Name of the table. + type: string type: object - id: GooglePrivacyDlpV2HybridInspectDlpJobRequest - description: Request to search for potentially sensitive info in a custom location. - GooglePrivacyDlpV2KAnonymityResult: - properties: - equivalenceClassHistogramBuckets: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' - description: Histogram of k-anonymity equivalence classes. - type: array - description: Result of the k-anonymity computation. + GooglePrivacyDlpV2DataProfilePubSubMessage: type: object - id: GooglePrivacyDlpV2KAnonymityResult - GooglePrivacyDlpV2TransformationConfig: - id: GooglePrivacyDlpV2TransformationConfig description: >- - User specified templates and configs for how to deidentify structured, - unstructures, and image files. User must provide either a unstructured - deidentify template or at least one redact image config. + Pub/Sub topic message for a DataProfileAction.PubSubNotification event. + To receive a message of protocol buffer schema type, convert the message + data to an object of this proto class. properties: - imageRedactTemplate: - description: >- - Image redact template. If this template is specified, it will serve - as the de-identify template for images. If this template is not set, - all findings in the image will be redacted with a black box. - type: string - deidentifyTemplate: + event: + enumDescriptions: + - Unused. + - New profile (not a re-profile). + - >- + One of the following profile metrics changed: Data risk score, + Sensitivity score, Resource visibility, Encryption type, Predicted + infoTypes, Other infoTypes + - Table data risk score or sensitivity score increased. + - A user (non-internal) error occurred. + description: The event that caused the Pub/Sub message to be sent. + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED type: string + fileStoreProfile: description: >- - De-identify template. If this template is specified, it will serve - as the default de-identify template. This template cannot contain - `record_transformations` since it can be used for unstructured - content such as free-form text files. If this template is not set, a - default `ReplaceWithInfoTypeConfig` will be used to de-identify - unstructured content. - structuredDeidentifyTemplate: - type: string + If `DetailLevel` is `FILE_STORE_PROFILE` this will be fully + populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only + `name` and `file_store_path` will be populated. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + profile: description: >- - Structured de-identify template. If this template is specified, it - will serve as the de-identify template for structured content such - as delimited files and tables. If this template is not set but the - `deidentify_template` is set, then `deidentify_template` will also - apply to the structured content. If neither template is set, a - default `ReplaceWithInfoTypeConfig` will be used to de-identify - structured content. - type: object - GooglePrivacyDlpV2DeidentifyDataSourceDetails: + If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. + Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and + `full_resource` will be populated. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + id: GooglePrivacyDlpV2DataProfilePubSubMessage + GooglePrivacyDlpV2TransformationResultStatus: type: object + id: GooglePrivacyDlpV2TransformationResultStatus + description: The outcome of a transformation. properties: - requestedOptions: - description: De-identification config used for the request. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' - deidentifyStats: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' - description: Stats about the de-identification operation. - description: The results of a Deidentify action from an inspect job. - id: GooglePrivacyDlpV2DeidentifyDataSourceDetails - GooglePrivacyDlpV2KAnonymityConfig: - properties: - entityId: - $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' + details: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Detailed error codes and messages + resultStatusType: + enumDescriptions: + - Unused. + - >- + This will be set when a finding could not be transformed (i.e. + outside user set bucket range). + - >- + This will be set when a BigQuery transformation was successful but + could not be stored back in BigQuery because the transformed row + exceeds BigQuery's max row size. + - >- + This will be set when there is a finding in the custom metadata of + a file, but at the write time of the transformed file, this key / + value pair is unretrievable. + - >- + This will be set when the transformation and storing of it is + successful. + enum: + - STATE_TYPE_UNSPECIFIED + - INVALID_TRANSFORM + - BIGQUERY_MAX_ROW_SIZE_EXCEEDED + - METADATA_UNRETRIEVABLE + - SUCCESS description: >- - Message indicating that multiple rows might be associated to a - single individual. If the same entity_id is associated to multiple - quasi-identifier tuples over distinct rows, we consider the entire - collection of tuples as the composite quasi-identifier. This - collection is a multiset: the order in which the different tuples - appear in the dataset is ignored, but their frequency is taken into - account. Important note: a maximum of 1000 rows can be associated to - a single entity ID. If more rows are associated with the same entity - ID, some might be ignored. + Transformation result status type, this will be either SUCCESS, or + it will be the reason for why the transformation was not completely + successful. + type: string + GooglePrivacyDlpV2JobNotificationEmails: + properties: {} + type: object + description: >- + Sends an email when the job completes. The email goes to IAM project + owners and technical [Essential + Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + id: GooglePrivacyDlpV2JobNotificationEmails + GooglePrivacyDlpV2LDiversityConfig: + description: l-diversity metric, used for analysis of reidentification risk. + properties: + sensitiveAttribute: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Sensitive field for computing the l-value. quasiIds: type: array items: $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Set of fields to compute k-anonymity over. When multiple fields are - specified, they are considered a single composite key. Structs and - repeated data types are not supported; however, nested fields are - supported so long as they are not structs themselves or nested - within a repeated field. - type: object - description: k-anonymity metric, used for analysis of reidentification risk. - id: GooglePrivacyDlpV2KAnonymityConfig - GooglePrivacyDlpV2AllOtherDatabaseResources: - description: Match database resources not covered by any other filter. - properties: {} - type: object - id: GooglePrivacyDlpV2AllOtherDatabaseResources - GooglePrivacyDlpV2ListProjectDataProfilesResponse: - properties: - nextPageToken: - description: The next page token. - type: string - projectDataProfiles: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' - description: List of data profiles. - type: array + Set of quasi-identifiers indicating how equivalence classes are + defined for the l-diversity computation. When multiple fields are + specified, they are considered a single composite key. + id: GooglePrivacyDlpV2LDiversityConfig type: object - id: GooglePrivacyDlpV2ListProjectDataProfilesResponse - description: List of profiles generated for a given organization or project. - GooglePrivacyDlpV2CreateDiscoveryConfigRequest: - id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest - description: Request message for CreateDiscoveryConfig. + GooglePrivacyDlpV2UpdateJobTriggerRequest: + id: GooglePrivacyDlpV2UpdateJobTriggerRequest + description: Request message for UpdateJobTrigger. type: object properties: - discoveryConfig: - description: Required. The DiscoveryConfig to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - configId: - description: >- - The config ID can contain uppercase and lowercase letters, numbers, - and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. + jobTrigger: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + description: New JobTrigger value. + updateMask: type: string - GooglePrivacyDlpV2ListInfoTypesResponse: - description: Response to the ListInfoTypes request. - id: GooglePrivacyDlpV2ListInfoTypesResponse + format: google-fieldmask + description: Mask to control which fields get updated. + GooglePrivacyDlpV2InfoTypeSummary: + description: The infoType details for this column. + id: GooglePrivacyDlpV2InfoTypeSummary properties: - infoTypes: - type: array - description: Set of sensitive infoTypes. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' + estimatedPrevalence: + type: integer + description: Not populated for predicted infotypes. + deprecated: true + format: int32 + infoType: + description: The infoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' type: object - GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: - id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + GooglePrivacyDlpV2SchemaModifiedCadence: properties: + types: + items: + enumDescriptions: + - Unused. + - New columns have appeared. + - Columns have been removed from the table. + type: string + enum: + - SQL_SCHEMA_MODIFICATION_UNSPECIFIED + - NEW_COLUMNS + - REMOVED_COLUMNS + type: array + description: >- + The types of schema modifications to consider. Defaults to + NEW_COLUMNS. frequency: + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + type: string enum: - UPDATE_FREQUENCY_UNSPECIFIED - UPDATE_FREQUENCY_NEVER - UPDATE_FREQUENCY_DAILY - UPDATE_FREQUENCY_MONTHLY - type: string description: >- - How frequently profiles may be updated when schemas are modified. + Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - types: - items: - enumDescriptions: - - Unused - - >- - Profiles should be regenerated when new columns are added to the - table. Default. - - >- - Profiles should be regenerated when columns are removed from the - table. - enum: - - SCHEMA_MODIFICATION_UNSPECIFIED - - SCHEMA_NEW_COLUMNS - - SCHEMA_REMOVED_COLUMNS - type: string + description: >- + How frequently to modify the profile when the table's schema is + modified. + type: object + id: GooglePrivacyDlpV2SchemaModifiedCadence + GooglePrivacyDlpV2DatastoreOptions: + description: Options defining a data set within Google Cloud Datastore. + properties: + partitionId: + $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' description: >- - The type of events to consider when deciding if the table's schema - has been modified and should have the profile updated. Defaults to - NEW_COLUMNS. - type: array - description: The cadence at which to update data profiles when a schema is modified. + A partition ID identifies a grouping of entities. The grouping is + always by project and namespace, however the namespace ID may be + empty. + kind: + $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' + description: The kind to process. type: object - GoogleRpcStatus: + id: GooglePrivacyDlpV2DatastoreOptions + GooglePrivacyDlpV2CloudSqlProperties: properties: - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - details: + cloudSqlIam: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' + description: Built-in IAM authentication (must be configured in Cloud SQL). + databaseEngine: + enum: + - DATABASE_ENGINE_UNKNOWN + - DATABASE_ENGINE_MYSQL + - DATABASE_ENGINE_POSTGRES description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - message: + Required. The database engine used by the Cloud SQL instance that + this connection configures. + enumDescriptions: + - >- + An engine that is not currently supported by Sensitive Data + Protection. + - Cloud SQL for MySQL instance. + - Cloud SQL for PostgreSQL instance. + type: string + connectionName: type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: object - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - GooglePrivacyDlpV2CryptoKey: - type: object - id: GooglePrivacyDlpV2CryptoKey - description: >- - This is a data encryption key (DEK) (as opposed to a key encryption key - (KEK) stored by Cloud Key Management Service (Cloud KMS). When using - Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM - policy on the KEK to ensure an attacker cannot unwrap the DEK. - properties: - unwrapped: - $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' - description: Unwrapped crypto key - transient: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' - description: Transient crypto key - kmsWrapped: - $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' - description: Key wrapped using Cloud KMS - GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: - properties: - nextPageToken: - type: string - description: >- - If the next page is available then the next page token to be used in - the following ListDeidentifyTemplates request. - deidentifyTemplates: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: >- - List of deidentify templates, up to page_size in - ListDeidentifyTemplatesRequest. - description: Response message for ListDeidentifyTemplates. - type: object - id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse - GoogleTypeDate: - properties: - day: + Optional. Immutable. The Cloud SQL instance for which the connection + is defined. Only one connection per instance is allowed. This can + only be set at creation time, and cannot be updated. It is an error + to use a connection_name from different project or region than the + one that holds the connection. For example, a Connection resource + for Cloud SQL connection_name `project-id:us-central1:sql-instance` + must be created under the parent + `projects/project-id/locations/us-central1` + maxConnections: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. + Required. DLP will limit its connections to max_connections. Must be + 2 or greater. format: int32 type: integer - year: - type: integer - format: int32 + usernamePassword: + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' + description: A username and password stored in Secret Manager. + type: object + id: GooglePrivacyDlpV2CloudSqlProperties + description: Cloud SQL connection properties. + GooglePrivacyDlpV2InfoTypeLimit: + id: GooglePrivacyDlpV2InfoTypeLimit + type: object + description: >- + Max findings configuration per infoType, per content item or long + running DlpJob. + properties: + infoType: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - month: + Type of information the findings limit applies to. Only one limit + per info_type should be provided. If InfoTypeLimit does not have an + info_type, the DLP API applies the limit against all info_types that + are found but not specified in another InfoTypeLimit. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + maxFindings: format: int32 - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. type: integer - type: object - id: GoogleTypeDate + description: Max findings limit for the given infoType. + GooglePrivacyDlpV2ExcludeByHotword: description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - GooglePrivacyDlpV2BigQueryTableTypes: - properties: - types: - description: A set of BigQuery table types. - items: - enum: - - BIG_QUERY_TABLE_TYPE_UNSPECIFIED - - BIG_QUERY_TABLE_TYPE_TABLE - - BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE - enumDescriptions: - - Unused. - - A normal BigQuery table. - - A table that references data stored in Cloud Storage. - type: string - type: array + The rule to exclude findings based on a hotword. For record inspection + of tables, column names are considered hotwords. An example of this is + to exclude a finding if it belongs to a BigQuery column that matches a + specific pattern. type: object - id: GooglePrivacyDlpV2BigQueryTableTypes - description: The types of BigQuery tables supported by Cloud DLP. - GooglePrivacyDlpV2HotwordRule: - id: GooglePrivacyDlpV2HotwordRule properties: - hotwordRegex: - description: Regular expression pattern defining what qualifies as a hotword. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' proximity: $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' description: >- Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The - finding itself will be included in the window, so that hotwords can - be used to match substrings of the finding itself. Suppose you want - Cloud DLP to promote the likelihood of the phone number regex - "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area - code of a company's office. In this case, use the hotword regex - "\(xxx\)", where "xxx" is the area code in question. For tabular - data, if you want to modify the likelihood of an entire column of - findngs, see [Hotword example: Set the match likelihood of a table - column] - (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - likelihoodAdjustment: - $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' - description: Likelihood adjustment to apply to all matching findings. + windowBefore property in proximity should be set to 1 if the hotword + needs to be included in a column header. + hotwordRegex: + description: Regular expression pattern defining what qualifies as a hotword. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + id: GooglePrivacyDlpV2ExcludeByHotword + GooglePrivacyDlpV2DataProfileAction: + description: A task to execute when a data profile has been generated. + properties: + publishToScc: + description: Publishes findings to SCC for each data profile. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2PublishToSecurityCommandCenter + pubSubNotification: + description: Publish a message into the Pub/Sub topic. + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' + publishToChronicle: + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToChronicle' + description: >- + Publishes generated data profiles to Google Security Operations. For + more information, see [Use Sensitive Data Protection data in + context-aware + analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + exportData: + description: Export data profiles into a provided location. + $ref: '#/components/schemas/GooglePrivacyDlpV2Export' + tagResources: + $ref: '#/components/schemas/GooglePrivacyDlpV2TagResources' + description: Tags the profiled resources with the specified tag values. type: object - description: >- - The rule that adjusts the likelihood of findings within a certain - proximity of hotwords. - GooglePrivacyDlpV2PartitionId: - description: >- - Datastore partition ID. A partition ID identifies a grouping of - entities. The grouping is always by project and namespace, however the - namespace ID may be empty. A partition ID contains several dimensions: - project ID and namespace ID. + id: GooglePrivacyDlpV2DataProfileAction + GooglePrivacyDlpV2Disabled: + id: GooglePrivacyDlpV2Disabled type: object + description: Do not profile the tables. + properties: {} + GooglePrivacyDlpV2ImageTransformations: properties: - namespaceId: - description: If not empty, the ID of the namespace to which the entities belong. - type: string - projectId: - description: The ID of the project to which the entities belong. - type: string - id: GooglePrivacyDlpV2PartitionId - GooglePrivacyDlpV2FileExtensionInfo: - id: GooglePrivacyDlpV2FileExtensionInfo - description: Information regarding the discovered file extension. - properties: - fileExtension: - type: string - description: The file extension if set. (aka .pdf, .jpg, .txt) + transforms: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' + type: array + description: List of transforms to make. type: object - GooglePrivacyDlpV2KAnonymityHistogramBucket: + id: GooglePrivacyDlpV2ImageTransformations + description: A type of transformation that is applied over images. + GooglePrivacyDlpV2FixedSizeBucketingConfig: properties: bucketSize: - description: Total number of equivalence classes in this bucket. - type: string - format: int64 - equivalenceClassSizeUpperBound: - description: Upper bound on the size of the equivalence classes in this bucket. - format: int64 - type: string - equivalenceClassSizeLowerBound: - description: Lower bound on the size of the equivalence classes in this bucket. - format: int64 - type: string - bucketValueCount: - description: Total number of distinct equivalence classes in this bucket. - format: int64 - type: string - bucketValues: + type: number description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' - id: GooglePrivacyDlpV2KAnonymityHistogramBucket - description: Histogram of k-anonymity equivalence classes. + Required. Size of each bucket (except for minimum and maximum + buckets). So if `lower_bound` = 10, `upper_bound` = 89, and + `bucket_size` = 10, then the following buckets would be used: -10, + 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. + Precision up to 2 decimals works. + format: double + lowerBound: + description: >- + Required. Lower bound value of buckets. All values less than + `lower_bound` are grouped together into a single bucket; for example + if `lower_bound` = 10, then all values less than 10 are replaced + with the value "-10". + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + upperBound: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: >- + Required. Upper bound value of buckets. All values greater than + upper_bound are grouped together into a single bucket; for example + if `upper_bound` = 89, then all values greater than 89 are replaced + with the value "89+". type: object - GooglePrivacyDlpV2KMapEstimationResult: description: >- - Result of the reidentifiability analysis. Note that these results are an - estimation, not exact values. - id: GooglePrivacyDlpV2KMapEstimationResult - type: object - properties: - kMapEstimationHistogram: + Buckets values based on fixed size ranges. The Bucketing transformation + can provide all of this functionality, but requires more configuration. + This message is provided as a convenience to the user for simple + bucketing strategies. The transformed value will be a hyphenated string + of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and + upper_bound = 20, all values that are within this bucket will be + replaced with "10-20". This can be used on data of type: double, long. + If the bound Value type differs from the type of data being transformed, + we will first attempt converting the type of the data to be transformed + to match the type of the bound before comparing. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing + to learn more. + id: GooglePrivacyDlpV2FixedSizeBucketingConfig + GooglePrivacyDlpV2RedactImageResponse: + id: GooglePrivacyDlpV2RedactImageResponse + properties: + inspectResult: description: >- - The intervals [min_anonymity, max_anonymity] do not overlap. If a - value doesn't correspond to any such interval, the associated - frequency is zero. For example, the following records: - {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: - 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, - max_anonymity: 10, frequency: 99} mean that there are no record with - an estimated anonymity of 4, 5, or larger than 10. - type: array - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket - GooglePrivacyDlpV2StatisticalTable: - id: GooglePrivacyDlpV2StatisticalTable + The findings. Populated when include_findings in the request is + true. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + extractedText: + type: string + description: >- + If an image was being inspected and the InspectConfig's + include_quote was set to true, then this field will include all + text, if any, that was found in the image. + redactedImage: + type: string + description: The redacted image. The type will be the same as the original image. + format: byte + description: Results of redacting an image. + type: object + GooglePrivacyDlpV2RequestedOptions: + id: GooglePrivacyDlpV2RequestedOptions + type: object + properties: + jobConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + description: Inspect config. + snapshotInspectTemplate: + description: >- + If run with an InspectTemplate, a snapshot of its state at the time + of this run. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + description: Snapshot of the inspection configuration. + GooglePrivacyDlpV2TransformationDetailsStorageConfig: + type: object properties: table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Required. Auxiliary table location. - quasiIds: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' - description: Required. Quasi-identifier columns. - type: array - relativeFrequency: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Required. The relative frequency column must contain a - floating-point number between 0 and 1 (inclusive). Null values are - assumed to be zero. + The BigQuery table in which to store the output. This may be an + existing table or in a new table in an existing dataset. If table_id + is not set a new one will be generated for you with the following + format: + dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. + Pacific time zone will be used for generating the date details. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Config for storing transformation details. + id: GooglePrivacyDlpV2TransformationDetailsStorageConfig + GooglePrivacyDlpV2PrivacyMetric: type: object - description: >- - An auxiliary table containing statistical information on the relative - frequency of different quasi-identifiers values. It has one or several - quasi-identifiers columns, and one column that indicates the relative - frequency of each quasi-identifier tuple. If a tuple is present in the - data but not in the auxiliary table, the corresponding relative - frequency is assumed to be zero (and thus, the tuple is highly - reidentifiable). - GooglePrivacyDlpV2TableDataProfile: + properties: + categoricalStatsConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' + description: Categorical stats + numericalStatsConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' + description: Numerical stats + deltaPresenceEstimationConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' + description: delta-presence + lDiversityConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' + description: l-diversity + kMapEstimationConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' + description: k-map + kAnonymityConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' + description: K-anonymity + id: GooglePrivacyDlpV2PrivacyMetric + description: Privacy metric to compute for reidentification risk analysis. + GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: type: object + id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + description: Request message for UpdateStoredInfoType. properties: - name: - description: The name of the profile. - type: string - failedColumnCount: - description: The number of columns skipped in the table because of an error. - type: string - format: int64 - datasetLocation: - type: string + config: description: >- - If supported, the location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - locations. - resourceVisibility: + Updated configuration for the storedInfoType. If not provided, a new + version of the storedInfoType will be created with the existing + configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + updateMask: + description: Mask to control which fields get updated. type: string + format: google-fieldmask + GooglePrivacyDlpV2OutputStorageConfig: + properties: + outputSchema: + enum: + - OUTPUT_SCHEMA_UNSPECIFIED + - BASIC_COLUMNS + - GCS_COLUMNS + - DATASTORE_COLUMNS + - BIG_QUERY_COLUMNS + - ALL_COLUMNS + description: >- + Schema used for writing the findings for Inspect jobs. This field is + only used for Inspect and must be unspecified for Risk jobs. Columns + are derived from the `Finding` object. If appending to an existing + table, any columns from the predefined schema that are missing will + be added. No columns in the existing table will be deleted. If + unspecified, then all available columns will be used for a new table + or an (existing) table with no schema, and no changes will be made + to an existing table that has a schema. Only for use with external + storage. enumDescriptions: - Unused. - - Visible to any user. - >- - May contain public items. For example, if a Cloud Storage bucket - has uniform bucket level access disabled, some objects inside it - may be public, but none are known yet. - - Visible only to specific users. - enum: - - RESOURCE_VISIBILITY_UNSPECIFIED - - RESOURCE_VISIBILITY_PUBLIC - - RESOURCE_VISIBILITY_INCONCLUSIVE - - RESOURCE_VISIBILITY_RESTRICTED - description: How broadly a resource has been shared. - projectDataProfile: - description: The resource name of the project data profile for this table. - type: string - tableId: + Basic schema including only `info_type`, `quote`, `certainty`, and + `timestamp`. + - Schema tailored to findings from scanning Cloud Storage. + - Schema tailored to findings from scanning Google Datastore. + - Schema tailored to findings from scanning Google BigQuery. + - Schema containing all columns. type: string - description: If the resource is BigQuery, the BigQuery table ID. - datasetId: + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: >- + Store findings in an existing table or a new table in an existing + dataset. If table_id is not set a new one will be generated for you + with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. + Pacific time zone will be used for generating the date details. For + Inspect, each column in an existing output table must have the same + name, type, and mode of a field in the `Finding` object. For Risk, + an existing output table should be the output of a previous Risk + analysis job run on the same source table, with the same privacy + metric and quasi-identifiers. Risk jobs that analyze the same table + but compute a different privacy metric, or use different sets of + quasi-identifiers, cannot store their results in the same table. + id: GooglePrivacyDlpV2OutputStorageConfig + description: Cloud repository for storing output. + type: object + GooglePrivacyDlpV2CreateStoredInfoTypeRequest: + id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest + type: object + properties: + storedInfoTypeId: + description: >- + The storedInfoType ID can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - description: If the resource is BigQuery, the dataset ID. - lastModifiedTime: - description: The time when this table was last modified + locationId: type: string - format: google-datetime - rowCount: + description: Deprecated. This field has no effect. + config: + description: Required. Configuration of the storedInfoType to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + description: Request message for CreateStoredInfoType. + GooglePrivacyDlpV2JobTrigger: + description: >- + Contains a configuration to make API calls on a repeating basis. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers + to learn more. + properties: + errors: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' description: >- - Number of rows in the table when the profile was generated. This - will not be populated for BigLake tables. + Output only. A stream of errors encountered when the trigger was + activated. Repeated errors may result in the JobTrigger + automatically being paused. Will return the last 100 errors. + Whenever the JobTrigger is modified this list will be cleared. + status: type: string - format: int64 - otherInfoTypes: - description: Other infoTypes found in this table's data. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - type: array - encryptionStatus: enum: - - ENCRYPTION_STATUS_UNSPECIFIED - - ENCRYPTION_GOOGLE_MANAGED - - ENCRYPTION_CUSTOMER_MANAGED + - STATUS_UNSPECIFIED + - HEALTHY + - PAUSED + - CANCELLED enumDescriptions: - Unused. - - Google manages server-side encryption keys on your behalf. - - Customer provides the key. - description: How the table is encrypted. - type: string - expirationTime: - description: Optional. The time when this table expires. - type: string - format: google-datetime - fullResource: - description: >- - The resource name of the resource profiled. - https://cloud.google.com/apis/design/resource_names#full_resource_name + - Trigger is healthy. + - Trigger is temporarily paused. + - Trigger is cancelled and can not be resumed. + description: Required. A status for this trigger. + lastRunTime: + readOnly: true type: string - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' - description: The resource type that was profiled. - dataRiskLevel: - description: The data risk level of this table. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - resourceLabels: - type: object - additionalProperties: - type: string + format: google-datetime + description: Output only. The timestamp of the last time this trigger executed. + name: description: >- - The labels applied to the resource at the time the profile was - generated. - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity score of this table. - predictedInfoTypes: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' - type: array - description: The infoTypes predicted from this table's data. - tableSizeBytes: + Unique resource name for the triggeredJob, assigned by the service + when the triggeredJob is created, for example + `projects/dlp-test-project/jobTriggers/53234423`. type: string - format: int64 - description: The size of the table when the profile was generated. createTime: - type: string + readOnly: true format: google-datetime - description: The time at which the table was created. - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - configSnapshot: - description: The snapshot of the configurations used to generate the profile. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' - scannedColumnCount: - description: The number of columns profiled in the table. - format: int64 + description: Output only. The creation timestamp of a triggeredJob. type: string - profileLastGenerated: + updateTime: type: string - description: The last time the profile was generated. + readOnly: true + description: Output only. The last update timestamp of a triggeredJob. format: google-datetime - state: + triggers: + type: array + description: >- + A list of triggers which will be OR'ed together. Only one in the + list needs to trigger for a job to be started. The list may contain + only a single Schedule trigger and must have at least one object. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' + description: type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE - description: State of a profile. - enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. - datasetProjectId: - description: The Google Cloud project ID that owns the resource. + description: User provided description (max 256 chars) + displayName: type: string - description: The profile for a scanned table. - id: GooglePrivacyDlpV2TableDataProfile - GooglePrivacyDlpV2InfoTypeTransformations: + description: Display name (max 100 chars) + inspectJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + description: For inspect jobs, a snapshot of the configuration. + id: GooglePrivacyDlpV2JobTrigger + type: object + GooglePrivacyDlpV2DiscoveryGenerationCadence: + description: >- + What must take place for a profile to be updated and how frequently it + should occur. New tables are scanned as quickly as possible depending on + system capacity. type: object properties: - transformations: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' - type: array + tableModifiedCadence: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' + description: Governs when to update data profiles when a table is modified. + inspectTemplateModifiedCadence: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence description: >- - Required. Transformation for each infoType. Cannot specify more than - one for a given infoType. - id: GooglePrivacyDlpV2InfoTypeTransformations - description: >- - A type of transformation that will scan unstructured text and apply - various `PrimitiveTransformation`s to each finding, where the - transformation is applied to only values that were identified as a - specific info_type. - GooglePrivacyDlpV2InspectionRule: - description: >- - A single inspection rule to be applied to infoTypes, specified in - `InspectionRuleSet`. + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to update. + refreshFrequency: + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + description: >- + Frequency at which profiles should be updated, regardless of whether + the underlying resource has changed. Defaults to never. + type: string + schemaModifiedCadence: + description: Governs when to update data profiles when a schema is modified. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + id: GooglePrivacyDlpV2DiscoveryGenerationCadence + GooglePrivacyDlpV2UpdateInspectTemplateRequest: properties: - hotwordRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - description: Hotword-based detection rule. - exclusionRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' - description: Exclusion rule. + updateMask: + type: string + format: google-fieldmask + description: Mask to control which fields get updated. + inspectTemplate: + description: New InspectTemplate value. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + description: Request message for UpdateInspectTemplate. + id: GooglePrivacyDlpV2UpdateInspectTemplateRequest type: object - id: GooglePrivacyDlpV2InspectionRule - GooglePrivacyDlpV2ListColumnDataProfilesResponse: + GooglePrivacyDlpV2ExclusionRule: + type: object + description: >- + The rule that specifies conditions when findings of infoTypes specified + in `InspectionRuleSet` are removed from results. + properties: + matchingType: + description: How the rule is applied, see MatchingType documentation for details. + type: string + enumDescriptions: + - Invalid. + - >- + Full match. - Dictionary: join of Dictionary results matched + complete finding quote - Regex: all regex matches fill a finding + quote start to end - Exclude info type: completely inside + affecting info types findings + - >- + Partial match. - Dictionary: at least one of the tokens in the + finding matches - Regex: substring of the finding matches - + Exclude info type: intersects with affecting info types findings + - >- + Inverse match. - Dictionary: no tokens in the finding match the + dictionary - Regex: finding doesn't match the regex - Exclude info + type: no intersection with affecting info types findings + enum: + - MATCHING_TYPE_UNSPECIFIED + - MATCHING_TYPE_FULL_MATCH + - MATCHING_TYPE_PARTIAL_MATCH + - MATCHING_TYPE_INVERSE_MATCH + excludeInfoTypes: + description: Set of infoTypes for which findings would affect this rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' + regex: + description: Regular expression which defines the rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + dictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + description: Dictionary which defines the rule. + excludeByHotword: + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' + description: >- + Drop if the hotword rule is contained in the proximate context. For + tabular data, the context includes the column name. + id: GooglePrivacyDlpV2ExclusionRule + GooglePrivacyDlpV2ListInspectTemplatesResponse: properties: nextPageToken: type: string - description: The next page token. - columnDataProfiles: + description: >- + If the next page is available then the next page token to be used in + the following ListInspectTemplates request. + inspectTemplates: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' type: array - description: List of data profiles. + description: >- + List of inspectTemplates, up to page_size in + ListInspectTemplatesRequest. + description: Response message for ListInspectTemplates. type: object - id: GooglePrivacyDlpV2ListColumnDataProfilesResponse - description: List of profiles generated for a given organization or project. - GooglePrivacyDlpV2InspectContentResponse: + id: GooglePrivacyDlpV2ListInspectTemplatesResponse + GooglePrivacyDlpV2LDiversityResult: + description: Result of the l-diversity computation. type: object - id: GooglePrivacyDlpV2InspectContentResponse + id: GooglePrivacyDlpV2LDiversityResult properties: - result: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' - description: The findings. - description: Results of inspecting an item. - GooglePrivacyDlpV2JobNotificationEmails: + sensitiveValueFrequencyHistogramBuckets: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' + type: array + description: >- + Histogram of l-diversity equivalence class sensitive value + frequencies. + GooglePrivacyDlpV2CloudStorageFileSet: + description: Message representing a set of files in Cloud Storage. + id: GooglePrivacyDlpV2CloudStorageFileSet + properties: + url: + description: >- + The url, in the format `gs:///`. Trailing wildcard in the path is + allowed. + type: string type: object - id: GooglePrivacyDlpV2JobNotificationEmails + GooglePrivacyDlpV2StoredInfoTypeConfig: description: >- - Sends an email when the job completes. The email goes to IAM project - owners and technical [Essential - Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). - properties: {} - GooglePrivacyDlpV2CategoricalStatsResult: - properties: - valueFrequencyHistogramBuckets: - description: Histogram of value frequencies in the column. - type: array - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket - type: object - id: GooglePrivacyDlpV2CategoricalStatsResult - description: Result of the categorical stats computation. - GooglePrivacyDlpV2InspectResult: + Configuration for stored infoTypes. All fields and subfield are provided + by the user. For more information, see + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. properties: - findings: - description: List of findings for an item. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' - type: array - findingsTruncated: - type: boolean + regex: + description: Store regular expression-based StoredInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + dictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + description: Store dictionary-based CustomInfoType. + description: + type: string + description: Description of the StoredInfoType (max 256 characters). + largeCustomDictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' description: >- - If true, then this item might have more findings than were returned, - and the findings returned are an arbitrary subset of all findings. - The findings list might be truncated because the input items were - too large, or because the server reached the maximum amount of - resources allowed for a single API call. For best results, divide - the input into smaller batches. - description: All the findings for a single scanned item. - type: object - id: GooglePrivacyDlpV2InspectResult - GooglePrivacyDlpV2KindExpression: - properties: - name: - description: The name of the kind. + StoredInfoType where findings are defined by a dictionary of + phrases. + displayName: + description: Display name of the StoredInfoType (max 256 characters). type: string type: object - description: A representation of a Datastore kind. - id: GooglePrivacyDlpV2KindExpression - GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: + id: GooglePrivacyDlpV2StoredInfoTypeConfig + GooglePrivacyDlpV2ReidentifyContentResponse: type: object - description: A tuple of values for the quasi-identifier columns. - id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + description: Results of re-identifying an item. + id: GooglePrivacyDlpV2ReidentifyContentResponse properties: - estimatedProbability: - format: double - type: number - description: >- - The estimated probability that a given individual sharing these - quasi-identifier values is in the dataset. This value, typically - called δ, is the ratio between the number of records in the dataset - with these quasi-identifier values, and the total number of - individuals (inside *and* outside the dataset) with these - quasi-identifier values. For example, if there are 15 individuals in - the dataset who share the same quasi-identifier values, and an - estimated 100 people in the entire population with these values, - then δ is 0.15. - quasiIdsValues: - description: The quasi-identifier values. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - GooglePrivacyDlpV2PubSubNotification: - description: >- - Send a Pub/Sub message into the given Pub/Sub topic to connect other - systems to data profile generation. The message payload data will be the - byte serialization of `DataProfilePubSubMessage`. - id: GooglePrivacyDlpV2PubSubNotification + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: The re-identified item. + overview: + description: An overview of the changes that were made to the `item`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' + GooglePrivacyDlpV2ActionDetails: properties: - event: + deidentifyDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' + description: Outcome of a de-identification action. + description: The results of an Action. + type: object + id: GooglePrivacyDlpV2ActionDetails + GooglePrivacyDlpV2HybridOptions: + type: object + id: GooglePrivacyDlpV2HybridOptions + properties: + description: description: >- - The type of event that triggers a Pub/Sub. At most one - `PubSubNotification` per EventType is permitted. - enum: - - EVENT_TYPE_UNSPECIFIED - - NEW_PROFILE - - CHANGED_PROFILE - - SCORE_INCREASED - - ERROR_CHANGED - type: string - enumDescriptions: - - Unused. - - New profile (not a re-profile). - - >- - One of the following profile metrics changed: Data risk score, - Sensitivity score, Resource visibility, Encryption type, Predicted - infoTypes, Other infoTypes - - Table data risk score or sensitivity score increased. - - A user (non-internal) error occurred. - topic: + A short description of where the data is coming from. Will be stored + once in the job. 256 max length. type: string + labels: description: >- - Cloud Pub/Sub topic to send notifications to. Format is - projects/{project}/topics/{topic}. - detailOfMessage: - type: string - enumDescriptions: - - Unused. - - The full table data profile. - - The name of the profiled resource. - - The full file store data profile. + To organize findings, these labels will be added to each finding. + Label keys must be between 1 and 63 characters long and must conform + to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. + Label values must be between 0 and 63 characters long and must + conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. + No more than 10 labels can be associated with a given finding. + Examples: * `"environment" : "production"` * `"pipeline" : "etl"` + additionalProperties: + type: string + type: object + tableOptions: description: >- - How much data to include in the Pub/Sub message. If the user wishes - to limit the size of the message, they can use resource_name and - fetch the profile fields they wish to. Per table profile (not per - column). - enum: - - DETAIL_LEVEL_UNSPECIFIED - - TABLE_PROFILE - - RESOURCE_NAME - - FILE_STORE_PROFILE - pubsubCondition: + If the container is a table, additional information to make findings + meaningful such as the columns that are primary keys. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + requiredFindingLabelKeys: + items: + type: string description: >- - Conditions (e.g., data risk or sensitivity level) for triggering a - Pub/Sub. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' - type: object - GooglePrivacyDlpV2ByteContentItem: - description: Container for bytes to inspect or redact. + These are labels that each inspection request must include within + their 'finding_labels' map. Request may contain others, but any + missing one of these will be rejected. Label keys must be between 1 + and 63 characters long and must conform to the following regular + expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can + be required. + type: array + description: >- + Configuration to control jobs where the content being inspected is + outside of Google Cloud Platform. + GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence: + description: >- + The cadence at which to update data profiles when the inspection rules + defined by the `InspectTemplate` change. type: object + id: GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence properties: - data: - description: Content data to inspect or redact. - format: byte - type: string - type: + frequency: enumDescriptions: - - Unused - - Any image type. - - jpeg - - bmp - - png - - svg - - plain text - - docx, docm, dotx, dotm - - pdf - - pptx, pptm, potx, potm, pot - - xlsx, xlsm, xltx, xltm - - avro - - csv - - tsv - - Audio file types. Only used for profiling. - - Video file types. Only used for profiling. - - Executable file types. Only used for profiling. + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. enum: - - BYTES_TYPE_UNSPECIFIED - - IMAGE - - IMAGE_JPEG - - IMAGE_BMP - - IMAGE_PNG - - IMAGE_SVG - - TEXT_UTF8 - - WORD_DOCUMENT - - PDF - - POWERPOINT_DOCUMENT - - EXCEL_DOCUMENT - - AVRO - - CSV - - TSV - - AUDIO - - VIDEO - - EXECUTABLE - type: string - description: >- - The type of data stored in the bytes string. Default will be - TEXT_UTF8. - id: GooglePrivacyDlpV2ByteContentItem - GooglePrivacyDlpV2BigQueryKey: - description: Row key for identifying a record in BigQuery table. - properties: - tableReference: - description: Complete BigQuery table reference. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - rowNumber: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY description: >- - Row number inferred at the time the table was scanned. This value is - nondeterministic, cannot be queried, and may be null for inspection - jobs. To locate findings within a table, specify - `inspect_job.storage_config.big_query_options.identifying_fields` in - `CreateDlpJobRequest`. - format: int64 + How frequently data profiles can be updated when the template is + modified. Defaults to never. type: string - id: GooglePrivacyDlpV2BigQueryKey - type: object - GooglePrivacyDlpV2RecordTransformation: - description: The field in a record to transform. + GooglePrivacyDlpV2CryptoDeterministicConfig: + id: GooglePrivacyDlpV2CryptoDeterministicConfig type: object - id: GooglePrivacyDlpV2RecordTransformation properties: - containerTimestamp: - description: Findings container modification timestamp, if applicable. - type: string - format: google-datetime - containerVersion: - type: string - description: Container version, if available ("generation" for Cloud Storage). - fieldId: - description: For record transformations, provide a field. + surrogateInfoType: + description: >- + The custom info type to annotate the surrogate with. This annotation + will be applied to the surrogate by prefixing it with the name of + the custom info type followed by the number of characters comprising + the surrogate. The following scheme defines the format: {info type + name}({surrogate character count}):{surrogate} For example, if the + name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate + is 'abc', the full replacement value will be: + 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate + when inspecting content using the custom info type 'Surrogate'. This + facilitates reversal of the surrogate when it occurs in free text. + Note: For record transformations where the entire cell in a table is + being transformed, surrogates are not mandatory. Surrogates are used + to denote the location of the token and are necessary for + re-identification in free form text. In order for inspection to work + properly, the name of this info type must not occur naturally + anywhere in your data; otherwise, inspection may either - reverse a + surrogate that does not correspond to an actual identifier - be + unable to parse the surrogate and result in an error Therefore, + choose your custom info type name carefully after considering what + your data looks like. One way to select a name that has a high + chance of yielding reliable detection is to include one or more + unicode characters that are highly improbable to exist in your data. + For example, assuming your data is entered from a regular ASCII + keyboard, the symbol with the hex code point 29DD might be used like + so: ⧝MY_TOKEN_TYPE. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + context: + description: >- + A context may be used for higher security and maintaining + referential integrity such that the same identifier in two different + contexts will be given a distinct surrogate. The context is appended + to plaintext value being encrypted. On decryption the provided + context is validated against the value used during encryption. If a + context was provided during encryption, same context must be + provided during decryption as well. If the context is not set, + plaintext would be used as is for encryption. If the context is set + but: 1. there is no record present when transforming a given value + or 2. the field is not present when transforming a given value, + plaintext would be used as is for encryption. Note that case (1) is + expected when an `InfoTypeTransformation` is applied to both + structured and unstructured `ContentItem`s. $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: - id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + description: >- + The key used by the encryption function. For deterministic + encryption using AES-SIV, the provided key is internally expanded to + 64 bytes prior to use. description: >- - How often existing tables should have their profiles refreshed. New - tables are scanned as quickly as possible depending on system capacity. + Pseudonymization method that generates deterministic encryption for the + given input. Outputs a base64 encoded representation of the encrypted + output. Uses AES-SIV based on the RFC + https://tools.ietf.org/html/rfc5297. + GooglePrivacyDlpV2ReplaceValueConfig: + type: object properties: - refreshFrequency: - description: >- - Data changes (non-schema changes) in Cloud SQL tables can't trigger - reprofiling. If you set this field, profiles are refreshed at this - frequency regardless of whether the underlying tables have changed. - Defaults to never. - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - type: string - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - schemaModifiedCadence: - description: When to reprofile if the schema has changed. - $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' - inspectTemplateModifiedCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - description: >- - Governs when to update data profiles when the inspection rules - defined by the `InspectTemplate` change. If not set, changing the - template will not cause a data profile to update. + newValue: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Value to replace it with. + description: Replace each input value with a given `Value`. + id: GooglePrivacyDlpV2ReplaceValueConfig + GooglePrivacyDlpV2MetadataLocation: + id: GooglePrivacyDlpV2MetadataLocation + description: Metadata Location type: object - GooglePrivacyDlpV2StoredInfoType: properties: - pendingVersions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + type: + enum: + - METADATATYPE_UNSPECIFIED + - STORAGE_METADATA + type: string + description: Type of metadata containing the finding. + enumDescriptions: + - Unused + - General file metadata provided by Cloud Storage. + storageLabel: + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' + description: Storage metadata. + GooglePrivacyDlpV2InfoType: + id: GooglePrivacyDlpV2InfoType + properties: + sensitivityScore: description: >- - Pending versions of the stored info type. Empty if no versions are - pending. - type: array + Optional custom sensitivity for this InfoType. This only applies to + data profiling. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + version: + description: Optional version name for this InfoType. + type: string name: type: string - description: Resource name. - currentVersion: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' - description: Current version of the stored info type. - type: object - id: GooglePrivacyDlpV2StoredInfoType - description: >- - StoredInfoType resource message that contains information about the - current version and any pending updates. - GooglePrivacyDlpV2InfoTypeTransformation: - description: >- - A transformation to apply to text that is identified as a specific - info_type. - id: GooglePrivacyDlpV2InfoTypeTransformation - properties: - primitiveTransformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - description: Required. Primitive transformation to apply to the infoType. - infoTypes: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - InfoTypes to apply the transformation to. An empty list will cause - this transformation to apply to all findings that correspond to - infoTypes that were requested in `InspectConfig`. - type: array + Name of the information type. Either a name of your choosing when + creating a CustomInfoType, or one of the names listed at + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + when specifying a built-in type. When sending Cloud DLP results to + Data Catalog, infoType names should conform to the pattern + `[A-Za-z0-9$_-]{1,64}`. + description: Type of information detected by the API. type: object - GooglePrivacyDlpV2OtherInfoTypeSummary: + GooglePrivacyDlpV2DocumentLocation: type: object + id: GooglePrivacyDlpV2DocumentLocation properties: - excludedFromAnalysis: - description: >- - Whether this infoType was excluded from sensitivity and risk - analysis due to factors such as low prevalence (subject to change). - type: boolean - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The other infoType. - estimatedPrevalence: + fileOffset: + format: int64 description: >- - Approximate percentage of non-null rows that contained data detected - by this infotype. - format: int32 - type: integer - description: Infotype details for other infoTypes found within a column. - id: GooglePrivacyDlpV2OtherInfoTypeSummary - GooglePrivacyDlpV2TransformationLocation: + Offset of the line, from the beginning of the file, where the + finding is located. + type: string + description: Location of a finding within a document. + GooglePrivacyDlpV2PublishToStackdriver: + description: >- + Enable Stackdriver metric dlp.googleapis.com/finding_count. This will + publish a metric to stack driver on each infotype requested and how many + findings were found for it. CustomDetectors will be bucketed as 'Custom' + under the Stackdriver label 'info_type'. + properties: {} + id: GooglePrivacyDlpV2PublishToStackdriver type: object - id: GooglePrivacyDlpV2TransformationLocation - description: Specifies the location of a transformation. + GooglePrivacyDlpV2DlpJob: properties: - findingId: + jobTriggerName: type: string description: >- - For infotype transformations, link to the corresponding findings ID - so that location information does not need to be duplicated. Each - findings ID correlates to an entry in the findings output table, - this table only gets created when users specify to save findings - (add the save findings action to the request). - recordTransformation: - description: >- - For record transformations, provide a field and container - information. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' - containerType: + If created by a job trigger, the resource name of the trigger that + instantiated the job. + startTime: + description: Time when the job started. + format: google-datetime + type: string + inspectDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' + description: Results from inspecting a data source. + errors: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + type: array + description: A stream of errors encountered running the job. + lastModified: + format: google-datetime + description: Time when the job was last modified by the system. + type: string + type: enum: - - TRANSFORM_UNKNOWN_CONTAINER - - TRANSFORM_BODY - - TRANSFORM_METADATA - - TRANSFORM_TABLE - description: >- - Information about the functionality of the container where this - finding occurred, if available. - enumDescriptions: - - Unused. - - Body of a file. - - Metadata for a file. - - A table. + - DLP_JOB_TYPE_UNSPECIFIED + - INSPECT_JOB + - RISK_ANALYSIS_JOB type: string - GooglePrivacyDlpV2ActionDetails: - description: The results of an Action. - type: object - properties: - deidentifyDetails: - description: Outcome of a de-identification action. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' - id: GooglePrivacyDlpV2ActionDetails - GooglePrivacyDlpV2SensitivityScore: - properties: - score: + enumDescriptions: + - Defaults to INSPECT_JOB. + - The job inspected Google Cloud for sensitive data. + - The job executed a Risk Analysis computation. + description: The type of job. + riskDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' + description: Results from analyzing risk of a data source. + endTime: + format: google-datetime + description: Time when the job finished. + type: string + state: enumDescriptions: - Unused. + - The job has not yet started. - >- - No sensitive information detected. The resource isn't publicly - accessible. - - Unable to determine sensitivity. - - >- - Medium risk. Contains personally identifiable information (PII), - potentially sensitive data, or fields with free-text data that are - at a higher risk of having intermittent sensitive data. Consider - limiting access. + The job is currently running. Once a job has finished it will + transition to FAILED or DONE. + - The job is no longer running. + - The job was canceled before it could be completed. + - The job had an error and did not complete. - >- - High risk. Sensitive personally identifiable information (SPII) - can be present. Exfiltration of data can lead to user data loss. - Re-identification of users might be possible. Consider limiting - usage and or removing SPII. - description: The sensitivity score applied to the resource. + The job is currently accepting findings via hybridInspect. A + hybrid job in ACTIVE state may continue to have findings added to + it through the calling of hybridInspect. After the job has + finished no more calls to hybridInspect may be made. ACTIVE jobs + can transition to DONE. enum: - - SENSITIVITY_SCORE_UNSPECIFIED - - SENSITIVITY_LOW - - SENSITIVITY_UNKNOWN - - SENSITIVITY_MODERATE - - SENSITIVITY_HIGH + - JOB_STATE_UNSPECIFIED + - PENDING + - RUNNING + - DONE + - CANCELED + - FAILED + - ACTIVE + description: State of a job. + type: string + actionDetails: + description: Events that should occur after the job has completed. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' + type: array + name: + type: string + description: The server-assigned name. + createTime: + format: google-datetime + description: Time when the job was created. type: string + id: GooglePrivacyDlpV2DlpJob + description: Combines all of the information about a DLP job. type: object - id: GooglePrivacyDlpV2SensitivityScore - description: >- - Score is calculated from of all elements in the data profile. A higher - level means the data is more sensitive. - GooglePrivacyDlpV2CloudSqlIamCredential: + GooglePrivacyDlpV2DiscoveryFileStoreConditions: + id: GooglePrivacyDlpV2DiscoveryFileStoreConditions type: object description: >- - Use IAM authentication to connect. This requires the Cloud SQL IAM - feature to be enabled on the instance, which is not the default for - Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication - and https://cloud.google.com/sql/docs/mysql/authentication. - properties: {} - id: GooglePrivacyDlpV2CloudSqlIamCredential - GooglePrivacyDlpV2RedactImageRequest: - id: GooglePrivacyDlpV2RedactImageRequest + Requirements that must be true before a file store is scanned in + discovery for the first time. There is an AND relationship between the + top-level attributes. properties: - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: Configuration for the inspector. - locationId: - type: string - description: Deprecated. This field has no effect. - includeFindings: - type: boolean + cloudStorageConditions: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageConditions + description: Optional. Cloud Storage conditions. + minAge: description: >- - Whether the response should include findings along with the redacted - image. - byteItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' - description: The content must be PNG, JPEG, SVG or BMP. - imageRedactionConfigs: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' - description: The configuration for specifying what content to redact from images. - type: object - description: >- - Request to search for potentially sensitive info in an image and redact - it by covering it with a colored rectangle. - GooglePrivacyDlpV2ColumnDataProfile: - id: GooglePrivacyDlpV2ColumnDataProfile - type: object - description: The profile for a scanned column within a table. - properties: - tableDataProfile: - description: The resource name of the table data profile. + Optional. Minimum age a file store must have. If set, the value must + be 1 hour or greater. + format: google-duration type: string - datasetLocation: - description: >- - The BigQuery location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - locations. + createdAfter: + format: google-datetime type: string - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level for this column. - name: + description: >- + Optional. File store must have been created after this date. Used to + avoid backfilling. + GooglePrivacyDlpV2SummaryResult: + id: GooglePrivacyDlpV2SummaryResult + properties: + count: + format: int64 + description: Number of transformations counted by this result. type: string - description: The name of the profile. - tableFullResource: - description: The resource name of the resource this column is within. + code: + description: Outcome of the transformation. type: string - columnType: + enumDescriptions: + - Unused + - Transformation completed without an error. + - Transformation had an error. enum: - - COLUMN_DATA_TYPE_UNSPECIFIED - - TYPE_INT64 - - TYPE_BOOL - - TYPE_FLOAT64 - - TYPE_STRING - - TYPE_BYTES - - TYPE_TIMESTAMP - - TYPE_DATE - - TYPE_TIME - - TYPE_DATETIME - - TYPE_GEOGRAPHY - - TYPE_NUMERIC - - TYPE_RECORD - - TYPE_BIGNUMERIC - - TYPE_JSON - - TYPE_INTERVAL - - TYPE_RANGE_DATE - - TYPE_RANGE_DATETIME - - TYPE_RANGE_TIMESTAMP + - TRANSFORMATION_RESULT_CODE_UNSPECIFIED + - SUCCESS + - ERROR + details: type: string - enumDescriptions: - - Invalid type. - - Encoded as a string in decimal format. - - Encoded as a boolean "false" or "true". - - Encoded as a number, or string "NaN", "Infinity" or "-Infinity". - - Encoded as a string value. - - Encoded as a base64 string per RFC 4648, section 4. - - >- - Encoded as an RFC 3339 timestamp with mandatory "Z" time zone - string: 1985-04-12T23:20:50.52Z - - 'Encoded as RFC 3339 full-date format string: 1985-04-12' - - 'Encoded as RFC 3339 partial-time format string: 23:20:50.52' - - >- - Encoded as RFC 3339 full-date "T" partial-time: - 1985-04-12T23:20:50.52 - - Encoded as WKT - - Encoded as a decimal string. - - Container of ordered fields, each with a type and field name. - - Decimal type. - - Json type. - - Interval type. - - '`Range` type.' - - '`Range` type.' - - '`Range` type.' - description: The data type of a given column. - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - profileLastGenerated: - description: The last time the profile was generated. - type: string - format: google-datetime - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity of this column. - columnInfoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + A place for warnings or errors to show up if a transformation didn't + work as expected. + description: >- + A collection that informs the user the number of times a particular + `TransformationResultCode` and error details occurred. + type: object + GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: + type: object + properties: + deidentifyTemplate: + description: Required. The DeidentifyTemplate to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + templateId: description: >- - If it's been determined this column can be identified as a single - type, this will be set. Otherwise the column either has - unidentifiable content or mixed types. - otherMatches: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - description: Other types found within this column. List will be unordered. - type: array - datasetId: + The template id can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - description: The BigQuery dataset ID. - tableId: + locationId: + description: Deprecated. This field has no effect. type: string - description: The BigQuery table ID. - column: + description: Request message for CreateDeidentifyTemplate. + id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + GooglePrivacyDlpV2HybridInspectStatistics: + description: Statistics related to processing hybrid inspect requests. + type: object + properties: + abortedCount: type: string - description: The name of the column. - estimatedNullPercentage: - enum: - - NULL_PERCENTAGE_LEVEL_UNSPECIFIED - - NULL_PERCENTAGE_VERY_LOW - - NULL_PERCENTAGE_LOW - - NULL_PERCENTAGE_MEDIUM - - NULL_PERCENTAGE_HIGH - enumDescriptions: - - Unused. - - Very few null entries. - - Some null entries. - - A few null entries. - - A lot of null entries. - type: string - description: Approximate percentage of entries being null in the column. - datasetProjectId: + description: >- + The number of hybrid inspection requests aborted because the job ran + out of quota or was ended before they could be processed. + format: int64 + processedCount: type: string - description: The Google Cloud project ID that owns the profiled resource. - state: + format: int64 + description: The number of hybrid inspection requests processed within this job. + pendingCount: type: string - description: State of a profile. - enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE - policyState: - enum: - - COLUMN_POLICY_STATE_UNSPECIFIED - - COLUMN_POLICY_TAGGED - description: Indicates if a policy tag has been applied to the column. + description: >- + The number of hybrid requests currently being processed. Only + populated when called via method `getDlpJob`. A burst of traffic may + cause hybrid inspect requests to be enqueued. Processing will take + place as quickly as possible, but resource limitations may impact + how long a request is enqueued for. + format: int64 + id: GooglePrivacyDlpV2HybridInspectStatistics + GooglePrivacyDlpV2DatabaseResourceRegexes: + description: >- + A collection of regular expressions to determine what database resources + to match against. + type: object + id: GooglePrivacyDlpV2DatabaseResourceRegexes + properties: + patterns: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' + description: >- + A group of regular expression patterns to match against one or more + database resources. Maximum of 100 entries. The sum of all regular + expression's length can't exceed 10 KiB. + type: array + GooglePrivacyDlpV2WordList: + properties: + words: + description: >- + Words or phrases defining the dictionary. The dictionary must + contain at least one phrase and every phrase must contain at least 2 + characters that are letters or digits. [required] + items: + type: string + type: array + type: object + description: Message defining a list of words or phrases to search for in the data. + id: GooglePrivacyDlpV2WordList + GooglePrivacyDlpV2KMapEstimationResult: + description: >- + Result of the reidentifiability analysis. Note that these results are an + estimation, not exact values. + id: GooglePrivacyDlpV2KMapEstimationResult + properties: + kMapEstimationHistogram: + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket + description: >- + The intervals [min_anonymity, max_anonymity] do not overlap. If a + value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: + 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, + max_anonymity: 10, frequency: 99} mean that there are no record with + an estimated anonymity of 4, 5, or larger than 10. + type: array + type: object + GooglePrivacyDlpV2Condition: + description: >- + The field type of `value` and `field` do not need to match to be + considered equal, but not all comparisons are possible. EQUAL_TO and + NOT_EQUAL_TO attempt to compare even with incompatible types, but all + other comparisons are invalid with incompatible types. A `value` of + type: - `string` can be compared against all other types - `boolean` can + only be compared against other booleans - `integer` can be compared + against doubles or a string if the string value can be parsed as an + integer. - `double` can be compared against integers or a string if the + string can be parsed as a double. - `Timestamp` can be compared against + strings in RFC 3339 date string format. - `TimeOfDay` can be compared + against timestamps and strings in the format of 'HH:mm:ss'. If we fail + to compare do to type mismatch, a warning will be given and the + condition will evaluate to false. + type: object + id: GooglePrivacyDlpV2Condition + properties: + operator: type: string - enumDescriptions: - - No policy tags. - - Column has policy tag applied. - estimatedUniquenessScore: + description: >- + Required. Operator used to compare the field or infoType to the + value. enum: - - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED - - UNIQUENESS_SCORE_LOW - - UNIQUENESS_SCORE_MEDIUM - - UNIQUENESS_SCORE_HIGH - description: Approximate uniqueness of the column. + - RELATIONAL_OPERATOR_UNSPECIFIED + - EQUAL_TO + - NOT_EQUAL_TO + - GREATER_THAN + - LESS_THAN + - GREATER_THAN_OR_EQUALS + - LESS_THAN_OR_EQUALS + - EXISTS enumDescriptions: - - >- - Some columns do not have estimated uniqueness. Possible reasons - include having too few values. - - >- - Low uniqueness, possibly a boolean, enum or similiarly typed - column. - - Medium uniqueness. - - >- - High uniqueness, possibly a column of free text or unique - identifiers. - type: string - freeTextScore: + - Unused + - Equal. Attempts to match even with incompatible types. + - Not equal to. Attempts to match even with incompatible types. + - Greater than. + - Less than. + - Greater than or equals. + - Less than or equals. + - Exists + value: + description: Value to compare against. [Mandatory, except for `EXISTS` tests.] + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + field: description: >- - The likelihood that this column contains free-form text. A value - close to 1 may indicate the column is likely to contain free-form or - natural language text. Range in 0-1. - format: double - type: number + Required. Field within the record this condition is evaluated + against. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' GooglePrivacyDlpV2RecordSuppression: - id: GooglePrivacyDlpV2RecordSuppression description: >- Configuration to suppress records whose suppression conditions evaluate to true. type: object + id: GooglePrivacyDlpV2RecordSuppression properties: condition: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' description: >- A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' - GooglePrivacyDlpV2AllOtherResources: - properties: {} + GooglePrivacyDlpV2UpdateConnectionRequest: type: object - description: Match discovery resources not covered by any other filter. - id: GooglePrivacyDlpV2AllOtherResources - GooglePrivacyDlpV2RecordCondition: + id: GooglePrivacyDlpV2UpdateConnectionRequest properties: - expressions: - description: An expression. - $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' - id: GooglePrivacyDlpV2RecordCondition - description: >- - A condition for determining whether a transformation should be applied - to a field. - type: object - GooglePrivacyDlpV2JobTrigger: - id: GooglePrivacyDlpV2JobTrigger + connection: + description: Required. The connection with new values for the relevant fields. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + updateMask: + format: google-fieldmask + description: Optional. Mask to control which fields get updated. + type: string + description: Request message for UpdateConnection. + GooglePrivacyDlpV2CategoricalStatsConfig: type: object description: >- - Contains a configuration to make API calls on a repeating basis. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers - to learn more. + Compute numerical stats over an individual column, including number of + distinct values and value count distribution. properties: - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - readOnly: true + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Output only. A stream of errors encountered when the trigger was - activated. Repeated errors may result in the JobTrigger - automatically being paused. Will return the last 100 errors. - Whenever the JobTrigger is modified this list will be cleared. - type: array - lastRunTime: - description: Output only. The timestamp of the last time this trigger executed. - readOnly: true + Field to compute categorical stats on. All column types are + supported except for arrays and structs. However, it may be more + informative to use NumericalStats when the field type is supported, + depending on the data. + id: GooglePrivacyDlpV2CategoricalStatsConfig + GooglePrivacyDlpV2DetectionRule: + properties: + hotwordRule: + description: Hotword-based detection rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + type: object + id: GooglePrivacyDlpV2DetectionRule + description: >- + Deprecated; use `InspectionRuleSet` instead. Rule for modifying a + `CustomInfoType` to alter behavior under certain circumstances, + depending on the specific details of the rule. Not supported for the + `surrogate_type` custom infoType. + GooglePrivacyDlpV2TransformationOverview: + properties: + transformedBytes: type: string - format: google-datetime - triggers: + format: int64 + description: Total size in bytes that were transformed in some way. + transformationSummaries: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' type: array - description: >- - A list of triggers which will be OR'ed together. Only one in the - list needs to trigger for a job to be started. The list may contain - only a single Schedule trigger and must have at least one object. - status: - enumDescriptions: - - Unused. - - Trigger is healthy. - - Trigger is temporarily paused. - - Trigger is cancelled and can not be resumed. - description: Required. A status for this trigger. - type: string - enum: - - STATUS_UNSPECIFIED - - HEALTHY - - PAUSED - - CANCELLED - updateTime: - readOnly: true - type: string - description: Output only. The last update timestamp of a triggeredJob. - format: google-datetime - inspectJob: - description: For inspect jobs, a snapshot of the configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: - description: User provided description (max 256 chars) - type: string - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The creation timestamp of a triggeredJob. - name: + description: Transformations applied to the dataset. + id: GooglePrivacyDlpV2TransformationOverview + type: object + description: Overview of the modifications that occurred. + GooglePrivacyDlpV2SecretManagerCredential: + type: object + description: >- + A credential consisting of a username and password, where the password + is stored in a Secret Manager resource. Note: Secret Manager [charges + apply](https://cloud.google.com/secret-manager/pricing). + properties: + passwordSecretVersionName: type: string description: >- - Unique resource name for the triggeredJob, assigned by the service - when the triggeredJob is created, for example - `projects/dlp-test-project/jobTriggers/53234423`. - displayName: - description: Display name (max 100 chars) + Required. The name of the Secret Manager resource that stores the + password, in the form + `projects/project-id/secrets/secret-name/versions/version`. + username: type: string - GooglePrivacyDlpV2RiskAnalysisJobConfig: + description: Required. The username. + id: GooglePrivacyDlpV2SecretManagerCredential + GooglePrivacyDlpV2FileStoreInfoTypeSummary: + type: object + id: GooglePrivacyDlpV2FileStoreInfoTypeSummary + properties: + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: The InfoType seen. + description: Information regarding the discovered InfoType. + GooglePrivacyDlpV2DataProfileBigQueryRowSchema: type: object + id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema description: >- - Configuration for a risk analysis job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis - to learn more. + The schema of data to be saved to the BigQuery table when the + `DataProfileAction` is enabled. properties: - sourceTable: - description: Input dataset to compute metrics over. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - privacyMetric: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - description: Privacy metric to compute. - actions: + columnProfile: + description: Column data profile column + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + fileStoreProfile: + description: File store data profile column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + tableProfile: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + description: Table data profile column + GooglePrivacyDlpV2FileClusterSummary: + id: GooglePrivacyDlpV2FileClusterSummary + type: object + properties: + noFilesExist: + description: >- + True if no files exist in this cluster. If the bucket had more files + than could be listed, this will be false even if no files for this + cluster were seen and file_extensions_seen is empty. + type: boolean + fileExtensionsScanned: type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' description: >- - Actions to execute at the completion of the job. Are executed in the - order provided. + A sample of file types scanned in this cluster. Empty if no files + were scanned. File extensions can be derived from the file name or + the file content. + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: >- + The data risk level of this cluster. RISK_LOW if nothing has been + scanned. + fileExtensionsSeen: + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' - id: GooglePrivacyDlpV2RiskAnalysisJobConfig - GooglePrivacyDlpV2DiscoveryTableModifiedCadence: - description: The cadence at which to update data profiles when a table is modified. - id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence - type: object - properties: - types: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' + description: >- + A sample of file types seen in this cluster. Empty if no files were + seen. File extensions can be derived from the file name or the file + content. + fileStoreInfoTypeSummaries: items: - type: string - enum: - - TABLE_MODIFICATION_UNSPECIFIED - - TABLE_MODIFIED_TIMESTAMP - enumDescriptions: - - Unused. - - >- - A table will be considered modified when the last_modified_time - from BigQuery has been updated. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' type: array + description: InfoTypes detected in this cluster. + errors: description: >- - The type of events to consider when deciding if the table has been - modified and should have the profile updated. Defaults to - MODIFIED_TIMESTAMP. - frequency: - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - type: string + A list of errors detected while scanning this cluster. The list is + truncated to 10 per cluster. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + fileClusterType: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterType' + description: The file cluster type. + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' description: >- - How frequently data profiles can be updated when tables are - modified. Defaults to never. - GooglePrivacyDlpV2Export: - id: GooglePrivacyDlpV2Export - type: object - description: >- - If set, the detailed data profiles will be persisted to the location of - your choice whenever updated. + The sensitivity score of this cluster. The score will be + SENSITIVITY_LOW if nothing has been scanned. + description: The file cluster summary. + GooglePrivacyDlpV2TransformationLocation: properties: - profileTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + containerType: description: >- - Store all table and column profiles in an existing table or a new - table in an existing dataset. Each re-generation will result in new - rows in BigQuery. Data is inserted using [streaming - insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) - and so data may be in the buffer for a period of time after the - profile has finished. The Pub/Sub notification is sent before the - streaming buffer is guaranteed to be written, so data may not be - instantly visible to queries by the time your topic receives the - Pub/Sub notification. - GooglePrivacyDlpV2OutputStorageConfig: - properties: - outputSchema: + Information about the functionality of the container where this + finding occurred, if available. enumDescriptions: - Unused. - - >- - Basic schema including only `info_type`, `quote`, `certainty`, and - `timestamp`. - - Schema tailored to findings from scanning Cloud Storage. - - Schema tailored to findings from scanning Google Datastore. - - Schema tailored to findings from scanning Google BigQuery. - - Schema containing all columns. - enum: - - OUTPUT_SCHEMA_UNSPECIFIED - - BASIC_COLUMNS - - GCS_COLUMNS - - DATASTORE_COLUMNS - - BIG_QUERY_COLUMNS - - ALL_COLUMNS + - Body of a file. + - Metadata for a file. + - A table. type: string + enum: + - TRANSFORM_UNKNOWN_CONTAINER + - TRANSFORM_BODY + - TRANSFORM_METADATA + - TRANSFORM_TABLE + findingId: description: >- - Schema used for writing the findings for Inspect jobs. This field is - only used for Inspect and must be unspecified for Risk jobs. Columns - are derived from the `Finding` object. If appending to an existing - table, any columns from the predefined schema that are missing will - be added. No columns in the existing table will be deleted. If - unspecified, then all available columns will be used for a new table - or an (existing) table with no schema, and no changes will be made - to an existing table that has a schema. Only for use with external - storage. - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + For infotype transformations, link to the corresponding findings ID + so that location information does not need to be duplicated. Each + findings ID correlates to an entry in the findings output table, + this table only gets created when users specify to save findings + (add the save findings action to the request). + type: string + recordTransformation: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' description: >- - Store findings in an existing table or a new table in an existing - dataset. If table_id is not set a new one will be generated for you - with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. - Pacific time zone will be used for generating the date details. For - Inspect, each column in an existing output table must have the same - name, type, and mode of a field in the `Finding` object. For Risk, - an existing output table should be the output of a previous Risk - analysis job run on the same source table, with the same privacy - metric and quasi-identifiers. Risk jobs that analyze the same table - but compute a different privacy metric, or use different sets of - quasi-identifiers, cannot store their results in the same table. - id: GooglePrivacyDlpV2OutputStorageConfig + For record transformations, provide a field and container + information. + description: Specifies the location of a transformation. type: object - description: Cloud repository for storing output. - GooglePrivacyDlpV2DeidentifyConfig: - description: The configuration that controls how the data will change. - id: GooglePrivacyDlpV2DeidentifyConfig + id: GooglePrivacyDlpV2TransformationLocation + GooglePrivacyDlpV2Key: + id: GooglePrivacyDlpV2Key + description: >- + A unique identifier for a Datastore entity. If a key's partition ID or + any of its path kinds or names are reserved/read-only, the key is + reserved/read-only. A reserved/read-only key is forbidden in certain + documented contexts. properties: - transformationErrorHandling: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' + path: description: >- - Mode for handling transformation errors. If left unspecified, the - default mode is `TransformationErrorHandling.ThrowError`. - infoTypeTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - description: >- - Treat the dataset as free-form text and apply the same free text - transformation everywhere. - imageTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' - description: Treat the dataset as an image and redact. - recordTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' + The entity path. An entity path consists of one or more elements + composed of a kind and a string or numerical identifier, which + identify entities. The first element identifies a _root entity_, the + second element identifies a _child_ of the root entity, the third + element identifies a child of the second entity, and so forth. The + entities identified by all prefixes of the path are called the + element's _ancestors_. A path can never be empty, and a path can + have at most 100 elements. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' + partitionId: + $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' description: >- - Treat the dataset as structured. Transformations can be applied to - specific locations within structured datasets, such as transforming - a column within a table. + Entities are partitioned into subsets, currently identified by a + project ID and namespace ID. Queries are scoped to a single + partition. type: object - GooglePrivacyDlpV2ListTableDataProfilesResponse: - description: List of profiles generated for a given organization or project. + GooglePrivacyDlpV2DiscoveryConfig: type: object + id: GooglePrivacyDlpV2DiscoveryConfig properties: - tableDataProfiles: - description: List of data profiles. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - type: array - nextPageToken: + displayName: + description: Display name (max 100 chars) + type: string + name: type: string - description: The next page token. - id: GooglePrivacyDlpV2ListTableDataProfilesResponse - GooglePrivacyDlpV2DiscoveryBigQueryFilter: - type: object - description: >- - Determines what tables will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID, dataset ID, and table ID. - properties: - otherTables: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' - description: >- - Catch-all. This should always be the last filter in the list because - anything above it will apply first. Should only appear once in a - configuration. If none is specified, a default one will be added - automatically. - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableReference' - description: >- - The table to scan. Discovery configurations including this can only - include one DiscoveryTarget (the DiscoveryTarget with this - TableReference). - tables: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableCollection' description: >- - A specific set of tables for this filter to apply to. A table - collection must be specified in only one filter per config. If a - table id or dataset is empty, Cloud DLP assumes all tables in that - collection must be profiled. Must specify a project ID. - id: GooglePrivacyDlpV2DiscoveryBigQueryFilter - GooglePrivacyDlpV2FileStoreDataProfile: - description: 'The profile for a file store. * Cloud Storage: maps 1:1 with a bucket.' - type: object - id: GooglePrivacyDlpV2FileStoreDataProfile - properties: - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity score of this resource. - fileClusterSummaries: - description: FileClusterSummary per each cluster. + Unique resource name for the DiscoveryConfig, assigned by the + service when the DiscoveryConfig is created, for example + `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + status: + description: Required. A status for this configuration. + enum: + - STATUS_UNSPECIFIED + - RUNNING + - PAUSED + enumDescriptions: + - Unused + - The discovery config is currently active. + - The discovery config is paused temporarily. + type: string + actions: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterSummary' + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' type: array - fileStoreInfoTypeSummaries: + description: Actions to execute at the completion of scanning. + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The creation timestamp of a DiscoveryConfig. + targets: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' - description: InfoTypes detected in this file store. - dataStorageLocations: - items: - type: string - type: array + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' description: >- - For resources that have multiple storage locations, these are those - regions. For Cloud Storage this is the list of regions chosen for - dual-region storage. `file_store_location` will normally be the - corresponding multi-region for the list of individual locations. The - first region is always picked as the processing and storage location - for the data profile. - fileStoreLocation: - type: string + Target to match against for determining what to scan and how + frequently. + orgConfig: + description: Only set when the parent is an org. + $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' + lastRunTime: + readOnly: true description: >- - The location of the file store. * Cloud Storage: - https://cloud.google.com/storage/docs/locations#available-locations - profileLastGenerated: + Output only. The timestamp of the last time this config was + executed. type: string - description: The last time the profile was generated. format: google-datetime - configSnapshot: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' - description: The snapshot of the configurations used to generate the profile. - fileStorePath: - type: string - description: 'The file store path. * Cloud Storage: `gs://{bucket}`' - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + inspectTemplates: + type: array description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - resourceAttributes: - additionalProperties: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + Detection logic for profile generation. Not all template features + are used by Discovery. FindingLimits, include_quote and + exclude_info_types have no impact on Discovery. Multiple templates + may be provided if there is data in multiple regions. At most one + template must be specified per-region (including "global"). Each + region is scanned using the applicable template. If no + region-specific template is specified, but a "global" template is + specified, it will be copied to that region and used instead. If no + global or region-specific template is provided for a region with + data, that region's data will not be scanned. For more information, + see + https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + items: + type: string + errors: description: >- - Attributes of the resource being profiled. Currently used - attributes: * customer_managed_encryption: boolean - true: the - resource is encrypted with a customer-managed key. - false: the - resource is encrypted with a provider-managed key. - type: object - projectId: + Output only. A stream of errors encountered when the config was + activated. Repeated errors may result in the config automatically + being paused. Output only field. Will return the last 100 errors. + Whenever the config is modified this list will be cleared. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + readOnly: true + updateTime: + format: google-datetime + readOnly: true + description: Output only. The last update timestamp of a DiscoveryConfig. + type: string + description: >- + Configuration for discovery to scan resources for profile generation. + Only one discovery configuration may exist per organization, folder, or + project. The generated data profiles are retained according to the [data + retention policy] + (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + GooglePrivacyDlpV2DataRiskLevel: + type: object + description: >- + Score is a summary of all elements in the data profile. A higher number + means more risk. + properties: + score: type: string - description: The Google Cloud project ID that owns the resource. - state: - description: State of a profile. - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE enumDescriptions: - Unused. - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. + Low risk - Lower indication of sensitive data that appears to have + additional access restrictions in place or no indication of + sensitive data found. + - Unable to determine risk. - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. + Medium risk - Sensitive data may be present but additional access + or fine grain access restrictions appear to be present. Consider + limiting access even further or transform data to mask. + - >- + High risk – SPII may be present. Access controls may include + public ACLs. Exfiltration of data may lead to user data loss. + Re-identification of users may be possible. Consider limiting + usage and or removing SPII. + enum: + - RISK_SCORE_UNSPECIFIED + - RISK_LOW + - RISK_UNKNOWN + - RISK_MODERATE + - RISK_HIGH + description: The score applied to the resource. + id: GooglePrivacyDlpV2DataRiskLevel + GoogleProtobufEmpty: + 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); } + properties: {} + id: GoogleProtobufEmpty + type: object + GooglePrivacyDlpV2DeidentifyTemplate: + id: GooglePrivacyDlpV2DeidentifyTemplate + description: >- + DeidentifyTemplates contains instructions on how to de-identify content. + See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates + to learn more. + properties: + deidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + description: The core content of the template. + displayName: + description: Display name (max 256 chars). type: string - projectDataProfile: - description: The resource name of the project data profile for this file store. + description: type: string - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' - description: The resource type that was profiled. - fullResource: - type: string - description: >- - The resource name of the resource profiled. - https://cloud.google.com/apis/design/resource_names#full_resource_name - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level of this resource. - resourceLabels: - type: object - description: >- - The labels applied to the resource at the time the profile was - generated. - additionalProperties: - type: string + description: Short description (max 256 chars). createTime: - format: google-datetime - description: The time the file store was first created. type: string - lastModifiedTime: + format: google-datetime + readOnly: true + description: Output only. The creation timestamp of an inspectTemplate. + updateTime: + description: Output only. The last update timestamp of an inspectTemplate. type: string + readOnly: true format: google-datetime - description: The time the file store was last modified. - fileStoreIsEmpty: - type: boolean - description: The file store does not have any files. name: type: string - description: The name of the profile. - resourceVisibility: - enum: - - RESOURCE_VISIBILITY_UNSPECIFIED - - RESOURCE_VISIBILITY_PUBLIC - - RESOURCE_VISIBILITY_INCONCLUSIVE - - RESOURCE_VISIBILITY_RESTRICTED - type: string - enumDescriptions: - - Unused. - - Visible to any user. - - >- - May contain public items. For example, if a Cloud Storage bucket - has uniform bucket level access disabled, some objects inside it - may be public, but none are known yet. - - Visible only to specific users. - description: How broadly a resource has been shared. - locationType: - type: string - description: >- - The location type of the bucket (region, dual-region, multi-region, - etc). If dual-region, expect data_storage_locations to be populated. - GooglePrivacyDlpV2NumericalStatsConfig: - id: GooglePrivacyDlpV2NumericalStatsConfig - description: >- - Compute numerical stats over an individual column, including min, max, - and quantiles. - properties: - field: + readOnly: true description: >- - Field to compute numerical stats on. Supported types are integer, - float, date, datetime, timestamp, time. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + Output only. The template name. The template will have one of the + following formats: + `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR + `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` + type: object + GooglePrivacyDlpV2TagCondition: type: object - GooglePrivacyDlpV2TimeZone: - id: GooglePrivacyDlpV2TimeZone properties: - offsetMinutes: - format: int32 + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' description: >- - Set only if the offset can be determined. Positive for time ahead of - UTC. E.g. For "UTC-9", this value is -540. - type: integer - type: object - description: Time zone of the date time object. + Conditions attaching the tag to a resource on its profile having + this sensitivity score. + tag: + $ref: '#/components/schemas/GooglePrivacyDlpV2TagValue' + description: The tag value to attach to resources. + id: GooglePrivacyDlpV2TagCondition + description: >- + The tag to attach to profiles matching the condition. At most one + `TagCondition` can be specified per sensitivity level. GooglePrivacyDlpV2BucketingConfig: - id: GooglePrivacyDlpV2BucketingConfig description: >- Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom @@ -6202,213 +5829,116 @@ components: the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. + id: GooglePrivacyDlpV2BucketingConfig + type: object properties: buckets: - type: array + description: Set of buckets. Ranges must be non-overlapping. items: $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' - description: Set of buckets. Ranges must be non-overlapping. - type: object - GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence: - id: GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence + type: array + GooglePrivacyDlpV2DeidentifyContentResponse: + id: GooglePrivacyDlpV2DeidentifyContentResponse + description: Results of de-identifying a ContentItem. properties: - inspectTemplateModifiedCadence: - description: >- - Optional. Governs when to update data profiles when the inspection - rules defined by the `InspectTemplate` change. If not set, changing - the template will not cause a data profile to update. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - refreshFrequency: - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - type: string - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - description: >- - Optional. Data changes in Cloud Storage can't trigger reprofiling. - If you set this field, profiles are refreshed at this frequency - regardless of whether the underlying buckets have changed. Defaults - to never. - description: >- - How often existing buckets should have their profiles refreshed. New - buckets are scanned as quickly as possible depending on system capacity. + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: The de-identified item. + overview: + description: An overview of the changes that were made on the `item`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' type: object - GooglePrivacyDlpV2TransformationDescription: + GooglePrivacyDlpV2CreateDlpJobRequest: + id: GooglePrivacyDlpV2CreateDlpJobRequest type: object description: >- - A flattened description of a `PrimitiveTransformation` or - `RecordSuppression`. + Request message for CreateDlpJobRequest. Used to initiate long running + jobs such as calculating risk metrics or inspecting Google Cloud + Storage. properties: - type: - type: string - enumDescriptions: - - Unused - - Record suppression - - Replace value - - Replace value using a dictionary. - - Redact - - Character mask - - FFX-FPE - - Fixed size bucketing - - Bucketing - - Replace with info type - - Time part - - Crypto hash - - Date shift - - Deterministic crypto - - Redact image - description: The transformation type. - enum: - - TRANSFORMATION_TYPE_UNSPECIFIED - - RECORD_SUPPRESSION - - REPLACE_VALUE - - REPLACE_DICTIONARY - - REDACT - - CHARACTER_MASK - - CRYPTO_REPLACE_FFX_FPE - - FIXED_SIZE_BUCKETING - - BUCKETING - - REPLACE_WITH_INFO_TYPE - - TIME_PART - - CRYPTO_HASH - - DATE_SHIFT - - CRYPTO_DETERMINISTIC_CONFIG - - REDACT_IMAGE - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: Set if the transformation was limited to a specific `InfoType`. - description: + jobId: type: string description: >- - A description of the transformation. This is empty for a - RECORD_SUPPRESSION, or is the output of calling toString() on the - `PrimitiveTransformation` protocol buffer message for any other type - of transformation. - condition: + The job id can contain uppercase and lowercase letters, numbers, and + hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + inspectJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + description: An inspection job scans a storage repository for InfoTypes. + locationId: + description: Deprecated. This field has no effect. type: string + riskJob: description: >- - A human-readable string representation of the `RecordCondition` - corresponding to this transformation. Set if a `RecordCondition` was - used to determine whether or not to apply this transformation. - Examples: * (age_field > 85) * (age_field <= 18) * (zip_field - exists) * (zip_field == 01234) && (city_field != "Springville") * - (zip_field == 01234) && (age_field <= 18) && (city_field exists) - id: GooglePrivacyDlpV2TransformationDescription - GooglePrivacyDlpV2PublishToPubSub: - id: GooglePrivacyDlpV2PublishToPubSub + A risk analysis job calculates re-identification risk metrics for a + BigQuery table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + GooglePrivacyDlpV2FileStoreRegexes: + id: GooglePrivacyDlpV2FileStoreRegexes properties: - topic: + patterns: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegex' description: >- - Cloud Pub/Sub topic to send notifications to. The topic must have - given publishing access rights to the DLP API service account - executing the long running DlpJob sending the notifications. Format - is projects/{project}/topics/{topic}. - type: string + Required. The group of regular expression patterns to match against + one or more file stores. Maximum of 100 entries. The sum of all + regular expression's length can't exceed 10 KiB. description: >- - Publish a message into a given Pub/Sub topic when DlpJob has completed. - The message contains a single field, `DlpJobName`, which is equal to the - finished job's - [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). - Compatible with: Inspect, Risk + A collection of regular expressions to determine what file store to + match against. type: object - GooglePrivacyDlpV2DiscoveryTarget: + GooglePrivacyDlpV2DeltaPresenceEstimationResult: + type: object + id: GooglePrivacyDlpV2DeltaPresenceEstimationResult + description: >- + Result of the δ-presence computation. Note that these results are an + estimation, not exact values. properties: - secretsTarget: - description: >- - Discovery target that looks for credentials and secrets stored in - cloud resource metadata and reports them as vulnerabilities to - Security Command Center. Only one target of this type is allowed. - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' - cloudSqlTarget: - description: >- - Cloud SQL target for Discovery. The first target to match a table - will be the one applied. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' - cloudStorageTarget: + deltaPresenceEstimationHistogram: description: >- - Cloud Storage target for Discovery. The first target to match a - table will be the one applied. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageDiscoveryTarget' - bigQueryTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' - description: >- - BigQuery target for Discovery. The first target to match a table - will be the one applied. - id: GooglePrivacyDlpV2DiscoveryTarget - type: object - description: Target used to match against for Discovery. - GooglePrivacyDlpV2Connection: - description: >- - A data connection to allow DLP to profile data in locations that require - additional configuration. + The intervals [min_probability, max_probability) do not overlap. If + a value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_probability: 0, max_probability: 0.1, frequency: 17} + {min_probability: 0.2, max_probability: 0.3, frequency: 42} + {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean + that there are no record with an estimated probability in [0.1, 0.2) + nor larger or equal to 0.4. + type: array + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + GooglePrivacyDlpV2DiscoveryCloudSqlFilter: + id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter type: object properties: - state: - enum: - - CONNECTION_STATE_UNSPECIFIED - - MISSING_CREDENTIALS - - AVAILABLE - - ERROR - description: Required. The connection's state in its lifecycle. - enumDescriptions: - - Unused - - >- - DLP automatically created this connection during an initial scan, - and it is awaiting full configuration by a user. - - A configured connection that has not encountered any errors. - - >- - A configured connection that encountered errors during its last - use. It will not be used again until it is set to AVAILABLE. If - the resolution requires external action, then the client must send - a request to set the status to AVAILABLE when the connection is - ready for use. If the resolution doesn't require external action, - then any changes to the connection properties will automatically - mark it as AVAILABLE. - type: string - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - readOnly: true - type: array + databaseResourceReference: description: >- - Output only. Set if status == ERROR, to provide additional details. - Will store the last 10 errors sorted with the most recent first. - name: - type: string + The database resource to scan. Targets including this can only + include one target (the target with this database resource + reference). + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' + collection: + description: A specific set of database resources for this filter to apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' + others: description: >- - Output only. Name of the connection: - `projects/{project}/locations/{location}/connections/{name}`. - readOnly: true - cloudSql: - description: Connect to a Cloud SQL instance. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' - id: GooglePrivacyDlpV2Connection - GooglePrivacyDlpV2ReidentifyContentResponse: - description: Results of re-identifying an item. - properties: - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The re-identified item. - overview: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' - description: An overview of the changes that were made to the `item`. - id: GooglePrivacyDlpV2ReidentifyContentResponse - type: object - GooglePrivacyDlpV2PublishToChronicle: - properties: {} - type: object - description: Message expressing intention to publish to Google Security Operations. - id: GooglePrivacyDlpV2PublishToChronicle + Catch-all. This should always be the last target in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherDatabaseResources' + description: >- + Determines what tables will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID, location, instance, database, and + database resource name. GooglePrivacyDlpV2TableLocation: - type: object id: GooglePrivacyDlpV2TableLocation + type: object + description: Location of a finding within a table. properties: rowIndex: description: >- @@ -6420,1315 +5950,1794 @@ components: will be stored inside of Finding. type: string format: int64 - description: Location of a finding within a table. - GooglePrivacyDlpV2NumericalStatsResult: - properties: - maxValue: - description: Maximum value appearing in the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - minValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Minimum value appearing in the column. - quantileValues: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: >- - List of 99 values that partition the set of field values into 100 - equal sized buckets. - id: GooglePrivacyDlpV2NumericalStatsResult - description: Result of the numerical stats computation. + GooglePrivacyDlpV2BigQueryTableTypes: type: object - GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: - description: Request message for UpdateDiscoveryConfig. properties: - updateMask: - type: string - format: google-fieldmask - description: Mask to control which fields get updated. - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: Required. New DiscoveryConfig value. - id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + types: + items: + enum: + - BIG_QUERY_TABLE_TYPE_UNSPECIFIED + - BIG_QUERY_TABLE_TYPE_TABLE + - BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE + enumDescriptions: + - Unused. + - A normal BigQuery table. + - A table that references data stored in Cloud Storage. + type: string + description: A set of BigQuery table types. + type: array + description: The types of BigQuery tables supported by Cloud DLP. + id: GooglePrivacyDlpV2BigQueryTableTypes + GooglePrivacyDlpV2BigQueryOptions: + id: GooglePrivacyDlpV2BigQueryOptions + description: Options defining BigQuery table and row identifiers. type: object - GooglePrivacyDlpV2CreateDlpJobRequest: properties: - riskJob: + rowsLimit: + format: int64 description: >- - A risk analysis job calculates re-identification risk metrics for a - BigQuery table. - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - inspectJob: - description: An inspection job scans a storage repository for InfoTypes. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - locationId: - type: string - description: Deprecated. This field has no effect. - jobId: + Max number of rows to scan. If the table has more rows than this + value, the rest of the rows are omitted. If not set, or if set to 0, + all rows will be scanned. Only one of rows_limit and + rows_limit_percent can be specified. Cannot be used in conjunction + with TimespanConfig. type: string + includedFields: + type: array description: >- - The job id can contain uppercase and lowercase letters, numbers, and - hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - description: >- - Request message for CreateDlpJobRequest. Used to initiate long running - jobs such as calculating risk metrics or inspecting Google Cloud - Storage. - id: GooglePrivacyDlpV2CreateDlpJobRequest - type: object - GooglePrivacyDlpV2TransformationSummary: - id: GooglePrivacyDlpV2TransformationSummary - properties: - fieldTransformations: - description: >- - The field transformation that was applied. If multiple field - transformations are requested for a single field, this list will - contain all of them; otherwise, only one is supplied. + Limit scanning only to these fields. When inspecting a table, we + recommend that you inspect all columns. Otherwise, findings might be + affected because hints from excluded columns will not be used. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' - type: array - recordSuppress: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' - description: The specific suppression option these stats apply to. - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Set if the transformation was limited to a specific FieldId. - transformedBytes: - description: Total size in bytes that were transformed in some way. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + sampleMethod: + enum: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START + enumDescriptions: + - No sampling. + - >- + Scan groups of rows in the order BigQuery provides (default). + Multiple groups of rows may be scanned in parallel, so results may + not appear in the same order the rows are read. + - Randomly pick groups of rows to scan. type: string - format: int64 - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: Set if the transformation was limited to a specific InfoType. - transformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - description: The specific transformation these stats apply to. - results: - type: array + description: How to sample the data. + identifyingFields: + description: >- + Table fields that may uniquely identify a row within the table. When + `actions.saveFindings.outputConfig.table` is specified, the values + of columns specified here are available in the output table under + `location.content_locations.record_location.record_key.id_values`. + Nested fields such as `person.birthdate.year` are allowed. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' - description: Collection of all transformations that took place or had an error. - type: object - description: >- - Summary of a single transformation. Only one of 'transformation', - 'field_transformation', or 'record_suppress' will be set. - GooglePrivacyDlpV2BigQueryRegex: - description: >- - A pattern to match against one or more tables, datasets, or projects - that contain BigQuery tables. At least one pattern must be specified. - Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - type: object - properties: - tableIdRegex: - type: string - description: If unset, this property matches all tables. - datasetIdRegex: - type: string - description: If unset, this property matches all datasets. - projectIdRegex: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + type: array + excludedFields: description: >- - For organizations, if unset, will match all projects. Has no effect - for data profile configurations created within a project. - type: string - id: GooglePrivacyDlpV2BigQueryRegex + References to fields excluded from scanning. This allows you to skip + inspection of entire columns which you know have no findings. When + inspecting a table, we recommend that you inspect all columns. + Otherwise, findings might be affected because hints from excluded + columns will not be used. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + type: array + tableReference: + description: Complete BigQuery table reference. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + rowsLimitPercent: + description: >- + Max percentage of rows to scan. The rest are omitted. The number of + rows scanned is rounded down. Must be between 0 and 100, + inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one + of rows_limit and rows_limit_percent can be specified. Cannot be + used in conjunction with TimespanConfig. Caution: A [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) + is causing the `rowsLimitPercent` field to behave unexpectedly. We + recommend using `rowsLimit` instead. + format: int32 + type: integer + GoogleTypeDate: + type: object + id: GoogleTypeDate + properties: + day: + format: int32 + type: integer + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + year: + format: int32 + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + month: + format: int32 + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + GooglePrivacyDlpV2AllOtherDatabaseResources: + type: object + id: GooglePrivacyDlpV2AllOtherDatabaseResources + description: Match database resources not covered by any other filter. + properties: {} + GooglePrivacyDlpV2BigQueryTableCollection: + properties: + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' + description: >- + A collection of regular expressions to match a BigQuery table + against. + type: object + id: GooglePrivacyDlpV2BigQueryTableCollection + description: Specifies a collection of BigQuery tables. Used for Discovery. GooglePrivacyDlpV2PubSubExpressions: type: object - id: GooglePrivacyDlpV2PubSubExpressions - description: An expression, consisting of an operator and conditions. properties: + conditions: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' + description: Conditions to apply to the expression. + type: array logicalOperator: - type: string + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - OR + - AND description: The operator to apply to the collection of conditions. + type: string enumDescriptions: - Unused. - Conditional OR. - Conditional AND. - enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - OR - - AND - conditions: - description: Conditions to apply to the expression. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' - type: array - GooglePrivacyDlpV2MetadataLocation: - id: GooglePrivacyDlpV2MetadataLocation + id: GooglePrivacyDlpV2PubSubExpressions + description: An expression, consisting of an operator and conditions. + GooglePrivacyDlpV2PublishToChronicle: + properties: {} + type: object + description: Message expressing intention to publish to Google Security Operations. + id: GooglePrivacyDlpV2PublishToChronicle + GooglePrivacyDlpV2Export: + description: >- + If set, the detailed data profiles will be persisted to the location of + your choice whenever updated. + type: object properties: - type: - enum: - - METADATATYPE_UNSPECIFIED - - STORAGE_METADATA + profileTable: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: >- + Store all table and column profiles in an existing table or a new + table in an existing dataset. Each re-generation will result in new + rows in BigQuery. Data is inserted using [streaming + insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) + and so data may be in the buffer for a period of time after the + profile has finished. The Pub/Sub notification is sent before the + streaming buffer is guaranteed to be written, so data may not be + instantly visible to queries by the time your topic receives the + Pub/Sub notification. + id: GooglePrivacyDlpV2Export + GooglePrivacyDlpV2CryptoHashConfig: + description: >- + Pseudonymization method that generates surrogates via cryptographic + hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. + Outputs a base64 encoded representation of the hashed output (for + example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only + string and integer values can be hashed. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + to learn more. + properties: + cryptoKey: + description: The key used by the hash function. + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + id: GooglePrivacyDlpV2CryptoHashConfig + type: object + GooglePrivacyDlpV2Error: + description: >- + Details information about an error encountered during job execution or + the results of an unsuccessful activation of the JobTrigger. + properties: + details: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Detailed error codes and messages. + timestamps: + type: array + items: + type: string + format: google-datetime + description: >- + The times the error occurred. List includes the oldest timestamp and + the last 9 timestamps. + extraInfo: enumDescriptions: - - Unused - - General file metadata provided by Cloud Storage. - description: Type of metadata containing the finding. + - Unused. + - Image scan is not available in the region. + - File store cluster is not supported for profile generation. + description: Additional information about the error. type: string - storageLabel: - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' - description: Storage metadata. + enum: + - ERROR_INFO_UNSPECIFIED + - IMAGE_SCAN_UNAVAILABLE_IN_REGION + - FILE_STORE_CLUSTER_UNSUPPORTED + id: GooglePrivacyDlpV2Error type: object - description: Metadata Location - GooglePrivacyDlpV2ListJobTriggersResponse: + GooglePrivacyDlpV2TableOptions: + id: GooglePrivacyDlpV2TableOptions + description: Instructions regarding the table content being inspected. type: object - id: GooglePrivacyDlpV2ListJobTriggersResponse properties: - jobTriggers: + identifyingFields: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - type: array - description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. - nextPageToken: - type: string + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - If the next page is available then this value is the next page token - to be used in the following ListJobTriggers request. - description: Response message for ListJobTriggers. - GooglePrivacyDlpV2ProjectDataProfile: - id: GooglePrivacyDlpV2ProjectDataProfile + The columns that are the primary keys for table objects included in + ContentItem. A copy of this cell's value will stored alongside + alongside each finding so that the finding can be traced to the + specific row it came from. No more than 3 may be provided. + type: array + GooglePrivacyDlpV2CancelDlpJobRequest: + properties: {} + id: GooglePrivacyDlpV2CancelDlpJobRequest type: object + description: The request message for canceling a DLP job. + GooglePrivacyDlpV2FileStoreRegex: properties: - name: - type: string - description: The resource name of the profile. - sensitivityScore: - description: The sensitivity score of this project. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - tableDataProfileCount: - type: string - description: The number of table data profiles generated for this project. - format: int64 - fileStoreDataProfileCount: + cloudStorageRegex: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegex' + description: Optional. Regex for Cloud Storage. + id: GooglePrivacyDlpV2FileStoreRegex + type: object + description: A pattern to match against one or more file stores. + GooglePrivacyDlpV2InfoTypeStats: + type: object + description: Statistics regarding a specific InfoType. + properties: + count: type: string + description: Number of findings for this infoType. format: int64 - description: The number of file store data profiles generated for this project. - profileLastGenerated: - description: The last time the profile was generated. - format: google-datetime - type: string - dataRiskLevel: - description: The data risk level of this project. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - projectId: - type: string - description: Project ID or account that was profiled. - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - description: Success or error status of the last attempt to profile the project. - description: >- - An aggregated profile for this project, based on the resources profiled - within it. - GooglePrivacyDlpV2ReplaceValueConfig: - description: Replace each input value with a given `Value`. - id: GooglePrivacyDlpV2ReplaceValueConfig + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: The type of finding this stat is for. + id: GooglePrivacyDlpV2InfoTypeStats + GooglePrivacyDlpV2CreateJobTriggerRequest: type: object + id: GooglePrivacyDlpV2CreateJobTriggerRequest + description: Request message for CreateJobTrigger. properties: - newValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Value to replace it with. - GooglePrivacyDlpV2DatastoreKey: - id: GooglePrivacyDlpV2DatastoreKey - description: Record key for a finding in Cloud Datastore. - properties: - entityKey: - description: Datastore entity key. - $ref: '#/components/schemas/GooglePrivacyDlpV2Key' + triggerId: + type: string + description: >- + The trigger id can contain uppercase and lowercase letters, numbers, + and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + locationId: + type: string + description: Deprecated. This field has no effect. + jobTrigger: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + description: Required. The JobTrigger to create. + GooglePrivacyDlpV2HybridInspectResponse: type: object - GooglePrivacyDlpV2InspectDataSourceDetails: + id: GooglePrivacyDlpV2HybridInspectResponse + description: Quota exceeded errors will be thrown once quota has been met. + properties: {} + GooglePrivacyDlpV2ByteContentItem: + id: GooglePrivacyDlpV2ByteContentItem + description: Container for bytes to inspect or redact. properties: - requestedOptions: - description: The configuration used for this job. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' - result: - $ref: '#/components/schemas/GooglePrivacyDlpV2Result' - description: A summary of the outcome of this inspection job. - id: GooglePrivacyDlpV2InspectDataSourceDetails + data: + type: string + description: Content data to inspect or redact. + format: byte + type: + enumDescriptions: + - Unused + - Any image type. + - jpeg + - bmp + - png + - svg + - plain text + - docx, docm, dotx, dotm + - pdf + - pptx, pptm, potx, potm, pot + - xlsx, xlsm, xltx, xltm + - avro + - csv + - tsv + - Audio file types. Only used for profiling. + - Video file types. Only used for profiling. + - Executable file types. Only used for profiling. + type: string + enum: + - BYTES_TYPE_UNSPECIFIED + - IMAGE + - IMAGE_JPEG + - IMAGE_BMP + - IMAGE_PNG + - IMAGE_SVG + - TEXT_UTF8 + - WORD_DOCUMENT + - PDF + - POWERPOINT_DOCUMENT + - EXCEL_DOCUMENT + - AVRO + - CSV + - TSV + - AUDIO + - VIDEO + - EXECUTABLE + description: >- + The type of data stored in the bytes string. Default will be + TEXT_UTF8. type: object - description: The results of an inspect DataSource job. - GooglePrivacyDlpV2Expressions: + GooglePrivacyDlpV2FileClusterType: + description: Message used to identify file cluster type being profiled. type: object - description: An expression, consisting of an operator and conditions. - id: GooglePrivacyDlpV2Expressions properties: - logicalOperator: + cluster: + enum: + - CLUSTER_UNSPECIFIED + - CLUSTER_UNKNOWN + - CLUSTER_TEXT + - CLUSTER_STRUCTURED_DATA + - CLUSTER_SOURCE_CODE + - CLUSTER_RICH_DOCUMENT + - CLUSTER_IMAGE + - CLUSTER_ARCHIVE + - CLUSTER_MULTIMEDIA + - CLUSTER_EXECUTABLE + description: Cluster type. type: string + enumDescriptions: + - Unused. + - Unsupported files. + - Plain text. + - Structured data like CSV, TSV etc. + - Source code. + - Rich document like docx, xlsx etc. + - Images like jpeg, bmp. + - Archives and containers like .zip, .tar etc. + - Multimedia like .mp4, .avi etc. + - Executable files like .exe, .class, .apk etc. + id: GooglePrivacyDlpV2FileClusterType + GooglePrivacyDlpV2DiscoveryBigQueryConditions: + type: object + id: GooglePrivacyDlpV2DiscoveryBigQueryConditions + description: >- + Requirements that must be true before a table is scanned in discovery + for the first time. There is an AND relationship between the top-level + attributes. Additionally, minimum conditions with an OR relationship + that must be met before Cloud DLP scans a table can be set (like a + minimum row count or a minimum table age). + properties: + types: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' + description: Restrict discovery to specific table types. + orConditions: description: >- - The operator to apply to the result of conditions. Default and - currently only supported value is `AND`. + At least one of the conditions must be true for a table to be + scanned. + $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' + typeCollection: + description: Restrict discovery to categories of table types. enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - AND + - BIG_QUERY_COLLECTION_UNSPECIFIED + - BIG_QUERY_COLLECTION_ALL_TYPES + - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES enumDescriptions: - - Unused - - Conditional AND - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' - description: Conditions to apply to the expression. - GooglePrivacyDlpV2InfoTypeCategory: - description: >- - Classification of infoTypes to organize them according to geographic - location, industry, and data type. - type: object - id: GooglePrivacyDlpV2InfoTypeCategory + - Unused. + - >- + Automatically generate profiles for all tables, even if the table + type is not yet fully supported for analysis. Profiles for + unsupported tables will be generated with errors to indicate their + partial support. When full support is added, the tables will + automatically be profiled during the next scheduled run. + - >- + Only those types fully supported will be profiled. Will expand + automatically as Cloud DLP adds support for new table types. + Unsupported table types will not have partial profiles generated. + type: string + createdAfter: + description: >- + BigQuery table must have been created after this date. Used to avoid + backfilling. + type: string + format: google-datetime + GooglePrivacyDlpV2PubSubNotification: properties: - industryCategory: + topic: + description: >- + Cloud Pub/Sub topic to send notifications to. Format is + projects/{project}/topics/{topic}. + type: string + pubsubCondition: + description: >- + Conditions (e.g., data risk or sensitivity level) for triggering a + Pub/Sub. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' + detailOfMessage: enum: - - INDUSTRY_UNSPECIFIED - - FINANCE - - HEALTH - - TELECOMMUNICATIONS + - DETAIL_LEVEL_UNSPECIFIED + - TABLE_PROFILE + - RESOURCE_NAME + - FILE_STORE_PROFILE enumDescriptions: - - Unused industry - - The infoType is typically used in the finance industry. - - The infoType is typically used in the health industry. - - The infoType is typically used in the telecommunications industry. + - Unused. + - The full table data profile. + - The name of the profiled resource. + - The full file store data profile. type: string description: >- - The group of relevant businesses where this infoType is commonly - used - locationCategory: + How much data to include in the Pub/Sub message. If the user wishes + to limit the size of the message, they can use resource_name and + fetch the profile fields they wish to. Per table profile (not per + column). + event: + description: >- + The type of event that triggers a Pub/Sub. At most one + `PubSubNotification` per EventType is permitted. + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED enumDescriptions: - - Unused location + - Unused. + - New profile (not a re-profile). - >- - The infoType is not issued by or tied to a specific region, but is - used almost everywhere. - - The infoType is typically used in Argentina. - - The infoType is typically used in Armenia. - - The infoType is typically used in Australia. - - The infoType is typically used in Azerbaijan. - - The infoType is typically used in Belarus. - - The infoType is typically used in Belgium. - - The infoType is typically used in Brazil. - - The infoType is typically used in Canada. - - The infoType is typically used in Chile. - - The infoType is typically used in China. - - The infoType is typically used in Colombia. - - The infoType is typically used in Croatia. - - The infoType is typically used in Denmark. - - The infoType is typically used in France. - - The infoType is typically used in Finland. - - The infoType is typically used in Germany. - - The infoType is typically used in Hong Kong. - - The infoType is typically used in India. - - The infoType is typically used in Indonesia. - - The infoType is typically used in Ireland. - - The infoType is typically used in Israel. - - The infoType is typically used in Italy. - - The infoType is typically used in Japan. - - The infoType is typically used in Kazakhstan. - - The infoType is typically used in Korea. - - The infoType is typically used in Mexico. - - The infoType is typically used in the Netherlands. - - The infoType is typically used in New Zealand. - - The infoType is typically used in Norway. - - The infoType is typically used in Paraguay. - - The infoType is typically used in Peru. - - The infoType is typically used in Poland. - - The infoType is typically used in Portugal. - - The infoType is typically used in Russia. - - The infoType is typically used in Singapore. - - The infoType is typically used in South Africa. - - The infoType is typically used in Spain. - - The infoType is typically used in Sweden. - - The infoType is typically used in Switzerland. - - The infoType is typically used in Taiwan. - - The infoType is typically used in Thailand. - - The infoType is typically used in Turkey. - - The infoType is typically used in Ukraine. - - The infoType is typically used in the United Kingdom. - - The infoType is typically used in the United States. - - The infoType is typically used in Uruguay. - - The infoType is typically used in Uzbekistan. - - The infoType is typically used in Venezuela. - - The infoType is typically used in Google internally. + One of the following profile metrics changed: Data risk score, + Sensitivity score, Resource visibility, Encryption type, Predicted + infoTypes, Other infoTypes + - Table data risk score or sensitivity score increased. + - A user (non-internal) error occurred. + type: string + id: GooglePrivacyDlpV2PubSubNotification + type: object + description: >- + Send a Pub/Sub message into the given Pub/Sub topic to connect other + systems to data profile generation. The message payload data will be the + byte serialization of `DataProfilePubSubMessage`. + GooglePrivacyDlpV2TimePartConfig: + type: object + properties: + partToExtract: enum: - - LOCATION_UNSPECIFIED - - GLOBAL - - ARGENTINA - - ARMENIA - - AUSTRALIA - - AZERBAIJAN - - BELARUS - - BELGIUM - - BRAZIL - - CANADA - - CHILE - - CHINA - - COLOMBIA - - CROATIA - - DENMARK - - FRANCE - - FINLAND - - GERMANY - - HONG_KONG - - INDIA - - INDONESIA - - IRELAND - - ISRAEL - - ITALY - - JAPAN - - KAZAKHSTAN - - KOREA - - MEXICO - - THE_NETHERLANDS - - NEW_ZEALAND - - NORWAY - - PARAGUAY - - PERU - - POLAND - - PORTUGAL - - RUSSIA - - SINGAPORE - - SOUTH_AFRICA - - SPAIN - - SWEDEN - - SWITZERLAND - - TAIWAN - - THAILAND - - TURKEY - - UKRAINE - - UNITED_KINGDOM - - UNITED_STATES - - URUGUAY - - UZBEKISTAN - - VENEZUELA - - INTERNAL - description: >- - The region or country that issued the ID or document represented by - the infoType. + - TIME_PART_UNSPECIFIED + - YEAR + - MONTH + - DAY_OF_MONTH + - DAY_OF_WEEK + - WEEK_OF_YEAR + - HOUR_OF_DAY type: string - typeCategory: enumDescriptions: - - Unused type - - >- - Personally identifiable information, for example, a name or phone - number - - >- - Personally identifiable information that is especially sensitive, - for example, a passport number. - - >- - Attributes that can partially identify someone, especially in - combination with other attributes, like age, height, and gender. - - Confidential or secret information, for example, a password. - - An identification document issued by a government. - - A document, for example, a resume or source code. - - >- - Information that is not sensitive on its own, but provides details - about the circumstances surrounding an entity or an event. - enum: - - TYPE_UNSPECIFIED - - PII - - SPII - - DEMOGRAPHIC - - CREDENTIAL - - GOVERNMENT_ID - - DOCUMENT - - CONTEXTUAL_INFORMATION - description: The class of identifiers where this infoType belongs + - Unused + - '[0-9999]' + - '[1-12]' + - '[1-31]' + - '[1-7]' + - '[1-53]' + - '[0-23]' + description: The part of the time to keep. + id: GooglePrivacyDlpV2TimePartConfig + description: >- + For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a + portion of the value. + GooglePrivacyDlpV2ProfileStatus: + description: Success or errors for the profile generation. + id: GooglePrivacyDlpV2ProfileStatus + properties: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Profiling status code and optional message. The `status.code` value + is 0 (default value) for OK. + timestamp: + format: google-datetime + description: Time when the profile generation status was updated type: string - GooglePrivacyDlpV2RequestedDeidentifyOptions: type: object - id: GooglePrivacyDlpV2RequestedDeidentifyOptions + GooglePrivacyDlpV2TagResources: + description: >- + If set, attaches the [tags] + (https://cloud.google.com/resource-manager/docs/tags/tags-overview) + provided to profiled resources. Tags support [access + control](https://cloud.google.com/iam/docs/tags-access-control). You can + conditionally grant or deny access to a resource based on whether the + resource has a specific tag. + id: GooglePrivacyDlpV2TagResources + properties: + lowerDataRiskToLow: + type: boolean + description: >- + Whether applying a tag to a resource should lower the risk of the + profile for that resource. For example, in conjunction with an [IAM + deny policy](https://cloud.google.com/iam/docs/deny-overview), you + can deny all principals a permission if a tag value is present, + mitigating the risk of the resource. This also lowers the data risk + of resources at the lower levels of the resource hierarchy. For + example, reducing the data risk of a table data profile also reduces + the data risk of the constituent column data profiles. + tagConditions: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TagCondition' + description: The tags to associate with different conditions. + profileGenerationsToTag: + items: + type: string + enumDescriptions: + - Unused. + - The profile is the first profile for the resource. + - The profile is an update to a previous profile. + enum: + - PROFILE_GENERATION_UNSPECIFIED + - PROFILE_GENERATION_NEW + - PROFILE_GENERATION_UPDATE + description: >- + The profile generations for which the tag should be attached to + resources. If you attach a tag to only new profiles, then if the + sensitivity score of a profile subsequently changes, its tag doesn't + change. By default, this field includes only new profiles. To + include both new and updated profiles for tagging, this field should + explicitly include both `PROFILE_GENERATION_NEW` and + `PROFILE_GENERATION_UPDATE`. + type: array + type: object + GooglePrivacyDlpV2SearchConnectionsResponse: + properties: + nextPageToken: + description: >- + Token to retrieve the next page of results. An empty value means + there are no more results. + type: string + connections: + description: >- + List of connections that match the search query. Note that only a + subset of the fields will be populated, and only "name" is + guaranteed to be set. For full details of a Connection, call + GetConnection with the name. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + description: Response message for SearchConnections. + id: GooglePrivacyDlpV2SearchConnectionsResponse + type: object + GooglePrivacyDlpV2Schedule: + id: GooglePrivacyDlpV2Schedule + properties: + recurrencePeriodDuration: + description: >- + With this option a job is started on a regular periodic basis. For + example: every day (86400 seconds). A scheduled start time will be + skipped if the previous execution has not ended when its scheduled + time occurs. This value must be set to a time duration greater than + or equal to 1 day and can be no longer than 60 days. + format: google-duration + type: string + type: object + description: Schedule for inspect job triggers. + GooglePrivacyDlpV2PublishSummaryToCscc: + type: object + id: GooglePrivacyDlpV2PublishSummaryToCscc + description: >- + Publish the result summary of a DlpJob to [Security Command + Center](https://cloud.google.com/security-command-center). This action + is available for only projects that belong to an organization. This + action publishes the count of finding instances and their infoTypes. The + summary of findings are persisted in Security Command Center and are + governed by [service-specific policies for Security Command + Center](https://cloud.google.com/terms/service-terms). Only a single + instance of this action can be specified. Compatible with: Inspect + properties: {} + GooglePrivacyDlpV2KMapEstimationHistogramBucket: + description: >- + A KMapEstimationHistogramBucket message with the following values: + min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 + records whose quasi-identifier values correspond to 3, 4 or 5 people in + the overlying population. An important particular case is when + min_anonymity = max_anonymity = 1: the frequency field then corresponds + to the number of uniquely identifiable records. + id: GooglePrivacyDlpV2KMapEstimationHistogramBucket + type: object + properties: + bucketValues: + type: array + description: >- + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationQuasiIdValues' + bucketValueCount: + format: int64 + description: >- + Total number of distinct quasi-identifier tuple values in this + bucket. + type: string + minAnonymity: + description: Always positive. + format: int64 + type: string + bucketSize: + format: int64 + type: string + description: Number of records within these anonymity bounds. + maxAnonymity: + format: int64 + type: string + description: Always greater than or equal to min_anonymity. + GooglePrivacyDlpV2FileSet: + type: object + properties: + regexFileSet: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegexFileSet' + description: >- + The regex-filtered set of files to scan. Exactly one of `url` or + `regex_file_set` must be set. + url: + type: string + description: >- + The Cloud Storage url of the file(s) to scan, in the format + `gs:///`. Trailing wildcard in the path is allowed. If the url ends + in a trailing slash, the bucket or directory represented by the url + will be scanned non-recursively (content in sub-directories will not + be scanned). This means that `gs://mybucket/` is equivalent to + `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to + `gs://mybucket/directory/*`. Exactly one of `url` or + `regex_file_set` must be set. + description: Set of files to scan. + id: GooglePrivacyDlpV2FileSet + GooglePrivacyDlpV2RequestedDeidentifyOptions: + description: De-identification options. + type: object + properties: + snapshotDeidentifyTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: >- + Snapshot of the state of the `DeidentifyTemplate` from the + Deidentify action at the time this job was run. + snapshotStructuredDeidentifyTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: >- + Snapshot of the state of the structured `DeidentifyTemplate` from + the `Deidentify` action at the time this job was run. + snapshotImageRedactTemplate: + description: >- + Snapshot of the state of the image transformation + `DeidentifyTemplate` from the `Deidentify` action at the time this + job was run. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + id: GooglePrivacyDlpV2RequestedDeidentifyOptions + GooglePrivacyDlpV2ThrowError: + description: Throw an error and fail the request when a transformation error occurs. + type: object + properties: {} + id: GooglePrivacyDlpV2ThrowError + GooglePrivacyDlpV2HybridInspectJobTriggerRequest: + id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest + description: Request to search for potentially sensitive info in a custom location. + properties: + hybridItem: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + type: object + GooglePrivacyDlpV2TransformationDescription: + id: GooglePrivacyDlpV2TransformationDescription + properties: + condition: + type: string + description: >- + A human-readable string representation of the `RecordCondition` + corresponding to this transformation. Set if a `RecordCondition` was + used to determine whether or not to apply this transformation. + Examples: * (age_field > 85) * (age_field <= 18) * (zip_field + exists) * (zip_field == 01234) && (city_field != "Springville") * + (zip_field == 01234) && (age_field <= 18) && (city_field exists) + infoType: + description: Set if the transformation was limited to a specific `InfoType`. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: + type: string + description: >- + A description of the transformation. This is empty for a + RECORD_SUPPRESSION, or is the output of calling toString() on the + `PrimitiveTransformation` protocol buffer message for any other type + of transformation. + type: + enumDescriptions: + - Unused + - Record suppression + - Replace value + - Replace value using a dictionary. + - Redact + - Character mask + - FFX-FPE + - Fixed size bucketing + - Bucketing + - Replace with info type + - Time part + - Crypto hash + - Date shift + - Deterministic crypto + - Redact image + type: string + enum: + - TRANSFORMATION_TYPE_UNSPECIFIED + - RECORD_SUPPRESSION + - REPLACE_VALUE + - REPLACE_DICTIONARY + - REDACT + - CHARACTER_MASK + - CRYPTO_REPLACE_FFX_FPE + - FIXED_SIZE_BUCKETING + - BUCKETING + - REPLACE_WITH_INFO_TYPE + - TIME_PART + - CRYPTO_HASH + - DATE_SHIFT + - CRYPTO_DETERMINISTIC_CONFIG + - REDACT_IMAGE + description: The transformation type. + type: object + description: >- + A flattened description of a `PrimitiveTransformation` or + `RecordSuppression`. + GooglePrivacyDlpV2DiscoveryTableModifiedCadence: + properties: + frequency: + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + type: string + description: >- + How frequently data profiles can be updated when tables are + modified. Defaults to never. + types: + items: + enumDescriptions: + - Unused. + - >- + A table will be considered modified when the last_modified_time + from BigQuery has been updated. + enum: + - TABLE_MODIFICATION_UNSPECIFIED + - TABLE_MODIFIED_TIMESTAMP + type: string + type: array + description: >- + The type of events to consider when deciding if the table has been + modified and should have the profile updated. Defaults to + MODIFIED_TIMESTAMP. + type: object + description: The cadence at which to update data profiles when a table is modified. + id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence + GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: + properties: + deidentifyTemplate: + description: New DeidentifyTemplate value. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + updateMask: + type: string + format: google-fieldmask + description: Mask to control which fields get updated. + type: object + id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + description: Request message for UpdateDeidentifyTemplate. + GooglePrivacyDlpV2FinishDlpJobRequest: + properties: {} + id: GooglePrivacyDlpV2FinishDlpJobRequest + type: object + description: The request message for finishing a DLP hybrid job. + GooglePrivacyDlpV2TaggedField: + id: GooglePrivacyDlpV2TaggedField + type: object + properties: + inferred: + $ref: '#/components/schemas/GoogleProtobufEmpty' + description: >- + If no semantic tag is indicated, we infer the statistical model from + the distribution of values in the input data + field: + description: Required. Identifies the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + customTag: + description: >- + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column (below). + type: string + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + A column can be tagged with a InfoType to use the relevant public + dataset as a statistical model of population, if available. We + currently support US ZIP codes, region codes, ages and genders. To + programmatically obtain the list of supported InfoTypes, use + ListInfoTypes with the supported_by=RISK_ANALYSIS filter. + description: A column with a semantic tag attached. + GooglePrivacyDlpV2CloudSqlIamCredential: + description: >- + Use IAM authentication to connect. This requires the Cloud SQL IAM + feature to be enabled on the instance, which is not the default for + Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication + and https://cloud.google.com/sql/docs/mysql/authentication. + properties: {} + id: GooglePrivacyDlpV2CloudSqlIamCredential + type: object + GooglePrivacyDlpV2Location: + type: object + id: GooglePrivacyDlpV2Location + description: Specifies the location of the finding. + properties: + contentLocations: + description: >- + List of nested objects pointing to the precise location of the + finding within the file or record. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' + type: array + byteRange: + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + description: >- + Zero-based byte offsets delimiting the finding. These are relative + to the finding's containing element. Note that when the content is + not textual, this references the UTF-8 encoded textual + representation of the content. Omitted if content is an image. + codepointRange: + description: >- + Unicode character offsets delimiting the finding. These are relative + to the finding's containing element. Provided when the content is + text. + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + container: + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' + description: >- + Information about the container where this finding occurred, if + available. + GooglePrivacyDlpV2DeidentifyDataSourceDetails: + id: GooglePrivacyDlpV2DeidentifyDataSourceDetails + properties: + deidentifyStats: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' + description: Stats about the de-identification operation. + requestedOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' + description: De-identification config used for the request. + type: object + description: The results of a Deidentify action from an inspect job. + GooglePrivacyDlpV2DeidentifyConfig: + description: The configuration that controls how the data will change. + id: GooglePrivacyDlpV2DeidentifyConfig + properties: + transformationErrorHandling: + description: >- + Mode for handling transformation errors. If left unspecified, the + default mode is `TransformationErrorHandling.ThrowError`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' + recordTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' + description: >- + Treat the dataset as structured. Transformations can be applied to + specific locations within structured datasets, such as transforming + a column within a table. + imageTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' + description: Treat the dataset as an image and redact. + infoTypeTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + description: >- + Treat the dataset as free-form text and apply the same free text + transformation everywhere. + type: object + GooglePrivacyDlpV2KMapEstimationQuasiIdValues: + type: object + id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues + properties: + estimatedAnonymity: + description: The estimated anonymity for these quasi-identifier values. + type: string + format: int64 + quasiIdsValues: + type: array + description: The quasi-identifier values. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: A tuple of values for the quasi-identifier columns. + GooglePrivacyDlpV2InfoTypeTransformations: + id: GooglePrivacyDlpV2InfoTypeTransformations + type: object + description: >- + A type of transformation that will scan unstructured text and apply + various `PrimitiveTransformation`s to each finding, where the + transformation is applied to only values that were identified as a + specific info_type. + properties: + transformations: + description: >- + Required. Transformation for each infoType. Cannot specify more than + one for a given infoType. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' + GooglePrivacyDlpV2KindExpression: + type: object + properties: + name: + type: string + description: The name of the kind. + description: A representation of a Datastore kind. + id: GooglePrivacyDlpV2KindExpression + GooglePrivacyDlpV2CloudStorageRegexFileSet: + type: object + description: >- + Message representing a set of files in a Cloud Storage bucket. Regular + expressions are used to allow fine-grained control over which files in + the bucket to include. Included files are those that match at least one + item in `include_regex` and do not match any items in `exclude_regex`. + Note that a file that matches items from both lists will _not_ be + included. For a match to occur, the entire file path (i.e., everything + in the url after the bucket name) must match the regular expression. For + example, given the input `{bucket_name: "mybucket", include_regex: + ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * + `gs://mybucket/directory1/myfile` will be included * + `gs://mybucket/directory1/directory2/myfile` will be included (`.*` + matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will + _not_ be included (the full path doesn't match any items in + `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be + included (the path matches an item in `exclude_regex`) If + `include_regex` is left empty, it will match all files by default (this + is equivalent to setting `include_regex: [".*"]`). Some other common use + cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will + include all files in `mybucket` except for .pdf files * `{bucket_name: + "mybucket", include_regex: ["directory/[^/]+"]}` will include all files + directly under `gs://mybucket/directory/`, without matching across `/` + id: GooglePrivacyDlpV2CloudStorageRegexFileSet + properties: + excludeRegex: + type: array + items: + type: string + description: >- + A list of regular expressions matching file paths to exclude. All + files in the bucket that match at least one of these regular + expressions will be excluded from the scan. Regular expressions use + RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can + be found under the google/re2 repository on GitHub. + bucketName: + type: string + description: The name of a Cloud Storage bucket. Required. + includeRegex: + type: array + description: >- + A list of regular expressions matching file paths to include. All + files in the bucket that match at least one of these regular + expressions will be included in the set of files, except for those + that also match an item in `exclude_regex`. Leaving this field empty + will match all files by default (this is equivalent to including + `.*` in the list). Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + items: + type: string + GooglePrivacyDlpV2RecordLocation: + description: Location of a finding within a row or record. + id: GooglePrivacyDlpV2RecordLocation + properties: + fieldId: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Field id of the field containing the finding. + recordKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' + description: Key of the finding. + tableLocation: + description: Location within a `ContentItem.Table`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' + type: object + GooglePrivacyDlpV2InspectContentResponse: + type: object + properties: + result: + description: The findings. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + description: Results of inspecting an item. + id: GooglePrivacyDlpV2InspectContentResponse + GooglePrivacyDlpV2QuasiIdField: + properties: + customTag: + type: string + description: A auxiliary field. + field: + description: Identifies the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + A quasi-identifier column has a custom_tag, used to know which column in + the data corresponds to which column in the statistical model. + type: object + id: GooglePrivacyDlpV2QuasiIdField + GooglePrivacyDlpV2DiscoveryStartingLocation: + description: >- + The location to begin a discovery scan. Denotes an organization ID or + folder ID within an organization. + type: object properties: - snapshotImageRedactTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: >- - Snapshot of the state of the image transformation - `DeidentifyTemplate` from the `Deidentify` action at the time this - job was run. - snapshotStructuredDeidentifyTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + organizationId: + type: string + format: int64 + description: The ID of an organization to scan. + folderId: + type: string + format: int64 + description: The ID of the folder within an organization to be scanned. + id: GooglePrivacyDlpV2DiscoveryStartingLocation + GooglePrivacyDlpV2FindingLimits: + id: GooglePrivacyDlpV2FindingLimits + properties: + maxFindingsPerRequest: + format: int32 description: >- - Snapshot of the state of the structured `DeidentifyTemplate` from - the `Deidentify` action at the time this job was run. - snapshotDeidentifyTemplate: + Max number of findings that are returned per request or job. If you + set this field in an InspectContentRequest, the resulting maximum + value is the value that you set or 3,000, whichever is lower. This + value isn't a hard limit. If an inspection reaches this limit, the + inspection ends gradually, not abruptly. Therefore, the actual + number of findings that Cloud DLP returns can be multiple times + higher than this value. + type: integer + maxFindingsPerItem: description: >- - Snapshot of the state of the `DeidentifyTemplate` from the - Deidentify action at the time this job was run. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: De-identification options. - GooglePrivacyDlpV2DatabaseResourceCollection: + Max number of findings that are returned for each item scanned. When + set within an InspectContentRequest, this field is ignored. This + value isn't a hard limit. If the number of findings for an item + reaches this limit, the inspection of that item ends gradually, not + abruptly. Therefore, the actual number of findings that Cloud DLP + returns for the item can be multiple times higher than this value. + format: int32 + type: integer + maxFindingsPerInfoType: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' + type: array + description: Configuration of findings limit given for specified infoTypes. description: >- - Match database resources using regex filters. Examples of database - resources are tables, views, and stored procedures. + Configuration to control the number of findings returned for inspection. + This is not used for de-identification or data profiling. When redacting + sensitive data from images, finding limits don't apply. They can cause + unexpected or inconsistent results, where only some data is redacted. + Don't include finding limits in RedactImage requests. Otherwise, Cloud + DLP returns an error. + type: object + GooglePrivacyDlpV2TimeZone: + id: GooglePrivacyDlpV2TimeZone + description: Time zone of the date time object. type: object - id: GooglePrivacyDlpV2DatabaseResourceCollection properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' + offsetMinutes: description: >- - A collection of regular expressions to match a database resource - against. - GooglePrivacyDlpV2VersionDescription: + Set only if the offset can be determined. Positive for time ahead of + UTC. E.g. For "UTC-9", this value is -540. + type: integer + format: int32 + GooglePrivacyDlpV2FieldId: + properties: + name: + type: string + description: Name describing the field. + id: GooglePrivacyDlpV2FieldId + description: General identifier of a data field in a storage service. type: object - description: Details about each available version for an infotype. - id: GooglePrivacyDlpV2VersionDescription + GooglePrivacyDlpV2LDiversityHistogramBucket: + description: Histogram of l-diversity equivalence class sensitive value frequencies. + id: GooglePrivacyDlpV2LDiversityHistogramBucket properties: - version: - description: Name of the version + bucketSize: + format: int64 + description: Total number of equivalence classes in this bucket. type: string - description: + sensitiveValueFrequencyLowerBound: + description: >- + Lower bound on the sensitive value frequencies of the equivalence + classes in this bucket. + format: int64 type: string - description: Description of the version. - GooglePrivacyDlpV2SchemaModifiedCadence: - properties: - frequency: + sensitiveValueFrequencyUpperBound: type: string + format: int64 description: >- - Frequency to regenerate data profiles when the schema is modified. - Defaults to monthly. - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - types: - type: array + Upper bound on the sensitive value frequencies of the equivalence + classes in this bucket. + bucketValueCount: + description: Total number of distinct equivalence classes in this bucket. + type: string + format: int64 + bucketValues: description: >- - The types of schema modifications to consider. Defaults to - NEW_COLUMNS. - items: - enum: - - SQL_SCHEMA_MODIFICATION_UNSPECIFIED - - NEW_COLUMNS - - REMOVED_COLUMNS - enumDescriptions: - - Unused. - - New columns have appeared. - - Columns have been removed from the table. - type: string - id: GooglePrivacyDlpV2SchemaModifiedCadence - type: object - description: >- - How frequently to modify the profile when the table's schema is - modified. - GooglePrivacyDlpV2Conditions: - properties: - conditions: - description: A collection of conditions. + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' type: array - id: GooglePrivacyDlpV2Conditions - description: A collection of conditions. - type: object - GooglePrivacyDlpV2BigQueryField: - properties: - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Source table of the field. - field: - description: Designated field in the BigQuery table. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - id: GooglePrivacyDlpV2BigQueryField type: object - description: Message defining a field of a BigQuery table. - GooglePrivacyDlpV2FileStoreCollection: - id: GooglePrivacyDlpV2FileStoreCollection + GooglePrivacyDlpV2TransformationConfig: type: object - description: Match file stores (e.g. buckets) using regex filters. + description: >- + User specified templates and configs for how to deidentify structured, + unstructures, and image files. User must provide either a unstructured + deidentify template or at least one redact image config. + id: GooglePrivacyDlpV2TransformationConfig properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegexes' + deidentifyTemplate: + type: string description: >- - Optional. A collection of regular expressions to match a file store - against. - GooglePrivacyDlpV2LargeCustomDictionaryStats: - type: object - properties: - approxNumPhrases: + De-identify template. If this template is specified, it will serve + as the default de-identify template. This template cannot contain + `record_transformations` since it can be used for unstructured + content such as free-form text files. If this template is not set, a + default `ReplaceWithInfoTypeConfig` will be used to de-identify + unstructured content. + structuredDeidentifyTemplate: + description: >- + Structured de-identify template. If this template is specified, it + will serve as the de-identify template for structured content such + as delimited files and tables. If this template is not set but the + `deidentify_template` is set, then `deidentify_template` will also + apply to the structured content. If neither template is set, a + default `ReplaceWithInfoTypeConfig` will be used to de-identify + structured content. type: string - format: int64 - description: Approximate number of distinct phrases in the dictionary. - id: GooglePrivacyDlpV2LargeCustomDictionaryStats - description: Summary statistics of a custom dictionary. - GooglePrivacyDlpV2FinishDlpJobRequest: - id: GooglePrivacyDlpV2FinishDlpJobRequest + imageRedactTemplate: + type: string + description: >- + Image redact template. If this template is specified, it will serve + as the de-identify template for images. If this template is not set, + all findings in the image will be redacted with a black box. + GooglePrivacyDlpV2Manual: type: object - description: The request message for finishing a DLP hybrid job. properties: {} - GooglePrivacyDlpV2InspectTemplate: - id: GooglePrivacyDlpV2InspectTemplate + id: GooglePrivacyDlpV2Manual description: >- - The inspectTemplate contains a configuration (set of types of sensitive - data to be detected) to be used anywhere you otherwise would normally - specify InspectConfig. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. + Job trigger option for hybrid jobs. Jobs must be manually created and + finished. + GooglePrivacyDlpV2Range: type: object + description: Generic half-open interval [start, end) + id: GooglePrivacyDlpV2Range properties: - updateTime: - readOnly: true - type: string - format: google-datetime - description: Output only. The last update timestamp of an inspectTemplate. - displayName: - description: Display name (max 256 chars). - type: string - createTime: - format: google-datetime - description: Output only. The creation timestamp of an inspectTemplate. - type: string - readOnly: true - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: >- - The core content of the template. Configuration of the scanning - process. - name: - description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; - readOnly: true + end: + description: Index of the last character of the range (exclusive). type: string - description: + format: int64 + start: type: string - description: Short description (max 256 chars). - GooglePrivacyDlpV2TransformationOverview: - description: Overview of the modifications that occurred. - id: GooglePrivacyDlpV2TransformationOverview - type: object + format: int64 + description: Index of the first character of the range (inclusive). + GooglePrivacyDlpV2ListProjectDataProfilesResponse: + id: GooglePrivacyDlpV2ListProjectDataProfilesResponse + description: List of profiles generated for a given organization or project. properties: - transformationSummaries: + projectDataProfiles: + description: List of data profiles. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' - description: Transformations applied to the dataset. - transformedBytes: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + nextPageToken: type: string - format: int64 - description: Total size in bytes that were transformed in some way. - GooglePrivacyDlpV2TaggedField: - description: A column with a semantic tag attached. + description: The next page token. type: object + GooglePrivacyDlpV2PublishToPubSub: properties: - customTag: - description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). + topic: type: string - infoType: - description: >- - A column can be tagged with a InfoType to use the relevant public - dataset as a statistical model of population, if available. We - currently support US ZIP codes, region codes, ages and genders. To - programmatically obtain the list of supported InfoTypes, use - ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Required. Identifies the column. - inferred: description: >- - If no semantic tag is indicated, we infer the statistical model from - the distribution of values in the input data - $ref: '#/components/schemas/GoogleProtobufEmpty' - id: GooglePrivacyDlpV2TaggedField - GooglePrivacyDlpV2CloudStorageDiscoveryTarget: + Cloud Pub/Sub topic to send notifications to. The topic must have + given publishing access rights to the DLP API service account + executing the long running DlpJob sending the notifications. Format + is projects/{project}/topics/{topic}. + description: >- + Publish a message into a given Pub/Sub topic when DlpJob has completed. + The message contains a single field, `DlpJobName`, which is equal to the + finished job's + [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). + Compatible with: Inspect, Risk + id: GooglePrivacyDlpV2PublishToPubSub + type: object + GooglePrivacyDlpV2Dictionary: + description: >- + Custom information type based on a dictionary of words or phrases. This + can be used to match sensitive information specific to the data, such as + a list of employee IDs or job titles. Dictionary words are + case-insensitive and all characters other than letters and digits in the + unicode [Basic Multilingual + Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) + will be replaced with whitespace when scanning for matches, so the + dictionary phrase "Sam Johnson" will match all three phrases "sam + johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the + characters surrounding any match must be of a different type than the + adjacent characters within the word, so letters must be next to + non-letters and digits next to non-digits. For example, the dictionary + word "jen" will match the first three letters of the text "jen123" but + will return no matches for "jennifer". Dictionary words containing a + large number of characters that are not letters or digits may result in + unexpected findings because such characters are treated as whitespace. + The [limits](https://cloud.google.com/sensitive-data-protection/limits) + page contains details about the size limits of dictionaries. For + dictionaries that do not fit within these constraints, consider using + `LargeCustomDictionaryConfig` in the `StoredInfoType` API. + type: object + id: GooglePrivacyDlpV2Dictionary properties: - conditions: - description: >- - Optional. In addition to matching the filter, these conditions must - be true before a profile is generated. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryFileStoreConditions' - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Optional. Disable profiling for buckets that match this filter. - filter: - description: >- - Required. The buckets the generation_cadence applies to. The first - target with a matching filter will be the one to apply to a bucket. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageFilter' - generationCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence + wordList: + description: List of words or phrases to search for. + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + cloudStoragePath: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' description: >- - Optional. How often and when to update profiles. New buckets that - match both the filter and conditions are scanned as quickly as - possible depending on system capacity. - id: GooglePrivacyDlpV2CloudStorageDiscoveryTarget - description: Target used to match against for discovery with Cloud Storage buckets. + Newline-delimited file of words in Cloud Storage. Only a single file + is accepted. + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - GooglePrivacyDlpV2TransformationResultStatus: + id: GoogleRpcStatus properties: - resultStatusType: - enumDescriptions: - - Unused. - - >- - This will be set when a finding could not be transformed (i.e. - outside user set bucket range). - - >- - This will be set when a BigQuery transformation was successful but - could not be stored back in BigQuery because the transformed row - exceeds BigQuery's max row size. - - >- - This will be set when there is a finding in the custom metadata of - a file, but at the write time of the transformed file, this key / - value pair is unretrievable. - - >- - This will be set when the transformation and storing of it is - successful. + details: description: >- - Transformation result status type, this will be either SUCCESS, or - it will be the reason for why the transformation was not completely - successful. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array + code: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - enum: - - STATE_TYPE_UNSPECIFIED - - INVALID_TRANSFORM - - BIGQUERY_MAX_ROW_SIZE_EXCEEDED - - METADATA_UNRETRIEVABLE - - SUCCESS - details: - description: Detailed error codes and messages - $ref: '#/components/schemas/GoogleRpcStatus' - description: The outcome of a transformation. - id: GooglePrivacyDlpV2TransformationResultStatus - type: object - GooglePrivacyDlpV2Disabled: - type: object - description: Do not profile the tables. - id: GooglePrivacyDlpV2Disabled - properties: {} - GooglePrivacyDlpV2FileClusterType: + GooglePrivacyDlpV2ListDiscoveryConfigsResponse: + id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse type: object - description: Message used to identify file cluster type being profiled. properties: - cluster: - enumDescriptions: - - Unused. - - Unsupported files. - - Plain text. - - Structured data like CSV, TSV etc. - - Source code. - - Rich document like docx, xlsx etc. - - Images like jpeg, bmp. - - Archives and containers like .zip, .tar etc. - - Multimedia like .mp4, .avi etc. - - Executable files like .exe, .class, .apk etc. - enum: - - CLUSTER_UNSPECIFIED - - CLUSTER_UNKNOWN - - CLUSTER_TEXT - - CLUSTER_STRUCTURED_DATA - - CLUSTER_SOURCE_CODE - - CLUSTER_RICH_DOCUMENT - - CLUSTER_IMAGE - - CLUSTER_ARCHIVE - - CLUSTER_MULTIMEDIA - - CLUSTER_EXECUTABLE + nextPageToken: + description: >- + If the next page is available then this value is the next page token + to be used in the following ListDiscoveryConfigs request. type: string - description: Cluster type. - id: GooglePrivacyDlpV2FileClusterType - GooglePrivacyDlpV2InspectionRuleSet: - id: GooglePrivacyDlpV2InspectionRuleSet - type: object - description: >- - Rule set for modifying a set of infoTypes to alter behavior under - certain circumstances, depending on the specific details of the rules - within the set. - properties: - infoTypes: - description: List of infoTypes this rule set is applied to. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - rules: + discoveryConfigs: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: List of configs, up to page_size in ListDiscoveryConfigsRequest. type: array - description: >- - Set of rules to be applied to infoTypes. The rules are applied in - order. - GooglePrivacyDlpV2KMapEstimationConfig: - description: >- - Reidentifiability metric. This corresponds to a risk model similar to - what is called "journalist risk" in the literature, except the attack - dataset is statistically modeled instead of being perfectly known. This - can be done using publicly available data (like the US Census), or using - a custom statistical model (indicated as one or several BigQuery - tables), or by extrapolating from the distribution of values in the - input dataset. - id: GooglePrivacyDlpV2KMapEstimationConfig + description: Response message for ListDiscoveryConfigs. + GooglePrivacyDlpV2KAnonymityConfig: + id: GooglePrivacyDlpV2KAnonymityConfig + description: k-anonymity metric, used for analysis of reidentification risk. properties: - regionCode: - description: >- - ISO 3166-1 alpha-2 region code to use in the statistical modeling. - Set if no column is tagged with a region-specific InfoType (like - US_ZIP_5) or a region code. - type: string + entityId: + $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' + description: >- + Message indicating that multiple rows might be associated to a + single individual. If the same entity_id is associated to multiple + quasi-identifier tuples over distinct rows, we consider the entire + collection of tuples as the composite quasi-identifier. This + collection is a multiset: the order in which the different tuples + appear in the dataset is ignored, but their frequency is taken into + account. Important note: a maximum of 1000 rows can be associated to + a single entity ID. If more rows are associated with the same entity + ID, some might be ignored. quasiIds: - type: array description: >- - Required. Fields considered to be quasi-identifiers. No two columns - can have the same tag. + Set of fields to compute k-anonymity over. When multiple fields are + specified, they are considered a single composite key. Structs and + repeated data types are not supported; however, nested fields are + supported so long as they are not structs themselves or nested + within a repeated field. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' - auxiliaryTables: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' - description: >- - Several auxiliary tables can be used in the analysis. Each - custom_tag used to tag a quasi-identifiers column must appear in - exactly one column of one auxiliary table. type: object - GooglePrivacyDlpV2KMapEstimationHistogramBucket: + GooglePrivacyDlpV2TransientCryptoKey: description: >- - A KMapEstimationHistogramBucket message with the following values: - min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 - records whose quasi-identifier values correspond to 3, 4 or 5 people in - the overlying population. An important particular case is when - min_anonymity = max_anonymity = 1: the frequency field then corresponds - to the number of uniquely identifiable records. + Use this to have a random data crypto key generated. It will be + discarded after the request finishes. + id: GooglePrivacyDlpV2TransientCryptoKey type: object - id: GooglePrivacyDlpV2KMapEstimationHistogramBucket properties: - bucketValueCount: + name: description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - type: string - format: int64 - minAnonymity: - type: string - format: int64 - description: Always positive. - bucketSize: + Required. Name of the key. This is an arbitrary string used to + differentiate different keys. A unique key is generated per name: + two separate `TransientCryptoKey` protos share the same generated + key if their names are the same. When the data crypto key is + generated, this name is not used in any way (repeating the api call + will result in a different key being generated). type: string - description: Number of records within these anonymity bounds. + GooglePrivacyDlpV2ValueFrequency: + properties: + count: + description: How many times the value is contained in the field. format: int64 - maxAnonymity: type: string - format: int64 - description: Always greater than or equal to min_anonymity. - bucketValues: - description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationQuasiIdValues' - GooglePrivacyDlpV2CloudStorageRegexFileSet: + value: + description: A value contained in the field in question. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + id: GooglePrivacyDlpV2ValueFrequency + type: object + description: A value of a field, including its frequency. + GooglePrivacyDlpV2SurrogateType: + type: object description: >- - Message representing a set of files in a Cloud Storage bucket. Regular - expressions are used to allow fine-grained control over which files in - the bucket to include. Included files are those that match at least one - item in `include_regex` and do not match any items in `exclude_regex`. - Note that a file that matches items from both lists will _not_ be - included. For a match to occur, the entire file path (i.e., everything - in the url after the bucket name) must match the regular expression. For - example, given the input `{bucket_name: "mybucket", include_regex: - ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * - `gs://mybucket/directory1/myfile` will be included * - `gs://mybucket/directory1/directory2/myfile` will be included (`.*` - matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will - _not_ be included (the full path doesn't match any items in - `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be - included (the path matches an item in `exclude_regex`) If - `include_regex` is left empty, it will match all files by default (this - is equivalent to setting `include_regex: [".*"]`). Some other common use - cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will - include all files in `mybucket` except for .pdf files * `{bucket_name: - "mybucket", include_regex: ["directory/[^/]+"]}` will include all files - directly under `gs://mybucket/directory/`, without matching across `/` + Message for detecting output from deidentification transformations such + as + [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). + These types of transformations are those that perform pseudonymization, + thereby producing a "surrogate" as output. This should be used in + conjunction with a field on the transformation such as + `surrogate_info_type`. This CustomInfoType does not support the use of + `detection_rules`. + id: GooglePrivacyDlpV2SurrogateType + properties: {} + GooglePrivacyDlpV2InspectConfig: + id: GooglePrivacyDlpV2InspectConfig type: object + description: >- + Configuration description of the scanning process. When used with + redactContent only info_types and min_likelihood are currently used. properties: - includeRegex: + contentOptions: items: type: string - description: >- - A list of regular expressions matching file paths to include. All - files in the bucket that match at least one of these regular - expressions will be included in the set of files, except for those - that also match an item in `exclude_regex`. Leaving this field empty - will match all files by default (this is equivalent to including - `.*` in the list). Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. + enum: + - CONTENT_UNSPECIFIED + - CONTENT_TEXT + - CONTENT_IMAGE + enumDescriptions: + - Includes entire content of a file or a data stream. + - Text content within the data, excluding any metadata. + - Images found in the data. type: array - bucketName: - description: The name of a Cloud Storage bucket. Required. - type: string - excludeRegex: + description: Deprecated and unused. + infoTypes: description: >- - A list of regular expressions matching file paths to exclude. All - files in the bucket that match at least one of these regular - expressions will be excluded from the scan. Regular expressions use - RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can - be found under the google/re2 repository on GitHub. + Restricts what info_types to look for. The values must correspond to + InfoType values returned by ListInfoTypes or listed at + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. + When no InfoTypes or CustomInfoTypes are specified in a request, the + system may automatically choose a default list of detectors to run, + which may change over time. If you need precise control and + predictability as to what detectors are run you should specify + specific InfoTypes listed in the reference, otherwise a default list + will be used, which may change over time. type: array items: - type: string - id: GooglePrivacyDlpV2CloudStorageRegexFileSet - GooglePrivacyDlpV2ListFileStoreDataProfilesResponse: - description: >- - List of file store data profiles generated for a given organization or - project. - properties: - nextPageToken: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + minLikelihood: + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY type: string - description: The next page token. - fileStoreDataProfiles: - description: List of data profiles. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + description: >- + Only returns findings equal to or above this threshold. The default + is POSSIBLE. In general, the highest likelihood setting yields the + fewest findings in results and the lowest chance of a false + positive. For more information, see [Match + likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + includeQuote: + type: boolean + description: >- + When true, a contextual quote from the data that triggered a finding + is included in the response; see Finding.quote. This is not used for + data profiling. + minLikelihoodPerInfoType: type: array - id: GooglePrivacyDlpV2ListFileStoreDataProfilesResponse - type: object - GooglePrivacyDlpV2DataProfilePubSubCondition: - properties: - expressions: - description: An expression. - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' - description: A condition for determining whether a Pub/Sub should be triggered. - id: GooglePrivacyDlpV2DataProfilePubSubCondition - type: object - GooglePrivacyDlpV2DataProfileAction: - type: object - id: GooglePrivacyDlpV2DataProfileAction - description: A task to execute when a data profile has been generated. - properties: - exportData: - $ref: '#/components/schemas/GooglePrivacyDlpV2Export' - description: Export data profiles into a provided location. - pubSubNotification: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' - description: Publish a message into the Pub/Sub topic. - tagResources: - description: Tags the profiled resources with the specified tag values. - $ref: '#/components/schemas/GooglePrivacyDlpV2TagResources' - publishToScc: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2PublishToSecurityCommandCenter - description: Publishes findings to SCC for each data profile. - publishToChronicle: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToChronicle' + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' description: >- - Publishes generated data profiles to Google Security Operations. For - more information, see [Use Sensitive Data Protection data in - context-aware - analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). - GooglePrivacyDlpV2CloudSqlProperties: - type: object - properties: - maxConnections: - type: integer - format: int32 + Minimum likelihood per infotype. For each infotype, a user can + specify a minimum likelihood. The system only returns a finding if + its likelihood is above this threshold. If this field is not set, + the system uses the InspectConfig min_likelihood. + limits: + description: >- + Configuration to control the number of findings returned. This is + not used for data profiling. When redacting sensitive data from + images, finding limits don't apply. They can cause unexpected or + inconsistent results, where only some data is redacted. Don't + include finding limits in RedactImage requests. Otherwise, Cloud DLP + returns an error. When set within an InspectJobConfig, the specified + maximum values aren't hard limits. If an inspection job reaches + these limits, the job ends gradually, not abruptly. Therefore, the + actual number of findings that Cloud DLP returns can be multiple + times higher than these maximum values. + $ref: '#/components/schemas/GooglePrivacyDlpV2FindingLimits' + customInfoTypes: description: >- - Required. DLP will limit its connections to max_connections. Must be - 2 or greater. - connectionName: - type: string + CustomInfoTypes provided by the user. See + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes + to learn more. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' + excludeInfoTypes: description: >- - Optional. Immutable. The Cloud SQL instance for which the connection - is defined. Only one connection per instance is allowed. This can - only be set at creation time, and cannot be updated. It is an error - to use a connection_name from different project or region than the - one that holds the connection. For example, a Connection resource - for Cloud SQL connection_name `project-id:us-central1:sql-instance` - must be created under the parent - `projects/project-id/locations/us-central1` - usernamePassword: - description: A username and password stored in Secret Manager. - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' - cloudSqlIam: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' - description: Built-in IAM authentication (must be configured in Cloud SQL). - databaseEngine: - enumDescriptions: - - >- - An engine that is not currently supported by Sensitive Data - Protection. - - Cloud SQL for MySQL instance. - - Cloud SQL for PostgreSQL instance. + When true, excludes type information of the findings. This is not + used for data profiling. + type: boolean + ruleSet: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' description: >- - Required. The database engine used by the Cloud SQL instance that - this connection configures. - enum: - - DATABASE_ENGINE_UNKNOWN - - DATABASE_ENGINE_MYSQL - - DATABASE_ENGINE_POSTGRES - type: string - description: Cloud SQL connection properties. - id: GooglePrivacyDlpV2CloudSqlProperties - GooglePrivacyDlpV2TimePartConfig: + Set of rules to apply to the findings for this InspectConfig. + Exclusion rules, contained in the set are executed in the end, other + rules are executed in the order they are specified for each info + type. + type: array + GooglePrivacyDlpV2LikelihoodAdjustment: properties: - partToExtract: - description: The part of the time to keep. + relativeLikelihood: + description: >- + Increase or decrease the likelihood by the specified number of + levels. For example, if a finding would be `POSSIBLE` without the + detection rule and `relative_likelihood` is 1, then it is upgraded + to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. + Likelihood may never drop below `VERY_UNLIKELY` or exceed + `VERY_LIKELY`, so applying an adjustment of 1 followed by an + adjustment of -1 when base likelihood is `VERY_LIKELY` will result + in a final likelihood of `LIKELY`. + format: int32 + type: integer + fixedLikelihood: + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + description: Set the likelihood of a finding to a fixed value. enum: - - TIME_PART_UNSPECIFIED - - YEAR - - MONTH - - DAY_OF_MONTH - - DAY_OF_WEEK - - WEEK_OF_YEAR - - HOUR_OF_DAY + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY type: string - enumDescriptions: - - Unused - - '[0-9999]' - - '[1-12]' - - '[1-31]' - - '[1-7]' - - '[1-53]' - - '[0-23]' - id: GooglePrivacyDlpV2TimePartConfig + id: GooglePrivacyDlpV2LikelihoodAdjustment description: >- - For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a - portion of the value. - type: object - GooglePrivacyDlpV2Color: - properties: - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - type: number - green: - format: float - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - red: - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - format: float + Message for specifying an adjustment to the likelihood of a finding as + part of a detection rule. type: object - description: Represents a color in the RGB color space. - id: GooglePrivacyDlpV2Color - GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: - description: Request message for UpdateDeidentifyTemplate. - id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + GooglePrivacyDlpV2TransformationSummary: + id: GooglePrivacyDlpV2TransformationSummary + description: >- + Summary of a single transformation. Only one of 'transformation', + 'field_transformation', or 'record_suppress' will be set. type: object properties: - updateMask: + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: Set if the transformation was limited to a specific InfoType. + transformation: + description: The specific transformation these stats apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + transformedBytes: type: string - format: google-fieldmask - description: Mask to control which fields get updated. - deidentifyTemplate: - description: New DeidentifyTemplate value. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - GooglePrivacyDlpV2TagValue: - description: A value of a tag. - properties: - namespacedValue: + format: int64 + description: Total size in bytes that were transformed in some way. + results: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' + description: Collection of all transformations that took place or had an error. + type: array + fieldTransformations: description: >- - The namespaced name for the tag value to attach to resources. Must - be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, - for example, "123456/environment/prod". + The field transformation that was applied. If multiple field + transformations are requested for a single field, this list will + contain all of them; otherwise, only one is supplied. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + field: + description: Set if the transformation was limited to a specific FieldId. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + recordSuppress: + description: The specific suppression option these stats apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + GooglePrivacyDlpV2InspectJobConfig: + description: Controls what and how to inspect for findings. + id: GooglePrivacyDlpV2InspectJobConfig + properties: + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: How and what to scan for. + actions: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + description: Actions to execute at the completion of the job. + storageConfig: + description: The data to scan. + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' + inspectTemplateName: type: string + description: >- + If provided, will be used as the default for all values in + InspectConfig. `inspect_config` will be merged into the values + persisted as part of the template. type: object - id: GooglePrivacyDlpV2TagValue - GooglePrivacyDlpV2BigQueryDiscoveryTarget: + GooglePrivacyDlpV2HybridContentItem: type: object - description: Target used to match against for discovery with BigQuery tables - id: GooglePrivacyDlpV2BigQueryDiscoveryTarget + id: GooglePrivacyDlpV2HybridContentItem + description: >- + An individual hybrid item to inspect. Will be stored temporarily during + processing. properties: - cadence: - description: >- - How often and when to update profiles. New tables that match both - the filter and conditions are scanned as quickly as possible - depending on system capacity. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryGenerationCadence' - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' - description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - filter: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' + findingDetails: + description: Supplementary information that will be added to each finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' + item: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + GooglePrivacyDlpV2RedactImageRequest: + type: object + properties: + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: Configuration for the inspector. + byteItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + description: The content must be PNG, JPEG, SVG or BMP. + includeFindings: + type: boolean description: >- - Required. The tables the discovery cadence applies to. The first - target with a matching filter will be the one to apply to a table. - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Tables that match this filter will not have profiles created. - GooglePrivacyDlpV2StoredInfoTypeStats: + Whether the response should include findings along with the redacted + image. + locationId: + type: string + description: Deprecated. This field has no effect. + imageRedactionConfigs: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' + description: The configuration for specifying what content to redact from images. + description: >- + Request to search for potentially sensitive info in an image and redact + it by covering it with a colored rectangle. + id: GooglePrivacyDlpV2RedactImageRequest + GooglePrivacyDlpV2RecordTransformation: + properties: + containerVersion: + type: string + description: Container version, if available ("generation" for Cloud Storage). + containerTimestamp: + format: google-datetime + type: string + description: Findings container modification timestamp, if applicable. + fieldId: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: For record transformations, provide a field. type: object - id: GooglePrivacyDlpV2StoredInfoTypeStats - description: Statistics for a StoredInfoType. + description: The field in a record to transform. + id: GooglePrivacyDlpV2RecordTransformation + GooglePrivacyDlpV2AllOtherResources: + properties: {} + type: object + id: GooglePrivacyDlpV2AllOtherResources + description: Match discovery resources not covered by any other filter. + GooglePrivacyDlpV2RecordTransformations: + type: object + description: >- + A type of transformation that is applied over structured data such as a + table. + id: GooglePrivacyDlpV2RecordTransformations properties: - largeCustomDictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' + fieldTransformations: + type: array + description: Transform the record by applying various field transformations. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + recordSuppressions: + type: array description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. - GooglePrivacyDlpV2QuasiIdField: + Configuration defining which records get suppressed entirely. + Records that match any suppression rule are omitted from the output. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + GooglePrivacyDlpV2QuasiIdentifierField: type: object description: >- A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model. - id: GooglePrivacyDlpV2QuasiIdField + id: GooglePrivacyDlpV2QuasiIdentifierField properties: customTag: type: string - description: A auxiliary field. + description: >- + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column (below). field: $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: Identifies the column. - GooglePrivacyDlpV2TransformationErrorHandling: - description: >- - How to handle transformation errors during de-identification. A - transformation error occurs when the requested transformation is - incompatible with the data. For example, trying to de-identify an IP - address using a `DateShift` transformation would result in a - transformation error, since date info cannot be extracted from an IP - address. Information about any incompatible transformations, and how - they were handled, is returned in the response as part of the - `TransformationOverviews`. - id: GooglePrivacyDlpV2TransformationErrorHandling - type: object - properties: - throwError: - $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' - description: Throw an error - leaveUntransformed: - $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' - description: Ignore errors - GooglePrivacyDlpV2LeaveUntransformed: - id: GooglePrivacyDlpV2LeaveUntransformed - description: >- - Skips the data without modifying it if the requested transformation - would cause an error. For example, if a `DateShift` transformation were - applied an an IP address, this mode would leave the IP address unchanged - in the response. - properties: {} - type: object - GooglePrivacyDlpV2LikelihoodAdjustment: - type: object + GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence: description: >- - Message for specifying an adjustment to the likelihood of a finding as - part of a detection rule. - id: GooglePrivacyDlpV2LikelihoodAdjustment + How often existing buckets should have their profiles refreshed. New + buckets are scanned as quickly as possible depending on system capacity. properties: - relativeLikelihood: - type: integer - format: int32 + inspectTemplateModifiedCadence: description: >- - Increase or decrease the likelihood by the specified number of - levels. For example, if a finding would be `POSSIBLE` without the - detection rule and `relative_likelihood` is 1, then it is upgraded - to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. - Likelihood may never drop below `VERY_UNLIKELY` or exceed - `VERY_LIKELY`, so applying an adjustment of 1 followed by an - adjustment of -1 when base likelihood is `VERY_LIKELY` will result - in a final likelihood of `LIKELY`. - fixedLikelihood: - description: Set the likelihood of a finding to a fixed value. - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - type: string - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - GooglePrivacyDlpV2ImageTransformations: - description: A type of transformation that is applied over images. - id: GooglePrivacyDlpV2ImageTransformations - type: object - properties: - transforms: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' - description: List of transforms to make. - type: array - GooglePrivacyDlpV2HybridInspectResponse: - id: GooglePrivacyDlpV2HybridInspectResponse - description: Quota exceeded errors will be thrown once quota has been met. - type: object - properties: {} - GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence: - id: GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - properties: - frequency: - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY + Optional. Governs when to update data profiles when the inspection + rules defined by the `InspectTemplate` change. If not set, changing + the template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + refreshFrequency: enumDescriptions: - Unspecified. - After the data profile is created, it will never be updated. - The data profile can be updated up to once every 24 hours. - The data profile can be updated up to once every 30 days. Default. description: >- - How frequently data profiles can be updated when the template is - modified. Defaults to never. + Optional. Data changes in Cloud Storage can't trigger reprofiling. + If you set this field, profiles are refreshed at this frequency + regardless of whether the underlying buckets have changed. Defaults + to never. type: string - description: >- - The cadence at which to update data profiles when the inspection rules - defined by the `InspectTemplate` change. - type: object - GooglePrivacyDlpV2BigQueryTableCollection: - id: GooglePrivacyDlpV2BigQueryTableCollection - properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' - description: >- - A collection of regular expressions to match a BigQuery table - against. - type: object - description: Specifies a collection of BigQuery tables. Used for Discovery. - GooglePrivacyDlpV2Trigger: + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + id: GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence type: object - description: What event needs to occur for a new job to be started. - properties: - schedule: - $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' - description: Create a job on a repeating basis based on the elapse of time. - manual: - $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' - description: >- - For use with hybrid jobs. Jobs must be manually created and - finished. - id: GooglePrivacyDlpV2Trigger - GooglePrivacyDlpV2PublishToStackdriver: - description: >- - Enable Stackdriver metric dlp.googleapis.com/finding_count. This will - publish a metric to stack driver on each infotype requested and how many - findings were found for it. CustomDetectors will be bucketed as 'Custom' - under the Stackdriver label 'info_type'. - properties: {} - id: GooglePrivacyDlpV2PublishToStackdriver + GooglePrivacyDlpV2ListInfoTypesResponse: type: object - GooglePrivacyDlpV2DiscoveryBigQueryConditions: + id: GooglePrivacyDlpV2ListInfoTypesResponse + description: Response to the ListInfoTypes request. properties: - orConditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' - description: >- - At least one of the conditions must be true for a table to be - scanned. - typeCollection: - type: string - description: Restrict discovery to categories of table types. - enum: - - BIG_QUERY_COLLECTION_UNSPECIFIED - - BIG_QUERY_COLLECTION_ALL_TYPES - - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES - enumDescriptions: - - Unused. - - >- - Automatically generate profiles for all tables, even if the table - type is not yet fully supported for analysis. Profiles for - unsupported tables will be generated with errors to indicate their - partial support. When full support is added, the tables will - automatically be profiled during the next scheduled run. - - >- - Only those types fully supported will be profiled. Will expand - automatically as Cloud DLP adds support for new table types. - Unsupported table types will not have partial profiles generated. - types: - description: Restrict discovery to specific table types. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' - createdAfter: - format: google-datetime - type: string - description: >- - BigQuery table must have been created after this date. Used to avoid - backfilling. - id: GooglePrivacyDlpV2DiscoveryBigQueryConditions - type: object + infoTypes: + description: Set of sensitive infoTypes. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' + GooglePrivacyDlpV2RiskAnalysisJobConfig: description: >- - Requirements that must be true before a table is scanned in discovery - for the first time. There is an AND relationship between the top-level - attributes. Additionally, minimum conditions with an OR relationship - that must be met before Cloud DLP scans a table can be set (like a - minimum row count or a minimum table age). - GooglePrivacyDlpV2PublishToSecurityCommandCenter: - id: GooglePrivacyDlpV2PublishToSecurityCommandCenter + Configuration for a risk analysis job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis + to learn more. type: object - properties: {} - description: >- - If set, a summary finding will be created/updated in SCC for each - profile. - GooglePrivacyDlpV2AuxiliaryTable: - id: GooglePrivacyDlpV2AuxiliaryTable - description: >- - An auxiliary table contains statistical information on the relative - frequency of different quasi-identifiers values. It has one or several - quasi-identifiers columns, and one column that indicates the relative - frequency of each quasi-identifier tuple. If a tuple is present in the - data but not in the auxiliary table, the corresponding relative - frequency is assumed to be zero (and thus, the tuple is highly - reidentifiable). properties: - quasiIds: + actions: type: array + description: >- + Actions to execute at the completion of the job. Are executed in the + order provided. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' - description: Required. Quasi-identifier columns. - table: + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + sourceTable: $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Required. Auxiliary table location. - relativeFrequency: - description: >- - Required. The relative frequency column must contain a - floating-point number between 0 and 1 (inclusive). Null values are - assumed to be zero. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - type: object - GooglePrivacyDlpV2Location: + description: Input dataset to compute metrics over. + privacyMetric: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + description: Privacy metric to compute. + id: GooglePrivacyDlpV2RiskAnalysisJobConfig + GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: + id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig type: object + description: Replace each matching finding with the name of the info_type. + properties: {} + GooglePrivacyDlpV2SelectedInfoTypes: + description: Apply transformation to the selected info_types. properties: - contentLocations: + infoTypes: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - List of nested objects pointing to the precise location of the - finding within the file or record. + Required. InfoTypes to apply the transformation to. Required. + Provided InfoType must be unique within the ImageTransformations + message. type: array - byteRange: - description: >- - Zero-based byte offsets delimiting the finding. These are relative - to the finding's containing element. Note that when the content is - not textual, this references the UTF-8 encoded textual - representation of the content. Omitted if content is an image. - $ref: '#/components/schemas/GooglePrivacyDlpV2Range' - container: - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - description: >- - Information about the container where this finding occurred, if - available. - codepointRange: - description: >- - Unicode character offsets delimiting the finding. These are relative - to the finding's containing element. Provided when the content is - text. - $ref: '#/components/schemas/GooglePrivacyDlpV2Range' - description: Specifies the location of the finding. - id: GooglePrivacyDlpV2Location + type: object + id: GooglePrivacyDlpV2SelectedInfoTypes + GooglePrivacyDlpV2LargeCustomDictionaryStats: + description: Summary statistics of a custom dictionary. + properties: + approxNumPhrases: + format: int64 + description: Approximate number of distinct phrases in the dictionary. + type: string + id: GooglePrivacyDlpV2LargeCustomDictionaryStats + type: object + GooglePrivacyDlpV2CryptoKey: + id: GooglePrivacyDlpV2CryptoKey + type: object + description: >- + This is a data encryption key (DEK) (as opposed to a key encryption key + (KEK) stored by Cloud Key Management Service (Cloud KMS). When using + Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM + policy on the KEK to ensure an attacker cannot unwrap the DEK. + properties: + transient: + description: Transient crypto key + $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' + unwrapped: + $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' + description: Unwrapped crypto key + kmsWrapped: + description: Key wrapped using Cloud KMS + $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' parameters: - prettyPrint: - description: Returns response with indentations and line breaks. + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean - 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. + type: string + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: key + name: fields + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string alt: @@ -7741,12 +7750,6 @@ components: - json - media - proto - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -7756,12 +7759,6 @@ components: name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -7771,10 +7768,13 @@ components: enum: - '1' - '2' - fields: - description: Selector specifying which fields to include in a partial response. + 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. in: query - name: fields + name: key schema: type: string oauth_token: @@ -7783,398 +7783,282 @@ components: name: oauth_token schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - x-stackQL-resources: - image: - id: google.dlp.image - name: image - title: Image - methods: - projects_image_redact: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_image_redact: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - dlp_jobs: - id: google.dlp.dlp_jobs - name: dlp_jobs - title: Dlp_jobs - methods: - projects_dlp_jobs_create: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_dlp_jobs_list: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - projects_dlp_jobs_cancel: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_dlp_jobs_delete: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_dlp_jobs_get: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_finish: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:finish/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_list: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - projects_locations_dlp_jobs_cancel: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_hybrid_inspect: + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + x-stackQL-resources: + info_types: + id: google.dlp.info_types + name: info_types + title: Info_types + methods: + info_types_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post + $ref: '#/paths/~1v2~1infoTypes/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_dlp_jobs_list: + locations_info_types_list: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1dlpJobs/get + $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobs sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_get - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_get - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_list - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/organizations_locations_dlp_jobs_list - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_list - insert: - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_create + #/components/x-stackQL-resources/info_types/methods/locations_info_types_list - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_create + #/components/x-stackQL-resources/info_types/methods/info_types_list + insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_delete - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_delete - deidentify_templates: - id: google.dlp.deidentify_templates - name: deidentify_templates - title: Deidentify_templates + delete: [] + stored_info_types: + id: google.dlp.stored_info_types + name: stored_info_types + title: Stored_info_types methods: - projects_deidentify_templates_get: + projects_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_delete: + projects_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_patch: + projects_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_list: + projects_stored_info_types_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - projects_deidentify_templates_create: + objectKey: $.storedInfoTypes + projects_stored_info_types_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_patch: + projects_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_get: + projects_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_delete: + projects_locations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_list: + projects_locations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - projects_locations_deidentify_templates_create: + objectKey: $.storedInfoTypes + projects_locations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_delete: + organizations_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_get: + organizations_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_patch: + organizations_locations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_list: + organizations_locations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - organizations_locations_deidentify_templates_create: + objectKey: $.storedInfoTypes + organizations_locations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_patch: + organizations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_get: + organizations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_delete: + organizations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_create: + organizations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_list: + organizations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/get + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates + objectKey: $.storedInfoTypes sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_get + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_get + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_get + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_list + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_list + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_get + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_list + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_list + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_list insert: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_create + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_create - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_create + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_create - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_create + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_create - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_create + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_create update: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_patch + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_patch + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_patch + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_patch + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_delete + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_delete + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_delete - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_delete + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_delete + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete job_triggers: id: google.dlp.job_triggers name: job_triggers title: Job_triggers methods: - projects_job_triggers_get: + projects_job_triggers_activate: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_patch: + projects_job_triggers_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_delete: + objectKey: $.jobTriggers + projects_job_triggers_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_list: + projects_job_triggers_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_job_triggers_create: + projects_job_triggers_delete: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_activate: + projects_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -8228,25 +8112,25 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_list: + organizations_locations_job_triggers_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - organizations_locations_job_triggers_create: + organizations_locations_job_triggers_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_delete: + objectKey: $.jobTriggers + organizations_locations_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -8257,10 +8141,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_patch: + organizations_locations_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -8300,336 +8184,409 @@ components: #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_delete - $ref: >- #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_delete - stored_info_types: - id: google.dlp.stored_info_types - name: stored_info_types - title: Stored_info_types + deidentify_templates: + id: google.dlp.deidentify_templates + name: deidentify_templates + title: Deidentify_templates methods: - projects_stored_info_types_delete: + projects_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_get: + projects_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_patch: + projects_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_create: + projects_deidentify_templates_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_list: + projects_deidentify_templates_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - projects_locations_stored_info_types_delete: + objectKey: $.deidentifyTemplates + projects_locations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_get: + objectKey: $.deidentifyTemplates + projects_locations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_patch: + projects_locations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_create: + projects_locations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_list: + projects_locations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_locations_stored_info_types_get: + organizations_locations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_patch: + organizations_locations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_delete: + organizations_locations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_create: + organizations_locations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_list: + objectKey: $.deidentifyTemplates + organizations_locations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_stored_info_types_patch: + organizations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_delete: + organizations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_get: + objectKey: $.deidentifyTemplates + organizations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_create: + organizations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_list: + organizations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_get + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_get + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_list + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_list insert: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_create + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_create + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_create + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_create + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_create update: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_patch + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_patch + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_patch + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_patch + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_delete + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete - connections: - id: google.dlp.connections - name: connections - title: Connections + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_delete + content: + id: google.dlp.content + name: content + title: Content methods: - projects_locations_connections_get: + projects_content_deidentify: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_content_reidentify: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_content_inspect: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_content_inspect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_patch: + projects_locations_content_reidentify: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_delete: + projects_locations_content_deidentify: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_search: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + column_data_profiles: + id: google.dlp.column_data_profiles + name: column_data_profiles + title: Column_data_profiles + methods: + projects_locations_column_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_list: + projects_locations_column_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_create: + objectKey: $.columnDataProfiles + organizations_locations_column_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_patch: + organizations_locations_column_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_delete: + objectKey: $.columnDataProfiles + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_list + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_list + insert: [] + update: [] + replace: [] + delete: [] + image: + id: google.dlp.image + name: image + title: Image + methods: + projects_locations_image_redact: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_get: + projects_image_redact: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + file_store_data_profiles: + id: google.dlp.file_store_data_profiles + name: file_store_data_profiles + title: File_store_data_profiles + methods: + projects_locations_file_store_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_create: + projects_locations_file_store_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_list: + projects_locations_file_store_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - organizations_locations_connections_search: + objectKey: $.fileStoreDataProfiles + organizations_locations_file_store_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_file_store_data_profiles_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_file_store_data_profiles_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.fileStoreDataProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get - - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_get - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_list - insert: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_create - update: + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_list - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_patch + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_list + insert: [] + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_delete - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_delete + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_delete inspect_templates: id: google.dlp.inspect_templates name: inspect_templates title: Inspect_templates methods: - projects_locations_inspect_templates_list: + projects_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - projects_locations_inspect_templates_create: + projects_locations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.inspectTemplates projects_locations_inspect_templates_delete: operation: $ref: >- @@ -8658,17 +8615,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_delete: + projects_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_patch: + projects_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -8685,78 +8642,78 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.inspectTemplates - organizations_inspect_templates_get: + organizations_locations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_delete: + organizations_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_patch: + organizations_locations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_create: + organizations_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_list: + organizations_locations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.inspectTemplates - organizations_locations_inspect_templates_create: + organizations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_list: + organizations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_locations_inspect_templates_patch: + organizations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_get: + organizations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_delete: + organizations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.inspectTemplates sqlVerbs: select: - $ref: >- @@ -8767,10 +8724,10 @@ components: #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_list - $ref: >- #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_get - - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_get - $ref: >- #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_list + - $ref: >- + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_get - $ref: >- #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_list - $ref: >- @@ -8803,68 +8760,197 @@ components: #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_delete - $ref: >- #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_delete - column_data_profiles: - id: google.dlp.column_data_profiles - name: column_data_profiles - title: Column_data_profiles + dlp_jobs: + id: google.dlp.dlp_jobs + name: dlp_jobs + title: Dlp_jobs methods: - projects_locations_column_data_profiles_list: + projects_locations_dlp_jobs_hybrid_inspect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.columnDataProfiles - projects_locations_column_data_profiles_get: + projects_locations_dlp_jobs_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_column_data_profiles_get: + projects_locations_dlp_jobs_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_column_data_profiles_list: + projects_locations_dlp_jobs_cancel: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.columnDataProfiles + projects_locations_dlp_jobs_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_dlp_jobs_list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + projects_locations_dlp_jobs_finish: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:finish/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_create: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + projects_dlp_jobs_cancel: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_get: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_delete: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_dlp_jobs_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1dlpJobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_get + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_get - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_get + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_list - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_list + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_get - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_list - insert: [] + #/components/x-stackQL-resources/dlp_jobs/methods/organizations_locations_dlp_jobs_list + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_create + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_create update: [] replace: [] - delete: [] - project_data_profiles: - id: google.dlp.project_data_profiles - name: project_data_profiles - title: Project_data_profiles + delete: + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_delete + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_delete + table_data_profiles: + id: google.dlp.table_data_profiles + name: table_data_profiles + title: Table_data_profiles methods: - projects_locations_project_data_profiles_list: + projects_locations_table_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.projectDataProfiles + projects_locations_table_data_profiles_delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_table_data_profiles_list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tableDataProfiles + organizations_locations_table_data_profiles_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tableDataProfiles + organizations_locations_table_data_profiles_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_table_data_profiles_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list + - $ref: >- + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete + - $ref: >- + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete + project_data_profiles: + id: google.dlp.project_data_profiles + name: project_data_profiles + title: Project_data_profiles + methods: projects_locations_project_data_profiles_get: operation: $ref: >- @@ -8872,13 +8958,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_project_data_profiles_get: + projects_locations_project_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.projectDataProfiles organizations_locations_project_data_profiles_list: operation: $ref: >- @@ -8887,6 +8974,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.projectDataProfiles + organizations_locations_project_data_profiles_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- @@ -8901,537 +8995,247 @@ components: update: [] replace: [] delete: [] - content: - id: google.dlp.content - name: content - title: Content + connections: + id: google.dlp.connections + name: connections + title: Connections methods: - projects_locations_content_inspect: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_content_deidentify: + projects_locations_connections_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_reidentify: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_content_reidentify: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_content_inspect: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_content_deidentify: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - discovery_configs: - id: google.dlp.discovery_configs - name: discovery_configs - title: Discovery_configs - methods: - projects_locations_discovery_configs_patch: + objectKey: $.connections + projects_locations_connections_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_delete: + projects_locations_connections_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_get: + projects_locations_connections_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_list: + projects_locations_connections_search: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.discoveryConfigs - projects_locations_discovery_configs_create: + organizations_locations_connections_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_delete: + organizations_locations_connections_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_patch: + organizations_locations_connections_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_get: + organizations_locations_connections_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_create: + organizations_locations_connections_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_list: + objectKey: $.connections + organizations_locations_connections_search: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.discoveryConfigs sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_list insert: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_create update: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_patch + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_patch + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete - table_data_profiles: - id: google.dlp.table_data_profiles - name: table_data_profiles - title: Table_data_profiles + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_delete + discovery_configs: + id: google.dlp.discovery_configs + name: discovery_configs + title: Discovery_configs methods: - projects_locations_table_data_profiles_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_table_data_profiles_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_table_data_profiles_list: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.tableDataProfiles - organizations_locations_table_data_profiles_delete: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_table_data_profiles_get: + projects_locations_discovery_configs_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_table_data_profiles_list: + projects_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list - - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete - - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete - file_store_data_profiles: - id: google.dlp.file_store_data_profiles - name: file_store_data_profiles - title: File_store_data_profiles - methods: - projects_locations_file_store_data_profiles_list: + projects_locations_discovery_configs_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.fileStoreDataProfiles - projects_locations_file_store_data_profiles_get: + projects_locations_discovery_configs_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_file_store_data_profiles_delete: + objectKey: $.discoveryConfigs + projects_locations_discovery_configs_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_file_store_data_profiles_delete: + organizations_locations_discovery_configs_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_file_store_data_profiles_get: + organizations_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_file_store_data_profiles_list: + organizations_locations_discovery_configs_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.fileStoreDataProfiles - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_list - - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_list - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_delete - - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_delete - info_types: - id: google.dlp.info_types - name: info_types - title: Info_types - methods: - locations_info_types_list: + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_discovery_configs_list: operation: - $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get response: mediaType: application/json openAPIDocKey: '200' - info_types_list: + objectKey: $.discoveryConfigs + organizations_locations_discovery_configs_create: operation: - $ref: '#/paths/~1v2~1infoTypes/get' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/info_types/methods/locations_info_types_list + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get - $ref: >- - #/components/x-stackQL-resources/info_types/methods/info_types_list - insert: [] - update: [] + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_patch + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_patch replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete paths: - /v2/projects/{projectsId}/image:redact: + /v2/infoTypes: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' - post: - description: >- - Redacts potentially sensitive info from an image. This method has limits - on input size, processing time, and output size. See - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.image.redact - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - /v2/projects/{projectsId}/dlpJobs: - parameters: *ref_1 - post: - description: >- - Creates a new job to inspect storage or calculate risk metrics. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. When no InfoTypes or CustomInfoTypes are specified in - inspect jobs, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.dlpJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - get: - description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.dlpJobs.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: orderBy - schema: - type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: - parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running DlpJob. The server - makes a best effort to cancel the DlpJob, but success is not guaranteed. - See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.dlpJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: dlpJobsId - required: true - schema: - type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: - parameters: *ref_1 - delete: - description: >- - Deletes a long-running DlpJob. This method indicates that the client is - no longer interested in the DlpJob result. The job will be canceled if - possible. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.dlpJobs.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: dlpJobsId - required: true - schema: - type: string - get: - description: >- - Gets the latest state of a long-running DlpJob. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + get: + description: >- + Returns a list of the sensitive information types that DLP API supports. + See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. - operationId: dlp.projects.dlpJobs.get + operationId: dlp.infoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9443,26 +9247,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' parameters: - - in: path - name: projectsId - required: true + - in: query + name: locationId schema: type: string - - in: path - name: dlpJobsId - required: true + - in: query + name: languageCode schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: + - in: query + name: filter + schema: + type: string + - in: query + name: parent + schema: + type: string + /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 - get: + delete: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.deidentifyTemplates.get + operationId: dlp.projects.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9474,7 +9284,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9482,16 +9292,23 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: storedInfoTypesId required: true schema: type: string - delete: + patch: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.deidentifyTemplates.delete + operationId: dlp.projects.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9503,7 +9320,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -9511,22 +9328,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: storedInfoTypesId required: true schema: type: string - patch: + get: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.deidentifyTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + operationId: dlp.projects.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9538,7 +9349,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -9546,18 +9357,18 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates: + /v2/projects/{projectsId}/storedInfoTypes: parameters: *ref_1 get: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.deidentifyTemplates.list + operationId: dlp.projects.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9570,7 +9381,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: projectsId @@ -9581,6 +9392,10 @@ paths: name: orderBy schema: type: string + - in: query + name: locationId + schema: + type: string - in: query name: pageSize schema: @@ -9590,23 +9405,18 @@ paths: name: pageToken schema: type: string - - in: query - name: locationId - schema: - type: string post: description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.deidentifyTemplates.create + operationId: dlp.projects.storedInfoTypes.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9618,21 +9428,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: parameters: *ref_1 - get: + post: description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.jobTriggers.get + Activate a job trigger. Causes the immediate execute of a trigger + instead of waiting on the trigger event to occur. + operationId: dlp.projects.jobTriggers.activate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9644,7 +9458,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -9656,17 +9470,14 @@ paths: required: true schema: type: string - patch: + /v2/projects/{projectsId}/jobTriggers: + parameters: *ref_1 + get: description: >- - Updates a job trigger. See + Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + operationId: dlp.projects.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9678,24 +9489,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: orderBy schema: type: string - delete: + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: type + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: description: >- - Deletes a job trigger. See + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.delete + operationId: dlp.projects.jobTriggers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9707,26 +9544,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: jobTriggersId - required: true - schema: - type: string - /v2/projects/{projectsId}/jobTriggers: + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: parameters: *ref_1 get: description: >- - Lists job triggers. See + Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.list + operationId: dlp.projects.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9738,50 +9570,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: jobTriggersId + required: true schema: type: string - post: + delete: description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See + Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + operationId: dlp.projects.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9793,25 +9599,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: - parameters: *ref_1 - post: + - in: path + name: jobTriggersId + required: true + schema: + type: string + patch: description: >- - Activate a job trigger. Causes the immediate execute of a trigger - instead of waiting on the trigger event to occur. - operationId: dlp.projects.jobTriggers.activate + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9823,7 +9633,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -9835,14 +9645,20 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: + /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_1 - delete: + patch: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.storedInfoTypes.delete + operationId: dlp.projects.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9854,7 +9670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -9862,16 +9678,16 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: deidentifyTemplatesId required: true schema: type: string get: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.storedInfoTypes.get + operationId: dlp.projects.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9883,7 +9699,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -9891,23 +9707,16 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: deidentifyTemplatesId required: true schema: type: string - patch: + delete: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + operationId: dlp.projects.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9919,7 +9728,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9927,24 +9736,25 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: deidentifyTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/storedInfoTypes: + /v2/projects/{projectsId}/deidentifyTemplates: parameters: *ref_1 post: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.storedInfoTypes.create + operationId: dlp.projects.deidentifyTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9956,7 +9766,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -9965,10 +9775,10 @@ paths: type: string get: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.storedInfoTypes.list + operationId: dlp.projects.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9981,7 +9791,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: projectsId @@ -9994,58 +9804,34 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: locationId schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query - name: locationId + name: orderBy schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + /v2/projects/{projectsId}/content:deidentify: parameters: *ref_1 - get: - description: Get a Connection by name. - operationId: dlp.projects.locations.connections.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: connectionsId - required: true - schema: - type: string - patch: - description: Update a Connection. - operationId: dlp.projects.locations.connections.patch + post: + description: >- + De-identifies potentially sensitive info from a ContentItem. This method + has limits on input size and output size. See + https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.content.deidentify requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10057,26 +9843,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: connectionsId - required: true - schema: - type: string - delete: - description: Delete a Connection. - operationId: dlp.projects.locations.connections.delete + /v2/projects/{projectsId}/content:reidentify: + parameters: *ref_1 + post: + description: >- + Re-identifies content that has been de-identified. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + to learn more. + operationId: dlp.projects.content.reidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10088,28 +9875,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: connectionsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:search: + /v2/projects/{projectsId}/content:inspect: parameters: *ref_1 - get: - description: Searches for Connections in a parent. - operationId: dlp.projects.locations.connections.search + post: + description: >- + Finds potentially sensitive info in content. This method has limits on + input size, processing time, and output size. When no InfoTypes or + CustomInfoTypes are specified in this request, the system will + automatically choose what detectors to run. By default this may be all + types, but may change over time as detectors are updated. For how to + guides, see + https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + and + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + operationId: dlp.projects.content.inspect + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10121,39 +9913,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections: + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: parameters: *ref_1 get: - description: >- - Lists Connections in a parent. Use SearchConnections to see all - connections within an organization. - operationId: dlp.projects.locations.connections.list + description: Gets a column data profile. + operationId: dlp.projects.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10165,7 +9936,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path name: projectsId @@ -10173,62 +9944,20 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Create a Connection to an external data source. - operationId: dlp.projects.locations.connections.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - parameters: - - in: path - name: projectsId + name: locationsId required: true schema: type: string - in: path - name: locationsId + name: columnDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: parameters: *ref_1 get: - description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.list + description: Lists column data profiles for an organization. + operationId: dlp.projects.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10241,7 +9970,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path name: projectsId @@ -10254,35 +9983,41 @@ paths: schema: type: string - in: query - name: orderBy + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: pageToken + name: filter schema: type: string - in: query - name: locationId + name: pageToken schema: type: string - in: query - name: pageSize + name: orderBy schema: - type: integer - format: int32 + type: string + /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: + parameters: *ref_1 post: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.create + Finds potentially sensitive info in content. This method has limits on + input size, processing time, and output size. When no InfoTypes or + CustomInfoTypes are specified in this request, the system will + automatically choose what detectors to run. By default this may be all + types, but may change over time as detectors are updated. For how to + guides, see + https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + and + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + operationId: dlp.projects.locations.content.inspect requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10294,7 +10029,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path name: projectsId @@ -10306,48 +10041,19 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: parameters: *ref_1 - delete: - description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: inspectTemplatesId - required: true - schema: - type: string - get: + post: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Re-identifies content that has been de-identified. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. - operationId: dlp.projects.locations.inspectTemplates.get + operationId: dlp.projects.locations.content.reidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10359,7 +10065,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path name: projectsId @@ -10371,23 +10078,23 @@ paths: required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true - schema: - type: string - patch: + /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: + parameters: *ref_1 + post: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.patch + De-identifies potentially sensitive info from a ContentItem. This method + has limits on input size and output size. See + https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.content.deidentify requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10399,7 +10106,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path name: projectsId @@ -10411,25 +10119,23 @@ paths: required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/projects/{projectsId}/locations/{locationsId}/image:redact: parameters: *ref_1 - patch: + post: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.patch + Redacts potentially sensitive info from an image. This method has limits + on input size, processing time, and output size. See + https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.image.redact requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10441,7 +10147,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' parameters: - in: path name: projectsId @@ -10453,17 +10159,11 @@ paths: required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true - schema: - type: string + /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: + parameters: *ref_1 get: - description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.get + description: Gets a file store data profile. + operationId: dlp.projects.locations.fileStoreDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10475,7 +10175,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' parameters: - in: path name: projectsId @@ -10488,16 +10188,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: fileStoreDataProfilesId required: true schema: type: string delete: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.delete + Delete a FileStoreDataProfile. Will not prevent the profile from being + regenerated if the resource is still included in a discovery + configuration. + operationId: dlp.projects.locations.fileStoreDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10522,18 +10222,15 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: fileStoreDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: + /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles: parameters: *ref_1 get: - description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.list + description: Lists file store data profiles for an organization. + operationId: dlp.projects.locations.fileStoreDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10546,7 +10243,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse parameters: - in: path name: projectsId @@ -10559,7 +10256,11 @@ paths: schema: type: string - in: query - name: locationId + name: orderBy + schema: + type: string + - in: query + name: filter schema: type: string - in: query @@ -10571,63 +10272,21 @@ paths: schema: type: integer format: int32 - - in: query - name: orderBy - schema: - type: string - post: - description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/image:redact: + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: parameters: *ref_1 post: description: >- - Redacts potentially sensitive info from an image. This method has limits - on input size, processing time, and output size. See - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.image.redact + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10639,7 +10298,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -10651,11 +10310,12 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: - parameters: *ref_1 get: - description: Lists column data profiles for an organization. - operationId: dlp.projects.locations.columnDataProfiles.list + description: >- + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10668,7 +10328,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: projectsId @@ -10681,7 +10341,7 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -10694,14 +10354,17 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: locationId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 - get: - description: Gets a column data profile. - operationId: dlp.projects.locations.columnDataProfiles.get + delete: + description: >- + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10713,7 +10376,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10726,20 +10389,16 @@ paths: schema: type: string - in: path - name: columnDataProfilesId + name: inspectTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: - parameters: *ref_1 get: description: >- - Gets the latest state of a long-running DlpJob. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.dlpJobs.get + operationId: dlp.projects.locations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10751,7 +10410,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -10764,20 +10423,22 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: inspectTemplatesId required: true schema: type: string - delete: + patch: description: >- - Deletes a long-running DlpJob. This method indicates that the client is - no longer interested in the DlpJob result. The job will be canceled if - possible. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.dlpJobs.delete + operationId: dlp.projects.locations.inspectTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10789,7 +10450,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -10802,22 +10463,23 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: inspectTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: parameters: *ref_1 post: description: >- - Finish a running hybrid DlpJob. Triggers the finalization steps and - running of any enabled actions that have not yet run. - operationId: dlp.projects.locations.dlpJobs.finish + Inspect hybrid content and store findings to a job. To review the + findings, inspect the job. Inspection will occur asynchronously. + operationId: dlp.projects.locations.dlpJobs.hybridInspect requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FinishDlpJobRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10829,7 +10491,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' parameters: - in: path name: projectsId @@ -10846,24 +10508,18 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: parameters: *ref_1 - post: + delete: description: >- - Creates a new job to inspect storage or calculate risk metrics. See + Deletes a long-running DlpJob. This method indicates that the client is + no longer interested in the DlpJob result. The job will be canceled if + possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. When no InfoTypes or CustomInfoTypes are specified in - inspect jobs, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.dlpJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' + to learn more. + operationId: dlp.projects.locations.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10875,7 +10531,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10887,14 +10543,19 @@ paths: required: true schema: type: string + - in: path + name: dlpJobsId + required: true + schema: + type: string get: description: >- - Lists DlpJobs that match the specified filter in the request. See + Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.dlpJobs.list + operationId: dlp.projects.locations.dlpJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10906,7 +10567,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -10918,29 +10579,9 @@ paths: required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter + - in: path + name: dlpJobsId + required: true schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: @@ -10988,19 +10629,24 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs: parameters: *ref_1 post: description: >- - Inspect hybrid content and store findings to a job. To review the - findings, inspect the job. Inspection will occur asynchronously. - operationId: dlp.projects.locations.dlpJobs.hybridInspect + Creates a new job to inspect storage or calculate risk metrics. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. When no InfoTypes or CustomInfoTypes are specified in + inspect jobs, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.dlpJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11012,7 +10658,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -11024,16 +10670,14 @@ paths: required: true schema: type: string - - in: path - name: dlpJobsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: - parameters: *ref_1 get: - description: Lists project data profiles for an organization. - operationId: dlp.projects.locations.projectDataProfiles.list + description: >- + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.locations.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11045,8 +10689,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path name: projectsId @@ -11058,12 +10701,20 @@ paths: required: true schema: type: string + - in: query + name: orderBy + schema: + type: string - in: query name: pageToken schema: type: string - in: query - name: orderBy + name: type + schema: + type: string + - in: query + name: filter schema: type: string - in: query @@ -11072,14 +10723,21 @@ paths: type: integer format: int32 - in: query - name: filter + name: locationId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: parameters: *ref_1 - get: - description: Gets a project data profile. - operationId: dlp.projects.locations.projectDataProfiles.get + post: + description: >- + Finish a running hybrid DlpJob. Triggers the finalization steps and + running of any enabled actions that have not yet run. + operationId: dlp.projects.locations.dlpJobs.finish + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2FinishDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11091,7 +10749,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11104,29 +10762,15 @@ paths: schema: type: string - in: path - name: projectDataProfilesId + name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: + /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: parameters: *ref_1 - post: - description: >- - Finds potentially sensitive info in content. This method has limits on - input size, processing time, and output size. When no InfoTypes or - CustomInfoTypes are specified in this request, the system will - automatically choose what detectors to run. By default this may be all - types, but may change over time as detectors are updated. For how to - guides, see - https://cloud.google.com/sensitive-data-protection/docs/inspecting-images - and - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, - operationId: dlp.projects.locations.content.inspect - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' + get: + description: Gets a table data profile. + operationId: dlp.projects.locations.tableDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11138,7 +10782,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' parameters: - in: path name: projectsId @@ -11147,26 +10791,19 @@ paths: type: string - in: path name: locationsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: - parameters: *ref_1 - post: - description: >- - De-identifies potentially sensitive info from a ContentItem. This method - has limits on input size and output size. See - https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.content.deidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' + required: true + schema: + type: string + - in: path + name: tableDataProfilesId + required: true + schema: + type: string + delete: + description: >- + Delete a TableDataProfile. Will not prevent the profile from being + regenerated if the table is still included in a discovery configuration. + operationId: dlp.projects.locations.tableDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11178,8 +10815,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11191,19 +10827,16 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: + - in: path + name: tableDataProfilesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles: parameters: *ref_1 - post: - description: >- - Re-identifies content that has been de-identified. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example - to learn more. - operationId: dlp.projects.locations.content.reidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + get: + description: Lists table data profiles for an organization. + operationId: dlp.projects.locations.tableDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11216,7 +10849,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse parameters: - in: path name: projectsId @@ -11228,17 +10861,28 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: parameters: *ref_1 - patch: - description: Updates a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + get: + description: Gets a project data profile. + operationId: dlp.projects.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11250,7 +10894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path name: projectsId @@ -11263,13 +10907,15 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: projectDataProfilesId required: true schema: type: string - delete: - description: Deletes a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.delete + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: + parameters: *ref_1 + get: + description: Lists project data profiles for an organization. + operationId: dlp.projects.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11281,7 +10927,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path name: projectsId @@ -11293,14 +10940,33 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - in: query + name: orderBy schema: type: string - get: - description: Gets a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections: + parameters: *ref_1 + post: + description: Create a Connection to an external data source. + operationId: dlp.projects.locations.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11312,7 +10978,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: projectsId @@ -11324,16 +10990,11 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: - parameters: *ref_1 get: - description: Lists discovery configurations. - operationId: dlp.projects.locations.discoveryConfigs.list + description: >- + Lists Connections in a parent. Use SearchConnections to see all + connections within an organization. + operationId: dlp.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11345,8 +11006,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' parameters: - in: path name: projectsId @@ -11359,27 +11019,28 @@ paths: schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query - name: orderBy + name: filter schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string - post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.projects.locations.discoveryConfigs.create + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + parameters: *ref_1 + patch: + description: Update a Connection. + operationId: dlp.projects.locations.connections.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11391,7 +11052,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: projectsId @@ -11403,13 +11064,14 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: - parameters: *ref_1 - delete: - description: >- - Delete a TableDataProfile. Will not prevent the profile from being - regenerated if the table is still included in a discovery configuration. - operationId: dlp.projects.locations.tableDataProfiles.delete + - in: path + name: connectionsId + required: true + schema: + type: string + get: + description: Get a Connection by name. + operationId: dlp.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11421,7 +11083,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: projectsId @@ -11434,13 +11096,13 @@ paths: schema: type: string - in: path - name: tableDataProfilesId + name: connectionsId required: true schema: type: string - get: - description: Gets a table data profile. - operationId: dlp.projects.locations.tableDataProfiles.get + delete: + description: Delete a Connection. + operationId: dlp.projects.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11452,7 +11114,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11465,15 +11127,15 @@ paths: schema: type: string - in: path - name: tableDataProfilesId + name: connectionsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles: + /v2/projects/{projectsId}/locations/{locationsId}/connections:search: parameters: *ref_1 get: - description: Lists table data profiles for an organization. - operationId: dlp.projects.locations.tableDataProfiles.list + description: Searches for Connections in a parent. + operationId: dlp.projects.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11486,7 +11148,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path name: projectsId @@ -11498,14 +11160,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - in: query name: pageToken schema: @@ -11515,11 +11169,18 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles: + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: parameters: *ref_1 get: - description: Lists file store data profiles for an organization. - operationId: dlp.projects.locations.fileStoreDataProfiles.list + description: >- + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11532,7 +11193,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: projectsId @@ -11545,7 +11206,7 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -11558,14 +11219,59 @@ paths: schema: type: string - in: query - name: pageToken + name: locationId + schema: + type: string + post: + description: >- + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.locations.deidentifyTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: + /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_1 - get: - description: Gets a file store data profile. - operationId: dlp.projects.locations.fileStoreDataProfiles.get + patch: + description: >- + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.locations.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11577,7 +11283,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -11590,16 +11296,16 @@ paths: schema: type: string - in: path - name: fileStoreDataProfilesId + name: deidentifyTemplatesId required: true schema: type: string - delete: + get: description: >- - Delete a FileStoreDataProfile. Will not prevent the profile from being - regenerated if the resource is still included in a discovery - configuration. - operationId: dlp.projects.locations.fileStoreDataProfiles.delete + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11611,7 +11317,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -11624,18 +11330,16 @@ paths: schema: type: string - in: path - name: fileStoreDataProfilesId + name: deidentifyTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_1 delete: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.storedInfoTypes.delete + operationId: dlp.projects.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11660,16 +11364,21 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: deidentifyTemplatesId required: true schema: type: string - get: - description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.get + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + parameters: *ref_1 + patch: + description: Updates a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11681,7 +11390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -11694,23 +11403,13 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: discoveryConfigsId required: true schema: type: string - patch: - description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + delete: + description: Deletes a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11722,7 +11421,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11735,24 +11434,13 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: discoveryConfigsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: - parameters: *ref_1 - post: - description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + get: + description: Gets a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11764,7 +11452,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -11776,12 +11464,16 @@ paths: required: true schema: type: string + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: + parameters: *ref_1 get: - description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.list + description: Lists discovery configurations. + operationId: dlp.projects.locations.discoveryConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11794,7 +11486,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path name: projectsId @@ -11806,11 +11498,6 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: orderBy schema: @@ -11820,7 +11507,40 @@ paths: schema: type: string - in: query - name: locationId + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a config for discovery to scan and profile storage. + operationId: dlp.projects.locations.discoveryConfigs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: @@ -11855,20 +11575,20 @@ paths: schema: type: string - in: query - name: locationId + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: pageToken + name: type schema: type: string - in: query - name: pageSize + name: orderBy schema: - type: integer - format: int32 + type: string - in: query - name: type + name: pageToken schema: type: string - in: query @@ -11876,7 +11596,7 @@ paths: schema: type: string - in: query - name: orderBy + name: locationId schema: type: string post: @@ -12105,14 +11825,89 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}: + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 + delete: + description: >- + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + patch: + description: >- + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: storedInfoTypesId + required: true + schema: + type: string get: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.inspectTemplates.get + operationId: dlp.projects.locations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12124,7 +11919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -12132,16 +11927,23 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId required: true schema: type: string - delete: + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: + parameters: *ref_1 + get: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.inspectTemplates.delete + operationId: dlp.projects.locations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12153,7 +11955,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: projectsId @@ -12161,22 +11964,39 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId required: true schema: type: string - patch: + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.inspectTemplates.patch + operationId: dlp.projects.locations.storedInfoTypes.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12188,7 +12008,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -12196,25 +12016,28 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/inspectTemplates: + /v2/projects/{projectsId}/dlpJobs: parameters: *ref_1 post: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.inspectTemplates.create + Creates a new job to inspect storage or calculate risk metrics. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. When no InfoTypes or CustomInfoTypes are specified in + inspect jobs, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.dlpJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12226,7 +12049,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -12235,10 +12058,12 @@ paths: type: string get: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.inspectTemplates.list + operationId: dlp.projects.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12250,20 +12075,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: orderBy schema: type: string - in: query - name: pageToken + name: type schema: type: string - in: query @@ -12275,19 +12103,27 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/content:reidentify: + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: parameters: *ref_1 post: description: >- - Re-identifies content that has been de-identified. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + Starts asynchronous cancellation on a long-running DlpJob. The server + makes a best effort to cancel the DlpJob, but success is not guaranteed. + See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.content.reidentify + operationId: dlp.projects.dlpJobs.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12299,33 +12135,28 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/content:inspect: + - in: path + name: dlpJobsId + required: true + schema: + type: string + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: parameters: *ref_1 - post: + get: description: >- - Finds potentially sensitive info in content. This method has limits on - input size, processing time, and output size. When no InfoTypes or - CustomInfoTypes are specified in this request, the system will - automatically choose what detectors to run. By default this may be all - types, but may change over time as detectors are updated. For how to - guides, see - https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + Gets the latest state of a long-running DlpJob. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, - operationId: dlp.projects.content.inspect - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.dlpJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12337,58 +12168,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/content:deidentify: - parameters: *ref_1 - post: - description: >- - De-identifies potentially sensitive info from a ContentItem. This method - has limits on input size and output size. See - https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.content.deidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse - parameters: - in: path - name: projectsId + name: dlpJobsId required: true schema: type: string - /v2/locations/{locationsId}/infoTypes: - parameters: *ref_1 - get: + delete: description: >- - Returns a list of the sensitive information types that DLP API supports. - See - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + Deletes a long-running DlpJob. This method indicates that the client is + no longer interested in the DlpJob result. The job will be canceled if + possible. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.locations.infoTypes.list + operationId: dlp.projects.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12400,34 +12201,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: locationsId + name: projectsId required: true schema: type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: locationId + - in: path + name: dlpJobsId + required: true schema: type: string - /v2/infoTypes: + /v2/projects/{projectsId}/image:redact: parameters: *ref_1 - get: + post: description: >- - Returns a list of the sensitive information types that DLP API supports. - See - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference - to learn more. - operationId: dlp.infoTypes.list + Redacts potentially sensitive info from an image. This method has limits + on input size, processing time, and output size. See + https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.image.redact + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12439,32 +12241,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' parameters: - - in: query - name: filter - schema: - type: string - - in: query - name: parent - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: languageCode + - in: path + name: projectsId + required: true schema: type: string - /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: + /v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 get: description: >- Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.inspectTemplates.get + operationId: dlp.projects.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12479,7 +12270,7 @@ paths: $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -12488,12 +12279,18 @@ paths: required: true schema: type: string - delete: + patch: description: >- - Deletes an InspectTemplate. See + Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.inspectTemplates.delete + operationId: dlp.projects.inspectTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12505,10 +12302,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -12517,18 +12314,12 @@ paths: required: true schema: type: string - patch: + delete: description: >- - Updates the InspectTemplate. See + Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.inspectTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + operationId: dlp.projects.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12540,10 +12331,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -12552,7 +12343,7 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/inspectTemplates: + /v2/projects/{projectsId}/inspectTemplates: parameters: *ref_1 post: description: >- @@ -12560,7 +12351,7 @@ paths: inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.inspectTemplates.create + operationId: dlp.projects.inspectTemplates.create requestBody: content: application/json: @@ -12581,7 +12372,7 @@ paths: $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -12590,7 +12381,7 @@ paths: Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.inspectTemplates.list + operationId: dlp.projects.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12606,10 +12397,18 @@ paths: #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string - in: query name: pageSize schema: @@ -12619,24 +12418,44 @@ paths: name: locationId schema: type: string - - in: query - name: pageToken + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a column data profile. + operationId: dlp.organizations.locations.columnDataProfiles.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: + - in: path + name: columnDataProfilesId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: parameters: *ref_1 get: - description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.organizations.locations.dlpJobs.list + description: Lists column data profiles for an organization. + operationId: dlp.organizations.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12648,7 +12467,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path name: organizationsId @@ -12666,33 +12486,25 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: locationId + name: pageToken schema: type: string - in: query name: filter schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: type - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: parameters: *ref_1 - get: + delete: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.get + Delete a FileStoreDataProfile. Will not prevent the profile from being + regenerated if the resource is still included in a discovery + configuration. + operationId: dlp.organizations.locations.fileStoreDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12704,7 +12516,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -12717,23 +12529,13 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: fileStoreDataProfilesId required: true schema: type: string - patch: - description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + get: + description: Gets a file store data profile. + operationId: dlp.organizations.locations.fileStoreDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12745,7 +12547,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' parameters: - in: path name: organizationsId @@ -12758,16 +12560,15 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: fileStoreDataProfilesId required: true schema: type: string - delete: - description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.delete + /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles: + parameters: *ref_1 + get: + description: Lists file store data profiles for an organization. + operationId: dlp.organizations.locations.fileStoreDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12779,7 +12580,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse parameters: - in: path name: organizationsId @@ -12791,25 +12593,37 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: filter schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: parameters: *ref_1 post: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.create + operationId: dlp.organizations.locations.jobTriggers.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12821,7 +12635,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -12835,10 +12649,10 @@ paths: type: string get: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.list + operationId: dlp.organizations.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12850,8 +12664,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: organizationsId @@ -12864,32 +12677,77 @@ paths: schema: type: string - in: query - name: locationId + name: pageToken + schema: + type: string + - in: query + name: type schema: type: string - in: query name: pageSize schema: - type: integer - format: int32 - - in: query - name: pageToken + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: filter + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_1 + patch: + description: >- + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.organizations.locations.jobTriggers.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: jobTriggersId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}: - parameters: *ref_1 - patch: - description: Update a Connection. - operationId: dlp.organizations.locations.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' + get: + description: >- + Gets a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.organizations.locations.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12901,7 +12759,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -12914,13 +12772,16 @@ paths: schema: type: string - in: path - name: connectionsId + name: jobTriggersId required: true schema: type: string delete: - description: Delete a Connection. - operationId: dlp.organizations.locations.connections.delete + description: >- + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.organizations.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12945,13 +12806,18 @@ paths: schema: type: string - in: path - name: connectionsId + name: jobTriggersId required: true schema: type: string - get: - description: Get a Connection by name. - operationId: dlp.organizations.locations.connections.get + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_1 + delete: + description: >- + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.organizations.locations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12963,7 +12829,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -12976,20 +12842,23 @@ paths: schema: type: string - in: path - name: connectionsId + name: storedInfoTypesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections: - parameters: *ref_1 - post: - description: Create a Connection to an external data source. - operationId: dlp.organizations.locations.connections.create + patch: + description: >- + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.organizations.locations.storedInfoTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13001,7 +12870,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -13013,11 +12882,17 @@ paths: required: true schema: type: string + - in: path + name: storedInfoTypesId + required: true + schema: + type: string get: description: >- - Lists Connections in a parent. Use SearchConnections to see all - connections within an organization. - operationId: dlp.organizations.locations.connections.list + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.organizations.locations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13029,7 +12904,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -13041,24 +12916,19 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: storedInfoTypesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: parameters: *ref_1 get: - description: Searches for Connections in a parent. - operationId: dlp.organizations.locations.connections.search + description: >- + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.organizations.locations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13071,7 +12941,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: organizationsId @@ -13084,23 +12954,34 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageSize + name: orderBy schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: locationId schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: - parameters: *ref_1 - get: - description: Gets a column data profile. - operationId: dlp.organizations.locations.columnDataProfiles.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.organizations.locations.storedInfoTypes.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13112,7 +12993,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -13124,16 +13005,14 @@ paths: required: true schema: type: string - - in: path - name: columnDataProfilesId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_1 - get: - description: Lists column data profiles for an organization. - operationId: dlp.organizations.locations.columnDataProfiles.list + delete: + description: >- + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13145,8 +13024,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13158,28 +13036,17 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter + - in: path + name: deidentifyTemplatesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: - parameters: *ref_1 - delete: - description: Deletes a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.delete + get: + description: >- + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13191,7 +13058,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -13204,19 +13071,22 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: deidentifyTemplatesId required: true schema: type: string patch: - description: Updates a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.patch + description: >- + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13228,7 +13098,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -13241,13 +13111,18 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: deidentifyTemplatesId required: true schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: + parameters: *ref_1 get: - description: Gets a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.get + description: >- + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13259,7 +13134,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: organizationsId @@ -13271,22 +13147,36 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: - parameters: *ref_1 post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.organizations.locations.discoveryConfigs.create + description: >- + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13298,7 +13188,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -13310,9 +13200,11 @@ paths: required: true schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: + parameters: *ref_1 get: - description: Lists discovery configurations. - operationId: dlp.organizations.locations.discoveryConfigs.list + description: Lists project data profiles for an organization. + operationId: dlp.organizations.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13325,7 +13217,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path name: organizationsId @@ -13338,7 +13230,7 @@ paths: schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - in: query @@ -13347,7 +13239,11 @@ paths: type: integer format: int32 - in: query - name: orderBy + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: @@ -13383,11 +13279,16 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: + /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: parameters: *ref_1 get: - description: Lists project data profiles for an organization. - operationId: dlp.organizations.locations.projectDataProfiles.list + description: >- + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.organizations.locations.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13399,8 +13300,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path name: organizationsId @@ -13413,30 +13313,38 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query name: orderBy schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: type + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: pageToken + name: locationId schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 - delete: + get: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.delete + operationId: dlp.organizations.locations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13448,7 +13356,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -13461,16 +13369,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string - get: + delete: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.get + operationId: dlp.organizations.locations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13482,7 +13390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13495,22 +13403,22 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string patch: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.patch + operationId: dlp.organizations.locations.inspectTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13522,7 +13430,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -13535,18 +13443,54 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: parameters: *ref_1 + post: + description: >- + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string get: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.list + operationId: dlp.organizations.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13559,7 +13503,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: organizationsId @@ -13572,7 +13516,11 @@ paths: schema: type: string - in: query - name: locationId + name: orderBy + schema: + type: string + - in: query + name: pageToken schema: type: string - in: query @@ -13581,26 +13529,20 @@ paths: type: integer format: int32 - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + name: locationId schema: type: string - post: - description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.create + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + parameters: *ref_1 + patch: + description: Updates a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13612,7 +13554,103 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + delete: + description: Deletes a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + get: + description: Gets a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: + parameters: *ref_1 + get: + description: Lists discovery configurations. + operationId: dlp.organizations.locations.discoveryConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path name: organizationsId @@ -13624,21 +13662,28 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string post: - description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.locations.inspectTemplates.create + description: Creates a config for discovery to scan and profile storage. + operationId: dlp.organizations.locations.discoveryConfigs.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13650,7 +13695,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13662,12 +13707,11 @@ paths: required: true schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: + parameters: *ref_1 get: - description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.locations.inspectTemplates.list + description: Lists table data profiles for an organization. + operationId: dlp.organizations.locations.tableDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13680,7 +13724,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse parameters: - in: path name: organizationsId @@ -13693,7 +13737,7 @@ paths: schema: type: string - in: query - name: orderBy + name: filter schema: type: string - in: query @@ -13706,23 +13750,16 @@ paths: type: integer format: int32 - in: query - name: locationId + name: orderBy schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: parameters: *ref_1 - patch: + delete: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.locations.inspectTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + Delete a TableDataProfile. Will not prevent the profile from being + regenerated if the table is still included in a discovery configuration. + operationId: dlp.organizations.locations.tableDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13734,7 +13771,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13747,16 +13784,13 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: tableDataProfilesId required: true schema: type: string get: - description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.locations.inspectTemplates.get + description: Gets a table data profile. + operationId: dlp.organizations.locations.tableDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13768,7 +13802,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' parameters: - in: path name: organizationsId @@ -13781,16 +13815,15 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: tableDataProfilesId required: true schema: type: string - delete: - description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.locations.inspectTemplates.delete + /v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}: + parameters: *ref_1 + get: + description: Get a Connection by name. + operationId: dlp.organizations.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13802,7 +13835,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -13815,18 +13848,13 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: connectionsId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: - parameters: *ref_1 delete: - description: >- - Delete a FileStoreDataProfile. Will not prevent the profile from being - regenerated if the resource is still included in a discovery - configuration. - operationId: dlp.organizations.locations.fileStoreDataProfiles.delete + description: Delete a Connection. + operationId: dlp.organizations.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13851,13 +13879,18 @@ paths: schema: type: string - in: path - name: fileStoreDataProfilesId + name: connectionsId required: true schema: type: string - get: - description: Gets a file store data profile. - operationId: dlp.organizations.locations.fileStoreDataProfiles.get + patch: + description: Update a Connection. + operationId: dlp.organizations.locations.connections.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13869,7 +13902,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -13882,15 +13915,20 @@ paths: schema: type: string - in: path - name: fileStoreDataProfilesId + name: connectionsId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles: + /v2/organizations/{organizationsId}/locations/{locationsId}/connections: parameters: *ref_1 - get: - description: Lists file store data profiles for an organization. - operationId: dlp.organizations.locations.fileStoreDataProfiles.list + post: + description: Create a Connection to an external data source. + operationId: dlp.organizations.locations.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13902,8 +13940,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -13915,31 +13952,11 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: - parameters: *ref_1 get: description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.list + Lists Connections in a parent. Use SearchConnections to see all + connections within an organization. + operationId: dlp.organizations.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13951,7 +13968,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' parameters: - in: path name: organizationsId @@ -13964,11 +13981,7 @@ paths: schema: type: string - in: query - name: orderBy - schema: - type: string - - in: query - name: locationId + name: pageToken schema: type: string - in: query @@ -13980,26 +13993,11 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: type - schema: - type: string - post: - description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: + parameters: *ref_1 + get: + description: Searches for Connections in a parent. + operationId: dlp.organizations.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14011,7 +14009,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path name: organizationsId @@ -14023,48 +14022,34 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: - parameters: *ref_1 - delete: - description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: organizationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: jobTriggersId - required: true + type: integer + format: int32 + - in: query + name: filter schema: type: string - get: + /v2/organizations/{organizationsId}/deidentifyTemplates: + parameters: *ref_1 + post: description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.locations.jobTriggers.get + operationId: dlp.organizations.deidentifyTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14076,34 +14061,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: jobTriggersId - required: true - schema: - type: string - patch: + get: description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.locations.jobTriggers.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + operationId: dlp.organizations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14115,30 +14085,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: locationId schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: + - in: query + name: pageToken + schema: + type: string + /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_1 - delete: + get: description: >- - Delete a TableDataProfile. Will not prevent the profile from being - regenerated if the table is still included in a discovery configuration. - operationId: dlp.organizations.locations.tableDataProfiles.delete + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14150,7 +14129,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -14158,18 +14137,16 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: tableDataProfilesId + name: deidentifyTemplatesId required: true schema: type: string - get: - description: Gets a table data profile. - operationId: dlp.organizations.locations.tableDataProfiles.get + delete: + description: >- + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14181,7 +14158,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14189,20 +14166,22 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: tableDataProfilesId + name: deidentifyTemplatesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: - parameters: *ref_1 - get: - description: Lists table data profiles for an organization. - operationId: dlp.organizations.locations.tableDataProfiles.list + patch: + description: >- + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14214,8 +14193,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -14223,42 +14201,18 @@ paths: schema: type: string - in: path - name: locationsId + name: deidentifyTemplatesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 - patch: + delete: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See + Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + operationId: dlp.organizations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14270,7 +14224,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14282,12 +14236,19 @@ paths: required: true schema: type: string - delete: + patch: description: >- - Deletes a stored infoType. See + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.storedInfoTypes.delete + operationId: dlp.organizations.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14299,7 +14260,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -14398,11 +14359,7 @@ paths: schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + name: locationId schema: type: string - in: query @@ -14411,23 +14368,27 @@ paths: type: integer format: int32 - in: query - name: locationId + name: orderBy schema: type: string - /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + - in: query + name: pageToken + schema: + type: string + /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 patch: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.patch + operationId: dlp.organizations.inspectTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14439,7 +14400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -14447,16 +14408,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string get: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.get + operationId: dlp.organizations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14468,7 +14429,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -14476,16 +14437,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string delete: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.delete + operationId: dlp.organizations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14505,25 +14466,25 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string - /v2/organizations/{organizationsId}/deidentifyTemplates: + /v2/organizations/{organizationsId}/inspectTemplates: parameters: *ref_1 post: description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.create + operationId: dlp.organizations.inspectTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14535,7 +14496,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -14544,10 +14505,10 @@ paths: type: string get: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.list + operationId: dlp.organizations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14560,7 +14521,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: organizationsId @@ -14568,19 +14529,58 @@ paths: schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: locationId schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: orderBy schema: type: string + /v2/locations/{locationsId}/infoTypes: + parameters: *ref_1 + get: + description: >- + Returns a list of the sensitive information types that DLP API supports. + See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + to learn more. + operationId: dlp.locations.infoTypes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string - in: query - name: pageSize + name: languageCode schema: - type: integer - format: int32 + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: filter + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml b/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml index 5d6bfd93..12d7be92 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml @@ -37,1170 +37,1301 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleRpcStatus: - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: properties: - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + questionId: + description: The Crowd Compute question ID. type: string + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + description: The long-running operation metadata for the ReviewDocument method. type: object - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: - properties: {} - description: Response message for the UndeployProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse - type: object - GoogleCloudDocumentaiV1HumanReviewStatus: - id: GoogleCloudDocumentaiV1HumanReviewStatus - description: The status of human review on a processed document. + id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata + GoogleCloudDocumentaiV1ReviewDocumentRequest: properties: - state: + priority: + type: string enumDescriptions: + - The default priority level. - >- - Human review state is unspecified. Most likely due to an internal - error. - - >- - Human review is skipped for the document. This can happen because - human review isn't enabled on the processor or the processing - request has been set to skip this document. - - >- - Human review validation is triggered and passed, so no review is - needed. - - >- - Human review validation is triggered and the document is under - review. - - >- - Some error happened during triggering human review, see the - state_message for details. - type: string + The urgent priority level. The labeling manager should allocate + labeler resource to the urgent task queue to respect this priority + level. + description: The priority of the human review task. enum: - - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR - description: The state of human review on the processing request. - humanReviewOperation: + - DEFAULT + - URGENT + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: The document schema of the human review task. + inlineDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: An inline document proto. + enableSchemaValidation: + type: boolean description: >- - The name of the operation triggered by the processed document. This - field is populated only when the state is - `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and - metadata as the long-running operation returned by ReviewDocument. - type: string - stateMessage: - type: string - description: A message providing more details about the human review state. + Whether the validation should be performed on the ad-hoc review + request. + type: object + id: GoogleCloudDocumentaiV1ReviewDocumentRequest + description: Request message for the ReviewDocument method. + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata type: object - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo: properties: - customGenAiModelInfo: - description: Information for a custom Generative AI model created by the user. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo - foundationGenAiModelInfo: - description: Information for a pretrained Google-managed foundation model. + destDatasetType: + description: The destination dataset split type. + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + deprecated: true + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + type: string + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo - id: GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo - type: object - description: Information about Generative AI model-based processor versions. - GoogleTypeDateTime: - description: >- - Represents civil time (or occasionally physical time). This type can - represent a civil time in one of a few possible ways: * When utc_offset - is set and time_zone is unset: a civil time on a calendar day with a - particular offset from UTC. * When time_zone is set and utc_offset is - unset: a civil time on a calendar day in a particular time zone. * When - neither time_zone nor utc_offset is set: a civil time on a calendar day - in local time. The date is relative to the Proleptic Gregorian Calendar. - If year, month, or day are 0, the DateTime is considered not to have a - specific year, month, or day respectively. This type may also be used to - represent a physical time if all the date and time fields are set and - either case of the `time_offset` oneof is set. Consider using - `Timestamp` message for physical time instead. If your use case also - would like to store the user's timezone, that can be done in another - field. This type is more flexible than some applications may want. Make - sure to document and validate your application's limitations. + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualBatchMoveStatuses: + type: array + description: The list of response details of each document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + destSplitType: + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + type: string + description: The destination dataset split type. + GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: type: object properties: - timeZone: - $ref: '#/components/schemas/GoogleTypeTimeZone' - description: Time zone. - hours: - description: >- - Optional. Hours of day in 24 hour format. Should be from 0 to 23, - defaults to 0 (midnight). An API may choose to allow the value - "24:00:00" for scenarios like business closing time. - type: integer - format: int32 - year: + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + status: + description: The status processing the document. + $ref: '#/components/schemas/GoogleRpcStatus' + inputGcsSource: + type: string description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - type: integer - format: int32 - utcOffset: + The source of the document, same as the input_gcs_source field in + the request when the batch process started. + outputGcsDestination: type: string description: >- - UTC offset. Must be whole seconds, between -18 hours and +18 hours. - For example, a UTC offset of -4:00 would be represented as { - seconds: -14400 }. - format: google-duration - nanos: + The Cloud Storage output destination (in the request as + DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed + document if it was successful, otherwise empty. + id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + description: The status of a each individual document in the batch process. + GoogleCloudDocumentaiV1DocumentPageMatrix: + type: object + id: GoogleCloudDocumentaiV1DocumentPageMatrix + properties: + cols: type: integer format: int32 - description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. - month: + description: Number of columns in the matrix. + rows: format: int32 - description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. - type: integer - day: + description: Number of rows in the matrix. type: integer - description: >- - Optional. Day of month. Must be from 1 to 31 and valid for the year - and month, or 0 if specifying a datetime without a day. - format: int32 - seconds: - description: >- - Optional. Seconds of minutes of the time. Must normally be from 0 to - 59, defaults to 0. An API may allow the value 60 if it allows - leap-seconds. - format: int32 + type: type: integer - minutes: format: int32 description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. - type: integer - id: GoogleTypeDateTime - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: + This encodes information about what data type the matrix uses. For + example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of + OpenCV primitive data types, please refer to + https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + data: + format: byte + description: The matrix data. + type: string + description: >- + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: + description: The response for TrainProcessorVersion. + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse properties: - documentErrorCount: - type: integer - description: The total number of document errors. - format: int32 - documentErrors: - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - datasetErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - type: array - datasetErrorCount: - description: The total number of dataset errors. - type: integer - format: int32 - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. - id: >- - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + processorVersion: + type: string + description: The resource name of the processor version produced by training. type: object - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: - id: >- - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + description: Font and other text style attributes. type: object properties: - datasetErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' + superscript: description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - type: array - documentErrorCount: - description: The total number of document errors. + Whether the text is a superscript. This feature is not supported + yet. + type: boolean + underlined: + description: Whether the text is underlined. + type: boolean + fontSize: + description: Font size in points (`1` point is `¹⁄₇₂` inches). format: int32 type: integer - datasetErrorCount: - format: int32 + strikeout: + type: boolean + description: >- + Whether the text is strikethrough. This feature is not supported + yet. + smallcaps: + description: >- + Whether the text is in small caps. This feature is not supported + yet. + type: boolean + pixelFontSize: + type: number + description: >- + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + format: double + fontType: + type: string + description: Name or style of the font. + letterSpacing: + format: double + type: number + description: Letter spacing in points. + subscript: + type: boolean + description: Whether the text is a subscript. This feature is not supported yet. + handwritten: + description: Whether the text is handwritten. + type: boolean + backgroundColor: + description: Color of the background. + $ref: '#/components/schemas/GoogleTypeColor' + italic: + description: Whether the text is italic. + type: boolean + fontWeight: type: integer - description: The total number of dataset errors. - documentErrors: description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: - description: Information for a pretrained Google-managed foundation model. - id: >- - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + format: int32 + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + bold: + type: boolean + description: >- + Whether the text is bold (equivalent to font_weight is at least + `700`). + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: type: object + id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo properties: - finetuningAllowed: - type: boolean - description: Whether finetuning is allowed for this base processor version. - minTrainLabeledDocuments: - format: int32 + locationId: description: >- - The minimum number of labeled documents in the training dataset - required for finetuning. - type: integer - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: + The location ID. For supported locations, refer to [regional and + multi-regional support](/document-ai/docs/regions). + type: string + description: The location information about where the processor is available. + GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: properties: commonMetadata: description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata type: object - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata - description: Metadata of the EvaluateProcessorVersion method. - GoogleCloudDocumentaiV1DocumentTextAnchor: + description: The long-running operation metadata for UpdateLabelerPool. + GoogleCloudDocumentaiV1BatchDocumentsInputConfig: + description: The common config to specify a set of documents used as input. type: object - id: GoogleCloudDocumentaiV1DocumentTextAnchor + id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig properties: - content: - type: string + gcsDocuments: + description: The set of documents individually specified on Cloud Storage. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' + gcsPrefix: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. - textSegments: + The set of documents that match the specified Cloud Storage + `gcs_prefix`. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Represents a row in a table. + properties: + cells: type: array + description: A table row is a list of table cells. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - description: The text segments from the Document.text. - description: Text reference indexing into the Document.text. - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell type: object - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. + GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: + type: object + id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + description: Configuration specific to the Cloud Storage-based implementation. properties: - type: - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - type: string - description: Detected break type. - GoogleCloudDocumentaiV1ProcessorVersion: - id: GoogleCloudDocumentaiV1ProcessorVersion + gcsPrefix: + description: >- + Required. The Cloud Storage URI (a directory) where the documents + belonging to the dataset must be stored. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' + GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: + properties: {} + description: The response proto of ExportDocuments method. + type: object + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse + type: object + properties: {} + description: The response proto of AutoLabelDocuments method. + GoogleCloudDocumentaiV1DocumentPage: + type: object + description: A page in a Document. + id: GoogleCloudDocumentaiV1DocumentPage properties: - name: + transforms: description: >- - Identifier. The resource name of the processor version. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - type: string - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - DEPLOYED - - DEPLOYING - - UNDEPLOYED - - UNDEPLOYING - - CREATING - - DELETING - - FAILED - - IMPORTING - description: Output only. The state of the processor version. - enumDescriptions: - - The processor version is in an unspecified state. - - The processor version is deployed and can be used for processing. - - The processor version is being deployed. - - >- - The processor version is not deployed and cannot be used for - processing. - - The processor version is being undeployed. - - The processor version is being created. - - The processor version is being deleted. - - The processor version failed and is in an indeterminate state. - - The processor version is being imported. - type: string - deprecationInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo - description: If set, information about the eventual deprecation of this version. - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - kmsKeyVersionName: - type: string - description: The KMS key version with which data is encrypted. - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: The schema of the processor version. Describes the output. - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - googleManaged: - readOnly: true - type: boolean + Transformation matrices that were applied to the original document + image to produce Page.image. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + type: array + tables: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' + description: A list of visually detected tables on the page. + blocks: description: >- - Output only. Denotes that this `ProcessorVersion` is managed by - Google. - modelType: - type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - MODEL_TYPE_GENERATIVE - - MODEL_TYPE_CUSTOM - description: Output only. The model type of this processor version. - readOnly: true - enumDescriptions: - - The processor version has unspecified model type. - - The processor version has generative model type. - - The processor version has custom model type. - displayName: - description: The display name of the processor version. - type: string - latestEvaluation: - description: The most recently invoked evaluation for the processor version. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' - createTime: - type: string - description: The time the processor version was created. - format: google-datetime - genAiModelInfo: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo + A list of visually detected text blocks on the page. A block has a + set of lines (collected into paragraphs) that have a common + line-spacing and orientation. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + type: array + pageNumber: description: >- - Output only. Information about Generative AI model-based processor - versions. - kmsKeyName: - type: string - description: The KMS key name used for encryption. - type: object - description: >- - A processor version is an implementation of a processor. Each processor - can have multiple versions, pretrained by Google internally or uptrained - by the customer. A processor can only have one default version at a - time. Its document-processing behavior is defined by that version. - GoogleCloudDocumentaiV1beta3DocumentId: - type: object - description: Document Identifier. - properties: - revisionRef: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3RevisionRef' - description: Points to a specific revision of the document if set. - unmanagedDocId: - description: A document id within unmanaged dataset. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId - gcsManagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId - description: A document id within user-managed Cloud Storage. - id: GoogleCloudDocumentaiV1beta3DocumentId - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: - description: Resync status against inconsistency types on the dataset level. - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus - properties: - status: + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. + format: int32 + type: integer + image: description: >- - The status of resyncing the dataset with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. - $ref: '#/components/schemas/GoogleRpcStatus' - datasetInconsistencyType: - type: string - enumDescriptions: - - Default value. - - The marker file under the dataset folder is not found. - enum: - - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED - - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER - description: The type of the inconsistency of the dataset. - type: object - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: - type: object - description: The status of each individual document in the batch delete process. - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of deleting the document in storage. - documentId: - description: The document id of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' - id: >- - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - GoogleCloudDocumentaiV1GcsDocument: - description: Specifies a document stored on Cloud Storage. - properties: - gcsUri: - description: The Cloud Storage object uri. - type: string - mimeType: - type: string - description: An IANA MIME type (RFC6838) of the content. - id: GoogleCloudDocumentaiV1GcsDocument - type: object - GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: - description: The input data used to train a new ProcessorVersion. - type: object - properties: - trainingDocuments: - description: The documents used for training the new version. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - testDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The documents used for testing the trained version. - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: - description: Response of the sample documents operation. - type: object - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse - properties: - sampleTestStatus: - description: The status of sampling documents in test split. - $ref: '#/components/schemas/GoogleRpcStatus' - sampleTrainingStatus: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of sampling documents in training split. - selectedDocuments: - description: The result of the sampling process. - type: array + Rendered image for this page. This image is preprocessed to remove + any skew, rotation, and distortions such that the annotation + bounding boxes can be upright and axis-aligned. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + detectedLanguages: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument - GoogleCloudDocumentaiV1DocumentStyleFontSize: - id: GoogleCloudDocumentaiV1DocumentStyleFontSize - description: Font size with unit. - type: object - properties: - size: - format: float - description: Font size for the text. - type: number - unit: - description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - type: string - GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: - properties: - defaultProcessorVersion: - type: string - description: >- - Required. The resource name of child ProcessorVersion to use as - default. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` - type: object - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest - description: Request message for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiV1Document: - properties: - text: - type: string - description: Optional. UTF-8 encoded text in reading order from the document. - pages: - description: Visual page layout for the Document. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array + description: A list of detected languages together with confidence. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the page. + provenance: + description: The history of this page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + visualElements: + description: >- + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - entities: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + type: array + formFields: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + description: A list of visually detected form fields on the page. type: array - revisions: + detectedBarcodes: + type: array + description: A list of detected barcodes. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + symbols: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' type: array - description: Placeholder. Revision history of this document. - textChanges: + description: A list of visually detected symbols on the page. + imageQualityScores: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + description: Image quality scores. + paragraphs: type: array description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' - entityRelations: - description: Placeholder. Relationship among Document.entities. + A list of visually detected text paragraphs on the page. A + collection of lines that a human would perceive as a paragraph. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' + tokens: + description: A list of visually detected tokens on the page. type: array - uri: - type: string + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + dimension: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + description: Physical dimension of the page. + lines: description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - error: - description: Any error that occurred while processing this document. - $ref: '#/components/schemas/GoogleRpcStatus' - chunkedDocument: - description: Document chunked based on chunking config. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' - mimeType: - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - type: string - shardInfo: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' - description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - content: - type: string - description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. - format: byte - textStyles: - deprecated: true + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' type: array - description: Styles for the Document.text. - documentLayout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' - description: Parsed layout of the document. - description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. + GoogleCloudLocationLocation: + description: A resource that represents a Google Cloud location. type: object - id: GoogleCloudDocumentaiV1Document - GoogleCloudDocumentaiV1BatchProcessRequest: - id: GoogleCloudDocumentaiV1BatchProcessRequest properties: - inputDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The input documents for the BatchProcessDocuments method. - skipHumanReview: + name: description: >- - Whether human review should be skipped for this request. Default to - `false`. - type: boolean - processOptions: - description: Inference-time options for the process API - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - documentOutputConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' - description: The output configuration for the BatchProcessDocuments method. + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string labels: additionalProperties: type: string + type: object description: >- - Optional. The labels with user-defined metadata for the request. - 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. + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + locationId: + type: string + description: 'The canonical id for this location. For example: `"us-east1"`.' + metadata: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: object - description: Request message for BatchProcessDocuments. + description: >- + Service-specific metadata. For example the available capacity at the + given location. + displayName: + type: string + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + id: GoogleCloudLocationLocation + GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: type: object - GoogleCloudDocumentaiV1ListEvaluationsResponse: - id: GoogleCloudDocumentaiV1ListEvaluationsResponse - description: The response from `ListEvaluations`. + id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + description: The long-running operation metadata for the ReviewDocument method. + properties: + stateMessage: + type: string + description: >- + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + createTime: + type: string + format: google-datetime + description: The creation time of the operation. + updateTime: + format: google-datetime + description: The last update time of the operation. + type: string + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + questionId: + description: The Crowd Compute question ID. + type: string + state: + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + description: Used only when Operation.done is false. + type: string + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: type: object + id: >- + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + description: >- + The validation status of each import config. Status is set to an error + if there are no documents to import in the `import_config`, or `OK` if + the operation will try to proceed with at least one document. properties: - nextPageToken: + status: + description: The validation status of import config. + $ref: '#/components/schemas/GoogleRpcStatus' + inputGcsSource: + type: string + description: The source Cloud Storage URI specified in the import config. + GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: + properties: + schema: 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. + Output only. The schema in Document AI Warehouse associated with the + dataset. type: string - evaluations: - description: The evaluations requested. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' - type: array - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - description: A row of table cells. - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + readOnly: true + collection: + description: >- + Output only. The collection in Document AI Warehouse associated with + the dataset. + type: string + readOnly: true + id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + description: >- + Configuration specific to the Document AI Warehouse-based + implementation. + type: object + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: properties: - cells: + qualityScore: + format: float + description: >- + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + type: number + detectedDefects: + type: array + description: A list of detected defects. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell - type: array - description: Cells that make up this row. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores type: object - GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata + description: Image quality scores for the page image. + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: + id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata properties: commonMetadata: description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - testDatasetValidation: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - trainingDatasetValidation: - description: The training dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: The metadata that represents a processor version being created. - type: object - GoogleLongrunningListOperationsResponse: - type: object - id: GoogleLongrunningListOperationsResponse - properties: - operations: + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + totalDocumentCount: + format: int32 + description: Total number of the documents that are qualified for importing. + type: integer + importConfigValidationResults: type: array + description: Validation statuses of the batch documents import config. items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - description: >- - A list of operations that matches the specified filter in the - request. - nextPageToken: - type: string - description: The standard List next-page token. - description: The response message for Operations.ListOperations. - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: - properties: {} - description: Response message for the UndeployProcessorVersion method. - type: object - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse - GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + individualImportStatuses: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + description: The list of response details of each document. + type: array type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - GoogleCloudDocumentaiV1EvaluationCounters: + description: Metadata of the import document operation. + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: + description: The status of each individual document in the import process. type: object - description: Evaluation counters for the documents that were used. - id: GoogleCloudDocumentaiV1EvaluationCounters properties: - evaluatedDocumentsCount: - description: How many documents were used in the evaluation. - format: int32 - type: integer - invalidDocumentsCount: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the importing of the document. + inputGcsSource: + type: string + description: The source Cloud Storage URI of the document. + outputDocumentId: description: >- - How many documents were not included in the evaluation as they - didn't pass validation. + The document id of imported document if it was successful, otherwise + empty. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + GoogleTypeDateTime: + description: >- + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. + id: GoogleTypeDateTime + type: object + properties: + seconds: + description: >- + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. type: integer format: int32 - inputDocumentsCount: - type: integer + hours: format: int32 - description: How many documents were sent for evaluation. - failedDocumentsCount: type: integer description: >- - How many documents were not included in the evaluation as Document - AI failed to process them. - format: int32 - GoogleCloudDocumentaiV1DocumentPageImage: - id: GoogleCloudDocumentaiV1DocumentPageImage - properties: - width: - description: Width of the image in pixels. + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. + minutes: + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. type: integer format: int32 - height: + year: + description: >- + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. format: int32 type: integer - description: Height of the image in pixels. - mimeType: + day: + type: integer + format: int32 description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - type: string - content: - format: byte + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + utcOffset: type: string - description: Raw byte content of the image. - description: Rendered image contents for this page. + format: google-duration + description: >- + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. + timeZone: + $ref: '#/components/schemas/GoogleTypeTimeZone' + description: Time zone. + month: + description: >- + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + type: integer + format: int32 + nanos: + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + format: int32 + type: integer + GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: + description: The response proto of ResyncDataset method. type: object - GoogleCloudDocumentaiV1DocumentPageToken: + properties: {} + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse + GoogleCloudDocumentaiV1DeleteProcessorMetadata: + id: GoogleCloudDocumentaiV1DeleteProcessorMetadata + properties: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + description: The long-running operation metadata for the DeleteProcessor method. + type: object + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: type: object properties: - styleInfo: - description: Text style attributes. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + datasetInconsistencyType: + type: string + enumDescriptions: + - Default value. + - The marker file under the dataset folder is not found. + description: The type of the inconsistency of the dataset. + enum: + - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED + - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The status of resyncing the dataset with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + description: Resync status against inconsistency types on the dataset level. + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + GoogleCloudDocumentaiV1DocumentPageToken: + description: A detected token. + id: GoogleCloudDocumentaiV1DocumentPageToken + properties: detectedBreak: + description: Detected break at the end of a Token. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. + styleInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Text style attributes. provenance: + description: The history of this annotation. deprecated: true $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Token. detectedLanguages: + type: array description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Token. - id: GoogleCloudDocumentaiV1DocumentPageToken - description: A detected token. - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: - properties: - evaluation: - type: string - description: The resource name of the created evaluation. - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse type: object - description: Response of the EvaluateProcessorVersion method. - GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: - description: Response of the EvaluateProcessorVersion method. - type: object - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse - properties: - evaluation: - type: string - description: The resource name of the created evaluation. - GoogleCloudDocumentaiV1EvaluationMetrics: + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Represents where the chunk starts and ends in the document. type: object properties: - predictedDocumentCount: - type: integer - format: int32 - description: The amount of documents with a predicted occurrence. - truePositivesCount: - type: integer - format: int32 - description: The amount of true positives. - falseNegativesCount: - type: integer - description: The amount of false negatives. - format: int32 - f1Score: - format: float - type: number - description: The calculated f1 score. - groundTruthDocumentCount: - format: int32 - type: integer - description: The amount of documents with a ground truth occurrence. - totalDocumentsCount: - description: The amount of documents that had an occurrence of this label. - format: int32 - type: integer - falsePositivesCount: - type: integer + pageStart: format: int32 - description: The amount of false positives. - predictedOccurrencesCount: type: integer - format: int32 - description: The amount of occurrences in predicted documents. - recall: - description: The calculated recall. - format: float - type: number - precision: - description: The calculated precision. - type: number - format: float - groundTruthOccurrencesCount: + description: Page where chunk starts in the document. + pageEnd: type: integer - description: The amount of occurrences in ground truth documents. format: int32 - id: GoogleCloudDocumentaiV1EvaluationMetrics - description: Evaluation metrics, either in aggregate or about a specific entity. - GoogleTypeMoney: + description: Page where chunk ends in the document. + GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: type: object + description: The long-running operation metadata for the DeleteProcessor method. + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata properties: - nanos: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1DocumentPageImage: + type: object + id: GoogleCloudDocumentaiV1DocumentPageImage + properties: + mimeType: description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + type: string + width: + description: Width of the image in pixels. format: int32 type: integer - currencyCode: - description: The three-letter currency code defined in ISO 4217. - type: string - units: - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + content: + description: Raw byte content of the image. type: string - format: int64 - id: GoogleTypeMoney - description: Represents an amount of money with its currency type. - GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse - description: The response proto of ExportDocuments method. - type: object - properties: {} - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: - description: The metadata proto of `ResyncDataset` method. - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata - type: object + format: byte + height: + description: Height of the image in pixels. + type: integer + format: int32 + description: Rendered image contents for this page. + GoogleCloudDocumentaiV1DocumentRevision: properties: - individualDocumentResyncStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + humanReview: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + description: Human Review information of this revision. + agent: description: >- - The list of document resync statuses. The same document could have - multiple `individual_document_resync_statuses` if it has multiple - inconsistencies. - datasetResyncStatuses: + If the change was made by a person specify the name or id of that + person. + type: string + id: + description: >- + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. + type: string + parentIds: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + type: string + type: array description: >- - The list of dataset resync statuses. Not checked when - ResyncDatasetRequest.dataset_documents is specified. + The revisions that this revision is based on. Must include all the + ids that have anything to do with this revision - eg. there are + `provenance.parent.revision` fields that index into this field. + createTime: + format: google-datetime + description: >- + The time that the revision was created, internally generated by doc + proto storage at the time of create. + type: string + processor: + type: string + description: >- + If the annotation was made by processor identify the processor by + its resource name. + parent: type: array - commonMetadata: + description: >- + The revisions that this revision is based on. This can include one + or more parent (when documents are merged.) This field represents + the index into the `revisions` field. + items: + format: int32 + type: integer + deprecated: true + description: Contains past or forward revisions of this document. + type: object + id: GoogleCloudDocumentaiV1DocumentRevision + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + properties: + text: + description: Footer in text format. + type: string + pageSpan: + description: Page span of the footer. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan type: object - id: >- - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + description: Represents the page footer associated with the chunk. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + GoogleCloudDocumentaiV1CommonOperationMetadata: + type: object + description: The common metadata for long running operations. + id: GoogleCloudDocumentaiV1CommonOperationMetadata properties: - customModelType: + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + stateMessage: + description: >- + A message providing more details about the current state of + processing. + type: string + resource: + type: string + description: A related resource to this operation. + state: + description: The state of the operation. + type: string + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. enum: - - CUSTOM_MODEL_TYPE_UNSPECIFIED - - VERSIONED_FOUNDATION - - FINE_TUNED + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + createTime: + description: The creation time of the operation. + format: google-datetime type: string - description: The type of custom model created by the user. + GoogleCloudDocumentaiV1HumanReviewStatus: + type: object + properties: + stateMessage: + description: A message providing more details about the human review state. + type: string + state: + description: The state of human review on the processing request. enumDescriptions: - - The model type is unspecified. - - The model is a versioned foundation model. - - The model is a finetuned foundation model. - baseProcessorVersionId: - description: The base processor version ID for the custom model. + - >- + Human review state is unspecified. Most likely due to an internal + error. + - >- + Human review is skipped for the document. This can happen because + human review isn't enabled on the processor or the processing + request has been set to skip this document. + - >- + Human review validation is triggered and passed, so no review is + needed. + - >- + Human review validation is triggered and the document is under + review. + - >- + Some error happened during triggering human review, see the + state_message for details. type: string - description: >- - Information for a custom Generative AI model created by the user. These - are created with `Create New Version` in either the `Call foundation - model` or `Fine tuning` tabs. - GoogleCloudDocumentaiV1ListProcessorVersionsResponse: + enum: + - STATE_UNSPECIFIED + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR + humanReviewOperation: + description: >- + The name of the operation triggered by the processed document. This + field is populated only when the state is + `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + metadata as the long-running operation returned by ReviewDocument. + type: string + description: The status of human review on a processed document. + id: GoogleCloudDocumentaiV1HumanReviewStatus + GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: + type: object properties: - nextPageToken: + docId: + description: Required. The id of the document. type: string - description: Points to the next processor, otherwise empty. - processorVersions: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - type: array - description: The list of processors. - id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse + description: >- + Identifies a document uniquely within the scope of a dataset in + unmanaged option. + id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + GoogleCloudDocumentaiV1DisableProcessorResponse: + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + id: GoogleCloudDocumentaiV1DisableProcessorResponse type: object - description: Response message for the ListProcessorVersions method. - GoogleCloudDocumentaiV1DisableProcessorMetadata: + properties: {} + GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig: + properties: + chunkingConfig: + description: Optional. Config for chunking in layout parser processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig + type: object + id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig + description: Serving config for layout parser processor. + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + type: object + description: Detected break at the end of a Token. + properties: + type: + enumDescriptions: + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. + type: string + enum: + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN + description: Detected break type. + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata properties: commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' type: object - id: GoogleCloudDocumentaiV1DisableProcessorMetadata - description: The long-running operation metadata for the DisableProcessor method. - GoogleCloudDocumentaiV1ProcessRequest: - id: GoogleCloudDocumentaiV1ProcessRequest + GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: + description: Response of the EvaluateProcessorVersion method. type: object - description: Request message for the ProcessDocument method. + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse properties: - inlineDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: An inline document proto. - skipHumanReview: + evaluation: + description: The resource name of the created evaluation. + type: string + GoogleLongrunningListOperationsResponse: + description: The response message for Operations.ListOperations. + id: GoogleLongrunningListOperationsResponse + type: object + properties: + operations: description: >- - Whether human review should be skipped for this request. Default to - `false`. + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + type: string + description: The standard List next-page token. + GoogleCloudDocumentaiV1OcrConfig: + description: Config for Document OCR. + id: GoogleCloudDocumentaiV1OcrConfig + properties: + computeStyleInfo: + deprecated: true + description: >- + Turn on font identification model and return font style information. + Deprecated, use PremiumFeatures.compute_style_info instead. type: boolean - labels: - additionalProperties: - type: string - type: object + hints: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' + description: Hints for the OCR model. + enableNativePdfParsing: description: >- - Optional. The labels with user-defined metadata for the request. - 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. - imagelessMode: + Enables special handling for PDFs with existing text information. + Results in better text extraction quality in such PDF inputs. + type: boolean + enableSymbol: + type: boolean + description: Includes symbol level OCR information if set to true. + premiumFeatures: + description: Configurations for premium OCR features. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' + disableCharacterBoxesDetection: type: boolean - description: Optional. Option to remove images from the document. - fieldMask: - format: google-fieldmask description: >- - Specifies which fields to include in the ProcessResponse.document - output. Only supports top-level document and pages field, so it must - be in the form of `{document_field_name}` or - `pages.{page_field_name}`. - type: string - processOptions: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - description: Inference-time options for the process API - rawDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' - description: A raw document content (bytes). - gcsDocument: - description: A raw document on Google Cloud Storage. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: - description: Metadata of the batch export documents operation. - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - splitExportStats: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + Turn off character box detector in OCR engine. Character box + detection is enabled by default in OCR 2.0 (and later) processors. + advancedOcrOptions: type: array - description: The list of statistics for each dataset split type. - individualExportStatuses: - description: The list of response details of each document. + description: >- + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: - `legacy_layout`: a heuristics layout + detection algorithm, which serves as an alternative to the current + ML-based layout detection algorithm. Customers can choose the best + suitable layout algorithm based on their situation. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - type: array + type: string + enableImageQualityScores: + description: >- + Enables intelligent document quality scores after OCR. Can help with + diagnosing why OCR responses are of poor quality for a given input. + Adds additional latency comparable to regular OCR to the process + call. + type: boolean type: object - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata - GoogleCloudDocumentaiV1BoundingPoly: - id: GoogleCloudDocumentaiV1BoundingPoly + GoogleCloudDocumentaiV1ListProcessorTypesResponse: + description: Response message for the ListProcessorTypes method. type: object - description: A bounding polygon for the detected image annotation. + id: GoogleCloudDocumentaiV1ListProcessorTypesResponse properties: - vertices: + nextPageToken: + description: Points to the next page, otherwise empty. + type: string + processorTypes: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - type: array - description: The bounding polygon vertices. - normalizedVertices: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' - description: The bounding polygon normalized vertices. - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: - description: The status of each individual document in the batch delete process. - type: object + description: The processor types. + GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: properties: - status: - description: The status of deleting the document in storage. - $ref: '#/components/schemas/GoogleRpcStatus' - documentId: - description: The document id of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - id: >- - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - GoogleCloudDocumentaiV1DocumentPageTable: - id: GoogleCloudDocumentaiV1DocumentPageTable + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. + type: object + GoogleCloudDocumentaiV1beta3DisableProcessorResponse: + type: object + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + properties: {} + id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse + GoogleCloudDocumentaiV1DocumentPageLine: type: object + id: GoogleCloudDocumentaiV1DocumentPageLine properties: - bodyRows: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - type: array - description: Body rows of the table. provenance: deprecated: true - description: The history of this table. + description: The history of this annotation. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - headerRows: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - description: Header rows of the table. - type: array detectedLanguages: - type: array - description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array layout: - description: Layout for Table. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: A table representation similar to HTML table structure. - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + description: Layout for Line. + description: >- + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. + GoogleCloudDocumentaiV1beta3EnableProcessorResponse: + id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + type: object + properties: {} + GoogleCloudDocumentaiV1DeployProcessorVersionResponse: + type: object + properties: {} + id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse + description: Response message for the DeployProcessorVersion method. + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: + type: object + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. properties: - pageFooters: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - type: array - description: Page footers associated with the chunk. - pageSpan: - description: Page span of the chunk. + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - content: - type: string - description: Text content of the chunk. - chunkId: - description: ID of the chunk. + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse + properties: + evaluation: + description: The resource name of the created evaluation. type: string - sourceBlockIds: - type: array - items: - type: string - description: Unused. - pageHeaders: - type: array - description: Page headers associated with the chunk. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - description: Represents a chunk. + description: Response of the EvaluateProcessorVersion method. type: object - GoogleCloudDocumentaiV1DocumentTextChange: - id: GoogleCloudDocumentaiV1DocumentTextChange + GoogleCloudDocumentaiV1Document: + id: GoogleCloudDocumentaiV1Document + description: >- + Document represents the canonical document resource in Document AI. It + is an interchange format that provides insights into documents and + allows for collaboration between users and Document AI to iterate and + optimize for quality. type: object properties: - changedText: + text: + description: Optional. UTF-8 encoded text in reading order from the document. type: string - description: The text that replaces the text identified in the `text_anchor`. - textAnchor: + mimeType: description: >- - Provenance of the correction. Text anchor indexing into the - Document.text. There can only be a single `TextAnchor.text_segments` - element. If the start and end index of the text segment are the - same, the text change is inserted before that index. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - provenance: - description: The history of this annotation. - type: array + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + type: string + chunkedDocument: + description: Document chunked based on chunking config. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' + textStyles: + description: Styles for the Document.text. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + type: array deprecated: true - description: This message is used for text changes aka. OCR corrections. - GoogleCloudDocumentaiV1DocumentPageAnchor: - properties: - pageRefs: + pages: + description: Visual page layout for the Document. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' type: array - description: One or more references to visual page elements + entities: + description: >- + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + shardInfo: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' + description: >- + Information about the sharding if this document is sharded part of a + larger document. If the document is not sharded, this message is not + specified. + entityRelations: + description: Placeholder. Relationship among Document.entities. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + textChanges: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' + description: >- + Placeholder. A list of text corrections made to Document.text. This + is usually used for annotating corrections to OCR mistakes. Text + changes for a given revision may not overlap with each other. + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + uri: + description: >- + Optional. Currently supports Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. + For more information, refer to [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris). + type: string + documentLayout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' + description: Parsed layout of the document. + revisions: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + description: Placeholder. Revision history of this document. + type: array + content: + type: string + format: byte + description: >- + Optional. Inline document content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary + representation, whereas JSON representations use base64. + GoogleCloudDocumentaiV1DisableProcessorMetadata: + type: object + properties: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1DisableProcessorMetadata + description: The long-running operation metadata for the DisableProcessor method. + GoogleCloudDocumentaiV1EnableProcessorResponse: + properties: {} + type: object + id: GoogleCloudDocumentaiV1EnableProcessorResponse description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. - id: GoogleCloudDocumentaiV1DocumentPageAnchor + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + description: Represents the page header associated with the chunk. type: object - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse + properties: + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the header. + text: + type: string + description: Header in text format. + GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment type: object - properties: {} - description: Response message for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: - properties: {} - id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse + properties: + startIndex: + description: TextSegment start UTF-8 char index in the Document.text. + type: string + format: int64 + endIndex: + type: string + format: int64 + description: TextSegment half open end UTF-8 char index in the Document.text. + description: >- + A text segment in the Document.text. The indices may be out of bounds + which indicate that the text extends into another document shard for + large sharded documents. See ShardInfo.text_offset + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: + id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock type: object - description: Response of the import document operation. - GoogleCloudDocumentaiV1DocumentPageBlock: properties: - layout: - description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: - type: array - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this annotation. + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + description: Page span of the block. + blockId: + type: string + description: ID of the block. + tableBlock: + description: Block consisting of table content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + listBlock: + description: Block consisting of list content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + textBlock: + description: Block consisting of text content. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + description: >- + Represents a block. A block could be one of the various types (text, + table, list) supported. + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: + properties: + evaluation: + description: The resource name of the created evaluation. + type: string + description: Response of the EvaluateProcessorVersion method. type: object + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse + GoogleCloudDocumentaiV1EvaluationReference: + properties: + evaluation: + type: string + description: The resource name of the evaluation. + operation: + type: string + description: The resource name of the Long Running Operation for the evaluation. + aggregateMetricsExact: + description: >- + An aggregate of the statistics for the evaluation with fuzzy + matching off. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + aggregateMetrics: + description: >- + An aggregate of the statistics for the evaluation with fuzzy + matching on. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. - id: GoogleCloudDocumentaiV1DocumentPageBlock - GoogleCloudDocumentaiV1beta3BatchProcessMetadata: + Gives a short summary of an evaluation, and links to the evaluation + itself. + type: object + id: GoogleCloudDocumentaiV1EvaluationReference + GoogleCloudDocumentaiUiv1beta3RevisionRef: + id: GoogleCloudDocumentaiUiv1beta3RevisionRef + type: object + description: The revision reference specifies which revision on the document to read. properties: - createTime: - format: google-datetime - description: The creation time of the operation. + latestProcessorVersion: type: string - stateMessage: + description: >- + Reads the revision generated by the processor version. The format + takes the full resource name of processor version. + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + revisionCase: + description: Reads the revision by the predefined case. + enumDescriptions: + - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. + - The latest revision made by a human. + - The latest revision based on timestamp. + - The first (OCR) revision. + type: string + enum: + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION + revisionId: + description: Reads the revision given by the id. type: string + GoogleCloudDocumentaiV1BatchProcessMetadata: + description: The long-running operation metadata for BatchProcessDocuments. + id: GoogleCloudDocumentaiV1BatchProcessMetadata + type: object + properties: + stateMessage: description: >- A message providing more details about the current state of processing. For example, the error message if the operation is failed. - updateTime: - description: The last update time of the operation. type: string + createTime: format: google-datetime + type: string + description: The creation time of the operation. individualProcessStatuses: - description: The list of response details of each document. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + description: The list of response details of each document. + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime state: - description: The state of the current batch processing. enumDescriptions: - The default value. This value is used if the state is omitted. - Request operation is waiting for scheduling. @@ -1209,6 +1340,8 @@ components: - The batch processing was being cancelled. - The batch processing was cancelled. - The batch processing has failed. + type: string + description: The state of the current batch processing. enum: - STATE_UNSPECIFIED - WAITING @@ -1217,1275 +1350,1004 @@ components: - CANCELLING - CANCELLED - FAILED - type: string - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata - type: object - description: The long-running operation metadata for BatchProcessDocuments. - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: type: object - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata - properties: - individualBatchMoveStatuses: + description: >- + Options to control the training of the Custom Document Extraction (CDE) + Processor. + properties: + trainingMethod: + description: Training method to use for CDE training. + type: string + enum: + - TRAINING_METHOD_UNSPECIFIED + - MODEL_BASED + - TEMPLATE_BASED + enumDescriptions: + - '' + - '' + - '' + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + GoogleCloudDocumentaiV1DocumentPageSymbol: + description: A detected symbol. + properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Symbol. + detectedLanguages: type: array - description: The list of response details of each document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - destDatasetType: - type: string - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + id: GoogleCloudDocumentaiV1DocumentPageSymbol + type: object + GoogleCloudDocumentaiV1ReviewDocumentResponse: + properties: + state: enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - description: The destination dataset split type. - deprecated: true - destSplitType: - type: string + - The default value. This value is used if the state is omitted. + - The review operation is rejected by the reviewer. + - The review operation is succeeded. enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - description: The destination dataset split type. - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + - STATE_UNSPECIFIED + - REJECTED + - SUCCEEDED + type: string + description: The state of the review operation. + gcsDestination: + type: string + description: >- + The Cloud Storage uri for the human reviewed document if the review + is succeeded. + rejectionReason: + type: string + description: The reason why the review is rejected by reviewer. + id: GoogleCloudDocumentaiV1ReviewDocumentResponse + description: Response message for the ReviewDocument method. + type: object + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse + description: The response message for the ImportProcessorVersion method. + type: object + properties: + processorVersion: + description: The destination processor version name. + type: string + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: + type: object + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan properties: pageStart: format: int32 - description: Page where chunk starts in the document. type: integer + description: Page where block starts in the document. pageEnd: format: int32 + description: Page where block ends in the document. type: integer - description: Page where chunk ends in the document. + description: Represents where the block starts and ends in the document. + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: type: object - description: Represents where the chunk starts and ends in the document. - GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: - id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + description: Response of the batch move documents operation. + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse + properties: {} + GoogleCloudDocumentaiV1ProcessorVersion: + properties: + googleManaged: + description: >- + Output only. Denotes that this `ProcessorVersion` is managed by + Google. + readOnly: true + type: boolean + state: + readOnly: true + enumDescriptions: + - The processor version is in an unspecified state. + - The processor version is deployed and can be used for processing. + - The processor version is being deployed. + - >- + The processor version is not deployed and cannot be used for + processing. + - The processor version is being undeployed. + - The processor version is being created. + - The processor version is being deleted. + - The processor version failed and is in an indeterminate state. + - The processor version is being imported. + enum: + - STATE_UNSPECIFIED + - DEPLOYED + - DEPLOYING + - UNDEPLOYED + - UNDEPLOYING + - CREATING + - DELETING + - FAILED + - IMPORTING + type: string + description: Output only. The state of the processor version. + kmsKeyName: + type: string + description: The KMS key name used for encryption. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + deprecationInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + description: If set, information about the eventual deprecation of this version. + name: + type: string + description: >- + Identifier. The resource name of the processor version. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + latestEvaluation: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' + description: The most recently invoked evaluation for the processor version. + createTime: + description: The time the processor version was created. + format: google-datetime + type: string + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + modelType: + readOnly: true + description: Output only. The model type of this processor version. + enum: + - MODEL_TYPE_UNSPECIFIED + - MODEL_TYPE_GENERATIVE + - MODEL_TYPE_CUSTOM + enumDescriptions: + - The processor version has unspecified model type. + - The processor version has generative model type. + - The processor version has custom model type. + type: string + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: The schema of the processor version. Describes the output. + displayName: + type: string + description: The display name of the processor version. + kmsKeyVersionName: + type: string + description: The KMS key version with which data is encrypted. + genAiModelInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo + readOnly: true + description: >- + Output only. Information about Generative AI model-based processor + versions. + id: GoogleCloudDocumentaiV1ProcessorVersion + description: >- + A processor version is an implementation of a processor. Each processor + can have multiple versions, pretrained by Google internally or uptrained + by the customer. A processor can only have one default version at a + time. Its document-processing behavior is defined by that version. type: object - description: Evaluations metrics, at a specific confidence level. + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: properties: - metrics: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - description: The metrics at the specific confidence level. - confidenceLevel: - type: number - description: The confidence level. - format: float - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: - id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata + commonMetadata: + description: The basic metadata for the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + type: object + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: type: object - description: Metadata of the import document operation. properties: - importConfigValidationResults: - description: Validation statuses of the batch documents import config. - type: array + splitExportStats: + description: The list of statistics for each dataset split type. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult - totalDocumentCount: - type: integer - description: Total number of the documents that are qualified for importing. - format: int32 - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - individualImportStatuses: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + type: array + individualExportStatuses: + type: array description: The list of response details of each document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus - type: array - GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: - type: object - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata - description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - properties: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1ProcessOptions: - id: GoogleCloudDocumentaiV1ProcessOptions + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: Metadata of the batch export documents operation. + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata + GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: + description: The status of a each individual document in the batch process. + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus properties: - fromEnd: - format: int32 - type: integer - description: Only process certain pages from the end, same as above. - schemaOverride: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: >- - Optional. Override the schema of the ProcessorVersion. Will return - an Invalid Argument error if this field is set when the underlying - ProcessorVersion doesn't support schema override. - layoutConfig: + inputGcsSource: description: >- - Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns - error if set on other processor types. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig - fromStart: + The source of the document, same as the input_gcs_source field in + the request when the batch process started. + type: string + outputGcsDestination: description: >- - Only process certain pages from the start. Process all if the - document has fewer pages. - type: integer - format: int32 - ocrConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfig' + The Cloud Storage output destination (in the request as + DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed + document if it was successful, otherwise empty. + type: string + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status processing the document. + humanReviewOperation: description: >- - Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. - Returns error if set on other processor types. - individualPageSelector: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector - description: Which pages to process (1-indexed). - description: Options for Process API - type: object - GoogleCloudDocumentaiV1BatchProcessResponse: - type: object - id: GoogleCloudDocumentaiV1BatchProcessResponse - description: Response message for BatchProcessDocuments. - properties: {} - GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - properties: {} - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse + The name of the operation triggered by the processed document. If + the human review process isn't triggered, this field will be empty. + It has the same response type and metadata as the long-running + operation returned by the ReviewDocument method. + deprecated: true + type: string + humanReviewStatus: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' + description: The status of human review on the processed document. type: object - GoogleCloudDocumentaiV1ListProcessorTypesResponse: + GoogleCloudDocumentaiV1DocumentPageParagraph: type: object - description: Response message for the ListProcessorTypes method. + description: A collection of lines that a human would perceive as a paragraph. + id: GoogleCloudDocumentaiV1DocumentPageParagraph properties: - processorTypes: - description: The processor types. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Paragraph. + detectedLanguages: type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' - nextPageToken: - type: string - description: Points to the next page, otherwise empty. - id: GoogleCloudDocumentaiV1ListProcessorTypesResponse - GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: - id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + deprecated: true + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata type: object properties: - pages: - description: Optional. Indices of the pages (starting from 1). - type: array + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + errorDocumentCount: + type: integer + format: int32 + description: Total number of documents that failed to be deleted in storage. + totalDocumentCount: + format: int32 + description: Total number of documents deleting from dataset. + type: integer + individualBatchDeleteStatuses: + description: The list of response details of each document. items: - format: int32 - type: integer - description: A list of individual page numbers. - GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: - id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig - type: object - description: Configuration specific to spanner-based indexing. - properties: {} - GoogleCloudDocumentaiV1RawDocument: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + type: array + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument type: object properties: - mimeType: - description: >- - An IANA MIME type (RFC6838) indicating the nature and format of the - content. - type: string - displayName: - type: string - description: >- - The display name of the document, it supports all Unicode characters - except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, - `,` `~`, `=` and `:` are reserved. If not specified, a default ID is - generated. - content: - description: Inline document content. + documentId: + description: An internal identifier for document. type: string - format: byte - id: GoogleCloudDocumentaiV1RawDocument - description: Payload message of raw document content (bytes). - GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: - description: The response for TrainProcessorVersion. - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: type: object - properties: - processorVersion: - description: The resource name of the processor version produced by training. - type: string - GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: - id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata + description: The metadata proto of `ResyncDataset` method. properties: commonMetadata: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - description: The long-running operation metadata for the DeleteProcessor method. - type: object - GoogleCloudDocumentaiV1DocumentRevision: - properties: - createTime: - format: google-datetime - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - type: string - humanReview: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - description: Human Review information of this revision. - agent: - type: string + datasetResyncStatuses: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus description: >- - If the change was made by a person specify the name or id of that - person. - parent: + The list of dataset resync statuses. Not checked when + ResyncDatasetRequest.dataset_documents is specified. + type: array + individualDocumentResyncStatuses: description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - deprecated: true - items: - type: integer - format: int32 + The list of document resync statuses. The same document could have + multiple `individual_document_resync_statuses` if it has multiple + inconsistencies. type: array - parentIds: items: - type: string - type: array - description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. - id: - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - type: string - processor: - description: >- - If the annotation was made by processor identify the processor by - its resource name. - type: string - description: Contains past or forward revisions of this document. - id: GoogleCloudDocumentaiV1DocumentRevision - type: object - GoogleCloudDocumentaiV1ReviewDocumentResponse: - description: Response message for the ReviewDocument method. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata + GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: type: object - properties: - rejectionReason: - description: The reason why the review is rejected by reviewer. - type: string - gcsDestination: - description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. - type: string - state: - enumDescriptions: - - The default value. This value is used if the state is omitted. - - The review operation is rejected by the reviewer. - - The review operation is succeeded. - type: string - description: The state of the review operation. - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - id: GoogleCloudDocumentaiV1ReviewDocumentResponse - GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata properties: commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: + properties: {} + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse type: object - GoogleCloudDocumentaiV1DocumentProvenance: - properties: - type: - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - type: string - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - description: The type of provenance operation. - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. - id: - format: int32 - deprecated: true - type: integer - description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - revision: - deprecated: true - description: The index of the revision that produced this element. - type: integer - format: int32 - parents: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent - type: array - description: References to the original elements that are replaced. + description: Response message for the UndeployProcessorVersion method. + GoogleCloudDocumentaiV1DeployProcessorVersionRequest: type: object - description: >- - Structure to identify provenance relationships between annotations in - different revisions. - id: GoogleCloudDocumentaiV1DocumentProvenance - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: + properties: {} + id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest + description: Request message for the DeployProcessorVersion method. + GoogleCloudDocumentaiV1DocumentStyleFontSize: type: object - description: The metadata that represents a processor version being created. - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - testDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - trainingDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: The training dataset validation information. - GoogleCloudDocumentaiV1ReviewDocumentRequest: - description: Request message for the ReviewDocument method. + id: GoogleCloudDocumentaiV1DocumentStyleFontSize properties: - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: The document schema of the human review task. - enableSchemaValidation: - type: boolean + unit: description: >- - Whether the validation should be performed on the ad-hoc review - request. - inlineDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: An inline document proto. - priority: - enumDescriptions: - - The default priority level. - - >- - The urgent priority level. The labeling manager should allocate - labeler resource to the urgent task queue to respect this priority - level. - description: The priority of the human review task. + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). type: string - enum: - - DEFAULT - - URGENT - id: GoogleCloudDocumentaiV1ReviewDocumentRequest + size: + format: float + type: number + description: Font size for the text. + description: Font size with unit. + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: + description: The sharding config for the output document. type: object - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: - description: Represents a text type block. + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig properties: - blocks: + pagesPerShard: + format: int32 + description: The number of pages per shard. + type: integer + pagesOverlap: + description: The number of overlapping pages between consecutive shards. + format: int32 + type: integer + GoogleCloudDocumentaiV1DocumentSchema: + properties: + displayName: + type: string + description: Display name to show to users. + metadata: + description: Metadata of the schema. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' + entityTypes: type: array + description: Entity types of the schema. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - description: >- - A text block could further have child blocks. Repeated blocks - support further hierarchies and nested blocks. - text: - description: Text content stored in the block. - type: string - type: + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType + description: type: string - description: >- - Type of the text in the block. Available options are: `paragraph`, - `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, - `heading-5`, `header`, `footer`. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - type: object - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: - description: Response message for the DeployProcessorVersion method. + description: Description of the schema. + description: The schema defines the output of the processed document by a processor. type: object - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse - properties: {} - GoogleCloudDocumentaiV1DocumentSchemaEntityType: + id: GoogleCloudDocumentaiV1DocumentSchema + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: + description: Defines properties that can be part of the entity type. properties: - properties: - type: array - description: Description the nested structure, or composition of an entity. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - displayName: + valueType: type: string - description: User defined name for the type. - enumValues: description: >- - If specified, lists all the possible values for this entity. This - should not be more than a handful of values. If the number of values - is >10 or could change frequently use the - `EntityType.value_ontology` field and specify a list of all possible - values in a value ontology file. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues + A reference to the value type of the property. This type is subject + to the same conventions as the `Entity.base_types` field. + displayName: + description: User defined name for the property. + type: string name: description: >- - Name of the type. It must be unique within the schema file and - cannot be a "Common Type". The following naming conventions are - used: - Use `snake_casing`. - Name matching is case-sensitive. - - Maximum 64 characters. - Must start with a letter. - Allowed - characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility - internal infrastructure and tooling can handle any ascii character.) - - The `/` is sometimes used to denote a property of a type. For - example `line_item/amount`. This convention is deprecated, but will - still be honored for backward compatibility. + The name of the property. Follows the same guidelines as the + EntityType name. type: string - baseTypes: + occurrenceType: + type: string + enumDescriptions: + - Unspecified occurrence type. + - >- + There will be zero or one instance of this entity type. The same + entity instance may be mentioned multiple times. + - The entity type will appear zero or multiple times. + - >- + The entity type will only appear exactly once. The same entity + instance may be mentioned multiple times. + - The entity type will appear once or more times. description: >- - The entity type that this type is derived from. For now, one and - only one should be set. - type: array - items: - type: string - description: >- - EntityType is the wrapper of a label of the corresponding model with - detailed attributes and limitations for entity-based processors. - Multiple types can also compose a dependency tree to represent nested - types. - type: object - id: GoogleCloudDocumentaiV1DocumentSchemaEntityType - GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: - description: The response message for the ImportProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse + Occurrence type limits the number of instances an entity type + appears in the document. + enum: + - OCCURRENCE_TYPE_UNSPECIFIED + - OPTIONAL_ONCE + - OPTIONAL_MULTIPLE + - REQUIRED_ONCE + - REQUIRED_MULTIPLE type: object + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + description: The status of each individual document in the batch delete process. properties: - processorVersion: - type: string - description: The destination processor version name. - GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + description: The document id of the document. + status: + description: The status of deleting the document in storage. + $ref: '#/components/schemas/GoogleRpcStatus' + id: >- + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus type: object + GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata - description: The long-running operation metadata for the DeleteProcessor method. - GoogleLongrunningOperation: - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object - properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - metadata: - type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + gcsUri: + description: Required. The Cloud Storage URI where the actual document is stored. type: string - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - id: GoogleLongrunningOperation - GoogleCloudDocumentaiV1DocumentPageMatrix: - properties: - rows: - description: Number of rows in the matrix. - format: int32 - type: integer - cols: - type: integer - format: int32 - description: Number of columns in the matrix. - data: - format: byte + cwDocId: + deprecated: true + description: Id of the document (indexed) managed by Content Warehouse. type: string - description: The matrix data. - type: - description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - type: integer - format: int32 + description: >- + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. + id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId type: object + GoogleCloudDocumentaiV1DocumentShardInfo: + id: GoogleCloudDocumentaiV1DocumentShardInfo description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. - id: GoogleCloudDocumentaiV1DocumentPageMatrix - GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: + For a large document, sharding may be performed to produce several + document shards. Each document shard contains this field to detail which + shard it is. + type: object properties: - gcsDestination: + shardCount: + format: int64 type: string - description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. - state: - description: The state of the review operation. - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED + description: Total number of shards. + textOffset: type: string - enumDescriptions: - - The default value. This value is used if the state is omitted. - - The review operation is rejected by the reviewer. - - The review operation is succeeded. - rejectionReason: - description: The reason why the review is rejected by reviewer. + format: int64 + description: >- + The index of the first character in Document.text in the overall + document global text. + shardIndex: type: string - type: object - description: Response message for the ReviewDocument method. - id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse - GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: + description: The 0-based index of this shard. + format: int64 + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: properties: - datasetErrorCount: - format: int32 - description: The total number of dataset errors. - type: integer - documentErrors: - description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - documentErrorCount: - type: integer - description: The total number of document errors. - format: int32 - datasetErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - type: array - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. + status: + description: The status of updating the document in storage. + $ref: '#/components/schemas/GoogleRpcStatus' + documentId: + description: The document id of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The status of each individual document in the batch update process. type: object - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata - description: Metadata of the auto-labeling documents operation. + id: >- + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata type: object properties: + individualBatchUpdateStatuses: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + description: The list of response details of each document. commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - totalDocumentCount: - type: integer - format: int32 - description: Total number of the auto-labeling documents. - individualAutoLabelStatuses: + GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: + type: object + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. + properties: + testDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: The test dataset validation information. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + trainingDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: The training dataset validation information. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: + properties: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the importing of the document. + outputGcsDestination: + description: >- + The output_gcs_destination of the processed document if it was + successful, otherwise empty. + type: string + outputDocumentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: >- + The document id of imported document if it was successful, otherwise + empty. + inputGcsSource: + description: The source Cloud Storage URI of the document. + type: string + id: >- + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + type: object + description: The status of each individual document in the import process. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + type: object + description: Represents a table type block. + properties: + bodyRows: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Body rows containing main table content. type: array + caption: + type: string + description: Table caption/title. + headerRows: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - description: >- - The list of individual auto-labeling statuses of the dataset - documents. - GoogleCloudDocumentaiV1DocumentPageLayout: + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Header rows at the top of the table. + type: array + GoogleCloudDocumentaiV1Barcode: type: object - id: GoogleCloudDocumentaiV1DocumentPageLayout properties: - orientation: + format: type: string - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - enumDescriptions: - - Unspecified orientation. - - Orientation is aligned with page up. - - >- - Orientation is aligned with page right. Turn the head 90 degrees - clockwise from upright to read. - - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. - - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - description: Detected orientation for the Layout. - textAnchor: - description: Text anchor indexing into the Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - boundingPoly: - description: The bounding polygon for the Layout. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - confidence: description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. + Format of a barcode. The supported formats are: - `CODE_128`: Code + 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - + `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - + `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - + `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E + type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - + `DATABAR`: GS1 DataBar code type. + valueFormat: + type: string + description: >- + Value format describes the format of the value that a barcode + encodes. The supported formats are: - `CONTACT_INFO`: Contact + information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - + `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - + `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi + information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar + event. - `DRIVER_LICENSE`: Driver's license. + rawValue: + type: string + description: >- + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + id: GoogleCloudDocumentaiV1Barcode + description: Encodes the detailed information of a barcode. + GoogleCloudDocumentaiV1DocumentPageDimension: + properties: + width: + description: Page width. format: float type: number - description: Visual element describing a layout unit on a page. - GoogleCloudDocumentaiV1DeployProcessorVersionResponse: - properties: {} - description: Response message for the DeployProcessorVersion method. - type: object - id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse - GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: - type: object - description: Information about the upcoming deprecation of this processor version. - id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo - properties: - replacementProcessorVersion: - description: If set, the processor version that will be used as a replacement. - type: string - deprecationTime: - description: The time at which this processor version will be deprecated. - format: google-datetime + unit: + description: Dimension unit. type: string - GoogleCloudDocumentaiV1DisableProcessorRequest: + height: + description: Page height. + format: float + type: number + id: GoogleCloudDocumentaiV1DocumentPageDimension type: object - id: GoogleCloudDocumentaiV1DisableProcessorRequest - properties: {} - description: Request message for the DisableProcessor method. - GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: - properties: {} - description: Response message for the UndeployProcessorVersion method. + description: Dimension for the page. + GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: + description: The long-running operation metadata for the DeleteProcessor method. type: object - id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse - GoogleCloudDocumentaiV1DisableProcessorResponse: + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + description: The status of each individual document in the batch delete process. type: object - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - properties: {} - id: GoogleCloudDocumentaiV1DisableProcessorResponse - GoogleCloudDocumentaiV1DocumentDocumentLayout: - description: >- - Represents the parsed layout of a document as a collection of blocks - that the document is divided into. - id: GoogleCloudDocumentaiV1DocumentDocumentLayout + id: >- + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus properties: - blocks: - type: array - description: List of blocks in the document. + status: + description: The status of deleting the document in storage. + $ref: '#/components/schemas/GoogleRpcStatus' + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document id of the document. + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + errorDocumentCount: + description: Total number of documents that failed to be deleted in storage. + format: int32 + type: integer + individualBatchDeleteStatuses: + description: The list of response details of each document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - type: object - GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + type: array + totalDocumentCount: + description: Total number of documents deleting from dataset. + type: integer + format: int32 + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata type: object - description: Response message for the SetDefaultProcessorVersion method. - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse - properties: {} - GoogleCloudDocumentaiV1DocumentPageVisualElement: - id: GoogleCloudDocumentaiV1DocumentPageVisualElement - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: type: object properties: - type: - description: Type of the VisualElement. - type: string - layout: - description: Layout for VisualElement. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: - description: A list of detected languages together with confidence. + sampleTrainingStatus: + description: The status of sampling documents in training split. + $ref: '#/components/schemas/GoogleRpcStatus' + selectedDocuments: + description: The result of the sampling process. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument type: array - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: + sampleTestStatus: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of sampling documents in test split. + description: Response of the sample documents operation. + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse + GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse + properties: {} + type: object + description: Response message for the DeployProcessorVersion method. + GoogleCloudDocumentaiV1ProcessorVersionAlias: + id: GoogleCloudDocumentaiV1ProcessorVersionAlias + type: object properties: - individualImportStatuses: + processorVersion: + type: string + description: The resource name of aliased processor version. + alias: + type: string + description: The alias in the form of `processor_version` resource name. + description: Contains the alias and the aliased resource name of processor version. + GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + type: object + properties: + datasetErrors: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. type: array - description: The list of response details of each document. - importConfigValidationResults: + documentErrorCount: + description: The total number of document errors. + type: integer + format: int32 + documentErrors: + description: >- + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. type: array - description: Validation statuses of the batch documents import config. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - totalDocumentCount: + $ref: '#/components/schemas/GoogleRpcStatus' + datasetErrorCount: + description: The total number of dataset errors. format: int32 - description: Total number of the documents that are qualified for importing. type: integer + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: + description: Response of the delete documents operation. + properties: {} + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse + type: object + GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. + GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: + id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse + type: object + properties: {} + description: Response message for the UndeployProcessorVersion method. + GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: + description: The long-running operation metadata for the DisableProcessor method. + properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - description: Metadata of the import document operation. - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata type: object - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse - type: object - properties: {} - description: Response of the delete documents operation. - GoogleCloudDocumentaiV1ProcessorVersionAlias: - description: Contains the alias and the aliased resource name of processor version. + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata + GoogleTypeTimeZone: type: object + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). + id: GoogleTypeTimeZone properties: - alias: + id: type: string - description: The alias in the form of `processor_version` resource name. - processorVersion: + description: IANA Time Zone Database time zone, e.g. "America/New_York". + version: + description: Optional. IANA Time Zone Database version number, e.g. "2019a". type: string - description: The resource name of aliased processor version. - id: GoogleCloudDocumentaiV1ProcessorVersionAlias - GoogleCloudDocumentaiV1OcrConfig: - description: Config for Document OCR. - id: GoogleCloudDocumentaiV1OcrConfig + GoogleCloudDocumentaiV1DocumentTextChange: + id: GoogleCloudDocumentaiV1DocumentTextChange + description: This message is used for text changes aka. OCR corrections. properties: - disableCharacterBoxesDetection: - description: >- - Turn off character box detector in OCR engine. Character box - detection is enabled by default in OCR 2.0 (and later) processors. - type: boolean - premiumFeatures: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' - description: Configurations for premium OCR features. - enableImageQualityScores: - description: >- - Enables intelligent document quality scores after OCR. Can help with - diagnosing why OCR responses are of poor quality for a given input. - Adds additional latency comparable to regular OCR to the process - call. - type: boolean - computeStyleInfo: - type: boolean - description: >- - Turn on font identification model and return font style information. - Deprecated, use PremiumFeatures.compute_style_info instead. - deprecated: true - hints: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' - description: Hints for the OCR model. - enableNativePdfParsing: - type: boolean - description: >- - Enables special handling for PDFs with existing text information. - Results in better text extraction quality in such PDF inputs. - enableSymbol: - description: Includes symbol level OCR information if set to true. - type: boolean - advancedOcrOptions: - type: array + textAnchor: description: >- - A list of advanced OCR options to further fine-tune OCR behavior. - Current valid values are: - `legacy_layout`: a heuristics layout - detection algorithm, which serves as an alternative to the current - ML-based layout detection algorithm. Customers can choose the best - suitable layout algorithm based on their situation. + Provenance of the correction. Text anchor indexing into the + Document.text. There can only be a single `TextAnchor.text_segments` + element. If the start and end index of the text segment are the + same, the text change is inserted before that index. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + provenance: + description: The history of this annotation. items: - type: string - type: object - GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: - description: Response of the import document operation. - properties: {} - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse - type: object - GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: - id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId - properties: - gcsUri: - type: string - description: Required. The Cloud Storage URI where the actual document is stored. - cwDocId: - description: Id of the document (indexed) managed by Content Warehouse. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' deprecated: true + type: array + changedText: + description: The text that replaces the text identified in the `text_anchor`. type: string type: object - description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. - GoogleCloudDocumentaiV1beta3GcsPrefix: - id: GoogleCloudDocumentaiV1beta3GcsPrefix - properties: - gcsUriPrefix: - type: string - description: The URI prefix. - description: Specifies all documents on Cloud Storage with a common prefix. + GoogleCloudDocumentaiV1ProcessRequest: + id: GoogleCloudDocumentaiV1ProcessRequest + description: Request message for the ProcessDocument method. type: object - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: properties: - shardingConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - description: Specifies the sharding config for the output document. - gcsUri: - description: The Cloud Storage uri (a directory) of the output. - type: string + inlineDocument: + description: An inline document proto. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + skipHumanReview: + description: >- + Whether human review should be skipped for this request. Default to + `false`. + type: boolean + rawDocument: + description: A raw document content (bytes). + $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' + labels: + description: >- + Optional. The labels with user-defined metadata for the request. + 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. + additionalProperties: + type: string + type: object + processOptions: + description: Inference-time options for the process API + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + imagelessMode: + description: Optional. Option to remove images from the document. + type: boolean + gcsDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + description: A raw document on Google Cloud Storage. fieldMask: format: google-fieldmask type: string description: >- - Specifies which fields to include in the output documents. Only - supports top level document and pages field so it must be in the - form of `{document_field_name}` or `pages.{page_field_name}`. - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig - description: The configuration used when outputting documents. - type: object - GoogleCloudDocumentaiV1DocumentPage: + Specifies which fields to include in the ProcessResponse.document + output. Only supports top-level document and pages field, so it must + be in the form of `{document_field_name}` or + `pages.{page_field_name}`. + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + description: A detected barcode. type: object - description: A page in a Document. properties: - imageQualityScores: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - description: Image quality scores. - detectedBarcodes: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - description: A list of detected barcodes. - provenance: - deprecated: true - description: The history of this page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - formFields: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - description: A list of visually detected form fields on the page. - type: array - tokens: - description: A list of visually detected tokens on the page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - blocks: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' - type: array - description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. - transforms: - description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' - type: array - pageNumber: - format: int32 - description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - type: integer + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for DetectedBarcode. + barcode: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + description: Detailed barcode information of the DetectedBarcode. + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + GoogleCloudDocumentaiV1DocumentPageVisualElement: + properties: + type: + type: string + description: Type of the VisualElement. detectedLanguages: description: A list of detected languages together with confidence. type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - lines: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' - type: array - description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. - tables: - type: array - description: A list of visually detected tables on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - image: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' - description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - paragraphs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. layout: - description: Layout for the page. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - symbols: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - description: A list of visually detected symbols on the page. - type: array - visualElements: - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - type: array - dimension: - description: Physical dimension of the page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - id: GoogleCloudDocumentaiV1DocumentPage - GoogleCloudDocumentaiV1DocumentStyle: + description: Layout for VisualElement. + type: object + id: GoogleCloudDocumentaiV1DocumentPageVisualElement description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. - id: GoogleCloudDocumentaiV1DocumentStyle + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: + id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata + type: object + description: The long-running operation metadata for the DisableProcessor method. properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - color: - description: Text color. - $ref: '#/components/schemas/GoogleTypeColor' - fontSize: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' - description: Font size. - textDecoration: - description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - type: string - textStyle: - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - type: string - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - fontWeight: - type: string - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - fontFamily: - type: string - description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - type: object - GoogleCloudDocumentaiV1FetchProcessorTypesResponse: - type: object + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata properties: - processorTypes: - type: array - description: The list of processor types. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' - id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse - description: Response message for the FetchProcessorTypes method. - GoogleCloudLocationListLocationsResponse: - description: The response message for Locations.ListLocations. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + type: object + description: Metadata of the EvaluateProcessorVersion method. + GoogleCloudDocumentaiV1TrainProcessorVersionRequest: properties: - nextPageToken: + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: Optional. The schema the processor version will be trained with. + customDocumentExtractionOptions: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + description: Options to control Custom Document Extraction (CDE) Processor. + foundationModelTuningOptions: + description: Options to control foundation model tuning of a processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions + processorVersion: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + description: Required. The processor version to be created. + baseProcessorVersion: type: string - description: The standard List next-page token. - locations: - items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' description: >- - A list of locations that matches the specified filter in the - request. - type: array + Optional. The processor version to use as a base for training. This + processor version must be a child of `parent`. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. + inputData: + description: Optional. The input data used to train the ProcessorVersion. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest + description: Request message for the TrainProcessorVersion method. type: object - id: GoogleCloudLocationListLocationsResponse - GoogleCloudDocumentaiV1beta3Dataset: + GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: properties: - documentWarehouseConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - description: >- - Optional. Deprecated. Warehouse-based dataset configuration is not - supported. - deprecated: true - gcsManagedConfig: + stateMessage: description: >- - Optional. User-managed Cloud Storage dataset configuration. Use this - configuration if the dataset documents are stored under a - user-managed Cloud Storage location. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig - name: + A message providing more details about the current state of + processing. type: string - description: >- - Dataset resource name. Format: - `projects/{project}/locations/{location}/processors/{processor}/dataset` + updateTime: + format: google-datetime + type: string + description: The last update time of the operation. + resource: + type: string + description: A related resource to this operation. + createTime: + type: string + description: The creation time of the operation. + format: google-datetime state: - enumDescriptions: - - Default unspecified enum, should not be used. - - Dataset has not been initialized. - - Dataset is being initialized. - - Dataset has been initialized. - description: Required. State of the dataset. Ignored when updating dataset. type: string + description: The state of the operation. + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. enum: - STATE_UNSPECIFIED - - UNINITIALIZED - - INITIALIZING - - INITIALIZED - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - satisfiesPzs: - description: Output only. Reserved for future use. - type: boolean - readOnly: true - spannerIndexingConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig - description: >- - Optional. A lightweight indexing source with low latency and high - reliability, but lacking advanced features like CMEK and - content-based search. - unmanagedDatasetConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - description: >- - Optional. Unmanaged dataset configuration. Use this configuration if - the dataset documents are managed by the document service internally - (not user-managed). - description: >- - A singleton resource under a Processor which configures a collection of - documents. - id: GoogleCloudDocumentaiV1beta3Dataset - type: object - GoogleCloudDocumentaiV1DocumentPageDimension: - id: GoogleCloudDocumentaiV1DocumentPageDimension - type: object - properties: - height: - type: number - description: Page height. - format: float - unit: - type: string - description: Dimension unit. - width: - format: float - type: number - description: Page width. - description: Dimension for the page. - GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig: + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED type: object - id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig - description: Serving config for chunking. - properties: - chunkSize: - type: integer - description: >- - Optional. The chunk sizes to use when splitting documents, in order - of level. - format: int32 - includeAncestorHeadings: - type: boolean - description: >- - Optional. Whether or not to include ancestor headings when - splitting. - GoogleCloudDocumentaiV1DocumentPageTableTableCell: + description: The common metadata for long running operations. + id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: properties: - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - layout: - description: Layout for TableCell. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' rowSpan: + type: integer format: int32 description: How many rows this cell spans. - type: integer colSpan: type: integer description: How many columns this cell spans. format: int32 + blocks: + description: >- + A table cell is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock type: object - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell - description: A cell representation inside the table. - GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: Metadata of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: - description: Response message for the SetDefaultProcessorVersion method. - properties: {} - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse - type: object - GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: - description: Metadata of the sample documents operation. - type: object - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + description: Represents a cell in a table row. + GoogleCloudDocumentaiV1beta3BatchProcessMetadata: + description: The long-running operation metadata for BatchProcessDocuments. + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: - properties: {} - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse - description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. - type: object - GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: - properties: - gcsPrefix: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' - description: >- - Required. The Cloud Storage URI (a directory) where the documents - belonging to the dataset must be stored. - type: object - id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig - description: Configuration specific to the Cloud Storage-based implementation. - GoogleCloudDocumentaiV1Barcode: - id: GoogleCloudDocumentaiV1Barcode - description: Encodes the detailed information of a barcode. - type: object - properties: - valueFormat: - type: string - description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - rawValue: - description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - type: string - format: - type: string - description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. - GoogleCloudDocumentaiV1beta3CommonOperationMetadata: - description: The common metadata for long running operations. - properties: - resource: + state: + description: The state of the current batch processing. + enum: + - STATE_UNSPECIFIED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLING + - CANCELLED + - FAILED + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was being cancelled. + - The batch processing was cancelled. + - The batch processing has failed. type: string - description: A related resource to this operation. - createTime: - description: The creation time of the operation. + updateTime: format: google-datetime type: string + description: The last update time of the operation. + individualProcessStatuses: + description: The list of response details of each document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + type: array stateMessage: type: string description: >- A message providing more details about the current state of - processing. - updateTime: - format: google-datetime + processing. For example, the error message if the operation is + failed. + createTime: type: string - description: The last update time of the operation. + description: The creation time of the operation. + format: google-datetime + type: object + GoogleCloudDocumentaiV1beta3CommonOperationMetadata: + properties: state: - description: The state of the operation. + type: string enumDescriptions: - Unspecified state. - Operation is still running. @@ -2493,7 +2355,6 @@ components: - Operation succeeded. - Operation failed. - Operation is cancelled. - type: string enum: - STATE_UNSPECIFIED - RUNNING @@ -2501,1381 +2362,1519 @@ components: - SUCCEEDED - FAILED - CANCELLED - type: object + description: The state of the operation. + createTime: + format: google-datetime + type: string + description: The creation time of the operation. + stateMessage: + type: string + description: >- + A message providing more details about the current state of + processing. + resource: + description: A related resource to this operation. + type: string + updateTime: + format: google-datetime + description: The last update time of the operation. + type: string + description: The common metadata for long running operations. id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1DocumentEntity: - id: GoogleCloudDocumentaiV1DocumentEntity type: object - description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. + GoogleCloudDocumentaiV1DocumentSchemaEntityType: properties: - redacted: + enumValues: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - type: boolean - id: + If specified, lists all the possible values for this entity. This + should not be more than a handful of values. If the number of values + is >10 or could change frequently use the + `EntityType.value_ontology` field and specify a list of all possible + values in a value ontology file. + displayName: + description: User defined name for the type. type: string + name: description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - mentionText: - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - type: string - mentionId: + Name of the type. It must be unique within the schema file and + cannot be a "Common Type". The following naming conventions are + used: - Use `snake_casing`. - Name matching is case-sensitive. - + Maximum 64 characters. - Must start with a letter. - Allowed + characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility + internal infrastructure and tooling can handle any ascii character.) + - The `/` is sometimes used to denote a property of a type. For + example `line_item/amount`. This convention is deprecated, but will + still be honored for backward compatibility. type: string - description: Optional. Deprecated. Use `id` field instead. properties: - description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + description: Description the nested structure, or composition of an entity. type: array - type: - type: string - description: Required. Entity type from a schema e.g. `Address`. - provenance: - description: Optional. The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - confidence: - type: number - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - format: float - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - normalizedValue: + baseTypes: description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: + The entity type that this type is derived from. For now, one and + only one should be set. + type: array + items: + type: string type: object + description: >- + EntityType is the wrapper of a label of the corresponding model with + detailed attributes and limitations for entity-based processors. + Multiple types can also compose a dependency tree to represent nested + types. + id: GoogleCloudDocumentaiV1DocumentSchemaEntityType + GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: + id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + type: object + description: Information about the upcoming deprecation of this processor version. properties: - status: - description: The status of moving the document. - $ref: '#/components/schemas/GoogleRpcStatus' - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. - description: The status of each individual document in the batch move process. - id: >- - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: + replacementProcessorVersion: + description: If set, the processor version that will be used as a replacement. + type: string + deprecationTime: + description: The time at which this processor version will be deprecated. + type: string + format: google-datetime + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. properties: commonMetadata: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata - type: object - GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig: - properties: - chunkingConfig: - description: Optional. Config for chunking in layout parser processor. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig - id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig - description: Serving config for layout parser processor. - type: object - GoogleTypeTimeZone: type: object - id: GoogleTypeTimeZone - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - properties: - version: - description: Optional. IANA Time Zone Database version number, e.g. "2019a". - type: string - id: - type: string - description: IANA Time Zone Database time zone, e.g. "America/New_York". - GoogleTypePostalAddress: + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata + GoogleCloudDocumentaiV1DocumentPageLayout: type: object properties: - languageCode: + confidence: + type: number description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + Confidence of the current Layout within context of the object this + layout is for. e.g. confidence can be for a single token, a table, a + visual element, etc. depending on context. Range `[0, 1]`. + format: float + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + orientation: + description: Detected orientation for the Layout. type: string - addressLines: - type: array - items: - type: string - description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). - organization: + enumDescriptions: + - Unspecified orientation. + - Orientation is aligned with page up. + - >- + Orientation is aligned with page right. Turn the head 90 degrees + clockwise from upright to read. + - >- + Orientation is aligned with page down. Turn the head 180 degrees + from upright to read. + - >- + Orientation is aligned with page left. Turn the head 90 degrees + counterclockwise from upright to read. + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + boundingPoly: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + description: The bounding polygon for the Layout. + id: GoogleCloudDocumentaiV1DocumentPageLayout + description: Visual element describing a layout unit on a page. + GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: + description: >- + The long-running operation metadata for updating the human review + configuration. + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + type: object + id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + GoogleTypeMoney: + type: object + properties: + currencyCode: type: string - description: Optional. The name of the organization at the address. - revision: + description: The three-letter currency code defined in ISO 4217. + units: + format: int64 description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - format: int32 - type: integer - administrativeArea: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string + nanos: description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. - locality: + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + description: Represents an amount of money with its currency type. + id: GoogleTypeMoney + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: + id: >- + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + type: object + properties: + documentErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - type: string - postalCode: - type: string + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + datasetErrorCount: + format: int32 + description: The total number of dataset errors. + type: integer + datasetErrors: description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). - sublocality: + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + documentErrorCount: + description: The total number of document errors. + type: integer + format: int32 + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: + properties: + docId: + description: Required. The id of the document. type: string + id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + type: object + description: >- + Identifies a document uniquely within the scope of a dataset in + unmanaged option. + GoogleTypeDate: + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + id: GoogleTypeDate + properties: + day: description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - regionCode: - type: string + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + year: + format: int32 description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. - sortingCode: + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + month: + format: int32 + type: integer description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + description: Represents a list type block. + properties: + type: type: string - recipients: description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. + Type of the list_entries (if exist). Available options are `ordered` + and `unordered`. + listEntries: + description: List entries that constitute a list block. items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry type: array - id: GoogleTypePostalAddress - description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - GoogleCloudDocumentaiV1TrainProcessorVersionRequest: - description: Request message for the TrainProcessorVersion method. type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: + type: object + description: Represents an entry in the list. properties: - foundationModelTuningOptions: - description: Options to control foundation model tuning of a processor. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions - customDocumentExtractionOptions: - description: Options to control Custom Document Extraction (CDE) Processor. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions - inputData: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - description: Optional. The input data used to train the ProcessorVersion. - processorVersion: - description: Required. The processor version to be created. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - documentSchema: - description: Optional. The schema the processor version will be trained with. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - baseProcessorVersion: - description: >- - Optional. The processor version to use as a base for training. This - processor version must be a child of `parent`. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. - type: string - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - properties: - stateMessage: - type: string - description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - state: - type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview - type: object - description: Human Review information of the document. - GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: - description: Response message for the DeployProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse - properties: {} - type: object - GoogleCloudDocumentaiUiv1beta3DocumentId: - id: GoogleCloudDocumentaiUiv1beta3DocumentId - properties: - gcsManagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - description: A document id within user-managed Cloud Storage. - unmanagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId - description: A document id within unmanaged dataset. - revisionRef: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' - description: Points to a specific revision of the document if set. - type: object - description: Document Identifier. - GoogleCloudDocumentaiV1beta3BatchProcessResponse: - type: object - properties: {} - description: Response message for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1beta3BatchProcessResponse - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: - properties: - learningRateMultiplier: - format: float - type: number - description: >- - Optional. The multiplier to apply to the recommended learning rate. - Valid values are between 0.1 and 10. If not provided, recommended - learning rate will be used. - trainSteps: - format: int32 + blocks: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + type: array description: >- - Optional. The number of steps to run for model tuning. Valid values - are between 1 and 400. If not provided, recommended steps will be - used. - type: integer + A list entry is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions - description: Options to control foundation model tuning of the processor. - type: object - GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: + description: Metadata of the EvaluateProcessorVersion method. type: object - description: The long-running operation metadata for the ReviewDocument method. - id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata properties: commonMetadata: $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. - questionId: - type: string - description: The Crowd Compute question ID. - GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata + GoogleCloudDocumentaiV1DocumentPageBlock: properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - createTime: - format: google-datetime - type: string - description: The creation time of the operation. - stateMessage: - type: string + layout: + description: Layout for Block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + detectedLanguages: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + id: GoogleCloudDocumentaiV1DocumentPageBlock + type: object + description: >- + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. + GoogleCloudDocumentaiV1beta3HumanReviewStatus: + id: GoogleCloudDocumentaiV1beta3HumanReviewStatus + properties: + humanReviewOperation: description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - updateTime: - description: The last update time of the operation. + The name of the operation triggered by the processed document. This + field is populated only when the state is + `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + metadata as the long-running operation returned by ReviewDocument. type: string - format: google-datetime state: + enumDescriptions: + - >- + Human review state is unspecified. Most likely due to an internal + error. + - >- + Human review is skipped for the document. This can happen because + human review isn't enabled on the processor or the processing + request has been set to skip this document. + - >- + Human review validation is triggered and passed, so no review is + needed. + - >- + Human review validation is triggered and the document is under + review. + - >- + Some error happened during triggering human review, see the + state_message for details. enum: - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR type: string - description: Used only when Operation.done is false. - questionId: - description: The Crowd Compute question ID. + description: The state of human review on the processing request. + stateMessage: type: string - description: The long-running operation metadata for the ReviewDocument method. - id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + description: A message providing more details about the human review state. + description: The status of human review on a processed document. type: object - GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + GoogleCloudDocumentaiV1EnableProcessorRequest: + description: Request message for the EnableProcessor method. + type: object + properties: {} + id: GoogleCloudDocumentaiV1EnableProcessorRequest + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo: + id: GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo type: object - description: The long-running operation metadata for the EnableProcessor method. properties: - commonMetadata: + foundationGenAiModelInfo: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues - description: Defines the a list of enum values. + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + description: Information for a pretrained Google-managed foundation model. + customGenAiModelInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + description: Information for a custom Generative AI model created by the user. + description: Information about Generative AI model-based processor versions. + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: + properties: + status: + description: The validation status of import config. + $ref: '#/components/schemas/GoogleRpcStatus' + inputGcsSource: + type: string + description: The source Cloud Storage URI specified in the import config. + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + type: object + description: >- + The validation status of each import config. Status is set to an error + if there are no documents to import in the `import_config`, or `OK` if + the operation will try to proceed with at least one document. + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: Detected language for a structural component. type: object properties: - values: + confidence: + type: number + description: Confidence of detected language. Range `[0, 1]`. + format: float + languageCode: + description: >- + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. + type: string + GoogleCloudDocumentaiV1BoundingPoly: + id: GoogleCloudDocumentaiV1BoundingPoly + description: A bounding polygon for the detected image annotation. + properties: + vertices: + description: The bounding polygon vertices. type: array - description: The individual values that this enum values type can include. items: - type: string - GoogleCloudDocumentaiV1DocumentProvenanceParent: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + normalizedVertices: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + description: The bounding polygon normalized vertices. + type: array type: object + GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. + The long-running operation metadata for the UndeployProcessorVersion + method. properties: - index: - format: int32 - type: integer - description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. - revision: - description: The index of the index into current revision's parent_ids list. - type: integer + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata + type: object + GoogleCloudDocumentaiV1FetchProcessorTypesResponse: + properties: + processorTypes: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + type: array + description: The list of processor types. + type: object + id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse + description: Response message for the FetchProcessorTypes method. + GoogleCloudDocumentaiV1Vertex: + properties: + 'y': format: int32 - id: - description: The id of the parent provenance. + description: Y coordinate (starts from the top of the image). + type: integer + x: format: int32 - deprecated: true type: integer - id: GoogleCloudDocumentaiV1DocumentProvenanceParent - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: - description: Represents a table type block. + description: X coordinate. + id: GoogleCloudDocumentaiV1Vertex + description: >- + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. + type: object + GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: + type: object + properties: {} + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse + GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: + description: >- + The long-running operation metadata for the DeleteProcessorVersion + method. + id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock properties: - caption: - description: Table caption/title. - type: string - headerRows: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - description: Header rows at the top of the table. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: + id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig + type: object + properties: {} + description: Configuration specific to spanner-based indexing. + GoogleCloudDocumentaiV1DocumentChunkedDocument: + type: object + id: GoogleCloudDocumentaiV1DocumentChunkedDocument + properties: + chunks: + description: List of chunks. type: array - bodyRows: - description: Body rows containing main table content. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - type: array - GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + description: Represents the chunks that the document is divided into. + GoogleCloudDocumentaiV1DisableProcessorRequest: + properties: {} + id: GoogleCloudDocumentaiV1DisableProcessorRequest + description: Request message for the DisableProcessor method. + type: object + GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: + type: object description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + properties: {} + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: + description: Information for a pretrained Google-managed foundation model. + id: >- + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + properties: + minTrainLabeledDocuments: + description: >- + The minimum number of labeled documents in the training dataset + required for finetuning. + format: int32 + type: integer + finetuningAllowed: + description: Whether finetuning is allowed for this base processor version. + type: boolean type: object + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: properties: + shardingConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + description: Specifies the sharding config for the output document. + fieldMask: + format: google-fieldmask + description: >- + Specifies which fields to include in the output documents. Only + supports top level document and pages field so it must be in the + form of `{document_field_name}` or `pages.{page_field_name}`. + type: string gcsUri: - description: Required. The Cloud Storage URI where the actual document is stored. type: string - cwDocId: + description: The Cloud Storage uri (a directory) of the output. + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + description: The configuration used when outputting documents. + type: object + GoogleCloudDocumentaiV1beta3Dataset: + id: GoogleCloudDocumentaiV1beta3Dataset + type: object + properties: + satisfiesPzs: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + state: + type: string + enum: + - STATE_UNSPECIFIED + - UNINITIALIZED + - INITIALIZING + - INITIALIZED + description: Required. State of the dataset. Ignored when updating dataset. + enumDescriptions: + - Default unspecified enum, should not be used. + - Dataset has not been initialized. + - Dataset is being initialized. + - Dataset has been initialized. + gcsManagedConfig: + description: >- + Optional. User-managed Cloud Storage dataset configuration. Use this + configuration if the dataset documents are stored under a + user-managed Cloud Storage location. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + unmanagedDatasetConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig + description: >- + Optional. Unmanaged dataset configuration. Use this configuration if + the dataset documents are managed by the document service internally + (not user-managed). + spannerIndexingConfig: + description: >- + Optional. A lightweight indexing source with low latency and high + reliability, but lacking advanced features like CMEK and + content-based search. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig + name: type: string + description: >- + Dataset resource name. Format: + `projects/{project}/locations/{location}/processors/{processor}/dataset` + documentWarehouseConfig: deprecated: true - description: Id of the document (indexed) managed by Content Warehouse. - id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - GoogleCloudDocumentaiV1beta3EnableProcessorResponse: - properties: {} + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + description: >- + Optional. Deprecated. Warehouse-based dataset configuration is not + supported. description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. + A singleton resource under a Processor which configures a collection of + documents. + GoogleCloudDocumentaiV1RawDocument: + description: Payload message of raw document content (bytes). type: object - id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: + id: GoogleCloudDocumentaiV1RawDocument properties: - individualBatchUpdateStatuses: - description: The list of response details of each document. + mimeType: + description: >- + An IANA MIME type (RFC6838) indicating the nature and format of the + content. + type: string + content: + description: Inline document content. + type: string + format: byte + displayName: + type: string + description: >- + The display name of the document, it supports all Unicode characters + except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, + `,` `~`, `=` and `:` are reserved. If not specified, a default ID is + generated. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: + description: Metadata of the import document operation. + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + type: object + properties: + individualImportStatuses: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + description: The list of response details of each document. type: array commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - type: object - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata + description: The basic metadata of the long-running operation. + totalDocumentCount: + description: Total number of the documents that are qualified for importing. + format: int32 + type: integer + importConfigValidationResults: + type: array + description: Validation statuses of the batch documents import config. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult GoogleCloudDocumentaiV1DocumentSchemaMetadata: + type: object + id: GoogleCloudDocumentaiV1DocumentSchemaMetadata + description: Metadata for global schema behavior. properties: + skipNamingValidation: + type: boolean + description: >- + If set, we will skip the naming format validation in the schema. So + the string values in `DocumentSchema.EntityType.name` and + `DocumentSchema.EntityType.Property.name` will not be checked. + prefixedNamingOnProperties: + description: If set, all the nested entities must be prefixed with the parents. + type: boolean documentSplitter: description: >- If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). type: boolean - prefixedNamingOnProperties: - type: boolean - description: If set, all the nested entities must be prefixed with the parents. documentAllowMultipleLabels: - type: boolean description: >- If true, on a given page, there can be multiple `document` annotations covering it. - skipNamingValidation: - description: >- - If set, we will skip the naming format validation in the schema. So - the string values in `DocumentSchema.EntityType.name` and - `DocumentSchema.EntityType.Property.name` will not be checked. type: boolean - id: GoogleCloudDocumentaiV1DocumentSchemaMetadata - description: Metadata for global schema behavior. - type: object - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata - description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - type: object + GoogleCloudDocumentaiV1beta3RevisionRef: properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata for the long-running operation. - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: + revisionId: + type: string + description: Reads the revision given by the id. + revisionCase: + description: Reads the revision by the predefined case. + type: string + enum: + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION + enumDescriptions: + - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. + - The latest revision made by a human. + - The latest revision based on timestamp. + - The first (OCR) revision. + latestProcessorVersion: + type: string + description: >- + Reads the revision generated by the processor version. The format + takes the full resource name of processor version. + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + id: GoogleCloudDocumentaiV1beta3RevisionRef + description: The revision reference specifies which revision on the document to read. type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The common metadata about the operation. - description: Metadata message associated with the ExportProcessorVersion operation. - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: + GoogleTypePostalAddress: + description: >- + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 type: object + id: GoogleTypePostalAddress properties: - blocks: + addressLines: + type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + type: string + description: >- + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (e.g. "Austin, TX"), it is important that the line order is + clear. The order of address lines should be "envelope order" for the + country/region of the address. In places where this can vary (e.g. + Japan), address_language is used to make it explicit (e.g. "ja" for + large-to-small ordering and "ja-Latn" or "en" for small-to-large). + This way, the most specific line of an address can be selected based + on the language. The minimum permitted structural representation of + an address consists of a region_code with all remaining information + placed in the address_lines. It would be possible to format such an + address very approximately without geocoding, but no semantic + reasoning could be made about any of the address components until it + was at least partially resolved. Creating an address only containing + a region_code and address_lines, and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). + recipients: + items: + type: string + description: >- + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. type: array + revision: description: >- - A list entry is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry - description: Represents an entry in the list. - GoogleCloudDocumentaiV1DocumentEntityRelation: - type: object - description: Relationship between Entities. - id: GoogleCloudDocumentaiV1DocumentEntityRelation - properties: - relation: + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + format: int32 + type: integer + locality: + description: >- + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. type: string - description: Relationship description. - objectId: + sublocality: type: string - description: Object entity id. - subjectId: + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + administrativeArea: + description: >- + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. Specifically, for + Spain this is the province and not the autonomous community (e.g. + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. E.g. in Switzerland this + should be left unpopulated. type: string - description: Subject entity id. - GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: - description: The status of a each individual document in the batch process. - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus - type: object - properties: - humanReviewOperation: - deprecated: true + languageCode: + description: >- + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + type: string + sortingCode: type: string description: >- - The name of the operation triggered by the processed document. If - the human review process isn't triggered, this field will be empty. - It has the same response type and metadata as the long-running - operation returned by the ReviewDocument method. - outputGcsDestination: + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). + regionCode: type: string description: >- - The Cloud Storage output destination (in the request as - DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed - document if it was successful, otherwise empty. - humanReviewStatus: - description: The status of human review on the processed document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' - inputGcsSource: + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + postalCode: type: string description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: - description: >- - Represents a block. A block could be one of the various types (text, - table, list) supported. - type: object - id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - properties: - textBlock: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - description: Block consisting of text content. - listBlock: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - description: Block consisting of list content/structure. - tableBlock: - description: Block consisting of table content/structure. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - blockId: - description: ID of the block. + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (e.g. state/zip validation in the U.S.A.). + organization: type: string - pageSpan: + description: Optional. The name of the organization at the address. + GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: + properties: + commonMetadata: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - description: Page span of the block. - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: - type: object - id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset - properties: - startIndex: - type: string - description: TextSegment start UTF-8 char index in the Document.text. - format: int64 - endIndex: - format: int64 - type: string - description: TextSegment half open end UTF-8 char index in the Document.text. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + The long-running operation metadata for the DeleteProcessorVersion + method. type: object + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - properties: - listEntries: - description: List entries that constitute a list block. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry - type: - type: string - description: >- - Type of the list_entries (if exist). Available options are `ordered` - and `unordered`. - description: Represents a list type block. - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: - description: The response proto of AutoLabelDocuments method. - properties: {} + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions type: object - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse - GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: properties: - state: - description: The state of the operation. - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - updateTime: - description: The last update time of the operation. - type: string - format: google-datetime - stateMessage: + trainSteps: description: >- - A message providing more details about the current state of - processing. - type: string - createTime: - format: google-datetime - description: The creation time of the operation. - type: string - resource: + Optional. The number of steps to run for model tuning. Valid values + are between 1 and 400. If not provided, recommended steps will be + used. + type: integer + format: int32 + learningRateMultiplier: + description: >- + Optional. The multiplier to apply to the recommended learning rate. + Valid values are between 0.1 and 10. If not provided, recommended + learning rate will be used. + format: float + type: number + description: Options to control foundation model tuning of the processor. + GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: + description: Response of the import document operation. + id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse + type: object + properties: {} + GoogleCloudDocumentaiV1beta3GcsPrefix: + description: Specifies all documents on Cloud Storage with a common prefix. + id: GoogleCloudDocumentaiV1beta3GcsPrefix + type: object + properties: + gcsUriPrefix: + description: The URI prefix. type: string - description: A related resource to this operation. - id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. type: object - description: The common metadata for long running operations. + description: >- + The long-running operation metadata for the DeleteProcessorVersion + method. + id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata GoogleCloudDocumentaiV1Evaluation: - description: An evaluation of a ProcessorVersion's performance. id: GoogleCloudDocumentaiV1Evaluation + type: object properties: - allEntitiesMetrics: - description: Metrics for all the entities in aggregate. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + createTime: + format: google-datetime + description: The time that the evaluation was created. + type: string + kmsKeyName: + type: string + description: The KMS key name used for encryption. + documentCounters: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' + description: Counters for the documents used in the evaluation. entityMetrics: additionalProperties: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics description: Metrics across confidence levels, for different entities. type: object - createTime: - format: google-datetime - description: The time that the evaluation was created. + allEntitiesMetrics: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + description: Metrics for all the entities in aggregate. + kmsKeyVersionName: + description: The KMS key version with which data is encrypted. type: string name: type: string description: >- The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` - documentCounters: - description: Counters for the documents used in the evaluation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' - kmsKeyName: - type: string - description: The KMS key name used for encryption. - kmsKeyVersionName: - description: The KMS key version with which data is encrypted. - type: string + description: An evaluation of a ProcessorVersion's performance. + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: + properties: {} + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse type: object - GoogleCloudDocumentaiV1beta3HumanReviewStatus: + description: Response of the batch update documents operation. + GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: properties: - state: - enum: - - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR - enumDescriptions: - - >- - Human review state is unspecified. Most likely due to an internal - error. - - >- - Human review is skipped for the document. This can happen because - human review isn't enabled on the processor or the processing - request has been set to skip this document. - - >- - Human review validation is triggered and passed, so no review is - needed. - - >- - Human review validation is triggered and the document is under - review. - - >- - Some error happened during triggering human review, see the - state_message for details. - type: string - description: The state of human review on the processing request. - stateMessage: - description: A message providing more details about the human review state. - type: string - humanReviewOperation: + evaluationDocuments: description: >- - The name of the operation triggered by the processed document. This - field is populated only when the state is - `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and - metadata as the long-running operation returned by ReviewDocument. - type: string - type: object - id: GoogleCloudDocumentaiV1beta3HumanReviewStatus - description: The status of human review on a processed document. - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + Optional. The documents used in the evaluation. If unspecified, use + the processor's dataset as evaluation input. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: Evaluates the given ProcessorVersion against the supplied documents. type: object - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + GoogleCloudDocumentaiV1ProcessOptions: + description: Options for Process API properties: - languageCode: - type: string + individualPageSelector: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + description: Which pages to process (1-indexed). + ocrConfig: description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. - confidence: - format: float - type: number - description: Confidence of detected language. Range `[0, 1]`. - description: Detected language for a structural component. - GoogleCloudDocumentaiV1OcrConfigHints: - properties: - languageHints: - type: array + Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. + Returns error if set on other processor types. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfig' + fromStart: description: >- - List of BCP-47 language codes to use for OCR. In most cases, not - specifying it yields the best results since it enables automatic - language detection. For languages based on the Latin alphabet, - setting hints is not needed. In rare cases, when the language of the - text in the image is known, setting a hint will help get better - results (although it will be a significant hindrance if the hint is - wrong). - items: - type: string - description: Hints for OCR Engine - id: GoogleCloudDocumentaiV1OcrConfigHints + Only process certain pages from the start. Process all if the + document has fewer pages. + format: int32 + type: integer + fromEnd: + format: int32 + type: integer + description: Only process certain pages from the end, same as above. + layoutConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig + description: >- + Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns + error if set on other processor types. + schemaOverride: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: >- + Optional. Override the schema of the ProcessorVersion. Will return + an Invalid Argument error if this field is set when the underlying + ProcessorVersion doesn't support schema override. type: object - GoogleCloudDocumentaiV1Processor: - description: >- - The first-class citizen for Document AI. Each processor defines how to - extract structural information from a document. + id: GoogleCloudDocumentaiV1ProcessOptions + GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: + id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig + properties: {} + description: Configuration specific to an unmanaged dataset. type: object - id: GoogleCloudDocumentaiV1Processor + GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig: + description: Serving config for chunking. + id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig properties: - displayName: - type: string - description: The display name of the processor. - kmsKeyName: - description: >- - The [KMS key](https://cloud.google.com/security-key-management) used - for encryption and decryption in CMEK scenarios. - type: string - name: - description: >- - Output only. Immutable. The resource name of the processor. Format: - `projects/{project}/locations/{location}/processors/{processor}` - readOnly: true - type: string - satisfiesPzi: - readOnly: true + includeAncestorHeadings: type: boolean - description: Output only. Reserved for future use. - processEndpoint: - type: string - readOnly: true description: >- - Output only. Immutable. The http endpoint that can be called to - invoke processing. - processorVersionAliases: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' - readOnly: true - description: Output only. The processor version aliases. - createTime: - format: google-datetime - type: string - description: The time the processor was created. - defaultProcessorVersion: - type: string - description: The default processor version. - type: - type: string - description: >- - The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. - To get a list of processor types, see FetchProcessorTypes. - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - ENABLED - - DISABLED - - ENABLING - - DISABLING - - CREATING - - FAILED - - DELETING - type: string - enumDescriptions: - - The processor is in an unspecified state. - - >- - The processor is enabled, i.e., has an enabled version which can - currently serve processing requests and all the feature - dependencies have been successfully initialized. - - The processor is disabled. - - >- - The processor is being enabled, will become `ENABLED` if - successful. - - >- - The processor is being disabled, will become `DISABLED` if - successful. - - >- - The processor is being created, will become either `ENABLED` (for - successful creation) or `FAILED` (for failed ones). Once a - processor is in this state, it can then be used for document - processing, but the feature dependencies of the processor might - not be fully created yet. - - >- - The processor failed during creation or initialization of feature - dependencies. The user should delete the processor and recreate - one as all the functionalities of the processor are disabled. - - The processor is being deleted, will be removed if successful. - description: Output only. The state of the processor. - satisfiesPzs: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: - description: Represents where the block starts and ends in the document. - properties: - pageEnd: - type: integer - description: Page where block ends in the document. - format: int32 - pageStart: - description: Page where block starts in the document. + Optional. Whether or not to include ancestor headings when + splitting. + chunkSize: format: int32 + description: >- + Optional. The chunk sizes to use when splitting documents, in order + of level. type: integer - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - type: object - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: type: object - description: The statistic representing a dataset split type for this export. - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue properties: - totalDocumentCount: - format: int32 + booleanValue: + description: >- + Boolean value. Can be used for entities with binary values, or for + checkboxes. + type: boolean + integerValue: type: integer + description: Integer value. + format: int32 + moneyValue: description: >- - Total number of documents with the given dataset split type to be - exported. - splitType: - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - description: The dataset split type. + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + $ref: '#/components/schemas/GoogleTypeMoney' + text: + description: >- + Optional. An optional field to store a normalized string. For some + entity types, one of respective `structured_value` fields may also + be populated. Also not all the types of `structured_value` will be + normalized. For example, some processors may not generate `float` or + `integer` normalized text by default. Below are sample formats + mapped to structured values. - Money/Currency type (`money_value`) + is in the ISO 4217 text format. - Date type (`date_value`) is in the + ISO 8601 text format. - Datetime type (`datetime_value`) is in the + ISO 8601 text format. type: string - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - GoogleCloudDocumentaiV1ListProcessorsResponse: + datetimeValue: + $ref: '#/components/schemas/GoogleTypeDateTime' + description: >- + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + dateValue: + description: >- + Date value. Includes year, month, day. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + $ref: '#/components/schemas/GoogleTypeDate' + addressValue: + description: >- + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + $ref: '#/components/schemas/GoogleTypePostalAddress' + floatValue: + type: number + description: Float value. + format: float + description: Parsed and normalized entity value. + type: object + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: + description: Metadata of the EvaluateProcessorVersion method. + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata + type: object properties: - processors: - description: The list of processors. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' - nextPageToken: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: + properties: + processorVersion: + description: The resource name of the processor version produced by training. type: string - description: Points to the next processor, otherwise empty. - id: GoogleCloudDocumentaiV1ListProcessorsResponse - description: Response message for the ListProcessors method. - type: object - GoogleCloudDocumentaiV1DeployProcessorVersionRequest: + description: The response for TrainProcessorVersion. + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse type: object - id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest - properties: {} - description: Request message for the DeployProcessorVersion method. - GoogleCloudDocumentaiV1DocumentShardInfo: - id: GoogleCloudDocumentaiV1DocumentShardInfo + GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: + description: Request message for the SetDefaultProcessorVersion method. type: object properties: - shardCount: - type: string - description: Total number of shards. - format: int64 - shardIndex: - type: string - description: The 0-based index of this shard. - format: int64 - textOffset: + defaultProcessorVersion: description: >- - The index of the first character in Document.text in the overall - document global text. + Required. The resource name of child ProcessorVersion to use as + default. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` type: string - format: int64 - description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: - id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + GoogleCloudDocumentaiV1GcsDocuments: + properties: + documents: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + type: array + description: The list of documents. + id: GoogleCloudDocumentaiV1GcsDocuments + type: object + description: Specifies a set of documents on Cloud Storage. + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: type: object properties: - inputGcsSource: - type: string - description: The source Cloud Storage URI specified in the import config. + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: >- + The document id of the auto-labeled document. This will replace the + gcs_uri. status: - description: The validation status of import config. $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The validation status of each import config. Status is set to an error - if there are no documents to import in the `import_config`, or `OK` if - the operation will try to proceed with at least one document. - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: - description: The sharding config for the output document. - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - type: object - properties: - pagesPerShard: - format: int32 - type: integer - description: The number of pages per shard. - pagesOverlap: - type: integer - format: int32 - description: The number of overlapping pages between consecutive shards. - GoogleCloudDocumentaiV1DocumentPageFormField: + description: The status of the document auto-labeling. + description: The status of individual documents in the auto-labeling process. + id: >- + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus + GoogleLongrunningOperation: type: object - description: A form field detected on the page. + id: GoogleLongrunningOperation properties: - valueDetectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages for value together with confidence. - type: array - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - fieldName: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - correctedKeyText: + done: + type: boolean description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. - type: string - fieldValue: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the FormField value. - nameDetectedLanguages: - description: A list of detected languages for name together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - correctedValueText: - type: string + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + name: description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. - valueType: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + error: description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` - id: GoogleCloudDocumentaiV1DocumentPageFormField - GoogleCloudDocumentaiV1EnableProcessorRequest: + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + type: object + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: + description: A list of individual page numbers. type: object - description: Request message for the EnableProcessor method. - properties: {} - id: GoogleCloudDocumentaiV1EnableProcessorRequest - GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: + id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector properties: - docId: - type: string - description: Required. The id of the document. + pages: + items: + format: int32 + type: integer + description: Optional. Indices of the pages (starting from 1). + type: array + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: + type: object description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. - id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + The long-running operation metadata for the DeployProcessorVersion + method. + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + GoogleCloudDocumentaiV1DocumentPageAnchor: + properties: + pageRefs: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + description: One or more references to visual page elements type: object - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: + description: >- + Referencing the visual context of the entity in the Document.pages. Page + anchors can be cross-page, consist of multiple bounding polygons and + optionally reference specific layout element types. + id: GoogleCloudDocumentaiV1DocumentPageAnchor + GoogleCloudDocumentaiV1DocumentProvenanceParent: + description: >- + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. properties: - evaluation: - type: string - description: The resource name of the created evaluation. - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse - description: Response of the EvaluateProcessorVersion method. + id: + deprecated: true + type: integer + format: int32 + description: The id of the parent provenance. + revision: + description: The index of the index into current revision's parent_ids list. + format: int32 + type: integer + index: + type: integer + format: int32 + description: >- + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. type: object - GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: + id: GoogleCloudDocumentaiV1DocumentProvenanceParent + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: + description: Metadata of the auto-labeling documents operation. + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata type: object - id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - description: The status of a each individual document in the batch process. properties: - outputGcsDestination: - description: >- - The Cloud Storage output destination (in the request as - DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed - document if it was successful, otherwise empty. - type: string - humanReviewStatus: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' - description: The status of human review on the processed document. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - inputGcsSource: + individualAutoLabelStatuses: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. - type: string - GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: + The list of individual auto-labeling statuses of the dataset + documents. + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + totalDocumentCount: + format: int32 + type: integer + description: Total number of the auto-labeling documents. + GoogleCloudDocumentaiV1ListProcessorsResponse: + description: Response message for the ListProcessors method. properties: - docId: + processors: + description: The list of processors. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + type: array + nextPageToken: + description: Points to the next processor, otherwise empty. type: string - description: Required. The id of the document. - description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. type: object - id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId - GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: + id: GoogleCloudDocumentaiV1ListProcessorsResponse + GoogleCloudDocumentaiV1GcsPrefix: + id: GoogleCloudDocumentaiV1GcsPrefix properties: - collection: - type: string - readOnly: true - description: >- - Output only. The collection in Document AI Warehouse associated with - the dataset. - schema: - description: >- - Output only. The schema in Document AI Warehouse associated with the - dataset. - readOnly: true + gcsUriPrefix: type: string - description: >- - Configuration specific to the Document AI Warehouse-based - implementation. - id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - type: object - GoogleCloudDocumentaiV1TrainProcessorVersionResponse: + description: The URI prefix. + description: Specifies all documents on Cloud Storage with a common prefix. type: object + GoogleCloudDocumentaiV1DocumentPageTableTableRow: properties: - processorVersion: - description: The resource name of the processor version produced by training. - type: string - description: The response for TrainProcessorVersion. - id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: - description: Response of the batch update documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse - properties: {} + cells: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + type: array + description: Cells that make up this row. type: object - GoogleCloudDocumentaiV1EnableProcessorResponse: - id: GoogleCloudDocumentaiV1EnableProcessorResponse + description: A row of table cells. + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: properties: {} - description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. + description: Request message for the UndeployProcessorVersion method. + type: object + id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: type: object - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: - description: Represents a weak reference to a page element within a document. properties: - layoutId: - deprecated: true + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: The long-running operation metadata for the CreateLabelerPool method. + id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + type: object + properties: + state: + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. + type: string + stateMessage: type: string - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - layoutType: description: >- - Optional. The type of the layout element that is being referenced if - any. - type: string - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. - page: - format: int64 - type: string - description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - confidence: - type: number - description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - format: float - boundingPoly: - description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. + description: Human Review information of the document. + GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata type: object - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: properties: - individualBatchDeleteStatuses: - description: The list of response details of each document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - type: array commonMetadata: + description: The basic metadata for the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - errorDocumentCount: - format: int32 - type: integer - description: Total number of documents that failed to be deleted in storage. - totalDocumentCount: - format: int32 - description: Total number of documents deleting from dataset. - type: integer - type: object - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. + GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: properties: - layout: - description: Layout for DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - barcode: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - description: Detailed barcode information of the DetectedBarcode. - description: A detected barcode. + gcsUri: + description: Required. The Cloud Storage URI where the actual document is stored. + type: string + cwDocId: + type: string + description: Id of the document (indexed) managed by Content Warehouse. + deprecated: true type: object - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata + id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + description: >- + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. + GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: + description: Metadata of the sample documents operation. type: object properties: - individualBatchDeleteStatuses: - description: The list of response details of each document. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - errorDocumentCount: - type: integer - format: int32 - description: Total number of documents that failed to be deleted in storage. commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - totalDocumentCount: - type: integer - format: int32 - description: Total number of documents deleting from dataset. - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: + description: Represents a chunk. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk type: object - description: Response of the delete documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse - properties: {} - GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: properties: - commonMetadata: - description: The basic metadata of the long-running operation. + content: + type: string + description: Text content of the chunk. + sourceBlockIds: + items: + type: string + description: Unused. + type: array + pageSpan: + description: Page span of the chunk. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + pageFooters: + description: Page footers associated with the chunk. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + pageHeaders: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + description: Page headers associated with the chunk. + type: array + chunkId: + description: ID of the chunk. + type: string + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse + properties: {} type: object - description: The long-running operation metadata for the EnableProcessor method. - id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + description: Response of the delete documents operation. + GoogleCloudDocumentaiV1DocumentPageFormField: type: object - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: Parsed and normalized entity value. + description: A form field detected on the page. properties: - floatValue: - description: Float value. - format: float - type: number - booleanValue: - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - type: boolean - dateValue: - description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - $ref: '#/components/schemas/GoogleTypeDate' - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' + correctedValueText: description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - text: + Created for Labeling UI to export value text. If corrections were + made to the text identified by the `field_value.text_anchor`, this + field will contain the correction. type: string + fieldName: description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - addressValue: + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + valueType: + type: string description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - integerValue: - type: integer - format: int32 - description: Integer value. - moneyValue: - $ref: '#/components/schemas/GoogleTypeMoney' + If the value is non-textual, this field represents the type. Current + valid values are: - blank (this indicates the `field_value` is + normal text) - `unfilled_checkbox` - `filled_checkbox` + fieldValue: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the FormField value. + valueDetectedLanguages: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages for value together with confidence. + nameDetectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages for name together with confidence. + type: array + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + correctedKeyText: + type: string description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: + Created for Labeling UI to export key text. If corrections were made + to the text identified by the `field_name.text_anchor`, this field + will contain the correction. + id: GoogleCloudDocumentaiV1DocumentPageFormField + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: + type: object + description: Response message for the UndeployProcessorVersion method. + properties: {} + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse + GoogleCloudLocationListLocationsResponse: type: object - id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus properties: - inputGcsSource: - description: The source Cloud Storage URI of the document. + nextPageToken: type: string - outputDocumentId: + description: The standard List next-page token. + locations: + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' description: >- - The document id of imported document if it was successful, otherwise - empty. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the importing of the document. - description: The status of each individual document in the import process. - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: + A list of locations that matches the specified filter in the + request. + type: array + description: The response message for Locations.ListLocations. + id: GoogleCloudLocationListLocationsResponse + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: + description: Represents a text type block. id: >- - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock properties: - outputGcsDestination: + blocks: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + type: array description: >- - The output_gcs_destination of the exported document if it was - successful, otherwise empty. + A text block could further have child blocks. Repeated blocks + support further hierarchies and nested blocks. + type: type: string - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the exporting of the document. + description: >- + Type of the text in the block. Available options are: `paragraph`, + `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + `heading-5`, `header`, `footer`. + text: + type: string + description: Text content stored in the block. + type: object + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: + properties: documentId: - description: The path to source docproto of the document. $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The status of each individual document in the export process. - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: + description: The document identifier. + status: + description: >- + The status of resyncing the document with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + $ref: '#/components/schemas/GoogleRpcStatus' + documentInconsistencyType: + enum: + - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED + - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO + - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA + - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE + enumDescriptions: + - Default value. + - The document proto is invalid. + - Indexed docproto metadata is mismatched. + - The page image or thumbnails are missing. + type: string + description: The type of document inconsistency. + id: >- + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + type: object + description: Resync status for each document per inconsistency type. + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - testDatasetValidation: - description: The test dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - trainingDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - description: The training dataset validation information. - description: The metadata that represents a processor version being created. + details: + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string type: object - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata - GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: + GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: + type: object + description: The long-running operation metadata for the EnableProcessor method. properties: commonMetadata: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata - type: object - description: The long-running operation metadata for UpdateLabelerPool. - GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: - id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest - description: Request message for the UndeployProcessorVersion method. - properties: {} - type: object - GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: + id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata + GoogleCloudDocumentaiV1DocumentDocumentLayout: + id: GoogleCloudDocumentaiV1DocumentDocumentLayout type: object properties: - locationId: - description: >- - The location ID. For supported locations, refer to [regional and - multi-regional support](/document-ai/docs/regions). - type: string - id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - description: The location information about where the processor is available. - GoogleCloudDocumentaiV1DocumentPageLine: - id: GoogleCloudDocumentaiV1DocumentPageLine - properties: - detectedLanguages: - description: A list of detected languages together with confidence. + blocks: + type: array + description: List of blocks in the document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Line. - type: object + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. + Represents the parsed layout of a document as a collection of blocks + that the document is divided into. + GoogleCloudDocumentaiV1DocumentOutputConfig: + description: >- + Config that controls the output of documents. All documents will be + written as a JSON file. + type: object + properties: + gcsOutputConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + description: Output config to write the results to Cloud Storage. + id: GoogleCloudDocumentaiV1DocumentOutputConfig + GoogleCloudDocumentaiV1GcsDocument: + properties: + mimeType: + type: string + description: An IANA MIME type (RFC6838) of the content. + gcsUri: + description: The Cloud Storage object uri. + type: string + id: GoogleCloudDocumentaiV1GcsDocument + type: object + description: Specifies a document stored on Cloud Storage. + GoogleCloudDocumentaiV1BatchProcessResponse: + id: GoogleCloudDocumentaiV1BatchProcessResponse + properties: {} + type: object + description: Response message for BatchProcessDocuments. GoogleCloudDocumentaiV1ProcessResponse: - description: Response message for the ProcessDocument method. type: object properties: document: @@ -3884,61 +3883,273 @@ components: behavior. $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' humanReviewStatus: - description: The status of human review on the processed document. $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + description: The status of human review on the processed document. id: GoogleCloudDocumentaiV1ProcessResponse - GoogleTypeColor: + description: Response message for the ProcessDocument method. + GoogleCloudDocumentaiV1beta3BatchProcessResponse: + type: object + properties: {} + id: GoogleCloudDocumentaiV1beta3BatchProcessResponse + description: Response message for BatchProcessDocuments. + GoogleCloudDocumentaiV1Processor: + id: GoogleCloudDocumentaiV1Processor + description: >- + The first-class citizen for Document AI. Each processor defines how to + extract structural information from a document. type: object properties: - red: - type: number - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - type: number - green: - format: float - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - alpha: - format: float - type: number + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + processEndpoint: + type: string + readOnly: true description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + Output only. Immutable. The http endpoint that can be called to + invoke processing. + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + defaultProcessorVersion: + type: string + description: The default processor version. + state: + type: string + description: Output only. The state of the processor. + readOnly: true + enum: + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + - ENABLING + - DISABLING + - CREATING + - FAILED + - DELETING + enumDescriptions: + - The processor is in an unspecified state. + - >- + The processor is enabled, i.e., has an enabled version which can + currently serve processing requests and all the feature + dependencies have been successfully initialized. + - The processor is disabled. + - >- + The processor is being enabled, will become `ENABLED` if + successful. + - >- + The processor is being disabled, will become `DISABLED` if + successful. + - >- + The processor is being created, will become either `ENABLED` (for + successful creation) or `FAILED` (for failed ones). Once a + processor is in this state, it can then be used for document + processing, but the feature dependencies of the processor might + not be fully created yet. + - >- + The processor failed during creation or initialization of feature + dependencies. The user should delete the processor and recreate + one as all the functionalities of the processor are disabled. + - The processor is being deleted, will be removed if successful. + createTime: + format: google-datetime + description: The time the processor was created. + type: string + processorVersionAliases: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' + readOnly: true + description: Output only. The processor version aliases. + type: array + kmsKeyName: + description: >- + The [KMS key](https://cloud.google.com/security-key-management) used + for encryption and decryption in CMEK scenarios. + type: string + name: + description: >- + Output only. Immutable. The resource name of the processor. Format: + `projects/{project}/locations/{location}/processors/{processor}` + type: string + readOnly: true + type: + type: string + description: >- + The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + To get a list of processor types, see FetchProcessorTypes. + displayName: + type: string + description: The display name of the processor. + GoogleCloudDocumentaiV1DocumentPageTable: + properties: + bodyRows: + type: array + description: Body rows of the table. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + headerRows: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: Header rows of the table. + provenance: + deprecated: true + description: The history of this table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + layout: + description: Layout for Table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: A table representation similar to HTML table structure. + type: object + id: GoogleCloudDocumentaiV1DocumentPageTable + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: + description: Response message for the SetDefaultProcessorVersion method. + type: object + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse + properties: {} + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: + id: >- + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + type: object + description: The status of each individual document in the export process. + properties: + outputGcsDestination: + description: >- + The output_gcs_destination of the exported document if it was + successful, otherwise empty. + type: string + documentId: + description: The path to source docproto of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + status: + description: The status of the exporting of the document. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + type: object + properties: + layoutType: + enumDescriptions: + - Layout Unspecified. + - References a Page.blocks element. + - References a Page.paragraphs element. + - References a Page.lines element. + - References a Page.tokens element. + - References a Page.visual_elements element. + - Refrrences a Page.tables element. + - References a Page.form_fields element. + description: >- + Optional. The type of the layout element that is being referenced if + any. + type: string + enum: + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD + confidence: + format: float + description: >- + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + type: number + page: + format: int64 + description: >- + Required. Index into the Document.pages element, for example using + `Document.pages` to locate the related page element. This field is + skipped when its value is the default `0`. See + https://developers.google.com/protocol-buffers/docs/proto3#json. + type: string + layoutId: + type: string + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + deprecated: true + boundingPoly: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + description: >- + Optional. Identifies the bounding polygon of a layout element on the + page. If `layout_type` is set, the bounding polygon must be exactly + the same to the layout element it's referring to. + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + description: Represents a weak reference to a page element within a document. + GoogleTypeColor: + properties: + blue: + format: float + type: number + description: The amount of blue in the color as a value in the interval [0, 1]. + red: + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + alpha: + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + green: + format: float + type: number + description: The amount of green in the color as a value in the interval [0, 1]. + type: object + id: GoogleTypeColor + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return @@ -3967,668 +4178,569 @@ components: resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... - id: GoogleTypeColor - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of updating the document in storage. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. + GoogleCloudDocumentaiV1ListProcessorVersionsResponse: type: object - description: The status of each individual document in the batch update process. - id: >- - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the document auto-labeling. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: >- - The document id of the auto-labeled document. This will replace the - gcs_uri. - description: The status of individual documents in the auto-labeling process. - id: >- - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - type: object - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - type: object - GoogleProtobufEmpty: - id: GoogleProtobufEmpty - properties: {} - 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); } - type: object - GoogleCloudDocumentaiV1DocumentPageParagraph: + id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse + description: Response message for the ListProcessorVersions method. properties: - layout: - description: Layout for Paragraph. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: + processorVersions: type: array + description: The list of processors. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - description: A collection of lines that a human would perceive as a paragraph. - type: object - id: GoogleCloudDocumentaiV1DocumentPageParagraph - GoogleCloudDocumentaiV1BatchDocumentsInputConfig: - type: object - description: The common config to specify a set of documents used as input. - properties: - gcsPrefix: - description: >- - The set of documents that match the specified Cloud Storage - `gcs_prefix`. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' - gcsDocuments: - description: The set of documents individually specified on Cloud Storage. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' - id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - type: object - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata - GoogleCloudDocumentaiUiv1beta3RevisionRef: - type: object - description: The revision reference specifies which revision on the document to read. - id: GoogleCloudDocumentaiUiv1beta3RevisionRef - properties: - revisionId: - type: string - description: Reads the revision given by the id. - revisionCase: - enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION - enumDescriptions: - - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. - - The latest revision made by a human. - - The latest revision based on timestamp. - - The first (OCR) revision. - type: string - description: Reads the revision by the predefined case. - latestProcessorVersion: - description: >- - Reads the revision generated by the processor version. The format - takes the full resource name of processor version. - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + nextPageToken: type: string - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: - type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata - description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: - properties: {} - description: Configuration specific to an unmanaged dataset. - id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - type: object - GoogleCloudDocumentaiV1beta3DisableProcessorResponse: - id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - properties: {} - type: object - GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: + description: Points to the next processor, otherwise empty. + GoogleCloudDocumentaiV1EvaluationMetrics: + id: GoogleCloudDocumentaiV1EvaluationMetrics + description: Evaluation metrics, either in aggregate or about a specific entity. type: object properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - description: The long-running operation metadata for the DisableProcessor method. - type: object - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: - description: >- - Options to control the training of the Custom Document Extraction (CDE) - Processor. + f1Score: + format: float + description: The calculated f1 score. + type: number + groundTruthOccurrencesCount: + description: The amount of occurrences in ground truth documents. + type: integer + format: int32 + totalDocumentsCount: + description: The amount of documents that had an occurrence of this label. + format: int32 + type: integer + predictedOccurrencesCount: + description: The amount of occurrences in predicted documents. + type: integer + format: int32 + predictedDocumentCount: + description: The amount of documents with a predicted occurrence. + format: int32 + type: integer + groundTruthDocumentCount: + description: The amount of documents with a ground truth occurrence. + type: integer + format: int32 + falsePositivesCount: + description: The amount of false positives. + format: int32 + type: integer + precision: + type: number + description: The calculated precision. + format: float + recall: + format: float + description: The calculated recall. + type: number + falseNegativesCount: + description: The amount of false negatives. + format: int32 + type: integer + truePositivesCount: + type: integer + description: The amount of true positives. + format: int32 + GoogleCloudDocumentaiV1TrainProcessorVersionResponse: + id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse type: object - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions - properties: - trainingMethod: - enum: - - TRAINING_METHOD_UNSPECIFIED - - MODEL_BASED - - TEMPLATE_BASED - description: Training method to use for CDE training. - type: string - enumDescriptions: - - '' - - '' - - '' - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse properties: processorVersion: + description: The resource name of the processor version produced by training. type: string - description: The destination processor version name. - description: The response message for the ImportProcessorVersion method. - type: object - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: + description: The response for TrainProcessorVersion. + GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - type: object - GoogleCloudDocumentaiV1Vertex: - description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. + metricsType: + type: string + enum: + - METRICS_TYPE_UNSPECIFIED + - AGGREGATE + enumDescriptions: + - >- + The metrics type is unspecified. By default, metrics without a + particular specification are for leaf entity types (i.e., + top-level entity types without child types, or child types which + are not parent types themselves). + - >- + Indicates whether metrics for this particular label type represent + an aggregate of metrics for other types instead of being based on + actual TP/FP/FN values for the label type. Metrics for parent + (i.e., non-leaf) entity types are an aggregate of metrics for + their children. + description: The metrics type for the label. + estimatedCalibrationError: + format: float + description: >- + The Estimated Calibration Error (ECE) of the confidence of the + predicted entities. + type: number + estimatedCalibrationErrorExact: + type: number + description: >- + The ECE for the predicted entities with fuzzy matching disabled, + i.e., exact matching only. + format: float + confidenceLevelMetricsExact: + description: Metrics across confidence levels with only exact matching. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + type: array + confidenceLevelMetrics: + type: array + description: Metrics across confidence levels with fuzzy matching enabled. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + auprcExact: + format: float + type: number + description: >- + The AUPRC for metrics with fuzzy matching disabled, i.e., exact + matching only. + auprc: + description: >- + The calculated area under the precision recall curve (AUPRC), + computed by integrating over all confidence thresholds. + type: number + format: float + id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + description: Metrics across multiple confidence levels. type: object - properties: - 'y': - description: Y coordinate (starts from the top of the image). - format: int32 - type: integer - x: - type: integer - description: X coordinate. - format: int32 - id: GoogleCloudDocumentaiV1Vertex - GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: + GoogleCloudDocumentaiV1beta3DocumentId: + id: GoogleCloudDocumentaiV1beta3DocumentId type: object - description: The long-running operation metadata for the CreateLabelerPool method. - id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata properties: - commonMetadata: + gcsManagedDocId: + description: A document id within user-managed Cloud Storage. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1BatchProcessMetadata: + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + revisionRef: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3RevisionRef' + description: Points to a specific revision of the document if set. + unmanagedDocId: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + description: A document id within unmanaged dataset. + description: Document Identifier. + GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: + id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse properties: - stateMessage: + gcsDestination: description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - type: string - individualProcessStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - description: The list of response details of each document. - updateTime: - format: google-datetime - description: The last update time of the operation. - type: string - createTime: - format: google-datetime - description: The creation time of the operation. + The Cloud Storage uri for the human reviewed document if the review + is succeeded. type: string state: enum: - STATE_UNSPECIFIED - - WAITING - - RUNNING + - REJECTED - SUCCEEDED - - CANCELLING - - CANCELLED - - FAILED - description: The state of the current batch processing. + description: The state of the review operation. + type: string enumDescriptions: - The default value. This value is used if the state is omitted. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was being cancelled. - - The batch processing was cancelled. - - The batch processing has failed. - type: string - description: The long-running operation metadata for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1BatchProcessMetadata - type: object - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: - description: Response message associated with the ExportProcessorVersion operation. - type: object - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse - properties: - gcsUri: - description: The Cloud Storage URI containing the output artifacts. + - The review operation is rejected by the reviewer. + - The review operation is succeeded. + rejectionReason: + description: The reason why the review is rejected by reviewer. type: string - GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: + description: Response message for the ReviewDocument method. type: object - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + GoogleCloudDocumentaiV1EvaluationCounters: + id: GoogleCloudDocumentaiV1EvaluationCounters properties: - evaluationDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + failedDocumentsCount: + format: int32 description: >- - Optional. The documents used in the evaluation. If unspecified, use - the processor's dataset as evaluation input. - description: Evaluates the given ProcessorVersion against the supplied documents. - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: - type: object - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores - properties: - qualityScore: + How many documents were not included in the evaluation as Document + AI failed to process them. + type: integer + evaluatedDocumentsCount: + type: integer + description: How many documents were used in the evaluation. + format: int32 + inputDocumentsCount: + format: int32 + type: integer + description: How many documents were sent for evaluation. + invalidDocumentsCount: description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - format: float - type: number - detectedDefects: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - description: A list of detected defects. - description: Image quality scores for the page image. - GoogleCloudDocumentaiV1EnableProcessorMetadata: - description: The long-running operation metadata for the EnableProcessor method. - id: GoogleCloudDocumentaiV1EnableProcessorMetadata + How many documents were not included in the evaluation as they + didn't pass validation. + type: integer + format: int32 type: object + description: Evaluation counters for the documents that were used. + GoogleCloudDocumentaiV1EnableProcessorMetadata: properties: commonMetadata: $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: - id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + id: GoogleCloudDocumentaiV1EnableProcessorMetadata + type: object + description: The long-running operation metadata for the EnableProcessor method. + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + description: Image Quality Defects properties: - estimatedCalibrationErrorExact: + type: + description: >- + Name of the defect type. Supported values are: - + `quality/defect_blurry` - `quality/defect_noisy` - + `quality/defect_dark` - `quality/defect_faint` - + `quality/defect_text_too_small` - `quality/defect_document_cutoff` - + `quality/defect_text_cutoff` - `quality/defect_glare` + type: string + confidence: format: float description: >- - The ECE for the predicted entities with fuzzy matching disabled, - i.e., exact matching only. - type: number - auprc: + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. type: number + type: object + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: + type: object + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + properties: {} + description: Response message for the DeployProcessorVersion method. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: + type: object + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse + properties: {} + description: Response of the import document operation. + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse + description: Response message for the SetDefaultProcessorVersion method. + properties: {} + type: object + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: + properties: + baseProcessorVersionId: + type: string + description: The base processor version ID for the custom model. + customModelType: + enumDescriptions: + - The model type is unspecified. + - The model is a versioned foundation model. + - The model is a finetuned foundation model. + description: The type of custom model created by the user. + enum: + - CUSTOM_MODEL_TYPE_UNSPECIFIED + - VERSIONED_FOUNDATION + - FINE_TUNED + type: string + id: >- + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + description: >- + Information for a custom Generative AI model created by the user. These + are created with `Create New Version` in either the `Call foundation + model` or `Fine tuning` tabs. + type: object + GoogleCloudDocumentaiV1DocumentStyle: + id: GoogleCloudDocumentaiV1DocumentStyle + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. + type: object + properties: + textDecoration: + type: string description: >- - The calculated area under the precision recall curve (AUPRC), - computed by integrating over all confidence thresholds. - format: float - confidenceLevelMetricsExact: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - type: array - description: Metrics across confidence levels with only exact matching. - auprcExact: - format: float - type: number + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + fontSize: + description: Font size. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' + backgroundColor: + description: Text background color. + $ref: '#/components/schemas/GoogleTypeColor' + textStyle: + type: string description: >- - The AUPRC for metrics with fuzzy matching disabled, i.e., exact - matching only. - confidenceLevelMetrics: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - type: array - description: Metrics across confidence levels with fuzzy matching enabled. - metricsType: - enum: - - METRICS_TYPE_UNSPECIFIED - - AGGREGATE - enumDescriptions: - - >- - The metrics type is unspecified. By default, metrics without a - particular specification are for leaf entity types (i.e., - top-level entity types without child types, or child types which - are not parent types themselves). - - >- - Indicates whether metrics for this particular label type represent - an aggregate of metrics for other types instead of being based on - actual TP/FP/FN values for the label type. Metrics for parent - (i.e., non-leaf) entity types are an aggregate of metrics for - their children. - description: The metrics type for the label. + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. + fontWeight: + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + type: string + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + fontFamily: type: string - estimatedCalibrationError: description: >- - The Estimated Calibration Error (ECE) of the confidence of the - predicted entities. - format: float - type: number - description: Metrics across multiple confidence levels. + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text color. + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: + description: Response message associated with the ExportProcessorVersion operation. + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse + properties: + gcsUri: + type: string + description: The Cloud Storage URI containing the output artifacts. type: object - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument + GoogleCloudDocumentaiV1ListEvaluationsResponse: type: object properties: - documentId: + nextPageToken: type: string - description: An internal identifier for document. - GoogleTypeDate: + 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. + evaluations: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' + description: The evaluations requested. + type: array + id: GoogleCloudDocumentaiV1ListEvaluationsResponse + description: The response from `ListEvaluations`. + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: + type: object + description: The statistic representing a dataset split type for this export. properties: - day: + totalDocumentCount: type: integer description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - type: integer - month: + Total number of documents with the given dataset split type to be + exported. format: int32 - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer + splitType: + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + type: string + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + description: The dataset split type. + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + GoogleCloudDocumentaiV1NormalizedVertex: + id: GoogleCloudDocumentaiV1NormalizedVertex description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - id: GoogleTypeDate + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. type: object - GoogleCloudDocumentaiV1DocumentSchema: properties: - metadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' - description: Metadata of the schema. - displayName: - description: Display name to show to users. - type: string - description: - description: Description of the schema. - type: string - entityTypes: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType - description: Entity types of the schema. - type: array - description: The schema defines the output of the processed document by a processor. - id: GoogleCloudDocumentaiV1DocumentSchema - type: object - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: - type: object + 'y': + type: number + format: float + description: Y coordinate (starts from the top of the image). + x: + format: float + type: number + description: X coordinate. + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata - GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: + documentId: + description: The document id of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of moving the document. + description: The status of each individual document in the batch move process. type: object + id: >- + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + GoogleCloudDocumentaiV1BatchProcessRequest: properties: - commonMetadata: + processOptions: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + description: Inference-time options for the process API + inputDocuments: + description: The input documents for the BatchProcessDocuments method. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata - GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + documentOutputConfig: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' + description: The output configuration for the BatchProcessDocuments method. + labels: + description: >- + Optional. The labels with user-defined metadata for the request. + 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. + additionalProperties: + type: string + type: object + skipHumanReview: + type: boolean + description: >- + Whether human review should be skipped for this request. Default to + `false`. + description: Request message for BatchProcessDocuments. type: object - id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. + id: GoogleCloudDocumentaiV1BatchProcessRequest + GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: + description: The response message for the ImportProcessorVersion method. type: object - id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata - GoogleCloudDocumentaiV1CommonOperationMetadata: - id: GoogleCloudDocumentaiV1CommonOperationMetadata - description: The common metadata for long running operations. properties: - state: - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. + processorVersion: + description: The destination processor version name. type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - description: The state of the operation. - stateMessage: - description: >- - A message providing more details about the current state of - processing. + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse + GoogleCloudDocumentaiV1DocumentEntity: + properties: + mentionId: type: string - resource: - description: A related resource to this operation. + description: Optional. Deprecated. Use `id` field instead. + normalizedValue: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + description: >- + Optional. Normalized entity value. Absent if the extracted value + could not be converted or the type (e.g. address) is not supported + for certain parsers. This field is also only populated for certain + supported document types. + redacted: + type: boolean + description: >- + Optional. Whether the entity will be redacted for de-identification + purposes. + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: Optional. The history of this annotation. + confidence: + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + format: float + type: number + textAnchor: + description: >- + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + type: type: string - updateTime: - description: The last update time of the operation. + description: Required. Entity type from a schema e.g. `Address`. + mentionText: + description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. type: string - format: google-datetime - createTime: - description: The creation time of the operation. - format: google-datetime + pageAnchor: + description: >- + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' + properties: + type: array + description: >- + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + id: type: string + description: >- + Optional. Canonical id. This will be a unique value in the entity + list for this document. type: object - GoogleCloudDocumentaiV1EvaluationReference: - id: GoogleCloudDocumentaiV1EvaluationReference + id: GoogleCloudDocumentaiV1DocumentEntity + description: >- + An entity that could be a phrase in the text or a property that belongs + to the document. It is a known entity type, such as a person, an + organization, or location. + GoogleCloudDocumentaiV1DocumentTextAnchor: + type: object + description: Text reference indexing into the Document.text. + id: GoogleCloudDocumentaiV1DocumentTextAnchor properties: - aggregateMetrics: - description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching on. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - operation: - description: The resource name of the Long Running Operation for the evaluation. + content: type: string - aggregateMetricsExact: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching off. - evaluation: - type: string - description: The resource name of the evaluation. + Contains the content of the text span so that users do not have to + look it up in the text_segments. It is always populated for + formFields. + textSegments: + description: The text segments from the Document.text. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + type: array + GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: + description: The input data used to train a new ProcessorVersion. type: object - description: >- - Gives a short summary of an evaluation, and links to the evaluation - itself. - GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: - description: >- - The long-running operation metadata for updating the human review - configuration. + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData properties: - commonMetadata: - description: The basic metadata of the long-running operation. + testDocuments: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The documents used for testing the trained version. + trainingDocuments: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The documents used for training the new version. + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: type: object - id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata - GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: properties: + trainingDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: The training dataset validation information. commonMetadata: description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + testDatasetValidation: + description: The test dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. + GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse + description: Response message for the SetDefaultProcessorVersion method. + properties: {} type: object - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata + GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: description: >- The long-running operation metadata for the DeployProcessorVersion method. - GoogleCloudLocationLocation: - type: object - description: A resource that represents a Google Cloud location. - id: GoogleCloudLocationLocation + id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata properties: - displayName: - type: string - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' - type: string - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - metadata: - type: object - description: >- - Service-specific metadata. For example the available capacity at the - given location. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - labels: - additionalProperties: - type: string - type: object - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' type: object - description: Font and other text style attributes. + GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: + type: object + description: Configurations for premium OCR features. + id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures properties: - fontType: - type: string - description: Name or style of the font. - fontSize: - description: Font size in points (`1` point is `¹⁄₇₂` inches). - format: int32 - type: integer - bold: - type: boolean - description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - underlined: - description: Whether the text is underlined. - type: boolean - subscript: - description: Whether the text is a subscript. This feature is not supported yet. - type: boolean - superscript: - description: >- - Whether the text is a superscript. This feature is not supported - yet. - type: boolean - italic: - description: Whether the text is italic. - type: boolean - letterSpacing: - format: double - description: Letter spacing in points. - type: number - fontWeight: - description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - format: int32 - type: integer - smallcaps: + enableSelectionMarkDetection: description: >- - Whether the text is in small caps. This feature is not supported - yet. + Turn on selection mark detector in OCR engine. Only available in OCR + 2.0 (and later) processors. type: boolean - strikeout: + enableMathOcr: type: boolean - description: >- - Whether the text is strikethrough. This feature is not supported - yet. - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - handwritten: + description: Turn on the model that can extract LaTeX math formulas. + computeStyleInfo: type: boolean - description: Whether the text is handwritten. - pixelFontSize: - format: double - type: number - description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse + description: Turn on font identification model and return font style information. + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The common metadata about the operation. type: object - properties: {} - description: Response of the batch move documents operation. - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: + description: Metadata message associated with the ExportProcessorVersion operation. + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata + GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: + description: The long-running operation metadata for the EnableProcessor method. type: object - description: Metadata of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata properties: commonMetadata: $ref: >- @@ -4636,45 +4748,35 @@ components: description: The basic metadata of the long-running operation. GoogleCloudDocumentaiV1ProcessorType: properties: - allowCreation: - description: >- - Whether the processor type allows creation. If true, users can - create a processor of this processor type. Otherwise, users need to - request access. - type: boolean - name: - description: >- - The resource name of the processor type. Format: - `projects/{project}/processorTypes/{processor_type}` - type: string type: + type: string description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' + category: type: string + description: The processor category, used by UI to group processor types. availableLocations: + description: The locations in which this processor is available. + type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - type: array - description: The locations in which this processor is available. - category: + name: + description: >- + The resource name of the processor type. Format: + `projects/{project}/processorTypes/{processor_type}` type: string - description: The processor category, used by UI to group processor types. + allowCreation: + type: boolean + description: >- + Whether the processor type allows creation. If true, users can + create a processor of this processor type. Otherwise, users need to + request access. sampleDocumentUris: + description: A set of Cloud Storage URIs of sample documents for this processor. items: type: string - description: A set of Cloud Storage URIs of sample documents for this processor. type: array launchStage: - description: Launch stage of the processor type - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -4714,367 +4816,253 @@ components: [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. type: string + description: Launch stage of the processor type + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: object id: GoogleCloudDocumentaiV1ProcessorType description: >- A processor type is responsible for performing a certain document understanding task on a certain type of document. - type: object - GoogleCloudDocumentaiV1beta3RevisionRef: - type: object - properties: - latestProcessorVersion: - type: string - description: >- - Reads the revision generated by the processor version. The format - takes the full resource name of processor version. - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - revisionId: - type: string - description: Reads the revision given by the id. - revisionCase: - description: Reads the revision by the predefined case. - enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION - enumDescriptions: - - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. - - The latest revision made by a human. - - The latest revision based on timestamp. - - The first (OCR) revision. - type: string - description: The revision reference specifies which revision on the document to read. - id: GoogleCloudDocumentaiV1beta3RevisionRef - GoogleCloudDocumentaiV1GcsPrefix: - type: object - properties: - gcsUriPrefix: - type: string - description: The URI prefix. - id: GoogleCloudDocumentaiV1GcsPrefix - description: Specifies all documents on Cloud Storage with a common prefix. - GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: - type: object - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse - properties: {} - description: The response proto of ResyncDataset method. GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: + description: The long-running operation metadata for DeleteLabelerPool. id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - description: The long-running operation metadata for DeleteLabelerPool. - type: object - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - type: object - description: >- - The validation status of each import config. Status is set to an error - if there are no documents to import in the `import_config`, or `OK` if - the operation will try to proceed with at least one document. - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The validation status of import config. - inputGcsSource: - description: The source Cloud Storage URI specified in the import config. - type: string - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - description: Represents a row in a table. - properties: - cells: - description: A table row is a list of table cells. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: + GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader properties: - text: - description: Header in text format. - type: string - pageSpan: + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the header. - description: Represents the page header associated with the chunk. - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - description: Image Quality Defects + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata + GoogleCloudDocumentaiV1OcrConfigHints: + id: GoogleCloudDocumentaiV1OcrConfigHints properties: - type: - type: string - description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` - confidence: - format: float + languageHints: + items: + type: string description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - type: number + List of BCP-47 language codes to use for OCR. In most cases, not + specifying it yields the best results since it enables automatic + language detection. For languages based on the Latin alphabet, + setting hints is not needed. In rare cases, when the language of the + text in the image is known, setting a hint will help get better + results (although it will be a significant hindrance if the hint is + wrong). + type: array + description: Hints for OCR Engine type: object - GoogleCloudDocumentaiV1DeleteProcessorMetadata: - description: The long-running operation metadata for the DeleteProcessor method. - id: GoogleCloudDocumentaiV1DeleteProcessorMetadata + GoogleCloudDocumentaiUiv1beta3DocumentId: properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + unmanagedDocId: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + description: A document id within unmanaged dataset. + gcsManagedDocId: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId + description: A document id within user-managed Cloud Storage. + revisionRef: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' + description: Points to a specific revision of the document if set. + id: GoogleCloudDocumentaiUiv1beta3DocumentId type: object - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: + description: Document Identifier. + GoogleCloudDocumentaiV1DocumentPageTableTableCell: type: object + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: A cell representation inside the table. properties: - displayName: - description: User defined name for the property. - type: string - name: - type: string - description: >- - The name of the property. Follows the same guidelines as the - EntityType name. - occurrenceType: - description: >- - Occurrence type limits the number of instances an entity type - appears in the document. - enumDescriptions: - - Unspecified occurrence type. - - >- - There will be zero or one instance of this entity type. The same - entity instance may be mentioned multiple times. - - The entity type will appear zero or multiple times. - - >- - The entity type will only appear exactly once. The same entity - instance may be mentioned multiple times. - - The entity type will appear once or more times. - enum: - - OCCURRENCE_TYPE_UNSPECIFIED - - OPTIONAL_ONCE - - OPTIONAL_MULTIPLE - - REQUIRED_ONCE - - REQUIRED_MULTIPLE - type: string - valueType: - description: >- - A reference to the value type of the property. This type is subject - to the same conventions as the `Entity.base_types` field. - type: string - description: Defines properties that can be part of the entity type. - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: - properties: + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array colSpan: + format: int32 description: How many columns this cell spans. + type: integer + rowSpan: + description: How many rows this cell spans. format: int32 type: integer - blocks: + layout: + description: Layout for TableCell. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + properties: {} + type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + type: object + id: >- + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + properties: + datasetErrors: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - A table cell is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. + documentErrors: + description: >- + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. type: array - rowSpan: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + datasetErrorCount: + format: int32 + description: The total number of dataset errors. type: integer - description: How many rows this cell spans. + documentErrorCount: format: int32 - type: object - description: Represents a cell in a table row. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - GoogleCloudDocumentaiV1DocumentOutputConfig: - type: object + description: The total number of document errors. + type: integer + GoogleCloudDocumentaiV1DocumentEntityRelation: + id: GoogleCloudDocumentaiV1DocumentEntityRelation properties: - gcsOutputConfig: - description: Output config to write the results to Cloud Storage. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig - id: GoogleCloudDocumentaiV1DocumentOutputConfig - description: >- - Config that controls the output of documents. All documents will be - written as a JSON file. - GoogleCloudDocumentaiV1NormalizedVertex: - description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. + subjectId: + type: string + description: Subject entity id. + objectId: + description: Object entity id. + type: string + relation: + type: string + description: Relationship description. + description: Relationship between Entities. type: object - id: GoogleCloudDocumentaiV1NormalizedVertex - properties: - 'y': - description: Y coordinate (starts from the top of the image). - format: float - type: number - x: - type: number - format: float - description: X coordinate. - GoogleCloudDocumentaiV1DocumentPageSymbol: - description: A detected symbol. + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: type: object - id: GoogleCloudDocumentaiV1DocumentPageSymbol + description: Defines the a list of enum values. + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues properties: - layout: - description: Layout for Symbol. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: - description: A list of detected languages together with confidence. + values: + description: The individual values that this enum values type can include. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: + type: string + GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: + id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics properties: - status: - description: >- - The status of resyncing the document with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. - $ref: '#/components/schemas/GoogleRpcStatus' - documentInconsistencyType: - description: The type of document inconsistency. - type: string - enum: - - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED - - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO - - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA - - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE - enumDescriptions: - - Default value. - - The document proto is invalid. - - Indexed docproto metadata is mismatched. - - The page image or thumbnails are missing. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document identifier. - id: >- - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus - description: Resync status for each document per inconsistency type. + metrics: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + description: The metrics at the specific confidence level. + confidenceLevel: + format: float + description: The confidence level. + type: number type: object - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + description: Evaluations metrics, at a specific confidence level. + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - description: Represents the page footer associated with the chunk. properties: - text: - type: string - description: Footer in text format. - pageSpan: - description: Page span of the footer. + trainingDatasetValidation: + description: The training dataset validation information. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: - id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata - description: The long-running operation metadata for the DisableProcessor method. - properties: - commonMetadata: + #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + testDatasetValidation: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - type: object - GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: - properties: + #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + description: The test dataset validation information. commonMetadata: - description: The basic metadata for the long-running operation. + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata - type: object + GoogleCloudDocumentaiV1DocumentProvenance: description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: - description: The status of each individual document in the import process. - properties: - inputGcsSource: - type: string - description: The source Cloud Storage URI of the document. - outputDocumentId: - description: >- - The document id of imported document if it was successful, otherwise - empty. - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the importing of the document. - outputGcsDestination: - type: string - description: >- - The output_gcs_destination of the processed document if it was - successful, otherwise empty. - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + Structure to identify provenance relationships between annotations in + different revisions. type: object - GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: properties: - enableMathOcr: - type: boolean - description: Turn on the model that can extract LaTeX math formulas. - enableSelectionMarkDetection: - type: boolean + id: description: >- - Turn on selection mark detector in OCR engine. Only available in OCR - 2.0 (and later) processors. - computeStyleInfo: - description: Turn on font identification model and return font style information. - type: boolean - type: object - id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures - description: Configurations for premium OCR features. - GoogleCloudDocumentaiV1GcsDocuments: - id: GoogleCloudDocumentaiV1GcsDocuments - type: object - description: Specifies a set of documents on Cloud Storage. - properties: - documents: - description: The list of documents. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + The Id of this operation. Needs to be unique within the scope of the + revision. + type: integer + deprecated: true + format: int32 + revision: + deprecated: true + description: The index of the revision that produced this element. + format: int32 + type: integer + parents: + description: References to the original elements that are replaced. type: array - GoogleCloudDocumentaiV1DocumentChunkedDocument: - id: GoogleCloudDocumentaiV1DocumentChunkedDocument - description: Represents the chunks that the document is divided into. - properties: - chunks: - description: List of chunks. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - type: array - type: object - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: - description: The response for TrainProcessorVersion. - properties: - processorVersion: - description: The resource name of the processor version produced by training. + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + type: type: string - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse - type: object - parameters: - callback: - description: JSONP - in: query - name: callback - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string + enumDescriptions: + - >- + Operation type unspecified. If no operation is specified a + provenance entry is simply used to match against a `parent`. + - Add an element. + - Remove an element identified by `parent`. + - >- + Updates any fields within the given provenance scope of the + message. It overwrites the fields rather than replacing them. Use + this when you want to update a field value of an entity without + also updating all the child properties. + - Currently unused. Replace an element identified by `parent`. + - >- + Deprecated. Request human review for the element identified by + `parent`. + - >- + Deprecated. Element is reviewed and approved at human review, + confidence will be set to 1.0. + - Deprecated. Element is skipped in the validation process. + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED + description: The type of provenance operation. + id: GoogleCloudDocumentaiV1DocumentProvenance + parameters: quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -5094,18 +5082,6 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean _.xgafv: description: V1 error format. in: query @@ -5115,18 +5091,6 @@ components: enum: - '1' - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -5136,12 +5100,48 @@ components: name: key schema: type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string x-stackQL-resources: operations: id: google.documentai.operations @@ -5161,21 +5161,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_list: + projects_locations_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - projects_locations_operations_get: + projects_locations_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations projects_operations_get: operation: $ref: >- @@ -5197,109 +5197,125 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/operations_delete - processors: - id: google.documentai.processors - name: processors - title: Processors + human_review_config: + id: google.documentai.human_review_config + name: human_review_config + title: Human_review_config methods: - projects_locations_processors_disable: + projects_locations_processors_human_review_config_review_document: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:disable/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1humanReviewConfig:reviewDocument/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_batch_process: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + processor_versions: + id: google.documentai.processor_versions + name: processor_versions + title: Processor_versions + methods: + projects_locations_processors_processor_versions_deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:batchProcess/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_enable: + projects_locations_processors_processor_versions_undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:enable/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_list: + projects_locations_processors_processor_versions_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:process/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processors - projects_locations_processors_create: + projects_locations_processors_processor_versions_batch_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_delete: + projects_locations_processors_processor_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_get: + objectKey: $.processorVersions + projects_locations_processors_processor_versions_train: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions:train/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_process: + projects_locations_processors_processor_versions_evaluate_processor_version: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:process/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:evaluateProcessorVersion/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_set_default_processor_version: + projects_locations_processors_processor_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:setDefaultProcessorVersion/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_processor_versions_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_get - - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_list - insert: + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_get - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_create + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_list + insert: [] update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_delete evaluations: id: google.documentai.evaluations name: evaluations title: Evaluations methods: - projects_locations_processors_processor_versions_evaluations_list: + projects_locations_processors_processor_versions_evaluations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations~1{evaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.evaluations - projects_locations_processors_processor_versions_evaluations_get: + projects_locations_processors_processor_versions_evaluations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations~1{evaluationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.evaluations sqlVerbs: select: - $ref: >- @@ -5310,105 +5326,89 @@ components: update: [] replace: [] delete: [] - processor_versions: - id: google.documentai.processor_versions - name: processor_versions - title: Processor_versions + processors: + id: google.documentai.processors + name: processors + title: Processors methods: - projects_locations_processors_processor_versions_delete: + projects_locations_processors_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_get: + projects_locations_processors_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_deploy: + projects_locations_processors_disable: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_batch_process: + projects_locations_processors_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:batchProcess/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_list: + projects_locations_processors_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processorVersions - projects_locations_processors_processor_versions_train: + objectKey: $.processors + projects_locations_processors_batch_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions:train/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_undeploy: + projects_locations_processors_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:process/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_process: + projects_locations_processors_set_default_processor_version: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:process/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:setDefaultProcessorVersion/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_evaluate_processor_version: + projects_locations_processors_enable: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:evaluateProcessorVersion/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_get + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_get - $ref: >- - #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_list - insert: [] + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_list + insert: + - $ref: >- + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_create update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_delete - human_review_config: - id: google.documentai.human_review_config - name: human_review_config - title: Human_review_config - methods: - projects_locations_processors_human_review_config_review_document: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1humanReviewConfig:reviewDocument/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete processor_types: id: google.documentai.processor_types name: processor_types @@ -5479,17 +5479,17 @@ components: paths: /v1/operations/{operationsId}: parameters: &ref_1 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' delete: description: >- Deletes a long-running operation. This method indicates that the client @@ -5515,17 +5515,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: parameters: *ref_1 post: - description: Disables a processor - operationId: documentai.projects.locations.processors.disable + description: >- + Send a document for Human Review. The input document should be processed + by the specified processor. + operationId: >- + documentai.projects.locations.processors.humanReviewConfig.reviewDocument requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DisableProcessorRequest + #/components/schemas/GoogleCloudDocumentaiV1ReviewDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5554,18 +5557,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:deploy: parameters: *ref_1 post: - description: >- - LRO endpoint to batch process many documents. The output is written to - Cloud Storage as JSON in the [Document] format. - operationId: documentai.projects.locations.processors.batchProcess + description: Deploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.deploy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5594,17 +5596,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: parameters: *ref_1 post: - description: Enables a processor - operationId: documentai.projects.locations.processors.enable + description: Undeploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.undeploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest + #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5633,11 +5640,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors: + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process: parameters: *ref_1 - get: - description: Lists all processors which belong to this project. - operationId: documentai.projects.locations.processors.list + post: + description: Processes a single document. + operationId: documentai.projects.locations.processors.processorVersions.process + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5649,8 +5666,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorsResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' parameters: - in: path name: projectsId @@ -5662,29 +5678,28 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: processorsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: processorVersionsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: + parameters: *ref_1 post: description: >- - Creates a processor from the ProcessorType provided. The processor will - be at `ENABLED` state by default after its creation. Note that this - method requires the `documentai.processors.create` permission on the - project, which is highly privileged. A user or service account with this - permission can create new processors that can interact with any gcs - bucket in your project. - operationId: documentai.projects.locations.processors.create + LRO endpoint to batch process many documents. The output is written to + Cloud Storage as JSON in the [Document] format. + operationId: documentai.projects.locations.processors.processorVersions.batchProcess requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5696,7 +5711,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5708,13 +5723,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: + - in: path + name: processorsId + required: true + schema: + type: string + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: parameters: *ref_1 - delete: - description: >- - Deletes the processor, unloads all deployed model artifacts if it was - enabled and then deletes all artifacts associated with this processor. - operationId: documentai.projects.locations.processors.delete + get: + description: Lists all versions of a processor. + operationId: documentai.projects.locations.processors.processorVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5726,7 +5749,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse parameters: - in: path name: projectsId @@ -5743,9 +5767,28 @@ paths: required: true schema: type: string - get: - description: Gets a processor detail. - operationId: documentai.projects.locations.processors.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: + parameters: *ref_1 + post: + description: >- + Trains a new processor version. Operation metadata is returned as + TrainProcessorVersionMetadata. + operationId: documentai.projects.locations.processors.processorVersions.train + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5757,7 +5800,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5774,16 +5817,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion: parameters: *ref_1 post: - description: Processes a single document. - operationId: documentai.projects.locations.processors.process + description: >- + Evaluates a ProcessorVersion against annotated documents, producing an + Evaluation. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5795,7 +5842,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5812,19 +5859,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}: parameters: *ref_1 - post: + delete: description: >- - Set the default (active) version of a Processor that will be used in - ProcessDocument and BatchProcessDocuments. - operationId: documentai.projects.locations.processors.setDefaultProcessorVersion - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + Deletes the processor version, all artifacts under the processor version + will be deleted. + operationId: documentai.projects.locations.processors.processorVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5853,12 +5899,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: - parameters: *ref_1 + - in: path + name: processorVersionsId + required: true + schema: + type: string get: - description: Retrieves a set of evaluations for a given processor version. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluations.list + description: Gets a processor version detail. + operationId: documentai.projects.locations.processors.processorVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5870,8 +5918,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' parameters: - in: path name: projectsId @@ -5893,15 +5940,6 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}: parameters: *ref_1 get: @@ -5946,13 +5984,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: parameters: *ref_1 - delete: - description: >- - Deletes the processor version, all artifacts under the processor version - will be deleted. - operationId: documentai.projects.locations.processors.processorVersions.delete + get: + description: Retrieves a set of evaluations for a given processor version. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5964,7 +6001,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse parameters: - in: path name: projectsId @@ -5986,9 +6024,22 @@ paths: required: true schema: type: string - get: - description: Gets a processor version detail. - operationId: documentai.projects.locations.processors.processorVersions.get + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: + parameters: *ref_1 + delete: + description: >- + Deletes the processor, unloads all deployed model artifacts if it was + enabled and then deletes all artifacts associated with this processor. + operationId: documentai.projects.locations.processors.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6000,7 +6051,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6017,22 +6068,9 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:deploy: - parameters: *ref_1 - post: - description: Deploys the processor version. - operationId: documentai.projects.locations.processors.processorVersions.deploy - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DeployProcessorVersionRequest + get: + description: Gets a processor detail. + operationId: documentai.projects.locations.processors.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6044,7 +6082,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' parameters: - in: path name: projectsId @@ -6061,23 +6099,17 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: parameters: *ref_1 post: - description: >- - LRO endpoint to batch process many documents. The output is written to - Cloud Storage as JSON in the [Document] format. - operationId: documentai.projects.locations.processors.processorVersions.batchProcess + description: Disables a processor + operationId: documentai.projects.locations.processors.disable requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DisableProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6106,16 +6138,22 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: + /v1/projects/{projectsId}/locations/{locationsId}/processors: parameters: *ref_1 - get: - description: Lists all versions of a processor. - operationId: documentai.projects.locations.processors.processorVersions.list + post: + description: >- + Creates a processor from the ProcessorType provided. The processor will + be at `ENABLED` state by default after its creation. Note that this + method requires the `documentai.processors.create` permission on the + project, which is highly privileged. A user or service account with this + permission can create new processors that can interact with any gcs + bucket in your project. + operationId: documentai.projects.locations.processors.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6127,8 +6165,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' parameters: - in: path name: projectsId @@ -6140,33 +6177,9 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: - parameters: *ref_1 - post: - description: >- - Trains a new processor version. Operation metadata is returned as - TrainProcessorVersionMetadata. - operationId: documentai.projects.locations.processors.processorVersions.train - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest + get: + description: Lists all processors which belong to this project. + operationId: documentai.projects.locations.processors.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6178,7 +6191,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorsResponse parameters: - in: path name: projectsId @@ -6190,22 +6204,27 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess: parameters: *ref_1 post: - description: Undeploys the processor version. - operationId: documentai.projects.locations.processors.processorVersions.undeploy + description: >- + LRO endpoint to batch process many documents. The output is written to + Cloud Storage as JSON in the [Document] format. + operationId: documentai.projects.locations.processors.batchProcess requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6234,16 +6253,11 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: parameters: *ref_1 post: description: Processes a single document. - operationId: documentai.projects.locations.processors.processorVersions.process + operationId: documentai.projects.locations.processors.process requestBody: content: application/json: @@ -6277,25 +6291,19 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: parameters: *ref_1 post: description: >- - Evaluates a ProcessorVersion against annotated documents, producing an - Evaluation. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion + Set the default (active) version of a Processor that will be used in + ProcessDocument and BatchProcessDocuments. + operationId: documentai.projects.locations.processors.setDefaultProcessorVersion requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6324,25 +6332,17 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: parameters: *ref_1 post: - description: >- - Send a document for Human Review. The input document should be processed - by the specified processor. - operationId: >- - documentai.projects.locations.processors.humanReviewConfig.reviewDocument + description: Enables a processor + operationId: documentai.projects.locations.processors.enable requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ReviewDocumentRequest + #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6371,20 +6371,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}: parameters: *ref_1 - post: - 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`. - operationId: documentai.projects.locations.operations.cancel + get: + description: Gets a processor type detail. + operationId: documentai.projects.locations.processorTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6396,7 +6387,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' parameters: - in: path name: projectsId @@ -6409,17 +6400,15 @@ paths: schema: type: string - in: path - name: operationsId + name: processorTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: documentai.projects.locations.operations.list + description: Lists the processor types that exist. + operationId: documentai.projects.locations.processorTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6431,7 +6420,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorTypesResponse parameters: - in: path name: projectsId @@ -6447,23 +6437,25 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: 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. - operationId: documentai.projects.locations.operations.get + 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`. + operationId: documentai.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6475,7 +6467,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6492,11 +6484,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets a processor type detail. - operationId: documentai.projects.locations.processorTypes.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. + operationId: documentai.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6508,7 +6503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6521,15 +6516,17 @@ paths: schema: type: string - in: path - name: processorTypesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: + /v1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_1 get: - description: Lists the processor types that exist. - operationId: documentai.projects.locations.processorTypes.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: documentai.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6541,8 +6538,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorTypesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -6558,6 +6554,10 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -6591,11 +6591,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations: + /v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes: parameters: *ref_1 get: - description: Lists information about the supported locations for this service. - operationId: documentai.projects.locations.list + description: >- + Fetches processor types. Note that we don't use ListProcessorTypes here, + because it isn't paginated. + operationId: documentai.projects.locations.fetchProcessorTypes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6607,33 +6609,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1FetchProcessorTypesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes: + /v1/projects/{projectsId}/locations: parameters: *ref_1 get: - description: >- - Fetches processor types. Note that we don't use ListProcessorTypes here, - because it isn't paginated. - operationId: documentai.projects.locations.fetchProcessorTypes + description: Lists information about the supported locations for this service. + operationId: documentai.projects.locations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6645,17 +6638,24 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1FetchProcessorTypesResponse + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string /v1/projects/{projectsId}/operations/{operationsId}: diff --git a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml index 9cda12c1..9efc5231 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml @@ -34,29 +34,38 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudEssentialcontactsV1SendTestMessageRequest: - id: GoogleCloudEssentialcontactsV1SendTestMessageRequest + GoogleCloudEssentialcontactsV1ListContactsResponse: + id: GoogleCloudEssentialcontactsV1ListContactsResponse + type: object properties: contacts: items: - type: string + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' type: array + description: The contacts for the specified resource. + nextPageToken: + description: >- + If there are 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` and the rest of the parameters the same as the original + request. + type: string + description: Response message for the ListContacts method. + GoogleCloudEssentialcontactsV1SendTestMessageRequest: + id: GoogleCloudEssentialcontactsV1SendTestMessageRequest + description: Request message for the SendTestMessage method. + properties: + contacts: description: >- Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} + type: array + items: + type: string notificationCategory: - enum: - - NOTIFICATION_CATEGORY_UNSPECIFIED - - ALL - - SUSPENSION - - SECURITY - - TECHNICAL - - BILLING - - LEGAL - - PRODUCT_UPDATES - - TECHNICAL_INCIDENTS enumDescriptions: - Notification category is unrecognized or unspecified. - >- @@ -81,61 +90,47 @@ components: - >- Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL. - type: string description: >- Required. The notification category to send the test message for. All contacts must be subscribed to this category. + type: string + enum: + - NOTIFICATION_CATEGORY_UNSPECIFIED + - ALL + - SUSPENSION + - SECURITY + - TECHNICAL + - BILLING + - LEGAL + - PRODUCT_UPDATES + - TECHNICAL_INCIDENTS type: object - description: Request message for the SendTestMessage method. - GoogleCloudEssentialcontactsV1ListContactsResponse: - type: object - id: GoogleCloudEssentialcontactsV1ListContactsResponse + GoogleCloudEssentialcontactsV1ComputeContactsResponse: + id: GoogleCloudEssentialcontactsV1ComputeContactsResponse + description: Response message for the ComputeContacts method. properties: - nextPageToken: - type: string - description: >- - If there are 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` and the rest of the parameters the same as the original - request. contacts: items: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + description: >- + All contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any + parent resources. type: array - description: The contacts for the specified resource. - description: Response message for the ListContacts method. - GoogleCloudEssentialcontactsV1ComputeContactsResponse: - description: Response message for the ComputeContacts method. - properties: nextPageToken: - type: string description: >- If there are 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` and the rest of the parameters the same as the original request. - contacts: - type: array - description: >- - All contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any - parent resources. - items: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' - id: GoogleCloudEssentialcontactsV1ComputeContactsResponse + type: string type: object GoogleCloudEssentialcontactsV1Contact: type: object + description: A contact that will receive notifications from Google Cloud. + id: GoogleCloudEssentialcontactsV1Contact properties: - languageTag: - type: string - description: >- - Required. The preferred language for notifications, as a ISO 639-1 - language code. See [Supported - languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) - for a list of supported languages. validationState: description: >- Output only. The validity of the contact. A contact is considered @@ -149,28 +144,23 @@ components: - >- The contact is considered invalid. This may become the state if the contact's email is found to be unreachable. + readOnly: true type: string enum: - VALIDATION_STATE_UNSPECIFIED - VALID - INVALID - readOnly: true + email: + description: >- + Required. The email address to send notifications to. The email + address does not need to be a Google Account. + type: string notificationCategorySubscriptions: type: array description: >- Required. The categories of notifications that the contact will receive communications for. items: - enum: - - NOTIFICATION_CATEGORY_UNSPECIFIED - - ALL - - SUSPENSION - - SECURITY - - TECHNICAL - - BILLING - - LEGAL - - PRODUCT_UPDATES - - TECHNICAL_INCIDENTS enumDescriptions: - Notification category is unrecognized or unspecified. - >- @@ -195,87 +185,75 @@ components: - >- Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL. + enum: + - NOTIFICATION_CATEGORY_UNSPECIFIED + - ALL + - SUSPENSION + - SECURITY + - TECHNICAL + - BILLING + - LEGAL + - PRODUCT_UPDATES + - TECHNICAL_INCIDENTS type: string validateTime: - format: google-datetime + type: string description: >- The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. + format: google-datetime + languageTag: + description: >- + Required. The preferred language for notifications, as a ISO 639-1 + language code. See [Supported + languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) + for a list of supported languages. type: string name: - readOnly: true description: >- Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} + readOnly: true type: string - email: - description: >- - Required. The email address to send notifications to. The email - address does not need to be a Google Account. - type: string - id: GoogleCloudEssentialcontactsV1Contact - description: A contact that will receive notifications from Google Cloud. GoogleProtobufEmpty: + id: GoogleProtobufEmpty + properties: {} + type: object description: >- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - type: object - id: GoogleProtobufEmpty parameters: - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: uploadType + name: upload_protocol schema: type: string - _.xgafv: - description: V1 error format. + 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. in: query - name: $.xgafv + name: key schema: type: string - enum: - - '1' - - '2' - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean callback: description: JSONP in: query name: callback schema: type: string - key: + quotaUser: 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. - in: query - name: key - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: oauth_token + name: quotaUser schema: type: string fields: @@ -284,21 +262,43 @@ components: name: fields schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: quotaUser + name: uploadType schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: upload_protocol + name: prettyPrint + schema: + type: boolean + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' access_token: description: OAuth access token. in: query @@ -311,48 +311,51 @@ components: name: contacts title: Contacts methods: - projects_contacts_compute: + organizations_contacts_get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_create: + organizations_contacts_patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_list: + organizations_contacts_delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contacts - projects_contacts_send_test_message: + organizations_contacts_compute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts:sendTestMessage/post + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:compute/get response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_get: + organizations_contacts_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_delete: + organizations_contacts_list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/get' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_patch: + objectKey: $.contacts + organizations_contacts_send_test_message: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/patch' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post response: mediaType: application/json openAPIDocKey: '200' @@ -374,9 +377,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_compute: + folders_contacts_send_test_message: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:sendTestMessage/post' response: mediaType: application/json openAPIDocKey: '200' @@ -393,116 +396,110 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_send_test_message: + folders_contacts_compute: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:sendTestMessage/post' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_create: + projects_contacts_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_list: + objectKey: $.contacts + projects_contacts_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contacts - organizations_contacts_delete: + projects_contacts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_get: + projects_contacts_patch: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/patch' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_patch: + projects_contacts_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/patch + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_compute: + projects_contacts_compute: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:compute/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_send_test_message: + projects_contacts_send_test_message: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post + #/paths/~1v1~1projects~1{projectsId}~1contacts:sendTestMessage/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_get + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_get - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_get - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_get + #/components/x-stackQL-resources/contacts/methods/projects_contacts_get - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_list + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_list - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list + #/components/x-stackQL-resources/contacts/methods/projects_contacts_list insert: - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_create + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_create - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_create - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_create + #/components/x-stackQL-resources/contacts/methods/projects_contacts_create update: - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_patch + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_patch - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_patch - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_patch + #/components/x-stackQL-resources/contacts/methods/projects_contacts_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_delete + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_delete - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_delete - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_delete + #/components/x-stackQL-resources/contacts/methods/projects_contacts_delete paths: - /v1/projects/{projectsId}/contacts:compute: + /v1/organizations/{organizationsId}/contacts/{contactsId}: parameters: &ref_1 - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' get: - description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.projects.contacts.compute + description: Gets a single contact. + operationId: essentialcontacts.organizations.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -514,32 +511,21 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: query - name: notificationCategories - schema: - type: string - - in: query - name: pageToken + - in: path + name: contactsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/contacts: - parameters: *ref_1 - post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.projects.contacts.create + patch: + description: 'Updates a contact. Note: A contact''s email address cannot be changed.' + operationId: essentialcontacts.organizations.contacts.patch requestBody: content: application/json: @@ -559,13 +545,23 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.projects.contacts.list + - in: path + name: contactsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a contact. + operationId: essentialcontacts.organizations.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -577,36 +573,26 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: contactsId + required: true schema: type: string - /v1/projects/{projectsId}/contacts:sendTestMessage: + /v1/organizations/{organizationsId}/contacts:compute: parameters: *ref_1 - post: + get: description: >- - Allows a contact admin to send a test message to contact to verify that - it has been configured correctly. - operationId: essentialcontacts.projects.contacts.sendTestMessage - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.organizations.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -618,18 +604,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - /v1/projects/{projectsId}/contacts/{contactsId}: + - in: query + name: notificationCategories + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/contacts: parameters: *ref_1 - get: - description: Gets a single contact. - operationId: essentialcontacts.projects.contacts.get + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.organizations.contacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -644,18 +649,13 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: contactsId + name: organizationsId required: true schema: type: string - delete: - description: Deletes a contact. - operationId: essentialcontacts.projects.contacts.delete + get: + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.organizations.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -667,26 +667,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: path - name: contactsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: - description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.projects.contacts.patch + /v1/organizations/{organizationsId}/contacts:sendTestMessage: + parameters: *ref_1 + post: + description: >- + Allows a contact admin to send a test message to contact to verify that + it has been configured correctly. + operationId: essentialcontacts.organizations.contacts.sendTestMessage requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -698,23 +708,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: contactsId + name: organizationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask /v1/folders/{foldersId}/contacts/{contactsId}: parameters: *ref_1 patch: @@ -805,14 +805,19 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/contacts:compute: + /v1/folders/{foldersId}/contacts:sendTestMessage: parameters: *ref_1 - get: + post: description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.folders.contacts.compute + Allows a contact admin to send a test message to contact to verify that + it has been configured correctly. + operationId: essentialcontacts.folders.contacts.sendTestMessage + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -824,27 +829,13 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: foldersId required: true schema: type: string - - in: query - name: notificationCategories - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string /v1/folders/{foldersId}/contacts: parameters: *ref_1 get: @@ -869,15 +860,15 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string post: description: Adds a new contact for a resource. operationId: essentialcontacts.folders.contacts.create @@ -904,19 +895,14 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/contacts:sendTestMessage: + /v1/folders/{foldersId}/contacts:compute: parameters: *ref_1 - post: + get: description: >- - Allows a contact admin to send a test message to contact to verify that - it has been configured correctly. - operationId: essentialcontacts.folders.contacts.sendTestMessage - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.folders.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -928,23 +914,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path name: foldersId required: true schema: type: string - /v1/organizations/{organizationsId}/contacts: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: notificationCategories + schema: + type: string + /v1/projects/{projectsId}/contacts: parameters: *ref_1 - post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.organizations.contacts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + get: + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.projects.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -956,16 +951,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.organizations.contacts.list + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.projects.contacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -977,28 +987,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/contacts/{contactsId}: + /v1/projects/{projectsId}/contacts/{contactsId}: parameters: *ref_1 delete: description: Deletes a contact. - operationId: essentialcontacts.organizations.contacts.delete + operationId: essentialcontacts.projects.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1013,7 +1013,7 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1022,9 +1022,14 @@ paths: required: true schema: type: string - get: - description: Gets a single contact. - operationId: essentialcontacts.organizations.contacts.get + patch: + description: 'Updates a contact. Note: A contact''s email address cannot be changed.' + operationId: essentialcontacts.projects.contacts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1039,7 +1044,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1048,14 +1053,14 @@ paths: required: true schema: type: string - patch: - description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.organizations.contacts.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a single contact. + operationId: essentialcontacts.projects.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1070,7 +1075,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1079,19 +1084,14 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/contacts:compute: + /v1/projects/{projectsId}/contacts:compute: parameters: *ref_1 get: description: >- Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources. - operationId: essentialcontacts.organizations.contacts.compute + operationId: essentialcontacts.projects.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1107,14 +1107,10 @@ paths: #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: notificationCategories schema: @@ -1124,13 +1120,17 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/contacts:sendTestMessage: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/contacts:sendTestMessage: parameters: *ref_1 post: description: >- Allows a contact admin to send a test message to contact to verify that it has been configured correctly. - operationId: essentialcontacts.organizations.contacts.sendTestMessage + operationId: essentialcontacts.projects.contacts.sendTestMessage requestBody: content: application/json: @@ -1151,7 +1151,7 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml index 20807b61..095ac3b2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml @@ -2678,7 +2678,7 @@ components: name: oauth_clients title: Oauth_clients methods: - projects_locations_oauth_clients_list: + list: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients/get @@ -2686,35 +2686,35 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.oauthClients - projects_locations_oauth_clients_create: + create: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_oauth_clients_get: + get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_oauth_clients_patch: + patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_oauth_clients_delete: + delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_oauth_clients_undelete: + undelete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}:undelete/post @@ -2723,54 +2723,49 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_get - - $ref: >- - #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_list + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/get' + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_create + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_patch + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/patch' replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/oauth_clients/methods/projects_locations_oauth_clients_delete - credentials: - id: google.iam.credentials - name: credentials - title: Credentials + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/delete' + oauth_client_credentials: + id: google.iam.oauth_client_credentials + name: oauth_client_credentials + title: Oauth_client_credentials methods: - projects_locations_oauth_clients_credentials_list: + list: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_oauth_clients_credentials_create: + create: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_oauth_clients_credentials_get: + get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_oauth_clients_credentials_patch: + patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_oauth_clients_credentials_delete: + delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/delete @@ -2780,25 +2775,25 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_get + #/components/x-stackQL-resources/oauth_client_credentials/methods/get - $ref: >- - #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_list + #/components/x-stackQL-resources/oauth_client_credentials/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_create + #/components/x-stackQL-resources/oauth_client_credentials/methods/create update: - $ref: >- - #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_patch + #/components/x-stackQL-resources/oauth_client_credentials/methods/patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/credentials/methods/projects_locations_oauth_clients_credentials_delete + #/components/x-stackQL-resources/oauth_client_credentials/methods/delete workload_identity_pools: id: google.iam.workload_identity_pools name: workload_identity_pools title: Workload_identity_pools methods: - projects_locations_workload_identity_pools_list: + list: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools/get @@ -2806,35 +2801,35 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.workloadIdentityPools - projects_locations_workload_identity_pools_create: + create: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_get: + get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_patch: + patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_delete: + delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_undelete: + undelete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}:undelete/post @@ -2844,88 +2839,88 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_get + #/components/x-stackQL-resources/workload_identity_pools/methods/get - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_list + #/components/x-stackQL-resources/workload_identity_pools/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_create + #/components/x-stackQL-resources/workload_identity_pools/methods/create update: - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_patch + #/components/x-stackQL-resources/workload_identity_pools/methods/patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/workload_identity_pools/methods/projects_locations_workload_identity_pools_delete + #/components/x-stackQL-resources/workload_identity_pools/methods/delete operations: id: google.iam.operations name: operations title: Operations methods: - projects_locations_workload_identity_pools_operations_get: + get_workload_identity_pool_operations: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_namespaces_operations_get: + get_workload_identity_pool_namespace_operations: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_namespaces_managed_identities_operations_get: + get_workload_identity_pool_namespace_managed_identity_operations: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_namespaces_managed_identities_workload_sources_operations_get: + get_workload_identity_pool_namespace_managed_identity_workload_source_operations: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}~1workloadSources~1{workloadSourcesId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_operations_get: + get_workload_identity_pool_provider_operations: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_keys_operations_get: + get_workload_identity_pool_provider_key_operations: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys~1{keysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_operations_get: + get_workforce_pool_operations: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_providers_operations_get: + get_workforce_pool_provider_operations: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_providers_keys_operations_get: + get_workforce_pool_provider_key_operations: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_subjects_operations_get: + get_workforce_pool_subject_operations: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}~1operations~1{operationsId}/get @@ -2935,35 +2930,35 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_namespaces_managed_identities_workload_sources_operations_get + #/components/x-stackQL-resources/operations/methods/get_workload_identity_pool_namespace_managed_identity_workload_source_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_namespaces_managed_identities_operations_get + #/components/x-stackQL-resources/operations/methods/get_workload_identity_pool_namespace_managed_identity_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_providers_keys_operations_get + #/components/x-stackQL-resources/operations/methods/get_workload_identity_pool_provider_key_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_namespaces_operations_get + #/components/x-stackQL-resources/operations/methods/get_workload_identity_pool_namespace_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_providers_operations_get + #/components/x-stackQL-resources/operations/methods/get_workload_identity_pool_provider_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/locations_workforce_pools_providers_keys_operations_get + #/components/x-stackQL-resources/operations/methods/get_workforce_pool_provider_key_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_workload_identity_pools_operations_get + #/components/x-stackQL-resources/operations/methods/get_workload_identity_pool_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/locations_workforce_pools_providers_operations_get + #/components/x-stackQL-resources/operations/methods/get_workforce_pool_provider_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/locations_workforce_pools_subjects_operations_get + #/components/x-stackQL-resources/operations/methods/get_workforce_pool_subject_operations - $ref: >- - #/components/x-stackQL-resources/operations/methods/locations_workforce_pools_operations_get + #/components/x-stackQL-resources/operations/methods/get_workforce_pool_operations insert: [] update: [] replace: [] delete: [] - providers: - id: google.iam.providers - name: providers - title: Providers + workload_identity_pool_providers: + id: google.iam.workload_identity_pool_providers + name: workload_identity_pool_providers + title: Workload_identity_pool_providers methods: - projects_locations_workload_identity_pools_providers_list: + list: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers/get @@ -2971,116 +2966,63 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.workloadIdentityPoolProviders - projects_locations_workload_identity_pools_providers_create: + create: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_get: + get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_patch: + patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_delete: + delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_undelete: + undelete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}:undelete/post response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_providers_list: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.workforcePoolProviders - locations_workforce_pools_providers_create: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers/post - response: - mediaType: application/json - openAPIDocKey: '200' - locations_workforce_pools_providers_get: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - locations_workforce_pools_providers_patch: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - locations_workforce_pools_providers_delete: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - locations_workforce_pools_providers_undelete: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}:undelete/post - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_get - - $ref: >- - #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_list - - $ref: >- - #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_get + #/components/x-stackQL-resources/workload_identity_pool_providers/methods/get - $ref: >- - #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_list + #/components/x-stackQL-resources/workload_identity_pool_providers/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_create - - $ref: >- - #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_create + #/components/x-stackQL-resources/workload_identity_pool_providers/methods/create update: - $ref: >- - #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_patch - - $ref: >- - #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_patch + #/components/x-stackQL-resources/workload_identity_pool_providers/methods/patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/providers/methods/projects_locations_workload_identity_pools_providers_delete - - $ref: >- - #/components/x-stackQL-resources/providers/methods/locations_workforce_pools_providers_delete - keys: - id: google.iam.keys - name: keys - title: Keys + #/components/x-stackQL-resources/workload_identity_pool_providers/methods/delete + workload_identity_pool_provider_keys: + id: google.iam.workload_identity_pool_provider_keys + name: workload_identity_pool_provider_keys + title: Workload_identity_pool_provider_keys methods: - projects_locations_workload_identity_pools_providers_keys_list: + list: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys/get @@ -3088,224 +3030,123 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.workloadIdentityPoolProviderKeys - projects_locations_workload_identity_pools_providers_keys_create: + create: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_keys_get: + get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_keys_delete: + delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_workload_identity_pools_providers_keys_undelete: + undelete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1providers~1{providersId}~1keys~1{keysId}:undelete/post response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_keys_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_service_accounts_keys_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_service_accounts_keys_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_service_accounts_keys_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_service_accounts_keys_upload: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys:upload/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_service_accounts_keys_disable: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}:disable/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_service_accounts_keys_enable: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}:enable/post - response: - mediaType: application/json - openAPIDocKey: '200' - locations_workforce_pools_providers_keys_list: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.workforcePoolProviderKeys - locations_workforce_pools_providers_keys_create: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/post - response: - mediaType: application/json - openAPIDocKey: '200' - locations_workforce_pools_providers_keys_get: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - locations_workforce_pools_providers_keys_delete: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - locations_workforce_pools_providers_keys_undelete: - operation: - $ref: >- - #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}:undelete/post - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keys/methods/projects_locations_workload_identity_pools_providers_keys_get - - $ref: >- - #/components/x-stackQL-resources/keys/methods/projects_locations_workload_identity_pools_providers_keys_list - - $ref: >- - #/components/x-stackQL-resources/keys/methods/locations_workforce_pools_providers_keys_get - - $ref: >- - #/components/x-stackQL-resources/keys/methods/projects_service_accounts_keys_get + #/components/x-stackQL-resources/workload_identity_pool_provider_keys/methods/get - $ref: >- - #/components/x-stackQL-resources/keys/methods/locations_workforce_pools_providers_keys_list - - $ref: >- - #/components/x-stackQL-resources/keys/methods/projects_service_accounts_keys_list + #/components/x-stackQL-resources/workload_identity_pool_provider_keys/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/keys/methods/projects_locations_workload_identity_pools_providers_keys_create - - $ref: >- - #/components/x-stackQL-resources/keys/methods/locations_workforce_pools_providers_keys_create - - $ref: >- - #/components/x-stackQL-resources/keys/methods/projects_service_accounts_keys_create + #/components/x-stackQL-resources/workload_identity_pool_provider_keys/methods/create update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/keys/methods/projects_locations_workload_identity_pools_providers_keys_delete - - $ref: >- - #/components/x-stackQL-resources/keys/methods/locations_workforce_pools_providers_keys_delete - - $ref: >- - #/components/x-stackQL-resources/keys/methods/projects_service_accounts_keys_delete + #/components/x-stackQL-resources/workload_identity_pool_provider_keys/methods/delete service_accounts: id: google.iam.service_accounts name: service_accounts title: Service_accounts methods: - projects_service_accounts_list: + list: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1serviceAccounts/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.accounts - projects_service_accounts_create: + create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1serviceAccounts/post' response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_get: + get: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_update: + update: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/put response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_patch: + patch: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_delete: + delete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_undelete: + undelete: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:undelete/post response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_enable: + enable: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_disable: + disable: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_sign_blob: + sign_blob: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:signBlob/post response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_sign_jwt: + sign_jwt: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:signJwt/post @@ -3314,28 +3155,22 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_get - - $ref: >- - #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_list + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/get' + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_create + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_patch + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/patch' replace: - - $ref: >- - #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_update + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/update' delete: - - $ref: >- - #/components/x-stackQL-resources/service_accounts/methods/projects_service_accounts_delete + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/delete' service_accounts_iam_policies: id: google.iam.service_accounts_iam_policies name: service_accounts_iam_policies title: Service_accounts_iam_policies methods: - projects_service_accounts_get_iam_policy: + get_iam_policy: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:getIamPolicy/post @@ -3343,14 +3178,14 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_service_accounts_set_iam_policy: + set_iam_policy: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_service_accounts_test_iam_permissions: + test_iam_permissions: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:testIamPermissions/post @@ -3360,110 +3195,177 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/service_accounts_iam_policies/methods/projects_service_accounts_get_iam_policy + #/components/x-stackQL-resources/service_accounts_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/service_accounts_iam_policies/methods/projects_service_accounts_set_iam_policy + #/components/x-stackQL-resources/service_accounts_iam_policies/methods/set_iam_policy delete: [] + service_account_keys: + id: google.iam.service_account_keys + name: service_account_keys + title: Service_account_keys + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.keys + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}:disable/post + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}:enable/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_account_keys/methods/get' + - $ref: '#/components/x-stackQL-resources/service_account_keys/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/service_account_keys/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/service_account_keys/methods/delete roles: id: google.iam.roles name: roles title: Roles methods: - projects_roles_list: + list_project_roles: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.roles - projects_roles_create: + create_project_roles: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles/post' response: mediaType: application/json openAPIDocKey: '200' - projects_roles_get: + get_project_roles: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles~1{rolesId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_roles_patch: + patch_project_roles: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles~1{rolesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - projects_roles_delete: + delete_project_roles: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1roles~1{rolesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - projects_roles_undelete: + undelete_project_roles: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1roles~1{rolesId}:undelete/post response: mediaType: application/json openAPIDocKey: '200' - roles_query_grantable_roles: + query_grantable_roles: operation: $ref: '#/paths/~1v1~1roles:queryGrantableRoles/post' response: mediaType: application/json openAPIDocKey: '200' - roles_list: + list: operation: $ref: '#/paths/~1v1~1roles/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.roles - roles_get: + get: operation: $ref: '#/paths/~1v1~1roles~1{rolesId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_roles_list: + list_org_roles: operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1roles/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.roles - organizations_roles_create: + create_org_roles: operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1roles/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_roles_get: + get_org_roles: operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_roles_patch: + patch_org_roles: operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_roles_delete: + delete_org_roles: operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_roles_undelete: + undelete_org_roles: operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}:undelete/post @@ -3472,70 +3374,64 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/roles/methods/projects_roles_get' - - $ref: >- - #/components/x-stackQL-resources/roles/methods/organizations_roles_get - - $ref: '#/components/x-stackQL-resources/roles/methods/projects_roles_list' - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_get' - - $ref: >- - #/components/x-stackQL-resources/roles/methods/organizations_roles_list - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_list' + - $ref: '#/components/x-stackQL-resources/roles/methods/get_project_roles' + - $ref: '#/components/x-stackQL-resources/roles/methods/get_org_roles' + - $ref: '#/components/x-stackQL-resources/roles/methods/list_project_roles' + - $ref: '#/components/x-stackQL-resources/roles/methods/get' + - $ref: '#/components/x-stackQL-resources/roles/methods/list_org_roles' + - $ref: '#/components/x-stackQL-resources/roles/methods/list' insert: - $ref: >- - #/components/x-stackQL-resources/roles/methods/projects_roles_create - - $ref: >- - #/components/x-stackQL-resources/roles/methods/organizations_roles_create + #/components/x-stackQL-resources/roles/methods/create_project_roles + - $ref: '#/components/x-stackQL-resources/roles/methods/create_org_roles' update: - - $ref: >- - #/components/x-stackQL-resources/roles/methods/projects_roles_patch - - $ref: >- - #/components/x-stackQL-resources/roles/methods/organizations_roles_patch + - $ref: '#/components/x-stackQL-resources/roles/methods/patch_project_roles' + - $ref: '#/components/x-stackQL-resources/roles/methods/patch_org_roles' replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/roles/methods/projects_roles_delete - - $ref: >- - #/components/x-stackQL-resources/roles/methods/organizations_roles_delete + #/components/x-stackQL-resources/roles/methods/delete_project_roles + - $ref: '#/components/x-stackQL-resources/roles/methods/delete_org_roles' workforce_pools: id: google.iam.workforce_pools name: workforce_pools title: Workforce_pools methods: - locations_workforce_pools_list: + list: operation: $ref: '#/paths/~1v1~1locations~1{locationsId}~1workforcePools/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workforcePools - locations_workforce_pools_create: + create: operation: $ref: '#/paths/~1v1~1locations~1{locationsId}~1workforcePools/post' response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_get: + get: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_patch: + patch: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_delete: + delete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_undelete: + undelete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:undelete/post @@ -3544,26 +3440,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_get - - $ref: >- - #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_list + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_create + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_patch + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/patch' replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/workforce_pools/methods/locations_workforce_pools_delete + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/delete' workforce_pools_iam_policies: id: google.iam.workforce_pools_iam_policies name: workforce_pools_iam_policies title: Workforce_pools_iam_policies methods: - locations_workforce_pools_get_iam_policy: + get_iam_policy: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:getIamPolicy/post @@ -3571,14 +3462,14 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - locations_workforce_pools_set_iam_policy: + set_iam_policy: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_test_iam_permissions: + test_iam_permissions: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:testIamPermissions/post @@ -3588,26 +3479,145 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/locations_workforce_pools_get_iam_policy + #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/locations_workforce_pools_set_iam_policy + #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/set_iam_policy delete: [] - subjects: - id: google.iam.subjects - name: subjects - title: Subjects + workforce_pool_providers: + id: google.iam.workforce_pool_providers + name: workforce_pool_providers + title: Workforce_pool_providers methods: - locations_workforce_pools_subjects_delete: + list: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workforcePoolProviders + create: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_providers/methods/get + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_providers/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_providers/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_providers/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_providers/methods/delete + workforce_pool_provider_keys: + id: google.iam.workforce_pool_provider_keys + name: workforce_pool_provider_keys + title: Workforce_pool_provider_keys + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workforcePoolProviderKeys + create: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_provider_keys/methods/get + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_provider_keys/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_provider_keys/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/workforce_pool_provider_keys/methods/delete + workforce_pool_subjects: + id: google.iam.workforce_pool_subjects + name: workforce_pool_subjects + title: Workforce_pool_subjects + methods: + delete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}/delete response: mediaType: application/json openAPIDocKey: '200' - locations_workforce_pools_subjects_undelete: + undelete: operation: $ref: >- #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}:undelete/post @@ -3621,13 +3631,13 @@ components: replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/subjects/methods/locations_workforce_pools_subjects_delete + #/components/x-stackQL-resources/workforce_pool_subjects/methods/delete permissions: id: google.iam.permissions name: permissions title: Permissions methods: - permissions_query_testable_permissions: + query_testable_permissions: operation: $ref: '#/paths/~1v1~1permissions:queryTestablePermissions/post' response: @@ -3644,13 +3654,13 @@ components: name: iam_policies title: Iam_policies methods: - iam_policies_query_auditable_services: + query_auditable_services: operation: $ref: '#/paths/~1v1~1iamPolicies:queryAuditableServices/post' response: mediaType: application/json openAPIDocKey: '200' - iam_policies_lint_policy: + lint_policy: operation: $ref: '#/paths/~1v1~1iamPolicies:lintPolicy/post' response: diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml index a50e72a9..66611bcf 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml @@ -773,10 +773,10 @@ components: - '1' - '2' x-stackQL-resources: - policies_policies: - id: google.iamv2.policies_policies - name: policies_policies - title: Policies_policies + policies: + id: google.iamv2.policies + name: policies + title: Policies methods: list_policies: operation: @@ -785,38 +785,12 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/policies_policies/methods/list_policies - insert: [] - update: [] - replace: [] - delete: [] - policies_policy: - id: google.iamv2.policies_policy - name: policies_policy - title: Policies_policy - methods: create_policy: operation: $ref: '#/paths/~1v2~1policies~1{policiesId}~1{policiesId1}/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/policies_policy/methods/create_policy - update: [] - replace: [] - delete: [] - policies: - id: google.iamv2.policies - name: policies - title: Policies - methods: get: operation: $ref: >- @@ -841,7 +815,9 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/policies/methods/get' - insert: [] + - $ref: '#/components/x-stackQL-resources/policies/methods/list_policies' + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_policy' update: [] replace: - $ref: '#/components/x-stackQL-resources/policies/methods/update' diff --git a/providers/src/googleapis.com/v00.00.00000/services/iap.yaml b/providers/src/googleapis.com/v00.00.00000/services/iap.yaml index b20a92b8..be759fbe 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iap.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iap.yaml @@ -7,7 +7,7 @@ info: title: Cloud Identity-Aware Proxy API description: Controls access to cloud applications running on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240909' + x-discovery-doc-revision: '20240916' x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/iap diff --git a/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml b/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml index f1336eeb..baf3e495 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml @@ -34,729 +34,706 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudIntegrationsV1alphaTaskConfig: - type: object - id: GoogleCloudIntegrationsV1alphaTaskConfig - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. + GoogleCloudIntegrationsV1alphaExecutionReplayInfo: properties: - task: - type: string - description: Optional. The name for the task. - failurePolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). - externalTaskType: - enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK - enumDescriptions: - - Default value. External task type is not specified - - Tasks belongs to the normal task flows - - Task belongs to the error catch task flows + replayReason: type: string - description: Optional. External task type of the task - taskTemplate: + description: reason for replay + originalExecutionInfoId: type: string description: >- - Optional. Used to define task-template name if task is of type - task-template - nextTasks: + If this execution is a replay of another execution, then this field + contains the original execution id. + replayedExecutionInfoIds: type: array description: >- - Optional. The set of tasks that are next in line to be executed as - per the execution graph defined for the parent event, specified by - `event_config_id`. Each of these next tasks are executed only if the - condition associated with them evaluates to true. + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - displayName: + type: string + description: >- + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship + id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo + type: object + EnterpriseCrmEventbusProtoNotification: + properties: + escalatorQueue: type: string + emailAddress: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' + request: description: >- - Optional. User-provided label that is attached to this TaskConfig in - the UI. - synchronousCallFailurePolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - nextTasksExecutionPolicy: - description: >- - Optional. The policy dictating the execution of the next set of - tasks for the current task. - type: string - enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - conditionalFailurePolicies: + If the out-of-the-box email/pubsub notifications are not suitable + and custom logic is required, fire a workflow containing all info + needed to notify users to resume execution. $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies - description: >- - Optional. The list of conditional failure policies that will be - applied to the task in order. - taskId: + #/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest + pubsubTopic: type: string - description: >- - Required. The identifier of this task within its parent event - config, specified by the client. This should be unique among all the - tasks belong to the same event config. We use this field as the - identifier to find next tasks (via field `next_tasks.task_id`). - taskExecutionStrategy: + buganizerNotification: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' + id: EnterpriseCrmEventbusProtoNotification + type: object + EnterpriseCrmEventbusProtoExecutionTraceInfo: + properties: + parentEventExecutionInfoId: type: string - enum: - - TASK_EXECUTION_STRATEGY_UNSPECIFIED - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - enumDescriptions: - - >- - Default. If the strategy is not set explicitly, it will default to - `WHEN_ALL_SUCCEED`. - - >- - Wait until all of its previous tasks finished execution, then - verify at least one of the edge conditions is met, and execute if - possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - - >- - Start execution as long as any of its previous tasks finished - execution and the corresponding edge condition is met (since we - will execute if only that succeeding edge condition is met). - - >- - Wait until all of its previous tasks finished execution, then - verify the all edge conditions are met and execute if possible. - description: Optional. The policy dictating the execution strategy of this task. - position: description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - errorCatcherId: + Parent event execution info id that triggers the current execution + through SubWorkflowExecutorTask. + traceId: + description: Used to aggregate ExecutionTraceInfo. type: string - description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task - successPolicy: - description: >- - Optional. Determines what action to take upon successful task - completion. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' - parameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' - type: object - description: Optional. The customized parameters the user can pass to this task. - description: + description: >- + Message that helps aggregate all sub-executions triggered by one + execution and keeps track of child-parent relationships. + type: object + id: EnterpriseCrmEventbusProtoExecutionTraceInfo + GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: + type: object + description: Response for DownloadJsonPackage. + id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse + properties: + files: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' + type: array + description: List containing JSON for multiple file with type information. + GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: + type: object + id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + description: Response for listing RuntimeEntitySchemas for a specific Connection. + properties: + nextPageToken: type: string - description: >- - Optional. User-provided description intended to give additional - business context about the task. - jsonValidationOption: + description: Next page token. + runtimeEntitySchemas: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + description: Runtime entity schemas. + type: array + EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: + type: object + id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam + properties: + useServiceAccountInContext: + type: boolean + scope: + description: A space-delimited list of requested scope permissions. type: string + allowedCredentialTypes: description: >- - Optional. If set, overrides the option configured in the Task - implementation class. - enum: - - JSON_VALIDATION_OPTION_UNSPECIFIED - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION - enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in IntegrationParameter. - - >- - Validate all potential output JSON parameters against schemas - specified in IntegrationParameter. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. - EnterpriseCrmEventbusProtoJsonFunction: - properties: - functionName: + Defines the credential types to be supported as Task may restrict + specific types to use, e.g. Cloud SQL Task will use + username/password type only. + type: array + items: + enumDescriptions: + - '' + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + type: string + allowedServiceAccountInContext: + type: boolean + authConfigId: + description: UUID of the AuthConfig. type: string + EnterpriseCrmEventbusProtoErrorDetail: + properties: + severity: enumDescriptions: - '' - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + description: 'The severity of the error: ERROR|WARN|INFO.' enum: - - UNSPECIFIED - - GET_PROPERTY - - GET_ELEMENT - - APPEND_ELEMENT - - SIZE - - SET_PROPERTY - - FLATTEN - - FLATTEN_ONCE - - MERGE - - TO_STRING - - TO_INT - - TO_DOUBLE - - TO_BOOLEAN - - TO_PROTO - - TO_STRING_ARRAY - - TO_INT_ARRAY - - TO_DOUBLE_ARRAY - - TO_PROTO_ARRAY - - TO_BOOLEAN_ARRAY - - REMOVE_PROPERTY - - RESOLVE_TEMPLATE - - EQUALS - - FOR_EACH - - FILTER_ELEMENTS - id: EnterpriseCrmEventbusProtoJsonFunction + - SEVERITY_UNSPECIFIED + - ERROR + - WARN + - INFO + type: string + errorMessage: + type: string + description: >- + The full text of the error message, including any parameters that + were thrown along with the exception. + taskNumber: + type: integer + format: int32 + description: >- + The task try-number, in which, the error occurred. If zero, the + error happened at the event level. + errorCode: + $ref: '#/components/schemas/CrmlogErrorCode' + description: The associated error-code, which can be a common or internal code. + id: EnterpriseCrmEventbusProtoErrorDetail type: object - EnterpriseCrmEventbusProtoStringArrayFunction: + description: An error, warning, or information message associated with a workflow. + GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: + description: The response for executing an integration. + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse type: object - id: EnterpriseCrmEventbusProtoStringArrayFunction properties: - functionName: + outputParameters: + additionalProperties: + type: any + description: Properties of the object. + description: >- + OUTPUT parameters in format of Map. Where Key is the name of the + parameter. Note: Name of the system generated parameters are wrapped + by backtick(`) to distinguish them from the user defined parameters. + type: object + executionFailed: + deprecated: true + description: Is true if any execution in the integration failed. False otherwise. + type: boolean + parameterEntries: + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: array + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + executionId: + description: The id of the execution corresponding to this run of integration. + type: string + eventParameters: + deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Details for the integration that were executed. + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: + type: object + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + properties: + eventExecutionDetails: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails + description: The execution info about this event. + triggerId: + description: >- + The trigger id of the workflow trigger config. If both trigger_id + and client_id is present, the workflow is executed from the start + tasks provided by the matching trigger config otherwise it is + executed from the default start tasks. + type: string + snapshotNumber: + format: int64 + type: string + description: Workflow snapshot number. + errorCode: + $ref: '#/components/schemas/CrmlogErrorCode' + description: Final error-code if event failed. + executionTraceInfo: + description: Execution trace info to aggregate parent-child executions. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' + integrationVersionUserLabel: + type: string + description: User-defined label that annotates the executed integration version. + responseParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Event parameters come out as part of the response. + replayInfo: + description: Replay info for the execution + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + requestParams: + description: Event parameters come in as part of the request. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + workflowRetryBackoffIntervalSeconds: + type: string + format: int64 + description: >- + Time interval in seconds to schedule retry of workflow in manifold + when workflow is already running + product: + type: string + enum: + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY + description: >- + Which Google product the execution_info belongs to. If not set, the + execution_info belongs to Integration Platform by default. enumDescriptions: - '' - '' - '' - '' + requestId: + type: string + description: Optional. This is used to de-dup incoming request. + eventExecutionInfoId: + description: Auto-generated primary key. + type: string + lastModifiedTime: + format: int64 + description: Auto-generated. + type: string + tenant: + description: >- + Tenant this event is created. Used to reschedule the event to + correct tenant. + type: string + errors: + description: >- + Errors, warnings, and informationals associated with the + workflow/task. The order in which the errors were added by the + workflow/task is maintained. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' + type: array + cloudLoggingDetails: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' + description: Cloud Logging details for execution info + clientId: + type: string + description: The event data user sends as request. + postMethod: + enum: + - UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + - POST_BY_EVENT_CONFIG_ID + - POST_WITH_EVENT_DETAILS + type: string + enumDescriptions: - '' - '' - '' - '' - '' - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + description: The ways user posts this event. + workflowId: type: string - GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails: - id: GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - description: Sub Integration which would be created via templates. - properties: - integration: + description: Required. Pointer to the workflow it is executing. + workflowName: type: string - description: >- - Required. Name of the sub integration which would be created via - templates. - integrationDescription: + description: Name of the workflow. + createTime: + description: Auto-generated. type: string - description: >- - Optional. Description of the sub integration which would be created - via templates. - type: object - GoogleCloudIntegrationsV1alphaFailurePolicy: + format: int64 + description: >- + Contains all the execution details for a workflow instance. Next + available id: 27 + EnterpriseCrmEventbusProtoCloudLoggingDetails: + id: EnterpriseCrmEventbusProtoCloudLoggingDetails + description: >- + Cloud Logging details, selected by the user for the integration version + (workflow). This message field will be also used in ExecutionInfo, to + indicate the CloudLoggingDetails config at the time of workflow + (integration version) execution, since this field value can be changed + for an unpublished workflow. properties: - maxRetries: - description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines - the number of times the task will be retried if failed. - format: int32 - type: integer - condition: - description: >- - Optional. The string condition that will be evaluated to determine - if the task should be retried with this failure policy. + cloudLoggingSeverity: type: string - retryStrategy: + description: >- + Severity selected by the customer for the logs to be sent to Cloud + Logging, for the integration version getting executed. enum: - - RETRY_STRATEGY_UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_INTEGRATION_WITH_BACKOFF + - CLOUD_LOGGING_SEVERITY_UNSPECIFIED + - INFO + - ERROR + - WARNING enumDescriptions: - - UNSPECIFIED. - - >- - Ignores the failure of this task. The rest of the integration will - be executed Assuming this task succeeded. - - >- - Causes a permanent failure of the task. However, if the last - task(s) of event was successfully completed despite the failure of - this task, it has no impact on the integration. - - >- - Causes a permanent failure of the event. It is different from NONE - because this will mark the event as FAILED by shutting down the - event execution. - - >- - The task will be retried from the failed task onwards after a - fixed delay. A max-retry count is required to be specified with - this strategy. A jitter is added to each exponential interval so - that concurrently failing tasks of the same type do not end up - retrying after the exact same exponential interval. max_retries - and interval_in_seconds must be specified. + - Unspecified - >- - The task will be retried from the failed task onwards after a - fixed delay that linearly increases with each retry attempt. A - jitter is added to each exponential interval so that concurrently - failing tasks of the same type do not end up retrying after the - exact same exponential interval. A max-retry count is required to - be specified with this strategy. max_retries and - interval_in_seconds must be specified. + If Severity selected is `INFO`, then all the Integration Execution + States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, + `ERROR`, `CANCELLED`) will be sent to Cloud Logging. - >- - The task will be retried after an exponentially increasing period - of time with each failure. A jitter is added to each exponential - interval so that concurrently failing tasks of the same type do - not end up retrying after the exact same exponential interval. A - max-retry count is required to be specified with this strategy. - `max_retries` and `interval_in_seconds` must be specified. + If Severity selected is `ERROR`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. - >- - The entire integration will be restarted with the initial - parameters that were set when the event was fired. A max-retry - count is required to be specified with this strategy. - `max_retries` and `interval_in_seconds` must be specified. - type: string - description: Defines what happens to the task upon failure. - intervalTime: + If Severity selected is `WARNING`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + enableCloudLogging: + type: boolean description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines - the initial interval in seconds for backoff. - type: string - format: google-datetime - description: >- - Policy that defines the task retry logic and failure type. If no - FailurePolicy is defined for a task, all its dependent tasks will not be - executed (i.e, a `retry_strategy` of NONE will be applied). + Status of whether Cloud Logging is enabled or not for the + integration version getting executed. type: object - id: GoogleCloudIntegrationsV1alphaFailurePolicy - EnterpriseCrmFrontendsEventbusProtoParameterMap: + GoogleCloudConnectorsV1DestinationConfig: + type: object + description: Define the Connectors target endpoint. + id: GoogleCloudConnectorsV1DestinationConfig properties: - entries: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + destinations: + description: The destinations for the key. type: array - keyType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' + key: type: string description: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - valueType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - type: string - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - id: EnterpriseCrmFrontendsEventbusProtoParameterMap - type: object - EnterpriseCrmEventbusStatsDimensions: - id: EnterpriseCrmEventbusStatsDimensions + The key is the destination identifier that is supported by the + Connector. + GoogleCloudIntegrationsV1alphaAuthConfig: type: object + id: GoogleCloudIntegrationsV1alphaAuthConfig properties: - clientId: + description: type: string - triggerId: + description: A description of the auth config. + certificateId: + description: Certificate id for client certificate + type: string + name: type: string description: >- - Stats have been or will be aggregated on set fields for any - semantically-meaningful combination. - retryAttempt: + Resource name of the auth config. For more information, see Manage + authentication profiles. + projects/{project}/locations/{location}/authConfigs/{authConfig}. + decryptedCredential: + description: Raw auth credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' + visibility: enumDescriptions: - - '' - - >- - Task has completed successfully or has depleted all retry - attempts. - - Task has failed but may be retried. - - Task has been deliberately canceled. - enum: - - UNSPECIFIED - - FINAL - - RETRYABLE - - CANCELED + - Visibility not specified. + - Profile visible to the creator only. + - Profile visible within the client. type: string - enumFilterType: enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE - enumDescriptions: - - '' - - '' - description: Whether to include or exclude the enums matching the regex. - type: string - taskName: - type: string - workflowId: + - AUTH_CONFIG_VISIBILITY_UNSPECIFIED + - PRIVATE + - CLIENT_VISIBLE + description: The visibility of the auth config. + encryptedCredential: type: string - taskNumber: + description: >- + Auth credential encrypted by Cloud KMS. Can be decrypted as + Credential with proper KMS key. + format: byte + creatorEmail: + description: >- + The creator's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. type: string - workflowName: + lastModifierEmail: type: string - errorEnumString: + description: >- + The last modifier's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. + reason: + description: The reason / details of the current status. type: string - warningEnumString: - type: string - EnterpriseCrmEventbusProtoCoordinate: - id: EnterpriseCrmEventbusProtoCoordinate - type: object - description: Represents two-dimensional positions. - properties: - 'y': - type: integer - format: int32 - x: - format: int32 - type: integer - GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: - description: >- - Integration Config Parameter is defined in the integration config and - are used to provide external configuration for integration. It provide - information about data types of the expected parameters and provide any - default values or value. They can also be used to add custom attributes. - type: object - id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter - properties: - value: - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message or a serialized object. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - parameter: + validTime: + format: google-datetime description: >- - Optional. Integration Parameter to provide the default value, data - type and attributes required for the Integration config variables. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - GoogleCloudIntegrationsV1alphaProjectProperties: - id: GoogleCloudIntegrationsV1alphaProjectProperties - type: object - description: Metadata information for the given project - properties: - ipEnablementState: - description: An enum value of what the enablement state is for the given project - enumDescriptions: - - The client enablement status is unspecified - - The client is enabled on Standalone IP - - The client is enabled on Apigee - - The client is entitled for Apigee but not enabled + The time until the auth config is valid. Empty or max value is + considered the auth config won't expire. type: string - enum: - - IP_ENABLEMENT_STATE_UNSPECIFIED - - IP_ENABLEMENT_STATE_STANDALONE - - IP_ENABLEMENT_STATE_APIGEE - - IP_ENABLEMENT_STATE_APIGEE_ENTITLED - billingType: - description: 'Required. Required: The client billing type that was requested' - enum: - - BILLING_TYPE_UNSPECIFIED - - APIGEE_TRIALS - - APIGEE_SUBSCRIPTION - - PAYG - - SUBSCRIPTION - - NO_BILLING + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The timestamp when the auth config is created. + credentialType: type: string enumDescriptions: - - '' - - A trial org provisioned through Apigee Provisioning Wizard - - >- - Subscription based on concurrency model for Apigee and Application - Integration users. - - Consumption based users of IP + - Unspecified credential type + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. - >- - Argentum subscription for Application Integration users. To be - used in the future. + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + description: Credential type of the encrypted credential. + state: + type: string + description: The status of the auth config. + enumDescriptions: + - Status not specified. + - Valid Auth config. - >- - Special billing type to avoid any billing to clients (eg: trusted - tester program). This should not be used without consulting with - the leads. - provisionedRegions: - type: array - description: A list of provisioned regions on the current project - items: - type: string - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: - id: >- - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - type: object - properties: - ancestorTaskNumbers: + General invalidity, if it doesn't fits in the detailed issue + below. + - Auth config soft deleted. + - Auth config expired. + - Auth config unauthorized. + - Auth config not supported. + enum: + - STATE_UNSPECIFIED + - VALID + - INVALID + - SOFT_DELETED + - EXPIRED + - UNAUTHORIZED + - UNSUPPORTED + displayName: + type: string + description: Required. The name of the auth config. + expiryNotificationDuration: type: array description: >- - Ancestor task number for the task(it will only be non-empty if the - task is under 'private workflow') - items: - type: string - taskAttemptNum: - description: the task attempt number this snapshot belongs to. Could be empty. - format: int32 - type: integer - ancestorIterationNumbers: + User can define the time to receive notification after which the + auth config becomes invalid. Support up to 30 days. Support + granularity in hours. items: type: string - type: array + format: google-duration + overrideValidTime: description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - taskLabel: + User provided expiry time to override. For the example of + Salesforce, username/password credentials can be valid for 6 months + depending on the instance settings. + format: google-datetime type: string - description: the task label associated with this snapshot. Could be empty. - eventAttemptNum: - format: int32 - description: the event attempt number this snapshot belongs to. - type: integer - integrationName: - description: >- - The direct integration which the event execution snapshots belongs - to + updateTime: + readOnly: true + description: Output only. The timestamp when the auth config is modified. + format: google-datetime type: string - taskNumber: - description: The task number associated with this snapshot. Could be empty. + description: The AuthConfig resource use to hold channels and connection config data. + GoogleCloudIntegrationsV1alphaRuntimeActionSchema: + type: object + description: Metadata of an action, including schemas for its inputs and outputs. + id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema + properties: + outputSchema: + description: Output parameter schema for the action. type: string - taskName: - description: the task name associated with this snapshot. Could be empty. + action: + description: Name of the action. type: string - GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: - properties: - scopes: - type: array - description: >- - Scopes the connection will request when the user performs the auth - code flow. - items: - type: string - clientId: - description: Client ID for user-provided OAuth app. + inputSchema: + description: Input parameter schema for the action. type: string - authCode: - description: Authorization code to be exchanged for access and refresh tokens. + GoogleCloudIntegrationsV1alphaOidcToken: + id: GoogleCloudIntegrationsV1alphaOidcToken + description: OIDC Token + properties: + tokenExpireTime: + format: google-datetime type: string - pkceVerifier: + description: The approximate time until the token retrieved is valid. + token: + description: ID token obtained for the service account type: string - description: PKCE verifier to be used during the auth code exchange. - authUri: + audience: + description: >- + Audience to be used when generating OIDC token. The audience claim + identifies the recipients that the JWT is intended for. type: string - description: Auth URL for Authorization Code Flow - enablePkce: - description: Whether to enable PKCE when the user performs the auth code flow. - type: boolean - redirectUri: + serviceAccountEmail: + description: The service account email to be used as the identity for the token. type: string - description: Redirect URI to be provided during the auth code exchange. - clientSecret: - description: Client secret for user-provided OAuth app. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - description: >- - Parameters to support Oauth 2.0 Auth Code Grant Authentication. See - https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. type: object - GoogleCloudIntegrationsV1alphaSearchTemplatesResponse: + GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: + id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + properties: {} + description: Request for UnpublishIntegrationVersion. + type: object + GoogleCloudConnectorsV1ResourceLimits: + id: GoogleCloudConnectorsV1ResourceLimits type: object + description: Resource limits defined for connection pods of a given connector type. properties: - nextPageToken: - description: The token used to retrieve the next page results. + cpu: + readOnly: true type: string - templates: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' - type: array - description: List of templates retrieved. - description: Response for a request to search templates - id: GoogleCloudIntegrationsV1alphaSearchTemplatesResponse - GoogleCloudIntegrationsV1alphaProvisionClientRequest: - id: GoogleCloudIntegrationsV1alphaProvisionClientRequest + description: Output only. CPU limit. + memory: + description: Output only. Memory limit. + readOnly: true + type: string + EnterpriseCrmEventbusProtoConnectorsConnection: properties: - provisionGmek: - type: boolean - deprecated: true + connectorVersion: description: >- - Optional. Deprecated. Indicates provision with GMEK or CMEK. This - field is deprecated and the provision would always be GMEK if - cloud_kms_config is not present in the request. - createSampleWorkflows: + Connector version Format: + projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} + type: string + serviceName: description: >- - Optional. Indicates if sample workflow should be created along with - provisioning - type: boolean - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + Service name Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} + type: string + host: + type: string description: >- - Optional. OPTIONAL: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. - runAsServiceAccount: + The name of the Hostname of the Service Directory service with TLS + if used. + connectionName: type: string description: >- - Optional. User input run-as service account, if empty, will bring up - a new default service account - skipCpProvision: - description: Optional. Indicates if skip CP provision or not - type: boolean + Connection name Format: + projects/{project}/locations/{location}/connections/{connection} + id: EnterpriseCrmEventbusProtoConnectorsConnection type: object - description: Request for the Provision rpc - EnterpriseCrmEventbusProtoFunction: - id: EnterpriseCrmEventbusProtoFunction + GoogleCloudIntegrationsV1alphaParameterMapField: + properties: + referenceKey: + type: string + description: Referencing one of the Integration variables. + literalValue: + description: Passing a literal value. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + id: GoogleCloudIntegrationsV1alphaParameterMapField + type: object + description: Field represents either the key or value in an entry. + EnterpriseCrmEventbusProtoBooleanFunction: + id: EnterpriseCrmEventbusProtoBooleanFunction type: object properties: - parameters: - description: List of parameters required for the transformation. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - type: array - functionType: - description: The name of the function to perform. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' - EnterpriseCrmFrontendsEventbusProtoStringParameterArray: + functionName: + type: string + enum: + - UNSPECIFIED + - TO_JSON + - NOT + - AND + - NAND + - OR + - XOR + - NOR + - XNOR + - TO_STRING + - EQUALS + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + EnterpriseCrmEventbusProtoCloudSchedulerConfig: + description: Cloud Scheduler Trigger configuration + id: EnterpriseCrmEventbusProtoCloudSchedulerConfig type: object properties: - stringValues: + errorMessage: + description: >- + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations + type: string + cronTab: + type: string + description: Required. The cron tab of cloud scheduler trigger. + location: + description: >- + Required. The location where associated cloud scheduler job will be + created + type: string + serviceAccountEmail: + type: string + description: >- + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time + GoogleCloudIntegrationsV1alphaDoubleParameterArray: + properties: + doubleValues: type: array + description: Double number array. items: - type: string - id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray - EnterpriseCrmEventbusProtoTaskMetadata: + format: double + type: number + description: This message only contains a field of double number array. + type: object + id: GoogleCloudIntegrationsV1alphaDoubleParameterArray + GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: + description: Request to enable/disable variable masking for a provisioned client + properties: + enableVariableMasking: + type: boolean + description: >- + Required. REQUIRED: True if variable masking feature should be + turned on for this region + type: object + id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: + id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry type: object properties: - externalDocHtml: - description: External-facing documention embedded in the RHP for this task. - type: string - descriptiveName: + config: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' + description: Optional fields, such as help text and other useful info. + validationRule: description: >- - The string name to show on the task list on the Workflow editor - screen. This should be a very short, one to two words name for the - task. (e.g. "Send Mail") + Rule used to validate inputs (individual values and collection + elements) for this parameter. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + protoDef: + description: Populated if this represents a proto or proto array. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition + isOutput: + type: boolean + jsonSchema: type: string - system: + description: If the data_type is JSON_VALUE, then this will define its schema. + key: type: string - enum: - - UNSPECIFIED_SYSTEM - - GENERIC - - BUGANIZER - - SALESFORCE - - CLOUD_SQL - - PLX - - SHEETS - - GOOGLE_GROUPS - - EMAIL - - SPANNER - - DATA_BRIDGE + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given task. These parameters must be + predefined in the workflow definition. + dataType: enumDescriptions: - '' - '' @@ -769,1714 +746,558 @@ components: - '' - '' - '' - description: - type: string - description: In a few sentences, describe the purpose and usage of the task. - externalDocMarkdown: - type: string - description: 'DEPRECATED: Use external_doc_html.' - category: - type: string - enumDescriptions: - '' - '' - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. - '' - '' - '' - - Internal IP tasks that should not be available in the UI. - - Tasks that are relevant to cloud systems teams and typically - - Task entities that derive from a custom task template. - - Category to show task recommendations - enum: - - UNSPECIFIED_CATEGORY - - CUSTOM - - FLOW_CONTROL - - DATA_MANIPULATION - - SCRIPTING - - CONNECTOR - - HIDDEN - - CLOUD_SYSTEMS - - CUSTOM_TASK_TEMPLATE - - TASK_RECOMMENDATIONS - isDeprecated: - type: boolean - description: The deprecation status of the current task. Default value is false; - admins: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' - externalDocLink: type: string - description: Doc link for external-facing documentation (separate from g3doc). - defaultSpec: + description: The data type of the parameter. + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + collectionElementClassName: type: string description: >- - Contains the initial configuration of the task with default values - set. For now, The string should be compatible to an ASCII-proto - format. - activeTaskName: + If it is a collection of objects, this would be the FCQN of every + individual element in the collection. If this is "java.lang.Object", + the parameter is a collection of any type. + required: + type: boolean + description: If set, the user must provide an input value for this parameter. + className: description: >- - The new task name to replace the current task if it is deprecated. - Otherwise, it is the same as the current task name. - type: string - iconLink: - description: >- - URL to gstatic image icon for this task. This icon shows up on the - task list panel along with the task name in the Workflow Editor - screen. Use the 24p, 2x, gray color icon image format. - type: string - status: - enum: - - UNSPECIFIED_STATUS - - DEFAULT_INACTIVE - - ACTIVE - type: string - enumDescriptions: - - >- - Default value. Actual Task Status should always be set to either - INACTIVE or ACTIVE. If none is specified at runtime, it will be - set to INACTIVE. - - Still in-progress or incomplete, and not intended for use. - - Available for use. - description: >- - Allows author to indicate if the task is ready to use or not. If not - set, then it will default to INACTIVE. - tags: - items: - type: string - type: array - description: >- - A set of tags that pertain to a particular task. This can be used to - improve the searchability of tasks with several names ("REST Caller" - vs. "Call REST Endpoint") or to help users find tasks based on - related words. - docMarkdown: - type: string - description: Snippet of markdown documentation to embed in the RHP for this task. - externalCategory: - enumDescriptions: - - '' - - '' - - '' - - HTTP tasks, e.g. rest api call task - - Integration services, e.g. connector task - - Customer ations, e.g. email task - - Flow control, e.g. while loop task - - Workspace tasks, e.g. list drive task - - Security, e.g. kms related tasks - - Database operation tasks, e.g. read firestore info tasks - - Analytics tasks, e.g. dataflow creattion tasks - - BYOC tasks - - BYOT tasks - - AI related tasks. - - Data manipulation related tasks, e.g. data mapping task - enum: - - UNSPECIFIED_EXTERNAL_CATEGORY - - CORE - - CONNECTORS - - EXTERNAL_HTTP - - EXTERNAL_INTEGRATION_SERVICES - - EXTERNAL_CUSTOMER_ACTIONS - - EXTERNAL_FLOW_CONTROL - - EXTERNAL_WORKSPACE - - EXTERNAL_SECURITY - - EXTERNAL_DATABASES - - EXTERNAL_ANALYTICS - - EXTERNAL_BYOC - - EXTERNAL_BYOT - - EXTERNAL_ARTIFICIAL_INTELIGENCE - - EXTERNAL_DATA_MANIPULATION - type: string - g3DocLink: - description: URL to the associated G3 Doc for the task if available - type: string - defaultJsonValidationOption: - enum: - - UNSPECIFIED_JSON_VALIDATION_OPTION - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION - type: string - description: >- - Controls whether JSON workflow parameters are validated against - provided schemas before and/or after this task's execution. - enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in WorkflowParameters. - - >- - Validate all potential output JSON parameters against schemas - specified in WorkflowParameters. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. - name: - description: >- - The actual class name or the annotated name of the task. Task Author - should initialize this field with value from the getName() method of - the Task class. - type: string - codeSearchLink: - description: The Code Search link to the Task Java file. - type: string - externalCategorySequence: - format: int32 - type: integer - description: >- - Sequence with which the task in specific category to be displayed in - task discovery panel for external users. - standaloneExternalDocHtml: - description: >- - External-facing documention for standalone IP in pantheon embedded - in the RHP for this task. Non null only if different from - external_doc_html - type: string - id: EnterpriseCrmEventbusProtoTaskMetadata - description: >- - TaskMetadata are attributes that are associated to every common Task we - have. - CrmlogErrorCode: - properties: - commonErrorCode: - enum: - - COMMON_ERROR_CODE_UNSPECIFIED - - INVALID_CREDENTIALS - - REQUIRED_FIELDS_MISSING - - INVALID_FIELDS - - BACKEND - - GENERAL - - INTERNAL - - IO_ERROR - - NOT_FOUND - - EVENT_BUS - - ALREADY_EXISTS - - CONCORD - - CONVERSION - - FLUME - - PERMISSION - - SALES_FORCE - - SPANNER - - UNIMPLEMENTED - - RELTIO - - WORKFLOW_NOT_FOUND - - QUOTA_THROTTLED - - QUOTA_ENQUEUED - - INVALID_QUOTA_CONFIGURATION - - TASK_NOT_FOUND - - EXECUTION_TIMEOUT - - INVALID_EVENT_EXECUTION_STATE - - INVALID_ATTRIBUTE - - MISSING_ATTRIBUTE - - CLIENT_UNAUTHORIZED_FOR_WORKFLOW - - INVALID_PARAMETER - - MISSING_PARAMETER - - UNAUTHROIZED_WORKFLOW_EDITOR_ACTION - - FAILED_PRECONDITION - - INVALID_CLIENT - - MISSING_CLIENT - - INVALID_WORKFLOW - - MISSING_QUOTA_CONFIGURATION - - UNHANDLED_TASK_ERROR - - SCRIPT_TASK_RUNTIME_ERROR - - RPC - - INVALID_PROTO - - UNHANDLED_EVENTBUS_ERROR - - INVALID_TASK_STATE - - TYPED_TASK_INVALID_INPUT_OPERATION - - TYPED_TASK_INVALID_OUTPUT_OPERATION - - VALIDATION_ERROR - - RESUME_ERROR - - APPS_SCRIPT_EXECUTION_ERROR - - INVALID_VECTOR_USER - - INFORMATICA - - RETRYABLE_TASK_ERROR - - INVALID_TENANT - - WRONG_TENANT - - INFORMATICA_BACKEND_UNAVAILABLE - - RPC_PERMISSION_DENIED - - SYNC_EVENTBUS_EXECUTION_TIMEOUT - - ASYNC_EVENTBUS_EXECUTION_TIMEOUT - - NOT_SUPPORTED_DATA_TYPE - - UNSANITIZED_USER_INPUT - - TRANSFORM_EXPRESSION_EVALUATION_ERROR - - HTTP_EXCEPTION - - EXECUTION_CANCELLED - enumDeprecated: - - false - - true - - false - - false - - true - - true - - true - - false - - false - - true - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. - - >- - ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use - only. This error will be counted as server availability error. - - '' - - '' - - '' - - '' - - '' - id: CrmlogErrorCode - type: object - description: >- - Registered ids for errors, as "oneof" enums. Each task or logical - grouping of tasks may share the same enum. - EnterpriseCrmEventbusProtoIntArrayFunction: - properties: - functionName: - type: string - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - id: EnterpriseCrmEventbusProtoIntArrayFunction - type: object - GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: - properties: - content: - description: String representation of the requested file. - type: string - files: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' - description: List containing String represendation for multiple file with type. - id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse - description: Response for DownloadIntegrationVersion. - type: object - GoogleCloudIntegrationsV1alphaCloudLoggingDetails: - type: object - description: Cloud Logging details for execution info - id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails - properties: - enableCloudLogging: - description: >- - Optional. Status of whether Cloud Logging is enabled or not for the - integration version getting executed. - type: boolean - cloudLoggingSeverity: - enumDescriptions: - - Unspecified - - >- - If Severity selected is `INFO`, then all the Integration Execution - States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, - `ERROR`, `CANCELLED`) will be sent to Cloud Logging. - - >- - If Severity selected is `ERROR`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. - - >- - If Severity selected is `WARNING`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. - description: >- - Optional. Severity selected by the customer for the logs to be sent - to Cloud Logging, for the integration version getting executed. - enum: - - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - - INFO - - ERROR - - WARNING - type: string - EnterpriseCrmEventbusProtoBooleanFunction: - id: EnterpriseCrmEventbusProtoBooleanFunction - properties: - functionName: - enum: - - UNSPECIFIED - - TO_JSON - - NOT - - AND - - NAND - - OR - - XOR - - NOR - - XNOR - - TO_STRING - - EQUALS - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: string - type: object - GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: - description: Cloud Scheduler Trigger configuration - properties: - errorMessage: - type: string - description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations - location: - type: string - description: >- - Required. The location where associated cloud scheduler job will be - created - cronTab: - type: string - description: Required. The cron tab of cloud scheduler trigger. - serviceAccountEmail: - type: string - description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time - id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - type: object - GoogleCloudConnectorsV1NodeConfig: - type: object - properties: - maxNodeCount: - type: integer - format: int32 - description: Maximum number of nodes in the runtime nodes. - minNodeCount: - format: int32 - type: integer - description: Minimum number of nodes in the runtime nodes. - id: GoogleCloudConnectorsV1NodeConfig - description: Node configuration for the connection. - GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: - id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest - description: Request for the Deprovision rpc - type: object - properties: {} - EnterpriseCrmEventbusProtoBooleanArrayFunction: - properties: - functionName: - type: string - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - id: EnterpriseCrmEventbusProtoBooleanArrayFunction - type: object - EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails: - description: >- - Contains the details of the execution info of this event: this includes - the tasks execution details plus the event execution statistics. Next - available id: 12 - properties: - eventExecutionSnapshot: - description: >- - After snapshot migration, this field will no longer be populated, - but old execution snapshots will still be accessible. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot - type: array - nextExecutionTime: - format: int64 - type: string - description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. - eventExecutionSnapshotsSize: - type: string - description: Total size of all event_execution_snapshots for an execution - format: int64 - eventRetriesFromBeginningCount: - description: >- - Indicates the number of times the execution has restarted from the - beginning. - format: int32 - type: integer - logFilePath: - description: The log file path (aka. cns address) for this event. - type: string - networkAddress: - type: string - description: >- - The network address (aka. bns address) that indicates where the - event executor is running. - ryeLockUnheldCount: - format: int32 - type: integer - description: >- - Used internally and shouldn't be exposed to users. A counter for the - cron job to record how many times this event is in in_process state - but don't have a lock consecutively/ - cancelReason: - type: string - description: >- - If the execution is manually canceled, this field will contain the - reason for cancellation. - eventExecutionState: - enumDescriptions: - - '' - - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. - - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. - - >- - Event execution canceled by user. There's no more change after - this state. - - Event execution failed and waiting for retry. - - Event execution suspended and waiting for manual intervention. - description: The execution state of this event. - enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED - type: string - eventAttemptStats: - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - type: array - type: object - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails - EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: - properties: - rollbackTaskImplementationClassName: - description: >- - Required. This is the name of the task that needs to be executed - upon rollback of this task. - type: string - parameters: - description: Optional. The customized parameters the user can pass to this task. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - taskNumbersToRollback: - type: array - items: - type: string - description: >- - Required. These are the tasks numbers of the tasks whose - `rollback_strategy.rollback_task_implementation_class_name` needs to - be executed upon failure of this task. - id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy - type: object - description: 'Next available id: 4' - EnterpriseCrmEventbusProtoPropertyEntry: - properties: - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - key: - type: string - description: >- - Key is used to retrieve the corresponding property value. This - should be unique for a given fired event. The Tasks should be aware - of the keys used while firing the events for them to be able to - retrieve the values. - type: object - id: EnterpriseCrmEventbusProtoPropertyEntry - description: Key-value pair of EventBus property. - EnterpriseCrmEventbusProtoIntFunction: - properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - ADD - - SUBTRACT - - MULTIPLY - - DIVIDE - - EXPONENT - - GREATER_THAN_EQUAL_TO - - GREATER_THAN - - LESS_THAN_EQUAL_TO - - LESS_THAN - - TO_DOUBLE - - TO_STRING - - EQUALS - - TO_JSON - - MOD - - EPOCH_TO_HUMAN_READABLE_TIME - type: string - type: object - id: EnterpriseCrmEventbusProtoIntFunction - GoogleCloudConnectorsV1EncryptionKey: - id: GoogleCloudConnectorsV1EncryptionKey - type: object - description: Encryption Key value. - properties: - kmsKeyName: - description: >- - The [KMS key name] with which the content of the Operation is - encrypted. The expected format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty - string if google managed. - type: string - type: - description: Type. - enumDescriptions: - - Value type is not specified. - - Google Managed. - - Customer Managed. - type: string - enum: - - TYPE_UNSPECIFIED - - GOOGLE_MANAGED - - CUSTOMER_MANAGED - GoogleCloudIntegrationsV1alphaUsernameAndPassword: - properties: - password: - type: string - description: Password to be used - username: - description: Username to be used - type: string - id: GoogleCloudIntegrationsV1alphaUsernameAndPassword - description: Username and password pair. - type: object - EnterpriseCrmEventbusProtoNodeIdentifier: - description: 'Represents a node identifier (type + id). Next highest id: 3' - id: EnterpriseCrmEventbusProtoNodeIdentifier - type: object - properties: - elementIdentifier: - type: string - description: Configuration of the edge. - elementType: - description: Destination node where the edge ends. It can only be a task config. - enum: - - UNKNOWN_TYPE - - TASK_CONFIG - - TRIGGER_CONFIG - enumDescriptions: - - '' - - '' - - '' - type: string - GoogleCloudIntegrationsV1alphaOidcToken: - properties: - serviceAccountEmail: - description: The service account email to be used as the identity for the token. - type: string - token: - type: string - description: ID token obtained for the service account - tokenExpireTime: - description: The approximate time until the token retrieved is valid. - format: google-datetime - type: string - audience: - type: string - description: >- - Audience to be used when generating OIDC token. The audience claim - identifies the recipients that the JWT is intended for. - type: object - id: GoogleCloudIntegrationsV1alphaOidcToken - description: OIDC Token - EnterpriseCrmEventbusProtoTaskAlertConfig: - description: >- - Message to be used to configure alerting in the {@code TaskConfig} - protos for tasks in an event. - id: EnterpriseCrmEventbusProtoTaskAlertConfig - properties: - durationThresholdMs: - format: int64 - type: string - description: >- - Should be specified only for TASK_AVERAGE_DURATION and - TASK_PERCENTILE_DURATION metrics. This member should be used to - specify what duration value the metrics should exceed for the alert - to trigger. - alertName: - type: string - description: >- - A name to identify this alert. This will be displayed in the alert - subject. If set, this name should be unique in within the scope of - the containing workflow. - thresholdValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - description: >- - The metric value, above or below which the alert should be - triggered. - aggregationPeriod: - type: string - description: >- - The period over which the metric value should be aggregated and - evaluated. Format is , where integer should be a positive integer - and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, - day, week). - numAggregationPeriods: - format: int32 - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - type: integer - thresholdType: - type: string - description: >- - The threshold type for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. - enumDescriptions: - - '' - - >- - Note that this field will only trigger alerts if the workflow - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. - - '' - enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX - playbookUrl: - type: string - description: >- - Link to a playbook for resolving the issue that triggered this - alert. - onlyFinalAttempt: - type: boolean - description: Only count final task attempts, not retries. - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - alertDisabled: - type: boolean - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. - clientId: - description: >- - Client associated with this alert configuration. Must be a client - enabled in one of the containing workflow's triggers. - type: string - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - metricType: - enumDescriptions: - - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors (potentially for a - specific set of enum values) for the enclosing TaskConfig. - - >- - Specifies alerting on the rate of warnings (potentially for a - specific set of enum values) for the enclosing TaskConfig. - Warnings use the same enum values as errors. - - >- - Specifies alerting on the number of instances for the enclosing - TaskConfig executed in the given aggregation_period. - - >- - Specifies alerting on the average duration of execution for the - enclosing task. - - >- - Specifies alerting on the duration of a particular percentile of - task executions. E.g. If 10% or more of the task executions have - durations above 5 seconds, alert. - type: string - enum: - - METRIC_TYPE_UNSPECIFIED - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - type: object - GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: - description: The response for executing an integration. - properties: - outputParameters: - additionalProperties: - description: Properties of the object. - type: any - description: >- - OUTPUT parameters in format of Map. Where Key is the name of the - parameter. Note: Name of the system generated parameters are wrapped - by backtick(`) to distinguish them from the user defined parameters. - type: object - eventParameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - deprecated: true - description: Details for the integration that were executed. - executionId: - type: string - description: The id of the execution corresponding to this run of integration. - executionFailed: - description: Is true if any execution in the integration failed. False otherwise. - deprecated: true - type: boolean - parameterEntries: - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - type: array - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - type: object - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse - GoogleCloudIntegrationsV1alphaListSuspensionsResponse: - type: object - properties: - suspensions: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' - description: >- - The suspensions for the relevant execution which the caller has - permissions to view and resolve. - nextPageToken: - description: Token to retrieve the next page of results. - type: string - id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse - description: Response for Suspensions.ListSuspensions. - GoogleCloudConnectorsV1ConfigVariable: - type: object - properties: - boolValue: - type: boolean - description: Value is a bool. - intValue: - type: string - description: Value is an integer - format: int64 - stringValue: - type: string - description: Value is a string. - secretValue: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Value is a secret. - encryptionKeyValue: - description: Value is a Encryption Key. - $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' - key: - type: string - description: Key of the config variable. - id: GoogleCloudConnectorsV1ConfigVariable - description: >- - ConfigVariable represents a configuration variable present in a - Connection. or AuthConfig. - GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: - type: object - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest - description: Request for TakeoverEditLock. - properties: {} - GoogleCloudIntegrationsV1alphaExecutionReplayInfo: - id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo - type: object - properties: - originalExecutionInfoId: - type: string - description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - replayedExecutionInfoIds: - type: array - items: - type: string - description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. - replayReason: - type: string - description: reason for replay - description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship - GoogleCloudConnectorsV1LockConfig: - id: GoogleCloudConnectorsV1LockConfig - description: >- - Determines whether or no a connection is locked. If locked, a reason - must be specified. - properties: - locked: - description: Indicates whether or not the connection is locked. - type: boolean - reason: - description: Describes why a connection is locked. - type: string - type: object - EnterpriseCrmEventbusProtoLogSettings: - description: >- - The LogSettings define the logging attributes for an event property. - These attributes are used to map the property to the parameter in the - log proto. Also used to define scrubbing/truncation behavior and PII - information. - type: object - properties: - logFieldName: - type: string - description: >- - The name of corresponding logging field of the event property. If - omitted, assumes the same name as the event property key. - seedPeriod: - enumDescriptions: - - '' - - Sanitized values remain constant for the day of the event. - - >- - Sanitized values remain constant for the week of the event; may - cross month boundaries. - - Sanitized values remain constant for the month of the event. - type: string - enum: - - SEED_PERIOD_UNSPECIFIED - - DAY - - WEEK - - MONTH - seedScope: - enum: - - SEED_SCOPE_UNSPECIFIED - - EVENT_NAME - - TIME_PERIOD - - PARAM_NAME - type: string - enumDescriptions: - - '' - - Hash computations include the event name. - - Hash computations include a time period. - - Hash computations include the param name. - id: EnterpriseCrmEventbusProtoLogSettings - EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: - id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig - properties: - operation: - enum: - - OPERATION_UNSPECIFIED - - EXECUTE_ACTION - - LIST_ENTITIES - - GET_ENTITY - - CREATE_ENTITY - - UPDATE_ENTITY - - DELETE_ENTITY - - EXECUTE_QUERY - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - description: Operation to perform using the configured connection. - connection: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' - description: User-selected connection. - type: object - GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: - properties: - fieldSchema: - description: List of fields in the entity. - type: string - arrayFieldSchema: - type: string - description: The above schema, but for an array of the associated entity. - entity: - type: string - description: Name of the entity. - id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - description: Metadata of an entity, including a schema for its properties. - type: object - EnterpriseCrmEventbusProtoCloudSchedulerConfig: - description: Cloud Scheduler Trigger configuration - properties: - serviceAccountEmail: - type: string - description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time - errorMessage: - description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations - type: string - cronTab: - description: Required. The cron tab of cloud scheduler trigger. - type: string - location: - type: string - description: >- - Required. The location where associated cloud scheduler job will be - created - id: EnterpriseCrmEventbusProtoCloudSchedulerConfig - type: object - EnterpriseCrmEventbusProtoEventBusProperties: - id: EnterpriseCrmEventbusProtoEventBusProperties - description: >- - LINT.IfChange This message is used for storing key value pair properties - for each Event / Task in the EventBus. - type: object - properties: - properties: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' - description: An unordered list of property entries. - GoogleCloudConnectorsV1EventingStatus: - description: EventingStatus indicates the state of eventing. - properties: - description: - type: string - description: Output only. Description of error if State is set to "ERROR". - readOnly: true - state: - readOnly: true - type: string - description: Output only. State. - enumDescriptions: - - Default state. - - Eventing is enabled and ready to receive events. - - Eventing is not active due to an error. - - Ingress endpoint required. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - ERROR - - INGRESS_ENDPOINT_REQUIRED - type: object - id: GoogleCloudConnectorsV1EventingStatus - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: - description: Rule used to validate strings. - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - properties: - exclusive: - type: boolean - description: >- - Whether the regex matcher is applied exclusively (if true, matching - values will be rejected). - regex: - type: string - description: The regex applied to the input value(s). - type: object - GoogleCloudIntegrationsV1alphaSfdcChannel: - properties: - displayName: - type: string - description: Client level unique name/alias to easily reference a channel. - name: - type: string - description: >- - Resource name of the SFDC channel - projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. - isActive: - type: boolean - description: >- - Indicated if a channel has any active integrations referencing it. - Set to false when the channel is created, and set to true if there - is any integration published with the channel configured in it. - updateTime: - readOnly: true - type: string - description: Output only. Time when the channel was last updated - format: google-datetime - createTime: - type: string - format: google-datetime - description: Output only. Time when the channel is created - readOnly: true - channelTopic: - description: The Channel topic defined by salesforce once an channel is opened - type: string - lastReplayId: - description: Last sfdc messsage replay id for channel - type: string - description: - description: The description for this channel + The FQCN of the Java object this represents. A string, for example, + would be "java.lang.String". If this is "java.lang.Object", the + parameter can be of any type. type: string - deleteTime: - format: google-datetime + isDeprecated: + type: boolean description: >- - Output only. Time when the channel was deleted. Empty if not - deleted. - readOnly: true - type: string - id: GoogleCloudIntegrationsV1alphaSfdcChannel - description: The SfdcChannel that points to a CDC or Platform Event Channel. - type: object - GoogleCloudConnectorsV1EventingRuntimeData: - description: >- - Eventing runtime data has the details related to eventing managed by the - system. - id: GoogleCloudConnectorsV1EventingRuntimeData - properties: - status: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' - description: Output only. Current status of eventing. - webhookData: + If set, this entry is deprecated, so further use of this parameter + should be prohibited. + defaultValue: $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - description: Output only. Webhook data. - readOnly: true - eventsListenerPscSa: - type: string - readOnly: true - description: >- - Output only. Events listener PSC Service attachment. The value will - be populated after provisioning the events listener with private - connectivity enabled. - eventsListenerEndpoint: - type: string - readOnly: true + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType description: >- - Output only. Events listener endpoint. The value will populated - after provisioning the events listener. - type: object - GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: - description: The response for testing an integration. + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + description: 'Key-value pair of EventBus task parameters. Next id: 13' + GoogleCloudConnectorsV1EventingConfig: + description: Eventing Configuration of a connection + id: GoogleCloudConnectorsV1EventingConfig properties: - parameters: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: >- - Optional. Parameters are a part of Event and can be used to - communicate between different tasks that are part of the same - integration execution. - executionId: - type: string - description: The id of the execution corresponding to this run of integration. - executionFailed: - description: Is true if any execution in the integration failed. False otherwise. - type: boolean - eventParameters: - description: Details for the integration that were executed. + listenerAuthConfig: + description: Optional. Auth details for the event listener. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + deadLetterConfig: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - deprecated: true - parameterEntries: - deprecated: true + #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + description: Optional. Dead letter configuration for eventing of a connection. + enrichmentEnabled: + type: boolean + description: Enrichment Enabled. + proxyDestinationConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + description: Optional. Proxy for Eventing auto-registration. + additionalVariables: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' type: array + description: Additional eventing related field values + eventsListenerIngressEndpoint: description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - type: object - id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse - GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: - properties: - enableVariableMasking: - type: boolean - description: >- - Required. REQUIRED: True if variable masking feature should be - turned on for this region - id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest - description: Request to enable/disable variable masking for a provisioned client - type: object - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: - type: object - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse - description: Response for PublishIntegrationVersion. - properties: {} - GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: - type: object - id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - properties: - projectId: - type: string - description: Optional. Project which has the topic given. - topic: - type: string - description: Optional. Topic to push events which couldn't be processed. - description: Dead Letter configuration details provided by the user. - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: - type: object - properties: - scriptId: - type: string - description: The id of the linked Apps Script project. - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse - description: Response for LinkAppsScriptProject rpc call. - GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: - id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest - properties: - triggerId: + Optional. Ingress endpoint of the event listener. This is used only + when private connectivity is enabled. type: string - description: >- - Required. The trigger id of the integration trigger config. If both - trigger_id and client_id is present, the integration is executed - from the start tasks provided by the matching trigger config - otherwise it is executed from the default start tasks. - parameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Optional. Passed in as parameters to each integration execution. - deprecated: true - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Required. integration config to execute the workflow - testMode: + registrationDestinationConfig: + description: Registration endpoint for auto registration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + privateConnectivityEnabled: type: boolean - description: >- - Optional. Can be specified in the event request, otherwise false - (default). If true, enables tasks with condition "test_mode = true". - If false, disables tasks with condition "test_mode = true" if global - test mode (set by platform) is also false {@link EventBusConfig}. - clientId: - type: string - description: >- - Required. This is used to identify the client on whose behalf the - event will be executed. - deadlineSecondsTime: - type: string - description: Optional. custom deadline of the rpc - format: google-datetime - inputParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Optional. Input parameters used during integration execution. - type: object - configParameters: - description: Optional. Config parameters used during integration execution. - additionalProperties: - type: any - description: Properties of the object. - type: object - type: object - description: The request for testing an integration. - GoogleCloudConnectorsV1AuthConfig: + description: Optional. Private Connectivity Enabled. + authConfig: + description: Auth details for the webhook adapter. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' type: object - id: GoogleCloudConnectorsV1AuthConfig - properties: - authKey: - type: string - description: Identifier key for auth config - additionalVariables: - type: array - description: List containing additional auth configs. - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - authType: - type: string - description: The type of authentication configured. - enum: - - AUTH_TYPE_UNSPECIFIED - - USER_PASSWORD - - OAUTH2_JWT_BEARER - - OAUTH2_CLIENT_CREDENTIALS - - SSH_PUBLIC_KEY - - OAUTH2_AUTH_CODE_FLOW - - GOOGLE_AUTHENTICATION - - OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED - enumDescriptions: - - Authentication type not specified. - - Username and Password Authentication. - - >- - JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant - based authentication - - Oauth 2.0 Client Credentials Grant Authentication - - SSH Public Key Authentication - - Oauth 2.0 Authorization Code Flow - - Google authentication - - >- - Oauth 2.0 Authorization Code Flow with Google Provided OAuth - Client - oauth2JwtBearer: - description: Oauth2JwtBearer. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - oauth2AuthCodeFlow: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - description: Oauth2AuthCodeFlow. - sshPublicKey: - description: SSH Public Key. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' - oauth2AuthCodeFlowGoogleManaged: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged - description: Oauth2AuthCodeFlowGoogleManaged. - userPassword: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' - description: UserPassword. - oauth2ClientCredentials: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - description: Oauth2ClientCredentials. - description: AuthConfig defines details of a authentication type. - GoogleCloudConnectorsV1DestinationConfig: + GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: + description: Response to list AuthConfigs. type: object - id: GoogleCloudConnectorsV1DestinationConfig + id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse properties: - destinations: - description: The destinations for the key. - type: array - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' - key: + nextPageToken: type: string - description: >- - The key is the destination identifier that is supported by the - Connector. - description: Define the Connectors target endpoint. - GoogleCloudIntegrationsV1alphaExecutionSnapshot: - description: Contains the snapshot of the execution for a given checkpoint. - type: object - properties: - executionSnapshotMetadata: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - description: Metadata of the execution snapshot. - params: - type: object - description: Parameters used during the execution. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - taskExecutionDetails: - description: All of the task execution details at the given point of time. + description: The token used to retrieve the next page of results. + authConfigs: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' type: array - checkpointTaskNumber: - type: string - description: >- - Indicates "after which checkpoint task's execution" this snapshot is - taken. - id: GoogleCloudIntegrationsV1alphaExecutionSnapshot - EnterpriseCrmEventbusProtoParameterMapEntry: - description: Entry is a pair of key and value. + description: The list of AuthConfigs retrieved. + GoogleCloudConnectorsV1NodeConfig: + type: object properties: - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - key: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + maxNodeCount: + format: int32 + description: Maximum number of nodes in the runtime nodes. + type: integer + minNodeCount: + description: Minimum number of nodes in the runtime nodes. + type: integer + format: int32 + id: GoogleCloudConnectorsV1NodeConfig + description: Node configuration for the connection. + GoogleCloudIntegrationsV1alphaParameterMap: type: object - id: EnterpriseCrmEventbusProtoParameterMapEntry - EnterpriseCrmEventbusProtoEventParameters: + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. properties: - parameters: + entries: type: array + description: A list of parameter map entries. items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry + keyType: + enum: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + type: string description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - description: >- - LINT.IfChange This message is used for processing and persisting (when - applicable) key value pair parameters for each event in the event bus. - Please see - id: EnterpriseCrmEventbusProtoEventParameters + Option to specify key type for all entries of the map. If provided + then field types for all entries must conform to this. + valueType: + type: string + description: >- + Option to specify value type for all entries of the map. If provided + then field types for all entries must conform to this. + enum: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + id: GoogleCloudIntegrationsV1alphaParameterMap + GoogleCloudIntegrationsV1alphaStringParameterArray: + id: GoogleCloudIntegrationsV1alphaStringParameterArray type: object - GoogleCloudIntegrationsV1alphaUnshareTemplateRequest: - id: GoogleCloudIntegrationsV1alphaUnshareTemplateRequest - description: Request to Unshare template + description: This message only contains a field of string array. properties: - resourceNames: - type: array + stringValues: items: type: string + description: String array. + type: array + GoogleCloudIntegrationsV1alphaUsernameAndPassword: + type: object + properties: + password: + description: Password to be used + type: string + username: + type: string + description: Username to be used + id: GoogleCloudIntegrationsV1alphaUsernameAndPassword + description: Username and password pair. + EnterpriseCrmFrontendsEventbusProtoTaskEntity: + properties: + taskType: + enumDescriptions: + - Normal IP task + - Task is of As-Is Template type + - Task is of I/O template type with a different underlying task + description: Defines the type of the task + type: string + enum: + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE + stats: + description: Deprecated - statistics from the Monarch query. + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusStats' + paramSpecs: description: >- - Optional. Project name resources to unshare the template. The - project names is expected in resource format Ex: - projects/{project-number} + Declarations for inputs/outputs for a TypedTask. This is also + associated with the METADATA mask. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + uiConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' + description: >- + UI configuration for this task Also associated with the METADATA + mask. + metadata: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' + description: Metadata inclueds the task name, author and so on. + disabledForVpcSc: + description: True if the task has conflict with vpcsc + type: boolean type: object - GoogleCloudIntegrationsV1alphaSfdcInstance: description: >- - The SfdcInstance resource use to hold channels and connection config - data. - type: object - id: GoogleCloudIntegrationsV1alphaSfdcInstance + Contains a task's metadata and associated information. Next available + id: 7 + id: EnterpriseCrmFrontendsEventbusProtoTaskEntity + GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: properties: - sfdcOrgId: - description: The SFDC Org Id. This is defined in salesforce. + projectId: type: string - deleteTime: + description: Optional. Project which has the topic given. + topic: type: string + description: Optional. Topic to push events which couldn't be processed. + type: object + description: Dead Letter configuration details provided by the user. + id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + GoogleCloudIntegrationsV1alphaSuspension: + description: A record representing a suspension. + type: object + id: GoogleCloudIntegrationsV1alphaSuspension + properties: + approvalConfig: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig description: >- - Output only. Time when the instance was deleted. Empty if not - deleted. - format: google-datetime - readOnly: true - updateTime: - description: Output only. Time when the instance was last updated + Controls the notifications and approval permissions for this + suspension. + lastModifyTime: readOnly: true + type: string format: google-datetime + description: Output only. Auto-generated. + createTime: type: string - name: + readOnly: true + description: Output only. Auto-generated. + format: google-datetime + audit: + description: Metadata pertaining to the resolution of this suspension. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' + state: + enum: + - RESOLUTION_STATE_UNSPECIFIED + - PENDING + - REJECTED + - LIFTED + enumDescriptions: + - Unset state. + - The suspension has not yet been resolved. + - The resolver has rejected the suspension. + - The resolver has lifted the suspension. + description: >- + Required. State of this suspension, indicating what action a + resolver has taken. type: string + suspensionConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' description: >- - Resource name of the SFDC instance - projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. - createTime: - readOnly: true - description: Output only. Time when the instance is created - format: google-datetime + Controls the notifications and resolver permissions for this + suspension. + deprecated: true + taskId: type: string - serviceAuthority: + description: Required. Task id of the associated SuspensionTask. + eventExecutionInfoId: + description: Required. ID of the associated execution. type: string - description: >- - URL used for API calls after authentication (the login authority is - configured within the referenced AuthConfig). - displayName: - description: User selected unique name/alias to easily reference an instance. + name: type: string - authConfigId: - description: A list of AuthConfigs that can be tried to open the channel to SFDC - type: array - items: - type: string - description: + description: Resource name for suspensions suspension/{suspension_id} + integration: + description: Required. The name of the originating integration. type: string - description: A description of the sfdc instance. - EnterpriseCrmFrontendsEventbusProtoParameterMapField: - id: EnterpriseCrmFrontendsEventbusProtoParameterMapField - description: Field represents either the key or value in an entry. + GoogleCloudIntegrationsV1alphaEventParameter: properties: - referenceKey: + key: type: string - description: Referencing one of the WF variables. - literalValue: - description: Passing a literal value. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - type: object - EnterpriseCrmEventbusProtoTransformExpression: - id: EnterpriseCrmEventbusProtoTransformExpression + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. + value: + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + masked: + type: boolean + description: True if this parameter should be masked in the logs type: object - properties: - initialValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' - description: Initial value upon which to perform transformations. - transformationFunctions: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' - type: array - description: Transformations to be applied sequentially. - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: + id: GoogleCloudIntegrationsV1alphaEventParameter + description: >- + This message is used for processing and persisting (when applicable) key + value pair parameters for each event in the event bus. Next available + id: 4 + GoogleCloudConnectorsV1ConfigVariable: type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + id: GoogleCloudConnectorsV1ConfigVariable + description: >- + ConfigVariable represents a configuration variable present in a + Connection. or AuthConfig. properties: - max: - format: int64 - description: The inclusive maximum of the acceptable range. + boolValue: + description: Value is a bool. + type: boolean + key: + description: Key of the config variable. type: string - min: - description: The inclusive minimum of the acceptable range. + encryptionKeyValue: + $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' + description: Value is a Encryption Key. + stringValue: + type: string + description: Value is a string. + secretValue: + description: Value is a secret. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + intValue: + description: Value is an integer format: int64 type: string - description: Range used to validate longs and ints. - GoogleCloudIntegrationsV1alphaClientCertificate: - type: object + EnterpriseCrmEventbusProtoPropertyEntry: properties: - encryptedPrivateKey: - type: string + key: description: >- - The ssl certificate encoded in PEM format. This string must include - the begin header and end footer lines. For example, -----BEGIN - CERTIFICATE----- - MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV - BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw - MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET - MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA - vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 - JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB - xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P - AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB - Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey - Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW - JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr - 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H - wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- - sslCertificate: + Key is used to retrieve the corresponding property value. This + should be unique for a given fired event. The Tasks should be aware + of the keys used while firing the events for them to be able to + retrieve the values. type: string + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' description: >- - The ssl certificate encoded in PEM format. This string must include - the begin header and end footer lines. For example, -----BEGIN - CERTIFICATE----- - MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV - BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw - MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET - MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA - vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 - JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB - xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P - AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB - Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey - Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW - JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr - 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H - wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- - passphrase: - description: >- - 'passphrase' should be left unset if private key is not encrypted. - Note that 'passphrase' is not the password for web server, but an - extra layer of security to protected private key. - type: string - id: GoogleCloudIntegrationsV1alphaClientCertificate - description: Contains client certificate information - GoogleCloudIntegrationsV1alphaSuspension: - description: A record representing a suspension. + Values for the defined keys. Each value can either be string, int, + double or any proto message. + id: EnterpriseCrmEventbusProtoPropertyEntry + type: object + description: Key-value pair of EventBus property. + EnterpriseCrmEventbusProtoDoubleArray: type: object - id: GoogleCloudIntegrationsV1alphaSuspension properties: - name: - description: Resource name for suspensions suspension/{suspension_id} - type: string - approvalConfig: + values: + type: array + items: + type: number + format: double + id: EnterpriseCrmEventbusProtoDoubleArray + EnterpriseCrmEventbusProtoConditionalFailurePolicies: + properties: + defaultFailurePolicy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' description: >- - Controls the notifications and approval permissions for this - suspension. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig - state: - enumDescriptions: - - Unset state. - - The suspension has not yet been resolved. - - The resolver has rejected the suspension. - - The resolver has lifted the suspension. + The default failure policy to be applied if no conditional failure + policy matches + failurePolicies: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + description: >- + The list of failure policies that will be applied to the task in + order. + type: array + id: EnterpriseCrmEventbusProtoConditionalFailurePolicies + type: object + GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + properties: {} + type: object + description: Request for TakeoverEditLock. + CrmlogErrorCode: + properties: + commonErrorCode: + enumDeprecated: + - false + - true + - false + - false + - true + - true + - true + - false + - false + - true + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false enum: - - RESOLUTION_STATE_UNSPECIFIED - - PENDING - - REJECTED - - LIFTED - description: >- - Required. State of this suspension, indicating what action a - resolver has taken. - type: string - taskId: - type: string - description: Required. Task id of the associated SuspensionTask. - lastModifyTime: - format: google-datetime - description: Output only. Auto-generated. - readOnly: true - type: string - eventExecutionInfoId: - type: string - description: Required. ID of the associated execution. - suspensionConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - deprecated: true - description: >- - Controls the notifications and resolver permissions for this - suspension. - integration: - description: Required. The name of the originating integration. - type: string - audit: - description: Metadata pertaining to the resolution of this suspension. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' - createTime: - format: google-datetime - type: string - description: Output only. Auto-generated. - readOnly: true - EnterpriseCrmEventbusProtoProtoArrayFunction: - properties: - functionName: - type: string + - COMMON_ERROR_CODE_UNSPECIFIED + - INVALID_CREDENTIALS + - REQUIRED_FIELDS_MISSING + - INVALID_FIELDS + - BACKEND + - GENERAL + - INTERNAL + - IO_ERROR + - NOT_FOUND + - EVENT_BUS + - ALREADY_EXISTS + - CONCORD + - CONVERSION + - FLUME + - PERMISSION + - SALES_FORCE + - SPANNER + - UNIMPLEMENTED + - RELTIO + - WORKFLOW_NOT_FOUND + - QUOTA_THROTTLED + - QUOTA_ENQUEUED + - INVALID_QUOTA_CONFIGURATION + - TASK_NOT_FOUND + - EXECUTION_TIMEOUT + - INVALID_EVENT_EXECUTION_STATE + - INVALID_ATTRIBUTE + - MISSING_ATTRIBUTE + - CLIENT_UNAUTHORIZED_FOR_WORKFLOW + - INVALID_PARAMETER + - MISSING_PARAMETER + - UNAUTHROIZED_WORKFLOW_EDITOR_ACTION + - FAILED_PRECONDITION + - INVALID_CLIENT + - MISSING_CLIENT + - INVALID_WORKFLOW + - MISSING_QUOTA_CONFIGURATION + - UNHANDLED_TASK_ERROR + - SCRIPT_TASK_RUNTIME_ERROR + - RPC + - INVALID_PROTO + - UNHANDLED_EVENTBUS_ERROR + - INVALID_TASK_STATE + - TYPED_TASK_INVALID_INPUT_OPERATION + - TYPED_TASK_INVALID_OUTPUT_OPERATION + - VALIDATION_ERROR + - RESUME_ERROR + - APPS_SCRIPT_EXECUTION_ERROR + - INVALID_VECTOR_USER + - INFORMATICA + - RETRYABLE_TASK_ERROR + - INVALID_TENANT + - WRONG_TENANT + - INFORMATICA_BACKEND_UNAVAILABLE + - RPC_PERMISSION_DENIED + - SYNC_EVENTBUS_EXECUTION_TIMEOUT + - ASYNC_EVENTBUS_EXECUTION_TIMEOUT + - NOT_SUPPORTED_DATA_TYPE + - UNSANITIZED_USER_INPUT + - TRANSFORM_EXPRESSION_EVALUATION_ERROR + - HTTP_EXCEPTION + - EXECUTION_CANCELLED enumDescriptions: - '' - '' @@ -2491,45 +1312,6 @@ components: - '' - '' - '' - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - id: EnterpriseCrmEventbusProtoProtoArrayFunction - type: object - EnterpriseCrmEventbusProtoDoubleFunction: - properties: - functionName: - enum: - - UNSPECIFIED - - TO_JSON - - TO_STRING - - ADD - - SUBTRACT - - MULTIPLY - - DIVIDE - - EXPONENT - - ROUND - - FLOOR - - CEIL - - GREATER_THAN - - LESS_THAN - - EQUALS - - GREATER_THAN_EQUALS - - LESS_THAN_EQUALS - - MOD - type: string - enumDescriptions: - '' - '' - '' @@ -2547,117 +1329,114 @@ components: - '' - '' - '' - type: object - id: EnterpriseCrmEventbusProtoDoubleFunction - GoogleCloudIntegrationsV1alphaJwt: - properties: - jwt: - type: string - description: The token calculated by the header, payload and signature. - jwtPayload: - type: string - description: >- - Contains a set of claims. The JWT specification defines seven - Registered Claim Names which are the standard fields commonly - included in tokens. Custom claims are usually also included, - depending on the purpose of the token. - jwtHeader: - description: Identifies which algorithm is used to generate the signature. - type: string - secret: - description: User's pre-shared secret to sign the token. - type: string - description: >- - Represents JSON web token(JWT), which is a compact, URL-safe means of - representing claims to be transferred between two parties, enabling the - claims to be digitally signed or integrity protected. - type: object - id: GoogleCloudIntegrationsV1alphaJwt - GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: - description: Metadata of the execution snapshot. - properties: - executionAttempt: - type: integer - description: the execution attempt number this snapshot belongs to. - format: int32 - taskLabel: - type: string - description: the task label associated with this snapshot. Could be empty. - ancestorIterationNumbers: - items: - type: string - description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - type: array - taskAttempt: - type: integer - format: int32 - description: the task attempt number this snapshot belongs to. - task: - type: string - description: the task name associated with this snapshot. - taskNumber: - type: string - description: The task number associated with this snapshot. - ancestorTaskNumbers: - type: array - items: - type: string - description: >- - Ancestor task number for the task(it will only be non-empty if the - task is under 'private workflow') - integrationName: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. + - >- + ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use + only. This error will be counted as server availability error. + - '' + - '' + - '' + - '' + - '' type: string - description: >- - The direct integration which the event execution snapshots belongs - to - id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - type: object - EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: + description: >- + Registered ids for errors, as "oneof" enums. Each task or logical + grouping of tasks may share the same enum. type: object - id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + id: CrmlogErrorCode + EnterpriseCrmEventbusStatsDimensions: + id: EnterpriseCrmEventbusStatsDimensions properties: - startTime: + triggerId: + type: string description: >- - The start time of the event execution for current attempt. This - could be in the future if it's been scheduled. - format: int64 + Stats have been or will be aggregated on set fields for any + semantically-meaningful combination. + taskName: type: string - endTime: - description: The end time of the event execution for current attempt. + warningEnumString: type: string - format: int64 - EnterpriseCrmEventbusProtoParameterMap: - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - type: object - properties: - valueType: + clientId: + type: string + errorEnumString: + type: string + retryAttempt: enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE + - UNSPECIFIED + - FINAL + - RETRYABLE + - CANCELED + enumDescriptions: + - '' + - >- + Task has completed successfully or has depleted all retry + attempts. + - Task has failed but may be retried. + - Task has been deliberately canceled. + type: string + workflowName: + type: string + enumFilterType: + description: Whether to include or exclude the enums matching the regex. type: string enumDescriptions: - '' - '' + enum: + - DEFAULT_INCLUSIVE + - EXCLUSIVE + taskNumber: + type: string + workflowId: + type: string + type: object + EnterpriseCrmEventbusProtoIntFunction: + properties: + functionName: + enum: + - UNSPECIFIED + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - GREATER_THAN_EQUAL_TO + - GREATER_THAN + - LESS_THAN_EQUAL_TO + - LESS_THAN + - TO_DOUBLE + - TO_STRING + - EQUALS + - TO_JSON + - MOD + - EPOCH_TO_HUMAN_READABLE_TIME + enumDescriptions: + - '' - '' - '' - '' @@ -2670,14 +1449,33 @@ components: - '' - '' - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - '' - '' - '' - keyType: + type: string + type: object + id: EnterpriseCrmEventbusProtoIntFunction + EnterpriseCrmEventbusProtoFieldMappingConfig: + id: EnterpriseCrmEventbusProtoFieldMappingConfig + properties: + mappedFields: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' + type: array + type: object + description: >- + Field Mapping Config to map multiple output fields values from input + fields values. + EnterpriseCrmFrontendsEventbusProtoParameterEntry: + description: Key-value pair of EventBus parameters. + properties: + key: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the workflow definition. + type: string + dataType: enum: - DATA_TYPE_UNSPECIFIED - STRING_VALUE @@ -2697,9 +1495,6 @@ components: - BYTES_ARRAY - NON_SERIALIZABLE_OBJECT - JSON_VALUE - description: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. enumDescriptions: - '' - '' @@ -2723,415 +1518,506 @@ components: - '' - '' type: string - entries: + description: Explicitly getting the type of the parameter. + masked: + type: boolean + description: True if this parameter should be masked in the logs + value: + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + type: object + id: EnterpriseCrmFrontendsEventbusProtoParameterEntry + GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged: + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + properties: + authCode: + type: string + description: >- + Optional. Authorization code to be exchanged for access and refresh + tokens. + redirectUri: + type: string + description: Optional. Redirect URI to be provided during the auth code exchange. + scopes: + description: >- + Required. Scopes the connection will request when the user performs + the auth code flow. type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' - id: EnterpriseCrmEventbusProtoParameterMap - GoogleCloudIntegrationsV1alphaSerializedFile: + type: string + type: object + description: >- + Parameters to support Oauth 2.0 Auth Code Grant Authentication using + Google Provided OAuth Client. See + https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. + GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: + properties: + suspensionResult: + type: string + description: >- + User passed in suspension result and will be used to control + workflow execution branching behavior by setting up corresponnding + edge condition with suspension result. For example, if you want to + lift the suspension, you can pass "Approved", or if you want to + reject the suspension and terminate workfloe execution, you can pass + "Rejected" and terminate the workflow execution with configuring the + edge condition. + type: object + id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + description: Request for lift Suspension + GoogleCloudIntegrationsV1alphaUploadTemplateRequest: + id: GoogleCloudIntegrationsV1alphaUploadTemplateRequest + type: object + description: Request for UploadTemplate. + properties: + fileFormat: + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + type: string + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + description: Required. File format for upload request. + content: + type: string + description: Required. The textproto of the template. + GoogleCloudIntegrationsV1alphaUseTemplateRequest: + properties: + subIntegrations: + description: Optional. Sub Integration which would be created via templates. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + type: object + integrationRegion: + description: Required. The region of the Integration to be created. + type: string + integrationDetails: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + description: Required. Integration details which would be created via templates. + description: Request to Use template + id: GoogleCloudIntegrationsV1alphaUseTemplateRequest + type: object + EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: + properties: + resolvedBy: + type: string + resolvedByCpi: + type: string + timestamp: + type: string + format: google-datetime + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + type: object + EnterpriseCrmEventbusProtoSerializedObjectParameter: + properties: + objectValue: + type: string + format: byte + type: object + id: EnterpriseCrmEventbusProtoSerializedObjectParameter + EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + properties: + doubleRange: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + intRange: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + stringRegex: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + type: object + GoogleCloudIntegrationsV1alphaIntegration: + description: The integration definition. + id: GoogleCloudIntegrationsV1alphaIntegration type: object - description: To store string representation of Integration file. - id: GoogleCloudIntegrationsV1alphaSerializedFile properties: - file: - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - description: >- - File information like Integration version, Integration Config - variables etc. + name: type: string - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. - content: - description: String representation of the file content. + description: Required. The resource name of the integration. + description: type: string - GoogleCloudIntegrationsV1alphaListExecutionsResponse: - type: object - id: GoogleCloudIntegrationsV1alphaListExecutionsResponse - description: Response for listing the integration execution data. - properties: - nextPageToken: + description: Optional. + createTime: type: string - description: The token used to retrieve the next page results. - executions: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - description: The detailed information of requested executions - type: array - executionInfos: - description: Required. The detailed information of requested executions. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - type: array - deprecated: true - GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: - description: Response for Suspensions.ResolveSuspensions. - type: object - properties: {} - id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse - GoogleCloudIntegrationsV1alphaParameterMap: - id: GoogleCloudIntegrationsV1alphaParameterMap + format: google-datetime + readOnly: true + description: Required. Output only. Auto-generated. + active: + description: Required. If any integration version is published. + type: boolean + updateTime: + readOnly: true + type: string + format: google-datetime + description: Output only. Auto-generated. + creatorEmail: + readOnly: true + type: string + description: >- + Output only. The creator's email address. Generated based on the End + User Credentials/LOAS role of the user making the call. + lastModifierEmail: + type: string + description: Required. The last modifier of this integration + GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. + Parameters to support Oauth 2.0 Auth Code Grant Authentication. See + https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. type: object + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow properties: - entries: + redirectUri: + type: string + description: Redirect URI to be provided during the auth code exchange. + clientId: + type: string + description: Client ID for user-provided OAuth app. + pkceVerifier: + type: string + description: PKCE verifier to be used during the auth code exchange. + clientSecret: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Client secret for user-provided OAuth app. + scopes: type: array items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry - description: A list of parameter map entries. - valueType: - enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - - NON_SERIALIZABLE_OBJECT - type: string - enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - - // Non-serializable object (Internal use only). + type: string description: >- - Option to specify value type for all entries of the map. If provided - then field types for all entries must conform to this. - keyType: - enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - - // Non-serializable object (Internal use only). - enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - - NON_SERIALIZABLE_OBJECT + Scopes the connection will request when the user performs the auth + code flow. + enablePkce: + type: boolean + description: Whether to enable PKCE when the user performs the auth code flow. + authUri: type: string - description: >- - Option to specify key type for all entries of the map. If provided - then field types for all entries must conform to this. - EnterpriseCrmEventbusProtoCloudLoggingDetails: + description: Auth URL for Authorization Code Flow + authCode: + type: string + description: Authorization code to be exchanged for access and refresh tokens. + GoogleCloudIntegrationsV1alphaIntegrationVersion: + id: GoogleCloudIntegrationsV1alphaIntegrationVersion + type: object + description: The integration version definition. properties: - enableCloudLogging: + origin: + type: string description: >- - Status of whether Cloud Logging is enabled or not for the - integration version getting executed. - type: boolean - cloudLoggingSeverity: + Optional. The origin that indicates where this integration is coming + from. + enum: + - UNSPECIFIED + - UI + - PIPER_V2 + - PIPER_V3 + - APPLICATION_IP_PROVISIONING + - TEST_CASE + deprecated: true enumDescriptions: - - Unspecified - - >- - If Severity selected is `INFO`, then all the Integration Execution - States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, - `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + - '' + - Workflow is being created via event bus UI. - >- - If Severity selected is `ERROR`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. + User checked in this workflow in Piper as v2 textproto format and + we synced it into spanner. - >- - If Severity selected is `WARNING`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. + User checked in this workflow in piper as v3 textproto format and + we synced it into spanner. + - Workflow is being created via Standalone IP Provisioning + - Workflow is being created via Test Case. + enumDeprecated: + - false + - false + - true + - false + - false + - false + userLabel: type: string - enum: - - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - - INFO - - ERROR - - WARNING description: >- - Severity selected by the customer for the logs to be sent to Cloud - Logging, for the integration version getting executed. - description: >- - Cloud Logging details, selected by the user for the integration version - (workflow). This message field will be also used in ExecutionInfo, to - indicate the CloudLoggingDetails config at the time of workflow - (integration version) execution, since this field value can be changed - for an unpublished workflow. - id: EnterpriseCrmEventbusProtoCloudLoggingDetails - type: object - GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: - id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse - type: object - description: Response for DownloadJsonPackage. - properties: - files: - type: array - description: List containing JSON for multiple file with type information. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' - GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: - id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - description: WebhookData has details of webhook configuration. - properties: - createTime: - readOnly: true - format: google-datetime - description: Output only. Timestamp when the webhook was created. - type: string - additionalVariables: - readOnly: true - description: Output only. Additional webhook related field values. + Optional. A user-defined label that annotates an integration + version. Typically, this is only set when the integration version is + created. + triggerConfigs: items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' + description: Optional. Trigger configurations. type: array - name: - type: string - description: Output only. Name of the Webhook - readOnly: true - id: - description: Output only. ID to uniquely identify webhook. + taskConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' + description: >- + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. + triggerConfigsInternal: + description: Optional. Trigger configurations. + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig + type: array + createTime: type: string readOnly: true - updateTime: - description: Output only. Timestamp when the webhook was last updated. - readOnly: true - type: string + description: Output only. Auto-generated. format: google-datetime - nextRefreshTime: - readOnly: true + createdFromTemplate: description: >- - Output only. Next webhook refresh time. Will be null if refresh is - not supported. - type: string - format: google-datetime - type: object - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims - description: JWT claims used for the jwt-bearer authorization grant. - properties: - issuer: - description: Value for the "iss" claim. - type: string - subject: - description: Value for the "sub" claim. + Optional. Optional. The resource name of the template from which the + integration is created. type: string - audience: - description: Value for the "aud" claim. + description: type: string - type: object - GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: - description: Request for [Suspensions.ResolveSuspensions]. - id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest - properties: - suspension: + description: Optional. The integration description. + teardown: + deprecated: true description: >- - Suspension, containing the event_execution_info_id, task_id, and - state to set on the corresponding suspension record. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' - type: object - EnterpriseCrmEventbusProtoDoubleParameterArray: - id: EnterpriseCrmEventbusProtoDoubleParameterArray - properties: - doubleValues: - items: - format: double - type: number - type: array - type: object - EnterpriseCrmEventbusProtoWorkflowAlertConfig: - description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. - properties: - durationThresholdMs: + Optional. Contains a graph of tasks that will be executed before + putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), + regardless of success or failure, similar to "finally" in code. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' + enableVariableMasking: + type: boolean + description: >- + Optional. True if variable masking feature should be turned on for + this version + snapshotNumber: format: int64 type: string description: >- - Should be specified only for *AVERAGE_DURATION and - *PERCENTILE_DURATION metrics. This member should be used to specify - what duration value the metrics should exceed for the alert to - trigger. - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - clientId: - description: Client associated with this alert configuration. + Optional. An increasing sequence that is set when a new snapshot is + created. The last created snapshot can be identified by + [workflow_name, org_id latest(snapshot_number)]. However, last + created snapshot need not be same as the HEAD. So users should + always use "HEAD" tag to identify the head. + parentTemplateId: + description: >- + Optional. The id of the template which was used to create this + integration_version. type: string - alertName: + lastModifierEmail: type: string description: >- - A name to identify this alert. This will be displayed in the alert - subject. If set, this name should be unique within the scope of the - workflow. - numAggregationPeriods: - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - type: integer - format: int32 - aggregationPeriod: + Optional. The last modifier's email address. Generated based on the + End User Credentials/LOAS role of the user making the call. + state: + enum: + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + description: Output only. User should not set it as an input. type: string - description: >- - For an EXPECTED_MIN threshold, this aggregation_period must be - lesser than 24 hours. - onlyFinalAttempt: - description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. - type: boolean - thresholdValue: + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + readOnly: true + cloudLoggingDetails: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + description: Optional. Cloud Logging details for the integration version + updateTime: + description: Output only. Auto-generated. + readOnly: true + format: google-datetime + type: string + runAsServiceAccount: description: >- - The metric value, above or below which the alert should be - triggered. - metricType: + Optional. The run-as service account email, if set and auth config + is not configured, that will be used to generate auth token to be + used in Connector task, Rest caller task and Cloud function task. type: string - enum: - - METRIC_TYPE_UNSPECIFIED - - EVENT_ERROR_RATE - - EVENT_WARNING_RATE - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - EVENT_RATE - - EVENT_AVERAGE_DURATION - - EVENT_PERCENTILE_DURATION - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - enumDescriptions: - - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors for the enclosing - workflow. - - >- - Specifies alerting on the rate of warnings for the enclosing - workflow. Warnings use the same enum values as errors. - - >- - Specifies alerting on the rate of errors for any task in the - enclosing workflow. - - >- - Specifies alerting on the rate of warnings for any task in the - enclosing workflow. - - >- - Specifies alerting on the rate of executions over all tasks in the - enclosing workflow. - - >- - Specifies alerting on the number of events executed in the given - aggregation_period. - - >- - Specifies alerting on the average duration of executions for this - workflow. - - >- - Specifies alerting on the duration value of a particular - percentile of workflow executions. E.g. If 10% or more of the - workflow executions have durations above 5 seconds, alert. - - >- - Specifies alerting on the average duration of any task in the - enclosing workflow, - - >- - Specifies alerting on the duration value of a particular - percentile of any task executions within the enclosing workflow. - E.g. If 10% or more of the task executions in the workflow have - durations above 5 seconds, alert. - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - alertDisabled: - type: boolean + integrationConfigParameters: description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. - thresholdType: + Optional. Config Parameters that are expected to be passed to the + integration when an integration is published. This consists of all + the parameters that are expected to provide configuration in the + integration execution. This gives the user the ability to provide + default values, value, add information like connection url, project + based configuration value and also provide data types of each + parameter. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationConfigParameter + type: array + errorCatcherConfigs: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig description: >- - The threshold type, whether lower(expected_min) or - upper(expected_max), for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. - enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX + Optional. Error Catch Task configuration for the integration. It's + optional. + status: + deprecated: true enumDescriptions: - '' - - >- - Note that this field will only trigger alerts if the workflow - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. + - '' + - '' + - '' - '' type: string - playbookUrl: + description: >- + Output only. Generated by eventbus. User should not set it as an + input. + readOnly: true + enum: + - UNKNOWN + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + name: type: string + readOnly: true + description: Output only. Auto-generated primary key. + databasePersistencePolicy: + enumDescriptions: + - Enables persistence for all execution data. + - Disables persistence for all execution data. + - Asynchronously persist all execution data. + enum: + - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED + - DATABASE_PERSISTENCE_DISABLED + - DATABASE_PERSISTENCE_ASYNC description: >- - Link to a playbook for resolving the issue that triggered this - alert. - type: object - id: EnterpriseCrmEventbusProtoWorkflowAlertConfig - EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: - id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition - type: object - properties: - fullName: + Optional. Flag to disable database persistence for execution data, + including event execution info, execution export info, execution + metadata index and execution param index. type: string + lockHolder: description: >- - The fully-qualified proto name. This message, for example, would be - "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". - path: + Optional. The edit lock holder's email address. Generated based on + the End User Credentials/LOAS role of the user making the call. type: string - description: Path to the proto file that contains the message type's definition. - EnterpriseCrmEventbusProtoBaseFunction: + taskConfigsInternal: + description: >- + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. + deprecated: true + items: + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' + type: array + integrationParametersInternal: + deprecated: true + description: >- + Optional. Parameters that are expected to be passed to the + integration when an event is triggered. This consists of all the + parameters that are expected in the integration execution. This + gives the user the ability to provide default values, add + information like PII and also provide data types of each parameter. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + integrationParameters: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + description: >- + Optional. Parameters that are expected to be passed to the + integration when an event is triggered. This consists of all the + parameters that are expected in the integration execution. This + gives the user the ability to provide default values, add + information like PII and also provide data types of each parameter. + type: array + EnterpriseCrmFrontendsEventbusProtoTriggerConfig: + id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig type: object - id: EnterpriseCrmEventbusProtoBaseFunction properties: - functionName: + nextTasksExecutionPolicy: enum: - UNSPECIFIED - - NOW_IN_MILLIS - - INT_LIST - - ENVIRONMENT - - GET_EXECUTION_ID - - GET_INTEGRATION_NAME - - GET_REGION - - GET_UUID - - GET_PROJECT_ID + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + type: string + enumDescriptions: + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + description: Dictates how next tasks will be executed. + position: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + description: >- + Optional. Informs the front-end application where to draw this + trigger config on the UI. + triggerName: + type: string + description: >- + Optional. Name of the trigger This is added to identify the type of + trigger. This is avoid the logic on triggerId to identify the + trigger_type and push the same to monitoring. + startTasks: + description: >- + Set of tasks numbers from where the workflow execution is started by + this trigger. If this is empty, then workflow is executed with + default start tasks. In the list of start tasks, none of two tasks + can have direct ancestor-descendant relationships (i.e. in a same + workflow execution graph). + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + triggerNumber: + type: string + description: >- + Required. A number to uniquely identify each trigger config within + the workflow on UI. + triggerCriteria: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria' + description: >- + Optional. When set, Eventbus will run the task specified in the + trigger_criteria and validate the result using the + trigger_criteria.condition, and only execute the workflow when + result is true. + description: + description: >- + User-provided description intended to give more business context + about the task. + type: string + properties: + description: >- + Configurable properties of the trigger, not to be confused with + workflow parameters. E.g. "name" is a property for API triggers and + "subscription" is a property for Cloud Pubsub triggers. + additionalProperties: + type: string + type: object + pauseWorkflowExecutions: + description: >- + Optional. If set to true, any upcoming requests for this trigger + config will be paused and the executions will be resumed later when + the flag is reset. The workflow to which this trigger config belongs + has to be in ACTIVE status for the executions to be paused or + resumed. + type: boolean + triggerType: + enum: + - UNKNOWN + - CLOUD_PUBSUB + - GOOPS + - SFDC_SYNC + - CRON + - API + - MANIFOLD_TRIGGER + - DATALAYER_DATA_CHANGE + - SFDC_CHANNEL + - CLOUD_PUBSUB_EXTERNAL + - SFDC_CDC_CHANNEL + - SFDC_PLATFORM_EVENTS_CHANNEL + - CLOUD_SCHEDULER + - INTEGRATION_CONNECTOR_TRIGGER + - PRIVATE_TRIGGER enumDescriptions: - '' - '' @@ -3142,2145 +2028,2519 @@ components: - '' - '' - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - GoogleCloudIntegrationsV1alphaShareTemplateRequest: - id: GoogleCloudIntegrationsV1alphaShareTemplateRequest - description: Request to Share template - properties: - resourceNames: + alertConfig: + description: >- + An alert threshold configuration for the [trigger + client + + workflow] tuple. If these values are not specified in the trigger + config, default values will be populated by the system. Note that + there must be exactly one alert threshold configured per [client + + trigger + workflow] when published. items: - type: string + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' type: array - description: >- - Optional. Project name resources to share the template. The project - names is expected in resource format Ex: projects/{project-number} - or organization/{org-id} - type: object - GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate: - description: Define the template of IntegrationVersion. - type: object - properties: - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Required. Templatized version of integration. - key: - description: Required. Unique Key of the IntegrationVersion. - type: string - id: GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate - GoogleCloudIntegrationsV1alphaCertificate: - properties: - name: - description: Output only. Auto generated primary key - type: string - readOnly: true - displayName: - type: string - description: Required. Name of the certificate - validStartTime: - description: Output only. The timestamp after which certificate will be valid - readOnly: true - type: string - format: google-datetime - validEndTime: - description: Output only. The timestamp after which certificate will expire - type: string - readOnly: true - format: google-datetime - requestorId: + triggerId: + description: The backend trigger ID. type: string + enabledClients: + items: + type: string description: >- - Immutable. Requestor ID to be used to register certificate with - trawler - rawCertificate: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' - description: >- - Input only. Raw client certificate which would be registered with - trawler - description: + Required. The list of client ids which are enabled to execute the + workflow using this trigger. In other words, these clients have the + workflow execution privledges for this trigger. For API trigger, the + client id in the incoming request is validated against the list of + enabled clients. For non-API triggers, one workflow execution is + triggered on behalf of each enabled client. + type: array + errorCatcherId: type: string - description: Description of the certificate - credentialId: + description: >- + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task + cloudSchedulerConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' + label: type: string - description: Immutable. Credential id that will be used to register with trawler - certificateStatus: + description: The user created label for a particular trigger. + description: 'Configuration detail of a trigger. Next available id: 20' + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: + description: Response for LinkAppsScriptProject rpc call. + properties: + scriptId: type: string - enumDescriptions: - - Unspecified certificate status - - Certificate in active state will be able to use - - Certificate in expired state needs to be updated - description: Status of the certificate - enum: - - STATE_UNSPECIFIED - - ACTIVE - - EXPIRED + description: The id of the linked Apps Script project. + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse type: object - id: GoogleCloudIntegrationsV1alphaCertificate - description: The certificate definition - GoogleCloudIntegrationsV1alphaUploadTemplateResponse: + GoogleProtobufEmpty: + properties: {} + id: GoogleProtobufEmpty + 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); } type: object - id: GoogleCloudIntegrationsV1alphaUploadTemplateResponse - properties: - template: - description: The uploaded Template - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' - description: Response for UploadTemplate. - GoogleCloudIntegrationsV1alphaListCertificatesResponse: - description: Response to list Certificates. + EnterpriseCrmEventbusProtoBooleanParameterArray: + type: object + id: EnterpriseCrmEventbusProtoBooleanParameterArray properties: - nextPageToken: - type: string - description: The token used to retrieve the next page of results. - certificates: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + booleanValues: type: array - description: The list of Certificates retrieved. - id: GoogleCloudIntegrationsV1alphaListCertificatesResponse + items: + type: boolean + GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: + description: Response for DownloadIntegrationVersion. type: object - GoogleCloudIntegrationsV1alphaCredential: - id: GoogleCloudIntegrationsV1alphaCredential - description: Defines parameters for a single, canonical credential. properties: - oidcToken: - description: Google OIDC ID Token - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' - jwt: - description: JWT credential - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' - authToken: - description: Auth token credential - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' - oauth2ResourceOwnerCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials - description: OAuth2 resource owner credentials - oauth2ClientCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials - description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials - oauth2AuthorizationCode: - description: >- - The api_key and oauth2_implicit are not covered in v1 and will be - picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 - authorization code credential - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode - serviceAccountCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials - description: Service account credential - usernameAndPassword: - description: Username and password credential - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword - credentialType: + files: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' + description: List containing String represendation for multiple file with type. + content: type: string - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - enumDescriptions: - - Unspecified credential type - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - description: Credential type associated with auth config. - type: object - GoogleCloudIntegrationsV1alphaRuntimeActionSchema: - type: object + description: String representation of the requested file. + id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + GoogleCloudIntegrationsV1alphaJwt: + description: >- + Represents JSON web token(JWT), which is a compact, URL-safe means of + representing claims to be transferred between two parties, enabling the + claims to be digitally signed or integrity protected. + id: GoogleCloudIntegrationsV1alphaJwt properties: - action: + jwt: + description: The token calculated by the header, payload and signature. type: string - description: Name of the action. - inputSchema: - description: Input parameter schema for the action. + secret: + description: User's pre-shared secret to sign the token. type: string - outputSchema: - description: Output parameter schema for the action. + jwtPayload: + type: string + description: >- + Contains a set of claims. The JWT specification defines seven + Registered Claim Names which are the standard fields commonly + included in tokens. Custom claims are usually also included, + depending on the purpose of the token. + jwtHeader: + description: Identifies which algorithm is used to generate the signature. type: string - id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema - description: Metadata of an action, including schemas for its inputs and outputs. - GoogleCloudConnectorsV1BillingConfig: type: object + GoogleCloudConnectorsV1ResourceRequests: + description: Resource requests defined for connection pods of a given connector type. properties: - billingCategory: - enum: - - BILLING_CATEGORY_UNSPECIFIED - - GCP_AND_TECHNICAL_CONNECTOR - - NON_GCP_CONNECTOR + memory: type: string - enumDescriptions: - - Billing category is not specified. - - GCP/Technical connector. - - Non-GCP connector. + description: Output only. Memory request. readOnly: true - description: Output only. Billing category for the connector. - description: Billing config for the connection. - id: GoogleCloudConnectorsV1BillingConfig - GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: - id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode - description: >- - The OAuth Type where the client sends request with the client id and - requested scopes to auth endpoint. User sees a consent screen and auth - code is received at specified redirect url afterwards. The auth code is - then combined with the client id and secret and sent to the token - endpoint in exchange for the access and refresh token. The refresh token - can be used to fetch new access tokens. + cpu: + readOnly: true + type: string + description: Output only. CPU request. type: object + id: GoogleCloudConnectorsV1ResourceRequests + GoogleCloudIntegrationsV1alphaProjectProperties: + id: GoogleCloudIntegrationsV1alphaProjectProperties + description: Metadata information for the given project properties: - tokenParams: - description: The token parameters sent along with the token request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - requestType: + ipEnablementState: + type: string + enumDescriptions: + - The client enablement status is unspecified + - The client is enabled on Standalone IP + - The client is enabled on Apigee + - The client is entitled for Apigee but not enabled + description: An enum value of what the enablement state is for the given project enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER - description: Represent how to pass parameters to fetch access token + - IP_ENABLEMENT_STATE_UNSPECIFIED + - IP_ENABLEMENT_STATE_STANDALONE + - IP_ENABLEMENT_STATE_APIGEE + - IP_ENABLEMENT_STATE_APIGEE_ENTITLED + billingType: + description: 'Required. Required: The client billing type that was requested' type: string + enum: + - BILLING_TYPE_UNSPECIFIED + - APIGEE_TRIALS + - APIGEE_SUBSCRIPTION + - PAYG + - SUBSCRIPTION + - NO_BILLING enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. + - '' + - A trial org provisioned through Apigee Provisioning Wizard - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. - applyReauthPolicy: - description: >- - Indicates if the user has opted in Google Reauth Policy. If opted - in, the refresh token will be valid for 20 hours, after which time - users must re-authenticate in order to obtain a new one. - type: boolean - authParams: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: The auth parameters sent along with the auth code request. - clientId: + Subscription based on concurrency model for Apigee and Application + Integration users. + - Consumption based users of IP + - >- + Argentum subscription for Application Integration users. To be + used in the future. + - >- + Special billing type to avoid any billing to clients (eg: trusted + tester program). This should not be used without consulting with + the leads. + provisionedRegions: + description: A list of provisioned regions on the current project + items: + type: string + type: array + type: object + GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: + type: object + properties: + content: + type: string + description: The content of downloaded execution. + description: Response for downloading an execution. + id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: + properties: + nextPageToken: type: string - description: The client's id. - authEndpoint: + description: The token used to retrieve the next page of results. + sfdcInstances: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + type: array + description: The list of SfdcInstances retrieved. + id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + description: Response to list SfdcInstances. + type: object + EnterpriseCrmEventbusProtoToken: + type: object + id: EnterpriseCrmEventbusProtoToken + properties: + name: type: string - description: The auth url endpoint to send the auth code request to. - accessToken: - description: The access token received from the token endpoint. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - scope: - description: A space-delimited list of requested scope permissions. + value: type: string - tokenEndpoint: + GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: + type: object + properties: + entity: type: string - description: The token url endpoint to send the token request to. - authCode: - description: The Auth Code that is used to initially retrieve the access token. + description: Name of the entity. + arrayFieldSchema: type: string - clientSecret: + description: The above schema, but for an array of the associated entity. + fieldSchema: + description: List of fields in the entity. type: string - description: The client's secret. - EnterpriseCrmFrontendsEventbusProtoTaskConfig: + description: Metadata of an entity, including a schema for its properties. + id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + GoogleCloudIntegrationsV1alphaCertificate: + description: The certificate definition type: object - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. - id: EnterpriseCrmFrontendsEventbusProtoTaskConfig + id: GoogleCloudIntegrationsV1alphaCertificate properties: - jsonValidationOption: + credentialId: + type: string + description: Immutable. Credential id that will be used to register with trawler + rawCertificate: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' description: >- - If set, overrides the option configured in the Task implementation - class. - enum: - - UNSPECIFIED_JSON_VALIDATION_OPTION - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION + Input only. Raw client certificate which would be registered with + trawler + validEndTime: + format: google-datetime + description: Output only. The timestamp after which certificate will expire type: string - enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in WorkflowParameters. - - >- - Validate all potential output JSON parameters against schemas - specified in WorkflowParameters. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. - createTime: + readOnly: true + validStartTime: + readOnly: true + description: Output only. The timestamp after which certificate will be valid format: google-datetime type: string - description: Auto-generated. description: - description: >- - User-provided description intended to give more business context - about the task. + description: Description of the certificate type: string - preconditionLabel: + requestorId: description: >- - Optional. User-provided label that is attached to precondition in - the UI. + Immutable. Requestor ID to be used to register certificate with + trawler type: string - taskName: + displayName: + description: Required. Name of the certificate type: string - description: The name for the task. - taskSpec: - description: >- - A string template that allows user to configure task parameters - (with either literal default values or tokens which will be resolved - at execution time) for the task. It will eventually replace the old - "parameters" field. + name: type: string - taskExecutionStrategy: + description: Output only. Auto generated primary key + readOnly: true + certificateStatus: type: string - enumDescriptions: - - >- - Wait until all of its previous tasks finished execution, then - verify at least one of the edge conditions is met, and execute if - possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - - >- - Start execution as long as any of its previous tasks finished - execution and the corresponding edge condition is met (since we - will execute if only that succeeding edge condition is met). - - >- - Wait until all of its previous tasks finished execution, then - verify the all edge conditions are met and execute if possible. - description: The policy dictating the execution strategy of this task. + description: Status of the certificate enum: - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - nextTasks: + - STATE_UNSPECIFIED + - ACTIVE + - EXPIRED + enumDescriptions: + - Unspecified certificate status + - Certificate in active state will be able to use + - Certificate in expired state needs to be updated + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + type: object + description: Range used to validate longs and ints. + properties: + min: + format: int64 + description: The inclusive minimum of the acceptable range. + type: string + max: + type: string + format: int64 + description: The inclusive maximum of the acceptable range. + EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: + id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats + properties: + endTime: + type: string + format: int64 + description: The end time of the task execution for current attempt. + startTime: + description: >- + The start time of the task execution for current attempt. This could + be in the future if it's been scheduled. + type: string + format: int64 + type: object + EnterpriseCrmEventbusProtoSuspensionAuthPermissions: + type: object + description: LINT.IfChange + properties: + googleGroup: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + mdbGroup: + type: string + loasRole: + type: string + gaiaIdentity: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + description: Represents a Gaia identity for a person or service account. + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions + GoogleCloudIntegrationsV1alphaListExecutionsResponse: + id: GoogleCloudIntegrationsV1alphaListExecutionsResponse + description: Response for listing the integration execution data. + type: object + properties: + executions: type: array + description: The detailed information of requested executions items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' - description: >- - The set of tasks that are next in line to be executed as per the - execution graph defined for the parent event, specified by - `event_config_id`. Each of these next tasks are executed only if the - condition associated with them evaluates to true. - disableStrictTypeValidation: - type: boolean - description: >- - If this config contains a TypedTask, allow validation to succeed if - an input is read from the output of another TypedTask whose output - type is declared as a superclass of the requested input type. For - instance, if the previous task declares an output of type Message, - any task with this flag enabled will pass validation when attempting - to read any proto Message type from the resultant Event parameter. - externalTaskType: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + nextPageToken: type: string - enumDescriptions: - - Default value. External task type is not specified - - Tasks belongs to the normal task flows - - Task belongs to the error catch task flows + description: The token used to retrieve the next page results. + executionInfos: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + description: Required. The detailed information of requested executions. + deprecated: true + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: + properties: + content: + type: string + description: The textproto of the integration_version. + fileFormat: + description: File format for upload request. enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK - failurePolicy: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + type: string + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + description: Request for UploadIntegrationVersion. + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + type: object + EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: + type: object + id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + properties: + protoValues: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array + GoogleCloudConnectorsV1HPAConfig: + id: GoogleCloudConnectorsV1HPAConfig + properties: + memoryUtilizationThreshold: + format: int64 description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - taskType: - description: Defines the type of the task - enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE + Output only. Percent Memory utilization where HPA triggers + autoscaling. type: string - enumDescriptions: - - Normal IP task - - Task is of As-Is Template type - - Task is of I/O template type with a different underlying task - lastModifiedTime: - format: google-datetime - description: Auto-generated. + readOnly: true + cpuUtilizationThreshold: + format: int64 + readOnly: true type: string - precondition: + description: Output only. Percent CPU utilization where HPA triggers autoscaling. + type: object + description: Autoscaling config for connector deployment system metrics. + GoogleCloudIntegrationsV1alphaErrorCatcherConfig: + type: object + id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig + properties: + position: + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + description: type: string description: >- - Optional. Standard filter expression evaluated before execution. - Independent of other conditions and tasks. Can be used to enable - rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to - task. - alertConfigs: + Optional. User-provided description intended to give more business + context about the error catcher config. + startErrorTasks: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' description: >- - Alert configurations on error rate, warning rate, number of runs, - durations, etc. + Required. The set of start tasks that are to be executed for the + error catch flow type: array - taskNumber: + label: description: >- - REQUIRED: the identifier of this task within its parent event - config, specified by the client. This should be unique among all the - tasks belong to the same event config. We use this field as the - identifier to find next tasks (via field `next_tasks.task_number`). - type: string - taskTemplateName: + Optional. The user created label for a particular error catcher. + Optional. type: string - description: Used to define task-template name if task is of type task-template - nextTasksExecutionPolicy: + errorCatcherNumber: description: >- - The policy dictating the execution of the next set of tasks for the - current task. + Required. A number to uniquely identify each error catcher config + within the workflow on UI. type: string - enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH errorCatcherId: type: string description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - rollbackStrategy: - description: >- - Optional. Contains information about what needs to be done upon - failure (either a permanent error or after it has been retried too - many times). - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy - creatorEmail: - description: The creator's email address. Auto-generated from the user's email. - type: string - label: - type: string - description: User-provided label that is attached to this TaskConfig in the UI. - successPolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' - description: Determines what action to take upon successful task completion. - parameters: - type: object - additionalProperties: + Required. An error catcher id is string representation for the error + catcher config. Within a workflow, error_catcher_id uniquely + identifies an error catcher config among all error catcher configs + for the workflow + description: Configuration detail of a error catch task + EnterpriseCrmEventbusProtoSuspensionConfig: + type: object + properties: + whoMayResolve: + description: Identities able to resolve this suspension. + items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: The customized parameters the user can pass to this task. - synchronousCallFailurePolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - taskEntity: - description: Copy of the task entity that this task config is an instance of. - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' - incomingEdgeCount: - format: int32 - description: The number of edges leading into this TaskConfig. - type: integer - conditionalFailurePolicies: + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions + type: array + customMessage: + type: string description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoConditionalFailurePolicies - position: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + Optional information to provide recipients of the suspension in + addition to the resolution URL, typically containing relevant + parameter values from the originating workflow. + suspensionExpiration: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' description: >- - Optional. Informs the front-end application where to draw this task - config on the UI. - EnterpriseCrmEventbusProtoIntArray: - properties: - values: + Indicates the next steps when no external actions happen on the + suspension. + notifications: items: - type: string - format: int64 + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' type: array - id: EnterpriseCrmEventbusProtoIntArray - type: object - GoogleCloudIntegrationsV1alphaDownloadTemplateResponse: - properties: - content: - description: String representation of the template. - type: string - description: Response for DownloadTemplate. + id: EnterpriseCrmEventbusProtoSuspensionConfig + GoogleCloudIntegrationsV1alphaExecution: + id: GoogleCloudIntegrationsV1alphaExecution type: object - id: GoogleCloudIntegrationsV1alphaDownloadTemplateResponse - GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest properties: - triggerId: - type: string - description: >- - Required. Matched against all {@link TriggerConfig}s across all - integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The - trigger_id is in the format of `api_trigger/TRIGGER_NAME`. - executionId: - description: Optional. The id of the ON_HOLD execution to be resumed. + updateTime: + description: Output only. Last modified time of the execution. + readOnly: true + format: google-datetime type: string - parameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - deprecated: true - description: >- - Optional. Passed in as parameters to each integration execution. - Redacted - inputParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - description: Optional. Input parameters used by integration execution. - requestId: + createTime: type: string - description: >- - Optional. This is used to de-dup incoming request: if the duplicate - request was detected, the response from the previous execution is - returned. - parameterEntries: + readOnly: true + format: google-datetime + description: Output only. Created time of the execution. + executionDetails: + description: Detailed info of this execution. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' + directSubExecutions: + description: Direct sub executions of the following Execution. items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: >- - Optional. Parameters are a part of Event and can be used to - communicate between different tasks that are part of the same - integration execution. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' type: array - deprecated: true - doNotPropagateError: - type: boolean + replayInfo: + readOnly: true + description: Output only. Replay info for the execution + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo + cloudLoggingDetails: + description: Cloud Logging details for the integration version + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + triggerId: + type: string description: >- - Optional. Flag to determine how to should propagate errors. If this - flag is set to be true, it will not throw an exception. Instead, it - will return a {@link ExecuteIntegrationsResponse} with an execution - id and error messages as PostWithTriggerIdExecutionException in - {@link EventParameters}. The flag is set to be false by default. - description: The request for executing an integration. - type: object - GoogleCloudIntegrationsV1alphaSuccessPolicy: - type: object - id: GoogleCloudIntegrationsV1alphaSuccessPolicy - description: >- - Policy that dictates the behavior for the task after it completes - successfully. - properties: - finalState: - enumDescriptions: - - UNSPECIFIED. - - >- - The default behavior, where successful tasks will be marked as - SUCCEEDED. - - >- - Sets the state to SUSPENDED after executing. This is required for - SuspensionTask; event execution will continue once the user calls - ResolveSuspensions with the event_execution_info_id and the task - number. + The trigger id of the integration trigger config. If both trigger_id + and client_id is present, the integration is executed from the start + tasks provided by the matching trigger config otherwise it is + executed from the default start tasks. + eventExecutionDetails: + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' + description: The execution info about this event. + integrationVersionState: + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. type: string + description: Output only. State of the integration version enum: - - FINAL_STATE_UNSPECIFIED - - SUCCEEDED - - SUSPENDED + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + readOnly: true + snapshotNumber: description: >- - State to which the execution snapshot status will be set if the task - succeeds. - GoogleCloudIntegrationsV1alphaTriggerConfig: - description: Configuration detail of a trigger. - properties: - description: + Output only. An increasing sequence that is set when a new snapshot + is created type: string - description: >- - Optional. User-provided description intended to give additional - business context about the task. - alertConfig: + format: int64 + readOnly: true + requestParams: + deprecated: true + description: Event parameters come in as part of the request. + type: array items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - description: >- - Optional. An alert threshold configuration for the [trigger + client - + integration] tuple. If these values are not specified in the - trigger config, default values will be populated by the system. Note - that there must be exactly one alert threshold configured per - [client + trigger + integration] when published. + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + responseParams: + deprecated: true + description: Event parameters come out as part of the response. + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry type: array - trigger: + name: + description: Auto-generated primary key. type: string - description: >- - Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub - Sub Trigger" When set will be sent out to monitoring dashabord for - tracking purpose. - triggerType: + requestParameters: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Event parameters come in as part of the request. + executionMethod: + description: The ways user posts this event. + enumDescriptions: + - Default value. + - Sync post. + - Async post. + - Async post with schedule time. type: string - description: Optional. Type of trigger enum: - - TRIGGER_TYPE_UNSPECIFIED - - CRON - - API - - SFDC_CHANNEL - - CLOUD_PUBSUB_EXTERNAL - - SFDC_CDC_CHANNEL - - CLOUD_SCHEDULER - - INTEGRATION_CONNECTOR_TRIGGER - - PRIVATE_TRIGGER - enumDescriptions: - - Unknown. - - Trigger by scheduled time. - - Trigger by API call. - - Trigger by Salesforce Channel. - - Trigger by Pub/Sub external. - - SFDC Channel Trigger for CDC. - - Trigger by Cloud Scheduler job. - - Trigger by Connector Event - - Trigger for private workflow - position: - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - startTasks: + - EXECUTION_METHOD_UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + responseParameters: + description: Event parameters returned as part of the response. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: >- + The Execution resource contains detailed information of an individual + integration execution. + GoogleCloudIntegrationsV1alphaFile: + description: >- + To store Integration version related file i.e. Integration Version, + Config variable etc. + id: GoogleCloudIntegrationsV1alphaFile + properties: + integrationConfig: + type: object + description: Integration version config file + additionalProperties: + description: Properties of the object. + type: any + integrationVersion: + description: Integration version + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + type: + type: string description: >- - Optional. Set of tasks numbers from where the integration execution - is started by this trigger. If this is empty, then integration is - executed with default start tasks. In the list of start tasks, none - of two tasks can have direct ancestor-descendant relationships (i.e. - in a same integration execution graph). - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - type: array - nextTasksExecutionPolicy: - description: Optional. Dictates how next tasks will be executed. + File information like Integration version, Integration Config + variables etc. enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - type: string + - Default value. + - Integration file. + - Integration Config variables. enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - triggerId: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES + type: object + GoogleCloudIntegrationsV1alphaCoordinate: + properties: + x: + format: int32 + type: integer + description: Required. X axis of the coordinate + 'y': + format: int32 + type: integer + description: Required. Y axis of the coordinate + type: object + description: Configuration detail of coordinate, it used for UI + id: GoogleCloudIntegrationsV1alphaCoordinate + EnterpriseCrmEventbusProtoCloudKmsConfig: + type: object + properties: + serviceAccount: description: >- - Optional. Auto-generated trigger ID. The ID is based on the - properties that you define in the trigger config. For example, for - an API trigger, the trigger ID follows the format: - api_trigger/TRIGGER_NAME Where trigger config has properties with - value {"Trigger name": TRIGGER_NAME} + Optional. The service account used for authentication of this KMS + key. If this is not provided, the service account in + Client.clientSource will be used. + type: string + gcpProjectId: type: string - triggerNumber: description: >- - Required. A number to uniquely identify each trigger config within - the integration on UI. + Optional. The id of GCP project where the KMS key is stored. If not + provided, assume the key is stored in the same GCP project defined + in Client (tag 14). + keyVersionName: type: string - label: + description: >- + Optional. Each version of a key contains key material used for + encryption or signing. A key's version is represented by an integer, + starting at 1. To decrypt data or verify a signature, you must use + the same key version that was used to encrypt or sign the data. + keyName: type: string - description: Optional. The user created label for a particular trigger. - properties: description: >- - Optional. Configurable properties of the trigger, not to be confused - with integration parameters. E.g. "name" is a property for API - triggers and "subscription" is a property for Pub/sub triggers. - type: object - additionalProperties: - type: string - errorCatcherId: + A Cloud KMS key is a named object containing one or more key + versions, along with metadata for the key. A key exists on exactly + one key ring tied to a specific location. + keyRingName: type: string description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task - cloudSchedulerConfig: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - description: Optional. Cloud Scheduler Trigger related metadata - id: GoogleCloudIntegrationsV1alphaTriggerConfig + A key ring organizes keys in a specific Google Cloud location and + allows you to manage access control on groups of keys. A key ring's + name does not need to be unique across a Google Cloud project, but + must be unique within a given location. + locationName: + description: Location name of the key ring, e.g. "us-west1". + type: string + id: EnterpriseCrmEventbusProtoCloudKmsConfig + GoogleCloudIntegrationsV1alphaExecutionDetails: + properties: + state: + description: Status of the execution. + enum: + - STATE_UNSPECIFIED + - PENDING + - PROCESSING + - SUCCEEDED + - FAILED + - CANCELLED + - RETRY_ON_HOLD + - SUSPENDED + type: string + enumDescriptions: + - Default. + - Execution is scheduled and awaiting to be triggered. + - Execution is processing. + - >- + Execution successfully finished. There's no more change after this + state. + - Execution failed. There's no more change after this state. + - >- + Execution canceled by user. There's no more change after this + state. + - Execution failed and waiting for retry. + - Execution suspended and waiting for manual intervention. + eventExecutionSnapshotsSize: + description: Total size of all event_execution_snapshots for an execution + format: int64 + type: string + attemptStats: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + description: List of Start and end time of the execution attempts. + executionSnapshots: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot + description: List of snapshots taken during the execution. + type: array + id: GoogleCloudIntegrationsV1alphaExecutionDetails + description: >- + Contains the details of the execution info: this includes the tasks + execution details plus the event execution statistics. type: object - GoogleCloudIntegrationsV1alphaUseTemplateResponse: - description: Response for use template + EnterpriseCrmEventbusProtoTransformExpression: + id: EnterpriseCrmEventbusProtoTransformExpression type: object properties: - subIntegrationVersions: - description: Sub integration versions which are created. + transformationFunctions: type: array + description: Transformations to be applied sequentially. items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: IntegrationVersion which is created. - id: GoogleCloudIntegrationsV1alphaUseTemplateResponse - EnterpriseCrmEventbusStats: - properties: - warningRate: - type: number - format: double - description: Average warning rate. - dimensions: - description: Dimensions that these stats have been aggregated on. - $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' - durationInSeconds: - description: Average duration in seconds. - type: number - format: double - qps: - format: double - description: Queries per second. - type: number - errorRate: - format: double - type: number - description: Average error rate. - id: EnterpriseCrmEventbusStats + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + initialValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' + description: Initial value upon which to perform transformations. + EnterpriseCrmEventbusProtoLogSettings: + id: EnterpriseCrmEventbusProtoLogSettings description: >- - Stats for the requested dimensions: QPS, duration, and error/warning - rate + The LogSettings define the logging attributes for an event property. + These attributes are used to map the property to the parameter in the + log proto. Also used to define scrubbing/truncation behavior and PII + information. type: object - EnterpriseCrmEventbusProtoParamSpecEntryConfig: properties: - inputDisplayOption: + seedPeriod: + enum: + - SEED_PERIOD_UNSPECIFIED + - DAY + - WEEK + - MONTH + type: string enumDescriptions: + - '' + - Sanitized values remain constant for the day of the event. - >- - A single-line input for strings, a numeric input box for numbers, - or a checkbox for booleans. - - A multi-line input box for longer strings/string templates. - - >- - A slider to select a numerical value. The default range is [0, - 100]. - - A toggle button for boolean parameters. + Sanitized values remain constant for the week of the event; may + cross month boundaries. + - Sanitized values remain constant for the month of the event. + seedScope: + enumDescriptions: + - '' + - Hash computations include the event name. + - Hash computations include a time period. + - Hash computations include the param name. type: string enum: - - DEFAULT - - STRING_MULTI_LINE - - NUMBER_SLIDER - - BOOLEAN_TOGGLE - subSectionLabel: + - SEED_SCOPE_UNSPECIFIED + - EVENT_NAME + - TIME_PERIOD + - PARAM_NAME + logFieldName: type: string description: >- - A user-friendly label for subSection under which the parameter will - be displayed. - parameterNameOption: + The name of corresponding logging field of the event property. If + omitted, assumes the same name as the event property key. + GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: + type: object + properties: + cloudKmsConfig: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + description: >- + Required. REQUIRED: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + description: Request for the SwitchEncryption rpc + id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + EnterpriseCrmEventbusProtoStringFunction: + properties: + functionName: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - CONCAT + - TO_UPPERCASE + - TO_LOWERCASE + - CONTAINS + - SPLIT + - LENGTH + - EQUALS + - TO_INT + - TO_DOUBLE + - TO_BOOLEAN + - TO_BASE_64 + - TO_JSON + - EQUALS_IGNORE_CASE + - REPLACE_ALL + - SUBSTRING + - RESOLVE_TEMPLATE + - DECODE_BASE64_STRING + type: object + id: EnterpriseCrmEventbusProtoStringFunction + GoogleCloudIntegrationsV1alphaIntegrationParameter: + properties: + description: type: string + description: Optional. Description of the parameter. + inputOutputType: + type: string + description: Specifies the input/output type for the parameter. enum: - - DEFAULT_NOT_PARAMETER_NAME - - IS_PARAMETER_NAME - - KEY_IS_PARAMETER_NAME - - VALUE_IS_PARAMETER_NAME + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT enumDescriptions: - - This field is not a parameter name. + - Default. - >- - If this field is a string and this option is selected, the field - will be interpreted as a parameter name. Users will be able to - choose a variable using the autocomplete, but the name will be - stored as a literal string. + Input parameters for the integration. EventBus validates that + these parameters exist in the integrations before execution. - >- - If this field is a ParameterMap and this option is selected, the - map's keys will be interpreted as parameter names. Ignored if this - field is not a ParameterMap. + Output Parameters for the integration. EventBus will only return + the integration parameters tagged with OUT in the response back. - >- - If this field is a ParameterMap and this option is selected, the - map's values will be interpreted as parameter names. Ignored if - this field is not a ParameterMap. - hideDefaultValue: - description: Whether the default value is hidden in the UI. + Input and Output Parameters. These can be used as both input and + output. EventBus will validate for the existence of these + parameters before execution and will also return this parameter + back in the response. + isTransient: type: boolean - descriptivePhrase: - type: string - description: A short phrase to describe what this parameter contains. - uiPlaceholderText: + description: Whether this parameter is a transient parameter. + producer: type: string description: >- - Placeholder text which will appear in the UI input form for this - parameter. - isHidden: - description: Whether this field is hidden in the UI. - type: boolean - label: - type: string - description: A user-friendly label for the parameter. - helpText: + The identifier of the node (TaskConfig/TriggerConfig) this parameter + was produced by, if it is a transient param or a copy of an input + param. + dataType: type: string - description: >- - Detailed help text for this parameter containing information not - provided elsewhere. For example, instructions on how to migrate from - a deprecated parameter. - type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryConfig - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: - description: Response for CreateAppsScriptProject rpc call. - properties: - projectId: + enum: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + description: Type of the parameter. + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + jsonSchema: type: string - description: The created AppsScriptProject ID. - type: object - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse - EnterpriseCrmEventbusProtoConditionResult: - description: Contains the combined condition calculation results. - properties: - result: description: >- - the result comes out after evaluate the combined condition. True if - there's no combined condition specified. + This schema will be used to validate runtime JSON-typed values of + this parameter. + searchable: type: boolean - currentTaskNumber: - description: the current task number. - type: string - nextTaskNumber: + description: Searchable in the execution log or not. + containsLargeData: + description: >- + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + type: boolean + masked: + type: boolean + description: True if this parameter should be masked in the logs + defaultValue: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: >- + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + key: type: string - description: the next task number. - id: EnterpriseCrmEventbusProtoConditionResult - type: object - GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: - description: Response of lift Suspense - id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse - properties: - eventExecutionInfoId: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. + displayName: type: string - description: Execution Id that will be returned - type: object - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + description: >- + The name (without prefix) to be displayed in the UI for this + parameter. E.g. if the key is "foo.bar.myName", then the name would + be "myName". + id: GoogleCloudIntegrationsV1alphaIntegrationParameter type: object - description: Request for CreateAppsScriptProject rpc call. + description: >- + Integration Parameter is defined in the integration config and are used + to provide information about data types of the expected parameters and + provide any default values if needed. They can also be used to add + custom attributes. These are static in nature and should not be used for + dynamic event definition. + GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: properties: - authConfigId: + priority: + enum: + - UNSPCIFIED + - SHEDDABLE + - SHEDDABLE_PLUS + - CRITICAL + - CRITICAL_PLUS + enumDescriptions: + - Unspecified + - >- + Frequent partial and occasional full unavailability is expected + and not pageable. * Requests to this band will be shed before all + other requests. * This is the default for async calls sent from + batch jobs. + - >- + Partial unavailability is expected and is not necessarily + pageable. * Requests to this band will be shed before any critical + traffic. * This is the default for async calls sent from + production jobs. + - >- + Any outage is a pageable event. * During a production outage + requests in this band will only be shed before CRITICAL_PLUS. * + This is the default for sync calls sent from production jobs. + - >- + Any outage is a pageable event. * The guideline is for < 10% of + requests to a service to be in this band. * During a production + outage requests in this band will be prioritized above all others. + * Opt-in to CRITICAL_PLUS when your workflow triggers by human. description: >- - The auth config id necessary to fetch the necessary credentials to - create the project for external clients - type: string - appsScriptProject: - description: The name of the Apps Script project to be created. + The request priority this request should be processed at. For + internal users: type: string - EnterpriseCrmEventbusProtoCloudKmsConfig: - properties: - gcpProjectId: + workflowName: description: >- - Optional. The id of GCP project where the KMS key is stored. If not - provided, assume the key is stored in the same GCP project defined - in Client (tag 14). + Optional. If provided, the workflow_name is used to filter all the + matched workflows having same trigger_id+client_id. A combination of + trigger_id, client_id and workflow_name identifies a unique + workflow. type: string - keyName: + triggerId: description: >- - A Cloud KMS key is a named object containing one or more key - versions, along with metadata for the key. A key exists on exactly - one key ring tied to a specific location. - type: string - keyRingName: + Matched against all {@link TriggerConfig}s across all workflows. + i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. type: string + testMode: description: >- - A key ring organizes keys in a specific Google Cloud location and - allows you to manage access control on groups of keys. A key ring's - name does not need to be unique across a Google Cloud project, but - must be unique within a given location. - keyVersionName: + Optional. Sets test mode in {@link + enterprise/crm/eventbus/event_message.proto}. + type: boolean + parameters: + description: Passed in as parameters to each workflow execution. Optional. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + requestId: description: >- - Optional. Each version of a key contains key material used for - encryption or signing. A key's version is represented by an integer, - starting at 1. To decrypt data or verify a signature, you must use - the same key version that was used to encrypt or sign the data. + Optional. This is used to de-dup incoming request: if the duplicate + request was detected, the response from the previous execution is + returned. Must have no more than 36 characters and contain only + alphanumeric characters and hyphens. type: string - locationName: + resourceName: type: string - description: Location name of the key ring, e.g. "us-west1". - serviceAccount: description: >- - Optional. The service account used for authentication of this KMS - key. If this is not provided, the service account in - Client.clientSource will be used. - type: string - id: EnterpriseCrmEventbusProtoCloudKmsConfig - type: object - GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: - type: object - id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials - properties: - clientSecret: - description: The client's secret. - type: string - scope: - type: string - description: A space-delimited list of requested scope permissions. - password: - description: The user's password. - type: string - username: - description: The user's username. - type: string - accessToken: - description: Access token fetched from the authorization server. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - clientId: - type: string - description: The client's ID. - tokenEndpoint: - type: string + This field is only required when using Admin Access. The resource + name of target, or the parent resource name. For example: + "projects/*/locations/*/integrations/*" + quotaRetryCount: + format: int32 + type: integer description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. - tokenParams: - description: Token parameters for the auth request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - requestType: - type: string - enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER - description: Represent how to pass parameters to fetch access token - description: >- - For resource owner credentials grant, the client will ask the user for - their authorization credentials (ususally a username and password) and - send a POST request to the authorization server. The authorization - server will respond with a JSON object containing the access token. - EnterpriseCrmEventbusProtoNextTeardownTask: - id: EnterpriseCrmEventbusProtoNextTeardownTask - description: >- - The teardown task that is next in line to be executed. We support only - sequential execution of teardown tasks (i.e. no branching). - properties: - name: - type: string - description: Required. Name of the next teardown task. - type: object - GoogleCloudConnectorsV1AuthConfigUserPassword: - id: GoogleCloudConnectorsV1AuthConfigUserPassword - description: Parameters to support Username and Password Authentication. - properties: - password: - description: Secret version reference containing the password. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - username: - description: Username. - type: string - type: object - GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: - properties: - properties: - description: 'Required. Required: The client configuration that was requested' - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' - type: object - id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse - description: Response for the GetClientMetadata rpc - GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: - properties: - content: - description: The content of downloaded execution. - type: string - description: Response for downloading an execution. - type: object - id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse - EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: - properties: - timestamp: - type: string - format: google-datetime - resolvedByCpi: + Optional. This is a field to see the quota retry count for + integration execution + ignoreErrorIfNoActiveWorkflow: + type: boolean + description: >- + Optional. Flag to determine whether clients would suppress a warning + when no ACTIVE workflows are not found. If this flag is set to be + true, an error will not be thrown if the requested trigger_id or + client_id is not found in any ACTIVE workflow. Otherwise, the error + is always thrown. The flag is set to be false by default. + userGeneratedExecutionId: type: string - resolvedBy: + description: >- + This is a unique id provided by the method caller. If provided this + will be used as the execution_id when a new execution info is + created. This is a string representation of a UUID. Must have no + more than 36 characters and contain only alphanumeric characters and + hyphens. + scheduledTime: + description: >- + Optional. Time in milliseconds since epoch when the given event + would be scheduled. + format: int64 type: string - type: object - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - GoogleCloudIntegrationsV1alphaAttemptStats: - description: Status for the execution attempt. - properties: - endTime: + clientId: type: string - description: The end time of the integration execution for current attempt. - format: google-datetime - startTime: - format: google-datetime description: >- - The start time of the integration execution for current attempt. - This could be in the future if it's been scheduled. - type: string - id: GoogleCloudIntegrationsV1alphaAttemptStats + Optional. If the client id is provided, then the combination of + trigger id and client id is matched across all the workflows. If the + client id is not provided, then workflows with matching trigger id + are executed for each client id in the {@link TriggerConfig}. For + Api Trigger, the client id is required and will be validated against + the allowed clients. + id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest type: object - GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: + description: >- + LINT.IfChange Use this request to post all workflows associated with a + given trigger id. Next available id: 13 + EnterpriseCrmEventbusProtoNodeIdentifier: type: object + id: EnterpriseCrmEventbusProtoNodeIdentifier properties: - customMessage: - description: Information to provide for recipients. + elementIdentifier: + description: Configuration of the edge. type: string - emailAddresses: - description: Email addresses to send approval request to. - type: array - items: - type: string - expiration: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration - description: >- - Indicates the next steps when no external actions happen on the - suspension. - description: Configurations for approving the Suspension. - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig - EnterpriseCrmEventbusProtoParameterEntry: - properties: - key: + elementType: + enum: + - UNKNOWN_TYPE + - TASK_CONFIG + - TRIGGER_CONFIG + description: Destination node where the edge ends. It can only be a task config. + enumDescriptions: + - '' + - '' + - '' type: string - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - masked: - type: boolean - description: True if this parameter should be masked in the logs - value: - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: Key-value pair of EventBus parameters. - id: EnterpriseCrmEventbusProtoParameterEntry + description: 'Represents a node identifier (type + id). Next highest id: 3' + EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + description: >- + LINT.IfChange This is the frontend version of WorkflowParameters. It's + exactly like the backend version except that instead of flattening + protobuf parameters and treating every field and subfield of a protobuf + parameter as a separate parameter, the fields/subfields of a protobuf + parameter will be nested as "children" (see 'children' field below) + parameters of the parent parameter. Please refer to + enterprise/crm/eventbus/proto/workflow_parameters.proto for more + information about WorkflowParameters. type: object - EnterpriseCrmEventbusProtoTeardown: properties: - teardownTaskConfigs: - type: array + parameters: + description: >- + Parameters are a part of Event and can be used to communiticate + between different tasks that are part of the same workflow + execution. items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' - description: Required. - type: object - id: EnterpriseCrmEventbusProtoTeardown - EnterpriseCrmEventbusProtoCombinedCondition: - deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + type: array + GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: + description: Metadata of the execution snapshot. + id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata type: object - id: EnterpriseCrmEventbusProtoCombinedCondition - description: >- - This message recursively combines constituent conditions using logical - AND. properties: - conditions: - description: A set of individual constituent conditions. + ancestorTaskNumbers: + description: >- + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' + type: string type: array - GoogleCloudIntegrationsV1alphaTemplateComponent: - type: object - properties: - name: + task: + description: the task name associated with this snapshot. type: string - description: Optional. Name of the component. - type: + taskAttempt: + format: int32 + type: integer + description: the task attempt number this snapshot belongs to. + taskLabel: + description: the task label associated with this snapshot. Could be empty. type: string - enumDescriptions: - - Component type is unspecified - - Trigger component - - Task component - - Connector component - description: Optional. Type of the component. - enum: - - TYPE_UNSPECIFIED - - TRIGGER - - TASK - - CONNECTOR - id: GoogleCloudIntegrationsV1alphaTemplateComponent - description: Define the components that are present in a template. - GoogleCloudIntegrationsV1alphaListConnectionsResponse: - type: object - description: Response containing Connections listed by region. - properties: - connections: - description: Connections. + taskNumber: + type: string + description: The task number associated with this snapshot. + ancestorIterationNumbers: type: array items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' - nextPageToken: - description: Next page token. - type: string - id: GoogleCloudIntegrationsV1alphaListConnectionsResponse - EnterpriseCrmEventbusProtoTeardownTaskConfig: - id: EnterpriseCrmEventbusProtoTeardownTaskConfig - type: object - properties: - teardownTaskImplementationClassName: - type: string - description: Required. Implementation class name. - properties: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' - creatorEmail: - type: string - description: The creator's email address. - name: - type: string + type: string description: >- - Required. Unique identifier of the teardown task within this Config. - We use this field as the identifier to find next teardown tasks. - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters the user can pass to this task. - nextTeardownTask: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' - GoogleCloudIntegrationsV1alphaTemplateBundle: - description: Define the bundle of the template. - id: GoogleCloudIntegrationsV1alphaTemplateBundle - properties: - subIntegrationVersionTemplates: - type: array + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') + integrationName: description: >- - Optional. Sub integration templates which would be added along with - main integration. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate - integrationVersionTemplate: - description: Required. Main integration templates of the template bundle. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate - type: object - EnterpriseCrmEventbusProtoParameterValueType: - id: EnterpriseCrmEventbusProtoParameterValueType + The direct integration which the event execution snapshots belongs + to + type: string + executionAttempt: + description: the execution attempt number this snapshot belongs to. + format: int32 + type: integer + GoogleCloudIntegrationsV1alphaBooleanParameterArray: type: object - description: >- - LINT.IfChange To support various types of parameter values. Next - available id: 14 properties: - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' - intValue: - format: int64 - type: string - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' - protoArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' - stringValue: - type: string - protoValue: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - booleanArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' - serializedObjectValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter - doubleValue: - format: double - type: number - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' - booleanValue: - type: boolean - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: + booleanValues: + description: Boolean array. + items: + type: boolean + type: array + id: GoogleCloudIntegrationsV1alphaBooleanParameterArray + description: This message only contains a field of boolean array. + GoogleCloudIntegrationsV1alphaSerializedFile: + id: GoogleCloudIntegrationsV1alphaSerializedFile properties: - jwtClaims: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims - description: JwtClaims providers fields to generate the token. - clientKey: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + file: + type: string description: >- - Secret version reference containing a PKCS#8 PEM-encoded private key - associated with the Client Certificate. This private key will be - used to sign JWTs used for the jwt-bearer authorization grant. - Specified in the form as: `projects/*/secrets/*/versions/*`. - description: >- - Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 - Authorization Grant based authentication. See - https://tools.ietf.org/html/rfc7523 for more details. + File information like Integration version, Integration Config + variables etc. + enumDescriptions: + - Default value. + - Integration file. + - Integration Config variables. + enum: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES + content: + type: string + description: String representation of the file content. + description: To store string representation of Integration file. type: object - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - EnterpriseCrmEventbusProtoMappedField: + GoogleCloudIntegrationsV1alphaSuspensionAudit: + description: Contains when and by whom the suspension was resolved. type: object - id: EnterpriseCrmEventbusProtoMappedField properties: - outputField: - description: The output field being mapped to. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - inputField: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - description: The input field being mapped from. - description: Mapped field is a pair of input field and output field. - GoogleCloudConnectorsV1SslConfig: + resolveTime: + type: string + format: google-datetime + description: Time at which this suspension was resolved. + resolver: + type: string + description: Email address of the person who resolved this suspension. + id: GoogleCloudIntegrationsV1alphaSuspensionAudit + EnterpriseCrmEventbusProtoCondition: + id: EnterpriseCrmEventbusProtoCondition + description: Condition that uses `operator` to evaluate the key against the value. type: object - id: GoogleCloudConnectorsV1SslConfig properties: - clientPrivateKey: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Client Private Key - clientPrivateKeyPass: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret containing the passphrase protecting the Client Private Key - useSsl: - description: Bool for enabling SSL - type: boolean - additionalVariables: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - type: array - description: Additional SSL related field values - privateServerCertificate: + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + description: Value that's checked for the key. + eventPropertyKey: description: >- - Private Server Certificate. Needs to be specified if trust model is - `PRIVATE`. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - serverCertType: - type: string - enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type - description: Type of Server Cert (PEM/JKS/.. etc.) - enum: - - CERT_TYPE_UNSPECIFIED - - PEM - type: - description: Controls the ssl type for the given connector version. - enum: - - SSL_TYPE_UNSPECIFIED - - TLS - - MTLS + Key that's evaluated against the `value`. Please note the data type + of the runtime value associated with the key should match the data + type of `value`, else an IllegalArgumentException is thrown. type: string + operator: enumDescriptions: - - No SSL configuration required. - - TLS Handshake - - mutual TLS (MTLS) Handshake - trustModel: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string enum: - - PUBLIC - - PRIVATE - - INSECURE - enumDescriptions: - - Public Trust Model. Takes the Default Java trust store. - - Private Trust Model. Takes custom/private trust store. - - Insecure Trust Model. Accept all certificates. - description: Trust Model of the SSL connection - clientCertificate: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Client Certificate - clientCertType: - enum: - - CERT_TYPE_UNSPECIFIED - - PEM - enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type - type: string - description: Type of Client Cert (PEM/JKS/.. etc.) - description: SSL Configuration of a connection - GoogleProtobufEmpty: - properties: {} - 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); } - type: object - id: GoogleProtobufEmpty - GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: - description: Response containing all provisioned regions for Connector Platform. - id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse + - UNSET + - EQUALS + - CONTAINS + - LESS_THAN + - GREATER_THAN + - EXISTS + - DOES_NOT_EXIST + - IS_EMPTY + - IS_NOT_EMPTY + description: >- + Operator used to evaluate the condition. Please note that an + operator with an inappropriate key/value operand will result in + IllegalArgumentException, e.g. CONTAINS with boolean key/value pair. + deprecated: true + GoogleCloudIntegrationsV1alphaListCertificatesResponse: type: object properties: - regions: - items: - type: string - type: array - description: All regions where Connector Platform is provisioned. - EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: - description: List of error enums for alerts. - properties: - enumStrings: + certificates: type: array items: - type: string - filterType: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + description: The list of Certificates retrieved. + nextPageToken: + type: string + description: The token used to retrieve the next page of results. + id: GoogleCloudIntegrationsV1alphaListCertificatesResponse + description: Response to list Certificates. + EnterpriseCrmEventbusProtoParamSpecEntryConfig: + id: EnterpriseCrmEventbusProtoParamSpecEntryConfig + properties: + helpText: + description: >- + Detailed help text for this parameter containing information not + provided elsewhere. For example, instructions on how to migrate from + a deprecated parameter. + type: string + isHidden: + type: boolean + description: Whether this field is hidden in the UI. + label: + type: string + description: A user-friendly label for the parameter. + uiPlaceholderText: + description: >- + Placeholder text which will appear in the UI input form for this + parameter. + type: string + subSectionLabel: + type: string + description: >- + A user-friendly label for subSection under which the parameter will + be displayed. + parameterNameOption: type: string + enumDescriptions: + - This field is not a parameter name. + - >- + If this field is a string and this option is selected, the field + will be interpreted as a parameter name. Users will be able to + choose a variable using the autocomplete, but the name will be + stored as a literal string. + - >- + If this field is a ParameterMap and this option is selected, the + map's keys will be interpreted as parameter names. Ignored if this + field is not a ParameterMap. + - >- + If this field is a ParameterMap and this option is selected, the + map's values will be interpreted as parameter names. Ignored if + this field is not a ParameterMap. enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE + - DEFAULT_NOT_PARAMETER_NAME + - IS_PARAMETER_NAME + - KEY_IS_PARAMETER_NAME + - VALUE_IS_PARAMETER_NAME + inputDisplayOption: + enum: + - DEFAULT + - STRING_MULTI_LINE + - NUMBER_SLIDER + - BOOLEAN_TOGGLE + type: string enumDescriptions: - - '' - - '' - id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + - >- + A single-line input for strings, a numeric input box for numbers, + or a checkbox for booleans. + - A multi-line input box for longer strings/string templates. + - >- + A slider to select a numerical value. The default range is [0, + 100]. + - A toggle button for boolean parameters. + descriptivePhrase: + description: A short phrase to describe what this parameter contains. + type: string + hideDefaultValue: + description: Whether the default value is hidden in the UI. + type: boolean type: object - GoogleCloudIntegrationsV1alphaEventParameter: - description: >- - This message is used for processing and persisting (when applicable) key - value pair parameters for each event in the event bus. Next available - id: 4 - id: GoogleCloudIntegrationsV1alphaEventParameter + EnterpriseCrmEventbusProtoParameterEntry: + description: Key-value pair of EventBus parameters. properties: + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. key: + type: string description: >- Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. - type: string masked: type: boolean description: True if this parameter should be masked in the logs - value: - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' type: object - GoogleCloudIntegrationsV1alphaListTemplatesResponse: - id: GoogleCloudIntegrationsV1alphaListTemplatesResponse + id: EnterpriseCrmEventbusProtoParameterEntry + GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: + description: Expiration configs for the approval request. type: object - description: Response for a request to list templates + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration properties: - templates: - description: List of templates retrieved. - type: array + remindTime: + description: >- + Time after the previous suspension action reminder, if any, is sent + using the selected notification option, for a suspension which is + still PENDING_UNSPECIFIED. + format: google-datetime + type: string + liftWhenExpired: + type: boolean + description: >- + Whether the suspension will be REJECTED or LIFTED upon expiration. + REJECTED is the default behavior. + expireTime: + format: google-datetime + readOnly: true + type: string + description: >- + Output only. Time after which the suspension expires, if no action + taken. + GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: + properties: + integrationVersions: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: The integrations which match the request. + type: array + noPermission: + description: Whether the user has no permission on the version or not. + type: boolean nextPageToken: - description: The token used to retrieve the next page results. type: string - EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: + 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. + description: Response for ListIntegrationVersions. + id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + type: object + EnterpriseCrmEventbusProtoCoordinate: + description: Represents two-dimensional positions. + id: EnterpriseCrmEventbusProtoCoordinate type: object properties: - booleanValues: - items: - type: boolean - type: array - id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray - EnterpriseCrmEventbusProtoTriggerCriteria: + 'y': + type: integer + format: int32 + x: + type: integer + format: int32 + GoogleCloudConnectorsV1EncryptionKey: properties: - condition: + kmsKeyName: type: string description: >- - Required. Standard filter expression, when true the workflow will be - executed. If there's no - trigger_criteria_task_implementation_class_name specified, the - condition will be validated directly. - triggerCriteriaTaskImplementationClassName: + The [KMS key name] with which the content of the Operation is + encrypted. The expected format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty + string if google managed. + type: type: string - description: >- - Optional. Implementation class name. The class should implement the - “TypedTask” interface. - parameters: - description: Optional. To be used in TaskConfig for the implementation class. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + enumDescriptions: + - Value type is not specified. + - Google Managed. + - Customer Managed. + description: Type. + enum: + - TYPE_UNSPECIFIED + - GOOGLE_MANAGED + - CUSTOMER_MANAGED + description: Encryption Key value. + id: GoogleCloudConnectorsV1EncryptionKey type: object - id: EnterpriseCrmEventbusProtoTriggerCriteria - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: + EnterpriseCrmEventbusProtoCombinedCondition: + description: >- + This message recursively combines constituent conditions using logical + AND. + deprecated: true properties: - scriptId: - type: string - description: The id of the Apps Script project to be linked. - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + conditions: + description: A set of individual constituent conditions. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' + id: EnterpriseCrmEventbusProtoCombinedCondition type: object - description: Request for LinkAppsScriptProject rpc call. - EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: + EnterpriseCrmEventbusProtoTaskUiModuleConfig: type: object - id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + id: EnterpriseCrmEventbusProtoTaskUiModuleConfig + description: Task author would use this type to configure a config module. properties: - key: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - value: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - description: Entry is a pair of key and value. - GoogleCloudIntegrationsV1alphaFile: - description: >- - To store Integration version related file i.e. Integration Version, - Config variable etc. - id: GoogleCloudIntegrationsV1alphaFile + moduleId: + type: string + enum: + - UNSPECIFIED_TASK_MODULE + - LABEL + - ERROR_HANDLING + - TASK_PARAM_TABLE + - TASK_PARAM_FORM + - PRECONDITION + - SCRIPT_EDITOR + - RPC + - TASK_SUMMARY + - SUSPENSION + - RPC_TYPED + - SUB_WORKFLOW + - APPS_SCRIPT_NAVIGATOR + - SUB_WORKFLOW_FOR_EACH_LOOP + - FIELD_MAPPING + - README + - REST_CALLER + - SUB_WORKFLOW_SCATTER_GATHER + - CLOUD_SQL + - GENERIC_CONNECTOR_TASK + description: ID of the config module. + enumDescriptions: + - Default + - Supports editing label of a task config. + - Supports editing error handling settings such as retry strategy. + - >- + Supports adding, removing and editing task parameter values in a + table with little assistance or restriction. + - >- + Supports editing values of declared input parameters of a task. + Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE. + - Supports editing preconditions of a task config. + - >- + Supports adding, editing, and deleting the scripts associated with + a script task, as well as modifying the input/output parameters. + - >- + Supports editing task parameters associated with an RPC/stubby + task. + - >- + Contains readonly task information, including input/output type + info. + - Configures a SuspensionTask. + - Configures a GenericStubbyTypedTask. + - Configures a SubWorkflowExecutorTask. + - Supports navigating to Apps Script editor + - Configures a SubWorkflowForEachLoopTask. + - Configures a FieldMappingTask. + - Contains embedded in-product documentation for a task. + - UI widget for the rest caller task. + - Configures a SubWorkflowScatterGatherTask. + - Configures a CloudSql Task. + - Configure a GenericConnectorTask. + GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: + description: Response to list SfdcChannels. + id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + properties: + sfdcChannels: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + description: The list of SfdcChannels retrieved. + type: array + nextPageToken: + type: string + description: The token used to retrieve the next page of results. type: object + GoogleCloudConnectorsV1LogConfig: properties: - integrationConfig: - additionalProperties: - type: any - description: Properties of the object. - type: object - description: Integration version config file - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Integration version - type: - description: >- - File information like Integration version, Integration Config - variables etc. + level: + enumDescriptions: + - Log level unspecified. + - Only error logs are enabled. + - Info and error logs are enabled. + - Debug and high verbosity logs are enabled. enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES + - LOG_LEVEL_UNSPECIFIED + - ERROR + - INFO + - DEBUG type: string - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. - GoogleCloudConnectorsV1Connection: + description: Optional. Log configuration level. + enabled: + type: boolean + description: >- + Enabled represents whether logging is enabled or not for a + connection. + id: GoogleCloudConnectorsV1LogConfig + description: Log configuration for the connection. type: object + GoogleCloudIntegrationsV1alphaTemplateComponent: properties: - envoyImageLocation: - description: >- - Output only. GCR location where the envoy image is stored. formatted - like: gcr.io/{bucketName}/{imageName} - readOnly: true + type: + enumDescriptions: + - Component type is unspecified + - Trigger component + - Task component + - Connector component + enum: + - TYPE_UNSPECIFIED + - TRIGGER + - TASK + - CONNECTOR + description: Optional. Type of the component. type: string - authConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - description: >- - Optional. Configuration for establishing the connection's - authentication with an external system. - description: + name: type: string - description: Optional. Description of the resource. - nodeConfig: - description: Optional. Node configuration for the connection. - $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' - configVariables: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + description: Optional. Name of the component. + id: GoogleCloudIntegrationsV1alphaTemplateComponent + description: Define the components that are present in a template. + type: object + EnterpriseCrmEventbusProtoFunction: + id: EnterpriseCrmEventbusProtoFunction + properties: + parameters: type: array - description: >- - Optional. Configuration for configuring the connection with an - external system. - subscriptionType: - description: >- - Output only. This subscription type enum states the subscription - type of the project. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' + description: List of parameters required for the transformation. + functionType: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' + description: The name of the function to perform. + type: object + GoogleCloudConnectorsV1EventingStatus: + type: object + properties: + state: enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAY_G - - PAID - type: string - readOnly: true + - STATE_UNSPECIFIED + - ACTIVE + - ERROR + - INGRESS_ENDPOINT_REQUIRED + description: Output only. State. enumDescriptions: - - Unspecified subscription type. - - PayG subscription. - - Paid Subscription. - imageLocation: + - Default state. + - Eventing is enabled and ready to receive events. + - Eventing is not active due to an error. + - Ingress endpoint required. readOnly: true - description: >- - Output only. GCR location where the runtime image is stored. - formatted like: gcr.io/{bucketName}/{imageName} type: string - connectorVersionInfraConfig: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig - description: Output only. Infra configs supported by Connector Version. - readOnly: true - suspended: - description: >- - Optional. Suspended indicates if a user has suspended a connection - or not. - type: boolean - updateTime: - description: Output only. Updated time. + description: type: string readOnly: true - format: google-datetime - logConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' - description: Optional. Log configuration for the connection. - eventingRuntimeData: - readOnly: true - description: Output only. Eventing Runtime Data. - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' - connectionRevision: - readOnly: true + description: Output only. Description of error if State is set to "ERROR". + description: EventingStatus indicates the state of eventing. + id: GoogleCloudConnectorsV1EventingStatus + EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: + type: object + properties: + startTime: format: int64 + type: string description: >- - Output only. Connection revision. This field is only updated when - the connection is created or updated by User. + The start time of the event execution for current attempt. This + could be in the future if it's been scheduled. + endTime: + description: The end time of the event execution for current attempt. type: string - tlsServiceDirectory: + format: int64 + id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + EnterpriseCrmEventbusProtoTaskUiConfig: + id: EnterpriseCrmEventbusProtoTaskUiConfig + description: >- + Task authors would use this type to configure the UI for a particular + task by specifying what UI config modules should be included to compose + the UI. Learn more about config module framework: + properties: + taskUiModuleConfigs: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' + description: Configurations of included config modules. + type: object + GoogleCloudIntegrationsV1alphaNextTask: + id: GoogleCloudIntegrationsV1alphaNextTask + properties: + displayName: + description: User-provided label that is attached to this edge in the UI. type: string - description: Output only. The name of the Service Directory service with TLS. - readOnly: true - labels: - additionalProperties: - type: string - type: object - description: >- - Optional. Resource labels to represent user-provided metadata. Refer - to cloud documentation on labels for more details. - https://cloud.google.com/compute/docs/labeling-resources - createTime: - description: Output only. Created time. - readOnly: true + taskId: type: string - format: google-datetime - eventingEnablementType: - enumDescriptions: - - Eventing Enablement Type Unspecifeied. - - Both connection and eventing. - - Only Eventing. - description: >- - Optional. Eventing enablement type. Will be nil if eventing is not - enabled. - enum: - - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED - - EVENTING_AND_CONNECTION - - ONLY_EVENTING + description: Task number of the next task. + taskConfigId: + type: string + description: ID of the next task. + description: type: string - lockConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' description: >- - Optional. Configuration that indicates whether or not the Connection - can be edited. - host: + User-provided description intended to give additional business + context about the task. + condition: type: string - readOnly: true description: >- - Output only. The name of the Hostname of the Service Directory - service with TLS. - destinationConfigs: + Standard filter expression for this task to become an eligible next + task. + type: object + description: >- + The task that is next in line to be executed, if the condition specified + evaluated to true. + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: + description: >- + Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 + Authorization Grant based authentication. See + https://tools.ietf.org/html/rfc7523 for more details. + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer + type: object + properties: + jwtClaims: + description: JwtClaims providers fields to generate the token. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + clientKey: description: >- - Optional. Configuration of the Connector's destination. Only - accepted for Connectors that accepts user defined destination(s). - type: array + Secret version reference containing a PKCS#8 PEM-encoded private key + associated with the Client Certificate. This private key will be + used to sign JWTs used for the jwt-bearer authorization grant. + Specified in the form as: `projects/*/secrets/*/versions/*`. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + GoogleCloudIntegrationsV1alphaListConnectionsResponse: + properties: + nextPageToken: + description: Next page token. + type: string + connections: + description: Connections. items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - connectorVersionLaunchStage: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' + type: array + description: Response containing Connections listed by region. + type: object + id: GoogleCloudIntegrationsV1alphaListConnectionsResponse + GoogleCloudIntegrationsV1alphaAccessToken: + id: GoogleCloudIntegrationsV1alphaAccessToken + properties: + accessTokenExpireTime: + description: >- + Required. The approximate time until the access token retrieved is + valid. + format: google-datetime type: string - enumDescriptions: - - LAUNCH_STAGE_UNSPECIFIED. - - PREVIEW. - - GA. - - DEPRECATED. - - PRIVATE_PREVIEW. - description: Output only. Flag to mark the version indicating the launch stage. - readOnly: true - enum: - - LAUNCH_STAGE_UNSPECIFIED - - PREVIEW - - GA - - DEPRECATED - - PRIVATE_PREVIEW - status: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' - description: Output only. Current status of the connection. - serviceDirectory: + refreshToken: type: string description: >- - Output only. The name of the Service Directory service name. Used - for Private Harpoon to resolve the ILB address. e.g. - "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" - readOnly: true - connectorVersion: - type: string + If the access token will expire, use the refresh token to obtain + another access token. + tokenType: description: >- - Required. Connector version on which the connection is created. The - format is: - projects/*/locations/*/providers/*/connectors/*/versions/* Only - global location is supported for ConnectorVersion resource. - eventingConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' - description: Optional. Eventing config of a connection - tlsMigrationState: - readOnly: true - enum: - - TLS_MIGRATION_STATE_UNSPECIFIED - - TLS_MIGRATION_NOT_STARTED - - TLS_MIGRATION_COMPLETED + Only support "bearer" token in v1 as bearer token is the predominant + type used with OAuth 2.0. + type: string + accessToken: type: string - description: Output only. Status of the TLS migration. - enumDescriptions: - - TLS migration state is not specified. - - TLS migration is in progress. - - TLS migration is completed. - name: description: >- - Output only. Resource name of the Connection. Format: - projects/{project}/locations/{location}/connections/{connection} + The access token encapsulating the security identity of a process or + thread. + refreshTokenExpireTime: + format: google-datetime + description: The approximate time until the refresh token retrieved is valid. type: string - readOnly: true - asyncOperationsEnabled: + description: >- + The access token represents the authorization of a specific application + to access specific parts of a user’s data. + type: object + GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: + properties: + value: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' description: >- - Optional. Async operations enabled for the connection. If Async - Operations is enabled, Connection allows the customers to initiate - async long running operations using the actions API. - type: boolean - serviceAccount: + Values for the defined keys. Each value can either be string, int, + double or any proto message or a serialized object. + parameter: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter description: >- - Optional. Service account needed for runtime plane to access Google - Cloud resources. + Optional. Integration Parameter to provide the default value, data + type and attributes required for the Integration config variables. + id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter + description: >- + Integration Config Parameter is defined in the integration config and + are used to provide external configuration for integration. It provide + information about data types of the expected parameters and provide any + default values or value. They can also be used to add custom attributes. + type: object + GoogleCloudIntegrationsV1alphaTaskExecutionDetails: + description: Contains the details of the execution of this task. + type: object + id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails + properties: + taskNumber: type: string - sslConfig: - description: Optional. Ssl config of a connection - $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' - isTrustedTester: - readOnly: true - type: boolean - description: Output only. Is trusted tester program enabled for the project. - billingConfig: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' - description: Output only. Billing config for the connection. - id: GoogleCloudConnectorsV1Connection - description: Connection represents an instance of connector. - GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: + description: Pointer to the task config it used for execution. + taskExecutionState: + description: The execution state of this task. + type: string + enumDescriptions: + - Default value. + - >- + Task is waiting for its precondition tasks to finish to start the + execution. + - Task is under processing. + - >- + Task execution successfully finished. There's no more change after + this state. + - Task execution failed. There's no more change after this state. + - >- + Task execution failed and cause the whole integration execution to + fail immediately. There's no more change after this state. + - Task execution failed and waiting for retry. + - >- + Task execution skipped. This happens when its precondition wasn't + met, or the integration execution been canceled before reach to + the task. There's no more changes after this state. + - >- + Task execution canceled when in progress. This happens when + integration execution been canceled or any other task fall in + fatal state. + - >- + Task is waiting for its dependency tasks' rollback to finish to + start its rollback. + - Task is rolling back. + - >- + Task is rolled back. This is the state we will set regardless of + rollback succeeding or failing. + - >- + Task is a SuspensionTask which has executed once, creating a + pending suspension. + enum: + - TASK_EXECUTION_STATE_UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED + - FATAL + - RETRY_ON_HOLD + - SKIPPED + - CANCELLED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED + taskAttemptStats: + description: Status for the current task execution attempt. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: + properties: {} + id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + type: object + description: Response for Suspensions.ResolveSuspensions. + EnterpriseCrmFrontendsEventbusProtoIntParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray type: object + properties: + intValues: + type: array + items: + type: string + format: int64 + GoogleCloudIntegrationsV1alphaServiceAccountCredentials: description: >- - LINT.IfChange Use this request to post all workflows associated with a - given trigger id. Next available id: 13 - id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest + Represents the service account which can be used to generate access + token for authenticating the service call. + type: object + id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials properties: - clientId: - description: >- - Optional. If the client id is provided, then the combination of - trigger id and client id is matched across all the workflows. If the - client id is not provided, then workflows with matching trigger id - are executed for each client id in the {@link TriggerConfig}. For - Api Trigger, the client id is required and will be validated against - the allowed clients. + scope: type: string - scheduledTime: + description: A space-delimited list of requested scope permissions. + serviceAccount: description: >- - Optional. Time in milliseconds since epoch when the given event - would be scheduled. - format: int64 + Name of the service account that has the permission to make the + request. + type: string + GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + description: 'The request for scheduling an integration. Next available id: 11' + properties: + scheduleTime: + format: google-datetime type: string - testMode: - type: boolean description: >- - Optional. Sets test mode in {@link - enterprise/crm/eventbus/event_message.proto}. - triggerId: + The time that the integration should be executed. If the time is + less or equal to the current time, the integration is executed + immediately. + userGeneratedExecutionId: type: string description: >- - Matched against all {@link TriggerConfig}s across all workflows. - i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. + Optional. This is a unique id provided by the method caller. If + provided this will be used as the execution_id when a new execution + info is created. This is a string representation of a UUID. Must + have no more than 36 characters and contain only alphanumeric + characters and hyphens. requestId: + description: >- + This is used to de-dup incoming request: if the duplicate request + was detected, the response from the previous execution is returned. type: string + inputParameters: + description: Optional. Input parameters used by integration execution. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + parameterEntries: + type: array description: >- - Optional. This is used to de-dup incoming request: if the duplicate - request was detected, the response from the previous execution is - returned. Must have no more than 36 characters and contain only - alphanumeric characters and hyphens. + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry parameters: - description: Passed in as parameters to each workflow execution. Optional. $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - resourceName: - type: string - description: >- - This field is only required when using Admin Access. The resource - name of target, or the parent resource name. For example: - "projects/*/locations/*/integrations/*" - priority: - enum: - - UNSPCIFIED - - SHEDDABLE - - SHEDDABLE_PLUS - - CRITICAL - - CRITICAL_PLUS - enumDescriptions: - - Unspecified - - >- - Frequent partial and occasional full unavailability is expected - and not pageable. * Requests to this band will be shed before all - other requests. * This is the default for async calls sent from - batch jobs. - - >- - Partial unavailability is expected and is not necessarily - pageable. * Requests to this band will be shed before any critical - traffic. * This is the default for async calls sent from - production jobs. - - >- - Any outage is a pageable event. * During a production outage - requests in this band will only be shed before CRITICAL_PLUS. * - This is the default for sync calls sent from production jobs. - - >- - Any outage is a pageable event. * The guideline is for < 10% of - requests to a service to be in this band. * During a production - outage requests in this band will be prioritized above all others. - * Opt-in to CRITICAL_PLUS when your workflow triggers by human. + deprecated: true + description: Passed in as parameters to each integration execution. + triggerId: + description: >- + Required. Matched against all {@link TriggerConfig}s across all + integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) + type: string + type: object + GoogleCloudIntegrationsV1alphaListIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse + description: Response for ListIntegrations. + properties: + nextPageToken: + type: string + description: The next page token for the response. + integrations: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' + type: array + description: The integrations which match the request. + type: object + GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: + description: Request for the ReplaceServiceAccount rpc + id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + properties: + runAsServiceAccount: type: string + description: 'Required. REQUIRED: Run-as service account to be updated' + type: object + GoogleCloudIntegrationsV1alphaProvisionClientRequest: + type: object + id: GoogleCloudIntegrationsV1alphaProvisionClientRequest + properties: + skipCpProvision: + type: boolean + description: Optional. Indicates if skip CP provision or not + provisionGmek: + type: boolean description: >- - The request priority this request should be processed at. For - internal users: - quotaRetryCount: + Optional. Deprecated. Indicates provision with GMEK or CMEK. This + field is deprecated and the provision would always be GMEK if + cloud_kms_config is not present in the request. + deprecated: true + createSampleWorkflows: + type: boolean description: >- - Optional. This is a field to see the quota retry count for - integration execution - format: int32 - type: integer - workflowName: + Optional. Indicates if sample workflow should be created along with + provisioning + runAsServiceAccount: description: >- - Optional. If provided, the workflow_name is used to filter all the - matched workflows having same trigger_id+client_id. A combination of - trigger_id, client_id and workflow_name identifies a unique - workflow. + Optional. User input run-as service account, if empty, will bring up + a new default service account type: string - ignoreErrorIfNoActiveWorkflow: + cloudKmsConfig: description: >- - Optional. Flag to determine whether clients would suppress a warning - when no ACTIVE workflows are not found. If this flag is set to be - true, an error will not be thrown if the requested trigger_id or - client_id is not found in any ACTIVE workflow. Otherwise, the error - is always thrown. The flag is set to be false by default. - type: boolean - userGeneratedExecutionId: + Optional. OPTIONAL: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + description: Request for the Provision rpc + GoogleCloudIntegrationsV1alphaListSuspensionsResponse: + type: object + description: Response for Suspensions.ListSuspensions. + id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse + properties: + nextPageToken: + description: Token to retrieve the next page of results. type: string + suspensions: description: >- - This is a unique id provided by the method caller. If provided this - will be used as the execution_id when a new execution info is - created. This is a string representation of a UUID. Must have no - more than 36 characters and contain only alphanumeric characters and - hyphens. - GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: + The suspensions for the relevant execution which the caller has + permissions to view and resolve. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' + type: array + EnterpriseCrmEventbusProtoJsonFunction: properties: - noPermission: - type: boolean - description: Whether the user has no permission on the version or not. - integrationVersions: - description: The integrations which match the request. + functionName: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET_PROPERTY + - GET_ELEMENT + - APPEND_ELEMENT + - SIZE + - SET_PROPERTY + - FLATTEN + - FLATTEN_ONCE + - MERGE + - TO_STRING + - TO_INT + - TO_DOUBLE + - TO_BOOLEAN + - TO_PROTO + - TO_STRING_ARRAY + - TO_INT_ARRAY + - TO_DOUBLE_ARRAY + - TO_PROTO_ARRAY + - TO_BOOLEAN_ARRAY + - REMOVE_PROPERTY + - RESOLVE_TEMPLATE + - EQUALS + - FOR_EACH + - FILTER_ELEMENTS + id: EnterpriseCrmEventbusProtoJsonFunction + type: object + EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: + id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + type: object + properties: + parameters: items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry type: array - nextPageToken: + GoogleCloudIntegrationsV1alphaCloudLoggingDetails: + properties: + enableCloudLogging: + description: >- + Optional. Status of whether Cloud Logging is enabled or not for the + integration version getting executed. + type: boolean + cloudLoggingSeverity: type: string + enumDescriptions: + - Unspecified + - >- + If Severity selected is `INFO`, then all the Integration Execution + States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, + `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + - >- + If Severity selected is `ERROR`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + - >- + If Severity selected is `WARNING`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + enum: + - CLOUD_LOGGING_SEVERITY_UNSPECIFIED + - INFO + - ERROR + - WARNING 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. - id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + Optional. Severity selected by the customer for the logs to be sent + to Cloud Logging, for the integration version getting executed. + id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails type: object - description: Response for ListIntegrationVersions. - EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: + description: Cloud Logging details for execution info + GoogleCloudIntegrationsV1alphaParameterMapEntry: type: object - id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage properties: - parameters: + key: + description: Key of the map entry. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + value: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + description: Value of the map entry. + description: Entry is a pair of key and value. + id: GoogleCloudIntegrationsV1alphaParameterMapEntry + EnterpriseCrmEventbusProtoDoubleFunction: + id: EnterpriseCrmEventbusProtoDoubleFunction + properties: + functionName: + type: string + enum: + - UNSPECIFIED + - TO_JSON + - TO_STRING + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - ROUND + - FLOOR + - CEIL + - GREATER_THAN + - LESS_THAN + - EQUALS + - GREATER_THAN_EQUALS + - LESS_THAN_EQUALS + - MOD + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: object + GoogleCloudIntegrationsV1alphaImportTemplateResponse: + id: GoogleCloudIntegrationsV1alphaImportTemplateResponse + type: object + properties: + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: IntegrationVersion after the import. + subIntegrationVersions: items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Sub integration versions which are imported. type: array - GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: + description: Response for import template + EnterpriseCrmEventbusProtoTaskMetadataAdmin: + type: object + id: EnterpriseCrmEventbusProtoTaskMetadataAdmin + description: >- + Admins are owners of a Task, and have all permissions on a particular + task identified by the task name. By default, Eventbus periodically + scans all task metadata and syncs (adds) any new admins defined here to + Zanzibar. properties: - clientId: + googleGroupEmail: type: string - description: The client identifier. - clientSecret: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret version reference containing the client secret. - id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + userEmail: + type: string + GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: type: object + id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + properties: + scope: + type: string + description: A space-delimited list of requested scope permissions. + clientSecret: + description: The client's secret. + type: string + tokenParams: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + description: Token parameters for the auth request. + clientId: + type: string + description: The client's ID. + tokenEndpoint: + description: >- + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. + type: string + accessToken: + description: Access token fetched from the authorization server. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + requestType: + description: Represent how to pass parameters to fetch access token + enumDescriptions: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + type: string + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER description: >- - Parameters to support Oauth 2.0 Client Credentials Grant Authentication. - See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. - EnterpriseCrmEventbusProtoSerializedObjectParameter: + For client credentials grant, the client sends a POST request with + grant_type as 'client_credentials' to the authorization server. The + authorization server will respond with a JSON object containing the + access token. + EnterpriseCrmEventbusProtoConditionResult: type: object + id: EnterpriseCrmEventbusProtoConditionResult properties: - objectValue: + nextTaskNumber: type: string - format: byte - id: EnterpriseCrmEventbusProtoSerializedObjectParameter - GoogleCloudConnectorsV1HPAConfig: + description: the next task number. + currentTaskNumber: + description: the current task number. + type: string + result: + type: boolean + description: >- + the result comes out after evaluate the combined condition. True if + there's no combined condition specified. + description: Contains the combined condition calculation results. + EnterpriseCrmEventbusProtoFunctionType: + properties: + booleanArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' + booleanFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction' + doubleFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' + jsonFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' + stringFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' + intArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction' + protoArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' + intFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntFunction' + baseFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' + description: LINT.IfChange + stringArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' + doubleArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' + protoFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' type: object + id: EnterpriseCrmEventbusProtoFunctionType + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: properties: - memoryUtilizationThreshold: - readOnly: true + regex: + description: The regex applied to the input value(s). type: string - format: int64 + exclusive: + type: boolean description: >- - Output only. Percent Memory utilization where HPA triggers - autoscaling. - cpuUtilizationThreshold: - description: Output only. Percent CPU utilization where HPA triggers autoscaling. - readOnly: true - type: string - format: int64 - description: Autoscaling config for connector deployment system metrics. - id: GoogleCloudConnectorsV1HPAConfig - GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: - description: Metadata of runtime connection schema. + Whether the regex matcher is applied exclusively (if true, matching + values will be rejected). + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + description: Rule used to validate strings. + type: object + EnterpriseCrmEventbusProtoParameterMapEntry: + id: EnterpriseCrmEventbusProtoParameterMapEntry properties: - actions: - description: List of actions. + key: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + description: Entry is a pair of key and value. + type: object + GoogleCloudIntegrationsV1alphaSfdcInstance: + properties: + sfdcOrgId: + description: The SFDC Org Id. This is defined in salesforce. + type: string + serviceAuthority: + type: string + description: >- + URL used for API calls after authentication (the login authority is + configured within the referenced AuthConfig). + authConfigId: items: type: string + description: A list of AuthConfigs that can be tried to open the channel to SFDC type: array - entities: - type: array - items: - type: string - description: List of entity names. + deleteTime: + description: >- + Output only. Time when the instance was deleted. Empty if not + deleted. + type: string + readOnly: true + format: google-datetime + updateTime: + readOnly: true + type: string + format: google-datetime + description: Output only. Time when the instance was last updated + displayName: + type: string + description: User selected unique name/alias to easily reference an instance. + createTime: + format: google-datetime + readOnly: true + description: Output only. Time when the instance is created + type: string + name: + type: string + description: >- + Resource name of the SFDC instance + projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. + description: + type: string + description: A description of the sfdc instance. + id: GoogleCloudIntegrationsV1alphaSfdcInstance + description: >- + The SfdcInstance resource use to hold channels and connection config + data. type: object - id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: + GoogleCloudIntegrationsV1alphaExecutionSnapshot: type: object + id: GoogleCloudIntegrationsV1alphaExecutionSnapshot properties: - configParameters: + params: + description: Parameters used during the execution. type: object additionalProperties: - type: any - description: Properties of the object. - description: Optional. Config parameters used during integration execution. - description: Request for PublishIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest - GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: - type: object - id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse - description: Response for listing RuntimeActionSchemas for a specific Connection. - properties: - nextPageToken: - type: string - description: Next page token. - runtimeActionSchemas: - description: Runtime action schemas. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + taskExecutionDetails: type: array + description: All of the task execution details at the given point of time. items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema - GoogleCloudConnectorsV1LogConfig: - type: object - id: GoogleCloudConnectorsV1LogConfig - properties: - level: - description: Optional. Log configuration level. - enum: - - LOG_LEVEL_UNSPECIFIED - - ERROR - - INFO - - DEBUG + #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails + checkpointTaskNumber: type: string - enumDescriptions: - - Log level unspecified. - - Only error logs are enabled. - - Info and error logs are enabled. - - Debug and high verbosity logs are enabled. - enabled: description: >- - Enabled represents whether logging is enabled or not for a - connection. - type: boolean - description: Log configuration for the connection. - EnterpriseCrmEventbusProtoValueType: + Indicates "after which checkpoint task's execution" this snapshot is + taken. + executionSnapshotMetadata: + description: Metadata of the execution snapshot. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + description: Contains the snapshot of the execution for a given checkpoint. + GoogleCloudIntegrationsV1alphaShareTemplateRequest: + id: GoogleCloudIntegrationsV1alphaShareTemplateRequest properties: - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' - intValue: + resourceNames: + description: >- + Optional. Project name resources to share the template. The project + names is expected in resource format Ex: projects/{project-number} + or organization/{org-id} + type: array + items: + type: string + description: Request to Share template + type: object + GoogleCloudIntegrationsV1alphaAuthToken: + id: GoogleCloudIntegrationsV1alphaAuthToken + type: object + properties: + type: type: string - format: int64 - booleanValue: - type: boolean - protoValue: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' - doubleValue: - format: double - type: number - stringValue: + description: Authentication type, e.g. "Basic", "Bearer", etc. + token: type: string - id: EnterpriseCrmEventbusProtoValueType + description: The token for the auth type. description: >- - Used for define type for values. Currently supported value types include - int, string, double, array, and any proto message. - type: object - EnterpriseCrmFrontendsEventbusProtoTriggerConfig: - id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig + The credentials to authenticate a user agent with a server that is put + in HTTP Authorization request header. + EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: + id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + description: 'Next available id: 4' type: object - description: 'Configuration detail of a trigger. Next available id: 20' properties: - triggerName: - type: string + rollbackTaskImplementationClassName: description: >- - Optional. Name of the trigger This is added to identify the type of - trigger. This is avoid the logic on triggerId to identify the - trigger_type and push the same to monitoring. - triggerId: + Required. This is the name of the task that needs to be executed + upon rollback of this task. type: string - description: The backend trigger ID. - enabledClients: + parameters: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Optional. The customized parameters the user can pass to this task. + taskNumbersToRollback: + type: array items: type: string - type: array description: >- - Required. The list of client ids which are enabled to execute the - workflow using this trigger. In other words, these clients have the - workflow execution privledges for this trigger. For API trigger, the - client id in the incoming request is validated against the list of - enabled clients. For non-API triggers, one workflow execution is - triggered on behalf of each enabled client. - startTasks: + Required. These are the tasks numbers of the tasks whose + `rollback_strategy.rollback_task_implementation_class_name` needs to + be executed upon failure of this task. + GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: + description: The response for executing an integration. + properties: + executionInfoIds: + type: array + description: The execution info id for the executed integrations. items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + type: string + type: object + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + GoogleCloudIntegrationsV1alphaClientConfig: + description: The configuration information for the Client + type: object + properties: + enableVariableMasking: description: >- - Set of tasks numbers from where the workflow execution is started by - this trigger. If this is empty, then workflow is executed with - default start tasks. In the list of start tasks, none of two tasks - can have direct ancestor-descendant relationships (i.e. in a same - workflow execution graph). - type: array - label: + Optional. True if variable masking feature should be turned on for + this region + type: boolean + runAsServiceAccount: type: string - description: The user created label for a particular trigger. - position: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' description: >- - Optional. Informs the front-end application where to draw this - trigger config on the UI. - errorCatcherId: + Default run-as service account email, set up during project + provision time, that will be used to generate auth token to be used + in Connector task, Rest caller task, Cloud function task and + Subworkflows. + createTime: type: string - description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - nextTasksExecutionPolicy: - description: Dictates how next tasks will be executed. - enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. + format: google-datetime + description: The timestamp when the client was first created. + projectId: + description: The GCP project id of the client associated with type: string - triggerType: + description: type: string + description: Description of what the client is used for + billingType: + description: Indicates the billing type of the client enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - Unspecified billing type + - A trial org provisioned through Apigee Provisioning Wizard + - Subscription based users of Apigee + - Consumption based users of IP enum: - - UNKNOWN - - CLOUD_PUBSUB - - GOOPS - - SFDC_SYNC - - CRON - - API - - MANIFOLD_TRIGGER - - DATALAYER_DATA_CHANGE - - SFDC_CHANNEL - - CLOUD_PUBSUB_EXTERNAL - - SFDC_CDC_CHANNEL - - SFDC_PLATFORM_EVENTS_CHANNEL - - CLOUD_SCHEDULER - - INTEGRATION_CONNECTOR_TRIGGER - - PRIVATE_TRIGGER - alertConfig: - type: array - description: >- - An alert threshold configuration for the [trigger + client + - workflow] tuple. If these values are not specified in the trigger - config, default values will be populated by the system. Note that - there must be exactly one alert threshold configured per [client + - trigger + workflow] when published. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' - triggerNumber: + - BILLING_TYPE_UNSPECIFIED + - BILLING_TYPE_APIGEE_TRIALS + - BILLING_TYPE_APIGEE_SUBSCRIPTION + - BILLING_TYPE_PAYG type: string - description: >- - Required. A number to uniquely identify each trigger config within - the workflow on UI. - description: + isGmek: + type: boolean + description: Optional. Indicates the client is provisioned with CMEK or GMEK. + region: + description: The region the client is linked to. type: string - description: >- - User-provided description intended to give more business context - about the task. - triggerCriteria: - description: >- - Optional. When set, Eventbus will run the task specified in the - trigger_criteria and validate the result using the - trigger_criteria.condition, and only execute the workflow when - result is true. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria' - pauseWorkflowExecutions: - description: >- - Optional. If set to true, any upcoming requests for this trigger - config will be paused and the executions will be resumed later when - the flag is reset. The workflow to which this trigger config belongs - has to be in ACTIVE status for the executions to be paused or - resumed. + cloudKmsConfig: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. + enableInternalIp: type: boolean - cloudSchedulerConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' - properties: - additionalProperties: - type: string description: >- - Configurable properties of the trigger, not to be confused with - workflow parameters. E.g. "name" is a property for API triggers and - "subscription" is a property for Cloud Pubsub triggers. - type: object - GoogleCloudConnectorsV1AuthConfigSshPublicKey: - id: GoogleCloudConnectorsV1AuthConfigSshPublicKey + Optional. Indicates the client enables internal IP feature, this is + applicable for internal clients only. + clientState: + enum: + - CLIENT_STATE_UNSPECIFIED + - CLIENT_STATE_ACTIVE + - CLIENT_STATE_DISABLED + description: Indicates the activity state the client + enumDescriptions: + - The client state is unspecified + - The client is active and able to make calls to the IP APIs + - The client is disabled and will soon be deleted + type: string + p4ServiceAccount: + description: The service agent associated with this client + type: string + id: + type: string + description: Globally unique ID (project_id + region) + id: GoogleCloudIntegrationsV1alphaClientConfig + EnterpriseCrmEventbusProtoTeardownTaskConfig: type: object properties: - username: - description: The user account used to authenticate. + teardownTaskImplementationClassName: + description: Required. Implementation class name. + type: string + parameters: + description: The parameters the user can pass to this task. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + name: + description: >- + Required. Unique identifier of the teardown task within this Config. + We use this field as the identifier to find next teardown tasks. type: string - sshClientCertPass: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Password (passphrase) for ssh client certificate if it has one. - certType: + properties: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' + creatorEmail: type: string - description: Format of SSH Client cert. - sshClientCert: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: SSH Client Cert. It should contain both public and private key. - description: Parameters to support Ssh public key Authentication. - GoogleCloudConnectorsV1ConnectorVersionInfraConfig: - id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig + description: The creator's email address. + nextTeardownTask: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' + id: EnterpriseCrmEventbusProtoTeardownTaskConfig + EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity properties: - sharedDeployment: + emailAddress: + type: string + gaiaId: type: string - description: Output only. The name of shared connector deployment. - readOnly: true - hpaConfig: - readOnly: true - description: Output only. HPA autoscaling config. - $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' - internalclientRatelimitThreshold: - description: >- - Output only. Max QPS supported for internal requests originating - from Connd. format: int64 + type: object + EnterpriseCrmEventbusProtoFailurePolicy: + properties: + retryStrategy: type: string - readOnly: true - deploymentModelMigrationState: enum: - - DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED - - IN_PROGRESS - - COMPLETED - - ROLLEDBACK - - ROLLBACK_IN_PROGRESS - readOnly: true + - UNSPECIFIED + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_WORKFLOW_WITH_BACKOFF enumDescriptions: - - Deployment model migration state is not specified. - - Deployment model migration is in progress. - - Deployment model migration is completed. - - Deployment model migration rolledback. - - Deployment model migration rollback in progress. - description: Output only. Status of the deployment model migration. - type: string - ratelimitThreshold: + - '' + - >- + Ignores the failure of this task. The rest of the workflow will be + executed Assuming this task succeeded. + - >- + Causes a permanent failure of the task. However, if the last + task(s) of event was successfully completed despite the failure of + this task, it has no impact on the workflow. + - >- + Causes a permanent failure of the event. It is different from NONE + because this will mark the event as FAILED by shutting down the + event execution. + - >- + The task will be retried from the failed task onwards after a + fixed delay. A max-retry count is required to be specified with + this strategy. A jitter is added to each exponential interval so + that concurrently failing tasks of the same type do not end up + retrying after the exact same exponential interval. + Max_num_retries and interval_in_seconds must be specified. + - >- + The task will be retried from the failed task onwards after a + fixed delay that linearly increases with each retry attempt. A + jitter is added to each exponential interval so that concurrently + failing tasks of the same type do not end up retrying after the + exact same exponential interval. A max-retry count is required to + be specified with this strategy. Max_num_retries and + interval_in_seconds must be specified. + - >- + The task will be retried after an exponentially increasing period + of time with each failure. A jitter is added to each exponential + interval so that concurrently failing tasks of the same type do + not end up retrying after the exact same exponential interval. A + max-retry count is required to be specified with this strategy. + `max_num_retries` and `interval_in_seconds` must be specified. + - >- + The entire workflow will be restarted with the initial parameters + that were set when the event was fired. A max-retry count is + required to be specified with this strategy. `max_num_retries` and + `interval_in_seconds` must be specified. + description: Defines what happens to the task upon failure. + retryCondition: type: string - format: int64 - readOnly: true description: >- - Output only. Max QPS supported by the connector version before - throttling of requests. - resourceRequests: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' - description: Output only. System resource requests. - resourceLimits: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' - description: Output only. System resource limits. - maxInstanceRequestConcurrency: - readOnly: true - type: integer + Optional. The retry condition that will be evaluated for this + failure policy with the corresponding retry strategy. + maxNumRetries: format: int32 - description: Output only. Max instance request concurrency. - connectionRatelimitWindowSeconds: - type: string - readOnly: true + type: integer description: >- - Output only. The window used for ratelimiting runtime requests to - connections. - format: int64 - deploymentModel: - enum: - - DEPLOYMENT_MODEL_UNSPECIFIED - - GKE_MST - - CLOUD_RUN_MST - description: Optional. Indicates whether connector is deployed on GKE/CloudRun + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the number of times the task will be retried if failed. + intervalInSeconds: + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the initial interval for backoff. type: string - enumDescriptions: - - Deployment model is not specified. - - Default model gke mst. - - Cloud run mst. + format: int64 + type: object + id: EnterpriseCrmEventbusProtoFailurePolicy description: >- - This cofiguration provides infra configs like rate limit threshold which - need to be configurable for every connector version + Policy that defines the task retry logic and failure type. If no + FailurePolicy is defined for a task, all its dependent tasks will not be + executed (i.e, a `retry_strategy` of NONE will be applied). + GoogleCloudIntegrationsV1alphaUploadTemplateResponse: type: object - EnterpriseCrmEventbusProtoConnectorsConnection: + id: GoogleCloudIntegrationsV1alphaUploadTemplateResponse + properties: + template: + description: The uploaded Template + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + description: Response for UploadTemplate. + EnterpriseCrmEventbusProtoTeardown: + properties: + teardownTaskConfigs: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' + type: array + description: Required. + id: EnterpriseCrmEventbusProtoTeardown type: object - id: EnterpriseCrmEventbusProtoConnectorsConnection + EnterpriseCrmEventbusProtoStringParameterArray: properties: - connectionName: - description: >- - Connection name Format: - projects/{project}/locations/{location}/connections/{connection} - type: string - connectorVersion: - type: string - description: >- - Connector version Format: - projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} - serviceName: - type: string - description: >- - Service name Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} - host: - description: >- - The name of the Hostname of the Service Directory service with TLS - if used. + stringValues: + type: array + items: + type: string + id: EnterpriseCrmEventbusProtoStringParameterArray + type: object + GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: + type: object + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + description: Response for Creating Cloud Function rpc call. + properties: + triggerUrl: + description: The trigger url that will be returned type: string - EnterpriseCrmEventbusProtoStringFunction: + EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + properties: + doubleValues: + items: + format: double + type: number + type: array + type: object + GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: + properties: {} + description: Request for the Deprovision rpc + type: object + id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + EnterpriseCrmEventbusProtoBooleanArrayFunction: type: object + id: EnterpriseCrmEventbusProtoBooleanArrayFunction properties: functionName: enum: - UNSPECIFIED - - CONCAT - - TO_UPPERCASE - - TO_LOWERCASE - - CONTAINS - - SPLIT - - LENGTH - - EQUALS - - TO_INT - - TO_DOUBLE - - TO_BOOLEAN - - TO_BASE_64 + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL - TO_JSON - - EQUALS_IGNORE_CASE - - REPLACE_ALL - - SUBSTRING - - RESOLVE_TEMPLATE - - DECODE_BASE64_STRING - enumDescriptions: - - '' - - '' - - '' - - '' - - '' + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + type: string + enumDescriptions: - '' - '' - '' @@ -5294,558 +4554,669 @@ components: - '' - '' - '' - type: string - id: EnterpriseCrmEventbusProtoStringFunction - EnterpriseCrmEventbusProtoLoopMetadata: + EnterpriseCrmEventbusProtoNextTask: properties: - failureLocation: - enumDescriptions: - - No error or Unknown. - - Subworkflow failed while firing/running. - - Param overrides failed. - - Param aggregation failed. - - Setting for loop current element failed. - - Getting the list to iterate. - - Evaluating the while loop condition. - - Building the iteration request - type: string - description: Indicates where in the loop logic did it error out. - enum: - - UNKNOWN - - SUBWORKFLOW - - PARAM_OVERRIDING - - PARAM_AGGREGATING - - SETTING_ITERATION_ELEMENT - - GETTING_LIST_TO_ITERATE - - CONDITION_EVALUATION - - BUILDING_REQUEST - errorMsg: - description: Add the error message when loops fail. + combinedConditions: + description: >- + Combined condition for this task to become an eligible next task. + Each of these combined_conditions are joined with logical OR. + DEPRECATED: use `condition` + deprecated: true + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' + type: array + condition: type: string - currentIterationDetail: description: >- - Needs to be set by the loop impl class before each iteration. The - abstract loop class will append the request and response to it. Eg. - The foreach Loop will clean up and set it as the current iteration - element at the start of each loop. The post request and response - will be appended to the value once they are available. + Standard filter expression for this task to become an eligible next + task. + taskNumber: type: string - currentIterationCount: - description: Starting from 1, not 0. - format: int64 + description: Task number of the next task. + taskConfigId: + description: ID of the next task. type: string - id: EnterpriseCrmEventbusProtoLoopMetadata - type: object - EnterpriseCrmEventbusProtoAttributes: + label: + type: string + description: User-provided label that is attached to this edge in the UI. + description: + type: string + description: >- + User-provided description intended to give more business context + about the next task edge or condition. description: >- - Attributes are additional options that can be associated with each event - property. For more information, see + The task that is next in line to be executed, if the condition specified + evaluated to true. type: object + id: EnterpriseCrmEventbusProtoNextTask + GoogleCloudIntegrationsV1alphaTemplateBundle: properties: - defaultValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - description: Used to define defaults. - taskVisibility: + subIntegrationVersionTemplates: + description: >- + Optional. Sub integration templates which would be added along with + main integration. type: array items: - type: string - description: List of tasks that can view this property, if empty then all. - masked: - type: boolean - description: True if this workflow parameter should be masked in the logs - isRequired: - type: boolean - description: >- - Required for event execution. The validation will be done by the - event bus when the event is triggered. - logSettings: - description: See - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' - dataType: - enum: - - DATA_TYPE_UNSPECIFIED - - EMAIL - - URL - - CURRENCY - - TIMESTAMP - - DOMAIN_NAME - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - >- - Domain is a web url string with one top-level private domain and a - suffix (for example: google.com, walmart.com) - description: >- - Things like URL, Email, Currency, Timestamp (rather than string, - int64...) - isSearchable: - deprecated: true - type: boolean - description: >- - Used to indicate if a ParameterEntry should be converted to - ParamIndexes for ST-Spanner full-text search. DEPRECATED: use - searchable. - searchable: - enumDescriptions: - - '' - - >- - If yes, the parameter key and value will be full-text indexed. In - a proto, this value will propagate to all children whose - searchable is unspecified. - - >- - If no, the parameter key and value will not be full-text indexed. - In a proto, this value will propagate to all children whose - searchable is unspecified. - enum: - - UNSPECIFIED - - 'YES' - - 'NO' - type: string - readOnly: - description: Used to indicate if the ParameterEntry is a read only field or not. - type: boolean - id: EnterpriseCrmEventbusProtoAttributes - GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: - properties: - integrationVersion: - description: Version after the lock is acquired by the new user. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + integrationVersionTemplate: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + description: Required. Main integration templates of the template bundle. + id: GoogleCloudIntegrationsV1alphaTemplateBundle + description: Define the bundle of the template. type: object - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse - description: Response for TakeoverEditLock. - GoogleCloudIntegrationsV1alphaCloudKmsConfig: + GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. type: object - id: GoogleCloudIntegrationsV1alphaCloudKmsConfig - description: Configuration information for Client's Cloud KMS information properties: - keyVersion: - description: >- - Optional. Each version of a key contains key material used for - encryption or signing. A key's version is represented by an integer, - starting at 1. To decrypt data or verify a signature, you must use - the same key version that was used to encrypt or sign the data. - type: string - key: - type: string - description: >- - Required. A Cloud KMS key is a named object containing one or more - key versions, along with metadata for the key. A key exists on - exactly one key ring tied to a specific location. - kmsProjectId: - type: string + alertThreshold: + format: int32 description: >- - Optional. The gcp project id of the project where the kms key - stored. If empty, the kms key is stored at the same project as - customer's project and ecrypted with CMEK, otherwise, the kms key is - stored in the tenant project and encrypted with GMEK - kmsLocation: - description: Required. Location name of the key ring, e.g. "us-west1". + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + type: integer + thresholdType: type: string - kmsRing: + enum: + - THRESHOLD_TYPE_UNSPECIFIED + - EXPECTED_MIN + - EXPECTED_MAX description: >- - Required. A key ring organizes keys in a specific Google Cloud - location and allows you to manage access control on groups of keys. - A key ring's name does not need to be unique across a Google Cloud - project, but must be unique within a given location. - type: string - GoogleCloudIntegrationsV1alphaIntParameterArray: - id: GoogleCloudIntegrationsV1alphaIntParameterArray - type: object - description: This message only contains a field of integer array. - properties: - intValues: - items: - type: string - format: int64 - description: Integer array. - type: array - GoogleCloudIntegrationsV1alphaClientConfig: - id: GoogleCloudIntegrationsV1alphaClientConfig - description: The configuration information for the Client - properties: - isGmek: - description: Optional. Indicates the client is provisioned with CMEK or GMEK. - type: boolean - id: - type: string - description: Globally unique ID (project_id + region) - p4ServiceAccount: - description: The service agent associated with this client - type: string - projectId: - type: string - description: The GCP project id of the client associated with - cloudKmsConfig: - description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - runAsServiceAccount: + The threshold type, whether lower(expected_min) or + upper(expected_max), for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. + enumDescriptions: + - Default. + - >- + Note that this field will only trigger alerts if the integration + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. Min value threshold. + - Max value threshold. + durationThreshold: type: string + format: google-duration description: >- - Default run-as service account email, set up during project - provision time, that will be used to generate auth token to be used - in Connector task, Rest caller task, Cloud function task and - Subworkflows. - createTime: - description: The timestamp when the client was first created. - format: google-datetime - type: string - enableInternalIp: + Should be specified only for *AVERAGE_DURATION and + *PERCENTILE_DURATION metrics. This member should be used to specify + what duration value the metrics should exceed for the alert to + trigger. + thresholdValue: description: >- - Optional. Indicates the client enables internal IP feature, this is - applicable for internal clients only. - type: boolean - billingType: + The metric value, above or below which the alert should be + triggered. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue + metricType: + description: The type of metric. enum: - - BILLING_TYPE_UNSPECIFIED - - BILLING_TYPE_APIGEE_TRIALS - - BILLING_TYPE_APIGEE_SUBSCRIPTION - - BILLING_TYPE_PAYG - description: Indicates the billing type of the client + - METRIC_TYPE_UNSPECIFIED + - EVENT_ERROR_RATE + - EVENT_WARNING_RATE + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - EVENT_RATE + - EVENT_AVERAGE_DURATION + - EVENT_PERCENTILE_DURATION + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION enumDescriptions: - - Unspecified billing type - - A trial org provisioned through Apigee Provisioning Wizard - - Subscription based users of Apigee - - Consumption based users of IP - type: string - clientState: - enum: - - CLIENT_STATE_UNSPECIFIED - - CLIENT_STATE_ACTIVE - - CLIENT_STATE_DISABLED + - >- + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. + - >- + Specifies alerting on the rate of errors for the enclosing + integration. + - >- + Specifies alerting on the rate of warnings for the enclosing + integration. Warnings use the same enum values as errors. + - >- + Specifies alerting on the rate of errors for any task in the + enclosing integration. + - >- + Specifies alerting on the rate of warnings for any task in the + enclosing integration. + - >- + Specifies alerting on the rate of executions over all tasks in the + enclosing integration. + - >- + Specifies alerting on the number of events executed in the given + aggregation_period. + - >- + Specifies alerting on the average duration of executions for this + integration. + - >- + Specifies alerting on the duration value of a particular + percentile of integration executions. E.g. If 10% or more of the + integration executions have durations above 5 seconds, alert. + - >- + Specifies alerting on the average duration of any task in the + enclosing integration, + - >- + Specifies alerting on the duration value of a particular + percentile of any task executions within the enclosing + integration. E.g. If 10% or more of the task executions in the + integration have durations above 5 seconds, alert. type: string - description: Indicates the activity state the client - enumDescriptions: - - The client state is unspecified - - The client is active and able to make calls to the IP APIs - - The client is disabled and will soon be deleted - region: + aggregationPeriod: type: string - description: The region the client is linked to. - enableVariableMasking: description: >- - Optional. True if variable masking feature should be turned on for - this region + The period over which the metric value should be aggregated and + evaluated. Format is , where integer should be a positive integer + and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, + day, week). For an EXPECTED_MIN threshold, this aggregation_period + must be lesser than 24 hours. + disableAlert: type: boolean - description: - description: Description of what the client is used for - type: string - type: object - GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: - properties: - expireTime: + description: >- + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this integration alert. + displayName: type: string - format: google-datetime - readOnly: true description: >- - Output only. Time after which the suspension expires, if no action - taken. - liftWhenExpired: + Name of the alert. This will be displayed in the alert subject. If + set, this name should be unique within the scope of the integration. + onlyFinalAttempt: type: boolean description: >- - Whether the suspension will be REJECTED or LIFTED upon expiration. - REJECTED is the default behavior. - remindTime: - description: >- - Time after the previous suspension action reminder, if any, is sent - using the selected notification option, for a suspension which is - still PENDING_UNSPECIFIED. - format: google-datetime - type: string + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: type: object - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration - description: Expiration configs for the approval request. - GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: + id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig properties: - parameters: - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: Passed in as parameters to each integration execution. - inputParameters: - description: Optional. Input parameters used by integration execution. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - userGeneratedExecutionId: - type: string - description: >- - Optional. This is a unique id provided by the method caller. If - provided this will be used as the execution_id when a new execution - info is created. This is a string representation of a UUID. Must - have no more than 36 characters and contain only alphanumeric - characters and hyphens. - triggerId: + operation: + description: Operation to perform using the configured connection. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - description: >- - Required. Matched against all {@link TriggerConfig}s across all - integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) - parameterEntries: - deprecated: true + enum: + - OPERATION_UNSPECIFIED + - EXECUTE_ACTION + - LIST_ENTITIES + - GET_ENTITY + - CREATE_ENTITY + - UPDATE_ENTITY + - DELETE_ENTITY + - EXECUTE_QUERY + connection: + description: User-selected connection. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' + GoogleCloudConnectorsV1SslConfig: + description: SSL Configuration of a connection + type: object + id: GoogleCloudConnectorsV1SslConfig + properties: + clientPrivateKeyPass: + description: Secret containing the passphrase protecting the Client Private Key + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + useSsl: + type: boolean + description: Bool for enabling SSL + clientPrivateKey: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Client Private Key + additionalVariables: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + description: Additional SSL related field values type: array - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - requestId: + type: + description: Controls the ssl type for the given connector version. type: string - description: >- - This is used to de-dup incoming request: if the duplicate request - was detected, the response from the previous execution is returned. - scheduleTime: + enumDescriptions: + - No SSL configuration required. + - TLS Handshake + - mutual TLS (MTLS) Handshake + enum: + - SSL_TYPE_UNSPECIFIED + - TLS + - MTLS + serverCertType: + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type + description: Type of Server Cert (PEM/JKS/.. etc.) + type: string + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + trustModel: + enum: + - PUBLIC + - PRIVATE + - INSECURE + description: Trust Model of the SSL connection type: string + enumDescriptions: + - Public Trust Model. Takes the Default Java trust store. + - Private Trust Model. Takes custom/private trust store. + - Insecure Trust Model. Accept all certificates. + clientCertificate: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Client Certificate + privateServerCertificate: description: >- - The time that the integration should be executed. If the time is - less or equal to the current time, the integration is executed - immediately. - format: google-datetime + Private Server Certificate. Needs to be specified if trust model is + `PRIVATE`. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + clientCertType: + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type + type: string + description: Type of Client Cert (PEM/JKS/.. etc.) + GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: + description: Response for listing RuntimeActionSchemas for a specific Connection. + id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse type: object - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest - description: 'The request for scheduling an integration. Next available id: 11' - GoogleCloudIntegrationsV1alphaErrorCatcherConfig: - description: Configuration detail of a error catch task - id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig properties: - label: + nextPageToken: type: string + description: Next page token. + runtimeActionSchemas: + type: array + description: Runtime action schemas. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema + GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: + type: object + description: Response for the GetClientMetadata rpc + properties: + properties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' + description: 'Required. Required: The client configuration that was requested' + id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + EnterpriseCrmEventbusStats: + description: >- + Stats for the requested dimensions: QPS, duration, and error/warning + rate + id: EnterpriseCrmEventbusStats + type: object + properties: + dimensions: + $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' + description: Dimensions that these stats have been aggregated on. + warningRate: + format: double + description: Average warning rate. + type: number + qps: + description: Queries per second. + type: number + format: double + durationInSeconds: + format: double + description: Average duration in seconds. + type: number + errorRate: + description: Average error rate. + type: number + format: double + GoogleCloudIntegrationsV1alphaFailurePolicy: + properties: + condition: description: >- - Optional. The user created label for a particular error catcher. - Optional. - errorCatcherNumber: + Optional. The string condition that will be evaluated to determine + if the task should be retried with this failure policy. type: string - description: >- - Required. A number to uniquely identify each error catcher config - within the workflow on UI. - position: - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - description: + intervalTime: + format: google-datetime type: string description: >- - Optional. User-provided description intended to give more business - context about the error catcher config. - startErrorTasks: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the initial interval in seconds for backoff. + maxRetries: + format: int32 description: >- - Required. The set of start tasks that are to be executed for the - error catch flow - errorCatcherId: + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the number of times the task will be retried if failed. + type: integer + retryStrategy: + enumDescriptions: + - UNSPECIFIED. + - >- + Ignores the failure of this task. The rest of the integration will + be executed Assuming this task succeeded. + - >- + Causes a permanent failure of the task. However, if the last + task(s) of event was successfully completed despite the failure of + this task, it has no impact on the integration. + - >- + Causes a permanent failure of the event. It is different from NONE + because this will mark the event as FAILED by shutting down the + event execution. + - >- + The task will be retried from the failed task onwards after a + fixed delay. A max-retry count is required to be specified with + this strategy. A jitter is added to each exponential interval so + that concurrently failing tasks of the same type do not end up + retrying after the exact same exponential interval. max_retries + and interval_in_seconds must be specified. + - >- + The task will be retried from the failed task onwards after a + fixed delay that linearly increases with each retry attempt. A + jitter is added to each exponential interval so that concurrently + failing tasks of the same type do not end up retrying after the + exact same exponential interval. A max-retry count is required to + be specified with this strategy. max_retries and + interval_in_seconds must be specified. + - >- + The task will be retried after an exponentially increasing period + of time with each failure. A jitter is added to each exponential + interval so that concurrently failing tasks of the same type do + not end up retrying after the exact same exponential interval. A + max-retry count is required to be specified with this strategy. + `max_retries` and `interval_in_seconds` must be specified. + - >- + The entire integration will be restarted with the initial + parameters that were set when the event was fired. A max-retry + count is required to be specified with this strategy. + `max_retries` and `interval_in_seconds` must be specified. type: string - description: >- - Required. An error catcher id is string representation for the error - catcher config. Within a workflow, error_catcher_id uniquely - identifies an error catcher config among all error catcher configs - for the workflow + enum: + - RETRY_STRATEGY_UNSPECIFIED + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_INTEGRATION_WITH_BACKOFF + description: Defines what happens to the task upon failure. + description: >- + Policy that defines the task retry logic and failure type. If no + FailurePolicy is defined for a task, all its dependent tasks will not be + executed (i.e, a `retry_strategy` of NONE will be applied). + id: GoogleCloudIntegrationsV1alphaFailurePolicy type: object - EnterpriseCrmEventbusProtoDoubleArray: + EnterpriseCrmEventbusProtoBaseFunction: + id: EnterpriseCrmEventbusProtoBaseFunction properties: - values: + functionName: + enum: + - UNSPECIFIED + - NOW_IN_MILLIS + - INT_LIST + - ENVIRONMENT + - GET_EXECUTION_ID + - GET_INTEGRATION_NAME + - GET_REGION + - GET_UUID + - GET_PROJECT_ID + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: object + EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + type: object + properties: + booleanValues: type: array items: - format: double - type: number + type: boolean + EnterpriseCrmEventbusProtoMappedField: + description: Mapped field is a pair of input field and output field. + properties: + outputField: + description: The output field being mapped to. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' + inputField: + description: The input field being mapped from. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' type: object - id: EnterpriseCrmEventbusProtoDoubleArray - EnterpriseCrmEventbusProtoBaseValue: - id: EnterpriseCrmEventbusProtoBaseValue + id: EnterpriseCrmEventbusProtoMappedField + GoogleCloudConnectorsV1ConnectionStatus: type: object + description: ConnectionStatus indicates the state of the connection. properties: - referenceValue: + status: type: string - description: Start with a reference value to dereference. - baseFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' - description: >- - Start with a function that does not build on existing values. Eg. - CurrentTime, Min, Max, Exists, etc. - literalValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: Start with a literal value. - EnterpriseCrmEventbusProtoIntParameterArray: - properties: - intValues: - items: - format: int64 - type: string - type: array + description: Status provides detailed information for the state. + state: + description: State. + type: string + enumDescriptions: + - Connection does not have a state yet. + - Connection is being created. + - Connection is running and ready for requests. + - Connection is stopped. + - Connection is being deleted. + - Connection is being updated. + - Connection is not running due to an error. + - >- + Connection is not running because the authorization configuration + is not complete. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - UPDATING + - ERROR + - AUTHORIZATION_REQUIRED + description: + type: string + description: Description. + id: GoogleCloudConnectorsV1ConnectionStatus + GoogleCloudIntegrationsV1alphaClientCertificate: type: object - id: EnterpriseCrmEventbusProtoIntParameterArray - EnterpriseCrmEventbusProtoCustomSuspensionRequest: + description: Contains client certificate information properties: - suspensionInfoEventParameterKey: + passphrase: + type: string + description: >- + 'passphrase' should be left unset if private key is not encrypted. + Note that 'passphrase' is not the password for web server, but an + extra layer of security to protected private key. + encryptedPrivateKey: + type: string + description: >- + The ssl certificate encoded in PEM format. This string must include + the begin header and end footer lines. For example, -----BEGIN + CERTIFICATE----- + MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV + BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw + MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET + MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA + vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 + JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB + xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P + AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB + Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey + Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW + JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr + 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H + wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- + sslCertificate: description: >- - In the fired event, set the SuspensionInfo message as the value for - this key. + The ssl certificate encoded in PEM format. This string must include + the begin header and end footer lines. For example, -----BEGIN + CERTIFICATE----- + MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV + BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw + MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET + MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA + vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 + JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB + xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P + AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB + Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey + Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW + JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr + 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H + wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- type: string - postToQueueWithTriggerIdRequest: - description: Request to fire an event containing the SuspensionInfo message. - $ref: >- - #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest - type: object - id: EnterpriseCrmEventbusProtoCustomSuspensionRequest - GoogleCloudIntegrationsV1alphaTemplate: - description: Defines the template for Application Integration + id: GoogleCloudIntegrationsV1alphaClientCertificate + EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: type: object - id: GoogleCloudIntegrationsV1alphaTemplate properties: - components: - type: array - description: >- - Optional. Components being used in the template. This could be used - to categorize and filter. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTemplateComponent - usageInfo: + fullName: description: >- - Optional. Information on how to use the template. This should - contain detailed information about usage of the template. + The fully-qualified proto name. This message, for example, would be + "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". type: string - createTime: - description: Output only. Auto-generated. - format: google-datetime - readOnly: true + path: + description: Path to the proto file that contains the message type's definition. type: string - author: - description: Optional. Creator of the template. + id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition + GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + description: Request for Creating Cloud Function rpc call. + properties: + functionName: type: string - lastUsedTime: - format: google-datetime - description: Optional. Time the template was last used. + description: The function name of CF to be created + functionRegion: type: string - templateBundle: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplateBundle' - description: >- - Required. Bundle which is part of the templates. The template - entities in the bundle would be converted to an actual entity. - sharedWith: - type: array - items: - type: string - description: >- - Required. Resource names with which the template is shared for - example ProjectNumber/Ord id - description: + description: The function region of CF to be created + projectId: description: >- - Optional. Description of the template. The length should not be more - than 255 characters + Indicates the id of the GCP project that the function will be + created in. type: string - name: - description: Identifier. Resource name of the template. + type: object + GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: + type: object + id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + description: Cloud Scheduler Trigger configuration + properties: + cronTab: + description: Required. The cron tab of cloud scheduler trigger. + type: string + location: type: string - categories: - items: - type: string - enumDescriptions: - - Category is unspecified - - AI_MACHINE_LEARNING - - BUSINESS_INTELLIGENCE - - COLLABORATION - - CUSTOMER_SERVICE - - DATAABASES - - DEVOPS_IT - - CONTENT_AND_FILES - - FINANCE_AND_ACCOUNTING - - HUMAN_RESOURCES - - OPERATIONS - - PRODUCT_PROJECT_MANAGEMENT - - PRODUCTIVITY - - SALES_AND_MARKETING - - UNIVERSAL_CONNECTORS - - UTILITY - - OTHERS - enum: - - CATEGORY_UNSPECIFIED - - AI_MACHINE_LEARNING - - BUSINESS_INTELLIGENCE - - COLLABORATION - - CUSTOMER_SERVICE - - DATABASES - - DEVOPS_IT - - CONTENT_AND_FILES - - FINANCE_AND_ACCOUNTING - - HUMAN_RESOURCES - - OPERATIONS - - PRODUCT_PROJECT_MANAGEMENT - - PRODUCTIVITY - - SALES_AND_MARKETING - - UNIVERSAL_CONNECTORS - - UTILITY - - OTHERS - type: array description: >- - Required. Categories associated with the Template. The categories - listed below will be utilized for the Template listing. - docLink: + Required. The location where associated cloud scheduler job will be + created + serviceAccountEmail: type: string - description: Optional. Link to template documentation. - updateTime: - description: Output only. Auto-generated + description: >- + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time + errorMessage: + description: >- + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations type: string - readOnly: true - format: google-datetime - displayName: - description: Required. The name of the template + GoogleCloudConnectorsV1LockConfig: + description: >- + Determines whether or no a connection is locked. If locked, a reason + must be specified. + id: GoogleCloudConnectorsV1LockConfig + type: object + properties: + locked: + description: Indicates whether or not the connection is locked. + type: boolean + reason: type: string - tags: - type: array - description: >- - Required. Tags which are used to identify templates. These tags - could be for business use case, connectors etc. - items: - type: string - visibility: + description: Describes why a connection is locked. + GoogleCloudIntegrationsV1alphaSuccessPolicy: + properties: + finalState: enum: - - VISIBILITY_UNSPECIFIED - - PRIVATE - - SHARED - - PUBLIC - type: string + - FINAL_STATE_UNSPECIFIED + - SUCCEEDED + - SUSPENDED + description: >- + State to which the execution snapshot status will be set if the task + succeeds. enumDescriptions: - - Visibility is unspecified - - Visibility is private - - Visibility is shared - - Visibility is public - description: Required. Visibility of the template. - usageCount: + - UNSPECIFIED. + - >- + The default behavior, where successful tasks will be marked as + SUCCEEDED. + - >- + Sets the state to SUSPENDED after executing. This is required for + SuspensionTask; event execution will continue once the user calls + ResolveSuspensions with the event_execution_info_id and the task + number. type: string - format: int64 - description: Optional. Number of template usages. - GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: + description: >- + Policy that dictates the behavior for the task after it completes + successfully. + type: object + id: GoogleCloudIntegrationsV1alphaSuccessPolicy + GoogleCloudIntegrationsV1alphaUseTemplateResponse: + description: Response for use template + type: object + id: GoogleCloudIntegrationsV1alphaUseTemplateResponse properties: - nextPageToken: - description: The token used to retrieve the next page of results. - type: string - sfdcChannels: - description: The list of SfdcChannels retrieved. + subIntegrationVersions: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion type: array - description: Response to list SfdcChannels. + description: Sub integration versions which are created. + integrationVersion: + description: IntegrationVersion which is created. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + properties: + subject: + description: Value for the "sub" claim. + type: string + audience: + description: Value for the "aud" claim. + type: string + issuer: + type: string + description: Value for the "iss" claim. type: object - id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse - EnterpriseCrmFrontendsEventbusProtoParameterEntry: + description: JWT claims used for the jwt-bearer authorization grant. + GoogleCloudIntegrationsV1alphaUnshareTemplateRequest: + id: GoogleCloudIntegrationsV1alphaUnshareTemplateRequest properties: - value: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + resourceNames: + type: array description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - masked: - description: True if this parameter should be masked in the logs - type: boolean - dataType: + Optional. Project name resources to unshare the template. The + project names is expected in resource format Ex: + projects/{project-number} + items: + type: string + type: object + description: Request to Unshare template + EnterpriseCrmEventbusProtoField: + type: object + id: EnterpriseCrmEventbusProtoField + description: Information about the value and type of the field. + properties: + fieldType: type: string enum: - DATA_TYPE_UNSPECIFIED @@ -5866,7 +5237,7 @@ components: - BYTES_ARRAY - NON_SERIALIZABLE_OBJECT - JSON_VALUE - description: Explicitly getting the type of the parameter. + description: Specifies the data type of the field. enumDescriptions: - '' - '' @@ -5889,717 +5260,798 @@ components: - '' - '' - '' - key: + transformExpression: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the workflow definition. + This is the transform expression to fetch the input field value. for + e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can + have a transform expression. 2. If a transform expression is + provided, reference_key will be ignored. 3. If no value is returned + after evaluation of transform expression, default_value can be + mapped if provided. 4. The field_type should be the type of the + final object returned after the transform expression is evaluated. + Scrubs the transform expression before logging as value provided by + user so may or may not contain PII or SPII data. + referenceKey: + description: >- + This holds the reference key of the workflow or task parameter. 1. + Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input + or output parameter, for e.g. $task1_param1$. 3. Any workflow or + task parameters with subfield references, for e.g., + $task1_param1.employee.id$ type: string - type: object - id: EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: Key-value pair of EventBus parameters. - GoogleCloudConnectorsV1Secret: - id: GoogleCloudConnectorsV1Secret - properties: - secretVersion: + cardinality: + enumDescriptions: + - For fields with unspecified cardinality. + - >- + If field cardinality is set to optional, ignore errors if input + field value is null or the reference_key is not found. type: string description: >- - The resource name of the secret version in the format, format as: - `projects/*/secrets/*/versions/*`. - type: object - description: Secret provides a reference to entries in Secret Manager. - EnterpriseCrmEventbusProtoAddress: - description: >- - Email address along with optional name and tokens. These tokens will be - substituted for the variables in the form of [{var_name}], where - var_name could be any string of no more than 32 bytes. - id: EnterpriseCrmEventbusProtoAddress - properties: - name: - type: string - email: - description: Required. + By default, if the cardinality is unspecified the field is + considered required while mapping. + enum: + - UNSPECIFIED + - OPTIONAL + defaultValue: + description: >- + This holds the default values for the fields. This value is supplied + by user so may or may not contain PII or SPII data. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + protoDefPath: type: string - tokens: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' - type: object - EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: + description: >- + Optional. The fully qualified proto name (e.g. + enterprise.crm.storage.Account). Required for output field of type + PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES + and output field_type is PROTO_VALUE, then fully qualified proto + type url should be provided to parse the input bytes. If field_type + is *_ARRAY, then all the converted protos are of the same type. + EnterpriseCrmEventbusProtoSuspensionExpiration: + id: EnterpriseCrmEventbusProtoSuspensionExpiration type: object properties: - producedBy: + remindAfterMs: description: >- - The identifier of the node (TaskConfig/TriggerConfig) this parameter - was produced by, if it is a transient param or a copy of an input - param. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNodeIdentifier' - dataType: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - description: The data type of the parameter. - isTransient: - type: boolean - description: Whether this parameter is a transient parameter. - key: + Milliseconds after which the previous suspension action reminder, if + any, is sent using the selected notification option, for a + suspension which is still PENDING_UNSPECIFIED. + type: integer + format: int32 + liftWhenExpired: description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the workflow definition. - type: string - attributes: - description: Metadata information about the parameters. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' - protoDefName: + Whether the suspension will be REJECTED or LIFTED upon expiration. + REJECTED is the default behavior. + type: boolean + expireAfterMs: + type: integer + format: int32 + description: Milliseconds after which the suspension expires, if no action taken. + GoogleCloudIntegrationsV1alphaTriggerConfig: + id: GoogleCloudIntegrationsV1alphaTriggerConfig + properties: + startTasks: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' description: >- - The name of the protobuf type if the parameter has a protobuf data - type. - type: string - inOutType: - type: string - enumDescriptions: - - '' - - >- - Input parameters for the workflow. EventBus validates that these - parameters exist in the workflows before execution. - - >- - Output Parameters for the workflow. EventBus will only return the - workflow parameters tagged with OUT in the response back. - - >- - Input or Output Parameters. These can be used as both input and - output. EventBus will validate for the existence of these - parameters before execution and will also return this parameter - back in the response. - description: Specifies the input/output type for the parameter. - enum: - - IN_OUT_TYPE_UNSPECIFIED - - IN - - OUT - - IN_OUT - children: + Optional. Set of tasks numbers from where the integration execution + is started by this trigger. If this is empty, then integration is + executed with default start tasks. In the list of start tasks, none + of two tasks can have direct ancestor-descendant relationships (i.e. + in a same integration execution graph). type: array - description: >- - Child parameters nested within this parameter. This field only - applies to protobuf parameters + alertConfig: items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - containsLargeData: - type: boolean + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - jsonSchema: + Optional. An alert threshold configuration for the [trigger + client + + integration] tuple. If these values are not specified in the + trigger config, default values will be populated by the system. Note + that there must be exactly one alert threshold configured per + [client + trigger + integration] when published. + type: array + properties: + description: >- + Optional. Configurable properties of the trigger, not to be confused + with integration parameters. E.g. "name" is a property for API + triggers and "subscription" is a property for Pub/sub triggers. + additionalProperties: + type: string + type: object + triggerId: + type: string + description: >- + Optional. Auto-generated trigger ID. The ID is based on the + properties that you define in the trigger config. For example, for + an API trigger, the trigger ID follows the format: + api_trigger/TRIGGER_NAME Where trigger config has properties with + value {"Trigger name": TRIGGER_NAME} + nextTasksExecutionPolicy: + enum: + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH type: string - description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - required: - type: boolean - protoDefPath: + description: Optional. Dictates how next tasks will be executed. + enumDescriptions: + - Default. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + label: type: string + description: Optional. The user created label for a particular trigger. + position: description: >- - If the data type is of type proto or proto array, this field needs - to be populated with the fully qualified proto name. This message, - for example, would be - "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". - name: - description: >- - The name (without prefix) to be displayed in the UI for this - parameter. E.g. if the key is "foo.bar.myName", then the name would - be "myName". - type: string - defaultValue: + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + cloudSchedulerConfig: + description: Optional. Cloud Scheduler Trigger related metadata $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + description: description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - producer: + Optional. User-provided description intended to give additional + business context about the task. type: string - description: + trigger: type: string - description: Optional. The description about the parameter - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - GoogleCloudIntegrationsV1alphaImportTemplateRequest: - properties: - subIntegrations: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - description: Optional. Sub Integration which would be created via templates. - integration: + description: >- + Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub + Sub Trigger" When set will be sent out to monitoring dashabord for + tracking purpose. + triggerNumber: type: string description: >- - Required. Name of the integration where template needs to be - imported. - integrationRegion: - description: Required. The region of the Integration to be created. + Required. A number to uniquely identify each trigger config within + the integration on UI. + errorCatcherId: + description: >- + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task + type: string + triggerType: + enumDescriptions: + - Unknown. + - Trigger by scheduled time. + - Trigger by API call. + - Trigger by Salesforce Channel. + - Trigger by Pub/Sub external. + - SFDC Channel Trigger for CDC. + - Trigger by Cloud Scheduler job. + - Trigger by Connector Event + - Trigger for private workflow type: string + enum: + - TRIGGER_TYPE_UNSPECIFIED + - CRON + - API + - SFDC_CHANNEL + - CLOUD_PUBSUB_EXTERNAL + - SFDC_CDC_CHANNEL + - CLOUD_SCHEDULER + - INTEGRATION_CONNECTOR_TRIGGER + - PRIVATE_TRIGGER + description: Optional. Type of trigger + type: object + description: Configuration detail of a trigger. + EnterpriseCrmEventbusProtoDoubleParameterArray: + id: EnterpriseCrmEventbusProtoDoubleParameterArray type: object - description: Request to Import template - id: GoogleCloudIntegrationsV1alphaImportTemplateRequest - GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: - description: Request for lift Suspension - id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest properties: - suspensionResult: - description: >- - User passed in suspension result and will be used to control - workflow execution branching behavior by setting up corresponnding - edge condition with suspension result. For example, if you want to - lift the suspension, you can pass "Approved", or if you want to - reject the suspension and terminate workfloe execution, you can pass - "Rejected" and terminate the workflow execution with configuring the - edge condition. + doubleValues: + items: + type: number + format: double + type: array + EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: + id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + properties: + objectValue: + format: byte type: string type: object - GoogleCloudIntegrationsV1alphaNextTask: - description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. + GoogleCloudIntegrationsV1alphaSearchTemplatesResponse: + description: Response for a request to search templates + id: GoogleCloudIntegrationsV1alphaSearchTemplatesResponse properties: - displayName: - type: string - description: User-provided label that is attached to this edge in the UI. - taskId: - description: Task number of the next task. - type: string - condition: - type: string - description: >- - Standard filter expression for this task to become an eligible next - task. - taskConfigId: - description: ID of the next task. - type: string - description: - description: >- - User-provided description intended to give additional business - context about the task. + templates: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + type: array + description: List of templates retrieved. + nextPageToken: type: string + description: The token used to retrieve the next page results. type: object - id: GoogleCloudIntegrationsV1alphaNextTask - GoogleCloudIntegrationsV1alphaIntegrationVersion: - id: GoogleCloudIntegrationsV1alphaIntegrationVersion - description: The integration version definition. + EnterpriseCrmEventbusProtoTaskExecutionDetails: properties: - name: - readOnly: true - type: string - description: Output only. Auto-generated primary key. - userLabel: - type: string - description: >- - Optional. A user-defined label that annotates an integration - version. Typically, this is only set when the integration version is - created. - description: - type: string - description: Optional. The integration description. - triggerConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' - description: Optional. Trigger configurations. - updateTime: + taskExecutionState: type: string - description: Output only. Auto-generated. - readOnly: true - format: google-datetime - cloudLoggingDetails: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - description: Optional. Cloud Logging details for the integration version - status: - readOnly: true - deprecated: true + enum: + - UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED + - FATAL + - RETRY_ON_HOLD + - SKIPPED + - CANCELED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED enumDescriptions: - '' - - '' - - '' - - '' - - '' - type: string - enum: - - UNKNOWN - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - description: >- - Output only. Generated by eventbus. User should not set it as an - input. - taskConfigs: + - >- + Task is waiting for its precondition tasks to finish to start the + execution. + - Task is under processing. + - >- + Task execution successfully finished. There's no more change after + this state. + - Task execution failed. There's no more change after this state. + - >- + Task execution failed and cause the whole event execution to fail + immediately. There's no more change after this state. + - Task execution failed and waiting for retry. + - >- + Task execution skipped. This happens when its precondition wasn't + met, or the event execution been canceled before reach to the + task. There's no more changes after this state. + - >- + Task execution canceled when in progress. This happens when event + execution been canceled or any other task fall in fatal state. + - >- + Task is waiting for its dependency tasks' rollback to finish to + start its rollback. + - Task is rolling back. + - >- + Task is rolled back. This is the state we will set regardless of + rollback succeeding or failing. + - >- + Task is a SuspensionTask which has executed once, creating a + pending suspension. + taskAttemptStats: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats type: array + taskNumber: + description: Pointer to the task config it used for execution. + type: string + description: >- + Contains the details of the execution of this task. Next available id: + 11 + id: EnterpriseCrmEventbusProtoTaskExecutionDetails + type: object + GoogleCloudIntegrationsV1alphaSfdcChannel: + description: The SfdcChannel that points to a CDC or Platform Event Channel. + type: object + properties: + description: + type: string + description: The description for this channel + name: description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - createdFromTemplate: - description: >- - Optional. Optional. The resource name of the template from which the - integration is created. + Resource name of the SFDC channel + projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. type: string - createTime: - description: Output only. Auto-generated. + updateTime: type: string - readOnly: true + description: Output only. Time when the channel was last updated format: google-datetime - teardown: - description: >- - Optional. Contains a graph of tasks that will be executed before - putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), - regardless of success or failure, similar to "finally" in code. - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' - state: - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. readOnly: true - description: Output only. User should not set it as an input. - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - type: string - runAsServiceAccount: + isActive: + type: boolean description: >- - Optional. The run-as service account email, if set and auth config - is not configured, that will be used to generate auth token to be - used in Connector task, Rest caller task and Cloud function task. + Indicated if a channel has any active integrations referencing it. + Set to false when the channel is created, and set to true if there + is any integration published with the channel configured in it. + displayName: type: string - integrationConfigParameters: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationConfigParameter - description: >- - Optional. Config Parameters that are expected to be passed to the - integration when an integration is published. This consists of all - the parameters that are expected to provide configuration in the - integration execution. This gives the user the ability to provide - default values, value, add information like connection url, project - based configuration value and also provide data types of each - parameter. - lastModifierEmail: - description: >- - Optional. The last modifier's email address. Generated based on the - End User Credentials/LOAS role of the user making the call. + description: Client level unique name/alias to easily reference a channel. + lastReplayId: type: string - lockHolder: + description: Last sfdc messsage replay id for channel + channelTopic: type: string + description: The Channel topic defined by salesforce once an channel is opened + deleteTime: description: >- - Optional. The edit lock holder's email address. Generated based on - the End User Credentials/LOAS role of the user making the call. - origin: - description: >- - Optional. The origin that indicates where this integration is coming - from. - enum: - - UNSPECIFIED - - UI - - PIPER_V2 - - PIPER_V3 - - APPLICATION_IP_PROVISIONING - - TEST_CASE - deprecated: true + Output only. Time when the channel was deleted. Empty if not + deleted. + format: google-datetime + readOnly: true type: string - enumDescriptions: - - '' - - Workflow is being created via event bus UI. - - >- - User checked in this workflow in Piper as v2 textproto format and - we synced it into spanner. - - >- - User checked in this workflow in piper as v3 textproto format and - we synced it into spanner. - - Workflow is being created via Standalone IP Provisioning - - Workflow is being created via Test Case. - enumDeprecated: - - false - - false - - true - - false - - false - - false - parentTemplateId: - description: >- - Optional. The id of the template which was used to create this - integration_version. + createTime: + readOnly: true type: string - databasePersistencePolicy: - enum: - - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED - - DATABASE_PERSISTENCE_DISABLED - - DATABASE_PERSISTENCE_ASYNC - description: >- - Optional. Flag to disable database persistence for execution data, - including event execution info, execution export info, execution - metadata index and execution param index. + description: Output only. Time when the channel is created + format: google-datetime + id: GoogleCloudIntegrationsV1alphaSfdcChannel + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: + type: object + properties: + appsScriptProject: + description: The name of the Apps Script project to be created. type: string - enumDescriptions: - - Enables persistence for all execution data. - - Disables persistence for all execution data. - - Asynchronously persist all execution data. - snapshotNumber: + authConfigId: type: string description: >- - Optional. An increasing sequence that is set when a new snapshot is - created. The last created snapshot can be identified by - [workflow_name, org_id latest(snapshot_number)]. However, last - created snapshot need not be same as the HEAD. So users should - always use "HEAD" tag to identify the head. - format: int64 - integrationParametersInternal: - description: >- - Optional. Parameters that are expected to be passed to the - integration when an event is triggered. This consists of all the - parameters that are expected in the integration execution. This - gives the user the ability to provide default values, add - information like PII and also provide data types of each parameter. - deprecated: true + The auth config id necessary to fetch the necessary credentials to + create the project for external clients + description: Request for CreateAppsScriptProject rpc call. + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: + description: The request for testing an integration. + type: object + properties: + parameters: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - triggerConfigsInternal: - description: Optional. Trigger configurations. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig - type: array + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Optional. Passed in as parameters to each integration execution. deprecated: true - integrationParameters: + configParameters: + description: Optional. Config parameters used during integration execution. + type: object + additionalProperties: + type: any + description: Properties of the object. + clientId: description: >- - Optional. Parameters that are expected to be passed to the - integration when an event is triggered. This consists of all the - parameters that are expected in the integration execution. This - gives the user the ability to provide default values, add - information like PII and also provide data types of each parameter. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - enableVariableMasking: + Required. This is used to identify the client on whose behalf the + event will be executed. + type: string + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Required. integration config to execute the workflow + inputParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + description: Optional. Input parameters used during integration execution. + deadlineSecondsTime: + description: Optional. custom deadline of the rpc + type: string + format: google-datetime + triggerId: + type: string description: >- - Optional. True if variable masking feature should be turned on for - this version + Required. The trigger id of the integration trigger config. If both + trigger_id and client_id is present, the integration is executed + from the start tasks provided by the matching trigger config + otherwise it is executed from the default start tasks. + testMode: type: boolean - errorCatcherConfigs: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig - type: array description: >- - Optional. Error Catch Task configuration for the integration. It's - optional. - taskConfigsInternal: + Optional. Can be specified in the event request, otherwise false + (default). If true, enables tasks with condition "test_mode = true". + If false, disables tasks with condition "test_mode = true" if global + test mode (set by platform) is also false {@link EventBusConfig}. + id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: + id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + properties: + filterType: + type: string + enumDescriptions: + - '' + - '' + enum: + - DEFAULT_INCLUSIVE + - EXCLUSIVE + enumStrings: + type: array + items: + type: string + description: List of error enums for alerts. + type: object + EnterpriseCrmEventbusProtoAddress: + type: object + description: >- + Email address along with optional name and tokens. These tokens will be + substituted for the variables in the form of [{var_name}], where + var_name could be any string of no more than 32 bytes. + id: EnterpriseCrmEventbusProtoAddress + properties: + name: + type: string + email: + description: Required. + type: string + tokens: items: - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' - description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' type: array + EnterpriseCrmEventbusProtoAttributes: + id: EnterpriseCrmEventbusProtoAttributes type: object - GoogleCloudIntegrationsV1alphaAccessToken: - id: GoogleCloudIntegrationsV1alphaAccessToken properties: - refreshToken: - type: string - description: >- - If the access token will expire, use the refresh token to obtain - another access token. - accessToken: - type: string + readOnly: + description: Used to indicate if the ParameterEntry is a read only field or not. + type: boolean + dataType: + enum: + - DATA_TYPE_UNSPECIFIED + - EMAIL + - URL + - CURRENCY + - TIMESTAMP + - DOMAIN_NAME description: >- - The access token encapsulating the security identity of a process or - thread. - refreshTokenExpireTime: + Things like URL, Email, Currency, Timestamp (rather than string, + int64...) type: string - format: google-datetime - description: The approximate time until the refresh token retrieved is valid. - accessTokenExpireTime: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - >- + Domain is a web url string with one top-level private domain and a + suffix (for example: google.com, walmart.com) + searchable: + enum: + - UNSPECIFIED + - 'YES' + - 'NO' type: string - format: google-datetime + enumDescriptions: + - '' + - >- + If yes, the parameter key and value will be full-text indexed. In + a proto, this value will propagate to all children whose + searchable is unspecified. + - >- + If no, the parameter key and value will not be full-text indexed. + In a proto, this value will propagate to all children whose + searchable is unspecified. + isRequired: description: >- - Required. The approximate time until the access token retrieved is - valid. - tokenType: - type: string + Required for event execution. The validation will be done by the + event bus when the event is triggered. + type: boolean + masked: + description: True if this workflow parameter should be masked in the logs + type: boolean + isSearchable: + type: boolean + deprecated: true description: >- - Only support "bearer" token in v1 as bearer token is the predominant - type used with OAuth 2.0. - type: object - description: >- - The access token represents the authorization of a specific application - to access specific parts of a user’s data. - EnterpriseCrmEventbusProtoStringArray: - properties: - values: + Used to indicate if a ParameterEntry should be converted to + ParamIndexes for ST-Spanner full-text search. DEPRECATED: use + searchable. + logSettings: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' + description: See + taskVisibility: + description: List of tasks that can view this property, if empty then all. items: type: string type: array - type: object - id: EnterpriseCrmEventbusProtoStringArray - GoogleCloudIntegrationsV1alphaCoordinate: - type: object - description: Configuration detail of coordinate, it used for UI + defaultValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + description: Used to define defaults. + description: >- + Attributes are additional options that can be associated with each event + property. For more information, see + GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: + id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest properties: - 'y': - format: int32 - description: Required. Y axis of the coordinate - type: integer - x: - description: Required. X axis of the coordinate - type: integer - format: int32 - id: GoogleCloudIntegrationsV1alphaCoordinate - GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: - id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + suspension: + description: >- + Suspension, containing the event_execution_info_id, task_id, and + state to set on the corresponding suspension record. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' + type: object + description: Request for [Suspensions.ResolveSuspensions]. + EnterpriseCrmEventbusProtoSuccessPolicy: description: >- - For client credentials grant, the client sends a POST request with - grant_type as 'client_credentials' to the authorization server. The - authorization server will respond with a JSON object containing the - access token. + Policy that dictates the behavior for the task after it completes + successfully. type: object properties: - clientId: - description: The client's ID. - type: string - clientSecret: - description: The client's secret. + finalState: type: string - requestType: + enum: + - UNSPECIFIED + - SUCCEEDED + - SUSPENDED enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. + - '' - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. - description: Represent how to pass parameters to fetch access token - type: string - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER - tokenEndpoint: - type: string + The default behavior, where successful tasks will be marked as + SUCCEEDED. + - >- + Sets the state to SUSPENDED after executing. This is required for + SuspensionTask; event execution will continue once the user calls + ResolveSuspensions with the event_execution_info_id and the task + number. description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. - accessToken: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - description: Access token fetched from the authorization server. - tokenParams: - description: Token parameters for the auth request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - scope: - description: A space-delimited list of requested scope permissions. - type: string - EnterpriseCrmEventbusProtoEventExecutionDetails: + State to which the execution snapshot status will be set if the task + succeeds. + id: EnterpriseCrmEventbusProtoSuccessPolicy + GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: + id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies properties: - nextExecutionTime: - format: int64 - type: string + defaultFailurePolicy: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. - eventAttemptStats: - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - type: array - cancelReason: - type: string + The default failure policy to be applied if no conditional failure + policy matches. + failurePolicies: description: >- - If the execution is manually canceled, this field will contain the - reason for cancellation. - eventExecutionSnapshot: + The list of failure policies that will be applied to the task in + order. type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot - logFilePath: - type: string - description: The log file path (aka. cns address) for this event. - networkAddress: - type: string + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + description: Conditional task failur retry strategies + type: object + GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: + type: object + description: The request for executing an integration. + properties: + parameterEntries: + type: array description: >- - The network address (aka. bns address) that indicates where the - event executor is running. - eventExecutionState: - type: string - enumDescriptions: - - '' - - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. - - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. - - >- - Event execution canceled by user. There's no more change after - this state. - - Event execution failed and waiting for retry. - - Event execution suspended and waiting for manual intervention. - enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED - ryeLockUnheldCount: - format: int32 + Optional. Parameters are a part of Event and can be used to + communicate between different tasks that are part of the same + integration execution. + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + triggerId: + type: string description: >- - Used internally and shouldn't be exposed to users. A counter for the - cron job to record how many times this event is in in_process state - but don't have a lock consecutively/ - type: integer - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution + Required. Matched against all {@link TriggerConfig}s across all + integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The + trigger_id is in the format of `api_trigger/TRIGGER_NAME`. + executionId: + description: Optional. The id of the ON_HOLD execution to be resumed. type: string - format: int64 - eventRetriesFromBeginningCount: - type: integer - format: int32 + doNotPropagateError: + type: boolean description: >- - Indicates the number of times the execution has restarted from the - beginning. - description: >- - Contains the details of the execution info of this event: this includes - the tasks execution details plus the event execution statistics. Next - available id: 12 - type: object - id: EnterpriseCrmEventbusProtoEventExecutionDetails - EnterpriseCrmEventbusProtoExternalTraffic: + Optional. Flag to determine how to should propagate errors. If this + flag is set to be true, it will not throw an exception. Instead, it + will return a {@link ExecuteIntegrationsResponse} with an execution + id and error messages as PostWithTriggerIdExecutionException in + {@link EventParameters}. The flag is set to be false by default. + inputParameters: + description: Optional. Input parameters used by integration execution. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + requestId: + type: string + description: >- + Optional. This is used to de-dup incoming request: if the duplicate + request was detected, the response from the previous execution is + returned. + parameters: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + deprecated: true + description: >- + Optional. Passed in as parameters to each integration execution. + Redacted + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + GoogleCloudIntegrationsV1alphaValueType: properties: - location: + intArray: + description: Integer Array. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' + doubleArray: + description: Double Number Array. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray + intValue: type: string - description: Location for the user's request. - source: + format: int64 + description: Integer. + stringArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray + description: String Array. + doubleValue: + format: double + type: number + description: Double Number. + stringValue: + description: String. type: string + jsonValue: + type: string + description: Json. + booleanArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray + description: Boolean Array. + booleanValue: + type: boolean + description: Boolean. + type: object + id: GoogleCloudIntegrationsV1alphaValueType + description: The type of the parameter. + EnterpriseCrmEventbusProtoIntParameterArray: + properties: + intValues: + type: array + items: + format: int64 + type: string + id: EnterpriseCrmEventbusProtoIntParameterArray + type: object + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + type: object + properties: {} + description: Response for PublishIntegrationVersion. + GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: + description: Response for TakeoverEditLock. + properties: + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Version after the lock is acquired by the new user. + type: object + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + GoogleCloudIntegrationsV1alphaCredential: + id: GoogleCloudIntegrationsV1alphaCredential + properties: + usernameAndPassword: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword + description: Username and password credential + oidcToken: + description: Google OIDC ID Token + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' + oauth2ClientCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials + oauth2ResourceOwnerCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + description: OAuth2 resource owner credentials + credentialType: enum: - - SOURCE_UNSPECIFIED - - APIGEE - - SECURITY + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN enumDescriptions: - - '' - - '' - - '' - gcpProjectId: - type: string - description: User’s GCP project id the traffic is referring to. - gcpProjectNumber: + - Unspecified credential type + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token type: string - description: User’s GCP project number the traffic is referring to. - retryRequestForQuota: - description: Enqueue the execution request due to quota issue - type: boolean - enableInternalIp: + description: Credential type associated with auth config. + oauth2AuthorizationCode: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode description: >- - Indicates the client enables internal IP feature, this is applicable - for internal clients only. - type: boolean + The api_key and oauth2_implicit are not covered in v1 and will be + picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 + authorization code credential + serviceAccountCredentials: + description: Service account credential + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials + jwt: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' + description: JWT credential + authToken: + description: Auth token credential + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' type: object - id: EnterpriseCrmEventbusProtoExternalTraffic - description: Represents external traffic type and id. - GoogleCloudIntegrationsV1alphaGenerateTokenResponse: - description: Returns success or error message - id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse + description: Defines parameters for a single, canonical credential. + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + description: Request for PublishIntegrationVersion. properties: - message: - type: string - description: The message that notifies the user if the request succeeded or not. + configParameters: + additionalProperties: + description: Properties of the object. + type: any + type: object + description: Optional. Config parameters used during integration execution. type: object - EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + EnterpriseCrmEventbusProtoTaskMetadata: + description: >- + TaskMetadata are attributes that are associated to every common Task we + have. type: object properties: - protoValues: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - GoogleCloudConnectorsV1Destination: - properties: - serviceAttachment: - deprecated: true + activeTaskName: + description: >- + The new task name to replace the current task if it is deprecated. + Otherwise, it is the same as the current task name. + type: string + externalDocHtml: + type: string + description: External-facing documention embedded in the RHP for this task. + isDeprecated: + type: boolean + description: The deprecation status of the current task. Default value is false; + externalDocMarkdown: type: string + description: 'DEPRECATED: Use external_doc_html.' + tags: + items: + type: string description: >- - PSC service attachments. Format: - projects/*/regions/*/serviceAttachments/* - port: - format: int32 + A set of tags that pertain to a particular task. This can be used to + improve the searchability of tasks with several names ("REST Caller" + vs. "Call REST Endpoint") or to help users find tasks based on + related words. + type: array + externalDocLink: + type: string + description: Doc link for external-facing documentation (separate from g3doc). + admins: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' + type: array + externalCategorySequence: type: integer + format: int32 description: >- - The port is the target port number that is accepted by the - destination. - host: + Sequence with which the task in specific category to be displayed in + task discovery panel for external users. + iconLink: + description: >- + URL to gstatic image icon for this task. This icon shows up on the + task list panel along with the task name in the Workflow Editor + screen. Use the 24p, 2x, gray color icon image format. type: string - description: For publicly routable host. - id: GoogleCloudConnectorsV1Destination - type: object - EnterpriseCrmEventbusProtoDoubleArrayFunction: - id: EnterpriseCrmEventbusProtoDoubleArrayFunction - properties: - functionName: + docMarkdown: + type: string + description: Snippet of markdown documentation to embed in the RHP for this task. + descriptiveName: + description: >- + The string name to show on the task list on the Workflow editor + screen. This should be a very short, one to two words name for the + task. (e.g. "Send Mail") + type: string + system: + enum: + - UNSPECIFIED_SYSTEM + - GENERIC + - BUGANIZER + - SALESFORCE + - CLOUD_SQL + - PLX + - SHEETS + - GOOGLE_GROUPS + - EMAIL + - SPANNER + - DATA_BRIDGE type: string enumDescriptions: - '' @@ -6613,187 +6065,324 @@ components: - '' - '' - '' + standaloneExternalDocHtml: + description: >- + External-facing documention for standalone IP in pantheon embedded + in the RHP for this task. Non null only if different from + external_doc_html + type: string + defaultSpec: + description: >- + Contains the initial configuration of the task with default values + set. For now, The string should be compatible to an ASCII-proto + format. + type: string + name: + type: string + description: >- + The actual class name or the annotated name of the task. Task Author + should initialize this field with value from the getName() method of + the Task class. + g3DocLink: + description: URL to the associated G3 Doc for the task if available + type: string + category: + enum: + - UNSPECIFIED_CATEGORY + - CUSTOM + - FLOW_CONTROL + - DATA_MANIPULATION + - SCRIPTING + - CONNECTOR + - HIDDEN + - CLOUD_SYSTEMS + - CUSTOM_TASK_TEMPLATE + - TASK_RECOMMENDATIONS + type: string + enumDescriptions: + - '' + - '' + - '' - '' - '' - '' + - Internal IP tasks that should not be available in the UI. + - Tasks that are relevant to cloud systems teams and typically + - Task entities that derive from a custom task template. + - Category to show task recommendations + externalCategory: + enumDescriptions: - '' - '' - '' + - HTTP tasks, e.g. rest api call task + - Integration services, e.g. connector task + - Customer ations, e.g. email task + - Flow control, e.g. while loop task + - Workspace tasks, e.g. list drive task + - Security, e.g. kms related tasks + - Database operation tasks, e.g. read firestore info tasks + - Analytics tasks, e.g. dataflow creattion tasks + - BYOC tasks + - BYOT tasks + - AI related tasks. + - Data manipulation related tasks, e.g. data mapping task enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + - UNSPECIFIED_EXTERNAL_CATEGORY + - CORE + - CONNECTORS + - EXTERNAL_HTTP + - EXTERNAL_INTEGRATION_SERVICES + - EXTERNAL_CUSTOMER_ACTIONS + - EXTERNAL_FLOW_CONTROL + - EXTERNAL_WORKSPACE + - EXTERNAL_SECURITY + - EXTERNAL_DATABASES + - EXTERNAL_ANALYTICS + - EXTERNAL_BYOC + - EXTERNAL_BYOT + - EXTERNAL_ARTIFICIAL_INTELIGENCE + - EXTERNAL_DATA_MANIPULATION + type: string + codeSearchLink: + type: string + description: The Code Search link to the Task Java file. + defaultJsonValidationOption: + type: string + enum: + - UNSPECIFIED_JSON_VALIDATION_OPTION + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION + description: >- + Controls whether JSON workflow parameters are validated against + provided schemas before and/or after this task's execution. + enumDescriptions: + - >- + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. + - >- + Validate all potential input JSON parameters against schemas + specified in WorkflowParameters. + - >- + Validate all potential output JSON parameters against schemas + specified in WorkflowParameters. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. + status: + enum: + - UNSPECIFIED_STATUS + - DEFAULT_INACTIVE + - ACTIVE + description: >- + Allows author to indicate if the task is ready to use or not. If not + set, then it will default to INACTIVE. + enumDescriptions: + - >- + Default value. Actual Task Status should always be set to either + INACTIVE or ACTIVE. If none is specified at runtime, it will be + set to INACTIVE. + - Still in-progress or incomplete, and not intended for use. + - Available for use. + type: string + description: + type: string + description: In a few sentences, describe the purpose and usage of the task. + id: EnterpriseCrmEventbusProtoTaskMetadata + EnterpriseCrmEventbusProtoStringArray: + id: EnterpriseCrmEventbusProtoStringArray type: object - GoogleCloudIntegrationsV1alphaListIntegrationsResponse: - id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse - description: Response for ListIntegrations. properties: - nextPageToken: - type: string - description: The next page token for the response. - integrations: + values: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' + type: string type: array - description: The integrations which match the request. - type: object - EnterpriseCrmEventbusProtoSuspensionConfig: + GoogleCloudConnectorsV1EventingRuntimeData: properties: - suspensionExpiration: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' + eventsListenerPscSa: + type: string + readOnly: true description: >- - Indicates the next steps when no external actions happen on the - suspension. - customMessage: + Output only. Events listener PSC Service attachment. The value will + be populated after provisioning the events listener with private + connectivity enabled. + status: + description: Output only. Current status of eventing. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' + webhookData: + description: Output only. Webhook data. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + eventsListenerEndpoint: description: >- - Optional information to provide recipients of the suspension in - addition to the resolution URL, typically containing relevant - parameter values from the originating workflow. + Output only. Events listener endpoint. The value will populated + after provisioning the events listener. + readOnly: true type: string - notifications: + type: object + description: >- + Eventing runtime data has the details related to eventing managed by the + system. + id: GoogleCloudConnectorsV1EventingRuntimeData + GoogleCloudIntegrationsV1alphaTemplate: + type: object + id: GoogleCloudIntegrationsV1alphaTemplate + description: Defines the template for Application Integration + properties: + tags: + description: >- + Required. Tags which are used to identify templates. These tags + could be for business use case, connectors etc. + items: + type: string + type: array + sharedWith: + description: >- + Required. Resource names with which the template is shared for + example ProjectNumber/Ord id type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' - whoMayResolve: + type: string + components: + description: >- + Optional. Components being used in the template. This could be used + to categorize and filter. + type: array items: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions - type: array - description: Identities able to resolve this suspension. - id: EnterpriseCrmEventbusProtoSuspensionConfig - type: object - EnterpriseCrmEventbusProtoExecutionTraceInfo: - description: >- - Message that helps aggregate all sub-executions triggered by one - execution and keeps track of child-parent relationships. - type: object - properties: - parentEventExecutionInfoId: - description: >- - Parent event execution info id that triggers the current execution - through SubWorkflowExecutorTask. + #/components/schemas/GoogleCloudIntegrationsV1alphaTemplateComponent + lastUsedTime: type: string - traceId: + description: Optional. Time the template was last used. + format: google-datetime + createTime: + description: Output only. Auto-generated. type: string - description: Used to aggregate ExecutionTraceInfo. - id: EnterpriseCrmEventbusProtoExecutionTraceInfo - EnterpriseCrmEventbusProtoTaskUiModuleConfig: - id: EnterpriseCrmEventbusProtoTaskUiModuleConfig - properties: - moduleId: - enumDescriptions: - - Default - - Supports editing label of a task config. - - Supports editing error handling settings such as retry strategy. - - >- - Supports adding, removing and editing task parameter values in a - table with little assistance or restriction. - - >- - Supports editing values of declared input parameters of a task. - Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE. - - Supports editing preconditions of a task config. - - >- - Supports adding, editing, and deleting the scripts associated with - a script task, as well as modifying the input/output parameters. - - >- - Supports editing task parameters associated with an RPC/stubby - task. - - >- - Contains readonly task information, including input/output type - info. - - Configures a SuspensionTask. - - Configures a GenericStubbyTypedTask. - - Configures a SubWorkflowExecutorTask. - - Supports navigating to Apps Script editor - - Configures a SubWorkflowForEachLoopTask. - - Configures a FieldMappingTask. - - Contains embedded in-product documentation for a task. - - UI widget for the rest caller task. - - Configures a SubWorkflowScatterGatherTask. - - Configures a CloudSql Task. - - Configure a GenericConnectorTask. + readOnly: true + format: google-datetime + docLink: + description: Optional. Link to template documentation. type: string - description: ID of the config module. - enum: - - UNSPECIFIED_TASK_MODULE - - LABEL - - ERROR_HANDLING - - TASK_PARAM_TABLE - - TASK_PARAM_FORM - - PRECONDITION - - SCRIPT_EDITOR - - RPC - - TASK_SUMMARY - - SUSPENSION - - RPC_TYPED - - SUB_WORKFLOW - - APPS_SCRIPT_NAVIGATOR - - SUB_WORKFLOW_FOR_EACH_LOOP - - FIELD_MAPPING - - README - - REST_CALLER - - SUB_WORKFLOW_SCATTER_GATHER - - CLOUD_SQL - - GENERIC_CONNECTOR_TASK - description: Task author would use this type to configure a config module. - type: object - EnterpriseCrmEventbusProtoErrorDetail: - id: EnterpriseCrmEventbusProtoErrorDetail - type: object - properties: - errorMessage: + updateTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Auto-generated + displayName: + type: string + description: Required. The name of the template + description: description: >- - The full text of the error message, including any parameters that - were thrown along with the exception. + Optional. Description of the template. The length should not be more + than 255 characters + type: string + usageInfo: type: string - errorCode: - description: The associated error-code, which can be a common or internal code. - $ref: '#/components/schemas/CrmlogErrorCode' - taskNumber: - type: integer - format: int32 description: >- - The task try-number, in which, the error occurred. If zero, the - error happened at the event level. - severity: + Optional. Information on how to use the template. This should + contain detailed information about usage of the template. + categories: + type: array + description: >- + Required. Categories associated with the Template. The categories + listed below will be utilized for the Template listing. + items: + type: string + enumDescriptions: + - Category is unspecified + - AI_MACHINE_LEARNING + - BUSINESS_INTELLIGENCE + - COLLABORATION + - CUSTOMER_SERVICE + - DATAABASES + - DEVOPS_IT + - CONTENT_AND_FILES + - FINANCE_AND_ACCOUNTING + - HUMAN_RESOURCES + - OPERATIONS + - PRODUCT_PROJECT_MANAGEMENT + - PRODUCTIVITY + - SALES_AND_MARKETING + - UNIVERSAL_CONNECTORS + - UTILITY + - OTHERS + enum: + - CATEGORY_UNSPECIFIED + - AI_MACHINE_LEARNING + - BUSINESS_INTELLIGENCE + - COLLABORATION + - CUSTOMER_SERVICE + - DATABASES + - DEVOPS_IT + - CONTENT_AND_FILES + - FINANCE_AND_ACCOUNTING + - HUMAN_RESOURCES + - OPERATIONS + - PRODUCT_PROJECT_MANAGEMENT + - PRODUCTIVITY + - SALES_AND_MARKETING + - UNIVERSAL_CONNECTORS + - UTILITY + - OTHERS + templateBundle: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplateBundle' + description: >- + Required. Bundle which is part of the templates. The template + entities in the bundle would be converted to an actual entity. + visibility: type: string - description: 'The severity of the error: ERROR|WARN|INFO.' + description: Required. Visibility of the template. enum: - - SEVERITY_UNSPECIFIED - - ERROR - - WARN - - INFO + - VISIBILITY_UNSPECIFIED + - PRIVATE + - SHARED + - PUBLIC enumDescriptions: - - '' - - '' - - '' - - '' - description: An error, warning, or information message associated with a workflow. + - Visibility is unspecified + - Visibility is private + - Visibility is shared + - Visibility is public + author: + type: string + description: Optional. Creator of the template. + usageCount: + format: int64 + description: Optional. Number of template usages. + type: string + name: + type: string + description: Identifier. Resource name of the template. EnterpriseCrmEventbusProtoSuspensionResolutionInfo: type: object id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo properties: - product: + cloudKmsConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' + description: KMS info, used by cmek/gmek integration + eventExecutionInfoId: + description: Required. ID of the associated execution. + type: string + wrappedDek: + description: Wrapped dek + format: byte + type: string + lastModifiedTimestamp: type: string + description: Auto-generated. + format: google-datetime + taskNumber: + type: string + description: Required. Task number of the associated SuspensionTask. + product: enum: - UNSPECIFIED_PRODUCT - IP - APIGEE - SECURITY + type: string description: >- Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default. @@ -6802,488 +6391,556 @@ components: - '' - '' - '' - eventExecutionInfoId: - type: string - description: Required. ID of the associated execution. - wrappedDek: - format: byte + clientId: + description: The event data user sends as request. type: string - description: Wrapped dek + externalTraffic: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' + description: The origin of the suspension for periodic notifications. status: + enum: + - PENDING_UNSPECIFIED + - REJECTED + - LIFTED + - CANCELED type: string enumDescriptions: - '' - '' - '' - '' - enum: - - PENDING_UNSPECIFIED - - REJECTED - - LIFTED - - CANCELED + audit: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit suspensionId: - description: Primary key for the SuspensionResolutionInfoTable. type: string - externalTraffic: - description: The origin of the suspension for periodic notifications. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' - cloudKmsConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' - description: KMS info, used by cmek/gmek integration - clientId: + description: Primary key for the SuspensionResolutionInfoTable. + createdTimestamp: + description: Auto-generated. type: string - description: The event data user sends as request. + format: google-datetime workflowName: - type: string description: Required. The name of the originating workflow. - lastModifiedTimestamp: - format: google-datetime - description: Auto-generated. type: string - createdTimestamp: - format: google-datetime - description: Auto-generated. + encryptedSuspensionResolutionInfo: + description: Encrypted SuspensionResolutionInfo type: string + format: byte suspensionConfig: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - audit: + EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + type: object + properties: + diffParams: + description: The parameters in Event object that differs from last snapshot. $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - encryptedSuspensionResolutionInfo: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + taskExecutionDetails: + description: All of the task execution details at the given point of time. + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + type: array + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + eventExecutionInfoId: type: string - format: byte - description: Encrypted SuspensionResolutionInfo - taskNumber: - description: Required. Task number of the associated SuspensionTask. + description: Points to the event execution info this snapshot belongs to. + eventExecutionSnapshotId: type: string - GoogleCloudConnectorsV1ResourceRequests: - id: GoogleCloudConnectorsV1ResourceRequests - description: Resource requests defined for connection pods of a given connector type. - properties: - cpu: + description: >- + Auto-generated. Used as primary key for EventExecutionSnapshots + table. + eventParams: + description: The parameters in Event object. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + checkpointTaskNumber: + description: >- + Indicates "right after which checkpoint task's execution" this + snapshot is taken. type: string - readOnly: true - description: Output only. CPU request. - memory: - description: Output only. Memory request. + conditionResults: + description: All of the computed conditions that been calculated. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + type: array + snapshotTime: + format: int64 + description: Indicates when this snapshot is taken. type: string - readOnly: true - type: object - EnterpriseCrmEventbusProtoTaskUiConfig: - id: EnterpriseCrmEventbusProtoTaskUiConfig - description: >- - Task authors would use this type to configure the UI for a particular - task by specifying what UI config modules should be included to compose - the UI. Learn more about config module framework: - type: object + taskName: + deprecated: true + type: string + description: The task name associated with this snapshot. Could be empty. + EnterpriseCrmEventbusProtoProtoParameterArray: properties: - taskUiModuleConfigs: - description: Configurations of included config modules. + protoValues: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: array - GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: - id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + type: object + id: EnterpriseCrmEventbusProtoProtoParameterArray + GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails: + description: Sub Integration which would be created via templates. + id: GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails type: object properties: - cloudKmsConfig: + integration: description: >- - Required. REQUIRED: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - description: Request for the SwitchEncryption rpc - EnterpriseCrmEventbusProtoScatterResponse: - properties: - errorMsg: + Required. Name of the sub integration which would be created via + templates. + type: string + integrationDescription: type: string - description: The error message of the failure if applicable. - executionIds: - type: array - items: - type: string - description: The execution ids of each Subworkflow fired by this scatter. - isSuccessful: - type: boolean - description: >- - If execution is sync, this is true if the execution passed and false - if it failed. If the execution is async, this is true if the WF was - fired off successfully, and false if it failed to execute. The - success or failure of the subworkflows executed are not captured. - responseParams: - type: array description: >- - A list of all the response parameters in the aggregtorMap stored - with the remapped key. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' - scatterElement: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: The element that was scattered for this execution. + Optional. Description of the sub integration which would be created + via templates. + GoogleCloudConnectorsV1Destination: type: object - id: EnterpriseCrmEventbusProtoScatterResponse - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + properties: + port: + format: int32 + type: integer + description: >- + The port is the target port number that is accepted by the + destination. + serviceAttachment: + description: >- + PSC service attachments. Format: + projects/*/regions/*/serviceAttachments/* + deprecated: true + type: string + host: + description: For publicly routable host. + type: string + id: GoogleCloudConnectorsV1Destination + EnterpriseCrmFrontendsEventbusProtoParameterValueType: + description: 'To support various types of parameter values. Next available id: 14' + id: EnterpriseCrmFrontendsEventbusProtoParameterValueType type: object - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo properties: - replayReason: + stringValue: type: string - description: reason for replay - replayedExecutionInfoIds: - items: - type: string - description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. - type: array - originalExecutionInfoId: + doubleValue: + type: number + format: double + protoValue: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + stringArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray + booleanValue: + type: boolean + intArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray + jsonValue: type: string - description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship - GoogleCloudIntegrationsV1alphaServiceAccountCredentials: + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + doubleArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + booleanArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + protoArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + intValue: + type: string + format: int64 + EnterpriseCrmEventbusProtoCustomSuspensionRequest: properties: - serviceAccount: + postToQueueWithTriggerIdRequest: + $ref: >- + #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest + description: Request to fire an event containing the SuspensionInfo message. + suspensionInfoEventParameterKey: description: >- - Name of the service account that has the permission to make the - request. - type: string - scope: + In the fired event, set the SuspensionInfo message as the value for + this key. type: string - description: A space-delimited list of requested scope permissions. + id: EnterpriseCrmEventbusProtoCustomSuspensionRequest + type: object + EnterpriseCrmEventbusProtoEventExecutionDetails: type: object description: >- - Represents the service account which can be used to generate access - token for authenticating the service call. - id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials - EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + Contains the details of the execution info of this event: this includes + the tasks execution details plus the event execution statistics. Next + available id: 12 properties: - doubleValues: + nextExecutionTime: + format: int64 + description: >- + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. + type: string + eventExecutionSnapshot: items: - format: double - type: number + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot type: array - type: object - EnterpriseCrmEventbusProtoStringParameterArray: - id: EnterpriseCrmEventbusProtoStringParameterArray - type: object - properties: - stringValues: + eventAttemptStats: items: - type: string + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats type: array - GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: - type: object - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - properties: - alertThreshold: + logFilePath: + type: string + description: The log file path (aka. cns address) for this event. + cancelReason: + type: string description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. + If the execution is manually canceled, this field will contain the + reason for cancellation. + ryeLockUnheldCount: + description: >- + Used internally and shouldn't be exposed to users. A counter for the + cron job to record how many times this event is in in_process state + but don't have a lock consecutively/ type: integer format: int32 - metricType: + eventExecutionState: enumDescriptions: + - '' - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors for the enclosing - integration. - - >- - Specifies alerting on the rate of warnings for the enclosing - integration. Warnings use the same enum values as errors. - - >- - Specifies alerting on the rate of errors for any task in the - enclosing integration. - - >- - Specifies alerting on the rate of warnings for any task in the - enclosing integration. - - >- - Specifies alerting on the rate of executions over all tasks in the - enclosing integration. - - >- - Specifies alerting on the number of events executed in the given - aggregation_period. - - >- - Specifies alerting on the average duration of executions for this - integration. - - >- - Specifies alerting on the duration value of a particular - percentile of integration executions. E.g. If 10% or more of the - integration executions have durations above 5 seconds, alert. + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. - >- - Specifies alerting on the average duration of any task in the - enclosing integration, + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. - >- - Specifies alerting on the duration value of a particular - percentile of any task executions within the enclosing - integration. E.g. If 10% or more of the task executions in the - integration have durations above 5 seconds, alert. - description: The type of metric. - enum: - - METRIC_TYPE_UNSPECIFIED - - EVENT_ERROR_RATE - - EVENT_WARNING_RATE - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - EVENT_RATE - - EVENT_AVERAGE_DURATION - - EVENT_PERCENTILE_DURATION - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - type: string - displayName: - description: >- - Name of the alert. This will be displayed in the alert subject. If - set, this name should be unique within the scope of the integration. - type: string - aggregationPeriod: - description: >- - The period over which the metric value should be aggregated and - evaluated. Format is , where integer should be a positive integer - and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, - day, week). For an EXPECTED_MIN threshold, this aggregation_period - must be lesser than 24 hours. + Event execution canceled by user. There's no more change after + this state. + - Event execution failed and waiting for retry. + - Event execution suspended and waiting for manual intervention. type: string - thresholdValue: - description: >- - The metric value, above or below which the alert should be - triggered. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue - thresholdType: enum: - - THRESHOLD_TYPE_UNSPECIFIED - - EXPECTED_MIN - - EXPECTED_MAX - enumDescriptions: - - Default. - - >- - Note that this field will only trigger alerts if the integration - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. Min value threshold. - - Max value threshold. - description: >- - The threshold type, whether lower(expected_min) or - upper(expected_max), for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. + - UNSPECIFIED + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED + eventExecutionSnapshotsSize: + format: int64 type: string - disableAlert: - type: boolean + description: Total size of all event_execution_snapshots for an execution + eventRetriesFromBeginningCount: + type: integer + format: int32 description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this integration alert. - durationThreshold: - format: google-duration + Indicates the number of times the execution has restarted from the + beginning. + networkAddress: description: >- - Should be specified only for *AVERAGE_DURATION and - *PERCENTILE_DURATION metrics. This member should be used to specify - what duration value the metrics should exceed for the alert to - trigger. + The network address (aka. bns address) that indicates where the + event executor is running. type: string - onlyFinalAttempt: - type: boolean - description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. + id: EnterpriseCrmEventbusProtoEventExecutionDetails + GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. - GoogleCloudIntegrationsV1alphaSuspensionAudit: - id: GoogleCloudIntegrationsV1alphaSuspensionAudit - description: Contains when and by whom the suspension was resolved. - type: object + The threshold value of the metric, above or below which the alert should + be triggered. See EventAlertConfig or TaskAlertConfig for the different + alert metric types in each case. For the *RATE metrics, one or both of + these fields may be set. Zero is the default value and can be left at + that. For *PERCENTILE_DURATION metrics, one or both of these fields may + be set, and also, the duration threshold value should be specified in + the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, + these fields should not be set at all. A different member, + threshold_duration_ms, must be set in the EventAlertConfig or the + TaskAlertConfig. properties: - resolver: - type: string - description: Email address of the person who resolved this suspension. - resolveTime: - description: Time at which this suspension was resolved. + absolute: + format: int64 type: string - format: google-datetime - GoogleCloudIntegrationsV1alphaImportTemplateResponse: - id: GoogleCloudIntegrationsV1alphaImportTemplateResponse - description: Response for import template + description: Absolute value threshold. + percentage: + format: int32 + description: Percentage threshold. + type: integer + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue type: object - properties: - subIntegrationVersions: - type: array - description: Sub integration versions which are imported. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: IntegrationVersion after the import. - EnterpriseCrmEventbusProtoFieldMappingConfig: - id: EnterpriseCrmEventbusProtoFieldMappingConfig - properties: - mappedFields: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' + GoogleCloudConnectorsV1ConnectorVersionInfraConfig: + id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig description: >- - Field Mapping Config to map multiple output fields values from input - fields values. - type: object - GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: + This cofiguration provides infra configs like rate limit threshold which + need to be configurable for every connector version type: object - description: Conditional task failur retry strategies properties: - failurePolicies: + deploymentModelMigrationState: + type: string + enumDescriptions: + - Deployment model migration state is not specified. + - Deployment model migration is in progress. + - Deployment model migration is completed. + - Deployment model migration rolledback. + - Deployment model migration rollback in progress. + readOnly: true + description: Output only. Status of the deployment model migration. + enum: + - DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED + - IN_PROGRESS + - COMPLETED + - ROLLEDBACK + - ROLLBACK_IN_PROGRESS + resourceRequests: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' + description: Output only. System resource requests. + readOnly: true + resourceLimits: + description: Output only. System resource limits. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' + deploymentModel: + type: string + enumDescriptions: + - Deployment model is not specified. + - Default model gke mst. + - Cloud run mst. + enum: + - DEPLOYMENT_MODEL_UNSPECIFIED + - GKE_MST + - CLOUD_RUN_MST + description: Optional. Indicates whether connector is deployed on GKE/CloudRun + maxInstanceRequestConcurrency: + format: int32 + type: integer + readOnly: true + description: Output only. Max instance request concurrency. + hpaConfig: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' + description: Output only. HPA autoscaling config. + sharedDeployment: + description: Output only. The name of shared connector deployment. + readOnly: true + type: string + ratelimitThreshold: + type: string + description: >- + Output only. Max QPS supported by the connector version before + throttling of requests. + format: int64 + readOnly: true + internalclientRatelimitThreshold: + readOnly: true description: >- - The list of failure policies that will be applied to the task in - order. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - type: array - defaultFailurePolicy: + Output only. Max QPS supported for internal requests originating + from Connd. + format: int64 + type: string + connectionRatelimitWindowSeconds: + readOnly: true description: >- - The default failure policy to be applied if no conditional failure - policy matches. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies - GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: - description: Request for UnpublishIntegrationVersion. - type: object - id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest - properties: {} - GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: + Output only. The window used for ratelimiting runtime requests to + connections. + type: string + format: int64 + GoogleCloudConnectorsV1BillingConfig: + description: Billing config for the connection. type: object - description: The response for executing an integration. - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + id: GoogleCloudConnectorsV1BillingConfig properties: - executionInfoIds: - description: The execution info id for the executed integrations. - type: array - items: - type: string - EnterpriseCrmEventbusProtoSuspensionAuthPermissions: - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions + billingCategory: + description: Output only. Billing category for the connector. + enumDescriptions: + - Billing category is not specified. + - GCP/Technical connector. + - Non-GCP connector. + enum: + - BILLING_CATEGORY_UNSPECIFIED + - GCP_AND_TECHNICAL_CONNECTOR + - NON_GCP_CONNECTOR + type: string + readOnly: true + GoogleCloudIntegrationsV1alphaDownloadTemplateResponse: type: object properties: - googleGroup: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - loasRole: - type: string - mdbGroup: + content: + description: String representation of the template. type: string - gaiaIdentity: - description: Represents a Gaia identity for a person or service account. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - description: LINT.IfChange - GoogleCloudIntegrationsV1alphaAuthToken: - id: GoogleCloudIntegrationsV1alphaAuthToken + description: Response for DownloadTemplate. + id: GoogleCloudIntegrationsV1alphaDownloadTemplateResponse + EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails: description: >- - The credentials to authenticate a user agent with a server that is put - in HTTP Authorization request header. - properties: - token: - description: The token for the auth type. - type: string - type: - type: string - description: Authentication type, e.g. "Basic", "Bearer", etc. - type: object - EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: + Contains the details of the execution info of this event: this includes + the tasks execution details plus the event execution statistics. Next + available id: 12 + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails properties: - eventExecutionSnapshotMetadata: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - conditionResults: - type: array - description: All of the computed conditions that been calculated. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - taskExecutionDetails: - description: All of the task execution details at the given point of time. - type: array + eventAttemptStats: items: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails - eventExecutionInfoId: - description: Points to the event execution info this snapshot belongs to. + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + type: array + eventExecutionSnapshotsSize: + format: int64 + description: Total size of all event_execution_snapshots for an execution type: string - checkpointTaskNumber: + ryeLockUnheldCount: + format: int32 + type: integer description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. - type: string - eventExecutionSnapshotId: + Used internally and shouldn't be exposed to users. A counter for the + cron job to record how many times this event is in in_process state + but don't have a lock consecutively/ + cancelReason: type: string description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - diffParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: The parameters in Event object that differs from last snapshot. - eventParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: The parameters in Event object. - snapshotTime: + If the execution is manually canceled, this field will contain the + reason for cancellation. + eventExecutionState: type: string + enumDescriptions: + - '' + - >- + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. + - >- + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. + - >- + Event execution canceled by user. There's no more change after + this state. + - Event execution failed and waiting for retry. + - Event execution suspended and waiting for manual intervention. + description: The execution state of this event. + enum: + - UNSPECIFIED + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED + nextExecutionTime: + description: >- + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. format: int64 - description: Indicates when this snapshot is taken. - taskName: - deprecated: true type: string - description: The task name associated with this snapshot. Could be empty. - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + eventRetriesFromBeginningCount: + description: >- + Indicates the number of times the execution has restarted from the + beginning. + type: integer + format: int32 + networkAddress: + description: >- + The network address (aka. bns address) that indicates where the + event executor is running. + type: string + eventExecutionSnapshot: + type: array + description: >- + After snapshot migration, this field will no longer be populated, + but old execution snapshots will still be accessible. + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + logFilePath: + description: The log file path (aka. cns address) for this event. + type: string type: object - EnterpriseCrmEventbusProtoNotification: + GoogleCloudIntegrationsV1alphaGenerateTokenResponse: + description: Returns success or error message + id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse properties: - emailAddress: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' - buganizerNotification: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' - escalatorQueue: + message: type: string - request: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest - description: >- - If the out-of-the-box email/pubsub notifications are not suitable - and custom logic is required, fire a workflow containing all info - needed to notify users to resume execution. - pubsubTopic: + description: The message that notifies the user if the request succeeded or not. + type: object + GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: + description: >- + Parameters to support Oauth 2.0 Client Credentials Grant Authentication. + See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. + type: object + properties: + clientId: + description: The client identifier. type: string + clientSecret: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Secret version reference containing the client secret. + id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + EnterpriseCrmEventbusProtoParameterValueType: type: object - id: EnterpriseCrmEventbusProtoNotification - GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: + description: >- + LINT.IfChange To support various types of parameter values. Next + available id: 14 + id: EnterpriseCrmEventbusProtoParameterValueType + properties: + protoArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' + stringValue: + type: string + intValue: + type: string + format: int64 + doubleValue: + type: number + format: double + booleanValue: + type: boolean + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' + booleanArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' + protoValue: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + EnterpriseCrmEventbusProtoIntArray: type: object - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest - description: Request for Creating Cloud Function rpc call. properties: - functionName: - description: The function name of CF to be created - type: string - functionRegion: - description: The function region of CF to be created - type: string - projectId: - description: >- - Indicates the id of the GCP project that the function will be - created in. + values: + type: array + items: + type: string + format: int64 + id: EnterpriseCrmEventbusProtoIntArray + EnterpriseCrmEventbusProtoParameterMapField: + id: EnterpriseCrmEventbusProtoParameterMapField + properties: + literalValue: + description: Passing a literal value. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + referenceKey: + description: Referencing one of the WF variables. type: string - EnterpriseCrmEventbusProtoProtoFunction: type: object + description: Field represents either the key or value in an entry. + EnterpriseCrmEventbusProtoIntArrayFunction: properties: functionName: + type: string enumDescriptions: - '' - '' @@ -7300,403 +6957,303 @@ components: - '' - '' - '' + - '' + - '' enum: - UNSPECIFIED - - GET_STRING_SUBFIELD - - GET_INT_SUBFIELD - - GET_DOUBLE_SUBFIELD - - GET_BOOLEAN_SUBFIELD - - GET_STRING_ARRAY_SUBFIELD - - GET_INT_ARRAY_SUBFIELD - - GET_DOUBLE_ARRAY_SUBFIELD - - GET_BOOLEAN_ARRAY_SUBFIELD - - GET_PROTO_ARRAY_SUBFIELD - - GET_PROTO_SUBFIELD + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL - TO_JSON - - GET_BYTES_SUBFIELD_AS_UTF_8_STRING - - GET_BYTES_SUBFIELD_AS_PROTO - - EQUALS - type: string - id: EnterpriseCrmEventbusProtoProtoFunction + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + id: EnterpriseCrmEventbusProtoIntArrayFunction + type: object EnterpriseCrmEventbusProtoEventExecutionSnapshot: + description: >- + Contains the snapshot of the event execution for a given checkpoint. + Next available id: 15 + id: EnterpriseCrmEventbusProtoEventExecutionSnapshot + type: object properties: + eventParams: + description: The parameters in Event object. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + diffParams: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: The parameters in Event object that differs from last snapshot. + eventExecutionInfoId: + type: string + description: Points to the event execution info this snapshot belongs to. + clientId: + type: string + description: Client that the execution snapshot is associated to. checkpointTaskNumber: type: string description: >- Indicates "right after which checkpoint task's execution" this snapshot is taken. - eventExecutionInfoId: + snapshotTime: + format: int64 + description: Indicates when this snapshot is taken. type: string - description: Points to the event execution info this snapshot belongs to. conditionResults: - description: All of the computed conditions that been calculated. items: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' type: array - diffParams: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters in Event object that differs from last snapshot. - eventParams: - description: The parameters in Event object. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - snapshotTime: - type: string - description: Indicates when this snapshot is taken. - format: int64 - clientId: - type: string - description: Client that the execution snapshot is associated to. - exceedMaxSize: - description: indicate whether snapshot exceeded maximum size before clean up - type: boolean + description: All of the computed conditions that been calculated. + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata taskExecutionDetails: - description: All of the task execution details at the given point of time. - type: array items: $ref: >- #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + description: All of the task execution details at the given point of time. + type: array + exceedMaxSize: + type: boolean + description: indicate whether snapshot exceeded maximum size before clean up eventExecutionSnapshotId: type: string description: >- Auto-generated. Used as primary key for EventExecutionSnapshots table. workflowName: - description: Name of the workflow this event execution snapshot belongs to. type: string + description: Name of the workflow this event execution snapshot belongs to. taskName: description: The task name associated with this snapshot. Could be empty. type: string deprecated: true - eventExecutionSnapshotMetadata: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - id: EnterpriseCrmEventbusProtoEventExecutionSnapshot - description: >- - Contains the snapshot of the event execution for a given checkpoint. - Next available id: 15 - type: object - EnterpriseCrmEventbusProtoProtoParameterArray: - id: EnterpriseCrmEventbusProtoProtoParameterArray - type: object - properties: - protoValues: - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: array - EnterpriseCrmFrontendsEventbusProtoTaskEntity: - type: object - properties: - metadata: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' - description: Metadata inclueds the task name, author and so on. - uiConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' - description: >- - UI configuration for this task Also associated with the METADATA - mask. - taskType: - enumDescriptions: - - Normal IP task - - Task is of As-Is Template type - - Task is of I/O template type with a different underlying task - type: string - enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE - description: Defines the type of the task - paramSpecs: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage - description: >- - Declarations for inputs/outputs for a TypedTask. This is also - associated with the METADATA mask. - stats: - description: Deprecated - statistics from the Monarch query. - $ref: '#/components/schemas/EnterpriseCrmEventbusStats' - deprecated: true - disabledForVpcSc: - type: boolean - description: True if the task has conflict with vpcsc - description: >- - Contains a task's metadata and associated information. Next available - id: 7 - id: EnterpriseCrmFrontendsEventbusProtoTaskEntity - GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: - id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse - type: object - properties: - nextPageToken: - type: string - description: The token used to retrieve the next page of results. - sfdcInstances: - description: The list of SfdcInstances retrieved. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' - description: Response to list SfdcInstances. - EnterpriseCrmEventbusProtoTaskExecutionDetails: - description: >- - Contains the details of the execution of this task. Next available id: - 11 - type: object - properties: - taskAttemptStats: - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats - type: array - taskExecutionState: - enumDescriptions: - - '' - - >- - Task is waiting for its precondition tasks to finish to start the - execution. - - Task is under processing. - - >- - Task execution successfully finished. There's no more change after - this state. - - Task execution failed. There's no more change after this state. - - >- - Task execution failed and cause the whole event execution to fail - immediately. There's no more change after this state. - - Task execution failed and waiting for retry. - - >- - Task execution skipped. This happens when its precondition wasn't - met, or the event execution been canceled before reach to the - task. There's no more changes after this state. - - >- - Task execution canceled when in progress. This happens when event - execution been canceled or any other task fall in fatal state. - - >- - Task is waiting for its dependency tasks' rollback to finish to - start its rollback. - - Task is rolling back. - - >- - Task is rolled back. This is the state we will set regardless of - rollback succeeding or failing. - - >- - Task is a SuspensionTask which has executed once, creating a - pending suspension. - type: string - enum: - - UNSPECIFIED - - PENDING_EXECUTION - - IN_PROCESS - - SUCCEED - - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - - CANCELED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK - - SUSPENDED - taskNumber: - type: string - description: Pointer to the task config it used for execution. - id: EnterpriseCrmEventbusProtoTaskExecutionDetails - EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: + type: object + description: Request for LinkAppsScriptProject rpc call. + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest properties: - emailAddress: + scriptId: + description: The id of the Apps Script project to be linked. type: string - gaiaId: - format: int64 + GoogleCloudIntegrationsV1alphaExecuteEventResponse: + description: The response for executing an integration. + properties: + executionId: type: string + description: The id of the execution corresponding to this run of integration. type: object - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - GoogleCloudIntegrationsV1alphaIntegrationParameter: + id: GoogleCloudIntegrationsV1alphaExecuteEventResponse + EnterpriseCrmEventbusProtoBuganizerNotification: type: object properties: - producer: + componentId: + format: int64 description: >- - The identifier of the node (TaskConfig/TriggerConfig) this parameter - was produced by, if it is a transient param or a copy of an input - param. + ID of the buganizer component within which to create a new issue. + Required. type: string - isTransient: - type: boolean - description: Whether this parameter is a transient parameter. - jsonSchema: + assigneeEmailAddress: + description: Whom to assign the new bug. Optional. + type: string + templateId: + format: int64 + type: string + description: ID of the buganizer template to use. Optional. + title: + description: Title of the issue to be created. Required. + type: string + id: EnterpriseCrmEventbusProtoBuganizerNotification + EnterpriseCrmEventbusProtoBaseValue: + id: EnterpriseCrmEventbusProtoBaseValue + type: object + properties: + referenceValue: + type: string + description: Start with a reference value to dereference. + literalValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: Start with a literal value. + baseFunction: description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. + Start with a function that does not build on existing values. Eg. + CurrentTime, Min, Max, Exists, etc. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + GoogleCloudIntegrationsV1alphaListTemplatesResponse: + description: Response for a request to list templates + id: GoogleCloudIntegrationsV1alphaListTemplatesResponse + properties: + templates: + type: array + description: List of templates retrieved. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + nextPageToken: + description: The token used to retrieve the next page results. type: string - searchable: - description: Searchable in the execution log or not. - type: boolean - description: + type: object + GoogleCloudIntegrationsV1alphaTaskConfig: + properties: + taskTemplate: + description: >- + Optional. Used to define task-template name if task is of type + task-template type: string - description: Optional. Description of the parameter. - containsLargeData: - type: boolean + failurePolicy: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - displayName: + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). + taskId: description: >- - The name (without prefix) to be displayed in the UI for this - parameter. E.g. if the key is "foo.bar.myName", then the name would - be "myName". + Required. The identifier of this task within its parent event + config, specified by the client. This should be unique among all the + tasks belong to the same event config. We use this field as the + identifier to find next tasks (via field `next_tasks.task_id`). type: string - key: + nextTasksExecutionPolicy: + enumDescriptions: + - Default. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + enum: + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + description: >- + Optional. The policy dictating the execution of the next set of + tasks for the current task. type: string + description: description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - dataType: - enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - - // Non-serializable object (Internal use only). + Optional. User-provided description intended to give additional + business context about the task. type: string - description: Type of the parameter. - enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - - NON_SERIALIZABLE_OBJECT - defaultValue: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + conditionalFailurePolicies: description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - masked: - type: boolean - description: True if this parameter should be masked in the logs - inputOutputType: + Optional. The list of conditional failure policies that will be + applied to the task in order. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + successPolicy: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' + description: >- + Optional. Determines what action to take upon successful task + completion. + parameters: + description: Optional. The customized parameters the user can pass to this task. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' + type: object + taskExecutionStrategy: + description: Optional. The policy dictating the execution strategy of this task. enumDescriptions: - - Default. - >- - Input parameters for the integration. EventBus validates that - these parameters exist in the integrations before execution. + Default. If the strategy is not set explicitly, it will default to + `WHEN_ALL_SUCCEED`. - >- - Output Parameters for the integration. EventBus will only return - the integration parameters tagged with OUT in the response back. + Wait until all of its previous tasks finished execution, then + verify at least one of the edge conditions is met, and execute if + possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - >- - Input and Output Parameters. These can be used as both input and - output. EventBus will validate for the existence of these - parameters before execution and will also return this parameter - back in the response. + Start execution as long as any of its previous tasks finished + execution and the corresponding edge condition is met (since we + will execute if only that succeeding edge condition is met). + - >- + Wait until all of its previous tasks finished execution, then + verify the all edge conditions are met and execute if possible. enum: - - IN_OUT_TYPE_UNSPECIFIED - - IN - - OUT - - IN_OUT - description: Specifies the input/output type for the parameter. - type: string - description: >- - Integration Parameter is defined in the integration config and are used - to provide information about data types of the expected parameters and - provide any default values if needed. They can also be used to add - custom attributes. These are static in nature and should not be used for - dynamic event definition. - id: GoogleCloudIntegrationsV1alphaIntegrationParameter - GoogleCloudIntegrationsV1alphaParameterMapEntry: - properties: - value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - description: Value of the map entry. - key: - description: Key of the map entry. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - description: Entry is a pair of key and value. - type: object - id: GoogleCloudIntegrationsV1alphaParameterMapEntry - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - description: >- - Contains all the execution details for a workflow instance. Next - available id: 27 - properties: - integrationVersionUserLabel: - description: User-defined label that annotates the executed integration version. + - TASK_EXECUTION_STRATEGY_UNSPECIFIED + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED type: string - workflowId: + errorCatcherId: type: string - description: Required. Pointer to the workflow it is executing. - errorCode: - description: Final error-code if event failed. - $ref: '#/components/schemas/CrmlogErrorCode' - responseParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Event parameters come out as part of the response. - workflowRetryBackoffIntervalSeconds: - format: int64 + description: >- + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task + nextTasks: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + description: >- + Optional. The set of tasks that are next in line to be executed as + per the execution graph defined for the parent event, specified by + `event_config_id`. Each of these next tasks are executed only if the + condition associated with them evaluates to true. + synchronousCallFailurePolicy: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + externalTaskType: + description: Optional. External task type of the task type: string + enumDescriptions: + - Default value. External task type is not specified + - Tasks belongs to the normal task flows + - Task belongs to the error catch task flows + enum: + - EXTERNAL_TASK_TYPE_UNSPECIFIED + - NORMAL_TASK + - ERROR_TASK + displayName: description: >- - Time interval in seconds to schedule retry of workflow in manifold - when workflow is already running - product: + Optional. User-provided label that is attached to this TaskConfig in + the UI. type: string + jsonValidationOption: + description: >- + Optional. If set, overrides the option configured in the Task + implementation class. enum: - - UNSPECIFIED_PRODUCT - - IP - - APIGEE - - SECURITY + - JSON_VALIDATION_OPTION_UNSPECIFIED + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION enumDescriptions: - - '' - - '' - - '' - - '' - description: >- - Which Google product the execution_info belongs to. If not set, the - execution_info belongs to Integration Platform by default. - workflowName: - type: string - description: Name of the workflow. - clientId: - type: string - description: The event data user sends as request. - triggerId: + - >- + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. + - >- + Validate all potential input JSON parameters against schemas + specified in IntegrationParameter. + - >- + Validate all potential output JSON parameters against schemas + specified in IntegrationParameter. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. type: string + position: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' description: >- - The trigger id of the workflow trigger config. If both trigger_id - and client_id is present, the workflow is executed from the start - tasks provided by the matching trigger config otherwise it is - executed from the default start tasks. - executionTraceInfo: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' - description: Execution trace info to aggregate parent-child executions. - lastModifiedTime: - description: Auto-generated. + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + task: type: string - format: int64 - postMethod: - description: The ways user posts this event. + description: Optional. The name for the task. + description: >- + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + type: object + id: GoogleCloudIntegrationsV1alphaTaskConfig + EnterpriseCrmEventbusProtoStringArrayFunction: + type: object + properties: + functionName: type: string - enum: - - UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE - - POST_BY_EVENT_CONFIG_ID - - POST_WITH_EVENT_DETAILS enumDescriptions: - '' - '' @@ -7704,675 +7261,464 @@ components: - '' - '' - '' - replayInfo: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo - description: Replay info for the execution - snapshotNumber: - type: string - description: Workflow snapshot number. - format: int64 - cloudLoggingDetails: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' - description: Cloud Logging details for execution info - tenant: - type: string - description: >- - Tenant this event is created. Used to reschedule the event to - correct tenant. - createTime: - description: Auto-generated. - format: int64 - type: string - requestId: - type: string - description: Optional. This is used to de-dup incoming request. - requestParams: - description: Event parameters come in as part of the request. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - errors: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' - type: array - description: >- - Errors, warnings, and informationals associated with the - workflow/task. The order in which the errors were added by the - workflow/task is maintained. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + id: EnterpriseCrmEventbusProtoStringArrayFunction + GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: + properties: eventExecutionInfoId: type: string - description: Auto-generated primary key. - eventExecutionDetails: - description: The execution info about this event. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails + description: Execution Id that will be returned + id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + description: Response of lift Suspense type: object - GoogleCloudConnectorsV1EventingConfig: - description: Eventing Configuration of a connection + GoogleCloudConnectorsV1AuthConfigSshPublicKey: + id: GoogleCloudConnectorsV1AuthConfigSshPublicKey + description: Parameters to support Ssh public key Authentication. type: object - id: GoogleCloudConnectorsV1EventingConfig - properties: - privateConnectivityEnabled: - type: boolean - description: Optional. Private Connectivity Enabled. - deadLetterConfig: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - description: Optional. Dead letter configuration for eventing of a connection. - enrichmentEnabled: - type: boolean - description: Enrichment Enabled. - additionalVariables: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - type: array - description: Additional eventing related field values - eventsListenerIngressEndpoint: - description: >- - Optional. Ingress endpoint of the event listener. This is used only - when private connectivity is enabled. - type: string - proxyDestinationConfig: - description: Optional. Proxy for Eventing auto-registration. - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - authConfig: - description: Auth details for the webhook adapter. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - listenerAuthConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - description: Optional. Auth details for the event listener. - registrationDestinationConfig: - description: Registration endpoint for auto registration. - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - EnterpriseCrmEventbusProtoParameterMapField: properties: - referenceKey: + sshClientCertPass: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Password (passphrase) for ssh client certificate if it has one. + sshClientCert: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: SSH Client Cert. It should contain both public and private key. + username: type: string - description: Referencing one of the WF variables. - literalValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: Passing a literal value. - type: object - id: EnterpriseCrmEventbusProtoParameterMapField - description: Field represents either the key or value in an entry. - GoogleCloudIntegrationsV1alphaDoubleParameterArray: - type: object - id: GoogleCloudIntegrationsV1alphaDoubleParameterArray - description: This message only contains a field of double number array. - properties: - doubleValues: - description: Double number array. - type: array - items: - format: double - type: number - EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: - type: object - properties: - parameters: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - description: >- - Parameters are a part of Event and can be used to communiticate - between different tasks that are part of the same workflow - execution. - description: >- - LINT.IfChange This is the frontend version of WorkflowParameters. It's - exactly like the backend version except that instead of flattening - protobuf parameters and treating every field and subfield of a protobuf - parameter as a separate parameter, the fields/subfields of a protobuf - parameter will be nested as "children" (see 'children' field below) - parameters of the parent parameter. Please refer to - enterprise/crm/eventbus/proto/workflow_parameters.proto for more - information about WorkflowParameters. - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: - id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - type: object - properties: - objectValue: + description: The user account used to authenticate. + certType: type: string - format: byte - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: - type: object + description: Format of SSH Client cert. + GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate: properties: integrationVersion: $ref: >- #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: The uploaded integration. - description: Response for UploadIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse - GoogleCloudIntegrationsV1alphaValueType: - description: The type of the parameter. - id: GoogleCloudIntegrationsV1alphaValueType + description: Required. Templatized version of integration. + key: + description: Required. Unique Key of the IntegrationVersion. + type: string + type: object + description: Define the template of IntegrationVersion. + id: GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + EnterpriseCrmFrontendsEventbusProtoParameterMapField: type: object + description: Field represents either the key or value in an entry. + id: EnterpriseCrmFrontendsEventbusProtoParameterMapField properties: - doubleValue: - type: number - description: Double Number. - format: double - booleanValue: - type: boolean - description: Boolean. - doubleArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray - description: Double Number Array. - jsonValue: - description: Json. - type: string - stringValue: - type: string - description: String. - intArray: - description: Integer Array. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' - intValue: - description: Integer. - format: int64 + referenceKey: + description: Referencing one of the WF variables. type: string - stringArray: - description: String Array. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray - booleanArray: + literalValue: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray - description: Boolean Array. - GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + description: Passing a literal value. + EnterpriseCrmEventbusProtoScatterResponse: + id: EnterpriseCrmEventbusProtoScatterResponse type: object - description: >- - Parameters to support Oauth 2.0 Auth Code Grant Authentication using - Google Provided OAuth Client. See - https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. properties: - authCode: - type: string + isSuccessful: description: >- - Optional. Authorization code to be exchanged for access and refresh - tokens. - redirectUri: - description: Optional. Redirect URI to be provided during the auth code exchange. - type: string - scopes: + If execution is sync, this is true if the execution passed and false + if it failed. If the execution is async, this is true if the WF was + fired off successfully, and false if it failed to execute. The + success or failure of the subworkflows executed are not captured. + type: boolean + scatterElement: + description: The element that was scattered for this execution. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + executionIds: + description: The execution ids of each Subworkflow fired by this scatter. type: array items: type: string + responseParams: description: >- - Required. Scopes the connection will request when the user performs - the auth code flow. - id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged - GoogleCloudIntegrationsV1alphaAuthConfig: + A list of all the response parameters in the aggregtorMap stored + with the remapped key. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + errorMsg: + description: The error message of the failure if applicable. + type: string + GoogleCloudIntegrationsV1alphaIntParameterArray: + properties: + intValues: + description: Integer array. + items: + format: int64 + type: string + type: array + id: GoogleCloudIntegrationsV1alphaIntParameterArray + type: object + description: This message only contains a field of integer array. + GoogleCloudConnectorsV1Connection: type: object + id: GoogleCloudConnectorsV1Connection properties: - credentialType: - type: string - description: Credential type of the encrypted credential. - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - enumDescriptions: - - Unspecified credential type - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - createTime: + serviceAccount: + description: >- + Optional. Service account needed for runtime plane to access Google + Cloud resources. type: string + suspended: + type: boolean + description: >- + Optional. Suspended indicates if a user has suspended a connection + or not. + connectionRevision: readOnly: true - format: google-datetime - description: Output only. The timestamp when the auth config is created. - lastModifierEmail: + format: int64 + type: string description: >- - The last modifier's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. + Output only. Connection revision. This field is only updated when + the connection is created or updated by User. + envoyImageLocation: + description: >- + Output only. GCR location where the envoy image is stored. formatted + like: gcr.io/{bucketName}/{imageName} + readOnly: true type: string - decryptedCredential: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' - description: Raw auth credentials. + connectorVersionInfraConfig: + description: Output only. Infra configs supported by Connector Version. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig + readOnly: true name: description: >- - Resource name of the auth config. For more information, see Manage - authentication profiles. - projects/{project}/locations/{location}/authConfigs/{authConfig}. + Output only. Resource name of the Connection. Format: + projects/{project}/locations/{location}/connections/{connection} + readOnly: true type: string - visibility: - description: The visibility of the auth config. + isTrustedTester: + description: Output only. Is trusted tester program enabled for the project. + type: boolean + readOnly: true + sslConfig: + description: Optional. Ssl config of a connection + $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' + connectorVersion: type: string - enum: - - AUTH_CONFIG_VISIBILITY_UNSPECIFIED - - PRIVATE - - CLIENT_VISIBLE + description: >- + Required. Connector version on which the connection is created. The + format is: + projects/*/locations/*/providers/*/connectors/*/versions/* Only + global location is supported for ConnectorVersion resource. + connectorVersionLaunchStage: enumDescriptions: - - Visibility not specified. - - Profile visible to the creator only. - - Profile visible within the client. - updateTime: + - LAUNCH_STAGE_UNSPECIFIED. + - PREVIEW. + - GA. + - DEPRECATED. + - PRIVATE_PREVIEW. type: string + description: Output only. Flag to mark the version indicating the launch stage. readOnly: true - description: Output only. The timestamp when the auth config is modified. - format: google-datetime - state: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - PREVIEW + - GA + - DEPRECATED + - PRIVATE_PREVIEW + tlsMigrationState: enumDescriptions: - - Status not specified. - - Valid Auth config. - - >- - General invalidity, if it doesn't fits in the detailed issue - below. - - Auth config soft deleted. - - Auth config expired. - - Auth config unauthorized. - - Auth config not supported. - description: The status of the auth config. + - TLS migration state is not specified. + - TLS migration is in progress. + - TLS migration is completed. + description: Output only. Status of the TLS migration. type: string enum: - - STATE_UNSPECIFIED - - VALID - - INVALID - - SOFT_DELETED - - EXPIRED - - UNAUTHORIZED - - UNSUPPORTED - encryptedCredential: - type: string - format: byte + - TLS_MIGRATION_STATE_UNSPECIFIED + - TLS_MIGRATION_NOT_STARTED + - TLS_MIGRATION_COMPLETED + readOnly: true + labels: + additionalProperties: + type: string + type: object + description: >- + Optional. Resource labels to represent user-provided metadata. Refer + to cloud documentation on labels for more details. + https://cloud.google.com/compute/docs/labeling-resources + authConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + description: >- + Optional. Configuration for establishing the connection's + authentication with an external system. + host: + readOnly: true description: >- - Auth credential encrypted by Cloud KMS. Can be decrypted as - Credential with proper KMS key. - reason: + Output only. The name of the Hostname of the Service Directory + service with TLS. type: string - description: The reason / details of the current status. - overrideValidTime: + billingConfig: + description: Output only. Billing config for the connection. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' + asyncOperationsEnabled: + type: boolean description: >- - User provided expiry time to override. For the example of - Salesforce, username/password credentials can be valid for 6 months - depending on the instance settings. - format: google-datetime + Optional. Async operations enabled for the connection. If Async + Operations is enabled, Connection allows the customers to initiate + async long running operations using the actions API. + tlsServiceDirectory: + description: Output only. The name of the Service Directory service with TLS. + readOnly: true type: string - expiryNotificationDuration: - description: >- - User can define the time to receive notification after which the - auth config becomes invalid. Support up to 30 days. Support - granularity in hours. + createTime: + type: string + format: google-datetime + description: Output only. Created time. + readOnly: true + configVariables: items: - format: google-duration - type: string + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' type: array - description: - description: A description of the auth config. - type: string - certificateId: - type: string - description: Certificate id for client certificate - creatorEmail: - type: string description: >- - The creator's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. - displayName: - type: string - description: Required. The name of the auth config. - validTime: + Optional. Configuration for configuring the connection with an + external system. + serviceDirectory: + readOnly: true description: >- - The time until the auth config is valid. Empty or max value is - considered the auth config won't expire. - format: google-datetime - type: string - id: GoogleCloudIntegrationsV1alphaAuthConfig - description: The AuthConfig resource use to hold channels and connection config data. - GoogleCloudIntegrationsV1alphaExecutionDetails: - properties: - eventExecutionSnapshotsSize: - format: int64 - description: Total size of all event_execution_snapshots for an execution + Output only. The name of the Service Directory service name. Used + for Private Harpoon to resolve the ILB address. e.g. + "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" type: string - attemptStats: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - type: array - description: List of Start and end time of the execution attempts. - state: + subscriptionType: + description: >- + Output only. This subscription type enum states the subscription + type of the project. type: string - enumDescriptions: - - Default. - - Execution is scheduled and awaiting to be triggered. - - Execution is processing. - - >- - Execution successfully finished. There's no more change after this - state. - - Execution failed. There's no more change after this state. - - >- - Execution canceled by user. There's no more change after this - state. - - Execution failed and waiting for retry. - - Execution suspended and waiting for manual intervention. - description: Status of the execution. enum: - - STATE_UNSPECIFIED - - PENDING - - PROCESSING - - SUCCEEDED - - FAILED - - CANCELLED - - RETRY_ON_HOLD - - SUSPENDED - executionSnapshots: - description: List of snapshots taken during the execution. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot - id: GoogleCloudIntegrationsV1alphaExecutionDetails - description: >- - Contains the details of the execution info: this includes the tasks - execution details plus the event execution statistics. - type: object - EnterpriseCrmFrontendsEventbusProtoEventParameters: - properties: - parameters: + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAY_G + - PAID + readOnly: true + enumDescriptions: + - Unspecified subscription type. + - PayG subscription. + - Paid Subscription. + destinationConfigs: + description: >- + Optional. Configuration of the Connector's destination. Only + accepted for Connectors that accepts user defined destination(s). items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' type: array + lockConfig: description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same workflow - execution. - id: EnterpriseCrmFrontendsEventbusProtoEventParameters - type: object - description: >- - LINT.IfChange This message is used for processing and persisting (when - applicable) key value pair parameters for each event in the event bus. - Please see - EnterpriseCrmEventbusProtoCondition: - properties: - operator: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + Optional. Configuration that indicates whether or not the Connection + can be edited. + $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' + status: + readOnly: true + description: Output only. Current status of the connection. + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' + description: + type: string + description: Optional. Description of the resource. + eventingRuntimeData: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' + description: Output only. Eventing Runtime Data. + imageLocation: + type: string description: >- - Operator used to evaluate the condition. Please note that an - operator with an inappropriate key/value operand will result in - IllegalArgumentException, e.g. CONTAINS with boolean key/value pair. + Output only. GCR location where the runtime image is stored. + formatted like: gcr.io/{bucketName}/{imageName} + readOnly: true + nodeConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' + description: Optional. Node configuration for the connection. + logConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' + description: Optional. Log configuration for the connection. + eventingEnablementType: enum: - - UNSET - - EQUALS - - CONTAINS - - LESS_THAN - - GREATER_THAN - - EXISTS - - DOES_NOT_EXIST - - IS_EMPTY - - IS_NOT_EMPTY + - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED + - EVENTING_AND_CONNECTION + - ONLY_EVENTING type: string - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - description: Value that's checked for the key. - eventPropertyKey: description: >- - Key that's evaluated against the `value`. Please note the data type - of the runtime value associated with the key should match the data - type of `value`, else an IllegalArgumentException is thrown. + Optional. Eventing enablement type. Will be nil if eventing is not + enabled. + enumDescriptions: + - Eventing Enablement Type Unspecifeied. + - Both connection and eventing. + - Only Eventing. + eventingConfig: + description: Optional. Eventing config of a connection + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' + updateTime: type: string + format: google-datetime + readOnly: true + description: Output only. Updated time. + description: Connection represents an instance of connector. + GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: + id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode type: object - description: Condition that uses `operator` to evaluate the key against the value. - id: EnterpriseCrmEventbusProtoCondition - deprecated: true - EnterpriseCrmEventbusProtoSuspensionExpiration: - properties: - expireAfterMs: - description: Milliseconds after which the suspension expires, if no action taken. - format: int32 - type: integer - liftWhenExpired: - type: boolean - description: >- - Whether the suspension will be REJECTED or LIFTED upon expiration. - REJECTED is the default behavior. - remindAfterMs: - description: >- - Milliseconds after which the previous suspension action reminder, if - any, is sent using the selected notification option, for a - suspension which is still PENDING_UNSPECIFIED. - type: integer - format: int32 - type: object - id: EnterpriseCrmEventbusProtoSuspensionExpiration - EnterpriseCrmEventbusProtoNextTask: - type: object - id: EnterpriseCrmEventbusProtoNextTask + description: >- + The OAuth Type where the client sends request with the client id and + requested scopes to auth endpoint. User sees a consent screen and auth + code is received at specified redirect url afterwards. The auth code is + then combined with the client id and secret and sent to the token + endpoint in exchange for the access and refresh token. The refresh token + can be used to fetch new access tokens. properties: - label: - description: User-provided label that is attached to this edge in the UI. + clientSecret: + type: string + description: The client's secret. + authParams: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + description: The auth parameters sent along with the auth code request. + accessToken: + description: The access token received from the token endpoint. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + tokenParams: + description: The token parameters sent along with the token request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + requestType: + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER type: string - taskConfigId: - description: ID of the next task. + description: Represent how to pass parameters to fetch access token + enumDescriptions: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + authCode: + description: The Auth Code that is used to initially retrieve the access token. type: string - description: + scope: + description: A space-delimited list of requested scope permissions. type: string - description: >- - User-provided description intended to give more business context - about the next task edge or condition. - combinedConditions: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' - deprecated: true - type: array - description: >- - Combined condition for this task to become an eligible next task. - Each of these combined_conditions are joined with logical OR. - DEPRECATED: use `condition` - taskNumber: + authEndpoint: + description: The auth url endpoint to send the auth code request to. type: string - description: Task number of the next task. - condition: + tokenEndpoint: + description: The token url endpoint to send the token request to. type: string + applyReauthPolicy: + type: boolean description: >- - Standard filter expression for this task to become an eligible next - task. - description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. - GoogleCloudIntegrationsV1alphaStringParameterArray: - id: GoogleCloudIntegrationsV1alphaStringParameterArray - properties: - stringValues: - description: String array. - items: - type: string - type: array - description: This message only contains a field of string array. - type: object - GoogleCloudConnectorsV1ResourceLimits: - properties: - memory: - readOnly: true - type: string - description: Output only. Memory limit. - cpu: - description: Output only. CPU limit. + Indicates if the user has opted in Google Reauth Policy. If opted + in, the refresh token will be valid for 20 hours, after which time + users must re-authenticate in order to obtain a new one. + clientId: type: string - readOnly: true - id: GoogleCloudConnectorsV1ResourceLimits - type: object - description: Resource limits defined for connection pods of a given connector type. - EnterpriseCrmEventbusProtoToken: - id: EnterpriseCrmEventbusProtoToken - type: object + description: The client's id. + GoogleCloudConnectorsV1Secret: + id: GoogleCloudConnectorsV1Secret properties: - value: - type: string - name: + secretVersion: type: string - EnterpriseCrmEventbusProtoBooleanParameterArray: - type: object - id: EnterpriseCrmEventbusProtoBooleanParameterArray - properties: - booleanValues: - type: array - items: - type: boolean - EnterpriseCrmEventbusProtoFunctionType: - properties: - booleanArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' - doubleArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' - protoFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' - baseFunction: - description: LINT.IfChange - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' - booleanFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction' - intArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction' - intFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntFunction' - jsonFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' - stringArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' - protoArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' - doubleFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' - stringFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' - type: object - id: EnterpriseCrmEventbusProtoFunctionType - GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue + description: >- + The resource name of the secret version in the format, format as: + `projects/*/secrets/*/versions/*`. + description: Secret provides a reference to entries in Secret Manager. type: object + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo description: >- - The threshold value of the metric, above or below which the alert should - be triggered. See EventAlertConfig or TaskAlertConfig for the different - alert metric types in each case. For the *RATE metrics, one or both of - these fields may be set. Zero is the default value and can be left at - that. For *PERCENTILE_DURATION metrics, one or both of these fields may - be set, and also, the duration threshold value should be specified in - the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, - these fields should not be set at all. A different member, - threshold_duration_ms, must be set in the EventAlertConfig or the - TaskAlertConfig. - properties: - percentage: - type: integer - format: int32 - description: Percentage threshold. - absolute: - format: int64 - type: string - description: Absolute value threshold. - GoogleCloudIntegrationsV1alphaUseTemplateRequest: - id: GoogleCloudIntegrationsV1alphaUseTemplateRequest - type: object - description: Request to Use template + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship properties: - subIntegrations: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - description: Optional. Sub Integration which would be created via templates. - type: object - integrationDetails: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - description: Required. Integration details which would be created via templates. - integrationRegion: + replayReason: type: string - description: Required. The region of the Integration to be created. - GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: - properties: - runtimeEntitySchemas: - type: array + description: reason for replay + replayedExecutionInfoIds: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - description: Runtime entity schemas. - nextPageToken: + type: string + description: >- + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. + type: array + originalExecutionInfoId: type: string - description: Next page token. - description: Response for listing RuntimeEntitySchemas for a specific Connection. - id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse - type: object - GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: - description: Request for the ReplaceServiceAccount rpc - id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + description: >- + If this execution is a replay of another execution, then this field + contains the original execution id. type: object + EnterpriseCrmEventbusProtoParameterMap: + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. properties: - runAsServiceAccount: - type: string - description: 'Required. REQUIRED: Run-as service account to be updated' - EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: - properties: - required: - type: boolean - description: If set, the user must provide an input value for this parameter. - protoDef: - description: Populated if this represents a proto or proto array. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition - key: - type: string - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given task. These parameters must be - predefined in the workflow definition. - defaultValue: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - collectionElementClassName: - description: >- - If it is a collection of objects, this would be the FCQN of every - individual element in the collection. If this is "java.lang.Object", - the parameter is a collection of any type. - type: string - config: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' - description: Optional fields, such as help text and other useful info. - jsonSchema: - description: If the data_type is JSON_VALUE, then this will define its schema. + keyType: type: string - validationRule: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' description: >- - Rule used to validate inputs (individual values and collection - elements) for this parameter. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - dataType: - description: The data type of the parameter. + Option to specify key value type for all entries of the map. If + provided then field types for all entries must conform to this. + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + valueType: enumDescriptions: - '' - '' @@ -8395,7 +7741,6 @@ components: - '' - '' - '' - type: string enum: - DATA_TYPE_UNSPECIFIED - STRING_VALUE @@ -8415,567 +7760,1043 @@ components: - BYTES_ARRAY - NON_SERIALIZABLE_OBJECT - JSON_VALUE - className: type: string - description: >- - The FQCN of the Java object this represents. A string, for example, - would be "java.lang.String". If this is "java.lang.Object", the - parameter can be of any type. - isOutput: - type: boolean - isDeprecated: - type: boolean - description: >- - If set, this entry is deprecated, so further use of this parameter - should be prohibited. + entries: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' + id: EnterpriseCrmEventbusProtoParameterMap type: object - description: 'Key-value pair of EventBus task parameters. Next id: 13' - id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry - GoogleCloudIntegrationsV1alphaIntegration: - id: GoogleCloudIntegrationsV1alphaIntegration + GoogleCloudIntegrationsV1alphaGetClientResponse: + description: Response for the GetClient rpc + id: GoogleCloudIntegrationsV1alphaGetClientResponse + properties: + client: + description: 'Required. Required: The client configuration that was requested' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' type: object + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: properties: - creatorEmail: - readOnly: true + taskLabel: + description: the task label associated with this snapshot. Could be empty. type: string + ancestorIterationNumbers: + items: + type: string + type: array description: >- - Output only. The creator's email address. Generated based on the End - User Credentials/LOAS role of the user making the call. - lastModifierEmail: - type: string - description: Required. The last modifier of this integration - active: - type: boolean - description: Required. If any integration version is published. - createTime: - format: google-datetime - type: string - description: Required. Output only. Auto-generated. - readOnly: true - updateTime: - readOnly: true + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') + taskAttemptNum: + type: integer + format: int32 + description: the task attempt number this snapshot belongs to. Could be empty. + taskName: type: string - description: Output only. Auto-generated. - format: google-datetime - description: - description: Optional. + description: the task name associated with this snapshot. Could be empty. + integrationName: type: string - name: + description: >- + The direct integration which the event execution snapshots belongs + to + eventAttemptNum: + type: integer + description: the event attempt number this snapshot belongs to. + format: int32 + ancestorTaskNumbers: + description: >- + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') + items: + type: string + type: array + taskNumber: + description: The task number associated with this snapshot. Could be empty. type: string - description: Required. The resource name of the integration. - description: The integration definition. - EnterpriseCrmEventbusProtoSuccessPolicy: + type: object + id: >- + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + EnterpriseCrmEventbusProtoTaskAlertConfig: + id: EnterpriseCrmEventbusProtoTaskAlertConfig properties: - finalState: - enum: - - UNSPECIFIED - - SUCCEEDED - - SUSPENDED + thresholdValue: description: >- - State to which the execution snapshot status will be set if the task - succeeds. + The metric value, above or below which the alert should be + triggered. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + numAggregationPeriods: + type: integer + description: >- + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + format: int32 + alertName: + description: >- + A name to identify this alert. This will be displayed in the alert + subject. If set, this name should be unique in within the scope of + the containing workflow. + type: string + thresholdType: type: string enumDescriptions: - '' - >- - The default behavior, where successful tasks will be marked as - SUCCEEDED. - - >- - Sets the state to SUSPENDED after executing. This is required for - SuspensionTask; event execution will continue once the user calls - ResolveSuspensions with the event_execution_info_id and the task - number. - type: object - description: >- - Policy that dictates the behavior for the task after it completes - successfully. - id: EnterpriseCrmEventbusProtoSuccessPolicy - GoogleCloudIntegrationsV1alphaUploadTemplateRequest: - properties: - content: - description: Required. The textproto of the template. + Note that this field will only trigger alerts if the workflow + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. + - '' + description: >- + The threshold type for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. + enum: + - UNSPECIFIED_THRESHOLD_TYPE + - EXPECTED_MIN + - EXPECTED_MAX + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + alertDisabled: + description: >- + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + type: boolean + playbookUrl: + description: >- + Link to a playbook for resolving the issue that triggered this + alert. type: string - fileFormat: - description: Required. File format for upload request. + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + aggregationPeriod: + description: >- + The period over which the metric value should be aggregated and + evaluated. Format is , where integer should be a positive integer + and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, + day, week). + type: string + clientId: + description: >- + Client associated with this alert configuration. Must be a client + enabled in one of the containing workflow's triggers. type: string + onlyFinalAttempt: + description: Only count final task attempts, not retries. + type: boolean + metricType: enumDescriptions: - - Unspecified file format - - JSON File Format - - YAML File Format + - >- + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. + - >- + Specifies alerting on the rate of errors (potentially for a + specific set of enum values) for the enclosing TaskConfig. + - >- + Specifies alerting on the rate of warnings (potentially for a + specific set of enum values) for the enclosing TaskConfig. + Warnings use the same enum values as errors. + - >- + Specifies alerting on the number of instances for the enclosing + TaskConfig executed in the given aggregation_period. + - >- + Specifies alerting on the average duration of execution for the + enclosing task. + - >- + Specifies alerting on the duration of a particular percentile of + task executions. E.g. If 10% or more of the task executions have + durations above 5 seconds, alert. + type: string enum: - - FILE_FORMAT_UNSPECIFIED - - JSON - - YAML - id: GoogleCloudIntegrationsV1alphaUploadTemplateRequest - type: object - description: Request for UploadTemplate. - GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: - type: object - id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse - description: Response to list AuthConfigs. - properties: - nextPageToken: + - METRIC_TYPE_UNSPECIFIED + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION + durationThresholdMs: + description: >- + Should be specified only for TASK_AVERAGE_DURATION and + TASK_PERCENTILE_DURATION metrics. This member should be used to + specify what duration value the metrics should exceed for the alert + to trigger. + format: int64 type: string - description: The token used to retrieve the next page of results. - authConfigs: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' - type: array - description: The list of AuthConfigs retrieved. - GoogleCloudIntegrationsV1alphaTaskExecutionDetails: - id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails type: object + description: >- + Message to be used to configure alerting in the {@code TaskConfig} + protos for tasks in an event. + EnterpriseCrmFrontendsEventbusProtoTaskConfig: properties: - taskAttemptStats: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - description: Status for the current task execution attempt. taskNumber: + description: >- + REQUIRED: the identifier of this task within its parent event + config, specified by the client. This should be unique among all the + tasks belong to the same event config. We use this field as the + identifier to find next tasks (via field `next_tasks.task_number`). type: string - description: Pointer to the task config it used for execution. - taskExecutionState: + lastModifiedTime: + description: Auto-generated. + type: string + format: google-datetime + taskType: + enumDescriptions: + - Normal IP task + - Task is of As-Is Template type + - Task is of I/O template type with a different underlying task type: string + description: Defines the type of the task enum: - - TASK_EXECUTION_STATE_UNSPECIFIED - - PENDING_EXECUTION - - IN_PROCESS - - SUCCEED - - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - - CANCELLED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK - - SUSPENDED - description: The execution state of this task. + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE + nextTasks: + type: array + description: >- + The set of tasks that are next in line to be executed as per the + execution graph defined for the parent event, specified by + `event_config_id`. Each of these next tasks are executed only if the + condition associated with them evaluates to true. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + disableStrictTypeValidation: + type: boolean + description: >- + If this config contains a TypedTask, allow validation to succeed if + an input is read from the output of another TypedTask whose output + type is declared as a superclass of the requested input type. For + instance, if the previous task declares an output of type Message, + any task with this flag enabled will pass validation when attempting + to read any proto Message type from the resultant Event parameter. + taskExecutionStrategy: + type: string enumDescriptions: - - Default value. - >- - Task is waiting for its precondition tasks to finish to start the - execution. - - Task is under processing. - - >- - Task execution successfully finished. There's no more change after - this state. - - Task execution failed. There's no more change after this state. - - >- - Task execution failed and cause the whole integration execution to - fail immediately. There's no more change after this state. - - Task execution failed and waiting for retry. + Wait until all of its previous tasks finished execution, then + verify at least one of the edge conditions is met, and execute if + possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - >- - Task execution skipped. This happens when its precondition wasn't - met, or the integration execution been canceled before reach to - the task. There's no more changes after this state. + Start execution as long as any of its previous tasks finished + execution and the corresponding edge condition is met (since we + will execute if only that succeeding edge condition is met). - >- - Task execution canceled when in progress. This happens when - integration execution been canceled or any other task fall in - fatal state. + Wait until all of its previous tasks finished execution, then + verify the all edge conditions are met and execute if possible. + description: The policy dictating the execution strategy of this task. + enum: + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + errorCatcherId: + description: >- + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task + type: string + failurePolicy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). + taskEntity: + description: Copy of the task entity that this task config is an instance of. + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' + position: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + description: >- + Optional. Informs the front-end application where to draw this task + config on the UI. + jsonValidationOption: + enum: + - UNSPECIFIED_JSON_VALIDATION_OPTION + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION + enumDescriptions: - >- - Task is waiting for its dependency tasks' rollback to finish to - start its rollback. - - Task is rolling back. + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. - >- - Task is rolled back. This is the state we will set regardless of - rollback succeeding or failing. + Validate all potential input JSON parameters against schemas + specified in WorkflowParameters. - >- - Task is a SuspensionTask which has executed once, creating a - pending suspension. - description: Contains the details of the execution of this task. - GoogleCloudIntegrationsV1alphaExecution: - description: >- - The Execution resource contains detailed information of an individual - integration execution. - type: object - properties: - directSubExecutions: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - type: array - description: Direct sub executions of the following Execution. - requestParameters: - description: Event parameters come in as part of the request. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - requestParams: + Validate all potential output JSON parameters against schemas + specified in WorkflowParameters. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. + type: string + description: >- + If set, overrides the option configured in the Task implementation + class. + taskName: + description: The name for the task. + type: string + externalTaskType: + type: string + enum: + - EXTERNAL_TASK_TYPE_UNSPECIFIED + - NORMAL_TASK + - ERROR_TASK + enumDescriptions: + - Default value. External task type is not specified + - Tasks belongs to the normal task flows + - Task belongs to the error catch task flows + alertConfigs: type: array items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' + description: >- + Alert configurations on error rate, warning rate, number of runs, + durations, etc. + synchronousCallFailurePolicy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + preconditionLabel: + description: >- + Optional. User-provided label that is attached to precondition in + the UI. + type: string + label: + type: string + description: User-provided label that is attached to this TaskConfig in the UI. + parameters: + type: object + additionalProperties: $ref: >- #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: Event parameters come in as part of the request. - deprecated: true - eventExecutionDetails: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' - deprecated: true - description: The execution info about this event. - responseParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Event parameters returned as part of the response. - type: object - triggerId: - description: >- - The trigger id of the integration trigger config. If both trigger_id - and client_id is present, the integration is executed from the start - tasks provided by the matching trigger config otherwise it is - executed from the default start tasks. + description: The customized parameters the user can pass to this task. + precondition: type: string - replayInfo: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo - readOnly: true - description: Output only. Replay info for the execution + description: >- + Optional. Standard filter expression evaluated before execution. + Independent of other conditions and tasks. Can be used to enable + rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to + task. createTime: - readOnly: true + type: string + description: Auto-generated. format: google-datetime + creatorEmail: type: string - description: Output only. Created time of the execution. - executionDetails: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' - description: Detailed info of this execution. - integrationVersionState: - description: Output only. State of the integration version - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. - readOnly: true + description: The creator's email address. Auto-generated from the user's email. + conditionalFailurePolicies: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoConditionalFailurePolicies + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + description: type: string + description: >- + User-provided description intended to give more business context + about the task. + incomingEdgeCount: + format: int32 + type: integer + description: The number of edges leading into this TaskConfig. + successPolicy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' + description: Determines what action to take upon successful task completion. + nextTasksExecutionPolicy: + enumDescriptions: + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - responseParams: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - deprecated: true - description: Event parameters come out as part of the response. - type: array - executionMethod: + - UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + description: >- + The policy dictating the execution of the next set of tasks for the + current task. type: string - enum: - - EXECUTION_METHOD_UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE - enumDescriptions: - - Default value. - - Sync post. - - Async post. - - Async post with schedule time. - description: The ways user posts this event. - name: + rollbackStrategy: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + description: >- + Optional. Contains information about what needs to be done upon + failure (either a permanent error or after it has been retried too + many times). + taskTemplateName: type: string - description: Auto-generated primary key. - snapshotNumber: - format: int64 + description: Used to define task-template name if task is of type task-template + taskSpec: type: string description: >- - Output only. An increasing sequence that is set when a new snapshot - is created - readOnly: true - updateTime: - description: Output only. Last modified time of the execution. - readOnly: true - type: string - format: google-datetime - cloudLoggingDetails: - description: Cloud Logging details for the integration version + A string template that allows user to configure task parameters + (with either literal default values or tokens which will be resolved + at execution time) for the task. It will eventually replace the old + "parameters" field. + type: object + id: EnterpriseCrmFrontendsEventbusProtoTaskConfig + description: >- + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + EnterpriseCrmEventbusProtoEventParameters: + type: object + properties: + parameters: + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + description: >- + LINT.IfChange This message is used for processing and persisting (when + applicable) key value pair parameters for each event in the event bus. + Please see + id: EnterpriseCrmEventbusProtoEventParameters + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + description: Response for UploadIntegrationVersion. + properties: + integrationVersion: + description: The uploaded integration. $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - id: GoogleCloudIntegrationsV1alphaExecution - EnterpriseCrmEventbusProtoFailurePolicy: + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + type: object + EnterpriseCrmEventbusProtoWorkflowAlertConfig: description: >- - Policy that defines the task retry logic and failure type. If no - FailurePolicy is defined for a task, all its dependent tasks will not be - executed (i.e, a `retry_strategy` of NONE will be applied). - id: EnterpriseCrmEventbusProtoFailurePolicy + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. type: object + id: EnterpriseCrmEventbusProtoWorkflowAlertConfig properties: - intervalInSeconds: + alertName: type: string - format: int64 description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the initial interval for backoff. - maxNumRetries: - format: int32 - type: integer + A name to identify this alert. This will be displayed in the alert + subject. If set, this name should be unique within the scope of the + workflow. + durationThresholdMs: + format: int64 + type: string description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the number of times the task will be retried if failed. - retryCondition: + Should be specified only for *AVERAGE_DURATION and + *PERCENTILE_DURATION metrics. This member should be used to specify + what duration value the metrics should exceed for the alert to + trigger. + playbookUrl: type: string description: >- - Optional. The retry condition that will be evaluated for this - failure policy with the corresponding retry strategy. - retryStrategy: + Link to a playbook for resolving the issue that triggered this + alert. + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + onlyFinalAttempt: + type: boolean + description: >- + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + aggregationPeriod: + description: >- + For an EXPECTED_MIN threshold, this aggregation_period must be + lesser than 24 hours. + type: string + metricType: + enum: + - METRIC_TYPE_UNSPECIFIED + - EVENT_ERROR_RATE + - EVENT_WARNING_RATE + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - EVENT_RATE + - EVENT_AVERAGE_DURATION + - EVENT_PERCENTILE_DURATION + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION enumDescriptions: - - '' - >- - Ignores the failure of this task. The rest of the workflow will be - executed Assuming this task succeeded. + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. - >- - Causes a permanent failure of the task. However, if the last - task(s) of event was successfully completed despite the failure of - this task, it has no impact on the workflow. + Specifies alerting on the rate of errors for the enclosing + workflow. - >- - Causes a permanent failure of the event. It is different from NONE - because this will mark the event as FAILED by shutting down the - event execution. + Specifies alerting on the rate of warnings for the enclosing + workflow. Warnings use the same enum values as errors. - >- - The task will be retried from the failed task onwards after a - fixed delay. A max-retry count is required to be specified with - this strategy. A jitter is added to each exponential interval so - that concurrently failing tasks of the same type do not end up - retrying after the exact same exponential interval. - Max_num_retries and interval_in_seconds must be specified. + Specifies alerting on the rate of errors for any task in the + enclosing workflow. - >- - The task will be retried from the failed task onwards after a - fixed delay that linearly increases with each retry attempt. A - jitter is added to each exponential interval so that concurrently - failing tasks of the same type do not end up retrying after the - exact same exponential interval. A max-retry count is required to - be specified with this strategy. Max_num_retries and - interval_in_seconds must be specified. + Specifies alerting on the rate of warnings for any task in the + enclosing workflow. - >- - The task will be retried after an exponentially increasing period - of time with each failure. A jitter is added to each exponential - interval so that concurrently failing tasks of the same type do - not end up retrying after the exact same exponential interval. A - max-retry count is required to be specified with this strategy. - `max_num_retries` and `interval_in_seconds` must be specified. + Specifies alerting on the rate of executions over all tasks in the + enclosing workflow. - >- - The entire workflow will be restarted with the initial parameters - that were set when the event was fired. A max-retry count is - required to be specified with this strategy. `max_num_retries` and - `interval_in_seconds` must be specified. - enum: - - UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_WORKFLOW_WITH_BACKOFF - description: Defines what happens to the task upon failure. + Specifies alerting on the number of events executed in the given + aggregation_period. + - >- + Specifies alerting on the average duration of executions for this + workflow. + - >- + Specifies alerting on the duration value of a particular + percentile of workflow executions. E.g. If 10% or more of the + workflow executions have durations above 5 seconds, alert. + - >- + Specifies alerting on the average duration of any task in the + enclosing workflow, + - >- + Specifies alerting on the duration value of a particular + percentile of any task executions within the enclosing workflow. + E.g. If 10% or more of the task executions in the workflow have + durations above 5 seconds, alert. type: string - EnterpriseCrmEventbusProtoTaskMetadataAdmin: - id: EnterpriseCrmEventbusProtoTaskMetadataAdmin - type: object - properties: - userEmail: + numAggregationPeriods: + type: integer + description: >- + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + format: int32 + thresholdType: + description: >- + The threshold type, whether lower(expected_min) or + upper(expected_max), for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. type: string - googleGroupEmail: + enum: + - UNSPECIFIED_THRESHOLD_TYPE + - EXPECTED_MIN + - EXPECTED_MAX + enumDescriptions: + - '' + - >- + Note that this field will only trigger alerts if the workflow + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. + - '' + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + clientId: + description: Client associated with this alert configuration. type: string + thresholdValue: + description: >- + The metric value, above or below which the alert should be + triggered. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + alertDisabled: + description: >- + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + type: boolean + EnterpriseCrmFrontendsEventbusProtoEventParameters: description: >- - Admins are owners of a Task, and have all permissions on a particular - task identified by the task name. By default, Eventbus periodically - scans all task metadata and syncs (adds) any new admins defined here to - Zanzibar. - EnterpriseCrmFrontendsEventbusProtoParameterValueType: - id: EnterpriseCrmFrontendsEventbusProtoParameterValueType - description: 'To support various types of parameter values. Next available id: 14' + LINT.IfChange This message is used for processing and persisting (when + applicable) key value pair parameters for each event in the event bus. + Please see type: object + id: EnterpriseCrmFrontendsEventbusProtoEventParameters + properties: + parameters: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same workflow + execution. + EnterpriseCrmEventbusProtoValueType: + id: EnterpriseCrmEventbusProtoValueType + type: object + description: >- + Used for define type for values. Currently supported value types include + int, string, double, array, and any proto message. properties: - intArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray stringValue: type: string + intValue: + format: int64 + type: string stringArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray - serializedObjectValue: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' doubleValue: format: double type: number + booleanValue: + type: boolean doubleArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' protoValue: + type: object additionalProperties: - description: Properties of the object. Contains field @type with type URL. type: any - type: object - intValue: - format: int64 + description: Properties of the object. Contains field @type with type URL. + EnterpriseCrmEventbusProtoProtoArrayFunction: + type: object + id: EnterpriseCrmEventbusProtoProtoArrayFunction + properties: + functionName: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - jsonValue: + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: + description: Range used to validate doubles and floats. + type: object + properties: + max: + type: number + format: double + description: The inclusive maximum of the acceptable range. + min: + description: The inclusive minimum of the acceptable range. + type: number + format: double + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + GoogleCloudConnectorsV1AuthConfigUserPassword: + description: Parameters to support Username and Password Authentication. + type: object + properties: + username: + description: Username. type: string - booleanValue: - type: boolean - protoArray: + password: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Secret version reference containing the password. + id: GoogleCloudConnectorsV1AuthConfigUserPassword + EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: + type: object + description: Entry is a pair of key and value. + properties: + key: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - booleanArray: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + value: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray - GoogleCloudIntegrationsV1alphaBooleanParameterArray: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: + type: object + id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata properties: - booleanValues: + actions: items: - type: boolean + type: string + description: List of actions. type: array - description: Boolean array. - id: GoogleCloudIntegrationsV1alphaBooleanParameterArray - description: This message only contains a field of boolean array. + entities: + type: array + items: + type: string + description: List of entity names. + description: Metadata of runtime connection schema. + GoogleCloudConnectorsV1AuthConfig: + description: AuthConfig defines details of a authentication type. + properties: + authType: + enumDescriptions: + - Authentication type not specified. + - Username and Password Authentication. + - >- + JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant + based authentication + - Oauth 2.0 Client Credentials Grant Authentication + - SSH Public Key Authentication + - Oauth 2.0 Authorization Code Flow + - Google authentication + - >- + Oauth 2.0 Authorization Code Flow with Google Provided OAuth + Client + description: The type of authentication configured. + enum: + - AUTH_TYPE_UNSPECIFIED + - USER_PASSWORD + - OAUTH2_JWT_BEARER + - OAUTH2_CLIENT_CREDENTIALS + - SSH_PUBLIC_KEY + - OAUTH2_AUTH_CODE_FLOW + - GOOGLE_AUTHENTICATION + - OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED + type: string + oauth2JwtBearer: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer + description: Oauth2JwtBearer. + authKey: + description: Identifier key for auth config + type: string + additionalVariables: + type: array + description: List containing additional auth configs. + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + oauth2ClientCredentials: + description: Oauth2ClientCredentials. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + oauth2AuthCodeFlowGoogleManaged: + description: Oauth2AuthCodeFlowGoogleManaged. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + sshPublicKey: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' + description: SSH Public Key. + oauth2AuthCodeFlow: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow + description: Oauth2AuthCodeFlow. + userPassword: + description: UserPassword. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' type: object - EnterpriseCrmFrontendsEventbusProtoIntParameterArray: + id: GoogleCloudConnectorsV1AuthConfig + GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + description: Configurations for approving the Suspension. type: object - id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray properties: - intValues: + emailAddresses: + description: Email addresses to send approval request to. + items: + type: string + type: array + customMessage: + type: string + description: Information to provide for recipients. + expiration: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + description: >- + Indicates the next steps when no external actions happen on the + suspension. + GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: + id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse + description: Response containing all provisioned regions for Connector Platform. + properties: + regions: + description: All regions where Connector Platform is provisioned. items: type: string - format: int64 type: array - EnterpriseCrmEventbusProtoConditionalFailurePolicies: type: object + EnterpriseCrmFrontendsEventbusProtoStringParameterArray: properties: - defaultFailurePolicy: - description: >- - The default failure policy to be applied if no conditional failure - policy matches - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - failurePolicies: + stringValues: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - description: >- - The list of failure policies that will be applied to the task in - order. + type: string type: array - id: EnterpriseCrmEventbusProtoConditionalFailurePolicies - EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: - id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam + type: object + id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray + GoogleCloudIntegrationsV1alphaImportTemplateRequest: + description: Request to Import template + type: object properties: - allowedServiceAccountInContext: - type: boolean - scope: - description: A space-delimited list of requested scope permissions. + subIntegrations: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + type: object + description: Optional. Sub Integration which would be created via templates. + integrationRegion: type: string - authConfigId: - description: UUID of the AuthConfig. + description: Required. The region of the Integration to be created. + integration: + description: >- + Required. Name of the integration where template needs to be + imported. type: string - allowedCredentialTypes: + id: GoogleCloudIntegrationsV1alphaImportTemplateRequest + EnterpriseCrmFrontendsEventbusProtoParameterMap: + id: EnterpriseCrmFrontendsEventbusProtoParameterMap + properties: + entries: items: - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - enumDescriptions: - - '' - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - type: string + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry type: array + keyType: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' description: >- - Defines the credential types to be supported as Task may restrict - specific types to use, e.g. Cloud SQL Task will use - username/password type only. - useServiceAccountInContext: - type: boolean - type: object - GoogleCloudConnectorsV1ConnectionStatus: - type: object - properties: - status: - description: Status provides detailed information for the state. + Option to specify key value type for all entries of the map. If + provided then field types for all entries must conform to this. type: string - description: - description: Description. + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + valueType: type: string - state: enumDescriptions: - - Connection does not have a state yet. - - Connection is being created. - - Connection is running and ready for requests. - - Connection is stopped. - - Connection is being deleted. - - Connection is being updated. - - Connection is not running due to an error. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' - >- - Connection is not running because the authorization configuration - is not complete. - description: State. + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - INACTIVE - - DELETING - - UPDATING - - ERROR - - AUTHORIZATION_REQUIRED - type: string - description: ConnectionStatus indicates the state of the connection. - id: GoogleCloudConnectorsV1ConnectionStatus - EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. type: object + EnterpriseCrmEventbusProtoDoubleArrayFunction: properties: - intRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange - doubleRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange - stringRegex: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: - properties: - triggerUrl: + functionName: + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - description: The trigger url that will be returned - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse - description: Response for Creating Cloud Function rpc call. type: object - GoogleCloudIntegrationsV1alphaExecuteEventResponse: + id: EnterpriseCrmEventbusProtoDoubleArrayFunction + GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + description: The response for testing an integration. type: object properties: + eventParameters: + deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Details for the integration that were executed. executionId: type: string description: The id of the execution corresponding to this run of integration. - description: The response for executing an integration. - id: GoogleCloudIntegrationsV1alphaExecuteEventResponse - EnterpriseCrmEventbusProtoField: - description: Information about the value and type of the field. + executionFailed: + description: Is true if any execution in the integration failed. False otherwise. + type: boolean + parameterEntries: + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: array + deprecated: true + parameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: >- + Optional. Parameters are a part of Event and can be used to + communicate between different tasks that are part of the same + integration execution. + type: object + EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry properties: - fieldType: + defaultValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + description: >- + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + producer: + type: string + producedBy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNodeIdentifier' + description: >- + The identifier of the node (TaskConfig/TriggerConfig) this parameter + was produced by, if it is a transient param or a copy of an input + param. + containsLargeData: + type: boolean + description: >- + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + inOutType: + enumDescriptions: + - '' + - >- + Input parameters for the workflow. EventBus validates that these + parameters exist in the workflows before execution. + - >- + Output Parameters for the workflow. EventBus will only return the + workflow parameters tagged with OUT in the response back. + - >- + Input or Output Parameters. These can be used as both input and + output. EventBus will validate for the existence of these + parameters before execution and will also return this parameter + back in the response. + enum: + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT + description: Specifies the input/output type for the parameter. + type: string + required: + type: boolean + key: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the workflow definition. + type: string + dataType: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + type: string enum: - DATA_TYPE_UNSPECIFIED - STRING_VALUE @@ -8995,6 +8816,158 @@ components: - BYTES_ARRAY - NON_SERIALIZABLE_OBJECT - JSON_VALUE + description: The data type of the parameter. + attributes: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' + description: Metadata information about the parameters. + protoDefName: + description: >- + The name of the protobuf type if the parameter has a protobuf data + type. + type: string + jsonSchema: + description: >- + This schema will be used to validate runtime JSON-typed values of + this parameter. + type: string + protoDefPath: + description: >- + If the data type is of type proto or proto array, this field needs + to be populated with the fully qualified proto name. This message, + for example, would be + "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + type: string + name: + description: >- + The name (without prefix) to be displayed in the UI for this + parameter. E.g. if the key is "foo.bar.myName", then the name would + be "myName". + type: string + description: + description: Optional. The description about the parameter + type: string + children: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + description: >- + Child parameters nested within this parameter. This field only + applies to protobuf parameters + isTransient: + description: Whether this parameter is a transient parameter. + type: boolean + type: object + EnterpriseCrmEventbusProtoTriggerCriteria: + properties: + triggerCriteriaTaskImplementationClassName: + type: string + description: >- + Optional. Implementation class name. The class should implement the + “TypedTask” interface. + parameters: + description: Optional. To be used in TaskConfig for the implementation class. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + condition: + type: string + description: >- + Required. Standard filter expression, when true the workflow will be + executed. If there's no + trigger_criteria_task_implementation_class_name specified, the + condition will be validated directly. + type: object + id: EnterpriseCrmEventbusProtoTriggerCriteria + EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: + description: >- + The threshold value of the metric, above or below which the alert should + be triggered. See EventAlertConfig or TaskAlertConfig for the different + alert metric types in each case. For the *RATE metrics, one or both of + these fields may be set. Zero is the default value and can be left at + that. For *PERCENTILE_DURATION metrics, one or both of these fields may + be set, and also, the duration threshold value should be specified in + the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, + these fields should not be set at all. A different member, + threshold_duration_ms, must be set in the EventAlertConfig or the + TaskAlertConfig. + properties: + percentage: + format: int32 + type: integer + absolute: + type: string + format: int64 + id: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + type: object + GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: + properties: + scope: + type: string + description: A space-delimited list of requested scope permissions. + clientId: + type: string + description: The client's ID. + accessToken: + description: Access token fetched from the authorization server. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + username: + type: string + description: The user's username. + clientSecret: + type: string + description: The client's secret. + password: + description: The user's password. + type: string + tokenParams: + description: Token parameters for the auth request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + tokenEndpoint: + description: >- + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. + type: string + requestType: + enumDescriptions: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + description: Represent how to pass parameters to fetch access token + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + type: string + description: >- + For resource owner credentials grant, the client will ask the user for + their authorization credentials (ususally a username and password) and + send a POST request to the authorization server. The authorization + server will respond with a JSON object containing the access token. + type: object + id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + EnterpriseCrmEventbusProtoProtoFunction: + properties: + functionName: + enum: + - UNSPECIFIED + - GET_STRING_SUBFIELD + - GET_INT_SUBFIELD + - GET_DOUBLE_SUBFIELD + - GET_BOOLEAN_SUBFIELD + - GET_STRING_ARRAY_SUBFIELD + - GET_INT_ARRAY_SUBFIELD + - GET_DOUBLE_ARRAY_SUBFIELD + - GET_BOOLEAN_ARRAY_SUBFIELD + - GET_PROTO_ARRAY_SUBFIELD + - GET_PROTO_SUBFIELD + - TO_JSON + - GET_BYTES_SUBFIELD_AS_UTF_8_STRING + - GET_BYTES_SUBFIELD_AS_PROTO + - EQUALS + type: string enumDescriptions: - '' - '' @@ -9010,184 +8983,205 @@ components: - '' - '' - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - '' - - '' - description: Specifies the data type of the field. + type: object + id: EnterpriseCrmEventbusProtoProtoFunction + GoogleCloudIntegrationsV1alphaAttemptStats: + id: GoogleCloudIntegrationsV1alphaAttemptStats + properties: + endTime: + description: The end time of the integration execution for current attempt. + format: google-datetime type: string - transformExpression: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - description: >- - This is the transform expression to fetch the input field value. for - e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can - have a transform expression. 2. If a transform expression is - provided, reference_key will be ignored. 3. If no value is returned - after evaluation of transform expression, default_value can be - mapped if provided. 4. The field_type should be the type of the - final object returned after the transform expression is evaluated. - Scrubs the transform expression before logging as value provided by - user so may or may not contain PII or SPII data. - defaultValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: >- - This holds the default values for the fields. This value is supplied - by user so may or may not contain PII or SPII data. - protoDefPath: + startTime: + format: google-datetime type: string description: >- - Optional. The fully qualified proto name (e.g. - enterprise.crm.storage.Account). Required for output field of type - PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES - and output field_type is PROTO_VALUE, then fully qualified proto - type url should be provided to parse the input bytes. If field_type - is *_ARRAY, then all the converted protos are of the same type. - cardinality: + The start time of the integration execution for current attempt. + This could be in the future if it's been scheduled. + description: Status for the execution attempt. + type: object + EnterpriseCrmEventbusProtoExternalTraffic: + id: EnterpriseCrmEventbusProtoExternalTraffic + type: object + properties: + retryRequestForQuota: + type: boolean + description: Enqueue the execution request due to quota issue + gcpProjectNumber: + description: User’s GCP project number the traffic is referring to. type: string + source: enumDescriptions: - - For fields with unspecified cardinality. - - >- - If field cardinality is set to optional, ignore errors if input - field value is null or the reference_key is not found. - description: >- - By default, if the cardinality is unspecified the field is - considered required while mapping. + - '' + - '' + - '' + type: string enum: - - UNSPECIFIED - - OPTIONAL - referenceKey: + - SOURCE_UNSPECIFIED + - APIGEE + - SECURITY + gcpProjectId: + description: User’s GCP project id the traffic is referring to. + type: string + location: + description: Location for the user's request. type: string + enableInternalIp: + type: boolean description: >- - This holds the reference key of the workflow or task parameter. 1. - Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input - or output parameter, for e.g. $task1_param1$. 3. Any workflow or - task parameters with subfield references, for e.g., - $task1_param1.employee.id$ - type: object - id: EnterpriseCrmEventbusProtoField - EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: + Indicates the client enables internal IP feature, this is applicable + for internal clients only. + description: Represents external traffic type and id. + GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: properties: - endTime: - format: int64 - description: The end time of the task execution for current attempt. + updateTime: + format: google-datetime + description: Output only. Timestamp when the webhook was last updated. + readOnly: true type: string - startTime: + additionalVariables: + description: Output only. Additional webhook related field values. + type: array + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + readOnly: true + id: + description: Output only. ID to uniquely identify webhook. + type: string + readOnly: true + name: + description: Output only. Name of the Webhook + type: string + readOnly: true + nextRefreshTime: + readOnly: true type: string description: >- - The start time of the task execution for current attempt. This could - be in the future if it's been scheduled. - format: int64 + Output only. Next webhook refresh time. Will be null if refresh is + not supported. + format: google-datetime + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. Timestamp when the webhook was created. + id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + description: WebhookData has details of webhook configuration. type: object - id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats - EnterpriseCrmEventbusProtoBuganizerNotification: - id: EnterpriseCrmEventbusProtoBuganizerNotification + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: + description: Response for CreateAppsScriptProject rpc call. type: object + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse properties: - title: - description: Title of the issue to be created. Required. + projectId: type: string - templateId: - format: int64 - description: ID of the buganizer template to use. Optional. + description: The created AppsScriptProject ID. + EnterpriseCrmEventbusProtoLoopMetadata: + properties: + currentIterationCount: type: string - assigneeEmailAddress: - description: Whom to assign the new bug. Optional. + description: Starting from 1, not 0. + format: int64 + failureLocation: + enum: + - UNKNOWN + - SUBWORKFLOW + - PARAM_OVERRIDING + - PARAM_AGGREGATING + - SETTING_ITERATION_ELEMENT + - GETTING_LIST_TO_ITERATE + - CONDITION_EVALUATION + - BUILDING_REQUEST + enumDescriptions: + - No error or Unknown. + - Subworkflow failed while firing/running. + - Param overrides failed. + - Param aggregation failed. + - Setting for loop current element failed. + - Getting the list to iterate. + - Evaluating the while loop condition. + - Building the iteration request + description: Indicates where in the loop logic did it error out. type: string - componentId: + currentIterationDetail: type: string description: >- - ID of the buganizer component within which to create a new issue. - Required. - format: int64 - GoogleCloudIntegrationsV1alphaParameterMapField: - properties: - literalValue: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Passing a literal value. - referenceKey: + Needs to be set by the loop impl class before each iteration. The + abstract loop class will append the request and response to it. Eg. + The foreach Loop will clean up and set it as the current iteration + element at the start of each loop. The post request and response + will be appended to the value once they are available. + errorMsg: + description: Add the error message when loops fail. type: string - description: Referencing one of the Integration variables. - id: GoogleCloudIntegrationsV1alphaParameterMapField - description: Field represents either the key or value in an entry. + id: EnterpriseCrmEventbusProtoLoopMetadata type: object - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: - description: Request for UploadIntegrationVersion. + GoogleCloudIntegrationsV1alphaCloudKmsConfig: type: object + description: Configuration information for Client's Cloud KMS information properties: - fileFormat: - enumDescriptions: - - Unspecified file format - - JSON File Format - - YAML File Format - enum: - - FILE_FORMAT_UNSPECIFIED - - JSON - - YAML + kmsLocation: type: string - description: File format for upload request. - content: - description: The textproto of the integration_version. + description: Required. Location name of the key ring, e.g. "us-west1". + kmsProjectId: + description: >- + Optional. The gcp project id of the project where the kms key + stored. If empty, the kms key is stored at the same project as + customer's project and ecrypted with CMEK, otherwise, the kms key is + stored in the tenant project and encrypted with GMEK type: string - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest - EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: - id: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - type: object - description: >- - The threshold value of the metric, above or below which the alert should - be triggered. See EventAlertConfig or TaskAlertConfig for the different - alert metric types in each case. For the *RATE metrics, one or both of - these fields may be set. Zero is the default value and can be left at - that. For *PERCENTILE_DURATION metrics, one or both of these fields may - be set, and also, the duration threshold value should be specified in - the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, - these fields should not be set at all. A different member, - threshold_duration_ms, must be set in the EventAlertConfig or the - TaskAlertConfig. - properties: - percentage: - type: integer - format: int32 - absolute: + key: + type: string + description: >- + Required. A Cloud KMS key is a named object containing one or more + key versions, along with metadata for the key. A key exists on + exactly one key ring tied to a specific location. + keyVersion: type: string - format: int64 - GoogleCloudIntegrationsV1alphaGetClientResponse: - id: GoogleCloudIntegrationsV1alphaGetClientResponse - description: Response for the GetClient rpc + description: >- + Optional. Each version of a key contains key material used for + encryption or signing. A key's version is represented by an integer, + starting at 1. To decrypt data or verify a signature, you must use + the same key version that was used to encrypt or sign the data. + kmsRing: + description: >- + Required. A key ring organizes keys in a specific Google Cloud + location and allows you to manage access control on groups of keys. + A key ring's name does not need to be unique across a Google Cloud + project, but must be unique within a given location. + type: string + id: GoogleCloudIntegrationsV1alphaCloudKmsConfig + EnterpriseCrmEventbusProtoEventBusProperties: + description: >- + LINT.IfChange This message is used for storing key value pair properties + for each Event / Task in the EventBus. type: object properties: - client: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' - description: 'Required. Required: The client configuration that was requested' - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: + properties: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' + description: An unordered list of property entries. + type: array + id: EnterpriseCrmEventbusProtoEventBusProperties + EnterpriseCrmEventbusProtoNextTeardownTask: properties: - max: - type: number - description: The inclusive maximum of the acceptable range. - format: double - min: - description: The inclusive minimum of the acceptable range. - format: double - type: number - description: Range used to validate doubles and floats. + name: + type: string + description: Required. Name of the next teardown task. + description: >- + The teardown task that is next in line to be executed. We support only + sequential execution of teardown tasks (i.e. no branching). type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + id: EnterpriseCrmEventbusProtoNextTeardownTask parameters: - key: + quotaUser: 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. - in: query - name: key - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: upload_protocol + name: quotaUser schema: type: string _.xgafv: @@ -9199,18 +9193,39 @@ components: enum: - '1' - '2' - access_token: - description: OAuth access token. + 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. in: query - name: access_token + name: key + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string alt: description: Data format for response. in: query @@ -9221,1035 +9236,1033 @@ components: - json - media - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token schema: type: string x-stackQL-resources: - versions: - id: google.integrations.versions - name: versions - title: Versions + callback: + id: google.integrations.callback + name: callback + title: Callback methods: - projects_locations_integrations_versions_publish: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_integrations_versions_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_integrations_versions_list: + callback_generate_token: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get + $ref: '#/paths/~1v1~1callback:generateToken/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_integrations_versions_upload: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + clientmetadata: + id: google.integrations.clientmetadata + name: clientmetadata + title: Clientmetadata + methods: + projects_get_clientmetadata: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_download_json_package: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata + insert: [] + update: [] + replace: [] + delete: [] + clients: + id: google.integrations.clients + name: clients + title: Clients + methods: + projects_locations_clients_provision: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:downloadJsonPackage/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_patch: + projects_locations_clients_switch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_delete: + projects_locations_clients_replace: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_get: + projects_locations_clients_switch_variable_masking: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_unpublish: + projects_locations_clients_deprovision: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_download: + projects_locations_get_clients: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_unpublish: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/clients/methods/projects_locations_clients_replace + delete: [] + auth_configs: + id: google.integrations.auth_configs + name: auth_configs + title: Auth_configs + methods: + projects_locations_auth_configs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_create: + projects_locations_auth_configs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_list: + objectKey: $.authConfigs + projects_locations_auth_configs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_products_integrations_versions_takeover_edit_lock: + projects_locations_auth_configs_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_download: + projects_locations_auth_configs_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_patch: + projects_locations_products_auth_configs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_get: + objectKey: $.authConfigs + projects_locations_products_auth_configs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_delete: + projects_locations_products_auth_configs_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_upload: + projects_locations_products_auth_configs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_publish: + projects_locations_products_auth_configs_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_get - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_get - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_list - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_list insert: - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_create + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_create - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_create + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_create update: - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_patch + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_patch - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_patch + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_delete + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_delete - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_delete - suspensions: - id: google.integrations.suspensions - name: suspensions - title: Suspensions + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_delete + apps_script_projects: + id: google.integrations.apps_script_projects + name: apps_script_projects + title: Apps_script_projects methods: - projects_locations_integrations_executions_suspensions_lift: + projects_locations_apps_script_projects_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_suspensions_resolve: + projects_locations_apps_script_projects_link: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_suspensions_list: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create + update: [] + replace: [] + delete: [] + runtime_action_schemas: + id: google.integrations.runtime_action_schemas + name: runtime_action_schemas + title: Runtime_action_schemas + methods: + projects_locations_connections_runtime_action_schemas_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeActionSchemas/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.suspensions - projects_locations_products_integrations_executions_suspensions_list: + objectKey: $.runtimeActionSchemas + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_action_schemas/methods/projects_locations_connections_runtime_action_schemas_list + insert: [] + update: [] + replace: [] + delete: [] + runtime_entity_schemas: + id: google.integrations.runtime_entity_schemas + name: runtime_entity_schemas + title: Runtime_entity_schemas + methods: + projects_locations_connections_runtime_entity_schemas_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeEntitySchemas/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.suspensions - projects_locations_products_integrations_executions_suspensions_lift: + objectKey: $.runtimeEntitySchemas + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_entity_schemas/methods/projects_locations_connections_runtime_entity_schemas_list + insert: [] + update: [] + replace: [] + delete: [] + connections_connection_schema_metadata: + id: google.integrations.connections_connection_schema_metadata + name: connections_connection_schema_metadata + title: Connections_connection_schema_metadata + methods: + projects_locations_connections_get_connection_schema_metadata: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_suspensions_resolve: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections_connection_schema_metadata/methods/projects_locations_connections_get_connection_schema_metadata + insert: [] + update: [] + replace: [] + delete: [] + connections: + id: google.integrations.connections + name: connections + title: Connections + methods: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.connections sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/suspensions/methods/projects_locations_products_integrations_executions_suspensions_list - - $ref: >- - #/components/x-stackQL-resources/suspensions/methods/projects_locations_integrations_executions_suspensions_list + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list insert: [] update: [] replace: [] delete: [] - executions: - id: google.integrations.executions - name: executions - title: Executions + certificates: + id: google.integrations.certificates + name: certificates + title: Certificates methods: - projects_locations_integrations_executions_list: + projects_locations_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions - projects_locations_integrations_executions_download: + projects_locations_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_get: + projects_locations_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_get: + projects_locations_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_download: + projects_locations_certificates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_list: + objectKey: $.certificates + projects_locations_products_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_certificates_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.certificates + projects_locations_products_certificates_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_certificates_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_certificates_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_get + #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_get - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_get + #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_get - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_list + #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_list - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_list - insert: [] - update: [] + #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_list + insert: + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_create + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_create + update: + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_patch + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_patch replace: [] - delete: [] - integrations: - id: google.integrations.integrations - name: integrations - title: Integrations + delete: + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_delete + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_delete + sfdc_instances: + id: google.integrations.sfdc_instances + name: sfdc_instances + title: Sfdc_instances methods: - projects_locations_integrations_list: + projects_locations_sfdc_instances_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations - projects_locations_integrations_execute: + projects_locations_sfdc_instances_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_delete: + projects_locations_sfdc_instances_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_test: + projects_locations_sfdc_instances_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_schedule: + projects_locations_sfdc_instances_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_test: + objectKey: $.sfdcInstances + projects_locations_products_sfdc_instances_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:test/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_execute: + projects_locations_products_sfdc_instances_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_schedule: + projects_locations_products_sfdc_instances_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:schedule/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_list: + projects_locations_products_sfdc_instances_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_sfdc_instances_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations + objectKey: $.sfdcInstances sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list - insert: [] - update: [] + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_create + update: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_patch + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete - skip_this_resource: - id: google.integrations.skip_this_resource - name: skip_this_resource - title: Skip_this_resource - methods: - projects_locations_integrations_execute_event: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - connections_connection_schema_metadata: - id: google.integrations.connections_connection_schema_metadata - name: connections_connection_schema_metadata - title: Connections_connection_schema_metadata + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete + sfdc_channels: + id: google.integrations.sfdc_channels + name: sfdc_channels + title: Sfdc_channels methods: - projects_locations_connections_get_connection_schema_metadata: + projects_locations_sfdc_instances_sfdc_channels_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections_connection_schema_metadata/methods/projects_locations_connections_get_connection_schema_metadata - insert: [] - update: [] - replace: [] - delete: [] - connections: - id: google.integrations.connections - name: connections - title: Connections - methods: - projects_locations_connections_list: + projects_locations_sfdc_instances_sfdc_channels_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - insert: [] - update: [] - replace: [] - delete: [] - runtime_action_schemas: - id: google.integrations.runtime_action_schemas - name: runtime_action_schemas - title: Runtime_action_schemas - methods: - projects_locations_connections_runtime_action_schemas_list: + projects_locations_sfdc_instances_sfdc_channels_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeActionSchemas/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runtimeActionSchemas - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/runtime_action_schemas/methods/projects_locations_connections_runtime_action_schemas_list - insert: [] - update: [] - replace: [] - delete: [] - runtime_entity_schemas: - id: google.integrations.runtime_entity_schemas - name: runtime_entity_schemas - title: Runtime_entity_schemas - methods: - projects_locations_connections_runtime_entity_schemas_list: + projects_locations_sfdc_instances_sfdc_channels_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeEntitySchemas/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runtimeEntitySchemas - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/runtime_entity_schemas/methods/projects_locations_connections_runtime_entity_schemas_list - insert: [] - update: [] - replace: [] - delete: [] - templates: - id: google.integrations.templates - name: templates - title: Templates - methods: - projects_locations_templates_get: + objectKey: $.sfdcChannels + projects_locations_sfdc_instances_sfdc_channels_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_patch: + projects_locations_products_sfdc_instances_sfdc_channels_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_delete: + projects_locations_products_sfdc_instances_sfdc_channels_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_share: + projects_locations_products_sfdc_instances_sfdc_channels_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:share/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_upload: + projects_locations_products_sfdc_instances_sfdc_channels_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_use: + objectKey: $.sfdcChannels + projects_locations_products_sfdc_instances_sfdc_channels_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:use/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_import: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_list + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_create + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_create + update: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_patch + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_delete + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_delete + executions: + id: google.integrations.executions + name: executions + title: Executions + methods: + projects_locations_products_integrations_executions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_list: + projects_locations_products_integrations_executions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.templates - projects_locations_templates_create: + objectKey: $.executions + projects_locations_products_integrations_executions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_unshare: + projects_locations_integrations_executions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:unshare/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_download: + projects_locations_integrations_executions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_search: + projects_locations_integrations_executions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:search/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.executions sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_get + #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_get - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_list - insert: + #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_list - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_create - update: + #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_get - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_patch + #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_list + insert: [] + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_delete - clients: - id: google.integrations.clients - name: clients - title: Clients + delete: [] + suspensions: + id: google.integrations.suspensions + name: suspensions + title: Suspensions methods: - projects_locations_clients_replace: + projects_locations_products_integrations_executions_suspensions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_deprovision: + objectKey: $.suspensions + projects_locations_products_integrations_executions_suspensions_resolve: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_switch: + projects_locations_products_integrations_executions_suspensions_lift: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_switch_variable_masking: + projects_locations_integrations_executions_suspensions_resolve: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_provision: + projects_locations_integrations_executions_suspensions_lift: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_get_clients: + projects_locations_integrations_executions_suspensions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.suspensions sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients + #/components/x-stackQL-resources/suspensions/methods/projects_locations_products_integrations_executions_suspensions_list + - $ref: >- + #/components/x-stackQL-resources/suspensions/methods/projects_locations_integrations_executions_suspensions_list insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/clients/methods/projects_locations_clients_replace + replace: [] delete: [] - auth_configs: - id: google.integrations.auth_configs - name: auth_configs - title: Auth_configs + versions: + id: google.integrations.versions + name: versions + title: Versions methods: - projects_locations_auth_configs_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_auth_configs_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_auth_configs_get: + projects_locations_products_integrations_versions_publish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_patch: + projects_locations_products_integrations_versions_takeover_edit_lock: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_delete: + projects_locations_products_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_create: + projects_locations_products_integrations_versions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_list: + projects_locations_products_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_products_auth_configs_get: + projects_locations_products_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_patch: + projects_locations_products_integrations_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_delete: + objectKey: $.integrationVersions + projects_locations_products_integrations_versions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_get - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_get - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_list - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_list - insert: - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_create - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_create - update: - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_patch - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_delete - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_delete - cloud_functions: - id: google.integrations.cloud_functions - name: cloud_functions - title: Cloud_functions - methods: - projects_locations_cloud_functions_create: + projects_locations_products_integrations_versions_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_cloud_functions_create: + projects_locations_products_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_products_cloud_functions_create - - $ref: >- - #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create - update: [] - replace: [] - delete: [] - sfdc_channels: - id: google.integrations.sfdc_channels - name: sfdc_channels - title: Sfdc_channels - methods: - projects_locations_sfdc_instances_sfdc_channels_patch: + projects_locations_integrations_versions_publish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_get: + projects_locations_integrations_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_delete: + objectKey: $.integrationVersions + projects_locations_integrations_versions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_list: + projects_locations_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcChannels - projects_locations_sfdc_instances_sfdc_channels_create: + projects_locations_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_list: + projects_locations_integrations_versions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcChannels - projects_locations_products_sfdc_instances_sfdc_channels_create: + projects_locations_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_patch: + projects_locations_integrations_versions_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_delete: + projects_locations_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_get: + projects_locations_integrations_versions_download_json_package: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:downloadJsonPackage/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_get + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_get + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_list + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_list + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list insert: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_create + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_create - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_create + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_create update: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_patch + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_patch - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_patch + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_delete + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_delete - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_delete - sfdc_instances: - id: google.integrations.sfdc_instances - name: sfdc_instances - title: Sfdc_instances + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_delete + integrations: + id: google.integrations.integrations + name: integrations + title: Integrations methods: - projects_locations_sfdc_instances_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_sfdc_instances_delete: + projects_locations_products_integrations_test: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:test/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_get: + projects_locations_products_integrations_execute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_list: + projects_locations_products_integrations_schedule: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:schedule/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_sfdc_instances_create: + projects_locations_products_integrations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_delete: + objectKey: $.integrations + projects_locations_integrations_test: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_get: + projects_locations_integrations_execute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_patch: + projects_locations_integrations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_list: + objectKey: $.integrations + projects_locations_integrations_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_products_sfdc_instances_create: + projects_locations_integrations_schedule: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list - insert: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_create - update: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_patch + #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_patch + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list + insert: [] + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete - apps_script_projects: - id: google.integrations.apps_script_projects - name: apps_script_projects - title: Apps_script_projects + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete + cloud_functions: + id: google.integrations.cloud_functions + name: cloud_functions + title: Cloud_functions methods: - projects_locations_apps_script_projects_link: + projects_locations_products_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_apps_script_projects_create: + projects_locations_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' @@ -10257,149 +10270,136 @@ components: select: [] insert: - $ref: >- - #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create + #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_products_cloud_functions_create + - $ref: >- + #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create update: [] replace: [] delete: [] - certificates: - id: google.integrations.certificates - name: certificates - title: Certificates + skip_this_resource: + id: google.integrations.skip_this_resource + name: skip_this_resource + title: Skip_this_resource methods: - projects_locations_certificates_create: + projects_locations_integrations_execute_event: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_list: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + templates: + id: google.integrations.templates + name: templates + title: Templates + methods: + projects_locations_templates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.certificates - projects_locations_certificates_get: + projects_locations_templates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_patch: + projects_locations_templates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_delete: + projects_locations_templates_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_list: + projects_locations_templates_unshare: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:unshare/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.certificates - projects_locations_products_certificates_create: + projects_locations_templates_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_get: + projects_locations_templates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_delete: + projects_locations_templates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_patch: + objectKey: $.templates + projects_locations_templates_import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:import/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_templates_use: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:use/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_templates_search: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:search/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_templates_share: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:share/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_get - - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_get - - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_list + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_get - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_list + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_list insert: - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_create - - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_create + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_create update: - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_patch - - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_patch + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_delete - - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_delete - clientmetadata: - id: google.integrations.clientmetadata - name: clientmetadata - title: Clientmetadata - methods: - projects_get_clientmetadata: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata - insert: [] - update: [] - replace: [] - delete: [] - callback: - id: google.integrations.callback - name: callback - title: Callback - methods: - callback_generate_token: - operation: - $ref: '#/paths/~1v1~1callback:generateToken/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_delete connector_platform_regions: id: google.integrations.connector_platform_regions name: connector_platform_regions @@ -10418,34 +10418,97 @@ components: replace: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + /v1/callback:generateToken: parameters: &ref_1 - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/uploadType' - post: + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + get: description: >- - This RPC throws an exception if the integration is in ARCHIVED or ACTIVE - state. This RPC throws an exception if the version being published is - DRAFT, and if the `locked_by` user is not the same as the user - performing the Publish. Audit fields updated include - last_published_timestamp, last_published_by, last_modified_timestamp, - last_modified_by. Any existing lock is on this integration is released. - operationId: integrations.projects.locations.integrations.versions.publish + Receives the auth code and auth config id to combine that with the + client id and secret to retrieve access tokens from the token endpoint. + Returns either a success or error message when it's done. + operationId: integrations.callback.generateToken + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse + parameters: + - in: query + name: state + schema: + type: string + - in: query + name: gcpProjectId + schema: + type: string + - in: query + name: code + schema: + type: string + - in: query + name: product + schema: + type: string + - in: query + name: redirectUri + schema: + type: string + /v1/projects/{projectsId}/clientmetadata: + parameters: *ref_1 + get: + description: Gets the metadata info for the requested client + operationId: integrations.projects.getClientmetadata + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: + parameters: *ref_1 + post: + description: >- + Perform the provisioning steps to enable a user GCP project to use IP. + If GCP project already registered on IP end via Apigee Integration, + provisioning will fail. + operationId: integrations.projects.locations.clients.provision requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10457,8 +10520,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10470,27 +10532,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: + /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: parameters: *ref_1 post: - description: Create a integration with a draft version in the specified project. - operationId: integrations.projects.locations.integrations.versions.create + description: Update client from GMEK to CMEK + operationId: integrations.projects.locations.clients.switch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10502,8 +10554,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10515,22 +10566,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: newIntegration - schema: - type: boolean - - in: query - name: createSampleIntegrations - schema: - type: boolean - get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.integrations.versions.list + /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: + parameters: *ref_1 + post: + description: Update run-as service account for provisioned client + operationId: integrations.projects.locations.clients.replace + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10542,8 +10588,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10555,49 +10600,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: fieldMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: + /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: parameters: *ref_1 post: - description: >- - Uploads an integration. The content can be a previously downloaded - integration. Performs the same function as - CreateDraftIntegrationVersion, but accepts input in a string format, - which holds the complete representation of the IntegrationVersion - content. - operationId: integrations.projects.locations.integrations.versions.upload + description: Update variable masking for provisioned client + operationId: integrations.projects.locations.clients.switchVariableMasking requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10609,8 +10622,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10622,21 +10634,19 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: + /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: parameters: *ref_1 - get: + post: description: >- - Downloads an Integration version package like - IntegrationVersion,Integration Config etc. Retrieves the - IntegrationVersion package for a given `integration_id` and returns the - response as a JSON. - operationId: >- - integrations.projects.locations.integrations.versions.downloadJsonPackage + Perform the deprovisioning steps to disable a user GCP project to use IP + and purge all related data in a wipeout-compliant way. + operationId: integrations.projects.locations.clients.deprovision + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10648,8 +10658,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10661,31 +10670,20 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - - in: query - name: files - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: parameters: *ref_1 - patch: - description: Update a integration with a draft version in the specified project. - operationId: integrations.projects.locations.integrations.versions.patch + post: + description: >- + Creates an auth config record. Fetch corresponding credentials for + specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. + Encrypt the auth config with Cloud KMS and store the encrypted + credentials in Spanner. Returns the encrypted auth config. + operationId: integrations.projects.locations.authConfigs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10697,8 +10695,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -10710,33 +10707,23 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: clientCertificate.sslCertificate schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: clientCertificate.encryptedPrivateKey schema: type: string - in: query - name: updateMask + name: clientCertificate.passphrase schema: type: string - format: google-fieldmask - delete: + get: description: >- - Soft-deletes the integration. Changes the status of the integration to - ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag - is removed from this snapshot and set to the previous non-ARCHIVED - snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. - This RPC throws an exception if the version being deleted is DRAFT, and - if the `locked_by` user is not the same as the user performing the - Delete. Audit fields updated include last_modified_timestamp, - last_modified_by. Any existing lock is released when Deleting a - integration. Currently, there is no undelete mechanism. - operationId: integrations.projects.locations.integrations.versions.delete + Lists all auth configs that match the filter. Restrict to auth configs + belong to the current client only. + operationId: integrations.projects.locations.authConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10748,7 +10735,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -10760,19 +10748,32 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: + parameters: *ref_1 get: - description: Get a integration in the specified project. - operationId: integrations.projects.locations.integrations.versions.get + description: >- + Gets a complete auth config. If the auth config doesn't exist, + Code.NOT_FOUND exception will be thrown. Returns the decrypted auth + config. + operationId: integrations.projects.locations.authConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10784,8 +10785,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -10798,31 +10798,23 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: - parameters: *ref_1 - post: + patch: description: >- - Sets the status of the ACTIVE integration to SNAPSHOT with a new tag - "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and - "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if - the version being snapshot is not ACTIVE. Audit fields added include - action, action_by, action_timestamp. - operationId: integrations.projects.locations.integrations.versions.unpublish + Updates an auth config. If credential is updated, fetch the encrypted + auth config from Spanner, decrypt with Cloud KMS key, update the + credential fields, re-encrypt with Cloud KMS key and update the Spanner + record. For other fields, directly update the Spanner record. Returns + the encrypted auth config. + operationId: integrations.projects.locations.authConfigs.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10834,7 +10826,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -10847,22 +10839,30 @@ paths: schema: type: string - in: path - name: integrationsId + name: authConfigsId required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: clientCertificate.sslCertificate schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: - parameters: *ref_1 - get: - description: >- - Downloads an integration. Retrieves the `IntegrationVersion` for a given - `integration_id` and returns the response as a string. - operationId: integrations.projects.locations.integrations.versions.download + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: clientCertificate.passphrase + schema: + type: string + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.authConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10874,8 +10874,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10888,37 +10887,21 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: authConfigsId required: true schema: type: string - - in: query - name: files - schema: - type: string - - in: query - name: fileFormat - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: parameters: *ref_1 post: - description: >- - * Lifts suspension for the Suspension task. Fetch corresponding - suspension with provided suspension Id, resolve suspension, and set up - suspension result for the Suspension Task. - operationId: integrations.projects.locations.integrations.executions.suspensions.lift + description: Creates an Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10931,7 +10914,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse parameters: - in: path name: projectsId @@ -10943,36 +10926,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: suspensionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: parameters: *ref_1 post: - description: >- - * Resolves (lifts/rejects) any number of suspensions. If the integration - is already running, only the status of the suspension is updated. - Otherwise, the suspended integration will begin execution again. - operationId: >- - integrations.projects.locations.integrations.executions.suspensions.resolve + description: Links a existing Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.link requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10985,7 +10949,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse parameters: - in: path name: projectsId @@ -10997,29 +10961,13 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: suspensionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: parameters: *ref_1 get: description: >- - * Lists suspensions associated with a specific execution. Only those - with permissions to resolve the relevant suspensions will be able to - view them. - operationId: integrations.projects.locations.integrations.executions.suspensions.list + Lists the JSON schemas for the inputs and outputs of actions, filtered + by action name. + operationId: integrations.projects.locations.connections.runtimeActionSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11032,7 +10980,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse parameters: - in: path name: projectsId @@ -11045,21 +10993,12 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: connectionsId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + name: pageToken schema: type: string - in: query @@ -11068,18 +11007,16 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions: + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: parameters: *ref_1 get: description: >- - Lists the results of all the integration executions. The response - includes the same information as the [execution - log](https://cloud.google.com/application-integration/docs/viewing-logs) - in the Integration UI. - operationId: integrations.projects.locations.integrations.executions.list + Lists the JSON schemas for the properties of runtime entities, filtered + by entity name. + operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11092,7 +11029,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse parameters: - in: path name: projectsId @@ -11105,99 +11042,108 @@ paths: schema: type: string - in: path - name: integrationsId + name: connectionsId required: true schema: type: string - in: query - name: filterParams.parameterValue + name: pageToken schema: type: string - in: query - name: snapshotMetadataWithoutParams + name: filter schema: - type: boolean + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filterParams.parameterPairKey + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: + parameters: *ref_1 + get: + description: Lists the available entities and actions associated with a Connection. + operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filterParams.parameterKey + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filterParams.parameterType + - in: path + name: connectionsId + required: true schema: type: string - - in: query - name: filterParams.eventStatuses + /v1/projects/{projectsId}/locations/{locationsId}/connections: + parameters: *ref_1 + get: + description: Lists Connections in a given project and location. + operationId: integrations.projects.locations.connections.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filterParams.executionId + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: refreshAcl - schema: - type: boolean - in: query name: orderBy schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: filterParams.parameterPairValue - schema: - type: string - - in: query - name: filterParams.customFilter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filterParams.workflowName - schema: - type: string - - in: query - name: filterParams.taskStatuses - schema: - type: string - - in: query - name: filterParams.startTime + name: pageSize schema: - type: string - format: int64 + type: integer + format: int32 - in: query - name: filterParams.endTime + name: filter schema: type: string - format: int64 - in: query - name: truncateParams + name: pageToken schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: parameters: *ref_1 get: - description: Download the execution. - operationId: integrations.projects.locations.integrations.executions.download + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.certificates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11209,8 +11155,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -11223,20 +11168,13 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: certificatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: - parameters: *ref_1 - get: - description: Get an execution in the specified project. - operationId: integrations.projects.locations.integrations.executions.get + delete: + description: Delete a certificate + operationId: integrations.projects.locations.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11248,7 +11186,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11261,20 +11199,22 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: certificatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations: - parameters: *ref_1 - get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.integrations.list + patch: + description: >- + Updates the certificate by id. If new certificate file is updated, it + will register with the trawler service, re-encrypt with cloud KMS and + update the Spanner record. Other fields will directly update the Spanner + record. Returns the Certificate. + operationId: integrations.projects.locations.certificates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11286,8 +11226,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -11299,41 +11238,29 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: certificatesId + required: true schema: type: string - in: query - name: orderBy + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/certificates: parameters: *ref_1 post: description: >- - Executes integrations synchronously by passing the trigger id in the - request body. The request is not returned until the requested executions - are either fulfilled or experienced an error. If the integration name is - not specified (passing `-`), all of the associated integration under the - given trigger_id will be executed. Otherwise only the specified - integration for the given `trigger_id` is executed. This is helpful for - execution the integration from UI. - operationId: integrations.projects.locations.integrations.execute + Creates a new certificate. The certificate will be registered to the + trawler service and will be encrypted using cloud KMS and stored in + Spanner Returns the certificate. + operationId: integrations.projects.locations.certificates.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11345,8 +11272,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -11358,19 +11284,11 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: - parameters: *ref_1 - post: + get: description: >- - Executes an integration on receiving events from Integration Connector - triggers, Eventarc or CPS Trigger. Input data to integration is received - in body in json format - operationId: integrations.projects.locations.integrations.executeEvent + List all the certificates that match the filter. Restrict to certificate + of current client only. + operationId: integrations.projects.locations.certificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11383,7 +11301,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -11395,20 +11313,29 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: triggerId + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: parameters: *ref_1 delete: - description: Delete the selected integration and all versions inside - operationId: integrations.projects.locations.integrations.delete + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11433,21 +11360,15 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: - parameters: *ref_1 - post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.integrations.test - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + get: + description: >- + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11460,7 +11381,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -11473,23 +11394,20 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: - parameters: *ref_1 - post: + patch: description: >- - Schedules an integration for execution by passing the trigger id and the - scheduled time in the request body. - operationId: integrations.projects.locations.integrations.schedule + Updates an sfdc instance. Updates the sfdc instance in spanner. Returns + the sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11502,7 +11420,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -11515,15 +11433,27 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: parameters: *ref_1 - get: - description: Lists the available entities and actions associated with a Connection. - operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata + post: + description: >- + Creates an sfdc instance record. Store the sfdc instance in Spanner. + Returns the sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11536,7 +11466,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -11548,16 +11478,11 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_1 get: - description: Lists Connections in a given project and location. - operationId: integrations.projects.locations.connections.list + description: >- + Lists all sfdc instances that match the filter. Restrict to sfdc + instances belonging to the current client only. + operationId: integrations.projects.locations.sfdcInstances.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11570,7 +11495,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse parameters: - in: path name: projectsId @@ -11587,11 +11512,12 @@ paths: schema: type: string - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query - name: orderBy + name: pageToken schema: type: string - in: query @@ -11599,13 +11525,49 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: parameters: *ref_1 get: description: >- - Lists the JSON schemas for the inputs and outputs of actions, filtered - by action name. - operationId: integrations.projects.locations.connections.runtimeActionSchemas.list + Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + - in: path + name: sfdcChannelsId + required: true + schema: + type: string + delete: + description: Deletes an sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11617,8 +11579,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11631,30 +11592,25 @@ paths: schema: type: string - in: path - name: connectionsId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: sfdcChannelsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: - parameters: *ref_1 - get: + patch: description: >- - Lists the JSON schemas for the properties of runtime entities, filtered - by entity name. - operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list + Updates an sfdc channel. Updates the sfdc channel in spanner. Returns + the sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11666,8 +11622,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -11680,28 +11635,27 @@ paths: schema: type: string - in: path - name: connectionsId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: sfdcChannelsId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: parameters: *ref_1 get: - description: Get a template in the specified project. - operationId: integrations.projects.locations.templates.get + description: >- + Lists all sfdc channels that match the filter. Restrict to sfdc channels + belonging to the current client only. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11713,7 +11667,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -11726,18 +11681,38 @@ paths: schema: type: string - in: path - name: templatesId + name: sfdcInstancesId required: true schema: type: string - patch: - description: Updates the template by given id. - operationId: integrations.projects.locations.templates.patch + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Creates an sfdc channel record. Store the sfdc channel in Spanner. + Returns the sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11749,7 +11724,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -11762,18 +11737,16 @@ paths: schema: type: string - in: path - name: templatesId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a template - operationId: integrations.projects.locations.templates.delete + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: + parameters: *ref_1 + get: + description: Download the execution. + operationId: >- + integrations.projects.locations.products.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11785,7 +11758,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -11798,24 +11772,29 @@ paths: schema: type: string - in: path - name: templatesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share: + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: parameters: *ref_1 - post: + get: description: >- - Share a template with other clients. Only the template owner can share - the templates with other projects. PERMISSION_DENIED would be thrown if - the request is not from the owner. - operationId: integrations.projects.locations.templates.share - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaShareTemplateRequest + Lists the results of all the integration executions. The response + includes the same information as the [execution + log](https://cloud.google.com/application-integration/docs/viewing-logs) + in the Integration UI. + operationId: integrations.projects.locations.products.integrations.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11827,7 +11806,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse parameters: - in: path name: projectsId @@ -11840,25 +11820,104 @@ paths: schema: type: string - in: path - name: templatesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates:upload: - parameters: *ref_1 - post: - description: >- - Uploads a template. The content can be a previously downloaded template. - Performs the same function as CreateTemplate, but accepts input in a - string format, which holds the complete representation of the Template - content. - operationId: integrations.projects.locations.templates.upload - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateRequest + - in: path + name: integrationsId + required: true + schema: + type: string + - in: query + name: filterParams.workflowName + schema: + type: string + - in: query + name: filterParams.eventStatuses + schema: + type: string + - in: query + name: refreshAcl + schema: + type: boolean + - in: query + name: truncateParams + schema: + type: boolean + - in: query + name: filterParams.startTime + schema: + type: string + format: int64 + - in: query + name: filterParams.customFilter + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: filterParams.executionId + schema: + type: string + - in: query + name: filterParams.parameterKey + schema: + type: string + - in: query + name: filterParams.taskStatuses + schema: + type: string + - in: query + name: filterParams.endTime + schema: + type: string + format: int64 + - in: query + name: filterParams.parameterPairKey + schema: + type: string + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean + - in: query + name: filterParams.parameterPairValue + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filterParams.parameterValue + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filterParams.parameterType + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: + parameters: *ref_1 + get: + description: Get an execution in the specified project. + operationId: integrations.projects.locations.products.integrations.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11870,8 +11929,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' parameters: - in: path name: projectsId @@ -11883,63 +11941,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use: - parameters: *ref_1 - post: - description: >- - Use the template to create integration. This api would keep track of - usage_count and last_used_time. PERMISSION_DENIED would be thrown if - template is not accessible by client. - operationId: integrations.projects.locations.templates.use - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateResponse - parameters: - in: path - name: projectsId + name: productsId required: true schema: type: string - in: path - name: locationsId + name: integrationsId required: true schema: type: string - in: path - name: templatesId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: parameters: *ref_1 - post: + get: description: >- - Import the template to an existing integration. This api would keep - track of usage_count and last_used_time. PERMISSION_DENIED would be - thrown if template is not accessible by client. - operationId: integrations.projects.locations.templates.import - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateRequest + * Lists suspensions associated with a specific execution. Only those + with permissions to resolve the relevant suspensions will be able to + view them. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11952,7 +11977,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse parameters: - in: path name: projectsId @@ -11965,50 +11990,30 @@ paths: schema: type: string - in: path - name: templatesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates: - parameters: *ref_1 - get: - description: Lists all templates matching the filter. - operationId: integrations.projects.locations.templates.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListTemplatesResponse - parameters: - in: path - name: projectsId + name: integrationsId required: true schema: type: string - in: path - name: locationsId + name: executionsId required: true schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: orderBy schema: type: string - in: query @@ -12016,18 +12021,21 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + parameters: *ref_1 post: - description: Creates a new template - operationId: integrations.projects.locations.templates.create + description: >- + * Resolves (lifts/rejects) any number of suspensions. If the integration + is already running, only the status of the suspension is updated. + Otherwise, the suspended integration will begin execution again. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.resolve requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12039,7 +12047,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -12051,21 +12060,41 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare: + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: parameters: *ref_1 post: description: >- - Unshare a template from given clients. Owner of the template can unshare - template with clients. Shared client can only unshare the template from - itself. PERMISSION_DENIED would be thrown if request is not from owner - or for unsharing itself. - operationId: integrations.projects.locations.templates.unshare + * Lifts suspension for the Suspension task. Fetch corresponding + suspension with provided suspension Id, resolve suspension, and set up + suspension result for the Suspension Task. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.lift requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnshareTemplateRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12077,7 +12106,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -12090,57 +12120,42 @@ paths: schema: type: string - in: path - name: templatesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download: - parameters: *ref_1 - get: - description: >- - Downloads a template. Retrieves the `Template` and returns the response - as a string. - operationId: integrations.projects.locations.templates.download - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTemplateResponse - parameters: - in: path - name: projectsId + name: integrationsId required: true schema: type: string - in: path - name: locationsId + name: executionsId required: true schema: type: string - in: path - name: templatesId + name: suspensionsId required: true schema: type: string - - in: query - name: fileFormat - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates:search: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: parameters: *ref_1 - get: + post: description: >- - Search templates based on user query and filters. This api would query - the templates and return a list of templates based on the user filter. - operationId: integrations.projects.locations.templates.search + This RPC throws an exception if the integration is in ARCHIVED or ACTIVE + state. This RPC throws an exception if the version being published is + DRAFT, and if the `locked_by` user is not the same as the user + performing the Publish. Audit fields updated include + last_published_timestamp, last_published_by, last_modified_timestamp, + last_modified_by. Any existing lock is on this integration is released. + operationId: integrations.projects.locations.products.integrations.versions.publish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12153,7 +12168,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSearchTemplatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12165,39 +12180,45 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: productsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: integrationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: orderBy + - in: path + name: versionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: parameters: *ref_1 post: - description: Update run-as service account for provisioned client - operationId: integrations.projects.locations.clients.replace + description: >- + Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of + this integration. It then performs the same action as the + CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the + integration as a SNAPSHOT and then creates a new DRAFT version with the + `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` + set to the current timestamp). Both the `locked_by` and + `user_taking_over` are notified via email about the takeover. This RPC + throws an exception if the integration is not in DRAFT status or if the + `locked_by` and `locked_at_timestamp` fields are not set.The + TakeoverEdit lock is treated the same as an edit of the integration, and + hence shares ACLs with edit. Audit fields updated include + last_modified_timestamp, last_modified_by. + operationId: >- + integrations.projects.locations.products.integrations.versions.takeoverEditLock requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12209,7 +12230,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse parameters: - in: path name: projectsId @@ -12221,19 +12243,37 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: parameters: *ref_1 post: description: >- - Perform the deprovisioning steps to disable a user GCP project to use IP - and purge all related data in a wipeout-compliant way. - operationId: integrations.projects.locations.clients.deprovision + Sets the status of the ACTIVE integration to SNAPSHOT with a new tag + "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and + "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if + the version being snapshot is not ACTIVE. Audit fields added include + action, action_by, action_timestamp. + operationId: integrations.projects.locations.products.integrations.versions.unpublish requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12257,17 +12297,32 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: parameters: *ref_1 - post: - description: Update client from GMEK to CMEK - operationId: integrations.projects.locations.clients.switch + patch: + description: Update a integration with a draft version in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12279,7 +12334,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12291,17 +12347,38 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: - parameters: *ref_1 - post: - description: Update variable masking for provisioned client - operationId: integrations.projects.locations.clients.switchVariableMasking - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Soft-deletes the integration. Changes the status of the integration to + ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag + is removed from this snapshot and set to the previous non-ARCHIVED + snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. + This RPC throws an exception if the version being deleted is DRAFT, and + if the `locked_by` user is not the same as the user performing the + Delete. Audit fields updated include last_modified_timestamp, + last_modified_by. Any existing lock is released when Deleting a + integration. Currently, there is no undelete mechanism. + operationId: integrations.projects.locations.products.integrations.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12325,20 +12402,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: - parameters: *ref_1 - post: - description: >- - Perform the provisioning steps to enable a user GCP project to use IP. - If GCP project already registered on IP end via Apigee Integration, - provisioning will fail. - operationId: integrations.projects.locations.clients.provision - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + get: + description: Get a integration in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12350,7 +12431,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12362,13 +12444,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: parameters: *ref_1 get: - description: >- - Lists all auth configs that match the filter. Restrict to auth configs - belong to the current client only. - operationId: integrations.projects.locations.authConfigs.list + description: Returns the list of all integration versions in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12381,7 +12476,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -12393,36 +12488,47 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true schema: type: string - format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: orderBy + schema: + type: string - in: query name: filter schema: type: string + - in: query + name: fieldMask + schema: + type: string + format: google-fieldmask - in: query name: pageToken schema: type: string post: - description: >- - Creates an auth config record. Fetch corresponding credentials for - specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. - Encrypt the auth config with Cloud KMS and store the encrypted - credentials in Spanner. Returns the encrypted auth config. - operationId: integrations.projects.locations.authConfigs.create + description: Create a integration with a draft version in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12434,7 +12540,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12446,26 +12553,40 @@ paths: required: true schema: type: string - - in: query - name: clientCertificate.sslCertificate + - in: path + name: productsId + required: true schema: type: string - - in: query - name: clientCertificate.passphrase + - in: path + name: integrationsId + required: true schema: type: string - in: query - name: clientCertificate.encryptedPrivateKey + name: createSampleIntegrations schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: + type: boolean + - in: query + name: newIntegration + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: parameters: *ref_1 - get: + post: description: >- - Gets a complete auth config. If the auth config doesn't exist, - Code.NOT_FOUND exception will be thrown. Returns the decrypted auth - config. - operationId: integrations.projects.locations.authConfigs.get + Uploads an integration. The content can be a previously downloaded + integration. Performs the same function as + CreateDraftIntegrationVersion, but accepts input in a string format, + which holds the complete representation of the IntegrationVersion + content. + operationId: integrations.projects.locations.products.integrations.versions.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12477,7 +12598,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12490,23 +12612,22 @@ paths: schema: type: string - in: path - name: authConfigsId + name: productsId required: true schema: type: string - patch: - description: >- - Updates an auth config. If credential is updated, fetch the encrypted - auth config from Spanner, decrypt with Cloud KMS key, update the - credential fields, re-encrypt with Cloud KMS key and update the Spanner - record. For other fields, directly update the Spanner record. Returns - the encrypted auth config. - operationId: integrations.projects.locations.authConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: + parameters: *ref_1 + get: + description: >- + Downloads an integration. Retrieves the `IntegrationVersion` for a given + `integration_id` and returns the response as a string. + operationId: integrations.projects.locations.products.integrations.versions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12518,7 +12639,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12531,30 +12653,39 @@ paths: schema: type: string - in: path - name: authConfigsId + name: productsId required: true schema: type: string - - in: query - name: clientCertificate.encryptedPrivateKey + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: clientCertificate.passphrase + - in: path + name: versionsId + required: true schema: type: string - in: query - name: updateMask + name: files schema: type: string - format: google-fieldmask - in: query - name: clientCertificate.sslCertificate + name: fileFormat schema: type: string - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.authConfigs.delete + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: + parameters: *ref_1 + post: + description: Execute the integration in draft state + operationId: integrations.projects.locations.products.integrations.test + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12566,7 +12697,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -12579,21 +12711,33 @@ paths: schema: type: string - in: path - name: authConfigsId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: parameters: *ref_1 post: - description: Creates a cloud function project. - operationId: integrations.projects.locations.cloudFunctions.create + description: >- + Executes integrations synchronously by passing the trigger id in the + request body. The request is not returned until the requested executions + are either fulfilled or experienced an error. If the integration name is + not specified (passing `-`), all of the associated integration under the + given trigger_id will be executed. Otherwise only the specified + integration for the given `trigger_id` is executed. This is helpful for + execution the integration from UI. + operationId: integrations.projects.locations.products.integrations.execute requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12606,7 +12750,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -12618,18 +12762,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: parameters: *ref_1 - patch: + post: description: >- - Updates an sfdc channel. Updates the sfdc channel in spanner. Returns - the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.patch + Schedules an integration for execution by passing the trigger id and the + scheduled time in the request body. + operationId: integrations.projects.locations.products.integrations.schedule requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12641,7 +12796,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -12654,25 +12810,20 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - in: path - name: sfdcChannelsId + name: integrationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: + parameters: *ref_1 get: - description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.get + description: Returns the list of all integrations in the specified project. + operationId: integrations.projects.locations.products.integrations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12684,7 +12835,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -12697,18 +12849,40 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - - in: path - name: sfdcChannelsId - required: true + - in: query + name: filter schema: type: string - delete: - description: Deletes an sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: + parameters: *ref_1 + post: + description: >- + Creates a new certificate. The certificate will be registered to the + trawler service and will be encrypted using cloud KMS and stored in + Spanner Returns the certificate. + operationId: integrations.projects.locations.products.certificates.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12720,7 +12894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -12733,22 +12907,15 @@ paths: schema: type: string - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: - parameters: *ref_1 get: description: >- - Lists all sfdc channels that match the filter. Restrict to sfdc channels - belonging to the current client only. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.list + List all the certificates that match the filter. Restrict to certificate + of current client only. + operationId: integrations.projects.locations.products.certificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12761,7 +12928,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -12774,15 +12941,14 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query name: pageToken schema: @@ -12793,19 +12959,15 @@ paths: type: string format: google-fieldmask - in: query - name: filter + name: pageSize schema: - type: string - post: - description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: + parameters: *ref_1 + delete: + description: Delete a certificate + operationId: integrations.projects.locations.products.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12817,7 +12979,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12830,22 +12992,18 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: - parameters: *ref_1 - patch: - description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + - in: path + name: certificatesId + required: true + schema: + type: string + get: + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.products.certificates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12857,8 +13015,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -12871,18 +13028,27 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: certificatesId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.delete + patch: + description: >- + Updates the certificate by id. If new certificate file is updated, it + will register with the trawler service, re-encrypt with cloud KMS and + update the Spanner record. Other fields will directly update the Spanner + record. Returns the Certificate. + operationId: integrations.projects.locations.products.certificates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12894,7 +13060,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -12907,15 +13073,31 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId + required: true + schema: + type: string + - in: path + name: certificatesId required: true schema: type: string - get: - description: >- - Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.sfdcInstances.get + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: + parameters: *ref_1 + post: + description: Creates a cloud function project. + operationId: integrations.projects.locations.products.cloudFunctions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12928,7 +13110,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse parameters: - in: path name: projectsId @@ -12941,17 +13123,17 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: parameters: *ref_1 get: description: >- - Lists all sfdc instances that match the filter. Restrict to sfdc - instances belonging to the current client only. - operationId: integrations.projects.locations.sfdcInstances.list + Lists all auth configs that match the filter. Restrict to auth configs + belong to the current client only. + operationId: integrations.projects.locations.products.authConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12964,7 +13146,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -12976,6 +13158,16 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask - in: query name: filter schema: @@ -12989,21 +13181,18 @@ paths: name: pageToken schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask post: description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.create + Creates an auth config record. Fetch corresponding credentials for + specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. + Encrypt the auth config with Cloud KMS and store the encrypted + credentials in Spanner. Returns the encrypted auth config. + operationId: integrations.projects.locations.products.authConfigs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13015,8 +13204,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -13028,17 +13216,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: + - in: path + name: productsId + required: true + schema: + type: string + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: parameters: *ref_1 - post: - description: Links a existing Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.link - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.products.authConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13050,8 +13249,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13063,17 +13261,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: - parameters: *ref_1 - post: - description: Creates an Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: authConfigsId + required: true + schema: + type: string + get: + description: >- + Gets a complete auth config. If the auth config doesn't exist, + Code.NOT_FOUND exception will be thrown. Returns the decrypted auth + config. + operationId: integrations.projects.locations.products.authConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13085,8 +13288,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -13098,19 +13300,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates: - parameters: *ref_1 - post: + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: authConfigsId + required: true + schema: + type: string + patch: description: >- - Creates a new certificate. The certificate will be registered to the - trawler service and will be encrypted using cloud KMS and stored in - Spanner Returns the certificate. - operationId: integrations.projects.locations.certificates.create + Updates an auth config. If credential is updated, fetch the encrypted + auth config from Spanner, decrypt with Cloud KMS key, update the + credential fields, re-encrypt with Cloud KMS key and update the Spanner + record. For other fields, directly update the Spanner record. Returns + the encrypted auth config. + operationId: integrations.projects.locations.products.authConfigs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13122,7 +13334,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -13134,58 +13346,40 @@ paths: required: true schema: type: string - get: - description: >- - List all the certificates that match the filter. Restrict to certificate - of current client only. - operationId: integrations.projects.locations.certificates.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse - parameters: - in: path - name: projectsId + name: productsId required: true schema: type: string - in: path - name: locationsId + name: authConfigsId required: true schema: type: string - in: query - name: filter + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: pageSize + name: clientCertificate.encryptedPrivateKey schema: - type: integer - format: int32 + type: string - in: query - name: readMask + name: clientCertificate.passphrase schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: clientCertificate.sslCertificate schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: parameters: *ref_1 get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.certificates.get + description: >- + Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13197,7 +13391,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -13210,22 +13404,31 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId + required: true + schema: + type: string + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + - in: path + name: sfdcChannelsId required: true schema: type: string patch: description: >- - Updates the certificate by id. If new certificate file is updated, it - will register with the trawler service, re-encrypt with cloud KMS and - update the Spanner record. Other fields will directly update the Spanner - record. Returns the Certificate. - operationId: integrations.projects.locations.certificates.patch + Updates an sfdc channel. Updates the sfdc channel in spanner. Returns + the sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13237,7 +13440,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -13250,7 +13453,17 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId + required: true + schema: + type: string + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + - in: path + name: sfdcChannelsId required: true schema: type: string @@ -13260,8 +13473,9 @@ paths: type: string format: google-fieldmask delete: - description: Delete a certificate - operationId: integrations.projects.locations.certificates.delete + description: Deletes an sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13286,17 +13500,27 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + - in: path + name: sfdcChannelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: parameters: *ref_1 get: description: >- - List all the certificates that match the filter. Restrict to certificate - of current client only. - operationId: integrations.projects.locations.products.certificates.list + Lists all sfdc channels that match the filter. Restrict to sfdc channels + belonging to the current client only. + operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13309,7 +13533,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -13326,13 +13550,9 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: sfdcInstancesId + required: true schema: type: string - in: query @@ -13340,21 +13560,30 @@ paths: schema: type: string format: google-fieldmask + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- - Creates a new certificate. The certificate will be registered to the - trawler service and will be encrypted using cloud KMS and stored in - Spanner Returns the certificate. - operationId: integrations.projects.locations.products.certificates.create + Creates an sfdc channel record. Store the sfdc channel in Spanner. + Returns the sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13366,7 +13595,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -13383,11 +13612,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: parameters: *ref_1 - get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.products.certificates.get + delete: + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13399,7 +13633,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13417,13 +13651,20 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string - delete: - description: Delete a certificate - operationId: integrations.projects.locations.products.certificates.delete + patch: + description: >- + Updates an sfdc instance. Updates the sfdc instance in spanner. Returns + the sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13435,7 +13676,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -13453,22 +13695,20 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string - patch: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: description: >- - Updates the certificate by id. If new certificate file is updated, it - will register with the trawler service, re-encrypt with cloud KMS and - update the Spanner record. Other fields will directly update the Spanner - record. Returns the Certificate. - operationId: integrations.projects.locations.products.certificates.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.products.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13480,7 +13720,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -13498,26 +13739,22 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: parameters: *ref_1 post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.products.integrations.test + description: >- + Creates an sfdc instance record. Store the sfdc instance in Spanner. + Returns the sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13530,7 +13767,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -13547,29 +13784,73 @@ paths: required: true schema: type: string + get: + description: >- + Lists all sfdc instances that match the filter. Restrict to sfdc + instances belonging to the current client only. + operationId: integrations.projects.locations.products.sfdcInstances.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: integrationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: + - in: path + name: productsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: parameters: *ref_1 post: description: >- - Executes integrations synchronously by passing the trigger id in the - request body. The request is not returned until the requested executions - are either fulfilled or experienced an error. If the integration name is - not specified (passing `-`), all of the associated integration under the - given trigger_id will be executed. Otherwise only the specified - integration for the given `trigger_id` is executed. This is helpful for - execution the integration from UI. - operationId: integrations.projects.locations.products.integrations.execute + * Resolves (lifts/rejects) any number of suspensions. If the integration + is already running, only the status of the suspension is updated. + Otherwise, the suspended integration will begin execution again. + operationId: >- + integrations.projects.locations.integrations.executions.suspensions.resolve requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13582,7 +13863,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -13595,28 +13876,34 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: parameters: *ref_1 post: description: >- - Schedules an integration for execution by passing the trigger id and the - scheduled time in the request body. - operationId: integrations.projects.locations.products.integrations.schedule + * Lifts suspension for the Suspension task. Fetch corresponding + suspension with provided suspension Id, resolve suspension, and set up + suspension result for the Suspension Task. + operationId: integrations.projects.locations.integrations.executions.suspensions.lift requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13629,7 +13916,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -13642,20 +13929,28 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: parameters: *ref_1 get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.products.integrations.list + description: >- + * Lists suspensions associated with a specific execution. Only those + with permissions to resolve the relevant suspensions will be able to + view them. + operationId: integrations.projects.locations.integrations.executions.suspensions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13668,7 +13963,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse parameters: - in: path name: projectsId @@ -13681,20 +13976,21 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: executionsId + required: true schema: type: string - in: query - name: orderBy + name: filter schema: type: string - in: query - name: filter + name: orderBy schema: type: string - in: query @@ -13702,11 +13998,15 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: parameters: *ref_1 get: description: Get an execution in the specified project. - operationId: integrations.projects.locations.products.integrations.executions.get + operationId: integrations.projects.locations.integrations.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13730,11 +14030,6 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true @@ -13745,12 +14040,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: parameters: *ref_1 get: description: Download the execution. - operationId: >- - integrations.projects.locations.products.integrations.executions.download + operationId: integrations.projects.locations.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13775,11 +14069,6 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true @@ -13790,7 +14079,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions: parameters: *ref_1 get: description: >- @@ -13798,7 +14087,7 @@ paths: includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. - operationId: integrations.projects.locations.products.integrations.executions.list + operationId: integrations.projects.locations.integrations.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13823,52 +14112,38 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - in: query - name: filterParams.executionId - schema: - type: string - - in: query - name: filterParams.workflowName + name: filterParams.endTime schema: type: string + format: int64 - in: query - name: filterParams.parameterKey + name: truncateParams schema: - type: string + type: boolean - in: query name: filterParams.parameterValue schema: type: string - in: query - name: filter + name: orderBy schema: type: string - in: query - name: readMask + name: filterParams.executionId schema: type: string - format: google-fieldmask - in: query - name: filterParams.startTime + name: filterParams.parameterKey schema: type: string - format: int64 - - in: query - name: snapshotMetadataWithoutParams - schema: - type: boolean - in: query - name: filterParams.eventStatuses + name: filterParams.parameterPairValue schema: type: string - in: query @@ -13876,32 +14151,28 @@ paths: schema: type: boolean - in: query - name: filterParams.parameterPairValue + name: snapshotMetadataWithoutParams schema: - type: string + type: boolean - in: query - name: orderBy + name: filterParams.parameterType schema: type: string - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: pageToken + name: filterParams.workflowName schema: type: string - in: query - name: filterParams.endTime + name: readMask schema: type: string - format: int64 + format: google-fieldmask - in: query - name: filterParams.parameterPairKey + name: pageToken schema: type: string - in: query - name: filterParams.parameterType + name: filterParams.eventStatuses schema: type: string - in: query @@ -13914,89 +14185,39 @@ paths: schema: type: string - in: query - name: filterParams.taskStatuses - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: - parameters: *ref_1 - get: - description: >- - * Lists suspensions associated with a specific execution. Only those - with permissions to resolve the relevant suspensions will be able to - view them. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId - required: true + name: filter schema: type: string - in: query - name: pageToken + name: filterParams.parameterPairKey schema: type: string - in: query - name: filter + name: filterParams.taskStatuses schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + name: filterParams.startTime schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: + format: int64 + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: parameters: *ref_1 post: description: >- - * Lifts suspension for the Suspension task. Fetch corresponding - suspension with provided suspension Id, resolve suspension, and set up - suspension result for the Suspension Task. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.lift + This RPC throws an exception if the integration is in ARCHIVED or ACTIVE + state. This RPC throws an exception if the version being published is + DRAFT, and if the `locked_by` user is not the same as the user + performing the Publish. Audit fields updated include + last_published_timestamp, last_published_by, last_modified_timestamp, + last_modified_by. Any existing lock is on this integration is released. + operationId: integrations.projects.locations.integrations.versions.publish requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14009,7 +14230,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14021,41 +14242,21 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: suspensionsId + name: versionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: parameters: *ref_1 - post: - description: >- - * Resolves (lifts/rejects) any number of suspensions. If the integration - is already running, only the status of the suspension is updated. - Otherwise, the suspended integration will begin execution again. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.resolve - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + get: + description: Returns the list of all integration versions in the specified project. + operationId: integrations.projects.locations.integrations.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14068,7 +14269,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -14081,41 +14282,41 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: fieldMask schema: type: string - - in: path - name: executionsId - required: true + format: google-fieldmask + - in: query + name: pageToken schema: type: string - - in: path - name: suspensionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: - parameters: *ref_1 post: - description: >- - Sets the status of the ACTIVE integration to SNAPSHOT with a new tag - "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and - "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if - the version being snapshot is not ACTIVE. Audit fields added include - action, action_by, action_timestamp. - operationId: integrations.projects.locations.products.integrations.versions.unpublish + description: Create a integration with a draft version in the specified project. + operationId: integrations.projects.locations.integrations.versions.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14127,7 +14328,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14139,32 +14341,24 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: createSampleIntegrations schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: + type: boolean + - in: query + name: newIntegration + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: parameters: *ref_1 - post: - description: Create a integration with a draft version in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + get: + description: Get a integration in the specified project. + operationId: integrations.projects.locations.integrations.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14189,27 +14383,28 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: - type: string - - in: query - name: createSampleIntegrations - schema: - type: boolean - - in: query - name: newIntegration + type: string + - in: path + name: versionsId + required: true schema: - type: boolean - get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.list + type: string + delete: + description: >- + Soft-deletes the integration. Changes the status of the integration to + ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag + is removed from this snapshot and set to the previous non-ARCHIVED + snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. + This RPC throws an exception if the version being deleted is DRAFT, and + if the `locked_by` user is not the same as the user performing the + Delete. Audit fields updated include last_modified_timestamp, + last_modified_by. Any existing lock is released when Deleting a + integration. Currently, there is no undelete mechanism. + operationId: integrations.projects.locations.integrations.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14221,8 +14416,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14235,61 +14429,24 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: fieldMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: - parameters: *ref_1 - post: - description: >- - Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of - this integration. It then performs the same action as the - CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the - integration as a SNAPSHOT and then creates a new DRAFT version with the - `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` - set to the current timestamp). Both the `locked_by` and - `user_taking_over` are notified via email about the takeover. This RPC - throws an exception if the integration is not in DRAFT status or if the - `locked_by` and `locked_at_timestamp` fields are not set.The - TakeoverEdit lock is treated the same as an edit of the integration, and - hence shares ACLs with edit. Audit fields updated include - last_modified_timestamp, last_modified_by. - operationId: >- - integrations.projects.locations.products.integrations.versions.takeoverEditLock + patch: + description: Update a integration with a draft version in the specified project. + operationId: integrations.projects.locations.integrations.versions.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14302,7 +14459,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14314,11 +14471,6 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true @@ -14329,13 +14481,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: parameters: *ref_1 get: description: >- Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string. - operationId: integrations.projects.locations.products.integrations.versions.download + operationId: integrations.projects.locations.integrations.versions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14360,11 +14517,6 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true @@ -14383,17 +14535,22 @@ paths: name: files schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: parameters: *ref_1 - patch: - description: Update a integration with a draft version in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.patch + post: + description: >- + Uploads an integration. The content can be a previously downloaded + integration. Performs the same function as + CreateDraftIntegrationVersion, but accepts input in a string format, + which holds the complete representation of the IntegrationVersion + content. + operationId: integrations.projects.locations.integrations.versions.upload requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14406,7 +14563,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14418,29 +14575,27 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - - in: path - name: versionsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Get a integration in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.get + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + parameters: *ref_1 + post: + description: >- + Sets the status of the ACTIVE integration to SNAPSHOT with a new tag + "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and + "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if + the version being snapshot is not ACTIVE. Audit fields added include + action, action_by, action_timestamp. + operationId: integrations.projects.locations.integrations.versions.unpublish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14452,8 +14607,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14465,11 +14619,6 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true @@ -14480,18 +14629,16 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: + parameters: *ref_1 + get: description: >- - Soft-deletes the integration. Changes the status of the integration to - ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag - is removed from this snapshot and set to the previous non-ARCHIVED - snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. - This RPC throws an exception if the version being deleted is DRAFT, and - if the `locked_by` user is not the same as the user performing the - Delete. Audit fields updated include last_modified_timestamp, - last_modified_by. Any existing lock is released when Deleting a - integration. Currently, there is no undelete mechanism. - operationId: integrations.projects.locations.products.integrations.versions.delete + Downloads an Integration version package like + IntegrationVersion,Integration Config etc. Retrieves the + IntegrationVersion package for a given `integration_id` and returns the + response as a JSON. + operationId: >- + integrations.projects.locations.integrations.versions.downloadJsonPackage security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14503,7 +14650,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse parameters: - in: path name: projectsId @@ -14515,11 +14663,6 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true @@ -14530,22 +14673,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: + - in: query + name: files + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: parameters: *ref_1 post: - description: >- - Uploads an integration. The content can be a previously downloaded - integration. Performs the same function as - CreateDraftIntegrationVersion, but accepts input in a string format, - which holds the complete representation of the IntegrationVersion - content. - operationId: integrations.projects.locations.products.integrations.versions.upload + description: Execute the integration in draft state + operationId: integrations.projects.locations.integrations.test requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14558,7 +14700,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -14570,33 +14712,29 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: parameters: *ref_1 post: description: >- - This RPC throws an exception if the integration is in ARCHIVED or ACTIVE - state. This RPC throws an exception if the version being published is - DRAFT, and if the `locked_by` user is not the same as the user - performing the Publish. Audit fields updated include - last_published_timestamp, last_published_by, last_modified_timestamp, - last_modified_by. Any existing lock is on this integration is released. - operationId: integrations.projects.locations.products.integrations.versions.publish + Executes integrations synchronously by passing the trigger id in the + request body. The request is not returned until the requested executions + are either fulfilled or experienced an error. If the integration name is + not specified (passing `-`), all of the associated integration under the + given trigger_id will be executed. Otherwise only the specified + integration for the given `trigger_id` is executed. This is helpful for + execution the integration from UI. + operationId: integrations.projects.locations.integrations.execute requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14609,7 +14747,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -14621,28 +14759,16 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - - in: path - name: versionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + /v1/projects/{projectsId}/locations/{locationsId}/integrations: parameters: *ref_1 get: - description: >- - Lists all sfdc channels that match the filter. Restrict to sfdc channels - belonging to the current client only. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.list + description: Returns the list of all integrations in the specified project. + operationId: integrations.projects.locations.integrations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14655,7 +14781,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -14663,27 +14789,20 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: locationsId required: true schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: filter + name: orderBy + schema: + type: string + - in: query + name: pageToken schema: type: string - in: query @@ -14691,21 +14810,11 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: + parameters: *ref_1 + delete: + description: Delete the selected integration and all versions inside + operationId: integrations.projects.locations.integrations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14717,7 +14826,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14730,28 +14839,23 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: parameters: *ref_1 - patch: + post: description: >- - Updates an sfdc channel. Updates the sfdc channel in spanner. Returns - the sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch + Schedules an integration for execution by passing the trigger id and the + scheduled time in the request body. + operationId: integrations.projects.locations.integrations.schedule requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14763,7 +14867,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -14776,29 +14881,18 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: integrationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes an sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: + parameters: *ref_1 + post: + description: >- + Executes an integration on receiving events from Integration Connector + triggers, Eventarc or CPS Trigger. Input data to integration is received + in body in json format + operationId: integrations.projects.locations.integrations.executeEvent security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14810,7 +14904,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse parameters: - in: path name: projectsId @@ -14823,25 +14918,25 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - - in: path - name: sfdcChannelsId - required: true + - in: query + name: triggerId schema: type: string - get: - description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get + /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: + parameters: *ref_1 + post: + description: Creates a cloud function project. + operationId: integrations.projects.locations.cloudFunctions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14853,7 +14948,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse parameters: - in: path name: projectsId @@ -14865,26 +14961,11 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}: parameters: *ref_1 - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.delete + get: + description: Get a template in the specified project. + operationId: integrations.projects.locations.templates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14896,7 +14977,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -14909,20 +14990,13 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: templatesId required: true schema: type: string - get: - description: >- - Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.get + delete: + description: Deletes a template + operationId: integrations.projects.locations.templates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14934,8 +15008,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14948,25 +15021,18 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: templatesId required: true schema: type: string patch: - description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.patch + description: Updates the template by given id. + operationId: integrations.projects.locations.templates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14978,8 +15044,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -14992,12 +15057,7 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: templatesId required: true schema: type: string @@ -15006,13 +15066,13 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download: parameters: *ref_1 get: description: >- - Lists all sfdc instances that match the filter. Restrict to sfdc - instances belonging to the current client only. - operationId: integrations.projects.locations.products.sfdcInstances.list + Downloads a template. Retrieves the `Template` and returns the response + as a string. + operationId: integrations.projects.locations.templates.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15025,7 +15085,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTemplateResponse parameters: - in: path name: projectsId @@ -15038,38 +15098,72 @@ paths: schema: type: string - in: path - name: productsId + name: templatesId required: true schema: type: string - in: query - name: readMask + name: fileFormat schema: type: string - format: google-fieldmask - - in: query - name: filter + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare: + parameters: *ref_1 + post: + description: >- + Unshare a template from given clients. Owner of the template can unshare + template with clients. Shared client can only unshare the template from + itself. PERMISSION_DENIED would be thrown if request is not from owner + or for unsharing itself. + operationId: integrations.projects.locations.templates.unshare + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUnshareTemplateRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: locationsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: templatesId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates:upload: + parameters: *ref_1 post: description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.create + Uploads a template. The content can be a previously downloaded template. + Performs the same function as CreateTemplate, but accepts input in a + string format, which holds the complete representation of the Template + content. + operationId: integrations.projects.locations.templates.upload requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15082,7 +15176,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateResponse parameters: - in: path name: projectsId @@ -15094,25 +15188,16 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: + /v1/projects/{projectsId}/locations/{locationsId}/templates: parameters: *ref_1 post: - description: >- - Creates an auth config record. Fetch corresponding credentials for - specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. - Encrypt the auth config with Cloud KMS and store the encrypted - credentials in Spanner. Returns the encrypted auth config. - operationId: integrations.projects.locations.products.authConfigs.create + description: Creates a new template + operationId: integrations.projects.locations.templates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15124,7 +15209,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -15136,28 +15221,9 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string get: - description: >- - Lists all auth configs that match the filter. Restrict to auth configs - belong to the current client only. - operationId: integrations.projects.locations.products.authConfigs.list + description: Lists all templates matching the filter. + operationId: integrations.projects.locations.templates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15170,7 +15236,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListTemplatesResponse parameters: - in: path name: projectsId @@ -15182,9 +15248,8 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true + - in: query + name: orderBy schema: type: string - in: query @@ -15193,26 +15258,32 @@ paths: type: integer format: int32 - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query - name: pageToken + name: filter schema: type: string - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import: parameters: *ref_1 - get: + post: description: >- - Gets a complete auth config. If the auth config doesn't exist, - Code.NOT_FOUND exception will be thrown. Returns the decrypted auth - config. - operationId: integrations.projects.locations.products.authConfigs.get + Import the template to an existing integration. This api would keep + track of usage_count and last_used_time. PERMISSION_DENIED would be + thrown if template is not accessible by client. + operationId: integrations.projects.locations.templates.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15224,7 +15295,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateResponse parameters: - in: path name: projectsId @@ -15237,28 +15309,24 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: authConfigsId + name: templatesId required: true schema: type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use: + parameters: *ref_1 + post: description: >- - Updates an auth config. If credential is updated, fetch the encrypted - auth config from Spanner, decrypt with Cloud KMS key, update the - credential fields, re-encrypt with Cloud KMS key and update the Spanner - record. For other fields, directly update the Spanner record. Returns - the encrypted auth config. - operationId: integrations.projects.locations.products.authConfigs.patch + Use the template to create integration. This api would keep track of + usage_count and last_used_time. PERMISSION_DENIED would be thrown if + template is not accessible by client. + operationId: integrations.projects.locations.templates.use requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15270,7 +15338,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateResponse parameters: - in: path name: projectsId @@ -15283,35 +15352,17 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: authConfigsId + name: templatesId required: true schema: type: string - - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.products.authConfigs.delete + /v1/projects/{projectsId}/locations/{locationsId}/templates:search: + parameters: *ref_1 + get: + description: >- + Search templates based on user query and filters. This api would query + the templates and return a list of templates based on the user filter. + operationId: integrations.projects.locations.templates.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15323,7 +15374,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSearchTemplatesResponse parameters: - in: path name: projectsId @@ -15335,27 +15387,42 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: authConfigsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share: parameters: *ref_1 post: - description: Creates a cloud function project. - operationId: integrations.projects.locations.products.cloudFunctions.create + description: >- + Share a template with other clients. Only the template owner can share + the templates with other projects. PERMISSION_DENIED would be thrown if + the request is not from the owner. + operationId: integrations.projects.locations.templates.share requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaShareTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15367,8 +15434,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -15381,7 +15447,7 @@ paths: schema: type: string - in: path - name: productsId + name: templatesId required: true schema: type: string @@ -15416,72 +15482,6 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/clientmetadata: - parameters: *ref_1 - get: - description: Gets the metadata info for the requested client - operationId: integrations.projects.getClientmetadata - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - /v1/callback:generateToken: - parameters: *ref_1 - get: - description: >- - Receives the auth code and auth config id to combine that with the - client id and secret to retrieve access tokens from the token endpoint. - Returns either a success or error message when it's done. - operationId: integrations.callback.generateToken - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse - parameters: - - in: query - name: state - schema: - type: string - - in: query - name: redirectUri - schema: - type: string - - in: query - name: product - schema: - type: string - - in: query - name: gcpProjectId - schema: - type: string - - in: query - name: code - schema: - type: string /v1/connectorPlatformRegions:enumerate: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml b/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml index 9d89ca81..ba461d12 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml @@ -34,157 +34,77 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudKmsV1KeyAccessJustificationsPolicy: - properties: - allowedAccessReasons: - description: >- - The list of allowed reasons for access to a CryptoKey. Zero allowed - access reasons means all encrypt, decrypt, and sign operations for - the CryptoKey associated with this policy will fail. - type: array - items: - enumDescriptions: - - Unspecified access reason. - - Customer-initiated support. - - >- - Google-initiated access for system management and - troubleshooting. - - >- - Google-initiated access in response to a legal request or legal - process. - - >- - Google-initiated access for security, fraud, abuse, or - compliance purposes. - - >- - Customer uses their account to perform any access to their own - data which their IAM policy authorizes. - - >- - Google systems access customer data to help optimize the - structure of the data or quality for future uses by the - customer. - - No reason is expected for this key request. - - >- - Customer uses their account to perform any access to their own - data which their IAM policy authorizes, and one of the following - is true: * A Google administrator has reset the root-access - account associated with the user's organization within the past - 7 days. * A Google-initiated emergency access operation has - interacted with a resource in the same project or folder as the - currently accessed resource within the past 7 days. - - >- - Google systems access customer data to help optimize the - structure of the data or quality for future uses by the - customer, and one of the following is true: * A Google - administrator has reset the root-access account associated with - the user's organization within the past 7 days. * A - Google-initiated emergency access operation has interacted with - a resource in the same project or folder as the currently - accessed resource within the past 7 days. - - Google-initiated access to maintain system reliability. - - >- - One of the following operations is being executed while - simultaneously encountering an internal technical issue which - prevented a more precise justification code from being - generated: * Your account has been used to perform any access to - your own data which your IAM policy authorizes. * An automated - Google system operates on encrypted customer data which your IAM - policy authorizes. * Customer-initiated Google support access. * - Google-initiated support access to protect system reliability. - enum: - - REASON_UNSPECIFIED - - CUSTOMER_INITIATED_SUPPORT - - GOOGLE_INITIATED_SERVICE - - THIRD_PARTY_DATA_REQUEST - - GOOGLE_INITIATED_REVIEW - - CUSTOMER_INITIATED_ACCESS - - GOOGLE_INITIATED_SYSTEM_OPERATION - - REASON_NOT_EXPECTED - - MODIFIED_CUSTOMER_INITIATED_ACCESS - - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION - - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT - - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING - type: string - description: >- - A KeyAccessJustificationsPolicy specifies zero or more allowed - AccessReason values for encrypt, decrypt, and sign operations on a - CryptoKey. - id: GoogleCloudKmsV1KeyAccessJustificationsPolicy - type: object - GoogleCloudKmsV1CryptoKeyVersion: + GoogleCloudKmsV1KeyOperationAttestation: + id: GoogleCloudKmsV1KeyOperationAttestation type: object - id: GoogleCloudKmsV1CryptoKeyVersion - description: >- - A CryptoKeyVersion represents an individual cryptographic key, and the - associated key material. An ENABLED version can be used for - cryptographic operations. For security reasons, the raw cryptographic - key material represented by a CryptoKeyVersion can never be viewed or - exported. It can only be used to encrypt, decrypt, or sign data when an - authorized user or application invokes Cloud KMS. properties: - externalDestructionFailureReason: - type: string - readOnly: true - description: >- - Output only. The root cause of the most recent external destruction - failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. - reimportEligible: - description: >- - Output only. Whether or not this key version is eligible for - reimport, by being specified as a target in - ImportCryptoKeyVersionRequest.crypto_key_version. - readOnly: true - type: boolean - createTime: - description: Output only. The time at which this CryptoKeyVersion was created. - readOnly: true - format: google-datetime + format: type: string - protectionLevel: - description: >- - Output only. The ProtectionLevel describing how crypto operations - are performed with this CryptoKeyVersion. + enum: + - ATTESTATION_FORMAT_UNSPECIFIED + - CAVIUM_V1_COMPRESSED + - CAVIUM_V2_COMPRESSED readOnly: true enumDescriptions: - Not specified. - - Crypto operations are performed in software. - - Crypto operations are performed in a Hardware Security Module. - - Crypto operations are performed by an external key manager. - - Crypto operations are performed in an EKM-over-VPC backend. - enum: - - PROTECTION_LEVEL_UNSPECIFIED - - SOFTWARE - - HSM - - EXTERNAL - - EXTERNAL_VPC - type: string - importFailureReason: + - >- + Cavium HSM attestation compressed with gzip. Note that this format + is defined by Cavium and subject to change at any time. See + https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. + - >- + Cavium HSM attestation V2 compressed with gzip. This is a new + format introduced in Cavium's version 3.2-08. + description: Output only. The format of the attestation data. + certChains: description: >- - Output only. The root cause of the most recent import failure. Only - present if state is IMPORT_FAILED. + Output only. The certificate chains needed to validate the + attestation + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains + content: readOnly: true type: string - externalProtectionLevelOptions: description: >- - ExternalProtectionLevelOptions stores a group of additional fields - for configuring a CryptoKeyVersion that are specific to the EXTERNAL - protection level and EXTERNAL_VPC protection levels. - $ref: '#/components/schemas/GoogleCloudKmsV1ExternalProtectionLevelOptions' - destroyTime: - type: string + Output only. The attestation data provided by the HSM when the key + operation was performed. + format: byte + description: >- + Contains an HSM-generated attestation about a key operation. For more + information, see [Verifying attestations] + (https://cloud.google.com/kms/docs/attest-key). + GoogleCloudKmsV1ExternalProtectionLevelOptions: + id: GoogleCloudKmsV1ExternalProtectionLevelOptions + description: >- + ExternalProtectionLevelOptions stores a group of additional fields for + configuring a CryptoKeyVersion that are specific to the EXTERNAL + protection level and EXTERNAL_VPC protection levels. + properties: + externalKeyUri: description: >- - Output only. The time this CryptoKeyVersion's key material is - scheduled for destruction. Only present if state is - DESTROY_SCHEDULED. - readOnly: true - format: google-datetime - generateTime: + The URI for an external resource that this CryptoKeyVersion + represents. + type: string + ekmConnectionKeyPath: description: >- - Output only. The time this CryptoKeyVersion's key material was - generated. - format: google-datetime + The path to the external key material on the EKM when using + EkmConnection e.g., "v0/my/key". Set this field instead of + external_key_uri when using an EkmConnection. type: string - readOnly: true + type: object + GoogleCloudKmsV1CryptoKeyVersionTemplate: + description: >- + A CryptoKeyVersionTemplate specifies the properties to use when creating + a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or + automatically as a result of auto-rotation. + properties: algorithm: + type: string + description: >- + Required. Algorithm to use when creating a CryptoKeyVersion based on + this template. For backwards compatibility, + GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted + and CryptoKey.purpose is ENCRYPT_DECRYPT. enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -234,11 +154,6 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. - readOnly: true - type: string - description: >- - Output only. The CryptoKeyVersionAlgorithm that this - CryptoKeyVersion supports. enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -276,277 +191,92 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION - state: - type: string + protectionLevel: enumDescriptions: - Not specified. - - >- - This version is still being generated. It may not be used, - enabled, disabled, or destroyed yet. Cloud KMS will automatically - mark this version ENABLED as soon as the version is ready. - - This version may be used for cryptographic operations. - - >- - This version may not be used, but the key material is still - available, and the version can be placed back into the ENABLED - state. - - >- - This version is destroyed, and the key material is no longer - stored. This version may only become ENABLED again if this version - is reimport_eligible and the original key material is reimported - with a call to KeyManagementService.ImportCryptoKeyVersion. - - >- - This version is scheduled for destruction, and will be destroyed - soon. Call RestoreCryptoKeyVersion to put it back into the - DISABLED state. - - >- - This version is still being imported. It may not be used, enabled, - disabled, or destroyed yet. Cloud KMS will automatically mark this - version ENABLED as soon as the version is ready. - - >- - This version was not imported successfully. It may not be used, - enabled, disabled, or destroyed. The submitted key material has - been discarded. Additional details can be found in - CryptoKeyVersion.import_failure_reason. - - >- - This version was not generated successfully. It may not be used, - enabled, disabled, or destroyed. Additional details can be found - in CryptoKeyVersion.generation_failure_reason. - - >- - This version was destroyed, and it may not be used or enabled - again. Cloud KMS is waiting for the corresponding key material - residing in an external key manager to be destroyed. - - >- - This version was destroyed, and it may not be used or enabled - again. However, Cloud KMS could not confirm that the corresponding - key material residing in an external key manager was destroyed. - Additional details can be found in - CryptoKeyVersion.external_destruction_failure_reason. - description: The current state of the CryptoKeyVersion. + - Crypto operations are performed in software. + - Crypto operations are performed in a Hardware Security Module. + - Crypto operations are performed by an external key manager. + - Crypto operations are performed in an EKM-over-VPC backend. enum: - - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED - - PENDING_GENERATION - - ENABLED - - DISABLED - - DESTROYED - - DESTROY_SCHEDULED - - PENDING_IMPORT - - IMPORT_FAILED - - GENERATION_FAILED - - PENDING_EXTERNAL_DESTRUCTION - - EXTERNAL_DESTRUCTION_FAILED - importJob: - description: >- - Output only. The name of the ImportJob used in the most recent - import of this CryptoKeyVersion. Only present if the underlying key - material was imported. - readOnly: true - type: string - generationFailureReason: - readOnly: true - description: >- - Output only. The root cause of the most recent generation failure. - Only present if state is GENERATION_FAILED. - type: string - importTime: - description: >- - Output only. The time at which this CryptoKeyVersion's key material - was most recently imported. - type: string - readOnly: true - format: google-datetime - attestation: - readOnly: true - $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' - description: >- - Output only. Statement that was generated and signed by the HSM at - key creation time. Use this statement to verify attributes of the - key as stored on the HSM, independently of Google. Only provided for - key versions with protection_level HSM. - destroyEventTime: - format: google-datetime + - PROTECTION_LEVEL_UNSPECIFIED + - SOFTWARE + - HSM + - EXTERNAL + - EXTERNAL_VPC type: string - readOnly: true - description: >- - Output only. The time this CryptoKeyVersion's key material was - destroyed. Only present if state is DESTROYED. - name: description: >- - Output only. The resource name for this CryptoKeyVersion in the - format - `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. - type: string - readOnly: true - GoogleCloudKmsV1KeyOperationAttestationCertificateChains: - id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains - properties: - caviumCerts: - description: Cavium certificate chain corresponding to the attestation. - items: - type: string - type: array - googlePartitionCerts: - type: array - description: Google partition certificate chain corresponding to the attestation. - items: - type: string - googleCardCerts: - type: array - description: Google card certificate chain corresponding to the attestation. - items: - type: string - description: >- - Certificate chains needed to verify the attestation. Certificates in - chains are PEM-encoded and are ordered based on - https://tools.ietf.org/html/rfc5246#section-7.4.2. + ProtectionLevel to use when creating a CryptoKeyVersion based on + this template. Immutable. Defaults to SOFTWARE. type: object + id: GoogleCloudKmsV1CryptoKeyVersionTemplate GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse: - id: GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse + type: object properties: - nextPageToken: - type: string - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. protectedResources: items: $ref: '#/components/schemas/GoogleCloudKmsInventoryV1ProtectedResource' - type: array description: Protected resources for this page. - description: Response message for KeyTrackingService.SearchProtectedResources. - type: object - GoogleCloudKmsInventoryV1ListCryptoKeysResponse: - description: Response message for KeyDashboardService.ListCryptoKeys. - properties: - cryptoKeys: type: array - description: The list of CryptoKeys. - items: - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' nextPageToken: description: >- - The page token returned from the previous response if the next page - is desired. - type: string - type: object - id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse - GoogleCloudKmsV1KeyOperationAttestation: - description: >- - Contains an HSM-generated attestation about a key operation. For more - information, see [Verifying attestations] - (https://cloud.google.com/kms/docs/attest-key). - id: GoogleCloudKmsV1KeyOperationAttestation - properties: - certChains: - readOnly: true - description: >- - Output only. The certificate chains needed to validate the - attestation - $ref: >- - #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains - format: - enumDescriptions: - - Not specified. - - >- - Cavium HSM attestation compressed with gzip. Note that this format - is defined by Cavium and subject to change at any time. See - https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. - - >- - Cavium HSM attestation V2 compressed with gzip. This is a new - format introduced in Cavium's version 3.2-08. - type: string - description: Output only. The format of the attestation data. - readOnly: true - enum: - - ATTESTATION_FORMAT_UNSPECIFIED - - CAVIUM_V1_COMPRESSED - - CAVIUM_V2_COMPRESSED - content: + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - readOnly: true - format: byte - description: >- - Output only. The attestation data provided by the HSM when the key - operation was performed. - type: object + description: Response message for KeyTrackingService.SearchProtectedResources. + id: GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse GoogleCloudKmsInventoryV1ProtectedResourcesSummary: + id: GoogleCloudKmsInventoryV1ProtectedResourcesSummary description: >- Aggregate information about the resources protected by a Cloud KMS key in the same Cloud organization as the key. - type: object - id: GoogleCloudKmsInventoryV1ProtectedResourcesSummary properties: - locations: - description: The number of resources protected by the key grouped by region. - type: object - additionalProperties: - format: int64 - type: string - resourceTypes: - additionalProperties: - format: int64 - type: string - description: >- - The number of resources protected by the key grouped by resource - type. - type: object - cloudProducts: - type: object - additionalProperties: - format: int64 - type: string - description: >- - The number of resources protected by the key grouped by Cloud - product. name: description: >- The full name of the ProtectedResourcesSummary resource. Example: projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary type: string + locations: + type: object + description: The number of resources protected by the key grouped by region. + additionalProperties: + type: string + format: int64 projectCount: + format: int32 description: >- The number of distinct Cloud projects in the same Cloud organization as the key that have resources protected by the key. - format: int32 type: integer resourceCount: - type: string description: >- The total number of protected resources in the same Cloud organization as the key. format: int64 - GoogleCloudKmsV1ExternalProtectionLevelOptions: - properties: - externalKeyUri: type: string + resourceTypes: description: >- - The URI for an external resource that this CryptoKeyVersion - represents. - ekmConnectionKeyPath: - type: string + The number of resources protected by the key grouped by resource + type. + type: object + additionalProperties: + type: string + format: int64 + cloudProducts: + additionalProperties: + type: string + format: int64 description: >- - The path to the external key material on the EKM when using - EkmConnection e.g., "v0/my/key". Set this field instead of - external_key_uri when using an EkmConnection. - description: >- - ExternalProtectionLevelOptions stores a group of additional fields for - configuring a CryptoKeyVersion that are specific to the EXTERNAL - protection level and EXTERNAL_VPC protection levels. - id: GoogleCloudKmsV1ExternalProtectionLevelOptions + The number of resources protected by the key grouped by Cloud + product. + type: object type: object GoogleCloudKmsV1CryptoKey: + description: >- + A CryptoKey represents a logical key that can be used for cryptographic + operations. A CryptoKey is made up of zero or more versions, which + represent the actual key material used in cryptographic operations. properties: - importOnly: - description: Immutable. Whether this key may contain imported versions only. - type: boolean - rotationPeriod: - format: google-duration - type: string - description: >- - next_rotation_time will be advanced by this period when the service - automatically rotates a key. Must be at least 24 hours and at most - 876,000 hours. If rotation_period is set, next_rotation_time must - also be set. Keys with purpose ENCRYPT_DECRYPT support automatic - rotation. For other keys, this field must be omitted. keyAccessJustificationsPolicy: description: >- Optional. The policy used for Key Access Justifications Policy @@ -559,44 +289,69 @@ components: By default, this field is absent, and all justification codes are allowed. $ref: '#/components/schemas/GoogleCloudKmsV1KeyAccessJustificationsPolicy' - cryptoKeyBackend: - type: string - description: >- - Immutable. The resource name of the backend environment where the - key material for all CryptoKeyVersions associated with this - CryptoKey reside and where all related cryptographic operations are - performed. Only applicable if CryptoKeyVersions have a - ProtectionLevel of EXTERNAL_VPC, with the resource name in the - format `projects/*/locations/*/ekmConnections/*`. Note, this list is - non-exhaustive and may apply to additional ProtectionLevels in the - future. - destroyScheduledDuration: + name: + readOnly: true description: >- - Immutable. The period of time that versions of this key spend in the - DESTROY_SCHEDULED state before transitioning to DESTROYED. If not - specified at creation time, the default duration is 30 days. + Output only. The resource name for this CryptoKey in the format + `projects/*/locations/*/keyRings/*/cryptoKeys/*`. type: string + rotationPeriod: format: google-duration - primary: - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' - readOnly: true description: >- - Output only. A copy of the "primary" CryptoKeyVersion that will be - used by Encrypt when this CryptoKey is given in EncryptRequest.name. - The CryptoKey's primary version can be updated via - UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may - have a primary. For other keys, this field will be omitted. + next_rotation_time will be advanced by this period when the service + automatically rotates a key. Must be at least 24 hours and at most + 876,000 hours. If rotation_period is set, next_rotation_time must + also be set. Keys with purpose ENCRYPT_DECRYPT support automatic + rotation. For other keys, this field must be omitted. + type: string versionTemplate: + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersionTemplate' description: >- A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template. - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersionTemplate' - createTime: - format: google-datetime - type: string - description: Output only. The time at which this CryptoKey was created. + nextRotationTime: + description: >- + At next_rotation_time, the Key Management Service will + automatically: 1. Create a new version of this CryptoKey. 2. Mark + the new version as primary. Key rotations performed manually via + CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not + affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support + automatic rotation. For other keys, this field must be omitted. + format: google-datetime + type: string + labels: + type: object + additionalProperties: + type: string + description: >- + Labels with user-defined metadata. For more information, see + [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). + createTime: + format: google-datetime + description: Output only. The time at which this CryptoKey was created. + type: string + readOnly: true + cryptoKeyBackend: + type: string + description: >- + Immutable. The resource name of the backend environment where the + key material for all CryptoKeyVersions associated with this + CryptoKey reside and where all related cryptographic operations are + performed. Only applicable if CryptoKeyVersions have a + ProtectionLevel of EXTERNAL_VPC, with the resource name in the + format `projects/*/locations/*/ekmConnections/*`. Note, this list is + non-exhaustive and may apply to additional ProtectionLevels in the + future. + primary: + description: >- + Output only. A copy of the "primary" CryptoKeyVersion that will be + used by Encrypt when this CryptoKey is given in EncryptRequest.name. + The CryptoKey's primary version can be updated via + UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may + have a primary. For other keys, this field will be omitted. + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' readOnly: true purpose: enumDescriptions: @@ -614,7 +369,7 @@ components: symmetric encryption and does not support automatic CryptoKey rotation. - CryptoKeys with this purpose may be used with MacSign. - description: Immutable. The immutable purpose of this CryptoKey. + type: string enum: - CRYPTO_KEY_PURPOSE_UNSPECIFIED - ENCRYPT_DECRYPT @@ -622,63 +377,259 @@ components: - ASYMMETRIC_DECRYPT - RAW_ENCRYPT_DECRYPT - MAC + description: Immutable. The immutable purpose of this CryptoKey. + destroyScheduledDuration: + format: google-duration type: string - name: - description: >- - Output only. The resource name for this CryptoKey in the format - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. - readOnly: true - type: string - labels: - additionalProperties: - type: string - type: object description: >- - Labels with user-defined metadata. For more information, see - [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). - nextRotationTime: + Immutable. The period of time that versions of this key spend in the + DESTROY_SCHEDULED state before transitioning to DESTROYED. If not + specified at creation time, the default duration is 30 days. + importOnly: + description: Immutable. Whether this key may contain imported versions only. + type: boolean + id: GoogleCloudKmsV1CryptoKey + type: object + GoogleCloudKmsInventoryV1ListCryptoKeysResponse: + properties: + nextPageToken: description: >- - At next_rotation_time, the Key Management Service will - automatically: 1. Create a new version of this CryptoKey. 2. Mark - the new version as primary. Key rotations performed manually via - CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not - affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support - automatic rotation. For other keys, this field must be omitted. + The page token returned from the previous response if the next page + is desired. type: string - format: google-datetime + cryptoKeys: + items: + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' + description: The list of CryptoKeys. + type: array + description: Response message for KeyDashboardService.ListCryptoKeys. type: object - id: GoogleCloudKmsV1CryptoKey - description: >- - A CryptoKey represents a logical key that can be used for cryptographic - operations. A CryptoKey is made up of zero or more versions, which - represent the actual key material used in cryptographic operations. - GoogleCloudKmsV1CryptoKeyVersionTemplate: + id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse + GoogleCloudKmsV1KeyAccessJustificationsPolicy: description: >- - A CryptoKeyVersionTemplate specifies the properties to use when creating - a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or - automatically as a result of auto-rotation. + A KeyAccessJustificationsPolicy specifies zero or more allowed + AccessReason values for encrypt, decrypt, and sign operations on a + CryptoKey. + id: GoogleCloudKmsV1KeyAccessJustificationsPolicy + properties: + allowedAccessReasons: + type: array + items: + type: string + enumDescriptions: + - Unspecified access reason. + - Customer-initiated support. + - >- + Google-initiated access for system management and + troubleshooting. + - >- + Google-initiated access in response to a legal request or legal + process. + - >- + Google-initiated access for security, fraud, abuse, or + compliance purposes. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer. + - No reason is expected for this key request. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes, and one of the following + is true: * A Google administrator has reset the root-access + account associated with the user's organization within the past + 7 days. * A Google-initiated emergency access operation has + interacted with a resource in the same project or folder as the + currently accessed resource within the past 7 days. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer, and one of the following is true: * A Google + administrator has reset the root-access account associated with + the user's organization within the past 7 days. * A + Google-initiated emergency access operation has interacted with + a resource in the same project or folder as the currently + accessed resource within the past 7 days. + - Google-initiated access to maintain system reliability. + - >- + One of the following operations is being executed while + simultaneously encountering an internal technical issue which + prevented a more precise justification code from being + generated: * Your account has been used to perform any access to + your own data which your IAM policy authorizes. * An automated + Google system operates on encrypted customer data which your IAM + policy authorizes. * Customer-initiated Google support access. * + Google-initiated support access to protect system reliability. + enum: + - REASON_UNSPECIFIED + - CUSTOMER_INITIATED_SUPPORT + - GOOGLE_INITIATED_SERVICE + - THIRD_PARTY_DATA_REQUEST + - GOOGLE_INITIATED_REVIEW + - CUSTOMER_INITIATED_ACCESS + - GOOGLE_INITIATED_SYSTEM_OPERATION + - REASON_NOT_EXPECTED + - MODIFIED_CUSTOMER_INITIATED_ACCESS + - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION + - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT + - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING + description: >- + The list of allowed reasons for access to a CryptoKey. Zero allowed + access reasons means all encrypt, decrypt, and sign operations for + the CryptoKey associated with this policy will fail. type: object - id: GoogleCloudKmsV1CryptoKeyVersionTemplate + GoogleCloudKmsV1KeyOperationAttestationCertificateChains: + properties: + googleCardCerts: + type: array + items: + type: string + description: Google card certificate chain corresponding to the attestation. + googlePartitionCerts: + items: + type: string + description: Google partition certificate chain corresponding to the attestation. + type: array + caviumCerts: + description: Cavium certificate chain corresponding to the attestation. + items: + type: string + type: array + id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains + type: object + description: >- + Certificate chains needed to verify the attestation. Certificates in + chains are PEM-encoded and are ordered based on + https://tools.ietf.org/html/rfc5246#section-7.4.2. + GoogleCloudKmsV1CryptoKeyVersion: properties: + destroyEventTime: + description: >- + Output only. The time this CryptoKeyVersion's key material was + destroyed. Only present if state is DESTROYED. + format: google-datetime + type: string + readOnly: true + reimportEligible: + readOnly: true + type: boolean + description: >- + Output only. Whether or not this key version is eligible for + reimport, by being specified as a target in + ImportCryptoKeyVersionRequest.crypto_key_version. + externalDestructionFailureReason: + type: string + description: >- + Output only. The root cause of the most recent external destruction + failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. + readOnly: true + externalProtectionLevelOptions: + $ref: '#/components/schemas/GoogleCloudKmsV1ExternalProtectionLevelOptions' + description: >- + ExternalProtectionLevelOptions stores a group of additional fields + for configuring a CryptoKeyVersion that are specific to the EXTERNAL + protection level and EXTERNAL_VPC protection levels. protectionLevel: + type: string enum: - PROTECTION_LEVEL_UNSPECIFIED - SOFTWARE - HSM - EXTERNAL - EXTERNAL_VPC - type: string + readOnly: true + description: >- + Output only. The ProtectionLevel describing how crypto operations + are performed with this CryptoKeyVersion. enumDescriptions: - Not specified. - Crypto operations are performed in software. - Crypto operations are performed in a Hardware Security Module. - Crypto operations are performed by an external key manager. - Crypto operations are performed in an EKM-over-VPC backend. + generationFailureReason: + type: string description: >- - ProtectionLevel to use when creating a CryptoKeyVersion based on - this template. Immutable. Defaults to SOFTWARE. - algorithm: + Output only. The root cause of the most recent generation failure. + Only present if state is GENERATION_FAILED. + readOnly: true + name: + readOnly: true type: string + description: >- + Output only. The resource name for this CryptoKeyVersion in the + format + `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. + destroyTime: + format: google-datetime + readOnly: true + type: string + description: >- + Output only. The time this CryptoKeyVersion's key material is + scheduled for destruction. Only present if state is + DESTROY_SCHEDULED. + attestation: + description: >- + Output only. Statement that was generated and signed by the HSM at + key creation time. Use this statement to verify attributes of the + key as stored on the HSM, independently of Google. Only provided for + key versions with protection_level HSM. + $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' + readOnly: true + createTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time at which this CryptoKeyVersion was created. + importJob: + readOnly: true + description: >- + Output only. The name of the ImportJob used in the most recent + import of this CryptoKeyVersion. Only present if the underlying key + material was imported. + type: string + algorithm: + enum: + - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED + - GOOGLE_SYMMETRIC_ENCRYPTION + - AES_128_GCM + - AES_256_GCM + - AES_128_CBC + - AES_256_CBC + - AES_128_CTR + - AES_256_CTR + - RSA_SIGN_PSS_2048_SHA256 + - RSA_SIGN_PSS_3072_SHA256 + - RSA_SIGN_PSS_4096_SHA256 + - RSA_SIGN_PSS_4096_SHA512 + - RSA_SIGN_PKCS1_2048_SHA256 + - RSA_SIGN_PKCS1_3072_SHA256 + - RSA_SIGN_PKCS1_4096_SHA256 + - RSA_SIGN_PKCS1_4096_SHA512 + - RSA_SIGN_RAW_PKCS1_2048 + - RSA_SIGN_RAW_PKCS1_3072 + - RSA_SIGN_RAW_PKCS1_4096 + - RSA_DECRYPT_OAEP_2048_SHA256 + - RSA_DECRYPT_OAEP_3072_SHA256 + - RSA_DECRYPT_OAEP_4096_SHA256 + - RSA_DECRYPT_OAEP_4096_SHA512 + - RSA_DECRYPT_OAEP_2048_SHA1 + - RSA_DECRYPT_OAEP_3072_SHA1 + - RSA_DECRYPT_OAEP_4096_SHA1 + - EC_SIGN_P256_SHA256 + - EC_SIGN_P384_SHA384 + - EC_SIGN_SECP256K1_SHA256 + - EC_SIGN_ED25519 + - HMAC_SHA256 + - HMAC_SHA1 + - HMAC_SHA384 + - HMAC_SHA512 + - HMAC_SHA224 + - EXTERNAL_SYMMETRIC_ENCRYPTION + readOnly: true enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -711,79 +662,138 @@ components: functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms - >- - ECDSA on the NIST P-384 curve with a SHA384 digest. Other hash - functions can also be used: - https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms + ECDSA on the NIST P-384 curve with a SHA384 digest. Other hash + functions can also be used: + https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms + - >- + ECDSA on the non-NIST secp256k1 curve. This curve is only + supported for HSM protection level. Other hash functions can also + be used: + https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms + - EdDSA on the Curve25519 in pure mode (taking data as input). + - HMAC-SHA256 signing with a 256 bit key. + - HMAC-SHA1 signing with a 160 bit key. + - HMAC-SHA384 signing with a 384 bit key. + - HMAC-SHA512 signing with a 512 bit key. + - HMAC-SHA224 signing with a 224 bit key. + - >- + Algorithm representing symmetric encryption by an external key + manager. + type: string + description: >- + Output only. The CryptoKeyVersionAlgorithm that this + CryptoKeyVersion supports. + importTime: + type: string + format: google-datetime + readOnly: true + description: >- + Output only. The time at which this CryptoKeyVersion's key material + was most recently imported. + generateTime: + type: string + readOnly: true + description: >- + Output only. The time this CryptoKeyVersion's key material was + generated. + format: google-datetime + importFailureReason: + description: >- + Output only. The root cause of the most recent import failure. Only + present if state is IMPORT_FAILED. + type: string + readOnly: true + state: + type: string + enumDescriptions: + - Not specified. + - >- + This version is still being generated. It may not be used, + enabled, disabled, or destroyed yet. Cloud KMS will automatically + mark this version ENABLED as soon as the version is ready. + - This version may be used for cryptographic operations. + - >- + This version may not be used, but the key material is still + available, and the version can be placed back into the ENABLED + state. + - >- + This version is destroyed, and the key material is no longer + stored. This version may only become ENABLED again if this version + is reimport_eligible and the original key material is reimported + with a call to KeyManagementService.ImportCryptoKeyVersion. + - >- + This version is scheduled for destruction, and will be destroyed + soon. Call RestoreCryptoKeyVersion to put it back into the + DISABLED state. + - >- + This version is still being imported. It may not be used, enabled, + disabled, or destroyed yet. Cloud KMS will automatically mark this + version ENABLED as soon as the version is ready. + - >- + This version was not imported successfully. It may not be used, + enabled, disabled, or destroyed. The submitted key material has + been discarded. Additional details can be found in + CryptoKeyVersion.import_failure_reason. + - >- + This version was not generated successfully. It may not be used, + enabled, disabled, or destroyed. Additional details can be found + in CryptoKeyVersion.generation_failure_reason. - >- - ECDSA on the non-NIST secp256k1 curve. This curve is only - supported for HSM protection level. Other hash functions can also - be used: - https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms - - EdDSA on the Curve25519 in pure mode (taking data as input). - - HMAC-SHA256 signing with a 256 bit key. - - HMAC-SHA1 signing with a 160 bit key. - - HMAC-SHA384 signing with a 384 bit key. - - HMAC-SHA512 signing with a 512 bit key. - - HMAC-SHA224 signing with a 224 bit key. + This version was destroyed, and it may not be used or enabled + again. Cloud KMS is waiting for the corresponding key material + residing in an external key manager to be destroyed. - >- - Algorithm representing symmetric encryption by an external key - manager. + This version was destroyed, and it may not be used or enabled + again. However, Cloud KMS could not confirm that the corresponding + key material residing in an external key manager was destroyed. + Additional details can be found in + CryptoKeyVersion.external_destruction_failure_reason. enum: - - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - - GOOGLE_SYMMETRIC_ENCRYPTION - - AES_128_GCM - - AES_256_GCM - - AES_128_CBC - - AES_256_CBC - - AES_128_CTR - - AES_256_CTR - - RSA_SIGN_PSS_2048_SHA256 - - RSA_SIGN_PSS_3072_SHA256 - - RSA_SIGN_PSS_4096_SHA256 - - RSA_SIGN_PSS_4096_SHA512 - - RSA_SIGN_PKCS1_2048_SHA256 - - RSA_SIGN_PKCS1_3072_SHA256 - - RSA_SIGN_PKCS1_4096_SHA256 - - RSA_SIGN_PKCS1_4096_SHA512 - - RSA_SIGN_RAW_PKCS1_2048 - - RSA_SIGN_RAW_PKCS1_3072 - - RSA_SIGN_RAW_PKCS1_4096 - - RSA_DECRYPT_OAEP_2048_SHA256 - - RSA_DECRYPT_OAEP_3072_SHA256 - - RSA_DECRYPT_OAEP_4096_SHA256 - - RSA_DECRYPT_OAEP_4096_SHA512 - - RSA_DECRYPT_OAEP_2048_SHA1 - - RSA_DECRYPT_OAEP_3072_SHA1 - - RSA_DECRYPT_OAEP_4096_SHA1 - - EC_SIGN_P256_SHA256 - - EC_SIGN_P384_SHA384 - - EC_SIGN_SECP256K1_SHA256 - - EC_SIGN_ED25519 - - HMAC_SHA256 - - HMAC_SHA1 - - HMAC_SHA384 - - HMAC_SHA512 - - HMAC_SHA224 - - EXTERNAL_SYMMETRIC_ENCRYPTION - description: >- - Required. Algorithm to use when creating a CryptoKeyVersion based on - this template. For backwards compatibility, - GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted - and CryptoKey.purpose is ENCRYPT_DECRYPT. + - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED + - PENDING_GENERATION + - ENABLED + - DISABLED + - DESTROYED + - DESTROY_SCHEDULED + - PENDING_IMPORT + - IMPORT_FAILED + - GENERATION_FAILED + - PENDING_EXTERNAL_DESTRUCTION + - EXTERNAL_DESTRUCTION_FAILED + description: The current state of the CryptoKeyVersion. + description: >- + A CryptoKeyVersion represents an individual cryptographic key, and the + associated key material. An ENABLED version can be used for + cryptographic operations. For security reasons, the raw cryptographic + key material represented by a CryptoKeyVersion can never be viewed or + exported. It can only be used to encrypt, decrypt, or sign data when an + authorized user or application invokes Cloud KMS. + id: GoogleCloudKmsV1CryptoKeyVersion + type: object GoogleCloudKmsInventoryV1ProtectedResource: - description: Metadata about a resource protected by a Cloud KMS key. type: object + description: Metadata about a resource protected by a Cloud KMS key. + id: GoogleCloudKmsInventoryV1ProtectedResource properties: - cryptoKeyVersion: + labels: + additionalProperties: + type: string + type: object + description: A key-value pair of the resource's labels (v1) to their values. + location: description: >- - The name of the Cloud KMS - [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) - used to protect this resource via CMEK. This field is empty if the - Google Cloud product owning the resource does not provide key - version data to Asset Inventory. If there are multiple key versions - protecting the resource, then this is same value as the first - element of crypto_key_versions. + Location can be `global`, regional like `us-east1`, or zonal like + `us-west1-b`. + type: string + cloudProduct: + description: 'The Cloud product that owns the resource. Example: `compute`' + type: string + project: type: string + description: 'Format: `projects/{PROJECT_NUMBER}`.' + resourceType: + type: string + description: 'Example: `compute.googleapis.com/Disk`' cryptoKeyVersions: type: array description: >- @@ -795,100 +805,96 @@ components: stored in crypto_key_version. items: type: string + cryptoKeyVersion: + description: >- + The name of the Cloud KMS + [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) + used to protect this resource via CMEK. This field is empty if the + Google Cloud product owning the resource does not provide key + version data to Asset Inventory. If there are multiple key versions + protecting the resource, then this is same value as the first + element of crypto_key_versions. + type: string projectId: type: string description: The ID of the project that owns the resource. - labels: - type: object - additionalProperties: - type: string - description: A key-value pair of the resource's labels (v1) to their values. - location: - type: string - description: >- - Location can be `global`, regional like `us-east1`, or zonal like - `us-west1-b`. createTime: + type: string + readOnly: true + format: google-datetime description: >- Output only. The time at which this resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. - format: google-datetime - type: string - readOnly: true - resourceType: - type: string - description: 'Example: `compute.googleapis.com/Disk`' - cloudProduct: - description: 'The Cloud product that owns the resource. Example: `compute`' - type: string - project: - type: string - description: 'Format: `projects/{PROJECT_NUMBER}`.' name: - type: string description: >- The full resource name of the resource. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. - id: GoogleCloudKmsInventoryV1ProtectedResource + type: string parameters: - alt: - description: Data format for response. + 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. in: query - name: alt + name: key schema: type: string - enum: - - json - - media - - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: quotaUser + name: fields schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - access_token: - description: OAuth access token. + callback: + description: JSONP in: query - name: access_token + name: callback schema: type: string - key: + quotaUser: 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. + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: key + name: quotaUser schema: type: string - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + alt: + description: Data format for response. in: query - name: uploadType + name: alt schema: type: string + enum: + - json + - media + - proto _.xgafv: description: V1 error format. in: query @@ -898,16 +904,10 @@ components: enum: - '1' - '2' - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - fields: - description: Selector specifying which fields to include in a partial response. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: fields + name: uploadType schema: type: string x-stackQL-resources: @@ -971,17 +971,17 @@ components: paths: /v1/projects/{projectsId}/cryptoKeys: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' get: description: >- Returns cryptographic keys managed by Cloud KMS in a given Cloud @@ -1086,6 +1086,10 @@ paths: required: true schema: type: string + - in: query + name: resourceTypes + schema: + type: string - in: query name: cryptoKey schema: @@ -1095,10 +1099,6 @@ paths: schema: type: integer format: int32 - - in: query - name: resourceTypes - schema: - type: string - in: query name: pageToken schema: diff --git a/providers/src/googleapis.com/v00.00.00000/services/language.yaml b/providers/src/googleapis.com/v00.00.00000/services/language.yaml index a1c98b2f..250f1588 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/language.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/language.yaml @@ -40,12 +40,76 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + XPSTextExtractionEvaluationMetrics: + id: XPSTextExtractionEvaluationMetrics + type: object + properties: + confidenceMetricsEntries: + items: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + type: array + description: >- + If the enclosing EvaluationMetrics.label is empty, + confidence_metrics_entries is an evaluation of the entire model + across all labels. If the enclosing EvaluationMetrics.label is set, + confidence_metrics_entries applies to that label. + confusionMatrix: + description: >- + Confusion matrix of the model, at the default confidence threshold + (0.0). Only set for whole-model evaluation, not for evaluation per + label. + $ref: '#/components/schemas/XPSConfusionMatrix' + bestF1ConfidenceMetrics: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + description: >- + Values are at the highest F1 score on the precision-recall curve. + Only confidence_threshold, recall, precision, and f1_score will be + set. + deprecated: true + perLabelConfidenceMetrics: + description: Only recall, precision, and f1_score will be set. + type: object + deprecated: true + additionalProperties: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + XPSSpeechModelSpecSubModelSpec: + type: object + id: XPSSpeechModelSpecSubModelSpec + properties: + contextId: + type: string + description: In S3, Recognition ClientContextId.context_id + isEnhancedModel: + type: boolean + description: >- + If true then it means we have an enhanced version of the biasing + models. + biasingModelType: + type: string + description: Type of the biasing model. + enum: + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT + enumDescriptions: + - '' + - Build biasing model on top of COMMAND_AND_SEARCH model + - Build biasing model on top of PHONE_CALL model + - Build biasing model on top of VIDEO model + - Build biasing model on top of DEFAULT model + clientId: + description: In S3, Recognition ClientContextId.client_id + type: string XPSFloat64Stats: id: XPSFloat64Stats + type: object + description: The data statistics of a series of FLOAT64 values. properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' histogramBuckets: + items: + $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' description: >- Histogram buckets of the data series. Sorted by the min value of the bucket, ascendingly, and the number of the buckets is dynamically @@ -53,2489 +117,1492 @@ components: whole FLOAT64 range with min of first bucket being `"-Infinity"`, and max of the last one being `"Infinity"`. type: array - items: - $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' - quantiles: - description: >- - Ordered from 0 to k k-quantile values of the data series of n - values. The value at index i is, approximately, the i*n/k-th - smallest value in the series; for i = 0 and i = k these are, - respectively, the min and max values. - type: array - items: - format: double - type: number standardDeviation: format: double description: The standard deviation of the series. type: number mean: - format: double type: number + format: double description: The mean of the series. - description: The data statistics of a series of FLOAT64 values. - type: object - XPSTfJsFormat: - description: >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used - in the browser and in Node.js using JavaScript. - id: XPSTfJsFormat - properties: {} + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + quantiles: + type: array + items: + format: double + type: number + description: >- + Ordered from 0 to k k-quantile values of the data series of n + values. The value at index i is, approximately, the i*n/k-th + smallest value in the series; for i = 0 and i = k these are, + respectively, the min and max values. + XPSTablesConfidenceMetricsEntry: + id: XPSTablesConfidenceMetricsEntry type: object - XPSFloat64StatsHistogramBucket: - id: XPSFloat64StatsHistogramBucket - description: A bucket of a histogram. properties: - max: + truePositiveRate: + description: 'TPR = #true positives / (#true positives + #false negatvies)' type: number format: double - description: >- - The maximum value of the bucket, exclusive unless max = - `"Infinity"`, in which case it's inclusive. - min: - description: The minimum value of the bucket, inclusive. + precision: + format: double + type: number + description: 'Precision = #true positives / (#true positives + #false positives).' + falseNegativeCount: + description: False negative count. + format: int64 + type: string + falsePositiveCount: + description: False positive count. + type: string + format: int64 + falsePositiveRate: type: number format: double - count: + description: 'FPR = #false positives / (#false positives + #true negatives)' + confidenceThreshold: + format: double + description: The confidence threshold value used to compute the metrics. + type: number + trueNegativeCount: + description: True negative count. + type: string + format: int64 + f1Score: description: >- - The number of data values that are in the bucket, i.e. are between - min and max values. + The harmonic mean of recall and precision. (2 * precision * recall) + / (precision + recall) + type: number + format: double + truePositiveCount: type: string format: int64 + description: True positive count. + recall: + format: double + type: number + description: 'Recall = #true positives / (#true positives + #false negatives).' + description: Metrics for a single confidence threshold. + XPSMetricEntry: + id: XPSMetricEntry type: object - CpuMetric: + properties: + int64Value: + type: string + format: int64 + description: A signed 64-bit integer value. + systemLabels: + description: Billing system labels for this (metric, value) pair. + type: array + items: + $ref: '#/components/schemas/XPSMetricEntryLabel' + doubleValue: + description: A double value. + format: double + type: number + metricName: + description: The metric name defined in the service configuration. + type: string + argentumMetricId: + description: >- + For billing metrics that are using legacy sku's, set the legacy + billing metric id here. This will be sent to Chemist as the + "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise + leave empty. + type: string + ModerateTextResponse: + description: The document moderation response message. + properties: + moderationCategories: + items: + $ref: '#/components/schemas/ClassificationCategory' + type: array + description: Harmful and sensitive categories representing the input document. + languageSupported: + type: boolean + description: >- + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + languageCode: + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + type: string + id: ModerateTextResponse type: object - id: CpuMetric + XPSXraiAttribution: + deprecated: true properties: - machineSpec: + stepCount: + description: >- + The number of steps for approximating the path integral. A good + value to start is 50 and gradually increase until the sum to diff + property is met within the desired error range. Valid range of its + value is [1, 100], inclusively. + type: integer + format: int32 + description: >- + An explanation method that redistributes Integrated Gradients + attributions to segmented regions, taking advantage of the model's fully + differentiable structure. Refer to this paper for more details: + https://arxiv.org/abs/1906.02825 Only supports image Models (modality is + IMAGE). + id: XPSXraiAttribution + type: object + XPSFileSpec: + description: >- + Spec of input and output files, on external file systems (CNS, GCS, + etc). + id: XPSFileSpec + properties: + singleFilePath: + deprecated: true + description: Deprecated. Use file_spec. + type: string + fileFormat: + enumDeprecated: + - false + - true + - false + - false + - false + - false + enum: + - FILE_FORMAT_UNKNOWN + - FILE_FORMAT_SSTABLE + - FILE_FORMAT_TRANSLATION_RKV + - FILE_FORMAT_RECORDIO + - FILE_FORMAT_RAW_CSV + - FILE_FORMAT_RAW_CAPACITOR + type: string enumDescriptions: - '' - '' + - >- + Internal format for parallel text data used by Google Translate. + go/rkvtools - '' + - >- + Only the lexicographically first file described by the file_spec + contains the header line. - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_2G - - A3_HIGHGPU_4G - - A3_HIGHGPU_8G - - A3_MEGAGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 - description: Required. Machine spec, e.g. N1_STANDARD_4. - type: string - coreNumber: - format: int64 - type: string - description: Required. Number of CPU cores. - cpuType: - enum: - - UNKNOWN_CPU_TYPE - - A2 - - A3 - - C2 - - C2D - - CUSTOM - - E2 - - G2 - - C3 - - M2 - - M1 - - N1 - - N2_CUSTOM - - N2 - - N2D - type: string - description: Required. Type of cpu, e.g. N2. - enumDescriptions: - - '' - - GPU-based machine, skip quota reporting. - - GPU-based machine, skip quota reporting. - - COMPUTE_OPTIMIZED - - '' - - '' - - '' - - GPU-based machine, skip quota reporting. - - '' - - MEMORY_OPTIMIZED_UPGRADE_PREMIUM - - MEMORY_OPTIMIZED - - '' - - '' - - '' - - '' - trackingLabels: - type: object - additionalProperties: - type: string - description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" - coreSec: - type: string - description: Required. Total seconds of core usage, e.g. 4. - format: int64 - description: Metric for billing reports. - XPSTablesClassificationMetricsCurveMetrics: - id: XPSTablesClassificationMetricsCurveMetrics - description: Metrics curve data point for a single value. - properties: - aucRoc: - format: double - description: The area under receiver operating characteristic curve. - type: number - confidenceMetricsEntries: - items: - $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' - description: >- - Metrics that have confidence thresholds. Precision-recall curve and - ROC curve can be derived from them. - type: array - positionThreshold: - type: integer - format: int32 - description: The position threshold value used to compute the metrics. - aucPr: - type: number - format: double - description: The area under the precision-recall curve. - value: - type: string - description: >- - The CATEGORY row value (for ARRAY unnested) the curve metrics are - for. - logLoss: - format: double - type: number - description: The Log loss metric. - type: object - XPSTimestampStatsGranularStats: - type: object - properties: - buckets: - description: >- - A map from granularity key to example count for that key. E.g. for - hour_of_day `13` means 1pm, or for month_of_year `5` means May). - additionalProperties: - format: int64 - type: string - type: object - description: Stats split by a defined in context granularity. - id: XPSTimestampStatsGranularStats - Status: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: Status - properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: array - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: object - DiskMetric: - type: object - id: DiskMetric - properties: - gibSec: - description: Required. Seconds of physical disk usage, e.g. 3600. - format: int64 - type: string - diskType: - enum: - - UNKNOWN_DISK_TYPE - - REGIONAL_SSD - - REGIONAL_STORAGE - - PD_SSD - - PD_STANDARD - - STORAGE_SNAPSHOT - description: Required. Type of Disk, e.g. REGIONAL_SSD. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - type: string - XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: - type: object - properties: - diceScoreCoefficient: - type: number - format: float - description: 'DSC or the F1 score: The harmonic mean of recall and precision.' - iouScore: - description: IOU score. - format: float - type: number - confidenceThreshold: - type: number - format: float - description: The confidence threshold value used to compute the metrics. - recall: - type: number - description: Recall for the given confidence threshold. - format: float - precision: - description: Precision for the given confidence threshold. - format: float - type: number - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' - description: >- - Confusion matrix of the per confidence_threshold evaluation. Pixel - counts are set here. Only set for model level evaluation, not for - evaluation per label. - description: Metrics for a single confidence threshold. - id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry - XPSTextComponentModel: - type: object - description: 'Component model. Next ID: 10' - id: XPSTextComponentModel - properties: - tfRuntimeVersion: - description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list - type: string - onlinePredictionModelGcsUri: - description: The Cloud Storage resource path to hold online prediction model. - type: string - servoModelName: - type: string - description: >- - The name of servo model. Populated by uCAIP BE as part of online - PredictRequest. - servingArtifact: - description: >- - The default model binary file used for serving (e.g. online predict, - batch predict) via public Cloud Ai Platform API. - $ref: '#/components/schemas/XPSModelArtifactItem' - versionNumber: - description: >- - The servomatic model version number. Populated by uCAIP BE as part - of online PredictRequest. - format: int64 - type: string - submodelName: - description: The name of the trained NL submodel. - type: string - partition: - type: string - description: >- - The partition where the model is deployed. Populated by uCAIP BE as - part of online PredictRequest. - enumDescriptions: - - '' - - The default partition. - - >- - It has significantly lower replication than partition-0 and is - located in the US only. It also has a larger model size limit and - higher default RAM quota than partition-0. Customers with batch - traffic, US-based traffic, or very large models should use this - partition. Capacity in this partition is significantly cheaper - than partition-0. - - >- - To be used by customers with Jellyfish-accelerated ops. See - go/servomatic-jellyfish for details. - - The partition used by regionalized servomatic cloud regions. - - The partition used for loading models from custom storage. - enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU - submodelType: - enum: - - TEXT_MODEL_TYPE_UNSPECIFIED - - TEXT_MODEL_TYPE_DEFAULT - - TEXT_MODEL_TYPE_META_ARCHITECT - - TEXT_MODEL_TYPE_ATC - - TEXT_MODEL_TYPE_CLARA2 - - TEXT_MODEL_TYPE_CHATBASE - - TEXT_MODEL_TYPE_SAFT_SPAN_LABELING - - TEXT_MODEL_TYPE_TEXT_EXTRACTION - - TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION - - TEXT_MODEL_TYPE_COMPOSITE - - TEXT_MODEL_TYPE_ALL_MODELS - - TEXT_MODEL_TYPE_BERT - - TEXT_MODEL_TYPE_ENC_PALM - type: string - description: The type of trained NL submodel - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - Model type for entity extraction. - - Model type for relationship extraction. - - >- - A composite model represents a set of component models that have - to be used together for prediction. A composite model appears to - be a single model to the model user. It may contain only one - component model. Please refer to go/cnl-composite-models for more - information. - - >- - Model type used to train default, MA, and ATC models in a single - batch worker pipeline. - - >- - BERT pipeline needs a specific model type, since it uses a - different TFX configuration compared with DEFAULT (despite sharing - most of the code). - - Model type for EncPaLM. - batchPredictionModelGcsUri: - type: string - description: The Cloud Storage resource path to hold batch prediction model. - XPSDataStats: - properties: - timestampStats: - $ref: '#/components/schemas/XPSTimestampStats' - description: The statistics for TIMESTAMP DataType. - structStats: - description: The statistics for STRUCT DataType. - $ref: '#/components/schemas/XPSStructStats' - validValueCount: - format: int64 - description: The number of values that are valid. - type: string - distinctValueCount: - type: string - description: The number of distinct values. - format: int64 - arrayStats: - $ref: '#/components/schemas/XPSArrayStats' - description: The statistics for ARRAY DataType. - nullValueCount: - format: int64 - type: string - description: The number of values that are null. - stringStats: - description: The statistics for STRING DataType. - $ref: '#/components/schemas/XPSStringStats' - categoryStats: - description: The statistics for CATEGORY DataType. - $ref: '#/components/schemas/XPSCategoryStats' - float64Stats: - description: The statistics for FLOAT64 DataType. - $ref: '#/components/schemas/XPSFloat64Stats' - type: object - description: The data statistics of a series of values that share the same DataType. - id: XPSDataStats - AnalyzeSentimentRequest: - id: AnalyzeSentimentRequest - description: The sentiment analysis request message. - properties: - encodingType: - type: string - enumDescriptions: - - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - description: The encoding type used by the API to calculate sentence offsets. - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - type: object - XPSDataType: - properties: - timeFormat: - description: >- - If type_code == TIMESTAMP then `time_format` provides the format in - which that time field is expressed. The time_format must be written - in `strftime` syntax. If time_format is not set, then the default - format as described on the field is used. - type: string - typeCode: - enum: - - TYPE_CODE_UNSPECIFIED - - FLOAT64 - - TIMESTAMP - - STRING - - ARRAY - - STRUCT - - CATEGORY - enumDescriptions: - - Not specified. Should not be used. - - >- - Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or - `"-Infinity"`. - - >- - Must be between 0AD and 9999AD. Encoded as `string` according to - time_format, or, if that format is not set, then in RFC 3339 - `date-time` format, where `time-offset` = `"Z"` (e.g. - 1985-04-12T23:20:50.52Z). - - Encoded as `string`. - - >- - Encoded as `list`, where the list elements are represented - according to list_element_type. - - >- - Encoded as `struct`, where field values are represented according - to struct_type. - - >- - Values of this type are not further understood by AutoML, e.g. - AutoML is unable to tell the order of values (as it could with - FLOAT64), or is unable to say if one value contains another (as it - could with STRING). Encoded as `string` (bytes should be - base64-encoded, as described in RFC 4648, section 4). - type: string - description: Required. The TypeCode for this type. - structType: - description: >- - If type_code == STRUCT, then `struct_type` provides type information - for the struct's fields. - $ref: '#/components/schemas/XPSStructType' - nullable: - type: boolean - description: If true, this DataType can also be `null`. - compatibleDataTypes: - type: array - items: - $ref: '#/components/schemas/XPSDataType' - description: The highly compatible data types to this data type. - listElementType: - $ref: '#/components/schemas/XPSDataType' - description: >- - If type_code == ARRAY, then `list_element_type` is the type of the - elements. - type: object - id: XPSDataType - description: >- - Indicated the type of data that can be stored in a structured data - entity (e.g. a table). - XPSVideoActionMetricsEntryConfidenceMetricsEntry: - id: XPSVideoActionMetricsEntryConfidenceMetricsEntry - type: object - properties: - recall: - format: float - type: number - description: Output only. Recall for the given confidence threshold. - confidenceThreshold: - format: float - description: >- - Output only. The confidence threshold value used to compute the - metrics. - type: number - precision: - description: Output only. Precision for the given confidence threshold. - format: float - type: number - f1Score: - format: float - type: number - description: Output only. The harmonic mean of recall and precision. - description: Metrics for a single confidence threshold. - XPSRow: - id: XPSRow - properties: - values: - description: >- - The values of the row cells, given in the same order as the - column_ids. If column_ids is not set, then in the same order as the - input_feature_column_ids in TablesModelMetadata. - items: - type: any - type: array - columnIds: - description: >- - The ids of the columns. Note: The below `values` field must match - order of this field, if this field is set. - items: - type: integer - format: int32 - type: array - type: object - XPSImageSegmentationTrainResponse: - properties: - trainCostNodeSeconds: - type: string - format: int64 - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - modelArtifactSpec: - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - description: >- - ## The fields below are only populated under uCAIP request scope. - Model artifact spec stores and model gcs pathes and related metadata - stopReason: - type: string - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED - enumDescriptions: - - '' - - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - colorMaps: - description: Color map of the model. - type: array - items: - $ref: '#/components/schemas/XPSColorMap' - exportModelSpec: - description: 'NOTE: These fields are not used/needed in EAP but will be set later.' - $ref: '#/components/schemas/XPSImageExportModelSpec' - type: object - id: XPSImageSegmentationTrainResponse - XPSImageModelArtifactSpec: - id: XPSImageModelArtifactSpec - type: object - properties: - checkpointArtifact: - $ref: '#/components/schemas/XPSModelArtifactItem' - description: The Tensorflow checkpoint files. e.g. Used for resumable training. - servingArtifact: - description: >- - The default model binary file used for serving (e.g. online predict, - batch predict) via public Cloud AI Platform API. - $ref: '#/components/schemas/XPSModelArtifactItem' - tfLiteMetadataGcsUri: - description: GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. - type: string - exportArtifact: - items: - $ref: '#/components/schemas/XPSModelArtifactItem' - type: array - description: The model binary files in different formats for model export. - labelGcsUri: - type: string - description: GCS uri of decoded labels file for model export 'dict.txt'. - tfJsBinaryGcsPrefix: - description: >- - GCS uri prefix of Tensorflow JavaScript binary files - 'groupX-shardXofX.bin' Deprecated. - type: string - description: >- - Stores the locations and related metadata of the model artifacts. - Populated for uCAIP requests only. - XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: - properties: - recall: - description: Recall for the given confidence threshold. - type: number - format: float - precision: - format: float - type: number - description: Precision for the given confidence threshold. - f1Score: - type: number - description: The harmonic mean of recall and precision. - format: float - confidenceThreshold: - type: number - format: float - description: The confidence threshold value used to compute the metrics. - description: Metrics for a single confidence threshold. - id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry - type: object - XPSDataErrors: - type: object - id: XPSDataErrors - description: Different types of errors and the stats associatesd with each error. - properties: - errorType: - type: string - description: Type of the error. - enumDescriptions: - - Not specified. - - >- - Audio format not in the formats by cloud-speech AutoML. Currently - only wav and flac file formats are supported. - - >- - File format differnt from what is specified in the file name - extension. - - File too large. Maximum allowed size is 50 MB. - - Transcript is missing. - enum: - - ERROR_TYPE_UNSPECIFIED - - UNSUPPORTED_AUDIO_FORMAT - - FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT - - FILE_TOO_LARGE - - MISSING_TRANSCRIPTION - count: - type: integer - format: int32 - description: Number of records having errors associated with the enum. - XPSEvaluationMetrics: - type: object - id: XPSEvaluationMetrics - description: >- - Contains xPS-specific model evaluation metrics either for a single - annotation spec (label), or for the model overall. Next tag: 18. - properties: - imageObjectDetectionEvalMetrics: - $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' - tablesEvalMetrics: - $ref: '#/components/schemas/XPSTablesEvaluationMetrics' - videoClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - videoActionRecognitionEvalMetrics: - $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' - annotationSpecIdToken: - type: string - description: >- - The annotation_spec for which this evaluation metrics instance had - been created. Empty iff this is an overall model evaluation (like - Tables evaluation metrics), i.e. aggregated across all labels. The - value comes from the input annotations in AnnotatedExample. For MVP - product or for text sentiment models where annotation_spec_id_token - is not available, set label instead. - videoObjectTrackingEvalMetrics: - $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' - textClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - regressionEvalMetrics: - $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' - translationEvalMetrics: - $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' - category: - type: integer - format: int32 - description: >- - The integer category label for which this evaluation metric instance - had been created. Valid categories are 0 or higher. Overall model - evaluation should set this to negative values (rather than implicit - zero). Only used for Image Segmentation (prefer to set - annotation_spec_id_token instead). Note: uCAIP Image Segmentation - should use annotation_spec_id_token. - tablesClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - imageSegmentationEvalMetrics: - $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' - label: + fileSpec: description: >- - The label for which this evaluation metrics instance had been - created. Empty iff this is an overall model evaluation (like Tables - evaluation metrics), i.e. aggregated across all labels. The label - maps to AnnotationSpec.display_name in Public API protos. Only used - by MVP implementation and text sentiment FULL implementation. + Single file path, or file pattern of format + "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is + expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and + /cns/cell-d/somewhere/file-00001-of-00002. type: string - textExtractionEvalMetrics: - $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' - textSentimentEvalMetrics: - $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' - imageClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - evaluatedExampleCount: - description: >- - The number of examples used to create this evaluation metrics - instance. - format: int32 - type: integer - XPSTablesDatasetMetadata: - properties: - primaryTableSpec: - description: Primary table. - $ref: '#/components/schemas/XPSTableSpec' - mlUseColumnId: - format: int32 - description: Id the column to split the table. - type: integer - weightColumnId: - format: int32 - description: >- - Id of the primary table column that should be used as the weight - column. - type: integer - targetColumnCorrelations: - description: '(the column id : its CorrelationStats with target column).' - additionalProperties: - $ref: '#/components/schemas/XPSCorrelationStats' - type: object - targetColumnId: - description: >- - Id of the primary table column that should be used as the training - label. - type: integer - format: int32 - id: XPSTablesDatasetMetadata - type: object - description: 'Metadata for a dataset used for AutoML Tables. Next ID: 6' - Color: - id: Color + directoryPath: + type: string + deprecated: true + description: Deprecated. Use file_spec. type: object - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... + XPSTrackMetricsEntryConfidenceMetricsEntry: + id: XPSTrackMetricsEntryConfidenceMetricsEntry + description: 'Metrics for a single confidence threshold. Next tag: 6.' properties: - green: - type: number + confidenceThreshold: format: float - description: The amount of green in the color as a value in the interval [0, 1]. - blue: type: number + description: >- + Output only. The confidence threshold value used to compute the + metrics. + trackingRecall: format: float - description: The amount of blue in the color as a value in the interval [0, 1]. - alpha: type: number - format: float + description: Output only. Tracking recall. + boundingBoxIou: description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - red: - description: The amount of red in the color as a value in the interval [0, 1]. + Output only. Bounding box intersection-over-union precision. + Measures how well the bounding boxes overlap between each other + (e.g. complete overlap or just barely above iou_threshold). type: number format: float - XPSTablesTrainResponse: - properties: - predictionSampleRows: - type: array - description: Sample rows from the dataset this model was trained. - items: - $ref: '#/components/schemas/XPSRow' - trainCostMilliNodeHours: - type: string - description: >- - The actual training cost of the model, expressed in milli node - hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed - to not exceed the train budget. - format: int64 - tablesModelColumnInfo: + mismatchRate: description: >- - Output only. Auxiliary information for each of the - input_feature_column_specs, with respect to this particular model. - items: - $ref: '#/components/schemas/XPSTablesModelColumnInfo' - type: array - modelStructure: - $ref: '#/components/schemas/XPSTablesModelStructure' - type: object - id: XPSTablesTrainResponse - XPSTablesClassificationMetrics: - id: XPSTablesClassificationMetrics - type: object - description: Metrics for Tables classification problems. - properties: - curveMetrics: - description: Metrics building a curve. - type: array - items: - $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' - XPSModelArtifactItem: + Output only. Mismatch rate, which measures the tracking consistency, + i.e. correctness of instance ID continuity. + format: float + type: number + trackingPrecision: + type: number + description: Output only. Tracking precision. + format: float type: object - description: A single model artifact item. - id: XPSModelArtifactItem + AnnotateTextRequest: properties: - gcsUri: - type: string - description: >- - The Google Cloud Storage (GCS) uri that stores the model binary - files. - artifactFormat: - description: The model artifact format. + features: + description: Required. The enabled features. + $ref: '#/components/schemas/AnnotateTextRequestFeatures' + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' + encodingType: + description: The encoding type used by the API to calculate offsets. enumDescriptions: - - Should not be used. - >- - The Tensorflow checkpoints. See - https://www.tensorflow.org/guide/checkpoint. - - The Tensorflow SavedModel binary. + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. - >- - Model artifact in generic TensorFlow Lite (.tflite) format. See - https://www.tensorflow.org/lite. - - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. - >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be - used in the browser and in Node.js using JavaScript. + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. - >- - Used for iOS mobile devices in (.mlmodel) format. See - https://developer.apple.com/documentation/coreml - type: string - enum: - - ARTIFACT_FORMAT_UNSPECIFIED - - TF_CHECKPOINT - - TF_SAVED_MODEL - - TF_LITE - - EDGE_TPU_TF_LITE - - TF_JS - - CORE_ML - XPSImageSegmentationEvaluationMetrics: - description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' - properties: - confidenceMetricsEntries: - items: - $ref: >- - #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. - type: array - id: XPSImageSegmentationEvaluationMetrics + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + type: string + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 type: object - XPSRegressionEvaluationMetrics: description: >- - Model evaluation metrics for regression problems. It can be used for - Tables. - id: XPSRegressionEvaluationMetrics + The request message for the text annotation API, which can perform + multiple analysis types in one call. + id: AnnotateTextRequest + XPSTablesModelColumnInfo: + description: >- + An information specific to given column and Tables Model, in context of + the Model and the predictions created by it. type: object + id: XPSTablesModelColumnInfo properties: - rootMeanSquaredError: - description: Root Mean Squared Error (RMSE). - type: number - format: float - regressionMetricsEntries: - items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' - type: array + featureImportance: description: >- - A list of actual versus predicted points for the model being - evaluated. - rSquared: - description: R squared. - type: number - format: float - meanAbsoluteError: + When given as part of a Model: Measurement of how much model + predictions correctness on the TEST data depend on values in this + column. A value between 0 and 1, higher means higher influence. + These values are normalized - for all input feature columns of a + given model they add to 1. When given back by Predict or Batch + Predict: Measurement of how impactful for the prediction returned + for the given row the value in this column was. Specifically, the + feature importance specifies the marginal contribution that the + feature made to the prediction score compared to the baseline score. + These values are computed using the Sampled Shapley method. format: float type: number - description: Mean Absolute Error (MAE). - rootMeanSquaredLogError: + columnId: + format: int32 + type: integer + description: The ID of the column. + XPSVideoObjectTrackingEvaluationMetrics: + type: object + properties: + boundingBoxMeanAveragePrecision: + description: >- + Output only. The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. type: number - description: Root mean squared log error. format: float - meanAbsolutePercentageError: - description: >- - Mean absolute percentage error. Only set if all ground truth values - are positive. + trackMeanAveragePrecision: type: number format: float - XPSXpsOperationMetadata: - type: object - id: XPSXpsOperationMetadata - properties: - videoBatchPredictOperationMetadata: - $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' - videoTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' - reportingMetrics: - $ref: '#/components/schemas/XPSReportingMetrics' description: >- - Metrics for the operation. By the time the operation is terminated - (whether succeeded or failed) as returned from XPS, AutoML BE - assumes the metrics are finalized. AutoML BE transparently posts the - metrics to Chemist if it's not empty, regardless of the response - content or error type. If user is supposed to be charged in case of - cancellation/error, this field should be set. In the case where the - type of LRO doesn't require any billing, this field should be left - unset. - exampleCount: - format: int64 + Output only. The single metric for tracks accuracy evaluation: the + mean_average_precision averaged over all track_metrics_entries. + trackMetricsEntries: description: >- - Optional. XPS server can opt to provide example count of the long - running operation (e.g. training, data importing, batch prediction). - type: string - tablesTrainingOperationMetadata: - $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' - visionTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' - XPSTablesConfidenceMetricsEntry: - type: object - properties: - falseNegativeCount: - format: int64 - description: False negative count. - type: string - trueNegativeCount: - description: True negative count. - type: string - format: int64 - f1Score: - type: number - format: double + Output only. The tracks match metrics for each + Intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + type: array + items: + $ref: '#/components/schemas/XPSTrackMetricsEntry' + boundingBoxMetricsEntries: + items: + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' + type: array description: >- - The harmonic mean of recall and precision. (2 * precision * recall) - / (precision + recall) - confidenceThreshold: - type: number - format: double - description: The confidence threshold value used to compute the metrics. - precision: - type: number - format: double - description: 'Precision = #true positives / (#true positives + #false positives).' - falsePositiveCount: - type: string - description: False positive count. - format: int64 - recall: - description: 'Recall = #true positives / (#true positives + #false negatives).' - type: number - format: double - falsePositiveRate: - type: number - format: double - description: 'FPR = #false positives / (#false positives + #true negatives)' - truePositiveCount: - format: int64 - type: string - description: True positive count. - truePositiveRate: - format: double - description: 'TPR = #true positives / (#true positives + #false negatvies)' + Output only. The bounding boxes match metrics for each + Intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + trackMeanBoundingBoxIou: type: number - id: XPSTablesConfidenceMetricsEntry - description: Metrics for a single confidence threshold. - AnalyzeEntitiesResponse: - description: The entity analysis response message. - properties: - languageSupported: - type: boolean + format: float description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - languageCode: - type: string + Output only. The single metric for tracks bounding box iou + evaluation: the mean_bounding_box_iou averaged over all + track_metrics_entries. + evaluatedBoundingboxCount: + description: The number of bounding boxes used for model evaluation. + format: int32 + type: integer + evaluatedTrackCount: + format: int32 + description: The number of tracks used for model evaluation. + type: integer + evaluatedFrameCount: + description: The number of video frames used for model evaluation. + format: int32 + type: integer + trackMeanMismatchRate: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - entities: - items: - $ref: '#/components/schemas/Entity' - description: The recognized entities in the input document. - type: array + Output only. The single metric for tracking consistency evaluation: + the mean_mismatch_rate averaged over all track_metrics_entries. + type: number + format: float + id: XPSVideoObjectTrackingEvaluationMetrics + description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' + XPSTablesDatasetMetadata: + description: 'Metadata for a dataset used for AutoML Tables. Next ID: 6' + id: XPSTablesDatasetMetadata type: object - id: AnalyzeEntitiesResponse - XPSVisualization: - description: Visualization configurations for image explanation. - deprecated: true properties: - colorMap: + targetColumnId: + type: integer description: >- - The color scheme used for the highlighted areas. Defaults to - PINK_GREEN for Integrated Gradients attribution, which shows - positive attributions in green and negative in pink. Defaults to - VIRIDIS for XRAI attribution, which highlights the most influential - regions in yellow and the least influential in blue. - enumDescriptions: - - Should not be used. - - 'Positive: green. Negative: pink.' - - >- - Viridis color map: A perceptually uniform color mapping which is - easier to see by those with colorblindness and progresses from - yellow to green to blue. Positive: yellow. Negative: blue. - - 'Positive: red. Negative: red.' - - 'Positive: green. Negative: green.' - - 'Positive: green. Negative: red.' - - PiYG palette. - type: string - enum: - - COLOR_MAP_UNSPECIFIED - - PINK_GREEN - - VIRIDIS - - RED - - GREEN - - RED_GREEN - - PINK_WHITE_GREEN - clipPercentLowerbound: - format: float + Id of the primary table column that should be used as the training + label. + format: int32 + primaryTableSpec: + description: Primary table. + $ref: '#/components/schemas/XPSTableSpec' + mlUseColumnId: + description: Id the column to split the table. + type: integer + format: int32 + weightColumnId: + format: int32 + description: >- + Id of the primary table column that should be used as the weight + column. + type: integer + targetColumnCorrelations: + additionalProperties: + $ref: '#/components/schemas/XPSCorrelationStats' + description: '(the column id : its CorrelationStats with target column).' + type: object + XPSTablesRegressionMetrics: + description: Metrics for Tables regression problems. + id: XPSTablesRegressionMetrics + type: object + properties: + rSquared: + format: double + description: R squared. + type: number + meanAbsolutePercentageError: + format: double type: number description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. - type: + Mean absolute percentage error, only set if all of the target + column's values are positive. + rootMeanSquaredError: + format: double + type: number + description: Root mean squared error. + rootMeanSquaredLogError: + description: Root mean squared log error. + type: number + format: double + meanAbsoluteError: + type: number + format: double + description: Mean absolute error. + regressionMetricsEntries: + items: + $ref: '#/components/schemas/XPSRegressionMetricsEntry' + description: >- + A list of actual versus predicted points for the model being + evaluated. + type: array + XPSConfidenceMetricsEntry: + id: XPSConfidenceMetricsEntry + properties: + positionThreshold: + description: >- + Metrics are computed with an assumption that the model always + returns at most this many predictions (ordered by their score, + descendingly), but they all still need to meet the + confidence_threshold. + type: integer + format: int32 + falsePositiveCount: + format: int64 type: string description: >- - Type of the image visualization. Only applicable to Integrated - Gradients attribution. OUTLINES shows regions of attribution, while - PIXELS shows per-pixel attribution. Defaults to OUTLINES. - enumDescriptions: - - Should not be used. - - Shows which pixel contributed to the image prediction. - - >- - Shows which region contributed to the image prediction by - outlining the region. - enum: - - TYPE_UNSPECIFIED - - PIXELS - - OUTLINES - clipPercentUpperbound: + The number of model created labels that do not match a ground truth + label. + recall: + type: number + format: float + description: Recall (true positive rate) for the given confidence threshold. + recallAt1: + format: float description: >- - Excludes attributions above the specified percentile from the - highlighted areas. Using the clip_percent_upperbound and - clip_percent_lowerbound together can be useful for filtering out - noise and making it easier to see areas of strong attribution. - Defaults to 99.9. + The recall (true positive rate) when only considering the label that + has the highest prediction score and not below the confidence + threshold for each example. + type: number + f1ScoreAt1: type: number format: float - overlayType: + description: The harmonic mean of recall_at1 and precision_at1. + falsePositiveRateAt1: + format: float + type: number description: >- - How the original image is displayed in the visualization. Adjusting - the overlay can help increase visual clarity if the original image - makes it difficult to view the visualization. Defaults to NONE. + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each example. + falsePositiveRate: + type: number + format: float + description: False Positive Rate for the given confidence threshold. + f1Score: + type: number + description: The harmonic mean of recall and precision. + format: float + falseNegativeCount: type: string - enum: - - OVERLAY_TYPE_UNSPECIFIED - - NONE - - ORIGINAL - - GRAYSCALE - - MASK_BLACK - enumDescriptions: - - Default value. This is the same as NONE. - - No overlay. - - The attributions are shown on top of the original image. - - >- - The attributions are shown on top of grayscaled version of the - original image. - - >- - The attributions are used as a mask to reveal predictive parts of - the image and hide the un-predictive parts. - polarity: description: >- - Whether to only highlight pixels with positive contributions, - negative or both. Defaults to POSITIVE. + The number of ground truth labels that are not matched by a model + created label. + format: int64 + truePositiveCount: + description: The number of model created labels that match a ground truth label. type: string - enumDescriptions: - - Default value. This is the same as POSITIVE. - - >- - Highlights the pixels/outlines that were most influential to the - model's prediction. - - >- - Setting polarity to negative highlights areas that does not lead - to the models's current prediction. - - Shows both positive and negative attributions. - enum: - - POLARITY_UNSPECIFIED - - POSITIVE - - NEGATIVE - - BOTH - type: object - id: XPSVisualization - XPSStructStats: - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - fieldStats: - type: object - description: >- - Map from a field name of the struct to data stats aggregated over - series of all data in that field across all the structs. - additionalProperties: - $ref: '#/components/schemas/XPSDataStats' - type: object - description: The data statistics of a series of STRUCT values. - id: XPSStructStats - XPSPreprocessResponse: - properties: - speechPreprocessResp: - $ref: '#/components/schemas/XPSSpeechPreprocessResponse' - translationPreprocessResp: - $ref: '#/components/schemas/XPSTranslationPreprocessResponse' - outputExampleSet: - $ref: '#/components/schemas/XPSExampleSet' + format: int64 + confidenceThreshold: description: >- - Preprocessed examples, that are to be imported into AutoML storage. - This should point to RecordIO file(s) of PreprocessedExample - messages. The PreprocessedExample.mvp_training_data-s returned here - are later verbatim passed to Train() call in - TrainExample.mvp_training_data. - tablesPreprocessResponse: - $ref: '#/components/schemas/XPSTablesPreprocessResponse' - id: XPSPreprocessResponse - type: object - description: 'Next ID: 8' - XPSImageModelServingSpecModelThroughputEstimation: - type: object - id: XPSImageModelServingSpecModelThroughputEstimation - properties: - computeEngineAcceleratorType: - enum: - - UNSPECIFIED - - NVIDIA_TESLA_K80 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_V100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_L4 - - NVIDIA_H100_80GB - - NVIDIA_H100_MEGA_80GB - - TPU_V2 - - TPU_V3 - - TPU_V4_POD - - TPU_V5_LITEPOD - type: string - enumDescriptions: - - '' - - Nvidia Tesla K80 GPU. - - Nvidia Tesla P100 GPU. - - Nvidia Tesla V100 GPU. - - Nvidia Tesla P4 GPU. - - Nvidia Tesla T4 GPU. - - Nvidia Tesla A100 GPU. - - Nvidia A100 80GB GPU. - - Nvidia L4 GPU. - - Nvidia H100 80Gb GPU. - - Nvidia H100 80Gb GPU. - - TPU v2 (JellyFish). - - TPU v3 (DragonFish). - - TPU_v4 (PufferFish). - - TPU v5 Lite Pods. - latencyInMilliseconds: - format: double - description: Estimated latency. + Metrics are computed with an assumption that the model never return + predictions with score lower than this value. + format: float type: number - nodeQps: + precision: + format: float type: number - description: The approximate qps a deployed node can serve. - format: double - servomaticPartitionType: - enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU - enumDescriptions: - - '' - - The default partition. - - >- - It has significantly lower replication than partition-0 and is - located in the US only. It also has a larger model size limit and - higher default RAM quota than partition-0. Customers with batch - traffic, US-based traffic, or very large models should use this - partition. Capacity in this partition is significantly cheaper - than partition-0. - - >- - To be used by customers with Jellyfish-accelerated ops. See - go/servomatic-jellyfish for details. - - The partition used by regionalized servomatic cloud regions. - - The partition used for loading models from custom storage. + description: Precision for the given confidence threshold. + precisionAt1: + type: number + format: float + description: >- + The precision when only considering the label that has the highest + prediction score and not below the confidence threshold for each + example. + trueNegativeCount: type: string - XPSTablesModelStructureModelParameters: - description: Model hyper-parameters for a model. + description: >- + The number of labels that were not created by the model, but if they + would, they would not match a ground truth label. + format: int64 type: object - id: XPSTablesModelStructureModelParameters + description: >- + ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. + Next tag: 16. + XPSTextToSpeechTrainResponse: + id: XPSTextToSpeechTrainResponse + description: TextToSpeech train response + type: object + properties: {} + XPSVideoObjectTrackingTrainResponse: properties: - hyperparameters: - type: array - items: - $ref: >- - #/components/schemas/XPSTablesModelStructureModelParametersParameter + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + exportModelSpec: + $ref: '#/components/schemas/XPSVideoExportModelSpec' + description: Populated for AutoML request only. + trainCostNodeSeconds: + type: string + format: int64 + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + type: object + id: XPSVideoObjectTrackingTrainResponse XPSTfLiteFormat: - properties: {} id: XPSTfLiteFormat - type: object description: >- LINT.IfChange A model format used for mobile and IoT devices. See https://www.tensorflow.org/lite. - XPSConfusionMatrix: + properties: {} type: object - id: XPSConfusionMatrix - description: Confusion matrix of the model running the classification. + XPSSpeechModelSpec: + id: XPSSpeechModelSpec properties: - sentimentLabel: - description: >- - Sentiment labels used in the confusion matrix. Set only for text - sentiment models. For AutoML Text Revamp, use - `annotation_spec_id_token` instead and leave this field empty. - type: array - items: - format: int32 - type: integer - category: - items: - format: int32 - type: integer - description: >- - Category (mainly for segmentation). Set only for image segmentation - models. Note: uCAIP Image Segmentation should use - annotation_spec_id_token. - type: array - annotationSpecIdToken: - type: array + language: + type: string + subModelSpecs: + description: Model specs for all submodels contained in this model. items: - type: string - description: >- - For the following three repeated fields, only one is intended to be - set. annotation_spec_id_token is preferable to be set. ID tokens of - the annotation specs used in the confusion matrix. - row: + $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' type: array - items: - $ref: '#/components/schemas/XPSConfusionMatrixRow' + datasetId: + type: string description: >- - Rows in the confusion matrix. The number of rows is equal to the - size of `annotation_spec_id_token`. `row[i].value[j]` is the number - of examples that have ground truth of the - `annotation_spec_id_token[i]` and are predicted as - `annotation_spec_id_token[j]` by the model being evaluated. - XPSResponseExplanationParameters: + Required for speech xps backend. Speech xps has to use dataset_id + and model_id as the primary key in db so that speech API can query + the db directly. + format: int64 + type: object + XPSXpsOperationMetadata: + id: XPSXpsOperationMetadata type: object - id: XPSResponseExplanationParameters - deprecated: true properties: - xraiAttribution: - $ref: '#/components/schemas/XPSXraiAttribution' - description: >- - An attribution method that redistributes Integrated Gradients - attribution to segmented regions, taking advantage of the model's - fully differentiable structure. Refer to this paper for more - details: https://arxiv.org/abs/1906.02825 XRAI currently performs - better on natural images, like a picture of a house or an animal. If - the images are taken in artificial environments, like a lab or - manufacturing line, or from diagnostic equipment, like x-rays or - quality-control cameras, use Integrated Gradients instead. - integratedGradientsAttribution: - $ref: '#/components/schemas/XPSIntegratedGradientsAttribution' + visionTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' + reportingMetrics: + $ref: '#/components/schemas/XPSReportingMetrics' description: >- - An attribution method that computes Aumann-Shapley values taking - advantage of the model's fully differentiable structure. Refer to - this paper for more details: https://arxiv.org/abs/1703.01365 - ModerateTextRequest: - properties: - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - modelVersion: + Metrics for the operation. By the time the operation is terminated + (whether succeeded or failed) as returned from XPS, AutoML BE + assumes the metrics are finalized. AutoML BE transparently posts the + metrics to Chemist if it's not empty, regardless of the response + content or error type. If user is supposed to be charged in case of + cancellation/error, this field should be set. In the case where the + type of LRO doesn't require any billing, this field should be left + unset. + tablesTrainingOperationMetadata: + $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' + exampleCount: type: string - enumDescriptions: - - The default model version. - - >- - Use the v1 model, this model is used by default when not provided. - The v1 model only returns probability (confidence) score for each - category. - - >- - Use the v2 model. The v2 model only returns probability - (confidence) score for each category, and returns severity score - for a subset of the categories. - description: Optional. The model version to use for ModerateText. - enum: - - MODEL_VERSION_UNSPECIFIED - - MODEL_VERSION_1 - - MODEL_VERSION_2 - id: ModerateTextRequest + format: int64 + description: >- + Optional. XPS server can opt to provide example count of the long + running operation (e.g. training, data importing, batch prediction). + videoTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' + videoBatchPredictOperationMetadata: + $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' + XPSTablesTrainingOperationMetadata: type: object - description: The document moderation request message. - XPSImageObjectDetectionModelSpec: - id: XPSImageObjectDetectionModelSpec properties: - exportModelSpec: - $ref: '#/components/schemas/XPSImageExportModelSpec' - maxBoundingBoxCount: + trainingObjectivePoints: + items: + $ref: '#/components/schemas/XPSTrainingObjectivePoint' + type: array + description: >- + This field records the training objective value with respect to + time, giving insight into how the model architecture search is + performing as training time elapses. + optimizationObjective: + description: The optimization objective for model. type: string - format: int64 - description: Max number of bounding box. - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - classCount: - format: int64 - description: Total number of classes. + trainingStartTime: + description: Timestamp when training process starts. type: string - trainCostNodeSeconds: - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - format: int64 + format: google-datetime + createModelStage: + enum: + - CREATE_MODEL_STAGE_UNSPECIFIED + - DATA_PREPROCESSING + - TRAINING + - EVALUATING + - MODEL_POST_PROCESSING + enumDescriptions: + - Unspecified stage. + - Prepare the model training pipeline and run data processing. + - Training model. + - Run evaluation. + - Finalizing model training pipeline. type: string - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - stopReason: + description: Current stage of creating model. + trainBudgetMilliNodeHours: + description: Creating model budget. type: string + format: int64 + topTrials: description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. - enumDescriptions: - - '' - - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + This field is for training. When the operation is terminated + successfully, AutoML Backend post this field to operation metadata + in spanner. If the metadata has no trials returned, the training + operation is supposed to be a failure. + items: + $ref: '#/components/schemas/XPSTuningTrial' + type: array + id: XPSTablesTrainingOperationMetadata + XPSCoreMlFormat: + properties: {} + description: A model format used for iOS mobile devices. type: object - XPSTrainingObjectivePoint: + id: XPSCoreMlFormat + XPSEvaluationMetricsSet: + id: XPSEvaluationMetricsSet type: object + description: Specifies location of model evaluation metrics. properties: - createTime: - type: string - description: The time at which this point was recorded. - format: google-datetime - value: - type: number - description: The objective value when this point was recorded. - format: float - id: XPSTrainingObjectivePoint - XPSMetricEntry: - properties: - doubleValue: - format: double - type: number - description: A double value. - int64Value: - type: string - description: A signed 64-bit integer value. + fileSpec: + $ref: '#/components/schemas/XPSFileSpec' + description: >- + File spec containing evaluation metrics of a model, must point to + RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics + messages. + numEvaluationMetrics: + description: >- + Number of the evaluation metrics (usually one per label plus + overall). format: int64 - systemLabels: - type: array - description: Billing system labels for this (metric, value) pair. + type: string + evaluationMetrics: items: - $ref: '#/components/schemas/XPSMetricEntryLabel' - metricName: - description: The metric name defined in the service configuration. + $ref: '#/components/schemas/XPSEvaluationMetrics' + description: >- + Inline EvaluationMetrics - should be relatively small. For passing + large quantities of exhaustive metrics, use file_spec. + type: array + XPSTrainResponse: + properties: + videoActionRecognitionTrainResp: + $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' + speechTrainResp: + $ref: '#/components/schemas/XPSSpeechModelSpec' + tablesTrainResp: + $ref: '#/components/schemas/XPSTablesTrainResponse' + evaluationMetricsSet: + description: >- + The trained model evaluation metrics. This can be optionally + returned. + $ref: '#/components/schemas/XPSEvaluationMetricsSet' + deployedModelSizeBytes: + description: Estimated model size in bytes once deployed. type: string - argentumMetricId: + format: int64 + modelToken: + description: >- + Token that represents the trained model. This is considered + immutable and is persisted in AutoML. xPS can put their own proto in + the byte string, to e.g. point to the model checkpoints. The token + is passed to other xPS APIs to refer to the model. + format: byte type: string + imageObjectDetectionTrainResp: + $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' + evaluatedExampleSet: + $ref: '#/components/schemas/XPSExampleSet' description: >- - For billing metrics that are using legacy sku's, set the legacy - billing metric id here. This will be sent to Chemist as the - "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise - leave empty. - type: object - id: XPSMetricEntry - XPSStringStats: - id: XPSStringStats - properties: - topUnigramStats: + Examples used to evaluate the model (usually the test set), with the + predicted annotations. The file_spec should point to recordio + file(s) of AnnotatedExample. For each returned example, the + example_id_token and annotations predicted by the model must be set. + The example payload can and is recommended to be omitted. + explanationConfigs: + type: array items: - $ref: '#/components/schemas/XPSStringStatsUnigramStats' + $ref: '#/components/schemas/XPSResponseExplanationSpec' description: >- - The statistics of the top 20 unigrams, ordered by - StringStats.UnigramStats.count. + VisionExplanationConfig for XAI on test set. Optional for when XAI + is enable in training request. + deprecated: true + videoObjectTrackingTrainResp: + $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' + textTrainResp: + description: Will only be needed for uCAIP from Beta. + $ref: '#/components/schemas/XPSTextTrainResponse' + errorAnalysisConfigs: type: array - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - description: The data statistics of a series of STRING values. - type: object - XPSSpeechEvaluationMetricsSubModelEvaluationMetric: - id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric + items: + $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' + description: >- + Optional vision model error analysis configuration. The field is set + when model error analysis is enabled in the training request. The + results of error analysis will be binded together with evaluation + results (in the format of AnnotatedExample). + translationTrainResp: + $ref: '#/components/schemas/XPSTranslationTrainResponse' + videoClassificationTrainResp: + $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' + imageClassificationTrainResp: + $ref: '#/components/schemas/XPSImageClassificationTrainResponse' + imageSegmentationTrainResp: + $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' + textToSpeechTrainResp: + $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' type: object + description: 'Next ID: 18' + id: XPSTrainResponse + EntityMention: + id: EntityMention properties: - isEnhancedModel: - description: >- - If true then it means we have an enhanced version of the biasing - models. - type: boolean - numDeletions: - format: int32 - type: integer - numWords: - description: Number of words over which the word error rate was computed. - format: int32 - type: integer - sentenceAccuracy: - format: double - type: number - description: Below fields are used for debugging purposes - wer: - format: double - type: number - description: Word error rate (standard error metric used for speech recognition). - numUtterances: - description: Number of utterances used in the wer computation. - format: int32 - type: integer - numSubstitutions: - format: int32 - type: integer - numInsertions: - type: integer - format: int32 - biasingModelType: - description: Type of the biasing model. - enumDescriptions: - - '' - - Build biasing model on top of COMMAND_AND_SEARCH model - - Build biasing model on top of PHONE_CALL model - - Build biasing model on top of VIDEO model - - Build biasing model on top of DEFAULT model - enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT + text: + $ref: '#/components/schemas/TextSpan' + description: The mention text. + type: type: string - AnalyzeEntitiesRequest: - description: The entity analysis request message. - id: AnalyzeEntitiesRequest - properties: - encodingType: - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - description: The encoding type used by the API to calculate offsets. enumDescriptions: - - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - type: string - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - type: object - ClassifyTextRequest: - id: ClassifyTextRequest - description: The document classification request message. - type: object - properties: - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - XPSResponseExplanationMetadata: - id: XPSResponseExplanationMetadata - type: object - properties: - outputs: - type: object - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' - description: Metadata of the output. - inputs: - description: Metadata of the input. - type: object - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' - deprecated: true - XPSImageObjectDetectionEvaluationMetrics: - type: object - description: >- - Model evaluation metrics for image object detection problems. Evaluates - prediction quality of labeled bounding boxes. - id: XPSImageObjectDetectionEvaluationMetrics - properties: - boundingBoxMeanAveragePrecision: + - Unknown + - Proper name + - Common noun (or noun compound) + description: The type of the entity mention. + enum: + - TYPE_UNKNOWN + - PROPER + - COMMON + probability: + description: >- + Probability score associated with the entity. The score shows the + probability of the entity mention being the entity type. The score + is in (0, 1] range. format: float type: number + sentiment: + $ref: '#/components/schemas/Sentiment' description: >- - The single metric for bounding boxes evaluation: the - mean_average_precision averaged over all - bounding_box_metrics_entries. - boundingBoxMetricsEntries: - type: array - items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' - description: >- - The bounding boxes match metrics for each Intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - evaluatedBoundingBoxCount: + For calls to AnalyzeEntitySentiment or if + AnnotateTextRequest.Features.extract_entity_sentiment is set to + true, this field will contain the sentiment expressed for this + mention of the entity in the provided document. + type: object + description: >- + Represents a mention for an entity in the text. Currently, proper noun + mentions are supported. + XPSIntegratedGradientsAttribution: + description: >- + An attribution method that computes the Aumann-Shapley value taking + advantage of the model's fully differentiable structure. Refer to this + paper for more details: https://arxiv.org/abs/1703.01365 + deprecated: true + properties: + stepCount: description: >- - The total number of bounding boxes (i.e. summed over all images) the - ground truth used to create this evaluation had. - type: integer + The number of steps for approximating the path integral. A good + value to start is 50 and gradually increase until the sum to diff + property is within the desired error range. Valid range of its value + is [1, 100], inclusively. format: int32 - XPSMetricEntryLabel: - properties: - labelName: - type: string - description: The name of the label. - labelValue: - type: string - description: The value of the label. - id: XPSMetricEntryLabel + type: integer type: object - XPSTablesModelStructureModelParametersParameter: - properties: - floatValue: - type: number - description: Float type parameter value. - format: double - name: - description: Parameter name. - type: string - stringValue: - description: String type parameter value. - type: string - intValue: - type: string - description: Integer type parameter value. - format: int64 - id: XPSTablesModelStructureModelParametersParameter + id: XPSIntegratedGradientsAttribution + XPSTablesModelStructure: type: object - AnnotateTextResponse: - description: The text annotations response message. properties: - languageSupported: - type: boolean - description: >- - Whether the language is officially supported by all requested - features. The API may still return a response when the language is - not supported, but it is on a best effort basis. - categories: - items: - $ref: '#/components/schemas/ClassificationCategory' - description: Categories identified in the input document. - type: array - languageCode: - type: string - description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - documentSentiment: - $ref: '#/components/schemas/Sentiment' - description: >- - The overall sentiment for the document. Populated if the user - enables AnnotateTextRequest.Features.extract_document_sentiment. - moderationCategories: + modelParameters: items: - $ref: '#/components/schemas/ClassificationCategory' - description: Harmful and sensitive categories identified in the input document. + $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' + description: A list of models. type: array - entities: + id: XPSTablesModelStructure + description: A description of Tables model structure. + XPSRegressionEvaluationMetrics: + id: XPSRegressionEvaluationMetrics + description: >- + Model evaluation metrics for regression problems. It can be used for + Tables. + type: object + properties: + regressionMetricsEntries: type: array - items: - $ref: '#/components/schemas/Entity' description: >- - Entities, along with their semantic information, in the input - document. Populated if the user enables - AnnotateTextRequest.Features.extract_entities or - AnnotateTextRequest.Features.extract_entity_sentiment. - sentences: - type: array + A list of actual versus predicted points for the model being + evaluated. items: - $ref: '#/components/schemas/Sentence' + $ref: '#/components/schemas/XPSRegressionMetricsEntry' + meanAbsoluteError: + description: Mean Absolute Error (MAE). + format: float + type: number + meanAbsolutePercentageError: + type: number + format: float description: >- - Sentences in the input document. Populated if the user enables - AnnotateTextRequest.Features.extract_document_sentiment. - id: AnnotateTextResponse - type: object + Mean absolute percentage error. Only set if all ground truth values + are positive. + rootMeanSquaredError: + type: number + format: float + description: Root Mean Squared Error (RMSE). + rSquared: + description: R squared. + format: float + type: number + rootMeanSquaredLogError: + description: Root mean squared log error. + format: float + type: number XPSVideoBatchPredictOperationMetadata: id: XPSVideoBatchPredictOperationMetadata + type: object properties: outputExamples: - items: - type: string description: >- All the partial batch prediction results that are completed at the moment. Output examples are sorted by completion time. The order will not be changed. Each output example should be the path of a single RecordIO file of AnnotatedExamples. type: array + items: + type: string + XPSCorrelationStats: + id: XPSCorrelationStats type: object - XPSEvaluationMetricsSet: - id: XPSEvaluationMetricsSet properties: - evaluationMetrics: - items: - $ref: '#/components/schemas/XPSEvaluationMetrics' - type: array - description: >- - Inline EvaluationMetrics - should be relatively small. For passing - large quantities of exhaustive metrics, use file_spec. - numEvaluationMetrics: - type: string - format: int64 - description: >- - Number of the evaluation metrics (usually one per label plus - overall). - fileSpec: - $ref: '#/components/schemas/XPSFileSpec' - description: >- - File spec containing evaluation metrics of a model, must point to - RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics - messages. - description: Specifies location of model evaluation metrics. + cramersV: + format: double + description: The correlation value using the Cramer's V measure. + type: number + description: >- + A correlation statistics between two series of DataType values. The + series may have differing DataType-s, but within a single series the + DataType must be the same. + XPSModelArtifactItem: + description: A single model artifact item. + id: XPSModelArtifactItem type: object - XPSTranslationPreprocessResponse: - description: Translation preprocess response. properties: - validExampleCount: + gcsUri: type: string - description: Total valid example count. - format: int64 - parsedExampleCount: + description: >- + The Google Cloud Storage (GCS) uri that stores the model binary + files. + artifactFormat: + enumDescriptions: + - Should not be used. + - >- + The Tensorflow checkpoints. See + https://www.tensorflow.org/guide/checkpoint. + - The Tensorflow SavedModel binary. + - >- + Model artifact in generic TensorFlow Lite (.tflite) format. See + https://www.tensorflow.org/lite. + - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. + - >- + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be + used in the browser and in Node.js using JavaScript. + - >- + Used for iOS mobile devices in (.mlmodel) format. See + https://developer.apple.com/documentation/coreml + enum: + - ARTIFACT_FORMAT_UNSPECIFIED + - TF_CHECKPOINT + - TF_SAVED_MODEL + - TF_LITE + - EDGE_TPU_TF_LITE + - TF_JS + - CORE_ML type: string - format: int64 - description: Total example count parsed. + description: The model artifact format. + ClassifyTextRequest: + type: object + description: The document classification request message. + properties: + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' + id: ClassifyTextRequest + Color: + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + id: Color type: object - id: XPSTranslationPreprocessResponse - XPSVideoObjectTrackingEvaluationMetrics: properties: - evaluatedBoundingboxCount: - type: integer - description: The number of bounding boxes used for model evaluation. - format: int32 - boundingBoxMeanAveragePrecision: - type: number - description: >- - Output only. The single metric for bounding boxes evaluation: the - mean_average_precision averaged over all - bounding_box_metrics_entries. + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. format: float - trackMeanMismatchRate: type: number + alpha: format: float - description: >- - Output only. The single metric for tracking consistency evaluation: - the mean_mismatch_rate averaged over all track_metrics_entries. - trackMetricsEntries: - description: >- - Output only. The tracks match metrics for each - Intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - items: - $ref: '#/components/schemas/XPSTrackMetricsEntry' - type: array - evaluatedTrackCount: - format: int32 - description: The number of tracks used for model evaluation. - type: integer - trackMeanAveragePrecision: type: number description: >- - Output only. The single metric for tracks accuracy evaluation: the - mean_average_precision averaged over all track_metrics_entries. + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + green: format: float - boundingBoxMetricsEntries: - items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' - description: >- - Output only. The bounding boxes match metrics for each - Intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - type: array - evaluatedFrameCount: - format: int32 - type: integer - description: The number of video frames used for model evaluation. - trackMeanBoundingBoxIou: - description: >- - Output only. The single metric for tracks bounding box iou - evaluation: the mean_bounding_box_iou averaged over all - track_metrics_entries. + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + red: + description: The amount of red in the color as a value in the interval [0, 1]. type: number format: float + ModerateTextRequest: type: object - description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' - id: XPSVideoObjectTrackingEvaluationMetrics - AnnotateTextRequestFeatures: - description: >- - All available features. Setting each one to true will enable that - specific analysis for the input. - type: object - id: AnnotateTextRequestFeatures + id: ModerateTextRequest properties: - classifyText: - description: Optional. Classify the full document into categories. - type: boolean - extractEntities: - type: boolean - description: Optional. Extract entities. - extractDocumentSentiment: - type: boolean - description: Optional. Extract document-level sentiment. - moderateText: - description: >- - Optional. Moderate the document for harmful and sensitive - categories. - type: boolean - XPSXraiAttribution: - deprecated: true - id: XPSXraiAttribution - description: >- - An explanation method that redistributes Integrated Gradients - attributions to segmented regions, taking advantage of the model's fully - differentiable structure. Refer to this paper for more details: - https://arxiv.org/abs/1906.02825 Only supports image Models (modality is - IMAGE). + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + modelVersion: + type: string + enumDescriptions: + - The default model version. + - >- + Use the v1 model, this model is used by default when not provided. + The v1 model only returns probability (confidence) score for each + category. + - >- + Use the v2 model. The v2 model only returns probability + (confidence) score for each category, and returns severity score + for a subset of the categories. + description: Optional. The model version to use for ModerateText. + enum: + - MODEL_VERSION_UNSPECIFIED + - MODEL_VERSION_1 + - MODEL_VERSION_2 + description: The document moderation request message. + XPSVideoClassificationTrainResponse: + type: object properties: - stepCount: + trainCostNodeSeconds: + format: int64 + type: string description: >- - The number of steps for approximating the path integral. A good - value to start is 50 and gradually increase until the sum to diff - property is met within the desired error range. Valid range of its - value is [1, 100], inclusively. - format: int32 - type: integer - type: object - XPSExampleSet: + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + modelArtifactSpec: + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + description: '## The fields below are only populated under uCAIP request scope.' + id: XPSVideoClassificationTrainResponse + XPSImageObjectDetectionModelSpec: + id: XPSImageObjectDetectionModelSpec properties: - fingerprint: + maxBoundingBoxCount: + description: Max number of bounding box. format: int64 - description: Fingerprint of the example set. type: string - fileSpec: - $ref: '#/components/schemas/XPSFileSpec' - description: File spec of the examples or input sources. - numInputSources: - description: Number of input sources. + modelArtifactSpec: + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + description: '## The fields below are only populated under uCAIP request scope.' + stopReason: + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED type: string + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. + enumDescriptions: + - '' + - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + exportModelSpec: + $ref: '#/components/schemas/XPSImageExportModelSpec' + classCount: format: int64 - numExamples: + description: Total number of classes. type: string + trainCostNodeSeconds: format: int64 - description: Number of examples. + type: string + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + type: object + XPSVideoActionRecognitionEvaluationMetrics: type: object - id: XPSExampleSet - description: Set of examples or input sources. - XPSTableSpec: properties: - rowCount: - type: string - description: The number of rows in the table. - format: int64 - columnSpecs: - additionalProperties: - $ref: '#/components/schemas/XPSColumnSpec' - description: Mapping from column id to column spec. - type: object - timeColumnId: + evaluatedActionCount: format: int32 type: integer - description: The id of the time column. - importedDataSizeInBytes: + description: >- + Output only. The number of ground truth actions used to create this + evaluation. + videoActionMetricsEntries: + description: >- + Output only. The metric entries for precision window lengths: + 1s,2s,3s,4s, 5s. + type: array + items: + $ref: '#/components/schemas/XPSVideoActionMetricsEntry' + id: XPSVideoActionRecognitionEvaluationMetrics + description: Model evaluation metrics for video action recognition. + XPSConfusionMatrixRow: + properties: + exampleCount: + items: + format: int32 + type: integer + description: >- + Value of the specific cell in the confusion matrix. The number of + values each row has (i.e. the length of the row) is equal to the + length of the annotation_spec_id_token field. + type: array + count: + type: array + items: + type: string + format: int64 + description: >- + Same as above except intended to represent other counts (for e.g. + for segmentation this is pixel count). NOTE(params): Only + example_count or count is set (oneoff does not support repeated + fields unless they are embedded inside another message). + id: XPSConfusionMatrixRow + type: object + description: A row in the confusion matrix. + XPSCommonStats: + description: Common statistics for a column with a specified data type. + type: object + properties: + distinctValueCount: format: int64 - description: The total size of imported data of the table. type: string - validRowCount: + nullValueCount: + format: int64 + type: string + validValueCount: type: string format: int64 - description: The number of valid rows. - type: object - id: XPSTableSpec - XPSRegressionMetricsEntry: - description: A pair of actual & observed values for the model being evaluated. - id: XPSRegressionMetricsEntry + id: XPSCommonStats + XPSTextSentimentEvaluationMetrics: type: object properties: - trueValue: + quadraticKappa: + description: >- + Output only. Quadratic weighted kappa. Only set for the overall + model evaluation, not for evaluation of a single annotation spec. type: number - description: The actual target value for a row in the dataset. format: float - predictedValue: - description: The observed value for a row in the dataset. + meanAbsoluteError: + description: >- + Output only. Mean absolute error. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. type: number format: float - XPSReportingMetrics: + meanSquaredError: + type: number + description: >- + Output only. Mean squared error. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. + format: float + f1Score: + description: Output only. The harmonic mean of recall and precision. + type: number + format: float + linearKappa: + type: number + format: float + description: >- + Output only. Linear weighted kappa. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. + confusionMatrix: + description: >- + Output only. Confusion matrix of the evaluation. Only set for the + overall model evaluation, not for evaluation of a single annotation + spec. + $ref: '#/components/schemas/XPSConfusionMatrix' + recall: + type: number + description: Output only. Recall. + format: float + precision: + description: Output only. Precision. + type: number + format: float + id: XPSTextSentimentEvaluationMetrics + description: Model evaluation metrics for text sentiment problems. + XPSSpeechPreprocessResponse: + type: object properties: - metricEntries: - type: array + cnsTrainDataPath: description: >- - One entry per metric name. The values must be aggregated per metric - name. - items: - $ref: '#/components/schemas/XPSMetricEntry' - effectiveTrainingDuration: - format: google-duration + Location of shards of sstables (training data) of DataUtterance + protos. + type: string + prebuiltModelEvaluationMetrics: description: >- - The effective time training used. If set, this is used for quota - management and billing. Deprecated. AutoML BE doesn't use this. - Don't set. - deprecated: true + The metrics for prebuilt speech models. They are included here + because there is no prebuilt speech models stored in the AutoML. + $ref: '#/components/schemas/XPSSpeechEvaluationMetrics' + cnsTestDataPath: type: string + description: Location od shards of sstables (test data) of DataUtterance protos. + speechPreprocessStats: + description: Stats associated with the data. + $ref: '#/components/schemas/XPSSpeechPreprocessStats' + id: XPSSpeechPreprocessResponse + XPSEdgeTpuTfLiteFormat: type: object - id: XPSReportingMetrics - XPSIntegratedGradientsAttribution: - id: XPSIntegratedGradientsAttribution + id: XPSEdgeTpuTfLiteFormat + properties: {} description: >- - An attribution method that computes the Aumann-Shapley value taking - advantage of the model's fully differentiable structure. Refer to this - paper for more details: https://arxiv.org/abs/1703.01365 - deprecated: true + A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) + devices. + XPSArrayStats: + id: XPSArrayStats type: object + description: The data statistics of a series of ARRAY values. properties: - stepCount: - format: int32 - type: integer + memberStats: description: >- - The number of steps for approximating the path integral. A good - value to start is 50 and gradually increase until the sum to diff - property is within the desired error range. Valid range of its value - is [1, 100], inclusively. - XPSTuningTrial: - id: XPSTuningTrial + Stats of all the values of all arrays, as if they were a single long + series of data. The type depends on the element type of the array. + $ref: '#/components/schemas/XPSDataStats' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + XPSResponseExplanationParameters: + deprecated: true + properties: + xraiAttribution: + $ref: '#/components/schemas/XPSXraiAttribution' + description: >- + An attribution method that redistributes Integrated Gradients + attribution to segmented regions, taking advantage of the model's + fully differentiable structure. Refer to this paper for more + details: https://arxiv.org/abs/1906.02825 XRAI currently performs + better on natural images, like a picture of a house or an animal. If + the images are taken in artificial environments, like a lab or + manufacturing line, or from diagnostic equipment, like x-rays or + quality-control cameras, use Integrated Gradients instead. + integratedGradientsAttribution: + $ref: '#/components/schemas/XPSIntegratedGradientsAttribution' + description: >- + An attribution method that computes Aumann-Shapley values taking + advantage of the model's fully differentiable structure. Refer to + this paper for more details: https://arxiv.org/abs/1703.01365 + id: XPSResponseExplanationParameters type: object - description: >- - Metrics for a tuning job generated, will get forwarded to Stackdriver as - model tuning logs. Setting this as a standalone message out of - CreateModelMetadata to avoid confusion as we expose this message only to - users. + XPSVideoModelArtifactSpec: + id: XPSVideoModelArtifactSpec properties: - modelStructure: - $ref: '#/components/schemas/XPSTablesModelStructure' - description: Model parameters for the trial. - trainingObjectivePoint: - description: The optimization objective evaluation of the eval split data. - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - XPSFileSpec: + exportArtifact: + description: The model binary files in different formats for model export. + type: array + items: + $ref: '#/components/schemas/XPSModelArtifactItem' + servingArtifact: + $ref: '#/components/schemas/XPSModelArtifactItem' + description: >- + The default model binary file used for serving (e.g. batch predict) + via public Cloud AI Platform API. + type: object + XPSStringStatsUnigramStats: + type: object + description: The statistics of a unigram. properties: - fileFormat: - type: string - enumDeprecated: - - false - - true - - false - - false - - false - - false - enum: - - FILE_FORMAT_UNKNOWN - - FILE_FORMAT_SSTABLE - - FILE_FORMAT_TRANSLATION_RKV - - FILE_FORMAT_RECORDIO - - FILE_FORMAT_RAW_CSV - - FILE_FORMAT_RAW_CAPACITOR - enumDescriptions: - - '' - - '' - - >- - Internal format for parallel text data used by Google Translate. - go/rkvtools - - '' - - >- - Only the lexicographically first file described by the file_spec - contains the header line. - - '' - singleFilePath: - description: Deprecated. Use file_spec. + count: + format: int64 + description: The number of occurrences of this unigram in the series. type: string - deprecated: true - fileSpec: + value: type: string + description: The unigram. + id: XPSStringStatsUnigramStats + Sentence: + id: Sentence + type: object + description: Represents a sentence in the input document. + properties: + sentiment: + $ref: '#/components/schemas/Sentiment' description: >- - Single file path, or file pattern of format - "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is - expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and - /cns/cell-d/somewhere/file-00001-of-00002. - directoryPath: - type: string - deprecated: true - description: Deprecated. Use file_spec. - description: >- - Spec of input and output files, on external file systems (CNS, GCS, - etc). + For calls to AnalyzeSentiment or if + AnnotateTextRequest.Features.extract_document_sentiment is set to + true, this field will contain the sentiment for the sentence. + text: + $ref: '#/components/schemas/TextSpan' + description: The sentence text. + XPSStructStats: + properties: + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + fieldStats: + type: object + description: >- + Map from a field name of the struct to data stats aggregated over + series of all data in that field across all the structs. + additionalProperties: + $ref: '#/components/schemas/XPSDataStats' + id: XPSStructStats + description: The data statistics of a series of STRUCT values. type: object - id: XPSFileSpec - XPSSpeechModelSpecSubModelSpec: - id: XPSSpeechModelSpecSubModelSpec + XPSSpeechPreprocessStats: + type: object + id: XPSSpeechPreprocessStats + properties: + dataErrors: + items: + $ref: '#/components/schemas/XPSDataErrors' + description: Different types of data errors and the counts associated with them. + type: array + numMachineTranscribedExamples: + type: integer + description: The number of rows marked as MACHINE_TRANSCRIBED + format: int32 + testWordsCount: + type: integer + format: int32 + description: The number of words in the test data set. + trainSentencesCount: + description: The number of sentences in the training data set. + format: int32 + type: integer + numHumanLabeledExamples: + format: int32 + type: integer + description: The number of rows marked HUMAN_LABELLED + testSentencesCount: + description: The number of sentences in the test data set. + type: integer + format: int32 + numLogsExamples: + type: integer + format: int32 + description: The number of samples found in the previously recorded logs data. + testExamplesCount: + description: The number of examples labelled as TEST by Speech xps server. + type: integer + format: int32 + trainWordsCount: + description: The number of words in the training data set. + type: integer + format: int32 + trainExamplesCount: + format: int32 + description: The number of examples labeled as TRAIN by Speech xps server. + type: integer + XPSDataErrors: + id: XPSDataErrors + description: Different types of errors and the stats associatesd with each error. properties: - clientId: - type: string - description: In S3, Recognition ClientContextId.client_id - isEnhancedModel: - type: boolean - description: >- - If true then it means we have an enhanced version of the biasing - models. - contextId: - type: string - description: In S3, Recognition ClientContextId.context_id - biasingModelType: + count: + type: integer + format: int32 + description: Number of records having errors associated with the enum. + errorType: type: string - enumDescriptions: - - '' - - Build biasing model on top of COMMAND_AND_SEARCH model - - Build biasing model on top of PHONE_CALL model - - Build biasing model on top of VIDEO model - - Build biasing model on top of DEFAULT model + description: Type of the error. enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT - description: Type of the biasing model. - type: object - XPSSpeechPreprocessResponse: + - ERROR_TYPE_UNSPECIFIED + - UNSUPPORTED_AUDIO_FORMAT + - FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT + - FILE_TOO_LARGE + - MISSING_TRANSCRIPTION + enumDescriptions: + - Not specified. + - >- + Audio format not in the formats by cloud-speech AutoML. Currently + only wav and flac file formats are supported. + - >- + File format differnt from what is specified in the file name + extension. + - File too large. Maximum allowed size is 50 MB. + - Transcript is missing. type: object - id: XPSSpeechPreprocessResponse + XPSBoundingBoxMetricsEntry: + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. + id: XPSBoundingBoxMetricsEntry properties: - cnsTrainDataPath: - type: string - description: >- - Location of shards of sstables (training data) of DataUtterance - protos. - speechPreprocessStats: - description: Stats associated with the data. - $ref: '#/components/schemas/XPSSpeechPreprocessStats' - cnsTestDataPath: - type: string - description: Location od shards of sstables (test data) of DataUtterance protos. - prebuiltModelEvaluationMetrics: - $ref: '#/components/schemas/XPSSpeechEvaluationMetrics' + iouThreshold: description: >- - The metrics for prebuilt speech models. They are included here - because there is no prebuilt speech models stored in the AutoML. - XPSVideoActionMetricsEntry: - id: XPSVideoActionMetricsEntry - properties: - meanAveragePrecision: - description: The mean average precision. - type: number + The intersection-over-union threshold value used to compute this + metrics entry. format: float + type: number confidenceMetricsEntries: + type: array description: >- Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. items: $ref: >- - #/components/schemas/XPSVideoActionMetricsEntryConfidenceMetricsEntry + #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + meanAveragePrecision: + format: float + description: The mean average precision. + type: number + type: object + XPSExampleSet: + id: XPSExampleSet + type: object + properties: + fileSpec: + description: File spec of the examples or input sources. + $ref: '#/components/schemas/XPSFileSpec' + numInputSources: + type: string + description: Number of input sources. + format: int64 + numExamples: + description: Number of examples. + format: int64 + type: string + fingerprint: + format: int64 + description: Fingerprint of the example set. + type: string + description: Set of examples or input sources. + XPSColumnSpec: + properties: + dataType: + $ref: '#/components/schemas/XPSDataType' + description: >- + The data type of the column. It's outputed in Preprocess rpc and a + required input for RefreshTablesStats and Train. + topCorrelatedColumns: + description: It's outputed in RefreshTablesStats, and a required input in Train. type: array - precisionWindowLength: + items: + $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' + forecastingMetadata: + $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' + displayName: + description: >- + The display name of the column. It's outputed in Preprocess and a + required input for RefreshTablesStats and Train. type: string - format: google-duration + columnId: + type: integer description: >- - This VideoActionMetricsEntry is calculated based on this prediction - window length. If the predicted action's timestamp is inside the - time window whose center is the ground truth action's timestamp with - this specific length, the prediction result is treated as a true - positive. + The unique id of the column. When Preprocess, the Tables BE will + popuate the order id of the column, which reflects the order of the + column inside the table, i.e. 0 means the first column in the table, + N-1 means the last column. AutoML BE will persist this order id in + Spanner and set the order id here when calling RefreshTablesStats + and Train. Note: it's different than the column_spec_id that is + generated in AutoML BE. + format: int32 + dataStats: + $ref: '#/components/schemas/XPSDataStats' + description: >- + The data stats of the column. It's outputed in RefreshTablesStats + and a required input for Train. + type: object + id: XPSColumnSpec + XPSTranslationPreprocessResponse: + id: XPSTranslationPreprocessResponse + properties: + validExampleCount: + format: int64 + description: Total valid example count. + type: string + parsedExampleCount: + format: int64 + type: string + description: Total example count parsed. + description: Translation preprocess response. type: object - description: The Evaluation metrics entry given a specific precision_window_length. XPSVideoActionRecognitionTrainResponse: + type: object properties: trainCostNodeSeconds: + format: int64 + type: string description: >- The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. - format: int64 - type: string modelArtifactSpec: $ref: '#/components/schemas/XPSVideoModelArtifactSpec' description: '## The fields below are only populated under uCAIP request scope.' id: XPSVideoActionRecognitionTrainResponse + XPSTranslationTrainResponse: + id: XPSTranslationTrainResponse type: object - XPSResponseExplanationMetadataOutputMetadata: - type: object - id: XPSResponseExplanationMetadataOutputMetadata - properties: - outputTensorName: - type: string - description: Name of the output tensor. Only needed in train response. - description: Metadata of the prediction output to be explained. - XPSResponseExplanationSpec: - type: object - properties: - parameters: - $ref: '#/components/schemas/XPSResponseExplanationParameters' - description: Parameters that configure explaining of the Model's predictions. - metadata: - description: Metadata describing the Model's input and output for explanation. - $ref: '#/components/schemas/XPSResponseExplanationMetadata' - explanationType: - type: string - description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - id: XPSResponseExplanationSpec - deprecated: true - description: >- - Specification of Model explanation. Feature-based XAI in AutoML Vision - ICN is deprecated, see b/288407203 for context. - TextSpan: + description: Train response for translation. properties: - content: - description: The content of the text span, which is a substring of the document. + modelType: + enumDescriptions: + - Default + - Legacy model. Will be deprecated. + - Current model. + enum: + - MODEL_TYPE_UNSPECIFIED + - LEGACY + - CURRENT type: string - beginOffset: - description: >- - The API calculates the beginning offset of the content in the - original document according to the EncodingType specified in the API - request. - format: int32 - type: integer - description: Represents a text span in the input document. - type: object - id: TextSpan - XPSSpeechPreprocessStats: + description: Type of the model. + XPSSpeechEvaluationMetrics: + id: XPSSpeechEvaluationMetrics type: object properties: - trainSentencesCount: - type: integer - description: The number of sentences in the training data set. - format: int32 - numLogsExamples: - format: int32 - description: The number of samples found in the previously recorded logs data. - type: integer - dataErrors: - description: Different types of data errors and the counts associated with them. - type: array + subModelEvaluationMetrics: items: - $ref: '#/components/schemas/XPSDataErrors' - trainExamplesCount: - format: int32 - description: The number of examples labeled as TRAIN by Speech xps server. - type: integer - numMachineTranscribedExamples: - description: The number of rows marked as MACHINE_TRANSCRIBED - format: int32 - type: integer - numHumanLabeledExamples: - type: integer - description: The number of rows marked HUMAN_LABELLED - format: int32 - testWordsCount: - description: The number of words in the test data set. - format: int32 - type: integer - trainWordsCount: - type: integer - format: int32 - description: The number of words in the training data set. - testSentencesCount: - description: The number of sentences in the test data set. - format: int32 - type: integer - testExamplesCount: - type: integer - description: The number of examples labelled as TEST by Speech xps server. - format: int32 - id: XPSSpeechPreprocessStats - GpuMetric: - id: GpuMetric + $ref: >- + #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric + description: Evaluation metrics for all submodels contained in this model. + type: array + XPSTablesPreprocessResponse: + id: XPSTablesPreprocessResponse + type: object properties: - gpuType: + tablesDatasetMetadata: + $ref: '#/components/schemas/XPSTablesDatasetMetadata' + description: >- + The table/column id, column_name and the DataTypes of the columns + will be populated. + DiskMetric: + type: object + id: DiskMetric + properties: + gibSec: + description: Required. Seconds of physical disk usage, e.g. 3600. + type: string + format: int64 + diskType: enum: - - UNKNOWN_GPU_TYPE - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_TESLA_K80 - - NVIDIA_L4 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_V100 - - NVIDIA_H100_80GB - description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. + - UNKNOWN_DISK_TYPE + - REGIONAL_SSD + - REGIONAL_STORAGE + - PD_SSD + - PD_STANDARD + - STORAGE_SNAPSHOT type: string enumDescriptions: - '' @@ -2544,188 +1611,118 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - gpuSec: - description: Required. Seconds of GPU usage, e.g. 3600. - format: int64 - type: string - trackingLabels: - type: object - additionalProperties: - type: string - description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" - machineSpec: - description: Required. Machine spec, e.g. N1_STANDARD_4. - type: string - enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_2G - - A3_HIGHGPU_4G - - A3_HIGHGPU_8G - - A3_MEGAGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 + description: Required. Type of Disk, e.g. REGIONAL_SSD. + XPSTranslationEvaluationMetrics: + type: object + description: Evaluation metrics for the dataset. + properties: + bleuScore: + type: number + description: BLEU score. + format: double + baseBleuScore: + description: BLEU score for base model. + type: number + format: double + id: XPSTranslationEvaluationMetrics + XPSColorMap: + id: XPSColorMap + type: object + description: >- + Map from color to display name. Will only be used by Image Segmentation + for uCAIP. + properties: + displayName: + type: string + description: Should be used during preprocessing. + intColor: + $ref: '#/components/schemas/XPSColorMapIntColor' + color: + $ref: '#/components/schemas/Color' + description: >- + This type is deprecated in favor of the IntColor below. This is + because google.type.Color represent color has a float which + semantically does not reflect discrete classes/categories concept. + Moreover, to handle it well we need to have some tolerance when + converting to a discretized color. As such, the recommendation is to + have API surface still use google.type.Color while internally + IntColor is used. + deprecated: true + annotationSpecIdToken: + type: string + description: Should be used during training. + XPSMetricEntryLabel: + properties: + labelValue: + type: string + description: The value of the label. + labelName: + description: The name of the label. + type: string + type: object + id: XPSMetricEntryLabel + XPSFloat64StatsHistogramBucket: + description: A bucket of a histogram. + properties: + max: + description: >- + The maximum value of the bucket, exclusive unless max = + `"Infinity"`, in which case it's inclusive. + type: number + format: double + min: + format: double + type: number + description: The minimum value of the bucket, inclusive. + count: + format: int64 + type: string + description: >- + The number of data values that are in the bucket, i.e. are between + min and max values. + type: object + id: XPSFloat64StatsHistogramBucket + GpuMetric: + properties: + gpuType: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: string + enum: + - UNKNOWN_GPU_TYPE + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_TESLA_K80 + - NVIDIA_L4 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_V100 + - NVIDIA_H100_80GB + description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. + trackingLabels: + description: >- + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" + type: object + additionalProperties: + type: string + gpuSec: + type: string + description: Required. Seconds of GPU usage, e.g. 3600. + format: int64 + machineSpec: enumDescriptions: - '' - '' @@ -2888,615 +1885,1290 @@ components: - '' - '' - '' + enum: + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 + description: Required. Machine spec, e.g. N1_STANDARD_4. + type: string + type: object + id: GpuMetric + XPSTablesModelStructureModelParameters: + properties: + hyperparameters: + type: array + items: + $ref: >- + #/components/schemas/XPSTablesModelStructureModelParametersParameter + type: object + description: Model hyper-parameters for a model. + id: XPSTablesModelStructureModelParameters + XPSTableSpec: + id: XPSTableSpec + type: object + properties: + timeColumnId: + description: The id of the time column. + format: int32 + type: integer + importedDataSizeInBytes: + type: string + description: The total size of imported data of the table. + format: int64 + validRowCount: + type: string + description: The number of valid rows. + format: int64 + rowCount: + type: string + description: The number of rows in the table. + format: int64 + columnSpecs: + type: object + description: Mapping from column id to column spec. + additionalProperties: + $ref: '#/components/schemas/XPSColumnSpec' + XPSTextComponentModel: + description: 'Component model. Next ID: 10' + type: object + id: XPSTextComponentModel + properties: + partition: + enumDescriptions: + - '' + - The default partition. + - >- + It has significantly lower replication than partition-0 and is + located in the US only. It also has a larger model size limit and + higher default RAM quota than partition-0. Customers with batch + traffic, US-based traffic, or very large models should use this + partition. Capacity in this partition is significantly cheaper + than partition-0. + - >- + To be used by customers with Jellyfish-accelerated ops. See + go/servomatic-jellyfish for details. + - The partition used by regionalized servomatic cloud regions. + - The partition used for loading models from custom storage. + type: string + enum: + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + description: >- + The partition where the model is deployed. Populated by uCAIP BE as + part of online PredictRequest. + tfRuntimeVersion: + description: >- + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list + type: string + onlinePredictionModelGcsUri: + description: The Cloud Storage resource path to hold online prediction model. + type: string + submodelType: + enum: + - TEXT_MODEL_TYPE_UNSPECIFIED + - TEXT_MODEL_TYPE_DEFAULT + - TEXT_MODEL_TYPE_META_ARCHITECT + - TEXT_MODEL_TYPE_ATC + - TEXT_MODEL_TYPE_CLARA2 + - TEXT_MODEL_TYPE_CHATBASE + - TEXT_MODEL_TYPE_SAFT_SPAN_LABELING + - TEXT_MODEL_TYPE_TEXT_EXTRACTION + - TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION + - TEXT_MODEL_TYPE_COMPOSITE + - TEXT_MODEL_TYPE_ALL_MODELS + - TEXT_MODEL_TYPE_BERT + - TEXT_MODEL_TYPE_ENC_PALM + type: string + description: The type of trained NL submodel + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - Model type for entity extraction. + - Model type for relationship extraction. + - >- + A composite model represents a set of component models that have + to be used together for prediction. A composite model appears to + be a single model to the model user. It may contain only one + component model. Please refer to go/cnl-composite-models for more + information. + - >- + Model type used to train default, MA, and ATC models in a single + batch worker pipeline. + - >- + BERT pipeline needs a specific model type, since it uses a + different TFX configuration compared with DEFAULT (despite sharing + most of the code). + - Model type for EncPaLM. + batchPredictionModelGcsUri: + description: The Cloud Storage resource path to hold batch prediction model. + type: string + servoModelName: + type: string + description: >- + The name of servo model. Populated by uCAIP BE as part of online + PredictRequest. + submodelName: + description: The name of the trained NL submodel. + type: string + versionNumber: + type: string + description: >- + The servomatic model version number. Populated by uCAIP BE as part + of online PredictRequest. + format: int64 + servingArtifact: + $ref: '#/components/schemas/XPSModelArtifactItem' + description: >- + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud Ai Platform API. + AnnotateTextResponse: + type: object + id: AnnotateTextResponse + description: The text annotations response message. + properties: + languageCode: + type: string + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + sentences: + description: >- + Sentences in the input document. Populated if the user enables + AnnotateTextRequest.Features.extract_document_sentiment. + items: + $ref: '#/components/schemas/Sentence' + type: array + documentSentiment: + $ref: '#/components/schemas/Sentiment' + description: >- + The overall sentiment for the document. Populated if the user + enables AnnotateTextRequest.Features.extract_document_sentiment. + moderationCategories: + type: array + description: Harmful and sensitive categories identified in the input document. + items: + $ref: '#/components/schemas/ClassificationCategory' + categories: + description: Categories identified in the input document. + items: + $ref: '#/components/schemas/ClassificationCategory' + type: array + languageSupported: + type: boolean + description: >- + Whether the language is officially supported by all requested + features. The API may still return a response when the language is + not supported, but it is on a best effort basis. + entities: + items: + $ref: '#/components/schemas/Entity' + type: array + description: >- + Entities, along with their semantic information, in the input + document. Populated if the user enables + AnnotateTextRequest.Features.extract_entities or + AnnotateTextRequest.Features.extract_entity_sentiment. + XPSEvaluationMetrics: + id: XPSEvaluationMetrics + type: object + description: >- + Contains xPS-specific model evaluation metrics either for a single + annotation spec (label), or for the model overall. Next tag: 18. + properties: + textSentimentEvalMetrics: + $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' + evaluatedExampleCount: + type: integer + description: >- + The number of examples used to create this evaluation metrics + instance. + format: int32 + category: + type: integer + format: int32 + description: >- + The integer category label for which this evaluation metric instance + had been created. Valid categories are 0 or higher. Overall model + evaluation should set this to negative values (rather than implicit + zero). Only used for Image Segmentation (prefer to set + annotation_spec_id_token instead). Note: uCAIP Image Segmentation + should use annotation_spec_id_token. + imageObjectDetectionEvalMetrics: + $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' + translationEvalMetrics: + $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' + videoObjectTrackingEvalMetrics: + $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' + videoClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + tablesClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + annotationSpecIdToken: + type: string + description: >- + The annotation_spec for which this evaluation metrics instance had + been created. Empty iff this is an overall model evaluation (like + Tables evaluation metrics), i.e. aggregated across all labels. The + value comes from the input annotations in AnnotatedExample. For MVP + product or for text sentiment models where annotation_spec_id_token + is not available, set label instead. + regressionEvalMetrics: + $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' + textClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + videoActionRecognitionEvalMetrics: + $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' + imageSegmentationEvalMetrics: + $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' + imageClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + tablesEvalMetrics: + $ref: '#/components/schemas/XPSTablesEvaluationMetrics' + label: + description: >- + The label for which this evaluation metrics instance had been + created. Empty iff this is an overall model evaluation (like Tables + evaluation metrics), i.e. aggregated across all labels. The label + maps to AnnotationSpec.display_name in Public API protos. Only used + by MVP implementation and text sentiment FULL implementation. + type: string + textExtractionEvalMetrics: + $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' + XPSTextTrainResponse: + type: object + properties: + componentModel: + type: array + items: + $ref: '#/components/schemas/XPSTextComponentModel' + description: Component submodels. + id: XPSTextTrainResponse + XPSColumnSpecCorrelatedColumn: + description: >- + Identifies a table's column, and its correlation with the column this + ColumnSpec describes. + id: XPSColumnSpecCorrelatedColumn + type: object + properties: + correlationStats: + $ref: '#/components/schemas/XPSCorrelationStats' + columnId: + format: int32 + type: integer + XPSTablesTrainResponse: + type: object + id: XPSTablesTrainResponse + properties: + modelStructure: + $ref: '#/components/schemas/XPSTablesModelStructure' + tablesModelColumnInfo: + type: array + description: >- + Output only. Auxiliary information for each of the + input_feature_column_specs, with respect to this particular model. + items: + $ref: '#/components/schemas/XPSTablesModelColumnInfo' + predictionSampleRows: + items: + $ref: '#/components/schemas/XPSRow' + type: array + description: Sample rows from the dataset this model was trained. + trainCostMilliNodeHours: + format: int64 + description: >- + The actual training cost of the model, expressed in milli node + hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed + to not exceed the train budget. + type: string + XPSColumnSpecForecastingMetadata: + id: XPSColumnSpecForecastingMetadata + description: >- + =========================================================================== + # The fields below are used exclusively for Forecasting. + type: object + properties: + columnType: + type: string + description: The type of the column for FORECASTING model training purposes. + enum: + - COLUMN_TYPE_UNSPECIFIED + - KEY + - KEY_METADATA + - TIME_SERIES_AVAILABLE_PAST_ONLY + - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE + enumDescriptions: + - An un-set value of this enum. + - Key columns are used to identify timeseries. + - >- + This column contains information describing static properties of + the entities identified by the key column(s) (e.g. city's ZIP + code). + - >- + This column contains information for the given entity, at any time + poinrt, they are only available in the time series before. + - >- + This column contains information for the given entity is known + both for the past and the sufficiently far future. + XPSRow: + properties: + values: + items: + type: any + description: >- + The values of the row cells, given in the same order as the + column_ids. If column_ids is not set, then in the same order as the + input_feature_column_ids in TablesModelMetadata. + type: array + columnIds: + description: >- + The ids of the columns. Note: The below `values` field must match + order of this field, if this field is set. + type: array + items: + format: int32 + type: integer + id: XPSRow + type: object + XPSVisionErrorAnalysisConfig: + id: XPSVisionErrorAnalysisConfig + description: 'The vision model error analysis configuration. Next tag: 3' + type: object + properties: + exampleCount: + format: int32 + type: integer + description: The number of query examples in error analysis. + queryType: + enumDescriptions: + - Unspecified query type for model error analysis. + - Query similar samples across all classes in the dataset. + - Query similar samples from the same class of the input sample. + - Query dissimilar samples from the same class of the input sample. + enum: + - QUERY_TYPE_UNSPECIFIED + - QUERY_TYPE_ALL_SIMILAR + - QUERY_TYPE_SAME_CLASS_SIMILAR + - QUERY_TYPE_SAME_CLASS_DISSIMILAR + description: >- + The query type used in retrieval. The enum values are frozen in the + foreseeable future. + type: string + XPSImageModelServingSpecModelThroughputEstimation: + id: XPSImageModelServingSpecModelThroughputEstimation + type: object + properties: + latencyInMilliseconds: + format: double + description: Estimated latency. + type: number + servomaticPartitionType: + type: string + enum: + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + enumDescriptions: + - '' + - The default partition. + - >- + It has significantly lower replication than partition-0 and is + located in the US only. It also has a larger model size limit and + higher default RAM quota than partition-0. Customers with batch + traffic, US-based traffic, or very large models should use this + partition. Capacity in this partition is significantly cheaper + than partition-0. + - >- + To be used by customers with Jellyfish-accelerated ops. See + go/servomatic-jellyfish for details. + - The partition used by regionalized servomatic cloud regions. + - The partition used for loading models from custom storage. + nodeQps: + description: The approximate qps a deployed node can serve. + type: number + format: double + computeEngineAcceleratorType: + enum: + - UNSPECIFIED + - NVIDIA_TESLA_K80 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_V100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_L4 + - NVIDIA_H100_80GB + - NVIDIA_H100_MEGA_80GB + - TPU_V2 + - TPU_V3 + - TPU_V4_POD + - TPU_V5_LITEPOD + type: string + enumDescriptions: + - '' + - Nvidia Tesla K80 GPU. + - Nvidia Tesla P100 GPU. + - Nvidia Tesla V100 GPU. + - Nvidia Tesla P4 GPU. + - Nvidia Tesla T4 GPU. + - Nvidia Tesla A100 GPU. + - Nvidia A100 80GB GPU. + - Nvidia L4 GPU. + - Nvidia H100 80Gb GPU. + - Nvidia H100 80Gb GPU. + - TPU v2 (JellyFish). + - TPU v3 (DragonFish). + - TPU_v4 (PufferFish). + - TPU v5 Lite Pods. + XPSExportModelOutputConfig: + type: object + properties: + edgeTpuTfLiteFormat: + $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' + coreMlFormat: + $ref: '#/components/schemas/XPSCoreMlFormat' + tfLiteFormat: + $ref: '#/components/schemas/XPSTfLiteFormat' + outputGcsUri: + type: string + description: >- + The Google Cloud Storage (GCS) directory where XPS will output the + exported models and related files. Format: gs://bucket/directory + tfSavedModelFormat: + $ref: '#/components/schemas/XPSTfSavedModelFormat' + exportFirebaseAuxiliaryInfo: + description: >- + For any model and format: If true, will additionally export + FirebaseExportedModelInfo in a firebase.txt file. + type: boolean + outputGcrUri: + type: string + description: >- + The Google Contained Registry (GCR) path the exported files to be + pushed to. This location is set if the exported format is DOCKDER. + dockerFormat: + $ref: '#/components/schemas/XPSDockerFormat' + tfJsFormat: + $ref: '#/components/schemas/XPSTfJsFormat' + id: XPSExportModelOutputConfig + XPSRegressionMetricsEntry: + description: A pair of actual & observed values for the model being evaluated. + properties: + trueValue: + format: float + type: number + description: The actual target value for a row in the dataset. + predictedValue: + description: The observed value for a row in the dataset. + format: float + type: number + id: XPSRegressionMetricsEntry + type: object + XPSPreprocessResponse: + type: object + id: XPSPreprocessResponse + description: 'Next ID: 8' + properties: + speechPreprocessResp: + $ref: '#/components/schemas/XPSSpeechPreprocessResponse' + tablesPreprocessResponse: + $ref: '#/components/schemas/XPSTablesPreprocessResponse' + translationPreprocessResp: + $ref: '#/components/schemas/XPSTranslationPreprocessResponse' + outputExampleSet: + description: >- + Preprocessed examples, that are to be imported into AutoML storage. + This should point to RecordIO file(s) of PreprocessedExample + messages. The PreprocessedExample.mvp_training_data-s returned here + are later verbatim passed to Train() call in + TrainExample.mvp_training_data. + $ref: '#/components/schemas/XPSExampleSet' + XPSColorMapIntColor: + properties: + green: + format: int32 + type: integer + description: The value should be in range of [0, 255]. + blue: + type: integer + format: int32 + description: The value should be in range of [0, 255]. + red: + type: integer + format: int32 + description: The value should be in range of [0, 255]. + id: XPSColorMapIntColor type: object - XPSImageClassificationTrainResponse: + description: RGB color and each channel is represented by an integer. + XPSImageExportModelSpec: + properties: + exportModelOutputConfig: + type: array + description: >- + Contains the model format and internal location of the model files + to be exported/downloaded. Use the GCS bucket name which is provided + via TrainRequest.gcs_bucket_name to store the model files. + items: + $ref: '#/components/schemas/XPSExportModelOutputConfig' + type: object + id: XPSImageExportModelSpec + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Upon receiving + ExportModel request from user, AutoMl backend can serve the + pre-generated models to user if exists (by copying the files from + internal path to user provided location), otherwise, AutoMl backend will + call xPS ExportModel API to generate the model on the fly with the + requesting format. + XPSDockerFormat: + description: >- + A model format used for Docker containers. Use the params field to + customize the container. The container is verified to work correctly on + ubuntu 16.04 operating system. type: object properties: - stopReason: + gpuArchitecture: enumDescriptions: - '' - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED - type: string - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - modelArtifactSpec: - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - exportModelSpec: - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Populated for - AutoMl requests. - $ref: '#/components/schemas/XPSImageExportModelSpec' - trainCostInNodeTime: description: >- - The actual cost to create this model. - For edge type model, the - cost is expressed in node hour. - For cloud type model,the cost is - expressed in compute hour. - Populated for models created before GA. - To be deprecated after GA. - format: google-duration + Optional. Additional gpu information describing the requirements for + the to be exported model files. type: string - classCount: - description: Total number of classes. - format: int64 + enum: + - GPU_ARCHITECTURE_UNSPECIFIED + - GPU_ARCHITECTURE_NVIDIA + cpuArchitecture: type: string - trainCostNodeSeconds: - format: int64 description: >- - The actual training cost, expressed in node seconds. Populated for - models trained in node time. - type: string - id: XPSImageClassificationTrainResponse - XPSBoundingBoxMetricsEntry: - description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. + Optional. Additional cpu information describing the requirements for + the to be exported model files. + enumDescriptions: + - '' + - '' + enum: + - CPU_ARCHITECTURE_UNSPECIFIED + - CPU_ARCHITECTURE_X86_64 + id: XPSDockerFormat + Entity: type: object properties: - meanAveragePrecision: - type: number - format: float - description: The mean average precision. - iouThreshold: - format: float - type: number - description: >- - The intersection-over-union threshold value used to compute this - metrics entry. - confidenceMetricsEntries: - items: - $ref: >- - #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry - type: array + sentiment: + $ref: '#/components/schemas/Sentiment' description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - id: XPSBoundingBoxMetricsEntry - XPSColumnSpecForecastingMetadata: - type: object - properties: - columnType: + For calls to AnalyzeEntitySentiment or if + AnnotateTextRequest.Features.extract_entity_sentiment is set to + true, this field will contain the aggregate sentiment expressed for + this entity in the provided document. + type: enum: - - COLUMN_TYPE_UNSPECIFIED - - KEY - - KEY_METADATA - - TIME_SERIES_AVAILABLE_PAST_ONLY - - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE - description: The type of the column for FORECASTING model training purposes. + - UNKNOWN + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE enumDescriptions: - - An un-set value of this enum. - - Key columns are used to identify timeseries. + - Unknown + - Person + - Location + - Organization + - Event + - Artwork + - Consumer product + - Other types of entities - >- - This column contains information describing static properties of - the entities identified by the key column(s) (e.g. city's ZIP - code). + Phone number The metadata lists the phone number, formatted + according to local convention, plus whichever additional elements + appear in the text: * `number` - the actual number, broken down + into sections as per local convention * `national_prefix` - + country code, if detected * `area_code` - region or area code, if + detected * `extension` - phone extension (to be dialed after + connection), if detected - >- - This column contains information for the given entity, at any time - poinrt, they are only available in the time series before. + Address The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - street number * `locality` - city or town * + `street_name` - street/route name, if detected * `postal_code` - + postal code, if detected * `country` - country, if detected * + `broad_region` - administrative area, such as the state, if + detected * `narrow_region` - smaller administrative area, such as + county, if detected * `sublocality` - used in Asian addresses to + demark a district within a city, if detected - >- - This column contains information for the given entity is known - both for the past and the sufficiently far future. - type: string - id: XPSColumnSpecForecastingMetadata - description: >- - =========================================================================== - # The fields below are used exclusively for Forecasting. - XPSTfSavedModelFormat: - description: A tensorflow model format in SavedModel format. - properties: {} - id: XPSTfSavedModelFormat - type: object - XPSSpeechModelSpec: - id: XPSSpeechModelSpec - type: object - properties: - language: + Date The metadata identifies the components of the date: * `year` + - four digit year, if detected * `month` - two digit month number, + if detected * `day` - two digit day number, if detected + - Number The metadata is the number itself. + - Price The metadata identifies the `value` and `currency`. + description: The entity type. type: string - datasetId: - format: int64 + name: type: string - description: >- - Required for speech xps backend. Speech xps has to use dataset_id - and model_id as the primary key in db so that speech API can query - the db directly. - subModelSpecs: - description: Model specs for all submodels contained in this model. - type: array + description: The representative name for the entity. + mentions: items: - $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' - XPSTablesRegressionMetrics: - type: object - description: Metrics for Tables regression problems. - id: XPSTablesRegressionMetrics + $ref: '#/components/schemas/EntityMention' + type: array + description: >- + The mentions of this entity in the input document. The API currently + supports proper noun mentions. + metadata: + type: object + description: >- + Metadata associated with the entity. For the metadata associated + with other entity types, see the Type table below. + additionalProperties: + type: string + description: >- + Represents a phrase in the text that is a known entity, such as a + person, an organization, or location. The API associates information, + such as probability and mentions, with entities. + id: Entity + XPSStringStats: + id: XPSStringStats + description: The data statistics of a series of STRING values. properties: - regressionMetricsEntries: + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + topUnigramStats: items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' + $ref: '#/components/schemas/XPSStringStatsUnigramStats' description: >- - A list of actual versus predicted points for the model being - evaluated. + The statistics of the top 20 unigrams, ordered by + StringStats.UnigramStats.count. type: array - meanAbsolutePercentageError: + type: object + XPSResponseExplanationSpec: + deprecated: true + description: >- + Specification of Model explanation. Feature-based XAI in AutoML Vision + ICN is deprecated, see b/288407203 for context. + id: XPSResponseExplanationSpec + type: object + properties: + metadata: + $ref: '#/components/schemas/XPSResponseExplanationMetadata' + description: Metadata describing the Model's input and output for explanation. + parameters: + description: Parameters that configure explaining of the Model's predictions. + $ref: '#/components/schemas/XPSResponseExplanationParameters' + explanationType: description: >- - Mean absolute percentage error, only set if all of the target - column's values are positive. - format: double - type: number - rootMeanSquaredLogError: - description: Root mean squared log error. - format: double + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + type: string + XPSStructType: + id: XPSStructType + type: object + properties: + fields: + description: Unordered map of struct field names to their data types. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSDataType' + description: '`StructType` defines the DataType-s of a STRUCT type.' + XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + properties: + precision: type: number - meanAbsoluteError: - description: Mean absolute error. - format: double + description: Precision for the given confidence threshold. + format: float + confidenceThreshold: + description: The confidence threshold value used to compute the metrics. + format: float type: number - rootMeanSquaredError: + confusionMatrix: + $ref: '#/components/schemas/XPSConfusionMatrix' + description: >- + Confusion matrix of the per confidence_threshold evaluation. Pixel + counts are set here. Only set for model level evaluation, not for + evaluation per label. + recall: type: number - format: double - description: Root mean squared error. - rSquared: - description: R squared. + description: Recall for the given confidence threshold. + format: float + iouScore: + format: float + description: IOU score. type: number - format: double - XPSTablesModelColumnInfo: - id: XPSTablesModelColumnInfo - properties: - columnId: - format: int32 - description: The ID of the column. - type: integer - featureImportance: + diceScoreCoefficient: + description: 'DSC or the F1 score: The harmonic mean of recall and precision.' format: float type: number + type: object + description: Metrics for a single confidence threshold. + AnnotateTextRequestFeatures: + properties: + extractDocumentSentiment: + type: boolean + description: Optional. Extract document-level sentiment. + extractEntities: + description: Optional. Extract entities. + type: boolean + classifyText: + type: boolean + description: Optional. Classify the full document into categories. + moderateText: + type: boolean description: >- - When given as part of a Model: Measurement of how much model - predictions correctness on the TEST data depend on values in this - column. A value between 0 and 1, higher means higher influence. - These values are normalized - for all input feature columns of a - given model they add to 1. When given back by Predict or Batch - Predict: Measurement of how impactful for the prediction returned - for the given row the value in this column was. Specifically, the - feature importance specifies the marginal contribution that the - feature made to the prediction score compared to the baseline score. - These values are computed using the Sampled Shapley method. + Optional. Moderate the document for harmful and sensitive + categories. description: >- - An information specific to given column and Tables Model, in context of - the Model and the predictions created by it. - type: object - EntityMention: - id: EntityMention + All available features. Setting each one to true will enable that + specific analysis for the input. type: object + id: AnnotateTextRequestFeatures + XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: + id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry properties: - probability: + confidenceThreshold: + description: The confidence threshold value used to compute the metrics. + type: number + format: float + precision: format: float - description: >- - Probability score associated with the entity. The score shows the - probability of the entity mention being the entity type. The score - is in (0, 1] range. type: number - sentiment: - $ref: '#/components/schemas/Sentiment' + description: Precision for the given confidence threshold. + recall: + type: number + format: float + description: Recall for the given confidence threshold. + f1Score: + description: The harmonic mean of recall and precision. + type: number + format: float + description: Metrics for a single confidence threshold. + type: object + Document: + type: object + id: Document + properties: + languageCode: description: >- - For calls to AnalyzeEntitySentiment or if - AnnotateTextRequest.Features.extract_entity_sentiment is set to - true, this field will contain the sentiment expressed for this - mention of the entity in the provided document. - text: - $ref: '#/components/schemas/TextSpan' - description: The mention text. - type: - description: The type of the entity mention. + Optional. The language of the document (if not specified, the + language is automatically detected). Both ISO and BCP-47 language + codes are accepted. [Language + Support](https://cloud.google.com/natural-language/docs/languages) + lists currently supported languages for each API method. If the + language (either specified by the caller or automatically detected) + is not supported by the called API method, an `INVALID_ARGUMENT` + error is returned. type: string - enumDescriptions: - - Unknown - - Proper name - - Common noun (or noun compound) + content: + description: >- + The content of the input in string format. Cloud audit logging + exempt since it is based on user data. + type: string + type: enum: - - TYPE_UNKNOWN - - PROPER - - COMMON + - TYPE_UNSPECIFIED + - PLAIN_TEXT + - HTML + enumDescriptions: + - The content type is not specified. + - Plain text + - HTML + type: string + description: >- + Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns + an `INVALID_ARGUMENT` error. + gcsContentUri: + description: >- + The Google Cloud Storage URI where the file content is located. This + URI must be of the form: gs://bucket_name/object_name. For more + details, see https://cloud.google.com/storage/docs/reference-uris. + NOTE: Cloud Storage object versioning is not supported. + type: string + description: Represents the input to API methods. + XPSTuningTrial: + properties: + trainingObjectivePoint: + $ref: '#/components/schemas/XPSTrainingObjectivePoint' + description: The optimization objective evaluation of the eval split data. + modelStructure: + description: Model parameters for the trial. + $ref: '#/components/schemas/XPSTablesModelStructure' + type: object description: >- - Represents a mention for an entity in the text. Currently, proper noun - mentions are supported. - XPSTablesPreprocessResponse: + Metrics for a tuning job generated, will get forwarded to Stackdriver as + model tuning logs. Setting this as a standalone message out of + CreateModelMetadata to avoid confusion as we expose this message only to + users. + id: XPSTuningTrial + XPSBatchPredictResponse: + type: object + id: XPSBatchPredictResponse properties: - tablesDatasetMetadata: - $ref: '#/components/schemas/XPSTablesDatasetMetadata' + exampleSet: description: >- - The table/column id, column_name and the DataTypes of the columns - will be populated. - type: object - id: XPSTablesPreprocessResponse - XPSVisionErrorAnalysisConfig: + Examples for batch prediction result. Under full API implementation, + results are stored in shared RecordIO of AnnotatedExample protobufs, + the annotations field of which is populated by XPS backend. + $ref: '#/components/schemas/XPSExampleSet' + XPSImageSegmentationEvaluationMetrics: properties: - queryType: + confidenceMetricsEntries: + items: + $ref: >- + #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + type: array description: >- - The query type used in retrieval. The enum values are frozen in the - foreseeable future. - type: string - enum: - - QUERY_TYPE_UNSPECIFIED - - QUERY_TYPE_ALL_SIMILAR - - QUERY_TYPE_SAME_CLASS_SIMILAR - - QUERY_TYPE_SAME_CLASS_DISSIMILAR - enumDescriptions: - - Unspecified query type for model error analysis. - - Query similar samples across all classes in the dataset. - - Query similar samples from the same class of the input sample. - - Query dissimilar samples from the same class of the input sample. - exampleCount: - format: int32 - type: integer - description: The number of query examples in error analysis. + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. + description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' type: object - id: XPSVisionErrorAnalysisConfig - description: 'The vision model error analysis configuration. Next tag: 3' - XPSResponseExplanationMetadataInputMetadata: - id: XPSResponseExplanationMetadataInputMetadata - description: Metadata of the input of a feature. + id: XPSImageSegmentationEvaluationMetrics + XPSSpeechEvaluationMetricsSubModelEvaluationMetric: + id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric type: object properties: - inputTensorName: + wer: + description: Word error rate (standard error metric used for speech recognition). + format: double + type: number + numWords: + format: int32 + description: Number of words over which the word error rate was computed. + type: integer + numDeletions: + format: int32 + type: integer + biasingModelType: type: string - description: >- - Name of the input tensor for this model. Only needed in train - response. - visualizationConfig: - $ref: '#/components/schemas/XPSVisualization' - description: Visualization configurations for image explanation. - modality: - enum: - - MODALITY_UNSPECIFIED - - NUMERIC - - IMAGE - - CATEGORICAL + description: Type of the biasing model. enumDescriptions: - '' - - '' - - '' - - '' - type: string + - Build biasing model on top of COMMAND_AND_SEARCH model + - Build biasing model on top of PHONE_CALL model + - Build biasing model on top of VIDEO model + - Build biasing model on top of DEFAULT model + enum: + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT + isEnhancedModel: description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. - ClassificationCategory: - type: object - id: ClassificationCategory + If true then it means we have an enhanced version of the biasing + models. + type: boolean + sentenceAccuracy: + type: number + description: Below fields are used for debugging purposes + format: double + numUtterances: + format: int32 + type: integer + description: Number of utterances used in the wer computation. + numSubstitutions: + type: integer + format: int32 + numInsertions: + format: int32 + type: integer + XPSImageModelArtifactSpec: + id: XPSImageModelArtifactSpec + description: >- + Stores the locations and related metadata of the model artifacts. + Populated for uCAIP requests only. properties: - name: + tfJsBinaryGcsPrefix: type: string - description: The name of the category representing the document. - severity: - description: >- - Optional. The classifier's severity of the category. This is only - present when the ModerateTextRequest.ModelVersion is set to - MODEL_VERSION_2, and the corresponding category has a severity - score. - type: number - format: float - confidence: description: >- - The classifier's confidence of the category. Number represents how - certain the classifier is that this category represents the given - text. - format: float - type: number - description: Represents a category returned from the text classifier. - XPSCategoryStats: - id: XPSCategoryStats - type: object - properties: - topCategoryStats: - type: array + GCS uri prefix of Tensorflow JavaScript binary files + 'groupX-shardXofX.bin' Deprecated. + checkpointArtifact: + description: The Tensorflow checkpoint files. e.g. Used for resumable training. + $ref: '#/components/schemas/XPSModelArtifactItem' + servingArtifact: description: >- - The statistics of the top 20 CATEGORY values, ordered by - CategoryStats.SingleCategoryStats.count. + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud AI Platform API. + $ref: '#/components/schemas/XPSModelArtifactItem' + exportArtifact: items: - $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - description: The data statistics of a series of CATEGORY values. - Document: + $ref: '#/components/schemas/XPSModelArtifactItem' + type: array + description: The model binary files in different formats for model export. + tfLiteMetadataGcsUri: + description: GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. + type: string + labelGcsUri: + type: string + description: GCS uri of decoded labels file for model export 'dict.txt'. type: object + XPSImageSegmentationTrainResponse: properties: - gcsContentUri: - type: string - description: >- - The Google Cloud Storage URI where the file content is located. This - URI must be of the form: gs://bucket_name/object_name. For more - details, see https://cloud.google.com/storage/docs/reference-uris. - NOTE: Cloud Storage object versioning is not supported. - type: + exportModelSpec: + $ref: '#/components/schemas/XPSImageExportModelSpec' + description: 'NOTE: These fields are not used/needed in EAP but will be set later.' + stopReason: + enumDescriptions: + - '' + - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. enum: - - TYPE_UNSPECIFIED - - PLAIN_TEXT - - HTML + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED type: string description: >- - Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns - an `INVALID_ARGUMENT` error. - enumDescriptions: - - The content type is not specified. - - Plain text - - HTML - content: + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + trainCostNodeSeconds: type: string + format: int64 description: >- - The content of the input in string format. Cloud audit logging - exempt since it is based on user data. - languageCode: - type: string + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + modelArtifactSpec: + $ref: '#/components/schemas/XPSImageModelArtifactSpec' description: >- - Optional. The language of the document (if not specified, the - language is automatically detected). Both ISO and BCP-47 language - codes are accepted. [Language - Support](https://cloud.google.com/natural-language/docs/languages) - lists currently supported languages for each API method. If the - language (either specified by the caller or automatically detected) - is not supported by the called API method, an `INVALID_ARGUMENT` - error is returned. - id: Document - description: Represents the input to API methods. - ModerateTextResponse: - description: The document moderation response message. - id: ModerateTextResponse - properties: - moderationCategories: - description: Harmful and sensitive categories representing the input document. + ## The fields below are only populated under uCAIP request scope. + Model artifact spec stores and model gcs pathes and related metadata + colorMaps: items: - $ref: '#/components/schemas/ClassificationCategory' + $ref: '#/components/schemas/XPSColorMap' type: array - languageSupported: - type: boolean + description: Color map of the model. + type: object + id: XPSImageSegmentationTrainResponse + XPSVideoActionMetricsEntry: + id: XPSVideoActionMetricsEntry + type: object + properties: + precisionWindowLength: description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - languageCode: + This VideoActionMetricsEntry is calculated based on this prediction + window length. If the predicted action's timestamp is inside the + time window whose center is the ground truth action's timestamp with + this specific length, the prediction result is treated as a true + positive. + format: google-duration + type: string + meanAveragePrecision: + format: float + description: The mean average precision. + type: number + confidenceMetricsEntries: + items: + $ref: >- + #/components/schemas/XPSVideoActionMetricsEntryConfidenceMetricsEntry + type: array description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + description: The Evaluation metrics entry given a specific precision_window_length. + AnalyzeSentimentRequest: + properties: + encodingType: + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 type: string + description: The encoding type used by the API to calculate sentence offsets. + enumDescriptions: + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. type: object - XPSTrackMetricsEntry: - id: XPSTrackMetricsEntry + id: AnalyzeSentimentRequest + description: The sentiment analysis request message. + XPSTfJsFormat: + type: object + properties: {} description: >- - Track matching model metrics for a single track match threshold and - multiple label match confidence thresholds. Next tag: 6. + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used + in the browser and in Node.js using JavaScript. + id: XPSTfJsFormat + XPSTablesModelStructureModelParametersParameter: + id: XPSTablesModelStructureModelParametersParameter + type: object properties: - meanTrackingAveragePrecision: - description: >- - Output only. The mean average precision over all confidence - thresholds. - format: float - type: number - meanMismatchRate: - format: float - description: Output only. The mean mismatch rate over all confidence thresholds. + stringValue: + description: String type parameter value. + type: string + floatValue: + format: double type: number - confidenceMetricsEntries: + description: Float type parameter value. + name: + type: string + description: Parameter name. + intValue: + description: Integer type parameter value. + type: string + format: int64 + XPSCategoryStats: + type: object + properties: + topCategoryStats: items: - $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' + $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' description: >- - Output only. Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. + The statistics of the top 20 CATEGORY values, ordered by + CategoryStats.SingleCategoryStats.count. type: array - iouThreshold: - format: float - description: >- - Output only. The intersection-over-union threshold value between - bounding boxes across frames used to compute this metric entry. - type: number - meanBoundingBoxIou: - format: float - type: number - description: >- - Output only. The mean bounding box iou over all confidence - thresholds. - type: object - XPSColumnSpecCorrelatedColumn: - description: >- - Identifies a table's column, and its correlation with the column this - ColumnSpec describes. - id: XPSColumnSpecCorrelatedColumn - properties: - correlationStats: - $ref: '#/components/schemas/XPSCorrelationStats' - columnId: - type: integer - format: int32 - type: object + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + id: XPSCategoryStats + description: The data statistics of a series of CATEGORY values. InfraUsage: - type: object - id: InfraUsage description: 'Infra Usage of billing metrics. Next ID: 6' + type: object properties: - ramMetrics: - description: Aggregated ram metrics since requested start_time. + tpuMetrics: + description: Aggregated tpu metrics since requested start_time. + items: + $ref: '#/components/schemas/TpuMetric' type: array + cpuMetrics: items: - $ref: '#/components/schemas/RamMetric' + $ref: '#/components/schemas/CpuMetric' + type: array + description: Aggregated core metrics since requested start_time. diskMetrics: description: Aggregated persistent disk metrics since requested start_time. - type: array items: $ref: '#/components/schemas/DiskMetric' - cpuMetrics: - description: Aggregated core metrics since requested start_time. type: array - items: - $ref: '#/components/schemas/CpuMetric' gpuMetrics: - items: - $ref: '#/components/schemas/GpuMetric' description: Aggregated gpu metrics since requested start_time. - type: array - tpuMetrics: - type: array - items: - $ref: '#/components/schemas/TpuMetric' - description: Aggregated tpu metrics since requested start_time. - XPSTimestampStats: - properties: - granularStats: - description: >- - The string key is the pre-defined granularity. Currently supported: - hour_of_day, day_of_week, month_of_year. Granularities finer that - the granularity of timestamp data are not populated (e.g. if - timestamps are at day granularity, then hour_of_day is not - populated). - additionalProperties: - $ref: '#/components/schemas/XPSTimestampStatsGranularStats' - type: object - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - medianTimestampNanos: - type: string - format: int64 - id: XPSTimestampStats - type: object - description: The data statistics of a series of TIMESTAMP values. - XPSArrayStats: - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - memberStats: - $ref: '#/components/schemas/XPSDataStats' - description: >- - Stats of all the values of all arrays, as if they were a single long - series of data. The type depends on the element type of the array. - type: object - id: XPSArrayStats - description: The data statistics of a series of ARRAY values. - TpuMetric: - id: TpuMetric - type: object - properties: - tpuSec: - format: int64 - type: string - description: Required. Seconds of TPU usage, e.g. 3600. - tpuType: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNKNOWN_TPU_TYPE - - TPU_V2_POD - - TPU_V2 - - TPU_V3_POD - - TPU_V3 - - TPU_V5_LITEPOD - description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. - XPSVideoModelArtifactSpec: - id: XPSVideoModelArtifactSpec - type: object - properties: - servingArtifact: - $ref: '#/components/schemas/XPSModelArtifactItem' - description: >- - The default model binary file used for serving (e.g. batch predict) - via public Cloud AI Platform API. - exportArtifact: items: - $ref: '#/components/schemas/XPSModelArtifactItem' + $ref: '#/components/schemas/GpuMetric' type: array - description: The model binary files in different formats for model export. - XPSTrainResponse: - properties: - videoClassificationTrainResp: - $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' - deployedModelSizeBytes: - description: Estimated model size in bytes once deployed. - type: string - format: int64 - explanationConfigs: - deprecated: true - description: >- - VisionExplanationConfig for XAI on test set. Optional for when XAI - is enable in training request. + ramMetrics: items: - $ref: '#/components/schemas/XPSResponseExplanationSpec' - type: array - evaluatedExampleSet: - $ref: '#/components/schemas/XPSExampleSet' - description: >- - Examples used to evaluate the model (usually the test set), with the - predicted annotations. The file_spec should point to recordio - file(s) of AnnotatedExample. For each returned example, the - example_id_token and annotations predicted by the model must be set. - The example payload can and is recommended to be omitted. - textToSpeechTrainResp: - $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' - videoObjectTrackingTrainResp: - $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' - evaluationMetricsSet: - $ref: '#/components/schemas/XPSEvaluationMetricsSet' - description: >- - The trained model evaluation metrics. This can be optionally - returned. - textTrainResp: - $ref: '#/components/schemas/XPSTextTrainResponse' - description: Will only be needed for uCAIP from Beta. - translationTrainResp: - $ref: '#/components/schemas/XPSTranslationTrainResponse' - errorAnalysisConfigs: + $ref: '#/components/schemas/RamMetric' type: array - description: >- - Optional vision model error analysis configuration. The field is set - when model error analysis is enabled in the training request. The - results of error analysis will be binded together with evaluation - results (in the format of AnnotatedExample). - items: - $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' - imageClassificationTrainResp: - $ref: '#/components/schemas/XPSImageClassificationTrainResponse' - videoActionRecognitionTrainResp: - $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' - imageObjectDetectionTrainResp: - $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' - imageSegmentationTrainResp: - $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' - tablesTrainResp: - $ref: '#/components/schemas/XPSTablesTrainResponse' - modelToken: - description: >- - Token that represents the trained model. This is considered - immutable and is persisted in AutoML. xPS can put their own proto in - the byte string, to e.g. point to the model checkpoints. The token - is passed to other xPS APIs to refer to the model. - type: string - format: byte - speechTrainResp: - $ref: '#/components/schemas/XPSSpeechModelSpec' - type: object - id: XPSTrainResponse - description: 'Next ID: 18' - AnalyzeSentimentResponse: - description: The sentiment analysis response message. + description: Aggregated ram metrics since requested start_time. + id: InfraUsage + XPSTablesEvaluationMetrics: type: object - id: AnalyzeSentimentResponse properties: + regressionMetrics: + $ref: '#/components/schemas/XPSTablesRegressionMetrics' + description: Regression metrics. + classificationMetrics: + description: Classification metrics. + $ref: '#/components/schemas/XPSTablesClassificationMetrics' + id: XPSTablesEvaluationMetrics + ClassifyTextResponse: + type: object + id: ClassifyTextResponse + properties: + categories: + items: + $ref: '#/components/schemas/ClassificationCategory' + description: Categories representing the input document. + type: array languageCode: type: string description: >- @@ -3510,360 +3182,723 @@ components: Whether the language is officially supported. The API may still return a response when the language is not supported, but it is on a best effort basis. - sentences: - items: - $ref: '#/components/schemas/Sentence' - type: array - description: The sentiment for all the sentences in the document. - documentSentiment: - $ref: '#/components/schemas/Sentiment' - description: The overall sentiment of the input document. - XPSTextSentimentEvaluationMetrics: + description: The document classification response message. + XPSTablesClassificationMetricsCurveMetrics: type: object + description: Metrics curve data point for a single value. properties: - meanSquaredError: + confidenceMetricsEntries: + type: array + items: + $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' description: >- - Output only. Mean squared error. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - format: float + Metrics that have confidence thresholds. Precision-recall curve and + ROC curve can be derived from them. + value: + type: string + description: >- + The CATEGORY row value (for ARRAY unnested) the curve metrics are + for. + positionThreshold: + description: The position threshold value used to compute the metrics. + type: integer + format: int32 + aucRoc: type: number - precision: - format: float - description: Output only. Precision. + format: double + description: The area under receiver operating characteristic curve. + logLoss: type: number - recall: - format: float + format: double + description: The Log loss metric. + aucPr: type: number - description: Output only. Recall. - f1Score: + description: The area under the precision-recall curve. + format: double + id: XPSTablesClassificationMetricsCurveMetrics + AnalyzeEntitiesRequest: + properties: + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + encodingType: + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 + type: string + description: The encoding type used by the API to calculate offsets. + enumDescriptions: + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + type: object + description: The entity analysis request message. + id: AnalyzeEntitiesRequest + ClassificationCategory: + type: object + description: Represents a category returned from the text classifier. + id: ClassificationCategory + properties: + confidence: type: number format: float - description: Output only. The harmonic mean of recall and precision. - linearKappa: description: >- - Output only. Linear weighted kappa. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - type: number - format: float - quadraticKappa: + The classifier's confidence of the category. Number represents how + certain the classifier is that this category represents the given + text. + name: + description: The name of the category representing the document. + type: string + severity: description: >- - Output only. Quadratic weighted kappa. Only set for the overall - model evaluation, not for evaluation of a single annotation spec. + Optional. The classifier's severity of the category. This is only + present when the ModerateTextRequest.ModelVersion is set to + MODEL_VERSION_2, and the corresponding category has a severity + score. format: float type: number - confusionMatrix: - description: >- - Output only. Confusion matrix of the evaluation. Only set for the - overall model evaluation, not for evaluation of a single annotation - spec. - $ref: '#/components/schemas/XPSConfusionMatrix' - meanAbsoluteError: - type: number - description: >- - Output only. Mean absolute error. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - format: float - id: XPSTextSentimentEvaluationMetrics - description: Model evaluation metrics for text sentiment problems. - XPSEdgeTpuTfLiteFormat: - properties: {} - description: >- - A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) - devices. - type: object - id: XPSEdgeTpuTfLiteFormat - XPSColorMap: - type: object - description: >- - Map from color to display name. Will only be used by Image Segmentation - for uCAIP. - id: XPSColorMap + XPSTimestampStatsGranularStats: + id: XPSTimestampStatsGranularStats + description: Stats split by a defined in context granularity. properties: - annotationSpecIdToken: - type: string - description: Should be used during training. - intColor: - $ref: '#/components/schemas/XPSColorMapIntColor' - color: + buckets: + type: object + additionalProperties: + format: int64 + type: string description: >- - This type is deprecated in favor of the IntColor below. This is - because google.type.Color represent color has a float which - semantically does not reflect discrete classes/categories concept. - Moreover, to handle it well we need to have some tolerance when - converting to a discretized color. As such, the recommendation is to - have API surface still use google.type.Color while internally - IntColor is used. - $ref: '#/components/schemas/Color' - deprecated: true - displayName: - type: string - description: Should be used during preprocessing. - XPSVideoTrainingOperationMetadata: - id: XPSVideoTrainingOperationMetadata + A map from granularity key to example count for that key. E.g. for + hour_of_day `13` means 1pm, or for month_of_year `5` means May). type: object + TextSpan: properties: - trainCostMilliNodeHour: + beginOffset: + format: int32 + type: integer description: >- - This is an estimation of the node hours necessary for training a - model, expressed in milli node hours (i.e. 1,000 value in this field - means 1 node hour). A node hour represents the time a virtual - machine spends running your training job. The cost of one node - running for one hour is a node hour. - format: int64 + The API calculates the beginning offset of the content in the + original document according to the EncodingType specified in the API + request. + content: type: string - XPSImageModelServingSpec: + description: The content of the text span, which is a substring of the document. + description: Represents a text span in the input document. + id: TextSpan type: object - description: Serving specification for image models. - id: XPSImageModelServingSpec - properties: - modelThroughputEstimation: - type: array - items: - $ref: >- - #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation - description: Populate under uCAIP request scope. - nodeQps: - type: number - format: double - description: >- - An estimated value of how much traffic a node can serve. Populated - for AutoMl request only. - tfRuntimeVersion: - description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list - type: string - XPSColorMapIntColor: - properties: - red: - format: int32 - description: The value should be in range of [0, 255]. - type: integer - blue: - description: The value should be in range of [0, 255]. - type: integer - format: int32 - green: - type: integer - description: The value should be in range of [0, 255]. - format: int32 - id: XPSColorMapIntColor + XPSCategoryStatsSingleCategoryStats: type: object - description: RGB color and each channel is represented by an integer. - XPSCorrelationStats: - description: >- - A correlation statistics between two series of DataType values. The - series may have differing DataType-s, but within a single series the - DataType must be the same. + description: The statistics of a single CATEGORY value. + id: XPSCategoryStatsSingleCategoryStats properties: - cramersV: - description: The correlation value using the Cramer's V measure. - type: number - format: double - type: object - id: XPSCorrelationStats - ClassifyTextResponse: + count: + type: string + description: The number of occurrences of this value in the series. + format: int64 + value: + type: string + description: The CATEGORY value. + XPSImageClassificationTrainResponse: type: object + id: XPSImageClassificationTrainResponse properties: - languageSupported: + classCount: + description: Total number of classes. + type: string + format: int64 + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + trainCostNodeSeconds: + type: string + format: int64 description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - type: boolean - categories: - items: - $ref: '#/components/schemas/ClassificationCategory' - type: array - description: Categories representing the input document. - languageCode: + The actual training cost, expressed in node seconds. Populated for + models trained in node time. + stopReason: + type: string description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + enumDescriptions: + - '' + - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + exportModelSpec: + $ref: '#/components/schemas/XPSImageExportModelSpec' + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Populated for + AutoMl requests. + trainCostInNodeTime: type: string - description: The document classification response message. - id: ClassifyTextResponse - XPSConfidenceMetricsEntry: - id: XPSConfidenceMetricsEntry - description: >- - ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. - Next tag: 16. + description: >- + The actual cost to create this model. - For edge type model, the + cost is expressed in node hour. - For cloud type model,the cost is + expressed in compute hour. - Populated for models created before GA. + To be deprecated after GA. + format: google-duration + XPSVisualization: type: object properties: - precisionAt1: + type: description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - example. - format: float + Type of the image visualization. Only applicable to Integrated + Gradients attribution. OUTLINES shows regions of attribution, while + PIXELS shows per-pixel attribution. Defaults to OUTLINES. + enumDescriptions: + - Should not be used. + - Shows which pixel contributed to the image prediction. + - >- + Shows which region contributed to the image prediction by + outlining the region. + enum: + - TYPE_UNSPECIFIED + - PIXELS + - OUTLINES + type: string + clipPercentLowerbound: type: number - confidenceThreshold: + description: >- + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. + format: float + overlayType: + enumDescriptions: + - Default value. This is the same as NONE. + - No overlay. + - The attributions are shown on top of the original image. + - >- + The attributions are shown on top of grayscaled version of the + original image. + - >- + The attributions are used as a mask to reveal predictive parts of + the image and hide the un-predictive parts. + type: string + enum: + - OVERLAY_TYPE_UNSPECIFIED + - NONE + - ORIGINAL + - GRAYSCALE + - MASK_BLACK + description: >- + How the original image is displayed in the visualization. Adjusting + the overlay can help increase visual clarity if the original image + makes it difficult to view the visualization. Defaults to NONE. + clipPercentUpperbound: + description: >- + Excludes attributions above the specified percentile from the + highlighted areas. Using the clip_percent_upperbound and + clip_percent_lowerbound together can be useful for filtering out + noise and making it easier to see areas of strong attribution. + Defaults to 99.9. format: float type: number + polarity: + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + type: string description: >- - Metrics are computed with an assumption that the model never return - predictions with score lower than this value. - falsePositiveCount: + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. + enumDescriptions: + - Default value. This is the same as POSITIVE. + - >- + Highlights the pixels/outlines that were most influential to the + model's prediction. + - >- + Setting polarity to negative highlights areas that does not lead + to the models's current prediction. + - Shows both positive and negative attributions. + colorMap: + enum: + - COLOR_MAP_UNSPECIFIED + - PINK_GREEN + - VIRIDIS + - RED + - GREEN + - RED_GREEN + - PINK_WHITE_GREEN + type: string + enumDescriptions: + - Should not be used. + - 'Positive: green. Negative: pink.' + - >- + Viridis color map: A perceptually uniform color mapping which is + easier to see by those with colorblindness and progresses from + yellow to green to blue. Positive: yellow. Negative: blue. + - 'Positive: red. Negative: red.' + - 'Positive: green. Negative: green.' + - 'Positive: green. Negative: red.' + - PiYG palette. description: >- - The number of model created labels that do not match a ground truth - label. + The color scheme used for the highlighted areas. Defaults to + PINK_GREEN for Integrated Gradients attribution, which shows + positive attributions in green and negative in pink. Defaults to + VIRIDIS for XRAI attribution, which highlights the most influential + regions in yellow and the least influential in blue. + id: XPSVisualization + description: Visualization configurations for image explanation. + deprecated: true + CpuMetric: + id: CpuMetric + description: Metric for billing reports. + properties: + machineSpec: + enum: + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: Required. Machine spec, e.g. N1_STANDARD_4. + coreSec: + description: Required. Total seconds of core usage, e.g. 4. format: int64 - recall: - description: Recall (true positive rate) for the given confidence threshold. - format: float - type: number - falsePositiveRate: - type: number - description: False Positive Rate for the given confidence threshold. - format: float - falsePositiveRateAt1: - type: number - format: float - description: >- - The False Positive Rate when only considering the label that has the - highest prediction score and not below the confidence threshold for - each example. - recallAt1: - type: number - format: float - description: >- - The recall (true positive rate) when only considering the label that - has the highest prediction score and not below the confidence - threshold for each example. - truePositiveCount: - description: The number of model created labels that match a ground truth label. - format: int64 - type: string - f1ScoreAt1: - format: float - description: The harmonic mean of recall_at1 and precision_at1. - type: number - precision: - format: float - description: Precision for the given confidence threshold. - type: number - positionThreshold: - format: int32 - type: integer - description: >- - Metrics are computed with an assumption that the model always - returns at most this many predictions (ordered by their score, - descendingly), but they all still need to meet the - confidence_threshold. - falseNegativeCount: type: string + coreNumber: + description: Required. Number of CPU cores. format: int64 - description: >- - The number of ground truth labels that are not matched by a model - created label. - trueNegativeCount: - description: >- - The number of labels that were not created by the model, but if they - would, they would not match a ground truth label. type: string - format: int64 - f1Score: - type: number - description: The harmonic mean of recall and precision. - format: float - XPSVideoClassificationTrainResponse: - properties: - trainCostNodeSeconds: - format: int64 + cpuType: + enumDescriptions: + - '' + - GPU-based machine, skip quota reporting. + - GPU-based machine, skip quota reporting. + - COMPUTE_OPTIMIZED + - '' + - '' + - '' + - GPU-based machine, skip quota reporting. + - '' + - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + - MEMORY_OPTIMIZED + - '' + - '' + - '' + - '' + enum: + - UNKNOWN_CPU_TYPE + - A2 + - A3 + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D type: string + description: Required. Type of cpu, e.g. N2. + trackingLabels: description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - id: XPSVideoClassificationTrainResponse - type: object - XPSTextTrainResponse: - id: XPSTextTrainResponse - properties: - componentModel: - items: - $ref: '#/components/schemas/XPSTextComponentModel' - type: array - description: Component submodels. - type: object - XPSTextExtractionEvaluationMetrics: - type: object - id: XPSTextExtractionEvaluationMetrics - properties: - bestF1ConfidenceMetrics: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - deprecated: true - description: >- - Values are at the highest F1 score on the precision-recall curve. - Only confidence_threshold, recall, precision, and f1_score will be - set. - perLabelConfidenceMetrics: - description: Only recall, precision, and f1_score will be set. - deprecated: true + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" type: object additionalProperties: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' - description: >- - Confusion matrix of the model, at the default confidence threshold - (0.0). Only set for whole-model evaluation, not for evaluation per - label. - confidenceMetricsEntries: - type: array - items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - description: >- - If the enclosing EvaluationMetrics.label is empty, - confidence_metrics_entries is an evaluation of the entire model - across all labels. If the enclosing EvaluationMetrics.label is set, - confidence_metrics_entries applies to that label. - XPSBatchPredictResponse: + type: string type: object + AnalyzeSentimentResponse: + description: The sentiment analysis response message. properties: - exampleSet: - description: >- - Examples for batch prediction result. Under full API implementation, - results are stored in shared RecordIO of AnnotatedExample protobufs, - the annotations field of which is populated by XPS backend. - $ref: '#/components/schemas/XPSExampleSet' - id: XPSBatchPredictResponse - XPSVideoActionRecognitionEvaluationMetrics: - properties: - videoActionMetricsEntries: + documentSentiment: + $ref: '#/components/schemas/Sentiment' + description: The overall sentiment of the input document. + languageCode: + type: string description: >- - Output only. The metric entries for precision window lengths: - 1s,2s,3s,4s, 5s. - type: array + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + sentences: items: - $ref: '#/components/schemas/XPSVideoActionMetricsEntry' - evaluatedActionCount: + $ref: '#/components/schemas/Sentence' + type: array + description: The sentiment for all the sentences in the document. + languageSupported: + type: boolean description: >- - Output only. The number of ground truth actions used to create this - evaluation. - type: integer - format: int32 - description: Model evaluation metrics for video action recognition. + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. type: object - id: XPSVideoActionRecognitionEvaluationMetrics - XPSCategoryStatsSingleCategoryStats: - description: The statistics of a single CATEGORY value. - id: XPSCategoryStatsSingleCategoryStats + id: AnalyzeSentimentResponse + XPSTimestampStats: + description: The data statistics of a series of TIMESTAMP values. + id: XPSTimestampStats properties: - value: - description: The CATEGORY value. - type: string - count: - description: The number of occurrences of this value in the series. + medianTimestampNanos: type: string format: int64 + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + granularStats: + additionalProperties: + $ref: '#/components/schemas/XPSTimestampStatsGranularStats' + type: object + description: >- + The string key is the pre-defined granularity. Currently supported: + hour_of_day, day_of_week, month_of_year. Granularities finer that + the granularity of timestamp data are not populated (e.g. if + timestamps are at day granularity, then hour_of_day is not + populated). type: object RamMetric: + type: object properties: machineSpec: enumDescriptions: @@ -4028,7 +4063,7 @@ components: - '' - '' - '' - description: Required. Machine spec, e.g. N1_STANDARD_4. + type: string enum: - UNKNOWN_MACHINE_SPEC - N1_STANDARD_2 @@ -4191,8 +4226,15 @@ components: - C3_HIGHMEM_44 - C3_HIGHMEM_88 - C3_HIGHMEM_176 + description: Required. Machine spec, e.g. N1_STANDARD_4. + gibSec: type: string + format: int64 + description: >- + Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type + to match billing metrics definition. trackingLabels: + type: object additionalProperties: type: string description: >- @@ -4200,25 +4242,7 @@ components: the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" - type: object ramType: - enum: - - UNKNOWN_RAM_TYPE - - A2 - - A3 - - C2 - - C2D - - CUSTOM - - E2 - - G2 - - C3 - - M2 - - M1 - - N1 - - N2_CUSTOM - - N2 - - N2D - type: string enumDescriptions: - '' - '' @@ -4235,199 +4259,242 @@ components: - '' - '' - '' + type: string + enum: + - UNKNOWN_RAM_TYPE + - A2 + - A3 + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D description: Required. Type of ram. memories: - format: double description: Required. VM memory in gb. type: number - gibSec: - description: >- - Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type - to match billing metrics definition. - format: int64 - type: string - type: object + format: double id: RamMetric - Sentiment: - id: Sentiment - description: >- - Represents the feeling associated with the entire text or entities in - the text. - type: object + XPSTrainingObjectivePoint: properties: - score: + createTime: + type: string + description: The time at which this point was recorded. + format: google-datetime + value: type: number format: float - description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). - magnitude: - description: >- - A non-negative number in the [0, +inf) range, which represents the - absolute magnitude of sentiment regardless of score (positive or - negative). - format: float - type: number - XPSExportModelOutputConfig: + description: The objective value when this point was recorded. + id: XPSTrainingObjectivePoint + type: object + XPSReportingMetrics: + id: XPSReportingMetrics type: object properties: - coreMlFormat: - $ref: '#/components/schemas/XPSCoreMlFormat' - tfSavedModelFormat: - $ref: '#/components/schemas/XPSTfSavedModelFormat' - outputGcrUri: - type: string - description: >- - The Google Contained Registry (GCR) path the exported files to be - pushed to. This location is set if the exported format is DOCKDER. - outputGcsUri: + effectiveTrainingDuration: description: >- - The Google Cloud Storage (GCS) directory where XPS will output the - exported models and related files. Format: gs://bucket/directory + The effective time training used. If set, this is used for quota + management and billing. Deprecated. AutoML BE doesn't use this. + Don't set. + deprecated: true type: string - tfJsFormat: - $ref: '#/components/schemas/XPSTfJsFormat' - tfLiteFormat: - $ref: '#/components/schemas/XPSTfLiteFormat' - exportFirebaseAuxiliaryInfo: - type: boolean + format: google-duration + metricEntries: + items: + $ref: '#/components/schemas/XPSMetricEntry' + type: array description: >- - For any model and format: If true, will additionally export - FirebaseExportedModelInfo in a firebase.txt file. - edgeTpuTfLiteFormat: - $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' - dockerFormat: - $ref: '#/components/schemas/XPSDockerFormat' - id: XPSExportModelOutputConfig - XPSConfusionMatrixRow: - id: XPSConfusionMatrixRow + One entry per metric name. The values must be aggregated per metric + name. + XPSResponseExplanationMetadataOutputMetadata: + id: XPSResponseExplanationMetadataOutputMetadata type: object properties: - count: + outputTensorName: + type: string + description: Name of the output tensor. Only needed in train response. + description: Metadata of the prediction output to be explained. + XPSConfusionMatrix: + id: XPSConfusionMatrix + type: object + properties: + category: + items: + format: int32 + type: integer + description: >- + Category (mainly for segmentation). Set only for image segmentation + models. Note: uCAIP Image Segmentation should use + annotation_spec_id_token. + type: array + annotationSpecIdToken: items: - format: int64 type: string description: >- - Same as above except intended to represent other counts (for e.g. - for segmentation this is pixel count). NOTE(params): Only - example_count or count is set (oneoff does not support repeated - fields unless they are embedded inside another message). + For the following three repeated fields, only one is intended to be + set. annotation_spec_id_token is preferable to be set. ID tokens of + the annotation specs used in the confusion matrix. type: array - exampleCount: + row: + description: >- + Rows in the confusion matrix. The number of rows is equal to the + size of `annotation_spec_id_token`. `row[i].value[j]` is the number + of examples that have ground truth of the + `annotation_spec_id_token[i]` and are predicted as + `annotation_spec_id_token[j]` by the model being evaluated. + items: + $ref: '#/components/schemas/XPSConfusionMatrixRow' type: array + sentimentLabel: description: >- - Value of the specific cell in the confusion matrix. The number of - values each row has (i.e. the length of the row) is equal to the - length of the annotation_spec_id_token field. + Sentiment labels used in the confusion matrix. Set only for text + sentiment models. For AutoML Text Revamp, use + `annotation_spec_id_token` instead and leave this field empty. + type: array items: - type: integer format: int32 - description: A row in the confusion matrix. - XPSCommonStats: - properties: - validValueCount: - type: string - format: int64 - distinctValueCount: - format: int64 - type: string - nullValueCount: - format: int64 - type: string - description: Common statistics for a column with a specified data type. - id: XPSCommonStats - type: object - XPSTrackMetricsEntryConfidenceMetricsEntry: - id: XPSTrackMetricsEntryConfidenceMetricsEntry + type: integer + description: Confusion matrix of the model running the classification. + XPSVideoActionMetricsEntryConfidenceMetricsEntry: properties: - trackingRecall: - description: Output only. Tracking recall. + f1Score: type: number format: float - trackingPrecision: - format: float - description: Output only. Tracking precision. - type: number - boundingBoxIou: - description: >- - Output only. Bounding box intersection-over-union precision. - Measures how well the bounding boxes overlap between each other - (e.g. complete overlap or just barely above iou_threshold). + description: Output only. The harmonic mean of recall and precision. + precision: type: number + description: Output only. Precision for the given confidence threshold. format: float - mismatchRate: + recall: type: number - description: >- - Output only. Mismatch rate, which measures the tracking consistency, - i.e. correctness of instance ID continuity. + description: Output only. Recall for the given confidence threshold. format: float confidenceThreshold: + format: float type: number description: >- Output only. The confidence threshold value used to compute the metrics. - format: float - type: object - description: 'Metrics for a single confidence threshold. Next tag: 6.' - XPSTextToSpeechTrainResponse: - description: TextToSpeech train response + description: Metrics for a single confidence threshold. type: object + id: XPSVideoActionMetricsEntryConfidenceMetricsEntry + XPSTfSavedModelFormat: properties: {} - id: XPSTextToSpeechTrainResponse - XPSVisionTrainingOperationMetadata: - deprecated: true - id: XPSVisionTrainingOperationMetadata + id: XPSTfSavedModelFormat + type: object + description: A tensorflow model format in SavedModel format. + XPSResponseExplanationMetadataInputMetadata: + type: object properties: - explanationUsage: + visualizationConfig: + description: Visualization configurations for image explanation. + $ref: '#/components/schemas/XPSVisualization' + inputTensorName: + type: string description: >- - Aggregated infra usage within certain time period, for billing - report purpose if XAI is enable in training request. - $ref: '#/components/schemas/InfraUsage' - type: object - XPSTranslationEvaluationMetrics: - description: Evaluation metrics for the dataset. + Name of the input tensor for this model. Only needed in train + response. + modality: + enumDescriptions: + - '' + - '' + - '' + - '' + description: >- + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. + enum: + - MODALITY_UNSPECIFIED + - NUMERIC + - IMAGE + - CATEGORICAL + type: string + description: Metadata of the input of a feature. + id: XPSResponseExplanationMetadataInputMetadata + Sentiment: + description: >- + Represents the feeling associated with the entire text or entities in + the text. properties: - baseBleuScore: - format: double + magnitude: + description: >- + A non-negative number in the [0, +inf) range, which represents the + absolute magnitude of sentiment regardless of score (positive or + negative). type: number - description: BLEU score for base model. - bleuScore: - format: double - description: BLEU score. + format: float + score: type: number + description: >- + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). + format: float type: object - id: XPSTranslationEvaluationMetrics - XPSVideoExportModelSpec: + id: Sentiment + XPSTablesClassificationMetrics: + properties: + curveMetrics: + description: Metrics building a curve. + items: + $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' + type: array + id: XPSTablesClassificationMetrics type: object - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Upon receiving - ExportModel request from user, AutoMl backend can serve the - pre-generated models to user if exists (by copying the files from - internal path to user provided location), otherwise, AutoMl backend will - call xPS ExportModel API to generate the model on the fly with the - requesting format. + description: Metrics for Tables classification problems. + Status: + type: object + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - exportModelOutputConfig: - items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: type: array description: >- - Contains the model format and internal location of the model files - to be exported/downloaded. Use the GCS bucket name which is provided - via TrainRequest.gcs_bucket_name to store the model files. - id: XPSVideoExportModelSpec + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 XPSClassificationEvaluationMetrics: - type: object id: XPSClassificationEvaluationMetrics - description: >- - Model evaluation metrics for classification problems. It can be used for - image and video classification. Next tag: 9. + type: object properties: - logLoss: - format: float - type: number - description: The Log Loss metric. + confidenceMetricsEntries: + description: >- + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. + items: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + type: array + evaluatedExamplesCount: + type: integer + description: The number of examples used for model evaluation. + format: int32 auRoc: description: >- The Area Under Receiver Operating Characteristic curve metric. @@ -4441,408 +4508,341 @@ components: classification problems where number of annotation specs is no more than 10. Only set for model level evaluation, not for evaluation per label. - auPrc: + logLoss: + description: The Log Loss metric. + format: float type: number + auPrc: format: float + type: number description: The Area under precision recall curve metric. - confidenceMetricsEntries: - items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - type: array - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. baseAuPrc: + type: number format: float description: The Area under precision recall curve metric based on priors. - type: number - evaluatedExamplesCount: - format: int32 - description: The number of examples used for model evaluation. - type: integer - XPSTranslationTrainResponse: - type: object - properties: - modelType: - description: Type of the model. - enum: - - MODEL_TYPE_UNSPECIFIED - - LEGACY - - CURRENT - enumDescriptions: - - Default - - Legacy model. Will be deprecated. - - Current model. - type: string - description: Train response for translation. - id: XPSTranslationTrainResponse - XPSTablesEvaluationMetrics: - properties: - classificationMetrics: - $ref: '#/components/schemas/XPSTablesClassificationMetrics' - description: Classification metrics. - regressionMetrics: - $ref: '#/components/schemas/XPSTablesRegressionMetrics' - description: Regression metrics. - id: XPSTablesEvaluationMetrics - type: object - Entity: + description: >- + Model evaluation metrics for classification problems. It can be used for + image and video classification. Next tag: 9. + XPSResponseExplanationMetadata: properties: - sentiment: - $ref: '#/components/schemas/Sentiment' - description: >- - For calls to AnalyzeEntitySentiment or if - AnnotateTextRequest.Features.extract_entity_sentiment is set to - true, this field will contain the aggregate sentiment expressed for - this entity in the provided document. - name: - description: The representative name for the entity. - type: string - mentions: - description: >- - The mentions of this entity in the input document. The API currently - supports proper noun mentions. - type: array - items: - $ref: '#/components/schemas/EntityMention' - metadata: + inputs: + description: Metadata of the input. + additionalProperties: + $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' + type: object + outputs: + description: Metadata of the output. type: object - description: >- - Metadata associated with the entity. For the metadata associated - with other entity types, see the Type table below. additionalProperties: - type: string - type: - type: string - enum: - - UNKNOWN - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - description: The entity type. - enumDescriptions: - - Unknown - - Person - - Location - - Organization - - Event - - Artwork - - Consumer product - - Other types of entities - - >- - Phone number The metadata lists the phone number, formatted - according to local convention, plus whichever additional elements - appear in the text: * `number` - the actual number, broken down - into sections as per local convention * `national_prefix` - - country code, if detected * `area_code` - region or area code, if - detected * `extension` - phone extension (to be dialed after - connection), if detected - - >- - Address The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - street number * `locality` - city or town * - `street_name` - street/route name, if detected * `postal_code` - - postal code, if detected * `country` - country, if detected * - `broad_region` - administrative area, such as the state, if - detected * `narrow_region` - smaller administrative area, such as - county, if detected * `sublocality` - used in Asian addresses to - demark a district within a city, if detected - - >- - Date The metadata identifies the components of the date: * `year` - - four digit year, if detected * `month` - two digit month number, - if detected * `day` - two digit day number, if detected - - Number The metadata is the number itself. - - Price The metadata identifies the `value` and `currency`. - id: Entity + $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' + deprecated: true type: object - description: >- - Represents a phrase in the text that is a known entity, such as a - person, an organization, or location. The API associates information, - such as probability and mentions, with entities. - XPSStructType: - id: XPSStructType + id: XPSResponseExplanationMetadata + AnalyzeEntitiesResponse: + description: The entity analysis response message. type: object - description: '`StructType` defines the DataType-s of a STRUCT type.' - properties: - fields: - additionalProperties: - $ref: '#/components/schemas/XPSDataType' - type: object - description: Unordered map of struct field names to their data types. - XPSColumnSpec: properties: - displayName: + languageSupported: + type: boolean description: >- - The display name of the column. It's outputed in Preprocess and a - required input for RefreshTablesStats and Train. + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + entities: + items: + $ref: '#/components/schemas/Entity' + description: The recognized entities in the input document. + type: array + languageCode: type: string - columnId: - format: int32 description: >- - The unique id of the column. When Preprocess, the Tables BE will - popuate the order id of the column, which reflects the order of the - column inside the table, i.e. 0 means the first column in the table, - N-1 means the last column. AutoML BE will persist this order id in - Spanner and set the order id here when calling RefreshTablesStats - and Train. Note: it's different than the column_spec_id that is - generated in AutoML BE. - type: integer - topCorrelatedColumns: + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + id: AnalyzeEntitiesResponse + XPSVideoExportModelSpec: + id: XPSVideoExportModelSpec + type: object + properties: + exportModelOutputConfig: items: - $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' - description: It's outputed in RefreshTablesStats, and a required input in Train. + $ref: '#/components/schemas/XPSExportModelOutputConfig' type: array - dataStats: - $ref: '#/components/schemas/XPSDataStats' description: >- - The data stats of the column. It's outputed in RefreshTablesStats - and a required input for Train. - forecastingMetadata: - $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' - dataType: - $ref: '#/components/schemas/XPSDataType' + Contains the model format and internal location of the model files + to be exported/downloaded. Use the GCS bucket name which is provided + via TrainRequest.gcs_bucket_name to store the model files. + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Upon receiving + ExportModel request from user, AutoMl backend can serve the + pre-generated models to user if exists (by copying the files from + internal path to user provided location), otherwise, AutoMl backend will + call xPS ExportModel API to generate the model on the fly with the + requesting format. + XPSVideoTrainingOperationMetadata: + id: XPSVideoTrainingOperationMetadata + properties: + trainCostMilliNodeHour: description: >- - The data type of the column. It's outputed in Preprocess rpc and a - required input for RefreshTablesStats and Train. + This is an estimation of the node hours necessary for training a + model, expressed in milli node hours (i.e. 1,000 value in this field + means 1 node hour). A node hour represents the time a virtual + machine spends running your training job. The cost of one node + running for one hour is a node hour. + type: string + format: int64 type: object - id: XPSColumnSpec - AnnotateTextRequest: + XPSDataType: type: object properties: - encodingType: + compatibleDataTypes: + type: array + items: + $ref: '#/components/schemas/XPSDataType' + description: The highly compatible data types to this data type. + nullable: + description: If true, this DataType can also be `null`. + type: boolean + timeFormat: + type: string + description: >- + If type_code == TIMESTAMP then `time_format` provides the format in + which that time field is expressed. The time_format must be written + in `strftime` syntax. If time_format is not set, then the default + format as described on the field is used. + structType: + $ref: '#/components/schemas/XPSStructType' + description: >- + If type_code == STRUCT, then `struct_type` provides type information + for the struct's fields. + typeCode: enumDescriptions: + - Not specified. Should not be used. - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. + Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or + `"-Infinity"`. - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. + Must be between 0AD and 9999AD. Encoded as `string` according to + time_format, or, if that format is not set, then in RFC 3339 + `date-time` format, where `time-offset` = `"Z"` (e.g. + 1985-04-12T23:20:50.52Z). + - Encoded as `string`. - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. + Encoded as `list`, where the list elements are represented + according to list_element_type. - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - type: string + Encoded as `struct`, where field values are represented according + to struct_type. + - >- + Values of this type are not further understood by AutoML, e.g. + AutoML is unable to tell the order of values (as it could with + FLOAT64), or is unable to say if one value contains another (as it + could with STRING). Encoded as `string` (bytes should be + base64-encoded, as described in RFC 4648, section 4). enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - description: The encoding type used by the API to calculate offsets. - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - features: - $ref: '#/components/schemas/AnnotateTextRequestFeatures' - description: Required. The enabled features. - id: AnnotateTextRequest + - TYPE_CODE_UNSPECIFIED + - FLOAT64 + - TIMESTAMP + - STRING + - ARRAY + - STRUCT + - CATEGORY + description: Required. The TypeCode for this type. + type: string + listElementType: + $ref: '#/components/schemas/XPSDataType' + description: >- + If type_code == ARRAY, then `list_element_type` is the type of the + elements. + id: XPSDataType description: >- - The request message for the text annotation API, which can perform - multiple analysis types in one call. - XPSTablesTrainingOperationMetadata: - id: XPSTablesTrainingOperationMetadata + Indicated the type of data that can be stored in a structured data + entity (e.g. a table). + TpuMetric: type: object + id: TpuMetric properties: - trainBudgetMilliNodeHours: + tpuSec: type: string - description: Creating model budget. format: int64 - optimizationObjective: + description: Required. Seconds of TPU usage, e.g. 3600. + tpuType: type: string - description: The optimization objective for model. - createModelStage: - description: Current stage of creating model. enumDescriptions: - - Unspecified stage. - - Prepare the model training pipeline and run data processing. - - Training model. - - Run evaluation. - - Finalizing model training pipeline. + - '' + - '' + - '' + - '' + - '' + - '' + description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. enum: - - CREATE_MODEL_STAGE_UNSPECIFIED - - DATA_PREPROCESSING - - TRAINING - - EVALUATING - - MODEL_POST_PROCESSING - type: string - trainingObjectivePoints: - items: - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - type: array + - UNKNOWN_TPU_TYPE + - TPU_V2_POD + - TPU_V2 + - TPU_V3_POD + - TPU_V3 + - TPU_V5_LITEPOD + XPSImageObjectDetectionEvaluationMetrics: + id: XPSImageObjectDetectionEvaluationMetrics + description: >- + Model evaluation metrics for image object detection problems. Evaluates + prediction quality of labeled bounding boxes. + properties: + evaluatedBoundingBoxCount: + format: int32 description: >- - This field records the training objective value with respect to - time, giving insight into how the model architecture search is - performing as training time elapses. - trainingStartTime: - format: google-datetime - description: Timestamp when training process starts. - type: string - topTrials: + The total number of bounding boxes (i.e. summed over all images) the + ground truth used to create this evaluation had. + type: integer + boundingBoxMeanAveragePrecision: description: >- - This field is for training. When the operation is terminated - successfully, AutoML Backend post this field to operation metadata - in spanner. If the metadata has no trials returned, the training - operation is supposed to be a failure. + The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. + format: float + type: number + boundingBoxMetricsEntries: + description: >- + The bounding boxes match metrics for each Intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. type: array items: - $ref: '#/components/schemas/XPSTuningTrial' - XPSCoreMlFormat: - description: A model format used for iOS mobile devices. - properties: {} - id: XPSCoreMlFormat + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' type: object - XPSStringStatsUnigramStats: - properties: - count: - type: string - description: The number of occurrences of this unigram in the series. - format: int64 - value: - type: string - description: The unigram. + XPSTrackMetricsEntry: + id: XPSTrackMetricsEntry type: object - id: XPSStringStatsUnigramStats - description: The statistics of a unigram. - Sentence: properties: - text: - description: The sentence text. - $ref: '#/components/schemas/TextSpan' - sentiment: + meanBoundingBoxIou: + type: number + format: float description: >- - For calls to AnalyzeSentiment or if - AnnotateTextRequest.Features.extract_document_sentiment is set to - true, this field will contain the sentiment for the sentence. - $ref: '#/components/schemas/Sentiment' - id: Sentence - type: object - description: Represents a sentence in the input document. - XPSTablesModelStructure: - type: object - description: A description of Tables model structure. - properties: - modelParameters: - description: A list of models. + Output only. The mean bounding box iou over all confidence + thresholds. + meanMismatchRate: + format: float + type: number + description: Output only. The mean mismatch rate over all confidence thresholds. + iouThreshold: + format: float + description: >- + Output only. The intersection-over-union threshold value between + bounding boxes across frames used to compute this metric entry. + type: number + confidenceMetricsEntries: type: array items: - $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' - id: XPSTablesModelStructure - XPSVideoObjectTrackingTrainResponse: - id: XPSVideoObjectTrackingTrainResponse + $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' + description: >- + Output only. Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. + meanTrackingAveragePrecision: + description: >- + Output only. The mean average precision over all confidence + thresholds. + type: number + format: float + description: >- + Track matching model metrics for a single track match threshold and + multiple label match confidence thresholds. Next tag: 6. + XPSVisionTrainingOperationMetadata: + properties: + explanationUsage: + description: >- + Aggregated infra usage within certain time period, for billing + report purpose if XAI is enable in training request. + $ref: '#/components/schemas/InfraUsage' + type: object + id: XPSVisionTrainingOperationMetadata + deprecated: true + XPSDataStats: + description: The data statistics of a series of values that share the same DataType. + id: XPSDataStats type: object properties: - trainCostNodeSeconds: + distinctValueCount: + description: The number of distinct values. + type: string + format: int64 + arrayStats: + description: The statistics for ARRAY DataType. + $ref: '#/components/schemas/XPSArrayStats' + validValueCount: + description: The number of values that are valid. format: int64 type: string - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - modelArtifactSpec: - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - exportModelSpec: - $ref: '#/components/schemas/XPSVideoExportModelSpec' - description: Populated for AutoML request only. - XPSImageExportModelSpec: - type: object - properties: - exportModelOutputConfig: - description: >- - Contains the model format and internal location of the model files - to be exported/downloaded. Use the GCS bucket name which is provided - via TrainRequest.gcs_bucket_name to store the model files. - items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' - type: array - id: XPSImageExportModelSpec - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Upon receiving - ExportModel request from user, AutoMl backend can serve the - pre-generated models to user if exists (by copying the files from - internal path to user provided location), otherwise, AutoMl backend will - call xPS ExportModel API to generate the model on the fly with the - requesting format. - XPSDockerFormat: - id: XPSDockerFormat - description: >- - A model format used for Docker containers. Use the params field to - customize the container. The container is verified to work correctly on - ubuntu 16.04 operating system. + timestampStats: + description: The statistics for TIMESTAMP DataType. + $ref: '#/components/schemas/XPSTimestampStats' + structStats: + $ref: '#/components/schemas/XPSStructStats' + description: The statistics for STRUCT DataType. + nullValueCount: + description: The number of values that are null. + type: string + format: int64 + float64Stats: + $ref: '#/components/schemas/XPSFloat64Stats' + description: The statistics for FLOAT64 DataType. + categoryStats: + $ref: '#/components/schemas/XPSCategoryStats' + description: The statistics for CATEGORY DataType. + stringStats: + $ref: '#/components/schemas/XPSStringStats' + description: The statistics for STRING DataType. + XPSImageModelServingSpec: + id: XPSImageModelServingSpec properties: - gpuArchitecture: - enumDescriptions: - - '' - - '' - enum: - - GPU_ARCHITECTURE_UNSPECIFIED - - GPU_ARCHITECTURE_NVIDIA + tfRuntimeVersion: type: string description: >- - Optional. Additional gpu information describing the requirements for - the to be exported model files. - cpuArchitecture: - enum: - - CPU_ARCHITECTURE_UNSPECIFIED - - CPU_ARCHITECTURE_X86_64 - enumDescriptions: - - '' - - '' + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list + nodeQps: + format: double description: >- - Optional. Additional cpu information describing the requirements for - the to be exported model files. - type: string - type: object - XPSSpeechEvaluationMetrics: - properties: - subModelEvaluationMetrics: + An estimated value of how much traffic a node can serve. Populated + for AutoMl request only. + type: number + modelThroughputEstimation: items: $ref: >- - #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric + #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation + description: Populate under uCAIP request scope. type: array - description: Evaluation metrics for all submodels contained in this model. - id: XPSSpeechEvaluationMetrics + description: Serving specification for image models. type: object parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + 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. in: query - name: prettyPrint + name: key schema: - type: boolean - fields: - description: Selector specifying which fields to include in a partial response. + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: fields + name: uploadType schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: quotaUser + name: upload_protocol schema: type: string oauth_token: @@ -4851,27 +4851,18 @@ components: name: oauth_token schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - 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. - in: query - name: key - schema: - type: string callback: description: JSONP in: query name: callback schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean _.xgafv: description: V1 error format. in: query @@ -4881,10 +4872,19 @@ components: enum: - '1' - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser schema: type: string alt: @@ -4903,21 +4903,15 @@ components: name: documents title: Documents methods: - analyze_sentiment: - operation: - $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' - response: - mediaType: application/json - openAPIDocKey: '200' classify_text: operation: $ref: '#/paths/~1v2~1documents:classifyText/post' response: mediaType: application/json openAPIDocKey: '200' - analyze_entities: + analyze_sentiment: operation: - $ref: '#/paths/~1v2~1documents:analyzeEntities/post' + $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4927,6 +4921,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + analyze_entities: + operation: + $ref: '#/paths/~1v2~1documents:analyzeEntities/post' + response: + mediaType: application/json + openAPIDocKey: '200' moderate_text: operation: $ref: '#/paths/~1v2~1documents:moderateText/post' @@ -4940,27 +4940,27 @@ components: replace: [] delete: [] paths: - /v2/documents:analyzeSentiment: + /v2/documents:classifyText: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/alt' post: - description: Analyzes the sentiment of the provided text. - operationId: language.documents.analyzeSentiment + description: Classifies a document into categories. + operationId: language.documents.classifyText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentRequest' + $ref: '#/components/schemas/ClassifyTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -4976,18 +4976,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentResponse' + $ref: '#/components/schemas/ClassifyTextResponse' parameters: [] - /v2/documents:classifyText: + /v2/documents:analyzeSentiment: parameters: *ref_1 post: - description: Classifies a document into categories. - operationId: language.documents.classifyText + description: Analyzes the sentiment of the provided text. + operationId: language.documents.analyzeSentiment requestBody: content: application/json: schema: - $ref: '#/components/schemas/ClassifyTextRequest' + $ref: '#/components/schemas/AnalyzeSentimentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5003,21 +5003,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ClassifyTextResponse' + $ref: '#/components/schemas/AnalyzeSentimentResponse' parameters: [] - /v2/documents:analyzeEntities: + /v2/documents:annotateText: parameters: *ref_1 post: - description: >- - Finds named entities (currently proper names and common nouns) in the - text along with entity types, probability, mentions for each entity, and - other properties. - operationId: language.documents.analyzeEntities + description: A convenience method that provides all features in one call. + operationId: language.documents.annotateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesRequest' + $ref: '#/components/schemas/AnnotateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5033,18 +5030,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesResponse' + $ref: '#/components/schemas/AnnotateTextResponse' parameters: [] - /v2/documents:annotateText: + /v2/documents:analyzeEntities: parameters: *ref_1 post: - description: A convenience method that provides all features in one call. - operationId: language.documents.annotateText + description: >- + Finds named entities (currently proper names and common nouns) in the + text along with entity types, probability, mentions for each entity, and + other properties. + operationId: language.documents.analyzeEntities requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextRequest' + $ref: '#/components/schemas/AnalyzeEntitiesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5060,7 +5060,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextResponse' + $ref: '#/components/schemas/AnalyzeEntitiesResponse' parameters: [] /v2/documents:moderateText: parameters: *ref_1 diff --git a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml index 8cc475de..d9def9cb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml @@ -34,77 +34,77 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + GoogleExampleLibraryagentV1Shelf: + properties: + name: + type: string + description: >- + Output only. The resource name of the shelf. Shelf names have the + form `shelves/{shelf_id}`. The name is ignored when creating a + shelf. + theme: + description: The theme of the shelf + type: string + type: object + id: GoogleExampleLibraryagentV1Shelf + description: A Shelf contains a collection of books with a theme. GoogleExampleLibraryagentV1ListBooksResponse: + type: object + id: GoogleExampleLibraryagentV1ListBooksResponse + description: Response message for LibraryAgent.ListBooks. properties: nextPageToken: - type: string description: >- A token to retrieve next page of results. Pass this value in the ListBooksRequest.page_token field in the subsequent call to `ListBooks` method to retrieve the next page of results. + type: string books: - type: array description: The list of books. + type: array items: $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' - id: GoogleExampleLibraryagentV1ListBooksResponse - type: object - description: Response message for LibraryAgent.ListBooks. GoogleExampleLibraryagentV1ListShelvesResponse: - id: GoogleExampleLibraryagentV1ListShelvesResponse description: Response message for LibraryAgent.ListShelves. type: object + id: GoogleExampleLibraryagentV1ListShelvesResponse properties: nextPageToken: + type: string description: >- A token to retrieve next page of results. Pass this value in the ListShelvesRequest.page_token field in the subsequent call to `ListShelves` method to retrieve the next page of results. - type: string shelves: description: The list of shelves. - type: array items: $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' + type: array GoogleExampleLibraryagentV1Book: - id: GoogleExampleLibraryagentV1Book + description: A single book in the library. properties: author: - description: The name of the book author. type: string - read: - description: Value indicating whether the book has been read. - type: boolean - title: - type: string - description: The title of the book. + description: The name of the book author. name: - type: string description: >- The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book. - description: A single book in the library. - type: object - GoogleExampleLibraryagentV1Shelf: - description: A Shelf contains a collection of books with a theme. - properties: - theme: type: string - description: The theme of the shelf - name: - description: >- - Output only. The resource name of the shelf. Shelf names have the - form `shelves/{shelf_id}`. The name is ignored when creating a - shelf. + title: type: string - id: GoogleExampleLibraryagentV1Shelf + description: The title of the book. + read: + description: Value indicating whether the book has been read. + type: boolean type: object + id: GoogleExampleLibraryagentV1Book parameters: - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string uploadType: @@ -113,6 +113,12 @@ components: name: uploadType schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -122,19 +128,10 @@ components: name: quotaUser schema: 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. - in: query - name: key - schema: - type: string - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token schema: type: string _.xgafv: @@ -146,12 +143,6 @@ components: enum: - '1' - '2' - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string alt: description: Data format for response. in: query @@ -162,22 +153,31 @@ components: - json - media - proto - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: upload_protocol + name: fields + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + 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. + in: query + name: key schema: type: string x-stackQL-resources: @@ -186,6 +186,12 @@ components: name: books title: Books methods: + get: + operation: + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books/get' @@ -205,12 +211,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/books/methods/get' @@ -246,19 +246,47 @@ components: replace: [] delete: [] paths: - /v1/shelves/{shelvesId}/books: + /v1/shelves/{shelvesId}/books/{booksId}: parameters: &ref_1 - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/key' + get: + description: Gets a book. Returns NOT_FOUND if the book does not exist. + operationId: libraryagent.shelves.books.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' + parameters: + - in: path + name: shelvesId + required: true + schema: + type: string + - in: path + name: booksId + required: true + schema: + type: string + /v1/shelves/{shelvesId}/books: + parameters: *ref_1 get: description: >- Lists books in a shelf. The order is unspecified but deterministic. @@ -356,34 +384,6 @@ paths: required: true schema: type: string - /v1/shelves/{shelvesId}/books/{booksId}: - parameters: *ref_1 - get: - description: Gets a book. Returns NOT_FOUND if the book does not exist. - operationId: libraryagent.shelves.books.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' - parameters: - - in: path - name: shelvesId - required: true - schema: - type: string - - in: path - name: booksId - required: true - schema: - type: string /v1/shelves/{shelvesId}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml index df78325f..aa8fc0cd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml @@ -7,7 +7,7 @@ info: title: Network Connectivity API description: This API enables connectivity with and between Google Cloud resources. version: v1 - x-discovery-doc-revision: '20240911' + x-discovery-doc-revision: '20240807' x-generated-date: '2024-09-19' externalDocs: url: >- @@ -308,10 +308,7 @@ components: - POLICY_LIMIT_REACHED - CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED producerInstanceId: - description: >- - Immutable. Deprecated. Use producer_instance_metadata instead. An - immutable identifier for the producer instance. - deprecated: true + description: Immutable. An immutable identifier for the producer instance. type: string serviceAttachmentIpAddressMap: description: >- @@ -331,11 +328,6 @@ components: Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234' type: string - producerInstanceMetadata: - description: Immutable. An immutable map for the producer instance metadata. - type: object - additionalProperties: - type: string ConsumerPscConnection: id: ConsumerPscConnection description: PSC connection details on consumer side. @@ -351,10 +343,7 @@ components: type: string enumDescriptions: - An invalid state as the default case. - - >- - The connection has been created successfully. However, for the - up-to-date connection status, please use the service attachment's - "ConnectedEndpoint.status" as the source of truth. + - The connection is fully established and ready to use. - >- The connection is not functional since some resources on the connection fail to be created. @@ -392,7 +381,6 @@ components: description: >- The error type indicates whether the error is consumer facing, producer facing or system internal. - deprecated: true type: string enumDescriptions: - An invalid error type as the default case. @@ -429,16 +417,8 @@ components: readOnly: true type: string producerInstanceId: - description: >- - Immutable. Deprecated. Use producer_instance_metadata instead. An - immutable identifier for the producer instance. - deprecated: true + description: Immutable. An immutable identifier for the producer instance. type: string - producerInstanceMetadata: - description: Immutable. An immutable map for the producer instance metadata. - type: object - additionalProperties: - type: string GoogleRpcErrorInfo: id: GoogleRpcErrorInfo description: >- @@ -517,12 +497,12 @@ components: See: https://google.aip.dev/122#fields-representing-resource-names type: string createTime: - description: Output only. Time when the ServiceConnectionPolicy was created. + description: Output only. Time when the ServiceConnectionMap was created. readOnly: true type: string format: google-datetime updateTime: - description: Output only. Time when the ServiceConnectionPolicy was updated. + description: Output only. Time when the ServiceConnectionMap was updated. readOnly: true type: string format: google-datetime @@ -647,10 +627,7 @@ components: type: string enumDescriptions: - An invalid state as the default case. - - >- - The connection has been created successfully. However, for the - up-to-date connection status, please use the created forwarding - rule's "PscConnectionStatus" as the source of truth. + - The connection is fully established and ready to use. - >- The connection is not functional since some resources on the connection fail to be created. @@ -674,7 +651,6 @@ components: description: >- The error type indicates whether the error is consumer facing, producer facing or system internal. - deprecated: true type: string enumDescriptions: - An invalid error type as the default case. @@ -687,9 +663,7 @@ components: - ERROR_CONSUMER_SIDE - ERROR_PRODUCER_SIDE error: - description: >- - The most recent error during operating this connection. Deprecated, - please use error_info instead. + description: The most recent error during operating this connection. deprecated: true $ref: '#/components/schemas/GoogleRpcStatus' gceOperation: @@ -714,22 +688,7 @@ components: readOnly: true type: string producerInstanceId: - description: >- - Immutable. Deprecated. Use producer_instance_metadata instead. An - immutable identifier for the producer instance. - deprecated: true - type: string - producerInstanceMetadata: - description: Immutable. An immutable map for the producer instance metadata. - type: object - additionalProperties: - type: string - serviceClass: - description: >- - Output only. [Output only] The service class associated with this - PSC Connection. The value is derived from the SCPolicy and matches - the service class name provided by the customer. - readOnly: true + description: Immutable. An immutable identifier for the producer instance. type: string ListServiceClassesResponse: id: ListServiceClassesResponse @@ -2026,11 +1985,7 @@ components: description: A description of this resource. type: string ipCidrRange: - description: >- - The IP range that this internal range defines. NOTE: IPv6 ranges are - limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For - IPv6 Ranges this field is compulsory, i.e. the address range must be - specified explicitly. + description: The IP range that this internal range defines. type: string network: description: >- @@ -2059,16 +2014,10 @@ components: resources and are meant to block out address ranges for various use cases, like for example, usage on-prem, with dynamic route announcements via interconnect. - - >- - Ranges created FOR_MIGRATION can be used to lock a CIDR range - between a source and target subnet. If usage is set to - FOR_MIGRATION the peering value has to be set to FOR_SELF or - default to FOR_SELF when unset. enum: - USAGE_UNSPECIFIED - FOR_VPC - EXTERNAL_TO_VPC - - FOR_MIGRATION peering: description: The type of peering set for this internal range. type: string @@ -2103,14 +2052,11 @@ components: - NOT_SHARED prefixLength: description: >- - An alternate to ip_cidr_range. Can be set when trying to create an - IPv4 reservation that automatically finds a free range of the given - size. If both ip_cidr_range and prefix_length are set, there is an - error if the range sizes do not match. Can also be used during - updates to change the range size. NOTE: For IPv6 this field only - works if ip_cidr_range is set as well, and both fields must match. - In other words, with IPv6 this field only works as a redundant - parameter. + An alternate to ip_cidr_range. Can be set when trying to create a + reservation that automatically finds a free range of the given size. + If both ip_cidr_range and prefix_length are set, there is an error + if the range sizes do not match. Can also be used during updates to + change the range size. type: integer format: int32 targetCidrRange: @@ -2154,28 +2100,6 @@ components: - OVERLAP_UNSPECIFIED - OVERLAP_ROUTE_RANGE - OVERLAP_EXISTING_SUBNET_RANGE - migration: - description: Optional. Should be present if usage is set to FOR_MIGRATION. - $ref: '#/components/schemas/Migration' - Migration: - id: Migration - description: Specification for migration with source and target resource names. - type: object - properties: - source: - description: >- - Immutable. Resource path as an URI of the source resource, for - example a subnet. The project for the source resource should match - the project for the InternalRange. An example: - /projects/{project}/regions/{region}/subnetworks/{subnet} - type: string - target: - description: >- - Immutable. Resource path of the target resource. The target project - can be different, as in the cases when migrating to peer networks. - The resource For example: - /projects/{project}/regions/{region}/subnetworks/{subnet} - type: string ListPolicyBasedRoutesResponse: id: ListPolicyBasedRoutesResponse description: Response for PolicyBasedRouting.ListPolicyBasedRoutes method. diff --git a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml index 1e070cc5..c2d17743 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml @@ -36,144 +36,25 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudOrgpolicyV2ConstraintListConstraint: - id: GoogleCloudOrgpolicyV2ConstraintListConstraint - properties: - supportsUnder: - type: boolean - description: >- - Indicates whether subtrees of the Resource Manager resource - hierarchy can be used in `Policy.allowed_values` and - `Policy.denied_values`. For example, `"under:folders/123"` would - match any resource under the 'folders/123' folder. - supportsIn: - description: >- - Indicates whether values grouped into categories can be used in - `Policy.allowed_values` and `Policy.denied_values`. For example, - `"in:Python"` would match any value in the 'Python' group. - type: boolean - description: >- - A constraint that allows or disallows a list of string values, which are - configured by an Organization Policy administrator with a policy. - type: object - GoogleCloudOrgpolicyV2AlternatePolicySpec: - description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. - id: GoogleCloudOrgpolicyV2AlternatePolicySpec - type: object - properties: - spec: - description: Specify constraint for configurations of Google Cloud resources. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - launch: - description: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. - type: string - GoogleCloudOrgpolicyV2ListConstraintsResponse: - properties: - constraints: - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' - description: >- - The collection of constraints that are available on the targeted - resource. - type: array - nextPageToken: - description: >- - Page token used to retrieve the next page. This is currently not - used. - type: string - id: GoogleCloudOrgpolicyV2ListConstraintsResponse - type: object - description: The response returned from the ListConstraints method. - GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: - properties: - customConstraints: - type: array - description: >- - All custom constraints that exist on the organization resource. It - will be empty if no custom constraints are set. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - nextPageToken: - type: string - description: >- - Page token used to retrieve the next page. This is currently not - used, but the server may at any point start supplying a valid token. - id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: + properties: {} type: object description: >- - The response returned from the ListCustomConstraints method. It will be - empty if no custom constraints are set on the organization resource. - GoogleTypeExpr: - properties: - location: - type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - description: - type: string - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - type: object - id: GoogleTypeExpr + A constraint that is either enforced or not. For example, a constraint + `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM + instance, serial port connections will not be opened to that instance. + id: GoogleCloudOrgpolicyV2ConstraintBooleanConstraint GoogleCloudOrgpolicyV2Policy: - type: object + id: GoogleCloudOrgpolicyV2Policy properties: dryRunSpec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' description: >- Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - alternate: - deprecated: true - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - description: Deprecated. - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Basic information about the Organization Policy. - etag: - type: string - description: >- - Optional. An opaque tag indicating the current state of the policy, - used for concurrency control. This 'etag' is computed by the server - based on the value of other fields, and may be sent on update and - delete requests to ensure the client has an up-to-date value before - proceeding. name: + type: string description: >- Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the @@ -185,52 +66,35 @@ components: Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + etag: type: string + description: >- + Optional. An opaque tag indicating the current state of the policy, + used for concurrency control. This 'etag' is computed by the server + based on the value of other fields, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + spec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: Basic information about the Organization Policy. + alternate: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' + description: Deprecated. + deprecated: true description: >- Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources. - id: GoogleCloudOrgpolicyV2Policy - GoogleCloudOrgpolicyV2ListPoliciesResponse: - description: >- - The response returned from the ListPolicies method. It will be empty if - no policies are set on the resource. - properties: - nextPageToken: - description: >- - Page token used to retrieve the next page. This is currently not - used, but the server may at any point start supplying a valid token. - type: string - policies: - description: >- - All policies that exist on the resource. It will be empty if no - policies are set. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - type: array - type: object - id: GoogleCloudOrgpolicyV2ListPoliciesResponse - GoogleProtobufEmpty: - type: object - properties: {} - id: GoogleProtobufEmpty - 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); } - GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: type: object - description: >- - A constraint that is either enforced or not. For example, a constraint - `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM - instance, serial port connections will not be opened to that instance. - id: GoogleCloudOrgpolicyV2ConstraintBooleanConstraint - properties: {} GoogleCloudOrgpolicyV2PolicySpec: - description: >- - Defines a Google Cloud policy specification which is used to specify - constraints for configurations of Google Cloud resources. properties: + reset: + type: boolean + description: >- + Ignores policies set above this resource and restores the + `constraint_default` enforcement behavior of the specific constraint + at this resource. This field can be set in policies for either list + or boolean constraints. If set, `rules` must be empty and + `inherit_from_parent` must be set to false. inheritFromParent: type: boolean description: >- @@ -241,15 +105,14 @@ components: this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints. updateTime: + type: string + readOnly: true + format: google-datetime description: >- Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. - type: string - format: google-datetime - readOnly: true etag: - type: string description: >- An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a @@ -258,16 +121,10 @@ components: version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the `etag` will be unset. - reset: - description: >- - Ignores policies set above this resource and restores the - `constraint_default` enforcement behavior of the specific constraint - at this resource. This field can be set in policies for either list - or boolean constraints. If set, `rules` must be empty and - `inherit_from_parent` must be set to false. - type: boolean + type: string rules: - type: array + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' description: >- In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition @@ -275,31 +132,80 @@ components: to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence. + type: array + id: GoogleCloudOrgpolicyV2PolicySpec + type: object + description: >- + Defines a Google Cloud policy specification which is used to specify + constraints for configurations of Google Cloud resources. + GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: + properties: + allowedValues: + description: List of values allowed at this resource. items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + type: string + type: array + deniedValues: + items: + type: string + type: array + description: List of values denied at this resource. type: object - id: GoogleCloudOrgpolicyV2PolicySpec - GoogleCloudOrgpolicyV2Constraint: description: >- - A constraint describes a way to restrict resource's configuration. For - example, you could enforce a constraint that controls which Google Cloud - services can be activated across an organization, or whether a Compute - Engine instance can have serial port connections established. - Constraints can be configured by the organization policy administrator - to fit the needs of the organization by setting a policy that includes - constraints at different locations in the organization's resource - hierarchy. Policies are inherited down the resource hierarchy from - higher levels, but can also be overridden. For details about the - inheritance rules please read about `policies`. Constraints have a - default behavior determined by the `constraint_default` field, which is - the enforcement behavior that is used in the absence of a policy being - defined or inherited for the resource in question. + A message that holds specific allowed and denied values. This message + can define specific values and subtrees of the Resource Manager resource + hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or + denied. This is achieved by using the `under:` and optional `is:` + prefixes. The `under:` prefix is used to denote resource subtree values. + The `is:` prefix is used to denote specific values, and is required only + if the value contains a ":". Values prefixed with "is:" are treated the + same as values with no prefix. Ancestry subtrees must be in one of the + following formats: - `projects/` (for example, + `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - + `organizations/` (for example, `organizations/1234`) The + `supports_under` field of the associated `Constraint` defines whether + ancestry prefixes can be used. + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + GoogleProtobufEmpty: + properties: {} type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: GoogleProtobufEmpty + GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: + description: >- + The response returned from the ListCustomConstraints method. It will be + empty if no custom constraints are set on the organization resource. + id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + type: object + properties: + customConstraints: + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + type: array + description: >- + All custom constraints that exist on the organization resource. It + will be empty if no custom constraints are set. + nextPageToken: + description: >- + Page token used to retrieve the next page. This is currently not + used, but the server may at any point start supplying a valid token. + type: string + GoogleCloudOrgpolicyV2Constraint: + id: GoogleCloudOrgpolicyV2Constraint properties: booleanConstraint: - description: Defines this constraint as being a BooleanConstraint. $ref: >- #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint + description: Defines this constraint as being a BooleanConstraint. + description: + description: >- + Detailed description of what this constraint controls as well as how + and where it is enforced. Mutable. + type: string constraintDefault: enumDescriptions: - >- @@ -311,28 +217,23 @@ components: - >- Indicate that all values are denied for list constraints. Indicate that enforcement is on for boolean constraints. + type: string + description: >- + The evaluation behavior of this constraint in the absence of a + policy. enum: - CONSTRAINT_DEFAULT_UNSPECIFIED - ALLOW - DENY + supportsDryRun: + type: boolean + description: Shows if dry run is supported for this constraint or not. + displayName: + description: The human readable name. Mutable. type: string - description: >- - The evaluation behavior of this constraint in the absence of a - policy. listConstraint: description: Defines this constraint as being a ListConstraint. $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' - displayName: - type: string - description: The human readable name. Mutable. - description: - type: string - description: >- - Detailed description of what this constraint controls as well as how - and where it is enforced. Mutable. - supportsDryRun: - description: Shows if dry run is supported for this constraint or not. - type: boolean name: description: >- Immutable. The resource name of the constraint. Must be in one of @@ -343,49 +244,84 @@ components: example, "/projects/123/constraints/compute.disableSerialPortAccess". type: string - id: GoogleCloudOrgpolicyV2Constraint - GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: type: object description: >- - A message that holds specific allowed and denied values. This message - can define specific values and subtrees of the Resource Manager resource - hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or - denied. This is achieved by using the `under:` and optional `is:` - prefixes. The `under:` prefix is used to denote resource subtree values. - The `is:` prefix is used to denote specific values, and is required only - if the value contains a ":". Values prefixed with "is:" are treated the - same as values with no prefix. Ancestry subtrees must be in one of the - following formats: - `projects/` (for example, - `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - - `organizations/` (for example, `organizations/1234`) The - `supports_under` field of the associated `Constraint` defines whether - ancestry prefixes can be used. - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + A constraint describes a way to restrict resource's configuration. For + example, you could enforce a constraint that controls which Google Cloud + services can be activated across an organization, or whether a Compute + Engine instance can have serial port connections established. + Constraints can be configured by the organization policy administrator + to fit the needs of the organization by setting a policy that includes + constraints at different locations in the organization's resource + hierarchy. Policies are inherited down the resource hierarchy from + higher levels, but can also be overridden. For details about the + inheritance rules please read about `policies`. Constraints have a + default behavior determined by the `constraint_default` field, which is + the enforcement behavior that is used in the absence of a policy being + defined or inherited for the resource in question. + GoogleCloudOrgpolicyV2ListPoliciesResponse: + type: object + properties: + policies: + description: >- + All policies that exist on the resource. It will be empty if no + policies are set. + type: array + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + nextPageToken: + description: >- + Page token used to retrieve the next page. This is currently not + used, but the server may at any point start supplying a valid token. + type: string + description: >- + The response returned from the ListPolicies method. It will be empty if + no policies are set on the resource. + id: GoogleCloudOrgpolicyV2ListPoliciesResponse + GoogleCloudOrgpolicyV2ConstraintListConstraint: + id: GoogleCloudOrgpolicyV2ConstraintListConstraint + description: >- + A constraint that allows or disallows a list of string values, which are + configured by an Organization Policy administrator with a policy. + properties: + supportsUnder: + type: boolean + description: >- + Indicates whether subtrees of the Resource Manager resource + hierarchy can be used in `Policy.allowed_values` and + `Policy.denied_values`. For example, `"under:folders/123"` would + match any resource under the 'folders/123' folder. + supportsIn: + type: boolean + description: >- + Indicates whether values grouped into categories can be used in + `Policy.allowed_values` and `Policy.denied_values`. For example, + `"in:Python"` would match any value in the 'Python' group. + type: object + GoogleCloudOrgpolicyV2AlternatePolicySpec: properties: - deniedValues: - items: - type: string - description: List of values denied at this resource. - type: array - allowedValues: - type: array - description: List of values allowed at this resource. - items: - type: string + spec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: Specify constraint for configurations of Google Cloud resources. + launch: + description: >- + Reference to the launch that will be used while audit logging and to + control the launch. Should be set only in the alternate policy. + type: string + type: object + id: GoogleCloudOrgpolicyV2AlternatePolicySpec + description: >- + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run/darklaunch. GoogleCloudOrgpolicyV2PolicySpecPolicyRule: - description: A rule used to express this policy. id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule properties: - denyAll: - type: boolean - description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. - allowAll: + values: description: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - type: boolean + List of values to be used for this policy rule. This field can be + set only in policies for list constraints. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues condition: description: >- A condition which determines whether this rule is used in the @@ -399,75 +335,142 @@ components: An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". $ref: '#/components/schemas/GoogleTypeExpr' + allowAll: + type: boolean + description: >- + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. enforce: + type: boolean description: >- If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. - type: boolean - values: + denyAll: description: >- - List of values to be used for this policy rule. This field can be - set only in policies for list constraints. - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + Setting this to true means that all values are denied. This field + can be set only in policies for list constraints. + type: boolean type: object - GoogleCloudOrgpolicyV2CustomConstraint: - description: >- - A custom constraint defined by customers which can *only* be applied to - the given resource types and organization. By creating a custom - constraint, customers can apply policies of this custom constraint. - *Creating a custom constraint itself does NOT apply any policy - enforcement*. + description: A rule used to express this policy. + GoogleTypeExpr: + id: GoogleTypeExpr properties: - name: + description: type: string description: >- - Immutable. Name of the constraint. This is unique within the - organization. Format of the name should be * - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The - max length is 70 characters and the minimum length is 1. Note that - the prefix `organizations/{organization_id}/customConstraints/` is - not counted. - updateTime: - readOnly: true - format: google-datetime + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + location: + type: string description: >- - Output only. The last time this custom constraint was updated. This - represents the last time that the `CreateCustomConstraint` or - `UpdateCustomConstraint` RPC was called + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. type: string - description: + title: + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + type: object + GoogleCloudOrgpolicyV2ListConstraintsResponse: + properties: + nextPageToken: + description: >- + Page token used to retrieve the next page. This is currently not + used. type: string + constraints: + type: array + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' + description: >- + The collection of constraints that are available on the targeted + resource. + id: GoogleCloudOrgpolicyV2ListConstraintsResponse + type: object + description: The response returned from the ListConstraints method. + GoogleCloudOrgpolicyV2CustomConstraint: + properties: + description: description: >- Detailed information about this custom policy constraint. The max length of the description is 2000 characters. - actionType: type: string + condition: + type: string + description: >- + Org policy condition/expression. For example: + `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, + `resource.management.auto_upgrade == true` The max length of the + condition is 1000 characters. + displayName: + type: string + description: >- + One line display name for the UI. The max length of the display_name + is 200 characters. + actionType: enumDescriptions: - Unspecified. Results in an error. - Allowed action type. - Deny action type. description: Allow or deny type. + type: string enum: - ACTION_TYPE_UNSPECIFIED - ALLOW - DENY + name: + description: >- + Immutable. Name of the constraint. This is unique within the + organization. Format of the name should be * + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The + max length is 70 characters and the minimum length is 1. Note that + the prefix `organizations/{organization_id}/customConstraints/` is + not counted. + type: string resourceTypes: - items: - type: string description: >- Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. + items: + type: string type: array + updateTime: + description: >- + Output only. The last time this custom constraint was updated. This + represents the last time that the `CreateCustomConstraint` or + `UpdateCustomConstraint` RPC was called + readOnly: true + type: string + format: google-datetime methodTypes: - description: All the operations being applied for this constraint. - type: array items: - type: string enum: - METHOD_TYPE_UNSPECIFIED - CREATE @@ -475,6 +478,7 @@ components: - DELETE - REMOVE_GRANT - GOVERN_TAGS + type: string enumDescriptions: - Unspecified. Results in an error. - Constraint applied when creating the resource. @@ -484,31 +488,43 @@ components: yet. - Constraint applied when removing an IAM grant. - Constraint applied when enforcing forced tagging. - condition: - description: >- - Org policy condition/expression. For example: - `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, - `resource.management.auto_upgrade == true` The max length of the - condition is 1000 characters. - type: string - displayName: - type: string - description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. - id: GoogleCloudOrgpolicyV2CustomConstraint + type: array + description: All the operations being applied for this constraint. type: object + id: GoogleCloudOrgpolicyV2CustomConstraint + description: >- + A custom constraint defined by customers which can *only* be applied to + the given resource types and organization. By creating a custom + constraint, customers can apply policies of this custom constraint. + *Creating a custom constraint itself does NOT apply any policy + enforcement*. parameters: - access_token: - description: OAuth access token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: access_token + name: prettyPrint + schema: + type: boolean + alt: + description: Data format for response. + in: query + name: alt schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + enum: + - json + - media + - proto + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: fields + name: upload_protocol + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string key: @@ -520,49 +536,33 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: $.xgafv + name: fields schema: type: string - enum: - - '1' - - '2' callback: description: JSONP in: query name: callback schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + type: string + _.xgafv: + description: V1 error format. in: query - name: upload_protocol + name: $.xgafv schema: type: string + enum: + - '1' + - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -579,80 +579,36 @@ components: schema: type: string x-stackQL-resources: - constraints: - id: google.orgpolicy.constraints - name: constraints - title: Constraints - methods: - folders_constraints_list: - operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - projects_constraints_list: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - organizations_constraints_list: - operation: - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/folders_constraints_list - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/projects_constraints_list - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/organizations_constraints_list - insert: [] - update: [] - replace: [] - delete: [] policies: id: google.orgpolicy.policies name: policies title: Policies methods: - folders_policies_delete: - operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - folders_policies_get: + projects_policies_delete: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete response: mediaType: application/json openAPIDocKey: '200' - folders_policies_patch: + projects_policies_get: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_create: + projects_policies_patch: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_list: + projects_policies_create: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.policies projects_policies_list: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' @@ -660,28 +616,30 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - projects_policies_create: + organizations_policies_delete: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_policies_delete: + organizations_policies_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_policies_get: + organizations_policies_patch: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_policies_patch: + organizations_policies_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' @@ -692,103 +650,145 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - organizations_policies_create: + folders_policies_patch: operation: - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/post' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_delete: + folders_policies_delete: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/delete + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_get: + folders_policies_get: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/get + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_patch: + folders_policies_list: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/patch + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + folders_policies_create: + operation: + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_get - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_get - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_get - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_list + #/components/x-stackQL-resources/policies/methods/folders_policies_get - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_list - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_list - insert: - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_create + #/components/x-stackQL-resources/policies/methods/folders_policies_list + insert: - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_create - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_create - update: - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_patch + #/components/x-stackQL-resources/policies/methods/folders_policies_create + update: - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_patch - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_patch + - $ref: >- + #/components/x-stackQL-resources/policies/methods/folders_policies_patch replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_delete - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_delete - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_delete + - $ref: >- + #/components/x-stackQL-resources/policies/methods/folders_policies_delete policies_effective_policy: id: google.orgpolicy.policies_effective_policy name: policies_effective_policy title: Policies_effective_policy methods: - folders_policies_get_effective_policy: + projects_policies_get_effective_policy: operation: $ref: >- - #/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}:getEffectivePolicy/get + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' - projects_policies_get_effective_policy: + organizations_policies_get_effective_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}:getEffectivePolicy/get + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_get_effective_policy: + folders_policies_get_effective_policy: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}:getEffectivePolicy/get + #/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy - $ref: >- #/components/x-stackQL-resources/policies_effective_policy/methods/projects_policies_get_effective_policy - $ref: >- #/components/x-stackQL-resources/policies_effective_policy/methods/organizations_policies_get_effective_policy + - $ref: >- + #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy + insert: [] + update: [] + replace: [] + delete: [] + constraints: + id: google.orgpolicy.constraints + name: constraints + title: Constraints + methods: + projects_constraints_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + organizations_constraints_list: + operation: + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + folders_constraints_list: + operation: + $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/constraints/methods/projects_constraints_list + - $ref: >- + #/components/x-stackQL-resources/constraints/methods/organizations_constraints_list + - $ref: >- + #/components/x-stackQL-resources/constraints/methods/folders_constraints_list insert: [] update: [] replace: [] @@ -798,10 +798,10 @@ components: name: custom_constraints title: Custom_constraints methods: - organizations_custom_constraints_get: + organizations_custom_constraints_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -812,10 +812,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_custom_constraints_patch: + organizations_custom_constraints_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -835,74 +835,41 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_get - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_list - insert: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_create - update: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_delete -paths: - /v2/folders/{foldersId}/constraints: - parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.folders.constraints.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/folders/{foldersId}/policies/{policiesId}: - parameters: *ref_1 + select: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_get + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_list + insert: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_create + update: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_delete +paths: + /v2/projects/{projectsId}/policies/{policiesId}: + parameters: &ref_1 + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/oauth_token' delete: description: >- Deletes a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or organization policy does not exist. - operationId: orgpolicy.folders.policies.delete + operationId: orgpolicy.projects.policies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -917,7 +884,7 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -935,7 +902,7 @@ paths: Gets a policy on a resource. If no policy is set on the resource, `NOT_FOUND` is returned. The `etag` value can be used with `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.folders.policies.get + operationId: orgpolicy.projects.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -950,7 +917,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -967,7 +934,7 @@ paths: the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields. - operationId: orgpolicy.folders.policies.patch + operationId: orgpolicy.projects.policies.patch requestBody: content: application/json: @@ -987,7 +954,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -1001,7 +968,7 @@ paths: schema: type: string format: google-fieldmask - /v2/folders/{foldersId}/policies: + /v2/projects/{projectsId}/policies: parameters: *ref_1 post: description: >- @@ -1009,7 +976,7 @@ paths: `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy already exists on the given Google Cloud resource. - operationId: orgpolicy.folders.policies.create + operationId: orgpolicy.projects.policies.create requestBody: content: application/json: @@ -1029,13 +996,13 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string get: description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.folders.policies.list + operationId: orgpolicy.projects.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1051,20 +1018,20 @@ paths: #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: parameters: *ref_1 get: description: >- @@ -1073,7 +1040,7 @@ paths: returned policy will not have an `etag` or `condition` set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.folders.policies.getEffectivePolicy + operationId: orgpolicy.projects.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1088,7 +1055,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -1130,16 +1097,19 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: + /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: parameters: *ref_1 - get: + patch: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.projects.policies.getEffectivePolicy + Updates a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the + supplied policy will perform a full overwrite of all fields. + operationId: orgpolicy.organizations.customConstraints.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1151,23 +1121,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string - /v2/projects/{projectsId}/policies: - parameters: *ref_1 - get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.projects.policies.list + delete: + description: >- + Deletes a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. + operationId: orgpolicy.organizations.customConstraints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1179,35 +1149,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: customConstraintsId + required: true schema: type: string - post: + get: description: >- - Creates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy - already exists on the given Google Cloud resource. - operationId: orgpolicy.projects.policies.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + Gets a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist. + operationId: orgpolicy.organizations.customConstraints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1219,21 +1177,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - /v2/projects/{projectsId}/policies/{policiesId}: + - in: path + name: customConstraintsId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/customConstraints: parameters: *ref_1 - delete: + get: description: >- - Deletes a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or organization policy - does not exist. - operationId: orgpolicy.projects.policies.delete + Retrieves all of the custom constraints that exist on a particular + organization resource. + operationId: orgpolicy.organizations.customConstraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1245,28 +1207,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: path - name: policiesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: etag + name: pageSize schema: - type: string - get: + type: integer + format: int32 + post: description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.projects.policies.get + Creates a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns + a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the + constraint already exists on the given organization. + operationId: orgpolicy.organizations.customConstraints.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1278,32 +1247,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: policiesId + name: organizationsId required: true schema: type: string - patch: - description: >- - Updates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not - exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if - the etag supplied in the request does not match the persisted etag of - the policy Note: the supplied policy will perform a full overwrite of - all fields. - operationId: orgpolicy.projects.policies.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + /v2/organizations/{organizationsId}/constraints: + parameters: *ref_1 + get: + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.organizations.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1315,30 +1270,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: path - name: policiesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask - /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: + type: integer + format: int32 + /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: parameters: *ref_1 get: description: >- - Gets a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist. - operationId: orgpolicy.organizations.customConstraints.get + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.organizations.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1350,7 +1308,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: organizationsId @@ -1358,15 +1316,18 @@ paths: schema: type: string - in: path - name: customConstraintsId + name: policiesId required: true schema: type: string + /v2/organizations/{organizationsId}/policies/{policiesId}: + parameters: *ref_1 delete: description: >- - Deletes a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. - operationId: orgpolicy.organizations.customConstraints.delete + Deletes a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or organization policy + does not exist. + operationId: orgpolicy.organizations.policies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1386,21 +1347,20 @@ paths: schema: type: string - in: path - name: customConstraintsId + name: policiesId required: true schema: type: string - patch: + - in: query + name: etag + schema: + type: string + get: description: >- - Updates a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the - supplied policy will perform a full overwrite of all fields. - operationId: orgpolicy.organizations.customConstraints.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.organizations.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1412,7 +1372,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: organizationsId @@ -1420,17 +1380,24 @@ paths: schema: type: string - in: path - name: customConstraintsId + name: policiesId required: true schema: type: string - /v2/organizations/{organizationsId}/customConstraints: - parameters: *ref_1 - get: + patch: description: >- - Retrieves all of the custom constraints that exist on a particular - organization resource. - operationId: orgpolicy.organizations.customConstraints.list + Updates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not + exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if + the etag supplied in the request does not match the persisted etag of + the policy Note: the supplied policy will perform a full overwrite of + all fields. + operationId: orgpolicy.organizations.policies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1442,35 +1409,37 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: policiesId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: updateMask schema: type: string + format: google-fieldmask + /v2/organizations/{organizationsId}/policies: + parameters: *ref_1 post: description: >- - Creates a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns - a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the - constraint already exists on the given organization. - operationId: orgpolicy.organizations.customConstraints.create + Creates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy + already exists on the given Google Cloud resource. + operationId: orgpolicy.organizations.policies.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1482,18 +1451,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: organizationsId required: true schema: type: string - /v2/organizations/{organizationsId}/constraints: - parameters: *ref_1 get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.organizations.constraints.list + description: Retrieves all of the policies that exist on a particular resource. + operationId: orgpolicy.organizations.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1506,7 +1473,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path name: organizationsId @@ -1522,11 +1489,22 @@ paths: schema: type: integer format: int32 - /v2/organizations/{organizationsId}/policies: + /v2/folders/{foldersId}/policies/{policiesId}: parameters: *ref_1 - get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.organizations.policies.list + patch: + description: >- + Updates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not + exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if + the etag supplied in the request does not match the persisted etag of + the policy Note: the supplied policy will perform a full overwrite of + all fields. + operationId: orgpolicy.folders.policies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1538,35 +1516,29 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: policiesId + required: true schema: type: string - in: query - name: pageSize + name: updateMask schema: - type: integer - format: int32 - post: + type: string + format: google-fieldmask + delete: description: >- - Creates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy - already exists on the given Google Cloud resource. - operationId: orgpolicy.organizations.policies.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + Deletes a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or organization policy + does not exist. + operationId: orgpolicy.folders.policies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1578,23 +1550,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_1 + - in: path + name: policiesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string get: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.organizations.policies.getEffectivePolicy + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.folders.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1609,7 +1586,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1618,14 +1595,11 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/policies/{policiesId}: + /v2/folders/{foldersId}/policies: parameters: *ref_1 - delete: - description: >- - Deletes a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or organization policy - does not exist. - operationId: orgpolicy.organizations.policies.delete + get: + description: Retrieves all of the policies that exist on a particular resource. + operationId: orgpolicy.folders.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1637,28 +1611,63 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - - in: path - name: policiesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: etag + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Creates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy + already exists on the given Google Cloud resource. + operationId: orgpolicy.folders.policies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + parameters: + - in: path + name: foldersId + required: true schema: type: string + /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: + parameters: *ref_1 get: description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.organizations.policies.get + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.folders.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1673,7 +1682,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1682,20 +1691,11 @@ paths: required: true schema: type: string - patch: - description: >- - Updates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not - exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if - the etag supplied in the request does not match the persisted etag of - the policy Note: the supplied policy will perform a full overwrite of - all fields. - operationId: orgpolicy.organizations.policies.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + /v2/folders/{foldersId}/constraints: + parameters: *ref_1 + get: + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.folders.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1707,20 +1707,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - - in: path - name: policiesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/places.yaml b/providers/src/googleapis.com/v00.00.00000/services/places.yaml index 3a07c903..1408e1c3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/places.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/places.yaml @@ -28,18 +28,18 @@ components: https://www.googleapis.com/auth/maps-platform.places.nearbysearch: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.nearbysearch - https://www.googleapis.com/auth/cloud-platform: >- - See, edit, configure, and delete your Google Cloud data and see - the email address for your Google Account. https://www.googleapis.com/auth/maps-platform.places: >- Private Service: https://www.googleapis.com/auth/maps-platform.places - https://www.googleapis.com/auth/maps-platform.places.textsearch: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.places.textsearch https://www.googleapis.com/auth/maps-platform.places.details: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.details + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. + https://www.googleapis.com/auth/maps-platform.places.textsearch: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places.textsearch Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -49,708 +49,570 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: - description: The range of highlighted text. - id: >- - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange - properties: - endIndex: - type: integer - format: int32 - startIndex: - format: int32 - type: integer + GoogleMapsPlacesV1Review: + id: GoogleMapsPlacesV1Review type: object - GoogleMapsPlacesV1PlaceAreaSummary: properties: - contentBlocks: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' - type: array + name: description: >- - Content blocks that compose the area summary. Each block has a - separate topic about the area. - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the area that the place is in. - id: GoogleMapsPlacesV1PlaceAreaSummary - type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: - description: An Autocomplete suggestion result. - properties: - queryPrediction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction - description: A prediction for a query. - placePrediction: - description: A prediction for a Place. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction - type: object - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion - GoogleMapsPlacesV1SearchTextRequestEVOptions: - description: Searchable EV options of a place search request. - type: object - id: GoogleMapsPlacesV1SearchTextRequestEVOptions - properties: - minimumChargingRateKw: + A reference representing this place review which may be used to look + up this place review again (also called the API "resource" name: + `places/{place_id}/reviews/{review}`). + type: string + originalText: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The review text in its original language. + publishTime: + type: string + description: Timestamp for the review. + format: google-datetime + text: + description: The localized text of the review. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + authorAttribution: + description: This review's author. + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + relativePublishTimeDescription: + type: string description: >- - Optional. Minimum required charging rate in kilowatts. A place with - a charging rate less than the specified rate is filtered out. - type: number + A string of formatted recent time, expressing the review time + relative to the current time in a form appropriate for the language + and country. + rating: + description: A number between 1.0 and 5.0, also called the number of stars. format: double - connectorTypes: - type: array - description: >- - Optional. The list of preferred EV connector types. A place that - does not support any of the listed connector types is filtered out. - items: - enum: - - EV_CONNECTOR_TYPE_UNSPECIFIED - - EV_CONNECTOR_TYPE_OTHER - - EV_CONNECTOR_TYPE_J1772 - - EV_CONNECTOR_TYPE_TYPE_2 - - EV_CONNECTOR_TYPE_CHADEMO - - EV_CONNECTOR_TYPE_CCS_COMBO_1 - - EV_CONNECTOR_TYPE_CCS_COMBO_2 - - EV_CONNECTOR_TYPE_TESLA - - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET - enumDescriptions: - - Unspecified connector. - - Other connector types. - - J1772 type 1 connector. - - IEC 62196 type 2 connector. Often referred to as MENNEKES. - - CHAdeMO type connector. - - >- - Combined Charging System (AC and DC). Based on SAE. Type-1 - J-1772 connector - - >- - Combined Charging System (AC and DC). Based on Type-2 Mennekes - connector - - >- - The generic TESLA connector. This is NACS in the North America - but can be non-NACS in other parts of the world (e.g. CCS Combo - 2 (CCS2) or GB/T). This value is less representative of an - actual connector type, and more represents the ability to charge - a Tesla brand vehicle at a Tesla owned charging station. - - >- - GB/T type corresponds to the GB/T standard in China. This type - covers all GB_T types. - - Unspecified wall outlet. - type: string - GoogleMapsPlacesV1RouteModifiers: + type: number + description: Information about a review of a place. + GoogleMapsPlacesV1FuelOptionsFuelPrice: + description: Fuel price information for a given type. properties: - avoidHighways: - description: >- - Optional. When set to true, avoids highways where reasonable, giving - preference to routes not containing highways. Applies only to the - `DRIVE` and `TWO_WHEELER` `TravelMode`. - type: boolean - avoidIndoor: - type: boolean - description: >- - Optional. When set to true, avoids navigating indoors where - reasonable, giving preference to routes not containing indoor - navigation. Applies only to the `WALK` `TravelMode`. - avoidFerries: - type: boolean - description: >- - Optional. When set to true, avoids ferries where reasonable, giving - preference to routes not containing ferries. Applies only to the - `DRIVE` and `TWO_WHEELER` `TravelMode`. - avoidTolls: - type: boolean - description: >- - Optional. When set to true, avoids toll roads where reasonable, - giving preference to routes not containing toll roads. Applies only - to the `DRIVE` and `TWO_WHEELER` `TravelMode`. - description: >- - Encapsulates a set of optional conditions to satisfy when calculating - the routes. + price: + description: The price of the fuel. + $ref: '#/components/schemas/GoogleTypeMoney' + updateTime: + type: string + description: The time the fuel price was last updated. + format: google-datetime + type: + description: The type of fuel. + enum: + - FUEL_TYPE_UNSPECIFIED + - DIESEL + - REGULAR_UNLEADED + - MIDGRADE + - PREMIUM + - SP91 + - SP91_E10 + - SP92 + - SP95 + - SP95_E10 + - SP98 + - SP99 + - SP100 + - LPG + - E80 + - E85 + - METHANE + - BIO_DIESEL + - TRUCK_DIESEL + enumDescriptions: + - Unspecified fuel type. + - Diesel fuel. + - Regular unleaded. + - Midgrade. + - Premium. + - SP 91. + - SP 91 E10. + - SP 92. + - SP 95. + - SP95 E10. + - SP 98. + - SP 99. + - SP 100. + - LPG. + - E 80. + - E 85. + - Methane. + - Bio-diesel. + - Truck diesel. + type: string + id: GoogleMapsPlacesV1FuelOptionsFuelPrice type: object - id: GoogleMapsPlacesV1RouteModifiers - GoogleMapsPlacesV1SearchTextResponse: + GoogleMapsPlacesV1SearchNearbyRequest: type: object properties: - nextPageToken: - type: string - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted or empty, there are no subsequent pages. - places: + excludedTypes: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - description: A list of places that meet the user's text search criteria. - type: array - contextualContents: + type: string description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. A list of contextual contents where each entry - associates to the corresponding place in the same index in the - places field. The contents that are relevant to the `text_query` in - the request are preferred. If the contextual content is not - available for one of the places, it will return non-contextual - content. It will be empty only when the content is unavailable for - this place. This list will have as many entries as the list of - places if requested. + Excluded Place type (eg, "restaurant" or "gas_station") from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If the client provides both included_types (e.g. + restaurant) and excluded_types (e.g. cafe), then the response should + include places that are restaurant but not cafe. The response + includes places that match at least one of the included_types and + none of the excluded_types. If there are any conflicting types, i.e. + a type appears in both included_types and excluded_types, an + INVALID_ARGUMENT error is returned. If a Place type is specified + with multiple type restrictions, only places that satisfy all of the + restrictions are returned. For example, if we have {included_types = + ["restaurant"], excluded_primary_types = ["restaurant"]}, the + returned places provide "restaurant" related services but do not + operate primarily as "restaurants". type: array + includedPrimaryTypes: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' - routingSummaries: - type: array + type: string description: >- - A list of routing summaries where each entry associates to the - corresponding place in the same index in the `places` field. If the - routing summary is not available for one of the places, it will - contain an empty entry. This list will have as many entries as the - list of places if requested. + Included primary Place type (e.g. "restaurant" or "gas_station") + from + https://developers.google.com/maps/documentation/places/web-service/place-types. + A place can only have a single primary type from the supported types + table associated with it. Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting primary types, i.e. a + type appears in both included_primary_types and + excluded_primary_types, an INVALID_ARGUMENT error is returned. If a + Place type is specified with multiple type restrictions, only places + that satisfy all of the restrictions are returned. For example, if + we have {included_types = ["restaurant"], excluded_primary_types = + ["restaurant"]}, the returned places provide "restaurant" related + services but do not operate primarily as "restaurants". + type: array + locationRestriction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + description: Required. The region to search. + excludedPrimaryTypes: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' - id: GoogleMapsPlacesV1SearchTextResponse - description: 'Response proto for SearchText. ' - GoogleMapsPlacesV1Polyline: - type: object - description: >- - A route polyline. Only supports an [encoded - polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), - which can be passed as a string and includes compression with minimal - lossiness. This is the Routes API default output. - properties: - encodedPolyline: - type: string + type: string + type: array description: >- - An [encoded - polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), - as returned by the [Routes API by - default](https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes#polylineencoding). - See the - [encoder](https://developers.google.com/maps/documentation/utilities/polylineutility) - and - [decoder](https://developers.google.com/maps/documentation/routes/polylinedecoder) - tools. - id: GoogleMapsPlacesV1Polyline - GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters: - description: >- - Specifies a precalculated polyline from the [Routes - API](https://developers.google.com/maps/documentation/routes) defining - the route to search. Searching along a route is similar to using the - `locationBias` or `locationRestriction` request option to bias the - search results. However, while the `locationBias` and - `locationRestriction` options let you specify a region to bias the - search results, this option lets you bias the results along a trip - route. Results are not guaranteed to be along the route provided, but - rather are ranked within the search area defined by the polyline and, - optionally, by the `locationBias` or `locationRestriction` based on - minimal detour times from origin to destination. The results might be - along an alternate route, especially if the provided polyline does not - define an optimal route from origin to destination. - properties: - polyline: - $ref: '#/components/schemas/GoogleMapsPlacesV1Polyline' - description: Required. The route polyline. - type: object - id: GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters - GoogleTypeDate: - id: GoogleTypeDate - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - properties: - year: + Excluded primary Place type (e.g. "restaurant" or "gas_station") + from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting primary types, i.e. a + type appears in both included_primary_types and + excluded_primary_types, an INVALID_ARGUMENT error is returned. If a + Place type is specified with multiple type restrictions, only places + that satisfy all of the restrictions are returned. For example, if + we have {included_types = ["restaurant"], excluded_primary_types = + ["restaurant"]}, the returned places provide "restaurant" related + services but do not operate primarily as "restaurants". + includedTypes: + items: + type: string + type: array description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 - month: + Included Place type (eg, "restaurant" or "gas_station") from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting types, i.e. a type + appears in both included_types and excluded_types, an + INVALID_ARGUMENT error is returned. If a Place type is specified + with multiple type restrictions, only places that satisfy all of the + restrictions are returned. For example, if we have {included_types = + ["restaurant"], excluded_primary_types = ["restaurant"]}, the + returned places provide "restaurant" related services but do not + operate primarily as "restaurants". + routingParameters: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' + description: Optional. Parameters that affect the routing to the search results. + maxResultCount: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - format: int32 - day: + Maximum number of results to return. It must be between 1 and 20 + (default), inclusively. If the number is unset, it falls back to the + upper limit. If the number is set to negative or exceeds the upper + limit, an INVALID_ARGUMENT error is returned. format: int32 type: integer + rankPreference: + enum: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - POPULARITY + enumDescriptions: + - >- + RankPreference value not set. Will use rank by POPULARITY by + default. + - Ranks results by distance. + - Ranks results by popularity. + description: How results will be ranked in the response. + type: string + regionCode: + type: string description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: object - GoogleMapsPlacesV1PlaceOpeningHours: - id: GoogleMapsPlacesV1PlaceOpeningHours - type: object + The Unicode country/region code (CLDR) of the location where the + request is coming from. This parameter is used to display the place + details, like region-specific place name, if available. The + parameter can affect results based on applicable law. For more + information, see + https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. + Note that 3-digit region codes are not currently supported. + languageCode: + description: >- + Place details will be displayed with the preferred language if + available. If the language code is unspecified or unrecognized, + place details of any language may be returned, with a preference for + English if such details exist. Current list of supported languages: + https://developers.google.com/maps/faq#languagesupport. + type: string + id: GoogleMapsPlacesV1SearchNearbyRequest + description: 'Request proto for Search Nearby. ' + GoogleMapsPlacesV1EVChargeOptions: properties: - periods: - type: array + connectorCount: + type: integer description: >- - The periods that this place is open during the week. The periods are - in chronological order, starting with Sunday in the place-local - timezone. An empty (but not absent) value indicates a place that is - never open, e.g. because it is closed temporarily for renovations. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' - specialDays: - type: array + Number of connectors at this station. However, because some ports + can have multiple connectors but only be able to charge one car at a + time (e.g.) the number of connectors may be greater than the total + number of cars which can charge simultaneously. + format: int32 + connectorAggregation: description: >- - Structured information for special days that fall within the period - that the returned opening hours cover. Special days are days that - could impact the business hours of a place, e.g. Christmas day. Set - for current_opening_hours and current_secondary_opening_hours if - there are exceptional hours. + A list of EV charging connector aggregations that contain connectors + of the same type and same charge rate. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' - secondaryHoursType: - enumDescriptions: - - Default value when secondary hour type is not specified. - - The drive-through hour for banks, restaurants, or pharmacies. - - The happy hour. - - The delivery hour. - - The takeout hour. - - The kitchen hour. - - The breakfast hour. - - The lunch hour. - - The dinner hour. - - The brunch hour. - - The pickup hour. - - The access hours for storage places. - - The special hours for seniors. - - The online service hours. - type: string - description: A type string used to identify the type of secondary hours. - enum: - - SECONDARY_HOURS_TYPE_UNSPECIFIED - - DRIVE_THROUGH - - HAPPY_HOUR - - DELIVERY - - TAKEOUT - - KITCHEN - - BREAKFAST - - LUNCH - - DINNER - - BRUNCH - - PICKUP - - ACCESS - - SENIOR_HOURS - - ONLINE_SERVICE_HOURS - weekdayDescriptions: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation type: array - description: >- - Localized strings describing the opening hours of this place, one - string for each day of the week. Will be empty if the hours are - unknown or could not be converted to localized text. Example: "Sun: - 18:00–06:00" - items: - type: string - openNow: - type: boolean - description: >- - Whether the opening hours period is currently active. For regular - opening hours and current opening hours, this field means whether - the place is open. For secondary opening hours and current secondary - opening hours, this field means whether the secondary hours of this - place is active. - description: Information about business hour of the place. - GoogleMapsPlacesV1PlaceOpeningHoursPeriod: - properties: - open: - description: The time that the place starts to be open. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - close: - description: The time that the place starts to be closed. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - description: A period the place remains in open_now status. - type: object - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: type: object + description: >- + Information about the EV Charge Station hosted in Place. Terminology + follows https://afdc.energy.gov/fuels/electricity_infrastructure.html + One port could charge one car at a time. One port has one or more + connectors. One station has one or more ports. + id: GoogleMapsPlacesV1EVChargeOptions + GoogleTypeLocalizedText: + id: GoogleTypeLocalizedText properties: - distanceMeters: - format: int32 - type: integer + languageCode: + type: string description: >- - The length of the geodesic in meters from `origin` if `origin` is - specified. Certain predictions such as routes may not populate this - field. + The text's BCP-47 language code, such as "en-US" or "sr-Latn". For + more information, see + http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. text: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - description: >- - Contains the human-readable name for the returned result. For - establishment results, this is usually the business name and - address. `text` is recommended for developers who wish to show a - single UI element. Developers who wish to show two separate, but - related, UI elements may want to use `structured_format` instead. - They are two different ways to represent a Place prediction. Users - should not try to parse `structured_format` into `text` or vice - versa. This text may be different from the `display_name` returned - by GetPlace. May be in mixed languages if the request `input` and - `language_code` are in different languages or if the Place does not - have a translation from the local language to `language_code`. - types: description: >- - List of types that apply to this Place from Table A or Table B in - https://developers.google.com/maps/documentation/places/web-service/place-types. - A type is a categorization of a Place. Places with shared types will - share similar characteristics. - type: array - items: - type: string - placeId: - description: >- - The unique identifier of the suggested Place. This identifier can be - used in other APIs that accept Place IDs. - type: string - place: + Localized string in the language corresponding to language_code + below. type: string - description: >- - The resource name of the suggested Place. This name can be used in - other APIs that accept Place names. + type: object + description: Localized variant of a text in a particular language. + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: + properties: structuredFormat: $ref: >- #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat description: >- - A breakdown of the Place prediction into main text containing the - name of the Place and secondary text containing additional - disambiguating features (such as a city or region). - `structured_format` is recommended for developers who wish to show - two separate, but related, UI elements. Developers who wish to show - a single UI element may want to use `text` instead. They are two - different ways to represent a Place prediction. Users should not try - to parse `structured_format` into `text` or vice versa. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction - description: Prediction results for a Place Autocomplete prediction. - GoogleMapsPlacesV1Circle: - id: GoogleMapsPlacesV1Circle - type: object - description: Circle with a LatLng as center and radius. - properties: - radius: - type: number - description: >- - Required. Radius measured in meters. The radius must be within [0.0, - 50000.0]. - format: double - center: - description: >- - Required. Center latitude and longitude. The range of latitude must - be within [-90.0, 90.0]. The range of the longitude must be within - [-180.0, 180.0]. - $ref: '#/components/schemas/GoogleTypeLatLng' - GoogleMapsPlacesV1FuelOptions: - properties: - fuelPrices: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' + A breakdown of the query prediction into main text containing the + query and secondary text containing additional disambiguating + features (such as a city or region). `structured_format` is + recommended for developers who wish to show two separate, but + related, UI elements. Developers who wish to show a single UI + element may want to use `text` instead. They are two different ways + to represent a query prediction. Users should not try to parse + `structured_format` into `text` or vice versa. + text: description: >- - The last known fuel price for each type of fuel this station has. - There is one entry per fuel type this station has. Order is not - important. - description: >- - The most recent information about fuel options in a gas station. This - information is updated regularly. - id: GoogleMapsPlacesV1FuelOptions + The predicted text. This text does not represent a Place, but rather + a text query that could be used in a search endpoint (for example, + Text Search). `text` is recommended for developers who wish to show + a single UI element. Developers who wish to show two separate, but + related, UI elements may want to use `structured_format` instead. + They are two different ways to represent a query prediction. Users + should not try to parse `structured_format` into `text` or vice + versa. May be in mixed languages if the request `input` and + `language_code` are in different languages or if part of the query + does not have a translation from the local language to + `language_code`. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: Prediction results for a Query Autocomplete prediction. type: object - GoogleMapsPlacesV1Photo: - id: GoogleMapsPlacesV1Photo - description: Information about a photo of a place. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + GoogleMapsPlacesV1RoutingSummaryLeg: type: object + id: GoogleMapsPlacesV1RoutingSummaryLeg + description: A leg is a single portion of a journey from one location to another. properties: - heightPx: + duration: + description: The time it takes to complete this leg of the trip. + format: google-duration + type: string + distanceMeters: + description: The distance of this leg of the trip. format: int32 type: integer - description: The maximum available height, in pixels. - authorAttributions: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - description: This photo's authors. - widthPx: - type: integer - description: The maximum available width, in pixels. - format: int32 - name: - type: string - description: >- - Identifier. A reference representing this place photo which may be - used to look up this place photo again (also called the API - "resource" name: `places/{place_id}/photos/{photo}`). - GoogleMapsPlacesV1ContextualContentJustification: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Justifications for the place. Justifications answers - the question of why a place could interest an end user. - id: GoogleMapsPlacesV1ContextualContentJustification + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: type: object properties: - businessAvailabilityAttributesJustification: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. + secondaryText: $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification - reviewJustification: + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. + Represents additional disambiguating features (such as a city or + region) to further identify the Place or refine the query. + mainText: $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification - GoogleMapsPlacesV1FuelOptionsFuelPrice: - id: GoogleMapsPlacesV1FuelOptionsFuelPrice - description: Fuel price information for a given type. - type: object - properties: - updateTime: - format: google-datetime - type: string - description: The time the fuel price was last updated. - price: - $ref: '#/components/schemas/GoogleTypeMoney' - description: The price of the fuel. - type: - enumDescriptions: - - Unspecified fuel type. - - Diesel fuel. - - Regular unleaded. - - Midgrade. - - Premium. - - SP 91. - - SP 91 E10. - - SP 92. - - SP 95. - - SP95 E10. - - SP 98. - - SP 99. - - SP 100. - - LPG. - - E 80. - - E 85. - - Methane. - - Bio-diesel. - - Truck diesel. - description: The type of fuel. - enum: - - FUEL_TYPE_UNSPECIFIED - - DIESEL - - REGULAR_UNLEADED - - MIDGRADE - - PREMIUM - - SP91 - - SP91_E10 - - SP92 - - SP95 - - SP95_E10 - - SP98 - - SP99 - - SP100 - - LPG - - E80 - - E85 - - METHANE - - BIO_DIESEL - - TRUCK_DIESEL + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: Represents the name of the Place or query. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + description: >- + Contains a breakdown of a Place or query prediction into main text and + secondary text. For Place predictions, the main text contains the + specific name of the Place. For query predictions, the main text + contains the query. The secondary text contains additional + disambiguating features (such as a city or region) to further identify + the Place or refine the query. + GoogleMapsPlacesV1PlaceSubDestination: + properties: + id: type: string - GoogleMapsPlacesV1PlaceAttribution: + description: The place id of the sub destination. + name: + type: string + description: The resource name of the sub destination. + description: >- + Place resource name and id of sub destinations that relate to the place. + For example, different terminals are different destinations of an + airport. + id: GoogleMapsPlacesV1PlaceSubDestination type: object + GoogleMapsPlacesV1AuthorAttribution: properties: - provider: + photoUri: type: string - description: Name of the Place's data provider. - providerUri: + description: Profile photo URI of the author of the Photo or Review. + uri: type: string - description: URI to the Place's data provider. - description: Information about data providers of this place. - id: GoogleMapsPlacesV1PlaceAttribution - GoogleMapsPlacesV1SearchTextRequest: + description: URI of the author of the Photo or Review. + displayName: + description: Name of the author of the Photo or Review. + type: string + description: Information about the author of the UGC data. Used in Photo, and Review. + type: object + id: GoogleMapsPlacesV1AuthorAttribution + GoogleMapsPlacesV1SearchTextResponse: + id: GoogleMapsPlacesV1SearchTextResponse type: object - id: GoogleMapsPlacesV1SearchTextRequest - description: 'Request proto for SearchText. ' properties: - regionCode: + contextualContents: description: >- - The Unicode country/region code (CLDR) of the location where the - request is coming from. This parameter is used to display the place - details, like region-specific place name, if available. The - parameter can affect results based on applicable law. For more - information, see - https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. - Note that 3-digit region codes are not currently supported. - type: string - routingParameters: - $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' - description: Optional. Additional parameters for routing to results. - openNow: - type: boolean + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. A list of contextual contents where each entry + associates to the corresponding place in the same index in the + places field. The contents that are relevant to the `text_query` in + the request are preferred. If the contextual content is not + available for one of the places, it will return non-contextual + content. It will be empty only when the content is unavailable for + this place. This list will have as many entries as the list of + places if requested. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' + type: array + places: + type: array + description: A list of places that meet the user's text search criteria. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + routingSummaries: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' description: >- - Used to restrict the search to places that are currently open. The - default is false. - strictTypeFiltering: - type: boolean + A list of routing summaries where each entry associates to the + corresponding place in the same index in the `places` field. If the + routing summary is not available for one of the places, it will + contain an empty entry. This list will have as many entries as the + list of places if requested. + type: array + nextPageToken: + type: string description: >- - Used to set strict type filtering for included_type. If set to true, - only results of the same type will be returned. Default to false. - locationBias: + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted or empty, there are no subsequent pages. + description: 'Response proto for SearchText. ' + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: + properties: + queryPrediction: + description: A prediction for a query. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + placePrediction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + description: A prediction for a Place. + description: An Autocomplete suggestion result. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + type: object + GoogleMapsPlacesV1SearchTextRequestEVOptions: + properties: + connectorTypes: + items: + type: string + enumDescriptions: + - Unspecified connector. + - Other connector types. + - J1772 type 1 connector. + - IEC 62196 type 2 connector. Often referred to as MENNEKES. + - CHAdeMO type connector. + - >- + Combined Charging System (AC and DC). Based on SAE. Type-1 + J-1772 connector + - >- + Combined Charging System (AC and DC). Based on Type-2 Mennekes + connector + - >- + The generic TESLA connector. This is NACS in the North America + but can be non-NACS in other parts of the world (e.g. CCS Combo + 2 (CCS2) or GB/T). This value is less representative of an + actual connector type, and more represents the ability to charge + a Tesla brand vehicle at a Tesla owned charging station. + - >- + GB/T type corresponds to the GB/T standard in China. This type + covers all GB_T types. + - Unspecified wall outlet. + enum: + - EV_CONNECTOR_TYPE_UNSPECIFIED + - EV_CONNECTOR_TYPE_OTHER + - EV_CONNECTOR_TYPE_J1772 + - EV_CONNECTOR_TYPE_TYPE_2 + - EV_CONNECTOR_TYPE_CHADEMO + - EV_CONNECTOR_TYPE_CCS_COMBO_1 + - EV_CONNECTOR_TYPE_CCS_COMBO_2 + - EV_CONNECTOR_TYPE_TESLA + - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T + - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET + type: array description: >- - The region to search. This location serves as a bias which means - results around given location might be returned. Cannot be set along - with location_restriction. - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationBias' - minRating: - type: number + Optional. The list of preferred EV connector types. A place that + does not support any of the listed connector types is filtered out. + minimumChargingRateKw: description: >- - Filter out results whose average user rating is strictly less than - this limit. A valid value must be a float between 0 and 5 - (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] - inclusively. The input rating will round up to the nearest - 0.5(ceiling). For instance, a rating of 0.6 will eliminate all - results with a less than 1.0 rating. + Optional. Minimum required charging rate in kilowatts. A place with + a charging rate less than the specified rate is filtered out. format: double - languageCode: - type: string + type: number + type: object + id: GoogleMapsPlacesV1SearchTextRequestEVOptions + description: Searchable EV options of a place search request. + GoogleMapsPlacesV1PlacePaymentOptions: + type: object + properties: + acceptsNfc: + type: boolean + description: Place accepts NFC payments. + acceptsCashOnly: + type: boolean description: >- - Place details will be displayed with the preferred language if - available. If the language code is unspecified or unrecognized, - place details of any language may be returned, with a preference for - English if such details exist. Current list of supported languages: - https://developers.google.com/maps/faq#languagesupport. - rankPreference: - enumDescriptions: - - >- - For a categorical query such as "Restaurants in New York City", - RELEVANCE is the default. For non-categorical queries such as - "Mountain View, CA" we recommend that you leave rankPreference - unset. - - Ranks results by distance. - - >- - Ranks results by relevance. Sort order determined by normal - ranking stack. - description: How results will be ranked in the response. - type: string - enum: - - RANK_PREFERENCE_UNSPECIFIED - - DISTANCE - - RELEVANCE - searchAlongRouteParameters: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters - description: Optional. Additional parameters proto for searching along a route. - pageSize: + Place accepts cash only as payment. Places with this attribute may + still accept other payment methods. + acceptsCreditCards: + description: Place accepts credit cards as payment. + type: boolean + acceptsDebitCards: + description: Place accepts debit cards as payment. + type: boolean + id: GoogleMapsPlacesV1PlacePaymentOptions + description: Payment options the place accepts. + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + type: object + description: Identifies a substring within a given text. + properties: + endOffset: + description: Zero-based offset of the last Unicode character (exclusive). + format: int32 type: integer + startOffset: format: int32 description: >- - Optional. The maximum number of results per page that can be - returned. If the number of available results is larger than - `page_size`, a `next_page_token` is returned which can be passed to - `page_token` to get the next page of results in subsequent requests. - If 0 or no value is provided, a default of 20 is used. The maximum - value is 20; values above 20 will be set to 20. Negative values will - return an INVALID_ARGUMENT error. If both `max_result_count` and - `page_size` are specified, `max_result_count` will be ignored. - evOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' - description: Optional. Set the searchable EV options of a place search request. - priceLevels: - type: array + Zero-based offset of the first Unicode character of the string + (inclusive). + type: integer + GoogleMapsPlacesV1PlaceAddressComponent: + id: GoogleMapsPlacesV1PlaceAddressComponent + description: >- + The structured components that form the formatted address, if this + information is available. + properties: + shortText: description: >- - Used to restrict the search to places that are marked as certain - price levels. Users can choose any combinations of price levels. - Default to select all price levels. + An abbreviated textual name for the address component, if available. + For example, an address component for the country of Australia may + have a short_name of "AU". + type: string + types: items: type: string - enum: - - PRICE_LEVEL_UNSPECIFIED - - PRICE_LEVEL_FREE - - PRICE_LEVEL_INEXPENSIVE - - PRICE_LEVEL_MODERATE - - PRICE_LEVEL_EXPENSIVE - - PRICE_LEVEL_VERY_EXPENSIVE - enumDescriptions: - - Place price level is unspecified or unknown. - - Place provides free services. - - Place provides inexpensive services. - - Place provides moderately priced services. - - Place provides expensive services. - - Place provides very expensive services. - locationRestriction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction - description: >- - The region to search. This location serves as a restriction which - means results outside given location will not be returned. Cannot be - set along with location_bias. - maxResultCount: + type: array + description: An array indicating the type(s) of the address component. + longText: description: >- - Deprecated: Use `page_size` instead. The maximum number of results - per page that can be returned. If the number of available results is - larger than `max_result_count`, a `next_page_token` is returned - which can be passed to `page_token` to get the next page of results - in subsequent requests. If 0 or no value is provided, a default of - 20 is used. The maximum value is 20; values above 20 will be coerced - to 20. Negative values will return an INVALID_ARGUMENT error. If - both `max_result_count` and `page_size` are specified, - `max_result_count` will be ignored. - deprecated: true - format: int32 - type: integer - textQuery: - description: Required. The text query for textual search. + The full text description or name of the address component. For + example, an address component for the country Australia may have a + long_name of "Australia". type: string - pageToken: + languageCode: + description: The language used to format this components, in CLDR notation. type: string + type: object + GoogleMapsPlacesV1RouteModifiers: + id: GoogleMapsPlacesV1RouteModifiers + type: object + properties: + avoidHighways: description: >- - Optional. A page token, received from a previous TextSearch call. - Provide this to retrieve the subsequent page. When paginating, all - parameters other than `page_token`, `page_size`, and - `max_result_count` provided to TextSearch must match the initial - call that provided the page token. Otherwise an INVALID_ARGUMENT - error is returned. - includedType: - type: string + Optional. When set to true, avoids highways where reasonable, giving + preference to routes not containing highways. Applies only to the + `DRIVE` and `TWO_WHEELER` `TravelMode`. + type: boolean + avoidIndoor: + type: boolean description: >- - The requested place type. Full list of types supported: - https://developers.google.com/maps/documentation/places/web-service/place-types. - Only support one included type. - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: + Optional. When set to true, avoids navigating indoors where + reasonable, giving preference to routes not containing indoor + navigation. Applies only to the `WALK` `TravelMode`. + avoidFerries: + type: boolean + description: >- + Optional. When set to true, avoids ferries where reasonable, giving + preference to routes not containing ferries. Applies only to the + `DRIVE` and `TWO_WHEELER` `TravelMode`. + avoidTolls: + type: boolean + description: >- + Optional. When set to true, avoids toll roads where reasonable, + giving preference to routes not containing toll roads. Applies only + to the `DRIVE` and `TWO_WHEELER` `TravelMode`. description: >- - The text highlighted by the justification. This is a subset of the - review itself. The exact word to highlight is marked by the - HighlightedTextRange. There could be several words in the text being - highlighted. - id: >- - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText + Encapsulates a set of optional conditions to satisfy when calculating + the routes. + GoogleMapsPlacesV1SearchTextRequestLocationRestriction: + id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction type: object properties: - text: - type: string - highlightedTextRanges: - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange - type: array - description: The list of the ranges of the highlighted text. + rectangle: + $ref: '#/components/schemas/GoogleGeoTypeViewport' + description: >- + A rectangle box defined by northeast and southwest corner. + `rectangle.high()` must be the northeast point of the rectangle + viewport. `rectangle.low()` must be the southwest point of the + rectangle viewport. `rectangle.low().latitude()` cannot be greater + than `rectangle.high().latitude()`. This will result in an empty + latitude range. A rectangle viewport cannot be wider than 180 + degrees. + description: >- + The region to search. This location serves as a restriction which means + results outside given location will not be returned. GoogleGeoTypeViewport: - id: GoogleGeoTypeViewport - type: object - properties: - high: - description: Required. The high point of the viewport. - $ref: '#/components/schemas/GoogleTypeLatLng' - low: - description: Required. The low point of the viewport. - $ref: '#/components/schemas/GoogleTypeLatLng' description: >- A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. @@ -769,208 +631,133 @@ components: viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } - GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification: - id: >- - GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification - type: object - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. BusinessAvailabilityAttributes justifications. This - shows some attributes a business has that could interest an end user. - properties: - dineIn: - type: boolean - description: If a place provides dine-in. - takeout: - type: boolean - description: If a place provides takeout. - delivery: - description: If a place provides delivery. - type: boolean - GoogleMapsPlacesV1PlacePaymentOptions: - properties: - acceptsNfc: - type: boolean - description: Place accepts NFC payments. - acceptsCreditCards: - description: Place accepts credit cards as payment. - type: boolean - acceptsCashOnly: - description: >- - Place accepts cash only as payment. Places with this attribute may - still accept other payment methods. - type: boolean - acceptsDebitCards: - description: Place accepts debit cards as payment. - type: boolean - type: object - description: Payment options the place accepts. - id: GoogleMapsPlacesV1PlacePaymentOptions - GoogleMapsPlacesV1Review: type: object - description: Information about a review of a place. - id: GoogleMapsPlacesV1Review + id: GoogleGeoTypeViewport properties: - originalText: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The review text in its original language. - relativePublishTimeDescription: - description: >- - A string of formatted recent time, expressing the review time - relative to the current time in a form appropriate for the language - and country. - type: string - rating: - type: number - format: double - description: A number between 1.0 and 5.0, also called the number of stars. - text: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The localized text of the review. - authorAttribution: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - description: This review's author. - publishTime: - type: string - description: Timestamp for the review. - format: google-datetime - name: - description: >- - A reference representing this place review which may be used to look - up this place review again (also called the API "resource" name: - `places/{place_id}/reviews/{review}`). - type: string - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: + high: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: Required. The high point of the viewport. + low: + description: Required. The low point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + GoogleMapsPlacesV1SearchTextRequest: type: object + id: GoogleMapsPlacesV1SearchTextRequest + description: 'Request proto for SearchText. ' properties: - startOffset: + strictTypeFiltering: + type: boolean description: >- - Zero-based offset of the first Unicode character of the string - (inclusive). - format: int32 + Used to set strict type filtering for included_type. If set to true, + only results of the same type will be returned. Default to false. + maxResultCount: type: integer - endOffset: - description: Zero-based offset of the last Unicode character (exclusive). + description: >- + Deprecated: Use `page_size` instead. The maximum number of results + per page that can be returned. If the number of available results is + larger than `max_result_count`, a `next_page_token` is returned + which can be passed to `page_token` to get the next page of results + in subsequent requests. If 0 or no value is provided, a default of + 20 is used. The maximum value is 20; values above 20 will be coerced + to 20. Negative values will return an INVALID_ARGUMENT error. If + both `max_result_count` and `page_size` are specified, + `max_result_count` will be ignored. format: int32 - type: integer - description: Identifies a substring within a given text. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange - GoogleMapsPlacesV1SearchNearbyRequest: - properties: - includedPrimaryTypes: + deprecated: true + locationRestriction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction description: >- - Included primary Place type (e.g. "restaurant" or "gas_station") - from - https://developers.google.com/maps/documentation/places/web-service/place-types. - A place can only have a single primary type from the supported types - table associated with it. Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting primary types, i.e. a - type appears in both included_primary_types and - excluded_primary_types, an INVALID_ARGUMENT error is returned. If a - Place type is specified with multiple type restrictions, only places - that satisfy all of the restrictions are returned. For example, if - we have {included_types = ["restaurant"], excluded_primary_types = - ["restaurant"]}, the returned places provide "restaurant" related - services but do not operate primarily as "restaurants". - items: - type: string - type: array + The region to search. This location serves as a restriction which + means results outside given location will not be returned. Cannot be + set along with location_bias. + textQuery: + type: string + description: Required. The text query for textual search. routingParameters: - description: Optional. Parameters that affect the routing to the search results. + description: Optional. Additional parameters for routing to results. $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' - maxResultCount: + evOptions: + description: Optional. Set the searchable EV options of a place search request. + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' + pageSize: type: integer - format: int32 - description: >- - Maximum number of results to return. It must be between 1 and 20 - (default), inclusively. If the number is unset, it falls back to the - upper limit. If the number is set to negative or exceeds the upper - limit, an INVALID_ARGUMENT error is returned. - excludedTypes: description: >- - Excluded Place type (eg, "restaurant" or "gas_station") from - https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If the client provides both included_types (e.g. - restaurant) and excluded_types (e.g. cafe), then the response should - include places that are restaurant but not cafe. The response - includes places that match at least one of the included_types and - none of the excluded_types. If there are any conflicting types, i.e. - a type appears in both included_types and excluded_types, an - INVALID_ARGUMENT error is returned. If a Place type is specified - with multiple type restrictions, only places that satisfy all of the - restrictions are returned. For example, if we have {included_types = - ["restaurant"], excluded_primary_types = ["restaurant"]}, the - returned places provide "restaurant" related services but do not - operate primarily as "restaurants". - type: array - items: - type: string - excludedPrimaryTypes: + Optional. The maximum number of results per page that can be + returned. If the number of available results is larger than + `page_size`, a `next_page_token` is returned which can be passed to + `page_token` to get the next page of results in subsequent requests. + If 0 or no value is provided, a default of 20 is used. The maximum + value is 20; values above 20 will be set to 20. Negative values will + return an INVALID_ARGUMENT error. If both `max_result_count` and + `page_size` are specified, `max_result_count` will be ignored. + format: int32 + priceLevels: items: + enumDescriptions: + - Place price level is unspecified or unknown. + - Place provides free services. + - Place provides inexpensive services. + - Place provides moderately priced services. + - Place provides expensive services. + - Place provides very expensive services. + enum: + - PRICE_LEVEL_UNSPECIFIED + - PRICE_LEVEL_FREE + - PRICE_LEVEL_INEXPENSIVE + - PRICE_LEVEL_MODERATE + - PRICE_LEVEL_EXPENSIVE + - PRICE_LEVEL_VERY_EXPENSIVE type: string + type: array description: >- - Excluded primary Place type (e.g. "restaurant" or "gas_station") - from + Used to restrict the search to places that are marked as certain + price levels. Users can choose any combinations of price levels. + Default to select all price levels. + includedType: + description: >- + The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting primary types, i.e. a - type appears in both included_primary_types and - excluded_primary_types, an INVALID_ARGUMENT error is returned. If a - Place type is specified with multiple type restrictions, only places - that satisfy all of the restrictions are returned. For example, if - we have {included_types = ["restaurant"], excluded_primary_types = - ["restaurant"]}, the returned places provide "restaurant" related - services but do not operate primarily as "restaurants". - type: array - locationRestriction: - description: Required. The region to search. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction - rankPreference: - enumDescriptions: - - >- - RankPreference value not set. Will use rank by POPULARITY by - default. - - Ranks results by distance. - - Ranks results by popularity. - description: How results will be ranked in the response. + Only support one included type. type: string - enum: - - RANK_PREFERENCE_UNSPECIFIED - - DISTANCE - - POPULARITY - languageCode: + pageToken: type: string + description: >- + Optional. A page token, received from a previous TextSearch call. + Provide this to retrieve the subsequent page. When paginating, all + parameters other than `page_token`, `page_size`, and + `max_result_count` provided to TextSearch must match the initial + call that provided the page token. Otherwise an INVALID_ARGUMENT + error is returned. + languageCode: description: >- Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist. Current list of supported languages: https://developers.google.com/maps/faq#languagesupport. - includedTypes: - type: array + type: string + searchAlongRouteParameters: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters + description: Optional. Additional parameters proto for searching along a route. + minRating: + format: double description: >- - Included Place type (eg, "restaurant" or "gas_station") from - https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting types, i.e. a type - appears in both included_types and excluded_types, an - INVALID_ARGUMENT error is returned. If a Place type is specified - with multiple type restrictions, only places that satisfy all of the - restrictions are returned. For example, if we have {included_types = - ["restaurant"], excluded_primary_types = ["restaurant"]}, the - returned places provide "restaurant" related services but do not - operate primarily as "restaurants". - items: - type: string + Filter out results whose average user rating is strictly less than + this limit. A valid value must be a float between 0 and 5 + (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] + inclusively. The input rating will round up to the nearest + 0.5(ceiling). For instance, a rating of 0.6 will eliminate all + results with a less than 1.0 rating. + type: number + locationBias: + description: >- + The region to search. This location serves as a bias which means + results around given location might be returned. Cannot be set along + with location_restriction. + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationBias' regionCode: - type: string description: >- The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place @@ -979,172 +766,333 @@ components: information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported. - id: GoogleMapsPlacesV1SearchNearbyRequest - description: 'Request proto for Search Nearby. ' + type: string + openNow: + description: >- + Used to restrict the search to places that are currently open. The + default is false. + type: boolean + rankPreference: + type: string + enumDescriptions: + - >- + For a categorical query such as "Restaurants in New York City", + RELEVANCE is the default. For non-categorical queries such as + "Mountain View, CA" we recommend that you leave rankPreference + unset. + - Ranks results by distance. + - >- + Ranks results by relevance. Sort order determined by normal + ranking stack. + enum: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - RELEVANCE + description: How results will be ranked in the response. + GoogleMapsPlacesV1PlaceAccessibilityOptions: type: object - GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: + id: GoogleMapsPlacesV1PlaceAccessibilityOptions + description: Information about the accessibility options a place offers. + properties: + wheelchairAccessibleParking: + type: boolean + description: Place offers wheelchair accessible parking. + wheelchairAccessibleRestroom: + description: Place has wheelchair accessible restroom. + type: boolean + wheelchairAccessibleSeating: + description: Place has wheelchair accessible seating. + type: boolean + wheelchairAccessibleEntrance: + type: boolean + description: Places has wheelchair accessible entrance. + GoogleMapsPlacesV1PhotoMedia: + id: GoogleMapsPlacesV1PhotoMedia type: object - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. User review justifications. This highlights a section - of the user review that would interest an end user. For instance, if the - search query is "firewood pizza", the review justification highlights - the text relevant to the search query. - id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification properties: - highlightedText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText - review: - description: The review that the highlighted text is generated from. - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - GoogleMapsPlacesV1SearchTextRequestLocationBias: + name: + type: string + description: >- + The resource name of a photo media in the format: + `places/{place_id}/photos/{photo_reference}/media`. + photoUri: + description: A short-lived uri that can be used to render the photo. + type: string + description: A photo media from Places API. + GoogleMapsPlacesV1PlaceOpeningHoursPeriod: + type: object properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by center point and radius. - rectangle: - $ref: '#/components/schemas/GoogleGeoTypeViewport' + close: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' + description: The time that the place starts to be closed. + open: + description: The time that the place starts to be open. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod + description: A period the place remains in open_now status. + GoogleMapsPlacesV1PlacePlusCode: + properties: + globalCode: + type: string description: >- - A rectangle box defined by northeast and southwest corner. - `rectangle.high()` must be the northeast point of the rectangle - viewport. `rectangle.low()` must be the southwest point of the - rectangle viewport. `rectangle.low().latitude()` cannot be greater - than `rectangle.high().latitude()`. This will result in an empty - latitude range. A rectangle viewport cannot be wider than 180 - degrees. - id: GoogleMapsPlacesV1SearchTextRequestLocationBias + Place's global (full) code, such as "9FWM33GV+HQ", representing an + 1/8000 by 1/8000 degree area (~14 by 14 meters). + compoundCode: + type: string + description: >- + Place's compound code, such as "33GV+HQ, Ramberg, Norway", + containing the suffix of the global code and replacing the prefix + with a formatted name of a reference entity. + id: GoogleMapsPlacesV1PlacePlusCode + description: >- + Plus code (http://plus.codes) is a location reference with two formats: + global code defining a 14mx14m (1/8000th of a degree) or smaller + rectangle, and compound code, replacing the prefix with a reference + location. + type: object + GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: type: object description: >- - The region to search. This location serves as a bias which means results - around given location might be returned. - GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint + Structured information for special days that fall within the period that + the returned opening hours cover. Special days are days that could + impact the business hours of a place, e.g. Christmas day. + id: GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay properties: - day: - format: int32 - type: integer - description: >- - A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is - Monday, etc. - minute: - type: integer - format: int32 - description: The minute in 2 digits. Ranges from 00 to 59. - truncated: - type: boolean - description: >- - Whether or not this endpoint was truncated. Truncation occurs when - the real hours are outside the times we are willing to return hours - between, so we truncate the hours back to these boundaries. This - ensures that at most 24 * 7 hours from midnight of the day of the - request are returned. - hour: - format: int32 - description: The hour in 2 digits. Ranges from 00 to 23. - type: integer date: $ref: '#/components/schemas/GoogleTypeDate' - description: Date in the local timezone for the place. - description: Status changing points. - type: object - GoogleMapsPlacesV1PhotoMedia: - type: object - description: A photo media from Places API. + description: The date of this special day. + GoogleMapsPlacesV1PlaceAttribution: properties: - photoUri: - description: A short-lived uri that can be used to render the photo. + provider: type: string - name: + description: Name of the Place's data provider. + providerUri: type: string + description: URI to the Place's data provider. + id: GoogleMapsPlacesV1PlaceAttribution + type: object + description: Information about data providers of this place. + GoogleMapsPlacesV1PlaceAreaSummary: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the area that the place is in. + id: GoogleMapsPlacesV1PlaceAreaSummary + properties: + contentBlocks: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' + type: array description: >- - The resource name of a photo media in the format: - `places/{place_id}/photos/{photo_reference}/media`. - id: GoogleMapsPlacesV1PhotoMedia + Content blocks that compose the area summary. Each block has a + separate topic about the area. + type: object GoogleMapsPlacesV1Place: + description: All the information representing a Place. id: GoogleMapsPlacesV1Place properties: - areaSummary: + regularSecondaryOpeningHours: description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the area that the place is - in. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAreaSummary' - goodForGroups: - description: Place accommodates groups. - type: boolean - attributions: - description: A set of data provider that must be shown with this result. + Contains an array of entries for information about regular secondary + hours of a business. Secondary hours are different from a business's + main hours. For example, a restaurant can specify drive through + hours or delivery hours as its secondary hours. This field populates + the type subfield, which draws from a predefined list of opening + hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the + types of the place. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' type: array + adrFormatAddress: + type: string + description: >- + The place's address in adr microformat: + http://microformats.org/wiki/adr. allowsDogs: type: boolean description: Place allows dogs. - menuForChildren: - description: Place has a children's menu. + takeout: type: boolean - paymentOptions: + description: Specifies if the business supports takeout. + reviews: description: >- - Payment options the place accepts. If a payment option data is not - available, the payment option field will be unset. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions' - iconBackgroundColor: - description: 'Background color for icon_mask in hex format, e.g. #909CE1.' - type: string + List of reviews about this place, sorted by relevance. A maximum of + 5 reviews can be returned. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + type: array servesDessert: + type: boolean description: Place serves dessert. + outdoorSeating: + description: Place provides outdoor seating. type: boolean - takeout: - description: Specifies if the business supports takeout. + menuForChildren: type: boolean - id: - type: string - description: The unique identifier of a place. + description: Place has a children's menu. servesCocktails: + type: boolean description: Place serves cocktails. + name: + description: >- + This Place's resource name, in `places/{place_id}` format. Can be + used to look up the Place. + type: string + currentSecondaryOpeningHours: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + type: array + description: >- + Contains an array of entries for the next seven days including + information about secondary hours of a business. Secondary hours are + different from a business's main hours. For example, a restaurant + can specify drive through hours or delivery hours as its secondary + hours. This field populates the type subfield, which draws from a + predefined list of opening hours types (such as DRIVE_THROUGH, + PICKUP, or TAKEOUT) based on the types of the place. This field + includes the special_days subfield of all hours, set for dates that + have exceptional hours. + servesDinner: + description: Specifies if the place serves dinner. type: boolean - servesBreakfast: - description: Specifies if the place serves breakfast. + currentOpeningHours: + description: >- + The hours of operation for the next seven days (including today). + The time period starts at midnight on the date of the request and + ends at 11:59 pm six days later. This field includes the + special_days subfield of all hours, set for dates that have + exceptional hours. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + types: + type: array + description: >- + A set of type tags for this result. For example, "political" and + "locality". For the complete list of possible values, see Table A + and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types + items: + type: string + goodForChildren: type: boolean - servesLunch: + description: Place is good for children. + dineIn: + description: >- + Specifies if the business supports indoor or outdoor seating + options. type: boolean - description: Specifies if the place serves lunch. - evChargeOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' - description: Information of ev charging options. reservable: type: boolean description: Specifies if the place supports reservations. - shortFormattedAddress: + attributions: + description: A set of data provider that must be shown with this result. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' + type: array + servesBeer: + type: boolean + description: Specifies if the place serves beer. + businessStatus: + enum: + - BUSINESS_STATUS_UNSPECIFIED + - OPERATIONAL + - CLOSED_TEMPORARILY + - CLOSED_PERMANENTLY + description: The business status for the place. + type: string + enumDescriptions: + - Default value. This value is unused. + - The establishment is operational, not necessarily open now. + - The establishment is temporarily closed. + - The establishment is permanently closed. + id: type: string + description: The unique identifier of a place. + servesBreakfast: + type: boolean + description: Specifies if the place serves breakfast. + shortFormattedAddress: description: A short, human-readable address for this place. - dineIn: + type: string + liveMusic: + type: boolean + description: Place provides live music. + servesBrunch: + type: boolean + description: Specifies if the place serves brunch. + goodForGroups: + type: boolean + description: Place accommodates groups. + goodForWatchingSports: + type: boolean + description: Place is suitable for watching sports. + servesWine: + description: Specifies if the place serves wine. + type: boolean + delivery: + type: boolean + description: Specifies if the business supports delivery. + websiteUri: + description: >- + The authoritative website for this place, e.g. a business' homepage. + Note that for places that are part of a chain (e.g. an IKEA store), + this will usually be the website for the individual store, not the + overall chain. + type: string + fuelOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' + description: >- + The most recent information about fuel options in a gas station. + This information is updated regularly. + addressComponents: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent' + description: >- + Repeated components for each locality level. Note the following + facts about the address_components[] array: - The array of address + components may contain more components than the formatted_address. - + The array does not necessarily include all the political entities + that contain an address, apart from those included in the + formatted_address. To retrieve all the political entities that + contain a specific address, you should use reverse geocoding, + passing the latitude/longitude of the address as a parameter to the + request. - The format of the response is not guaranteed to remain + the same between requests. In particular, the number of + address_components varies based on the address requested and can + change over time for the same address. A component can change + position in the array. The type of the component can change. A + particular component may be missing in a later response. + type: array + servesCoffee: + description: Place serves coffee. + type: boolean + generativeSummary: description: >- - Specifies if the business supports indoor or outdoor seating - options. + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the place. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGenerativeSummary' + paymentOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions' + description: >- + Payment options the place accepts. If a payment option data is not + available, the payment option field will be unset. + servesVegetarianFood: + description: Specifies if the place serves vegetarian food. type: boolean - fuelOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' + rating: + description: A rating between 1.0 and 5.0, based on user reviews of this place. + format: double + type: number + photos: description: >- - The most recent information about fuel options in a gas station. - This information is updated regularly. + Information (including references) about photos of this place. A + maximum of 10 photos can be returned. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' restroom: - description: Place has restroom. type: boolean - parkingOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' - description: Options of parking provided by the place. - primaryType: - description: >- - The primary type of the given result. This type must one of the - Places API supported types. For example, "restaurant", "cafe", - "airport", etc. A place can only have a single primary type. For the - complete list of possible values, see Table A and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types - type: string + description: Place has restroom. editorialSummary: $ref: '#/components/schemas/GoogleTypeLocalizedText' description: >- @@ -1152,91 +1100,38 @@ components: overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered. - servesBrunch: - type: boolean - description: Specifies if the place serves brunch. - generativeSummary: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGenerativeSummary' - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the place. - businessStatus: - description: The business status for the place. - enum: - - BUSINESS_STATUS_UNSPECIFIED - - OPERATIONAL - - CLOSED_TEMPORARILY - - CLOSED_PERMANENTLY - type: string - enumDescriptions: - - Default value. This value is unused. - - The establishment is operational, not necessarily open now. - - The establishment is temporarily closed. - - The establishment is permanently closed. - internationalPhoneNumber: + utcOffsetMinutes: description: >- - A human-readable phone number for the place, in international - format. - type: string + Number of minutes this place's timezone is currently offset from + UTC. This is expressed in minutes to support timezones that are + offset by fractions of an hour, e.g. X hours and 15 minutes. + format: int32 + type: integer googleMapsUri: description: A URL providing more information about this place. type: string - regularSecondaryOpeningHours: - description: >- - Contains an array of entries for information about regular secondary - hours of a business. Secondary hours are different from a business's - main hours. For example, a restaurant can specify drive through - hours or delivery hours as its secondary hours. This field populates - the type subfield, which draws from a predefined list of opening - hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the - types of the place. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - outdoorSeating: + servesLunch: + description: Specifies if the place serves lunch. type: boolean - description: Place provides outdoor seating. - userRatingCount: - description: The total number of reviews (with or without text) for this place. - format: int32 - type: integer + regularOpeningHours: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + description: The regular hours of operation. viewport: description: >- A viewport suitable for displaying the place on an average-sized map. $ref: '#/components/schemas/GoogleGeoTypeViewport' - currentSecondaryOpeningHours: - description: >- - Contains an array of entries for the next seven days including - information about secondary hours of a business. Secondary hours are - different from a business's main hours. For example, a restaurant - can specify drive through hours or delivery hours as its secondary - hours. This field populates the type subfield, which draws from a - predefined list of opening hours types (such as DRIVE_THROUGH, - PICKUP, or TAKEOUT) based on the types of the place. This field - includes the special_days subfield of all hours, set for dates that - have exceptional hours. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - rating: - format: double - type: number - description: A rating between 1.0 and 5.0, based on user reviews of this place. - photos: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' - type: array + primaryType: description: >- - Information (including references) about photos of this place. A - maximum of 10 photos can be returned. - servesWine: - description: Specifies if the place serves wine. - type: boolean - liveMusic: - type: boolean - description: Place provides live music. + The primary type of the given result. This type must one of the + Places API supported types. For example, "restaurant", "cafe", + "airport", etc. A place can only have a single primary type. For the + complete list of possible values, see Table A and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types + type: string + iconBackgroundColor: + description: 'Background color for icon_mask in hex format, e.g. #909CE1.' + type: string priceLevel: enumDescriptions: - Place price level is unspecified or unknown. @@ -1245,6 +1140,7 @@ components: - Place provides moderately priced services. - Place provides expensive services. - Place provides very expensive services. + type: string enum: - PRICE_LEVEL_UNSPECIFIED - PRICE_LEVEL_FREE @@ -1253,216 +1149,167 @@ components: - PRICE_LEVEL_EXPENSIVE - PRICE_LEVEL_VERY_EXPENSIVE description: Price level of the place. - type: string - servesVegetarianFood: - description: Specifies if the place serves vegetarian food. - type: boolean - servesBeer: - description: Specifies if the place serves beer. - type: boolean - adrFormatAddress: - description: >- - The place's address in adr microformat: - http://microformats.org/wiki/adr. - type: string - reviews: + areaSummary: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAreaSummary' description: >- - List of reviews about this place, sorted by relevance. A maximum of - 5 reviews can be returned. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the area that the place is + in. + evChargeOptions: + description: Information of ev charging options. + $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' location: description: The position of this place. $ref: '#/components/schemas/GoogleTypeLatLng' - websiteUri: - description: >- - The authoritative website for this place, e.g. a business' homepage. - Note that for places that are part of a chain (e.g. an IKEA store), - this will usually be the website for the individual store, not the - overall chain. + internationalPhoneNumber: type: string - servesDinner: - description: Specifies if the place serves dinner. - type: boolean + description: >- + A human-readable phone number for the place, in international + format. + accessibilityOptions: + description: Information about the accessibility options a place offers. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' nationalPhoneNumber: type: string description: A human-readable phone number for the place, in national format. - plusCode: - description: Plus code of the place location lat/long. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' - currentOpeningHours: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - description: >- - The hours of operation for the next seven days (including today). - The time period starts at midnight on the date of the request and - ends at 11:59 pm six days later. This field includes the - special_days subfield of all hours, set for dates that have - exceptional hours. - curbsidePickup: - description: Specifies if the business supports curbside pickup. - type: boolean iconMaskBaseUri: - type: string description: >- A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png"). - displayName: - description: >- - The localized name of the place, suitable as a short human-readable - description. For example, "Google Sydney", "Starbucks", "Pyrmont", - etc. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - goodForWatchingSports: - type: boolean - description: Place is suitable for watching sports. - types: - description: >- - A set of type tags for this result. For example, "political" and - "locality". For the complete list of possible values, see Table A - and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types - type: array - items: - type: string - primaryTypeDisplayName: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: >- - The display name of the primary type, localized to the request - language if applicable. For the complete list of possible values, - see Table A and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types - regularOpeningHours: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - description: The regular hours of operation. - servesCoffee: - type: boolean - description: Place serves coffee. - accessibilityOptions: - description: Information about the accessibility options a place offers. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' - utcOffsetMinutes: - type: integer - format: int32 - description: >- - Number of minutes this place's timezone is currently offset from - UTC. This is expressed in minutes to support timezones that are - offset by fractions of an hour, e.g. X hours and 15 minutes. - goodForChildren: - description: Place is good for children. - type: boolean - delivery: - type: boolean - description: Specifies if the business supports delivery. - formattedAddress: - description: A full, human-readable address for this place. - type: string - subDestinations: - type: array - description: A list of sub destinations related to the place. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' - name: type: string - description: >- - This Place's resource name, in `places/{place_id}` format. Can be - used to look up the Place. - addressComponents: - type: array + formattedAddress: + type: string + description: A full, human-readable address for this place. + subDestinations: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent' - description: >- - Repeated components for each locality level. Note the following - facts about the address_components[] array: - The array of address - components may contain more components than the formatted_address. - - The array does not necessarily include all the political entities - that contain an address, apart from those included in the - formatted_address. To retrieve all the political entities that - contain a specific address, you should use reverse geocoding, - passing the latitude/longitude of the address as a parameter to the - request. - The format of the response is not guaranteed to remain - the same between requests. In particular, the number of - address_components varies based on the address requested and can - change over time for the same address. A component can change - position in the array. The type of the component can change. A - particular component may be missing in a later response. - description: All the information representing a Place. - type: object - GoogleMapsPlacesV1EVChargeOptions: - properties: - connectorAggregation: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' + description: A list of sub destinations related to the place. type: array + displayName: + $ref: '#/components/schemas/GoogleTypeLocalizedText' description: >- - A list of EV charging connector aggregations that contain connectors - of the same type and same charge rate. - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation - connectorCount: - format: int32 + The localized name of the place, suitable as a short human-readable + description. For example, "Google Sydney", "Starbucks", "Pyrmont", + etc. + plusCode: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' + description: Plus code of the place location lat/long. + primaryTypeDisplayName: description: >- - Number of connectors at this station. However, because some ports - can have multiple connectors but only be able to charge one car at a - time (e.g.) the number of connectors may be greater than the total - number of cars which can charge simultaneously. + The display name of the primary type, localized to the request + language if applicable. For the complete list of possible values, + see Table A and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types + $ref: '#/components/schemas/GoogleTypeLocalizedText' + curbsidePickup: + type: boolean + description: Specifies if the business supports curbside pickup. + userRatingCount: type: integer - id: GoogleMapsPlacesV1EVChargeOptions + format: int32 + description: The total number of reviews (with or without text) for this place. + parkingOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' + description: Options of parking provided by the place. + type: object + GoogleMapsPlacesV1ContextualContentJustification: type: object - description: >- - Information about the EV Charge Station hosted in Place. Terminology - follows https://afdc.energy.gov/fuels/electricity_infrastructure.html - One port could charge one car at a time. One port has one or more - connectors. One station has one or more ports. - GoogleMapsPlacesV1ContentBlock: - description: A block of content that can be served individually. - id: GoogleMapsPlacesV1ContentBlock properties: - topic: - type: string - description: The topic of the content, for example "overview" or "restaurant". - content: - description: Content related to the topic. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - references: + businessAvailabilityAttributesJustification: description: >- Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. References that are related to this block of - content. - $ref: '#/components/schemas/GoogleMapsPlacesV1References' - type: object - GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: + for more details. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + reviewJustification: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. + id: GoogleMapsPlacesV1ContextualContentJustification + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. Justifications answers + the question of why a place could interest an end user. + GoogleMapsPlacesV1Circle: + description: Circle with a LatLng as center and radius. + id: GoogleMapsPlacesV1Circle properties: - count: - type: integer - description: Number of connectors in this aggregation. - format: int32 - availableCount: - format: int32 - type: integer + center: + $ref: '#/components/schemas/GoogleTypeLatLng' description: >- - Number of connectors in this aggregation that are currently - available. - maxChargeRateKw: + Required. Center latitude and longitude. The range of latitude must + be within [-90.0, 90.0]. The range of the longitude must be within + [-180.0, 180.0]. + radius: format: double type: number description: >- - The static max charging rate in kw of each connector in the - aggregation. - outOfServiceCount: - description: >- - Number of connectors in this aggregation that are currently out of - service. - format: int32 - type: integer - availabilityLastUpdateTime: + Required. Radius measured in meters. The radius must be within [0.0, + 50000.0]. + type: object + GoogleTypeMoney: + type: object + properties: + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + units: type: string description: >- - The timestamp when the connector availability information in this - aggregation was last updated. - format: google-datetime + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + format: int64 + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. + GoogleTypeLatLng: + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. + type: object + id: GoogleTypeLatLng + properties: + longitude: + format: double + type: number + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: number + format: double + GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: + id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + type: object + properties: type: - type: string + enum: + - EV_CONNECTOR_TYPE_UNSPECIFIED + - EV_CONNECTOR_TYPE_OTHER + - EV_CONNECTOR_TYPE_J1772 + - EV_CONNECTOR_TYPE_TYPE_2 + - EV_CONNECTOR_TYPE_CHADEMO + - EV_CONNECTOR_TYPE_CCS_COMBO_1 + - EV_CONNECTOR_TYPE_CCS_COMBO_2 + - EV_CONNECTOR_TYPE_TESLA + - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T + - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET description: The connector type of this aggregation. enumDescriptions: - Unspecified connector. @@ -1486,312 +1333,468 @@ components: GB/T type corresponds to the GB/T standard in China. This type covers all GB_T types. - Unspecified wall outlet. - enum: - - EV_CONNECTOR_TYPE_UNSPECIFIED - - EV_CONNECTOR_TYPE_OTHER - - EV_CONNECTOR_TYPE_J1772 - - EV_CONNECTOR_TYPE_TYPE_2 - - EV_CONNECTOR_TYPE_CHADEMO - - EV_CONNECTOR_TYPE_CCS_COMBO_1 - - EV_CONNECTOR_TYPE_CCS_COMBO_2 - - EV_CONNECTOR_TYPE_TESLA - - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET - id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + type: string + maxChargeRateKw: + description: >- + The static max charging rate in kw of each connector in the + aggregation. + format: double + type: number + outOfServiceCount: + format: int32 + description: >- + Number of connectors in this aggregation that are currently out of + service. + type: integer + count: + format: int32 + description: Number of connectors in this aggregation. + type: integer + availabilityLastUpdateTime: + format: google-datetime + description: >- + The timestamp when the connector availability information in this + aggregation was last updated. + type: string + availableCount: + format: int32 + description: >- + Number of connectors in this aggregation that are currently + available. + type: integer description: >- EV charging information grouped by [type, max_charge_rate_kw]. Shows EV charge aggregation of connectors that have the same type and max charge rate in kw. + GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: type: object - GoogleMapsPlacesV1RoutingSummary: + id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + description: The region to search. properties: - legs: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummaryLeg' - description: >- - The legs of the trip. When you calculate travel duration and - distance from a set origin, `legs` contains a single leg containing - the duration and distance from the origin to the destination. When - you do a search along route, `legs` contains two legs: one from the - origin to place, and one from the place to the destination. - type: array - type: object - id: GoogleMapsPlacesV1RoutingSummary - description: >- - The duration and distance from the routing origin to a place in the - response, and a second leg from that place to the destination, if - requested. **Note:** Adding `routingSummaries` in the field mask without - also including either the `routingParameters.origin` parameter or the - `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the - request causes an error. - GoogleMapsPlacesV1SearchTextRequestLocationRestriction: - type: object + circle: + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: A circle defined by center point and radius. + GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification: description: >- - The region to search. This location serves as a restriction which means - results outside given location will not be returned. - id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. BusinessAvailabilityAttributes justifications. This + shows some attributes a business has that could interest an end user. properties: - rectangle: - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: >- - A rectangle box defined by northeast and southwest corner. - `rectangle.high()` must be the northeast point of the rectangle - viewport. `rectangle.low()` must be the southwest point of the - rectangle viewport. `rectangle.low().latitude()` cannot be greater - than `rectangle.high().latitude()`. This will result in an empty - latitude range. A rectangle viewport cannot be wider than 180 - degrees. - GoogleMapsPlacesV1SearchNearbyResponse: + dineIn: + description: If a place provides dine-in. + type: boolean + delivery: + description: If a place provides delivery. + type: boolean + takeout: + description: If a place provides takeout. + type: boolean + id: >- + GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification type: object - id: GoogleMapsPlacesV1SearchNearbyResponse - description: 'Response proto for Search Nearby. ' + GoogleMapsPlacesV1PlaceOpeningHours: properties: - routingSummaries: - type: array + secondaryHoursType: + description: A type string used to identify the type of secondary hours. + enum: + - SECONDARY_HOURS_TYPE_UNSPECIFIED + - DRIVE_THROUGH + - HAPPY_HOUR + - DELIVERY + - TAKEOUT + - KITCHEN + - BREAKFAST + - LUNCH + - DINNER + - BRUNCH + - PICKUP + - ACCESS + - SENIOR_HOURS + - ONLINE_SERVICE_HOURS + type: string + enumDescriptions: + - Default value when secondary hour type is not specified. + - The drive-through hour for banks, restaurants, or pharmacies. + - The happy hour. + - The delivery hour. + - The takeout hour. + - The kitchen hour. + - The breakfast hour. + - The lunch hour. + - The dinner hour. + - The brunch hour. + - The pickup hour. + - The access hours for storage places. + - The special hours for seniors. + - The online service hours. + weekdayDescriptions: description: >- - A list of routing summaries where each entry associates to the - corresponding place in the same index in the `places` field. If the - routing summary is not available for one of the places, it will - contain an empty entry. This list should have as many entries as the - list of places if requested. + Localized strings describing the opening hours of this place, one + string for each day of the week. Will be empty if the hours are + unknown or could not be converted to localized text. Example: "Sun: + 18:00–06:00" + type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' - places: + type: string + openNow: + description: >- + Whether the opening hours period is currently active. For regular + opening hours and current opening hours, this field means whether + the place is open. For secondary opening hours and current secondary + opening hours, this field means whether the secondary hours of this + place is active. + type: boolean + specialDays: type: array description: >- - A list of places that meets user's requirements like places types, - number of places and specific location restriction. + Structured information for special days that fall within the period + that the returned opening hours cover. Special days are days that + could impact the business hours of a place, e.g. Christmas day. Set + for current_opening_hours and current_secondary_opening_hours if + there are exceptional hours. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' + periods: + description: >- + The periods that this place is open during the week. The periods are + in chronological order, starting with Sunday in the place-local + timezone. An empty (but not absent) value indicates a place that is + never open, e.g. because it is closed temporarily for renovations. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' + type: object + description: Information about business hour of the place. + id: GoogleMapsPlacesV1PlaceOpeningHours + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: description: >- - Text representing a Place or query prediction. The text may be used as - is or formatted. + The text highlighted by the justification. This is a subset of the + review itself. The exact word to highlight is marked by the + HighlightedTextRange. There could be several words in the text being + highlighted. type: object - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText properties: - text: - type: string - description: Text that may be used as is or formatted with `matches`. - matches: - description: >- - A list of string ranges identifying where the input request matched - in `text`. The ranges can be used to format specific parts of - `text`. The substrings may not be exact matches of `input` if the - matching was determined by criteria other than string matching (for - example, spell corrections or transliterations). These values are - Unicode character offsets of `text`. The ranges are guaranteed to be - ordered in increasing offset values. + highlightedTextRanges: + type: array items: $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange - type: array - GoogleMapsPlacesV1References: + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange + description: The list of the ranges of the highlighted text. + text: + type: string + id: >- + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: properties: - places: - type: array - description: >- - The list of resource names of the referenced places. This name can - be used in other APIs that accept Place resource names. + types: items: type: string - reviews: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + description: >- + List of types that apply to this Place from Table A or Table B in + https://developers.google.com/maps/documentation/places/web-service/place-types. + A type is a categorization of a Place. Places with shared types will + share similar characteristics. type: array - description: Reviews that serve as references. - type: object - id: GoogleMapsPlacesV1References - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Reference that the generative content is related to. - GoogleTypeLocalizedText: - properties: - text: - type: string + distanceMeters: description: >- - Localized string in the language corresponding to language_code - below. - languageCode: + The length of the geodesic in meters from `origin` if `origin` is + specified. Certain predictions such as routes may not populate this + field. + format: int32 + type: integer + place: type: string description: >- - The text's BCP-47 language code, such as "en-US" or "sr-Latn". For - more information, see - http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - id: GoogleTypeLocalizedText - type: object - description: Localized variant of a text in a particular language. - GoogleMapsPlacesV1PlaceGenerativeSummary: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the place. - id: GoogleMapsPlacesV1PlaceGenerativeSummary - properties: - description: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The detailed description of the place. - references: - description: References that are used to generate the summary description. - $ref: '#/components/schemas/GoogleMapsPlacesV1References' - overview: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The overview of the place. - type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: - properties: + The resource name of the suggested Place. This name can be used in + other APIs that accept Place names. text: $ref: >- #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText description: >- - The predicted text. This text does not represent a Place, but rather - a text query that could be used in a search endpoint (for example, - Text Search). `text` is recommended for developers who wish to show - a single UI element. Developers who wish to show two separate, but + Contains the human-readable name for the returned result. For + establishment results, this is usually the business name and + address. `text` is recommended for developers who wish to show a + single UI element. Developers who wish to show two separate, but related, UI elements may want to use `structured_format` instead. - They are two different ways to represent a query prediction. Users + They are two different ways to represent a Place prediction. Users should not try to parse `structured_format` into `text` or vice - versa. May be in mixed languages if the request `input` and - `language_code` are in different languages or if part of the query - does not have a translation from the local language to - `language_code`. - structuredFormat: + versa. This text may be different from the `display_name` returned + by GetPlace. May be in mixed languages if the request `input` and + `language_code` are in different languages or if the Place does not + have a translation from the local language to `language_code`. + placeId: description: >- - A breakdown of the query prediction into main text containing the - query and secondary text containing additional disambiguating - features (such as a city or region). `structured_format` is - recommended for developers who wish to show two separate, but - related, UI elements. Developers who wish to show a single UI - element may want to use `text` instead. They are two different ways - to represent a query prediction. Users should not try to parse - `structured_format` into `text` or vice versa. + The unique identifier of the suggested Place. This identifier can be + used in other APIs that accept Place IDs. + type: string + structuredFormat: $ref: >- #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + description: >- + A breakdown of the Place prediction into main text containing the + name of the Place and secondary text containing additional + disambiguating features (such as a city or region). + `structured_format` is recommended for developers who wish to show + two separate, but related, UI elements. Developers who wish to show + a single UI element may want to use `text` instead. They are two + different ways to represent a Place prediction. Users should not try + to parse `structured_format` into `text` or vice versa. + type: object + description: Prediction results for a Place Autocomplete prediction. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + GoogleMapsPlacesV1References: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Reference that the generative content is related to. + id: GoogleMapsPlacesV1References type: object - description: Prediction results for a Query Autocomplete prediction. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction - GoogleMapsPlacesV1AutocompletePlacesResponse: - description: Response proto for AutocompletePlaces. properties: - suggestions: + places: + items: + type: string + description: >- + The list of resource names of the referenced places. This name can + be used in other APIs that accept Place resource names. type: array + reviews: items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + type: array + description: Reviews that serve as references. + GoogleMapsPlacesV1SearchNearbyResponse: + type: object + description: 'Response proto for Search Nearby. ' + properties: + places: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + type: array description: >- - Contains a list of suggestions, ordered in descending order of - relevance. + A list of places that meets user's requirements like places types, + number of places and specific location restriction. + routingSummaries: + description: >- + A list of routing summaries where each entry associates to the + corresponding place in the same index in the `places` field. If the + routing summary is not available for one of the places, it will + contain an empty entry. This list should have as many entries as the + list of places if requested. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' + type: array + id: GoogleMapsPlacesV1SearchNearbyResponse + GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint type: object - id: GoogleMapsPlacesV1AutocompletePlacesResponse - GoogleMapsPlacesV1RoutingSummaryLeg: properties: - duration: - description: The time it takes to complete this leg of the trip. - type: string - format: google-duration - distanceMeters: + minute: + description: The minute in 2 digits. Ranges from 00 to 59. + format: int32 + type: integer + truncated: + type: boolean + description: >- + Whether or not this endpoint was truncated. Truncation occurs when + the real hours are outside the times we are willing to return hours + between, so we truncate the hours back to these boundaries. This + ensures that at most 24 * 7 hours from midnight of the day of the + request are returned. + day: + description: >- + A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is + Monday, etc. + format: int32 + type: integer + hour: type: integer + description: The hour in 2 digits. Ranges from 00 to 23. format: int32 - description: The distance of this leg of the trip. - description: A leg is a single portion of a journey from one location to another. - id: GoogleMapsPlacesV1RoutingSummaryLeg + date: + $ref: '#/components/schemas/GoogleTypeDate' + description: Date in the local timezone for the place. + description: Status changing points. + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: + id: >- + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange type: object - GoogleMapsPlacesV1PlacePlusCode: - description: >- - Plus code (http://plus.codes) is a location reference with two formats: - global code defining a 14mx14m (1/8000th of a degree) or smaller - rectangle, and compound code, replacing the prefix with a reference - location. + properties: + endIndex: + format: int32 + type: integer + startIndex: + format: int32 + type: integer + description: The range of highlighted text. + GoogleMapsPlacesV1RoutingSummary: type: object - id: GoogleMapsPlacesV1PlacePlusCode properties: - globalCode: - type: string - description: >- - Place's global (full) code, such as "9FWM33GV+HQ", representing an - 1/8000 by 1/8000 degree area (~14 by 14 meters). - compoundCode: + legs: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummaryLeg' + type: array description: >- - Place's compound code, such as "33GV+HQ, Ramberg, Norway", - containing the suffix of the global code and replacing the prefix - with a formatted name of a reference entity. - type: string - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: + The legs of the trip. When you calculate travel duration and + distance from a set origin, `legs` contains a single leg containing + the duration and distance from the origin to the destination. When + you do a search along route, `legs` contains two legs: one from the + origin to place, and one from the place to the destination. + id: GoogleMapsPlacesV1RoutingSummary + description: >- + The duration and distance from the routing origin to a place in the + response, and a second leg from that place to the destination, if + requested. **Note:** Adding `routingSummaries` in the field mask without + also including either the `routingParameters.origin` parameter or the + `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the + request causes an error. + GoogleMapsPlacesV1SearchTextRequestLocationBias: + type: object + id: GoogleMapsPlacesV1SearchTextRequestLocationBias properties: - secondaryText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + rectangle: description: >- - Represents additional disambiguating features (such as a city or - region) to further identify the Place or refine the query. - mainText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - description: Represents the name of the Place or query. + A rectangle box defined by northeast and southwest corner. + `rectangle.high()` must be the northeast point of the rectangle + viewport. `rectangle.low()` must be the southwest point of the + rectangle viewport. `rectangle.low().latitude()` cannot be greater + than `rectangle.high().latitude()`. This will result in an empty + latitude range. A rectangle viewport cannot be wider than 180 + degrees. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + circle: + description: A circle defined by center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' description: >- - Contains a breakdown of a Place or query prediction into main text and - secondary text. For Place predictions, the main text contains the - specific name of the Place. For query predictions, the main text - contains the query. The secondary text contains additional - disambiguating features (such as a city or region) to further identify - the Place or refine the query. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + The region to search. This location serves as a bias which means results + around given location might be returned. + GoogleMapsPlacesV1FuelOptions: type: object - GoogleMapsPlacesV1ContextualContent: + id: GoogleMapsPlacesV1FuelOptions + description: >- + The most recent information about fuel options in a gas station. This + information is updated regularly. properties: - justifications: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Justifications for the place. - type: array - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification - photos: - description: >- - Information (including references) about photos of this place, - contexual to the place query. - type: array + fuelPrices: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' - reviews: - description: List of reviews about this place, contexual to the place query. + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + description: >- + The last known fuel price for each type of fuel this station has. + There is one entry per fuel type this station has. Order is not + important. + GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: + id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + type: object + properties: + review: + description: The review that the highlighted text is generated from. + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + highlightedText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText description: >- Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Content that is contextual to the place query. - type: object - id: GoogleMapsPlacesV1ContextualContent - GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: + for more details. User review justifications. This highlights a section + of the user review that would interest an end user. For instance, if the + search query is "firewood pizza", the review justification highlights + the text relevant to the search query. + GoogleMapsPlacesV1ContentBlock: + id: GoogleMapsPlacesV1ContentBlock + properties: + references: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. References that are related to this block of + content. + $ref: '#/components/schemas/GoogleMapsPlacesV1References' + topic: + type: string + description: The topic of the content, for example "overview" or "restaurant". + content: + description: Content related to the topic. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: A block of content that can be served individually. type: object + GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: properties: circle: $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by center point and radius. - description: The region to search. - id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + description: A circle defined by a center point and radius. + rectangle: + $ref: '#/components/schemas/GoogleGeoTypeViewport' + description: A viewport defined by a northeast and a southwest corner. + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias + description: >- + The region to search. The results may be biased around the specified + region. + type: object + GoogleTypeDate: + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + id: GoogleTypeDate + type: object + properties: + year: + format: int32 + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + month: + type: integer + format: int32 + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + day: + format: int32 + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer GoogleMapsPlacesV1RoutingParameters: - description: >- - Parameters to configure the routing calculations to the places in the - response, both along a route (where result ranking will be influenced) - and for calculating travel times on results. - type: object - id: GoogleMapsPlacesV1RoutingParameters properties: + travelMode: + description: Optional. The travel mode. + enum: + - TRAVEL_MODE_UNSPECIFIED + - DRIVE + - BICYCLE + - WALK + - TWO_WHEELER + enumDescriptions: + - No travel mode specified. Defaults to `DRIVE`. + - Travel by passenger car. + - >- + Travel by bicycle. Not supported with + `search_along_route_parameters`. + - >- + Travel by walking. Not supported with + `search_along_route_parameters`. + - >- + Motorized two wheeled vehicles of all kinds such as scooters and + motorcycles. Note that this is distinct from the `BICYCLE` travel + mode which covers human-powered transport. Not supported with + `search_along_route_parameters`. Only supported in those countries + listed at [Countries and regions supported for two-wheeled + vehicles](https://developers.google.com/maps/documentation/routes/coverage-two-wheeled). + type: string routeModifiers: - $ref: '#/components/schemas/GoogleMapsPlacesV1RouteModifiers' description: Optional. The route modifiers. + $ref: '#/components/schemas/GoogleMapsPlacesV1RouteModifiers' routingPreference: - enum: - - ROUTING_PREFERENCE_UNSPECIFIED - - TRAFFIC_UNAWARE - - TRAFFIC_AWARE - - TRAFFIC_AWARE_OPTIMAL type: string enumDescriptions: - No routing preference specified. Default to `TRAFFIC_UNAWARE`. @@ -1820,48 +1823,62 @@ components: attempts to use the selected routing preference to compute the route. The traffic aware routing preference is only available for the `DRIVE` or `TWO_WHEELER` `travelMode`. + enum: + - ROUTING_PREFERENCE_UNSPECIFIED + - TRAFFIC_UNAWARE + - TRAFFIC_AWARE + - TRAFFIC_AWARE_OPTIMAL origin: description: >- Optional. An explicit routing origin that overrides the origin defined in the polyline. By default, the polyline origin is used. $ref: '#/components/schemas/GoogleTypeLatLng' - travelMode: - enumDescriptions: - - No travel mode specified. Defaults to `DRIVE`. - - Travel by passenger car. - - >- - Travel by bicycle. Not supported with - `search_along_route_parameters`. - - >- - Travel by walking. Not supported with - `search_along_route_parameters`. - - >- - Motorized two wheeled vehicles of all kinds such as scooters and - motorcycles. Note that this is distinct from the `BICYCLE` travel - mode which covers human-powered transport. Not supported with - `search_along_route_parameters`. Only supported in those countries - listed at [Countries and regions supported for two-wheeled - vehicles](https://developers.google.com/maps/documentation/routes/coverage-two-wheeled). - enum: - - TRAVEL_MODE_UNSPECIFIED - - DRIVE - - BICYCLE - - WALK - - TWO_WHEELER - description: Optional. The travel mode. - type: string + description: >- + Parameters to configure the routing calculations to the places in the + response, both along a route (where result ranking will be influenced) + and for calculating travel times on results. + id: GoogleMapsPlacesV1RoutingParameters + type: object + GoogleMapsPlacesV1ContextualContent: + properties: + reviews: + type: array + description: List of reviews about this place, contexual to the place query. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + photos: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + description: >- + Information (including references) about photos of this place, + contexual to the place query. + justifications: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification + type: array + type: object + id: GoogleMapsPlacesV1ContextualContent + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Content that is contextual to the place query. GoogleMapsPlacesV1AutocompletePlacesRequest: id: GoogleMapsPlacesV1AutocompletePlacesRequest + description: Request proto for AutocompletePlaces. type: object properties: - inputOffset: - format: int32 + includeQueryPredictions: description: >- - Optional. A zero-based Unicode character offset of `input` - indicating the cursor position in `input`. The cursor position may - influence what predictions are returned. If empty, defaults to the - length of `input`. - type: integer + Optional. If true, the response will include both Place and query + predictions. Otherwise the response will only return Place + predictions. + type: boolean locationRestriction: $ref: >- #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction @@ -1871,12 +1888,6 @@ components: are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal. - origin: - description: >- - Optional. The origin point from which to calculate geodesic distance - to the destination (returned as `distance_meters`). If this value is - omitted, geodesic distance will not be returned. - $ref: '#/components/schemas/GoogleTypeLatLng' languageCode: description: >- Optional. The language in which to return results. Defaults to @@ -1886,28 +1897,13 @@ components: `language_code`. type: string regionCode: - type: string description: >- Optional. The region code, specified as a CLDR two-character region code. This affects address formatting, result ranking, and may influence what results are returned. This does not restrict results to the specified region. To restrict results to a region, use `region_code_restriction`. - locationBias: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - description: >- - Optional. Bias results to a specified location. At most one of - `location_bias` or `location_restriction` should be set. If neither - are set, the results will be biased by IP address, meaning the IP - address will be mapped to an imprecise location and used as a - biasing signal. - includeQueryPredictions: - type: boolean - description: >- - Optional. If true, the response will include both Place and query - predictions. Otherwise the response will only return Place - predictions. + type: string sessionToken: type: string description: >- @@ -1917,229 +1913,239 @@ components: error is returned. The session begins when the user starts typing a query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have - multiple queries, followed by one Place Details or Address - Validation request. The credentials used for each request within a - session must belong to the same Google Cloud Console project. Once a - session has concluded, the token is no longer valid; your app must - generate a fresh token for each session. If the `session_token` - parameter is omitted, or if you reuse a session token, the session - is charged as if no session token was provided (each request is - billed separately). We recommend the following guidelines: * Use - session tokens for all Place Autocomplete calls. * Generate a fresh - token for each session. Using a version 4 UUID is recommended. * - Ensure that the credentials used for all Place Autocomplete, Place - Details, and Address Validation requests within a session belong to - the same Cloud Console project. * Be sure to pass a unique session - token for each new session. Using the same token for more than one - session will result in each request being billed individually. - input: - description: Required. The text string on which to search. - type: string - includedRegionCodes: - type: array - description: >- - Optional. Only include results in the specified regions, specified - as up to 15 CLDR two-character region codes. An empty set will not - restrict the results. If both `location_restriction` and - `included_region_codes` are set, the results will be located in the - area of intersection. - items: - type: string - includedPrimaryTypes: - description: >- - Optional. Included primary Place type (for example, "restaurant" or - "gas_station") in Place Types - (https://developers.google.com/maps/documentation/places/web-service/place-types), - or only `(regions)`, or only `(cities)`. A Place is only returned if - its primary type is included in this list. Up to 5 values can be - specified. If no types are specified, all Place types are returned. - type: array - items: - type: string - description: Request proto for AutocompletePlaces. - GoogleMapsPlacesV1PlaceSubDestination: - id: GoogleMapsPlacesV1PlaceSubDestination - properties: - id: - type: string - description: The place id of the sub destination. - name: - type: string - description: The resource name of the sub destination. - type: object - description: >- - Place resource name and id of sub destinations that relate to the place. - For example, different terminals are different destinations of an - airport. - GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: - type: object - description: >- - The region to search. The results may be biased around the specified - region. - properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by a center point and radius. - rectangle: - description: A viewport defined by a northeast and a southwest corner. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - GoogleMapsPlacesV1AuthorAttribution: - type: object - properties: - uri: - type: string - description: URI of the author of the Photo or Review. - displayName: - type: string - description: Name of the author of the Photo or Review. - photoUri: - type: string - description: Profile photo URI of the author of the Photo or Review. - description: Information about the author of the UGC data. Used in Photo, and Review. - id: GoogleMapsPlacesV1AuthorAttribution - GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: - id: GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay - description: >- - Structured information for special days that fall within the period that - the returned opening hours cover. Special days are days that could - impact the business hours of a place, e.g. Christmas day. - type: object - properties: - date: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of this special day. - GoogleMapsPlacesV1PlaceAddressComponent: - id: GoogleMapsPlacesV1PlaceAddressComponent - properties: - shortText: - type: string - description: >- - An abbreviated textual name for the address component, if available. - For example, an address component for the country of Australia may - have a short_name of "AU". - longText: + multiple queries, followed by one Place Details or Address + Validation request. The credentials used for each request within a + session must belong to the same Google Cloud Console project. Once a + session has concluded, the token is no longer valid; your app must + generate a fresh token for each session. If the `session_token` + parameter is omitted, or if you reuse a session token, the session + is charged as if no session token was provided (each request is + billed separately). We recommend the following guidelines: * Use + session tokens for all Place Autocomplete calls. * Generate a fresh + token for each session. Using a version 4 UUID is recommended. * + Ensure that the credentials used for all Place Autocomplete, Place + Details, and Address Validation requests within a session belong to + the same Cloud Console project. * Be sure to pass a unique session + token for each new session. Using the same token for more than one + session will result in each request being billed individually. + inputOffset: + type: integer + format: int32 description: >- - The full text description or name of the address component. For - example, an address component for the country Australia may have a - long_name of "Australia". + Optional. A zero-based Unicode character offset of `input` + indicating the cursor position in `input`. The cursor position may + influence what predictions are returned. If empty, defaults to the + length of `input`. + input: + description: Required. The text string on which to search. type: string - types: + locationBias: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias + description: >- + Optional. Bias results to a specified location. At most one of + `location_bias` or `location_restriction` should be set. If neither + are set, the results will be biased by IP address, meaning the IP + address will be mapped to an imprecise location and used as a + biasing signal. + includedPrimaryTypes: type: array - description: An array indicating the type(s) of the address component. + description: >- + Optional. Included primary Place type (for example, "restaurant" or + "gas_station") in Place Types + (https://developers.google.com/maps/documentation/places/web-service/place-types), + or only `(regions)`, or only `(cities)`. A Place is only returned if + its primary type is included in this list. Up to 5 values can be + specified. If no types are specified, all Place types are returned. items: type: string - languageCode: - description: The language used to format this components, in CLDR notation. - type: string + origin: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: >- + Optional. The origin point from which to calculate geodesic distance + to the destination (returned as `distance_meters`). If this value is + omitted, geodesic distance will not be returned. + includedRegionCodes: + items: + type: string + description: >- + Optional. Only include results in the specified regions, specified + as up to 15 CLDR two-character region codes. An empty set will not + restrict the results. If both `location_restriction` and + `included_region_codes` are set, the results will be located in the + area of intersection. + type: array + GoogleMapsPlacesV1AutocompletePlacesResponse: + properties: + suggestions: + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + description: >- + Contains a list of suggestions, ordered in descending order of + relevance. + type: array type: object - description: >- - The structured components that form the formatted address, if this - information is available. + id: GoogleMapsPlacesV1AutocompletePlacesResponse + description: Response proto for AutocompletePlaces. GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction + type: object properties: circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' description: A circle defined by a center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' rectangle: $ref: '#/components/schemas/GoogleGeoTypeViewport' description: A viewport defined by a northeast and a southwest corner. - type: object - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction description: >- The region to search. The results will be restricted to the specified region. - GoogleMapsPlacesV1PlaceAccessibilityOptions: + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: properties: - wheelchairAccessibleSeating: - description: Place has wheelchair accessible seating. - type: boolean - wheelchairAccessibleRestroom: - description: Place has wheelchair accessible restroom. - type: boolean - wheelchairAccessibleEntrance: - description: Places has wheelchair accessible entrance. - type: boolean - wheelchairAccessibleParking: - type: boolean - description: Place offers wheelchair accessible parking. - id: GoogleMapsPlacesV1PlaceAccessibilityOptions + matches: + description: >- + A list of string ranges identifying where the input request matched + in `text`. The ranges can be used to format specific parts of + `text`. The substrings may not be exact matches of `input` if the + matching was determined by criteria other than string matching (for + example, spell corrections or transliterations). These values are + Unicode character offsets of `text`. The ranges are guaranteed to be + ordered in increasing offset values. + type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + text: + description: Text that may be used as is or formatted with `matches`. + type: string type: object - description: Information about the accessibility options a place offers. - GoogleTypeMoney: - id: GoogleTypeMoney - description: Represents an amount of money with its currency type. + description: >- + Text representing a Place or query prediction. The text may be used as + is or formatted. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + GoogleMapsPlacesV1PlaceGenerativeSummary: + id: GoogleMapsPlacesV1PlaceGenerativeSummary type: object + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the place. properties: - units: - format: int64 + references: + $ref: '#/components/schemas/GoogleMapsPlacesV1References' + description: References that are used to generate the summary description. + description: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The detailed description of the place. + overview: + description: The overview of the place. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + GoogleMapsPlacesV1Photo: + properties: + authorAttributions: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + type: array + description: This photo's authors. + heightPx: + description: The maximum available height, in pixels. + type: integer + format: int32 + widthPx: + type: integer + description: The maximum available width, in pixels. + format: int32 + name: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + Identifier. A reference representing this place photo which may be + used to look up this place photo again (also called the API + "resource" name: `places/{place_id}/photos/{photo}`). type: string - currencyCode: + id: GoogleMapsPlacesV1Photo + description: Information about a photo of a place. + type: object + GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters: + type: object + description: >- + Specifies a precalculated polyline from the [Routes + API](https://developers.google.com/maps/documentation/routes) defining + the route to search. Searching along a route is similar to using the + `locationBias` or `locationRestriction` request option to bias the + search results. However, while the `locationBias` and + `locationRestriction` options let you specify a region to bias the + search results, this option lets you bias the results along a trip + route. Results are not guaranteed to be along the route provided, but + rather are ranked within the search area defined by the polyline and, + optionally, by the `locationBias` or `locationRestriction` based on + minimal detour times from origin to destination. The results might be + along an alternate route, especially if the provided polyline does not + define an optimal route from origin to destination. + id: GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters + properties: + polyline: + description: Required. The route polyline. + $ref: '#/components/schemas/GoogleMapsPlacesV1Polyline' + GoogleMapsPlacesV1Polyline: + properties: + encodedPolyline: type: string - description: The three-letter currency code defined in ISO 4217. - nanos: description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - format: int32 - type: integer + An [encoded + polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), + as returned by the [Routes API by + default](https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes#polylineencoding). + See the + [encoder](https://developers.google.com/maps/documentation/utilities/polylineutility) + and + [decoder](https://developers.google.com/maps/documentation/routes/polylinedecoder) + tools. + type: object + id: GoogleMapsPlacesV1Polyline + description: >- + A route polyline. Only supports an [encoded + polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), + which can be passed as a string and includes compression with minimal + lossiness. This is the Routes API default output. GoogleMapsPlacesV1PlaceParkingOptions: - id: GoogleMapsPlacesV1PlaceParkingOptions type: object + id: GoogleMapsPlacesV1PlaceParkingOptions properties: - paidParkingLot: - type: boolean - description: Place offers paid parking lots. - freeParkingLot: + paidGarageParking: type: boolean - description: Place offers free parking lots. + description: Place offers paid garage parking. valetParking: type: boolean description: Place offers valet parking. - paidStreetParking: - type: boolean - description: Place offers paid street parking. - freeStreetParking: - description: Place offers free street parking. + paidParkingLot: type: boolean + description: Place offers paid parking lots. freeGarageParking: type: boolean description: Place offers free garage parking. - paidGarageParking: - type: boolean - description: Place offers paid garage parking. - description: >- - Information about parking options for the place. A parking lot could - support more than one option at the same time. - GoogleTypeLatLng: - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - type: object - id: GoogleTypeLatLng - properties: - latitude: - format: double - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - type: number - longitude: - type: number - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - format: double + paidStreetParking: + description: Place offers paid street parking. + type: boolean + freeStreetParking: + description: Place offers free street parking. + type: boolean + freeParkingLot: + type: boolean + description: Place offers free parking lots. + description: >- + Information about parking options for the place. A parking lot could + support more than one option at the same time. parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string _.xgafv: @@ -2151,21 +2157,6 @@ components: enum: - '1' - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string alt: description: Data format for response. in: query @@ -2176,10 +2167,28 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: upload_protocol + name: oauth_token + schema: + 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. + in: query + name: key + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser schema: type: string fields: @@ -2188,6 +2197,12 @@ components: name: fields schema: type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string access_token: description: OAuth access token. in: query @@ -2200,40 +2215,7 @@ components: name: prettyPrint schema: type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - 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. - in: query - name: key - schema: - type: string x-stackQL-resources: - photos_media: - id: google.places.photos_media - name: photos_media - title: Photos_media - methods: - get_media: - operation: - $ref: '#/paths/~1v1~1places~1{placesId}~1photos~1{photosId}~1media/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/photos_media/methods/get_media' - insert: [] - update: [] - replace: [] - delete: [] places: id: google.places.places name: places @@ -2245,6 +2227,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + search_text: + operation: + $ref: '#/paths/~1v1~1places:searchText/post' + response: + mediaType: application/json + openAPIDocKey: '200' search_nearby: operation: $ref: '#/paths/~1v1~1places:searchNearby/post' @@ -2257,36 +2245,50 @@ components: response: mediaType: application/json openAPIDocKey: '200' - search_text: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/places/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + photos_media: + id: google.places.photos_media + name: photos_media + title: Photos_media + methods: + get_media: operation: - $ref: '#/paths/~1v1~1places:searchText/post' + $ref: '#/paths/~1v1~1places~1{placesId}~1photos~1{photosId}~1media/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/places/methods/get' + - $ref: '#/components/x-stackQL-resources/photos_media/methods/get_media' insert: [] update: [] replace: [] delete: [] paths: - /v1/places/{placesId}/photos/{photosId}/media: + /v1/places/{placesId}: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' get: - description: Get a photo media with a photo reference string. - operationId: places.places.photos.getMedia + description: >- + Get the details of a place based on its resource name, which is a string + in the `places/{place_id}` format. + operationId: places.places.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2296,45 +2298,45 @@ paths: - https://www.googleapis.com/auth/maps-platform.places Oauth2c: - https://www.googleapis.com/auth/maps-platform.places + - Oauth2: + - https://www.googleapis.com/auth/maps-platform.places.details + Oauth2c: + - https://www.googleapis.com/auth/maps-platform.places.details responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1PhotoMedia' + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' parameters: - in: path name: placesId required: true schema: type: string - - in: path - name: photosId - required: true - schema: - type: string - in: query - name: maxWidthPx + name: languageCode schema: - type: integer - format: int32 + type: string - in: query - name: skipHttpRedirect + name: sessionToken schema: - type: boolean + type: string - in: query - name: maxHeightPx + name: regionCode schema: - type: integer - format: int32 - /v1/places/{placesId}: + type: string + /v1/places:searchText: parameters: *ref_1 - get: - description: >- - Get the details of a place based on its resource name, which is a string - in the `places/{place_id}` format. - operationId: places.places.get + post: + description: Text query based place search. + operationId: places.places.searchText + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2345,34 +2347,17 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.details + - https://www.googleapis.com/auth/maps-platform.places.textsearch Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.details + - https://www.googleapis.com/auth/maps-platform.places.textsearch responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - parameters: - - in: path - name: placesId - required: true - schema: - type: string - - in: query - name: regionCode - schema: - type: string - - in: query - name: sessionToken - schema: - type: string - - in: query - name: languageCode - schema: - type: string + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextResponse' + parameters: [] /v1/places:searchNearby: parameters: *ref_1 post: @@ -2436,16 +2421,11 @@ paths: $ref: >- #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse parameters: [] - /v1/places:searchText: + /v1/places/{placesId}/photos/{photosId}/media: parameters: *ref_1 - post: - description: Text query based place search. - operationId: places.places.searchText - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequest' + get: + description: Get a photo media with a photo reference string. + operationId: places.places.photos.getMedia security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2455,15 +2435,35 @@ paths: - https://www.googleapis.com/auth/maps-platform.places Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.textsearch - Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.textsearch responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextResponse' - parameters: [] + $ref: '#/components/schemas/GoogleMapsPlacesV1PhotoMedia' + parameters: + - in: path + name: placesId + required: true + schema: + type: string + - in: path + name: photosId + required: true + schema: + type: string + - in: query + name: maxWidthPx + schema: + type: integer + format: int32 + - in: query + name: maxHeightPx + schema: + type: integer + format: int32 + - in: query + name: skipHttpRedirect + schema: + type: boolean diff --git a/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml b/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml index e4b0da83..e0bc47e0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml @@ -34,76 +34,64 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + GoogleCloudPolicyanalyzerV1Activity: + id: GoogleCloudPolicyanalyzerV1Activity + description: Represents Activity on a GCP resource over specific observation period. + type: object + properties: + activityType: + description: The type of the activity. + type: string + observationPeriod: + description: The data observation period to build the activity. + $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' + fullResourceName: + type: string + description: >- + The full resource name that identifies the resource. For examples of + full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + activity: + additionalProperties: + type: any + description: Properties of the object. + type: object + description: A struct of custom fields to explain the activity. GoogleCloudPolicyanalyzerV1ObservationPeriod: - description: Represents data observation period. id: GoogleCloudPolicyanalyzerV1ObservationPeriod + description: Represents data observation period. properties: - startTime: - description: >- - The observation start time. The time in this timestamp is always - `07:00:00Z`. - format: google-datetime - type: string endTime: + format: google-datetime description: >- The observation end time. The time in this timestamp is always `07:00:00Z`. type: string + startTime: + type: string + description: >- + The observation start time. The time in this timestamp is always + `07:00:00Z`. format: google-datetime type: object GoogleCloudPolicyanalyzerV1QueryActivityResponse: + id: GoogleCloudPolicyanalyzerV1QueryActivityResponse + description: Response to the `QueryActivity` method. properties: - nextPageToken: - type: string - description: >- - If there might be more results than those appearing in this - response, then `nextPageToken` is included. To get the next set of - results, call this method again using the value of `nextPageToken` - as `pageToken`. activities: type: array items: $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1Activity' description: The set of activities that match the filter included in the request. - id: GoogleCloudPolicyanalyzerV1QueryActivityResponse - type: object - description: Response to the `QueryActivity` method. - GoogleCloudPolicyanalyzerV1Activity: - type: object - description: Represents Activity on a GCP resource over specific observation period. - id: GoogleCloudPolicyanalyzerV1Activity - properties: - fullResourceName: + nextPageToken: description: >- - The full resource name that identifies the resource. For examples of - full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - type: string - activityType: - description: The type of the activity. + If there might be more results than those appearing in this + response, then `nextPageToken` is included. To get the next set of + results, call this method again using the value of `nextPageToken` + as `pageToken`. type: string - activity: - description: A struct of custom fields to explain the activity. - type: object - additionalProperties: - description: Properties of the object. - type: any - observationPeriod: - $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' - description: The data observation period to build the activity. + type: object parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -113,12 +101,6 @@ components: name: quotaUser schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -128,12 +110,24 @@ components: name: key schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string callback: description: JSONP in: query @@ -149,12 +143,6 @@ components: enum: - '1' - '2' - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string oauth_token: description: OAuth 2.0 token for the current user. in: query @@ -171,6 +159,18 @@ components: - json - media - proto + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean x-stackQL-resources: activities: id: google.policyanalyzer.activities @@ -180,7 +180,7 @@ components: query: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1activityTypes~1{activityTypesId}~1activities:query/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1activityTypes~1{activityTypesId}~1activities:query/get response: mediaType: application/json openAPIDocKey: '200' @@ -192,22 +192,22 @@ components: replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + /v1/folders/{foldersId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/prettyPrint' get: description: Queries policy activities on Google Cloud resources. - operationId: policyanalyzer.organizations.locations.activityTypes.activities.query + operationId: policyanalyzer.folders.locations.activityTypes.activities.query security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -223,7 +223,7 @@ paths: #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -237,6 +237,11 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: @@ -245,11 +250,6 @@ paths: name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 /v1/projects/{projectsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: *ref_1 get: @@ -284,10 +284,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: @@ -297,11 +293,15 @@ paths: schema: type: integer format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: *ref_1 get: description: Queries policy activities on Google Cloud resources. - operationId: policyanalyzer.folders.locations.activityTypes.activities.query + operationId: policyanalyzer.organizations.locations.activityTypes.activities.query security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -317,7 +317,7 @@ paths: #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -331,10 +331,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: @@ -344,3 +340,7 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml b/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml index f86d7279..4afa8f05 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml @@ -35,80 +35,201 @@ components: scopes: *ref_0 schemas: GoogleCloudPolicysimulatorV1ReplayOperationMetadata: - description: Metadata about a Replay operation. properties: startTime: format: google-datetime type: string description: Time when the request was received. - id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata type: object - GoogleCloudPolicysimulatorV1AccessTuple: + description: Metadata about a Replay operation. + id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata + GoogleCloudPolicysimulatorV1ReplayResultsSummary: type: object properties: - fullResourceName: - type: string + errorCount: + type: integer + description: The number of log entries that could not be replayed. + format: int32 + unchangedCount: description: >- - Required. The full resource name that identifies the resource. For - example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - For examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - principal: + The number of replayed log entries with no difference between + baseline and simulated policies. + format: int32 + type: integer + logCount: + format: int32 + description: The total number of log entries replayed. + type: integer + oldestDate: + description: The date of the oldest log entry replayed. + $ref: '#/components/schemas/GoogleTypeDate' + newestDate: + description: The date of the newest log entry replayed. + $ref: '#/components/schemas/GoogleTypeDate' + differenceCount: description: >- - Required. The principal whose access you want to check, in the form - of the email address that represents that principal. For example, - `alice@example.com` or - `my-service-account@my-project.iam.gserviceaccount.com`. The - principal must be a Google Account or a service account. Other types - of principals are not supported. + The number of replayed log entries with a difference between + baseline and simulated policies. + type: integer + format: int32 + id: GoogleCloudPolicysimulatorV1ReplayResultsSummary + description: Summary statistics about the replayed log entries. + GoogleCloudOrgpolicyV2Policy: + description: >- + Defines an organization policy which is used to specify constraints for + configurations of Google Cloud resources. + id: GoogleCloudOrgpolicyV2Policy + properties: + etag: type: string - permission: + description: >- + Optional. An opaque tag indicating the current state of the policy, + used for concurrency control. This 'etag' is computed by the server + based on the value of other fields, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + spec: + description: Basic information about the Organization Policy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + alternate: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' + description: Deprecated. + deprecated: true + name: type: string description: >- - Required. The IAM permission to check for the specified principal - and resource. For a complete list of IAM permissions, see - https://cloud.google.com/iam/help/permissions/reference. For a - complete list of predefined IAM roles and the permissions in each - role, see https://cloud.google.com/iam/help/roles/reference. - id: GoogleCloudPolicysimulatorV1AccessTuple - description: Information about the principal, resource, and permission to check. - GoogleLongrunningListOperationsResponse: + Immutable. The resource name of the policy. Must be one of the + following forms, where `constraint_name` is the name of the + constraint which this policy configures: * + `projects/{project_number}/policies/{constraint_name}` * + `folders/{folder_id}/policies/{constraint_name}` * + `organizations/{organization_id}/policies/{constraint_name}` For + example, `projects/123/policies/compute.disableSerialPortAccess`. + Note: `projects/{project_id}/policies/{constraint_name}` is also an + acceptable name for API requests, but responses will return the name + using the equivalent project number. + dryRunSpec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: >- + Dry-run policy. Audit-only policy, can be used to monitor how the + policy would have impacted the existing and future resources if it's + enforced. type: object - id: GoogleLongrunningListOperationsResponse + GoogleIamV1Policy: + id: GoogleIamV1Policy + type: object + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). properties: - nextPageToken: - description: The standard List next-page token. + version: + type: integer + format: int32 + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + etag: + format: byte type: string - operations: description: >- - A list of operations that matches the specified filter in the - request. + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + bindings: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Binding' + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. type: array - description: The response message for Operations.ListOperations. + auditConfigs: + type: array + description: Specifies cloud audit logging configuration for this policy. + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' GoogleTypeDate: + type: object properties: - day: - format: int32 - type: integer - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. month: - type: integer description: >- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. format: int32 + type: integer year: format: int32 description: >- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. type: integer + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + type: integer description: >- Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are @@ -119,122 +240,148 @@ components: * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - type: object id: GoogleTypeDate - GoogleCloudPolicysimulatorV1ReplayConfig: - id: GoogleCloudPolicysimulatorV1ReplayConfig + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: + type: object + description: >- + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. properties: - policyOverlay: + startTime: + type: string + format: google-datetime description: >- - A mapping of the resources that you want to simulate policies for - and the policies that you want to simulate. Keys are the full - resource names for the resources. For example, - `//cloudresourcemanager.googleapis.com/projects/my-project`. For - examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - Values are Policy objects representing the policies that you want to - simulate. Replays automatically take into account any IAM policies - inherited through the resource hierarchy, and any policies set on - descendant resources. You do not need to include these policies in - the policy overlay. - additionalProperties: - $ref: '#/components/schemas/GoogleIamV1Policy' - type: object - logSource: - description: The logs to use as input for the Replay. + Time when the request started processing, i.e. when the state was + set to RUNNING. + resourcesScanned: + description: Number of resources already scanned. + format: int32 + type: integer + state: enum: - - LOG_SOURCE_UNSPECIFIED - - RECENT_ACCESSES + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + description: The current state of the operation. enumDescriptions: - - >- - An unspecified log source. If the log source is unspecified, the - Replay defaults to using `RECENT_ACCESSES`. - - >- - All access logs from the last 90 days. These logs may not include - logs from the most recent 7 days. - type: string - type: object - description: The configuration used for a Replay. - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + type: string + requestTime: + format: google-datetime + type: string + description: Time when the request was received. + resourcesFound: + format: int32 + description: >- + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + resourcesPending: + description: Number of resources still to scan. + type: integer + format: int32 + id: >- + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata + GoogleCloudPolicysimulatorV1Replay: type: object - description: The proposed changes to OrgPolicy. + description: A resource describing a `Replay`, or simulation. + id: GoogleCloudPolicysimulatorV1Replay properties: - customConstraints: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay - description: >- - Optional. The OrgPolicy CustomConstraint changes to preview - violations for. Any existing CustomConstraints with the same name - will be overridden in the simulation. That is, violations will be - determined as if all custom constraints in the overlay were - instantiated. Only a single custom_constraint is supported in the - overlay at a time. For evaluating multiple constraints, multiple - `GenerateOrgPolicyViolationsPreview` requests are made, where each - request evaluates a single constraint. - policies: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay + name: + readOnly: true + type: string description: >- - Optional. The OrgPolicy changes to preview violations for. Any - existing OrgPolicies with the same name will be overridden in the - simulation. That is, violations will be determined as if all - policies in the overlay were created or updated. - type: array - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata: + Output only. The resource name of the `Replay`, which has the + following format: + `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, + where `{resource-id}` is the ID of the project, folder, or + organization that owns the Replay. Example: + `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` + state: + type: string + description: Output only. The current state of the `Replay`. + enumDescriptions: + - Default value. This value is unused. + - The `Replay` has not started yet. + - The `Replay` is currently running. + - The `Replay` has successfully completed. + - The `Replay` has finished with an error. + readOnly: true + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + config: + description: Required. The configuration used for the `Replay`. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' + resultsSummary: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary + description: Output only. Summary statistics about the replayed log entries. + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: type: object + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + description: A change to an OrgPolicy. + properties: + policy: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + description: Optional. The new or updated OrgPolicy. + policyParent: + type: string + description: >- + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: id: >- - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata - description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts properties: - resourcesScanned: + unenforced: + description: >- + Output only. Number of resources where the constraint was not + enforced, i.e. the Policy set `enforced: false` for that resource. + readOnly: true type: integer format: int32 - description: Number of resources already scanned. - startTime: + errors: description: >- - Time when the request started processing, i.e., when the state was - set to RUNNING. - format: google-datetime - type: string - resourcesPending: + Output only. Number of resources that returned an error when + scanned. format: int32 - description: Number of resources still to scan. type: integer - resourcesFound: + readOnly: true + noncompliant: format: int32 + readOnly: true + type: integer description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending + Output only. Number of scanned resources with at least one + violation. + compliant: + description: Output only. Number of scanned resources with zero violations. type: integer - state: - type: string + format: int32 readOnly: true - description: Output only. The current state of the operation. - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - requestTime: - format: google-datetime - type: string - description: Time when the request was received. - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview: + scanned: + readOnly: true + type: integer + format: int32 + description: >- + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error + description: >- + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. type: object - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview: description: >- OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of @@ -242,14 +389,28 @@ components: ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field. + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview + type: object properties: - resourceCounts: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + createTime: description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. + Output only. Time when this `OrgPolicyViolationsPreview` was + created. + format: google-datetime + type: string + readOnly: true + violationsCount: readOnly: true + description: >- + Output only. The number of OrgPolicyViolations in this + `OrgPolicyViolationsPreview`. This count may differ from + `resource_summary.noncompliant_count` because each + OrgPolicyViolation is specific to a resource **and** constraint. If + there are multiple constraints being evaluated (i.e. multiple + policies in the overlay), a single resource may violate multiple + constraints. + format: int32 + type: integer name: readOnly: true type: string @@ -259,36 +420,8 @@ components: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` - state: - type: string - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - readOnly: true - description: Output only. The state of the `OrgPolicyViolationsPreview`. - overlay: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay - description: Required. The proposed changes we are previewing violations for. - createTime: - readOnly: true - format: google-datetime - description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. - type: string customConstraints: - items: - type: string + readOnly: true description: >- Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only @@ -299,169 +432,73 @@ components: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - readOnly: true + items: + type: string type: array - violationsCount: + resourceCounts: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts description: >- - Output only. The number of OrgPolicyViolations in this - `OrgPolicyViolationsPreview`. This count may differ from - `resource_summary.noncompliant_count` because each - OrgPolicyViolation is specific to a resource **and** constraint. If - there are multiple constraints being evaluated (i.e. multiple - policies in the overlay), a single resource may violate multiple - constraints. - type: integer + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + readOnly: true + overlay: + description: Required. The proposed changes we are previewing violations for. + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + state: + description: Output only. The state of the `OrgPolicyViolationsPreview`. readOnly: true - format: int32 - GoogleCloudPolicysimulatorV1ListReplayResultsResponse: - type: object - properties: - replayResults: - description: The results of running a Replay. - type: array - items: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayResult' - nextPageToken: type: string - description: >- - A token that you can use to retrieve the next page of ReplayResult - objects. If this field is omitted, there are no subsequent pages. - id: GoogleCloudPolicysimulatorV1ListReplayResultsResponse - description: Response message for Simulator.ListReplayResults. - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: - description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. - properties: - noncompliant: - format: int32 - readOnly: true - type: integer - description: >- - Output only. Number of scanned resources with at least one - violation. - errors: - readOnly: true - description: >- - Output only. Number of resources that returned an error when - scanned. - format: int32 - type: integer - scanned: - format: int32 - description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - type: integer - readOnly: true - compliant: - description: Output only. Number of scanned resources with zero violations. - readOnly: true - type: integer - format: int32 - unenforced: - description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. - format: int32 - readOnly: true - type: integer - type: object - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts - GoogleCloudOrgpolicyV2Policy: - type: object + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + GoogleIamV1AuditLogConfig: properties: - alternate: - description: Deprecated. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - deprecated: true - etag: + logType: + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' type: string + description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + type: array description: >- - Optional. An opaque tag indicating the current state of the policy, - used for concurrency control. This 'etag' is computed by the server - based on the value of other fields, and may be sent on update and - delete requests to ensure the client has an up-to-date value before - proceeding. - dryRunSpec: - description: >- - Dry-run policy. Audit-only policy, can be used to monitor how the - policy would have impacted the existing and future resources if it's - enforced. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Basic information about the Organization Policy. - name: - description: >- - Immutable. The resource name of the policy. Must be one of the - following forms, where `constraint_name` is the name of the - constraint which this policy configures: * - `projects/{project_number}/policies/{constraint_name}` * - `folders/{folder_id}/policies/{constraint_name}` * - `organizations/{organization_id}/policies/{constraint_name}` For - example, `projects/123/policies/compute.disableSerialPortAccess`. - Note: `projects/{project_id}/policies/{constraint_name}` is also an - acceptable name for API requests, but responses will return the name - using the equivalent project number. - type: string - id: GoogleCloudOrgpolicyV2Policy + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + items: + type: string description: >- - Defines an organization policy which is used to specify constraints for - configurations of Google Cloud resources. - GoogleCloudPolicysimulatorV1Replay: - id: GoogleCloudPolicysimulatorV1Replay - description: A resource describing a `Replay`, or simulation. - properties: - name: - type: string - readOnly: true - description: >- - Output only. The resource name of the `Replay`, which has the - following format: - `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, - where `{resource-id}` is the ID of the project, folder, or - organization that owns the Replay. Example: - `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` - config: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' - description: Required. The configuration used for the `Replay`. - resultsSummary: - readOnly: true - description: Output only. Summary statistics about the replayed log entries. - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary - state: - type: string - enumDescriptions: - - Default value. This value is unused. - - The `Replay` has not started yet. - - The `Replay` is currently running. - - The `Replay` has successfully completed. - - The `Replay` has finished with an error. - readOnly: true - description: Output only. The current state of the `Replay`. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. type: object + id: GoogleIamV1AuditLogConfig GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview: - type: object properties: - name: - type: string - readOnly: true - description: >- - Output only. The resource name of the `OrgPolicyViolationsPreview`. - It has the following format: - `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` - Example: - `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` customConstraints: + items: + type: string type: array + readOnly: true description: >- Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only @@ -472,29 +509,42 @@ components: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - readOnly: true - items: - type: string state: type: string + readOnly: true + description: Output only. The state of the `OrgPolicyViolationsPreview`. enum: - PREVIEW_STATE_UNSPECIFIED - PREVIEW_PENDING - PREVIEW_RUNNING - PREVIEW_SUCCEEDED - PREVIEW_FAILED - readOnly: true enumDescriptions: - The state is unspecified. - The OrgPolicyViolationsPreview has not been created yet. - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. - description: Output only. The state of the `OrgPolicyViolationsPreview`. - createTime: + resourceCounts: + readOnly: true + description: >- + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts + name: + readOnly: true type: string - format: google-datetime + description: >- + Output only. The resource name of the `OrgPolicyViolationsPreview`. + It has the following format: + `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` + Example: + `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` + createTime: readOnly: true + format: google-datetime + type: string description: >- Output only. Time when this `OrgPolicyViolationsPreview` was created. @@ -502,14 +552,10 @@ components: description: Required. The proposed changes we are previewing violations for. $ref: >- #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay - resourceCounts: - readOnly: true - description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts violationsCount: + readOnly: true + type: integer + format: int32 description: >- Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from @@ -518,9 +564,7 @@ components: there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints. - format: int32 - type: integer - readOnly: true + type: object description: >- OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of @@ -529,85 +573,46 @@ components: OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field. id: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview - GoogleCloudOrgpolicyV2PolicySpec: - description: >- - Defines a Google Cloud policy specification which is used to specify - constraints for configurations of Google Cloud resources. + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: + type: object + description: A change to an OrgPolicy custom constraint. properties: - rules: - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' - type: array - description: >- - In policies for boolean constraints, the following requirements - apply: - There must be one and only one policy rule where condition - is unset. - Boolean policy rules with conditions must set `enforced` - to the opposite of the policy rule without a condition. - During - policy evaluation, policy rules with conditions that are true for a - target resource take precedence. - etag: - description: >- - An opaque tag indicating the current version of the policySpec, used - for concurrency control. This field is ignored if used in a - `CreatePolicy` request. When the policy is returned from either a - `GetPolicy` or a `ListPolicies` request, this `etag` indicates the - version of the current policySpec to use when executing a - read-modify-write loop. When the policy is returned from a - `GetEffectivePolicy` request, the `etag` will be unset. - type: string - reset: - type: boolean - description: >- - Ignores policies set above this resource and restores the - `constraint_default` enforcement behavior of the specific constraint - at this resource. This field can be set in policies for either list - or boolean constraints. If set, `rules` must be empty and - `inherit_from_parent` must be set to false. - updateTime: + customConstraint: + description: Optional. The new or updated custom constraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + customConstraintParent: type: string - readOnly: true - format: google-datetime - description: >- - Output only. The time stamp this was previously updated. This - represents the last time a call to `CreatePolicy` or `UpdatePolicy` - was made for that policy. - inheritFromParent: description: >- - Determines the inheritance behavior for this policy. If - `inherit_from_parent` is true, policy rules set higher up in the - hierarchy (up to the closest root) are inherited and present in the - effective policy. If it is false, then no rules are inherited, and - this policy becomes the new root for evaluation. This field can be - set only for policies which configure list constraints. - type: boolean - type: object - id: GoogleCloudOrgpolicyV2PolicySpec - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: + Optional. Resource the constraint is attached to. Example: + "organization/987654" + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay + GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: properties: - requestTime: - type: string - format: google-datetime - description: Time when the request was received. resourcesPending: description: Number of resources still to scan. type: integer format: int32 resourcesFound: + format: int32 + type: integer description: >- Total number of resources that need scanning. Should equal resource_scanned + resources_pending - type: integer - format: int32 + startTime: + format: google-datetime + description: >- + Time when the request started processing, i.e. when the state was + set to RUNNING. + type: string state: - description: Output only. The current state of the operation. - readOnly: true + type: string + description: The current state of the operation. enumDescriptions: - The state is unspecified. - The OrgPolicyViolationsPreview has not been created yet. - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. - type: string enum: - PREVIEW_STATE_UNSPECIFIED - PREVIEW_PENDING @@ -615,57 +620,32 @@ components: - PREVIEW_SUCCEEDED - PREVIEW_FAILED resourcesScanned: - format: int32 description: Number of resources already scanned. type: integer - startTime: - description: >- - Time when the request started processing, i.e., when the state was - set to RUNNING. - type: string + format: int32 + requestTime: format: google-datetime + type: string + description: Time when the request was received. id: >- - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata + GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata type: object description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation. GoogleCloudPolicysimulatorV1ExplainedPolicy: id: GoogleCloudPolicysimulatorV1ExplainedPolicy + description: Details about how a specific IAM Policy contributed to the access check. properties: - relevance: - type: string - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - description: >- - The relevance of this policy to the overall determination in the - TroubleshootIamPolicyResponse. If the user who created the Replay - does not have access to the policy, this field is omitted. - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - bindingExplanations: - description: >- - Details about how each binding in the policy affects the principal's - ability, or inability, to use the permission for the resource. If - the user who created the Replay does not have access to the policy, - this field is omitted. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation - policy: + fullResourceName: description: >- - The IAM policy attached to the resource. If the user who created the - Replay does not have access to the policy, this field is empty. - $ref: '#/components/schemas/GoogleIamV1Policy' + The full resource name that identifies the resource. For example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + If the user who created the Replay does not have access to the + policy, this field is omitted. For examples of full resource names + for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + type: string access: enumDescriptions: - Default value. This value is unused. @@ -677,7 +657,6 @@ components: - >- The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate. - type: string description: >- Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does @@ -692,120 +671,132 @@ components: - NOT_GRANTED - UNKNOWN_CONDITIONAL - UNKNOWN_INFO_DENIED - fullResourceName: + type: string + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - The full resource name that identifies the resource. For example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - If the user who created the Replay does not have access to the - policy, this field is omitted. For examples of full resource names - for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + The IAM policy attached to the resource. If the user who created the + Replay does not have access to the policy, this field is empty. + bindingExplanations: + type: array + description: >- + Details about how each binding in the policy affects the principal's + ability, or inability, to use the permission for the resource. If + the user who created the Replay does not have access to the policy, + this field is omitted. + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation + relevance: + description: >- + The relevance of this policy to the overall determination in the + TroubleshootIamPolicyResponse. If the user who created the Replay + does not have access to the policy, this field is omitted. + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. type: string + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH type: object - description: Details about how a specific IAM Policy contributed to the access check. - GoogleCloudPolicysimulatorV1ReplayResultsSummary: - id: GoogleCloudPolicysimulatorV1ReplayResultsSummary + GoogleCloudOrgpolicyV2CustomConstraint: type: object + description: >- + A custom constraint defined by customers which can *only* be applied to + the given resource types and organization. By creating a custom + constraint, customers can apply policies of this custom constraint. + *Creating a custom constraint itself does NOT apply any policy + enforcement*. + id: GoogleCloudOrgpolicyV2CustomConstraint properties: - unchangedCount: - format: int32 + name: + type: string description: >- - The number of replayed log entries with no difference between - baseline and simulated policies. - type: integer - oldestDate: - description: The date of the oldest log entry replayed. - $ref: '#/components/schemas/GoogleTypeDate' - errorCount: - format: int32 - type: integer - description: The number of log entries that could not be replayed. - newestDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of the newest log entry replayed. - logCount: - description: The total number of log entries replayed. - format: int32 - type: integer - differenceCount: - format: int32 + Immutable. Name of the constraint. This is unique within the + organization. Format of the name should be * + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The + max length is 70 characters and the minimum length is 1. Note that + the prefix `organizations/{organization_id}/customConstraints/` is + not counted. + description: + type: string description: >- - The number of replayed log entries with a difference between - baseline and simulated policies. - type: integer - description: Summary statistics about the replayed log entries. - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: - properties: - resourcesPending: - description: Number of resources still to scan. - format: int32 - type: integer - state: + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + actionType: type: string - description: The current state of the operation. - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - requestTime: - description: Time when the request was received. + - ACTION_TYPE_UNSPECIFIED + - ALLOW + - DENY + enumDescriptions: + - Unspecified. Results in an error. + - Allowed action type. + - Deny action type. + description: Allow or deny type. + methodTypes: + type: array + description: All the operations being applied for this constraint. + items: + enum: + - METHOD_TYPE_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + - REMOVE_GRANT + - GOVERN_TAGS + enumDescriptions: + - Unspecified. Results in an error. + - Constraint applied when creating the resource. + - Constraint applied when updating the resource. + - >- + Constraint applied when deleting the resource. Not supported + yet. + - Constraint applied when removing an IAM grant. + - Constraint applied when enforcing forced tagging. + type: string + updateTime: type: string - format: google-datetime - startTime: + readOnly: true format: google-datetime description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. + Output only. The last time this custom constraint was updated. This + represents the last time that the `CreateCustomConstraint` or + `UpdateCustomConstraint` RPC was called + condition: type: string - resourcesFound: description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - type: integer - format: int32 - resourcesScanned: - description: Number of resources already scanned. - type: integer - format: int32 - description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - type: object - id: >- - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata - GoogleCloudOrgpolicyV2PolicySpecPolicyRule: - properties: - values: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - description: >- - List of values to be used for this policy rule. This field can be - set only in policies for list constraints. - denyAll: - type: boolean - description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. - allowAll: + Org policy condition/expression. For example: + `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, + `resource.management.auto_upgrade == true` The max length of the + condition is 1000 characters. + resourceTypes: + type: array description: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - type: boolean - enforce: - type: boolean + Immutable. The resource instance type on which this policy applies. + Format will be of the form : `/` Example: * + `compute.googleapis.com/Instance`. + items: + type: string + displayName: + type: string description: >- - If `true`, then the policy is enforced. If `false`, then any - configuration is acceptable. This field can be set only in policies - for boolean constraints. + One line display name for the UI. The max length of the display_name + is 200 characters. + GoogleCloudOrgpolicyV2PolicySpecPolicyRule: + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule + properties: condition: + $ref: '#/components/schemas/GoogleTypeExpr' description: >- A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the @@ -817,38 +808,106 @@ components: and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". - $ref: '#/components/schemas/GoogleTypeExpr' - description: A rule used to express this policy. + denyAll: + description: >- + Setting this to true means that all values are denied. This field + can be set only in policies for list constraints. + type: boolean + enforce: + type: boolean + description: >- + If `true`, then the policy is enforced. If `false`, then any + configuration is acceptable. This field can be set only in policies + for boolean constraints. + allowAll: + type: boolean + description: >- + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. + values: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + description: >- + List of values to be used for this policy rule. This field can be + set only in policies for list constraints. type: object - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule - GoogleCloudPolicysimulatorV1ExplainedAccess: - description: >- - Details about how a set of policies, listed in ExplainedPolicy, resulted - in a certain AccessState when replaying an access tuple. - id: GoogleCloudPolicysimulatorV1ExplainedAccess + description: A rule used to express this policy. + GoogleLongrunningListOperationsResponse: + description: The response message for Operations.ListOperations. type: object properties: - policies: - type: array + operations: + description: >- + A list of operations that matches the specified filter in the + request. items: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array + nextPageToken: + description: The standard List next-page token. + type: string + id: GoogleLongrunningListOperationsResponse + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: + properties: + errors: + format: int32 + type: integer description: >- - If the AccessState is `UNKNOWN`, this field contains the policies - that led to that result. If the `AccessState` is `GRANTED` or - `NOT_GRANTED`, this field is omitted. + Output only. Number of resources that returned an error when + scanned. + readOnly: true + unenforced: + readOnly: true + format: int32 + type: integer + description: >- + Output only. Number of resources where the constraint was not + enforced, i.e. the Policy set `enforced: false` for that resource. + scanned: + description: >- + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error + readOnly: true + type: integer + format: int32 + compliant: + description: Output only. Number of scanned resources with zero violations. + type: integer + format: int32 + readOnly: true + noncompliant: + description: >- + Output only. Number of scanned resources with at least one + violation. + readOnly: true + format: int32 + type: integer + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + type: object + description: >- + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. + GoogleCloudPolicysimulatorV1ExplainedAccess: + type: object + id: GoogleCloudPolicysimulatorV1ExplainedAccess + properties: errors: + type: array description: >- If the AccessState is `UNKNOWN`, this field contains a list of errors explaining why the result is `UNKNOWN`. If the `AccessState` is `GRANTED` or `NOT_GRANTED`, this field is omitted. items: $ref: '#/components/schemas/GoogleRpcStatus' + policies: + items: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' + description: >- + If the AccessState is `UNKNOWN`, this field contains the policies + that led to that result. If the `AccessState` is `GRANTED` or + `NOT_GRANTED`, this field is omitted. type: array accessState: - type: string - description: >- - Whether the principal in the access tuple has permission to access - the resource in the access tuple under the given policies. enumDescriptions: - Default value. This value is unused. - The principal has the permission. @@ -859,276 +918,145 @@ components: - >- The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate. + description: >- + Whether the principal in the access tuple has permission to access + the resource in the access tuple under the given policies. + type: string enum: - ACCESS_STATE_UNSPECIFIED - GRANTED - NOT_GRANTED - UNKNOWN_CONDITIONAL - UNKNOWN_INFO_DENIED - GoogleIamV1Policy: + description: >- + Details about how a set of policies, listed in ExplainedPolicy, resulted + in a certain AccessState when replaying an access tuple. + GoogleRpcStatus: properties: - version: - description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - format: int32 + code: type: integer - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - type: array - bindings: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: type: array description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. items: - $ref: '#/components/schemas/GoogleIamV1Binding' - etag: - format: byte + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + GoogleCloudPolicysimulatorV1AccessTuple: + id: GoogleCloudPolicysimulatorV1AccessTuple + type: object + description: Information about the principal, resource, and permission to check. + properties: + permission: + description: >- + Required. The IAM permission to check for the specified principal + and resource. For a complete list of IAM permissions, see + https://cloud.google.com/iam/help/permissions/reference. For a + complete list of predefined IAM roles and the permissions in each + role, see https://cloud.google.com/iam/help/roles/reference. type: string + principal: description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - id: GoogleIamV1Policy - type: object - GoogleLongrunningOperation: - properties: - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - name: + Required. The principal whose access you want to check, in the form + of the email address that represents that principal. For example, + `alice@example.com` or + `my-service-account@my-project.iam.gserviceaccount.com`. The + principal must be a Google Account or a service account. Other types + of principals are not supported. type: string + fullResourceName: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - id: GoogleLongrunningOperation - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleCloudPolicysimulatorV1AccessStateDiff: - description: >- - A summary and comparison of the principal's access under the current - (baseline) policies and the proposed (simulated) policies for a single - access tuple. - id: GoogleCloudPolicysimulatorV1AccessStateDiff + Required. The full resource name that identifies the resource. For + example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + For examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + type: string + GoogleCloudPolicysimulatorV1ReplayConfig: + description: The configuration used for a Replay. type: object + id: GoogleCloudPolicysimulatorV1ReplayConfig properties: - simulated: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' - description: >- - The results of evaluating the access tuple under the proposed - (simulated) policies. If the AccessState couldn't be fully - evaluated, this field explains why. - baseline: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + policyOverlay: description: >- - The results of evaluating the access tuple under the current - (baseline) policies. If the AccessState couldn't be fully evaluated, - this field explains why. - accessChange: + A mapping of the resources that you want to simulate policies for + and the policies that you want to simulate. Keys are the full + resource names for the resources. For example, + `//cloudresourcemanager.googleapis.com/projects/my-project`. For + examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + Values are Policy objects representing the policies that you want to + simulate. Replays automatically take into account any IAM policies + inherited through the resource hierarchy, and any policies set on + descendant resources. You do not need to include these policies in + the policy overlay. + additionalProperties: + $ref: '#/components/schemas/GoogleIamV1Policy' + type: object + logSource: + enum: + - LOG_SOURCE_UNSPECIFIED + - RECENT_ACCESSES + description: The logs to use as input for the Replay. enumDescriptions: - - Default value. This value is unused. - - >- - The principal's access did not change. This includes the case - where both baseline and simulated are UNKNOWN, but the unknown - information is equivalent. - - >- - The principal's access under both the current policies and the - proposed policies is `UNKNOWN`, but the unknown information - differs between them. - - >- - The principal had access under the current policies (`GRANTED`), - but will no longer have access after the proposed changes - (`NOT_GRANTED`). - - >- - The principal did not have access under the current policies - (`NOT_GRANTED`), but will have access after the proposed changes - (`GRANTED`). - >- - This result can occur for the following reasons: * The principal - had access under the current policies (`GRANTED`), but their - access after the proposed changes is `UNKNOWN`. * The principal's - access under the current policies is `UNKNOWN`, but they will not - have access after the proposed changes (`NOT_GRANTED`). + An unspecified log source. If the log source is unspecified, the + Replay defaults to using `RECENT_ACCESSES`. - >- - This result can occur for the following reasons: * The principal - did not have access under the current policies (`NOT_GRANTED`), - but their access after the proposed changes is `UNKNOWN`. * The - principal's access under the current policies is `UNKNOWN`, but - they will have access after the proposed changes (`GRANTED`). + All access logs from the last 90 days. These logs may not include + logs from the most recent 7 days. type: string - enum: - - ACCESS_CHANGE_TYPE_UNSPECIFIED - - NO_CHANGE - - UNKNOWN_CHANGE - - ACCESS_REVOKED - - ACCESS_GAINED - - ACCESS_MAYBE_REVOKED - - ACCESS_MAYBE_GAINED - description: >- - How the principal's access, specified in the AccessState field, - changed between the current (baseline) policies and proposed - (simulated) policies. - GoogleCloudPolicysimulatorV1BindingExplanation: - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. - id: GoogleCloudPolicysimulatorV1BindingExplanation + GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: properties: - access: - description: >- - Required. Indicates whether _this binding_ provides the specified - permission to the specified principal for the specified resource. - This field does _not_ indicate whether the principal actually has - the permission for the resource. There might be another binding that - overrides this binding. To determine whether the principal actually - has the permission, use the `access` field in the - TroubleshootIamPolicyResponse. - type: string - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. + membership: enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - rolePermission: + - MEMBERSHIP_UNSPECIFIED + - MEMBERSHIP_INCLUDED + - MEMBERSHIP_NOT_INCLUDED + - MEMBERSHIP_UNKNOWN_INFO_DENIED + - MEMBERSHIP_UNKNOWN_UNSUPPORTED + description: Indicates whether the binding includes the principal. enumDescriptions: - Default value. This value is unused. - - The permission is included in the role. - - The permission is not included in the role. + - >- + The binding includes the principal. The principal can be included + directly or indirectly. For example: * A principal is included + directly if that principal is listed in the binding. * A principal + is included indirectly if that principal is in a Google group or + Google Workspace domain that is listed in the binding. + - The binding does not include the principal. - >- The user who created the Replay is not allowed to access the binding. - enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED - type: string - description: >- - Indicates whether the role granted by this binding contains the - specified permission. - role: - description: >- - The role that this binding grants. For example, - `roles/compute.serviceAgent`. For a complete list of predefined IAM - roles, as well as the permissions in each role, see - https://cloud.google.com/iam/help/roles/reference. + - >- + The principal is an unsupported type. Only Google Accounts and + service accounts are supported. type: string relevance: + description: >- + The relevance of the principal's status to the overall determination + for the binding. enumDescriptions: - Default value. This value is unused. - >- @@ -1137,112 +1065,295 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. + type: string enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL - HIGH - type: string + id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership + type: object + description: Details about whether the binding includes the principal. + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay: + properties: + customConstraints: + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay description: >- - The relevance of this binding to the overall determination for the - entire policy. - memberships: + Optional. The OrgPolicy CustomConstraint changes to preview + violations for. Any existing CustomConstraints with the same name + will be overridden in the simulation. That is, violations will be + determined as if all custom constraints in the overlay were + instantiated. Only a single custom_constraint is supported in the + overlay at a time. For evaluating multiple constraints, multiple + `GenerateOrgPolicyViolationsPreview` requests are made, where each + request evaluates a single constraint. + type: array + policies: description: >- - Indicates whether each principal in the binding includes the - principal specified in the request, either directly or indirectly. - Each key identifies a principal in the binding, and each value - indicates whether the principal in the binding includes the - principal in the request. For example, suppose that a binding - includes the following principals: * `user:alice@example.com` * - `group:product-eng@example.com` The principal in the replayed access - tuple is `user:bob@example.com`. This user is a principal of the - group `group:product-eng@example.com`. For the first principal in - the binding, the key is `user:alice@example.com`, and the - `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. - For the second principal in the binding, the key is - `group:product-eng@example.com`, and the `membership` field in the - value is set to `MEMBERSHIP_INCLUDED`. - type: object - additionalProperties: + Optional. The OrgPolicy changes to preview violations for. Any + existing OrgPolicies with the same name will be overridden in the + simulation. That is, violations will be determined as if all + policies in the overlay were created or updated. + items: $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership - condition: - $ref: '#/components/schemas/GoogleTypeExpr' + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + type: array + description: The proposed changes to OrgPolicy. + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + type: object + GoogleCloudOrgpolicyV2AlternatePolicySpec: + properties: + spec: + description: Specify constraint for configurations of Google Cloud resources. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + launch: description: >- - A condition expression that prevents this binding from granting - access unless the expression evaluates to `true`. To learn about IAM - Conditions, see - https://cloud.google.com/iam/docs/conditions-overview. - rolePermissionRelevance: - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. + Reference to the launch that will be used while audit logging and to + control the launch. Should be set only in the alternate policy. type: string + id: GoogleCloudOrgpolicyV2AlternatePolicySpec + type: object + description: >- + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run/darklaunch. + GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata: + id: >- + GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata + properties: + requestTime: + format: google-datetime + description: Time when the request was received. + type: string + resourcesFound: + format: int32 description: >- - The relevance of the permission's existence, or nonexistence, in the - role to the overall determination for the entire policy. + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + state: + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + type: string + description: Output only. The current state of the operation. + readOnly: true + resourcesScanned: + description: Number of resources already scanned. + format: int32 + type: integer + startTime: + description: >- + Time when the request started processing, i.e., when the state was + set to RUNNING. + format: google-datetime + type: string + resourcesPending: + description: Number of resources still to scan. + type: integer + format: int32 + description: >- + CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. type: object - GoogleIamV1AuditConfig: + GoogleCloudOrgpolicyV2PolicySpec: + id: GoogleCloudOrgpolicyV2PolicySpec + properties: + etag: + description: >- + An opaque tag indicating the current version of the policySpec, used + for concurrency control. This field is ignored if used in a + `CreatePolicy` request. When the policy is returned from either a + `GetPolicy` or a `ListPolicies` request, this `etag` indicates the + version of the current policySpec to use when executing a + read-modify-write loop. When the policy is returned from a + `GetEffectivePolicy` request, the `etag` will be unset. + type: string + inheritFromParent: + type: boolean + description: >- + Determines the inheritance behavior for this policy. If + `inherit_from_parent` is true, policy rules set higher up in the + hierarchy (up to the closest root) are inherited and present in the + effective policy. If it is false, then no rules are inherited, and + this policy becomes the new root for evaluation. This field can be + set only for policies which configure list constraints. + updateTime: + description: >- + Output only. The time stamp this was previously updated. This + represents the last time a call to `CreatePolicy` or `UpdatePolicy` + was made for that policy. + readOnly: true + format: google-datetime + type: string + rules: + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + description: >- + In policies for boolean constraints, the following requirements + apply: - There must be one and only one policy rule where condition + is unset. - Boolean policy rules with conditions must set `enforced` + to the opposite of the policy rule without a condition. - During + policy evaluation, policy rules with conditions that are true for a + target resource take precedence. + type: array + reset: + type: boolean + description: >- + Ignores policies set above this resource and restores the + `constraint_default` enforcement behavior of the specific constraint + at this resource. This field can be set in policies for either list + or boolean constraints. If set, `rules` must be empty and + `inherit_from_parent` must be set to false. + description: >- + Defines a Google Cloud policy specification which is used to specify + constraints for configurations of Google Cloud resources. + type: object + GoogleCloudPolicysimulatorV1ReplayDiff: + id: GoogleCloudPolicysimulatorV1ReplayDiff type: object - id: GoogleIamV1AuditConfig properties: - auditLogConfigs: + accessDiff: + description: >- + A summary and comparison of the principal's access under the current + (baseline) policies and the proposed (simulated) policies for a + single access tuple. The evaluation of the principal's access is + reported in the AccessState field. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessStateDiff' + description: >- + The difference between the results of evaluating an access tuple under + the current (baseline) policies and under the proposed (simulated) + policies. This difference explains how a principal's access could change + if the proposed policies were applied. + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: + description: The proposed changes to OrgPolicy. + type: object + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + properties: + customConstraints: + description: >- + Optional. The OrgPolicy CustomConstraint changes to preview + violations for. Any existing CustomConstraints with the same name + will be overridden in the simulation. That is, violations will be + determined as if all custom constraints in the overlay were + instantiated. Only a single custom_constraint is supported in the + overlay at a time. For evaluating multiple constraints, multiple + `GenerateOrgPolicyViolationsPreview` requests are made, where each + request evaluates a single constraint. + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay + type: array + policies: + type: array + description: >- + Optional. The OrgPolicy changes to preview violations for. Any + existing OrgPolicies with the same name will be overridden in the + simulation. That is, violations will be determined as if all + policies in the overlay were created or updated. + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay + GoogleCloudPolicysimulatorV1ListReplayResultsResponse: + description: Response message for Simulator.ListReplayResults. + id: GoogleCloudPolicysimulatorV1ListReplayResultsResponse + type: object + properties: + nextPageToken: + type: string + description: >- + A token that you can use to retrieve the next page of ReplayResult + objects. If this field is omitted, there are no subsequent pages. + replayResults: + description: The results of running a Replay. type: array items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - description: The configuration for logging of each type of permission. - service: - description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - type: string - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayResult' + GoogleLongrunningOperation: type: object - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation properties: - policyParent: + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + done: + type: boolean description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" - policy: - description: Optional. The new or updated OrgPolicy. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: A change to an OrgPolicy. - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: - id: >- - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata - description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: properties: + resourcesPending: + type: integer + format: int32 + description: Number of resources still to scan. + requestTime: + description: Time when the request was received. + type: string + format: google-datetime + resourcesScanned: + type: integer + description: Number of resources already scanned. + format: int32 + resourcesFound: + description: >- + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + format: int32 + startTime: + description: >- + Time when the request started processing, i.e., when the state was + set to RUNNING. + type: string + format: google-datetime state: enum: - PREVIEW_STATE_UNSPECIFIED @@ -1250,128 +1361,170 @@ components: - PREVIEW_RUNNING - PREVIEW_SUCCEEDED - PREVIEW_FAILED - type: string enumDescriptions: - The state is unspecified. - The OrgPolicyViolationsPreview has not been created yet. - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. - description: The current state of the operation. - resourcesFound: - type: integer - format: int32 - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - resourcesPending: - format: int32 - description: Number of resources still to scan. - type: integer - resourcesScanned: - format: int32 - type: integer - description: Number of resources already scanned. - requestTime: - description: Time when the request was received. - type: string - format: google-datetime - startTime: - description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. - format: google-datetime - type: string - type: object - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay - properties: - customConstraint: - description: Optional. The new or updated custom constraint. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - customConstraintParent: + readOnly: true + description: Output only. The current state of the operation. type: string - description: >- - Optional. Resource the constraint is attached to. Example: - "organization/987654" - description: A change to an OrgPolicy custom constraint. + id: >- + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata + description: >- + CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. type: object - GoogleRpcStatus: - id: GoogleRpcStatus + GoogleCloudPolicysimulatorV1AccessStateDiff: type: object + id: GoogleCloudPolicysimulatorV1AccessStateDiff + description: >- + A summary and comparison of the principal's access under the current + (baseline) policies and the proposed (simulated) policies for a single + access tuple. properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: + accessChange: + description: >- + How the principal's access, specified in the AccessState field, + changed between the current (baseline) policies and proposed + (simulated) policies. + enum: + - ACCESS_CHANGE_TYPE_UNSPECIFIED + - NO_CHANGE + - UNKNOWN_CHANGE + - ACCESS_REVOKED + - ACCESS_GAINED + - ACCESS_MAYBE_REVOKED + - ACCESS_MAYBE_GAINED + enumDescriptions: + - Default value. This value is unused. + - >- + The principal's access did not change. This includes the case + where both baseline and simulated are UNKNOWN, but the unknown + information is equivalent. + - >- + The principal's access under both the current policies and the + proposed policies is `UNKNOWN`, but the unknown information + differs between them. + - >- + The principal had access under the current policies (`GRANTED`), + but will no longer have access after the proposed changes + (`NOT_GRANTED`). + - >- + The principal did not have access under the current policies + (`NOT_GRANTED`), but will have access after the proposed changes + (`GRANTED`). + - >- + This result can occur for the following reasons: * The principal + had access under the current policies (`GRANTED`), but their + access after the proposed changes is `UNKNOWN`. * The principal's + access under the current policies is `UNKNOWN`, but they will not + have access after the proposed changes (`NOT_GRANTED`). + - >- + This result can occur for the following reasons: * The principal + did not have access under the current policies (`NOT_GRANTED`), + but their access after the proposed changes is `UNKNOWN`. * The + principal's access under the current policies is `UNKNOWN`, but + they will have access after the proposed changes (`GRANTED`). type: string + simulated: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + The results of evaluating the access tuple under the proposed + (simulated) policies. If the AccessState couldn't be fully + evaluated, this field explains why. + baseline: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + The results of evaluating the access tuple under the current + (baseline) policies. If the AccessState couldn't be fully evaluated, + this field explains why. GoogleCloudPolicysimulatorV1ReplayResult: + type: object description: The result of replaying a single access tuple against a simulated state. id: GoogleCloudPolicysimulatorV1ReplayResult properties: diff: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayDiff' description: >- The difference between the principal's access under the current (baseline) policies and the principal's access under the proposed (simulated) policies. This field is only included for access tuples that were successfully replayed and had different results under the current policies and the proposed policies. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayDiff' + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error that caused the access tuple replay to fail. This field is + only included for access tuples that were not replayed successfully. + lastSeenDate: + description: The latest date this access tuple was seen in the logs. + $ref: '#/components/schemas/GoogleTypeDate' accessTuple: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' description: >- The access tuple that was replayed. This field includes information about the principal, resource, and permission that were involved in the access attempt. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' - lastSeenDate: - description: The latest date this access tuple was seen in the logs. - $ref: '#/components/schemas/GoogleTypeDate' name: - type: string description: >- The resource name of the `ReplayResult`, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234` - parent: type: string + parent: description: The Replay that the access tuple was included in. - error: - $ref: '#/components/schemas/GoogleRpcStatus' + type: string + GoogleIamV1AuditConfig: + properties: + auditLogConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + description: The configuration for logging of each type of permission. + service: + type: string description: >- - The error that caused the access tuple replay to fail. This field is - only included for access tuples that were not replayed successfully. + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. type: object + id: GoogleIamV1AuditConfig + description: >- + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. GoogleIamV1Binding: - id: GoogleIamV1Binding - type: object description: Associates `members`, or principals, with a `role`. properties: + role: + type: string + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). members: + type: array description: >- Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A @@ -1433,7 +1586,6 @@ components: `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. items: type: string - type: array condition: description: >- The condition that is associated with this binding. If the condition @@ -1445,41 +1597,73 @@ components: their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). $ref: '#/components/schemas/GoogleTypeExpr' - role: + type: object + id: GoogleIamV1Binding + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: + properties: + policy: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + description: Optional. The new or updated OrgPolicy. + policyParent: type: string description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - GoogleCloudPolicysimulatorV1ReplayDiff: - id: GoogleCloudPolicysimulatorV1ReplayDiff + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay type: object + description: A change to an OrgPolicy. + GoogleTypeExpr: description: >- - The difference between the results of evaluating an access tuple under - the current (baseline) policies and under the proposed (simulated) - policies. This difference explains how a principal's access could change - if the proposed policies were applied. + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. + id: GoogleTypeExpr + type: object properties: - accessDiff: + description: description: >- - A summary and comparison of the principal's access under the current - (baseline) policies and the proposed (simulated) policies for a - single access tuple. The evaluation of the principal's access is - reported in the AccessState field. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessStateDiff' - GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + type: string + title: + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + location: + type: string + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + expression: + type: string + description: >- + Textual representation of an expression in Common Expression + Language syntax. + GoogleCloudPolicysimulatorV1BindingExplanation: + description: >- + Details about how a binding in a policy affects a principal's ability to + use a permission. properties: - relevance: + rolePermissionRelevance: enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL - HIGH - description: >- - The relevance of the principal's status to the overall determination - for the binding. enumDescriptions: - Default value. This value is unused. - >- @@ -1489,147 +1673,107 @@ components: The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. type: string - membership: - description: Indicates whether the binding includes the principal. + description: >- + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. + memberships: + description: >- + Indicates whether each principal in the binding includes the + principal specified in the request, either directly or indirectly. + Each key identifies a principal in the binding, and each value + indicates whether the principal in the binding includes the + principal in the request. For example, suppose that a binding + includes the following principals: * `user:alice@example.com` * + `group:product-eng@example.com` The principal in the replayed access + tuple is `user:bob@example.com`. This user is a principal of the + group `group:product-eng@example.com`. For the first principal in + the binding, the key is `user:alice@example.com`, and the + `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. + For the second principal in the binding, the key is + `group:product-eng@example.com`, and the `membership` field in the + value is set to `MEMBERSHIP_INCLUDED`. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership + relevance: type: string + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + description: >- + The relevance of this binding to the overall determination for the + entire policy. enumDescriptions: - Default value. This value is unused. - >- - The binding includes the principal. The principal can be included - directly or indirectly. For example: * A principal is included - directly if that principal is listed in the binding. * A principal - is included indirectly if that principal is in a Google group or - Google Workspace domain that is listed in the binding. - - The binding does not include the principal. - - >- - The user who created the Replay is not allowed to access the - binding. + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. - >- - The principal is an unsupported type. Only Google Accounts and - service accounts are supported. + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + access: enum: - - MEMBERSHIP_UNSPECIFIED - - MEMBERSHIP_INCLUDED - - MEMBERSHIP_NOT_INCLUDED - - MEMBERSHIP_UNKNOWN_INFO_DENIED - - MEMBERSHIP_UNKNOWN_UNSUPPORTED - description: Details about whether the binding includes the principal. - id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership - type: object - GoogleTypeExpr: - id: GoogleTypeExpr - properties: - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - description: - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - location: - type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - type: object - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay - properties: - customConstraint: - description: Optional. The new or updated custom constraint. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - customConstraintParent: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. type: string description: >- - Optional. Resource the constraint is attached to. Example: - "organization/987654" - description: A change to an OrgPolicy custom constraint. - type: object - GoogleCloudOrgpolicyV2AlternatePolicySpec: - properties: - spec: - description: Specify constraint for configurations of Google Cloud resources. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - launch: + Required. Indicates whether _this binding_ provides the specified + permission to the specified principal for the specified resource. + This field does _not_ indicate whether the principal actually has + the permission for the resource. There might be another binding that + overrides this binding. To determine whether the principal actually + has the permission, use the `access` field in the + TroubleshootIamPolicyResponse. + condition: description: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. + A condition expression that prevents this binding from granting + access unless the expression evaluates to `true`. To learn about IAM + Conditions, see + https://cloud.google.com/iam/docs/conditions-overview. + $ref: '#/components/schemas/GoogleTypeExpr' + role: + description: >- + The role that this binding grants. For example, + `roles/compute.serviceAgent`. For a complete list of predefined IAM + roles, as well as the permissions in each role, see + https://cloud.google.com/iam/help/roles/reference. type: string - type: object - description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. - id: GoogleCloudOrgpolicyV2AlternatePolicySpec - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: - description: A change to an OrgPolicy. - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay - type: object - properties: - policyParent: + rolePermission: description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" + Indicates whether the role granted by this binding contains the + specified permission. + enumDescriptions: + - Default value. This value is unused. + - The permission is included in the role. + - The permission is not included in the role. + - >- + The user who created the Replay is not allowed to access the + binding. type: string - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay: + enum: + - ROLE_PERMISSION_UNSPECIFIED + - ROLE_PERMISSION_INCLUDED + - ROLE_PERMISSION_NOT_INCLUDED + - ROLE_PERMISSION_UNKNOWN_INFO_DENIED type: object - description: The proposed changes to OrgPolicy. - properties: - policies: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay - description: >- - Optional. The OrgPolicy changes to preview violations for. Any - existing OrgPolicies with the same name will be overridden in the - simulation. That is, violations will be determined as if all - policies in the overlay were created or updated. - type: array - customConstraints: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay - type: array - description: >- - Optional. The OrgPolicy CustomConstraint changes to preview - violations for. Any existing CustomConstraints with the same name - will be overridden in the simulation. That is, violations will be - determined as if all custom constraints in the overlay were - instantiated. Only a single custom_constraint is supported in the - overlay at a time. For evaluating multiple constraints, multiple - `GenerateOrgPolicyViolationsPreview` requests are made, where each - request evaluates a single constraint. - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + id: GoogleCloudPolicysimulatorV1BindingExplanation GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + type: object description: >- A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource @@ -1644,198 +1788,32 @@ components: `organizations/` (for example, `organizations/1234`) The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. - type: object + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues properties: deniedValues: - type: array - items: - type: string description: List of values denied at this resource. - allowedValues: - description: List of values allowed at this resource. type: array items: type: string - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: - id: >- - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts - description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. - type: object - properties: - scanned: - description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - type: integer - format: int32 - readOnly: true - unenforced: - readOnly: true - description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. - type: integer - format: int32 - errors: - format: int32 - readOnly: true - description: >- - Output only. Number of resources that returned an error when - scanned. - type: integer - noncompliant: - readOnly: true - format: int32 - type: integer - description: >- - Output only. Number of scanned resources with at least one - violation. - compliant: - format: int32 - description: Output only. Number of scanned resources with zero violations. - readOnly: true - type: integer - GoogleCloudOrgpolicyV2CustomConstraint: - id: GoogleCloudOrgpolicyV2CustomConstraint - properties: - condition: - type: string - description: >- - Org policy condition/expression. For example: - `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, - `resource.management.auto_upgrade == true` The max length of the - condition is 1000 characters. - actionType: - enumDescriptions: - - Unspecified. Results in an error. - - Allowed action type. - - Deny action type. - enum: - - ACTION_TYPE_UNSPECIFIED - - ALLOW - - DENY - description: Allow or deny type. - type: string - resourceTypes: - items: - type: string - type: array - description: >- - Immutable. The resource instance type on which this policy applies. - Format will be of the form : `/` Example: * - `compute.googleapis.com/Instance`. - displayName: - description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. - type: string - methodTypes: - description: All the operations being applied for this constraint. + allowedValues: items: - enumDescriptions: - - Unspecified. Results in an error. - - Constraint applied when creating the resource. - - Constraint applied when updating the resource. - - >- - Constraint applied when deleting the resource. Not supported - yet. - - Constraint applied when removing an IAM grant. - - Constraint applied when enforcing forced tagging. type: string - enum: - - METHOD_TYPE_UNSPECIFIED - - CREATE - - UPDATE - - DELETE - - REMOVE_GRANT - - GOVERN_TAGS + description: List of values allowed at this resource. type: array - name: - type: string - description: >- - Immutable. Name of the constraint. This is unique within the - organization. Format of the name should be * - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The - max length is 70 characters and the minimum length is 1. Note that - the prefix `organizations/{organization_id}/customConstraints/` is - not counted. - updateTime: - readOnly: true - format: google-datetime - type: string - description: >- - Output only. The last time this custom constraint was updated. This - represents the last time that the `CreateCustomConstraint` or - `UpdateCustomConstraint` RPC was called - description: - type: string - description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. - type: object - description: >- - A custom constraint defined by customers which can *only* be applied to - the given resource types and organization. By creating a custom - constraint, customers can apply policies of this custom constraint. - *Creating a custom constraint itself does NOT apply any policy - enforcement*. - GoogleIamV1AuditLogConfig: - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - id: GoogleIamV1AuditLogConfig + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: properties: - exemptedMembers: - items: - type: string - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - logType: - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ + customConstraintParent: + description: >- + Optional. Resource the constraint is attached to. Example: + "organization/987654" type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - description: The log type that this config enables. + customConstraint: + description: Optional. The new or updated custom constraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' type: object + description: A change to an OrgPolicy custom constraint. + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -1845,12 +1823,24 @@ components: enum: - '1' - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: upload_protocol + name: fields + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -1860,10 +1850,10 @@ components: name: key schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string callback: @@ -1872,12 +1862,28 @@ components: name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + alt: + description: Data format for response. in: query - name: prettyPrint + name: alt schema: - type: boolean + type: string + enum: + - json + - media + - proto + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -1887,247 +1893,243 @@ components: name: quotaUser schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string x-stackQL-resources: - results: - id: google.policysimulator.results - name: results - title: Results + replays: + id: google.policysimulator.replays + name: replays + title: Replays methods: - organizations_locations_replays_results_list: + organizations_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.replayResults - projects_locations_replays_results_list: + organizations_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.replayResults - folders_locations_replays_results_list: + folders_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.replayResults - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/results/methods/organizations_locations_replays_results_list - - $ref: >- - #/components/x-stackQL-resources/results/methods/projects_locations_replays_results_list - - $ref: >- - #/components/x-stackQL-resources/results/methods/folders_locations_replays_results_list - insert: [] - update: [] - replace: [] - delete: [] - operations: - id: google.policysimulator.operations - name: operations - title: Operations - methods: - organizations_locations_replays_operations_get: + folders_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_operations_list: + projects_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - organizations_locations_org_policy_violations_previews_operations_get: + projects_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_operations_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_get + - $ref: >- + #/components/x-stackQL-resources/replays/methods/folders_locations_replays_get + - $ref: >- + #/components/x-stackQL-resources/replays/methods/projects_locations_replays_get + insert: + - $ref: >- + #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_create + - $ref: >- + #/components/x-stackQL-resources/replays/methods/folders_locations_replays_create + - $ref: >- + #/components/x-stackQL-resources/replays/methods/projects_locations_replays_create + update: [] + replace: [] + delete: [] + results: + id: google.policysimulator.results + name: results + title: Results + methods: + organizations_locations_replays_results_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_operations_list: + objectKey: $.replayResults + folders_locations_replays_results_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - projects_locations_org_policy_violations_previews_operations_get: + objectKey: $.replayResults + projects_locations_replays_results_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_operations_list: + objectKey: $.replayResults + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/results/methods/organizations_locations_replays_results_list + - $ref: >- + #/components/x-stackQL-resources/results/methods/folders_locations_replays_results_list + - $ref: >- + #/components/x-stackQL-resources/results/methods/projects_locations_replays_results_list + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.policysimulator.operations + name: operations + title: Operations + methods: + organizations_locations_replays_operations_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - folders_locations_replays_operations_get: + organizations_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_org_policy_violations_previews_operations_get: + organizations_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' operations_get: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - operations_list: - operation: - $ref: '#/paths/~1v1~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_org_policy_violations_previews_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_org_policy_violations_previews_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_org_policy_violations_previews_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_list - - $ref: '#/components/x-stackQL-resources/operations/methods/operations_get' - - $ref: >- - #/components/x-stackQL-resources/operations/methods/operations_list - insert: [] - update: [] - replace: [] - delete: [] - replays: - id: google.policysimulator.replays - name: replays - title: Replays - methods: - organizations_locations_replays_create: - operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + operations_list: + operation: + $ref: '#/paths/~1v1~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + folders_locations_replays_operations_list: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_get: + objectKey: $.operations + folders_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_create: + folders_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_get: + projects_locations_replays_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_create: + objectKey: $.operations + projects_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_get: + projects_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_get + #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_get - $ref: >- - #/components/x-stackQL-resources/replays/methods/projects_locations_replays_get + #/components/x-stackQL-resources/operations/methods/organizations_locations_org_policy_violations_previews_operations_get - $ref: >- - #/components/x-stackQL-resources/replays/methods/folders_locations_replays_get - insert: + #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_get - $ref: >- - #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_create + #/components/x-stackQL-resources/operations/methods/folders_locations_org_policy_violations_previews_operations_get - $ref: >- - #/components/x-stackQL-resources/replays/methods/projects_locations_replays_create + #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get - $ref: >- - #/components/x-stackQL-resources/replays/methods/folders_locations_replays_create + #/components/x-stackQL-resources/operations/methods/projects_locations_org_policy_violations_previews_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_list + - $ref: '#/components/x-stackQL-resources/operations/methods/operations_get' + - $ref: >- + #/components/x-stackQL-resources/operations/methods/operations_list + insert: [] update: [] replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' get: - description: Lists the results of running a Replay. - operationId: policysimulator.organizations.locations.replays.results.list + description: >- + Gets the specified Replay. Each `Replay` is available for at least 7 + days. + operationId: policysimulator.organizations.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2139,8 +2141,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path name: organizationsId @@ -2157,23 +2158,44 @@ paths: required: true schema: type: string - - in: query - name: pageToken + /v1/organizations/{organizationsId}/locations/{locationsId}/replays: + parameters: *ref_1 + post: + description: Creates and starts a Replay using the given ReplayConfig. + operationId: policysimulator.organizations.locations.replays.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: locationsId + required: true schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_1 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. - operationId: policysimulator.organizations.locations.replays.operations.get + description: Lists the results of running a Replay. + operationId: policysimulator.organizations.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2185,7 +2207,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path name: organizationsId @@ -2202,9 +2225,13 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: @@ -2243,28 +2270,26 @@ paths: schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query name: pageToken schema: type: string - in: query - name: filter + name: pageSize schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays: + type: integer + format: int32 + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.organizations.locations.replays.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + 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. + operationId: policysimulator.organizations.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2288,13 +2313,25 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: + - in: path + name: replaysId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.organizations.locations.replays.get + 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. + operationId: >- + policysimulator.organizations.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2306,7 +2343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -2319,19 +2356,23 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/operations/{operationsId}: parameters: *ref_1 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. - operationId: >- - policysimulator.organizations.locations.orgPolicyViolationsPreviews.operations.get + operationId: policysimulator.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2346,35 +2387,48 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId + name: operationsId required: true schema: type: string - - in: path - name: locationsId - required: true + /v1/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: query + name: pageSize schema: - type: string - - in: path - name: orgPolicyViolationsPreviewsId - required: true + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays: + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_1 - post: - description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.projects.locations.replays.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + get: + description: Lists the results of running a Replay. + operationId: policysimulator.folders.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2386,10 +2440,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2398,13 +2453,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: + - in: path + name: replaysId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_1 get: description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.projects.locations.replays.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.folders.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2416,10 +2485,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2433,14 +2502,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: policysimulator.projects.locations.replays.operations.get + operationId: policysimulator.folders.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2455,7 +2537,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2474,13 +2556,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.projects.locations.replays.operations.list + Gets the specified Replay. Each `Replay` is available for at least 7 + days. + operationId: policysimulator.folders.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2492,10 +2574,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2509,24 +2591,16 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/folders/{foldersId}/locations/{locationsId}/replays: parameters: *ref_1 - get: - description: Lists the results of running a Replay. - operationId: policysimulator.projects.locations.replays.results.list + post: + description: Creates and starts a Replay using the given ReplayConfig. + operationId: policysimulator.folders.locations.replays.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2538,11 +2612,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2551,21 +2624,7 @@ paths: required: true schema: type: string - - in: path - name: replaysId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- @@ -2573,7 +2632,7 @@ paths: method to poll the operation result at intervals as recommended by the API service. operationId: >- - policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get + policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2588,7 +2647,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2607,11 +2666,11 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays: + /v1/projects/{projectsId}/locations/{locationsId}/replays: parameters: *ref_1 post: description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.folders.locations.replays.create + operationId: policysimulator.projects.locations.replays.create requestBody: content: application/json: @@ -2631,7 +2690,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2640,13 +2699,13 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_1 get: description: >- Gets the specified Replay. Each `Replay` is available for at least 7 days. - operationId: policysimulator.folders.locations.replays.get + operationId: policysimulator.projects.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2661,7 +2720,7 @@ paths: $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2675,13 +2734,11 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.folders.locations.replays.operations.list + description: Lists the results of running a Replay. + operationId: policysimulator.projects.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2693,10 +2750,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2710,10 +2768,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: @@ -2723,14 +2777,13 @@ paths: schema: type: integer format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_1 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. - operationId: policysimulator.folders.locations.replays.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.projects.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2742,10 +2795,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2759,63 +2812,27 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: - parameters: *ref_1 - get: - description: Lists the results of running a Replay. - operationId: policysimulator.folders.locations.replays.results.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: replaysId - required: true + type: integer + format: int32 + - in: query + name: filter schema: type: string - in: query name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: >- - policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get + operationId: policysimulator.projects.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2830,7 +2847,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2840,7 +2857,7 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string @@ -2849,14 +2866,15 @@ paths: required: true schema: type: string - /v1/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: *ref_1 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. - operationId: policysimulator.operations.get + operationId: >- + policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2871,40 +2889,22 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: operationsId + name: projectsId required: true schema: type: string - /v1/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: orgPolicyViolationsPreviewsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: operationsId + required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml b/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml index ceaa150d..84c4d34f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml @@ -34,200 +34,78 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: - description: Response for TroubleshootIamPolicy. + GoogleTypeExpr: + id: GoogleTypeExpr + description: >- + Represents a textual expression in the Common Expression Language (CEL) + syntax. CEL is a C-like expression language. The syntax and semantics of + CEL are documented at https://github.com/google/cel-spec. Example + (Comparison): title: "Summary size limit" description: "Determines if a + summary is less than 100 chars" expression: "document.summary.size() < + 100" Example (Equality): title: "Requestor is owner" description: + "Determines if requestor is the document owner" expression: + "document.owner == request.auth.claims.email" Example (Logic): title: + "Public documents" description: "Determine whether the document should + be publicly visible" expression: "document.type != 'private' && + document.type != 'internal'" Example (Data Manipulation): title: + "Notification string" description: "Create a notification string with a + timestamp." expression: "'New message received at ' + + string(document.create_time)" The exact variables and functions that may + be referenced within an expression are determined by the service that + evaluates it. See the service documentation for additional information. type: object - id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse properties: - explainedPolicies: - description: >- - List of IAM policies that were evaluated to check the principal's - permissions, with annotations to indicate how each policy - contributed to the final result. The list of policies can include - the policy for the resource itself. It can also include policies - that are inherited from higher levels of the resource hierarchy, - including the organization, the folder, and the project. To learn - more about the resource hierarchy, see - https://cloud.google.com/iam/help/resource-hierarchy. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy - access: - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The sender of the request does not have access to all of the - policies that Policy Troubleshooter needs to evaluate. - description: >- - Indicates whether the principal has the specified permission for the - specified resource, based on evaluating all of the applicable IAM - policies. + description: type: string - errors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The general errors contained in the troubleshooting response. - type: array - GoogleRpcStatus: - properties: - message: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + title: type: string - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - id: GoogleRpcStatus - GoogleCloudPolicytroubleshooterV1BindingExplanation: - type: object - properties: - relevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH description: >- - The relevance of this binding to the overall determination for the - entire policy. - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + location: type: string - memberships: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership - type: object description: >- - Indicates whether each principal in the binding includes the - principal specified in the request, either directly or indirectly. - Each key identifies a principal in the binding, and each value - indicates whether the principal in the binding includes the - principal in the request. For example, suppose that a binding - includes the following principals: * `user:alice@example.com` * - `group:product-eng@example.com` You want to troubleshoot access for - `user:bob@example.com`. This user is a principal of the group - `group:product-eng@example.com`. For the first principal in the - binding, the key is `user:alice@example.com`, and the `membership` - field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the - second principal in the binding, the key is - `group:product-eng@example.com`, and the `membership` field in the - value is set to `MEMBERSHIP_INCLUDED`. - role: + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + expression: type: string description: >- - The role that this binding grants. For example, - `roles/compute.serviceAgent`. For a complete list of predefined IAM - roles, as well as the permissions in each role, see - https://cloud.google.com/iam/help/roles/reference. - access: + Textual representation of an expression in Common Expression + Language syntax. + GoogleCloudPolicytroubleshooterV1AccessTuple: + properties: + fullResourceName: + type: string description: >- - Required. Indicates whether _this binding_ provides the specified - permission to the specified principal for the specified resource. - This field does _not_ indicate whether the principal actually has - the permission for the resource. There might be another binding that - overrides this binding. To determine whether the principal actually - has the permission, use the `access` field in the - TroubleshootIamPolicyResponse. - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The sender of the request does not have access to all of the - policies that Policy Troubleshooter needs to evaluate. + Required. The full resource name that identifies the resource. For + example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + For examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + permission: type: string - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - condition: - $ref: '#/components/schemas/GoogleTypeExpr' description: >- - A condition expression that prevents this binding from granting - access unless the expression evaluates to `true`. To learn about IAM - Conditions, see - https://cloud.google.com/iam/help/conditions/overview. - rolePermission: - enumDescriptions: - - Default value. This value is unused. - - The permission is included in the role. - - The permission is not included in the role. - - The sender of the request is not allowed to access the binding. - enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED + Required. The IAM permission to check for the specified principal + and resource. For a complete list of IAM permissions, see + https://cloud.google.com/iam/help/permissions/reference. For a + complete list of predefined IAM roles and the permissions in each + role, see https://cloud.google.com/iam/help/roles/reference. + principal: description: >- - Indicates whether the role granted by this binding contains the - specified permission. - type: string - rolePermissionRelevance: + Required. The principal whose access you want to check, in the form + of the email address that represents that principal. For example, + `alice@example.com` or + `my-service-account@my-project.iam.gserviceaccount.com`. The + principal must be a Google Account or a service account. Other types + of principals are not supported. type: string - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: >- - The relevance of the permission's existence, or nonexistence, in the - role to the overall determination for the entire policy. - id: GoogleCloudPolicytroubleshooterV1BindingExplanation - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. + id: GoogleCloudPolicytroubleshooterV1AccessTuple + description: Information about the principal, resource, and permission to check. + type: object GoogleIamV1Policy: description: >- An Identity and Access Management (IAM) policy, which specifies access @@ -264,10 +142,27 @@ components: For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). properties: + version: + type: integer + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + format: int32 bindings: - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - type: array description: >- Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when @@ -278,6 +173,9 @@ components: For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + type: array auditConfigs: description: Specifies cloud audit logging configuration for this policy. type: array @@ -299,103 +197,275 @@ components: the conditions in the version `3` policy are lost. type: string format: byte - version: - format: int32 - type: integer - description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: object id: GoogleIamV1Policy - GoogleIamV1AuditLogConfig: - id: GoogleIamV1AuditLogConfig type: object + GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: + description: Details about whether the binding includes the principal. + type: object + id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership properties: - exemptedMembers: + membership: + description: Indicates whether the binding includes the principal. + enum: + - MEMBERSHIP_UNSPECIFIED + - MEMBERSHIP_INCLUDED + - MEMBERSHIP_NOT_INCLUDED + - MEMBERSHIP_UNKNOWN_INFO_DENIED + - MEMBERSHIP_UNKNOWN_UNSUPPORTED + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + The binding includes the principal. The principal can be included + directly or indirectly. For example: * A principal is included + directly if that principal is listed in the binding. * A principal + is included indirectly if that principal is in a Google group or + Google Workspace domain that is listed in the binding. + - The binding does not include the principal. + - The sender of the request is not allowed to access the binding. + - >- + The principal is an unsupported type. Only Google Accounts and + service accounts are supported. + relevance: + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - items: - type: string - type: array + The relevance of the principal's status to the overall determination + for the binding. + type: string + GoogleIamV1AuditLogConfig: + properties: logType: type: string - description: The log type that this config enables. - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ enumDescriptions: - Default case. Should never be this. - 'Admin reads. Example: CloudIAM getIamPolicy' - 'Data writes. Example: CloudSQL Users create' - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + description: The log type that this config enables. + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + items: + type: string + type: array + type: object description: >- Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. - GoogleCloudPolicytroubleshooterV1AccessTuple: - description: Information about the principal, resource, and permission to check. - id: GoogleCloudPolicytroubleshooterV1AccessTuple + id: GoogleIamV1AuditLogConfig + GoogleIamV1Binding: + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. + properties: + members: + description: >- + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + items: + type: string + type: array + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + condition: + $ref: '#/components/schemas/GoogleTypeExpr' + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: object + GoogleIamV1AuditConfig: + properties: + service: + type: string + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + auditLogConfigs: + type: array + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + description: >- + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + type: object + id: GoogleIamV1AuditConfig + GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: + id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse type: object + description: Response for TroubleshootIamPolicy. properties: - fullResourceName: + access: + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The sender of the request does not have access to all of the + policies that Policy Troubleshooter needs to evaluate. description: >- - Required. The full resource name that identifies the resource. For - example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - For examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - type: string - principal: + Indicates whether the principal has the specified permission for the + specified resource, based on evaluating all of the applicable IAM + policies. type: string + errors: + type: array + description: The general errors contained in the troubleshooting response. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + explainedPolicies: description: >- - Required. The principal whose access you want to check, in the form - of the email address that represents that principal. For example, - `alice@example.com` or - `my-service-account@my-project.iam.gserviceaccount.com`. The - principal must be a Google Account or a service account. Other types - of principals are not supported. - permission: - description: >- - Required. The IAM permission to check for the specified principal - and resource. For a complete list of IAM permissions, see - https://cloud.google.com/iam/help/permissions/reference. For a - complete list of predefined IAM roles and the permissions in each - role, see https://cloud.google.com/iam/help/roles/reference. - type: string + List of IAM policies that were evaluated to check the principal's + permissions, with annotations to indicate how each policy + contributed to the final result. The list of policies can include + the policy for the resource itself. It can also include policies + that are inherited from higher levels of the resource hierarchy, + including the organization, the folder, and the project. To learn + more about the resource hierarchy, see + https://cloud.google.com/iam/help/resource-hierarchy. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy GoogleCloudPolicytroubleshooterV1ExplainedPolicy: - type: object + description: Details about how a specific IAM Policy contributed to the access check. id: GoogleCloudPolicytroubleshooterV1ExplainedPolicy + type: object properties: bindingExplanations: - type: array description: >- Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted. + type: array items: $ref: >- #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation + fullResourceName: + type: string + description: >- + The full resource name that identifies the resource. For example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + If the sender of the request does not have access to the policy, + this field is omitted. For examples of full resource names for + Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. relevance: + type: string enumDescriptions: - Default value. This value is unused. - >- @@ -404,15 +474,14 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH description: >- The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted. - type: string + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH access: description: >- Indicates whether _this policy_ provides the specified permission to @@ -444,74 +513,115 @@ components: description: >- The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty. - fullResourceName: - type: string + GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest: + description: Request for TroubleshootIamPolicy. + properties: + accessTuple: + $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' description: >- - The full resource name that identifies the resource. For example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - If the sender of the request does not have access to the policy, - this field is omitted. For examples of full resource names for - Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - description: Details about how a specific IAM Policy contributed to the access check. - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig + The information to use for checking whether a principal has a + permission for a resource. + type: object + id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest + GoogleCloudPolicytroubleshooterV1BindingExplanation: type: object + id: GoogleCloudPolicytroubleshooterV1BindingExplanation description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. + Details about how a binding in a policy affects a principal's ability to + use a permission. properties: - service: + role: + description: >- + The role that this binding grants. For example, + `roles/compute.serviceAgent`. For a complete list of predefined IAM + roles, as well as the permissions in each role, see + https://cloud.google.com/iam/help/roles/reference. + type: string + rolePermissionRelevance: type: string + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - auditLogConfigs: - description: The configuration for logging of each type of permission. - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - type: array - GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: - type: object - properties: - membership: + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. + access: + description: >- + Required. Indicates whether _this binding_ provides the specified + permission to the specified principal for the specified resource. + This field does _not_ indicate whether the principal actually has + the permission for the resource. There might be another binding that + overrides this binding. To determine whether the principal actually + has the permission, use the `access` field in the + TroubleshootIamPolicyResponse. + type: string enumDescriptions: - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. - >- - The binding includes the principal. The principal can be included - directly or indirectly. For example: * A principal is included - directly if that principal is listed in the binding. * A principal - is included indirectly if that principal is in a Google group or - Google Workspace domain that is listed in the binding. - - The binding does not include the principal. - - The sender of the request is not allowed to access the binding. + The principal has the permission only if a condition expression + evaluates to `true`. - >- - The principal is an unsupported type. Only Google Accounts and - service accounts are supported. + The sender of the request does not have access to all of the + policies that Policy Troubleshooter needs to evaluate. enum: - - MEMBERSHIP_UNSPECIFIED - - MEMBERSHIP_INCLUDED - - MEMBERSHIP_NOT_INCLUDED - - MEMBERSHIP_UNKNOWN_INFO_DENIED - - MEMBERSHIP_UNKNOWN_UNSUPPORTED - description: Indicates whether the binding includes the principal. + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + condition: + description: >- + A condition expression that prevents this binding from granting + access unless the expression evaluates to `true`. To learn about IAM + Conditions, see + https://cloud.google.com/iam/help/conditions/overview. + $ref: '#/components/schemas/GoogleTypeExpr' + memberships: + description: >- + Indicates whether each principal in the binding includes the + principal specified in the request, either directly or indirectly. + Each key identifies a principal in the binding, and each value + indicates whether the principal in the binding includes the + principal in the request. For example, suppose that a binding + includes the following principals: * `user:alice@example.com` * + `group:product-eng@example.com` You want to troubleshoot access for + `user:bob@example.com`. This user is a principal of the group + `group:product-eng@example.com`. For the first principal in the + binding, the key is `user:alice@example.com`, and the `membership` + field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the + second principal in the binding, the key is + `group:product-eng@example.com`, and the `membership` field in the + value is set to `MEMBERSHIP_INCLUDED`. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership + type: object + rolePermission: + description: >- + Indicates whether the role granted by this binding contains the + specified permission. type: string + enum: + - ROLE_PERMISSION_UNSPECIFIED + - ROLE_PERMISSION_INCLUDED + - ROLE_PERMISSION_NOT_INCLUDED + - ROLE_PERMISSION_UNKNOWN_INFO_DENIED + enumDescriptions: + - Default value. This value is unused. + - The permission is included in the role. + - The permission is not included in the role. + - The sender of the request is not allowed to access the binding. relevance: enum: - HEURISTIC_RELEVANCE_UNSPECIFIED @@ -519,8 +629,8 @@ components: - HIGH type: string description: >- - The relevance of the principal's status to the overall determination - for the binding. + The relevance of this binding to the overall determination for the + entire policy. enumDescriptions: - Default value. This value is unused. - >- @@ -529,155 +639,70 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - description: Details about whether the binding includes the principal. - id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership - GoogleTypeExpr: + GoogleRpcStatus: + id: GoogleRpcStatus properties: - description: - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string - location: - type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - title: + code: + type: integer + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + message: description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - type: object - id: GoogleTypeExpr - description: >- - Represents a textual expression in the Common Expression Language (CEL) - syntax. CEL is a C-like expression language. The syntax and semantics of - CEL are documented at https://github.com/google/cel-spec. Example - (Comparison): title: "Summary size limit" description: "Determines if a - summary is less than 100 chars" expression: "document.summary.size() < - 100" Example (Equality): title: "Requestor is owner" description: - "Determines if requestor is the document owner" expression: - "document.owner == request.auth.claims.email" Example (Logic): title: - "Public documents" description: "Determine whether the document should - be publicly visible" expression: "document.type != 'private' && - document.type != 'internal'" Example (Data Manipulation): title: - "Notification string" description: "Create a notification string with a - timestamp." expression: "'New message received at ' + - string(document.create_time)" The exact variables and functions that may - be referenced within an expression are determined by the service that - evaluates it. See the service documentation for additional information. - GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest: - properties: - accessTuple: - $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' - description: >- - The information to use for checking whether a principal has a - permission for a resource. - description: Request for TroubleshootIamPolicy. - type: object - id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest - GoogleIamV1Binding: - id: GoogleIamV1Binding - properties: - members: - type: array + details: items: - type: string - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - condition: - $ref: '#/components/schemas/GoogleTypeExpr' + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - description: Associates `members`, or principals, with a `role`. parameters: - access_token: - description: OAuth access token. + _.xgafv: + description: V1 error format. in: query - name: access_token + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + alt: + description: Data format for response. + in: query + name: alt schema: type: string + enum: + - json + - media + - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -687,10 +712,10 @@ components: name: quotaUser schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string oauth_token: @@ -699,13 +724,10 @@ components: name: oauth_token schema: 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. + access_token: + description: OAuth access token. in: query - name: key + name: access_token schema: type: string fields: @@ -714,43 +736,21 @@ components: name: fields schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - alt: - description: Data format for response. + 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. in: query - name: alt + name: key schema: type: string - enum: - - json - - media - - proto callback: description: JSONP in: query name: callback schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' x-stackQL-resources: iam: id: google.policytroubleshooter.iam @@ -772,17 +772,17 @@ components: paths: /v1/iam:troubleshoot: parameters: - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' post: description: >- Checks whether a principal has a specific permission for a specific diff --git a/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml b/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml index c6bf9045..ec333a96 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml @@ -34,169 +34,73 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Color: + HttpBody: + id: HttpBody type: object description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... - id: Color - properties: - alpha: - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - type: number - format: float - blue: - type: number - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - red: - type: number - description: The amount of red in the color as a value in the interval [0, 1]. - format: float - green: - format: float - type: number - description: The amount of green in the color as a value in the interval [0, 1]. - PlantDescription: - description: >- - Contains general information about plants, including details on their - seasonality, special shapes and colors, information about allergic - cross-reactions, and plant photos. + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. properties: - specialColors: - type: string - description: >- - Textual description of the plants' colors of leaves, bark, flowers - or seeds that helps identify the plant. - crossReaction: - description: >- - Textual description of pollen cross reaction plants. Example: Alder, - Hazel, Hornbeam, Beech, Willow, and Oak pollen. - type: string - picture: - description: Link to the picture of the plant. - type: string - season: - type: string + contentType: description: >- - Textual list of explanations of seasons where the pollen is active. - Example: "Late winter, spring". - pictureCloseup: - description: Link to a closeup picture of the plant. - type: string - specialShapes: + The HTTP Content-Type header value specifying the content type of + the body. type: string - description: >- - Textual description of the plants' shapes of leaves, bark, flowers - or seeds that helps identify the plant. - family: + data: type: string + format: byte + description: The HTTP request/response body as raw binary. + extensions: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - A human readable representation of the plant family name. Example: - "Betulaceae (the Birch family)". - type: - description: >- - The plant's pollen type. For example: "GRASS". A list of all - available codes could be found here. - type: string - enum: - - POLLEN_TYPE_UNSPECIFIED - - GRASS - - TREE - - WEED - enumDescriptions: - - Unspecified plant type. - - Grass pollen type. - - Tree pollen type. - - Weed pollen type. - type: object - id: PlantDescription + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array IndexInfo: - type: object id: IndexInfo + type: object description: >- This object contains data representing specific pollen index value, category and description. properties: - value: - description: The index's numeric score. Numeric range is between 0 and 5. - format: int32 - type: integer - color: - description: The color used to represent the Pollen Index numeric score. - $ref: '#/components/schemas/Color' indexDescription: type: string description: Textual explanation of current index level. category: + type: string description: >- Text classification of index numerical score interpretation. The index consists of six categories: * 0: "None" * 1: "Very low" * 2: "Low" * 3: "Moderate" * 4: "High" * 5: "Very high - type: string + value: + description: The index's numeric score. Numeric range is between 0 and 5. + format: int32 + type: integer displayName: - type: string description: >- A human readable representation of the index name. Example: "Universal Pollen Index". + type: string code: enum: - INDEX_UNSPECIFIED @@ -204,128 +108,54 @@ components: enumDescriptions: - Unspecified index. - Universal Pollen Index. - type: string description: >- The index's code. This field represents the index for programming purposes by using snake cases instead of spaces. Example: "UPI". + type: string + color: + $ref: '#/components/schemas/Color' + description: The color used to represent the Pollen Index numeric score. DayInfo: + type: object + description: >- + This object contains the daily forecast information for each day + requested. + id: DayInfo properties: pollenTypeInfo: + type: array items: $ref: '#/components/schemas/PollenTypeInfo' - type: array description: >- This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request. + date: + $ref: '#/components/schemas/Date' + description: The date in UTC at which the pollen forecast data is represented. plantInfo: description: >- This list will include up to 15 pollen species affecting the location specified in the request. - type: array items: $ref: '#/components/schemas/PlantInfo' - date: - description: The date in UTC at which the pollen forecast data is represented. - $ref: '#/components/schemas/Date' - id: DayInfo - description: >- - This object contains the daily forecast information for each day - requested. - type: object - PollenTypeInfo: - description: >- - This object contains the pollen type index and health recommendation - information on specific pollen type. - properties: - inSeason: - type: boolean - description: Indication whether the plant is in season or not. - code: - enumDescriptions: - - Unspecified plant type. - - Grass pollen type. - - Tree pollen type. - - Weed pollen type. - enum: - - POLLEN_TYPE_UNSPECIFIED - - GRASS - - TREE - - WEED - type: string - description: 'The pollen type''s code name. For example: "GRASS"' - indexInfo: - description: Contains the Universal Pollen Index (UPI) data for the pollen type. - $ref: '#/components/schemas/IndexInfo' - healthRecommendations: - description: >- - Textual list of explanations, related to health insights based on - the current pollen levels. - items: - type: string - type: array - displayName: - description: >- - A human readable representation of the pollen type name. Example: - "Grass" - type: string - id: PollenTypeInfo - type: object - LookupForecastResponse: - id: LookupForecastResponse - type: object - properties: - regionCode: - description: >- - The ISO_3166-1 alpha-2 code of the country/region corresponding to - the location provided in the request. This field might be omitted - from the response if the location provided in the request resides in - a disputed territory. - type: string - dailyInfo: - items: - $ref: '#/components/schemas/DayInfo' - description: >- - Required. This object contains the daily forecast information for - each day requested. type: array - nextPageToken: - type: string - description: Optional. The token to retrieve the next page. PlantInfo: properties: + plantDescription: + $ref: '#/components/schemas/PlantDescription' + description: >- + Contains general information about plants, including details on + their seasonality, special shapes and colors, information about + allergic cross-reactions, and plant photos. displayName: - type: string description: >- A human readable representation of the plant name. Example: “Cottonwood". - indexInfo: - $ref: '#/components/schemas/IndexInfo' - description: >- - This object contains data representing specific pollen index value, - category and description. + type: string code: description: >- The plant code name. For example: "COTTONWOOD". A list of all available codes could be found here. - enum: - - PLANT_UNSPECIFIED - - ALDER - - ASH - - BIRCH - - COTTONWOOD - - ELM - - MAPLE - - OLIVE - - JUNIPER - - OAK - - PINE - - CYPRESS_PINE - - HAZEL - - GRAMINALES - - RAGWEED - - MUGWORT - - JAPANESE_CEDAR - - JAPANESE_CYPRESS type: string enumDescriptions: - Unspecified plant code. @@ -346,106 +176,264 @@ components: - Mugwort is classified as a weed pollen type. - Japanese cedar is classified as a tree pollen type. - Japanese cypress is classified as a tree pollen type. - plantDescription: - $ref: '#/components/schemas/PlantDescription' - description: >- - Contains general information about plants, including details on - their seasonality, special shapes and colors, information about - allergic cross-reactions, and plant photos. + enum: + - PLANT_UNSPECIFIED + - ALDER + - ASH + - BIRCH + - COTTONWOOD + - ELM + - MAPLE + - OLIVE + - JUNIPER + - OAK + - PINE + - CYPRESS_PINE + - HAZEL + - GRAMINALES + - RAGWEED + - MUGWORT + - JAPANESE_CEDAR + - JAPANESE_CYPRESS inSeason: - type: boolean description: Indication of either the plant is in season or not. + type: boolean + indexInfo: + $ref: '#/components/schemas/IndexInfo' + description: >- + This object contains data representing specific pollen index value, + category and description. description: This object contains the daily information on specific plant. type: object - id: PlantInfo - Date: - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + id: PlantInfo + Date: + id: Date + type: object + properties: + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + type: integer + month: + type: integer + format: int32 + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + PollenTypeInfo: + type: object + description: >- + This object contains the pollen type index and health recommendation + information on specific pollen type. + properties: + healthRecommendations: + description: >- + Textual list of explanations, related to health insights based on + the current pollen levels. + type: array + items: + type: string + displayName: + description: >- + A human readable representation of the pollen type name. Example: + "Grass" + type: string + code: + enum: + - POLLEN_TYPE_UNSPECIFIED + - GRASS + - TREE + - WEED + enumDescriptions: + - Unspecified plant type. + - Grass pollen type. + - Tree pollen type. + - Weed pollen type. + type: string + description: 'The pollen type''s code name. For example: "GRASS"' + indexInfo: + description: Contains the Universal Pollen Index (UPI) data for the pollen type. + $ref: '#/components/schemas/IndexInfo' + inSeason: + type: boolean + description: Indication whether the plant is in season or not. + id: PollenTypeInfo + Color: + properties: + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + type: number + alpha: + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + green: + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + type: number + red: + format: float + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + type: object + id: Color + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + PlantDescription: + type: object properties: - month: + specialColors: + type: string description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - format: int32 - day: - format: int32 + Textual description of the plants' colors of leaves, bark, flowers + or seeds that helps identify the plant. + specialShapes: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - year: + Textual description of the plants' shapes of leaves, bark, flowers + or seeds that helps identify the plant. + type: string + family: + type: string description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 - id: Date - type: object - HttpBody: - properties: - contentType: + A human readable representation of the plant family name. Example: + "Betulaceae (the Birch family)". + type: + description: >- + The plant's pollen type. For example: "GRASS". A list of all + available codes could be found here. + enum: + - POLLEN_TYPE_UNSPECIFIED + - GRASS + - TREE + - WEED + enumDescriptions: + - Unspecified plant type. + - Grass pollen type. + - Tree pollen type. + - Weed pollen type. type: string + season: description: >- - The HTTP Content-Type header value specifying the content type of - the body. - data: + Textual list of explanations of seasons where the pollen is active. + Example: "Late winter, spring". type: string - description: The HTTP request/response body as raw binary. - format: byte - extensions: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + crossReaction: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - type: array - type: object - id: HttpBody + Textual description of pollen cross reaction plants. Example: Alder, + Hazel, Hornbeam, Beech, Willow, and Oak pollen. + type: string + pictureCloseup: + description: Link to a closeup picture of the plant. + type: string + picture: + type: string + description: Link to the picture of the plant. + id: PlantDescription description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + Contains general information about plants, including details on their + seasonality, special shapes and colors, information about allergic + cross-reactions, and plant photos. + LookupForecastResponse: + type: object + id: LookupForecastResponse + properties: + dailyInfo: + description: >- + Required. This object contains the daily forecast information for + each day requested. + type: array + items: + $ref: '#/components/schemas/DayInfo' + nextPageToken: + type: string + description: Optional. The token to retrieve the next page. + regionCode: + type: string + description: >- + The ISO_3166-1 alpha-2 code of the country/region corresponding to + the location provided in the request. This field might be omitted + from the response if the location provided in the request resides in + a disputed territory. parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -455,16 +443,22 @@ components: name: quotaUser schema: type: string - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: fields + name: prettyPrint + schema: + type: boolean + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string access_token: @@ -473,12 +467,12 @@ components: name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: prettyPrint + name: upload_protocol schema: - type: boolean + type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -488,6 +482,22 @@ components: name: key schema: type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -497,22 +507,12 @@ components: enum: - '1' - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - alt: - description: Data format for response. + callback: + description: JSONP in: query - name: alt + name: callback schema: type: string - enum: - - json - - media - - proto x-stackQL-resources: forecast: id: google.pollen.forecast @@ -552,17 +552,17 @@ components: paths: /v1/forecast:lookup: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/callback' get: description: >- Returns up to 5 days of daily pollen information in more than 65 @@ -582,37 +582,37 @@ paths: $ref: '#/components/schemas/LookupForecastResponse' parameters: - in: query - name: languageCode + name: pageToken schema: type: string - in: query - name: pageSize + name: days schema: type: integer format: int32 - in: query - name: pageToken + name: languageCode schema: type: string - in: query - name: location.latitude + name: location.longitude schema: type: number format: double - in: query - name: location.longitude + name: location.latitude schema: type: number format: double - - in: query - name: days - schema: - type: integer - format: int32 - in: query name: plantsDescription schema: type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml b/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml index 2b90d5a9..a9f1769b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml @@ -22,10 +22,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/sasportal: Read, create, update, and delete your SAS Portal data. https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. + https://www.googleapis.com/auth/sasportal: Read, create, update, and delete your SAS Portal data. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -35,89 +35,68 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalEmpty: - 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); } - properties: {} - id: SasPortalEmpty + SasPortalGetPolicyRequest: + description: Request message for `GetPolicy` method. + id: SasPortalGetPolicyRequest type: object - SasPortalMigrateOrganizationMetadata: properties: - operationState: + resource: + description: Required. The resource for which the policy is being requested. type: string - enumDescriptions: - - Unspecified. - - Pending (Not started). - - In-progress. - - Done successfully. - - Done with errors. - description: Output only. Current operation state - enum: - - OPERATION_STATE_UNSPECIFIED - - OPERATION_STATE_PENDING - - OPERATION_STATE_RUNNING - - OPERATION_STATE_SUCCEEDED - - OPERATION_STATE_FAILED - readOnly: true - id: SasPortalMigrateOrganizationMetadata - description: >- - Long-running operation metadata message returned by the - MigrateOrganization. + SasPortalNode: type: object - SasPortalSetupSasAnalyticsRequest: + id: SasPortalNode properties: - userId: - description: >- - Optional. User id to setup analytics for, if not provided the user - id associated with the project is used. optional + sasUserIds: + type: array + description: User ids used by the devices belonging to this node. + items: + type: string + name: + description: Output only. Resource name. type: string - id: SasPortalSetupSasAnalyticsRequest - type: object - description: Request for the SetupSasAnalytics rpc. - SasPortalPolicy: - description: Defines an access control policy to the resources. + displayName: + type: string + description: The node's display name. + description: The Node. + SasPortalTestPermissionsRequest: + id: SasPortalTestPermissionsRequest + description: Request message for `TestPermissions` method. + properties: + permissions: + type: array + items: + type: string + description: The set of permissions to check for the `resource`. + resource: + type: string + description: >- + Required. The resource for which the permissions are being + requested. type: object + SasPortalMigrateOrganizationResponse: + description: >- + Response for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. properties: - assignments: - description: List of assignments + deploymentAssociation: items: - $ref: '#/components/schemas/SasPortalAssignment' - type: array - etag: + $ref: '#/components/schemas/SasPortalDeploymentAssociation' description: >- - The etag is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the etag in - the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An etag is returned in the response to - GetPolicy, and systems are expected to put that etag in the request - to SetPolicy to ensure that their change will be applied to the same - version of the policy. If no etag is provided in the call to - GetPolicy, then the existing policy is overwritten blindly. - type: string - format: byte - id: SasPortalPolicy + Optional. A list of deployment association that were created for the + migration, or current associations if they already exist. + type: array + id: SasPortalMigrateOrganizationResponse + type: object SasPortalDeviceAirInterface: - description: Information about the device's air interface. properties: - radioTechnology: - enum: - - RADIO_TECHNOLOGY_UNSPECIFIED - - E_UTRA - - CAMBIUM_NETWORKS - - FOUR_G_BBW_SAA_1 - - NR - - DOODLE_CBRS - - CW - - REDLINE - - TARANA_WIRELESS - - FAROS + supportedSpec: description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. + Optional. This field is related to the `radioTechnology` and + provides the air interface specification that the CBSD is compliant + with at the time of registration. + type: string + radioTechnology: enumDescriptions: - '' - '' @@ -130,333 +109,447 @@ components: - '' - '' type: string - supportedSpec: description: >- - Optional. This field is related to the `radioTechnology` and - provides the air interface specification that the CBSD is compliant - with at the time of registration. - type: string + Conditional. This field specifies the radio access technology that + is used for the CBSD. + enum: + - RADIO_TECHNOLOGY_UNSPECIFIED + - E_UTRA + - CAMBIUM_NETWORKS + - FOUR_G_BBW_SAA_1 + - NR + - DOODLE_CBRS + - CW + - REDLINE + - TARANA_WIRELESS + - FAROS id: SasPortalDeviceAirInterface + description: Information about the device's air interface. type: object - SasPortalDpaMoveList: - description: An entry in a DPA's move list. - type: object - properties: - dpaId: - type: string - description: The ID of the DPA. - frequencyRange: - description: The frequency range that the move list affects. - $ref: '#/components/schemas/SasPortalFrequencyRange' - id: SasPortalDpaMoveList - SasPortalListGcpProjectDeploymentsResponse: - description: Response for [ListGcpProjectDeployments]. - type: object - id: SasPortalListGcpProjectDeploymentsResponse - properties: - deployments: - type: array - items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' - description: Optional. Deployments associated with the GCP project - SasPortalMoveDeviceRequest: - properties: - destination: - type: string - description: >- - Required. The name of the new parent resource node or customer to - reparent the device under. - id: SasPortalMoveDeviceRequest - type: object - description: Request for MoveDevice. - SasPortalProvisionDeploymentResponse: - id: SasPortalProvisionDeploymentResponse + SasPortalDeviceModel: type: object - description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. properties: - errorMessage: - description: >- - Optional. Optional error message if the provisioning request is not - successful. + firmwareVersion: type: string - SasPortalValidateInstallerResponse: - description: Response for ValidateInstaller. - id: SasPortalValidateInstallerResponse - properties: {} - type: object - SasPortalDeviceModel: - properties: + description: The firmware version of the device. softwareVersion: - type: string description: The software version of the device. + type: string name: description: The name of the device model. type: string vendor: - description: The name of the device vendor. - type: string - firmwareVersion: - description: The firmware version of the device. type: string + description: The name of the device vendor. hardwareVersion: - type: string description: The hardware version of the device. + type: string id: SasPortalDeviceModel - type: object description: Information about the model of the device. - SasPortalNode: + SasPortalPolicy: properties: - name: - description: Output only. Resource name. + etag: type: string - sasUserIds: - type: array + description: >- + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the etag in + the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An etag is returned in the response to + GetPolicy, and systems are expected to put that etag in the request + to SetPolicy to ensure that their change will be applied to the same + version of the policy. If no etag is provided in the call to + GetPolicy, then the existing policy is overwritten blindly. + format: byte + assignments: items: - type: string - description: User ids used by the devices belonging to this node. - displayName: - description: The node's display name. - type: string - id: SasPortalNode + $ref: '#/components/schemas/SasPortalAssignment' + type: array + description: List of assignments + description: Defines an access control policy to the resources. + id: SasPortalPolicy type: object - description: The Node. - SasPortalValidateInstallerRequest: + SasPortalSetPolicyRequest: properties: - secret: - description: Required. Secret returned by the GenerateSecret. - type: string - installerId: - type: string + disableNotification: + type: boolean description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - encodedSecret: + Optional. Set the field as `true` to disable the onboarding + notification. + policy: + $ref: '#/components/schemas/SasPortalPolicy' + description: Required. The policy to be applied to the `resource`. + resource: type: string description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must include a "secret" claim whose value is the secret. + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. type: object - description: Request for ValidateInstaller. - id: SasPortalValidateInstallerRequest - SasPortalSetupSasAnalyticsMetadata: + id: SasPortalSetPolicyRequest + description: Request message for `SetPolicy` method. + SasPortalEmpty: description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. - id: SasPortalSetupSasAnalyticsMetadata + 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: SasPortalEmpty type: object properties: {} - SasPortalDeviceMetadata: - type: object - description: Device data overridable by both SAS Portal and registration requests. - id: SasPortalDeviceMetadata + SasPortalMigrateOrganizationMetadata: + description: >- + Long-running operation metadata message returned by the + MigrateOrganization. properties: - nrqzValidation: - readOnly: true - $ref: '#/components/schemas/SasPortalNrqzValidation' - description: Output only. National Radio Quiet Zone validation info. - nrqzValidated: - type: boolean - description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. - deprecated: true + operationState: readOnly: true - interferenceCoordinationGroup: - type: string - description: >- - Interference Coordination Group (ICG). A group of CBSDs that manage - their own interference with the group. For more details, see - [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - antennaModel: - description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` + description: Output only. Current operation state + enumDescriptions: + - Unspecified. + - Pending (Not started). + - In-progress. + - Done successfully. + - Done with errors. type: string - commonChannelGroup: - description: >- - Common Channel Group (CCG). A group of CBSDs in the same ICG - requesting a common primary channel assignment. For more details, - see [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + enum: + - OPERATION_STATE_UNSPECIFIED + - OPERATION_STATE_PENDING + - OPERATION_STATE_RUNNING + - OPERATION_STATE_SUCCEEDED + - OPERATION_STATE_FAILED + id: SasPortalMigrateOrganizationMetadata + type: object + SasPortalMigrateOrganizationRequest: + id: SasPortalMigrateOrganizationRequest + type: object + description: >- + Request for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP + Project, Organization Info, and caller's GAIA ID should be retrieved + from the RPC handler, and used to check authorization on SAS Portal + organization and to create GCP Projects. + properties: + organizationId: + description: Required. Id of the SAS organization to be migrated. + format: int64 type: string - SasPortalUpdateSignedDeviceRequest: - description: Request for UpdateSignedDevice. + SasPortalListDevicesResponse: + description: Response for ListDevices. properties: - encodedDevice: - format: byte + nextPageToken: type: string description: >- - Required. The JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - installerId: - description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. - type: string - id: SasPortalUpdateSignedDeviceRequest + A pagination token returned from a previous call to ListDevices that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more devices. + devices: + type: array + items: + $ref: '#/components/schemas/SasPortalDevice' + description: The devices that match the request. type: object - SasPortalDeployment: + id: SasPortalListDevicesResponse + SasPortalGenerateSecretRequest: + description: Request for GenerateSecret. + type: object + id: SasPortalGenerateSecretRequest + properties: {} + SasPortalDeploymentAssociation: + id: SasPortalDeploymentAssociation + description: Association between a gcp project and a SAS user id. type: object properties: - name: + gcpProjectId: type: string - readOnly: true - description: Output only. Resource name. - frns: - readOnly: true - type: array - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. - items: - type: string - sasUserIds: - description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. - type: array - items: - type: string - displayName: + description: GCP project id of the associated project. + userId: + description: User id of the deployment. type: string - description: The deployment's display name. - id: SasPortalDeployment - description: The Deployment. - SasPortalDeviceGrant: + SasPortalGcpProjectDeployment: + id: SasPortalGcpProjectDeployment + type: object description: >- - Device grant. It is an authorization provided by the Spectrum Access - System to a device to transmit using specified operating parameters - after a successful heartbeat by the device. + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. + properties: + deployment: + $ref: '#/components/schemas/SasPortalDeployment' + description: Deployment associated with the GCP project. + hasEnabledAnalytics: + type: boolean + description: Whether SAS analytics has been enabled. + SasPortalDpaMoveList: + type: object properties: - moveList: - items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - description: The DPA move lists on which this grant appears. - type: array frequencyRange: + description: The frequency range that the move list affects. $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The transmission frequency range. - state: - type: string - enumDescriptions: - - '' - - >- - The grant has been granted but the device is not heartbeating on - it. - - The grant has been terminated by the SAS. - - The grant has been suspended by the SAS. - - The device is currently transmitting. - - The grant has expired. - enum: - - GRANT_STATE_UNSPECIFIED - - GRANT_STATE_GRANTED - - GRANT_STATE_TERMINATED - - GRANT_STATE_SUSPENDED - - GRANT_STATE_AUTHORIZED - - GRANT_STATE_EXPIRED - description: State of the grant. - suspensionReason: - description: If the grant is suspended, the reason(s) for suspension. - items: - type: string - type: array - grantId: + dpaId: + description: The ID of the DPA. type: string - description: Grant Id. - lastHeartbeatTransmitExpireTime: - format: google-datetime + description: An entry in a DPA's move list. + id: SasPortalDpaMoveList + SasPortalMoveDeploymentRequest: + properties: + destination: type: string - description: The transmit expiration time of the last heartbeat. - maxEirp: - type: number description: >- - Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by - the grant. The maximum EIRP is in units of dBm/MHz. The value of - `maxEirp` represents the average (RMS) EIRP that would be measured - by the procedure defined in FCC part 96.41(e)(3). - format: double - channelType: - type: string - enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL - description: Type of channel used. - enumDescriptions: - - '' - - '' - - '' - expireTime: - format: google-datetime - type: string - description: The expiration time of the grant. - id: SasPortalDeviceGrant + Required. The name of the new parent resource node or customer to + reparent the deployment under. type: object - SasPortalMigrateOrganizationRequest: + description: Request for MoveDeployment. + id: SasPortalMoveDeploymentRequest + SasPortalInstallationParams: + id: SasPortalInstallationParams + description: Information about the device installation parameters. type: object - id: SasPortalMigrateOrganizationRequest properties: - organizationId: - description: Required. Id of the SAS organization to be migrated. + heightType: + description: Specifies how the height is measured. + enum: + - HEIGHT_TYPE_UNSPECIFIED + - HEIGHT_TYPE_AGL + - HEIGHT_TYPE_AMSL type: string - format: int64 - description: >- - Request for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP - Project, Organization Info, and caller's GAIA ID should be retrieved - from the RPC handler, and used to check authorization on SAS Portal - organization and to create GCP Projects. - SasPortalChannelWithScore: - id: SasPortalChannelWithScore - type: object - description: The channel with score. - properties: - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range of the channel. - score: - type: number - description: The channel score, normalized to be in the range [0,100]. - format: double - SasPortalGcpProjectDeployment: - type: object - properties: - hasEnabledAnalytics: - description: Whether SAS analytics has been enabled. + enumDescriptions: + - Unspecified height type. + - AGL height is measured relative to the ground level. + - AMSL height is measured relative to the mean sea level. + longitude: + description: >- + Longitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -180.000000 to +180.000000. + Positive values represent longitudes east of the prime meridian; + negative values west of the prime meridian. + type: number + format: double + antennaAzimuth: + type: integer + format: int32 + description: >- + Boresight direction of the horizontal plane of the antenna in + degrees with respect to true north. The value of this parameter is + an integer with a value between 0 and 359 inclusive. A value of 0 + degrees means true north; a value of 90 degrees means east. This + parameter is optional for Category A devices and conditional for + Category B devices. + horizontalAccuracy: + description: >- + A positive number in meters to indicate accuracy of the device + antenna horizontal location. This optional parameter should only be + present if its value is less than the FCC requirement of 50 meters. + type: number + format: double + indoorDeployment: type: boolean - deployment: - description: Deployment associated with the GCP project. - $ref: '#/components/schemas/SasPortalDeployment' - description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. - id: SasPortalGcpProjectDeployment - SasPortalStatus: - properties: - code: + description: >- + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. + eirpCapability: + description: >- + This parameter is the maximum device EIRP in units of dBm/10MHz and + is an integer with a value between -127 and +47 (dBm/10 MHz) + inclusive. If not included, SAS interprets it as maximum allowable + EIRP in units of dBm/10MHz for device category. format: int32 type: integer - description: The status code, which should be an enum value of google.rpc.Code. - details: + antennaGain: + type: number + format: double description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Peak antenna gain in dBi. This parameter is a double with a value + between -127 and +128 (dBi) inclusive. Part of Release 2 to support + floating-point value + antennaModel: + description: >- + If an external antenna is used, the antenna model is optionally + provided in this field. The string has a maximum length of 128 + octets. + type: string + height: + format: double + type: number + description: >- + Device antenna height in meters. When the `heightType` parameter + value is "AGL", the antenna height should be given relative to + ground level. When the `heightType` parameter value is "AMSL", it is + given with respect to WGS84 datum. + cpeCbsdIndication: + type: boolean + description: >- + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + antennaBeamwidth: + type: integer + description: >- + 3-dB antenna beamwidth of the antenna in the horizontal-plane in + degrees. This parameter is an unsigned integer having a value + between 0 and 360 (degrees) inclusive; it is optional for Category A + devices and conditional for Category B devices. + format: int32 + verticalAccuracy: + format: double + type: number + description: >- + A positive number in meters to indicate accuracy of the device + antenna vertical location. This optional parameter should only be + present if its value is less than the FCC requirement of 3 meters. + antennaDowntilt: + description: >- + Antenna downtilt in degrees and is an integer with a value between + -90 and +90 inclusive; a negative value means the antenna is tilted + up (above horizontal). This parameter is optional for Category A + devices and conditional for Category B devices. + type: integer + format: int32 + latitude: + format: double + type: number + description: >- + Latitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -90.000000 to +90.000000. + Positive values represent latitudes north of the equator; negative + values south of the equator. + SasPortalGenerateSecretResponse: + properties: + secret: + type: string + description: The secret generated by the string and used by ValidateInstaller. + description: Response for GenerateSecret. + type: object + id: SasPortalGenerateSecretResponse + SasPortalAssignment: + type: object + properties: + role: + type: string + description: Required. Role that is assigned to `members`. + members: + description: >- + The identities the role is assigned to. It can have the following + values: * `{user_email}`: An email address that represents a + specific Google account. For example: `alice@gmail.com`. * + `{group_email}`: An email address that represents a Google group. + For example, `viewers@gmail.com`. + items: + type: string + type: array + description: Associates `members` with a `role`. + id: SasPortalAssignment + SasPortalChannelWithScore: + id: SasPortalChannelWithScore + properties: + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The frequency range of the channel. + score: + description: The channel score, normalized to be in the range [0,100]. + type: number + format: double + type: object + description: The channel with score. + SasPortalFrequencyRange: + id: SasPortalFrequencyRange + type: object + properties: + lowFrequencyMhz: + format: double + description: The lowest frequency of the frequency range in MHz. + type: number + highFrequencyMhz: + description: The highest frequency of the frequency range in MHz. + type: number + format: double + description: Frequency range from `low_frequency` to `high_frequency`. + SasPortalListGcpProjectDeploymentsResponse: + id: SasPortalListGcpProjectDeploymentsResponse + description: Response for [ListGcpProjectDeployments]. + type: object + properties: + deployments: + description: Optional. Deployments associated with the GCP project type: array items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - message: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + SasPortalListCustomersResponse: + id: SasPortalListCustomersResponse + type: object + properties: + nextPageToken: + description: >- + A pagination token returned from a previous call to ListCustomers + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more customers. type: string + customers: + type: array + description: The list of customers that match the request. + items: + $ref: '#/components/schemas/SasPortalCustomer' + description: Response for `ListCustomers`. + SasPortalSetupSasAnalyticsRequest: + id: SasPortalSetupSasAnalyticsRequest + description: Request for the SetupSasAnalytics rpc. + type: object + properties: + userId: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Optional. User id to setup analytics for, if not provided the user + id associated with the project is used. optional + type: string + SasPortalSetupSasAnalyticsMetadata: + properties: {} + type: object + id: SasPortalSetupSasAnalyticsMetadata + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. + SasPortalValidateInstallerResponse: + description: Response for ValidateInstaller. + id: SasPortalValidateInstallerResponse + type: object + properties: {} + SasPortalValidateInstallerRequest: + type: object + description: Request for ValidateInstaller. + properties: + installerId: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + type: string + encodedSecret: + type: string + description: >- + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. + secret: + description: Required. Secret returned by the GenerateSecret. + type: string + id: SasPortalValidateInstallerRequest + SasPortalMoveNodeRequest: + id: SasPortalMoveNodeRequest + properties: + destination: + description: >- + Required. The name of the new parent resource node or customer to + reparent the node under. + type: string + description: Request for MoveNode. + type: object + SasPortalProvisionDeploymentResponse: + properties: + errorMessage: + description: >- + Optional. Optional error message if the provisioning request is not + successful. + type: string + id: SasPortalProvisionDeploymentResponse + description: >- + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. + type: object + SasPortalStatus: description: >- The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It @@ -467,342 +560,386 @@ components: Guide](https://cloud.google.com/apis/design/errors). type: object id: SasPortalStatus - SasPortalListCustomersResponse: - description: Response for `ListCustomers`. - id: SasPortalListCustomersResponse - type: object properties: - customers: - description: The list of customers that match the request. - type: array - items: - $ref: '#/components/schemas/SasPortalCustomer' - nextPageToken: + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string + details: description: >- - A pagination token returned from a previous call to ListCustomers - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more customers. - SasPortalGetPolicyRequest: - type: object - description: Request message for `GetPolicy` method. - id: SasPortalGetPolicyRequest - properties: - resource: - type: string - description: Required. The resource for which the policy is being requested. - SasPortalDeviceConfig: - description: Information about the device configuration. - id: SasPortalDeviceConfig - properties: - measurementCapabilities: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - description: Measurement reporting capabilities of the device. items: - enum: - - MEASUREMENT_CAPABILITY_UNSPECIFIED - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT - enumDescriptions: - - '' - - '' - - '' - type: string - installationParams: - description: Installation parameters for the device. - $ref: '#/components/schemas/SasPortalInstallationParams' - airInterface: - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - description: Information about this device's air interface. - callSign: - type: string - description: The call sign of the device operator. - updateTime: - description: Output only. The last time the device configuration was edited. - type: string - format: google-datetime - userId: - description: The identifier of a device user. - type: string - model: - $ref: '#/components/schemas/SasPortalDeviceModel' - description: Information about this device model. - category: - enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + SasPortalDeviceGrant: + properties: + channelType: + description: Type of channel used. enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL type: string - description: FCC category of the device. - state: enumDescriptions: - '' - '' - '' - description: State of the configuration. - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL + maxEirp: + description: >- + Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by + the grant. The maximum EIRP is in units of dBm/MHz. The value of + `maxEirp` represents the average (RMS) EIRP that would be measured + by the procedure defined in FCC part 96.41(e)(3). + format: double + type: number + expireTime: + description: The expiration time of the grant. + format: google-datetime type: string - isSigned: - description: Output only. Whether the configuration has been signed by a CPI. - type: boolean - type: object - SasPortalGenerateSecretResponse: - properties: - secret: + lastHeartbeatTransmitExpireTime: type: string - description: The secret generated by the string and used by ValidateInstaller. - type: object - description: Response for GenerateSecret. - id: SasPortalGenerateSecretResponse - SasPortalCustomer: - type: object - description: Entity representing a SAS customer. - properties: - displayName: - description: >- - Required. Name of the organization that the customer entity - represents. + format: google-datetime + description: The transmit expiration time of the last heartbeat. + state: type: string - sasUserIds: + description: State of the grant. + enum: + - GRANT_STATE_UNSPECIFIED + - GRANT_STATE_GRANTED + - GRANT_STATE_TERMINATED + - GRANT_STATE_SUSPENDED + - GRANT_STATE_AUTHORIZED + - GRANT_STATE_EXPIRED + enumDescriptions: + - '' + - >- + The grant has been granted but the device is not heartbeating on + it. + - The grant has been terminated by the SAS. + - The grant has been suspended by the SAS. + - The device is currently transmitting. + - The grant has expired. + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The transmission frequency range. + grantId: + type: string + description: Grant Id. + moveList: + items: + $ref: '#/components/schemas/SasPortalDpaMoveList' + type: array + description: The DPA move lists on which this grant appears. + suspensionReason: type: array + description: If the grant is suspended, the reason(s) for suspension. items: type: string - description: User IDs used by the devices belonging to this customer. - name: - type: string - description: Output only. Resource name of the customer. - id: SasPortalCustomer - SasPortalSignDeviceRequest: - id: SasPortalSignDeviceRequest - description: Request for SignDevice. - properties: - device: - $ref: '#/components/schemas/SasPortalDevice' - description: >- - Required. The device to sign. The device fields name, fcc_id and - serial_number must be set. The user_id field must be set. - type: object - SasPortalDeploymentAssociation: - description: Association between a gcp project and a SAS user id. - id: SasPortalDeploymentAssociation + description: >- + Device grant. It is an authorization provided by the Spectrum Access + System to a device to transmit using specified operating parameters + after a successful heartbeat by the device. + id: SasPortalDeviceGrant type: object - properties: - userId: - description: User id of the deployment. - type: string - gcpProjectId: - type: string - description: GCP project id of the associated project. SasPortalOrganization: - description: Organization details. - id: SasPortalOrganization + type: object properties: displayName: - type: string description: Name of organization + type: string id: - format: int64 type: string description: Id of organization + format: int64 + description: Organization details. + id: SasPortalOrganization + SasPortalMoveDeviceRequest: + description: Request for MoveDevice. type: object - SasPortalInstallationParams: - description: Information about the device installation parameters. + id: SasPortalMoveDeviceRequest properties: - antennaModel: - description: >- - If an external antenna is used, the antenna model is optionally - provided in this field. The string has a maximum length of 128 - octets. + destination: type: string - eirpCapability: - format: int32 - type: integer description: >- - This parameter is the maximum device EIRP in units of dBm/10MHz and - is an integer with a value between -127 and +47 (dBm/10 MHz) - inclusive. If not included, SAS interprets it as maximum allowable - EIRP in units of dBm/10MHz for device category. - latitude: - type: number - format: double + Required. The name of the new parent resource node or customer to + reparent the device under. + SasPortalSignDeviceRequest: + properties: + device: description: >- - Latitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -90.000000 to +90.000000. - Positive values represent latitudes north of the equator; negative - values south of the equator. - horizontalAccuracy: + Required. The device to sign. The device fields name, fcc_id and + serial_number must be set. The user_id field must be set. + $ref: '#/components/schemas/SasPortalDevice' + description: Request for SignDevice. + type: object + id: SasPortalSignDeviceRequest + SasPortalListDeploymentsResponse: + description: Response for ListDeployments. + properties: + deployments: + type: array + description: The deployments that match the request. + items: + $ref: '#/components/schemas/SasPortalDeployment' + nextPageToken: + type: string description: >- - A positive number in meters to indicate accuracy of the device - antenna horizontal location. This optional parameter should only be - present if its value is less than the FCC requirement of 50 meters. - format: double - type: number - indoorDeployment: - type: boolean + A pagination token returned from a previous call to ListDeployments + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more deployments. + type: object + id: SasPortalListDeploymentsResponse + SasPortalDeviceMetadata: + properties: + interferenceCoordinationGroup: description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. - heightType: - description: Specifies how the height is measured. - enum: - - HEIGHT_TYPE_UNSPECIFIED - - HEIGHT_TYPE_AGL - - HEIGHT_TYPE_AMSL - enumDescriptions: - - Unspecified height type. - - AGL height is measured relative to the ground level. - - AMSL height is measured relative to the mean sea level. + Interference Coordination Group (ICG). A group of CBSDs that manage + their own interference with the group. For more details, see + [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). type: string - verticalAccuracy: - description: >- - A positive number in meters to indicate accuracy of the device - antenna vertical location. This optional parameter should only be - present if its value is less than the FCC requirement of 3 meters. - format: double - type: number - antennaDowntilt: - format: int32 + nrqzValidation: + description: Output only. National Radio Quiet Zone validation info. + $ref: '#/components/schemas/SasPortalNrqzValidation' + readOnly: true + commonChannelGroup: description: >- - Antenna downtilt in degrees and is an integer with a value between - -90 and +90 inclusive; a negative value means the antenna is tilted - up (above horizontal). This parameter is optional for Category A - devices and conditional for Category B devices. - type: integer - antennaBeamwidth: - type: integer + Common Channel Group (CCG). A group of CBSDs in the same ICG + requesting a common primary channel assignment. For more details, + see [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + type: string + nrqzValidated: + type: boolean + deprecated: true description: >- - 3-dB antenna beamwidth of the antenna in the horizontal-plane in - degrees. This parameter is an unsigned integer having a value - between 0 and 360 (degrees) inclusive; it is optional for Category A - devices and conditional for Category B devices. - format: int32 - antennaGain: - type: number + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + readOnly: true + antennaModel: description: >- - Peak antenna gain in dBi. This parameter is a double with a value - between -127 and +128 (dBi) inclusive. Part of Release 2 to support - floating-point value - format: double - height: - type: number + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` + type: string + type: object + id: SasPortalDeviceMetadata + description: Device data overridable by both SAS Portal and registration requests. + SasPortalListNodesResponse: + id: SasPortalListNodesResponse + description: Response for ListNodes. + type: object + properties: + nextPageToken: + type: string description: >- - Device antenna height in meters. When the `heightType` parameter - value is "AGL", the antenna height should be given relative to - ground level. When the `heightType` parameter value is "AMSL", it is - given with respect to WGS84 datum. - format: double - longitude: - type: number - format: double + A pagination token returned from a previous call to ListNodes that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more nodes. + nodes: + items: + $ref: '#/components/schemas/SasPortalNode' + description: The nodes that match the request. + type: array + SasPortalCustomer: + description: Entity representing a SAS customer. + properties: + name: + type: string + description: Output only. Resource name of the customer. + sasUserIds: + items: + type: string + type: array + description: User IDs used by the devices belonging to this customer. + displayName: + type: string description: >- - Longitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -180.000000 to +180.000000. - Positive values represent longitudes east of the prime meridian; - negative values west of the prime meridian. - cpeCbsdIndication: - type: boolean + Required. Name of the organization that the customer entity + represents. + type: object + id: SasPortalCustomer + SasPortalUpdateSignedDeviceRequest: + type: object + id: SasPortalUpdateSignedDeviceRequest + properties: + installerId: + type: string description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - antennaAzimuth: - format: int32 + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. + encodedDevice: + format: byte description: >- - Boresight direction of the horizontal plane of the antenna in - degrees with respect to true north. The value of this parameter is - an integer with a value between 0 and 359 inclusive. A value of 0 - degrees means true north; a value of 90 degrees means east. This - parameter is optional for Category A devices and conditional for - Category B devices. - type: integer + Required. The JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + type: string + description: Request for UpdateSignedDevice. + SasPortalTestPermissionsResponse: + description: Response message for `TestPermissions` method. type: object - id: SasPortalInstallationParams - SasPortalTestPermissionsRequest: + id: SasPortalTestPermissionsResponse properties: permissions: - description: The set of permissions to check for the `resource`. items: type: string type: array - resource: + description: A set of permissions that the caller is allowed. + SasPortalCreateSignedDeviceRequest: + properties: + encodedDevice: description: >- - Required. The resource for which the permissions are being - requested. + Required. JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + format: byte + type: string + installerId: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. type: string - description: Request message for `TestPermissions` method. - id: SasPortalTestPermissionsRequest type: object - SasPortalMoveNodeRequest: - id: SasPortalMoveNodeRequest + description: Request for CreateSignedDevice. + id: SasPortalCreateSignedDeviceRequest + SasPortalNrqzValidation: properties: - destination: + latitude: + format: double + description: Device latitude that's associated with the validation. + type: number + state: type: string - description: >- - Required. The name of the new parent resource node or customer to - reparent the node under. + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. + description: State of the NRQZ validation info. + cpiId: + type: string + description: CPI who signed the validation. + caseId: + type: string + description: Validation case ID. + longitude: + format: double + type: number + description: Device longitude that's associated with the validation. type: object - description: Request for MoveNode. - SasPortalListDeploymentsResponse: - id: SasPortalListDeploymentsResponse + id: SasPortalNrqzValidation + description: Information about National Radio Quiet Zone validation. + SasPortalSetupSasAnalyticsResponse: + type: object + properties: {} + id: SasPortalSetupSasAnalyticsResponse + description: >- + Response returned by the long running operation for the + SetupSasAnalytics rpc. + SasPortalDeviceConfig: + id: SasPortalDeviceConfig properties: - deployments: - description: The deployments that match the request. - items: - $ref: '#/components/schemas/SasPortalDeployment' + model: + description: Information about this device model. + $ref: '#/components/schemas/SasPortalDeviceModel' + userId: + type: string + description: The identifier of a device user. + measurementCapabilities: type: array - nextPageToken: - description: >- - A pagination token returned from a previous call to ListDeployments - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more deployments. + description: Measurement reporting capabilities of the device. + items: + enum: + - MEASUREMENT_CAPABILITY_UNSPECIFIED + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + type: string + enumDescriptions: + - '' + - '' + - '' + airInterface: + $ref: '#/components/schemas/SasPortalDeviceAirInterface' + description: Information about this device's air interface. + isSigned: + description: Output only. Whether the configuration has been signed by a CPI. + type: boolean + state: + enumDescriptions: + - '' + - '' + - '' type: string - description: Response for ListDeployments. + description: State of the configuration. + enum: + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL + category: + description: FCC category of the device. + type: string + enumDescriptions: + - Unspecified device category. + - Category A. + - Category B. + enum: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B + callSign: + type: string + description: The call sign of the device operator. + updateTime: + type: string + format: google-datetime + description: Output only. The last time the device configuration was edited. + installationParams: + description: Installation parameters for the device. + $ref: '#/components/schemas/SasPortalInstallationParams' + description: Information about the device configuration. type: object - SasPortalListDevicesResponse: - description: Response for ListDevices. + SasPortalListLegacyOrganizationsResponse: + id: SasPortalListLegacyOrganizationsResponse + description: >- + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. properties: - nextPageToken: - description: >- - A pagination token returned from a previous call to ListDevices that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more devices. - type: string - devices: - description: The devices that match the request. + organizations: type: array items: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOrganization' + description: Optional. Legacy SAS organizations. type: object - id: SasPortalListDevicesResponse SasPortalOperation: type: object id: SasPortalOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. properties: - metadata: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - name: - type: string + error: + $ref: '#/components/schemas/SasPortalStatus' description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + The error result of the operation in case of failure or + cancellation. response: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object description: >- The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is @@ -812,255 +949,123 @@ components: where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. type: object additionalProperties: description: Properties of the object. Contains field @type with type URL. type: any done: + type: boolean description: >- If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - type: boolean - error: - $ref: '#/components/schemas/SasPortalStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - SasPortalListNodesResponse: - properties: - nextPageToken: - description: >- - A pagination token returned from a previous call to ListNodes that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more nodes. - type: string - nodes: - items: - $ref: '#/components/schemas/SasPortalNode' - type: array - description: The nodes that match the request. - description: Response for ListNodes. - type: object - id: SasPortalListNodesResponse - SasPortalNrqzValidation: - type: object - properties: - latitude: - format: double - type: number - description: Device latitude that's associated with the validation. - cpiId: - type: string - description: CPI who signed the validation. - longitude: - description: Device longitude that's associated with the validation. - format: double - type: number - caseId: - type: string - description: Validation case ID. - state: - description: State of the NRQZ validation info. + name: type: string - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. - description: Information about National Radio Quiet Zone validation. - id: SasPortalNrqzValidation - SasPortalSetPolicyRequest: - id: SasPortalSetPolicyRequest - type: object - description: Request message for `SetPolicy` method. - properties: - disableNotification: - description: >- - Optional. Set the field as `true` to disable the onboarding - notification. - type: boolean - resource: description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - type: string - policy: - $ref: '#/components/schemas/SasPortalPolicy' - description: Required. The policy to be applied to the `resource`. - SasPortalSetupSasAnalyticsResponse: - properties: {} - description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. - type: object - id: SasPortalSetupSasAnalyticsResponse - SasPortalDevice: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + SasPortalDeployment: properties: - fccId: - type: string - description: >- - The FCC identifier of the device. Refer to - https://www.fcc.gov/oet/ea/fccid for FccID format. Accept - underscores and periods because some test-SAS customers use them. - grants: - type: array - description: Output only. Grants held by the device. - items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - activeConfig: - $ref: '#/components/schemas/SasPortalDeviceConfig' - description: >- - Output only. Current configuration of the device as registered to - the SAS. - grantRangeAllowlists: - description: >- - Only ranges that are within the allowlists are available for new - grants. - type: array - items: - $ref: '#/components/schemas/SasPortalFrequencyRange' - state: - type: string - enumDescriptions: - - Unspecified state. - - >- - Device created in the SAS Portal, however, not yet registered with - SAS. - - Device registered with SAS. - - Device de-registered with SAS. - description: Output only. Device state. - enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED displayName: type: string - description: Device display name. - deviceMetadata: - $ref: '#/components/schemas/SasPortalDeviceMetadata' - description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - currentChannels: - readOnly: true - items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - deprecated: true - description: Output only. Current channels with scores. - type: array - serialNumber: - type: string - description: A serial number assigned to the device by the device manufacturer. + description: The deployment's display name. name: + readOnly: true + description: Output only. Resource name. type: string - description: Output only. The resource path name. - preloadedConfig: - $ref: '#/components/schemas/SasPortalDeviceConfig' - description: Configuration of the device, as specified via SAS Portal API. - type: object - id: SasPortalDevice - SasPortalMoveDeploymentRequest: - id: SasPortalMoveDeploymentRequest - properties: - destination: - type: string + frns: description: >- - Required. The name of the new parent resource node or customer to - reparent the deployment under. - description: Request for MoveDeployment. - type: object - SasPortalAssignment: - id: SasPortalAssignment - properties: - role: - type: string - description: Required. Role that is assigned to `members`. - members: - type: array + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. items: type: string - description: >- - The identities the role is assigned to. It can have the following - values: * `{user_email}`: An email address that represents a - specific Google account. For example: `alice@gmail.com`. * - `{group_email}`: An email address that represents a Google group. - For example, `viewers@gmail.com`. - description: Associates `members` with a `role`. - type: object - SasPortalTestPermissionsResponse: - properties: - permissions: + readOnly: true type: array - description: A set of permissions that the caller is allowed. - items: - type: string - type: object - description: Response message for `TestPermissions` method. - id: SasPortalTestPermissionsResponse - SasPortalCreateSignedDeviceRequest: - properties: - installerId: - type: string - description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - encodedDevice: + sasUserIds: + type: array + items: + type: string description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - type: string - format: byte - description: Request for CreateSignedDevice. - type: object - id: SasPortalCreateSignedDeviceRequest - SasPortalFrequencyRange: - properties: - highFrequencyMhz: - description: The highest frequency of the frequency range in MHz. - type: number - format: double - lowFrequencyMhz: - description: The lowest frequency of the frequency range in MHz. - format: double - type: number - description: Frequency range from `low_frequency` to `high_frequency`. - id: SasPortalFrequencyRange + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + description: The Deployment. type: object - SasPortalListLegacyOrganizationsResponse: - id: SasPortalListLegacyOrganizationsResponse + id: SasPortalDeployment + SasPortalDevice: type: object + id: SasPortalDevice properties: - organizations: + activeConfig: + description: >- + Output only. Current configuration of the device as registered to + the SAS. + $ref: '#/components/schemas/SasPortalDeviceConfig' + displayName: + description: Device display name. + type: string + currentChannels: type: array + readOnly: true + description: Output only. Current channels with scores. items: - $ref: '#/components/schemas/SasPortalOrganization' - description: Optional. Legacy SAS organizations. - description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. - SasPortalMigrateOrganizationResponse: - id: SasPortalMigrateOrganizationResponse - type: object - properties: - deploymentAssociation: + $ref: '#/components/schemas/SasPortalChannelWithScore' + deprecated: true + deviceMetadata: description: >- - Optional. A list of deployment association that were created for the - migration, or current associations if they already exist. + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + $ref: '#/components/schemas/SasPortalDeviceMetadata' + name: + type: string + description: Output only. The resource path name. + serialNumber: + type: string + description: A serial number assigned to the device by the device manufacturer. + fccId: + type: string + description: >- + The FCC identifier of the device. Refer to + https://www.fcc.gov/oet/ea/fccid for FccID format. Accept + underscores and periods because some test-SAS customers use them. + grantRangeAllowlists: + description: >- + Only ranges that are within the allowlists are available for new + grants. items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' + $ref: '#/components/schemas/SasPortalFrequencyRange' type: array - description: >- - Response for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + state: + type: string + description: Output only. Device state. + enum: + - DEVICE_STATE_UNSPECIFIED + - RESERVED + - REGISTERED + - DEREGISTERED + enumDescriptions: + - Unspecified state. + - >- + Device created in the SAS Portal, however, not yet registered with + SAS. + - Device registered with SAS. + - Device de-registered with SAS. + grants: + type: array + items: + $ref: '#/components/schemas/SasPortalDeviceGrant' + description: Output only. Grants held by the device. + preloadedConfig: + description: Configuration of the device, as specified via SAS Portal API. + $ref: '#/components/schemas/SasPortalDeviceConfig' SasPortalProvisionDeploymentRequest: id: SasPortalProvisionDeploymentRequest description: >- @@ -1069,62 +1074,76 @@ components: Project, Organization Info, and caller’s GAIA ID should be retrieved from the RPC handler, and used as inputs to create a new SAS organization (if not exists) and a new SAS deployment. - type: object properties: - organizationId: - type: string - description: >- - Optional. If this field is set then a new deployment will be created - under the organization specified by this id. - format: int64 newDeploymentDisplayName: type: string description: >- Optional. If this field is set, and a new SAS Portal Deployment needs to be created, its display name will be set to the value of this field. + organizationId: + description: >- + Optional. If this field is set then a new deployment will be created + under the organization specified by this id. + type: string + format: int64 newOrganizationDisplayName: type: string description: >- Optional. If this field is set, and a new SAS Portal Organization needs to be created, its display name will be set to the value of this field. - SasPortalGenerateSecretRequest: - id: SasPortalGenerateSecretRequest - properties: {} - description: Request for GenerateSecret. type: object parameters: - prettyPrint: - description: Returns response with indentations and line breaks. + alt: + description: Data format for response. in: query - name: prettyPrint + name: alt schema: - type: boolean + type: string + enum: + - json + - media + - proto access_token: description: OAuth access token. in: query name: access_token schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string fields: description: Selector specifying which fields to include in a partial response. in: query @@ -1155,97 +1174,90 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto x-stackQL-resources: - devices: - id: google.prod_tt_sasportal.devices - name: devices - title: Devices + node: + id: google.prod_tt_sasportal.node + name: node + title: Node methods: - deployments_devices_get: + nodes_get: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_patch: + nodes_nodes_get: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_delete: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' + insert: [] + update: [] + replace: [] + delete: [] + devices: + id: google.prod_tt_sasportal.devices + name: devices + title: Devices + methods: + nodes_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + objectKey: $.devices + nodes_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_move: + nodes_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_delete: + nodes_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.devices nodes_devices_patch: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_get: + nodes_devices_delete: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create: + nodes_devices_get: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_list: + nodes_devices_sign_device: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices nodes_devices_move: operation: $ref: >- @@ -1253,47 +1265,55 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_sign_device: + nodes_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.devices + nodes_nodes_devices_create: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_list: + customers_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_deployments_devices_create: + customers_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_list: + objectKey: $.devices + customers_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - nodes_nodes_devices_create: + customers_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_move: + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1311,10 +1331,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_devices_patch: + customers_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' @@ -1338,51 +1358,56 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_list: + deployments_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_deployments_devices_create: + deployments_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create: + deployments_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_list: + deployments_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_move: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_get - - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list + - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_get + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list + #/components/x-stackQL-resources/devices/methods/customers_devices_get + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_list - $ref: >- @@ -1392,38 +1417,44 @@ components: #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_create update: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_patch + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_patch replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_delete + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_delete devices_signed: id: google.prod_tt_sasportal.devices_signed name: devices_signed title: Devices_signed methods: - deployments_devices_update_signed: + nodes_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_devices_create_signed: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1434,23 +1465,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create_signed: + nodes_nodes_devices_create_signed: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create_signed: + customers_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + customers_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' @@ -1468,17 +1500,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create_signed: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_devices_create_signed: + deployments_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1489,21 +1514,21 @@ components: #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed update: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed replace: [] delete: [] deployments: @@ -1511,12 +1536,6 @@ components: name: deployments title: Deployments methods: - deployments_get: - operation: - $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' nodes_deployments_move: operation: $ref: >- @@ -1567,27 +1586,34 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.deployments - customers_deployments_delete: + customers_nodes_deployments_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_patch: + objectKey: $.deployments + customers_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_get: + customers_deployments_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_deployments_list: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.deployments customers_deployments_move: operation: $ref: >- @@ -1595,50 +1621,49 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_list: + customers_deployments_patch: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_create: + customers_deployments_delete: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_deployments_create: + customers_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_deployments_list: + deployments_get: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/deployments_get + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/deployments_get insert: - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create @@ -1662,26 +1687,6 @@ components: name: nodes title: Nodes methods: - nodes_nodes_nodes_list: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_nodes_create: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_nodes_move: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' - response: - mediaType: application/json - openAPIDocKey: '200' nodes_nodes_list: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' @@ -1695,166 +1700,108 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_delete: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' nodes_nodes_patch: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_move: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_patch: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_list - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_list' - insert: - - $ref: >- - #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_create - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_create' - update: - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' - - $ref: >- - #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' - node: - id: google.prod_tt_sasportal.node - name: node - title: Node - methods: - nodes_nodes_get: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_get: + nodes_nodes_delete: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' - insert: [] - update: [] - replace: [] - delete: [] - installer: - id: google.prod_tt_sasportal.installer - name: installer - title: Installer - methods: - installer_generate_secret: + nodes_nodes_move: operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' response: mediaType: application/json openAPIDocKey: '200' - installer_validate: + nodes_nodes_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - policies: - id: google.prod_tt_sasportal.policies - name: policies - title: Policies - methods: - policies_set: + objectKey: $.nodes + nodes_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - policies_get: + customers_nodes_patch: operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch response: mediaType: application/json openAPIDocKey: '200' - policies_test: + customers_nodes_move: operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' - insert: [] - update: [] + - $ref: >- + #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_list + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_list' + insert: + - $ref: >- + #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_create + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_create' + update: + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' + - $ref: >- + #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch replace: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' customer_nodes: id: google.prod_tt_sasportal.customer_nodes name: customer_nodes title: Customer_nodes methods: - customers_nodes_nodes_list: + customers_nodes_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_nodes_create: + customers_nodes_list: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.nodes customers_nodes_create: operation: $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_list: + customers_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_delete: + customers_nodes_nodes_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.nodes sqlVerbs: select: - $ref: >- @@ -1895,9 +1842,9 @@ components: name: customers title: Customers methods: - customers_setup_sas_analytics: + customers_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -1907,15 +1854,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_get: + customers_provision_deployment: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' response: mediaType: application/json openAPIDocKey: '200' - customers_provision_deployment: + customers_migrate_organization: operation: - $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1926,9 +1873,9 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.customers - customers_migrate_organization: + customers_setup_sas_analytics: operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' + $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1979,23 +1926,188 @@ components: update: [] replace: [] delete: [] + policies: + id: google.prod_tt_sasportal.policies + name: policies + title: Policies + methods: + policies_get: + operation: + $ref: '#/paths/~1v1alpha1~1policies:get/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_set: + operation: + $ref: '#/paths/~1v1alpha1~1policies:set/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_test: + operation: + $ref: '#/paths/~1v1alpha1~1policies:test/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' + insert: [] + update: [] + replace: [] + delete: [] + installer: + id: google.prod_tt_sasportal.installer + name: installer + title: Installer + methods: + installer_validate: + operation: + $ref: '#/paths/~1v1alpha1~1installer:validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + installer_generate_secret: + operation: + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] paths: - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + /v1alpha1/nodes/{nodesId}: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/alt' get: - description: Gets details about a device. - operationId: prod_tt_sasportal.deployments.devices.get + description: Returns a requested node. + operationId: prod_tt_sasportal.nodes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalListDevicesResponse' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2014,23 +2126,25 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - patch: - description: Updates a device. - operationId: prod_tt_sasportal.deployments.devices.patch + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + parameters: *ref_1 + post: + description: Moves a deployment under another node or customer. + operationId: prod_tt_sasportal.nodes.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2046,26 +2160,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.deployments.devices.delete + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: Returns a requested deployment. + operationId: prod_tt_sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2081,28 +2192,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: - parameters: *ref_1 patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.deployments.devices.updateSigned + description: Updates an existing deployment. + operationId: prod_tt_sasportal.nodes.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2118,28 +2227,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: - parameters: *ref_1 - post: - description: Signs a device. - operationId: prod_tt_sasportal.deployments.devices.signDevice - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2157,26 +2264,66 @@ paths: schema: $ref: '#/components/schemas/SasPortalEmpty' parameters: + - in: path + name: nodesId + required: true + schema: + type: string - in: path name: deploymentsId required: true schema: type: string + /v1alpha1/nodes/{nodesId}/deployments: + parameters: *ref_1 + get: + description: Lists deployments. + operationId: prod_tt_sasportal.nodes.deployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + parameters: - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices: parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.deployments.devices.move + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2192,23 +2339,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}: - parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.deployments.get + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2224,23 +2364,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: parameters: *ref_1 patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.nodes.devices.updateSigned + description: Updates a device. + operationId: prod_tt_sasportal.nodes.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2268,16 +2421,14 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2293,18 +2444,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: - parameters: *ref_1 - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.nodes.devices.delete + - in: path + name: devicesId + required: true + schema: + type: string + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2320,7 +2474,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -2332,14 +2486,16 @@ paths: required: true schema: type: string - patch: - description: Updates a device. - operationId: prod_tt_sasportal.nodes.devices.patch + /v1alpha1/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2362,19 +2518,53 @@ paths: required: true schema: type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.nodes.devices.updateSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' + parameters: - in: path - name: devicesId + name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets details about a device. - operationId: prod_tt_sasportal.nodes.devices.get + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + parameters: *ref_1 + post: + description: Signs a device. + operationId: prod_tt_sasportal.nodes.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2390,7 +2580,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -2402,16 +2592,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.create + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.nodes.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2427,16 +2617,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId required: true schema: type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes: + parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.list + description: Lists nodes. + operationId: prod_tt_sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2452,7 +2649,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: nodesId @@ -2472,16 +2669,14 @@ paths: name: filter schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: - parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.nodes.devices.move + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2497,28 +2692,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: parameters: *ref_1 - post: - description: Signs a device. - operationId: prod_tt_sasportal.nodes.devices.signDevice + patch: + description: Updates an existing node. + operationId: prod_tt_sasportal.nodes.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2534,7 +2724,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -2542,20 +2732,18 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: - parameters: *ref_1 - post: - description: Moves a deployment under another node or customer. - operationId: prod_tt_sasportal.nodes.deployments.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a node. + operationId: prod_tt_sasportal.nodes.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2571,7 +2759,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -2579,15 +2767,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: - parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.nodes.deployments.get + description: Returns a requested node. + operationId: prod_tt_sasportal.nodes.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2603,7 +2789,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -2611,18 +2797,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - patch: - description: Updates an existing deployment. - operationId: prod_tt_sasportal.nodes.deployments.patch + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: + parameters: *ref_1 + post: + description: Moves a node under another node or customer. + operationId: prod_tt_sasportal.nodes.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2638,7 +2826,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -2646,18 +2834,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.nodes.deployments.delete + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + parameters: *ref_1 + post: + description: Creates a new deployment. + operationId: prod_tt_sasportal.nodes.nodes.deployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2673,7 +2863,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -2681,15 +2871,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments: - parameters: *ref_1 get: description: Lists deployments. - operationId: prod_tt_sasportal.nodes.deployments.list + operationId: prod_tt_sasportal.nodes.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2712,24 +2900,29 @@ paths: required: true schema: type: string + - in: path + name: nodesId1 + required: true + schema: + type: string - in: query name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: parameters: *ref_1 get: description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.list + operationId: prod_tt_sasportal.nodes.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2753,26 +2946,26 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: filter schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string post: description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.create + operationId: prod_tt_sasportal.nodes.nodes.devices.create requestBody: content: application/json: @@ -2801,15 +2994,15 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: parameters: *ref_1 post: description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.createSigned + operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned requestBody: content: application/json: @@ -2831,73 +3024,6 @@ paths: application/json: schema: $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: - parameters: *ref_1 - post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.nodes.nodes.deployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - get: - description: Lists deployments. - operationId: prod_tt_sasportal.nodes.nodes.deployments.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId @@ -2906,20 +3032,7 @@ paths: type: string - in: path name: nodesId1 - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + required: true schema: type: string /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: @@ -2960,11 +3073,11 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string post: @@ -3002,11 +3115,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + /v1alpha1/customers/{customersId}/nodes/{nodesId}: parameters: *ref_1 - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.list + patch: + description: Updates an existing node. + operationId: prod_tt_sasportal.customers.nodes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3022,39 +3140,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + format: google-fieldmask + delete: + description: Deletes a node. + operationId: prod_tt_sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3070,28 +3175,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + get: + description: Returns a requested node. + operationId: prod_tt_sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3107,28 +3205,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: + /v1alpha1/customers/{customersId}/nodes: parameters: *ref_1 - post: - description: Moves a node under another node or customer. - operationId: prod_tt_sasportal.nodes.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + get: + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3144,23 +3237,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - - in: path - name: nodesId1 - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1alpha1/nodes/{nodesId}/nodes: - parameters: *ref_1 - get: - description: Lists nodes. - operationId: prod_tt_sasportal.nodes.nodes.list + - in: query + name: filter + schema: + type: string + post: + description: Creates a new node. + operationId: prod_tt_sasportal.customers.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3176,34 +3280,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + parameters: *ref_1 post: - description: Creates a new node. - operationId: prod_tt_sasportal.nodes.nodes.create + description: Moves a node under another node or customer. + operationId: prod_tt_sasportal.customers.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3219,18 +3312,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalOperation' parameters: + - in: path + name: customersId + required: true + schema: + type: string - in: path name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: parameters: *ref_1 - get: - description: Returns a requested node. - operationId: prod_tt_sasportal.nodes.nodes.get + post: + description: Creates a new node. + operationId: prod_tt_sasportal.customers.nodes.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3249,18 +3352,18 @@ paths: $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - delete: - description: Deletes a node. - operationId: prod_tt_sasportal.nodes.nodes.delete + get: + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3276,26 +3379,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - patch: - description: Updates an existing node. - operationId: prod_tt_sasportal.nodes.nodes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + parameters: *ref_1 + get: + description: Lists deployments. + operationId: prod_tt_sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3311,28 +3424,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}: - parameters: *ref_1 - get: - description: Returns a requested node. - operationId: prod_tt_sasportal.nodes.get + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a new deployment. + operationId: prod_tt_sasportal.customers.nodes.deployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3348,23 +3472,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: + - in: path + name: customersId + required: true + schema: + type: string - in: path name: nodesId required: true schema: type: string - /v1alpha1/installer:generateSecret: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: parameters: *ref_1 post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: prod_tt_sasportal.installer.generateSecret + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3380,18 +3509,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/installer:validate: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: nodesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: parameters: *ref_1 post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: prod_tt_sasportal.installer.validate + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3407,20 +3546,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' - parameters: [] - /v1alpha1/policies:set: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: prod_tt_sasportal.policies.set - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSetPolicyRequest' + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: nodesId + required: true + schema: + type: string + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.customers.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3436,20 +3576,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:get: + $ref: '#/components/schemas/SasPortalListDevicesResponse' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: parameters: *ref_1 - post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: prod_tt_sasportal.policies.get - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalGetPolicyRequest' + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3465,18 +3621,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:test: - parameters: *ref_1 + $ref: '#/components/schemas/SasPortalListDevicesResponse' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Returns permissions that a caller has on the specified resource. - operationId: prod_tt_sasportal.policies.test + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3492,18 +3669,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' - parameters: [] - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.customers.devices.move + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3519,7 +3706,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3527,15 +3714,20 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}: + /v1alpha1/customers/{customersId}/deployments: parameters: *ref_1 - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.customers.devices.delete + post: + description: Creates a new deployment. + operationId: prod_tt_sasportal.customers.deployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3551,21 +3743,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string get: - description: Gets details about a device. - operationId: prod_tt_sasportal.customers.devices.get + description: Lists deployments. + operationId: prod_tt_sasportal.customers.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3581,26 +3768,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: pageToken schema: type: string - patch: - description: Updates a device. - operationId: prod_tt_sasportal.customers.devices.patch + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + parameters: *ref_1 + post: + description: Moves a deployment under another node or customer. + operationId: prod_tt_sasportal.customers.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3616,7 +3813,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -3624,25 +3821,20 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: parameters: *ref_1 patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.customers.devices.updateSigned + description: Updates an existing deployment. + operationId: prod_tt_sasportal.customers.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3658,7 +3850,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -3666,15 +3858,18 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices: - parameters: *ref_1 - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.devices.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.customers.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3690,34 +3885,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: deploymentsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + get: + description: Returns a requested deployment. + operationId: prod_tt_sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3733,23 +3915,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}: parameters: *ref_1 - post: - description: Signs a device. - operationId: prod_tt_sasportal.customers.devices.signDevice + patch: + description: Updates a device. + operationId: prod_tt_sasportal.customers.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3765,7 +3952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3777,16 +3964,14 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.customers.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3802,23 +3987,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + - in: path + name: devicesId + required: true + schema: + type: string + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.customers.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3842,15 +4025,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: parameters: *ref_1 - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.list + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.customers.devices.updateSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3866,7 +4054,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3874,31 +4062,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: + parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.create + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.customers.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3914,7 +4091,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -3922,15 +4099,15 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + /v1alpha1/customers/{customersId}/devices: parameters: *ref_1 - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.customers.deployments.delete + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3946,26 +4123,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: - description: Updates an existing deployment. - operationId: prod_tt_sasportal.customers.deployments.patch + - in: query + name: filter + schema: + type: string + post: + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3981,26 +4166,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.customers.deployments.get + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + parameters: *ref_1 + post: + description: Signs a device. + operationId: prod_tt_sasportal.customers.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4016,7 +4198,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -4024,20 +4206,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + /v1alpha1/customers/{customersId}/devices:createSigned: parameters: *ref_1 post: - description: Moves a deployment under another node or customer. - operationId: prod_tt_sasportal.customers.deployments.move + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4053,23 +4235,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/deployments: + /v1alpha1/customers/{customersId}: parameters: *ref_1 get: - description: Lists deployments. - operationId: prod_tt_sasportal.customers.deployments.list + description: Returns a requested customer. + operationId: prod_tt_sasportal.customers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4085,34 +4262,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalCustomer' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.customers.deployments.create + patch: + description: Updates an existing customer. + operationId: prod_tt_sasportal.customers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalCustomer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4128,18 +4292,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalCustomer' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers:listGcpProjectDeployments: parameters: *ref_1 get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.nodes.list + description: >- + Returns a list of SAS deployments associated with current GCP project. + Includes whether SAS analytics has been enabled or not. + operationId: prod_tt_sasportal.customers.listGcpProjectDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4155,39 +4326,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.nodes.create + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers:provisionDeployment: + parameters: *ref_1 + post: + description: >- + Creates a new SAS deployment through the GCP workflow. Creates a SAS + organization if an organization match is not found. + operationId: prod_tt_sasportal.customers.provisionDeployment requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4203,28 +4356,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: + $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' + parameters: [] + /v1alpha1/customers:migrateOrganization: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.createSigned + description: >- + Migrates a SAS organization to the cloud. This will create GCP projects + for each deployment and associate them. The SAS Organization is linked + to the gcp project that called the command. + go/sas-legacy-customer-migration + operationId: prod_tt_sasportal.customers.migrateOrganization requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4240,28 +4387,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers:listLegacyOrganizations: parameters: *ref_1 - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + get: + description: Returns a list of legacy organizations. + operationId: prod_tt_sasportal.customers.listLegacyOrganizations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4277,21 +4409,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' + parameters: [] + /v1alpha1/customers: + parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.list + description: Returns a list of requested customers. + operationId: prod_tt_sasportal.customers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4307,41 +4431,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListCustomersResponse' parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - in: query - name: filter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + /v1alpha1/customers:setupSasAnalytics: parameters: *ref_1 post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.customers.nodes.deployments.create + description: >- + Setups the a GCP Project to receive SAS Analytics messages via GCP + Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and + BigQuery tables are created automatically as part of this service. + operationId: prod_tt_sasportal.customers.setupSasAnalytics requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4357,21 +4470,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - get: - description: Lists deployments. - operationId: prod_tt_sasportal.customers.nodes.deployments.list + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/policies:get: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: prod_tt_sasportal.policies.get + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4387,41 +4499,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/customers/{customersId}/nodes: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:set: parameters: *ref_1 post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.create + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: prod_tt_sasportal.policies.set requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4437,16 +4528,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.list + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:test: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: prod_tt_sasportal.policies.test + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalTestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4462,36 +4555,72 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + parameters: [] + /v1alpha1/installer:validate: + parameters: *ref_1 + post: + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: prod_tt_sasportal.installer.validate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + parameters: [] + /v1alpha1/installer:generateSecret: + parameters: *ref_1 + post: + description: Generates a secret to be used with the ValidateInstaller. + operationId: prod_tt_sasportal.installer.generateSecret + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + parameters: [] + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: parameters: *ref_1 - post: - description: Moves a node under another node or customer. - operationId: prod_tt_sasportal.customers.nodes.move + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.deployments.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4507,28 +4636,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: parameters: *ref_1 patch: - description: Updates an existing node. - operationId: prod_tt_sasportal.customers.nodes.patch + description: Updates a device. + operationId: prod_tt_sasportal.deployments.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4544,15 +4673,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string @@ -4562,8 +4691,8 @@ paths: type: string format: google-fieldmask get: - description: Returns a requested node. - operationId: prod_tt_sasportal.customers.nodes.get + description: Gets details about a device. + operationId: prod_tt_sasportal.deployments.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4579,21 +4708,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string delete: - description: Deletes a node. - operationId: prod_tt_sasportal.customers.nodes.delete + description: Deletes a device. + operationId: prod_tt_sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4612,55 +4741,25 @@ paths: $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers:setupSasAnalytics: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: >- - Setups the a GCP Project to receive SAS Analytics messages via GCP - Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and - BigQuery tables are created automatically as part of this service. - operationId: prod_tt_sasportal.customers.setupSasAnalytics - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers/{customersId}: - parameters: *ref_1 - patch: - description: Updates an existing customer. - operationId: prod_tt_sasportal.customers.patch + description: Signs a device. + operationId: prod_tt_sasportal.deployments.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4676,102 +4775,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Returns a requested customer. - operationId: prod_tt_sasportal.customers.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCustomer' - parameters: - in: path - name: customersId + name: devicesId required: true schema: type: string - /v1alpha1/customers:provisionDeployment: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: parameters: *ref_1 post: - description: >- - Creates a new SAS deployment through the GCP workflow. Creates a SAS - organization if an organization match is not found. - operationId: prod_tt_sasportal.customers.provisionDeployment + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.deployments.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' - parameters: [] - /v1alpha1/customers:listGcpProjectDeployments: - parameters: *ref_1 - get: - description: >- - Returns a list of SAS deployments associated with current GCP project. - Includes whether SAS analytics has been enabled or not. - operationId: prod_tt_sasportal.customers.listGcpProjectDeployments - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/SasPortalListGcpProjectDeploymentsResponse - parameters: [] - /v1alpha1/customers: - parameters: *ref_1 - get: - description: Returns a list of requested customers. - operationId: prod_tt_sasportal.customers.list + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4787,53 +4812,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - - in: query - name: pageToken + - in: path + name: deploymentsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: devicesId + required: true schema: - type: integer - format: int32 - /v1alpha1/customers:listLegacyOrganizations: + type: string + /v1alpha1/deployments/{deploymentsId}: parameters: *ref_1 get: - description: Returns a list of legacy organizations. - operationId: prod_tt_sasportal.customers.listLegacyOrganizations - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' - parameters: [] - /v1alpha1/customers:migrateOrganization: - parameters: *ref_1 - post: - description: >- - Migrates a SAS organization to the cloud. This will create GCP projects - for each deployment and associate them. The SAS Organization is linked - to the gcp project that called the command. - go/sas-legacy-customer-migration - operationId: prod_tt_sasportal.customers.migrateOrganization - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + description: Returns a requested deployment. + operationId: prod_tt_sasportal.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4849,5 +4844,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] + $ref: '#/components/schemas/SasPortalDeployment' + parameters: + - in: path + name: deploymentsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml b/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml index e5faff85..583961d9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml @@ -36,172 +36,129 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecaptchaenterpriseV1IpOverrideData: - description: Information about the IP or IP range override. - properties: - overrideType: - enumDescriptions: - - >- - Default override type that indicates this enum hasn't been - specified. - - >- - Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 - for all valid assessments. - description: Required. Describes the type of IP override. - enum: - - OVERRIDE_TYPE_UNSPECIFIED - - ALLOW - type: string - ip: - description: >- - Required. The IP address to override (can be IPv4, IPv6 or CIDR). - The IP override must be a valid IPv4 or IPv6 address, or a CIDR - range. The IP override must be a public IP address. Example of IPv4: - 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B - Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: - 2001:0DB8:1234::/48 - type: string - id: GoogleCloudRecaptchaenterpriseV1IpOverrideData - type: object - GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest: - properties: - ipOverrideData: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' - description: Required. IP override added to the key. - id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest - description: The AddIpOverride request message. - type: object - GoogleCloudRecaptchaenterpriseV1ScoreMetrics: - type: object + GoogleCloudRecaptchaenterpriseV1FraudSignals: properties: - actionMetrics: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + cardSignals: description: >- - Action-based metrics. The map key is the action name which specified - by the site owners at time of the "execute" client-side call. - overallMetrics: + Output only. Signals describing the payment card or cards used in + this transaction. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution - description: Aggregated score metrics for all traffic. - description: Metrics related to scoring. - id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: - id: >- - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse - type: object - description: The response to a `ListRelatedAccountGroupMemberships` call. - properties: - relatedAccountGroupMemberships: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - description: The memberships listed by the query. - 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 - GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: - type: object - description: >- - A substitute action transparently serves a different page than the one - requested. - properties: - path: - type: string - description: >- - Optional. The address to redirect to. The target is a relative path - in the current host. Example: "/blog/404.html". - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction - GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: - type: object - properties: - lastVerificationTime: - description: >- - Output only. Timestamp of the last successful verification for the - endpoint, if any. - format: google-datetime - type: string + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals readOnly: true - requestToken: - type: string + userSignals: readOnly: true - description: >- - Output only. Token to provide to the client to trigger endpoint - verification. It must be used within 15 minutes. - phoneNumber: - type: string - description: >- - Phone number for which to trigger a verification request. Should be - given in E.164 format. - emailAddress: - type: string - description: Email address for which to trigger a verification request. - description: Information about a verification endpoint that can be used for 2FA. - id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - GoogleCloudRecaptchaenterpriseV1ScoreDistribution: - description: Score distribution. - properties: - scoreBuckets: - description: >- - Map key is score value multiplied by 100. The scores are discrete - values between [0, 1]. The maximum number of buckets is on order of - a few dozen, but typically much lower (ie. 10). - additionalProperties: - type: string - format: int64 - type: object + description: Output only. Signals describing the end user in this transaction. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + description: Fraud signals describing users and cards involved in the transaction. + id: GoogleCloudRecaptchaenterpriseV1FraudSignals type: object - id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: - type: object id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict - description: Information about SMS toll fraud. + type: object properties: reasons: - description: Output only. Reasons contributing to the SMS toll fraud verdict. type: array + description: Output only. Reasons contributing to the SMS toll fraud verdict. + readOnly: true items: - type: string - enumDescriptions: - - Default unspecified reason - - The provided phone number was invalid enum: - SMS_TOLL_FRAUD_REASON_UNSPECIFIED - INVALID_PHONE_NUMBER - readOnly: true + enumDescriptions: + - Default unspecified reason + - The provided phone number was invalid + type: string risk: - format: float - type: number description: >- Output only. Probability of an SMS event being fraudulent. Values are from 0.0 (lowest) to 1.0 (highest). readOnly: true - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: - description: The request message to search related account group memberships. - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + format: float + type: number + description: Information about SMS toll fraud. + GoogleCloudRecaptchaenterpriseV1RiskAnalysis: + type: object properties: - pageSize: - format: int32 + reasons: + readOnly: true + items: + enum: + - CLASSIFICATION_REASON_UNSPECIFIED + - AUTOMATION + - UNEXPECTED_ENVIRONMENT + - TOO_MUCH_TRAFFIC + - UNEXPECTED_USAGE_PATTERNS + - LOW_CONFIDENCE_SCORE + - SUSPECTED_CARDING + - SUSPECTED_CHARGEBACK + enumDescriptions: + - Default unspecified type. + - Interactions matched the behavior of an automated agent. + - The event originated from an illegitimate environment. + - Traffic volume from the event source is higher than normal. + - >- + Interactions with the site were significantly different than + expected patterns. + - >- + Too little traffic has been received from this site thus far to + generate quality risk analysis. + - >- + The request matches behavioral characteristics of a carding + attack. + - >- + The request matches behavioral characteristics of chargebacks + for fraud. + type: string + description: Output only. Reasons contributing to the risk analysis verdict. + type: array + extendedVerdictReasons: + readOnly: true + items: + type: string description: >- - Optional. The maximum number of groups to return. The service might - return fewer than this value. If unspecified, at most 50 groups are - returned. The maximum value is 1000; values above 1000 are coerced - to 1000. - type: integer - pageToken: + Output only. Extended verdict reasons to be used for experimentation + only. The set of possible reasons is subject to change. + type: array + score: + type: number + readOnly: true + format: float + description: >- + Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very + likely legitimate traffic while 0.0 means very likely non-legitimate + traffic). + id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis + description: Risk analysis result for an event. + GoogleCloudRecaptchaenterpriseV1UserInfo: + description: >- + User information associated with a request protected by reCAPTCHA + Enterprise. + type: object + id: GoogleCloudRecaptchaenterpriseV1UserInfo + properties: + userIds: + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' + description: Optional. Identifiers associated with this user or request. + type: array + createAccountTime: + description: >- + Optional. Creation time for this account associated with this user. + Leave blank for non logged-in actions, guest checkout, or when there + is no account associated with the current user. type: string + format: google-datetime + accountId: description: >- - Optional. A page token, received from a previous - `SearchRelatedAccountGroupMemberships` call. Provide this to - retrieve the subsequent page. When paginating, all other parameters - provided to `SearchRelatedAccountGroupMemberships` must match the - call that provided the page token. + Optional. For logged-in requests or login/registration requests, the + unique account identifier associated with this user. You can use the + username if it is stable (meaning it is the same for every request + associated with the same user), or any stable user ID of your + choice. Leave blank for non logged-in actions or guest checkout. + type: string + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: + properties: accountId: description: >- Optional. The unique stable account identifier used to search @@ -210,412 +167,532 @@ components: call. Either hashed_account_id or account_id must be set, but not both. type: string + pageSize: + format: int32 + description: >- + Optional. The maximum number of groups to return. The service might + return fewer than this value. If unspecified, at most 50 groups are + returned. The maximum value is 1000; values above 1000 are coerced + to 1000. + type: integer hashedAccountId: - deprecated: true - format: byte - type: string description: >- Optional. Deprecated: use `account_id` instead. The unique stable hashed account identifier used to search connections. The identifier should correspond to a `hashed_account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or account_id must be set, but not both. - type: object - GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest: - type: object - id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest - description: The removeIpOverride request message. - properties: - ipOverrideData: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' - description: Required. IP override to be removed from the key. - GoogleCloudRecaptchaenterpriseV1Event: - properties: - wafTokenAssessment: - type: boolean - description: >- - Optional. Flag for running WAF token assessment. If enabled, the - token must be specified, and have been created by a WAF-enabled key. - userInfo: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' - description: >- - Optional. Information about the user that generates this event, when - they can be identified. They are often identified through the use of - an account for logged-in requests or login/registration requests, or - by providing user identifiers for guest actions like checkout. - ja3: - type: string - description: Optional. JA3 fingerprint for SSL clients. - fraudPrevention: - description: Optional. The Fraud Prevention setting for this assessment. - enum: - - FRAUD_PREVENTION_UNSPECIFIED - - ENABLED - - DISABLED - enumDescriptions: - - >- - Default, unspecified setting. If opted in for automatic detection, - `fraud_prevention_assessment` is returned based on the request. - Otherwise, `fraud_prevention_assessment` is returned if - `transaction_data` is present in the `Event` and Fraud Prevention - is enabled in the Google Cloud console. - - >- - Enable Fraud Prevention for this assessment, if Fraud Prevention - is enabled in the Google Cloud console. - - >- - Disable Fraud Prevention for this assessment, regardless of opt-in - status or Google Cloud console settings. - type: string - userAgent: type: string - description: >- - Optional. The user agent present in the request from the user's - device related to this event. - siteKey: - description: >- - Optional. The site key that was used to invoke reCAPTCHA Enterprise - on your site and generate the token. + deprecated: true + format: byte + pageToken: type: string - firewallPolicyEvaluation: - type: boolean description: >- - Optional. Flag for enabling firewall policy config assessment. If - this flag is enabled, the firewall policy is evaluated and a - suggested firewall action is returned in the response. - express: - type: boolean + Optional. A page token, received from a previous + `SearchRelatedAccountGroupMemberships` call. Provide this to + retrieve the subsequent page. When paginating, all other parameters + provided to `SearchRelatedAccountGroupMemberships` must match the + call that provided the page token. + type: object + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + description: The request message to search related account group memberships. + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: + type: object + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict + description: >- + Information about card testing fraud, where an adversary is testing + fraudulently obtained cards or brute forcing their details. + properties: + risk: + readOnly: true + type: number + format: float description: >- - Optional. Flag for a reCAPTCHA express request for an assessment - without a token. If enabled, `site_key` must reference an Express - site key. - token: + Output only. Probability of this transaction attempt being part of a + card testing attack. Values are from 0.0 (lowest) to 1.0 (highest). + GoogleCloudRecaptchaenterpriseV1FirewallPolicy: + description: >- + A FirewallPolicy represents a single matching pattern and resulting + actions to take. + type: object + properties: + description: type: string description: >- - Optional. The user response token provided by the reCAPTCHA - Enterprise client-side integration on your site. - transactionData: + Optional. A description of what this policy aims to achieve, for + convenience purposes. The description can at most include 256 UTF-8 + characters. + actions: + type: array description: >- - Optional. Data describing a payment transaction to be assessed. - Sending this data enables reCAPTCHA Enterprise Fraud Prevention and - the FraudPreventionAssessment component in the response. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData' - requestedUri: + Optional. The actions that the caller should take regarding user + access. There should be at most one terminal action. A terminal + action is any action that forces a response, such as `AllowAction`, + `BlockAction` or `SubstituteAction`. Zero or more non-terminal + actions such as `SetHeader` might be specified. A single policy can + contain up to 16 actions. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction + path: description: >- - Optional. The URI resource the user requested that triggered an - assessment. + Optional. The path for which this policy applies, specified as a + glob pattern. For more information on glob, see the [manual + page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has + a max length of 200 characters. type: string - expectedAction: + condition: type: string description: >- - Optional. The expected action for this type of event. This should be - the same action provided at token generation time on client-side - platforms already integrated with recaptcha enterprise. - userIpAddress: - type: string + Optional. A CEL (Common Expression Language) conditional expression + that specifies if this policy applies to an incoming user request. + If this condition evaluates to true and the requested path matched + the path pattern, the associated actions should be executed by the + caller. The condition string is checked for CEL syntax correctness + on creation. For more information, see the [CEL + spec](https://github.com/google/cel-spec) and its [language + definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). + A condition has a max length of 500 characters. + name: description: >- - Optional. The IP address in the request from the user's device - related to this event. - headers: + Identifier. The resource name for the FirewallPolicy in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. + type: string + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy + GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: + type: object + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + properties: + cardLabels: + type: array + description: Output only. The labels for the payment card in this transaction. + readOnly: true items: type: string - description: Optional. HTTP header information about the request. + enum: + - CARD_LABEL_UNSPECIFIED + - PREPAID + - VIRTUAL + - UNEXPECTED_LOCATION + enumDescriptions: + - No label specified. + - This card has been detected as prepaid. + - >- + This card has been detected as virtual, such as a card number + generated for a single transaction or merchant. + - >- + This card has been detected as being used in an unexpected + geographic location. + description: Signals describing the payment card used in this transaction. + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: + description: The reorder firewall policies request message. + type: object + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest + properties: + names: type: array - hashedAccountId: - deprecated: true description: >- - Optional. Deprecated: use `user_info.account_id` instead. Unique - stable hashed user identifier for the request. The identifier must - be hashed using hmac-sha256 with stable secret. - type: string - format: byte - type: object - id: GoogleCloudRecaptchaenterpriseV1Event - description: The event being assessed. - GoogleCloudRecaptchaenterpriseV1ExpressKeySettings: - properties: {} - description: Settings specific to keys that can be used for reCAPTCHA Express. - type: object - id: GoogleCloudRecaptchaenterpriseV1ExpressKeySettings - GoogleCloudRecaptchaenterpriseV1TransactionDataItem: + Required. A list containing all policy names, in the new order. Each + name is in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. + items: + type: string + GoogleCloudRecaptchaenterpriseV1TokenProperties: + id: GoogleCloudRecaptchaenterpriseV1TokenProperties properties: - quantity: - format: int64 + hostname: type: string - description: Optional. The quantity of this item that is being purchased. - merchantAccountId: + description: >- + Output only. The hostname of the page on which the token was + generated (Web keys only). + readOnly: true + valid: + description: >- + Output only. Whether the provided user response token is valid. When + valid = false, the reason could be specified in invalid_reason or it + could also be due to a user failing to solve a challenge or a + sitekey mismatch (i.e the sitekey used to generate the token was + different than the one specified in the assessment). + type: boolean + readOnly: true + invalidReason: + enumDescriptions: + - Default unspecified type. + - If the failure reason was not accounted for. + - The provided user verification token was malformed. + - The user verification token had expired. + - The user verification had already been seen. + - The user verification token was not present. + - >- + A retriable error (such as network failure) occurred on the + browser. Could easily be simulated by an attacker. + enum: + - INVALID_REASON_UNSPECIFIED + - UNKNOWN_INVALID_REASON + - MALFORMED + - EXPIRED + - DUPE + - MISSING + - BROWSER_ERROR + readOnly: true + description: Output only. Reason associated with the response when valid = false. type: string + androidPackageName: description: >- - Optional. When a merchant is specified, its corresponding - account_id. Necessary to populate marketplace-style transactions. - value: - format: double - type: number + Output only. The name of the Android package with which the token + was generated (Android keys only). + type: string + readOnly: true + createTime: + readOnly: true description: >- - Optional. The value per item that the user is paying, in the - transaction currency, after discounts. - name: + Output only. The timestamp corresponding to the generation of the + token. type: string - description: Optional. The full name of the item. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem - description: Line items being purchased in this transaction. - type: object - GoogleCloudRecaptchaenterpriseV1WebKeySettings: + format: google-datetime + action: + readOnly: true + type: string + description: Output only. Action name provided at token generation. + iosBundleId: + readOnly: true + description: >- + Output only. The ID of the iOS bundle with which the token was + generated (iOS keys only). + type: string + description: Properties of the provided event token. type: object - description: Settings specific to keys that can be used by websites. - id: GoogleCloudRecaptchaenterpriseV1WebKeySettings + GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: + description: Details about the transaction from the gateway. properties: - challengeSecurityPreference: - type: string - enum: - - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED - - USABILITY - - BALANCE - - SECURITY - enumDescriptions: - - Default type that indicates this enum hasn't been specified. - - Key tends to show fewer and easier challenges. - - Key tends to show balanced (in amount and difficulty) challenges. - - Key tends to show more and harder challenges. + avsResponseCode: description: >- - Optional. Settings for the frequency and difficulty at which this - key triggers captcha challenges. This should only be specified for - IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. - integrationType: - description: Required. Describes how this key is integrated with the website. - enumDescriptions: - - >- - Default type that indicates this enum hasn't been specified. This - is not a valid IntegrationType, one of the other types must be - specified instead. - - >- - Only used to produce scores. It doesn't display the "I'm not a - robot" checkbox and never shows captcha challenges. - - >- - Displays the "I'm not a robot" checkbox and may show captcha - challenges after it is checked. - - >- - Doesn't display the "I'm not a robot" checkbox, but may show - captcha challenges after risk analysis. - enum: - - INTEGRATION_TYPE_UNSPECIFIED - - SCORE - - CHECKBOX - - INVISIBLE + Optional. AVS response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). + type: string + name: type: string - allowAllDomains: - type: boolean - description: Optional. If set to true, it means allowed_domains are not enforced. - allowedDomains: description: >- - Optional. Domains or subdomains of websites allowed to use the key. - All subdomains of an allowed domain are automatically allowed. A - valid domain requires a host and must not include any path, port, - query or fragment. Examples: 'example.com' or - 'subdomain.example.com' - items: - type: string - type: array - allowAmpTraffic: + Optional. Name of the gateway service (for example, stripe, square, + paypal). + gatewayResponseCode: description: >- - Optional. If set to true, the key can be used on AMP (Accelerated - Mobile Pages) websites. This is supported only for the SCORE - integration type. - type: boolean - GoogleCloudRecaptchaenterpriseV1UserInfo: + Optional. Gateway response code describing the state of the + transaction. + type: string + cvvResponseCode: + type: string + description: >- + Optional. CVV response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). + type: object + id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo + GoogleCloudRecaptchaenterpriseV1WafSettings: description: >- - User information associated with a request protected by reCAPTCHA - Enterprise. + Settings specific to keys that can be used for WAF (Web Application + Firewall). + type: object properties: - createAccountTime: - description: >- - Optional. Creation time for this account associated with this user. - Leave blank for non logged-in actions, guest checkout, or when there - is no account associated with the current user. - format: google-datetime + wafFeature: type: string - accountId: - description: >- - Optional. For logged-in requests or login/registration requests, the - unique account identifier associated with this user. You can use the - username if it is stable (meaning it is the same for every request - associated with the same user), or any stable user ID of your - choice. Leave blank for non logged-in actions or guest checkout. + enumDescriptions: + - Undefined feature. + - Redirects suspicious traffic to reCAPTCHA. + - >- + Use reCAPTCHA session-tokens to protect the whole user session on + the site's domain. + - Use reCAPTCHA action-tokens to protect user actions. + - >- + Use reCAPTCHA WAF express protection to protect any content other + than web pages, like APIs and IoT devices. + description: Required. The WAF feature for which this key is enabled. + enum: + - WAF_FEATURE_UNSPECIFIED + - CHALLENGE_PAGE + - SESSION_TOKEN + - ACTION_TOKEN + - EXPRESS + wafService: + enum: + - WAF_SERVICE_UNSPECIFIED + - CA + - FASTLY + - CLOUDFLARE + - AKAMAI + description: Required. The WAF service that uses this key. + enumDescriptions: + - Undefined WAF + - Cloud Armor + - Fastly + - Cloudflare + - Akamai type: string - userIds: - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' - description: Optional. Identifiers associated with this user or request. + id: GoogleCloudRecaptchaenterpriseV1WafSettings + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: + id: >- + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction type: object - id: GoogleCloudRecaptchaenterpriseV1UserInfo - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: + properties: {} + description: >- + An include reCAPTCHA script action involves injecting reCAPTCHA + JavaScript code into the HTML returned by the site backend. This + reCAPTCHA script is tasked with collecting user signals on the requested + web page, issuing tokens as a cookie within the site domain, and + enabling their utilization in subsequent page requests. + GoogleCloudRecaptchaenterpriseV1UserId: + description: An identifier associated with a user. type: object - description: A membership in a group of related accounts. - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership properties: - name: + email: + description: Optional. An email address. type: string - description: >- - Required. Identifier. The resource name for this membership in the - format - `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. - accountId: - description: >- - The unique stable account identifier of the member. The identifier - corresponds to an `account_id` provided in a previous - `CreateAssessment` or `AnnotateAssessment` call. + username: type: string - hashedAccountId: - deprecated: true - format: byte description: >- - Deprecated: use `account_id` instead. The unique stable hashed - account identifier of the member. The identifier corresponds to a - `hashed_account_id` provided in a previous `CreateAssessment` or - `AnnotateAssessment` call. + Optional. A unique username, if different from all the other + identifiers and `account_id` that are provided. Can be a unique + login handle or display name for a user. + phoneNumber: type: string - GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: - properties: {} - description: >- - A redirect action returns a 307 (temporary redirect) response, pointing - the user to a reCAPTCHA interstitial page to attach a token. + description: Optional. A phone number. Should use the E.164 format. + id: GoogleCloudRecaptchaenterpriseV1UserId + GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: + id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + properties: + smsTollFraudVerdict: + description: >- + Output only. Assessment of this phone event for risk of SMS toll + fraud. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + readOnly: true + type: object + description: Assessment for Phone Fraud + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction - GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: properties: nextPageToken: - description: >- - Token to retrieve the next page of results. It is set to empty if no - policies remain in results. type: string - firewallPolicies: - description: Policy details. + 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. + relatedAccountGroups: type: array + description: The groups of related accounts listed by the query. items: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - description: Response to request to list firewall policies belonging to a project. - type: object - id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse - GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse + description: The response to a `ListRelatedAccountGroups` call. + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse properties: - gatewayResponseCode: + relatedAccountGroupMemberships: + type: array + description: The queried memberships. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + nextPageToken: type: string description: >- - Optional. Gateway response code describing the state of the - transaction. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + description: The response to a `SearchRelatedAccountGroupMemberships` call. + type: object + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse + description: The reorder firewall policies response message. + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: + description: A group of related accounts. + type: object + properties: name: type: string description: >- - Optional. Name of the gateway service (for example, stripe, square, - paypal). - avsResponseCode: - description: >- - Optional. AVS response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). + Required. Identifier. The resource name for the related account + group in the format + `projects/{project}/relatedaccountgroups/{related_account_group}`. + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction + properties: {} + description: An allow action continues processing a request unimpeded. + type: object + GoogleCloudRecaptchaenterpriseV1IpOverrideData: + id: GoogleCloudRecaptchaenterpriseV1IpOverrideData + description: Information about the IP or IP range override. + type: object + properties: + overrideType: + enum: + - OVERRIDE_TYPE_UNSPECIFIED + - ALLOW type: string - cvvResponseCode: + enumDescriptions: + - >- + Default override type that indicates this enum hasn't been + specified. + - >- + Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 + for all valid assessments. + description: Required. Describes the type of IP override. + ip: type: string description: >- - Optional. CVV response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). + Required. The IP address to override (can be IPv4, IPv6 or CIDR). + The IP override must be a valid IPv4 or IPv6 address, or a CIDR + range. The IP override must be a public IP address. Example of IPv4: + 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B + Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: + 2001:0DB8:1234::/48 + GoogleCloudRecaptchaenterpriseV1ExpressKeySettings: type: object - description: Details about the transaction from the gateway. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo - GoogleCloudRecaptchaenterpriseV1FirewallAction: + id: GoogleCloudRecaptchaenterpriseV1ExpressKeySettings + description: Settings specific to keys that can be used for reCAPTCHA Express. + properties: {} + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: type: object - description: >- - An individual action. Each action represents what to do if a policy - matches. + description: Assessment for Fraud Prevention. properties: - allow: - description: >- - The user request did not match any policy and should be allowed - access to the requested resource. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction - substitute: + stolenInstrumentVerdict: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict + readOnly: true description: >- - This action transparently serves a different page to an offending - user. - redirect: + Output only. Assessment of this transaction for risk of a stolen + instrument. + transactionRisk: + format: float + readOnly: true + type: number description: >- - This action redirects the request to a reCAPTCHA interstitial to - attach a token. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction - setHeader: + Output only. Probability of this transaction being fraudulent. + Summarizes the combined risk of attack vectors below. Values are + from 0.0 (lowest) to 1.0 (highest). + cardTestingVerdict: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction - description: >- - This action sets a custom header but allow the request to continue - to the customer backend. - block: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict description: >- - This action denies access to a given page. The user gets an HTTP - error code. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction - includeRecaptchaScript: + Output only. Assessment of this transaction for risk of being part + of a card testing attack. + readOnly: true + behavioralTrustVerdict: + description: Output only. Assessment of this transaction for behavioral trust. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: + properties: + keyId: + type: string + description: Required. The Apple developer key ID (10-character string). + teamId: description: >- - This action injects reCAPTCHA JavaScript code into the HTML page - returned by the site backend. - id: GoogleCloudRecaptchaenterpriseV1FirewallAction - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: + Required. The Apple team ID (10-character string) owning the + provisioning profile used to build your application. + type: string + privateKey: + description: >- + Required. Input only. A private key (downloaded as a text file with + a .p8 file extension) generated for your Apple Developer account. + Ensure that Apple DeviceCheck is enabled for the private key. + type: string description: >- - Information about stolen instrument fraud, where the user is not the - legitimate owner of the instrument being used for the purchase. - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict + Contains fields that are required to perform Apple-specific integrity + checks. + id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId + type: object + GoogleProtobufEmpty: + properties: {} + type: object + id: GoogleProtobufEmpty + 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); } + GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: type: object + description: Structured address format for billing and shipping addresses. properties: - risk: - type: number - readOnly: true + recipient: + type: string description: >- - Output only. Probability of this transaction being executed with a - stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). - format: float + Optional. The recipient name, potentially including information such + as "care of". + address: + items: + type: string + type: array + description: >- + Optional. The first lines of the address. The first line generally + contains the street name and number, and further lines may include + information such as an apartment number. + postalCode: + type: string + description: Optional. The postal or ZIP code of the address. + regionCode: + type: string + description: Optional. The CLDR country/region of the address. + administrativeArea: + description: >- + Optional. The state, province, or otherwise administrative area of + the address. + type: string + locality: + type: string + description: Optional. The town/city of the address. + id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: + properties: + path: + type: string + description: >- + Optional. The address to redirect to. The target is a relative path + in the current host. Example: "/blog/404.html". + type: object + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + description: >- + A substitute action transparently serves a different page than the one + requested. + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + type: object + properties: {} + description: Empty response for AnnotateAssessment. GoogleCloudRecaptchaenterpriseV1Assessment: type: object description: A reCAPTCHA Enterprise assessment resource. id: GoogleCloudRecaptchaenterpriseV1Assessment properties: - fraudPreventionAssessment: + phoneFraudAssessment: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment description: >- - Output only. Assessment returned by Fraud Prevention when - TransactionData is provided. - readOnly: true - event: - description: Optional. The event being assessed. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' - riskAnalysis: + Output only. Assessment returned when a site key, a token, and a + phone number as `user_id` are provided. Account defender and SMS + toll fraud protection need to be enabled. readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' - description: Output only. The risk analysis result for the event being assessed. - tokenProperties: - description: Output only. Properties of the provided event token. + name: readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' + type: string + description: >- + Output only. Identifier. The resource name for the Assessment in the + format `projects/{project}/assessments/{assessment}`. assessmentEnvironment: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment description: >- Optional. The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user. - name: - description: >- - Output only. Identifier. The resource name for the Assessment in the - format `projects/{project}/assessments/{assessment}`. - readOnly: true - type: string + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment accountVerification: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo @@ -623,20 +700,21 @@ components: Optional. Account verification information for identity verification. The assessment event must include a token and site key to use this feature. - fraudSignals: + tokenProperties: + description: Output only. Properties of the provided event token. readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' + event: + description: Optional. The event being assessed. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' + firewallPolicyAssessment: description: >- - Output only. Fraud Signals specific to the users involved in a - payment transaction. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' - phoneFraudAssessment: - description: >- - Output only. Assessment returned when a site key, a token, and a - phone number as `user_id` are provided. Account defender and SMS - toll fraud protection need to be enabled. - readOnly: true + Output only. Assessment returned when firewall policies belonging to + the project are evaluated using the field + firewall_policy_evaluation. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + readOnly: true privatePasswordLeakVerification: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification @@ -644,65 +722,227 @@ components: Optional. The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials. - accountDefenderAssessment: + fraudSignals: description: >- - Output only. Assessment returned by account defender when an account - identifier is provided. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - readOnly: true - firewallPolicyAssessment: + Output only. Fraud Signals specific to the users involved in a + payment transaction. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' + readOnly: true + riskAnalysis: + description: Output only. The risk analysis result for the event being assessed. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' + accountDefenderAssessment: + readOnly: true + description: >- + Output only. Assessment returned by account defender when an account + identifier is provided. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment + fraudPreventionAssessment: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment readOnly: true description: >- - Output only. Assessment returned when firewall policies belonging to - the project are evaluated using the field - firewall_policy_evaluation. - GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: - id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId + Output only. Assessment returned by Fraud Prevention when + TransactionData is provided. + GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: type: object + id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + properties: {} + description: >- + A block action serves an HTTP error code a prevents the request from + hitting the backend. + GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: + id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics properties: - keyId: + passedCount: + format: int64 + description: >- + Count of nocaptchas (successful verification without a challenge) + plus submitted challenge solutions that were correct and resulted in + verification. type: string - description: Required. The Apple developer key ID (10-character string). - privateKey: + nocaptchaCount: + format: int64 type: string description: >- - Required. Input only. A private key (downloaded as a text file with - a .p8 file extension) generated for your Apple Developer account. - Ensure that Apple DeviceCheck is enabled for the private key. - teamId: + Count of nocaptchas (successful verification without a challenge) + issued. + pageloadCount: + format: int64 type: string description: >- - Required. The Apple team ID (10-character string) owning the - provisioning profile used to build your application. + Count of reCAPTCHA checkboxes or badges rendered. This is mostly + equivalent to a count of pageloads for pages that include reCAPTCHA. + failedCount: + type: string + format: int64 + description: >- + Count of submitted challenge solutions that were incorrect or + otherwise deemed suspicious such that a subsequent challenge was + triggered. + description: Metrics related to challenges. + type: object + GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest: + properties: + ipOverrideData: + description: Required. IP override added to the key. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' + id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest + description: The AddIpOverride request message. + type: object + GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse: + id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse + properties: {} + description: Response for RemoveIpOverride. + type: object + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: + properties: + risk: + readOnly: true + format: float + type: number + description: >- + Output only. Probability of this transaction being executed with a + stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict description: >- - Contains fields that are required to perform Apple-specific integrity - checks. - GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: + Information about stolen instrument fraud, where the user is not the + legitimate owner of the instrument being used for the purchase. + type: object + GoogleCloudRecaptchaenterpriseV1TransactionDataUser: + type: object properties: - username: + phoneNumber: + description: Optional. The phone number of the user, with country code. + type: string + emailVerified: + type: boolean description: >- - Username of the account that is being verified. Deprecated. - Customers should now provide the `account_id` field in - `event.user_info`. - deprecated: true + Optional. Whether the email has been verified to be accessible by + the user (OTP or similar). + email: + description: Optional. The email address of the user. + type: string + accountId: type: string - endpoints: - type: array - description: Optional. Endpoints that can be used for identity verification. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - languageCode: description: >- - Optional. Language code preference for the verification message, set - as a IETF BCP 47 language code. + Optional. Unique account identifier for this user. If using account + defender, this should match the hashed_account_id field. Otherwise, + a unique and persistent identifier for this account. + creationMs: + description: Optional. The epoch milliseconds of the user's account creation. + type: string + format: int64 + phoneVerified: + description: >- + Optional. Whether the phone number has been verified to be + accessible by the user (OTP or similar). + type: boolean + id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser + description: Details about a user's account involved in the transaction. + GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: + type: object + properties: + emailAddress: + type: string + description: Email address for which to trigger a verification request. + requestToken: + description: >- + Output only. Token to provide to the client to trigger endpoint + verification. It must be used within 15 minutes. + readOnly: true + type: string + phoneNumber: + description: >- + Phone number for which to trigger a verification request. Should be + given in E.164 format. + type: string + lastVerificationTime: + type: string + format: google-datetime + readOnly: true + description: >- + Output only. Timestamp of the last successful verification for the + endpoint, if any. + id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + description: Information about a verification endpoint that can be used for 2FA. + GoogleCloudRecaptchaenterpriseV1Key: + type: object + description: >- + A key used to identify and configure applications (web and/or mobile) + that use reCAPTCHA Enterprise. + id: GoogleCloudRecaptchaenterpriseV1Key + properties: + wafSettings: + description: Optional. Settings for WAF + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' + name: + description: >- + Identifier. The resource name for the Key in the format + `projects/{project}/keys/{key}`. + type: string + iosSettings: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' + description: Settings for keys that can be used by iOS apps. + createTime: type: string - latestVerificationResult: readOnly: true + description: >- + Output only. The timestamp corresponding to the creation of this + key. + format: google-datetime + testingOptions: + description: Optional. Options for user acceptance testing. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' + webSettings: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' + description: Settings for keys that can be used by websites. + androidSettings: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + description: Settings for keys that can be used by Android apps. + labels: + description: >- + Optional. See [Creating and managing labels] + (https://cloud.google.com/recaptcha/docs/labels). + additionalProperties: + type: string + type: object + displayName: type: string + description: >- + Required. Human-readable display name of this key. Modifiable by + user. + expressSettings: + description: Settings for keys that can be used by reCAPTCHA Express. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ExpressKeySettings + GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: + description: Policy config assessment. + properties: + error: + description: >- + Output only. If the processing of a policy config fails, an error is + populated and the firewall_policy is left empty. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + firewallPolicy: + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' + description: >- + Output only. The policy that matched the request. If more than one + policy may match, this is the first match. If no policy matches the + incoming request, the policy field is left empty. + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + type: object + GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: + description: Information about account verification, used for identity verification. + id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + properties: + latestVerificationResult: enum: - RESULT_UNSPECIFIED - SUCCESS_USER_VERIFIED @@ -714,6 +954,7 @@ components: - ERROR_CUSTOMER_QUOTA_EXHAUSTED - ERROR_VERIFICATION_BYPASSED - ERROR_VERDICT_MISMATCH + readOnly: true enumDescriptions: - No information about the latest account verification. - >- @@ -744,64 +985,92 @@ components: The request parameters do not match with the token provided and cannot be processed. description: Output only. Result of the latest account verification challenge. - type: object - id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo - description: Information about account verification, used for identity verification. - GoogleCloudRecaptchaenterpriseV1Key: - description: >- - A key used to identify and configure applications (web and/or mobile) - that use reCAPTCHA Enterprise. - properties: - expressSettings: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ExpressKeySettings - description: Settings for keys that can be used by reCAPTCHA Express. - iosSettings: - description: Settings for keys that can be used by iOS apps. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' - testingOptions: - description: Optional. Options for user acceptance testing. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' - createTime: - format: google-datetime type: string - description: >- - Output only. The timestamp corresponding to the creation of this - key. + languageCode: + type: string + description: >- + Optional. Language code preference for the verification message, set + as a IETF BCP 47 language code. + endpoints: + description: Optional. Endpoints that can be used for identity verification. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + username: + type: string + description: >- + Username of the account that is being verified. Deprecated. + Customers should now provide the `account_id` field in + `event.user_info`. + deprecated: true + type: object + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: + type: object + description: Information about behavioral trust of the transaction. + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + properties: + trust: readOnly: true - wafSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' - description: Optional. Settings for WAF - name: + type: number description: >- - Identifier. The resource name for the Key in the format - `projects/{project}/keys/{key}`. + Output only. Probability of this transaction attempt being executed + in a behaviorally trustworthy way. Values are from 0.0 (lowest) to + 1.0 (highest). + format: float + GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: + description: Response to request to list firewall policies belonging to a project. + properties: + nextPageToken: + description: >- + Token to retrieve the next page of results. It is set to empty if no + policies remain in results. type: string - webSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' - description: Settings for keys that can be used by websites. - displayName: + firewallPolicies: + type: array + description: Policy details. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + type: object + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: + description: The response to a `ListRelatedAccountGroupMemberships` call. + id: >- + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + type: object + properties: + nextPageToken: type: string description: >- - Required. Human-readable display name of this key. Modifiable by - user. - androidSettings: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - description: Settings for keys that can be used by Android apps. - labels: - description: >- - Optional. See [Creating and managing labels] - (https://cloud.google.com/recaptcha/docs/labels). - additionalProperties: - type: string - type: object + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + relatedAccountGroupMemberships: + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + description: The memberships listed by the query. + type: array + GoogleCloudRecaptchaenterpriseV1ListKeysResponse: + description: Response to request to list keys in a project. + id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse type: object - id: GoogleCloudRecaptchaenterpriseV1Key + properties: + nextPageToken: + description: >- + Token to retrieve the next page of results. It is set to empty if no + keys remain in results. + type: string + keys: + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + description: Key details. + type: array GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: - id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest - description: The migrate key request message. type: object + description: The migrate key request message. + id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest properties: skipBillingCheck: type: boolean @@ -814,47 +1083,36 @@ components: present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information. - GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: - type: object + GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment: description: >- - Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd - party integration with legacy reCAPTCHA. - id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + The environment creating the assessment. This describes your environment + (the system invoking CreateAssessment), NOT the environment of your + user. properties: - legacySecretKey: + version: + type: string + description: Optional. The version of the client module. For example, "1.0.0". + client: type: string description: >- - The secret key (also known as shared secret) authorizes - communication between your application backend and the reCAPTCHA - Enterprise server to create an assessment. The secret key needs to - be kept safe for security purposes. - GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: - description: Policy config assessment. - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment - properties: - firewallPolicy: - readOnly: true - description: >- - Output only. The policy that matched the request. If more than one - policy may match, this is the first match. If no policy matches the - incoming request, the policy field is left empty. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' - error: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - description: >- - Output only. If the processing of a policy config fails, an error is - populated and the firewall_policy is left empty. + Optional. Identifies the client module initiating the + CreateAssessment request. This can be the link to the client + module's project. Examples include: - + "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" + - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - + "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - + "wordpress.org/plugins/recaptcha-something" type: object + id: GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse: description: Response for ListIpOverrides. type: object properties: nextPageToken: + type: string description: >- Token to retrieve the next page of results. If this field is empty, no keys remain in the results. - type: string ipOverrides: type: array description: IP Overrides details. @@ -862,993 +1120,376 @@ components: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData id: GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse - GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse: - properties: {} - id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse - description: Response for RemoveIpOverride. + GoogleCloudRecaptchaenterpriseV1IOSKeySettings: + id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings type: object - GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: properties: - cardLabels: + appleDeveloperId: + description: >- + Optional. Apple Developer account details for the app that is + protected by the reCAPTCHA Key. reCAPTCHA leverages + platform-specific checks like Apple App Attest and Apple DeviceCheck + to protect your app from abuse. Providing these fields allows + reCAPTCHA to get a better assessment of the integrity of your app. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId + allowedBundleIds: + type: array + items: + type: string + description: >- + Optional. iOS bundle ids of apps allowed to use the key. Example: + 'com.companyname.productname.appname' + allowAllBundleIds: + type: boolean + description: Optional. If set to true, allowed_bundle_ids are not enforced. + description: Settings specific to keys that can be used by iOS apps. + GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: + properties: + labels: + readOnly: true + type: array + description: Output only. Labels for this request. items: enumDescriptions: - - No label specified. - - This card has been detected as prepaid. + - Default unspecified type. + - The request matches a known good profile for the user. - >- - This card has been detected as virtual, such as a card number - generated for a single transaction or merchant. + The request is potentially a suspicious login event and must be + further verified either through multi-factor authentication or + another system. - >- - This card has been detected as being used in an unexpected - geographic location. - enum: - - CARD_LABEL_UNSPECIFIED - - PREPAID - - VIRTUAL - - UNEXPECTED_LOCATION + The request matched a profile that previously had suspicious + account creation behavior. This can mean that this is a fake + account. + - >- + The account in the request has a high number of related + accounts. It does not necessarily imply that the account is bad + but can require further investigation. type: string - type: array - description: Output only. The labels for the payment card in this transaction. - readOnly: true - type: object - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - description: Signals describing the payment card used in this transaction. - GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse: - properties: {} - type: object - description: Response for AddIpOverride. - id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: - properties: - trust: - description: >- - Output only. Probability of this transaction attempt being executed - in a behaviorally trustworthy way. Values are from 0.0 (lowest) to - 1.0 (highest). - type: number - format: float - readOnly: true - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict - description: Information about behavioral trust of the transaction. - type: object - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: + enum: + - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED + - PROFILE_MATCH + - SUSPICIOUS_LOGIN_ACTIVITY + - SUSPICIOUS_ACCOUNT_CREATION + - RELATED_ACCOUNTS_NUMBER_HIGH + description: Account defender risk assessment. + id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment type: object - id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + GoogleCloudRecaptchaenterpriseV1Event: properties: - cardTestingVerdict: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict - description: >- - Output only. Assessment of this transaction for risk of being part - of a card testing attack. - stolenInstrumentVerdict: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict + userIpAddress: description: >- - Output only. Assessment of this transaction for risk of a stolen - instrument. - readOnly: true - transactionRisk: - readOnly: true - format: float - description: >- - Output only. Probability of this transaction being fraudulent. - Summarizes the combined risk of attack vectors below. Values are - from 0.0 (lowest) to 1.0 (highest). - type: number - behavioralTrustVerdict: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict - description: Output only. Assessment of this transaction for behavioral trust. - description: Assessment for Fraud Prevention. - GoogleCloudRecaptchaenterpriseV1FraudSignals: - properties: - userSignals: - description: Output only. Signals describing the end user in this transaction. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals - cardSignals: - description: >- - Output only. Signals describing the payment card or cards used in - this transaction. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - type: object - id: GoogleCloudRecaptchaenterpriseV1FraudSignals - description: Fraud signals describing users and cards involved in the transaction. - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse - type: object - description: The response to a `SearchRelatedAccountGroupMemberships` call. - properties: - 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 - relatedAccountGroupMemberships: - description: The queried memberships. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals - properties: - syntheticRisk: - readOnly: true - description: >- - Output only. Likelihood (from 0.0 to 1.0) this user includes - synthetic components in their identity, such as a randomly generated - email address, temporary phone number, or fake shipping address. - type: number - format: float - activeDaysLowerBound: - format: int32 - description: >- - Output only. This user (based on email, phone, and other - identifiers) has been seen on the internet for at least this number - of days. - type: integer - readOnly: true - type: object - description: Signals describing the user involved in this transaction. - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: - properties: {} - description: Empty response for AnnotateAssessment. - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse - type: object - GoogleCloudRecaptchaenterpriseV1WafSettings: - description: >- - Settings specific to keys that can be used for WAF (Web Application - Firewall). - type: object - id: GoogleCloudRecaptchaenterpriseV1WafSettings - properties: - wafFeature: - enum: - - WAF_FEATURE_UNSPECIFIED - - CHALLENGE_PAGE - - SESSION_TOKEN - - ACTION_TOKEN - - EXPRESS - enumDescriptions: - - Undefined feature. - - Redirects suspicious traffic to reCAPTCHA. - - >- - Use reCAPTCHA session-tokens to protect the whole user session on - the site's domain. - - Use reCAPTCHA action-tokens to protect user actions. - - >- - Use reCAPTCHA WAF express protection to protect any content other - than web pages, like APIs and IoT devices. - description: Required. The WAF feature for which this key is enabled. - type: string - wafService: - description: Required. The WAF service that uses this key. - enumDescriptions: - - Undefined WAF - - Cloud Armor - - Fastly - - Cloudflare - - Akamai - type: string - enum: - - WAF_SERVICE_UNSPECIFIED - - CA - - FASTLY - - CLOUDFLARE - - AKAMAI - GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: - properties: - value: - description: >- - Optional. The header value to set in the request to the backend - server. - type: string - key: - type: string - description: >- - Optional. The header key to set in the request to the backend - server. - description: >- - A set header action sets a header and forwards the request to the - backend. This can be used to trigger custom protection implemented on - the backend. - type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction - GoogleProtobufEmpty: - 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); } - type: object - id: GoogleProtobufEmpty - properties: {} - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: - description: The request message to annotate an Assessment. - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest - type: object - properties: - reasons: - type: array - description: Optional. Reasons for the annotation that are assigned to the event. - items: - enumDescriptions: - - Default unspecified reason. - - >- - Indicates that the transaction had a chargeback issued with no - other details. When possible, specify the type by using - CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. - - >- - Indicates that the transaction had a chargeback issued related - to an alleged unauthorized transaction from the cardholder's - perspective (for example, the card number was stolen). - - >- - Indicates that the transaction had a chargeback issued related - to the cardholder having provided their card details but - allegedly not being satisfied with the purchase (for example, - misrepresentation, attempted cancellation). - - >- - Indicates that the completed payment transaction was refunded by - the seller. - - >- - Indicates that the completed payment transaction was determined - to be fraudulent by the seller, and was cancelled and refunded - as a result. - - >- - Indicates that the payment transaction was accepted, and the - user was charged. - - >- - Indicates that the payment transaction was declined, for example - due to invalid card details. - - >- - Indicates the transaction associated with the assessment is - suspected of being fraudulent based on the payment method, - billing details, shipping address or other transaction - information. - - >- - Indicates that the user was served a 2FA challenge. An old - assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that - has not been overwritten with `PASSED_TWO_FACTOR` is treated as - an abandoned 2FA flow. This is equivalent to - `FAILED_TWO_FACTOR`. - - Indicates that the user passed a 2FA challenge. - - Indicates that the user failed a 2FA challenge. - - Indicates the user provided the correct password. - - Indicates the user provided an incorrect password. - - >- - Indicates that the user sent unwanted and abusive messages to - other users of the platform, such as spam, scams, phishing, or - social engineering. - enum: - - REASON_UNSPECIFIED - - CHARGEBACK - - CHARGEBACK_FRAUD - - CHARGEBACK_DISPUTE - - REFUND - - REFUND_FRAUD - - TRANSACTION_ACCEPTED - - TRANSACTION_DECLINED - - PAYMENT_HEURISTICS - - INITIATED_TWO_FACTOR - - PASSED_TWO_FACTOR - - FAILED_TWO_FACTOR - - CORRECT_PASSWORD - - INCORRECT_PASSWORD - - SOCIAL_SPAM - type: string - hashedAccountId: - format: byte - type: string - description: >- - Optional. A stable hashed account identifier to apply to the - assessment. This is an alternative to setting `hashed_account_id` in - `CreateAssessment`, for example when a stable account identifier is - not yet known in the initial request. - accountId: - type: string - description: >- - Optional. A stable account identifier to apply to the assessment. - This is an alternative to setting `account_id` in - `CreateAssessment`, for example when a stable account identifier is - not yet known in the initial request. - transactionEvent: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent - description: >- - Optional. If the assessment is part of a payment transaction, - provide details on payment lifecycle events that occur in the - transaction. - annotation: - description: >- - Optional. The annotation that is assigned to the Event. This field - can be left empty to provide reasons that apply to an event without - concluding whether the event is legitimate or fraudulent. - type: string - enumDescriptions: - - Default unspecified type. - - Provides information that the event turned out to be legitimate. - - Provides information that the event turned out to be fraudulent. - - >- - Provides information that the event was related to a login event - in which the user typed the correct password. Deprecated, prefer - indicating CORRECT_PASSWORD through the reasons field instead. - - >- - Provides information that the event was related to a login event - in which the user typed the incorrect password. Deprecated, prefer - indicating INCORRECT_PASSWORD through the reasons field instead. - enum: - - ANNOTATION_UNSPECIFIED - - LEGITIMATE - - FRAUDULENT - - PASSWORD_CORRECT - - PASSWORD_INCORRECT - enumDeprecated: - - false - - false - - false - - true - - true - GoogleCloudRecaptchaenterpriseV1IOSKeySettings: - id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings - properties: - allowAllBundleIds: - type: boolean - description: Optional. If set to true, allowed_bundle_ids are not enforced. - allowedBundleIds: - items: - type: string - description: >- - Optional. iOS bundle ids of apps allowed to use the key. Example: - 'com.companyname.productname.appname' - type: array - appleDeveloperId: - description: >- - Optional. Apple Developer account details for the app that is - protected by the reCAPTCHA Key. reCAPTCHA leverages - platform-specific checks like Apple App Attest and Apple DeviceCheck - to protect your app from abuse. Providing these fields allows - reCAPTCHA to get a better assessment of the integrity of your app. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId - type: object - description: Settings specific to keys that can be used by iOS apps. - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: - properties: - names: - type: array - items: - type: string - description: >- - Required. A list containing all policy names, in the new order. Each - name is in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. - description: The reorder firewall policies request message. - type: object - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest - GoogleCloudRecaptchaenterpriseV1TransactionEvent: - properties: - eventTime: - type: string - description: >- - Optional. Timestamp when this transaction event occurred; otherwise - assumed to be the time of the API call. - format: google-datetime - reason: - type: string - description: >- - Optional. The reason or standardized code that corresponds with this - transaction event, if one exists. For example, a CHARGEBACK event - with code 6005. - value: - type: number - format: double - description: >- - Optional. The value that corresponds with this transaction event, if - one exists. For example, a refund event where $5.00 was refunded. - Currency is obtained from the original transaction data. - eventType: - description: Optional. The type of this transaction event. - enumDescriptions: - - Default, unspecified event type. - - >- - Indicates that the transaction is approved by the merchant. The - accompanying reasons can include terms such as 'INHOUSE', - 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. - - >- - Indicates that the transaction is denied and concluded due to - risks detected by the merchant. The accompanying reasons can - include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or - 'MANUAL_REVIEW'. - - >- - Indicates that the transaction is being evaluated by a human, due - to suspicion or risk. - - >- - Indicates that the authorization attempt with the card issuer - succeeded. - - >- - Indicates that the authorization attempt with the card issuer - failed. The accompanying reasons can include Visa's '54' - indicating that the card is expired, or '82' indicating that the - CVV is incorrect. - - >- - Indicates that the transaction is completed because the funds were - settled. - - >- - Indicates that the transaction could not be completed because the - funds were not settled. - - >- - Indicates that the transaction has been canceled. Specify the - reason for the cancellation. For example, - 'INSUFFICIENT_INVENTORY'. - - >- - Indicates that the merchant has received a chargeback inquiry due - to fraud for the transaction, requesting additional information - before a fraud chargeback is officially issued and a formal - chargeback notification is sent. - - >- - Indicates that the merchant has received a chargeback alert due to - fraud for the transaction. The process of resolving the dispute - without involving the payment network is started. - - >- - Indicates that a fraud notification is issued for the transaction, - sent by the payment instrument's issuing bank because the - transaction appears to be fraudulent. We recommend including TC40 - or SAFE data in the `reason` field for this event type. For - partial chargebacks, we recommend that you include an amount in - the `value` field. - - >- - Indicates that the merchant is informed by the payment network - that the transaction has entered the chargeback process due to - fraud. Reason code examples include Discover's '6005' and '6041'. - For partial chargebacks, we recommend that you include an amount - in the `value` field. - - >- - Indicates that the transaction has entered the chargeback process - due to fraud, and that the merchant has chosen to enter - representment. Reason examples include Discover's '6005' and - '6041'. For partial chargebacks, we recommend that you include an - amount in the `value` field. - - >- - Indicates that the transaction has had a fraud chargeback which - was illegitimate and was reversed as a result. For partial - chargebacks, we recommend that you include an amount in the - `value` field. - - >- - Indicates that the merchant has received a refund for a completed - transaction. For partial refunds, we recommend that you include an - amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) - - >- - Indicates that the merchant has received a refund request for this - transaction, but that they have declined it. For partial refunds, - we recommend that you include an amount in the `value` field. - Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) - - >- - Indicates that the completed transaction was refunded by the - merchant. For partial refunds, we recommend that you include an - amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) - - >- - Indicates that the completed transaction was refunded by the - merchant, and that this refund was reversed. For partial refunds, - we recommend that you include an amount in the `value` field. - enum: - - TRANSACTION_EVENT_TYPE_UNSPECIFIED - - MERCHANT_APPROVE - - MERCHANT_DENY - - MANUAL_REVIEW - - AUTHORIZATION - - AUTHORIZATION_DECLINE - - PAYMENT_CAPTURE - - PAYMENT_CAPTURE_DECLINE - - CANCEL - - CHARGEBACK_INQUIRY - - CHARGEBACK_ALERT - - FRAUD_NOTIFICATION - - CHARGEBACK - - CHARGEBACK_REPRESENTMENT - - CHARGEBACK_REVERSE - - REFUND_REQUEST - - REFUND_DECLINE - - REFUND - - REFUND_REVERSE - type: string - id: GoogleCloudRecaptchaenterpriseV1TransactionEvent - type: object - description: Describes an event in the lifecycle of a payment transaction. - GoogleRpcStatus: - type: object - properties: - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - type: array - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: - description: An allow action continues processing a request unimpeded. - id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction - type: object - properties: {} - GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment: - properties: - client: - type: string - description: >- - Optional. Identifies the client module initiating the - CreateAssessment request. This can be the link to the client - module's project. Examples include: - - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - - "wordpress.org/plugins/recaptcha-something" - version: - description: Optional. The version of the client module. For example, "1.0.0". - type: string - type: object - description: >- - The environment creating the assessment. This describes your environment - (the system invoking CreateAssessment), NOT the environment of your - user. - id: GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment - GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: - properties: - passedCount: - description: >- - Count of nocaptchas (successful verification without a challenge) - plus submitted challenge solutions that were correct and resulted in - verification. - format: int64 - type: string - pageloadCount: - description: >- - Count of reCAPTCHA checkboxes or badges rendered. This is mostly - equivalent to a count of pageloads for pages that include reCAPTCHA. - format: int64 - type: string - nocaptchaCount: - format: int64 - description: >- - Count of nocaptchas (successful verification without a challenge) - issued. + Optional. The IP address in the request from the user's device + related to this event. type: string - failedCount: - description: >- - Count of submitted challenge solutions that were incorrect or - otherwise deemed suspicious such that a subsequent challenge was - triggered. - format: int64 + fraudPrevention: type: string - id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics - type: object - description: Metrics related to challenges. - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: - description: >- - An include reCAPTCHA script action involves injecting reCAPTCHA - JavaScript code into the HTML returned by the site backend. This - reCAPTCHA script is tasked with collecting user signals on the requested - web page, issuing tokens as a cookie within the site domain, and - enabling their utilization in subsequent page requests. - id: >- - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction - type: object - properties: {} - GoogleCloudRecaptchaenterpriseV1TokenProperties: - description: Properties of the provided event token. - type: object - properties: - androidPackageName: + enum: + - FRAUD_PREVENTION_UNSPECIFIED + - ENABLED + - DISABLED + description: Optional. The Fraud Prevention setting for this assessment. + enumDescriptions: + - >- + Default, unspecified setting. If opted in for automatic detection, + `fraud_prevention_assessment` is returned based on the request. + Otherwise, `fraud_prevention_assessment` is returned if + `transaction_data` is present in the `Event` and Fraud Prevention + is enabled in the Google Cloud console. + - >- + Enable Fraud Prevention for this assessment, if Fraud Prevention + is enabled in the Google Cloud console. + - >- + Disable Fraud Prevention for this assessment, regardless of opt-in + status or Google Cloud console settings. + wafTokenAssessment: + type: boolean description: >- - Output only. The name of the Android package with which the token - was generated (Android keys only). + Optional. Flag for running WAF token assessment. If enabled, the + token must be specified, and have been created by a WAF-enabled key. + requestedUri: type: string - readOnly: true - valid: description: >- - Output only. Whether the provided user response token is valid. When - valid = false, the reason could be specified in invalid_reason or it - could also be due to a user failing to solve a challenge or a - sitekey mismatch (i.e the sitekey used to generate the token was - different than the one specified in the assessment). - type: boolean - readOnly: true - hostname: - readOnly: true + Optional. The URI resource the user requested that triggered an + assessment. + userAgent: type: string description: >- - Output only. The hostname of the page on which the token was - generated (Web keys only). - iosBundleId: - readOnly: true + Optional. The user agent present in the request from the user's + device related to this event. + expectedAction: description: >- - Output only. The ID of the iOS bundle with which the token was - generated (iOS keys only). - type: string - action: + Optional. The expected action for this type of event. This should be + the same action provided at token generation time on client-side + platforms already integrated with recaptcha enterprise. type: string - readOnly: true - description: Output only. Action name provided at token generation. - createTime: - readOnly: true - format: google-datetime + token: type: string description: >- - Output only. The timestamp corresponding to the generation of the - token. - invalidReason: - readOnly: true - description: Output only. Reason associated with the response when valid = false. - enum: - - INVALID_REASON_UNSPECIFIED - - UNKNOWN_INVALID_REASON - - MALFORMED - - EXPIRED - - DUPE - - MISSING - - BROWSER_ERROR - type: string - enumDescriptions: - - Default unspecified type. - - If the failure reason was not accounted for. - - The provided user verification token was malformed. - - The user verification token had expired. - - The user verification had already been seen. - - The user verification token was not present. - - >- - A retriable error (such as network failure) occurred on the - browser. Could easily be simulated by an attacker. - id: GoogleCloudRecaptchaenterpriseV1TokenProperties - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: - description: The reorder firewall policies response message. - type: object - properties: {} - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse - GoogleCloudRecaptchaenterpriseV1ListKeysResponse: - description: Response to request to list keys in a project. - id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse - properties: - nextPageToken: + Optional. The user response token provided by the reCAPTCHA + Enterprise client-side integration on your site. + hashedAccountId: + deprecated: true description: >- - Token to retrieve the next page of results. It is set to empty if no - keys remain in results. + Optional. Deprecated: use `user_info.account_id` instead. Unique + stable hashed user identifier for the request. The identifier must + be hashed using hmac-sha256 with stable secret. + format: byte type: string - keys: - description: Key details. - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' - type: array - type: object - GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: - properties: - supportNonGoogleAppStoreDistribution: + firewallPolicyEvaluation: type: boolean description: >- - Optional. Set to true for keys that are used in an Android - application that is available for download in app stores in addition - to the Google Play Store. - allowedPackageNames: - items: - type: string - type: array + Optional. Flag for enabling firewall policy config assessment. If + this flag is enabled, the firewall policy is evaluated and a + suggested firewall action is returned in the response. + express: description: >- - Optional. Android package names of apps allowed to use the key. - Example: 'com.companyname.appname' - allowAllPackageNames: + Optional. Flag for a reCAPTCHA express request for an assessment + without a token. If enabled, `site_key` must reference an Express + site key. type: boolean - description: Optional. If set to true, allowed_package_names are not enforced. - description: Settings specific to keys that can be used by Android apps. - id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - type: object - GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: - description: >- - A block action serves an HTTP error code a prevents the request from - hitting the backend. - id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction - type: object - properties: {} - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - description: A group of related accounts. - type: object - properties: - name: - type: string - description: >- - Required. Identifier. The resource name for the related account - group in the format - `projects/{project}/relatedaccountgroups/{related_account_group}`. - GoogleCloudRecaptchaenterpriseV1RiskAnalysis: - id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis - description: Risk analysis result for an event. - properties: - reasons: + headers: type: array - readOnly: true + description: Optional. HTTP header information about the request. items: - enumDescriptions: - - Default unspecified type. - - Interactions matched the behavior of an automated agent. - - The event originated from an illegitimate environment. - - Traffic volume from the event source is higher than normal. - - >- - Interactions with the site were significantly different than - expected patterns. - - >- - Too little traffic has been received from this site thus far to - generate quality risk analysis. - - >- - The request matches behavioral characteristics of a carding - attack. - - >- - The request matches behavioral characteristics of chargebacks - for fraud. - enum: - - CLASSIFICATION_REASON_UNSPECIFIED - - AUTOMATION - - UNEXPECTED_ENVIRONMENT - - TOO_MUCH_TRAFFIC - - UNEXPECTED_USAGE_PATTERNS - - LOW_CONFIDENCE_SCORE - - SUSPECTED_CARDING - - SUSPECTED_CHARGEBACK type: string - description: Output only. Reasons contributing to the risk analysis verdict. - score: - type: number - description: >- - Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very - likely legitimate traffic while 0.0 means very likely non-legitimate - traffic). - readOnly: true - format: float - extendedVerdictReasons: - readOnly: true + ja3: + type: string + description: Optional. JA3 fingerprint for SSL clients. + siteKey: + type: string description: >- - Output only. Extended verdict reasons to be used for experimentation - only. The set of possible reasons is subject to change. - type: array - items: - type: string - type: object - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: - type: object - description: >- - Information about card testing fraud, where an adversary is testing - fraudulently obtained cards or brute forcing their details. - properties: - risk: - readOnly: true + Optional. The site key that was used to invoke reCAPTCHA Enterprise + on your site and generate the token. + transactionData: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData' description: >- - Output only. Probability of this transaction attempt being part of a - card testing attack. Values are from 0.0 (lowest) to 1.0 (highest). - format: float - type: number - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict - GoogleCloudRecaptchaenterpriseV1TransactionDataUser: - description: Details about a user's account involved in the transaction. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser + Optional. Data describing a payment transaction to be assessed. + Sending this data enables reCAPTCHA Enterprise Fraud Prevention and + the FraudPreventionAssessment component in the response. + userInfo: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' + description: >- + Optional. Information about the user that generates this event, when + they can be identified. They are often identified through the use of + an account for logged-in requests or login/registration requests, or + by providing user identifiers for guest actions like checkout. + id: GoogleCloudRecaptchaenterpriseV1Event + description: The event being assessed. + type: object + GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: type: object + id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + description: Private password leak verification info. properties: - accountId: + encryptedLeakMatchPrefixes: description: >- - Optional. Unique account identifier for this user. If using account - defender, this should match the hashed_account_id field. Otherwise, - a unique and persistent identifier for this account. + Output only. List of prefixes of the encrypted potential password + leaks that matched the given parameters. They must be compared with + the client-side decryption prefix of + `reencrypted_user_credentials_hash` + type: array + readOnly: true + items: + type: string + format: byte + reencryptedUserCredentialsHash: type: string - phoneVerified: - type: boolean description: >- - Optional. Whether the phone number has been verified to be - accessible by the user (OTP or similar). - creationMs: - format: int64 - description: Optional. The epoch milliseconds of the user's account creation. - type: string - email: - description: Optional. The email address of the user. + Output only. Corresponds to the re-encryption of the + `encrypted_user_credentials_hash` field. It is used to match + potential password leaks within `encrypted_leak_match_prefixes`. + readOnly: true + format: byte + lookupHashPrefix: type: string - emailVerified: - type: boolean + format: byte description: >- - Optional. Whether the email has been verified to be accessible by - the user (OTP or similar). - phoneNumber: + Required. Exactly 26-bit prefix of the SHA-256 hash of the + canonicalized username. It is used to look up password leaks + associated with that hash prefix. + encryptedUserCredentialsHash: + description: >- + Optional. Encrypted Scrypt hash of the canonicalized + username+password. It is re-encrypted by the server and returned + through `reencrypted_user_credentials_hash`. + format: byte type: string - description: Optional. The phone number of the user, with country code. - GoogleCloudRecaptchaenterpriseV1UserId: + GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: + id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + description: >- + Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd + party integration with legacy reCAPTCHA. type: object - id: GoogleCloudRecaptchaenterpriseV1UserId - description: An identifier associated with a user. properties: - email: - type: string - description: Optional. An email address. - phoneNumber: - type: string - description: Optional. A phone number. Should use the E.164 format. - username: - type: string + legacySecretKey: description: >- - Optional. A unique username, if different from all the other - identifiers and `account_id` that are provided. Can be a unique - login handle or display name for a user. - GoogleCloudRecaptchaenterpriseV1Metrics: - description: Metrics for a single Key. - id: GoogleCloudRecaptchaenterpriseV1Metrics - type: object - properties: - name: + The secret key (also known as shared secret) authorizes + communication between your application backend and the reCAPTCHA + Enterprise server to create an assessment. The secret key needs to + be kept safe for security purposes. type: string + GoogleCloudRecaptchaenterpriseV1FirewallAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallAction + properties: + allow: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction description: >- - Output only. Identifier. The name of the metrics, in the format - `projects/{project}/keys/{key}/metrics`. - readOnly: true - challengeMetrics: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics - type: array + The user request did not match any policy and should be allowed + access to the requested resource. + substitute: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction description: >- - Metrics are continuous and in order by dates, and in the granularity - of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have - challenge-based data. - scoreMetrics: - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' + This action transparently serves a different page to an offending + user. + setHeader: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction description: >- - Metrics are continuous and in order by dates, and in the granularity - of day. All Key types should have score-based data. - type: array - startTime: - type: string - description: Inclusive start time aligned to a day (UTC). - format: google-datetime - GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: - properties: - smsTollFraudVerdict: + This action sets a custom header but allow the request to continue + to the customer backend. + includeRecaptchaScript: description: >- - Output only. Assessment of this phone event for risk of SMS toll - fraud. - readOnly: true + This action injects reCAPTCHA JavaScript code into the HTML page + returned by the site backend. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction + block: + description: >- + This action denies access to a given page. The user gets an HTTP + error code. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + redirect: + description: >- + This action redirects the request to a reCAPTCHA interstitial to + attach a token. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + description: >- + An individual action. Each action represents what to do if a policy + matches. type: object - id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment - description: Assessment for Phone Fraud - GoogleCloudRecaptchaenterpriseV1FirewallPolicy: + GoogleCloudRecaptchaenterpriseV1ScoreDistribution: + description: Score distribution. + type: object + id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution properties: - name: - type: string - description: >- - Identifier. The resource name for the FirewallPolicy in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. - description: - type: string + scoreBuckets: + type: object + additionalProperties: + format: int64 + type: string description: >- - Optional. A description of what this policy aims to achieve, for - convenience purposes. The description can at most include 256 UTF-8 - characters. - path: + Map key is score value multiplied by 100. The scores are discrete + values between [0, 1]. The maximum number of buckets is on order of + a few dozen, but typically much lower (ie. 10). + GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + type: object + properties: + value: description: >- - Optional. The path for which this policy applies, specified as a - glob pattern. For more information on glob, see the [manual - page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has - a max length of 200 characters. + Optional. The header value to set in the request to the backend + server. type: string - condition: - description: >- - Optional. A CEL (Common Expression Language) conditional expression - that specifies if this policy applies to an incoming user request. - If this condition evaluates to true and the requested path matched - the path pattern, the associated actions should be executed by the - caller. The condition string is checked for CEL syntax correctness - on creation. For more information, see the [CEL - spec](https://github.com/google/cel-spec) and its [language - definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). - A condition has a max length of 500 characters. + key: type: string - actions: description: >- - Optional. The actions that the caller should take regarding user - access. There should be at most one terminal action. A terminal - action is any action that forces a response, such as `AllowAction`, - `BlockAction` or `SubstituteAction`. Zero or more non-terminal - actions such as `SetHeader` might be specified. A single policy can - contain up to 16 actions. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction + Optional. The header key to set in the request to the backend + server. description: >- - A FirewallPolicy represents a single matching pattern and resulting - actions to take. + A set header action sets a header and forwards the request to the + backend. This can be used to trigger custom protection implemented on + the backend. + GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: + type: object + properties: {} + id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + description: >- + A redirect action returns a 307 (temporary redirect) response, pointing + the user to a reCAPTCHA interstitial page to attach a token. + GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest: + type: object + id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest + properties: + ipOverrideData: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' + description: Required. IP override to be removed from the key. + description: The removeIpOverride request message. + GoogleCloudRecaptchaenterpriseV1ScoreMetrics: + properties: + actionMetrics: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + description: >- + Action-based metrics. The map key is the action name which specified + by the site owners at time of the "execute" client-side call. + overallMetrics: + description: Aggregated score metrics for all traffic. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy - GoogleCloudRecaptchaenterpriseV1TransactionData: + description: Metrics related to scoring. + id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics + GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse: + id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse type: object + properties: {} + description: Response for AddIpOverride. + GoogleCloudRecaptchaenterpriseV1TransactionData: id: GoogleCloudRecaptchaenterpriseV1TransactionData properties: - merchants: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser - description: >- - Optional. Information about the user or users fulfilling the - transaction. - cardLastFour: - description: Optional. The last four digits of the card. - type: string billingAddress: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress description: >- Optional. Address associated with the payment method when applicable. - cardBin: + user: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser description: >- - Optional. The Bank Identification Number - generally the first 6 or - 8 digits of the card. + Optional. Information about the user paying/initiating the + transaction. + paymentMethod: + description: >- + Optional. The payment method for the transaction. The allowed values + are: * credit-card * debit-card * gift-card * processor-{name} (If a + third-party is used, for example, processor-paypal) * custom-{name} + (If an alternative method is used, for example, custom-crypto) type: string - currencyCode: - description: Optional. The currency code in ISO-4217 format. + cardBin: type: string - shippingValue: - format: double - type: number description: >- - Optional. The value of shipping in the specified currency. 0 for - free or no shipping. + Optional. The Bank Identification Number - generally the first 6 or + 8 digits of the card. shippingAddress: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress description: >- Optional. Destination address if this transaction involves shipping a physical item. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress items: + type: array items: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataItem description: Optional. Items purchased in this transaction. - type: array - value: - format: double + currencyCode: + type: string + description: Optional. The currency code in ISO-4217 format. + gatewayInfo: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo description: >- - Optional. The decimal value of the transaction in the specified - currency. - type: number + Optional. Information about the payment gateway's response to the + transaction. transactionId: type: string description: >- @@ -1856,207 +1497,538 @@ components: used to reference this transaction in the future, for example, labeling a refund or chargeback event. Two attempts at the same transaction should use the same transaction id. - user: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + shippingValue: description: >- - Optional. Information about the user paying/initiating the + Optional. The value of shipping in the specified currency. 0 for + free or no shipping. + format: double + type: number + cardLastFour: + type: string + description: Optional. The last four digits of the card. + value: + format: double + type: number + description: >- + Optional. The decimal value of the transaction in the specified + currency. + merchants: + type: array + description: >- + Optional. Information about the user or users fulfilling the transaction. - paymentMethod: + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + type: object + description: >- + Transaction data associated with a payment protected by reCAPTCHA + Enterprise. + GoogleCloudRecaptchaenterpriseV1WebKeySettings: + id: GoogleCloudRecaptchaenterpriseV1WebKeySettings + properties: + challengeSecurityPreference: + enum: + - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED + - USABILITY + - BALANCE + - SECURITY + description: >- + Optional. Settings for the frequency and difficulty at which this + key triggers captcha challenges. This should only be specified for + IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. + enumDescriptions: + - Default type that indicates this enum hasn't been specified. + - Key tends to show fewer and easier challenges. + - Key tends to show balanced (in amount and difficulty) challenges. + - Key tends to show more and harder challenges. type: string + allowedDomains: + type: array + items: + type: string description: >- - Optional. The payment method for the transaction. The allowed values - are: * credit-card * debit-card * gift-card * processor-{name} (If a - third-party is used, for example, processor-paypal) * custom-{name} - (If an alternative method is used, for example, custom-crypto) - gatewayInfo: + Optional. Domains or subdomains of websites allowed to use the key. + All subdomains of an allowed domain are automatically allowed. A + valid domain requires a host and must not include any path, port, + query or fragment. Examples: 'example.com' or + 'subdomain.example.com' + allowAllDomains: + description: Optional. If set to true, it means allowed_domains are not enforced. + type: boolean + allowAmpTraffic: + description: >- + Optional. If set to true, the key can be used on AMP (Accelerated + Mobile Pages) websites. This is supported only for the SCORE + integration type. + type: boolean + integrationType: + type: string + enumDescriptions: + - >- + Default type that indicates this enum hasn't been specified. This + is not a valid IntegrationType, one of the other types must be + specified instead. + - >- + Only used to produce scores. It doesn't display the "I'm not a + robot" checkbox and never shows captcha challenges. + - >- + Displays the "I'm not a robot" checkbox and may show captcha + challenges after it is checked. + - >- + Doesn't display the "I'm not a robot" checkbox, but may show + captcha challenges after risk analysis. + enum: + - INTEGRATION_TYPE_UNSPECIFIED + - SCORE + - CHECKBOX + - INVISIBLE + description: Required. Describes how this key is integrated with the website. + type: object + description: Settings specific to keys that can be used by websites. + GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: + properties: + supportNonGoogleAppStoreDistribution: + description: >- + Optional. Set to true for keys that are used in an Android + application that is available for download in app stores in addition + to the Google Play Store. + type: boolean + allowedPackageNames: + items: + type: string + description: >- + Optional. Android package names of apps allowed to use the key. + Example: 'com.companyname.appname' + type: array + allowAllPackageNames: + description: Optional. If set to true, allowed_package_names are not enforced. + type: boolean + id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + description: Settings specific to keys that can be used by Android apps. + type: object + GoogleCloudRecaptchaenterpriseV1TransactionDataItem: + properties: + value: + description: >- + Optional. The value per item that the user is paying, in the + transaction currency, after discounts. + format: double + type: number + quantity: + description: Optional. The quantity of this item that is being purchased. + type: string + format: int64 + merchantAccountId: + description: >- + Optional. When a merchant is specified, its corresponding + account_id. Necessary to populate marketplace-style transactions. + type: string + name: + type: string + description: Optional. The full name of the item. + id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem + type: object + description: Line items being purchased in this transaction. + GoogleCloudRecaptchaenterpriseV1TestingOptions: + description: Options for user acceptance testing. + type: object + properties: + testingChallenge: + type: string + description: >- + Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + challenge requests for this site return nocaptcha if NOCAPTCHA, or + an unsolvable challenge if CHALLENGE. + enumDescriptions: + - >- + Perform the normal risk analysis and return either nocaptcha or a + challenge depending on risk and trust factors. + - >- + Challenge requests for this key always return a nocaptcha, which + does not require a solution. + - >- + Challenge requests for this key always return an unsolvable + challenge. + enum: + - TESTING_CHALLENGE_UNSPECIFIED + - NOCAPTCHA + - UNSOLVABLE_CHALLENGE + testingScore: + format: float + description: >- + Optional. All assessments for this Key return this score. Must be + between 0 (likely not legitimate) and 1 (likely legitimate) + inclusive. + type: number + id: GoogleCloudRecaptchaenterpriseV1TestingOptions + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: + properties: + hashedAccountId: + type: string + deprecated: true + format: byte + description: >- + Deprecated: use `account_id` instead. The unique stable hashed + account identifier of the member. The identifier corresponds to a + `hashed_account_id` provided in a previous `CreateAssessment` or + `AnnotateAssessment` call. + accountId: + type: string + description: >- + The unique stable account identifier of the member. The identifier + corresponds to an `account_id` provided in a previous + `CreateAssessment` or `AnnotateAssessment` call. + name: + type: string description: >- - Optional. Information about the payment gateway's response to the - transaction. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo - description: >- - Transaction data associated with a payment protected by reCAPTCHA - Enterprise. - GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: - description: Structured address format for billing and shipping addresses. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + Required. Identifier. The resource name for this membership in the + format + `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + type: object + description: A membership in a group of related accounts. + GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: + description: Signals describing the user involved in this transaction. type: object properties: - recipient: + activeDaysLowerBound: + format: int32 description: >- - Optional. The recipient name, potentially including information such - as "care of". - type: string - postalCode: - type: string - description: Optional. The postal or ZIP code of the address. - locality: - description: Optional. The town/city of the address. - type: string - regionCode: - description: Optional. The CLDR country/region of the address. + Output only. This user (based on email, phone, and other + identifiers) has been seen on the internet for at least this number + of days. + readOnly: true + type: integer + syntheticRisk: + readOnly: true + format: float + type: number + description: >- + Output only. Likelihood (from 0.0 to 1.0) this user includes + synthetic components in their identity, such as a randomly generated + email address, temporary phone number, or fake shipping address. + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + GoogleCloudRecaptchaenterpriseV1Metrics: + properties: + startTime: type: string - address: + format: google-datetime + description: Inclusive start time aligned to a day (UTC). + scoreMetrics: description: >- - Optional. The first lines of the address. The first line generally - contains the street name and number, and further lines may include - information such as an apartment number. + Metrics are continuous and in order by dates, and in the granularity + of day. All Key types should have score-based data. type: array items: - type: string - administrativeArea: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' + name: description: >- - Optional. The state, province, or otherwise administrative area of - the address. - type: string - GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: - description: Private password leak verification info. - properties: - encryptedLeakMatchPrefixes: - items: - type: string - format: byte + Output only. Identifier. The name of the metrics, in the format + `projects/{project}/keys/{key}/metrics`. readOnly: true - description: >- - Output only. List of prefixes of the encrypted potential password - leaks that matched the given parameters. They must be compared with - the client-side decryption prefix of - `reencrypted_user_credentials_hash` + type: string + challengeMetrics: type: array - reencryptedUserCredentialsHash: - readOnly: true - format: byte + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics description: >- - Output only. Corresponds to the re-encryption of the - `encrypted_user_credentials_hash` field. It is used to match - potential password leaks within `encrypted_leak_match_prefixes`. + Metrics are continuous and in order by dates, and in the granularity + of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have + challenge-based data. + type: object + description: Metrics for a single Key. + id: GoogleCloudRecaptchaenterpriseV1Metrics + GoogleCloudRecaptchaenterpriseV1TransactionEvent: + properties: + eventType: + enumDescriptions: + - Default, unspecified event type. + - >- + Indicates that the transaction is approved by the merchant. The + accompanying reasons can include terms such as 'INHOUSE', + 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. + - >- + Indicates that the transaction is denied and concluded due to + risks detected by the merchant. The accompanying reasons can + include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or + 'MANUAL_REVIEW'. + - >- + Indicates that the transaction is being evaluated by a human, due + to suspicion or risk. + - >- + Indicates that the authorization attempt with the card issuer + succeeded. + - >- + Indicates that the authorization attempt with the card issuer + failed. The accompanying reasons can include Visa's '54' + indicating that the card is expired, or '82' indicating that the + CVV is incorrect. + - >- + Indicates that the transaction is completed because the funds were + settled. + - >- + Indicates that the transaction could not be completed because the + funds were not settled. + - >- + Indicates that the transaction has been canceled. Specify the + reason for the cancellation. For example, + 'INSUFFICIENT_INVENTORY'. + - >- + Indicates that the merchant has received a chargeback inquiry due + to fraud for the transaction, requesting additional information + before a fraud chargeback is officially issued and a formal + chargeback notification is sent. + - >- + Indicates that the merchant has received a chargeback alert due to + fraud for the transaction. The process of resolving the dispute + without involving the payment network is started. + - >- + Indicates that a fraud notification is issued for the transaction, + sent by the payment instrument's issuing bank because the + transaction appears to be fraudulent. We recommend including TC40 + or SAFE data in the `reason` field for this event type. For + partial chargebacks, we recommend that you include an amount in + the `value` field. + - >- + Indicates that the merchant is informed by the payment network + that the transaction has entered the chargeback process due to + fraud. Reason code examples include Discover's '6005' and '6041'. + For partial chargebacks, we recommend that you include an amount + in the `value` field. + - >- + Indicates that the transaction has entered the chargeback process + due to fraud, and that the merchant has chosen to enter + representment. Reason examples include Discover's '6005' and + '6041'. For partial chargebacks, we recommend that you include an + amount in the `value` field. + - >- + Indicates that the transaction has had a fraud chargeback which + was illegitimate and was reversed as a result. For partial + chargebacks, we recommend that you include an amount in the + `value` field. + - >- + Indicates that the merchant has received a refund for a completed + transaction. For partial refunds, we recommend that you include an + amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + - >- + Indicates that the merchant has received a refund request for this + transaction, but that they have declined it. For partial refunds, + we recommend that you include an amount in the `value` field. + Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) + - >- + Indicates that the completed transaction was refunded by the + merchant. For partial refunds, we recommend that you include an + amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + - >- + Indicates that the completed transaction was refunded by the + merchant, and that this refund was reversed. For partial refunds, + we recommend that you include an amount in the `value` field. + description: Optional. The type of this transaction event. + enum: + - TRANSACTION_EVENT_TYPE_UNSPECIFIED + - MERCHANT_APPROVE + - MERCHANT_DENY + - MANUAL_REVIEW + - AUTHORIZATION + - AUTHORIZATION_DECLINE + - PAYMENT_CAPTURE + - PAYMENT_CAPTURE_DECLINE + - CANCEL + - CHARGEBACK_INQUIRY + - CHARGEBACK_ALERT + - FRAUD_NOTIFICATION + - CHARGEBACK + - CHARGEBACK_REPRESENTMENT + - CHARGEBACK_REVERSE + - REFUND_REQUEST + - REFUND_DECLINE + - REFUND + - REFUND_REVERSE type: string - encryptedUserCredentialsHash: + reason: description: >- - Optional. Encrypted Scrypt hash of the canonicalized - username+password. It is re-encrypted by the server and returned - through `reencrypted_user_credentials_hash`. - format: byte + Optional. The reason or standardized code that corresponds with this + transaction event, if one exists. For example, a CHARGEBACK event + with code 6005. type: string - lookupHashPrefix: - format: byte - description: >- - Required. Exactly 26-bit prefix of the SHA-256 hash of the - canonicalized username. It is used to look up password leaks - associated with that hash prefix. + eventTime: type: string + description: >- + Optional. Timestamp when this transaction event occurred; otherwise + assumed to be the time of the API call. + format: google-datetime + value: + format: double + type: number + description: >- + Optional. The value that corresponds with this transaction event, if + one exists. For example, a refund event where $5.00 was refunded. + Currency is obtained from the original transaction data. type: object - id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: + description: Describes an event in the lifecycle of a payment transaction. + id: GoogleCloudRecaptchaenterpriseV1TransactionEvent + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest properties: - relatedAccountGroups: - description: The groups of related accounts listed by the query. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - type: array - nextPageToken: + accountId: + description: >- + Optional. A stable account identifier to apply to the assessment. + This is an alternative to setting `account_id` in + `CreateAssessment`, for example when a stable account identifier is + not yet known in the initial request. + type: string + hashedAccountId: type: string 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. - id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse - type: object - description: The response to a `ListRelatedAccountGroups` call. - GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: - type: object - description: Account defender risk assessment. - id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - properties: - labels: - description: Output only. Labels for this request. + Optional. A stable hashed account identifier to apply to the + assessment. This is an alternative to setting `hashed_account_id` in + `CreateAssessment`, for example when a stable account identifier is + not yet known in the initial request. + format: byte + reasons: type: array + description: Optional. Reasons for the annotation that are assigned to the event. items: - enum: - - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED - - PROFILE_MATCH - - SUSPICIOUS_LOGIN_ACTIVITY - - SUSPICIOUS_ACCOUNT_CREATION - - RELATED_ACCOUNTS_NUMBER_HIGH type: string enumDescriptions: - - Default unspecified type. - - The request matches a known good profile for the user. + - Default unspecified reason. - >- - The request is potentially a suspicious login event and must be - further verified either through multi-factor authentication or - another system. + Indicates that the transaction had a chargeback issued with no + other details. When possible, specify the type by using + CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. - >- - The request matched a profile that previously had suspicious - account creation behavior. This can mean that this is a fake - account. + Indicates that the transaction had a chargeback issued related + to an alleged unauthorized transaction from the cardholder's + perspective (for example, the card number was stolen). - >- - The account in the request has a high number of related - accounts. It does not necessarily imply that the account is bad - but can require further investigation. - readOnly: true - GoogleCloudRecaptchaenterpriseV1TestingOptions: - properties: - testingScore: - type: number - format: float + Indicates that the transaction had a chargeback issued related + to the cardholder having provided their card details but + allegedly not being satisfied with the purchase (for example, + misrepresentation, attempted cancellation). + - >- + Indicates that the completed payment transaction was refunded by + the seller. + - >- + Indicates that the completed payment transaction was determined + to be fraudulent by the seller, and was cancelled and refunded + as a result. + - >- + Indicates that the payment transaction was accepted, and the + user was charged. + - >- + Indicates that the payment transaction was declined, for example + due to invalid card details. + - >- + Indicates the transaction associated with the assessment is + suspected of being fraudulent based on the payment method, + billing details, shipping address or other transaction + information. + - >- + Indicates that the user was served a 2FA challenge. An old + assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that + has not been overwritten with `PASSED_TWO_FACTOR` is treated as + an abandoned 2FA flow. This is equivalent to + `FAILED_TWO_FACTOR`. + - Indicates that the user passed a 2FA challenge. + - Indicates that the user failed a 2FA challenge. + - Indicates the user provided the correct password. + - Indicates the user provided an incorrect password. + - >- + Indicates that the user sent unwanted and abusive messages to + other users of the platform, such as spam, scams, phishing, or + social engineering. + enum: + - REASON_UNSPECIFIED + - CHARGEBACK + - CHARGEBACK_FRAUD + - CHARGEBACK_DISPUTE + - REFUND + - REFUND_FRAUD + - TRANSACTION_ACCEPTED + - TRANSACTION_DECLINED + - PAYMENT_HEURISTICS + - INITIATED_TWO_FACTOR + - PASSED_TWO_FACTOR + - FAILED_TWO_FACTOR + - CORRECT_PASSWORD + - INCORRECT_PASSWORD + - SOCIAL_SPAM + annotation: + type: string description: >- - Optional. All assessments for this Key return this score. Must be - between 0 (likely not legitimate) and 1 (likely legitimate) - inclusive. - testingChallenge: + Optional. The annotation that is assigned to the Event. This field + can be left empty to provide reasons that apply to an event without + concluding whether the event is legitimate or fraudulent. enumDescriptions: + - Default unspecified type. + - Provides information that the event turned out to be legitimate. + - Provides information that the event turned out to be fraudulent. - >- - Perform the normal risk analysis and return either nocaptcha or a - challenge depending on risk and trust factors. - - >- - Challenge requests for this key always return a nocaptcha, which - does not require a solution. + Provides information that the event was related to a login event + in which the user typed the correct password. Deprecated, prefer + indicating CORRECT_PASSWORD through the reasons field instead. - >- - Challenge requests for this key always return an unsolvable - challenge. - description: >- - Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - challenge requests for this site return nocaptcha if NOCAPTCHA, or - an unsolvable challenge if CHALLENGE. + Provides information that the event was related to a login event + in which the user typed the incorrect password. Deprecated, prefer + indicating INCORRECT_PASSWORD through the reasons field instead. + enumDeprecated: + - false + - false + - false + - true + - true enum: - - TESTING_CHALLENGE_UNSPECIFIED - - NOCAPTCHA - - UNSOLVABLE_CHALLENGE - type: string - description: Options for user acceptance testing. + - ANNOTATION_UNSPECIFIED + - LEGITIMATE + - FRAUDULENT + - PASSWORD_CORRECT + - PASSWORD_INCORRECT + transactionEvent: + description: >- + Optional. If the assessment is part of a payment transaction, + provide details on payment lifecycle events that occur in the + transaction. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent type: object - id: GoogleCloudRecaptchaenterpriseV1TestingOptions + description: The request message to annotate an Assessment. + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus + type: object + properties: + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + details: + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object parameters: - callback: - description: JSONP - in: query - name: callback - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -2066,15 +2038,6 @@ components: enum: - '1' - '2' - 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. - in: query - name: key - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query @@ -2096,121 +2059,177 @@ components: name: fields schema: type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + 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. in: query - name: uploadType + name: key schema: type: string x-stackQL-resources: - keys: - id: google.recaptchaenterprise.keys - name: keys - title: Keys + assessments: + id: google.recaptchaenterprise.assessments + name: assessments + title: Assessments methods: - list: + annotate: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1assessments~1{assessmentsId}:annotate/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keys create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1assessments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/assessments/methods/create' + update: [] + replace: [] + delete: [] + firewallpolicies: + id: google.recaptchaenterprise.firewallpolicies + name: firewallpolicies + title: Firewallpolicies + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/patch' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/patch response: mediaType: application/json openAPIDocKey: '200' - get: + create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' response: mediaType: application/json openAPIDocKey: '200' - migrate: + list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.firewallPolicies + reorder: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies:reorder/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/keys/methods/get' - - $ref: '#/components/x-stackQL-resources/keys/methods/list' + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/get' + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/keys/methods/create' + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/create' update: - - $ref: '#/components/x-stackQL-resources/keys/methods/patch' + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/keys/methods/delete' - keys_legacy_secret_key: - id: google.recaptchaenterprise.keys_legacy_secret_key - name: keys_legacy_secret_key - title: Keys_legacy_secret_key + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/delete' + relatedaccountgroups: + id: google.recaptchaenterprise.relatedaccountgroups + name: relatedaccountgroups + title: Relatedaccountgroups methods: - retrieve_legacy_secret_key: + list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:retrieveLegacySecretKey/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.relatedAccountGroups sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/keys_legacy_secret_key/methods/retrieve_legacy_secret_key + - $ref: '#/components/x-stackQL-resources/relatedaccountgroups/methods/list' insert: [] update: [] replace: [] delete: [] - keys_ip_override: - id: google.recaptchaenterprise.keys_ip_override - name: keys_ip_override - title: Keys_ip_override + memberships: + id: google.recaptchaenterprise.memberships + name: memberships + title: Memberships methods: - add_ip_override: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:addIpOverride/post - response: - mediaType: application/json - openAPIDocKey: '200' - remove_ip_override: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:removeIpOverride/post + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups~1{relatedaccountgroupsId}~1memberships/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.relatedAccountGroupMemberships sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/keys_ip_override/methods/add_ip_override + select: + - $ref: '#/components/x-stackQL-resources/memberships/methods/list' + insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/keys_ip_override/methods/remove_ip_override + delete: [] keys_metrics: id: google.recaptchaenterprise.keys_metrics name: keys_metrics @@ -2229,183 +2248,173 @@ components: update: [] replace: [] delete: [] - keys_ip_overrides: - id: google.recaptchaenterprise.keys_ip_overrides - name: keys_ip_overrides - title: Keys_ip_overrides - methods: - list_ip_overrides: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:listIpOverrides/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.ipOverrides - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/keys_ip_overrides/methods/list_ip_overrides - insert: [] - update: [] - replace: [] - delete: [] - relatedaccountgroupmemberships: - id: google.recaptchaenterprise.relatedaccountgroupmemberships - name: relatedaccountgroupmemberships - title: Relatedaccountgroupmemberships + keys: + id: google.recaptchaenterprise.keys + name: keys + title: Keys methods: - search: + get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - assessments: - id: google.recaptchaenterprise.assessments - name: assessments - title: Assessments - methods: - annotate: + delete: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1assessments~1{assessmentsId}:annotate/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1assessments/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/patch' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/assessments/methods/create' - update: [] - replace: [] - delete: [] - firewallpolicies: - id: google.recaptchaenterprise.firewallpolicies - name: firewallpolicies - title: Firewallpolicies - methods: create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.firewallPolicies - patch: + objectKey: $.keys + migrate: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/patch + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys/methods/get' + - $ref: '#/components/x-stackQL-resources/keys/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/keys/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/keys/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + keys_ip_overrides: + id: google.recaptchaenterprise.keys_ip_overrides + name: keys_ip_overrides + title: Keys_ip_overrides + methods: + list_ip_overrides: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:listIpOverrides/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.ipOverrides + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/keys_ip_overrides/methods/list_ip_overrides + insert: [] + update: [] + replace: [] + delete: [] + keys_ip_override: + id: google.recaptchaenterprise.keys_ip_override + name: keys_ip_override + title: Keys_ip_override + methods: + remove_ip_override: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:removeIpOverride/post response: mediaType: application/json openAPIDocKey: '200' - reorder: + add_ip_override: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies:reorder/post + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:addIpOverride/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/get' - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/list' + select: [] insert: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/keys_ip_override/methods/add_ip_override + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/delete' - relatedaccountgroups: - id: google.recaptchaenterprise.relatedaccountgroups - name: relatedaccountgroups - title: Relatedaccountgroups + - $ref: >- + #/components/x-stackQL-resources/keys_ip_override/methods/remove_ip_override + keys_legacy_secret_key: + id: google.recaptchaenterprise.keys_legacy_secret_key + name: keys_legacy_secret_key + title: Keys_legacy_secret_key methods: - list: + retrieve_legacy_secret_key: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:retrieveLegacySecretKey/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.relatedAccountGroups sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/relatedaccountgroups/methods/list' + - $ref: >- + #/components/x-stackQL-resources/keys_legacy_secret_key/methods/retrieve_legacy_secret_key insert: [] update: [] replace: [] delete: [] - memberships: - id: google.recaptchaenterprise.memberships - name: memberships - title: Memberships + relatedaccountgroupmemberships: + id: google.recaptchaenterprise.relatedaccountgroupmemberships + name: relatedaccountgroupmemberships + title: Relatedaccountgroupmemberships methods: - list: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups~1{relatedaccountgroupsId}~1memberships/get + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.relatedAccountGroupMemberships sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/memberships/methods/list' + select: [] insert: [] update: [] replace: [] delete: [] paths: - /v1/projects/{projectsId}/keys: + /v1/projects/{projectsId}/assessments/{assessmentsId}:annotate: parameters: &ref_1 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - get: - description: Returns the list of all keys that belong to a project. - operationId: recaptchaenterprise.projects.keys.list + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/key' + post: + description: >- + Annotates a previously created Assessment to provide additional + information on whether the event turned out to be authentic or + fraudulent. + operationId: recaptchaenterprise.projects.assessments.annotate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2418,30 +2427,28 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: assessmentsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/assessments: + parameters: *ref_1 post: - description: Creates a new reCAPTCHA Enterprise key. - operationId: recaptchaenterprise.projects.keys.create + description: Creates an Assessment of the likelihood an event is legitimate. + operationId: recaptchaenterprise.projects.assessments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2453,18 +2460,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}: + /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: parameters: *ref_1 + get: + description: Returns the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: firewallpoliciesId + required: true + schema: + type: string delete: - description: Deletes the specified key. - operationId: recaptchaenterprise.projects.keys.delete + description: Deletes the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2484,18 +2519,19 @@ paths: schema: type: string - in: path - name: keysId + name: firewallpoliciesId required: true schema: type: string patch: - description: Updates the specified key. - operationId: recaptchaenterprise.projects.keys.patch + description: Updates the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2507,7 +2543,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId @@ -2515,7 +2552,7 @@ paths: schema: type: string - in: path - name: keysId + name: firewallpoliciesId required: true schema: type: string @@ -2524,9 +2561,20 @@ paths: schema: type: string format: google-fieldmask - get: - description: Returns the specified key. - operationId: recaptchaenterprise.projects.keys.get + /v1/projects/{projectsId}/firewallpolicies: + parameters: *ref_1 + post: + description: >- + Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA + Enterprise actions can be executed. A project may have a maximum of 1000 + policies. + operationId: recaptchaenterprise.projects.firewallpolicies.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2538,26 +2586,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: - parameters: *ref_1 get: - description: >- - Returns the secret key related to the specified public key. You must use - the legacy secret key only in a 3rd party integration with legacy - reCAPTCHA. - operationId: recaptchaenterprise.projects.keys.retrieveLegacySecretKey + description: Returns the list of all firewall policies that belong to a project. + operationId: recaptchaenterprise.projects.firewallpolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2570,33 +2609,33 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:addIpOverride: + /v1/projects/{projectsId}/firewallpolicies:reorder: parameters: *ref_1 post: - description: >- - Adds an IP override to a key. The following restrictions hold: * The - maximum number of IP overrides per key is 100. * For any conflict (such - as IP already exists or IP part of an existing IP range), an error is - returned. - operationId: recaptchaenterprise.projects.keys.addIpOverride + description: Reorders all firewall policies. + operationId: recaptchaenterprise.projects.firewallpolicies.reorder requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2609,25 +2648,18 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - /v1/projects/{projectsId}/keys/{keysId}/metrics: + /v1/projects/{projectsId}/relatedaccountgroups: parameters: *ref_1 get: - description: >- - Get some aggregated metrics for a Key. This data can be used to build - dashboards. - operationId: recaptchaenterprise.projects.keys.getMetrics + description: List groups of related accounts. + operationId: recaptchaenterprise.projects.relatedaccountgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2639,23 +2671,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:listIpOverrides: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships: parameters: *ref_1 get: - description: Lists all IP overrides for a key. - operationId: recaptchaenterprise.projects.keys.listIpOverrides + description: Get memberships in a group of related accounts. + operationId: recaptchaenterprise.projects.relatedaccountgroups.memberships.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2668,7 +2705,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse parameters: - in: path name: projectsId @@ -2676,34 +2713,26 @@ paths: schema: type: string - in: path - name: keysId + name: relatedaccountgroupsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/keys/{keysId}:removeIpOverride: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/keys/{keysId}/metrics: parameters: *ref_1 - post: + get: description: >- - Removes an IP override from a key. The following restrictions hold: * If - the IP isn't found in an existing IP override, a `NOT_FOUND` error is - returned. * If the IP is found in an existing IP override, but the - override type does not match, a `NOT_FOUND` error is returned. - operationId: recaptchaenterprise.projects.keys.removeIpOverride - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest + Get some aggregated metrics for a Key. This data can be used to build + dashboards. + operationId: recaptchaenterprise.projects.keys.getMetrics security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2715,8 +2744,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics' parameters: - in: path name: projectsId @@ -2728,22 +2756,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:migrate: + /v1/projects/{projectsId}/keys/{keysId}: parameters: *ref_1 - post: - description: >- - Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a - key is migrated, it can be used from either product. SiteVerify requests - are billed as CreateAssessment calls. You must be authenticated as one - of the current owners of the reCAPTCHA Key, and your user must have the - reCAPTCHA Enterprise Admin IAM role in the destination project. - operationId: recaptchaenterprise.projects.keys.migrate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest + get: + description: Returns the specified key. + operationId: recaptchaenterprise.projects.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2767,17 +2784,9 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: - parameters: *ref_1 - post: - description: Search group memberships related to a given account. - operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + delete: + description: Deletes the specified key. + operationId: recaptchaenterprise.projects.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2789,28 +2798,26 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/assessments/{assessmentsId}:annotate: - parameters: *ref_1 - post: - description: >- - Annotates a previously created Assessment to provide additional - information on whether the event turned out to be authentic or - fraudulent. - operationId: recaptchaenterprise.projects.assessments.annotate + - in: path + name: keysId + required: true + schema: + type: string + patch: + description: Updates the specified key. + operationId: recaptchaenterprise.projects.keys.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2822,8 +2829,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId @@ -2831,20 +2837,20 @@ paths: schema: type: string - in: path - name: assessmentsId + name: keysId required: true schema: type: string - /v1/projects/{projectsId}/assessments: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/keys/{keysId}:listIpOverrides: parameters: *ref_1 - post: - description: Creates an Assessment of the likelihood an event is legitimate. - operationId: recaptchaenterprise.projects.assessments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment' + get: + description: Lists all IP overrides for a key. + operationId: recaptchaenterprise.projects.keys.listIpOverrides security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2857,27 +2863,37 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/firewallpolicies: + - in: path + name: keysId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/keys: parameters: *ref_1 post: - description: >- - Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA - Enterprise actions can be executed. A project may have a maximum of 1000 - policies. - operationId: recaptchaenterprise.projects.firewallpolicies.create + description: Creates a new reCAPTCHA Enterprise key. + operationId: recaptchaenterprise.projects.keys.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2889,8 +2905,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId @@ -2898,8 +2913,8 @@ paths: schema: type: string get: - description: Returns the list of all firewall policies that belong to a project. - operationId: recaptchaenterprise.projects.firewallpolicies.list + description: Returns the list of all keys that belong to a project. + operationId: recaptchaenterprise.projects.keys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2912,7 +2927,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse parameters: - in: path name: projectsId @@ -2928,17 +2943,22 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: + /v1/projects/{projectsId}/keys/{keysId}:migrate: parameters: *ref_1 - patch: - description: Updates the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.patch + post: + description: >- + Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a + key is migrated, it can be used from either product. SiteVerify requests + are billed as CreateAssessment calls. You must be authenticated as one + of the current owners of the reCAPTCHA Key, and your user must have the + reCAPTCHA Enterprise Admin IAM role in the destination project. + operationId: recaptchaenterprise.projects.keys.migrate requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2950,8 +2970,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId @@ -2959,18 +2978,25 @@ paths: schema: type: string - in: path - name: firewallpoliciesId + name: keysId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Returns the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.get + /v1/projects/{projectsId}/keys/{keysId}:removeIpOverride: + parameters: *ref_1 + post: + description: >- + Removes an IP override from a key. The following restrictions hold: * If + the IP isn't found in an existing IP override, a `NOT_FOUND` error is + returned. * If the IP is found in an existing IP override, but the + override type does not match, a `NOT_FOUND` error is returned. + operationId: recaptchaenterprise.projects.keys.removeIpOverride + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2983,7 +3009,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse parameters: - in: path name: projectsId @@ -2991,13 +3017,18 @@ paths: schema: type: string - in: path - name: firewallpoliciesId + name: keysId required: true schema: type: string - delete: - description: Deletes the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.delete + /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: + parameters: *ref_1 + get: + description: >- + Returns the secret key related to the specified public key. You must use + the legacy secret key only in a 3rd party integration with legacy + reCAPTCHA. + operationId: recaptchaenterprise.projects.keys.retrieveLegacySecretKey security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3009,7 +3040,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse parameters: - in: path name: projectsId @@ -3017,21 +3049,25 @@ paths: schema: type: string - in: path - name: firewallpoliciesId + name: keysId required: true schema: type: string - /v1/projects/{projectsId}/firewallpolicies:reorder: + /v1/projects/{projectsId}/keys/{keysId}:addIpOverride: parameters: *ref_1 post: - description: Reorders all firewall policies. - operationId: recaptchaenterprise.projects.firewallpolicies.reorder + description: >- + Adds an IP override to a key. The following restrictions hold: * The + maximum number of IP overrides per key is 100. * For any conflict (such + as IP already exists or IP part of an existing IP range), an error is + returned. + operationId: recaptchaenterprise.projects.keys.addIpOverride requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3044,51 +3080,29 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/relatedaccountgroups: - parameters: *ref_1 - get: - description: List groups of related accounts. - operationId: recaptchaenterprise.projects.relatedaccountgroups.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse - parameters: - in: path - name: projectsId + name: keysId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships: + /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: parameters: *ref_1 - get: - description: Get memberships in a group of related accounts. - operationId: recaptchaenterprise.projects.relatedaccountgroups.memberships.list + post: + description: Search group memberships related to a given account. + operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3101,24 +3115,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: relatedaccountgroupsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml b/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml index b511b6ef..66b9345d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml @@ -34,52 +34,36 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecommenderV1OperationGroup: - id: GoogleCloudRecommenderV1OperationGroup - type: object - description: Group of operations that need to be performed atomically. - properties: - operations: - description: >- - List of operations across one or more resources that belong to this - group. Loosely based on RFC6902 and should be performed in the order - they appear. - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Operation' - type: array - GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: - description: Request for the `MarkRecommendationSucceeded` Method. + GoogleCloudRecommenderV1InsightTypeGenerationConfig: + description: >- + A configuration to customize the generation of insights. Eg, customizing + the lookback period considered when generating a insight. type: object + id: GoogleCloudRecommenderV1InsightTypeGenerationConfig properties: - etag: - type: string + params: description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. - stateMetadata: - type: object + Parameters for this InsightTypeGenerationConfig. These configs can + be used by or are applied to all subtypes. additionalProperties: - type: string - description: >- - State properties to include with this state. Overwrites any existing - `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. - Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. - id: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + description: Properties of the object. + type: any + type: object GoogleTypeMoney: - description: Represents an amount of money with its currency type. - type: object id: GoogleTypeMoney + type: object properties: units: type: string + format: int64 description: >- The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - format: int64 currencyCode: - description: The three-letter currency code defined in ISO 4217. type: string + description: The three-letter currency code defined in ISO 4217. nanos: + format: int32 description: >- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is @@ -87,191 +71,62 @@ components: `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - format: int32 type: integer - GoogleCloudRecommenderV1ReliabilityProjection: - properties: - details: - additionalProperties: - description: Properties of the object. - type: any - type: object - description: Per-recommender projection. - risks: - type: array - items: - enum: - - RISK_TYPE_UNSPECIFIED - - SERVICE_DISRUPTION - - DATA_LOSS - - ACCESS_DENY - type: string - enumDescriptions: - - Default unspecified risk. Don't use directly. - - Potential service downtime. - - Potential data loss. - - >- - Potential access denial. The service is still up but some or all - clients can't access it. - description: Reliability risks mitigated by this recommendation. - id: GoogleCloudRecommenderV1ReliabilityProjection - type: object - description: Contains information on the impact of a reliability recommendation. - GoogleCloudRecommenderV1Operation: - description: >- - Contains an operation for a resource loosely based on the JSON-PATCH - format with support for: * Custom filters for describing partial array - patch. * Extended path values for describing nested arrays. * Custom - fields for describing the resource for which the operation is being - described. * Allows extension to custom operations not natively - supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for - details on the original RFC. + description: Represents an amount of money with its currency type. + GoogleCloudRecommenderV1SustainabilityProjection: properties: - value: - type: any - description: >- - Value for the `path` field. Will be set for actions:'add'/'replace'. - Maybe set for action: 'test'. Either this or `value_matcher` will be - set for 'test' operation. An exact match must be performed. - sourceResource: - type: string - description: >- - Can be set with action 'copy' to copy resource configuration across - different resources of the same type. Example: A resource clone can - be done via action = 'copy', path = "/", from = "/", source_resource - = and resource_name = . This field is empty for all other values of - `action`. - resource: - description: >- - Contains the fully qualified resource name. This field is always - populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. - type: string - valueMatcher: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' - description: >- - Can be set for action 'test' for advanced matching for the value of - 'path' field. Either this or `value` will be set for 'test' - operation. - resourceType: - description: >- - Type of GCP resource being modified/tested. This field is always - populated. Example: cloudresourcemanager.googleapis.com/Project, - compute.googleapis.com/Instance - type: string - pathValueMatchers: - type: object - description: >- - Similar to path_filters, this contains set of filters to apply if - `path` field refers to array elements. This is meant to support - value matching beyond exact match. To perform exact match, use - path_filters. When both path_filters and path_value_matchers are - set, an implicit AND must be performed. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' - pathFilters: - description: >- - Set of filters to apply if `path` refers to array elements or nested - array elements in order to narrow down to a single unique element - that is being tested/modified. This is intended to be an exact match - per filter. To perform advanced matching, use path_value_matchers. * - Example: ``` { "/versions/*/name" : "it-123" - "/versions/*/targetSize/percent": 20 } ``` * Example: ``` { - "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } - ``` * Example: ``` { "/bindings/*/role": "roles/owner" - "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ``` - When both path_filters and path_value_matchers are set, an implicit - AND must be performed. - additionalProperties: - type: any - type: object - action: - type: string - description: >- - Type of this operation. Contains one of 'add', 'remove', 'replace', - 'move', 'copy', 'test' and custom operations. This field is - case-insensitive and always populated. - sourcePath: - type: string - description: >- - Can be set with action 'copy' or 'move' to indicate the source field - within resource or source_resource, ignored if provided for other - operation types. - path: + duration: + description: Duration for which this sustainability applies. + format: google-duration type: string + kgCO2e: description: >- - Path to the target field being operated on. If the operation is at - the resource level, then path should be "/". This field is always - populated. + Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e + so that the name renders correctly in camelCase (kgCO2e). + type: number + format: double + description: >- + Contains metadata about how much sustainability a recommendation can + save or incur. type: object - id: GoogleCloudRecommenderV1Operation - GoogleCloudRecommenderV1InsightTypeConfig: + id: GoogleCloudRecommenderV1SustainabilityProjection + GoogleCloudRecommenderV1ListInsightsResponse: + description: Response to the `ListInsights` method. type: object - id: GoogleCloudRecommenderV1InsightTypeConfig properties: - annotations: - type: object - additionalProperties: - type: string - description: >- - Allows clients to store small amounts of arbitrary data. Annotations - must follow the Kubernetes syntax. The total size of all keys and - values combined is limited to 256k. Key can have 2 segments: prefix - (optional) and name (required), separated by a slash (/). Prefix - must be a DNS subdomain. Name must be 63 characters or less, begin - and end with alphanumerics, with dashes (-), underscores (_), dots - (.), and alphanumerics between. - updateTime: - description: Last time when the config was updated. - format: google-datetime - type: string - etag: - type: string - description: >- - Fingerprint of the InsightTypeConfig. Provides optimistic locking - when updating. - name: - type: string - description: >- - Identifier. Name of insight type config. Eg, - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config - revisionId: - type: string - readOnly: true - description: >- - Output only. Immutable. The revision ID of the config. A new - revision is committed whenever the config is changed in any way. The - format is an 8-character hexadecimal string. - insightTypeGenerationConfig: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig + nextPageToken: description: >- - InsightTypeGenerationConfig which configures the generation of - insights for this insight type. - displayName: + A token that can be used to request the next page of results. This + field is empty if there are no additional results. type: string - description: >- - A user-settable field to provide a human-readable name to be used in - user interfaces. - description: Configuration for an InsightType. - GoogleCloudRecommenderV1MarkInsightAcceptedRequest: - description: Request for the `MarkInsightAccepted` method. - id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest + insights: + type: array + description: The set of insights for the `parent` resource. + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + id: GoogleCloudRecommenderV1ListInsightsResponse + GoogleCloudRecommenderV1SecurityProjection: type: object + description: Contains various ways of describing the impact on Security. properties: - stateMetadata: + details: + description: >- + Additional security impact details that is provided by the + recommender. type: object additionalProperties: - type: string - description: >- - Optional. State properties user wish to include with this state. - Full replace of the current state_metadata. + description: Properties of the object. + type: any + id: GoogleCloudRecommenderV1SecurityProjection + GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: + id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + properties: etag: type: string - description: Required. Fingerprint of the Insight. Provides optimistic locking. - GoogleCloudRecommenderV1RecommendationStateInfo: - id: GoogleCloudRecommenderV1RecommendationStateInfo - description: Information for state. Contains state and metadata. + description: Fingerprint of the Recommendation. Provides optimistic locking. + description: Request for the `MarkRecommendationDismissed` Method. type: object + GoogleCloudRecommenderV1RecommendationStateInfo: properties: stateMetadata: additionalProperties: @@ -281,7 +136,6 @@ components: A map of metadata for the state, provided by user or automations systems. state: - type: string enumDescriptions: - Default state. Don't use directly. - >- @@ -304,6 +158,7 @@ components: Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE. + type: string description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. enum: - STATE_UNSPECIFIED @@ -312,70 +167,20 @@ components: - SUCCEEDED - FAILED - DISMISSED - GoogleCloudRecommenderV1RecommendationContent: - id: GoogleCloudRecommenderV1RecommendationContent - description: Contains what resources are changing and how they are changing. - type: object - properties: - overview: - description: Condensed overview information about the recommendation. - additionalProperties: - description: Properties of the object. - type: any - type: object - operationGroups: - description: >- - Operations to one or more Google Cloud resources grouped in such a - way that, all operations within one group are expected to be - performed atomically and in an order. - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' - GoogleCloudRecommenderV1ListInsightsResponse: - type: object - id: GoogleCloudRecommenderV1ListInsightsResponse - properties: - insights: - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' - description: The set of insights for the `parent` resource. - nextPageToken: - type: string - description: >- - A token that can be used to request the next page of results. This - field is empty if there are no additional results. - description: Response to the `ListInsights` method. - GoogleCloudRecommenderV1RecommendationInsightReference: - id: GoogleCloudRecommenderV1RecommendationInsightReference - description: Reference to an associated insight. - properties: - insight: - description: >- - Insight resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] - type: string - type: object - GoogleCloudRecommenderV1InsightRecommendationReference: - description: Reference to an associated recommendation. - id: GoogleCloudRecommenderV1InsightRecommendationReference type: object - properties: - recommendation: - type: string - description: >- - Recommendation resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + description: Information for state. Contains state and metadata. + id: GoogleCloudRecommenderV1RecommendationStateInfo GoogleCloudRecommenderV1InsightStateInfo: properties: stateMetadata: description: >- A map of metadata for the state, provided by user or automations systems. + type: object additionalProperties: type: string - type: object state: + description: Insight state. enum: - STATE_UNSPECIFIED - ACTIVE @@ -397,74 +202,110 @@ components: - >- Insight is dismissed. Content for DISMISSED insights can be updated by Google. DISMISSED insights can be marked as ACTIVE. - description: Insight state. - id: GoogleCloudRecommenderV1InsightStateInfo description: Information related to insight state. + id: GoogleCloudRecommenderV1InsightStateInfo type: object - GoogleCloudRecommenderV1SecurityProjection: - id: GoogleCloudRecommenderV1SecurityProjection + GoogleCloudRecommenderV1ListRecommendationsResponse: + description: Response to the `ListRecommendations` method. + properties: + recommendations: + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + type: array + description: The set of recommendations for the `parent` resource. + nextPageToken: + description: >- + A token that can be used to request the next page of results. This + field is empty if there are no additional results. + type: string type: object + id: GoogleCloudRecommenderV1ListRecommendationsResponse + GoogleCloudRecommenderV1ReliabilityProjection: + id: GoogleCloudRecommenderV1ReliabilityProjection properties: details: - description: >- - Additional security impact details that is provided by the - recommender. type: object additionalProperties: type: any description: Properties of the object. - description: Contains various ways of describing the impact on Security. - GoogleCloudRecommenderV1ValueMatcher: - id: GoogleCloudRecommenderV1ValueMatcher - description: Contains various matching options for values for a GCP resource field. + description: Per-recommender projection. + risks: + items: + enum: + - RISK_TYPE_UNSPECIFIED + - SERVICE_DISRUPTION + - DATA_LOSS + - ACCESS_DENY + enumDescriptions: + - Default unspecified risk. Don't use directly. + - Potential service downtime. + - Potential data loss. + - >- + Potential access denial. The service is still up but some or all + clients can't access it. + type: string + description: Reliability risks mitigated by this recommendation. + type: array type: object + description: Contains information on the impact of a reliability recommendation. + GoogleCloudRecommenderV1OperationGroup: properties: - matchesPattern: - type: string + operations: description: >- - To be used for full regex matching. The regular expression is using - the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), - so to be used with RE2::FullMatch - GoogleCloudRecommenderV1RecommenderConfig: - id: GoogleCloudRecommenderV1RecommenderConfig + List of operations across one or more resources that belong to this + group. Loosely based on RFC6902 and should be performed in the order + they appear. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Operation' + description: Group of operations that need to be performed atomically. + id: GoogleCloudRecommenderV1OperationGroup + type: object + GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: type: object properties: - name: - type: string - description: >- - Identifier. Name of recommender config. Eg, - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config - recommenderGenerationConfig: - description: >- - RecommenderGenerationConfig which configures the Generation of - recommendations for this recommender. - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig etag: description: >- - Fingerprint of the RecommenderConfig. Provides optimistic locking - when updating. - type: string - updateTime: - description: Last time when the config was updated. - format: google-datetime + Required. Fingerprint of the Recommendation. Provides optimistic + locking. type: string - displayName: + stateMetadata: + type: object description: >- - A user-settable field to provide a human-readable name to be used in - user interfaces. - type: string - revisionId: + State properties to include with this state. Overwrites any existing + `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + additionalProperties: + type: string + description: Request for the `MarkRecommendationClaimed` Method. + id: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: + type: object + properties: + stateMetadata: description: >- - Output only. Immutable. The revision ID of the config. A new - revision is committed whenever the config is changed in any way. The - format is an 8-character hexadecimal string. + State properties to include with this state. Overwrites any existing + `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + type: object + additionalProperties: + type: string + etag: type: string - readOnly: true + description: >- + Required. Fingerprint of the Recommendation. Provides optimistic + locking. + description: Request for the `MarkRecommendationSucceeded` Method. + id: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + GoogleCloudRecommenderV1InsightTypeConfig: + id: GoogleCloudRecommenderV1InsightTypeConfig + description: Configuration for an InsightType. + type: object + properties: annotations: - type: object additionalProperties: type: string + type: object description: >- Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and @@ -473,213 +314,191 @@ components: must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. - description: Configuration for a Recommender. - GoogleCloudRecommenderV1CostProjection: - type: object - description: >- - Contains metadata about how much money a recommendation can save or - incur. - properties: - duration: - format: google-duration + displayName: + description: >- + A user-settable field to provide a human-readable name to be used in + user interfaces. type: string - description: Duration for which this cost applies. - costInLocalCurrency: + etag: description: >- - The approximate cost savings in the billing account's local - currency. - $ref: '#/components/schemas/GoogleTypeMoney' - cost: + Fingerprint of the InsightTypeConfig. Provides optimistic locking + when updating. + type: string + insightTypeGenerationConfig: description: >- - An approximate projection on amount saved or amount incurred. - Negative cost units indicate cost savings and positive cost units - indicate increase. See google.type.Money documentation for - positive/negative units. A user's permissions may affect whether the - cost is computed using list prices or custom contract prices. - $ref: '#/components/schemas/GoogleTypeMoney' - id: GoogleCloudRecommenderV1CostProjection - GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: + InsightTypeGenerationConfig which configures the generation of + insights for this insight type. + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig + name: + description: >- + Identifier. Name of insight type config. Eg, + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config + type: string + revisionId: + description: >- + Output only. Immutable. The revision ID of the config. A new + revision is committed whenever the config is changed in any way. The + format is an 8-character hexadecimal string. + readOnly: true + type: string + updateTime: + format: google-datetime + type: string + description: Last time when the config was updated. + GoogleCloudRecommenderV1ValueMatcher: + id: GoogleCloudRecommenderV1ValueMatcher + description: Contains various matching options for values for a GCP resource field. + type: object properties: - etag: + matchesPattern: description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. + To be used for full regex matching. The regular expression is using + the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), + so to be used with RE2::FullMatch type: string + GoogleCloudRecommenderV1MarkRecommendationFailedRequest: + id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest + type: object + properties: stateMetadata: - type: object + additionalProperties: + type: string description: >- State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. - additionalProperties: - type: string - description: Request for the `MarkRecommendationClaimed` Method. - id: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest - type: object - GoogleCloudRecommenderV1InsightTypeGenerationConfig: - description: >- - A configuration to customize the generation of insights. Eg, customizing - the lookback period considered when generating a insight. - type: object - id: GoogleCloudRecommenderV1InsightTypeGenerationConfig - properties: - params: - description: >- - Parameters for this InsightTypeGenerationConfig. These configs can - be used by or are applied to all subtypes. - additionalProperties: - description: Properties of the object. - type: any type: object - GoogleCloudRecommenderV1Insight: - type: object - description: >- - An insight along with the information used to derive the insight. The - insight may have associated recommendations as well. - properties: - insightSubtype: + etag: description: >- - Insight subtype. Insight content schema will be stable for a given - subtype. + Required. Fingerprint of the Recommendation. Provides optimistic + locking. type: string - stateInfo: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' - description: Information state and metadata. - content: + description: Request for the `MarkRecommendationFailed` Method. + GoogleCloudRecommenderV1Operation: + id: GoogleCloudRecommenderV1Operation + type: object + properties: + pathFilters: + type: object additionalProperties: - description: Properties of the object. type: any description: >- - A struct of custom fields to explain the insight. Example: - "grantedPermissionsCount": "1000" - type: object - observationPeriod: - description: >- - Observation period that led to the insight. The source data used to - generate the insight ends at last_refresh_time and begins at - (last_refresh_time - observation_period). - format: google-duration + Set of filters to apply if `path` refers to array elements or nested + array elements in order to narrow down to a single unique element + that is being tested/modified. This is intended to be an exact match + per filter. To perform advanced matching, use path_value_matchers. * + Example: ``` { "/versions/*/name" : "it-123" + "/versions/*/targetSize/percent": 20 } ``` * Example: ``` { + "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } + ``` * Example: ``` { "/bindings/*/role": "roles/owner" + "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ``` + When both path_filters and path_value_matchers are set, an implicit + AND must be performed. + path: type: string - etag: + description: >- + Path to the target field being operated on. If the operation is at + the resource level, then path should be "/". This field is always + populated. + sourceResource: type: string description: >- - Fingerprint of the Insight. Provides optimistic locking when - updating states. - severity: + Can be set with action 'copy' to copy resource configuration across + different resources of the same type. Example: A resource clone can + be done via action = 'copy', path = "/", from = "/", source_resource + = and resource_name = . This field is empty for all other values of + `action`. + action: + description: >- + Type of this operation. Contains one of 'add', 'remove', 'replace', + 'move', 'copy', 'test' and custom operations. This field is + case-insensitive and always populated. type: string - description: Insight's severity. - enumDescriptions: - - Insight has unspecified severity. - - Insight has low severity. - - Insight has medium severity. - - Insight has high severity. - - Insight has critical severity. - enum: - - SEVERITY_UNSPECIFIED - - LOW - - MEDIUM - - HIGH - - CRITICAL - lastRefreshTime: + pathValueMatchers: + type: object + description: >- + Similar to path_filters, this contains set of filters to apply if + `path` field refers to array elements. This is meant to support + value matching beyond exact match. To perform exact match, use + path_filters. When both path_filters and path_value_matchers are + set, an implicit AND must be performed. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' + resourceType: type: string - format: google-datetime - description: Timestamp of the latest data used to generate the insight. - category: + description: >- + Type of GCP resource being modified/tested. This field is always + populated. Example: cloudresourcemanager.googleapis.com/Project, + compute.googleapis.com/Instance + valueMatcher: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' + description: >- + Can be set for action 'test' for advanced matching for the value of + 'path' field. Either this or `value` will be set for 'test' + operation. + resource: + description: >- + Contains the fully qualified resource name. This field is always + populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. type: string - enumDescriptions: - - Unspecified category. - - The insight is related to cost. - - The insight is related to security. - - The insight is related to performance. - - This insight is related to manageability. - - The insight is related to sustainability. - - This insight is related to reliability. - description: Category being targeted by the insight. - enum: - - CATEGORY_UNSPECIFIED - - COST - - SECURITY - - PERFORMANCE - - MANAGEABILITY - - SUSTAINABILITY - - RELIABILITY - description: + sourcePath: type: string description: >- - Free-form human readable summary in English. The maximum length is - 500 characters. - associatedRecommendations: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1InsightRecommendationReference - description: Recommendations derived from this insight. - name: - type: string - description: Identifier. Name of the insight. - targetResources: - items: - type: string - description: Fully qualified resource names that this insight is targeting. - type: array - id: GoogleCloudRecommenderV1Insight - GoogleCloudRecommenderV1RecommenderGenerationConfig: + Can be set with action 'copy' or 'move' to indicate the source field + within resource or source_resource, ignored if provided for other + operation types. + value: + type: any + description: >- + Value for the `path` field. Will be set for actions:'add'/'replace'. + Maybe set for action: 'test'. Either this or `value_matcher` will be + set for 'test' operation. An exact match must be performed. description: >- - A Configuration to customize the generation of recommendations. Eg, - customizing the lookback period considered when generating a - recommendation. + Contains an operation for a resource loosely based on the JSON-PATCH + format with support for: * Custom filters for describing partial array + patch. * Extended path values for describing nested arrays. * Custom + fields for describing the resource for which the operation is being + described. * Allows extension to custom operations not natively + supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for + details on the original RFC. + GoogleCloudRecommenderV1RecommenderGenerationConfig: + type: object properties: params: + type: object + additionalProperties: + type: any + description: Properties of the object. description: >- Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes. - additionalProperties: - description: Properties of the object. - type: any - type: object - type: object + description: >- + A Configuration to customize the generation of recommendations. Eg, + customizing the lookback period considered when generating a + recommendation. id: GoogleCloudRecommenderV1RecommenderGenerationConfig GoogleCloudRecommenderV1Recommendation: - description: >- - A recommendation along with a suggested action. E.g., a rightsizing - recommendation for an underutilized VM, IAM role recommendations, etc - id: GoogleCloudRecommenderV1Recommendation - type: object properties: - content: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' + recommenderSubtype: description: >- - Content of the recommendation describing recommended changes to - resources. + Contains an identifier for a subtype of recommendations produced for + the same recommender. Subtype is a function of content and impact, + meaning a new subtype might be added when significant changes to + `content` or `primary_impact.category` are introduced. See the + Recommenders section to see a list of subtypes for a given + Recommender. Examples: For recommender = + "google.iam.policy.Recommender", recommender_subtype can be one of + "REMOVE_ROLE"/"REPLACE_ROLE" + type: string + name: + type: string + description: Identifier. Name of recommendation. description: description: >- Free-form human readable summary in English. The maximum length is 500 characters. type: string - xorGroupId: - description: >- - Corresponds to a mutually exclusive group ID within a recommender. A - non-empty ID indicates that the recommendation belongs to a mutually - exclusive group. This means that only one recommendation within the - group is suggested to be applied. - type: string - associatedInsights: - items: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference - description: Insights that led to this recommendation. - type: array - lastRefreshTime: - type: string - description: >- - Last time this recommendation was refreshed by the system that - created it in the first place. - format: google-datetime - etag: - description: >- - Fingerprint of the Recommendation. Provides optimistic locking when - updating states. - type: string priority: enumDescriptions: - Recommendation has unspecified priority. @@ -687,69 +506,96 @@ components: - Recommendation has P3 priority (second lowest priority). - Recommendation has P2 priority (second highest priority). - Recommendation has P1 priority (highest priority). + type: string + description: Recommendation's priority. enum: - PRIORITY_UNSPECIFIED - P4 - P3 - P2 - P1 + lastRefreshTime: + description: >- + Last time this recommendation was refreshed by the system that + created it in the first place. + format: google-datetime type: string - description: Recommendation's priority. additionalImpact: items: $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' - type: array description: >- Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. - stateInfo: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' - description: Information for state. Contains state and metadata. - targetResources: - items: - type: string + type: array + content: + description: >- + Content of the recommendation describing recommended changes to + resources. + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' + xorGroupId: + description: >- + Corresponds to a mutually exclusive group ID within a recommender. A + non-empty ID indicates that the recommendation belongs to a mutually + exclusive group. This means that only one recommendation within the + group is suggested to be applied. + type: string + etag: + description: >- + Fingerprint of the Recommendation. Provides optimistic locking when + updating states. + type: string + targetResources: + items: + type: string type: array description: >- Fully qualified resource names that this recommendation is targeting. - name: - description: Identifier. Name of recommendation. - type: string + associatedInsights: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference + description: Insights that led to this recommendation. + stateInfo: + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' + description: Information for state. Contains state and metadata. primaryImpact: description: >- The primary impact that this recommendation can have while trying to optimize for one category. $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' - recommenderSubtype: - type: string - description: >- - Contains an identifier for a subtype of recommendations produced for - the same recommender. Subtype is a function of content and impact, - meaning a new subtype might be added when significant changes to - `content` or `primary_impact.category` are introduced. See the - Recommenders section to see a list of subtypes for a given - Recommender. Examples: For recommender = - "google.iam.policy.Recommender", recommender_subtype can be one of - "REMOVE_ROLE"/"REPLACE_ROLE" - GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: type: object - id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest - description: Request for the `MarkRecommendationDismissed` Method. - properties: - etag: - type: string - description: Fingerprint of the Recommendation. Provides optimistic locking. + id: GoogleCloudRecommenderV1Recommendation + description: >- + A recommendation along with a suggested action. E.g., a rightsizing + recommendation for an underutilized VM, IAM role recommendations, etc GoogleCloudRecommenderV1Impact: - id: GoogleCloudRecommenderV1Impact - description: Contains the impact a recommendation can have for a given category. - type: object properties: reliabilityProjection: $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' description: Use with CategoryType.RELIABILITY + costProjection: + description: Use with CategoryType.COST + $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' + sustainabilityProjection: + description: Use with CategoryType.SUSTAINABILITY + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection + securityProjection: + description: Use with CategoryType.SECURITY + $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' category: - description: Category that is being targeted. + type: string + enum: + - CATEGORY_UNSPECIFIED + - COST + - SECURITY + - PERFORMANCE + - MANAGEABILITY + - SUSTAINABILITY + - RELIABILITY enumDescriptions: - Default unspecified category. Don't use directly. - Indicates a potential increase or decrease in cost. @@ -758,7 +604,26 @@ components: - Indicates a potential increase or decrease in manageability. - Indicates a potential increase or decrease in sustainability. - Indicates a potential increase or decrease in reliability. + description: Category that is being targeted. + type: object + id: GoogleCloudRecommenderV1Impact + description: Contains the impact a recommendation can have for a given category. + GoogleCloudRecommenderV1Insight: + properties: + etag: type: string + description: >- + Fingerprint of the Insight. Provides optimistic locking when + updating states. + content: + description: >- + A struct of custom fields to explain the insight. Example: + "grantedPermissionsCount": "1000" + additionalProperties: + description: Properties of the object. + type: any + type: object + category: enum: - CATEGORY_UNSPECIFIED - COST @@ -767,66 +632,201 @@ components: - MANAGEABILITY - SUSTAINABILITY - RELIABILITY - costProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' - description: Use with CategoryType.COST - sustainabilityProjection: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection - description: Use with CategoryType.SUSTAINABILITY - securityProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' - description: Use with CategoryType.SECURITY - GoogleCloudRecommenderV1ListRecommendationsResponse: - id: GoogleCloudRecommenderV1ListRecommendationsResponse + enumDescriptions: + - Unspecified category. + - The insight is related to cost. + - The insight is related to security. + - The insight is related to performance. + - This insight is related to manageability. + - The insight is related to sustainability. + - This insight is related to reliability. + type: string + description: Category being targeted by the insight. + stateInfo: + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' + description: Information state and metadata. + description: + type: string + description: >- + Free-form human readable summary in English. The maximum length is + 500 characters. + targetResources: + description: Fully qualified resource names that this insight is targeting. + items: + type: string + type: array + severity: + description: Insight's severity. + enum: + - SEVERITY_UNSPECIFIED + - LOW + - MEDIUM + - HIGH + - CRITICAL + enumDescriptions: + - Insight has unspecified severity. + - Insight has low severity. + - Insight has medium severity. + - Insight has high severity. + - Insight has critical severity. + type: string + name: + type: string + description: Identifier. Name of the insight. + lastRefreshTime: + description: Timestamp of the latest data used to generate the insight. + type: string + format: google-datetime + observationPeriod: + description: >- + Observation period that led to the insight. The source data used to + generate the insight ends at last_refresh_time and begins at + (last_refresh_time - observation_period). + format: google-duration + type: string + insightSubtype: + type: string + description: >- + Insight subtype. Insight content schema will be stable for a given + subtype. + associatedRecommendations: + items: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1InsightRecommendationReference + type: array + description: Recommendations derived from this insight. + description: >- + An insight along with the information used to derive the insight. The + insight may have associated recommendations as well. + id: GoogleCloudRecommenderV1Insight type: object - description: Response to the `ListRecommendations` method. + GoogleCloudRecommenderV1RecommendationContent: properties: - nextPageToken: + overview: + description: Condensed overview information about the recommendation. + type: object + additionalProperties: + type: any + description: Properties of the object. + operationGroups: description: >- - A token that can be used to request the next page of results. This - field is empty if there are no additional results. - type: string - recommendations: + Operations to one or more Google Cloud resources grouped in such a + way that, all operations within one group are expected to be + performed atomically and in an order. type: array - description: The set of recommendations for the `parent` resource. items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' - GoogleCloudRecommenderV1SustainabilityProjection: - id: GoogleCloudRecommenderV1SustainabilityProjection + $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' + type: object + description: Contains what resources are changing and how they are changing. + id: GoogleCloudRecommenderV1RecommendationContent + GoogleCloudRecommenderV1CostProjection: properties: + cost: + description: >- + An approximate projection on amount saved or amount incurred. + Negative cost units indicate cost savings and positive cost units + indicate increase. See google.type.Money documentation for + positive/negative units. A user's permissions may affect whether the + cost is computed using list prices or custom contract prices. + $ref: '#/components/schemas/GoogleTypeMoney' duration: - description: Duration for which this sustainability applies. type: string + description: Duration for which this cost applies. format: google-duration - kgCO2e: - type: number + costInLocalCurrency: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e - so that the name renders correctly in camelCase (kgCO2e). - format: double + The approximate cost savings in the billing account's local + currency. type: object + id: GoogleCloudRecommenderV1CostProjection description: >- - Contains metadata about how much sustainability a recommendation can - save or incur. - GoogleCloudRecommenderV1MarkRecommendationFailedRequest: - description: Request for the `MarkRecommendationFailed` Method. + Contains metadata about how much money a recommendation can save or + incur. + GoogleCloudRecommenderV1RecommendationInsightReference: + id: GoogleCloudRecommenderV1RecommendationInsightReference + properties: + insight: + description: >- + Insight resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] + type: string + type: object + description: Reference to an associated insight. + GoogleCloudRecommenderV1MarkInsightAcceptedRequest: + type: object + id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest + description: Request for the `MarkInsightAccepted` method. + properties: + etag: + type: string + description: Required. Fingerprint of the Insight. Provides optimistic locking. + stateMetadata: + additionalProperties: + type: string + type: object + description: >- + Optional. State properties user wish to include with this state. + Full replace of the current state_metadata. + GoogleCloudRecommenderV1RecommenderConfig: + properties: + displayName: + type: string + description: >- + A user-settable field to provide a human-readable name to be used in + user interfaces. + name: + type: string + description: >- + Identifier. Name of recommender config. Eg, + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config + etag: + type: string + description: >- + Fingerprint of the RecommenderConfig. Provides optimistic locking + when updating. + updateTime: + type: string + description: Last time when the config was updated. + format: google-datetime + recommenderGenerationConfig: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig + description: >- + RecommenderGenerationConfig which configures the Generation of + recommendations for this recommender. + annotations: + additionalProperties: + type: string + type: object + description: >- + Allows clients to store small amounts of arbitrary data. Annotations + must follow the Kubernetes syntax. The total size of all keys and + values combined is limited to 256k. Key can have 2 segments: prefix + (optional) and name (required), separated by a slash (/). Prefix + must be a DNS subdomain. Name must be 63 characters or less, begin + and end with alphanumerics, with dashes (-), underscores (_), dots + (.), and alphanumerics between. + revisionId: + description: >- + Output only. Immutable. The revision ID of the config. A new + revision is committed whenever the config is changed in any way. The + format is an 8-character hexadecimal string. + readOnly: true + type: string + type: object + description: Configuration for a Recommender. + id: GoogleCloudRecommenderV1RecommenderConfig + GoogleCloudRecommenderV1InsightRecommendationReference: + description: Reference to an associated recommendation. type: object - id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest properties: - etag: + recommendation: type: string description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. - stateMetadata: - type: object - description: >- - State properties to include with this state. Overwrites any existing - `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. - Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. - additionalProperties: - type: string + Recommendation resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + id: GoogleCloudRecommenderV1InsightRecommendationReference parameters: access_token: description: OAuth access token. @@ -834,43 +834,53 @@ components: name: access_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: prettyPrint + name: upload_protocol schema: - type: boolean + type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: quotaUser + name: prettyPrint + schema: + type: boolean + alt: + description: Data format for response. + in: query + name: alt schema: type: string + enum: + - json + - media + - proto fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + 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. in: query - name: upload_protocol + name: key schema: type: string _.xgafv: @@ -882,44 +892,27 @@ components: enum: - '1' - '2' - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - key: + quotaUser: 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. - in: query - name: key - schema: - type: string - alt: - description: Data format for response. + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: alt + name: quotaUser schema: type: string - enum: - - json - - media - - proto x-stackQL-resources: insights: id: google.recommender.insights name: insights title: Insights methods: - organizations_locations_insight_types_insights_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' organizations_locations_insight_types_insights_mark_accepted: operation: $ref: >- @@ -935,10 +928,10 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.insights - billing_accounts_locations_insight_types_insights_get: + organizations_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -949,6 +942,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + billing_accounts_locations_insight_types_insights_get: + operation: + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' billing_accounts_locations_insight_types_insights_list: operation: $ref: >- @@ -957,47 +957,47 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.insights - folders_locations_insight_types_insights_list: + projects_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.insights - folders_locations_insight_types_insights_mark_accepted: + projects_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_insight_types_insights_get: + objectKey: $.insights + projects_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_insights_get: + folders_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_insights_list: + objectKey: $.insights + folders_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.insights - projects_locations_insight_types_insights_mark_accepted: + folders_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' @@ -1007,18 +1007,18 @@ components: #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_get - - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_get + - $ref: >- + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_list - $ref: >- #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_list - - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list - $ref: >- #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_list + - $ref: >- + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list insert: [] update: [] replace: [] @@ -1028,17 +1028,17 @@ components: name: insight_types_config title: Insight_types_config methods: - organizations_locations_insight_types_update_config: + organizations_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_insight_types_get_config: + organizations_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1056,17 +1056,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_update_config: + projects_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_get_config: + projects_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1088,173 +1088,152 @@ components: #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_update_config replace: [] delete: [] - recommenders_config: - id: google.recommender.recommenders_config - name: recommenders_config - title: Recommenders_config + recommendations: + id: google.recommender.recommendations + name: recommendations + title: Recommendations methods: - organizations_locations_recommenders_update_config: + organizations_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_get_config: + organizations_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_update_config: + organizations_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_get_config: + objectKey: $.recommendations + organizations_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_get_config: + organizations_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_update_config: + organizations_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_update_config - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_update_config - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_update_config - replace: [] - delete: [] - recommendations: - id: google.recommender.recommendations - name: recommendations - title: Recommendations - methods: - organizations_locations_recommenders_recommendations_mark_dismissed: + billing_accounts_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_list: + billing_accounts_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.recommendations - organizations_locations_recommenders_recommendations_mark_succeeded: + billing_accounts_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_get: + billing_accounts_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_failed: + billing_accounts_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_list: + projects_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - billing_accounts_locations_recommenders_recommendations_mark_claimed: + projects_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_dismissed: + projects_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_failed: + objectKey: $.recommendations + projects_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_succeeded: + projects_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_get: + projects_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_get: + folders_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_dismissed: + objectKey: $.recommendations + folders_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' @@ -1265,18 +1244,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_list: + folders_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - folders_locations_recommenders_recommendations_mark_claimed: + folders_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' @@ -1287,125 +1265,107 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_dismissed: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_list + insert: [] + update: [] + replace: [] + delete: [] + recommenders_config: + id: google.recommender.recommenders_config + name: recommenders_config + title: Recommenders_config + methods: + organizations_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_claimed: + organizations_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_get: + billing_accounts_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_list: + billing_accounts_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - projects_locations_recommenders_recommendations_mark_failed: + projects_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_succeeded: + projects_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_get + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_get + #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_list + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_list + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_update_config - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_list + #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_update_config - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list - insert: [] - update: [] + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_update_config replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: &ref_1 - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/alt' - get: - description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.organizations.locations.insightTypes.insights.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: insightTypesId - required: true - schema: - type: string - - in: path - name: insightsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_1 + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' post: description: >- Marks the Insight State as Accepted. Users can use this method to @@ -1489,6 +1449,11 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: filter schema: @@ -1497,23 +1462,13 @@ paths: name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 - patch: + get: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.organizations.locations.insightTypes.updateConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.organizations.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1525,7 +1480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: organizationsId @@ -1542,15 +1497,13 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: insightsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + parameters: *ref_1 get: description: >- Gets the requested InsightTypeConfig. There is only one instance of the @@ -1584,18 +1537,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: - parameters: *ref_1 patch: description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.organizations.locations.recommenders.updateConfig + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.organizations.locations.insightTypes.updateConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1607,7 +1558,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: organizationsId @@ -1620,7 +1571,7 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string @@ -1632,57 +1583,14 @@ paths: name: updateMask schema: type: string - format: google-fieldmask - get: - description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.organizations.locations.recommenders.getConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: recommendersId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: - parameters: *ref_1 - post: - description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markDismissed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + format: google-fieldmask + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_1 + get: + description: >- + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.organizations.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1716,25 +1624,26 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. operationId: >- - recommender.organizations.locations.recommenders.recommendations.markClaimed + recommender.organizations.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1817,26 +1726,26 @@ paths: name: filter schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. operationId: >- - recommender.organizations.locations.recommenders.recommendations.markSucceeded + recommender.organizations.locations.recommenders.recommendations.markFailed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1870,13 +1779,25 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 - get: + post: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.organizations.locations.recommenders.recommendations.get + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markClaimed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1910,26 +1831,23 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. operationId: >- - recommender.organizations.locations.recommenders.recommendations.markFailed + recommender.organizations.locations.recommenders.recommendations.markDismissed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1963,13 +1881,13 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_1 get: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.billingAccounts.locations.insightTypes.insights.get + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.organizations.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1981,10 +1899,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1994,31 +1912,20 @@ paths: schema: type: string - in: path - name: insightTypesId - required: true - schema: - type: string - - in: path - name: insightsId + name: recommendersId required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_1 - post: + patch: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.billingAccounts.locations.insightTypes.insights.markAccepted + Updates a Recommender Config. This will create a new revision of the + config. + operationId: recommender.organizations.locations.recommenders.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2030,10 +1937,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2043,22 +1950,26 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: path - name: insightsId - required: true + - in: query + name: updateMask schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_1 get: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.billingAccounts.locations.insightTypes.insights.list + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.billingAccounts.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2070,8 +1981,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path name: billingAccountsId @@ -2084,35 +1994,20 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: - parameters: *ref_1 patch: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.billingAccounts.locations.insightTypes.updateConfig + Updates a Recommender Config. This will create a new revision of the + config. + operationId: recommender.billingAccounts.locations.recommenders.updateConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2124,7 +2019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path name: billingAccountsId @@ -2137,7 +2032,7 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string @@ -2150,11 +2045,26 @@ paths: name: validateOnly schema: type: boolean - get: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + parameters: *ref_1 + post: description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.billingAccounts.locations.insightTypes.getConfig + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2166,7 +2076,60 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + parameters: + - in: path + name: billingAccountsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: recommendersId + required: true + schema: + type: string + - in: path + name: recommendationsId + required: true + schema: + type: string + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + parameters: *ref_1 + post: + description: >- + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markFailed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: billingAccountsId @@ -2179,7 +2142,12 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId + required: true + schema: + type: string + - in: path + name: recommendationsId required: true schema: type: string @@ -2219,6 +2187,10 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -2228,10 +2200,6 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 post: @@ -2284,6 +2252,46 @@ paths: required: true schema: type: string + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_1 + get: + description: >- + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.billingAccounts.locations.recommenders.recommendations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + parameters: + - in: path + name: billingAccountsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: recommendersId + required: true + schema: + type: string + - in: path + name: recommendationsId + required: true + schema: + type: string /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 post: @@ -2334,26 +2342,22 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markFailed + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.billingAccounts.locations.insightTypes.insights.markAccepted requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2365,7 +2369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: billingAccountsId @@ -2378,35 +2382,22 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 - post: + get: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.billingAccounts.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2418,7 +2409,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: billingAccountsId @@ -2431,22 +2422,22 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_1 get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.billingAccounts.locations.recommenders.recommendations.get + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.billingAccounts.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2458,7 +2449,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path name: billingAccountsId @@ -2471,27 +2463,35 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + - in: query + name: pageToken + schema: + type: string + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: *ref_1 patch: description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.billingAccounts.locations.recommenders.updateConfig + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.billingAccounts.locations.insightTypes.updateConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2503,7 +2503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: billingAccountsId @@ -2516,7 +2516,7 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string @@ -2531,9 +2531,9 @@ paths: type: boolean get: description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.billingAccounts.locations.recommenders.getConfig + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.billingAccounts.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2545,7 +2545,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: billingAccountsId @@ -2558,17 +2558,17 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 get: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.folders.locations.insightTypes.insights.list + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.projects.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2580,11 +2580,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2598,35 +2597,18 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: insightsId + required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_1 - post: + get: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.folders.locations.insightTypes.insights.markAccepted - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.projects.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2638,10 +2620,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2655,18 +2638,35 @@ paths: required: true schema: type: string - - in: path - name: insightsId - required: true + - in: query + name: filter schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 - get: + post: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.folders.locations.insightTypes.insights.get + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.projects.locations.insightTypes.insights.markAccepted + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2681,7 +2681,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2700,13 +2700,13 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: *ref_1 get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.get + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.projects.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2718,10 +2718,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2731,31 +2731,20 @@ paths: schema: type: string - in: path - name: recommendersId - required: true - schema: - type: string - - in: path - name: recommendationsId + name: insightTypesId required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: - parameters: *ref_1 - post: + patch: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markDismissed + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.projects.locations.insightTypes.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2767,10 +2756,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2780,34 +2769,31 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_1 - post: + patch: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markFailed + Updates a Recommender Config. This will create a new revision of the + config. + operationId: recommender.projects.locations.recommenders.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2819,10 +2805,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2836,18 +2822,20 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: updateMask schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: - parameters: *ref_1 + format: google-fieldmask get: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.list + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.projects.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2859,11 +2847,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2877,37 +2864,26 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markClaimed + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.projects.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2922,7 +2898,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2941,25 +2917,23 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markSucceeded + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. + operationId: >- + recommender.projects.locations.recommenders.recommendations.markDismissed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2974,7 +2948,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2993,13 +2967,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 get: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.projects.locations.insightTypes.insights.get + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3011,7 +2985,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path name: projectsId @@ -3024,22 +2999,42 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: path - name: insightsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 - get: + post: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.projects.locations.insightTypes.insights.list + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.markFailed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3051,8 +3046,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: projectsId @@ -3065,39 +3059,22 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: recommendationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: parameters: *ref_1 - post: + get: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.projects.locations.insightTypes.insights.markAccepted - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3109,7 +3086,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: projectsId @@ -3122,27 +3099,33 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: path - name: insightsId + name: recommendationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 - patch: + post: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.projects.locations.insightTypes.updateConfig + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.markClaimed requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3154,7 +3137,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: projectsId @@ -3167,24 +3150,22 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: recommendationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + parameters: *ref_1 get: description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.projects.locations.insightTypes.getConfig + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.folders.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3196,10 +3177,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3213,23 +3195,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 - post: + get: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. - operationId: >- - recommender.projects.locations.recommenders.recommendations.markDismissed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.folders.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3241,10 +3226,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3254,33 +3239,31 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.markClaimed + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.folders.locations.insightTypes.insights.markAccepted requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3292,10 +3275,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3305,22 +3288,22 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.get + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3332,10 +3315,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3349,18 +3333,37 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 - get: + post: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.list + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markClaimed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3372,11 +3375,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3390,20 +3392,12 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: recommendationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 post: description: >- @@ -3415,7 +3409,7 @@ paths: applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.markFailed + operationId: recommender.folders.locations.recommenders.recommendations.markFailed requestBody: content: application/json: @@ -3436,7 +3430,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3455,26 +3449,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: parameters: *ref_1 - post: + get: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.projects.locations.recommenders.recommendations.markSucceeded - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3489,7 +3470,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3508,13 +3489,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 - get: + post: description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.projects.locations.recommenders.getConfig + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markDismissed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3526,10 +3516,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3543,16 +3533,30 @@ paths: required: true schema: type: string - patch: + - in: path + name: recommendationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + parameters: *ref_1 + post: description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.projects.locations.recommenders.updateConfig + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3564,10 +3568,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3581,12 +3585,8 @@ paths: required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: updateMask + - in: path + name: recommendationsId + required: true schema: type: string - format: google-fieldmask diff --git a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml b/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml index b1a306e3..e27ba9a2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml @@ -37,46 +37,146 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudResourcesettingsV1ValueStringSet: + GoogleCloudResourcesettingsV1SettingMetadata: + id: GoogleCloudResourcesettingsV1SettingMetadata + description: Metadata about a setting which is not editable by the end user. properties: - values: + displayName: + type: string + description: The human readable name for this setting. + defaultValue: + description: >- + The value provided by Setting.effective_value if no setting value is + explicitly set. Note: not all settings have a default value. + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' + readOnly: + type: boolean + description: >- + A flag indicating that values of this setting cannot be modified. + See documentation for the specific setting for updates and reasons. + description: + type: string + description: A detailed description of what this setting does. + dataType: + enum: + - DATA_TYPE_UNSPECIFIED + - BOOLEAN + - STRING + - STRING_SET + - ENUM_VALUE + - DURATION_VALUE + - STRING_MAP + description: The data type for this setting. + type: string + enumDescriptions: + - Unspecified data type. + - A boolean setting. + - A string setting. + - A string set setting. + - A Enum setting + - A Duration setting + - A string->string map setting + type: object + GoogleCloudResourcesettingsV1ValueEnumValue: + properties: + value: + type: string + description: The value of this enum + id: GoogleCloudResourcesettingsV1ValueEnumValue + type: object + description: >- + A enum value that can hold any enum type setting values. Each enum type + is represented by a number, this representation is stored in the + definitions. + GoogleCloudResourcesettingsV1ListSettingsResponse: + type: object + description: The response from ListSettings. + id: GoogleCloudResourcesettingsV1ListSettingsResponse + properties: + nextPageToken: + description: Unused. A page token used to retrieve the next page. + type: string + settings: + description: >- + A list of settings that are available at the specified Cloud + resource. type: array - description: The strings in the set items: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' + GoogleCloudResourcesettingsV1ValueStringMap: + id: GoogleCloudResourcesettingsV1ValueStringMap + properties: + mappings: + additionalProperties: type: string + description: The key-value pairs in the map + type: object + description: >- + A string->string map value that can hold a map of string keys to string + values. The maximum length of each string is 200 characters and there + can be a maximum of 50 key-value pairs in the map. + type: object + GoogleCloudResourcesettingsV1ValueStringSet: type: object - id: GoogleCloudResourcesettingsV1ValueStringSet description: >- A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set. + properties: + values: + description: The strings in the set + type: array + items: + type: string + id: GoogleCloudResourcesettingsV1ValueStringSet GoogleCloudResourcesettingsV1Value: + description: The data in a setting value. + type: object + id: GoogleCloudResourcesettingsV1Value properties: + stringMapValue: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringMap' + description: Defines this value as being a StringMap. enumValue: description: Defines this value as being a Enum. $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueEnumValue' + stringSetValue: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' + description: Defines this value as being a StringSet. stringValue: - type: string description: Defines this value as being a string value. - stringMapValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringMap' - description: Defines this value as being a StringMap. + type: string booleanValue: type: boolean description: Defines this value as being a boolean value. - stringSetValue: - description: Defines this value as being a StringSet. - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' durationValue: - description: Defines this value as being a Duration. type: string format: google-duration - id: GoogleCloudResourcesettingsV1Value - type: object - description: The data in a setting value. + description: Defines this value as being a Duration. GoogleCloudResourcesettingsV1Setting: + type: object + description: The schema for settings. + id: GoogleCloudResourcesettingsV1Setting properties: + localValue: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' + description: >- + The configured value of the setting at the given parent resource, + ignoring the resource hierarchy. The data type of Value must always + be consistent with the data type defined in Setting.metadata. + etag: + type: string + description: >- + A fingerprint used for optimistic concurrency. See UpdateSetting for + more details. + metadata: + description: >- + Output only. Metadata about a setting which is not editable by the + end user. + readOnly: true + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1SettingMetadata' effectiveValue: + readOnly: true description: >- Output only. The effective value of the setting at the given parent resource, evaluated based on the resource hierarchy The effective @@ -90,19 +190,6 @@ components: `Value` with all fields unset. The data type of Value must always be consistent with the data type defined in Setting.metadata. $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - readOnly: true - localValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - description: >- - The configured value of the setting at the given parent resource, - ignoring the resource hierarchy. The data type of Value must always - be consistent with the data type defined in Setting.metadata. - metadata: - readOnly: true - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1SettingMetadata' - description: >- - Output only. Metadata about a setting which is not editable by the - end user. name: type: string description: >- @@ -111,104 +198,11 @@ components: `folders/{folder_id}/settings/{setting_name}` * `organizations/{organization_id}/settings/{setting_name}` For example, "/projects/123/settings/gcp-enableMyFeature" - etag: - description: >- - A fingerprint used for optimistic concurrency. See UpdateSetting for - more details. - type: string - id: GoogleCloudResourcesettingsV1Setting - description: The schema for settings. - type: object - GoogleCloudResourcesettingsV1ValueStringMap: - type: object - id: GoogleCloudResourcesettingsV1ValueStringMap - properties: - mappings: - description: The key-value pairs in the map - additionalProperties: - type: string - type: object - description: >- - A string->string map value that can hold a map of string keys to string - values. The maximum length of each string is 200 characters and there - can be a maximum of 50 key-value pairs in the map. - GoogleCloudResourcesettingsV1SettingMetadata: - properties: - description: - description: A detailed description of what this setting does. - type: string - readOnly: - type: boolean - description: >- - A flag indicating that values of this setting cannot be modified. - See documentation for the specific setting for updates and reasons. - defaultValue: - description: >- - The value provided by Setting.effective_value if no setting value is - explicitly set. Note: not all settings have a default value. - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - displayName: - type: string - description: The human readable name for this setting. - dataType: - enumDescriptions: - - Unspecified data type. - - A boolean setting. - - A string setting. - - A string set setting. - - A Enum setting - - A Duration setting - - A string->string map setting - description: The data type for this setting. - enum: - - DATA_TYPE_UNSPECIFIED - - BOOLEAN - - STRING - - STRING_SET - - ENUM_VALUE - - DURATION_VALUE - - STRING_MAP - type: string - id: GoogleCloudResourcesettingsV1SettingMetadata - type: object - description: Metadata about a setting which is not editable by the end user. - GoogleCloudResourcesettingsV1ListSettingsResponse: - description: The response from ListSettings. - id: GoogleCloudResourcesettingsV1ListSettingsResponse - properties: - nextPageToken: - type: string - description: Unused. A page token used to retrieve the next page. - settings: - items: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - type: array - description: >- - A list of settings that are available at the specified Cloud - resource. - type: object - GoogleCloudResourcesettingsV1ValueEnumValue: - id: GoogleCloudResourcesettingsV1ValueEnumValue - description: >- - A enum value that can hold any enum type setting values. Each enum type - is represented by a number, this representation is stored in the - definitions. - type: object - properties: - value: - type: string - description: The value of this enum parameters: - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string prettyPrint: @@ -217,16 +211,32 @@ components: name: prettyPrint schema: type: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto callback: description: JSONP in: query name: callback schema: type: string - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token schema: type: string uploadType: @@ -235,16 +245,21 @@ components: name: uploadType schema: type: string - alt: - description: Data format for response. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: alt + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string - enum: - - json - - media - - proto _.xgafv: description: V1 error format. in: query @@ -254,28 +269,13 @@ components: enum: - '1' - '2' - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - 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. - in: query - name: key - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + 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. in: query - name: quotaUser + name: key schema: type: string x-stackQL-resources: @@ -284,21 +284,9 @@ components: name: settings title: Settings methods: - projects_settings_get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_settings_patch: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_settings_list: + folders_settings_list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings/get' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings/get' response: mediaType: application/json openAPIDocKey: '200' @@ -315,16 +303,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_settings_list: + projects_settings_get: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.settings - organizations_settings_list: + projects_settings_patch: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1settings/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_settings_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings/get' response: mediaType: application/json openAPIDocKey: '200' @@ -343,49 +336,95 @@ components: response: mediaType: application/json openAPIDocKey: '200' + organizations_settings_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1settings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.settings sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_get - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_get - $ref: >- - #/components/x-stackQL-resources/settings/methods/organizations_settings_get + #/components/x-stackQL-resources/settings/methods/projects_settings_get - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_list + #/components/x-stackQL-resources/settings/methods/organizations_settings_get - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_list + - $ref: >- + #/components/x-stackQL-resources/settings/methods/projects_settings_list - $ref: >- #/components/x-stackQL-resources/settings/methods/organizations_settings_list insert: [] update: - - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_patch - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_patch + - $ref: >- + #/components/x-stackQL-resources/settings/methods/projects_settings_patch - $ref: >- #/components/x-stackQL-resources/settings/methods/organizations_settings_patch replace: [] delete: [] paths: - /v1/projects/{projectsId}/settings/{settingsId}: + /v1/folders/{foldersId}/settings: parameters: &ref_1 - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' + get: + description: >- + Lists all the settings that are available on the Cloud resource + `parent`. + operationId: resourcesettings.folders.settings.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/folders/{foldersId}/settings/{settingsId}: + parameters: *ref_1 get: description: >- Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.projects.settings.get + operationId: resourcesettings.folders.settings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -400,7 +439,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -424,7 +463,7 @@ paths: will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.projects.settings.patch + operationId: resourcesettings.folders.settings.patch requestBody: content: application/json: @@ -444,7 +483,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -453,52 +492,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/settings: - parameters: *ref_1 - get: - description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.projects.settings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/folders/{foldersId}/settings/{settingsId}: + /v1/projects/{projectsId}/settings/{settingsId}: parameters: *ref_1 get: description: >- Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.folders.settings.get + operationId: resourcesettings.projects.settings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -513,7 +513,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -537,7 +537,7 @@ paths: will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.folders.settings.patch + operationId: resourcesettings.projects.settings.patch requestBody: content: application/json: @@ -557,7 +557,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -566,13 +566,13 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/settings: + /v1/projects/{projectsId}/settings: parameters: *ref_1 get: description: >- Lists all the settings that are available on the Cloud resource `parent`. - operationId: resourcesettings.folders.settings.list + operationId: resourcesettings.projects.settings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -588,62 +588,23 @@ paths: #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: view schema: type: string - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/settings: - parameters: *ref_1 - get: - description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.organizations.settings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: view + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 /v1/organizations/{organizationsId}/settings/{settingsId}: parameters: *ref_1 get: @@ -718,3 +679,42 @@ paths: required: true schema: type: string + /v1/organizations/{organizationsId}/settings: + parameters: *ref_1 + get: + description: >- + Lists all the settings that are available on the Cloud resource + `parent`. + operationId: resourcesettings.organizations.settings.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: view + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/run.yaml b/providers/src/googleapis.com/v00.00.00000/services/run.yaml index 07944dc1..c22c1fa9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/run.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/run.yaml @@ -11,7 +11,7 @@ info: Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/. version: v2 - x-discovery-doc-revision: '20240906' + x-discovery-doc-revision: '20240916' x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/run/ @@ -3006,6 +3006,17 @@ components: based on the percent of traffic they are receiving. (BETA) type: integer format: int32 + scalingMode: + description: Optional. The scaling mode for the service. + type: string + enumDescriptions: + - Unspecified. + - Scale based on traffic between min and max instances. + - Scale to exactly min instances and ignore max instances. + enum: + - SCALING_MODE_UNSPECIFIED + - AUTOMATIC + - MANUAL GoogleCloudRunV2TrafficTargetStatus: id: GoogleCloudRunV2TrafficTargetStatus description: Represents the observed state of a single `TrafficTarget` entry. diff --git a/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml b/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml index dd81bb37..a6f9522c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml @@ -35,142 +35,228 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalUpdateSignedDeviceRequest: - description: Request for UpdateSignedDevice. - type: object - id: SasPortalUpdateSignedDeviceRequest + SasPortalDeviceConfig: + description: Information about the device configuration. + id: SasPortalDeviceConfig properties: - encodedDevice: - description: >- - Required. The JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. + updateTime: type: string - format: byte - installerId: - description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. + description: Output only. The last time the device configuration was edited. + format: google-datetime + model: + description: Information about this device model. + $ref: '#/components/schemas/SasPortalDeviceModel' + callSign: + description: The call sign of the device operator. type: string - SasPortalInstallationParams: - properties: - heightType: + measurementCapabilities: + items: + enum: + - MEASUREMENT_CAPABILITY_UNSPECIFIED + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + type: string + enumDescriptions: + - '' + - '' + - '' + description: Measurement reporting capabilities of the device. + type: array + state: type: string - description: Specifies how the height is measured. + enum: + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL enumDescriptions: - - Unspecified height type. - - AGL height is measured relative to the ground level. - - AMSL height is measured relative to the mean sea level. + - '' + - '' + - '' + description: State of the configuration. + airInterface: + $ref: '#/components/schemas/SasPortalDeviceAirInterface' + description: Information about this device's air interface. + installationParams: + $ref: '#/components/schemas/SasPortalInstallationParams' + description: Installation parameters for the device. + userId: + type: string + description: The identifier of a device user. + isSigned: + type: boolean + description: Output only. Whether the configuration has been signed by a CPI. + category: + description: FCC category of the device. + enumDescriptions: + - Unspecified device category. + - Category A. + - Category B. enum: - - HEIGHT_TYPE_UNSPECIFIED - - HEIGHT_TYPE_AGL - - HEIGHT_TYPE_AMSL - verticalAccuracy: - format: double - type: number - description: >- - A positive number in meters to indicate accuracy of the device - antenna vertical location. This optional parameter should only be - present if its value is less than the FCC requirement of 3 meters. - antennaDowntilt: - description: >- - Antenna downtilt in degrees and is an integer with a value between - -90 and +90 inclusive; a negative value means the antenna is tilted - up (above horizontal). This parameter is optional for Category A - devices and conditional for Category B devices. - format: int32 - type: integer - longitude: - description: >- - Longitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -180.000000 to +180.000000. - Positive values represent longitudes east of the prime meridian; - negative values west of the prime meridian. - format: double - type: number - eirpCapability: - type: integer - format: int32 - description: >- - This parameter is the maximum device EIRP in units of dBm/10MHz and - is an integer with a value between -127 and +47 (dBm/10 MHz) - inclusive. If not included, SAS interprets it as maximum allowable - EIRP in units of dBm/10MHz for device category. - antennaModel: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B + type: string + type: object + SasPortalDevice: + type: object + id: SasPortalDevice + properties: + grants: + items: + $ref: '#/components/schemas/SasPortalDeviceGrant' + description: Output only. Grants held by the device. + type: array + displayName: + type: string + description: Device display name. + currentChannels: + readOnly: true + deprecated: true + items: + $ref: '#/components/schemas/SasPortalChannelWithScore' + description: Output only. Current channels with scores. + type: array + preloadedConfig: + $ref: '#/components/schemas/SasPortalDeviceConfig' + description: Configuration of the device, as specified via SAS Portal API. + fccId: type: string description: >- - If an external antenna is used, the antenna model is optionally - provided in this field. The string has a maximum length of 128 - octets. - height: + The FCC identifier of the device. Refer to + https://www.fcc.gov/oet/ea/fccid for FccID format. Accept + underscores and periods because some test-SAS customers use them. + deviceMetadata: description: >- - Device antenna height in meters. When the `heightType` parameter - value is "AGL", the antenna height should be given relative to - ground level. When the `heightType` parameter value is "AMSL", it is - given with respect to WGS84 datum. - format: double - type: number - antennaBeamwidth: - format: int32 - type: integer + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + $ref: '#/components/schemas/SasPortalDeviceMetadata' + activeConfig: + $ref: '#/components/schemas/SasPortalDeviceConfig' description: >- - 3-dB antenna beamwidth of the antenna in the horizontal-plane in - degrees. This parameter is an unsigned integer having a value - between 0 and 360 (degrees) inclusive; it is optional for Category A - devices and conditional for Category B devices. - cpeCbsdIndication: - type: boolean + Output only. Current configuration of the device as registered to + the SAS. + name: + description: Output only. The resource path name. + type: string + grantRangeAllowlists: + items: + $ref: '#/components/schemas/SasPortalFrequencyRange' description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - antennaAzimuth: + Only ranges that are within the allowlists are available for new + grants. + type: array + serialNumber: + type: string + description: A serial number assigned to the device by the device manufacturer. + state: + description: Output only. Device state. + enumDescriptions: + - Unspecified state. + - >- + Device created in the SAS Portal, however, not yet registered with + SAS. + - Device registered with SAS. + - Device de-registered with SAS. + enum: + - DEVICE_STATE_UNSPECIFIED + - RESERVED + - REGISTERED + - DEREGISTERED + type: string + SasPortalDeploymentAssociation: + type: object + id: SasPortalDeploymentAssociation + properties: + gcpProjectId: + description: GCP project id of the associated project. + type: string + userId: + type: string + description: User id of the deployment. + description: Association between a gcp project and a SAS user id. + SasPortalValidateInstallerRequest: + id: SasPortalValidateInstallerRequest + properties: + secret: + type: string + description: Required. Secret returned by the GenerateSecret. + installerId: + type: string description: >- - Boresight direction of the horizontal plane of the antenna in - degrees with respect to true north. The value of this parameter is - an integer with a value between 0 and 359 inclusive. A value of 0 - degrees means true north; a value of 90 degrees means east. This - parameter is optional for Category A devices and conditional for - Category B devices. - type: integer - format: int32 - latitude: - type: number + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + encodedSecret: + type: string description: >- - Latitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -90.000000 to +90.000000. - Positive values represent latitudes north of the equator; negative - values south of the equator. - format: double - horizontalAccuracy: - format: double - type: number + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. + type: object + description: Request for ValidateInstaller. + SasPortalOrganization: + id: SasPortalOrganization + description: Organization details. + properties: + displayName: + type: string + description: Name of organization + id: + description: Id of organization + type: string + format: int64 + type: object + SasPortalUpdateSignedDeviceRequest: + description: Request for UpdateSignedDevice. + properties: + installerId: description: >- - A positive number in meters to indicate accuracy of the device - antenna horizontal location. This optional parameter should only be - present if its value is less than the FCC requirement of 50 meters. - indoorDeployment: + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. + type: string + encodedDevice: description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. - type: boolean - antennaGain: + Required. The JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + type: string + format: byte + id: SasPortalUpdateSignedDeviceRequest + type: object + SasPortalTestPermissionsResponse: + type: object + properties: + permissions: + type: array + items: + type: string + description: A set of permissions that the caller is allowed. + description: Response message for `TestPermissions` method. + id: SasPortalTestPermissionsResponse + SasPortalPolicy: + id: SasPortalPolicy + properties: + etag: description: >- - Peak antenna gain in dBi. This parameter is a double with a value - between -127 and +128 (dBi) inclusive. Part of Release 2 to support - floating-point value - format: double - type: number - id: SasPortalInstallationParams - description: Information about the device installation parameters. + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the etag in + the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An etag is returned in the response to + GetPolicy, and systems are expected to put that etag in the request + to SetPolicy to ensure that their change will be applied to the same + version of the policy. If no etag is provided in the call to + GetPolicy, then the existing policy is overwritten blindly. + format: byte + type: string + assignments: + description: List of assignments + type: array + items: + $ref: '#/components/schemas/SasPortalAssignment' type: object + description: Defines an access control policy to the resources. SasPortalDeviceAirInterface: - id: SasPortalDeviceAirInterface properties: radioTechnology: - type: string - description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. enum: - RADIO_TECHNOLOGY_UNSPECIFIED - E_UTRA @@ -182,6 +268,7 @@ components: - REDLINE - TARANA_WIRELESS - FAROS + type: string enumDescriptions: - '' - '' @@ -193,231 +280,85 @@ components: - '' - '' - '' + description: >- + Conditional. This field specifies the radio access technology that + is used for the CBSD. supportedSpec: description: >- Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. type: string - type: object description: Information about the device's air interface. - SasPortalSignDeviceRequest: - type: object - description: Request for SignDevice. - properties: - device: - $ref: '#/components/schemas/SasPortalDevice' - description: >- - Required. The device to sign. The device fields name, fcc_id and - serial_number must be set. The user_id field must be set. - id: SasPortalSignDeviceRequest - SasPortalProvisionDeploymentResponse: - description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. - type: object - properties: - errorMessage: - type: string - description: >- - Optional. Optional error message if the provisioning request is not - successful. - id: SasPortalProvisionDeploymentResponse - SasPortalProvisionDeploymentRequest: - type: object - description: >- - Request for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP - Project, Organization Info, and caller’s GAIA ID should be retrieved - from the RPC handler, and used as inputs to create a new SAS - organization (if not exists) and a new SAS deployment. - id: SasPortalProvisionDeploymentRequest - properties: - organizationId: - description: >- - Optional. If this field is set then a new deployment will be created - under the organization specified by this id. - format: int64 - type: string - newOrganizationDisplayName: - type: string - description: >- - Optional. If this field is set, and a new SAS Portal Organization - needs to be created, its display name will be set to the value of - this field. - newDeploymentDisplayName: - description: >- - Optional. If this field is set, and a new SAS Portal Deployment - needs to be created, its display name will be set to the value of - this field. - type: string - SasPortalFrequencyRange: - type: object - properties: - lowFrequencyMhz: - format: double - type: number - description: The lowest frequency of the frequency range in MHz. - highFrequencyMhz: - description: The highest frequency of the frequency range in MHz. - format: double - type: number - description: Frequency range from `low_frequency` to `high_frequency`. - id: SasPortalFrequencyRange - SasPortalMoveDeploymentRequest: - properties: - destination: - type: string - description: >- - Required. The name of the new parent resource node or customer to - reparent the deployment under. - type: object - description: Request for MoveDeployment. - id: SasPortalMoveDeploymentRequest - SasPortalDeviceMetadata: - properties: - nrqzValidation: - description: Output only. National Radio Quiet Zone validation info. - readOnly: true - $ref: '#/components/schemas/SasPortalNrqzValidation' - interferenceCoordinationGroup: - type: string - description: >- - Interference Coordination Group (ICG). A group of CBSDs that manage - their own interference with the group. For more details, see - [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - commonChannelGroup: - type: string - description: >- - Common Channel Group (CCG). A group of CBSDs in the same ICG - requesting a common primary channel assignment. For more details, - see [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - nrqzValidated: - readOnly: true - description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. - type: boolean - deprecated: true - antennaModel: - description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` - type: string - id: SasPortalDeviceMetadata - description: Device data overridable by both SAS Portal and registration requests. + id: SasPortalDeviceAirInterface type: object - SasPortalNrqzValidation: - properties: - caseId: - type: string - description: Validation case ID. - latitude: - type: number - format: double - description: Device latitude that's associated with the validation. - state: - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. - description: State of the NRQZ validation info. - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - type: string - cpiId: - type: string - description: CPI who signed the validation. - longitude: - description: Device longitude that's associated with the validation. - format: double - type: number - id: SasPortalNrqzValidation - description: Information about National Radio Quiet Zone validation. + SasPortalDpaMoveList: type: object - SasPortalMoveDeviceRequest: + description: An entry in a DPA's move list. properties: - destination: - description: >- - Required. The name of the new parent resource node or customer to - reparent the device under. + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The frequency range that the move list affects. + dpaId: type: string - type: object - description: Request for MoveDevice. - id: SasPortalMoveDeviceRequest - SasPortalDevice: + description: The ID of the DPA. + id: SasPortalDpaMoveList + SasPortalNode: properties: - grants: - items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - description: Output only. Grants held by the device. + sasUserIds: type: array - deviceMetadata: - $ref: '#/components/schemas/SasPortalDeviceMetadata' - description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - activeConfig: - $ref: '#/components/schemas/SasPortalDeviceConfig' - description: >- - Output only. Current configuration of the device as registered to - the SAS. - fccId: - description: >- - The FCC identifier of the device. Refer to - https://www.fcc.gov/oet/ea/fccid for FccID format. Accept - underscores and periods because some test-SAS customers use them. - type: string - preloadedConfig: - description: Configuration of the device, as specified via SAS Portal API. - $ref: '#/components/schemas/SasPortalDeviceConfig' - serialNumber: - description: A serial number assigned to the device by the device manufacturer. + description: User ids used by the devices belonging to this node. + items: + type: string + displayName: type: string + description: The node's display name. name: - description: Output only. The resource path name. type: string - currentChannels: - deprecated: true - items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - readOnly: true + description: Output only. Resource name. + type: object + id: SasPortalNode + description: The Node. + SasPortalListDeploymentsResponse: + description: Response for ListDeployments. + id: SasPortalListDeploymentsResponse + properties: + deployments: type: array - description: Output only. Current channels with scores. - grantRangeAllowlists: + description: The deployments that match the request. items: - $ref: '#/components/schemas/SasPortalFrequencyRange' - type: array - description: >- - Only ranges that are within the allowlists are available for new - grants. - displayName: - description: Device display name. + $ref: '#/components/schemas/SasPortalDeployment' + nextPageToken: type: string - state: + description: >- + A pagination token returned from a previous call to ListDeployments + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more deployments. + type: object + SasPortalMigrateOrganizationMetadata: + properties: + operationState: + readOnly: true + description: Output only. Current operation state type: string - enumDescriptions: - - Unspecified state. - - >- - Device created in the SAS Portal, however, not yet registered with - SAS. - - Device registered with SAS. - - Device de-registered with SAS. enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED - description: Output only. Device state. - id: SasPortalDevice + - OPERATION_STATE_UNSPECIFIED + - OPERATION_STATE_PENDING + - OPERATION_STATE_RUNNING + - OPERATION_STATE_SUCCEEDED + - OPERATION_STATE_FAILED + enumDescriptions: + - Unspecified. + - Pending (Not started). + - In-progress. + - Done successfully. + - Done with errors. + id: SasPortalMigrateOrganizationMetadata type: object + description: >- + Long-running operation metadata message returned by the + MigrateOrganization. SasPortalListLegacyOrganizationsResponse: - type: object - id: SasPortalListLegacyOrganizationsResponse description: >- Response for [ListLegacyOrganizations]. [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. @@ -425,365 +366,344 @@ components: organizations: items: $ref: '#/components/schemas/SasPortalOrganization' - type: array description: Optional. Legacy SAS organizations. - SasPortalStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + type: array type: object + id: SasPortalListLegacyOrganizationsResponse + SasPortalMoveDeploymentRequest: properties: - message: + destination: type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - details: - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - id: SasPortalStatus - SasPortalValidateInstallerRequest: + Required. The name of the new parent resource node or customer to + reparent the deployment under. + type: object + id: SasPortalMoveDeploymentRequest + description: Request for MoveDeployment. + SasPortalDeviceMetadata: + description: Device data overridable by both SAS Portal and registration requests. + id: SasPortalDeviceMetadata type: object properties: - installerId: + nrqzValidation: + $ref: '#/components/schemas/SasPortalNrqzValidation' + description: Output only. National Radio Quiet Zone validation info. + readOnly: true + antennaModel: type: string description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - encodedSecret: + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` + nrqzValidated: + readOnly: true description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must include a "secret" claim whose value is the secret. - type: string - secret: + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + type: boolean + deprecated: true + commonChannelGroup: + description: >- + Common Channel Group (CCG). A group of CBSDs in the same ICG + requesting a common primary channel assignment. For more details, + see [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). type: string - description: Required. Secret returned by the GenerateSecret. - description: Request for ValidateInstaller. - id: SasPortalValidateInstallerRequest - SasPortalDpaMoveList: - type: object - description: An entry in a DPA's move list. - id: SasPortalDpaMoveList - properties: - dpaId: + interferenceCoordinationGroup: type: string - description: The ID of the DPA. - frequencyRange: - description: The frequency range that the move list affects. - $ref: '#/components/schemas/SasPortalFrequencyRange' - SasPortalTestPermissionsResponse: + description: >- + Interference Coordination Group (ICG). A group of CBSDs that manage + their own interference with the group. For more details, see + [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + SasPortalAssignment: + description: Associates `members` with a `role`. properties: - permissions: - type: array - description: A set of permissions that the caller is allowed. + members: + description: >- + The identities the role is assigned to. It can have the following + values: * `{user_email}`: An email address that represents a + specific Google account. For example: `alice@gmail.com`. * + `{group_email}`: An email address that represents a Google group. + For example, `viewers@gmail.com`. items: type: string - id: SasPortalTestPermissionsResponse - description: Response message for `TestPermissions` method. + type: array + role: + type: string + description: Required. Role that is assigned to `members`. type: object - SasPortalListGcpProjectDeploymentsResponse: + id: SasPortalAssignment + SasPortalValidateInstallerResponse: type: object - properties: - deployments: - type: array - description: Optional. Deployments associated with the GCP project - items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' - id: SasPortalListGcpProjectDeploymentsResponse - description: Response for [ListGcpProjectDeployments]. - SasPortalSetPolicyRequest: + properties: {} + description: Response for ValidateInstaller. + id: SasPortalValidateInstallerResponse + SasPortalDeployment: type: object + id: SasPortalDeployment properties: - disableNotification: - type: boolean - description: >- - Optional. Set the field as `true` to disable the onboarding - notification. - policy: - description: Required. The policy to be applied to the `resource`. - $ref: '#/components/schemas/SasPortalPolicy' - resource: + frns: + items: + type: string + readOnly: true description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. + type: array + name: + description: Output only. Resource name. + readOnly: true type: string - id: SasPortalSetPolicyRequest - description: Request message for `SetPolicy` method. - SasPortalMigrateOrganizationResponse: - type: object - properties: - deploymentAssociation: - description: >- - Optional. A list of deployment association that were created for the - migration, or current associations if they already exist. + displayName: + type: string + description: The deployment's display name. + sasUserIds: type: array items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' - description: >- - Response for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. - id: SasPortalMigrateOrganizationResponse + type: string + description: >- + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + description: The Deployment. SasPortalListCustomersResponse: description: Response for `ListCustomers`. + type: object + id: SasPortalListCustomersResponse properties: - customers: - items: - $ref: '#/components/schemas/SasPortalCustomer' - type: array - description: The list of customers that match the request. nextPageToken: description: >- A pagination token returned from a previous call to ListCustomers that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers. type: string + customers: + description: The list of customers that match the request. + items: + $ref: '#/components/schemas/SasPortalCustomer' + type: array + SasPortalMigrateOrganizationRequest: type: object - id: SasPortalListCustomersResponse - SasPortalDeviceGrant: - id: SasPortalDeviceGrant + properties: + organizationId: + format: int64 + description: Required. Id of the SAS organization to be migrated. + type: string + description: >- + Request for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP + Project, Organization Info, and caller's GAIA ID should be retrieved + from the RPC handler, and used to check authorization on SAS Portal + organization and to create GCP Projects. + id: SasPortalMigrateOrganizationRequest + SasPortalListNodesResponse: + id: SasPortalListNodesResponse type: object properties: - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The transmission frequency range. - expireTime: - description: The expiration time of the grant. - format: google-datetime + nextPageToken: type: string - moveList: - type: array - description: The DPA move lists on which this grant appears. + description: >- + A pagination token returned from a previous call to ListNodes that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more nodes. + nodes: + description: The nodes that match the request. items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - channelType: - enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL - description: Type of channel used. + $ref: '#/components/schemas/SasPortalNode' + type: array + description: Response for ListNodes. + SasPortalMoveNodeRequest: + properties: + destination: + description: >- + Required. The name of the new parent resource node or customer to + reparent the node under. + type: string + type: object + description: Request for MoveNode. + id: SasPortalMoveNodeRequest + SasPortalProvisionDeploymentRequest: + type: object + id: SasPortalProvisionDeploymentRequest + description: >- + Request for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP + Project, Organization Info, and caller’s GAIA ID should be retrieved + from the RPC handler, and used as inputs to create a new SAS + organization (if not exists) and a new SAS deployment. + properties: + newDeploymentDisplayName: type: string - enumDescriptions: - - '' - - '' - - '' - maxEirp: - format: double description: >- - Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by - the grant. The maximum EIRP is in units of dBm/MHz. The value of - `maxEirp` represents the average (RMS) EIRP that would be measured - by the procedure defined in FCC part 96.41(e)(3). - type: number - lastHeartbeatTransmitExpireTime: - description: The transmit expiration time of the last heartbeat. + Optional. If this field is set, and a new SAS Portal Deployment + needs to be created, its display name will be set to the value of + this field. + organizationId: + format: int64 type: string - format: google-datetime - grantId: + description: >- + Optional. If this field is set then a new deployment will be created + under the organization specified by this id. + newOrganizationDisplayName: + description: >- + Optional. If this field is set, and a new SAS Portal Organization + needs to be created, its display name will be set to the value of + this field. type: string - description: Grant Id. - suspensionReason: - items: - type: string - type: array - description: If the grant is suspended, the reason(s) for suspension. - state: - description: State of the grant. - enumDescriptions: - - '' - - >- - The grant has been granted but the device is not heartbeating on - it. - - The grant has been terminated by the SAS. - - The grant has been suspended by the SAS. - - The device is currently transmitting. - - The grant has expired. - enum: - - GRANT_STATE_UNSPECIFIED - - GRANT_STATE_GRANTED - - GRANT_STATE_TERMINATED - - GRANT_STATE_SUSPENDED - - GRANT_STATE_AUTHORIZED - - GRANT_STATE_EXPIRED + SasPortalSetupSasAnalyticsRequest: + properties: + userId: + description: >- + Optional. User id to setup analytics for, if not provided the user + id associated with the project is used. optional type: string - description: >- - Device grant. It is an authorization provided by the Spectrum Access - System to a device to transmit using specified operating parameters - after a successful heartbeat by the device. - SasPortalSetupSasAnalyticsResponse: - id: SasPortalSetupSasAnalyticsResponse type: object - description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. - properties: {} + description: Request for the SetupSasAnalytics rpc. + id: SasPortalSetupSasAnalyticsRequest SasPortalEmpty: + properties: {} 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); } - type: object id: SasPortalEmpty - properties: {} - SasPortalSetupSasAnalyticsMetadata: - description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. - id: SasPortalSetupSasAnalyticsMetadata type: object - properties: {} - SasPortalMoveNodeRequest: - id: SasPortalMoveNodeRequest + SasPortalGenerateSecretResponse: + id: SasPortalGenerateSecretResponse properties: - destination: + secret: type: string + description: The secret generated by the string and used by ValidateInstaller. + type: object + description: Response for GenerateSecret. + SasPortalProvisionDeploymentResponse: + id: SasPortalProvisionDeploymentResponse + description: >- + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. + type: object + properties: + errorMessage: description: >- - Required. The name of the new parent resource node or customer to - reparent the node under. - description: Request for MoveNode. + Optional. Optional error message if the provisioning request is not + successful. + type: string + SasPortalListGcpProjectDeploymentsResponse: + description: Response for [ListGcpProjectDeployments]. + id: SasPortalListGcpProjectDeploymentsResponse type: object - SasPortalDeploymentAssociation: + properties: + deployments: + description: Optional. Deployments associated with the GCP project + items: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + type: array + SasPortalDeviceModel: + id: SasPortalDeviceModel + description: Information about the model of the device. + properties: + firmwareVersion: + description: The firmware version of the device. + type: string + hardwareVersion: + type: string + description: The hardware version of the device. + name: + description: The name of the device model. + type: string + softwareVersion: + type: string + description: The software version of the device. + vendor: + description: The name of the device vendor. + type: string type: object + SasPortalCreateSignedDeviceRequest: properties: - userId: - description: User id of the deployment. + installerId: type: string - gcpProjectId: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + encodedDevice: + format: byte type: string - description: GCP project id of the associated project. - id: SasPortalDeploymentAssociation - description: Association between a gcp project and a SAS user id. - SasPortalOrganization: - description: Organization details. + description: >- + Required. JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + id: SasPortalCreateSignedDeviceRequest type: object - id: SasPortalOrganization + description: Request for CreateSignedDevice. + SasPortalFrequencyRange: + properties: + lowFrequencyMhz: + description: The lowest frequency of the frequency range in MHz. + format: double + type: number + highFrequencyMhz: + format: double + description: The highest frequency of the frequency range in MHz. + type: number + id: SasPortalFrequencyRange + type: object + description: Frequency range from `low_frequency` to `high_frequency`. + SasPortalStatus: properties: - displayName: - description: Name of organization - type: string - id: + message: type: string - description: Id of organization - format: int64 - SasPortalPolicy: - properties: - etag: description: >- - The etag is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the etag in - the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An etag is returned in the response to - GetPolicy, and systems are expected to put that etag in the request - to SetPolicy to ensure that their change will be applied to the same - version of the policy. If no etag is provided in the call to - GetPolicy, then the existing policy is overwritten blindly. - format: byte - type: string - assignments: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. items: - $ref: '#/components/schemas/SasPortalAssignment' - description: List of assignments - id: SasPortalPolicy - description: Defines an access control policy to the resources. - type: object - SasPortalDeviceConfig: - id: SasPortalDeviceConfig - description: Information about the device configuration. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + id: SasPortalStatus type: object + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + SasPortalCustomer: + id: SasPortalCustomer properties: - installationParams: - $ref: '#/components/schemas/SasPortalInstallationParams' - description: Installation parameters for the device. - measurementCapabilities: - type: array - description: Measurement reporting capabilities of the device. + sasUserIds: items: - enum: - - MEASUREMENT_CAPABILITY_UNSPECIFIED - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT type: string - enumDescriptions: - - '' - - '' - - '' - callSign: - description: The call sign of the device operator. - type: string - airInterface: - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - description: Information about this device's air interface. - updateTime: - format: google-datetime - type: string - description: Output only. The last time the device configuration was edited. - userId: - type: string - description: The identifier of a device user. - state: - description: State of the configuration. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL - model: - $ref: '#/components/schemas/SasPortalDeviceModel' - description: Information about this device model. - isSigned: - description: Output only. Whether the configuration has been signed by a CPI. - type: boolean - category: + description: User IDs used by the devices belonging to this customer. + type: array + name: + description: Output only. Resource name of the customer. type: string - description: FCC category of the device. - enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B - enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. - SasPortalMigrateOrganizationRequest: - properties: - organizationId: - format: int64 - description: Required. Id of the SAS organization to be migrated. + displayName: type: string - description: >- - Request for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP - Project, Organization Info, and caller's GAIA ID should be retrieved - from the RPC handler, and used to check authorization on SAS Portal - organization and to create GCP Projects. + description: >- + Required. Name of the organization that the customer entity + represents. + description: Entity representing a SAS customer. type: object - id: SasPortalMigrateOrganizationRequest + SasPortalGenerateSecretRequest: + description: Request for GenerateSecret. + type: object + id: SasPortalGenerateSecretRequest + properties: {} SasPortalListDevicesResponse: - description: Response for ListDevices. - id: SasPortalListDevicesResponse properties: devices: description: The devices that match the request. @@ -796,305 +716,397 @@ components: A pagination token returned from a previous call to ListDevices that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices. + id: SasPortalListDevicesResponse + description: Response for ListDevices. type: object - SasPortalOperation: - type: object - id: SasPortalOperation - description: >- - This resource represents a long-running operation that is the result of - a network API call. + SasPortalInstallationParams: properties: - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + verticalAccuracy: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - name: + A positive number in meters to indicate accuracy of the device + antenna vertical location. This optional parameter should only be + present if its value is less than the FCC requirement of 3 meters. + type: number + format: double + horizontalAccuracy: + format: double + type: number description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + A positive number in meters to indicate accuracy of the device + antenna horizontal location. This optional parameter should only be + present if its value is less than the FCC requirement of 50 meters. + heightType: + enumDescriptions: + - Unspecified height type. + - AGL height is measured relative to the ground level. + - AMSL height is measured relative to the mean sea level. + enum: + - HEIGHT_TYPE_UNSPECIFIED + - HEIGHT_TYPE_AGL + - HEIGHT_TYPE_AMSL + description: Specifies how the height is measured. + type: string + latitude: + format: double + description: >- + Latitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -90.000000 to +90.000000. + Positive values represent latitudes north of the equator; negative + values south of the equator. + type: number + antennaGain: + description: >- + Peak antenna gain in dBi. This parameter is a double with a value + between -127 and +128 (dBi) inclusive. Part of Release 2 to support + floating-point value + format: double + type: number + longitude: + type: number + description: >- + Longitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -180.000000 to +180.000000. + Positive values represent longitudes east of the prime meridian; + negative values west of the prime meridian. + format: double + cpeCbsdIndication: + type: boolean + description: >- + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + eirpCapability: + description: >- + This parameter is the maximum device EIRP in units of dBm/10MHz and + is an integer with a value between -127 and +47 (dBm/10 MHz) + inclusive. If not included, SAS interprets it as maximum allowable + EIRP in units of dBm/10MHz for device category. + type: integer + format: int32 + antennaBeamwidth: + format: int32 + type: integer + description: >- + 3-dB antenna beamwidth of the antenna in the horizontal-plane in + degrees. This parameter is an unsigned integer having a value + between 0 and 360 (degrees) inclusive; it is optional for Category A + devices and conditional for Category B devices. + antennaDowntilt: + description: >- + Antenna downtilt in degrees and is an integer with a value between + -90 and +90 inclusive; a negative value means the antenna is tilted + up (above horizontal). This parameter is optional for Category A + devices and conditional for Category B devices. + type: integer + format: int32 + height: + type: number + description: >- + Device antenna height in meters. When the `heightType` parameter + value is "AGL", the antenna height should be given relative to + ground level. When the `heightType` parameter value is "AMSL", it is + given with respect to WGS84 datum. + format: double + antennaAzimuth: + format: int32 + type: integer + description: >- + Boresight direction of the horizontal plane of the antenna in + degrees with respect to true north. The value of this parameter is + an integer with a value between 0 and 359 inclusive. A value of 0 + degrees means true north; a value of 90 degrees means east. This + parameter is optional for Category A devices and conditional for + Category B devices. + antennaModel: type: string - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - done: + If an external antenna is used, the antenna model is optionally + provided in this field. The string has a maximum length of 128 + octets. + indoorDeployment: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. type: boolean - error: - $ref: '#/components/schemas/SasPortalStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - SasPortalTestPermissionsRequest: - id: SasPortalTestPermissionsRequest + description: Information about the device installation parameters. + type: object + id: SasPortalInstallationParams + SasPortalGetPolicyRequest: properties: - permissions: - type: array - description: The set of permissions to check for the `resource`. - items: - type: string resource: - description: >- - Required. The resource for which the permissions are being - requested. type: string - description: Request message for `TestPermissions` method. + description: Required. The resource for which the policy is being requested. + id: SasPortalGetPolicyRequest + description: Request message for `GetPolicy` method. type: object - SasPortalChannelWithScore: + SasPortalDeviceGrant: type: object - id: SasPortalChannelWithScore + id: SasPortalDeviceGrant + description: >- + Device grant. It is an authorization provided by the Spectrum Access + System to a device to transmit using specified operating parameters + after a successful heartbeat by the device. properties: + grantId: + description: Grant Id. + type: string frequencyRange: + description: The transmission frequency range. $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range of the channel. - score: - type: number - format: double - description: The channel score, normalized to be in the range [0,100]. - description: The channel with score. - SasPortalDeviceModel: - id: SasPortalDeviceModel - type: object - description: Information about the model of the device. - properties: - hardwareVersion: - type: string - description: The hardware version of the device. - name: - description: The name of the device model. - type: string - firmwareVersion: - description: The firmware version of the device. - type: string - vendor: - type: string - description: The name of the device vendor. - softwareVersion: - description: The software version of the device. + state: type: string - SasPortalListNodesResponse: - id: SasPortalListNodesResponse - properties: - nodes: - description: The nodes that match the request. - items: - $ref: '#/components/schemas/SasPortalNode' - type: array - nextPageToken: + description: State of the grant. + enumDescriptions: + - '' + - >- + The grant has been granted but the device is not heartbeating on + it. + - The grant has been terminated by the SAS. + - The grant has been suspended by the SAS. + - The device is currently transmitting. + - The grant has expired. + enum: + - GRANT_STATE_UNSPECIFIED + - GRANT_STATE_GRANTED + - GRANT_STATE_TERMINATED + - GRANT_STATE_SUSPENDED + - GRANT_STATE_AUTHORIZED + - GRANT_STATE_EXPIRED + channelType: + description: Type of channel used. + enum: + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL + enumDescriptions: + - '' + - '' + - '' type: string + maxEirp: + format: double description: >- - A pagination token returned from a previous call to ListNodes that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more nodes. - type: object - description: Response for ListNodes. - SasPortalListDeploymentsResponse: - description: Response for ListDeployments. - properties: - nextPageToken: - description: >- - A pagination token returned from a previous call to ListDeployments - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more deployments. - type: string - deployments: - type: array - description: The deployments that match the request. + Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by + the grant. The maximum EIRP is in units of dBm/MHz. The value of + `maxEirp` represents the average (RMS) EIRP that would be measured + by the procedure defined in FCC part 96.41(e)(3). + type: number + suspensionReason: items: - $ref: '#/components/schemas/SasPortalDeployment' - id: SasPortalListDeploymentsResponse - type: object - SasPortalCustomer: - properties: - sasUserIds: - description: User IDs used by the devices belonging to this customer. + type: string type: array + description: If the grant is suspended, the reason(s) for suspension. + moveList: items: - type: string - displayName: + $ref: '#/components/schemas/SasPortalDpaMoveList' + type: array + description: The DPA move lists on which this grant appears. + expireTime: + format: google-datetime + description: The expiration time of the grant. type: string - description: >- - Required. Name of the organization that the customer entity - represents. - name: - description: Output only. Resource name of the customer. + lastHeartbeatTransmitExpireTime: type: string - type: object - id: SasPortalCustomer - description: Entity representing a SAS customer. - SasPortalMigrateOrganizationMetadata: - id: SasPortalMigrateOrganizationMetadata - type: object + format: google-datetime + description: The transmit expiration time of the last heartbeat. + SasPortalGcpProjectDeployment: description: >- - Long-running operation metadata message returned by the - MigrateOrganization. + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. + id: SasPortalGcpProjectDeployment properties: - operationState: - readOnly: true - enum: - - OPERATION_STATE_UNSPECIFIED - - OPERATION_STATE_PENDING - - OPERATION_STATE_RUNNING - - OPERATION_STATE_SUCCEEDED - - OPERATION_STATE_FAILED - enumDescriptions: - - Unspecified. - - Pending (Not started). - - In-progress. - - Done successfully. - - Done with errors. - type: string - description: Output only. Current operation state - SasPortalGenerateSecretResponse: - id: SasPortalGenerateSecretResponse + deployment: + description: Deployment associated with the GCP project. + $ref: '#/components/schemas/SasPortalDeployment' + hasEnabledAnalytics: + type: boolean + description: Whether SAS analytics has been enabled. type: object - properties: - secret: - type: string - description: The secret generated by the string and used by ValidateInstaller. - description: Response for GenerateSecret. - SasPortalDeployment: - description: The Deployment. + SasPortalMigrateOrganizationResponse: + id: SasPortalMigrateOrganizationResponse type: object - id: SasPortalDeployment + description: >- + Response for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. properties: - displayName: - description: The deployment's display name. - type: string - frns: - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. - items: - type: string - type: array - readOnly: true - name: - type: string - description: Output only. Resource name. - readOnly: true - sasUserIds: + deploymentAssociation: items: - type: string + $ref: '#/components/schemas/SasPortalDeploymentAssociation' type: array description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. - SasPortalGetPolicyRequest: + Optional. A list of deployment association that were created for the + migration, or current associations if they already exist. + SasPortalSignDeviceRequest: + properties: + device: + description: >- + Required. The device to sign. The device fields name, fcc_id and + serial_number must be set. The user_id field must be set. + $ref: '#/components/schemas/SasPortalDevice' + description: Request for SignDevice. + id: SasPortalSignDeviceRequest type: object - description: Request message for `GetPolicy` method. + SasPortalSetPolicyRequest: + description: Request message for `SetPolicy` method. properties: resource: + description: >- + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. type: string - description: Required. The resource for which the policy is being requested. - id: SasPortalGetPolicyRequest - SasPortalGenerateSecretRequest: + disableNotification: + description: >- + Optional. Set the field as `true` to disable the onboarding + notification. + type: boolean + policy: + description: Required. The policy to be applied to the `resource`. + $ref: '#/components/schemas/SasPortalPolicy' + type: object + id: SasPortalSetPolicyRequest + SasPortalSetupSasAnalyticsMetadata: properties: {} - id: SasPortalGenerateSecretRequest + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. type: object - description: Request for GenerateSecret. - SasPortalCreateSignedDeviceRequest: - description: Request for CreateSignedDevice. + id: SasPortalSetupSasAnalyticsMetadata + SasPortalOperation: type: object - id: SasPortalCreateSignedDeviceRequest properties: - installerId: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + response: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - encodedDevice: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + metadata: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + $ref: '#/components/schemas/SasPortalStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: SasPortalOperation + SasPortalMoveDeviceRequest: + type: object + description: Request for MoveDevice. + properties: + destination: type: string - format: byte description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - SasPortalGcpProjectDeployment: + Required. The name of the new parent resource node or customer to + reparent the device under. + id: SasPortalMoveDeviceRequest + SasPortalSetupSasAnalyticsResponse: + id: SasPortalSetupSasAnalyticsResponse type: object description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. - id: SasPortalGcpProjectDeployment - properties: - hasEnabledAnalytics: - description: Whether SAS analytics has been enabled. - type: boolean - deployment: - description: Deployment associated with the GCP project. - $ref: '#/components/schemas/SasPortalDeployment' - SasPortalValidateInstallerResponse: - description: Response for ValidateInstaller. - id: SasPortalValidateInstallerResponse + Response returned by the long running operation for the + SetupSasAnalytics rpc. properties: {} + SasPortalTestPermissionsRequest: + description: Request message for `TestPermissions` method. type: object - SasPortalAssignment: - type: object + id: SasPortalTestPermissionsRequest properties: - members: - type: array + permissions: items: type: string + description: The set of permissions to check for the `resource`. + type: array + resource: description: >- - The identities the role is assigned to. It can have the following - values: * `{user_email}`: An email address that represents a - specific Google account. For example: `alice@gmail.com`. * - `{group_email}`: An email address that represents a Google group. - For example, `viewers@gmail.com`. - role: + Required. The resource for which the permissions are being + requested. type: string - description: Required. Role that is assigned to `members`. - description: Associates `members` with a `role`. - id: SasPortalAssignment - SasPortalNode: - description: The Node. + SasPortalChannelWithScore: + properties: + frequencyRange: + description: The frequency range of the channel. + $ref: '#/components/schemas/SasPortalFrequencyRange' + score: + description: The channel score, normalized to be in the range [0,100]. + format: double + type: number + description: The channel with score. + id: SasPortalChannelWithScore type: object - id: SasPortalNode + SasPortalNrqzValidation: + id: SasPortalNrqzValidation properties: - displayName: + cpiId: + description: CPI who signed the validation. type: string - description: The node's display name. - sasUserIds: - description: User ids used by the devices belonging to this node. - items: - type: string - type: array - name: + state: + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL + description: State of the NRQZ validation info. type: string - description: Output only. Resource name. - SasPortalSetupSasAnalyticsRequest: - type: object - id: SasPortalSetupSasAnalyticsRequest - properties: - userId: - description: >- - Optional. User id to setup analytics for, if not provided the user - id associated with the project is used. optional + longitude: + description: Device longitude that's associated with the validation. + type: number + format: double + latitude: + description: Device latitude that's associated with the validation. + format: double + type: number + caseId: + description: Validation case ID. type: string - description: Request for the SetupSasAnalytics rpc. + description: Information about National Radio Quiet Zone validation. + type: object parameters: + callback: + description: JSONP + in: query + name: callback + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -1104,22 +1116,16 @@ components: name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string alt: @@ -1132,22 +1138,10 @@ components: - json - media - proto - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: upload_protocol + name: oauth_token schema: type: string key: @@ -1159,6 +1153,12 @@ components: name: key schema: type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -1168,39 +1168,32 @@ components: enum: - '1' - '2' - oauth_token: - description: OAuth 2.0 token for the current user. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: oauth_token + name: uploadType schema: type: string x-stackQL-resources: - policies: - id: google.sasportal.policies - name: policies - title: Policies + installer: + id: google.sasportal.installer + name: installer + title: Installer methods: - policies_test: - operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_set: + installer_validate: operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' + $ref: '#/paths/~1v1alpha1~1installer:validate/post' response: mediaType: application/json openAPIDocKey: '200' - policies_get: + installer_generate_secret: operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' + select: [] insert: [] update: [] replace: [] @@ -1229,15 +1222,15 @@ components: name: customers title: Customers methods: - customers_migrate_organization: + customers_patch: operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' response: mediaType: application/json openAPIDocKey: '200' - customers_provision_deployment: + customers_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -1248,15 +1241,15 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.customers - customers_get: + customers_provision_deployment: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' response: mediaType: application/json openAPIDocKey: '200' - customers_patch: + customers_migrate_organization: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1294,488 +1287,488 @@ components: update: [] replace: [] delete: [] - deployments: - id: google.sasportal.deployments - name: deployments - title: Deployments + devices_signed: + id: google.sasportal.devices_signed + name: devices_signed + title: Devices_signed methods: - customers_deployments_get: + customers_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_patch: + customers_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_delete: + customers_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_list: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_create: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_move: + customers_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_deployments_list: + deployments_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_nodes_deployments_create: + nodes_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_deployments_list: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - nodes_deployments_move: + nodes_devices_create_signed: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_get: + nodes_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_delete: + nodes_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_patch: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed + update: + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed + replace: [] + delete: [] + devices: + id: google.sasportal.devices + name: devices + title: Devices + methods: + customers_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_deployments_create: + objectKey: $.devices + customers_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_deployments_list: + customers_devices_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - deployments_get: + objectKey: $.devices + customers_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/deployments_get - insert: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_create - update: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete - devices_signed: - id: google.sasportal.devices_signed - name: devices_signed - title: Devices_signed - methods: - customers_deployments_devices_create_signed: + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create_signed: + customers_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - customers_devices_update_signed: + customers_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create_signed: + customers_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_update_signed: + customers_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create_signed: + customers_nodes_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create_signed: + objectKey: $.devices + customers_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + deployments_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_update_signed: + deployments_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed - update: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed - replace: [] - delete: [] - devices: - id: google.sasportal.devices - name: devices - title: Devices - methods: - customers_deployments_devices_list: + deployments_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_deployments_devices_create: + deployments_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create: + deployments_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_list: + nodes_devices_list: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - customers_devices_create: + nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_list: + nodes_devices_patch: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_devices_patch: + nodes_devices_delete: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_delete: + nodes_devices_get: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_get: + nodes_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_move: + nodes_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_sign_device: + objectKey: $.devices + nodes_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_sign_device: + nodes_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_patch: + objectKey: $.devices + nodes_nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_devices_get + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_get + - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_devices_list + insert: + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_devices_create + update: + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_devices_patch + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_patch + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_devices_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_devices_delete + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_delete + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_devices_delete + deployments: + id: google.sasportal.deployments + name: deployments + title: Deployments + methods: + customers_deployments_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_get: + customers_deployments_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create: + objectKey: $.deployments + customers_deployments_delete: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_list: + customers_deployments_get: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_move: + customers_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_list: + customers_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_deployments_devices_create: + customers_nodes_deployments_list: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_list: + objectKey: $.deployments + customers_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_nodes_devices_create: + deployments_get: + operation: + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_deployments_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + nodes_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_move: + nodes_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_patch: + nodes_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_get: + nodes_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_delete: + nodes_nodes_deployments_list: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + objectKey: $.deployments + nodes_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_get - - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_get + #/components/x-stackQL-resources/deployments/methods/customers_deployments_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_list + #/components/x-stackQL-resources/deployments/methods/deployments_get - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_list + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list insert: - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_create + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_create + #/components/x-stackQL-resources/deployments/methods/customers_deployments_create update: - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_patch - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_patch + #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_patch + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_delete - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_delete + #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_delete + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete customer_nodes: id: google.sasportal.customer_nodes name: customer_nodes @@ -1796,19 +1789,19 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - customers_nodes_list: + customers_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_create: + customers_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.nodes customers_nodes_delete: operation: $ref: >- @@ -1851,21 +1844,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_patch: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_nodes_delete: + nodes_nodes_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_move: + nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1876,19 +1863,18 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - nodes_nodes_create: + nodes_nodes_patch: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_nodes_list: + nodes_nodes_delete: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes nodes_nodes_nodes_create: operation: $ref: >- @@ -1896,6 +1882,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + nodes_nodes_nodes_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.nodes sqlVerbs: select: - $ref: >- @@ -1956,51 +1949,58 @@ components: update: [] replace: [] delete: [] - installer: - id: google.sasportal.installer - name: installer - title: Installer + policies: + id: google.sasportal.policies + name: policies + title: Policies methods: - installer_generate_secret: + policies_get: operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + $ref: '#/paths/~1v1alpha1~1policies:get/post' response: mediaType: application/json openAPIDocKey: '200' - installer_validate: + policies_test: operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' + $ref: '#/paths/~1v1alpha1~1policies:test/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_set: + operation: + $ref: '#/paths/~1v1alpha1~1policies:set/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' insert: [] update: [] replace: [] delete: [] paths: - /v1alpha1/policies:test: + /v1alpha1/installer:validate: parameters: &ref_1 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' post: - description: Returns permissions that a caller has on the specified resource. - operationId: sasportal.policies.test + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: sasportal.installer.validate requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2016,20 +2016,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' parameters: [] - /v1alpha1/policies:set: + /v1alpha1/installer:generateSecret: parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: sasportal.policies.set + description: Generates a secret to be used with the ValidateInstaller. + operationId: sasportal.installer.generateSecret requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetPolicyRequest' + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2045,20 +2043,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' parameters: [] - /v1alpha1/policies:get: + /v1alpha1/customers:listGcpProjectDeployments: parameters: *ref_1 - post: + get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: sasportal.policies.get + Returns a list of SAS deployments associated with current GCP project. + Includes whether SAS analytics has been enabled or not. + operationId: sasportal.customers.listGcpProjectDeployments + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers/{customersId}: + parameters: *ref_1 + patch: + description: Updates an existing customer. + operationId: sasportal.customers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGetPolicyRequest' + $ref: '#/components/schemas/SasPortalCustomer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2074,15 +2095,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/customers:listGcpProjectDeployments: - parameters: *ref_1 + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: >- - Returns a list of SAS deployments associated with current GCP project. - Includes whether SAS analytics has been enabled or not. - operationId: sasportal.customers.listGcpProjectDeployments + description: Returns a requested customer. + operationId: sasportal.customers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2098,23 +2125,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/SasPortalListGcpProjectDeploymentsResponse - parameters: [] - /v1alpha1/customers:migrateOrganization: + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + /v1alpha1/customers: parameters: *ref_1 - post: - description: >- - Migrates a SAS organization to the cloud. This will create GCP projects - for each deployment and associate them. The SAS Organization is linked - to the gcp project that called the command. - go/sas-legacy-customer-migration - operationId: sasportal.customers.migrateOrganization - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + get: + description: Returns a list of requested customers. + operationId: sasportal.customers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2130,8 +2152,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] + $ref: '#/components/schemas/SasPortalListCustomersResponse' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string /v1alpha1/customers:provisionDeployment: parameters: *ref_1 post: @@ -2161,11 +2192,20 @@ paths: schema: $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' parameters: [] - /v1alpha1/customers: + /v1alpha1/customers:migrateOrganization: parameters: *ref_1 - get: - description: Returns a list of requested customers. - operationId: sasportal.customers.list + post: + description: >- + Migrates a SAS organization to the cloud. This will create GCP projects + for each deployment and associate them. The SAS Organization is linked + to the gcp project that called the command. + go/sas-legacy-customer-migration + operationId: sasportal.customers.migrateOrganization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2181,22 +2221,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' - parameters: - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/customers/{customersId}: + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers:setupSasAnalytics: parameters: *ref_1 - get: - description: Returns a requested customer. - operationId: sasportal.customers.get + post: + description: >- + Setups the a GCP Project to receive SAS Analytics messages via GCP + Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and + BigQuery tables are created automatically as part of this service. + operationId: sasportal.customers.setupSasAnalytics + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2212,21 +2251,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - patch: - description: Updates an existing customer. - operationId: sasportal.customers.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers:listLegacyOrganizations: + parameters: *ref_1 + get: + description: Returns a list of legacy organizations. + operationId: sasportal.customers.listLegacyOrganizations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2242,31 +2273,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers:setupSasAnalytics: + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' + parameters: [] + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_1 post: - description: >- - Setups the a GCP Project to receive SAS Analytics messages via GCP - Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and - BigQuery tables are created automatically as part of this service. - operationId: sasportal.customers.setupSasAnalytics + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2282,13 +2300,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers:listLegacyOrganizations: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: parameters: *ref_1 get: - description: Returns a list of legacy organizations. - operationId: sasportal.customers.listLegacyOrganizations + description: Lists devices under a node or customer. + operationId: sasportal.customers.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2304,13 +2332,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' - parameters: [] - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: - parameters: *ref_1 - get: - description: Returns a requested deployment. - operationId: sasportal.customers.deployments.get + $ref: '#/components/schemas/SasPortalListDevicesResponse' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a device under a node or customer. + operationId: sasportal.customers.deployments.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2326,7 +2380,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -2338,9 +2392,11 @@ paths: required: true schema: type: string - patch: - description: Updates an existing deployment. - operationId: sasportal.customers.deployments.patch + /v1alpha1/customers/{customersId}/deployments: + parameters: *ref_1 + post: + description: Creates a new deployment. + operationId: sasportal.customers.deployments.create requestBody: content: application/json: @@ -2368,16 +2424,46 @@ paths: required: true schema: type: string + get: + description: Lists deployments. + operationId: sasportal.customers.deployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + parameters: *ref_1 delete: description: Deletes a deployment. operationId: sasportal.customers.deployments.delete @@ -2408,11 +2494,9 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments: - parameters: *ref_1 get: - description: Lists deployments. - operationId: sasportal.customers.deployments.list + description: Returns a requested deployment. + operationId: sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2428,29 +2512,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: deploymentsId + required: true schema: type: string - post: - description: Creates a new deployment. - operationId: sasportal.customers.deployments.create + patch: + description: Updates an existing deployment. + operationId: sasportal.customers.deployments.patch requestBody: content: application/json: @@ -2478,6 +2554,16 @@ paths: required: true schema: type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: parameters: *ref_1 post: @@ -2515,11 +2601,11 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/customers/{customersId}/devices:createSigned: parameters: *ref_1 post: description: Creates a signed device under a node or customer. - operationId: sasportal.customers.deployments.devices.createSigned + operationId: sasportal.customers.devices.createSigned requestBody: content: application/json: @@ -2547,16 +2633,11 @@ paths: required: true schema: type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + /v1alpha1/customers/{customersId}/devices: parameters: *ref_1 get: description: Lists devices under a node or customer. - operationId: sasportal.customers.deployments.devices.list + operationId: sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2579,15 +2660,6 @@ paths: required: true schema: type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: @@ -2597,9 +2669,13 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string post: description: Creates a device under a node or customer. - operationId: sasportal.customers.deployments.devices.create + operationId: sasportal.customers.devices.create requestBody: content: application/json: @@ -2627,21 +2703,16 @@ paths: required: true schema: type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: + /v1alpha1/customers/{customersId}/devices/{devicesId}: parameters: *ref_1 - post: - description: Creates a new node. - operationId: sasportal.customers.nodes.nodes.create + patch: + description: Updates a device. + operationId: sasportal.customers.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2657,7 +2728,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -2665,13 +2736,18 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - get: - description: Lists nodes. - operationId: sasportal.customers.nodes.nodes.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a device. + operationId: sasportal.customers.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2687,7 +2763,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -2695,28 +2771,50 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - - in: query - name: pageToken + get: + description: Gets details about a device. + operationId: sasportal.customers.devices.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true schema: type: string - - in: query - name: filter + - in: path + name: devicesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: parameters: *ref_1 - get: - description: Lists deployments. - operationId: sasportal.customers.nodes.deployments.list + patch: + description: Updates a signed device. + operationId: sasportal.customers.devices.updateSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2732,7 +2830,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -2740,31 +2838,20 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: sasportal.customers.nodes.deployments.create + description: Signs a device. + operationId: sasportal.customers.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2780,7 +2867,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -2788,20 +2875,20 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.nodes.devices.create + description: Moves a device under another node or customer. + operationId: sasportal.customers.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2817,7 +2904,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -2825,10 +2912,12 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + parameters: *ref_1 get: description: Lists devices under a node or customer. operationId: sasportal.customers.nodes.devices.list @@ -2872,16 +2961,14 @@ paths: schema: type: integer format: int32 - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: - parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.nodes.devices.createSigned + description: Creates a device under a node or customer. + operationId: sasportal.customers.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2909,11 +2996,16 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: parameters: *ref_1 - get: - description: Lists nodes. - operationId: sasportal.customers.nodes.list + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.nodes.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2929,29 +3021,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: nodesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: + parameters: *ref_1 post: description: Creates a new node. - operationId: sasportal.customers.nodes.create + operationId: sasportal.customers.nodes.nodes.create requestBody: content: application/json: @@ -2979,46 +3065,14 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}: - parameters: *ref_1 - delete: - description: Deletes a node. - operationId: sasportal.customers.nodes.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - in: path name: nodesId required: true schema: type: string - patch: - description: Updates an existing node. - operationId: sasportal.customers.nodes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists nodes. + operationId: sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3034,7 +3088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId @@ -3047,13 +3101,23 @@ paths: schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + parameters: *ref_1 get: - description: Returns a requested node. - operationId: sasportal.customers.nodes.get + description: Lists deployments. + operationId: sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3069,7 +3133,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId @@ -3081,16 +3145,27 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: - parameters: *ref_1 + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Moves a node under another node or customer. - operationId: sasportal.customers.nodes.move + description: Creates a new deployment. + operationId: sasportal.customers.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3106,7 +3181,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -3118,16 +3193,16 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/devices: + /v1alpha1/customers/{customersId}/nodes: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.devices.create + description: Creates a new node. + operationId: sasportal.customers.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3143,7 +3218,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -3151,8 +3226,8 @@ paths: schema: type: string get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.devices.list + description: Lists nodes. + operationId: sasportal.customers.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3168,36 +3243,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}: + /v1alpha1/customers/{customersId}/nodes/{nodesId}: parameters: *ref_1 patch: - description: Updates a device. - operationId: sasportal.customers.devices.patch + description: Updates an existing node. + operationId: sasportal.customers.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3213,7 +3288,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -3221,7 +3296,7 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string @@ -3231,8 +3306,8 @@ paths: type: string format: google-fieldmask delete: - description: Deletes a device. - operationId: sasportal.customers.devices.delete + description: Deletes a node. + operationId: sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3256,50 +3331,13 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string get: - description: Gets details about a device. - operationId: sasportal.customers.devices.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: - parameters: *ref_1 - post: - description: Moves a device under another node or customer. - operationId: sasportal.customers.devices.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + description: Returns a requested node. + operationId: sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3315,7 +3353,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -3323,20 +3361,20 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: parameters: *ref_1 post: - description: Signs a device. - operationId: sasportal.customers.devices.signDevice + description: Moves a node under another node or customer. + operationId: sasportal.customers.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3352,7 +3390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -3360,20 +3398,15 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: + /v1alpha1/deployments/{deploymentsId}: parameters: *ref_1 - patch: - description: Updates a signed device. - operationId: sasportal.customers.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + get: + description: Returns a requested deployment. + operationId: sasportal.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3389,28 +3422,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices:createSigned: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.devices.createSigned + description: Moves a device under another node or customer. + operationId: sasportal.deployments.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3426,23 +3454,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: parameters: *ref_1 - post: - description: Signs a device. - operationId: sasportal.nodes.devices.signDevice - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + get: + description: Gets details about a device. + operationId: sasportal.deployments.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3458,10 +3486,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string @@ -3470,16 +3498,9 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: - parameters: *ref_1 - patch: - description: Updates a device. - operationId: sasportal.nodes.devices.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + delete: + description: Deletes a device. + operationId: sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3495,10 +3516,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string @@ -3507,14 +3528,14 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: sasportal.nodes.devices.delete + patch: + description: Updates a device. + operationId: sasportal.deployments.devices.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3530,10 +3551,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string @@ -3542,9 +3563,21 @@ paths: required: true schema: type: string - get: - description: Gets details about a device. - operationId: sasportal.nodes.devices.get + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: sasportal.deployments.devices.updateSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3563,7 +3596,7 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string @@ -3572,16 +3605,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.devices.create + description: Signs a device. + operationId: sasportal.deployments.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3597,13 +3630,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: deploymentsId + required: true + schema: + type: string + - in: path + name: devicesId required: true schema: type: string + /v1alpha1/nodes/{nodesId}/devices: + parameters: *ref_1 get: description: Lists devices under a node or customer. operationId: sasportal.nodes.devices.list @@ -3629,6 +3669,10 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -3638,20 +3682,14 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: - parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: sasportal.nodes.devices.move + description: Creates a device under a node or customer. + operationId: sasportal.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3667,18 +3705,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: parameters: *ref_1 patch: @@ -3748,16 +3781,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.deployments.devices.createSigned + patch: + description: Updates a device. + operationId: sasportal.nodes.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3781,15 +3814,18 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: - parameters: *ref_1 - get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.deployments.devices.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a device. + operationId: sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3805,7 +3841,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -3813,31 +3849,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.deployments.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + get: + description: Gets details about a device. + operationId: sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3861,15 +3879,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: parameters: *ref_1 - get: - description: Lists deployments. - operationId: sasportal.nodes.deployments.list + post: + description: Moves a device under another node or customer. + operationId: sasportal.nodes.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3885,36 +3908,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize + - in: path + name: devicesId + required: true schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: Moves a deployment under another node or customer. - operationId: sasportal.nodes.deployments.move + description: Signs a device. + operationId: sasportal.nodes.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3930,7 +3945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -3938,15 +3953,15 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + /v1alpha1/nodes/{nodesId}/deployments: parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: sasportal.nodes.deployments.get + description: Lists deployments. + operationId: sasportal.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3962,21 +3977,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - delete: - description: Deletes a deployment. - operationId: sasportal.nodes.deployments.delete + - in: query + name: pageToken + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: Returns a requested deployment. + operationId: sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3992,7 +4017,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -4044,11 +4069,9 @@ paths: schema: type: string format: google-fieldmask - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: - parameters: *ref_1 - get: - description: Returns a requested node. - operationId: sasportal.nodes.nodes.get + delete: + description: Deletes a deployment. + operationId: sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4064,7 +4087,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -4072,53 +4095,20 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - patch: - description: Updates an existing node. - operationId: sasportal.nodes.nodes.patch + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + parameters: *ref_1 + post: + description: Moves a deployment under another node or customer. + operationId: sasportal.nodes.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a node. - operationId: sasportal.nodes.nodes.delete + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4134,7 +4124,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -4142,20 +4132,20 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_1 post: - description: Moves a node under another node or customer. - operationId: sasportal.nodes.nodes.move + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4171,7 +4161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -4179,15 +4169,15 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: parameters: *ref_1 get: - description: Lists nodes. - operationId: sasportal.nodes.nodes.list + description: Lists devices under a node or customer. + operationId: sasportal.nodes.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4203,13 +4193,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId required: true schema: type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: @@ -4219,18 +4218,14 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.create + description: Creates a device under a node or customer. + operationId: sasportal.nodes.deployments.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4246,18 +4241,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: parameters: *ref_1 - get: - description: Lists nodes. - operationId: sasportal.nodes.nodes.nodes.list + post: + description: Moves a node under another node or customer. + operationId: sasportal.nodes.nodes.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4273,7 +4278,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -4285,22 +4290,11 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v1alpha1/nodes/{nodesId}/nodes: + parameters: *ref_1 post: description: Creates a new node. - operationId: sasportal.nodes.nodes.nodes.create + operationId: sasportal.nodes.nodes.create requestBody: content: application/json: @@ -4328,16 +4322,9 @@ paths: required: true schema: type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: - parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.nodes.devices.list + description: Lists nodes. + operationId: sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4353,39 +4340,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - in: query name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.nodes.devices.create + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: + parameters: *ref_1 + patch: + description: Updates an existing node. + operationId: sasportal.nodes.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4401,7 +4385,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -4413,16 +4397,14 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.nodes.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a node. + operationId: sasportal.nodes.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4438,7 +4420,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -4448,18 +4430,11 @@ paths: - in: path name: nodesId1 required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: - parameters: *ref_1 - post: - description: Creates a new deployment. - operationId: sasportal.nodes.nodes.deployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + schema: + type: string + get: + description: Returns a requested node. + operationId: sasportal.nodes.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4475,7 +4450,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -4487,6 +4462,8 @@ paths: required: true schema: type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + parameters: *ref_1 get: description: Lists deployments. operationId: sasportal.nodes.nodes.deployments.list @@ -4517,11 +4494,6 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: filter schema: @@ -4530,11 +4502,19 @@ paths: name: pageToken schema: type: string - /v1alpha1/nodes/{nodesId}: - parameters: *ref_1 - get: - description: Returns a requested node. - operationId: sasportal.nodes.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new deployment. + operationId: sasportal.nodes.nodes.deployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4550,23 +4530,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/installer:generateSecret: + - in: path + name: nodesId1 + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: parameters: *ref_1 post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: sasportal.installer.generateSecret + description: Creates a new node. + operationId: sasportal.nodes.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4582,18 +4567,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/installer:validate: - parameters: *ref_1 - post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: sasportal.installer.validate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerRequest' + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: nodesId1 + required: true + schema: + type: string + get: + description: Lists nodes. + operationId: sasportal.nodes.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4609,18 +4597,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' - parameters: [] - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + $ref: '#/components/schemas/SasPortalListNodesResponse' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: nodesId1 + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: parameters: *ref_1 - post: - description: Moves a device under another node or customer. - operationId: sasportal.deployments.devices.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + get: + description: Lists devices under a node or customer. + operationId: sasportal.nodes.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4636,28 +4642,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: - parameters: *ref_1 - patch: - description: Updates a signed device. - operationId: sasportal.deployments.devices.updateSigned + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a device under a node or customer. + operationId: sasportal.nodes.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4676,25 +4693,25 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: parameters: *ref_1 - patch: - description: Updates a device. - operationId: sasportal.deployments.devices.patch + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4713,23 +4730,20 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1alpha1/nodes/{nodesId}: + parameters: *ref_1 get: - description: Gets details about a device. - operationId: sasportal.deployments.devices.get + description: Returns a requested node. + operationId: sasportal.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4745,21 +4759,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId + name: nodesId required: true schema: type: string - delete: - description: Deletes a device. - operationId: sasportal.deployments.devices.delete + /v1alpha1/policies:get: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: sasportal.policies.get + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4775,28 +4793,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:test: parameters: *ref_1 post: - description: Signs a device. - operationId: sasportal.deployments.devices.signDevice + description: Returns permissions that a caller has on the specified resource. + operationId: sasportal.policies.test requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalTestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4812,23 +4820,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}: + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + parameters: [] + /v1alpha1/policies:set: parameters: *ref_1 - get: - description: Returns a requested deployment. - operationId: sasportal.deployments.get + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: sasportal.policies.set + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4844,10 +4849,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml index bac22943..45af28c9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml @@ -34,1083 +34,1268 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SearchTenancyUnitsResponse: - id: SearchTenancyUnitsResponse - description: Response for the search query. + JavaSettings: properties: - nextPageToken: + libraryPackage: type: string - description: Pagination token for large results. - tenancyUnits: - items: - $ref: '#/components/schemas/TenancyUnit' - type: array - description: Tenancy Units matching the request. - type: object - CppSettings: - id: CppSettings - type: object - properties: + description: >- + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 + serviceClassNames: + description: >- + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + type: object + additionalProperties: + type: string common: $ref: '#/components/schemas/CommonLanguageSettings' description: Some settings. - description: Settings for C++ client libraries. - ServiceAccountConfig: + description: Settings for Java client libraries. + type: object + id: JavaSettings + TenancyUnit: + id: TenancyUnit type: object properties: - tenantProjectRoles: + tenantResources: items: - type: string - description: Roles for the associated service account for the tenant project. + $ref: '#/components/schemas/TenantResource' type: array - accountId: description: >- - ID of the IAM service account to be created in tenant project. The - email format of the service account is "@.iam.gserviceaccount.com". - This account ID must be unique within tenant project and service - producers have to guarantee it. The ID must be 6-30 characters long, - and match the following regular expression: - `[a-z]([-a-z0-9]*[a-z0-9])`. + Resources constituting the tenancy unit. There can be at most 512 + tenant resources in a tenancy unit. + service: + readOnly: true + description: >- + Output only. Google Cloud API name of the managed service owning + this tenancy unit. For example + 'serviceconsumermanagement.googleapis.com'. type: string - id: ServiceAccountConfig - description: Describes the service account configuration for the tenant project. - Logging: - properties: - producerDestinations: + createTime: + type: string + readOnly: true + description: Output only. @OutputOnly The time this tenancy unit was created. + format: google-datetime + name: description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. - items: - $ref: '#/components/schemas/LoggingDestination' - type: array - consumerDestinations: + Globally unique identifier of this tenancy unit + "services/{service}/{collection id}/{resource + id}/tenancyUnits/{unit}" + type: string + consumer: description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. - items: - $ref: '#/components/schemas/LoggingDestination' - type: array + Output only. @OutputOnly Cloud resource name of the consumer of this + service. For example 'projects/123456'. + readOnly: true + type: string + description: Representation of a tenancy unit. + EnumValue: type: object - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - id: Logging - Option: + id: EnumValue properties: - value: - type: object - description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + options: + type: array + items: + $ref: '#/components/schemas/Option' + description: Protocol buffer options. + number: + format: int32 + description: Enum value number. + type: integer name: type: string - description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - id: Option - type: object - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - AuthRequirement: + description: Enum value name. + description: Enum value definition. + MethodSettings: properties: - providerId: - description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - type: string - audiences: - type: string + autoPopulatedFields: description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - type: object - id: AuthRequirement - description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - V1RefreshConsumerResponse: - id: V1RefreshConsumerResponse - description: >- - Response message for the `RefreshConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - type: object - properties: {} - AuthenticationRule: - type: object - id: AuthenticationRule - properties: - oauth: - description: The requirements for OAuth credentials. - $ref: '#/components/schemas/OAuthRequirements' - requirements: - description: Requirements for additional authentication providers. + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id type: array items: - $ref: '#/components/schemas/AuthRequirement' + type: string selector: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... type: string - allowWithoutCredential: - type: boolean + longRunning: + $ref: '#/components/schemas/LongRunning' description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - NodeSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: NodeSettings - type: object - description: Settings for Node client libraries. - V1DisableConsumerResponse: + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + id: MethodSettings + description: Describes the generator configuration for a method. type: object - id: V1DisableConsumerResponse - properties: {} - description: >- - Response message for the `DisableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - Http: + Publishing: type: object properties: - rules: + methodSettings: + description: >- + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. type: array items: - $ref: '#/components/schemas/HttpRule' - description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. - fullyDecodeReservedExpansion: - type: boolean + $ref: '#/components/schemas/MethodSettings' + librarySettings: description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - id: Http - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - V1GenerateDefaultIdentityResponse: - properties: - attachStatus: + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. + type: array + items: + $ref: '#/components/schemas/ClientLibrarySettings' + docTagPrefix: + description: >- + A prefix used in sample code when demarking regions to be included + in documentation. type: string - enum: - - ATTACH_STATUS_UNSPECIFIED - - ATTACHED - - ATTACH_SKIPPED - - PREVIOUSLY_ATTACHED - - ATTACH_DENIED_BY_ORG_POLICY - enumDescriptions: - - Indicates that the AttachStatus was not set. - - >- - The default identity was attached to a role successfully in this - request. - - >- - The request specified that no attempt should be made to attach the - role. - - >- - Role was attached to the consumer project at some point in time. - Tenant manager doesn't make assertion about the current state of - the identity with respect to the consumer. Role attachment should - happen only once after activation and cannot be reattached after - customer removes it. (go/si-attach-role) - - >- - Role attachment was denied in this request by customer set org - policy. (go/si-attach-role) + codeownerGithubTeams: description: >- - Status of the role attachment. Under development - (go/si-attach-role), currently always return - ATTACH_STATUS_UNSPECIFIED) - role: + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + items: + type: string + type: array + newIssueUri: description: >- - Role attached to consumer project. Empty if not attached in this - request. (Under development, currently always return empty.) + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 type: string - identity: - $ref: '#/components/schemas/V1DefaultIdentity' - description: DefaultIdentity that was created or retrieved. - description: >- - Response message for the `GenerateDefaultIdentity` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - id: V1GenerateDefaultIdentityResponse - type: object - TenantResource: - description: Resource constituting the TenancyUnit. - id: TenantResource - properties: - tag: + apiShortName: + type: string + description: >- + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". + protoReferenceDocumentationUri: + type: string + description: >- + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc + restReferenceDocumentationUri: + type: string + description: >- + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + githubLabel: + description: >- + GitHub label to apply to issues and pull requests opened for this + API. + type: string + organization: type: string - description: Unique per single tenancy unit. - status: enum: - - STATUS_UNSPECIFIED - - PENDING_CREATE - - ACTIVE - - PENDING_DELETE - - FAILED - - DELETED - description: Status of tenant resource. + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI enumDescriptions: - - Unspecified status is the default unset value. - - Creation of the tenant resource is ongoing. - - Active resource. - - Deletion of the resource is ongoing. - - Tenant resource creation or deletion has failed. - - Tenant resource has been deleted. + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + description: For whom the client library is being published. + documentationUri: type: string - resource: - readOnly: true description: >- - Output only. @OutputOnly Identifier of the tenant resource. For - cloud projects, it is in the form 'projects/{number}'. For example - 'projects/123456'. - type: string - type: object - MethodPolicy: + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + id: Publishing + description: >- + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. + LogDescriptor: properties: - requestPolicies: + labels: + description: >- + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. type: array - description: Policies that are applicable to the request message. items: - $ref: '#/components/schemas/FieldPolicy' - selector: + $ref: '#/components/schemas/LabelDescriptor' + name: type: string description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - description: Defines policies applying to an RPC method. - id: MethodPolicy - type: object - CreateTenancyUnitRequest: - id: CreateTenancyUnitRequest - description: >- - Request to create a tenancy unit for a service consumer of a managed - service. - properties: - tenancyUnitId: + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + displayName: type: string description: >- - Optional. Optional service producer-provided identifier of the - tenancy unit. Must be no longer than 40 characters and preferably - URI friendly. If it isn't provided, a UID for the tenancy unit is - automatically generated. The identifier must be unique across a - managed service. If the tenancy unit already exists for the managed - service and service consumer pair, calling `CreateTenancyUnit` - returns the existing tenancy unit if the provided identifier is - identical or empty, otherwise the call fails. + The human-readable name for this log. This information appears on + the user interface and should be concise. + description: + description: >- + A human-readable description of this log. This information appears + in the documentation and can contain details. + type: string type: object - Endpoint: - id: Endpoint + id: LogDescriptor description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer + SystemParameterRule: + id: SystemParameterRule + type: object properties: - target: - type: string - description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". - name: - description: The canonical name of this endpoint. + selector: type: string - allowCors: description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - type: boolean - aliases: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + parameters: type: array description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. items: - type: string - type: object - V1Beta1BatchCreateProducerOverridesResponse: - properties: - overrides: - description: The overrides that were created. - type: array - items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - id: V1Beta1BatchCreateProducerOverridesResponse - description: Response message for BatchCreateProducerOverrides - type: object - BillingDestination: - id: BillingDestination + $ref: '#/components/schemas/SystemParameter' + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + Documentation: type: object + id: Documentation + description: >- + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. properties: - monitoredResource: + overview: type: string description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - metrics: + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. + rules: type: array items: - type: string + $ref: '#/components/schemas/DocumentationRule' description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - LabelDescriptor: - properties: - key: - description: The label key. - type: string - description: - description: A human-readable description for the label. - type: string - valueType: - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - description: The type of data that can be assigned to the label. - type: string - enum: - - STRING - - BOOL - - INT64 - id: LabelDescriptor - type: object - description: A description of a label. - Method: - type: object - id: Method - properties: - responseTypeUrl: - type: string - description: The URL of the output message type. - requestTypeUrl: - description: A URL of the input message type. + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. + summary: + description: >- + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. type: string - options: + pages: items: - $ref: '#/components/schemas/Option' + $ref: '#/components/schemas/Page' type: array - description: Any metadata attached to the method. - syntax: - type: string - description: The source syntax of this method. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - name: - type: string - description: The simple name of this method. - responseStreaming: - type: boolean - description: If true, the response is streamed. - requestStreaming: - description: If true, the request is streamed. - type: boolean - description: Method represents a method of an API interface. - EnumValue: - description: Enum value definition. - type: object - id: EnumValue - properties: - name: - description: Enum value name. + description: The top level pages for the documentation set. + documentationRootUrl: type: string - options: - description: Protocol buffer options. + description: The URL to the root of documentation. + sectionOverrides: items: - $ref: '#/components/schemas/Option' + $ref: '#/components/schemas/Page' type: array - number: - description: Enum value number. - format: int32 - type: integer - CustomHttpPattern: - description: A custom pattern is used for defining custom HTTP verb. - properties: - path: - type: string - description: The path matched by this custom verb. - kind: - type: string - description: The name of this custom HTTP verb. - type: object - id: CustomHttpPattern - FieldPolicy: - id: FieldPolicy - properties: - resourcePermission: - description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - type: string - selector: description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". - type: string - resourceType: + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries + serviceRootUrl: type: string description: >- - Specifies the resource type for the resource referred to by the - field. + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. + V1Beta1GenerateServiceIdentityResponse: type: object - description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. - AddTenantProjectRequest: + id: V1Beta1GenerateServiceIdentityResponse properties: - projectConfig: - $ref: '#/components/schemas/TenantProjectConfig' - description: >- - Configuration of the new tenant project to be added to tenancy unit - resources. - tag: - description: >- - Required. Tag of the added project. Must be less than 128 - characters. Required. - type: string - id: AddTenantProjectRequest + identity: + $ref: '#/components/schemas/V1Beta1ServiceIdentity' + description: ServiceIdentity that was created or retrieved. description: >- - Request to add a newly created and configured tenant project to a - tenancy unit. - type: object - MetricDescriptor: + Response message for the `GenerateServiceIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + CreateTenancyUnitRequest: description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. + Request to create a tenancy unit for a service consumer of a managed + service. + id: CreateTenancyUnitRequest + type: object properties: - metricKind: + tenancyUnitId: + description: >- + Optional. Optional service producer-provided identifier of the + tenancy unit. Must be no longer than 40 characters and preferably + URI friendly. If it isn't provided, a UID for the tenancy unit is + automatically generated. The identifier must be unique across a + managed service. If the tenancy unit already exists for the managed + service and service consumer pair, calling `CreateTenancyUnit` + returns the existing tenancy unit if the provided identifier is + identical or empty, otherwise the call fails. type: string + Service: + id: Service + properties: + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. + endpoints: + type: array + items: + $ref: '#/components/schemas/Endpoint' description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - displayName: - description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - type: string - launchStage: - description: Optional. The launch stage of the metric definition. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - type: string - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + enums: description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - type: string - labels: + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + items: + $ref: '#/components/schemas/Enum' type: array + metrics: + type: array + description: Defines the metrics used by this service. + items: + $ref: '#/components/schemas/MetricDescriptor' + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + apis: description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. items: - $ref: '#/components/schemas/LabelDescriptor' - valueType: - type: string - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY + $ref: '#/components/schemas/Api' + type: array + types: + type: array description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. - unit: + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 + items: + $ref: '#/components/schemas/Type' + backend: + $ref: '#/components/schemas/Backend' + description: API backend configuration. + title: description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). + The product title for this service, it is the name displayed in + Google Cloud Console. type: string - metadata: - description: Optional. Metadata which can be used to guide usage of the metric. - $ref: '#/components/schemas/MetricDescriptorMetadata' - name: + producerProjectId: + description: The Google project that owns this service. type: string - description: The resource name of the metric descriptor. - description: + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + publishing: + description: >- + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + $ref: '#/components/schemas/Publishing' + billing: + $ref: '#/components/schemas/Billing' + description: Billing configuration. + name: type: string description: >- - A detailed description of the metric, which can be used in - documentation. - monitoredResourceTypes: - type: array + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. + control: + description: Configuration for the service control plane. + $ref: '#/components/schemas/Control' + logs: + description: Defines the logs used by this service. items: - type: string - description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. - id: MetricDescriptor + $ref: '#/components/schemas/LogDescriptor' + type: array + documentation: + $ref: '#/components/schemas/Documentation' + description: Additional API documentation. + usage: + description: Configuration controlling usage of this service. + $ref: '#/components/schemas/Usage' + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + sourceInfo: + description: >- + Output only. The source information for this configuration if + available. + $ref: '#/components/schemas/SourceInfo' + monitoredResources: + description: >- + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + type: array + systemTypes: + type: array + items: + $ref: '#/components/schemas/Type' + description: >- + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. + id: + description: >- + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + type: string + configVersion: + type: integer + format: uint32 + description: >- + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + description: >- + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth type: object - BillingConfig: - id: BillingConfig + SourceContext: type: object + id: SourceContext + properties: + fileName: + type: string + description: >- + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + description: >- + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. + BillingConfig: + description: Describes the billing configuration for a new tenant project. properties: billingAccount: + type: string description: >- Name of the billing account. For example `billingAccounts/012345-567890-ABCDEF`. - type: string - description: Describes the billing configuration for a new tenant project. - V1Beta1GenerateServiceIdentityResponse: + id: BillingConfig + type: object + LongRunning: + id: LongRunning + type: object properties: - identity: - $ref: '#/components/schemas/V1Beta1ServiceIdentity' - description: ServiceIdentity that was created or retrieved. + totalPollTimeout: + type: string + format: google-duration + description: 'Total polling timeout. Default value: 5 minutes.' + initialPollDelay: + type: string + description: >- + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + format: google-duration + pollDelayMultiplier: + description: >- + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + format: float + type: number + maxPollDelay: + format: google-duration + type: string + description: >- + Maximum time between two subsequent poll requests. Default value: 45 + seconds. description: >- - Response message for the `GenerateServiceIdentity` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - id: V1Beta1GenerateServiceIdentityResponse + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + SystemParameters: + properties: + rules: + items: + $ref: '#/components/schemas/SystemParameterRule' + description: >- + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + type: array + id: SystemParameters type: object - Operation: description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: Operation + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + Endpoint: properties: - done: + allowCors: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. type: boolean - error: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any name: + type: string + description: The canonical name of this endpoint. + aliases: + type: array + items: + type: string description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + target: + description: >- + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". type: string type: object - Authentication: + id: Endpoint description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - id: Authentication + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + RemoveTenantProjectRequest: type: object + id: RemoveTenantProjectRequest properties: - providers: - items: - $ref: '#/components/schemas/AuthProvider' - type: array - description: Defines a set of authentication providers that a service supports. - rules: - type: array + tag: + description: Required. Tag of the resource within the tenancy unit. + type: string + description: >- + Request message to remove a tenant project resource from the tenancy + unit. + V1Beta1ImportProducerOverridesResponse: + id: V1Beta1ImportProducerOverridesResponse + description: Response message for ImportProducerOverrides + type: object + properties: + overrides: + description: The overrides that were created from the imported data. items: - $ref: '#/components/schemas/AuthenticationRule' + $ref: '#/components/schemas/V1Beta1QuotaOverride' + type: array + Control: + properties: + methodPolicies: + type: array + description: Defines policies applying to the API methods of the service. + items: + $ref: '#/components/schemas/MethodPolicy' + environment: description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - HttpRule: + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + type: string + id: Control + type: object description: >- - gRPC Transcoding gRPC Transcoding is a feature for mapping between a - gRPC method and one or more HTTP REST endpoints. It allows developers to - build a single API service that supports both gRPC APIs and REST APIs. - Many systems, including [Google - APIs](https://github.com/googleapis/googleapis), [Cloud - Endpoints](https://cloud.google.com/endpoints), [gRPC - Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - and use it for large scale production services. `HttpRule` defines the - schema of the gRPC/REST mapping. The mapping specifies how different - portions of the gRPC request message are mapped to the URL path, URL - query parameters, and HTTP request body. It also controls how the gRPC - response message is mapped to the HTTP response body. `HttpRule` is - typically specified as an `google.api.http` annotation on the gRPC - method. Each mapping specifies a URL path template and an HTTP method. - The path template may refer to one or more fields in the gRPC request - message, as long as each field is a non-repeated field with a primitive - (non-message) type. The path template controls how fields of the request - message are mapped to the URL path. Example: service Messaging { rpc - GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message - GetMessageRequest { string name = 1; // Mapped to URL path. } message - Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request - message which are not bound by the path template automatically become - HTTP query parameters if there is no HTTP request body. For example: - service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) - { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } - message GetMessageRequest { message SubMessage { string subfield = 1; } - string message_id = 1; // Mapped to URL path. int64 revision = 2; // - Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped - to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC - mapping as below: - HTTP: `GET - /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: - `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - "foo"))` Note that fields which are mapped to URL query parameters must - have a primitive type or a repeated primitive type or a non-repeated - message type. In the case of a repeated type, the parameter can be - repeated in the URL as `...?param=A¶m=B`. In the case of a message - type, each field of the message is mapped to a separate parameter, such - as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request - body, the `body` field specifies the mapping. Consider a REST update - method on the message resource collection: service Messaging { rpc - UpdateMessage(UpdateMessageRequest) returns (Message) { option - (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" - }; } } message UpdateMessageRequest { string message_id = 1; // mapped - to the URL Message message = 2; // mapped to the body } The following - HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: - HTTP: - `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The - special name `*` can be used in the body mapping to define that every - field not bound by the path template should be mapped to the request - body. This enables the following alternative definition of the update - method: service Messaging { rpc UpdateMessage(Message) returns (Message) - { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: - "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH - /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using - `*` in the body mapping, it is not possible to have HTTP parameters, as - all fields not bound by the path end in the body. This makes this option - more rarely used in practice when defining REST APIs. The common usage - of `*` is in custom methods which don't use the URL at all for - transferring data. It is possible to define multiple HTTP methods for - one RPC by using the `additional_bindings` option. Example: service - Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/messages/{message_id}" - additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } - }; } } message GetMessageRequest { string message_id = 1; string user_id - = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: - HTTP: `GET /v1/messages/123456` - gRPC: - `GetMessage(message_id: "123456")` - HTTP: `GET - /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" - message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields - (recursive expansion nested messages in the request message) are - classified into three categories: - Fields referred by the path - template. They are passed via the URL path. - Fields referred by the - HttpRule.body. They are passed via the HTTP request body. - All other - fields are passed via the URL query parameters, and the parameter name - is the field path in the request message. A repeated field can be - represented as multiple query parameters under the same name. 2. If - HttpRule.body is "*", there is no URL query parameter, all fields are - passed via URL path and HTTP request body. 3. If HttpRule.body is - omitted, there is no HTTP request body, all fields are passed via URL - path and URL query parameters. Path template syntax Template = "/" - Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | - "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] - "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax - `*` matches a single URL path segment. The syntax `**` matches zero or - more URL path segments, which must be the last part of the URL path - except the `Verb`. The syntax `Variable` matches part of the URL path as - specified by its template. A variable template must not contain other - variables. If a variable matches a single path segment, its template may - be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax - `LITERAL` matches literal text in the URL path. If the `LITERAL` - contains any reserved character, such characters should be - percent-encoded before the matching. If a variable contains exactly one - path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is - expanded into a URL path on the client side, all characters except - `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse - decoding. Such variables show up in the [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{var}`. If a variable contains multiple path segments, such as - `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a - URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` - are percent-encoded. The server side does the reverse decoding, except - "%2F" and "%2f" are left unchanged. Such variables show up in the - [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. Using gRPC API Service Configuration gRPC API Service - Configuration (service config) is a configuration language for - configuring a gRPC service to become a user-facing product. The service - config is simply the YAML representation of the `google.api.Service` - proto message. As an alternative to annotating your proto file, you can - configure gRPC transcoding in your service config YAML files. You do - this by specifying a `HttpRule` that maps the gRPC method to a REST - endpoint, achieving the same effect as the proto annotation. This can be - particularly useful if you have a proto that is reused in multiple - services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. The - following example selects a gRPC method and applies an `HttpRule` to it: - http: rules: - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC - Transcoding is used to map a gRPC to JSON REST endpoints, the proto to - JSON conversion must follow the [proto3 - specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - While the single segment variable follows the semantics of [RFC - 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - Expansion, the multi segment variable **does not** follow RFC 6570 - Section 3.2.3 Reserved Expansion. The reason is that the Reserved - Expansion does not expand special characters like `?` and `#`, which - would lead to invalid URLs. As the result, gRPC Transcoding uses a - custom encoding for multi segment variables. The path variables **must - not** refer to any repeated or mapped field, because client libraries - are not capable of handling such variable expansion. The path variables - **must not** capture the leading "/" character. The reason is that the - most common use case "{var}" does not capture the leading "/" character. - For consistency, all path variables must share the same behavior. - Repeated message fields must not be mapped to URL query parameters, - because no client library can support such complicated mapping. If an - API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. - id: HttpRule + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + V1EnableConsumerResponse: + id: V1EnableConsumerResponse + properties: {} type: object + description: >- + Response message for the `EnableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + PythonSettings: properties: - patch: + experimentalFeatures: + description: >- + Experimental features to be included during client library + generation. + $ref: '#/components/schemas/ExperimentalFeatures' + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + description: Settings for Python client libraries. + id: PythonSettings + type: object + TenantProjectConfig: + description: >- + This structure defines a tenant project to be added to the specified + tenancy unit and its initial configuration and properties. A project + lien is created for the tenant project to prevent the tenant project + from being deleted accidentally. The lien is deleted as part of tenant + project removal. + id: TenantProjectConfig + properties: + labels: + additionalProperties: + type: string + description: Labels that are applied to this project. + type: object + tenantProjectPolicy: + $ref: '#/components/schemas/TenantProjectPolicy' + description: Describes ownership and policies for the new tenant project. + billingConfig: + description: Billing account properties. The billing account must be specified. + $ref: '#/components/schemas/BillingConfig' + folder: type: string - description: Maps to HTTP PATCH. Used for updating a resource. - delete: - description: Maps to HTTP DELETE. Used for deleting a resource. + description: >- + Folder where project in this tenancy unit must be located This + folder must have been previously created with the required + permissions for the caller to create and configure a project in it. + Valid folder resource names have the format + `folders/{folder_number}` (for example, `folders/123456`). + serviceAccountConfig: + description: Configuration for the IAM service account on the tenant project. + $ref: '#/components/schemas/ServiceAccountConfig' + services: + items: + type: string + type: array + description: >- + Google Cloud API names of services that are activated on this + project during provisioning. If any of these services can't be + activated, the request fails. For example: + 'compute.googleapis.com','cloudfunctions.googleapis.com' + type: object + DocumentationRule: + description: A documentation rule provides information about individual API elements. + id: DocumentationRule + properties: + disableReplacementWords: + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. type: string - put: - description: Maps to HTTP PUT. Used for replacing a resource. + selector: + type: string + description: >- + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + deprecationDescription: + description: >- + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + type: string + description: + description: >- + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. + type: string + type: object + V1GenerateServiceAccountResponse: + description: >- + Response message for the `GenerateServiceAccount` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: V1GenerateServiceAccountResponse + type: object + properties: + account: + $ref: '#/components/schemas/V1ServiceAccount' + description: ServiceAccount that was created or retrieved. + ListTenancyUnitsResponse: + properties: + nextPageToken: + description: Pagination token for large results. + type: string + tenancyUnits: + items: + $ref: '#/components/schemas/TenancyUnit' + type: array + description: Tenancy units matching the request. + type: object + id: ListTenancyUnitsResponse + description: Response for the list request. + ContextRule: + id: ContextRule + description: >- + A context rule provides information about the context for an individual + API element. + properties: + requested: + description: >- + A list of full type names of requested contexts, only the requested + context will be made available to the backend. + items: + type: string + type: array + allowedResponseExtensions: + items: + type: string + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + type: array + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + provided: + items: + type: string + description: >- + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. + type: array + allowedRequestExtensions: + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + type: array + items: + type: string + type: object + Method: + type: object + id: Method + properties: + name: + description: The simple name of this method. + type: string + responseStreaming: + type: boolean + description: If true, the response is streamed. + requestTypeUrl: + description: A URL of the input message type. + type: string + options: + description: Any metadata attached to the method. + type: array + items: + $ref: '#/components/schemas/Option' + requestStreaming: + type: boolean + description: If true, the request is streamed. + responseTypeUrl: + type: string + description: The URL of the output message type. + syntax: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string + description: The source syntax of this method. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: Method represents a method of an API interface. + UndeleteTenantProjectRequest: + type: object + id: UndeleteTenantProjectRequest + description: >- + Request message to undelete tenant project resource previously deleted + from the tenancy unit. + properties: + tag: + type: string + description: Required. Tag of the resource within the tenancy unit. + MonitoredResourceDescriptor: + type: object + id: MonitoredResourceDescriptor + properties: + type: + type: string + description: >- + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). + displayName: + description: >- + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. + type: string + launchStage: + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Optional. The launch stage of the monitored resource definition. + type: string + labels: + description: >- + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + type: array + items: + $ref: '#/components/schemas/LabelDescriptor' + description: + type: string + description: >- + Optional. A detailed description of the monitored resource type that + might be used in documentation. + name: + description: >- + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + type: string + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. + TenantResource: + id: TenantResource + properties: + status: + type: string + enum: + - STATUS_UNSPECIFIED + - PENDING_CREATE + - ACTIVE + - PENDING_DELETE + - FAILED + - DELETED + enumDescriptions: + - Unspecified status is the default unset value. + - Creation of the tenant resource is ongoing. + - Active resource. + - Deletion of the resource is ongoing. + - Tenant resource creation or deletion has failed. + - Tenant resource has been deleted. + description: Status of tenant resource. + resource: type: string - responseBody: + readOnly: true description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. + Output only. @OutputOnly Identifier of the tenant resource. For + cloud projects, it is in the form 'projects/{number}'. For example + 'projects/123456'. + tag: + description: Unique per single tenancy unit. type: string - custom: - description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - $ref: '#/components/schemas/CustomHttpPattern' - additionalBindings: + description: Resource constituting the TenancyUnit. + type: object + PhpSettings: + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + type: object + id: PhpSettings + description: Settings for Php client libraries. + TenantProjectPolicy: + description: >- + Describes policy settings that can be applied to a newly created tenant + project. + properties: + policyBindings: + items: + $ref: '#/components/schemas/PolicyBinding' description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). + Policy bindings to be applied to the tenant project, in addition to + the 'roles/owner' role granted to the Service Consumer Management + service account. type: array + type: object + id: TenantProjectPolicy + Http: + properties: + fullyDecodeReservedExpansion: + description: >- + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: boolean + rules: items: $ref: '#/components/schemas/HttpRule' - post: + type: array description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + type: object + id: Http + description: >- + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + JwtLocation: + id: JwtLocation + description: Specifies a location to extract JWT from an API request. + type: object + properties: + valuePrefix: type: string - get: + description: >- + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + header: + type: string + description: Specifies HTTP header name to extract JWT token. + query: + description: Specifies URL query parameter name to extract JWT token. + type: string + cookie: + type: string + description: Specifies cookie name to extract JWT token. + Page: + type: object + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + id: Page + properties: + name: type: string description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - body: + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. + content: description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. - type: string - selector: + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. type: string + subpages: description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - DeleteTenantProjectRequest: - description: Request message to delete tenant project resource from the tenancy unit. + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. + items: + $ref: '#/components/schemas/Page' + type: array + Option: + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. properties: - tag: - description: Required. Tag of the resource within the tenancy unit. + name: type: string - id: DeleteTenantProjectRequest + description: >- + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. + value: + type: object + description: >- + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + id: Option + type: object + Backend: type: object - Control: properties: - methodPolicies: - type: array + rules: items: - $ref: '#/components/schemas/MethodPolicy' - description: Defines policies applying to the API methods of the service. - environment: - type: string + $ref: '#/components/schemas/BackendRule' + type: array description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + id: Backend + description: '`Backend` defines the backend configuration for a service.' + Mixin: description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - id: Control + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } type: object - RemoveTenantProjectRequest: + id: Mixin properties: - tag: + root: + description: >- + If non-empty specifies a path under which inherited HTTP paths are + rooted. type: string - description: Required. Tag of the resource within the tenancy unit. - description: >- - Request message to remove a tenant project resource from the tenancy - unit. + name: + description: The fully qualified name of the interface which is included. + type: string + NodeSettings: + type: object + id: NodeSettings + description: Settings for Node client libraries. + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + AuthenticationRule: + properties: + allowWithoutCredential: + type: boolean + description: >- + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + requirements: + description: Requirements for additional authentication providers. + items: + $ref: '#/components/schemas/AuthRequirement' + type: array + selector: + type: string + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + oauth: + description: The requirements for OAuth credentials. + $ref: '#/components/schemas/OAuthRequirements' + id: AuthenticationRule + description: >- + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. type: object - id: RemoveTenantProjectRequest UsageRule: description: >- Usage configuration rules for the service. NOTE: Under development. Use @@ -1124,1313 +1309,1182 @@ components: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true - id: UsageRule properties: allowUnregisteredCalls: - type: boolean description: >- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. + type: boolean + selector: + type: string + description: >- + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. skipServiceControl: + type: boolean description: >- If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. - type: boolean - selector: - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - type: string type: object - Publishing: + id: UsageRule + V1DisableConsumerResponse: + description: >- + Response message for the `DisableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + type: object + properties: {} + id: V1DisableConsumerResponse + Usage: properties: - librarySettings: - type: array - description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. - items: - $ref: '#/components/schemas/ClientLibrarySettings' - apiShortName: - type: string - description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". - restReferenceDocumentationUri: - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - type: string - protoReferenceDocumentationUri: + producerNotificationChannel: type: string description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - methodSettings: - type: array - description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + rules: items: - $ref: '#/components/schemas/MethodSettings' - newIssueUri: - type: string - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - githubLabel: - type: string + $ref: '#/components/schemas/UsageRule' description: >- - GitHub label to apply to issues and pull requests opened for this - API. - codeownerGithubTeams: + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + requirements: items: type: string - description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. type: array - documentationUri: - type: string - description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - organization: - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - description: For whom the client library is being published. - type: string - docTagPrefix: - type: string description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - id: Publishing - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - type: object - ApplyTenantProjectConfigRequest: - description: Request to apply configuration to an existing tenant project. - id: ApplyTenantProjectConfigRequest + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. + description: Configuration controlling usage of a service. type: object - properties: - tag: - description: >- - Required. Tag of the project. Must be less than 128 characters. - Required. - type: string - projectConfig: - $ref: '#/components/schemas/TenantProjectConfig' - description: Configuration that should be applied to the existing tenant project. - Enum: + id: Usage + Api: + id: Api type: object - id: Enum - description: Enum type definition. properties: - name: - type: string - description: Enum type name. - enumvalue: - items: - $ref: '#/components/schemas/EnumValue' - description: Enum value definitions. - type: array - options: - items: - $ref: '#/components/schemas/Option' - type: array - description: Protocol buffer options. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - edition: - type: string - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. syntax: enum: - SYNTAX_PROTO2 - SYNTAX_PROTO3 - SYNTAX_EDITIONS + description: The source syntax of the service. + type: string enumDescriptions: - Syntax `proto2`. - Syntax `proto3`. - Syntax `editions`. + name: type: string - description: The source syntax. - Field: - properties: - kind: - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - description: The field type. - type: string - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 - oneofIndex: - format: int32 - type: integer description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - typeUrl: + The fully qualified name of this interface, including package name + followed by the interface's simple name. + sourceContext: + description: >- + Source context for the protocol buffer service represented by this + message. + $ref: '#/components/schemas/SourceContext' + methods: + items: + $ref: '#/components/schemas/Method' + description: The methods of this interface, in unspecified order. + type: array + options: + description: Any metadata attached to the interface. + type: array + items: + $ref: '#/components/schemas/Option' + version: type: string description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - packed: - type: boolean - description: Whether to use alternative packed wire representation. - jsonName: - description: The field JSON name. + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. + mixins: + type: array + items: + $ref: '#/components/schemas/Mixin' + description: Included interfaces. See Mixin. + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + V1Beta1EnableConsumerResponse: + description: >- + Response message for the `EnableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + type: object + properties: {} + id: V1Beta1EnableConsumerResponse + SearchTenancyUnitsResponse: + id: SearchTenancyUnitsResponse + properties: + nextPageToken: type: string - number: - format: int32 - description: The field number. - type: integer - defaultValue: + description: Pagination token for large results. + tenancyUnits: + type: array + description: Tenancy Units matching the request. + items: + $ref: '#/components/schemas/TenancyUnit' + description: Response for the search query. + type: object + V1Beta1ImportProducerQuotaPoliciesResponse: + id: V1Beta1ImportProducerQuotaPoliciesResponse + properties: + policies: + description: The policies that were created from the imported data. + items: + $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' + type: array + description: Response message for ImportProducerQuotaPolicies + type: object + Type: + id: Type + description: A protocol buffer message type. + properties: + edition: type: string description: >- - The string value of the default value of this field. Proto2 syntax - only. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. options: items: $ref: '#/components/schemas/Option' description: The protocol buffer options. type: array name: - description: The field name. - type: string - cardinality: - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - description: The field cardinality. + description: The fully qualified message name. type: string - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - description: A single field of a message type. - id: Field - type: object - SourceInfo: - properties: - sourceFiles: + oneofs: + type: array items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + type: string + description: The list of types appearing in `oneof` definitions in this type. + fields: type: array - description: All files used during config generation. - description: Source information used to create a Service Config - type: object - id: SourceInfo - LongRunning: + items: + $ref: '#/components/schemas/Field' + description: The list of fields. + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + description: The source syntax. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' type: object + QuotaLimit: description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - id: LongRunning + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. + type: object properties: - pollDelayMultiplier: - type: number - format: float - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - maxPollDelay: + duration: description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - format: google-duration + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. type: string - initialPollDelay: - format: google-duration + defaultLimit: + format: int64 description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - type: string - totalPollTimeout: - format: google-duration + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. type: string - description: 'Total polling timeout. Default value: 5 minutes.' - Documentation: - description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. - properties: - overview: + values: description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + additionalProperties: + type: string + format: int64 + type: object + metric: type: string - serviceRootUrl: description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. + description: + description: >- + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + type: string + maxLimit: type: string - sectionOverrides: description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - items: - $ref: '#/components/schemas/Page' - type: array - documentationRootUrl: - description: The URL to the root of documentation. + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + format: int64 + freeTier: + description: >- + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + type: string + format: int64 + displayName: type: string - pages: - description: The top level pages for the documentation set. - items: - $ref: '#/components/schemas/Page' - type: array - rules: - items: - $ref: '#/components/schemas/DocumentationRule' - type: array description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - summary: + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + unit: type: string description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. - id: Documentation - type: object - ExperimentalFeatures: - description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. - type: object - properties: - restAsyncIoEnabled: + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + name: + type: string description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. - type: boolean - id: ExperimentalFeatures + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + id: QuotaLimit PolicyBinding: - type: object id: PolicyBinding + description: Translates to IAM Policy bindings (without auditing at this level) properties: members: description: >- Uses the same format as in IAM policy. `member` must include both a prefix and ID. For example, `user:{emailId}`, `serviceAccount:{emailId}`, `group:{emailId}`. - type: array - items: - type: string - role: - description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. - type: string - description: Translates to IAM Policy bindings (without auditing at this level) - Billing: - properties: - consumerDestinations: - items: - $ref: '#/components/schemas/BillingDestination' - description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. - type: array - id: Billing - type: object - description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count - V1Beta1ImportProducerQuotaPoliciesResponse: - id: V1Beta1ImportProducerQuotaPoliciesResponse - type: object - properties: - policies: - type: array - description: The policies that were created from the imported data. - items: - $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' - description: Response message for ImportProducerQuotaPolicies - MetricDescriptorMetadata: - properties: - timeSeriesResourceHierarchyLevel: items: - enumDescriptions: - - Do not use this default value. - - Scopes a metric to a project. - - Scopes a metric to an organization. - - Scopes a metric to a folder. - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER type: string - description: The scope of the timeseries data of the metric. - type: array - samplePeriod: - description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. - type: string - format: google-duration - ingestDelay: - format: google-duration - type: string - description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - deprecated: true - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. - type: string - id: MetricDescriptorMetadata - type: object - description: Additional annotations that can be used to guide the usage of a metric. - SystemParameterRule: - type: object - id: SystemParameterRule - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - properties: - parameters: - description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. type: array - items: - $ref: '#/components/schemas/SystemParameter' - selector: - type: string - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - Mixin: - description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - id: Mixin - type: object - properties: - root: + role: type: string description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. - name: - description: The fully qualified name of the interface which is included. - type: string - JwtLocation: - id: JwtLocation + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. type: object - description: Specifies a location to extract JWT from an API request. + BackendRule: properties: - valuePrefix: - type: string + overridesByRequestProtocol: + additionalProperties: + $ref: '#/components/schemas/BackendRule' + type: object + description: The map between request protocol and the backend address. + deadline: + type: number description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - query: - description: Specifies URL query parameter name to extract JWT token. + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + format: double + selector: type: string - cookie: - description: Specifies cookie name to extract JWT token. + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + minDeadline: + type: number + deprecated: true + format: double + description: Deprecated, do not use. + disableAuth: + description: >- + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + type: boolean + protocol: type: string - header: - description: Specifies HTTP header name to extract JWT token. + description: >- + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. + operationDeadline: + type: number + description: >- + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + format: double + pathTranslation: + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS type: string - Status: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: + address: type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + jwtAudience: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. + type: string + description: A backend rule provides configuration for an individual API element. + id: BackendRule type: object - id: Status - PythonSettings: + Authentication: + id: Authentication + type: object + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - experimentalFeatures: - $ref: '#/components/schemas/ExperimentalFeatures' + providers: + description: Defines a set of authentication providers that a service supports. + type: array + items: + $ref: '#/components/schemas/AuthProvider' + rules: + items: + $ref: '#/components/schemas/AuthenticationRule' description: >- - Experimental features to be included during client library - generation. - id: PythonSettings - type: object - description: Settings for Python client libraries. - V1Beta1EnableConsumerResponse: + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + V1RefreshConsumerResponse: + id: V1RefreshConsumerResponse type: object - properties: {} description: >- - Response message for the `EnableConsumer` method. This response message + Response message for the `RefreshConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. - id: V1Beta1EnableConsumerResponse - OAuthRequirements: - properties: - canonicalScopes: - description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read - type: string + properties: {} + Empty: description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. + 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 + properties: {} type: object - id: OAuthRequirements - Page: + LabelDescriptor: + description: A description of a label. + id: LabelDescriptor type: object - id: Page - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. properties: - subpages: - description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - type: array - items: - $ref: '#/components/schemas/Page' - content: - description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. + valueType: + description: The type of data that can be assigned to the label. + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + enum: + - STRING + - BOOL + - INT64 + type: string + description: + description: A human-readable description for the label. + type: string + key: + description: The label key. type: string + Field: + id: Field + properties: + number: + format: int32 + description: The field number. + type: integer + packed: + type: boolean + description: Whether to use alternative packed wire representation. name: + type: string + description: The field name. + kind: + type: string + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + description: The field type. + typeUrl: type: string description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - V1RemoveVisibilityLabelsResponse: - description: >- - Response message for the `RemoveVisibilityLabels` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - type: object - id: V1RemoveVisibilityLabelsResponse - properties: - labels: - items: - type: string + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + cardinality: + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + type: string + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + description: The field cardinality. + defaultValue: description: >- - The updated set of visibility labels for this consumer on this - service. - type: array - CancelOperationRequest: - type: object - description: The request message for Operations.CancelOperation. - properties: {} - id: CancelOperationRequest - ListTenancyUnitsResponse: - id: ListTenancyUnitsResponse - properties: - nextPageToken: - description: Pagination token for large results. + The string value of the default value of this field. Proto2 syntax + only. type: string - tenancyUnits: + options: items: - $ref: '#/components/schemas/TenancyUnit' + $ref: '#/components/schemas/Option' + description: The protocol buffer options. type: array - description: Tenancy units matching the request. - description: Response for the list request. - type: object - DotnetSettings: + jsonName: + description: The field JSON name. + type: string + oneofIndex: + description: >- + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + format: int32 + type: integer type: object - id: DotnetSettings - description: Settings for Dotnet client libraries. + description: A single field of a message type. + LoggingDestination: + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). properties: - renamedResources: - type: object - additionalProperties: - type: string - description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - handwrittenSignatures: + logs: type: array items: type: string description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - forcedNamespaceAliases: - description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - items: - type: string - type: array - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - ignoredResources: - description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - type: array - items: - type: string - renamedServices: + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + monitoredResource: description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - type: object - additionalProperties: - type: string - PhpSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + type: string + id: LoggingDestination type: object - description: Settings for Php client libraries. - id: PhpSettings - Backend: - id: Backend + CommonLanguageSettings: properties: - rules: + destinations: type: array items: - $ref: '#/components/schemas/BackendRule' + type: string + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - description: '`Backend` defines the backend configuration for a service.' - type: object - Api: - type: object - properties: - mixins: - items: - $ref: '#/components/schemas/Mixin' - description: Included interfaces. See Mixin. - type: array - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS + The destination where API teams want this client library to be + published. + referenceDocsUri: type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax of the service. - methods: - type: array - description: The methods of this interface, in unspecified order. + deprecated: true + description: >- + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + id: CommonLanguageSettings + description: Required information for every language. + type: object + Billing: + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count + id: Billing + properties: + consumerDestinations: items: - $ref: '#/components/schemas/Method' - options: + $ref: '#/components/schemas/BillingDestination' type: array - description: Any metadata attached to the interface. - items: - $ref: '#/components/schemas/Option' - name: description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + type: object + MetricRule: + type: object + id: MetricRule + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + properties: + selector: type: string - version: description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. - type: string - sourceContext: - $ref: '#/components/schemas/SourceContext' + Selects the methods to which this rule applies. Refer to selector + for syntax details. + metricCosts: + type: object + additionalProperties: + type: string + format: int64 description: >- - Source context for the protocol buffer service represented by this - message. + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + Operation: description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. - id: Api - CustomError: - id: CustomError + This resource represents a long-running operation that is the result of + a network API call. + id: Operation + type: object + properties: + error: + $ref: '#/components/schemas/Status' + description: >- + The error result of the operation in case of failure or + cancellation. + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + Monitoring: description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + id: Monitoring type: object properties: - types: + producerDestinations: type: array - description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. items: - type: string - rules: + $ref: '#/components/schemas/MonitoringDestination' description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + consumerDestinations: + description: >- + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. type: array items: - $ref: '#/components/schemas/CustomErrorRule' - V1Beta1ServiceIdentity: - description: A service identity in the Identity and Access Management API. - id: V1Beta1ServiceIdentity + $ref: '#/components/schemas/MonitoringDestination' + ExperimentalFeatures: + id: ExperimentalFeatures + type: object properties: - uniqueId: - type: string - description: The unique and stable id of the service identity. - name: - type: string + restAsyncIoEnabled: description: >- - P4 service identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` - email: - description: The email address of the service identity. + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + CustomHttpPattern: + description: A custom pattern is used for defining custom HTTP verb. + id: CustomHttpPattern + properties: + kind: type: string - tag: + description: The name of this custom HTTP verb. + path: + description: The path matched by this custom verb. type: string - description: >- - The P4 service identity configuration tag. This must be defined in - activation_grants. If not specified when creating the account, the - tag is set to "default". type: object - ListOperationsResponse: - description: The response message for Operations.ListOperations. + V1Beta1BatchCreateProducerOverridesResponse: + id: V1Beta1BatchCreateProducerOverridesResponse + description: Response message for BatchCreateProducerOverrides + type: object properties: - operations: - description: >- - A list of operations that matches the specified filter in the - request. + overrides: + description: The overrides that were created. type: array items: - $ref: '#/components/schemas/Operation' - nextPageToken: - description: The standard List next-page token. - type: string - id: ListOperationsResponse + $ref: '#/components/schemas/V1Beta1QuotaOverride' + V1RemoveVisibilityLabelsResponse: + properties: + labels: + type: array + items: + type: string + description: >- + The updated set of visibility labels for this consumer on this + service. + id: V1RemoveVisibilityLabelsResponse + type: object + description: >- + Response message for the `RemoveVisibilityLabels` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + GoSettings: type: object - AttachTenantProjectRequest: + id: GoSettings + description: Settings for Go client libraries. properties: - tag: - description: >- - Required. Tag of the tenant resource after attachment. Must be less - than 128 characters. Required. - type: string - reservedResource: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + MonitoringDestination: + id: MonitoringDestination + properties: + metrics: + items: + type: string + type: array description: >- - When attaching a reserved project already in tenancy units, this is - the tag of a tenant resource under the tenancy unit for the managed - service's service producer project. The reserved tenant resource - must be in an active state. - type: string - externalResource: + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + monitoredResource: type: string description: >- - When attaching an external project, this is in the format of - `projects/{project_number}`. - id: AttachTenantProjectRequest + The monitored resource type. The type must be defined in + Service.monitored_resources section. description: >- - Request to attach an existing project to the tenancy unit as a new - tenant resource. + Configuration of a specific monitoring destination (the producer project + or the consumer project). type: object - TenancyUnit: + Enum: + description: Enum type definition. + id: Enum properties: - createTime: - type: string - description: Output only. @OutputOnly The time this tenancy unit was created. - readOnly: true - format: google-datetime name: type: string - description: >- - Globally unique identifier of this tenancy unit - "services/{service}/{collection id}/{resource - id}/tenancyUnits/{unit}" - tenantResources: + description: Enum type name. + syntax: + description: The source syntax. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumvalue: + description: Enum value definitions. items: - $ref: '#/components/schemas/TenantResource' + $ref: '#/components/schemas/EnumValue' type: array + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + edition: description: >- - Resources constituting the tenancy unit. There can be at most 512 - tenant resources in a tenancy unit. - consumer: - description: >- - Output only. @OutputOnly Cloud resource name of the consumer of this - service. For example 'projects/123456'. - type: string - readOnly: true - service: + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. type: string - readOnly: true - description: >- - Output only. Google Cloud API name of the managed service owning - this tenancy unit. For example - 'serviceconsumermanagement.googleapis.com'. - type: object - id: TenancyUnit - description: Representation of a tenancy unit. - V1Beta1ImportProducerOverridesResponse: - id: V1Beta1ImportProducerOverridesResponse - type: object - properties: - overrides: + options: + description: Protocol buffer options. type: array items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - description: The overrides that were created from the imported data. - description: Response message for ImportProducerOverrides - SourceContext: + $ref: '#/components/schemas/Option' + type: object + DeleteTenantProjectRequest: + description: Request message to delete tenant project resource from the tenancy unit. type: object + id: DeleteTenantProjectRequest properties: - fileName: + tag: type: string - description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - id: SourceContext - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - AuthProvider: - id: AuthProvider + description: Required. Tag of the resource within the tenancy unit. + CustomErrorRule: + type: object + description: A custom error rule. + id: CustomErrorRule properties: - jwksUri: + selector: + description: >- + Selects messages to which this rule applies. Refer to selector for + syntax details. type: string + isErrorType: description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - id: + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + type: boolean + ApplyTenantProjectConfigRequest: + type: object + description: Request to apply configuration to an existing tenant project. + properties: + projectConfig: + $ref: '#/components/schemas/TenantProjectConfig' + description: Configuration that should be applied to the existing tenant project. + tag: description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". + Required. Tag of the project. Must be less than 128 characters. + Required. type: string - issuer: + id: ApplyTenantProjectConfigRequest + BillingDestination: + id: BillingDestination + properties: + metrics: + items: + type: string description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - type: string - jwtLocations: + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. type: array + monitoredResource: description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token + The monitored resource type. The type must be defined in + Service.monitored_resources section. + type: string + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + type: object + MetricDescriptorMetadata: + type: object + id: MetricDescriptorMetadata + description: Additional annotations that can be used to guide the usage of a metric. + properties: + timeSeriesResourceHierarchyLevel: items: - $ref: '#/components/schemas/JwtLocation' - authorizationUrl: + type: string + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER + description: The scope of the timeseries data of the metric. + type: array + launchStage: + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + deprecated: true + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + samplePeriod: + format: google-duration description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. type: string - audiences: + ingestDelay: description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. type: string - type: object - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - V1ServiceAccount: - type: object + format: google-duration + SystemParameter: properties: - email: - type: string - description: The email address of the service account. - tag: - type: string + urlQueryParameter: description: >- - The P4 SA configuration tag. This must be defined in - activation_grants. If not specified when creating the account, the - tag is set to "default". - iamAccountName: - deprecated: true - type: string - description: Deprecated. See b/136209818. - uniqueId: - description: The unique and stable id of the service account. + Define the URL query parameter name to use for the parameter. It is + case sensitive. type: string name: + description: >- + Define the name of the parameter, such as "api_key" . It is case + sensitive. + type: string + httpHeader: type: string description: >- - P4 SA resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` - description: A service account in the Identity and Access Management API. - id: V1ServiceAccount - V1EnableConsumerResponse: - properties: {} + Define the HTTP header name to use for the parameter. It is case + insensitive. type: object - id: V1EnableConsumerResponse - description: >- - Response message for the `EnableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - TenantProjectConfig: - id: TenantProjectConfig + id: SystemParameter description: >- - This structure defines a tenant project to be added to the specified - tenancy unit and its initial configuration and properties. A project - lien is created for the tenant project to prevent the tenant project - from being deleted accidentally. The lien is deleted as part of tenant - project removal. - properties: - tenantProjectPolicy: - description: Describes ownership and policies for the new tenant project. - $ref: '#/components/schemas/TenantProjectPolicy' - serviceAccountConfig: - $ref: '#/components/schemas/ServiceAccountConfig' - description: Configuration for the IAM service account on the tenant project. - labels: - additionalProperties: - type: string - description: Labels that are applied to this project. - type: object - folder: - type: string - description: >- - Folder where project in this tenancy unit must be located This - folder must have been previously created with the required - permissions for the caller to create and configure a project in it. - Valid folder resource names have the format - `folders/{folder_number}` (for example, `folders/123456`). - services: - type: array - items: - type: string - description: >- - Google Cloud API names of services that are activated on this - project during provisioning. If any of these services can't be - activated, the request fails. For example: - 'compute.googleapis.com','cloudfunctions.googleapis.com' - billingConfig: - description: Billing account properties. The billing account must be specified. - $ref: '#/components/schemas/BillingConfig' + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + V1GenerateDefaultIdentityResponse: type: object - V1Beta1ProducerQuotaPolicy: properties: - unit: - description: >- - The limit unit of the limit to which this policy applies. An example - unit would be: `1/{project}/{region}` Note that `{project}` and - `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - type: string - dimensions: - description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota polcies that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' - additionalProperties: - type: string - type: object - policyValue: + identity: + description: DefaultIdentity that was created or retrieved. + $ref: '#/components/schemas/V1DefaultIdentity' + attachStatus: + enumDescriptions: + - Indicates that the AttachStatus was not set. + - >- + The default identity was attached to a role successfully in this + request. + - >- + The request specified that no attempt should be made to attach the + role. + - >- + Role was attached to the consumer project at some point in time. + Tenant manager doesn't make assertion about the current state of + the identity with respect to the consumer. Role attachment should + happen only once after activation and cannot be reattached after + customer removes it. (go/si-attach-role) + - >- + Role attachment was denied in this request by customer set org + policy. (go/si-attach-role) description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). - format: int64 - type: string - container: + Status of the role attachment. Under development + (go/si-attach-role), currently always return + ATTACH_STATUS_UNSPECIFIED) type: string - description: >- - The cloud resource container at which the quota policy is created. - The format is {container_type}/{container_number} - metric: - description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` + enum: + - ATTACH_STATUS_UNSPECIFIED + - ATTACHED + - ATTACH_SKIPPED + - PREVIOUSLY_ATTACHED + - ATTACH_DENIED_BY_ORG_POLICY + role: type: string - name: description: >- - The resource name of the producer policy. An example name would be: - `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` - type: string - description: Quota policy created by service producer. - type: object - id: V1Beta1ProducerQuotaPolicy - TenantProjectPolicy: + Role attached to consumer project. Empty if not attached in this + request. (Under development, currently always return empty.) + id: V1GenerateDefaultIdentityResponse + description: >- + Response message for the `GenerateDefaultIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + V1Beta1RefreshConsumerResponse: + id: V1Beta1RefreshConsumerResponse type: object description: >- - Describes policy settings that can be applied to a newly created tenant - project. - id: TenantProjectPolicy - properties: - policyBindings: - description: >- - Policy bindings to be applied to the tenant project, in addition to - the 'roles/owner' role granted to the Service Consumer Management - service account. - items: - $ref: '#/components/schemas/PolicyBinding' - type: array - MonitoredResourceDescriptor: + Response message for the `RefreshConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + properties: {} + Logging: + id: Logging type: object + description: >- + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history properties: - displayName: - description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. - type: string - labels: - description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. + consumerDestinations: items: - $ref: '#/components/schemas/LabelDescriptor' - type: array - type: - type: string - description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - description: - type: string + $ref: '#/components/schemas/LoggingDestination' description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - name: + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. + type: array + producerDestinations: + items: + $ref: '#/components/schemas/LoggingDestination' + description: >- + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. + type: array + ClientLibrarySettings: + type: object + properties: + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. + version: type: string description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - type: string - description: Optional. The launch stage of the monitored resource definition. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -2469,319 +2523,125 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. - id: MonitoredResourceDescriptor - V1Beta1RefreshConsumerResponse: - id: V1Beta1RefreshConsumerResponse - description: >- - Response message for the `RefreshConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - type: object - properties: {} - BackendRule: - properties: - protocol: type: string - description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. - disableAuth: - type: boolean - description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - overridesByRequestProtocol: - description: The map between request protocol and the backend address. - type: object - additionalProperties: - $ref: '#/components/schemas/BackendRule' - pathTranslation: - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + description: Launch stage of this version of the API. enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - type: string - deadline: - type: number - format: double - description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - minDeadline: - type: number - description: Deprecated, do not use. - deprecated: true - format: double - address: - description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - type: string - selector: - type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - operationDeadline: - type: number - description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - format: double - jwtAudience: - type: string - description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. - id: BackendRule - description: A backend rule provides configuration for an individual API element. - type: object - V1AddVisibilityLabelsResponse: - description: >- - Response message for the `AddVisibilityLabels` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - id: V1AddVisibilityLabelsResponse - type: object - properties: - labels: - type: array - items: - type: string - description: >- - The updated set of visibility labels for this consumer on this - service. - LogDescriptor: - properties: - name: - description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - type: string - description: - description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - type: string - labels: - description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - type: array - items: - $ref: '#/components/schemas/LabelDescriptor' - displayName: - description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - type: string - id: LogDescriptor - type: object - description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer - V1DefaultIdentity: - id: V1DefaultIdentity - description: A default identity in the Identity and Access Management API. - properties: - uniqueId: - description: The unique and stable id of the default identity. - type: string - tag: - description: >- - The Default Identity tag. If specified when creating the account, - the tag must be present in activation_grants. If not specified when - creating the account, the tag is set to the tag specified in - activation_grants. - type: string - name: - type: string - description: >- - Default identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` - email: - type: string - description: The email address of the default identity. - type: object - CustomErrorRule: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + pythonSettings: + $ref: '#/components/schemas/PythonSettings' + description: Settings for Python client libraries. + rubySettings: + $ref: '#/components/schemas/RubySettings' + description: Settings for Ruby client libraries. + phpSettings: + $ref: '#/components/schemas/PhpSettings' + description: Settings for PHP client libraries. + restNumericEnums: + description: >- + When using transport=rest, the client request will encode enums as + numbers rather than strings. + type: boolean + javaSettings: + description: Settings for legacy Java features, supported in the Service YAML. + $ref: '#/components/schemas/JavaSettings' + dotnetSettings: + $ref: '#/components/schemas/DotnetSettings' + description: Settings for .NET client libraries. + goSettings: + description: Settings for Go client libraries. + $ref: '#/components/schemas/GoSettings' + cppSettings: + $ref: '#/components/schemas/CppSettings' + description: Settings for C++ client libraries. + id: ClientLibrarySettings + description: Details about how and where to publish client libraries. + AuthProvider: type: object properties: - selector: + id: description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". + type: string + jwksUri: type: string - isErrorType: - type: boolean description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - description: A custom error rule. - id: CustomErrorRule - MethodSettings: - properties: - longRunning: - $ref: '#/components/schemas/LongRunning' + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs + jwtLocations: + items: + $ref: '#/components/schemas/JwtLocation' description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - autoPopulatedFields: + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token type: array + authorizationUrl: description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id - items: - type: string - selector: - description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. type: string - type: object - description: Describes the generator configuration for a method. - id: MethodSettings - Monitoring: - type: object - properties: - consumerDestinations: + issuer: description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - type: array - items: - $ref: '#/components/schemas/MonitoringDestination' - producerDestinations: - type: array + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com + type: string + audiences: + type: string description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - items: - $ref: '#/components/schemas/MonitoringDestination' - id: Monitoring - description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue - V1GenerateServiceAccountResponse: - properties: - account: - description: ServiceAccount that was created or retrieved. - $ref: '#/components/schemas/V1ServiceAccount' - id: V1GenerateServiceAccountResponse - type: object + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + id: AuthProvider description: >- - Response message for the `GenerateServiceAccount` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). V1Beta1QuotaOverride: properties: + dimensions: + type: object + description: ' If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' + additionalProperties: + type: string + metric: + description: >- + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` + type: string unit: description: >- The limit unit of the limit to which this override applies. An @@ -2789,580 +2649,745 @@ components: and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. type: string + overrideValue: + type: string + description: >- + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + format: int64 adminOverrideAncestor: + type: string description: >- The resource name of the ancestor that requested the override. For example: "organizations/12345" or "folders/67890". Used by admin overrides only. - type: string name: - type: string description: >- The resource name of the producer override. An example name would be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` - metric: - description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` - type: string - dimensions: - type: object - additionalProperties: - type: string - description: ' If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' - overrideValue: - description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). type: string - format: int64 description: A quota override id: V1Beta1QuotaOverride type: object - Usage: - description: Configuration controlling usage of a service. - properties: - rules: - items: - $ref: '#/components/schemas/UsageRule' - type: array - description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - producerNotificationChannel: - description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. - type: string - requirements: - type: array - description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. - items: - type: string - id: Usage - type: object - MetricRule: - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - id: MetricRule - type: object + DotnetSettings: + type: object + id: DotnetSettings + description: Settings for Dotnet client libraries. properties: - metricCosts: - additionalProperties: - type: string - format: int64 + renamedServices: description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. type: object - selector: - type: string + additionalProperties: + type: string + forcedNamespaceAliases: + items: + type: string + type: array description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - QuotaLimit: - description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - properties: - name: + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision + handwrittenSignatures: description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. - type: string - values: + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + type: array + items: + type: string + renamedResources: type: object description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" additionalProperties: - format: int64 type: string - displayName: - type: string + ignoredResources: + items: + type: string + type: array description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - unit: + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + ServiceAccountConfig: + description: Describes the service account configuration for the tenant project. + type: object + id: ServiceAccountConfig + properties: + accountId: type: string description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. - defaultLimit: - type: string + ID of the IAM service account to be created in tenant project. The + email format of the service account is "@.iam.gserviceaccount.com". + This account ID must be unique within tenant project and service + producers have to guarantee it. The ID must be 6-30 characters long, + and match the following regular expression: + `[a-z]([-a-z0-9]*[a-z0-9])`. + tenantProjectRoles: + type: array + description: Roles for the associated service account for the tenant project. + items: + type: string + AttachTenantProjectRequest: + properties: + reservedResource: description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - format: int64 - description: + When attaching a reserved project already in tenancy units, this is + the tag of a tenant resource under the tenancy unit for the managed + service's service producer project. The reserved tenant resource + must be in an active state. type: string + externalResource: description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). - maxLimit: + When attaching an external project, this is in the format of + `projects/{project_number}`. type: string - description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - format: int64 - duration: + tag: type: string description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - metric: + Required. Tag of the tenant resource after attachment. Must be less + than 128 characters. Required. + id: AttachTenantProjectRequest + type: object + description: >- + Request to attach an existing project to the tenancy unit as a new + tenant resource. + Quota: + properties: + limits: + type: array + items: + $ref: '#/components/schemas/QuotaLimit' + description: List of QuotaLimit definitions for the service. + metricRules: description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + items: + $ref: '#/components/schemas/MetricRule' + type: array + id: Quota + type: object + description: >- + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + OAuthRequirements: + id: OAuthRequirements + properties: + canonicalScopes: type: string - freeTier: description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - format: int64 - type: string - id: QuotaLimit + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read + description: >- + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. type: object - CommonLanguageSettings: - description: Required information for every language. + AuthRequirement: + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + properties: + audiences: + type: string + description: >- + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + providerId: + description: >- + id from authentication provider. Example: provider_id: + bookstore_auth + type: string + id: AuthRequirement type: object + ListOperationsResponse: + description: The response message for Operations.ListOperations. properties: - destinations: - description: >- - The destination where API teams want this client library to be - published. + operations: type: array items: - type: string - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - referenceDocsUri: - deprecated: true + $ref: '#/components/schemas/Operation' description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest + A list of operations that matches the specified filter in the + request. + nextPageToken: + description: The standard List next-page token. type: string - id: CommonLanguageSettings - SystemParameter: + id: ListOperationsResponse + type: object + MetricDescriptor: type: object - description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. - id: SystemParameter properties: - name: + displayName: type: string description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - httpHeader: + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + labels: + description: >- + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array + metadata: + $ref: '#/components/schemas/MetricDescriptorMetadata' + description: Optional. Metadata which can be used to guide usage of the metric. + unit: type: string description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - urlQueryParameter: + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + metricKind: + description: >- + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + type: string + launchStage: + description: Optional. The launch stage of the metric definition. + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: string + type: type: string description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - Quota: - id: Quota - description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - type: object + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" + name: + description: The resource name of the metric descriptor. + type: string + description: + type: string + description: >- + A detailed description of the metric, which can be used in + documentation. + monitoredResourceTypes: + description: >- + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + type: array + items: + type: string + valueType: + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + description: >- + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. + type: string + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + id: MetricDescriptor + V1AddVisibilityLabelsResponse: + description: >- + Response message for the `AddVisibilityLabels` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. properties: - limits: + labels: type: array - description: List of QuotaLimit definitions for the service. - items: - $ref: '#/components/schemas/QuotaLimit' - metricRules: description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. + The updated set of visibility labels for this consumer on this + service. items: - $ref: '#/components/schemas/MetricRule' - type: array - DocumentationRule: - description: A documentation rule provides information about individual API elements. + type: string type: object - id: DocumentationRule + id: V1AddVisibilityLabelsResponse + HttpRule: properties: - disableReplacementWords: + selector: description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. + Selects a method to which this rule applies. Refer to selector for + syntax details. type: string - deprecationDescription: - description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. + put: type: string - description: - description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. + description: Maps to HTTP PUT. Used for replacing a resource. + delete: + type: string + description: Maps to HTTP DELETE. Used for deleting a resource. + patch: + type: string + description: Maps to HTTP PATCH. Used for updating a resource. + body: type: string - selector: description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + custom: + $ref: '#/components/schemas/CustomHttpPattern' + description: >- + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + get: type: string - MonitoringDestination: - properties: - metrics: + description: >- + Maps to HTTP GET. Used for listing and getting information about + resources. + additionalBindings: type: array + description: >- + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). items: - type: string + $ref: '#/components/schemas/HttpRule' + post: description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. - monitoredResource: + Maps to HTTP POST. Used for creating a resource or performing an + action. + type: string + responseBody: type: string description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - id: MonitoringDestination - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - type: object - GoSettings: - type: object - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: GoSettings - description: Settings for Go client libraries. - LoggingDestination: - id: LoggingDestination + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). + gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC method and one or more HTTP REST endpoints. It allows developers to + build a single API service that supports both gRPC APIs and REST APIs. + Many systems, including [Google + APIs](https://github.com/googleapis/googleapis), [Cloud + Endpoints](https://cloud.google.com/endpoints), [gRPC + Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + and use it for large scale production services. `HttpRule` defines the + schema of the gRPC/REST mapping. The mapping specifies how different + portions of the gRPC request message are mapped to the URL path, URL + query parameters, and HTTP request body. It also controls how the gRPC + response message is mapped to the HTTP response body. `HttpRule` is + typically specified as an `google.api.http` annotation on the gRPC + method. Each mapping specifies a URL path template and an HTTP method. + The path template may refer to one or more fields in the gRPC request + message, as long as each field is a non-repeated field with a primitive + (non-message) type. The path template controls how fields of the request + message are mapped to the URL path. Example: service Messaging { rpc + GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message + GetMessageRequest { string name = 1; // Mapped to URL path. } message + Message { string text = 1; // The resource content. } This enables an + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + "foo"))` Note that fields which are mapped to URL query parameters must + have a primitive type or a repeated primitive type or a non-repeated + message type. In the case of a repeated type, the parameter can be + repeated in the URL as `...?param=A¶m=B`. In the case of a message + type, each field of the message is mapped to a separate parameter, such + as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request + body, the `body` field specifies the mapping. Consider a REST update + method on the message resource collection: service Messaging { rpc + UpdateMessage(UpdateMessageRequest) returns (Message) { option + (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" + }; } } message UpdateMessageRequest { string message_id = 1; // mapped + to the URL Message message = 2; // mapped to the body } The following + HTTP JSON to RPC mapping is enabled, where the representation of the + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The + special name `*` can be used in the body mapping to define that every + field not bound by the path template should be mapped to the request + body. This enables the following alternative definition of the update + method: service Messaging { rpc UpdateMessage(Message) returns (Message) + { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: + "*" }; } } message Message { string message_id = 1; string text = 2; } + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using + `*` in the body mapping, it is not possible to have HTTP parameters, as + all fields not bound by the path end in the body. This makes this option + more rarely used in practice when defining REST APIs. The common usage + of `*` is in custom methods which don't use the URL at all for + transferring data. It is possible to define multiple HTTP methods for + one RPC by using the `additional_bindings` option. Example: service + Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/messages/{message_id}" + additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } + }; } } message GetMessageRequest { string message_id = 1; string user_id + = 2; } This enables the following two alternative HTTP JSON to RPC + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{var}`. If a variable contains multiple path segments, such as + `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a + URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` + are percent-encoded. The server side does the reverse decoding, except + "%2F" and "%2f" are left unchanged. Such variables show up in the + [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{+var}`. Using gRPC API Service Configuration gRPC API Service + Configuration (service config) is a configuration language for + configuring a gRPC service to become a user-facing product. The service + config is simply the YAML representation of the `google.api.Service` + proto message. As an alternative to annotating your proto file, you can + configure gRPC transcoding in your service config YAML files. You do + this by specifying a `HttpRule` that maps the gRPC method to a REST + endpoint, achieving the same effect as the proto annotation. This can be + particularly useful if you have a proto that is reused in multiple + services. Note that any transcoding specified in the service config will + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC + Transcoding is used to map a gRPC to JSON REST endpoints, the proto to + JSON conversion must follow the [proto3 + specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + While the single segment variable follows the semantics of [RFC + 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + Expansion, the multi segment variable **does not** follow RFC 6570 + Section 3.2.3 Reserved Expansion. The reason is that the Reserved + Expansion does not expand special characters like `?` and `#`, which + would lead to invalid URLs. As the result, gRPC Transcoding uses a + custom encoding for multi segment variables. The path variables **must + not** refer to any repeated or mapped field, because client libraries + are not capable of handling such variable expansion. The path variables + **must not** capture the leading "/" character. The reason is that the + most common use case "{var}" does not capture the leading "/" character. + For consistency, all path variables must share the same behavior. + Repeated message fields must not be mapped to URL query parameters, + because no client library can support such complicated mapping. If an + API needs to use a JSON array for request or response body, it can map + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. + id: HttpRule type: object + V1Beta1ProducerQuotaPolicy: + id: V1Beta1ProducerQuotaPolicy properties: - monitoredResource: - type: string - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - logs: - type: array - items: - type: string - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - Type: - properties: - oneofs: - items: + dimensions: + description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota polcies that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' + additionalProperties: type: string - type: array - description: The list of types appearing in `oneof` definitions in this type. - fields: - type: array - description: The list of fields. - items: - $ref: '#/components/schemas/Field' - options: - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array - name: - description: The fully qualified message name. - type: string - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. - type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - edition: + type: object + unit: type: string description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - description: A protocol buffer message type. - type: object - id: Type - ClientLibrarySettings: - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings - properties: - nodeSettings: - $ref: '#/components/schemas/NodeSettings' - description: Settings for Node client libraries. - version: - description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - type: string - launchStage: + The limit unit of the limit to which this policy applies. An example + unit would be: `1/{project}/{region}` Note that `{project}` and + `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. + container: type: string - description: Launch stage of this version of the API. - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - phpSettings: - description: Settings for PHP client libraries. - $ref: '#/components/schemas/PhpSettings' - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - dotnetSettings: - description: Settings for .NET client libraries. - $ref: '#/components/schemas/DotnetSettings' - cppSettings: - description: Settings for C++ client libraries. - $ref: '#/components/schemas/CppSettings' - rubySettings: - $ref: '#/components/schemas/RubySettings' - description: Settings for Ruby client libraries. - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. - restNumericEnums: - type: boolean - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - type: object - ContextRule: - id: ContextRule - properties: - provided: - items: - type: string - description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. - type: array - allowedResponseExtensions: - type: array - items: - type: string description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - allowedRequestExtensions: - type: array + The cloud resource container at which the quota policy is created. + The format is {container_type}/{container_number} + policyValue: + type: string description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - items: - type: string - selector: + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). + format: int64 + name: + type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + The resource name of the producer policy. An example name would be: + `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` + metric: type: string - requested: description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. - items: - type: string - type: array - type: object - description: >- - A context rule provides information about the context for an individual - API element. - V1Beta1DisableConsumerResponse: - id: V1Beta1DisableConsumerResponse - properties: {} + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` type: object - description: >- - Response message for the `DisableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. + description: Quota policy created by service producer. RubySettings: type: object - id: RubySettings + description: Settings for Ruby client libraries. properties: common: description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - description: Settings for Ruby client libraries. - SystemParameters: - type: object + id: RubySettings + Status: description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - id: SystemParameters + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: Status + type: object properties: - rules: - description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - type: array + code: + type: integer + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + details: items: - $ref: '#/components/schemas/SystemParameterRule' + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + CancelOperationRequest: + type: object + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + properties: {} Context: + id: Context + type: object description: >- `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - @@ -3387,259 +3412,224 @@ components: type: array items: $ref: '#/components/schemas/ContextRule' - id: Context + CustomError: type: object - Empty: + id: CustomError + properties: + rules: + items: + $ref: '#/components/schemas/CustomErrorRule' + description: >- + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array + types: + type: array + description: >- + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + items: + type: string 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); } - type: object - properties: {} - id: Empty - UndeleteTenantProjectRequest: + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + FieldPolicy: + id: FieldPolicy type: object - id: UndeleteTenantProjectRequest description: >- - Request message to undelete tenant project resource previously deleted - from the tenancy unit. + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. properties: - tag: - description: Required. Tag of the resource within the tenancy unit. + selector: type: string - JavaSettings: - properties: - serviceClassNames: - additionalProperties: - type: string - description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - type: object - libraryPackage: description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". + resourcePermission: type: string - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - id: JavaSettings - type: object - description: Settings for Java client libraries. - Service: - type: object - id: Service - properties: - sourceInfo: - $ref: '#/components/schemas/SourceInfo' description: >- - Output only. The source information for this configuration if - available. - producerProjectId: + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". + resourceType: type: string - description: The Google project that owns this service. - enums: - items: - $ref: '#/components/schemas/Enum' description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum - type: array - types: - type: array - description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - items: - $ref: '#/components/schemas/Type' - logs: - items: - $ref: '#/components/schemas/LogDescriptor' - type: array - description: Defines the logs used by this service. - context: - $ref: '#/components/schemas/Context' - description: Context configuration. - billing: - description: Billing configuration. - $ref: '#/components/schemas/Billing' - title: + Specifies the resource type for the resource referred to by the + field. + AddTenantProjectRequest: + description: >- + Request to add a newly created and configured tenant project to a + tenancy unit. + id: AddTenantProjectRequest + properties: + projectConfig: description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. + Configuration of the new tenant project to be added to tenancy unit + resources. + $ref: '#/components/schemas/TenantProjectConfig' + tag: type: string - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - endpoints: description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. - items: - $ref: '#/components/schemas/Endpoint' - type: array - apis: - items: - $ref: '#/components/schemas/Api' - type: array + Required. Tag of the added project. Must be less than 128 + characters. Required. + type: object + V1ServiceAccount: + type: object + description: A service account in the Identity and Access Management API. + id: V1ServiceAccount + properties: + email: + description: The email address of the service account. + type: string + uniqueId: + type: string + description: The unique and stable id of the service account. + name: description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. - control: - $ref: '#/components/schemas/Control' - description: Configuration for the service control plane. - configVersion: - format: uint32 + P4 SA resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` + type: string + iamAccountName: + type: string + deprecated: true + description: Deprecated. See b/136209818. + tag: + type: string description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - type: integer - id: + The P4 SA configuration tag. This must be defined in + activation_grants. If not specified when creating the account, the + tag is set to "default". + CppSettings: + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + type: object + id: CppSettings + description: Settings for C++ client libraries. + V1Beta1ServiceIdentity: + id: V1Beta1ServiceIdentity + description: A service identity in the Identity and Access Management API. + type: object + properties: + tag: type: string description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. - publishing: - description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - $ref: '#/components/schemas/Publishing' - systemTypes: - type: array - items: - $ref: '#/components/schemas/Type' - description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - monitoring: - description: Monitoring configuration. - $ref: '#/components/schemas/Monitoring' - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - systemParameters: - description: System parameter configuration. - $ref: '#/components/schemas/SystemParameters' - backend: - $ref: '#/components/schemas/Backend' - description: API backend configuration. + The P4 service identity configuration tag. This must be defined in + activation_grants. If not specified when creating the account, the + tag is set to "default". name: type: string description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - metrics: + P4 service identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` + uniqueId: + type: string + description: The unique and stable id of the service identity. + email: + description: The email address of the service identity. + type: string + SourceInfo: + properties: + sourceFiles: + description: All files used during config generation. items: - $ref: '#/components/schemas/MetricDescriptor' - description: Defines the metrics used by this service. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any type: array - authentication: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - logging: - description: Logging configuration. - $ref: '#/components/schemas/Logging' - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - monitoredResources: + description: Source information used to create a Service Config + type: object + id: SourceInfo + MethodPolicy: + properties: + selector: + type: string description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . + requestPolicies: + description: Policies that are applicable to the request message. items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' + $ref: '#/components/schemas/FieldPolicy' type: array + description: Defines policies applying to an RPC method. + type: object + id: MethodPolicy + V1Beta1DisableConsumerResponse: + id: V1Beta1DisableConsumerResponse + properties: {} + type: object description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth + Response message for the `DisableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + V1DefaultIdentity: + type: object + description: A default identity in the Identity and Access Management API. + properties: + uniqueId: + type: string + description: The unique and stable id of the default identity. + email: + type: string + description: The email address of the default identity. + name: + type: string + description: >- + Default identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` + tag: + type: string + description: >- + The Default Identity tag. If specified when creating the account, + the tag must be present in activation_grants. If not specified when + creating the account, the tag is set to the tag specified in + activation_grants. + id: V1DefaultIdentity parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: fields + name: oauth_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + _.xgafv: + description: V1 error format. in: query - name: uploadType + name: $.xgafv schema: type: string - alt: - description: Data format for response. + enum: + - '1' + - '2' + 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. in: query - name: alt + name: key schema: type: string - enum: - - json - - media - - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -3649,98 +3639,124 @@ components: name: quotaUser schema: type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string callback: description: JSONP in: query name: callback schema: type: string - _.xgafv: - description: V1 error format. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: $.xgafv + name: upload_protocol schema: type: string - enum: - - '1' - - '2' - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: key + name: uploadType schema: type: string - access_token: - description: OAuth access token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: access_token + name: prettyPrint + schema: + type: boolean + alt: + description: Data format for response. + in: query + name: alt schema: type: string + enum: + - json + - media + - proto x-stackQL-resources: - operations: - id: google.serviceconsumermanagement.operations - name: operations - title: Operations + services: + id: google.serviceconsumermanagement.services + name: services + title: Services methods: - cancel: + search: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' + $ref: '#/paths/~1v1~1services~1{servicesId}:search/get' response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + tenancy_units_project: + id: google.serviceconsumermanagement.tenancy_units_project + name: tenancy_units_project + title: Tenancy_units_project + methods: + delete_project: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post response: mediaType: application/json openAPIDocKey: '200' - delete: + add_project: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:addProject/post response: mediaType: application/json openAPIDocKey: '200' - list: + remove_project: operation: - $ref: '#/paths/~1v1~1operations/get' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:removeProject/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/tenancy_units_project/methods/add_project update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/tenancy_units_project/methods/delete_project + - $ref: >- + #/components/x-stackQL-resources/tenancy_units_project/methods/remove_project tenancy_units: id: google.serviceconsumermanagement.tenancy_units name: tenancy_units title: Tenancy_units methods: - attach_project: + apply_project_config: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:attachProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:applyProjectConfig/post response: mediaType: application/json openAPIDocKey: '200' - undelete_project: + create: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/post response: mediaType: application/json openAPIDocKey: '200' @@ -3752,17 +3768,17 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.tenancyUnits - create: + undelete_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post response: mediaType: application/json openAPIDocKey: '200' - apply_project_config: + attach_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:applyProjectConfig/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:attachProject/post response: mediaType: application/json openAPIDocKey: '200' @@ -3782,143 +3798,62 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/tenancy_units/methods/delete' - tenancy_units_project: - id: google.serviceconsumermanagement.tenancy_units_project - name: tenancy_units_project - title: Tenancy_units_project + operations: + id: google.serviceconsumermanagement.operations + name: operations + title: Operations methods: - add_project: + list: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:addProject/post + $ref: '#/paths/~1v1~1operations/get' response: mediaType: application/json openAPIDocKey: '200' - remove_project: + objectKey: $.operations + cancel: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:removeProject/post + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' response: mediaType: application/json openAPIDocKey: '200' - delete_project: + delete: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/tenancy_units_project/methods/add_project - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/tenancy_units_project/methods/remove_project - - $ref: >- - #/components/x-stackQL-resources/tenancy_units_project/methods/delete_project - services: - id: google.serviceconsumermanagement.services - name: services - title: Services - methods: - search: + get: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:search/get' + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] replace: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: - /v1/operations/{operationsId}:cancel: + /v1/services/{servicesId}:search: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' - post: - 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`. - operationId: serviceconsumermanagement.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: operationsId - required: true - schema: - type: string - /v1/operations/{operationsId}: - parameters: *ref_1 + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' 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. - operationId: serviceconsumermanagement.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: operationsId - required: true - schema: - type: string - 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`. - operationId: serviceconsumermanagement.operations.delete + description: Search tenancy units for a managed service. + operationId: serviceconsumermanagement.services.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3930,66 +3865,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/SearchTenancyUnitsResponse' parameters: - in: path - name: operationsId + name: servicesId required: true schema: type: string - /v1/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: serviceconsumermanagement.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOperationsResponse' - parameters: - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: query schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: parameters: *ref_1 post: description: >- - Attach an existing project to the tenancy unit as a new tenant resource. - The project could either be the tenant project reserved by calling - `AddTenantProject` under a tenancy unit of a service producer's project - of a managed service, or from a separate project. The caller is checked - against a set of permissions as if calling `AddTenantProject` on the - same service consumer. To trigger the attachment, the targeted tenant - project must be in a folder. Make sure the ServiceConsumerManagement - service account is the owner of that project. These two requirements are - already met if the project is reserved by calling `AddTenantProject`. - Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.attachProject + Deletes the specified project resource identified by a tenant resource + tag. The mothod removes a project lien with a 'TenantManager' origin if + that was added. It will then attempt to delete the project. If that + operation fails, this method also fails. After the project has been + deleted, the tenant resource state is set to DELETED. To permanently + remove resource metadata, call the `RemoveTenantProject` method. New + resources with the same tag can't be added if there are existing + resources in a DELETED state. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.deleteProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/AttachTenantProjectRequest' + $ref: '#/components/schemas/DeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4023,21 +3936,30 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: parameters: *ref_1 post: description: >- - Attempts to undelete a previously deleted tenant project. The project - must be in a DELETED state. There are no guarantees that an undeleted - project will be in a fully restored and functional state. Call the - `ApplyTenantProjectConfig` method to update its configuration and then - validate all managed service resources. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.undeleteProject + Apply a configuration to an existing tenant project. This project must + exist in an active state and have the original owner account. The caller + must have permission to add a project to the given tenancy unit. The + configuration is applied, but any existing settings on the project + aren't modified. Specified policy bindings are applied. Existing + bindings aren't modified. Specified services are activated. No service + is deactivated. If specified, new billing configuration is applied. Omit + a billing configuration to keep the existing one. A service account in + the project is created if previously non existed. Specified labels will + be appended to tenant project, note that the value of existing label key + will be updated if the same label key is requested. The specified folder + is ignored, as moving a tenant project to a different folder isn't + supported. The operation fails if any of the steps fail, but no rollback + of already applied configuration changes is attempted. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.applyProjectConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteTenantProjectRequest' + $ref: '#/components/schemas/ApplyTenantProjectConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4071,21 +3993,20 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits: parameters: *ref_1 post: description: >- - Add a new tenant project to the tenancy unit. There can be a maximum of - 1024 tenant projects in a tenancy unit. If there are previously failed - `AddTenantProject` calls, you might need to call `RemoveTenantProject` - first to resolve them before you can make another call to - `AddTenantProject` with the same tag. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.addProject + Creates a tenancy unit with no tenant resources. If tenancy unit already + exists, it will be returned, however, in this case, returned TenancyUnit + does not have tenant_resources field set and ListTenancyUnits has to be + used to get a complete TenancyUnit with all fields populated. + operationId: serviceconsumermanagement.services.tenancyUnits.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddTenantProjectRequest' + $ref: '#/components/schemas/CreateTenancyUnitRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4097,7 +4018,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TenancyUnit' parameters: - in: path name: servicesId @@ -4114,13 +4035,6 @@ paths: required: true schema: type: string - - in: path - name: tenancyUnitsId - required: true - schema: - type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits: - parameters: *ref_1 get: description: >- Find the tenancy unit for a managed service and service consumer. This @@ -4157,6 +4071,10 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: @@ -4166,22 +4084,21 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject: + parameters: *ref_1 post: description: >- - Creates a tenancy unit with no tenant resources. If tenancy unit already - exists, it will be returned, however, in this case, returned TenancyUnit - does not have tenant_resources field set and ListTenancyUnits has to be - used to get a complete TenancyUnit with all fields populated. - operationId: serviceconsumermanagement.services.tenancyUnits.create + Add a new tenant project to the tenancy unit. There can be a maximum of + 1024 tenant projects in a tenancy unit. If there are previously failed + `AddTenantProject` calls, you might need to call `RemoveTenantProject` + first to resolve them before you can make another call to + `AddTenantProject` with the same tag. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.addProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateTenancyUnitRequest' + $ref: '#/components/schemas/AddTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4193,7 +4110,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenancyUnit' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -4210,23 +4127,26 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: + - in: path + name: tenancyUnitsId + required: true + schema: + type: string + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: parameters: *ref_1 post: description: >- - Removes the specified project resource identified by a tenant resource - tag. The method removes the project lien with 'TenantManager' origin if - that was added. It then attempts to delete the project. If that - operation fails, this method also fails. Calls to remove already removed - or non-existent tenant project succeed. After the project has been - deleted, or if was already in a DELETED state, resource metadata is - permanently removed from the tenancy unit. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.removeProject + Attempts to undelete a previously deleted tenant project. The project + must be in a DELETED state. There are no guarantees that an undeleted + project will be in a fully restored and functional state. Call the + `ApplyTenantProjectConfig` method to update its configuration and then + validate all managed service resources. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.undeleteProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveTenantProjectRequest' + $ref: '#/components/schemas/UndeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4260,30 +4180,26 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: parameters: *ref_1 post: description: >- - Apply a configuration to an existing tenant project. This project must - exist in an active state and have the original owner account. The caller - must have permission to add a project to the given tenancy unit. The - configuration is applied, but any existing settings on the project - aren't modified. Specified policy bindings are applied. Existing - bindings aren't modified. Specified services are activated. No service - is deactivated. If specified, new billing configuration is applied. Omit - a billing configuration to keep the existing one. A service account in - the project is created if previously non existed. Specified labels will - be appended to tenant project, note that the value of existing label key - will be updated if the same label key is requested. The specified folder - is ignored, as moving a tenant project to a different folder isn't - supported. The operation fails if any of the steps fail, but no rollback - of already applied configuration changes is attempted. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.applyProjectConfig + Attach an existing project to the tenancy unit as a new tenant resource. + The project could either be the tenant project reserved by calling + `AddTenantProject` under a tenancy unit of a service producer's project + of a managed service, or from a separate project. The caller is checked + against a set of permissions as if calling `AddTenantProject` on the + same service consumer. To trigger the attachment, the targeted tenant + project must be in a folder. Make sure the ServiceConsumerManagement + service account is the owner of that project. These two requirements are + already met if the project is reserved by calling `AddTenantProject`. + Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.attachProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplyTenantProjectConfigRequest' + $ref: '#/components/schemas/AttachTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4317,13 +4233,23 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: parameters: *ref_1 - delete: + post: description: >- - Delete a tenancy unit. Before you delete the tenancy unit, there should - be no tenant resources in it that aren't in a DELETED state. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.delete + Removes the specified project resource identified by a tenant resource + tag. The method removes the project lien with 'TenantManager' origin if + that was added. It then attempts to delete the project. If that + operation fails, this method also fails. Calls to remove already removed + or non-existent tenant project succeed. After the project has been + deleted, or if was already in a DELETED state, resource metadata is + permanently removed from the tenancy unit. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.removeProject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4357,24 +4283,13 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}: parameters: *ref_1 - post: + delete: description: >- - Deletes the specified project resource identified by a tenant resource - tag. The mothod removes a project lien with a 'TenantManager' origin if - that was added. It will then attempt to delete the project. If that - operation fails, this method also fails. After the project has been - deleted, the tenant resource state is set to DELETED. To permanently - remove resource metadata, call the `RemoveTenantProject` method. New - resources with the same tag can't be added if there are existing - resources in a DELETED state. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.deleteProject - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteTenantProjectRequest' + Delete a tenancy unit. Before you delete the tenancy unit, there should + be no tenant resources in it that aren't in a DELETED state. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4408,11 +4323,13 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:search: + /v1/operations: parameters: *ref_1 get: - description: Search tenancy units for a managed service. - operationId: serviceconsumermanagement.services.search + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: serviceconsumermanagement.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4424,23 +4341,106 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchTenancyUnitsResponse' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: path - name: servicesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - in: query name: pageToken schema: type: string - - in: query - name: query + /v1/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + 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`. + operationId: serviceconsumermanagement.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: operationsId + required: true schema: type: string - - in: query - name: pageSize + /v1/operations/{operationsId}: + parameters: *ref_1 + 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`. + operationId: serviceconsumermanagement.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 + 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. + operationId: serviceconsumermanagement.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml index 1bb80dfc..fbd8b47d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml @@ -25,10 +25,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/service.management: Manage your Google API service configuration https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. - https://www.googleapis.com/auth/service.management: Manage your Google API service configuration Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -38,348 +38,134 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - MethodSettings: - type: object + MethodPolicy: properties: selector: - type: string - description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... - longRunning: - $ref: '#/components/schemas/LongRunning' description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - autoPopulatedFields: + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . + type: string + requestPolicies: items: - type: string + $ref: '#/components/schemas/FieldPolicy' + description: Policies that are applicable to the request message. type: array - description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id - description: Describes the generator configuration for a method. - id: MethodSettings - QuotaLimit: + description: Defines policies applying to an RPC method. + id: MethodPolicy + type: object + ValidateConsumerConfigResponse: type: object - id: QuotaLimit properties: - maxLimit: - format: int64 - type: string + isValid: + type: boolean + description: Indicates whether all the requested validations passed. + existingSubnetworkCandidates: + items: + $ref: '#/components/schemas/Subnetwork' description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - duration: + List of subnetwork candidates from the request which exist with the + `ip_cidr_range`, `secondary_ip_cider_ranges`, and + `outside_allocation` fields set. + type: array + validationError: + enum: + - VALIDATION_ERROR_UNSPECIFIED + - VALIDATION_NOT_REQUESTED + - SERVICE_NETWORKING_NOT_ENABLED + - NETWORK_NOT_FOUND + - NETWORK_NOT_PEERED + - NETWORK_PEERING_DELETED + - NETWORK_NOT_IN_CONSUMERS_PROJECT + - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT + - HOST_PROJECT_NOT_FOUND + - CONSUMER_PROJECT_NOT_SERVICE_PROJECT + - RANGES_EXHAUSTED + - RANGES_NOT_RESERVED + - RANGES_DELETED_LATER + - COMPUTE_API_NOT_ENABLED + - USE_PERMISSION_NOT_FOUND + enumDescriptions: + - '' + - In case none of the validations are requested. + - '' + - The network provided by the consumer does not exist. + - The network has not been peered with the producer org. + - The peering was created and later deleted. + - >- + The network is a regular VPC but the network is not in the + consumer's project. + - >- + The consumer project is a service project, and network is a shared + VPC, but the network is not in the host project of this consumer + project. + - >- + The host project associated with the consumer project was not + found. + - >- + The consumer project is not a service project for the specified + host project. + - >- + The reserved IP ranges do not have enough space to create a subnet + of desired size. + - The IP ranges were not reserved. + - The IP ranges were reserved but deleted later. + - The consumer project does not have the compute api enabled. + - >- + The consumer project does not have the permission from the host + project. + description: The first validation which failed. type: string + id: ValidateConsumerConfigResponse + RangeReservation: + description: Represents a range reservation. + properties: + secondaryRangeIpPrefixLengths: + type: array description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - unit: - description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. - type: string - name: - type: string + Optional. The size of the desired secondary ranges for the subnet. + Use usual CIDR range notation. For example, '29' to find unused + x.x.x.x/29 CIDR range. The goal is to determine that the allocated + ranges have enough free space for all the requested secondary + ranges. GCE disallows subnets with prefix_length > 29 + items: + format: int32 + type: integer + ipPrefixLength: + format: int32 + type: integer description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. - defaultLimit: + Required. The size of the desired subnet. Use usual CIDR range + notation. For example, '29' to find unused x.x.x.x/29 CIDR range. + The goal is to determine if one of the allocated ranges has enough + free space for a subnet of the requested size. GCE disallows subnets + with prefix_length > 29 + subnetworkCandidates: description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - format: int64 - type: string - freeTier: + Optional. List of subnetwork candidates to validate. The required + input fields are `name`, `network`, and `region`. Subnetworks from + this list which exist will be returned in the response with the + `ip_cidr_range`, `secondary_ip_cider_ranges`, and + `outside_allocation` fields set. + items: + $ref: '#/components/schemas/Subnetwork' + type: array + requestedRanges: description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - format: int64 - type: string - values: - additionalProperties: + Optional. The name of one or more allocated IP address ranges + associated with this private service access connection. If no range + names are provided all ranges associated with this connection will + be considered. If a CIDR range with the specified IP prefix length + is not available within these ranges the validation fails. + type: array + items: type: string - format: int64 - description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - type: object - displayName: - description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - type: string - description: - description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). - type: string - metric: - description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - type: string - description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - CustomErrorRule: + id: RangeReservation type: object - description: A custom error rule. - id: CustomErrorRule - properties: - selector: - type: string - description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. - isErrorType: - type: boolean - description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - Control: + MonitoredResourceDescriptor: type: object - properties: - methodPolicies: - items: - $ref: '#/components/schemas/MethodPolicy' - type: array - description: Defines policies applying to the API methods of the service. - environment: - type: string - description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com - description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - id: Control - SystemParameters: - type: object - properties: - rules: - type: array - description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - items: - $ref: '#/components/schemas/SystemParameterRule' - id: SystemParameters - description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - CloudSQLConfig: - properties: - umbrellaNetwork: - type: string - description: The name of the umbrella network in the Cloud SQL umbrella project. - umbrellaProject: - type: string - format: int64 - description: The project number of the Cloud SQL umbrella project. - service: - description: Peering service used for peering with the Cloud SQL project. - type: string - type: object - id: CloudSQLConfig - description: Cloud SQL configuration. - AuthRequirement: - properties: - providerId: - type: string - description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - audiences: - type: string - description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - id: AuthRequirement - type: object - description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - ConsumerConfigMetadata: - type: object - id: ConsumerConfigMetadata - properties: {} - description: >- - Metadata provided through GetOperation request for the LRO generated by - UpdateConsumerConfig API. - Documentation: - description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. - properties: - serviceRootUrl: - description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. - type: string - documentationRootUrl: - type: string - description: The URL to the root of documentation. - sectionOverrides: - items: - $ref: '#/components/schemas/Page' - type: array - description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - summary: - description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. - type: string - overview: - type: string - description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. - rules: - description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/DocumentationRule' - type: array - pages: - items: - $ref: '#/components/schemas/Page' - description: The top level pages for the documentation set. - type: array - type: object - id: Documentation - SystemParameter: - type: object - properties: - httpHeader: - description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - type: string - urlQueryParameter: - type: string - description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - name: - description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - type: string - id: SystemParameter - description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. - MonitoredResourceDescriptor: description: >- An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource @@ -388,27 +174,17 @@ components: `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API. - type: object properties: - name: - type: string + type: description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). + type: string launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -447,13 +223,40 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string description: Optional. The launch stage of the monitored resource definition. - description: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: string + name: type: string + description: >- + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + labels: + type: array + items: + $ref: '#/components/schemas/LabelDescriptor' + description: >- + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + description: description: >- Optional. A detailed description of the monitored resource type that might be used in documentation. + type: string displayName: type: string description: >- @@ -461,364 +264,196 @@ components: be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. - type: - description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). + id: MonitoredResourceDescriptor + LongRunning: + id: LongRunning + properties: + maxPollDelay: + format: google-duration type: string - labels: - items: - $ref: '#/components/schemas/LabelDescriptor' - type: array description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. - id: MonitoredResourceDescriptor - SourceInfo: - id: SourceInfo - description: Source information used to create a Service Config + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + totalPollTimeout: + description: 'Total polling timeout. Default value: 5 minutes.' + type: string + format: google-duration + initialPollDelay: + format: google-duration + type: string + description: >- + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + pollDelayMultiplier: + type: number + description: >- + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + format: float + description: >- + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). type: object + Documentation: properties: - sourceFiles: + pages: items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + $ref: '#/components/schemas/Page' type: array - description: All files used during config generation. - ListDnsRecordSetsResponse: - id: ListDnsRecordSetsResponse - description: Represents all DNS RecordSets associated with the producer network - properties: - dnsRecordSets: + description: The top level pages for the documentation set. + documentationRootUrl: + type: string + description: The URL to the root of documentation. + serviceRootUrl: + description: >- + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. + type: string + rules: + items: + $ref: '#/components/schemas/DocumentationRule' + description: >- + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. type: array + sectionOverrides: items: - $ref: '#/components/schemas/DnsRecordSet' - description: DNS record Set Resource - type: object - BackendRule: - properties: - protocol: + $ref: '#/components/schemas/Page' + type: array description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries + overview: + description: >- + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. type: string - minDeadline: - description: Deprecated, do not use. - deprecated: true - format: double - type: number - address: + summary: type: string description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - pathTranslation: + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. + type: object + description: >- + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. + id: Documentation + CloudSQLConfig: + description: Cloud SQL configuration. + id: CloudSQLConfig + properties: + umbrellaProject: + format: int64 type: string - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST - jwtAudience: - description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. + description: The project number of the Cloud SQL umbrella project. + umbrellaNetwork: type: string - overridesByRequestProtocol: - additionalProperties: - $ref: '#/components/schemas/BackendRule' - type: object - description: The map between request protocol and the backend address. - deadline: - description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - format: double - type: number - operationDeadline: - description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - type: number - format: double - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + description: The name of the umbrella network in the Cloud SQL umbrella project. + service: type: string - disableAuth: - type: boolean - description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. + description: Peering service used for peering with the Cloud SQL project. type: object - id: BackendRule - description: A backend rule provides configuration for an individual API element. - ValidateConsumerConfigResponse: - id: ValidateConsumerConfigResponse + BillingDestination: + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + id: BillingDestination properties: - existingSubnetworkCandidates: + metrics: type: array + description: >- + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. items: - $ref: '#/components/schemas/Subnetwork' + type: string + monitoredResource: + type: string description: >- - List of subnetwork candidates from the request which exist with the - `ip_cidr_range`, `secondary_ip_cider_ranges`, and - `outside_allocation` fields set. - isValid: - description: Indicates whether all the requested validations passed. - type: boolean - validationError: - enum: - - VALIDATION_ERROR_UNSPECIFIED - - VALIDATION_NOT_REQUESTED - - SERVICE_NETWORKING_NOT_ENABLED - - NETWORK_NOT_FOUND - - NETWORK_NOT_PEERED - - NETWORK_PEERING_DELETED - - NETWORK_NOT_IN_CONSUMERS_PROJECT - - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT - - HOST_PROJECT_NOT_FOUND - - CONSUMER_PROJECT_NOT_SERVICE_PROJECT - - RANGES_EXHAUSTED - - RANGES_NOT_RESERVED - - RANGES_DELETED_LATER - - COMPUTE_API_NOT_ENABLED - - USE_PERMISSION_NOT_FOUND - enumDescriptions: - - '' - - In case none of the validations are requested. - - '' - - The network provided by the consumer does not exist. - - The network has not been peered with the producer org. - - The peering was created and later deleted. - - >- - The network is a regular VPC but the network is not in the - consumer's project. - - >- - The consumer project is a service project, and network is a shared - VPC, but the network is not in the host project of this consumer - project. - - >- - The host project associated with the consumer project was not - found. - - >- - The consumer project is not a service project for the specified - host project. - - >- - The reserved IP ranges do not have enough space to create a subnet - of desired size. - - The IP ranges were not reserved. - - The IP ranges were reserved but deleted later. - - The consumer project does not have the compute api enabled. - - >- - The consumer project does not have the permission from the host - project. - type: string - description: The first validation which failed. - type: object - Route: + The monitored resource type. The type must be defined in + Service.monitored_resources section. type: object + CustomError: + id: CustomError description: >- - Represents a route that was created or discovered by a private access - management service. - properties: - network: - type: string - description: >- - Fully-qualified URL of the VPC network in the producer host tenant - project that this route applies to. For example: - `projects/123456/global/networks/host-network` - name: - description: Route name. See https://cloud.google.com/vpc/docs/routes - type: string - destRange: - description: Destination CIDR range that this route applies to. - type: string - nextHopGateway: - description: >- - Fully-qualified URL of the gateway that should handle matching - packets that this route applies to. For example: - `projects/123456/global/gateways/default-internet-gateway` - type: string - id: Route - UpdateDnsRecordSetRequest: - description: >- - Request to update a record set from a private managed DNS zone in the - shared producer host project. The name, type, ttl, and data values of - the existing record set must all exactly match an existing record set in - the specified zone. - id: UpdateDnsRecordSetRequest + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError properties: - newDnsRecordSet: - $ref: '#/components/schemas/DnsRecordSet' - description: >- - Required. The new values that the DNS record set should be updated - to hold. - consumerNetwork: + types: + items: + type: string + type: array description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - type: string - zone: - type: string + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + rules: + items: + $ref: '#/components/schemas/CustomErrorRule' description: >- - Required. The name of the private DNS zone in the shared producer - host project from which the record set will be removed. - existingDnsRecordSet: - description: Required. The existing DNS record set to update. - $ref: '#/components/schemas/DnsRecordSet' + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array type: object - LogDescriptor: - id: LogDescriptor + AddRolesRequest: type: object + id: AddRolesRequest + description: >- + Request for AddRoles to allow Service Producers to add roles in the + shared VPC host project for them to use. properties: - displayName: - description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - type: string - labels: + policyBinding: type: array items: - $ref: '#/components/schemas/LabelDescriptor' - description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - name: - description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - type: string - description: - type: string - description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer - OAuthRequirements: - id: OAuthRequirements - type: object - description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. - properties: - canonicalScopes: - type: string - description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read - UsageRule: - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true - type: object - id: UsageRule - properties: - skipServiceControl: - type: boolean - description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - allowUnregisteredCalls: + $ref: '#/components/schemas/PolicyBinding' + description: Required. List of policy bindings to add to shared VPC host project. + consumerNetwork: description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - type: boolean - selector: + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is a network name. type: string - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. PolicyBinding: properties: member: @@ -842,394 +477,459 @@ components: project - 'roles/monitoring.viewer' applied on the shared VPC host project - 'roles/servicemanagement.quotaViewer' applied on the shared VPC host project - description: Grouping of IAM role and IAM member. type: object id: PolicyBinding - NodeSettings: - id: NodeSettings - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' + description: Grouping of IAM role and IAM member. + AddRolesResponse: type: object - description: Settings for Node client libraries. - MonitoringDestination: + description: Represents IAM roles added to the shared VPC host project. + id: AddRolesResponse properties: - monitoredResource: - type: string - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - metrics: - type: array + policyBinding: items: - type: string + $ref: '#/components/schemas/PolicyBinding' description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. - id: MonitoringDestination - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - type: object - AddDnsZoneMetadata: - id: AddDnsZoneMetadata + Required. List of policy bindings that were added to the shared VPC + host project. + type: array + AddDnsZoneRequest: + id: AddDnsZoneRequest description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsZone API + Request to add a private managed DNS zone in the shared producer host + project and a matching DNS peering zone in the consumer project. type: object - properties: {} - Quota: properties: - limits: - items: - $ref: '#/components/schemas/QuotaLimit' - description: List of QuotaLimit definitions for the service. - type: array - metricRules: + name: + type: string description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - type: array - items: - $ref: '#/components/schemas/MetricRule' - type: object - description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - id: Quota - CommonLanguageSettings: + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. Must be + unique within both projects. The name must be 1-63 characters long, + must begin with a letter, end with a letter or digit, and only + contain lowercase letters, digits or dashes. + dnsSuffix: + description: >- + Required. The DNS name suffix for the zones e.g. `example.com.`. + Cloud DNS requires that a DNS suffix ends with a trailing dot. + type: string + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + type: string + DnsZone: + id: DnsZone type: object - description: Required information for every language. properties: - selectiveGapicGeneration: - $ref: '#/components/schemas/SelectiveGapicGeneration' + name: description: >- - Configuration for which RPCs should be generated in the GAPIC - client. - referenceDocsUri: + User assigned name for this resource. Must be unique within the + project. The name must be 1-63 characters long, must begin with a + letter, end with a letter or digit, and only contain lowercase + letters, digits or dashes. + type: string + dnsSuffix: type: string description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - deprecated: true - destinations: + The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS + requires that a DNS suffix ends with a trailing dot. + description: Represents a DNS zone resource. + Monitoring: + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + type: object + properties: + producerDestinations: + description: >- + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + items: + $ref: '#/components/schemas/MonitoringDestination' type: array + consumerDestinations: items: - type: string - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER + $ref: '#/components/schemas/MonitoringDestination' description: >- - The destination where API teams want this client library to be - published. - id: CommonLanguageSettings - DnsZonePair: + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + type: array + id: Monitoring + GetDnsZoneResponse: + id: GetDnsZoneResponse + description: >- + Represents managed DNS zones created in the shared Producer host and + consumer projects. type: object - description: '* Represents a pair of private and peering DNS zone resources. *' - id: DnsZonePair properties: producerPrivateZone: - description: The private DNS zone in the shared producer host project. + description: The private DNS zone created in the shared producer host project. $ref: '#/components/schemas/DnsZone' consumerPeeringZone: - description: The DNS peering zone in the consumer project. $ref: '#/components/schemas/DnsZone' - VpcServiceControls: + description: The DNS peering zone created in the consumer project. + ListConnectionsResponse: + description: >- + ListConnectionsResponse is the response to list peering states for the + given service and consumer project. + properties: + connections: + items: + $ref: '#/components/schemas/Connection' + type: array + description: The list of Connections. + id: ListConnectionsResponse type: object + MetricRule: + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. properties: - enabled: + selector: description: >- - Output only. Indicates whether the VPC Service Controls are enabled - or disabled for the connection. If the consumer called the - EnableVpcServiceControls method, then this is true. If the consumer - called DisableVpcServiceControls, then this is false. The default is - false. - type: boolean - readOnly: true - id: VpcServiceControls - description: Response for the get VPC Service Controls request. - PartialDeleteConnectionMetadata: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + metricCosts: + additionalProperties: + format: int64 + type: string + description: >- + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + type: object + id: MetricRule + type: object + SecondaryIpRange: + type: object + id: SecondaryIpRange + properties: + rangeName: + description: Name of the secondary IP range. + type: string + ipCidrRange: + type: string + description: Secondary IP CIDR range in `x.x.x.x/y` format. + PeeredDnsDomainMetadata: + id: PeeredDnsDomainMetadata type: object - id: PartialDeleteConnectionMetadata properties: {} description: >- Metadata provided through GetOperation request for the LRO generated by - Partial Delete Connection API - RemoveDnsRecordSetResponse: - description: Blank message response type for RemoveDnsRecordSet API - properties: {} + CreatePeeredDnsDomain API. + ExperimentalFeatures: + properties: + restAsyncIoEnabled: + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + id: ExperimentalFeatures type: object - id: RemoveDnsRecordSetResponse - UpdateDnsRecordSetMetadata: - id: UpdateDnsRecordSetMetadata - properties: {} + DeleteConnectionRequest: type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - UpdateDnsRecordSet API - Type: - description: A protocol buffer message type. - id: Type properties: - name: - description: The fully qualified message name. - type: string - edition: + consumerNetwork: type: string description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - syntax: - description: The source syntax. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - fields: - description: The list of fields. - items: - $ref: '#/components/schemas/Field' - type: array - oneofs: - type: array - description: The list of types appearing in `oneof` definitions in this type. - items: - type: string - options: - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is a network name. + description: >- + Request to delete a private service access connection. The call will + fail if there are any managed service instances using this connection. + id: DeleteConnectionRequest + ConsumerConfigMetadata: + description: >- + Metadata provided through GetOperation request for the LRO generated by + UpdateConsumerConfig API. + properties: {} type: object - Endpoint: + id: ConsumerConfigMetadata + Service: properties: - aliases: + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + backend: + $ref: '#/components/schemas/Backend' + description: API backend configuration. + id: description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + type: string + systemTypes: + description: >- + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. items: - type: string + $ref: '#/components/schemas/Type' type: array name: - type: string - description: The canonical name of this endpoint. - allowCors: - type: boolean description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - target: + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. type: string + enums: + items: + $ref: '#/components/schemas/Enum' + type: array description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". - type: object - description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true - id: Endpoint - Range: - properties: - network: - type: string + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + endpoints: + items: + $ref: '#/components/schemas/Endpoint' description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` - ipCidrRange: + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + type: array + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + publishing: + $ref: '#/components/schemas/Publishing' description: >- - CIDR range in "10.x.x.x/y" format that is within the allocated - ranges and currently unused. + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + logs: + description: Defines the logs used by this service. + items: + $ref: '#/components/schemas/LogDescriptor' + type: array + producerProjectId: + description: The Google project that owns this service. type: string - id: Range - description: Represents a found unused range. - type: object - Page: - type: object - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - properties: - content: + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + control: + $ref: '#/components/schemas/Control' + description: Configuration for the service control plane. + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. + billing: + description: Billing configuration. + $ref: '#/components/schemas/Billing' + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + title: type: string description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. - name: + The product title for this service, it is the name displayed in + Google Cloud Console. + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + configVersion: + type: integer + format: uint32 description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - type: string - subpages: - type: array + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + sourceInfo: + $ref: '#/components/schemas/SourceInfo' description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. + Output only. The source information for this configuration if + available. + types: items: - $ref: '#/components/schemas/Page' - id: Page - FieldPolicy: - properties: - resourceType: - type: string + $ref: '#/components/schemas/Type' description: >- - Specifies the resource type for the resource referred to by the - field. - selector: - type: string + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 + type: array + metrics: + description: Defines the metrics used by this service. + type: array + items: + $ref: '#/components/schemas/MetricDescriptor' + monitoredResources: + type: array + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". - resourcePermission: - type: string + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + systemParameters: + description: System parameter configuration. + $ref: '#/components/schemas/SystemParameters' + apis: description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - type: object - id: FieldPolicy + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + items: + $ref: '#/components/schemas/Api' + type: array + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. - Operation: - id: Operation + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth type: object + id: Service + ListDnsZonesResponse: description: >- - This resource represents a long-running operation that is the result of - a network API call. + Represents all DNS zones in the shared producer host project and the + matching peering zones in the consumer project. + id: ListDnsZonesResponse properties: - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - metadata: + dnsZonePairs: + type: array + items: + $ref: '#/components/schemas/DnsZonePair' description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - name: - type: string + All pairs of private DNS zones in the shared producer host project + and the matching peering zones in the consumer project.. + type: object + DnsZonePair: + description: '* Represents a pair of private and peering DNS zone resources. *' + id: DnsZonePair + type: object + properties: + consumerPeeringZone: + $ref: '#/components/schemas/DnsZone' + description: The DNS peering zone in the consumer project. + producerPrivateZone: + $ref: '#/components/schemas/DnsZone' + description: The private DNS zone in the shared producer host project. + SystemParameterRule: + properties: + parameters: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - done: - type: boolean + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. + items: + $ref: '#/components/schemas/SystemParameter' + type: array + selector: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: - $ref: '#/components/schemas/Status' + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + type: string + type: object + id: SystemParameterRule + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + Backend: + properties: + rules: description: >- - The error result of the operation in case of failure or - cancellation. + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/BackendRule' + type: array + description: '`Backend` defines the backend configuration for a service.' + type: object + id: Backend RemoveDnsRecordSetRequest: + type: object id: RemoveDnsRecordSetRequest description: >- Request to remove a record set from a private managed DNS zone in the shared producer host project. The name, type, ttl, and data values must all exactly match an existing record set in the specified zone. - type: object properties: dnsRecordSet: - description: Required. The DNS record set to remove. $ref: '#/components/schemas/DnsRecordSet' + description: Required. The DNS record set to remove. consumerNetwork: type: string description: >- @@ -1242,1265 +942,1408 @@ components: description: >- Required. The name of the private DNS zone in the shared producer host project from which the record set will be removed. - HttpRule: - id: HttpRule + LogDescriptor: + properties: + description: + type: string + description: >- + A human-readable description of this log. This information appears + in the documentation and can contain details. + name: + type: string + description: >- + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + displayName: + description: >- + The human-readable name for this log. This information appears on + the user interface and should be concise. + type: string + labels: + description: >- + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array description: >- - gRPC Transcoding gRPC Transcoding is a feature for mapping between a - gRPC method and one or more HTTP REST endpoints. It allows developers to - build a single API service that supports both gRPC APIs and REST APIs. - Many systems, including [Google - APIs](https://github.com/googleapis/googleapis), [Cloud - Endpoints](https://cloud.google.com/endpoints), [gRPC - Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - and use it for large scale production services. `HttpRule` defines the - schema of the gRPC/REST mapping. The mapping specifies how different - portions of the gRPC request message are mapped to the URL path, URL - query parameters, and HTTP request body. It also controls how the gRPC - response message is mapped to the HTTP response body. `HttpRule` is - typically specified as an `google.api.http` annotation on the gRPC - method. Each mapping specifies a URL path template and an HTTP method. - The path template may refer to one or more fields in the gRPC request - message, as long as each field is a non-repeated field with a primitive - (non-message) type. The path template controls how fields of the request - message are mapped to the URL path. Example: service Messaging { rpc - GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message - GetMessageRequest { string name = 1; // Mapped to URL path. } message - Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request - message which are not bound by the path template automatically become - HTTP query parameters if there is no HTTP request body. For example: - service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) - { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } - message GetMessageRequest { message SubMessage { string subfield = 1; } - string message_id = 1; // Mapped to URL path. int64 revision = 2; // - Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped - to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC - mapping as below: - HTTP: `GET - /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: - `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - "foo"))` Note that fields which are mapped to URL query parameters must - have a primitive type or a repeated primitive type or a non-repeated - message type. In the case of a repeated type, the parameter can be - repeated in the URL as `...?param=A¶m=B`. In the case of a message - type, each field of the message is mapped to a separate parameter, such - as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request - body, the `body` field specifies the mapping. Consider a REST update - method on the message resource collection: service Messaging { rpc - UpdateMessage(UpdateMessageRequest) returns (Message) { option - (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" - }; } } message UpdateMessageRequest { string message_id = 1; // mapped - to the URL Message message = 2; // mapped to the body } The following - HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: - HTTP: - `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The - special name `*` can be used in the body mapping to define that every - field not bound by the path template should be mapped to the request - body. This enables the following alternative definition of the update - method: service Messaging { rpc UpdateMessage(Message) returns (Message) - { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: - "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH - /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using - `*` in the body mapping, it is not possible to have HTTP parameters, as - all fields not bound by the path end in the body. This makes this option - more rarely used in practice when defining REST APIs. The common usage - of `*` is in custom methods which don't use the URL at all for - transferring data. It is possible to define multiple HTTP methods for - one RPC by using the `additional_bindings` option. Example: service - Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/messages/{message_id}" - additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } - }; } } message GetMessageRequest { string message_id = 1; string user_id - = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: - HTTP: `GET /v1/messages/123456` - gRPC: - `GetMessage(message_id: "123456")` - HTTP: `GET - /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" - message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields - (recursive expansion nested messages in the request message) are - classified into three categories: - Fields referred by the path - template. They are passed via the URL path. - Fields referred by the - HttpRule.body. They are passed via the HTTP request body. - All other - fields are passed via the URL query parameters, and the parameter name - is the field path in the request message. A repeated field can be - represented as multiple query parameters under the same name. 2. If - HttpRule.body is "*", there is no URL query parameter, all fields are - passed via URL path and HTTP request body. 3. If HttpRule.body is - omitted, there is no HTTP request body, all fields are passed via URL - path and URL query parameters. Path template syntax Template = "/" - Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | - "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] - "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax - `*` matches a single URL path segment. The syntax `**` matches zero or - more URL path segments, which must be the last part of the URL path - except the `Verb`. The syntax `Variable` matches part of the URL path as - specified by its template. A variable template must not contain other - variables. If a variable matches a single path segment, its template may - be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax - `LITERAL` matches literal text in the URL path. If the `LITERAL` - contains any reserved character, such characters should be - percent-encoded before the matching. If a variable contains exactly one - path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is - expanded into a URL path on the client side, all characters except - `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse - decoding. Such variables show up in the [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{var}`. If a variable contains multiple path segments, such as - `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a - URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` - are percent-encoded. The server side does the reverse decoding, except - "%2F" and "%2f" are left unchanged. Such variables show up in the - [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. Using gRPC API Service Configuration gRPC API Service - Configuration (service config) is a configuration language for - configuring a gRPC service to become a user-facing product. The service - config is simply the YAML representation of the `google.api.Service` - proto message. As an alternative to annotating your proto file, you can - configure gRPC transcoding in your service config YAML files. You do - this by specifying a `HttpRule` that maps the gRPC method to a REST - endpoint, achieving the same effect as the proto annotation. This can be - particularly useful if you have a proto that is reused in multiple - services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. The - following example selects a gRPC method and applies an `HttpRule` to it: - http: rules: - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC - Transcoding is used to map a gRPC to JSON REST endpoints, the proto to - JSON conversion must follow the [proto3 - specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - While the single segment variable follows the semantics of [RFC - 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - Expansion, the multi segment variable **does not** follow RFC 6570 - Section 3.2.3 Reserved Expansion. The reason is that the Reserved - Expansion does not expand special characters like `?` and `#`, which - would lead to invalid URLs. As the result, gRPC Transcoding uses a - custom encoding for multi segment variables. The path variables **must - not** refer to any repeated or mapped field, because client libraries - are not capable of handling such variable expansion. The path variables - **must not** capture the leading "/" character. The reason is that the - most common use case "{var}" does not capture the leading "/" character. - For consistency, all path variables must share the same behavior. - Repeated message fields must not be mapped to URL query parameters, - because no client library can support such complicated mapping. If an - API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer + id: LogDescriptor + type: object + MetricDescriptor: + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + id: MetricDescriptor type: object properties: - delete: - type: string - description: Maps to HTTP DELETE. Used for deleting a resource. - body: + displayName: type: string description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. - post: + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + labels: + description: >- + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array + metadata: + description: Optional. Metadata which can be used to guide usage of the metric. + $ref: '#/components/schemas/MetricDescriptorMetadata' + description: type: string description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - put: - description: Maps to HTTP PUT. Used for replacing a resource. + A detailed description of the metric, which can be used in + documentation. + unit: type: string - custom: - $ref: '#/components/schemas/CustomHttpPattern' description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - additionalBindings: + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + monitoredResourceTypes: type: array items: - $ref: '#/components/schemas/HttpRule' - description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - get: - description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - type: string - selector: - type: string + type: string description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - responseBody: + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + type: description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. - type: string - patch: + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" type: string - description: Maps to HTTP PATCH. Used for updating a resource. - PeeredDnsDomainMetadata: - properties: {} - id: PeeredDnsDomainMetadata - type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - CreatePeeredDnsDomain API. - Field: - properties: - cardinality: + launchStage: type: string - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - description: The field cardinality. - options: - items: - $ref: '#/components/schemas/Option' - type: array - description: The protocol buffer options. - packed: - description: Whether to use alternative packed wire representation. - type: boolean - oneofIndex: - format: int32 - description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - type: integer - name: - type: string - description: The field name. - jsonName: - description: The field JSON name. - type: string - defaultValue: - description: >- - The string value of the default value of this field. Proto2 syntax - only. - type: string - kind: - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 - description: The field type. - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Optional. The launch stage of the metric definition. + name: + description: The resource name of the metric descriptor. + type: string + metricKind: + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE type: string - number: - format: int32 - description: The field number. - type: integer - typeUrl: description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + valueType: + description: >- + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY type: string - description: A single field of a message type. - id: Field - type: object - SelectiveGapicGeneration: - description: >- - This message is used to configure the generation of a subset of the RPCs - in a service for client libraries. - type: object - id: SelectiveGapicGeneration + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + UpdateConsumerConfigRequest: properties: - methods: - description: >- - An allowlist of the fully qualified names of RPCs that should be - included on public client surfaces. - type: array - items: - type: string - RemoveDnsZoneResponse: - description: Blank message response type for RemoveDnsZone API - id: RemoveDnsZoneResponse - properties: {} + consumerConfig: + description: Required. The updated peering config. + $ref: '#/components/schemas/ConsumerConfig' type: object - CppSettings: - id: CppSettings + id: UpdateConsumerConfigRequest + description: >- + Request to update the configuration of a service networking connection + including the import/export of custom routes and subnetwork routes with + public IP. + DotnetSettings: type: object + id: DotnetSettings + description: Settings for Dotnet client libraries. properties: common: $ref: '#/components/schemas/CommonLanguageSettings' description: Some settings. - description: Settings for C++ client libraries. - LoggingDestination: - type: object - properties: - logs: + handwrittenSignatures: type: array description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. items: type: string - monitoredResource: + renamedResources: + type: object description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - type: string + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + additionalProperties: + type: string + forcedNamespaceAliases: + items: + type: string + description: >- + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision + type: array + renamedServices: + description: >- + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + additionalProperties: + type: string + type: object + ignoredResources: + items: + type: string + description: >- + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + type: array + Route: + id: Route description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - id: LoggingDestination - SecondaryIpRange: + Represents a route that was created or discovered by a private access + management service. type: object properties: - ipCidrRange: - description: Secondary IP CIDR range in `x.x.x.x/y` format. + destRange: type: string - rangeName: + description: Destination CIDR range that this route applies to. + network: + description: >- + Fully-qualified URL of the VPC network in the producer host tenant + project that this route applies to. For example: + `projects/123456/global/networks/host-network` type: string - description: Name of the secondary IP range. - id: SecondaryIpRange - UpdateConsumerConfigRequest: - type: object - id: UpdateConsumerConfigRequest - properties: - consumerConfig: - $ref: '#/components/schemas/ConsumerConfig' - description: Required. The updated peering config. - description: >- - Request to update the configuration of a service networking connection - including the import/export of custom routes and subnetwork routes with - public IP. - AddDnsRecordSetRequest: - description: >- - Request to add a record set to a private managed DNS zone in the shared - producer host project. - type: object - properties: - dnsRecordSet: - description: Required. The DNS record set to add. - $ref: '#/components/schemas/DnsRecordSet' - consumerNetwork: + name: + description: Route name. See https://cloud.google.com/vpc/docs/routes type: string + nextHopGateway: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - zone: + Fully-qualified URL of the gateway that should handle matching + packets that this route applies to. For example: + `projects/123456/global/gateways/default-internet-gateway` type: string - description: >- - Required. The name of the private DNS zone in the shared producer - host project to which the record set will be added. - id: AddDnsRecordSetRequest - Service: - description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - id: Service + RubySettings: + description: Settings for Ruby client libraries. + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + type: object + id: RubySettings + CommonLanguageSettings: type: object properties: - control: - $ref: '#/components/schemas/Control' - description: Configuration for the service control plane. - http: - description: HTTP configuration. - $ref: '#/components/schemas/Http' - publishing: - $ref: '#/components/schemas/Publishing' - description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - systemTypes: + destinations: description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. + The destination where API teams want this client library to be + published. items: - $ref: '#/components/schemas/Type' + type: string + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER type: array - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - endpoints: + selectiveGapicGeneration: + $ref: '#/components/schemas/SelectiveGapicGeneration' description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. - items: - $ref: '#/components/schemas/Endpoint' - type: array + Configuration for which RPCs should be generated in the GAPIC + client. + referenceDocsUri: + description: >- + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + type: string + deprecated: true + id: CommonLanguageSettings + description: Required information for every language. + MonitoringDestination: + type: object + id: MonitoringDestination + properties: + monitoredResource: + type: string + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. metrics: - type: array - description: Defines the metrics used by this service. - items: - $ref: '#/components/schemas/MetricDescriptor' - logs: type: array items: - $ref: '#/components/schemas/LogDescriptor' - description: Defines the logs used by this service. - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - billing: - description: Billing configuration. - $ref: '#/components/schemas/Billing' - id: + type: string description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. - type: string - title: + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + description: >- + Configuration of a specific monitoring destination (the producer project + or the consumer project). + Api: + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + properties: + name: type: string description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - apis: + The fully qualified name of this interface, including package name + followed by the interface's simple name. + version: description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. - items: - $ref: '#/components/schemas/Api' + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. + type: string + syntax: + description: The source syntax of the service. + type: string + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + mixins: + description: Included interfaces. See Mixin. type: array - backend: - description: API backend configuration. - $ref: '#/components/schemas/Backend' - enums: - description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum items: - $ref: '#/components/schemas/Enum' - type: array - configVersion: - format: uint32 - type: integer + $ref: '#/components/schemas/Mixin' + sourceContext: description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - systemParameters: - description: System parameter configuration. - $ref: '#/components/schemas/SystemParameters' - monitoredResources: + Source context for the protocol buffer service represented by this + message. + $ref: '#/components/schemas/SourceContext' + methods: + description: The methods of this interface, in unspecified order. type: array items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - types: + $ref: '#/components/schemas/Method' + options: items: - $ref: '#/components/schemas/Type' - description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 + $ref: '#/components/schemas/Option' type: array - producerProjectId: - type: string - description: The Google project that owns this service. - name: - type: string - description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - sourceInfo: - description: >- - Output only. The source information for this configuration if - available. - $ref: '#/components/schemas/SourceInfo' - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - logging: - description: Logging configuration. - $ref: '#/components/schemas/Logging' - MetricDescriptorMetadata: - description: Additional annotations that can be used to guide the usage of a metric. + description: Any metadata attached to the interface. + id: Api + type: object + GoogleCloudServicenetworkingV1betaConnection: type: object + description: >- + Represents a private connection resource. A private connection is + implemented as a VPC Network Peering connection between a service + producer's VPC network and a service consumer's VPC network. properties: - samplePeriod: - type: string - format: google-duration + service: description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. - ingestDelay: + Output only. The name of the peering service that's associated with + this connection, in the following format: `services/{service name}`. + type: string + network: description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - format: google-duration + The name of service consumer's VPC network that's connected with + service producer network, in the following format: + `projects/{project}/global/networks/{network}`. `{project}` is a + project number, such as in `12345` that includes the VPC service + consumer's VPC network. `{network}` is the name of the service + consumer's VPC network. type: string - timeSeriesResourceHierarchyLevel: + reservedPeeringRanges: type: array - description: The scope of the timeseries data of the metric. + description: >- + The name of one or more allocated IP address ranges for this service + producer of type `PEERING`. Note that invoking this method with a + different range when connection is already established will not + modify already provisioned service producer subnetworks. items: type: string - enumDescriptions: - - Do not use this default value. - - Scopes a metric to a project. - - Scopes a metric to an organization. - - Scopes a metric to a folder. - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER - launchStage: - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + peering: + description: >- + Output only. The name of the VPC Network Peering connection that was + created by the service producer. type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - deprecated: true - id: MetricDescriptorMetadata - GetDnsZoneResponse: - type: object - id: GetDnsZoneResponse + id: GoogleCloudServicenetworkingV1betaConnection + Page: properties: - producerPrivateZone: - $ref: '#/components/schemas/DnsZone' - description: The private DNS zone created in the shared producer host project. - consumerPeeringZone: - description: The DNS peering zone created in the consumer project. - $ref: '#/components/schemas/DnsZone' + name: + description: >- + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. + type: string + subpages: + type: array + items: + $ref: '#/components/schemas/Page' + description: >- + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. + content: + type: string + description: >- + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. + id: Page + type: object description: >- - Represents managed DNS zones created in the shared Producer host and - consumer projects. - LabelDescriptor: + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + NodeSettings: + description: Settings for Node client libraries. + id: NodeSettings type: object - id: LabelDescriptor - description: A description of a label. properties: - description: - description: A human-readable description for the label. - type: string - key: - type: string - description: The label key. - valueType: - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + SearchRangeRequest: + id: SearchRangeRequest + properties: + network: + description: >- + Network name in the consumer project. This network must have been + already peered with a shared VPC network using CreateConnection + method. Must be in a form + 'projects/{project}/global/networks/{network}'. {project} is a + project number, as in '12345' {network} is network name. type: string - description: The type of data that can be assigned to the label. - enum: - - STRING - - BOOL - - INT64 - ClientLibrarySettings: - id: ClientLibrarySettings - description: Details about how and where to publish client libraries. + ipPrefixLength: + type: integer + description: >- + Required. The prefix length of the IP range. Use usual CIDR range + notation. For example, '30' to find unused x.x.x.x/30 CIDR range. + Actual range will be determined using allocated range for the + consumer peered network and returned in the result. + format: int32 + description: Request to search for an unused range within allocated ranges. + type: object + Field: type: object + description: A single field of a message type. + id: Field properties: - dotnetSettings: - description: Settings for .NET client libraries. - $ref: '#/components/schemas/DotnetSettings' - version: + defaultValue: type: string description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Launch stage of this version of the API. + The string value of the default value of this field. Proto2 syntax + only. + typeUrl: + description: >- + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + type: string + cardinality: + type: string enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - pythonSettings: - description: Settings for Python client libraries. - $ref: '#/components/schemas/PythonSettings' - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - restNumericEnums: - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - type: boolean - nodeSettings: - $ref: '#/components/schemas/NodeSettings' - description: Settings for Node client libraries. - rubySettings: - $ref: '#/components/schemas/RubySettings' - description: Settings for Ruby client libraries. - goSettings: - description: Settings for Go client libraries. - $ref: '#/components/schemas/GoSettings' - RangeReservation: - description: Represents a range reservation. - id: RangeReservation - properties: - subnetworkCandidates: - type: array + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + description: The field cardinality. + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + oneofIndex: + format: int32 description: >- - Optional. List of subnetwork candidates to validate. The required - input fields are `name`, `network`, and `region`. Subnetworks from - this list which exist will be returned in the response with the - `ip_cidr_range`, `secondary_ip_cider_ranges`, and - `outside_allocation` fields set. - items: - $ref: '#/components/schemas/Subnetwork' - ipPrefixLength: + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. type: integer + number: format: int32 - description: >- - Required. The size of the desired subnet. Use usual CIDR range - notation. For example, '29' to find unused x.x.x.x/29 CIDR range. - The goal is to determine if one of the allocated ranges has enough - free space for a subnet of the requested size. GCE disallows subnets - with prefix_length > 29 - requestedRanges: - items: - type: string - type: array - description: >- - Optional. The name of one or more allocated IP address ranges - associated with this private service access connection. If no range - names are provided all ranges associated with this connection will - be considered. If a CIDR range with the specified IP prefix length - is not available within these ranges the validation fails. - secondaryRangeIpPrefixLengths: - type: array - items: - format: int32 - type: integer - description: >- - Optional. The size of the desired secondary ranges for the subnet. - Use usual CIDR range notation. For example, '29' to find unused - x.x.x.x/29 CIDR range. The goal is to determine that the allocated - ranges have enough free space for all the requested secondary - ranges. GCE disallows subnets with prefix_length > 29 - type: object - Enum: - properties: - enumvalue: - type: array - items: - $ref: '#/components/schemas/EnumValue' - description: Enum value definitions. - syntax: - description: The source syntax. + description: The field number. + type: integer + kind: enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. type: string - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + description: The field type. + packed: + type: boolean + description: Whether to use alternative packed wire representation. name: type: string - description: Enum type name. - edition: - type: string - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + description: The field name. options: items: $ref: '#/components/schemas/Option' type: array - description: Protocol buffer options. - description: Enum type definition. + description: The protocol buffer options. + jsonName: + type: string + description: The field JSON name. + GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: + id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + description: Allocated IP address ranges for this private service access connection. type: object - id: Enum - Connection: - description: >- - Represents a private connection resource. A private connection is - implemented as a VPC Network Peering connection between a service - producer's VPC network and a service consumer's VPC network. properties: - network: - type: string - description: >- - The name of service consumer's VPC network that's connected with - service producer network, in the following format: - `projects/{project}/global/networks/{network}`. `{project}` is a - project number, such as in `12345` that includes the VPC service - consumer's VPC network. `{network}` is the name of the service - consumer's VPC network. - peering: - description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. + address: type: string - readOnly: true - reservedPeeringRanges: - items: - type: string - type: array description: >- - The name of one or more allocated IP address ranges for this service - producer of type `PEERING`. Note that invoking CreateConnection - method with a different range when connection is already established - will not modify already provisioned service producer subnetworks. If - CreateConnection method is invoked repeatedly to reconnect when - peering connection had been disconnected on the consumer side, - leaving this field empty will restore previously allocated IP - ranges. - service: + The starting address of the reserved range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix length is the CIDR range for the reserved range. + ipPrefixLength: + type: integer + description: The prefix length of the reserved range. + format: int32 + name: type: string - description: >- - Output only. The name of the peering service that's associated with - this connection, in the following format: `services/{service name}`. - readOnly: true - id: Connection - type: object + description: The name of the reserved range. GoogleCloudServicenetworkingV1betaSubnetwork: - description: >- - Represents a subnet that was created or discovered by a private access - management service. - id: GoogleCloudServicenetworkingV1betaSubnetwork - type: object properties: - name: - type: string - description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ network: type: string description: >- In the Shared VPC host project, the VPC network that's peered with the consumer network. For example: `projects/1234321/global/networks/host-network` - outsideAllocation: - type: boolean + name: + type: string + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + outsideAllocation: + type: boolean description: >- This is a discovered subnet that is not within the current consumer allocated ranges. ipCidrRange: description: Subnetwork CIDR range in `10.x.x.x/y` format. type: string - ValidateConsumerConfigRequest: + id: GoogleCloudServicenetworkingV1betaSubnetwork + type: object + description: >- + Represents a subnet that was created or discovered by a private access + management service. + ConsumerConfig: properties: - rangeReservation: - $ref: '#/components/schemas/RangeReservation' + usedIpRanges: + items: + type: string + type: array + readOnly: true + description: Output only. The IP ranges already in use by consumer or producer + producerImportSubnetRoutesWithPublicIp: + type: boolean description: >- - RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are - done when range_reservation is provided. - validateNetwork: + Import subnet routes with public ip flag value for peering from + producer to consumer. + vpcScReferenceArchitectureEnabled: type: boolean description: >- - The validations will be performed in the order listed in the - ValidationError enum. The first failure will return. If a validation - is not requested, then the next one will be performed. - SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are - performed for all requests where validation is requested. - NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for - requests that have validate_network set to true. - consumerProject: - $ref: '#/components/schemas/ConsumerProject' + Output only. Indicates whether the VPC Service Controls reference + architecture is configured for the producer VPC host network. + readOnly: true + producerExportCustomRoutes: + type: boolean description: >- - NETWORK_NOT_IN_CONSUMERS_PROJECT, - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND - are done when consumer_project is provided. - consumerNetwork: + Export custom routes flag value for peering from producer to + consumer. + reservedRanges: + description: >- + Output only. The reserved ranges associated with this private + service access connection. + readOnly: true + items: + $ref: >- + #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + type: array + cloudsqlConfigs: + items: + $ref: '#/components/schemas/CloudSQLConfig' + type: array + description: Represents one or multiple Cloud SQL configurations. + consumerImportCustomRoutes: + description: >- + Import custom routes flag value for peering from consumer to + producer. + type: boolean + consumerExportSubnetRoutesWithPublicIp: + description: >- + Export subnet routes with public ip flag value for peering from + consumer to producer. + type: boolean + producerExportSubnetRoutesWithPublicIp: + type: boolean + description: >- + Export subnet routes with public ip flag value for peering from + producer to consumer. + producerNetwork: + description: >- + Output only. The VPC host network that is used to host managed + service instances. In the format, + projects/{project}/global/networks/{network} where {project} is the + project number e.g. '12345' and {network} is the network name. type: string + readOnly: true + consumerExportCustomRoutes: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. - checkServiceNetworkingUsePermission: + Export custom routes flag value for peering from consumer to + producer. + type: boolean + consumerImportSubnetRoutesWithPublicIp: description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. + Import subnet routes with public ip flag value for peering from + consumer to producer. + type: boolean + producerImportCustomRoutes: type: boolean + description: >- + Import custom routes flag value for peering from producer to + consumer. + id: ConsumerConfig type: object - id: ValidateConsumerConfigRequest - Option: + description: Configuration information for a private service access connection. + RemoveDnsZoneRequest: type: object - id: Option properties: - value: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. name: + description: >- + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. + type: string + consumerNetwork: type: string description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + id: RemoveDnsZoneRequest description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - DotnetSettings: - type: object - id: DotnetSettings + Request to remove a private managed DNS zone in the shared producer host + project and a matching DNS peering zone in the consumer project. + ContextRule: properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - ignoredResources: - items: - type: string + provided: description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - type: array - forcedNamespaceAliases: + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. items: type: string - description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision type: array - handwrittenSignatures: + allowedResponseExtensions: type: array items: type: string description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - renamedServices: - type: object - additionalProperties: - type: string - description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - renamedResources: - type: object + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + requested: description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - additionalProperties: + A list of full type names of requested contexts, only the requested + context will be made available to the backend. + type: array + items: type: string - description: Settings for Dotnet client libraries. - Monitoring: - properties: - producerDestinations: + selector: description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - items: - $ref: '#/components/schemas/MonitoringDestination' - type: array - consumerDestinations: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + allowedRequestExtensions: items: - $ref: '#/components/schemas/MonitoringDestination' + type: string description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. type: array + description: >- + A context rule provides information about the context for an individual + API element. + id: ContextRule + type: object + AuthProvider: + id: AuthProvider type: object description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue - id: Monitoring - AddDnsZoneRequest: - id: AddDnsZoneRequest + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). properties: - name: + jwksUri: + description: >- + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs type: string + audiences: description: >- - Required. The name for both the private zone in the shared producer - host project and the peering zone in the consumer project. Must be - unique within both projects. The name must be 1-63 characters long, - must begin with a letter, end with a letter or digit, and only - contain lowercase letters, digits or dashes. - consumerNetwork: + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string + authorizationUrl: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. type: string - dnsSuffix: + issuer: type: string description: >- - Required. The DNS name suffix for the zones e.g. `example.com.`. - Cloud DNS requires that a DNS suffix ends with a trailing dot. - description: >- - Request to add a private managed DNS zone in the shared producer host - project and a matching DNS peering zone in the consumer project. - type: object - Status: - properties: - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com + jwtLocations: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token type: array - message: + items: + $ref: '#/components/schemas/JwtLocation' + id: + description: >- + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". type: string + FieldPolicy: + properties: + resourcePermission: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: Status - type: object - RemoveDnsZoneMetadata: - id: RemoveDnsZoneMetadata + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". + type: string + selector: + type: string + description: >- + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". + resourceType: + type: string + description: >- + Specifies the resource type for the resource referred to by the + field. + id: FieldPolicy type: object - properties: {} description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsZone API - MetricDescriptor: + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. + Subnetwork: + id: Subnetwork properties: + outsideAllocation: + type: boolean + description: >- + This is a discovered subnet that is not within the current consumer + allocated ranges. + secondaryIpRanges: + type: array + items: + $ref: '#/components/schemas/SecondaryIpRange' + description: List of secondary IP ranges in this subnetwork. + ipCidrRange: + description: Subnetwork CIDR range in `10.x.x.x/y` format. + type: string name: type: string - description: The resource name of the metric descriptor. - labels: - type: array + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + region: + type: string + description: GCP region where the subnetwork is located. + network: + type: string description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` + type: object + description: >- + Represents a subnet that was created or discovered by a private access + management service. + ListDnsRecordSetsResponse: + properties: + dnsRecordSets: + type: array + description: DNS record Set Resource items: - $ref: '#/components/schemas/LabelDescriptor' - monitoredResourceTypes: + $ref: '#/components/schemas/DnsRecordSet' + id: ListDnsRecordSetsResponse + type: object + description: Represents all DNS RecordSets associated with the producer network + ListOperationsResponse: + properties: + nextPageToken: + type: string + description: The standard List next-page token. + operations: description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. + A list of operations that matches the specified filter in the + request. items: - type: string + $ref: '#/components/schemas/Operation' type: array - type: + id: ListOperationsResponse + type: object + description: The response message for Operations.ListOperations. + Option: + id: Option + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + type: object + properties: + value: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + type: object + name: type: string description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - unit: + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. + AddSubnetworkRequest: + description: Request to create a subnetwork in a previously peered service network. + id: AddSubnetworkRequest + type: object + properties: + role: type: string description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). + Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For + information about the roles that can be set using this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. + ipPrefixLength: + type: integer + format: int32 + description: >- + Required. The prefix length of the subnet's IP address range. Use + CIDR range notation, such as `29` to provision a subnet with an + `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool + of available ranges in the service consumer's allocated range. GCE + disallows subnets with prefix_length > 29 + skipRequestedAddressValidation: + type: boolean + description: >- + Optional. Skips validating if the requested_address is in use by SN + VPC’s peering group. Compute Engine will still perform this check + and fail the request if the requested_address is in use. Note that + Compute Engine does not check for the existence of dynamic routes + when performing this check. Caller of this API should make sure that + there are no dynamic routes overlapping with the + requested_address/prefix_length IP address range otherwise the + created subnet could cause misrouting. + consumerNetwork: + type: string + description: >- + Required. The name of the service consumer's VPC network. The + network must have an existing private connection that was + provisioned through the connections.create method. The name must be + in the following format: + `projects/{project}/global/networks/{network}`, where {project} is a + project number, such as `12345`. {network} is the name of a VPC + network in the project. + internalRange: + description: >- + Optional. The url of an Internal Range. Eg: + `projects//locations/global/internalRanges/`. If specified, it means + that the subnetwork cidr will be created using the combination of + requested_address/ip_prefix_length. Note that the subnet cidr has to + be within the cidr range of this Internal Range. + type: string + secondaryIpRangeSpecs: + description: >- + Optional. A list of secondary IP ranges to be created within the new + subnetwork. + type: array + items: + $ref: '#/components/schemas/SecondaryIpRangeSpec' description: + type: string + description: Optional. Description of the subnet. + useCustomComputeIdempotencyWindow: + type: boolean description: >- - A detailed description of the metric, which can be used in - documentation. + Optional. Specifies if Service Networking should use a custom time + bucket for Arcus idempotency. If false, Service Networking uses a + 300 second (5 minute) Arcus idempotency window. If true, Service + Networking uses a custom idempotency window provided by the user in + field compute_idempotency_window. For more information on how to + use, see: go/revisit-sn-idempotency-window + requestedRanges: + type: array + description: >- + Optional. The name of one or more allocated IP address ranges + associated with this private service access connection. If no range + names are provided all ranges associated with this connection will + be considered. If a CIDR range with the specified IP prefix length + is not available within these ranges, the call fails. + items: + type: string + allowSubnetCidrRoutesOverlap: + type: boolean + description: >- + Optional. Defines the allowSubnetCidrRoutesOverlap field of the + subnet, e.g. Available in alpha and beta according to [Compute API + documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert) + computeIdempotencyWindow: + description: >- + Optional. Specifies a custom time bucket for Arcus subnetwork + request idempotency. If two equivalent concurrent requests are made, + Arcus will know to ignore the request if it has already been + completed or is in progress. Only requests with matching + compute_idempotency_window have guaranteed idempotency. Changing + this time window between requests results in undefined behavior. + Zero (or empty) value with custom_compute_idempotency_window=true + specifies no idempotency (i.e. no request ID is provided to Arcus). + Maximum value of 14 days (enforced by Arcus limit). For more + information on how to use, see: go/revisit-sn-idempotency-window + type: string + format: google-duration + subnetwork: + description: >- + Required. A name for the new subnet. For information about the + naming requirements, see + [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the + Compute API documentation. + type: string + requestedAddress: + type: string + description: >- + Optional. The starting address of a range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix range is the CIDR range for the subnet. The range must + be within the allocated range that is assigned to the private + connection. If the CIDR range isn't available, the call fails. + outsideAllocationPublicIpRange: + description: >- + Optional. Enable outside allocation using public IP addresses. Any + public IP range may be specified. If this field is provided, we will + not use customer reserved ranges for this primary IP range. + type: string + privateIpv6GoogleAccess: + type: string + description: >- + Optional. The private IPv6 google access type for the VMs in this + subnet. For information about the access types that can be set using + this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. + consumer: + type: string + description: >- + Required. A resource that represents the service consumer, such as + `projects/123456`. The project number can be different from the + value in the consumer network parameter. For example, the network + might be part of a Shared VPC network. In those cases, Service + Networking validates that this resource belongs to that Shared VPC. + subnetworkUsers: + items: + type: string + description: >- + A list of members that are granted the + `roles/servicenetworking.subnetworkAdmin` role on the subnet. + type: array + purpose: + type: string + description: >- + Optional. Defines the purpose field of the subnet, e.g. + 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that + can be set using this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. + region: + description: >- + Required. The name of a [region](/compute/docs/regions-zones) for + the subnet, such `europe-west1`. + type: string + checkServiceNetworkingUsePermission: + type: boolean + description: >- + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + Status: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + details: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + id: Status + DeleteConnectionMetadata: + properties: {} + id: DeleteConnectionMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + Delete Connection API + type: object + Method: + description: Method represents a method of an API interface. + id: Method + properties: + requestTypeUrl: + type: string + description: A URL of the input message type. + responseStreaming: + description: If true, the response is streamed. + type: boolean + name: + description: The simple name of this method. + type: string + responseTypeUrl: type: string + description: The URL of the output message type. + options: + type: array + description: Any metadata attached to the method. + items: + $ref: '#/components/schemas/Option' + requestStreaming: + type: boolean + description: If true, the request is streamed. + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax of this method. + type: string + type: object + ValidateConsumerConfigRequest: + id: ValidateConsumerConfigRequest + properties: + checkServiceNetworkingUsePermission: + type: boolean + description: >- + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + validateNetwork: + type: boolean + description: >- + The validations will be performed in the order listed in the + ValidationError enum. The first failure will return. If a validation + is not requested, then the next one will be performed. + SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are + performed for all requests where validation is requested. + NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for + requests that have validate_network set to true. + consumerNetwork: + type: string + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. + consumerProject: + $ref: '#/components/schemas/ConsumerProject' + description: >- + NETWORK_NOT_IN_CONSUMERS_PROJECT, + NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND + are done when consumer_project is provided. + rangeReservation: + description: >- + RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are + done when range_reservation is provided. + $ref: '#/components/schemas/RangeReservation' + type: object + LoggingDestination: + id: LoggingDestination + properties: + monitoredResource: + description: >- + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + type: string + logs: + type: array + items: + type: string + description: >- + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). + type: object + AddDnsRecordSetMetadata: + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsRecordSet API + type: object + id: AddDnsRecordSetMetadata + properties: {} + UpdateDnsRecordSetRequest: + type: object + id: UpdateDnsRecordSetRequest + description: >- + Request to update a record set from a private managed DNS zone in the + shared producer host project. The name, type, ttl, and data values of + the existing record set must all exactly match an existing record set in + the specified zone. + properties: + newDnsRecordSet: + description: >- + Required. The new values that the DNS record set should be updated + to hold. + $ref: '#/components/schemas/DnsRecordSet' + existingDnsRecordSet: + $ref: '#/components/schemas/DnsRecordSet' + description: Required. The existing DNS record set to update. + zone: + type: string + description: >- + Required. The name of the private DNS zone in the shared producer + host project from which the record set will be removed. + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + type: string + RemoveDnsZoneResponse: + type: object + id: RemoveDnsZoneResponse + properties: {} + description: Blank message response type for RemoveDnsZone API + CustomHttpPattern: + id: CustomHttpPattern + description: A custom pattern is used for defining custom HTTP verb. + properties: + kind: + type: string + description: The name of this custom HTTP verb. + path: + type: string + description: The path matched by this custom verb. + type: object + AddRolesMetadata: + properties: {} + id: AddRolesMetadata + type: object + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddRoles API + MetricDescriptorMetadata: + description: Additional annotations that can be used to guide the usage of a metric. + properties: + ingestDelay: + type: string + format: google-duration + description: >- + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. + timeSeriesResourceHierarchyLevel: + type: array + items: + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + type: string + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER + description: The scope of the timeseries data of the metric. launchStage: type: string - description: Optional. The launch stage of the metric definition. + deprecated: true + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -2548,216 +2391,294 @@ components: - BETA - GA - DEPRECATED - metadata: - $ref: '#/components/schemas/MetricDescriptorMetadata' - description: Optional. Metadata which can be used to guide usage of the metric. - metricKind: - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE + samplePeriod: description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. type: string - valueType: - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. + format: google-duration + type: object + id: MetricDescriptorMetadata + Context: + type: object + description: >- + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. + id: Context + properties: + rules: description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - type: string - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY - displayName: + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/ContextRule' + JavaSettings: + id: JavaSettings + type: object + description: Settings for Java client libraries. + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + libraryPackage: + description: >- + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 type: string + serviceClassNames: + type: object + additionalProperties: + type: string description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - type: object - id: MetricDescriptor - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. - Logging: + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + MethodSettings: properties: - consumerDestinations: - type: array + longRunning: description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. - items: - $ref: '#/components/schemas/LoggingDestination' - producerDestinations: + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + $ref: '#/components/schemas/LongRunning' + autoPopulatedFields: type: array items: - $ref: '#/components/schemas/LoggingDestination' + type: string description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id + selector: + type: string + description: >- + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... + id: MethodSettings + description: Describes the generator configuration for a method. type: object - id: Logging - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - ConsumerConfig: + RemoveDnsRecordSetMetadata: type: object - id: ConsumerConfig + id: RemoveDnsRecordSetMetadata + properties: {} + description: >- + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsRecordSet API + SystemParameter: + id: SystemParameter properties: - producerImportCustomRoutes: - description: >- - Import custom routes flag value for peering from producer to - consumer. - type: boolean - consumerExportCustomRoutes: - type: boolean - description: >- - Export custom routes flag value for peering from consumer to - producer. - producerExportSubnetRoutesWithPublicIp: + urlQueryParameter: + type: string description: >- - Export subnet routes with public ip flag value for peering from - producer to consumer. - type: boolean - consumerImportSubnetRoutesWithPublicIp: - type: boolean + Define the URL query parameter name to use for the parameter. It is + case sensitive. + httpHeader: description: >- - Import subnet routes with public ip flag value for peering from - consumer to producer. - consumerExportSubnetRoutesWithPublicIp: + Define the HTTP header name to use for the parameter. It is case + insensitive. + type: string + name: + type: string description: >- - Export subnet routes with public ip flag value for peering from - consumer to producer. - type: boolean - cloudsqlConfigs: - type: array - items: - $ref: '#/components/schemas/CloudSQLConfig' - description: Represents one or multiple Cloud SQL configurations. - producerExportCustomRoutes: + Define the name of the parameter, such as "api_key" . It is case + sensitive. + type: object + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + Mixin: + properties: + name: + description: The fully qualified name of the interface which is included. + type: string + root: description: >- - Export custom routes flag value for peering from producer to - consumer. - type: boolean - producerImportSubnetRoutesWithPublicIp: - type: boolean + If non-empty specifies a path under which inherited HTTP paths are + rooted. + type: string + id: Mixin + type: object + description: >- + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + DeletePeeredDnsDomainMetadata: + type: object + id: DeletePeeredDnsDomainMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + DeletePeeredDnsDomain API. + properties: {} + SecondaryIpRangeSpec: + type: object + id: SecondaryIpRangeSpec + properties: + ipPrefixLength: + format: int32 description: >- - Import subnet routes with public ip flag value for peering from - producer to consumer. - usedIpRanges: - items: - type: string - type: array - description: Output only. The IP ranges already in use by consumer or producer - readOnly: true - consumerImportCustomRoutes: - type: boolean + Required. The prefix length of the secondary IP range. Use CIDR + range notation, such as `30` to provision a secondary IP range with + an `x.x.x.x/30` CIDR range. The IP address range is drawn from a + pool of available ranges in the service consumer's allocated range. + type: integer + outsideAllocationPublicIpRange: description: >- - Import custom routes flag value for peering from consumer to - producer. - vpcScReferenceArchitectureEnabled: + Optional. Enable outside allocation using public IP addresses. Any + public IP range may be specified. If this field is provided, we will + not use customer reserved ranges for this secondary IP range. + type: string + requestedAddress: + type: string description: >- - Output only. Indicates whether the VPC Service Controls reference - architecture is configured for the producer VPC host network. - type: boolean - readOnly: true - reservedRanges: - readOnly: true - type: array + Optional. The starting address of a range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix range is the CIDR range for the secondary IP range. + The range must be within the allocated range that is assigned to the + private connection. If the CIDR range isn't available, the call + fails. + rangeName: + type: string description: >- - Output only. The reserved ranges associated with this private - service access connection. - items: - $ref: >- - #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange - producerNetwork: + Required. A name for the secondary IP range. The name must be 1-63 + characters long, and comply with RFC1035. The name must be unique + within the subnetwork. + EnableVpcServiceControlsRequest: + description: Request to enable VPC service controls. + properties: + consumerNetwork: type: string description: >- - Output only. The VPC host network that is used to host managed - service instances. In the format, - projects/{project}/global/networks/{network} where {project} is the - project number e.g. '12345' and {network} is the network name. - readOnly: true - description: Configuration information for a private service access connection. - DeletePeeredDnsDomainMetadata: - properties: {} - description: >- - Metadata provided through GetOperation request for the LRO generated by - DeletePeeredDnsDomain API. - id: DeletePeeredDnsDomainMetadata + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. type: object + id: EnableVpcServiceControlsRequest PeeredDnsDomain: + description: >- + DNS domain suffix for which requests originating in the producer VPC + network are resolved in the associated consumer VPC network. id: PeeredDnsDomain type: object properties: + dnsSuffix: + type: string + description: >- + The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires + that a DNS suffix ends with a trailing dot. name: + type: string description: >- User assigned name for this resource. Must be unique within the consumer network. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. - type: string - dnsSuffix: - description: >- - The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires - that a DNS suffix ends with a trailing dot. - type: string + RemoveDnsZoneMetadata: + id: RemoveDnsZoneMetadata + properties: {} description: >- - DNS domain suffix for which requests originating in the producer VPC - network are resolved in the associated consumer VPC network. - RemoveDnsZoneRequest: + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsZone API + type: object + CppSettings: + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + description: Settings for C++ client libraries. + type: object + id: CppSettings + VpcServiceControls: + description: Response for the get VPC Service Controls request. + properties: + enabled: + type: boolean + readOnly: true + description: >- + Output only. Indicates whether the VPC Service Controls are enabled + or disabled for the connection. If the consumer called the + EnableVpcServiceControls method, then this is true. If the consumer + called DisableVpcServiceControls, then this is false. The default is + false. + id: VpcServiceControls + type: object + AddDnsRecordSetRequest: description: >- - Request to remove a private managed DNS zone in the shared producer host - project and a matching DNS peering zone in the consumer project. - id: RemoveDnsZoneRequest + Request to add a record set to a private managed DNS zone in the shared + producer host project. + type: object properties: + zone: + type: string + description: >- + Required. The name of the private DNS zone in the shared producer + host project to which the record set will be added. consumerNetwork: description: >- Required. The network that the consumer is using to connect with @@ -2765,1323 +2686,1428 @@ components: projects/{project}/global/networks/{network} {project} is the project number, as in '12345' {network} is the network name. type: string - name: - description: >- - Required. The name for both the private zone in the shared producer - host project and the peering zone in the consumer project. - type: string - type: object - Empty: - id: Empty + dnsRecordSet: + $ref: '#/components/schemas/DnsRecordSet' + description: Required. The DNS record set to add. + id: AddDnsRecordSetRequest + Publishing: + id: Publishing 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); } - properties: {} - type: object - Method: + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. properties: - requestStreaming: - type: boolean - description: If true, the request is streamed. - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - description: The source syntax of this method. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - options: - type: array - description: Any metadata attached to the method. - items: - $ref: '#/components/schemas/Option' - responseStreaming: - description: If true, the response is streamed. - type: boolean - responseTypeUrl: - type: string - description: The URL of the output message type. - requestTypeUrl: - type: string - description: A URL of the input message type. - name: - description: The simple name of this method. + docTagPrefix: type: string - description: Method represents a method of an API interface. - id: Method - type: object - RubySettings: - description: Settings for Ruby client libraries. - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: RubySettings - type: object - LongRunning: - description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - properties: - pollDelayMultiplier: - format: float - type: number description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - initialPollDelay: + A prefix used in sample code when demarking regions to be included + in documentation. + protoReferenceDocumentationUri: description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc type: string - format: google-duration - maxPollDelay: + methodSettings: description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - type: string - format: google-duration - totalPollTimeout: - description: 'Total polling timeout. Default value: 5 minutes.' - format: google-duration + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + type: array + items: + $ref: '#/components/schemas/MethodSettings' + organization: + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + enumDescriptions: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + description: For whom the client library is being published. type: string - id: LongRunning - type: object - Context: - properties: - rules: + codeownerGithubTeams: type: array items: - $ref: '#/components/schemas/ContextRule' - description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - id: Context - type: object - description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. - ConsumerProject: - description: Represents a consumer project. - id: ConsumerProject - type: object - properties: - projectNum: + type: string description: >- - Required. Project number of the consumer that is launching the - service instance. It can own the network that is peered with Google - or, be a service project in an XPN where the host project has the - network. - format: int64 - type: string - JavaSettings: - properties: - libraryPackage: + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + newIssueUri: type: string description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 - serviceClassNames: - type: object - additionalProperties: - type: string + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + documentationUri: description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - id: JavaSettings - description: Settings for Java client libraries. - type: object - Http: - properties: - rules: + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + type: string + restReferenceDocumentationUri: + description: >- + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + type: string + librarySettings: items: - $ref: '#/components/schemas/HttpRule' + $ref: '#/components/schemas/ClientLibrarySettings' type: array description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. - fullyDecodeReservedExpansion: + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. + githubLabel: + type: string description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - type: boolean - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - id: Http - type: object - AddRolesResponse: - properties: - policyBinding: - items: - $ref: '#/components/schemas/PolicyBinding' - type: array + GitHub label to apply to issues and pull requests opened for this + API. + apiShortName: description: >- - Required. List of policy bindings that were added to the shared VPC - host project. - id: AddRolesResponse - description: Represents IAM roles added to the shared VPC host project. + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". + type: string type: object - CancelOperationRequest: - id: CancelOperationRequest + Empty: properties: {} + id: 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); } type: object - description: The request message for Operations.CancelOperation. - DnsZone: + Enum: + type: object + description: Enum type definition. properties: - dnsSuffix: + enumvalue: + items: + $ref: '#/components/schemas/EnumValue' + description: Enum value definitions. + type: array + syntax: type: string - description: >- - The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS - requires that a DNS suffix ends with a trailing dot. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS name: + description: Enum type name. + type: string + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: Protocol buffer options. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + edition: description: >- - User assigned name for this resource. Must be unique within the - project. The name must be 1-63 characters long, must begin with a - letter, end with a letter or digit, and only contain lowercase - letters, digits or dashes. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. type: string - type: object - description: Represents a DNS zone resource. - id: DnsZone + id: Enum AddDnsZoneResponse: + type: object description: >- Represents managed DNS zones created in the shared producer host and consumer projects. - id: AddDnsZoneResponse - type: object properties: consumerPeeringZone: description: The DNS peering zone created in the consumer project. $ref: '#/components/schemas/DnsZone' producerPrivateZone: - description: The private DNS zone created in the shared producer host project. $ref: '#/components/schemas/DnsZone' - AddRolesRequest: - id: AddRolesRequest - type: object - properties: - policyBinding: - type: array - description: Required. List of policy bindings to add to shared VPC host project. - items: - $ref: '#/components/schemas/PolicyBinding' - consumerNetwork: - type: string - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is a network name. - description: >- - Request for AddRoles to allow Service Producers to add roles in the - shared VPC host project for them to use. - RemoveDnsRecordSetMetadata: - id: RemoveDnsRecordSetMetadata - type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsRecordSet API - properties: {} - SourceContext: - type: object - id: SourceContext - properties: - fileName: - description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - type: string - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - ListPeeredDnsDomainsResponse: - description: Response to list peered DNS domains for a given connection. - properties: - peeredDnsDomains: - description: The list of peered DNS domains. - type: array - items: - $ref: '#/components/schemas/PeeredDnsDomain' - id: ListPeeredDnsDomainsResponse - type: object - Mixin: - properties: - root: - type: string - description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. - name: - type: string - description: The fully qualified name of the interface which is included. - id: Mixin - type: object - description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - AuthenticationRule: - id: AuthenticationRule + description: The private DNS zone created in the shared producer host project. + id: AddDnsZoneResponse + Usage: type: object + description: Configuration controlling usage of a service. + id: Usage properties: - allowWithoutCredential: - description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - type: boolean - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - selector: - type: string + rules: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - requirements: - description: Requirements for additional authentication providers. + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/UsageRule' type: array + requirements: items: - $ref: '#/components/schemas/AuthRequirement' - description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - EnumValue: - description: Enum value definition. - id: EnumValue - type: object + type: string + description: >- + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. + type: array + producerNotificationChannel: + type: string + description: >- + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + Type: properties: + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + edition: + type: string + description: >- + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. name: type: string - description: Enum value name. - number: - description: Enum value number. - format: int32 - type: integer + description: The fully qualified message name. + oneofs: + description: The list of types appearing in `oneof` definitions in this type. + items: + type: string + type: array + syntax: + description: The source syntax. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. options: + description: The protocol buffer options. type: array - description: Protocol buffer options. items: $ref: '#/components/schemas/Option' - SearchRangeRequest: + fields: + items: + $ref: '#/components/schemas/Field' + type: array + description: The list of fields. + description: A protocol buffer message type. type: object - id: SearchRangeRequest - description: Request to search for an unused range within allocated ranges. + id: Type + AuthRequirement: + type: object + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + id: AuthRequirement properties: - network: + providerId: type: string description: >- - Network name in the consumer project. This network must have been - already peered with a shared VPC network using CreateConnection - method. Must be in a form - 'projects/{project}/global/networks/{network}'. {project} is a - project number, as in '12345' {network} is network name. - ipPrefixLength: - format: int32 + id from authentication provider. Example: provider_id: + bookstore_auth + audiences: description: >- - Required. The prefix length of the IP range. Use usual CIDR range - notation. For example, '30' to find unused x.x.x.x/30 CIDR range. - Actual range will be determined using allocated range for the - consumer peered network and returned in the result. - type: integer - Authentication: + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string + SelectiveGapicGeneration: + type: object + description: >- + This message is used to configure the generation of a subset of the RPCs + in a service for client libraries. + id: SelectiveGapicGeneration properties: - rules: - items: - $ref: '#/components/schemas/AuthenticationRule' - description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - providers: - description: Defines a set of authentication providers that a service supports. + methods: items: - $ref: '#/components/schemas/AuthProvider' + type: string type: array - description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + description: >- + An allowlist of the fully qualified names of RPCs that should be + included on public client surfaces. + CancelOperationRequest: type: object - id: Authentication - Subnetwork: + description: The request message for Operations.CancelOperation. + id: CancelOperationRequest + properties: {} + JwtLocation: + id: JwtLocation type: object - description: >- - Represents a subnet that was created or discovered by a private access - management service. - id: Subnetwork + description: Specifies a location to extract JWT from an API request. properties: - name: + cookie: type: string - description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ - outsideAllocation: - type: boolean - description: >- - This is a discovered subnet that is not within the current consumer - allocated ranges. - ipCidrRange: - description: Subnetwork CIDR range in `10.x.x.x/y` format. + description: Specifies cookie name to extract JWT token. + header: + description: Specifies HTTP header name to extract JWT token. type: string - network: - description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` + valuePrefix: type: string - secondaryIpRanges: - description: List of secondary IP ranges in this subnetwork. - items: - $ref: '#/components/schemas/SecondaryIpRange' - type: array - region: + description: >- + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + query: type: string - description: GCP region where the subnetwork is located. - AuthProvider: - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + description: Specifies URL query parameter name to extract JWT token. + BackendRule: type: object - id: AuthProvider properties: - jwksUri: - type: string + deadline: + format: double description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - authorizationUrl: + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + type: number + pathTranslation: + type: string + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + overridesByRequestProtocol: + description: The map between request protocol and the backend address. + additionalProperties: + $ref: '#/components/schemas/BackendRule' + type: object + protocol: type: string description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - audiences: + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. + operationDeadline: + type: number + format: double description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + selector: type: string - id: description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". + Selects the methods to which this rule applies. Refer to selector + for syntax details. + address: type: string - jwtLocations: description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - items: - $ref: '#/components/schemas/JwtLocation' - type: array - issuer: + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + jwtAudience: type: string description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - AddRolesMetadata: - type: object - properties: {} + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. + disableAuth: + type: boolean + description: >- + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + minDeadline: + description: Deprecated, do not use. + deprecated: true + type: number + format: double + description: A backend rule provides configuration for an individual API element. + id: BackendRule + AddDnsZoneMetadata: description: >- Metadata provided through GetOperation request for the LRO generated by - AddRoles API - id: AddRolesMetadata - PhpSettings: - type: object - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - description: Settings for Php client libraries. - id: PhpSettings - ExperimentalFeatures: + AddDnsZone API + properties: {} type: object - id: ExperimentalFeatures + id: AddDnsZoneMetadata + QuotaLimit: + id: QuotaLimit properties: - restAsyncIoEnabled: - type: boolean + duration: + type: string description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. - description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. - Api: - properties: - syntax: - description: The source syntax of the service. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + maxLimit: type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - methods: - items: - $ref: '#/components/schemas/Method' - description: The methods of this interface, in unspecified order. - type: array - options: - description: Any metadata attached to the interface. - type: array - items: - $ref: '#/components/schemas/Option' - mixins: - type: array - description: Included interfaces. See Mixin. - items: - $ref: '#/components/schemas/Mixin' - version: + format: int64 description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + displayName: type: string + description: >- + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. name: description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. type: string - sourceContext: - $ref: '#/components/schemas/SourceContext' + defaultLimit: description: >- - Source context for the protocol buffer service represented by this - message. - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. - type: object - id: Api - ListConnectionsResponse: - description: >- - ListConnectionsResponse is the response to list peering states for the - given service and consumer project. - id: ListConnectionsResponse - properties: - connections: - description: The list of Connections. - items: - $ref: '#/components/schemas/Connection' - type: array - type: object - JwtLocation: - id: JwtLocation - properties: - query: - description: Specifies URL query parameter name to extract JWT token. + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. type: string - valuePrefix: + format: int64 + freeTier: + type: string + description: >- + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + format: int64 + description: + type: string + description: >- + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + values: + description: >- + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + type: object + additionalProperties: + format: int64 + type: string + unit: type: string description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - header: - description: Specifies HTTP header name to extract JWT token. - type: string - cookie: + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + metric: type: string - description: Specifies cookie name to extract JWT token. + description: >- + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. type: object - description: Specifies a location to extract JWT from an API request. - Usage: - id: Usage - description: Configuration controlling usage of a service. + description: >- + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. + CustomErrorRule: + description: A custom error rule. + id: CustomErrorRule type: object properties: - requirements: + isErrorType: + type: boolean description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. - type: array - items: - type: string - rules: + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + selector: + type: string description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + Selects messages to which this rule applies. Refer to selector for + syntax details. + UpdateDnsRecordSetMetadata: + description: >- + Metadata provided through GetOperation request for the LRO generated by + UpdateDnsRecordSet API + type: object + id: UpdateDnsRecordSetMetadata + properties: {} + EnumValue: + description: Enum value definition. + properties: + number: + format: int32 + type: integer + description: Enum value number. + options: type: array + description: Protocol buffer options. items: - $ref: '#/components/schemas/UsageRule' - producerNotificationChannel: - description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. + $ref: '#/components/schemas/Option' + name: + description: Enum value name. type: string - DnsRecordSet: + id: EnumValue + type: object + ConsumerProject: + description: Represents a consumer project. + type: object properties: - data: - items: - type: string + projectNum: + format: int64 + type: string description: >- - Required. As defined in RFC 1035 (section 5) and RFC 1034 (section - 3.6.1) for examples see - https://cloud.google.com/dns/records/json-record. - type: array - type: + Required. Project number of the consumer that is launching the + service instance. It can own the network that is peered with Google + or, be a service project in an XPN where the host project has the + network. + id: ConsumerProject + HttpRule: + description: >- + gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC method and one or more HTTP REST endpoints. It allows developers to + build a single API service that supports both gRPC APIs and REST APIs. + Many systems, including [Google + APIs](https://github.com/googleapis/googleapis), [Cloud + Endpoints](https://cloud.google.com/endpoints), [gRPC + Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + and use it for large scale production services. `HttpRule` defines the + schema of the gRPC/REST mapping. The mapping specifies how different + portions of the gRPC request message are mapped to the URL path, URL + query parameters, and HTTP request body. It also controls how the gRPC + response message is mapped to the HTTP response body. `HttpRule` is + typically specified as an `google.api.http` annotation on the gRPC + method. Each mapping specifies a URL path template and an HTTP method. + The path template may refer to one or more fields in the gRPC request + message, as long as each field is a non-repeated field with a primitive + (non-message) type. The path template controls how fields of the request + message are mapped to the URL path. Example: service Messaging { rpc + GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message + GetMessageRequest { string name = 1; // Mapped to URL path. } message + Message { string text = 1; // The resource content. } This enables an + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + "foo"))` Note that fields which are mapped to URL query parameters must + have a primitive type or a repeated primitive type or a non-repeated + message type. In the case of a repeated type, the parameter can be + repeated in the URL as `...?param=A¶m=B`. In the case of a message + type, each field of the message is mapped to a separate parameter, such + as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request + body, the `body` field specifies the mapping. Consider a REST update + method on the message resource collection: service Messaging { rpc + UpdateMessage(UpdateMessageRequest) returns (Message) { option + (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" + }; } } message UpdateMessageRequest { string message_id = 1; // mapped + to the URL Message message = 2; // mapped to the body } The following + HTTP JSON to RPC mapping is enabled, where the representation of the + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The + special name `*` can be used in the body mapping to define that every + field not bound by the path template should be mapped to the request + body. This enables the following alternative definition of the update + method: service Messaging { rpc UpdateMessage(Message) returns (Message) + { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: + "*" }; } } message Message { string message_id = 1; string text = 2; } + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using + `*` in the body mapping, it is not possible to have HTTP parameters, as + all fields not bound by the path end in the body. This makes this option + more rarely used in practice when defining REST APIs. The common usage + of `*` is in custom methods which don't use the URL at all for + transferring data. It is possible to define multiple HTTP methods for + one RPC by using the `additional_bindings` option. Example: service + Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/messages/{message_id}" + additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } + }; } } message GetMessageRequest { string message_id = 1; string user_id + = 2; } This enables the following two alternative HTTP JSON to RPC + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{var}`. If a variable contains multiple path segments, such as + `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a + URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` + are percent-encoded. The server side does the reverse decoding, except + "%2F" and "%2f" are left unchanged. Such variables show up in the + [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{+var}`. Using gRPC API Service Configuration gRPC API Service + Configuration (service config) is a configuration language for + configuring a gRPC service to become a user-facing product. The service + config is simply the YAML representation of the `google.api.Service` + proto message. As an alternative to annotating your proto file, you can + configure gRPC transcoding in your service config YAML files. You do + this by specifying a `HttpRule` that maps the gRPC method to a REST + endpoint, achieving the same effect as the proto annotation. This can be + particularly useful if you have a proto that is reused in multiple + services. Note that any transcoding specified in the service config will + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC + Transcoding is used to map a gRPC to JSON REST endpoints, the proto to + JSON conversion must follow the [proto3 + specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + While the single segment variable follows the semantics of [RFC + 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + Expansion, the multi segment variable **does not** follow RFC 6570 + Section 3.2.3 Reserved Expansion. The reason is that the Reserved + Expansion does not expand special characters like `?` and `#`, which + would lead to invalid URLs. As the result, gRPC Transcoding uses a + custom encoding for multi segment variables. The path variables **must + not** refer to any repeated or mapped field, because client libraries + are not capable of handling such variable expansion. The path variables + **must not** capture the leading "/" character. The reason is that the + most common use case "{var}" does not capture the leading "/" character. + For consistency, all path variables must share the same behavior. + Repeated message fields must not be mapped to URL query parameters, + because no client library can support such complicated mapping. If an + API needs to use a JSON array for request or response body, it can map + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. + properties: + responseBody: type: string - description: Required. The identifier of a supported record type. - domain: description: >- - Required. The DNS or domain name of the record set, e.g. - `test.example.com`. Cloud DNS requires that a DNS suffix ends with a - trailing dot. + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + selector: + description: >- + Selects a method to which this rule applies. Refer to selector for + syntax details. type: string - ttl: + patch: + description: Maps to HTTP PATCH. Used for updating a resource. type: string - format: google-duration + body: description: >- - Required. The period of time for which this RecordSet can be cached - by resolvers. - type: object - description: Represents a DNS record set resource. - id: DnsRecordSet - DisableVpcServiceControlsRequest: - description: Request to disable VPC service controls. - properties: - consumerNetwork: + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + type: string + delete: + type: string + description: Maps to HTTP DELETE. Used for deleting a resource. + put: + description: Maps to HTTP PUT. Used for replacing a resource. type: string + get: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. - type: object - id: DisableVpcServiceControlsRequest - ListOperationsResponse: - id: ListOperationsResponse - properties: - nextPageToken: - description: The standard List next-page token. + Maps to HTTP GET. Used for listing and getting information about + resources. type: string - operations: + post: + type: string + description: >- + Maps to HTTP POST. Used for creating a resource or performing an + action. + custom: + description: >- + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + $ref: '#/components/schemas/CustomHttpPattern' + additionalBindings: items: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/HttpRule' description: >- - A list of operations that matches the specified filter in the - request. + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). type: array + id: HttpRule type: object - description: The response message for Operations.ListOperations. - DeleteConnectionMetadata: - id: DeleteConnectionMetadata - type: object + Http: description: >- - Metadata provided through GetOperation request for the LRO generated by - Delete Connection API - properties: {} - GoSettings: + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + id: Http type: object properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - description: Settings for Go client libraries. - id: GoSettings - ListDnsZonesResponse: - properties: - dnsZonePairs: + fullyDecodeReservedExpansion: description: >- - All pairs of private DNS zones in the shared producer host project - and the matching peering zones in the consumer project.. + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: boolean + rules: type: array - items: - $ref: '#/components/schemas/DnsZonePair' - type: object - description: >- - Represents all DNS zones in the shared producer host project and the - matching peering zones in the consumer project. - id: ListDnsZonesResponse - GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: - description: Allocated IP address ranges for this private service access connection. - id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange - properties: - address: - description: >- - The starting address of the reserved range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix length is the CIDR range for the reserved range. - type: string - ipPrefixLength: - description: The prefix length of the reserved range. - type: integer - format: int32 - name: - description: The name of the reserved range. - type: string - type: object - MetricRule: - id: MetricRule - type: object - properties: - metricCosts: - additionalProperties: - format: int64 - type: string - type: object - description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - selector: - type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - SystemParameterRule: + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + items: + $ref: '#/components/schemas/HttpRule' + Logging: type: object - id: SystemParameterRule + id: Logging properties: - selector: - type: string + producerDestinations: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - parameters: + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. items: - $ref: '#/components/schemas/SystemParameter' - description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. + $ref: '#/components/schemas/LoggingDestination' type: array - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - SecondaryIpRangeSpec: - properties: - requestedAddress: - type: string - description: >- - Optional. The starting address of a range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix range is the CIDR range for the secondary IP range. - The range must be within the allocated range that is assigned to the - private connection. If the CIDR range isn't available, the call - fails. - rangeName: - type: string - description: >- - Required. A name for the secondary IP range. The name must be 1-63 - characters long, and comply with RFC1035. The name must be unique - within the subnetwork. - outsideAllocationPublicIpRange: - type: string - description: >- - Optional. Enable outside allocation using public IP addresses. Any - public IP range may be specified. If this field is provided, we will - not use customer reserved ranges for this secondary IP range. - ipPrefixLength: - description: >- - Required. The prefix length of the secondary IP range. Use CIDR - range notation, such as `30` to provision a secondary IP range with - an `x.x.x.x/30` CIDR range. The IP address range is drawn from a - pool of available ranges in the service consumer's allocated range. - format: int32 - type: integer - id: SecondaryIpRangeSpec - type: object - DeleteConnectionRequest: - id: DeleteConnectionRequest - type: object - properties: - consumerNetwork: - type: string - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is a network name. - description: >- - Request to delete a private service access connection. The call will - fail if there are any managed service instances using this connection. - AddDnsRecordSetMetadata: - description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsRecordSet API - type: object - id: AddDnsRecordSetMetadata - properties: {} - CustomHttpPattern: - id: CustomHttpPattern - description: A custom pattern is used for defining custom HTTP verb. - type: object - properties: - path: - type: string - description: The path matched by this custom verb. - kind: - type: string - description: The name of this custom HTTP verb. - EnableVpcServiceControlsRequest: + consumerDestinations: + type: array + items: + $ref: '#/components/schemas/LoggingDestination' + description: >- + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. + description: >- + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history + Connection: type: object - id: EnableVpcServiceControlsRequest properties: - consumerNetwork: + network: type: string description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. - description: Request to enable VPC service controls. - GoogleCloudServicenetworkingV1betaConnection: - properties: + The name of service consumer's VPC network that's connected with + service producer network, in the following format: + `projects/{project}/global/networks/{network}`. `{project}` is a + project number, such as in `12345` that includes the VPC service + consumer's VPC network. `{network}` is the name of the service + consumer's VPC network. + peering: + readOnly: true + description: >- + Output only. The name of the VPC Network Peering connection that was + created by the service producer. + type: string reservedPeeringRanges: description: >- The name of one or more allocated IP address ranges for this service - producer of type `PEERING`. Note that invoking this method with a - different range when connection is already established will not - modify already provisioned service producer subnetworks. + producer of type `PEERING`. Note that invoking CreateConnection + method with a different range when connection is already established + will not modify already provisioned service producer subnetworks. If + CreateConnection method is invoked repeatedly to reconnect when + peering connection had been disconnected on the consumer side, + leaving this field empty will restore previously allocated IP + ranges. type: array items: type: string service: + readOnly: true description: >- Output only. The name of the peering service that's associated with this connection, in the following format: `services/{service name}`. type: string - peering: - type: string - description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. - network: - description: >- - The name of service consumer's VPC network that's connected with - service producer network, in the following format: - `projects/{project}/global/networks/{network}`. `{project}` is a - project number, such as in `12345` that includes the VPC service - consumer's VPC network. `{network}` is the name of the service - consumer's VPC network. - type: string description: >- Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network. - id: GoogleCloudServicenetworkingV1betaConnection + id: Connection + PartialDeleteConnectionMetadata: + properties: {} + type: object + id: PartialDeleteConnectionMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + Partial Delete Connection API + Billing: + properties: + consumerDestinations: + type: array + items: + $ref: '#/components/schemas/BillingDestination' + description: >- + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count + type: object + id: Billing + SourceInfo: type: object + id: SourceInfo + properties: + sourceFiles: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + description: All files used during config generation. + description: Source information used to create a Service Config PythonSettings: description: Settings for Python client libraries. - id: PythonSettings type: object + id: PythonSettings properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' experimentalFeatures: $ref: '#/components/schemas/ExperimentalFeatures' description: >- Experimental features to be included during client library generation. - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - MethodPolicy: + LabelDescriptor: + id: LabelDescriptor + type: object properties: - requestPolicies: - type: array - items: - $ref: '#/components/schemas/FieldPolicy' - description: Policies that are applicable to the request message. - selector: - description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . + description: + description: A human-readable description for the label. type: string - type: object - id: MethodPolicy - description: Defines policies applying to an RPC method. - ContextRule: - type: object + valueType: + description: The type of data that can be assigned to the label. + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + enum: + - STRING + - BOOL + - INT64 + type: string + key: + description: The label key. + type: string + description: A description of a label. + Quota: properties: - allowedRequestExtensions: - type: array - items: - type: string - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - requested: + metricRules: type: array description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. items: - type: string - provided: - type: array - description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. + $ref: '#/components/schemas/MetricRule' + limits: + description: List of QuotaLimit definitions for the service. items: - type: string - allowedResponseExtensions: - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. + $ref: '#/components/schemas/QuotaLimit' type: array - items: - type: string - selector: + type: object + id: Quota + description: >- + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + OAuthRequirements: + description: >- + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. + properties: + canonicalScopes: type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - id: ContextRule - description: >- - A context rule provides information about the context for an individual - API element. - AddSubnetworkRequest: + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read + id: OAuthRequirements type: object + Operation: + id: Operation properties: - ipPrefixLength: - format: int32 - type: integer + response: description: >- - Required. The prefix length of the subnet's IP address range. Use - CIDR range notation, such as `29` to provision a subnet with an - `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool - of available ranges in the service consumer's allocated range. GCE - disallows subnets with prefix_length > 29 - allowSubnetCidrRoutesOverlap: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + metadata: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object description: >- - Optional. Defines the allowSubnetCidrRoutesOverlap field of the - subnet, e.g. Available in alpha and beta according to [Compute API - documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert) - type: boolean - subnetworkUsers: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + name: description: >- - A list of members that are granted the - `roles/servicenetworking.subnetworkAdmin` role on the subnet. - type: array - items: - type: string - computeIdempotencyWindow: - format: google-duration + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + done: description: >- - Optional. Specifies a custom time bucket for Arcus subnetwork - request idempotency. If two equivalent concurrent requests are made, - Arcus will know to ignore the request if it has already been - completed or is in progress. Only requests with matching - compute_idempotency_window have guaranteed idempotency. Changing - this time window between requests results in undefined behavior. - Zero (or empty) value with custom_compute_idempotency_window=true - specifies no idempotency (i.e. no request ID is provided to Arcus). - Maximum value of 14 days (enforced by Arcus limit). For more - information on how to use, see: go/revisit-sn-idempotency-window - useCustomComputeIdempotencyWindow: - type: boolean - description: >- - Optional. Specifies if Service Networking should use a custom time - bucket for Arcus idempotency. If false, Service Networking uses a - 300 second (5 minute) Arcus idempotency window. If true, Service - Networking uses a custom idempotency window provided by the user in - field compute_idempotency_window. For more information on how to - use, see: go/revisit-sn-idempotency-window - requestedRanges: - description: >- - Optional. The name of one or more allocated IP address ranges - associated with this private service access connection. If no range - names are provided all ranges associated with this connection will - be considered. If a CIDR range with the specified IP prefix length - is not available within these ranges, the call fails. - items: - type: string - type: array - secondaryIpRangeSpecs: - type: array - items: - $ref: '#/components/schemas/SecondaryIpRangeSpec' - description: >- - Optional. A list of secondary IP ranges to be created within the new - subnetwork. - checkServiceNetworkingUsePermission: + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. type: boolean + error: + $ref: '#/components/schemas/Status' description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - region: - type: string + The error result of the operation in case of failure or + cancellation. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + Range: + properties: + network: description: >- - Required. The name of a [region](/compute/docs/regions-zones) for - the subnet, such `europe-west1`. - description: - type: string - description: Optional. Description of the subnet. - role: + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` type: string + ipCidrRange: description: >- - Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For - information about the roles that can be set using this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - subnetwork: + CIDR range in "10.x.x.x/y" format that is within the allocated + ranges and currently unused. type: string + id: Range + type: object + description: Represents a found unused range. + UsageRule: + id: UsageRule + description: >- + Usage configuration rules for the service. NOTE: Under development. Use + this rule to configure unregistered calls for the service. Unregistered + calls are calls that do not contain consumer project identity. (Example: + calls that do not contain an API key). By default, API methods do not + allow unregistered calls, and each method call must be identified by a + consumer project identity. Use this rule to allow/disallow unregistered + calls. Example of an API that wants to allow unregistered calls for + entire service. usage: rules: - selector: "*" allow_unregistered_calls: + true Example of a method that wants to allow unregistered calls. usage: + rules: - selector: "google.example.library.v1.LibraryService.CreateBook" + allow_unregistered_calls: true + type: object + properties: + allowUnregisteredCalls: description: >- - Required. A name for the new subnet. For information about the - naming requirements, see - [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the - Compute API documentation. - outsideAllocationPublicIpRange: - description: >- - Optional. Enable outside allocation using public IP addresses. Any - public IP range may be specified. If this field is provided, we will - not use customer reserved ranges for this primary IP range. - type: string - consumer: + If true, the selected method allows unregistered calls, e.g. calls + that don't identify any user or application. + type: boolean + skipServiceControl: + type: boolean description: >- - Required. A resource that represents the service consumer, such as - `projects/123456`. The project number can be different from the - value in the consumer network parameter. For example, the network - might be part of a Shared VPC network. In those cases, Service - Networking validates that this resource belongs to that Shared VPC. - type: string - consumerNetwork: + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + selector: type: string description: >- - Required. The name of the service consumer's VPC network. The - network must have an existing private connection that was - provisioned through the connections.create method. The name must be - in the following format: - `projects/{project}/global/networks/{network}`, where {project} is a - project number, such as `12345`. {network} is the name of a VPC - network in the project. - purpose: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + ListPeeredDnsDomainsResponse: + id: ListPeeredDnsDomainsResponse + type: object + properties: + peeredDnsDomains: + items: + $ref: '#/components/schemas/PeeredDnsDomain' + description: The list of peered DNS domains. + type: array + description: Response to list peered DNS domains for a given connection. + Endpoint: + type: object + id: Endpoint + properties: + name: type: string - description: >- - Optional. Defines the purpose field of the subnet, e.g. - 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that - can be set using this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - internalRange: + description: The canonical name of this endpoint. + target: type: string description: >- - Optional. The url of an Internal Range. Eg: - `projects//locations/global/internalRanges/`. If specified, it means - that the subnetwork cidr will be created using the combination of - requested_address/ip_prefix_length. Note that the subnet cidr has to - be within the cidr range of this Internal Range. - skipRequestedAddressValidation: + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". + allowCors: type: boolean description: >- - Optional. Skips validating if the requested_address is in use by SN - VPC’s peering group. Compute Engine will still perform this check - and fail the request if the requested_address is in use. Note that - Compute Engine does not check for the existence of dynamic routes - when performing this check. Caller of this API should make sure that - there are no dynamic routes overlapping with the - requested_address/prefix_length IP address range otherwise the - created subnet could cause misrouting. - requestedAddress: - type: string - description: >- - Optional. The starting address of a range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix range is the CIDR range for the subnet. The range must - be within the allocated range that is assigned to the private - connection. If the CIDR range isn't available, the call fails. - privateIpv6GoogleAccess: + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. + aliases: + items: + type: string description: >- - Optional. The private IPv6 google access type for the VMs in this - subnet. For information about the access types that can be set using - this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - type: string - description: Request to create a subnetwork in a previously peered service network. - id: AddSubnetworkRequest - Billing: + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + type: array description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count - id: Billing + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + RemoveDnsRecordSetResponse: + id: RemoveDnsRecordSetResponse + description: Blank message response type for RemoveDnsRecordSet API + properties: {} + type: object + DnsRecordSet: type: object + id: DnsRecordSet properties: - consumerDestinations: + ttl: + type: string + format: google-duration + description: >- + Required. The period of time for which this RecordSet can be cached + by resolvers. + data: items: - $ref: '#/components/schemas/BillingDestination' + type: string description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. + Required. As defined in RFC 1035 (section 5) and RFC 1034 (section + 3.6.1) for examples see + https://cloud.google.com/dns/records/json-record. type: array - Backend: - description: '`Backend` defines the backend configuration for a service.' + domain: + type: string + description: >- + Required. The DNS or domain name of the record set, e.g. + `test.example.com`. Cloud DNS requires that a DNS suffix ends with a + trailing dot. + type: + type: string + description: Required. The identifier of a supported record type. + description: Represents a DNS record set resource. + SystemParameters: properties: rules: - description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/BackendRule' type: array - id: Backend + items: + $ref: '#/components/schemas/SystemParameterRule' + description: >- + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. type: object - Publishing: + id: SystemParameters description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + ClientLibrarySettings: + description: Details about how and where to publish client libraries. type: object - id: Publishing + id: ClientLibrarySettings properties: - newIssueUri: - type: string - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - protoReferenceDocumentationUri: + restNumericEnums: + type: boolean description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc + When using transport=rest, the client request will encode enums as + numbers rather than strings. + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + description: Launch stage of this version of the API. type: string - githubLabel: + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. + cppSettings: + $ref: '#/components/schemas/CppSettings' + description: Settings for C++ client libraries. + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + phpSettings: + $ref: '#/components/schemas/PhpSettings' + description: Settings for PHP client libraries. + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' + goSettings: + $ref: '#/components/schemas/GoSettings' + description: Settings for Go client libraries. + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. + version: description: >- - GitHub label to apply to issues and pull requests opened for this - API. + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". type: string - apiShortName: + Control: + id: Control + properties: + environment: type: string description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". - librarySettings: - description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. - items: - $ref: '#/components/schemas/ClientLibrarySettings' - type: array - organization: - type: string - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - description: For whom the client library is being published. - methodSettings: + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + methodPolicies: type: array items: - $ref: '#/components/schemas/MethodSettings' - description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - documentationUri: + $ref: '#/components/schemas/MethodPolicy' + description: Defines policies applying to the API methods of the service. + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + type: object + SourceContext: + id: SourceContext + type: object + properties: + fileName: + type: string description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + description: >- + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. + AuthenticationRule: + id: AuthenticationRule + type: object + properties: + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string - codeownerGithubTeams: + allowWithoutCredential: + type: boolean description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + requirements: + description: Requirements for additional authentication providers. type: array items: - type: string - docTagPrefix: - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - type: string - restReferenceDocumentationUri: - type: string + $ref: '#/components/schemas/AuthRequirement' + oauth: + description: The requirements for OAuth credentials. + $ref: '#/components/schemas/OAuthRequirements' + description: >- + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + Authentication: + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + type: object + id: Authentication + properties: + providers: + type: array + items: + $ref: '#/components/schemas/AuthProvider' + description: Defines a set of authentication providers that a service supports. + rules: description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/AuthenticationRule' + PhpSettings: + description: Settings for Php client libraries. + type: object + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + id: PhpSettings + GoSettings: + id: GoSettings + description: Settings for Go client libraries. + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + type: object DocumentationRule: properties: - disableReplacementWords: - type: string - description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. deprecationDescription: type: string description: >- @@ -4098,66 +4124,34 @@ components: components. To specify a default for all applicable elements, the whole pattern "*" is used. type: string - description: + disableReplacementWords: type: string + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + description: description: >- Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. - description: A documentation rule provides information about individual API elements. + type: string type: object + description: A documentation rule provides information about individual API elements. id: DocumentationRule - CustomError: - description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - id: CustomError - type: object - properties: - rules: - items: - $ref: '#/components/schemas/CustomErrorRule' - description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. - type: array - types: - type: array - description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - items: - type: string - BillingDestination: - type: object - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). + DisableVpcServiceControlsRequest: properties: - metrics: - items: - type: string - description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - type: array - monitoredResource: + consumerNetwork: type: string description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - id: BillingDestination + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. + description: Request to disable VPC service controls. + id: DisableVpcServiceControlsRequest + type: object parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -4167,18 +4161,15 @@ components: name: quotaUser schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - callback: - description: JSONP + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv schema: type: string + enum: + - '1' + - '2' alt: description: Data format for response. in: query @@ -4189,6 +4180,18 @@ components: - json - media - proto + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string fields: description: Selector specifying which fields to include in a partial response. in: query @@ -4201,225 +4204,162 @@ components: name: prettyPrint schema: type: boolean - _.xgafv: - description: V1 error format. + 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. in: query - name: $.xgafv + name: key schema: type: string - enum: - - '1' - - '2' oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: key - schema: - type: string - x-stackQL-resources: - operations: - id: google.servicenetworking.operations - name: operations - title: Operations - methods: - get: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - cancel: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - dns_zones: - id: google.servicenetworking.dns_zones - name: dns_zones - title: Dns_zones + name: uploadType + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + x-stackQL-resources: + services: + id: google.servicenetworking.services + name: services + title: Services methods: - remove: + validate: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:remove/post' + $ref: '#/paths/~1v1~1services~1{servicesId}:validate/post' response: mediaType: application/json openAPIDocKey: '200' - add: + disable_vpc_service_controls: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:add/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' - get: + search_range: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones~1{dnsZonesId}/get + $ref: '#/paths/~1v1~1services~1{servicesId}:searchRange/post' response: mediaType: application/json openAPIDocKey: '200' - list: + enable_vpc_service_controls: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones:list/get + #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_zones/methods/get' - - $ref: '#/components/x-stackQL-resources/dns_zones/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/dns_zones/methods/add' + select: [] + insert: [] update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/dns_zones/methods/remove' - connections: - id: google.servicenetworking.connections - name: connections - title: Connections + delete: [] + services_subnetwork: + id: google.servicenetworking.services_subnetwork + name: services_subnetwork + title: Services_subnetwork methods: - list: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/get' - response: - mediaType: application/json - openAPIDocKey: '200' - create: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/post' - response: - mediaType: application/json - openAPIDocKey: '200' - patch: + add_subnetwork: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/patch + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}:addSubnetwork/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/connections/methods/list' + select: [] insert: - - $ref: '#/components/x-stackQL-resources/connections/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/connections/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/services_subnetwork/methods/add_subnetwork + update: [] replace: [] delete: [] - connections_connection: - id: google.servicenetworking.connections_connection - name: connections_connection - title: Connections_connection + roles: + id: google.servicenetworking.roles + name: roles + title: Roles methods: - delete_connection: + add: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/post + $ref: '#/paths/~1v1~1services~1{servicesId}~1roles:add/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: '#/components/x-stackQL-resources/roles/methods/add' update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/connections_connection/methods/delete_connection - networks_vpc_service_controls: - id: google.servicenetworking.networks_vpc_service_controls - name: networks_vpc_service_controls - title: Networks_vpc_service_controls + delete: [] + dns_record_sets: + id: google.servicenetworking.dns_record_sets + name: dns_record_sets + title: Dns_record_sets methods: - get_vpc_service_controls: + add: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1vpcServiceControls/get + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/networks_vpc_service_controls/methods/get_vpc_service_controls - insert: [] - update: [] - replace: [] - delete: [] - networks_consumer_config: - id: google.servicenetworking.networks_consumer_config - name: networks_consumer_config - title: Networks_consumer_config - methods: - update_consumer_config: + list: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}:updateConsumerConfig/patch + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:list/get' + response: + mediaType: application/json + openAPIDocKey: '200' + remove: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:update/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/add' update: - - $ref: >- - #/components/x-stackQL-resources/networks_consumer_config/methods/update_consumer_config + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/update' replace: [] - delete: [] - networks: - id: google.servicenetworking.networks - name: networks - title: Networks + delete: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/remove' + dns_record_set: + id: google.servicenetworking.dns_record_set + name: dns_record_set + title: Dns_record_set methods: get: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}/get + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/networks/methods/get' + - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' insert: [] update: [] replace: [] @@ -4429,24 +4369,24 @@ components: name: peered_dns_domains title: Peered_dns_domains methods: - list: + delete: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/get + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains~1{peeredDnsDomainsId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/post + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/get response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains~1{peeredDnsDomainsId}/delete + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/post response: mediaType: application/json openAPIDocKey: '200' @@ -4459,158 +4399,225 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/delete' - dns_record_sets: - id: google.servicenetworking.dns_record_sets - name: dns_record_sets - title: Dns_record_sets + dns_zones: + id: google.servicenetworking.dns_zones + name: dns_zones + title: Dns_zones methods: - add: + list: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones:list/get response: mediaType: application/json openAPIDocKey: '200' - remove: + get: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones~1{dnsZonesId}/get response: mediaType: application/json openAPIDocKey: '200' - update: + add: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:update/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:add/post' response: mediaType: application/json openAPIDocKey: '200' - list: + remove: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:list/get' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:remove/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/list' + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/get' + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/add' - update: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/update' + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/add' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/remove' - dns_record_set: - id: google.servicenetworking.dns_record_set - name: dns_record_set - title: Dns_record_set + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/remove' + networks: + id: google.servicenetworking.networks + name: networks + title: Networks methods: get: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/networks/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + networks_vpc_service_controls: + id: google.servicenetworking.networks_vpc_service_controls + name: networks_vpc_service_controls + title: Networks_vpc_service_controls + methods: + get_vpc_service_controls: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1vpcServiceControls/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/networks_vpc_service_controls/methods/get_vpc_service_controls + insert: [] + update: [] + replace: [] + delete: [] + networks_consumer_config: + id: google.servicenetworking.networks_consumer_config + name: networks_consumer_config + title: Networks_consumer_config + methods: + update_consumer_config: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}:updateConsumerConfig/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/networks_consumer_config/methods/update_consumer_config replace: [] delete: [] - roles: - id: google.servicenetworking.roles - name: roles - title: Roles + connections_connection: + id: google.servicenetworking.connections_connection + name: connections_connection + title: Connections_connection methods: - add: + delete_connection: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1roles:add/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] - insert: - - $ref: '#/components/x-stackQL-resources/roles/methods/add' + insert: [] update: [] replace: [] - delete: [] - services: - id: google.servicenetworking.services - name: services - title: Services + delete: + - $ref: >- + #/components/x-stackQL-resources/connections_connection/methods/delete_connection + connections: + id: google.servicenetworking.connections + name: connections + title: Connections methods: - validate: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:validate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - enable_vpc_service_controls: + patch: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch + #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - search_range: + create: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:searchRange/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/post' response: mediaType: application/json openAPIDocKey: '200' - disable_vpc_service_controls: + list: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch + $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: [] + select: + - $ref: '#/components/x-stackQL-resources/connections/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/patch' replace: [] delete: [] - services_subnetwork: - id: google.servicenetworking.services_subnetwork - name: services_subnetwork - title: Services_subnetwork + operations: + id: google.servicenetworking.operations + name: operations + title: Operations methods: - add_subnetwork: + list: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}:addSubnetwork/post + $ref: '#/paths/~1v1~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/services_subnetwork/methods/add_subnetwork + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] update: [] replace: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: - /v1/operations/{operationsId}: + /v1/services/{servicesId}:validate: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' - get: + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/callback' + post: 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. - operationId: servicenetworking.operations.get + Service producers use this method to validate if the consumer provided + network, project and requested range are valid. This allows them to use + a fail-fast mechanism for consumer requests, and not have to wait for + AddSubnetwork operation completion to determine if user request is + invalid. + operationId: servicenetworking.services.validate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ValidateConsumerConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4626,20 +4633,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ValidateConsumerConfigResponse' parameters: - in: path - name: operationsId + name: servicesId required: true schema: type: string - 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`. - operationId: servicenetworking.operations.delete + /v1/services/{servicesId}:disableVpcServiceControls: + parameters: *ref_1 + patch: + description: Disables VPC service controls for a connection. + operationId: servicenetworking.services.disableVpcServiceControls + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisableVpcServiceControlsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4655,69 +4665,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: servicesId required: true schema: type: string - /v1/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: servicenetworking.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/service.management - Oauth2c: - - https://www.googleapis.com/auth/service.management - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOperationsResponse' - parameters: - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/operations/{operationsId}:cancel: + /v1/services/{servicesId}:searchRange: parameters: *ref_1 post: 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`. - operationId: servicenetworking.operations.cancel + Service producers can use this method to find a currently unused range + within consumer allocated ranges. This returned range is not reserved, + and not guaranteed to remain unused. It will validate previously + provided allocated ranges, find non-conflicting sub-range of requested + size (expressed in number of leading bits of ipv4 network mask, as in + CIDR range notation). + operationId: servicenetworking.services.searchRange requestBody: content: application/json: schema: - $ref: '#/components/schemas/CancelOperationRequest' + $ref: '#/components/schemas/SearchRangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4733,26 +4703,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: servicesId required: true schema: type: string - /v1/services/{servicesId}/dnsZones:remove: + /v1/services/{servicesId}:enableVpcServiceControls: parameters: *ref_1 - post: - description: >- - Service producers can use this method to remove private DNS zones in the - shared producer host project and matching peering zones in the consumer - project. - operationId: servicenetworking.services.dnsZones.remove + patch: + description: Enables VPC service controls for a connection. + operationId: servicenetworking.services.enableVpcServiceControls requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveDnsZoneRequest' + $ref: '#/components/schemas/EnableVpcServiceControlsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4775,19 +4742,24 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsZones:add: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork: parameters: *ref_1 post: description: >- - Service producers can use this method to add private DNS zones in the - shared producer host project and matching peering zones in the consumer - project. - operationId: servicenetworking.services.dnsZones.add + For service producers, provisions a new subnet in a peered service's + shared VPC network in the requested region and with the requested size + that's expressed as a CIDR range (number of leading bits of ipV4 network + mask). The method checks against the assigned allocated ranges to find a + non-conflicting IP address range. The method will reuse a subnet if + subsequent calls contain the same subnet name, region, and prefix + length. This method will make producer's tenant project to be a shared + VPC service project as needed. + operationId: servicenetworking.services.addSubnetwork requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddDnsZoneRequest' + $ref: '#/components/schemas/AddSubnetworkRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4810,13 +4782,30 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/connections: + - in: path + name: servicesId1 + required: true + schema: + type: string + - in: path + name: servicesId2 + required: true + schema: + type: string + /v1/services/{servicesId}/roles:add: parameters: *ref_1 - get: + post: description: >- - List the private connections that are configured in a service consumer's - VPC network. - operationId: servicenetworking.services.connections.list + Service producers can use this method to add roles in the shared VPC + host project. Each role is bound to the provided member. Each role must + be selected from within an allowlisted set of roles. Each role is + applied at only the granularity specified in the allowlist. + operationId: servicenetworking.services.roles.add + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddRolesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4832,32 +4821,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: network - schema: - type: string + /v1/services/{servicesId}/dnsRecordSets:add: + parameters: *ref_1 post: description: >- - Creates a private connection that establishes a VPC Network Peering - connection to a VPC network in the service producer's organization. The - administrator of the service consumer's VPC network invokes this method. - The administrator must assign one or more allocated IP ranges for - provisioning subnetworks in the service producer's VPC network. This - connection is used for all supported services in the service producer's - organization, so it only needs to be invoked once. - operationId: servicenetworking.services.connections.create + Service producers can use this method to add DNS record sets to private + DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/AddDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4880,16 +4862,14 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/connections/{connectionsId}: + /v1/services/{servicesId}/dnsRecordSets:list: parameters: *ref_1 - patch: - description: Updates the allocated ranges that are assigned to a connection. - operationId: servicenetworking.services.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + get: + description: >- + Producers can use this method to retrieve a list of available DNS + RecordSets available inside the private zone on the tenant host project + accessible from their network. + operationId: servicenetworking.services.dnsRecordSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4905,35 +4885,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListDnsRecordSetsResponse' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - in: query - name: force + name: zone schema: - type: boolean + type: string - in: query - name: updateMask + name: consumerNetwork schema: type: string - format: google-fieldmask + /v1/services/{servicesId}/dnsRecordSets:remove: + parameters: *ref_1 post: - description: Deletes a private service access connection. - operationId: servicenetworking.services.connections.deleteConnection + description: >- + Service producers can use this method to remove DNS record sets from + private DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.remove requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteConnectionRequest' + $ref: '#/components/schemas/RemoveDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4956,19 +4934,18 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: + /v1/services/{servicesId}/dnsRecordSets:update: parameters: *ref_1 - get: + post: description: >- - Consumers use this method to find out the state of VPC Service Controls. - The controls could be enabled or disabled for a connection. - operationId: >- - servicenetworking.services.projects.global.networks.getVpcServiceControls + Service producers can use this method to update DNS record sets from + private DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4984,36 +4961,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VpcServiceControls' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId - required: true - schema: - type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: + /v1/services/{servicesId}/dnsRecordSets:get: parameters: *ref_1 - patch: + get: description: >- - Service producers use this method to update the configuration of their - connection including the import/export of custom routes and subnetwork - routes with public IP. - operationId: servicenetworking.services.projects.global.networks.updateConsumerConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateConsumerConfigRequest' + Producers can use this method to retrieve information about the DNS + record set added to the private zone inside the shared tenant host + project associated with a consumer network. + operationId: servicenetworking.services.dnsRecordSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5029,31 +4991,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/DnsRecordSet' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: projectsId - required: true + - in: query + name: consumerNetwork schema: type: string - - in: path - name: networksId - required: true + - in: query + name: domain schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: + - in: query + name: zone + schema: + type: string + - in: query + name: type + schema: + type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: parameters: *ref_1 - get: - description: >- - Service producers use this method to get the configuration of their - connection including the import/export of custom routes and subnetwork - routes with public IP. - operationId: servicenetworking.services.projects.global.networks.get + delete: + description: Deletes a peered DNS domain. + operationId: >- + servicenetworking.services.projects.global.networks.peeredDnsDomains.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5069,7 +5035,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConsumerConfig' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -5086,10 +5052,11 @@ paths: required: true schema: type: string - - in: query - name: includeUsedIpRanges + - in: path + name: peeredDnsDomainsId + required: true schema: - type: boolean + type: string /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains: parameters: *ref_1 get: @@ -5172,12 +5139,14 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones:list: parameters: *ref_1 - delete: - description: Deletes a peered DNS domain. - operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.delete + get: + description: >- + * Service producers can use this method to retrieve a list of available + DNS zones in the shared producer host project and the matching peering + zones in the consumer project. * + operationId: servicenetworking.services.projects.global.networks.dnsZones.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5193,7 +5162,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListDnsZonesResponse' parameters: - in: path name: servicesId @@ -5210,11 +5179,6 @@ paths: required: true schema: type: string - - in: path - name: peeredDnsDomainsId - required: true - schema: - type: string /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones/{dnsZonesId}: parameters: *ref_1 get: @@ -5260,14 +5224,14 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones:list: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: parameters: *ref_1 get: description: >- - * Service producers can use this method to retrieve a list of available - DNS zones in the shared producer host project and the matching peering - zones in the consumer project. * - operationId: servicenetworking.services.projects.global.networks.dnsZones.list + Service producers use this method to get the configuration of their + connection including the import/export of custom routes and subnetwork + routes with public IP. + operationId: servicenetworking.services.projects.global.networks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5283,7 +5247,51 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDnsZonesResponse' + $ref: '#/components/schemas/ConsumerConfig' + parameters: + - in: path + name: servicesId + required: true + schema: + type: string + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: networksId + required: true + schema: + type: string + - in: query + name: includeUsedIpRanges + schema: + type: boolean + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: + parameters: *ref_1 + get: + description: >- + Consumers use this method to find out the state of VPC Service Controls. + The controls could be enabled or disabled for a connection. + operationId: >- + servicenetworking.services.projects.global.networks.getVpcServiceControls + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/VpcServiceControls' parameters: - in: path name: servicesId @@ -5300,18 +5308,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:add: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: parameters: *ref_1 - post: + patch: description: >- - Service producers can use this method to add DNS record sets to private - DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.add + Service producers use this method to update the configuration of their + connection including the import/export of custom routes and subnetwork + routes with public IP. + operationId: servicenetworking.services.projects.global.networks.updateConsumerConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddDnsRecordSetRequest' + $ref: '#/components/schemas/UpdateConsumerConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5334,18 +5343,26 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:remove: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: networksId + required: true + schema: + type: string + /v1/services/{servicesId}/connections/{connectionsId}: parameters: *ref_1 post: - description: >- - Service producers can use this method to remove DNS record sets from - private DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.remove + description: Deletes a private service access connection. + operationId: servicenetworking.services.connections.deleteConnection requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveDnsRecordSetRequest' + $ref: '#/components/schemas/DeleteConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5368,18 +5385,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:update: - parameters: *ref_1 - post: - description: >- - Service producers can use this method to update DNS record sets from - private DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.update + - in: path + name: connectionsId + required: true + schema: + type: string + patch: + description: Updates the allocated ranges that are assigned to a connection. + operationId: servicenetworking.services.connections.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateDnsRecordSetRequest' + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5402,14 +5420,37 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:get: + - in: path + name: connectionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: force + schema: + type: boolean + /v1/services/{servicesId}/connections: parameters: *ref_1 - get: + post: description: >- - Producers can use this method to retrieve information about the DNS - record set added to the private zone inside the shared tenant host - project associated with a consumer network. - operationId: servicenetworking.services.dnsRecordSets.get + Creates a private connection that establishes a VPC Network Peering + connection to a VPC network in the service producer's organization. The + administrator of the service consumer's VPC network invokes this method. + The administrator must assign one or more allocated IP ranges for + provisioning subnetworks in the service producer's VPC network. This + connection is used for all supported services in the service producer's + organization, so it only needs to be invoked once. + operationId: servicenetworking.services.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5425,37 +5466,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DnsRecordSet' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: consumerNetwork - schema: - type: string - - in: query - name: domain - schema: - type: string - - in: query - name: zone - schema: - type: string - - in: query - name: type - schema: - type: string - /v1/services/{servicesId}/dnsRecordSets:list: - parameters: *ref_1 get: description: >- - Producers can use this method to retrieve a list of available DNS - RecordSets available inside the private zone on the tenant host project - accessible from their network. - operationId: servicenetworking.services.dnsRecordSets.list + List the private connections that are configured in a service consumer's + VPC network. + operationId: servicenetworking.services.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5471,7 +5493,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDnsRecordSetsResponse' + $ref: '#/components/schemas/ListConnectionsResponse' parameters: - in: path name: servicesId @@ -5479,27 +5501,22 @@ paths: schema: type: string - in: query - name: consumerNetwork - schema: - type: string - - in: query - name: zone + name: network schema: type: string - /v1/services/{servicesId}/roles:add: + /v1/services/{servicesId}/dnsZones:add: parameters: *ref_1 post: description: >- - Service producers can use this method to add roles in the shared VPC - host project. Each role is bound to the provided member. Each role must - be selected from within an allowlisted set of roles. Each role is - applied at only the granularity specified in the allowlist. - operationId: servicenetworking.services.roles.add + Service producers can use this method to add private DNS zones in the + shared producer host project and matching peering zones in the consumer + project. + operationId: servicenetworking.services.dnsZones.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddRolesRequest' + $ref: '#/components/schemas/AddDnsZoneRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5522,21 +5539,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:validate: + /v1/services/{servicesId}/dnsZones:remove: parameters: *ref_1 post: description: >- - Service producers use this method to validate if the consumer provided - network, project and requested range are valid. This allows them to use - a fail-fast mechanism for consumer requests, and not have to wait for - AddSubnetwork operation completion to determine if user request is - invalid. - operationId: servicenetworking.services.validate + Service producers can use this method to remove private DNS zones in the + shared producer host project and matching peering zones in the consumer + project. + operationId: servicenetworking.services.dnsZones.remove requestBody: content: application/json: schema: - $ref: '#/components/schemas/ValidateConsumerConfigRequest' + $ref: '#/components/schemas/RemoveDnsZoneRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5552,31 +5567,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ValidateConsumerConfigResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork: + /v1/operations: parameters: *ref_1 - post: + get: description: >- - For service producers, provisions a new subnet in a peered service's - shared VPC network in the requested region and with the requested size - that's expressed as a CIDR range (number of leading bits of ipV4 network - mask). The method checks against the assigned allocated ranges to find a - non-conflicting IP address range. The method will reuse a subnet if - subsequent calls contain the same subnet name, region, and prefix - length. This method will make producer's tenant project to be a shared - VPC service project as needed. - operationId: servicenetworking.services.addSubnetwork - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddSubnetworkRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: servicenetworking.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5592,33 +5596,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: path - name: servicesId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: servicesId1 - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: servicesId2 - required: true + - in: query + name: filter schema: type: string - /v1/services/{servicesId}:enableVpcServiceControls: + /v1/operations/{operationsId}: parameters: *ref_1 - patch: - description: Enables VPC service controls for a connection. - operationId: servicenetworking.services.enableVpcServiceControls - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EnableVpcServiceControlsRequest' + 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. + operationId: servicenetworking.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5637,26 +5637,17 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: servicesId + name: operationsId required: true schema: type: string - /v1/services/{servicesId}:searchRange: - parameters: *ref_1 - post: + delete: description: >- - Service producers can use this method to find a currently unused range - within consumer allocated ranges. This returned range is not reserved, - and not guaranteed to remain unused. It will validate previously - provided allocated ranges, find non-conflicting sub-range of requested - size (expressed in number of leading bits of ipv4 network mask, as in - CIDR range notation). - operationId: servicenetworking.services.searchRange - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SearchRangeRequest' + 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`. + operationId: servicenetworking.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5672,23 +5663,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: servicesId + name: operationsId required: true schema: type: string - /v1/services/{servicesId}:disableVpcServiceControls: + /v1/operations/{operationsId}:cancel: parameters: *ref_1 - patch: - description: Disables VPC service controls for a connection. - operationId: servicenetworking.services.disableVpcServiceControls + post: + 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`. + operationId: servicenetworking.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableVpcServiceControlsRequest' + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5704,10 +5704,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: servicesId + name: operationsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml b/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml index b1dcd44a..b91660ce 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml @@ -25,13 +25,13 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform.read-only: >- - View your data across Google Cloud services and see the email - address of your Google Account - https://www.googleapis.com/auth/service.management: Manage your Google API service configuration https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. + https://www.googleapis.com/auth/service.management: Manage your Google API service configuration + https://www.googleapis.com/auth/cloud-platform.read-only: >- + View your data across Google Cloud services and see the email + address of your Google Account Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -41,336 +41,429 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - EnumValue: - type: object - description: Enum value definition. - id: EnumValue - properties: - number: - type: integer - format: int32 - description: Enum value number. - options: - type: array - description: Protocol buffer options. - items: - $ref: '#/components/schemas/Option' - name: - type: string - description: Enum value name. - Empty: - properties: {} - 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 - type: object - LongRunning: - id: LongRunning + Impact: + description: A message to group impacts of updating a policy. type: object - description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). properties: - pollDelayMultiplier: - type: number - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - format: float - totalPollTimeout: - description: 'Total polling timeout. Default value: 5 minutes.' - type: string - format: google-duration - initialPollDelay: - description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. + detail: type: string - format: google-duration - maxPollDelay: + description: Output only. User friendly impact detail in a free form message. + readOnly: true + impactType: + enumDescriptions: + - >- + Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 + Block 0 - Special/Admin codes Block 1 - Impact Type of + ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of + ANALYSIS_TYPE_RESOURCE_USAGE ... + - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY + description: Output only. The type of impact. + enum: + - IMPACT_TYPE_UNSPECIFIED + - DEPENDENCY_MISSING_DEPENDENCIES type: string - description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - format: google-duration - GoogleApiServiceusageV1beta1ServiceIdentity: + readOnly: true + id: Impact + AuthenticationRule: + type: object properties: - uniqueId: + selector: type: string description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount - email: - type: string + Selects the methods to which this rule applies. Refer to selector + for syntax details. + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + allowWithoutCredential: description: >- - The email address of the service account that a service producer - would use to access consumer resources. - id: GoogleApiServiceusageV1beta1ServiceIdentity + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + type: boolean + requirements: + description: Requirements for additional authentication providers. + type: array + items: + $ref: '#/components/schemas/AuthRequirement' + id: AuthenticationRule description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + Monitoring: type: object - GoogleApiServiceusageV1ServiceConfig: - id: GoogleApiServiceusageV1ServiceConfig properties: - apis: + producerDestinations: type: array - description: >- - A list of API interfaces exported by this service. Contains only the - names, versions, and method names of the interfaces. items: - $ref: '#/components/schemas/Api' - monitoredResources: + $ref: '#/components/schemas/MonitoringDestination' + description: >- + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + consumerDestinations: type: array items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' + $ref: '#/components/schemas/MonitoringDestination' description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - name: + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + id: Monitoring + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + ListServicesResponse: + properties: + nextPageToken: type: string description: >- - The DNS address at which this service is available. An example DNS - address would be: `calendar.googleapis.com`. - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - monitoring: - $ref: '#/components/schemas/Monitoring' - description: >- - Monitoring configuration. This should not include the - 'producer_destinations' field. - documentation: - description: >- - Additional API documentation. Contains only the summary and the - documentation URL. - $ref: '#/components/schemas/Documentation' - endpoints: - description: >- - Configuration for network endpoints. Contains only the names and - aliases of the endpoints. - type: array + Token that can be passed to `ListServices` to resume a paginated + query. + services: items: - $ref: '#/components/schemas/Endpoint' - title: - description: The product title for this service. - type: string - authentication: - description: Auth configuration. Contains only the OAuth rules. - $ref: '#/components/schemas/Authentication' + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The available services for the requested project. + type: array + id: ListServicesResponse type: object - description: The configuration of the service. - Analysis: + description: Response message for the `ListServices` method. + JavaSettings: + description: Settings for Java client libraries. + id: JavaSettings type: object - description: A message to group the analysis information. - id: Analysis properties: - service: + serviceClassNames: + type: object + additionalProperties: + type: string description: >- - The names of the service that has analysis result of warnings or - blockers. Example: `services/storage.googleapis.com`. + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + libraryPackage: type: string - displayName: + description: >- + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + Publishing: + type: object + id: Publishing + properties: + newIssueUri: type: string - readOnly: true description: >- - Output only. The user friendly display name of the analysis type. - E.g. service dependency analysis, service resource usage analysis, - etc. - analysisType: + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + githubLabel: type: string - enumDescriptions: - - Unspecified analysis type. Do not use. - - The analysis of service dependencies. - - The analysis of service resource usage. - readOnly: true - enum: - - ANALYSIS_TYPE_UNSPECIFIED - - ANALYSIS_TYPE_DEPENDENCY - - ANALYSIS_TYPE_RESOURCE_USAGE - description: Output only. The type of analysis. - analysis: - description: Output only. Analysis result of updating a policy. - readOnly: true - $ref: '#/components/schemas/AnalysisResult' - SystemParameters: - properties: - rules: + description: >- + GitHub label to apply to issues and pull requests opened for this + API. + docTagPrefix: + type: string + description: >- + A prefix used in sample code when demarking regions to be included + in documentation. + protoReferenceDocumentationUri: + type: string + description: >- + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc + methodSettings: + description: >- + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. items: - $ref: '#/components/schemas/SystemParameterRule' + $ref: '#/components/schemas/MethodSettings' type: array - description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - type: object - id: SystemParameters - Authentication: - properties: - providers: + codeownerGithubTeams: items: - $ref: '#/components/schemas/AuthProvider' - description: Defines a set of authentication providers that a service supports. + type: string type: array - rules: description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - items: - $ref: '#/components/schemas/AuthenticationRule' - type: object - description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - id: Authentication - Status: - properties: - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - details: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + restReferenceDocumentationUri: + type: string description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + librarySettings: + items: + $ref: '#/components/schemas/ClientLibrarySettings' type: array - message: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. + documentationUri: + description: >- + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview type: string - id: Status - type: object + apiShortName: + description: >- + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". + type: string + organization: + type: string + description: For whom the client library is being published. + enumDescriptions: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - LoggingDestination: - id: LoggingDestination + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. + ListOperationsResponse: + type: object + id: ListOperationsResponse properties: - logs: + nextPageToken: + description: The standard List next-page token. + type: string + operations: type: array description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". + A list of operations that matches the specified filter in the + request. items: + $ref: '#/components/schemas/Operation' + description: The response message for Operations.ListOperations. + MetricRule: + properties: + selector: + type: string + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + metricCosts: + additionalProperties: type: string - monitoredResource: + format: int64 + type: object description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - type: string + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. type: object description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - AnalysisResult: + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + id: MetricRule + RubySettings: + description: Settings for Ruby client libraries. + id: RubySettings + type: object properties: - warnings: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + Quota: + id: Quota + type: object + properties: + limits: + description: List of QuotaLimit definitions for the service. items: - $ref: '#/components/schemas/Impact' - description: >- - Warning information indicating that the policy changes might be - unsafe, but will not block the changes at runtime. + $ref: '#/components/schemas/QuotaLimit' type: array - blockers: + metricRules: description: >- - Blocking information that would prevent the policy changes at - runtime. - items: - $ref: '#/components/schemas/Impact' - type: array - type: object - description: An analysis result including blockers and warnings. - id: AnalysisResult - BatchCreateAdminOverridesResponse: - type: object - properties: - overrides: - description: The overrides that were created. + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. type: array items: - $ref: '#/components/schemas/QuotaOverride' - description: Response message for BatchCreateAdminOverrides - id: BatchCreateAdminOverridesResponse - Impact: - properties: - detail: - description: Output only. User friendly impact detail in a free form message. - readOnly: true - type: string - impactType: - enumDescriptions: - - >- - Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 - Block 0 - Special/Admin codes Block 1 - Impact Type of - ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of - ANALYSIS_TYPE_RESOURCE_USAGE ... - - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY + $ref: '#/components/schemas/MetricRule' + description: >- + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + AuthProvider: + properties: + issuer: type: string - readOnly: true - enum: - - IMPACT_TYPE_UNSPECIFIED - - DEPENDENCY_MISSING_DEPENDENCIES - description: Output only. The type of impact. + description: >- + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com + jwksUri: + description: >- + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs + type: string + id: + type: string + description: >- + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". + audiences: + description: >- + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string + jwtLocations: + type: array + description: >- + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token + items: + $ref: '#/components/schemas/JwtLocation' + authorizationUrl: + description: >- + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. + type: string + id: AuthProvider type: object - id: Impact - description: A message to group impacts of updating a policy. - CancelOperationRequest: - id: CancelOperationRequest - description: The request message for Operations.CancelOperation. + description: >- + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + Context: type: object - properties: {} - DocumentationRule: properties: - disableReplacementWords: + rules: + items: + $ref: '#/components/schemas/ContextRule' description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. - type: string + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + id: Context + description: >- + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. + DocumentationRule: + type: object + id: DocumentationRule + description: A documentation rule provides information about individual API elements. + properties: selector: type: string description: >- @@ -387,264 +480,72 @@ components: description: >- Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. + disableReplacementWords: + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + type: string description: + type: string description: >- Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. - type: string - type: object - id: DocumentationRule - description: A documentation rule provides information about individual API elements. - Publishing: - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. + MetricDescriptor: + id: MetricDescriptor properties: - docTagPrefix: - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - type: string - newIssueUri: - type: string - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - protoReferenceDocumentationUri: - description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - type: string - apiShortName: - type: string - description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". - codeownerGithubTeams: - description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. + monitoredResourceTypes: type: array + description: >- + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. items: type: string - githubLabel: - type: string - description: >- - GitHub label to apply to issues and pull requests opened for this - API. - restReferenceDocumentationUri: - type: string - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - organization: - description: For whom the client library is being published. - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - type: string - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - documentationUri: - type: string + metadata: + $ref: '#/components/schemas/MetricDescriptorMetadata' + description: Optional. Metadata which can be used to guide usage of the metric. + labels: description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - librarySettings: + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. type: array items: - $ref: '#/components/schemas/ClientLibrarySettings' + $ref: '#/components/schemas/LabelDescriptor' + valueType: + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. - methodSettings: - description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - items: - $ref: '#/components/schemas/MethodSettings' - type: array - type: object - id: Publishing - Control: - type: object - description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - properties: - methodPolicies: - description: Defines policies applying to the API methods of the service. - type: array - items: - $ref: '#/components/schemas/MethodPolicy' - environment: - description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com - type: string - id: Control - MetricRule: - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - properties: - selector: - type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - metricCosts: - description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - type: object - additionalProperties: - format: int64 - type: string - id: MetricRule - type: object - GoogleApiServiceusageV1beta1GetServiceIdentityResponse: - type: object - description: Response message for getting service identity. - properties: - state: - description: Service identity state. - enumDescriptions: - - >- - Default service identity state. This value is used if the state is - omitted. - - Service identity has been created and can be used. - type: string - enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE - identity: - $ref: '#/components/schemas/GoogleApiServiceusageV1beta1ServiceIdentity' - description: >- - Service identity that service producer can use to access consumer - resources. If exists is true, it contains email and unique_id. If - exists is false, it contains pre-constructed email and empty - unique_id. - id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse - Type: - type: object - description: A protocol buffer message type. - properties: - edition: - type: string - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - name: - type: string - description: The fully qualified message name. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - oneofs: - description: The list of types appearing in `oneof` definitions in this type. - type: array - items: - type: string - options: - items: - $ref: '#/components/schemas/Option' - type: array - description: The protocol buffer options. - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. type: string - fields: - description: The list of fields. - items: - $ref: '#/components/schemas/Field' - type: array - id: Type - RubySettings: - description: Settings for Ruby client libraries. - id: RubySettings - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object - ImportAdminQuotaPoliciesMetadata: - id: ImportAdminQuotaPoliciesMetadata - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportAdminQuotaPolicies. - type: object - properties: {} - ClientLibrarySettings: - type: object - id: ClientLibrarySettings - properties: - dotnetSettings: - $ref: '#/components/schemas/DotnetSettings' - description: Settings for .NET client libraries. - nodeSettings: - description: Settings for Node client libraries. - $ref: '#/components/schemas/NodeSettings' - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - rubySettings: - description: Settings for Ruby client libraries. - $ref: '#/components/schemas/RubySettings' - restNumericEnums: - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - type: boolean - cppSettings: - description: Settings for C++ client libraries. - $ref: '#/components/schemas/CppSettings' launchStage: - description: Launch stage of this version of the API. type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -683,434 +584,369 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - version: - description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - type: string - javaSettings: - description: Settings for legacy Java features, supported in the Service YAML. - $ref: '#/components/schemas/JavaSettings' - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - description: Details about how and where to publish client libraries. - LabelDescriptor: - description: A description of a label. - properties: - key: - type: string - description: The label key. - valueType: - description: The type of data that can be assigned to the label. - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - type: string + description: Optional. The launch stage of the metric definition. enum: - - STRING - - BOOL - - INT64 - description: - description: A human-readable description for the label. + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: type: string - id: LabelDescriptor - type: object - OAuthRequirements: - properties: - canonicalScopes: description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" + unit: type: string - id: OAuthRequirements - type: object - description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. - HttpRule: - id: HttpRule - properties: - custom: - $ref: '#/components/schemas/CustomHttpPattern' description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - patch: - description: Maps to HTTP PATCH. Used for updating a resource. + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + description: + description: >- + A detailed description of the metric, which can be used in + documentation. type: string - selector: + metricKind: + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + description: >- + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + type: string + displayName: type: string description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - responseBody: + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + name: + type: string + description: The resource name of the metric descriptor. + type: object + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + UpdateConsumerPolicyMetadata: + type: object + id: UpdateConsumerPolicyMetadata + properties: {} + description: Metadata for the `UpdateConsumerPolicy` method. + EnumValue: + id: EnumValue + type: object + description: Enum value definition. + properties: + number: + type: integer + description: Enum value number. + format: int32 + name: type: string + description: Enum value name. + options: + description: Protocol buffer options. + items: + $ref: '#/components/schemas/Option' + type: array + Backend: + properties: + rules: + items: + $ref: '#/components/schemas/BackendRule' description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. - post: + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + description: '`Backend` defines the backend configuration for a service.' + id: Backend + type: object + JwtLocation: + properties: + valuePrefix: description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. type: string - get: + header: + type: string + description: Specifies HTTP header name to extract JWT token. + cookie: + type: string + description: Specifies cookie name to extract JWT token. + query: type: string + description: Specifies URL query parameter name to extract JWT token. + id: JwtLocation + description: Specifies a location to extract JWT from an API request. + type: object + AddEnableRulesMetadata: + type: object + id: AddEnableRulesMetadata + description: Metadata for the `AddEnableRules` method. + properties: {} + ServiceIdentity: + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + type: object + id: ServiceIdentity + properties: + email: description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - put: - description: Maps to HTTP PUT. Used for replacing a resource. + The email address of the service account that a service producer + would use to access consumer resources. + type: string + uniqueId: type: string - additionalBindings: - type: array description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - items: - $ref: '#/components/schemas/HttpRule' - delete: - description: Maps to HTTP DELETE. Used for deleting a resource. + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: + type: object + description: Metadata for the `UpdateConsumerPolicy` method. + properties: {} + id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata + FieldPolicy: + type: object + description: >- + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. + properties: + selector: + description: >- + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". type: string - body: + resourcePermission: type: string description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". + resourceType: + type: string + description: >- + Specifies the resource type for the resource referred to by the + field. + id: FieldPolicy + MethodPolicy: + properties: + requestPolicies: + items: + $ref: '#/components/schemas/FieldPolicy' + description: Policies that are applicable to the request message. + type: array + selector: + description: >- + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . + type: string + type: object + description: Defines policies applying to an RPC method. + id: MethodPolicy + ImportAdminOverridesMetadata: + id: ImportAdminOverridesMetadata type: object description: >- - gRPC Transcoding gRPC Transcoding is a feature for mapping between a - gRPC method and one or more HTTP REST endpoints. It allows developers to - build a single API service that supports both gRPC APIs and REST APIs. - Many systems, including [Google - APIs](https://github.com/googleapis/googleapis), [Cloud - Endpoints](https://cloud.google.com/endpoints), [gRPC - Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - and use it for large scale production services. `HttpRule` defines the - schema of the gRPC/REST mapping. The mapping specifies how different - portions of the gRPC request message are mapped to the URL path, URL - query parameters, and HTTP request body. It also controls how the gRPC - response message is mapped to the HTTP response body. `HttpRule` is - typically specified as an `google.api.http` annotation on the gRPC - method. Each mapping specifies a URL path template and an HTTP method. - The path template may refer to one or more fields in the gRPC request - message, as long as each field is a non-repeated field with a primitive - (non-message) type. The path template controls how fields of the request - message are mapped to the URL path. Example: service Messaging { rpc - GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message - GetMessageRequest { string name = 1; // Mapped to URL path. } message - Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request - message which are not bound by the path template automatically become - HTTP query parameters if there is no HTTP request body. For example: - service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) - { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } - message GetMessageRequest { message SubMessage { string subfield = 1; } - string message_id = 1; // Mapped to URL path. int64 revision = 2; // - Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped - to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC - mapping as below: - HTTP: `GET - /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: - `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - "foo"))` Note that fields which are mapped to URL query parameters must - have a primitive type or a repeated primitive type or a non-repeated - message type. In the case of a repeated type, the parameter can be - repeated in the URL as `...?param=A¶m=B`. In the case of a message - type, each field of the message is mapped to a separate parameter, such - as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request - body, the `body` field specifies the mapping. Consider a REST update - method on the message resource collection: service Messaging { rpc - UpdateMessage(UpdateMessageRequest) returns (Message) { option - (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" - }; } } message UpdateMessageRequest { string message_id = 1; // mapped - to the URL Message message = 2; // mapped to the body } The following - HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: - HTTP: - `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The - special name `*` can be used in the body mapping to define that every - field not bound by the path template should be mapped to the request - body. This enables the following alternative definition of the update - method: service Messaging { rpc UpdateMessage(Message) returns (Message) - { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: - "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH - /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using - `*` in the body mapping, it is not possible to have HTTP parameters, as - all fields not bound by the path end in the body. This makes this option - more rarely used in practice when defining REST APIs. The common usage - of `*` is in custom methods which don't use the URL at all for - transferring data. It is possible to define multiple HTTP methods for - one RPC by using the `additional_bindings` option. Example: service - Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/messages/{message_id}" - additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } - }; } } message GetMessageRequest { string message_id = 1; string user_id - = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: - HTTP: `GET /v1/messages/123456` - gRPC: - `GetMessage(message_id: "123456")` - HTTP: `GET - /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" - message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields - (recursive expansion nested messages in the request message) are - classified into three categories: - Fields referred by the path - template. They are passed via the URL path. - Fields referred by the - HttpRule.body. They are passed via the HTTP request body. - All other - fields are passed via the URL query parameters, and the parameter name - is the field path in the request message. A repeated field can be - represented as multiple query parameters under the same name. 2. If - HttpRule.body is "*", there is no URL query parameter, all fields are - passed via URL path and HTTP request body. 3. If HttpRule.body is - omitted, there is no HTTP request body, all fields are passed via URL - path and URL query parameters. Path template syntax Template = "/" - Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | - "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] - "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax - `*` matches a single URL path segment. The syntax `**` matches zero or - more URL path segments, which must be the last part of the URL path - except the `Verb`. The syntax `Variable` matches part of the URL path as - specified by its template. A variable template must not contain other - variables. If a variable matches a single path segment, its template may - be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax - `LITERAL` matches literal text in the URL path. If the `LITERAL` - contains any reserved character, such characters should be - percent-encoded before the matching. If a variable contains exactly one - path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is - expanded into a URL path on the client side, all characters except - `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse - decoding. Such variables show up in the [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{var}`. If a variable contains multiple path segments, such as - `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a - URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` - are percent-encoded. The server side does the reverse decoding, except - "%2F" and "%2f" are left unchanged. Such variables show up in the - [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. Using gRPC API Service Configuration gRPC API Service - Configuration (service config) is a configuration language for - configuring a gRPC service to become a user-facing product. The service - config is simply the YAML representation of the `google.api.Service` - proto message. As an alternative to annotating your proto file, you can - configure gRPC transcoding in your service config YAML files. You do - this by specifying a `HttpRule` that maps the gRPC method to a REST - endpoint, achieving the same effect as the proto annotation. This can be - particularly useful if you have a proto that is reused in multiple - services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. The - following example selects a gRPC method and applies an `HttpRule` to it: - http: rules: - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC - Transcoding is used to map a gRPC to JSON REST endpoints, the proto to - JSON conversion must follow the [proto3 - specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - While the single segment variable follows the semantics of [RFC - 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - Expansion, the multi segment variable **does not** follow RFC 6570 - Section 3.2.3 Reserved Expansion. The reason is that the Reserved - Expansion does not expand special characters like `?` and `#`, which - would lead to invalid URLs. As the result, gRPC Transcoding uses a - custom encoding for multi segment variables. The path variables **must - not** refer to any repeated or mapped field, because client libraries - are not capable of handling such variable expansion. The path variables - **must not** capture the leading "/" character. The reason is that the - most common use case "{var}" does not capture the leading "/" character. - For consistency, all path variables must share the same behavior. - Repeated message fields must not be mapped to URL query parameters, - because no client library can support such complicated mapping. If an - API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. - LogDescriptor: + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportAdminOverrides. + properties: {} + ContextRule: description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer - id: LogDescriptor + A context rule provides information about the context for an individual + API element. + id: ContextRule type: object properties: - description: - type: string + allowedResponseExtensions: + type: array description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - displayName: - type: string + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + items: + type: string + allowedRequestExtensions: description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - labels: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + type: array + items: + type: string + requested: description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. + A list of full type names of requested contexts, only the requested + context will be made available to the backend. items: - $ref: '#/components/schemas/LabelDescriptor' + type: string type: array - name: + selector: type: string description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - GoogleApiServiceusageV1OperationMetadata: - properties: - resourceNames: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + provided: description: >- - The full name of the resources that this operation is directly - associated with. + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. type: array items: type: string - id: GoogleApiServiceusageV1OperationMetadata - type: object - description: The operation metadata returned for the batchend services operation. - GetServiceIdentityMetadata: - type: object - id: GetServiceIdentityMetadata - properties: {} - description: Metadata for the `GetServiceIdentity` method. - Operation: + SourceContext: description: >- - This resource represents a long-running operation that is the result of - a network API call. + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. type: object - id: Operation + properties: + fileName: + description: >- + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + type: string + id: SourceContext + GoogleApiServiceusageV1Service: + description: A service that is available for use by the consumer. properties: name: type: string description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - metadata: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - GoSettings: - description: Settings for Go client libraries. - id: GoSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - type: object - SourceContext: - type: object - id: SourceContext - properties: - fileName: + The resource name of the consumer and service. A valid name would + be: - projects/123/services/serviceusage.googleapis.com + state: + enum: + - STATE_UNSPECIFIED + - DISABLED + - ENABLED + description: Whether or not the service has been enabled for use by the consumer. type: string + enumDescriptions: + - >- + The default value, which indicates that the enabled state of the + service is unspecified or not meaningful. Currently, all consumers + other than projects (such as folders and organizations) are always + in this state. + - >- + The service cannot be used by this consumer. It has either been + explicitly disabled, or has never been enabled. + - The service has been explicitly enabled for use by this consumer. + config: + $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - RemoveEnableRulesMetadata: + The service configuration of the available service. Some fields may + be filtered out of the configuration in responses to the + `ListServices` method. These fields are present only in responses to + the `GetService` method. + parent: + description: >- + The resource name of the consumer. A valid name would be: - + projects/123 + type: string + id: GoogleApiServiceusageV1Service type: object - id: RemoveEnableRulesMetadata - properties: {} - description: Metadata for the `RemoveEnableRules` method. Api: - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. type: object id: Api properties: - mixins: - items: - $ref: '#/components/schemas/Mixin' - description: Included interfaces. See Mixin. - type: array - name: - type: string - description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - options: - items: - $ref: '#/components/schemas/Option' - type: array - description: Any metadata attached to the interface. - sourceContext: - description: >- - Source context for the protocol buffer service represented by this - message. - $ref: '#/components/schemas/SourceContext' syntax: + description: The source syntax of the service. enum: - SYNTAX_PROTO2 - SYNTAX_PROTO3 @@ -1120,12 +956,26 @@ components: - Syntax `proto2`. - Syntax `proto3`. - Syntax `editions`. - description: The source syntax of the service. + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: >- + Source context for the protocol buffer service represented by this + message. + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: Any metadata attached to the interface. methods: items: $ref: '#/components/schemas/Method' type: array description: The methods of this interface, in unspecified order. + name: + type: string + description: >- + The fully qualified name of this interface, including package name + followed by the interface's simple name. version: description: >- A version string for this interface. If specified, must have the @@ -1145,328 +995,114 @@ components: omitted. Zero major versions must only be used for experimental, non-GA interfaces. type: string - QuotaOverride: - id: QuotaOverride + mixins: + description: Included interfaces. See Mixin. + items: + $ref: '#/components/schemas/Mixin' + type: array + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + GetServiceIdentityMetadata: + id: GetServiceIdentityMetadata + description: Metadata for the `GetServiceIdentity` method. + properties: {} type: object - properties: - unit: - description: >- - The limit unit of the limit to which this override applies. An - example unit would be: `1/{project}/{region}` Note that `{project}` - and `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - type: string - dimensions: - description: >- - If this map is nonempty, then this override applies only to specific - values for dimensions defined in the limit unit. For example, an - override on a limit with the unit `1/{project}/{region}` could - contain an entry with the key `region` and the value `us-east-1`; - the override is only applied to quota consumed in that region. This - map has the following restrictions: * Keys that are not defined in - the limit's unit are not valid keys. Any string appearing in - `{brackets}` in the unit (besides `{project}` or `{user}`) is a - defined key. * `project` is not a valid key; the project is already - specified in the parent resource name. * `user` is not a valid key; - the API does not support quota overrides that apply only to a - specific user. * If `region` appears as a key, its value must be a - valid Cloud region. * If `zone` appears as a key, its value must be - a valid Cloud zone. * If any valid key other than `region` or `zone` - appears in the map, then all valid keys other than `region` or - `zone` must also appear in the map. - type: object - additionalProperties: - type: string - overrideValue: - type: string - format: int64 - description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). - metric: - description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` - type: string - adminOverrideAncestor: - description: >- - The resource name of the ancestor that requested the override. For - example: `organizations/12345` or `folders/67890`. Used by admin - overrides only. - type: string - name: - description: >- - The resource name of the override. This name is generated by the - server when the override is created. Example names would be: - `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` - `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` - The resource name is intended to be opaque and should not be parsed - for its component strings, since its representation could change in - the future. - type: string - description: A quota override - AuthRequirement: - id: AuthRequirement + BillingDestination: description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + Configuration of a specific billing destination (Currently only support + bill against consumer project). + id: BillingDestination + type: object properties: - providerId: + monitoredResource: description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - type: string - audiences: + The monitored resource type. The type must be defined in + Service.monitored_resources section. type: string + metrics: + type: array description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + items: + type: string + ImportConsumerOverridesResponse: + id: ImportConsumerOverridesResponse type: object - Option: + properties: + overrides: + description: The overrides that were created from the imported data. + items: + $ref: '#/components/schemas/QuotaOverride' + type: array + description: Response message for ImportConsumerOverrides + Operation: description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. + This resource represents a long-running operation that is the result of + a network API call. properties: - value: - description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. + metadata: additionalProperties: description: Properties of the object. Contains field @type with type URL. type: any - type: object - name: - type: string description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - type: object - id: Option - ImportConsumerOverridesMetadata: - properties: {} - type: object - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportConsumerOverrides. - id: ImportConsumerOverridesMetadata - AddEnableRulesMetadata: - description: Metadata for the `AddEnableRules` method. - properties: {} - id: AddEnableRulesMetadata - type: object - Billing: - type: object - id: Billing - properties: - consumerDestinations: - items: - $ref: '#/components/schemas/BillingDestination' - type: array - description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. - description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count - DeleteAdminQuotaPolicyMetadata: - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by DeleteAdminQuotaPolicy. - type: object - id: DeleteAdminQuotaPolicyMetadata - properties: {} - OperationMetadata: - id: OperationMetadata - type: object - properties: - resourceNames: - type: array - items: - type: string - description: >- - The full name of the resources that this operation is directly - associated with. - description: The operation metadata returned for the batchend services operation. - Documentation: - id: Documentation - properties: - overview: - type: string - description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. - documentationRootUrl: - type: string - description: The URL to the root of documentation. - rules: - type: array - items: - $ref: '#/components/schemas/DocumentationRule' - description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - pages: - type: array - items: - $ref: '#/components/schemas/Page' - description: The top level pages for the documentation set. - sectionOverrides: - type: array - items: - $ref: '#/components/schemas/Page' - description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - serviceRootUrl: - type: string - description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. - summary: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + done: description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + name: type: string - description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. - type: object - EnableServiceRequest: - type: object - description: Request message for the `EnableService` method. - properties: {} - id: EnableServiceRequest - AnalyzeConsumerPolicyResponse: - type: object - properties: - analysis: - description: >- - The list of analyses returned from performing the intended policy - update analysis. The analysis is grouped by service name and - different analysis types. The empty analysis list means that the - consumer policy can be updated without any warnings or blockers. - items: - $ref: '#/components/schemas/Analysis' - type: array - id: AnalyzeConsumerPolicyResponse - description: The response of analyzing a consumer policy update. - ImportAdminQuotaPoliciesResponse: - type: object - id: ImportAdminQuotaPoliciesResponse - properties: - policies: - items: - $ref: '#/components/schemas/AdminQuotaPolicy' - description: The policies that were created from the imported data. - type: array - description: Response message for ImportAdminQuotaPolicies - CppSettings: - id: CppSettings - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - description: Settings for C++ client libraries. - type: object - SystemParameter: - properties: - urlQueryParameter: description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - type: string - httpHeader: - type: string + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + error: + $ref: '#/components/schemas/Status' description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - name: - type: string + The error result of the operation in case of failure or + cancellation. + response: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. type: object - id: SystemParameter - description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. + id: Operation DisableServiceRequest: - id: DisableServiceRequest - description: Request message for the `DisableService` method. properties: + disableDependentServices: + type: boolean + description: >- + Indicates if services that are enabled and which depend on this + service should also be disabled. If not set, an error will be + generated if any enabled services depend on the service to be + disabled. When set, the service, and any enabled services that + depend on it, will be disabled together. checkIfServiceHasUsage: enumDescriptions: - When unset, the default behavior is used, which is SKIP. @@ -1475,547 +1111,923 @@ components: If set, service usage is checked when disabling the service. If a service, or its dependents, has usage in the last 30 days, the request returns a FAILED_PRECONDITION error. - type: string description: >- Defines the behavior for checking service usage when disabling a service. + type: string enum: - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED - SKIP - CHECK - disableDependentServices: - type: boolean - description: >- - Indicates if services that are enabled and which depend on this - service should also be disabled. If not set, an error will be - generated if any enabled services depend on the service to be - disabled. When set, the service, and any enabled services that - depend on it, will be disabled together. + id: DisableServiceRequest + description: Request message for the `DisableService` method. type: object - Http: + DotnetSettings: properties: - fullyDecodeReservedExpansion: - type: boolean + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + renamedResources: + type: object description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - rules: + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + additionalProperties: + type: string + ignoredResources: description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" items: - $ref: '#/components/schemas/HttpRule' + type: string type: array - id: Http + handwrittenSignatures: + description: >- + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + items: + type: string + type: array + renamedServices: + additionalProperties: + type: string + description: >- + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + type: object + forcedNamespaceAliases: + items: + type: string + description: >- + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision + type: array + id: DotnetSettings type: object - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - GoogleApiServiceusageV2alphaConsumerPolicy: + description: Settings for Dotnet client libraries. + QuotaLimit: properties: - createTime: + metric: type: string description: >- - Output only. The time the policy was created. For singleton - policies, this is the first touch of the policy. - format: google-datetime - readOnly: true - updateTime: - description: Output only. The time the policy was last updated. + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. + defaultLimit: type: string - readOnly: true - format: google-datetime - name: description: >- - Output only. The resource name of the policy. Only the `default` - policy is supported: `projects/12345/consumerPolicies/default`, - `folders/12345/consumerPolicies/default`, - `organizations/12345/consumerPolicies/default`. - readOnly: true + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + format: int64 + displayName: type: string - etag: description: >- - Output only. An opaque tag indicating the current version of the - policy, used for concurrency control. + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + name: type: string - readOnly: true - annotations: description: >- - Optional. Annotations is an unstructured key-value map stored with a - policy that may be set by external tools to store and retrieve - arbitrary metadata. They are not queryable and should be preserved - when modifying objects. - [AIP-128](https://google.aip.dev/128#annotations) - type: object + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + maxLimit: + description: >- + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + format: int64 + type: string + values: additionalProperties: + format: int64 type: string - enableRules: - type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' + type: object description: >- - Enable rules define usable services, groups, and categories. There - can currently be at most one `EnableRule`. This restriction will be - lifted in later releases. + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + unit: + type: string + description: >- + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + description: + type: string + description: >- + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + freeTier: + type: string + description: >- + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + format: int64 + duration: + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + type: string + id: QuotaLimit + type: object description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. + Option: + id: Option type: object - id: GoogleApiServiceusageV2alphaConsumerPolicy - Endpoint: + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + properties: + name: + description: >- + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. + type: string + value: + type: object + description: >- + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + LogDescriptor: + id: LogDescriptor + description: >- + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer type: object properties: - allowCors: - type: boolean + description: description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - aliases: - type: array + A human-readable description of this log. This information appears + in the documentation and can contain details. + type: string + labels: items: - type: string + $ref: '#/components/schemas/LabelDescriptor' + type: array description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. + displayName: + type: string + description: >- + The human-readable name for this log. This information appears on + the user interface and should be concise. name: - description: The canonical name of this endpoint. type: string - target: + description: >- + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + OAuthRequirements: + id: OAuthRequirements + properties: + canonicalScopes: type: string description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". - id: Endpoint + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read + type: object description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true - Field: - description: A single field of a message type. + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. + Billing: type: object - id: Field + id: Billing properties: - name: - description: The field name. - type: string - options: - description: The protocol buffer options. + consumerDestinations: + description: >- + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. items: - $ref: '#/components/schemas/Option' + $ref: '#/components/schemas/BillingDestination' type: array - kind: + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count + UpdateAdminQuotaPolicyMetadata: + properties: {} + type: object + id: UpdateAdminQuotaPolicyMetadata + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by UpdateAdminQuotaPolicy. + ImportConsumerOverridesMetadata: + properties: {} + type: object + id: ImportConsumerOverridesMetadata + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportConsumerOverrides. + Type: + type: object + description: A protocol buffer message type. + properties: + syntax: + type: string + description: The source syntax. enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 - description: The field type. - type: string - number: - type: integer - description: The field number. - format: int32 - jsonName: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + edition: type: string - description: The field JSON name. - defaultValue: description: >- - The string value of the default value of this field. Proto2 syntax - only. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + fields: + items: + $ref: '#/components/schemas/Field' + type: array + description: The list of fields. + oneofs: + type: array + items: + type: string + description: The list of types appearing in `oneof` definitions in this type. + options: + type: array + items: + $ref: '#/components/schemas/Option' + description: The protocol buffer options. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + name: + description: The fully qualified message name. type: string - typeUrl: + id: Type + CustomHttpPattern: + properties: + path: + description: The path matched by this custom verb. type: string - description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - packed: - type: boolean - description: Whether to use alternative packed wire representation. - oneofIndex: - description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - format: int32 - type: integer - cardinality: - description: The field cardinality. - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED + kind: + description: The name of this custom HTTP verb. type: string - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - SystemParameterRule: - id: SystemParameterRule + description: A custom pattern is used for defining custom HTTP verb. type: object - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. + id: CustomHttpPattern + EnableFailure: properties: - parameters: - type: array - description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. - items: - $ref: '#/components/schemas/SystemParameter' - selector: + errorMessage: + description: An error message describing why the service could not be enabled. type: string - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - Mixin: - id: Mixin + serviceId: + type: string + description: The service id of a service that could not be enabled. + description: Provides error messages for the failing services. + type: object + id: EnableFailure + RemoveEnableRulesMetadata: + properties: {} + id: RemoveEnableRulesMetadata type: object + description: Metadata for the `RemoveEnableRules` method. + GoSettings: + description: Settings for Go client libraries. + type: object + id: GoSettings properties: - name: - description: The fully qualified name of the interface which is included. - type: string - root: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + GetServiceIdentityResponse: + properties: + state: type: string - description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. + enumDescriptions: + - >- + Default service identity state. This value is used if the state is + omitted. + - Service identity has been created and can be used. + description: Service identity state. + enum: + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE + identity: + $ref: '#/components/schemas/ServiceIdentity' + description: >- + Service identity that service producer can use to access consumer + resources. If exists is true, it contains email and unique_id. If + exists is false, it contains pre-constructed email and empty + unique_id. + description: Response message for getting service identity. + type: object + id: GetServiceIdentityResponse + ImportAdminQuotaPoliciesMetadata: + properties: {} description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - DotnetSettings: + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportAdminQuotaPolicies. + id: ImportAdminQuotaPoliciesMetadata type: object - description: Settings for Dotnet client libraries. + Usage: + id: Usage properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - ignoredResources: - type: array - items: - type: string - description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - forcedNamespaceAliases: + requirements: items: type: string type: array description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - renamedResources: - description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - type: object - additionalProperties: - type: string - renamedServices: + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. + rules: description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - type: object - additionalProperties: - type: string - handwrittenSignatures: + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. items: - type: string + $ref: '#/components/schemas/UsageRule' type: array + producerNotificationChannel: description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - id: DotnetSettings - ImportConsumerOverridesResponse: - id: ImportConsumerOverridesResponse + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + type: string + description: Configuration controlling usage of a service. + type: object + CppSettings: + type: object + description: Settings for C++ client libraries. + id: CppSettings properties: - overrides: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + ImportAdminQuotaPoliciesResponse: + properties: + policies: + description: The policies that were created from the imported data. items: - $ref: '#/components/schemas/QuotaOverride' - description: The overrides that were created from the imported data. + $ref: '#/components/schemas/AdminQuotaPolicy' type: array - description: Response message for ImportConsumerOverrides + id: ImportAdminQuotaPoliciesResponse type: object - GetServiceIdentityResponse: + description: Response message for ImportAdminQuotaPolicies + NodeSettings: + type: object + id: NodeSettings + description: Settings for Node client libraries. properties: - identity: - $ref: '#/components/schemas/ServiceIdentity' - description: >- - Service identity that service producer can use to access consumer - resources. If exists is true, it contains email and unique_id. If - exists is false, it contains pre-constructed email and empty - unique_id. - state: - description: Service identity state. - enumDescriptions: - - >- - Default service identity state. This value is used if the state is - omitted. - - Service identity has been created and can be used. - type: string - enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE - description: Response message for getting service identity. + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + DisableServiceResponse: + id: DisableServiceResponse type: object - id: GetServiceIdentityResponse - MonitoredResourceDescriptor: + description: >- + Response message for the `DisableService` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. properties: - description: + service: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The new state of the service after disabling. + AuthRequirement: + type: object + id: AuthRequirement + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + properties: + providerId: + description: >- + id from authentication provider. Example: provider_id: + bookstore_auth type: string + audiences: description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - labels: + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string + AnalyzeConsumerPolicyResponse: + type: object + description: The response of analyzing a consumer policy update. + id: AnalyzeConsumerPolicyResponse + properties: + analysis: description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. + The list of analyses returned from performing the intended policy + update analysis. The analysis is grouped by service name and + different analysis types. The empty analysis list means that the + consumer policy can be updated without any warnings or blockers. items: - $ref: '#/components/schemas/LabelDescriptor' + $ref: '#/components/schemas/Analysis' type: array - displayName: - type: string + BatchGetServicesResponse: + description: Response message for the `BatchGetServices` method. + type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The requested Service states. + id: BatchGetServicesResponse + AddEnableRulesResponse: + properties: + parent: description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. - type: - type: string - description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - name: + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. type: string + addedValues: + items: + type: string + description: The values added to the parent consumer policy. + type: array + type: object + description: The response message of `AddEnableRules` method. + id: AddEnableRulesResponse + CustomError: + id: CustomError + type: object + properties: + rules: description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. - launchStage: - description: Optional. The launch stage of the monitored resource definition. - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - id: MonitoredResourceDescriptor + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + items: + $ref: '#/components/schemas/CustomErrorRule' + type: array + types: + description: >- + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + type: array + items: + type: string description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + AnalysisResult: + properties: + blockers: + items: + $ref: '#/components/schemas/Impact' + type: array + description: >- + Blocking information that would prevent the policy changes at + runtime. + warnings: + type: array + description: >- + Warning information indicating that the policy changes might be + unsafe, but will not block the changes at runtime. + items: + $ref: '#/components/schemas/Impact' + description: An analysis result including blockers and warnings. type: object - BillingDestination: - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - id: BillingDestination + id: AnalysisResult + BatchCreateConsumerOverridesResponse: + description: Response message for BatchCreateConsumerOverrides properties: - metrics: + overrides: + type: array + description: The overrides that were created. + items: + $ref: '#/components/schemas/QuotaOverride' + id: BatchCreateConsumerOverridesResponse + type: object + Status: + properties: + code: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + details: description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array items: - type: string - monitoredResource: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string + type: object + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + OperationMetadata: + properties: + resourceNames: + items: + type: string description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. + The full name of the resources that this operation is directly + associated with. + type: array + description: The operation metadata returned for the batchend services operation. + type: object + id: OperationMetadata + SourceInfo: + id: SourceInfo + type: object + description: Source information used to create a Service Config + properties: + sourceFiles: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array + description: All files used during config generation. + GoogleApiServiceusageV2alphaEnableRule: + id: GoogleApiServiceusageV2alphaEnableRule + properties: + services: + description: >- + The names of the services that are enabled. Example: + `services/storage.googleapis.com`. + type: array + items: + type: string type: object - MetricDescriptor: description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. + The consumer policy rule that defines enabled services, groups, and + categories. + CreateAdminQuotaPolicyMetadata: + properties: {} + id: CreateAdminQuotaPolicyMetadata + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by CreateAdminQuotaPolicy. type: object + RemoveEnableRulesResponse: + id: RemoveEnableRulesResponse properties: - name: + parent: type: string - description: The resource name of the metric descriptor. - monitoredResourceTypes: description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. + removedValues: items: type: string + deprecated: true + description: The values removed from the parent consumer policy. + type: array + description: The response message of `RemoveEnableRules` method. + type: object + Http: + id: Http + properties: + rules: type: array - description: - type: string description: >- - A detailed description of the metric, which can be used in - documentation. - launchStage: - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + items: + $ref: '#/components/schemas/HttpRule' + fullyDecodeReservedExpansion: + type: boolean + description: >- + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: object + description: >- + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + Logging: + id: Logging + type: object + description: >- + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history + properties: + consumerDestinations: + description: >- + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. + items: + $ref: '#/components/schemas/LoggingDestination' + type: array + producerDestinations: + items: + $ref: '#/components/schemas/LoggingDestination' + description: >- + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. + type: array + MonitoringDestination: + type: object + id: MonitoringDestination + properties: + monitoredResource: + type: string + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + metrics: + description: >- + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + type: array + items: + type: string + description: >- + Configuration of a specific monitoring destination (the producer project + or the consumer project). + LongRunning: + description: >- + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + properties: + initialPollDelay: + format: google-duration + description: >- + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + type: string + totalPollTimeout: + format: google-duration + type: string + description: 'Total polling timeout. Default value: 5 minutes.' + pollDelayMultiplier: + type: number + description: >- + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + format: float + maxPollDelay: + description: >- + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + type: string + format: google-duration + id: LongRunning + type: object + AnalyzeConsumerPolicyMetadata: + description: Metadata for the `AnalyzeConsumerPolicy` method. + properties: {} + type: object + id: AnalyzeConsumerPolicyMetadata + CancelOperationRequest: + description: The request message for Operations.CancelOperation. + id: CancelOperationRequest + properties: {} + type: object + MetricDescriptorMetadata: + description: Additional annotations that can be used to guide the usage of a metric. + properties: + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + deprecated: true + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + ingestDelay: + description: >- + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. + type: string + format: google-duration + samplePeriod: + format: google-duration + type: string + description: >- + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. + timeSeriesResourceHierarchyLevel: + description: The scope of the timeseries data of the metric. + items: + type: string + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + type: array + id: MetricDescriptorMetadata + type: object + MonitoredResourceDescriptor: + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. + id: MonitoredResourceDescriptor + properties: + launchStage: + type: string + description: Optional. The launch stage of the monitored resource definition. + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. - >- Alpha is a limited availability test for releases before they are @@ -2052,951 +2064,1050 @@ components: - BETA - GA - DEPRECATED - description: Optional. The launch stage of the metric definition. + name: type: string - labels: description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + description: + type: string + description: >- + Optional. A detailed description of the monitored resource type that + might be used in documentation. + displayName: + description: >- + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. + type: string + labels: type: array - items: - $ref: '#/components/schemas/LabelDescriptor' - unit: description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: + description: >- + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). type: string - valueType: - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY + type: object + LoggingDestination: + type: object + id: LoggingDestination + properties: + monitoredResource: type: string description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + logs: + type: array + description: >- + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + items: + type: string + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). + Analysis: + description: A message to group the analysis information. + type: object + properties: displayName: type: string + readOnly: true description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - type: - description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" + Output only. The user friendly display name of the analysis type. + E.g. service dependency analysis, service resource usage analysis, + etc. + analysisType: + enumDescriptions: + - Unspecified analysis type. Do not use. + - The analysis of service dependencies. + - The analysis of service resource usage. + readOnly: true type: string - metricKind: enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. + - ANALYSIS_TYPE_UNSPECIFIED + - ANALYSIS_TYPE_DEPENDENCY + - ANALYSIS_TYPE_RESOURCE_USAGE + description: Output only. The type of analysis. + service: + type: string description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. + The names of the service that has analysis result of warnings or + blockers. Example: `services/storage.googleapis.com`. + analysis: + description: Output only. Analysis result of updating a policy. + $ref: '#/components/schemas/AnalysisResult' + readOnly: true + id: Analysis + Endpoint: + id: Endpoint + properties: + name: type: string - metadata: - $ref: '#/components/schemas/MetricDescriptorMetadata' - description: Optional. Metadata which can be used to guide usage of the metric. - id: MetricDescriptor - UsageRule: + description: The canonical name of this endpoint. + aliases: + type: array + description: >- + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + items: + type: string + target: + description: >- + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". + type: string + allowCors: + type: boolean + description: >- + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true - id: UsageRule + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + type: object + SystemParameterRule: properties: selector: + type: string description: >- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. - type: string - allowUnregisteredCalls: - description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - type: boolean - skipServiceControl: - type: boolean + parameters: + items: + $ref: '#/components/schemas/SystemParameter' + type: array description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - type: object - BatchGetServicesResponse: + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. type: object - properties: - services: - description: The requested Service states. - type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: Response message for the `BatchGetServices` method. - id: BatchGetServicesResponse - GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: - properties: {} - id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + id: SystemParameterRule + BackendRule: type: object - description: Metadata for the `UpdateConsumerPolicy` method. - AdminQuotaPolicy: - description: Quota policy created by quota administrator. + description: A backend rule provides configuration for an individual API element. + id: BackendRule properties: - unit: + address: + type: string description: >- - The limit unit of the limit to which this policy applies. An example - unit would be: `1/{project}/{region}` Note that `{project}` and - `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string - dimensions: - description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.' + operationDeadline: + description: >- + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + format: double + type: number + deadline: + type: number + description: >- + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + format: double + disableAuth: + description: >- + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + type: boolean + overridesByRequestProtocol: additionalProperties: - type: string + $ref: '#/components/schemas/BackendRule' type: object - policyValue: - format: int64 + description: The map between request protocol and the backend address. + protocol: type: string description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). - container: + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. + jwtAudience: description: >- - The cloud resource container at which the quota policy is created. - The format is `{container_type}/{container_number}` + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. type: string - metric: - description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` + pathTranslation: + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST type: string - name: + minDeadline: + description: Deprecated, do not use. + format: double + type: number + deprecated: true + CustomErrorRule: + properties: + selector: type: string description: >- - The resource name of the policy. This name is generated by the - server when the policy is created. Example names would be: - `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` - type: object - id: AdminQuotaPolicy - PhpSettings: + Selects messages to which this rule applies. Refer to selector for + syntax details. + isErrorType: + type: boolean + description: >- + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + description: A custom error rule. type: object - id: PhpSettings - description: Settings for Php client libraries. - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - ConsumerPolicy: + id: CustomErrorRule + Documentation: + id: Documentation + description: >- + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. properties: - updateTime: - description: The last-modified time. + pages: + description: The top level pages for the documentation set. + items: + $ref: '#/components/schemas/Page' + type: array + overview: type: string - format: google-datetime - annotations: - type: object description: >- - Optional. Annotations is an unstructured key-value map stored with a - policy that may be set by external tools to store and retrieve - arbitrary metadata. They are not queryable and should be preserved - when modifying objects. - [AIP-128](https://google.aip.dev/128#annotations) - additionalProperties: - type: string - name: + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. + summary: + description: >- + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. + type: string + documentationRootUrl: type: string + description: The URL to the root of documentation. + sectionOverrides: + type: array description: >- - Output only. The resource name of the policy. We only allow consumer - policy name as `default` for now: - `projects/12345/consumerPolicies/default`, - `folders/12345/consumerPolicies/default`, - `organizations/12345/consumerPolicies/default`. - readOnly: true - enableRules: + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries items: - $ref: '#/components/schemas/EnableRule' + $ref: '#/components/schemas/Page' + rules: type: array - description: Enable rules define usable services and service groups. - etag: - type: string description: >- - An opaque tag indicating the current version of the policy, used for - concurrency control. - description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. - type: object - id: ConsumerPolicy - NodeSettings: - type: object - id: NodeSettings - description: Settings for Node client libraries. - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - SourceInfo: - description: Source information used to create a Service Config - properties: - sourceFiles: - description: All files used during config generation. + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - id: SourceInfo - type: object - AnalyzeConsumerPolicyMetadata: + $ref: '#/components/schemas/DocumentationRule' + serviceRootUrl: + description: >- + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. + type: string type: object - properties: {} - id: AnalyzeConsumerPolicyMetadata - description: Metadata for the `AnalyzeConsumerPolicy` method. - Method: - description: Method represents a method of an API interface. - id: Method + Mixin: type: object + description: >- + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } properties: - requestStreaming: - description: If true, the request is streamed. - type: boolean - options: - type: array - description: Any metadata attached to the method. - items: - $ref: '#/components/schemas/Option' - responseTypeUrl: - type: string - description: The URL of the output message type. - requestTypeUrl: - description: A URL of the input message type. - type: string - responseStreaming: - description: If true, the response is streamed. - type: boolean name: - description: The simple name of this method. + description: The fully qualified name of the interface which is included. type: string - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of this method. + root: type: string - ListServicesResponse: - id: ListServicesResponse - description: Response message for the `ListServices` method. + description: >- + If non-empty specifies a path under which inherited HTTP paths are + rooted. + id: Mixin + PhpSettings: properties: - nextPageToken: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + id: PhpSettings + description: Settings for Php client libraries. + type: object + GoogleApiService: + properties: + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + documentation: + $ref: '#/components/schemas/Documentation' + description: Additional API documentation. + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. + billing: + $ref: '#/components/schemas/Billing' + description: Billing configuration. + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + name: description: >- - Token that can be passed to `ListServices` to resume a paginated - query. + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. type: string - services: + control: + description: Configuration for the service control plane. + $ref: '#/components/schemas/Control' + logs: + description: Defines the logs used by this service. + items: + $ref: '#/components/schemas/LogDescriptor' + type: array + configVersion: + type: integer + description: >- + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + format: uint32 + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + backend: + $ref: '#/components/schemas/Backend' + description: API backend configuration. + monitoredResources: + description: >- + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. type: array - description: The available services for the requested project. items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - type: object - RemoveEnableRulesResponse: - description: The response message of `RemoveEnableRules` method. - properties: - parent: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + producerProjectId: + description: The Google project that owns this service. type: string + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + metrics: + items: + $ref: '#/components/schemas/MetricDescriptor' + description: Defines the metrics used by this service. + type: array + endpoints: description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. - removedValues: + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. items: - type: string - description: The values removed from the parent consumer policy. + $ref: '#/components/schemas/Endpoint' type: array - deprecated: true - type: object - id: RemoveEnableRulesResponse - FieldPolicy: - properties: - resourcePermission: + publishing: description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - type: string - resourceType: - type: string + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + $ref: '#/components/schemas/Publishing' + logging: + description: Logging configuration. + $ref: '#/components/schemas/Logging' + enums: description: >- - Specifies the resource type for the resource referred to by the - field. - selector: + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + type: array + items: + $ref: '#/components/schemas/Enum' + customError: + description: Custom error configuration. + $ref: '#/components/schemas/CustomError' + systemTypes: + items: + $ref: '#/components/schemas/Type' + description: >- + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. + type: array + sourceInfo: + description: >- + Output only. The source information for this configuration if + available. + $ref: '#/components/schemas/SourceInfo' + context: + $ref: '#/components/schemas/Context' + description: Context configuration. + title: + description: >- + The product title for this service, it is the name displayed in + Google Cloud Console. type: string + types: description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". - id: FieldPolicy - description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. - type: object - CustomErrorRule: - properties: - isErrorType: - description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - type: boolean - selector: - description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. - type: string - description: A custom error rule. - type: object - id: CustomErrorRule - DisableServiceResponse: - properties: - service: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: The new state of the service after disabling. - description: >- - Response message for the `DisableService` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - id: DisableServiceResponse - type: object - ImportAdminOverridesMetadata: - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportAdminOverrides. - id: ImportAdminOverridesMetadata - properties: {} - type: object - BatchEnableServicesResponse: - description: >- - Response message for the `BatchEnableServices` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - id: BatchEnableServicesResponse - type: object - properties: - services: - description: The new state of the services after enabling. - items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - type: array - failures: - items: - $ref: '#/components/schemas/EnableFailure' - description: >- - If allow_partial_success is true, and one or more services could not - be enabled, this field contains the details about each failure. - type: array - CustomError: - id: CustomError - description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - properties: - types: + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 type: array items: - type: string + $ref: '#/components/schemas/Type' + apis: description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - rules: + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. type: array items: - $ref: '#/components/schemas/CustomErrorRule' + $ref: '#/components/schemas/Api' + id: + type: string description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + id: GoogleApiService + description: >- + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth + type: object + GoogleApiServiceusageV1beta1GetServiceIdentityResponse: + id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse + description: Response message for getting service identity. type: object - MethodSettings: - id: MethodSettings properties: - longRunning: - description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - $ref: '#/components/schemas/LongRunning' - selector: + state: + enumDescriptions: + - >- + Default service identity state. This value is used if the state is + omitted. + - Service identity has been created and can be used. type: string + description: Service identity state. + enum: + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE + identity: + $ref: '#/components/schemas/GoogleApiServiceusageV1beta1ServiceIdentity' description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... - autoPopulatedFields: - type: array - description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id + Service identity that service producer can use to access consumer + resources. If exists is true, it contains email and unique_id. If + exists is false, it contains pre-constructed email and empty + unique_id. + BatchCreateAdminOverridesResponse: + properties: + overrides: items: - type: string - type: object - description: Describes the generator configuration for a method. - AuthenticationRule: - description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - id: AuthenticationRule + $ref: '#/components/schemas/QuotaOverride' + type: array + description: The overrides that were created. + id: BatchCreateAdminOverridesResponse type: object + description: Response message for BatchCreateAdminOverrides + Field: + id: Field + description: A single field of a message type. properties: - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - requirements: - type: array - items: - $ref: '#/components/schemas/AuthRequirement' - description: Requirements for additional authentication providers. - allowWithoutCredential: + typeUrl: + type: string description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - type: boolean - selector: + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + defaultValue: + type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + The string value of the default value of this field. Proto2 syntax + only. + cardinality: + description: The field cardinality. type: string - Monitoring: - properties: - consumerDestinations: + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + options: items: - $ref: '#/components/schemas/MonitoringDestination' - description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - type: array - producerDestinations: + $ref: '#/components/schemas/Option' + description: The protocol buffer options. type: array - description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - items: - $ref: '#/components/schemas/MonitoringDestination' - id: Monitoring + kind: + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + description: The field type. + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + type: string + name: + type: string + description: The field name. + number: + format: int32 + type: integer + description: The field number. + oneofIndex: + type: integer + format: int32 + description: >- + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + packed: + type: boolean + description: Whether to use alternative packed wire representation. + jsonName: + description: The field JSON name. + type: string type: object + GoogleApiServiceusageV2alphaConsumerPolicy: description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue - Enum: - id: Enum - type: object + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. + id: GoogleApiServiceusageV2alphaConsumerPolicy properties: - edition: - type: string - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - enumvalue: - type: array - items: - $ref: '#/components/schemas/EnumValue' - description: Enum value definitions. - options: + enableRules: items: - $ref: '#/components/schemas/Option' + $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' type: array - description: Protocol buffer options. + description: >- + Enable rules define usable services, groups, and categories. There + can currently be at most one `EnableRule`. This restriction will be + lifted in later releases. name: - description: Enum type name. - type: string - syntax: + readOnly: true type: string - description: The source syntax. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - description: Enum type definition. - AuthProvider: - properties: - issuer: description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com + Output only. The resource name of the policy. Only the `default` + policy is supported: `projects/12345/consumerPolicies/default`, + `folders/12345/consumerPolicies/default`, + `organizations/12345/consumerPolicies/default`. + updateTime: + readOnly: true + format: google-datetime type: string - id: + description: Output only. The time the policy was last updated. + etag: + readOnly: true type: string description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - jwtLocations: - type: array - description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - items: - $ref: '#/components/schemas/JwtLocation' - audiences: - type: string + Output only. An opaque tag indicating the current version of the + policy, used for concurrency control. + annotations: + additionalProperties: + type: string + type: object description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - authorizationUrl: - type: string + Optional. Annotations is an unstructured key-value map stored with a + policy that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. + [AIP-128](https://google.aip.dev/128#annotations) + createTime: + format: google-datetime description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - jwksUri: + Output only. The time the policy was created. For singleton + policies, this is the first touch of the policy. type: string - description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - type: object - id: AuthProvider - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - CreateAdminQuotaPolicyMetadata: - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by CreateAdminQuotaPolicy. - properties: {} - id: CreateAdminQuotaPolicyMetadata - type: object - UpdateConsumerPolicyMetadata: - description: Metadata for the `UpdateConsumerPolicy` method. + readOnly: true type: object - id: UpdateConsumerPolicyMetadata - properties: {} - Quota: - id: Quota + HttpRule: type: object properties: - limits: - description: List of QuotaLimit definitions for the service. - type: array - items: - $ref: '#/components/schemas/QuotaLimit' - metricRules: - type: array + put: + description: Maps to HTTP PUT. Used for replacing a resource. + type: string + responseBody: + type: string description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - items: - $ref: '#/components/schemas/MetricRule' - description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - UpdateAdminQuotaPolicyMetadata: - id: UpdateAdminQuotaPolicyMetadata - properties: {} - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by UpdateAdminQuotaPolicy. - type: object - BackendRule: - properties: - deadline: + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. + type: string + patch: + type: string + description: Maps to HTTP PATCH. Used for updating a resource. + custom: + $ref: '#/components/schemas/CustomHttpPattern' description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - type: number - format: double - jwtAudience: + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + post: description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. + Maps to HTTP POST. Used for creating a resource or performing an + action. + type: string + get: type: string - protocol: description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. + Maps to HTTP GET. Used for listing and getting information about + resources. + body: type: string - overridesByRequestProtocol: - additionalProperties: - $ref: '#/components/schemas/BackendRule' - description: The map between request protocol and the backend address. - type: object - operationDeadline: description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - format: double - type: number - disableAuth: - type: boolean + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + additionalBindings: + type: array description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - minDeadline: - deprecated: true - description: Deprecated, do not use. - type: number - format: double + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). + items: + $ref: '#/components/schemas/HttpRule' selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - pathTranslation: - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST - type: string - address: type: string description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - id: BackendRule - description: A backend rule provides configuration for an individual API element. - type: object - Page: - type: object + Selects a method to which this rule applies. Refer to selector for + syntax details. + id: HttpRule + description: >- + gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC method and one or more HTTP REST endpoints. It allows developers to + build a single API service that supports both gRPC APIs and REST APIs. + Many systems, including [Google + APIs](https://github.com/googleapis/googleapis), [Cloud + Endpoints](https://cloud.google.com/endpoints), [gRPC + Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + and use it for large scale production services. `HttpRule` defines the + schema of the gRPC/REST mapping. The mapping specifies how different + portions of the gRPC request message are mapped to the URL path, URL + query parameters, and HTTP request body. It also controls how the gRPC + response message is mapped to the HTTP response body. `HttpRule` is + typically specified as an `google.api.http` annotation on the gRPC + method. Each mapping specifies a URL path template and an HTTP method. + The path template may refer to one or more fields in the gRPC request + message, as long as each field is a non-repeated field with a primitive + (non-message) type. The path template controls how fields of the request + message are mapped to the URL path. Example: service Messaging { rpc + GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message + GetMessageRequest { string name = 1; // Mapped to URL path. } message + Message { string text = 1; // The resource content. } This enables an + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + "foo"))` Note that fields which are mapped to URL query parameters must + have a primitive type or a repeated primitive type or a non-repeated + message type. In the case of a repeated type, the parameter can be + repeated in the URL as `...?param=A¶m=B`. In the case of a message + type, each field of the message is mapped to a separate parameter, such + as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request + body, the `body` field specifies the mapping. Consider a REST update + method on the message resource collection: service Messaging { rpc + UpdateMessage(UpdateMessageRequest) returns (Message) { option + (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" + }; } } message UpdateMessageRequest { string message_id = 1; // mapped + to the URL Message message = 2; // mapped to the body } The following + HTTP JSON to RPC mapping is enabled, where the representation of the + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The + special name `*` can be used in the body mapping to define that every + field not bound by the path template should be mapped to the request + body. This enables the following alternative definition of the update + method: service Messaging { rpc UpdateMessage(Message) returns (Message) + { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: + "*" }; } } message Message { string message_id = 1; string text = 2; } + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using + `*` in the body mapping, it is not possible to have HTTP parameters, as + all fields not bound by the path end in the body. This makes this option + more rarely used in practice when defining REST APIs. The common usage + of `*` is in custom methods which don't use the URL at all for + transferring data. It is possible to define multiple HTTP methods for + one RPC by using the `additional_bindings` option. Example: service + Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/messages/{message_id}" + additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } + }; } } message GetMessageRequest { string message_id = 1; string user_id + = 2; } This enables the following two alternative HTTP JSON to RPC + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{var}`. If a variable contains multiple path segments, such as + `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a + URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` + are percent-encoded. The server side does the reverse decoding, except + "%2F" and "%2f" are left unchanged. Such variables show up in the + [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{+var}`. Using gRPC API Service Configuration gRPC API Service + Configuration (service config) is a configuration language for + configuring a gRPC service to become a user-facing product. The service + config is simply the YAML representation of the `google.api.Service` + proto message. As an alternative to annotating your proto file, you can + configure gRPC transcoding in your service config YAML files. You do + this by specifying a `HttpRule` that maps the gRPC method to a REST + endpoint, achieving the same effect as the proto annotation. This can be + particularly useful if you have a proto that is reused in multiple + services. Note that any transcoding specified in the service config will + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC + Transcoding is used to map a gRPC to JSON REST endpoints, the proto to + JSON conversion must follow the [proto3 + specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + While the single segment variable follows the semantics of [RFC + 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + Expansion, the multi segment variable **does not** follow RFC 6570 + Section 3.2.3 Reserved Expansion. The reason is that the Reserved + Expansion does not expand special characters like `?` and `#`, which + would lead to invalid URLs. As the result, gRPC Transcoding uses a + custom encoding for multi segment variables. The path variables **must + not** refer to any repeated or mapped field, because client libraries + are not capable of handling such variable expansion. The path variables + **must not** capture the leading "/" character. The reason is that the + most common use case "{var}" does not capture the leading "/" character. + For consistency, all path variables must share the same behavior. + Repeated message fields must not be mapped to URL query parameters, + because no client library can support such complicated mapping. If an + API needs to use a JSON array for request or response body, it can map + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. + Enum: properties: - content: - description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. + syntax: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax. type: string - name: - description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + options: + items: + $ref: '#/components/schemas/Option' + description: Protocol buffer options. + type: array + edition: type: string - subpages: description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + enumvalue: + description: Enum value definitions. items: - $ref: '#/components/schemas/Page' + $ref: '#/components/schemas/EnumValue' type: array - id: Page - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - CustomHttpPattern: - id: CustomHttpPattern - properties: - path: - description: The path matched by this custom verb. - type: string - kind: - description: The name of this custom HTTP verb. + name: + description: Enum type name. type: string - description: A custom pattern is used for defining custom HTTP verb. + description: Enum type definition. type: object + id: Enum EnableRule: - description: >- - The consumer policy rule that defines usable services and service - groups. type: object id: EnableRule properties: - services: - description: >- - DEPRECATED: Please use field `values`. Service should have prefix - `services/`. The names of the services that are enabled. Example: - `storage.googleapis.com`. - type: array - items: - type: string - deprecated: true groups: - deprecated: true - type: array - items: - type: string description: >- DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). Example: `groups/googleServices`. + deprecated: true + items: + type: string + type: array values: + items: + type: string type: array description: >- The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, `groups/googleServices`, `groups/allServices`. + services: + description: >- + DEPRECATED: Please use field `values`. Service should have prefix + `services/`. The names of the services that are enabled. Example: + `storage.googleapis.com`. items: type: string + type: array + deprecated: true enableType: + type: string + description: Client and resource project enable type. + enum: + - ENABLE_TYPE_UNSPECIFIED + - CLIENT + - RESOURCE + - V1_COMPATIBLE enumDescriptions: - >- Unspecified enable type, which means enabled as both client and @@ -3013,237 +3124,261 @@ components: consumers differentiate between policy changes made by v1 and v2 clients and understand what is actually possible based on those different policies. - description: Client and resource project enable type. - type: string - enum: - - ENABLE_TYPE_UNSPECIFIED - - CLIENT - - RESOURCE - - V1_COMPATIBLE - JavaSettings: + description: >- + The consumer policy rule that defines usable services and service + groups. + Control: properties: - serviceClassNames: + methodPolicies: + type: array + description: Defines policies applying to the API methods of the service. + items: + $ref: '#/components/schemas/MethodPolicy' + environment: description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - additionalProperties: + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + type: string + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + id: Control + type: object + BatchEnableServicesRequest: + type: object + properties: + serviceIds: + type: array + items: type: string - type: object - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - libraryPackage: + description: >- + The identifiers of the services to enable on the project. A valid + identifier would be: serviceusage.googleapis.com Enabling services + requires that each service is public or is shared with the user + enabling the service. A single request can enable a maximum of 20 + services at a time. If more than 20 services are specified, the + request will fail, and no state changes will occur. + description: Request message for the `BatchEnableServices` method. + id: BatchEnableServicesRequest + EnableServiceRequest: + type: object + description: Request message for the `EnableService` method. + id: EnableServiceRequest + properties: {} + Method: + id: Method + properties: + requestTypeUrl: + description: A URL of the input message type. + type: string + name: + description: The simple name of this method. + type: string + options: + description: Any metadata attached to the method. + items: + $ref: '#/components/schemas/Option' + type: array + requestStreaming: + type: boolean + description: If true, the request is streamed. + responseTypeUrl: + description: The URL of the output message type. + type: string + syntax: + description: The source syntax of this method. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. type: string - description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + responseStreaming: + description: If true, the response is streamed. + type: boolean + description: Method represents a method of an API interface. + type: object + Authentication: + id: Authentication type: object - description: Settings for Java client libraries. - id: JavaSettings - Backend: properties: + providers: + description: Defines a set of authentication providers that a service supports. + items: + $ref: '#/components/schemas/AuthProvider' + type: array rules: + type: array items: - $ref: '#/components/schemas/BackendRule' + $ref: '#/components/schemas/AuthenticationRule' description: >- - A list of API backend rules that apply to individual API methods. + A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + GoogleApiServiceusageV1OperationMetadata: + properties: + resourceNames: type: array - description: '`Backend` defines the backend configuration for a service.' - id: Backend + items: + type: string + description: >- + The full name of the resources that this operation is directly + associated with. + id: GoogleApiServiceusageV1OperationMetadata type: object - QuotaLimit: - description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. + description: The operation metadata returned for the batchend services operation. + AdminQuotaPolicy: + id: AdminQuotaPolicy + description: Quota policy created by quota administrator. type: object - id: QuotaLimit properties: - maxLimit: - type: string - format: int64 - description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - defaultLimit: - description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - format: int64 + metric: type: string - values: description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` + dimensions: additionalProperties: - format: int64 type: string + description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.' type: object - description: - description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). - type: string - freeTier: - type: string - format: int64 + unit: description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - metric: + The limit unit of the limit to which this policy applies. An example + unit would be: `1/{project}/{region}` Note that `{project}` and + `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. type: string + container: description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - duration: - description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. + The cloud resource container at which the quota policy is created. + The format is `{container_type}/{container_number}` type: string - unit: - description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. + policyValue: type: string - displayName: + format: int64 description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - type: string + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). name: description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. + The resource name of the policy. This name is generated by the + server when the policy is created. Example names would be: + `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` type: string - PythonSettings: - type: object - id: PythonSettings + GoogleApiServiceusageV1ServiceConfig: properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - experimentalFeatures: - $ref: '#/components/schemas/ExperimentalFeatures' + apis: + type: array description: >- - Experimental features to be included during client library - generation. - description: Settings for Python client libraries. - ServiceIdentity: - id: ServiceIdentity - type: object - properties: - uniqueId: - type: string + A list of API interfaces exported by this service. Contains only the + names, versions, and method names of the interfaces. + items: + $ref: '#/components/schemas/Api' + documentation: + $ref: '#/components/schemas/Documentation' description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount - email: - type: string + Additional API documentation. Contains only the summary and the + documentation URL. + authentication: + description: Auth configuration. Contains only the OAuth rules. + $ref: '#/components/schemas/Authentication' + monitoring: + $ref: '#/components/schemas/Monitoring' description: >- - The email address of the service account that a service producer - would use to access consumer resources. - description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - Logging: - id: Logging - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - type: object - properties: - producerDestinations: - items: - $ref: '#/components/schemas/LoggingDestination' + Monitoring configuration. This should not include the + 'producer_destinations' field. + monitoredResources: type: array - description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. - consumerDestinations: items: - $ref: '#/components/schemas/LoggingDestination' + $ref: '#/components/schemas/MonitoredResourceDescriptor' description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + title: + type: string + description: The product title for this service. + endpoints: type: array - MethodPolicy: - description: Defines policies applying to an RPC method. - id: MethodPolicy + items: + $ref: '#/components/schemas/Endpoint' + description: >- + Configuration for network endpoints. Contains only the names and + aliases of the endpoints. + name: + description: >- + The DNS address at which this service is available. An example DNS + address would be: `calendar.googleapis.com`. + type: string + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. + usage: + description: Configuration controlling usage of this service. + $ref: '#/components/schemas/Usage' + id: GoogleApiServiceusageV1ServiceConfig + description: The configuration of the service. + type: object + SystemParameter: + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + type: object + id: SystemParameter properties: - requestPolicies: - items: - $ref: '#/components/schemas/FieldPolicy' - type: array - description: Policies that are applicable to the request message. - selector: + name: + type: string description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . + Define the name of the parameter, such as "api_key" . It is case + sensitive. + urlQueryParameter: + type: string + description: >- + Define the URL query parameter name to use for the parameter. It is + case sensitive. + httpHeader: + description: >- + Define the HTTP header name to use for the parameter. It is case + insensitive. type: string + EnableServiceResponse: + description: >- + Response message for the `EnableService` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + id: EnableServiceResponse + properties: + service: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The new state of the service after enabling. type: object - MetricDescriptorMetadata: + ClientLibrarySettings: + id: ClientLibrarySettings properties: + version: + description: >- + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". + type: string launchStage: - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. - deprecated: true + description: Launch stage of this version of the API. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -3292,554 +3427,413 @@ components: - BETA - GA - DEPRECATED - ingestDelay: - format: google-duration - description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - type: string - samplePeriod: - format: google-duration - description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. - type: string - timeSeriesResourceHierarchyLevel: - description: The scope of the timeseries data of the metric. - items: - enumDescriptions: - - Do not use this default value. - - Scopes a metric to a project. - - Scopes a metric to an organization. - - Scopes a metric to a folder. - type: string - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER - type: array - description: Additional annotations that can be used to guide the usage of a metric. - id: MetricDescriptorMetadata - type: object - BatchEnableServicesRequest: - properties: - serviceIds: - type: array - description: >- - The identifiers of the services to enable on the project. A valid - identifier would be: serviceusage.googleapis.com Enabling services - requires that each service is public or is shared with the user - enabling the service. A single request can enable a maximum of 20 - services at a time. If more than 20 services are specified, the - request will fail, and no state changes will occur. - items: - type: string - type: object - description: Request message for the `BatchEnableServices` method. - id: BatchEnableServicesRequest - BatchCreateConsumerOverridesResponse: - properties: - overrides: - type: array - items: - $ref: '#/components/schemas/QuotaOverride' - description: The overrides that were created. - id: BatchCreateConsumerOverridesResponse - description: Response message for BatchCreateConsumerOverrides - type: object - AddEnableRulesResponse: - properties: - addedValues: - items: - type: string - description: The values added to the parent consumer policy. - type: array - parent: - type: string - description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. - type: object - id: AddEnableRulesResponse - description: The response message of `AddEnableRules` method. - JwtLocation: - type: object - properties: - query: - description: Specifies URL query parameter name to extract JWT token. - type: string - header: - description: Specifies HTTP header name to extract JWT token. - type: string - valuePrefix: - type: string - description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - cookie: - description: Specifies cookie name to extract JWT token. - type: string - description: Specifies a location to extract JWT from an API request. - id: JwtLocation - EnableServiceResponse: - type: object - description: >- - Response message for the `EnableService` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - properties: - service: - description: The new state of the service after enabling. - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - id: EnableServiceResponse - ImportAdminOverridesResponse: - description: Response message for ImportAdminOverrides - properties: - overrides: - description: The overrides that were created from the imported data. - type: array - items: - $ref: '#/components/schemas/QuotaOverride' - id: ImportAdminOverridesResponse - type: object - ExperimentalFeatures: - description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. - id: ExperimentalFeatures - type: object - properties: - restAsyncIoEnabled: - description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. - type: boolean - GoogleApiServiceusageV2alphaEnableRule: - description: >- - The consumer policy rule that defines enabled services, groups, and - categories. - id: GoogleApiServiceusageV2alphaEnableRule - properties: - services: - type: array - items: - type: string - description: >- - The names of the services that are enabled. Example: - `services/storage.googleapis.com`. - type: object - GoogleApiService: - id: GoogleApiService - description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - properties: - customError: - description: Custom error configuration. - $ref: '#/components/schemas/CustomError' - context: - $ref: '#/components/schemas/Context' - description: Context configuration. - endpoints: - description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. - items: - $ref: '#/components/schemas/Endpoint' - type: array - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - title: - type: string - description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - control: - description: Configuration for the service control plane. - $ref: '#/components/schemas/Control' - sourceInfo: + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. + dotnetSettings: + $ref: '#/components/schemas/DotnetSettings' + description: Settings for .NET client libraries. + restNumericEnums: description: >- - Output only. The source information for this configuration if - available. - $ref: '#/components/schemas/SourceInfo' - producerProjectId: - type: string - description: The Google project that owns this service. - apis: + When using transport=rest, the client request will encode enums as + numbers rather than strings. + type: boolean + goSettings: + $ref: '#/components/schemas/GoSettings' + description: Settings for Go client libraries. + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + phpSettings: + description: Settings for PHP client libraries. + $ref: '#/components/schemas/PhpSettings' + cppSettings: + description: Settings for C++ client libraries. + $ref: '#/components/schemas/CppSettings' + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. + type: object + description: Details about how and where to publish client libraries. + CommonLanguageSettings: + properties: + destinations: type: array description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. + The destination where API teams want this client library to be + published. items: - $ref: '#/components/schemas/Api' - publishing: - description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - $ref: '#/components/schemas/Publishing' - name: + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + type: string + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + referenceDocsUri: + deprecated: true description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest type: string - logging: - description: Logging configuration. - $ref: '#/components/schemas/Logging' - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - logs: - description: Defines the logs used by this service. - items: - $ref: '#/components/schemas/LogDescriptor' - type: array - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - metrics: - type: array - items: - $ref: '#/components/schemas/MetricDescriptor' - description: Defines the metrics used by this service. - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - monitoredResources: + id: CommonLanguageSettings + description: Required information for every language. + type: object + BatchEnableServicesResponse: + id: BatchEnableServicesResponse + description: >- + Response message for the `BatchEnableServices` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + type: object + properties: + failures: description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - type: array + If allow_partial_success is true, and one or more services could not + be enabled, this field contains the details about each failure. items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - enums: + $ref: '#/components/schemas/EnableFailure' type: array + services: + description: The new state of the services after enabling. items: - $ref: '#/components/schemas/Enum' - description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - types: - items: - $ref: '#/components/schemas/Type' + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' type: array - description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - configVersion: - format: uint32 - description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - type: integer - id: - description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. + LabelDescriptor: + id: LabelDescriptor + properties: + valueType: + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + enum: + - STRING + - BOOL + - INT64 + description: The type of data that can be assigned to the label. type: string - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - backend: - description: API backend configuration. - $ref: '#/components/schemas/Backend' - systemTypes: - description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - type: array - items: - $ref: '#/components/schemas/Type' - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - type: object - ContextRule: + description: + type: string + description: A human-readable description for the label. + key: + description: The label key. + type: string + description: A description of a label. type: object + UsageRule: description: >- - A context rule provides information about the context for an individual - API element. + Usage configuration rules for the service. NOTE: Under development. Use + this rule to configure unregistered calls for the service. Unregistered + calls are calls that do not contain consumer project identity. (Example: + calls that do not contain an API key). By default, API methods do not + allow unregistered calls, and each method call must be identified by a + consumer project identity. Use this rule to allow/disallow unregistered + calls. Example of an API that wants to allow unregistered calls for + entire service. usage: rules: - selector: "*" allow_unregistered_calls: + true Example of a method that wants to allow unregistered calls. usage: + rules: - selector: "google.example.library.v1.LibraryService.CreateBook" + allow_unregistered_calls: true + type: object properties: selector: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string - allowedResponseExtensions: + skipServiceControl: + type: boolean description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - type: array - items: - type: string - provided: - items: - type: string - type: array + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + allowUnregisteredCalls: + type: boolean description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. - requested: + If true, the selected method allows unregistered calls, e.g. calls + that don't identify any user or application. + id: UsageRule + MethodSettings: + id: MethodSettings + type: object + properties: + autoPopulatedFields: description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id type: array items: type: string - allowedRequestExtensions: - items: - type: string + longRunning: description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - type: array - id: ContextRule - ListOperationsResponse: - description: The response message for Operations.ListOperations. - id: ListOperationsResponse - type: object - properties: - nextPageToken: + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + $ref: '#/components/schemas/LongRunning' + selector: type: string - description: The standard List next-page token. - operations: - items: - $ref: '#/components/schemas/Operation' description: >- - A list of operations that matches the specified filter in the - request. - type: array - Context: + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... + description: Describes the generator configuration for a method. + Empty: + type: object description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. + 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); } + properties: {} + id: Empty + ExperimentalFeatures: + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + id: ExperimentalFeatures properties: - rules: - items: - $ref: '#/components/schemas/ContextRule' + restAsyncIoEnabled: description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - id: Context + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean type: object - CommonLanguageSettings: - description: Required information for every language. - id: CommonLanguageSettings + PythonSettings: + id: PythonSettings properties: - destinations: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + experimentalFeatures: + $ref: '#/components/schemas/ExperimentalFeatures' description: >- - The destination where API teams want this client library to be - published. - type: array + Experimental features to be included during client library + generation. + description: Settings for Python client libraries. + type: object + ImportAdminOverridesResponse: + description: Response message for ImportAdminOverrides + id: ImportAdminOverridesResponse + properties: + overrides: items: - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - type: string - referenceDocsUri: + $ref: '#/components/schemas/QuotaOverride' + type: array + description: The overrides that were created from the imported data. + type: object + GoogleApiServiceusageV1beta1ServiceIdentity: + id: GoogleApiServiceusageV1beta1ServiceIdentity + properties: + email: description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest + The email address of the service account that a service producer + would use to access consumer resources. + type: string + uniqueId: + description: >- + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount type: string - deprecated: true - type: object - Usage: type: object - id: Usage - description: Configuration controlling usage of a service. + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + Page: properties: - requirements: + subpages: description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. type: array items: - type: string - producerNotificationChannel: + $ref: '#/components/schemas/Page' + name: description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. type: string - rules: - items: - $ref: '#/components/schemas/UsageRule' + content: description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - GoogleApiServiceusageV1Service: - id: GoogleApiServiceusageV1Service + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. + type: string + id: Page + type: object + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + QuotaOverride: + type: object + description: A quota override properties: - config: - $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' - description: >- - The service configuration of the available service. Some fields may - be filtered out of the configuration in responses to the - `ListServices` method. These fields are present only in responses to - the `GetService` method. name: + type: string description: >- - The resource name of the consumer and service. A valid name would - be: - projects/123/services/serviceusage.googleapis.com + The resource name of the override. This name is generated by the + server when the override is created. Example names would be: + `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` + `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` + The resource name is intended to be opaque and should not be parsed + for its component strings, since its representation could change in + the future. + metric: type: string - parent: + description: >- + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` + overrideValue: + description: >- + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). type: string + format: int64 + dimensions: description: >- - The resource name of the consumer. A valid name would be: - - projects/123 - state: - enum: - - STATE_UNSPECIFIED - - DISABLED - - ENABLED + If this map is nonempty, then this override applies only to specific + values for dimensions defined in the limit unit. For example, an + override on a limit with the unit `1/{project}/{region}` could + contain an entry with the key `region` and the value `us-east-1`; + the override is only applied to quota consumed in that region. This + map has the following restrictions: * Keys that are not defined in + the limit's unit are not valid keys. Any string appearing in + `{brackets}` in the unit (besides `{project}` or `{user}`) is a + defined key. * `project` is not a valid key; the project is already + specified in the parent resource name. * `user` is not a valid key; + the API does not support quota overrides that apply only to a + specific user. * If `region` appears as a key, its value must be a + valid Cloud region. * If `zone` appears as a key, its value must be + a valid Cloud zone. * If any valid key other than `region` or `zone` + appears in the map, then all valid keys other than `region` or + `zone` must also appear in the map. + additionalProperties: + type: string + type: object + unit: + type: string + description: >- + The limit unit of the limit to which this override applies. An + example unit would be: `1/{project}/{region}` Note that `{project}` + and `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. + adminOverrideAncestor: type: string - enumDescriptions: - - >- - The default value, which indicates that the enabled state of the - service is unspecified or not meaningful. Currently, all consumers - other than projects (such as folders and organizations) are always - in this state. - - >- - The service cannot be used by this consumer. It has either been - explicitly disabled, or has never been enabled. - - The service has been explicitly enabled for use by this consumer. - description: Whether or not the service has been enabled for use by the consumer. - type: object - description: A service that is available for use by the consumer. - MonitoringDestination: + description: >- + The resource name of the ancestor that requested the override. For + example: `organizations/12345` or `folders/67890`. Used by admin + overrides only. + id: QuotaOverride + ConsumerPolicy: type: object - id: MonitoringDestination + description: >- + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. + id: ConsumerPolicy properties: - metrics: + etag: + type: string description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. + An opaque tag indicating the current version of the policy, used for + concurrency control. + enableRules: + description: Enable rules define usable services and service groups. items: - type: string + $ref: '#/components/schemas/EnableRule' type: array - monitoredResource: + updateTime: + description: The last-modified time. + format: google-datetime type: string + name: description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. + Output only. The resource name of the policy. We only allow consumer + policy name as `default` for now: + `projects/12345/consumerPolicies/default`, + `folders/12345/consumerPolicies/default`, + `organizations/12345/consumerPolicies/default`. + readOnly: true + type: string + annotations: + type: object + additionalProperties: + type: string + description: >- + Optional. Annotations is an unstructured key-value map stored with a + policy that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. + [AIP-128](https://google.aip.dev/128#annotations) + DeleteAdminQuotaPolicyMetadata: + properties: {} description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - EnableFailure: - description: Provides error messages for the failing services. + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by DeleteAdminQuotaPolicy. + type: object + id: DeleteAdminQuotaPolicyMetadata + SystemParameters: + description: >- + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. properties: - errorMessage: - type: string - description: An error message describing why the service could not be enabled. - serviceId: - type: string - description: The service id of a service that could not be enabled. - id: EnableFailure + rules: + items: + $ref: '#/components/schemas/SystemParameterRule' + type: array + description: >- + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + id: SystemParameters type: object parameters: - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - access_token: - description: OAuth access token. + callback: + description: JSONP in: query - name: access_token + name: callback schema: type: string prettyPrint: @@ -3854,10 +3848,25 @@ components: name: uploadType schema: type: string - callback: - description: JSONP + 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. in: query - name: callback + name: key + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string alt: @@ -3870,12 +3879,6 @@ components: - json - media - proto - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -3891,6 +3894,12 @@ components: name: upload_protocol schema: type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -3900,27 +3909,12 @@ components: enum: - '1' - '2' - 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. - in: query - name: key - schema: - type: string x-stackQL-resources: operations: id: google.serviceusage.operations name: operations title: Operations methods: - cancel: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' - response: - mediaType: application/json - openAPIDocKey: '200' delete: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' @@ -3933,6 +3927,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + cancel: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: '#/paths/~1v1~1operations/get' @@ -3972,7 +3972,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' - enable: + disable: operation: $ref: '#/paths/~1v1~1{name}/post' response: @@ -3987,36 +3987,26 @@ components: replace: [] delete: [] paths: - /v1/operations/{operationsId}:cancel: + /v1/operations/{operationsId}: parameters: &ref_1 - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - post: + delete: 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`. - operationId: serviceusage.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' + 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`. + operationId: serviceusage.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4039,15 +4029,12 @@ paths: required: true schema: type: string - /v1/operations/{operationsId}: - parameters: *ref_1 - delete: + get: 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`. - operationId: serviceusage.operations.delete + 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. + operationId: serviceusage.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4063,19 +4050,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: operationsId required: true schema: type: string - get: + /v1/operations/{operationsId}:cancel: + parameters: *ref_1 + post: 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. - operationId: serviceusage.operations.get + 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`. + operationId: serviceusage.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4091,7 +4091,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: operationsId @@ -4122,10 +4122,6 @@ paths: schema: $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: @@ -4139,6 +4135,10 @@ paths: name: name schema: type: string + - in: query + name: filter + schema: + type: string /v1/{parentType}/{parent}/services: parameters: *ref_1 get: @@ -4244,13 +4244,19 @@ paths: schema: type: string post: - description: Enable a service so that it can be used with a project. - operationId: serviceusage.services.enable + description: >- + Disable a service so that it can no longer be used with a project. This + prevents unintended usage that may cause unexpected billing charges or + security leaks. It is not valid to call the disable method on a service + that is not currently enabled. Callers will receive a + `FAILED_PRECONDITION` status if the target service is not currently + enabled. + operationId: serviceusage.services.disable requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnableServiceRequest' + $ref: '#/components/schemas/DisableServiceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform diff --git a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml index 6b0fc5fe..356a4d29 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml @@ -34,66 +34,8 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SolarPanelConfig: - type: object - properties: - panelsCount: - format: int32 - description: >- - Total number of panels. Note that this is redundant to (the sum of) - the corresponding fields in roof_segment_summaries. - type: integer - roofSegmentSummaries: - type: array - items: - $ref: '#/components/schemas/RoofSegmentSummary' - description: >- - Information about the production of each roof segment that is - carrying at least one panel in this layout. - `roof_segment_summaries[i]` describes the i-th roof segment, - including its size, expected production and orientation. - yearlyEnergyDcKwh: - format: float - type: number - description: >- - How much sunlight energy this layout captures over the course of a - year, in DC kWh, assuming the panels described above. - description: >- - SolarPanelConfig describes a particular placement of solar panels on the - roof. - id: SolarPanelConfig - SavingsOverTime: - id: SavingsOverTime - properties: - financiallyViable: - type: boolean - description: >- - Indicates whether this scenario is financially viable. Will be false - for scenarios with poor financial viability (e.g., money-losing). - savingsYear1: - $ref: '#/components/schemas/Money' - description: Savings in the first year after panel installation. - savingsYear20: - description: Savings in the first twenty years after panel installation. - $ref: '#/components/schemas/Money' - presentValueOfSavingsYear20: - description: >- - Using the assumed discount rate, what is the present value of the - cumulative 20-year savings? - $ref: '#/components/schemas/Money' - savingsLifetime: - description: Savings in the entire panel lifetime. - $ref: '#/components/schemas/Money' - presentValueOfSavingsLifetime: - description: >- - Using the assumed discount rate, what is the present value of the - cumulative lifetime savings? - $ref: '#/components/schemas/Money' - description: Financial information that's shared between different financing methods. - type: object Date: type: object - id: Date description: >- Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are @@ -104,272 +46,89 @@ components: * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + id: Date properties: - day: - type: integer + month: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. format: int32 + type: integer year: + format: int32 description: >- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. type: integer + day: format: int32 - month: - type: integer - format: int32 - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - CashPurchaseSavings: - description: >- - Cost and benefit of an outright purchase of a particular configuration - of solar panels with a particular electricity usage. - type: object - properties: - outOfPocketCost: - $ref: '#/components/schemas/Money' - description: >- - Initial cost before tax incentives: the amount that must be paid - out-of-pocket. Contrast with `upfront_cost`, which is after tax - incentives. - rebateValue: - $ref: '#/components/schemas/Money' - description: The value of all tax rebates. - savings: - description: How much is saved (or not) over the lifetime period. - $ref: '#/components/schemas/SavingsOverTime' - upfrontCost: description: >- - Initial cost after tax incentives: it's the amount that must be paid - during first year. Contrast with `out_of_pocket_cost`, which is - before tax incentives. - $ref: '#/components/schemas/Money' - paybackYears: - type: number - format: float - description: >- - Number of years until payback occurs. A negative value means payback - never occurs within the lifetime period. - id: CashPurchaseSavings - SolarPanel: - type: object + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + SolarPanelConfig: + id: SolarPanelConfig properties: - segmentIndex: + panelsCount: description: >- - Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` - which corresponds to the roof segment that this panel is placed on. + Total number of panels. Note that this is redundant to (the sum of) + the corresponding fields in roof_segment_summaries. format: int32 type: integer - orientation: - enumDescriptions: - - No panel orientation is known. - - >- - A `LANDSCAPE` panel has its long edge perpendicular to the azimuth - direction of the roof segment that it is placed on. - - >- - A `PORTRAIT` panel has its long edge parallel to the azimuth - direction of the roof segment that it is placed on. - type: string - description: The orientation of the panel. - enum: - - SOLAR_PANEL_ORIENTATION_UNSPECIFIED - - LANDSCAPE - - PORTRAIT - center: - $ref: '#/components/schemas/LatLng' - description: The centre of the panel. yearlyEnergyDcKwh: - type: number - format: float - description: >- - How much sunlight energy this layout captures over the course of a - year, in DC kWh. - description: >- - SolarPanel describes the position, orientation, and production of a - single solar panel. See the panel_height_meters, panel_width_meters, and - panel_capacity_watts fields in SolarPotential for information on the - parameters of the panel. - id: SolarPanel - FinancialDetails: - description: >- - Details of a financial analysis. Some of these details are already - stored at higher levels (e.g., out of pocket cost). Total money amounts - are over a lifetime period defined by the panel_lifetime_years field in - SolarPotential. Note: The out of pocket cost of purchasing the panels is - given in the out_of_pocket_cost field in CashPurchaseSavings. - type: object - id: FinancialDetails - properties: - percentageExportedToGrid: - format: float - description: >- - The percentage (0-100) of solar electricity production we assumed - was exported to the grid, based on the first quarter of production. - This affects the calculations if net metering is not allowed. - type: number - initialAcKwhPerYear: format: float type: number description: >- - How many AC kWh we think the solar panels will generate in their - first year. - utilityIncentive: - $ref: '#/components/schemas/Money' - description: >- - Amount of money available from utility incentives; this applies if - the user buys (with or without a loan) the panels. - costOfElectricityWithoutSolar: - $ref: '#/components/schemas/Money' - description: >- - Total cost of electricity the user would have paid over the lifetime - period if they didn't install solar. - federalIncentive: - $ref: '#/components/schemas/Money' - description: >- - Amount of money available from federal incentives; this applies if - the user buys (with or without a loan) the panels. - lifetimeSrecTotal: - $ref: '#/components/schemas/Money' - description: >- - Amount of money the user will receive from Solar Renewable Energy - Credits over the panel lifetime; this applies if the user buys (with - or without a loan) the panels. - solarPercentage: - description: >- - Percentage (0-100) of the user's power supplied by solar. Valid for - the first year but approximately correct for future years. - type: number - format: float - stateIncentive: - $ref: '#/components/schemas/Money' - description: >- - Amount of money available from state incentives; this applies if the - user buys (with or without a loan) the panels. - remainingLifetimeUtilityBill: - $ref: '#/components/schemas/Money' - description: >- - Utility bill for electricity not produced by solar, for the lifetime - of the panels. - netMeteringAllowed: - description: Whether net metering is allowed. - type: boolean - SizeAndSunshineStats: - id: SizeAndSunshineStats - description: Size and sunniness quantiles of a roof, or part of a roof. - type: object - properties: - sunshineQuantiles: - type: array - description: >- - Quantiles of the pointwise sunniness across the area. If there are N - values here, this represents the (N-1)-iles. For example, if there - are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, - max). Values are in annual kWh/kW like max_sunshine_hours_per_year. + How much sunlight energy this layout captures over the course of a + year, in DC kWh, assuming the panels described above. + roofSegmentSummaries: items: - type: number - format: float - groundAreaMeters2: - description: >- - The ground footprint area covered by the roof or roof segment, in - m^2. - type: number - format: float - areaMeters2: - format: float - type: number - description: >- - The area of the roof or roof segment, in m^2. This is the roof area - (accounting for tilt), not the ground footprint area. - LeasingSavings: - properties: - leasesSupported: - type: boolean - description: >- - Whether leases are supported in this juristiction by the financial - calculation engine. If this field is false, then the values in this - message should probably be ignored. This is independent of - `leases_allowed`: in some areas leases are allowed, but under - conditions that aren't handled by the financial models. - annualLeasingCost: - description: Estimated annual leasing cost. - $ref: '#/components/schemas/Money' - leasesAllowed: - type: boolean + $ref: '#/components/schemas/RoofSegmentSummary' + type: array description: >- - Whether leases are allowed in this juristiction (leases are not - allowed in some states). If this field is false, then the values in - this message should probably be ignored. - savings: - $ref: '#/components/schemas/SavingsOverTime' - description: How much is saved (or not) over the lifetime period. - id: LeasingSavings + Information about the production of each roof segment that is + carrying at least one panel in this layout. + `roof_segment_summaries[i]` describes the i-th roof segment, + including its size, expected production and orientation. description: >- - Cost and benefit of leasing a particular configuration of solar panels - with a particular electricity usage. + SolarPanelConfig describes a particular placement of solar panels on the + roof. type: object - RoofSegmentSummary: + LatLng: + id: LatLng + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. properties: - panelsCount: - type: integer - format: int32 - description: The total number of panels on this segment. - azimuthDegrees: - format: float - description: >- - Compass direction the roof segment is pointing in. 0 = North, 90 = - East, 180 = South. For a "flat" roof segment (`pitch_degrees` very - near 0), azimuth is not well defined, so for consistency, we define - it arbitrarily to be 0 (North). - type: number - yearlyEnergyDcKwh: - format: float - type: number - description: >- - How much sunlight energy this part of the layout captures over the - course of a year, in DC kWh, assuming the panels described above. - segmentIndex: - type: integer - format: int32 - description: >- - Index in roof_segment_stats of the corresponding - `RoofSegmentSizeAndSunshineStats`. - pitchDegrees: - format: float + longitude: type: number - description: >- - Angle of the roof segment relative to the theoretical ground plane. - 0 = parallel to the ground, 90 = perpendicular to the ground. + format: double + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: number + format: double type: object - id: RoofSegmentSummary - description: >- - Information about a roof segment on the building, with some number of - panels placed on it. BuildingInsights: + id: BuildingInsights + description: >- + Response message for `Solar.FindClosestBuildingInsights`. Information + about the location, dimensions, and solar potential of a building. + type: object properties: - postalCode: - type: string - description: Postal code (e.g., US zip code) this building is contained by. administrativeArea: description: >- Administrative area 1 (e.g., in the US, the state) that contains this building. For example, in the US, the abbreviation might be "MA" or "CA." type: string - regionCode: + postalCode: type: string - description: Region code for the country (or region) this building is in. - boundingBox: - $ref: '#/components/schemas/LatLngBox' - description: The bounding box of the building. + description: Postal code (e.g., US zip code) this building is contained by. imageryQuality: - description: >- - The quality of the imagery used to compute the data for this - building. - type: string enum: - IMAGERY_QUALITY_UNSPECIFIED - HIGH @@ -390,15 +149,19 @@ components: - >- Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. - statisticalArea: type: string - description: Statistical area (e.g., US census tract) this building is in. + description: >- + The quality of the imagery used to compute the data for this + building. center: - $ref: '#/components/schemas/LatLng' description: A point near the center of the building. + $ref: '#/components/schemas/LatLng' solarPotential: - $ref: '#/components/schemas/SolarPotential' description: Solar potential of the building. + $ref: '#/components/schemas/SolarPotential' + statisticalArea: + type: string + description: Statistical area (e.g., US census tract) this building is in. imageryDate: $ref: '#/components/schemas/Date' description: Date that the underlying imagery was acquired. This is approximate. @@ -406,180 +169,163 @@ components: type: string description: The resource name for the building, of the format `building/`. imageryProcessedDate: - description: When processing was completed on this imagery. $ref: '#/components/schemas/Date' - description: >- - Response message for `Solar.FindClosestBuildingInsights`. Information - about the location, dimensions, and solar potential of a building. + description: When processing was completed on this imagery. + boundingBox: + $ref: '#/components/schemas/LatLngBox' + description: The bounding box of the building. + regionCode: + type: string + description: Region code for the country (or region) this building is in. + Money: + description: Represents an amount of money with its currency type. + id: Money type: object - id: BuildingInsights - LatLngBox: - id: LatLngBox - description: A bounding box in lat/lng coordinates. properties: - ne: - $ref: '#/components/schemas/LatLng' - description: The northeast corner of the box. - sw: - description: The southwest corner of the box. - $ref: '#/components/schemas/LatLng' - type: object + units: + format: int64 + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 FinancedPurchaseSavings: - id: FinancedPurchaseSavings type: object description: >- Cost and benefit of using a loan to buy a particular configuration of solar panels with a particular electricity usage. properties: loanInterestRate: - description: The interest rate on loans assumed in this set of calculations. - type: number format: float + type: number + description: The interest rate on loans assumed in this set of calculations. annualLoanPayment: - $ref: '#/components/schemas/Money' description: Annual loan payments. - savings: - $ref: '#/components/schemas/SavingsOverTime' - description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/Money' rebateValue: $ref: '#/components/schemas/Money' description: >- The value of all tax rebates (including Federal Investment Tax Credit (ITC)). - HttpBody: - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + savings: + $ref: '#/components/schemas/SavingsOverTime' + description: How much is saved (or not) over the lifetime period. + id: FinancedPurchaseSavings + CashPurchaseSavings: properties: - contentType: - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - type: string - extensions: - type: array + rebateValue: + $ref: '#/components/schemas/Money' + description: The value of all tax rebates. + outOfPocketCost: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - data: - format: byte - type: string - description: The HTTP request/response body as raw binary. - type: object - id: HttpBody - LatLng: - properties: - longitude: - type: number - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - format: double - latitude: - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - format: double + Initial cost before tax incentives: the amount that must be paid + out-of-pocket. Contrast with `upfront_cost`, which is after tax + incentives. + $ref: '#/components/schemas/Money' + paybackYears: type: number - type: object - id: LatLng - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - Money: - type: object - id: Money - properties: - nanos: + format: float description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - currencyCode: - description: The three-letter currency code defined in ISO 4217. - type: string - units: - format: int64 + Number of years until payback occurs. A negative value means payback + never occurs within the lifetime period. + savings: + $ref: '#/components/schemas/SavingsOverTime' + description: How much is saved (or not) over the lifetime period. + upfrontCost: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string - description: Represents an amount of money with its currency type. - RoofSegmentSizeAndSunshineStats: - description: Information about the size and sunniness quantiles of a roof segment. + Initial cost after tax incentives: it's the amount that must be paid + during first year. Contrast with `out_of_pocket_cost`, which is + before tax incentives. + $ref: '#/components/schemas/Money' type: object + id: CashPurchaseSavings + description: >- + Cost and benefit of an outright purchase of a particular configuration + of solar panels with a particular electricity usage. + RoofSegmentSizeAndSunshineStats: properties: - center: - $ref: '#/components/schemas/LatLng' - description: A point near the center of the roof segment. - planeHeightAtCenterMeters: - format: float - description: >- - The height of the roof segment plane, in meters above sea level, at - the point designated by `center`. Together with the pitch, azimuth, - and center location, this fully defines the roof segment plane. - type: number - stats: - description: Total size and sunlight quantiles for the roof segment. - $ref: '#/components/schemas/SizeAndSunshineStats' azimuthDegrees: - type: number format: float + type: number description: >- Compass direction the roof segment is pointing in. 0 = North, 90 = East, 180 = South. For a "flat" roof segment (`pitch_degrees` very near 0), azimuth is not well defined, so for consistency, we define it arbitrarily to be 0 (North). pitchDegrees: + format: float + type: number description: >- Angle of the roof segment relative to the theoretical ground plane. 0 = parallel to the ground, 90 = perpendicular to the ground. - type: number + center: + $ref: '#/components/schemas/LatLng' + description: A point near the center of the roof segment. + planeHeightAtCenterMeters: + description: >- + The height of the roof segment plane, in meters above sea level, at + the point designated by `center`. Together with the pitch, azimuth, + and center location, this fully defines the roof segment plane. format: float + type: number + stats: + $ref: '#/components/schemas/SizeAndSunshineStats' + description: Total size and sunlight quantiles for the roof segment. boundingBox: description: The bounding box of the roof segment. $ref: '#/components/schemas/LatLngBox' + type: object + description: Information about the size and sunniness quantiles of a roof segment. id: RoofSegmentSizeAndSunshineStats DataLayers: - id: DataLayers - description: >- - Information about the solar potential of a region. The actual data are - contained in a number of GeoTIFF files covering the requested region, - for which this message contains URLs: Each string in the `DataLayers` - message contains a URL from which the corresponding GeoTIFF can be - fetched. These URLs are valid for a few hours after they've been - generated. Most of the GeoTIFF files are at a resolution of 0.1m/pixel, - but the monthly flux file is at 0.5m/pixel, and the hourly shade files - are at 1m/pixel. If a `pixel_size_meters` value was specified in the - `GetDataLayersRequest`, then the minimum resolution in the GeoTIFF files - will be that value. - type: object properties: + imageryProcessedDate: + description: When processing was completed on this imagery. + $ref: '#/components/schemas/Date' + annualFluxUrl: + type: string + description: >- + The URL for the annual flux map (annual sunlight on roofs) of the + region. Values are kWh/kW/year. This is *unmasked flux*: flux is + computed for every location, not just building rooftops. Invalid + locations are stored as -9999: locations outside our coverage area + will be invalid, and a few locations inside the coverage area, where + we were unable to calculate flux, will also be invalid. + rgbUrl: + description: The URL for an image of RGB data (aerial photo) of the region. + type: string + imageryDate: + $ref: '#/components/schemas/Date' + description: >- + When the source imagery (from which all the other data are derived) + in this region was taken. It is necessarily somewhat approximate, as + the images may have been taken over more than one day. + dsmUrl: + description: >- + The URL for an image of the DSM (Digital Surface Model) of the + region. Values are in meters above EGM96 geoid (i.e., sea level). + Invalid locations (where we don't have data) are stored as -9999. + type: string imageryQuality: + type: string + enum: + - IMAGERY_QUALITY_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + - BASE enumDescriptions: - No quality is known. - >- @@ -595,54 +341,10 @@ components: Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. description: The quality of the result's imagery. - type: string - enum: - - IMAGERY_QUALITY_UNSPECIFIED - - HIGH - - MEDIUM - - LOW - - BASE - maskUrl: - type: string - description: >- - The URL for the building mask image: one bit per pixel saying - whether that pixel is considered to be part of a rooftop or not. - imageryDate: - $ref: '#/components/schemas/Date' - description: >- - When the source imagery (from which all the other data are derived) - in this region was taken. It is necessarily somewhat approximate, as - the images may have been taken over more than one day. - dsmUrl: - description: >- - The URL for an image of the DSM (Digital Surface Model) of the - region. Values are in meters above EGM96 geoid (i.e., sea level). - Invalid locations (where we don't have data) are stored as -9999. - type: string - annualFluxUrl: - type: string - description: >- - The URL for the annual flux map (annual sunlight on roofs) of the - region. Values are kWh/kW/year. This is *unmasked flux*: flux is - computed for every location, not just building rooftops. Invalid - locations are stored as -9999: locations outside our coverage area - will be invalid, and a few locations inside the coverage area, where - we were unable to calculate flux, will also be invalid. - monthlyFluxUrl: - description: >- - The URL for the monthly flux map (sunlight on roofs, broken down by - month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to - by this URL will contain twelve bands, corresponding to - January...December, in order. - type: string - rgbUrl: - type: string - description: The URL for an image of RGB data (aerial photo) of the region. - imageryProcessedDate: - $ref: '#/components/schemas/Date' - description: When processing was completed on this imagery. hourlyShadeUrls: type: array + items: + type: string description: >- Twelve URLs for hourly shade, corresponding to January...December, in order. Each GeoTIFF will contain 24 bands, corresponding to the @@ -667,89 +369,257 @@ components: the channels, and a final non-zero result means "sunny". There are no leap days, and DST doesn't exist (all days are 24 hours long; noon is always "standard time" noon). + monthlyFluxUrl: + type: string + description: >- + The URL for the monthly flux map (sunlight on roofs, broken down by + month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to + by this URL will contain twelve bands, corresponding to + January...December, in order. + maskUrl: + type: string + description: >- + The URL for the building mask image: one bit per pixel saying + whether that pixel is considered to be part of a rooftop or not. + id: DataLayers + description: >- + Information about the solar potential of a region. The actual data are + contained in a number of GeoTIFF files covering the requested region, + for which this message contains URLs: Each string in the `DataLayers` + message contains a URL from which the corresponding GeoTIFF can be + fetched. These URLs are valid for a few hours after they've been + generated. Most of the GeoTIFF files are at a resolution of 0.1m/pixel, + but the monthly flux file is at 0.5m/pixel, and the hourly shade files + are at 1m/pixel. If a `pixel_size_meters` value was specified in the + `GetDataLayersRequest`, then the minimum resolution in the GeoTIFF files + will be that value. + type: object + FinancialDetails: + type: object + description: >- + Details of a financial analysis. Some of these details are already + stored at higher levels (e.g., out of pocket cost). Total money amounts + are over a lifetime period defined by the panel_lifetime_years field in + SolarPotential. Note: The out of pocket cost of purchasing the panels is + given in the out_of_pocket_cost field in CashPurchaseSavings. + id: FinancialDetails + properties: + lifetimeSrecTotal: + $ref: '#/components/schemas/Money' + description: >- + Amount of money the user will receive from Solar Renewable Energy + Credits over the panel lifetime; this applies if the user buys (with + or without a loan) the panels. + netMeteringAllowed: + description: Whether net metering is allowed. + type: boolean + percentageExportedToGrid: + format: float + type: number + description: >- + The percentage (0-100) of solar electricity production we assumed + was exported to the grid, based on the first quarter of production. + This affects the calculations if net metering is not allowed. + initialAcKwhPerYear: + description: >- + How many AC kWh we think the solar panels will generate in their + first year. + type: number + format: float + remainingLifetimeUtilityBill: + description: >- + Utility bill for electricity not produced by solar, for the lifetime + of the panels. + $ref: '#/components/schemas/Money' + federalIncentive: + description: >- + Amount of money available from federal incentives; this applies if + the user buys (with or without a loan) the panels. + $ref: '#/components/schemas/Money' + costOfElectricityWithoutSolar: + description: >- + Total cost of electricity the user would have paid over the lifetime + period if they didn't install solar. + $ref: '#/components/schemas/Money' + utilityIncentive: + description: >- + Amount of money available from utility incentives; this applies if + the user buys (with or without a loan) the panels. + $ref: '#/components/schemas/Money' + stateIncentive: + description: >- + Amount of money available from state incentives; this applies if the + user buys (with or without a loan) the panels. + $ref: '#/components/schemas/Money' + solarPercentage: + type: number + format: float + description: >- + Percentage (0-100) of the user's power supplied by solar. Valid for + the first year but approximately correct for future years. + HttpBody: + type: object + properties: + extensions: + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array items: - type: string - FinancialAnalysis: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + contentType: + type: string + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + data: + description: The HTTP request/response body as raw binary. + type: string + format: byte description: >- - Analysis of the cost and benefits of the optimum solar layout for a - particular electric bill size. + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + id: HttpBody + SolarPanel: type: object - id: FinancialAnalysis + description: >- + SolarPanel describes the position, orientation, and production of a + single solar panel. See the panel_height_meters, panel_width_meters, and + panel_capacity_watts fields in SolarPotential for information on the + parameters of the panel. + id: SolarPanel properties: - panelConfigIndex: + center: + description: The centre of the panel. + $ref: '#/components/schemas/LatLng' + orientation: + enumDescriptions: + - No panel orientation is known. + - >- + A `LANDSCAPE` panel has its long edge perpendicular to the azimuth + direction of the roof segment that it is placed on. + - >- + A `PORTRAIT` panel has its long edge parallel to the azimuth + direction of the roof segment that it is placed on. + type: string + enum: + - SOLAR_PANEL_ORIENTATION_UNSPECIFIED + - LANDSCAPE + - PORTRAIT + description: The orientation of the panel. + yearlyEnergyDcKwh: + description: >- + How much sunlight energy this layout captures over the course of a + year, in DC kWh. + format: float + type: number + segmentIndex: format: int32 description: >- - Index in solar_panel_configs of the optimum solar layout for this - bill size. This can be -1 indicating that there is no layout. In - this case, the remaining submessages will be omitted. + Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` + which corresponds to the roof segment that this panel is placed on. type: integer - financedPurchaseSavings: - description: >- - Cost and benefit of buying the solar panels by financing the - purchase. - $ref: '#/components/schemas/FinancedPurchaseSavings' + FinancialAnalysis: + type: object + id: FinancialAnalysis + description: >- + Analysis of the cost and benefits of the optimum solar layout for a + particular electric bill size. + properties: + financialDetails: + $ref: '#/components/schemas/FinancialDetails' + description: >- + Financial information that applies regardless of the financing + method used. monthlyBill: $ref: '#/components/schemas/Money' description: The monthly electric bill this analysis assumes. + defaultBill: + description: >- + Whether this is the bill size selected to be the default bill for + the area this building is in. Exactly one `FinancialAnalysis` in + `BuildingSolarPotential` should have `default_bill` set. + type: boolean leasingSavings: $ref: '#/components/schemas/LeasingSavings' description: Cost and benefit of leasing the solar panels. - financialDetails: - $ref: '#/components/schemas/FinancialDetails' - description: >- - Financial information that applies regardless of the financing - method used. - cashPurchaseSavings: - description: Cost and benefit of buying the solar panels with cash. - $ref: '#/components/schemas/CashPurchaseSavings' averageKwhPerMonth: - format: float type: number description: >- How much electricity the house uses in an average month, based on the bill size and the local electricity rates. - defaultBill: - type: boolean + format: float + financedPurchaseSavings: + $ref: '#/components/schemas/FinancedPurchaseSavings' description: >- - Whether this is the bill size selected to be the default bill for - the area this building is in. Exactly one `FinancialAnalysis` in - `BuildingSolarPotential` should have `default_bill` set. - SolarPotential: + Cost and benefit of buying the solar panels by financing the + purchase. + cashPurchaseSavings: + description: Cost and benefit of buying the solar panels with cash. + $ref: '#/components/schemas/CashPurchaseSavings' + panelConfigIndex: + description: >- + Index in solar_panel_configs of the optimum solar layout for this + bill size. This can be -1 indicating that there is no layout. In + this case, the remaining submessages will be omitted. + type: integer + format: int32 + LeasingSavings: + type: object description: >- - Information about the solar potential of a building. A number of fields - in this are defined in terms of "panels". The fields - panel_capacity_watts, panel_height_meters, and panel_width_meters - describe the parameters of the model of panel used in these - calculations. + Cost and benefit of leasing a particular configuration of solar panels + with a particular electricity usage. properties: - maxSunshineHoursPerYear: - description: >- - Maximum number of sunshine hours received per year, by any point on - the roof. Sunshine hours are a measure of the total amount of - insolation (energy) received per year. 1 sunshine hour = 1 kWh per - kW (where kW refers to kW of capacity under Standard Testing - Conditions). - format: float - type: number - wholeRoofStats: - $ref: '#/components/schemas/SizeAndSunshineStats' + leasesSupported: + type: boolean description: >- - Total size and sunlight quantiles for the part of the roof that was - assigned to some roof segment. Despite the name, this may not - include the entire building. See building_stats. - maxArrayPanelsCount: + Whether leases are supported in this juristiction by the financial + calculation engine. If this field is false, then the values in this + message should probably be ignored. This is independent of + `leases_allowed`: in some areas leases are allowed, but under + conditions that aren't handled by the financial models. + savings: + description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/SavingsOverTime' + leasesAllowed: + type: boolean description: >- - Size of the maximum array - that is, the maximum number of panels - that can fit on the roof. - format: int32 + Whether leases are allowed in this juristiction (leases are not + allowed in some states). If this field is false, then the values in + this message should probably be ignored. + annualLeasingCost: + $ref: '#/components/schemas/Money' + description: Estimated annual leasing cost. + id: LeasingSavings + SolarPotential: + properties: + panelLifetimeYears: type: integer - panelHeightMeters: - format: float - type: number description: >- - Height, in meters in portrait orientation, of the panel used in the - calculations. + The expected lifetime, in years, of the solar panels. This is used + in the financial calculations. + format: int32 buildingStats: + $ref: '#/components/schemas/SizeAndSunshineStats' description: >- Size and sunlight quantiles for the entire building, including parts of the roof that were not assigned to some roof segment. Because the @@ -759,81 +629,223 @@ components: can be obtained by scaling the roof area from whole_roof_stats by the ratio of the ground areas of `building_stats` and `whole_roof_stats`. + panelCapacityWatts: + description: Capacity, in watts, of the panel used in the calculations. + format: float + type: number + roofSegmentStats: + type: array + items: + $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' + description: Size and sunlight quantiles for each roof segment. + wholeRoofStats: + description: >- + Total size and sunlight quantiles for the part of the roof that was + assigned to some roof segment. Despite the name, this may not + include the entire building. See building_stats. $ref: '#/components/schemas/SizeAndSunshineStats' - solarPanels: + solarPanelConfigs: + description: >- + Each SolarPanelConfig describes a different arrangement of solar + panels on the roof. They are in order of increasing number of + panels. The `SolarPanelConfig` with panels_count=N is based on the + first N panels in the `solar_panels` list. This field is only + populated if at least 4 panels can fit on a roof. type: array items: - $ref: '#/components/schemas/SolarPanel' + $ref: '#/components/schemas/SolarPanelConfig' + solarPanels: description: >- Each SolarPanel describes a single solar panel. They are listed in the order that the panel layout algorithm placed this. This is usually, though not always, in decreasing order of annual energy production. - panelCapacityWatts: - description: Capacity, in watts, of the panel used in the calculations. + type: array + items: + $ref: '#/components/schemas/SolarPanel' + financialAnalyses: + type: array + description: >- + A FinancialAnalysis gives the savings from going solar assuming a + given monthly bill and a given electricity provider. They are in + order of increasing order of monthly bill amount. This field will be + empty for buildings in areas for which the Solar API does not have + enough information to perform financial computations. + items: + $ref: '#/components/schemas/FinancialAnalysis' + maxArrayPanelsCount: + description: >- + Size of the maximum array - that is, the maximum number of panels + that can fit on the roof. + format: int32 + type: integer + carbonOffsetFactorKgPerMwh: + type: number + description: >- + Equivalent amount of CO2 produced per MWh of grid electricity. This + is a measure of the carbon intensity of grid electricity displaced + by solar electricity. format: float + panelHeightMeters: + description: >- + Height, in meters in portrait orientation, of the panel used in the + calculations. type: number - panelWidthMeters: format: float + maxSunshineHoursPerYear: + description: >- + Maximum number of sunshine hours received per year, by any point on + the roof. Sunshine hours are a measure of the total amount of + insolation (energy) received per year. 1 sunshine hour = 1 kWh per + kW (where kW refers to kW of capacity under Standard Testing + Conditions). + format: float + type: number + panelWidthMeters: description: >- Width, in meters in portrait orientation, of the panel used in the calculations. + format: float type: number maxArrayAreaMeters2: + description: Size, in square meters, of the maximum array. + type: number format: float + type: object + id: SolarPotential + description: >- + Information about the solar potential of a building. A number of fields + in this are defined in terms of "panels". The fields + panel_capacity_watts, panel_height_meters, and panel_width_meters + describe the parameters of the model of panel used in these + calculations. + SizeAndSunshineStats: + type: object + properties: + groundAreaMeters2: type: number - description: Size, in square meters, of the maximum array. - panelLifetimeYears: - format: int32 - type: integer description: >- - The expected lifetime, in years, of the solar panels. This is used - in the financial calculations. - financialAnalyses: - type: array + The ground footprint area covered by the roof or roof segment, in + m^2. + format: float + sunshineQuantiles: description: >- - A FinancialAnalysis gives the savings from going solar assuming a - given monthly bill and a given electricity provider. They are in - order of increasing order of monthly bill amount. This field will be - empty for buildings in areas for which the Solar API does not have - enough information to perform financial computations. - items: - $ref: '#/components/schemas/FinancialAnalysis' - roofSegmentStats: - type: array + Quantiles of the pointwise sunniness across the area. If there are N + values here, this represents the (N-1)-iles. For example, if there + are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, + max). Values are in annual kWh/kW like max_sunshine_hours_per_year. items: - $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' - description: Size and sunlight quantiles for each roof segment. - solarPanelConfigs: + type: number + format: float type: array - items: - $ref: '#/components/schemas/SolarPanelConfig' + areaMeters2: + description: >- + The area of the roof or roof segment, in m^2. This is the roof area + (accounting for tilt), not the ground footprint area. + format: float + type: number + id: SizeAndSunshineStats + description: Size and sunniness quantiles of a roof, or part of a roof. + SavingsOverTime: + description: Financial information that's shared between different financing methods. + properties: + presentValueOfSavingsLifetime: + $ref: '#/components/schemas/Money' + description: >- + Using the assumed discount rate, what is the present value of the + cumulative lifetime savings? + financiallyViable: + description: >- + Indicates whether this scenario is financially viable. Will be false + for scenarios with poor financial viability (e.g., money-losing). + type: boolean + presentValueOfSavingsYear20: + $ref: '#/components/schemas/Money' + description: >- + Using the assumed discount rate, what is the present value of the + cumulative 20-year savings? + savingsYear1: + description: Savings in the first year after panel installation. + $ref: '#/components/schemas/Money' + savingsYear20: + $ref: '#/components/schemas/Money' + description: Savings in the first twenty years after panel installation. + savingsLifetime: + $ref: '#/components/schemas/Money' + description: Savings in the entire panel lifetime. + type: object + id: SavingsOverTime + LatLngBox: + properties: + ne: + $ref: '#/components/schemas/LatLng' + description: The northeast corner of the box. + sw: + $ref: '#/components/schemas/LatLng' + description: The southwest corner of the box. + description: A bounding box in lat/lng coordinates. + id: LatLngBox + type: object + RoofSegmentSummary: + type: object + id: RoofSegmentSummary + description: >- + Information about a roof segment on the building, with some number of + panels placed on it. + properties: + yearlyEnergyDcKwh: + format: float + type: number description: >- - Each SolarPanelConfig describes a different arrangement of solar - panels on the roof. They are in order of increasing number of - panels. The `SolarPanelConfig` with panels_count=N is based on the - first N panels in the `solar_panels` list. This field is only - populated if at least 4 panels can fit on a roof. - carbonOffsetFactorKgPerMwh: + How much sunlight energy this part of the layout captures over the + course of a year, in DC kWh, assuming the panels described above. + pitchDegrees: description: >- - Equivalent amount of CO2 produced per MWh of grid electricity. This - is a measure of the carbon intensity of grid electricity displaced - by solar electricity. + Angle of the roof segment relative to the theoretical ground plane. + 0 = parallel to the ground, 90 = perpendicular to the ground. format: float type: number - id: SolarPotential - type: object + azimuthDegrees: + description: >- + Compass direction the roof segment is pointing in. 0 = North, 90 = + East, 180 = South. For a "flat" roof segment (`pitch_degrees` very + near 0), azimuth is not well defined, so for consistency, we define + it arbitrarily to be 0 (North). + type: number + format: float + segmentIndex: + type: integer + format: int32 + description: >- + Index in roof_segment_stats of the corresponding + `RoofSegmentSizeAndSunshineStats`. + panelsCount: + format: int32 + type: integer + description: The total number of panels on this segment. parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string - access_token: - description: OAuth access token. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: access_token + name: quotaUser + schema: + 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. + in: query + name: key schema: type: string alt: @@ -846,40 +858,28 @@ components: - json - media - proto - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token schema: 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. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: key + name: upload_protocol schema: type: string _.xgafv: @@ -891,19 +891,37 @@ components: enum: - '1' - '2' + callback: + description: JSONP + in: query + name: callback + schema: + type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string x-stackQL-resources: + geo_tiff: + id: google.solar.geo_tiff + name: geo_tiff + title: Geo_tiff + methods: + get: + operation: + $ref: '#/paths/~1v1~1geoTiff:get/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/geo_tiff/methods/get' + insert: [] + update: [] + replace: [] + delete: [] data_layers: id: google.solar.data_layers name: data_layers @@ -939,38 +957,42 @@ components: update: [] replace: [] delete: [] - geo_tiff: - id: google.solar.geo_tiff - name: geo_tiff - title: Geo_tiff - methods: - get: - operation: - $ref: '#/paths/~1v1~1geoTiff:get/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/geo_tiff/methods/get' - insert: [] - update: [] - replace: [] - delete: [] paths: - /v1/dataLayers:get: + /v1/geoTiff:get: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' + get: + description: Returns an image by its ID. + operationId: solar.geoTiff.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: query + name: id + schema: + type: string + /v1/dataLayers:get: + parameters: *ref_1 get: description: >- Gets solar information for a region surrounding a location. Returns an @@ -991,20 +1013,12 @@ paths: $ref: '#/components/schemas/DataLayers' parameters: - in: query - name: exactQualityRequired - schema: - type: boolean - - in: query - name: radiusMeters + name: location.latitude schema: type: number - format: float - - in: query - name: experiments - schema: - type: string + format: double - in: query - name: view + name: requiredQuality schema: type: string - in: query @@ -1013,16 +1027,24 @@ paths: type: number format: double - in: query - name: requiredQuality + name: exactQualityRequired + schema: + type: boolean + - in: query + name: experiments schema: type: string - in: query - name: location.latitude + name: pixelSizeMeters schema: type: number - format: double + format: float - in: query - name: pixelSizeMeters + name: view + schema: + type: string + - in: query + name: radiusMeters schema: type: number format: float @@ -1047,43 +1069,21 @@ paths: schema: $ref: '#/components/schemas/BuildingInsights' parameters: - - in: query - name: experiments - schema: - type: string - in: query name: location.longitude schema: type: number format: double - - in: query - name: requiredQuality - schema: - type: string - in: query name: location.latitude schema: type: number format: double - /v1/geoTiff:get: - parameters: *ref_1 - get: - description: Returns an image by its ID. - operationId: solar.geoTiff.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/HttpBody' - parameters: - in: query - name: id + name: requiredQuality + schema: + type: string + - in: query + name: experiments schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml index dcd681a1..20c2b580 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml @@ -9,7 +9,7 @@ info: Use the Migrate to Virtual Machines API to programmatically migrate workloads. version: v1 - x-discovery-doc-revision: '20240912' + x-discovery-doc-revision: '20240905' x-generated-date: '2024-09-19' externalDocs: url: https://cloud.google.com/migrate/virtual-machines diff --git a/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml b/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml index 05081fae..7d846cdf 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml @@ -34,74 +34,74 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleRpcStatus: - id: GoogleRpcStatus - type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudWebriskV1SearchHashesResponseThreatHash: properties: - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - message: + hash: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + A 32 byte SHA256 hash. This field is in binary format. For JSON + requests, hashes are base64-encoded. + format: byte type: string - details: + threatTypes: items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + type: string + enum: + - THREAT_TYPE_UNSPECIFIED + - MALWARE + - SOCIAL_ENGINEERING + - UNWANTED_SOFTWARE + - SOCIAL_ENGINEERING_EXTENDED_COVERAGE + enumDescriptions: + - >- + No entries should match this threat type. This threat type is + unused. + - Malware targeting any platform. + - Social engineering targeting any platform. + - Unwanted software targeting any platform. + - >- + A list of extended coverage social engineering URIs targeting + any platform. description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + The ThreatList this threat belongs to. This must contain at least + one entry. type: array + expireTime: + format: google-datetime + description: >- + The cache lifetime for the returned match. Clients must not cache + this response past this timestamp to avoid false positives. + type: string + id: GoogleCloudWebriskV1SearchHashesResponseThreatHash + description: Contains threat information on a matching hash. + type: object GoogleProtobufEmpty: - properties: {} - id: GoogleProtobufEmpty type: object + id: GoogleProtobufEmpty 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); } - GoogleCloudWebriskV1Submission: + properties: {} + GoogleCloudWebriskV1RawHashes: type: object - id: GoogleCloudWebriskV1Submission properties: - uri: + rawHashes: description: >- - Required. The URI that is being reported for malicious content to be - analyzed. + The hashes, in binary format, concatenated into one long string. + Hashes are sorted in lexicographic order. For JSON API users, hashes + are base64-encoded. type: string - description: Wraps a URI that might be displaying malicious content. - GoogleCloudWebriskV1RawHashes: - properties: + format: byte prefixSize: description: >- The number of bytes for each prefix encoded below. This field can be anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). In practice this is almost always 4, except in exceptional circumstances. - type: integer format: int32 - rawHashes: - type: string - description: >- - The hashes, in binary format, concatenated into one long string. - Hashes are sorted in lexicographic order. For JSON API users, hashes - are base64-encoded. - format: byte + type: integer + id: GoogleCloudWebriskV1RawHashes description: >- The uncompressed threat entries in hash format. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some @@ -109,99 +109,105 @@ components: Used for sending ThreatEntryAdditons to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression. - id: GoogleCloudWebriskV1RawHashes - type: object - GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: - id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + GoogleCloudWebriskV1ThreatEntryAdditions: + description: >- + Contains the set of entries to add to a local database. May contain a + combination of compressed and raw data in a single response. + id: GoogleCloudWebriskV1ThreatEntryAdditions properties: - sha256: - type: string - format: byte + riceHashes: + $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' description: >- - The SHA256 hash of the client state; that is, of the sorted list of - all hashes present in the database. - description: The expected state of a client's local database. + The encoded 4-byte prefixes of SHA256-formatted entries, using a + Golomb-Rice encoding. The hashes are converted to uint32, sorted in + ascending order, then delta encoded and stored as encoded_data. + rawHashes: + items: + $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' + type: array + description: >- + The raw SHA256-formatted entries. Repeated to allow returning sets + of hashes with different prefix sizes. type: object - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse + GoogleCloudWebriskV1ThreatEntryRemovals: + description: Contains the set of entries to remove from a local database. type: object - description: The response message for Operations.ListOperations. properties: - nextPageToken: + riceIndices: + description: >- + The encoded local, lexicographically-sorted list indices, using a + Golomb-Rice encoding. Used for sending compressed removal indices. + The removal indices (uint32) are sorted in ascending order, then + delta encoded and stored as encoded_data. + $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' + rawIndices: + $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' + description: The raw removal indices for a local list. + id: GoogleCloudWebriskV1ThreatEntryRemovals + GoogleCloudWebriskV1Submission: + properties: + uri: type: string - description: The standard List next-page token. - operations: - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - type: array description: >- - A list of operations that matches the specified filter in the - request. - GoogleCloudWebriskV1RawIndices: + Required. The URI that is being reported for malicious content to be + analyzed. type: object + id: GoogleCloudWebriskV1Submission + description: Wraps a URI that might be displaying malicious content. + GoogleCloudWebriskV1RiceDeltaEncoding: + id: GoogleCloudWebriskV1RiceDeltaEncoding properties: - indices: - items: - type: integer - format: int32 - type: array - description: The indices to remove from a lexicographically-sorted local list. - id: GoogleCloudWebriskV1RawIndices - description: A set of raw indices to remove from a local list. - GoogleLongrunningOperation: - id: GoogleLongrunningOperation + encodedData: + format: byte + type: string + description: The encoded deltas that are encoded using the Golomb-Rice coder. + firstValue: + format: int64 + type: string + description: >- + The offset of the first entry in the encoded data, or, if only a + single integer was encoded, that single integer's value. If the + field is empty or missing, assume zero. + riceParameter: + format: int32 + type: integer + description: >- + The Golomb-Rice parameter, which is a number between 2 and 28. This + field is missing (that is, zero) if `num_entries` is zero. + entryCount: + format: int32 + description: >- + The number of entries that are delta encoded in the encoded data. If + only a single integer was encoded, this will be zero and the single + value will be stored in `first_value`. + type: integer type: object description: >- - This resource represents a long-running operation that is the result of - a network API call. + The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes + or compressed removal indices. + GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: properties: - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - done: + sha256: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - name: - description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. + The SHA256 hash of the client state; that is, of the sorted list of + all hashes present in the database. type: string - metadata: - description: Contains a `SubmitUriMetadata` object. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - GoogleCloudWebriskV1SearchUrisResponseThreatUri: + format: byte + description: The expected state of a client's local database. type: object + id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + GoogleCloudWebriskV1SearchUrisResponseThreatUri: + id: GoogleCloudWebriskV1SearchUrisResponseThreatUri properties: + expireTime: + description: >- + The cache lifetime for the returned match. Clients must not cache + this response past this timestamp to avoid false positives. + format: google-datetime + type: string threatTypes: type: array items: - enum: - - THREAT_TYPE_UNSPECIFIED - - MALWARE - - SOCIAL_ENGINEERING - - UNWANTED_SOFTWARE - - SOCIAL_ENGINEERING_EXTENDED_COVERAGE - type: string enumDescriptions: - >- No entries should match this threat type. This threat type is @@ -212,114 +218,132 @@ components: - >- A list of extended coverage social engineering URIs targeting any platform. + enum: + - THREAT_TYPE_UNSPECIFIED + - MALWARE + - SOCIAL_ENGINEERING + - UNWANTED_SOFTWARE + - SOCIAL_ENGINEERING_EXTENDED_COVERAGE + type: string description: The ThreatList this threat belongs to. - expireTime: - type: string - description: >- - The cache lifetime for the returned match. Clients must not cache - this response past this timestamp to avoid false positives. - format: google-datetime - id: GoogleCloudWebriskV1SearchUrisResponseThreatUri + type: object description: Contains threat information on a matching uri. - GoogleCloudWebriskV1ComputeThreatListDiffResponse: + GoogleLongrunningCancelOperationRequest: + description: The request message for Operations.CancelOperation. + type: object + id: GoogleLongrunningCancelOperationRequest + properties: {} + GoogleRpcStatus: properties: - responseType: - enum: - - RESPONSE_TYPE_UNSPECIFIED - - DIFF - - RESET - enumDescriptions: - - Unknown. - - >- - Partial updates are applied to the client's existing local - database. - - >- - Full updates resets the client's entire local database. This means - that either the client had no state, was seriously out-of-date, or - the client is believed to be corrupt. - description: >- - The type of response. This may indicate that an action must be taken - by the client when the response is received. + message: type: string - recommendedNextDiff: description: >- - The soonest the client should wait before issuing any diff request. - Querying sooner is unlikely to produce a meaningful diff. Waiting - longer is acceptable considering the use case. If this field is not - set clients may update as soon as they want. - type: string - format: google-datetime - checksum: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array description: >- - The expected SHA256 hash of the client state; that is, of the sorted - list of all hashes present in the database after applying the - provided diff. If the client state doesn't match the expected state, - the client must discard this diff and retry later. - removals: - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + id: GoogleRpcStatus + type: object + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudWebriskV1RawIndices: + type: object + id: GoogleCloudWebriskV1RawIndices + description: A set of raw indices to remove from a local list. + properties: + indices: + type: array + description: The indices to remove from a lexicographically-sorted local list. + items: + type: integer + format: int32 + GoogleCloudWebriskV1SearchUrisResponse: + type: object + id: GoogleCloudWebriskV1SearchUrisResponse + properties: + threat: + $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponseThreatUri' description: >- - A set of entries to remove from a local threat type's list. This - field may be empty. - newVersionToken: - type: string - format: byte + The threat list matches. This might be empty if the URI is on no + list. + GoogleLongrunningListOperationsResponse: + properties: + operations: + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - The new opaque client version token. This should be retained by the - client and passed into the next call of ComputeThreatListDiff as - 'version_token'. A separate version token should be stored and used - for each threatList. - additions: - description: A set of entries to add to a local threat type's list. - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' - id: GoogleCloudWebriskV1ComputeThreatListDiffResponse + A list of operations that matches the specified filter in the + request. + type: array + nextPageToken: + description: The standard List next-page token. + type: string + description: The response message for Operations.ListOperations. type: object - GoogleCloudWebriskV1ThreatEntryAdditions: - description: >- - Contains the set of entries to add to a local database. May contain a - combination of compressed and raw data in a single response. + id: GoogleLongrunningListOperationsResponse + GoogleLongrunningOperation: type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation properties: - riceHashes: - $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' + name: + type: string + description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. + response: description: >- - The encoded 4-byte prefixes of SHA256-formatted entries, using a - Golomb-Rice encoding. The hashes are converted to uint32, sorted in - ascending order, then delta encoded and stored as encoded_data. - rawHashes: - type: array + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: description: >- - The raw SHA256-formatted entries. Repeated to allow returning sets - of hashes with different prefix sizes. - items: - $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' - id: GoogleCloudWebriskV1ThreatEntryAdditions - GoogleCloudWebriskV1ThreatEntryRemovals: - id: GoogleCloudWebriskV1ThreatEntryRemovals - description: Contains the set of entries to remove from a local database. - type: object - properties: - rawIndices: - $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' - description: The raw removal indices for a local list. - riceIndices: - $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + metadata: + description: Contains a `SubmitUriMetadata` object. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + error: description: >- - The encoded local, lexicographically-sorted list indices, using a - Golomb-Rice encoding. Used for sending compressed removal indices. - The removal indices (uint32) are sorted in ascending order, then - delta encoded and stored as encoded_data. + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' GoogleCloudWebriskV1SearchHashesResponse: - type: object id: GoogleCloudWebriskV1SearchHashesResponse properties: - negativeExpireTime: - description: >- - For requested entities that did not match the threat list, how long - to cache the response until. - type: string - format: google-datetime threats: description: >- The full hashes that matched the requested prefixes. The hash will @@ -328,96 +352,85 @@ components: items: $ref: >- #/components/schemas/GoogleCloudWebriskV1SearchHashesResponseThreatHash - GoogleCloudWebriskV1SearchUrisResponse: - type: object - properties: - threat: + negativeExpireTime: description: >- - The threat list matches. This might be empty if the URI is on no - list. - $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponseThreatUri' - id: GoogleCloudWebriskV1SearchUrisResponse - GoogleCloudWebriskV1SearchHashesResponseThreatHash: + For requested entities that did not match the threat list, how long + to cache the response until. + format: google-datetime + type: string type: object - id: GoogleCloudWebriskV1SearchHashesResponseThreatHash + GoogleCloudWebriskV1ComputeThreatListDiffResponse: + type: object + id: GoogleCloudWebriskV1ComputeThreatListDiffResponse properties: - threatTypes: - type: array - items: - type: string - enumDescriptions: - - >- - No entries should match this threat type. This threat type is - unused. - - Malware targeting any platform. - - Social engineering targeting any platform. - - Unwanted software targeting any platform. - - >- - A list of extended coverage social engineering URIs targeting - any platform. - enum: - - THREAT_TYPE_UNSPECIFIED - - MALWARE - - SOCIAL_ENGINEERING - - UNWANTED_SOFTWARE - - SOCIAL_ENGINEERING_EXTENDED_COVERAGE + removals: + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' description: >- - The ThreatList this threat belongs to. This must contain at least - one entry. - hash: + A set of entries to remove from a local threat type's list. This + field may be empty. + additions: + description: A set of entries to add to a local threat type's list. + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' + newVersionToken: format: byte description: >- - A 32 byte SHA256 hash. This field is in binary format. For JSON - requests, hashes are base64-encoded. + The new opaque client version token. This should be retained by the + client and passed into the next call of ComputeThreatListDiff as + 'version_token'. A separate version token should be stored and used + for each threatList. type: string - expireTime: - format: google-datetime + checksum: description: >- - The cache lifetime for the returned match. Clients must not cache - this response past this timestamp to avoid false positives. + The expected SHA256 hash of the client state; that is, of the sorted + list of all hashes present in the database after applying the + provided diff. If the client state doesn't match the expected state, + the client must discard this diff and retry later. + $ref: >- + #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + recommendedNextDiff: + format: google-datetime type: string - description: Contains threat information on a matching hash. - GoogleCloudWebriskV1RiceDeltaEncoding: - type: object - id: GoogleCloudWebriskV1RiceDeltaEncoding - description: >- - The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes - or compressed removal indices. - properties: - riceParameter: - description: >- - The Golomb-Rice parameter, which is a number between 2 and 28. This - field is missing (that is, zero) if `num_entries` is zero. - type: integer - format: int32 - firstValue: - format: int64 description: >- - The offset of the first entry in the encoded data, or, if only a - single integer was encoded, that single integer's value. If the - field is empty or missing, assume zero. - type: string - entryCount: + The soonest the client should wait before issuing any diff request. + Querying sooner is unlikely to produce a meaningful diff. Waiting + longer is acceptable considering the use case. If this field is not + set clients may update as soon as they want. + responseType: + enumDescriptions: + - Unknown. + - >- + Partial updates are applied to the client's existing local + database. + - >- + Full updates resets the client's entire local database. This means + that either the client had no state, was seriously out-of-date, or + the client is believed to be corrupt. + enum: + - RESPONSE_TYPE_UNSPECIFIED + - DIFF + - RESET description: >- - The number of entries that are delta encoded in the encoded data. If - only a single integer was encoded, this will be zero and the single - value will be stored in `first_value`. - type: integer - format: int32 - encodedData: - description: The encoded deltas that are encoded using the Golomb-Rice coder. + The type of response. This may indicate that an action must be taken + by the client when the response is received. type: string - format: byte - GoogleLongrunningCancelOperationRequest: - type: object - id: GoogleLongrunningCancelOperationRequest - properties: {} - description: The request message for Operations.CancelOperation. parameters: - oauth_token: - description: OAuth 2.0 token for the current user. + alt: + description: Data format for response. in: query - name: oauth_token + name: alt + schema: + type: string + enum: + - json + - media + - proto + 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. + in: query + name: key schema: type: string _.xgafv: @@ -429,16 +442,13 @@ components: enum: - '1' - '2' - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: uploadType + name: quotaUser schema: type: string upload_protocol: @@ -447,52 +457,42 @@ components: name: upload_protocol schema: 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. - in: query - name: key - schema: - type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + callback: + description: JSONP in: query - name: fields + name: callback schema: type: string - alt: - description: Data format for response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: alt + name: oauth_token + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string - enum: - - json - - media - - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: quotaUser + name: fields schema: type: string - callback: - description: JSONP + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: callback + name: prettyPrint schema: - type: string + type: boolean x-stackQL-resources: uris: id: google.webrisk.uris @@ -511,6 +511,23 @@ components: update: [] replace: [] delete: [] + hashes: + id: google.webrisk.hashes + name: hashes + title: Hashes + methods: + search: + operation: + $ref: '#/paths/~1v1~1hashes:search/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] submissions: id: google.webrisk.submissions name: submissions @@ -534,13 +551,13 @@ components: name: operations title: Operations methods: - list: + get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations delete: operation: $ref: >- @@ -548,20 +565,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}:cancel/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -588,37 +605,20 @@ components: update: [] replace: [] delete: [] - hashes: - id: google.webrisk.hashes - name: hashes - title: Hashes - methods: - search: - operation: - $ref: '#/paths/~1v1~1hashes:search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] paths: /v1/uris:search: parameters: &ref_1 - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/prettyPrint' get: description: >- This method is used to check whether a URI is on a given threatList. @@ -648,6 +648,38 @@ paths: name: uri schema: type: string + /v1/hashes:search: + parameters: *ref_1 + get: + description: >- + Gets the full hashes that match the requested hash prefix. This is used + after a hash prefix is looked up in a threatList and there is a match. + The client side threatList only holds partial hashes so the client must + query this method to determine if there is a full hash match of a + threat. + operationId: webrisk.hashes.search + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudWebriskV1SearchHashesResponse' + parameters: + - in: query + name: threatTypes + schema: + type: string + - in: query + name: hashPrefix + schema: + type: string + format: byte /v1/projects/{projectsId}/submissions: parameters: *ref_1 post: @@ -684,42 +716,37 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/operations: + /v1/projects/{projectsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: webrisk.projects.operations.list - security: [] + 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. + operationId: webrisk.projects.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client @@ -746,35 +773,6 @@ paths: required: true schema: 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. - operationId: webrisk.projects.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string /v1/projects/{projectsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: @@ -813,64 +811,51 @@ paths: required: true schema: type: string - /v1/threatLists:computeDiff: + /v1/projects/{projectsId}/operations: parameters: *ref_1 get: description: >- - Gets the most recent threat list diffs. These diffs should be applied to - a local database of hashes to keep it up-to-date. If the local database - is empty or excessively out-of-date, a complete snapshot of the database - will be returned. This Method only updates a single ThreatList at a - time. To update multiple ThreatList databases, this method needs to be - called once for each list. - operationId: webrisk.threatLists.computeDiff - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: webrisk.projects.operations.list + security: [] responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - - in: query - name: constraints.supportedCompressions - schema: - type: string - - in: query - name: threatType + - in: path + name: projectsId + required: true schema: type: string - in: query - name: constraints.maxDatabaseEntries + name: pageSize schema: type: integer format: int32 - in: query - name: constraints.maxDiffEntries + name: pageToken schema: - type: integer - format: int32 + type: string - in: query - name: versionToken + name: filter schema: type: string - format: byte - /v1/hashes:search: + /v1/threatLists:computeDiff: parameters: *ref_1 get: description: >- - Gets the full hashes that match the requested hash prefix. This is used - after a hash prefix is looked up in a threatList and there is a match. - The client side threatList only holds partial hashes so the client must - query this method to determine if there is a full hash match of a - threat. - operationId: webrisk.hashes.search + Gets the most recent threat list diffs. These diffs should be applied to + a local database of hashes to keep it up-to-date. If the local database + is empty or excessively out-of-date, a complete snapshot of the database + will be returned. This Method only updates a single ThreatList at a + time. To update multiple ThreatList databases, this method needs to be + called once for each list. + operationId: webrisk.threatLists.computeDiff security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -882,14 +867,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudWebriskV1SearchHashesResponse' + $ref: >- + #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse parameters: - in: query - name: hashPrefix + name: versionToken schema: type: string format: byte - in: query - name: threatTypes + name: constraints.supportedCompressions + schema: + type: string + - in: query + name: constraints.maxDatabaseEntries + schema: + type: integer + format: int32 + - in: query + name: threatType schema: type: string + - in: query + name: constraints.maxDiffEntries + schema: + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml index 61c66760..15422fef 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml @@ -35,284 +35,146 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Form: - id: Form - description: '! Information about a vulnerability with an HTML.' - type: object + IapTestServiceAccountInfo: + id: IapTestServiceAccountInfo + description: >- + Describes authentication configuration when Web-Security-Scanner service + account is added in Identity-Aware-Proxy (IAP) access policies. properties: - actionUri: + targetAudienceClientId: + description: >- + Required. Describes OAuth2 client id of resources protected by + Identity-Aware-Proxy (IAP). type: string - description: '! The URI where to send the form when it''s submitted.' - fields: - description: '! The names of form fields related to the vulnerability.' + type: object + VulnerableHeaders: + id: VulnerableHeaders + description: Information about vulnerable or missing HTTP Headers. + type: object + properties: + headers: + description: List of vulnerable headers. type: array items: - type: string + $ref: '#/components/schemas/Header' + missingHeaders: + description: List of missing headers. + items: + $ref: '#/components/schemas/Header' + type: array Xxe: - description: Information reported for an XXE. id: Xxe properties: - payloadValue: - type: string - description: >- - The XML string that triggered the XXE vulnerability. Non-payload - values might be redacted. payloadLocation: type: string + description: Location within the request where the payload was placed. enum: - LOCATION_UNSPECIFIED - COMPLETE_REQUEST_BODY - description: Location within the request where the payload was placed. enumDescriptions: - Unknown Location. - The XML payload replaced the complete request body. - type: object - ScanConfig: - properties: - ignoreHttpStatusErrors: - type: boolean - description: >- - Whether to keep scanning even if most requests return HTTP error - codes. - schedule: - $ref: '#/components/schemas/Schedule' - description: The schedule of the ScanConfig. - authentication: - $ref: '#/components/schemas/Authentication' - description: >- - The authentication configuration. If specified, service will use the - authentication configuration during scanning. - exportToSecurityCommandCenter: - enumDescriptions: - - Use default, which is ENABLED. - - Export results of this scan to Security Command Center. - - Do not export results of this scan to Security Command Center. - type: string - description: >- - Controls export of scan configurations and results to Security - Command Center. - enum: - - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED - - ENABLED - - DISABLED - userAgent: - description: The user agent used during scanning. - enumDescriptions: - - The user agent is unknown. Service will default to CHROME_LINUX. - - Chrome on Linux. This is the service default if unspecified. - - Chrome on Android. - - Safari on IPhone. + payloadValue: type: string - enum: - - USER_AGENT_UNSPECIFIED - - CHROME_LINUX - - CHROME_ANDROID - - SAFARI_IPHONE - blacklistPatterns: - type: array - description: >- - The excluded URL patterns as described in - https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls - items: - type: string - maxQps: - description: >- - The maximum QPS during scanning. A valid value ranges from 5 to 20 - inclusively. If the field is unspecified or its value is set 0, - server will default to 15. Other values outside of [5, 20] range - will be rejected with INVALID_ARGUMENT error. - type: integer - format: int32 - name: description: >- - The resource name of the ScanConfig. The name follows the format of - 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig - IDs are generated by the system. + The XML string that triggered the XXE vulnerability. Non-payload + values might be redacted. + description: Information reported for an XXE. + type: object + CrawledUrl: + id: CrawledUrl + properties: + url: + description: Output only. The URL that was crawled. type: string - displayName: + httpMethod: type: string - description: Required. The user provided display name of the ScanConfig. - managedScan: - type: boolean - description: >- - Whether the scan config is managed by Web Security Scanner, output - only. - staticIpScan: description: >- - Whether the scan configuration has enabled static IP address scan - feature. If enabled, the scanner will access applications from - static IP addresses. - type: boolean - startingUrls: - type: array - items: - type: string - description: Required. The starting URLs from which the scanner finds site pages. - riskLevel: - enum: - - RISK_LEVEL_UNSPECIFIED - - NORMAL - - LOW - enumDescriptions: - - Use default, which is NORMAL. - - Normal scanning (Recommended) - - Lower impact scanning - description: The risk level selected for the scan + Output only. The http method of the request that was used to visit + the URL, in uppercase. + body: type: string - description: A ScanConfig resource contains the configurations to launch a scan. + description: Output only. The body of the request that was used to visit the URL. + description: >- + A CrawledUrl resource represents a URL that was crawled during a + ScanRun. Web Security Scanner Service crawls the web applications, + following all links within the scope of sites, to find the URLs to test + against. type: object - id: ScanConfig - IapCredential: - description: Describes authentication configuration for Identity-Aware-Proxy (IAP). + StartScanRunRequest: type: object + id: StartScanRunRequest + properties: {} + description: Request for the `StartScanRun` method. + Schedule: + id: Schedule properties: - iapTestServiceAccountInfo: + scheduleTime: description: >- - Authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. - $ref: '#/components/schemas/IapTestServiceAccountInfo' - id: IapCredential - Finding: + A timestamp indicates when the next run will be scheduled. The value + is refreshed by the server after each run. If unspecified, it will + default to current server time, which means the scan will be + scheduled to start immediately. + format: google-datetime + type: string + intervalDurationDays: + description: Required. The duration of time between executions in days. + type: integer + format: int32 + description: Scan schedule configuration. type: object - id: Finding - description: >- - A Finding resource represents a vulnerability instance identified during - a ScanRun. + Header: + id: Header + description: Describes a HTTP Header. properties: - findingType: + name: type: string - description: >- - Output only. The type of the Finding. Detailed and up-to-date - information on findings can be found here: - https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings - description: - description: Output only. The description of the vulnerability. + description: Header name. + value: type: string - name: + description: Header value. + type: object + CustomAccount: + description: Describes authentication configuration that uses a custom account. + properties: + username: type: string + description: Required. The user name of the custom account. + password: description: >- - Output only. The resource name of the Finding. The name follows the - format of - 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. - The finding IDs are generated by the system. - frameUrl: - description: >- - Output only. If the vulnerability was originated from nested IFrame, - the immediate parent IFrame is reported. + Required. Input only. The password of the custom account. The + credential is stored encrypted and not returned in any response nor + included in audit logs. type: string - body: + loginUrl: type: string - description: >- - Output only. The body of the request that triggered the - vulnerability. - fuzzedUrl: + description: Required. The login form URL of the website. + id: CustomAccount + type: object + FindingTypeStats: + type: object + id: FindingTypeStats + properties: + findingCount: + description: Output only. The count of findings belonging to this finding type. + type: integer + format: int32 + findingType: + description: Output only. The finding type associated with the stats. type: string - description: >- - Output only. The URL produced by the server-side fuzzer and used in - the request that triggered the vulnerability. - vulnerableParameters: - $ref: '#/components/schemas/VulnerableParameters' - description: >- - Output only. An addon containing information about request - parameters which were found to be vulnerable. - violatingResource: - description: >- - Output only. An addon containing detailed information regarding any - resource causing the vulnerability such as JavaScript sources, - image, audio files, etc. - $ref: '#/components/schemas/ViolatingResource' - xss: - description: >- - Output only. An addon containing information reported for an XSS, if - any. - $ref: '#/components/schemas/Xss' - form: - $ref: '#/components/schemas/Form' - description: >- - Output only. An addon containing information reported for a - vulnerability with an HTML form, if any. - xxe: - readOnly: true - $ref: '#/components/schemas/Xxe' - description: >- - Output only. An addon containing information reported for an XXE, if - any. - vulnerableHeaders: - $ref: '#/components/schemas/VulnerableHeaders' - description: >- - Output only. An addon containing information about vulnerable or - missing HTTP headers. - finalUrl: - description: >- - Output only. The URL where the browser lands when the vulnerability - is detected. - type: string - outdatedLibrary: - $ref: '#/components/schemas/OutdatedLibrary' - description: >- - Output only. An addon containing information about outdated - libraries. - trackingId: - type: string - description: >- - Output only. The tracking ID uniquely identifies a vulnerability - instance across multiple ScanRuns. - httpMethod: - description: >- - Output only. The http method of the request that triggered the - vulnerability, in uppercase. - type: string - reproductionUrl: - description: >- - Output only. The URL containing human-readable payload that user can - leverage to reproduce the vulnerability. - type: string - severity: - enumDescriptions: - - No severity specified. The default value. - - Critical severity. - - High severity. - - Medium severity. - - Low severity. - enum: - - SEVERITY_UNSPECIFIED - - CRITICAL - - HIGH - - MEDIUM - - LOW - description: Output only. The severity level of the reported vulnerability. - readOnly: true - type: string - StopScanRunRequest: - description: Request for the `StopScanRun` method. - id: StopScanRunRequest - type: object - properties: {} - Authentication: - type: object - id: Authentication - description: Scan authentication configuration. - properties: - customAccount: - description: Authentication using a custom account. - $ref: '#/components/schemas/CustomAccount' - googleAccount: - description: Authentication using a Google account. - $ref: '#/components/schemas/GoogleAccount' - deprecated: true - iapCredential: - $ref: '#/components/schemas/IapCredential' - description: Authentication using Identity-Aware-Proxy (IAP). + description: >- + A FindingTypeStats resource represents stats regarding a specific + FindingType of Findings under a given ScanRun. ScanConfigError: + id: ScanConfigError + description: >- + Defines a custom error message used by CreateScanConfig and + UpdateScanConfig APIs when scan configuration validation fails. It is + also reported as part of a ScanRunErrorTrace message if scan validation + fails due to a scan configuration error. properties: - fieldName: - type: string - description: >- - Output only. Indicates the full name of the ScanConfig field that - triggers this error, for example "scan_config.max_qps". This field - is provided for troubleshooting purposes only and its actual value - can change in the future. code: + type: string enumDescriptions: - There is no error. - There is no error. @@ -395,7 +257,6 @@ components: supported. - CAI is not able to list assets. description: Output only. Indicates the reason code for a configuration failure. - type: string enum: - CODE_UNSPECIFIED - OK @@ -440,26 +301,18 @@ components: - UNSUPPORTED_FINDING_TYPE - UNSUPPORTED_URL_SCHEME - CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND - description: >- - Defines a custom error message used by CreateScanConfig and - UpdateScanConfig APIs when scan configuration validation fails. It is - also reported as part of a ScanRunErrorTrace message if scan validation - fails due to a scan configuration error. - type: object - id: ScanConfigError - StartScanRunRequest: - description: Request for the `StartScanRun` method. - id: StartScanRunRequest + fieldName: + type: string + description: >- + Output only. Indicates the full name of the ScanConfig field that + triggers this error, for example "scan_config.max_qps". This field + is provided for troubleshooting purposes only and its actual value + can change in the future. type: object - properties: {} Xss: + id: Xss properties: - errorMessage: - description: An error message generated by a javascript breakage. - type: string attackVector: - description: The attack vector of the payload triggering this XSS. - type: string enum: - ATTACK_VECTOR_UNSPECIFIED - LOCAL_STORAGE @@ -498,20 +351,104 @@ components: - >- The attack payload is received from a third-party host via a URL that is user-controllable + description: The attack vector of the payload triggering this XSS. + type: string + errorMessage: + description: An error message generated by a javascript breakage. + type: string + storedXssSeedingUrl: + type: string + description: The reproduction url for the seeding POST request of a Stored XSS. stackTraces: description: Stack traces leading to the point where the XSS occurred. type: array items: type: string - storedXssSeedingUrl: - type: string - description: The reproduction url for the seeding POST request of a Stored XSS. - id: Xss description: Information reported for an XSS. type: object + ScanRunErrorTrace: + id: ScanRunErrorTrace + type: object + description: Output only. Defines an error trace message for a ScanRun. + properties: + scanConfigError: + $ref: '#/components/schemas/ScanConfigError' + description: >- + Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this + field has the error message encountered during scan configuration + validation that is performed before each scan run. + mostCommonHttpErrorCode: + type: integer + description: >- + Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field + indicates the most common HTTP error code, if such is available. For + example, if this code is 404, the scan has encountered too many + NOT_FOUND responses. + format: int32 + code: + type: string + enum: + - CODE_UNSPECIFIED + - INTERNAL_ERROR + - SCAN_CONFIG_ISSUE + - AUTHENTICATION_CONFIG_ISSUE + - TIMED_OUT_WHILE_SCANNING + - TOO_MANY_REDIRECTS + - TOO_MANY_HTTP_ERRORS + - STARTING_URLS_CRAWL_HTTP_ERRORS + enumDescriptions: + - Default value is never used. + - >- + Indicates that the scan run failed due to an internal server + error. + - >- + Indicates a scan configuration error, usually due to outdated + ScanConfig settings, such as starting_urls or the DNS + configuration. + - >- + Indicates an authentication error, usually due to outdated + ScanConfig authentication settings. + - >- + Indicates a scan operation timeout, usually caused by a very large + site. + - >- + Indicates that a scan encountered excessive redirects, either to + authentication or some other page outside of the scan scope. + - >- + Indicates that a scan encountered numerous errors from the web + site pages. When available, most_common_http_error_code field + indicates the most common HTTP error code encountered during the + scan. + - >- + Indicates that some of the starting web urls returned HTTP errors + during the scan. + description: Output only. Indicates the error reason code. + ListFindingsResponse: + type: object + id: ListFindingsResponse + description: Response for the `ListFindings` method. + properties: + findings: + type: array + description: The list of Findings returned. + items: + $ref: '#/components/schemas/Finding' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string ScanRunWarningTrace: + type: object + id: ScanRunWarningTrace + description: >- + Output only. Defines a warning trace message for ScanRun. Warning traces + provide customers with useful information that helps make the scanning + process more effective. properties: code: + description: Output only. Indicates the warning code. + type: string enumDescriptions: - Default value is never used. - >- @@ -535,221 +472,37 @@ components: - TOO_MANY_FUZZ_TASKS - BLOCKED_BY_IAP - NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN - description: Output only. Indicates the warning code. - type: string + Authentication: + properties: + googleAccount: + description: Authentication using a Google account. + deprecated: true + $ref: '#/components/schemas/GoogleAccount' + iapCredential: + $ref: '#/components/schemas/IapCredential' + description: Authentication using Identity-Aware-Proxy (IAP). + customAccount: + description: Authentication using a custom account. + $ref: '#/components/schemas/CustomAccount' type: object - id: ScanRunWarningTrace - description: >- - Output only. Defines a warning trace message for ScanRun. Warning traces - provide customers with useful information that helps make the scanning - process more effective. - ListScanConfigsResponse: + id: Authentication + description: Scan authentication configuration. + GoogleAccount: + deprecated: true type: object - description: Response for the `ListScanConfigs` method. + description: Describes authentication configuration that uses a Google account. properties: - nextPageToken: + username: + description: Required. The user name of the Google account. type: string - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - scanConfigs: - type: array - description: The list of ScanConfigs returned. - items: - $ref: '#/components/schemas/ScanConfig' - id: ListScanConfigsResponse - CustomAccount: - type: object - id: CustomAccount - properties: password: + type: string description: >- - Required. Input only. The password of the custom account. The + Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. - type: string - username: - description: Required. The user name of the custom account. - type: string - loginUrl: - description: Required. The login form URL of the website. - type: string - description: Describes authentication configuration that uses a custom account. - Empty: - type: object - properties: {} - id: 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); } - ListFindingsResponse: - id: ListFindingsResponse - type: object - properties: - findings: - items: - $ref: '#/components/schemas/Finding' - description: The list of Findings returned. - type: array - nextPageToken: - type: string - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - description: Response for the `ListFindings` method. - CrawledUrl: - id: CrawledUrl - properties: - body: - type: string - description: Output only. The body of the request that was used to visit the URL. - httpMethod: - type: string - description: >- - Output only. The http method of the request that was used to visit - the URL, in uppercase. - url: - description: Output only. The URL that was crawled. - type: string - description: >- - A CrawledUrl resource represents a URL that was crawled during a - ScanRun. Web Security Scanner Service crawls the web applications, - following all links within the scope of sites, to find the URLs to test - against. - type: object - GoogleAccount: - deprecated: true id: GoogleAccount - description: Describes authentication configuration that uses a Google account. - properties: - password: - type: string - description: >- - Required. Input only. The password of the Google account. The - credential is stored encrypted and not returned in any response nor - included in audit logs. - username: - type: string - description: Required. The user name of the Google account. - type: object - VulnerableHeaders: - description: Information about vulnerable or missing HTTP Headers. - properties: - headers: - items: - $ref: '#/components/schemas/Header' - type: array - description: List of vulnerable headers. - missingHeaders: - type: array - description: List of missing headers. - items: - $ref: '#/components/schemas/Header' - id: VulnerableHeaders - type: object - ViolatingResource: - type: object - description: >- - Information regarding any resource causing the vulnerability such as - JavaScript sources, image, audio files, etc. - properties: - resourceUrl: - description: URL of this violating resource. - type: string - contentType: - type: string - description: The MIME type of this resource. - id: ViolatingResource - ListScanRunsResponse: - id: ListScanRunsResponse - properties: - scanRuns: - type: array - items: - $ref: '#/components/schemas/ScanRun' - description: The list of ScanRuns returned. - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - type: object - description: Response for the `ListScanRuns` method. - OutdatedLibrary: - type: object - properties: - learnMoreUrls: - description: >- - URLs to learn more information about the vulnerabilities in the - library. - type: array - items: - type: string - version: - type: string - description: The version number. - libraryName: - description: The name of the outdated library. - type: string - id: OutdatedLibrary - description: Information reported for an outdated library. - Schedule: - type: object - id: Schedule - properties: - intervalDurationDays: - description: Required. The duration of time between executions in days. - format: int32 - type: integer - scheduleTime: - description: >- - A timestamp indicates when the next run will be scheduled. The value - is refreshed by the server after each run. If unspecified, it will - default to current server time, which means the scan will be - scheduled to start immediately. - format: google-datetime - type: string - description: Scan schedule configuration. - ListFindingTypeStatsResponse: - type: object - properties: - findingTypeStats: - items: - $ref: '#/components/schemas/FindingTypeStats' - type: array - description: The list of FindingTypeStats returned. - description: Response for the `ListFindingTypeStats` method. - id: ListFindingTypeStatsResponse - Header: - type: object - description: Describes a HTTP Header. - id: Header - properties: - name: - description: Header name. - type: string - value: - description: Header value. - type: string - FindingTypeStats: - type: object - properties: - findingCount: - format: int32 - description: Output only. The count of findings belonging to this finding type. - type: integer - findingType: - type: string - description: Output only. The finding type associated with the stats. - description: >- - A FindingTypeStats resource represents stats regarding a specific - FindingType of Findings under a given ScanRun. - id: FindingTypeStats ScanRun: - id: ScanRun - type: object properties: endTime: description: >- @@ -757,36 +510,7 @@ components: - that the ScanRun is either finished or stopped by user. type: string format: google-datetime - hasVulnerabilities: - description: Output only. Whether the scan run has found any vulnerabilities. - type: boolean - warningTraces: - description: >- - Output only. A list of warnings, if such are encountered during this - scan run. - items: - $ref: '#/components/schemas/ScanRunWarningTrace' - type: array - progressPercent: - description: >- - Output only. The percentage of total completion ranging from 0 to - 100. If the scan is in queue, the value is 0. If the scan is - running, the value ranges from 0 to 100. If the scan is finished, - the value is 100. - format: int32 - type: integer - urlsTestedCount: - format: int64 - description: >- - Output only. The number of URLs tested during this ScanRun. If the - scan is in progress, the value represents the number of URLs tested - up to now. The number of URLs tested is usually larger than the - number URLS crawled because typically a crawled URL is tested with - multiple test payloads. - type: string executionState: - description: Output only. The execution state of the ScanRun. - type: string enumDescriptions: - >- Represents an invalid state caused by internal server error. This @@ -799,16 +523,18 @@ components: - QUEUED - SCANNING - FINISHED + description: Output only. The execution state of the ScanRun. + type: string resultState: type: string - description: >- - Output only. The result state of the ScanRun. This field is only - available after the execution state reaches "FINISHED". enum: - RESULT_STATE_UNSPECIFIED - SUCCESS - ERROR - KILLED + description: >- + Output only. The result state of the ScanRun. This field is only + available after the execution state reaches "FINISHED". enumDescriptions: - >- Default value. This value is returned when the ScanRun is not yet @@ -816,17 +542,13 @@ components: - The scan finished without errors. - The scan finished with errors. - The scan was terminated by user. - urlsCrawledCount: - type: string - format: int64 + warningTraces: description: >- - Output only. The number of URLs crawled during this ScanRun. If the - scan is in progress, the value represents the number of URLs crawled - up to now. - startTime: - description: Output only. The time at which the ScanRun started. - format: google-datetime - type: string + Output only. A list of warnings, if such are encountered during this + scan run. + items: + $ref: '#/components/schemas/ScanRunWarningTrace' + type: array name: description: >- Output only. The resource name of the ScanRun. The name follows the @@ -834,126 +556,392 @@ components: 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. type: string + urlsTestedCount: + type: string + description: >- + Output only. The number of URLs tested during this ScanRun. If the + scan is in progress, the value represents the number of URLs tested + up to now. The number of URLs tested is usually larger than the + number URLS crawled because typically a crawled URL is tested with + multiple test payloads. + format: int64 + startTime: + type: string + format: google-datetime + description: Output only. The time at which the ScanRun started. errorTrace: description: >- Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. $ref: '#/components/schemas/ScanRunErrorTrace' - description: >- - A ScanRun is a output-only resource representing an actual run of the - scan. Next id: 12 - IapTestServiceAccountInfo: - id: IapTestServiceAccountInfo - properties: - targetAudienceClientId: - type: string + progressPercent: + type: integer + format: int32 description: >- - Required. Describes OAuth2 client id of resources protected by - Identity-Aware-Proxy (IAP). - type: object - description: >- - Describes authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. + Output only. The percentage of total completion ranging from 0 to + 100. If the scan is in queue, the value is 0. If the scan is + running, the value ranges from 0 to 100. If the scan is finished, + the value is 100. + hasVulnerabilities: + description: Output only. Whether the scan run has found any vulnerabilities. + type: boolean + urlsCrawledCount: + description: >- + Output only. The number of URLs crawled during this ScanRun. If the + scan is in progress, the value represents the number of URLs crawled + up to now. + format: int64 + type: string + id: ScanRun + description: >- + A ScanRun is a output-only resource representing an actual run of the + scan. Next id: 12 + type: object + Form: + type: object + description: '! Information about a vulnerability with an HTML.' + properties: + actionUri: + type: string + description: '! The URI where to send the form when it''s submitted.' + fields: + type: array + items: + type: string + description: '! The names of form fields related to the vulnerability.' + id: Form + OutdatedLibrary: + type: object + id: OutdatedLibrary + description: Information reported for an outdated library. + properties: + libraryName: + type: string + description: The name of the outdated library. + version: + description: The version number. + type: string + learnMoreUrls: + type: array + description: >- + URLs to learn more information about the vulnerabilities in the + library. + items: + type: string + IapCredential: + description: Describes authentication configuration for Identity-Aware-Proxy (IAP). + type: object + properties: + iapTestServiceAccountInfo: + $ref: '#/components/schemas/IapTestServiceAccountInfo' + description: >- + Authentication configuration when Web-Security-Scanner service + account is added in Identity-Aware-Proxy (IAP) access policies. + id: IapCredential + ListFindingTypeStatsResponse: + description: Response for the `ListFindingTypeStats` method. + properties: + findingTypeStats: + type: array + items: + $ref: '#/components/schemas/FindingTypeStats' + description: The list of FindingTypeStats returned. + id: ListFindingTypeStatsResponse + type: object ListCrawledUrlsResponse: properties: crawledUrls: description: The list of CrawledUrls returned. + type: array items: $ref: '#/components/schemas/CrawledUrl' - type: array nextPageToken: description: >- Token to retrieve the next page of results, or empty if there are no more results in the list. type: string - type: object description: Response for the `ListCrawledUrls` method. id: ListCrawledUrlsResponse + type: object + StopScanRunRequest: + description: Request for the `StopScanRun` method. + properties: {} + id: StopScanRunRequest + type: object + Finding: + id: Finding + type: object + description: >- + A Finding resource represents a vulnerability instance identified during + a ScanRun. + properties: + finalUrl: + type: string + description: >- + Output only. The URL where the browser lands when the vulnerability + is detected. + form: + $ref: '#/components/schemas/Form' + description: >- + Output only. An addon containing information reported for a + vulnerability with an HTML form, if any. + xss: + description: >- + Output only. An addon containing information reported for an XSS, if + any. + $ref: '#/components/schemas/Xss' + reproductionUrl: + type: string + description: >- + Output only. The URL containing human-readable payload that user can + leverage to reproduce the vulnerability. + violatingResource: + $ref: '#/components/schemas/ViolatingResource' + description: >- + Output only. An addon containing detailed information regarding any + resource causing the vulnerability such as JavaScript sources, + image, audio files, etc. + trackingId: + description: >- + Output only. The tracking ID uniquely identifies a vulnerability + instance across multiple ScanRuns. + type: string + body: + description: >- + Output only. The body of the request that triggered the + vulnerability. + type: string + severity: + type: string + enum: + - SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW + enumDescriptions: + - No severity specified. The default value. + - Critical severity. + - High severity. + - Medium severity. + - Low severity. + readOnly: true + description: Output only. The severity level of the reported vulnerability. + outdatedLibrary: + description: >- + Output only. An addon containing information about outdated + libraries. + $ref: '#/components/schemas/OutdatedLibrary' + vulnerableParameters: + description: >- + Output only. An addon containing information about request + parameters which were found to be vulnerable. + $ref: '#/components/schemas/VulnerableParameters' + vulnerableHeaders: + $ref: '#/components/schemas/VulnerableHeaders' + description: >- + Output only. An addon containing information about vulnerable or + missing HTTP headers. + xxe: + description: >- + Output only. An addon containing information reported for an XXE, if + any. + $ref: '#/components/schemas/Xxe' + readOnly: true + httpMethod: + type: string + description: >- + Output only. The http method of the request that triggered the + vulnerability, in uppercase. + fuzzedUrl: + type: string + description: >- + Output only. The URL produced by the server-side fuzzer and used in + the request that triggered the vulnerability. + frameUrl: + type: string + description: >- + Output only. If the vulnerability was originated from nested IFrame, + the immediate parent IFrame is reported. + findingType: + description: >- + Output only. The type of the Finding. Detailed and up-to-date + information on findings can be found here: + https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings + type: string + description: + type: string + description: Output only. The description of the vulnerability. + name: + description: >- + Output only. The resource name of the Finding. The name follows the + format of + 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. + The finding IDs are generated by the system. + type: string VulnerableParameters: id: VulnerableParameters type: object - description: Information about vulnerable request parameters. properties: parameterNames: + items: + type: string description: The vulnerable parameter names. type: array + description: Information about vulnerable request parameters. + Empty: + properties: {} + 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); } + type: object + id: Empty + ListScanConfigsResponse: + id: ListScanConfigsResponse + type: object + description: Response for the `ListScanConfigs` method. + properties: + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + scanConfigs: + type: array items: - type: string - ScanRunErrorTrace: + $ref: '#/components/schemas/ScanConfig' + description: The list of ScanConfigs returned. + ListScanRunsResponse: + description: Response for the `ListScanRuns` method. properties: - mostCommonHttpErrorCode: - type: integer + nextPageToken: description: >- - Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field - indicates the most common HTTP error code, if such is available. For - example, if this code is 404, the scan has encountered too many - NOT_FOUND responses. - format: int32 - scanConfigError: - $ref: '#/components/schemas/ScanConfigError' + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + scanRuns: + type: array + description: The list of ScanRuns returned. + items: + $ref: '#/components/schemas/ScanRun' + type: object + id: ListScanRunsResponse + ScanConfig: + description: A ScanConfig resource contains the configurations to launch a scan. + id: ScanConfig + type: object + properties: + startingUrls: + items: + type: string + description: Required. The starting URLs from which the scanner finds site pages. + type: array + authentication: description: >- - Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this - field has the error message encountered during scan configuration - validation that is performed before each scan run. - code: + The authentication configuration. If specified, service will use the + authentication configuration during scanning. + $ref: '#/components/schemas/Authentication' + riskLevel: + description: The risk level selected for the scan enum: - - CODE_UNSPECIFIED - - INTERNAL_ERROR - - SCAN_CONFIG_ISSUE - - AUTHENTICATION_CONFIG_ISSUE - - TIMED_OUT_WHILE_SCANNING - - TOO_MANY_REDIRECTS - - TOO_MANY_HTTP_ERRORS - - STARTING_URLS_CRAWL_HTTP_ERRORS - description: Output only. Indicates the error reason code. + - RISK_LEVEL_UNSPECIFIED + - NORMAL + - LOW enumDescriptions: - - Default value is never used. - - >- - Indicates that the scan run failed due to an internal server - error. - - >- - Indicates a scan configuration error, usually due to outdated - ScanConfig settings, such as starting_urls or the DNS - configuration. - - >- - Indicates an authentication error, usually due to outdated - ScanConfig authentication settings. - - >- - Indicates a scan operation timeout, usually caused by a very large - site. - - >- - Indicates that a scan encountered excessive redirects, either to - authentication or some other page outside of the scan scope. - - >- - Indicates that a scan encountered numerous errors from the web - site pages. When available, most_common_http_error_code field - indicates the most common HTTP error code encountered during the - scan. - - >- - Indicates that some of the starting web urls returned HTTP errors - during the scan. + - Use default, which is NORMAL. + - Normal scanning (Recommended) + - Lower impact scanning + type: string + displayName: + type: string + description: Required. The user provided display name of the ScanConfig. + blacklistPatterns: + type: array + description: >- + The excluded URL patterns as described in + https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls + items: + type: string + ignoreHttpStatusErrors: + description: >- + Whether to keep scanning even if most requests return HTTP error + codes. + type: boolean + staticIpScan: + description: >- + Whether the scan configuration has enabled static IP address scan + feature. If enabled, the scanner will access applications from + static IP addresses. + type: boolean + managedScan: + type: boolean + description: >- + Whether the scan config is managed by Web Security Scanner, output + only. + name: + description: >- + The resource name of the ScanConfig. The name follows the format of + 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig + IDs are generated by the system. + type: string + userAgent: + type: string + enum: + - USER_AGENT_UNSPECIFIED + - CHROME_LINUX + - CHROME_ANDROID + - SAFARI_IPHONE + enumDescriptions: + - The user agent is unknown. Service will default to CHROME_LINUX. + - Chrome on Linux. This is the service default if unspecified. + - Chrome on Android. + - Safari on IPhone. + description: The user agent used during scanning. + maxQps: + description: >- + The maximum QPS during scanning. A valid value ranges from 5 to 20 + inclusively. If the field is unspecified or its value is set 0, + server will default to 15. Other values outside of [5, 20] range + will be rejected with INVALID_ARGUMENT error. + type: integer + format: int32 + schedule: + $ref: '#/components/schemas/Schedule' + description: The schedule of the ScanConfig. + exportToSecurityCommandCenter: + description: >- + Controls export of scan configurations and results to Security + Command Center. + enum: + - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED + - ENABLED + - DISABLED + enumDescriptions: + - Use default, which is ENABLED. + - Export results of this scan to Security Command Center. + - Do not export results of this scan to Security Command Center. type: string - description: Output only. Defines an error trace message for a ScanRun. - id: ScanRunErrorTrace + ViolatingResource: + properties: + resourceUrl: + description: URL of this violating resource. + type: string + contentType: + type: string + description: The MIME type of this resource. + description: >- + Information regarding any resource causing the vulnerability such as + JavaScript sources, image, audio files, etc. + id: ViolatingResource type: object parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol schema: type: string alt: @@ -966,19 +954,16 @@ components: - json - media - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + callback: + description: JSONP in: query - name: quotaUser + name: callback schema: type: string - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token schema: type: string uploadType: @@ -987,6 +972,12 @@ components: name: uploadType schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -996,18 +987,6 @@ components: name: key schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -1017,31 +996,43 @@ components: enum: - '1' - '2' + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string x-stackQL-resources: - findings: - id: google.websecurityscanner.findings - name: findings - title: Findings + finding_type_stats: + id: google.websecurityscanner.finding_type_stats + name: finding_type_stats + title: Finding_type_stats methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.findings - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings~1{findingsId}/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findingTypeStats/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/findings/methods/get' - - $ref: '#/components/x-stackQL-resources/findings/methods/list' + - $ref: '#/components/x-stackQL-resources/finding_type_stats/methods/list' insert: [] update: [] replace: [] @@ -1066,21 +1057,30 @@ components: update: [] replace: [] delete: [] - finding_type_stats: - id: google.websecurityscanner.finding_type_stats - name: finding_type_stats - title: Finding_type_stats + findings: + id: google.websecurityscanner.findings + name: findings + title: Findings methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findingTypeStats/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.findings + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings~1{findingsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/finding_type_stats/methods/list' + - $ref: '#/components/x-stackQL-resources/findings/methods/get' + - $ref: '#/components/x-stackQL-resources/findings/methods/list' insert: [] update: [] replace: [] @@ -1132,17 +1132,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -1178,22 +1178,22 @@ components: delete: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/delete' paths: - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' get: - description: List Findings under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list + description: List all FindingTypeStats under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1205,7 +1205,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingsResponse' + $ref: '#/components/schemas/ListFindingTypeStatsResponse' parameters: - in: path name: projectsId @@ -1222,24 +1222,11 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: parameters: *ref_1 get: - description: Gets a Finding. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.get + description: List CrawledUrls under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1251,7 +1238,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Finding' + $ref: '#/components/schemas/ListCrawledUrlsResponse' parameters: - in: path name: projectsId @@ -1268,16 +1255,20 @@ paths: required: true schema: type: string - - in: path - name: findingsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: parameters: *ref_1 get: - description: List CrawledUrls under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list + description: List Findings under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1289,7 +1280,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCrawledUrlsResponse' + $ref: '#/components/schemas/ListFindingsResponse' parameters: - in: path name: projectsId @@ -1315,11 +1306,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}: parameters: *ref_1 get: - description: List all FindingTypeStats under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list + description: Gets a Finding. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1331,7 +1326,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingTypeStatsResponse' + $ref: '#/components/schemas/Finding' parameters: - in: path name: projectsId @@ -1348,6 +1343,11 @@ paths: required: true schema: type: string + - in: path + name: findingsId + required: true + schema: + type: string /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: parameters: *ref_1 get: @@ -1411,15 +1411,15 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop: parameters: *ref_1 post: @@ -1498,9 +1498,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes an existing ScanConfig and its child resources. - operationId: websecurityscanner.projects.scanConfigs.delete + get: + description: Gets a ScanConfig. + operationId: websecurityscanner.projects.scanConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1512,7 +1512,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ScanConfig' parameters: - in: path name: projectsId @@ -1524,9 +1524,9 @@ paths: required: true schema: type: string - get: - description: Gets a ScanConfig. - operationId: websecurityscanner.projects.scanConfigs.get + delete: + description: Deletes an existing ScanConfig and its child resources. + operationId: websecurityscanner.projects.scanConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1538,7 +1538,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanConfig' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId